diff --git a/clients/client-accessanalyzer/commands/ApplyArchiveRuleCommand.ts b/clients/client-accessanalyzer/commands/ApplyArchiveRuleCommand.ts index a4b06e51fa07..5c95567827cd 100644 --- a/clients/client-accessanalyzer/commands/ApplyArchiveRuleCommand.ts +++ b/clients/client-accessanalyzer/commands/ApplyArchiveRuleCommand.ts @@ -23,6 +23,20 @@ export interface ApplyArchiveRuleCommandOutput extends __MetadataBearer {} /** *

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

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { AccessAnalyzerClient, ApplyArchiveRuleCommand } from "@aws-sdk/client-accessanalyzer"; // ES Modules import + * // const { AccessAnalyzerClient, ApplyArchiveRuleCommand } = require("@aws-sdk/client-accessanalyzer"); // CommonJS import + * const client = new AccessAnalyzerClient(config); + * const command = new ApplyArchiveRuleCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ApplyArchiveRuleCommandInput} for command's `input` shape. + * @see {@link ApplyArchiveRuleCommandOutput} for command's `response` shape. + * @see {@link AccessAnalyzerClientResolvedConfig | config} for command's `input` shape. + * */ export class ApplyArchiveRuleCommand extends $Command< ApplyArchiveRuleCommandInput, diff --git a/clients/client-accessanalyzer/commands/CancelPolicyGenerationCommand.ts b/clients/client-accessanalyzer/commands/CancelPolicyGenerationCommand.ts index 6e066b883ca9..a29ad04eefbe 100644 --- a/clients/client-accessanalyzer/commands/CancelPolicyGenerationCommand.ts +++ b/clients/client-accessanalyzer/commands/CancelPolicyGenerationCommand.ts @@ -22,6 +22,20 @@ export interface CancelPolicyGenerationCommandOutput extends CancelPolicyGenerat /** *

Cancels the requested policy generation.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { AccessAnalyzerClient, CancelPolicyGenerationCommand } from "@aws-sdk/client-accessanalyzer"; // ES Modules import + * // const { AccessAnalyzerClient, CancelPolicyGenerationCommand } = require("@aws-sdk/client-accessanalyzer"); // CommonJS import + * const client = new AccessAnalyzerClient(config); + * const command = new CancelPolicyGenerationCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CancelPolicyGenerationCommandInput} for command's `input` shape. + * @see {@link CancelPolicyGenerationCommandOutput} for command's `response` shape. + * @see {@link AccessAnalyzerClientResolvedConfig | config} for command's `input` shape. + * */ export class CancelPolicyGenerationCommand extends $Command< CancelPolicyGenerationCommandInput, diff --git a/clients/client-accessanalyzer/commands/CreateAccessPreviewCommand.ts b/clients/client-accessanalyzer/commands/CreateAccessPreviewCommand.ts index 9edefa2c3bf0..58f441359eb7 100644 --- a/clients/client-accessanalyzer/commands/CreateAccessPreviewCommand.ts +++ b/clients/client-accessanalyzer/commands/CreateAccessPreviewCommand.ts @@ -23,6 +23,20 @@ export interface CreateAccessPreviewCommandOutput extends CreateAccessPreviewRes /** *

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

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { AccessAnalyzerClient, CreateAccessPreviewCommand } from "@aws-sdk/client-accessanalyzer"; // ES Modules import + * // const { AccessAnalyzerClient, CreateAccessPreviewCommand } = require("@aws-sdk/client-accessanalyzer"); // CommonJS import + * const client = new AccessAnalyzerClient(config); + * const command = new CreateAccessPreviewCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreateAccessPreviewCommandInput} for command's `input` shape. + * @see {@link CreateAccessPreviewCommandOutput} for command's `response` shape. + * @see {@link AccessAnalyzerClientResolvedConfig | config} for command's `input` shape. + * */ export class CreateAccessPreviewCommand extends $Command< CreateAccessPreviewCommandInput, diff --git a/clients/client-accessanalyzer/commands/CreateAnalyzerCommand.ts b/clients/client-accessanalyzer/commands/CreateAnalyzerCommand.ts index c3c75bf68b3b..3618fa6c9600 100644 --- a/clients/client-accessanalyzer/commands/CreateAnalyzerCommand.ts +++ b/clients/client-accessanalyzer/commands/CreateAnalyzerCommand.ts @@ -22,6 +22,20 @@ export interface CreateAnalyzerCommandOutput extends CreateAnalyzerResponse, __M /** *

Creates an analyzer for your account.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { AccessAnalyzerClient, CreateAnalyzerCommand } from "@aws-sdk/client-accessanalyzer"; // ES Modules import + * // const { AccessAnalyzerClient, CreateAnalyzerCommand } = require("@aws-sdk/client-accessanalyzer"); // CommonJS import + * const client = new AccessAnalyzerClient(config); + * const command = new CreateAnalyzerCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreateAnalyzerCommandInput} for command's `input` shape. + * @see {@link CreateAnalyzerCommandOutput} for command's `response` shape. + * @see {@link AccessAnalyzerClientResolvedConfig | config} for command's `input` shape. + * */ export class CreateAnalyzerCommand extends $Command< CreateAnalyzerCommandInput, diff --git a/clients/client-accessanalyzer/commands/CreateArchiveRuleCommand.ts b/clients/client-accessanalyzer/commands/CreateArchiveRuleCommand.ts index 0791af29cea3..9c21f874a228 100644 --- a/clients/client-accessanalyzer/commands/CreateArchiveRuleCommand.ts +++ b/clients/client-accessanalyzer/commands/CreateArchiveRuleCommand.ts @@ -25,6 +25,20 @@ export interface CreateArchiveRuleCommandOutput extends __MetadataBearer {} * 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 Access Analyzer filter keys in the IAM User * Guide.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { AccessAnalyzerClient, CreateArchiveRuleCommand } from "@aws-sdk/client-accessanalyzer"; // ES Modules import + * // const { AccessAnalyzerClient, CreateArchiveRuleCommand } = require("@aws-sdk/client-accessanalyzer"); // CommonJS import + * const client = new AccessAnalyzerClient(config); + * const command = new CreateArchiveRuleCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreateArchiveRuleCommandInput} for command's `input` shape. + * @see {@link CreateArchiveRuleCommandOutput} for command's `response` shape. + * @see {@link AccessAnalyzerClientResolvedConfig | config} for command's `input` shape. + * */ export class CreateArchiveRuleCommand extends $Command< CreateArchiveRuleCommandInput, diff --git a/clients/client-accessanalyzer/commands/DeleteAnalyzerCommand.ts b/clients/client-accessanalyzer/commands/DeleteAnalyzerCommand.ts index 62782e5c8996..d8e09e000435 100644 --- a/clients/client-accessanalyzer/commands/DeleteAnalyzerCommand.ts +++ b/clients/client-accessanalyzer/commands/DeleteAnalyzerCommand.ts @@ -24,6 +24,20 @@ export interface DeleteAnalyzerCommandOutput extends __MetadataBearer {} *

Deletes the specified analyzer. When you delete an analyzer, 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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { AccessAnalyzerClient, DeleteAnalyzerCommand } from "@aws-sdk/client-accessanalyzer"; // ES Modules import + * // const { AccessAnalyzerClient, DeleteAnalyzerCommand } = require("@aws-sdk/client-accessanalyzer"); // CommonJS import + * const client = new AccessAnalyzerClient(config); + * const command = new DeleteAnalyzerCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteAnalyzerCommandInput} for command's `input` shape. + * @see {@link DeleteAnalyzerCommandOutput} for command's `response` shape. + * @see {@link AccessAnalyzerClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteAnalyzerCommand extends $Command< DeleteAnalyzerCommandInput, diff --git a/clients/client-accessanalyzer/commands/DeleteArchiveRuleCommand.ts b/clients/client-accessanalyzer/commands/DeleteArchiveRuleCommand.ts index 80ae94f94052..7fb7740eb876 100644 --- a/clients/client-accessanalyzer/commands/DeleteArchiveRuleCommand.ts +++ b/clients/client-accessanalyzer/commands/DeleteArchiveRuleCommand.ts @@ -22,6 +22,20 @@ export interface DeleteArchiveRuleCommandOutput extends __MetadataBearer {} /** *

Deletes the specified archive rule.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { AccessAnalyzerClient, DeleteArchiveRuleCommand } from "@aws-sdk/client-accessanalyzer"; // ES Modules import + * // const { AccessAnalyzerClient, DeleteArchiveRuleCommand } = require("@aws-sdk/client-accessanalyzer"); // CommonJS import + * const client = new AccessAnalyzerClient(config); + * const command = new DeleteArchiveRuleCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteArchiveRuleCommandInput} for command's `input` shape. + * @see {@link DeleteArchiveRuleCommandOutput} for command's `response` shape. + * @see {@link AccessAnalyzerClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteArchiveRuleCommand extends $Command< DeleteArchiveRuleCommandInput, diff --git a/clients/client-accessanalyzer/commands/GetAccessPreviewCommand.ts b/clients/client-accessanalyzer/commands/GetAccessPreviewCommand.ts index e6c6d2a6df55..800ac9f80a2a 100644 --- a/clients/client-accessanalyzer/commands/GetAccessPreviewCommand.ts +++ b/clients/client-accessanalyzer/commands/GetAccessPreviewCommand.ts @@ -22,6 +22,20 @@ export interface GetAccessPreviewCommandOutput extends GetAccessPreviewResponse, /** *

Retrieves information about an access preview for the specified analyzer.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { AccessAnalyzerClient, GetAccessPreviewCommand } from "@aws-sdk/client-accessanalyzer"; // ES Modules import + * // const { AccessAnalyzerClient, GetAccessPreviewCommand } = require("@aws-sdk/client-accessanalyzer"); // CommonJS import + * const client = new AccessAnalyzerClient(config); + * const command = new GetAccessPreviewCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetAccessPreviewCommandInput} for command's `input` shape. + * @see {@link GetAccessPreviewCommandOutput} for command's `response` shape. + * @see {@link AccessAnalyzerClientResolvedConfig | config} for command's `input` shape. + * */ export class GetAccessPreviewCommand extends $Command< GetAccessPreviewCommandInput, diff --git a/clients/client-accessanalyzer/commands/GetAnalyzedResourceCommand.ts b/clients/client-accessanalyzer/commands/GetAnalyzedResourceCommand.ts index 4e5274cac23d..2308df8ee74e 100644 --- a/clients/client-accessanalyzer/commands/GetAnalyzedResourceCommand.ts +++ b/clients/client-accessanalyzer/commands/GetAnalyzedResourceCommand.ts @@ -22,6 +22,20 @@ export interface GetAnalyzedResourceCommandOutput extends GetAnalyzedResourceRes /** *

Retrieves information about a resource that was analyzed.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { AccessAnalyzerClient, GetAnalyzedResourceCommand } from "@aws-sdk/client-accessanalyzer"; // ES Modules import + * // const { AccessAnalyzerClient, GetAnalyzedResourceCommand } = require("@aws-sdk/client-accessanalyzer"); // CommonJS import + * const client = new AccessAnalyzerClient(config); + * const command = new GetAnalyzedResourceCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetAnalyzedResourceCommandInput} for command's `input` shape. + * @see {@link GetAnalyzedResourceCommandOutput} for command's `response` shape. + * @see {@link AccessAnalyzerClientResolvedConfig | config} for command's `input` shape. + * */ export class GetAnalyzedResourceCommand extends $Command< GetAnalyzedResourceCommandInput, diff --git a/clients/client-accessanalyzer/commands/GetAnalyzerCommand.ts b/clients/client-accessanalyzer/commands/GetAnalyzerCommand.ts index d44f751cb090..599e3eff9948 100644 --- a/clients/client-accessanalyzer/commands/GetAnalyzerCommand.ts +++ b/clients/client-accessanalyzer/commands/GetAnalyzerCommand.ts @@ -22,6 +22,20 @@ export interface GetAnalyzerCommandOutput extends GetAnalyzerResponse, __Metadat /** *

Retrieves information about the specified analyzer.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { AccessAnalyzerClient, GetAnalyzerCommand } from "@aws-sdk/client-accessanalyzer"; // ES Modules import + * // const { AccessAnalyzerClient, GetAnalyzerCommand } = require("@aws-sdk/client-accessanalyzer"); // CommonJS import + * const client = new AccessAnalyzerClient(config); + * const command = new GetAnalyzerCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetAnalyzerCommandInput} for command's `input` shape. + * @see {@link GetAnalyzerCommandOutput} for command's `response` shape. + * @see {@link AccessAnalyzerClientResolvedConfig | config} for command's `input` shape. + * */ export class GetAnalyzerCommand extends $Command< GetAnalyzerCommandInput, diff --git a/clients/client-accessanalyzer/commands/GetArchiveRuleCommand.ts b/clients/client-accessanalyzer/commands/GetArchiveRuleCommand.ts index da789123b780..07f91779a028 100644 --- a/clients/client-accessanalyzer/commands/GetArchiveRuleCommand.ts +++ b/clients/client-accessanalyzer/commands/GetArchiveRuleCommand.ts @@ -24,6 +24,20 @@ export interface GetArchiveRuleCommandOutput extends GetArchiveRuleResponse, __M *

Retrieves information about an archive rule.

*

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

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { AccessAnalyzerClient, GetArchiveRuleCommand } from "@aws-sdk/client-accessanalyzer"; // ES Modules import + * // const { AccessAnalyzerClient, GetArchiveRuleCommand } = require("@aws-sdk/client-accessanalyzer"); // CommonJS import + * const client = new AccessAnalyzerClient(config); + * const command = new GetArchiveRuleCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetArchiveRuleCommandInput} for command's `input` shape. + * @see {@link GetArchiveRuleCommandOutput} for command's `response` shape. + * @see {@link AccessAnalyzerClientResolvedConfig | config} for command's `input` shape. + * */ export class GetArchiveRuleCommand extends $Command< GetArchiveRuleCommandInput, diff --git a/clients/client-accessanalyzer/commands/GetFindingCommand.ts b/clients/client-accessanalyzer/commands/GetFindingCommand.ts index e8ceaf3bd194..a528a3e80a52 100644 --- a/clients/client-accessanalyzer/commands/GetFindingCommand.ts +++ b/clients/client-accessanalyzer/commands/GetFindingCommand.ts @@ -22,6 +22,20 @@ export interface GetFindingCommandOutput extends GetFindingResponse, __MetadataB /** *

Retrieves information about the specified finding.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { AccessAnalyzerClient, GetFindingCommand } from "@aws-sdk/client-accessanalyzer"; // ES Modules import + * // const { AccessAnalyzerClient, GetFindingCommand } = require("@aws-sdk/client-accessanalyzer"); // CommonJS import + * const client = new AccessAnalyzerClient(config); + * const command = new GetFindingCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetFindingCommandInput} for command's `input` shape. + * @see {@link GetFindingCommandOutput} for command's `response` shape. + * @see {@link AccessAnalyzerClientResolvedConfig | config} for command's `input` shape. + * */ export class GetFindingCommand extends $Command< GetFindingCommandInput, diff --git a/clients/client-accessanalyzer/commands/GetGeneratedPolicyCommand.ts b/clients/client-accessanalyzer/commands/GetGeneratedPolicyCommand.ts index ec6a28f19fb2..ca4af6071ec2 100644 --- a/clients/client-accessanalyzer/commands/GetGeneratedPolicyCommand.ts +++ b/clients/client-accessanalyzer/commands/GetGeneratedPolicyCommand.ts @@ -23,6 +23,20 @@ export interface GetGeneratedPolicyCommandOutput extends GetGeneratedPolicyRespo /** *

Retrieves the policy that was generated using StartPolicyGeneration. *

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { AccessAnalyzerClient, GetGeneratedPolicyCommand } from "@aws-sdk/client-accessanalyzer"; // ES Modules import + * // const { AccessAnalyzerClient, GetGeneratedPolicyCommand } = require("@aws-sdk/client-accessanalyzer"); // CommonJS import + * const client = new AccessAnalyzerClient(config); + * const command = new GetGeneratedPolicyCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetGeneratedPolicyCommandInput} for command's `input` shape. + * @see {@link GetGeneratedPolicyCommandOutput} for command's `response` shape. + * @see {@link AccessAnalyzerClientResolvedConfig | config} for command's `input` shape. + * */ export class GetGeneratedPolicyCommand extends $Command< GetGeneratedPolicyCommandInput, diff --git a/clients/client-accessanalyzer/commands/ListAccessPreviewFindingsCommand.ts b/clients/client-accessanalyzer/commands/ListAccessPreviewFindingsCommand.ts index adca28748e84..8e9d3daf6cd6 100644 --- a/clients/client-accessanalyzer/commands/ListAccessPreviewFindingsCommand.ts +++ b/clients/client-accessanalyzer/commands/ListAccessPreviewFindingsCommand.ts @@ -23,6 +23,20 @@ export interface ListAccessPreviewFindingsCommandOutput extends ListAccessPrevie /** *

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

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { AccessAnalyzerClient, ListAccessPreviewFindingsCommand } from "@aws-sdk/client-accessanalyzer"; // ES Modules import + * // const { AccessAnalyzerClient, ListAccessPreviewFindingsCommand } = require("@aws-sdk/client-accessanalyzer"); // CommonJS import + * const client = new AccessAnalyzerClient(config); + * const command = new ListAccessPreviewFindingsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListAccessPreviewFindingsCommandInput} for command's `input` shape. + * @see {@link ListAccessPreviewFindingsCommandOutput} for command's `response` shape. + * @see {@link AccessAnalyzerClientResolvedConfig | config} for command's `input` shape. + * */ export class ListAccessPreviewFindingsCommand extends $Command< ListAccessPreviewFindingsCommandInput, diff --git a/clients/client-accessanalyzer/commands/ListAccessPreviewsCommand.ts b/clients/client-accessanalyzer/commands/ListAccessPreviewsCommand.ts index a337be06435e..31b1c061b9f9 100644 --- a/clients/client-accessanalyzer/commands/ListAccessPreviewsCommand.ts +++ b/clients/client-accessanalyzer/commands/ListAccessPreviewsCommand.ts @@ -22,6 +22,20 @@ export interface ListAccessPreviewsCommandOutput extends ListAccessPreviewsRespo /** *

Retrieves a list of access previews for the specified analyzer.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { AccessAnalyzerClient, ListAccessPreviewsCommand } from "@aws-sdk/client-accessanalyzer"; // ES Modules import + * // const { AccessAnalyzerClient, ListAccessPreviewsCommand } = require("@aws-sdk/client-accessanalyzer"); // CommonJS import + * const client = new AccessAnalyzerClient(config); + * const command = new ListAccessPreviewsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListAccessPreviewsCommandInput} for command's `input` shape. + * @see {@link ListAccessPreviewsCommandOutput} for command's `response` shape. + * @see {@link AccessAnalyzerClientResolvedConfig | config} for command's `input` shape. + * */ export class ListAccessPreviewsCommand extends $Command< ListAccessPreviewsCommandInput, diff --git a/clients/client-accessanalyzer/commands/ListAnalyzedResourcesCommand.ts b/clients/client-accessanalyzer/commands/ListAnalyzedResourcesCommand.ts index 13734579d0c8..b0029d042da3 100644 --- a/clients/client-accessanalyzer/commands/ListAnalyzedResourcesCommand.ts +++ b/clients/client-accessanalyzer/commands/ListAnalyzedResourcesCommand.ts @@ -23,6 +23,20 @@ export interface ListAnalyzedResourcesCommandOutput extends ListAnalyzedResource /** *

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

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { AccessAnalyzerClient, ListAnalyzedResourcesCommand } from "@aws-sdk/client-accessanalyzer"; // ES Modules import + * // const { AccessAnalyzerClient, ListAnalyzedResourcesCommand } = require("@aws-sdk/client-accessanalyzer"); // CommonJS import + * const client = new AccessAnalyzerClient(config); + * const command = new ListAnalyzedResourcesCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListAnalyzedResourcesCommandInput} for command's `input` shape. + * @see {@link ListAnalyzedResourcesCommandOutput} for command's `response` shape. + * @see {@link AccessAnalyzerClientResolvedConfig | config} for command's `input` shape. + * */ export class ListAnalyzedResourcesCommand extends $Command< ListAnalyzedResourcesCommandInput, diff --git a/clients/client-accessanalyzer/commands/ListAnalyzersCommand.ts b/clients/client-accessanalyzer/commands/ListAnalyzersCommand.ts index 08cb609001bd..3e22d22d46b7 100644 --- a/clients/client-accessanalyzer/commands/ListAnalyzersCommand.ts +++ b/clients/client-accessanalyzer/commands/ListAnalyzersCommand.ts @@ -22,6 +22,20 @@ export interface ListAnalyzersCommandOutput extends ListAnalyzersResponse, __Met /** *

Retrieves a list of analyzers.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { AccessAnalyzerClient, ListAnalyzersCommand } from "@aws-sdk/client-accessanalyzer"; // ES Modules import + * // const { AccessAnalyzerClient, ListAnalyzersCommand } = require("@aws-sdk/client-accessanalyzer"); // CommonJS import + * const client = new AccessAnalyzerClient(config); + * const command = new ListAnalyzersCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListAnalyzersCommandInput} for command's `input` shape. + * @see {@link ListAnalyzersCommandOutput} for command's `response` shape. + * @see {@link AccessAnalyzerClientResolvedConfig | config} for command's `input` shape. + * */ export class ListAnalyzersCommand extends $Command< ListAnalyzersCommandInput, diff --git a/clients/client-accessanalyzer/commands/ListArchiveRulesCommand.ts b/clients/client-accessanalyzer/commands/ListArchiveRulesCommand.ts index 3ebfec1218ba..beff5f2ebcd3 100644 --- a/clients/client-accessanalyzer/commands/ListArchiveRulesCommand.ts +++ b/clients/client-accessanalyzer/commands/ListArchiveRulesCommand.ts @@ -22,6 +22,20 @@ export interface ListArchiveRulesCommandOutput extends ListArchiveRulesResponse, /** *

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

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { AccessAnalyzerClient, ListArchiveRulesCommand } from "@aws-sdk/client-accessanalyzer"; // ES Modules import + * // const { AccessAnalyzerClient, ListArchiveRulesCommand } = require("@aws-sdk/client-accessanalyzer"); // CommonJS import + * const client = new AccessAnalyzerClient(config); + * const command = new ListArchiveRulesCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListArchiveRulesCommandInput} for command's `input` shape. + * @see {@link ListArchiveRulesCommandOutput} for command's `response` shape. + * @see {@link AccessAnalyzerClientResolvedConfig | config} for command's `input` shape. + * */ export class ListArchiveRulesCommand extends $Command< ListArchiveRulesCommandInput, diff --git a/clients/client-accessanalyzer/commands/ListFindingsCommand.ts b/clients/client-accessanalyzer/commands/ListFindingsCommand.ts index 3aecccfde980..009066c5cfcb 100644 --- a/clients/client-accessanalyzer/commands/ListFindingsCommand.ts +++ b/clients/client-accessanalyzer/commands/ListFindingsCommand.ts @@ -24,6 +24,20 @@ export interface ListFindingsCommandOutput extends ListFindingsResponse, __Metad *

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 Access Analyzer filter keys in the IAM User * Guide.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { AccessAnalyzerClient, ListFindingsCommand } from "@aws-sdk/client-accessanalyzer"; // ES Modules import + * // const { AccessAnalyzerClient, ListFindingsCommand } = require("@aws-sdk/client-accessanalyzer"); // CommonJS import + * const client = new AccessAnalyzerClient(config); + * const command = new ListFindingsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListFindingsCommandInput} for command's `input` shape. + * @see {@link ListFindingsCommandOutput} for command's `response` shape. + * @see {@link AccessAnalyzerClientResolvedConfig | config} for command's `input` shape. + * */ export class ListFindingsCommand extends $Command< ListFindingsCommandInput, diff --git a/clients/client-accessanalyzer/commands/ListPolicyGenerationsCommand.ts b/clients/client-accessanalyzer/commands/ListPolicyGenerationsCommand.ts index 5375db1ba3b3..f9018c91f2cf 100644 --- a/clients/client-accessanalyzer/commands/ListPolicyGenerationsCommand.ts +++ b/clients/client-accessanalyzer/commands/ListPolicyGenerationsCommand.ts @@ -22,6 +22,20 @@ export interface ListPolicyGenerationsCommandOutput extends ListPolicyGeneration /** *

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

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { AccessAnalyzerClient, ListPolicyGenerationsCommand } from "@aws-sdk/client-accessanalyzer"; // ES Modules import + * // const { AccessAnalyzerClient, ListPolicyGenerationsCommand } = require("@aws-sdk/client-accessanalyzer"); // CommonJS import + * const client = new AccessAnalyzerClient(config); + * const command = new ListPolicyGenerationsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListPolicyGenerationsCommandInput} for command's `input` shape. + * @see {@link ListPolicyGenerationsCommandOutput} for command's `response` shape. + * @see {@link AccessAnalyzerClientResolvedConfig | config} for command's `input` shape. + * */ export class ListPolicyGenerationsCommand extends $Command< ListPolicyGenerationsCommandInput, diff --git a/clients/client-accessanalyzer/commands/ListTagsForResourceCommand.ts b/clients/client-accessanalyzer/commands/ListTagsForResourceCommand.ts index fecf7e8f0f52..f5fa5a7b72b3 100644 --- a/clients/client-accessanalyzer/commands/ListTagsForResourceCommand.ts +++ b/clients/client-accessanalyzer/commands/ListTagsForResourceCommand.ts @@ -22,6 +22,20 @@ export interface ListTagsForResourceCommandOutput extends ListTagsForResourceRes /** *

Retrieves a list of tags applied to the specified resource.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { AccessAnalyzerClient, ListTagsForResourceCommand } from "@aws-sdk/client-accessanalyzer"; // ES Modules import + * // const { AccessAnalyzerClient, ListTagsForResourceCommand } = require("@aws-sdk/client-accessanalyzer"); // CommonJS import + * const client = new AccessAnalyzerClient(config); + * const command = new ListTagsForResourceCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListTagsForResourceCommandInput} for command's `input` shape. + * @see {@link ListTagsForResourceCommandOutput} for command's `response` shape. + * @see {@link AccessAnalyzerClientResolvedConfig | config} for command's `input` shape. + * */ export class ListTagsForResourceCommand extends $Command< ListTagsForResourceCommandInput, diff --git a/clients/client-accessanalyzer/commands/StartPolicyGenerationCommand.ts b/clients/client-accessanalyzer/commands/StartPolicyGenerationCommand.ts index 2352cfcca77f..244b43d97ebf 100644 --- a/clients/client-accessanalyzer/commands/StartPolicyGenerationCommand.ts +++ b/clients/client-accessanalyzer/commands/StartPolicyGenerationCommand.ts @@ -22,6 +22,20 @@ export interface StartPolicyGenerationCommandOutput extends StartPolicyGeneratio /** *

Starts the policy generation request.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { AccessAnalyzerClient, StartPolicyGenerationCommand } from "@aws-sdk/client-accessanalyzer"; // ES Modules import + * // const { AccessAnalyzerClient, StartPolicyGenerationCommand } = require("@aws-sdk/client-accessanalyzer"); // CommonJS import + * const client = new AccessAnalyzerClient(config); + * const command = new StartPolicyGenerationCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link StartPolicyGenerationCommandInput} for command's `input` shape. + * @see {@link StartPolicyGenerationCommandOutput} for command's `response` shape. + * @see {@link AccessAnalyzerClientResolvedConfig | config} for command's `input` shape. + * */ export class StartPolicyGenerationCommand extends $Command< StartPolicyGenerationCommandInput, diff --git a/clients/client-accessanalyzer/commands/StartResourceScanCommand.ts b/clients/client-accessanalyzer/commands/StartResourceScanCommand.ts index 744497e8f0e2..d77b05368ffb 100644 --- a/clients/client-accessanalyzer/commands/StartResourceScanCommand.ts +++ b/clients/client-accessanalyzer/commands/StartResourceScanCommand.ts @@ -22,6 +22,20 @@ export interface StartResourceScanCommandOutput extends __MetadataBearer {} /** *

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

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { AccessAnalyzerClient, StartResourceScanCommand } from "@aws-sdk/client-accessanalyzer"; // ES Modules import + * // const { AccessAnalyzerClient, StartResourceScanCommand } = require("@aws-sdk/client-accessanalyzer"); // CommonJS import + * const client = new AccessAnalyzerClient(config); + * const command = new StartResourceScanCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link StartResourceScanCommandInput} for command's `input` shape. + * @see {@link StartResourceScanCommandOutput} for command's `response` shape. + * @see {@link AccessAnalyzerClientResolvedConfig | config} for command's `input` shape. + * */ export class StartResourceScanCommand extends $Command< StartResourceScanCommandInput, diff --git a/clients/client-accessanalyzer/commands/TagResourceCommand.ts b/clients/client-accessanalyzer/commands/TagResourceCommand.ts index e4127f79f379..48abc0e7c0c2 100644 --- a/clients/client-accessanalyzer/commands/TagResourceCommand.ts +++ b/clients/client-accessanalyzer/commands/TagResourceCommand.ts @@ -22,6 +22,20 @@ export interface TagResourceCommandOutput extends TagResourceResponse, __Metadat /** *

Adds a tag to the specified resource.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { AccessAnalyzerClient, TagResourceCommand } from "@aws-sdk/client-accessanalyzer"; // ES Modules import + * // const { AccessAnalyzerClient, TagResourceCommand } = require("@aws-sdk/client-accessanalyzer"); // CommonJS import + * const client = new AccessAnalyzerClient(config); + * const command = new TagResourceCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link TagResourceCommandInput} for command's `input` shape. + * @see {@link TagResourceCommandOutput} for command's `response` shape. + * @see {@link AccessAnalyzerClientResolvedConfig | config} for command's `input` shape. + * */ export class TagResourceCommand extends $Command< TagResourceCommandInput, diff --git a/clients/client-accessanalyzer/commands/UntagResourceCommand.ts b/clients/client-accessanalyzer/commands/UntagResourceCommand.ts index 79551f0054dc..e62f015f729e 100644 --- a/clients/client-accessanalyzer/commands/UntagResourceCommand.ts +++ b/clients/client-accessanalyzer/commands/UntagResourceCommand.ts @@ -22,6 +22,20 @@ export interface UntagResourceCommandOutput extends UntagResourceResponse, __Met /** *

Removes a tag from the specified resource.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { AccessAnalyzerClient, UntagResourceCommand } from "@aws-sdk/client-accessanalyzer"; // ES Modules import + * // const { AccessAnalyzerClient, UntagResourceCommand } = require("@aws-sdk/client-accessanalyzer"); // CommonJS import + * const client = new AccessAnalyzerClient(config); + * const command = new UntagResourceCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link UntagResourceCommandInput} for command's `input` shape. + * @see {@link UntagResourceCommandOutput} for command's `response` shape. + * @see {@link AccessAnalyzerClientResolvedConfig | config} for command's `input` shape. + * */ export class UntagResourceCommand extends $Command< UntagResourceCommandInput, diff --git a/clients/client-accessanalyzer/commands/UpdateArchiveRuleCommand.ts b/clients/client-accessanalyzer/commands/UpdateArchiveRuleCommand.ts index 95240330d1de..efe5689c21e0 100644 --- a/clients/client-accessanalyzer/commands/UpdateArchiveRuleCommand.ts +++ b/clients/client-accessanalyzer/commands/UpdateArchiveRuleCommand.ts @@ -22,6 +22,20 @@ export interface UpdateArchiveRuleCommandOutput extends __MetadataBearer {} /** *

Updates the criteria and values for the specified archive rule.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { AccessAnalyzerClient, UpdateArchiveRuleCommand } from "@aws-sdk/client-accessanalyzer"; // ES Modules import + * // const { AccessAnalyzerClient, UpdateArchiveRuleCommand } = require("@aws-sdk/client-accessanalyzer"); // CommonJS import + * const client = new AccessAnalyzerClient(config); + * const command = new UpdateArchiveRuleCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link UpdateArchiveRuleCommandInput} for command's `input` shape. + * @see {@link UpdateArchiveRuleCommandOutput} for command's `response` shape. + * @see {@link AccessAnalyzerClientResolvedConfig | config} for command's `input` shape. + * */ export class UpdateArchiveRuleCommand extends $Command< UpdateArchiveRuleCommandInput, diff --git a/clients/client-accessanalyzer/commands/UpdateFindingsCommand.ts b/clients/client-accessanalyzer/commands/UpdateFindingsCommand.ts index 6b390d512b1a..dc6ba5046d7f 100644 --- a/clients/client-accessanalyzer/commands/UpdateFindingsCommand.ts +++ b/clients/client-accessanalyzer/commands/UpdateFindingsCommand.ts @@ -22,6 +22,20 @@ export interface UpdateFindingsCommandOutput extends __MetadataBearer {} /** *

Updates the status for the specified findings.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { AccessAnalyzerClient, UpdateFindingsCommand } from "@aws-sdk/client-accessanalyzer"; // ES Modules import + * // const { AccessAnalyzerClient, UpdateFindingsCommand } = require("@aws-sdk/client-accessanalyzer"); // CommonJS import + * const client = new AccessAnalyzerClient(config); + * const command = new UpdateFindingsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link UpdateFindingsCommandInput} for command's `input` shape. + * @see {@link UpdateFindingsCommandOutput} for command's `response` shape. + * @see {@link AccessAnalyzerClientResolvedConfig | config} for command's `input` shape. + * */ export class UpdateFindingsCommand extends $Command< UpdateFindingsCommandInput, diff --git a/clients/client-accessanalyzer/commands/ValidatePolicyCommand.ts b/clients/client-accessanalyzer/commands/ValidatePolicyCommand.ts index 13e0335c402c..4b2d49b53615 100644 --- a/clients/client-accessanalyzer/commands/ValidatePolicyCommand.ts +++ b/clients/client-accessanalyzer/commands/ValidatePolicyCommand.ts @@ -24,6 +24,20 @@ export interface ValidatePolicyCommandOutput extends ValidatePolicyResponse, __M *

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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { AccessAnalyzerClient, ValidatePolicyCommand } from "@aws-sdk/client-accessanalyzer"; // ES Modules import + * // const { AccessAnalyzerClient, ValidatePolicyCommand } = require("@aws-sdk/client-accessanalyzer"); // CommonJS import + * const client = new AccessAnalyzerClient(config); + * const command = new ValidatePolicyCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ValidatePolicyCommandInput} for command's `input` shape. + * @see {@link ValidatePolicyCommandOutput} for command's `response` shape. + * @see {@link AccessAnalyzerClientResolvedConfig | config} for command's `input` shape. + * */ export class ValidatePolicyCommand extends $Command< ValidatePolicyCommandInput, diff --git a/clients/client-accessanalyzer/models/models_0.ts b/clients/client-accessanalyzer/models/models_0.ts index 5ab6ecca64d2..e6ca65336a1a 100644 --- a/clients/client-accessanalyzer/models/models_0.ts +++ b/clients/client-accessanalyzer/models/models_0.ts @@ -11,6 +11,9 @@ export interface AccessDeniedException extends __SmithyException, $MetadataBeare } export namespace AccessDeniedException { + /** + * @internal + */ export const filterSensitiveLog = (obj: AccessDeniedException): any => ({ ...obj, }); @@ -35,6 +38,9 @@ export interface ConflictException extends __SmithyException, $MetadataBearer { } export namespace ConflictException { + /** + * @internal + */ export const filterSensitiveLog = (obj: ConflictException): any => ({ ...obj, }); @@ -66,6 +72,9 @@ export interface Criterion { } export namespace Criterion { + /** + * @internal + */ export const filterSensitiveLog = (obj: Criterion): any => ({ ...obj, }); @@ -97,6 +106,9 @@ export interface CreateArchiveRuleRequest { } export namespace CreateArchiveRuleRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateArchiveRuleRequest): any => ({ ...obj, }); @@ -117,6 +129,9 @@ export interface InternalServerException extends __SmithyException, $MetadataBea } export namespace InternalServerException { + /** + * @internal + */ export const filterSensitiveLog = (obj: InternalServerException): any => ({ ...obj, }); @@ -141,6 +156,9 @@ export interface ResourceNotFoundException extends __SmithyException, $MetadataB } export namespace ResourceNotFoundException { + /** + * @internal + */ export const filterSensitiveLog = (obj: ResourceNotFoundException): any => ({ ...obj, }); @@ -165,6 +183,9 @@ export interface ServiceQuotaExceededException extends __SmithyException, $Metad } export namespace ServiceQuotaExceededException { + /** + * @internal + */ export const filterSensitiveLog = (obj: ServiceQuotaExceededException): any => ({ ...obj, }); @@ -187,6 +208,9 @@ export interface ThrottlingException extends __SmithyException, $MetadataBearer } export namespace ThrottlingException { + /** + * @internal + */ export const filterSensitiveLog = (obj: ThrottlingException): any => ({ ...obj, }); @@ -208,6 +232,9 @@ export interface ValidationExceptionField { } export namespace ValidationExceptionField { + /** + * @internal + */ export const filterSensitiveLog = (obj: ValidationExceptionField): any => ({ ...obj, }); @@ -239,6 +266,9 @@ export interface ValidationException extends __SmithyException, $MetadataBearer } export namespace ValidationException { + /** + * @internal + */ export const filterSensitiveLog = (obj: ValidationException): any => ({ ...obj, }); @@ -265,6 +295,9 @@ export interface DeleteArchiveRuleRequest { } export namespace DeleteArchiveRuleRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteArchiveRuleRequest): any => ({ ...obj, }); @@ -286,6 +319,9 @@ export interface GetArchiveRuleRequest { } export namespace GetArchiveRuleRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetArchiveRuleRequest): any => ({ ...obj, }); @@ -317,6 +353,9 @@ export interface ArchiveRuleSummary { } export namespace ArchiveRuleSummary { + /** + * @internal + */ export const filterSensitiveLog = (obj: ArchiveRuleSummary): any => ({ ...obj, }); @@ -333,6 +372,9 @@ export interface GetArchiveRuleResponse { } export namespace GetArchiveRuleResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetArchiveRuleResponse): any => ({ ...obj, }); @@ -359,6 +401,9 @@ export interface ListArchiveRulesRequest { } export namespace ListArchiveRulesRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListArchiveRulesRequest): any => ({ ...obj, }); @@ -380,6 +425,9 @@ export interface ListArchiveRulesResponse { } export namespace ListArchiveRulesResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListArchiveRulesResponse): any => ({ ...obj, }); @@ -412,6 +460,9 @@ export interface UpdateArchiveRuleRequest { } export namespace UpdateArchiveRuleRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateArchiveRuleRequest): any => ({ ...obj, }); @@ -434,6 +485,9 @@ export interface InlineArchiveRule { } export namespace InlineArchiveRule { + /** + * @internal + */ export const filterSensitiveLog = (obj: InlineArchiveRule): any => ({ ...obj, }); @@ -475,6 +529,9 @@ export interface CreateAnalyzerRequest { } export namespace CreateAnalyzerRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateAnalyzerRequest): any => ({ ...obj, }); @@ -491,6 +548,9 @@ export interface CreateAnalyzerResponse { } export namespace CreateAnalyzerResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateAnalyzerResponse): any => ({ ...obj, }); @@ -512,6 +572,9 @@ export interface DeleteAnalyzerRequest { } export namespace DeleteAnalyzerRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteAnalyzerRequest): any => ({ ...obj, }); @@ -528,6 +591,9 @@ export interface GetAnalyzerRequest { } export namespace GetAnalyzerRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetAnalyzerRequest): any => ({ ...obj, }); @@ -555,6 +621,9 @@ export interface StatusReason { } export namespace StatusReason { + /** + * @internal + */ export const filterSensitiveLog = (obj: StatusReason): any => ({ ...obj, }); @@ -621,6 +690,9 @@ export interface AnalyzerSummary { } export namespace AnalyzerSummary { + /** + * @internal + */ export const filterSensitiveLog = (obj: AnalyzerSummary): any => ({ ...obj, }); @@ -638,6 +710,9 @@ export interface GetAnalyzerResponse { } export namespace GetAnalyzerResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetAnalyzerResponse): any => ({ ...obj, }); @@ -664,6 +739,9 @@ export interface ListAnalyzersRequest { } export namespace ListAnalyzersRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListAnalyzersRequest): any => ({ ...obj, }); @@ -685,6 +763,9 @@ export interface ListAnalyzersResponse { } export namespace ListAnalyzersResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListAnalyzersResponse): any => ({ ...obj, }); @@ -711,6 +792,9 @@ export interface ApplyArchiveRuleRequest { } export namespace ApplyArchiveRuleRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ApplyArchiveRuleRequest): any => ({ ...obj, }); @@ -727,6 +811,9 @@ export interface CancelPolicyGenerationRequest { } export namespace CancelPolicyGenerationRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: CancelPolicyGenerationRequest): any => ({ ...obj, }); @@ -735,6 +822,9 @@ export namespace CancelPolicyGenerationRequest { export interface CancelPolicyGenerationResponse {} export namespace CancelPolicyGenerationResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: CancelPolicyGenerationResponse): any => ({ ...obj, }); @@ -758,6 +848,9 @@ export interface IamRoleConfiguration { } export namespace IamRoleConfiguration { + /** + * @internal + */ export const filterSensitiveLog = (obj: IamRoleConfiguration): any => ({ ...obj, }); @@ -789,6 +882,9 @@ export interface KmsGrantConstraints { } export namespace KmsGrantConstraints { + /** + * @internal + */ export const filterSensitiveLog = (obj: KmsGrantConstraints): any => ({ ...obj, }); @@ -847,6 +943,9 @@ export interface KmsGrantConfiguration { } export namespace KmsGrantConfiguration { + /** + * @internal + */ export const filterSensitiveLog = (obj: KmsGrantConfiguration): any => ({ ...obj, }); @@ -882,6 +981,9 @@ export interface KmsKeyConfiguration { } export namespace KmsKeyConfiguration { + /** + * @internal + */ export const filterSensitiveLog = (obj: KmsKeyConfiguration): any => ({ ...obj, }); @@ -894,6 +996,9 @@ export namespace KmsKeyConfiguration { export interface InternetConfiguration {} export namespace InternetConfiguration { + /** + * @internal + */ export const filterSensitiveLog = (obj: InternetConfiguration): any => ({ ...obj, }); @@ -913,6 +1018,9 @@ export interface VpcConfiguration { } export namespace VpcConfiguration { + /** + * @internal + */ export const filterSensitiveLog = (obj: VpcConfiguration): any => ({ ...obj, }); @@ -970,6 +1078,9 @@ export namespace NetworkOriginConfiguration { return visitor._(value.$unknown[0], value.$unknown[1]); }; + /** + * @internal + */ export const filterSensitiveLog = (obj: NetworkOriginConfiguration): any => { if (obj.vpcConfiguration !== undefined) return { vpcConfiguration: VpcConfiguration.filterSensitiveLog(obj.vpcConfiguration) }; @@ -1002,6 +1113,9 @@ export interface S3PublicAccessBlockConfiguration { } export namespace S3PublicAccessBlockConfiguration { + /** + * @internal + */ export const filterSensitiveLog = (obj: S3PublicAccessBlockConfiguration): any => ({ ...obj, }); @@ -1039,6 +1153,9 @@ export interface S3AccessPointConfiguration { } export namespace S3AccessPointConfiguration { + /** + * @internal + */ export const filterSensitiveLog = (obj: S3AccessPointConfiguration): any => ({ ...obj, ...(obj.networkOrigin && { networkOrigin: NetworkOriginConfiguration.filterSensitiveLog(obj.networkOrigin) }), @@ -1088,6 +1205,9 @@ export namespace AclGrantee { return visitor._(value.$unknown[0], value.$unknown[1]); }; + /** + * @internal + */ export const filterSensitiveLog = (obj: AclGrantee): any => { if (obj.id !== undefined) return { id: obj.id }; if (obj.uri !== undefined) return { uri: obj.uri }; @@ -1121,6 +1241,9 @@ export interface S3BucketAclGrantConfiguration { } export namespace S3BucketAclGrantConfiguration { + /** + * @internal + */ export const filterSensitiveLog = (obj: S3BucketAclGrantConfiguration): any => ({ ...obj, ...(obj.grantee && { grantee: AclGrantee.filterSensitiveLog(obj.grantee) }), @@ -1165,6 +1288,9 @@ export interface S3BucketConfiguration { } export namespace S3BucketConfiguration { + /** + * @internal + */ export const filterSensitiveLog = (obj: S3BucketConfiguration): any => ({ ...obj, ...(obj.bucketAclGrants && { @@ -1209,6 +1335,9 @@ export interface SecretsManagerSecretConfiguration { } export namespace SecretsManagerSecretConfiguration { + /** + * @internal + */ export const filterSensitiveLog = (obj: SecretsManagerSecretConfiguration): any => ({ ...obj, }); @@ -1233,6 +1362,9 @@ export interface SqsQueueConfiguration { } export namespace SqsQueueConfiguration { + /** + * @internal + */ export const filterSensitiveLog = (obj: SqsQueueConfiguration): any => ({ ...obj, }); @@ -1338,6 +1470,9 @@ export namespace Configuration { return visitor._(value.$unknown[0], value.$unknown[1]); }; + /** + * @internal + */ export const filterSensitiveLog = (obj: Configuration): any => { if (obj.iamRole !== undefined) return { iamRole: IamRoleConfiguration.filterSensitiveLog(obj.iamRole) }; if (obj.kmsKey !== undefined) return { kmsKey: KmsKeyConfiguration.filterSensitiveLog(obj.kmsKey) }; @@ -1373,6 +1508,9 @@ export interface CreateAccessPreviewRequest { } export namespace CreateAccessPreviewRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateAccessPreviewRequest): any => ({ ...obj, ...(obj.configurations && { @@ -1395,6 +1533,9 @@ export interface CreateAccessPreviewResponse { } export namespace CreateAccessPreviewResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateAccessPreviewResponse): any => ({ ...obj, }); @@ -1414,6 +1555,9 @@ export interface GetAccessPreviewRequest { } export namespace GetAccessPreviewRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetAccessPreviewRequest): any => ({ ...obj, }); @@ -1444,6 +1588,9 @@ export interface AccessPreviewStatusReason { } export namespace AccessPreviewStatusReason { + /** + * @internal + */ export const filterSensitiveLog = (obj: AccessPreviewStatusReason): any => ({ ...obj, }); @@ -1503,6 +1650,9 @@ export interface AccessPreview { } export namespace AccessPreview { + /** + * @internal + */ export const filterSensitiveLog = (obj: AccessPreview): any => ({ ...obj, ...(obj.configurations && { @@ -1525,6 +1675,9 @@ export interface GetAccessPreviewResponse { } export namespace GetAccessPreviewResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetAccessPreviewResponse): any => ({ ...obj, ...(obj.accessPreview && { accessPreview: AccessPreview.filterSensitiveLog(obj.accessPreview) }), @@ -1548,6 +1701,9 @@ export interface GetAnalyzedResourceRequest { } export namespace GetAnalyzedResourceRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetAnalyzedResourceRequest): any => ({ ...obj, }); @@ -1628,6 +1784,9 @@ export interface AnalyzedResource { } export namespace AnalyzedResource { + /** + * @internal + */ export const filterSensitiveLog = (obj: AnalyzedResource): any => ({ ...obj, }); @@ -1645,6 +1804,9 @@ export interface GetAnalyzedResourceResponse { } export namespace GetAnalyzedResourceResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetAnalyzedResourceResponse): any => ({ ...obj, }); @@ -1667,6 +1829,9 @@ export interface GetFindingRequest { } export namespace GetFindingRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetFindingRequest): any => ({ ...obj, }); @@ -1684,6 +1849,9 @@ export interface FindingSourceDetail { } export namespace FindingSourceDetail { + /** + * @internal + */ export const filterSensitiveLog = (obj: FindingSourceDetail): any => ({ ...obj, }); @@ -1709,6 +1877,9 @@ export interface FindingSource { } export namespace FindingSource { + /** + * @internal + */ export const filterSensitiveLog = (obj: FindingSource): any => ({ ...obj, }); @@ -1793,6 +1964,9 @@ export interface Finding { } export namespace Finding { + /** + * @internal + */ export const filterSensitiveLog = (obj: Finding): any => ({ ...obj, }); @@ -1809,6 +1983,9 @@ export interface GetFindingResponse { } export namespace GetFindingResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetFindingResponse): any => ({ ...obj, }); @@ -1842,6 +2019,9 @@ export interface GetGeneratedPolicyRequest { } export namespace GetGeneratedPolicyRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetGeneratedPolicyRequest): any => ({ ...obj, }); @@ -1859,6 +2039,9 @@ export interface GeneratedPolicy { } export namespace GeneratedPolicy { + /** + * @internal + */ export const filterSensitiveLog = (obj: GeneratedPolicy): any => ({ ...obj, }); @@ -1888,6 +2071,9 @@ export interface TrailProperties { } export namespace TrailProperties { + /** + * @internal + */ export const filterSensitiveLog = (obj: TrailProperties): any => ({ ...obj, }); @@ -1918,6 +2104,9 @@ export interface CloudTrailProperties { } export namespace CloudTrailProperties { + /** + * @internal + */ export const filterSensitiveLog = (obj: CloudTrailProperties): any => ({ ...obj, }); @@ -1946,6 +2135,9 @@ export interface GeneratedPolicyProperties { } export namespace GeneratedPolicyProperties { + /** + * @internal + */ export const filterSensitiveLog = (obj: GeneratedPolicyProperties): any => ({ ...obj, }); @@ -1969,6 +2161,9 @@ export interface GeneratedPolicyResult { } export namespace GeneratedPolicyResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: GeneratedPolicyResult): any => ({ ...obj, }); @@ -1998,6 +2193,9 @@ export interface JobError { } export namespace JobError { + /** + * @internal + */ export const filterSensitiveLog = (obj: JobError): any => ({ ...obj, }); @@ -2044,6 +2242,9 @@ export interface JobDetails { } export namespace JobDetails { + /** + * @internal + */ export const filterSensitiveLog = (obj: JobDetails): any => ({ ...obj, }); @@ -2064,6 +2265,9 @@ export interface GetGeneratedPolicyResponse { } export namespace GetGeneratedPolicyResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetGeneratedPolicyResponse): any => ({ ...obj, }); @@ -2098,6 +2302,9 @@ export interface ListAccessPreviewFindingsRequest { } export namespace ListAccessPreviewFindingsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListAccessPreviewFindingsRequest): any => ({ ...obj, }); @@ -2221,6 +2428,9 @@ export interface AccessPreviewFinding { } export namespace AccessPreviewFinding { + /** + * @internal + */ export const filterSensitiveLog = (obj: AccessPreviewFinding): any => ({ ...obj, }); @@ -2239,6 +2449,9 @@ export interface ListAccessPreviewFindingsResponse { } export namespace ListAccessPreviewFindingsResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListAccessPreviewFindingsResponse): any => ({ ...obj, }); @@ -2263,6 +2476,9 @@ export interface ListAccessPreviewsRequest { } export namespace ListAccessPreviewsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListAccessPreviewsRequest): any => ({ ...obj, }); @@ -2317,6 +2533,9 @@ export interface AccessPreviewSummary { } export namespace AccessPreviewSummary { + /** + * @internal + */ export const filterSensitiveLog = (obj: AccessPreviewSummary): any => ({ ...obj, }); @@ -2335,6 +2554,9 @@ export interface ListAccessPreviewsResponse { } export namespace ListAccessPreviewsResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListAccessPreviewsResponse): any => ({ ...obj, }); @@ -2367,6 +2589,9 @@ export interface ListAnalyzedResourcesRequest { } export namespace ListAnalyzedResourcesRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListAnalyzedResourcesRequest): any => ({ ...obj, }); @@ -2393,6 +2618,9 @@ export interface AnalyzedResourceSummary { } export namespace AnalyzedResourceSummary { + /** + * @internal + */ export const filterSensitiveLog = (obj: AnalyzedResourceSummary): any => ({ ...obj, }); @@ -2414,6 +2642,9 @@ export interface ListAnalyzedResourcesResponse { } export namespace ListAnalyzedResourcesResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListAnalyzedResourcesResponse): any => ({ ...obj, }); @@ -2437,6 +2668,9 @@ export interface SortCriteria { } export namespace SortCriteria { + /** + * @internal + */ export const filterSensitiveLog = (obj: SortCriteria): any => ({ ...obj, }); @@ -2474,6 +2708,9 @@ export interface ListFindingsRequest { } export namespace ListFindingsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListFindingsRequest): any => ({ ...obj, }); @@ -2559,6 +2796,9 @@ export interface FindingSummary { } export namespace FindingSummary { + /** + * @internal + */ export const filterSensitiveLog = (obj: FindingSummary): any => ({ ...obj, }); @@ -2581,6 +2821,9 @@ export interface ListFindingsResponse { } export namespace ListFindingsResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListFindingsResponse): any => ({ ...obj, }); @@ -2606,6 +2849,9 @@ export interface ListPolicyGenerationsRequest { } export namespace ListPolicyGenerationsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListPolicyGenerationsRequest): any => ({ ...obj, }); @@ -2645,6 +2891,9 @@ export interface PolicyGeneration { } export namespace PolicyGeneration { + /** + * @internal + */ export const filterSensitiveLog = (obj: PolicyGeneration): any => ({ ...obj, }); @@ -2664,6 +2913,9 @@ export interface ListPolicyGenerationsResponse { } export namespace ListPolicyGenerationsResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListPolicyGenerationsResponse): any => ({ ...obj, }); @@ -2680,6 +2932,9 @@ export interface ListTagsForResourceRequest { } export namespace ListTagsForResourceRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListTagsForResourceRequest): any => ({ ...obj, }); @@ -2696,6 +2951,9 @@ export interface ListTagsForResourceResponse { } export namespace ListTagsForResourceResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListTagsForResourceResponse): any => ({ ...obj, }); @@ -2725,6 +2983,9 @@ export interface Trail { } export namespace Trail { + /** + * @internal + */ export const filterSensitiveLog = (obj: Trail): any => ({ ...obj, }); @@ -2760,6 +3021,9 @@ export interface CloudTrailDetails { } export namespace CloudTrailDetails { + /** + * @internal + */ export const filterSensitiveLog = (obj: CloudTrailDetails): any => ({ ...obj, }); @@ -2777,6 +3041,9 @@ export interface PolicyGenerationDetails { } export namespace PolicyGenerationDetails { + /** + * @internal + */ export const filterSensitiveLog = (obj: PolicyGenerationDetails): any => ({ ...obj, }); @@ -2808,6 +3075,9 @@ export interface StartPolicyGenerationRequest { } export namespace StartPolicyGenerationRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: StartPolicyGenerationRequest): any => ({ ...obj, }); @@ -2824,6 +3094,9 @@ export interface StartPolicyGenerationResponse { } export namespace StartPolicyGenerationResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: StartPolicyGenerationResponse): any => ({ ...obj, }); @@ -2847,6 +3120,9 @@ export interface StartResourceScanRequest { } export namespace StartResourceScanRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: StartResourceScanRequest): any => ({ ...obj, }); @@ -2868,6 +3144,9 @@ export interface TagResourceRequest { } export namespace TagResourceRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: TagResourceRequest): any => ({ ...obj, }); @@ -2879,6 +3158,9 @@ export namespace TagResourceRequest { export interface TagResourceResponse {} export namespace TagResourceResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: TagResourceResponse): any => ({ ...obj, }); @@ -2900,6 +3182,9 @@ export interface UntagResourceRequest { } export namespace UntagResourceRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: UntagResourceRequest): any => ({ ...obj, }); @@ -2911,6 +3196,9 @@ export namespace UntagResourceRequest { export interface UntagResourceResponse {} export namespace UntagResourceResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: UntagResourceResponse): any => ({ ...obj, }); @@ -2952,6 +3240,9 @@ export interface UpdateFindingsRequest { } export namespace UpdateFindingsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateFindingsRequest): any => ({ ...obj, }); @@ -3011,6 +3302,9 @@ export interface ValidatePolicyRequest { } export namespace ValidatePolicyRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ValidatePolicyRequest): any => ({ ...obj, }); @@ -3039,6 +3333,9 @@ export interface Substring { } export namespace Substring { + /** + * @internal + */ export const filterSensitiveLog = (obj: Substring): any => ({ ...obj, }); @@ -3123,6 +3420,9 @@ export namespace PathElement { return visitor._(value.$unknown[0], value.$unknown[1]); }; + /** + * @internal + */ export const filterSensitiveLog = (obj: PathElement): any => { if (obj.index !== undefined) return { index: obj.index }; if (obj.key !== undefined) return { key: obj.key }; @@ -3153,6 +3453,9 @@ export interface Position { } export namespace Position { + /** + * @internal + */ export const filterSensitiveLog = (obj: Position): any => ({ ...obj, }); @@ -3175,6 +3478,9 @@ export interface Span { } export namespace Span { + /** + * @internal + */ export const filterSensitiveLog = (obj: Span): any => ({ ...obj, }); @@ -3197,6 +3503,9 @@ export interface Location { } export namespace Location { + /** + * @internal + */ export const filterSensitiveLog = (obj: Location): any => ({ ...obj, ...(obj.path && { path: obj.path.map((item) => PathElement.filterSensitiveLog(item)) }), @@ -3244,6 +3553,9 @@ export interface ValidatePolicyFinding { } export namespace ValidatePolicyFinding { + /** + * @internal + */ export const filterSensitiveLog = (obj: ValidatePolicyFinding): any => ({ ...obj, ...(obj.locations && { locations: obj.locations.map((item) => Location.filterSensitiveLog(item)) }), @@ -3264,6 +3576,9 @@ export interface ValidatePolicyResponse { } export namespace ValidatePolicyResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ValidatePolicyResponse): any => ({ ...obj, }); diff --git a/clients/client-acm-pca/commands/CreateCertificateAuthorityAuditReportCommand.ts b/clients/client-acm-pca/commands/CreateCertificateAuthorityAuditReportCommand.ts index 7cf2bda26e2b..2e5557b6483d 100644 --- a/clients/client-acm-pca/commands/CreateCertificateAuthorityAuditReportCommand.ts +++ b/clients/client-acm-pca/commands/CreateCertificateAuthorityAuditReportCommand.ts @@ -43,6 +43,20 @@ export interface CreateCertificateAuthorityAuditReportCommandOutput *

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

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ACMPCAClient, CreateCertificateAuthorityAuditReportCommand } from "@aws-sdk/client-acm-pca"; // ES Modules import + * // const { ACMPCAClient, CreateCertificateAuthorityAuditReportCommand } = require("@aws-sdk/client-acm-pca"); // CommonJS import + * const client = new ACMPCAClient(config); + * const command = new CreateCertificateAuthorityAuditReportCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreateCertificateAuthorityAuditReportCommandInput} for command's `input` shape. + * @see {@link CreateCertificateAuthorityAuditReportCommandOutput} for command's `response` shape. + * @see {@link ACMPCAClientResolvedConfig | config} for command's `input` shape. + * */ export class CreateCertificateAuthorityAuditReportCommand extends $Command< CreateCertificateAuthorityAuditReportCommandInput, diff --git a/clients/client-acm-pca/commands/CreateCertificateAuthorityCommand.ts b/clients/client-acm-pca/commands/CreateCertificateAuthorityCommand.ts index ef408256677c..d4336f35312b 100644 --- a/clients/client-acm-pca/commands/CreateCertificateAuthorityCommand.ts +++ b/clients/client-acm-pca/commands/CreateCertificateAuthorityCommand.ts @@ -40,6 +40,20 @@ export interface CreateCertificateAuthorityCommandOutput extends CreateCertifica * thrown. For more information, see Configure * Access to ACM Private CA.

* + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ACMPCAClient, CreateCertificateAuthorityCommand } from "@aws-sdk/client-acm-pca"; // ES Modules import + * // const { ACMPCAClient, CreateCertificateAuthorityCommand } = require("@aws-sdk/client-acm-pca"); // CommonJS import + * const client = new ACMPCAClient(config); + * const command = new CreateCertificateAuthorityCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreateCertificateAuthorityCommandInput} for command's `input` shape. + * @see {@link CreateCertificateAuthorityCommandOutput} for command's `response` shape. + * @see {@link ACMPCAClientResolvedConfig | config} for command's `input` shape. + * */ export class CreateCertificateAuthorityCommand extends $Command< CreateCertificateAuthorityCommandInput, diff --git a/clients/client-acm-pca/commands/CreatePermissionCommand.ts b/clients/client-acm-pca/commands/CreatePermissionCommand.ts index c6c61c5d3806..ee0fd76b02b6 100644 --- a/clients/client-acm-pca/commands/CreatePermissionCommand.ts +++ b/clients/client-acm-pca/commands/CreatePermissionCommand.ts @@ -48,6 +48,20 @@ export interface CreatePermissionCommandOutput extends __MetadataBearer {} * Based Policy with ACM Private CA.

* * + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ACMPCAClient, CreatePermissionCommand } from "@aws-sdk/client-acm-pca"; // ES Modules import + * // const { ACMPCAClient, CreatePermissionCommand } = require("@aws-sdk/client-acm-pca"); // CommonJS import + * const client = new ACMPCAClient(config); + * const command = new CreatePermissionCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreatePermissionCommandInput} for command's `input` shape. + * @see {@link CreatePermissionCommandOutput} for command's `response` shape. + * @see {@link ACMPCAClientResolvedConfig | config} for command's `input` shape. + * */ export class CreatePermissionCommand extends $Command< CreatePermissionCommandInput, diff --git a/clients/client-acm-pca/commands/DeleteCertificateAuthorityCommand.ts b/clients/client-acm-pca/commands/DeleteCertificateAuthorityCommand.ts index bb88dc6c6200..b1e98443f491 100644 --- a/clients/client-acm-pca/commands/DeleteCertificateAuthorityCommand.ts +++ b/clients/client-acm-pca/commands/DeleteCertificateAuthorityCommand.ts @@ -41,6 +41,20 @@ export interface DeleteCertificateAuthorityCommandOutput extends __MetadataBeare * 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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ACMPCAClient, DeleteCertificateAuthorityCommand } from "@aws-sdk/client-acm-pca"; // ES Modules import + * // const { ACMPCAClient, DeleteCertificateAuthorityCommand } = require("@aws-sdk/client-acm-pca"); // CommonJS import + * const client = new ACMPCAClient(config); + * const command = new DeleteCertificateAuthorityCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteCertificateAuthorityCommandInput} for command's `input` shape. + * @see {@link DeleteCertificateAuthorityCommandOutput} for command's `response` shape. + * @see {@link ACMPCAClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteCertificateAuthorityCommand extends $Command< DeleteCertificateAuthorityCommandInput, diff --git a/clients/client-acm-pca/commands/DeletePermissionCommand.ts b/clients/client-acm-pca/commands/DeletePermissionCommand.ts index 0599594c8aba..057c57e36088 100644 --- a/clients/client-acm-pca/commands/DeletePermissionCommand.ts +++ b/clients/client-acm-pca/commands/DeletePermissionCommand.ts @@ -50,6 +50,20 @@ export interface DeletePermissionCommandOutput extends __MetadataBearer {} * Based Policy with ACM Private CA.

* * + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ACMPCAClient, DeletePermissionCommand } from "@aws-sdk/client-acm-pca"; // ES Modules import + * // const { ACMPCAClient, DeletePermissionCommand } = require("@aws-sdk/client-acm-pca"); // CommonJS import + * const client = new ACMPCAClient(config); + * const command = new DeletePermissionCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeletePermissionCommandInput} for command's `input` shape. + * @see {@link DeletePermissionCommandOutput} for command's `response` shape. + * @see {@link ACMPCAClientResolvedConfig | config} for command's `input` shape. + * */ export class DeletePermissionCommand extends $Command< DeletePermissionCommandInput, diff --git a/clients/client-acm-pca/commands/DeletePolicyCommand.ts b/clients/client-acm-pca/commands/DeletePolicyCommand.ts index 6dfbfa3806e9..d2120716d75c 100644 --- a/clients/client-acm-pca/commands/DeletePolicyCommand.ts +++ b/clients/client-acm-pca/commands/DeletePolicyCommand.ts @@ -56,6 +56,20 @@ export interface DeletePolicyCommandOutput extends __MetadataBearer {} * Access.

* * + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ACMPCAClient, DeletePolicyCommand } from "@aws-sdk/client-acm-pca"; // ES Modules import + * // const { ACMPCAClient, DeletePolicyCommand } = require("@aws-sdk/client-acm-pca"); // CommonJS import + * const client = new ACMPCAClient(config); + * const command = new DeletePolicyCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeletePolicyCommandInput} for command's `input` shape. + * @see {@link DeletePolicyCommandOutput} for command's `response` shape. + * @see {@link ACMPCAClientResolvedConfig | config} for command's `input` shape. + * */ export class DeletePolicyCommand extends $Command< DeletePolicyCommandInput, diff --git a/clients/client-acm-pca/commands/DescribeCertificateAuthorityAuditReportCommand.ts b/clients/client-acm-pca/commands/DescribeCertificateAuthorityAuditReportCommand.ts index 79a910981289..6b4e11969fd1 100644 --- a/clients/client-acm-pca/commands/DescribeCertificateAuthorityAuditReportCommand.ts +++ b/clients/client-acm-pca/commands/DescribeCertificateAuthorityAuditReportCommand.ts @@ -31,6 +31,20 @@ export interface DescribeCertificateAuthorityAuditReportCommandOutput * 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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ACMPCAClient, DescribeCertificateAuthorityAuditReportCommand } from "@aws-sdk/client-acm-pca"; // ES Modules import + * // const { ACMPCAClient, DescribeCertificateAuthorityAuditReportCommand } = require("@aws-sdk/client-acm-pca"); // CommonJS import + * const client = new ACMPCAClient(config); + * const command = new DescribeCertificateAuthorityAuditReportCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeCertificateAuthorityAuditReportCommandInput} for command's `input` shape. + * @see {@link DescribeCertificateAuthorityAuditReportCommandOutput} for command's `response` shape. + * @see {@link ACMPCAClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeCertificateAuthorityAuditReportCommand extends $Command< DescribeCertificateAuthorityAuditReportCommandInput, diff --git a/clients/client-acm-pca/commands/DescribeCertificateAuthorityCommand.ts b/clients/client-acm-pca/commands/DescribeCertificateAuthorityCommand.ts index fe370e727485..bfa2df5e4c78 100644 --- a/clients/client-acm-pca/commands/DescribeCertificateAuthorityCommand.ts +++ b/clients/client-acm-pca/commands/DescribeCertificateAuthorityCommand.ts @@ -64,6 +64,20 @@ export interface DescribeCertificateAuthorityCommandOutput * restoration period is also included in this action's output.

* * + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ACMPCAClient, DescribeCertificateAuthorityCommand } from "@aws-sdk/client-acm-pca"; // ES Modules import + * // const { ACMPCAClient, DescribeCertificateAuthorityCommand } = require("@aws-sdk/client-acm-pca"); // CommonJS import + * const client = new ACMPCAClient(config); + * const command = new DescribeCertificateAuthorityCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeCertificateAuthorityCommandInput} for command's `input` shape. + * @see {@link DescribeCertificateAuthorityCommandOutput} for command's `response` shape. + * @see {@link ACMPCAClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeCertificateAuthorityCommand extends $Command< DescribeCertificateAuthorityCommandInput, diff --git a/clients/client-acm-pca/commands/GetCertificateAuthorityCertificateCommand.ts b/clients/client-acm-pca/commands/GetCertificateAuthorityCertificateCommand.ts index 4a0a3c966968..26b54ba92ccd 100644 --- a/clients/client-acm-pca/commands/GetCertificateAuthorityCertificateCommand.ts +++ b/clients/client-acm-pca/commands/GetCertificateAuthorityCertificateCommand.ts @@ -30,6 +30,20 @@ export interface GetCertificateAuthorityCertificateCommandOutput * (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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ACMPCAClient, GetCertificateAuthorityCertificateCommand } from "@aws-sdk/client-acm-pca"; // ES Modules import + * // const { ACMPCAClient, GetCertificateAuthorityCertificateCommand } = require("@aws-sdk/client-acm-pca"); // CommonJS import + * const client = new ACMPCAClient(config); + * const command = new GetCertificateAuthorityCertificateCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetCertificateAuthorityCertificateCommandInput} for command's `input` shape. + * @see {@link GetCertificateAuthorityCertificateCommandOutput} for command's `response` shape. + * @see {@link ACMPCAClientResolvedConfig | config} for command's `input` shape. + * */ export class GetCertificateAuthorityCertificateCommand extends $Command< GetCertificateAuthorityCertificateCommandInput, diff --git a/clients/client-acm-pca/commands/GetCertificateAuthorityCsrCommand.ts b/clients/client-acm-pca/commands/GetCertificateAuthorityCsrCommand.ts index c86c445957d2..60df5eceda86 100644 --- a/clients/client-acm-pca/commands/GetCertificateAuthorityCsrCommand.ts +++ b/clients/client-acm-pca/commands/GetCertificateAuthorityCsrCommand.ts @@ -26,6 +26,20 @@ export interface GetCertificateAuthorityCsrCommandOutput extends GetCertificateA * on-premises root or subordinate CA. Then import the signed certificate back into ACM Private CA * by calling the ImportCertificateAuthorityCertificate action. The CSR is returned as a * base64 PEM-encoded string.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ACMPCAClient, GetCertificateAuthorityCsrCommand } from "@aws-sdk/client-acm-pca"; // ES Modules import + * // const { ACMPCAClient, GetCertificateAuthorityCsrCommand } = require("@aws-sdk/client-acm-pca"); // CommonJS import + * const client = new ACMPCAClient(config); + * const command = new GetCertificateAuthorityCsrCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetCertificateAuthorityCsrCommandInput} for command's `input` shape. + * @see {@link GetCertificateAuthorityCsrCommandOutput} for command's `response` shape. + * @see {@link ACMPCAClientResolvedConfig | config} for command's `input` shape. + * */ export class GetCertificateAuthorityCsrCommand extends $Command< GetCertificateAuthorityCsrCommandInput, diff --git a/clients/client-acm-pca/commands/GetCertificateCommand.ts b/clients/client-acm-pca/commands/GetCertificateCommand.ts index 490e3dce31ac..a165a63271de 100644 --- a/clients/client-acm-pca/commands/GetCertificateCommand.ts +++ b/clients/client-acm-pca/commands/GetCertificateCommand.ts @@ -29,6 +29,20 @@ export interface GetCertificateCommandOutput extends GetCertificateResponse, __M * the CreateCertificateAuthorityAuditReport action to create a report that * contains information about all of the certificates issued and revoked by your private * CA.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ACMPCAClient, GetCertificateCommand } from "@aws-sdk/client-acm-pca"; // ES Modules import + * // const { ACMPCAClient, GetCertificateCommand } = require("@aws-sdk/client-acm-pca"); // CommonJS import + * const client = new ACMPCAClient(config); + * const command = new GetCertificateCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetCertificateCommandInput} for command's `input` shape. + * @see {@link GetCertificateCommandOutput} for command's `response` shape. + * @see {@link ACMPCAClientResolvedConfig | config} for command's `input` shape. + * */ export class GetCertificateCommand extends $Command< GetCertificateCommandInput, diff --git a/clients/client-acm-pca/commands/GetPolicyCommand.ts b/clients/client-acm-pca/commands/GetPolicyCommand.ts index 4291d4224562..dacb5fc215f9 100644 --- a/clients/client-acm-pca/commands/GetPolicyCommand.ts +++ b/clients/client-acm-pca/commands/GetPolicyCommand.ts @@ -49,6 +49,20 @@ export interface GetPolicyCommandOutput extends GetPolicyResponse, __MetadataBea * Access.

* * + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ACMPCAClient, GetPolicyCommand } from "@aws-sdk/client-acm-pca"; // ES Modules import + * // const { ACMPCAClient, GetPolicyCommand } = require("@aws-sdk/client-acm-pca"); // CommonJS import + * const client = new ACMPCAClient(config); + * const command = new GetPolicyCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetPolicyCommandInput} for command's `input` shape. + * @see {@link GetPolicyCommandOutput} for command's `response` shape. + * @see {@link ACMPCAClientResolvedConfig | config} for command's `input` shape. + * */ export class GetPolicyCommand extends $Command< GetPolicyCommandInput, diff --git a/clients/client-acm-pca/commands/ImportCertificateAuthorityCertificateCommand.ts b/clients/client-acm-pca/commands/ImportCertificateAuthorityCertificateCommand.ts index 1c732fa033e8..907dccc12786 100644 --- a/clients/client-acm-pca/commands/ImportCertificateAuthorityCertificateCommand.ts +++ b/clients/client-acm-pca/commands/ImportCertificateAuthorityCertificateCommand.ts @@ -150,6 +150,20 @@ export interface ImportCertificateAuthorityCertificateCommandOutput extends __Me *

Any other extension

* * + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ACMPCAClient, ImportCertificateAuthorityCertificateCommand } from "@aws-sdk/client-acm-pca"; // ES Modules import + * // const { ACMPCAClient, ImportCertificateAuthorityCertificateCommand } = require("@aws-sdk/client-acm-pca"); // CommonJS import + * const client = new ACMPCAClient(config); + * const command = new ImportCertificateAuthorityCertificateCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ImportCertificateAuthorityCertificateCommandInput} for command's `input` shape. + * @see {@link ImportCertificateAuthorityCertificateCommandOutput} for command's `response` shape. + * @see {@link ACMPCAClientResolvedConfig | config} for command's `input` shape. + * */ export class ImportCertificateAuthorityCertificateCommand extends $Command< ImportCertificateAuthorityCertificateCommandInput, diff --git a/clients/client-acm-pca/commands/IssueCertificateCommand.ts b/clients/client-acm-pca/commands/IssueCertificateCommand.ts index aa5541334d54..cf75589475cf 100644 --- a/clients/client-acm-pca/commands/IssueCertificateCommand.ts +++ b/clients/client-acm-pca/commands/IssueCertificateCommand.ts @@ -29,6 +29,20 @@ export interface IssueCertificateCommandOutput extends IssueCertificateResponse, *

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

* + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ACMPCAClient, IssueCertificateCommand } from "@aws-sdk/client-acm-pca"; // ES Modules import + * // const { ACMPCAClient, IssueCertificateCommand } = require("@aws-sdk/client-acm-pca"); // CommonJS import + * const client = new ACMPCAClient(config); + * const command = new IssueCertificateCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link IssueCertificateCommandInput} for command's `input` shape. + * @see {@link IssueCertificateCommandOutput} for command's `response` shape. + * @see {@link ACMPCAClientResolvedConfig | config} for command's `input` shape. + * */ export class IssueCertificateCommand extends $Command< IssueCertificateCommandInput, diff --git a/clients/client-acm-pca/commands/ListCertificateAuthoritiesCommand.ts b/clients/client-acm-pca/commands/ListCertificateAuthoritiesCommand.ts index b7a013a0d851..500145234e21 100644 --- a/clients/client-acm-pca/commands/ListCertificateAuthoritiesCommand.ts +++ b/clients/client-acm-pca/commands/ListCertificateAuthoritiesCommand.ts @@ -22,6 +22,20 @@ export interface ListCertificateAuthoritiesCommandOutput extends ListCertificate /** *

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

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ACMPCAClient, ListCertificateAuthoritiesCommand } from "@aws-sdk/client-acm-pca"; // ES Modules import + * // const { ACMPCAClient, ListCertificateAuthoritiesCommand } = require("@aws-sdk/client-acm-pca"); // CommonJS import + * const client = new ACMPCAClient(config); + * const command = new ListCertificateAuthoritiesCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListCertificateAuthoritiesCommandInput} for command's `input` shape. + * @see {@link ListCertificateAuthoritiesCommandOutput} for command's `response` shape. + * @see {@link ACMPCAClientResolvedConfig | config} for command's `input` shape. + * */ export class ListCertificateAuthoritiesCommand extends $Command< ListCertificateAuthoritiesCommandInput, diff --git a/clients/client-acm-pca/commands/ListPermissionsCommand.ts b/clients/client-acm-pca/commands/ListPermissionsCommand.ts index f79dff0b32ff..f411e1b24bba 100644 --- a/clients/client-acm-pca/commands/ListPermissionsCommand.ts +++ b/clients/client-acm-pca/commands/ListPermissionsCommand.ts @@ -49,6 +49,20 @@ export interface ListPermissionsCommandOutput extends ListPermissionsResponse, _ * Based Policy with ACM Private CA.

* * + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ACMPCAClient, ListPermissionsCommand } from "@aws-sdk/client-acm-pca"; // ES Modules import + * // const { ACMPCAClient, ListPermissionsCommand } = require("@aws-sdk/client-acm-pca"); // CommonJS import + * const client = new ACMPCAClient(config); + * const command = new ListPermissionsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListPermissionsCommandInput} for command's `input` shape. + * @see {@link ListPermissionsCommandOutput} for command's `response` shape. + * @see {@link ACMPCAClientResolvedConfig | config} for command's `input` shape. + * */ export class ListPermissionsCommand extends $Command< ListPermissionsCommandInput, diff --git a/clients/client-acm-pca/commands/ListTagsCommand.ts b/clients/client-acm-pca/commands/ListTagsCommand.ts index a5b7e7471c2b..d76ea009797a 100644 --- a/clients/client-acm-pca/commands/ListTagsCommand.ts +++ b/clients/client-acm-pca/commands/ListTagsCommand.ts @@ -22,6 +22,20 @@ export interface ListTagsCommandOutput extends ListTagsResponse, __MetadataBeare * 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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ACMPCAClient, ListTagsCommand } from "@aws-sdk/client-acm-pca"; // ES Modules import + * // const { ACMPCAClient, ListTagsCommand } = require("@aws-sdk/client-acm-pca"); // CommonJS import + * const client = new ACMPCAClient(config); + * const command = new ListTagsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListTagsCommandInput} for command's `input` shape. + * @see {@link ListTagsCommandOutput} for command's `response` shape. + * @see {@link ACMPCAClientResolvedConfig | config} for command's `input` shape. + * */ export class ListTagsCommand extends $Command { // Start section: command_properties diff --git a/clients/client-acm-pca/commands/PutPolicyCommand.ts b/clients/client-acm-pca/commands/PutPolicyCommand.ts index d766557a62aa..71a7210efcef 100644 --- a/clients/client-acm-pca/commands/PutPolicyCommand.ts +++ b/clients/client-acm-pca/commands/PutPolicyCommand.ts @@ -50,6 +50,20 @@ export interface PutPolicyCommandOutput extends __MetadataBearer {} * Access.

* * + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ACMPCAClient, PutPolicyCommand } from "@aws-sdk/client-acm-pca"; // ES Modules import + * // const { ACMPCAClient, PutPolicyCommand } = require("@aws-sdk/client-acm-pca"); // CommonJS import + * const client = new ACMPCAClient(config); + * const command = new PutPolicyCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link PutPolicyCommandInput} for command's `input` shape. + * @see {@link PutPolicyCommandOutput} for command's `response` shape. + * @see {@link ACMPCAClientResolvedConfig | config} for command's `input` shape. + * */ export class PutPolicyCommand extends $Command< PutPolicyCommandInput, diff --git a/clients/client-acm-pca/commands/RestoreCertificateAuthorityCommand.ts b/clients/client-acm-pca/commands/RestoreCertificateAuthorityCommand.ts index b63ea3566809..7c8b7600e935 100644 --- a/clients/client-acm-pca/commands/RestoreCertificateAuthorityCommand.ts +++ b/clients/client-acm-pca/commands/RestoreCertificateAuthorityCommand.ts @@ -32,6 +32,20 @@ export interface RestoreCertificateAuthorityCommandOutput extends __MetadataBear * 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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ACMPCAClient, RestoreCertificateAuthorityCommand } from "@aws-sdk/client-acm-pca"; // ES Modules import + * // const { ACMPCAClient, RestoreCertificateAuthorityCommand } = require("@aws-sdk/client-acm-pca"); // CommonJS import + * const client = new ACMPCAClient(config); + * const command = new RestoreCertificateAuthorityCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link RestoreCertificateAuthorityCommandInput} for command's `input` shape. + * @see {@link RestoreCertificateAuthorityCommandOutput} for command's `response` shape. + * @see {@link ACMPCAClientResolvedConfig | config} for command's `input` shape. + * */ export class RestoreCertificateAuthorityCommand extends $Command< RestoreCertificateAuthorityCommandInput, diff --git a/clients/client-acm-pca/commands/RevokeCertificateCommand.ts b/clients/client-acm-pca/commands/RevokeCertificateCommand.ts index 3c7cfe018a03..9bff86df3ea8 100644 --- a/clients/client-acm-pca/commands/RevokeCertificateCommand.ts +++ b/clients/client-acm-pca/commands/RevokeCertificateCommand.ts @@ -41,6 +41,20 @@ export interface RevokeCertificateCommandOutput extends __MetadataBearer {} * *

You cannot revoke a root CA self-signed certificate.

* + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ACMPCAClient, RevokeCertificateCommand } from "@aws-sdk/client-acm-pca"; // ES Modules import + * // const { ACMPCAClient, RevokeCertificateCommand } = require("@aws-sdk/client-acm-pca"); // CommonJS import + * const client = new ACMPCAClient(config); + * const command = new RevokeCertificateCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link RevokeCertificateCommandInput} for command's `input` shape. + * @see {@link RevokeCertificateCommandOutput} for command's `response` shape. + * @see {@link ACMPCAClientResolvedConfig | config} for command's `input` shape. + * */ export class RevokeCertificateCommand extends $Command< RevokeCertificateCommandInput, diff --git a/clients/client-acm-pca/commands/TagCertificateAuthorityCommand.ts b/clients/client-acm-pca/commands/TagCertificateAuthorityCommand.ts index 22051721af8a..e207783adb64 100644 --- a/clients/client-acm-pca/commands/TagCertificateAuthorityCommand.ts +++ b/clients/client-acm-pca/commands/TagCertificateAuthorityCommand.ts @@ -29,6 +29,20 @@ export interface TagCertificateAuthorityCommandOutput extends __MetadataBearer { * 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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ACMPCAClient, TagCertificateAuthorityCommand } from "@aws-sdk/client-acm-pca"; // ES Modules import + * // const { ACMPCAClient, TagCertificateAuthorityCommand } = require("@aws-sdk/client-acm-pca"); // CommonJS import + * const client = new ACMPCAClient(config); + * const command = new TagCertificateAuthorityCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link TagCertificateAuthorityCommandInput} for command's `input` shape. + * @see {@link TagCertificateAuthorityCommandOutput} for command's `response` shape. + * @see {@link ACMPCAClientResolvedConfig | config} for command's `input` shape. + * */ export class TagCertificateAuthorityCommand extends $Command< TagCertificateAuthorityCommandInput, diff --git a/clients/client-acm-pca/commands/UntagCertificateAuthorityCommand.ts b/clients/client-acm-pca/commands/UntagCertificateAuthorityCommand.ts index 31cf61b24b83..229e2442145c 100644 --- a/clients/client-acm-pca/commands/UntagCertificateAuthorityCommand.ts +++ b/clients/client-acm-pca/commands/UntagCertificateAuthorityCommand.ts @@ -26,6 +26,20 @@ export interface UntagCertificateAuthorityCommandOutput extends __MetadataBearer * 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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ACMPCAClient, UntagCertificateAuthorityCommand } from "@aws-sdk/client-acm-pca"; // ES Modules import + * // const { ACMPCAClient, UntagCertificateAuthorityCommand } = require("@aws-sdk/client-acm-pca"); // CommonJS import + * const client = new ACMPCAClient(config); + * const command = new UntagCertificateAuthorityCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link UntagCertificateAuthorityCommandInput} for command's `input` shape. + * @see {@link UntagCertificateAuthorityCommandOutput} for command's `response` shape. + * @see {@link ACMPCAClientResolvedConfig | config} for command's `input` shape. + * */ export class UntagCertificateAuthorityCommand extends $Command< UntagCertificateAuthorityCommandInput, diff --git a/clients/client-acm-pca/commands/UpdateCertificateAuthorityCommand.ts b/clients/client-acm-pca/commands/UpdateCertificateAuthorityCommand.ts index f32ee6c27438..7662a98d5383 100644 --- a/clients/client-acm-pca/commands/UpdateCertificateAuthorityCommand.ts +++ b/clients/client-acm-pca/commands/UpdateCertificateAuthorityCommand.ts @@ -32,6 +32,20 @@ export interface UpdateCertificateAuthorityCommandOutput extends __MetadataBeare * thrown. For more information, see Configure * Access to ACM Private CA.

* + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ACMPCAClient, UpdateCertificateAuthorityCommand } from "@aws-sdk/client-acm-pca"; // ES Modules import + * // const { ACMPCAClient, UpdateCertificateAuthorityCommand } = require("@aws-sdk/client-acm-pca"); // CommonJS import + * const client = new ACMPCAClient(config); + * const command = new UpdateCertificateAuthorityCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link UpdateCertificateAuthorityCommandInput} for command's `input` shape. + * @see {@link UpdateCertificateAuthorityCommandOutput} for command's `response` shape. + * @see {@link ACMPCAClientResolvedConfig | config} for command's `input` shape. + * */ export class UpdateCertificateAuthorityCommand extends $Command< UpdateCertificateAuthorityCommandInput, diff --git a/clients/client-acm-pca/models/models_0.ts b/clients/client-acm-pca/models/models_0.ts index 0c480c677b5c..0d3b227b7974 100644 --- a/clients/client-acm-pca/models/models_0.ts +++ b/clients/client-acm-pca/models/models_0.ts @@ -94,6 +94,9 @@ export interface ASN1Subject { } export namespace ASN1Subject { + /** + * @internal + */ export const filterSensitiveLog = (obj: ASN1Subject): any => ({ ...obj, }); @@ -117,6 +120,9 @@ export interface EdiPartyName { } export namespace EdiPartyName { + /** + * @internal + */ export const filterSensitiveLog = (obj: EdiPartyName): any => ({ ...obj, }); @@ -141,6 +147,9 @@ export interface OtherName { } export namespace OtherName { + /** + * @internal + */ export const filterSensitiveLog = (obj: OtherName): any => ({ ...obj, }); @@ -198,6 +207,9 @@ export interface GeneralName { } export namespace GeneralName { + /** + * @internal + */ export const filterSensitiveLog = (obj: GeneralName): any => ({ ...obj, }); @@ -230,6 +242,9 @@ export interface AccessMethod { } export namespace AccessMethod { + /** + * @internal + */ export const filterSensitiveLog = (obj: AccessMethod): any => ({ ...obj, }); @@ -252,6 +267,9 @@ export interface AccessDescription { } export namespace AccessDescription { + /** + * @internal + */ export const filterSensitiveLog = (obj: AccessDescription): any => ({ ...obj, }); @@ -309,6 +327,9 @@ export interface KeyUsage { } export namespace KeyUsage { + /** + * @internal + */ export const filterSensitiveLog = (obj: KeyUsage): any => ({ ...obj, }); @@ -334,6 +355,9 @@ export interface CsrExtensions { } export namespace CsrExtensions { + /** + * @internal + */ export const filterSensitiveLog = (obj: CsrExtensions): any => ({ ...obj, }); @@ -391,6 +415,9 @@ export interface CertificateAuthorityConfiguration { } export namespace CertificateAuthorityConfiguration { + /** + * @internal + */ export const filterSensitiveLog = (obj: CertificateAuthorityConfiguration): any => ({ ...obj, }); @@ -542,6 +569,9 @@ export interface CrlConfiguration { } export namespace CrlConfiguration { + /** + * @internal + */ export const filterSensitiveLog = (obj: CrlConfiguration): any => ({ ...obj, }); @@ -561,6 +591,9 @@ export interface RevocationConfiguration { } export namespace RevocationConfiguration { + /** + * @internal + */ export const filterSensitiveLog = (obj: RevocationConfiguration): any => ({ ...obj, }); @@ -585,6 +618,9 @@ export interface Tag { } export namespace Tag { + /** + * @internal + */ export const filterSensitiveLog = (obj: Tag): any => ({ ...obj, }); @@ -630,6 +666,9 @@ export interface CreateCertificateAuthorityRequest { } export namespace CreateCertificateAuthorityRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateCertificateAuthorityRequest): any => ({ ...obj, }); @@ -648,6 +687,9 @@ export interface CreateCertificateAuthorityResponse { } export namespace CreateCertificateAuthorityResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateCertificateAuthorityResponse): any => ({ ...obj, }); @@ -663,6 +705,9 @@ export interface InvalidArgsException extends __SmithyException, $MetadataBearer } export namespace InvalidArgsException { + /** + * @internal + */ export const filterSensitiveLog = (obj: InvalidArgsException): any => ({ ...obj, }); @@ -679,6 +724,9 @@ export interface InvalidPolicyException extends __SmithyException, $MetadataBear } export namespace InvalidPolicyException { + /** + * @internal + */ export const filterSensitiveLog = (obj: InvalidPolicyException): any => ({ ...obj, }); @@ -695,6 +743,9 @@ export interface InvalidTagException extends __SmithyException, $MetadataBearer } export namespace InvalidTagException { + /** + * @internal + */ export const filterSensitiveLog = (obj: InvalidTagException): any => ({ ...obj, }); @@ -711,6 +762,9 @@ export interface LimitExceededException extends __SmithyException, $MetadataBear } export namespace LimitExceededException { + /** + * @internal + */ export const filterSensitiveLog = (obj: LimitExceededException): any => ({ ...obj, }); @@ -742,6 +796,9 @@ export interface CreateCertificateAuthorityAuditReportRequest { } export namespace CreateCertificateAuthorityAuditReportRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateCertificateAuthorityAuditReportRequest): any => ({ ...obj, }); @@ -761,6 +818,9 @@ export interface CreateCertificateAuthorityAuditReportResponse { } export namespace CreateCertificateAuthorityAuditReportResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateCertificateAuthorityAuditReportResponse): any => ({ ...obj, }); @@ -777,6 +837,9 @@ export interface InvalidArnException extends __SmithyException, $MetadataBearer } export namespace InvalidArnException { + /** + * @internal + */ export const filterSensitiveLog = (obj: InvalidArnException): any => ({ ...obj, }); @@ -792,6 +855,9 @@ export interface InvalidStateException extends __SmithyException, $MetadataBeare } export namespace InvalidStateException { + /** + * @internal + */ export const filterSensitiveLog = (obj: InvalidStateException): any => ({ ...obj, }); @@ -807,6 +873,9 @@ export interface RequestFailedException extends __SmithyException, $MetadataBear } export namespace RequestFailedException { + /** + * @internal + */ export const filterSensitiveLog = (obj: RequestFailedException): any => ({ ...obj, }); @@ -822,6 +891,9 @@ export interface RequestInProgressException extends __SmithyException, $Metadata } export namespace RequestInProgressException { + /** + * @internal + */ export const filterSensitiveLog = (obj: RequestInProgressException): any => ({ ...obj, }); @@ -838,6 +910,9 @@ export interface ResourceNotFoundException extends __SmithyException, $MetadataB } export namespace ResourceNotFoundException { + /** + * @internal + */ export const filterSensitiveLog = (obj: ResourceNotFoundException): any => ({ ...obj, }); @@ -880,6 +955,9 @@ export interface CreatePermissionRequest { } export namespace CreatePermissionRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreatePermissionRequest): any => ({ ...obj, }); @@ -895,6 +973,9 @@ export interface PermissionAlreadyExistsException extends __SmithyException, $Me } export namespace PermissionAlreadyExistsException { + /** + * @internal + */ export const filterSensitiveLog = (obj: PermissionAlreadyExistsException): any => ({ ...obj, }); @@ -910,6 +991,9 @@ export interface ConcurrentModificationException extends __SmithyException, $Met } export namespace ConcurrentModificationException { + /** + * @internal + */ export const filterSensitiveLog = (obj: ConcurrentModificationException): any => ({ ...obj, }); @@ -933,6 +1017,9 @@ export interface DeleteCertificateAuthorityRequest { } export namespace DeleteCertificateAuthorityRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteCertificateAuthorityRequest): any => ({ ...obj, }); @@ -963,6 +1050,9 @@ export interface DeletePermissionRequest { } export namespace DeletePermissionRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeletePermissionRequest): any => ({ ...obj, }); @@ -979,6 +1069,9 @@ export interface DeletePolicyRequest { } export namespace DeletePolicyRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeletePolicyRequest): any => ({ ...obj, }); @@ -996,6 +1089,9 @@ export interface LockoutPreventedException extends __SmithyException, $MetadataB } export namespace LockoutPreventedException { + /** + * @internal + */ export const filterSensitiveLog = (obj: LockoutPreventedException): any => ({ ...obj, }); @@ -1013,6 +1109,9 @@ export interface DescribeCertificateAuthorityRequest { } export namespace DescribeCertificateAuthorityRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeCertificateAuthorityRequest): any => ({ ...obj, }); @@ -1118,6 +1217,9 @@ export interface CertificateAuthority { } export namespace CertificateAuthority { + /** + * @internal + */ export const filterSensitiveLog = (obj: CertificateAuthority): any => ({ ...obj, }); @@ -1132,6 +1234,9 @@ export interface DescribeCertificateAuthorityResponse { } export namespace DescribeCertificateAuthorityResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeCertificateAuthorityResponse): any => ({ ...obj, }); @@ -1154,6 +1259,9 @@ export interface DescribeCertificateAuthorityAuditReportRequest { } export namespace DescribeCertificateAuthorityAuditReportRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeCertificateAuthorityAuditReportRequest): any => ({ ...obj, }); @@ -1189,6 +1297,9 @@ export interface DescribeCertificateAuthorityAuditReportResponse { } export namespace DescribeCertificateAuthorityAuditReportResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeCertificateAuthorityAuditReportResponse): any => ({ ...obj, }); @@ -1216,6 +1327,9 @@ export interface GetCertificateRequest { } export namespace GetCertificateRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetCertificateRequest): any => ({ ...obj, }); @@ -1236,6 +1350,9 @@ export interface GetCertificateResponse { } export namespace GetCertificateResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetCertificateResponse): any => ({ ...obj, }); @@ -1253,6 +1370,9 @@ export interface GetCertificateAuthorityCertificateRequest { } export namespace GetCertificateAuthorityCertificateRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetCertificateAuthorityCertificateRequest): any => ({ ...obj, }); @@ -1274,6 +1394,9 @@ export interface GetCertificateAuthorityCertificateResponse { } export namespace GetCertificateAuthorityCertificateResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetCertificateAuthorityCertificateResponse): any => ({ ...obj, }); @@ -1291,6 +1414,9 @@ export interface GetCertificateAuthorityCsrRequest { } export namespace GetCertificateAuthorityCsrRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetCertificateAuthorityCsrRequest): any => ({ ...obj, }); @@ -1305,6 +1431,9 @@ export interface GetCertificateAuthorityCsrResponse { } export namespace GetCertificateAuthorityCsrResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetCertificateAuthorityCsrResponse): any => ({ ...obj, }); @@ -1321,6 +1450,9 @@ export interface GetPolicyRequest { } export namespace GetPolicyRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetPolicyRequest): any => ({ ...obj, }); @@ -1334,6 +1466,9 @@ export interface GetPolicyResponse { } export namespace GetPolicyResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetPolicyResponse): any => ({ ...obj, }); @@ -1350,6 +1485,9 @@ export interface CertificateMismatchException extends __SmithyException, $Metada } export namespace CertificateMismatchException { + /** + * @internal + */ export const filterSensitiveLog = (obj: CertificateMismatchException): any => ({ ...obj, }); @@ -1383,6 +1521,9 @@ export interface ImportCertificateAuthorityCertificateRequest { } export namespace ImportCertificateAuthorityCertificateRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ImportCertificateAuthorityCertificateRequest): any => ({ ...obj, }); @@ -1398,6 +1539,9 @@ export interface InvalidRequestException extends __SmithyException, $MetadataBea } export namespace InvalidRequestException { + /** + * @internal + */ export const filterSensitiveLog = (obj: InvalidRequestException): any => ({ ...obj, }); @@ -1413,6 +1557,9 @@ export interface MalformedCertificateException extends __SmithyException, $Metad } export namespace MalformedCertificateException { + /** + * @internal + */ export const filterSensitiveLog = (obj: MalformedCertificateException): any => ({ ...obj, }); @@ -1435,6 +1582,9 @@ export interface Qualifier { } export namespace Qualifier { + /** + * @internal + */ export const filterSensitiveLog = (obj: Qualifier): any => ({ ...obj, }); @@ -1458,6 +1608,9 @@ export interface PolicyQualifierInfo { } export namespace PolicyQualifierInfo { + /** + * @internal + */ export const filterSensitiveLog = (obj: PolicyQualifierInfo): any => ({ ...obj, }); @@ -1482,6 +1635,9 @@ export interface PolicyInformation { } export namespace PolicyInformation { + /** + * @internal + */ export const filterSensitiveLog = (obj: PolicyInformation): any => ({ ...obj, }); @@ -1517,6 +1673,9 @@ export interface ExtendedKeyUsage { } export namespace ExtendedKeyUsage { + /** + * @internal + */ export const filterSensitiveLog = (obj: ExtendedKeyUsage): any => ({ ...obj, }); @@ -1559,6 +1718,9 @@ export interface Extensions { } export namespace Extensions { + /** + * @internal + */ export const filterSensitiveLog = (obj: Extensions): any => ({ ...obj, }); @@ -1589,6 +1751,9 @@ export interface ApiPassthrough { } export namespace ApiPassthrough { + /** + * @internal + */ export const filterSensitiveLog = (obj: ApiPassthrough): any => ({ ...obj, }); @@ -1670,6 +1835,9 @@ export interface Validity { } export namespace Validity { + /** + * @internal + */ export const filterSensitiveLog = (obj: Validity): any => ({ ...obj, }); @@ -1781,6 +1949,9 @@ export interface IssueCertificateRequest { } export namespace IssueCertificateRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: IssueCertificateRequest): any => ({ ...obj, }); @@ -1799,6 +1970,9 @@ export interface IssueCertificateResponse { } export namespace IssueCertificateResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: IssueCertificateResponse): any => ({ ...obj, }); @@ -1814,6 +1988,9 @@ export interface MalformedCSRException extends __SmithyException, $MetadataBeare } export namespace MalformedCSRException { + /** + * @internal + */ export const filterSensitiveLog = (obj: MalformedCSRException): any => ({ ...obj, }); @@ -1830,6 +2007,9 @@ export interface InvalidNextTokenException extends __SmithyException, $MetadataB } export namespace InvalidNextTokenException { + /** + * @internal + */ export const filterSensitiveLog = (obj: InvalidNextTokenException): any => ({ ...obj, }); @@ -1865,6 +2045,9 @@ export interface ListCertificateAuthoritiesRequest { } export namespace ListCertificateAuthoritiesRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListCertificateAuthoritiesRequest): any => ({ ...obj, }); @@ -1884,6 +2067,9 @@ export interface ListCertificateAuthoritiesResponse { } export namespace ListCertificateAuthoritiesResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListCertificateAuthoritiesResponse): any => ({ ...obj, }); @@ -1915,6 +2101,9 @@ export interface ListPermissionsRequest { } export namespace ListPermissionsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListPermissionsRequest): any => ({ ...obj, }); @@ -1964,6 +2153,9 @@ export interface Permission { } export namespace Permission { + /** + * @internal + */ export const filterSensitiveLog = (obj: Permission): any => ({ ...obj, }); @@ -1984,6 +2176,9 @@ export interface ListPermissionsResponse { } export namespace ListPermissionsResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListPermissionsResponse): any => ({ ...obj, }); @@ -2016,6 +2211,9 @@ export interface ListTagsRequest { } export namespace ListTagsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListTagsRequest): any => ({ ...obj, }); @@ -2035,6 +2233,9 @@ export interface ListTagsResponse { } export namespace ListTagsResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListTagsResponse): any => ({ ...obj, }); @@ -2059,6 +2260,9 @@ export interface PutPolicyRequest { } export namespace PutPolicyRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: PutPolicyRequest): any => ({ ...obj, }); @@ -2076,6 +2280,9 @@ export interface RestoreCertificateAuthorityRequest { } export namespace RestoreCertificateAuthorityRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: RestoreCertificateAuthorityRequest): any => ({ ...obj, }); @@ -2091,6 +2298,9 @@ export interface RequestAlreadyProcessedException extends __SmithyException, $Me } export namespace RequestAlreadyProcessedException { + /** + * @internal + */ export const filterSensitiveLog = (obj: RequestAlreadyProcessedException): any => ({ ...obj, }); @@ -2140,6 +2350,9 @@ export interface RevokeCertificateRequest { } export namespace RevokeCertificateRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: RevokeCertificateRequest): any => ({ ...obj, }); @@ -2162,6 +2375,9 @@ export interface TagCertificateAuthorityRequest { } export namespace TagCertificateAuthorityRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: TagCertificateAuthorityRequest): any => ({ ...obj, }); @@ -2178,6 +2394,9 @@ export interface TooManyTagsException extends __SmithyException, $MetadataBearer } export namespace TooManyTagsException { + /** + * @internal + */ export const filterSensitiveLog = (obj: TooManyTagsException): any => ({ ...obj, }); @@ -2200,6 +2419,9 @@ export interface UntagCertificateAuthorityRequest { } export namespace UntagCertificateAuthorityRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: UntagCertificateAuthorityRequest): any => ({ ...obj, }); @@ -2228,6 +2450,9 @@ export interface UpdateCertificateAuthorityRequest { } export namespace UpdateCertificateAuthorityRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateCertificateAuthorityRequest): any => ({ ...obj, }); diff --git a/clients/client-acm/commands/AddTagsToCertificateCommand.ts b/clients/client-acm/commands/AddTagsToCertificateCommand.ts index e274e94593cb..d2c33dd90970 100644 --- a/clients/client-acm/commands/AddTagsToCertificateCommand.ts +++ b/clients/client-acm/commands/AddTagsToCertificateCommand.ts @@ -37,6 +37,20 @@ export interface AddTagsToCertificateCommandOutput extends __MetadataBearer {} * *

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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ACMClient, AddTagsToCertificateCommand } from "@aws-sdk/client-acm"; // ES Modules import + * // const { ACMClient, AddTagsToCertificateCommand } = require("@aws-sdk/client-acm"); // CommonJS import + * const client = new ACMClient(config); + * const command = new AddTagsToCertificateCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link AddTagsToCertificateCommandInput} for command's `input` shape. + * @see {@link AddTagsToCertificateCommandOutput} for command's `response` shape. + * @see {@link ACMClientResolvedConfig | config} for command's `input` shape. + * */ export class AddTagsToCertificateCommand extends $Command< AddTagsToCertificateCommandInput, diff --git a/clients/client-acm/commands/DeleteCertificateCommand.ts b/clients/client-acm/commands/DeleteCertificateCommand.ts index 409e9cfdf92c..5a1071d12bb2 100644 --- a/clients/client-acm/commands/DeleteCertificateCommand.ts +++ b/clients/client-acm/commands/DeleteCertificateCommand.ts @@ -29,6 +29,20 @@ export interface DeleteCertificateCommandOutput extends __MetadataBearer {} * delete a certificate that is in use, the certificate association must first be * removed.

* + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ACMClient, DeleteCertificateCommand } from "@aws-sdk/client-acm"; // ES Modules import + * // const { ACMClient, DeleteCertificateCommand } = require("@aws-sdk/client-acm"); // CommonJS import + * const client = new ACMClient(config); + * const command = new DeleteCertificateCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteCertificateCommandInput} for command's `input` shape. + * @see {@link DeleteCertificateCommandOutput} for command's `response` shape. + * @see {@link ACMClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteCertificateCommand extends $Command< DeleteCertificateCommandInput, diff --git a/clients/client-acm/commands/DescribeCertificateCommand.ts b/clients/client-acm/commands/DescribeCertificateCommand.ts index b03f23dd6a35..2ea3809b2e0a 100644 --- a/clients/client-acm/commands/DescribeCertificateCommand.ts +++ b/clients/client-acm/commands/DescribeCertificateCommand.ts @@ -22,6 +22,20 @@ export interface DescribeCertificateCommandOutput extends DescribeCertificateRes /** *

Returns detailed metadata about the specified ACM certificate.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ACMClient, DescribeCertificateCommand } from "@aws-sdk/client-acm"; // ES Modules import + * // const { ACMClient, DescribeCertificateCommand } = require("@aws-sdk/client-acm"); // CommonJS import + * const client = new ACMClient(config); + * const command = new DescribeCertificateCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeCertificateCommandInput} for command's `input` shape. + * @see {@link DescribeCertificateCommandOutput} for command's `response` shape. + * @see {@link ACMClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeCertificateCommand extends $Command< DescribeCertificateCommandInput, diff --git a/clients/client-acm/commands/ExportCertificateCommand.ts b/clients/client-acm/commands/ExportCertificateCommand.ts index 707c0e97f9b0..64ea04a23b09 100644 --- a/clients/client-acm/commands/ExportCertificateCommand.ts +++ b/clients/client-acm/commands/ExportCertificateCommand.ts @@ -28,6 +28,20 @@ export interface ExportCertificateCommandOutput extends ExportCertificateRespons *

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

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ACMClient, ExportCertificateCommand } from "@aws-sdk/client-acm"; // ES Modules import + * // const { ACMClient, ExportCertificateCommand } = require("@aws-sdk/client-acm"); // CommonJS import + * const client = new ACMClient(config); + * const command = new ExportCertificateCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ExportCertificateCommandInput} for command's `input` shape. + * @see {@link ExportCertificateCommandOutput} for command's `response` shape. + * @see {@link ACMClientResolvedConfig | config} for command's `input` shape. + * */ export class ExportCertificateCommand extends $Command< ExportCertificateCommandInput, diff --git a/clients/client-acm/commands/GetAccountConfigurationCommand.ts b/clients/client-acm/commands/GetAccountConfigurationCommand.ts index 814d8d9730ab..e770789f5361 100644 --- a/clients/client-acm/commands/GetAccountConfigurationCommand.ts +++ b/clients/client-acm/commands/GetAccountConfigurationCommand.ts @@ -23,6 +23,20 @@ export interface GetAccountConfigurationCommandOutput extends GetAccountConfigur /** *

Returns the account * configuration options associated with an AWS account.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ACMClient, GetAccountConfigurationCommand } from "@aws-sdk/client-acm"; // ES Modules import + * // const { ACMClient, GetAccountConfigurationCommand } = require("@aws-sdk/client-acm"); // CommonJS import + * const client = new ACMClient(config); + * const command = new GetAccountConfigurationCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetAccountConfigurationCommandInput} for command's `input` shape. + * @see {@link GetAccountConfigurationCommandOutput} for command's `response` shape. + * @see {@link ACMClientResolvedConfig | config} for command's `input` shape. + * */ export class GetAccountConfigurationCommand extends $Command< GetAccountConfigurationCommandInput, diff --git a/clients/client-acm/commands/GetCertificateCommand.ts b/clients/client-acm/commands/GetCertificateCommand.ts index 7126bc1db53c..97d017f7b5dd 100644 --- a/clients/client-acm/commands/GetCertificateCommand.ts +++ b/clients/client-acm/commands/GetCertificateCommand.ts @@ -25,6 +25,20 @@ export interface GetCertificateCommandOutput extends GetCertificateResponse, __M * 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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ACMClient, GetCertificateCommand } from "@aws-sdk/client-acm"; // ES Modules import + * // const { ACMClient, GetCertificateCommand } = require("@aws-sdk/client-acm"); // CommonJS import + * const client = new ACMClient(config); + * const command = new GetCertificateCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetCertificateCommandInput} for command's `input` shape. + * @see {@link GetCertificateCommandOutput} for command's `response` shape. + * @see {@link ACMClientResolvedConfig | config} for command's `input` shape. + * */ export class GetCertificateCommand extends $Command< GetCertificateCommandInput, diff --git a/clients/client-acm/commands/ImportCertificateCommand.ts b/clients/client-acm/commands/ImportCertificateCommand.ts index 270217380914..e496b1ce6149 100644 --- a/clients/client-acm/commands/ImportCertificateCommand.ts +++ b/clients/client-acm/commands/ImportCertificateCommand.ts @@ -94,6 +94,20 @@ export interface ImportCertificateCommandOutput extends ImportCertificateRespons * *

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

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ACMClient, ImportCertificateCommand } from "@aws-sdk/client-acm"; // ES Modules import + * // const { ACMClient, ImportCertificateCommand } = require("@aws-sdk/client-acm"); // CommonJS import + * const client = new ACMClient(config); + * const command = new ImportCertificateCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ImportCertificateCommandInput} for command's `input` shape. + * @see {@link ImportCertificateCommandOutput} for command's `response` shape. + * @see {@link ACMClientResolvedConfig | config} for command's `input` shape. + * */ export class ImportCertificateCommand extends $Command< ImportCertificateCommandInput, diff --git a/clients/client-acm/commands/ListCertificatesCommand.ts b/clients/client-acm/commands/ListCertificatesCommand.ts index 4004154071bb..8862e04991e9 100644 --- a/clients/client-acm/commands/ListCertificatesCommand.ts +++ b/clients/client-acm/commands/ListCertificatesCommand.ts @@ -25,6 +25,20 @@ export interface ListCertificatesCommandOutput extends ListCertificatesResponse, * 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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ACMClient, ListCertificatesCommand } from "@aws-sdk/client-acm"; // ES Modules import + * // const { ACMClient, ListCertificatesCommand } = require("@aws-sdk/client-acm"); // CommonJS import + * const client = new ACMClient(config); + * const command = new ListCertificatesCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListCertificatesCommandInput} for command's `input` shape. + * @see {@link ListCertificatesCommandOutput} for command's `response` shape. + * @see {@link ACMClientResolvedConfig | config} for command's `input` shape. + * */ export class ListCertificatesCommand extends $Command< ListCertificatesCommandInput, diff --git a/clients/client-acm/commands/ListTagsForCertificateCommand.ts b/clients/client-acm/commands/ListTagsForCertificateCommand.ts index d73dfc41dea7..92f3d911dd61 100644 --- a/clients/client-acm/commands/ListTagsForCertificateCommand.ts +++ b/clients/client-acm/commands/ListTagsForCertificateCommand.ts @@ -24,6 +24,20 @@ export interface ListTagsForCertificateCommandOutput extends ListTagsForCertific *

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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ACMClient, ListTagsForCertificateCommand } from "@aws-sdk/client-acm"; // ES Modules import + * // const { ACMClient, ListTagsForCertificateCommand } = require("@aws-sdk/client-acm"); // CommonJS import + * const client = new ACMClient(config); + * const command = new ListTagsForCertificateCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListTagsForCertificateCommandInput} for command's `input` shape. + * @see {@link ListTagsForCertificateCommandOutput} for command's `response` shape. + * @see {@link ACMClientResolvedConfig | config} for command's `input` shape. + * */ export class ListTagsForCertificateCommand extends $Command< ListTagsForCertificateCommandInput, diff --git a/clients/client-acm/commands/PutAccountConfigurationCommand.ts b/clients/client-acm/commands/PutAccountConfigurationCommand.ts index f622447ed6a3..571d56a0fe31 100644 --- a/clients/client-acm/commands/PutAccountConfigurationCommand.ts +++ b/clients/client-acm/commands/PutAccountConfigurationCommand.ts @@ -30,6 +30,20 @@ export interface PutAccountConfigurationCommandOutput extends __MetadataBearer { * 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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ACMClient, PutAccountConfigurationCommand } from "@aws-sdk/client-acm"; // ES Modules import + * // const { ACMClient, PutAccountConfigurationCommand } = require("@aws-sdk/client-acm"); // CommonJS import + * const client = new ACMClient(config); + * const command = new PutAccountConfigurationCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link PutAccountConfigurationCommandInput} for command's `input` shape. + * @see {@link PutAccountConfigurationCommandOutput} for command's `response` shape. + * @see {@link ACMClientResolvedConfig | config} for command's `input` shape. + * */ export class PutAccountConfigurationCommand extends $Command< PutAccountConfigurationCommandInput, diff --git a/clients/client-acm/commands/RemoveTagsFromCertificateCommand.ts b/clients/client-acm/commands/RemoveTagsFromCertificateCommand.ts index dc2d3ce7de81..6f08fc169f39 100644 --- a/clients/client-acm/commands/RemoveTagsFromCertificateCommand.ts +++ b/clients/client-acm/commands/RemoveTagsFromCertificateCommand.ts @@ -28,6 +28,20 @@ export interface RemoveTagsFromCertificateCommandOutput extends __MetadataBearer * *

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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ACMClient, RemoveTagsFromCertificateCommand } from "@aws-sdk/client-acm"; // ES Modules import + * // const { ACMClient, RemoveTagsFromCertificateCommand } = require("@aws-sdk/client-acm"); // CommonJS import + * const client = new ACMClient(config); + * const command = new RemoveTagsFromCertificateCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link RemoveTagsFromCertificateCommandInput} for command's `input` shape. + * @see {@link RemoveTagsFromCertificateCommandOutput} for command's `response` shape. + * @see {@link ACMClientResolvedConfig | config} for command's `input` shape. + * */ export class RemoveTagsFromCertificateCommand extends $Command< RemoveTagsFromCertificateCommandInput, diff --git a/clients/client-acm/commands/RenewCertificateCommand.ts b/clients/client-acm/commands/RenewCertificateCommand.ts index 3bc75bc41695..65c65280d0ab 100644 --- a/clients/client-acm/commands/RenewCertificateCommand.ts +++ b/clients/client-acm/commands/RenewCertificateCommand.ts @@ -26,6 +26,20 @@ export interface RenewCertificateCommandOutput extends __MetadataBearer {} * first grant the ACM * service principal permission to do so. For more information, see Testing Managed Renewal * in the ACM User Guide.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ACMClient, RenewCertificateCommand } from "@aws-sdk/client-acm"; // ES Modules import + * // const { ACMClient, RenewCertificateCommand } = require("@aws-sdk/client-acm"); // CommonJS import + * const client = new ACMClient(config); + * const command = new RenewCertificateCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link RenewCertificateCommandInput} for command's `input` shape. + * @see {@link RenewCertificateCommandOutput} for command's `response` shape. + * @see {@link ACMClientResolvedConfig | config} for command's `input` shape. + * */ export class RenewCertificateCommand extends $Command< RenewCertificateCommandInput, diff --git a/clients/client-acm/commands/RequestCertificateCommand.ts b/clients/client-acm/commands/RequestCertificateCommand.ts index 82bdfed9e971..deffd966306e 100644 --- a/clients/client-acm/commands/RequestCertificateCommand.ts +++ b/clients/client-acm/commands/RequestCertificateCommand.ts @@ -31,6 +31,20 @@ export interface RequestCertificateCommandOutput extends RequestCertificateRespo * 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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ACMClient, RequestCertificateCommand } from "@aws-sdk/client-acm"; // ES Modules import + * // const { ACMClient, RequestCertificateCommand } = require("@aws-sdk/client-acm"); // CommonJS import + * const client = new ACMClient(config); + * const command = new RequestCertificateCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link RequestCertificateCommandInput} for command's `input` shape. + * @see {@link RequestCertificateCommandOutput} for command's `response` shape. + * @see {@link ACMClientResolvedConfig | config} for command's `input` shape. + * */ export class RequestCertificateCommand extends $Command< RequestCertificateCommandInput, diff --git a/clients/client-acm/commands/ResendValidationEmailCommand.ts b/clients/client-acm/commands/ResendValidationEmailCommand.ts index 941ec49a7d59..1e4dbf191c8e 100644 --- a/clients/client-acm/commands/ResendValidationEmailCommand.ts +++ b/clients/client-acm/commands/ResendValidationEmailCommand.ts @@ -30,6 +30,20 @@ export interface ResendValidationEmailCommandOutput extends __MetadataBearer {} * 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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ACMClient, ResendValidationEmailCommand } from "@aws-sdk/client-acm"; // ES Modules import + * // const { ACMClient, ResendValidationEmailCommand } = require("@aws-sdk/client-acm"); // CommonJS import + * const client = new ACMClient(config); + * const command = new ResendValidationEmailCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ResendValidationEmailCommandInput} for command's `input` shape. + * @see {@link ResendValidationEmailCommandOutput} for command's `response` shape. + * @see {@link ACMClientResolvedConfig | config} for command's `input` shape. + * */ export class ResendValidationEmailCommand extends $Command< ResendValidationEmailCommandInput, diff --git a/clients/client-acm/commands/UpdateCertificateOptionsCommand.ts b/clients/client-acm/commands/UpdateCertificateOptionsCommand.ts index 4550cd84fd3a..76c383d9aa4e 100644 --- a/clients/client-acm/commands/UpdateCertificateOptionsCommand.ts +++ b/clients/client-acm/commands/UpdateCertificateOptionsCommand.ts @@ -25,6 +25,20 @@ export interface UpdateCertificateOptionsCommandOutput extends __MetadataBearer * to or out of recording your certificate in a certificate transparency log. For more * information, see Opting Out of * Certificate Transparency Logging.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ACMClient, UpdateCertificateOptionsCommand } from "@aws-sdk/client-acm"; // ES Modules import + * // const { ACMClient, UpdateCertificateOptionsCommand } = require("@aws-sdk/client-acm"); // CommonJS import + * const client = new ACMClient(config); + * const command = new UpdateCertificateOptionsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link UpdateCertificateOptionsCommandInput} for command's `input` shape. + * @see {@link UpdateCertificateOptionsCommandOutput} for command's `response` shape. + * @see {@link ACMClientResolvedConfig | config} for command's `input` shape. + * */ export class UpdateCertificateOptionsCommand extends $Command< UpdateCertificateOptionsCommandInput, diff --git a/clients/client-acm/models/models_0.ts b/clients/client-acm/models/models_0.ts index 9e946e02c01b..89a136c8b5f6 100644 --- a/clients/client-acm/models/models_0.ts +++ b/clients/client-acm/models/models_0.ts @@ -12,6 +12,9 @@ export interface AccessDeniedException extends __SmithyException, $MetadataBeare } export namespace AccessDeniedException { + /** + * @internal + */ export const filterSensitiveLog = (obj: AccessDeniedException): any => ({ ...obj, }); @@ -33,6 +36,9 @@ export interface Tag { } export namespace Tag { + /** + * @internal + */ export const filterSensitiveLog = (obj: Tag): any => ({ ...obj, }); @@ -58,6 +64,9 @@ export interface AddTagsToCertificateRequest { } export namespace AddTagsToCertificateRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: AddTagsToCertificateRequest): any => ({ ...obj, }); @@ -73,6 +82,9 @@ export interface InvalidArnException extends __SmithyException, $MetadataBearer } export namespace InvalidArnException { + /** + * @internal + */ export const filterSensitiveLog = (obj: InvalidArnException): any => ({ ...obj, }); @@ -88,6 +100,9 @@ export interface InvalidParameterException extends __SmithyException, $MetadataB } export namespace InvalidParameterException { + /** + * @internal + */ export const filterSensitiveLog = (obj: InvalidParameterException): any => ({ ...obj, }); @@ -104,6 +119,9 @@ export interface InvalidTagException extends __SmithyException, $MetadataBearer } export namespace InvalidTagException { + /** + * @internal + */ export const filterSensitiveLog = (obj: InvalidTagException): any => ({ ...obj, }); @@ -120,6 +138,9 @@ export interface ResourceNotFoundException extends __SmithyException, $MetadataB } export namespace ResourceNotFoundException { + /** + * @internal + */ export const filterSensitiveLog = (obj: ResourceNotFoundException): any => ({ ...obj, }); @@ -135,6 +156,9 @@ export interface TagPolicyException extends __SmithyException, $MetadataBearer { } export namespace TagPolicyException { + /** + * @internal + */ export const filterSensitiveLog = (obj: TagPolicyException): any => ({ ...obj, }); @@ -151,6 +175,9 @@ export interface ThrottlingException extends __SmithyException, $MetadataBearer } export namespace ThrottlingException { + /** + * @internal + */ export const filterSensitiveLog = (obj: ThrottlingException): any => ({ ...obj, }); @@ -166,6 +193,9 @@ export interface TooManyTagsException extends __SmithyException, $MetadataBearer } export namespace TooManyTagsException { + /** + * @internal + */ export const filterSensitiveLog = (obj: TooManyTagsException): any => ({ ...obj, }); @@ -198,6 +228,9 @@ export interface ResourceRecord { } export namespace ResourceRecord { + /** + * @internal + */ export const filterSensitiveLog = (obj: ResourceRecord): any => ({ ...obj, }); @@ -272,6 +305,9 @@ export interface DomainValidation { } export namespace DomainValidation { + /** + * @internal + */ export const filterSensitiveLog = (obj: DomainValidation): any => ({ ...obj, }); @@ -359,6 +395,9 @@ export interface ExtendedKeyUsage { } export namespace ExtendedKeyUsage { + /** + * @internal + */ export const filterSensitiveLog = (obj: ExtendedKeyUsage): any => ({ ...obj, }); @@ -419,6 +458,9 @@ export interface KeyUsage { } export namespace KeyUsage { + /** + * @internal + */ export const filterSensitiveLog = (obj: KeyUsage): any => ({ ...obj, }); @@ -447,6 +489,9 @@ export interface CertificateOptions { } export namespace CertificateOptions { + /** + * @internal + */ export const filterSensitiveLog = (obj: CertificateOptions): any => ({ ...obj, }); @@ -495,6 +540,9 @@ export interface RenewalSummary { } export namespace RenewalSummary { + /** + * @internal + */ export const filterSensitiveLog = (obj: RenewalSummary): any => ({ ...obj, }); @@ -701,6 +749,9 @@ export interface CertificateDetail { } export namespace CertificateDetail { + /** + * @internal + */ export const filterSensitiveLog = (obj: CertificateDetail): any => ({ ...obj, }); @@ -719,6 +770,9 @@ export interface DeleteCertificateRequest { } export namespace DeleteCertificateRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteCertificateRequest): any => ({ ...obj, }); @@ -735,6 +789,9 @@ export interface ResourceInUseException extends __SmithyException, $MetadataBear } export namespace ResourceInUseException { + /** + * @internal + */ export const filterSensitiveLog = (obj: ResourceInUseException): any => ({ ...obj, }); @@ -753,6 +810,9 @@ export interface DescribeCertificateRequest { } export namespace DescribeCertificateRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeCertificateRequest): any => ({ ...obj, }); @@ -766,6 +826,9 @@ export interface DescribeCertificateResponse { } export namespace DescribeCertificateResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeCertificateResponse): any => ({ ...obj, }); @@ -792,6 +855,9 @@ export interface ExportCertificateRequest { } export namespace ExportCertificateRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ExportCertificateRequest): any => ({ ...obj, ...(obj.Passphrase && { Passphrase: SENSITIVE_STRING }), @@ -818,6 +884,9 @@ export interface ExportCertificateResponse { } export namespace ExportCertificateResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ExportCertificateResponse): any => ({ ...obj, ...(obj.PrivateKey && { PrivateKey: SENSITIVE_STRING }), @@ -835,6 +904,9 @@ export interface RequestInProgressException extends __SmithyException, $Metadata } export namespace RequestInProgressException { + /** + * @internal + */ export const filterSensitiveLog = (obj: RequestInProgressException): any => ({ ...obj, }); @@ -855,6 +927,9 @@ export interface ExpiryEventsConfiguration { } export namespace ExpiryEventsConfiguration { + /** + * @internal + */ export const filterSensitiveLog = (obj: ExpiryEventsConfiguration): any => ({ ...obj, }); @@ -869,6 +944,9 @@ export interface GetAccountConfigurationResponse { } export namespace GetAccountConfigurationResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetAccountConfigurationResponse): any => ({ ...obj, }); @@ -886,6 +964,9 @@ export interface GetCertificateRequest { } export namespace GetCertificateRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetCertificateRequest): any => ({ ...obj, }); @@ -906,6 +987,9 @@ export interface GetCertificateResponse { } export namespace GetCertificateResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetCertificateResponse): any => ({ ...obj, }); @@ -942,6 +1026,9 @@ export interface ImportCertificateRequest { } export namespace ImportCertificateRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ImportCertificateRequest): any => ({ ...obj, ...(obj.PrivateKey && { PrivateKey: SENSITIVE_STRING }), @@ -957,6 +1044,9 @@ export interface ImportCertificateResponse { } export namespace ImportCertificateResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ImportCertificateResponse): any => ({ ...obj, }); @@ -972,6 +1062,9 @@ export interface LimitExceededException extends __SmithyException, $MetadataBear } export namespace LimitExceededException { + /** + * @internal + */ export const filterSensitiveLog = (obj: LimitExceededException): any => ({ ...obj, }); @@ -987,6 +1080,9 @@ export interface InvalidArgsException extends __SmithyException, $MetadataBearer } export namespace InvalidArgsException { + /** + * @internal + */ export const filterSensitiveLog = (obj: InvalidArgsException): any => ({ ...obj, }); @@ -1019,6 +1115,9 @@ export interface Filters { } export namespace Filters { + /** + * @internal + */ export const filterSensitiveLog = (obj: Filters): any => ({ ...obj, }); @@ -1053,6 +1152,9 @@ export interface ListCertificatesRequest { } export namespace ListCertificatesRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListCertificatesRequest): any => ({ ...obj, }); @@ -1082,6 +1184,9 @@ export interface CertificateSummary { } export namespace CertificateSummary { + /** + * @internal + */ export const filterSensitiveLog = (obj: CertificateSummary): any => ({ ...obj, }); @@ -1101,6 +1206,9 @@ export interface ListCertificatesResponse { } export namespace ListCertificatesResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListCertificatesResponse): any => ({ ...obj, }); @@ -1119,6 +1227,9 @@ export interface ListTagsForCertificateRequest { } export namespace ListTagsForCertificateRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListTagsForCertificateRequest): any => ({ ...obj, }); @@ -1132,6 +1243,9 @@ export interface ListTagsForCertificateResponse { } export namespace ListTagsForCertificateResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListTagsForCertificateResponse): any => ({ ...obj, }); @@ -1149,6 +1263,9 @@ export interface ConflictException extends __SmithyException, $MetadataBearer { } export namespace ConflictException { + /** + * @internal + */ export const filterSensitiveLog = (obj: ConflictException): any => ({ ...obj, }); @@ -1173,6 +1290,9 @@ export interface PutAccountConfigurationRequest { } export namespace PutAccountConfigurationRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: PutAccountConfigurationRequest): any => ({ ...obj, }); @@ -1189,6 +1309,9 @@ export interface ValidationException extends __SmithyException, $MetadataBearer } export namespace ValidationException { + /** + * @internal + */ export const filterSensitiveLog = (obj: ValidationException): any => ({ ...obj, }); @@ -1214,6 +1337,9 @@ export interface RemoveTagsFromCertificateRequest { } export namespace RemoveTagsFromCertificateRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: RemoveTagsFromCertificateRequest): any => ({ ...obj, }); @@ -1232,6 +1358,9 @@ export interface RenewCertificateRequest { } export namespace RenewCertificateRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: RenewCertificateRequest): any => ({ ...obj, }); @@ -1248,6 +1377,9 @@ export interface InvalidDomainValidationOptionsException extends __SmithyExcepti } export namespace InvalidDomainValidationOptionsException { + /** + * @internal + */ export const filterSensitiveLog = (obj: InvalidDomainValidationOptionsException): any => ({ ...obj, }); @@ -1292,6 +1424,9 @@ export interface DomainValidationOption { } export namespace DomainValidationOption { + /** + * @internal + */ export const filterSensitiveLog = (obj: DomainValidationOption): any => ({ ...obj, }); @@ -1392,6 +1527,9 @@ export interface RequestCertificateRequest { } export namespace RequestCertificateRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: RequestCertificateRequest): any => ({ ...obj, }); @@ -1408,6 +1546,9 @@ export interface RequestCertificateResponse { } export namespace RequestCertificateResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: RequestCertificateResponse): any => ({ ...obj, }); @@ -1423,6 +1564,9 @@ export interface InvalidStateException extends __SmithyException, $MetadataBeare } export namespace InvalidStateException { + /** + * @internal + */ export const filterSensitiveLog = (obj: InvalidStateException): any => ({ ...obj, }); @@ -1476,6 +1620,9 @@ export interface ResendValidationEmailRequest { } export namespace ResendValidationEmailRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ResendValidationEmailRequest): any => ({ ...obj, }); @@ -1501,6 +1648,9 @@ export interface UpdateCertificateOptionsRequest { } export namespace UpdateCertificateOptionsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateCertificateOptionsRequest): any => ({ ...obj, }); diff --git a/clients/client-alexa-for-business/commands/ApproveSkillCommand.ts b/clients/client-alexa-for-business/commands/ApproveSkillCommand.ts index 4c9e60dea735..13463798fb2b 100644 --- a/clients/client-alexa-for-business/commands/ApproveSkillCommand.ts +++ b/clients/client-alexa-for-business/commands/ApproveSkillCommand.ts @@ -23,6 +23,20 @@ export interface ApproveSkillCommandOutput extends ApproveSkillResponse, __Metad /** *

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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { AlexaForBusinessClient, ApproveSkillCommand } from "@aws-sdk/client-alexa-for-business"; // ES Modules import + * // const { AlexaForBusinessClient, ApproveSkillCommand } = require("@aws-sdk/client-alexa-for-business"); // CommonJS import + * const client = new AlexaForBusinessClient(config); + * const command = new ApproveSkillCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ApproveSkillCommandInput} for command's `input` shape. + * @see {@link ApproveSkillCommandOutput} for command's `response` shape. + * @see {@link AlexaForBusinessClientResolvedConfig | config} for command's `input` shape. + * */ export class ApproveSkillCommand extends $Command< ApproveSkillCommandInput, diff --git a/clients/client-alexa-for-business/commands/AssociateContactWithAddressBookCommand.ts b/clients/client-alexa-for-business/commands/AssociateContactWithAddressBookCommand.ts index 219b1adb63ac..10b3baa8c8f5 100644 --- a/clients/client-alexa-for-business/commands/AssociateContactWithAddressBookCommand.ts +++ b/clients/client-alexa-for-business/commands/AssociateContactWithAddressBookCommand.ts @@ -24,6 +24,20 @@ export interface AssociateContactWithAddressBookCommandOutput /** *

Associates a contact with a given address book.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { AlexaForBusinessClient, AssociateContactWithAddressBookCommand } from "@aws-sdk/client-alexa-for-business"; // ES Modules import + * // const { AlexaForBusinessClient, AssociateContactWithAddressBookCommand } = require("@aws-sdk/client-alexa-for-business"); // CommonJS import + * const client = new AlexaForBusinessClient(config); + * const command = new AssociateContactWithAddressBookCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link AssociateContactWithAddressBookCommandInput} for command's `input` shape. + * @see {@link AssociateContactWithAddressBookCommandOutput} for command's `response` shape. + * @see {@link AlexaForBusinessClientResolvedConfig | config} for command's `input` shape. + * */ export class AssociateContactWithAddressBookCommand extends $Command< AssociateContactWithAddressBookCommandInput, diff --git a/clients/client-alexa-for-business/commands/AssociateDeviceWithNetworkProfileCommand.ts b/clients/client-alexa-for-business/commands/AssociateDeviceWithNetworkProfileCommand.ts index 1dc7f87a2ed7..b3649514fd61 100644 --- a/clients/client-alexa-for-business/commands/AssociateDeviceWithNetworkProfileCommand.ts +++ b/clients/client-alexa-for-business/commands/AssociateDeviceWithNetworkProfileCommand.ts @@ -27,6 +27,20 @@ export interface AssociateDeviceWithNetworkProfileCommandOutput /** *

Associates a device with the specified network profile.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { AlexaForBusinessClient, AssociateDeviceWithNetworkProfileCommand } from "@aws-sdk/client-alexa-for-business"; // ES Modules import + * // const { AlexaForBusinessClient, AssociateDeviceWithNetworkProfileCommand } = require("@aws-sdk/client-alexa-for-business"); // CommonJS import + * const client = new AlexaForBusinessClient(config); + * const command = new AssociateDeviceWithNetworkProfileCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link AssociateDeviceWithNetworkProfileCommandInput} for command's `input` shape. + * @see {@link AssociateDeviceWithNetworkProfileCommandOutput} for command's `response` shape. + * @see {@link AlexaForBusinessClientResolvedConfig | config} for command's `input` shape. + * */ export class AssociateDeviceWithNetworkProfileCommand extends $Command< AssociateDeviceWithNetworkProfileCommandInput, diff --git a/clients/client-alexa-for-business/commands/AssociateDeviceWithRoomCommand.ts b/clients/client-alexa-for-business/commands/AssociateDeviceWithRoomCommand.ts index 5dda98ce7fed..3a36f1efb65a 100644 --- a/clients/client-alexa-for-business/commands/AssociateDeviceWithRoomCommand.ts +++ b/clients/client-alexa-for-business/commands/AssociateDeviceWithRoomCommand.ts @@ -24,6 +24,20 @@ export interface AssociateDeviceWithRoomCommandOutput extends AssociateDeviceWit *

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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { AlexaForBusinessClient, AssociateDeviceWithRoomCommand } from "@aws-sdk/client-alexa-for-business"; // ES Modules import + * // const { AlexaForBusinessClient, AssociateDeviceWithRoomCommand } = require("@aws-sdk/client-alexa-for-business"); // CommonJS import + * const client = new AlexaForBusinessClient(config); + * const command = new AssociateDeviceWithRoomCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link AssociateDeviceWithRoomCommandInput} for command's `input` shape. + * @see {@link AssociateDeviceWithRoomCommandOutput} for command's `response` shape. + * @see {@link AlexaForBusinessClientResolvedConfig | config} for command's `input` shape. + * */ export class AssociateDeviceWithRoomCommand extends $Command< AssociateDeviceWithRoomCommandInput, diff --git a/clients/client-alexa-for-business/commands/AssociateSkillGroupWithRoomCommand.ts b/clients/client-alexa-for-business/commands/AssociateSkillGroupWithRoomCommand.ts index 33f786029577..b43d068946a5 100644 --- a/clients/client-alexa-for-business/commands/AssociateSkillGroupWithRoomCommand.ts +++ b/clients/client-alexa-for-business/commands/AssociateSkillGroupWithRoomCommand.ts @@ -25,6 +25,20 @@ export interface AssociateSkillGroupWithRoomCommandOutput /** *

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

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { AlexaForBusinessClient, AssociateSkillGroupWithRoomCommand } from "@aws-sdk/client-alexa-for-business"; // ES Modules import + * // const { AlexaForBusinessClient, AssociateSkillGroupWithRoomCommand } = require("@aws-sdk/client-alexa-for-business"); // CommonJS import + * const client = new AlexaForBusinessClient(config); + * const command = new AssociateSkillGroupWithRoomCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link AssociateSkillGroupWithRoomCommandInput} for command's `input` shape. + * @see {@link AssociateSkillGroupWithRoomCommandOutput} for command's `response` shape. + * @see {@link AlexaForBusinessClientResolvedConfig | config} for command's `input` shape. + * */ export class AssociateSkillGroupWithRoomCommand extends $Command< AssociateSkillGroupWithRoomCommandInput, diff --git a/clients/client-alexa-for-business/commands/AssociateSkillWithSkillGroupCommand.ts b/clients/client-alexa-for-business/commands/AssociateSkillWithSkillGroupCommand.ts index e381e62f6d08..f89d9b89db26 100644 --- a/clients/client-alexa-for-business/commands/AssociateSkillWithSkillGroupCommand.ts +++ b/clients/client-alexa-for-business/commands/AssociateSkillWithSkillGroupCommand.ts @@ -24,6 +24,20 @@ export interface AssociateSkillWithSkillGroupCommandOutput /** *

Associates a skill with a skill group.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { AlexaForBusinessClient, AssociateSkillWithSkillGroupCommand } from "@aws-sdk/client-alexa-for-business"; // ES Modules import + * // const { AlexaForBusinessClient, AssociateSkillWithSkillGroupCommand } = require("@aws-sdk/client-alexa-for-business"); // CommonJS import + * const client = new AlexaForBusinessClient(config); + * const command = new AssociateSkillWithSkillGroupCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link AssociateSkillWithSkillGroupCommandInput} for command's `input` shape. + * @see {@link AssociateSkillWithSkillGroupCommandOutput} for command's `response` shape. + * @see {@link AlexaForBusinessClientResolvedConfig | config} for command's `input` shape. + * */ export class AssociateSkillWithSkillGroupCommand extends $Command< AssociateSkillWithSkillGroupCommandInput, diff --git a/clients/client-alexa-for-business/commands/AssociateSkillWithUsersCommand.ts b/clients/client-alexa-for-business/commands/AssociateSkillWithUsersCommand.ts index 18c156876ec7..dfb3cec645a7 100644 --- a/clients/client-alexa-for-business/commands/AssociateSkillWithUsersCommand.ts +++ b/clients/client-alexa-for-business/commands/AssociateSkillWithUsersCommand.ts @@ -22,6 +22,20 @@ export interface AssociateSkillWithUsersCommandOutput extends AssociateSkillWith /** *

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

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { AlexaForBusinessClient, AssociateSkillWithUsersCommand } from "@aws-sdk/client-alexa-for-business"; // ES Modules import + * // const { AlexaForBusinessClient, AssociateSkillWithUsersCommand } = require("@aws-sdk/client-alexa-for-business"); // CommonJS import + * const client = new AlexaForBusinessClient(config); + * const command = new AssociateSkillWithUsersCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link AssociateSkillWithUsersCommandInput} for command's `input` shape. + * @see {@link AssociateSkillWithUsersCommandOutput} for command's `response` shape. + * @see {@link AlexaForBusinessClientResolvedConfig | config} for command's `input` shape. + * */ export class AssociateSkillWithUsersCommand extends $Command< AssociateSkillWithUsersCommandInput, diff --git a/clients/client-alexa-for-business/commands/CreateAddressBookCommand.ts b/clients/client-alexa-for-business/commands/CreateAddressBookCommand.ts index 3ae2a0b1ad55..83e218519fda 100644 --- a/clients/client-alexa-for-business/commands/CreateAddressBookCommand.ts +++ b/clients/client-alexa-for-business/commands/CreateAddressBookCommand.ts @@ -22,6 +22,20 @@ export interface CreateAddressBookCommandOutput extends CreateAddressBookRespons /** *

Creates an address book with the specified details.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { AlexaForBusinessClient, CreateAddressBookCommand } from "@aws-sdk/client-alexa-for-business"; // ES Modules import + * // const { AlexaForBusinessClient, CreateAddressBookCommand } = require("@aws-sdk/client-alexa-for-business"); // CommonJS import + * const client = new AlexaForBusinessClient(config); + * const command = new CreateAddressBookCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreateAddressBookCommandInput} for command's `input` shape. + * @see {@link CreateAddressBookCommandOutput} for command's `response` shape. + * @see {@link AlexaForBusinessClientResolvedConfig | config} for command's `input` shape. + * */ export class CreateAddressBookCommand extends $Command< CreateAddressBookCommandInput, diff --git a/clients/client-alexa-for-business/commands/CreateBusinessReportScheduleCommand.ts b/clients/client-alexa-for-business/commands/CreateBusinessReportScheduleCommand.ts index 4be10288d4d5..27a271ea4ee6 100644 --- a/clients/client-alexa-for-business/commands/CreateBusinessReportScheduleCommand.ts +++ b/clients/client-alexa-for-business/commands/CreateBusinessReportScheduleCommand.ts @@ -25,6 +25,20 @@ export interface CreateBusinessReportScheduleCommandOutput /** *

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

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { AlexaForBusinessClient, CreateBusinessReportScheduleCommand } from "@aws-sdk/client-alexa-for-business"; // ES Modules import + * // const { AlexaForBusinessClient, CreateBusinessReportScheduleCommand } = require("@aws-sdk/client-alexa-for-business"); // CommonJS import + * const client = new AlexaForBusinessClient(config); + * const command = new CreateBusinessReportScheduleCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreateBusinessReportScheduleCommandInput} for command's `input` shape. + * @see {@link CreateBusinessReportScheduleCommandOutput} for command's `response` shape. + * @see {@link AlexaForBusinessClientResolvedConfig | config} for command's `input` shape. + * */ export class CreateBusinessReportScheduleCommand extends $Command< CreateBusinessReportScheduleCommandInput, diff --git a/clients/client-alexa-for-business/commands/CreateConferenceProviderCommand.ts b/clients/client-alexa-for-business/commands/CreateConferenceProviderCommand.ts index 9f773bc25948..fe6d36cf4505 100644 --- a/clients/client-alexa-for-business/commands/CreateConferenceProviderCommand.ts +++ b/clients/client-alexa-for-business/commands/CreateConferenceProviderCommand.ts @@ -22,6 +22,20 @@ export interface CreateConferenceProviderCommandOutput extends CreateConferenceP /** *

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

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { AlexaForBusinessClient, CreateConferenceProviderCommand } from "@aws-sdk/client-alexa-for-business"; // ES Modules import + * // const { AlexaForBusinessClient, CreateConferenceProviderCommand } = require("@aws-sdk/client-alexa-for-business"); // CommonJS import + * const client = new AlexaForBusinessClient(config); + * const command = new CreateConferenceProviderCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreateConferenceProviderCommandInput} for command's `input` shape. + * @see {@link CreateConferenceProviderCommandOutput} for command's `response` shape. + * @see {@link AlexaForBusinessClientResolvedConfig | config} for command's `input` shape. + * */ export class CreateConferenceProviderCommand extends $Command< CreateConferenceProviderCommandInput, diff --git a/clients/client-alexa-for-business/commands/CreateContactCommand.ts b/clients/client-alexa-for-business/commands/CreateContactCommand.ts index c7350243382b..a4b1d3063646 100644 --- a/clients/client-alexa-for-business/commands/CreateContactCommand.ts +++ b/clients/client-alexa-for-business/commands/CreateContactCommand.ts @@ -22,6 +22,20 @@ export interface CreateContactCommandOutput extends CreateContactResponse, __Met /** *

Creates a contact with the specified details.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { AlexaForBusinessClient, CreateContactCommand } from "@aws-sdk/client-alexa-for-business"; // ES Modules import + * // const { AlexaForBusinessClient, CreateContactCommand } = require("@aws-sdk/client-alexa-for-business"); // CommonJS import + * const client = new AlexaForBusinessClient(config); + * const command = new CreateContactCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreateContactCommandInput} for command's `input` shape. + * @see {@link CreateContactCommandOutput} for command's `response` shape. + * @see {@link AlexaForBusinessClientResolvedConfig | config} for command's `input` shape. + * */ export class CreateContactCommand extends $Command< CreateContactCommandInput, diff --git a/clients/client-alexa-for-business/commands/CreateGatewayGroupCommand.ts b/clients/client-alexa-for-business/commands/CreateGatewayGroupCommand.ts index 7282a361454a..ec34e4f778c5 100644 --- a/clients/client-alexa-for-business/commands/CreateGatewayGroupCommand.ts +++ b/clients/client-alexa-for-business/commands/CreateGatewayGroupCommand.ts @@ -22,6 +22,20 @@ export interface CreateGatewayGroupCommandOutput extends CreateGatewayGroupRespo /** *

Creates a gateway group with the specified details.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { AlexaForBusinessClient, CreateGatewayGroupCommand } from "@aws-sdk/client-alexa-for-business"; // ES Modules import + * // const { AlexaForBusinessClient, CreateGatewayGroupCommand } = require("@aws-sdk/client-alexa-for-business"); // CommonJS import + * const client = new AlexaForBusinessClient(config); + * const command = new CreateGatewayGroupCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreateGatewayGroupCommandInput} for command's `input` shape. + * @see {@link CreateGatewayGroupCommandOutput} for command's `response` shape. + * @see {@link AlexaForBusinessClientResolvedConfig | config} for command's `input` shape. + * */ export class CreateGatewayGroupCommand extends $Command< CreateGatewayGroupCommandInput, diff --git a/clients/client-alexa-for-business/commands/CreateNetworkProfileCommand.ts b/clients/client-alexa-for-business/commands/CreateNetworkProfileCommand.ts index fedb2f19c63e..18ffea530712 100644 --- a/clients/client-alexa-for-business/commands/CreateNetworkProfileCommand.ts +++ b/clients/client-alexa-for-business/commands/CreateNetworkProfileCommand.ts @@ -22,6 +22,20 @@ export interface CreateNetworkProfileCommandOutput extends CreateNetworkProfileR /** *

Creates a network profile with the specified details.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { AlexaForBusinessClient, CreateNetworkProfileCommand } from "@aws-sdk/client-alexa-for-business"; // ES Modules import + * // const { AlexaForBusinessClient, CreateNetworkProfileCommand } = require("@aws-sdk/client-alexa-for-business"); // CommonJS import + * const client = new AlexaForBusinessClient(config); + * const command = new CreateNetworkProfileCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreateNetworkProfileCommandInput} for command's `input` shape. + * @see {@link CreateNetworkProfileCommandOutput} for command's `response` shape. + * @see {@link AlexaForBusinessClientResolvedConfig | config} for command's `input` shape. + * */ export class CreateNetworkProfileCommand extends $Command< CreateNetworkProfileCommandInput, diff --git a/clients/client-alexa-for-business/commands/CreateProfileCommand.ts b/clients/client-alexa-for-business/commands/CreateProfileCommand.ts index ba75d9fecdef..df9e95eb1cfe 100644 --- a/clients/client-alexa-for-business/commands/CreateProfileCommand.ts +++ b/clients/client-alexa-for-business/commands/CreateProfileCommand.ts @@ -22,6 +22,20 @@ export interface CreateProfileCommandOutput extends CreateProfileResponse, __Met /** *

Creates a new room profile with the specified details.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { AlexaForBusinessClient, CreateProfileCommand } from "@aws-sdk/client-alexa-for-business"; // ES Modules import + * // const { AlexaForBusinessClient, CreateProfileCommand } = require("@aws-sdk/client-alexa-for-business"); // CommonJS import + * const client = new AlexaForBusinessClient(config); + * const command = new CreateProfileCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreateProfileCommandInput} for command's `input` shape. + * @see {@link CreateProfileCommandOutput} for command's `response` shape. + * @see {@link AlexaForBusinessClientResolvedConfig | config} for command's `input` shape. + * */ export class CreateProfileCommand extends $Command< CreateProfileCommandInput, diff --git a/clients/client-alexa-for-business/commands/CreateRoomCommand.ts b/clients/client-alexa-for-business/commands/CreateRoomCommand.ts index 6eb5c4eb5454..1443412a5b78 100644 --- a/clients/client-alexa-for-business/commands/CreateRoomCommand.ts +++ b/clients/client-alexa-for-business/commands/CreateRoomCommand.ts @@ -22,6 +22,20 @@ export interface CreateRoomCommandOutput extends CreateRoomResponse, __MetadataB /** *

Creates a room with the specified details.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { AlexaForBusinessClient, CreateRoomCommand } from "@aws-sdk/client-alexa-for-business"; // ES Modules import + * // const { AlexaForBusinessClient, CreateRoomCommand } = require("@aws-sdk/client-alexa-for-business"); // CommonJS import + * const client = new AlexaForBusinessClient(config); + * const command = new CreateRoomCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreateRoomCommandInput} for command's `input` shape. + * @see {@link CreateRoomCommandOutput} for command's `response` shape. + * @see {@link AlexaForBusinessClientResolvedConfig | config} for command's `input` shape. + * */ export class CreateRoomCommand extends $Command< CreateRoomCommandInput, diff --git a/clients/client-alexa-for-business/commands/CreateSkillGroupCommand.ts b/clients/client-alexa-for-business/commands/CreateSkillGroupCommand.ts index 0ec280c0eb10..39f369437866 100644 --- a/clients/client-alexa-for-business/commands/CreateSkillGroupCommand.ts +++ b/clients/client-alexa-for-business/commands/CreateSkillGroupCommand.ts @@ -22,6 +22,20 @@ export interface CreateSkillGroupCommandOutput extends CreateSkillGroupResponse, /** *

Creates a skill group with a specified name and description.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { AlexaForBusinessClient, CreateSkillGroupCommand } from "@aws-sdk/client-alexa-for-business"; // ES Modules import + * // const { AlexaForBusinessClient, CreateSkillGroupCommand } = require("@aws-sdk/client-alexa-for-business"); // CommonJS import + * const client = new AlexaForBusinessClient(config); + * const command = new CreateSkillGroupCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreateSkillGroupCommandInput} for command's `input` shape. + * @see {@link CreateSkillGroupCommandOutput} for command's `response` shape. + * @see {@link AlexaForBusinessClientResolvedConfig | config} for command's `input` shape. + * */ export class CreateSkillGroupCommand extends $Command< CreateSkillGroupCommandInput, diff --git a/clients/client-alexa-for-business/commands/CreateUserCommand.ts b/clients/client-alexa-for-business/commands/CreateUserCommand.ts index f11079f00d1a..ca6d9b80fd58 100644 --- a/clients/client-alexa-for-business/commands/CreateUserCommand.ts +++ b/clients/client-alexa-for-business/commands/CreateUserCommand.ts @@ -22,6 +22,20 @@ export interface CreateUserCommandOutput extends CreateUserResponse, __MetadataB /** *

Creates a user.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { AlexaForBusinessClient, CreateUserCommand } from "@aws-sdk/client-alexa-for-business"; // ES Modules import + * // const { AlexaForBusinessClient, CreateUserCommand } = require("@aws-sdk/client-alexa-for-business"); // CommonJS import + * const client = new AlexaForBusinessClient(config); + * const command = new CreateUserCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreateUserCommandInput} for command's `input` shape. + * @see {@link CreateUserCommandOutput} for command's `response` shape. + * @see {@link AlexaForBusinessClientResolvedConfig | config} for command's `input` shape. + * */ export class CreateUserCommand extends $Command< CreateUserCommandInput, diff --git a/clients/client-alexa-for-business/commands/DeleteAddressBookCommand.ts b/clients/client-alexa-for-business/commands/DeleteAddressBookCommand.ts index 02d5a377f579..ce0b1fa628e4 100644 --- a/clients/client-alexa-for-business/commands/DeleteAddressBookCommand.ts +++ b/clients/client-alexa-for-business/commands/DeleteAddressBookCommand.ts @@ -22,6 +22,20 @@ export interface DeleteAddressBookCommandOutput extends DeleteAddressBookRespons /** *

Deletes an address book by the address book ARN.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { AlexaForBusinessClient, DeleteAddressBookCommand } from "@aws-sdk/client-alexa-for-business"; // ES Modules import + * // const { AlexaForBusinessClient, DeleteAddressBookCommand } = require("@aws-sdk/client-alexa-for-business"); // CommonJS import + * const client = new AlexaForBusinessClient(config); + * const command = new DeleteAddressBookCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteAddressBookCommandInput} for command's `input` shape. + * @see {@link DeleteAddressBookCommandOutput} for command's `response` shape. + * @see {@link AlexaForBusinessClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteAddressBookCommand extends $Command< DeleteAddressBookCommandInput, diff --git a/clients/client-alexa-for-business/commands/DeleteBusinessReportScheduleCommand.ts b/clients/client-alexa-for-business/commands/DeleteBusinessReportScheduleCommand.ts index bb2d3d79d4ce..70d2b211051b 100644 --- a/clients/client-alexa-for-business/commands/DeleteBusinessReportScheduleCommand.ts +++ b/clients/client-alexa-for-business/commands/DeleteBusinessReportScheduleCommand.ts @@ -25,6 +25,20 @@ export interface DeleteBusinessReportScheduleCommandOutput /** *

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

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { AlexaForBusinessClient, DeleteBusinessReportScheduleCommand } from "@aws-sdk/client-alexa-for-business"; // ES Modules import + * // const { AlexaForBusinessClient, DeleteBusinessReportScheduleCommand } = require("@aws-sdk/client-alexa-for-business"); // CommonJS import + * const client = new AlexaForBusinessClient(config); + * const command = new DeleteBusinessReportScheduleCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteBusinessReportScheduleCommandInput} for command's `input` shape. + * @see {@link DeleteBusinessReportScheduleCommandOutput} for command's `response` shape. + * @see {@link AlexaForBusinessClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteBusinessReportScheduleCommand extends $Command< DeleteBusinessReportScheduleCommandInput, diff --git a/clients/client-alexa-for-business/commands/DeleteConferenceProviderCommand.ts b/clients/client-alexa-for-business/commands/DeleteConferenceProviderCommand.ts index ca1442a4fa6f..ac5ef6133994 100644 --- a/clients/client-alexa-for-business/commands/DeleteConferenceProviderCommand.ts +++ b/clients/client-alexa-for-business/commands/DeleteConferenceProviderCommand.ts @@ -22,6 +22,20 @@ export interface DeleteConferenceProviderCommandOutput extends DeleteConferenceP /** *

Deletes a conference provider.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { AlexaForBusinessClient, DeleteConferenceProviderCommand } from "@aws-sdk/client-alexa-for-business"; // ES Modules import + * // const { AlexaForBusinessClient, DeleteConferenceProviderCommand } = require("@aws-sdk/client-alexa-for-business"); // CommonJS import + * const client = new AlexaForBusinessClient(config); + * const command = new DeleteConferenceProviderCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteConferenceProviderCommandInput} for command's `input` shape. + * @see {@link DeleteConferenceProviderCommandOutput} for command's `response` shape. + * @see {@link AlexaForBusinessClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteConferenceProviderCommand extends $Command< DeleteConferenceProviderCommandInput, diff --git a/clients/client-alexa-for-business/commands/DeleteContactCommand.ts b/clients/client-alexa-for-business/commands/DeleteContactCommand.ts index 6d7e4a7f690a..8c5a87287cd1 100644 --- a/clients/client-alexa-for-business/commands/DeleteContactCommand.ts +++ b/clients/client-alexa-for-business/commands/DeleteContactCommand.ts @@ -22,6 +22,20 @@ export interface DeleteContactCommandOutput extends DeleteContactResponse, __Met /** *

Deletes a contact by the contact ARN.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { AlexaForBusinessClient, DeleteContactCommand } from "@aws-sdk/client-alexa-for-business"; // ES Modules import + * // const { AlexaForBusinessClient, DeleteContactCommand } = require("@aws-sdk/client-alexa-for-business"); // CommonJS import + * const client = new AlexaForBusinessClient(config); + * const command = new DeleteContactCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteContactCommandInput} for command's `input` shape. + * @see {@link DeleteContactCommandOutput} for command's `response` shape. + * @see {@link AlexaForBusinessClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteContactCommand extends $Command< DeleteContactCommandInput, diff --git a/clients/client-alexa-for-business/commands/DeleteDeviceCommand.ts b/clients/client-alexa-for-business/commands/DeleteDeviceCommand.ts index 5e2cae573a79..0e6f470feeb2 100644 --- a/clients/client-alexa-for-business/commands/DeleteDeviceCommand.ts +++ b/clients/client-alexa-for-business/commands/DeleteDeviceCommand.ts @@ -22,6 +22,20 @@ export interface DeleteDeviceCommandOutput extends DeleteDeviceResponse, __Metad /** *

Removes a device from Alexa For Business.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { AlexaForBusinessClient, DeleteDeviceCommand } from "@aws-sdk/client-alexa-for-business"; // ES Modules import + * // const { AlexaForBusinessClient, DeleteDeviceCommand } = require("@aws-sdk/client-alexa-for-business"); // CommonJS import + * const client = new AlexaForBusinessClient(config); + * const command = new DeleteDeviceCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteDeviceCommandInput} for command's `input` shape. + * @see {@link DeleteDeviceCommandOutput} for command's `response` shape. + * @see {@link AlexaForBusinessClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteDeviceCommand extends $Command< DeleteDeviceCommandInput, diff --git a/clients/client-alexa-for-business/commands/DeleteDeviceUsageDataCommand.ts b/clients/client-alexa-for-business/commands/DeleteDeviceUsageDataCommand.ts index 3c1bef62bfce..8e20f096cd8a 100644 --- a/clients/client-alexa-for-business/commands/DeleteDeviceUsageDataCommand.ts +++ b/clients/client-alexa-for-business/commands/DeleteDeviceUsageDataCommand.ts @@ -24,6 +24,20 @@ export interface DeleteDeviceUsageDataCommandOutput extends DeleteDeviceUsageDat *

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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { AlexaForBusinessClient, DeleteDeviceUsageDataCommand } from "@aws-sdk/client-alexa-for-business"; // ES Modules import + * // const { AlexaForBusinessClient, DeleteDeviceUsageDataCommand } = require("@aws-sdk/client-alexa-for-business"); // CommonJS import + * const client = new AlexaForBusinessClient(config); + * const command = new DeleteDeviceUsageDataCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteDeviceUsageDataCommandInput} for command's `input` shape. + * @see {@link DeleteDeviceUsageDataCommandOutput} for command's `response` shape. + * @see {@link AlexaForBusinessClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteDeviceUsageDataCommand extends $Command< DeleteDeviceUsageDataCommandInput, diff --git a/clients/client-alexa-for-business/commands/DeleteGatewayGroupCommand.ts b/clients/client-alexa-for-business/commands/DeleteGatewayGroupCommand.ts index 9a62264a2743..9b1e5d5d9509 100644 --- a/clients/client-alexa-for-business/commands/DeleteGatewayGroupCommand.ts +++ b/clients/client-alexa-for-business/commands/DeleteGatewayGroupCommand.ts @@ -22,6 +22,20 @@ export interface DeleteGatewayGroupCommandOutput extends DeleteGatewayGroupRespo /** *

Deletes a gateway group.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { AlexaForBusinessClient, DeleteGatewayGroupCommand } from "@aws-sdk/client-alexa-for-business"; // ES Modules import + * // const { AlexaForBusinessClient, DeleteGatewayGroupCommand } = require("@aws-sdk/client-alexa-for-business"); // CommonJS import + * const client = new AlexaForBusinessClient(config); + * const command = new DeleteGatewayGroupCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteGatewayGroupCommandInput} for command's `input` shape. + * @see {@link DeleteGatewayGroupCommandOutput} for command's `response` shape. + * @see {@link AlexaForBusinessClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteGatewayGroupCommand extends $Command< DeleteGatewayGroupCommandInput, diff --git a/clients/client-alexa-for-business/commands/DeleteNetworkProfileCommand.ts b/clients/client-alexa-for-business/commands/DeleteNetworkProfileCommand.ts index 587dc5ca9423..9d15fd961b83 100644 --- a/clients/client-alexa-for-business/commands/DeleteNetworkProfileCommand.ts +++ b/clients/client-alexa-for-business/commands/DeleteNetworkProfileCommand.ts @@ -22,6 +22,20 @@ export interface DeleteNetworkProfileCommandOutput extends DeleteNetworkProfileR /** *

Deletes a network profile by the network profile ARN.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { AlexaForBusinessClient, DeleteNetworkProfileCommand } from "@aws-sdk/client-alexa-for-business"; // ES Modules import + * // const { AlexaForBusinessClient, DeleteNetworkProfileCommand } = require("@aws-sdk/client-alexa-for-business"); // CommonJS import + * const client = new AlexaForBusinessClient(config); + * const command = new DeleteNetworkProfileCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteNetworkProfileCommandInput} for command's `input` shape. + * @see {@link DeleteNetworkProfileCommandOutput} for command's `response` shape. + * @see {@link AlexaForBusinessClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteNetworkProfileCommand extends $Command< DeleteNetworkProfileCommandInput, diff --git a/clients/client-alexa-for-business/commands/DeleteProfileCommand.ts b/clients/client-alexa-for-business/commands/DeleteProfileCommand.ts index 1d385d88c44f..577f90a20173 100644 --- a/clients/client-alexa-for-business/commands/DeleteProfileCommand.ts +++ b/clients/client-alexa-for-business/commands/DeleteProfileCommand.ts @@ -22,6 +22,20 @@ export interface DeleteProfileCommandOutput extends DeleteProfileResponse, __Met /** *

Deletes a room profile by the profile ARN.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { AlexaForBusinessClient, DeleteProfileCommand } from "@aws-sdk/client-alexa-for-business"; // ES Modules import + * // const { AlexaForBusinessClient, DeleteProfileCommand } = require("@aws-sdk/client-alexa-for-business"); // CommonJS import + * const client = new AlexaForBusinessClient(config); + * const command = new DeleteProfileCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteProfileCommandInput} for command's `input` shape. + * @see {@link DeleteProfileCommandOutput} for command's `response` shape. + * @see {@link AlexaForBusinessClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteProfileCommand extends $Command< DeleteProfileCommandInput, diff --git a/clients/client-alexa-for-business/commands/DeleteRoomCommand.ts b/clients/client-alexa-for-business/commands/DeleteRoomCommand.ts index cfa5ff15ff7b..fcd7bbf557d1 100644 --- a/clients/client-alexa-for-business/commands/DeleteRoomCommand.ts +++ b/clients/client-alexa-for-business/commands/DeleteRoomCommand.ts @@ -22,6 +22,20 @@ export interface DeleteRoomCommandOutput extends DeleteRoomResponse, __MetadataB /** *

Deletes a room by the room ARN.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { AlexaForBusinessClient, DeleteRoomCommand } from "@aws-sdk/client-alexa-for-business"; // ES Modules import + * // const { AlexaForBusinessClient, DeleteRoomCommand } = require("@aws-sdk/client-alexa-for-business"); // CommonJS import + * const client = new AlexaForBusinessClient(config); + * const command = new DeleteRoomCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteRoomCommandInput} for command's `input` shape. + * @see {@link DeleteRoomCommandOutput} for command's `response` shape. + * @see {@link AlexaForBusinessClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteRoomCommand extends $Command< DeleteRoomCommandInput, diff --git a/clients/client-alexa-for-business/commands/DeleteRoomSkillParameterCommand.ts b/clients/client-alexa-for-business/commands/DeleteRoomSkillParameterCommand.ts index bdb933374d56..6ea2f0c90a69 100644 --- a/clients/client-alexa-for-business/commands/DeleteRoomSkillParameterCommand.ts +++ b/clients/client-alexa-for-business/commands/DeleteRoomSkillParameterCommand.ts @@ -22,6 +22,20 @@ export interface DeleteRoomSkillParameterCommandOutput extends DeleteRoomSkillPa /** *

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

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { AlexaForBusinessClient, DeleteRoomSkillParameterCommand } from "@aws-sdk/client-alexa-for-business"; // ES Modules import + * // const { AlexaForBusinessClient, DeleteRoomSkillParameterCommand } = require("@aws-sdk/client-alexa-for-business"); // CommonJS import + * const client = new AlexaForBusinessClient(config); + * const command = new DeleteRoomSkillParameterCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteRoomSkillParameterCommandInput} for command's `input` shape. + * @see {@link DeleteRoomSkillParameterCommandOutput} for command's `response` shape. + * @see {@link AlexaForBusinessClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteRoomSkillParameterCommand extends $Command< DeleteRoomSkillParameterCommandInput, diff --git a/clients/client-alexa-for-business/commands/DeleteSkillAuthorizationCommand.ts b/clients/client-alexa-for-business/commands/DeleteSkillAuthorizationCommand.ts index fd9f11dd6003..2ee504a45f91 100644 --- a/clients/client-alexa-for-business/commands/DeleteSkillAuthorizationCommand.ts +++ b/clients/client-alexa-for-business/commands/DeleteSkillAuthorizationCommand.ts @@ -22,6 +22,20 @@ export interface DeleteSkillAuthorizationCommandOutput extends DeleteSkillAuthor /** *

Unlinks a third-party account from a skill.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { AlexaForBusinessClient, DeleteSkillAuthorizationCommand } from "@aws-sdk/client-alexa-for-business"; // ES Modules import + * // const { AlexaForBusinessClient, DeleteSkillAuthorizationCommand } = require("@aws-sdk/client-alexa-for-business"); // CommonJS import + * const client = new AlexaForBusinessClient(config); + * const command = new DeleteSkillAuthorizationCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteSkillAuthorizationCommandInput} for command's `input` shape. + * @see {@link DeleteSkillAuthorizationCommandOutput} for command's `response` shape. + * @see {@link AlexaForBusinessClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteSkillAuthorizationCommand extends $Command< DeleteSkillAuthorizationCommandInput, diff --git a/clients/client-alexa-for-business/commands/DeleteSkillGroupCommand.ts b/clients/client-alexa-for-business/commands/DeleteSkillGroupCommand.ts index 7f3a84fba924..9e3212c78ff5 100644 --- a/clients/client-alexa-for-business/commands/DeleteSkillGroupCommand.ts +++ b/clients/client-alexa-for-business/commands/DeleteSkillGroupCommand.ts @@ -22,6 +22,20 @@ export interface DeleteSkillGroupCommandOutput extends DeleteSkillGroupResponse, /** *

Deletes a skill group by skill group ARN.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { AlexaForBusinessClient, DeleteSkillGroupCommand } from "@aws-sdk/client-alexa-for-business"; // ES Modules import + * // const { AlexaForBusinessClient, DeleteSkillGroupCommand } = require("@aws-sdk/client-alexa-for-business"); // CommonJS import + * const client = new AlexaForBusinessClient(config); + * const command = new DeleteSkillGroupCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteSkillGroupCommandInput} for command's `input` shape. + * @see {@link DeleteSkillGroupCommandOutput} for command's `response` shape. + * @see {@link AlexaForBusinessClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteSkillGroupCommand extends $Command< DeleteSkillGroupCommandInput, diff --git a/clients/client-alexa-for-business/commands/DeleteUserCommand.ts b/clients/client-alexa-for-business/commands/DeleteUserCommand.ts index 65467b966e00..5d875a163da5 100644 --- a/clients/client-alexa-for-business/commands/DeleteUserCommand.ts +++ b/clients/client-alexa-for-business/commands/DeleteUserCommand.ts @@ -22,6 +22,20 @@ export interface DeleteUserCommandOutput extends DeleteUserResponse, __MetadataB /** *

Deletes a specified user by user ARN and enrollment ARN.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { AlexaForBusinessClient, DeleteUserCommand } from "@aws-sdk/client-alexa-for-business"; // ES Modules import + * // const { AlexaForBusinessClient, DeleteUserCommand } = require("@aws-sdk/client-alexa-for-business"); // CommonJS import + * const client = new AlexaForBusinessClient(config); + * const command = new DeleteUserCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteUserCommandInput} for command's `input` shape. + * @see {@link DeleteUserCommandOutput} for command's `response` shape. + * @see {@link AlexaForBusinessClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteUserCommand extends $Command< DeleteUserCommandInput, diff --git a/clients/client-alexa-for-business/commands/DisassociateContactFromAddressBookCommand.ts b/clients/client-alexa-for-business/commands/DisassociateContactFromAddressBookCommand.ts index 49de6417e0a3..c123f15b05c0 100644 --- a/clients/client-alexa-for-business/commands/DisassociateContactFromAddressBookCommand.ts +++ b/clients/client-alexa-for-business/commands/DisassociateContactFromAddressBookCommand.ts @@ -27,6 +27,20 @@ export interface DisassociateContactFromAddressBookCommandOutput /** *

Disassociates a contact from a given address book.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { AlexaForBusinessClient, DisassociateContactFromAddressBookCommand } from "@aws-sdk/client-alexa-for-business"; // ES Modules import + * // const { AlexaForBusinessClient, DisassociateContactFromAddressBookCommand } = require("@aws-sdk/client-alexa-for-business"); // CommonJS import + * const client = new AlexaForBusinessClient(config); + * const command = new DisassociateContactFromAddressBookCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DisassociateContactFromAddressBookCommandInput} for command's `input` shape. + * @see {@link DisassociateContactFromAddressBookCommandOutput} for command's `response` shape. + * @see {@link AlexaForBusinessClientResolvedConfig | config} for command's `input` shape. + * */ export class DisassociateContactFromAddressBookCommand extends $Command< DisassociateContactFromAddressBookCommandInput, diff --git a/clients/client-alexa-for-business/commands/DisassociateDeviceFromRoomCommand.ts b/clients/client-alexa-for-business/commands/DisassociateDeviceFromRoomCommand.ts index 3b1fb96674dd..7951155a16e7 100644 --- a/clients/client-alexa-for-business/commands/DisassociateDeviceFromRoomCommand.ts +++ b/clients/client-alexa-for-business/commands/DisassociateDeviceFromRoomCommand.ts @@ -24,6 +24,20 @@ export interface DisassociateDeviceFromRoomCommandOutput extends DisassociateDev *

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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { AlexaForBusinessClient, DisassociateDeviceFromRoomCommand } from "@aws-sdk/client-alexa-for-business"; // ES Modules import + * // const { AlexaForBusinessClient, DisassociateDeviceFromRoomCommand } = require("@aws-sdk/client-alexa-for-business"); // CommonJS import + * const client = new AlexaForBusinessClient(config); + * const command = new DisassociateDeviceFromRoomCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DisassociateDeviceFromRoomCommandInput} for command's `input` shape. + * @see {@link DisassociateDeviceFromRoomCommandOutput} for command's `response` shape. + * @see {@link AlexaForBusinessClientResolvedConfig | config} for command's `input` shape. + * */ export class DisassociateDeviceFromRoomCommand extends $Command< DisassociateDeviceFromRoomCommandInput, diff --git a/clients/client-alexa-for-business/commands/DisassociateSkillFromSkillGroupCommand.ts b/clients/client-alexa-for-business/commands/DisassociateSkillFromSkillGroupCommand.ts index cc95e15b3689..f741f6a2a17b 100644 --- a/clients/client-alexa-for-business/commands/DisassociateSkillFromSkillGroupCommand.ts +++ b/clients/client-alexa-for-business/commands/DisassociateSkillFromSkillGroupCommand.ts @@ -24,6 +24,20 @@ export interface DisassociateSkillFromSkillGroupCommandOutput /** *

Disassociates a skill from a skill group.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { AlexaForBusinessClient, DisassociateSkillFromSkillGroupCommand } from "@aws-sdk/client-alexa-for-business"; // ES Modules import + * // const { AlexaForBusinessClient, DisassociateSkillFromSkillGroupCommand } = require("@aws-sdk/client-alexa-for-business"); // CommonJS import + * const client = new AlexaForBusinessClient(config); + * const command = new DisassociateSkillFromSkillGroupCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DisassociateSkillFromSkillGroupCommandInput} for command's `input` shape. + * @see {@link DisassociateSkillFromSkillGroupCommandOutput} for command's `response` shape. + * @see {@link AlexaForBusinessClientResolvedConfig | config} for command's `input` shape. + * */ export class DisassociateSkillFromSkillGroupCommand extends $Command< DisassociateSkillFromSkillGroupCommandInput, diff --git a/clients/client-alexa-for-business/commands/DisassociateSkillFromUsersCommand.ts b/clients/client-alexa-for-business/commands/DisassociateSkillFromUsersCommand.ts index 3a8045392af1..8e419b9737d1 100644 --- a/clients/client-alexa-for-business/commands/DisassociateSkillFromUsersCommand.ts +++ b/clients/client-alexa-for-business/commands/DisassociateSkillFromUsersCommand.ts @@ -23,6 +23,20 @@ export interface DisassociateSkillFromUsersCommandOutput extends DisassociateSki /** *

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

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { AlexaForBusinessClient, DisassociateSkillFromUsersCommand } from "@aws-sdk/client-alexa-for-business"; // ES Modules import + * // const { AlexaForBusinessClient, DisassociateSkillFromUsersCommand } = require("@aws-sdk/client-alexa-for-business"); // CommonJS import + * const client = new AlexaForBusinessClient(config); + * const command = new DisassociateSkillFromUsersCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DisassociateSkillFromUsersCommandInput} for command's `input` shape. + * @see {@link DisassociateSkillFromUsersCommandOutput} for command's `response` shape. + * @see {@link AlexaForBusinessClientResolvedConfig | config} for command's `input` shape. + * */ export class DisassociateSkillFromUsersCommand extends $Command< DisassociateSkillFromUsersCommandInput, diff --git a/clients/client-alexa-for-business/commands/DisassociateSkillGroupFromRoomCommand.ts b/clients/client-alexa-for-business/commands/DisassociateSkillGroupFromRoomCommand.ts index 003cb7bdc7eb..e8f7b4fba5f2 100644 --- a/clients/client-alexa-for-business/commands/DisassociateSkillGroupFromRoomCommand.ts +++ b/clients/client-alexa-for-business/commands/DisassociateSkillGroupFromRoomCommand.ts @@ -25,6 +25,20 @@ export interface DisassociateSkillGroupFromRoomCommandOutput /** *

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

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { AlexaForBusinessClient, DisassociateSkillGroupFromRoomCommand } from "@aws-sdk/client-alexa-for-business"; // ES Modules import + * // const { AlexaForBusinessClient, DisassociateSkillGroupFromRoomCommand } = require("@aws-sdk/client-alexa-for-business"); // CommonJS import + * const client = new AlexaForBusinessClient(config); + * const command = new DisassociateSkillGroupFromRoomCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DisassociateSkillGroupFromRoomCommandInput} for command's `input` shape. + * @see {@link DisassociateSkillGroupFromRoomCommandOutput} for command's `response` shape. + * @see {@link AlexaForBusinessClientResolvedConfig | config} for command's `input` shape. + * */ export class DisassociateSkillGroupFromRoomCommand extends $Command< DisassociateSkillGroupFromRoomCommandInput, diff --git a/clients/client-alexa-for-business/commands/ForgetSmartHomeAppliancesCommand.ts b/clients/client-alexa-for-business/commands/ForgetSmartHomeAppliancesCommand.ts index a9f2f5364504..a5bc88a66172 100644 --- a/clients/client-alexa-for-business/commands/ForgetSmartHomeAppliancesCommand.ts +++ b/clients/client-alexa-for-business/commands/ForgetSmartHomeAppliancesCommand.ts @@ -22,6 +22,20 @@ export interface ForgetSmartHomeAppliancesCommandOutput extends ForgetSmartHomeA /** *

Forgets smart home appliances associated to a room.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { AlexaForBusinessClient, ForgetSmartHomeAppliancesCommand } from "@aws-sdk/client-alexa-for-business"; // ES Modules import + * // const { AlexaForBusinessClient, ForgetSmartHomeAppliancesCommand } = require("@aws-sdk/client-alexa-for-business"); // CommonJS import + * const client = new AlexaForBusinessClient(config); + * const command = new ForgetSmartHomeAppliancesCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ForgetSmartHomeAppliancesCommandInput} for command's `input` shape. + * @see {@link ForgetSmartHomeAppliancesCommandOutput} for command's `response` shape. + * @see {@link AlexaForBusinessClientResolvedConfig | config} for command's `input` shape. + * */ export class ForgetSmartHomeAppliancesCommand extends $Command< ForgetSmartHomeAppliancesCommandInput, diff --git a/clients/client-alexa-for-business/commands/GetAddressBookCommand.ts b/clients/client-alexa-for-business/commands/GetAddressBookCommand.ts index 62f373e02860..5d19f7911243 100644 --- a/clients/client-alexa-for-business/commands/GetAddressBookCommand.ts +++ b/clients/client-alexa-for-business/commands/GetAddressBookCommand.ts @@ -22,6 +22,20 @@ export interface GetAddressBookCommandOutput extends GetAddressBookResponse, __M /** *

Gets address the book details by the address book ARN.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { AlexaForBusinessClient, GetAddressBookCommand } from "@aws-sdk/client-alexa-for-business"; // ES Modules import + * // const { AlexaForBusinessClient, GetAddressBookCommand } = require("@aws-sdk/client-alexa-for-business"); // CommonJS import + * const client = new AlexaForBusinessClient(config); + * const command = new GetAddressBookCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetAddressBookCommandInput} for command's `input` shape. + * @see {@link GetAddressBookCommandOutput} for command's `response` shape. + * @see {@link AlexaForBusinessClientResolvedConfig | config} for command's `input` shape. + * */ export class GetAddressBookCommand extends $Command< GetAddressBookCommandInput, diff --git a/clients/client-alexa-for-business/commands/GetConferencePreferenceCommand.ts b/clients/client-alexa-for-business/commands/GetConferencePreferenceCommand.ts index f152723db72a..83cfff5102d9 100644 --- a/clients/client-alexa-for-business/commands/GetConferencePreferenceCommand.ts +++ b/clients/client-alexa-for-business/commands/GetConferencePreferenceCommand.ts @@ -22,6 +22,20 @@ export interface GetConferencePreferenceCommandOutput extends GetConferencePrefe /** *

Retrieves the existing conference preferences.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { AlexaForBusinessClient, GetConferencePreferenceCommand } from "@aws-sdk/client-alexa-for-business"; // ES Modules import + * // const { AlexaForBusinessClient, GetConferencePreferenceCommand } = require("@aws-sdk/client-alexa-for-business"); // CommonJS import + * const client = new AlexaForBusinessClient(config); + * const command = new GetConferencePreferenceCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetConferencePreferenceCommandInput} for command's `input` shape. + * @see {@link GetConferencePreferenceCommandOutput} for command's `response` shape. + * @see {@link AlexaForBusinessClientResolvedConfig | config} for command's `input` shape. + * */ export class GetConferencePreferenceCommand extends $Command< GetConferencePreferenceCommandInput, diff --git a/clients/client-alexa-for-business/commands/GetConferenceProviderCommand.ts b/clients/client-alexa-for-business/commands/GetConferenceProviderCommand.ts index a32051dddb2c..02cbe0a04ab7 100644 --- a/clients/client-alexa-for-business/commands/GetConferenceProviderCommand.ts +++ b/clients/client-alexa-for-business/commands/GetConferenceProviderCommand.ts @@ -22,6 +22,20 @@ export interface GetConferenceProviderCommandOutput extends GetConferenceProvide /** *

Gets details about a specific conference provider.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { AlexaForBusinessClient, GetConferenceProviderCommand } from "@aws-sdk/client-alexa-for-business"; // ES Modules import + * // const { AlexaForBusinessClient, GetConferenceProviderCommand } = require("@aws-sdk/client-alexa-for-business"); // CommonJS import + * const client = new AlexaForBusinessClient(config); + * const command = new GetConferenceProviderCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetConferenceProviderCommandInput} for command's `input` shape. + * @see {@link GetConferenceProviderCommandOutput} for command's `response` shape. + * @see {@link AlexaForBusinessClientResolvedConfig | config} for command's `input` shape. + * */ export class GetConferenceProviderCommand extends $Command< GetConferenceProviderCommandInput, diff --git a/clients/client-alexa-for-business/commands/GetContactCommand.ts b/clients/client-alexa-for-business/commands/GetContactCommand.ts index 390a1c15fdf8..fb1e932806b5 100644 --- a/clients/client-alexa-for-business/commands/GetContactCommand.ts +++ b/clients/client-alexa-for-business/commands/GetContactCommand.ts @@ -22,6 +22,20 @@ export interface GetContactCommandOutput extends GetContactResponse, __MetadataB /** *

Gets the contact details by the contact ARN.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { AlexaForBusinessClient, GetContactCommand } from "@aws-sdk/client-alexa-for-business"; // ES Modules import + * // const { AlexaForBusinessClient, GetContactCommand } = require("@aws-sdk/client-alexa-for-business"); // CommonJS import + * const client = new AlexaForBusinessClient(config); + * const command = new GetContactCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetContactCommandInput} for command's `input` shape. + * @see {@link GetContactCommandOutput} for command's `response` shape. + * @see {@link AlexaForBusinessClientResolvedConfig | config} for command's `input` shape. + * */ export class GetContactCommand extends $Command< GetContactCommandInput, diff --git a/clients/client-alexa-for-business/commands/GetDeviceCommand.ts b/clients/client-alexa-for-business/commands/GetDeviceCommand.ts index 5f9eea3278ae..7c44a7d475c4 100644 --- a/clients/client-alexa-for-business/commands/GetDeviceCommand.ts +++ b/clients/client-alexa-for-business/commands/GetDeviceCommand.ts @@ -19,6 +19,20 @@ export interface GetDeviceCommandOutput extends GetDeviceResponse, __MetadataBea /** *

Gets the details of a device by device ARN.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { AlexaForBusinessClient, GetDeviceCommand } from "@aws-sdk/client-alexa-for-business"; // ES Modules import + * // const { AlexaForBusinessClient, GetDeviceCommand } = require("@aws-sdk/client-alexa-for-business"); // CommonJS import + * const client = new AlexaForBusinessClient(config); + * const command = new GetDeviceCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetDeviceCommandInput} for command's `input` shape. + * @see {@link GetDeviceCommandOutput} for command's `response` shape. + * @see {@link AlexaForBusinessClientResolvedConfig | config} for command's `input` shape. + * */ export class GetDeviceCommand extends $Command< GetDeviceCommandInput, diff --git a/clients/client-alexa-for-business/commands/GetGatewayCommand.ts b/clients/client-alexa-for-business/commands/GetGatewayCommand.ts index a01ff79887aa..474e7d6aa816 100644 --- a/clients/client-alexa-for-business/commands/GetGatewayCommand.ts +++ b/clients/client-alexa-for-business/commands/GetGatewayCommand.ts @@ -22,6 +22,20 @@ export interface GetGatewayCommandOutput extends GetGatewayResponse, __MetadataB /** *

Retrieves the details of a gateway.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { AlexaForBusinessClient, GetGatewayCommand } from "@aws-sdk/client-alexa-for-business"; // ES Modules import + * // const { AlexaForBusinessClient, GetGatewayCommand } = require("@aws-sdk/client-alexa-for-business"); // CommonJS import + * const client = new AlexaForBusinessClient(config); + * const command = new GetGatewayCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetGatewayCommandInput} for command's `input` shape. + * @see {@link GetGatewayCommandOutput} for command's `response` shape. + * @see {@link AlexaForBusinessClientResolvedConfig | config} for command's `input` shape. + * */ export class GetGatewayCommand extends $Command< GetGatewayCommandInput, diff --git a/clients/client-alexa-for-business/commands/GetGatewayGroupCommand.ts b/clients/client-alexa-for-business/commands/GetGatewayGroupCommand.ts index 565f30d946d5..5cfa44ac638b 100644 --- a/clients/client-alexa-for-business/commands/GetGatewayGroupCommand.ts +++ b/clients/client-alexa-for-business/commands/GetGatewayGroupCommand.ts @@ -22,6 +22,20 @@ export interface GetGatewayGroupCommandOutput extends GetGatewayGroupResponse, _ /** *

Retrieves the details of a gateway group.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { AlexaForBusinessClient, GetGatewayGroupCommand } from "@aws-sdk/client-alexa-for-business"; // ES Modules import + * // const { AlexaForBusinessClient, GetGatewayGroupCommand } = require("@aws-sdk/client-alexa-for-business"); // CommonJS import + * const client = new AlexaForBusinessClient(config); + * const command = new GetGatewayGroupCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetGatewayGroupCommandInput} for command's `input` shape. + * @see {@link GetGatewayGroupCommandOutput} for command's `response` shape. + * @see {@link AlexaForBusinessClientResolvedConfig | config} for command's `input` shape. + * */ export class GetGatewayGroupCommand extends $Command< GetGatewayGroupCommandInput, diff --git a/clients/client-alexa-for-business/commands/GetInvitationConfigurationCommand.ts b/clients/client-alexa-for-business/commands/GetInvitationConfigurationCommand.ts index e746ed21cab7..680bbb181a79 100644 --- a/clients/client-alexa-for-business/commands/GetInvitationConfigurationCommand.ts +++ b/clients/client-alexa-for-business/commands/GetInvitationConfigurationCommand.ts @@ -23,6 +23,20 @@ export interface GetInvitationConfigurationCommandOutput extends GetInvitationCo /** *

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

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { AlexaForBusinessClient, GetInvitationConfigurationCommand } from "@aws-sdk/client-alexa-for-business"; // ES Modules import + * // const { AlexaForBusinessClient, GetInvitationConfigurationCommand } = require("@aws-sdk/client-alexa-for-business"); // CommonJS import + * const client = new AlexaForBusinessClient(config); + * const command = new GetInvitationConfigurationCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetInvitationConfigurationCommandInput} for command's `input` shape. + * @see {@link GetInvitationConfigurationCommandOutput} for command's `response` shape. + * @see {@link AlexaForBusinessClientResolvedConfig | config} for command's `input` shape. + * */ export class GetInvitationConfigurationCommand extends $Command< GetInvitationConfigurationCommandInput, diff --git a/clients/client-alexa-for-business/commands/GetNetworkProfileCommand.ts b/clients/client-alexa-for-business/commands/GetNetworkProfileCommand.ts index eb1998a5892a..f46c32934b74 100644 --- a/clients/client-alexa-for-business/commands/GetNetworkProfileCommand.ts +++ b/clients/client-alexa-for-business/commands/GetNetworkProfileCommand.ts @@ -22,6 +22,20 @@ export interface GetNetworkProfileCommandOutput extends GetNetworkProfileRespons /** *

Gets the network profile details by the network profile ARN.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { AlexaForBusinessClient, GetNetworkProfileCommand } from "@aws-sdk/client-alexa-for-business"; // ES Modules import + * // const { AlexaForBusinessClient, GetNetworkProfileCommand } = require("@aws-sdk/client-alexa-for-business"); // CommonJS import + * const client = new AlexaForBusinessClient(config); + * const command = new GetNetworkProfileCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetNetworkProfileCommandInput} for command's `input` shape. + * @see {@link GetNetworkProfileCommandOutput} for command's `response` shape. + * @see {@link AlexaForBusinessClientResolvedConfig | config} for command's `input` shape. + * */ export class GetNetworkProfileCommand extends $Command< GetNetworkProfileCommandInput, diff --git a/clients/client-alexa-for-business/commands/GetProfileCommand.ts b/clients/client-alexa-for-business/commands/GetProfileCommand.ts index c78b2e958e91..b4abb73321d8 100644 --- a/clients/client-alexa-for-business/commands/GetProfileCommand.ts +++ b/clients/client-alexa-for-business/commands/GetProfileCommand.ts @@ -22,6 +22,20 @@ export interface GetProfileCommandOutput extends GetProfileResponse, __MetadataB /** *

Gets the details of a room profile by profile ARN.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { AlexaForBusinessClient, GetProfileCommand } from "@aws-sdk/client-alexa-for-business"; // ES Modules import + * // const { AlexaForBusinessClient, GetProfileCommand } = require("@aws-sdk/client-alexa-for-business"); // CommonJS import + * const client = new AlexaForBusinessClient(config); + * const command = new GetProfileCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetProfileCommandInput} for command's `input` shape. + * @see {@link GetProfileCommandOutput} for command's `response` shape. + * @see {@link AlexaForBusinessClientResolvedConfig | config} for command's `input` shape. + * */ export class GetProfileCommand extends $Command< GetProfileCommandInput, diff --git a/clients/client-alexa-for-business/commands/GetRoomCommand.ts b/clients/client-alexa-for-business/commands/GetRoomCommand.ts index c6d8f30c687c..1f9090263a46 100644 --- a/clients/client-alexa-for-business/commands/GetRoomCommand.ts +++ b/clients/client-alexa-for-business/commands/GetRoomCommand.ts @@ -19,6 +19,20 @@ export interface GetRoomCommandOutput extends GetRoomResponse, __MetadataBearer /** *

Gets room details by room ARN.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { AlexaForBusinessClient, GetRoomCommand } from "@aws-sdk/client-alexa-for-business"; // ES Modules import + * // const { AlexaForBusinessClient, GetRoomCommand } = require("@aws-sdk/client-alexa-for-business"); // CommonJS import + * const client = new AlexaForBusinessClient(config); + * const command = new GetRoomCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetRoomCommandInput} for command's `input` shape. + * @see {@link GetRoomCommandOutput} for command's `response` shape. + * @see {@link AlexaForBusinessClientResolvedConfig | config} for command's `input` shape. + * */ export class GetRoomCommand extends $Command< GetRoomCommandInput, diff --git a/clients/client-alexa-for-business/commands/GetRoomSkillParameterCommand.ts b/clients/client-alexa-for-business/commands/GetRoomSkillParameterCommand.ts index 741ad237d35a..e389a1e0d039 100644 --- a/clients/client-alexa-for-business/commands/GetRoomSkillParameterCommand.ts +++ b/clients/client-alexa-for-business/commands/GetRoomSkillParameterCommand.ts @@ -22,6 +22,20 @@ export interface GetRoomSkillParameterCommandOutput extends GetRoomSkillParamete /** *

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

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { AlexaForBusinessClient, GetRoomSkillParameterCommand } from "@aws-sdk/client-alexa-for-business"; // ES Modules import + * // const { AlexaForBusinessClient, GetRoomSkillParameterCommand } = require("@aws-sdk/client-alexa-for-business"); // CommonJS import + * const client = new AlexaForBusinessClient(config); + * const command = new GetRoomSkillParameterCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetRoomSkillParameterCommandInput} for command's `input` shape. + * @see {@link GetRoomSkillParameterCommandOutput} for command's `response` shape. + * @see {@link AlexaForBusinessClientResolvedConfig | config} for command's `input` shape. + * */ export class GetRoomSkillParameterCommand extends $Command< GetRoomSkillParameterCommandInput, diff --git a/clients/client-alexa-for-business/commands/GetSkillGroupCommand.ts b/clients/client-alexa-for-business/commands/GetSkillGroupCommand.ts index b99f905d61ea..e188ab5b26e6 100644 --- a/clients/client-alexa-for-business/commands/GetSkillGroupCommand.ts +++ b/clients/client-alexa-for-business/commands/GetSkillGroupCommand.ts @@ -22,6 +22,20 @@ export interface GetSkillGroupCommandOutput extends GetSkillGroupResponse, __Met /** *

Gets skill group details by skill group ARN.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { AlexaForBusinessClient, GetSkillGroupCommand } from "@aws-sdk/client-alexa-for-business"; // ES Modules import + * // const { AlexaForBusinessClient, GetSkillGroupCommand } = require("@aws-sdk/client-alexa-for-business"); // CommonJS import + * const client = new AlexaForBusinessClient(config); + * const command = new GetSkillGroupCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetSkillGroupCommandInput} for command's `input` shape. + * @see {@link GetSkillGroupCommandOutput} for command's `response` shape. + * @see {@link AlexaForBusinessClientResolvedConfig | config} for command's `input` shape. + * */ export class GetSkillGroupCommand extends $Command< GetSkillGroupCommandInput, diff --git a/clients/client-alexa-for-business/commands/ListBusinessReportSchedulesCommand.ts b/clients/client-alexa-for-business/commands/ListBusinessReportSchedulesCommand.ts index de2ef7f8d4b4..14901f99c3ba 100644 --- a/clients/client-alexa-for-business/commands/ListBusinessReportSchedulesCommand.ts +++ b/clients/client-alexa-for-business/commands/ListBusinessReportSchedulesCommand.ts @@ -24,6 +24,20 @@ export interface ListBusinessReportSchedulesCommandOutput /** *

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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { AlexaForBusinessClient, ListBusinessReportSchedulesCommand } from "@aws-sdk/client-alexa-for-business"; // ES Modules import + * // const { AlexaForBusinessClient, ListBusinessReportSchedulesCommand } = require("@aws-sdk/client-alexa-for-business"); // CommonJS import + * const client = new AlexaForBusinessClient(config); + * const command = new ListBusinessReportSchedulesCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListBusinessReportSchedulesCommandInput} for command's `input` shape. + * @see {@link ListBusinessReportSchedulesCommandOutput} for command's `response` shape. + * @see {@link AlexaForBusinessClientResolvedConfig | config} for command's `input` shape. + * */ export class ListBusinessReportSchedulesCommand extends $Command< ListBusinessReportSchedulesCommandInput, diff --git a/clients/client-alexa-for-business/commands/ListConferenceProvidersCommand.ts b/clients/client-alexa-for-business/commands/ListConferenceProvidersCommand.ts index ec1589124e41..b1261c226120 100644 --- a/clients/client-alexa-for-business/commands/ListConferenceProvidersCommand.ts +++ b/clients/client-alexa-for-business/commands/ListConferenceProvidersCommand.ts @@ -22,6 +22,20 @@ export interface ListConferenceProvidersCommandOutput extends ListConferenceProv /** *

Lists conference providers under a specific AWS account.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { AlexaForBusinessClient, ListConferenceProvidersCommand } from "@aws-sdk/client-alexa-for-business"; // ES Modules import + * // const { AlexaForBusinessClient, ListConferenceProvidersCommand } = require("@aws-sdk/client-alexa-for-business"); // CommonJS import + * const client = new AlexaForBusinessClient(config); + * const command = new ListConferenceProvidersCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListConferenceProvidersCommandInput} for command's `input` shape. + * @see {@link ListConferenceProvidersCommandOutput} for command's `response` shape. + * @see {@link AlexaForBusinessClientResolvedConfig | config} for command's `input` shape. + * */ export class ListConferenceProvidersCommand extends $Command< ListConferenceProvidersCommandInput, diff --git a/clients/client-alexa-for-business/commands/ListDeviceEventsCommand.ts b/clients/client-alexa-for-business/commands/ListDeviceEventsCommand.ts index 16cc32123af6..aa310de29867 100644 --- a/clients/client-alexa-for-business/commands/ListDeviceEventsCommand.ts +++ b/clients/client-alexa-for-business/commands/ListDeviceEventsCommand.ts @@ -23,6 +23,20 @@ export interface ListDeviceEventsCommandOutput extends ListDeviceEventsResponse, /** *

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

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { AlexaForBusinessClient, ListDeviceEventsCommand } from "@aws-sdk/client-alexa-for-business"; // ES Modules import + * // const { AlexaForBusinessClient, ListDeviceEventsCommand } = require("@aws-sdk/client-alexa-for-business"); // CommonJS import + * const client = new AlexaForBusinessClient(config); + * const command = new ListDeviceEventsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListDeviceEventsCommandInput} for command's `input` shape. + * @see {@link ListDeviceEventsCommandOutput} for command's `response` shape. + * @see {@link AlexaForBusinessClientResolvedConfig | config} for command's `input` shape. + * */ export class ListDeviceEventsCommand extends $Command< ListDeviceEventsCommandInput, diff --git a/clients/client-alexa-for-business/commands/ListGatewayGroupsCommand.ts b/clients/client-alexa-for-business/commands/ListGatewayGroupsCommand.ts index 275fd45d4f1b..f996d3da0c74 100644 --- a/clients/client-alexa-for-business/commands/ListGatewayGroupsCommand.ts +++ b/clients/client-alexa-for-business/commands/ListGatewayGroupsCommand.ts @@ -23,6 +23,20 @@ export interface ListGatewayGroupsCommandOutput extends ListGatewayGroupsRespons /** *

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

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { AlexaForBusinessClient, ListGatewayGroupsCommand } from "@aws-sdk/client-alexa-for-business"; // ES Modules import + * // const { AlexaForBusinessClient, ListGatewayGroupsCommand } = require("@aws-sdk/client-alexa-for-business"); // CommonJS import + * const client = new AlexaForBusinessClient(config); + * const command = new ListGatewayGroupsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListGatewayGroupsCommandInput} for command's `input` shape. + * @see {@link ListGatewayGroupsCommandOutput} for command's `response` shape. + * @see {@link AlexaForBusinessClientResolvedConfig | config} for command's `input` shape. + * */ export class ListGatewayGroupsCommand extends $Command< ListGatewayGroupsCommandInput, diff --git a/clients/client-alexa-for-business/commands/ListGatewaysCommand.ts b/clients/client-alexa-for-business/commands/ListGatewaysCommand.ts index 7650e86995dd..557036bc5c7f 100644 --- a/clients/client-alexa-for-business/commands/ListGatewaysCommand.ts +++ b/clients/client-alexa-for-business/commands/ListGatewaysCommand.ts @@ -24,6 +24,20 @@ export interface ListGatewaysCommandOutput extends ListGatewaysResponse, __Metad *

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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { AlexaForBusinessClient, ListGatewaysCommand } from "@aws-sdk/client-alexa-for-business"; // ES Modules import + * // const { AlexaForBusinessClient, ListGatewaysCommand } = require("@aws-sdk/client-alexa-for-business"); // CommonJS import + * const client = new AlexaForBusinessClient(config); + * const command = new ListGatewaysCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListGatewaysCommandInput} for command's `input` shape. + * @see {@link ListGatewaysCommandOutput} for command's `response` shape. + * @see {@link AlexaForBusinessClientResolvedConfig | config} for command's `input` shape. + * */ export class ListGatewaysCommand extends $Command< ListGatewaysCommandInput, diff --git a/clients/client-alexa-for-business/commands/ListSkillsCommand.ts b/clients/client-alexa-for-business/commands/ListSkillsCommand.ts index 3fa7f4c53a74..bf691083511d 100644 --- a/clients/client-alexa-for-business/commands/ListSkillsCommand.ts +++ b/clients/client-alexa-for-business/commands/ListSkillsCommand.ts @@ -22,6 +22,20 @@ export interface ListSkillsCommandOutput extends ListSkillsResponse, __MetadataB /** *

Lists all enabled skills in a specific skill group.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { AlexaForBusinessClient, ListSkillsCommand } from "@aws-sdk/client-alexa-for-business"; // ES Modules import + * // const { AlexaForBusinessClient, ListSkillsCommand } = require("@aws-sdk/client-alexa-for-business"); // CommonJS import + * const client = new AlexaForBusinessClient(config); + * const command = new ListSkillsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListSkillsCommandInput} for command's `input` shape. + * @see {@link ListSkillsCommandOutput} for command's `response` shape. + * @see {@link AlexaForBusinessClientResolvedConfig | config} for command's `input` shape. + * */ export class ListSkillsCommand extends $Command< ListSkillsCommandInput, diff --git a/clients/client-alexa-for-business/commands/ListSkillsStoreCategoriesCommand.ts b/clients/client-alexa-for-business/commands/ListSkillsStoreCategoriesCommand.ts index 8e21852840b5..f01e9c8e2408 100644 --- a/clients/client-alexa-for-business/commands/ListSkillsStoreCategoriesCommand.ts +++ b/clients/client-alexa-for-business/commands/ListSkillsStoreCategoriesCommand.ts @@ -22,6 +22,20 @@ export interface ListSkillsStoreCategoriesCommandOutput extends ListSkillsStoreC /** *

Lists all categories in the Alexa skill store.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { AlexaForBusinessClient, ListSkillsStoreCategoriesCommand } from "@aws-sdk/client-alexa-for-business"; // ES Modules import + * // const { AlexaForBusinessClient, ListSkillsStoreCategoriesCommand } = require("@aws-sdk/client-alexa-for-business"); // CommonJS import + * const client = new AlexaForBusinessClient(config); + * const command = new ListSkillsStoreCategoriesCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListSkillsStoreCategoriesCommandInput} for command's `input` shape. + * @see {@link ListSkillsStoreCategoriesCommandOutput} for command's `response` shape. + * @see {@link AlexaForBusinessClientResolvedConfig | config} for command's `input` shape. + * */ export class ListSkillsStoreCategoriesCommand extends $Command< ListSkillsStoreCategoriesCommandInput, diff --git a/clients/client-alexa-for-business/commands/ListSkillsStoreSkillsByCategoryCommand.ts b/clients/client-alexa-for-business/commands/ListSkillsStoreSkillsByCategoryCommand.ts index 7e53d151bfbe..b74e3df9fda0 100644 --- a/clients/client-alexa-for-business/commands/ListSkillsStoreSkillsByCategoryCommand.ts +++ b/clients/client-alexa-for-business/commands/ListSkillsStoreSkillsByCategoryCommand.ts @@ -24,6 +24,20 @@ export interface ListSkillsStoreSkillsByCategoryCommandOutput /** *

Lists all skills in the Alexa skill store by category.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { AlexaForBusinessClient, ListSkillsStoreSkillsByCategoryCommand } from "@aws-sdk/client-alexa-for-business"; // ES Modules import + * // const { AlexaForBusinessClient, ListSkillsStoreSkillsByCategoryCommand } = require("@aws-sdk/client-alexa-for-business"); // CommonJS import + * const client = new AlexaForBusinessClient(config); + * const command = new ListSkillsStoreSkillsByCategoryCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListSkillsStoreSkillsByCategoryCommandInput} for command's `input` shape. + * @see {@link ListSkillsStoreSkillsByCategoryCommandOutput} for command's `response` shape. + * @see {@link AlexaForBusinessClientResolvedConfig | config} for command's `input` shape. + * */ export class ListSkillsStoreSkillsByCategoryCommand extends $Command< ListSkillsStoreSkillsByCategoryCommandInput, diff --git a/clients/client-alexa-for-business/commands/ListSmartHomeAppliancesCommand.ts b/clients/client-alexa-for-business/commands/ListSmartHomeAppliancesCommand.ts index 80ac110edab6..3372222ee40a 100644 --- a/clients/client-alexa-for-business/commands/ListSmartHomeAppliancesCommand.ts +++ b/clients/client-alexa-for-business/commands/ListSmartHomeAppliancesCommand.ts @@ -22,6 +22,20 @@ export interface ListSmartHomeAppliancesCommandOutput extends ListSmartHomeAppli /** *

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

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { AlexaForBusinessClient, ListSmartHomeAppliancesCommand } from "@aws-sdk/client-alexa-for-business"; // ES Modules import + * // const { AlexaForBusinessClient, ListSmartHomeAppliancesCommand } = require("@aws-sdk/client-alexa-for-business"); // CommonJS import + * const client = new AlexaForBusinessClient(config); + * const command = new ListSmartHomeAppliancesCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListSmartHomeAppliancesCommandInput} for command's `input` shape. + * @see {@link ListSmartHomeAppliancesCommandOutput} for command's `response` shape. + * @see {@link AlexaForBusinessClientResolvedConfig | config} for command's `input` shape. + * */ export class ListSmartHomeAppliancesCommand extends $Command< ListSmartHomeAppliancesCommandInput, diff --git a/clients/client-alexa-for-business/commands/ListTagsCommand.ts b/clients/client-alexa-for-business/commands/ListTagsCommand.ts index 1a91a4a6be60..121d5fa37c89 100644 --- a/clients/client-alexa-for-business/commands/ListTagsCommand.ts +++ b/clients/client-alexa-for-business/commands/ListTagsCommand.ts @@ -19,6 +19,20 @@ export interface ListTagsCommandOutput extends ListTagsResponse, __MetadataBeare /** *

Lists all tags for the specified resource.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { AlexaForBusinessClient, ListTagsCommand } from "@aws-sdk/client-alexa-for-business"; // ES Modules import + * // const { AlexaForBusinessClient, ListTagsCommand } = require("@aws-sdk/client-alexa-for-business"); // CommonJS import + * const client = new AlexaForBusinessClient(config); + * const command = new ListTagsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListTagsCommandInput} for command's `input` shape. + * @see {@link ListTagsCommandOutput} for command's `response` shape. + * @see {@link AlexaForBusinessClientResolvedConfig | config} for command's `input` shape. + * */ export class ListTagsCommand extends $Command< ListTagsCommandInput, diff --git a/clients/client-alexa-for-business/commands/PutConferencePreferenceCommand.ts b/clients/client-alexa-for-business/commands/PutConferencePreferenceCommand.ts index bcaa7a92a024..cac0795ccc9c 100644 --- a/clients/client-alexa-for-business/commands/PutConferencePreferenceCommand.ts +++ b/clients/client-alexa-for-business/commands/PutConferencePreferenceCommand.ts @@ -23,6 +23,20 @@ export interface PutConferencePreferenceCommandOutput extends PutConferencePrefe /** *

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

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { AlexaForBusinessClient, PutConferencePreferenceCommand } from "@aws-sdk/client-alexa-for-business"; // ES Modules import + * // const { AlexaForBusinessClient, PutConferencePreferenceCommand } = require("@aws-sdk/client-alexa-for-business"); // CommonJS import + * const client = new AlexaForBusinessClient(config); + * const command = new PutConferencePreferenceCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link PutConferencePreferenceCommandInput} for command's `input` shape. + * @see {@link PutConferencePreferenceCommandOutput} for command's `response` shape. + * @see {@link AlexaForBusinessClientResolvedConfig | config} for command's `input` shape. + * */ export class PutConferencePreferenceCommand extends $Command< PutConferencePreferenceCommandInput, diff --git a/clients/client-alexa-for-business/commands/PutInvitationConfigurationCommand.ts b/clients/client-alexa-for-business/commands/PutInvitationConfigurationCommand.ts index bf8c2ca4638a..9e35178315bd 100644 --- a/clients/client-alexa-for-business/commands/PutInvitationConfigurationCommand.ts +++ b/clients/client-alexa-for-business/commands/PutInvitationConfigurationCommand.ts @@ -23,6 +23,20 @@ export interface PutInvitationConfigurationCommandOutput extends PutInvitationCo /** *

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

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { AlexaForBusinessClient, PutInvitationConfigurationCommand } from "@aws-sdk/client-alexa-for-business"; // ES Modules import + * // const { AlexaForBusinessClient, PutInvitationConfigurationCommand } = require("@aws-sdk/client-alexa-for-business"); // CommonJS import + * const client = new AlexaForBusinessClient(config); + * const command = new PutInvitationConfigurationCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link PutInvitationConfigurationCommandInput} for command's `input` shape. + * @see {@link PutInvitationConfigurationCommandOutput} for command's `response` shape. + * @see {@link AlexaForBusinessClientResolvedConfig | config} for command's `input` shape. + * */ export class PutInvitationConfigurationCommand extends $Command< PutInvitationConfigurationCommandInput, diff --git a/clients/client-alexa-for-business/commands/PutRoomSkillParameterCommand.ts b/clients/client-alexa-for-business/commands/PutRoomSkillParameterCommand.ts index ee5112d7ef9e..0c135c1ad903 100644 --- a/clients/client-alexa-for-business/commands/PutRoomSkillParameterCommand.ts +++ b/clients/client-alexa-for-business/commands/PutRoomSkillParameterCommand.ts @@ -23,6 +23,20 @@ export interface PutRoomSkillParameterCommandOutput extends PutRoomSkillParamete /** *

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

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { AlexaForBusinessClient, PutRoomSkillParameterCommand } from "@aws-sdk/client-alexa-for-business"; // ES Modules import + * // const { AlexaForBusinessClient, PutRoomSkillParameterCommand } = require("@aws-sdk/client-alexa-for-business"); // CommonJS import + * const client = new AlexaForBusinessClient(config); + * const command = new PutRoomSkillParameterCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link PutRoomSkillParameterCommandInput} for command's `input` shape. + * @see {@link PutRoomSkillParameterCommandOutput} for command's `response` shape. + * @see {@link AlexaForBusinessClientResolvedConfig | config} for command's `input` shape. + * */ export class PutRoomSkillParameterCommand extends $Command< PutRoomSkillParameterCommandInput, diff --git a/clients/client-alexa-for-business/commands/PutSkillAuthorizationCommand.ts b/clients/client-alexa-for-business/commands/PutSkillAuthorizationCommand.ts index cb7c2a94f2cd..e7055fc52d42 100644 --- a/clients/client-alexa-for-business/commands/PutSkillAuthorizationCommand.ts +++ b/clients/client-alexa-for-business/commands/PutSkillAuthorizationCommand.ts @@ -24,6 +24,20 @@ export interface PutSkillAuthorizationCommandOutput extends PutSkillAuthorizatio *

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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { AlexaForBusinessClient, PutSkillAuthorizationCommand } from "@aws-sdk/client-alexa-for-business"; // ES Modules import + * // const { AlexaForBusinessClient, PutSkillAuthorizationCommand } = require("@aws-sdk/client-alexa-for-business"); // CommonJS import + * const client = new AlexaForBusinessClient(config); + * const command = new PutSkillAuthorizationCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link PutSkillAuthorizationCommandInput} for command's `input` shape. + * @see {@link PutSkillAuthorizationCommandOutput} for command's `response` shape. + * @see {@link AlexaForBusinessClientResolvedConfig | config} for command's `input` shape. + * */ export class PutSkillAuthorizationCommand extends $Command< PutSkillAuthorizationCommandInput, diff --git a/clients/client-alexa-for-business/commands/RegisterAVSDeviceCommand.ts b/clients/client-alexa-for-business/commands/RegisterAVSDeviceCommand.ts index 07f23ef2f7ae..e711b1c12ba2 100644 --- a/clients/client-alexa-for-business/commands/RegisterAVSDeviceCommand.ts +++ b/clients/client-alexa-for-business/commands/RegisterAVSDeviceCommand.ts @@ -23,6 +23,20 @@ export interface RegisterAVSDeviceCommandOutput extends RegisterAVSDeviceRespons /** *

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

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { AlexaForBusinessClient, RegisterAVSDeviceCommand } from "@aws-sdk/client-alexa-for-business"; // ES Modules import + * // const { AlexaForBusinessClient, RegisterAVSDeviceCommand } = require("@aws-sdk/client-alexa-for-business"); // CommonJS import + * const client = new AlexaForBusinessClient(config); + * const command = new RegisterAVSDeviceCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link RegisterAVSDeviceCommandInput} for command's `input` shape. + * @see {@link RegisterAVSDeviceCommandOutput} for command's `response` shape. + * @see {@link AlexaForBusinessClientResolvedConfig | config} for command's `input` shape. + * */ export class RegisterAVSDeviceCommand extends $Command< RegisterAVSDeviceCommandInput, diff --git a/clients/client-alexa-for-business/commands/RejectSkillCommand.ts b/clients/client-alexa-for-business/commands/RejectSkillCommand.ts index acc66a100fd7..f153c26f94bd 100644 --- a/clients/client-alexa-for-business/commands/RejectSkillCommand.ts +++ b/clients/client-alexa-for-business/commands/RejectSkillCommand.ts @@ -24,6 +24,20 @@ export interface RejectSkillCommandOutput extends RejectSkillResponse, __Metadat *

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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { AlexaForBusinessClient, RejectSkillCommand } from "@aws-sdk/client-alexa-for-business"; // ES Modules import + * // const { AlexaForBusinessClient, RejectSkillCommand } = require("@aws-sdk/client-alexa-for-business"); // CommonJS import + * const client = new AlexaForBusinessClient(config); + * const command = new RejectSkillCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link RejectSkillCommandInput} for command's `input` shape. + * @see {@link RejectSkillCommandOutput} for command's `response` shape. + * @see {@link AlexaForBusinessClientResolvedConfig | config} for command's `input` shape. + * */ export class RejectSkillCommand extends $Command< RejectSkillCommandInput, diff --git a/clients/client-alexa-for-business/commands/ResolveRoomCommand.ts b/clients/client-alexa-for-business/commands/ResolveRoomCommand.ts index d8d326626ccd..a4040de109b6 100644 --- a/clients/client-alexa-for-business/commands/ResolveRoomCommand.ts +++ b/clients/client-alexa-for-business/commands/ResolveRoomCommand.ts @@ -28,6 +28,20 @@ export interface ResolveRoomCommandOutput extends ResolveRoomResponse, __Metadat * 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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { AlexaForBusinessClient, ResolveRoomCommand } from "@aws-sdk/client-alexa-for-business"; // ES Modules import + * // const { AlexaForBusinessClient, ResolveRoomCommand } = require("@aws-sdk/client-alexa-for-business"); // CommonJS import + * const client = new AlexaForBusinessClient(config); + * const command = new ResolveRoomCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ResolveRoomCommandInput} for command's `input` shape. + * @see {@link ResolveRoomCommandOutput} for command's `response` shape. + * @see {@link AlexaForBusinessClientResolvedConfig | config} for command's `input` shape. + * */ export class ResolveRoomCommand extends $Command< ResolveRoomCommandInput, diff --git a/clients/client-alexa-for-business/commands/RevokeInvitationCommand.ts b/clients/client-alexa-for-business/commands/RevokeInvitationCommand.ts index 52a2e2aa95ea..9940ba8440a3 100644 --- a/clients/client-alexa-for-business/commands/RevokeInvitationCommand.ts +++ b/clients/client-alexa-for-business/commands/RevokeInvitationCommand.ts @@ -22,6 +22,20 @@ export interface RevokeInvitationCommandOutput extends RevokeInvitationResponse, /** *

Revokes an invitation and invalidates the enrollment URL.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { AlexaForBusinessClient, RevokeInvitationCommand } from "@aws-sdk/client-alexa-for-business"; // ES Modules import + * // const { AlexaForBusinessClient, RevokeInvitationCommand } = require("@aws-sdk/client-alexa-for-business"); // CommonJS import + * const client = new AlexaForBusinessClient(config); + * const command = new RevokeInvitationCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link RevokeInvitationCommandInput} for command's `input` shape. + * @see {@link RevokeInvitationCommandOutput} for command's `response` shape. + * @see {@link AlexaForBusinessClientResolvedConfig | config} for command's `input` shape. + * */ export class RevokeInvitationCommand extends $Command< RevokeInvitationCommandInput, diff --git a/clients/client-alexa-for-business/commands/SearchAddressBooksCommand.ts b/clients/client-alexa-for-business/commands/SearchAddressBooksCommand.ts index 9258e20407fd..835e5c80e630 100644 --- a/clients/client-alexa-for-business/commands/SearchAddressBooksCommand.ts +++ b/clients/client-alexa-for-business/commands/SearchAddressBooksCommand.ts @@ -23,6 +23,20 @@ export interface SearchAddressBooksCommandOutput extends SearchAddressBooksRespo /** *

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

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { AlexaForBusinessClient, SearchAddressBooksCommand } from "@aws-sdk/client-alexa-for-business"; // ES Modules import + * // const { AlexaForBusinessClient, SearchAddressBooksCommand } = require("@aws-sdk/client-alexa-for-business"); // CommonJS import + * const client = new AlexaForBusinessClient(config); + * const command = new SearchAddressBooksCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link SearchAddressBooksCommandInput} for command's `input` shape. + * @see {@link SearchAddressBooksCommandOutput} for command's `response` shape. + * @see {@link AlexaForBusinessClientResolvedConfig | config} for command's `input` shape. + * */ export class SearchAddressBooksCommand extends $Command< SearchAddressBooksCommandInput, diff --git a/clients/client-alexa-for-business/commands/SearchContactsCommand.ts b/clients/client-alexa-for-business/commands/SearchContactsCommand.ts index 630091191933..074f60a581a5 100644 --- a/clients/client-alexa-for-business/commands/SearchContactsCommand.ts +++ b/clients/client-alexa-for-business/commands/SearchContactsCommand.ts @@ -23,6 +23,20 @@ export interface SearchContactsCommandOutput extends SearchContactsResponse, __M /** *

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

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { AlexaForBusinessClient, SearchContactsCommand } from "@aws-sdk/client-alexa-for-business"; // ES Modules import + * // const { AlexaForBusinessClient, SearchContactsCommand } = require("@aws-sdk/client-alexa-for-business"); // CommonJS import + * const client = new AlexaForBusinessClient(config); + * const command = new SearchContactsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link SearchContactsCommandInput} for command's `input` shape. + * @see {@link SearchContactsCommandOutput} for command's `response` shape. + * @see {@link AlexaForBusinessClientResolvedConfig | config} for command's `input` shape. + * */ export class SearchContactsCommand extends $Command< SearchContactsCommandInput, diff --git a/clients/client-alexa-for-business/commands/SearchDevicesCommand.ts b/clients/client-alexa-for-business/commands/SearchDevicesCommand.ts index 44a5e9069f82..26fb3377b318 100644 --- a/clients/client-alexa-for-business/commands/SearchDevicesCommand.ts +++ b/clients/client-alexa-for-business/commands/SearchDevicesCommand.ts @@ -22,6 +22,20 @@ export interface SearchDevicesCommandOutput extends SearchDevicesResponse, __Met /** *

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

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { AlexaForBusinessClient, SearchDevicesCommand } from "@aws-sdk/client-alexa-for-business"; // ES Modules import + * // const { AlexaForBusinessClient, SearchDevicesCommand } = require("@aws-sdk/client-alexa-for-business"); // CommonJS import + * const client = new AlexaForBusinessClient(config); + * const command = new SearchDevicesCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link SearchDevicesCommandInput} for command's `input` shape. + * @see {@link SearchDevicesCommandOutput} for command's `response` shape. + * @see {@link AlexaForBusinessClientResolvedConfig | config} for command's `input` shape. + * */ export class SearchDevicesCommand extends $Command< SearchDevicesCommandInput, diff --git a/clients/client-alexa-for-business/commands/SearchNetworkProfilesCommand.ts b/clients/client-alexa-for-business/commands/SearchNetworkProfilesCommand.ts index ae08b189ff35..ed47088d9f4c 100644 --- a/clients/client-alexa-for-business/commands/SearchNetworkProfilesCommand.ts +++ b/clients/client-alexa-for-business/commands/SearchNetworkProfilesCommand.ts @@ -23,6 +23,20 @@ export interface SearchNetworkProfilesCommandOutput extends SearchNetworkProfile /** *

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

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { AlexaForBusinessClient, SearchNetworkProfilesCommand } from "@aws-sdk/client-alexa-for-business"; // ES Modules import + * // const { AlexaForBusinessClient, SearchNetworkProfilesCommand } = require("@aws-sdk/client-alexa-for-business"); // CommonJS import + * const client = new AlexaForBusinessClient(config); + * const command = new SearchNetworkProfilesCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link SearchNetworkProfilesCommandInput} for command's `input` shape. + * @see {@link SearchNetworkProfilesCommandOutput} for command's `response` shape. + * @see {@link AlexaForBusinessClientResolvedConfig | config} for command's `input` shape. + * */ export class SearchNetworkProfilesCommand extends $Command< SearchNetworkProfilesCommandInput, diff --git a/clients/client-alexa-for-business/commands/SearchProfilesCommand.ts b/clients/client-alexa-for-business/commands/SearchProfilesCommand.ts index 61233756ae45..c478bd5fd74d 100644 --- a/clients/client-alexa-for-business/commands/SearchProfilesCommand.ts +++ b/clients/client-alexa-for-business/commands/SearchProfilesCommand.ts @@ -23,6 +23,20 @@ export interface SearchProfilesCommandOutput extends SearchProfilesResponse, __M /** *

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

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { AlexaForBusinessClient, SearchProfilesCommand } from "@aws-sdk/client-alexa-for-business"; // ES Modules import + * // const { AlexaForBusinessClient, SearchProfilesCommand } = require("@aws-sdk/client-alexa-for-business"); // CommonJS import + * const client = new AlexaForBusinessClient(config); + * const command = new SearchProfilesCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link SearchProfilesCommandInput} for command's `input` shape. + * @see {@link SearchProfilesCommandOutput} for command's `response` shape. + * @see {@link AlexaForBusinessClientResolvedConfig | config} for command's `input` shape. + * */ export class SearchProfilesCommand extends $Command< SearchProfilesCommandInput, diff --git a/clients/client-alexa-for-business/commands/SearchRoomsCommand.ts b/clients/client-alexa-for-business/commands/SearchRoomsCommand.ts index 3cd8da966405..91be78153d67 100644 --- a/clients/client-alexa-for-business/commands/SearchRoomsCommand.ts +++ b/clients/client-alexa-for-business/commands/SearchRoomsCommand.ts @@ -23,6 +23,20 @@ export interface SearchRoomsCommandOutput extends SearchRoomsResponse, __Metadat /** *

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

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { AlexaForBusinessClient, SearchRoomsCommand } from "@aws-sdk/client-alexa-for-business"; // ES Modules import + * // const { AlexaForBusinessClient, SearchRoomsCommand } = require("@aws-sdk/client-alexa-for-business"); // CommonJS import + * const client = new AlexaForBusinessClient(config); + * const command = new SearchRoomsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link SearchRoomsCommandInput} for command's `input` shape. + * @see {@link SearchRoomsCommandOutput} for command's `response` shape. + * @see {@link AlexaForBusinessClientResolvedConfig | config} for command's `input` shape. + * */ export class SearchRoomsCommand extends $Command< SearchRoomsCommandInput, diff --git a/clients/client-alexa-for-business/commands/SearchSkillGroupsCommand.ts b/clients/client-alexa-for-business/commands/SearchSkillGroupsCommand.ts index d2d3b1b53ad3..a8b1f8df1c2a 100644 --- a/clients/client-alexa-for-business/commands/SearchSkillGroupsCommand.ts +++ b/clients/client-alexa-for-business/commands/SearchSkillGroupsCommand.ts @@ -23,6 +23,20 @@ export interface SearchSkillGroupsCommandOutput extends SearchSkillGroupsRespons /** *

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

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { AlexaForBusinessClient, SearchSkillGroupsCommand } from "@aws-sdk/client-alexa-for-business"; // ES Modules import + * // const { AlexaForBusinessClient, SearchSkillGroupsCommand } = require("@aws-sdk/client-alexa-for-business"); // CommonJS import + * const client = new AlexaForBusinessClient(config); + * const command = new SearchSkillGroupsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link SearchSkillGroupsCommandInput} for command's `input` shape. + * @see {@link SearchSkillGroupsCommandOutput} for command's `response` shape. + * @see {@link AlexaForBusinessClientResolvedConfig | config} for command's `input` shape. + * */ export class SearchSkillGroupsCommand extends $Command< SearchSkillGroupsCommandInput, diff --git a/clients/client-alexa-for-business/commands/SearchUsersCommand.ts b/clients/client-alexa-for-business/commands/SearchUsersCommand.ts index d6c811d338d0..00a6a1544474 100644 --- a/clients/client-alexa-for-business/commands/SearchUsersCommand.ts +++ b/clients/client-alexa-for-business/commands/SearchUsersCommand.ts @@ -23,6 +23,20 @@ export interface SearchUsersCommandOutput extends SearchUsersResponse, __Metadat /** *

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

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { AlexaForBusinessClient, SearchUsersCommand } from "@aws-sdk/client-alexa-for-business"; // ES Modules import + * // const { AlexaForBusinessClient, SearchUsersCommand } = require("@aws-sdk/client-alexa-for-business"); // CommonJS import + * const client = new AlexaForBusinessClient(config); + * const command = new SearchUsersCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link SearchUsersCommandInput} for command's `input` shape. + * @see {@link SearchUsersCommandOutput} for command's `response` shape. + * @see {@link AlexaForBusinessClientResolvedConfig | config} for command's `input` shape. + * */ export class SearchUsersCommand extends $Command< SearchUsersCommandInput, diff --git a/clients/client-alexa-for-business/commands/SendAnnouncementCommand.ts b/clients/client-alexa-for-business/commands/SendAnnouncementCommand.ts index f6754907619f..71b06e7ca621 100644 --- a/clients/client-alexa-for-business/commands/SendAnnouncementCommand.ts +++ b/clients/client-alexa-for-business/commands/SendAnnouncementCommand.ts @@ -23,6 +23,20 @@ export interface SendAnnouncementCommandOutput extends SendAnnouncementResponse, /** *

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

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { AlexaForBusinessClient, SendAnnouncementCommand } from "@aws-sdk/client-alexa-for-business"; // ES Modules import + * // const { AlexaForBusinessClient, SendAnnouncementCommand } = require("@aws-sdk/client-alexa-for-business"); // CommonJS import + * const client = new AlexaForBusinessClient(config); + * const command = new SendAnnouncementCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link SendAnnouncementCommandInput} for command's `input` shape. + * @see {@link SendAnnouncementCommandOutput} for command's `response` shape. + * @see {@link AlexaForBusinessClientResolvedConfig | config} for command's `input` shape. + * */ export class SendAnnouncementCommand extends $Command< SendAnnouncementCommandInput, diff --git a/clients/client-alexa-for-business/commands/SendInvitationCommand.ts b/clients/client-alexa-for-business/commands/SendInvitationCommand.ts index f2e57ac3b82b..8ae856507e2b 100644 --- a/clients/client-alexa-for-business/commands/SendInvitationCommand.ts +++ b/clients/client-alexa-for-business/commands/SendInvitationCommand.ts @@ -23,6 +23,20 @@ export interface SendInvitationCommandOutput extends SendInvitationResponse, __M /** *

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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { AlexaForBusinessClient, SendInvitationCommand } from "@aws-sdk/client-alexa-for-business"; // ES Modules import + * // const { AlexaForBusinessClient, SendInvitationCommand } = require("@aws-sdk/client-alexa-for-business"); // CommonJS import + * const client = new AlexaForBusinessClient(config); + * const command = new SendInvitationCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link SendInvitationCommandInput} for command's `input` shape. + * @see {@link SendInvitationCommandOutput} for command's `response` shape. + * @see {@link AlexaForBusinessClientResolvedConfig | config} for command's `input` shape. + * */ export class SendInvitationCommand extends $Command< SendInvitationCommandInput, diff --git a/clients/client-alexa-for-business/commands/StartDeviceSyncCommand.ts b/clients/client-alexa-for-business/commands/StartDeviceSyncCommand.ts index a6b47d8bcf5c..2e1d4fce9af4 100644 --- a/clients/client-alexa-for-business/commands/StartDeviceSyncCommand.ts +++ b/clients/client-alexa-for-business/commands/StartDeviceSyncCommand.ts @@ -43,6 +43,20 @@ export interface StartDeviceSyncCommandOutput extends StartDeviceSyncResponse, _ * communications (if enabled on the room profile).

* * + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { AlexaForBusinessClient, StartDeviceSyncCommand } from "@aws-sdk/client-alexa-for-business"; // ES Modules import + * // const { AlexaForBusinessClient, StartDeviceSyncCommand } = require("@aws-sdk/client-alexa-for-business"); // CommonJS import + * const client = new AlexaForBusinessClient(config); + * const command = new StartDeviceSyncCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link StartDeviceSyncCommandInput} for command's `input` shape. + * @see {@link StartDeviceSyncCommandOutput} for command's `response` shape. + * @see {@link AlexaForBusinessClientResolvedConfig | config} for command's `input` shape. + * */ export class StartDeviceSyncCommand extends $Command< StartDeviceSyncCommandInput, diff --git a/clients/client-alexa-for-business/commands/StartSmartHomeApplianceDiscoveryCommand.ts b/clients/client-alexa-for-business/commands/StartSmartHomeApplianceDiscoveryCommand.ts index 35cbb1b6dd0e..1000fd42cba0 100644 --- a/clients/client-alexa-for-business/commands/StartSmartHomeApplianceDiscoveryCommand.ts +++ b/clients/client-alexa-for-business/commands/StartSmartHomeApplianceDiscoveryCommand.ts @@ -25,6 +25,20 @@ export interface StartSmartHomeApplianceDiscoveryCommandOutput /** *

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

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { AlexaForBusinessClient, StartSmartHomeApplianceDiscoveryCommand } from "@aws-sdk/client-alexa-for-business"; // ES Modules import + * // const { AlexaForBusinessClient, StartSmartHomeApplianceDiscoveryCommand } = require("@aws-sdk/client-alexa-for-business"); // CommonJS import + * const client = new AlexaForBusinessClient(config); + * const command = new StartSmartHomeApplianceDiscoveryCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link StartSmartHomeApplianceDiscoveryCommandInput} for command's `input` shape. + * @see {@link StartSmartHomeApplianceDiscoveryCommandOutput} for command's `response` shape. + * @see {@link AlexaForBusinessClientResolvedConfig | config} for command's `input` shape. + * */ export class StartSmartHomeApplianceDiscoveryCommand extends $Command< StartSmartHomeApplianceDiscoveryCommandInput, diff --git a/clients/client-alexa-for-business/commands/TagResourceCommand.ts b/clients/client-alexa-for-business/commands/TagResourceCommand.ts index 01611781dbf3..a372f309b148 100644 --- a/clients/client-alexa-for-business/commands/TagResourceCommand.ts +++ b/clients/client-alexa-for-business/commands/TagResourceCommand.ts @@ -22,6 +22,20 @@ export interface TagResourceCommandOutput extends TagResourceResponse, __Metadat /** *

Adds metadata tags to a specified resource.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { AlexaForBusinessClient, TagResourceCommand } from "@aws-sdk/client-alexa-for-business"; // ES Modules import + * // const { AlexaForBusinessClient, TagResourceCommand } = require("@aws-sdk/client-alexa-for-business"); // CommonJS import + * const client = new AlexaForBusinessClient(config); + * const command = new TagResourceCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link TagResourceCommandInput} for command's `input` shape. + * @see {@link TagResourceCommandOutput} for command's `response` shape. + * @see {@link AlexaForBusinessClientResolvedConfig | config} for command's `input` shape. + * */ export class TagResourceCommand extends $Command< TagResourceCommandInput, diff --git a/clients/client-alexa-for-business/commands/UntagResourceCommand.ts b/clients/client-alexa-for-business/commands/UntagResourceCommand.ts index 892330d5737c..77a763b16dfa 100644 --- a/clients/client-alexa-for-business/commands/UntagResourceCommand.ts +++ b/clients/client-alexa-for-business/commands/UntagResourceCommand.ts @@ -22,6 +22,20 @@ export interface UntagResourceCommandOutput extends UntagResourceResponse, __Met /** *

Removes metadata tags from a specified resource.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { AlexaForBusinessClient, UntagResourceCommand } from "@aws-sdk/client-alexa-for-business"; // ES Modules import + * // const { AlexaForBusinessClient, UntagResourceCommand } = require("@aws-sdk/client-alexa-for-business"); // CommonJS import + * const client = new AlexaForBusinessClient(config); + * const command = new UntagResourceCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link UntagResourceCommandInput} for command's `input` shape. + * @see {@link UntagResourceCommandOutput} for command's `response` shape. + * @see {@link AlexaForBusinessClientResolvedConfig | config} for command's `input` shape. + * */ export class UntagResourceCommand extends $Command< UntagResourceCommandInput, diff --git a/clients/client-alexa-for-business/commands/UpdateAddressBookCommand.ts b/clients/client-alexa-for-business/commands/UpdateAddressBookCommand.ts index 121a5e147680..1e81dc3e418b 100644 --- a/clients/client-alexa-for-business/commands/UpdateAddressBookCommand.ts +++ b/clients/client-alexa-for-business/commands/UpdateAddressBookCommand.ts @@ -22,6 +22,20 @@ export interface UpdateAddressBookCommandOutput extends UpdateAddressBookRespons /** *

Updates address book details by the address book ARN.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { AlexaForBusinessClient, UpdateAddressBookCommand } from "@aws-sdk/client-alexa-for-business"; // ES Modules import + * // const { AlexaForBusinessClient, UpdateAddressBookCommand } = require("@aws-sdk/client-alexa-for-business"); // CommonJS import + * const client = new AlexaForBusinessClient(config); + * const command = new UpdateAddressBookCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link UpdateAddressBookCommandInput} for command's `input` shape. + * @see {@link UpdateAddressBookCommandOutput} for command's `response` shape. + * @see {@link AlexaForBusinessClientResolvedConfig | config} for command's `input` shape. + * */ export class UpdateAddressBookCommand extends $Command< UpdateAddressBookCommandInput, diff --git a/clients/client-alexa-for-business/commands/UpdateBusinessReportScheduleCommand.ts b/clients/client-alexa-for-business/commands/UpdateBusinessReportScheduleCommand.ts index d2c06a3a2c6f..fd738894572a 100644 --- a/clients/client-alexa-for-business/commands/UpdateBusinessReportScheduleCommand.ts +++ b/clients/client-alexa-for-business/commands/UpdateBusinessReportScheduleCommand.ts @@ -25,6 +25,20 @@ export interface UpdateBusinessReportScheduleCommandOutput /** *

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

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { AlexaForBusinessClient, UpdateBusinessReportScheduleCommand } from "@aws-sdk/client-alexa-for-business"; // ES Modules import + * // const { AlexaForBusinessClient, UpdateBusinessReportScheduleCommand } = require("@aws-sdk/client-alexa-for-business"); // CommonJS import + * const client = new AlexaForBusinessClient(config); + * const command = new UpdateBusinessReportScheduleCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link UpdateBusinessReportScheduleCommandInput} for command's `input` shape. + * @see {@link UpdateBusinessReportScheduleCommandOutput} for command's `response` shape. + * @see {@link AlexaForBusinessClientResolvedConfig | config} for command's `input` shape. + * */ export class UpdateBusinessReportScheduleCommand extends $Command< UpdateBusinessReportScheduleCommandInput, diff --git a/clients/client-alexa-for-business/commands/UpdateConferenceProviderCommand.ts b/clients/client-alexa-for-business/commands/UpdateConferenceProviderCommand.ts index 22093bb04bab..de54e7a1333a 100644 --- a/clients/client-alexa-for-business/commands/UpdateConferenceProviderCommand.ts +++ b/clients/client-alexa-for-business/commands/UpdateConferenceProviderCommand.ts @@ -22,6 +22,20 @@ export interface UpdateConferenceProviderCommandOutput extends UpdateConferenceP /** *

Updates an existing conference provider's settings.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { AlexaForBusinessClient, UpdateConferenceProviderCommand } from "@aws-sdk/client-alexa-for-business"; // ES Modules import + * // const { AlexaForBusinessClient, UpdateConferenceProviderCommand } = require("@aws-sdk/client-alexa-for-business"); // CommonJS import + * const client = new AlexaForBusinessClient(config); + * const command = new UpdateConferenceProviderCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link UpdateConferenceProviderCommandInput} for command's `input` shape. + * @see {@link UpdateConferenceProviderCommandOutput} for command's `response` shape. + * @see {@link AlexaForBusinessClientResolvedConfig | config} for command's `input` shape. + * */ export class UpdateConferenceProviderCommand extends $Command< UpdateConferenceProviderCommandInput, diff --git a/clients/client-alexa-for-business/commands/UpdateContactCommand.ts b/clients/client-alexa-for-business/commands/UpdateContactCommand.ts index ed1fc2e4963c..e042b4368f9a 100644 --- a/clients/client-alexa-for-business/commands/UpdateContactCommand.ts +++ b/clients/client-alexa-for-business/commands/UpdateContactCommand.ts @@ -22,6 +22,20 @@ export interface UpdateContactCommandOutput extends UpdateContactResponse, __Met /** *

Updates the contact details by the contact ARN.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { AlexaForBusinessClient, UpdateContactCommand } from "@aws-sdk/client-alexa-for-business"; // ES Modules import + * // const { AlexaForBusinessClient, UpdateContactCommand } = require("@aws-sdk/client-alexa-for-business"); // CommonJS import + * const client = new AlexaForBusinessClient(config); + * const command = new UpdateContactCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link UpdateContactCommandInput} for command's `input` shape. + * @see {@link UpdateContactCommandOutput} for command's `response` shape. + * @see {@link AlexaForBusinessClientResolvedConfig | config} for command's `input` shape. + * */ export class UpdateContactCommand extends $Command< UpdateContactCommandInput, diff --git a/clients/client-alexa-for-business/commands/UpdateDeviceCommand.ts b/clients/client-alexa-for-business/commands/UpdateDeviceCommand.ts index b0373a858600..75c4825b4e45 100644 --- a/clients/client-alexa-for-business/commands/UpdateDeviceCommand.ts +++ b/clients/client-alexa-for-business/commands/UpdateDeviceCommand.ts @@ -22,6 +22,20 @@ export interface UpdateDeviceCommandOutput extends UpdateDeviceResponse, __Metad /** *

Updates the device name by device ARN.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { AlexaForBusinessClient, UpdateDeviceCommand } from "@aws-sdk/client-alexa-for-business"; // ES Modules import + * // const { AlexaForBusinessClient, UpdateDeviceCommand } = require("@aws-sdk/client-alexa-for-business"); // CommonJS import + * const client = new AlexaForBusinessClient(config); + * const command = new UpdateDeviceCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link UpdateDeviceCommandInput} for command's `input` shape. + * @see {@link UpdateDeviceCommandOutput} for command's `response` shape. + * @see {@link AlexaForBusinessClientResolvedConfig | config} for command's `input` shape. + * */ export class UpdateDeviceCommand extends $Command< UpdateDeviceCommandInput, diff --git a/clients/client-alexa-for-business/commands/UpdateGatewayCommand.ts b/clients/client-alexa-for-business/commands/UpdateGatewayCommand.ts index 96c095dd5013..e0024e2bbdce 100644 --- a/clients/client-alexa-for-business/commands/UpdateGatewayCommand.ts +++ b/clients/client-alexa-for-business/commands/UpdateGatewayCommand.ts @@ -23,6 +23,20 @@ export interface UpdateGatewayCommandOutput extends UpdateGatewayResponse, __Met /** *

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

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { AlexaForBusinessClient, UpdateGatewayCommand } from "@aws-sdk/client-alexa-for-business"; // ES Modules import + * // const { AlexaForBusinessClient, UpdateGatewayCommand } = require("@aws-sdk/client-alexa-for-business"); // CommonJS import + * const client = new AlexaForBusinessClient(config); + * const command = new UpdateGatewayCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link UpdateGatewayCommandInput} for command's `input` shape. + * @see {@link UpdateGatewayCommandOutput} for command's `response` shape. + * @see {@link AlexaForBusinessClientResolvedConfig | config} for command's `input` shape. + * */ export class UpdateGatewayCommand extends $Command< UpdateGatewayCommandInput, diff --git a/clients/client-alexa-for-business/commands/UpdateGatewayGroupCommand.ts b/clients/client-alexa-for-business/commands/UpdateGatewayGroupCommand.ts index c1cce69ce0ef..260b28dc4bba 100644 --- a/clients/client-alexa-for-business/commands/UpdateGatewayGroupCommand.ts +++ b/clients/client-alexa-for-business/commands/UpdateGatewayGroupCommand.ts @@ -23,6 +23,20 @@ export interface UpdateGatewayGroupCommandOutput extends UpdateGatewayGroupRespo /** *

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

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { AlexaForBusinessClient, UpdateGatewayGroupCommand } from "@aws-sdk/client-alexa-for-business"; // ES Modules import + * // const { AlexaForBusinessClient, UpdateGatewayGroupCommand } = require("@aws-sdk/client-alexa-for-business"); // CommonJS import + * const client = new AlexaForBusinessClient(config); + * const command = new UpdateGatewayGroupCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link UpdateGatewayGroupCommandInput} for command's `input` shape. + * @see {@link UpdateGatewayGroupCommandOutput} for command's `response` shape. + * @see {@link AlexaForBusinessClientResolvedConfig | config} for command's `input` shape. + * */ export class UpdateGatewayGroupCommand extends $Command< UpdateGatewayGroupCommandInput, diff --git a/clients/client-alexa-for-business/commands/UpdateNetworkProfileCommand.ts b/clients/client-alexa-for-business/commands/UpdateNetworkProfileCommand.ts index aedb63810b09..d5394d072c13 100644 --- a/clients/client-alexa-for-business/commands/UpdateNetworkProfileCommand.ts +++ b/clients/client-alexa-for-business/commands/UpdateNetworkProfileCommand.ts @@ -22,6 +22,20 @@ export interface UpdateNetworkProfileCommandOutput extends UpdateNetworkProfileR /** *

Updates a network profile by the network profile ARN.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { AlexaForBusinessClient, UpdateNetworkProfileCommand } from "@aws-sdk/client-alexa-for-business"; // ES Modules import + * // const { AlexaForBusinessClient, UpdateNetworkProfileCommand } = require("@aws-sdk/client-alexa-for-business"); // CommonJS import + * const client = new AlexaForBusinessClient(config); + * const command = new UpdateNetworkProfileCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link UpdateNetworkProfileCommandInput} for command's `input` shape. + * @see {@link UpdateNetworkProfileCommandOutput} for command's `response` shape. + * @see {@link AlexaForBusinessClientResolvedConfig | config} for command's `input` shape. + * */ export class UpdateNetworkProfileCommand extends $Command< UpdateNetworkProfileCommandInput, diff --git a/clients/client-alexa-for-business/commands/UpdateProfileCommand.ts b/clients/client-alexa-for-business/commands/UpdateProfileCommand.ts index df43ebce443a..b047f424b41f 100644 --- a/clients/client-alexa-for-business/commands/UpdateProfileCommand.ts +++ b/clients/client-alexa-for-business/commands/UpdateProfileCommand.ts @@ -22,6 +22,20 @@ export interface UpdateProfileCommandOutput extends UpdateProfileResponse, __Met /** *

Updates an existing room profile by room profile ARN.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { AlexaForBusinessClient, UpdateProfileCommand } from "@aws-sdk/client-alexa-for-business"; // ES Modules import + * // const { AlexaForBusinessClient, UpdateProfileCommand } = require("@aws-sdk/client-alexa-for-business"); // CommonJS import + * const client = new AlexaForBusinessClient(config); + * const command = new UpdateProfileCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link UpdateProfileCommandInput} for command's `input` shape. + * @see {@link UpdateProfileCommandOutput} for command's `response` shape. + * @see {@link AlexaForBusinessClientResolvedConfig | config} for command's `input` shape. + * */ export class UpdateProfileCommand extends $Command< UpdateProfileCommandInput, diff --git a/clients/client-alexa-for-business/commands/UpdateRoomCommand.ts b/clients/client-alexa-for-business/commands/UpdateRoomCommand.ts index b31f615d5467..a33311218069 100644 --- a/clients/client-alexa-for-business/commands/UpdateRoomCommand.ts +++ b/clients/client-alexa-for-business/commands/UpdateRoomCommand.ts @@ -22,6 +22,20 @@ export interface UpdateRoomCommandOutput extends UpdateRoomResponse, __MetadataB /** *

Updates room details by room ARN.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { AlexaForBusinessClient, UpdateRoomCommand } from "@aws-sdk/client-alexa-for-business"; // ES Modules import + * // const { AlexaForBusinessClient, UpdateRoomCommand } = require("@aws-sdk/client-alexa-for-business"); // CommonJS import + * const client = new AlexaForBusinessClient(config); + * const command = new UpdateRoomCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link UpdateRoomCommandInput} for command's `input` shape. + * @see {@link UpdateRoomCommandOutput} for command's `response` shape. + * @see {@link AlexaForBusinessClientResolvedConfig | config} for command's `input` shape. + * */ export class UpdateRoomCommand extends $Command< UpdateRoomCommandInput, diff --git a/clients/client-alexa-for-business/commands/UpdateSkillGroupCommand.ts b/clients/client-alexa-for-business/commands/UpdateSkillGroupCommand.ts index 324d38b72bbb..04c211206e74 100644 --- a/clients/client-alexa-for-business/commands/UpdateSkillGroupCommand.ts +++ b/clients/client-alexa-for-business/commands/UpdateSkillGroupCommand.ts @@ -22,6 +22,20 @@ export interface UpdateSkillGroupCommandOutput extends UpdateSkillGroupResponse, /** *

Updates skill group details by skill group ARN.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { AlexaForBusinessClient, UpdateSkillGroupCommand } from "@aws-sdk/client-alexa-for-business"; // ES Modules import + * // const { AlexaForBusinessClient, UpdateSkillGroupCommand } = require("@aws-sdk/client-alexa-for-business"); // CommonJS import + * const client = new AlexaForBusinessClient(config); + * const command = new UpdateSkillGroupCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link UpdateSkillGroupCommandInput} for command's `input` shape. + * @see {@link UpdateSkillGroupCommandOutput} for command's `response` shape. + * @see {@link AlexaForBusinessClientResolvedConfig | config} for command's `input` shape. + * */ export class UpdateSkillGroupCommand extends $Command< UpdateSkillGroupCommandInput, diff --git a/clients/client-alexa-for-business/models/models_0.ts b/clients/client-alexa-for-business/models/models_0.ts index f92512f17239..bc130c3e8ca2 100644 --- a/clients/client-alexa-for-business/models/models_0.ts +++ b/clients/client-alexa-for-business/models/models_0.ts @@ -22,6 +22,9 @@ export interface AddressBook { } export namespace AddressBook { + /** + * @internal + */ export const filterSensitiveLog = (obj: AddressBook): any => ({ ...obj, }); @@ -48,6 +51,9 @@ export interface AddressBookData { } export namespace AddressBookData { + /** + * @internal + */ export const filterSensitiveLog = (obj: AddressBookData): any => ({ ...obj, }); @@ -61,6 +67,9 @@ export interface ApproveSkillRequest { } export namespace ApproveSkillRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ApproveSkillRequest): any => ({ ...obj, }); @@ -69,6 +78,9 @@ export namespace ApproveSkillRequest { export interface ApproveSkillResponse {} export namespace ApproveSkillResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ApproveSkillResponse): any => ({ ...obj, }); @@ -84,6 +96,9 @@ export interface ConcurrentModificationException extends __SmithyException, $Met } export namespace ConcurrentModificationException { + /** + * @internal + */ export const filterSensitiveLog = (obj: ConcurrentModificationException): any => ({ ...obj, }); @@ -99,6 +114,9 @@ export interface LimitExceededException extends __SmithyException, $MetadataBear } export namespace LimitExceededException { + /** + * @internal + */ export const filterSensitiveLog = (obj: LimitExceededException): any => ({ ...obj, }); @@ -114,6 +132,9 @@ export interface NotFoundException extends __SmithyException, $MetadataBearer { } export namespace NotFoundException { + /** + * @internal + */ export const filterSensitiveLog = (obj: NotFoundException): any => ({ ...obj, }); @@ -132,6 +153,9 @@ export interface AssociateContactWithAddressBookRequest { } export namespace AssociateContactWithAddressBookRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: AssociateContactWithAddressBookRequest): any => ({ ...obj, }); @@ -140,6 +164,9 @@ export namespace AssociateContactWithAddressBookRequest { export interface AssociateContactWithAddressBookResponse {} export namespace AssociateContactWithAddressBookResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: AssociateContactWithAddressBookResponse): any => ({ ...obj, }); @@ -158,6 +185,9 @@ export interface AssociateDeviceWithNetworkProfileRequest { } export namespace AssociateDeviceWithNetworkProfileRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: AssociateDeviceWithNetworkProfileRequest): any => ({ ...obj, }); @@ -166,6 +196,9 @@ export namespace AssociateDeviceWithNetworkProfileRequest { export interface AssociateDeviceWithNetworkProfileResponse {} export namespace AssociateDeviceWithNetworkProfileResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: AssociateDeviceWithNetworkProfileResponse): any => ({ ...obj, }); @@ -181,6 +214,9 @@ export interface DeviceNotRegisteredException extends __SmithyException, $Metada } export namespace DeviceNotRegisteredException { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeviceNotRegisteredException): any => ({ ...obj, }); @@ -199,6 +235,9 @@ export interface AssociateDeviceWithRoomRequest { } export namespace AssociateDeviceWithRoomRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: AssociateDeviceWithRoomRequest): any => ({ ...obj, }); @@ -207,6 +246,9 @@ export namespace AssociateDeviceWithRoomRequest { export interface AssociateDeviceWithRoomResponse {} export namespace AssociateDeviceWithRoomResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: AssociateDeviceWithRoomResponse): any => ({ ...obj, }); @@ -225,6 +267,9 @@ export interface AssociateSkillGroupWithRoomRequest { } export namespace AssociateSkillGroupWithRoomRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: AssociateSkillGroupWithRoomRequest): any => ({ ...obj, }); @@ -233,6 +278,9 @@ export namespace AssociateSkillGroupWithRoomRequest { export interface AssociateSkillGroupWithRoomResponse {} export namespace AssociateSkillGroupWithRoomResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: AssociateSkillGroupWithRoomResponse): any => ({ ...obj, }); @@ -251,6 +299,9 @@ export interface AssociateSkillWithSkillGroupRequest { } export namespace AssociateSkillWithSkillGroupRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: AssociateSkillWithSkillGroupRequest): any => ({ ...obj, }); @@ -259,6 +310,9 @@ export namespace AssociateSkillWithSkillGroupRequest { export interface AssociateSkillWithSkillGroupResponse {} export namespace AssociateSkillWithSkillGroupResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: AssociateSkillWithSkillGroupResponse): any => ({ ...obj, }); @@ -274,6 +328,9 @@ export interface SkillNotLinkedException extends __SmithyException, $MetadataBea } export namespace SkillNotLinkedException { + /** + * @internal + */ export const filterSensitiveLog = (obj: SkillNotLinkedException): any => ({ ...obj, }); @@ -287,6 +344,9 @@ export interface AssociateSkillWithUsersRequest { } export namespace AssociateSkillWithUsersRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: AssociateSkillWithUsersRequest): any => ({ ...obj, }); @@ -295,6 +355,9 @@ export namespace AssociateSkillWithUsersRequest { export interface AssociateSkillWithUsersResponse {} export namespace AssociateSkillWithUsersResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: AssociateSkillWithUsersResponse): any => ({ ...obj, }); @@ -310,6 +373,9 @@ export interface AlreadyExistsException extends __SmithyException, $MetadataBear } export namespace AlreadyExistsException { + /** + * @internal + */ export const filterSensitiveLog = (obj: AlreadyExistsException): any => ({ ...obj, }); @@ -331,6 +397,9 @@ export interface Tag { } export namespace Tag { + /** + * @internal + */ export const filterSensitiveLog = (obj: Tag): any => ({ ...obj, }); @@ -360,6 +429,9 @@ export interface CreateAddressBookRequest { } export namespace CreateAddressBookRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateAddressBookRequest): any => ({ ...obj, }); @@ -373,6 +445,9 @@ export interface CreateAddressBookResponse { } export namespace CreateAddressBookResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateAddressBookResponse): any => ({ ...obj, }); @@ -395,6 +470,9 @@ export interface BusinessReportContentRange { } export namespace BusinessReportContentRange { + /** + * @internal + */ export const filterSensitiveLog = (obj: BusinessReportContentRange): any => ({ ...obj, }); @@ -416,6 +494,9 @@ export interface BusinessReportRecurrence { } export namespace BusinessReportRecurrence { + /** + * @internal + */ export const filterSensitiveLog = (obj: BusinessReportRecurrence): any => ({ ...obj, }); @@ -467,6 +548,9 @@ export interface CreateBusinessReportScheduleRequest { } export namespace CreateBusinessReportScheduleRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateBusinessReportScheduleRequest): any => ({ ...obj, }); @@ -480,6 +564,9 @@ export interface CreateBusinessReportScheduleResponse { } export namespace CreateBusinessReportScheduleResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateBusinessReportScheduleResponse): any => ({ ...obj, }); @@ -520,6 +607,9 @@ export interface IPDialIn { } export namespace IPDialIn { + /** + * @internal + */ export const filterSensitiveLog = (obj: IPDialIn): any => ({ ...obj, }); @@ -555,6 +645,9 @@ export interface MeetingSetting { } export namespace MeetingSetting { + /** + * @internal + */ export const filterSensitiveLog = (obj: MeetingSetting): any => ({ ...obj, }); @@ -586,6 +679,9 @@ export interface PSTNDialIn { } export namespace PSTNDialIn { + /** + * @internal + */ export const filterSensitiveLog = (obj: PSTNDialIn): any => ({ ...obj, }); @@ -629,6 +725,9 @@ export interface CreateConferenceProviderRequest { } export namespace CreateConferenceProviderRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateConferenceProviderRequest): any => ({ ...obj, }); @@ -642,6 +741,9 @@ export interface CreateConferenceProviderResponse { } export namespace CreateConferenceProviderResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateConferenceProviderResponse): any => ({ ...obj, }); @@ -669,6 +771,9 @@ export interface PhoneNumber { } export namespace PhoneNumber { + /** + * @internal + */ export const filterSensitiveLog = (obj: PhoneNumber): any => ({ ...obj, ...(obj.Number && { Number: SENSITIVE_STRING }), @@ -696,6 +801,9 @@ export interface SipAddress { } export namespace SipAddress { + /** + * @internal + */ export const filterSensitiveLog = (obj: SipAddress): any => ({ ...obj, ...(obj.Uri && { Uri: SENSITIVE_STRING }), @@ -751,6 +859,9 @@ export interface CreateContactRequest { } export namespace CreateContactRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateContactRequest): any => ({ ...obj, ...(obj.PhoneNumber && { PhoneNumber: SENSITIVE_STRING }), @@ -767,6 +878,9 @@ export interface CreateContactResponse { } export namespace CreateContactResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateContactResponse): any => ({ ...obj, }); @@ -795,6 +909,9 @@ export interface CreateGatewayGroupRequest { } export namespace CreateGatewayGroupRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateGatewayGroupRequest): any => ({ ...obj, }); @@ -808,6 +925,9 @@ export interface CreateGatewayGroupResponse { } export namespace CreateGatewayGroupResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateGatewayGroupResponse): any => ({ ...obj, }); @@ -889,6 +1009,9 @@ export interface CreateNetworkProfileRequest { } export namespace CreateNetworkProfileRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateNetworkProfileRequest): any => ({ ...obj, ...(obj.CurrentPassword && { CurrentPassword: SENSITIVE_STRING }), @@ -904,6 +1027,9 @@ export interface CreateNetworkProfileResponse { } export namespace CreateNetworkProfileResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateNetworkProfileResponse): any => ({ ...obj, }); @@ -919,6 +1045,9 @@ export interface InvalidCertificateAuthorityException extends __SmithyException, } export namespace InvalidCertificateAuthorityException { + /** + * @internal + */ export const filterSensitiveLog = (obj: InvalidCertificateAuthorityException): any => ({ ...obj, }); @@ -934,6 +1063,9 @@ export interface InvalidServiceLinkedRoleStateException extends __SmithyExceptio } export namespace InvalidServiceLinkedRoleStateException { + /** + * @internal + */ export const filterSensitiveLog = (obj: InvalidServiceLinkedRoleStateException): any => ({ ...obj, }); @@ -974,6 +1106,9 @@ export interface CreateEndOfMeetingReminder { } export namespace CreateEndOfMeetingReminder { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateEndOfMeetingReminder): any => ({ ...obj, }); @@ -998,6 +1133,9 @@ export interface CreateInstantBooking { } export namespace CreateInstantBooking { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateInstantBooking): any => ({ ...obj, }); @@ -1019,6 +1157,9 @@ export interface CreateRequireCheckIn { } export namespace CreateRequireCheckIn { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateRequireCheckIn): any => ({ ...obj, }); @@ -1052,6 +1193,9 @@ export interface CreateMeetingRoomConfiguration { } export namespace CreateMeetingRoomConfiguration { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateMeetingRoomConfiguration): any => ({ ...obj, }); @@ -1142,6 +1286,9 @@ export interface CreateProfileRequest { } export namespace CreateProfileRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateProfileRequest): any => ({ ...obj, }); @@ -1155,6 +1302,9 @@ export interface CreateProfileResponse { } export namespace CreateProfileResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateProfileResponse): any => ({ ...obj, }); @@ -1194,6 +1344,9 @@ export interface CreateRoomRequest { } export namespace CreateRoomRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateRoomRequest): any => ({ ...obj, }); @@ -1207,6 +1360,9 @@ export interface CreateRoomResponse { } export namespace CreateRoomResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateRoomResponse): any => ({ ...obj, }); @@ -1236,6 +1392,9 @@ export interface CreateSkillGroupRequest { } export namespace CreateSkillGroupRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateSkillGroupRequest): any => ({ ...obj, }); @@ -1249,6 +1408,9 @@ export interface CreateSkillGroupResponse { } export namespace CreateSkillGroupResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateSkillGroupResponse): any => ({ ...obj, }); @@ -1288,6 +1450,9 @@ export interface CreateUserRequest { } export namespace CreateUserRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateUserRequest): any => ({ ...obj, }); @@ -1301,6 +1466,9 @@ export interface CreateUserResponse { } export namespace CreateUserResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateUserResponse): any => ({ ...obj, }); @@ -1320,6 +1488,9 @@ export interface ResourceInUseException extends __SmithyException, $MetadataBear } export namespace ResourceInUseException { + /** + * @internal + */ export const filterSensitiveLog = (obj: ResourceInUseException): any => ({ ...obj, }); @@ -1333,6 +1504,9 @@ export interface DeleteAddressBookRequest { } export namespace DeleteAddressBookRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteAddressBookRequest): any => ({ ...obj, }); @@ -1341,6 +1515,9 @@ export namespace DeleteAddressBookRequest { export interface DeleteAddressBookResponse {} export namespace DeleteAddressBookResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteAddressBookResponse): any => ({ ...obj, }); @@ -1354,6 +1531,9 @@ export interface DeleteBusinessReportScheduleRequest { } export namespace DeleteBusinessReportScheduleRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteBusinessReportScheduleRequest): any => ({ ...obj, }); @@ -1362,6 +1542,9 @@ export namespace DeleteBusinessReportScheduleRequest { export interface DeleteBusinessReportScheduleResponse {} export namespace DeleteBusinessReportScheduleResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteBusinessReportScheduleResponse): any => ({ ...obj, }); @@ -1375,6 +1558,9 @@ export interface DeleteConferenceProviderRequest { } export namespace DeleteConferenceProviderRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteConferenceProviderRequest): any => ({ ...obj, }); @@ -1383,6 +1569,9 @@ export namespace DeleteConferenceProviderRequest { export interface DeleteConferenceProviderResponse {} export namespace DeleteConferenceProviderResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteConferenceProviderResponse): any => ({ ...obj, }); @@ -1396,6 +1585,9 @@ export interface DeleteContactRequest { } export namespace DeleteContactRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteContactRequest): any => ({ ...obj, }); @@ -1404,6 +1596,9 @@ export namespace DeleteContactRequest { export interface DeleteContactResponse {} export namespace DeleteContactResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteContactResponse): any => ({ ...obj, }); @@ -1417,6 +1612,9 @@ export interface DeleteDeviceRequest { } export namespace DeleteDeviceRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteDeviceRequest): any => ({ ...obj, }); @@ -1425,6 +1623,9 @@ export namespace DeleteDeviceRequest { export interface DeleteDeviceResponse {} export namespace DeleteDeviceResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteDeviceResponse): any => ({ ...obj, }); @@ -1447,6 +1648,9 @@ export interface DeleteDeviceUsageDataRequest { } export namespace DeleteDeviceUsageDataRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteDeviceUsageDataRequest): any => ({ ...obj, }); @@ -1455,6 +1659,9 @@ export namespace DeleteDeviceUsageDataRequest { export interface DeleteDeviceUsageDataResponse {} export namespace DeleteDeviceUsageDataResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteDeviceUsageDataResponse): any => ({ ...obj, }); @@ -1468,6 +1675,9 @@ export interface DeleteGatewayGroupRequest { } export namespace DeleteGatewayGroupRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteGatewayGroupRequest): any => ({ ...obj, }); @@ -1476,6 +1686,9 @@ export namespace DeleteGatewayGroupRequest { export interface DeleteGatewayGroupResponse {} export namespace DeleteGatewayGroupResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteGatewayGroupResponse): any => ({ ...obj, }); @@ -1491,6 +1704,9 @@ export interface ResourceAssociatedException extends __SmithyException, $Metadat } export namespace ResourceAssociatedException { + /** + * @internal + */ export const filterSensitiveLog = (obj: ResourceAssociatedException): any => ({ ...obj, }); @@ -1504,6 +1720,9 @@ export interface DeleteNetworkProfileRequest { } export namespace DeleteNetworkProfileRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteNetworkProfileRequest): any => ({ ...obj, }); @@ -1512,6 +1731,9 @@ export namespace DeleteNetworkProfileRequest { export interface DeleteNetworkProfileResponse {} export namespace DeleteNetworkProfileResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteNetworkProfileResponse): any => ({ ...obj, }); @@ -1525,6 +1747,9 @@ export interface DeleteProfileRequest { } export namespace DeleteProfileRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteProfileRequest): any => ({ ...obj, }); @@ -1533,6 +1758,9 @@ export namespace DeleteProfileRequest { export interface DeleteProfileResponse {} export namespace DeleteProfileResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteProfileResponse): any => ({ ...obj, }); @@ -1546,6 +1774,9 @@ export interface DeleteRoomRequest { } export namespace DeleteRoomRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteRoomRequest): any => ({ ...obj, }); @@ -1554,6 +1785,9 @@ export namespace DeleteRoomRequest { export interface DeleteRoomResponse {} export namespace DeleteRoomResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteRoomResponse): any => ({ ...obj, }); @@ -1577,6 +1811,9 @@ export interface DeleteRoomSkillParameterRequest { } export namespace DeleteRoomSkillParameterRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteRoomSkillParameterRequest): any => ({ ...obj, }); @@ -1585,6 +1822,9 @@ export namespace DeleteRoomSkillParameterRequest { export interface DeleteRoomSkillParameterResponse {} export namespace DeleteRoomSkillParameterResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteRoomSkillParameterResponse): any => ({ ...obj, }); @@ -1603,6 +1843,9 @@ export interface DeleteSkillAuthorizationRequest { } export namespace DeleteSkillAuthorizationRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteSkillAuthorizationRequest): any => ({ ...obj, }); @@ -1611,6 +1854,9 @@ export namespace DeleteSkillAuthorizationRequest { export interface DeleteSkillAuthorizationResponse {} export namespace DeleteSkillAuthorizationResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteSkillAuthorizationResponse): any => ({ ...obj, }); @@ -1624,6 +1870,9 @@ export interface DeleteSkillGroupRequest { } export namespace DeleteSkillGroupRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteSkillGroupRequest): any => ({ ...obj, }); @@ -1632,6 +1881,9 @@ export namespace DeleteSkillGroupRequest { export interface DeleteSkillGroupResponse {} export namespace DeleteSkillGroupResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteSkillGroupResponse): any => ({ ...obj, }); @@ -1650,6 +1902,9 @@ export interface DeleteUserRequest { } export namespace DeleteUserRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteUserRequest): any => ({ ...obj, }); @@ -1658,6 +1913,9 @@ export namespace DeleteUserRequest { export interface DeleteUserResponse {} export namespace DeleteUserResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteUserResponse): any => ({ ...obj, }); @@ -1676,6 +1934,9 @@ export interface DisassociateContactFromAddressBookRequest { } export namespace DisassociateContactFromAddressBookRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DisassociateContactFromAddressBookRequest): any => ({ ...obj, }); @@ -1684,6 +1945,9 @@ export namespace DisassociateContactFromAddressBookRequest { export interface DisassociateContactFromAddressBookResponse {} export namespace DisassociateContactFromAddressBookResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DisassociateContactFromAddressBookResponse): any => ({ ...obj, }); @@ -1697,6 +1961,9 @@ export interface DisassociateDeviceFromRoomRequest { } export namespace DisassociateDeviceFromRoomRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DisassociateDeviceFromRoomRequest): any => ({ ...obj, }); @@ -1705,6 +1972,9 @@ export namespace DisassociateDeviceFromRoomRequest { export interface DisassociateDeviceFromRoomResponse {} export namespace DisassociateDeviceFromRoomResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DisassociateDeviceFromRoomResponse): any => ({ ...obj, }); @@ -1723,6 +1993,9 @@ export interface DisassociateSkillFromSkillGroupRequest { } export namespace DisassociateSkillFromSkillGroupRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DisassociateSkillFromSkillGroupRequest): any => ({ ...obj, }); @@ -1731,6 +2004,9 @@ export namespace DisassociateSkillFromSkillGroupRequest { export interface DisassociateSkillFromSkillGroupResponse {} export namespace DisassociateSkillFromSkillGroupResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DisassociateSkillFromSkillGroupResponse): any => ({ ...obj, }); @@ -1744,6 +2020,9 @@ export interface DisassociateSkillFromUsersRequest { } export namespace DisassociateSkillFromUsersRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DisassociateSkillFromUsersRequest): any => ({ ...obj, }); @@ -1752,6 +2031,9 @@ export namespace DisassociateSkillFromUsersRequest { export interface DisassociateSkillFromUsersResponse {} export namespace DisassociateSkillFromUsersResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DisassociateSkillFromUsersResponse): any => ({ ...obj, }); @@ -1771,6 +2053,9 @@ export interface DisassociateSkillGroupFromRoomRequest { } export namespace DisassociateSkillGroupFromRoomRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DisassociateSkillGroupFromRoomRequest): any => ({ ...obj, }); @@ -1779,6 +2064,9 @@ export namespace DisassociateSkillGroupFromRoomRequest { export interface DisassociateSkillGroupFromRoomResponse {} export namespace DisassociateSkillGroupFromRoomResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DisassociateSkillGroupFromRoomResponse): any => ({ ...obj, }); @@ -1792,6 +2080,9 @@ export interface ForgetSmartHomeAppliancesRequest { } export namespace ForgetSmartHomeAppliancesRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ForgetSmartHomeAppliancesRequest): any => ({ ...obj, }); @@ -1800,6 +2091,9 @@ export namespace ForgetSmartHomeAppliancesRequest { export interface ForgetSmartHomeAppliancesResponse {} export namespace ForgetSmartHomeAppliancesResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ForgetSmartHomeAppliancesResponse): any => ({ ...obj, }); @@ -1813,6 +2107,9 @@ export interface GetAddressBookRequest { } export namespace GetAddressBookRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetAddressBookRequest): any => ({ ...obj, }); @@ -1826,6 +2123,9 @@ export interface GetAddressBookResponse { } export namespace GetAddressBookResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetAddressBookResponse): any => ({ ...obj, }); @@ -1834,6 +2134,9 @@ export namespace GetAddressBookResponse { export interface GetConferencePreferenceRequest {} export namespace GetConferencePreferenceRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetConferencePreferenceRequest): any => ({ ...obj, }); @@ -1851,6 +2154,9 @@ export interface ConferencePreference { } export namespace ConferencePreference { + /** + * @internal + */ export const filterSensitiveLog = (obj: ConferencePreference): any => ({ ...obj, }); @@ -1864,6 +2170,9 @@ export interface GetConferencePreferenceResponse { } export namespace GetConferencePreferenceResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetConferencePreferenceResponse): any => ({ ...obj, }); @@ -1877,6 +2186,9 @@ export interface GetConferenceProviderRequest { } export namespace GetConferenceProviderRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetConferenceProviderRequest): any => ({ ...obj, }); @@ -1918,6 +2230,9 @@ export interface ConferenceProvider { } export namespace ConferenceProvider { + /** + * @internal + */ export const filterSensitiveLog = (obj: ConferenceProvider): any => ({ ...obj, }); @@ -1931,6 +2246,9 @@ export interface GetConferenceProviderResponse { } export namespace GetConferenceProviderResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetConferenceProviderResponse): any => ({ ...obj, }); @@ -1944,6 +2262,9 @@ export interface GetContactRequest { } export namespace GetContactRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetContactRequest): any => ({ ...obj, }); @@ -1992,6 +2313,9 @@ export interface Contact { } export namespace Contact { + /** + * @internal + */ export const filterSensitiveLog = (obj: Contact): any => ({ ...obj, ...(obj.PhoneNumber && { PhoneNumber: SENSITIVE_STRING }), @@ -2008,6 +2332,9 @@ export interface GetContactResponse { } export namespace GetContactResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetContactResponse): any => ({ ...obj, ...(obj.Contact && { Contact: Contact.filterSensitiveLog(obj.Contact) }), @@ -2022,6 +2349,9 @@ export interface GetDeviceRequest { } export namespace GetDeviceRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetDeviceRequest): any => ({ ...obj, }); @@ -2087,6 +2417,9 @@ export interface DeviceStatusDetail { } export namespace DeviceStatusDetail { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeviceStatusDetail): any => ({ ...obj, }); @@ -2113,6 +2446,9 @@ export interface DeviceStatusInfo { } export namespace DeviceStatusInfo { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeviceStatusInfo): any => ({ ...obj, }); @@ -2139,6 +2475,9 @@ export interface DeviceNetworkProfileInfo { } export namespace DeviceNetworkProfileInfo { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeviceNetworkProfileInfo): any => ({ ...obj, }); @@ -2201,6 +2540,9 @@ export interface Device { } export namespace Device { + /** + * @internal + */ export const filterSensitiveLog = (obj: Device): any => ({ ...obj, }); @@ -2214,6 +2556,9 @@ export interface GetDeviceResponse { } export namespace GetDeviceResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetDeviceResponse): any => ({ ...obj, }); @@ -2227,6 +2572,9 @@ export interface GetGatewayRequest { } export namespace GetGatewayRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetGatewayRequest): any => ({ ...obj, }); @@ -2264,6 +2612,9 @@ export interface Gateway { } export namespace Gateway { + /** + * @internal + */ export const filterSensitiveLog = (obj: Gateway): any => ({ ...obj, }); @@ -2277,6 +2628,9 @@ export interface GetGatewayResponse { } export namespace GetGatewayResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetGatewayResponse): any => ({ ...obj, }); @@ -2290,6 +2644,9 @@ export interface GetGatewayGroupRequest { } export namespace GetGatewayGroupRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetGatewayGroupRequest): any => ({ ...obj, }); @@ -2316,6 +2673,9 @@ export interface GatewayGroup { } export namespace GatewayGroup { + /** + * @internal + */ export const filterSensitiveLog = (obj: GatewayGroup): any => ({ ...obj, }); @@ -2329,6 +2689,9 @@ export interface GetGatewayGroupResponse { } export namespace GetGatewayGroupResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetGatewayGroupResponse): any => ({ ...obj, }); @@ -2337,6 +2700,9 @@ export namespace GetGatewayGroupResponse { export interface GetInvitationConfigurationRequest {} export namespace GetInvitationConfigurationRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetInvitationConfigurationRequest): any => ({ ...obj, }); @@ -2362,6 +2728,9 @@ export interface GetInvitationConfigurationResponse { } export namespace GetInvitationConfigurationResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetInvitationConfigurationResponse): any => ({ ...obj, }); @@ -2375,6 +2744,9 @@ export interface GetNetworkProfileRequest { } export namespace GetNetworkProfileRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetNetworkProfileRequest): any => ({ ...obj, }); @@ -2442,6 +2814,9 @@ export interface NetworkProfile { } export namespace NetworkProfile { + /** + * @internal + */ export const filterSensitiveLog = (obj: NetworkProfile): any => ({ ...obj, ...(obj.CurrentPassword && { CurrentPassword: SENSITIVE_STRING }), @@ -2457,6 +2832,9 @@ export interface GetNetworkProfileResponse { } export namespace GetNetworkProfileResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetNetworkProfileResponse): any => ({ ...obj, ...(obj.NetworkProfile && { NetworkProfile: NetworkProfile.filterSensitiveLog(obj.NetworkProfile) }), @@ -2473,6 +2851,9 @@ export interface InvalidSecretsManagerResourceException extends __SmithyExceptio } export namespace InvalidSecretsManagerResourceException { + /** + * @internal + */ export const filterSensitiveLog = (obj: InvalidSecretsManagerResourceException): any => ({ ...obj, }); @@ -2486,6 +2867,9 @@ export interface GetProfileRequest { } export namespace GetProfileRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetProfileRequest): any => ({ ...obj, }); @@ -2513,6 +2897,9 @@ export interface EndOfMeetingReminder { } export namespace EndOfMeetingReminder { + /** + * @internal + */ export const filterSensitiveLog = (obj: EndOfMeetingReminder): any => ({ ...obj, }); @@ -2537,6 +2924,9 @@ export interface InstantBooking { } export namespace InstantBooking { + /** + * @internal + */ export const filterSensitiveLog = (obj: InstantBooking): any => ({ ...obj, }); @@ -2558,6 +2948,9 @@ export interface RequireCheckIn { } export namespace RequireCheckIn { + /** + * @internal + */ export const filterSensitiveLog = (obj: RequireCheckIn): any => ({ ...obj, }); @@ -2594,6 +2987,9 @@ export interface MeetingRoomConfiguration { } export namespace MeetingRoomConfiguration { + /** + * @internal + */ export const filterSensitiveLog = (obj: MeetingRoomConfiguration): any => ({ ...obj, }); @@ -2681,6 +3077,9 @@ export interface Profile { } export namespace Profile { + /** + * @internal + */ export const filterSensitiveLog = (obj: Profile): any => ({ ...obj, }); @@ -2694,6 +3093,9 @@ export interface GetProfileResponse { } export namespace GetProfileResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetProfileResponse): any => ({ ...obj, }); @@ -2707,6 +3109,9 @@ export interface GetRoomRequest { } export namespace GetRoomRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetRoomRequest): any => ({ ...obj, }); @@ -2743,6 +3148,9 @@ export interface Room { } export namespace Room { + /** + * @internal + */ export const filterSensitiveLog = (obj: Room): any => ({ ...obj, }); @@ -2756,6 +3164,9 @@ export interface GetRoomResponse { } export namespace GetRoomResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetRoomResponse): any => ({ ...obj, }); @@ -2780,6 +3191,9 @@ export interface GetRoomSkillParameterRequest { } export namespace GetRoomSkillParameterRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetRoomSkillParameterRequest): any => ({ ...obj, }); @@ -2802,6 +3216,9 @@ export interface RoomSkillParameter { } export namespace RoomSkillParameter { + /** + * @internal + */ export const filterSensitiveLog = (obj: RoomSkillParameter): any => ({ ...obj, }); @@ -2815,6 +3232,9 @@ export interface GetRoomSkillParameterResponse { } export namespace GetRoomSkillParameterResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetRoomSkillParameterResponse): any => ({ ...obj, }); @@ -2828,6 +3248,9 @@ export interface GetSkillGroupRequest { } export namespace GetSkillGroupRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetSkillGroupRequest): any => ({ ...obj, }); @@ -2854,6 +3277,9 @@ export interface SkillGroup { } export namespace SkillGroup { + /** + * @internal + */ export const filterSensitiveLog = (obj: SkillGroup): any => ({ ...obj, }); @@ -2867,6 +3293,9 @@ export interface GetSkillGroupResponse { } export namespace GetSkillGroupResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetSkillGroupResponse): any => ({ ...obj, }); @@ -2885,6 +3314,9 @@ export interface ListBusinessReportSchedulesRequest { } export namespace ListBusinessReportSchedulesRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListBusinessReportSchedulesRequest): any => ({ ...obj, }); @@ -2912,6 +3344,9 @@ export interface BusinessReportS3Location { } export namespace BusinessReportS3Location { + /** + * @internal + */ export const filterSensitiveLog = (obj: BusinessReportS3Location): any => ({ ...obj, }); @@ -2955,6 +3390,9 @@ export interface BusinessReport { } export namespace BusinessReport { + /** + * @internal + */ export const filterSensitiveLog = (obj: BusinessReport): any => ({ ...obj, }); @@ -3008,6 +3446,9 @@ export interface BusinessReportSchedule { } export namespace BusinessReportSchedule { + /** + * @internal + */ export const filterSensitiveLog = (obj: BusinessReportSchedule): any => ({ ...obj, }); @@ -3026,6 +3467,9 @@ export interface ListBusinessReportSchedulesResponse { } export namespace ListBusinessReportSchedulesResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListBusinessReportSchedulesResponse): any => ({ ...obj, }); @@ -3045,6 +3489,9 @@ export interface ListConferenceProvidersRequest { } export namespace ListConferenceProvidersRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListConferenceProvidersRequest): any => ({ ...obj, }); @@ -3063,6 +3510,9 @@ export interface ListConferenceProvidersResponse { } export namespace ListConferenceProvidersResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListConferenceProvidersResponse): any => ({ ...obj, }); @@ -3104,6 +3554,9 @@ export interface ListDeviceEventsRequest { } export namespace ListDeviceEventsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListDeviceEventsRequest): any => ({ ...obj, }); @@ -3130,6 +3583,9 @@ export interface DeviceEvent { } export namespace DeviceEvent { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeviceEvent): any => ({ ...obj, }); @@ -3148,6 +3604,9 @@ export interface ListDeviceEventsResponse { } export namespace ListDeviceEventsResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListDeviceEventsResponse): any => ({ ...obj, }); @@ -3166,6 +3625,9 @@ export interface ListGatewayGroupsRequest { } export namespace ListGatewayGroupsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListGatewayGroupsRequest): any => ({ ...obj, }); @@ -3192,6 +3654,9 @@ export interface GatewayGroupSummary { } export namespace GatewayGroupSummary { + /** + * @internal + */ export const filterSensitiveLog = (obj: GatewayGroupSummary): any => ({ ...obj, }); @@ -3210,6 +3675,9 @@ export interface ListGatewayGroupsResponse { } export namespace ListGatewayGroupsResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListGatewayGroupsResponse): any => ({ ...obj, }); @@ -3233,6 +3701,9 @@ export interface ListGatewaysRequest { } export namespace ListGatewaysRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListGatewaysRequest): any => ({ ...obj, }); @@ -3270,6 +3741,9 @@ export interface GatewaySummary { } export namespace GatewaySummary { + /** + * @internal + */ export const filterSensitiveLog = (obj: GatewaySummary): any => ({ ...obj, }); @@ -3288,6 +3762,9 @@ export interface ListGatewaysResponse { } export namespace ListGatewaysResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListGatewaysResponse): any => ({ ...obj, }); @@ -3336,6 +3813,9 @@ export interface ListSkillsRequest { } export namespace ListSkillsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListSkillsRequest): any => ({ ...obj, }); @@ -3383,6 +3863,9 @@ export interface SkillSummary { } export namespace SkillSummary { + /** + * @internal + */ export const filterSensitiveLog = (obj: SkillSummary): any => ({ ...obj, }); @@ -3401,6 +3884,9 @@ export interface ListSkillsResponse { } export namespace ListSkillsResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListSkillsResponse): any => ({ ...obj, }); @@ -3419,6 +3905,9 @@ export interface ListSkillsStoreCategoriesRequest { } export namespace ListSkillsStoreCategoriesRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListSkillsStoreCategoriesRequest): any => ({ ...obj, }); @@ -3441,6 +3930,9 @@ export interface Category { } export namespace Category { + /** + * @internal + */ export const filterSensitiveLog = (obj: Category): any => ({ ...obj, }); @@ -3459,6 +3951,9 @@ export interface ListSkillsStoreCategoriesResponse { } export namespace ListSkillsStoreCategoriesResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListSkillsStoreCategoriesResponse): any => ({ ...obj, }); @@ -3483,6 +3978,9 @@ export interface ListSkillsStoreSkillsByCategoryRequest { } export namespace ListSkillsStoreSkillsByCategoryRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListSkillsStoreSkillsByCategoryRequest): any => ({ ...obj, }); @@ -3514,6 +4012,9 @@ export interface DeveloperInfo { } export namespace DeveloperInfo { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeveloperInfo): any => ({ ...obj, }); @@ -3579,6 +4080,9 @@ export interface SkillDetails { } export namespace SkillDetails { + /** + * @internal + */ export const filterSensitiveLog = (obj: SkillDetails): any => ({ ...obj, }); @@ -3625,6 +4129,9 @@ export interface SkillsStoreSkill { } export namespace SkillsStoreSkill { + /** + * @internal + */ export const filterSensitiveLog = (obj: SkillsStoreSkill): any => ({ ...obj, }); @@ -3643,6 +4150,9 @@ export interface ListSkillsStoreSkillsByCategoryResponse { } export namespace ListSkillsStoreSkillsByCategoryResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListSkillsStoreSkillsByCategoryResponse): any => ({ ...obj, }); @@ -3666,6 +4176,9 @@ export interface ListSmartHomeAppliancesRequest { } export namespace ListSmartHomeAppliancesRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListSmartHomeAppliancesRequest): any => ({ ...obj, }); @@ -3693,6 +4206,9 @@ export interface SmartHomeAppliance { } export namespace SmartHomeAppliance { + /** + * @internal + */ export const filterSensitiveLog = (obj: SmartHomeAppliance): any => ({ ...obj, }); @@ -3711,6 +4227,9 @@ export interface ListSmartHomeAppliancesResponse { } export namespace ListSmartHomeAppliancesResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListSmartHomeAppliancesResponse): any => ({ ...obj, }); @@ -3738,6 +4257,9 @@ export interface ListTagsRequest { } export namespace ListTagsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListTagsRequest): any => ({ ...obj, }); @@ -3756,6 +4278,9 @@ export interface ListTagsResponse { } export namespace ListTagsResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListTagsResponse): any => ({ ...obj, }); @@ -3769,6 +4294,9 @@ export interface PutConferencePreferenceRequest { } export namespace PutConferencePreferenceRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: PutConferencePreferenceRequest): any => ({ ...obj, }); @@ -3777,6 +4305,9 @@ export namespace PutConferencePreferenceRequest { export interface PutConferencePreferenceResponse {} export namespace PutConferencePreferenceResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: PutConferencePreferenceResponse): any => ({ ...obj, }); @@ -3802,6 +4333,9 @@ export interface PutInvitationConfigurationRequest { } export namespace PutInvitationConfigurationRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: PutInvitationConfigurationRequest): any => ({ ...obj, }); @@ -3810,6 +4344,9 @@ export namespace PutInvitationConfigurationRequest { export interface PutInvitationConfigurationResponse {} export namespace PutInvitationConfigurationResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: PutInvitationConfigurationResponse): any => ({ ...obj, }); @@ -3833,6 +4370,9 @@ export interface PutRoomSkillParameterRequest { } export namespace PutRoomSkillParameterRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: PutRoomSkillParameterRequest): any => ({ ...obj, }); @@ -3841,6 +4381,9 @@ export namespace PutRoomSkillParameterRequest { export interface PutRoomSkillParameterResponse {} export namespace PutRoomSkillParameterResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: PutRoomSkillParameterResponse): any => ({ ...obj, }); @@ -3865,6 +4408,9 @@ export interface PutSkillAuthorizationRequest { } export namespace PutSkillAuthorizationRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: PutSkillAuthorizationRequest): any => ({ ...obj, ...(obj.AuthorizationResult && { AuthorizationResult: SENSITIVE_STRING }), @@ -3874,6 +4420,9 @@ export namespace PutSkillAuthorizationRequest { export interface PutSkillAuthorizationResponse {} export namespace PutSkillAuthorizationResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: PutSkillAuthorizationResponse): any => ({ ...obj, }); @@ -3889,6 +4438,9 @@ export interface UnauthorizedException extends __SmithyException, $MetadataBeare } export namespace UnauthorizedException { + /** + * @internal + */ export const filterSensitiveLog = (obj: UnauthorizedException): any => ({ ...obj, }); @@ -3904,6 +4456,9 @@ export interface InvalidDeviceException extends __SmithyException, $MetadataBear } export namespace InvalidDeviceException { + /** + * @internal + */ export const filterSensitiveLog = (obj: InvalidDeviceException): any => ({ ...obj, }); @@ -3952,6 +4507,9 @@ export interface RegisterAVSDeviceRequest { } export namespace RegisterAVSDeviceRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: RegisterAVSDeviceRequest): any => ({ ...obj, }); @@ -3965,6 +4523,9 @@ export interface RegisterAVSDeviceResponse { } export namespace RegisterAVSDeviceResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: RegisterAVSDeviceResponse): any => ({ ...obj, }); @@ -3978,6 +4539,9 @@ export interface RejectSkillRequest { } export namespace RejectSkillRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: RejectSkillRequest): any => ({ ...obj, }); @@ -3986,6 +4550,9 @@ export namespace RejectSkillRequest { export interface RejectSkillResponse {} export namespace RejectSkillResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: RejectSkillResponse): any => ({ ...obj, }); @@ -4004,6 +4571,9 @@ export interface ResolveRoomRequest { } export namespace ResolveRoomRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ResolveRoomRequest): any => ({ ...obj, }); @@ -4027,6 +4597,9 @@ export interface ResolveRoomResponse { } export namespace ResolveRoomResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ResolveRoomResponse): any => ({ ...obj, }); @@ -4045,6 +4618,9 @@ export interface RevokeInvitationRequest { } export namespace RevokeInvitationRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: RevokeInvitationRequest): any => ({ ...obj, }); @@ -4053,6 +4629,9 @@ export namespace RevokeInvitationRequest { export interface RevokeInvitationResponse {} export namespace RevokeInvitationResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: RevokeInvitationResponse): any => ({ ...obj, }); @@ -4075,6 +4654,9 @@ export interface Filter { } export namespace Filter { + /** + * @internal + */ export const filterSensitiveLog = (obj: Filter): any => ({ ...obj, }); @@ -4101,6 +4683,9 @@ export interface Sort { } export namespace Sort { + /** + * @internal + */ export const filterSensitiveLog = (obj: Sort): any => ({ ...obj, }); @@ -4135,6 +4720,9 @@ export interface SearchAddressBooksRequest { } export namespace SearchAddressBooksRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: SearchAddressBooksRequest): any => ({ ...obj, }); @@ -4159,6 +4747,9 @@ export interface SearchAddressBooksResponse { } export namespace SearchAddressBooksResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: SearchAddressBooksResponse): any => ({ ...obj, }); @@ -4193,6 +4784,9 @@ export interface SearchContactsRequest { } export namespace SearchContactsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: SearchContactsRequest): any => ({ ...obj, }); @@ -4241,6 +4835,9 @@ export interface ContactData { } export namespace ContactData { + /** + * @internal + */ export const filterSensitiveLog = (obj: ContactData): any => ({ ...obj, ...(obj.PhoneNumber && { PhoneNumber: SENSITIVE_STRING }), @@ -4267,6 +4864,9 @@ export interface SearchContactsResponse { } export namespace SearchContactsResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: SearchContactsResponse): any => ({ ...obj, ...(obj.Contacts && { Contacts: obj.Contacts.map((item) => ContactData.filterSensitiveLog(item)) }), @@ -4305,6 +4905,9 @@ export interface SearchDevicesRequest { } export namespace SearchDevicesRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: SearchDevicesRequest): any => ({ ...obj, }); @@ -4381,6 +4984,9 @@ export interface DeviceData { } export namespace DeviceData { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeviceData): any => ({ ...obj, }); @@ -4404,6 +5010,9 @@ export interface SearchDevicesResponse { } export namespace SearchDevicesResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: SearchDevicesResponse): any => ({ ...obj, }); @@ -4438,6 +5047,9 @@ export interface SearchNetworkProfilesRequest { } export namespace SearchNetworkProfilesRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: SearchNetworkProfilesRequest): any => ({ ...obj, }); @@ -4487,6 +5099,9 @@ export interface NetworkProfileData { } export namespace NetworkProfileData { + /** + * @internal + */ export const filterSensitiveLog = (obj: NetworkProfileData): any => ({ ...obj, }); @@ -4513,6 +5128,9 @@ export interface SearchNetworkProfilesResponse { } export namespace SearchNetworkProfilesResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: SearchNetworkProfilesResponse): any => ({ ...obj, }); @@ -4547,6 +5165,9 @@ export interface SearchProfilesRequest { } export namespace SearchProfilesRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: SearchProfilesRequest): any => ({ ...obj, }); @@ -4604,6 +5225,9 @@ export interface ProfileData { } export namespace ProfileData { + /** + * @internal + */ export const filterSensitiveLog = (obj: ProfileData): any => ({ ...obj, }); @@ -4627,6 +5251,9 @@ export interface SearchProfilesResponse { } export namespace SearchProfilesResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: SearchProfilesResponse): any => ({ ...obj, }); @@ -4661,6 +5288,9 @@ export interface SearchRoomsRequest { } export namespace SearchRoomsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: SearchRoomsRequest): any => ({ ...obj, }); @@ -4702,6 +5332,9 @@ export interface RoomData { } export namespace RoomData { + /** + * @internal + */ export const filterSensitiveLog = (obj: RoomData): any => ({ ...obj, }); @@ -4725,6 +5358,9 @@ export interface SearchRoomsResponse { } export namespace SearchRoomsResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: SearchRoomsResponse): any => ({ ...obj, }); @@ -4760,6 +5396,9 @@ export interface SearchSkillGroupsRequest { } export namespace SearchSkillGroupsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: SearchSkillGroupsRequest): any => ({ ...obj, }); @@ -4786,6 +5425,9 @@ export interface SkillGroupData { } export namespace SkillGroupData { + /** + * @internal + */ export const filterSensitiveLog = (obj: SkillGroupData): any => ({ ...obj, }); @@ -4809,6 +5451,9 @@ export interface SearchSkillGroupsResponse { } export namespace SearchSkillGroupsResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: SearchSkillGroupsResponse): any => ({ ...obj, }); @@ -4844,6 +5489,9 @@ export interface SearchUsersRequest { } export namespace SearchUsersRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: SearchUsersRequest): any => ({ ...obj, }); @@ -4893,6 +5541,9 @@ export interface UserData { } export namespace UserData { + /** + * @internal + */ export const filterSensitiveLog = (obj: UserData): any => ({ ...obj, }); @@ -4916,6 +5567,9 @@ export interface SearchUsersResponse { } export namespace SearchUsersResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: SearchUsersResponse): any => ({ ...obj, }); @@ -4951,6 +5605,9 @@ export interface Audio { } export namespace Audio { + /** + * @internal + */ export const filterSensitiveLog = (obj: Audio): any => ({ ...obj, }); @@ -4972,6 +5629,9 @@ export interface Ssml { } export namespace Ssml { + /** + * @internal + */ export const filterSensitiveLog = (obj: Ssml): any => ({ ...obj, }); @@ -4993,6 +5653,9 @@ export interface Text { } export namespace Text { + /** + * @internal + */ export const filterSensitiveLog = (obj: Text): any => ({ ...obj, }); @@ -5020,6 +5683,9 @@ export interface Content { } export namespace Content { + /** + * @internal + */ export const filterSensitiveLog = (obj: Content): any => ({ ...obj, }); @@ -5049,6 +5715,9 @@ export interface SendAnnouncementRequest { } export namespace SendAnnouncementRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: SendAnnouncementRequest): any => ({ ...obj, }); @@ -5062,6 +5731,9 @@ export interface SendAnnouncementResponse { } export namespace SendAnnouncementResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: SendAnnouncementResponse): any => ({ ...obj, }); @@ -5077,6 +5749,9 @@ export interface InvalidUserStatusException extends __SmithyException, $Metadata } export namespace InvalidUserStatusException { + /** + * @internal + */ export const filterSensitiveLog = (obj: InvalidUserStatusException): any => ({ ...obj, }); @@ -5090,6 +5765,9 @@ export interface SendInvitationRequest { } export namespace SendInvitationRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: SendInvitationRequest): any => ({ ...obj, }); @@ -5098,6 +5776,9 @@ export namespace SendInvitationRequest { export interface SendInvitationResponse {} export namespace SendInvitationResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: SendInvitationResponse): any => ({ ...obj, }); @@ -5121,6 +5802,9 @@ export interface StartDeviceSyncRequest { } export namespace StartDeviceSyncRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: StartDeviceSyncRequest): any => ({ ...obj, }); @@ -5129,6 +5813,9 @@ export namespace StartDeviceSyncRequest { export interface StartDeviceSyncResponse {} export namespace StartDeviceSyncResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: StartDeviceSyncResponse): any => ({ ...obj, }); @@ -5142,6 +5829,9 @@ export interface StartSmartHomeApplianceDiscoveryRequest { } export namespace StartSmartHomeApplianceDiscoveryRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: StartSmartHomeApplianceDiscoveryRequest): any => ({ ...obj, }); @@ -5150,6 +5840,9 @@ export namespace StartSmartHomeApplianceDiscoveryRequest { export interface StartSmartHomeApplianceDiscoveryResponse {} export namespace StartSmartHomeApplianceDiscoveryResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: StartSmartHomeApplianceDiscoveryResponse): any => ({ ...obj, }); @@ -5169,6 +5862,9 @@ export interface TagResourceRequest { } export namespace TagResourceRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: TagResourceRequest): any => ({ ...obj, }); @@ -5177,6 +5873,9 @@ export namespace TagResourceRequest { export interface TagResourceResponse {} export namespace TagResourceResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: TagResourceResponse): any => ({ ...obj, }); @@ -5196,6 +5895,9 @@ export interface UntagResourceRequest { } export namespace UntagResourceRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: UntagResourceRequest): any => ({ ...obj, }); @@ -5204,6 +5906,9 @@ export namespace UntagResourceRequest { export interface UntagResourceResponse {} export namespace UntagResourceResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: UntagResourceResponse): any => ({ ...obj, }); @@ -5219,6 +5924,9 @@ export interface NameInUseException extends __SmithyException, $MetadataBearer { } export namespace NameInUseException { + /** + * @internal + */ export const filterSensitiveLog = (obj: NameInUseException): any => ({ ...obj, }); @@ -5242,6 +5950,9 @@ export interface UpdateAddressBookRequest { } export namespace UpdateAddressBookRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateAddressBookRequest): any => ({ ...obj, }); @@ -5250,6 +5961,9 @@ export namespace UpdateAddressBookRequest { export interface UpdateAddressBookResponse {} export namespace UpdateAddressBookResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateAddressBookResponse): any => ({ ...obj, }); @@ -5289,6 +6003,9 @@ export interface UpdateBusinessReportScheduleRequest { } export namespace UpdateBusinessReportScheduleRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateBusinessReportScheduleRequest): any => ({ ...obj, }); @@ -5297,6 +6014,9 @@ export namespace UpdateBusinessReportScheduleRequest { export interface UpdateBusinessReportScheduleResponse {} export namespace UpdateBusinessReportScheduleResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateBusinessReportScheduleResponse): any => ({ ...obj, }); @@ -5330,6 +6050,9 @@ export interface UpdateConferenceProviderRequest { } export namespace UpdateConferenceProviderRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateConferenceProviderRequest): any => ({ ...obj, }); @@ -5338,6 +6061,9 @@ export namespace UpdateConferenceProviderRequest { export interface UpdateConferenceProviderResponse {} export namespace UpdateConferenceProviderResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateConferenceProviderResponse): any => ({ ...obj, }); @@ -5383,6 +6109,9 @@ export interface UpdateContactRequest { } export namespace UpdateContactRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateContactRequest): any => ({ ...obj, ...(obj.PhoneNumber && { PhoneNumber: SENSITIVE_STRING }), @@ -5394,6 +6123,9 @@ export namespace UpdateContactRequest { export interface UpdateContactResponse {} export namespace UpdateContactResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateContactResponse): any => ({ ...obj, }); @@ -5412,6 +6144,9 @@ export interface UpdateDeviceRequest { } export namespace UpdateDeviceRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateDeviceRequest): any => ({ ...obj, }); @@ -5420,6 +6155,9 @@ export namespace UpdateDeviceRequest { export interface UpdateDeviceResponse {} export namespace UpdateDeviceResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateDeviceResponse): any => ({ ...obj, }); @@ -5449,6 +6187,9 @@ export interface UpdateGatewayRequest { } export namespace UpdateGatewayRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateGatewayRequest): any => ({ ...obj, }); @@ -5457,6 +6198,9 @@ export namespace UpdateGatewayRequest { export interface UpdateGatewayResponse {} export namespace UpdateGatewayResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateGatewayResponse): any => ({ ...obj, }); @@ -5480,6 +6224,9 @@ export interface UpdateGatewayGroupRequest { } export namespace UpdateGatewayGroupRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateGatewayGroupRequest): any => ({ ...obj, }); @@ -5488,6 +6235,9 @@ export namespace UpdateGatewayGroupRequest { export interface UpdateGatewayGroupResponse {} export namespace UpdateGatewayGroupResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateGatewayGroupResponse): any => ({ ...obj, }); @@ -5535,6 +6285,9 @@ export interface UpdateNetworkProfileRequest { } export namespace UpdateNetworkProfileRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateNetworkProfileRequest): any => ({ ...obj, ...(obj.CurrentPassword && { CurrentPassword: SENSITIVE_STRING }), @@ -5545,6 +6298,9 @@ export namespace UpdateNetworkProfileRequest { export interface UpdateNetworkProfileResponse {} export namespace UpdateNetworkProfileResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateNetworkProfileResponse): any => ({ ...obj, }); @@ -5574,6 +6330,9 @@ export interface UpdateEndOfMeetingReminder { } export namespace UpdateEndOfMeetingReminder { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateEndOfMeetingReminder): any => ({ ...obj, }); @@ -5598,6 +6357,9 @@ export interface UpdateInstantBooking { } export namespace UpdateInstantBooking { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateInstantBooking): any => ({ ...obj, }); @@ -5619,6 +6381,9 @@ export interface UpdateRequireCheckIn { } export namespace UpdateRequireCheckIn { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateRequireCheckIn): any => ({ ...obj, }); @@ -5652,6 +6417,9 @@ export interface UpdateMeetingRoomConfiguration { } export namespace UpdateMeetingRoomConfiguration { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateMeetingRoomConfiguration): any => ({ ...obj, }); @@ -5731,6 +6499,9 @@ export interface UpdateProfileRequest { } export namespace UpdateProfileRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateProfileRequest): any => ({ ...obj, }); @@ -5739,6 +6510,9 @@ export namespace UpdateProfileRequest { export interface UpdateProfileResponse {} export namespace UpdateProfileResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateProfileResponse): any => ({ ...obj, }); @@ -5772,6 +6546,9 @@ export interface UpdateRoomRequest { } export namespace UpdateRoomRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateRoomRequest): any => ({ ...obj, }); @@ -5780,6 +6557,9 @@ export namespace UpdateRoomRequest { export interface UpdateRoomResponse {} export namespace UpdateRoomResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateRoomResponse): any => ({ ...obj, }); @@ -5803,6 +6583,9 @@ export interface UpdateSkillGroupRequest { } export namespace UpdateSkillGroupRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateSkillGroupRequest): any => ({ ...obj, }); @@ -5811,6 +6594,9 @@ export namespace UpdateSkillGroupRequest { export interface UpdateSkillGroupResponse {} export namespace UpdateSkillGroupResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateSkillGroupResponse): any => ({ ...obj, }); diff --git a/clients/client-amp/commands/CreateWorkspaceCommand.ts b/clients/client-amp/commands/CreateWorkspaceCommand.ts index 93cd1325a122..6f01cca3444c 100644 --- a/clients/client-amp/commands/CreateWorkspaceCommand.ts +++ b/clients/client-amp/commands/CreateWorkspaceCommand.ts @@ -22,6 +22,20 @@ export interface CreateWorkspaceCommandOutput extends CreateWorkspaceResponse, _ /** * Creates a new AMP workspace. + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { AmpClient, CreateWorkspaceCommand } from "@aws-sdk/client-amp"; // ES Modules import + * // const { AmpClient, CreateWorkspaceCommand } = require("@aws-sdk/client-amp"); // CommonJS import + * const client = new AmpClient(config); + * const command = new CreateWorkspaceCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreateWorkspaceCommandInput} for command's `input` shape. + * @see {@link CreateWorkspaceCommandOutput} for command's `response` shape. + * @see {@link AmpClientResolvedConfig | config} for command's `input` shape. + * */ export class CreateWorkspaceCommand extends $Command< CreateWorkspaceCommandInput, diff --git a/clients/client-amp/commands/DeleteWorkspaceCommand.ts b/clients/client-amp/commands/DeleteWorkspaceCommand.ts index 12b76c2c0687..5d1e79360693 100644 --- a/clients/client-amp/commands/DeleteWorkspaceCommand.ts +++ b/clients/client-amp/commands/DeleteWorkspaceCommand.ts @@ -22,6 +22,20 @@ export interface DeleteWorkspaceCommandOutput extends __MetadataBearer {} /** * Deletes an AMP workspace. + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { AmpClient, DeleteWorkspaceCommand } from "@aws-sdk/client-amp"; // ES Modules import + * // const { AmpClient, DeleteWorkspaceCommand } = require("@aws-sdk/client-amp"); // CommonJS import + * const client = new AmpClient(config); + * const command = new DeleteWorkspaceCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteWorkspaceCommandInput} for command's `input` shape. + * @see {@link DeleteWorkspaceCommandOutput} for command's `response` shape. + * @see {@link AmpClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteWorkspaceCommand extends $Command< DeleteWorkspaceCommandInput, diff --git a/clients/client-amp/commands/DescribeWorkspaceCommand.ts b/clients/client-amp/commands/DescribeWorkspaceCommand.ts index 6e4ca5b0d801..9d4a62de81ee 100644 --- a/clients/client-amp/commands/DescribeWorkspaceCommand.ts +++ b/clients/client-amp/commands/DescribeWorkspaceCommand.ts @@ -22,6 +22,20 @@ export interface DescribeWorkspaceCommandOutput extends DescribeWorkspaceRespons /** * Describes an existing AMP workspace. + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { AmpClient, DescribeWorkspaceCommand } from "@aws-sdk/client-amp"; // ES Modules import + * // const { AmpClient, DescribeWorkspaceCommand } = require("@aws-sdk/client-amp"); // CommonJS import + * const client = new AmpClient(config); + * const command = new DescribeWorkspaceCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeWorkspaceCommandInput} for command's `input` shape. + * @see {@link DescribeWorkspaceCommandOutput} for command's `response` shape. + * @see {@link AmpClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeWorkspaceCommand extends $Command< DescribeWorkspaceCommandInput, diff --git a/clients/client-amp/commands/ListWorkspacesCommand.ts b/clients/client-amp/commands/ListWorkspacesCommand.ts index 130cb3ab5367..209e3498f9f9 100644 --- a/clients/client-amp/commands/ListWorkspacesCommand.ts +++ b/clients/client-amp/commands/ListWorkspacesCommand.ts @@ -22,6 +22,20 @@ export interface ListWorkspacesCommandOutput extends ListWorkspacesResponse, __M /** * Lists all AMP workspaces, including workspaces being created or deleted. + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { AmpClient, ListWorkspacesCommand } from "@aws-sdk/client-amp"; // ES Modules import + * // const { AmpClient, ListWorkspacesCommand } = require("@aws-sdk/client-amp"); // CommonJS import + * const client = new AmpClient(config); + * const command = new ListWorkspacesCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListWorkspacesCommandInput} for command's `input` shape. + * @see {@link ListWorkspacesCommandOutput} for command's `response` shape. + * @see {@link AmpClientResolvedConfig | config} for command's `input` shape. + * */ export class ListWorkspacesCommand extends $Command< ListWorkspacesCommandInput, diff --git a/clients/client-amp/commands/UpdateWorkspaceAliasCommand.ts b/clients/client-amp/commands/UpdateWorkspaceAliasCommand.ts index 01e80c147822..1a9f46e0575a 100644 --- a/clients/client-amp/commands/UpdateWorkspaceAliasCommand.ts +++ b/clients/client-amp/commands/UpdateWorkspaceAliasCommand.ts @@ -22,6 +22,20 @@ export interface UpdateWorkspaceAliasCommandOutput extends __MetadataBearer {} /** * Updates an AMP workspace alias. + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { AmpClient, UpdateWorkspaceAliasCommand } from "@aws-sdk/client-amp"; // ES Modules import + * // const { AmpClient, UpdateWorkspaceAliasCommand } = require("@aws-sdk/client-amp"); // CommonJS import + * const client = new AmpClient(config); + * const command = new UpdateWorkspaceAliasCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link UpdateWorkspaceAliasCommandInput} for command's `input` shape. + * @see {@link UpdateWorkspaceAliasCommandOutput} for command's `response` shape. + * @see {@link AmpClientResolvedConfig | config} for command's `input` shape. + * */ export class UpdateWorkspaceAliasCommand extends $Command< UpdateWorkspaceAliasCommandInput, diff --git a/clients/client-amp/models/models_0.ts b/clients/client-amp/models/models_0.ts index 87031d4cbf6d..fb097fb9f171 100644 --- a/clients/client-amp/models/models_0.ts +++ b/clients/client-amp/models/models_0.ts @@ -14,6 +14,9 @@ export interface AccessDeniedException extends __SmithyException, $MetadataBeare } export namespace AccessDeniedException { + /** + * @internal + */ export const filterSensitiveLog = (obj: AccessDeniedException): any => ({ ...obj, }); @@ -42,6 +45,9 @@ export interface ConflictException extends __SmithyException, $MetadataBearer { } export namespace ConflictException { + /** + * @internal + */ export const filterSensitiveLog = (obj: ConflictException): any => ({ ...obj, }); @@ -63,6 +69,9 @@ export interface CreateWorkspaceRequest { } export namespace CreateWorkspaceRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateWorkspaceRequest): any => ({ ...obj, }); @@ -102,6 +111,9 @@ export interface WorkspaceStatus { } export namespace WorkspaceStatus { + /** + * @internal + */ export const filterSensitiveLog = (obj: WorkspaceStatus): any => ({ ...obj, }); @@ -128,6 +140,9 @@ export interface CreateWorkspaceResponse { } export namespace CreateWorkspaceResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateWorkspaceResponse): any => ({ ...obj, }); @@ -152,6 +167,9 @@ export interface InternalServerException extends __SmithyException, $MetadataBea } export namespace InternalServerException { + /** + * @internal + */ export const filterSensitiveLog = (obj: InternalServerException): any => ({ ...obj, }); @@ -190,6 +208,9 @@ export interface ServiceQuotaExceededException extends __SmithyException, $Metad } export namespace ServiceQuotaExceededException { + /** + * @internal + */ export const filterSensitiveLog = (obj: ServiceQuotaExceededException): any => ({ ...obj, }); @@ -224,6 +245,9 @@ export interface ThrottlingException extends __SmithyException, $MetadataBearer } export namespace ThrottlingException { + /** + * @internal + */ export const filterSensitiveLog = (obj: ThrottlingException): any => ({ ...obj, }); @@ -245,6 +269,9 @@ export interface ValidationExceptionField { } export namespace ValidationExceptionField { + /** + * @internal + */ export const filterSensitiveLog = (obj: ValidationExceptionField): any => ({ ...obj, }); @@ -280,6 +307,9 @@ export interface ValidationException extends __SmithyException, $MetadataBearer } export namespace ValidationException { + /** + * @internal + */ export const filterSensitiveLog = (obj: ValidationException): any => ({ ...obj, }); @@ -301,6 +331,9 @@ export interface DeleteWorkspaceRequest { } export namespace DeleteWorkspaceRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteWorkspaceRequest): any => ({ ...obj, }); @@ -329,6 +362,9 @@ export interface ResourceNotFoundException extends __SmithyException, $MetadataB } export namespace ResourceNotFoundException { + /** + * @internal + */ export const filterSensitiveLog = (obj: ResourceNotFoundException): any => ({ ...obj, }); @@ -345,6 +381,9 @@ export interface DescribeWorkspaceRequest { } export namespace DescribeWorkspaceRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeWorkspaceRequest): any => ({ ...obj, }); @@ -386,6 +425,9 @@ export interface WorkspaceDescription { } export namespace WorkspaceDescription { + /** + * @internal + */ export const filterSensitiveLog = (obj: WorkspaceDescription): any => ({ ...obj, }); @@ -402,6 +444,9 @@ export interface DescribeWorkspaceResponse { } export namespace DescribeWorkspaceResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeWorkspaceResponse): any => ({ ...obj, }); @@ -428,6 +473,9 @@ export interface ListWorkspacesRequest { } export namespace ListWorkspacesRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListWorkspacesRequest): any => ({ ...obj, }); @@ -464,6 +512,9 @@ export interface WorkspaceSummary { } export namespace WorkspaceSummary { + /** + * @internal + */ export const filterSensitiveLog = (obj: WorkspaceSummary): any => ({ ...obj, }); @@ -485,6 +536,9 @@ export interface ListWorkspacesResponse { } export namespace ListWorkspacesResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListWorkspacesResponse): any => ({ ...obj, }); @@ -511,6 +565,9 @@ export interface UpdateWorkspaceAliasRequest { } export namespace UpdateWorkspaceAliasRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateWorkspaceAliasRequest): any => ({ ...obj, }); diff --git a/clients/client-amplify/commands/CreateAppCommand.ts b/clients/client-amplify/commands/CreateAppCommand.ts index 9d7b65c138a4..f4e797ddf2f7 100644 --- a/clients/client-amplify/commands/CreateAppCommand.ts +++ b/clients/client-amplify/commands/CreateAppCommand.ts @@ -22,6 +22,20 @@ export interface CreateAppCommandOutput extends CreateAppResult, __MetadataBeare /** *

Creates a new Amplify app.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { AmplifyClient, CreateAppCommand } from "@aws-sdk/client-amplify"; // ES Modules import + * // const { AmplifyClient, CreateAppCommand } = require("@aws-sdk/client-amplify"); // CommonJS import + * const client = new AmplifyClient(config); + * const command = new CreateAppCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreateAppCommandInput} for command's `input` shape. + * @see {@link CreateAppCommandOutput} for command's `response` shape. + * @see {@link AmplifyClientResolvedConfig | config} for command's `input` shape. + * */ export class CreateAppCommand extends $Command< CreateAppCommandInput, diff --git a/clients/client-amplify/commands/CreateBackendEnvironmentCommand.ts b/clients/client-amplify/commands/CreateBackendEnvironmentCommand.ts index c72252c4adea..786138f2d5b5 100644 --- a/clients/client-amplify/commands/CreateBackendEnvironmentCommand.ts +++ b/clients/client-amplify/commands/CreateBackendEnvironmentCommand.ts @@ -22,6 +22,20 @@ export interface CreateBackendEnvironmentCommandOutput extends CreateBackendEnvi /** *

Creates a new backend environment for an Amplify app.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { AmplifyClient, CreateBackendEnvironmentCommand } from "@aws-sdk/client-amplify"; // ES Modules import + * // const { AmplifyClient, CreateBackendEnvironmentCommand } = require("@aws-sdk/client-amplify"); // CommonJS import + * const client = new AmplifyClient(config); + * const command = new CreateBackendEnvironmentCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreateBackendEnvironmentCommandInput} for command's `input` shape. + * @see {@link CreateBackendEnvironmentCommandOutput} for command's `response` shape. + * @see {@link AmplifyClientResolvedConfig | config} for command's `input` shape. + * */ export class CreateBackendEnvironmentCommand extends $Command< CreateBackendEnvironmentCommandInput, diff --git a/clients/client-amplify/commands/CreateBranchCommand.ts b/clients/client-amplify/commands/CreateBranchCommand.ts index c14fee14cd1f..04266888f258 100644 --- a/clients/client-amplify/commands/CreateBranchCommand.ts +++ b/clients/client-amplify/commands/CreateBranchCommand.ts @@ -22,6 +22,20 @@ export interface CreateBranchCommandOutput extends CreateBranchResult, __Metadat /** *

Creates a new branch for an Amplify app.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { AmplifyClient, CreateBranchCommand } from "@aws-sdk/client-amplify"; // ES Modules import + * // const { AmplifyClient, CreateBranchCommand } = require("@aws-sdk/client-amplify"); // CommonJS import + * const client = new AmplifyClient(config); + * const command = new CreateBranchCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreateBranchCommandInput} for command's `input` shape. + * @see {@link CreateBranchCommandOutput} for command's `response` shape. + * @see {@link AmplifyClientResolvedConfig | config} for command's `input` shape. + * */ export class CreateBranchCommand extends $Command< CreateBranchCommandInput, diff --git a/clients/client-amplify/commands/CreateDeploymentCommand.ts b/clients/client-amplify/commands/CreateDeploymentCommand.ts index 6e124d6305ba..73505d3568d1 100644 --- a/clients/client-amplify/commands/CreateDeploymentCommand.ts +++ b/clients/client-amplify/commands/CreateDeploymentCommand.ts @@ -23,6 +23,20 @@ export interface CreateDeploymentCommandOutput extends CreateDeploymentResult, _ /** *

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

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { AmplifyClient, CreateDeploymentCommand } from "@aws-sdk/client-amplify"; // ES Modules import + * // const { AmplifyClient, CreateDeploymentCommand } = require("@aws-sdk/client-amplify"); // CommonJS import + * const client = new AmplifyClient(config); + * const command = new CreateDeploymentCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreateDeploymentCommandInput} for command's `input` shape. + * @see {@link CreateDeploymentCommandOutput} for command's `response` shape. + * @see {@link AmplifyClientResolvedConfig | config} for command's `input` shape. + * */ export class CreateDeploymentCommand extends $Command< CreateDeploymentCommandInput, diff --git a/clients/client-amplify/commands/CreateDomainAssociationCommand.ts b/clients/client-amplify/commands/CreateDomainAssociationCommand.ts index 02c2216022f9..dc2caf292a36 100644 --- a/clients/client-amplify/commands/CreateDomainAssociationCommand.ts +++ b/clients/client-amplify/commands/CreateDomainAssociationCommand.ts @@ -23,6 +23,20 @@ export interface CreateDomainAssociationCommandOutput extends CreateDomainAssoci /** *

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

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { AmplifyClient, CreateDomainAssociationCommand } from "@aws-sdk/client-amplify"; // ES Modules import + * // const { AmplifyClient, CreateDomainAssociationCommand } = require("@aws-sdk/client-amplify"); // CommonJS import + * const client = new AmplifyClient(config); + * const command = new CreateDomainAssociationCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreateDomainAssociationCommandInput} for command's `input` shape. + * @see {@link CreateDomainAssociationCommandOutput} for command's `response` shape. + * @see {@link AmplifyClientResolvedConfig | config} for command's `input` shape. + * */ export class CreateDomainAssociationCommand extends $Command< CreateDomainAssociationCommandInput, diff --git a/clients/client-amplify/commands/CreateWebhookCommand.ts b/clients/client-amplify/commands/CreateWebhookCommand.ts index fed9776a4fcc..9b64b331330e 100644 --- a/clients/client-amplify/commands/CreateWebhookCommand.ts +++ b/clients/client-amplify/commands/CreateWebhookCommand.ts @@ -22,6 +22,20 @@ export interface CreateWebhookCommandOutput extends CreateWebhookResult, __Metad /** *

Creates a new webhook on an Amplify app.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { AmplifyClient, CreateWebhookCommand } from "@aws-sdk/client-amplify"; // ES Modules import + * // const { AmplifyClient, CreateWebhookCommand } = require("@aws-sdk/client-amplify"); // CommonJS import + * const client = new AmplifyClient(config); + * const command = new CreateWebhookCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreateWebhookCommandInput} for command's `input` shape. + * @see {@link CreateWebhookCommandOutput} for command's `response` shape. + * @see {@link AmplifyClientResolvedConfig | config} for command's `input` shape. + * */ export class CreateWebhookCommand extends $Command< CreateWebhookCommandInput, diff --git a/clients/client-amplify/commands/DeleteAppCommand.ts b/clients/client-amplify/commands/DeleteAppCommand.ts index 614eda63a425..5cd426e64993 100644 --- a/clients/client-amplify/commands/DeleteAppCommand.ts +++ b/clients/client-amplify/commands/DeleteAppCommand.ts @@ -22,6 +22,20 @@ export interface DeleteAppCommandOutput extends DeleteAppResult, __MetadataBeare /** *

Deletes an existing Amplify app specified by an app ID.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { AmplifyClient, DeleteAppCommand } from "@aws-sdk/client-amplify"; // ES Modules import + * // const { AmplifyClient, DeleteAppCommand } = require("@aws-sdk/client-amplify"); // CommonJS import + * const client = new AmplifyClient(config); + * const command = new DeleteAppCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteAppCommandInput} for command's `input` shape. + * @see {@link DeleteAppCommandOutput} for command's `response` shape. + * @see {@link AmplifyClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteAppCommand extends $Command< DeleteAppCommandInput, diff --git a/clients/client-amplify/commands/DeleteBackendEnvironmentCommand.ts b/clients/client-amplify/commands/DeleteBackendEnvironmentCommand.ts index 2c5d0c56dac1..e8440fa9671e 100644 --- a/clients/client-amplify/commands/DeleteBackendEnvironmentCommand.ts +++ b/clients/client-amplify/commands/DeleteBackendEnvironmentCommand.ts @@ -22,6 +22,20 @@ export interface DeleteBackendEnvironmentCommandOutput extends DeleteBackendEnvi /** *

Deletes a backend environment for an Amplify app.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { AmplifyClient, DeleteBackendEnvironmentCommand } from "@aws-sdk/client-amplify"; // ES Modules import + * // const { AmplifyClient, DeleteBackendEnvironmentCommand } = require("@aws-sdk/client-amplify"); // CommonJS import + * const client = new AmplifyClient(config); + * const command = new DeleteBackendEnvironmentCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteBackendEnvironmentCommandInput} for command's `input` shape. + * @see {@link DeleteBackendEnvironmentCommandOutput} for command's `response` shape. + * @see {@link AmplifyClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteBackendEnvironmentCommand extends $Command< DeleteBackendEnvironmentCommandInput, diff --git a/clients/client-amplify/commands/DeleteBranchCommand.ts b/clients/client-amplify/commands/DeleteBranchCommand.ts index f0c3149fae72..fc5eff907f0c 100644 --- a/clients/client-amplify/commands/DeleteBranchCommand.ts +++ b/clients/client-amplify/commands/DeleteBranchCommand.ts @@ -22,6 +22,20 @@ export interface DeleteBranchCommandOutput extends DeleteBranchResult, __Metadat /** *

Deletes a branch for an Amplify app.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { AmplifyClient, DeleteBranchCommand } from "@aws-sdk/client-amplify"; // ES Modules import + * // const { AmplifyClient, DeleteBranchCommand } = require("@aws-sdk/client-amplify"); // CommonJS import + * const client = new AmplifyClient(config); + * const command = new DeleteBranchCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteBranchCommandInput} for command's `input` shape. + * @see {@link DeleteBranchCommandOutput} for command's `response` shape. + * @see {@link AmplifyClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteBranchCommand extends $Command< DeleteBranchCommandInput, diff --git a/clients/client-amplify/commands/DeleteDomainAssociationCommand.ts b/clients/client-amplify/commands/DeleteDomainAssociationCommand.ts index 5f913467f1c6..917851fc4571 100644 --- a/clients/client-amplify/commands/DeleteDomainAssociationCommand.ts +++ b/clients/client-amplify/commands/DeleteDomainAssociationCommand.ts @@ -22,6 +22,20 @@ export interface DeleteDomainAssociationCommandOutput extends DeleteDomainAssoci /** *

Deletes a domain association for an Amplify app.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { AmplifyClient, DeleteDomainAssociationCommand } from "@aws-sdk/client-amplify"; // ES Modules import + * // const { AmplifyClient, DeleteDomainAssociationCommand } = require("@aws-sdk/client-amplify"); // CommonJS import + * const client = new AmplifyClient(config); + * const command = new DeleteDomainAssociationCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteDomainAssociationCommandInput} for command's `input` shape. + * @see {@link DeleteDomainAssociationCommandOutput} for command's `response` shape. + * @see {@link AmplifyClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteDomainAssociationCommand extends $Command< DeleteDomainAssociationCommandInput, diff --git a/clients/client-amplify/commands/DeleteJobCommand.ts b/clients/client-amplify/commands/DeleteJobCommand.ts index 2a012cf3c24c..5c6c0966fef6 100644 --- a/clients/client-amplify/commands/DeleteJobCommand.ts +++ b/clients/client-amplify/commands/DeleteJobCommand.ts @@ -22,6 +22,20 @@ export interface DeleteJobCommandOutput extends DeleteJobResult, __MetadataBeare /** *

Deletes a job for a branch of an Amplify app.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { AmplifyClient, DeleteJobCommand } from "@aws-sdk/client-amplify"; // ES Modules import + * // const { AmplifyClient, DeleteJobCommand } = require("@aws-sdk/client-amplify"); // CommonJS import + * const client = new AmplifyClient(config); + * const command = new DeleteJobCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteJobCommandInput} for command's `input` shape. + * @see {@link DeleteJobCommandOutput} for command's `response` shape. + * @see {@link AmplifyClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteJobCommand extends $Command< DeleteJobCommandInput, diff --git a/clients/client-amplify/commands/DeleteWebhookCommand.ts b/clients/client-amplify/commands/DeleteWebhookCommand.ts index beb08c4c3eec..2bead719c9df 100644 --- a/clients/client-amplify/commands/DeleteWebhookCommand.ts +++ b/clients/client-amplify/commands/DeleteWebhookCommand.ts @@ -22,6 +22,20 @@ export interface DeleteWebhookCommandOutput extends DeleteWebhookResult, __Metad /** *

Deletes a webhook.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { AmplifyClient, DeleteWebhookCommand } from "@aws-sdk/client-amplify"; // ES Modules import + * // const { AmplifyClient, DeleteWebhookCommand } = require("@aws-sdk/client-amplify"); // CommonJS import + * const client = new AmplifyClient(config); + * const command = new DeleteWebhookCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteWebhookCommandInput} for command's `input` shape. + * @see {@link DeleteWebhookCommandOutput} for command's `response` shape. + * @see {@link AmplifyClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteWebhookCommand extends $Command< DeleteWebhookCommandInput, diff --git a/clients/client-amplify/commands/GenerateAccessLogsCommand.ts b/clients/client-amplify/commands/GenerateAccessLogsCommand.ts index 2c7774434371..a7bf28d8ff22 100644 --- a/clients/client-amplify/commands/GenerateAccessLogsCommand.ts +++ b/clients/client-amplify/commands/GenerateAccessLogsCommand.ts @@ -23,6 +23,20 @@ export interface GenerateAccessLogsCommandOutput extends GenerateAccessLogsResul /** *

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

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { AmplifyClient, GenerateAccessLogsCommand } from "@aws-sdk/client-amplify"; // ES Modules import + * // const { AmplifyClient, GenerateAccessLogsCommand } = require("@aws-sdk/client-amplify"); // CommonJS import + * const client = new AmplifyClient(config); + * const command = new GenerateAccessLogsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GenerateAccessLogsCommandInput} for command's `input` shape. + * @see {@link GenerateAccessLogsCommandOutput} for command's `response` shape. + * @see {@link AmplifyClientResolvedConfig | config} for command's `input` shape. + * */ export class GenerateAccessLogsCommand extends $Command< GenerateAccessLogsCommandInput, diff --git a/clients/client-amplify/commands/GetAppCommand.ts b/clients/client-amplify/commands/GetAppCommand.ts index 987f2f21567c..6a7fbcfe7454 100644 --- a/clients/client-amplify/commands/GetAppCommand.ts +++ b/clients/client-amplify/commands/GetAppCommand.ts @@ -19,6 +19,20 @@ export interface GetAppCommandOutput extends GetAppResult, __MetadataBearer {} /** *

Returns an existing Amplify app by appID.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { AmplifyClient, GetAppCommand } from "@aws-sdk/client-amplify"; // ES Modules import + * // const { AmplifyClient, GetAppCommand } = require("@aws-sdk/client-amplify"); // CommonJS import + * const client = new AmplifyClient(config); + * const command = new GetAppCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetAppCommandInput} for command's `input` shape. + * @see {@link GetAppCommandOutput} for command's `response` shape. + * @see {@link AmplifyClientResolvedConfig | config} for command's `input` shape. + * */ export class GetAppCommand extends $Command { // Start section: command_properties diff --git a/clients/client-amplify/commands/GetArtifactUrlCommand.ts b/clients/client-amplify/commands/GetArtifactUrlCommand.ts index f27b6ef16326..cba112f42dca 100644 --- a/clients/client-amplify/commands/GetArtifactUrlCommand.ts +++ b/clients/client-amplify/commands/GetArtifactUrlCommand.ts @@ -22,6 +22,20 @@ export interface GetArtifactUrlCommandOutput extends GetArtifactUrlResult, __Met /** *

Returns the artifact info that corresponds to an artifact id.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { AmplifyClient, GetArtifactUrlCommand } from "@aws-sdk/client-amplify"; // ES Modules import + * // const { AmplifyClient, GetArtifactUrlCommand } = require("@aws-sdk/client-amplify"); // CommonJS import + * const client = new AmplifyClient(config); + * const command = new GetArtifactUrlCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetArtifactUrlCommandInput} for command's `input` shape. + * @see {@link GetArtifactUrlCommandOutput} for command's `response` shape. + * @see {@link AmplifyClientResolvedConfig | config} for command's `input` shape. + * */ export class GetArtifactUrlCommand extends $Command< GetArtifactUrlCommandInput, diff --git a/clients/client-amplify/commands/GetBackendEnvironmentCommand.ts b/clients/client-amplify/commands/GetBackendEnvironmentCommand.ts index f03deb6f39f5..86a508927583 100644 --- a/clients/client-amplify/commands/GetBackendEnvironmentCommand.ts +++ b/clients/client-amplify/commands/GetBackendEnvironmentCommand.ts @@ -22,6 +22,20 @@ export interface GetBackendEnvironmentCommandOutput extends GetBackendEnvironmen /** *

Returns a backend environment for an Amplify app.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { AmplifyClient, GetBackendEnvironmentCommand } from "@aws-sdk/client-amplify"; // ES Modules import + * // const { AmplifyClient, GetBackendEnvironmentCommand } = require("@aws-sdk/client-amplify"); // CommonJS import + * const client = new AmplifyClient(config); + * const command = new GetBackendEnvironmentCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetBackendEnvironmentCommandInput} for command's `input` shape. + * @see {@link GetBackendEnvironmentCommandOutput} for command's `response` shape. + * @see {@link AmplifyClientResolvedConfig | config} for command's `input` shape. + * */ export class GetBackendEnvironmentCommand extends $Command< GetBackendEnvironmentCommandInput, diff --git a/clients/client-amplify/commands/GetBranchCommand.ts b/clients/client-amplify/commands/GetBranchCommand.ts index bc322d6379c6..26f867c058e1 100644 --- a/clients/client-amplify/commands/GetBranchCommand.ts +++ b/clients/client-amplify/commands/GetBranchCommand.ts @@ -22,6 +22,20 @@ export interface GetBranchCommandOutput extends GetBranchResult, __MetadataBeare /** *

Returns a branch for an Amplify app.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { AmplifyClient, GetBranchCommand } from "@aws-sdk/client-amplify"; // ES Modules import + * // const { AmplifyClient, GetBranchCommand } = require("@aws-sdk/client-amplify"); // CommonJS import + * const client = new AmplifyClient(config); + * const command = new GetBranchCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetBranchCommandInput} for command's `input` shape. + * @see {@link GetBranchCommandOutput} for command's `response` shape. + * @see {@link AmplifyClientResolvedConfig | config} for command's `input` shape. + * */ export class GetBranchCommand extends $Command< GetBranchCommandInput, diff --git a/clients/client-amplify/commands/GetDomainAssociationCommand.ts b/clients/client-amplify/commands/GetDomainAssociationCommand.ts index 331f9af89ef1..3d370a130da9 100644 --- a/clients/client-amplify/commands/GetDomainAssociationCommand.ts +++ b/clients/client-amplify/commands/GetDomainAssociationCommand.ts @@ -22,6 +22,20 @@ export interface GetDomainAssociationCommandOutput extends GetDomainAssociationR /** *

Returns the domain information for an Amplify app.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { AmplifyClient, GetDomainAssociationCommand } from "@aws-sdk/client-amplify"; // ES Modules import + * // const { AmplifyClient, GetDomainAssociationCommand } = require("@aws-sdk/client-amplify"); // CommonJS import + * const client = new AmplifyClient(config); + * const command = new GetDomainAssociationCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetDomainAssociationCommandInput} for command's `input` shape. + * @see {@link GetDomainAssociationCommandOutput} for command's `response` shape. + * @see {@link AmplifyClientResolvedConfig | config} for command's `input` shape. + * */ export class GetDomainAssociationCommand extends $Command< GetDomainAssociationCommandInput, diff --git a/clients/client-amplify/commands/GetJobCommand.ts b/clients/client-amplify/commands/GetJobCommand.ts index a9bae709e93c..b9e1e3de1c07 100644 --- a/clients/client-amplify/commands/GetJobCommand.ts +++ b/clients/client-amplify/commands/GetJobCommand.ts @@ -19,6 +19,20 @@ export interface GetJobCommandOutput extends GetJobResult, __MetadataBearer {} /** *

Returns a job for a branch of an Amplify app.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { AmplifyClient, GetJobCommand } from "@aws-sdk/client-amplify"; // ES Modules import + * // const { AmplifyClient, GetJobCommand } = require("@aws-sdk/client-amplify"); // CommonJS import + * const client = new AmplifyClient(config); + * const command = new GetJobCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetJobCommandInput} for command's `input` shape. + * @see {@link GetJobCommandOutput} for command's `response` shape. + * @see {@link AmplifyClientResolvedConfig | config} for command's `input` shape. + * */ export class GetJobCommand extends $Command { // Start section: command_properties diff --git a/clients/client-amplify/commands/GetWebhookCommand.ts b/clients/client-amplify/commands/GetWebhookCommand.ts index 5fe4ee7a5dcd..964981b8c333 100644 --- a/clients/client-amplify/commands/GetWebhookCommand.ts +++ b/clients/client-amplify/commands/GetWebhookCommand.ts @@ -22,6 +22,20 @@ export interface GetWebhookCommandOutput extends GetWebhookResult, __MetadataBea /** *

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

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { AmplifyClient, GetWebhookCommand } from "@aws-sdk/client-amplify"; // ES Modules import + * // const { AmplifyClient, GetWebhookCommand } = require("@aws-sdk/client-amplify"); // CommonJS import + * const client = new AmplifyClient(config); + * const command = new GetWebhookCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetWebhookCommandInput} for command's `input` shape. + * @see {@link GetWebhookCommandOutput} for command's `response` shape. + * @see {@link AmplifyClientResolvedConfig | config} for command's `input` shape. + * */ export class GetWebhookCommand extends $Command< GetWebhookCommandInput, diff --git a/clients/client-amplify/commands/ListAppsCommand.ts b/clients/client-amplify/commands/ListAppsCommand.ts index 5a9994704e99..bf708b7201e3 100644 --- a/clients/client-amplify/commands/ListAppsCommand.ts +++ b/clients/client-amplify/commands/ListAppsCommand.ts @@ -22,6 +22,20 @@ export interface ListAppsCommandOutput extends ListAppsResult, __MetadataBearer /** *

Returns a list of the existing Amplify apps.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { AmplifyClient, ListAppsCommand } from "@aws-sdk/client-amplify"; // ES Modules import + * // const { AmplifyClient, ListAppsCommand } = require("@aws-sdk/client-amplify"); // CommonJS import + * const client = new AmplifyClient(config); + * const command = new ListAppsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListAppsCommandInput} for command's `input` shape. + * @see {@link ListAppsCommandOutput} for command's `response` shape. + * @see {@link AmplifyClientResolvedConfig | config} for command's `input` shape. + * */ export class ListAppsCommand extends $Command< ListAppsCommandInput, diff --git a/clients/client-amplify/commands/ListArtifactsCommand.ts b/clients/client-amplify/commands/ListArtifactsCommand.ts index 5f321a8788c3..3fc10e8b110a 100644 --- a/clients/client-amplify/commands/ListArtifactsCommand.ts +++ b/clients/client-amplify/commands/ListArtifactsCommand.ts @@ -22,6 +22,20 @@ export interface ListArtifactsCommandOutput extends ListArtifactsResult, __Metad /** *

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

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { AmplifyClient, ListArtifactsCommand } from "@aws-sdk/client-amplify"; // ES Modules import + * // const { AmplifyClient, ListArtifactsCommand } = require("@aws-sdk/client-amplify"); // CommonJS import + * const client = new AmplifyClient(config); + * const command = new ListArtifactsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListArtifactsCommandInput} for command's `input` shape. + * @see {@link ListArtifactsCommandOutput} for command's `response` shape. + * @see {@link AmplifyClientResolvedConfig | config} for command's `input` shape. + * */ export class ListArtifactsCommand extends $Command< ListArtifactsCommandInput, diff --git a/clients/client-amplify/commands/ListBackendEnvironmentsCommand.ts b/clients/client-amplify/commands/ListBackendEnvironmentsCommand.ts index 684d51a1ad71..4bf914b851d6 100644 --- a/clients/client-amplify/commands/ListBackendEnvironmentsCommand.ts +++ b/clients/client-amplify/commands/ListBackendEnvironmentsCommand.ts @@ -22,6 +22,20 @@ export interface ListBackendEnvironmentsCommandOutput extends ListBackendEnviron /** *

Lists the backend environments for an Amplify app.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { AmplifyClient, ListBackendEnvironmentsCommand } from "@aws-sdk/client-amplify"; // ES Modules import + * // const { AmplifyClient, ListBackendEnvironmentsCommand } = require("@aws-sdk/client-amplify"); // CommonJS import + * const client = new AmplifyClient(config); + * const command = new ListBackendEnvironmentsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListBackendEnvironmentsCommandInput} for command's `input` shape. + * @see {@link ListBackendEnvironmentsCommandOutput} for command's `response` shape. + * @see {@link AmplifyClientResolvedConfig | config} for command's `input` shape. + * */ export class ListBackendEnvironmentsCommand extends $Command< ListBackendEnvironmentsCommandInput, diff --git a/clients/client-amplify/commands/ListBranchesCommand.ts b/clients/client-amplify/commands/ListBranchesCommand.ts index 6145f0b04522..88f05ce2451d 100644 --- a/clients/client-amplify/commands/ListBranchesCommand.ts +++ b/clients/client-amplify/commands/ListBranchesCommand.ts @@ -22,6 +22,20 @@ export interface ListBranchesCommandOutput extends ListBranchesResult, __Metadat /** *

Lists the branches of an Amplify app.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { AmplifyClient, ListBranchesCommand } from "@aws-sdk/client-amplify"; // ES Modules import + * // const { AmplifyClient, ListBranchesCommand } = require("@aws-sdk/client-amplify"); // CommonJS import + * const client = new AmplifyClient(config); + * const command = new ListBranchesCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListBranchesCommandInput} for command's `input` shape. + * @see {@link ListBranchesCommandOutput} for command's `response` shape. + * @see {@link AmplifyClientResolvedConfig | config} for command's `input` shape. + * */ export class ListBranchesCommand extends $Command< ListBranchesCommandInput, diff --git a/clients/client-amplify/commands/ListDomainAssociationsCommand.ts b/clients/client-amplify/commands/ListDomainAssociationsCommand.ts index 65cf07390005..138dc7c4adf7 100644 --- a/clients/client-amplify/commands/ListDomainAssociationsCommand.ts +++ b/clients/client-amplify/commands/ListDomainAssociationsCommand.ts @@ -22,6 +22,20 @@ export interface ListDomainAssociationsCommandOutput extends ListDomainAssociati /** *

Returns the domain associations for an Amplify app.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { AmplifyClient, ListDomainAssociationsCommand } from "@aws-sdk/client-amplify"; // ES Modules import + * // const { AmplifyClient, ListDomainAssociationsCommand } = require("@aws-sdk/client-amplify"); // CommonJS import + * const client = new AmplifyClient(config); + * const command = new ListDomainAssociationsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListDomainAssociationsCommandInput} for command's `input` shape. + * @see {@link ListDomainAssociationsCommandOutput} for command's `response` shape. + * @see {@link AmplifyClientResolvedConfig | config} for command's `input` shape. + * */ export class ListDomainAssociationsCommand extends $Command< ListDomainAssociationsCommandInput, diff --git a/clients/client-amplify/commands/ListJobsCommand.ts b/clients/client-amplify/commands/ListJobsCommand.ts index 78668ead8de9..87a24b1b7873 100644 --- a/clients/client-amplify/commands/ListJobsCommand.ts +++ b/clients/client-amplify/commands/ListJobsCommand.ts @@ -22,6 +22,20 @@ export interface ListJobsCommandOutput extends ListJobsResult, __MetadataBearer /** *

Lists the jobs for a branch of an Amplify app.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { AmplifyClient, ListJobsCommand } from "@aws-sdk/client-amplify"; // ES Modules import + * // const { AmplifyClient, ListJobsCommand } = require("@aws-sdk/client-amplify"); // CommonJS import + * const client = new AmplifyClient(config); + * const command = new ListJobsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListJobsCommandInput} for command's `input` shape. + * @see {@link ListJobsCommandOutput} for command's `response` shape. + * @see {@link AmplifyClientResolvedConfig | config} for command's `input` shape. + * */ export class ListJobsCommand extends $Command< ListJobsCommandInput, diff --git a/clients/client-amplify/commands/ListTagsForResourceCommand.ts b/clients/client-amplify/commands/ListTagsForResourceCommand.ts index 08280625c507..084e5ab4fc5d 100644 --- a/clients/client-amplify/commands/ListTagsForResourceCommand.ts +++ b/clients/client-amplify/commands/ListTagsForResourceCommand.ts @@ -22,6 +22,20 @@ export interface ListTagsForResourceCommandOutput extends ListTagsForResourceRes /** *

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

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { AmplifyClient, ListTagsForResourceCommand } from "@aws-sdk/client-amplify"; // ES Modules import + * // const { AmplifyClient, ListTagsForResourceCommand } = require("@aws-sdk/client-amplify"); // CommonJS import + * const client = new AmplifyClient(config); + * const command = new ListTagsForResourceCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListTagsForResourceCommandInput} for command's `input` shape. + * @see {@link ListTagsForResourceCommandOutput} for command's `response` shape. + * @see {@link AmplifyClientResolvedConfig | config} for command's `input` shape. + * */ export class ListTagsForResourceCommand extends $Command< ListTagsForResourceCommandInput, diff --git a/clients/client-amplify/commands/ListWebhooksCommand.ts b/clients/client-amplify/commands/ListWebhooksCommand.ts index f957761708c5..f8342e790c66 100644 --- a/clients/client-amplify/commands/ListWebhooksCommand.ts +++ b/clients/client-amplify/commands/ListWebhooksCommand.ts @@ -22,6 +22,20 @@ export interface ListWebhooksCommandOutput extends ListWebhooksResult, __Metadat /** *

Returns a list of webhooks for an Amplify app.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { AmplifyClient, ListWebhooksCommand } from "@aws-sdk/client-amplify"; // ES Modules import + * // const { AmplifyClient, ListWebhooksCommand } = require("@aws-sdk/client-amplify"); // CommonJS import + * const client = new AmplifyClient(config); + * const command = new ListWebhooksCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListWebhooksCommandInput} for command's `input` shape. + * @see {@link ListWebhooksCommandOutput} for command's `response` shape. + * @see {@link AmplifyClientResolvedConfig | config} for command's `input` shape. + * */ export class ListWebhooksCommand extends $Command< ListWebhooksCommandInput, diff --git a/clients/client-amplify/commands/StartDeploymentCommand.ts b/clients/client-amplify/commands/StartDeploymentCommand.ts index aebefad5a150..a5a07e455ad1 100644 --- a/clients/client-amplify/commands/StartDeploymentCommand.ts +++ b/clients/client-amplify/commands/StartDeploymentCommand.ts @@ -23,6 +23,20 @@ export interface StartDeploymentCommandOutput extends StartDeploymentResult, __M /** *

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

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { AmplifyClient, StartDeploymentCommand } from "@aws-sdk/client-amplify"; // ES Modules import + * // const { AmplifyClient, StartDeploymentCommand } = require("@aws-sdk/client-amplify"); // CommonJS import + * const client = new AmplifyClient(config); + * const command = new StartDeploymentCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link StartDeploymentCommandInput} for command's `input` shape. + * @see {@link StartDeploymentCommandOutput} for command's `response` shape. + * @see {@link AmplifyClientResolvedConfig | config} for command's `input` shape. + * */ export class StartDeploymentCommand extends $Command< StartDeploymentCommandInput, diff --git a/clients/client-amplify/commands/StartJobCommand.ts b/clients/client-amplify/commands/StartJobCommand.ts index 76c6819cb687..5f784d253e07 100644 --- a/clients/client-amplify/commands/StartJobCommand.ts +++ b/clients/client-amplify/commands/StartJobCommand.ts @@ -22,6 +22,20 @@ export interface StartJobCommandOutput extends StartJobResult, __MetadataBearer /** *

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

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { AmplifyClient, StartJobCommand } from "@aws-sdk/client-amplify"; // ES Modules import + * // const { AmplifyClient, StartJobCommand } = require("@aws-sdk/client-amplify"); // CommonJS import + * const client = new AmplifyClient(config); + * const command = new StartJobCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link StartJobCommandInput} for command's `input` shape. + * @see {@link StartJobCommandOutput} for command's `response` shape. + * @see {@link AmplifyClientResolvedConfig | config} for command's `input` shape. + * */ export class StartJobCommand extends $Command< StartJobCommandInput, diff --git a/clients/client-amplify/commands/StopJobCommand.ts b/clients/client-amplify/commands/StopJobCommand.ts index f398f818cb71..818c51ba02f5 100644 --- a/clients/client-amplify/commands/StopJobCommand.ts +++ b/clients/client-amplify/commands/StopJobCommand.ts @@ -22,6 +22,20 @@ export interface StopJobCommandOutput extends StopJobResult, __MetadataBearer {} /** *

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

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { AmplifyClient, StopJobCommand } from "@aws-sdk/client-amplify"; // ES Modules import + * // const { AmplifyClient, StopJobCommand } = require("@aws-sdk/client-amplify"); // CommonJS import + * const client = new AmplifyClient(config); + * const command = new StopJobCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link StopJobCommandInput} for command's `input` shape. + * @see {@link StopJobCommandOutput} for command's `response` shape. + * @see {@link AmplifyClientResolvedConfig | config} for command's `input` shape. + * */ export class StopJobCommand extends $Command { // Start section: command_properties diff --git a/clients/client-amplify/commands/TagResourceCommand.ts b/clients/client-amplify/commands/TagResourceCommand.ts index 428b2478caad..6e3c8f1ea9ea 100644 --- a/clients/client-amplify/commands/TagResourceCommand.ts +++ b/clients/client-amplify/commands/TagResourceCommand.ts @@ -22,6 +22,20 @@ export interface TagResourceCommandOutput extends TagResourceResponse, __Metadat /** *

Tags the resource with a tag key and value.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { AmplifyClient, TagResourceCommand } from "@aws-sdk/client-amplify"; // ES Modules import + * // const { AmplifyClient, TagResourceCommand } = require("@aws-sdk/client-amplify"); // CommonJS import + * const client = new AmplifyClient(config); + * const command = new TagResourceCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link TagResourceCommandInput} for command's `input` shape. + * @see {@link TagResourceCommandOutput} for command's `response` shape. + * @see {@link AmplifyClientResolvedConfig | config} for command's `input` shape. + * */ export class TagResourceCommand extends $Command< TagResourceCommandInput, diff --git a/clients/client-amplify/commands/UntagResourceCommand.ts b/clients/client-amplify/commands/UntagResourceCommand.ts index 1fcf4745de61..1a65fbe8452d 100644 --- a/clients/client-amplify/commands/UntagResourceCommand.ts +++ b/clients/client-amplify/commands/UntagResourceCommand.ts @@ -22,6 +22,20 @@ export interface UntagResourceCommandOutput extends UntagResourceResponse, __Met /** *

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

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { AmplifyClient, UntagResourceCommand } from "@aws-sdk/client-amplify"; // ES Modules import + * // const { AmplifyClient, UntagResourceCommand } = require("@aws-sdk/client-amplify"); // CommonJS import + * const client = new AmplifyClient(config); + * const command = new UntagResourceCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link UntagResourceCommandInput} for command's `input` shape. + * @see {@link UntagResourceCommandOutput} for command's `response` shape. + * @see {@link AmplifyClientResolvedConfig | config} for command's `input` shape. + * */ export class UntagResourceCommand extends $Command< UntagResourceCommandInput, diff --git a/clients/client-amplify/commands/UpdateAppCommand.ts b/clients/client-amplify/commands/UpdateAppCommand.ts index a8f6cdc1c048..ae2934e5e296 100644 --- a/clients/client-amplify/commands/UpdateAppCommand.ts +++ b/clients/client-amplify/commands/UpdateAppCommand.ts @@ -22,6 +22,20 @@ export interface UpdateAppCommandOutput extends UpdateAppResult, __MetadataBeare /** *

Updates an existing Amplify app.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { AmplifyClient, UpdateAppCommand } from "@aws-sdk/client-amplify"; // ES Modules import + * // const { AmplifyClient, UpdateAppCommand } = require("@aws-sdk/client-amplify"); // CommonJS import + * const client = new AmplifyClient(config); + * const command = new UpdateAppCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link UpdateAppCommandInput} for command's `input` shape. + * @see {@link UpdateAppCommandOutput} for command's `response` shape. + * @see {@link AmplifyClientResolvedConfig | config} for command's `input` shape. + * */ export class UpdateAppCommand extends $Command< UpdateAppCommandInput, diff --git a/clients/client-amplify/commands/UpdateBranchCommand.ts b/clients/client-amplify/commands/UpdateBranchCommand.ts index 7ea06037326a..9ff286bd1530 100644 --- a/clients/client-amplify/commands/UpdateBranchCommand.ts +++ b/clients/client-amplify/commands/UpdateBranchCommand.ts @@ -22,6 +22,20 @@ export interface UpdateBranchCommandOutput extends UpdateBranchResult, __Metadat /** *

Updates a branch for an Amplify app.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { AmplifyClient, UpdateBranchCommand } from "@aws-sdk/client-amplify"; // ES Modules import + * // const { AmplifyClient, UpdateBranchCommand } = require("@aws-sdk/client-amplify"); // CommonJS import + * const client = new AmplifyClient(config); + * const command = new UpdateBranchCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link UpdateBranchCommandInput} for command's `input` shape. + * @see {@link UpdateBranchCommandOutput} for command's `response` shape. + * @see {@link AmplifyClientResolvedConfig | config} for command's `input` shape. + * */ export class UpdateBranchCommand extends $Command< UpdateBranchCommandInput, diff --git a/clients/client-amplify/commands/UpdateDomainAssociationCommand.ts b/clients/client-amplify/commands/UpdateDomainAssociationCommand.ts index b6561605e166..c2e388f0987a 100644 --- a/clients/client-amplify/commands/UpdateDomainAssociationCommand.ts +++ b/clients/client-amplify/commands/UpdateDomainAssociationCommand.ts @@ -22,6 +22,20 @@ export interface UpdateDomainAssociationCommandOutput extends UpdateDomainAssoci /** *

Creates a new domain association for an Amplify app.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { AmplifyClient, UpdateDomainAssociationCommand } from "@aws-sdk/client-amplify"; // ES Modules import + * // const { AmplifyClient, UpdateDomainAssociationCommand } = require("@aws-sdk/client-amplify"); // CommonJS import + * const client = new AmplifyClient(config); + * const command = new UpdateDomainAssociationCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link UpdateDomainAssociationCommandInput} for command's `input` shape. + * @see {@link UpdateDomainAssociationCommandOutput} for command's `response` shape. + * @see {@link AmplifyClientResolvedConfig | config} for command's `input` shape. + * */ export class UpdateDomainAssociationCommand extends $Command< UpdateDomainAssociationCommandInput, diff --git a/clients/client-amplify/commands/UpdateWebhookCommand.ts b/clients/client-amplify/commands/UpdateWebhookCommand.ts index 4c3e3d1b4e8a..e023e5540c45 100644 --- a/clients/client-amplify/commands/UpdateWebhookCommand.ts +++ b/clients/client-amplify/commands/UpdateWebhookCommand.ts @@ -22,6 +22,20 @@ export interface UpdateWebhookCommandOutput extends UpdateWebhookResult, __Metad /** *

Updates a webhook.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { AmplifyClient, UpdateWebhookCommand } from "@aws-sdk/client-amplify"; // ES Modules import + * // const { AmplifyClient, UpdateWebhookCommand } = require("@aws-sdk/client-amplify"); // CommonJS import + * const client = new AmplifyClient(config); + * const command = new UpdateWebhookCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link UpdateWebhookCommandInput} for command's `input` shape. + * @see {@link UpdateWebhookCommandOutput} for command's `response` shape. + * @see {@link AmplifyClientResolvedConfig | config} for command's `input` shape. + * */ export class UpdateWebhookCommand extends $Command< UpdateWebhookCommandInput, diff --git a/clients/client-amplify/models/models_0.ts b/clients/client-amplify/models/models_0.ts index cdd84f24e27d..e86b95a4f2a4 100644 --- a/clients/client-amplify/models/models_0.ts +++ b/clients/client-amplify/models/models_0.ts @@ -11,6 +11,9 @@ export interface BadRequestException extends __SmithyException, $MetadataBearer } export namespace BadRequestException { + /** + * @internal + */ export const filterSensitiveLog = (obj: BadRequestException): any => ({ ...obj, }); @@ -81,6 +84,9 @@ export interface AutoBranchCreationConfig { } export namespace AutoBranchCreationConfig { + /** + * @internal + */ export const filterSensitiveLog = (obj: AutoBranchCreationConfig): any => ({ ...obj, ...(obj.basicAuthCredentials && { basicAuthCredentials: SENSITIVE_STRING }), @@ -136,6 +142,9 @@ export interface CustomRule { } export namespace CustomRule { + /** + * @internal + */ export const filterSensitiveLog = (obj: CustomRule): any => ({ ...obj, }); @@ -252,6 +261,9 @@ export interface CreateAppRequest { } export namespace CreateAppRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateAppRequest): any => ({ ...obj, ...(obj.oauthToken && { oauthToken: SENSITIVE_STRING }), @@ -289,6 +301,9 @@ export interface ProductionBranch { } export namespace ProductionBranch { + /** + * @internal + */ export const filterSensitiveLog = (obj: ProductionBranch): any => ({ ...obj, }); @@ -419,6 +434,9 @@ export interface App { } export namespace App { + /** + * @internal + */ export const filterSensitiveLog = (obj: App): any => ({ ...obj, ...(obj.basicAuthCredentials && { basicAuthCredentials: SENSITIVE_STRING }), @@ -437,6 +455,9 @@ export interface CreateAppResult { } export namespace CreateAppResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateAppResult): any => ({ ...obj, ...(obj.app && { app: App.filterSensitiveLog(obj.app) }), @@ -453,6 +474,9 @@ export interface DependentServiceFailureException extends __SmithyException, $Me } export namespace DependentServiceFailureException { + /** + * @internal + */ export const filterSensitiveLog = (obj: DependentServiceFailureException): any => ({ ...obj, }); @@ -468,6 +492,9 @@ export interface InternalFailureException extends __SmithyException, $MetadataBe } export namespace InternalFailureException { + /** + * @internal + */ export const filterSensitiveLog = (obj: InternalFailureException): any => ({ ...obj, }); @@ -483,6 +510,9 @@ export interface LimitExceededException extends __SmithyException, $MetadataBear } export namespace LimitExceededException { + /** + * @internal + */ export const filterSensitiveLog = (obj: LimitExceededException): any => ({ ...obj, }); @@ -498,6 +528,9 @@ export interface UnauthorizedException extends __SmithyException, $MetadataBeare } export namespace UnauthorizedException { + /** + * @internal + */ export const filterSensitiveLog = (obj: UnauthorizedException): any => ({ ...obj, }); @@ -529,6 +562,9 @@ export interface CreateBackendEnvironmentRequest { } export namespace CreateBackendEnvironmentRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateBackendEnvironmentRequest): any => ({ ...obj, }); @@ -573,6 +609,9 @@ export interface BackendEnvironment { } export namespace BackendEnvironment { + /** + * @internal + */ export const filterSensitiveLog = (obj: BackendEnvironment): any => ({ ...obj, }); @@ -589,6 +628,9 @@ export interface CreateBackendEnvironmentResult { } export namespace CreateBackendEnvironmentResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateBackendEnvironmentResult): any => ({ ...obj, }); @@ -604,6 +646,9 @@ export interface NotFoundException extends __SmithyException, $MetadataBearer { } export namespace NotFoundException { + /** + * @internal + */ export const filterSensitiveLog = (obj: NotFoundException): any => ({ ...obj, }); @@ -707,6 +752,9 @@ export interface CreateBranchRequest { } export namespace CreateBranchRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateBranchRequest): any => ({ ...obj, ...(obj.basicAuthCredentials && { basicAuthCredentials: SENSITIVE_STRING }), @@ -857,6 +905,9 @@ export interface Branch { } export namespace Branch { + /** + * @internal + */ export const filterSensitiveLog = (obj: Branch): any => ({ ...obj, ...(obj.basicAuthCredentials && { basicAuthCredentials: SENSITIVE_STRING }), @@ -875,6 +926,9 @@ export interface CreateBranchResult { } export namespace CreateBranchResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateBranchResult): any => ({ ...obj, ...(obj.branch && { branch: Branch.filterSensitiveLog(obj.branch) }), @@ -905,6 +959,9 @@ export interface CreateDeploymentRequest { } export namespace CreateDeploymentRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateDeploymentRequest): any => ({ ...obj, }); @@ -933,6 +990,9 @@ export interface CreateDeploymentResult { } export namespace CreateDeploymentResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateDeploymentResult): any => ({ ...obj, }); @@ -954,6 +1014,9 @@ export interface SubDomainSetting { } export namespace SubDomainSetting { + /** + * @internal + */ export const filterSensitiveLog = (obj: SubDomainSetting): any => ({ ...obj, }); @@ -996,6 +1059,9 @@ export interface CreateDomainAssociationRequest { } export namespace CreateDomainAssociationRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateDomainAssociationRequest): any => ({ ...obj, }); @@ -1033,6 +1099,9 @@ export interface SubDomain { } export namespace SubDomain { + /** + * @internal + */ export const filterSensitiveLog = (obj: SubDomain): any => ({ ...obj, }); @@ -1091,6 +1160,9 @@ export interface DomainAssociation { } export namespace DomainAssociation { + /** + * @internal + */ export const filterSensitiveLog = (obj: DomainAssociation): any => ({ ...obj, }); @@ -1108,6 +1180,9 @@ export interface CreateDomainAssociationResult { } export namespace CreateDomainAssociationResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateDomainAssociationResult): any => ({ ...obj, }); @@ -1134,6 +1209,9 @@ export interface CreateWebhookRequest { } export namespace CreateWebhookRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateWebhookRequest): any => ({ ...obj, }); @@ -1180,6 +1258,9 @@ export interface Webhook { } export namespace Webhook { + /** + * @internal + */ export const filterSensitiveLog = (obj: Webhook): any => ({ ...obj, }); @@ -1196,6 +1277,9 @@ export interface CreateWebhookResult { } export namespace CreateWebhookResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateWebhookResult): any => ({ ...obj, }); @@ -1212,6 +1296,9 @@ export interface DeleteAppRequest { } export namespace DeleteAppRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteAppRequest): any => ({ ...obj, }); @@ -1229,6 +1316,9 @@ export interface DeleteAppResult { } export namespace DeleteAppResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteAppResult): any => ({ ...obj, ...(obj.app && { app: App.filterSensitiveLog(obj.app) }), @@ -1251,6 +1341,9 @@ export interface DeleteBackendEnvironmentRequest { } export namespace DeleteBackendEnvironmentRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteBackendEnvironmentRequest): any => ({ ...obj, }); @@ -1267,6 +1360,9 @@ export interface DeleteBackendEnvironmentResult { } export namespace DeleteBackendEnvironmentResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteBackendEnvironmentResult): any => ({ ...obj, }); @@ -1288,6 +1384,9 @@ export interface DeleteBranchRequest { } export namespace DeleteBranchRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteBranchRequest): any => ({ ...obj, }); @@ -1304,6 +1403,9 @@ export interface DeleteBranchResult { } export namespace DeleteBranchResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteBranchResult): any => ({ ...obj, ...(obj.branch && { branch: Branch.filterSensitiveLog(obj.branch) }), @@ -1326,6 +1428,9 @@ export interface DeleteDomainAssociationRequest { } export namespace DeleteDomainAssociationRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteDomainAssociationRequest): any => ({ ...obj, }); @@ -1340,6 +1445,9 @@ export interface DeleteDomainAssociationResult { } export namespace DeleteDomainAssociationResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteDomainAssociationResult): any => ({ ...obj, }); @@ -1366,6 +1474,9 @@ export interface DeleteJobRequest { } export namespace DeleteJobRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteJobRequest): any => ({ ...obj, }); @@ -1443,6 +1554,9 @@ export interface JobSummary { } export namespace JobSummary { + /** + * @internal + */ export const filterSensitiveLog = (obj: JobSummary): any => ({ ...obj, }); @@ -1459,6 +1573,9 @@ export interface DeleteJobResult { } export namespace DeleteJobResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteJobResult): any => ({ ...obj, }); @@ -1475,6 +1592,9 @@ export interface DeleteWebhookRequest { } export namespace DeleteWebhookRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteWebhookRequest): any => ({ ...obj, }); @@ -1491,6 +1611,9 @@ export interface DeleteWebhookResult { } export namespace DeleteWebhookResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteWebhookResult): any => ({ ...obj, }); @@ -1524,6 +1647,9 @@ export interface GenerateAccessLogsRequest { } export namespace GenerateAccessLogsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GenerateAccessLogsRequest): any => ({ ...obj, }); @@ -1540,6 +1666,9 @@ export interface GenerateAccessLogsResult { } export namespace GenerateAccessLogsResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: GenerateAccessLogsResult): any => ({ ...obj, }); @@ -1556,6 +1685,9 @@ export interface GetAppRequest { } export namespace GetAppRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetAppRequest): any => ({ ...obj, }); @@ -1570,6 +1702,9 @@ export interface GetAppResult { } export namespace GetAppResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetAppResult): any => ({ ...obj, ...(obj.app && { app: App.filterSensitiveLog(obj.app) }), @@ -1587,6 +1722,9 @@ export interface GetArtifactUrlRequest { } export namespace GetArtifactUrlRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetArtifactUrlRequest): any => ({ ...obj, }); @@ -1608,6 +1746,9 @@ export interface GetArtifactUrlResult { } export namespace GetArtifactUrlResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetArtifactUrlResult): any => ({ ...obj, }); @@ -1629,6 +1770,9 @@ export interface GetBackendEnvironmentRequest { } export namespace GetBackendEnvironmentRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetBackendEnvironmentRequest): any => ({ ...obj, }); @@ -1645,6 +1789,9 @@ export interface GetBackendEnvironmentResult { } export namespace GetBackendEnvironmentResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetBackendEnvironmentResult): any => ({ ...obj, }); @@ -1666,6 +1813,9 @@ export interface GetBranchRequest { } export namespace GetBranchRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetBranchRequest): any => ({ ...obj, }); @@ -1679,6 +1829,9 @@ export interface GetBranchResult { } export namespace GetBranchResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetBranchResult): any => ({ ...obj, ...(obj.branch && { branch: Branch.filterSensitiveLog(obj.branch) }), @@ -1701,6 +1854,9 @@ export interface GetDomainAssociationRequest { } export namespace GetDomainAssociationRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetDomainAssociationRequest): any => ({ ...obj, }); @@ -1718,6 +1874,9 @@ export interface GetDomainAssociationResult { } export namespace GetDomainAssociationResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetDomainAssociationResult): any => ({ ...obj, }); @@ -1744,6 +1903,9 @@ export interface GetJobRequest { } export namespace GetJobRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetJobRequest): any => ({ ...obj, }); @@ -1811,6 +1973,9 @@ export interface Step { } export namespace Step { + /** + * @internal + */ export const filterSensitiveLog = (obj: Step): any => ({ ...obj, }); @@ -1832,6 +1997,9 @@ export interface Job { } export namespace Job { + /** + * @internal + */ export const filterSensitiveLog = (obj: Job): any => ({ ...obj, }); @@ -1845,6 +2013,9 @@ export interface GetJobResult { } export namespace GetJobResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetJobResult): any => ({ ...obj, }); @@ -1861,6 +2032,9 @@ export interface GetWebhookRequest { } export namespace GetWebhookRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetWebhookRequest): any => ({ ...obj, }); @@ -1877,6 +2051,9 @@ export interface GetWebhookResult { } export namespace GetWebhookResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetWebhookResult): any => ({ ...obj, }); @@ -1899,6 +2076,9 @@ export interface ListAppsRequest { } export namespace ListAppsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListAppsRequest): any => ({ ...obj, }); @@ -1922,6 +2102,9 @@ export interface ListAppsResult { } export namespace ListAppsResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListAppsResult): any => ({ ...obj, ...(obj.apps && { apps: obj.apps.map((item) => App.filterSensitiveLog(item)) }), @@ -1961,6 +2144,9 @@ export interface ListArtifactsRequest { } export namespace ListArtifactsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListArtifactsRequest): any => ({ ...obj, }); @@ -1982,6 +2168,9 @@ export interface Artifact { } export namespace Artifact { + /** + * @internal + */ export const filterSensitiveLog = (obj: Artifact): any => ({ ...obj, }); @@ -2004,6 +2193,9 @@ export interface ListArtifactsResult { } export namespace ListArtifactsResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListArtifactsResult): any => ({ ...obj, }); @@ -2037,6 +2229,9 @@ export interface ListBackendEnvironmentsRequest { } export namespace ListBackendEnvironmentsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListBackendEnvironmentsRequest): any => ({ ...obj, }); @@ -2059,6 +2254,9 @@ export interface ListBackendEnvironmentsResult { } export namespace ListBackendEnvironmentsResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListBackendEnvironmentsResult): any => ({ ...obj, }); @@ -2087,6 +2285,9 @@ export interface ListBranchesRequest { } export namespace ListBranchesRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListBranchesRequest): any => ({ ...obj, }); @@ -2109,6 +2310,9 @@ export interface ListBranchesResult { } export namespace ListBranchesResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListBranchesResult): any => ({ ...obj, ...(obj.branches && { branches: obj.branches.map((item) => Branch.filterSensitiveLog(item)) }), @@ -2138,6 +2342,9 @@ export interface ListDomainAssociationsRequest { } export namespace ListDomainAssociationsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListDomainAssociationsRequest): any => ({ ...obj, }); @@ -2160,6 +2367,9 @@ export interface ListDomainAssociationsResult { } export namespace ListDomainAssociationsResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListDomainAssociationsResult): any => ({ ...obj, }); @@ -2193,6 +2403,9 @@ export interface ListJobsRequest { } export namespace ListJobsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListJobsRequest): any => ({ ...obj, }); @@ -2215,6 +2428,9 @@ export interface ListJobsResult { } export namespace ListJobsResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListJobsResult): any => ({ ...obj, }); @@ -2231,6 +2447,9 @@ export interface ListTagsForResourceRequest { } export namespace ListTagsForResourceRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListTagsForResourceRequest): any => ({ ...obj, }); @@ -2247,6 +2466,9 @@ export interface ListTagsForResourceResponse { } export namespace ListTagsForResourceResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListTagsForResourceResponse): any => ({ ...obj, }); @@ -2263,6 +2485,9 @@ export interface ResourceNotFoundException extends __SmithyException, $MetadataB } export namespace ResourceNotFoundException { + /** + * @internal + */ export const filterSensitiveLog = (obj: ResourceNotFoundException): any => ({ ...obj, }); @@ -2291,6 +2516,9 @@ export interface ListWebhooksRequest { } export namespace ListWebhooksRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListWebhooksRequest): any => ({ ...obj, }); @@ -2313,6 +2541,9 @@ export interface ListWebhooksResult { } export namespace ListWebhooksResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListWebhooksResult): any => ({ ...obj, }); @@ -2346,6 +2577,9 @@ export interface StartDeploymentRequest { } export namespace StartDeploymentRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: StartDeploymentRequest): any => ({ ...obj, }); @@ -2362,6 +2596,9 @@ export interface StartDeploymentResult { } export namespace StartDeploymentResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: StartDeploymentResult): any => ({ ...obj, }); @@ -2418,6 +2655,9 @@ export interface StartJobRequest { } export namespace StartJobRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: StartJobRequest): any => ({ ...obj, }); @@ -2434,6 +2674,9 @@ export interface StartJobResult { } export namespace StartJobResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: StartJobResult): any => ({ ...obj, }); @@ -2460,6 +2703,9 @@ export interface StopJobRequest { } export namespace StopJobRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: StopJobRequest): any => ({ ...obj, }); @@ -2476,6 +2722,9 @@ export interface StopJobResult { } export namespace StopJobResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: StopJobResult): any => ({ ...obj, }); @@ -2497,6 +2746,9 @@ export interface TagResourceRequest { } export namespace TagResourceRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: TagResourceRequest): any => ({ ...obj, }); @@ -2508,6 +2760,9 @@ export namespace TagResourceRequest { export interface TagResourceResponse {} export namespace TagResourceResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: TagResourceResponse): any => ({ ...obj, }); @@ -2529,6 +2784,9 @@ export interface UntagResourceRequest { } export namespace UntagResourceRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: UntagResourceRequest): any => ({ ...obj, }); @@ -2540,6 +2798,9 @@ export namespace UntagResourceRequest { export interface UntagResourceResponse {} export namespace UntagResourceResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: UntagResourceResponse): any => ({ ...obj, }); @@ -2651,6 +2912,9 @@ export interface UpdateAppRequest { } export namespace UpdateAppRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateAppRequest): any => ({ ...obj, ...(obj.basicAuthCredentials && { basicAuthCredentials: SENSITIVE_STRING }), @@ -2673,6 +2937,9 @@ export interface UpdateAppResult { } export namespace UpdateAppResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateAppResult): any => ({ ...obj, ...(obj.app && { app: App.filterSensitiveLog(obj.app) }), @@ -2772,6 +3039,9 @@ export interface UpdateBranchRequest { } export namespace UpdateBranchRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateBranchRequest): any => ({ ...obj, ...(obj.basicAuthCredentials && { basicAuthCredentials: SENSITIVE_STRING }), @@ -2789,6 +3059,9 @@ export interface UpdateBranchResult { } export namespace UpdateBranchResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateBranchResult): any => ({ ...obj, ...(obj.branch && { branch: Branch.filterSensitiveLog(obj.branch) }), @@ -2832,6 +3105,9 @@ export interface UpdateDomainAssociationRequest { } export namespace UpdateDomainAssociationRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateDomainAssociationRequest): any => ({ ...obj, }); @@ -2849,6 +3125,9 @@ export interface UpdateDomainAssociationResult { } export namespace UpdateDomainAssociationResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateDomainAssociationResult): any => ({ ...obj, }); @@ -2875,6 +3154,9 @@ export interface UpdateWebhookRequest { } export namespace UpdateWebhookRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateWebhookRequest): any => ({ ...obj, }); @@ -2891,6 +3173,9 @@ export interface UpdateWebhookResult { } export namespace UpdateWebhookResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateWebhookResult): any => ({ ...obj, }); diff --git a/clients/client-amplifybackend/commands/CloneBackendCommand.ts b/clients/client-amplifybackend/commands/CloneBackendCommand.ts index 61308c51ae26..2d6e50edd097 100644 --- a/clients/client-amplifybackend/commands/CloneBackendCommand.ts +++ b/clients/client-amplifybackend/commands/CloneBackendCommand.ts @@ -22,6 +22,20 @@ export interface CloneBackendCommandOutput extends CloneBackendResponse, __Metad /** *

This operation clones an existing backend.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { AmplifyBackendClient, CloneBackendCommand } from "@aws-sdk/client-amplifybackend"; // ES Modules import + * // const { AmplifyBackendClient, CloneBackendCommand } = require("@aws-sdk/client-amplifybackend"); // CommonJS import + * const client = new AmplifyBackendClient(config); + * const command = new CloneBackendCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CloneBackendCommandInput} for command's `input` shape. + * @see {@link CloneBackendCommandOutput} for command's `response` shape. + * @see {@link AmplifyBackendClientResolvedConfig | config} for command's `input` shape. + * */ export class CloneBackendCommand extends $Command< CloneBackendCommandInput, diff --git a/clients/client-amplifybackend/commands/CreateBackendAPICommand.ts b/clients/client-amplifybackend/commands/CreateBackendAPICommand.ts index ad2cb391d717..a0844215c075 100644 --- a/clients/client-amplifybackend/commands/CreateBackendAPICommand.ts +++ b/clients/client-amplifybackend/commands/CreateBackendAPICommand.ts @@ -22,6 +22,20 @@ export interface CreateBackendAPICommandOutput extends CreateBackendAPIResponse, /** *

Creates a new backend API resource.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { AmplifyBackendClient, CreateBackendAPICommand } from "@aws-sdk/client-amplifybackend"; // ES Modules import + * // const { AmplifyBackendClient, CreateBackendAPICommand } = require("@aws-sdk/client-amplifybackend"); // CommonJS import + * const client = new AmplifyBackendClient(config); + * const command = new CreateBackendAPICommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreateBackendAPICommandInput} for command's `input` shape. + * @see {@link CreateBackendAPICommandOutput} for command's `response` shape. + * @see {@link AmplifyBackendClientResolvedConfig | config} for command's `input` shape. + * */ export class CreateBackendAPICommand extends $Command< CreateBackendAPICommandInput, diff --git a/clients/client-amplifybackend/commands/CreateBackendAuthCommand.ts b/clients/client-amplifybackend/commands/CreateBackendAuthCommand.ts index da7389db1203..c3fcaf17f0f3 100644 --- a/clients/client-amplifybackend/commands/CreateBackendAuthCommand.ts +++ b/clients/client-amplifybackend/commands/CreateBackendAuthCommand.ts @@ -22,6 +22,20 @@ export interface CreateBackendAuthCommandOutput extends CreateBackendAuthRespons /** *

Creates a new backend authentication resource.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { AmplifyBackendClient, CreateBackendAuthCommand } from "@aws-sdk/client-amplifybackend"; // ES Modules import + * // const { AmplifyBackendClient, CreateBackendAuthCommand } = require("@aws-sdk/client-amplifybackend"); // CommonJS import + * const client = new AmplifyBackendClient(config); + * const command = new CreateBackendAuthCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreateBackendAuthCommandInput} for command's `input` shape. + * @see {@link CreateBackendAuthCommandOutput} for command's `response` shape. + * @see {@link AmplifyBackendClientResolvedConfig | config} for command's `input` shape. + * */ export class CreateBackendAuthCommand extends $Command< CreateBackendAuthCommandInput, diff --git a/clients/client-amplifybackend/commands/CreateBackendCommand.ts b/clients/client-amplifybackend/commands/CreateBackendCommand.ts index 2a1333acff31..b71618037a26 100644 --- a/clients/client-amplifybackend/commands/CreateBackendCommand.ts +++ b/clients/client-amplifybackend/commands/CreateBackendCommand.ts @@ -22,6 +22,20 @@ export interface CreateBackendCommandOutput extends CreateBackendResponse, __Met /** *

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

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { AmplifyBackendClient, CreateBackendCommand } from "@aws-sdk/client-amplifybackend"; // ES Modules import + * // const { AmplifyBackendClient, CreateBackendCommand } = require("@aws-sdk/client-amplifybackend"); // CommonJS import + * const client = new AmplifyBackendClient(config); + * const command = new CreateBackendCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreateBackendCommandInput} for command's `input` shape. + * @see {@link CreateBackendCommandOutput} for command's `response` shape. + * @see {@link AmplifyBackendClientResolvedConfig | config} for command's `input` shape. + * */ export class CreateBackendCommand extends $Command< CreateBackendCommandInput, diff --git a/clients/client-amplifybackend/commands/CreateBackendConfigCommand.ts b/clients/client-amplifybackend/commands/CreateBackendConfigCommand.ts index 43bd70f4d496..37a3fb21c541 100644 --- a/clients/client-amplifybackend/commands/CreateBackendConfigCommand.ts +++ b/clients/client-amplifybackend/commands/CreateBackendConfigCommand.ts @@ -22,6 +22,20 @@ export interface CreateBackendConfigCommandOutput extends CreateBackendConfigRes /** *

Creates a config object for a backend.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { AmplifyBackendClient, CreateBackendConfigCommand } from "@aws-sdk/client-amplifybackend"; // ES Modules import + * // const { AmplifyBackendClient, CreateBackendConfigCommand } = require("@aws-sdk/client-amplifybackend"); // CommonJS import + * const client = new AmplifyBackendClient(config); + * const command = new CreateBackendConfigCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreateBackendConfigCommandInput} for command's `input` shape. + * @see {@link CreateBackendConfigCommandOutput} for command's `response` shape. + * @see {@link AmplifyBackendClientResolvedConfig | config} for command's `input` shape. + * */ export class CreateBackendConfigCommand extends $Command< CreateBackendConfigCommandInput, diff --git a/clients/client-amplifybackend/commands/CreateTokenCommand.ts b/clients/client-amplifybackend/commands/CreateTokenCommand.ts index 4c7f02349902..06060cc7efef 100644 --- a/clients/client-amplifybackend/commands/CreateTokenCommand.ts +++ b/clients/client-amplifybackend/commands/CreateTokenCommand.ts @@ -22,6 +22,20 @@ export interface CreateTokenCommandOutput extends CreateTokenResponse, __Metadat /** *

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

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { AmplifyBackendClient, CreateTokenCommand } from "@aws-sdk/client-amplifybackend"; // ES Modules import + * // const { AmplifyBackendClient, CreateTokenCommand } = require("@aws-sdk/client-amplifybackend"); // CommonJS import + * const client = new AmplifyBackendClient(config); + * const command = new CreateTokenCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreateTokenCommandInput} for command's `input` shape. + * @see {@link CreateTokenCommandOutput} for command's `response` shape. + * @see {@link AmplifyBackendClientResolvedConfig | config} for command's `input` shape. + * */ export class CreateTokenCommand extends $Command< CreateTokenCommandInput, diff --git a/clients/client-amplifybackend/commands/DeleteBackendAPICommand.ts b/clients/client-amplifybackend/commands/DeleteBackendAPICommand.ts index b0e0a0ad5a31..21e58c78f0a2 100644 --- a/clients/client-amplifybackend/commands/DeleteBackendAPICommand.ts +++ b/clients/client-amplifybackend/commands/DeleteBackendAPICommand.ts @@ -22,6 +22,20 @@ export interface DeleteBackendAPICommandOutput extends DeleteBackendAPIResponse, /** *

Deletes an existing backend API resource.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { AmplifyBackendClient, DeleteBackendAPICommand } from "@aws-sdk/client-amplifybackend"; // ES Modules import + * // const { AmplifyBackendClient, DeleteBackendAPICommand } = require("@aws-sdk/client-amplifybackend"); // CommonJS import + * const client = new AmplifyBackendClient(config); + * const command = new DeleteBackendAPICommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteBackendAPICommandInput} for command's `input` shape. + * @see {@link DeleteBackendAPICommandOutput} for command's `response` shape. + * @see {@link AmplifyBackendClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteBackendAPICommand extends $Command< DeleteBackendAPICommandInput, diff --git a/clients/client-amplifybackend/commands/DeleteBackendAuthCommand.ts b/clients/client-amplifybackend/commands/DeleteBackendAuthCommand.ts index dd104428ffba..ef75137219dc 100644 --- a/clients/client-amplifybackend/commands/DeleteBackendAuthCommand.ts +++ b/clients/client-amplifybackend/commands/DeleteBackendAuthCommand.ts @@ -22,6 +22,20 @@ export interface DeleteBackendAuthCommandOutput extends DeleteBackendAuthRespons /** *

Deletes an existing backend authentication resource.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { AmplifyBackendClient, DeleteBackendAuthCommand } from "@aws-sdk/client-amplifybackend"; // ES Modules import + * // const { AmplifyBackendClient, DeleteBackendAuthCommand } = require("@aws-sdk/client-amplifybackend"); // CommonJS import + * const client = new AmplifyBackendClient(config); + * const command = new DeleteBackendAuthCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteBackendAuthCommandInput} for command's `input` shape. + * @see {@link DeleteBackendAuthCommandOutput} for command's `response` shape. + * @see {@link AmplifyBackendClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteBackendAuthCommand extends $Command< DeleteBackendAuthCommandInput, diff --git a/clients/client-amplifybackend/commands/DeleteBackendCommand.ts b/clients/client-amplifybackend/commands/DeleteBackendCommand.ts index 1ac11765c0a0..3b667ee221a8 100644 --- a/clients/client-amplifybackend/commands/DeleteBackendCommand.ts +++ b/clients/client-amplifybackend/commands/DeleteBackendCommand.ts @@ -22,6 +22,20 @@ export interface DeleteBackendCommandOutput extends DeleteBackendResponse, __Met /** *

Removes an existing environment from your Amplify project.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { AmplifyBackendClient, DeleteBackendCommand } from "@aws-sdk/client-amplifybackend"; // ES Modules import + * // const { AmplifyBackendClient, DeleteBackendCommand } = require("@aws-sdk/client-amplifybackend"); // CommonJS import + * const client = new AmplifyBackendClient(config); + * const command = new DeleteBackendCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteBackendCommandInput} for command's `input` shape. + * @see {@link DeleteBackendCommandOutput} for command's `response` shape. + * @see {@link AmplifyBackendClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteBackendCommand extends $Command< DeleteBackendCommandInput, diff --git a/clients/client-amplifybackend/commands/DeleteTokenCommand.ts b/clients/client-amplifybackend/commands/DeleteTokenCommand.ts index afaa85f9e150..52120a45074d 100644 --- a/clients/client-amplifybackend/commands/DeleteTokenCommand.ts +++ b/clients/client-amplifybackend/commands/DeleteTokenCommand.ts @@ -22,6 +22,20 @@ export interface DeleteTokenCommandOutput extends DeleteTokenResponse, __Metadat /** *

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

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { AmplifyBackendClient, DeleteTokenCommand } from "@aws-sdk/client-amplifybackend"; // ES Modules import + * // const { AmplifyBackendClient, DeleteTokenCommand } = require("@aws-sdk/client-amplifybackend"); // CommonJS import + * const client = new AmplifyBackendClient(config); + * const command = new DeleteTokenCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteTokenCommandInput} for command's `input` shape. + * @see {@link DeleteTokenCommandOutput} for command's `response` shape. + * @see {@link AmplifyBackendClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteTokenCommand extends $Command< DeleteTokenCommandInput, diff --git a/clients/client-amplifybackend/commands/GenerateBackendAPIModelsCommand.ts b/clients/client-amplifybackend/commands/GenerateBackendAPIModelsCommand.ts index f15e939e6f8e..2a4fcb5eabb2 100644 --- a/clients/client-amplifybackend/commands/GenerateBackendAPIModelsCommand.ts +++ b/clients/client-amplifybackend/commands/GenerateBackendAPIModelsCommand.ts @@ -22,6 +22,20 @@ export interface GenerateBackendAPIModelsCommandOutput extends GenerateBackendAP /** *

Generates a model schema for an existing backend API resource.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { AmplifyBackendClient, GenerateBackendAPIModelsCommand } from "@aws-sdk/client-amplifybackend"; // ES Modules import + * // const { AmplifyBackendClient, GenerateBackendAPIModelsCommand } = require("@aws-sdk/client-amplifybackend"); // CommonJS import + * const client = new AmplifyBackendClient(config); + * const command = new GenerateBackendAPIModelsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GenerateBackendAPIModelsCommandInput} for command's `input` shape. + * @see {@link GenerateBackendAPIModelsCommandOutput} for command's `response` shape. + * @see {@link AmplifyBackendClientResolvedConfig | config} for command's `input` shape. + * */ export class GenerateBackendAPIModelsCommand extends $Command< GenerateBackendAPIModelsCommandInput, diff --git a/clients/client-amplifybackend/commands/GetBackendAPICommand.ts b/clients/client-amplifybackend/commands/GetBackendAPICommand.ts index 41706f524ec8..147b7f3aa9c3 100644 --- a/clients/client-amplifybackend/commands/GetBackendAPICommand.ts +++ b/clients/client-amplifybackend/commands/GetBackendAPICommand.ts @@ -22,6 +22,20 @@ export interface GetBackendAPICommandOutput extends GetBackendAPIResponse, __Met /** *

Gets the details for a backend API.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { AmplifyBackendClient, GetBackendAPICommand } from "@aws-sdk/client-amplifybackend"; // ES Modules import + * // const { AmplifyBackendClient, GetBackendAPICommand } = require("@aws-sdk/client-amplifybackend"); // CommonJS import + * const client = new AmplifyBackendClient(config); + * const command = new GetBackendAPICommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetBackendAPICommandInput} for command's `input` shape. + * @see {@link GetBackendAPICommandOutput} for command's `response` shape. + * @see {@link AmplifyBackendClientResolvedConfig | config} for command's `input` shape. + * */ export class GetBackendAPICommand extends $Command< GetBackendAPICommandInput, diff --git a/clients/client-amplifybackend/commands/GetBackendAPIModelsCommand.ts b/clients/client-amplifybackend/commands/GetBackendAPIModelsCommand.ts index c16847139340..e17add002f43 100644 --- a/clients/client-amplifybackend/commands/GetBackendAPIModelsCommand.ts +++ b/clients/client-amplifybackend/commands/GetBackendAPIModelsCommand.ts @@ -22,6 +22,20 @@ export interface GetBackendAPIModelsCommandOutput extends GetBackendAPIModelsRes /** *

Generates a model schema for existing backend API resource.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { AmplifyBackendClient, GetBackendAPIModelsCommand } from "@aws-sdk/client-amplifybackend"; // ES Modules import + * // const { AmplifyBackendClient, GetBackendAPIModelsCommand } = require("@aws-sdk/client-amplifybackend"); // CommonJS import + * const client = new AmplifyBackendClient(config); + * const command = new GetBackendAPIModelsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetBackendAPIModelsCommandInput} for command's `input` shape. + * @see {@link GetBackendAPIModelsCommandOutput} for command's `response` shape. + * @see {@link AmplifyBackendClientResolvedConfig | config} for command's `input` shape. + * */ export class GetBackendAPIModelsCommand extends $Command< GetBackendAPIModelsCommandInput, diff --git a/clients/client-amplifybackend/commands/GetBackendAuthCommand.ts b/clients/client-amplifybackend/commands/GetBackendAuthCommand.ts index 2f8aa2c54dab..49825d0fccd9 100644 --- a/clients/client-amplifybackend/commands/GetBackendAuthCommand.ts +++ b/clients/client-amplifybackend/commands/GetBackendAuthCommand.ts @@ -22,6 +22,20 @@ export interface GetBackendAuthCommandOutput extends GetBackendAuthResponse, __M /** *

Gets backend auth details.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { AmplifyBackendClient, GetBackendAuthCommand } from "@aws-sdk/client-amplifybackend"; // ES Modules import + * // const { AmplifyBackendClient, GetBackendAuthCommand } = require("@aws-sdk/client-amplifybackend"); // CommonJS import + * const client = new AmplifyBackendClient(config); + * const command = new GetBackendAuthCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetBackendAuthCommandInput} for command's `input` shape. + * @see {@link GetBackendAuthCommandOutput} for command's `response` shape. + * @see {@link AmplifyBackendClientResolvedConfig | config} for command's `input` shape. + * */ export class GetBackendAuthCommand extends $Command< GetBackendAuthCommandInput, diff --git a/clients/client-amplifybackend/commands/GetBackendCommand.ts b/clients/client-amplifybackend/commands/GetBackendCommand.ts index 077c40500692..6b6ff2405e9c 100644 --- a/clients/client-amplifybackend/commands/GetBackendCommand.ts +++ b/clients/client-amplifybackend/commands/GetBackendCommand.ts @@ -22,6 +22,20 @@ export interface GetBackendCommandOutput extends GetBackendResponse, __MetadataB /** *

Provides project-level details for your Amplify UI project.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { AmplifyBackendClient, GetBackendCommand } from "@aws-sdk/client-amplifybackend"; // ES Modules import + * // const { AmplifyBackendClient, GetBackendCommand } = require("@aws-sdk/client-amplifybackend"); // CommonJS import + * const client = new AmplifyBackendClient(config); + * const command = new GetBackendCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetBackendCommandInput} for command's `input` shape. + * @see {@link GetBackendCommandOutput} for command's `response` shape. + * @see {@link AmplifyBackendClientResolvedConfig | config} for command's `input` shape. + * */ export class GetBackendCommand extends $Command< GetBackendCommandInput, diff --git a/clients/client-amplifybackend/commands/GetBackendJobCommand.ts b/clients/client-amplifybackend/commands/GetBackendJobCommand.ts index 599a5a94d292..4ff1532ab5b3 100644 --- a/clients/client-amplifybackend/commands/GetBackendJobCommand.ts +++ b/clients/client-amplifybackend/commands/GetBackendJobCommand.ts @@ -22,6 +22,20 @@ export interface GetBackendJobCommandOutput extends GetBackendJobResponse, __Met /** *

Returns information about a specific job.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { AmplifyBackendClient, GetBackendJobCommand } from "@aws-sdk/client-amplifybackend"; // ES Modules import + * // const { AmplifyBackendClient, GetBackendJobCommand } = require("@aws-sdk/client-amplifybackend"); // CommonJS import + * const client = new AmplifyBackendClient(config); + * const command = new GetBackendJobCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetBackendJobCommandInput} for command's `input` shape. + * @see {@link GetBackendJobCommandOutput} for command's `response` shape. + * @see {@link AmplifyBackendClientResolvedConfig | config} for command's `input` shape. + * */ export class GetBackendJobCommand extends $Command< GetBackendJobCommandInput, diff --git a/clients/client-amplifybackend/commands/GetTokenCommand.ts b/clients/client-amplifybackend/commands/GetTokenCommand.ts index f351f42a6df4..b4834422d322 100644 --- a/clients/client-amplifybackend/commands/GetTokenCommand.ts +++ b/clients/client-amplifybackend/commands/GetTokenCommand.ts @@ -22,6 +22,20 @@ export interface GetTokenCommandOutput extends GetTokenResponse, __MetadataBeare /** *

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

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { AmplifyBackendClient, GetTokenCommand } from "@aws-sdk/client-amplifybackend"; // ES Modules import + * // const { AmplifyBackendClient, GetTokenCommand } = require("@aws-sdk/client-amplifybackend"); // CommonJS import + * const client = new AmplifyBackendClient(config); + * const command = new GetTokenCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetTokenCommandInput} for command's `input` shape. + * @see {@link GetTokenCommandOutput} for command's `response` shape. + * @see {@link AmplifyBackendClientResolvedConfig | config} for command's `input` shape. + * */ export class GetTokenCommand extends $Command< GetTokenCommandInput, diff --git a/clients/client-amplifybackend/commands/ListBackendJobsCommand.ts b/clients/client-amplifybackend/commands/ListBackendJobsCommand.ts index aa4cdafbbb31..12e1d546dcd9 100644 --- a/clients/client-amplifybackend/commands/ListBackendJobsCommand.ts +++ b/clients/client-amplifybackend/commands/ListBackendJobsCommand.ts @@ -22,6 +22,20 @@ export interface ListBackendJobsCommandOutput extends ListBackendJobsResponse, _ /** *

Lists the jobs for the backend of an Amplify app.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { AmplifyBackendClient, ListBackendJobsCommand } from "@aws-sdk/client-amplifybackend"; // ES Modules import + * // const { AmplifyBackendClient, ListBackendJobsCommand } = require("@aws-sdk/client-amplifybackend"); // CommonJS import + * const client = new AmplifyBackendClient(config); + * const command = new ListBackendJobsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListBackendJobsCommandInput} for command's `input` shape. + * @see {@link ListBackendJobsCommandOutput} for command's `response` shape. + * @see {@link AmplifyBackendClientResolvedConfig | config} for command's `input` shape. + * */ export class ListBackendJobsCommand extends $Command< ListBackendJobsCommandInput, diff --git a/clients/client-amplifybackend/commands/RemoveAllBackendsCommand.ts b/clients/client-amplifybackend/commands/RemoveAllBackendsCommand.ts index 3c11f92e9b1c..3bb12128846d 100644 --- a/clients/client-amplifybackend/commands/RemoveAllBackendsCommand.ts +++ b/clients/client-amplifybackend/commands/RemoveAllBackendsCommand.ts @@ -22,6 +22,20 @@ export interface RemoveAllBackendsCommandOutput extends RemoveAllBackendsRespons /** *

Removes all backend environments from your Amplify project.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { AmplifyBackendClient, RemoveAllBackendsCommand } from "@aws-sdk/client-amplifybackend"; // ES Modules import + * // const { AmplifyBackendClient, RemoveAllBackendsCommand } = require("@aws-sdk/client-amplifybackend"); // CommonJS import + * const client = new AmplifyBackendClient(config); + * const command = new RemoveAllBackendsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link RemoveAllBackendsCommandInput} for command's `input` shape. + * @see {@link RemoveAllBackendsCommandOutput} for command's `response` shape. + * @see {@link AmplifyBackendClientResolvedConfig | config} for command's `input` shape. + * */ export class RemoveAllBackendsCommand extends $Command< RemoveAllBackendsCommandInput, diff --git a/clients/client-amplifybackend/commands/RemoveBackendConfigCommand.ts b/clients/client-amplifybackend/commands/RemoveBackendConfigCommand.ts index e02edb823183..c0ff791ca942 100644 --- a/clients/client-amplifybackend/commands/RemoveBackendConfigCommand.ts +++ b/clients/client-amplifybackend/commands/RemoveBackendConfigCommand.ts @@ -22,6 +22,20 @@ export interface RemoveBackendConfigCommandOutput extends RemoveBackendConfigRes /** *

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

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { AmplifyBackendClient, RemoveBackendConfigCommand } from "@aws-sdk/client-amplifybackend"; // ES Modules import + * // const { AmplifyBackendClient, RemoveBackendConfigCommand } = require("@aws-sdk/client-amplifybackend"); // CommonJS import + * const client = new AmplifyBackendClient(config); + * const command = new RemoveBackendConfigCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link RemoveBackendConfigCommandInput} for command's `input` shape. + * @see {@link RemoveBackendConfigCommandOutput} for command's `response` shape. + * @see {@link AmplifyBackendClientResolvedConfig | config} for command's `input` shape. + * */ export class RemoveBackendConfigCommand extends $Command< RemoveBackendConfigCommandInput, diff --git a/clients/client-amplifybackend/commands/UpdateBackendAPICommand.ts b/clients/client-amplifybackend/commands/UpdateBackendAPICommand.ts index 933515e8efb5..f9eab3b2551b 100644 --- a/clients/client-amplifybackend/commands/UpdateBackendAPICommand.ts +++ b/clients/client-amplifybackend/commands/UpdateBackendAPICommand.ts @@ -22,6 +22,20 @@ export interface UpdateBackendAPICommandOutput extends UpdateBackendAPIResponse, /** *

Updates an existing backend API resource.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { AmplifyBackendClient, UpdateBackendAPICommand } from "@aws-sdk/client-amplifybackend"; // ES Modules import + * // const { AmplifyBackendClient, UpdateBackendAPICommand } = require("@aws-sdk/client-amplifybackend"); // CommonJS import + * const client = new AmplifyBackendClient(config); + * const command = new UpdateBackendAPICommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link UpdateBackendAPICommandInput} for command's `input` shape. + * @see {@link UpdateBackendAPICommandOutput} for command's `response` shape. + * @see {@link AmplifyBackendClientResolvedConfig | config} for command's `input` shape. + * */ export class UpdateBackendAPICommand extends $Command< UpdateBackendAPICommandInput, diff --git a/clients/client-amplifybackend/commands/UpdateBackendAuthCommand.ts b/clients/client-amplifybackend/commands/UpdateBackendAuthCommand.ts index e7796b129c38..393a0e8966df 100644 --- a/clients/client-amplifybackend/commands/UpdateBackendAuthCommand.ts +++ b/clients/client-amplifybackend/commands/UpdateBackendAuthCommand.ts @@ -22,6 +22,20 @@ export interface UpdateBackendAuthCommandOutput extends UpdateBackendAuthRespons /** *

Updates an existing backend authentication resource.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { AmplifyBackendClient, UpdateBackendAuthCommand } from "@aws-sdk/client-amplifybackend"; // ES Modules import + * // const { AmplifyBackendClient, UpdateBackendAuthCommand } = require("@aws-sdk/client-amplifybackend"); // CommonJS import + * const client = new AmplifyBackendClient(config); + * const command = new UpdateBackendAuthCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link UpdateBackendAuthCommandInput} for command's `input` shape. + * @see {@link UpdateBackendAuthCommandOutput} for command's `response` shape. + * @see {@link AmplifyBackendClientResolvedConfig | config} for command's `input` shape. + * */ export class UpdateBackendAuthCommand extends $Command< UpdateBackendAuthCommandInput, diff --git a/clients/client-amplifybackend/commands/UpdateBackendConfigCommand.ts b/clients/client-amplifybackend/commands/UpdateBackendConfigCommand.ts index b63c4e483295..72181a2d1765 100644 --- a/clients/client-amplifybackend/commands/UpdateBackendConfigCommand.ts +++ b/clients/client-amplifybackend/commands/UpdateBackendConfigCommand.ts @@ -22,6 +22,20 @@ export interface UpdateBackendConfigCommandOutput extends UpdateBackendConfigRes /** *

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

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { AmplifyBackendClient, UpdateBackendConfigCommand } from "@aws-sdk/client-amplifybackend"; // ES Modules import + * // const { AmplifyBackendClient, UpdateBackendConfigCommand } = require("@aws-sdk/client-amplifybackend"); // CommonJS import + * const client = new AmplifyBackendClient(config); + * const command = new UpdateBackendConfigCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link UpdateBackendConfigCommandInput} for command's `input` shape. + * @see {@link UpdateBackendConfigCommandOutput} for command's `response` shape. + * @see {@link AmplifyBackendClientResolvedConfig | config} for command's `input` shape. + * */ export class UpdateBackendConfigCommand extends $Command< UpdateBackendConfigCommandInput, diff --git a/clients/client-amplifybackend/commands/UpdateBackendJobCommand.ts b/clients/client-amplifybackend/commands/UpdateBackendJobCommand.ts index 55ad1b6111d8..37c243d7c7f6 100644 --- a/clients/client-amplifybackend/commands/UpdateBackendJobCommand.ts +++ b/clients/client-amplifybackend/commands/UpdateBackendJobCommand.ts @@ -22,6 +22,20 @@ export interface UpdateBackendJobCommandOutput extends UpdateBackendJobResponse, /** *

Updates a specific job.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { AmplifyBackendClient, UpdateBackendJobCommand } from "@aws-sdk/client-amplifybackend"; // ES Modules import + * // const { AmplifyBackendClient, UpdateBackendJobCommand } = require("@aws-sdk/client-amplifybackend"); // CommonJS import + * const client = new AmplifyBackendClient(config); + * const command = new UpdateBackendJobCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link UpdateBackendJobCommandInput} for command's `input` shape. + * @see {@link UpdateBackendJobCommandOutput} for command's `response` shape. + * @see {@link AmplifyBackendClientResolvedConfig | config} for command's `input` shape. + * */ export class UpdateBackendJobCommand extends $Command< UpdateBackendJobCommandInput, diff --git a/clients/client-amplifybackend/models/models_0.ts b/clients/client-amplifybackend/models/models_0.ts index 1da7504afe42..4c1719575257 100644 --- a/clients/client-amplifybackend/models/models_0.ts +++ b/clients/client-amplifybackend/models/models_0.ts @@ -21,6 +21,9 @@ export interface BadRequestException extends __SmithyException, $MetadataBearer } export namespace BadRequestException { + /** + * @internal + */ export const filterSensitiveLog = (obj: BadRequestException): any => ({ ...obj, }); @@ -47,6 +50,9 @@ export interface CloneBackendRequest { } export namespace CloneBackendRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: CloneBackendRequest): any => ({ ...obj, }); @@ -85,6 +91,9 @@ export interface CloneBackendResponse { } export namespace CloneBackendResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: CloneBackendResponse): any => ({ ...obj, }); @@ -103,6 +112,9 @@ export interface GatewayTimeoutException extends __SmithyException, $MetadataBea } export namespace GatewayTimeoutException { + /** + * @internal + */ export const filterSensitiveLog = (obj: GatewayTimeoutException): any => ({ ...obj, }); @@ -126,6 +138,9 @@ export interface NotFoundException extends __SmithyException, $MetadataBearer { } export namespace NotFoundException { + /** + * @internal + */ export const filterSensitiveLog = (obj: NotFoundException): any => ({ ...obj, }); @@ -149,6 +164,9 @@ export interface TooManyRequestsException extends __SmithyException, $MetadataBe } export namespace TooManyRequestsException { + /** + * @internal + */ export const filterSensitiveLog = (obj: TooManyRequestsException): any => ({ ...obj, }); @@ -160,6 +178,9 @@ export namespace TooManyRequestsException { export interface ResourceConfig {} export namespace ResourceConfig { + /** + * @internal + */ export const filterSensitiveLog = (obj: ResourceConfig): any => ({ ...obj, }); @@ -196,6 +217,9 @@ export interface CreateBackendRequest { } export namespace CreateBackendRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateBackendRequest): any => ({ ...obj, }); @@ -234,6 +258,9 @@ export interface CreateBackendResponse { } export namespace CreateBackendResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateBackendResponse): any => ({ ...obj, }); @@ -292,6 +319,9 @@ export interface BackendAPIAppSyncAuthSettings { } export namespace BackendAPIAppSyncAuthSettings { + /** + * @internal + */ export const filterSensitiveLog = (obj: BackendAPIAppSyncAuthSettings): any => ({ ...obj, }); @@ -313,6 +343,9 @@ export interface BackendAPIAuthType { } export namespace BackendAPIAuthType { + /** + * @internal + */ export const filterSensitiveLog = (obj: BackendAPIAuthType): any => ({ ...obj, }); @@ -336,6 +369,9 @@ export interface BackendAPIConflictResolution { } export namespace BackendAPIConflictResolution { + /** + * @internal + */ export const filterSensitiveLog = (obj: BackendAPIConflictResolution): any => ({ ...obj, }); @@ -377,6 +413,9 @@ export interface BackendAPIResourceConfig { } export namespace BackendAPIResourceConfig { + /** + * @internal + */ export const filterSensitiveLog = (obj: BackendAPIResourceConfig): any => ({ ...obj, }); @@ -408,6 +447,9 @@ export interface CreateBackendAPIRequest { } export namespace CreateBackendAPIRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateBackendAPIRequest): any => ({ ...obj, }); @@ -446,6 +488,9 @@ export interface CreateBackendAPIResponse { } export namespace CreateBackendAPIResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateBackendAPIResponse): any => ({ ...obj, }); @@ -472,6 +517,9 @@ export interface CreateBackendAuthIdentityPoolConfig { } export namespace CreateBackendAuthIdentityPoolConfig { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateBackendAuthIdentityPoolConfig): any => ({ ...obj, }); @@ -502,6 +550,9 @@ export interface EmailSettings { } export namespace EmailSettings { + /** + * @internal + */ export const filterSensitiveLog = (obj: EmailSettings): any => ({ ...obj, }); @@ -518,6 +569,9 @@ export interface SmsSettings { } export namespace SmsSettings { + /** + * @internal + */ export const filterSensitiveLog = (obj: SmsSettings): any => ({ ...obj, }); @@ -544,6 +598,9 @@ export interface CreateBackendAuthForgotPasswordConfig { } export namespace CreateBackendAuthForgotPasswordConfig { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateBackendAuthForgotPasswordConfig): any => ({ ...obj, }); @@ -576,6 +633,9 @@ export interface Settings { } export namespace Settings { + /** + * @internal + */ export const filterSensitiveLog = (obj: Settings): any => ({ ...obj, }); @@ -597,6 +657,9 @@ export interface CreateBackendAuthMFAConfig { } export namespace CreateBackendAuthMFAConfig { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateBackendAuthMFAConfig): any => ({ ...obj, }); @@ -631,6 +694,9 @@ export interface BackendAuthSocialProviderConfig { } export namespace BackendAuthSocialProviderConfig { + /** + * @internal + */ export const filterSensitiveLog = (obj: BackendAuthSocialProviderConfig): any => ({ ...obj, }); @@ -657,6 +723,9 @@ export interface SocialProviderSettings { } export namespace SocialProviderSettings { + /** + * @internal + */ export const filterSensitiveLog = (obj: SocialProviderSettings): any => ({ ...obj, }); @@ -698,6 +767,9 @@ export interface CreateBackendAuthOAuthConfig { } export namespace CreateBackendAuthOAuthConfig { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateBackendAuthOAuthConfig): any => ({ ...obj, }); @@ -719,6 +791,9 @@ export interface CreateBackendAuthPasswordPolicyConfig { } export namespace CreateBackendAuthPasswordPolicyConfig { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateBackendAuthPasswordPolicyConfig): any => ({ ...obj, }); @@ -792,6 +867,9 @@ export interface CreateBackendAuthUserPoolConfig { } export namespace CreateBackendAuthUserPoolConfig { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateBackendAuthUserPoolConfig): any => ({ ...obj, }); @@ -823,6 +901,9 @@ export interface CreateBackendAuthResourceConfig { } export namespace CreateBackendAuthResourceConfig { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateBackendAuthResourceConfig): any => ({ ...obj, }); @@ -854,6 +935,9 @@ export interface CreateBackendAuthRequest { } export namespace CreateBackendAuthRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateBackendAuthRequest): any => ({ ...obj, }); @@ -892,6 +976,9 @@ export interface CreateBackendAuthResponse { } export namespace CreateBackendAuthResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateBackendAuthResponse): any => ({ ...obj, }); @@ -913,6 +1000,9 @@ export interface CreateBackendConfigRequest { } export namespace CreateBackendConfigRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateBackendConfigRequest): any => ({ ...obj, }); @@ -941,6 +1031,9 @@ export interface CreateBackendConfigResponse { } export namespace CreateBackendConfigResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateBackendConfigResponse): any => ({ ...obj, }); @@ -954,6 +1047,9 @@ export interface CreateTokenRequest { } export namespace CreateTokenRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateTokenRequest): any => ({ ...obj, }); @@ -982,6 +1078,9 @@ export interface CreateTokenResponse { } export namespace CreateTokenResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateTokenResponse): any => ({ ...obj, }); @@ -1000,6 +1099,9 @@ export interface DeleteBackendRequest { } export namespace DeleteBackendRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteBackendRequest): any => ({ ...obj, }); @@ -1038,6 +1140,9 @@ export interface DeleteBackendResponse { } export namespace DeleteBackendResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteBackendResponse): any => ({ ...obj, }); @@ -1069,6 +1174,9 @@ export interface DeleteBackendAPIRequest { } export namespace DeleteBackendAPIRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteBackendAPIRequest): any => ({ ...obj, }); @@ -1107,6 +1215,9 @@ export interface DeleteBackendAPIResponse { } export namespace DeleteBackendAPIResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteBackendAPIResponse): any => ({ ...obj, }); @@ -1133,6 +1244,9 @@ export interface DeleteBackendAuthRequest { } export namespace DeleteBackendAuthRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteBackendAuthRequest): any => ({ ...obj, }); @@ -1171,6 +1285,9 @@ export interface DeleteBackendAuthResponse { } export namespace DeleteBackendAuthResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteBackendAuthResponse): any => ({ ...obj, }); @@ -1189,6 +1306,9 @@ export interface DeleteTokenRequest { } export namespace DeleteTokenRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteTokenRequest): any => ({ ...obj, }); @@ -1202,6 +1322,9 @@ export interface DeleteTokenResponse { } export namespace DeleteTokenResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteTokenResponse): any => ({ ...obj, }); @@ -1228,6 +1351,9 @@ export interface GenerateBackendAPIModelsRequest { } export namespace GenerateBackendAPIModelsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GenerateBackendAPIModelsRequest): any => ({ ...obj, }); @@ -1266,6 +1392,9 @@ export interface GenerateBackendAPIModelsResponse { } export namespace GenerateBackendAPIModelsResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: GenerateBackendAPIModelsResponse): any => ({ ...obj, }); @@ -1287,6 +1416,9 @@ export interface GetBackendRequest { } export namespace GetBackendRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetBackendRequest): any => ({ ...obj, }); @@ -1325,6 +1457,9 @@ export interface GetBackendResponse { } export namespace GetBackendResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetBackendResponse): any => ({ ...obj, }); @@ -1356,6 +1491,9 @@ export interface GetBackendAPIRequest { } export namespace GetBackendAPIRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetBackendAPIRequest): any => ({ ...obj, }); @@ -1389,6 +1527,9 @@ export interface GetBackendAPIResponse { } export namespace GetBackendAPIResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetBackendAPIResponse): any => ({ ...obj, }); @@ -1415,6 +1556,9 @@ export interface GetBackendAPIModelsRequest { } export namespace GetBackendAPIModelsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetBackendAPIModelsRequest): any => ({ ...obj, }); @@ -1438,6 +1582,9 @@ export interface GetBackendAPIModelsResponse { } export namespace GetBackendAPIModelsResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetBackendAPIModelsResponse): any => ({ ...obj, }); @@ -1464,6 +1611,9 @@ export interface GetBackendAuthRequest { } export namespace GetBackendAuthRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetBackendAuthRequest): any => ({ ...obj, }); @@ -1497,6 +1647,9 @@ export interface GetBackendAuthResponse { } export namespace GetBackendAuthResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetBackendAuthResponse): any => ({ ...obj, }); @@ -1520,6 +1673,9 @@ export interface GetBackendJobRequest { } export namespace GetBackendJobRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetBackendJobRequest): any => ({ ...obj, }); @@ -1568,6 +1724,9 @@ export interface GetBackendJobResponse { } export namespace GetBackendJobResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetBackendJobResponse): any => ({ ...obj, }); @@ -1586,6 +1745,9 @@ export interface GetTokenRequest { } export namespace GetTokenRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetTokenRequest): any => ({ ...obj, }); @@ -1614,6 +1776,9 @@ export interface GetTokenResponse { } export namespace GetTokenResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetTokenResponse): any => ({ ...obj, }); @@ -1660,6 +1825,9 @@ export interface ListBackendJobsRequest { } export namespace ListBackendJobsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListBackendJobsRequest): any => ({ ...obj, }); @@ -1711,6 +1879,9 @@ export interface BackendJobRespObj { } export namespace BackendJobRespObj { + /** + * @internal + */ export const filterSensitiveLog = (obj: BackendJobRespObj): any => ({ ...obj, }); @@ -1729,6 +1900,9 @@ export interface ListBackendJobsResponse { } export namespace ListBackendJobsResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListBackendJobsResponse): any => ({ ...obj, }); @@ -1750,6 +1924,9 @@ export interface RemoveAllBackendsRequest { } export namespace RemoveAllBackendsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: RemoveAllBackendsRequest): any => ({ ...obj, }); @@ -1783,6 +1960,9 @@ export interface RemoveAllBackendsResponse { } export namespace RemoveAllBackendsResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: RemoveAllBackendsResponse): any => ({ ...obj, }); @@ -1796,6 +1976,9 @@ export interface RemoveBackendConfigRequest { } export namespace RemoveBackendConfigRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: RemoveBackendConfigRequest): any => ({ ...obj, }); @@ -1809,6 +1992,9 @@ export interface RemoveBackendConfigResponse { } export namespace RemoveBackendConfigResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: RemoveBackendConfigResponse): any => ({ ...obj, }); @@ -1840,6 +2026,9 @@ export interface UpdateBackendAPIRequest { } export namespace UpdateBackendAPIRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateBackendAPIRequest): any => ({ ...obj, }); @@ -1878,6 +2067,9 @@ export interface UpdateBackendAPIResponse { } export namespace UpdateBackendAPIResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateBackendAPIResponse): any => ({ ...obj, }); @@ -1894,6 +2086,9 @@ export interface UpdateBackendAuthIdentityPoolConfig { } export namespace UpdateBackendAuthIdentityPoolConfig { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateBackendAuthIdentityPoolConfig): any => ({ ...obj, }); @@ -1920,6 +2115,9 @@ export interface UpdateBackendAuthForgotPasswordConfig { } export namespace UpdateBackendAuthForgotPasswordConfig { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateBackendAuthForgotPasswordConfig): any => ({ ...obj, }); @@ -1941,6 +2139,9 @@ export interface UpdateBackendAuthMFAConfig { } export namespace UpdateBackendAuthMFAConfig { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateBackendAuthMFAConfig): any => ({ ...obj, }); @@ -1982,6 +2183,9 @@ export interface UpdateBackendAuthOAuthConfig { } export namespace UpdateBackendAuthOAuthConfig { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateBackendAuthOAuthConfig): any => ({ ...obj, }); @@ -2003,6 +2207,9 @@ export interface UpdateBackendAuthPasswordPolicyConfig { } export namespace UpdateBackendAuthPasswordPolicyConfig { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateBackendAuthPasswordPolicyConfig): any => ({ ...obj, }); @@ -2034,6 +2241,9 @@ export interface UpdateBackendAuthUserPoolConfig { } export namespace UpdateBackendAuthUserPoolConfig { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateBackendAuthUserPoolConfig): any => ({ ...obj, }); @@ -2065,6 +2275,9 @@ export interface UpdateBackendAuthResourceConfig { } export namespace UpdateBackendAuthResourceConfig { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateBackendAuthResourceConfig): any => ({ ...obj, }); @@ -2096,6 +2309,9 @@ export interface UpdateBackendAuthRequest { } export namespace UpdateBackendAuthRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateBackendAuthRequest): any => ({ ...obj, }); @@ -2134,6 +2350,9 @@ export interface UpdateBackendAuthResponse { } export namespace UpdateBackendAuthResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateBackendAuthResponse): any => ({ ...obj, }); @@ -2165,6 +2384,9 @@ export interface LoginAuthConfigReqObj { } export namespace LoginAuthConfigReqObj { + /** + * @internal + */ export const filterSensitiveLog = (obj: LoginAuthConfigReqObj): any => ({ ...obj, }); @@ -2186,6 +2408,9 @@ export interface UpdateBackendConfigRequest { } export namespace UpdateBackendConfigRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateBackendConfigRequest): any => ({ ...obj, }); @@ -2214,6 +2439,9 @@ export interface UpdateBackendConfigResponse { } export namespace UpdateBackendConfigResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateBackendConfigResponse): any => ({ ...obj, }); @@ -2250,6 +2478,9 @@ export interface UpdateBackendJobRequest { } export namespace UpdateBackendJobRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateBackendJobRequest): any => ({ ...obj, }); @@ -2298,6 +2529,9 @@ export interface UpdateBackendJobResponse { } export namespace UpdateBackendJobResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateBackendJobResponse): any => ({ ...obj, }); diff --git a/clients/client-api-gateway/commands/CreateApiKeyCommand.ts b/clients/client-api-gateway/commands/CreateApiKeyCommand.ts index c6ea114e2769..1e6cf15df6e2 100644 --- a/clients/client-api-gateway/commands/CreateApiKeyCommand.ts +++ b/clients/client-api-gateway/commands/CreateApiKeyCommand.ts @@ -23,6 +23,20 @@ export interface CreateApiKeyCommandOutput extends ApiKey, __MetadataBearer {} /** *

Create an ApiKey resource.

*
AWS CLI
+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { APIGatewayClient, CreateApiKeyCommand } from "@aws-sdk/client-api-gateway"; // ES Modules import + * // const { APIGatewayClient, CreateApiKeyCommand } = require("@aws-sdk/client-api-gateway"); // CommonJS import + * const client = new APIGatewayClient(config); + * const command = new CreateApiKeyCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreateApiKeyCommandInput} for command's `input` shape. + * @see {@link CreateApiKeyCommandOutput} for command's `response` shape. + * @see {@link APIGatewayClientResolvedConfig | config} for command's `input` shape. + * */ export class CreateApiKeyCommand extends $Command< CreateApiKeyCommandInput, diff --git a/clients/client-api-gateway/commands/CreateAuthorizerCommand.ts b/clients/client-api-gateway/commands/CreateAuthorizerCommand.ts index db239e1f0aba..890eda75409e 100644 --- a/clients/client-api-gateway/commands/CreateAuthorizerCommand.ts +++ b/clients/client-api-gateway/commands/CreateAuthorizerCommand.ts @@ -23,6 +23,20 @@ export interface CreateAuthorizerCommandOutput extends Authorizer, __MetadataBea /** *

Adds a new Authorizer resource to an existing RestApi resource.

*
AWS CLI
+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { APIGatewayClient, CreateAuthorizerCommand } from "@aws-sdk/client-api-gateway"; // ES Modules import + * // const { APIGatewayClient, CreateAuthorizerCommand } = require("@aws-sdk/client-api-gateway"); // CommonJS import + * const client = new APIGatewayClient(config); + * const command = new CreateAuthorizerCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreateAuthorizerCommandInput} for command's `input` shape. + * @see {@link CreateAuthorizerCommandOutput} for command's `response` shape. + * @see {@link APIGatewayClientResolvedConfig | config} for command's `input` shape. + * */ export class CreateAuthorizerCommand extends $Command< CreateAuthorizerCommandInput, diff --git a/clients/client-api-gateway/commands/CreateBasePathMappingCommand.ts b/clients/client-api-gateway/commands/CreateBasePathMappingCommand.ts index fae787666481..55e4296cba8f 100644 --- a/clients/client-api-gateway/commands/CreateBasePathMappingCommand.ts +++ b/clients/client-api-gateway/commands/CreateBasePathMappingCommand.ts @@ -22,6 +22,20 @@ export interface CreateBasePathMappingCommandOutput extends BasePathMapping, __M /** *

Creates a new BasePathMapping resource.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { APIGatewayClient, CreateBasePathMappingCommand } from "@aws-sdk/client-api-gateway"; // ES Modules import + * // const { APIGatewayClient, CreateBasePathMappingCommand } = require("@aws-sdk/client-api-gateway"); // CommonJS import + * const client = new APIGatewayClient(config); + * const command = new CreateBasePathMappingCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreateBasePathMappingCommandInput} for command's `input` shape. + * @see {@link CreateBasePathMappingCommandOutput} for command's `response` shape. + * @see {@link APIGatewayClientResolvedConfig | config} for command's `input` shape. + * */ export class CreateBasePathMappingCommand extends $Command< CreateBasePathMappingCommandInput, diff --git a/clients/client-api-gateway/commands/CreateDeploymentCommand.ts b/clients/client-api-gateway/commands/CreateDeploymentCommand.ts index 2111ed7f60cc..d4514630b2e9 100644 --- a/clients/client-api-gateway/commands/CreateDeploymentCommand.ts +++ b/clients/client-api-gateway/commands/CreateDeploymentCommand.ts @@ -22,6 +22,20 @@ export interface CreateDeploymentCommandOutput extends Deployment, __MetadataBea /** *

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

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { APIGatewayClient, CreateDeploymentCommand } from "@aws-sdk/client-api-gateway"; // ES Modules import + * // const { APIGatewayClient, CreateDeploymentCommand } = require("@aws-sdk/client-api-gateway"); // CommonJS import + * const client = new APIGatewayClient(config); + * const command = new CreateDeploymentCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreateDeploymentCommandInput} for command's `input` shape. + * @see {@link CreateDeploymentCommandOutput} for command's `response` shape. + * @see {@link APIGatewayClientResolvedConfig | config} for command's `input` shape. + * */ export class CreateDeploymentCommand extends $Command< CreateDeploymentCommandInput, diff --git a/clients/client-api-gateway/commands/CreateDomainNameCommand.ts b/clients/client-api-gateway/commands/CreateDomainNameCommand.ts index 2dd5a0ca6f12..9a170b43181e 100644 --- a/clients/client-api-gateway/commands/CreateDomainNameCommand.ts +++ b/clients/client-api-gateway/commands/CreateDomainNameCommand.ts @@ -22,6 +22,20 @@ export interface CreateDomainNameCommandOutput extends DomainName, __MetadataBea /** *

Creates a new domain name.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { APIGatewayClient, CreateDomainNameCommand } from "@aws-sdk/client-api-gateway"; // ES Modules import + * // const { APIGatewayClient, CreateDomainNameCommand } = require("@aws-sdk/client-api-gateway"); // CommonJS import + * const client = new APIGatewayClient(config); + * const command = new CreateDomainNameCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreateDomainNameCommandInput} for command's `input` shape. + * @see {@link CreateDomainNameCommandOutput} for command's `response` shape. + * @see {@link APIGatewayClientResolvedConfig | config} for command's `input` shape. + * */ export class CreateDomainNameCommand extends $Command< CreateDomainNameCommandInput, diff --git a/clients/client-api-gateway/commands/CreateModelCommand.ts b/clients/client-api-gateway/commands/CreateModelCommand.ts index 5faacd8f0f6d..4057923c702d 100644 --- a/clients/client-api-gateway/commands/CreateModelCommand.ts +++ b/clients/client-api-gateway/commands/CreateModelCommand.ts @@ -22,6 +22,20 @@ export interface CreateModelCommandOutput extends Model, __MetadataBearer {} /** *

Adds a new Model resource to an existing RestApi resource.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { APIGatewayClient, CreateModelCommand } from "@aws-sdk/client-api-gateway"; // ES Modules import + * // const { APIGatewayClient, CreateModelCommand } = require("@aws-sdk/client-api-gateway"); // CommonJS import + * const client = new APIGatewayClient(config); + * const command = new CreateModelCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreateModelCommandInput} for command's `input` shape. + * @see {@link CreateModelCommandOutput} for command's `response` shape. + * @see {@link APIGatewayClientResolvedConfig | config} for command's `input` shape. + * */ export class CreateModelCommand extends $Command< CreateModelCommandInput, diff --git a/clients/client-api-gateway/commands/CreateRequestValidatorCommand.ts b/clients/client-api-gateway/commands/CreateRequestValidatorCommand.ts index 6a33b9818eb8..67a8d037e21a 100644 --- a/clients/client-api-gateway/commands/CreateRequestValidatorCommand.ts +++ b/clients/client-api-gateway/commands/CreateRequestValidatorCommand.ts @@ -22,6 +22,20 @@ export interface CreateRequestValidatorCommandOutput extends RequestValidator, _ /** *

Creates a ReqeustValidator of a given RestApi.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { APIGatewayClient, CreateRequestValidatorCommand } from "@aws-sdk/client-api-gateway"; // ES Modules import + * // const { APIGatewayClient, CreateRequestValidatorCommand } = require("@aws-sdk/client-api-gateway"); // CommonJS import + * const client = new APIGatewayClient(config); + * const command = new CreateRequestValidatorCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreateRequestValidatorCommandInput} for command's `input` shape. + * @see {@link CreateRequestValidatorCommandOutput} for command's `response` shape. + * @see {@link APIGatewayClientResolvedConfig | config} for command's `input` shape. + * */ export class CreateRequestValidatorCommand extends $Command< CreateRequestValidatorCommandInput, diff --git a/clients/client-api-gateway/commands/CreateResourceCommand.ts b/clients/client-api-gateway/commands/CreateResourceCommand.ts index 78e274648f4c..013ce1d0908e 100644 --- a/clients/client-api-gateway/commands/CreateResourceCommand.ts +++ b/clients/client-api-gateway/commands/CreateResourceCommand.ts @@ -22,6 +22,20 @@ export interface CreateResourceCommandOutput extends Resource, __MetadataBearer /** *

Creates a Resource resource.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { APIGatewayClient, CreateResourceCommand } from "@aws-sdk/client-api-gateway"; // ES Modules import + * // const { APIGatewayClient, CreateResourceCommand } = require("@aws-sdk/client-api-gateway"); // CommonJS import + * const client = new APIGatewayClient(config); + * const command = new CreateResourceCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreateResourceCommandInput} for command's `input` shape. + * @see {@link CreateResourceCommandOutput} for command's `response` shape. + * @see {@link APIGatewayClientResolvedConfig | config} for command's `input` shape. + * */ export class CreateResourceCommand extends $Command< CreateResourceCommandInput, diff --git a/clients/client-api-gateway/commands/CreateRestApiCommand.ts b/clients/client-api-gateway/commands/CreateRestApiCommand.ts index 0f2142d7ea81..c2994184b952 100644 --- a/clients/client-api-gateway/commands/CreateRestApiCommand.ts +++ b/clients/client-api-gateway/commands/CreateRestApiCommand.ts @@ -22,6 +22,20 @@ export interface CreateRestApiCommandOutput extends RestApi, __MetadataBearer {} /** *

Creates a new RestApi resource.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { APIGatewayClient, CreateRestApiCommand } from "@aws-sdk/client-api-gateway"; // ES Modules import + * // const { APIGatewayClient, CreateRestApiCommand } = require("@aws-sdk/client-api-gateway"); // CommonJS import + * const client = new APIGatewayClient(config); + * const command = new CreateRestApiCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreateRestApiCommandInput} for command's `input` shape. + * @see {@link CreateRestApiCommandOutput} for command's `response` shape. + * @see {@link APIGatewayClientResolvedConfig | config} for command's `input` shape. + * */ export class CreateRestApiCommand extends $Command< CreateRestApiCommandInput, diff --git a/clients/client-api-gateway/commands/CreateStageCommand.ts b/clients/client-api-gateway/commands/CreateStageCommand.ts index dabe61d5ca08..e8c64956fc96 100644 --- a/clients/client-api-gateway/commands/CreateStageCommand.ts +++ b/clients/client-api-gateway/commands/CreateStageCommand.ts @@ -23,6 +23,20 @@ export interface CreateStageCommandOutput extends Stage, __MetadataBearer {} /** *

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

* + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { APIGatewayClient, CreateStageCommand } from "@aws-sdk/client-api-gateway"; // ES Modules import + * // const { APIGatewayClient, CreateStageCommand } = require("@aws-sdk/client-api-gateway"); // CommonJS import + * const client = new APIGatewayClient(config); + * const command = new CreateStageCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreateStageCommandInput} for command's `input` shape. + * @see {@link CreateStageCommandOutput} for command's `response` shape. + * @see {@link APIGatewayClientResolvedConfig | config} for command's `input` shape. + * */ export class CreateStageCommand extends $Command< CreateStageCommandInput, diff --git a/clients/client-api-gateway/commands/CreateUsagePlanCommand.ts b/clients/client-api-gateway/commands/CreateUsagePlanCommand.ts index f5aaea0f5a38..7e2a9414abe6 100644 --- a/clients/client-api-gateway/commands/CreateUsagePlanCommand.ts +++ b/clients/client-api-gateway/commands/CreateUsagePlanCommand.ts @@ -22,6 +22,20 @@ export interface CreateUsagePlanCommandOutput extends UsagePlan, __MetadataBeare /** *

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

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { APIGatewayClient, CreateUsagePlanCommand } from "@aws-sdk/client-api-gateway"; // ES Modules import + * // const { APIGatewayClient, CreateUsagePlanCommand } = require("@aws-sdk/client-api-gateway"); // CommonJS import + * const client = new APIGatewayClient(config); + * const command = new CreateUsagePlanCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreateUsagePlanCommandInput} for command's `input` shape. + * @see {@link CreateUsagePlanCommandOutput} for command's `response` shape. + * @see {@link APIGatewayClientResolvedConfig | config} for command's `input` shape. + * */ export class CreateUsagePlanCommand extends $Command< CreateUsagePlanCommandInput, diff --git a/clients/client-api-gateway/commands/CreateUsagePlanKeyCommand.ts b/clients/client-api-gateway/commands/CreateUsagePlanKeyCommand.ts index 0f361a647795..88129ba685ac 100644 --- a/clients/client-api-gateway/commands/CreateUsagePlanKeyCommand.ts +++ b/clients/client-api-gateway/commands/CreateUsagePlanKeyCommand.ts @@ -22,6 +22,20 @@ export interface CreateUsagePlanKeyCommandOutput extends UsagePlanKey, __Metadat /** *

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

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { APIGatewayClient, CreateUsagePlanKeyCommand } from "@aws-sdk/client-api-gateway"; // ES Modules import + * // const { APIGatewayClient, CreateUsagePlanKeyCommand } = require("@aws-sdk/client-api-gateway"); // CommonJS import + * const client = new APIGatewayClient(config); + * const command = new CreateUsagePlanKeyCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreateUsagePlanKeyCommandInput} for command's `input` shape. + * @see {@link CreateUsagePlanKeyCommandOutput} for command's `response` shape. + * @see {@link APIGatewayClientResolvedConfig | config} for command's `input` shape. + * */ export class CreateUsagePlanKeyCommand extends $Command< CreateUsagePlanKeyCommandInput, diff --git a/clients/client-api-gateway/commands/CreateVpcLinkCommand.ts b/clients/client-api-gateway/commands/CreateVpcLinkCommand.ts index 1a04eef55d13..24250f895130 100644 --- a/clients/client-api-gateway/commands/CreateVpcLinkCommand.ts +++ b/clients/client-api-gateway/commands/CreateVpcLinkCommand.ts @@ -22,6 +22,20 @@ export interface CreateVpcLinkCommandOutput extends VpcLink, __MetadataBearer {} /** *

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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { APIGatewayClient, CreateVpcLinkCommand } from "@aws-sdk/client-api-gateway"; // ES Modules import + * // const { APIGatewayClient, CreateVpcLinkCommand } = require("@aws-sdk/client-api-gateway"); // CommonJS import + * const client = new APIGatewayClient(config); + * const command = new CreateVpcLinkCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreateVpcLinkCommandInput} for command's `input` shape. + * @see {@link CreateVpcLinkCommandOutput} for command's `response` shape. + * @see {@link APIGatewayClientResolvedConfig | config} for command's `input` shape. + * */ export class CreateVpcLinkCommand extends $Command< CreateVpcLinkCommandInput, diff --git a/clients/client-api-gateway/commands/DeleteApiKeyCommand.ts b/clients/client-api-gateway/commands/DeleteApiKeyCommand.ts index 7dca9c097f42..ff5161334c06 100644 --- a/clients/client-api-gateway/commands/DeleteApiKeyCommand.ts +++ b/clients/client-api-gateway/commands/DeleteApiKeyCommand.ts @@ -22,6 +22,20 @@ export interface DeleteApiKeyCommandOutput extends __MetadataBearer {} /** *

Deletes the ApiKey resource.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { APIGatewayClient, DeleteApiKeyCommand } from "@aws-sdk/client-api-gateway"; // ES Modules import + * // const { APIGatewayClient, DeleteApiKeyCommand } = require("@aws-sdk/client-api-gateway"); // CommonJS import + * const client = new APIGatewayClient(config); + * const command = new DeleteApiKeyCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteApiKeyCommandInput} for command's `input` shape. + * @see {@link DeleteApiKeyCommandOutput} for command's `response` shape. + * @see {@link APIGatewayClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteApiKeyCommand extends $Command< DeleteApiKeyCommandInput, diff --git a/clients/client-api-gateway/commands/DeleteAuthorizerCommand.ts b/clients/client-api-gateway/commands/DeleteAuthorizerCommand.ts index e2ab3f1a20bd..9f4e0733ab58 100644 --- a/clients/client-api-gateway/commands/DeleteAuthorizerCommand.ts +++ b/clients/client-api-gateway/commands/DeleteAuthorizerCommand.ts @@ -23,6 +23,20 @@ export interface DeleteAuthorizerCommandOutput extends __MetadataBearer {} /** *

Deletes an existing Authorizer resource.

*
AWS CLI
+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { APIGatewayClient, DeleteAuthorizerCommand } from "@aws-sdk/client-api-gateway"; // ES Modules import + * // const { APIGatewayClient, DeleteAuthorizerCommand } = require("@aws-sdk/client-api-gateway"); // CommonJS import + * const client = new APIGatewayClient(config); + * const command = new DeleteAuthorizerCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteAuthorizerCommandInput} for command's `input` shape. + * @see {@link DeleteAuthorizerCommandOutput} for command's `response` shape. + * @see {@link APIGatewayClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteAuthorizerCommand extends $Command< DeleteAuthorizerCommandInput, diff --git a/clients/client-api-gateway/commands/DeleteBasePathMappingCommand.ts b/clients/client-api-gateway/commands/DeleteBasePathMappingCommand.ts index 7bca630cbe61..160b639e8601 100644 --- a/clients/client-api-gateway/commands/DeleteBasePathMappingCommand.ts +++ b/clients/client-api-gateway/commands/DeleteBasePathMappingCommand.ts @@ -22,6 +22,20 @@ export interface DeleteBasePathMappingCommandOutput extends __MetadataBearer {} /** *

Deletes the BasePathMapping resource.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { APIGatewayClient, DeleteBasePathMappingCommand } from "@aws-sdk/client-api-gateway"; // ES Modules import + * // const { APIGatewayClient, DeleteBasePathMappingCommand } = require("@aws-sdk/client-api-gateway"); // CommonJS import + * const client = new APIGatewayClient(config); + * const command = new DeleteBasePathMappingCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteBasePathMappingCommandInput} for command's `input` shape. + * @see {@link DeleteBasePathMappingCommandOutput} for command's `response` shape. + * @see {@link APIGatewayClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteBasePathMappingCommand extends $Command< DeleteBasePathMappingCommandInput, diff --git a/clients/client-api-gateway/commands/DeleteClientCertificateCommand.ts b/clients/client-api-gateway/commands/DeleteClientCertificateCommand.ts index 40b2cd6fb896..6c6e11c67717 100644 --- a/clients/client-api-gateway/commands/DeleteClientCertificateCommand.ts +++ b/clients/client-api-gateway/commands/DeleteClientCertificateCommand.ts @@ -22,6 +22,20 @@ export interface DeleteClientCertificateCommandOutput extends __MetadataBearer { /** *

Deletes the ClientCertificate resource.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { APIGatewayClient, DeleteClientCertificateCommand } from "@aws-sdk/client-api-gateway"; // ES Modules import + * // const { APIGatewayClient, DeleteClientCertificateCommand } = require("@aws-sdk/client-api-gateway"); // CommonJS import + * const client = new APIGatewayClient(config); + * const command = new DeleteClientCertificateCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteClientCertificateCommandInput} for command's `input` shape. + * @see {@link DeleteClientCertificateCommandOutput} for command's `response` shape. + * @see {@link APIGatewayClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteClientCertificateCommand extends $Command< DeleteClientCertificateCommandInput, diff --git a/clients/client-api-gateway/commands/DeleteDeploymentCommand.ts b/clients/client-api-gateway/commands/DeleteDeploymentCommand.ts index 82ff160aa320..21365614d647 100644 --- a/clients/client-api-gateway/commands/DeleteDeploymentCommand.ts +++ b/clients/client-api-gateway/commands/DeleteDeploymentCommand.ts @@ -22,6 +22,20 @@ export interface DeleteDeploymentCommandOutput extends __MetadataBearer {} /** *

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

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { APIGatewayClient, DeleteDeploymentCommand } from "@aws-sdk/client-api-gateway"; // ES Modules import + * // const { APIGatewayClient, DeleteDeploymentCommand } = require("@aws-sdk/client-api-gateway"); // CommonJS import + * const client = new APIGatewayClient(config); + * const command = new DeleteDeploymentCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteDeploymentCommandInput} for command's `input` shape. + * @see {@link DeleteDeploymentCommandOutput} for command's `response` shape. + * @see {@link APIGatewayClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteDeploymentCommand extends $Command< DeleteDeploymentCommandInput, diff --git a/clients/client-api-gateway/commands/DeleteDomainNameCommand.ts b/clients/client-api-gateway/commands/DeleteDomainNameCommand.ts index 0ff1a9e95053..9ab0eac99f74 100644 --- a/clients/client-api-gateway/commands/DeleteDomainNameCommand.ts +++ b/clients/client-api-gateway/commands/DeleteDomainNameCommand.ts @@ -22,6 +22,20 @@ export interface DeleteDomainNameCommandOutput extends __MetadataBearer {} /** *

Deletes the DomainName resource.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { APIGatewayClient, DeleteDomainNameCommand } from "@aws-sdk/client-api-gateway"; // ES Modules import + * // const { APIGatewayClient, DeleteDomainNameCommand } = require("@aws-sdk/client-api-gateway"); // CommonJS import + * const client = new APIGatewayClient(config); + * const command = new DeleteDomainNameCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteDomainNameCommandInput} for command's `input` shape. + * @see {@link DeleteDomainNameCommandOutput} for command's `response` shape. + * @see {@link APIGatewayClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteDomainNameCommand extends $Command< DeleteDomainNameCommandInput, diff --git a/clients/client-api-gateway/commands/DeleteGatewayResponseCommand.ts b/clients/client-api-gateway/commands/DeleteGatewayResponseCommand.ts index ef797e9410fd..6734587c4ccf 100644 --- a/clients/client-api-gateway/commands/DeleteGatewayResponseCommand.ts +++ b/clients/client-api-gateway/commands/DeleteGatewayResponseCommand.ts @@ -22,6 +22,20 @@ export interface DeleteGatewayResponseCommandOutput extends __MetadataBearer {} /** *

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

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { APIGatewayClient, DeleteGatewayResponseCommand } from "@aws-sdk/client-api-gateway"; // ES Modules import + * // const { APIGatewayClient, DeleteGatewayResponseCommand } = require("@aws-sdk/client-api-gateway"); // CommonJS import + * const client = new APIGatewayClient(config); + * const command = new DeleteGatewayResponseCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteGatewayResponseCommandInput} for command's `input` shape. + * @see {@link DeleteGatewayResponseCommandOutput} for command's `response` shape. + * @see {@link APIGatewayClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteGatewayResponseCommand extends $Command< DeleteGatewayResponseCommandInput, diff --git a/clients/client-api-gateway/commands/DeleteIntegrationCommand.ts b/clients/client-api-gateway/commands/DeleteIntegrationCommand.ts index aae26fdc2646..50354f70710f 100644 --- a/clients/client-api-gateway/commands/DeleteIntegrationCommand.ts +++ b/clients/client-api-gateway/commands/DeleteIntegrationCommand.ts @@ -22,6 +22,20 @@ export interface DeleteIntegrationCommandOutput extends __MetadataBearer {} /** *

Represents a delete integration.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { APIGatewayClient, DeleteIntegrationCommand } from "@aws-sdk/client-api-gateway"; // ES Modules import + * // const { APIGatewayClient, DeleteIntegrationCommand } = require("@aws-sdk/client-api-gateway"); // CommonJS import + * const client = new APIGatewayClient(config); + * const command = new DeleteIntegrationCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteIntegrationCommandInput} for command's `input` shape. + * @see {@link DeleteIntegrationCommandOutput} for command's `response` shape. + * @see {@link APIGatewayClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteIntegrationCommand extends $Command< DeleteIntegrationCommandInput, diff --git a/clients/client-api-gateway/commands/DeleteIntegrationResponseCommand.ts b/clients/client-api-gateway/commands/DeleteIntegrationResponseCommand.ts index 66ed9c61f177..9ceaa879dcd2 100644 --- a/clients/client-api-gateway/commands/DeleteIntegrationResponseCommand.ts +++ b/clients/client-api-gateway/commands/DeleteIntegrationResponseCommand.ts @@ -22,6 +22,20 @@ export interface DeleteIntegrationResponseCommandOutput extends __MetadataBearer /** *

Represents a delete integration response.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { APIGatewayClient, DeleteIntegrationResponseCommand } from "@aws-sdk/client-api-gateway"; // ES Modules import + * // const { APIGatewayClient, DeleteIntegrationResponseCommand } = require("@aws-sdk/client-api-gateway"); // CommonJS import + * const client = new APIGatewayClient(config); + * const command = new DeleteIntegrationResponseCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteIntegrationResponseCommandInput} for command's `input` shape. + * @see {@link DeleteIntegrationResponseCommandOutput} for command's `response` shape. + * @see {@link APIGatewayClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteIntegrationResponseCommand extends $Command< DeleteIntegrationResponseCommandInput, diff --git a/clients/client-api-gateway/commands/DeleteMethodCommand.ts b/clients/client-api-gateway/commands/DeleteMethodCommand.ts index f00aefec3d23..e2f52ba90755 100644 --- a/clients/client-api-gateway/commands/DeleteMethodCommand.ts +++ b/clients/client-api-gateway/commands/DeleteMethodCommand.ts @@ -22,6 +22,20 @@ export interface DeleteMethodCommandOutput extends __MetadataBearer {} /** *

Deletes an existing Method resource.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { APIGatewayClient, DeleteMethodCommand } from "@aws-sdk/client-api-gateway"; // ES Modules import + * // const { APIGatewayClient, DeleteMethodCommand } = require("@aws-sdk/client-api-gateway"); // CommonJS import + * const client = new APIGatewayClient(config); + * const command = new DeleteMethodCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteMethodCommandInput} for command's `input` shape. + * @see {@link DeleteMethodCommandOutput} for command's `response` shape. + * @see {@link APIGatewayClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteMethodCommand extends $Command< DeleteMethodCommandInput, diff --git a/clients/client-api-gateway/commands/DeleteMethodResponseCommand.ts b/clients/client-api-gateway/commands/DeleteMethodResponseCommand.ts index d764e2a3ef56..14989360f8bb 100644 --- a/clients/client-api-gateway/commands/DeleteMethodResponseCommand.ts +++ b/clients/client-api-gateway/commands/DeleteMethodResponseCommand.ts @@ -22,6 +22,20 @@ export interface DeleteMethodResponseCommandOutput extends __MetadataBearer {} /** *

Deletes an existing MethodResponse resource.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { APIGatewayClient, DeleteMethodResponseCommand } from "@aws-sdk/client-api-gateway"; // ES Modules import + * // const { APIGatewayClient, DeleteMethodResponseCommand } = require("@aws-sdk/client-api-gateway"); // CommonJS import + * const client = new APIGatewayClient(config); + * const command = new DeleteMethodResponseCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteMethodResponseCommandInput} for command's `input` shape. + * @see {@link DeleteMethodResponseCommandOutput} for command's `response` shape. + * @see {@link APIGatewayClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteMethodResponseCommand extends $Command< DeleteMethodResponseCommandInput, diff --git a/clients/client-api-gateway/commands/DeleteModelCommand.ts b/clients/client-api-gateway/commands/DeleteModelCommand.ts index cfc1a1804d60..a8f38d7857ed 100644 --- a/clients/client-api-gateway/commands/DeleteModelCommand.ts +++ b/clients/client-api-gateway/commands/DeleteModelCommand.ts @@ -22,6 +22,20 @@ export interface DeleteModelCommandOutput extends __MetadataBearer {} /** *

Deletes a model.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { APIGatewayClient, DeleteModelCommand } from "@aws-sdk/client-api-gateway"; // ES Modules import + * // const { APIGatewayClient, DeleteModelCommand } = require("@aws-sdk/client-api-gateway"); // CommonJS import + * const client = new APIGatewayClient(config); + * const command = new DeleteModelCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteModelCommandInput} for command's `input` shape. + * @see {@link DeleteModelCommandOutput} for command's `response` shape. + * @see {@link APIGatewayClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteModelCommand extends $Command< DeleteModelCommandInput, diff --git a/clients/client-api-gateway/commands/DeleteRequestValidatorCommand.ts b/clients/client-api-gateway/commands/DeleteRequestValidatorCommand.ts index 3cccf51a73bf..32f6b780183f 100644 --- a/clients/client-api-gateway/commands/DeleteRequestValidatorCommand.ts +++ b/clients/client-api-gateway/commands/DeleteRequestValidatorCommand.ts @@ -22,6 +22,20 @@ export interface DeleteRequestValidatorCommandOutput extends __MetadataBearer {} /** *

Deletes a RequestValidator of a given RestApi.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { APIGatewayClient, DeleteRequestValidatorCommand } from "@aws-sdk/client-api-gateway"; // ES Modules import + * // const { APIGatewayClient, DeleteRequestValidatorCommand } = require("@aws-sdk/client-api-gateway"); // CommonJS import + * const client = new APIGatewayClient(config); + * const command = new DeleteRequestValidatorCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteRequestValidatorCommandInput} for command's `input` shape. + * @see {@link DeleteRequestValidatorCommandOutput} for command's `response` shape. + * @see {@link APIGatewayClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteRequestValidatorCommand extends $Command< DeleteRequestValidatorCommandInput, diff --git a/clients/client-api-gateway/commands/DeleteResourceCommand.ts b/clients/client-api-gateway/commands/DeleteResourceCommand.ts index 4a3ba5d65d9f..a67c811eacb4 100644 --- a/clients/client-api-gateway/commands/DeleteResourceCommand.ts +++ b/clients/client-api-gateway/commands/DeleteResourceCommand.ts @@ -22,6 +22,20 @@ export interface DeleteResourceCommandOutput extends __MetadataBearer {} /** *

Deletes a Resource resource.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { APIGatewayClient, DeleteResourceCommand } from "@aws-sdk/client-api-gateway"; // ES Modules import + * // const { APIGatewayClient, DeleteResourceCommand } = require("@aws-sdk/client-api-gateway"); // CommonJS import + * const client = new APIGatewayClient(config); + * const command = new DeleteResourceCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteResourceCommandInput} for command's `input` shape. + * @see {@link DeleteResourceCommandOutput} for command's `response` shape. + * @see {@link APIGatewayClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteResourceCommand extends $Command< DeleteResourceCommandInput, diff --git a/clients/client-api-gateway/commands/DeleteRestApiCommand.ts b/clients/client-api-gateway/commands/DeleteRestApiCommand.ts index e631940d132b..d445bf6c092a 100644 --- a/clients/client-api-gateway/commands/DeleteRestApiCommand.ts +++ b/clients/client-api-gateway/commands/DeleteRestApiCommand.ts @@ -22,6 +22,20 @@ export interface DeleteRestApiCommandOutput extends __MetadataBearer {} /** *

Deletes the specified API.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { APIGatewayClient, DeleteRestApiCommand } from "@aws-sdk/client-api-gateway"; // ES Modules import + * // const { APIGatewayClient, DeleteRestApiCommand } = require("@aws-sdk/client-api-gateway"); // CommonJS import + * const client = new APIGatewayClient(config); + * const command = new DeleteRestApiCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteRestApiCommandInput} for command's `input` shape. + * @see {@link DeleteRestApiCommandOutput} for command's `response` shape. + * @see {@link APIGatewayClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteRestApiCommand extends $Command< DeleteRestApiCommandInput, diff --git a/clients/client-api-gateway/commands/DeleteStageCommand.ts b/clients/client-api-gateway/commands/DeleteStageCommand.ts index bcaeeb87e42d..326b9fb327e1 100644 --- a/clients/client-api-gateway/commands/DeleteStageCommand.ts +++ b/clients/client-api-gateway/commands/DeleteStageCommand.ts @@ -22,6 +22,20 @@ export interface DeleteStageCommandOutput extends __MetadataBearer {} /** *

Deletes a Stage resource.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { APIGatewayClient, DeleteStageCommand } from "@aws-sdk/client-api-gateway"; // ES Modules import + * // const { APIGatewayClient, DeleteStageCommand } = require("@aws-sdk/client-api-gateway"); // CommonJS import + * const client = new APIGatewayClient(config); + * const command = new DeleteStageCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteStageCommandInput} for command's `input` shape. + * @see {@link DeleteStageCommandOutput} for command's `response` shape. + * @see {@link APIGatewayClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteStageCommand extends $Command< DeleteStageCommandInput, diff --git a/clients/client-api-gateway/commands/DeleteUsagePlanCommand.ts b/clients/client-api-gateway/commands/DeleteUsagePlanCommand.ts index 5bf3d10292e0..9b3a5e28acae 100644 --- a/clients/client-api-gateway/commands/DeleteUsagePlanCommand.ts +++ b/clients/client-api-gateway/commands/DeleteUsagePlanCommand.ts @@ -22,6 +22,20 @@ export interface DeleteUsagePlanCommandOutput extends __MetadataBearer {} /** *

Deletes a usage plan of a given plan Id.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { APIGatewayClient, DeleteUsagePlanCommand } from "@aws-sdk/client-api-gateway"; // ES Modules import + * // const { APIGatewayClient, DeleteUsagePlanCommand } = require("@aws-sdk/client-api-gateway"); // CommonJS import + * const client = new APIGatewayClient(config); + * const command = new DeleteUsagePlanCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteUsagePlanCommandInput} for command's `input` shape. + * @see {@link DeleteUsagePlanCommandOutput} for command's `response` shape. + * @see {@link APIGatewayClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteUsagePlanCommand extends $Command< DeleteUsagePlanCommandInput, diff --git a/clients/client-api-gateway/commands/DeleteUsagePlanKeyCommand.ts b/clients/client-api-gateway/commands/DeleteUsagePlanKeyCommand.ts index 258b8aac2947..41b23f7c1326 100644 --- a/clients/client-api-gateway/commands/DeleteUsagePlanKeyCommand.ts +++ b/clients/client-api-gateway/commands/DeleteUsagePlanKeyCommand.ts @@ -22,6 +22,20 @@ export interface DeleteUsagePlanKeyCommandOutput extends __MetadataBearer {} /** *

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

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { APIGatewayClient, DeleteUsagePlanKeyCommand } from "@aws-sdk/client-api-gateway"; // ES Modules import + * // const { APIGatewayClient, DeleteUsagePlanKeyCommand } = require("@aws-sdk/client-api-gateway"); // CommonJS import + * const client = new APIGatewayClient(config); + * const command = new DeleteUsagePlanKeyCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteUsagePlanKeyCommandInput} for command's `input` shape. + * @see {@link DeleteUsagePlanKeyCommandOutput} for command's `response` shape. + * @see {@link APIGatewayClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteUsagePlanKeyCommand extends $Command< DeleteUsagePlanKeyCommandInput, diff --git a/clients/client-api-gateway/commands/DeleteVpcLinkCommand.ts b/clients/client-api-gateway/commands/DeleteVpcLinkCommand.ts index 623ca76da2a8..5d935a38b937 100644 --- a/clients/client-api-gateway/commands/DeleteVpcLinkCommand.ts +++ b/clients/client-api-gateway/commands/DeleteVpcLinkCommand.ts @@ -22,6 +22,20 @@ export interface DeleteVpcLinkCommandOutput extends __MetadataBearer {} /** *

Deletes an existing VpcLink of a specified identifier.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { APIGatewayClient, DeleteVpcLinkCommand } from "@aws-sdk/client-api-gateway"; // ES Modules import + * // const { APIGatewayClient, DeleteVpcLinkCommand } = require("@aws-sdk/client-api-gateway"); // CommonJS import + * const client = new APIGatewayClient(config); + * const command = new DeleteVpcLinkCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteVpcLinkCommandInput} for command's `input` shape. + * @see {@link DeleteVpcLinkCommandOutput} for command's `response` shape. + * @see {@link APIGatewayClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteVpcLinkCommand extends $Command< DeleteVpcLinkCommandInput, diff --git a/clients/client-api-gateway/commands/FlushStageAuthorizersCacheCommand.ts b/clients/client-api-gateway/commands/FlushStageAuthorizersCacheCommand.ts index ca048bfa328c..e96040baa6b9 100644 --- a/clients/client-api-gateway/commands/FlushStageAuthorizersCacheCommand.ts +++ b/clients/client-api-gateway/commands/FlushStageAuthorizersCacheCommand.ts @@ -22,6 +22,20 @@ export interface FlushStageAuthorizersCacheCommandOutput extends __MetadataBeare /** *

Flushes all authorizer cache entries on a stage.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { APIGatewayClient, FlushStageAuthorizersCacheCommand } from "@aws-sdk/client-api-gateway"; // ES Modules import + * // const { APIGatewayClient, FlushStageAuthorizersCacheCommand } = require("@aws-sdk/client-api-gateway"); // CommonJS import + * const client = new APIGatewayClient(config); + * const command = new FlushStageAuthorizersCacheCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link FlushStageAuthorizersCacheCommandInput} for command's `input` shape. + * @see {@link FlushStageAuthorizersCacheCommandOutput} for command's `response` shape. + * @see {@link APIGatewayClientResolvedConfig | config} for command's `input` shape. + * */ export class FlushStageAuthorizersCacheCommand extends $Command< FlushStageAuthorizersCacheCommandInput, diff --git a/clients/client-api-gateway/commands/FlushStageCacheCommand.ts b/clients/client-api-gateway/commands/FlushStageCacheCommand.ts index 1f34057f57c9..1c53dd4381cc 100644 --- a/clients/client-api-gateway/commands/FlushStageCacheCommand.ts +++ b/clients/client-api-gateway/commands/FlushStageCacheCommand.ts @@ -22,6 +22,20 @@ export interface FlushStageCacheCommandOutput extends __MetadataBearer {} /** *

Flushes a stage's cache.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { APIGatewayClient, FlushStageCacheCommand } from "@aws-sdk/client-api-gateway"; // ES Modules import + * // const { APIGatewayClient, FlushStageCacheCommand } = require("@aws-sdk/client-api-gateway"); // CommonJS import + * const client = new APIGatewayClient(config); + * const command = new FlushStageCacheCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link FlushStageCacheCommandInput} for command's `input` shape. + * @see {@link FlushStageCacheCommandOutput} for command's `response` shape. + * @see {@link APIGatewayClientResolvedConfig | config} for command's `input` shape. + * */ export class FlushStageCacheCommand extends $Command< FlushStageCacheCommandInput, diff --git a/clients/client-api-gateway/commands/GenerateClientCertificateCommand.ts b/clients/client-api-gateway/commands/GenerateClientCertificateCommand.ts index 242b0cc4a069..c69f4d015c0e 100644 --- a/clients/client-api-gateway/commands/GenerateClientCertificateCommand.ts +++ b/clients/client-api-gateway/commands/GenerateClientCertificateCommand.ts @@ -22,6 +22,20 @@ export interface GenerateClientCertificateCommandOutput extends ClientCertificat /** *

Generates a ClientCertificate resource.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { APIGatewayClient, GenerateClientCertificateCommand } from "@aws-sdk/client-api-gateway"; // ES Modules import + * // const { APIGatewayClient, GenerateClientCertificateCommand } = require("@aws-sdk/client-api-gateway"); // CommonJS import + * const client = new APIGatewayClient(config); + * const command = new GenerateClientCertificateCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GenerateClientCertificateCommandInput} for command's `input` shape. + * @see {@link GenerateClientCertificateCommandOutput} for command's `response` shape. + * @see {@link APIGatewayClientResolvedConfig | config} for command's `input` shape. + * */ export class GenerateClientCertificateCommand extends $Command< GenerateClientCertificateCommandInput, diff --git a/clients/client-api-gateway/commands/GetAccountCommand.ts b/clients/client-api-gateway/commands/GetAccountCommand.ts index 58cdaf30ac9f..a52c7bf64e0d 100644 --- a/clients/client-api-gateway/commands/GetAccountCommand.ts +++ b/clients/client-api-gateway/commands/GetAccountCommand.ts @@ -22,6 +22,20 @@ export interface GetAccountCommandOutput extends Account, __MetadataBearer {} /** *

Gets information about the current Account resource.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { APIGatewayClient, GetAccountCommand } from "@aws-sdk/client-api-gateway"; // ES Modules import + * // const { APIGatewayClient, GetAccountCommand } = require("@aws-sdk/client-api-gateway"); // CommonJS import + * const client = new APIGatewayClient(config); + * const command = new GetAccountCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetAccountCommandInput} for command's `input` shape. + * @see {@link GetAccountCommandOutput} for command's `response` shape. + * @see {@link APIGatewayClientResolvedConfig | config} for command's `input` shape. + * */ export class GetAccountCommand extends $Command< GetAccountCommandInput, diff --git a/clients/client-api-gateway/commands/GetApiKeyCommand.ts b/clients/client-api-gateway/commands/GetApiKeyCommand.ts index a766dc7ca066..9b82d7aaad6a 100644 --- a/clients/client-api-gateway/commands/GetApiKeyCommand.ts +++ b/clients/client-api-gateway/commands/GetApiKeyCommand.ts @@ -22,6 +22,20 @@ export interface GetApiKeyCommandOutput extends ApiKey, __MetadataBearer {} /** *

Gets information about the current ApiKey resource.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { APIGatewayClient, GetApiKeyCommand } from "@aws-sdk/client-api-gateway"; // ES Modules import + * // const { APIGatewayClient, GetApiKeyCommand } = require("@aws-sdk/client-api-gateway"); // CommonJS import + * const client = new APIGatewayClient(config); + * const command = new GetApiKeyCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetApiKeyCommandInput} for command's `input` shape. + * @see {@link GetApiKeyCommandOutput} for command's `response` shape. + * @see {@link APIGatewayClientResolvedConfig | config} for command's `input` shape. + * */ export class GetApiKeyCommand extends $Command< GetApiKeyCommandInput, diff --git a/clients/client-api-gateway/commands/GetApiKeysCommand.ts b/clients/client-api-gateway/commands/GetApiKeysCommand.ts index c5a021f5d2f2..9bc86ca40b34 100644 --- a/clients/client-api-gateway/commands/GetApiKeysCommand.ts +++ b/clients/client-api-gateway/commands/GetApiKeysCommand.ts @@ -22,6 +22,20 @@ export interface GetApiKeysCommandOutput extends ApiKeys, __MetadataBearer {} /** *

Gets information about the current ApiKeys resource.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { APIGatewayClient, GetApiKeysCommand } from "@aws-sdk/client-api-gateway"; // ES Modules import + * // const { APIGatewayClient, GetApiKeysCommand } = require("@aws-sdk/client-api-gateway"); // CommonJS import + * const client = new APIGatewayClient(config); + * const command = new GetApiKeysCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetApiKeysCommandInput} for command's `input` shape. + * @see {@link GetApiKeysCommandOutput} for command's `response` shape. + * @see {@link APIGatewayClientResolvedConfig | config} for command's `input` shape. + * */ export class GetApiKeysCommand extends $Command< GetApiKeysCommandInput, diff --git a/clients/client-api-gateway/commands/GetAuthorizerCommand.ts b/clients/client-api-gateway/commands/GetAuthorizerCommand.ts index a6771ebc2ae6..55d8dfc24ecc 100644 --- a/clients/client-api-gateway/commands/GetAuthorizerCommand.ts +++ b/clients/client-api-gateway/commands/GetAuthorizerCommand.ts @@ -23,6 +23,20 @@ export interface GetAuthorizerCommandOutput extends Authorizer, __MetadataBearer /** *

Describe an existing Authorizer resource.

*
AWS CLI
+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { APIGatewayClient, GetAuthorizerCommand } from "@aws-sdk/client-api-gateway"; // ES Modules import + * // const { APIGatewayClient, GetAuthorizerCommand } = require("@aws-sdk/client-api-gateway"); // CommonJS import + * const client = new APIGatewayClient(config); + * const command = new GetAuthorizerCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetAuthorizerCommandInput} for command's `input` shape. + * @see {@link GetAuthorizerCommandOutput} for command's `response` shape. + * @see {@link APIGatewayClientResolvedConfig | config} for command's `input` shape. + * */ export class GetAuthorizerCommand extends $Command< GetAuthorizerCommandInput, diff --git a/clients/client-api-gateway/commands/GetAuthorizersCommand.ts b/clients/client-api-gateway/commands/GetAuthorizersCommand.ts index c89730916fe7..c8e47bdd882c 100644 --- a/clients/client-api-gateway/commands/GetAuthorizersCommand.ts +++ b/clients/client-api-gateway/commands/GetAuthorizersCommand.ts @@ -23,6 +23,20 @@ export interface GetAuthorizersCommandOutput extends Authorizers, __MetadataBear /** *

Describe an existing Authorizers resource.

*
AWS CLI
+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { APIGatewayClient, GetAuthorizersCommand } from "@aws-sdk/client-api-gateway"; // ES Modules import + * // const { APIGatewayClient, GetAuthorizersCommand } = require("@aws-sdk/client-api-gateway"); // CommonJS import + * const client = new APIGatewayClient(config); + * const command = new GetAuthorizersCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetAuthorizersCommandInput} for command's `input` shape. + * @see {@link GetAuthorizersCommandOutput} for command's `response` shape. + * @see {@link APIGatewayClientResolvedConfig | config} for command's `input` shape. + * */ export class GetAuthorizersCommand extends $Command< GetAuthorizersCommandInput, diff --git a/clients/client-api-gateway/commands/GetBasePathMappingCommand.ts b/clients/client-api-gateway/commands/GetBasePathMappingCommand.ts index cb9c6f3dc973..09d311a73992 100644 --- a/clients/client-api-gateway/commands/GetBasePathMappingCommand.ts +++ b/clients/client-api-gateway/commands/GetBasePathMappingCommand.ts @@ -22,6 +22,20 @@ export interface GetBasePathMappingCommandOutput extends BasePathMapping, __Meta /** *

Describe a BasePathMapping resource.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { APIGatewayClient, GetBasePathMappingCommand } from "@aws-sdk/client-api-gateway"; // ES Modules import + * // const { APIGatewayClient, GetBasePathMappingCommand } = require("@aws-sdk/client-api-gateway"); // CommonJS import + * const client = new APIGatewayClient(config); + * const command = new GetBasePathMappingCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetBasePathMappingCommandInput} for command's `input` shape. + * @see {@link GetBasePathMappingCommandOutput} for command's `response` shape. + * @see {@link APIGatewayClientResolvedConfig | config} for command's `input` shape. + * */ export class GetBasePathMappingCommand extends $Command< GetBasePathMappingCommandInput, diff --git a/clients/client-api-gateway/commands/GetBasePathMappingsCommand.ts b/clients/client-api-gateway/commands/GetBasePathMappingsCommand.ts index 24ccef41d9eb..92e6ffb036ca 100644 --- a/clients/client-api-gateway/commands/GetBasePathMappingsCommand.ts +++ b/clients/client-api-gateway/commands/GetBasePathMappingsCommand.ts @@ -22,6 +22,20 @@ export interface GetBasePathMappingsCommandOutput extends BasePathMappings, __Me /** *

Represents a collection of BasePathMapping resources.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { APIGatewayClient, GetBasePathMappingsCommand } from "@aws-sdk/client-api-gateway"; // ES Modules import + * // const { APIGatewayClient, GetBasePathMappingsCommand } = require("@aws-sdk/client-api-gateway"); // CommonJS import + * const client = new APIGatewayClient(config); + * const command = new GetBasePathMappingsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetBasePathMappingsCommandInput} for command's `input` shape. + * @see {@link GetBasePathMappingsCommandOutput} for command's `response` shape. + * @see {@link APIGatewayClientResolvedConfig | config} for command's `input` shape. + * */ export class GetBasePathMappingsCommand extends $Command< GetBasePathMappingsCommandInput, diff --git a/clients/client-api-gateway/commands/GetClientCertificateCommand.ts b/clients/client-api-gateway/commands/GetClientCertificateCommand.ts index 828e4125c6b5..43fa859a4c11 100644 --- a/clients/client-api-gateway/commands/GetClientCertificateCommand.ts +++ b/clients/client-api-gateway/commands/GetClientCertificateCommand.ts @@ -22,6 +22,20 @@ export interface GetClientCertificateCommandOutput extends ClientCertificate, __ /** *

Gets information about the current ClientCertificate resource.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { APIGatewayClient, GetClientCertificateCommand } from "@aws-sdk/client-api-gateway"; // ES Modules import + * // const { APIGatewayClient, GetClientCertificateCommand } = require("@aws-sdk/client-api-gateway"); // CommonJS import + * const client = new APIGatewayClient(config); + * const command = new GetClientCertificateCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetClientCertificateCommandInput} for command's `input` shape. + * @see {@link GetClientCertificateCommandOutput} for command's `response` shape. + * @see {@link APIGatewayClientResolvedConfig | config} for command's `input` shape. + * */ export class GetClientCertificateCommand extends $Command< GetClientCertificateCommandInput, diff --git a/clients/client-api-gateway/commands/GetClientCertificatesCommand.ts b/clients/client-api-gateway/commands/GetClientCertificatesCommand.ts index 5482922a6323..10b233325e66 100644 --- a/clients/client-api-gateway/commands/GetClientCertificatesCommand.ts +++ b/clients/client-api-gateway/commands/GetClientCertificatesCommand.ts @@ -22,6 +22,20 @@ export interface GetClientCertificatesCommandOutput extends ClientCertificates, /** *

Gets a collection of ClientCertificate resources.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { APIGatewayClient, GetClientCertificatesCommand } from "@aws-sdk/client-api-gateway"; // ES Modules import + * // const { APIGatewayClient, GetClientCertificatesCommand } = require("@aws-sdk/client-api-gateway"); // CommonJS import + * const client = new APIGatewayClient(config); + * const command = new GetClientCertificatesCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetClientCertificatesCommandInput} for command's `input` shape. + * @see {@link GetClientCertificatesCommandOutput} for command's `response` shape. + * @see {@link APIGatewayClientResolvedConfig | config} for command's `input` shape. + * */ export class GetClientCertificatesCommand extends $Command< GetClientCertificatesCommandInput, diff --git a/clients/client-api-gateway/commands/GetDeploymentCommand.ts b/clients/client-api-gateway/commands/GetDeploymentCommand.ts index 9c4af2c1ebcd..658312c3be5c 100644 --- a/clients/client-api-gateway/commands/GetDeploymentCommand.ts +++ b/clients/client-api-gateway/commands/GetDeploymentCommand.ts @@ -22,6 +22,20 @@ export interface GetDeploymentCommandOutput extends Deployment, __MetadataBearer /** *

Gets information about a Deployment resource.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { APIGatewayClient, GetDeploymentCommand } from "@aws-sdk/client-api-gateway"; // ES Modules import + * // const { APIGatewayClient, GetDeploymentCommand } = require("@aws-sdk/client-api-gateway"); // CommonJS import + * const client = new APIGatewayClient(config); + * const command = new GetDeploymentCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetDeploymentCommandInput} for command's `input` shape. + * @see {@link GetDeploymentCommandOutput} for command's `response` shape. + * @see {@link APIGatewayClientResolvedConfig | config} for command's `input` shape. + * */ export class GetDeploymentCommand extends $Command< GetDeploymentCommandInput, diff --git a/clients/client-api-gateway/commands/GetDeploymentsCommand.ts b/clients/client-api-gateway/commands/GetDeploymentsCommand.ts index efd9edc92649..10197a67a2e7 100644 --- a/clients/client-api-gateway/commands/GetDeploymentsCommand.ts +++ b/clients/client-api-gateway/commands/GetDeploymentsCommand.ts @@ -22,6 +22,20 @@ export interface GetDeploymentsCommandOutput extends Deployments, __MetadataBear /** *

Gets information about a Deployments collection.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { APIGatewayClient, GetDeploymentsCommand } from "@aws-sdk/client-api-gateway"; // ES Modules import + * // const { APIGatewayClient, GetDeploymentsCommand } = require("@aws-sdk/client-api-gateway"); // CommonJS import + * const client = new APIGatewayClient(config); + * const command = new GetDeploymentsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetDeploymentsCommandInput} for command's `input` shape. + * @see {@link GetDeploymentsCommandOutput} for command's `response` shape. + * @see {@link APIGatewayClientResolvedConfig | config} for command's `input` shape. + * */ export class GetDeploymentsCommand extends $Command< GetDeploymentsCommandInput, diff --git a/clients/client-api-gateway/commands/GetDomainNameCommand.ts b/clients/client-api-gateway/commands/GetDomainNameCommand.ts index 19c2efe3ce9d..bc4399754681 100644 --- a/clients/client-api-gateway/commands/GetDomainNameCommand.ts +++ b/clients/client-api-gateway/commands/GetDomainNameCommand.ts @@ -22,6 +22,20 @@ export interface GetDomainNameCommandOutput extends DomainName, __MetadataBearer /** *

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

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { APIGatewayClient, GetDomainNameCommand } from "@aws-sdk/client-api-gateway"; // ES Modules import + * // const { APIGatewayClient, GetDomainNameCommand } = require("@aws-sdk/client-api-gateway"); // CommonJS import + * const client = new APIGatewayClient(config); + * const command = new GetDomainNameCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetDomainNameCommandInput} for command's `input` shape. + * @see {@link GetDomainNameCommandOutput} for command's `response` shape. + * @see {@link APIGatewayClientResolvedConfig | config} for command's `input` shape. + * */ export class GetDomainNameCommand extends $Command< GetDomainNameCommandInput, diff --git a/clients/client-api-gateway/commands/GetDomainNamesCommand.ts b/clients/client-api-gateway/commands/GetDomainNamesCommand.ts index 39b2bc31386f..f67363c499e9 100644 --- a/clients/client-api-gateway/commands/GetDomainNamesCommand.ts +++ b/clients/client-api-gateway/commands/GetDomainNamesCommand.ts @@ -22,6 +22,20 @@ export interface GetDomainNamesCommandOutput extends DomainNames, __MetadataBear /** *

Represents a collection of DomainName resources.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { APIGatewayClient, GetDomainNamesCommand } from "@aws-sdk/client-api-gateway"; // ES Modules import + * // const { APIGatewayClient, GetDomainNamesCommand } = require("@aws-sdk/client-api-gateway"); // CommonJS import + * const client = new APIGatewayClient(config); + * const command = new GetDomainNamesCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetDomainNamesCommandInput} for command's `input` shape. + * @see {@link GetDomainNamesCommandOutput} for command's `response` shape. + * @see {@link APIGatewayClientResolvedConfig | config} for command's `input` shape. + * */ export class GetDomainNamesCommand extends $Command< GetDomainNamesCommandInput, diff --git a/clients/client-api-gateway/commands/GetExportCommand.ts b/clients/client-api-gateway/commands/GetExportCommand.ts index 5cd79fccdc26..7aaa4e086737 100644 --- a/clients/client-api-gateway/commands/GetExportCommand.ts +++ b/clients/client-api-gateway/commands/GetExportCommand.ts @@ -22,6 +22,20 @@ export interface GetExportCommandOutput extends ExportResponse, __MetadataBearer /** *

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

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { APIGatewayClient, GetExportCommand } from "@aws-sdk/client-api-gateway"; // ES Modules import + * // const { APIGatewayClient, GetExportCommand } = require("@aws-sdk/client-api-gateway"); // CommonJS import + * const client = new APIGatewayClient(config); + * const command = new GetExportCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetExportCommandInput} for command's `input` shape. + * @see {@link GetExportCommandOutput} for command's `response` shape. + * @see {@link APIGatewayClientResolvedConfig | config} for command's `input` shape. + * */ export class GetExportCommand extends $Command< GetExportCommandInput, diff --git a/clients/client-api-gateway/commands/GetGatewayResponseCommand.ts b/clients/client-api-gateway/commands/GetGatewayResponseCommand.ts index 6550cd4a4f0d..243b7852c15a 100644 --- a/clients/client-api-gateway/commands/GetGatewayResponseCommand.ts +++ b/clients/client-api-gateway/commands/GetGatewayResponseCommand.ts @@ -22,6 +22,20 @@ export interface GetGatewayResponseCommandOutput extends GatewayResponse, __Meta /** *

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

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { APIGatewayClient, GetGatewayResponseCommand } from "@aws-sdk/client-api-gateway"; // ES Modules import + * // const { APIGatewayClient, GetGatewayResponseCommand } = require("@aws-sdk/client-api-gateway"); // CommonJS import + * const client = new APIGatewayClient(config); + * const command = new GetGatewayResponseCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetGatewayResponseCommandInput} for command's `input` shape. + * @see {@link GetGatewayResponseCommandOutput} for command's `response` shape. + * @see {@link APIGatewayClientResolvedConfig | config} for command's `input` shape. + * */ export class GetGatewayResponseCommand extends $Command< GetGatewayResponseCommandInput, diff --git a/clients/client-api-gateway/commands/GetGatewayResponsesCommand.ts b/clients/client-api-gateway/commands/GetGatewayResponsesCommand.ts index badcf6913e40..c04ec44d9be7 100644 --- a/clients/client-api-gateway/commands/GetGatewayResponsesCommand.ts +++ b/clients/client-api-gateway/commands/GetGatewayResponsesCommand.ts @@ -22,6 +22,20 @@ export interface GetGatewayResponsesCommandOutput extends GatewayResponses, __Me /** *

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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { APIGatewayClient, GetGatewayResponsesCommand } from "@aws-sdk/client-api-gateway"; // ES Modules import + * // const { APIGatewayClient, GetGatewayResponsesCommand } = require("@aws-sdk/client-api-gateway"); // CommonJS import + * const client = new APIGatewayClient(config); + * const command = new GetGatewayResponsesCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetGatewayResponsesCommandInput} for command's `input` shape. + * @see {@link GetGatewayResponsesCommandOutput} for command's `response` shape. + * @see {@link APIGatewayClientResolvedConfig | config} for command's `input` shape. + * */ export class GetGatewayResponsesCommand extends $Command< GetGatewayResponsesCommandInput, diff --git a/clients/client-api-gateway/commands/GetIntegrationCommand.ts b/clients/client-api-gateway/commands/GetIntegrationCommand.ts index 1f53f8efe1ee..92a50ae79389 100644 --- a/clients/client-api-gateway/commands/GetIntegrationCommand.ts +++ b/clients/client-api-gateway/commands/GetIntegrationCommand.ts @@ -22,6 +22,20 @@ export interface GetIntegrationCommandOutput extends Integration, __MetadataBear /** *

Get the integration settings.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { APIGatewayClient, GetIntegrationCommand } from "@aws-sdk/client-api-gateway"; // ES Modules import + * // const { APIGatewayClient, GetIntegrationCommand } = require("@aws-sdk/client-api-gateway"); // CommonJS import + * const client = new APIGatewayClient(config); + * const command = new GetIntegrationCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetIntegrationCommandInput} for command's `input` shape. + * @see {@link GetIntegrationCommandOutput} for command's `response` shape. + * @see {@link APIGatewayClientResolvedConfig | config} for command's `input` shape. + * */ export class GetIntegrationCommand extends $Command< GetIntegrationCommandInput, diff --git a/clients/client-api-gateway/commands/GetIntegrationResponseCommand.ts b/clients/client-api-gateway/commands/GetIntegrationResponseCommand.ts index ac0d20db68f2..c40ee8b94d1c 100644 --- a/clients/client-api-gateway/commands/GetIntegrationResponseCommand.ts +++ b/clients/client-api-gateway/commands/GetIntegrationResponseCommand.ts @@ -22,6 +22,20 @@ export interface GetIntegrationResponseCommandOutput extends IntegrationResponse /** *

Represents a get integration response.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { APIGatewayClient, GetIntegrationResponseCommand } from "@aws-sdk/client-api-gateway"; // ES Modules import + * // const { APIGatewayClient, GetIntegrationResponseCommand } = require("@aws-sdk/client-api-gateway"); // CommonJS import + * const client = new APIGatewayClient(config); + * const command = new GetIntegrationResponseCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetIntegrationResponseCommandInput} for command's `input` shape. + * @see {@link GetIntegrationResponseCommandOutput} for command's `response` shape. + * @see {@link APIGatewayClientResolvedConfig | config} for command's `input` shape. + * */ export class GetIntegrationResponseCommand extends $Command< GetIntegrationResponseCommandInput, diff --git a/clients/client-api-gateway/commands/GetMethodCommand.ts b/clients/client-api-gateway/commands/GetMethodCommand.ts index 55b69965394d..2e1a1f693ace 100644 --- a/clients/client-api-gateway/commands/GetMethodCommand.ts +++ b/clients/client-api-gateway/commands/GetMethodCommand.ts @@ -22,6 +22,20 @@ export interface GetMethodCommandOutput extends Method, __MetadataBearer {} /** *

Describe an existing Method resource.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { APIGatewayClient, GetMethodCommand } from "@aws-sdk/client-api-gateway"; // ES Modules import + * // const { APIGatewayClient, GetMethodCommand } = require("@aws-sdk/client-api-gateway"); // CommonJS import + * const client = new APIGatewayClient(config); + * const command = new GetMethodCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetMethodCommandInput} for command's `input` shape. + * @see {@link GetMethodCommandOutput} for command's `response` shape. + * @see {@link APIGatewayClientResolvedConfig | config} for command's `input` shape. + * */ export class GetMethodCommand extends $Command< GetMethodCommandInput, diff --git a/clients/client-api-gateway/commands/GetMethodResponseCommand.ts b/clients/client-api-gateway/commands/GetMethodResponseCommand.ts index 541b7c44da29..751885daa0e6 100644 --- a/clients/client-api-gateway/commands/GetMethodResponseCommand.ts +++ b/clients/client-api-gateway/commands/GetMethodResponseCommand.ts @@ -22,6 +22,20 @@ export interface GetMethodResponseCommandOutput extends MethodResponse, __Metada /** *

Describes a MethodResponse resource.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { APIGatewayClient, GetMethodResponseCommand } from "@aws-sdk/client-api-gateway"; // ES Modules import + * // const { APIGatewayClient, GetMethodResponseCommand } = require("@aws-sdk/client-api-gateway"); // CommonJS import + * const client = new APIGatewayClient(config); + * const command = new GetMethodResponseCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetMethodResponseCommandInput} for command's `input` shape. + * @see {@link GetMethodResponseCommandOutput} for command's `response` shape. + * @see {@link APIGatewayClientResolvedConfig | config} for command's `input` shape. + * */ export class GetMethodResponseCommand extends $Command< GetMethodResponseCommandInput, diff --git a/clients/client-api-gateway/commands/GetModelCommand.ts b/clients/client-api-gateway/commands/GetModelCommand.ts index 9961f0050fc0..ed7e6a180ba4 100644 --- a/clients/client-api-gateway/commands/GetModelCommand.ts +++ b/clients/client-api-gateway/commands/GetModelCommand.ts @@ -22,6 +22,20 @@ export interface GetModelCommandOutput extends Model, __MetadataBearer {} /** *

Describes an existing model defined for a RestApi resource.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { APIGatewayClient, GetModelCommand } from "@aws-sdk/client-api-gateway"; // ES Modules import + * // const { APIGatewayClient, GetModelCommand } = require("@aws-sdk/client-api-gateway"); // CommonJS import + * const client = new APIGatewayClient(config); + * const command = new GetModelCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetModelCommandInput} for command's `input` shape. + * @see {@link GetModelCommandOutput} for command's `response` shape. + * @see {@link APIGatewayClientResolvedConfig | config} for command's `input` shape. + * */ export class GetModelCommand extends $Command< GetModelCommandInput, diff --git a/clients/client-api-gateway/commands/GetModelTemplateCommand.ts b/clients/client-api-gateway/commands/GetModelTemplateCommand.ts index b851e97e60a3..2849d42ba171 100644 --- a/clients/client-api-gateway/commands/GetModelTemplateCommand.ts +++ b/clients/client-api-gateway/commands/GetModelTemplateCommand.ts @@ -22,6 +22,20 @@ export interface GetModelTemplateCommandOutput extends Template, __MetadataBeare /** *

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

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { APIGatewayClient, GetModelTemplateCommand } from "@aws-sdk/client-api-gateway"; // ES Modules import + * // const { APIGatewayClient, GetModelTemplateCommand } = require("@aws-sdk/client-api-gateway"); // CommonJS import + * const client = new APIGatewayClient(config); + * const command = new GetModelTemplateCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetModelTemplateCommandInput} for command's `input` shape. + * @see {@link GetModelTemplateCommandOutput} for command's `response` shape. + * @see {@link APIGatewayClientResolvedConfig | config} for command's `input` shape. + * */ export class GetModelTemplateCommand extends $Command< GetModelTemplateCommandInput, diff --git a/clients/client-api-gateway/commands/GetModelsCommand.ts b/clients/client-api-gateway/commands/GetModelsCommand.ts index 075944b18ffc..e9fa8d74520a 100644 --- a/clients/client-api-gateway/commands/GetModelsCommand.ts +++ b/clients/client-api-gateway/commands/GetModelsCommand.ts @@ -22,6 +22,20 @@ export interface GetModelsCommandOutput extends Models, __MetadataBearer {} /** *

Describes existing Models defined for a RestApi resource.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { APIGatewayClient, GetModelsCommand } from "@aws-sdk/client-api-gateway"; // ES Modules import + * // const { APIGatewayClient, GetModelsCommand } = require("@aws-sdk/client-api-gateway"); // CommonJS import + * const client = new APIGatewayClient(config); + * const command = new GetModelsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetModelsCommandInput} for command's `input` shape. + * @see {@link GetModelsCommandOutput} for command's `response` shape. + * @see {@link APIGatewayClientResolvedConfig | config} for command's `input` shape. + * */ export class GetModelsCommand extends $Command< GetModelsCommandInput, diff --git a/clients/client-api-gateway/commands/GetRequestValidatorCommand.ts b/clients/client-api-gateway/commands/GetRequestValidatorCommand.ts index c8ff1929ce82..49e26e13a8ef 100644 --- a/clients/client-api-gateway/commands/GetRequestValidatorCommand.ts +++ b/clients/client-api-gateway/commands/GetRequestValidatorCommand.ts @@ -22,6 +22,20 @@ export interface GetRequestValidatorCommandOutput extends RequestValidator, __Me /** *

Gets a RequestValidator of a given RestApi.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { APIGatewayClient, GetRequestValidatorCommand } from "@aws-sdk/client-api-gateway"; // ES Modules import + * // const { APIGatewayClient, GetRequestValidatorCommand } = require("@aws-sdk/client-api-gateway"); // CommonJS import + * const client = new APIGatewayClient(config); + * const command = new GetRequestValidatorCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetRequestValidatorCommandInput} for command's `input` shape. + * @see {@link GetRequestValidatorCommandOutput} for command's `response` shape. + * @see {@link APIGatewayClientResolvedConfig | config} for command's `input` shape. + * */ export class GetRequestValidatorCommand extends $Command< GetRequestValidatorCommandInput, diff --git a/clients/client-api-gateway/commands/GetRequestValidatorsCommand.ts b/clients/client-api-gateway/commands/GetRequestValidatorsCommand.ts index a764b1e97899..db703b95c004 100644 --- a/clients/client-api-gateway/commands/GetRequestValidatorsCommand.ts +++ b/clients/client-api-gateway/commands/GetRequestValidatorsCommand.ts @@ -22,6 +22,20 @@ export interface GetRequestValidatorsCommandOutput extends RequestValidators, __ /** *

Gets the RequestValidators collection of a given RestApi.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { APIGatewayClient, GetRequestValidatorsCommand } from "@aws-sdk/client-api-gateway"; // ES Modules import + * // const { APIGatewayClient, GetRequestValidatorsCommand } = require("@aws-sdk/client-api-gateway"); // CommonJS import + * const client = new APIGatewayClient(config); + * const command = new GetRequestValidatorsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetRequestValidatorsCommandInput} for command's `input` shape. + * @see {@link GetRequestValidatorsCommandOutput} for command's `response` shape. + * @see {@link APIGatewayClientResolvedConfig | config} for command's `input` shape. + * */ export class GetRequestValidatorsCommand extends $Command< GetRequestValidatorsCommandInput, diff --git a/clients/client-api-gateway/commands/GetResourceCommand.ts b/clients/client-api-gateway/commands/GetResourceCommand.ts index 8c805239501c..c7833cee1a99 100644 --- a/clients/client-api-gateway/commands/GetResourceCommand.ts +++ b/clients/client-api-gateway/commands/GetResourceCommand.ts @@ -22,6 +22,20 @@ export interface GetResourceCommandOutput extends Resource, __MetadataBearer {} /** *

Lists information about a resource.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { APIGatewayClient, GetResourceCommand } from "@aws-sdk/client-api-gateway"; // ES Modules import + * // const { APIGatewayClient, GetResourceCommand } = require("@aws-sdk/client-api-gateway"); // CommonJS import + * const client = new APIGatewayClient(config); + * const command = new GetResourceCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetResourceCommandInput} for command's `input` shape. + * @see {@link GetResourceCommandOutput} for command's `response` shape. + * @see {@link APIGatewayClientResolvedConfig | config} for command's `input` shape. + * */ export class GetResourceCommand extends $Command< GetResourceCommandInput, diff --git a/clients/client-api-gateway/commands/GetResourcesCommand.ts b/clients/client-api-gateway/commands/GetResourcesCommand.ts index d3b82e7b0a24..82cea28349ae 100644 --- a/clients/client-api-gateway/commands/GetResourcesCommand.ts +++ b/clients/client-api-gateway/commands/GetResourcesCommand.ts @@ -22,6 +22,20 @@ export interface GetResourcesCommandOutput extends Resources, __MetadataBearer { /** *

Lists information about a collection of Resource resources.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { APIGatewayClient, GetResourcesCommand } from "@aws-sdk/client-api-gateway"; // ES Modules import + * // const { APIGatewayClient, GetResourcesCommand } = require("@aws-sdk/client-api-gateway"); // CommonJS import + * const client = new APIGatewayClient(config); + * const command = new GetResourcesCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetResourcesCommandInput} for command's `input` shape. + * @see {@link GetResourcesCommandOutput} for command's `response` shape. + * @see {@link APIGatewayClientResolvedConfig | config} for command's `input` shape. + * */ export class GetResourcesCommand extends $Command< GetResourcesCommandInput, diff --git a/clients/client-api-gateway/commands/GetRestApiCommand.ts b/clients/client-api-gateway/commands/GetRestApiCommand.ts index 95ec78bda77f..20b1c561b66d 100644 --- a/clients/client-api-gateway/commands/GetRestApiCommand.ts +++ b/clients/client-api-gateway/commands/GetRestApiCommand.ts @@ -22,6 +22,20 @@ export interface GetRestApiCommandOutput extends RestApi, __MetadataBearer {} /** *

Lists the RestApi resource in the collection.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { APIGatewayClient, GetRestApiCommand } from "@aws-sdk/client-api-gateway"; // ES Modules import + * // const { APIGatewayClient, GetRestApiCommand } = require("@aws-sdk/client-api-gateway"); // CommonJS import + * const client = new APIGatewayClient(config); + * const command = new GetRestApiCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetRestApiCommandInput} for command's `input` shape. + * @see {@link GetRestApiCommandOutput} for command's `response` shape. + * @see {@link APIGatewayClientResolvedConfig | config} for command's `input` shape. + * */ export class GetRestApiCommand extends $Command< GetRestApiCommandInput, diff --git a/clients/client-api-gateway/commands/GetRestApisCommand.ts b/clients/client-api-gateway/commands/GetRestApisCommand.ts index 5f140066cbd3..ca19f3fe2281 100644 --- a/clients/client-api-gateway/commands/GetRestApisCommand.ts +++ b/clients/client-api-gateway/commands/GetRestApisCommand.ts @@ -22,6 +22,20 @@ export interface GetRestApisCommandOutput extends RestApis, __MetadataBearer {} /** *

Lists the RestApis resources for your collection.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { APIGatewayClient, GetRestApisCommand } from "@aws-sdk/client-api-gateway"; // ES Modules import + * // const { APIGatewayClient, GetRestApisCommand } = require("@aws-sdk/client-api-gateway"); // CommonJS import + * const client = new APIGatewayClient(config); + * const command = new GetRestApisCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetRestApisCommandInput} for command's `input` shape. + * @see {@link GetRestApisCommandOutput} for command's `response` shape. + * @see {@link APIGatewayClientResolvedConfig | config} for command's `input` shape. + * */ export class GetRestApisCommand extends $Command< GetRestApisCommandInput, diff --git a/clients/client-api-gateway/commands/GetSdkCommand.ts b/clients/client-api-gateway/commands/GetSdkCommand.ts index 4e04aea3101d..57fb22cec884 100644 --- a/clients/client-api-gateway/commands/GetSdkCommand.ts +++ b/clients/client-api-gateway/commands/GetSdkCommand.ts @@ -19,6 +19,20 @@ export interface GetSdkCommandOutput extends SdkResponse, __MetadataBearer {} /** *

Generates a client SDK for a RestApi and Stage.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { APIGatewayClient, GetSdkCommand } from "@aws-sdk/client-api-gateway"; // ES Modules import + * // const { APIGatewayClient, GetSdkCommand } = require("@aws-sdk/client-api-gateway"); // CommonJS import + * const client = new APIGatewayClient(config); + * const command = new GetSdkCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetSdkCommandInput} for command's `input` shape. + * @see {@link GetSdkCommandOutput} for command's `response` shape. + * @see {@link APIGatewayClientResolvedConfig | config} for command's `input` shape. + * */ export class GetSdkCommand extends $Command { // Start section: command_properties diff --git a/clients/client-api-gateway/commands/GetStageCommand.ts b/clients/client-api-gateway/commands/GetStageCommand.ts index 84c11e56c751..580bd85e592d 100644 --- a/clients/client-api-gateway/commands/GetStageCommand.ts +++ b/clients/client-api-gateway/commands/GetStageCommand.ts @@ -22,6 +22,20 @@ export interface GetStageCommandOutput extends Stage, __MetadataBearer {} /** *

Gets information about a Stage resource.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { APIGatewayClient, GetStageCommand } from "@aws-sdk/client-api-gateway"; // ES Modules import + * // const { APIGatewayClient, GetStageCommand } = require("@aws-sdk/client-api-gateway"); // CommonJS import + * const client = new APIGatewayClient(config); + * const command = new GetStageCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetStageCommandInput} for command's `input` shape. + * @see {@link GetStageCommandOutput} for command's `response` shape. + * @see {@link APIGatewayClientResolvedConfig | config} for command's `input` shape. + * */ export class GetStageCommand extends $Command< GetStageCommandInput, diff --git a/clients/client-api-gateway/commands/GetStagesCommand.ts b/clients/client-api-gateway/commands/GetStagesCommand.ts index 8f02ac16ce0b..012bd7355263 100644 --- a/clients/client-api-gateway/commands/GetStagesCommand.ts +++ b/clients/client-api-gateway/commands/GetStagesCommand.ts @@ -22,6 +22,20 @@ export interface GetStagesCommandOutput extends Stages, __MetadataBearer {} /** *

Gets information about one or more Stage resources.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { APIGatewayClient, GetStagesCommand } from "@aws-sdk/client-api-gateway"; // ES Modules import + * // const { APIGatewayClient, GetStagesCommand } = require("@aws-sdk/client-api-gateway"); // CommonJS import + * const client = new APIGatewayClient(config); + * const command = new GetStagesCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetStagesCommandInput} for command's `input` shape. + * @see {@link GetStagesCommandOutput} for command's `response` shape. + * @see {@link APIGatewayClientResolvedConfig | config} for command's `input` shape. + * */ export class GetStagesCommand extends $Command< GetStagesCommandInput, diff --git a/clients/client-api-gateway/commands/GetTagsCommand.ts b/clients/client-api-gateway/commands/GetTagsCommand.ts index 0d215d7606d8..738bb38433e7 100644 --- a/clients/client-api-gateway/commands/GetTagsCommand.ts +++ b/clients/client-api-gateway/commands/GetTagsCommand.ts @@ -22,6 +22,20 @@ export interface GetTagsCommandOutput extends Tags, __MetadataBearer {} /** *

Gets the Tags collection for a given resource.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { APIGatewayClient, GetTagsCommand } from "@aws-sdk/client-api-gateway"; // ES Modules import + * // const { APIGatewayClient, GetTagsCommand } = require("@aws-sdk/client-api-gateway"); // CommonJS import + * const client = new APIGatewayClient(config); + * const command = new GetTagsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetTagsCommandInput} for command's `input` shape. + * @see {@link GetTagsCommandOutput} for command's `response` shape. + * @see {@link APIGatewayClientResolvedConfig | config} for command's `input` shape. + * */ export class GetTagsCommand extends $Command< GetTagsCommandInput, diff --git a/clients/client-api-gateway/commands/GetUsageCommand.ts b/clients/client-api-gateway/commands/GetUsageCommand.ts index c09179cb99e3..e2c5e4dde683 100644 --- a/clients/client-api-gateway/commands/GetUsageCommand.ts +++ b/clients/client-api-gateway/commands/GetUsageCommand.ts @@ -22,6 +22,20 @@ export interface GetUsageCommandOutput extends Usage, __MetadataBearer {} /** *

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

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { APIGatewayClient, GetUsageCommand } from "@aws-sdk/client-api-gateway"; // ES Modules import + * // const { APIGatewayClient, GetUsageCommand } = require("@aws-sdk/client-api-gateway"); // CommonJS import + * const client = new APIGatewayClient(config); + * const command = new GetUsageCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetUsageCommandInput} for command's `input` shape. + * @see {@link GetUsageCommandOutput} for command's `response` shape. + * @see {@link APIGatewayClientResolvedConfig | config} for command's `input` shape. + * */ export class GetUsageCommand extends $Command< GetUsageCommandInput, diff --git a/clients/client-api-gateway/commands/GetUsagePlanCommand.ts b/clients/client-api-gateway/commands/GetUsagePlanCommand.ts index 665aeda537b2..1a2f4e8c55be 100644 --- a/clients/client-api-gateway/commands/GetUsagePlanCommand.ts +++ b/clients/client-api-gateway/commands/GetUsagePlanCommand.ts @@ -22,6 +22,20 @@ export interface GetUsagePlanCommandOutput extends UsagePlan, __MetadataBearer { /** *

Gets a usage plan of a given plan identifier.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { APIGatewayClient, GetUsagePlanCommand } from "@aws-sdk/client-api-gateway"; // ES Modules import + * // const { APIGatewayClient, GetUsagePlanCommand } = require("@aws-sdk/client-api-gateway"); // CommonJS import + * const client = new APIGatewayClient(config); + * const command = new GetUsagePlanCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetUsagePlanCommandInput} for command's `input` shape. + * @see {@link GetUsagePlanCommandOutput} for command's `response` shape. + * @see {@link APIGatewayClientResolvedConfig | config} for command's `input` shape. + * */ export class GetUsagePlanCommand extends $Command< GetUsagePlanCommandInput, diff --git a/clients/client-api-gateway/commands/GetUsagePlanKeyCommand.ts b/clients/client-api-gateway/commands/GetUsagePlanKeyCommand.ts index 65635a5787e1..45eead692eb0 100644 --- a/clients/client-api-gateway/commands/GetUsagePlanKeyCommand.ts +++ b/clients/client-api-gateway/commands/GetUsagePlanKeyCommand.ts @@ -22,6 +22,20 @@ export interface GetUsagePlanKeyCommandOutput extends UsagePlanKey, __MetadataBe /** *

Gets a usage plan key of a given key identifier.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { APIGatewayClient, GetUsagePlanKeyCommand } from "@aws-sdk/client-api-gateway"; // ES Modules import + * // const { APIGatewayClient, GetUsagePlanKeyCommand } = require("@aws-sdk/client-api-gateway"); // CommonJS import + * const client = new APIGatewayClient(config); + * const command = new GetUsagePlanKeyCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetUsagePlanKeyCommandInput} for command's `input` shape. + * @see {@link GetUsagePlanKeyCommandOutput} for command's `response` shape. + * @see {@link APIGatewayClientResolvedConfig | config} for command's `input` shape. + * */ export class GetUsagePlanKeyCommand extends $Command< GetUsagePlanKeyCommandInput, diff --git a/clients/client-api-gateway/commands/GetUsagePlanKeysCommand.ts b/clients/client-api-gateway/commands/GetUsagePlanKeysCommand.ts index 098b827cc6d4..26f158dbc01e 100644 --- a/clients/client-api-gateway/commands/GetUsagePlanKeysCommand.ts +++ b/clients/client-api-gateway/commands/GetUsagePlanKeysCommand.ts @@ -22,6 +22,20 @@ export interface GetUsagePlanKeysCommandOutput extends UsagePlanKeys, __Metadata /** *

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

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { APIGatewayClient, GetUsagePlanKeysCommand } from "@aws-sdk/client-api-gateway"; // ES Modules import + * // const { APIGatewayClient, GetUsagePlanKeysCommand } = require("@aws-sdk/client-api-gateway"); // CommonJS import + * const client = new APIGatewayClient(config); + * const command = new GetUsagePlanKeysCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetUsagePlanKeysCommandInput} for command's `input` shape. + * @see {@link GetUsagePlanKeysCommandOutput} for command's `response` shape. + * @see {@link APIGatewayClientResolvedConfig | config} for command's `input` shape. + * */ export class GetUsagePlanKeysCommand extends $Command< GetUsagePlanKeysCommandInput, diff --git a/clients/client-api-gateway/commands/GetUsagePlansCommand.ts b/clients/client-api-gateway/commands/GetUsagePlansCommand.ts index cf97e58b0c53..3d5563a83d6d 100644 --- a/clients/client-api-gateway/commands/GetUsagePlansCommand.ts +++ b/clients/client-api-gateway/commands/GetUsagePlansCommand.ts @@ -22,6 +22,20 @@ export interface GetUsagePlansCommandOutput extends UsagePlans, __MetadataBearer /** *

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

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { APIGatewayClient, GetUsagePlansCommand } from "@aws-sdk/client-api-gateway"; // ES Modules import + * // const { APIGatewayClient, GetUsagePlansCommand } = require("@aws-sdk/client-api-gateway"); // CommonJS import + * const client = new APIGatewayClient(config); + * const command = new GetUsagePlansCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetUsagePlansCommandInput} for command's `input` shape. + * @see {@link GetUsagePlansCommandOutput} for command's `response` shape. + * @see {@link APIGatewayClientResolvedConfig | config} for command's `input` shape. + * */ export class GetUsagePlansCommand extends $Command< GetUsagePlansCommandInput, diff --git a/clients/client-api-gateway/commands/GetVpcLinkCommand.ts b/clients/client-api-gateway/commands/GetVpcLinkCommand.ts index f2d70fc2586a..04330d677aaa 100644 --- a/clients/client-api-gateway/commands/GetVpcLinkCommand.ts +++ b/clients/client-api-gateway/commands/GetVpcLinkCommand.ts @@ -22,6 +22,20 @@ export interface GetVpcLinkCommandOutput extends VpcLink, __MetadataBearer {} /** *

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

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { APIGatewayClient, GetVpcLinkCommand } from "@aws-sdk/client-api-gateway"; // ES Modules import + * // const { APIGatewayClient, GetVpcLinkCommand } = require("@aws-sdk/client-api-gateway"); // CommonJS import + * const client = new APIGatewayClient(config); + * const command = new GetVpcLinkCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetVpcLinkCommandInput} for command's `input` shape. + * @see {@link GetVpcLinkCommandOutput} for command's `response` shape. + * @see {@link APIGatewayClientResolvedConfig | config} for command's `input` shape. + * */ export class GetVpcLinkCommand extends $Command< GetVpcLinkCommandInput, diff --git a/clients/client-api-gateway/commands/GetVpcLinksCommand.ts b/clients/client-api-gateway/commands/GetVpcLinksCommand.ts index 7363ef2c478a..550f053b2c09 100644 --- a/clients/client-api-gateway/commands/GetVpcLinksCommand.ts +++ b/clients/client-api-gateway/commands/GetVpcLinksCommand.ts @@ -22,6 +22,20 @@ export interface GetVpcLinksCommandOutput extends VpcLinks, __MetadataBearer {} /** *

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

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { APIGatewayClient, GetVpcLinksCommand } from "@aws-sdk/client-api-gateway"; // ES Modules import + * // const { APIGatewayClient, GetVpcLinksCommand } = require("@aws-sdk/client-api-gateway"); // CommonJS import + * const client = new APIGatewayClient(config); + * const command = new GetVpcLinksCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetVpcLinksCommandInput} for command's `input` shape. + * @see {@link GetVpcLinksCommandOutput} for command's `response` shape. + * @see {@link APIGatewayClientResolvedConfig | config} for command's `input` shape. + * */ export class GetVpcLinksCommand extends $Command< GetVpcLinksCommandInput, diff --git a/clients/client-api-gateway/commands/ImportApiKeysCommand.ts b/clients/client-api-gateway/commands/ImportApiKeysCommand.ts index 7e665a5ec7f2..ae5202c84a8b 100644 --- a/clients/client-api-gateway/commands/ImportApiKeysCommand.ts +++ b/clients/client-api-gateway/commands/ImportApiKeysCommand.ts @@ -22,6 +22,20 @@ export interface ImportApiKeysCommandOutput extends ApiKeyIds, __MetadataBearer /** *

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

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { APIGatewayClient, ImportApiKeysCommand } from "@aws-sdk/client-api-gateway"; // ES Modules import + * // const { APIGatewayClient, ImportApiKeysCommand } = require("@aws-sdk/client-api-gateway"); // CommonJS import + * const client = new APIGatewayClient(config); + * const command = new ImportApiKeysCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ImportApiKeysCommandInput} for command's `input` shape. + * @see {@link ImportApiKeysCommandOutput} for command's `response` shape. + * @see {@link APIGatewayClientResolvedConfig | config} for command's `input` shape. + * */ export class ImportApiKeysCommand extends $Command< ImportApiKeysCommandInput, diff --git a/clients/client-api-gateway/commands/ImportRestApiCommand.ts b/clients/client-api-gateway/commands/ImportRestApiCommand.ts index 253ef154d41b..76ef37c015e0 100644 --- a/clients/client-api-gateway/commands/ImportRestApiCommand.ts +++ b/clients/client-api-gateway/commands/ImportRestApiCommand.ts @@ -22,6 +22,20 @@ export interface ImportRestApiCommandOutput extends RestApi, __MetadataBearer {} /** *

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

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { APIGatewayClient, ImportRestApiCommand } from "@aws-sdk/client-api-gateway"; // ES Modules import + * // const { APIGatewayClient, ImportRestApiCommand } = require("@aws-sdk/client-api-gateway"); // CommonJS import + * const client = new APIGatewayClient(config); + * const command = new ImportRestApiCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ImportRestApiCommandInput} for command's `input` shape. + * @see {@link ImportRestApiCommandOutput} for command's `response` shape. + * @see {@link APIGatewayClientResolvedConfig | config} for command's `input` shape. + * */ export class ImportRestApiCommand extends $Command< ImportRestApiCommandInput, diff --git a/clients/client-api-gateway/commands/PutGatewayResponseCommand.ts b/clients/client-api-gateway/commands/PutGatewayResponseCommand.ts index 8ec22f0f415b..18d77dd0088d 100644 --- a/clients/client-api-gateway/commands/PutGatewayResponseCommand.ts +++ b/clients/client-api-gateway/commands/PutGatewayResponseCommand.ts @@ -22,6 +22,20 @@ export interface PutGatewayResponseCommandOutput extends GatewayResponse, __Meta /** *

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

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { APIGatewayClient, PutGatewayResponseCommand } from "@aws-sdk/client-api-gateway"; // ES Modules import + * // const { APIGatewayClient, PutGatewayResponseCommand } = require("@aws-sdk/client-api-gateway"); // CommonJS import + * const client = new APIGatewayClient(config); + * const command = new PutGatewayResponseCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link PutGatewayResponseCommandInput} for command's `input` shape. + * @see {@link PutGatewayResponseCommandOutput} for command's `response` shape. + * @see {@link APIGatewayClientResolvedConfig | config} for command's `input` shape. + * */ export class PutGatewayResponseCommand extends $Command< PutGatewayResponseCommandInput, diff --git a/clients/client-api-gateway/commands/PutIntegrationCommand.ts b/clients/client-api-gateway/commands/PutIntegrationCommand.ts index 770225c57507..110ff47d14f0 100644 --- a/clients/client-api-gateway/commands/PutIntegrationCommand.ts +++ b/clients/client-api-gateway/commands/PutIntegrationCommand.ts @@ -22,6 +22,20 @@ export interface PutIntegrationCommandOutput extends Integration, __MetadataBear /** *

Sets up a method's integration.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { APIGatewayClient, PutIntegrationCommand } from "@aws-sdk/client-api-gateway"; // ES Modules import + * // const { APIGatewayClient, PutIntegrationCommand } = require("@aws-sdk/client-api-gateway"); // CommonJS import + * const client = new APIGatewayClient(config); + * const command = new PutIntegrationCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link PutIntegrationCommandInput} for command's `input` shape. + * @see {@link PutIntegrationCommandOutput} for command's `response` shape. + * @see {@link APIGatewayClientResolvedConfig | config} for command's `input` shape. + * */ export class PutIntegrationCommand extends $Command< PutIntegrationCommandInput, diff --git a/clients/client-api-gateway/commands/PutIntegrationResponseCommand.ts b/clients/client-api-gateway/commands/PutIntegrationResponseCommand.ts index 22445da1e548..d48c699408a4 100644 --- a/clients/client-api-gateway/commands/PutIntegrationResponseCommand.ts +++ b/clients/client-api-gateway/commands/PutIntegrationResponseCommand.ts @@ -22,6 +22,20 @@ export interface PutIntegrationResponseCommandOutput extends IntegrationResponse /** *

Represents a put integration.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { APIGatewayClient, PutIntegrationResponseCommand } from "@aws-sdk/client-api-gateway"; // ES Modules import + * // const { APIGatewayClient, PutIntegrationResponseCommand } = require("@aws-sdk/client-api-gateway"); // CommonJS import + * const client = new APIGatewayClient(config); + * const command = new PutIntegrationResponseCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link PutIntegrationResponseCommandInput} for command's `input` shape. + * @see {@link PutIntegrationResponseCommandOutput} for command's `response` shape. + * @see {@link APIGatewayClientResolvedConfig | config} for command's `input` shape. + * */ export class PutIntegrationResponseCommand extends $Command< PutIntegrationResponseCommandInput, diff --git a/clients/client-api-gateway/commands/PutMethodCommand.ts b/clients/client-api-gateway/commands/PutMethodCommand.ts index 027e4127a8af..19189fd4a48f 100644 --- a/clients/client-api-gateway/commands/PutMethodCommand.ts +++ b/clients/client-api-gateway/commands/PutMethodCommand.ts @@ -22,6 +22,20 @@ export interface PutMethodCommandOutput extends Method, __MetadataBearer {} /** *

Add a method to an existing Resource resource.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { APIGatewayClient, PutMethodCommand } from "@aws-sdk/client-api-gateway"; // ES Modules import + * // const { APIGatewayClient, PutMethodCommand } = require("@aws-sdk/client-api-gateway"); // CommonJS import + * const client = new APIGatewayClient(config); + * const command = new PutMethodCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link PutMethodCommandInput} for command's `input` shape. + * @see {@link PutMethodCommandOutput} for command's `response` shape. + * @see {@link APIGatewayClientResolvedConfig | config} for command's `input` shape. + * */ export class PutMethodCommand extends $Command< PutMethodCommandInput, diff --git a/clients/client-api-gateway/commands/PutMethodResponseCommand.ts b/clients/client-api-gateway/commands/PutMethodResponseCommand.ts index 1faf0190257a..55e0c7ef4bba 100644 --- a/clients/client-api-gateway/commands/PutMethodResponseCommand.ts +++ b/clients/client-api-gateway/commands/PutMethodResponseCommand.ts @@ -22,6 +22,20 @@ export interface PutMethodResponseCommandOutput extends MethodResponse, __Metada /** *

Adds a MethodResponse to an existing Method resource.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { APIGatewayClient, PutMethodResponseCommand } from "@aws-sdk/client-api-gateway"; // ES Modules import + * // const { APIGatewayClient, PutMethodResponseCommand } = require("@aws-sdk/client-api-gateway"); // CommonJS import + * const client = new APIGatewayClient(config); + * const command = new PutMethodResponseCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link PutMethodResponseCommandInput} for command's `input` shape. + * @see {@link PutMethodResponseCommandOutput} for command's `response` shape. + * @see {@link APIGatewayClientResolvedConfig | config} for command's `input` shape. + * */ export class PutMethodResponseCommand extends $Command< PutMethodResponseCommandInput, diff --git a/clients/client-api-gateway/commands/PutRestApiCommand.ts b/clients/client-api-gateway/commands/PutRestApiCommand.ts index ff6f8bd6b381..b1d960dc5369 100644 --- a/clients/client-api-gateway/commands/PutRestApiCommand.ts +++ b/clients/client-api-gateway/commands/PutRestApiCommand.ts @@ -23,6 +23,20 @@ export interface PutRestApiCommandOutput extends RestApi, __MetadataBearer {} /** *

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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { APIGatewayClient, PutRestApiCommand } from "@aws-sdk/client-api-gateway"; // ES Modules import + * // const { APIGatewayClient, PutRestApiCommand } = require("@aws-sdk/client-api-gateway"); // CommonJS import + * const client = new APIGatewayClient(config); + * const command = new PutRestApiCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link PutRestApiCommandInput} for command's `input` shape. + * @see {@link PutRestApiCommandOutput} for command's `response` shape. + * @see {@link APIGatewayClientResolvedConfig | config} for command's `input` shape. + * */ export class PutRestApiCommand extends $Command< PutRestApiCommandInput, diff --git a/clients/client-api-gateway/commands/TagResourceCommand.ts b/clients/client-api-gateway/commands/TagResourceCommand.ts index 4a6539521dce..2fd8ea7cdde1 100644 --- a/clients/client-api-gateway/commands/TagResourceCommand.ts +++ b/clients/client-api-gateway/commands/TagResourceCommand.ts @@ -22,6 +22,20 @@ export interface TagResourceCommandOutput extends __MetadataBearer {} /** *

Adds or updates a tag on a given resource.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { APIGatewayClient, TagResourceCommand } from "@aws-sdk/client-api-gateway"; // ES Modules import + * // const { APIGatewayClient, TagResourceCommand } = require("@aws-sdk/client-api-gateway"); // CommonJS import + * const client = new APIGatewayClient(config); + * const command = new TagResourceCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link TagResourceCommandInput} for command's `input` shape. + * @see {@link TagResourceCommandOutput} for command's `response` shape. + * @see {@link APIGatewayClientResolvedConfig | config} for command's `input` shape. + * */ export class TagResourceCommand extends $Command< TagResourceCommandInput, diff --git a/clients/client-api-gateway/commands/TestInvokeAuthorizerCommand.ts b/clients/client-api-gateway/commands/TestInvokeAuthorizerCommand.ts index 312c62c46026..dd0af81e0627 100644 --- a/clients/client-api-gateway/commands/TestInvokeAuthorizerCommand.ts +++ b/clients/client-api-gateway/commands/TestInvokeAuthorizerCommand.ts @@ -26,6 +26,20 @@ export interface TestInvokeAuthorizerCommandOutput extends TestInvokeAuthorizerR * Use Lambda Function as Authorizer * Use Cognito User Pool as Authorizer * + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { APIGatewayClient, TestInvokeAuthorizerCommand } from "@aws-sdk/client-api-gateway"; // ES Modules import + * // const { APIGatewayClient, TestInvokeAuthorizerCommand } = require("@aws-sdk/client-api-gateway"); // CommonJS import + * const client = new APIGatewayClient(config); + * const command = new TestInvokeAuthorizerCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link TestInvokeAuthorizerCommandInput} for command's `input` shape. + * @see {@link TestInvokeAuthorizerCommandOutput} for command's `response` shape. + * @see {@link APIGatewayClientResolvedConfig | config} for command's `input` shape. + * */ export class TestInvokeAuthorizerCommand extends $Command< TestInvokeAuthorizerCommandInput, diff --git a/clients/client-api-gateway/commands/TestInvokeMethodCommand.ts b/clients/client-api-gateway/commands/TestInvokeMethodCommand.ts index 1821d924e9f1..bd7383a1d10c 100644 --- a/clients/client-api-gateway/commands/TestInvokeMethodCommand.ts +++ b/clients/client-api-gateway/commands/TestInvokeMethodCommand.ts @@ -22,6 +22,20 @@ export interface TestInvokeMethodCommandOutput extends TestInvokeMethodResponse, /** *

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

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { APIGatewayClient, TestInvokeMethodCommand } from "@aws-sdk/client-api-gateway"; // ES Modules import + * // const { APIGatewayClient, TestInvokeMethodCommand } = require("@aws-sdk/client-api-gateway"); // CommonJS import + * const client = new APIGatewayClient(config); + * const command = new TestInvokeMethodCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link TestInvokeMethodCommandInput} for command's `input` shape. + * @see {@link TestInvokeMethodCommandOutput} for command's `response` shape. + * @see {@link APIGatewayClientResolvedConfig | config} for command's `input` shape. + * */ export class TestInvokeMethodCommand extends $Command< TestInvokeMethodCommandInput, diff --git a/clients/client-api-gateway/commands/UntagResourceCommand.ts b/clients/client-api-gateway/commands/UntagResourceCommand.ts index 1b11700cf2f7..a81c52b7bb7d 100644 --- a/clients/client-api-gateway/commands/UntagResourceCommand.ts +++ b/clients/client-api-gateway/commands/UntagResourceCommand.ts @@ -22,6 +22,20 @@ export interface UntagResourceCommandOutput extends __MetadataBearer {} /** *

Removes a tag from a given resource.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { APIGatewayClient, UntagResourceCommand } from "@aws-sdk/client-api-gateway"; // ES Modules import + * // const { APIGatewayClient, UntagResourceCommand } = require("@aws-sdk/client-api-gateway"); // CommonJS import + * const client = new APIGatewayClient(config); + * const command = new UntagResourceCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link UntagResourceCommandInput} for command's `input` shape. + * @see {@link UntagResourceCommandOutput} for command's `response` shape. + * @see {@link APIGatewayClientResolvedConfig | config} for command's `input` shape. + * */ export class UntagResourceCommand extends $Command< UntagResourceCommandInput, diff --git a/clients/client-api-gateway/commands/UpdateAccountCommand.ts b/clients/client-api-gateway/commands/UpdateAccountCommand.ts index 5985725d6cdf..252c29fdb971 100644 --- a/clients/client-api-gateway/commands/UpdateAccountCommand.ts +++ b/clients/client-api-gateway/commands/UpdateAccountCommand.ts @@ -22,6 +22,20 @@ export interface UpdateAccountCommandOutput extends Account, __MetadataBearer {} /** *

Changes information about the current Account resource.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { APIGatewayClient, UpdateAccountCommand } from "@aws-sdk/client-api-gateway"; // ES Modules import + * // const { APIGatewayClient, UpdateAccountCommand } = require("@aws-sdk/client-api-gateway"); // CommonJS import + * const client = new APIGatewayClient(config); + * const command = new UpdateAccountCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link UpdateAccountCommandInput} for command's `input` shape. + * @see {@link UpdateAccountCommandOutput} for command's `response` shape. + * @see {@link APIGatewayClientResolvedConfig | config} for command's `input` shape. + * */ export class UpdateAccountCommand extends $Command< UpdateAccountCommandInput, diff --git a/clients/client-api-gateway/commands/UpdateApiKeyCommand.ts b/clients/client-api-gateway/commands/UpdateApiKeyCommand.ts index 334a082b0d3c..e9ba19605928 100644 --- a/clients/client-api-gateway/commands/UpdateApiKeyCommand.ts +++ b/clients/client-api-gateway/commands/UpdateApiKeyCommand.ts @@ -22,6 +22,20 @@ export interface UpdateApiKeyCommandOutput extends ApiKey, __MetadataBearer {} /** *

Changes information about an ApiKey resource.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { APIGatewayClient, UpdateApiKeyCommand } from "@aws-sdk/client-api-gateway"; // ES Modules import + * // const { APIGatewayClient, UpdateApiKeyCommand } = require("@aws-sdk/client-api-gateway"); // CommonJS import + * const client = new APIGatewayClient(config); + * const command = new UpdateApiKeyCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link UpdateApiKeyCommandInput} for command's `input` shape. + * @see {@link UpdateApiKeyCommandOutput} for command's `response` shape. + * @see {@link APIGatewayClientResolvedConfig | config} for command's `input` shape. + * */ export class UpdateApiKeyCommand extends $Command< UpdateApiKeyCommandInput, diff --git a/clients/client-api-gateway/commands/UpdateAuthorizerCommand.ts b/clients/client-api-gateway/commands/UpdateAuthorizerCommand.ts index 0f67c402d4ac..00d2e5762c17 100644 --- a/clients/client-api-gateway/commands/UpdateAuthorizerCommand.ts +++ b/clients/client-api-gateway/commands/UpdateAuthorizerCommand.ts @@ -23,6 +23,20 @@ export interface UpdateAuthorizerCommandOutput extends Authorizer, __MetadataBea /** *

Updates an existing Authorizer resource.

*
AWS CLI
+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { APIGatewayClient, UpdateAuthorizerCommand } from "@aws-sdk/client-api-gateway"; // ES Modules import + * // const { APIGatewayClient, UpdateAuthorizerCommand } = require("@aws-sdk/client-api-gateway"); // CommonJS import + * const client = new APIGatewayClient(config); + * const command = new UpdateAuthorizerCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link UpdateAuthorizerCommandInput} for command's `input` shape. + * @see {@link UpdateAuthorizerCommandOutput} for command's `response` shape. + * @see {@link APIGatewayClientResolvedConfig | config} for command's `input` shape. + * */ export class UpdateAuthorizerCommand extends $Command< UpdateAuthorizerCommandInput, diff --git a/clients/client-api-gateway/commands/UpdateBasePathMappingCommand.ts b/clients/client-api-gateway/commands/UpdateBasePathMappingCommand.ts index a493628fe5e7..2ae4e2aee0e9 100644 --- a/clients/client-api-gateway/commands/UpdateBasePathMappingCommand.ts +++ b/clients/client-api-gateway/commands/UpdateBasePathMappingCommand.ts @@ -22,6 +22,20 @@ export interface UpdateBasePathMappingCommandOutput extends BasePathMapping, __M /** *

Changes information about the BasePathMapping resource.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { APIGatewayClient, UpdateBasePathMappingCommand } from "@aws-sdk/client-api-gateway"; // ES Modules import + * // const { APIGatewayClient, UpdateBasePathMappingCommand } = require("@aws-sdk/client-api-gateway"); // CommonJS import + * const client = new APIGatewayClient(config); + * const command = new UpdateBasePathMappingCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link UpdateBasePathMappingCommandInput} for command's `input` shape. + * @see {@link UpdateBasePathMappingCommandOutput} for command's `response` shape. + * @see {@link APIGatewayClientResolvedConfig | config} for command's `input` shape. + * */ export class UpdateBasePathMappingCommand extends $Command< UpdateBasePathMappingCommandInput, diff --git a/clients/client-api-gateway/commands/UpdateClientCertificateCommand.ts b/clients/client-api-gateway/commands/UpdateClientCertificateCommand.ts index 0094e89b002a..13f39e067c85 100644 --- a/clients/client-api-gateway/commands/UpdateClientCertificateCommand.ts +++ b/clients/client-api-gateway/commands/UpdateClientCertificateCommand.ts @@ -22,6 +22,20 @@ export interface UpdateClientCertificateCommandOutput extends ClientCertificate, /** *

Changes information about an ClientCertificate resource.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { APIGatewayClient, UpdateClientCertificateCommand } from "@aws-sdk/client-api-gateway"; // ES Modules import + * // const { APIGatewayClient, UpdateClientCertificateCommand } = require("@aws-sdk/client-api-gateway"); // CommonJS import + * const client = new APIGatewayClient(config); + * const command = new UpdateClientCertificateCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link UpdateClientCertificateCommandInput} for command's `input` shape. + * @see {@link UpdateClientCertificateCommandOutput} for command's `response` shape. + * @see {@link APIGatewayClientResolvedConfig | config} for command's `input` shape. + * */ export class UpdateClientCertificateCommand extends $Command< UpdateClientCertificateCommandInput, diff --git a/clients/client-api-gateway/commands/UpdateDeploymentCommand.ts b/clients/client-api-gateway/commands/UpdateDeploymentCommand.ts index 0c6821b49277..dbe11aa369c8 100644 --- a/clients/client-api-gateway/commands/UpdateDeploymentCommand.ts +++ b/clients/client-api-gateway/commands/UpdateDeploymentCommand.ts @@ -22,6 +22,20 @@ export interface UpdateDeploymentCommandOutput extends Deployment, __MetadataBea /** *

Changes information about a Deployment resource.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { APIGatewayClient, UpdateDeploymentCommand } from "@aws-sdk/client-api-gateway"; // ES Modules import + * // const { APIGatewayClient, UpdateDeploymentCommand } = require("@aws-sdk/client-api-gateway"); // CommonJS import + * const client = new APIGatewayClient(config); + * const command = new UpdateDeploymentCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link UpdateDeploymentCommandInput} for command's `input` shape. + * @see {@link UpdateDeploymentCommandOutput} for command's `response` shape. + * @see {@link APIGatewayClientResolvedConfig | config} for command's `input` shape. + * */ export class UpdateDeploymentCommand extends $Command< UpdateDeploymentCommandInput, diff --git a/clients/client-api-gateway/commands/UpdateDomainNameCommand.ts b/clients/client-api-gateway/commands/UpdateDomainNameCommand.ts index 6aeab99f7eef..a67b9e092997 100644 --- a/clients/client-api-gateway/commands/UpdateDomainNameCommand.ts +++ b/clients/client-api-gateway/commands/UpdateDomainNameCommand.ts @@ -22,6 +22,20 @@ export interface UpdateDomainNameCommandOutput extends DomainName, __MetadataBea /** *

Changes information about the DomainName resource.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { APIGatewayClient, UpdateDomainNameCommand } from "@aws-sdk/client-api-gateway"; // ES Modules import + * // const { APIGatewayClient, UpdateDomainNameCommand } = require("@aws-sdk/client-api-gateway"); // CommonJS import + * const client = new APIGatewayClient(config); + * const command = new UpdateDomainNameCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link UpdateDomainNameCommandInput} for command's `input` shape. + * @see {@link UpdateDomainNameCommandOutput} for command's `response` shape. + * @see {@link APIGatewayClientResolvedConfig | config} for command's `input` shape. + * */ export class UpdateDomainNameCommand extends $Command< UpdateDomainNameCommandInput, diff --git a/clients/client-api-gateway/commands/UpdateGatewayResponseCommand.ts b/clients/client-api-gateway/commands/UpdateGatewayResponseCommand.ts index f839c31030fc..7ce0fb18c35d 100644 --- a/clients/client-api-gateway/commands/UpdateGatewayResponseCommand.ts +++ b/clients/client-api-gateway/commands/UpdateGatewayResponseCommand.ts @@ -22,6 +22,20 @@ export interface UpdateGatewayResponseCommandOutput extends GatewayResponse, __M /** *

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

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { APIGatewayClient, UpdateGatewayResponseCommand } from "@aws-sdk/client-api-gateway"; // ES Modules import + * // const { APIGatewayClient, UpdateGatewayResponseCommand } = require("@aws-sdk/client-api-gateway"); // CommonJS import + * const client = new APIGatewayClient(config); + * const command = new UpdateGatewayResponseCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link UpdateGatewayResponseCommandInput} for command's `input` shape. + * @see {@link UpdateGatewayResponseCommandOutput} for command's `response` shape. + * @see {@link APIGatewayClientResolvedConfig | config} for command's `input` shape. + * */ export class UpdateGatewayResponseCommand extends $Command< UpdateGatewayResponseCommandInput, diff --git a/clients/client-api-gateway/commands/UpdateIntegrationCommand.ts b/clients/client-api-gateway/commands/UpdateIntegrationCommand.ts index 0856a802c9a1..bef447c7bc5c 100644 --- a/clients/client-api-gateway/commands/UpdateIntegrationCommand.ts +++ b/clients/client-api-gateway/commands/UpdateIntegrationCommand.ts @@ -22,6 +22,20 @@ export interface UpdateIntegrationCommandOutput extends Integration, __MetadataB /** *

Represents an update integration.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { APIGatewayClient, UpdateIntegrationCommand } from "@aws-sdk/client-api-gateway"; // ES Modules import + * // const { APIGatewayClient, UpdateIntegrationCommand } = require("@aws-sdk/client-api-gateway"); // CommonJS import + * const client = new APIGatewayClient(config); + * const command = new UpdateIntegrationCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link UpdateIntegrationCommandInput} for command's `input` shape. + * @see {@link UpdateIntegrationCommandOutput} for command's `response` shape. + * @see {@link APIGatewayClientResolvedConfig | config} for command's `input` shape. + * */ export class UpdateIntegrationCommand extends $Command< UpdateIntegrationCommandInput, diff --git a/clients/client-api-gateway/commands/UpdateIntegrationResponseCommand.ts b/clients/client-api-gateway/commands/UpdateIntegrationResponseCommand.ts index af9fb3561e8e..9eb963b7967d 100644 --- a/clients/client-api-gateway/commands/UpdateIntegrationResponseCommand.ts +++ b/clients/client-api-gateway/commands/UpdateIntegrationResponseCommand.ts @@ -22,6 +22,20 @@ export interface UpdateIntegrationResponseCommandOutput extends IntegrationRespo /** *

Represents an update integration response.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { APIGatewayClient, UpdateIntegrationResponseCommand } from "@aws-sdk/client-api-gateway"; // ES Modules import + * // const { APIGatewayClient, UpdateIntegrationResponseCommand } = require("@aws-sdk/client-api-gateway"); // CommonJS import + * const client = new APIGatewayClient(config); + * const command = new UpdateIntegrationResponseCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link UpdateIntegrationResponseCommandInput} for command's `input` shape. + * @see {@link UpdateIntegrationResponseCommandOutput} for command's `response` shape. + * @see {@link APIGatewayClientResolvedConfig | config} for command's `input` shape. + * */ export class UpdateIntegrationResponseCommand extends $Command< UpdateIntegrationResponseCommandInput, diff --git a/clients/client-api-gateway/commands/UpdateMethodCommand.ts b/clients/client-api-gateway/commands/UpdateMethodCommand.ts index 1eeaff41fdb9..12657973be91 100644 --- a/clients/client-api-gateway/commands/UpdateMethodCommand.ts +++ b/clients/client-api-gateway/commands/UpdateMethodCommand.ts @@ -22,6 +22,20 @@ export interface UpdateMethodCommandOutput extends Method, __MetadataBearer {} /** *

Updates an existing Method resource.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { APIGatewayClient, UpdateMethodCommand } from "@aws-sdk/client-api-gateway"; // ES Modules import + * // const { APIGatewayClient, UpdateMethodCommand } = require("@aws-sdk/client-api-gateway"); // CommonJS import + * const client = new APIGatewayClient(config); + * const command = new UpdateMethodCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link UpdateMethodCommandInput} for command's `input` shape. + * @see {@link UpdateMethodCommandOutput} for command's `response` shape. + * @see {@link APIGatewayClientResolvedConfig | config} for command's `input` shape. + * */ export class UpdateMethodCommand extends $Command< UpdateMethodCommandInput, diff --git a/clients/client-api-gateway/commands/UpdateMethodResponseCommand.ts b/clients/client-api-gateway/commands/UpdateMethodResponseCommand.ts index 865a110b7bd3..da8cf4c20831 100644 --- a/clients/client-api-gateway/commands/UpdateMethodResponseCommand.ts +++ b/clients/client-api-gateway/commands/UpdateMethodResponseCommand.ts @@ -22,6 +22,20 @@ export interface UpdateMethodResponseCommandOutput extends MethodResponse, __Met /** *

Updates an existing MethodResponse resource.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { APIGatewayClient, UpdateMethodResponseCommand } from "@aws-sdk/client-api-gateway"; // ES Modules import + * // const { APIGatewayClient, UpdateMethodResponseCommand } = require("@aws-sdk/client-api-gateway"); // CommonJS import + * const client = new APIGatewayClient(config); + * const command = new UpdateMethodResponseCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link UpdateMethodResponseCommandInput} for command's `input` shape. + * @see {@link UpdateMethodResponseCommandOutput} for command's `response` shape. + * @see {@link APIGatewayClientResolvedConfig | config} for command's `input` shape. + * */ export class UpdateMethodResponseCommand extends $Command< UpdateMethodResponseCommandInput, diff --git a/clients/client-api-gateway/commands/UpdateModelCommand.ts b/clients/client-api-gateway/commands/UpdateModelCommand.ts index 90d60666d745..e0e4f2d16f6e 100644 --- a/clients/client-api-gateway/commands/UpdateModelCommand.ts +++ b/clients/client-api-gateway/commands/UpdateModelCommand.ts @@ -22,6 +22,20 @@ export interface UpdateModelCommandOutput extends Model, __MetadataBearer {} /** *

Changes information about a model.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { APIGatewayClient, UpdateModelCommand } from "@aws-sdk/client-api-gateway"; // ES Modules import + * // const { APIGatewayClient, UpdateModelCommand } = require("@aws-sdk/client-api-gateway"); // CommonJS import + * const client = new APIGatewayClient(config); + * const command = new UpdateModelCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link UpdateModelCommandInput} for command's `input` shape. + * @see {@link UpdateModelCommandOutput} for command's `response` shape. + * @see {@link APIGatewayClientResolvedConfig | config} for command's `input` shape. + * */ export class UpdateModelCommand extends $Command< UpdateModelCommandInput, diff --git a/clients/client-api-gateway/commands/UpdateRequestValidatorCommand.ts b/clients/client-api-gateway/commands/UpdateRequestValidatorCommand.ts index 8d450ecd652a..4d88e99dc52c 100644 --- a/clients/client-api-gateway/commands/UpdateRequestValidatorCommand.ts +++ b/clients/client-api-gateway/commands/UpdateRequestValidatorCommand.ts @@ -22,6 +22,20 @@ export interface UpdateRequestValidatorCommandOutput extends RequestValidator, _ /** *

Updates a RequestValidator of a given RestApi.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { APIGatewayClient, UpdateRequestValidatorCommand } from "@aws-sdk/client-api-gateway"; // ES Modules import + * // const { APIGatewayClient, UpdateRequestValidatorCommand } = require("@aws-sdk/client-api-gateway"); // CommonJS import + * const client = new APIGatewayClient(config); + * const command = new UpdateRequestValidatorCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link UpdateRequestValidatorCommandInput} for command's `input` shape. + * @see {@link UpdateRequestValidatorCommandOutput} for command's `response` shape. + * @see {@link APIGatewayClientResolvedConfig | config} for command's `input` shape. + * */ export class UpdateRequestValidatorCommand extends $Command< UpdateRequestValidatorCommandInput, diff --git a/clients/client-api-gateway/commands/UpdateResourceCommand.ts b/clients/client-api-gateway/commands/UpdateResourceCommand.ts index cd0fc08bb270..b733744f2788 100644 --- a/clients/client-api-gateway/commands/UpdateResourceCommand.ts +++ b/clients/client-api-gateway/commands/UpdateResourceCommand.ts @@ -22,6 +22,20 @@ export interface UpdateResourceCommandOutput extends Resource, __MetadataBearer /** *

Changes information about a Resource resource.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { APIGatewayClient, UpdateResourceCommand } from "@aws-sdk/client-api-gateway"; // ES Modules import + * // const { APIGatewayClient, UpdateResourceCommand } = require("@aws-sdk/client-api-gateway"); // CommonJS import + * const client = new APIGatewayClient(config); + * const command = new UpdateResourceCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link UpdateResourceCommandInput} for command's `input` shape. + * @see {@link UpdateResourceCommandOutput} for command's `response` shape. + * @see {@link APIGatewayClientResolvedConfig | config} for command's `input` shape. + * */ export class UpdateResourceCommand extends $Command< UpdateResourceCommandInput, diff --git a/clients/client-api-gateway/commands/UpdateRestApiCommand.ts b/clients/client-api-gateway/commands/UpdateRestApiCommand.ts index f799485a5e35..0dc6e6f041bf 100644 --- a/clients/client-api-gateway/commands/UpdateRestApiCommand.ts +++ b/clients/client-api-gateway/commands/UpdateRestApiCommand.ts @@ -22,6 +22,20 @@ export interface UpdateRestApiCommandOutput extends RestApi, __MetadataBearer {} /** *

Changes information about the specified API.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { APIGatewayClient, UpdateRestApiCommand } from "@aws-sdk/client-api-gateway"; // ES Modules import + * // const { APIGatewayClient, UpdateRestApiCommand } = require("@aws-sdk/client-api-gateway"); // CommonJS import + * const client = new APIGatewayClient(config); + * const command = new UpdateRestApiCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link UpdateRestApiCommandInput} for command's `input` shape. + * @see {@link UpdateRestApiCommandOutput} for command's `response` shape. + * @see {@link APIGatewayClientResolvedConfig | config} for command's `input` shape. + * */ export class UpdateRestApiCommand extends $Command< UpdateRestApiCommandInput, diff --git a/clients/client-api-gateway/commands/UpdateStageCommand.ts b/clients/client-api-gateway/commands/UpdateStageCommand.ts index c37bf8ac7bbe..7b534416c655 100644 --- a/clients/client-api-gateway/commands/UpdateStageCommand.ts +++ b/clients/client-api-gateway/commands/UpdateStageCommand.ts @@ -22,6 +22,20 @@ export interface UpdateStageCommandOutput extends Stage, __MetadataBearer {} /** *

Changes information about a Stage resource.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { APIGatewayClient, UpdateStageCommand } from "@aws-sdk/client-api-gateway"; // ES Modules import + * // const { APIGatewayClient, UpdateStageCommand } = require("@aws-sdk/client-api-gateway"); // CommonJS import + * const client = new APIGatewayClient(config); + * const command = new UpdateStageCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link UpdateStageCommandInput} for command's `input` shape. + * @see {@link UpdateStageCommandOutput} for command's `response` shape. + * @see {@link APIGatewayClientResolvedConfig | config} for command's `input` shape. + * */ export class UpdateStageCommand extends $Command< UpdateStageCommandInput, diff --git a/clients/client-api-gateway/commands/UpdateUsageCommand.ts b/clients/client-api-gateway/commands/UpdateUsageCommand.ts index 1cda4fdaef43..fc5b51f29599 100644 --- a/clients/client-api-gateway/commands/UpdateUsageCommand.ts +++ b/clients/client-api-gateway/commands/UpdateUsageCommand.ts @@ -22,6 +22,20 @@ export interface UpdateUsageCommandOutput extends Usage, __MetadataBearer {} /** *

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

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { APIGatewayClient, UpdateUsageCommand } from "@aws-sdk/client-api-gateway"; // ES Modules import + * // const { APIGatewayClient, UpdateUsageCommand } = require("@aws-sdk/client-api-gateway"); // CommonJS import + * const client = new APIGatewayClient(config); + * const command = new UpdateUsageCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link UpdateUsageCommandInput} for command's `input` shape. + * @see {@link UpdateUsageCommandOutput} for command's `response` shape. + * @see {@link APIGatewayClientResolvedConfig | config} for command's `input` shape. + * */ export class UpdateUsageCommand extends $Command< UpdateUsageCommandInput, diff --git a/clients/client-api-gateway/commands/UpdateUsagePlanCommand.ts b/clients/client-api-gateway/commands/UpdateUsagePlanCommand.ts index 21429a9a0b7d..dade25efeee4 100644 --- a/clients/client-api-gateway/commands/UpdateUsagePlanCommand.ts +++ b/clients/client-api-gateway/commands/UpdateUsagePlanCommand.ts @@ -22,6 +22,20 @@ export interface UpdateUsagePlanCommandOutput extends UsagePlan, __MetadataBeare /** *

Updates a usage plan of a given plan Id.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { APIGatewayClient, UpdateUsagePlanCommand } from "@aws-sdk/client-api-gateway"; // ES Modules import + * // const { APIGatewayClient, UpdateUsagePlanCommand } = require("@aws-sdk/client-api-gateway"); // CommonJS import + * const client = new APIGatewayClient(config); + * const command = new UpdateUsagePlanCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link UpdateUsagePlanCommandInput} for command's `input` shape. + * @see {@link UpdateUsagePlanCommandOutput} for command's `response` shape. + * @see {@link APIGatewayClientResolvedConfig | config} for command's `input` shape. + * */ export class UpdateUsagePlanCommand extends $Command< UpdateUsagePlanCommandInput, diff --git a/clients/client-api-gateway/commands/UpdateVpcLinkCommand.ts b/clients/client-api-gateway/commands/UpdateVpcLinkCommand.ts index 26e5cc6669f1..c38421e7722b 100644 --- a/clients/client-api-gateway/commands/UpdateVpcLinkCommand.ts +++ b/clients/client-api-gateway/commands/UpdateVpcLinkCommand.ts @@ -22,6 +22,20 @@ export interface UpdateVpcLinkCommandOutput extends VpcLink, __MetadataBearer {} /** *

Updates an existing VpcLink of a specified identifier.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { APIGatewayClient, UpdateVpcLinkCommand } from "@aws-sdk/client-api-gateway"; // ES Modules import + * // const { APIGatewayClient, UpdateVpcLinkCommand } = require("@aws-sdk/client-api-gateway"); // CommonJS import + * const client = new APIGatewayClient(config); + * const command = new UpdateVpcLinkCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link UpdateVpcLinkCommandInput} for command's `input` shape. + * @see {@link UpdateVpcLinkCommandOutput} for command's `response` shape. + * @see {@link APIGatewayClientResolvedConfig | config} for command's `input` shape. + * */ export class UpdateVpcLinkCommand extends $Command< UpdateVpcLinkCommandInput, diff --git a/clients/client-api-gateway/models/models_0.ts b/clients/client-api-gateway/models/models_0.ts index 5ea1ebfdf349..d326cda8f53d 100644 --- a/clients/client-api-gateway/models/models_0.ts +++ b/clients/client-api-gateway/models/models_0.ts @@ -17,6 +17,9 @@ export interface AccessLogSettings { } export namespace AccessLogSettings { + /** + * @internal + */ export const filterSensitiveLog = (obj: AccessLogSettings): any => ({ ...obj, }); @@ -38,6 +41,9 @@ export interface ThrottleSettings { } export namespace ThrottleSettings { + /** + * @internal + */ export const filterSensitiveLog = (obj: ThrottleSettings): any => ({ ...obj, }); @@ -117,6 +123,9 @@ export interface Account { } export namespace Account { + /** + * @internal + */ export const filterSensitiveLog = (obj: Account): any => ({ ...obj, }); @@ -181,6 +190,9 @@ export interface ApiKey { } export namespace ApiKey { + /** + * @internal + */ export const filterSensitiveLog = (obj: ApiKey): any => ({ ...obj, }); @@ -202,6 +214,9 @@ export interface ApiKeyIds { } export namespace ApiKeyIds { + /** + * @internal + */ export const filterSensitiveLog = (obj: ApiKeyIds): any => ({ ...obj, }); @@ -231,6 +246,9 @@ export interface ApiKeys { } export namespace ApiKeys { + /** + * @internal + */ export const filterSensitiveLog = (obj: ApiKeys): any => ({ ...obj, }); @@ -266,6 +284,9 @@ export interface ApiStage { } export namespace ApiStage { + /** + * @internal + */ export const filterSensitiveLog = (obj: ApiStage): any => ({ ...obj, }); @@ -337,6 +358,9 @@ export interface Authorizer { } export namespace Authorizer { + /** + * @internal + */ export const filterSensitiveLog = (obj: Authorizer): any => ({ ...obj, }); @@ -362,6 +386,9 @@ export interface Authorizers { } export namespace Authorizers { + /** + * @internal + */ export const filterSensitiveLog = (obj: Authorizers): any => ({ ...obj, }); @@ -377,6 +404,9 @@ export interface BadRequestException extends __SmithyException, $MetadataBearer } export namespace BadRequestException { + /** + * @internal + */ export const filterSensitiveLog = (obj: BadRequestException): any => ({ ...obj, }); @@ -392,6 +422,9 @@ export interface ConflictException extends __SmithyException, $MetadataBearer { } export namespace ConflictException { + /** + * @internal + */ export const filterSensitiveLog = (obj: ConflictException): any => ({ ...obj, }); @@ -413,6 +446,9 @@ export interface StageKey { } export namespace StageKey { + /** + * @internal + */ export const filterSensitiveLog = (obj: StageKey): any => ({ ...obj, }); @@ -464,6 +500,9 @@ export interface CreateApiKeyRequest { } export namespace CreateApiKeyRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateApiKeyRequest): any => ({ ...obj, }); @@ -480,6 +519,9 @@ export interface LimitExceededException extends __SmithyException, $MetadataBear } export namespace LimitExceededException { + /** + * @internal + */ export const filterSensitiveLog = (obj: LimitExceededException): any => ({ ...obj, }); @@ -495,6 +537,9 @@ export interface NotFoundException extends __SmithyException, $MetadataBearer { } export namespace NotFoundException { + /** + * @internal + */ export const filterSensitiveLog = (obj: NotFoundException): any => ({ ...obj, }); @@ -511,6 +556,9 @@ export interface TooManyRequestsException extends __SmithyException, $MetadataBe } export namespace TooManyRequestsException { + /** + * @internal + */ export const filterSensitiveLog = (obj: TooManyRequestsException): any => ({ ...obj, }); @@ -526,6 +574,9 @@ export interface UnauthorizedException extends __SmithyException, $MetadataBeare } export namespace UnauthorizedException { + /** + * @internal + */ export const filterSensitiveLog = (obj: UnauthorizedException): any => ({ ...obj, }); @@ -587,6 +638,9 @@ export interface CreateAuthorizerRequest { } export namespace CreateAuthorizerRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateAuthorizerRequest): any => ({ ...obj, }); @@ -617,6 +671,9 @@ export interface BasePathMapping { } export namespace BasePathMapping { + /** + * @internal + */ export const filterSensitiveLog = (obj: BasePathMapping): any => ({ ...obj, }); @@ -648,6 +705,9 @@ export interface CreateBasePathMappingRequest { } export namespace CreateBasePathMappingRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateBasePathMappingRequest): any => ({ ...obj, }); @@ -685,6 +745,9 @@ export interface DeploymentCanarySettings { } export namespace DeploymentCanarySettings { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeploymentCanarySettings): any => ({ ...obj, }); @@ -743,6 +806,9 @@ export interface CreateDeploymentRequest { } export namespace CreateDeploymentRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateDeploymentRequest): any => ({ ...obj, }); @@ -764,6 +830,9 @@ export interface MethodSnapshot { } export namespace MethodSnapshot { + /** + * @internal + */ export const filterSensitiveLog = (obj: MethodSnapshot): any => ({ ...obj, }); @@ -801,6 +870,9 @@ export interface Deployment { } export namespace Deployment { + /** + * @internal + */ export const filterSensitiveLog = (obj: Deployment): any => ({ ...obj, }); @@ -817,6 +889,9 @@ export interface ServiceUnavailableException extends __SmithyException, $Metadat } export namespace ServiceUnavailableException { + /** + * @internal + */ export const filterSensitiveLog = (obj: ServiceUnavailableException): any => ({ ...obj, }); @@ -868,6 +943,9 @@ export interface DocumentationPartLocation { } export namespace DocumentationPartLocation { + /** + * @internal + */ export const filterSensitiveLog = (obj: DocumentationPartLocation): any => ({ ...obj, }); @@ -894,6 +972,9 @@ export interface CreateDocumentationPartRequest { } export namespace CreateDocumentationPartRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateDocumentationPartRequest): any => ({ ...obj, }); @@ -926,6 +1007,9 @@ export interface DocumentationPart { } export namespace DocumentationPart { + /** + * @internal + */ export const filterSensitiveLog = (obj: DocumentationPart): any => ({ ...obj, }); @@ -957,6 +1041,9 @@ export interface CreateDocumentationVersionRequest { } export namespace CreateDocumentationVersionRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateDocumentationVersionRequest): any => ({ ...obj, }); @@ -987,6 +1074,9 @@ export interface DocumentationVersion { } export namespace DocumentationVersion { + /** + * @internal + */ export const filterSensitiveLog = (obj: DocumentationVersion): any => ({ ...obj, }); @@ -1010,6 +1100,9 @@ export interface EndpointConfiguration { } export namespace EndpointConfiguration { + /** + * @internal + */ export const filterSensitiveLog = (obj: EndpointConfiguration): any => ({ ...obj, }); @@ -1038,6 +1131,9 @@ export interface MutualTlsAuthenticationInput { } export namespace MutualTlsAuthenticationInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: MutualTlsAuthenticationInput): any => ({ ...obj, }); @@ -1111,6 +1207,9 @@ export interface CreateDomainNameRequest { } export namespace CreateDomainNameRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateDomainNameRequest): any => ({ ...obj, }); @@ -1152,6 +1251,9 @@ export interface MutualTlsAuthentication { } export namespace MutualTlsAuthentication { + /** + * @internal + */ export const filterSensitiveLog = (obj: MutualTlsAuthentication): any => ({ ...obj, }); @@ -1250,6 +1352,9 @@ export interface DomainName { } export namespace DomainName { + /** + * @internal + */ export const filterSensitiveLog = (obj: DomainName): any => ({ ...obj, }); @@ -1286,6 +1391,9 @@ export interface CreateModelRequest { } export namespace CreateModelRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateModelRequest): any => ({ ...obj, }); @@ -1329,6 +1437,9 @@ export interface Model { } export namespace Model { + /** + * @internal + */ export const filterSensitiveLog = (obj: Model): any => ({ ...obj, }); @@ -1360,6 +1471,9 @@ export interface CreateRequestValidatorRequest { } export namespace CreateRequestValidatorRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateRequestValidatorRequest): any => ({ ...obj, }); @@ -1395,6 +1509,9 @@ export interface RequestValidator { } export namespace RequestValidator { + /** + * @internal + */ export const filterSensitiveLog = (obj: RequestValidator): any => ({ ...obj, }); @@ -1421,6 +1538,9 @@ export interface CreateResourceRequest { } export namespace CreateResourceRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateResourceRequest): any => ({ ...obj, }); @@ -1476,6 +1596,9 @@ export interface IntegrationResponse { } export namespace IntegrationResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: IntegrationResponse): any => ({ ...obj, }); @@ -1495,6 +1618,9 @@ export interface TlsConfig { } export namespace TlsConfig { + /** + * @internal + */ export const filterSensitiveLog = (obj: TlsConfig): any => ({ ...obj, }); @@ -1678,6 +1804,9 @@ export interface Integration { } export namespace Integration { + /** + * @internal + */ export const filterSensitiveLog = (obj: Integration): any => ({ ...obj, }); @@ -1748,6 +1877,9 @@ export interface MethodResponse { } export namespace MethodResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: MethodResponse): any => ({ ...obj, }); @@ -2112,6 +2244,9 @@ export interface Method { } export namespace Method { + /** + * @internal + */ export const filterSensitiveLog = (obj: Method): any => ({ ...obj, }); @@ -2303,6 +2438,9 @@ export interface Resource { } export namespace Resource { + /** + * @internal + */ export const filterSensitiveLog = (obj: Resource): any => ({ ...obj, }); @@ -2369,6 +2507,9 @@ export interface CreateRestApiRequest { } export namespace CreateRestApiRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateRestApiRequest): any => ({ ...obj, }); @@ -2448,6 +2589,9 @@ export interface RestApi { } export namespace RestApi { + /** + * @internal + */ export const filterSensitiveLog = (obj: RestApi): any => ({ ...obj, }); @@ -2479,6 +2623,9 @@ export interface CanarySettings { } export namespace CanarySettings { + /** + * @internal + */ export const filterSensitiveLog = (obj: CanarySettings): any => ({ ...obj, }); @@ -2547,6 +2694,9 @@ export interface CreateStageRequest { } export namespace CreateStageRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateStageRequest): any => ({ ...obj, }); @@ -2622,6 +2772,9 @@ export interface MethodSetting { } export namespace MethodSetting { + /** + * @internal + */ export const filterSensitiveLog = (obj: MethodSetting): any => ({ ...obj, }); @@ -2722,6 +2875,9 @@ export interface Stage { } export namespace Stage { + /** + * @internal + */ export const filterSensitiveLog = (obj: Stage): any => ({ ...obj, }); @@ -2754,6 +2910,9 @@ export interface QuotaSettings { } export namespace QuotaSettings { + /** + * @internal + */ export const filterSensitiveLog = (obj: QuotaSettings): any => ({ ...obj, }); @@ -2795,6 +2954,9 @@ export interface CreateUsagePlanRequest { } export namespace CreateUsagePlanRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateUsagePlanRequest): any => ({ ...obj, }); @@ -2852,6 +3014,9 @@ export interface UsagePlan { } export namespace UsagePlan { + /** + * @internal + */ export const filterSensitiveLog = (obj: UsagePlan): any => ({ ...obj, }); @@ -2878,6 +3043,9 @@ export interface CreateUsagePlanKeyRequest { } export namespace CreateUsagePlanKeyRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateUsagePlanKeyRequest): any => ({ ...obj, }); @@ -2915,6 +3083,9 @@ export interface UsagePlanKey { } export namespace UsagePlanKey { + /** + * @internal + */ export const filterSensitiveLog = (obj: UsagePlanKey): any => ({ ...obj, }); @@ -2946,6 +3117,9 @@ export interface CreateVpcLinkRequest { } export namespace CreateVpcLinkRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateVpcLinkRequest): any => ({ ...obj, }); @@ -3002,6 +3176,9 @@ export interface VpcLink { } export namespace VpcLink { + /** + * @internal + */ export const filterSensitiveLog = (obj: VpcLink): any => ({ ...obj, }); @@ -3018,6 +3195,9 @@ export interface DeleteApiKeyRequest { } export namespace DeleteApiKeyRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteApiKeyRequest): any => ({ ...obj, }); @@ -3039,6 +3219,9 @@ export interface DeleteAuthorizerRequest { } export namespace DeleteAuthorizerRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteAuthorizerRequest): any => ({ ...obj, }); @@ -3061,6 +3244,9 @@ export interface DeleteBasePathMappingRequest { } export namespace DeleteBasePathMappingRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteBasePathMappingRequest): any => ({ ...obj, }); @@ -3077,6 +3263,9 @@ export interface DeleteClientCertificateRequest { } export namespace DeleteClientCertificateRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteClientCertificateRequest): any => ({ ...obj, }); @@ -3098,6 +3287,9 @@ export interface DeleteDeploymentRequest { } export namespace DeleteDeploymentRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteDeploymentRequest): any => ({ ...obj, }); @@ -3119,6 +3311,9 @@ export interface DeleteDocumentationPartRequest { } export namespace DeleteDocumentationPartRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteDocumentationPartRequest): any => ({ ...obj, }); @@ -3140,6 +3335,9 @@ export interface DeleteDocumentationVersionRequest { } export namespace DeleteDocumentationVersionRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteDocumentationVersionRequest): any => ({ ...obj, }); @@ -3156,6 +3354,9 @@ export interface DeleteDomainNameRequest { } export namespace DeleteDomainNameRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteDomainNameRequest): any => ({ ...obj, }); @@ -3200,6 +3401,9 @@ export interface DeleteGatewayResponseRequest { } export namespace DeleteGatewayResponseRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteGatewayResponseRequest): any => ({ ...obj, }); @@ -3226,6 +3430,9 @@ export interface DeleteIntegrationRequest { } export namespace DeleteIntegrationRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteIntegrationRequest): any => ({ ...obj, }); @@ -3257,6 +3464,9 @@ export interface DeleteIntegrationResponseRequest { } export namespace DeleteIntegrationResponseRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteIntegrationResponseRequest): any => ({ ...obj, }); @@ -3283,6 +3493,9 @@ export interface DeleteMethodRequest { } export namespace DeleteMethodRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteMethodRequest): any => ({ ...obj, }); @@ -3314,6 +3527,9 @@ export interface DeleteMethodResponseRequest { } export namespace DeleteMethodResponseRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteMethodResponseRequest): any => ({ ...obj, }); @@ -3335,6 +3551,9 @@ export interface DeleteModelRequest { } export namespace DeleteModelRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteModelRequest): any => ({ ...obj, }); @@ -3356,6 +3575,9 @@ export interface DeleteRequestValidatorRequest { } export namespace DeleteRequestValidatorRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteRequestValidatorRequest): any => ({ ...obj, }); @@ -3377,6 +3599,9 @@ export interface DeleteResourceRequest { } export namespace DeleteResourceRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteResourceRequest): any => ({ ...obj, }); @@ -3393,6 +3618,9 @@ export interface DeleteRestApiRequest { } export namespace DeleteRestApiRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteRestApiRequest): any => ({ ...obj, }); @@ -3414,6 +3642,9 @@ export interface DeleteStageRequest { } export namespace DeleteStageRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteStageRequest): any => ({ ...obj, }); @@ -3430,6 +3661,9 @@ export interface DeleteUsagePlanRequest { } export namespace DeleteUsagePlanRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteUsagePlanRequest): any => ({ ...obj, }); @@ -3451,6 +3685,9 @@ export interface DeleteUsagePlanKeyRequest { } export namespace DeleteUsagePlanKeyRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteUsagePlanKeyRequest): any => ({ ...obj, }); @@ -3467,6 +3704,9 @@ export interface DeleteVpcLinkRequest { } export namespace DeleteVpcLinkRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteVpcLinkRequest): any => ({ ...obj, }); @@ -3488,6 +3728,9 @@ export interface FlushStageAuthorizersCacheRequest { } export namespace FlushStageAuthorizersCacheRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: FlushStageAuthorizersCacheRequest): any => ({ ...obj, }); @@ -3509,6 +3752,9 @@ export interface FlushStageCacheRequest { } export namespace FlushStageCacheRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: FlushStageCacheRequest): any => ({ ...obj, }); @@ -3554,6 +3800,9 @@ export interface ClientCertificate { } export namespace ClientCertificate { + /** + * @internal + */ export const filterSensitiveLog = (obj: ClientCertificate): any => ({ ...obj, }); @@ -3575,6 +3824,9 @@ export interface GenerateClientCertificateRequest { } export namespace GenerateClientCertificateRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GenerateClientCertificateRequest): any => ({ ...obj, }); @@ -3586,6 +3838,9 @@ export namespace GenerateClientCertificateRequest { export interface GetAccountRequest {} export namespace GetAccountRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetAccountRequest): any => ({ ...obj, }); @@ -3607,6 +3862,9 @@ export interface GetApiKeyRequest { } export namespace GetApiKeyRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetApiKeyRequest): any => ({ ...obj, }); @@ -3643,6 +3901,9 @@ export interface GetApiKeysRequest { } export namespace GetApiKeysRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetApiKeysRequest): any => ({ ...obj, }); @@ -3664,6 +3925,9 @@ export interface GetAuthorizerRequest { } export namespace GetAuthorizerRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetAuthorizerRequest): any => ({ ...obj, }); @@ -3690,6 +3954,9 @@ export interface GetAuthorizersRequest { } export namespace GetAuthorizersRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetAuthorizersRequest): any => ({ ...obj, }); @@ -3711,6 +3978,9 @@ export interface GetBasePathMappingRequest { } export namespace GetBasePathMappingRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetBasePathMappingRequest): any => ({ ...obj, }); @@ -3735,6 +4005,9 @@ export interface BasePathMappings { } export namespace BasePathMappings { + /** + * @internal + */ export const filterSensitiveLog = (obj: BasePathMappings): any => ({ ...obj, }); @@ -3761,6 +4034,9 @@ export interface GetBasePathMappingsRequest { } export namespace GetBasePathMappingsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetBasePathMappingsRequest): any => ({ ...obj, }); @@ -3777,6 +4053,9 @@ export interface GetClientCertificateRequest { } export namespace GetClientCertificateRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetClientCertificateRequest): any => ({ ...obj, }); @@ -3801,6 +4080,9 @@ export interface ClientCertificates { } export namespace ClientCertificates { + /** + * @internal + */ export const filterSensitiveLog = (obj: ClientCertificates): any => ({ ...obj, }); @@ -3822,6 +4104,9 @@ export interface GetClientCertificatesRequest { } export namespace GetClientCertificatesRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetClientCertificatesRequest): any => ({ ...obj, }); @@ -3848,6 +4133,9 @@ export interface GetDeploymentRequest { } export namespace GetDeploymentRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetDeploymentRequest): any => ({ ...obj, }); @@ -3876,6 +4164,9 @@ export interface Deployments { } export namespace Deployments { + /** + * @internal + */ export const filterSensitiveLog = (obj: Deployments): any => ({ ...obj, }); @@ -3902,6 +4193,9 @@ export interface GetDeploymentsRequest { } export namespace GetDeploymentsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetDeploymentsRequest): any => ({ ...obj, }); @@ -3923,6 +4217,9 @@ export interface GetDocumentationPartRequest { } export namespace GetDocumentationPartRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetDocumentationPartRequest): any => ({ ...obj, }); @@ -3948,6 +4245,9 @@ export interface DocumentationParts { } export namespace DocumentationParts { + /** + * @internal + */ export const filterSensitiveLog = (obj: DocumentationParts): any => ({ ...obj, }); @@ -3999,6 +4299,9 @@ export interface GetDocumentationPartsRequest { } export namespace GetDocumentationPartsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetDocumentationPartsRequest): any => ({ ...obj, }); @@ -4020,6 +4323,9 @@ export interface GetDocumentationVersionRequest { } export namespace GetDocumentationVersionRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetDocumentationVersionRequest): any => ({ ...obj, }); @@ -4045,6 +4351,9 @@ export interface DocumentationVersions { } export namespace DocumentationVersions { + /** + * @internal + */ export const filterSensitiveLog = (obj: DocumentationVersions): any => ({ ...obj, }); @@ -4071,6 +4380,9 @@ export interface GetDocumentationVersionsRequest { } export namespace GetDocumentationVersionsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetDocumentationVersionsRequest): any => ({ ...obj, }); @@ -4087,6 +4399,9 @@ export interface GetDomainNameRequest { } export namespace GetDomainNameRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetDomainNameRequest): any => ({ ...obj, }); @@ -4111,6 +4426,9 @@ export interface DomainNames { } export namespace DomainNames { + /** + * @internal + */ export const filterSensitiveLog = (obj: DomainNames): any => ({ ...obj, }); @@ -4132,6 +4450,9 @@ export interface GetDomainNamesRequest { } export namespace GetDomainNamesRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetDomainNamesRequest): any => ({ ...obj, }); @@ -4158,6 +4479,9 @@ export interface ExportResponse { } export namespace ExportResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ExportResponse): any => ({ ...obj, }); @@ -4194,6 +4518,9 @@ export interface GetExportRequest { } export namespace GetExportRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetExportRequest): any => ({ ...obj, }); @@ -4287,6 +4614,9 @@ export interface GatewayResponse { } export namespace GatewayResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: GatewayResponse): any => ({ ...obj, }); @@ -4308,6 +4638,9 @@ export interface GetGatewayResponseRequest { } export namespace GetGatewayResponseRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetGatewayResponseRequest): any => ({ ...obj, }); @@ -4855,6 +5188,9 @@ export interface GatewayResponses { } export namespace GatewayResponses { + /** + * @internal + */ export const filterSensitiveLog = (obj: GatewayResponses): any => ({ ...obj, }); @@ -4881,6 +5217,9 @@ export interface GetGatewayResponsesRequest { } export namespace GetGatewayResponsesRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetGatewayResponsesRequest): any => ({ ...obj, }); @@ -4907,6 +5246,9 @@ export interface GetIntegrationRequest { } export namespace GetIntegrationRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetIntegrationRequest): any => ({ ...obj, }); @@ -4938,6 +5280,9 @@ export interface GetIntegrationResponseRequest { } export namespace GetIntegrationResponseRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetIntegrationResponseRequest): any => ({ ...obj, }); @@ -4964,6 +5309,9 @@ export interface GetMethodRequest { } export namespace GetMethodRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetMethodRequest): any => ({ ...obj, }); @@ -4995,6 +5343,9 @@ export interface GetMethodResponseRequest { } export namespace GetMethodResponseRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetMethodResponseRequest): any => ({ ...obj, }); @@ -5021,6 +5372,9 @@ export interface GetModelRequest { } export namespace GetModelRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetModelRequest): any => ({ ...obj, }); @@ -5047,6 +5401,9 @@ export interface GetModelsRequest { } export namespace GetModelsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetModelsRequest): any => ({ ...obj, }); @@ -5071,6 +5428,9 @@ export interface Models { } export namespace Models { + /** + * @internal + */ export const filterSensitiveLog = (obj: Models): any => ({ ...obj, }); @@ -5092,6 +5452,9 @@ export interface GetModelTemplateRequest { } export namespace GetModelTemplateRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetModelTemplateRequest): any => ({ ...obj, }); @@ -5111,6 +5474,9 @@ export interface Template { } export namespace Template { + /** + * @internal + */ export const filterSensitiveLog = (obj: Template): any => ({ ...obj, }); @@ -5132,6 +5498,9 @@ export interface GetRequestValidatorRequest { } export namespace GetRequestValidatorRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetRequestValidatorRequest): any => ({ ...obj, }); @@ -5158,6 +5527,9 @@ export interface GetRequestValidatorsRequest { } export namespace GetRequestValidatorsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetRequestValidatorsRequest): any => ({ ...obj, }); @@ -5183,6 +5555,9 @@ export interface RequestValidators { } export namespace RequestValidators { + /** + * @internal + */ export const filterSensitiveLog = (obj: RequestValidators): any => ({ ...obj, }); @@ -5209,6 +5584,9 @@ export interface GetResourceRequest { } export namespace GetResourceRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetResourceRequest): any => ({ ...obj, }); @@ -5240,6 +5618,9 @@ export interface GetResourcesRequest { } export namespace GetResourcesRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetResourcesRequest): any => ({ ...obj, }); @@ -5264,6 +5645,9 @@ export interface Resources { } export namespace Resources { + /** + * @internal + */ export const filterSensitiveLog = (obj: Resources): any => ({ ...obj, }); @@ -5280,6 +5664,9 @@ export interface GetRestApiRequest { } export namespace GetRestApiRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetRestApiRequest): any => ({ ...obj, }); @@ -5301,6 +5688,9 @@ export interface GetRestApisRequest { } export namespace GetRestApisRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetRestApisRequest): any => ({ ...obj, }); @@ -5325,6 +5715,9 @@ export interface RestApis { } export namespace RestApis { + /** + * @internal + */ export const filterSensitiveLog = (obj: RestApis): any => ({ ...obj, }); @@ -5356,6 +5749,9 @@ export interface GetSdkRequest { } export namespace GetSdkRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetSdkRequest): any => ({ ...obj, }); @@ -5382,6 +5778,9 @@ export interface SdkResponse { } export namespace SdkResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: SdkResponse): any => ({ ...obj, }); @@ -5398,6 +5797,9 @@ export interface GetSdkTypeRequest { } export namespace GetSdkTypeRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetSdkTypeRequest): any => ({ ...obj, }); @@ -5434,6 +5836,9 @@ export interface SdkConfigurationProperty { } export namespace SdkConfigurationProperty { + /** + * @internal + */ export const filterSensitiveLog = (obj: SdkConfigurationProperty): any => ({ ...obj, }); @@ -5465,6 +5870,9 @@ export interface SdkType { } export namespace SdkType { + /** + * @internal + */ export const filterSensitiveLog = (obj: SdkType): any => ({ ...obj, }); @@ -5486,6 +5894,9 @@ export interface GetSdkTypesRequest { } export namespace GetSdkTypesRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetSdkTypesRequest): any => ({ ...obj, }); @@ -5502,6 +5913,9 @@ export interface SdkTypes { } export namespace SdkTypes { + /** + * @internal + */ export const filterSensitiveLog = (obj: SdkTypes): any => ({ ...obj, }); @@ -5523,6 +5937,9 @@ export interface GetStageRequest { } export namespace GetStageRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetStageRequest): any => ({ ...obj, }); @@ -5544,6 +5961,9 @@ export interface GetStagesRequest { } export namespace GetStagesRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetStagesRequest): any => ({ ...obj, }); @@ -5561,6 +5981,9 @@ export interface Stages { } export namespace Stages { + /** + * @internal + */ export const filterSensitiveLog = (obj: Stages): any => ({ ...obj, }); @@ -5587,6 +6010,9 @@ export interface GetTagsRequest { } export namespace GetTagsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetTagsRequest): any => ({ ...obj, }); @@ -5603,6 +6029,9 @@ export interface Tags { } export namespace Tags { + /** + * @internal + */ export const filterSensitiveLog = (obj: Tags): any => ({ ...obj, }); @@ -5644,6 +6073,9 @@ export interface GetUsageRequest { } export namespace GetUsageRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetUsageRequest): any => ({ ...obj, }); @@ -5685,6 +6117,9 @@ export interface Usage { } export namespace Usage { + /** + * @internal + */ export const filterSensitiveLog = (obj: Usage): any => ({ ...obj, }); @@ -5701,6 +6136,9 @@ export interface GetUsagePlanRequest { } export namespace GetUsagePlanRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetUsagePlanRequest): any => ({ ...obj, }); @@ -5722,6 +6160,9 @@ export interface GetUsagePlanKeyRequest { } export namespace GetUsagePlanKeyRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetUsagePlanKeyRequest): any => ({ ...obj, }); @@ -5753,6 +6194,9 @@ export interface GetUsagePlanKeysRequest { } export namespace GetUsagePlanKeysRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetUsagePlanKeysRequest): any => ({ ...obj, }); @@ -5777,6 +6221,9 @@ export interface UsagePlanKeys { } export namespace UsagePlanKeys { + /** + * @internal + */ export const filterSensitiveLog = (obj: UsagePlanKeys): any => ({ ...obj, }); @@ -5803,6 +6250,9 @@ export interface GetUsagePlansRequest { } export namespace GetUsagePlansRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetUsagePlansRequest): any => ({ ...obj, }); @@ -5827,6 +6277,9 @@ export interface UsagePlans { } export namespace UsagePlans { + /** + * @internal + */ export const filterSensitiveLog = (obj: UsagePlans): any => ({ ...obj, }); @@ -5843,6 +6296,9 @@ export interface GetVpcLinkRequest { } export namespace GetVpcLinkRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetVpcLinkRequest): any => ({ ...obj, }); @@ -5864,6 +6320,9 @@ export interface GetVpcLinksRequest { } export namespace GetVpcLinksRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetVpcLinksRequest): any => ({ ...obj, }); @@ -5889,6 +6348,9 @@ export interface VpcLinks { } export namespace VpcLinks { + /** + * @internal + */ export const filterSensitiveLog = (obj: VpcLinks): any => ({ ...obj, }); @@ -5915,6 +6377,9 @@ export interface ImportApiKeysRequest { } export namespace ImportApiKeysRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ImportApiKeysRequest): any => ({ ...obj, }); @@ -5940,6 +6405,9 @@ export interface DocumentationPartIds { } export namespace DocumentationPartIds { + /** + * @internal + */ export const filterSensitiveLog = (obj: DocumentationPartIds): any => ({ ...obj, }); @@ -5976,6 +6444,9 @@ export interface ImportDocumentationPartsRequest { } export namespace ImportDocumentationPartsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ImportDocumentationPartsRequest): any => ({ ...obj, }); @@ -6010,6 +6481,9 @@ export interface ImportRestApiRequest { } export namespace ImportRestApiRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ImportRestApiRequest): any => ({ ...obj, }); @@ -6046,6 +6520,9 @@ export interface PutGatewayResponseRequest { } export namespace PutGatewayResponseRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: PutGatewayResponseRequest): any => ({ ...obj, }); @@ -6155,6 +6632,9 @@ export interface PutIntegrationRequest { } export namespace PutIntegrationRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: PutIntegrationRequest): any => ({ ...obj, }); @@ -6212,6 +6692,9 @@ export interface PutIntegrationResponseRequest { } export namespace PutIntegrationResponseRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: PutIntegrationResponseRequest): any => ({ ...obj, }); @@ -6278,6 +6761,9 @@ export interface PutMethodRequest { } export namespace PutMethodRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: PutMethodRequest): any => ({ ...obj, }); @@ -6319,6 +6805,9 @@ export interface PutMethodResponseRequest { } export namespace PutMethodResponseRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: PutMethodResponseRequest): any => ({ ...obj, }); @@ -6357,6 +6846,9 @@ export interface PutRestApiRequest { } export namespace PutRestApiRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: PutRestApiRequest): any => ({ ...obj, }); @@ -6378,6 +6870,9 @@ export interface TagResourceRequest { } export namespace TagResourceRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: TagResourceRequest): any => ({ ...obj, }); @@ -6429,6 +6924,9 @@ export interface TestInvokeAuthorizerRequest { } export namespace TestInvokeAuthorizerRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: TestInvokeAuthorizerRequest): any => ({ ...obj, }); @@ -6471,6 +6969,9 @@ export interface TestInvokeAuthorizerResponse { } export namespace TestInvokeAuthorizerResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: TestInvokeAuthorizerResponse): any => ({ ...obj, }); @@ -6527,6 +7028,9 @@ export interface TestInvokeMethodRequest { } export namespace TestInvokeMethodRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: TestInvokeMethodRequest): any => ({ ...obj, }); @@ -6571,6 +7075,9 @@ export interface TestInvokeMethodResponse { } export namespace TestInvokeMethodResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: TestInvokeMethodResponse): any => ({ ...obj, }); @@ -6592,6 +7099,9 @@ export interface UntagResourceRequest { } export namespace UntagResourceRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: UntagResourceRequest): any => ({ ...obj, }); @@ -6626,6 +7136,9 @@ export interface PatchOperation { } export namespace PatchOperation { + /** + * @internal + */ export const filterSensitiveLog = (obj: PatchOperation): any => ({ ...obj, }); @@ -6642,6 +7155,9 @@ export interface UpdateAccountRequest { } export namespace UpdateAccountRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateAccountRequest): any => ({ ...obj, }); @@ -6663,6 +7179,9 @@ export interface UpdateApiKeyRequest { } export namespace UpdateApiKeyRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateApiKeyRequest): any => ({ ...obj, }); @@ -6689,6 +7208,9 @@ export interface UpdateAuthorizerRequest { } export namespace UpdateAuthorizerRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateAuthorizerRequest): any => ({ ...obj, }); @@ -6716,6 +7238,9 @@ export interface UpdateBasePathMappingRequest { } export namespace UpdateBasePathMappingRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateBasePathMappingRequest): any => ({ ...obj, }); @@ -6737,6 +7262,9 @@ export interface UpdateClientCertificateRequest { } export namespace UpdateClientCertificateRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateClientCertificateRequest): any => ({ ...obj, }); @@ -6763,6 +7291,9 @@ export interface UpdateDeploymentRequest { } export namespace UpdateDeploymentRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateDeploymentRequest): any => ({ ...obj, }); @@ -6789,6 +7320,9 @@ export interface UpdateDocumentationPartRequest { } export namespace UpdateDocumentationPartRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateDocumentationPartRequest): any => ({ ...obj, }); @@ -6815,6 +7349,9 @@ export interface UpdateDocumentationVersionRequest { } export namespace UpdateDocumentationVersionRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateDocumentationVersionRequest): any => ({ ...obj, }); @@ -6836,6 +7373,9 @@ export interface UpdateDomainNameRequest { } export namespace UpdateDomainNameRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateDomainNameRequest): any => ({ ...obj, }); @@ -6862,6 +7402,9 @@ export interface UpdateGatewayResponseRequest { } export namespace UpdateGatewayResponseRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateGatewayResponseRequest): any => ({ ...obj, }); @@ -6893,6 +7436,9 @@ export interface UpdateIntegrationRequest { } export namespace UpdateIntegrationRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateIntegrationRequest): any => ({ ...obj, }); @@ -6929,6 +7475,9 @@ export interface UpdateIntegrationResponseRequest { } export namespace UpdateIntegrationResponseRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateIntegrationResponseRequest): any => ({ ...obj, }); @@ -6960,6 +7509,9 @@ export interface UpdateMethodRequest { } export namespace UpdateMethodRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateMethodRequest): any => ({ ...obj, }); @@ -6996,6 +7548,9 @@ export interface UpdateMethodResponseRequest { } export namespace UpdateMethodResponseRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateMethodResponseRequest): any => ({ ...obj, }); @@ -7022,6 +7577,9 @@ export interface UpdateModelRequest { } export namespace UpdateModelRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateModelRequest): any => ({ ...obj, }); @@ -7048,6 +7606,9 @@ export interface UpdateRequestValidatorRequest { } export namespace UpdateRequestValidatorRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateRequestValidatorRequest): any => ({ ...obj, }); @@ -7074,6 +7635,9 @@ export interface UpdateResourceRequest { } export namespace UpdateResourceRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateResourceRequest): any => ({ ...obj, }); @@ -7095,6 +7659,9 @@ export interface UpdateRestApiRequest { } export namespace UpdateRestApiRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateRestApiRequest): any => ({ ...obj, }); @@ -7121,6 +7688,9 @@ export interface UpdateStageRequest { } export namespace UpdateStageRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateStageRequest): any => ({ ...obj, }); @@ -7147,6 +7717,9 @@ export interface UpdateUsageRequest { } export namespace UpdateUsageRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateUsageRequest): any => ({ ...obj, }); @@ -7168,6 +7741,9 @@ export interface UpdateUsagePlanRequest { } export namespace UpdateUsagePlanRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateUsagePlanRequest): any => ({ ...obj, }); @@ -7189,6 +7765,9 @@ export interface UpdateVpcLinkRequest { } export namespace UpdateVpcLinkRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateVpcLinkRequest): any => ({ ...obj, }); diff --git a/clients/client-apigatewaymanagementapi/commands/DeleteConnectionCommand.ts b/clients/client-apigatewaymanagementapi/commands/DeleteConnectionCommand.ts index 295494874eb4..991eee3356b6 100644 --- a/clients/client-apigatewaymanagementapi/commands/DeleteConnectionCommand.ts +++ b/clients/client-apigatewaymanagementapi/commands/DeleteConnectionCommand.ts @@ -26,6 +26,20 @@ export interface DeleteConnectionCommandOutput extends __MetadataBearer {} /** *

Delete the connection with the provided id.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ApiGatewayManagementApiClient, DeleteConnectionCommand } from "@aws-sdk/client-apigatewaymanagementapi"; // ES Modules import + * // const { ApiGatewayManagementApiClient, DeleteConnectionCommand } = require("@aws-sdk/client-apigatewaymanagementapi"); // CommonJS import + * const client = new ApiGatewayManagementApiClient(config); + * const command = new DeleteConnectionCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteConnectionCommandInput} for command's `input` shape. + * @see {@link DeleteConnectionCommandOutput} for command's `response` shape. + * @see {@link ApiGatewayManagementApiClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteConnectionCommand extends $Command< DeleteConnectionCommandInput, diff --git a/clients/client-apigatewaymanagementapi/commands/GetConnectionCommand.ts b/clients/client-apigatewaymanagementapi/commands/GetConnectionCommand.ts index de95ef91cff6..ab06d1e286a9 100644 --- a/clients/client-apigatewaymanagementapi/commands/GetConnectionCommand.ts +++ b/clients/client-apigatewaymanagementapi/commands/GetConnectionCommand.ts @@ -26,6 +26,20 @@ export interface GetConnectionCommandOutput extends GetConnectionResponse, __Met /** *

Get information about the connection with the provided id.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ApiGatewayManagementApiClient, GetConnectionCommand } from "@aws-sdk/client-apigatewaymanagementapi"; // ES Modules import + * // const { ApiGatewayManagementApiClient, GetConnectionCommand } = require("@aws-sdk/client-apigatewaymanagementapi"); // CommonJS import + * const client = new ApiGatewayManagementApiClient(config); + * const command = new GetConnectionCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetConnectionCommandInput} for command's `input` shape. + * @see {@link GetConnectionCommandOutput} for command's `response` shape. + * @see {@link ApiGatewayManagementApiClientResolvedConfig | config} for command's `input` shape. + * */ export class GetConnectionCommand extends $Command< GetConnectionCommandInput, diff --git a/clients/client-apigatewaymanagementapi/commands/PostToConnectionCommand.ts b/clients/client-apigatewaymanagementapi/commands/PostToConnectionCommand.ts index 52491b7ba5d1..a15563a8fc2c 100644 --- a/clients/client-apigatewaymanagementapi/commands/PostToConnectionCommand.ts +++ b/clients/client-apigatewaymanagementapi/commands/PostToConnectionCommand.ts @@ -26,6 +26,20 @@ export interface PostToConnectionCommandOutput extends __MetadataBearer {} /** *

Sends the provided data to the specified connection.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ApiGatewayManagementApiClient, PostToConnectionCommand } from "@aws-sdk/client-apigatewaymanagementapi"; // ES Modules import + * // const { ApiGatewayManagementApiClient, PostToConnectionCommand } = require("@aws-sdk/client-apigatewaymanagementapi"); // CommonJS import + * const client = new ApiGatewayManagementApiClient(config); + * const command = new PostToConnectionCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link PostToConnectionCommandInput} for command's `input` shape. + * @see {@link PostToConnectionCommandOutput} for command's `response` shape. + * @see {@link ApiGatewayManagementApiClientResolvedConfig | config} for command's `input` shape. + * */ export class PostToConnectionCommand extends $Command< PostToConnectionCommandInput, diff --git a/clients/client-apigatewaymanagementapi/models/models_0.ts b/clients/client-apigatewaymanagementapi/models/models_0.ts index d23ef63ec502..ac70341f543a 100644 --- a/clients/client-apigatewaymanagementapi/models/models_0.ts +++ b/clients/client-apigatewaymanagementapi/models/models_0.ts @@ -6,6 +6,9 @@ export interface DeleteConnectionRequest { } export namespace DeleteConnectionRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteConnectionRequest): any => ({ ...obj, }); @@ -20,6 +23,9 @@ export interface ForbiddenException extends __SmithyException, $MetadataBearer { } export namespace ForbiddenException { + /** + * @internal + */ export const filterSensitiveLog = (obj: ForbiddenException): any => ({ ...obj, }); @@ -34,6 +40,9 @@ export interface GoneException extends __SmithyException, $MetadataBearer { } export namespace GoneException { + /** + * @internal + */ export const filterSensitiveLog = (obj: GoneException): any => ({ ...obj, }); @@ -48,6 +57,9 @@ export interface LimitExceededException extends __SmithyException, $MetadataBear } export namespace LimitExceededException { + /** + * @internal + */ export const filterSensitiveLog = (obj: LimitExceededException): any => ({ ...obj, }); @@ -58,6 +70,9 @@ export interface GetConnectionRequest { } export namespace GetConnectionRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetConnectionRequest): any => ({ ...obj, }); @@ -76,6 +91,9 @@ export interface Identity { } export namespace Identity { + /** + * @internal + */ export const filterSensitiveLog = (obj: Identity): any => ({ ...obj, }); @@ -95,6 +113,9 @@ export interface GetConnectionResponse { } export namespace GetConnectionResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetConnectionResponse): any => ({ ...obj, }); @@ -110,6 +131,9 @@ export interface PayloadTooLargeException extends __SmithyException, $MetadataBe } export namespace PayloadTooLargeException { + /** + * @internal + */ export const filterSensitiveLog = (obj: PayloadTooLargeException): any => ({ ...obj, }); @@ -128,6 +152,9 @@ export interface PostToConnectionRequest { } export namespace PostToConnectionRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: PostToConnectionRequest): any => ({ ...obj, }); diff --git a/clients/client-apigatewayv2/commands/CreateApiCommand.ts b/clients/client-apigatewayv2/commands/CreateApiCommand.ts index f0f4323b7e7b..77ba2665b2b6 100644 --- a/clients/client-apigatewayv2/commands/CreateApiCommand.ts +++ b/clients/client-apigatewayv2/commands/CreateApiCommand.ts @@ -22,6 +22,20 @@ export interface CreateApiCommandOutput extends CreateApiResponse, __MetadataBea /** *

Creates an Api resource.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ApiGatewayV2Client, CreateApiCommand } from "@aws-sdk/client-apigatewayv2"; // ES Modules import + * // const { ApiGatewayV2Client, CreateApiCommand } = require("@aws-sdk/client-apigatewayv2"); // CommonJS import + * const client = new ApiGatewayV2Client(config); + * const command = new CreateApiCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreateApiCommandInput} for command's `input` shape. + * @see {@link CreateApiCommandOutput} for command's `response` shape. + * @see {@link ApiGatewayV2ClientResolvedConfig | config} for command's `input` shape. + * */ export class CreateApiCommand extends $Command< CreateApiCommandInput, diff --git a/clients/client-apigatewayv2/commands/CreateApiMappingCommand.ts b/clients/client-apigatewayv2/commands/CreateApiMappingCommand.ts index e9b2704a6637..c14cf2c2b30a 100644 --- a/clients/client-apigatewayv2/commands/CreateApiMappingCommand.ts +++ b/clients/client-apigatewayv2/commands/CreateApiMappingCommand.ts @@ -22,6 +22,20 @@ export interface CreateApiMappingCommandOutput extends CreateApiMappingResponse, /** *

Creates an API mapping.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ApiGatewayV2Client, CreateApiMappingCommand } from "@aws-sdk/client-apigatewayv2"; // ES Modules import + * // const { ApiGatewayV2Client, CreateApiMappingCommand } = require("@aws-sdk/client-apigatewayv2"); // CommonJS import + * const client = new ApiGatewayV2Client(config); + * const command = new CreateApiMappingCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreateApiMappingCommandInput} for command's `input` shape. + * @see {@link CreateApiMappingCommandOutput} for command's `response` shape. + * @see {@link ApiGatewayV2ClientResolvedConfig | config} for command's `input` shape. + * */ export class CreateApiMappingCommand extends $Command< CreateApiMappingCommandInput, diff --git a/clients/client-apigatewayv2/commands/CreateAuthorizerCommand.ts b/clients/client-apigatewayv2/commands/CreateAuthorizerCommand.ts index fd06f614321e..38cc77734d49 100644 --- a/clients/client-apigatewayv2/commands/CreateAuthorizerCommand.ts +++ b/clients/client-apigatewayv2/commands/CreateAuthorizerCommand.ts @@ -22,6 +22,20 @@ export interface CreateAuthorizerCommandOutput extends CreateAuthorizerResponse, /** *

Creates an Authorizer for an API.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ApiGatewayV2Client, CreateAuthorizerCommand } from "@aws-sdk/client-apigatewayv2"; // ES Modules import + * // const { ApiGatewayV2Client, CreateAuthorizerCommand } = require("@aws-sdk/client-apigatewayv2"); // CommonJS import + * const client = new ApiGatewayV2Client(config); + * const command = new CreateAuthorizerCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreateAuthorizerCommandInput} for command's `input` shape. + * @see {@link CreateAuthorizerCommandOutput} for command's `response` shape. + * @see {@link ApiGatewayV2ClientResolvedConfig | config} for command's `input` shape. + * */ export class CreateAuthorizerCommand extends $Command< CreateAuthorizerCommandInput, diff --git a/clients/client-apigatewayv2/commands/CreateDeploymentCommand.ts b/clients/client-apigatewayv2/commands/CreateDeploymentCommand.ts index ac435b9009bc..5c009fff64bb 100644 --- a/clients/client-apigatewayv2/commands/CreateDeploymentCommand.ts +++ b/clients/client-apigatewayv2/commands/CreateDeploymentCommand.ts @@ -22,6 +22,20 @@ export interface CreateDeploymentCommandOutput extends CreateDeploymentResponse, /** *

Creates a Deployment for an API.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ApiGatewayV2Client, CreateDeploymentCommand } from "@aws-sdk/client-apigatewayv2"; // ES Modules import + * // const { ApiGatewayV2Client, CreateDeploymentCommand } = require("@aws-sdk/client-apigatewayv2"); // CommonJS import + * const client = new ApiGatewayV2Client(config); + * const command = new CreateDeploymentCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreateDeploymentCommandInput} for command's `input` shape. + * @see {@link CreateDeploymentCommandOutput} for command's `response` shape. + * @see {@link ApiGatewayV2ClientResolvedConfig | config} for command's `input` shape. + * */ export class CreateDeploymentCommand extends $Command< CreateDeploymentCommandInput, diff --git a/clients/client-apigatewayv2/commands/CreateDomainNameCommand.ts b/clients/client-apigatewayv2/commands/CreateDomainNameCommand.ts index d6f7106ef65d..c304d2b05ab5 100644 --- a/clients/client-apigatewayv2/commands/CreateDomainNameCommand.ts +++ b/clients/client-apigatewayv2/commands/CreateDomainNameCommand.ts @@ -22,6 +22,20 @@ export interface CreateDomainNameCommandOutput extends CreateDomainNameResponse, /** *

Creates a domain name.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ApiGatewayV2Client, CreateDomainNameCommand } from "@aws-sdk/client-apigatewayv2"; // ES Modules import + * // const { ApiGatewayV2Client, CreateDomainNameCommand } = require("@aws-sdk/client-apigatewayv2"); // CommonJS import + * const client = new ApiGatewayV2Client(config); + * const command = new CreateDomainNameCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreateDomainNameCommandInput} for command's `input` shape. + * @see {@link CreateDomainNameCommandOutput} for command's `response` shape. + * @see {@link ApiGatewayV2ClientResolvedConfig | config} for command's `input` shape. + * */ export class CreateDomainNameCommand extends $Command< CreateDomainNameCommandInput, diff --git a/clients/client-apigatewayv2/commands/CreateIntegrationCommand.ts b/clients/client-apigatewayv2/commands/CreateIntegrationCommand.ts index 4cd820984d54..65aa14a9acf9 100644 --- a/clients/client-apigatewayv2/commands/CreateIntegrationCommand.ts +++ b/clients/client-apigatewayv2/commands/CreateIntegrationCommand.ts @@ -22,6 +22,20 @@ export interface CreateIntegrationCommandOutput extends CreateIntegrationResult, /** *

Creates an Integration.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ApiGatewayV2Client, CreateIntegrationCommand } from "@aws-sdk/client-apigatewayv2"; // ES Modules import + * // const { ApiGatewayV2Client, CreateIntegrationCommand } = require("@aws-sdk/client-apigatewayv2"); // CommonJS import + * const client = new ApiGatewayV2Client(config); + * const command = new CreateIntegrationCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreateIntegrationCommandInput} for command's `input` shape. + * @see {@link CreateIntegrationCommandOutput} for command's `response` shape. + * @see {@link ApiGatewayV2ClientResolvedConfig | config} for command's `input` shape. + * */ export class CreateIntegrationCommand extends $Command< CreateIntegrationCommandInput, diff --git a/clients/client-apigatewayv2/commands/CreateIntegrationResponseCommand.ts b/clients/client-apigatewayv2/commands/CreateIntegrationResponseCommand.ts index 53ebce729725..e84024069f31 100644 --- a/clients/client-apigatewayv2/commands/CreateIntegrationResponseCommand.ts +++ b/clients/client-apigatewayv2/commands/CreateIntegrationResponseCommand.ts @@ -22,6 +22,20 @@ export interface CreateIntegrationResponseCommandOutput extends CreateIntegratio /** *

Creates an IntegrationResponses.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ApiGatewayV2Client, CreateIntegrationResponseCommand } from "@aws-sdk/client-apigatewayv2"; // ES Modules import + * // const { ApiGatewayV2Client, CreateIntegrationResponseCommand } = require("@aws-sdk/client-apigatewayv2"); // CommonJS import + * const client = new ApiGatewayV2Client(config); + * const command = new CreateIntegrationResponseCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreateIntegrationResponseCommandInput} for command's `input` shape. + * @see {@link CreateIntegrationResponseCommandOutput} for command's `response` shape. + * @see {@link ApiGatewayV2ClientResolvedConfig | config} for command's `input` shape. + * */ export class CreateIntegrationResponseCommand extends $Command< CreateIntegrationResponseCommandInput, diff --git a/clients/client-apigatewayv2/commands/CreateModelCommand.ts b/clients/client-apigatewayv2/commands/CreateModelCommand.ts index 07cb79a5d122..b78b2e4308c9 100644 --- a/clients/client-apigatewayv2/commands/CreateModelCommand.ts +++ b/clients/client-apigatewayv2/commands/CreateModelCommand.ts @@ -22,6 +22,20 @@ export interface CreateModelCommandOutput extends CreateModelResponse, __Metadat /** *

Creates a Model for an API.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ApiGatewayV2Client, CreateModelCommand } from "@aws-sdk/client-apigatewayv2"; // ES Modules import + * // const { ApiGatewayV2Client, CreateModelCommand } = require("@aws-sdk/client-apigatewayv2"); // CommonJS import + * const client = new ApiGatewayV2Client(config); + * const command = new CreateModelCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreateModelCommandInput} for command's `input` shape. + * @see {@link CreateModelCommandOutput} for command's `response` shape. + * @see {@link ApiGatewayV2ClientResolvedConfig | config} for command's `input` shape. + * */ export class CreateModelCommand extends $Command< CreateModelCommandInput, diff --git a/clients/client-apigatewayv2/commands/CreateRouteCommand.ts b/clients/client-apigatewayv2/commands/CreateRouteCommand.ts index 9565400400c9..1d8bd5064c90 100644 --- a/clients/client-apigatewayv2/commands/CreateRouteCommand.ts +++ b/clients/client-apigatewayv2/commands/CreateRouteCommand.ts @@ -22,6 +22,20 @@ export interface CreateRouteCommandOutput extends CreateRouteResult, __MetadataB /** *

Creates a Route for an API.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ApiGatewayV2Client, CreateRouteCommand } from "@aws-sdk/client-apigatewayv2"; // ES Modules import + * // const { ApiGatewayV2Client, CreateRouteCommand } = require("@aws-sdk/client-apigatewayv2"); // CommonJS import + * const client = new ApiGatewayV2Client(config); + * const command = new CreateRouteCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreateRouteCommandInput} for command's `input` shape. + * @see {@link CreateRouteCommandOutput} for command's `response` shape. + * @see {@link ApiGatewayV2ClientResolvedConfig | config} for command's `input` shape. + * */ export class CreateRouteCommand extends $Command< CreateRouteCommandInput, diff --git a/clients/client-apigatewayv2/commands/CreateRouteResponseCommand.ts b/clients/client-apigatewayv2/commands/CreateRouteResponseCommand.ts index f26c71e9a1ab..96f54373e4cb 100644 --- a/clients/client-apigatewayv2/commands/CreateRouteResponseCommand.ts +++ b/clients/client-apigatewayv2/commands/CreateRouteResponseCommand.ts @@ -22,6 +22,20 @@ export interface CreateRouteResponseCommandOutput extends CreateRouteResponseRes /** *

Creates a RouteResponse for a Route.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ApiGatewayV2Client, CreateRouteResponseCommand } from "@aws-sdk/client-apigatewayv2"; // ES Modules import + * // const { ApiGatewayV2Client, CreateRouteResponseCommand } = require("@aws-sdk/client-apigatewayv2"); // CommonJS import + * const client = new ApiGatewayV2Client(config); + * const command = new CreateRouteResponseCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreateRouteResponseCommandInput} for command's `input` shape. + * @see {@link CreateRouteResponseCommandOutput} for command's `response` shape. + * @see {@link ApiGatewayV2ClientResolvedConfig | config} for command's `input` shape. + * */ export class CreateRouteResponseCommand extends $Command< CreateRouteResponseCommandInput, diff --git a/clients/client-apigatewayv2/commands/CreateStageCommand.ts b/clients/client-apigatewayv2/commands/CreateStageCommand.ts index 6c89c5ffdc65..ed7c1a0785b5 100644 --- a/clients/client-apigatewayv2/commands/CreateStageCommand.ts +++ b/clients/client-apigatewayv2/commands/CreateStageCommand.ts @@ -22,6 +22,20 @@ export interface CreateStageCommandOutput extends CreateStageResponse, __Metadat /** *

Creates a Stage for an API.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ApiGatewayV2Client, CreateStageCommand } from "@aws-sdk/client-apigatewayv2"; // ES Modules import + * // const { ApiGatewayV2Client, CreateStageCommand } = require("@aws-sdk/client-apigatewayv2"); // CommonJS import + * const client = new ApiGatewayV2Client(config); + * const command = new CreateStageCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreateStageCommandInput} for command's `input` shape. + * @see {@link CreateStageCommandOutput} for command's `response` shape. + * @see {@link ApiGatewayV2ClientResolvedConfig | config} for command's `input` shape. + * */ export class CreateStageCommand extends $Command< CreateStageCommandInput, diff --git a/clients/client-apigatewayv2/commands/CreateVpcLinkCommand.ts b/clients/client-apigatewayv2/commands/CreateVpcLinkCommand.ts index 8878301d7b0f..46e32fc900c4 100644 --- a/clients/client-apigatewayv2/commands/CreateVpcLinkCommand.ts +++ b/clients/client-apigatewayv2/commands/CreateVpcLinkCommand.ts @@ -22,6 +22,20 @@ export interface CreateVpcLinkCommandOutput extends CreateVpcLinkResponse, __Met /** *

Creates a VPC link.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ApiGatewayV2Client, CreateVpcLinkCommand } from "@aws-sdk/client-apigatewayv2"; // ES Modules import + * // const { ApiGatewayV2Client, CreateVpcLinkCommand } = require("@aws-sdk/client-apigatewayv2"); // CommonJS import + * const client = new ApiGatewayV2Client(config); + * const command = new CreateVpcLinkCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreateVpcLinkCommandInput} for command's `input` shape. + * @see {@link CreateVpcLinkCommandOutput} for command's `response` shape. + * @see {@link ApiGatewayV2ClientResolvedConfig | config} for command's `input` shape. + * */ export class CreateVpcLinkCommand extends $Command< CreateVpcLinkCommandInput, diff --git a/clients/client-apigatewayv2/commands/DeleteAccessLogSettingsCommand.ts b/clients/client-apigatewayv2/commands/DeleteAccessLogSettingsCommand.ts index 5a5339d0c4d4..10999427fe80 100644 --- a/clients/client-apigatewayv2/commands/DeleteAccessLogSettingsCommand.ts +++ b/clients/client-apigatewayv2/commands/DeleteAccessLogSettingsCommand.ts @@ -22,6 +22,20 @@ export interface DeleteAccessLogSettingsCommandOutput extends __MetadataBearer { /** *

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

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ApiGatewayV2Client, DeleteAccessLogSettingsCommand } from "@aws-sdk/client-apigatewayv2"; // ES Modules import + * // const { ApiGatewayV2Client, DeleteAccessLogSettingsCommand } = require("@aws-sdk/client-apigatewayv2"); // CommonJS import + * const client = new ApiGatewayV2Client(config); + * const command = new DeleteAccessLogSettingsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteAccessLogSettingsCommandInput} for command's `input` shape. + * @see {@link DeleteAccessLogSettingsCommandOutput} for command's `response` shape. + * @see {@link ApiGatewayV2ClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteAccessLogSettingsCommand extends $Command< DeleteAccessLogSettingsCommandInput, diff --git a/clients/client-apigatewayv2/commands/DeleteApiCommand.ts b/clients/client-apigatewayv2/commands/DeleteApiCommand.ts index 2d4a9d33cccf..7663822e65f0 100644 --- a/clients/client-apigatewayv2/commands/DeleteApiCommand.ts +++ b/clients/client-apigatewayv2/commands/DeleteApiCommand.ts @@ -22,6 +22,20 @@ export interface DeleteApiCommandOutput extends __MetadataBearer {} /** *

Deletes an Api resource.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ApiGatewayV2Client, DeleteApiCommand } from "@aws-sdk/client-apigatewayv2"; // ES Modules import + * // const { ApiGatewayV2Client, DeleteApiCommand } = require("@aws-sdk/client-apigatewayv2"); // CommonJS import + * const client = new ApiGatewayV2Client(config); + * const command = new DeleteApiCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteApiCommandInput} for command's `input` shape. + * @see {@link DeleteApiCommandOutput} for command's `response` shape. + * @see {@link ApiGatewayV2ClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteApiCommand extends $Command< DeleteApiCommandInput, diff --git a/clients/client-apigatewayv2/commands/DeleteApiMappingCommand.ts b/clients/client-apigatewayv2/commands/DeleteApiMappingCommand.ts index 25f1d75554c2..420a068b85b7 100644 --- a/clients/client-apigatewayv2/commands/DeleteApiMappingCommand.ts +++ b/clients/client-apigatewayv2/commands/DeleteApiMappingCommand.ts @@ -22,6 +22,20 @@ export interface DeleteApiMappingCommandOutput extends __MetadataBearer {} /** *

Deletes an API mapping.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ApiGatewayV2Client, DeleteApiMappingCommand } from "@aws-sdk/client-apigatewayv2"; // ES Modules import + * // const { ApiGatewayV2Client, DeleteApiMappingCommand } = require("@aws-sdk/client-apigatewayv2"); // CommonJS import + * const client = new ApiGatewayV2Client(config); + * const command = new DeleteApiMappingCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteApiMappingCommandInput} for command's `input` shape. + * @see {@link DeleteApiMappingCommandOutput} for command's `response` shape. + * @see {@link ApiGatewayV2ClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteApiMappingCommand extends $Command< DeleteApiMappingCommandInput, diff --git a/clients/client-apigatewayv2/commands/DeleteAuthorizerCommand.ts b/clients/client-apigatewayv2/commands/DeleteAuthorizerCommand.ts index d4871ad67ee7..1e1a5de605c0 100644 --- a/clients/client-apigatewayv2/commands/DeleteAuthorizerCommand.ts +++ b/clients/client-apigatewayv2/commands/DeleteAuthorizerCommand.ts @@ -22,6 +22,20 @@ export interface DeleteAuthorizerCommandOutput extends __MetadataBearer {} /** *

Deletes an Authorizer.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ApiGatewayV2Client, DeleteAuthorizerCommand } from "@aws-sdk/client-apigatewayv2"; // ES Modules import + * // const { ApiGatewayV2Client, DeleteAuthorizerCommand } = require("@aws-sdk/client-apigatewayv2"); // CommonJS import + * const client = new ApiGatewayV2Client(config); + * const command = new DeleteAuthorizerCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteAuthorizerCommandInput} for command's `input` shape. + * @see {@link DeleteAuthorizerCommandOutput} for command's `response` shape. + * @see {@link ApiGatewayV2ClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteAuthorizerCommand extends $Command< DeleteAuthorizerCommandInput, diff --git a/clients/client-apigatewayv2/commands/DeleteCorsConfigurationCommand.ts b/clients/client-apigatewayv2/commands/DeleteCorsConfigurationCommand.ts index cb20f0797903..744d502bc1a8 100644 --- a/clients/client-apigatewayv2/commands/DeleteCorsConfigurationCommand.ts +++ b/clients/client-apigatewayv2/commands/DeleteCorsConfigurationCommand.ts @@ -22,6 +22,20 @@ export interface DeleteCorsConfigurationCommandOutput extends __MetadataBearer { /** *

Deletes a CORS configuration.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ApiGatewayV2Client, DeleteCorsConfigurationCommand } from "@aws-sdk/client-apigatewayv2"; // ES Modules import + * // const { ApiGatewayV2Client, DeleteCorsConfigurationCommand } = require("@aws-sdk/client-apigatewayv2"); // CommonJS import + * const client = new ApiGatewayV2Client(config); + * const command = new DeleteCorsConfigurationCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteCorsConfigurationCommandInput} for command's `input` shape. + * @see {@link DeleteCorsConfigurationCommandOutput} for command's `response` shape. + * @see {@link ApiGatewayV2ClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteCorsConfigurationCommand extends $Command< DeleteCorsConfigurationCommandInput, diff --git a/clients/client-apigatewayv2/commands/DeleteDeploymentCommand.ts b/clients/client-apigatewayv2/commands/DeleteDeploymentCommand.ts index d32f2ed97b93..da5e09a301e6 100644 --- a/clients/client-apigatewayv2/commands/DeleteDeploymentCommand.ts +++ b/clients/client-apigatewayv2/commands/DeleteDeploymentCommand.ts @@ -22,6 +22,20 @@ export interface DeleteDeploymentCommandOutput extends __MetadataBearer {} /** *

Deletes a Deployment.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ApiGatewayV2Client, DeleteDeploymentCommand } from "@aws-sdk/client-apigatewayv2"; // ES Modules import + * // const { ApiGatewayV2Client, DeleteDeploymentCommand } = require("@aws-sdk/client-apigatewayv2"); // CommonJS import + * const client = new ApiGatewayV2Client(config); + * const command = new DeleteDeploymentCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteDeploymentCommandInput} for command's `input` shape. + * @see {@link DeleteDeploymentCommandOutput} for command's `response` shape. + * @see {@link ApiGatewayV2ClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteDeploymentCommand extends $Command< DeleteDeploymentCommandInput, diff --git a/clients/client-apigatewayv2/commands/DeleteDomainNameCommand.ts b/clients/client-apigatewayv2/commands/DeleteDomainNameCommand.ts index a49782f24471..c4906aabe64d 100644 --- a/clients/client-apigatewayv2/commands/DeleteDomainNameCommand.ts +++ b/clients/client-apigatewayv2/commands/DeleteDomainNameCommand.ts @@ -22,6 +22,20 @@ export interface DeleteDomainNameCommandOutput extends __MetadataBearer {} /** *

Deletes a domain name.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ApiGatewayV2Client, DeleteDomainNameCommand } from "@aws-sdk/client-apigatewayv2"; // ES Modules import + * // const { ApiGatewayV2Client, DeleteDomainNameCommand } = require("@aws-sdk/client-apigatewayv2"); // CommonJS import + * const client = new ApiGatewayV2Client(config); + * const command = new DeleteDomainNameCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteDomainNameCommandInput} for command's `input` shape. + * @see {@link DeleteDomainNameCommandOutput} for command's `response` shape. + * @see {@link ApiGatewayV2ClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteDomainNameCommand extends $Command< DeleteDomainNameCommandInput, diff --git a/clients/client-apigatewayv2/commands/DeleteIntegrationCommand.ts b/clients/client-apigatewayv2/commands/DeleteIntegrationCommand.ts index 310e6ec35a75..1cf5014238fd 100644 --- a/clients/client-apigatewayv2/commands/DeleteIntegrationCommand.ts +++ b/clients/client-apigatewayv2/commands/DeleteIntegrationCommand.ts @@ -22,6 +22,20 @@ export interface DeleteIntegrationCommandOutput extends __MetadataBearer {} /** *

Deletes an Integration.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ApiGatewayV2Client, DeleteIntegrationCommand } from "@aws-sdk/client-apigatewayv2"; // ES Modules import + * // const { ApiGatewayV2Client, DeleteIntegrationCommand } = require("@aws-sdk/client-apigatewayv2"); // CommonJS import + * const client = new ApiGatewayV2Client(config); + * const command = new DeleteIntegrationCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteIntegrationCommandInput} for command's `input` shape. + * @see {@link DeleteIntegrationCommandOutput} for command's `response` shape. + * @see {@link ApiGatewayV2ClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteIntegrationCommand extends $Command< DeleteIntegrationCommandInput, diff --git a/clients/client-apigatewayv2/commands/DeleteIntegrationResponseCommand.ts b/clients/client-apigatewayv2/commands/DeleteIntegrationResponseCommand.ts index b1b73d9cde93..48af1b007d83 100644 --- a/clients/client-apigatewayv2/commands/DeleteIntegrationResponseCommand.ts +++ b/clients/client-apigatewayv2/commands/DeleteIntegrationResponseCommand.ts @@ -22,6 +22,20 @@ export interface DeleteIntegrationResponseCommandOutput extends __MetadataBearer /** *

Deletes an IntegrationResponses.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ApiGatewayV2Client, DeleteIntegrationResponseCommand } from "@aws-sdk/client-apigatewayv2"; // ES Modules import + * // const { ApiGatewayV2Client, DeleteIntegrationResponseCommand } = require("@aws-sdk/client-apigatewayv2"); // CommonJS import + * const client = new ApiGatewayV2Client(config); + * const command = new DeleteIntegrationResponseCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteIntegrationResponseCommandInput} for command's `input` shape. + * @see {@link DeleteIntegrationResponseCommandOutput} for command's `response` shape. + * @see {@link ApiGatewayV2ClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteIntegrationResponseCommand extends $Command< DeleteIntegrationResponseCommandInput, diff --git a/clients/client-apigatewayv2/commands/DeleteModelCommand.ts b/clients/client-apigatewayv2/commands/DeleteModelCommand.ts index fcbcfd190a74..ea6a2b965c5a 100644 --- a/clients/client-apigatewayv2/commands/DeleteModelCommand.ts +++ b/clients/client-apigatewayv2/commands/DeleteModelCommand.ts @@ -22,6 +22,20 @@ export interface DeleteModelCommandOutput extends __MetadataBearer {} /** *

Deletes a Model.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ApiGatewayV2Client, DeleteModelCommand } from "@aws-sdk/client-apigatewayv2"; // ES Modules import + * // const { ApiGatewayV2Client, DeleteModelCommand } = require("@aws-sdk/client-apigatewayv2"); // CommonJS import + * const client = new ApiGatewayV2Client(config); + * const command = new DeleteModelCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteModelCommandInput} for command's `input` shape. + * @see {@link DeleteModelCommandOutput} for command's `response` shape. + * @see {@link ApiGatewayV2ClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteModelCommand extends $Command< DeleteModelCommandInput, diff --git a/clients/client-apigatewayv2/commands/DeleteRouteCommand.ts b/clients/client-apigatewayv2/commands/DeleteRouteCommand.ts index 33c59638c514..8ffa47134155 100644 --- a/clients/client-apigatewayv2/commands/DeleteRouteCommand.ts +++ b/clients/client-apigatewayv2/commands/DeleteRouteCommand.ts @@ -22,6 +22,20 @@ export interface DeleteRouteCommandOutput extends __MetadataBearer {} /** *

Deletes a Route.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ApiGatewayV2Client, DeleteRouteCommand } from "@aws-sdk/client-apigatewayv2"; // ES Modules import + * // const { ApiGatewayV2Client, DeleteRouteCommand } = require("@aws-sdk/client-apigatewayv2"); // CommonJS import + * const client = new ApiGatewayV2Client(config); + * const command = new DeleteRouteCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteRouteCommandInput} for command's `input` shape. + * @see {@link DeleteRouteCommandOutput} for command's `response` shape. + * @see {@link ApiGatewayV2ClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteRouteCommand extends $Command< DeleteRouteCommandInput, diff --git a/clients/client-apigatewayv2/commands/DeleteRouteRequestParameterCommand.ts b/clients/client-apigatewayv2/commands/DeleteRouteRequestParameterCommand.ts index 004bedf6251f..8a97c41b18a0 100644 --- a/clients/client-apigatewayv2/commands/DeleteRouteRequestParameterCommand.ts +++ b/clients/client-apigatewayv2/commands/DeleteRouteRequestParameterCommand.ts @@ -22,6 +22,20 @@ export interface DeleteRouteRequestParameterCommandOutput extends __MetadataBear /** *

Deletes a route request parameter.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ApiGatewayV2Client, DeleteRouteRequestParameterCommand } from "@aws-sdk/client-apigatewayv2"; // ES Modules import + * // const { ApiGatewayV2Client, DeleteRouteRequestParameterCommand } = require("@aws-sdk/client-apigatewayv2"); // CommonJS import + * const client = new ApiGatewayV2Client(config); + * const command = new DeleteRouteRequestParameterCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteRouteRequestParameterCommandInput} for command's `input` shape. + * @see {@link DeleteRouteRequestParameterCommandOutput} for command's `response` shape. + * @see {@link ApiGatewayV2ClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteRouteRequestParameterCommand extends $Command< DeleteRouteRequestParameterCommandInput, diff --git a/clients/client-apigatewayv2/commands/DeleteRouteResponseCommand.ts b/clients/client-apigatewayv2/commands/DeleteRouteResponseCommand.ts index f73dca4813bb..39107bcbd22c 100644 --- a/clients/client-apigatewayv2/commands/DeleteRouteResponseCommand.ts +++ b/clients/client-apigatewayv2/commands/DeleteRouteResponseCommand.ts @@ -22,6 +22,20 @@ export interface DeleteRouteResponseCommandOutput extends __MetadataBearer {} /** *

Deletes a RouteResponse.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ApiGatewayV2Client, DeleteRouteResponseCommand } from "@aws-sdk/client-apigatewayv2"; // ES Modules import + * // const { ApiGatewayV2Client, DeleteRouteResponseCommand } = require("@aws-sdk/client-apigatewayv2"); // CommonJS import + * const client = new ApiGatewayV2Client(config); + * const command = new DeleteRouteResponseCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteRouteResponseCommandInput} for command's `input` shape. + * @see {@link DeleteRouteResponseCommandOutput} for command's `response` shape. + * @see {@link ApiGatewayV2ClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteRouteResponseCommand extends $Command< DeleteRouteResponseCommandInput, diff --git a/clients/client-apigatewayv2/commands/DeleteRouteSettingsCommand.ts b/clients/client-apigatewayv2/commands/DeleteRouteSettingsCommand.ts index a91aa8fe0df8..8df107190c58 100644 --- a/clients/client-apigatewayv2/commands/DeleteRouteSettingsCommand.ts +++ b/clients/client-apigatewayv2/commands/DeleteRouteSettingsCommand.ts @@ -22,6 +22,20 @@ export interface DeleteRouteSettingsCommandOutput extends __MetadataBearer {} /** *

Deletes the RouteSettings for a stage.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ApiGatewayV2Client, DeleteRouteSettingsCommand } from "@aws-sdk/client-apigatewayv2"; // ES Modules import + * // const { ApiGatewayV2Client, DeleteRouteSettingsCommand } = require("@aws-sdk/client-apigatewayv2"); // CommonJS import + * const client = new ApiGatewayV2Client(config); + * const command = new DeleteRouteSettingsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteRouteSettingsCommandInput} for command's `input` shape. + * @see {@link DeleteRouteSettingsCommandOutput} for command's `response` shape. + * @see {@link ApiGatewayV2ClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteRouteSettingsCommand extends $Command< DeleteRouteSettingsCommandInput, diff --git a/clients/client-apigatewayv2/commands/DeleteStageCommand.ts b/clients/client-apigatewayv2/commands/DeleteStageCommand.ts index 04768d7f79a0..a97c97b32652 100644 --- a/clients/client-apigatewayv2/commands/DeleteStageCommand.ts +++ b/clients/client-apigatewayv2/commands/DeleteStageCommand.ts @@ -22,6 +22,20 @@ export interface DeleteStageCommandOutput extends __MetadataBearer {} /** *

Deletes a Stage.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ApiGatewayV2Client, DeleteStageCommand } from "@aws-sdk/client-apigatewayv2"; // ES Modules import + * // const { ApiGatewayV2Client, DeleteStageCommand } = require("@aws-sdk/client-apigatewayv2"); // CommonJS import + * const client = new ApiGatewayV2Client(config); + * const command = new DeleteStageCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteStageCommandInput} for command's `input` shape. + * @see {@link DeleteStageCommandOutput} for command's `response` shape. + * @see {@link ApiGatewayV2ClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteStageCommand extends $Command< DeleteStageCommandInput, diff --git a/clients/client-apigatewayv2/commands/DeleteVpcLinkCommand.ts b/clients/client-apigatewayv2/commands/DeleteVpcLinkCommand.ts index 93c41b169a99..2e59601d8b31 100644 --- a/clients/client-apigatewayv2/commands/DeleteVpcLinkCommand.ts +++ b/clients/client-apigatewayv2/commands/DeleteVpcLinkCommand.ts @@ -22,6 +22,20 @@ export interface DeleteVpcLinkCommandOutput extends DeleteVpcLinkResponse, __Met /** *

Deletes a VPC link.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ApiGatewayV2Client, DeleteVpcLinkCommand } from "@aws-sdk/client-apigatewayv2"; // ES Modules import + * // const { ApiGatewayV2Client, DeleteVpcLinkCommand } = require("@aws-sdk/client-apigatewayv2"); // CommonJS import + * const client = new ApiGatewayV2Client(config); + * const command = new DeleteVpcLinkCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteVpcLinkCommandInput} for command's `input` shape. + * @see {@link DeleteVpcLinkCommandOutput} for command's `response` shape. + * @see {@link ApiGatewayV2ClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteVpcLinkCommand extends $Command< DeleteVpcLinkCommandInput, diff --git a/clients/client-apigatewayv2/commands/GetApiCommand.ts b/clients/client-apigatewayv2/commands/GetApiCommand.ts index e3e5e771357a..8d1a20e2468f 100644 --- a/clients/client-apigatewayv2/commands/GetApiCommand.ts +++ b/clients/client-apigatewayv2/commands/GetApiCommand.ts @@ -19,6 +19,20 @@ export interface GetApiCommandOutput extends GetApiResponse, __MetadataBearer {} /** *

Gets an Api resource.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ApiGatewayV2Client, GetApiCommand } from "@aws-sdk/client-apigatewayv2"; // ES Modules import + * // const { ApiGatewayV2Client, GetApiCommand } = require("@aws-sdk/client-apigatewayv2"); // CommonJS import + * const client = new ApiGatewayV2Client(config); + * const command = new GetApiCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetApiCommandInput} for command's `input` shape. + * @see {@link GetApiCommandOutput} for command's `response` shape. + * @see {@link ApiGatewayV2ClientResolvedConfig | config} for command's `input` shape. + * */ export class GetApiCommand extends $Command { // Start section: command_properties diff --git a/clients/client-apigatewayv2/commands/GetApiMappingCommand.ts b/clients/client-apigatewayv2/commands/GetApiMappingCommand.ts index 942a4be74163..035b1493e187 100644 --- a/clients/client-apigatewayv2/commands/GetApiMappingCommand.ts +++ b/clients/client-apigatewayv2/commands/GetApiMappingCommand.ts @@ -22,6 +22,20 @@ export interface GetApiMappingCommandOutput extends GetApiMappingResponse, __Met /** *

Gets an API mapping.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ApiGatewayV2Client, GetApiMappingCommand } from "@aws-sdk/client-apigatewayv2"; // ES Modules import + * // const { ApiGatewayV2Client, GetApiMappingCommand } = require("@aws-sdk/client-apigatewayv2"); // CommonJS import + * const client = new ApiGatewayV2Client(config); + * const command = new GetApiMappingCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetApiMappingCommandInput} for command's `input` shape. + * @see {@link GetApiMappingCommandOutput} for command's `response` shape. + * @see {@link ApiGatewayV2ClientResolvedConfig | config} for command's `input` shape. + * */ export class GetApiMappingCommand extends $Command< GetApiMappingCommandInput, diff --git a/clients/client-apigatewayv2/commands/GetApiMappingsCommand.ts b/clients/client-apigatewayv2/commands/GetApiMappingsCommand.ts index d172e6ed8315..cbc5d09c3ed7 100644 --- a/clients/client-apigatewayv2/commands/GetApiMappingsCommand.ts +++ b/clients/client-apigatewayv2/commands/GetApiMappingsCommand.ts @@ -22,6 +22,20 @@ export interface GetApiMappingsCommandOutput extends GetApiMappingsResponse, __M /** *

Gets API mappings.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ApiGatewayV2Client, GetApiMappingsCommand } from "@aws-sdk/client-apigatewayv2"; // ES Modules import + * // const { ApiGatewayV2Client, GetApiMappingsCommand } = require("@aws-sdk/client-apigatewayv2"); // CommonJS import + * const client = new ApiGatewayV2Client(config); + * const command = new GetApiMappingsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetApiMappingsCommandInput} for command's `input` shape. + * @see {@link GetApiMappingsCommandOutput} for command's `response` shape. + * @see {@link ApiGatewayV2ClientResolvedConfig | config} for command's `input` shape. + * */ export class GetApiMappingsCommand extends $Command< GetApiMappingsCommandInput, diff --git a/clients/client-apigatewayv2/commands/GetApisCommand.ts b/clients/client-apigatewayv2/commands/GetApisCommand.ts index 90fd2ece998e..7efd40059fe5 100644 --- a/clients/client-apigatewayv2/commands/GetApisCommand.ts +++ b/clients/client-apigatewayv2/commands/GetApisCommand.ts @@ -22,6 +22,20 @@ export interface GetApisCommandOutput extends GetApisResponse, __MetadataBearer /** *

Gets a collection of Api resources.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ApiGatewayV2Client, GetApisCommand } from "@aws-sdk/client-apigatewayv2"; // ES Modules import + * // const { ApiGatewayV2Client, GetApisCommand } = require("@aws-sdk/client-apigatewayv2"); // CommonJS import + * const client = new ApiGatewayV2Client(config); + * const command = new GetApisCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetApisCommandInput} for command's `input` shape. + * @see {@link GetApisCommandOutput} for command's `response` shape. + * @see {@link ApiGatewayV2ClientResolvedConfig | config} for command's `input` shape. + * */ export class GetApisCommand extends $Command< GetApisCommandInput, diff --git a/clients/client-apigatewayv2/commands/GetAuthorizerCommand.ts b/clients/client-apigatewayv2/commands/GetAuthorizerCommand.ts index 8e0e1f5422c2..55d06c27eaac 100644 --- a/clients/client-apigatewayv2/commands/GetAuthorizerCommand.ts +++ b/clients/client-apigatewayv2/commands/GetAuthorizerCommand.ts @@ -22,6 +22,20 @@ export interface GetAuthorizerCommandOutput extends GetAuthorizerResponse, __Met /** *

Gets an Authorizer.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ApiGatewayV2Client, GetAuthorizerCommand } from "@aws-sdk/client-apigatewayv2"; // ES Modules import + * // const { ApiGatewayV2Client, GetAuthorizerCommand } = require("@aws-sdk/client-apigatewayv2"); // CommonJS import + * const client = new ApiGatewayV2Client(config); + * const command = new GetAuthorizerCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetAuthorizerCommandInput} for command's `input` shape. + * @see {@link GetAuthorizerCommandOutput} for command's `response` shape. + * @see {@link ApiGatewayV2ClientResolvedConfig | config} for command's `input` shape. + * */ export class GetAuthorizerCommand extends $Command< GetAuthorizerCommandInput, diff --git a/clients/client-apigatewayv2/commands/GetAuthorizersCommand.ts b/clients/client-apigatewayv2/commands/GetAuthorizersCommand.ts index e0b90fa666d9..ef853d62f06d 100644 --- a/clients/client-apigatewayv2/commands/GetAuthorizersCommand.ts +++ b/clients/client-apigatewayv2/commands/GetAuthorizersCommand.ts @@ -22,6 +22,20 @@ export interface GetAuthorizersCommandOutput extends GetAuthorizersResponse, __M /** *

Gets the Authorizers for an API.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ApiGatewayV2Client, GetAuthorizersCommand } from "@aws-sdk/client-apigatewayv2"; // ES Modules import + * // const { ApiGatewayV2Client, GetAuthorizersCommand } = require("@aws-sdk/client-apigatewayv2"); // CommonJS import + * const client = new ApiGatewayV2Client(config); + * const command = new GetAuthorizersCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetAuthorizersCommandInput} for command's `input` shape. + * @see {@link GetAuthorizersCommandOutput} for command's `response` shape. + * @see {@link ApiGatewayV2ClientResolvedConfig | config} for command's `input` shape. + * */ export class GetAuthorizersCommand extends $Command< GetAuthorizersCommandInput, diff --git a/clients/client-apigatewayv2/commands/GetDeploymentCommand.ts b/clients/client-apigatewayv2/commands/GetDeploymentCommand.ts index 1ea9655ee44e..368d6aed4462 100644 --- a/clients/client-apigatewayv2/commands/GetDeploymentCommand.ts +++ b/clients/client-apigatewayv2/commands/GetDeploymentCommand.ts @@ -22,6 +22,20 @@ export interface GetDeploymentCommandOutput extends GetDeploymentResponse, __Met /** *

Gets a Deployment.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ApiGatewayV2Client, GetDeploymentCommand } from "@aws-sdk/client-apigatewayv2"; // ES Modules import + * // const { ApiGatewayV2Client, GetDeploymentCommand } = require("@aws-sdk/client-apigatewayv2"); // CommonJS import + * const client = new ApiGatewayV2Client(config); + * const command = new GetDeploymentCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetDeploymentCommandInput} for command's `input` shape. + * @see {@link GetDeploymentCommandOutput} for command's `response` shape. + * @see {@link ApiGatewayV2ClientResolvedConfig | config} for command's `input` shape. + * */ export class GetDeploymentCommand extends $Command< GetDeploymentCommandInput, diff --git a/clients/client-apigatewayv2/commands/GetDeploymentsCommand.ts b/clients/client-apigatewayv2/commands/GetDeploymentsCommand.ts index 6a63001a7a87..d969129b952b 100644 --- a/clients/client-apigatewayv2/commands/GetDeploymentsCommand.ts +++ b/clients/client-apigatewayv2/commands/GetDeploymentsCommand.ts @@ -22,6 +22,20 @@ export interface GetDeploymentsCommandOutput extends GetDeploymentsResponse, __M /** *

Gets the Deployments for an API.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ApiGatewayV2Client, GetDeploymentsCommand } from "@aws-sdk/client-apigatewayv2"; // ES Modules import + * // const { ApiGatewayV2Client, GetDeploymentsCommand } = require("@aws-sdk/client-apigatewayv2"); // CommonJS import + * const client = new ApiGatewayV2Client(config); + * const command = new GetDeploymentsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetDeploymentsCommandInput} for command's `input` shape. + * @see {@link GetDeploymentsCommandOutput} for command's `response` shape. + * @see {@link ApiGatewayV2ClientResolvedConfig | config} for command's `input` shape. + * */ export class GetDeploymentsCommand extends $Command< GetDeploymentsCommandInput, diff --git a/clients/client-apigatewayv2/commands/GetDomainNameCommand.ts b/clients/client-apigatewayv2/commands/GetDomainNameCommand.ts index a4f068b10048..58ae8a7e1ca1 100644 --- a/clients/client-apigatewayv2/commands/GetDomainNameCommand.ts +++ b/clients/client-apigatewayv2/commands/GetDomainNameCommand.ts @@ -22,6 +22,20 @@ export interface GetDomainNameCommandOutput extends GetDomainNameResponse, __Met /** *

Gets a domain name.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ApiGatewayV2Client, GetDomainNameCommand } from "@aws-sdk/client-apigatewayv2"; // ES Modules import + * // const { ApiGatewayV2Client, GetDomainNameCommand } = require("@aws-sdk/client-apigatewayv2"); // CommonJS import + * const client = new ApiGatewayV2Client(config); + * const command = new GetDomainNameCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetDomainNameCommandInput} for command's `input` shape. + * @see {@link GetDomainNameCommandOutput} for command's `response` shape. + * @see {@link ApiGatewayV2ClientResolvedConfig | config} for command's `input` shape. + * */ export class GetDomainNameCommand extends $Command< GetDomainNameCommandInput, diff --git a/clients/client-apigatewayv2/commands/GetDomainNamesCommand.ts b/clients/client-apigatewayv2/commands/GetDomainNamesCommand.ts index 992ec6e7d3e1..3f9779f58487 100644 --- a/clients/client-apigatewayv2/commands/GetDomainNamesCommand.ts +++ b/clients/client-apigatewayv2/commands/GetDomainNamesCommand.ts @@ -22,6 +22,20 @@ export interface GetDomainNamesCommandOutput extends GetDomainNamesResponse, __M /** *

Gets the domain names for an AWS account.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ApiGatewayV2Client, GetDomainNamesCommand } from "@aws-sdk/client-apigatewayv2"; // ES Modules import + * // const { ApiGatewayV2Client, GetDomainNamesCommand } = require("@aws-sdk/client-apigatewayv2"); // CommonJS import + * const client = new ApiGatewayV2Client(config); + * const command = new GetDomainNamesCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetDomainNamesCommandInput} for command's `input` shape. + * @see {@link GetDomainNamesCommandOutput} for command's `response` shape. + * @see {@link ApiGatewayV2ClientResolvedConfig | config} for command's `input` shape. + * */ export class GetDomainNamesCommand extends $Command< GetDomainNamesCommandInput, diff --git a/clients/client-apigatewayv2/commands/GetIntegrationCommand.ts b/clients/client-apigatewayv2/commands/GetIntegrationCommand.ts index 83bfe6ee95bc..5f6c562499cc 100644 --- a/clients/client-apigatewayv2/commands/GetIntegrationCommand.ts +++ b/clients/client-apigatewayv2/commands/GetIntegrationCommand.ts @@ -22,6 +22,20 @@ export interface GetIntegrationCommandOutput extends GetIntegrationResult, __Met /** *

Gets an Integration.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ApiGatewayV2Client, GetIntegrationCommand } from "@aws-sdk/client-apigatewayv2"; // ES Modules import + * // const { ApiGatewayV2Client, GetIntegrationCommand } = require("@aws-sdk/client-apigatewayv2"); // CommonJS import + * const client = new ApiGatewayV2Client(config); + * const command = new GetIntegrationCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetIntegrationCommandInput} for command's `input` shape. + * @see {@link GetIntegrationCommandOutput} for command's `response` shape. + * @see {@link ApiGatewayV2ClientResolvedConfig | config} for command's `input` shape. + * */ export class GetIntegrationCommand extends $Command< GetIntegrationCommandInput, diff --git a/clients/client-apigatewayv2/commands/GetIntegrationResponseCommand.ts b/clients/client-apigatewayv2/commands/GetIntegrationResponseCommand.ts index d514ffc235a7..91373a6d9140 100644 --- a/clients/client-apigatewayv2/commands/GetIntegrationResponseCommand.ts +++ b/clients/client-apigatewayv2/commands/GetIntegrationResponseCommand.ts @@ -22,6 +22,20 @@ export interface GetIntegrationResponseCommandOutput extends GetIntegrationRespo /** *

Gets an IntegrationResponses.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ApiGatewayV2Client, GetIntegrationResponseCommand } from "@aws-sdk/client-apigatewayv2"; // ES Modules import + * // const { ApiGatewayV2Client, GetIntegrationResponseCommand } = require("@aws-sdk/client-apigatewayv2"); // CommonJS import + * const client = new ApiGatewayV2Client(config); + * const command = new GetIntegrationResponseCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetIntegrationResponseCommandInput} for command's `input` shape. + * @see {@link GetIntegrationResponseCommandOutput} for command's `response` shape. + * @see {@link ApiGatewayV2ClientResolvedConfig | config} for command's `input` shape. + * */ export class GetIntegrationResponseCommand extends $Command< GetIntegrationResponseCommandInput, diff --git a/clients/client-apigatewayv2/commands/GetIntegrationResponsesCommand.ts b/clients/client-apigatewayv2/commands/GetIntegrationResponsesCommand.ts index 39016c030422..9b0687a1b8a9 100644 --- a/clients/client-apigatewayv2/commands/GetIntegrationResponsesCommand.ts +++ b/clients/client-apigatewayv2/commands/GetIntegrationResponsesCommand.ts @@ -22,6 +22,20 @@ export interface GetIntegrationResponsesCommandOutput extends GetIntegrationResp /** *

Gets the IntegrationResponses for an Integration.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ApiGatewayV2Client, GetIntegrationResponsesCommand } from "@aws-sdk/client-apigatewayv2"; // ES Modules import + * // const { ApiGatewayV2Client, GetIntegrationResponsesCommand } = require("@aws-sdk/client-apigatewayv2"); // CommonJS import + * const client = new ApiGatewayV2Client(config); + * const command = new GetIntegrationResponsesCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetIntegrationResponsesCommandInput} for command's `input` shape. + * @see {@link GetIntegrationResponsesCommandOutput} for command's `response` shape. + * @see {@link ApiGatewayV2ClientResolvedConfig | config} for command's `input` shape. + * */ export class GetIntegrationResponsesCommand extends $Command< GetIntegrationResponsesCommandInput, diff --git a/clients/client-apigatewayv2/commands/GetIntegrationsCommand.ts b/clients/client-apigatewayv2/commands/GetIntegrationsCommand.ts index b31b59ec6886..5cc8a9ab88bc 100644 --- a/clients/client-apigatewayv2/commands/GetIntegrationsCommand.ts +++ b/clients/client-apigatewayv2/commands/GetIntegrationsCommand.ts @@ -22,6 +22,20 @@ export interface GetIntegrationsCommandOutput extends GetIntegrationsResponse, _ /** *

Gets the Integrations for an API.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ApiGatewayV2Client, GetIntegrationsCommand } from "@aws-sdk/client-apigatewayv2"; // ES Modules import + * // const { ApiGatewayV2Client, GetIntegrationsCommand } = require("@aws-sdk/client-apigatewayv2"); // CommonJS import + * const client = new ApiGatewayV2Client(config); + * const command = new GetIntegrationsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetIntegrationsCommandInput} for command's `input` shape. + * @see {@link GetIntegrationsCommandOutput} for command's `response` shape. + * @see {@link ApiGatewayV2ClientResolvedConfig | config} for command's `input` shape. + * */ export class GetIntegrationsCommand extends $Command< GetIntegrationsCommandInput, diff --git a/clients/client-apigatewayv2/commands/GetModelCommand.ts b/clients/client-apigatewayv2/commands/GetModelCommand.ts index dc0e016f6e0d..d491abb5a0f7 100644 --- a/clients/client-apigatewayv2/commands/GetModelCommand.ts +++ b/clients/client-apigatewayv2/commands/GetModelCommand.ts @@ -22,6 +22,20 @@ export interface GetModelCommandOutput extends GetModelResponse, __MetadataBeare /** *

Gets a Model.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ApiGatewayV2Client, GetModelCommand } from "@aws-sdk/client-apigatewayv2"; // ES Modules import + * // const { ApiGatewayV2Client, GetModelCommand } = require("@aws-sdk/client-apigatewayv2"); // CommonJS import + * const client = new ApiGatewayV2Client(config); + * const command = new GetModelCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetModelCommandInput} for command's `input` shape. + * @see {@link GetModelCommandOutput} for command's `response` shape. + * @see {@link ApiGatewayV2ClientResolvedConfig | config} for command's `input` shape. + * */ export class GetModelCommand extends $Command< GetModelCommandInput, diff --git a/clients/client-apigatewayv2/commands/GetModelTemplateCommand.ts b/clients/client-apigatewayv2/commands/GetModelTemplateCommand.ts index 7c2d000252df..10f57cb21091 100644 --- a/clients/client-apigatewayv2/commands/GetModelTemplateCommand.ts +++ b/clients/client-apigatewayv2/commands/GetModelTemplateCommand.ts @@ -22,6 +22,20 @@ export interface GetModelTemplateCommandOutput extends GetModelTemplateResponse, /** *

Gets a model template.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ApiGatewayV2Client, GetModelTemplateCommand } from "@aws-sdk/client-apigatewayv2"; // ES Modules import + * // const { ApiGatewayV2Client, GetModelTemplateCommand } = require("@aws-sdk/client-apigatewayv2"); // CommonJS import + * const client = new ApiGatewayV2Client(config); + * const command = new GetModelTemplateCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetModelTemplateCommandInput} for command's `input` shape. + * @see {@link GetModelTemplateCommandOutput} for command's `response` shape. + * @see {@link ApiGatewayV2ClientResolvedConfig | config} for command's `input` shape. + * */ export class GetModelTemplateCommand extends $Command< GetModelTemplateCommandInput, diff --git a/clients/client-apigatewayv2/commands/GetModelsCommand.ts b/clients/client-apigatewayv2/commands/GetModelsCommand.ts index 5d5b3d65c08b..bc0190f6b9ae 100644 --- a/clients/client-apigatewayv2/commands/GetModelsCommand.ts +++ b/clients/client-apigatewayv2/commands/GetModelsCommand.ts @@ -22,6 +22,20 @@ export interface GetModelsCommandOutput extends GetModelsResponse, __MetadataBea /** *

Gets the Models for an API.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ApiGatewayV2Client, GetModelsCommand } from "@aws-sdk/client-apigatewayv2"; // ES Modules import + * // const { ApiGatewayV2Client, GetModelsCommand } = require("@aws-sdk/client-apigatewayv2"); // CommonJS import + * const client = new ApiGatewayV2Client(config); + * const command = new GetModelsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetModelsCommandInput} for command's `input` shape. + * @see {@link GetModelsCommandOutput} for command's `response` shape. + * @see {@link ApiGatewayV2ClientResolvedConfig | config} for command's `input` shape. + * */ export class GetModelsCommand extends $Command< GetModelsCommandInput, diff --git a/clients/client-apigatewayv2/commands/GetRouteCommand.ts b/clients/client-apigatewayv2/commands/GetRouteCommand.ts index 1d819e15386e..a71b92d4fb53 100644 --- a/clients/client-apigatewayv2/commands/GetRouteCommand.ts +++ b/clients/client-apigatewayv2/commands/GetRouteCommand.ts @@ -22,6 +22,20 @@ export interface GetRouteCommandOutput extends GetRouteResult, __MetadataBearer /** *

Gets a Route.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ApiGatewayV2Client, GetRouteCommand } from "@aws-sdk/client-apigatewayv2"; // ES Modules import + * // const { ApiGatewayV2Client, GetRouteCommand } = require("@aws-sdk/client-apigatewayv2"); // CommonJS import + * const client = new ApiGatewayV2Client(config); + * const command = new GetRouteCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetRouteCommandInput} for command's `input` shape. + * @see {@link GetRouteCommandOutput} for command's `response` shape. + * @see {@link ApiGatewayV2ClientResolvedConfig | config} for command's `input` shape. + * */ export class GetRouteCommand extends $Command< GetRouteCommandInput, diff --git a/clients/client-apigatewayv2/commands/GetRouteResponseCommand.ts b/clients/client-apigatewayv2/commands/GetRouteResponseCommand.ts index fc5eb8ebffa3..5ec6b2aceb97 100644 --- a/clients/client-apigatewayv2/commands/GetRouteResponseCommand.ts +++ b/clients/client-apigatewayv2/commands/GetRouteResponseCommand.ts @@ -22,6 +22,20 @@ export interface GetRouteResponseCommandOutput extends GetRouteResponseResponse, /** *

Gets a RouteResponse.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ApiGatewayV2Client, GetRouteResponseCommand } from "@aws-sdk/client-apigatewayv2"; // ES Modules import + * // const { ApiGatewayV2Client, GetRouteResponseCommand } = require("@aws-sdk/client-apigatewayv2"); // CommonJS import + * const client = new ApiGatewayV2Client(config); + * const command = new GetRouteResponseCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetRouteResponseCommandInput} for command's `input` shape. + * @see {@link GetRouteResponseCommandOutput} for command's `response` shape. + * @see {@link ApiGatewayV2ClientResolvedConfig | config} for command's `input` shape. + * */ export class GetRouteResponseCommand extends $Command< GetRouteResponseCommandInput, diff --git a/clients/client-apigatewayv2/commands/GetRouteResponsesCommand.ts b/clients/client-apigatewayv2/commands/GetRouteResponsesCommand.ts index cdbe7bc55680..74d5a98030b0 100644 --- a/clients/client-apigatewayv2/commands/GetRouteResponsesCommand.ts +++ b/clients/client-apigatewayv2/commands/GetRouteResponsesCommand.ts @@ -22,6 +22,20 @@ export interface GetRouteResponsesCommandOutput extends GetRouteResponsesRespons /** *

Gets the RouteResponses for a Route.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ApiGatewayV2Client, GetRouteResponsesCommand } from "@aws-sdk/client-apigatewayv2"; // ES Modules import + * // const { ApiGatewayV2Client, GetRouteResponsesCommand } = require("@aws-sdk/client-apigatewayv2"); // CommonJS import + * const client = new ApiGatewayV2Client(config); + * const command = new GetRouteResponsesCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetRouteResponsesCommandInput} for command's `input` shape. + * @see {@link GetRouteResponsesCommandOutput} for command's `response` shape. + * @see {@link ApiGatewayV2ClientResolvedConfig | config} for command's `input` shape. + * */ export class GetRouteResponsesCommand extends $Command< GetRouteResponsesCommandInput, diff --git a/clients/client-apigatewayv2/commands/GetRoutesCommand.ts b/clients/client-apigatewayv2/commands/GetRoutesCommand.ts index acb82d4d5a9b..27d0dce6bbb2 100644 --- a/clients/client-apigatewayv2/commands/GetRoutesCommand.ts +++ b/clients/client-apigatewayv2/commands/GetRoutesCommand.ts @@ -22,6 +22,20 @@ export interface GetRoutesCommandOutput extends GetRoutesResponse, __MetadataBea /** *

Gets the Routes for an API.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ApiGatewayV2Client, GetRoutesCommand } from "@aws-sdk/client-apigatewayv2"; // ES Modules import + * // const { ApiGatewayV2Client, GetRoutesCommand } = require("@aws-sdk/client-apigatewayv2"); // CommonJS import + * const client = new ApiGatewayV2Client(config); + * const command = new GetRoutesCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetRoutesCommandInput} for command's `input` shape. + * @see {@link GetRoutesCommandOutput} for command's `response` shape. + * @see {@link ApiGatewayV2ClientResolvedConfig | config} for command's `input` shape. + * */ export class GetRoutesCommand extends $Command< GetRoutesCommandInput, diff --git a/clients/client-apigatewayv2/commands/GetStageCommand.ts b/clients/client-apigatewayv2/commands/GetStageCommand.ts index 4d5819f70c1f..d15aff7d6b23 100644 --- a/clients/client-apigatewayv2/commands/GetStageCommand.ts +++ b/clients/client-apigatewayv2/commands/GetStageCommand.ts @@ -22,6 +22,20 @@ export interface GetStageCommandOutput extends GetStageResponse, __MetadataBeare /** *

Gets a Stage.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ApiGatewayV2Client, GetStageCommand } from "@aws-sdk/client-apigatewayv2"; // ES Modules import + * // const { ApiGatewayV2Client, GetStageCommand } = require("@aws-sdk/client-apigatewayv2"); // CommonJS import + * const client = new ApiGatewayV2Client(config); + * const command = new GetStageCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetStageCommandInput} for command's `input` shape. + * @see {@link GetStageCommandOutput} for command's `response` shape. + * @see {@link ApiGatewayV2ClientResolvedConfig | config} for command's `input` shape. + * */ export class GetStageCommand extends $Command< GetStageCommandInput, diff --git a/clients/client-apigatewayv2/commands/GetStagesCommand.ts b/clients/client-apigatewayv2/commands/GetStagesCommand.ts index a0aefb10ab79..9bd4568243f4 100644 --- a/clients/client-apigatewayv2/commands/GetStagesCommand.ts +++ b/clients/client-apigatewayv2/commands/GetStagesCommand.ts @@ -22,6 +22,20 @@ export interface GetStagesCommandOutput extends GetStagesResponse, __MetadataBea /** *

Gets the Stages for an API.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ApiGatewayV2Client, GetStagesCommand } from "@aws-sdk/client-apigatewayv2"; // ES Modules import + * // const { ApiGatewayV2Client, GetStagesCommand } = require("@aws-sdk/client-apigatewayv2"); // CommonJS import + * const client = new ApiGatewayV2Client(config); + * const command = new GetStagesCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetStagesCommandInput} for command's `input` shape. + * @see {@link GetStagesCommandOutput} for command's `response` shape. + * @see {@link ApiGatewayV2ClientResolvedConfig | config} for command's `input` shape. + * */ export class GetStagesCommand extends $Command< GetStagesCommandInput, diff --git a/clients/client-apigatewayv2/commands/GetTagsCommand.ts b/clients/client-apigatewayv2/commands/GetTagsCommand.ts index 653cbbdcf868..94ef583c6627 100644 --- a/clients/client-apigatewayv2/commands/GetTagsCommand.ts +++ b/clients/client-apigatewayv2/commands/GetTagsCommand.ts @@ -22,6 +22,20 @@ export interface GetTagsCommandOutput extends GetTagsResponse, __MetadataBearer /** *

Gets a collection of Tag resources.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ApiGatewayV2Client, GetTagsCommand } from "@aws-sdk/client-apigatewayv2"; // ES Modules import + * // const { ApiGatewayV2Client, GetTagsCommand } = require("@aws-sdk/client-apigatewayv2"); // CommonJS import + * const client = new ApiGatewayV2Client(config); + * const command = new GetTagsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetTagsCommandInput} for command's `input` shape. + * @see {@link GetTagsCommandOutput} for command's `response` shape. + * @see {@link ApiGatewayV2ClientResolvedConfig | config} for command's `input` shape. + * */ export class GetTagsCommand extends $Command< GetTagsCommandInput, diff --git a/clients/client-apigatewayv2/commands/GetVpcLinkCommand.ts b/clients/client-apigatewayv2/commands/GetVpcLinkCommand.ts index bee787bccb93..0e391ca02171 100644 --- a/clients/client-apigatewayv2/commands/GetVpcLinkCommand.ts +++ b/clients/client-apigatewayv2/commands/GetVpcLinkCommand.ts @@ -22,6 +22,20 @@ export interface GetVpcLinkCommandOutput extends GetVpcLinkResponse, __MetadataB /** *

Gets a VPC link.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ApiGatewayV2Client, GetVpcLinkCommand } from "@aws-sdk/client-apigatewayv2"; // ES Modules import + * // const { ApiGatewayV2Client, GetVpcLinkCommand } = require("@aws-sdk/client-apigatewayv2"); // CommonJS import + * const client = new ApiGatewayV2Client(config); + * const command = new GetVpcLinkCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetVpcLinkCommandInput} for command's `input` shape. + * @see {@link GetVpcLinkCommandOutput} for command's `response` shape. + * @see {@link ApiGatewayV2ClientResolvedConfig | config} for command's `input` shape. + * */ export class GetVpcLinkCommand extends $Command< GetVpcLinkCommandInput, diff --git a/clients/client-apigatewayv2/commands/GetVpcLinksCommand.ts b/clients/client-apigatewayv2/commands/GetVpcLinksCommand.ts index 20b8295e137e..b3a45a6fec8c 100644 --- a/clients/client-apigatewayv2/commands/GetVpcLinksCommand.ts +++ b/clients/client-apigatewayv2/commands/GetVpcLinksCommand.ts @@ -22,6 +22,20 @@ export interface GetVpcLinksCommandOutput extends GetVpcLinksResponse, __Metadat /** *

Gets a collection of VPC links.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ApiGatewayV2Client, GetVpcLinksCommand } from "@aws-sdk/client-apigatewayv2"; // ES Modules import + * // const { ApiGatewayV2Client, GetVpcLinksCommand } = require("@aws-sdk/client-apigatewayv2"); // CommonJS import + * const client = new ApiGatewayV2Client(config); + * const command = new GetVpcLinksCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetVpcLinksCommandInput} for command's `input` shape. + * @see {@link GetVpcLinksCommandOutput} for command's `response` shape. + * @see {@link ApiGatewayV2ClientResolvedConfig | config} for command's `input` shape. + * */ export class GetVpcLinksCommand extends $Command< GetVpcLinksCommandInput, diff --git a/clients/client-apigatewayv2/commands/ImportApiCommand.ts b/clients/client-apigatewayv2/commands/ImportApiCommand.ts index 4f2b7d783ce9..e3bf61509eb6 100644 --- a/clients/client-apigatewayv2/commands/ImportApiCommand.ts +++ b/clients/client-apigatewayv2/commands/ImportApiCommand.ts @@ -22,6 +22,20 @@ export interface ImportApiCommandOutput extends ImportApiResponse, __MetadataBea /** *

Imports an API.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ApiGatewayV2Client, ImportApiCommand } from "@aws-sdk/client-apigatewayv2"; // ES Modules import + * // const { ApiGatewayV2Client, ImportApiCommand } = require("@aws-sdk/client-apigatewayv2"); // CommonJS import + * const client = new ApiGatewayV2Client(config); + * const command = new ImportApiCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ImportApiCommandInput} for command's `input` shape. + * @see {@link ImportApiCommandOutput} for command's `response` shape. + * @see {@link ApiGatewayV2ClientResolvedConfig | config} for command's `input` shape. + * */ export class ImportApiCommand extends $Command< ImportApiCommandInput, diff --git a/clients/client-apigatewayv2/commands/ReimportApiCommand.ts b/clients/client-apigatewayv2/commands/ReimportApiCommand.ts index c4f039269246..7810c48fa610 100644 --- a/clients/client-apigatewayv2/commands/ReimportApiCommand.ts +++ b/clients/client-apigatewayv2/commands/ReimportApiCommand.ts @@ -22,6 +22,20 @@ export interface ReimportApiCommandOutput extends ReimportApiResponse, __Metadat /** *

Puts an Api resource.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ApiGatewayV2Client, ReimportApiCommand } from "@aws-sdk/client-apigatewayv2"; // ES Modules import + * // const { ApiGatewayV2Client, ReimportApiCommand } = require("@aws-sdk/client-apigatewayv2"); // CommonJS import + * const client = new ApiGatewayV2Client(config); + * const command = new ReimportApiCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ReimportApiCommandInput} for command's `input` shape. + * @see {@link ReimportApiCommandOutput} for command's `response` shape. + * @see {@link ApiGatewayV2ClientResolvedConfig | config} for command's `input` shape. + * */ export class ReimportApiCommand extends $Command< ReimportApiCommandInput, diff --git a/clients/client-apigatewayv2/commands/ResetAuthorizersCacheCommand.ts b/clients/client-apigatewayv2/commands/ResetAuthorizersCacheCommand.ts index db73223d5455..aa7134db1fe2 100644 --- a/clients/client-apigatewayv2/commands/ResetAuthorizersCacheCommand.ts +++ b/clients/client-apigatewayv2/commands/ResetAuthorizersCacheCommand.ts @@ -22,6 +22,20 @@ export interface ResetAuthorizersCacheCommandOutput extends __MetadataBearer {} /** *

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

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ApiGatewayV2Client, ResetAuthorizersCacheCommand } from "@aws-sdk/client-apigatewayv2"; // ES Modules import + * // const { ApiGatewayV2Client, ResetAuthorizersCacheCommand } = require("@aws-sdk/client-apigatewayv2"); // CommonJS import + * const client = new ApiGatewayV2Client(config); + * const command = new ResetAuthorizersCacheCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ResetAuthorizersCacheCommandInput} for command's `input` shape. + * @see {@link ResetAuthorizersCacheCommandOutput} for command's `response` shape. + * @see {@link ApiGatewayV2ClientResolvedConfig | config} for command's `input` shape. + * */ export class ResetAuthorizersCacheCommand extends $Command< ResetAuthorizersCacheCommandInput, diff --git a/clients/client-apigatewayv2/commands/TagResourceCommand.ts b/clients/client-apigatewayv2/commands/TagResourceCommand.ts index a88753b0fd9f..238ff1b159e7 100644 --- a/clients/client-apigatewayv2/commands/TagResourceCommand.ts +++ b/clients/client-apigatewayv2/commands/TagResourceCommand.ts @@ -22,6 +22,20 @@ export interface TagResourceCommandOutput extends TagResourceResponse, __Metadat /** *

Creates a new Tag resource to represent a tag.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ApiGatewayV2Client, TagResourceCommand } from "@aws-sdk/client-apigatewayv2"; // ES Modules import + * // const { ApiGatewayV2Client, TagResourceCommand } = require("@aws-sdk/client-apigatewayv2"); // CommonJS import + * const client = new ApiGatewayV2Client(config); + * const command = new TagResourceCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link TagResourceCommandInput} for command's `input` shape. + * @see {@link TagResourceCommandOutput} for command's `response` shape. + * @see {@link ApiGatewayV2ClientResolvedConfig | config} for command's `input` shape. + * */ export class TagResourceCommand extends $Command< TagResourceCommandInput, diff --git a/clients/client-apigatewayv2/commands/UntagResourceCommand.ts b/clients/client-apigatewayv2/commands/UntagResourceCommand.ts index 0f3a7cc1bbb1..027a7eae157d 100644 --- a/clients/client-apigatewayv2/commands/UntagResourceCommand.ts +++ b/clients/client-apigatewayv2/commands/UntagResourceCommand.ts @@ -22,6 +22,20 @@ export interface UntagResourceCommandOutput extends __MetadataBearer {} /** *

Deletes a Tag.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ApiGatewayV2Client, UntagResourceCommand } from "@aws-sdk/client-apigatewayv2"; // ES Modules import + * // const { ApiGatewayV2Client, UntagResourceCommand } = require("@aws-sdk/client-apigatewayv2"); // CommonJS import + * const client = new ApiGatewayV2Client(config); + * const command = new UntagResourceCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link UntagResourceCommandInput} for command's `input` shape. + * @see {@link UntagResourceCommandOutput} for command's `response` shape. + * @see {@link ApiGatewayV2ClientResolvedConfig | config} for command's `input` shape. + * */ export class UntagResourceCommand extends $Command< UntagResourceCommandInput, diff --git a/clients/client-apigatewayv2/commands/UpdateApiCommand.ts b/clients/client-apigatewayv2/commands/UpdateApiCommand.ts index e6d47229faa5..ba84d87b6862 100644 --- a/clients/client-apigatewayv2/commands/UpdateApiCommand.ts +++ b/clients/client-apigatewayv2/commands/UpdateApiCommand.ts @@ -22,6 +22,20 @@ export interface UpdateApiCommandOutput extends UpdateApiResponse, __MetadataBea /** *

Updates an Api resource.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ApiGatewayV2Client, UpdateApiCommand } from "@aws-sdk/client-apigatewayv2"; // ES Modules import + * // const { ApiGatewayV2Client, UpdateApiCommand } = require("@aws-sdk/client-apigatewayv2"); // CommonJS import + * const client = new ApiGatewayV2Client(config); + * const command = new UpdateApiCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link UpdateApiCommandInput} for command's `input` shape. + * @see {@link UpdateApiCommandOutput} for command's `response` shape. + * @see {@link ApiGatewayV2ClientResolvedConfig | config} for command's `input` shape. + * */ export class UpdateApiCommand extends $Command< UpdateApiCommandInput, diff --git a/clients/client-apigatewayv2/commands/UpdateApiMappingCommand.ts b/clients/client-apigatewayv2/commands/UpdateApiMappingCommand.ts index 6f9caea1cef8..816c4717f766 100644 --- a/clients/client-apigatewayv2/commands/UpdateApiMappingCommand.ts +++ b/clients/client-apigatewayv2/commands/UpdateApiMappingCommand.ts @@ -22,6 +22,20 @@ export interface UpdateApiMappingCommandOutput extends UpdateApiMappingResponse, /** *

The API mapping.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ApiGatewayV2Client, UpdateApiMappingCommand } from "@aws-sdk/client-apigatewayv2"; // ES Modules import + * // const { ApiGatewayV2Client, UpdateApiMappingCommand } = require("@aws-sdk/client-apigatewayv2"); // CommonJS import + * const client = new ApiGatewayV2Client(config); + * const command = new UpdateApiMappingCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link UpdateApiMappingCommandInput} for command's `input` shape. + * @see {@link UpdateApiMappingCommandOutput} for command's `response` shape. + * @see {@link ApiGatewayV2ClientResolvedConfig | config} for command's `input` shape. + * */ export class UpdateApiMappingCommand extends $Command< UpdateApiMappingCommandInput, diff --git a/clients/client-apigatewayv2/commands/UpdateAuthorizerCommand.ts b/clients/client-apigatewayv2/commands/UpdateAuthorizerCommand.ts index 31417d8eab8e..28022a86e3e9 100644 --- a/clients/client-apigatewayv2/commands/UpdateAuthorizerCommand.ts +++ b/clients/client-apigatewayv2/commands/UpdateAuthorizerCommand.ts @@ -22,6 +22,20 @@ export interface UpdateAuthorizerCommandOutput extends UpdateAuthorizerResponse, /** *

Updates an Authorizer.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ApiGatewayV2Client, UpdateAuthorizerCommand } from "@aws-sdk/client-apigatewayv2"; // ES Modules import + * // const { ApiGatewayV2Client, UpdateAuthorizerCommand } = require("@aws-sdk/client-apigatewayv2"); // CommonJS import + * const client = new ApiGatewayV2Client(config); + * const command = new UpdateAuthorizerCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link UpdateAuthorizerCommandInput} for command's `input` shape. + * @see {@link UpdateAuthorizerCommandOutput} for command's `response` shape. + * @see {@link ApiGatewayV2ClientResolvedConfig | config} for command's `input` shape. + * */ export class UpdateAuthorizerCommand extends $Command< UpdateAuthorizerCommandInput, diff --git a/clients/client-apigatewayv2/commands/UpdateDeploymentCommand.ts b/clients/client-apigatewayv2/commands/UpdateDeploymentCommand.ts index 0bc5c92eded0..16f8205a35d9 100644 --- a/clients/client-apigatewayv2/commands/UpdateDeploymentCommand.ts +++ b/clients/client-apigatewayv2/commands/UpdateDeploymentCommand.ts @@ -22,6 +22,20 @@ export interface UpdateDeploymentCommandOutput extends UpdateDeploymentResponse, /** *

Updates a Deployment.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ApiGatewayV2Client, UpdateDeploymentCommand } from "@aws-sdk/client-apigatewayv2"; // ES Modules import + * // const { ApiGatewayV2Client, UpdateDeploymentCommand } = require("@aws-sdk/client-apigatewayv2"); // CommonJS import + * const client = new ApiGatewayV2Client(config); + * const command = new UpdateDeploymentCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link UpdateDeploymentCommandInput} for command's `input` shape. + * @see {@link UpdateDeploymentCommandOutput} for command's `response` shape. + * @see {@link ApiGatewayV2ClientResolvedConfig | config} for command's `input` shape. + * */ export class UpdateDeploymentCommand extends $Command< UpdateDeploymentCommandInput, diff --git a/clients/client-apigatewayv2/commands/UpdateDomainNameCommand.ts b/clients/client-apigatewayv2/commands/UpdateDomainNameCommand.ts index dee7e790cd75..61b24a7c2b7e 100644 --- a/clients/client-apigatewayv2/commands/UpdateDomainNameCommand.ts +++ b/clients/client-apigatewayv2/commands/UpdateDomainNameCommand.ts @@ -22,6 +22,20 @@ export interface UpdateDomainNameCommandOutput extends UpdateDomainNameResponse, /** *

Updates a domain name.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ApiGatewayV2Client, UpdateDomainNameCommand } from "@aws-sdk/client-apigatewayv2"; // ES Modules import + * // const { ApiGatewayV2Client, UpdateDomainNameCommand } = require("@aws-sdk/client-apigatewayv2"); // CommonJS import + * const client = new ApiGatewayV2Client(config); + * const command = new UpdateDomainNameCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link UpdateDomainNameCommandInput} for command's `input` shape. + * @see {@link UpdateDomainNameCommandOutput} for command's `response` shape. + * @see {@link ApiGatewayV2ClientResolvedConfig | config} for command's `input` shape. + * */ export class UpdateDomainNameCommand extends $Command< UpdateDomainNameCommandInput, diff --git a/clients/client-apigatewayv2/commands/UpdateIntegrationCommand.ts b/clients/client-apigatewayv2/commands/UpdateIntegrationCommand.ts index 3378b422326c..b44352cc172f 100644 --- a/clients/client-apigatewayv2/commands/UpdateIntegrationCommand.ts +++ b/clients/client-apigatewayv2/commands/UpdateIntegrationCommand.ts @@ -22,6 +22,20 @@ export interface UpdateIntegrationCommandOutput extends UpdateIntegrationResult, /** *

Updates an Integration.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ApiGatewayV2Client, UpdateIntegrationCommand } from "@aws-sdk/client-apigatewayv2"; // ES Modules import + * // const { ApiGatewayV2Client, UpdateIntegrationCommand } = require("@aws-sdk/client-apigatewayv2"); // CommonJS import + * const client = new ApiGatewayV2Client(config); + * const command = new UpdateIntegrationCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link UpdateIntegrationCommandInput} for command's `input` shape. + * @see {@link UpdateIntegrationCommandOutput} for command's `response` shape. + * @see {@link ApiGatewayV2ClientResolvedConfig | config} for command's `input` shape. + * */ export class UpdateIntegrationCommand extends $Command< UpdateIntegrationCommandInput, diff --git a/clients/client-apigatewayv2/commands/UpdateIntegrationResponseCommand.ts b/clients/client-apigatewayv2/commands/UpdateIntegrationResponseCommand.ts index 111275506e43..ddc1add164d6 100644 --- a/clients/client-apigatewayv2/commands/UpdateIntegrationResponseCommand.ts +++ b/clients/client-apigatewayv2/commands/UpdateIntegrationResponseCommand.ts @@ -22,6 +22,20 @@ export interface UpdateIntegrationResponseCommandOutput extends UpdateIntegratio /** *

Updates an IntegrationResponses.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ApiGatewayV2Client, UpdateIntegrationResponseCommand } from "@aws-sdk/client-apigatewayv2"; // ES Modules import + * // const { ApiGatewayV2Client, UpdateIntegrationResponseCommand } = require("@aws-sdk/client-apigatewayv2"); // CommonJS import + * const client = new ApiGatewayV2Client(config); + * const command = new UpdateIntegrationResponseCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link UpdateIntegrationResponseCommandInput} for command's `input` shape. + * @see {@link UpdateIntegrationResponseCommandOutput} for command's `response` shape. + * @see {@link ApiGatewayV2ClientResolvedConfig | config} for command's `input` shape. + * */ export class UpdateIntegrationResponseCommand extends $Command< UpdateIntegrationResponseCommandInput, diff --git a/clients/client-apigatewayv2/commands/UpdateModelCommand.ts b/clients/client-apigatewayv2/commands/UpdateModelCommand.ts index f18db075b46e..3838b5ec1161 100644 --- a/clients/client-apigatewayv2/commands/UpdateModelCommand.ts +++ b/clients/client-apigatewayv2/commands/UpdateModelCommand.ts @@ -22,6 +22,20 @@ export interface UpdateModelCommandOutput extends UpdateModelResponse, __Metadat /** *

Updates a Model.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ApiGatewayV2Client, UpdateModelCommand } from "@aws-sdk/client-apigatewayv2"; // ES Modules import + * // const { ApiGatewayV2Client, UpdateModelCommand } = require("@aws-sdk/client-apigatewayv2"); // CommonJS import + * const client = new ApiGatewayV2Client(config); + * const command = new UpdateModelCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link UpdateModelCommandInput} for command's `input` shape. + * @see {@link UpdateModelCommandOutput} for command's `response` shape. + * @see {@link ApiGatewayV2ClientResolvedConfig | config} for command's `input` shape. + * */ export class UpdateModelCommand extends $Command< UpdateModelCommandInput, diff --git a/clients/client-apigatewayv2/commands/UpdateRouteCommand.ts b/clients/client-apigatewayv2/commands/UpdateRouteCommand.ts index 599935a4340e..fcc7697097bd 100644 --- a/clients/client-apigatewayv2/commands/UpdateRouteCommand.ts +++ b/clients/client-apigatewayv2/commands/UpdateRouteCommand.ts @@ -22,6 +22,20 @@ export interface UpdateRouteCommandOutput extends UpdateRouteResult, __MetadataB /** *

Updates a Route.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ApiGatewayV2Client, UpdateRouteCommand } from "@aws-sdk/client-apigatewayv2"; // ES Modules import + * // const { ApiGatewayV2Client, UpdateRouteCommand } = require("@aws-sdk/client-apigatewayv2"); // CommonJS import + * const client = new ApiGatewayV2Client(config); + * const command = new UpdateRouteCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link UpdateRouteCommandInput} for command's `input` shape. + * @see {@link UpdateRouteCommandOutput} for command's `response` shape. + * @see {@link ApiGatewayV2ClientResolvedConfig | config} for command's `input` shape. + * */ export class UpdateRouteCommand extends $Command< UpdateRouteCommandInput, diff --git a/clients/client-apigatewayv2/commands/UpdateRouteResponseCommand.ts b/clients/client-apigatewayv2/commands/UpdateRouteResponseCommand.ts index b25fdf93febe..26ab66b2d1b1 100644 --- a/clients/client-apigatewayv2/commands/UpdateRouteResponseCommand.ts +++ b/clients/client-apigatewayv2/commands/UpdateRouteResponseCommand.ts @@ -22,6 +22,20 @@ export interface UpdateRouteResponseCommandOutput extends UpdateRouteResponseRes /** *

Updates a RouteResponse.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ApiGatewayV2Client, UpdateRouteResponseCommand } from "@aws-sdk/client-apigatewayv2"; // ES Modules import + * // const { ApiGatewayV2Client, UpdateRouteResponseCommand } = require("@aws-sdk/client-apigatewayv2"); // CommonJS import + * const client = new ApiGatewayV2Client(config); + * const command = new UpdateRouteResponseCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link UpdateRouteResponseCommandInput} for command's `input` shape. + * @see {@link UpdateRouteResponseCommandOutput} for command's `response` shape. + * @see {@link ApiGatewayV2ClientResolvedConfig | config} for command's `input` shape. + * */ export class UpdateRouteResponseCommand extends $Command< UpdateRouteResponseCommandInput, diff --git a/clients/client-apigatewayv2/commands/UpdateStageCommand.ts b/clients/client-apigatewayv2/commands/UpdateStageCommand.ts index 21a5f1dd687c..b63bd079adef 100644 --- a/clients/client-apigatewayv2/commands/UpdateStageCommand.ts +++ b/clients/client-apigatewayv2/commands/UpdateStageCommand.ts @@ -22,6 +22,20 @@ export interface UpdateStageCommandOutput extends UpdateStageResponse, __Metadat /** *

Updates a Stage.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ApiGatewayV2Client, UpdateStageCommand } from "@aws-sdk/client-apigatewayv2"; // ES Modules import + * // const { ApiGatewayV2Client, UpdateStageCommand } = require("@aws-sdk/client-apigatewayv2"); // CommonJS import + * const client = new ApiGatewayV2Client(config); + * const command = new UpdateStageCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link UpdateStageCommandInput} for command's `input` shape. + * @see {@link UpdateStageCommandOutput} for command's `response` shape. + * @see {@link ApiGatewayV2ClientResolvedConfig | config} for command's `input` shape. + * */ export class UpdateStageCommand extends $Command< UpdateStageCommandInput, diff --git a/clients/client-apigatewayv2/commands/UpdateVpcLinkCommand.ts b/clients/client-apigatewayv2/commands/UpdateVpcLinkCommand.ts index 3c3e3ca22c21..f4e9b821e469 100644 --- a/clients/client-apigatewayv2/commands/UpdateVpcLinkCommand.ts +++ b/clients/client-apigatewayv2/commands/UpdateVpcLinkCommand.ts @@ -22,6 +22,20 @@ export interface UpdateVpcLinkCommandOutput extends UpdateVpcLinkResponse, __Met /** *

Updates a VPC link.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ApiGatewayV2Client, UpdateVpcLinkCommand } from "@aws-sdk/client-apigatewayv2"; // ES Modules import + * // const { ApiGatewayV2Client, UpdateVpcLinkCommand } = require("@aws-sdk/client-apigatewayv2"); // CommonJS import + * const client = new ApiGatewayV2Client(config); + * const command = new UpdateVpcLinkCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link UpdateVpcLinkCommandInput} for command's `input` shape. + * @see {@link UpdateVpcLinkCommandOutput} for command's `response` shape. + * @see {@link ApiGatewayV2ClientResolvedConfig | config} for command's `input` shape. + * */ export class UpdateVpcLinkCommand extends $Command< UpdateVpcLinkCommandInput, diff --git a/clients/client-apigatewayv2/models/models_0.ts b/clients/client-apigatewayv2/models/models_0.ts index 59cdb2a93d7d..e3645515c7f0 100644 --- a/clients/client-apigatewayv2/models/models_0.ts +++ b/clients/client-apigatewayv2/models/models_0.ts @@ -37,6 +37,9 @@ export interface Cors { } export namespace Cors { + /** + * @internal + */ export const filterSensitiveLog = (obj: Cors): any => ({ ...obj, }); @@ -133,6 +136,9 @@ export interface Api { } export namespace Api { + /** + * @internal + */ export const filterSensitiveLog = (obj: Api): any => ({ ...obj, }); @@ -164,6 +170,9 @@ export interface ApiMapping { } export namespace ApiMapping { + /** + * @internal + */ export const filterSensitiveLog = (obj: ApiMapping): any => ({ ...obj, }); @@ -191,6 +200,9 @@ export interface JWTConfiguration { } export namespace JWTConfiguration { + /** + * @internal + */ export const filterSensitiveLog = (obj: JWTConfiguration): any => ({ ...obj, }); @@ -258,6 +270,9 @@ export interface Authorizer { } export namespace Authorizer { + /** + * @internal + */ export const filterSensitiveLog = (obj: Authorizer): any => ({ ...obj, }); @@ -305,6 +320,9 @@ export interface Deployment { } export namespace Deployment { + /** + * @internal + */ export const filterSensitiveLog = (obj: Deployment): any => ({ ...obj, }); @@ -376,6 +394,9 @@ export interface DomainNameConfiguration { } export namespace DomainNameConfiguration { + /** + * @internal + */ export const filterSensitiveLog = (obj: DomainNameConfiguration): any => ({ ...obj, }); @@ -399,6 +420,9 @@ export interface MutualTlsAuthentication { } export namespace MutualTlsAuthentication { + /** + * @internal + */ export const filterSensitiveLog = (obj: MutualTlsAuthentication): any => ({ ...obj, }); @@ -435,6 +459,9 @@ export interface DomainName { } export namespace DomainName { + /** + * @internal + */ export const filterSensitiveLog = (obj: DomainName): any => ({ ...obj, }); @@ -475,6 +502,9 @@ export interface TlsConfig { } export namespace TlsConfig { + /** + * @internal + */ export const filterSensitiveLog = (obj: TlsConfig): any => ({ ...obj, }); @@ -591,6 +621,9 @@ export interface Integration { } export namespace Integration { + /** + * @internal + */ export const filterSensitiveLog = (obj: Integration): any => ({ ...obj, }); @@ -632,6 +665,9 @@ export interface IntegrationResponse { } export namespace IntegrationResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: IntegrationResponse): any => ({ ...obj, }); @@ -668,6 +704,9 @@ export interface Model { } export namespace Model { + /** + * @internal + */ export const filterSensitiveLog = (obj: Model): any => ({ ...obj, }); @@ -691,6 +730,9 @@ export interface ParameterConstraints { } export namespace ParameterConstraints { + /** + * @internal + */ export const filterSensitiveLog = (obj: ParameterConstraints): any => ({ ...obj, }); @@ -767,6 +809,9 @@ export interface Route { } export namespace Route { + /** + * @internal + */ export const filterSensitiveLog = (obj: Route): any => ({ ...obj, }); @@ -803,6 +848,9 @@ export interface RouteResponse { } export namespace RouteResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: RouteResponse): any => ({ ...obj, }); @@ -824,6 +872,9 @@ export interface AccessLogSettings { } export namespace AccessLogSettings { + /** + * @internal + */ export const filterSensitiveLog = (obj: AccessLogSettings): any => ({ ...obj, }); @@ -866,6 +917,9 @@ export interface RouteSettings { } export namespace RouteSettings { + /** + * @internal + */ export const filterSensitiveLog = (obj: RouteSettings): any => ({ ...obj, }); @@ -947,6 +1001,9 @@ export interface Stage { } export namespace Stage { + /** + * @internal + */ export const filterSensitiveLog = (obj: Stage): any => ({ ...obj, }); @@ -1015,6 +1072,9 @@ export interface VpcLink { } export namespace VpcLink { + /** + * @internal + */ export const filterSensitiveLog = (obj: VpcLink): any => ({ ...obj, }); @@ -1027,6 +1087,9 @@ export interface AccessDeniedException extends __SmithyException, $MetadataBeare } export namespace AccessDeniedException { + /** + * @internal + */ export const filterSensitiveLog = (obj: AccessDeniedException): any => ({ ...obj, }); @@ -1045,6 +1108,9 @@ export interface BadRequestException extends __SmithyException, $MetadataBearer } export namespace BadRequestException { + /** + * @internal + */ export const filterSensitiveLog = (obj: BadRequestException): any => ({ ...obj, }); @@ -1063,6 +1129,9 @@ export interface ConflictException extends __SmithyException, $MetadataBearer { } export namespace ConflictException { + /** + * @internal + */ export const filterSensitiveLog = (obj: ConflictException): any => ({ ...obj, }); @@ -1139,6 +1208,9 @@ export interface CreateApiRequest { } export namespace CreateApiRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateApiRequest): any => ({ ...obj, }); @@ -1227,6 +1299,9 @@ export interface CreateApiResponse { } export namespace CreateApiResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateApiResponse): any => ({ ...obj, }); @@ -1250,6 +1325,9 @@ export interface NotFoundException extends __SmithyException, $MetadataBearer { } export namespace NotFoundException { + /** + * @internal + */ export const filterSensitiveLog = (obj: NotFoundException): any => ({ ...obj, }); @@ -1273,6 +1351,9 @@ export interface TooManyRequestsException extends __SmithyException, $MetadataBe } export namespace TooManyRequestsException { + /** + * @internal + */ export const filterSensitiveLog = (obj: TooManyRequestsException): any => ({ ...obj, }); @@ -1304,6 +1385,9 @@ export interface CreateApiMappingRequest { } export namespace CreateApiMappingRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateApiMappingRequest): any => ({ ...obj, }); @@ -1332,6 +1416,9 @@ export interface CreateApiMappingResponse { } export namespace CreateApiMappingResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateApiMappingResponse): any => ({ ...obj, }); @@ -1399,6 +1486,9 @@ export interface CreateAuthorizerRequest { } export namespace CreateAuthorizerRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateAuthorizerRequest): any => ({ ...obj, }); @@ -1463,6 +1553,9 @@ export interface CreateAuthorizerResponse { } export namespace CreateAuthorizerResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateAuthorizerResponse): any => ({ ...obj, }); @@ -1489,6 +1582,9 @@ export interface CreateDeploymentRequest { } export namespace CreateDeploymentRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateDeploymentRequest): any => ({ ...obj, }); @@ -1527,6 +1623,9 @@ export interface CreateDeploymentResponse { } export namespace CreateDeploymentResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateDeploymentResponse): any => ({ ...obj, }); @@ -1545,6 +1644,9 @@ export interface MutualTlsAuthenticationInput { } export namespace MutualTlsAuthenticationInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: MutualTlsAuthenticationInput): any => ({ ...obj, }); @@ -1576,6 +1678,9 @@ export interface CreateDomainNameRequest { } export namespace CreateDomainNameRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateDomainNameRequest): any => ({ ...obj, }); @@ -1609,6 +1714,9 @@ export interface CreateDomainNameResponse { } export namespace CreateDomainNameResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateDomainNameResponse): any => ({ ...obj, }); @@ -1625,6 +1733,9 @@ export interface TlsConfigInput { } export namespace TlsConfigInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: TlsConfigInput): any => ({ ...obj, }); @@ -1731,6 +1842,9 @@ export interface CreateIntegrationRequest { } export namespace CreateIntegrationRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateIntegrationRequest): any => ({ ...obj, }); @@ -1844,6 +1958,9 @@ export interface CreateIntegrationResult { } export namespace CreateIntegrationResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateIntegrationResult): any => ({ ...obj, }); @@ -1890,6 +2007,9 @@ export interface CreateIntegrationResponseRequest { } export namespace CreateIntegrationResponseRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateIntegrationResponseRequest): any => ({ ...obj, }); @@ -1928,6 +2048,9 @@ export interface CreateIntegrationResponseResponse { } export namespace CreateIntegrationResponseResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateIntegrationResponseResponse): any => ({ ...obj, }); @@ -1964,6 +2087,9 @@ export interface CreateModelRequest { } export namespace CreateModelRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateModelRequest): any => ({ ...obj, }); @@ -1997,6 +2123,9 @@ export interface CreateModelResponse { } export namespace CreateModelResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateModelResponse): any => ({ ...obj, }); @@ -2068,6 +2197,9 @@ export interface CreateRouteRequest { } export namespace CreateRouteRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateRouteRequest): any => ({ ...obj, }); @@ -2141,6 +2273,9 @@ export interface CreateRouteResult { } export namespace CreateRouteResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateRouteResult): any => ({ ...obj, }); @@ -2182,6 +2317,9 @@ export interface CreateRouteResponseRequest { } export namespace CreateRouteResponseRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateRouteResponseRequest): any => ({ ...obj, }); @@ -2215,6 +2353,9 @@ export interface CreateRouteResponseResponse { } export namespace CreateRouteResponseResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateRouteResponseResponse): any => ({ ...obj, }); @@ -2281,6 +2422,9 @@ export interface CreateStageRequest { } export namespace CreateStageRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateStageRequest): any => ({ ...obj, }); @@ -2359,6 +2503,9 @@ export interface CreateStageResponse { } export namespace CreateStageResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateStageResponse): any => ({ ...obj, }); @@ -2390,6 +2537,9 @@ export interface CreateVpcLinkRequest { } export namespace CreateVpcLinkRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateVpcLinkRequest): any => ({ ...obj, }); @@ -2443,6 +2593,9 @@ export interface CreateVpcLinkResponse { } export namespace CreateVpcLinkResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateVpcLinkResponse): any => ({ ...obj, }); @@ -2461,6 +2614,9 @@ export interface DeleteAccessLogSettingsRequest { } export namespace DeleteAccessLogSettingsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteAccessLogSettingsRequest): any => ({ ...obj, }); @@ -2474,6 +2630,9 @@ export interface DeleteApiRequest { } export namespace DeleteApiRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteApiRequest): any => ({ ...obj, }); @@ -2492,6 +2651,9 @@ export interface DeleteApiMappingRequest { } export namespace DeleteApiMappingRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteApiMappingRequest): any => ({ ...obj, }); @@ -2510,6 +2672,9 @@ export interface DeleteAuthorizerRequest { } export namespace DeleteAuthorizerRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteAuthorizerRequest): any => ({ ...obj, }); @@ -2523,6 +2688,9 @@ export interface DeleteCorsConfigurationRequest { } export namespace DeleteCorsConfigurationRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteCorsConfigurationRequest): any => ({ ...obj, }); @@ -2541,6 +2709,9 @@ export interface DeleteDeploymentRequest { } export namespace DeleteDeploymentRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteDeploymentRequest): any => ({ ...obj, }); @@ -2554,6 +2725,9 @@ export interface DeleteDomainNameRequest { } export namespace DeleteDomainNameRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteDomainNameRequest): any => ({ ...obj, }); @@ -2572,6 +2746,9 @@ export interface DeleteIntegrationRequest { } export namespace DeleteIntegrationRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteIntegrationRequest): any => ({ ...obj, }); @@ -2595,6 +2772,9 @@ export interface DeleteIntegrationResponseRequest { } export namespace DeleteIntegrationResponseRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteIntegrationResponseRequest): any => ({ ...obj, }); @@ -2613,6 +2793,9 @@ export interface DeleteModelRequest { } export namespace DeleteModelRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteModelRequest): any => ({ ...obj, }); @@ -2631,6 +2814,9 @@ export interface DeleteRouteRequest { } export namespace DeleteRouteRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteRouteRequest): any => ({ ...obj, }); @@ -2654,6 +2840,9 @@ export interface DeleteRouteRequestParameterRequest { } export namespace DeleteRouteRequestParameterRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteRouteRequestParameterRequest): any => ({ ...obj, }); @@ -2677,6 +2866,9 @@ export interface DeleteRouteResponseRequest { } export namespace DeleteRouteResponseRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteRouteResponseRequest): any => ({ ...obj, }); @@ -2700,6 +2892,9 @@ export interface DeleteRouteSettingsRequest { } export namespace DeleteRouteSettingsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteRouteSettingsRequest): any => ({ ...obj, }); @@ -2718,6 +2913,9 @@ export interface DeleteStageRequest { } export namespace DeleteStageRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteStageRequest): any => ({ ...obj, }); @@ -2731,6 +2929,9 @@ export interface DeleteVpcLinkRequest { } export namespace DeleteVpcLinkRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteVpcLinkRequest): any => ({ ...obj, }); @@ -2739,6 +2940,9 @@ export namespace DeleteVpcLinkRequest { export interface DeleteVpcLinkResponse {} export namespace DeleteVpcLinkResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteVpcLinkResponse): any => ({ ...obj, }); @@ -2777,6 +2981,9 @@ export interface ExportApiRequest { } export namespace ExportApiRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ExportApiRequest): any => ({ ...obj, }); @@ -2790,6 +2997,9 @@ export interface ExportApiResponse { } export namespace ExportApiResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ExportApiResponse): any => ({ ...obj, }); @@ -2803,6 +3013,9 @@ export interface GetApiRequest { } export namespace GetApiRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetApiRequest): any => ({ ...obj, }); @@ -2891,6 +3104,9 @@ export interface GetApiResponse { } export namespace GetApiResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetApiResponse): any => ({ ...obj, }); @@ -2909,6 +3125,9 @@ export interface GetApiMappingRequest { } export namespace GetApiMappingRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetApiMappingRequest): any => ({ ...obj, }); @@ -2937,6 +3156,9 @@ export interface GetApiMappingResponse { } export namespace GetApiMappingResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetApiMappingResponse): any => ({ ...obj, }); @@ -2960,6 +3182,9 @@ export interface GetApiMappingsRequest { } export namespace GetApiMappingsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetApiMappingsRequest): any => ({ ...obj, }); @@ -2978,6 +3203,9 @@ export interface GetApiMappingsResponse { } export namespace GetApiMappingsResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetApiMappingsResponse): any => ({ ...obj, }); @@ -2996,6 +3224,9 @@ export interface GetApisRequest { } export namespace GetApisRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetApisRequest): any => ({ ...obj, }); @@ -3014,6 +3245,9 @@ export interface GetApisResponse { } export namespace GetApisResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetApisResponse): any => ({ ...obj, }); @@ -3032,6 +3266,9 @@ export interface GetAuthorizerRequest { } export namespace GetAuthorizerRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetAuthorizerRequest): any => ({ ...obj, }); @@ -3096,6 +3333,9 @@ export interface GetAuthorizerResponse { } export namespace GetAuthorizerResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetAuthorizerResponse): any => ({ ...obj, }); @@ -3119,6 +3359,9 @@ export interface GetAuthorizersRequest { } export namespace GetAuthorizersRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetAuthorizersRequest): any => ({ ...obj, }); @@ -3137,6 +3380,9 @@ export interface GetAuthorizersResponse { } export namespace GetAuthorizersResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetAuthorizersResponse): any => ({ ...obj, }); @@ -3155,6 +3401,9 @@ export interface GetDeploymentRequest { } export namespace GetDeploymentRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetDeploymentRequest): any => ({ ...obj, }); @@ -3193,6 +3442,9 @@ export interface GetDeploymentResponse { } export namespace GetDeploymentResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetDeploymentResponse): any => ({ ...obj, }); @@ -3216,6 +3468,9 @@ export interface GetDeploymentsRequest { } export namespace GetDeploymentsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetDeploymentsRequest): any => ({ ...obj, }); @@ -3234,6 +3489,9 @@ export interface GetDeploymentsResponse { } export namespace GetDeploymentsResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetDeploymentsResponse): any => ({ ...obj, }); @@ -3247,6 +3505,9 @@ export interface GetDomainNameRequest { } export namespace GetDomainNameRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetDomainNameRequest): any => ({ ...obj, }); @@ -3280,6 +3541,9 @@ export interface GetDomainNameResponse { } export namespace GetDomainNameResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetDomainNameResponse): any => ({ ...obj, }); @@ -3298,6 +3562,9 @@ export interface GetDomainNamesRequest { } export namespace GetDomainNamesRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetDomainNamesRequest): any => ({ ...obj, }); @@ -3316,6 +3583,9 @@ export interface GetDomainNamesResponse { } export namespace GetDomainNamesResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetDomainNamesResponse): any => ({ ...obj, }); @@ -3334,6 +3604,9 @@ export interface GetIntegrationRequest { } export namespace GetIntegrationRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetIntegrationRequest): any => ({ ...obj, }); @@ -3447,6 +3720,9 @@ export interface GetIntegrationResult { } export namespace GetIntegrationResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetIntegrationResult): any => ({ ...obj, }); @@ -3470,6 +3746,9 @@ export interface GetIntegrationResponseRequest { } export namespace GetIntegrationResponseRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetIntegrationResponseRequest): any => ({ ...obj, }); @@ -3508,6 +3787,9 @@ export interface GetIntegrationResponseResponse { } export namespace GetIntegrationResponseResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetIntegrationResponseResponse): any => ({ ...obj, }); @@ -3536,6 +3818,9 @@ export interface GetIntegrationResponsesRequest { } export namespace GetIntegrationResponsesRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetIntegrationResponsesRequest): any => ({ ...obj, }); @@ -3554,6 +3839,9 @@ export interface GetIntegrationResponsesResponse { } export namespace GetIntegrationResponsesResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetIntegrationResponsesResponse): any => ({ ...obj, }); @@ -3577,6 +3865,9 @@ export interface GetIntegrationsRequest { } export namespace GetIntegrationsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetIntegrationsRequest): any => ({ ...obj, }); @@ -3595,6 +3886,9 @@ export interface GetIntegrationsResponse { } export namespace GetIntegrationsResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetIntegrationsResponse): any => ({ ...obj, }); @@ -3613,6 +3907,9 @@ export interface GetModelRequest { } export namespace GetModelRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetModelRequest): any => ({ ...obj, }); @@ -3646,6 +3943,9 @@ export interface GetModelResponse { } export namespace GetModelResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetModelResponse): any => ({ ...obj, }); @@ -3669,6 +3969,9 @@ export interface GetModelsRequest { } export namespace GetModelsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetModelsRequest): any => ({ ...obj, }); @@ -3687,6 +3990,9 @@ export interface GetModelsResponse { } export namespace GetModelsResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetModelsResponse): any => ({ ...obj, }); @@ -3705,6 +4011,9 @@ export interface GetModelTemplateRequest { } export namespace GetModelTemplateRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetModelTemplateRequest): any => ({ ...obj, }); @@ -3718,6 +4027,9 @@ export interface GetModelTemplateResponse { } export namespace GetModelTemplateResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetModelTemplateResponse): any => ({ ...obj, }); @@ -3736,6 +4048,9 @@ export interface GetRouteRequest { } export namespace GetRouteRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetRouteRequest): any => ({ ...obj, }); @@ -3809,6 +4124,9 @@ export interface GetRouteResult { } export namespace GetRouteResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetRouteResult): any => ({ ...obj, }); @@ -3832,6 +4150,9 @@ export interface GetRouteResponseRequest { } export namespace GetRouteResponseRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetRouteResponseRequest): any => ({ ...obj, }); @@ -3865,6 +4186,9 @@ export interface GetRouteResponseResponse { } export namespace GetRouteResponseResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetRouteResponseResponse): any => ({ ...obj, }); @@ -3893,6 +4217,9 @@ export interface GetRouteResponsesRequest { } export namespace GetRouteResponsesRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetRouteResponsesRequest): any => ({ ...obj, }); @@ -3911,6 +4238,9 @@ export interface GetRouteResponsesResponse { } export namespace GetRouteResponsesResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetRouteResponsesResponse): any => ({ ...obj, }); @@ -3934,6 +4264,9 @@ export interface GetRoutesRequest { } export namespace GetRoutesRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetRoutesRequest): any => ({ ...obj, }); @@ -3952,6 +4285,9 @@ export interface GetRoutesResponse { } export namespace GetRoutesResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetRoutesResponse): any => ({ ...obj, }); @@ -3970,6 +4306,9 @@ export interface GetStageRequest { } export namespace GetStageRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetStageRequest): any => ({ ...obj, }); @@ -4048,6 +4387,9 @@ export interface GetStageResponse { } export namespace GetStageResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetStageResponse): any => ({ ...obj, }); @@ -4071,6 +4413,9 @@ export interface GetStagesRequest { } export namespace GetStagesRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetStagesRequest): any => ({ ...obj, }); @@ -4089,6 +4434,9 @@ export interface GetStagesResponse { } export namespace GetStagesResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetStagesResponse): any => ({ ...obj, }); @@ -4102,6 +4450,9 @@ export interface GetTagsRequest { } export namespace GetTagsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetTagsRequest): any => ({ ...obj, }); @@ -4115,6 +4466,9 @@ export interface GetTagsResponse { } export namespace GetTagsResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetTagsResponse): any => ({ ...obj, }); @@ -4128,6 +4482,9 @@ export interface GetVpcLinkRequest { } export namespace GetVpcLinkRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetVpcLinkRequest): any => ({ ...obj, }); @@ -4181,6 +4538,9 @@ export interface GetVpcLinkResponse { } export namespace GetVpcLinkResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetVpcLinkResponse): any => ({ ...obj, }); @@ -4199,6 +4559,9 @@ export interface GetVpcLinksRequest { } export namespace GetVpcLinksRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetVpcLinksRequest): any => ({ ...obj, }); @@ -4217,6 +4580,9 @@ export interface GetVpcLinksResponse { } export namespace GetVpcLinksResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetVpcLinksResponse): any => ({ ...obj, }); @@ -4243,6 +4609,9 @@ export interface ImportApiRequest { } export namespace ImportApiRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ImportApiRequest): any => ({ ...obj, }); @@ -4331,6 +4700,9 @@ export interface ImportApiResponse { } export namespace ImportApiResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ImportApiResponse): any => ({ ...obj, }); @@ -4362,6 +4734,9 @@ export interface ReimportApiRequest { } export namespace ReimportApiRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ReimportApiRequest): any => ({ ...obj, }); @@ -4450,6 +4825,9 @@ export interface ReimportApiResponse { } export namespace ReimportApiResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ReimportApiResponse): any => ({ ...obj, }); @@ -4468,6 +4846,9 @@ export interface ResetAuthorizersCacheRequest { } export namespace ResetAuthorizersCacheRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ResetAuthorizersCacheRequest): any => ({ ...obj, }); @@ -4489,6 +4870,9 @@ export interface TagResourceRequest { } export namespace TagResourceRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: TagResourceRequest): any => ({ ...obj, }); @@ -4497,6 +4881,9 @@ export namespace TagResourceRequest { export interface TagResourceResponse {} export namespace TagResourceResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: TagResourceResponse): any => ({ ...obj, }); @@ -4515,6 +4902,9 @@ export interface UntagResourceRequest { } export namespace UntagResourceRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: UntagResourceRequest): any => ({ ...obj, }); @@ -4586,6 +4976,9 @@ export interface UpdateApiRequest { } export namespace UpdateApiRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateApiRequest): any => ({ ...obj, }); @@ -4674,6 +5067,9 @@ export interface UpdateApiResponse { } export namespace UpdateApiResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateApiResponse): any => ({ ...obj, }); @@ -4710,6 +5106,9 @@ export interface UpdateApiMappingRequest { } export namespace UpdateApiMappingRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateApiMappingRequest): any => ({ ...obj, }); @@ -4738,6 +5137,9 @@ export interface UpdateApiMappingResponse { } export namespace UpdateApiMappingResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateApiMappingResponse): any => ({ ...obj, }); @@ -4810,6 +5212,9 @@ export interface UpdateAuthorizerRequest { } export namespace UpdateAuthorizerRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateAuthorizerRequest): any => ({ ...obj, }); @@ -4874,6 +5279,9 @@ export interface UpdateAuthorizerResponse { } export namespace UpdateAuthorizerResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateAuthorizerResponse): any => ({ ...obj, }); @@ -4900,6 +5308,9 @@ export interface UpdateDeploymentRequest { } export namespace UpdateDeploymentRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateDeploymentRequest): any => ({ ...obj, }); @@ -4938,6 +5349,9 @@ export interface UpdateDeploymentResponse { } export namespace UpdateDeploymentResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateDeploymentResponse): any => ({ ...obj, }); @@ -4964,6 +5378,9 @@ export interface UpdateDomainNameRequest { } export namespace UpdateDomainNameRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateDomainNameRequest): any => ({ ...obj, }); @@ -4997,6 +5414,9 @@ export interface UpdateDomainNameResponse { } export namespace UpdateDomainNameResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateDomainNameResponse): any => ({ ...obj, }); @@ -5108,6 +5528,9 @@ export interface UpdateIntegrationRequest { } export namespace UpdateIntegrationRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateIntegrationRequest): any => ({ ...obj, }); @@ -5221,6 +5644,9 @@ export interface UpdateIntegrationResult { } export namespace UpdateIntegrationResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateIntegrationResult): any => ({ ...obj, }); @@ -5279,6 +5705,9 @@ export interface UpdateIntegrationResponseRequest { } export namespace UpdateIntegrationResponseRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateIntegrationResponseRequest): any => ({ ...obj, }); @@ -5317,6 +5746,9 @@ export interface UpdateIntegrationResponseResponse { } export namespace UpdateIntegrationResponseResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateIntegrationResponseResponse): any => ({ ...obj, }); @@ -5358,6 +5790,9 @@ export interface UpdateModelRequest { } export namespace UpdateModelRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateModelRequest): any => ({ ...obj, }); @@ -5391,6 +5826,9 @@ export interface UpdateModelResponse { } export namespace UpdateModelResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateModelResponse): any => ({ ...obj, }); @@ -5467,6 +5905,9 @@ export interface UpdateRouteRequest { } export namespace UpdateRouteRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateRouteRequest): any => ({ ...obj, }); @@ -5540,6 +5981,9 @@ export interface UpdateRouteResult { } export namespace UpdateRouteResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateRouteResult): any => ({ ...obj, }); @@ -5586,6 +6030,9 @@ export interface UpdateRouteResponseRequest { } export namespace UpdateRouteResponseRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateRouteResponseRequest): any => ({ ...obj, }); @@ -5619,6 +6066,9 @@ export interface UpdateRouteResponseResponse { } export namespace UpdateRouteResponseResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateRouteResponseResponse): any => ({ ...obj, }); @@ -5680,6 +6130,9 @@ export interface UpdateStageRequest { } export namespace UpdateStageRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateStageRequest): any => ({ ...obj, }); @@ -5758,6 +6211,9 @@ export interface UpdateStageResponse { } export namespace UpdateStageResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateStageResponse): any => ({ ...obj, }); @@ -5779,6 +6235,9 @@ export interface UpdateVpcLinkRequest { } export namespace UpdateVpcLinkRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateVpcLinkRequest): any => ({ ...obj, }); @@ -5832,6 +6291,9 @@ export interface UpdateVpcLinkResponse { } export namespace UpdateVpcLinkResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateVpcLinkResponse): any => ({ ...obj, }); diff --git a/clients/client-app-mesh/commands/CreateGatewayRouteCommand.ts b/clients/client-app-mesh/commands/CreateGatewayRouteCommand.ts index ff55e9d4f90e..dd1d0cb904f7 100644 --- a/clients/client-app-mesh/commands/CreateGatewayRouteCommand.ts +++ b/clients/client-app-mesh/commands/CreateGatewayRouteCommand.ts @@ -26,6 +26,20 @@ export interface CreateGatewayRouteCommandOutput extends CreateGatewayRouteOutpu * 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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { AppMeshClient, CreateGatewayRouteCommand } from "@aws-sdk/client-app-mesh"; // ES Modules import + * // const { AppMeshClient, CreateGatewayRouteCommand } = require("@aws-sdk/client-app-mesh"); // CommonJS import + * const client = new AppMeshClient(config); + * const command = new CreateGatewayRouteCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreateGatewayRouteCommandInput} for command's `input` shape. + * @see {@link CreateGatewayRouteCommandOutput} for command's `response` shape. + * @see {@link AppMeshClientResolvedConfig | config} for command's `input` shape. + * */ export class CreateGatewayRouteCommand extends $Command< CreateGatewayRouteCommandInput, diff --git a/clients/client-app-mesh/commands/CreateMeshCommand.ts b/clients/client-app-mesh/commands/CreateMeshCommand.ts index a5e5debde7d5..ba77807b2825 100644 --- a/clients/client-app-mesh/commands/CreateMeshCommand.ts +++ b/clients/client-app-mesh/commands/CreateMeshCommand.ts @@ -27,6 +27,20 @@ export interface CreateMeshCommandOutput extends CreateMeshOutput, __MetadataBea * 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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { AppMeshClient, CreateMeshCommand } from "@aws-sdk/client-app-mesh"; // ES Modules import + * // const { AppMeshClient, CreateMeshCommand } = require("@aws-sdk/client-app-mesh"); // CommonJS import + * const client = new AppMeshClient(config); + * const command = new CreateMeshCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreateMeshCommandInput} for command's `input` shape. + * @see {@link CreateMeshCommandOutput} for command's `response` shape. + * @see {@link AppMeshClientResolvedConfig | config} for command's `input` shape. + * */ export class CreateMeshCommand extends $Command< CreateMeshCommandInput, diff --git a/clients/client-app-mesh/commands/CreateRouteCommand.ts b/clients/client-app-mesh/commands/CreateRouteCommand.ts index b06d962a730c..58203a7d5c07 100644 --- a/clients/client-app-mesh/commands/CreateRouteCommand.ts +++ b/clients/client-app-mesh/commands/CreateRouteCommand.ts @@ -25,6 +25,20 @@ export interface CreateRouteCommandOutput extends CreateRouteOutput, __MetadataB *

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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { AppMeshClient, CreateRouteCommand } from "@aws-sdk/client-app-mesh"; // ES Modules import + * // const { AppMeshClient, CreateRouteCommand } = require("@aws-sdk/client-app-mesh"); // CommonJS import + * const client = new AppMeshClient(config); + * const command = new CreateRouteCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreateRouteCommandInput} for command's `input` shape. + * @see {@link CreateRouteCommandOutput} for command's `response` shape. + * @see {@link AppMeshClientResolvedConfig | config} for command's `input` shape. + * */ export class CreateRouteCommand extends $Command< CreateRouteCommandInput, diff --git a/clients/client-app-mesh/commands/CreateVirtualGatewayCommand.ts b/clients/client-app-mesh/commands/CreateVirtualGatewayCommand.ts index 6322263bcbd2..4979672f1735 100644 --- a/clients/client-app-mesh/commands/CreateVirtualGatewayCommand.ts +++ b/clients/client-app-mesh/commands/CreateVirtualGatewayCommand.ts @@ -28,6 +28,20 @@ export interface CreateVirtualGatewayCommandOutput extends CreateVirtualGatewayO * represents an Envoy running with an application, a virtual gateway represents Envoy * deployed by itself.

*

For more information about virtual gateways, see Virtual gateways.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { AppMeshClient, CreateVirtualGatewayCommand } from "@aws-sdk/client-app-mesh"; // ES Modules import + * // const { AppMeshClient, CreateVirtualGatewayCommand } = require("@aws-sdk/client-app-mesh"); // CommonJS import + * const client = new AppMeshClient(config); + * const command = new CreateVirtualGatewayCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreateVirtualGatewayCommandInput} for command's `input` shape. + * @see {@link CreateVirtualGatewayCommandOutput} for command's `response` shape. + * @see {@link AppMeshClientResolvedConfig | config} for command's `input` shape. + * */ export class CreateVirtualGatewayCommand extends $Command< CreateVirtualGatewayCommandInput, diff --git a/clients/client-app-mesh/commands/CreateVirtualNodeCommand.ts b/clients/client-app-mesh/commands/CreateVirtualNodeCommand.ts index 3eed39c9019a..569c2f590c48 100644 --- a/clients/client-app-mesh/commands/CreateVirtualNodeCommand.ts +++ b/clients/client-app-mesh/commands/CreateVirtualNodeCommand.ts @@ -45,6 +45,20 @@ export interface CreateVirtualNodeCommandOutput extends CreateVirtualNodeOutput, *

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 about App Mesh Envoy variables, see Envoy image in * the AWS App Mesh User Guide.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { AppMeshClient, CreateVirtualNodeCommand } from "@aws-sdk/client-app-mesh"; // ES Modules import + * // const { AppMeshClient, CreateVirtualNodeCommand } = require("@aws-sdk/client-app-mesh"); // CommonJS import + * const client = new AppMeshClient(config); + * const command = new CreateVirtualNodeCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreateVirtualNodeCommandInput} for command's `input` shape. + * @see {@link CreateVirtualNodeCommandOutput} for command's `response` shape. + * @see {@link AppMeshClientResolvedConfig | config} for command's `input` shape. + * */ export class CreateVirtualNodeCommand extends $Command< CreateVirtualNodeCommandInput, diff --git a/clients/client-app-mesh/commands/CreateVirtualRouterCommand.ts b/clients/client-app-mesh/commands/CreateVirtualRouterCommand.ts index b367684bdf0d..4796d8560abf 100644 --- a/clients/client-app-mesh/commands/CreateVirtualRouterCommand.ts +++ b/clients/client-app-mesh/commands/CreateVirtualRouterCommand.ts @@ -28,6 +28,20 @@ export interface CreateVirtualRouterCommandOutput extends CreateVirtualRouterOut * 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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { AppMeshClient, CreateVirtualRouterCommand } from "@aws-sdk/client-app-mesh"; // ES Modules import + * // const { AppMeshClient, CreateVirtualRouterCommand } = require("@aws-sdk/client-app-mesh"); // CommonJS import + * const client = new AppMeshClient(config); + * const command = new CreateVirtualRouterCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreateVirtualRouterCommandInput} for command's `input` shape. + * @see {@link CreateVirtualRouterCommandOutput} for command's `response` shape. + * @see {@link AppMeshClientResolvedConfig | config} for command's `input` shape. + * */ export class CreateVirtualRouterCommand extends $Command< CreateVirtualRouterCommandInput, diff --git a/clients/client-app-mesh/commands/CreateVirtualServiceCommand.ts b/clients/client-app-mesh/commands/CreateVirtualServiceCommand.ts index 7b218e04239e..1306d2af32e9 100644 --- a/clients/client-app-mesh/commands/CreateVirtualServiceCommand.ts +++ b/clients/client-app-mesh/commands/CreateVirtualServiceCommand.ts @@ -28,6 +28,20 @@ export interface CreateVirtualServiceCommandOutput extends CreateVirtualServiceO * virtual node or virtual router that is specified as the provider for the virtual * service.

*

For more information about virtual services, see Virtual services.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { AppMeshClient, CreateVirtualServiceCommand } from "@aws-sdk/client-app-mesh"; // ES Modules import + * // const { AppMeshClient, CreateVirtualServiceCommand } = require("@aws-sdk/client-app-mesh"); // CommonJS import + * const client = new AppMeshClient(config); + * const command = new CreateVirtualServiceCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreateVirtualServiceCommandInput} for command's `input` shape. + * @see {@link CreateVirtualServiceCommandOutput} for command's `response` shape. + * @see {@link AppMeshClientResolvedConfig | config} for command's `input` shape. + * */ export class CreateVirtualServiceCommand extends $Command< CreateVirtualServiceCommandInput, diff --git a/clients/client-app-mesh/commands/DeleteGatewayRouteCommand.ts b/clients/client-app-mesh/commands/DeleteGatewayRouteCommand.ts index 4a1af147d60f..7242d4586647 100644 --- a/clients/client-app-mesh/commands/DeleteGatewayRouteCommand.ts +++ b/clients/client-app-mesh/commands/DeleteGatewayRouteCommand.ts @@ -22,6 +22,20 @@ export interface DeleteGatewayRouteCommandOutput extends DeleteGatewayRouteOutpu /** *

Deletes an existing gateway route.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { AppMeshClient, DeleteGatewayRouteCommand } from "@aws-sdk/client-app-mesh"; // ES Modules import + * // const { AppMeshClient, DeleteGatewayRouteCommand } = require("@aws-sdk/client-app-mesh"); // CommonJS import + * const client = new AppMeshClient(config); + * const command = new DeleteGatewayRouteCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteGatewayRouteCommandInput} for command's `input` shape. + * @see {@link DeleteGatewayRouteCommandOutput} for command's `response` shape. + * @see {@link AppMeshClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteGatewayRouteCommand extends $Command< DeleteGatewayRouteCommandInput, diff --git a/clients/client-app-mesh/commands/DeleteMeshCommand.ts b/clients/client-app-mesh/commands/DeleteMeshCommand.ts index d3b88dba3bb4..3034243a5f55 100644 --- a/clients/client-app-mesh/commands/DeleteMeshCommand.ts +++ b/clients/client-app-mesh/commands/DeleteMeshCommand.ts @@ -24,6 +24,20 @@ export interface DeleteMeshCommandOutput extends DeleteMeshOutput, __MetadataBea *

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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { AppMeshClient, DeleteMeshCommand } from "@aws-sdk/client-app-mesh"; // ES Modules import + * // const { AppMeshClient, DeleteMeshCommand } = require("@aws-sdk/client-app-mesh"); // CommonJS import + * const client = new AppMeshClient(config); + * const command = new DeleteMeshCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteMeshCommandInput} for command's `input` shape. + * @see {@link DeleteMeshCommandOutput} for command's `response` shape. + * @see {@link AppMeshClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteMeshCommand extends $Command< DeleteMeshCommandInput, diff --git a/clients/client-app-mesh/commands/DeleteRouteCommand.ts b/clients/client-app-mesh/commands/DeleteRouteCommand.ts index aae1b0eb74ea..ef350433f9ef 100644 --- a/clients/client-app-mesh/commands/DeleteRouteCommand.ts +++ b/clients/client-app-mesh/commands/DeleteRouteCommand.ts @@ -22,6 +22,20 @@ export interface DeleteRouteCommandOutput extends DeleteRouteOutput, __MetadataB /** *

Deletes an existing route.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { AppMeshClient, DeleteRouteCommand } from "@aws-sdk/client-app-mesh"; // ES Modules import + * // const { AppMeshClient, DeleteRouteCommand } = require("@aws-sdk/client-app-mesh"); // CommonJS import + * const client = new AppMeshClient(config); + * const command = new DeleteRouteCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteRouteCommandInput} for command's `input` shape. + * @see {@link DeleteRouteCommandOutput} for command's `response` shape. + * @see {@link AppMeshClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteRouteCommand extends $Command< DeleteRouteCommandInput, diff --git a/clients/client-app-mesh/commands/DeleteVirtualGatewayCommand.ts b/clients/client-app-mesh/commands/DeleteVirtualGatewayCommand.ts index 3d8e22133a48..73f7973e862f 100644 --- a/clients/client-app-mesh/commands/DeleteVirtualGatewayCommand.ts +++ b/clients/client-app-mesh/commands/DeleteVirtualGatewayCommand.ts @@ -23,6 +23,20 @@ export interface DeleteVirtualGatewayCommandOutput extends DeleteVirtualGatewayO /** *

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

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { AppMeshClient, DeleteVirtualGatewayCommand } from "@aws-sdk/client-app-mesh"; // ES Modules import + * // const { AppMeshClient, DeleteVirtualGatewayCommand } = require("@aws-sdk/client-app-mesh"); // CommonJS import + * const client = new AppMeshClient(config); + * const command = new DeleteVirtualGatewayCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteVirtualGatewayCommandInput} for command's `input` shape. + * @see {@link DeleteVirtualGatewayCommandOutput} for command's `response` shape. + * @see {@link AppMeshClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteVirtualGatewayCommand extends $Command< DeleteVirtualGatewayCommandInput, diff --git a/clients/client-app-mesh/commands/DeleteVirtualNodeCommand.ts b/clients/client-app-mesh/commands/DeleteVirtualNodeCommand.ts index 0b860f8c0468..f843db162597 100644 --- a/clients/client-app-mesh/commands/DeleteVirtualNodeCommand.ts +++ b/clients/client-app-mesh/commands/DeleteVirtualNodeCommand.ts @@ -24,6 +24,20 @@ export interface DeleteVirtualNodeCommandOutput extends DeleteVirtualNodeOutput, *

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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { AppMeshClient, DeleteVirtualNodeCommand } from "@aws-sdk/client-app-mesh"; // ES Modules import + * // const { AppMeshClient, DeleteVirtualNodeCommand } = require("@aws-sdk/client-app-mesh"); // CommonJS import + * const client = new AppMeshClient(config); + * const command = new DeleteVirtualNodeCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteVirtualNodeCommandInput} for command's `input` shape. + * @see {@link DeleteVirtualNodeCommandOutput} for command's `response` shape. + * @see {@link AppMeshClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteVirtualNodeCommand extends $Command< DeleteVirtualNodeCommandInput, diff --git a/clients/client-app-mesh/commands/DeleteVirtualRouterCommand.ts b/clients/client-app-mesh/commands/DeleteVirtualRouterCommand.ts index 8fedc6502711..f70788bc19a5 100644 --- a/clients/client-app-mesh/commands/DeleteVirtualRouterCommand.ts +++ b/clients/client-app-mesh/commands/DeleteVirtualRouterCommand.ts @@ -24,6 +24,20 @@ export interface DeleteVirtualRouterCommandOutput extends DeleteVirtualRouterOut *

Deletes an existing virtual router.

*

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

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { AppMeshClient, DeleteVirtualRouterCommand } from "@aws-sdk/client-app-mesh"; // ES Modules import + * // const { AppMeshClient, DeleteVirtualRouterCommand } = require("@aws-sdk/client-app-mesh"); // CommonJS import + * const client = new AppMeshClient(config); + * const command = new DeleteVirtualRouterCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteVirtualRouterCommandInput} for command's `input` shape. + * @see {@link DeleteVirtualRouterCommandOutput} for command's `response` shape. + * @see {@link AppMeshClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteVirtualRouterCommand extends $Command< DeleteVirtualRouterCommandInput, diff --git a/clients/client-app-mesh/commands/DeleteVirtualServiceCommand.ts b/clients/client-app-mesh/commands/DeleteVirtualServiceCommand.ts index 0830b578dc72..eff4ccc55e00 100644 --- a/clients/client-app-mesh/commands/DeleteVirtualServiceCommand.ts +++ b/clients/client-app-mesh/commands/DeleteVirtualServiceCommand.ts @@ -22,6 +22,20 @@ export interface DeleteVirtualServiceCommandOutput extends DeleteVirtualServiceO /** *

Deletes an existing virtual service.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { AppMeshClient, DeleteVirtualServiceCommand } from "@aws-sdk/client-app-mesh"; // ES Modules import + * // const { AppMeshClient, DeleteVirtualServiceCommand } = require("@aws-sdk/client-app-mesh"); // CommonJS import + * const client = new AppMeshClient(config); + * const command = new DeleteVirtualServiceCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteVirtualServiceCommandInput} for command's `input` shape. + * @see {@link DeleteVirtualServiceCommandOutput} for command's `response` shape. + * @see {@link AppMeshClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteVirtualServiceCommand extends $Command< DeleteVirtualServiceCommandInput, diff --git a/clients/client-app-mesh/commands/DescribeGatewayRouteCommand.ts b/clients/client-app-mesh/commands/DescribeGatewayRouteCommand.ts index 26fdb3102fca..4fbfa2bd58c1 100644 --- a/clients/client-app-mesh/commands/DescribeGatewayRouteCommand.ts +++ b/clients/client-app-mesh/commands/DescribeGatewayRouteCommand.ts @@ -22,6 +22,20 @@ export interface DescribeGatewayRouteCommandOutput extends DescribeGatewayRouteO /** *

Describes an existing gateway route.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { AppMeshClient, DescribeGatewayRouteCommand } from "@aws-sdk/client-app-mesh"; // ES Modules import + * // const { AppMeshClient, DescribeGatewayRouteCommand } = require("@aws-sdk/client-app-mesh"); // CommonJS import + * const client = new AppMeshClient(config); + * const command = new DescribeGatewayRouteCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeGatewayRouteCommandInput} for command's `input` shape. + * @see {@link DescribeGatewayRouteCommandOutput} for command's `response` shape. + * @see {@link AppMeshClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeGatewayRouteCommand extends $Command< DescribeGatewayRouteCommandInput, diff --git a/clients/client-app-mesh/commands/DescribeMeshCommand.ts b/clients/client-app-mesh/commands/DescribeMeshCommand.ts index b37c8618703e..3e7cc0623e5d 100644 --- a/clients/client-app-mesh/commands/DescribeMeshCommand.ts +++ b/clients/client-app-mesh/commands/DescribeMeshCommand.ts @@ -22,6 +22,20 @@ export interface DescribeMeshCommandOutput extends DescribeMeshOutput, __Metadat /** *

Describes an existing service mesh.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { AppMeshClient, DescribeMeshCommand } from "@aws-sdk/client-app-mesh"; // ES Modules import + * // const { AppMeshClient, DescribeMeshCommand } = require("@aws-sdk/client-app-mesh"); // CommonJS import + * const client = new AppMeshClient(config); + * const command = new DescribeMeshCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeMeshCommandInput} for command's `input` shape. + * @see {@link DescribeMeshCommandOutput} for command's `response` shape. + * @see {@link AppMeshClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeMeshCommand extends $Command< DescribeMeshCommandInput, diff --git a/clients/client-app-mesh/commands/DescribeRouteCommand.ts b/clients/client-app-mesh/commands/DescribeRouteCommand.ts index de964557f6ae..b7ace5baaeb6 100644 --- a/clients/client-app-mesh/commands/DescribeRouteCommand.ts +++ b/clients/client-app-mesh/commands/DescribeRouteCommand.ts @@ -22,6 +22,20 @@ export interface DescribeRouteCommandOutput extends DescribeRouteOutput, __Metad /** *

Describes an existing route.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { AppMeshClient, DescribeRouteCommand } from "@aws-sdk/client-app-mesh"; // ES Modules import + * // const { AppMeshClient, DescribeRouteCommand } = require("@aws-sdk/client-app-mesh"); // CommonJS import + * const client = new AppMeshClient(config); + * const command = new DescribeRouteCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeRouteCommandInput} for command's `input` shape. + * @see {@link DescribeRouteCommandOutput} for command's `response` shape. + * @see {@link AppMeshClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeRouteCommand extends $Command< DescribeRouteCommandInput, diff --git a/clients/client-app-mesh/commands/DescribeVirtualGatewayCommand.ts b/clients/client-app-mesh/commands/DescribeVirtualGatewayCommand.ts index 49be96bed14b..80993c45df04 100644 --- a/clients/client-app-mesh/commands/DescribeVirtualGatewayCommand.ts +++ b/clients/client-app-mesh/commands/DescribeVirtualGatewayCommand.ts @@ -22,6 +22,20 @@ export interface DescribeVirtualGatewayCommandOutput extends DescribeVirtualGate /** *

Describes an existing virtual gateway.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { AppMeshClient, DescribeVirtualGatewayCommand } from "@aws-sdk/client-app-mesh"; // ES Modules import + * // const { AppMeshClient, DescribeVirtualGatewayCommand } = require("@aws-sdk/client-app-mesh"); // CommonJS import + * const client = new AppMeshClient(config); + * const command = new DescribeVirtualGatewayCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeVirtualGatewayCommandInput} for command's `input` shape. + * @see {@link DescribeVirtualGatewayCommandOutput} for command's `response` shape. + * @see {@link AppMeshClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeVirtualGatewayCommand extends $Command< DescribeVirtualGatewayCommandInput, diff --git a/clients/client-app-mesh/commands/DescribeVirtualNodeCommand.ts b/clients/client-app-mesh/commands/DescribeVirtualNodeCommand.ts index 536b5974233c..6fa89b27856d 100644 --- a/clients/client-app-mesh/commands/DescribeVirtualNodeCommand.ts +++ b/clients/client-app-mesh/commands/DescribeVirtualNodeCommand.ts @@ -22,6 +22,20 @@ export interface DescribeVirtualNodeCommandOutput extends DescribeVirtualNodeOut /** *

Describes an existing virtual node.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { AppMeshClient, DescribeVirtualNodeCommand } from "@aws-sdk/client-app-mesh"; // ES Modules import + * // const { AppMeshClient, DescribeVirtualNodeCommand } = require("@aws-sdk/client-app-mesh"); // CommonJS import + * const client = new AppMeshClient(config); + * const command = new DescribeVirtualNodeCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeVirtualNodeCommandInput} for command's `input` shape. + * @see {@link DescribeVirtualNodeCommandOutput} for command's `response` shape. + * @see {@link AppMeshClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeVirtualNodeCommand extends $Command< DescribeVirtualNodeCommandInput, diff --git a/clients/client-app-mesh/commands/DescribeVirtualRouterCommand.ts b/clients/client-app-mesh/commands/DescribeVirtualRouterCommand.ts index 833742f77413..27616267e09b 100644 --- a/clients/client-app-mesh/commands/DescribeVirtualRouterCommand.ts +++ b/clients/client-app-mesh/commands/DescribeVirtualRouterCommand.ts @@ -22,6 +22,20 @@ export interface DescribeVirtualRouterCommandOutput extends DescribeVirtualRoute /** *

Describes an existing virtual router.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { AppMeshClient, DescribeVirtualRouterCommand } from "@aws-sdk/client-app-mesh"; // ES Modules import + * // const { AppMeshClient, DescribeVirtualRouterCommand } = require("@aws-sdk/client-app-mesh"); // CommonJS import + * const client = new AppMeshClient(config); + * const command = new DescribeVirtualRouterCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeVirtualRouterCommandInput} for command's `input` shape. + * @see {@link DescribeVirtualRouterCommandOutput} for command's `response` shape. + * @see {@link AppMeshClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeVirtualRouterCommand extends $Command< DescribeVirtualRouterCommandInput, diff --git a/clients/client-app-mesh/commands/DescribeVirtualServiceCommand.ts b/clients/client-app-mesh/commands/DescribeVirtualServiceCommand.ts index f08caf495c1e..945e71be1d04 100644 --- a/clients/client-app-mesh/commands/DescribeVirtualServiceCommand.ts +++ b/clients/client-app-mesh/commands/DescribeVirtualServiceCommand.ts @@ -22,6 +22,20 @@ export interface DescribeVirtualServiceCommandOutput extends DescribeVirtualServ /** *

Describes an existing virtual service.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { AppMeshClient, DescribeVirtualServiceCommand } from "@aws-sdk/client-app-mesh"; // ES Modules import + * // const { AppMeshClient, DescribeVirtualServiceCommand } = require("@aws-sdk/client-app-mesh"); // CommonJS import + * const client = new AppMeshClient(config); + * const command = new DescribeVirtualServiceCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeVirtualServiceCommandInput} for command's `input` shape. + * @see {@link DescribeVirtualServiceCommandOutput} for command's `response` shape. + * @see {@link AppMeshClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeVirtualServiceCommand extends $Command< DescribeVirtualServiceCommandInput, diff --git a/clients/client-app-mesh/commands/ListGatewayRoutesCommand.ts b/clients/client-app-mesh/commands/ListGatewayRoutesCommand.ts index efaf2ec1e56e..bb6aa6fccaf4 100644 --- a/clients/client-app-mesh/commands/ListGatewayRoutesCommand.ts +++ b/clients/client-app-mesh/commands/ListGatewayRoutesCommand.ts @@ -23,6 +23,20 @@ export interface ListGatewayRoutesCommandOutput extends ListGatewayRoutesOutput, /** *

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

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { AppMeshClient, ListGatewayRoutesCommand } from "@aws-sdk/client-app-mesh"; // ES Modules import + * // const { AppMeshClient, ListGatewayRoutesCommand } = require("@aws-sdk/client-app-mesh"); // CommonJS import + * const client = new AppMeshClient(config); + * const command = new ListGatewayRoutesCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListGatewayRoutesCommandInput} for command's `input` shape. + * @see {@link ListGatewayRoutesCommandOutput} for command's `response` shape. + * @see {@link AppMeshClientResolvedConfig | config} for command's `input` shape. + * */ export class ListGatewayRoutesCommand extends $Command< ListGatewayRoutesCommandInput, diff --git a/clients/client-app-mesh/commands/ListMeshesCommand.ts b/clients/client-app-mesh/commands/ListMeshesCommand.ts index dd3645daa11c..8be93e46f420 100644 --- a/clients/client-app-mesh/commands/ListMeshesCommand.ts +++ b/clients/client-app-mesh/commands/ListMeshesCommand.ts @@ -22,6 +22,20 @@ export interface ListMeshesCommandOutput extends ListMeshesOutput, __MetadataBea /** *

Returns a list of existing service meshes.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { AppMeshClient, ListMeshesCommand } from "@aws-sdk/client-app-mesh"; // ES Modules import + * // const { AppMeshClient, ListMeshesCommand } = require("@aws-sdk/client-app-mesh"); // CommonJS import + * const client = new AppMeshClient(config); + * const command = new ListMeshesCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListMeshesCommandInput} for command's `input` shape. + * @see {@link ListMeshesCommandOutput} for command's `response` shape. + * @see {@link AppMeshClientResolvedConfig | config} for command's `input` shape. + * */ export class ListMeshesCommand extends $Command< ListMeshesCommandInput, diff --git a/clients/client-app-mesh/commands/ListRoutesCommand.ts b/clients/client-app-mesh/commands/ListRoutesCommand.ts index e4d9b9fe68f2..54edf14ea314 100644 --- a/clients/client-app-mesh/commands/ListRoutesCommand.ts +++ b/clients/client-app-mesh/commands/ListRoutesCommand.ts @@ -22,6 +22,20 @@ export interface ListRoutesCommandOutput extends ListRoutesOutput, __MetadataBea /** *

Returns a list of existing routes in a service mesh.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { AppMeshClient, ListRoutesCommand } from "@aws-sdk/client-app-mesh"; // ES Modules import + * // const { AppMeshClient, ListRoutesCommand } = require("@aws-sdk/client-app-mesh"); // CommonJS import + * const client = new AppMeshClient(config); + * const command = new ListRoutesCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListRoutesCommandInput} for command's `input` shape. + * @see {@link ListRoutesCommandOutput} for command's `response` shape. + * @see {@link AppMeshClientResolvedConfig | config} for command's `input` shape. + * */ export class ListRoutesCommand extends $Command< ListRoutesCommandInput, diff --git a/clients/client-app-mesh/commands/ListTagsForResourceCommand.ts b/clients/client-app-mesh/commands/ListTagsForResourceCommand.ts index 4250bc26b88b..8323950a90ed 100644 --- a/clients/client-app-mesh/commands/ListTagsForResourceCommand.ts +++ b/clients/client-app-mesh/commands/ListTagsForResourceCommand.ts @@ -22,6 +22,20 @@ export interface ListTagsForResourceCommandOutput extends ListTagsForResourceOut /** *

List the tags for an App Mesh resource.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { AppMeshClient, ListTagsForResourceCommand } from "@aws-sdk/client-app-mesh"; // ES Modules import + * // const { AppMeshClient, ListTagsForResourceCommand } = require("@aws-sdk/client-app-mesh"); // CommonJS import + * const client = new AppMeshClient(config); + * const command = new ListTagsForResourceCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListTagsForResourceCommandInput} for command's `input` shape. + * @see {@link ListTagsForResourceCommandOutput} for command's `response` shape. + * @see {@link AppMeshClientResolvedConfig | config} for command's `input` shape. + * */ export class ListTagsForResourceCommand extends $Command< ListTagsForResourceCommandInput, diff --git a/clients/client-app-mesh/commands/ListVirtualGatewaysCommand.ts b/clients/client-app-mesh/commands/ListVirtualGatewaysCommand.ts index 058701c67794..0003b8edb2d4 100644 --- a/clients/client-app-mesh/commands/ListVirtualGatewaysCommand.ts +++ b/clients/client-app-mesh/commands/ListVirtualGatewaysCommand.ts @@ -22,6 +22,20 @@ export interface ListVirtualGatewaysCommandOutput extends ListVirtualGatewaysOut /** *

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

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { AppMeshClient, ListVirtualGatewaysCommand } from "@aws-sdk/client-app-mesh"; // ES Modules import + * // const { AppMeshClient, ListVirtualGatewaysCommand } = require("@aws-sdk/client-app-mesh"); // CommonJS import + * const client = new AppMeshClient(config); + * const command = new ListVirtualGatewaysCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListVirtualGatewaysCommandInput} for command's `input` shape. + * @see {@link ListVirtualGatewaysCommandOutput} for command's `response` shape. + * @see {@link AppMeshClientResolvedConfig | config} for command's `input` shape. + * */ export class ListVirtualGatewaysCommand extends $Command< ListVirtualGatewaysCommandInput, diff --git a/clients/client-app-mesh/commands/ListVirtualNodesCommand.ts b/clients/client-app-mesh/commands/ListVirtualNodesCommand.ts index a719188ef019..72111e25aa64 100644 --- a/clients/client-app-mesh/commands/ListVirtualNodesCommand.ts +++ b/clients/client-app-mesh/commands/ListVirtualNodesCommand.ts @@ -22,6 +22,20 @@ export interface ListVirtualNodesCommandOutput extends ListVirtualNodesOutput, _ /** *

Returns a list of existing virtual nodes.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { AppMeshClient, ListVirtualNodesCommand } from "@aws-sdk/client-app-mesh"; // ES Modules import + * // const { AppMeshClient, ListVirtualNodesCommand } = require("@aws-sdk/client-app-mesh"); // CommonJS import + * const client = new AppMeshClient(config); + * const command = new ListVirtualNodesCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListVirtualNodesCommandInput} for command's `input` shape. + * @see {@link ListVirtualNodesCommandOutput} for command's `response` shape. + * @see {@link AppMeshClientResolvedConfig | config} for command's `input` shape. + * */ export class ListVirtualNodesCommand extends $Command< ListVirtualNodesCommandInput, diff --git a/clients/client-app-mesh/commands/ListVirtualRoutersCommand.ts b/clients/client-app-mesh/commands/ListVirtualRoutersCommand.ts index 0f480816d3df..e719cd06b553 100644 --- a/clients/client-app-mesh/commands/ListVirtualRoutersCommand.ts +++ b/clients/client-app-mesh/commands/ListVirtualRoutersCommand.ts @@ -22,6 +22,20 @@ export interface ListVirtualRoutersCommandOutput extends ListVirtualRoutersOutpu /** *

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

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { AppMeshClient, ListVirtualRoutersCommand } from "@aws-sdk/client-app-mesh"; // ES Modules import + * // const { AppMeshClient, ListVirtualRoutersCommand } = require("@aws-sdk/client-app-mesh"); // CommonJS import + * const client = new AppMeshClient(config); + * const command = new ListVirtualRoutersCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListVirtualRoutersCommandInput} for command's `input` shape. + * @see {@link ListVirtualRoutersCommandOutput} for command's `response` shape. + * @see {@link AppMeshClientResolvedConfig | config} for command's `input` shape. + * */ export class ListVirtualRoutersCommand extends $Command< ListVirtualRoutersCommandInput, diff --git a/clients/client-app-mesh/commands/ListVirtualServicesCommand.ts b/clients/client-app-mesh/commands/ListVirtualServicesCommand.ts index 4b529f2cce88..9af6c6b1ed78 100644 --- a/clients/client-app-mesh/commands/ListVirtualServicesCommand.ts +++ b/clients/client-app-mesh/commands/ListVirtualServicesCommand.ts @@ -22,6 +22,20 @@ export interface ListVirtualServicesCommandOutput extends ListVirtualServicesOut /** *

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

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { AppMeshClient, ListVirtualServicesCommand } from "@aws-sdk/client-app-mesh"; // ES Modules import + * // const { AppMeshClient, ListVirtualServicesCommand } = require("@aws-sdk/client-app-mesh"); // CommonJS import + * const client = new AppMeshClient(config); + * const command = new ListVirtualServicesCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListVirtualServicesCommandInput} for command's `input` shape. + * @see {@link ListVirtualServicesCommandOutput} for command's `response` shape. + * @see {@link AppMeshClientResolvedConfig | config} for command's `input` shape. + * */ export class ListVirtualServicesCommand extends $Command< ListVirtualServicesCommandInput, diff --git a/clients/client-app-mesh/commands/TagResourceCommand.ts b/clients/client-app-mesh/commands/TagResourceCommand.ts index 6f7ea05a0c82..97d4a14398ee 100644 --- a/clients/client-app-mesh/commands/TagResourceCommand.ts +++ b/clients/client-app-mesh/commands/TagResourceCommand.ts @@ -25,6 +25,20 @@ export interface TagResourceCommandOutput extends TagResourceOutput, __MetadataB * 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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { AppMeshClient, TagResourceCommand } from "@aws-sdk/client-app-mesh"; // ES Modules import + * // const { AppMeshClient, TagResourceCommand } = require("@aws-sdk/client-app-mesh"); // CommonJS import + * const client = new AppMeshClient(config); + * const command = new TagResourceCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link TagResourceCommandInput} for command's `input` shape. + * @see {@link TagResourceCommandOutput} for command's `response` shape. + * @see {@link AppMeshClientResolvedConfig | config} for command's `input` shape. + * */ export class TagResourceCommand extends $Command< TagResourceCommandInput, diff --git a/clients/client-app-mesh/commands/UntagResourceCommand.ts b/clients/client-app-mesh/commands/UntagResourceCommand.ts index 192a30475831..ef239a14e517 100644 --- a/clients/client-app-mesh/commands/UntagResourceCommand.ts +++ b/clients/client-app-mesh/commands/UntagResourceCommand.ts @@ -22,6 +22,20 @@ export interface UntagResourceCommandOutput extends UntagResourceOutput, __Metad /** *

Deletes specified tags from a resource.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { AppMeshClient, UntagResourceCommand } from "@aws-sdk/client-app-mesh"; // ES Modules import + * // const { AppMeshClient, UntagResourceCommand } = require("@aws-sdk/client-app-mesh"); // CommonJS import + * const client = new AppMeshClient(config); + * const command = new UntagResourceCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link UntagResourceCommandInput} for command's `input` shape. + * @see {@link UntagResourceCommandOutput} for command's `response` shape. + * @see {@link AppMeshClientResolvedConfig | config} for command's `input` shape. + * */ export class UntagResourceCommand extends $Command< UntagResourceCommandInput, diff --git a/clients/client-app-mesh/commands/UpdateGatewayRouteCommand.ts b/clients/client-app-mesh/commands/UpdateGatewayRouteCommand.ts index 9b6b940ea3c6..5be9c36dc0cf 100644 --- a/clients/client-app-mesh/commands/UpdateGatewayRouteCommand.ts +++ b/clients/client-app-mesh/commands/UpdateGatewayRouteCommand.ts @@ -23,6 +23,20 @@ export interface UpdateGatewayRouteCommandOutput extends UpdateGatewayRouteOutpu /** *

Updates an existing gateway route that is associated to a specified virtual gateway in a * service mesh.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { AppMeshClient, UpdateGatewayRouteCommand } from "@aws-sdk/client-app-mesh"; // ES Modules import + * // const { AppMeshClient, UpdateGatewayRouteCommand } = require("@aws-sdk/client-app-mesh"); // CommonJS import + * const client = new AppMeshClient(config); + * const command = new UpdateGatewayRouteCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link UpdateGatewayRouteCommandInput} for command's `input` shape. + * @see {@link UpdateGatewayRouteCommandOutput} for command's `response` shape. + * @see {@link AppMeshClientResolvedConfig | config} for command's `input` shape. + * */ export class UpdateGatewayRouteCommand extends $Command< UpdateGatewayRouteCommandInput, diff --git a/clients/client-app-mesh/commands/UpdateMeshCommand.ts b/clients/client-app-mesh/commands/UpdateMeshCommand.ts index 2ee917c64d26..aaf65a2404b7 100644 --- a/clients/client-app-mesh/commands/UpdateMeshCommand.ts +++ b/clients/client-app-mesh/commands/UpdateMeshCommand.ts @@ -22,6 +22,20 @@ export interface UpdateMeshCommandOutput extends UpdateMeshOutput, __MetadataBea /** *

Updates an existing service mesh.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { AppMeshClient, UpdateMeshCommand } from "@aws-sdk/client-app-mesh"; // ES Modules import + * // const { AppMeshClient, UpdateMeshCommand } = require("@aws-sdk/client-app-mesh"); // CommonJS import + * const client = new AppMeshClient(config); + * const command = new UpdateMeshCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link UpdateMeshCommandInput} for command's `input` shape. + * @see {@link UpdateMeshCommandOutput} for command's `response` shape. + * @see {@link AppMeshClientResolvedConfig | config} for command's `input` shape. + * */ export class UpdateMeshCommand extends $Command< UpdateMeshCommandInput, diff --git a/clients/client-app-mesh/commands/UpdateRouteCommand.ts b/clients/client-app-mesh/commands/UpdateRouteCommand.ts index 3fda03dcb89b..2ae1aa046e7c 100644 --- a/clients/client-app-mesh/commands/UpdateRouteCommand.ts +++ b/clients/client-app-mesh/commands/UpdateRouteCommand.ts @@ -22,6 +22,20 @@ export interface UpdateRouteCommandOutput extends UpdateRouteOutput, __MetadataB /** *

Updates an existing route for a specified service mesh and virtual router.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { AppMeshClient, UpdateRouteCommand } from "@aws-sdk/client-app-mesh"; // ES Modules import + * // const { AppMeshClient, UpdateRouteCommand } = require("@aws-sdk/client-app-mesh"); // CommonJS import + * const client = new AppMeshClient(config); + * const command = new UpdateRouteCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link UpdateRouteCommandInput} for command's `input` shape. + * @see {@link UpdateRouteCommandOutput} for command's `response` shape. + * @see {@link AppMeshClientResolvedConfig | config} for command's `input` shape. + * */ export class UpdateRouteCommand extends $Command< UpdateRouteCommandInput, diff --git a/clients/client-app-mesh/commands/UpdateVirtualGatewayCommand.ts b/clients/client-app-mesh/commands/UpdateVirtualGatewayCommand.ts index f8875380eb57..1a5438427aff 100644 --- a/clients/client-app-mesh/commands/UpdateVirtualGatewayCommand.ts +++ b/clients/client-app-mesh/commands/UpdateVirtualGatewayCommand.ts @@ -22,6 +22,20 @@ export interface UpdateVirtualGatewayCommandOutput extends UpdateVirtualGatewayO /** *

Updates an existing virtual gateway in a specified service mesh.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { AppMeshClient, UpdateVirtualGatewayCommand } from "@aws-sdk/client-app-mesh"; // ES Modules import + * // const { AppMeshClient, UpdateVirtualGatewayCommand } = require("@aws-sdk/client-app-mesh"); // CommonJS import + * const client = new AppMeshClient(config); + * const command = new UpdateVirtualGatewayCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link UpdateVirtualGatewayCommandInput} for command's `input` shape. + * @see {@link UpdateVirtualGatewayCommandOutput} for command's `response` shape. + * @see {@link AppMeshClientResolvedConfig | config} for command's `input` shape. + * */ export class UpdateVirtualGatewayCommand extends $Command< UpdateVirtualGatewayCommandInput, diff --git a/clients/client-app-mesh/commands/UpdateVirtualNodeCommand.ts b/clients/client-app-mesh/commands/UpdateVirtualNodeCommand.ts index 7b5d336241ca..f62bcbf57c78 100644 --- a/clients/client-app-mesh/commands/UpdateVirtualNodeCommand.ts +++ b/clients/client-app-mesh/commands/UpdateVirtualNodeCommand.ts @@ -22,6 +22,20 @@ export interface UpdateVirtualNodeCommandOutput extends UpdateVirtualNodeOutput, /** *

Updates an existing virtual node in a specified service mesh.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { AppMeshClient, UpdateVirtualNodeCommand } from "@aws-sdk/client-app-mesh"; // ES Modules import + * // const { AppMeshClient, UpdateVirtualNodeCommand } = require("@aws-sdk/client-app-mesh"); // CommonJS import + * const client = new AppMeshClient(config); + * const command = new UpdateVirtualNodeCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link UpdateVirtualNodeCommandInput} for command's `input` shape. + * @see {@link UpdateVirtualNodeCommandOutput} for command's `response` shape. + * @see {@link AppMeshClientResolvedConfig | config} for command's `input` shape. + * */ export class UpdateVirtualNodeCommand extends $Command< UpdateVirtualNodeCommandInput, diff --git a/clients/client-app-mesh/commands/UpdateVirtualRouterCommand.ts b/clients/client-app-mesh/commands/UpdateVirtualRouterCommand.ts index 8e67ca197ec8..271a2c7fe134 100644 --- a/clients/client-app-mesh/commands/UpdateVirtualRouterCommand.ts +++ b/clients/client-app-mesh/commands/UpdateVirtualRouterCommand.ts @@ -22,6 +22,20 @@ export interface UpdateVirtualRouterCommandOutput extends UpdateVirtualRouterOut /** *

Updates an existing virtual router in a specified service mesh.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { AppMeshClient, UpdateVirtualRouterCommand } from "@aws-sdk/client-app-mesh"; // ES Modules import + * // const { AppMeshClient, UpdateVirtualRouterCommand } = require("@aws-sdk/client-app-mesh"); // CommonJS import + * const client = new AppMeshClient(config); + * const command = new UpdateVirtualRouterCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link UpdateVirtualRouterCommandInput} for command's `input` shape. + * @see {@link UpdateVirtualRouterCommandOutput} for command's `response` shape. + * @see {@link AppMeshClientResolvedConfig | config} for command's `input` shape. + * */ export class UpdateVirtualRouterCommand extends $Command< UpdateVirtualRouterCommandInput, diff --git a/clients/client-app-mesh/commands/UpdateVirtualServiceCommand.ts b/clients/client-app-mesh/commands/UpdateVirtualServiceCommand.ts index 77af2a8c4ad3..0ac1a4140c31 100644 --- a/clients/client-app-mesh/commands/UpdateVirtualServiceCommand.ts +++ b/clients/client-app-mesh/commands/UpdateVirtualServiceCommand.ts @@ -22,6 +22,20 @@ export interface UpdateVirtualServiceCommandOutput extends UpdateVirtualServiceO /** *

Updates an existing virtual service in a specified service mesh.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { AppMeshClient, UpdateVirtualServiceCommand } from "@aws-sdk/client-app-mesh"; // ES Modules import + * // const { AppMeshClient, UpdateVirtualServiceCommand } = require("@aws-sdk/client-app-mesh"); // CommonJS import + * const client = new AppMeshClient(config); + * const command = new UpdateVirtualServiceCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link UpdateVirtualServiceCommandInput} for command's `input` shape. + * @see {@link UpdateVirtualServiceCommandOutput} for command's `response` shape. + * @see {@link AppMeshClientResolvedConfig | config} for command's `input` shape. + * */ export class UpdateVirtualServiceCommand extends $Command< UpdateVirtualServiceCommandInput, diff --git a/clients/client-app-mesh/models/models_0.ts b/clients/client-app-mesh/models/models_0.ts index ba33048d41ac..384fc8514a38 100644 --- a/clients/client-app-mesh/models/models_0.ts +++ b/clients/client-app-mesh/models/models_0.ts @@ -20,6 +20,9 @@ export interface FileAccessLog { } export namespace FileAccessLog { + /** + * @internal + */ export const filterSensitiveLog = (obj: FileAccessLog): any => ({ ...obj, }); @@ -54,6 +57,9 @@ export namespace AccessLog { return visitor._(value.$unknown[0], value.$unknown[1]); }; + /** + * @internal + */ export const filterSensitiveLog = (obj: AccessLog): any => { if (obj.file !== undefined) return { file: FileAccessLog.filterSensitiveLog(obj.file) }; if (obj.$unknown !== undefined) return { [obj.$unknown[0]]: "UNKNOWN" }; @@ -70,6 +76,9 @@ export interface BadRequestException extends __SmithyException, $MetadataBearer } export namespace BadRequestException { + /** + * @internal + */ export const filterSensitiveLog = (obj: BadRequestException): any => ({ ...obj, }); @@ -85,6 +94,9 @@ export interface ForbiddenException extends __SmithyException, $MetadataBearer { } export namespace ForbiddenException { + /** + * @internal + */ export const filterSensitiveLog = (obj: ForbiddenException): any => ({ ...obj, }); @@ -102,6 +114,9 @@ export interface InternalServerErrorException extends __SmithyException, $Metada } export namespace InternalServerErrorException { + /** + * @internal + */ export const filterSensitiveLog = (obj: InternalServerErrorException): any => ({ ...obj, }); @@ -138,6 +153,9 @@ export interface ListTagsForResourceInput { } export namespace ListTagsForResourceInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListTagsForResourceInput): any => ({ ...obj, }); @@ -164,6 +182,9 @@ export interface TagRef { } export namespace TagRef { + /** + * @internal + */ export const filterSensitiveLog = (obj: TagRef): any => ({ ...obj, }); @@ -188,6 +209,9 @@ export interface ListTagsForResourceOutput { } export namespace ListTagsForResourceOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListTagsForResourceOutput): any => ({ ...obj, }); @@ -203,6 +227,9 @@ export interface NotFoundException extends __SmithyException, $MetadataBearer { } export namespace NotFoundException { + /** + * @internal + */ export const filterSensitiveLog = (obj: NotFoundException): any => ({ ...obj, }); @@ -219,6 +246,9 @@ export interface ServiceUnavailableException extends __SmithyException, $Metadat } export namespace ServiceUnavailableException { + /** + * @internal + */ export const filterSensitiveLog = (obj: ServiceUnavailableException): any => ({ ...obj, }); @@ -239,6 +269,9 @@ export interface TooManyRequestsException extends __SmithyException, $MetadataBe } export namespace TooManyRequestsException { + /** + * @internal + */ export const filterSensitiveLog = (obj: TooManyRequestsException): any => ({ ...obj, }); @@ -255,6 +288,9 @@ export interface ConflictException extends __SmithyException, $MetadataBearer { } export namespace ConflictException { + /** + * @internal + */ export const filterSensitiveLog = (obj: ConflictException): any => ({ ...obj, }); @@ -280,6 +316,9 @@ export interface EgressFilter { } export namespace EgressFilter { + /** + * @internal + */ export const filterSensitiveLog = (obj: EgressFilter): any => ({ ...obj, }); @@ -296,6 +335,9 @@ export interface MeshSpec { } export namespace MeshSpec { + /** + * @internal + */ export const filterSensitiveLog = (obj: MeshSpec): any => ({ ...obj, }); @@ -331,6 +373,9 @@ export interface CreateMeshInput { } export namespace CreateMeshInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateMeshInput): any => ({ ...obj, }); @@ -379,6 +424,9 @@ export interface ResourceMetadata { } export namespace ResourceMetadata { + /** + * @internal + */ export const filterSensitiveLog = (obj: ResourceMetadata): any => ({ ...obj, }); @@ -401,6 +449,9 @@ export interface MeshStatus { } export namespace MeshStatus { + /** + * @internal + */ export const filterSensitiveLog = (obj: MeshStatus): any => ({ ...obj, }); @@ -432,6 +483,9 @@ export interface MeshData { } export namespace MeshData { + /** + * @internal + */ export const filterSensitiveLog = (obj: MeshData): any => ({ ...obj, }); @@ -448,6 +502,9 @@ export interface CreateMeshOutput { } export namespace CreateMeshOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateMeshOutput): any => ({ ...obj, }); @@ -464,6 +521,9 @@ export interface LimitExceededException extends __SmithyException, $MetadataBear } export namespace LimitExceededException { + /** + * @internal + */ export const filterSensitiveLog = (obj: LimitExceededException): any => ({ ...obj, }); @@ -480,6 +540,9 @@ export interface DeleteMeshInput { } export namespace DeleteMeshInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteMeshInput): any => ({ ...obj, }); @@ -496,6 +559,9 @@ export interface DeleteMeshOutput { } export namespace DeleteMeshOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteMeshOutput): any => ({ ...obj, }); @@ -512,6 +578,9 @@ export interface ResourceInUseException extends __SmithyException, $MetadataBear } export namespace ResourceInUseException { + /** + * @internal + */ export const filterSensitiveLog = (obj: ResourceInUseException): any => ({ ...obj, }); @@ -534,6 +603,9 @@ export interface DescribeMeshInput { } export namespace DescribeMeshInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeMeshInput): any => ({ ...obj, }); @@ -550,6 +622,9 @@ export interface DescribeMeshOutput { } export namespace DescribeMeshOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeMeshOutput): any => ({ ...obj, }); @@ -585,6 +660,9 @@ export interface ListMeshesInput { } export namespace ListMeshesInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListMeshesInput): any => ({ ...obj, }); @@ -633,6 +711,9 @@ export interface MeshRef { } export namespace MeshRef { + /** + * @internal + */ export const filterSensitiveLog = (obj: MeshRef): any => ({ ...obj, }); @@ -657,6 +738,9 @@ export interface ListMeshesOutput { } export namespace ListMeshesOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListMeshesOutput): any => ({ ...obj, }); @@ -684,6 +768,9 @@ export interface UpdateMeshInput { } export namespace UpdateMeshInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateMeshInput): any => ({ ...obj, }); @@ -700,6 +787,9 @@ export interface UpdateMeshOutput { } export namespace UpdateMeshOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateMeshOutput): any => ({ ...obj, }); @@ -723,6 +813,9 @@ export interface VirtualGatewayListenerTlsFileCertificate { } export namespace VirtualGatewayListenerTlsFileCertificate { + /** + * @internal + */ export const filterSensitiveLog = (obj: VirtualGatewayListenerTlsFileCertificate): any => ({ ...obj, }); @@ -744,6 +837,9 @@ export interface VirtualGatewayListenerTlsSdsCertificate { } export namespace VirtualGatewayListenerTlsSdsCertificate { + /** + * @internal + */ export const filterSensitiveLog = (obj: VirtualGatewayListenerTlsSdsCertificate): any => ({ ...obj, }); @@ -796,6 +892,9 @@ export namespace VirtualGatewayClientTlsCertificate { return visitor._(value.$unknown[0], value.$unknown[1]); }; + /** + * @internal + */ export const filterSensitiveLog = (obj: VirtualGatewayClientTlsCertificate): any => { if (obj.file !== undefined) return { file: VirtualGatewayListenerTlsFileCertificate.filterSensitiveLog(obj.file) }; if (obj.sds !== undefined) return { sds: VirtualGatewayListenerTlsSdsCertificate.filterSensitiveLog(obj.sds) }; @@ -815,6 +914,9 @@ export interface SubjectAlternativeNameMatchers { } export namespace SubjectAlternativeNameMatchers { + /** + * @internal + */ export const filterSensitiveLog = (obj: SubjectAlternativeNameMatchers): any => ({ ...obj, }); @@ -832,6 +934,9 @@ export interface SubjectAlternativeNames { } export namespace SubjectAlternativeNames { + /** + * @internal + */ export const filterSensitiveLog = (obj: SubjectAlternativeNames): any => ({ ...obj, }); @@ -849,6 +954,9 @@ export interface VirtualGatewayTlsValidationContextAcmTrust { } export namespace VirtualGatewayTlsValidationContextAcmTrust { + /** + * @internal + */ export const filterSensitiveLog = (obj: VirtualGatewayTlsValidationContextAcmTrust): any => ({ ...obj, }); @@ -866,6 +974,9 @@ export interface VirtualGatewayTlsValidationContextFileTrust { } export namespace VirtualGatewayTlsValidationContextFileTrust { + /** + * @internal + */ export const filterSensitiveLog = (obj: VirtualGatewayTlsValidationContextFileTrust): any => ({ ...obj, }); @@ -886,6 +997,9 @@ export interface VirtualGatewayTlsValidationContextSdsTrust { } export namespace VirtualGatewayTlsValidationContextSdsTrust { + /** + * @internal + */ export const filterSensitiveLog = (obj: VirtualGatewayTlsValidationContextSdsTrust): any => ({ ...obj, }); @@ -954,6 +1068,9 @@ export namespace VirtualGatewayTlsValidationContextTrust { return visitor._(value.$unknown[0], value.$unknown[1]); }; + /** + * @internal + */ export const filterSensitiveLog = (obj: VirtualGatewayTlsValidationContextTrust): any => { if (obj.acm !== undefined) return { acm: VirtualGatewayTlsValidationContextAcmTrust.filterSensitiveLog(obj.acm) }; if (obj.file !== undefined) @@ -981,6 +1098,9 @@ export interface VirtualGatewayTlsValidationContext { } export namespace VirtualGatewayTlsValidationContext { + /** + * @internal + */ export const filterSensitiveLog = (obj: VirtualGatewayTlsValidationContext): any => ({ ...obj, ...(obj.trust && { trust: VirtualGatewayTlsValidationContextTrust.filterSensitiveLog(obj.trust) }), @@ -1015,6 +1135,9 @@ export interface VirtualGatewayClientPolicyTls { } export namespace VirtualGatewayClientPolicyTls { + /** + * @internal + */ export const filterSensitiveLog = (obj: VirtualGatewayClientPolicyTls): any => ({ ...obj, ...(obj.certificate && { certificate: VirtualGatewayClientTlsCertificate.filterSensitiveLog(obj.certificate) }), @@ -1033,6 +1156,9 @@ export interface VirtualGatewayClientPolicy { } export namespace VirtualGatewayClientPolicy { + /** + * @internal + */ export const filterSensitiveLog = (obj: VirtualGatewayClientPolicy): any => ({ ...obj, ...(obj.tls && { tls: VirtualGatewayClientPolicyTls.filterSensitiveLog(obj.tls) }), @@ -1050,6 +1176,9 @@ export interface VirtualGatewayBackendDefaults { } export namespace VirtualGatewayBackendDefaults { + /** + * @internal + */ export const filterSensitiveLog = (obj: VirtualGatewayBackendDefaults): any => ({ ...obj, ...(obj.clientPolicy && { clientPolicy: VirtualGatewayClientPolicy.filterSensitiveLog(obj.clientPolicy) }), @@ -1068,6 +1197,9 @@ export interface VirtualGatewayGrpcConnectionPool { } export namespace VirtualGatewayGrpcConnectionPool { + /** + * @internal + */ export const filterSensitiveLog = (obj: VirtualGatewayGrpcConnectionPool): any => ({ ...obj, }); @@ -1091,6 +1223,9 @@ export interface VirtualGatewayHttpConnectionPool { } export namespace VirtualGatewayHttpConnectionPool { + /** + * @internal + */ export const filterSensitiveLog = (obj: VirtualGatewayHttpConnectionPool): any => ({ ...obj, }); @@ -1108,6 +1243,9 @@ export interface VirtualGatewayHttp2ConnectionPool { } export namespace VirtualGatewayHttp2ConnectionPool { + /** + * @internal + */ export const filterSensitiveLog = (obj: VirtualGatewayHttp2ConnectionPool): any => ({ ...obj, }); @@ -1178,6 +1316,9 @@ export namespace VirtualGatewayConnectionPool { return visitor._(value.$unknown[0], value.$unknown[1]); }; + /** + * @internal + */ export const filterSensitiveLog = (obj: VirtualGatewayConnectionPool): any => { if (obj.http !== undefined) return { http: VirtualGatewayHttpConnectionPool.filterSensitiveLog(obj.http) }; if (obj.http2 !== undefined) return { http2: VirtualGatewayHttp2ConnectionPool.filterSensitiveLog(obj.http2) }; @@ -1241,6 +1382,9 @@ export interface VirtualGatewayHealthCheckPolicy { } export namespace VirtualGatewayHealthCheckPolicy { + /** + * @internal + */ export const filterSensitiveLog = (obj: VirtualGatewayHealthCheckPolicy): any => ({ ...obj, }); @@ -1262,6 +1406,9 @@ export interface VirtualGatewayPortMapping { } export namespace VirtualGatewayPortMapping { + /** + * @internal + */ export const filterSensitiveLog = (obj: VirtualGatewayPortMapping): any => ({ ...obj, }); @@ -1278,6 +1425,9 @@ export interface VirtualGatewayListenerTlsAcmCertificate { } export namespace VirtualGatewayListenerTlsAcmCertificate { + /** + * @internal + */ export const filterSensitiveLog = (obj: VirtualGatewayListenerTlsAcmCertificate): any => ({ ...obj, }); @@ -1345,6 +1495,9 @@ export namespace VirtualGatewayListenerTlsCertificate { return visitor._(value.$unknown[0], value.$unknown[1]); }; + /** + * @internal + */ export const filterSensitiveLog = (obj: VirtualGatewayListenerTlsCertificate): any => { if (obj.acm !== undefined) return { acm: VirtualGatewayListenerTlsAcmCertificate.filterSensitiveLog(obj.acm) }; if (obj.file !== undefined) return { file: VirtualGatewayListenerTlsFileCertificate.filterSensitiveLog(obj.file) }; @@ -1406,6 +1559,9 @@ export namespace VirtualGatewayListenerTlsValidationContextTrust { return visitor._(value.$unknown[0], value.$unknown[1]); }; + /** + * @internal + */ export const filterSensitiveLog = (obj: VirtualGatewayListenerTlsValidationContextTrust): any => { if (obj.file !== undefined) return { file: VirtualGatewayTlsValidationContextFileTrust.filterSensitiveLog(obj.file) }; @@ -1433,6 +1589,9 @@ export interface VirtualGatewayListenerTlsValidationContext { } export namespace VirtualGatewayListenerTlsValidationContext { + /** + * @internal + */ export const filterSensitiveLog = (obj: VirtualGatewayListenerTlsValidationContext): any => ({ ...obj, ...(obj.trust && { trust: VirtualGatewayListenerTlsValidationContextTrust.filterSensitiveLog(obj.trust) }), @@ -1478,6 +1637,9 @@ export interface VirtualGatewayListenerTls { } export namespace VirtualGatewayListenerTls { + /** + * @internal + */ export const filterSensitiveLog = (obj: VirtualGatewayListenerTls): any => ({ ...obj, ...(obj.validation && { @@ -1513,6 +1675,9 @@ export interface VirtualGatewayListener { } export namespace VirtualGatewayListener { + /** + * @internal + */ export const filterSensitiveLog = (obj: VirtualGatewayListener): any => ({ ...obj, ...(obj.tls && { tls: VirtualGatewayListenerTls.filterSensitiveLog(obj.tls) }), @@ -1535,6 +1700,9 @@ export interface VirtualGatewayFileAccessLog { } export namespace VirtualGatewayFileAccessLog { + /** + * @internal + */ export const filterSensitiveLog = (obj: VirtualGatewayFileAccessLog): any => ({ ...obj, }); @@ -1569,6 +1737,9 @@ export namespace VirtualGatewayAccessLog { return visitor._(value.$unknown[0], value.$unknown[1]); }; + /** + * @internal + */ export const filterSensitiveLog = (obj: VirtualGatewayAccessLog): any => { if (obj.file !== undefined) return { file: VirtualGatewayFileAccessLog.filterSensitiveLog(obj.file) }; if (obj.$unknown !== undefined) return { [obj.$unknown[0]]: "UNKNOWN" }; @@ -1586,6 +1757,9 @@ export interface VirtualGatewayLogging { } export namespace VirtualGatewayLogging { + /** + * @internal + */ export const filterSensitiveLog = (obj: VirtualGatewayLogging): any => ({ ...obj, ...(obj.accessLog && { accessLog: VirtualGatewayAccessLog.filterSensitiveLog(obj.accessLog) }), @@ -1614,6 +1788,9 @@ export interface VirtualGatewaySpec { } export namespace VirtualGatewaySpec { + /** + * @internal + */ export const filterSensitiveLog = (obj: VirtualGatewaySpec): any => ({ ...obj, ...(obj.backendDefaults && { @@ -1663,6 +1840,9 @@ export interface CreateVirtualGatewayInput { } export namespace CreateVirtualGatewayInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateVirtualGatewayInput): any => ({ ...obj, ...(obj.spec && { spec: VirtualGatewaySpec.filterSensitiveLog(obj.spec) }), @@ -1686,6 +1866,9 @@ export interface VirtualGatewayStatus { } export namespace VirtualGatewayStatus { + /** + * @internal + */ export const filterSensitiveLog = (obj: VirtualGatewayStatus): any => ({ ...obj, }); @@ -1722,6 +1905,9 @@ export interface VirtualGatewayData { } export namespace VirtualGatewayData { + /** + * @internal + */ export const filterSensitiveLog = (obj: VirtualGatewayData): any => ({ ...obj, ...(obj.spec && { spec: VirtualGatewaySpec.filterSensitiveLog(obj.spec) }), @@ -1736,6 +1922,9 @@ export interface CreateVirtualGatewayOutput { } export namespace CreateVirtualGatewayOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateVirtualGatewayOutput): any => ({ ...obj, ...(obj.virtualGateway && { virtualGateway: VirtualGatewayData.filterSensitiveLog(obj.virtualGateway) }), @@ -1761,6 +1950,9 @@ export interface DeleteVirtualGatewayInput { } export namespace DeleteVirtualGatewayInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteVirtualGatewayInput): any => ({ ...obj, }); @@ -1774,6 +1966,9 @@ export interface DeleteVirtualGatewayOutput { } export namespace DeleteVirtualGatewayOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteVirtualGatewayOutput): any => ({ ...obj, ...(obj.virtualGateway && { virtualGateway: VirtualGatewayData.filterSensitiveLog(obj.virtualGateway) }), @@ -1799,6 +1994,9 @@ export interface DescribeVirtualGatewayInput { } export namespace DescribeVirtualGatewayInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeVirtualGatewayInput): any => ({ ...obj, }); @@ -1812,6 +2010,9 @@ export interface DescribeVirtualGatewayOutput { } export namespace DescribeVirtualGatewayOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeVirtualGatewayOutput): any => ({ ...obj, ...(obj.virtualGateway && { virtualGateway: VirtualGatewayData.filterSensitiveLog(obj.virtualGateway) }), @@ -1829,6 +2030,9 @@ export interface GatewayRouteVirtualService { } export namespace GatewayRouteVirtualService { + /** + * @internal + */ export const filterSensitiveLog = (obj: GatewayRouteVirtualService): any => ({ ...obj, }); @@ -1845,6 +2049,9 @@ export interface GatewayRouteTarget { } export namespace GatewayRouteTarget { + /** + * @internal + */ export const filterSensitiveLog = (obj: GatewayRouteTarget): any => ({ ...obj, }); @@ -1861,6 +2068,9 @@ export interface GrpcGatewayRouteAction { } export namespace GrpcGatewayRouteAction { + /** + * @internal + */ export const filterSensitiveLog = (obj: GrpcGatewayRouteAction): any => ({ ...obj, }); @@ -1877,6 +2087,9 @@ export interface GrpcGatewayRouteMatch { } export namespace GrpcGatewayRouteMatch { + /** + * @internal + */ export const filterSensitiveLog = (obj: GrpcGatewayRouteMatch): any => ({ ...obj, }); @@ -1898,6 +2111,9 @@ export interface GrpcGatewayRoute { } export namespace GrpcGatewayRoute { + /** + * @internal + */ export const filterSensitiveLog = (obj: GrpcGatewayRoute): any => ({ ...obj, }); @@ -1914,6 +2130,9 @@ export interface HttpGatewayRouteAction { } export namespace HttpGatewayRouteAction { + /** + * @internal + */ export const filterSensitiveLog = (obj: HttpGatewayRouteAction): any => ({ ...obj, }); @@ -1935,6 +2154,9 @@ export interface HttpGatewayRouteMatch { } export namespace HttpGatewayRouteMatch { + /** + * @internal + */ export const filterSensitiveLog = (obj: HttpGatewayRouteMatch): any => ({ ...obj, }); @@ -1956,6 +2178,9 @@ export interface HttpGatewayRoute { } export namespace HttpGatewayRoute { + /** + * @internal + */ export const filterSensitiveLog = (obj: HttpGatewayRoute): any => ({ ...obj, }); @@ -1983,6 +2208,9 @@ export interface GatewayRouteSpec { } export namespace GatewayRouteSpec { + /** + * @internal + */ export const filterSensitiveLog = (obj: GatewayRouteSpec): any => ({ ...obj, }); @@ -2034,6 +2262,9 @@ export interface CreateGatewayRouteInput { } export namespace CreateGatewayRouteInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateGatewayRouteInput): any => ({ ...obj, }); @@ -2056,6 +2287,9 @@ export interface GatewayRouteStatus { } export namespace GatewayRouteStatus { + /** + * @internal + */ export const filterSensitiveLog = (obj: GatewayRouteStatus): any => ({ ...obj, }); @@ -2097,6 +2331,9 @@ export interface GatewayRouteData { } export namespace GatewayRouteData { + /** + * @internal + */ export const filterSensitiveLog = (obj: GatewayRouteData): any => ({ ...obj, }); @@ -2110,6 +2347,9 @@ export interface CreateGatewayRouteOutput { } export namespace CreateGatewayRouteOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateGatewayRouteOutput): any => ({ ...obj, }); @@ -2139,6 +2379,9 @@ export interface DeleteGatewayRouteInput { } export namespace DeleteGatewayRouteInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteGatewayRouteInput): any => ({ ...obj, }); @@ -2152,6 +2395,9 @@ export interface DeleteGatewayRouteOutput { } export namespace DeleteGatewayRouteOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteGatewayRouteOutput): any => ({ ...obj, }); @@ -2181,6 +2427,9 @@ export interface DescribeGatewayRouteInput { } export namespace DescribeGatewayRouteInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeGatewayRouteInput): any => ({ ...obj, }); @@ -2194,6 +2443,9 @@ export interface DescribeGatewayRouteOutput { } export namespace DescribeGatewayRouteOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeGatewayRouteOutput): any => ({ ...obj, }); @@ -2238,6 +2490,9 @@ export interface ListGatewayRoutesInput { } export namespace ListGatewayRoutesInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListGatewayRoutesInput): any => ({ ...obj, }); @@ -2296,6 +2551,9 @@ export interface GatewayRouteRef { } export namespace GatewayRouteRef { + /** + * @internal + */ export const filterSensitiveLog = (obj: GatewayRouteRef): any => ({ ...obj, }); @@ -2318,6 +2576,9 @@ export interface ListGatewayRoutesOutput { } export namespace ListGatewayRoutesOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListGatewayRoutesOutput): any => ({ ...obj, }); @@ -2358,6 +2619,9 @@ export interface UpdateGatewayRouteInput { } export namespace UpdateGatewayRouteInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateGatewayRouteInput): any => ({ ...obj, }); @@ -2371,6 +2635,9 @@ export interface UpdateGatewayRouteOutput { } export namespace UpdateGatewayRouteOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateGatewayRouteOutput): any => ({ ...obj, }); @@ -2410,6 +2677,9 @@ export interface ListVirtualGatewaysInput { } export namespace ListVirtualGatewaysInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListVirtualGatewaysInput): any => ({ ...obj, }); @@ -2463,6 +2733,9 @@ export interface VirtualGatewayRef { } export namespace VirtualGatewayRef { + /** + * @internal + */ export const filterSensitiveLog = (obj: VirtualGatewayRef): any => ({ ...obj, }); @@ -2484,6 +2757,9 @@ export interface ListVirtualGatewaysOutput { } export namespace ListVirtualGatewaysOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListVirtualGatewaysOutput): any => ({ ...obj, }); @@ -2520,6 +2796,9 @@ export interface UpdateVirtualGatewayInput { } export namespace UpdateVirtualGatewayInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateVirtualGatewayInput): any => ({ ...obj, ...(obj.spec && { spec: VirtualGatewaySpec.filterSensitiveLog(obj.spec) }), @@ -2534,6 +2813,9 @@ export interface UpdateVirtualGatewayOutput { } export namespace UpdateVirtualGatewayOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateVirtualGatewayOutput): any => ({ ...obj, ...(obj.virtualGateway && { virtualGateway: VirtualGatewayData.filterSensitiveLog(obj.virtualGateway) }), @@ -2558,6 +2840,9 @@ export interface ListenerTlsFileCertificate { } export namespace ListenerTlsFileCertificate { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListenerTlsFileCertificate): any => ({ ...obj, }); @@ -2578,6 +2863,9 @@ export interface ListenerTlsSdsCertificate { } export namespace ListenerTlsSdsCertificate { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListenerTlsSdsCertificate): any => ({ ...obj, }); @@ -2630,6 +2918,9 @@ export namespace ClientTlsCertificate { return visitor._(value.$unknown[0], value.$unknown[1]); }; + /** + * @internal + */ export const filterSensitiveLog = (obj: ClientTlsCertificate): any => { if (obj.file !== undefined) return { file: ListenerTlsFileCertificate.filterSensitiveLog(obj.file) }; if (obj.sds !== undefined) return { sds: ListenerTlsSdsCertificate.filterSensitiveLog(obj.sds) }; @@ -2649,6 +2940,9 @@ export interface TlsValidationContextAcmTrust { } export namespace TlsValidationContextAcmTrust { + /** + * @internal + */ export const filterSensitiveLog = (obj: TlsValidationContextAcmTrust): any => ({ ...obj, }); @@ -2666,6 +2960,9 @@ export interface TlsValidationContextFileTrust { } export namespace TlsValidationContextFileTrust { + /** + * @internal + */ export const filterSensitiveLog = (obj: TlsValidationContextFileTrust): any => ({ ...obj, }); @@ -2686,6 +2983,9 @@ export interface TlsValidationContextSdsTrust { } export namespace TlsValidationContextSdsTrust { + /** + * @internal + */ export const filterSensitiveLog = (obj: TlsValidationContextSdsTrust): any => ({ ...obj, }); @@ -2754,6 +3054,9 @@ export namespace TlsValidationContextTrust { return visitor._(value.$unknown[0], value.$unknown[1]); }; + /** + * @internal + */ export const filterSensitiveLog = (obj: TlsValidationContextTrust): any => { if (obj.acm !== undefined) return { acm: TlsValidationContextAcmTrust.filterSensitiveLog(obj.acm) }; if (obj.file !== undefined) return { file: TlsValidationContextFileTrust.filterSensitiveLog(obj.file) }; @@ -2780,6 +3083,9 @@ export interface TlsValidationContext { } export namespace TlsValidationContext { + /** + * @internal + */ export const filterSensitiveLog = (obj: TlsValidationContext): any => ({ ...obj, ...(obj.trust && { trust: TlsValidationContextTrust.filterSensitiveLog(obj.trust) }), @@ -2812,6 +3118,9 @@ export interface ClientPolicyTls { } export namespace ClientPolicyTls { + /** + * @internal + */ export const filterSensitiveLog = (obj: ClientPolicyTls): any => ({ ...obj, ...(obj.certificate && { certificate: ClientTlsCertificate.filterSensitiveLog(obj.certificate) }), @@ -2830,6 +3139,9 @@ export interface ClientPolicy { } export namespace ClientPolicy { + /** + * @internal + */ export const filterSensitiveLog = (obj: ClientPolicy): any => ({ ...obj, ...(obj.tls && { tls: ClientPolicyTls.filterSensitiveLog(obj.tls) }), @@ -2847,6 +3159,9 @@ export interface BackendDefaults { } export namespace BackendDefaults { + /** + * @internal + */ export const filterSensitiveLog = (obj: BackendDefaults): any => ({ ...obj, ...(obj.clientPolicy && { clientPolicy: ClientPolicy.filterSensitiveLog(obj.clientPolicy) }), @@ -2869,6 +3184,9 @@ export interface VirtualServiceBackend { } export namespace VirtualServiceBackend { + /** + * @internal + */ export const filterSensitiveLog = (obj: VirtualServiceBackend): any => ({ ...obj, ...(obj.clientPolicy && { clientPolicy: ClientPolicy.filterSensitiveLog(obj.clientPolicy) }), @@ -2905,6 +3223,9 @@ export namespace Backend { return visitor._(value.$unknown[0], value.$unknown[1]); }; + /** + * @internal + */ export const filterSensitiveLog = (obj: Backend): any => { if (obj.virtualService !== undefined) return { virtualService: VirtualServiceBackend.filterSensitiveLog(obj.virtualService) }; @@ -2924,6 +3245,9 @@ export interface VirtualNodeGrpcConnectionPool { } export namespace VirtualNodeGrpcConnectionPool { + /** + * @internal + */ export const filterSensitiveLog = (obj: VirtualNodeGrpcConnectionPool): any => ({ ...obj, }); @@ -2947,6 +3271,9 @@ export interface VirtualNodeHttpConnectionPool { } export namespace VirtualNodeHttpConnectionPool { + /** + * @internal + */ export const filterSensitiveLog = (obj: VirtualNodeHttpConnectionPool): any => ({ ...obj, }); @@ -2964,6 +3291,9 @@ export interface VirtualNodeHttp2ConnectionPool { } export namespace VirtualNodeHttp2ConnectionPool { + /** + * @internal + */ export const filterSensitiveLog = (obj: VirtualNodeHttp2ConnectionPool): any => ({ ...obj, }); @@ -2981,6 +3311,9 @@ export interface VirtualNodeTcpConnectionPool { } export namespace VirtualNodeTcpConnectionPool { + /** + * @internal + */ export const filterSensitiveLog = (obj: VirtualNodeTcpConnectionPool): any => ({ ...obj, }); @@ -3070,6 +3403,9 @@ export namespace VirtualNodeConnectionPool { return visitor._(value.$unknown[0], value.$unknown[1]); }; + /** + * @internal + */ export const filterSensitiveLog = (obj: VirtualNodeConnectionPool): any => { if (obj.tcp !== undefined) return { tcp: VirtualNodeTcpConnectionPool.filterSensitiveLog(obj.tcp) }; if (obj.http !== undefined) return { http: VirtualNodeHttpConnectionPool.filterSensitiveLog(obj.http) }; @@ -3134,6 +3470,9 @@ export interface HealthCheckPolicy { } export namespace HealthCheckPolicy { + /** + * @internal + */ export const filterSensitiveLog = (obj: HealthCheckPolicy): any => ({ ...obj, }); @@ -3160,6 +3499,9 @@ export interface Duration { } export namespace Duration { + /** + * @internal + */ export const filterSensitiveLog = (obj: Duration): any => ({ ...obj, }); @@ -3192,6 +3534,9 @@ export interface OutlierDetection { } export namespace OutlierDetection { + /** + * @internal + */ export const filterSensitiveLog = (obj: OutlierDetection): any => ({ ...obj, }); @@ -3213,6 +3558,9 @@ export interface PortMapping { } export namespace PortMapping { + /** + * @internal + */ export const filterSensitiveLog = (obj: PortMapping): any => ({ ...obj, }); @@ -3236,6 +3584,9 @@ export interface GrpcTimeout { } export namespace GrpcTimeout { + /** + * @internal + */ export const filterSensitiveLog = (obj: GrpcTimeout): any => ({ ...obj, }); @@ -3259,6 +3610,9 @@ export interface HttpTimeout { } export namespace HttpTimeout { + /** + * @internal + */ export const filterSensitiveLog = (obj: HttpTimeout): any => ({ ...obj, }); @@ -3275,6 +3629,9 @@ export interface TcpTimeout { } export namespace TcpTimeout { + /** + * @internal + */ export const filterSensitiveLog = (obj: TcpTimeout): any => ({ ...obj, }); @@ -3359,6 +3716,9 @@ export namespace ListenerTimeout { return visitor._(value.$unknown[0], value.$unknown[1]); }; + /** + * @internal + */ export const filterSensitiveLog = (obj: ListenerTimeout): any => { if (obj.tcp !== undefined) return { tcp: TcpTimeout.filterSensitiveLog(obj.tcp) }; if (obj.http !== undefined) return { http: HttpTimeout.filterSensitiveLog(obj.http) }; @@ -3379,6 +3739,9 @@ export interface ListenerTlsAcmCertificate { } export namespace ListenerTlsAcmCertificate { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListenerTlsAcmCertificate): any => ({ ...obj, }); @@ -3446,6 +3809,9 @@ export namespace ListenerTlsCertificate { return visitor._(value.$unknown[0], value.$unknown[1]); }; + /** + * @internal + */ export const filterSensitiveLog = (obj: ListenerTlsCertificate): any => { if (obj.acm !== undefined) return { acm: ListenerTlsAcmCertificate.filterSensitiveLog(obj.acm) }; if (obj.file !== undefined) return { file: ListenerTlsFileCertificate.filterSensitiveLog(obj.file) }; @@ -3506,6 +3872,9 @@ export namespace ListenerTlsValidationContextTrust { return visitor._(value.$unknown[0], value.$unknown[1]); }; + /** + * @internal + */ export const filterSensitiveLog = (obj: ListenerTlsValidationContextTrust): any => { if (obj.file !== undefined) return { file: TlsValidationContextFileTrust.filterSensitiveLog(obj.file) }; if (obj.sds !== undefined) return { sds: TlsValidationContextSdsTrust.filterSensitiveLog(obj.sds) }; @@ -3531,6 +3900,9 @@ export interface ListenerTlsValidationContext { } export namespace ListenerTlsValidationContext { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListenerTlsValidationContext): any => ({ ...obj, ...(obj.trust && { trust: ListenerTlsValidationContextTrust.filterSensitiveLog(obj.trust) }), @@ -3575,6 +3947,9 @@ export interface ListenerTls { } export namespace ListenerTls { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListenerTls): any => ({ ...obj, ...(obj.certificate && { certificate: ListenerTlsCertificate.filterSensitiveLog(obj.certificate) }), @@ -3618,6 +3993,9 @@ export interface Listener { } export namespace Listener { + /** + * @internal + */ export const filterSensitiveLog = (obj: Listener): any => ({ ...obj, ...(obj.tls && { tls: ListenerTls.filterSensitiveLog(obj.tls) }), @@ -3637,6 +4015,9 @@ export interface Logging { } export namespace Logging { + /** + * @internal + */ export const filterSensitiveLog = (obj: Logging): any => ({ ...obj, ...(obj.accessLog && { accessLog: AccessLog.filterSensitiveLog(obj.accessLog) }), @@ -3665,6 +4046,9 @@ export interface AwsCloudMapInstanceAttribute { } export namespace AwsCloudMapInstanceAttribute { + /** + * @internal + */ export const filterSensitiveLog = (obj: AwsCloudMapInstanceAttribute): any => ({ ...obj, }); @@ -3697,6 +4081,9 @@ export interface AwsCloudMapServiceDiscovery { } export namespace AwsCloudMapServiceDiscovery { + /** + * @internal + */ export const filterSensitiveLog = (obj: AwsCloudMapServiceDiscovery): any => ({ ...obj, }); @@ -3714,6 +4101,9 @@ export interface DnsServiceDiscovery { } export namespace DnsServiceDiscovery { + /** + * @internal + */ export const filterSensitiveLog = (obj: DnsServiceDiscovery): any => ({ ...obj, }); @@ -3764,6 +4154,9 @@ export namespace ServiceDiscovery { return visitor._(value.$unknown[0], value.$unknown[1]); }; + /** + * @internal + */ export const filterSensitiveLog = (obj: ServiceDiscovery): any => { if (obj.dns !== undefined) return { dns: DnsServiceDiscovery.filterSensitiveLog(obj.dns) }; if (obj.awsCloudMap !== undefined) @@ -3806,6 +4199,9 @@ export interface VirtualNodeSpec { } export namespace VirtualNodeSpec { + /** + * @internal + */ export const filterSensitiveLog = (obj: VirtualNodeSpec): any => ({ ...obj, ...(obj.serviceDiscovery && { serviceDiscovery: ServiceDiscovery.filterSensitiveLog(obj.serviceDiscovery) }), @@ -3858,6 +4254,9 @@ export interface CreateVirtualNodeInput { } export namespace CreateVirtualNodeInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateVirtualNodeInput): any => ({ ...obj, ...(obj.spec && { spec: VirtualNodeSpec.filterSensitiveLog(obj.spec) }), @@ -3881,6 +4280,9 @@ export interface VirtualNodeStatus { } export namespace VirtualNodeStatus { + /** + * @internal + */ export const filterSensitiveLog = (obj: VirtualNodeStatus): any => ({ ...obj, }); @@ -3917,6 +4319,9 @@ export interface VirtualNodeData { } export namespace VirtualNodeData { + /** + * @internal + */ export const filterSensitiveLog = (obj: VirtualNodeData): any => ({ ...obj, ...(obj.spec && { spec: VirtualNodeSpec.filterSensitiveLog(obj.spec) }), @@ -3934,6 +4339,9 @@ export interface CreateVirtualNodeOutput { } export namespace CreateVirtualNodeOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateVirtualNodeOutput): any => ({ ...obj, ...(obj.virtualNode && { virtualNode: VirtualNodeData.filterSensitiveLog(obj.virtualNode) }), @@ -3962,6 +4370,9 @@ export interface DeleteVirtualNodeInput { } export namespace DeleteVirtualNodeInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteVirtualNodeInput): any => ({ ...obj, }); @@ -3978,6 +4389,9 @@ export interface DeleteVirtualNodeOutput { } export namespace DeleteVirtualNodeOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteVirtualNodeOutput): any => ({ ...obj, ...(obj.virtualNode && { virtualNode: VirtualNodeData.filterSensitiveLog(obj.virtualNode) }), @@ -4006,6 +4420,9 @@ export interface DescribeVirtualNodeInput { } export namespace DescribeVirtualNodeInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeVirtualNodeInput): any => ({ ...obj, }); @@ -4022,6 +4439,9 @@ export interface DescribeVirtualNodeOutput { } export namespace DescribeVirtualNodeOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeVirtualNodeOutput): any => ({ ...obj, ...(obj.virtualNode && { virtualNode: VirtualNodeData.filterSensitiveLog(obj.virtualNode) }), @@ -4065,6 +4485,9 @@ export interface ListVirtualNodesInput { } export namespace ListVirtualNodesInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListVirtualNodesInput): any => ({ ...obj, }); @@ -4118,6 +4541,9 @@ export interface VirtualNodeRef { } export namespace VirtualNodeRef { + /** + * @internal + */ export const filterSensitiveLog = (obj: VirtualNodeRef): any => ({ ...obj, }); @@ -4142,6 +4568,9 @@ export interface ListVirtualNodesOutput { } export namespace ListVirtualNodesOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListVirtualNodesOutput): any => ({ ...obj, }); @@ -4180,6 +4609,9 @@ export interface UpdateVirtualNodeInput { } export namespace UpdateVirtualNodeInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateVirtualNodeInput): any => ({ ...obj, ...(obj.spec && { spec: VirtualNodeSpec.filterSensitiveLog(obj.spec) }), @@ -4197,6 +4629,9 @@ export interface UpdateVirtualNodeOutput { } export namespace UpdateVirtualNodeOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateVirtualNodeOutput): any => ({ ...obj, ...(obj.virtualNode && { virtualNode: VirtualNodeData.filterSensitiveLog(obj.virtualNode) }), @@ -4214,6 +4649,9 @@ export interface VirtualRouterListener { } export namespace VirtualRouterListener { + /** + * @internal + */ export const filterSensitiveLog = (obj: VirtualRouterListener): any => ({ ...obj, }); @@ -4231,6 +4669,9 @@ export interface VirtualRouterSpec { } export namespace VirtualRouterSpec { + /** + * @internal + */ export const filterSensitiveLog = (obj: VirtualRouterSpec): any => ({ ...obj, }); @@ -4278,6 +4719,9 @@ export interface CreateVirtualRouterInput { } export namespace CreateVirtualRouterInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateVirtualRouterInput): any => ({ ...obj, }); @@ -4300,6 +4744,9 @@ export interface VirtualRouterStatus { } export namespace VirtualRouterStatus { + /** + * @internal + */ export const filterSensitiveLog = (obj: VirtualRouterStatus): any => ({ ...obj, }); @@ -4336,6 +4783,9 @@ export interface VirtualRouterData { } export namespace VirtualRouterData { + /** + * @internal + */ export const filterSensitiveLog = (obj: VirtualRouterData): any => ({ ...obj, }); @@ -4352,6 +4802,9 @@ export interface CreateVirtualRouterOutput { } export namespace CreateVirtualRouterOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateVirtualRouterOutput): any => ({ ...obj, }); @@ -4379,6 +4832,9 @@ export interface DeleteVirtualRouterInput { } export namespace DeleteVirtualRouterInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteVirtualRouterInput): any => ({ ...obj, }); @@ -4395,6 +4851,9 @@ export interface DeleteVirtualRouterOutput { } export namespace DeleteVirtualRouterOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteVirtualRouterOutput): any => ({ ...obj, }); @@ -4422,6 +4881,9 @@ export interface DescribeVirtualRouterInput { } export namespace DescribeVirtualRouterInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeVirtualRouterInput): any => ({ ...obj, }); @@ -4438,6 +4900,9 @@ export interface DescribeVirtualRouterOutput { } export namespace DescribeVirtualRouterOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeVirtualRouterOutput): any => ({ ...obj, }); @@ -4480,6 +4945,9 @@ export interface ListVirtualRoutersInput { } export namespace ListVirtualRoutersInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListVirtualRoutersInput): any => ({ ...obj, }); @@ -4533,6 +5001,9 @@ export interface VirtualRouterRef { } export namespace VirtualRouterRef { + /** + * @internal + */ export const filterSensitiveLog = (obj: VirtualRouterRef): any => ({ ...obj, }); @@ -4557,6 +5028,9 @@ export interface ListVirtualRoutersOutput { } export namespace ListVirtualRoutersOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListVirtualRoutersOutput): any => ({ ...obj, }); @@ -4581,6 +5055,9 @@ export interface WeightedTarget { } export namespace WeightedTarget { + /** + * @internal + */ export const filterSensitiveLog = (obj: WeightedTarget): any => ({ ...obj, }); @@ -4597,6 +5074,9 @@ export interface GrpcRouteAction { } export namespace GrpcRouteAction { + /** + * @internal + */ export const filterSensitiveLog = (obj: GrpcRouteAction): any => ({ ...obj, }); @@ -4618,6 +5098,9 @@ export interface MatchRange { } export namespace MatchRange { + /** + * @internal + */ export const filterSensitiveLog = (obj: MatchRange): any => ({ ...obj, }); @@ -4722,6 +5205,9 @@ export namespace GrpcRouteMetadataMatchMethod { return visitor._(value.$unknown[0], value.$unknown[1]); }; + /** + * @internal + */ export const filterSensitiveLog = (obj: GrpcRouteMetadataMatchMethod): any => { if (obj.exact !== undefined) return { exact: obj.exact }; if (obj.regex !== undefined) return { regex: obj.regex }; @@ -4753,6 +5239,9 @@ export interface GrpcRouteMetadata { } export namespace GrpcRouteMetadata { + /** + * @internal + */ export const filterSensitiveLog = (obj: GrpcRouteMetadata): any => ({ ...obj, ...(obj.match && { match: GrpcRouteMetadataMatchMethod.filterSensitiveLog(obj.match) }), @@ -4781,6 +5270,9 @@ export interface GrpcRouteMatch { } export namespace GrpcRouteMatch { + /** + * @internal + */ export const filterSensitiveLog = (obj: GrpcRouteMatch): any => ({ ...obj, ...(obj.metadata && { metadata: obj.metadata.map((item) => GrpcRouteMetadata.filterSensitiveLog(item)) }), @@ -4851,6 +5343,9 @@ export interface GrpcRetryPolicy { } export namespace GrpcRetryPolicy { + /** + * @internal + */ export const filterSensitiveLog = (obj: GrpcRetryPolicy): any => ({ ...obj, }); @@ -4882,6 +5377,9 @@ export interface GrpcRoute { } export namespace GrpcRoute { + /** + * @internal + */ export const filterSensitiveLog = (obj: GrpcRoute): any => ({ ...obj, }); @@ -4898,6 +5396,9 @@ export interface HttpRouteAction { } export namespace HttpRouteAction { + /** + * @internal + */ export const filterSensitiveLog = (obj: HttpRouteAction): any => ({ ...obj, }); @@ -5003,6 +5504,9 @@ export namespace HeaderMatchMethod { return visitor._(value.$unknown[0], value.$unknown[1]); }; + /** + * @internal + */ export const filterSensitiveLog = (obj: HeaderMatchMethod): any => { if (obj.exact !== undefined) return { exact: obj.exact }; if (obj.regex !== undefined) return { regex: obj.regex }; @@ -5034,6 +5538,9 @@ export interface HttpRouteHeader { } export namespace HttpRouteHeader { + /** + * @internal + */ export const filterSensitiveLog = (obj: HttpRouteHeader): any => ({ ...obj, ...(obj.match && { match: HeaderMatchMethod.filterSensitiveLog(obj.match) }), @@ -5089,6 +5596,9 @@ export interface HttpRouteMatch { } export namespace HttpRouteMatch { + /** + * @internal + */ export const filterSensitiveLog = (obj: HttpRouteMatch): any => ({ ...obj, ...(obj.headers && { headers: obj.headers.map((item) => HttpRouteHeader.filterSensitiveLog(item)) }), @@ -5142,6 +5652,9 @@ export interface HttpRetryPolicy { } export namespace HttpRetryPolicy { + /** + * @internal + */ export const filterSensitiveLog = (obj: HttpRetryPolicy): any => ({ ...obj, }); @@ -5173,6 +5686,9 @@ export interface HttpRoute { } export namespace HttpRoute { + /** + * @internal + */ export const filterSensitiveLog = (obj: HttpRoute): any => ({ ...obj, }); @@ -5189,6 +5705,9 @@ export interface TcpRouteAction { } export namespace TcpRouteAction { + /** + * @internal + */ export const filterSensitiveLog = (obj: TcpRouteAction): any => ({ ...obj, }); @@ -5210,6 +5729,9 @@ export interface TcpRoute { } export namespace TcpRoute { + /** + * @internal + */ export const filterSensitiveLog = (obj: TcpRoute): any => ({ ...obj, }); @@ -5247,6 +5769,9 @@ export interface RouteSpec { } export namespace RouteSpec { + /** + * @internal + */ export const filterSensitiveLog = (obj: RouteSpec): any => ({ ...obj, }); @@ -5300,6 +5825,9 @@ export interface CreateRouteInput { } export namespace CreateRouteInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateRouteInput): any => ({ ...obj, }); @@ -5322,6 +5850,9 @@ export interface RouteStatus { } export namespace RouteStatus { + /** + * @internal + */ export const filterSensitiveLog = (obj: RouteStatus): any => ({ ...obj, }); @@ -5363,6 +5894,9 @@ export interface RouteData { } export namespace RouteData { + /** + * @internal + */ export const filterSensitiveLog = (obj: RouteData): any => ({ ...obj, }); @@ -5379,6 +5913,9 @@ export interface CreateRouteOutput { } export namespace CreateRouteOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateRouteOutput): any => ({ ...obj, }); @@ -5411,6 +5948,9 @@ export interface DeleteRouteInput { } export namespace DeleteRouteInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteRouteInput): any => ({ ...obj, }); @@ -5427,6 +5967,9 @@ export interface DeleteRouteOutput { } export namespace DeleteRouteOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteRouteOutput): any => ({ ...obj, }); @@ -5459,6 +6002,9 @@ export interface DescribeRouteInput { } export namespace DescribeRouteInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeRouteInput): any => ({ ...obj, }); @@ -5475,6 +6021,9 @@ export interface DescribeRouteOutput { } export namespace DescribeRouteOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeRouteOutput): any => ({ ...obj, }); @@ -5522,6 +6071,9 @@ export interface ListRoutesInput { } export namespace ListRoutesInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListRoutesInput): any => ({ ...obj, }); @@ -5580,6 +6132,9 @@ export interface RouteRef { } export namespace RouteRef { + /** + * @internal + */ export const filterSensitiveLog = (obj: RouteRef): any => ({ ...obj, }); @@ -5604,6 +6159,9 @@ export interface ListRoutesOutput { } export namespace ListRoutesOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListRoutesOutput): any => ({ ...obj, }); @@ -5647,6 +6205,9 @@ export interface UpdateRouteInput { } export namespace UpdateRouteInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateRouteInput): any => ({ ...obj, }); @@ -5663,6 +6224,9 @@ export interface UpdateRouteOutput { } export namespace UpdateRouteOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateRouteOutput): any => ({ ...obj, }); @@ -5701,6 +6265,9 @@ export interface UpdateVirtualRouterInput { } export namespace UpdateVirtualRouterInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateVirtualRouterInput): any => ({ ...obj, }); @@ -5717,6 +6284,9 @@ export interface UpdateVirtualRouterOutput { } export namespace UpdateVirtualRouterOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateVirtualRouterOutput): any => ({ ...obj, }); @@ -5733,6 +6303,9 @@ export interface VirtualNodeServiceProvider { } export namespace VirtualNodeServiceProvider { + /** + * @internal + */ export const filterSensitiveLog = (obj: VirtualNodeServiceProvider): any => ({ ...obj, }); @@ -5749,6 +6322,9 @@ export interface VirtualRouterServiceProvider { } export namespace VirtualRouterServiceProvider { + /** + * @internal + */ export const filterSensitiveLog = (obj: VirtualRouterServiceProvider): any => ({ ...obj, }); @@ -5799,6 +6375,9 @@ export namespace VirtualServiceProvider { return visitor._(value.$unknown[0], value.$unknown[1]); }; + /** + * @internal + */ export const filterSensitiveLog = (obj: VirtualServiceProvider): any => { if (obj.virtualNode !== undefined) return { virtualNode: VirtualNodeServiceProvider.filterSensitiveLog(obj.virtualNode) }; @@ -5820,6 +6399,9 @@ export interface VirtualServiceSpec { } export namespace VirtualServiceSpec { + /** + * @internal + */ export const filterSensitiveLog = (obj: VirtualServiceSpec): any => ({ ...obj, ...(obj.provider && { provider: VirtualServiceProvider.filterSensitiveLog(obj.provider) }), @@ -5868,6 +6450,9 @@ export interface CreateVirtualServiceInput { } export namespace CreateVirtualServiceInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateVirtualServiceInput): any => ({ ...obj, ...(obj.spec && { spec: VirtualServiceSpec.filterSensitiveLog(obj.spec) }), @@ -5891,6 +6476,9 @@ export interface VirtualServiceStatus { } export namespace VirtualServiceStatus { + /** + * @internal + */ export const filterSensitiveLog = (obj: VirtualServiceStatus): any => ({ ...obj, }); @@ -5927,6 +6515,9 @@ export interface VirtualServiceData { } export namespace VirtualServiceData { + /** + * @internal + */ export const filterSensitiveLog = (obj: VirtualServiceData): any => ({ ...obj, ...(obj.spec && { spec: VirtualServiceSpec.filterSensitiveLog(obj.spec) }), @@ -5944,6 +6535,9 @@ export interface CreateVirtualServiceOutput { } export namespace CreateVirtualServiceOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateVirtualServiceOutput): any => ({ ...obj, ...(obj.virtualService && { virtualService: VirtualServiceData.filterSensitiveLog(obj.virtualService) }), @@ -5972,6 +6566,9 @@ export interface DeleteVirtualServiceInput { } export namespace DeleteVirtualServiceInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteVirtualServiceInput): any => ({ ...obj, }); @@ -5988,6 +6585,9 @@ export interface DeleteVirtualServiceOutput { } export namespace DeleteVirtualServiceOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteVirtualServiceOutput): any => ({ ...obj, ...(obj.virtualService && { virtualService: VirtualServiceData.filterSensitiveLog(obj.virtualService) }), @@ -6016,6 +6616,9 @@ export interface DescribeVirtualServiceInput { } export namespace DescribeVirtualServiceInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeVirtualServiceInput): any => ({ ...obj, }); @@ -6032,6 +6635,9 @@ export interface DescribeVirtualServiceOutput { } export namespace DescribeVirtualServiceOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeVirtualServiceOutput): any => ({ ...obj, ...(obj.virtualService && { virtualService: VirtualServiceData.filterSensitiveLog(obj.virtualService) }), @@ -6075,6 +6681,9 @@ export interface ListVirtualServicesInput { } export namespace ListVirtualServicesInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListVirtualServicesInput): any => ({ ...obj, }); @@ -6128,6 +6737,9 @@ export interface VirtualServiceRef { } export namespace VirtualServiceRef { + /** + * @internal + */ export const filterSensitiveLog = (obj: VirtualServiceRef): any => ({ ...obj, }); @@ -6152,6 +6764,9 @@ export interface ListVirtualServicesOutput { } export namespace ListVirtualServicesOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListVirtualServicesOutput): any => ({ ...obj, }); @@ -6191,6 +6806,9 @@ export interface UpdateVirtualServiceInput { } export namespace UpdateVirtualServiceInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateVirtualServiceInput): any => ({ ...obj, ...(obj.spec && { spec: VirtualServiceSpec.filterSensitiveLog(obj.spec) }), @@ -6208,6 +6826,9 @@ export interface UpdateVirtualServiceOutput { } export namespace UpdateVirtualServiceOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateVirtualServiceOutput): any => ({ ...obj, ...(obj.virtualService && { virtualService: VirtualServiceData.filterSensitiveLog(obj.virtualService) }), @@ -6232,6 +6853,9 @@ export interface TagResourceInput { } export namespace TagResourceInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: TagResourceInput): any => ({ ...obj, }); @@ -6243,6 +6867,9 @@ export namespace TagResourceInput { export interface TagResourceOutput {} export namespace TagResourceOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: TagResourceOutput): any => ({ ...obj, }); @@ -6260,6 +6887,9 @@ export interface TooManyTagsException extends __SmithyException, $MetadataBearer } export namespace TooManyTagsException { + /** + * @internal + */ export const filterSensitiveLog = (obj: TooManyTagsException): any => ({ ...obj, }); @@ -6281,6 +6911,9 @@ export interface UntagResourceInput { } export namespace UntagResourceInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: UntagResourceInput): any => ({ ...obj, }); @@ -6292,6 +6925,9 @@ export namespace UntagResourceInput { export interface UntagResourceOutput {} export namespace UntagResourceOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: UntagResourceOutput): any => ({ ...obj, }); diff --git a/clients/client-appconfig/commands/CreateApplicationCommand.ts b/clients/client-appconfig/commands/CreateApplicationCommand.ts index a4117d88018b..ca590aad131b 100644 --- a/clients/client-appconfig/commands/CreateApplicationCommand.ts +++ b/clients/client-appconfig/commands/CreateApplicationCommand.ts @@ -25,6 +25,20 @@ export interface CreateApplicationCommandOutput extends Application, __MetadataB * customers. For example, an application can be a microservice that runs on Amazon EC2 instances, * a mobile application installed by your users, a serverless application using Amazon API * Gateway and AWS Lambda, or any system you run on behalf of others.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { AppConfigClient, CreateApplicationCommand } from "@aws-sdk/client-appconfig"; // ES Modules import + * // const { AppConfigClient, CreateApplicationCommand } = require("@aws-sdk/client-appconfig"); // CommonJS import + * const client = new AppConfigClient(config); + * const command = new CreateApplicationCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreateApplicationCommandInput} for command's `input` shape. + * @see {@link CreateApplicationCommandOutput} for command's `response` shape. + * @see {@link AppConfigClientResolvedConfig | config} for command's `input` shape. + * */ export class CreateApplicationCommand extends $Command< CreateApplicationCommandInput, diff --git a/clients/client-appconfig/commands/CreateConfigurationProfileCommand.ts b/clients/client-appconfig/commands/CreateConfigurationProfileCommand.ts index cc4698847243..158f46080275 100644 --- a/clients/client-appconfig/commands/CreateConfigurationProfileCommand.ts +++ b/clients/client-appconfig/commands/CreateConfigurationProfileCommand.ts @@ -39,6 +39,20 @@ export interface CreateConfigurationProfileCommandOutput extends ConfigurationPr *

For more information, see Create a * Configuration and a Configuration Profile in the * AWS AppConfig User Guide.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { AppConfigClient, CreateConfigurationProfileCommand } from "@aws-sdk/client-appconfig"; // ES Modules import + * // const { AppConfigClient, CreateConfigurationProfileCommand } = require("@aws-sdk/client-appconfig"); // CommonJS import + * const client = new AppConfigClient(config); + * const command = new CreateConfigurationProfileCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreateConfigurationProfileCommandInput} for command's `input` shape. + * @see {@link CreateConfigurationProfileCommandOutput} for command's `response` shape. + * @see {@link AppConfigClientResolvedConfig | config} for command's `input` shape. + * */ export class CreateConfigurationProfileCommand extends $Command< CreateConfigurationProfileCommandInput, diff --git a/clients/client-appconfig/commands/CreateDeploymentStrategyCommand.ts b/clients/client-appconfig/commands/CreateDeploymentStrategyCommand.ts index 189ee950ab93..08f0cf054b9d 100644 --- a/clients/client-appconfig/commands/CreateDeploymentStrategyCommand.ts +++ b/clients/client-appconfig/commands/CreateDeploymentStrategyCommand.ts @@ -25,6 +25,20 @@ export interface CreateDeploymentStrategyCommandOutput extends DeploymentStrateg * 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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { AppConfigClient, CreateDeploymentStrategyCommand } from "@aws-sdk/client-appconfig"; // ES Modules import + * // const { AppConfigClient, CreateDeploymentStrategyCommand } = require("@aws-sdk/client-appconfig"); // CommonJS import + * const client = new AppConfigClient(config); + * const command = new CreateDeploymentStrategyCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreateDeploymentStrategyCommandInput} for command's `input` shape. + * @see {@link CreateDeploymentStrategyCommandOutput} for command's `response` shape. + * @see {@link AppConfigClientResolvedConfig | config} for command's `input` shape. + * */ export class CreateDeploymentStrategyCommand extends $Command< CreateDeploymentStrategyCommandInput, diff --git a/clients/client-appconfig/commands/CreateEnvironmentCommand.ts b/clients/client-appconfig/commands/CreateEnvironmentCommand.ts index 11b4f685f0e1..8941cece0901 100644 --- a/clients/client-appconfig/commands/CreateEnvironmentCommand.ts +++ b/clients/client-appconfig/commands/CreateEnvironmentCommand.ts @@ -28,6 +28,20 @@ export interface CreateEnvironmentCommandOutput extends Environment, __MetadataB * 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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { AppConfigClient, CreateEnvironmentCommand } from "@aws-sdk/client-appconfig"; // ES Modules import + * // const { AppConfigClient, CreateEnvironmentCommand } = require("@aws-sdk/client-appconfig"); // CommonJS import + * const client = new AppConfigClient(config); + * const command = new CreateEnvironmentCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreateEnvironmentCommandInput} for command's `input` shape. + * @see {@link CreateEnvironmentCommandOutput} for command's `response` shape. + * @see {@link AppConfigClientResolvedConfig | config} for command's `input` shape. + * */ export class CreateEnvironmentCommand extends $Command< CreateEnvironmentCommandInput, diff --git a/clients/client-appconfig/commands/CreateHostedConfigurationVersionCommand.ts b/clients/client-appconfig/commands/CreateHostedConfigurationVersionCommand.ts index 4aeefb2e8483..750c18b02a5f 100644 --- a/clients/client-appconfig/commands/CreateHostedConfigurationVersionCommand.ts +++ b/clients/client-appconfig/commands/CreateHostedConfigurationVersionCommand.ts @@ -22,6 +22,20 @@ export interface CreateHostedConfigurationVersionCommandOutput extends HostedCon /** *

Create a new configuration in the AppConfig configuration store.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { AppConfigClient, CreateHostedConfigurationVersionCommand } from "@aws-sdk/client-appconfig"; // ES Modules import + * // const { AppConfigClient, CreateHostedConfigurationVersionCommand } = require("@aws-sdk/client-appconfig"); // CommonJS import + * const client = new AppConfigClient(config); + * const command = new CreateHostedConfigurationVersionCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreateHostedConfigurationVersionCommandInput} for command's `input` shape. + * @see {@link CreateHostedConfigurationVersionCommandOutput} for command's `response` shape. + * @see {@link AppConfigClientResolvedConfig | config} for command's `input` shape. + * */ export class CreateHostedConfigurationVersionCommand extends $Command< CreateHostedConfigurationVersionCommandInput, diff --git a/clients/client-appconfig/commands/DeleteApplicationCommand.ts b/clients/client-appconfig/commands/DeleteApplicationCommand.ts index 095c794bdeb4..fb04f2f64092 100644 --- a/clients/client-appconfig/commands/DeleteApplicationCommand.ts +++ b/clients/client-appconfig/commands/DeleteApplicationCommand.ts @@ -23,6 +23,20 @@ export interface DeleteApplicationCommandOutput extends __MetadataBearer {} /** *

Delete an application. Deleting an application does not delete a configuration from a * host.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { AppConfigClient, DeleteApplicationCommand } from "@aws-sdk/client-appconfig"; // ES Modules import + * // const { AppConfigClient, DeleteApplicationCommand } = require("@aws-sdk/client-appconfig"); // CommonJS import + * const client = new AppConfigClient(config); + * const command = new DeleteApplicationCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteApplicationCommandInput} for command's `input` shape. + * @see {@link DeleteApplicationCommandOutput} for command's `response` shape. + * @see {@link AppConfigClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteApplicationCommand extends $Command< DeleteApplicationCommandInput, diff --git a/clients/client-appconfig/commands/DeleteConfigurationProfileCommand.ts b/clients/client-appconfig/commands/DeleteConfigurationProfileCommand.ts index 1f2c9682deb0..1fdccb52eff0 100644 --- a/clients/client-appconfig/commands/DeleteConfigurationProfileCommand.ts +++ b/clients/client-appconfig/commands/DeleteConfigurationProfileCommand.ts @@ -23,6 +23,20 @@ export interface DeleteConfigurationProfileCommandOutput extends __MetadataBeare /** *

Delete a configuration profile. Deleting a configuration profile does not delete a * configuration from a host.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { AppConfigClient, DeleteConfigurationProfileCommand } from "@aws-sdk/client-appconfig"; // ES Modules import + * // const { AppConfigClient, DeleteConfigurationProfileCommand } = require("@aws-sdk/client-appconfig"); // CommonJS import + * const client = new AppConfigClient(config); + * const command = new DeleteConfigurationProfileCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteConfigurationProfileCommandInput} for command's `input` shape. + * @see {@link DeleteConfigurationProfileCommandOutput} for command's `response` shape. + * @see {@link AppConfigClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteConfigurationProfileCommand extends $Command< DeleteConfigurationProfileCommandInput, diff --git a/clients/client-appconfig/commands/DeleteDeploymentStrategyCommand.ts b/clients/client-appconfig/commands/DeleteDeploymentStrategyCommand.ts index 1c6b714de1d0..a24da597034d 100644 --- a/clients/client-appconfig/commands/DeleteDeploymentStrategyCommand.ts +++ b/clients/client-appconfig/commands/DeleteDeploymentStrategyCommand.ts @@ -23,6 +23,20 @@ export interface DeleteDeploymentStrategyCommandOutput extends __MetadataBearer /** *

Delete a deployment strategy. Deleting a deployment strategy does not delete a * configuration from a host.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { AppConfigClient, DeleteDeploymentStrategyCommand } from "@aws-sdk/client-appconfig"; // ES Modules import + * // const { AppConfigClient, DeleteDeploymentStrategyCommand } = require("@aws-sdk/client-appconfig"); // CommonJS import + * const client = new AppConfigClient(config); + * const command = new DeleteDeploymentStrategyCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteDeploymentStrategyCommandInput} for command's `input` shape. + * @see {@link DeleteDeploymentStrategyCommandOutput} for command's `response` shape. + * @see {@link AppConfigClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteDeploymentStrategyCommand extends $Command< DeleteDeploymentStrategyCommandInput, diff --git a/clients/client-appconfig/commands/DeleteEnvironmentCommand.ts b/clients/client-appconfig/commands/DeleteEnvironmentCommand.ts index 8e73a25c25c7..2688b2dfd94e 100644 --- a/clients/client-appconfig/commands/DeleteEnvironmentCommand.ts +++ b/clients/client-appconfig/commands/DeleteEnvironmentCommand.ts @@ -23,6 +23,20 @@ export interface DeleteEnvironmentCommandOutput extends __MetadataBearer {} /** *

Delete an environment. Deleting an environment does not delete a configuration from a * host.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { AppConfigClient, DeleteEnvironmentCommand } from "@aws-sdk/client-appconfig"; // ES Modules import + * // const { AppConfigClient, DeleteEnvironmentCommand } = require("@aws-sdk/client-appconfig"); // CommonJS import + * const client = new AppConfigClient(config); + * const command = new DeleteEnvironmentCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteEnvironmentCommandInput} for command's `input` shape. + * @see {@link DeleteEnvironmentCommandOutput} for command's `response` shape. + * @see {@link AppConfigClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteEnvironmentCommand extends $Command< DeleteEnvironmentCommandInput, diff --git a/clients/client-appconfig/commands/DeleteHostedConfigurationVersionCommand.ts b/clients/client-appconfig/commands/DeleteHostedConfigurationVersionCommand.ts index cecec71bea63..ff6ef23b0913 100644 --- a/clients/client-appconfig/commands/DeleteHostedConfigurationVersionCommand.ts +++ b/clients/client-appconfig/commands/DeleteHostedConfigurationVersionCommand.ts @@ -22,6 +22,20 @@ export interface DeleteHostedConfigurationVersionCommandOutput extends __Metadat /** *

Delete a version of a configuration from the AppConfig configuration store.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { AppConfigClient, DeleteHostedConfigurationVersionCommand } from "@aws-sdk/client-appconfig"; // ES Modules import + * // const { AppConfigClient, DeleteHostedConfigurationVersionCommand } = require("@aws-sdk/client-appconfig"); // CommonJS import + * const client = new AppConfigClient(config); + * const command = new DeleteHostedConfigurationVersionCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteHostedConfigurationVersionCommandInput} for command's `input` shape. + * @see {@link DeleteHostedConfigurationVersionCommandOutput} for command's `response` shape. + * @see {@link AppConfigClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteHostedConfigurationVersionCommand extends $Command< DeleteHostedConfigurationVersionCommandInput, diff --git a/clients/client-appconfig/commands/GetApplicationCommand.ts b/clients/client-appconfig/commands/GetApplicationCommand.ts index b54e4d70302b..3c06d5cdcb46 100644 --- a/clients/client-appconfig/commands/GetApplicationCommand.ts +++ b/clients/client-appconfig/commands/GetApplicationCommand.ts @@ -22,6 +22,20 @@ export interface GetApplicationCommandOutput extends Application, __MetadataBear /** *

Retrieve information about an application.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { AppConfigClient, GetApplicationCommand } from "@aws-sdk/client-appconfig"; // ES Modules import + * // const { AppConfigClient, GetApplicationCommand } = require("@aws-sdk/client-appconfig"); // CommonJS import + * const client = new AppConfigClient(config); + * const command = new GetApplicationCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetApplicationCommandInput} for command's `input` shape. + * @see {@link GetApplicationCommandOutput} for command's `response` shape. + * @see {@link AppConfigClientResolvedConfig | config} for command's `input` shape. + * */ export class GetApplicationCommand extends $Command< GetApplicationCommandInput, diff --git a/clients/client-appconfig/commands/GetConfigurationCommand.ts b/clients/client-appconfig/commands/GetConfigurationCommand.ts index efb377e039db..e6d641decbc4 100644 --- a/clients/client-appconfig/commands/GetConfigurationCommand.ts +++ b/clients/client-appconfig/commands/GetConfigurationCommand.ts @@ -34,6 +34,20 @@ export interface GetConfigurationCommandOutput extends Configuration, __Metadata * calls to GetConfiguration must pass this value by using the * ClientConfigurationVersion parameter.

* + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { AppConfigClient, GetConfigurationCommand } from "@aws-sdk/client-appconfig"; // ES Modules import + * // const { AppConfigClient, GetConfigurationCommand } = require("@aws-sdk/client-appconfig"); // CommonJS import + * const client = new AppConfigClient(config); + * const command = new GetConfigurationCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetConfigurationCommandInput} for command's `input` shape. + * @see {@link GetConfigurationCommandOutput} for command's `response` shape. + * @see {@link AppConfigClientResolvedConfig | config} for command's `input` shape. + * */ export class GetConfigurationCommand extends $Command< GetConfigurationCommandInput, diff --git a/clients/client-appconfig/commands/GetConfigurationProfileCommand.ts b/clients/client-appconfig/commands/GetConfigurationProfileCommand.ts index 6010a94794eb..4226a768d713 100644 --- a/clients/client-appconfig/commands/GetConfigurationProfileCommand.ts +++ b/clients/client-appconfig/commands/GetConfigurationProfileCommand.ts @@ -22,6 +22,20 @@ export interface GetConfigurationProfileCommandOutput extends ConfigurationProfi /** *

Retrieve information about a configuration profile.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { AppConfigClient, GetConfigurationProfileCommand } from "@aws-sdk/client-appconfig"; // ES Modules import + * // const { AppConfigClient, GetConfigurationProfileCommand } = require("@aws-sdk/client-appconfig"); // CommonJS import + * const client = new AppConfigClient(config); + * const command = new GetConfigurationProfileCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetConfigurationProfileCommandInput} for command's `input` shape. + * @see {@link GetConfigurationProfileCommandOutput} for command's `response` shape. + * @see {@link AppConfigClientResolvedConfig | config} for command's `input` shape. + * */ export class GetConfigurationProfileCommand extends $Command< GetConfigurationProfileCommandInput, diff --git a/clients/client-appconfig/commands/GetDeploymentCommand.ts b/clients/client-appconfig/commands/GetDeploymentCommand.ts index c3bda722975c..037b4f10315f 100644 --- a/clients/client-appconfig/commands/GetDeploymentCommand.ts +++ b/clients/client-appconfig/commands/GetDeploymentCommand.ts @@ -22,6 +22,20 @@ export interface GetDeploymentCommandOutput extends Deployment, __MetadataBearer /** *

Retrieve information about a configuration deployment.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { AppConfigClient, GetDeploymentCommand } from "@aws-sdk/client-appconfig"; // ES Modules import + * // const { AppConfigClient, GetDeploymentCommand } = require("@aws-sdk/client-appconfig"); // CommonJS import + * const client = new AppConfigClient(config); + * const command = new GetDeploymentCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetDeploymentCommandInput} for command's `input` shape. + * @see {@link GetDeploymentCommandOutput} for command's `response` shape. + * @see {@link AppConfigClientResolvedConfig | config} for command's `input` shape. + * */ export class GetDeploymentCommand extends $Command< GetDeploymentCommandInput, diff --git a/clients/client-appconfig/commands/GetDeploymentStrategyCommand.ts b/clients/client-appconfig/commands/GetDeploymentStrategyCommand.ts index f0edaeb9c54c..ecaa6d708882 100644 --- a/clients/client-appconfig/commands/GetDeploymentStrategyCommand.ts +++ b/clients/client-appconfig/commands/GetDeploymentStrategyCommand.ts @@ -26,6 +26,20 @@ export interface GetDeploymentStrategyCommandOutput extends DeploymentStrategy, * 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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { AppConfigClient, GetDeploymentStrategyCommand } from "@aws-sdk/client-appconfig"; // ES Modules import + * // const { AppConfigClient, GetDeploymentStrategyCommand } = require("@aws-sdk/client-appconfig"); // CommonJS import + * const client = new AppConfigClient(config); + * const command = new GetDeploymentStrategyCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetDeploymentStrategyCommandInput} for command's `input` shape. + * @see {@link GetDeploymentStrategyCommandOutput} for command's `response` shape. + * @see {@link AppConfigClientResolvedConfig | config} for command's `input` shape. + * */ export class GetDeploymentStrategyCommand extends $Command< GetDeploymentStrategyCommandInput, diff --git a/clients/client-appconfig/commands/GetEnvironmentCommand.ts b/clients/client-appconfig/commands/GetEnvironmentCommand.ts index 66a1afd71efc..67c9f465b1d1 100644 --- a/clients/client-appconfig/commands/GetEnvironmentCommand.ts +++ b/clients/client-appconfig/commands/GetEnvironmentCommand.ts @@ -26,6 +26,20 @@ export interface GetEnvironmentCommandOutput extends Environment, __MetadataBear * 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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { AppConfigClient, GetEnvironmentCommand } from "@aws-sdk/client-appconfig"; // ES Modules import + * // const { AppConfigClient, GetEnvironmentCommand } = require("@aws-sdk/client-appconfig"); // CommonJS import + * const client = new AppConfigClient(config); + * const command = new GetEnvironmentCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetEnvironmentCommandInput} for command's `input` shape. + * @see {@link GetEnvironmentCommandOutput} for command's `response` shape. + * @see {@link AppConfigClientResolvedConfig | config} for command's `input` shape. + * */ export class GetEnvironmentCommand extends $Command< GetEnvironmentCommandInput, diff --git a/clients/client-appconfig/commands/GetHostedConfigurationVersionCommand.ts b/clients/client-appconfig/commands/GetHostedConfigurationVersionCommand.ts index 871a46c77fb0..f8372c7e22ad 100644 --- a/clients/client-appconfig/commands/GetHostedConfigurationVersionCommand.ts +++ b/clients/client-appconfig/commands/GetHostedConfigurationVersionCommand.ts @@ -22,6 +22,20 @@ export interface GetHostedConfigurationVersionCommandOutput extends HostedConfig /** *

Get information about a specific configuration version.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { AppConfigClient, GetHostedConfigurationVersionCommand } from "@aws-sdk/client-appconfig"; // ES Modules import + * // const { AppConfigClient, GetHostedConfigurationVersionCommand } = require("@aws-sdk/client-appconfig"); // CommonJS import + * const client = new AppConfigClient(config); + * const command = new GetHostedConfigurationVersionCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetHostedConfigurationVersionCommandInput} for command's `input` shape. + * @see {@link GetHostedConfigurationVersionCommandOutput} for command's `response` shape. + * @see {@link AppConfigClientResolvedConfig | config} for command's `input` shape. + * */ export class GetHostedConfigurationVersionCommand extends $Command< GetHostedConfigurationVersionCommandInput, diff --git a/clients/client-appconfig/commands/ListApplicationsCommand.ts b/clients/client-appconfig/commands/ListApplicationsCommand.ts index 21a3a8086b75..361525e08a95 100644 --- a/clients/client-appconfig/commands/ListApplicationsCommand.ts +++ b/clients/client-appconfig/commands/ListApplicationsCommand.ts @@ -22,6 +22,20 @@ export interface ListApplicationsCommandOutput extends Applications, __MetadataB /** *

List all applications in your AWS account.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { AppConfigClient, ListApplicationsCommand } from "@aws-sdk/client-appconfig"; // ES Modules import + * // const { AppConfigClient, ListApplicationsCommand } = require("@aws-sdk/client-appconfig"); // CommonJS import + * const client = new AppConfigClient(config); + * const command = new ListApplicationsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListApplicationsCommandInput} for command's `input` shape. + * @see {@link ListApplicationsCommandOutput} for command's `response` shape. + * @see {@link AppConfigClientResolvedConfig | config} for command's `input` shape. + * */ export class ListApplicationsCommand extends $Command< ListApplicationsCommandInput, diff --git a/clients/client-appconfig/commands/ListConfigurationProfilesCommand.ts b/clients/client-appconfig/commands/ListConfigurationProfilesCommand.ts index a0b4b677fa4b..7094a1115ce0 100644 --- a/clients/client-appconfig/commands/ListConfigurationProfilesCommand.ts +++ b/clients/client-appconfig/commands/ListConfigurationProfilesCommand.ts @@ -22,6 +22,20 @@ export interface ListConfigurationProfilesCommandOutput extends ConfigurationPro /** *

Lists the configuration profiles for an application.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { AppConfigClient, ListConfigurationProfilesCommand } from "@aws-sdk/client-appconfig"; // ES Modules import + * // const { AppConfigClient, ListConfigurationProfilesCommand } = require("@aws-sdk/client-appconfig"); // CommonJS import + * const client = new AppConfigClient(config); + * const command = new ListConfigurationProfilesCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListConfigurationProfilesCommandInput} for command's `input` shape. + * @see {@link ListConfigurationProfilesCommandOutput} for command's `response` shape. + * @see {@link AppConfigClientResolvedConfig | config} for command's `input` shape. + * */ export class ListConfigurationProfilesCommand extends $Command< ListConfigurationProfilesCommandInput, diff --git a/clients/client-appconfig/commands/ListDeploymentStrategiesCommand.ts b/clients/client-appconfig/commands/ListDeploymentStrategiesCommand.ts index c28f317292da..bb1cec16ca1b 100644 --- a/clients/client-appconfig/commands/ListDeploymentStrategiesCommand.ts +++ b/clients/client-appconfig/commands/ListDeploymentStrategiesCommand.ts @@ -22,6 +22,20 @@ export interface ListDeploymentStrategiesCommandOutput extends DeploymentStrateg /** *

List deployment strategies.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { AppConfigClient, ListDeploymentStrategiesCommand } from "@aws-sdk/client-appconfig"; // ES Modules import + * // const { AppConfigClient, ListDeploymentStrategiesCommand } = require("@aws-sdk/client-appconfig"); // CommonJS import + * const client = new AppConfigClient(config); + * const command = new ListDeploymentStrategiesCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListDeploymentStrategiesCommandInput} for command's `input` shape. + * @see {@link ListDeploymentStrategiesCommandOutput} for command's `response` shape. + * @see {@link AppConfigClientResolvedConfig | config} for command's `input` shape. + * */ export class ListDeploymentStrategiesCommand extends $Command< ListDeploymentStrategiesCommandInput, diff --git a/clients/client-appconfig/commands/ListDeploymentsCommand.ts b/clients/client-appconfig/commands/ListDeploymentsCommand.ts index 092b424a4db7..c21a348c086d 100644 --- a/clients/client-appconfig/commands/ListDeploymentsCommand.ts +++ b/clients/client-appconfig/commands/ListDeploymentsCommand.ts @@ -22,6 +22,20 @@ export interface ListDeploymentsCommandOutput extends Deployments, __MetadataBea /** *

Lists the deployments for an environment.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { AppConfigClient, ListDeploymentsCommand } from "@aws-sdk/client-appconfig"; // ES Modules import + * // const { AppConfigClient, ListDeploymentsCommand } = require("@aws-sdk/client-appconfig"); // CommonJS import + * const client = new AppConfigClient(config); + * const command = new ListDeploymentsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListDeploymentsCommandInput} for command's `input` shape. + * @see {@link ListDeploymentsCommandOutput} for command's `response` shape. + * @see {@link AppConfigClientResolvedConfig | config} for command's `input` shape. + * */ export class ListDeploymentsCommand extends $Command< ListDeploymentsCommandInput, diff --git a/clients/client-appconfig/commands/ListEnvironmentsCommand.ts b/clients/client-appconfig/commands/ListEnvironmentsCommand.ts index 45d3b7098c7a..52c00797eb65 100644 --- a/clients/client-appconfig/commands/ListEnvironmentsCommand.ts +++ b/clients/client-appconfig/commands/ListEnvironmentsCommand.ts @@ -22,6 +22,20 @@ export interface ListEnvironmentsCommandOutput extends Environments, __MetadataB /** *

List the environments for an application.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { AppConfigClient, ListEnvironmentsCommand } from "@aws-sdk/client-appconfig"; // ES Modules import + * // const { AppConfigClient, ListEnvironmentsCommand } = require("@aws-sdk/client-appconfig"); // CommonJS import + * const client = new AppConfigClient(config); + * const command = new ListEnvironmentsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListEnvironmentsCommandInput} for command's `input` shape. + * @see {@link ListEnvironmentsCommandOutput} for command's `response` shape. + * @see {@link AppConfigClientResolvedConfig | config} for command's `input` shape. + * */ export class ListEnvironmentsCommand extends $Command< ListEnvironmentsCommandInput, diff --git a/clients/client-appconfig/commands/ListHostedConfigurationVersionsCommand.ts b/clients/client-appconfig/commands/ListHostedConfigurationVersionsCommand.ts index f6f46eba8716..d321ba306101 100644 --- a/clients/client-appconfig/commands/ListHostedConfigurationVersionsCommand.ts +++ b/clients/client-appconfig/commands/ListHostedConfigurationVersionsCommand.ts @@ -23,6 +23,20 @@ export interface ListHostedConfigurationVersionsCommandOutput extends HostedConf /** *

View a list of configurations stored in the AppConfig configuration store by * version.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { AppConfigClient, ListHostedConfigurationVersionsCommand } from "@aws-sdk/client-appconfig"; // ES Modules import + * // const { AppConfigClient, ListHostedConfigurationVersionsCommand } = require("@aws-sdk/client-appconfig"); // CommonJS import + * const client = new AppConfigClient(config); + * const command = new ListHostedConfigurationVersionsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListHostedConfigurationVersionsCommandInput} for command's `input` shape. + * @see {@link ListHostedConfigurationVersionsCommandOutput} for command's `response` shape. + * @see {@link AppConfigClientResolvedConfig | config} for command's `input` shape. + * */ export class ListHostedConfigurationVersionsCommand extends $Command< ListHostedConfigurationVersionsCommandInput, diff --git a/clients/client-appconfig/commands/ListTagsForResourceCommand.ts b/clients/client-appconfig/commands/ListTagsForResourceCommand.ts index 263eae4daaa7..0d8a8b4d22ac 100644 --- a/clients/client-appconfig/commands/ListTagsForResourceCommand.ts +++ b/clients/client-appconfig/commands/ListTagsForResourceCommand.ts @@ -22,6 +22,20 @@ export interface ListTagsForResourceCommandOutput extends ResourceTags, __Metada /** *

Retrieves the list of key-value tags assigned to the resource.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { AppConfigClient, ListTagsForResourceCommand } from "@aws-sdk/client-appconfig"; // ES Modules import + * // const { AppConfigClient, ListTagsForResourceCommand } = require("@aws-sdk/client-appconfig"); // CommonJS import + * const client = new AppConfigClient(config); + * const command = new ListTagsForResourceCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListTagsForResourceCommandInput} for command's `input` shape. + * @see {@link ListTagsForResourceCommandOutput} for command's `response` shape. + * @see {@link AppConfigClientResolvedConfig | config} for command's `input` shape. + * */ export class ListTagsForResourceCommand extends $Command< ListTagsForResourceCommandInput, diff --git a/clients/client-appconfig/commands/StartDeploymentCommand.ts b/clients/client-appconfig/commands/StartDeploymentCommand.ts index 8b3e4f5d09dc..6a70b7926b63 100644 --- a/clients/client-appconfig/commands/StartDeploymentCommand.ts +++ b/clients/client-appconfig/commands/StartDeploymentCommand.ts @@ -22,6 +22,20 @@ export interface StartDeploymentCommandOutput extends Deployment, __MetadataBear /** *

Starts a deployment.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { AppConfigClient, StartDeploymentCommand } from "@aws-sdk/client-appconfig"; // ES Modules import + * // const { AppConfigClient, StartDeploymentCommand } = require("@aws-sdk/client-appconfig"); // CommonJS import + * const client = new AppConfigClient(config); + * const command = new StartDeploymentCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link StartDeploymentCommandInput} for command's `input` shape. + * @see {@link StartDeploymentCommandOutput} for command's `response` shape. + * @see {@link AppConfigClientResolvedConfig | config} for command's `input` shape. + * */ export class StartDeploymentCommand extends $Command< StartDeploymentCommandInput, diff --git a/clients/client-appconfig/commands/StopDeploymentCommand.ts b/clients/client-appconfig/commands/StopDeploymentCommand.ts index f16360897a4c..62a3a24bd5f9 100644 --- a/clients/client-appconfig/commands/StopDeploymentCommand.ts +++ b/clients/client-appconfig/commands/StopDeploymentCommand.ts @@ -24,6 +24,20 @@ export interface StopDeploymentCommandOutput extends Deployment, __MetadataBeare *

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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { AppConfigClient, StopDeploymentCommand } from "@aws-sdk/client-appconfig"; // ES Modules import + * // const { AppConfigClient, StopDeploymentCommand } = require("@aws-sdk/client-appconfig"); // CommonJS import + * const client = new AppConfigClient(config); + * const command = new StopDeploymentCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link StopDeploymentCommandInput} for command's `input` shape. + * @see {@link StopDeploymentCommandOutput} for command's `response` shape. + * @see {@link AppConfigClientResolvedConfig | config} for command's `input` shape. + * */ export class StopDeploymentCommand extends $Command< StopDeploymentCommandInput, diff --git a/clients/client-appconfig/commands/TagResourceCommand.ts b/clients/client-appconfig/commands/TagResourceCommand.ts index e4caaf181ad7..b8f347ad5c81 100644 --- a/clients/client-appconfig/commands/TagResourceCommand.ts +++ b/clients/client-appconfig/commands/TagResourceCommand.ts @@ -24,6 +24,20 @@ export interface TagResourceCommandOutput extends __MetadataBearer {} *

Metadata to assign 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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { AppConfigClient, TagResourceCommand } from "@aws-sdk/client-appconfig"; // ES Modules import + * // const { AppConfigClient, TagResourceCommand } = require("@aws-sdk/client-appconfig"); // CommonJS import + * const client = new AppConfigClient(config); + * const command = new TagResourceCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link TagResourceCommandInput} for command's `input` shape. + * @see {@link TagResourceCommandOutput} for command's `response` shape. + * @see {@link AppConfigClientResolvedConfig | config} for command's `input` shape. + * */ export class TagResourceCommand extends $Command< TagResourceCommandInput, diff --git a/clients/client-appconfig/commands/UntagResourceCommand.ts b/clients/client-appconfig/commands/UntagResourceCommand.ts index bef7102033db..874952edeb4f 100644 --- a/clients/client-appconfig/commands/UntagResourceCommand.ts +++ b/clients/client-appconfig/commands/UntagResourceCommand.ts @@ -22,6 +22,20 @@ export interface UntagResourceCommandOutput extends __MetadataBearer {} /** *

Deletes a tag key and value from an AppConfig resource.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { AppConfigClient, UntagResourceCommand } from "@aws-sdk/client-appconfig"; // ES Modules import + * // const { AppConfigClient, UntagResourceCommand } = require("@aws-sdk/client-appconfig"); // CommonJS import + * const client = new AppConfigClient(config); + * const command = new UntagResourceCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link UntagResourceCommandInput} for command's `input` shape. + * @see {@link UntagResourceCommandOutput} for command's `response` shape. + * @see {@link AppConfigClientResolvedConfig | config} for command's `input` shape. + * */ export class UntagResourceCommand extends $Command< UntagResourceCommandInput, diff --git a/clients/client-appconfig/commands/UpdateApplicationCommand.ts b/clients/client-appconfig/commands/UpdateApplicationCommand.ts index 9355ff84378c..26e6fa397781 100644 --- a/clients/client-appconfig/commands/UpdateApplicationCommand.ts +++ b/clients/client-appconfig/commands/UpdateApplicationCommand.ts @@ -22,6 +22,20 @@ export interface UpdateApplicationCommandOutput extends Application, __MetadataB /** *

Updates an application.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { AppConfigClient, UpdateApplicationCommand } from "@aws-sdk/client-appconfig"; // ES Modules import + * // const { AppConfigClient, UpdateApplicationCommand } = require("@aws-sdk/client-appconfig"); // CommonJS import + * const client = new AppConfigClient(config); + * const command = new UpdateApplicationCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link UpdateApplicationCommandInput} for command's `input` shape. + * @see {@link UpdateApplicationCommandOutput} for command's `response` shape. + * @see {@link AppConfigClientResolvedConfig | config} for command's `input` shape. + * */ export class UpdateApplicationCommand extends $Command< UpdateApplicationCommandInput, diff --git a/clients/client-appconfig/commands/UpdateConfigurationProfileCommand.ts b/clients/client-appconfig/commands/UpdateConfigurationProfileCommand.ts index 86675d9f5bf7..9b5ccb703ed6 100644 --- a/clients/client-appconfig/commands/UpdateConfigurationProfileCommand.ts +++ b/clients/client-appconfig/commands/UpdateConfigurationProfileCommand.ts @@ -22,6 +22,20 @@ export interface UpdateConfigurationProfileCommandOutput extends ConfigurationPr /** *

Updates a configuration profile.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { AppConfigClient, UpdateConfigurationProfileCommand } from "@aws-sdk/client-appconfig"; // ES Modules import + * // const { AppConfigClient, UpdateConfigurationProfileCommand } = require("@aws-sdk/client-appconfig"); // CommonJS import + * const client = new AppConfigClient(config); + * const command = new UpdateConfigurationProfileCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link UpdateConfigurationProfileCommandInput} for command's `input` shape. + * @see {@link UpdateConfigurationProfileCommandOutput} for command's `response` shape. + * @see {@link AppConfigClientResolvedConfig | config} for command's `input` shape. + * */ export class UpdateConfigurationProfileCommand extends $Command< UpdateConfigurationProfileCommandInput, diff --git a/clients/client-appconfig/commands/UpdateDeploymentStrategyCommand.ts b/clients/client-appconfig/commands/UpdateDeploymentStrategyCommand.ts index 17fc813e43ab..a0486ad6af51 100644 --- a/clients/client-appconfig/commands/UpdateDeploymentStrategyCommand.ts +++ b/clients/client-appconfig/commands/UpdateDeploymentStrategyCommand.ts @@ -22,6 +22,20 @@ export interface UpdateDeploymentStrategyCommandOutput extends DeploymentStrateg /** *

Updates a deployment strategy.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { AppConfigClient, UpdateDeploymentStrategyCommand } from "@aws-sdk/client-appconfig"; // ES Modules import + * // const { AppConfigClient, UpdateDeploymentStrategyCommand } = require("@aws-sdk/client-appconfig"); // CommonJS import + * const client = new AppConfigClient(config); + * const command = new UpdateDeploymentStrategyCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link UpdateDeploymentStrategyCommandInput} for command's `input` shape. + * @see {@link UpdateDeploymentStrategyCommandOutput} for command's `response` shape. + * @see {@link AppConfigClientResolvedConfig | config} for command's `input` shape. + * */ export class UpdateDeploymentStrategyCommand extends $Command< UpdateDeploymentStrategyCommandInput, diff --git a/clients/client-appconfig/commands/UpdateEnvironmentCommand.ts b/clients/client-appconfig/commands/UpdateEnvironmentCommand.ts index 0a6cc1a2261a..81f531f74fd0 100644 --- a/clients/client-appconfig/commands/UpdateEnvironmentCommand.ts +++ b/clients/client-appconfig/commands/UpdateEnvironmentCommand.ts @@ -22,6 +22,20 @@ export interface UpdateEnvironmentCommandOutput extends Environment, __MetadataB /** *

Updates an environment.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { AppConfigClient, UpdateEnvironmentCommand } from "@aws-sdk/client-appconfig"; // ES Modules import + * // const { AppConfigClient, UpdateEnvironmentCommand } = require("@aws-sdk/client-appconfig"); // CommonJS import + * const client = new AppConfigClient(config); + * const command = new UpdateEnvironmentCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link UpdateEnvironmentCommandInput} for command's `input` shape. + * @see {@link UpdateEnvironmentCommandOutput} for command's `response` shape. + * @see {@link AppConfigClientResolvedConfig | config} for command's `input` shape. + * */ export class UpdateEnvironmentCommand extends $Command< UpdateEnvironmentCommandInput, diff --git a/clients/client-appconfig/commands/ValidateConfigurationCommand.ts b/clients/client-appconfig/commands/ValidateConfigurationCommand.ts index 8a30c435f7e6..37321ae7cd19 100644 --- a/clients/client-appconfig/commands/ValidateConfigurationCommand.ts +++ b/clients/client-appconfig/commands/ValidateConfigurationCommand.ts @@ -22,6 +22,20 @@ export interface ValidateConfigurationCommandOutput extends __MetadataBearer {} /** *

Uses the validators in a configuration profile to validate a configuration.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { AppConfigClient, ValidateConfigurationCommand } from "@aws-sdk/client-appconfig"; // ES Modules import + * // const { AppConfigClient, ValidateConfigurationCommand } = require("@aws-sdk/client-appconfig"); // CommonJS import + * const client = new AppConfigClient(config); + * const command = new ValidateConfigurationCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ValidateConfigurationCommandInput} for command's `input` shape. + * @see {@link ValidateConfigurationCommandOutput} for command's `response` shape. + * @see {@link AppConfigClientResolvedConfig | config} for command's `input` shape. + * */ export class ValidateConfigurationCommand extends $Command< ValidateConfigurationCommandInput, diff --git a/clients/client-appconfig/models/models_0.ts b/clients/client-appconfig/models/models_0.ts index d3b0071cc7dd..f50e67cfb404 100644 --- a/clients/client-appconfig/models/models_0.ts +++ b/clients/client-appconfig/models/models_0.ts @@ -19,6 +19,9 @@ export interface Application { } export namespace Application { + /** + * @internal + */ export const filterSensitiveLog = (obj: Application): any => ({ ...obj, }); @@ -34,6 +37,9 @@ export interface BadRequestException extends __SmithyException, $MetadataBearer } export namespace BadRequestException { + /** + * @internal + */ export const filterSensitiveLog = (obj: BadRequestException): any => ({ ...obj, }); @@ -59,6 +65,9 @@ export interface CreateApplicationRequest { } export namespace CreateApplicationRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateApplicationRequest): any => ({ ...obj, }); @@ -74,6 +83,9 @@ export interface InternalServerException extends __SmithyException, $MetadataBea } export namespace InternalServerException { + /** + * @internal + */ export const filterSensitiveLog = (obj: InternalServerException): any => ({ ...obj, }); @@ -107,6 +119,9 @@ export interface Validator { } export namespace Validator { + /** + * @internal + */ export const filterSensitiveLog = (obj: Validator): any => ({ ...obj, ...(obj.Content && { Content: SENSITIVE_STRING }), @@ -152,6 +167,9 @@ export interface ConfigurationProfile { } export namespace ConfigurationProfile { + /** + * @internal + */ export const filterSensitiveLog = (obj: ConfigurationProfile): any => ({ ...obj, ...(obj.Validators && { Validators: obj.Validators.map((item) => Validator.filterSensitiveLog(item)) }), @@ -205,6 +223,9 @@ export interface CreateConfigurationProfileRequest { } export namespace CreateConfigurationProfileRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateConfigurationProfileRequest): any => ({ ...obj, ...(obj.Validators && { Validators: obj.Validators.map((item) => Validator.filterSensitiveLog(item)) }), @@ -222,6 +243,9 @@ export interface ResourceNotFoundException extends __SmithyException, $MetadataB } export namespace ResourceNotFoundException { + /** + * @internal + */ export const filterSensitiveLog = (obj: ResourceNotFoundException): any => ({ ...obj, }); @@ -313,6 +337,9 @@ export interface CreateDeploymentStrategyRequest { } export namespace CreateDeploymentStrategyRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateDeploymentStrategyRequest): any => ({ ...obj, }); @@ -363,6 +390,9 @@ export interface DeploymentStrategy { } export namespace DeploymentStrategy { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeploymentStrategy): any => ({ ...obj, }); @@ -384,6 +414,9 @@ export interface Monitor { } export namespace Monitor { + /** + * @internal + */ export const filterSensitiveLog = (obj: Monitor): any => ({ ...obj, }); @@ -419,6 +452,9 @@ export interface CreateEnvironmentRequest { } export namespace CreateEnvironmentRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateEnvironmentRequest): any => ({ ...obj, }); @@ -467,6 +503,9 @@ export interface Environment { } export namespace Environment { + /** + * @internal + */ export const filterSensitiveLog = (obj: Environment): any => ({ ...obj, }); @@ -483,6 +522,9 @@ export interface ConflictException extends __SmithyException, $MetadataBearer { } export namespace ConflictException { + /** + * @internal + */ export const filterSensitiveLog = (obj: ConflictException): any => ({ ...obj, }); @@ -525,6 +567,9 @@ export interface CreateHostedConfigurationVersionRequest { } export namespace CreateHostedConfigurationVersionRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateHostedConfigurationVersionRequest): any => ({ ...obj, ...(obj.Content && { Content: SENSITIVE_STRING }), @@ -565,6 +610,9 @@ export interface HostedConfigurationVersion { } export namespace HostedConfigurationVersion { + /** + * @internal + */ export const filterSensitiveLog = (obj: HostedConfigurationVersion): any => ({ ...obj, ...(obj.Content && { Content: SENSITIVE_STRING }), @@ -588,6 +636,9 @@ export interface PayloadTooLargeException extends __SmithyException, $MetadataBe } export namespace PayloadTooLargeException { + /** + * @internal + */ export const filterSensitiveLog = (obj: PayloadTooLargeException): any => ({ ...obj, }); @@ -604,6 +655,9 @@ export interface ServiceQuotaExceededException extends __SmithyException, $Metad } export namespace ServiceQuotaExceededException { + /** + * @internal + */ export const filterSensitiveLog = (obj: ServiceQuotaExceededException): any => ({ ...obj, }); @@ -617,6 +671,9 @@ export interface DeleteApplicationRequest { } export namespace DeleteApplicationRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteApplicationRequest): any => ({ ...obj, }); @@ -635,6 +692,9 @@ export interface DeleteConfigurationProfileRequest { } export namespace DeleteConfigurationProfileRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteConfigurationProfileRequest): any => ({ ...obj, }); @@ -648,6 +708,9 @@ export interface DeleteDeploymentStrategyRequest { } export namespace DeleteDeploymentStrategyRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteDeploymentStrategyRequest): any => ({ ...obj, }); @@ -666,6 +729,9 @@ export interface DeleteEnvironmentRequest { } export namespace DeleteEnvironmentRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteEnvironmentRequest): any => ({ ...obj, }); @@ -689,6 +755,9 @@ export interface DeleteHostedConfigurationVersionRequest { } export namespace DeleteHostedConfigurationVersionRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteHostedConfigurationVersionRequest): any => ({ ...obj, }); @@ -702,6 +771,9 @@ export interface GetApplicationRequest { } export namespace GetApplicationRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetApplicationRequest): any => ({ ...obj, }); @@ -726,6 +798,9 @@ export interface Configuration { } export namespace Configuration { + /** + * @internal + */ export const filterSensitiveLog = (obj: Configuration): any => ({ ...obj, ...(obj.Content && { Content: SENSITIVE_STRING }), @@ -779,6 +854,9 @@ export interface GetConfigurationRequest { } export namespace GetConfigurationRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetConfigurationRequest): any => ({ ...obj, }); @@ -798,6 +876,9 @@ export interface GetConfigurationProfileRequest { } export namespace GetConfigurationProfileRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetConfigurationProfileRequest): any => ({ ...obj, }); @@ -851,6 +932,9 @@ export interface DeploymentEvent { } export namespace DeploymentEvent { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeploymentEvent): any => ({ ...obj, }); @@ -961,6 +1045,9 @@ export interface Deployment { } export namespace Deployment { + /** + * @internal + */ export const filterSensitiveLog = (obj: Deployment): any => ({ ...obj, }); @@ -984,6 +1071,9 @@ export interface GetDeploymentRequest { } export namespace GetDeploymentRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetDeploymentRequest): any => ({ ...obj, }); @@ -997,6 +1087,9 @@ export interface GetDeploymentStrategyRequest { } export namespace GetDeploymentStrategyRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetDeploymentStrategyRequest): any => ({ ...obj, }); @@ -1015,6 +1108,9 @@ export interface GetEnvironmentRequest { } export namespace GetEnvironmentRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetEnvironmentRequest): any => ({ ...obj, }); @@ -1038,6 +1134,9 @@ export interface GetHostedConfigurationVersionRequest { } export namespace GetHostedConfigurationVersionRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetHostedConfigurationVersionRequest): any => ({ ...obj, }); @@ -1057,6 +1156,9 @@ export interface Applications { } export namespace Applications { + /** + * @internal + */ export const filterSensitiveLog = (obj: Applications): any => ({ ...obj, }); @@ -1076,6 +1178,9 @@ export interface ListApplicationsRequest { } export namespace ListApplicationsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListApplicationsRequest): any => ({ ...obj, }); @@ -1112,6 +1217,9 @@ export interface ConfigurationProfileSummary { } export namespace ConfigurationProfileSummary { + /** + * @internal + */ export const filterSensitiveLog = (obj: ConfigurationProfileSummary): any => ({ ...obj, }); @@ -1131,6 +1239,9 @@ export interface ConfigurationProfiles { } export namespace ConfigurationProfiles { + /** + * @internal + */ export const filterSensitiveLog = (obj: ConfigurationProfiles): any => ({ ...obj, }); @@ -1155,6 +1266,9 @@ export interface ListConfigurationProfilesRequest { } export namespace ListConfigurationProfilesRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListConfigurationProfilesRequest): any => ({ ...obj, }); @@ -1223,6 +1337,9 @@ export interface DeploymentSummary { } export namespace DeploymentSummary { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeploymentSummary): any => ({ ...obj, }); @@ -1242,6 +1359,9 @@ export interface Deployments { } export namespace Deployments { + /** + * @internal + */ export const filterSensitiveLog = (obj: Deployments): any => ({ ...obj, }); @@ -1271,6 +1391,9 @@ export interface ListDeploymentsRequest { } export namespace ListDeploymentsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListDeploymentsRequest): any => ({ ...obj, }); @@ -1290,6 +1413,9 @@ export interface DeploymentStrategies { } export namespace DeploymentStrategies { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeploymentStrategies): any => ({ ...obj, }); @@ -1309,6 +1435,9 @@ export interface ListDeploymentStrategiesRequest { } export namespace ListDeploymentStrategiesRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListDeploymentStrategiesRequest): any => ({ ...obj, }); @@ -1328,6 +1457,9 @@ export interface Environments { } export namespace Environments { + /** + * @internal + */ export const filterSensitiveLog = (obj: Environments): any => ({ ...obj, }); @@ -1352,6 +1484,9 @@ export interface ListEnvironmentsRequest { } export namespace ListEnvironmentsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListEnvironmentsRequest): any => ({ ...obj, }); @@ -1389,6 +1524,9 @@ export interface HostedConfigurationVersionSummary { } export namespace HostedConfigurationVersionSummary { + /** + * @internal + */ export const filterSensitiveLog = (obj: HostedConfigurationVersionSummary): any => ({ ...obj, }); @@ -1408,6 +1546,9 @@ export interface HostedConfigurationVersions { } export namespace HostedConfigurationVersions { + /** + * @internal + */ export const filterSensitiveLog = (obj: HostedConfigurationVersions): any => ({ ...obj, }); @@ -1437,6 +1578,9 @@ export interface ListHostedConfigurationVersionsRequest { } export namespace ListHostedConfigurationVersionsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListHostedConfigurationVersionsRequest): any => ({ ...obj, }); @@ -1450,6 +1594,9 @@ export interface ListTagsForResourceRequest { } export namespace ListTagsForResourceRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListTagsForResourceRequest): any => ({ ...obj, }); @@ -1465,6 +1612,9 @@ export interface ResourceTags { } export namespace ResourceTags { + /** + * @internal + */ export const filterSensitiveLog = (obj: ResourceTags): any => ({ ...obj, }); @@ -1510,6 +1660,9 @@ export interface StartDeploymentRequest { } export namespace StartDeploymentRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: StartDeploymentRequest): any => ({ ...obj, }); @@ -1533,6 +1686,9 @@ export interface StopDeploymentRequest { } export namespace StopDeploymentRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: StopDeploymentRequest): any => ({ ...obj, }); @@ -1553,6 +1709,9 @@ export interface TagResourceRequest { } export namespace TagResourceRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: TagResourceRequest): any => ({ ...obj, }); @@ -1571,6 +1730,9 @@ export interface UntagResourceRequest { } export namespace UntagResourceRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: UntagResourceRequest): any => ({ ...obj, }); @@ -1594,6 +1756,9 @@ export interface UpdateApplicationRequest { } export namespace UpdateApplicationRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateApplicationRequest): any => ({ ...obj, }); @@ -1633,6 +1798,9 @@ export interface UpdateConfigurationProfileRequest { } export namespace UpdateConfigurationProfileRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateConfigurationProfileRequest): any => ({ ...obj, ...(obj.Validators && { Validators: obj.Validators.map((item) => Validator.filterSensitiveLog(item)) }), @@ -1702,6 +1870,9 @@ export interface UpdateDeploymentStrategyRequest { } export namespace UpdateDeploymentStrategyRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateDeploymentStrategyRequest): any => ({ ...obj, }); @@ -1735,6 +1906,9 @@ export interface UpdateEnvironmentRequest { } export namespace UpdateEnvironmentRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateEnvironmentRequest): any => ({ ...obj, }); @@ -1758,6 +1932,9 @@ export interface ValidateConfigurationRequest { } export namespace ValidateConfigurationRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ValidateConfigurationRequest): any => ({ ...obj, }); diff --git a/clients/client-appflow/commands/CreateConnectorProfileCommand.ts b/clients/client-appflow/commands/CreateConnectorProfileCommand.ts index aa76143044df..c4c18e9c45e3 100644 --- a/clients/client-appflow/commands/CreateConnectorProfileCommand.ts +++ b/clients/client-appflow/commands/CreateConnectorProfileCommand.ts @@ -24,6 +24,20 @@ export interface CreateConnectorProfileCommandOutput extends CreateConnectorProf *

* Creates a new connector profile associated with your AWS account. There is a soft quota of 100 connector profiles per AWS 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. *

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { AppflowClient, CreateConnectorProfileCommand } from "@aws-sdk/client-appflow"; // ES Modules import + * // const { AppflowClient, CreateConnectorProfileCommand } = require("@aws-sdk/client-appflow"); // CommonJS import + * const client = new AppflowClient(config); + * const command = new CreateConnectorProfileCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreateConnectorProfileCommandInput} for command's `input` shape. + * @see {@link CreateConnectorProfileCommandOutput} for command's `response` shape. + * @see {@link AppflowClientResolvedConfig | config} for command's `input` shape. + * */ export class CreateConnectorProfileCommand extends $Command< CreateConnectorProfileCommandInput, diff --git a/clients/client-appflow/commands/CreateFlowCommand.ts b/clients/client-appflow/commands/CreateFlowCommand.ts index 58ce3124bd12..083a317194d7 100644 --- a/clients/client-appflow/commands/CreateFlowCommand.ts +++ b/clients/client-appflow/commands/CreateFlowCommand.ts @@ -25,6 +25,20 @@ export interface CreateFlowCommandOutput extends CreateFlowResponse, __MetadataB * 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. * *

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { AppflowClient, CreateFlowCommand } from "@aws-sdk/client-appflow"; // ES Modules import + * // const { AppflowClient, CreateFlowCommand } = require("@aws-sdk/client-appflow"); // CommonJS import + * const client = new AppflowClient(config); + * const command = new CreateFlowCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreateFlowCommandInput} for command's `input` shape. + * @see {@link CreateFlowCommandOutput} for command's `response` shape. + * @see {@link AppflowClientResolvedConfig | config} for command's `input` shape. + * */ export class CreateFlowCommand extends $Command< CreateFlowCommandInput, diff --git a/clients/client-appflow/commands/DeleteConnectorProfileCommand.ts b/clients/client-appflow/commands/DeleteConnectorProfileCommand.ts index 114cda8c735d..cf2b862afdc6 100644 --- a/clients/client-appflow/commands/DeleteConnectorProfileCommand.ts +++ b/clients/client-appflow/commands/DeleteConnectorProfileCommand.ts @@ -24,6 +24,20 @@ export interface DeleteConnectorProfileCommandOutput extends DeleteConnectorProf *

* Enables you to delete an existing connector profile. *

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { AppflowClient, DeleteConnectorProfileCommand } from "@aws-sdk/client-appflow"; // ES Modules import + * // const { AppflowClient, DeleteConnectorProfileCommand } = require("@aws-sdk/client-appflow"); // CommonJS import + * const client = new AppflowClient(config); + * const command = new DeleteConnectorProfileCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteConnectorProfileCommandInput} for command's `input` shape. + * @see {@link DeleteConnectorProfileCommandOutput} for command's `response` shape. + * @see {@link AppflowClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteConnectorProfileCommand extends $Command< DeleteConnectorProfileCommandInput, diff --git a/clients/client-appflow/commands/DeleteFlowCommand.ts b/clients/client-appflow/commands/DeleteFlowCommand.ts index bdeda2dce815..5ddf89ce03fe 100644 --- a/clients/client-appflow/commands/DeleteFlowCommand.ts +++ b/clients/client-appflow/commands/DeleteFlowCommand.ts @@ -25,6 +25,20 @@ export interface DeleteFlowCommandOutput extends DeleteFlowResponse, __MetadataB * 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. * *

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { AppflowClient, DeleteFlowCommand } from "@aws-sdk/client-appflow"; // ES Modules import + * // const { AppflowClient, DeleteFlowCommand } = require("@aws-sdk/client-appflow"); // CommonJS import + * const client = new AppflowClient(config); + * const command = new DeleteFlowCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteFlowCommandInput} for command's `input` shape. + * @see {@link DeleteFlowCommandOutput} for command's `response` shape. + * @see {@link AppflowClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteFlowCommand extends $Command< DeleteFlowCommandInput, diff --git a/clients/client-appflow/commands/DescribeConnectorEntityCommand.ts b/clients/client-appflow/commands/DescribeConnectorEntityCommand.ts index 2a88e15e4af8..dbf216128a46 100644 --- a/clients/client-appflow/commands/DescribeConnectorEntityCommand.ts +++ b/clients/client-appflow/commands/DescribeConnectorEntityCommand.ts @@ -24,6 +24,20 @@ export interface DescribeConnectorEntityCommandOutput extends DescribeConnectorE *

* Provides details regarding the entity used with the connector, with a description of the data model for each entity. *

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { AppflowClient, DescribeConnectorEntityCommand } from "@aws-sdk/client-appflow"; // ES Modules import + * // const { AppflowClient, DescribeConnectorEntityCommand } = require("@aws-sdk/client-appflow"); // CommonJS import + * const client = new AppflowClient(config); + * const command = new DescribeConnectorEntityCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeConnectorEntityCommandInput} for command's `input` shape. + * @see {@link DescribeConnectorEntityCommandOutput} for command's `response` shape. + * @see {@link AppflowClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeConnectorEntityCommand extends $Command< DescribeConnectorEntityCommandInput, diff --git a/clients/client-appflow/commands/DescribeConnectorProfilesCommand.ts b/clients/client-appflow/commands/DescribeConnectorProfilesCommand.ts index ddcd28b813b3..0ac695d02601 100644 --- a/clients/client-appflow/commands/DescribeConnectorProfilesCommand.ts +++ b/clients/client-appflow/commands/DescribeConnectorProfilesCommand.ts @@ -24,6 +24,20 @@ export interface DescribeConnectorProfilesCommandOutput extends DescribeConnecto *

* 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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { AppflowClient, DescribeConnectorProfilesCommand } from "@aws-sdk/client-appflow"; // ES Modules import + * // const { AppflowClient, DescribeConnectorProfilesCommand } = require("@aws-sdk/client-appflow"); // CommonJS import + * const client = new AppflowClient(config); + * const command = new DescribeConnectorProfilesCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeConnectorProfilesCommandInput} for command's `input` shape. + * @see {@link DescribeConnectorProfilesCommandOutput} for command's `response` shape. + * @see {@link AppflowClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeConnectorProfilesCommand extends $Command< DescribeConnectorProfilesCommandInput, diff --git a/clients/client-appflow/commands/DescribeConnectorsCommand.ts b/clients/client-appflow/commands/DescribeConnectorsCommand.ts index 657cdce83dab..32c6560c8d2a 100644 --- a/clients/client-appflow/commands/DescribeConnectorsCommand.ts +++ b/clients/client-appflow/commands/DescribeConnectorsCommand.ts @@ -25,6 +25,20 @@ export interface DescribeConnectorsCommandOutput extends DescribeConnectorsRespo * 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. *

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { AppflowClient, DescribeConnectorsCommand } from "@aws-sdk/client-appflow"; // ES Modules import + * // const { AppflowClient, DescribeConnectorsCommand } = require("@aws-sdk/client-appflow"); // CommonJS import + * const client = new AppflowClient(config); + * const command = new DescribeConnectorsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeConnectorsCommandInput} for command's `input` shape. + * @see {@link DescribeConnectorsCommandOutput} for command's `response` shape. + * @see {@link AppflowClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeConnectorsCommand extends $Command< DescribeConnectorsCommandInput, diff --git a/clients/client-appflow/commands/DescribeFlowCommand.ts b/clients/client-appflow/commands/DescribeFlowCommand.ts index bb50e5037cf9..d3e091f5dc21 100644 --- a/clients/client-appflow/commands/DescribeFlowCommand.ts +++ b/clients/client-appflow/commands/DescribeFlowCommand.ts @@ -25,6 +25,20 @@ export interface DescribeFlowCommandOutput extends DescribeFlowResponse, __Metad * Provides a description of the specified flow. * *

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { AppflowClient, DescribeFlowCommand } from "@aws-sdk/client-appflow"; // ES Modules import + * // const { AppflowClient, DescribeFlowCommand } = require("@aws-sdk/client-appflow"); // CommonJS import + * const client = new AppflowClient(config); + * const command = new DescribeFlowCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeFlowCommandInput} for command's `input` shape. + * @see {@link DescribeFlowCommandOutput} for command's `response` shape. + * @see {@link AppflowClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeFlowCommand extends $Command< DescribeFlowCommandInput, diff --git a/clients/client-appflow/commands/DescribeFlowExecutionRecordsCommand.ts b/clients/client-appflow/commands/DescribeFlowExecutionRecordsCommand.ts index 5975a1358f17..86e2d814b3e4 100644 --- a/clients/client-appflow/commands/DescribeFlowExecutionRecordsCommand.ts +++ b/clients/client-appflow/commands/DescribeFlowExecutionRecordsCommand.ts @@ -26,6 +26,20 @@ export interface DescribeFlowExecutionRecordsCommandOutput *

* Fetches the execution history of the flow. *

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { AppflowClient, DescribeFlowExecutionRecordsCommand } from "@aws-sdk/client-appflow"; // ES Modules import + * // const { AppflowClient, DescribeFlowExecutionRecordsCommand } = require("@aws-sdk/client-appflow"); // CommonJS import + * const client = new AppflowClient(config); + * const command = new DescribeFlowExecutionRecordsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeFlowExecutionRecordsCommandInput} for command's `input` shape. + * @see {@link DescribeFlowExecutionRecordsCommandOutput} for command's `response` shape. + * @see {@link AppflowClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeFlowExecutionRecordsCommand extends $Command< DescribeFlowExecutionRecordsCommandInput, diff --git a/clients/client-appflow/commands/ListConnectorEntitiesCommand.ts b/clients/client-appflow/commands/ListConnectorEntitiesCommand.ts index 69b23268503b..385220f479d9 100644 --- a/clients/client-appflow/commands/ListConnectorEntitiesCommand.ts +++ b/clients/client-appflow/commands/ListConnectorEntitiesCommand.ts @@ -24,6 +24,20 @@ export interface ListConnectorEntitiesCommandOutput extends ListConnectorEntitie *

* 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. *

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { AppflowClient, ListConnectorEntitiesCommand } from "@aws-sdk/client-appflow"; // ES Modules import + * // const { AppflowClient, ListConnectorEntitiesCommand } = require("@aws-sdk/client-appflow"); // CommonJS import + * const client = new AppflowClient(config); + * const command = new ListConnectorEntitiesCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListConnectorEntitiesCommandInput} for command's `input` shape. + * @see {@link ListConnectorEntitiesCommandOutput} for command's `response` shape. + * @see {@link AppflowClientResolvedConfig | config} for command's `input` shape. + * */ export class ListConnectorEntitiesCommand extends $Command< ListConnectorEntitiesCommandInput, diff --git a/clients/client-appflow/commands/ListFlowsCommand.ts b/clients/client-appflow/commands/ListFlowsCommand.ts index 48af98490911..6747af44adad 100644 --- a/clients/client-appflow/commands/ListFlowsCommand.ts +++ b/clients/client-appflow/commands/ListFlowsCommand.ts @@ -24,6 +24,20 @@ export interface ListFlowsCommandOutput extends ListFlowsResponse, __MetadataBea *

* Lists all of the flows associated with your account. *

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { AppflowClient, ListFlowsCommand } from "@aws-sdk/client-appflow"; // ES Modules import + * // const { AppflowClient, ListFlowsCommand } = require("@aws-sdk/client-appflow"); // CommonJS import + * const client = new AppflowClient(config); + * const command = new ListFlowsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListFlowsCommandInput} for command's `input` shape. + * @see {@link ListFlowsCommandOutput} for command's `response` shape. + * @see {@link AppflowClientResolvedConfig | config} for command's `input` shape. + * */ export class ListFlowsCommand extends $Command< ListFlowsCommandInput, diff --git a/clients/client-appflow/commands/ListTagsForResourceCommand.ts b/clients/client-appflow/commands/ListTagsForResourceCommand.ts index 87685c0a8d11..fe3e2e448cbc 100644 --- a/clients/client-appflow/commands/ListTagsForResourceCommand.ts +++ b/clients/client-appflow/commands/ListTagsForResourceCommand.ts @@ -24,6 +24,20 @@ export interface ListTagsForResourceCommandOutput extends ListTagsForResourceRes *

* Retrieves the tags that are associated with a specified flow. *

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { AppflowClient, ListTagsForResourceCommand } from "@aws-sdk/client-appflow"; // ES Modules import + * // const { AppflowClient, ListTagsForResourceCommand } = require("@aws-sdk/client-appflow"); // CommonJS import + * const client = new AppflowClient(config); + * const command = new ListTagsForResourceCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListTagsForResourceCommandInput} for command's `input` shape. + * @see {@link ListTagsForResourceCommandOutput} for command's `response` shape. + * @see {@link AppflowClientResolvedConfig | config} for command's `input` shape. + * */ export class ListTagsForResourceCommand extends $Command< ListTagsForResourceCommandInput, diff --git a/clients/client-appflow/commands/StartFlowCommand.ts b/clients/client-appflow/commands/StartFlowCommand.ts index e051b187e7d5..ade5aa4051f1 100644 --- a/clients/client-appflow/commands/StartFlowCommand.ts +++ b/clients/client-appflow/commands/StartFlowCommand.ts @@ -25,6 +25,20 @@ export interface StartFlowCommandOutput extends StartFlowResponse, __MetadataBea * 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. * *

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { AppflowClient, StartFlowCommand } from "@aws-sdk/client-appflow"; // ES Modules import + * // const { AppflowClient, StartFlowCommand } = require("@aws-sdk/client-appflow"); // CommonJS import + * const client = new AppflowClient(config); + * const command = new StartFlowCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link StartFlowCommandInput} for command's `input` shape. + * @see {@link StartFlowCommandOutput} for command's `response` shape. + * @see {@link AppflowClientResolvedConfig | config} for command's `input` shape. + * */ export class StartFlowCommand extends $Command< StartFlowCommandInput, diff --git a/clients/client-appflow/commands/StopFlowCommand.ts b/clients/client-appflow/commands/StopFlowCommand.ts index 7bf27fa8cd2f..9ac172b2e7b5 100644 --- a/clients/client-appflow/commands/StopFlowCommand.ts +++ b/clients/client-appflow/commands/StopFlowCommand.ts @@ -24,6 +24,20 @@ export interface StopFlowCommandOutput extends StopFlowResponse, __MetadataBeare *

* 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. *

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { AppflowClient, StopFlowCommand } from "@aws-sdk/client-appflow"; // ES Modules import + * // const { AppflowClient, StopFlowCommand } = require("@aws-sdk/client-appflow"); // CommonJS import + * const client = new AppflowClient(config); + * const command = new StopFlowCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link StopFlowCommandInput} for command's `input` shape. + * @see {@link StopFlowCommandOutput} for command's `response` shape. + * @see {@link AppflowClientResolvedConfig | config} for command's `input` shape. + * */ export class StopFlowCommand extends $Command< StopFlowCommandInput, diff --git a/clients/client-appflow/commands/TagResourceCommand.ts b/clients/client-appflow/commands/TagResourceCommand.ts index 53d260aa9384..e06b5b917244 100644 --- a/clients/client-appflow/commands/TagResourceCommand.ts +++ b/clients/client-appflow/commands/TagResourceCommand.ts @@ -24,6 +24,20 @@ export interface TagResourceCommandOutput extends TagResourceResponse, __Metadat *

* Applies a tag to the specified flow. *

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { AppflowClient, TagResourceCommand } from "@aws-sdk/client-appflow"; // ES Modules import + * // const { AppflowClient, TagResourceCommand } = require("@aws-sdk/client-appflow"); // CommonJS import + * const client = new AppflowClient(config); + * const command = new TagResourceCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link TagResourceCommandInput} for command's `input` shape. + * @see {@link TagResourceCommandOutput} for command's `response` shape. + * @see {@link AppflowClientResolvedConfig | config} for command's `input` shape. + * */ export class TagResourceCommand extends $Command< TagResourceCommandInput, diff --git a/clients/client-appflow/commands/UntagResourceCommand.ts b/clients/client-appflow/commands/UntagResourceCommand.ts index 75ff0954a741..319b1acdb27d 100644 --- a/clients/client-appflow/commands/UntagResourceCommand.ts +++ b/clients/client-appflow/commands/UntagResourceCommand.ts @@ -24,6 +24,20 @@ export interface UntagResourceCommandOutput extends UntagResourceResponse, __Met *

* Removes a tag from the specified flow. *

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { AppflowClient, UntagResourceCommand } from "@aws-sdk/client-appflow"; // ES Modules import + * // const { AppflowClient, UntagResourceCommand } = require("@aws-sdk/client-appflow"); // CommonJS import + * const client = new AppflowClient(config); + * const command = new UntagResourceCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link UntagResourceCommandInput} for command's `input` shape. + * @see {@link UntagResourceCommandOutput} for command's `response` shape. + * @see {@link AppflowClientResolvedConfig | config} for command's `input` shape. + * */ export class UntagResourceCommand extends $Command< UntagResourceCommandInput, diff --git a/clients/client-appflow/commands/UpdateConnectorProfileCommand.ts b/clients/client-appflow/commands/UpdateConnectorProfileCommand.ts index c147fbaf2568..817ff221088d 100644 --- a/clients/client-appflow/commands/UpdateConnectorProfileCommand.ts +++ b/clients/client-appflow/commands/UpdateConnectorProfileCommand.ts @@ -24,6 +24,20 @@ export interface UpdateConnectorProfileCommandOutput extends UpdateConnectorProf *

* Updates a given connector profile associated with your account. *

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { AppflowClient, UpdateConnectorProfileCommand } from "@aws-sdk/client-appflow"; // ES Modules import + * // const { AppflowClient, UpdateConnectorProfileCommand } = require("@aws-sdk/client-appflow"); // CommonJS import + * const client = new AppflowClient(config); + * const command = new UpdateConnectorProfileCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link UpdateConnectorProfileCommandInput} for command's `input` shape. + * @see {@link UpdateConnectorProfileCommandOutput} for command's `response` shape. + * @see {@link AppflowClientResolvedConfig | config} for command's `input` shape. + * */ export class UpdateConnectorProfileCommand extends $Command< UpdateConnectorProfileCommandInput, diff --git a/clients/client-appflow/commands/UpdateFlowCommand.ts b/clients/client-appflow/commands/UpdateFlowCommand.ts index 74797fbbafba..59825257b89a 100644 --- a/clients/client-appflow/commands/UpdateFlowCommand.ts +++ b/clients/client-appflow/commands/UpdateFlowCommand.ts @@ -24,6 +24,20 @@ export interface UpdateFlowCommandOutput extends UpdateFlowResponse, __MetadataB *

* Updates an existing flow. *

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { AppflowClient, UpdateFlowCommand } from "@aws-sdk/client-appflow"; // ES Modules import + * // const { AppflowClient, UpdateFlowCommand } = require("@aws-sdk/client-appflow"); // CommonJS import + * const client = new AppflowClient(config); + * const command = new UpdateFlowCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link UpdateFlowCommandInput} for command's `input` shape. + * @see {@link UpdateFlowCommandOutput} for command's `response` shape. + * @see {@link AppflowClientResolvedConfig | config} for command's `input` shape. + * */ export class UpdateFlowCommand extends $Command< UpdateFlowCommandInput, diff --git a/clients/client-appflow/models/models_0.ts b/clients/client-appflow/models/models_0.ts index 18c4d3b5375e..6853fc7e3c70 100644 --- a/clients/client-appflow/models/models_0.ts +++ b/clients/client-appflow/models/models_0.ts @@ -21,6 +21,9 @@ export interface AggregationConfig { } export namespace AggregationConfig { + /** + * @internal + */ export const filterSensitiveLog = (obj: AggregationConfig): any => ({ ...obj, }); @@ -52,6 +55,9 @@ export interface AmplitudeConnectorProfileCredentials { } export namespace AmplitudeConnectorProfileCredentials { + /** + * @internal + */ export const filterSensitiveLog = (obj: AmplitudeConnectorProfileCredentials): any => ({ ...obj, ...(obj.secretKey && { secretKey: SENSITIVE_STRING }), @@ -66,6 +72,9 @@ export namespace AmplitudeConnectorProfileCredentials { export interface AmplitudeConnectorProfileProperties {} export namespace AmplitudeConnectorProfileProperties { + /** + * @internal + */ export const filterSensitiveLog = (obj: AmplitudeConnectorProfileProperties): any => ({ ...obj, }); @@ -79,6 +88,9 @@ export namespace AmplitudeConnectorProfileProperties { export interface AmplitudeMetadata {} export namespace AmplitudeMetadata { + /** + * @internal + */ export const filterSensitiveLog = (obj: AmplitudeMetadata): any => ({ ...obj, }); @@ -99,6 +111,9 @@ export interface AmplitudeSourceProperties { } export namespace AmplitudeSourceProperties { + /** + * @internal + */ export const filterSensitiveLog = (obj: AmplitudeSourceProperties): any => ({ ...obj, }); @@ -116,6 +131,9 @@ export interface ConflictException extends __SmithyException, $MetadataBearer { } export namespace ConflictException { + /** + * @internal + */ export const filterSensitiveLog = (obj: ConflictException): any => ({ ...obj, }); @@ -138,6 +156,9 @@ export interface ConnectorAuthenticationException extends __SmithyException, $Me } export namespace ConnectorAuthenticationException { + /** + * @internal + */ export const filterSensitiveLog = (obj: ConnectorAuthenticationException): any => ({ ...obj, }); @@ -151,6 +172,9 @@ export namespace ConnectorAuthenticationException { export interface CustomerProfilesMetadata {} export namespace CustomerProfilesMetadata { + /** + * @internal + */ export const filterSensitiveLog = (obj: CustomerProfilesMetadata): any => ({ ...obj, }); @@ -164,6 +188,9 @@ export namespace CustomerProfilesMetadata { export interface DatadogMetadata {} export namespace DatadogMetadata { + /** + * @internal + */ export const filterSensitiveLog = (obj: DatadogMetadata): any => ({ ...obj, }); @@ -177,6 +204,9 @@ export namespace DatadogMetadata { export interface DynatraceMetadata {} export namespace DynatraceMetadata { + /** + * @internal + */ export const filterSensitiveLog = (obj: DynatraceMetadata): any => ({ ...obj, }); @@ -190,6 +220,9 @@ export namespace DynatraceMetadata { export interface EventBridgeMetadata {} export namespace EventBridgeMetadata { + /** + * @internal + */ export const filterSensitiveLog = (obj: EventBridgeMetadata): any => ({ ...obj, }); @@ -210,6 +243,9 @@ export interface GoogleAnalyticsMetadata { } export namespace GoogleAnalyticsMetadata { + /** + * @internal + */ export const filterSensitiveLog = (obj: GoogleAnalyticsMetadata): any => ({ ...obj, }); @@ -230,6 +266,9 @@ export interface HoneycodeMetadata { } export namespace HoneycodeMetadata { + /** + * @internal + */ export const filterSensitiveLog = (obj: HoneycodeMetadata): any => ({ ...obj, }); @@ -243,6 +282,9 @@ export namespace HoneycodeMetadata { export interface InforNexusMetadata {} export namespace InforNexusMetadata { + /** + * @internal + */ export const filterSensitiveLog = (obj: InforNexusMetadata): any => ({ ...obj, }); @@ -256,6 +298,9 @@ export namespace InforNexusMetadata { export interface MarketoMetadata {} export namespace MarketoMetadata { + /** + * @internal + */ export const filterSensitiveLog = (obj: MarketoMetadata): any => ({ ...obj, }); @@ -269,6 +314,9 @@ export namespace MarketoMetadata { export interface RedshiftMetadata {} export namespace RedshiftMetadata { + /** + * @internal + */ export const filterSensitiveLog = (obj: RedshiftMetadata): any => ({ ...obj, }); @@ -282,6 +330,9 @@ export namespace RedshiftMetadata { export interface S3Metadata {} export namespace S3Metadata { + /** + * @internal + */ export const filterSensitiveLog = (obj: S3Metadata): any => ({ ...obj, }); @@ -302,6 +353,9 @@ export interface SalesforceMetadata { } export namespace SalesforceMetadata { + /** + * @internal + */ export const filterSensitiveLog = (obj: SalesforceMetadata): any => ({ ...obj, }); @@ -315,6 +369,9 @@ export namespace SalesforceMetadata { export interface ServiceNowMetadata {} export namespace ServiceNowMetadata { + /** + * @internal + */ export const filterSensitiveLog = (obj: ServiceNowMetadata): any => ({ ...obj, }); @@ -328,6 +385,9 @@ export namespace ServiceNowMetadata { export interface SingularMetadata {} export namespace SingularMetadata { + /** + * @internal + */ export const filterSensitiveLog = (obj: SingularMetadata): any => ({ ...obj, }); @@ -348,6 +408,9 @@ export interface SlackMetadata { } export namespace SlackMetadata { + /** + * @internal + */ export const filterSensitiveLog = (obj: SlackMetadata): any => ({ ...obj, }); @@ -368,6 +431,9 @@ export interface SnowflakeMetadata { } export namespace SnowflakeMetadata { + /** + * @internal + */ export const filterSensitiveLog = (obj: SnowflakeMetadata): any => ({ ...obj, }); @@ -381,6 +447,9 @@ export namespace SnowflakeMetadata { export interface TrendmicroMetadata {} export namespace TrendmicroMetadata { + /** + * @internal + */ export const filterSensitiveLog = (obj: TrendmicroMetadata): any => ({ ...obj, }); @@ -394,6 +463,9 @@ export namespace TrendmicroMetadata { export interface UpsolverMetadata {} export namespace UpsolverMetadata { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpsolverMetadata): any => ({ ...obj, }); @@ -407,6 +479,9 @@ export namespace UpsolverMetadata { export interface VeevaMetadata {} export namespace VeevaMetadata { + /** + * @internal + */ export const filterSensitiveLog = (obj: VeevaMetadata): any => ({ ...obj, }); @@ -427,6 +502,9 @@ export interface ZendeskMetadata { } export namespace ZendeskMetadata { + /** + * @internal + */ export const filterSensitiveLog = (obj: ZendeskMetadata): any => ({ ...obj, }); @@ -580,6 +658,9 @@ export interface ConnectorMetadata { } export namespace ConnectorMetadata { + /** + * @internal + */ export const filterSensitiveLog = (obj: ConnectorMetadata): any => ({ ...obj, }); @@ -688,6 +769,9 @@ export interface ConnectorConfiguration { } export namespace ConnectorConfiguration { + /** + * @internal + */ export const filterSensitiveLog = (obj: ConnectorConfiguration): any => ({ ...obj, }); @@ -723,6 +807,9 @@ export interface ConnectorEntity { } export namespace ConnectorEntity { + /** + * @internal + */ export const filterSensitiveLog = (obj: ConnectorEntity): any => ({ ...obj, }); @@ -777,6 +864,9 @@ export interface DestinationFieldProperties { } export namespace DestinationFieldProperties { + /** + * @internal + */ export const filterSensitiveLog = (obj: DestinationFieldProperties): any => ({ ...obj, }); @@ -804,6 +894,9 @@ export interface SourceFieldProperties { } export namespace SourceFieldProperties { + /** + * @internal + */ export const filterSensitiveLog = (obj: SourceFieldProperties): any => ({ ...obj, }); @@ -862,6 +955,9 @@ export interface FieldTypeDetails { } export namespace FieldTypeDetails { + /** + * @internal + */ export const filterSensitiveLog = (obj: FieldTypeDetails): any => ({ ...obj, }); @@ -882,6 +978,9 @@ export interface SupportedFieldTypeDetails { } export namespace SupportedFieldTypeDetails { + /** + * @internal + */ export const filterSensitiveLog = (obj: SupportedFieldTypeDetails): any => ({ ...obj, }); @@ -937,6 +1036,9 @@ export interface ConnectorEntityField { } export namespace ConnectorEntityField { + /** + * @internal + */ export const filterSensitiveLog = (obj: ConnectorEntityField): any => ({ ...obj, }); @@ -964,6 +1066,9 @@ export interface ConnectorOAuthRequest { } export namespace ConnectorOAuthRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ConnectorOAuthRequest): any => ({ ...obj, }); @@ -1321,6 +1426,9 @@ export interface ConnectorOperator { } export namespace ConnectorOperator { + /** + * @internal + */ export const filterSensitiveLog = (obj: ConnectorOperator): any => ({ ...obj, }); @@ -1341,6 +1449,9 @@ export interface DatadogConnectorProfileProperties { } export namespace DatadogConnectorProfileProperties { + /** + * @internal + */ export const filterSensitiveLog = (obj: DatadogConnectorProfileProperties): any => ({ ...obj, }); @@ -1361,6 +1472,9 @@ export interface DynatraceConnectorProfileProperties { } export namespace DynatraceConnectorProfileProperties { + /** + * @internal + */ export const filterSensitiveLog = (obj: DynatraceConnectorProfileProperties): any => ({ ...obj, }); @@ -1374,6 +1488,9 @@ export namespace DynatraceConnectorProfileProperties { export interface GoogleAnalyticsConnectorProfileProperties {} export namespace GoogleAnalyticsConnectorProfileProperties { + /** + * @internal + */ export const filterSensitiveLog = (obj: GoogleAnalyticsConnectorProfileProperties): any => ({ ...obj, }); @@ -1387,6 +1504,9 @@ export namespace GoogleAnalyticsConnectorProfileProperties { export interface HoneycodeConnectorProfileProperties {} export namespace HoneycodeConnectorProfileProperties { + /** + * @internal + */ export const filterSensitiveLog = (obj: HoneycodeConnectorProfileProperties): any => ({ ...obj, }); @@ -1407,6 +1527,9 @@ export interface InforNexusConnectorProfileProperties { } export namespace InforNexusConnectorProfileProperties { + /** + * @internal + */ export const filterSensitiveLog = (obj: InforNexusConnectorProfileProperties): any => ({ ...obj, }); @@ -1427,6 +1550,9 @@ export interface MarketoConnectorProfileProperties { } export namespace MarketoConnectorProfileProperties { + /** + * @internal + */ export const filterSensitiveLog = (obj: MarketoConnectorProfileProperties): any => ({ ...obj, }); @@ -1468,6 +1594,9 @@ export interface RedshiftConnectorProfileProperties { } export namespace RedshiftConnectorProfileProperties { + /** + * @internal + */ export const filterSensitiveLog = (obj: RedshiftConnectorProfileProperties): any => ({ ...obj, }); @@ -1495,6 +1624,9 @@ export interface SalesforceConnectorProfileProperties { } export namespace SalesforceConnectorProfileProperties { + /** + * @internal + */ export const filterSensitiveLog = (obj: SalesforceConnectorProfileProperties): any => ({ ...obj, }); @@ -1515,6 +1647,9 @@ export interface ServiceNowConnectorProfileProperties { } export namespace ServiceNowConnectorProfileProperties { + /** + * @internal + */ export const filterSensitiveLog = (obj: ServiceNowConnectorProfileProperties): any => ({ ...obj, }); @@ -1528,6 +1663,9 @@ export namespace ServiceNowConnectorProfileProperties { export interface SingularConnectorProfileProperties {} export namespace SingularConnectorProfileProperties { + /** + * @internal + */ export const filterSensitiveLog = (obj: SingularConnectorProfileProperties): any => ({ ...obj, }); @@ -1548,6 +1686,9 @@ export interface SlackConnectorProfileProperties { } export namespace SlackConnectorProfileProperties { + /** + * @internal + */ export const filterSensitiveLog = (obj: SlackConnectorProfileProperties): any => ({ ...obj, }); @@ -1610,6 +1751,9 @@ export interface SnowflakeConnectorProfileProperties { } export namespace SnowflakeConnectorProfileProperties { + /** + * @internal + */ export const filterSensitiveLog = (obj: SnowflakeConnectorProfileProperties): any => ({ ...obj, }); @@ -1623,6 +1767,9 @@ export namespace SnowflakeConnectorProfileProperties { export interface TrendmicroConnectorProfileProperties {} export namespace TrendmicroConnectorProfileProperties { + /** + * @internal + */ export const filterSensitiveLog = (obj: TrendmicroConnectorProfileProperties): any => ({ ...obj, }); @@ -1643,6 +1790,9 @@ export interface VeevaConnectorProfileProperties { } export namespace VeevaConnectorProfileProperties { + /** + * @internal + */ export const filterSensitiveLog = (obj: VeevaConnectorProfileProperties): any => ({ ...obj, }); @@ -1663,6 +1813,9 @@ export interface ZendeskConnectorProfileProperties { } export namespace ZendeskConnectorProfileProperties { + /** + * @internal + */ export const filterSensitiveLog = (obj: ZendeskConnectorProfileProperties): any => ({ ...obj, }); @@ -1788,6 +1941,9 @@ export interface ConnectorProfileProperties { } export namespace ConnectorProfileProperties { + /** + * @internal + */ export const filterSensitiveLog = (obj: ConnectorProfileProperties): any => ({ ...obj, }); @@ -1857,6 +2013,9 @@ export interface ConnectorProfile { } export namespace ConnectorProfile { + /** + * @internal + */ export const filterSensitiveLog = (obj: ConnectorProfile): any => ({ ...obj, }); @@ -1884,6 +2043,9 @@ export interface DatadogConnectorProfileCredentials { } export namespace DatadogConnectorProfileCredentials { + /** + * @internal + */ export const filterSensitiveLog = (obj: DatadogConnectorProfileCredentials): any => ({ ...obj, }); @@ -1904,6 +2066,9 @@ export interface DynatraceConnectorProfileCredentials { } export namespace DynatraceConnectorProfileCredentials { + /** + * @internal + */ export const filterSensitiveLog = (obj: DynatraceConnectorProfileCredentials): any => ({ ...obj, }); @@ -1952,6 +2117,9 @@ export interface GoogleAnalyticsConnectorProfileCredentials { } export namespace GoogleAnalyticsConnectorProfileCredentials { + /** + * @internal + */ export const filterSensitiveLog = (obj: GoogleAnalyticsConnectorProfileCredentials): any => ({ ...obj, ...(obj.clientSecret && { clientSecret: SENSITIVE_STRING }), @@ -1988,6 +2156,9 @@ export interface HoneycodeConnectorProfileCredentials { } export namespace HoneycodeConnectorProfileCredentials { + /** + * @internal + */ export const filterSensitiveLog = (obj: HoneycodeConnectorProfileCredentials): any => ({ ...obj, ...(obj.accessToken && { accessToken: SENSITIVE_STRING }), @@ -2030,6 +2201,9 @@ export interface InforNexusConnectorProfileCredentials { } export namespace InforNexusConnectorProfileCredentials { + /** + * @internal + */ export const filterSensitiveLog = (obj: InforNexusConnectorProfileCredentials): any => ({ ...obj, ...(obj.accessKeyId && { accessKeyId: SENSITIVE_STRING }), @@ -2072,6 +2246,9 @@ export interface MarketoConnectorProfileCredentials { } export namespace MarketoConnectorProfileCredentials { + /** + * @internal + */ export const filterSensitiveLog = (obj: MarketoConnectorProfileCredentials): any => ({ ...obj, ...(obj.clientSecret && { clientSecret: SENSITIVE_STRING }), @@ -2101,6 +2278,9 @@ export interface RedshiftConnectorProfileCredentials { } export namespace RedshiftConnectorProfileCredentials { + /** + * @internal + */ export const filterSensitiveLog = (obj: RedshiftConnectorProfileCredentials): any => ({ ...obj, ...(obj.password && { password: SENSITIVE_STRING }), @@ -2143,6 +2323,9 @@ export interface SalesforceConnectorProfileCredentials { } export namespace SalesforceConnectorProfileCredentials { + /** + * @internal + */ export const filterSensitiveLog = (obj: SalesforceConnectorProfileCredentials): any => ({ ...obj, ...(obj.accessToken && { accessToken: SENSITIVE_STRING }), @@ -2172,6 +2355,9 @@ export interface ServiceNowConnectorProfileCredentials { } export namespace ServiceNowConnectorProfileCredentials { + /** + * @internal + */ export const filterSensitiveLog = (obj: ServiceNowConnectorProfileCredentials): any => ({ ...obj, ...(obj.password && { password: SENSITIVE_STRING }), @@ -2192,6 +2378,9 @@ export interface SingularConnectorProfileCredentials { } export namespace SingularConnectorProfileCredentials { + /** + * @internal + */ export const filterSensitiveLog = (obj: SingularConnectorProfileCredentials): any => ({ ...obj, }); @@ -2233,6 +2422,9 @@ export interface SlackConnectorProfileCredentials { } export namespace SlackConnectorProfileCredentials { + /** + * @internal + */ export const filterSensitiveLog = (obj: SlackConnectorProfileCredentials): any => ({ ...obj, ...(obj.clientSecret && { clientSecret: SENSITIVE_STRING }), @@ -2262,6 +2454,9 @@ export interface SnowflakeConnectorProfileCredentials { } export namespace SnowflakeConnectorProfileCredentials { + /** + * @internal + */ export const filterSensitiveLog = (obj: SnowflakeConnectorProfileCredentials): any => ({ ...obj, ...(obj.password && { password: SENSITIVE_STRING }), @@ -2283,6 +2478,9 @@ export interface TrendmicroConnectorProfileCredentials { } export namespace TrendmicroConnectorProfileCredentials { + /** + * @internal + */ export const filterSensitiveLog = (obj: TrendmicroConnectorProfileCredentials): any => ({ ...obj, ...(obj.apiSecretKey && { apiSecretKey: SENSITIVE_STRING }), @@ -2311,6 +2509,9 @@ export interface VeevaConnectorProfileCredentials { } export namespace VeevaConnectorProfileCredentials { + /** + * @internal + */ export const filterSensitiveLog = (obj: VeevaConnectorProfileCredentials): any => ({ ...obj, ...(obj.password && { password: SENSITIVE_STRING }), @@ -2353,6 +2554,9 @@ export interface ZendeskConnectorProfileCredentials { } export namespace ZendeskConnectorProfileCredentials { + /** + * @internal + */ export const filterSensitiveLog = (obj: ZendeskConnectorProfileCredentials): any => ({ ...obj, ...(obj.clientSecret && { clientSecret: SENSITIVE_STRING }), @@ -2480,6 +2684,9 @@ export interface ConnectorProfileCredentials { } export namespace ConnectorProfileCredentials { + /** + * @internal + */ export const filterSensitiveLog = (obj: ConnectorProfileCredentials): any => ({ ...obj, ...(obj.Amplitude && { Amplitude: AmplitudeConnectorProfileCredentials.filterSensitiveLog(obj.Amplitude) }), @@ -2522,6 +2729,9 @@ export interface ConnectorProfileConfig { } export namespace ConnectorProfileConfig { + /** + * @internal + */ export const filterSensitiveLog = (obj: ConnectorProfileConfig): any => ({ ...obj, ...(obj.connectorProfileCredentials && { @@ -2542,6 +2752,9 @@ export interface ConnectorServerException extends __SmithyException, $MetadataBe } export namespace ConnectorServerException { + /** + * @internal + */ export const filterSensitiveLog = (obj: ConnectorServerException): any => ({ ...obj, }); @@ -2585,6 +2798,9 @@ export interface CreateConnectorProfileRequest { } export namespace CreateConnectorProfileRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateConnectorProfileRequest): any => ({ ...obj, }); @@ -2600,6 +2816,9 @@ export interface CreateConnectorProfileResponse { } export namespace CreateConnectorProfileResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateConnectorProfileResponse): any => ({ ...obj, }); @@ -2617,6 +2836,9 @@ export interface InternalServerException extends __SmithyException, $MetadataBea } export namespace InternalServerException { + /** + * @internal + */ export const filterSensitiveLog = (obj: InternalServerException): any => ({ ...obj, }); @@ -2634,6 +2856,9 @@ export interface ServiceQuotaExceededException extends __SmithyException, $Metad } export namespace ServiceQuotaExceededException { + /** + * @internal + */ export const filterSensitiveLog = (obj: ServiceQuotaExceededException): any => ({ ...obj, }); @@ -2651,6 +2876,9 @@ export interface ValidationException extends __SmithyException, $MetadataBearer } export namespace ValidationException { + /** + * @internal + */ export const filterSensitiveLog = (obj: ValidationException): any => ({ ...obj, }); @@ -2678,6 +2906,9 @@ export interface CustomerProfilesDestinationProperties { } export namespace CustomerProfilesDestinationProperties { + /** + * @internal + */ export const filterSensitiveLog = (obj: CustomerProfilesDestinationProperties): any => ({ ...obj, }); @@ -2713,6 +2944,9 @@ export interface ErrorHandlingConfig { } export namespace ErrorHandlingConfig { + /** + * @internal + */ export const filterSensitiveLog = (obj: ErrorHandlingConfig): any => ({ ...obj, }); @@ -2741,6 +2975,9 @@ export interface EventBridgeDestinationProperties { } export namespace EventBridgeDestinationProperties { + /** + * @internal + */ export const filterSensitiveLog = (obj: EventBridgeDestinationProperties): any => ({ ...obj, }); @@ -2769,6 +3006,9 @@ export interface HoneycodeDestinationProperties { } export namespace HoneycodeDestinationProperties { + /** + * @internal + */ export const filterSensitiveLog = (obj: HoneycodeDestinationProperties): any => ({ ...obj, }); @@ -2782,6 +3022,9 @@ export namespace HoneycodeDestinationProperties { export interface LookoutMetricsDestinationProperties {} export namespace LookoutMetricsDestinationProperties { + /** + * @internal + */ export const filterSensitiveLog = (obj: LookoutMetricsDestinationProperties): any => ({ ...obj, }); @@ -2823,6 +3066,9 @@ export interface RedshiftDestinationProperties { } export namespace RedshiftDestinationProperties { + /** + * @internal + */ export const filterSensitiveLog = (obj: RedshiftDestinationProperties): any => ({ ...obj, }); @@ -2870,6 +3116,9 @@ export interface PrefixConfig { } export namespace PrefixConfig { + /** + * @internal + */ export const filterSensitiveLog = (obj: PrefixConfig): any => ({ ...obj, }); @@ -2904,6 +3153,9 @@ export interface S3OutputFormatConfig { } export namespace S3OutputFormatConfig { + /** + * @internal + */ export const filterSensitiveLog = (obj: S3OutputFormatConfig): any => ({ ...obj, }); @@ -2938,6 +3190,9 @@ export interface S3DestinationProperties { } export namespace S3DestinationProperties { + /** + * @internal + */ export const filterSensitiveLog = (obj: S3DestinationProperties): any => ({ ...obj, }); @@ -2979,6 +3234,9 @@ export interface SalesforceDestinationProperties { } export namespace SalesforceDestinationProperties { + /** + * @internal + */ export const filterSensitiveLog = (obj: SalesforceDestinationProperties): any => ({ ...obj, }); @@ -3020,6 +3278,9 @@ export interface SnowflakeDestinationProperties { } export namespace SnowflakeDestinationProperties { + /** + * @internal + */ export const filterSensitiveLog = (obj: SnowflakeDestinationProperties): any => ({ ...obj, }); @@ -3054,6 +3315,9 @@ export interface UpsolverS3OutputFormatConfig { } export namespace UpsolverS3OutputFormatConfig { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpsolverS3OutputFormatConfig): any => ({ ...obj, }); @@ -3088,6 +3352,9 @@ export interface UpsolverDestinationProperties { } export namespace UpsolverDestinationProperties { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpsolverDestinationProperties): any => ({ ...obj, }); @@ -3119,6 +3386,9 @@ export interface ZendeskDestinationProperties { } export namespace ZendeskDestinationProperties { + /** + * @internal + */ export const filterSensitiveLog = (obj: ZendeskDestinationProperties): any => ({ ...obj, }); @@ -3197,6 +3467,9 @@ export interface DestinationConnectorProperties { } export namespace DestinationConnectorProperties { + /** + * @internal + */ export const filterSensitiveLog = (obj: DestinationConnectorProperties): any => ({ ...obj, }); @@ -3231,6 +3504,9 @@ export interface DestinationFlowConfig { } export namespace DestinationFlowConfig { + /** + * @internal + */ export const filterSensitiveLog = (obj: DestinationFlowConfig): any => ({ ...obj, }); @@ -3251,6 +3527,9 @@ export interface IncrementalPullConfig { } export namespace IncrementalPullConfig { + /** + * @internal + */ export const filterSensitiveLog = (obj: IncrementalPullConfig): any => ({ ...obj, }); @@ -3271,6 +3550,9 @@ export interface DatadogSourceProperties { } export namespace DatadogSourceProperties { + /** + * @internal + */ export const filterSensitiveLog = (obj: DatadogSourceProperties): any => ({ ...obj, }); @@ -3291,6 +3573,9 @@ export interface DynatraceSourceProperties { } export namespace DynatraceSourceProperties { + /** + * @internal + */ export const filterSensitiveLog = (obj: DynatraceSourceProperties): any => ({ ...obj, }); @@ -3311,6 +3596,9 @@ export interface GoogleAnalyticsSourceProperties { } export namespace GoogleAnalyticsSourceProperties { + /** + * @internal + */ export const filterSensitiveLog = (obj: GoogleAnalyticsSourceProperties): any => ({ ...obj, }); @@ -3331,6 +3619,9 @@ export interface InforNexusSourceProperties { } export namespace InforNexusSourceProperties { + /** + * @internal + */ export const filterSensitiveLog = (obj: InforNexusSourceProperties): any => ({ ...obj, }); @@ -3351,6 +3642,9 @@ export interface MarketoSourceProperties { } export namespace MarketoSourceProperties { + /** + * @internal + */ export const filterSensitiveLog = (obj: MarketoSourceProperties): any => ({ ...obj, }); @@ -3378,6 +3672,9 @@ export interface S3SourceProperties { } export namespace S3SourceProperties { + /** + * @internal + */ export const filterSensitiveLog = (obj: S3SourceProperties): any => ({ ...obj, }); @@ -3412,6 +3709,9 @@ export interface SalesforceSourceProperties { } export namespace SalesforceSourceProperties { + /** + * @internal + */ export const filterSensitiveLog = (obj: SalesforceSourceProperties): any => ({ ...obj, }); @@ -3432,6 +3732,9 @@ export interface ServiceNowSourceProperties { } export namespace ServiceNowSourceProperties { + /** + * @internal + */ export const filterSensitiveLog = (obj: ServiceNowSourceProperties): any => ({ ...obj, }); @@ -3452,6 +3755,9 @@ export interface SingularSourceProperties { } export namespace SingularSourceProperties { + /** + * @internal + */ export const filterSensitiveLog = (obj: SingularSourceProperties): any => ({ ...obj, }); @@ -3472,6 +3778,9 @@ export interface SlackSourceProperties { } export namespace SlackSourceProperties { + /** + * @internal + */ export const filterSensitiveLog = (obj: SlackSourceProperties): any => ({ ...obj, }); @@ -3492,6 +3801,9 @@ export interface TrendmicroSourceProperties { } export namespace TrendmicroSourceProperties { + /** + * @internal + */ export const filterSensitiveLog = (obj: TrendmicroSourceProperties): any => ({ ...obj, }); @@ -3512,6 +3824,9 @@ export interface VeevaSourceProperties { } export namespace VeevaSourceProperties { + /** + * @internal + */ export const filterSensitiveLog = (obj: VeevaSourceProperties): any => ({ ...obj, }); @@ -3532,6 +3847,9 @@ export interface ZendeskSourceProperties { } export namespace ZendeskSourceProperties { + /** + * @internal + */ export const filterSensitiveLog = (obj: ZendeskSourceProperties): any => ({ ...obj, }); @@ -3643,6 +3961,9 @@ export interface SourceConnectorProperties { } export namespace SourceConnectorProperties { + /** + * @internal + */ export const filterSensitiveLog = (obj: SourceConnectorProperties): any => ({ ...obj, }); @@ -3684,6 +4005,9 @@ export interface SourceFlowConfig { } export namespace SourceFlowConfig { + /** + * @internal + */ export const filterSensitiveLog = (obj: SourceFlowConfig): any => ({ ...obj, }); @@ -3759,6 +4083,9 @@ export interface Task { } export namespace Task { + /** + * @internal + */ export const filterSensitiveLog = (obj: Task): any => ({ ...obj, }); @@ -3826,6 +4153,9 @@ export interface ScheduledTriggerProperties { } export namespace ScheduledTriggerProperties { + /** + * @internal + */ export const filterSensitiveLog = (obj: ScheduledTriggerProperties): any => ({ ...obj, }); @@ -3846,6 +4176,9 @@ export interface TriggerProperties { } export namespace TriggerProperties { + /** + * @internal + */ export const filterSensitiveLog = (obj: TriggerProperties): any => ({ ...obj, }); @@ -3875,6 +4208,9 @@ export interface TriggerConfig { } export namespace TriggerConfig { + /** + * @internal + */ export const filterSensitiveLog = (obj: TriggerConfig): any => ({ ...obj, }); @@ -3939,6 +4275,9 @@ export interface CreateFlowRequest { } export namespace CreateFlowRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateFlowRequest): any => ({ ...obj, }); @@ -3970,6 +4309,9 @@ export interface CreateFlowResponse { } export namespace CreateFlowResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateFlowResponse): any => ({ ...obj, }); @@ -3987,6 +4329,9 @@ export interface ResourceNotFoundException extends __SmithyException, $MetadataB } export namespace ResourceNotFoundException { + /** + * @internal + */ export const filterSensitiveLog = (obj: ResourceNotFoundException): any => ({ ...obj, }); @@ -4009,6 +4354,9 @@ export interface DeleteConnectorProfileRequest { } export namespace DeleteConnectorProfileRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteConnectorProfileRequest): any => ({ ...obj, }); @@ -4017,6 +4365,9 @@ export namespace DeleteConnectorProfileRequest { export interface DeleteConnectorProfileResponse {} export namespace DeleteConnectorProfileResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteConnectorProfileResponse): any => ({ ...obj, }); @@ -4039,6 +4390,9 @@ export interface DeleteFlowRequest { } export namespace DeleteFlowRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteFlowRequest): any => ({ ...obj, }); @@ -4047,6 +4401,9 @@ export namespace DeleteFlowRequest { export interface DeleteFlowResponse {} export namespace DeleteFlowResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteFlowResponse): any => ({ ...obj, }); @@ -4076,6 +4433,9 @@ export interface DescribeConnectorEntityRequest { } export namespace DescribeConnectorEntityRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeConnectorEntityRequest): any => ({ ...obj, }); @@ -4091,6 +4451,9 @@ export interface DescribeConnectorEntityResponse { } export namespace DescribeConnectorEntityResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeConnectorEntityResponse): any => ({ ...obj, }); @@ -4127,6 +4490,9 @@ export interface DescribeConnectorProfilesRequest { } export namespace DescribeConnectorProfilesRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeConnectorProfilesRequest): any => ({ ...obj, }); @@ -4149,6 +4515,9 @@ export interface DescribeConnectorProfilesResponse { } export namespace DescribeConnectorProfilesResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeConnectorProfilesResponse): any => ({ ...obj, }); @@ -4171,6 +4540,9 @@ export interface DescribeConnectorsRequest { } export namespace DescribeConnectorsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeConnectorsRequest): any => ({ ...obj, }); @@ -4193,6 +4565,9 @@ export interface DescribeConnectorsResponse { } export namespace DescribeConnectorsResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeConnectorsResponse): any => ({ ...obj, }); @@ -4208,6 +4583,9 @@ export interface DescribeFlowRequest { } export namespace DescribeFlowRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeFlowRequest): any => ({ ...obj, }); @@ -4248,6 +4626,9 @@ export interface ExecutionDetails { } export namespace ExecutionDetails { + /** + * @internal + */ export const filterSensitiveLog = (obj: ExecutionDetails): any => ({ ...obj, }); @@ -4368,6 +4749,9 @@ export interface DescribeFlowResponse { } export namespace DescribeFlowResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeFlowResponse): any => ({ ...obj, }); @@ -4397,6 +4781,9 @@ export interface DescribeFlowExecutionRecordsRequest { } export namespace DescribeFlowExecutionRecordsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeFlowExecutionRecordsRequest): any => ({ ...obj, }); @@ -4424,6 +4811,9 @@ export interface ErrorInfo { } export namespace ErrorInfo { + /** + * @internal + */ export const filterSensitiveLog = (obj: ErrorInfo): any => ({ ...obj, }); @@ -4465,6 +4855,9 @@ export interface ExecutionResult { } export namespace ExecutionResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: ExecutionResult): any => ({ ...obj, }); @@ -4527,6 +4920,9 @@ export interface ExecutionRecord { } export namespace ExecutionRecord { + /** + * @internal + */ export const filterSensitiveLog = (obj: ExecutionRecord): any => ({ ...obj, }); @@ -4549,6 +4945,9 @@ export interface DescribeFlowExecutionRecordsResponse { } export namespace DescribeFlowExecutionRecordsResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeFlowExecutionRecordsResponse): any => ({ ...obj, }); @@ -4653,6 +5052,9 @@ export interface FlowDefinition { } export namespace FlowDefinition { + /** + * @internal + */ export const filterSensitiveLog = (obj: FlowDefinition): any => ({ ...obj, }); @@ -4682,6 +5084,9 @@ export interface ListConnectorEntitiesRequest { } export namespace ListConnectorEntitiesRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListConnectorEntitiesRequest): any => ({ ...obj, }); @@ -4697,6 +5102,9 @@ export interface ListConnectorEntitiesResponse { } export namespace ListConnectorEntitiesResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListConnectorEntitiesResponse): any => ({ ...obj, }); @@ -4719,6 +5127,9 @@ export interface ListFlowsRequest { } export namespace ListFlowsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListFlowsRequest): any => ({ ...obj, }); @@ -4741,6 +5152,9 @@ export interface ListFlowsResponse { } export namespace ListFlowsResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListFlowsResponse): any => ({ ...obj, }); @@ -4756,6 +5170,9 @@ export interface ListTagsForResourceRequest { } export namespace ListTagsForResourceRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListTagsForResourceRequest): any => ({ ...obj, }); @@ -4771,6 +5188,9 @@ export interface ListTagsForResourceResponse { } export namespace ListTagsForResourceResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListTagsForResourceResponse): any => ({ ...obj, }); @@ -4786,6 +5206,9 @@ export interface StartFlowRequest { } export namespace StartFlowRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: StartFlowRequest): any => ({ ...obj, }); @@ -4816,6 +5239,9 @@ export interface StartFlowResponse { } export namespace StartFlowResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: StartFlowResponse): any => ({ ...obj, }); @@ -4831,6 +5257,9 @@ export interface StopFlowRequest { } export namespace StopFlowRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: StopFlowRequest): any => ({ ...obj, }); @@ -4853,6 +5282,9 @@ export interface StopFlowResponse { } export namespace StopFlowResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: StopFlowResponse): any => ({ ...obj, }); @@ -4870,6 +5302,9 @@ export interface UnsupportedOperationException extends __SmithyException, $Metad } export namespace UnsupportedOperationException { + /** + * @internal + */ export const filterSensitiveLog = (obj: UnsupportedOperationException): any => ({ ...obj, }); @@ -4892,6 +5327,9 @@ export interface TagResourceRequest { } export namespace TagResourceRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: TagResourceRequest): any => ({ ...obj, }); @@ -4900,6 +5338,9 @@ export namespace TagResourceRequest { export interface TagResourceResponse {} export namespace TagResourceResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: TagResourceResponse): any => ({ ...obj, }); @@ -4922,6 +5363,9 @@ export interface UntagResourceRequest { } export namespace UntagResourceRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: UntagResourceRequest): any => ({ ...obj, }); @@ -4930,6 +5374,9 @@ export namespace UntagResourceRequest { export interface UntagResourceResponse {} export namespace UntagResourceResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: UntagResourceResponse): any => ({ ...obj, }); @@ -4959,6 +5406,9 @@ export interface UpdateConnectorProfileRequest { } export namespace UpdateConnectorProfileRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateConnectorProfileRequest): any => ({ ...obj, }); @@ -4974,6 +5424,9 @@ export interface UpdateConnectorProfileResponse { } export namespace UpdateConnectorProfileResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateConnectorProfileResponse): any => ({ ...obj, }); @@ -5024,6 +5477,9 @@ export interface UpdateFlowRequest { } export namespace UpdateFlowRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateFlowRequest): any => ({ ...obj, }); @@ -5038,6 +5494,9 @@ export interface UpdateFlowResponse { } export namespace UpdateFlowResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateFlowResponse): any => ({ ...obj, }); diff --git a/clients/client-appintegrations/commands/CreateEventIntegrationCommand.ts b/clients/client-appintegrations/commands/CreateEventIntegrationCommand.ts index fd22ec254a02..6731065c7512 100644 --- a/clients/client-appintegrations/commands/CreateEventIntegrationCommand.ts +++ b/clients/client-appintegrations/commands/CreateEventIntegrationCommand.ts @@ -26,6 +26,20 @@ export interface CreateEventIntegrationCommandOutput extends CreateEventIntegrat * Amazon Eventbridge bus in your account and a partner event source that will push events to that bus. No * objects are created in the your account, only metadata that is persisted on the EventIntegration * control plane.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { AppIntegrationsClient, CreateEventIntegrationCommand } from "@aws-sdk/client-appintegrations"; // ES Modules import + * // const { AppIntegrationsClient, CreateEventIntegrationCommand } = require("@aws-sdk/client-appintegrations"); // CommonJS import + * const client = new AppIntegrationsClient(config); + * const command = new CreateEventIntegrationCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreateEventIntegrationCommandInput} for command's `input` shape. + * @see {@link CreateEventIntegrationCommandOutput} for command's `response` shape. + * @see {@link AppIntegrationsClientResolvedConfig | config} for command's `input` shape. + * */ export class CreateEventIntegrationCommand extends $Command< CreateEventIntegrationCommandInput, diff --git a/clients/client-appintegrations/commands/DeleteEventIntegrationCommand.ts b/clients/client-appintegrations/commands/DeleteEventIntegrationCommand.ts index ab2eea106fa9..bfffb41be76d 100644 --- a/clients/client-appintegrations/commands/DeleteEventIntegrationCommand.ts +++ b/clients/client-appintegrations/commands/DeleteEventIntegrationCommand.ts @@ -24,6 +24,20 @@ export interface DeleteEventIntegrationCommandOutput extends DeleteEventIntegrat *

The Amazon AppIntegrations APIs are in preview release and are subject to change.

*

Deletes the specified existing event integration. If the event integration is associated * with clients, the request is rejected.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { AppIntegrationsClient, DeleteEventIntegrationCommand } from "@aws-sdk/client-appintegrations"; // ES Modules import + * // const { AppIntegrationsClient, DeleteEventIntegrationCommand } = require("@aws-sdk/client-appintegrations"); // CommonJS import + * const client = new AppIntegrationsClient(config); + * const command = new DeleteEventIntegrationCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteEventIntegrationCommandInput} for command's `input` shape. + * @see {@link DeleteEventIntegrationCommandOutput} for command's `response` shape. + * @see {@link AppIntegrationsClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteEventIntegrationCommand extends $Command< DeleteEventIntegrationCommandInput, diff --git a/clients/client-appintegrations/commands/GetEventIntegrationCommand.ts b/clients/client-appintegrations/commands/GetEventIntegrationCommand.ts index a622c372420f..9effb015f320 100644 --- a/clients/client-appintegrations/commands/GetEventIntegrationCommand.ts +++ b/clients/client-appintegrations/commands/GetEventIntegrationCommand.ts @@ -23,6 +23,20 @@ export interface GetEventIntegrationCommandOutput extends GetEventIntegrationRes /** *

The Amazon AppIntegrations APIs are in preview release and are subject to change.

*

Return information about the event integration.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { AppIntegrationsClient, GetEventIntegrationCommand } from "@aws-sdk/client-appintegrations"; // ES Modules import + * // const { AppIntegrationsClient, GetEventIntegrationCommand } = require("@aws-sdk/client-appintegrations"); // CommonJS import + * const client = new AppIntegrationsClient(config); + * const command = new GetEventIntegrationCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetEventIntegrationCommandInput} for command's `input` shape. + * @see {@link GetEventIntegrationCommandOutput} for command's `response` shape. + * @see {@link AppIntegrationsClientResolvedConfig | config} for command's `input` shape. + * */ export class GetEventIntegrationCommand extends $Command< GetEventIntegrationCommandInput, diff --git a/clients/client-appintegrations/commands/ListEventIntegrationAssociationsCommand.ts b/clients/client-appintegrations/commands/ListEventIntegrationAssociationsCommand.ts index 5dba1f5333be..f6b3ed23d65a 100644 --- a/clients/client-appintegrations/commands/ListEventIntegrationAssociationsCommand.ts +++ b/clients/client-appintegrations/commands/ListEventIntegrationAssociationsCommand.ts @@ -25,6 +25,20 @@ export interface ListEventIntegrationAssociationsCommandOutput /** *

The Amazon AppIntegrations APIs are in preview release and are subject to change.

*

Returns a paginated list of event integration associations in the account.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { AppIntegrationsClient, ListEventIntegrationAssociationsCommand } from "@aws-sdk/client-appintegrations"; // ES Modules import + * // const { AppIntegrationsClient, ListEventIntegrationAssociationsCommand } = require("@aws-sdk/client-appintegrations"); // CommonJS import + * const client = new AppIntegrationsClient(config); + * const command = new ListEventIntegrationAssociationsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListEventIntegrationAssociationsCommandInput} for command's `input` shape. + * @see {@link ListEventIntegrationAssociationsCommandOutput} for command's `response` shape. + * @see {@link AppIntegrationsClientResolvedConfig | config} for command's `input` shape. + * */ export class ListEventIntegrationAssociationsCommand extends $Command< ListEventIntegrationAssociationsCommandInput, diff --git a/clients/client-appintegrations/commands/ListEventIntegrationsCommand.ts b/clients/client-appintegrations/commands/ListEventIntegrationsCommand.ts index ad97d185c466..324b84af56af 100644 --- a/clients/client-appintegrations/commands/ListEventIntegrationsCommand.ts +++ b/clients/client-appintegrations/commands/ListEventIntegrationsCommand.ts @@ -23,6 +23,20 @@ export interface ListEventIntegrationsCommandOutput extends ListEventIntegration /** *

The Amazon AppIntegrations APIs are in preview release and are subject to change.

*

Returns a paginated list of event integrations in the account.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { AppIntegrationsClient, ListEventIntegrationsCommand } from "@aws-sdk/client-appintegrations"; // ES Modules import + * // const { AppIntegrationsClient, ListEventIntegrationsCommand } = require("@aws-sdk/client-appintegrations"); // CommonJS import + * const client = new AppIntegrationsClient(config); + * const command = new ListEventIntegrationsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListEventIntegrationsCommandInput} for command's `input` shape. + * @see {@link ListEventIntegrationsCommandOutput} for command's `response` shape. + * @see {@link AppIntegrationsClientResolvedConfig | config} for command's `input` shape. + * */ export class ListEventIntegrationsCommand extends $Command< ListEventIntegrationsCommandInput, diff --git a/clients/client-appintegrations/commands/ListTagsForResourceCommand.ts b/clients/client-appintegrations/commands/ListTagsForResourceCommand.ts index 4e6be1878b05..6ac1861fdb3e 100644 --- a/clients/client-appintegrations/commands/ListTagsForResourceCommand.ts +++ b/clients/client-appintegrations/commands/ListTagsForResourceCommand.ts @@ -23,6 +23,20 @@ export interface ListTagsForResourceCommandOutput extends ListTagsForResourceRes /** *

The Amazon AppIntegrations APIs are in preview release and are subject to change.

*

Lists the tags for the specified resource.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { AppIntegrationsClient, ListTagsForResourceCommand } from "@aws-sdk/client-appintegrations"; // ES Modules import + * // const { AppIntegrationsClient, ListTagsForResourceCommand } = require("@aws-sdk/client-appintegrations"); // CommonJS import + * const client = new AppIntegrationsClient(config); + * const command = new ListTagsForResourceCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListTagsForResourceCommandInput} for command's `input` shape. + * @see {@link ListTagsForResourceCommandOutput} for command's `response` shape. + * @see {@link AppIntegrationsClientResolvedConfig | config} for command's `input` shape. + * */ export class ListTagsForResourceCommand extends $Command< ListTagsForResourceCommandInput, diff --git a/clients/client-appintegrations/commands/TagResourceCommand.ts b/clients/client-appintegrations/commands/TagResourceCommand.ts index 2b1e1663c694..99a6bcc6f8af 100644 --- a/clients/client-appintegrations/commands/TagResourceCommand.ts +++ b/clients/client-appintegrations/commands/TagResourceCommand.ts @@ -23,6 +23,20 @@ export interface TagResourceCommandOutput extends TagResourceResponse, __Metadat /** *

The Amazon AppIntegrations APIs are in preview release and are subject to change.

*

Adds the specified tags to the specified resource.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { AppIntegrationsClient, TagResourceCommand } from "@aws-sdk/client-appintegrations"; // ES Modules import + * // const { AppIntegrationsClient, TagResourceCommand } = require("@aws-sdk/client-appintegrations"); // CommonJS import + * const client = new AppIntegrationsClient(config); + * const command = new TagResourceCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link TagResourceCommandInput} for command's `input` shape. + * @see {@link TagResourceCommandOutput} for command's `response` shape. + * @see {@link AppIntegrationsClientResolvedConfig | config} for command's `input` shape. + * */ export class TagResourceCommand extends $Command< TagResourceCommandInput, diff --git a/clients/client-appintegrations/commands/UntagResourceCommand.ts b/clients/client-appintegrations/commands/UntagResourceCommand.ts index 7ef8a4dee9b3..10051fdcd856 100644 --- a/clients/client-appintegrations/commands/UntagResourceCommand.ts +++ b/clients/client-appintegrations/commands/UntagResourceCommand.ts @@ -23,6 +23,20 @@ export interface UntagResourceCommandOutput extends UntagResourceResponse, __Met /** *

The Amazon AppIntegrations APIs are in preview release and are subject to change.

*

Removes the specified tags from the specified resource.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { AppIntegrationsClient, UntagResourceCommand } from "@aws-sdk/client-appintegrations"; // ES Modules import + * // const { AppIntegrationsClient, UntagResourceCommand } = require("@aws-sdk/client-appintegrations"); // CommonJS import + * const client = new AppIntegrationsClient(config); + * const command = new UntagResourceCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link UntagResourceCommandInput} for command's `input` shape. + * @see {@link UntagResourceCommandOutput} for command's `response` shape. + * @see {@link AppIntegrationsClientResolvedConfig | config} for command's `input` shape. + * */ export class UntagResourceCommand extends $Command< UntagResourceCommandInput, diff --git a/clients/client-appintegrations/commands/UpdateEventIntegrationCommand.ts b/clients/client-appintegrations/commands/UpdateEventIntegrationCommand.ts index b08204864dcc..5068c1d4a44f 100644 --- a/clients/client-appintegrations/commands/UpdateEventIntegrationCommand.ts +++ b/clients/client-appintegrations/commands/UpdateEventIntegrationCommand.ts @@ -23,6 +23,20 @@ export interface UpdateEventIntegrationCommandOutput extends UpdateEventIntegrat /** *

The Amazon AppIntegrations APIs are in preview release and are subject to change.

*

Updates the description of an event integration.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { AppIntegrationsClient, UpdateEventIntegrationCommand } from "@aws-sdk/client-appintegrations"; // ES Modules import + * // const { AppIntegrationsClient, UpdateEventIntegrationCommand } = require("@aws-sdk/client-appintegrations"); // CommonJS import + * const client = new AppIntegrationsClient(config); + * const command = new UpdateEventIntegrationCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link UpdateEventIntegrationCommandInput} for command's `input` shape. + * @see {@link UpdateEventIntegrationCommandOutput} for command's `response` shape. + * @see {@link AppIntegrationsClientResolvedConfig | config} for command's `input` shape. + * */ export class UpdateEventIntegrationCommand extends $Command< UpdateEventIntegrationCommandInput, diff --git a/clients/client-appintegrations/models/models_0.ts b/clients/client-appintegrations/models/models_0.ts index fc886831d474..702d4b7612bc 100644 --- a/clients/client-appintegrations/models/models_0.ts +++ b/clients/client-appintegrations/models/models_0.ts @@ -11,6 +11,9 @@ export interface AccessDeniedException extends __SmithyException, $MetadataBeare } export namespace AccessDeniedException { + /** + * @internal + */ export const filterSensitiveLog = (obj: AccessDeniedException): any => ({ ...obj, }); @@ -28,6 +31,9 @@ export interface EventFilter { } export namespace EventFilter { + /** + * @internal + */ export const filterSensitiveLog = (obj: EventFilter): any => ({ ...obj, }); @@ -67,6 +73,9 @@ export interface CreateEventIntegrationRequest { } export namespace CreateEventIntegrationRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateEventIntegrationRequest): any => ({ ...obj, }); @@ -80,6 +89,9 @@ export interface CreateEventIntegrationResponse { } export namespace CreateEventIntegrationResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateEventIntegrationResponse): any => ({ ...obj, }); @@ -95,6 +107,9 @@ export interface DuplicateResourceException extends __SmithyException, $Metadata } export namespace DuplicateResourceException { + /** + * @internal + */ export const filterSensitiveLog = (obj: DuplicateResourceException): any => ({ ...obj, }); @@ -110,6 +125,9 @@ export interface InternalServiceError extends __SmithyException, $MetadataBearer } export namespace InternalServiceError { + /** + * @internal + */ export const filterSensitiveLog = (obj: InternalServiceError): any => ({ ...obj, }); @@ -125,6 +143,9 @@ export interface InvalidRequestException extends __SmithyException, $MetadataBea } export namespace InvalidRequestException { + /** + * @internal + */ export const filterSensitiveLog = (obj: InvalidRequestException): any => ({ ...obj, }); @@ -140,6 +161,9 @@ export interface ResourceQuotaExceededException extends __SmithyException, $Meta } export namespace ResourceQuotaExceededException { + /** + * @internal + */ export const filterSensitiveLog = (obj: ResourceQuotaExceededException): any => ({ ...obj, }); @@ -155,6 +179,9 @@ export interface ThrottlingException extends __SmithyException, $MetadataBearer } export namespace ThrottlingException { + /** + * @internal + */ export const filterSensitiveLog = (obj: ThrottlingException): any => ({ ...obj, }); @@ -168,6 +195,9 @@ export interface DeleteEventIntegrationRequest { } export namespace DeleteEventIntegrationRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteEventIntegrationRequest): any => ({ ...obj, }); @@ -176,6 +206,9 @@ export namespace DeleteEventIntegrationRequest { export interface DeleteEventIntegrationResponse {} export namespace DeleteEventIntegrationResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteEventIntegrationResponse): any => ({ ...obj, }); @@ -191,6 +224,9 @@ export interface ResourceNotFoundException extends __SmithyException, $MetadataB } export namespace ResourceNotFoundException { + /** + * @internal + */ export const filterSensitiveLog = (obj: ResourceNotFoundException): any => ({ ...obj, }); @@ -204,6 +240,9 @@ export interface GetEventIntegrationRequest { } export namespace GetEventIntegrationRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetEventIntegrationRequest): any => ({ ...obj, }); @@ -242,6 +281,9 @@ export interface GetEventIntegrationResponse { } export namespace GetEventIntegrationResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetEventIntegrationResponse): any => ({ ...obj, }); @@ -266,6 +308,9 @@ export interface ListEventIntegrationAssociationsRequest { } export namespace ListEventIntegrationAssociationsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListEventIntegrationAssociationsRequest): any => ({ ...obj, }); @@ -308,6 +353,9 @@ export interface EventIntegrationAssociation { } export namespace EventIntegrationAssociation { + /** + * @internal + */ export const filterSensitiveLog = (obj: EventIntegrationAssociation): any => ({ ...obj, }); @@ -326,6 +374,9 @@ export interface ListEventIntegrationAssociationsResponse { } export namespace ListEventIntegrationAssociationsResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListEventIntegrationAssociationsResponse): any => ({ ...obj, }); @@ -345,6 +396,9 @@ export interface ListEventIntegrationsRequest { } export namespace ListEventIntegrationsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListEventIntegrationsRequest): any => ({ ...obj, }); @@ -387,6 +441,9 @@ export interface EventIntegration { } export namespace EventIntegration { + /** + * @internal + */ export const filterSensitiveLog = (obj: EventIntegration): any => ({ ...obj, }); @@ -405,6 +462,9 @@ export interface ListEventIntegrationsResponse { } export namespace ListEventIntegrationsResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListEventIntegrationsResponse): any => ({ ...obj, }); @@ -418,6 +478,9 @@ export interface ListTagsForResourceRequest { } export namespace ListTagsForResourceRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListTagsForResourceRequest): any => ({ ...obj, }); @@ -431,6 +494,9 @@ export interface ListTagsForResourceResponse { } export namespace ListTagsForResourceResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListTagsForResourceResponse): any => ({ ...obj, }); @@ -449,6 +515,9 @@ export interface TagResourceRequest { } export namespace TagResourceRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: TagResourceRequest): any => ({ ...obj, }); @@ -457,6 +526,9 @@ export namespace TagResourceRequest { export interface TagResourceResponse {} export namespace TagResourceResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: TagResourceResponse): any => ({ ...obj, }); @@ -475,6 +547,9 @@ export interface UntagResourceRequest { } export namespace UntagResourceRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: UntagResourceRequest): any => ({ ...obj, }); @@ -483,6 +558,9 @@ export namespace UntagResourceRequest { export interface UntagResourceResponse {} export namespace UntagResourceResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: UntagResourceResponse): any => ({ ...obj, }); @@ -501,6 +579,9 @@ export interface UpdateEventIntegrationRequest { } export namespace UpdateEventIntegrationRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateEventIntegrationRequest): any => ({ ...obj, }); @@ -509,6 +590,9 @@ export namespace UpdateEventIntegrationRequest { export interface UpdateEventIntegrationResponse {} export namespace UpdateEventIntegrationResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateEventIntegrationResponse): any => ({ ...obj, }); diff --git a/clients/client-application-auto-scaling/commands/DeleteScalingPolicyCommand.ts b/clients/client-application-auto-scaling/commands/DeleteScalingPolicyCommand.ts index 8c6771eb8a1b..d107486cab34 100644 --- a/clients/client-application-auto-scaling/commands/DeleteScalingPolicyCommand.ts +++ b/clients/client-application-auto-scaling/commands/DeleteScalingPolicyCommand.ts @@ -31,6 +31,20 @@ export interface DeleteScalingPolicyCommandOutput extends DeleteScalingPolicyRes * action.

*

For more information, see Delete a step scaling policy and Delete a target tracking scaling policy in the * Application Auto Scaling User Guide.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ApplicationAutoScalingClient, DeleteScalingPolicyCommand } from "@aws-sdk/client-application-auto-scaling"; // ES Modules import + * // const { ApplicationAutoScalingClient, DeleteScalingPolicyCommand } = require("@aws-sdk/client-application-auto-scaling"); // CommonJS import + * const client = new ApplicationAutoScalingClient(config); + * const command = new DeleteScalingPolicyCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteScalingPolicyCommandInput} for command's `input` shape. + * @see {@link DeleteScalingPolicyCommandOutput} for command's `response` shape. + * @see {@link ApplicationAutoScalingClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteScalingPolicyCommand extends $Command< DeleteScalingPolicyCommandInput, diff --git a/clients/client-application-auto-scaling/commands/DeleteScheduledActionCommand.ts b/clients/client-application-auto-scaling/commands/DeleteScheduledActionCommand.ts index 2aaeb137edc4..541e9c48e371 100644 --- a/clients/client-application-auto-scaling/commands/DeleteScheduledActionCommand.ts +++ b/clients/client-application-auto-scaling/commands/DeleteScheduledActionCommand.ts @@ -27,6 +27,20 @@ export interface DeleteScheduledActionCommandOutput extends DeleteScheduledActio /** *

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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ApplicationAutoScalingClient, DeleteScheduledActionCommand } from "@aws-sdk/client-application-auto-scaling"; // ES Modules import + * // const { ApplicationAutoScalingClient, DeleteScheduledActionCommand } = require("@aws-sdk/client-application-auto-scaling"); // CommonJS import + * const client = new ApplicationAutoScalingClient(config); + * const command = new DeleteScheduledActionCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteScheduledActionCommandInput} for command's `input` shape. + * @see {@link DeleteScheduledActionCommandOutput} for command's `response` shape. + * @see {@link ApplicationAutoScalingClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteScheduledActionCommand extends $Command< DeleteScheduledActionCommandInput, diff --git a/clients/client-application-auto-scaling/commands/DeregisterScalableTargetCommand.ts b/clients/client-application-auto-scaling/commands/DeregisterScalableTargetCommand.ts index 62f7a20373c9..154be1835886 100644 --- a/clients/client-application-auto-scaling/commands/DeregisterScalableTargetCommand.ts +++ b/clients/client-application-auto-scaling/commands/DeregisterScalableTargetCommand.ts @@ -31,6 +31,20 @@ export interface DeregisterScalableTargetCommandOutput extends DeregisterScalabl *

Deregistering a scalable target deletes the scaling policies and the scheduled * actions that are associated with it.

* + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ApplicationAutoScalingClient, DeregisterScalableTargetCommand } from "@aws-sdk/client-application-auto-scaling"; // ES Modules import + * // const { ApplicationAutoScalingClient, DeregisterScalableTargetCommand } = require("@aws-sdk/client-application-auto-scaling"); // CommonJS import + * const client = new ApplicationAutoScalingClient(config); + * const command = new DeregisterScalableTargetCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeregisterScalableTargetCommandInput} for command's `input` shape. + * @see {@link DeregisterScalableTargetCommandOutput} for command's `response` shape. + * @see {@link ApplicationAutoScalingClientResolvedConfig | config} for command's `input` shape. + * */ export class DeregisterScalableTargetCommand extends $Command< DeregisterScalableTargetCommandInput, diff --git a/clients/client-application-auto-scaling/commands/DescribeScalableTargetsCommand.ts b/clients/client-application-auto-scaling/commands/DescribeScalableTargetsCommand.ts index 1a978cb5539e..cdec494fc8ef 100644 --- a/clients/client-application-auto-scaling/commands/DescribeScalableTargetsCommand.ts +++ b/clients/client-application-auto-scaling/commands/DescribeScalableTargetsCommand.ts @@ -28,6 +28,20 @@ export interface DescribeScalableTargetsCommandOutput extends DescribeScalableTa *

Gets information about the scalable targets in the specified namespace.

*

You can filter the results using ResourceIds and * ScalableDimension.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ApplicationAutoScalingClient, DescribeScalableTargetsCommand } from "@aws-sdk/client-application-auto-scaling"; // ES Modules import + * // const { ApplicationAutoScalingClient, DescribeScalableTargetsCommand } = require("@aws-sdk/client-application-auto-scaling"); // CommonJS import + * const client = new ApplicationAutoScalingClient(config); + * const command = new DescribeScalableTargetsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeScalableTargetsCommandInput} for command's `input` shape. + * @see {@link DescribeScalableTargetsCommandOutput} for command's `response` shape. + * @see {@link ApplicationAutoScalingClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeScalableTargetsCommand extends $Command< DescribeScalableTargetsCommandInput, diff --git a/clients/client-application-auto-scaling/commands/DescribeScalingActivitiesCommand.ts b/clients/client-application-auto-scaling/commands/DescribeScalingActivitiesCommand.ts index dfb794bbd58d..4219bac917c5 100644 --- a/clients/client-application-auto-scaling/commands/DescribeScalingActivitiesCommand.ts +++ b/clients/client-application-auto-scaling/commands/DescribeScalingActivitiesCommand.ts @@ -29,6 +29,20 @@ export interface DescribeScalingActivitiesCommandOutput extends DescribeScalingA * from the previous six weeks.

*

You can filter the results using ResourceId and * ScalableDimension.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ApplicationAutoScalingClient, DescribeScalingActivitiesCommand } from "@aws-sdk/client-application-auto-scaling"; // ES Modules import + * // const { ApplicationAutoScalingClient, DescribeScalingActivitiesCommand } = require("@aws-sdk/client-application-auto-scaling"); // CommonJS import + * const client = new ApplicationAutoScalingClient(config); + * const command = new DescribeScalingActivitiesCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeScalingActivitiesCommandInput} for command's `input` shape. + * @see {@link DescribeScalingActivitiesCommandOutput} for command's `response` shape. + * @see {@link ApplicationAutoScalingClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeScalingActivitiesCommand extends $Command< DescribeScalingActivitiesCommandInput, diff --git a/clients/client-application-auto-scaling/commands/DescribeScalingPoliciesCommand.ts b/clients/client-application-auto-scaling/commands/DescribeScalingPoliciesCommand.ts index c88189473914..83a5fa1928d1 100644 --- a/clients/client-application-auto-scaling/commands/DescribeScalingPoliciesCommand.ts +++ b/clients/client-application-auto-scaling/commands/DescribeScalingPoliciesCommand.ts @@ -29,6 +29,20 @@ export interface DescribeScalingPoliciesCommandOutput extends DescribeScalingPol *

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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ApplicationAutoScalingClient, DescribeScalingPoliciesCommand } from "@aws-sdk/client-application-auto-scaling"; // ES Modules import + * // const { ApplicationAutoScalingClient, DescribeScalingPoliciesCommand } = require("@aws-sdk/client-application-auto-scaling"); // CommonJS import + * const client = new ApplicationAutoScalingClient(config); + * const command = new DescribeScalingPoliciesCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeScalingPoliciesCommandInput} for command's `input` shape. + * @see {@link DescribeScalingPoliciesCommandOutput} for command's `response` shape. + * @see {@link ApplicationAutoScalingClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeScalingPoliciesCommand extends $Command< DescribeScalingPoliciesCommandInput, diff --git a/clients/client-application-auto-scaling/commands/DescribeScheduledActionsCommand.ts b/clients/client-application-auto-scaling/commands/DescribeScheduledActionsCommand.ts index 802bcec5d203..9ebf46810b39 100644 --- a/clients/client-application-auto-scaling/commands/DescribeScheduledActionsCommand.ts +++ b/clients/client-application-auto-scaling/commands/DescribeScheduledActionsCommand.ts @@ -30,6 +30,20 @@ export interface DescribeScheduledActionsCommandOutput extends DescribeScheduled * ScalableDimension, and ScheduledActionNames parameters.

*

For more information, see Scheduled scaling and Managing scheduled scaling in the * Application Auto Scaling User Guide.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ApplicationAutoScalingClient, DescribeScheduledActionsCommand } from "@aws-sdk/client-application-auto-scaling"; // ES Modules import + * // const { ApplicationAutoScalingClient, DescribeScheduledActionsCommand } = require("@aws-sdk/client-application-auto-scaling"); // CommonJS import + * const client = new ApplicationAutoScalingClient(config); + * const command = new DescribeScheduledActionsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeScheduledActionsCommandInput} for command's `input` shape. + * @see {@link DescribeScheduledActionsCommandOutput} for command's `response` shape. + * @see {@link ApplicationAutoScalingClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeScheduledActionsCommand extends $Command< DescribeScheduledActionsCommandInput, diff --git a/clients/client-application-auto-scaling/commands/PutScalingPolicyCommand.ts b/clients/client-application-auto-scaling/commands/PutScalingPolicyCommand.ts index fec443c30865..2c009e58b756 100644 --- a/clients/client-application-auto-scaling/commands/PutScalingPolicyCommand.ts +++ b/clients/client-application-auto-scaling/commands/PutScalingPolicyCommand.ts @@ -50,6 +50,20 @@ export interface PutScalingPolicyCommandOutput extends PutScalingPolicyResponse, * execute scaling policies. Any scaling policies that were specified for the scalable * target are deleted.

* + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ApplicationAutoScalingClient, PutScalingPolicyCommand } from "@aws-sdk/client-application-auto-scaling"; // ES Modules import + * // const { ApplicationAutoScalingClient, PutScalingPolicyCommand } = require("@aws-sdk/client-application-auto-scaling"); // CommonJS import + * const client = new ApplicationAutoScalingClient(config); + * const command = new PutScalingPolicyCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link PutScalingPolicyCommandInput} for command's `input` shape. + * @see {@link PutScalingPolicyCommandOutput} for command's `response` shape. + * @see {@link ApplicationAutoScalingClientResolvedConfig | config} for command's `input` shape. + * */ export class PutScalingPolicyCommand extends $Command< PutScalingPolicyCommandInput, diff --git a/clients/client-application-auto-scaling/commands/PutScheduledActionCommand.ts b/clients/client-application-auto-scaling/commands/PutScheduledActionCommand.ts index 13c42f6756f6..34caf7842d50 100644 --- a/clients/client-application-auto-scaling/commands/PutScheduledActionCommand.ts +++ b/clients/client-application-auto-scaling/commands/PutScheduledActionCommand.ts @@ -40,6 +40,20 @@ export interface PutScheduledActionCommandOutput extends PutScheduledActionRespo * run scheduled actions. Any scheduled actions that were specified for the scalable target * are deleted.

* + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ApplicationAutoScalingClient, PutScheduledActionCommand } from "@aws-sdk/client-application-auto-scaling"; // ES Modules import + * // const { ApplicationAutoScalingClient, PutScheduledActionCommand } = require("@aws-sdk/client-application-auto-scaling"); // CommonJS import + * const client = new ApplicationAutoScalingClient(config); + * const command = new PutScheduledActionCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link PutScheduledActionCommandInput} for command's `input` shape. + * @see {@link PutScheduledActionCommandOutput} for command's `response` shape. + * @see {@link ApplicationAutoScalingClientResolvedConfig | config} for command's `input` shape. + * */ export class PutScheduledActionCommand extends $Command< PutScheduledActionCommandInput, diff --git a/clients/client-application-auto-scaling/commands/RegisterScalableTargetCommand.ts b/clients/client-application-auto-scaling/commands/RegisterScalableTargetCommand.ts index e94a1b2e7890..a26419973d87 100644 --- a/clients/client-application-auto-scaling/commands/RegisterScalableTargetCommand.ts +++ b/clients/client-application-auto-scaling/commands/RegisterScalableTargetCommand.ts @@ -40,6 +40,20 @@ export interface RegisterScalableTargetCommandOutput extends RegisterScalableTar *

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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ApplicationAutoScalingClient, RegisterScalableTargetCommand } from "@aws-sdk/client-application-auto-scaling"; // ES Modules import + * // const { ApplicationAutoScalingClient, RegisterScalableTargetCommand } = require("@aws-sdk/client-application-auto-scaling"); // CommonJS import + * const client = new ApplicationAutoScalingClient(config); + * const command = new RegisterScalableTargetCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link RegisterScalableTargetCommandInput} for command's `input` shape. + * @see {@link RegisterScalableTargetCommandOutput} for command's `response` shape. + * @see {@link ApplicationAutoScalingClientResolvedConfig | config} for command's `input` shape. + * */ export class RegisterScalableTargetCommand extends $Command< RegisterScalableTargetCommandInput, diff --git a/clients/client-application-auto-scaling/models/models_0.ts b/clients/client-application-auto-scaling/models/models_0.ts index 09ac582db8f1..b2be056dc359 100644 --- a/clients/client-application-auto-scaling/models/models_0.ts +++ b/clients/client-application-auto-scaling/models/models_0.ts @@ -23,6 +23,9 @@ export interface Alarm { } export namespace Alarm { + /** + * @internal + */ export const filterSensitiveLog = (obj: Alarm): any => ({ ...obj, }); @@ -39,6 +42,9 @@ export interface ConcurrentUpdateException extends __SmithyException, $MetadataB } export namespace ConcurrentUpdateException { + /** + * @internal + */ export const filterSensitiveLog = (obj: ConcurrentUpdateException): any => ({ ...obj, }); @@ -231,6 +237,9 @@ export interface DeleteScalingPolicyRequest { } export namespace DeleteScalingPolicyRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteScalingPolicyRequest): any => ({ ...obj, }); @@ -239,6 +248,9 @@ export namespace DeleteScalingPolicyRequest { export interface DeleteScalingPolicyResponse {} export namespace DeleteScalingPolicyResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteScalingPolicyResponse): any => ({ ...obj, }); @@ -254,6 +266,9 @@ export interface InternalServiceException extends __SmithyException, $MetadataBe } export namespace InternalServiceException { + /** + * @internal + */ export const filterSensitiveLog = (obj: InternalServiceException): any => ({ ...obj, }); @@ -273,6 +288,9 @@ export interface ObjectNotFoundException extends __SmithyException, $MetadataBea } export namespace ObjectNotFoundException { + /** + * @internal + */ export const filterSensitiveLog = (obj: ObjectNotFoundException): any => ({ ...obj, }); @@ -289,6 +307,9 @@ export interface ValidationException extends __SmithyException, $MetadataBearer } export namespace ValidationException { + /** + * @internal + */ export const filterSensitiveLog = (obj: ValidationException): any => ({ ...obj, }); @@ -446,6 +467,9 @@ export interface DeleteScheduledActionRequest { } export namespace DeleteScheduledActionRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteScheduledActionRequest): any => ({ ...obj, }); @@ -454,6 +478,9 @@ export namespace DeleteScheduledActionRequest { export interface DeleteScheduledActionResponse {} export namespace DeleteScheduledActionResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteScheduledActionResponse): any => ({ ...obj, }); @@ -607,6 +634,9 @@ export interface DeregisterScalableTargetRequest { } export namespace DeregisterScalableTargetRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeregisterScalableTargetRequest): any => ({ ...obj, }); @@ -615,6 +645,9 @@ export namespace DeregisterScalableTargetRequest { export interface DeregisterScalableTargetResponse {} export namespace DeregisterScalableTargetResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeregisterScalableTargetResponse): any => ({ ...obj, }); @@ -784,6 +817,9 @@ export interface DescribeScalableTargetsRequest { } export namespace DescribeScalableTargetsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeScalableTargetsRequest): any => ({ ...obj, }); @@ -817,6 +853,9 @@ export interface SuspendedState { } export namespace SuspendedState { + /** + * @internal + */ export const filterSensitiveLog = (obj: SuspendedState): any => ({ ...obj, }); @@ -1000,6 +1039,9 @@ export interface ScalableTarget { } export namespace ScalableTarget { + /** + * @internal + */ export const filterSensitiveLog = (obj: ScalableTarget): any => ({ ...obj, }); @@ -1019,6 +1061,9 @@ export interface DescribeScalableTargetsResponse { } export namespace DescribeScalableTargetsResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeScalableTargetsResponse): any => ({ ...obj, }); @@ -1034,6 +1079,9 @@ export interface InvalidNextTokenException extends __SmithyException, $MetadataB } export namespace InvalidNextTokenException { + /** + * @internal + */ export const filterSensitiveLog = (obj: InvalidNextTokenException): any => ({ ...obj, }); @@ -1203,6 +1251,9 @@ export interface DescribeScalingActivitiesRequest { } export namespace DescribeScalingActivitiesRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeScalingActivitiesRequest): any => ({ ...obj, }); @@ -1407,6 +1458,9 @@ export interface ScalingActivity { } export namespace ScalingActivity { + /** + * @internal + */ export const filterSensitiveLog = (obj: ScalingActivity): any => ({ ...obj, }); @@ -1426,6 +1480,9 @@ export interface DescribeScalingActivitiesResponse { } export namespace DescribeScalingActivitiesResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeScalingActivitiesResponse): any => ({ ...obj, }); @@ -1600,6 +1657,9 @@ export interface DescribeScalingPoliciesRequest { } export namespace DescribeScalingPoliciesRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeScalingPoliciesRequest): any => ({ ...obj, }); @@ -1681,6 +1741,9 @@ export interface StepAdjustment { } export namespace StepAdjustment { + /** + * @internal + */ export const filterSensitiveLog = (obj: StepAdjustment): any => ({ ...obj, }); @@ -1793,6 +1856,9 @@ export interface StepScalingPolicyConfiguration { } export namespace StepScalingPolicyConfiguration { + /** + * @internal + */ export const filterSensitiveLog = (obj: StepScalingPolicyConfiguration): any => ({ ...obj, }); @@ -1814,6 +1880,9 @@ export interface MetricDimension { } export namespace MetricDimension { + /** + * @internal + */ export const filterSensitiveLog = (obj: MetricDimension): any => ({ ...obj, }); @@ -1881,6 +1950,9 @@ export interface CustomizedMetricSpecification { } export namespace CustomizedMetricSpecification { + /** + * @internal + */ export const filterSensitiveLog = (obj: CustomizedMetricSpecification): any => ({ ...obj, }); @@ -1949,6 +2021,9 @@ export interface PredefinedMetricSpecification { } export namespace PredefinedMetricSpecification { + /** + * @internal + */ export const filterSensitiveLog = (obj: PredefinedMetricSpecification): any => ({ ...obj, }); @@ -2104,6 +2179,9 @@ export interface TargetTrackingScalingPolicyConfiguration { } export namespace TargetTrackingScalingPolicyConfiguration { + /** + * @internal + */ export const filterSensitiveLog = (obj: TargetTrackingScalingPolicyConfiguration): any => ({ ...obj, }); @@ -2297,6 +2375,9 @@ export interface ScalingPolicy { } export namespace ScalingPolicy { + /** + * @internal + */ export const filterSensitiveLog = (obj: ScalingPolicy): any => ({ ...obj, }); @@ -2316,6 +2397,9 @@ export interface DescribeScalingPoliciesResponse { } export namespace DescribeScalingPoliciesResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeScalingPoliciesResponse): any => ({ ...obj, }); @@ -2334,6 +2418,9 @@ export interface FailedResourceAccessException extends __SmithyException, $Metad } export namespace FailedResourceAccessException { + /** + * @internal + */ export const filterSensitiveLog = (obj: FailedResourceAccessException): any => ({ ...obj, }); @@ -2508,6 +2595,9 @@ export interface DescribeScheduledActionsRequest { } export namespace DescribeScheduledActionsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeScheduledActionsRequest): any => ({ ...obj, }); @@ -2538,6 +2628,9 @@ export interface ScalableTargetAction { } export namespace ScalableTargetAction { + /** + * @internal + */ export const filterSensitiveLog = (obj: ScalableTargetAction): any => ({ ...obj, }); @@ -2758,6 +2851,9 @@ export interface ScheduledAction { } export namespace ScheduledAction { + /** + * @internal + */ export const filterSensitiveLog = (obj: ScheduledAction): any => ({ ...obj, }); @@ -2777,6 +2873,9 @@ export interface DescribeScheduledActionsResponse { } export namespace DescribeScheduledActionsResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeScheduledActionsResponse): any => ({ ...obj, }); @@ -2792,6 +2891,9 @@ export interface LimitExceededException extends __SmithyException, $MetadataBear } export namespace LimitExceededException { + /** + * @internal + */ export const filterSensitiveLog = (obj: LimitExceededException): any => ({ ...obj, }); @@ -2977,6 +3079,9 @@ export interface PutScalingPolicyRequest { } export namespace PutScalingPolicyRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: PutScalingPolicyRequest): any => ({ ...obj, }); @@ -2995,6 +3100,9 @@ export interface PutScalingPolicyResponse { } export namespace PutScalingPolicyResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: PutScalingPolicyResponse): any => ({ ...obj, }); @@ -3205,6 +3313,9 @@ export interface PutScheduledActionRequest { } export namespace PutScheduledActionRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: PutScheduledActionRequest): any => ({ ...obj, }); @@ -3213,6 +3324,9 @@ export namespace PutScheduledActionRequest { export interface PutScheduledActionResponse {} export namespace PutScheduledActionResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: PutScheduledActionResponse): any => ({ ...obj, }); @@ -3425,6 +3539,9 @@ export interface RegisterScalableTargetRequest { } export namespace RegisterScalableTargetRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: RegisterScalableTargetRequest): any => ({ ...obj, }); @@ -3433,6 +3550,9 @@ export namespace RegisterScalableTargetRequest { export interface RegisterScalableTargetResponse {} export namespace RegisterScalableTargetResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: RegisterScalableTargetResponse): any => ({ ...obj, }); diff --git a/clients/client-application-discovery-service/commands/AssociateConfigurationItemsToApplicationCommand.ts b/clients/client-application-discovery-service/commands/AssociateConfigurationItemsToApplicationCommand.ts index 2579e9ad04df..42eb043c0ffa 100644 --- a/clients/client-application-discovery-service/commands/AssociateConfigurationItemsToApplicationCommand.ts +++ b/clients/client-application-discovery-service/commands/AssociateConfigurationItemsToApplicationCommand.ts @@ -32,6 +32,20 @@ export interface AssociateConfigurationItemsToApplicationCommandOutput /** *

Associates one or more configuration items with an application.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ApplicationDiscoveryServiceClient, AssociateConfigurationItemsToApplicationCommand } from "@aws-sdk/client-application-discovery-service"; // ES Modules import + * // const { ApplicationDiscoveryServiceClient, AssociateConfigurationItemsToApplicationCommand } = require("@aws-sdk/client-application-discovery-service"); // CommonJS import + * const client = new ApplicationDiscoveryServiceClient(config); + * const command = new AssociateConfigurationItemsToApplicationCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link AssociateConfigurationItemsToApplicationCommandInput} for command's `input` shape. + * @see {@link AssociateConfigurationItemsToApplicationCommandOutput} for command's `response` shape. + * @see {@link ApplicationDiscoveryServiceClientResolvedConfig | config} for command's `input` shape. + * */ export class AssociateConfigurationItemsToApplicationCommand extends $Command< AssociateConfigurationItemsToApplicationCommandInput, diff --git a/clients/client-application-discovery-service/commands/BatchDeleteImportDataCommand.ts b/clients/client-application-discovery-service/commands/BatchDeleteImportDataCommand.ts index 18b351d3700a..9c466156e0b8 100644 --- a/clients/client-application-discovery-service/commands/BatchDeleteImportDataCommand.ts +++ b/clients/client-application-discovery-service/commands/BatchDeleteImportDataCommand.ts @@ -33,6 +33,20 @@ export interface BatchDeleteImportDataCommandOutput extends BatchDeleteImportDat * 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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ApplicationDiscoveryServiceClient, BatchDeleteImportDataCommand } from "@aws-sdk/client-application-discovery-service"; // ES Modules import + * // const { ApplicationDiscoveryServiceClient, BatchDeleteImportDataCommand } = require("@aws-sdk/client-application-discovery-service"); // CommonJS import + * const client = new ApplicationDiscoveryServiceClient(config); + * const command = new BatchDeleteImportDataCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link BatchDeleteImportDataCommandInput} for command's `input` shape. + * @see {@link BatchDeleteImportDataCommandOutput} for command's `response` shape. + * @see {@link ApplicationDiscoveryServiceClientResolvedConfig | config} for command's `input` shape. + * */ export class BatchDeleteImportDataCommand extends $Command< BatchDeleteImportDataCommandInput, diff --git a/clients/client-application-discovery-service/commands/CreateApplicationCommand.ts b/clients/client-application-discovery-service/commands/CreateApplicationCommand.ts index 9ae6990661f2..0a242623573f 100644 --- a/clients/client-application-discovery-service/commands/CreateApplicationCommand.ts +++ b/clients/client-application-discovery-service/commands/CreateApplicationCommand.ts @@ -26,6 +26,20 @@ export interface CreateApplicationCommandOutput extends CreateApplicationRespons /** *

Creates an application with the given name and description.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ApplicationDiscoveryServiceClient, CreateApplicationCommand } from "@aws-sdk/client-application-discovery-service"; // ES Modules import + * // const { ApplicationDiscoveryServiceClient, CreateApplicationCommand } = require("@aws-sdk/client-application-discovery-service"); // CommonJS import + * const client = new ApplicationDiscoveryServiceClient(config); + * const command = new CreateApplicationCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreateApplicationCommandInput} for command's `input` shape. + * @see {@link CreateApplicationCommandOutput} for command's `response` shape. + * @see {@link ApplicationDiscoveryServiceClientResolvedConfig | config} for command's `input` shape. + * */ export class CreateApplicationCommand extends $Command< CreateApplicationCommandInput, diff --git a/clients/client-application-discovery-service/commands/CreateTagsCommand.ts b/clients/client-application-discovery-service/commands/CreateTagsCommand.ts index 3316d47e382a..7a49a3e39004 100644 --- a/clients/client-application-discovery-service/commands/CreateTagsCommand.ts +++ b/clients/client-application-discovery-service/commands/CreateTagsCommand.ts @@ -27,6 +27,20 @@ export interface CreateTagsCommandOutput extends CreateTagsResponse, __MetadataB /** *

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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ApplicationDiscoveryServiceClient, CreateTagsCommand } from "@aws-sdk/client-application-discovery-service"; // ES Modules import + * // const { ApplicationDiscoveryServiceClient, CreateTagsCommand } = require("@aws-sdk/client-application-discovery-service"); // CommonJS import + * const client = new ApplicationDiscoveryServiceClient(config); + * const command = new CreateTagsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreateTagsCommandInput} for command's `input` shape. + * @see {@link CreateTagsCommandOutput} for command's `response` shape. + * @see {@link ApplicationDiscoveryServiceClientResolvedConfig | config} for command's `input` shape. + * */ export class CreateTagsCommand extends $Command< CreateTagsCommandInput, diff --git a/clients/client-application-discovery-service/commands/DeleteApplicationsCommand.ts b/clients/client-application-discovery-service/commands/DeleteApplicationsCommand.ts index fa2688f03b5a..c097fe1ddc78 100644 --- a/clients/client-application-discovery-service/commands/DeleteApplicationsCommand.ts +++ b/clients/client-application-discovery-service/commands/DeleteApplicationsCommand.ts @@ -27,6 +27,20 @@ export interface DeleteApplicationsCommandOutput extends DeleteApplicationsRespo /** *

Deletes a list of applications and their associations with configuration * items.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ApplicationDiscoveryServiceClient, DeleteApplicationsCommand } from "@aws-sdk/client-application-discovery-service"; // ES Modules import + * // const { ApplicationDiscoveryServiceClient, DeleteApplicationsCommand } = require("@aws-sdk/client-application-discovery-service"); // CommonJS import + * const client = new ApplicationDiscoveryServiceClient(config); + * const command = new DeleteApplicationsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteApplicationsCommandInput} for command's `input` shape. + * @see {@link DeleteApplicationsCommandOutput} for command's `response` shape. + * @see {@link ApplicationDiscoveryServiceClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteApplicationsCommand extends $Command< DeleteApplicationsCommandInput, diff --git a/clients/client-application-discovery-service/commands/DeleteTagsCommand.ts b/clients/client-application-discovery-service/commands/DeleteTagsCommand.ts index ec27a98975d2..f6526095faa9 100644 --- a/clients/client-application-discovery-service/commands/DeleteTagsCommand.ts +++ b/clients/client-application-discovery-service/commands/DeleteTagsCommand.ts @@ -27,6 +27,20 @@ export interface DeleteTagsCommandOutput extends DeleteTagsResponse, __MetadataB /** *

Deletes the association between configuration items and one or more tags. This API * accepts a list of multiple configuration items.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ApplicationDiscoveryServiceClient, DeleteTagsCommand } from "@aws-sdk/client-application-discovery-service"; // ES Modules import + * // const { ApplicationDiscoveryServiceClient, DeleteTagsCommand } = require("@aws-sdk/client-application-discovery-service"); // CommonJS import + * const client = new ApplicationDiscoveryServiceClient(config); + * const command = new DeleteTagsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteTagsCommandInput} for command's `input` shape. + * @see {@link DeleteTagsCommandOutput} for command's `response` shape. + * @see {@link ApplicationDiscoveryServiceClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteTagsCommand extends $Command< DeleteTagsCommandInput, diff --git a/clients/client-application-discovery-service/commands/DescribeAgentsCommand.ts b/clients/client-application-discovery-service/commands/DescribeAgentsCommand.ts index 086b736efdf6..2b1969014667 100644 --- a/clients/client-application-discovery-service/commands/DescribeAgentsCommand.ts +++ b/clients/client-application-discovery-service/commands/DescribeAgentsCommand.ts @@ -28,6 +28,20 @@ export interface DescribeAgentsCommandOutput extends DescribeAgentsResponse, __M *

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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ApplicationDiscoveryServiceClient, DescribeAgentsCommand } from "@aws-sdk/client-application-discovery-service"; // ES Modules import + * // const { ApplicationDiscoveryServiceClient, DescribeAgentsCommand } = require("@aws-sdk/client-application-discovery-service"); // CommonJS import + * const client = new ApplicationDiscoveryServiceClient(config); + * const command = new DescribeAgentsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeAgentsCommandInput} for command's `input` shape. + * @see {@link DescribeAgentsCommandOutput} for command's `response` shape. + * @see {@link ApplicationDiscoveryServiceClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeAgentsCommand extends $Command< DescribeAgentsCommandInput, diff --git a/clients/client-application-discovery-service/commands/DescribeConfigurationsCommand.ts b/clients/client-application-discovery-service/commands/DescribeConfigurationsCommand.ts index 56b6253959bf..f13e52397624 100644 --- a/clients/client-application-discovery-service/commands/DescribeConfigurationsCommand.ts +++ b/clients/client-application-discovery-service/commands/DescribeConfigurationsCommand.ts @@ -51,6 +51,20 @@ export interface DescribeConfigurationsCommandOutput extends DescribeConfigurati *

For a complete list of outputs for each asset type, see Using the DescribeConfigurations Action in the AWS Application * Discovery Service User Guide.

* + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ApplicationDiscoveryServiceClient, DescribeConfigurationsCommand } from "@aws-sdk/client-application-discovery-service"; // ES Modules import + * // const { ApplicationDiscoveryServiceClient, DescribeConfigurationsCommand } = require("@aws-sdk/client-application-discovery-service"); // CommonJS import + * const client = new ApplicationDiscoveryServiceClient(config); + * const command = new DescribeConfigurationsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeConfigurationsCommandInput} for command's `input` shape. + * @see {@link DescribeConfigurationsCommandOutput} for command's `response` shape. + * @see {@link ApplicationDiscoveryServiceClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeConfigurationsCommand extends $Command< DescribeConfigurationsCommandInput, diff --git a/clients/client-application-discovery-service/commands/DescribeContinuousExportsCommand.ts b/clients/client-application-discovery-service/commands/DescribeContinuousExportsCommand.ts index 9155aa65d309..9e1f8176ee9f 100644 --- a/clients/client-application-discovery-service/commands/DescribeContinuousExportsCommand.ts +++ b/clients/client-application-discovery-service/commands/DescribeContinuousExportsCommand.ts @@ -28,6 +28,20 @@ export interface DescribeContinuousExportsCommandOutput extends DescribeContinuo *

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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ApplicationDiscoveryServiceClient, DescribeContinuousExportsCommand } from "@aws-sdk/client-application-discovery-service"; // ES Modules import + * // const { ApplicationDiscoveryServiceClient, DescribeContinuousExportsCommand } = require("@aws-sdk/client-application-discovery-service"); // CommonJS import + * const client = new ApplicationDiscoveryServiceClient(config); + * const command = new DescribeContinuousExportsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeContinuousExportsCommandInput} for command's `input` shape. + * @see {@link DescribeContinuousExportsCommandOutput} for command's `response` shape. + * @see {@link ApplicationDiscoveryServiceClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeContinuousExportsCommand extends $Command< DescribeContinuousExportsCommandInput, diff --git a/clients/client-application-discovery-service/commands/DescribeExportConfigurationsCommand.ts b/clients/client-application-discovery-service/commands/DescribeExportConfigurationsCommand.ts index 791fec69ffc7..dd7515684e8e 100644 --- a/clients/client-application-discovery-service/commands/DescribeExportConfigurationsCommand.ts +++ b/clients/client-application-discovery-service/commands/DescribeExportConfigurationsCommand.ts @@ -31,6 +31,20 @@ export interface DescribeExportConfigurationsCommandOutput * *

* DescribeExportConfigurations is deprecated. Use DescribeImportTasks, instead.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ApplicationDiscoveryServiceClient, DescribeExportConfigurationsCommand } from "@aws-sdk/client-application-discovery-service"; // ES Modules import + * // const { ApplicationDiscoveryServiceClient, DescribeExportConfigurationsCommand } = require("@aws-sdk/client-application-discovery-service"); // CommonJS import + * const client = new ApplicationDiscoveryServiceClient(config); + * const command = new DescribeExportConfigurationsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeExportConfigurationsCommandInput} for command's `input` shape. + * @see {@link DescribeExportConfigurationsCommandOutput} for command's `response` shape. + * @see {@link ApplicationDiscoveryServiceClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeExportConfigurationsCommand extends $Command< DescribeExportConfigurationsCommandInput, diff --git a/clients/client-application-discovery-service/commands/DescribeExportTasksCommand.ts b/clients/client-application-discovery-service/commands/DescribeExportTasksCommand.ts index 3974f2fbed57..0bbec0fb29de 100644 --- a/clients/client-application-discovery-service/commands/DescribeExportTasksCommand.ts +++ b/clients/client-application-discovery-service/commands/DescribeExportTasksCommand.ts @@ -27,6 +27,20 @@ export interface DescribeExportTasksCommandOutput extends DescribeExportTasksRes /** *

Retrieve status of one or more export tasks. You can retrieve the status of up to 100 * export tasks.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ApplicationDiscoveryServiceClient, DescribeExportTasksCommand } from "@aws-sdk/client-application-discovery-service"; // ES Modules import + * // const { ApplicationDiscoveryServiceClient, DescribeExportTasksCommand } = require("@aws-sdk/client-application-discovery-service"); // CommonJS import + * const client = new ApplicationDiscoveryServiceClient(config); + * const command = new DescribeExportTasksCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeExportTasksCommandInput} for command's `input` shape. + * @see {@link DescribeExportTasksCommandOutput} for command's `response` shape. + * @see {@link ApplicationDiscoveryServiceClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeExportTasksCommand extends $Command< DescribeExportTasksCommandInput, diff --git a/clients/client-application-discovery-service/commands/DescribeImportTasksCommand.ts b/clients/client-application-discovery-service/commands/DescribeImportTasksCommand.ts index 224c8ab8dd7a..279998144d7b 100644 --- a/clients/client-application-discovery-service/commands/DescribeImportTasksCommand.ts +++ b/clients/client-application-discovery-service/commands/DescribeImportTasksCommand.ts @@ -27,6 +27,20 @@ export interface DescribeImportTasksCommandOutput extends DescribeImportTasksRes /** *

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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ApplicationDiscoveryServiceClient, DescribeImportTasksCommand } from "@aws-sdk/client-application-discovery-service"; // ES Modules import + * // const { ApplicationDiscoveryServiceClient, DescribeImportTasksCommand } = require("@aws-sdk/client-application-discovery-service"); // CommonJS import + * const client = new ApplicationDiscoveryServiceClient(config); + * const command = new DescribeImportTasksCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeImportTasksCommandInput} for command's `input` shape. + * @see {@link DescribeImportTasksCommandOutput} for command's `response` shape. + * @see {@link ApplicationDiscoveryServiceClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeImportTasksCommand extends $Command< DescribeImportTasksCommandInput, diff --git a/clients/client-application-discovery-service/commands/DescribeTagsCommand.ts b/clients/client-application-discovery-service/commands/DescribeTagsCommand.ts index a15354bf509c..b9d090820ecf 100644 --- a/clients/client-application-discovery-service/commands/DescribeTagsCommand.ts +++ b/clients/client-application-discovery-service/commands/DescribeTagsCommand.ts @@ -41,6 +41,20 @@ export interface DescribeTagsCommandOutput extends DescribeTagsResponse, __Metad * *

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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ApplicationDiscoveryServiceClient, DescribeTagsCommand } from "@aws-sdk/client-application-discovery-service"; // ES Modules import + * // const { ApplicationDiscoveryServiceClient, DescribeTagsCommand } = require("@aws-sdk/client-application-discovery-service"); // CommonJS import + * const client = new ApplicationDiscoveryServiceClient(config); + * const command = new DescribeTagsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeTagsCommandInput} for command's `input` shape. + * @see {@link DescribeTagsCommandOutput} for command's `response` shape. + * @see {@link ApplicationDiscoveryServiceClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeTagsCommand extends $Command< DescribeTagsCommandInput, diff --git a/clients/client-application-discovery-service/commands/DisassociateConfigurationItemsFromApplicationCommand.ts b/clients/client-application-discovery-service/commands/DisassociateConfigurationItemsFromApplicationCommand.ts index 03bd79fa5225..52ecfd44eed5 100644 --- a/clients/client-application-discovery-service/commands/DisassociateConfigurationItemsFromApplicationCommand.ts +++ b/clients/client-application-discovery-service/commands/DisassociateConfigurationItemsFromApplicationCommand.ts @@ -32,6 +32,20 @@ export interface DisassociateConfigurationItemsFromApplicationCommandOutput /** *

Disassociates one or more configuration items from an application.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ApplicationDiscoveryServiceClient, DisassociateConfigurationItemsFromApplicationCommand } from "@aws-sdk/client-application-discovery-service"; // ES Modules import + * // const { ApplicationDiscoveryServiceClient, DisassociateConfigurationItemsFromApplicationCommand } = require("@aws-sdk/client-application-discovery-service"); // CommonJS import + * const client = new ApplicationDiscoveryServiceClient(config); + * const command = new DisassociateConfigurationItemsFromApplicationCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DisassociateConfigurationItemsFromApplicationCommandInput} for command's `input` shape. + * @see {@link DisassociateConfigurationItemsFromApplicationCommandOutput} for command's `response` shape. + * @see {@link ApplicationDiscoveryServiceClientResolvedConfig | config} for command's `input` shape. + * */ export class DisassociateConfigurationItemsFromApplicationCommand extends $Command< DisassociateConfigurationItemsFromApplicationCommandInput, diff --git a/clients/client-application-discovery-service/commands/ExportConfigurationsCommand.ts b/clients/client-application-discovery-service/commands/ExportConfigurationsCommand.ts index b5a2460e1da9..d35b1809f5d6 100644 --- a/clients/client-application-discovery-service/commands/ExportConfigurationsCommand.ts +++ b/clients/client-application-discovery-service/commands/ExportConfigurationsCommand.ts @@ -33,6 +33,20 @@ export interface ExportConfigurationsCommandOutput extends ExportConfigurationsR * 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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ApplicationDiscoveryServiceClient, ExportConfigurationsCommand } from "@aws-sdk/client-application-discovery-service"; // ES Modules import + * // const { ApplicationDiscoveryServiceClient, ExportConfigurationsCommand } = require("@aws-sdk/client-application-discovery-service"); // CommonJS import + * const client = new ApplicationDiscoveryServiceClient(config); + * const command = new ExportConfigurationsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ExportConfigurationsCommandInput} for command's `input` shape. + * @see {@link ExportConfigurationsCommandOutput} for command's `response` shape. + * @see {@link ApplicationDiscoveryServiceClientResolvedConfig | config} for command's `input` shape. + * */ export class ExportConfigurationsCommand extends $Command< ExportConfigurationsCommandInput, diff --git a/clients/client-application-discovery-service/commands/GetDiscoverySummaryCommand.ts b/clients/client-application-discovery-service/commands/GetDiscoverySummaryCommand.ts index 49044cb8a308..fc6dfbb96e79 100644 --- a/clients/client-application-discovery-service/commands/GetDiscoverySummaryCommand.ts +++ b/clients/client-application-discovery-service/commands/GetDiscoverySummaryCommand.ts @@ -28,6 +28,20 @@ export interface GetDiscoverySummaryCommandOutput extends GetDiscoverySummaryRes *

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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ApplicationDiscoveryServiceClient, GetDiscoverySummaryCommand } from "@aws-sdk/client-application-discovery-service"; // ES Modules import + * // const { ApplicationDiscoveryServiceClient, GetDiscoverySummaryCommand } = require("@aws-sdk/client-application-discovery-service"); // CommonJS import + * const client = new ApplicationDiscoveryServiceClient(config); + * const command = new GetDiscoverySummaryCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetDiscoverySummaryCommandInput} for command's `input` shape. + * @see {@link GetDiscoverySummaryCommandOutput} for command's `response` shape. + * @see {@link ApplicationDiscoveryServiceClientResolvedConfig | config} for command's `input` shape. + * */ export class GetDiscoverySummaryCommand extends $Command< GetDiscoverySummaryCommandInput, diff --git a/clients/client-application-discovery-service/commands/ListConfigurationsCommand.ts b/clients/client-application-discovery-service/commands/ListConfigurationsCommand.ts index 95906a777174..9c2f4d25087e 100644 --- a/clients/client-application-discovery-service/commands/ListConfigurationsCommand.ts +++ b/clients/client-application-discovery-service/commands/ListConfigurationsCommand.ts @@ -28,6 +28,20 @@ export interface ListConfigurationsCommandOutput extends ListConfigurationsRespo *

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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ApplicationDiscoveryServiceClient, ListConfigurationsCommand } from "@aws-sdk/client-application-discovery-service"; // ES Modules import + * // const { ApplicationDiscoveryServiceClient, ListConfigurationsCommand } = require("@aws-sdk/client-application-discovery-service"); // CommonJS import + * const client = new ApplicationDiscoveryServiceClient(config); + * const command = new ListConfigurationsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListConfigurationsCommandInput} for command's `input` shape. + * @see {@link ListConfigurationsCommandOutput} for command's `response` shape. + * @see {@link ApplicationDiscoveryServiceClientResolvedConfig | config} for command's `input` shape. + * */ export class ListConfigurationsCommand extends $Command< ListConfigurationsCommandInput, diff --git a/clients/client-application-discovery-service/commands/ListServerNeighborsCommand.ts b/clients/client-application-discovery-service/commands/ListServerNeighborsCommand.ts index c22acbf79000..3aa214dd62df 100644 --- a/clients/client-application-discovery-service/commands/ListServerNeighborsCommand.ts +++ b/clients/client-application-discovery-service/commands/ListServerNeighborsCommand.ts @@ -27,6 +27,20 @@ export interface ListServerNeighborsCommandOutput extends ListServerNeighborsRes /** *

Retrieves a list of servers that are one network hop away from a specified * server.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ApplicationDiscoveryServiceClient, ListServerNeighborsCommand } from "@aws-sdk/client-application-discovery-service"; // ES Modules import + * // const { ApplicationDiscoveryServiceClient, ListServerNeighborsCommand } = require("@aws-sdk/client-application-discovery-service"); // CommonJS import + * const client = new ApplicationDiscoveryServiceClient(config); + * const command = new ListServerNeighborsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListServerNeighborsCommandInput} for command's `input` shape. + * @see {@link ListServerNeighborsCommandOutput} for command's `response` shape. + * @see {@link ApplicationDiscoveryServiceClientResolvedConfig | config} for command's `input` shape. + * */ export class ListServerNeighborsCommand extends $Command< ListServerNeighborsCommandInput, diff --git a/clients/client-application-discovery-service/commands/StartContinuousExportCommand.ts b/clients/client-application-discovery-service/commands/StartContinuousExportCommand.ts index 567125c140a4..cb7f7a483933 100644 --- a/clients/client-application-discovery-service/commands/StartContinuousExportCommand.ts +++ b/clients/client-application-discovery-service/commands/StartContinuousExportCommand.ts @@ -26,6 +26,20 @@ export interface StartContinuousExportCommandOutput extends StartContinuousExpor /** *

Start the continuous flow of agent's discovered data into Amazon Athena.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ApplicationDiscoveryServiceClient, StartContinuousExportCommand } from "@aws-sdk/client-application-discovery-service"; // ES Modules import + * // const { ApplicationDiscoveryServiceClient, StartContinuousExportCommand } = require("@aws-sdk/client-application-discovery-service"); // CommonJS import + * const client = new ApplicationDiscoveryServiceClient(config); + * const command = new StartContinuousExportCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link StartContinuousExportCommandInput} for command's `input` shape. + * @see {@link StartContinuousExportCommandOutput} for command's `response` shape. + * @see {@link ApplicationDiscoveryServiceClientResolvedConfig | config} for command's `input` shape. + * */ export class StartContinuousExportCommand extends $Command< StartContinuousExportCommandInput, diff --git a/clients/client-application-discovery-service/commands/StartDataCollectionByAgentIdsCommand.ts b/clients/client-application-discovery-service/commands/StartDataCollectionByAgentIdsCommand.ts index aca940ccf1fa..3079520b6c5c 100644 --- a/clients/client-application-discovery-service/commands/StartDataCollectionByAgentIdsCommand.ts +++ b/clients/client-application-discovery-service/commands/StartDataCollectionByAgentIdsCommand.ts @@ -28,6 +28,20 @@ export interface StartDataCollectionByAgentIdsCommandOutput /** *

Instructs the specified agents or connectors to start collecting data.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ApplicationDiscoveryServiceClient, StartDataCollectionByAgentIdsCommand } from "@aws-sdk/client-application-discovery-service"; // ES Modules import + * // const { ApplicationDiscoveryServiceClient, StartDataCollectionByAgentIdsCommand } = require("@aws-sdk/client-application-discovery-service"); // CommonJS import + * const client = new ApplicationDiscoveryServiceClient(config); + * const command = new StartDataCollectionByAgentIdsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link StartDataCollectionByAgentIdsCommandInput} for command's `input` shape. + * @see {@link StartDataCollectionByAgentIdsCommandOutput} for command's `response` shape. + * @see {@link ApplicationDiscoveryServiceClientResolvedConfig | config} for command's `input` shape. + * */ export class StartDataCollectionByAgentIdsCommand extends $Command< StartDataCollectionByAgentIdsCommandInput, diff --git a/clients/client-application-discovery-service/commands/StartExportTaskCommand.ts b/clients/client-application-discovery-service/commands/StartExportTaskCommand.ts index fbfd11c01e66..7dc0259fdab6 100644 --- a/clients/client-application-discovery-service/commands/StartExportTaskCommand.ts +++ b/clients/client-application-discovery-service/commands/StartExportTaskCommand.ts @@ -34,6 +34,20 @@ export interface StartExportTaskCommandOutput extends StartExportTaskResponse, _ *

If you do not include an agentIds filter, summary data is exported that * includes both AWS Agentless Discovery Connector data and summary data from AWS Discovery * Agents. Export of summary data is limited to two exports per day.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ApplicationDiscoveryServiceClient, StartExportTaskCommand } from "@aws-sdk/client-application-discovery-service"; // ES Modules import + * // const { ApplicationDiscoveryServiceClient, StartExportTaskCommand } = require("@aws-sdk/client-application-discovery-service"); // CommonJS import + * const client = new ApplicationDiscoveryServiceClient(config); + * const command = new StartExportTaskCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link StartExportTaskCommandInput} for command's `input` shape. + * @see {@link StartExportTaskCommandOutput} for command's `response` shape. + * @see {@link ApplicationDiscoveryServiceClientResolvedConfig | config} for command's `input` shape. + * */ export class StartExportTaskCommand extends $Command< StartExportTaskCommandInput, diff --git a/clients/client-application-discovery-service/commands/StartImportTaskCommand.ts b/clients/client-application-discovery-service/commands/StartImportTaskCommand.ts index 9c7f2b9cfc04..aade2f94c611 100644 --- a/clients/client-application-discovery-service/commands/StartImportTaskCommand.ts +++ b/clients/client-application-discovery-service/commands/StartImportTaskCommand.ts @@ -61,6 +61,20 @@ export interface StartImportTaskCommandOutput extends StartImportTaskResponse, _ * Discovery Service Limits in the AWS Application Discovery Service User * Guide.

* + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ApplicationDiscoveryServiceClient, StartImportTaskCommand } from "@aws-sdk/client-application-discovery-service"; // ES Modules import + * // const { ApplicationDiscoveryServiceClient, StartImportTaskCommand } = require("@aws-sdk/client-application-discovery-service"); // CommonJS import + * const client = new ApplicationDiscoveryServiceClient(config); + * const command = new StartImportTaskCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link StartImportTaskCommandInput} for command's `input` shape. + * @see {@link StartImportTaskCommandOutput} for command's `response` shape. + * @see {@link ApplicationDiscoveryServiceClientResolvedConfig | config} for command's `input` shape. + * */ export class StartImportTaskCommand extends $Command< StartImportTaskCommandInput, diff --git a/clients/client-application-discovery-service/commands/StopContinuousExportCommand.ts b/clients/client-application-discovery-service/commands/StopContinuousExportCommand.ts index 8d20882748f6..64db873bcd28 100644 --- a/clients/client-application-discovery-service/commands/StopContinuousExportCommand.ts +++ b/clients/client-application-discovery-service/commands/StopContinuousExportCommand.ts @@ -26,6 +26,20 @@ export interface StopContinuousExportCommandOutput extends StopContinuousExportR /** *

Stop the continuous flow of agent's discovered data into Amazon Athena.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ApplicationDiscoveryServiceClient, StopContinuousExportCommand } from "@aws-sdk/client-application-discovery-service"; // ES Modules import + * // const { ApplicationDiscoveryServiceClient, StopContinuousExportCommand } = require("@aws-sdk/client-application-discovery-service"); // CommonJS import + * const client = new ApplicationDiscoveryServiceClient(config); + * const command = new StopContinuousExportCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link StopContinuousExportCommandInput} for command's `input` shape. + * @see {@link StopContinuousExportCommandOutput} for command's `response` shape. + * @see {@link ApplicationDiscoveryServiceClientResolvedConfig | config} for command's `input` shape. + * */ export class StopContinuousExportCommand extends $Command< StopContinuousExportCommandInput, diff --git a/clients/client-application-discovery-service/commands/StopDataCollectionByAgentIdsCommand.ts b/clients/client-application-discovery-service/commands/StopDataCollectionByAgentIdsCommand.ts index 27c479dae3bb..90b7eca2191c 100644 --- a/clients/client-application-discovery-service/commands/StopDataCollectionByAgentIdsCommand.ts +++ b/clients/client-application-discovery-service/commands/StopDataCollectionByAgentIdsCommand.ts @@ -28,6 +28,20 @@ export interface StopDataCollectionByAgentIdsCommandOutput /** *

Instructs the specified agents or connectors to stop collecting data.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ApplicationDiscoveryServiceClient, StopDataCollectionByAgentIdsCommand } from "@aws-sdk/client-application-discovery-service"; // ES Modules import + * // const { ApplicationDiscoveryServiceClient, StopDataCollectionByAgentIdsCommand } = require("@aws-sdk/client-application-discovery-service"); // CommonJS import + * const client = new ApplicationDiscoveryServiceClient(config); + * const command = new StopDataCollectionByAgentIdsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link StopDataCollectionByAgentIdsCommandInput} for command's `input` shape. + * @see {@link StopDataCollectionByAgentIdsCommandOutput} for command's `response` shape. + * @see {@link ApplicationDiscoveryServiceClientResolvedConfig | config} for command's `input` shape. + * */ export class StopDataCollectionByAgentIdsCommand extends $Command< StopDataCollectionByAgentIdsCommandInput, diff --git a/clients/client-application-discovery-service/commands/UpdateApplicationCommand.ts b/clients/client-application-discovery-service/commands/UpdateApplicationCommand.ts index 719c69e9db9a..8d74595c2823 100644 --- a/clients/client-application-discovery-service/commands/UpdateApplicationCommand.ts +++ b/clients/client-application-discovery-service/commands/UpdateApplicationCommand.ts @@ -26,6 +26,20 @@ export interface UpdateApplicationCommandOutput extends UpdateApplicationRespons /** *

Updates metadata about an application.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ApplicationDiscoveryServiceClient, UpdateApplicationCommand } from "@aws-sdk/client-application-discovery-service"; // ES Modules import + * // const { ApplicationDiscoveryServiceClient, UpdateApplicationCommand } = require("@aws-sdk/client-application-discovery-service"); // CommonJS import + * const client = new ApplicationDiscoveryServiceClient(config); + * const command = new UpdateApplicationCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link UpdateApplicationCommandInput} for command's `input` shape. + * @see {@link UpdateApplicationCommandOutput} for command's `response` shape. + * @see {@link ApplicationDiscoveryServiceClientResolvedConfig | config} for command's `input` shape. + * */ export class UpdateApplicationCommand extends $Command< UpdateApplicationCommandInput, diff --git a/clients/client-application-discovery-service/models/models_0.ts b/clients/client-application-discovery-service/models/models_0.ts index a35a2d21702d..650eeb46778e 100644 --- a/clients/client-application-discovery-service/models/models_0.ts +++ b/clients/client-application-discovery-service/models/models_0.ts @@ -27,6 +27,9 @@ export interface AgentConfigurationStatus { } export namespace AgentConfigurationStatus { + /** + * @internal + */ export const filterSensitiveLog = (obj: AgentConfigurationStatus): any => ({ ...obj, }); @@ -48,6 +51,9 @@ export interface AgentNetworkInfo { } export namespace AgentNetworkInfo { + /** + * @internal + */ export const filterSensitiveLog = (obj: AgentNetworkInfo): any => ({ ...obj, }); @@ -122,6 +128,9 @@ export interface AgentInfo { } export namespace AgentInfo { + /** + * @internal + */ export const filterSensitiveLog = (obj: AgentInfo): any => ({ ...obj, }); @@ -140,6 +149,9 @@ export interface AssociateConfigurationItemsToApplicationRequest { } export namespace AssociateConfigurationItemsToApplicationRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: AssociateConfigurationItemsToApplicationRequest): any => ({ ...obj, }); @@ -148,6 +160,9 @@ export namespace AssociateConfigurationItemsToApplicationRequest { export interface AssociateConfigurationItemsToApplicationResponse {} export namespace AssociateConfigurationItemsToApplicationResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: AssociateConfigurationItemsToApplicationResponse): any => ({ ...obj, }); @@ -164,6 +179,9 @@ export interface AuthorizationErrorException extends __SmithyException, $Metadat } export namespace AuthorizationErrorException { + /** + * @internal + */ export const filterSensitiveLog = (obj: AuthorizationErrorException): any => ({ ...obj, }); @@ -179,6 +197,9 @@ export interface HomeRegionNotSetException extends __SmithyException, $MetadataB } export namespace HomeRegionNotSetException { + /** + * @internal + */ export const filterSensitiveLog = (obj: HomeRegionNotSetException): any => ({ ...obj, }); @@ -194,6 +215,9 @@ export interface InvalidParameterException extends __SmithyException, $MetadataB } export namespace InvalidParameterException { + /** + * @internal + */ export const filterSensitiveLog = (obj: InvalidParameterException): any => ({ ...obj, }); @@ -210,6 +234,9 @@ export interface InvalidParameterValueException extends __SmithyException, $Meta } export namespace InvalidParameterValueException { + /** + * @internal + */ export const filterSensitiveLog = (obj: InvalidParameterValueException): any => ({ ...obj, }); @@ -225,6 +252,9 @@ export interface ServerInternalErrorException extends __SmithyException, $Metada } export namespace ServerInternalErrorException { + /** + * @internal + */ export const filterSensitiveLog = (obj: ServerInternalErrorException): any => ({ ...obj, }); @@ -238,6 +268,9 @@ export interface BatchDeleteImportDataRequest { } export namespace BatchDeleteImportDataRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: BatchDeleteImportDataRequest): any => ({ ...obj, }); @@ -271,6 +304,9 @@ export interface BatchDeleteImportDataError { } export namespace BatchDeleteImportDataError { + /** + * @internal + */ export const filterSensitiveLog = (obj: BatchDeleteImportDataError): any => ({ ...obj, }); @@ -285,6 +321,9 @@ export interface BatchDeleteImportDataResponse { } export namespace BatchDeleteImportDataResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: BatchDeleteImportDataResponse): any => ({ ...obj, }); @@ -303,6 +342,9 @@ export interface CreateApplicationRequest { } export namespace CreateApplicationRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateApplicationRequest): any => ({ ...obj, }); @@ -316,6 +358,9 @@ export interface CreateApplicationResponse { } export namespace CreateApplicationResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateApplicationResponse): any => ({ ...obj, }); @@ -337,6 +382,9 @@ export interface Tag { } export namespace Tag { + /** + * @internal + */ export const filterSensitiveLog = (obj: Tag): any => ({ ...obj, }); @@ -360,6 +408,9 @@ export interface CreateTagsRequest { } export namespace CreateTagsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateTagsRequest): any => ({ ...obj, }); @@ -368,6 +419,9 @@ export namespace CreateTagsRequest { export interface CreateTagsResponse {} export namespace CreateTagsResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateTagsResponse): any => ({ ...obj, }); @@ -384,6 +438,9 @@ export interface ResourceNotFoundException extends __SmithyException, $MetadataB } export namespace ResourceNotFoundException { + /** + * @internal + */ export const filterSensitiveLog = (obj: ResourceNotFoundException): any => ({ ...obj, }); @@ -397,6 +454,9 @@ export interface DeleteApplicationsRequest { } export namespace DeleteApplicationsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteApplicationsRequest): any => ({ ...obj, }); @@ -405,6 +465,9 @@ export namespace DeleteApplicationsRequest { export interface DeleteApplicationsResponse {} export namespace DeleteApplicationsResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteApplicationsResponse): any => ({ ...obj, }); @@ -428,6 +491,9 @@ export interface DeleteTagsRequest { } export namespace DeleteTagsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteTagsRequest): any => ({ ...obj, }); @@ -436,6 +502,9 @@ export namespace DeleteTagsRequest { export interface DeleteTagsResponse {} export namespace DeleteTagsResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteTagsResponse): any => ({ ...obj, }); @@ -472,6 +541,9 @@ export interface Filter { } export namespace Filter { + /** + * @internal + */ export const filterSensitiveLog = (obj: Filter): any => ({ ...obj, }); @@ -510,6 +582,9 @@ export interface DescribeAgentsRequest { } export namespace DescribeAgentsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeAgentsRequest): any => ({ ...obj, }); @@ -534,6 +609,9 @@ export interface DescribeAgentsResponse { } export namespace DescribeAgentsResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeAgentsResponse): any => ({ ...obj, }); @@ -547,6 +625,9 @@ export interface DescribeConfigurationsRequest { } export namespace DescribeConfigurationsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeConfigurationsRequest): any => ({ ...obj, }); @@ -560,6 +641,9 @@ export interface DescribeConfigurationsResponse { } export namespace DescribeConfigurationsResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeConfigurationsResponse): any => ({ ...obj, }); @@ -584,6 +668,9 @@ export interface DescribeContinuousExportsRequest { } export namespace DescribeContinuousExportsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeContinuousExportsRequest): any => ({ ...obj, }); @@ -726,6 +813,9 @@ export interface ContinuousExportDescription { } export namespace ContinuousExportDescription { + /** + * @internal + */ export const filterSensitiveLog = (obj: ContinuousExportDescription): any => ({ ...obj, }); @@ -744,6 +834,9 @@ export interface DescribeContinuousExportsResponse { } export namespace DescribeContinuousExportsResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeContinuousExportsResponse): any => ({ ...obj, }); @@ -759,6 +852,9 @@ export interface OperationNotPermittedException extends __SmithyException, $Meta } export namespace OperationNotPermittedException { + /** + * @internal + */ export const filterSensitiveLog = (obj: OperationNotPermittedException): any => ({ ...obj, }); @@ -783,6 +879,9 @@ export interface DescribeExportConfigurationsRequest { } export namespace DescribeExportConfigurationsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeExportConfigurationsRequest): any => ({ ...obj, }); @@ -849,6 +948,9 @@ export interface ExportInfo { } export namespace ExportInfo { + /** + * @internal + */ export const filterSensitiveLog = (obj: ExportInfo): any => ({ ...obj, }); @@ -867,6 +969,9 @@ export interface DescribeExportConfigurationsResponse { } export namespace DescribeExportConfigurationsResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeExportConfigurationsResponse): any => ({ ...obj, }); @@ -898,6 +1003,9 @@ export interface ExportFilter { } export namespace ExportFilter { + /** + * @internal + */ export const filterSensitiveLog = (obj: ExportFilter): any => ({ ...obj, }); @@ -940,6 +1048,9 @@ export interface DescribeExportTasksRequest { } export namespace DescribeExportTasksRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeExportTasksRequest): any => ({ ...obj, }); @@ -964,6 +1075,9 @@ export interface DescribeExportTasksResponse { } export namespace DescribeExportTasksResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeExportTasksResponse): any => ({ ...obj, }); @@ -997,6 +1111,9 @@ export interface ImportTaskFilter { } export namespace ImportTaskFilter { + /** + * @internal + */ export const filterSensitiveLog = (obj: ImportTaskFilter): any => ({ ...obj, }); @@ -1022,6 +1139,9 @@ export interface DescribeImportTasksRequest { } export namespace DescribeImportTasksRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeImportTasksRequest): any => ({ ...obj, }); @@ -1138,6 +1258,9 @@ export interface ImportTask { } export namespace ImportTask { + /** + * @internal + */ export const filterSensitiveLog = (obj: ImportTask): any => ({ ...obj, }); @@ -1157,6 +1280,9 @@ export interface DescribeImportTasksResponse { } export namespace DescribeImportTasksResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeImportTasksResponse): any => ({ ...obj, }); @@ -1179,6 +1305,9 @@ export interface TagFilter { } export namespace TagFilter { + /** + * @internal + */ export const filterSensitiveLog = (obj: TagFilter): any => ({ ...obj, }); @@ -1205,6 +1334,9 @@ export interface DescribeTagsRequest { } export namespace DescribeTagsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeTagsRequest): any => ({ ...obj, }); @@ -1253,6 +1385,9 @@ export interface ConfigurationTag { } export namespace ConfigurationTag { + /** + * @internal + */ export const filterSensitiveLog = (obj: ConfigurationTag): any => ({ ...obj, }); @@ -1272,6 +1407,9 @@ export interface DescribeTagsResponse { } export namespace DescribeTagsResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeTagsResponse): any => ({ ...obj, }); @@ -1290,6 +1428,9 @@ export interface DisassociateConfigurationItemsFromApplicationRequest { } export namespace DisassociateConfigurationItemsFromApplicationRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DisassociateConfigurationItemsFromApplicationRequest): any => ({ ...obj, }); @@ -1298,6 +1439,9 @@ export namespace DisassociateConfigurationItemsFromApplicationRequest { export interface DisassociateConfigurationItemsFromApplicationResponse {} export namespace DisassociateConfigurationItemsFromApplicationResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DisassociateConfigurationItemsFromApplicationResponse): any => ({ ...obj, }); @@ -1311,6 +1455,9 @@ export interface ExportConfigurationsResponse { } export namespace ExportConfigurationsResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ExportConfigurationsResponse): any => ({ ...obj, }); @@ -1319,6 +1466,9 @@ export namespace ExportConfigurationsResponse { export interface GetDiscoverySummaryRequest {} export namespace GetDiscoverySummaryRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetDiscoverySummaryRequest): any => ({ ...obj, }); @@ -1365,6 +1515,9 @@ export interface CustomerAgentInfo { } export namespace CustomerAgentInfo { + /** + * @internal + */ export const filterSensitiveLog = (obj: CustomerAgentInfo): any => ({ ...obj, }); @@ -1411,6 +1564,9 @@ export interface CustomerConnectorInfo { } export namespace CustomerConnectorInfo { + /** + * @internal + */ export const filterSensitiveLog = (obj: CustomerConnectorInfo): any => ({ ...obj, }); @@ -1449,6 +1605,9 @@ export interface GetDiscoverySummaryResponse { } export namespace GetDiscoverySummaryResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetDiscoverySummaryResponse): any => ({ ...obj, }); @@ -1475,6 +1634,9 @@ export interface OrderByElement { } export namespace OrderByElement { + /** + * @internal + */ export const filterSensitiveLog = (obj: OrderByElement): any => ({ ...obj, }); @@ -1520,6 +1682,9 @@ export interface ListConfigurationsRequest { } export namespace ListConfigurationsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListConfigurationsRequest): any => ({ ...obj, }); @@ -1543,6 +1708,9 @@ export interface ListConfigurationsResponse { } export namespace ListConfigurationsResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListConfigurationsResponse): any => ({ ...obj, }); @@ -1580,6 +1748,9 @@ export interface ListServerNeighborsRequest { } export namespace ListServerNeighborsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListServerNeighborsRequest): any => ({ ...obj, }); @@ -1616,6 +1787,9 @@ export interface NeighborConnectionDetail { } export namespace NeighborConnectionDetail { + /** + * @internal + */ export const filterSensitiveLog = (obj: NeighborConnectionDetail): any => ({ ...obj, }); @@ -1643,6 +1817,9 @@ export interface ListServerNeighborsResponse { } export namespace ListServerNeighborsResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListServerNeighborsResponse): any => ({ ...obj, }); @@ -1658,6 +1835,9 @@ export interface ConflictErrorException extends __SmithyException, $MetadataBear } export namespace ConflictErrorException { + /** + * @internal + */ export const filterSensitiveLog = (obj: ConflictErrorException): any => ({ ...obj, }); @@ -1677,6 +1857,9 @@ export interface ResourceInUseException extends __SmithyException, $MetadataBear } export namespace ResourceInUseException { + /** + * @internal + */ export const filterSensitiveLog = (obj: ResourceInUseException): any => ({ ...obj, }); @@ -1685,6 +1868,9 @@ export namespace ResourceInUseException { export interface StartContinuousExportRequest {} export namespace StartContinuousExportRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: StartContinuousExportRequest): any => ({ ...obj, }); @@ -1726,6 +1912,9 @@ export interface StartContinuousExportResponse { } export namespace StartContinuousExportResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: StartContinuousExportResponse): any => ({ ...obj, }); @@ -1745,6 +1934,9 @@ export interface StartDataCollectionByAgentIdsRequest { } export namespace StartDataCollectionByAgentIdsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: StartDataCollectionByAgentIdsRequest): any => ({ ...obj, }); @@ -1760,6 +1952,9 @@ export interface StartDataCollectionByAgentIdsResponse { } export namespace StartDataCollectionByAgentIdsResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: StartDataCollectionByAgentIdsResponse): any => ({ ...obj, }); @@ -1807,6 +2002,9 @@ export interface StartExportTaskRequest { } export namespace StartExportTaskRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: StartExportTaskRequest): any => ({ ...obj, }); @@ -1820,6 +2018,9 @@ export interface StartExportTaskResponse { } export namespace StartExportTaskResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: StartExportTaskResponse): any => ({ ...obj, }); @@ -1857,6 +2058,9 @@ export interface StartImportTaskRequest { } export namespace StartImportTaskRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: StartImportTaskRequest): any => ({ ...obj, }); @@ -1871,6 +2075,9 @@ export interface StartImportTaskResponse { } export namespace StartImportTaskResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: StartImportTaskResponse): any => ({ ...obj, }); @@ -1884,6 +2091,9 @@ export interface StopContinuousExportRequest { } export namespace StopContinuousExportRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: StopContinuousExportRequest): any => ({ ...obj, }); @@ -1903,6 +2113,9 @@ export interface StopContinuousExportResponse { } export namespace StopContinuousExportResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: StopContinuousExportResponse): any => ({ ...obj, }); @@ -1916,6 +2129,9 @@ export interface StopDataCollectionByAgentIdsRequest { } export namespace StopDataCollectionByAgentIdsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: StopDataCollectionByAgentIdsRequest): any => ({ ...obj, }); @@ -1931,6 +2147,9 @@ export interface StopDataCollectionByAgentIdsResponse { } export namespace StopDataCollectionByAgentIdsResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: StopDataCollectionByAgentIdsResponse): any => ({ ...obj, }); @@ -1954,6 +2173,9 @@ export interface UpdateApplicationRequest { } export namespace UpdateApplicationRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateApplicationRequest): any => ({ ...obj, }); @@ -1962,6 +2184,9 @@ export namespace UpdateApplicationRequest { export interface UpdateApplicationResponse {} export namespace UpdateApplicationResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateApplicationResponse): any => ({ ...obj, }); diff --git a/clients/client-application-insights/commands/CreateApplicationCommand.ts b/clients/client-application-insights/commands/CreateApplicationCommand.ts index e677671a6613..734643b9db12 100644 --- a/clients/client-application-insights/commands/CreateApplicationCommand.ts +++ b/clients/client-application-insights/commands/CreateApplicationCommand.ts @@ -26,6 +26,20 @@ export interface CreateApplicationCommandOutput extends CreateApplicationRespons /** *

Adds an application that is created from a resource group.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ApplicationInsightsClient, CreateApplicationCommand } from "@aws-sdk/client-application-insights"; // ES Modules import + * // const { ApplicationInsightsClient, CreateApplicationCommand } = require("@aws-sdk/client-application-insights"); // CommonJS import + * const client = new ApplicationInsightsClient(config); + * const command = new CreateApplicationCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreateApplicationCommandInput} for command's `input` shape. + * @see {@link CreateApplicationCommandOutput} for command's `response` shape. + * @see {@link ApplicationInsightsClientResolvedConfig | config} for command's `input` shape. + * */ export class CreateApplicationCommand extends $Command< CreateApplicationCommandInput, diff --git a/clients/client-application-insights/commands/CreateComponentCommand.ts b/clients/client-application-insights/commands/CreateComponentCommand.ts index 8e021e074d80..6d01d2136f92 100644 --- a/clients/client-application-insights/commands/CreateComponentCommand.ts +++ b/clients/client-application-insights/commands/CreateComponentCommand.ts @@ -26,6 +26,20 @@ export interface CreateComponentCommandOutput extends CreateComponentResponse, _ /** *

Creates a custom component by grouping similar standalone instances to monitor.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ApplicationInsightsClient, CreateComponentCommand } from "@aws-sdk/client-application-insights"; // ES Modules import + * // const { ApplicationInsightsClient, CreateComponentCommand } = require("@aws-sdk/client-application-insights"); // CommonJS import + * const client = new ApplicationInsightsClient(config); + * const command = new CreateComponentCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreateComponentCommandInput} for command's `input` shape. + * @see {@link CreateComponentCommandOutput} for command's `response` shape. + * @see {@link ApplicationInsightsClientResolvedConfig | config} for command's `input` shape. + * */ export class CreateComponentCommand extends $Command< CreateComponentCommandInput, diff --git a/clients/client-application-insights/commands/CreateLogPatternCommand.ts b/clients/client-application-insights/commands/CreateLogPatternCommand.ts index edbd32ae7904..6ce3d1af77a5 100644 --- a/clients/client-application-insights/commands/CreateLogPatternCommand.ts +++ b/clients/client-application-insights/commands/CreateLogPatternCommand.ts @@ -26,6 +26,20 @@ export interface CreateLogPatternCommandOutput extends CreateLogPatternResponse, /** *

Adds an log pattern to a LogPatternSet.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ApplicationInsightsClient, CreateLogPatternCommand } from "@aws-sdk/client-application-insights"; // ES Modules import + * // const { ApplicationInsightsClient, CreateLogPatternCommand } = require("@aws-sdk/client-application-insights"); // CommonJS import + * const client = new ApplicationInsightsClient(config); + * const command = new CreateLogPatternCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreateLogPatternCommandInput} for command's `input` shape. + * @see {@link CreateLogPatternCommandOutput} for command's `response` shape. + * @see {@link ApplicationInsightsClientResolvedConfig | config} for command's `input` shape. + * */ export class CreateLogPatternCommand extends $Command< CreateLogPatternCommandInput, diff --git a/clients/client-application-insights/commands/DeleteApplicationCommand.ts b/clients/client-application-insights/commands/DeleteApplicationCommand.ts index 3ddd0d90cd51..b81d7b637196 100644 --- a/clients/client-application-insights/commands/DeleteApplicationCommand.ts +++ b/clients/client-application-insights/commands/DeleteApplicationCommand.ts @@ -26,6 +26,20 @@ export interface DeleteApplicationCommandOutput extends DeleteApplicationRespons /** *

Removes the specified application from monitoring. Does not delete the application.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ApplicationInsightsClient, DeleteApplicationCommand } from "@aws-sdk/client-application-insights"; // ES Modules import + * // const { ApplicationInsightsClient, DeleteApplicationCommand } = require("@aws-sdk/client-application-insights"); // CommonJS import + * const client = new ApplicationInsightsClient(config); + * const command = new DeleteApplicationCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteApplicationCommandInput} for command's `input` shape. + * @see {@link DeleteApplicationCommandOutput} for command's `response` shape. + * @see {@link ApplicationInsightsClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteApplicationCommand extends $Command< DeleteApplicationCommandInput, diff --git a/clients/client-application-insights/commands/DeleteComponentCommand.ts b/clients/client-application-insights/commands/DeleteComponentCommand.ts index 67e5ec0ba2d8..a8b4381af9d8 100644 --- a/clients/client-application-insights/commands/DeleteComponentCommand.ts +++ b/clients/client-application-insights/commands/DeleteComponentCommand.ts @@ -27,6 +27,20 @@ export interface DeleteComponentCommandOutput extends DeleteComponentResponse, _ /** *

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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ApplicationInsightsClient, DeleteComponentCommand } from "@aws-sdk/client-application-insights"; // ES Modules import + * // const { ApplicationInsightsClient, DeleteComponentCommand } = require("@aws-sdk/client-application-insights"); // CommonJS import + * const client = new ApplicationInsightsClient(config); + * const command = new DeleteComponentCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteComponentCommandInput} for command's `input` shape. + * @see {@link DeleteComponentCommandOutput} for command's `response` shape. + * @see {@link ApplicationInsightsClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteComponentCommand extends $Command< DeleteComponentCommandInput, diff --git a/clients/client-application-insights/commands/DeleteLogPatternCommand.ts b/clients/client-application-insights/commands/DeleteLogPatternCommand.ts index 910d09063c1e..41cc4e428147 100644 --- a/clients/client-application-insights/commands/DeleteLogPatternCommand.ts +++ b/clients/client-application-insights/commands/DeleteLogPatternCommand.ts @@ -26,6 +26,20 @@ export interface DeleteLogPatternCommandOutput extends DeleteLogPatternResponse, /** *

Removes the specified log pattern from a LogPatternSet.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ApplicationInsightsClient, DeleteLogPatternCommand } from "@aws-sdk/client-application-insights"; // ES Modules import + * // const { ApplicationInsightsClient, DeleteLogPatternCommand } = require("@aws-sdk/client-application-insights"); // CommonJS import + * const client = new ApplicationInsightsClient(config); + * const command = new DeleteLogPatternCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteLogPatternCommandInput} for command's `input` shape. + * @see {@link DeleteLogPatternCommandOutput} for command's `response` shape. + * @see {@link ApplicationInsightsClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteLogPatternCommand extends $Command< DeleteLogPatternCommandInput, diff --git a/clients/client-application-insights/commands/DescribeApplicationCommand.ts b/clients/client-application-insights/commands/DescribeApplicationCommand.ts index 93e7fdf6831e..e2a6c6d96656 100644 --- a/clients/client-application-insights/commands/DescribeApplicationCommand.ts +++ b/clients/client-application-insights/commands/DescribeApplicationCommand.ts @@ -26,6 +26,20 @@ export interface DescribeApplicationCommandOutput extends DescribeApplicationRes /** *

Describes the application.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ApplicationInsightsClient, DescribeApplicationCommand } from "@aws-sdk/client-application-insights"; // ES Modules import + * // const { ApplicationInsightsClient, DescribeApplicationCommand } = require("@aws-sdk/client-application-insights"); // CommonJS import + * const client = new ApplicationInsightsClient(config); + * const command = new DescribeApplicationCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeApplicationCommandInput} for command's `input` shape. + * @see {@link DescribeApplicationCommandOutput} for command's `response` shape. + * @see {@link ApplicationInsightsClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeApplicationCommand extends $Command< DescribeApplicationCommandInput, diff --git a/clients/client-application-insights/commands/DescribeComponentCommand.ts b/clients/client-application-insights/commands/DescribeComponentCommand.ts index 3850c84834eb..0d96f6450339 100644 --- a/clients/client-application-insights/commands/DescribeComponentCommand.ts +++ b/clients/client-application-insights/commands/DescribeComponentCommand.ts @@ -26,6 +26,20 @@ export interface DescribeComponentCommandOutput extends DescribeComponentRespons /** *

Describes a component and lists the resources that are grouped together in a component.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ApplicationInsightsClient, DescribeComponentCommand } from "@aws-sdk/client-application-insights"; // ES Modules import + * // const { ApplicationInsightsClient, DescribeComponentCommand } = require("@aws-sdk/client-application-insights"); // CommonJS import + * const client = new ApplicationInsightsClient(config); + * const command = new DescribeComponentCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeComponentCommandInput} for command's `input` shape. + * @see {@link DescribeComponentCommandOutput} for command's `response` shape. + * @see {@link ApplicationInsightsClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeComponentCommand extends $Command< DescribeComponentCommandInput, diff --git a/clients/client-application-insights/commands/DescribeComponentConfigurationCommand.ts b/clients/client-application-insights/commands/DescribeComponentConfigurationCommand.ts index de86bccea113..cb7d0a90c1da 100644 --- a/clients/client-application-insights/commands/DescribeComponentConfigurationCommand.ts +++ b/clients/client-application-insights/commands/DescribeComponentConfigurationCommand.ts @@ -28,6 +28,20 @@ export interface DescribeComponentConfigurationCommandOutput /** *

Describes the monitoring configuration of the component.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ApplicationInsightsClient, DescribeComponentConfigurationCommand } from "@aws-sdk/client-application-insights"; // ES Modules import + * // const { ApplicationInsightsClient, DescribeComponentConfigurationCommand } = require("@aws-sdk/client-application-insights"); // CommonJS import + * const client = new ApplicationInsightsClient(config); + * const command = new DescribeComponentConfigurationCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeComponentConfigurationCommandInput} for command's `input` shape. + * @see {@link DescribeComponentConfigurationCommandOutput} for command's `response` shape. + * @see {@link ApplicationInsightsClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeComponentConfigurationCommand extends $Command< DescribeComponentConfigurationCommandInput, diff --git a/clients/client-application-insights/commands/DescribeComponentConfigurationRecommendationCommand.ts b/clients/client-application-insights/commands/DescribeComponentConfigurationRecommendationCommand.ts index c0ea6d20d30a..e1bb83a3f6db 100644 --- a/clients/client-application-insights/commands/DescribeComponentConfigurationRecommendationCommand.ts +++ b/clients/client-application-insights/commands/DescribeComponentConfigurationRecommendationCommand.ts @@ -32,6 +32,20 @@ export interface DescribeComponentConfigurationRecommendationCommandOutput /** *

Describes the recommended monitoring configuration of the component.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ApplicationInsightsClient, DescribeComponentConfigurationRecommendationCommand } from "@aws-sdk/client-application-insights"; // ES Modules import + * // const { ApplicationInsightsClient, DescribeComponentConfigurationRecommendationCommand } = require("@aws-sdk/client-application-insights"); // CommonJS import + * const client = new ApplicationInsightsClient(config); + * const command = new DescribeComponentConfigurationRecommendationCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeComponentConfigurationRecommendationCommandInput} for command's `input` shape. + * @see {@link DescribeComponentConfigurationRecommendationCommandOutput} for command's `response` shape. + * @see {@link ApplicationInsightsClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeComponentConfigurationRecommendationCommand extends $Command< DescribeComponentConfigurationRecommendationCommandInput, diff --git a/clients/client-application-insights/commands/DescribeLogPatternCommand.ts b/clients/client-application-insights/commands/DescribeLogPatternCommand.ts index 1a324fa031cc..68b32f755edb 100644 --- a/clients/client-application-insights/commands/DescribeLogPatternCommand.ts +++ b/clients/client-application-insights/commands/DescribeLogPatternCommand.ts @@ -26,6 +26,20 @@ export interface DescribeLogPatternCommandOutput extends DescribeLogPatternRespo /** *

Describe a specific log pattern from a LogPatternSet.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ApplicationInsightsClient, DescribeLogPatternCommand } from "@aws-sdk/client-application-insights"; // ES Modules import + * // const { ApplicationInsightsClient, DescribeLogPatternCommand } = require("@aws-sdk/client-application-insights"); // CommonJS import + * const client = new ApplicationInsightsClient(config); + * const command = new DescribeLogPatternCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeLogPatternCommandInput} for command's `input` shape. + * @see {@link DescribeLogPatternCommandOutput} for command's `response` shape. + * @see {@link ApplicationInsightsClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeLogPatternCommand extends $Command< DescribeLogPatternCommandInput, diff --git a/clients/client-application-insights/commands/DescribeObservationCommand.ts b/clients/client-application-insights/commands/DescribeObservationCommand.ts index 7ac8adf63130..f361387cdff0 100644 --- a/clients/client-application-insights/commands/DescribeObservationCommand.ts +++ b/clients/client-application-insights/commands/DescribeObservationCommand.ts @@ -26,6 +26,20 @@ export interface DescribeObservationCommandOutput extends DescribeObservationRes /** *

Describes an anomaly or error with the application.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ApplicationInsightsClient, DescribeObservationCommand } from "@aws-sdk/client-application-insights"; // ES Modules import + * // const { ApplicationInsightsClient, DescribeObservationCommand } = require("@aws-sdk/client-application-insights"); // CommonJS import + * const client = new ApplicationInsightsClient(config); + * const command = new DescribeObservationCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeObservationCommandInput} for command's `input` shape. + * @see {@link DescribeObservationCommandOutput} for command's `response` shape. + * @see {@link ApplicationInsightsClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeObservationCommand extends $Command< DescribeObservationCommandInput, diff --git a/clients/client-application-insights/commands/DescribeProblemCommand.ts b/clients/client-application-insights/commands/DescribeProblemCommand.ts index 45f888cb345b..7e7f87ac0783 100644 --- a/clients/client-application-insights/commands/DescribeProblemCommand.ts +++ b/clients/client-application-insights/commands/DescribeProblemCommand.ts @@ -26,6 +26,20 @@ export interface DescribeProblemCommandOutput extends DescribeProblemResponse, _ /** *

Describes an application problem.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ApplicationInsightsClient, DescribeProblemCommand } from "@aws-sdk/client-application-insights"; // ES Modules import + * // const { ApplicationInsightsClient, DescribeProblemCommand } = require("@aws-sdk/client-application-insights"); // CommonJS import + * const client = new ApplicationInsightsClient(config); + * const command = new DescribeProblemCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeProblemCommandInput} for command's `input` shape. + * @see {@link DescribeProblemCommandOutput} for command's `response` shape. + * @see {@link ApplicationInsightsClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeProblemCommand extends $Command< DescribeProblemCommandInput, diff --git a/clients/client-application-insights/commands/DescribeProblemObservationsCommand.ts b/clients/client-application-insights/commands/DescribeProblemObservationsCommand.ts index 93ba4548ddc7..d9db0907cad1 100644 --- a/clients/client-application-insights/commands/DescribeProblemObservationsCommand.ts +++ b/clients/client-application-insights/commands/DescribeProblemObservationsCommand.ts @@ -28,6 +28,20 @@ export interface DescribeProblemObservationsCommandOutput /** *

Describes the anomalies or errors associated with the problem.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ApplicationInsightsClient, DescribeProblemObservationsCommand } from "@aws-sdk/client-application-insights"; // ES Modules import + * // const { ApplicationInsightsClient, DescribeProblemObservationsCommand } = require("@aws-sdk/client-application-insights"); // CommonJS import + * const client = new ApplicationInsightsClient(config); + * const command = new DescribeProblemObservationsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeProblemObservationsCommandInput} for command's `input` shape. + * @see {@link DescribeProblemObservationsCommandOutput} for command's `response` shape. + * @see {@link ApplicationInsightsClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeProblemObservationsCommand extends $Command< DescribeProblemObservationsCommandInput, diff --git a/clients/client-application-insights/commands/ListApplicationsCommand.ts b/clients/client-application-insights/commands/ListApplicationsCommand.ts index 9a148537d90e..c0b45fb5ab34 100644 --- a/clients/client-application-insights/commands/ListApplicationsCommand.ts +++ b/clients/client-application-insights/commands/ListApplicationsCommand.ts @@ -26,6 +26,20 @@ export interface ListApplicationsCommandOutput extends ListApplicationsResponse, /** *

Lists the IDs of the applications that you are monitoring.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ApplicationInsightsClient, ListApplicationsCommand } from "@aws-sdk/client-application-insights"; // ES Modules import + * // const { ApplicationInsightsClient, ListApplicationsCommand } = require("@aws-sdk/client-application-insights"); // CommonJS import + * const client = new ApplicationInsightsClient(config); + * const command = new ListApplicationsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListApplicationsCommandInput} for command's `input` shape. + * @see {@link ListApplicationsCommandOutput} for command's `response` shape. + * @see {@link ApplicationInsightsClientResolvedConfig | config} for command's `input` shape. + * */ export class ListApplicationsCommand extends $Command< ListApplicationsCommandInput, diff --git a/clients/client-application-insights/commands/ListComponentsCommand.ts b/clients/client-application-insights/commands/ListComponentsCommand.ts index 0add3468dcbb..ef8f1e0fc233 100644 --- a/clients/client-application-insights/commands/ListComponentsCommand.ts +++ b/clients/client-application-insights/commands/ListComponentsCommand.ts @@ -26,6 +26,20 @@ export interface ListComponentsCommandOutput extends ListComponentsResponse, __M /** *

Lists the auto-grouped, standalone, and custom components of the application.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ApplicationInsightsClient, ListComponentsCommand } from "@aws-sdk/client-application-insights"; // ES Modules import + * // const { ApplicationInsightsClient, ListComponentsCommand } = require("@aws-sdk/client-application-insights"); // CommonJS import + * const client = new ApplicationInsightsClient(config); + * const command = new ListComponentsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListComponentsCommandInput} for command's `input` shape. + * @see {@link ListComponentsCommandOutput} for command's `response` shape. + * @see {@link ApplicationInsightsClientResolvedConfig | config} for command's `input` shape. + * */ export class ListComponentsCommand extends $Command< ListComponentsCommandInput, diff --git a/clients/client-application-insights/commands/ListConfigurationHistoryCommand.ts b/clients/client-application-insights/commands/ListConfigurationHistoryCommand.ts index 1d2c21f56ca9..47536fe9a3dc 100644 --- a/clients/client-application-insights/commands/ListConfigurationHistoryCommand.ts +++ b/clients/client-application-insights/commands/ListConfigurationHistoryCommand.ts @@ -39,6 +39,20 @@ export interface ListConfigurationHistoryCommandOutput extends ListConfiguration *

ERROR: alarm not created due to permission errors or exceeding quotas.

* * + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ApplicationInsightsClient, ListConfigurationHistoryCommand } from "@aws-sdk/client-application-insights"; // ES Modules import + * // const { ApplicationInsightsClient, ListConfigurationHistoryCommand } = require("@aws-sdk/client-application-insights"); // CommonJS import + * const client = new ApplicationInsightsClient(config); + * const command = new ListConfigurationHistoryCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListConfigurationHistoryCommandInput} for command's `input` shape. + * @see {@link ListConfigurationHistoryCommandOutput} for command's `response` shape. + * @see {@link ApplicationInsightsClientResolvedConfig | config} for command's `input` shape. + * */ export class ListConfigurationHistoryCommand extends $Command< ListConfigurationHistoryCommandInput, diff --git a/clients/client-application-insights/commands/ListLogPatternSetsCommand.ts b/clients/client-application-insights/commands/ListLogPatternSetsCommand.ts index beed2f9baa49..f093908cbb51 100644 --- a/clients/client-application-insights/commands/ListLogPatternSetsCommand.ts +++ b/clients/client-application-insights/commands/ListLogPatternSetsCommand.ts @@ -26,6 +26,20 @@ export interface ListLogPatternSetsCommandOutput extends ListLogPatternSetsRespo /** *

Lists the log pattern sets in the specific application.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ApplicationInsightsClient, ListLogPatternSetsCommand } from "@aws-sdk/client-application-insights"; // ES Modules import + * // const { ApplicationInsightsClient, ListLogPatternSetsCommand } = require("@aws-sdk/client-application-insights"); // CommonJS import + * const client = new ApplicationInsightsClient(config); + * const command = new ListLogPatternSetsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListLogPatternSetsCommandInput} for command's `input` shape. + * @see {@link ListLogPatternSetsCommandOutput} for command's `response` shape. + * @see {@link ApplicationInsightsClientResolvedConfig | config} for command's `input` shape. + * */ export class ListLogPatternSetsCommand extends $Command< ListLogPatternSetsCommandInput, diff --git a/clients/client-application-insights/commands/ListLogPatternsCommand.ts b/clients/client-application-insights/commands/ListLogPatternsCommand.ts index 4381256ad39e..23cb558832c8 100644 --- a/clients/client-application-insights/commands/ListLogPatternsCommand.ts +++ b/clients/client-application-insights/commands/ListLogPatternsCommand.ts @@ -26,6 +26,20 @@ export interface ListLogPatternsCommandOutput extends ListLogPatternsResponse, _ /** *

Lists the log patterns in the specific log LogPatternSet.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ApplicationInsightsClient, ListLogPatternsCommand } from "@aws-sdk/client-application-insights"; // ES Modules import + * // const { ApplicationInsightsClient, ListLogPatternsCommand } = require("@aws-sdk/client-application-insights"); // CommonJS import + * const client = new ApplicationInsightsClient(config); + * const command = new ListLogPatternsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListLogPatternsCommandInput} for command's `input` shape. + * @see {@link ListLogPatternsCommandOutput} for command's `response` shape. + * @see {@link ApplicationInsightsClientResolvedConfig | config} for command's `input` shape. + * */ export class ListLogPatternsCommand extends $Command< ListLogPatternsCommandInput, diff --git a/clients/client-application-insights/commands/ListProblemsCommand.ts b/clients/client-application-insights/commands/ListProblemsCommand.ts index 6b280742e820..dab990aff9f7 100644 --- a/clients/client-application-insights/commands/ListProblemsCommand.ts +++ b/clients/client-application-insights/commands/ListProblemsCommand.ts @@ -26,6 +26,20 @@ export interface ListProblemsCommandOutput extends ListProblemsResponse, __Metad /** *

Lists the problems with your application.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ApplicationInsightsClient, ListProblemsCommand } from "@aws-sdk/client-application-insights"; // ES Modules import + * // const { ApplicationInsightsClient, ListProblemsCommand } = require("@aws-sdk/client-application-insights"); // CommonJS import + * const client = new ApplicationInsightsClient(config); + * const command = new ListProblemsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListProblemsCommandInput} for command's `input` shape. + * @see {@link ListProblemsCommandOutput} for command's `response` shape. + * @see {@link ApplicationInsightsClientResolvedConfig | config} for command's `input` shape. + * */ export class ListProblemsCommand extends $Command< ListProblemsCommandInput, diff --git a/clients/client-application-insights/commands/ListTagsForResourceCommand.ts b/clients/client-application-insights/commands/ListTagsForResourceCommand.ts index f484bf94db7e..0ed606d8a334 100644 --- a/clients/client-application-insights/commands/ListTagsForResourceCommand.ts +++ b/clients/client-application-insights/commands/ListTagsForResourceCommand.ts @@ -31,6 +31,20 @@ export interface ListTagsForResourceCommandOutput extends ListTagsForResourceRes * 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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ApplicationInsightsClient, ListTagsForResourceCommand } from "@aws-sdk/client-application-insights"; // ES Modules import + * // const { ApplicationInsightsClient, ListTagsForResourceCommand } = require("@aws-sdk/client-application-insights"); // CommonJS import + * const client = new ApplicationInsightsClient(config); + * const command = new ListTagsForResourceCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListTagsForResourceCommandInput} for command's `input` shape. + * @see {@link ListTagsForResourceCommandOutput} for command's `response` shape. + * @see {@link ApplicationInsightsClientResolvedConfig | config} for command's `input` shape. + * */ export class ListTagsForResourceCommand extends $Command< ListTagsForResourceCommandInput, diff --git a/clients/client-application-insights/commands/TagResourceCommand.ts b/clients/client-application-insights/commands/TagResourceCommand.ts index ea86318e1635..9d24502dba92 100644 --- a/clients/client-application-insights/commands/TagResourceCommand.ts +++ b/clients/client-application-insights/commands/TagResourceCommand.ts @@ -33,6 +33,20 @@ export interface TagResourceCommandOutput extends TagResourceResponse, __Metadat * 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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ApplicationInsightsClient, TagResourceCommand } from "@aws-sdk/client-application-insights"; // ES Modules import + * // const { ApplicationInsightsClient, TagResourceCommand } = require("@aws-sdk/client-application-insights"); // CommonJS import + * const client = new ApplicationInsightsClient(config); + * const command = new TagResourceCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link TagResourceCommandInput} for command's `input` shape. + * @see {@link TagResourceCommandOutput} for command's `response` shape. + * @see {@link ApplicationInsightsClientResolvedConfig | config} for command's `input` shape. + * */ export class TagResourceCommand extends $Command< TagResourceCommandInput, diff --git a/clients/client-application-insights/commands/UntagResourceCommand.ts b/clients/client-application-insights/commands/UntagResourceCommand.ts index 5e8dad7d6d61..742b60950917 100644 --- a/clients/client-application-insights/commands/UntagResourceCommand.ts +++ b/clients/client-application-insights/commands/UntagResourceCommand.ts @@ -26,6 +26,20 @@ export interface UntagResourceCommandOutput extends UntagResourceResponse, __Met /** *

Remove one or more tags (keys and values) from a specified application.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ApplicationInsightsClient, UntagResourceCommand } from "@aws-sdk/client-application-insights"; // ES Modules import + * // const { ApplicationInsightsClient, UntagResourceCommand } = require("@aws-sdk/client-application-insights"); // CommonJS import + * const client = new ApplicationInsightsClient(config); + * const command = new UntagResourceCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link UntagResourceCommandInput} for command's `input` shape. + * @see {@link UntagResourceCommandOutput} for command's `response` shape. + * @see {@link ApplicationInsightsClientResolvedConfig | config} for command's `input` shape. + * */ export class UntagResourceCommand extends $Command< UntagResourceCommandInput, diff --git a/clients/client-application-insights/commands/UpdateApplicationCommand.ts b/clients/client-application-insights/commands/UpdateApplicationCommand.ts index cfb452c52f37..2dda14fbe171 100644 --- a/clients/client-application-insights/commands/UpdateApplicationCommand.ts +++ b/clients/client-application-insights/commands/UpdateApplicationCommand.ts @@ -26,6 +26,20 @@ export interface UpdateApplicationCommandOutput extends UpdateApplicationRespons /** *

Updates the application.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ApplicationInsightsClient, UpdateApplicationCommand } from "@aws-sdk/client-application-insights"; // ES Modules import + * // const { ApplicationInsightsClient, UpdateApplicationCommand } = require("@aws-sdk/client-application-insights"); // CommonJS import + * const client = new ApplicationInsightsClient(config); + * const command = new UpdateApplicationCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link UpdateApplicationCommandInput} for command's `input` shape. + * @see {@link UpdateApplicationCommandOutput} for command's `response` shape. + * @see {@link ApplicationInsightsClientResolvedConfig | config} for command's `input` shape. + * */ export class UpdateApplicationCommand extends $Command< UpdateApplicationCommandInput, diff --git a/clients/client-application-insights/commands/UpdateComponentCommand.ts b/clients/client-application-insights/commands/UpdateComponentCommand.ts index 30748869d51d..07cb8f51947d 100644 --- a/clients/client-application-insights/commands/UpdateComponentCommand.ts +++ b/clients/client-application-insights/commands/UpdateComponentCommand.ts @@ -27,6 +27,20 @@ export interface UpdateComponentCommandOutput extends UpdateComponentResponse, _ /** *

Updates the custom component name and/or the list of resources that make up the * component.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ApplicationInsightsClient, UpdateComponentCommand } from "@aws-sdk/client-application-insights"; // ES Modules import + * // const { ApplicationInsightsClient, UpdateComponentCommand } = require("@aws-sdk/client-application-insights"); // CommonJS import + * const client = new ApplicationInsightsClient(config); + * const command = new UpdateComponentCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link UpdateComponentCommandInput} for command's `input` shape. + * @see {@link UpdateComponentCommandOutput} for command's `response` shape. + * @see {@link ApplicationInsightsClientResolvedConfig | config} for command's `input` shape. + * */ export class UpdateComponentCommand extends $Command< UpdateComponentCommandInput, diff --git a/clients/client-application-insights/commands/UpdateComponentConfigurationCommand.ts b/clients/client-application-insights/commands/UpdateComponentConfigurationCommand.ts index 3815f6cd28b0..99f02a9aeb39 100644 --- a/clients/client-application-insights/commands/UpdateComponentConfigurationCommand.ts +++ b/clients/client-application-insights/commands/UpdateComponentConfigurationCommand.ts @@ -30,6 +30,20 @@ export interface UpdateComponentConfigurationCommandOutput *

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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ApplicationInsightsClient, UpdateComponentConfigurationCommand } from "@aws-sdk/client-application-insights"; // ES Modules import + * // const { ApplicationInsightsClient, UpdateComponentConfigurationCommand } = require("@aws-sdk/client-application-insights"); // CommonJS import + * const client = new ApplicationInsightsClient(config); + * const command = new UpdateComponentConfigurationCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link UpdateComponentConfigurationCommandInput} for command's `input` shape. + * @see {@link UpdateComponentConfigurationCommandOutput} for command's `response` shape. + * @see {@link ApplicationInsightsClientResolvedConfig | config} for command's `input` shape. + * */ export class UpdateComponentConfigurationCommand extends $Command< UpdateComponentConfigurationCommandInput, diff --git a/clients/client-application-insights/commands/UpdateLogPatternCommand.ts b/clients/client-application-insights/commands/UpdateLogPatternCommand.ts index 195e7c9aef18..4889d4d42400 100644 --- a/clients/client-application-insights/commands/UpdateLogPatternCommand.ts +++ b/clients/client-application-insights/commands/UpdateLogPatternCommand.ts @@ -26,6 +26,20 @@ export interface UpdateLogPatternCommandOutput extends UpdateLogPatternResponse, /** *

Adds a log pattern to a LogPatternSet.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ApplicationInsightsClient, UpdateLogPatternCommand } from "@aws-sdk/client-application-insights"; // ES Modules import + * // const { ApplicationInsightsClient, UpdateLogPatternCommand } = require("@aws-sdk/client-application-insights"); // CommonJS import + * const client = new ApplicationInsightsClient(config); + * const command = new UpdateLogPatternCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link UpdateLogPatternCommandInput} for command's `input` shape. + * @see {@link UpdateLogPatternCommandOutput} for command's `response` shape. + * @see {@link ApplicationInsightsClientResolvedConfig | config} for command's `input` shape. + * */ export class UpdateLogPatternCommand extends $Command< UpdateLogPatternCommandInput, diff --git a/clients/client-application-insights/models/models_0.ts b/clients/client-application-insights/models/models_0.ts index bc99ea1c3419..d5727884e6d5 100644 --- a/clients/client-application-insights/models/models_0.ts +++ b/clients/client-application-insights/models/models_0.ts @@ -13,6 +13,9 @@ export interface AccessDeniedException extends __SmithyException, $MetadataBeare } export namespace AccessDeniedException { + /** + * @internal + */ export const filterSensitiveLog = (obj: AccessDeniedException): any => ({ ...obj, }); @@ -82,6 +85,9 @@ export interface ApplicationComponent { } export namespace ApplicationComponent { + /** + * @internal + */ export const filterSensitiveLog = (obj: ApplicationComponent): any => ({ ...obj, }); @@ -140,6 +146,9 @@ export interface ApplicationInfo { } export namespace ApplicationInfo { + /** + * @internal + */ export const filterSensitiveLog = (obj: ApplicationInfo): any => ({ ...obj, }); @@ -155,6 +164,9 @@ export interface BadRequestException extends __SmithyException, $MetadataBearer } export namespace BadRequestException { + /** + * @internal + */ export const filterSensitiveLog = (obj: BadRequestException): any => ({ ...obj, }); @@ -220,6 +232,9 @@ export interface ConfigurationEvent { } export namespace ConfigurationEvent { + /** + * @internal + */ export const filterSensitiveLog = (obj: ConfigurationEvent): any => ({ ...obj, }); @@ -268,6 +283,9 @@ export interface Tag { } export namespace Tag { + /** + * @internal + */ export const filterSensitiveLog = (obj: Tag): any => ({ ...obj, }); @@ -311,6 +329,9 @@ export interface CreateApplicationRequest { } export namespace CreateApplicationRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateApplicationRequest): any => ({ ...obj, }); @@ -324,6 +345,9 @@ export interface CreateApplicationResponse { } export namespace CreateApplicationResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateApplicationResponse): any => ({ ...obj, }); @@ -339,6 +363,9 @@ export interface InternalServerException extends __SmithyException, $MetadataBea } export namespace InternalServerException { + /** + * @internal + */ export const filterSensitiveLog = (obj: InternalServerException): any => ({ ...obj, }); @@ -354,6 +381,9 @@ export interface ResourceInUseException extends __SmithyException, $MetadataBear } export namespace ResourceInUseException { + /** + * @internal + */ export const filterSensitiveLog = (obj: ResourceInUseException): any => ({ ...obj, }); @@ -369,6 +399,9 @@ export interface ResourceNotFoundException extends __SmithyException, $MetadataB } export namespace ResourceNotFoundException { + /** + * @internal + */ export const filterSensitiveLog = (obj: ResourceNotFoundException): any => ({ ...obj, }); @@ -384,6 +417,9 @@ export interface TagsAlreadyExistException extends __SmithyException, $MetadataB } export namespace TagsAlreadyExistException { + /** + * @internal + */ export const filterSensitiveLog = (obj: TagsAlreadyExistException): any => ({ ...obj, }); @@ -399,6 +435,9 @@ export interface ValidationException extends __SmithyException, $MetadataBearer } export namespace ValidationException { + /** + * @internal + */ export const filterSensitiveLog = (obj: ValidationException): any => ({ ...obj, }); @@ -422,6 +461,9 @@ export interface CreateComponentRequest { } export namespace CreateComponentRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateComponentRequest): any => ({ ...obj, }); @@ -430,6 +472,9 @@ export namespace CreateComponentRequest { export interface CreateComponentResponse {} export namespace CreateComponentResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateComponentResponse): any => ({ ...obj, }); @@ -465,6 +510,9 @@ export interface CreateLogPatternRequest { } export namespace CreateLogPatternRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateLogPatternRequest): any => ({ ...obj, }); @@ -501,6 +549,9 @@ export interface LogPattern { } export namespace LogPattern { + /** + * @internal + */ export const filterSensitiveLog = (obj: LogPattern): any => ({ ...obj, }); @@ -519,6 +570,9 @@ export interface CreateLogPatternResponse { } export namespace CreateLogPatternResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateLogPatternResponse): any => ({ ...obj, }); @@ -532,6 +586,9 @@ export interface DeleteApplicationRequest { } export namespace DeleteApplicationRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteApplicationRequest): any => ({ ...obj, }); @@ -540,6 +597,9 @@ export namespace DeleteApplicationRequest { export interface DeleteApplicationResponse {} export namespace DeleteApplicationResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteApplicationResponse): any => ({ ...obj, }); @@ -558,6 +618,9 @@ export interface DeleteComponentRequest { } export namespace DeleteComponentRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteComponentRequest): any => ({ ...obj, }); @@ -566,6 +629,9 @@ export namespace DeleteComponentRequest { export interface DeleteComponentResponse {} export namespace DeleteComponentResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteComponentResponse): any => ({ ...obj, }); @@ -589,6 +655,9 @@ export interface DeleteLogPatternRequest { } export namespace DeleteLogPatternRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteLogPatternRequest): any => ({ ...obj, }); @@ -597,6 +666,9 @@ export namespace DeleteLogPatternRequest { export interface DeleteLogPatternResponse {} export namespace DeleteLogPatternResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteLogPatternResponse): any => ({ ...obj, }); @@ -610,6 +682,9 @@ export interface DescribeApplicationRequest { } export namespace DescribeApplicationRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeApplicationRequest): any => ({ ...obj, }); @@ -623,6 +698,9 @@ export interface DescribeApplicationResponse { } export namespace DescribeApplicationResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeApplicationResponse): any => ({ ...obj, }); @@ -641,6 +719,9 @@ export interface DescribeComponentRequest { } export namespace DescribeComponentRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeComponentRequest): any => ({ ...obj, }); @@ -660,6 +741,9 @@ export interface DescribeComponentResponse { } export namespace DescribeComponentResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeComponentResponse): any => ({ ...obj, }); @@ -678,6 +762,9 @@ export interface DescribeComponentConfigurationRequest { } export namespace DescribeComponentConfigurationRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeComponentConfigurationRequest): any => ({ ...obj, }); @@ -704,6 +791,9 @@ export interface DescribeComponentConfigurationResponse { } export namespace DescribeComponentConfigurationResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeComponentConfigurationResponse): any => ({ ...obj, }); @@ -729,6 +819,9 @@ export interface DescribeComponentConfigurationRecommendationRequest { } export namespace DescribeComponentConfigurationRecommendationRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeComponentConfigurationRecommendationRequest): any => ({ ...obj, }); @@ -742,6 +835,9 @@ export interface DescribeComponentConfigurationRecommendationResponse { } export namespace DescribeComponentConfigurationRecommendationResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeComponentConfigurationRecommendationResponse): any => ({ ...obj, }); @@ -765,6 +861,9 @@ export interface DescribeLogPatternRequest { } export namespace DescribeLogPatternRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeLogPatternRequest): any => ({ ...obj, }); @@ -783,6 +882,9 @@ export interface DescribeLogPatternResponse { } export namespace DescribeLogPatternResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeLogPatternResponse): any => ({ ...obj, }); @@ -796,6 +898,9 @@ export interface DescribeObservationRequest { } export namespace DescribeObservationRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeObservationRequest): any => ({ ...obj, }); @@ -1081,6 +1186,9 @@ export interface Observation { } export namespace Observation { + /** + * @internal + */ export const filterSensitiveLog = (obj: Observation): any => ({ ...obj, }); @@ -1094,6 +1202,9 @@ export interface DescribeObservationResponse { } export namespace DescribeObservationResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeObservationResponse): any => ({ ...obj, }); @@ -1107,6 +1218,9 @@ export interface DescribeProblemRequest { } export namespace DescribeProblemRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeProblemRequest): any => ({ ...obj, }); @@ -1176,6 +1290,9 @@ export interface Problem { } export namespace Problem { + /** + * @internal + */ export const filterSensitiveLog = (obj: Problem): any => ({ ...obj, }); @@ -1189,6 +1306,9 @@ export interface DescribeProblemResponse { } export namespace DescribeProblemResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeProblemResponse): any => ({ ...obj, }); @@ -1202,6 +1322,9 @@ export interface DescribeProblemObservationsRequest { } export namespace DescribeProblemObservationsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeProblemObservationsRequest): any => ({ ...obj, }); @@ -1218,6 +1341,9 @@ export interface RelatedObservations { } export namespace RelatedObservations { + /** + * @internal + */ export const filterSensitiveLog = (obj: RelatedObservations): any => ({ ...obj, }); @@ -1231,6 +1357,9 @@ export interface DescribeProblemObservationsResponse { } export namespace DescribeProblemObservationsResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeProblemObservationsResponse): any => ({ ...obj, }); @@ -1250,6 +1379,9 @@ export interface ListApplicationsRequest { } export namespace ListApplicationsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListApplicationsRequest): any => ({ ...obj, }); @@ -1269,6 +1401,9 @@ export interface ListApplicationsResponse { } export namespace ListApplicationsResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListApplicationsResponse): any => ({ ...obj, }); @@ -1293,6 +1428,9 @@ export interface ListComponentsRequest { } export namespace ListComponentsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListComponentsRequest): any => ({ ...obj, }); @@ -1311,6 +1449,9 @@ export interface ListComponentsResponse { } export namespace ListComponentsResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListComponentsResponse): any => ({ ...obj, }); @@ -1358,6 +1499,9 @@ export interface ListConfigurationHistoryRequest { } export namespace ListConfigurationHistoryRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListConfigurationHistoryRequest): any => ({ ...obj, }); @@ -1380,6 +1524,9 @@ export interface ListConfigurationHistoryResponse { } export namespace ListConfigurationHistoryResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListConfigurationHistoryResponse): any => ({ ...obj, }); @@ -1409,6 +1556,9 @@ export interface ListLogPatternsRequest { } export namespace ListLogPatternsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListLogPatternsRequest): any => ({ ...obj, }); @@ -1433,6 +1583,9 @@ export interface ListLogPatternsResponse { } export namespace ListLogPatternsResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListLogPatternsResponse): any => ({ ...obj, }); @@ -1457,6 +1610,9 @@ export interface ListLogPatternSetsRequest { } export namespace ListLogPatternSetsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListLogPatternSetsRequest): any => ({ ...obj, }); @@ -1481,6 +1637,9 @@ export interface ListLogPatternSetsResponse { } export namespace ListLogPatternSetsResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListLogPatternSetsResponse): any => ({ ...obj, }); @@ -1517,6 +1676,9 @@ export interface ListProblemsRequest { } export namespace ListProblemsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListProblemsRequest): any => ({ ...obj, }); @@ -1536,6 +1698,9 @@ export interface ListProblemsResponse { } export namespace ListProblemsResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListProblemsResponse): any => ({ ...obj, }); @@ -1550,6 +1715,9 @@ export interface ListTagsForResourceRequest { } export namespace ListTagsForResourceRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListTagsForResourceRequest): any => ({ ...obj, }); @@ -1565,6 +1733,9 @@ export interface ListTagsForResourceResponse { } export namespace ListTagsForResourceResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListTagsForResourceResponse): any => ({ ...obj, }); @@ -1586,6 +1757,9 @@ export interface TagResourceRequest { } export namespace TagResourceRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: TagResourceRequest): any => ({ ...obj, }); @@ -1594,6 +1768,9 @@ export namespace TagResourceRequest { export interface TagResourceResponse {} export namespace TagResourceResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: TagResourceResponse): any => ({ ...obj, }); @@ -1614,6 +1791,9 @@ export interface TooManyTagsException extends __SmithyException, $MetadataBearer } export namespace TooManyTagsException { + /** + * @internal + */ export const filterSensitiveLog = (obj: TooManyTagsException): any => ({ ...obj, }); @@ -1636,6 +1816,9 @@ export interface UntagResourceRequest { } export namespace UntagResourceRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: UntagResourceRequest): any => ({ ...obj, }); @@ -1644,6 +1827,9 @@ export namespace UntagResourceRequest { export interface UntagResourceResponse {} export namespace UntagResourceResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: UntagResourceResponse): any => ({ ...obj, }); @@ -1684,6 +1870,9 @@ export interface UpdateApplicationRequest { } export namespace UpdateApplicationRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateApplicationRequest): any => ({ ...obj, }); @@ -1697,6 +1886,9 @@ export interface UpdateApplicationResponse { } export namespace UpdateApplicationResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateApplicationResponse): any => ({ ...obj, }); @@ -1725,6 +1917,9 @@ export interface UpdateComponentRequest { } export namespace UpdateComponentRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateComponentRequest): any => ({ ...obj, }); @@ -1733,6 +1928,9 @@ export namespace UpdateComponentRequest { export interface UpdateComponentResponse {} export namespace UpdateComponentResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateComponentResponse): any => ({ ...obj, }); @@ -1770,6 +1968,9 @@ export interface UpdateComponentConfigurationRequest { } export namespace UpdateComponentConfigurationRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateComponentConfigurationRequest): any => ({ ...obj, }); @@ -1778,6 +1979,9 @@ export namespace UpdateComponentConfigurationRequest { export interface UpdateComponentConfigurationResponse {} export namespace UpdateComponentConfigurationResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateComponentConfigurationResponse): any => ({ ...obj, }); @@ -1813,6 +2017,9 @@ export interface UpdateLogPatternRequest { } export namespace UpdateLogPatternRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateLogPatternRequest): any => ({ ...obj, }); @@ -1831,6 +2038,9 @@ export interface UpdateLogPatternResponse { } export namespace UpdateLogPatternResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateLogPatternResponse): any => ({ ...obj, }); diff --git a/clients/client-appstream/commands/AssociateFleetCommand.ts b/clients/client-appstream/commands/AssociateFleetCommand.ts index cb19fead17e1..6171afdd3988 100644 --- a/clients/client-appstream/commands/AssociateFleetCommand.ts +++ b/clients/client-appstream/commands/AssociateFleetCommand.ts @@ -22,6 +22,20 @@ export interface AssociateFleetCommandOutput extends AssociateFleetResult, __Met /** *

Associates the specified fleet with the specified stack.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { AppStreamClient, AssociateFleetCommand } from "@aws-sdk/client-appstream"; // ES Modules import + * // const { AppStreamClient, AssociateFleetCommand } = require("@aws-sdk/client-appstream"); // CommonJS import + * const client = new AppStreamClient(config); + * const command = new AssociateFleetCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link AssociateFleetCommandInput} for command's `input` shape. + * @see {@link AssociateFleetCommandOutput} for command's `response` shape. + * @see {@link AppStreamClientResolvedConfig | config} for command's `input` shape. + * */ export class AssociateFleetCommand extends $Command< AssociateFleetCommandInput, diff --git a/clients/client-appstream/commands/BatchAssociateUserStackCommand.ts b/clients/client-appstream/commands/BatchAssociateUserStackCommand.ts index 3ed36f0c2656..72b51389b2ea 100644 --- a/clients/client-appstream/commands/BatchAssociateUserStackCommand.ts +++ b/clients/client-appstream/commands/BatchAssociateUserStackCommand.ts @@ -22,6 +22,20 @@ export interface BatchAssociateUserStackCommandOutput extends BatchAssociateUser /** *

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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { AppStreamClient, BatchAssociateUserStackCommand } from "@aws-sdk/client-appstream"; // ES Modules import + * // const { AppStreamClient, BatchAssociateUserStackCommand } = require("@aws-sdk/client-appstream"); // CommonJS import + * const client = new AppStreamClient(config); + * const command = new BatchAssociateUserStackCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link BatchAssociateUserStackCommandInput} for command's `input` shape. + * @see {@link BatchAssociateUserStackCommandOutput} for command's `response` shape. + * @see {@link AppStreamClientResolvedConfig | config} for command's `input` shape. + * */ export class BatchAssociateUserStackCommand extends $Command< BatchAssociateUserStackCommandInput, diff --git a/clients/client-appstream/commands/BatchDisassociateUserStackCommand.ts b/clients/client-appstream/commands/BatchDisassociateUserStackCommand.ts index 5af9de538b2c..02a7e62229f5 100644 --- a/clients/client-appstream/commands/BatchDisassociateUserStackCommand.ts +++ b/clients/client-appstream/commands/BatchDisassociateUserStackCommand.ts @@ -22,6 +22,20 @@ export interface BatchDisassociateUserStackCommandOutput extends BatchDisassocia /** *

Disassociates the specified users from the specified stacks.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { AppStreamClient, BatchDisassociateUserStackCommand } from "@aws-sdk/client-appstream"; // ES Modules import + * // const { AppStreamClient, BatchDisassociateUserStackCommand } = require("@aws-sdk/client-appstream"); // CommonJS import + * const client = new AppStreamClient(config); + * const command = new BatchDisassociateUserStackCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link BatchDisassociateUserStackCommandInput} for command's `input` shape. + * @see {@link BatchDisassociateUserStackCommandOutput} for command's `response` shape. + * @see {@link AppStreamClientResolvedConfig | config} for command's `input` shape. + * */ export class BatchDisassociateUserStackCommand extends $Command< BatchDisassociateUserStackCommandInput, diff --git a/clients/client-appstream/commands/CopyImageCommand.ts b/clients/client-appstream/commands/CopyImageCommand.ts index 00965ee9989d..cdd4b291a68c 100644 --- a/clients/client-appstream/commands/CopyImageCommand.ts +++ b/clients/client-appstream/commands/CopyImageCommand.ts @@ -19,6 +19,20 @@ export interface CopyImageCommandOutput extends CopyImageResponse, __MetadataBea /** *

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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { AppStreamClient, CopyImageCommand } from "@aws-sdk/client-appstream"; // ES Modules import + * // const { AppStreamClient, CopyImageCommand } = require("@aws-sdk/client-appstream"); // CommonJS import + * const client = new AppStreamClient(config); + * const command = new CopyImageCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CopyImageCommandInput} for command's `input` shape. + * @see {@link CopyImageCommandOutput} for command's `response` shape. + * @see {@link AppStreamClientResolvedConfig | config} for command's `input` shape. + * */ export class CopyImageCommand extends $Command< CopyImageCommandInput, diff --git a/clients/client-appstream/commands/CreateDirectoryConfigCommand.ts b/clients/client-appstream/commands/CreateDirectoryConfigCommand.ts index 5b46fd78ac6d..0a0c0b4fd508 100644 --- a/clients/client-appstream/commands/CreateDirectoryConfigCommand.ts +++ b/clients/client-appstream/commands/CreateDirectoryConfigCommand.ts @@ -22,6 +22,20 @@ export interface CreateDirectoryConfigCommandOutput extends CreateDirectoryConfi /** *

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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { AppStreamClient, CreateDirectoryConfigCommand } from "@aws-sdk/client-appstream"; // ES Modules import + * // const { AppStreamClient, CreateDirectoryConfigCommand } = require("@aws-sdk/client-appstream"); // CommonJS import + * const client = new AppStreamClient(config); + * const command = new CreateDirectoryConfigCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreateDirectoryConfigCommandInput} for command's `input` shape. + * @see {@link CreateDirectoryConfigCommandOutput} for command's `response` shape. + * @see {@link AppStreamClientResolvedConfig | config} for command's `input` shape. + * */ export class CreateDirectoryConfigCommand extends $Command< CreateDirectoryConfigCommandInput, diff --git a/clients/client-appstream/commands/CreateFleetCommand.ts b/clients/client-appstream/commands/CreateFleetCommand.ts index b6b0bbe51472..fbb8914ceb2a 100644 --- a/clients/client-appstream/commands/CreateFleetCommand.ts +++ b/clients/client-appstream/commands/CreateFleetCommand.ts @@ -22,6 +22,20 @@ export interface CreateFleetCommandOutput extends CreateFleetResult, __MetadataB /** *

Creates a fleet. A fleet consists of streaming instances that run a specified image.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { AppStreamClient, CreateFleetCommand } from "@aws-sdk/client-appstream"; // ES Modules import + * // const { AppStreamClient, CreateFleetCommand } = require("@aws-sdk/client-appstream"); // CommonJS import + * const client = new AppStreamClient(config); + * const command = new CreateFleetCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreateFleetCommandInput} for command's `input` shape. + * @see {@link CreateFleetCommandOutput} for command's `response` shape. + * @see {@link AppStreamClientResolvedConfig | config} for command's `input` shape. + * */ export class CreateFleetCommand extends $Command< CreateFleetCommandInput, diff --git a/clients/client-appstream/commands/CreateImageBuilderCommand.ts b/clients/client-appstream/commands/CreateImageBuilderCommand.ts index 9678e111ca24..5e39e752055b 100644 --- a/clients/client-appstream/commands/CreateImageBuilderCommand.ts +++ b/clients/client-appstream/commands/CreateImageBuilderCommand.ts @@ -23,6 +23,20 @@ export interface CreateImageBuilderCommandOutput extends CreateImageBuilderResul /** *

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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { AppStreamClient, CreateImageBuilderCommand } from "@aws-sdk/client-appstream"; // ES Modules import + * // const { AppStreamClient, CreateImageBuilderCommand } = require("@aws-sdk/client-appstream"); // CommonJS import + * const client = new AppStreamClient(config); + * const command = new CreateImageBuilderCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreateImageBuilderCommandInput} for command's `input` shape. + * @see {@link CreateImageBuilderCommandOutput} for command's `response` shape. + * @see {@link AppStreamClientResolvedConfig | config} for command's `input` shape. + * */ export class CreateImageBuilderCommand extends $Command< CreateImageBuilderCommandInput, diff --git a/clients/client-appstream/commands/CreateImageBuilderStreamingURLCommand.ts b/clients/client-appstream/commands/CreateImageBuilderStreamingURLCommand.ts index 8d91f2b951a4..16397a118a23 100644 --- a/clients/client-appstream/commands/CreateImageBuilderStreamingURLCommand.ts +++ b/clients/client-appstream/commands/CreateImageBuilderStreamingURLCommand.ts @@ -24,6 +24,20 @@ export interface CreateImageBuilderStreamingURLCommandOutput /** *

Creates a URL to start an image builder streaming session.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { AppStreamClient, CreateImageBuilderStreamingURLCommand } from "@aws-sdk/client-appstream"; // ES Modules import + * // const { AppStreamClient, CreateImageBuilderStreamingURLCommand } = require("@aws-sdk/client-appstream"); // CommonJS import + * const client = new AppStreamClient(config); + * const command = new CreateImageBuilderStreamingURLCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreateImageBuilderStreamingURLCommandInput} for command's `input` shape. + * @see {@link CreateImageBuilderStreamingURLCommandOutput} for command's `response` shape. + * @see {@link AppStreamClientResolvedConfig | config} for command's `input` shape. + * */ export class CreateImageBuilderStreamingURLCommand extends $Command< CreateImageBuilderStreamingURLCommandInput, diff --git a/clients/client-appstream/commands/CreateStackCommand.ts b/clients/client-appstream/commands/CreateStackCommand.ts index 4600b422ee09..304f41d68c19 100644 --- a/clients/client-appstream/commands/CreateStackCommand.ts +++ b/clients/client-appstream/commands/CreateStackCommand.ts @@ -22,6 +22,20 @@ export interface CreateStackCommandOutput extends CreateStackResult, __MetadataB /** *

Creates a stack to start streaming applications to users. A stack consists of an associated fleet, user access policies, and storage configurations.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { AppStreamClient, CreateStackCommand } from "@aws-sdk/client-appstream"; // ES Modules import + * // const { AppStreamClient, CreateStackCommand } = require("@aws-sdk/client-appstream"); // CommonJS import + * const client = new AppStreamClient(config); + * const command = new CreateStackCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreateStackCommandInput} for command's `input` shape. + * @see {@link CreateStackCommandOutput} for command's `response` shape. + * @see {@link AppStreamClientResolvedConfig | config} for command's `input` shape. + * */ export class CreateStackCommand extends $Command< CreateStackCommandInput, diff --git a/clients/client-appstream/commands/CreateStreamingURLCommand.ts b/clients/client-appstream/commands/CreateStreamingURLCommand.ts index e6c5222621ca..a4d965e7b882 100644 --- a/clients/client-appstream/commands/CreateStreamingURLCommand.ts +++ b/clients/client-appstream/commands/CreateStreamingURLCommand.ts @@ -22,6 +22,20 @@ export interface CreateStreamingURLCommandOutput extends CreateStreamingURLResul /** *

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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { AppStreamClient, CreateStreamingURLCommand } from "@aws-sdk/client-appstream"; // ES Modules import + * // const { AppStreamClient, CreateStreamingURLCommand } = require("@aws-sdk/client-appstream"); // CommonJS import + * const client = new AppStreamClient(config); + * const command = new CreateStreamingURLCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreateStreamingURLCommandInput} for command's `input` shape. + * @see {@link CreateStreamingURLCommandOutput} for command's `response` shape. + * @see {@link AppStreamClientResolvedConfig | config} for command's `input` shape. + * */ export class CreateStreamingURLCommand extends $Command< CreateStreamingURLCommandInput, diff --git a/clients/client-appstream/commands/CreateUpdatedImageCommand.ts b/clients/client-appstream/commands/CreateUpdatedImageCommand.ts index 0501a9943cf9..cb7aa92c7843 100644 --- a/clients/client-appstream/commands/CreateUpdatedImageCommand.ts +++ b/clients/client-appstream/commands/CreateUpdatedImageCommand.ts @@ -25,6 +25,20 @@ export interface CreateUpdatedImageCommandOutput extends CreateUpdatedImageResul * *

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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { AppStreamClient, CreateUpdatedImageCommand } from "@aws-sdk/client-appstream"; // ES Modules import + * // const { AppStreamClient, CreateUpdatedImageCommand } = require("@aws-sdk/client-appstream"); // CommonJS import + * const client = new AppStreamClient(config); + * const command = new CreateUpdatedImageCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreateUpdatedImageCommandInput} for command's `input` shape. + * @see {@link CreateUpdatedImageCommandOutput} for command's `response` shape. + * @see {@link AppStreamClientResolvedConfig | config} for command's `input` shape. + * */ export class CreateUpdatedImageCommand extends $Command< CreateUpdatedImageCommandInput, diff --git a/clients/client-appstream/commands/CreateUsageReportSubscriptionCommand.ts b/clients/client-appstream/commands/CreateUsageReportSubscriptionCommand.ts index 5f30f389f9e7..23bb90cf9f51 100644 --- a/clients/client-appstream/commands/CreateUsageReportSubscriptionCommand.ts +++ b/clients/client-appstream/commands/CreateUsageReportSubscriptionCommand.ts @@ -24,6 +24,20 @@ export interface CreateUsageReportSubscriptionCommandOutput /** *

Creates a usage report subscription. Usage reports are generated daily.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { AppStreamClient, CreateUsageReportSubscriptionCommand } from "@aws-sdk/client-appstream"; // ES Modules import + * // const { AppStreamClient, CreateUsageReportSubscriptionCommand } = require("@aws-sdk/client-appstream"); // CommonJS import + * const client = new AppStreamClient(config); + * const command = new CreateUsageReportSubscriptionCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreateUsageReportSubscriptionCommandInput} for command's `input` shape. + * @see {@link CreateUsageReportSubscriptionCommandOutput} for command's `response` shape. + * @see {@link AppStreamClientResolvedConfig | config} for command's `input` shape. + * */ export class CreateUsageReportSubscriptionCommand extends $Command< CreateUsageReportSubscriptionCommandInput, diff --git a/clients/client-appstream/commands/CreateUserCommand.ts b/clients/client-appstream/commands/CreateUserCommand.ts index f713e5618665..1e35600520fd 100644 --- a/clients/client-appstream/commands/CreateUserCommand.ts +++ b/clients/client-appstream/commands/CreateUserCommand.ts @@ -22,6 +22,20 @@ export interface CreateUserCommandOutput extends CreateUserResult, __MetadataBea /** *

Creates a new user in the user pool.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { AppStreamClient, CreateUserCommand } from "@aws-sdk/client-appstream"; // ES Modules import + * // const { AppStreamClient, CreateUserCommand } = require("@aws-sdk/client-appstream"); // CommonJS import + * const client = new AppStreamClient(config); + * const command = new CreateUserCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreateUserCommandInput} for command's `input` shape. + * @see {@link CreateUserCommandOutput} for command's `response` shape. + * @see {@link AppStreamClientResolvedConfig | config} for command's `input` shape. + * */ export class CreateUserCommand extends $Command< CreateUserCommandInput, diff --git a/clients/client-appstream/commands/DeleteDirectoryConfigCommand.ts b/clients/client-appstream/commands/DeleteDirectoryConfigCommand.ts index 414d5cc7c8af..0e27a93c0092 100644 --- a/clients/client-appstream/commands/DeleteDirectoryConfigCommand.ts +++ b/clients/client-appstream/commands/DeleteDirectoryConfigCommand.ts @@ -22,6 +22,20 @@ export interface DeleteDirectoryConfigCommandOutput extends DeleteDirectoryConfi /** *

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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { AppStreamClient, DeleteDirectoryConfigCommand } from "@aws-sdk/client-appstream"; // ES Modules import + * // const { AppStreamClient, DeleteDirectoryConfigCommand } = require("@aws-sdk/client-appstream"); // CommonJS import + * const client = new AppStreamClient(config); + * const command = new DeleteDirectoryConfigCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteDirectoryConfigCommandInput} for command's `input` shape. + * @see {@link DeleteDirectoryConfigCommandOutput} for command's `response` shape. + * @see {@link AppStreamClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteDirectoryConfigCommand extends $Command< DeleteDirectoryConfigCommandInput, diff --git a/clients/client-appstream/commands/DeleteFleetCommand.ts b/clients/client-appstream/commands/DeleteFleetCommand.ts index 27ac822e2252..ee223ae4bec2 100644 --- a/clients/client-appstream/commands/DeleteFleetCommand.ts +++ b/clients/client-appstream/commands/DeleteFleetCommand.ts @@ -22,6 +22,20 @@ export interface DeleteFleetCommandOutput extends DeleteFleetResult, __MetadataB /** *

Deletes the specified fleet.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { AppStreamClient, DeleteFleetCommand } from "@aws-sdk/client-appstream"; // ES Modules import + * // const { AppStreamClient, DeleteFleetCommand } = require("@aws-sdk/client-appstream"); // CommonJS import + * const client = new AppStreamClient(config); + * const command = new DeleteFleetCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteFleetCommandInput} for command's `input` shape. + * @see {@link DeleteFleetCommandOutput} for command's `response` shape. + * @see {@link AppStreamClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteFleetCommand extends $Command< DeleteFleetCommandInput, diff --git a/clients/client-appstream/commands/DeleteImageBuilderCommand.ts b/clients/client-appstream/commands/DeleteImageBuilderCommand.ts index 7883a10a849c..af122e93fab5 100644 --- a/clients/client-appstream/commands/DeleteImageBuilderCommand.ts +++ b/clients/client-appstream/commands/DeleteImageBuilderCommand.ts @@ -22,6 +22,20 @@ export interface DeleteImageBuilderCommandOutput extends DeleteImageBuilderResul /** *

Deletes the specified image builder and releases the capacity.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { AppStreamClient, DeleteImageBuilderCommand } from "@aws-sdk/client-appstream"; // ES Modules import + * // const { AppStreamClient, DeleteImageBuilderCommand } = require("@aws-sdk/client-appstream"); // CommonJS import + * const client = new AppStreamClient(config); + * const command = new DeleteImageBuilderCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteImageBuilderCommandInput} for command's `input` shape. + * @see {@link DeleteImageBuilderCommandOutput} for command's `response` shape. + * @see {@link AppStreamClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteImageBuilderCommand extends $Command< DeleteImageBuilderCommandInput, diff --git a/clients/client-appstream/commands/DeleteImageCommand.ts b/clients/client-appstream/commands/DeleteImageCommand.ts index 132feeb1659e..9d453387d4a9 100644 --- a/clients/client-appstream/commands/DeleteImageCommand.ts +++ b/clients/client-appstream/commands/DeleteImageCommand.ts @@ -23,6 +23,20 @@ export interface DeleteImageCommandOutput extends DeleteImageResult, __MetadataB /** *

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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { AppStreamClient, DeleteImageCommand } from "@aws-sdk/client-appstream"; // ES Modules import + * // const { AppStreamClient, DeleteImageCommand } = require("@aws-sdk/client-appstream"); // CommonJS import + * const client = new AppStreamClient(config); + * const command = new DeleteImageCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteImageCommandInput} for command's `input` shape. + * @see {@link DeleteImageCommandOutput} for command's `response` shape. + * @see {@link AppStreamClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteImageCommand extends $Command< DeleteImageCommandInput, diff --git a/clients/client-appstream/commands/DeleteImagePermissionsCommand.ts b/clients/client-appstream/commands/DeleteImagePermissionsCommand.ts index 161e72118bed..1016e30b6372 100644 --- a/clients/client-appstream/commands/DeleteImagePermissionsCommand.ts +++ b/clients/client-appstream/commands/DeleteImagePermissionsCommand.ts @@ -22,6 +22,20 @@ export interface DeleteImagePermissionsCommandOutput extends DeleteImagePermissi /** *

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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { AppStreamClient, DeleteImagePermissionsCommand } from "@aws-sdk/client-appstream"; // ES Modules import + * // const { AppStreamClient, DeleteImagePermissionsCommand } = require("@aws-sdk/client-appstream"); // CommonJS import + * const client = new AppStreamClient(config); + * const command = new DeleteImagePermissionsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteImagePermissionsCommandInput} for command's `input` shape. + * @see {@link DeleteImagePermissionsCommandOutput} for command's `response` shape. + * @see {@link AppStreamClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteImagePermissionsCommand extends $Command< DeleteImagePermissionsCommandInput, diff --git a/clients/client-appstream/commands/DeleteStackCommand.ts b/clients/client-appstream/commands/DeleteStackCommand.ts index 6c84d3c1bc9e..ab8e2365cf2f 100644 --- a/clients/client-appstream/commands/DeleteStackCommand.ts +++ b/clients/client-appstream/commands/DeleteStackCommand.ts @@ -22,6 +22,20 @@ export interface DeleteStackCommandOutput extends DeleteStackResult, __MetadataB /** *

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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { AppStreamClient, DeleteStackCommand } from "@aws-sdk/client-appstream"; // ES Modules import + * // const { AppStreamClient, DeleteStackCommand } = require("@aws-sdk/client-appstream"); // CommonJS import + * const client = new AppStreamClient(config); + * const command = new DeleteStackCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteStackCommandInput} for command's `input` shape. + * @see {@link DeleteStackCommandOutput} for command's `response` shape. + * @see {@link AppStreamClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteStackCommand extends $Command< DeleteStackCommandInput, diff --git a/clients/client-appstream/commands/DeleteUsageReportSubscriptionCommand.ts b/clients/client-appstream/commands/DeleteUsageReportSubscriptionCommand.ts index 7b82d562b418..adac12ecbb61 100644 --- a/clients/client-appstream/commands/DeleteUsageReportSubscriptionCommand.ts +++ b/clients/client-appstream/commands/DeleteUsageReportSubscriptionCommand.ts @@ -24,6 +24,20 @@ export interface DeleteUsageReportSubscriptionCommandOutput /** *

Disables usage report generation.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { AppStreamClient, DeleteUsageReportSubscriptionCommand } from "@aws-sdk/client-appstream"; // ES Modules import + * // const { AppStreamClient, DeleteUsageReportSubscriptionCommand } = require("@aws-sdk/client-appstream"); // CommonJS import + * const client = new AppStreamClient(config); + * const command = new DeleteUsageReportSubscriptionCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteUsageReportSubscriptionCommandInput} for command's `input` shape. + * @see {@link DeleteUsageReportSubscriptionCommandOutput} for command's `response` shape. + * @see {@link AppStreamClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteUsageReportSubscriptionCommand extends $Command< DeleteUsageReportSubscriptionCommandInput, diff --git a/clients/client-appstream/commands/DeleteUserCommand.ts b/clients/client-appstream/commands/DeleteUserCommand.ts index e3a680e3d04a..0720068788bc 100644 --- a/clients/client-appstream/commands/DeleteUserCommand.ts +++ b/clients/client-appstream/commands/DeleteUserCommand.ts @@ -22,6 +22,20 @@ export interface DeleteUserCommandOutput extends DeleteUserResult, __MetadataBea /** *

Deletes a user from the user pool.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { AppStreamClient, DeleteUserCommand } from "@aws-sdk/client-appstream"; // ES Modules import + * // const { AppStreamClient, DeleteUserCommand } = require("@aws-sdk/client-appstream"); // CommonJS import + * const client = new AppStreamClient(config); + * const command = new DeleteUserCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteUserCommandInput} for command's `input` shape. + * @see {@link DeleteUserCommandOutput} for command's `response` shape. + * @see {@link AppStreamClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteUserCommand extends $Command< DeleteUserCommandInput, diff --git a/clients/client-appstream/commands/DescribeDirectoryConfigsCommand.ts b/clients/client-appstream/commands/DescribeDirectoryConfigsCommand.ts index a4fd5a8be00a..7639b1d308f7 100644 --- a/clients/client-appstream/commands/DescribeDirectoryConfigsCommand.ts +++ b/clients/client-appstream/commands/DescribeDirectoryConfigsCommand.ts @@ -24,6 +24,20 @@ export interface DescribeDirectoryConfigsCommandOutput extends DescribeDirectory *

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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { AppStreamClient, DescribeDirectoryConfigsCommand } from "@aws-sdk/client-appstream"; // ES Modules import + * // const { AppStreamClient, DescribeDirectoryConfigsCommand } = require("@aws-sdk/client-appstream"); // CommonJS import + * const client = new AppStreamClient(config); + * const command = new DescribeDirectoryConfigsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeDirectoryConfigsCommandInput} for command's `input` shape. + * @see {@link DescribeDirectoryConfigsCommandOutput} for command's `response` shape. + * @see {@link AppStreamClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeDirectoryConfigsCommand extends $Command< DescribeDirectoryConfigsCommandInput, diff --git a/clients/client-appstream/commands/DescribeFleetsCommand.ts b/clients/client-appstream/commands/DescribeFleetsCommand.ts index b528250b625f..0375b1dcc09a 100644 --- a/clients/client-appstream/commands/DescribeFleetsCommand.ts +++ b/clients/client-appstream/commands/DescribeFleetsCommand.ts @@ -22,6 +22,20 @@ export interface DescribeFleetsCommandOutput extends DescribeFleetsResult, __Met /** *

Retrieves a list that describes one or more specified fleets, if the fleet names are provided. Otherwise, all fleets in the account are described.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { AppStreamClient, DescribeFleetsCommand } from "@aws-sdk/client-appstream"; // ES Modules import + * // const { AppStreamClient, DescribeFleetsCommand } = require("@aws-sdk/client-appstream"); // CommonJS import + * const client = new AppStreamClient(config); + * const command = new DescribeFleetsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeFleetsCommandInput} for command's `input` shape. + * @see {@link DescribeFleetsCommandOutput} for command's `response` shape. + * @see {@link AppStreamClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeFleetsCommand extends $Command< DescribeFleetsCommandInput, diff --git a/clients/client-appstream/commands/DescribeImageBuildersCommand.ts b/clients/client-appstream/commands/DescribeImageBuildersCommand.ts index f1331abcf2d5..a9e38d71569e 100644 --- a/clients/client-appstream/commands/DescribeImageBuildersCommand.ts +++ b/clients/client-appstream/commands/DescribeImageBuildersCommand.ts @@ -22,6 +22,20 @@ export interface DescribeImageBuildersCommandOutput extends DescribeImageBuilder /** *

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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { AppStreamClient, DescribeImageBuildersCommand } from "@aws-sdk/client-appstream"; // ES Modules import + * // const { AppStreamClient, DescribeImageBuildersCommand } = require("@aws-sdk/client-appstream"); // CommonJS import + * const client = new AppStreamClient(config); + * const command = new DescribeImageBuildersCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeImageBuildersCommandInput} for command's `input` shape. + * @see {@link DescribeImageBuildersCommandOutput} for command's `response` shape. + * @see {@link AppStreamClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeImageBuildersCommand extends $Command< DescribeImageBuildersCommandInput, diff --git a/clients/client-appstream/commands/DescribeImagePermissionsCommand.ts b/clients/client-appstream/commands/DescribeImagePermissionsCommand.ts index a458cb5bd84a..29c8a11548f0 100644 --- a/clients/client-appstream/commands/DescribeImagePermissionsCommand.ts +++ b/clients/client-appstream/commands/DescribeImagePermissionsCommand.ts @@ -22,6 +22,20 @@ export interface DescribeImagePermissionsCommandOutput extends DescribeImagePerm /** *

Retrieves a list that describes the permissions for shared AWS account IDs on a private image that you own.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { AppStreamClient, DescribeImagePermissionsCommand } from "@aws-sdk/client-appstream"; // ES Modules import + * // const { AppStreamClient, DescribeImagePermissionsCommand } = require("@aws-sdk/client-appstream"); // CommonJS import + * const client = new AppStreamClient(config); + * const command = new DescribeImagePermissionsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeImagePermissionsCommandInput} for command's `input` shape. + * @see {@link DescribeImagePermissionsCommandOutput} for command's `response` shape. + * @see {@link AppStreamClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeImagePermissionsCommand extends $Command< DescribeImagePermissionsCommandInput, diff --git a/clients/client-appstream/commands/DescribeImagesCommand.ts b/clients/client-appstream/commands/DescribeImagesCommand.ts index c07d552638b6..557c1d566400 100644 --- a/clients/client-appstream/commands/DescribeImagesCommand.ts +++ b/clients/client-appstream/commands/DescribeImagesCommand.ts @@ -22,6 +22,20 @@ export interface DescribeImagesCommandOutput extends DescribeImagesResult, __Met /** *

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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { AppStreamClient, DescribeImagesCommand } from "@aws-sdk/client-appstream"; // ES Modules import + * // const { AppStreamClient, DescribeImagesCommand } = require("@aws-sdk/client-appstream"); // CommonJS import + * const client = new AppStreamClient(config); + * const command = new DescribeImagesCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeImagesCommandInput} for command's `input` shape. + * @see {@link DescribeImagesCommandOutput} for command's `response` shape. + * @see {@link AppStreamClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeImagesCommand extends $Command< DescribeImagesCommandInput, diff --git a/clients/client-appstream/commands/DescribeSessionsCommand.ts b/clients/client-appstream/commands/DescribeSessionsCommand.ts index d31d4324c7c1..7e4287081226 100644 --- a/clients/client-appstream/commands/DescribeSessionsCommand.ts +++ b/clients/client-appstream/commands/DescribeSessionsCommand.ts @@ -24,6 +24,20 @@ export interface DescribeSessionsCommandOutput extends DescribeSessionsResult, _ *

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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { AppStreamClient, DescribeSessionsCommand } from "@aws-sdk/client-appstream"; // ES Modules import + * // const { AppStreamClient, DescribeSessionsCommand } = require("@aws-sdk/client-appstream"); // CommonJS import + * const client = new AppStreamClient(config); + * const command = new DescribeSessionsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeSessionsCommandInput} for command's `input` shape. + * @see {@link DescribeSessionsCommandOutput} for command's `response` shape. + * @see {@link AppStreamClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeSessionsCommand extends $Command< DescribeSessionsCommandInput, diff --git a/clients/client-appstream/commands/DescribeStacksCommand.ts b/clients/client-appstream/commands/DescribeStacksCommand.ts index 96ab34f4a827..2b8e539331e4 100644 --- a/clients/client-appstream/commands/DescribeStacksCommand.ts +++ b/clients/client-appstream/commands/DescribeStacksCommand.ts @@ -22,6 +22,20 @@ export interface DescribeStacksCommandOutput extends DescribeStacksResult, __Met /** *

Retrieves a list that describes one or more specified stacks, if the stack names are provided. Otherwise, all stacks in the account are described.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { AppStreamClient, DescribeStacksCommand } from "@aws-sdk/client-appstream"; // ES Modules import + * // const { AppStreamClient, DescribeStacksCommand } = require("@aws-sdk/client-appstream"); // CommonJS import + * const client = new AppStreamClient(config); + * const command = new DescribeStacksCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeStacksCommandInput} for command's `input` shape. + * @see {@link DescribeStacksCommandOutput} for command's `response` shape. + * @see {@link AppStreamClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeStacksCommand extends $Command< DescribeStacksCommandInput, diff --git a/clients/client-appstream/commands/DescribeUsageReportSubscriptionsCommand.ts b/clients/client-appstream/commands/DescribeUsageReportSubscriptionsCommand.ts index f5e6539e48e3..5b18dcaaba0c 100644 --- a/clients/client-appstream/commands/DescribeUsageReportSubscriptionsCommand.ts +++ b/clients/client-appstream/commands/DescribeUsageReportSubscriptionsCommand.ts @@ -24,6 +24,20 @@ export interface DescribeUsageReportSubscriptionsCommandOutput /** *

Retrieves a list that describes one or more usage report subscriptions.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { AppStreamClient, DescribeUsageReportSubscriptionsCommand } from "@aws-sdk/client-appstream"; // ES Modules import + * // const { AppStreamClient, DescribeUsageReportSubscriptionsCommand } = require("@aws-sdk/client-appstream"); // CommonJS import + * const client = new AppStreamClient(config); + * const command = new DescribeUsageReportSubscriptionsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeUsageReportSubscriptionsCommandInput} for command's `input` shape. + * @see {@link DescribeUsageReportSubscriptionsCommandOutput} for command's `response` shape. + * @see {@link AppStreamClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeUsageReportSubscriptionsCommand extends $Command< DescribeUsageReportSubscriptionsCommandInput, diff --git a/clients/client-appstream/commands/DescribeUserStackAssociationsCommand.ts b/clients/client-appstream/commands/DescribeUserStackAssociationsCommand.ts index db83c36597b5..f2b08b98652b 100644 --- a/clients/client-appstream/commands/DescribeUserStackAssociationsCommand.ts +++ b/clients/client-appstream/commands/DescribeUserStackAssociationsCommand.ts @@ -32,6 +32,20 @@ export interface DescribeUserStackAssociationsCommandOutput *

The user name (email address of the user associated with the stack) and the authentication type for the user

* * + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { AppStreamClient, DescribeUserStackAssociationsCommand } from "@aws-sdk/client-appstream"; // ES Modules import + * // const { AppStreamClient, DescribeUserStackAssociationsCommand } = require("@aws-sdk/client-appstream"); // CommonJS import + * const client = new AppStreamClient(config); + * const command = new DescribeUserStackAssociationsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeUserStackAssociationsCommandInput} for command's `input` shape. + * @see {@link DescribeUserStackAssociationsCommandOutput} for command's `response` shape. + * @see {@link AppStreamClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeUserStackAssociationsCommand extends $Command< DescribeUserStackAssociationsCommandInput, diff --git a/clients/client-appstream/commands/DescribeUsersCommand.ts b/clients/client-appstream/commands/DescribeUsersCommand.ts index 69fe7ba5d75f..22324cbca949 100644 --- a/clients/client-appstream/commands/DescribeUsersCommand.ts +++ b/clients/client-appstream/commands/DescribeUsersCommand.ts @@ -22,6 +22,20 @@ export interface DescribeUsersCommandOutput extends DescribeUsersResult, __Metad /** *

Retrieves a list that describes one or more specified users in the user pool.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { AppStreamClient, DescribeUsersCommand } from "@aws-sdk/client-appstream"; // ES Modules import + * // const { AppStreamClient, DescribeUsersCommand } = require("@aws-sdk/client-appstream"); // CommonJS import + * const client = new AppStreamClient(config); + * const command = new DescribeUsersCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeUsersCommandInput} for command's `input` shape. + * @see {@link DescribeUsersCommandOutput} for command's `response` shape. + * @see {@link AppStreamClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeUsersCommand extends $Command< DescribeUsersCommandInput, diff --git a/clients/client-appstream/commands/DisableUserCommand.ts b/clients/client-appstream/commands/DisableUserCommand.ts index 60d4397f1f21..9100baae8669 100644 --- a/clients/client-appstream/commands/DisableUserCommand.ts +++ b/clients/client-appstream/commands/DisableUserCommand.ts @@ -22,6 +22,20 @@ export interface DisableUserCommandOutput extends DisableUserResult, __MetadataB /** *

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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { AppStreamClient, DisableUserCommand } from "@aws-sdk/client-appstream"; // ES Modules import + * // const { AppStreamClient, DisableUserCommand } = require("@aws-sdk/client-appstream"); // CommonJS import + * const client = new AppStreamClient(config); + * const command = new DisableUserCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DisableUserCommandInput} for command's `input` shape. + * @see {@link DisableUserCommandOutput} for command's `response` shape. + * @see {@link AppStreamClientResolvedConfig | config} for command's `input` shape. + * */ export class DisableUserCommand extends $Command< DisableUserCommandInput, diff --git a/clients/client-appstream/commands/DisassociateFleetCommand.ts b/clients/client-appstream/commands/DisassociateFleetCommand.ts index 9f9ef67517d7..7018a6cd5331 100644 --- a/clients/client-appstream/commands/DisassociateFleetCommand.ts +++ b/clients/client-appstream/commands/DisassociateFleetCommand.ts @@ -22,6 +22,20 @@ export interface DisassociateFleetCommandOutput extends DisassociateFleetResult, /** *

Disassociates the specified fleet from the specified stack.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { AppStreamClient, DisassociateFleetCommand } from "@aws-sdk/client-appstream"; // ES Modules import + * // const { AppStreamClient, DisassociateFleetCommand } = require("@aws-sdk/client-appstream"); // CommonJS import + * const client = new AppStreamClient(config); + * const command = new DisassociateFleetCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DisassociateFleetCommandInput} for command's `input` shape. + * @see {@link DisassociateFleetCommandOutput} for command's `response` shape. + * @see {@link AppStreamClientResolvedConfig | config} for command's `input` shape. + * */ export class DisassociateFleetCommand extends $Command< DisassociateFleetCommandInput, diff --git a/clients/client-appstream/commands/EnableUserCommand.ts b/clients/client-appstream/commands/EnableUserCommand.ts index ef7447f230a0..5c71379097ef 100644 --- a/clients/client-appstream/commands/EnableUserCommand.ts +++ b/clients/client-appstream/commands/EnableUserCommand.ts @@ -22,6 +22,20 @@ export interface EnableUserCommandOutput extends EnableUserResult, __MetadataBea /** *

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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { AppStreamClient, EnableUserCommand } from "@aws-sdk/client-appstream"; // ES Modules import + * // const { AppStreamClient, EnableUserCommand } = require("@aws-sdk/client-appstream"); // CommonJS import + * const client = new AppStreamClient(config); + * const command = new EnableUserCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link EnableUserCommandInput} for command's `input` shape. + * @see {@link EnableUserCommandOutput} for command's `response` shape. + * @see {@link AppStreamClientResolvedConfig | config} for command's `input` shape. + * */ export class EnableUserCommand extends $Command< EnableUserCommandInput, diff --git a/clients/client-appstream/commands/ExpireSessionCommand.ts b/clients/client-appstream/commands/ExpireSessionCommand.ts index cb72d5e77c9a..19c79244882a 100644 --- a/clients/client-appstream/commands/ExpireSessionCommand.ts +++ b/clients/client-appstream/commands/ExpireSessionCommand.ts @@ -22,6 +22,20 @@ export interface ExpireSessionCommandOutput extends ExpireSessionResult, __Metad /** *

Immediately stops the specified streaming session.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { AppStreamClient, ExpireSessionCommand } from "@aws-sdk/client-appstream"; // ES Modules import + * // const { AppStreamClient, ExpireSessionCommand } = require("@aws-sdk/client-appstream"); // CommonJS import + * const client = new AppStreamClient(config); + * const command = new ExpireSessionCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ExpireSessionCommandInput} for command's `input` shape. + * @see {@link ExpireSessionCommandOutput} for command's `response` shape. + * @see {@link AppStreamClientResolvedConfig | config} for command's `input` shape. + * */ export class ExpireSessionCommand extends $Command< ExpireSessionCommandInput, diff --git a/clients/client-appstream/commands/ListAssociatedFleetsCommand.ts b/clients/client-appstream/commands/ListAssociatedFleetsCommand.ts index f5deb7ce2c13..6549f7bb42ee 100644 --- a/clients/client-appstream/commands/ListAssociatedFleetsCommand.ts +++ b/clients/client-appstream/commands/ListAssociatedFleetsCommand.ts @@ -22,6 +22,20 @@ export interface ListAssociatedFleetsCommandOutput extends ListAssociatedFleetsR /** *

Retrieves the name of the fleet that is associated with the specified stack.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { AppStreamClient, ListAssociatedFleetsCommand } from "@aws-sdk/client-appstream"; // ES Modules import + * // const { AppStreamClient, ListAssociatedFleetsCommand } = require("@aws-sdk/client-appstream"); // CommonJS import + * const client = new AppStreamClient(config); + * const command = new ListAssociatedFleetsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListAssociatedFleetsCommandInput} for command's `input` shape. + * @see {@link ListAssociatedFleetsCommandOutput} for command's `response` shape. + * @see {@link AppStreamClientResolvedConfig | config} for command's `input` shape. + * */ export class ListAssociatedFleetsCommand extends $Command< ListAssociatedFleetsCommandInput, diff --git a/clients/client-appstream/commands/ListAssociatedStacksCommand.ts b/clients/client-appstream/commands/ListAssociatedStacksCommand.ts index 00867c6b5e22..8a1507facd7f 100644 --- a/clients/client-appstream/commands/ListAssociatedStacksCommand.ts +++ b/clients/client-appstream/commands/ListAssociatedStacksCommand.ts @@ -22,6 +22,20 @@ export interface ListAssociatedStacksCommandOutput extends ListAssociatedStacksR /** *

Retrieves the name of the stack with which the specified fleet is associated.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { AppStreamClient, ListAssociatedStacksCommand } from "@aws-sdk/client-appstream"; // ES Modules import + * // const { AppStreamClient, ListAssociatedStacksCommand } = require("@aws-sdk/client-appstream"); // CommonJS import + * const client = new AppStreamClient(config); + * const command = new ListAssociatedStacksCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListAssociatedStacksCommandInput} for command's `input` shape. + * @see {@link ListAssociatedStacksCommandOutput} for command's `response` shape. + * @see {@link AppStreamClientResolvedConfig | config} for command's `input` shape. + * */ export class ListAssociatedStacksCommand extends $Command< ListAssociatedStacksCommandInput, diff --git a/clients/client-appstream/commands/ListTagsForResourceCommand.ts b/clients/client-appstream/commands/ListTagsForResourceCommand.ts index 2c6816c8fe2d..75931a80339a 100644 --- a/clients/client-appstream/commands/ListTagsForResourceCommand.ts +++ b/clients/client-appstream/commands/ListTagsForResourceCommand.ts @@ -23,6 +23,20 @@ export interface ListTagsForResourceCommandOutput extends ListTagsForResourceRes /** *

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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { AppStreamClient, ListTagsForResourceCommand } from "@aws-sdk/client-appstream"; // ES Modules import + * // const { AppStreamClient, ListTagsForResourceCommand } = require("@aws-sdk/client-appstream"); // CommonJS import + * const client = new AppStreamClient(config); + * const command = new ListTagsForResourceCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListTagsForResourceCommandInput} for command's `input` shape. + * @see {@link ListTagsForResourceCommandOutput} for command's `response` shape. + * @see {@link AppStreamClientResolvedConfig | config} for command's `input` shape. + * */ export class ListTagsForResourceCommand extends $Command< ListTagsForResourceCommandInput, diff --git a/clients/client-appstream/commands/StartFleetCommand.ts b/clients/client-appstream/commands/StartFleetCommand.ts index 6236739f5fc7..01ab6f950e13 100644 --- a/clients/client-appstream/commands/StartFleetCommand.ts +++ b/clients/client-appstream/commands/StartFleetCommand.ts @@ -22,6 +22,20 @@ export interface StartFleetCommandOutput extends StartFleetResult, __MetadataBea /** *

Starts the specified fleet.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { AppStreamClient, StartFleetCommand } from "@aws-sdk/client-appstream"; // ES Modules import + * // const { AppStreamClient, StartFleetCommand } = require("@aws-sdk/client-appstream"); // CommonJS import + * const client = new AppStreamClient(config); + * const command = new StartFleetCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link StartFleetCommandInput} for command's `input` shape. + * @see {@link StartFleetCommandOutput} for command's `response` shape. + * @see {@link AppStreamClientResolvedConfig | config} for command's `input` shape. + * */ export class StartFleetCommand extends $Command< StartFleetCommandInput, diff --git a/clients/client-appstream/commands/StartImageBuilderCommand.ts b/clients/client-appstream/commands/StartImageBuilderCommand.ts index ae15d6b9fe8c..a32df8a913ff 100644 --- a/clients/client-appstream/commands/StartImageBuilderCommand.ts +++ b/clients/client-appstream/commands/StartImageBuilderCommand.ts @@ -22,6 +22,20 @@ export interface StartImageBuilderCommandOutput extends StartImageBuilderResult, /** *

Starts the specified image builder.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { AppStreamClient, StartImageBuilderCommand } from "@aws-sdk/client-appstream"; // ES Modules import + * // const { AppStreamClient, StartImageBuilderCommand } = require("@aws-sdk/client-appstream"); // CommonJS import + * const client = new AppStreamClient(config); + * const command = new StartImageBuilderCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link StartImageBuilderCommandInput} for command's `input` shape. + * @see {@link StartImageBuilderCommandOutput} for command's `response` shape. + * @see {@link AppStreamClientResolvedConfig | config} for command's `input` shape. + * */ export class StartImageBuilderCommand extends $Command< StartImageBuilderCommandInput, diff --git a/clients/client-appstream/commands/StopFleetCommand.ts b/clients/client-appstream/commands/StopFleetCommand.ts index 47b4572ea037..7827646df03e 100644 --- a/clients/client-appstream/commands/StopFleetCommand.ts +++ b/clients/client-appstream/commands/StopFleetCommand.ts @@ -19,6 +19,20 @@ export interface StopFleetCommandOutput extends StopFleetResult, __MetadataBeare /** *

Stops the specified fleet.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { AppStreamClient, StopFleetCommand } from "@aws-sdk/client-appstream"; // ES Modules import + * // const { AppStreamClient, StopFleetCommand } = require("@aws-sdk/client-appstream"); // CommonJS import + * const client = new AppStreamClient(config); + * const command = new StopFleetCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link StopFleetCommandInput} for command's `input` shape. + * @see {@link StopFleetCommandOutput} for command's `response` shape. + * @see {@link AppStreamClientResolvedConfig | config} for command's `input` shape. + * */ export class StopFleetCommand extends $Command< StopFleetCommandInput, diff --git a/clients/client-appstream/commands/StopImageBuilderCommand.ts b/clients/client-appstream/commands/StopImageBuilderCommand.ts index 8f5176f3adf0..a2d59c8773dc 100644 --- a/clients/client-appstream/commands/StopImageBuilderCommand.ts +++ b/clients/client-appstream/commands/StopImageBuilderCommand.ts @@ -22,6 +22,20 @@ export interface StopImageBuilderCommandOutput extends StopImageBuilderResult, _ /** *

Stops the specified image builder.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { AppStreamClient, StopImageBuilderCommand } from "@aws-sdk/client-appstream"; // ES Modules import + * // const { AppStreamClient, StopImageBuilderCommand } = require("@aws-sdk/client-appstream"); // CommonJS import + * const client = new AppStreamClient(config); + * const command = new StopImageBuilderCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link StopImageBuilderCommandInput} for command's `input` shape. + * @see {@link StopImageBuilderCommandOutput} for command's `response` shape. + * @see {@link AppStreamClientResolvedConfig | config} for command's `input` shape. + * */ export class StopImageBuilderCommand extends $Command< StopImageBuilderCommandInput, diff --git a/clients/client-appstream/commands/TagResourceCommand.ts b/clients/client-appstream/commands/TagResourceCommand.ts index c7bd6b003565..49815b84a64c 100644 --- a/clients/client-appstream/commands/TagResourceCommand.ts +++ b/clients/client-appstream/commands/TagResourceCommand.ts @@ -28,6 +28,20 @@ export interface TagResourceCommandOutput extends TagResourceResponse, __Metadat *

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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { AppStreamClient, TagResourceCommand } from "@aws-sdk/client-appstream"; // ES Modules import + * // const { AppStreamClient, TagResourceCommand } = require("@aws-sdk/client-appstream"); // CommonJS import + * const client = new AppStreamClient(config); + * const command = new TagResourceCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link TagResourceCommandInput} for command's `input` shape. + * @see {@link TagResourceCommandOutput} for command's `response` shape. + * @see {@link AppStreamClientResolvedConfig | config} for command's `input` shape. + * */ export class TagResourceCommand extends $Command< TagResourceCommandInput, diff --git a/clients/client-appstream/commands/UntagResourceCommand.ts b/clients/client-appstream/commands/UntagResourceCommand.ts index 5e5a19007a87..f3a8260923d3 100644 --- a/clients/client-appstream/commands/UntagResourceCommand.ts +++ b/clients/client-appstream/commands/UntagResourceCommand.ts @@ -24,6 +24,20 @@ export interface UntagResourceCommandOutput extends UntagResourceResponse, __Met *

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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { AppStreamClient, UntagResourceCommand } from "@aws-sdk/client-appstream"; // ES Modules import + * // const { AppStreamClient, UntagResourceCommand } = require("@aws-sdk/client-appstream"); // CommonJS import + * const client = new AppStreamClient(config); + * const command = new UntagResourceCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link UntagResourceCommandInput} for command's `input` shape. + * @see {@link UntagResourceCommandOutput} for command's `response` shape. + * @see {@link AppStreamClientResolvedConfig | config} for command's `input` shape. + * */ export class UntagResourceCommand extends $Command< UntagResourceCommandInput, diff --git a/clients/client-appstream/commands/UpdateDirectoryConfigCommand.ts b/clients/client-appstream/commands/UpdateDirectoryConfigCommand.ts index 3c85c85f4e8a..ec1a4d5d21f7 100644 --- a/clients/client-appstream/commands/UpdateDirectoryConfigCommand.ts +++ b/clients/client-appstream/commands/UpdateDirectoryConfigCommand.ts @@ -22,6 +22,20 @@ export interface UpdateDirectoryConfigCommandOutput extends UpdateDirectoryConfi /** *

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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { AppStreamClient, UpdateDirectoryConfigCommand } from "@aws-sdk/client-appstream"; // ES Modules import + * // const { AppStreamClient, UpdateDirectoryConfigCommand } = require("@aws-sdk/client-appstream"); // CommonJS import + * const client = new AppStreamClient(config); + * const command = new UpdateDirectoryConfigCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link UpdateDirectoryConfigCommandInput} for command's `input` shape. + * @see {@link UpdateDirectoryConfigCommandOutput} for command's `response` shape. + * @see {@link AppStreamClientResolvedConfig | config} for command's `input` shape. + * */ export class UpdateDirectoryConfigCommand extends $Command< UpdateDirectoryConfigCommandInput, diff --git a/clients/client-appstream/commands/UpdateFleetCommand.ts b/clients/client-appstream/commands/UpdateFleetCommand.ts index 38920280030a..c6b35e179898 100644 --- a/clients/client-appstream/commands/UpdateFleetCommand.ts +++ b/clients/client-appstream/commands/UpdateFleetCommand.ts @@ -25,6 +25,20 @@ export interface UpdateFleetCommandOutput extends UpdateFleetResult, __MetadataB *

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 DisplayName, ComputeCapacity, ImageARN, ImageName, IdleDisconnectTimeoutInSeconds, and DisconnectTimeoutInSeconds attributes. * If the fleet is in the STARTING or STOPPING state, you can't update it.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { AppStreamClient, UpdateFleetCommand } from "@aws-sdk/client-appstream"; // ES Modules import + * // const { AppStreamClient, UpdateFleetCommand } = require("@aws-sdk/client-appstream"); // CommonJS import + * const client = new AppStreamClient(config); + * const command = new UpdateFleetCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link UpdateFleetCommandInput} for command's `input` shape. + * @see {@link UpdateFleetCommandOutput} for command's `response` shape. + * @see {@link AppStreamClientResolvedConfig | config} for command's `input` shape. + * */ export class UpdateFleetCommand extends $Command< UpdateFleetCommandInput, diff --git a/clients/client-appstream/commands/UpdateImagePermissionsCommand.ts b/clients/client-appstream/commands/UpdateImagePermissionsCommand.ts index 71f4bb8375bc..e42f1db93d83 100644 --- a/clients/client-appstream/commands/UpdateImagePermissionsCommand.ts +++ b/clients/client-appstream/commands/UpdateImagePermissionsCommand.ts @@ -22,6 +22,20 @@ export interface UpdateImagePermissionsCommandOutput extends UpdateImagePermissi /** *

Adds or updates permissions for the specified private image.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { AppStreamClient, UpdateImagePermissionsCommand } from "@aws-sdk/client-appstream"; // ES Modules import + * // const { AppStreamClient, UpdateImagePermissionsCommand } = require("@aws-sdk/client-appstream"); // CommonJS import + * const client = new AppStreamClient(config); + * const command = new UpdateImagePermissionsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link UpdateImagePermissionsCommandInput} for command's `input` shape. + * @see {@link UpdateImagePermissionsCommandOutput} for command's `response` shape. + * @see {@link AppStreamClientResolvedConfig | config} for command's `input` shape. + * */ export class UpdateImagePermissionsCommand extends $Command< UpdateImagePermissionsCommandInput, diff --git a/clients/client-appstream/commands/UpdateStackCommand.ts b/clients/client-appstream/commands/UpdateStackCommand.ts index b377c72ab9dd..958a7370691d 100644 --- a/clients/client-appstream/commands/UpdateStackCommand.ts +++ b/clients/client-appstream/commands/UpdateStackCommand.ts @@ -22,6 +22,20 @@ export interface UpdateStackCommandOutput extends UpdateStackResult, __MetadataB /** *

Updates the specified fields for the specified stack.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { AppStreamClient, UpdateStackCommand } from "@aws-sdk/client-appstream"; // ES Modules import + * // const { AppStreamClient, UpdateStackCommand } = require("@aws-sdk/client-appstream"); // CommonJS import + * const client = new AppStreamClient(config); + * const command = new UpdateStackCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link UpdateStackCommandInput} for command's `input` shape. + * @see {@link UpdateStackCommandOutput} for command's `response` shape. + * @see {@link AppStreamClientResolvedConfig | config} for command's `input` shape. + * */ export class UpdateStackCommand extends $Command< UpdateStackCommandInput, diff --git a/clients/client-appstream/models/models_0.ts b/clients/client-appstream/models/models_0.ts index 03de3d7e61a1..1902e6d8cf27 100644 --- a/clients/client-appstream/models/models_0.ts +++ b/clients/client-appstream/models/models_0.ts @@ -21,6 +21,9 @@ export interface AccessEndpoint { } export namespace AccessEndpoint { + /** + * @internal + */ export const filterSensitiveLog = (obj: AccessEndpoint): any => ({ ...obj, }); @@ -77,6 +80,9 @@ export interface Application { } export namespace Application { + /** + * @internal + */ export const filterSensitiveLog = (obj: Application): any => ({ ...obj, }); @@ -98,6 +104,9 @@ export interface ApplicationSettings { } export namespace ApplicationSettings { + /** + * @internal + */ export const filterSensitiveLog = (obj: ApplicationSettings): any => ({ ...obj, }); @@ -125,6 +134,9 @@ export interface ApplicationSettingsResponse { } export namespace ApplicationSettingsResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ApplicationSettingsResponse): any => ({ ...obj, }); @@ -143,6 +155,9 @@ export interface AssociateFleetRequest { } export namespace AssociateFleetRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: AssociateFleetRequest): any => ({ ...obj, }); @@ -151,6 +166,9 @@ export namespace AssociateFleetRequest { export interface AssociateFleetResult {} export namespace AssociateFleetResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: AssociateFleetResult): any => ({ ...obj, }); @@ -169,6 +187,9 @@ export interface ConcurrentModificationException extends __SmithyException, $Met } export namespace ConcurrentModificationException { + /** + * @internal + */ export const filterSensitiveLog = (obj: ConcurrentModificationException): any => ({ ...obj, }); @@ -187,6 +208,9 @@ export interface IncompatibleImageException extends __SmithyException, $Metadata } export namespace IncompatibleImageException { + /** + * @internal + */ export const filterSensitiveLog = (obj: IncompatibleImageException): any => ({ ...obj, }); @@ -205,6 +229,9 @@ export interface InvalidAccountStatusException extends __SmithyException, $Metad } export namespace InvalidAccountStatusException { + /** + * @internal + */ export const filterSensitiveLog = (obj: InvalidAccountStatusException): any => ({ ...obj, }); @@ -223,6 +250,9 @@ export interface LimitExceededException extends __SmithyException, $MetadataBear } export namespace LimitExceededException { + /** + * @internal + */ export const filterSensitiveLog = (obj: LimitExceededException): any => ({ ...obj, }); @@ -241,6 +271,9 @@ export interface OperationNotPermittedException extends __SmithyException, $Meta } export namespace OperationNotPermittedException { + /** + * @internal + */ export const filterSensitiveLog = (obj: OperationNotPermittedException): any => ({ ...obj, }); @@ -259,6 +292,9 @@ export interface ResourceNotFoundException extends __SmithyException, $MetadataB } export namespace ResourceNotFoundException { + /** + * @internal + */ export const filterSensitiveLog = (obj: ResourceNotFoundException): any => ({ ...obj, }); @@ -300,6 +336,9 @@ export interface UserStackAssociation { } export namespace UserStackAssociation { + /** + * @internal + */ export const filterSensitiveLog = (obj: UserStackAssociation): any => ({ ...obj, ...(obj.UserName && { UserName: SENSITIVE_STRING }), @@ -314,6 +353,9 @@ export interface BatchAssociateUserStackRequest { } export namespace BatchAssociateUserStackRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: BatchAssociateUserStackRequest): any => ({ ...obj, ...(obj.UserStackAssociations && { @@ -350,6 +392,9 @@ export interface UserStackAssociationError { } export namespace UserStackAssociationError { + /** + * @internal + */ export const filterSensitiveLog = (obj: UserStackAssociationError): any => ({ ...obj, ...(obj.UserStackAssociation && { @@ -366,6 +411,9 @@ export interface BatchAssociateUserStackResult { } export namespace BatchAssociateUserStackResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: BatchAssociateUserStackResult): any => ({ ...obj, ...(obj.errors && { errors: obj.errors.map((item) => UserStackAssociationError.filterSensitiveLog(item)) }), @@ -385,6 +433,9 @@ export interface InvalidParameterCombinationException extends __SmithyException, } export namespace InvalidParameterCombinationException { + /** + * @internal + */ export const filterSensitiveLog = (obj: InvalidParameterCombinationException): any => ({ ...obj, }); @@ -398,6 +449,9 @@ export interface BatchDisassociateUserStackRequest { } export namespace BatchDisassociateUserStackRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: BatchDisassociateUserStackRequest): any => ({ ...obj, ...(obj.UserStackAssociations && { @@ -414,6 +468,9 @@ export interface BatchDisassociateUserStackResult { } export namespace BatchDisassociateUserStackResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: BatchDisassociateUserStackResult): any => ({ ...obj, ...(obj.errors && { errors: obj.errors.map((item) => UserStackAssociationError.filterSensitiveLog(item)) }), @@ -431,6 +488,9 @@ export interface ComputeCapacity { } export namespace ComputeCapacity { + /** + * @internal + */ export const filterSensitiveLog = (obj: ComputeCapacity): any => ({ ...obj, }); @@ -463,6 +523,9 @@ export interface ComputeCapacityStatus { } export namespace ComputeCapacityStatus { + /** + * @internal + */ export const filterSensitiveLog = (obj: ComputeCapacityStatus): any => ({ ...obj, }); @@ -491,6 +554,9 @@ export interface CopyImageRequest { } export namespace CopyImageRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: CopyImageRequest): any => ({ ...obj, }); @@ -504,6 +570,9 @@ export interface CopyImageResponse { } export namespace CopyImageResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: CopyImageResponse): any => ({ ...obj, }); @@ -522,6 +591,9 @@ export interface ResourceAlreadyExistsException extends __SmithyException, $Meta } export namespace ResourceAlreadyExistsException { + /** + * @internal + */ export const filterSensitiveLog = (obj: ResourceAlreadyExistsException): any => ({ ...obj, }); @@ -540,6 +612,9 @@ export interface ResourceNotAvailableException extends __SmithyException, $Metad } export namespace ResourceNotAvailableException { + /** + * @internal + */ export const filterSensitiveLog = (obj: ResourceNotAvailableException): any => ({ ...obj, }); @@ -563,6 +638,9 @@ export interface ServiceAccountCredentials { } export namespace ServiceAccountCredentials { + /** + * @internal + */ export const filterSensitiveLog = (obj: ServiceAccountCredentials): any => ({ ...obj, ...(obj.AccountName && { AccountName: SENSITIVE_STRING }), @@ -588,6 +666,9 @@ export interface CreateDirectoryConfigRequest { } export namespace CreateDirectoryConfigRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateDirectoryConfigRequest): any => ({ ...obj, ...(obj.ServiceAccountCredentials && { @@ -622,6 +703,9 @@ export interface DirectoryConfig { } export namespace DirectoryConfig { + /** + * @internal + */ export const filterSensitiveLog = (obj: DirectoryConfig): any => ({ ...obj, ...(obj.ServiceAccountCredentials && { @@ -638,6 +722,9 @@ export interface CreateDirectoryConfigResult { } export namespace CreateDirectoryConfigResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateDirectoryConfigResult): any => ({ ...obj, ...(obj.DirectoryConfig && { DirectoryConfig: DirectoryConfig.filterSensitiveLog(obj.DirectoryConfig) }), @@ -657,6 +744,9 @@ export interface InvalidRoleException extends __SmithyException, $MetadataBearer } export namespace InvalidRoleException { + /** + * @internal + */ export const filterSensitiveLog = (obj: InvalidRoleException): any => ({ ...obj, }); @@ -678,6 +768,9 @@ export interface DomainJoinInfo { } export namespace DomainJoinInfo { + /** + * @internal + */ export const filterSensitiveLog = (obj: DomainJoinInfo): any => ({ ...obj, }); @@ -709,6 +802,9 @@ export interface VpcConfig { } export namespace VpcConfig { + /** + * @internal + */ export const filterSensitiveLog = (obj: VpcConfig): any => ({ ...obj, }); @@ -942,6 +1038,9 @@ export interface CreateFleetRequest { } export namespace CreateFleetRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateFleetRequest): any => ({ ...obj, }); @@ -996,6 +1095,9 @@ export interface FleetError { } export namespace FleetError { + /** + * @internal + */ export const filterSensitiveLog = (obj: FleetError): any => ({ ...obj, }); @@ -1248,6 +1350,9 @@ export interface Fleet { } export namespace Fleet { + /** + * @internal + */ export const filterSensitiveLog = (obj: Fleet): any => ({ ...obj, }); @@ -1261,6 +1366,9 @@ export interface CreateFleetResult { } export namespace CreateFleetResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateFleetResult): any => ({ ...obj, }); @@ -1279,6 +1387,9 @@ export interface RequestLimitExceededException extends __SmithyException, $Metad } export namespace RequestLimitExceededException { + /** + * @internal + */ export const filterSensitiveLog = (obj: RequestLimitExceededException): any => ({ ...obj, }); @@ -1462,6 +1573,9 @@ export interface CreateImageBuilderRequest { } export namespace CreateImageBuilderRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateImageBuilderRequest): any => ({ ...obj, }); @@ -1488,6 +1602,9 @@ export interface ResourceError { } export namespace ResourceError { + /** + * @internal + */ export const filterSensitiveLog = (obj: ResourceError): any => ({ ...obj, }); @@ -1509,6 +1626,9 @@ export interface NetworkAccessConfiguration { } export namespace NetworkAccessConfiguration { + /** + * @internal + */ export const filterSensitiveLog = (obj: NetworkAccessConfiguration): any => ({ ...obj, }); @@ -1551,6 +1671,9 @@ export interface ImageBuilderStateChangeReason { } export namespace ImageBuilderStateChangeReason { + /** + * @internal + */ export const filterSensitiveLog = (obj: ImageBuilderStateChangeReason): any => ({ ...obj, }); @@ -1755,6 +1878,9 @@ export interface ImageBuilder { } export namespace ImageBuilder { + /** + * @internal + */ export const filterSensitiveLog = (obj: ImageBuilder): any => ({ ...obj, }); @@ -1768,6 +1894,9 @@ export interface CreateImageBuilderResult { } export namespace CreateImageBuilderResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateImageBuilderResult): any => ({ ...obj, }); @@ -1787,6 +1916,9 @@ export interface CreateImageBuilderStreamingURLRequest { } export namespace CreateImageBuilderStreamingURLRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateImageBuilderStreamingURLRequest): any => ({ ...obj, }); @@ -1805,6 +1937,9 @@ export interface CreateImageBuilderStreamingURLResult { } export namespace CreateImageBuilderStreamingURLResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateImageBuilderStreamingURLResult): any => ({ ...obj, }); @@ -1837,6 +1972,9 @@ export interface StorageConnector { } export namespace StorageConnector { + /** + * @internal + */ export const filterSensitiveLog = (obj: StorageConnector): any => ({ ...obj, }); @@ -1863,6 +2001,9 @@ export interface UserSetting { } export namespace UserSetting { + /** + * @internal + */ export const filterSensitiveLog = (obj: UserSetting): any => ({ ...obj, }); @@ -1933,6 +2074,9 @@ export interface CreateStackRequest { } export namespace CreateStackRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateStackRequest): any => ({ ...obj, }); @@ -1959,6 +2103,9 @@ export interface StackError { } export namespace StackError { + /** + * @internal + */ export const filterSensitiveLog = (obj: StackError): any => ({ ...obj, }); @@ -2035,6 +2182,9 @@ export interface Stack { } export namespace Stack { + /** + * @internal + */ export const filterSensitiveLog = (obj: Stack): any => ({ ...obj, }); @@ -2048,6 +2198,9 @@ export interface CreateStackResult { } export namespace CreateStackResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateStackResult): any => ({ ...obj, }); @@ -2088,6 +2241,9 @@ export interface CreateStreamingURLRequest { } export namespace CreateStreamingURLRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateStreamingURLRequest): any => ({ ...obj, }); @@ -2106,6 +2262,9 @@ export interface CreateStreamingURLResult { } export namespace CreateStreamingURLResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateStreamingURLResult): any => ({ ...obj, }); @@ -2148,6 +2307,9 @@ export interface CreateUpdatedImageRequest { } export namespace CreateUpdatedImageRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateUpdatedImageRequest): any => ({ ...obj, }); @@ -2169,6 +2331,9 @@ export interface ImagePermissions { } export namespace ImagePermissions { + /** + * @internal + */ export const filterSensitiveLog = (obj: ImagePermissions): any => ({ ...obj, }); @@ -2206,6 +2371,9 @@ export interface ImageStateChangeReason { } export namespace ImageStateChangeReason { + /** + * @internal + */ export const filterSensitiveLog = (obj: ImageStateChangeReason): any => ({ ...obj, }); @@ -2310,6 +2478,9 @@ export interface Image { } export namespace Image { + /** + * @internal + */ export const filterSensitiveLog = (obj: Image): any => ({ ...obj, }); @@ -2328,6 +2499,9 @@ export interface CreateUpdatedImageResult { } export namespace CreateUpdatedImageResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateUpdatedImageResult): any => ({ ...obj, }); @@ -2336,6 +2510,9 @@ export namespace CreateUpdatedImageResult { export interface CreateUsageReportSubscriptionRequest {} export namespace CreateUsageReportSubscriptionRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateUsageReportSubscriptionRequest): any => ({ ...obj, }); @@ -2364,6 +2541,9 @@ export interface CreateUsageReportSubscriptionResult { } export namespace CreateUsageReportSubscriptionResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateUsageReportSubscriptionResult): any => ({ ...obj, }); @@ -2410,6 +2590,9 @@ export interface CreateUserRequest { } export namespace CreateUserRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateUserRequest): any => ({ ...obj, ...(obj.UserName && { UserName: SENSITIVE_STRING }), @@ -2421,6 +2604,9 @@ export namespace CreateUserRequest { export interface CreateUserResult {} export namespace CreateUserResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateUserResult): any => ({ ...obj, }); @@ -2434,6 +2620,9 @@ export interface DeleteDirectoryConfigRequest { } export namespace DeleteDirectoryConfigRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteDirectoryConfigRequest): any => ({ ...obj, }); @@ -2442,6 +2631,9 @@ export namespace DeleteDirectoryConfigRequest { export interface DeleteDirectoryConfigResult {} export namespace DeleteDirectoryConfigResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteDirectoryConfigResult): any => ({ ...obj, }); @@ -2460,6 +2652,9 @@ export interface ResourceInUseException extends __SmithyException, $MetadataBear } export namespace ResourceInUseException { + /** + * @internal + */ export const filterSensitiveLog = (obj: ResourceInUseException): any => ({ ...obj, }); @@ -2473,6 +2668,9 @@ export interface DeleteFleetRequest { } export namespace DeleteFleetRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteFleetRequest): any => ({ ...obj, }); @@ -2481,6 +2679,9 @@ export namespace DeleteFleetRequest { export interface DeleteFleetResult {} export namespace DeleteFleetResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteFleetResult): any => ({ ...obj, }); @@ -2494,6 +2695,9 @@ export interface DeleteImageRequest { } export namespace DeleteImageRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteImageRequest): any => ({ ...obj, }); @@ -2507,6 +2711,9 @@ export interface DeleteImageResult { } export namespace DeleteImageResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteImageResult): any => ({ ...obj, }); @@ -2520,6 +2727,9 @@ export interface DeleteImageBuilderRequest { } export namespace DeleteImageBuilderRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteImageBuilderRequest): any => ({ ...obj, }); @@ -2533,6 +2743,9 @@ export interface DeleteImageBuilderResult { } export namespace DeleteImageBuilderResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteImageBuilderResult): any => ({ ...obj, }); @@ -2551,6 +2764,9 @@ export interface DeleteImagePermissionsRequest { } export namespace DeleteImagePermissionsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteImagePermissionsRequest): any => ({ ...obj, }); @@ -2559,6 +2775,9 @@ export namespace DeleteImagePermissionsRequest { export interface DeleteImagePermissionsResult {} export namespace DeleteImagePermissionsResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteImagePermissionsResult): any => ({ ...obj, }); @@ -2572,6 +2791,9 @@ export interface DeleteStackRequest { } export namespace DeleteStackRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteStackRequest): any => ({ ...obj, }); @@ -2580,6 +2802,9 @@ export namespace DeleteStackRequest { export interface DeleteStackResult {} export namespace DeleteStackResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteStackResult): any => ({ ...obj, }); @@ -2588,6 +2813,9 @@ export namespace DeleteStackResult { export interface DeleteUsageReportSubscriptionRequest {} export namespace DeleteUsageReportSubscriptionRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteUsageReportSubscriptionRequest): any => ({ ...obj, }); @@ -2596,6 +2824,9 @@ export namespace DeleteUsageReportSubscriptionRequest { export interface DeleteUsageReportSubscriptionResult {} export namespace DeleteUsageReportSubscriptionResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteUsageReportSubscriptionResult): any => ({ ...obj, }); @@ -2618,6 +2849,9 @@ export interface DeleteUserRequest { } export namespace DeleteUserRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteUserRequest): any => ({ ...obj, ...(obj.UserName && { UserName: SENSITIVE_STRING }), @@ -2627,6 +2861,9 @@ export namespace DeleteUserRequest { export interface DeleteUserResult {} export namespace DeleteUserResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteUserResult): any => ({ ...obj, }); @@ -2650,6 +2887,9 @@ export interface DescribeDirectoryConfigsRequest { } export namespace DescribeDirectoryConfigsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeDirectoryConfigsRequest): any => ({ ...obj, }); @@ -2668,6 +2908,9 @@ export interface DescribeDirectoryConfigsResult { } export namespace DescribeDirectoryConfigsResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeDirectoryConfigsResult): any => ({ ...obj, ...(obj.DirectoryConfigs && { @@ -2689,6 +2932,9 @@ export interface DescribeFleetsRequest { } export namespace DescribeFleetsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeFleetsRequest): any => ({ ...obj, }); @@ -2707,6 +2953,9 @@ export interface DescribeFleetsResult { } export namespace DescribeFleetsResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeFleetsResult): any => ({ ...obj, }); @@ -2730,6 +2979,9 @@ export interface DescribeImageBuildersRequest { } export namespace DescribeImageBuildersRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeImageBuildersRequest): any => ({ ...obj, }); @@ -2748,6 +3000,9 @@ export interface DescribeImageBuildersResult { } export namespace DescribeImageBuildersResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeImageBuildersResult): any => ({ ...obj, }); @@ -2776,6 +3031,9 @@ export interface DescribeImagePermissionsRequest { } export namespace DescribeImagePermissionsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeImagePermissionsRequest): any => ({ ...obj, }); @@ -2797,6 +3055,9 @@ export interface SharedImagePermissions { } export namespace SharedImagePermissions { + /** + * @internal + */ export const filterSensitiveLog = (obj: SharedImagePermissions): any => ({ ...obj, }); @@ -2820,6 +3081,9 @@ export interface DescribeImagePermissionsResult { } export namespace DescribeImagePermissionsResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeImagePermissionsResult): any => ({ ...obj, }); @@ -2853,6 +3117,9 @@ export interface DescribeImagesRequest { } export namespace DescribeImagesRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeImagesRequest): any => ({ ...obj, }); @@ -2871,6 +3138,9 @@ export interface DescribeImagesResult { } export namespace DescribeImagesResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeImagesResult): any => ({ ...obj, }); @@ -2911,6 +3181,9 @@ export interface DescribeSessionsRequest { } export namespace DescribeSessionsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeSessionsRequest): any => ({ ...obj, }); @@ -2984,6 +3257,9 @@ export interface Session { } export namespace Session { + /** + * @internal + */ export const filterSensitiveLog = (obj: Session): any => ({ ...obj, }); @@ -3002,6 +3278,9 @@ export interface DescribeSessionsResult { } export namespace DescribeSessionsResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeSessionsResult): any => ({ ...obj, }); @@ -3020,6 +3299,9 @@ export interface DescribeStacksRequest { } export namespace DescribeStacksRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeStacksRequest): any => ({ ...obj, }); @@ -3038,6 +3320,9 @@ export interface DescribeStacksResult { } export namespace DescribeStacksResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeStacksResult): any => ({ ...obj, }); @@ -3056,6 +3341,9 @@ export interface DescribeUsageReportSubscriptionsRequest { } export namespace DescribeUsageReportSubscriptionsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeUsageReportSubscriptionsRequest): any => ({ ...obj, }); @@ -3083,6 +3371,9 @@ export interface LastReportGenerationExecutionError { } export namespace LastReportGenerationExecutionError { + /** + * @internal + */ export const filterSensitiveLog = (obj: LastReportGenerationExecutionError): any => ({ ...obj, }); @@ -3120,6 +3411,9 @@ export interface UsageReportSubscription { } export namespace UsageReportSubscription { + /** + * @internal + */ export const filterSensitiveLog = (obj: UsageReportSubscription): any => ({ ...obj, }); @@ -3138,6 +3432,9 @@ export interface DescribeUsageReportSubscriptionsResult { } export namespace DescribeUsageReportSubscriptionsResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeUsageReportSubscriptionsResult): any => ({ ...obj, }); @@ -3161,6 +3458,9 @@ export interface DescribeUsersRequest { } export namespace DescribeUsersRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeUsersRequest): any => ({ ...obj, }); @@ -3233,6 +3533,9 @@ export interface User { } export namespace User { + /** + * @internal + */ export const filterSensitiveLog = (obj: User): any => ({ ...obj, ...(obj.UserName && { UserName: SENSITIVE_STRING }), @@ -3254,6 +3557,9 @@ export interface DescribeUsersResult { } export namespace DescribeUsersResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeUsersResult): any => ({ ...obj, ...(obj.Users && { Users: obj.Users.map((item) => User.filterSensitiveLog(item)) }), @@ -3292,6 +3598,9 @@ export interface DescribeUserStackAssociationsRequest { } export namespace DescribeUserStackAssociationsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeUserStackAssociationsRequest): any => ({ ...obj, ...(obj.UserName && { UserName: SENSITIVE_STRING }), @@ -3311,6 +3620,9 @@ export interface DescribeUserStackAssociationsResult { } export namespace DescribeUserStackAssociationsResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeUserStackAssociationsResult): any => ({ ...obj, ...(obj.UserStackAssociations && { @@ -3336,6 +3648,9 @@ export interface DisableUserRequest { } export namespace DisableUserRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DisableUserRequest): any => ({ ...obj, ...(obj.UserName && { UserName: SENSITIVE_STRING }), @@ -3345,6 +3660,9 @@ export namespace DisableUserRequest { export interface DisableUserResult {} export namespace DisableUserResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: DisableUserResult): any => ({ ...obj, }); @@ -3363,6 +3681,9 @@ export interface DisassociateFleetRequest { } export namespace DisassociateFleetRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DisassociateFleetRequest): any => ({ ...obj, }); @@ -3371,6 +3692,9 @@ export namespace DisassociateFleetRequest { export interface DisassociateFleetResult {} export namespace DisassociateFleetResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: DisassociateFleetResult): any => ({ ...obj, }); @@ -3393,6 +3717,9 @@ export interface EnableUserRequest { } export namespace EnableUserRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: EnableUserRequest): any => ({ ...obj, ...(obj.UserName && { UserName: SENSITIVE_STRING }), @@ -3402,6 +3729,9 @@ export namespace EnableUserRequest { export interface EnableUserResult {} export namespace EnableUserResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: EnableUserResult): any => ({ ...obj, }); @@ -3415,6 +3745,9 @@ export interface ExpireSessionRequest { } export namespace ExpireSessionRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ExpireSessionRequest): any => ({ ...obj, }); @@ -3423,6 +3756,9 @@ export namespace ExpireSessionRequest { export interface ExpireSessionResult {} export namespace ExpireSessionResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: ExpireSessionResult): any => ({ ...obj, }); @@ -3448,6 +3784,9 @@ export interface ListAssociatedFleetsRequest { } export namespace ListAssociatedFleetsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListAssociatedFleetsRequest): any => ({ ...obj, }); @@ -3466,6 +3805,9 @@ export interface ListAssociatedFleetsResult { } export namespace ListAssociatedFleetsResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListAssociatedFleetsResult): any => ({ ...obj, }); @@ -3484,6 +3826,9 @@ export interface ListAssociatedStacksRequest { } export namespace ListAssociatedStacksRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListAssociatedStacksRequest): any => ({ ...obj, }); @@ -3502,6 +3847,9 @@ export interface ListAssociatedStacksResult { } export namespace ListAssociatedStacksResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListAssociatedStacksResult): any => ({ ...obj, }); @@ -3515,6 +3863,9 @@ export interface ListTagsForResourceRequest { } export namespace ListTagsForResourceRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListTagsForResourceRequest): any => ({ ...obj, }); @@ -3528,6 +3879,9 @@ export interface ListTagsForResourceResponse { } export namespace ListTagsForResourceResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListTagsForResourceResponse): any => ({ ...obj, }); @@ -3541,6 +3895,9 @@ export interface StartFleetRequest { } export namespace StartFleetRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: StartFleetRequest): any => ({ ...obj, }); @@ -3549,6 +3906,9 @@ export namespace StartFleetRequest { export interface StartFleetResult {} export namespace StartFleetResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: StartFleetResult): any => ({ ...obj, }); @@ -3567,6 +3927,9 @@ export interface StartImageBuilderRequest { } export namespace StartImageBuilderRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: StartImageBuilderRequest): any => ({ ...obj, }); @@ -3580,6 +3943,9 @@ export interface StartImageBuilderResult { } export namespace StartImageBuilderResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: StartImageBuilderResult): any => ({ ...obj, }); @@ -3593,6 +3959,9 @@ export interface StopFleetRequest { } export namespace StopFleetRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: StopFleetRequest): any => ({ ...obj, }); @@ -3601,6 +3970,9 @@ export namespace StopFleetRequest { export interface StopFleetResult {} export namespace StopFleetResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: StopFleetResult): any => ({ ...obj, }); @@ -3614,6 +3986,9 @@ export interface StopImageBuilderRequest { } export namespace StopImageBuilderRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: StopImageBuilderRequest): any => ({ ...obj, }); @@ -3627,6 +4002,9 @@ export interface StopImageBuilderResult { } export namespace StopImageBuilderResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: StopImageBuilderResult): any => ({ ...obj, }); @@ -3650,6 +4028,9 @@ export interface TagResourceRequest { } export namespace TagResourceRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: TagResourceRequest): any => ({ ...obj, }); @@ -3658,6 +4039,9 @@ export namespace TagResourceRequest { export interface TagResourceResponse {} export namespace TagResourceResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: TagResourceResponse): any => ({ ...obj, }); @@ -3676,6 +4060,9 @@ export interface UntagResourceRequest { } export namespace UntagResourceRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: UntagResourceRequest): any => ({ ...obj, }); @@ -3684,6 +4071,9 @@ export namespace UntagResourceRequest { export interface UntagResourceResponse {} export namespace UntagResourceResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: UntagResourceResponse): any => ({ ...obj, }); @@ -3707,6 +4097,9 @@ export interface UpdateDirectoryConfigRequest { } export namespace UpdateDirectoryConfigRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateDirectoryConfigRequest): any => ({ ...obj, ...(obj.ServiceAccountCredentials && { @@ -3723,6 +4116,9 @@ export interface UpdateDirectoryConfigResult { } export namespace UpdateDirectoryConfigResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateDirectoryConfigResult): any => ({ ...obj, ...(obj.DirectoryConfig && { DirectoryConfig: DirectoryConfig.filterSensitiveLog(obj.DirectoryConfig) }), @@ -3940,6 +4336,9 @@ export interface UpdateFleetRequest { } export namespace UpdateFleetRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateFleetRequest): any => ({ ...obj, }); @@ -3953,6 +4352,9 @@ export interface UpdateFleetResult { } export namespace UpdateFleetResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateFleetResult): any => ({ ...obj, }); @@ -3976,6 +4378,9 @@ export interface UpdateImagePermissionsRequest { } export namespace UpdateImagePermissionsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateImagePermissionsRequest): any => ({ ...obj, }); @@ -3984,6 +4389,9 @@ export namespace UpdateImagePermissionsRequest { export interface UpdateImagePermissionsResult {} export namespace UpdateImagePermissionsResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateImagePermissionsResult): any => ({ ...obj, }); @@ -4068,6 +4476,9 @@ export interface UpdateStackRequest { } export namespace UpdateStackRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateStackRequest): any => ({ ...obj, }); @@ -4081,6 +4492,9 @@ export interface UpdateStackResult { } export namespace UpdateStackResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateStackResult): any => ({ ...obj, }); diff --git a/clients/client-appsync/commands/CreateApiCacheCommand.ts b/clients/client-appsync/commands/CreateApiCacheCommand.ts index 1777a11e6faf..08b3d0f7cb13 100644 --- a/clients/client-appsync/commands/CreateApiCacheCommand.ts +++ b/clients/client-appsync/commands/CreateApiCacheCommand.ts @@ -22,6 +22,20 @@ export interface CreateApiCacheCommandOutput extends CreateApiCacheResponse, __M /** *

Creates a cache for the GraphQL API.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { AppSyncClient, CreateApiCacheCommand } from "@aws-sdk/client-appsync"; // ES Modules import + * // const { AppSyncClient, CreateApiCacheCommand } = require("@aws-sdk/client-appsync"); // CommonJS import + * const client = new AppSyncClient(config); + * const command = new CreateApiCacheCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreateApiCacheCommandInput} for command's `input` shape. + * @see {@link CreateApiCacheCommandOutput} for command's `response` shape. + * @see {@link AppSyncClientResolvedConfig | config} for command's `input` shape. + * */ export class CreateApiCacheCommand extends $Command< CreateApiCacheCommandInput, diff --git a/clients/client-appsync/commands/CreateApiKeyCommand.ts b/clients/client-appsync/commands/CreateApiKeyCommand.ts index 6bcf22bdf0da..254020b40bc3 100644 --- a/clients/client-appsync/commands/CreateApiKeyCommand.ts +++ b/clients/client-appsync/commands/CreateApiKeyCommand.ts @@ -23,6 +23,20 @@ export interface CreateApiKeyCommandOutput extends CreateApiKeyResponse, __Metad /** *

Creates a unique key that you can distribute to clients who are executing your * API.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { AppSyncClient, CreateApiKeyCommand } from "@aws-sdk/client-appsync"; // ES Modules import + * // const { AppSyncClient, CreateApiKeyCommand } = require("@aws-sdk/client-appsync"); // CommonJS import + * const client = new AppSyncClient(config); + * const command = new CreateApiKeyCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreateApiKeyCommandInput} for command's `input` shape. + * @see {@link CreateApiKeyCommandOutput} for command's `response` shape. + * @see {@link AppSyncClientResolvedConfig | config} for command's `input` shape. + * */ export class CreateApiKeyCommand extends $Command< CreateApiKeyCommandInput, diff --git a/clients/client-appsync/commands/CreateDataSourceCommand.ts b/clients/client-appsync/commands/CreateDataSourceCommand.ts index 638b8bbe42a5..1e1eb353cb09 100644 --- a/clients/client-appsync/commands/CreateDataSourceCommand.ts +++ b/clients/client-appsync/commands/CreateDataSourceCommand.ts @@ -22,6 +22,20 @@ export interface CreateDataSourceCommandOutput extends CreateDataSourceResponse, /** *

Creates a DataSource object.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { AppSyncClient, CreateDataSourceCommand } from "@aws-sdk/client-appsync"; // ES Modules import + * // const { AppSyncClient, CreateDataSourceCommand } = require("@aws-sdk/client-appsync"); // CommonJS import + * const client = new AppSyncClient(config); + * const command = new CreateDataSourceCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreateDataSourceCommandInput} for command's `input` shape. + * @see {@link CreateDataSourceCommandOutput} for command's `response` shape. + * @see {@link AppSyncClientResolvedConfig | config} for command's `input` shape. + * */ export class CreateDataSourceCommand extends $Command< CreateDataSourceCommandInput, diff --git a/clients/client-appsync/commands/CreateFunctionCommand.ts b/clients/client-appsync/commands/CreateFunctionCommand.ts index f8c7c0d47b92..fceb9f6f5912 100644 --- a/clients/client-appsync/commands/CreateFunctionCommand.ts +++ b/clients/client-appsync/commands/CreateFunctionCommand.ts @@ -24,6 +24,20 @@ export interface CreateFunctionCommandOutput extends CreateFunctionResponse, __M *

Creates a Function object.

*

A function is a reusable entity. Multiple functions can be used to compose the resolver * logic.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { AppSyncClient, CreateFunctionCommand } from "@aws-sdk/client-appsync"; // ES Modules import + * // const { AppSyncClient, CreateFunctionCommand } = require("@aws-sdk/client-appsync"); // CommonJS import + * const client = new AppSyncClient(config); + * const command = new CreateFunctionCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreateFunctionCommandInput} for command's `input` shape. + * @see {@link CreateFunctionCommandOutput} for command's `response` shape. + * @see {@link AppSyncClientResolvedConfig | config} for command's `input` shape. + * */ export class CreateFunctionCommand extends $Command< CreateFunctionCommandInput, diff --git a/clients/client-appsync/commands/CreateGraphqlApiCommand.ts b/clients/client-appsync/commands/CreateGraphqlApiCommand.ts index ba108f035fae..feb191d75d25 100644 --- a/clients/client-appsync/commands/CreateGraphqlApiCommand.ts +++ b/clients/client-appsync/commands/CreateGraphqlApiCommand.ts @@ -22,6 +22,20 @@ export interface CreateGraphqlApiCommandOutput extends CreateGraphqlApiResponse, /** *

Creates a GraphqlApi object.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { AppSyncClient, CreateGraphqlApiCommand } from "@aws-sdk/client-appsync"; // ES Modules import + * // const { AppSyncClient, CreateGraphqlApiCommand } = require("@aws-sdk/client-appsync"); // CommonJS import + * const client = new AppSyncClient(config); + * const command = new CreateGraphqlApiCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreateGraphqlApiCommandInput} for command's `input` shape. + * @see {@link CreateGraphqlApiCommandOutput} for command's `response` shape. + * @see {@link AppSyncClientResolvedConfig | config} for command's `input` shape. + * */ export class CreateGraphqlApiCommand extends $Command< CreateGraphqlApiCommandInput, diff --git a/clients/client-appsync/commands/CreateResolverCommand.ts b/clients/client-appsync/commands/CreateResolverCommand.ts index 07362980141b..224cc84d08a8 100644 --- a/clients/client-appsync/commands/CreateResolverCommand.ts +++ b/clients/client-appsync/commands/CreateResolverCommand.ts @@ -24,6 +24,20 @@ export interface CreateResolverCommandOutput extends CreateResolverResponse, __M *

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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { AppSyncClient, CreateResolverCommand } from "@aws-sdk/client-appsync"; // ES Modules import + * // const { AppSyncClient, CreateResolverCommand } = require("@aws-sdk/client-appsync"); // CommonJS import + * const client = new AppSyncClient(config); + * const command = new CreateResolverCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreateResolverCommandInput} for command's `input` shape. + * @see {@link CreateResolverCommandOutput} for command's `response` shape. + * @see {@link AppSyncClientResolvedConfig | config} for command's `input` shape. + * */ export class CreateResolverCommand extends $Command< CreateResolverCommandInput, diff --git a/clients/client-appsync/commands/CreateTypeCommand.ts b/clients/client-appsync/commands/CreateTypeCommand.ts index 84fe123d36f7..b4655c0ea158 100644 --- a/clients/client-appsync/commands/CreateTypeCommand.ts +++ b/clients/client-appsync/commands/CreateTypeCommand.ts @@ -22,6 +22,20 @@ export interface CreateTypeCommandOutput extends CreateTypeResponse, __MetadataB /** *

Creates a Type object.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { AppSyncClient, CreateTypeCommand } from "@aws-sdk/client-appsync"; // ES Modules import + * // const { AppSyncClient, CreateTypeCommand } = require("@aws-sdk/client-appsync"); // CommonJS import + * const client = new AppSyncClient(config); + * const command = new CreateTypeCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreateTypeCommandInput} for command's `input` shape. + * @see {@link CreateTypeCommandOutput} for command's `response` shape. + * @see {@link AppSyncClientResolvedConfig | config} for command's `input` shape. + * */ export class CreateTypeCommand extends $Command< CreateTypeCommandInput, diff --git a/clients/client-appsync/commands/DeleteApiCacheCommand.ts b/clients/client-appsync/commands/DeleteApiCacheCommand.ts index 2ff759345b60..b4e358de69eb 100644 --- a/clients/client-appsync/commands/DeleteApiCacheCommand.ts +++ b/clients/client-appsync/commands/DeleteApiCacheCommand.ts @@ -22,6 +22,20 @@ export interface DeleteApiCacheCommandOutput extends DeleteApiCacheResponse, __M /** *

Deletes an ApiCache object.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { AppSyncClient, DeleteApiCacheCommand } from "@aws-sdk/client-appsync"; // ES Modules import + * // const { AppSyncClient, DeleteApiCacheCommand } = require("@aws-sdk/client-appsync"); // CommonJS import + * const client = new AppSyncClient(config); + * const command = new DeleteApiCacheCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteApiCacheCommandInput} for command's `input` shape. + * @see {@link DeleteApiCacheCommandOutput} for command's `response` shape. + * @see {@link AppSyncClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteApiCacheCommand extends $Command< DeleteApiCacheCommandInput, diff --git a/clients/client-appsync/commands/DeleteApiKeyCommand.ts b/clients/client-appsync/commands/DeleteApiKeyCommand.ts index de1c9641902e..90277c235450 100644 --- a/clients/client-appsync/commands/DeleteApiKeyCommand.ts +++ b/clients/client-appsync/commands/DeleteApiKeyCommand.ts @@ -22,6 +22,20 @@ export interface DeleteApiKeyCommandOutput extends DeleteApiKeyResponse, __Metad /** *

Deletes an API key.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { AppSyncClient, DeleteApiKeyCommand } from "@aws-sdk/client-appsync"; // ES Modules import + * // const { AppSyncClient, DeleteApiKeyCommand } = require("@aws-sdk/client-appsync"); // CommonJS import + * const client = new AppSyncClient(config); + * const command = new DeleteApiKeyCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteApiKeyCommandInput} for command's `input` shape. + * @see {@link DeleteApiKeyCommandOutput} for command's `response` shape. + * @see {@link AppSyncClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteApiKeyCommand extends $Command< DeleteApiKeyCommandInput, diff --git a/clients/client-appsync/commands/DeleteDataSourceCommand.ts b/clients/client-appsync/commands/DeleteDataSourceCommand.ts index 03c1421b12fd..de0250def3ec 100644 --- a/clients/client-appsync/commands/DeleteDataSourceCommand.ts +++ b/clients/client-appsync/commands/DeleteDataSourceCommand.ts @@ -22,6 +22,20 @@ export interface DeleteDataSourceCommandOutput extends DeleteDataSourceResponse, /** *

Deletes a DataSource object.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { AppSyncClient, DeleteDataSourceCommand } from "@aws-sdk/client-appsync"; // ES Modules import + * // const { AppSyncClient, DeleteDataSourceCommand } = require("@aws-sdk/client-appsync"); // CommonJS import + * const client = new AppSyncClient(config); + * const command = new DeleteDataSourceCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteDataSourceCommandInput} for command's `input` shape. + * @see {@link DeleteDataSourceCommandOutput} for command's `response` shape. + * @see {@link AppSyncClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteDataSourceCommand extends $Command< DeleteDataSourceCommandInput, diff --git a/clients/client-appsync/commands/DeleteFunctionCommand.ts b/clients/client-appsync/commands/DeleteFunctionCommand.ts index 113d7074c9d9..d27840ae0061 100644 --- a/clients/client-appsync/commands/DeleteFunctionCommand.ts +++ b/clients/client-appsync/commands/DeleteFunctionCommand.ts @@ -22,6 +22,20 @@ export interface DeleteFunctionCommandOutput extends DeleteFunctionResponse, __M /** *

Deletes a Function.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { AppSyncClient, DeleteFunctionCommand } from "@aws-sdk/client-appsync"; // ES Modules import + * // const { AppSyncClient, DeleteFunctionCommand } = require("@aws-sdk/client-appsync"); // CommonJS import + * const client = new AppSyncClient(config); + * const command = new DeleteFunctionCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteFunctionCommandInput} for command's `input` shape. + * @see {@link DeleteFunctionCommandOutput} for command's `response` shape. + * @see {@link AppSyncClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteFunctionCommand extends $Command< DeleteFunctionCommandInput, diff --git a/clients/client-appsync/commands/DeleteGraphqlApiCommand.ts b/clients/client-appsync/commands/DeleteGraphqlApiCommand.ts index 0f49ddd5b264..6cc8f81d76ed 100644 --- a/clients/client-appsync/commands/DeleteGraphqlApiCommand.ts +++ b/clients/client-appsync/commands/DeleteGraphqlApiCommand.ts @@ -22,6 +22,20 @@ export interface DeleteGraphqlApiCommandOutput extends DeleteGraphqlApiResponse, /** *

Deletes a GraphqlApi object.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { AppSyncClient, DeleteGraphqlApiCommand } from "@aws-sdk/client-appsync"; // ES Modules import + * // const { AppSyncClient, DeleteGraphqlApiCommand } = require("@aws-sdk/client-appsync"); // CommonJS import + * const client = new AppSyncClient(config); + * const command = new DeleteGraphqlApiCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteGraphqlApiCommandInput} for command's `input` shape. + * @see {@link DeleteGraphqlApiCommandOutput} for command's `response` shape. + * @see {@link AppSyncClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteGraphqlApiCommand extends $Command< DeleteGraphqlApiCommandInput, diff --git a/clients/client-appsync/commands/DeleteResolverCommand.ts b/clients/client-appsync/commands/DeleteResolverCommand.ts index 32a393672ba6..3169c42a9c2f 100644 --- a/clients/client-appsync/commands/DeleteResolverCommand.ts +++ b/clients/client-appsync/commands/DeleteResolverCommand.ts @@ -22,6 +22,20 @@ export interface DeleteResolverCommandOutput extends DeleteResolverResponse, __M /** *

Deletes a Resolver object.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { AppSyncClient, DeleteResolverCommand } from "@aws-sdk/client-appsync"; // ES Modules import + * // const { AppSyncClient, DeleteResolverCommand } = require("@aws-sdk/client-appsync"); // CommonJS import + * const client = new AppSyncClient(config); + * const command = new DeleteResolverCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteResolverCommandInput} for command's `input` shape. + * @see {@link DeleteResolverCommandOutput} for command's `response` shape. + * @see {@link AppSyncClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteResolverCommand extends $Command< DeleteResolverCommandInput, diff --git a/clients/client-appsync/commands/DeleteTypeCommand.ts b/clients/client-appsync/commands/DeleteTypeCommand.ts index 3ee3e64631c5..6bddf0ca2161 100644 --- a/clients/client-appsync/commands/DeleteTypeCommand.ts +++ b/clients/client-appsync/commands/DeleteTypeCommand.ts @@ -22,6 +22,20 @@ export interface DeleteTypeCommandOutput extends DeleteTypeResponse, __MetadataB /** *

Deletes a Type object.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { AppSyncClient, DeleteTypeCommand } from "@aws-sdk/client-appsync"; // ES Modules import + * // const { AppSyncClient, DeleteTypeCommand } = require("@aws-sdk/client-appsync"); // CommonJS import + * const client = new AppSyncClient(config); + * const command = new DeleteTypeCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteTypeCommandInput} for command's `input` shape. + * @see {@link DeleteTypeCommandOutput} for command's `response` shape. + * @see {@link AppSyncClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteTypeCommand extends $Command< DeleteTypeCommandInput, diff --git a/clients/client-appsync/commands/FlushApiCacheCommand.ts b/clients/client-appsync/commands/FlushApiCacheCommand.ts index 1849d28ca249..72644635b3a5 100644 --- a/clients/client-appsync/commands/FlushApiCacheCommand.ts +++ b/clients/client-appsync/commands/FlushApiCacheCommand.ts @@ -22,6 +22,20 @@ export interface FlushApiCacheCommandOutput extends FlushApiCacheResponse, __Met /** *

Flushes an ApiCache object.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { AppSyncClient, FlushApiCacheCommand } from "@aws-sdk/client-appsync"; // ES Modules import + * // const { AppSyncClient, FlushApiCacheCommand } = require("@aws-sdk/client-appsync"); // CommonJS import + * const client = new AppSyncClient(config); + * const command = new FlushApiCacheCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link FlushApiCacheCommandInput} for command's `input` shape. + * @see {@link FlushApiCacheCommandOutput} for command's `response` shape. + * @see {@link AppSyncClientResolvedConfig | config} for command's `input` shape. + * */ export class FlushApiCacheCommand extends $Command< FlushApiCacheCommandInput, diff --git a/clients/client-appsync/commands/GetApiCacheCommand.ts b/clients/client-appsync/commands/GetApiCacheCommand.ts index 84a00ac58b5b..ced561631bea 100644 --- a/clients/client-appsync/commands/GetApiCacheCommand.ts +++ b/clients/client-appsync/commands/GetApiCacheCommand.ts @@ -22,6 +22,20 @@ export interface GetApiCacheCommandOutput extends GetApiCacheResponse, __Metadat /** *

Retrieves an ApiCache object.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { AppSyncClient, GetApiCacheCommand } from "@aws-sdk/client-appsync"; // ES Modules import + * // const { AppSyncClient, GetApiCacheCommand } = require("@aws-sdk/client-appsync"); // CommonJS import + * const client = new AppSyncClient(config); + * const command = new GetApiCacheCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetApiCacheCommandInput} for command's `input` shape. + * @see {@link GetApiCacheCommandOutput} for command's `response` shape. + * @see {@link AppSyncClientResolvedConfig | config} for command's `input` shape. + * */ export class GetApiCacheCommand extends $Command< GetApiCacheCommandInput, diff --git a/clients/client-appsync/commands/GetDataSourceCommand.ts b/clients/client-appsync/commands/GetDataSourceCommand.ts index c6843e620f52..fb33375530e6 100644 --- a/clients/client-appsync/commands/GetDataSourceCommand.ts +++ b/clients/client-appsync/commands/GetDataSourceCommand.ts @@ -22,6 +22,20 @@ export interface GetDataSourceCommandOutput extends GetDataSourceResponse, __Met /** *

Retrieves a DataSource object.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { AppSyncClient, GetDataSourceCommand } from "@aws-sdk/client-appsync"; // ES Modules import + * // const { AppSyncClient, GetDataSourceCommand } = require("@aws-sdk/client-appsync"); // CommonJS import + * const client = new AppSyncClient(config); + * const command = new GetDataSourceCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetDataSourceCommandInput} for command's `input` shape. + * @see {@link GetDataSourceCommandOutput} for command's `response` shape. + * @see {@link AppSyncClientResolvedConfig | config} for command's `input` shape. + * */ export class GetDataSourceCommand extends $Command< GetDataSourceCommandInput, diff --git a/clients/client-appsync/commands/GetFunctionCommand.ts b/clients/client-appsync/commands/GetFunctionCommand.ts index 0462871cbee6..c51fcefc65a0 100644 --- a/clients/client-appsync/commands/GetFunctionCommand.ts +++ b/clients/client-appsync/commands/GetFunctionCommand.ts @@ -22,6 +22,20 @@ export interface GetFunctionCommandOutput extends GetFunctionResponse, __Metadat /** *

Get a Function.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { AppSyncClient, GetFunctionCommand } from "@aws-sdk/client-appsync"; // ES Modules import + * // const { AppSyncClient, GetFunctionCommand } = require("@aws-sdk/client-appsync"); // CommonJS import + * const client = new AppSyncClient(config); + * const command = new GetFunctionCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetFunctionCommandInput} for command's `input` shape. + * @see {@link GetFunctionCommandOutput} for command's `response` shape. + * @see {@link AppSyncClientResolvedConfig | config} for command's `input` shape. + * */ export class GetFunctionCommand extends $Command< GetFunctionCommandInput, diff --git a/clients/client-appsync/commands/GetGraphqlApiCommand.ts b/clients/client-appsync/commands/GetGraphqlApiCommand.ts index 559c1c86c202..91b4ab1dafd3 100644 --- a/clients/client-appsync/commands/GetGraphqlApiCommand.ts +++ b/clients/client-appsync/commands/GetGraphqlApiCommand.ts @@ -22,6 +22,20 @@ export interface GetGraphqlApiCommandOutput extends GetGraphqlApiResponse, __Met /** *

Retrieves a GraphqlApi object.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { AppSyncClient, GetGraphqlApiCommand } from "@aws-sdk/client-appsync"; // ES Modules import + * // const { AppSyncClient, GetGraphqlApiCommand } = require("@aws-sdk/client-appsync"); // CommonJS import + * const client = new AppSyncClient(config); + * const command = new GetGraphqlApiCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetGraphqlApiCommandInput} for command's `input` shape. + * @see {@link GetGraphqlApiCommandOutput} for command's `response` shape. + * @see {@link AppSyncClientResolvedConfig | config} for command's `input` shape. + * */ export class GetGraphqlApiCommand extends $Command< GetGraphqlApiCommandInput, diff --git a/clients/client-appsync/commands/GetIntrospectionSchemaCommand.ts b/clients/client-appsync/commands/GetIntrospectionSchemaCommand.ts index 8ade56b040ba..7813c9e4074c 100644 --- a/clients/client-appsync/commands/GetIntrospectionSchemaCommand.ts +++ b/clients/client-appsync/commands/GetIntrospectionSchemaCommand.ts @@ -22,6 +22,20 @@ export interface GetIntrospectionSchemaCommandOutput extends GetIntrospectionSch /** *

Retrieves the introspection schema for a GraphQL API.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { AppSyncClient, GetIntrospectionSchemaCommand } from "@aws-sdk/client-appsync"; // ES Modules import + * // const { AppSyncClient, GetIntrospectionSchemaCommand } = require("@aws-sdk/client-appsync"); // CommonJS import + * const client = new AppSyncClient(config); + * const command = new GetIntrospectionSchemaCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetIntrospectionSchemaCommandInput} for command's `input` shape. + * @see {@link GetIntrospectionSchemaCommandOutput} for command's `response` shape. + * @see {@link AppSyncClientResolvedConfig | config} for command's `input` shape. + * */ export class GetIntrospectionSchemaCommand extends $Command< GetIntrospectionSchemaCommandInput, diff --git a/clients/client-appsync/commands/GetResolverCommand.ts b/clients/client-appsync/commands/GetResolverCommand.ts index 0beafe13be1f..6fd54e5159b1 100644 --- a/clients/client-appsync/commands/GetResolverCommand.ts +++ b/clients/client-appsync/commands/GetResolverCommand.ts @@ -22,6 +22,20 @@ export interface GetResolverCommandOutput extends GetResolverResponse, __Metadat /** *

Retrieves a Resolver object.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { AppSyncClient, GetResolverCommand } from "@aws-sdk/client-appsync"; // ES Modules import + * // const { AppSyncClient, GetResolverCommand } = require("@aws-sdk/client-appsync"); // CommonJS import + * const client = new AppSyncClient(config); + * const command = new GetResolverCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetResolverCommandInput} for command's `input` shape. + * @see {@link GetResolverCommandOutput} for command's `response` shape. + * @see {@link AppSyncClientResolvedConfig | config} for command's `input` shape. + * */ export class GetResolverCommand extends $Command< GetResolverCommandInput, diff --git a/clients/client-appsync/commands/GetSchemaCreationStatusCommand.ts b/clients/client-appsync/commands/GetSchemaCreationStatusCommand.ts index 5adcc1e3b9e1..695718d97736 100644 --- a/clients/client-appsync/commands/GetSchemaCreationStatusCommand.ts +++ b/clients/client-appsync/commands/GetSchemaCreationStatusCommand.ts @@ -22,6 +22,20 @@ export interface GetSchemaCreationStatusCommandOutput extends GetSchemaCreationS /** *

Retrieves the current status of a schema creation operation.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { AppSyncClient, GetSchemaCreationStatusCommand } from "@aws-sdk/client-appsync"; // ES Modules import + * // const { AppSyncClient, GetSchemaCreationStatusCommand } = require("@aws-sdk/client-appsync"); // CommonJS import + * const client = new AppSyncClient(config); + * const command = new GetSchemaCreationStatusCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetSchemaCreationStatusCommandInput} for command's `input` shape. + * @see {@link GetSchemaCreationStatusCommandOutput} for command's `response` shape. + * @see {@link AppSyncClientResolvedConfig | config} for command's `input` shape. + * */ export class GetSchemaCreationStatusCommand extends $Command< GetSchemaCreationStatusCommandInput, diff --git a/clients/client-appsync/commands/GetTypeCommand.ts b/clients/client-appsync/commands/GetTypeCommand.ts index 525d570cf186..a082d9464f96 100644 --- a/clients/client-appsync/commands/GetTypeCommand.ts +++ b/clients/client-appsync/commands/GetTypeCommand.ts @@ -22,6 +22,20 @@ export interface GetTypeCommandOutput extends GetTypeResponse, __MetadataBearer /** *

Retrieves a Type object.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { AppSyncClient, GetTypeCommand } from "@aws-sdk/client-appsync"; // ES Modules import + * // const { AppSyncClient, GetTypeCommand } = require("@aws-sdk/client-appsync"); // CommonJS import + * const client = new AppSyncClient(config); + * const command = new GetTypeCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetTypeCommandInput} for command's `input` shape. + * @see {@link GetTypeCommandOutput} for command's `response` shape. + * @see {@link AppSyncClientResolvedConfig | config} for command's `input` shape. + * */ export class GetTypeCommand extends $Command { // Start section: command_properties diff --git a/clients/client-appsync/commands/ListApiKeysCommand.ts b/clients/client-appsync/commands/ListApiKeysCommand.ts index 3d8b3bc028b6..de2016f5fe4c 100644 --- a/clients/client-appsync/commands/ListApiKeysCommand.ts +++ b/clients/client-appsync/commands/ListApiKeysCommand.ts @@ -28,6 +28,20 @@ export interface ListApiKeysCommandOutput extends ListApiKeysResponse, __Metadat * call DeleteApiKey to manually delete a key before it's automatically * deleted.

* + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { AppSyncClient, ListApiKeysCommand } from "@aws-sdk/client-appsync"; // ES Modules import + * // const { AppSyncClient, ListApiKeysCommand } = require("@aws-sdk/client-appsync"); // CommonJS import + * const client = new AppSyncClient(config); + * const command = new ListApiKeysCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListApiKeysCommandInput} for command's `input` shape. + * @see {@link ListApiKeysCommandOutput} for command's `response` shape. + * @see {@link AppSyncClientResolvedConfig | config} for command's `input` shape. + * */ export class ListApiKeysCommand extends $Command< ListApiKeysCommandInput, diff --git a/clients/client-appsync/commands/ListDataSourcesCommand.ts b/clients/client-appsync/commands/ListDataSourcesCommand.ts index af5a8477176a..57ac68bd3ba4 100644 --- a/clients/client-appsync/commands/ListDataSourcesCommand.ts +++ b/clients/client-appsync/commands/ListDataSourcesCommand.ts @@ -22,6 +22,20 @@ export interface ListDataSourcesCommandOutput extends ListDataSourcesResponse, _ /** *

Lists the data sources for a given API.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { AppSyncClient, ListDataSourcesCommand } from "@aws-sdk/client-appsync"; // ES Modules import + * // const { AppSyncClient, ListDataSourcesCommand } = require("@aws-sdk/client-appsync"); // CommonJS import + * const client = new AppSyncClient(config); + * const command = new ListDataSourcesCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListDataSourcesCommandInput} for command's `input` shape. + * @see {@link ListDataSourcesCommandOutput} for command's `response` shape. + * @see {@link AppSyncClientResolvedConfig | config} for command's `input` shape. + * */ export class ListDataSourcesCommand extends $Command< ListDataSourcesCommandInput, diff --git a/clients/client-appsync/commands/ListFunctionsCommand.ts b/clients/client-appsync/commands/ListFunctionsCommand.ts index f9637f3f4bfd..0eff4709a9ad 100644 --- a/clients/client-appsync/commands/ListFunctionsCommand.ts +++ b/clients/client-appsync/commands/ListFunctionsCommand.ts @@ -22,6 +22,20 @@ export interface ListFunctionsCommandOutput extends ListFunctionsResponse, __Met /** *

List multiple functions.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { AppSyncClient, ListFunctionsCommand } from "@aws-sdk/client-appsync"; // ES Modules import + * // const { AppSyncClient, ListFunctionsCommand } = require("@aws-sdk/client-appsync"); // CommonJS import + * const client = new AppSyncClient(config); + * const command = new ListFunctionsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListFunctionsCommandInput} for command's `input` shape. + * @see {@link ListFunctionsCommandOutput} for command's `response` shape. + * @see {@link AppSyncClientResolvedConfig | config} for command's `input` shape. + * */ export class ListFunctionsCommand extends $Command< ListFunctionsCommandInput, diff --git a/clients/client-appsync/commands/ListGraphqlApisCommand.ts b/clients/client-appsync/commands/ListGraphqlApisCommand.ts index 0db7c6f9e2e2..959206a61ac0 100644 --- a/clients/client-appsync/commands/ListGraphqlApisCommand.ts +++ b/clients/client-appsync/commands/ListGraphqlApisCommand.ts @@ -22,6 +22,20 @@ export interface ListGraphqlApisCommandOutput extends ListGraphqlApisResponse, _ /** *

Lists your GraphQL APIs.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { AppSyncClient, ListGraphqlApisCommand } from "@aws-sdk/client-appsync"; // ES Modules import + * // const { AppSyncClient, ListGraphqlApisCommand } = require("@aws-sdk/client-appsync"); // CommonJS import + * const client = new AppSyncClient(config); + * const command = new ListGraphqlApisCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListGraphqlApisCommandInput} for command's `input` shape. + * @see {@link ListGraphqlApisCommandOutput} for command's `response` shape. + * @see {@link AppSyncClientResolvedConfig | config} for command's `input` shape. + * */ export class ListGraphqlApisCommand extends $Command< ListGraphqlApisCommandInput, diff --git a/clients/client-appsync/commands/ListResolversByFunctionCommand.ts b/clients/client-appsync/commands/ListResolversByFunctionCommand.ts index c11b43a3b819..1f0e4e8e40e8 100644 --- a/clients/client-appsync/commands/ListResolversByFunctionCommand.ts +++ b/clients/client-appsync/commands/ListResolversByFunctionCommand.ts @@ -22,6 +22,20 @@ export interface ListResolversByFunctionCommandOutput extends ListResolversByFun /** *

List the resolvers that are associated with a specific function.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { AppSyncClient, ListResolversByFunctionCommand } from "@aws-sdk/client-appsync"; // ES Modules import + * // const { AppSyncClient, ListResolversByFunctionCommand } = require("@aws-sdk/client-appsync"); // CommonJS import + * const client = new AppSyncClient(config); + * const command = new ListResolversByFunctionCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListResolversByFunctionCommandInput} for command's `input` shape. + * @see {@link ListResolversByFunctionCommandOutput} for command's `response` shape. + * @see {@link AppSyncClientResolvedConfig | config} for command's `input` shape. + * */ export class ListResolversByFunctionCommand extends $Command< ListResolversByFunctionCommandInput, diff --git a/clients/client-appsync/commands/ListResolversCommand.ts b/clients/client-appsync/commands/ListResolversCommand.ts index cedacb9ed38c..92652fcab830 100644 --- a/clients/client-appsync/commands/ListResolversCommand.ts +++ b/clients/client-appsync/commands/ListResolversCommand.ts @@ -22,6 +22,20 @@ export interface ListResolversCommandOutput extends ListResolversResponse, __Met /** *

Lists the resolvers for a given API and type.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { AppSyncClient, ListResolversCommand } from "@aws-sdk/client-appsync"; // ES Modules import + * // const { AppSyncClient, ListResolversCommand } = require("@aws-sdk/client-appsync"); // CommonJS import + * const client = new AppSyncClient(config); + * const command = new ListResolversCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListResolversCommandInput} for command's `input` shape. + * @see {@link ListResolversCommandOutput} for command's `response` shape. + * @see {@link AppSyncClientResolvedConfig | config} for command's `input` shape. + * */ export class ListResolversCommand extends $Command< ListResolversCommandInput, diff --git a/clients/client-appsync/commands/ListTagsForResourceCommand.ts b/clients/client-appsync/commands/ListTagsForResourceCommand.ts index 584acec888f0..2fa6f009b531 100644 --- a/clients/client-appsync/commands/ListTagsForResourceCommand.ts +++ b/clients/client-appsync/commands/ListTagsForResourceCommand.ts @@ -22,6 +22,20 @@ export interface ListTagsForResourceCommandOutput extends ListTagsForResourceRes /** *

Lists the tags for a resource.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { AppSyncClient, ListTagsForResourceCommand } from "@aws-sdk/client-appsync"; // ES Modules import + * // const { AppSyncClient, ListTagsForResourceCommand } = require("@aws-sdk/client-appsync"); // CommonJS import + * const client = new AppSyncClient(config); + * const command = new ListTagsForResourceCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListTagsForResourceCommandInput} for command's `input` shape. + * @see {@link ListTagsForResourceCommandOutput} for command's `response` shape. + * @see {@link AppSyncClientResolvedConfig | config} for command's `input` shape. + * */ export class ListTagsForResourceCommand extends $Command< ListTagsForResourceCommandInput, diff --git a/clients/client-appsync/commands/ListTypesCommand.ts b/clients/client-appsync/commands/ListTypesCommand.ts index 76a6fdd053a4..d25dc47a077b 100644 --- a/clients/client-appsync/commands/ListTypesCommand.ts +++ b/clients/client-appsync/commands/ListTypesCommand.ts @@ -22,6 +22,20 @@ export interface ListTypesCommandOutput extends ListTypesResponse, __MetadataBea /** *

Lists the types for a given API.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { AppSyncClient, ListTypesCommand } from "@aws-sdk/client-appsync"; // ES Modules import + * // const { AppSyncClient, ListTypesCommand } = require("@aws-sdk/client-appsync"); // CommonJS import + * const client = new AppSyncClient(config); + * const command = new ListTypesCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListTypesCommandInput} for command's `input` shape. + * @see {@link ListTypesCommandOutput} for command's `response` shape. + * @see {@link AppSyncClientResolvedConfig | config} for command's `input` shape. + * */ export class ListTypesCommand extends $Command< ListTypesCommandInput, diff --git a/clients/client-appsync/commands/StartSchemaCreationCommand.ts b/clients/client-appsync/commands/StartSchemaCreationCommand.ts index 1b7098f2a71a..070cf3cd7386 100644 --- a/clients/client-appsync/commands/StartSchemaCreationCommand.ts +++ b/clients/client-appsync/commands/StartSchemaCreationCommand.ts @@ -24,6 +24,20 @@ export interface StartSchemaCreationCommandOutput extends StartSchemaCreationRes *

Adds a new schema to your GraphQL API.

*

This operation is asynchronous. Use to * determine when it has completed.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { AppSyncClient, StartSchemaCreationCommand } from "@aws-sdk/client-appsync"; // ES Modules import + * // const { AppSyncClient, StartSchemaCreationCommand } = require("@aws-sdk/client-appsync"); // CommonJS import + * const client = new AppSyncClient(config); + * const command = new StartSchemaCreationCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link StartSchemaCreationCommandInput} for command's `input` shape. + * @see {@link StartSchemaCreationCommandOutput} for command's `response` shape. + * @see {@link AppSyncClientResolvedConfig | config} for command's `input` shape. + * */ export class StartSchemaCreationCommand extends $Command< StartSchemaCreationCommandInput, diff --git a/clients/client-appsync/commands/TagResourceCommand.ts b/clients/client-appsync/commands/TagResourceCommand.ts index 782493459b3c..213084dc308c 100644 --- a/clients/client-appsync/commands/TagResourceCommand.ts +++ b/clients/client-appsync/commands/TagResourceCommand.ts @@ -22,6 +22,20 @@ export interface TagResourceCommandOutput extends TagResourceResponse, __Metadat /** *

Tags a resource with user-supplied tags.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { AppSyncClient, TagResourceCommand } from "@aws-sdk/client-appsync"; // ES Modules import + * // const { AppSyncClient, TagResourceCommand } = require("@aws-sdk/client-appsync"); // CommonJS import + * const client = new AppSyncClient(config); + * const command = new TagResourceCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link TagResourceCommandInput} for command's `input` shape. + * @see {@link TagResourceCommandOutput} for command's `response` shape. + * @see {@link AppSyncClientResolvedConfig | config} for command's `input` shape. + * */ export class TagResourceCommand extends $Command< TagResourceCommandInput, diff --git a/clients/client-appsync/commands/UntagResourceCommand.ts b/clients/client-appsync/commands/UntagResourceCommand.ts index 923e9a25c72b..ea3c384c0e7d 100644 --- a/clients/client-appsync/commands/UntagResourceCommand.ts +++ b/clients/client-appsync/commands/UntagResourceCommand.ts @@ -22,6 +22,20 @@ export interface UntagResourceCommandOutput extends UntagResourceResponse, __Met /** *

Untags a resource.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { AppSyncClient, UntagResourceCommand } from "@aws-sdk/client-appsync"; // ES Modules import + * // const { AppSyncClient, UntagResourceCommand } = require("@aws-sdk/client-appsync"); // CommonJS import + * const client = new AppSyncClient(config); + * const command = new UntagResourceCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link UntagResourceCommandInput} for command's `input` shape. + * @see {@link UntagResourceCommandOutput} for command's `response` shape. + * @see {@link AppSyncClientResolvedConfig | config} for command's `input` shape. + * */ export class UntagResourceCommand extends $Command< UntagResourceCommandInput, diff --git a/clients/client-appsync/commands/UpdateApiCacheCommand.ts b/clients/client-appsync/commands/UpdateApiCacheCommand.ts index dcf6085ff8d3..1db8b9c48d1a 100644 --- a/clients/client-appsync/commands/UpdateApiCacheCommand.ts +++ b/clients/client-appsync/commands/UpdateApiCacheCommand.ts @@ -22,6 +22,20 @@ export interface UpdateApiCacheCommandOutput extends UpdateApiCacheResponse, __M /** *

Updates the cache for the GraphQL API.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { AppSyncClient, UpdateApiCacheCommand } from "@aws-sdk/client-appsync"; // ES Modules import + * // const { AppSyncClient, UpdateApiCacheCommand } = require("@aws-sdk/client-appsync"); // CommonJS import + * const client = new AppSyncClient(config); + * const command = new UpdateApiCacheCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link UpdateApiCacheCommandInput} for command's `input` shape. + * @see {@link UpdateApiCacheCommandOutput} for command's `response` shape. + * @see {@link AppSyncClientResolvedConfig | config} for command's `input` shape. + * */ export class UpdateApiCacheCommand extends $Command< UpdateApiCacheCommandInput, diff --git a/clients/client-appsync/commands/UpdateApiKeyCommand.ts b/clients/client-appsync/commands/UpdateApiKeyCommand.ts index dc061d773139..eb94e80ebe85 100644 --- a/clients/client-appsync/commands/UpdateApiKeyCommand.ts +++ b/clients/client-appsync/commands/UpdateApiKeyCommand.ts @@ -22,6 +22,20 @@ export interface UpdateApiKeyCommandOutput extends UpdateApiKeyResponse, __Metad /** *

Updates an API key. The key can be updated while it is not deleted.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { AppSyncClient, UpdateApiKeyCommand } from "@aws-sdk/client-appsync"; // ES Modules import + * // const { AppSyncClient, UpdateApiKeyCommand } = require("@aws-sdk/client-appsync"); // CommonJS import + * const client = new AppSyncClient(config); + * const command = new UpdateApiKeyCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link UpdateApiKeyCommandInput} for command's `input` shape. + * @see {@link UpdateApiKeyCommandOutput} for command's `response` shape. + * @see {@link AppSyncClientResolvedConfig | config} for command's `input` shape. + * */ export class UpdateApiKeyCommand extends $Command< UpdateApiKeyCommandInput, diff --git a/clients/client-appsync/commands/UpdateDataSourceCommand.ts b/clients/client-appsync/commands/UpdateDataSourceCommand.ts index 5ef29b8e457e..a7b6d57164ce 100644 --- a/clients/client-appsync/commands/UpdateDataSourceCommand.ts +++ b/clients/client-appsync/commands/UpdateDataSourceCommand.ts @@ -22,6 +22,20 @@ export interface UpdateDataSourceCommandOutput extends UpdateDataSourceResponse, /** *

Updates a DataSource object.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { AppSyncClient, UpdateDataSourceCommand } from "@aws-sdk/client-appsync"; // ES Modules import + * // const { AppSyncClient, UpdateDataSourceCommand } = require("@aws-sdk/client-appsync"); // CommonJS import + * const client = new AppSyncClient(config); + * const command = new UpdateDataSourceCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link UpdateDataSourceCommandInput} for command's `input` shape. + * @see {@link UpdateDataSourceCommandOutput} for command's `response` shape. + * @see {@link AppSyncClientResolvedConfig | config} for command's `input` shape. + * */ export class UpdateDataSourceCommand extends $Command< UpdateDataSourceCommandInput, diff --git a/clients/client-appsync/commands/UpdateFunctionCommand.ts b/clients/client-appsync/commands/UpdateFunctionCommand.ts index 124618c10d5c..771207c8cf94 100644 --- a/clients/client-appsync/commands/UpdateFunctionCommand.ts +++ b/clients/client-appsync/commands/UpdateFunctionCommand.ts @@ -22,6 +22,20 @@ export interface UpdateFunctionCommandOutput extends UpdateFunctionResponse, __M /** *

Updates a Function object.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { AppSyncClient, UpdateFunctionCommand } from "@aws-sdk/client-appsync"; // ES Modules import + * // const { AppSyncClient, UpdateFunctionCommand } = require("@aws-sdk/client-appsync"); // CommonJS import + * const client = new AppSyncClient(config); + * const command = new UpdateFunctionCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link UpdateFunctionCommandInput} for command's `input` shape. + * @see {@link UpdateFunctionCommandOutput} for command's `response` shape. + * @see {@link AppSyncClientResolvedConfig | config} for command's `input` shape. + * */ export class UpdateFunctionCommand extends $Command< UpdateFunctionCommandInput, diff --git a/clients/client-appsync/commands/UpdateGraphqlApiCommand.ts b/clients/client-appsync/commands/UpdateGraphqlApiCommand.ts index de733a3996d2..fb26ce4b84e6 100644 --- a/clients/client-appsync/commands/UpdateGraphqlApiCommand.ts +++ b/clients/client-appsync/commands/UpdateGraphqlApiCommand.ts @@ -22,6 +22,20 @@ export interface UpdateGraphqlApiCommandOutput extends UpdateGraphqlApiResponse, /** *

Updates a GraphqlApi object.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { AppSyncClient, UpdateGraphqlApiCommand } from "@aws-sdk/client-appsync"; // ES Modules import + * // const { AppSyncClient, UpdateGraphqlApiCommand } = require("@aws-sdk/client-appsync"); // CommonJS import + * const client = new AppSyncClient(config); + * const command = new UpdateGraphqlApiCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link UpdateGraphqlApiCommandInput} for command's `input` shape. + * @see {@link UpdateGraphqlApiCommandOutput} for command's `response` shape. + * @see {@link AppSyncClientResolvedConfig | config} for command's `input` shape. + * */ export class UpdateGraphqlApiCommand extends $Command< UpdateGraphqlApiCommandInput, diff --git a/clients/client-appsync/commands/UpdateResolverCommand.ts b/clients/client-appsync/commands/UpdateResolverCommand.ts index 3ea2197883e2..6199bfdb100a 100644 --- a/clients/client-appsync/commands/UpdateResolverCommand.ts +++ b/clients/client-appsync/commands/UpdateResolverCommand.ts @@ -22,6 +22,20 @@ export interface UpdateResolverCommandOutput extends UpdateResolverResponse, __M /** *

Updates a Resolver object.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { AppSyncClient, UpdateResolverCommand } from "@aws-sdk/client-appsync"; // ES Modules import + * // const { AppSyncClient, UpdateResolverCommand } = require("@aws-sdk/client-appsync"); // CommonJS import + * const client = new AppSyncClient(config); + * const command = new UpdateResolverCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link UpdateResolverCommandInput} for command's `input` shape. + * @see {@link UpdateResolverCommandOutput} for command's `response` shape. + * @see {@link AppSyncClientResolvedConfig | config} for command's `input` shape. + * */ export class UpdateResolverCommand extends $Command< UpdateResolverCommandInput, diff --git a/clients/client-appsync/commands/UpdateTypeCommand.ts b/clients/client-appsync/commands/UpdateTypeCommand.ts index 630f582dfd1c..52e5e42d1379 100644 --- a/clients/client-appsync/commands/UpdateTypeCommand.ts +++ b/clients/client-appsync/commands/UpdateTypeCommand.ts @@ -22,6 +22,20 @@ export interface UpdateTypeCommandOutput extends UpdateTypeResponse, __MetadataB /** *

Updates a Type object.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { AppSyncClient, UpdateTypeCommand } from "@aws-sdk/client-appsync"; // ES Modules import + * // const { AppSyncClient, UpdateTypeCommand } = require("@aws-sdk/client-appsync"); // CommonJS import + * const client = new AppSyncClient(config); + * const command = new UpdateTypeCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link UpdateTypeCommandInput} for command's `input` shape. + * @see {@link UpdateTypeCommandOutput} for command's `response` shape. + * @see {@link AppSyncClientResolvedConfig | config} for command's `input` shape. + * */ export class UpdateTypeCommand extends $Command< UpdateTypeCommandInput, diff --git a/clients/client-appsync/models/models_0.ts b/clients/client-appsync/models/models_0.ts index d8811abf33e9..d9530f030710 100644 --- a/clients/client-appsync/models/models_0.ts +++ b/clients/client-appsync/models/models_0.ts @@ -11,6 +11,9 @@ export interface AccessDeniedException extends __SmithyException, $MetadataBeare } export namespace AccessDeniedException { + /** + * @internal + */ export const filterSensitiveLog = (obj: AccessDeniedException): any => ({ ...obj, }); @@ -53,6 +56,9 @@ export interface OpenIDConnectConfig { } export namespace OpenIDConnectConfig { + /** + * @internal + */ export const filterSensitiveLog = (obj: OpenIDConnectConfig): any => ({ ...obj, }); @@ -80,6 +86,9 @@ export interface CognitoUserPoolConfig { } export namespace CognitoUserPoolConfig { + /** + * @internal + */ export const filterSensitiveLog = (obj: CognitoUserPoolConfig): any => ({ ...obj, }); @@ -106,6 +115,9 @@ export interface AdditionalAuthenticationProvider { } export namespace AdditionalAuthenticationProvider { + /** + * @internal + */ export const filterSensitiveLog = (obj: AdditionalAuthenticationProvider): any => ({ ...obj, }); @@ -292,6 +304,9 @@ export interface ApiCache { } export namespace ApiCache { + /** + * @internal + */ export const filterSensitiveLog = (obj: ApiCache): any => ({ ...obj, }); @@ -392,6 +407,9 @@ export interface ApiKey { } export namespace ApiKey { + /** + * @internal + */ export const filterSensitiveLog = (obj: ApiKey): any => ({ ...obj, }); @@ -407,6 +425,9 @@ export interface ApiKeyLimitExceededException extends __SmithyException, $Metada } export namespace ApiKeyLimitExceededException { + /** + * @internal + */ export const filterSensitiveLog = (obj: ApiKeyLimitExceededException): any => ({ ...obj, }); @@ -423,6 +444,9 @@ export interface ApiKeyValidityOutOfBoundsException extends __SmithyException, $ } export namespace ApiKeyValidityOutOfBoundsException { + /** + * @internal + */ export const filterSensitiveLog = (obj: ApiKeyValidityOutOfBoundsException): any => ({ ...obj, }); @@ -438,6 +462,9 @@ export interface ApiLimitExceededException extends __SmithyException, $MetadataB } export namespace ApiLimitExceededException { + /** + * @internal + */ export const filterSensitiveLog = (obj: ApiLimitExceededException): any => ({ ...obj, }); @@ -463,6 +490,9 @@ export interface AwsIamConfig { } export namespace AwsIamConfig { + /** + * @internal + */ export const filterSensitiveLog = (obj: AwsIamConfig): any => ({ ...obj, }); @@ -491,6 +521,9 @@ export interface AuthorizationConfig { } export namespace AuthorizationConfig { + /** + * @internal + */ export const filterSensitiveLog = (obj: AuthorizationConfig): any => ({ ...obj, }); @@ -507,6 +540,9 @@ export interface BadRequestException extends __SmithyException, $MetadataBearer } export namespace BadRequestException { + /** + * @internal + */ export const filterSensitiveLog = (obj: BadRequestException): any => ({ ...obj, }); @@ -523,6 +559,9 @@ export interface ConcurrentModificationException extends __SmithyException, $Met } export namespace ConcurrentModificationException { + /** + * @internal + */ export const filterSensitiveLog = (obj: ConcurrentModificationException): any => ({ ...obj, }); @@ -651,6 +690,9 @@ export interface CreateApiCacheRequest { } export namespace CreateApiCacheRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateApiCacheRequest): any => ({ ...obj, }); @@ -667,6 +709,9 @@ export interface CreateApiCacheResponse { } export namespace CreateApiCacheResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateApiCacheResponse): any => ({ ...obj, }); @@ -682,6 +727,9 @@ export interface InternalFailureException extends __SmithyException, $MetadataBe } export namespace InternalFailureException { + /** + * @internal + */ export const filterSensitiveLog = (obj: InternalFailureException): any => ({ ...obj, }); @@ -698,6 +746,9 @@ export interface NotFoundException extends __SmithyException, $MetadataBearer { } export namespace NotFoundException { + /** + * @internal + */ export const filterSensitiveLog = (obj: NotFoundException): any => ({ ...obj, }); @@ -713,6 +764,9 @@ export interface UnauthorizedException extends __SmithyException, $MetadataBeare } export namespace UnauthorizedException { + /** + * @internal + */ export const filterSensitiveLog = (obj: UnauthorizedException): any => ({ ...obj, }); @@ -738,6 +792,9 @@ export interface CreateApiKeyRequest { } export namespace CreateApiKeyRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateApiKeyRequest): any => ({ ...obj, }); @@ -751,6 +808,9 @@ export interface CreateApiKeyResponse { } export namespace CreateApiKeyResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateApiKeyResponse): any => ({ ...obj, }); @@ -766,6 +826,9 @@ export interface LimitExceededException extends __SmithyException, $MetadataBear } export namespace LimitExceededException { + /** + * @internal + */ export const filterSensitiveLog = (obj: LimitExceededException): any => ({ ...obj, }); @@ -792,6 +855,9 @@ export interface DeltaSyncConfig { } export namespace DeltaSyncConfig { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeltaSyncConfig): any => ({ ...obj, }); @@ -828,6 +894,9 @@ export interface DynamodbDataSourceConfig { } export namespace DynamodbDataSourceConfig { + /** + * @internal + */ export const filterSensitiveLog = (obj: DynamodbDataSourceConfig): any => ({ ...obj, }); @@ -849,6 +918,9 @@ export interface ElasticsearchDataSourceConfig { } export namespace ElasticsearchDataSourceConfig { + /** + * @internal + */ export const filterSensitiveLog = (obj: ElasticsearchDataSourceConfig): any => ({ ...obj, }); @@ -873,6 +945,9 @@ export interface HttpDataSourceConfig { } export namespace HttpDataSourceConfig { + /** + * @internal + */ export const filterSensitiveLog = (obj: HttpDataSourceConfig): any => ({ ...obj, }); @@ -889,6 +964,9 @@ export interface LambdaDataSourceConfig { } export namespace LambdaDataSourceConfig { + /** + * @internal + */ export const filterSensitiveLog = (obj: LambdaDataSourceConfig): any => ({ ...obj, }); @@ -925,6 +1003,9 @@ export interface RdsHttpEndpointConfig { } export namespace RdsHttpEndpointConfig { + /** + * @internal + */ export const filterSensitiveLog = (obj: RdsHttpEndpointConfig): any => ({ ...obj, }); @@ -957,6 +1038,9 @@ export interface RelationalDatabaseDataSourceConfig { } export namespace RelationalDatabaseDataSourceConfig { + /** + * @internal + */ export const filterSensitiveLog = (obj: RelationalDatabaseDataSourceConfig): any => ({ ...obj, }); @@ -1025,6 +1109,9 @@ export interface CreateDataSourceRequest { } export namespace CreateDataSourceRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateDataSourceRequest): any => ({ ...obj, }); @@ -1121,6 +1208,9 @@ export interface DataSource { } export namespace DataSource { + /** + * @internal + */ export const filterSensitiveLog = (obj: DataSource): any => ({ ...obj, }); @@ -1134,6 +1224,9 @@ export interface CreateDataSourceResponse { } export namespace CreateDataSourceResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateDataSourceResponse): any => ({ ...obj, }); @@ -1163,6 +1256,9 @@ export interface LambdaConflictHandlerConfig { } export namespace LambdaConflictHandlerConfig { + /** + * @internal + */ export const filterSensitiveLog = (obj: LambdaConflictHandlerConfig): any => ({ ...obj, }); @@ -1222,6 +1318,9 @@ export interface SyncConfig { } export namespace SyncConfig { + /** + * @internal + */ export const filterSensitiveLog = (obj: SyncConfig): any => ({ ...obj, }); @@ -1275,6 +1374,9 @@ export interface CreateFunctionRequest { } export namespace CreateFunctionRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateFunctionRequest): any => ({ ...obj, }); @@ -1336,6 +1438,9 @@ export interface FunctionConfiguration { } export namespace FunctionConfiguration { + /** + * @internal + */ export const filterSensitiveLog = (obj: FunctionConfiguration): any => ({ ...obj, }); @@ -1349,6 +1454,9 @@ export interface CreateFunctionResponse { } export namespace CreateFunctionResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateFunctionResponse): any => ({ ...obj, }); @@ -1421,6 +1529,9 @@ export interface LogConfig { } export namespace LogConfig { + /** + * @internal + */ export const filterSensitiveLog = (obj: LogConfig): any => ({ ...obj, }); @@ -1460,6 +1571,9 @@ export interface UserPoolConfig { } export namespace UserPoolConfig { + /** + * @internal + */ export const filterSensitiveLog = (obj: UserPoolConfig): any => ({ ...obj, }); @@ -1510,6 +1624,9 @@ export interface CreateGraphqlApiRequest { } export namespace CreateGraphqlApiRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateGraphqlApiRequest): any => ({ ...obj, }); @@ -1584,6 +1701,9 @@ export interface GraphqlApi { } export namespace GraphqlApi { + /** + * @internal + */ export const filterSensitiveLog = (obj: GraphqlApi): any => ({ ...obj, }); @@ -1597,6 +1717,9 @@ export interface CreateGraphqlApiResponse { } export namespace CreateGraphqlApiResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateGraphqlApiResponse): any => ({ ...obj, }); @@ -1621,6 +1744,9 @@ export interface CachingConfig { } export namespace CachingConfig { + /** + * @internal + */ export const filterSensitiveLog = (obj: CachingConfig): any => ({ ...obj, }); @@ -1642,6 +1768,9 @@ export interface PipelineConfig { } export namespace PipelineConfig { + /** + * @internal + */ export const filterSensitiveLog = (obj: PipelineConfig): any => ({ ...obj, }); @@ -1720,6 +1849,9 @@ export interface CreateResolverRequest { } export namespace CreateResolverRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateResolverRequest): any => ({ ...obj, }); @@ -1796,6 +1928,9 @@ export interface Resolver { } export namespace Resolver { + /** + * @internal + */ export const filterSensitiveLog = (obj: Resolver): any => ({ ...obj, }); @@ -1809,6 +1944,9 @@ export interface CreateResolverResponse { } export namespace CreateResolverResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateResolverResponse): any => ({ ...obj, }); @@ -1839,6 +1977,9 @@ export interface CreateTypeRequest { } export namespace CreateTypeRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateTypeRequest): any => ({ ...obj, }); @@ -1875,6 +2016,9 @@ export interface Type { } export namespace Type { + /** + * @internal + */ export const filterSensitiveLog = (obj: Type): any => ({ ...obj, }); @@ -1888,6 +2032,9 @@ export interface CreateTypeResponse { } export namespace CreateTypeResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateTypeResponse): any => ({ ...obj, }); @@ -1904,6 +2051,9 @@ export interface DeleteApiCacheRequest { } export namespace DeleteApiCacheRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteApiCacheRequest): any => ({ ...obj, }); @@ -1915,6 +2065,9 @@ export namespace DeleteApiCacheRequest { export interface DeleteApiCacheResponse {} export namespace DeleteApiCacheResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteApiCacheResponse): any => ({ ...obj, }); @@ -1933,6 +2086,9 @@ export interface DeleteApiKeyRequest { } export namespace DeleteApiKeyRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteApiKeyRequest): any => ({ ...obj, }); @@ -1941,6 +2097,9 @@ export namespace DeleteApiKeyRequest { export interface DeleteApiKeyResponse {} export namespace DeleteApiKeyResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteApiKeyResponse): any => ({ ...obj, }); @@ -1959,6 +2118,9 @@ export interface DeleteDataSourceRequest { } export namespace DeleteDataSourceRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteDataSourceRequest): any => ({ ...obj, }); @@ -1967,6 +2129,9 @@ export namespace DeleteDataSourceRequest { export interface DeleteDataSourceResponse {} export namespace DeleteDataSourceResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteDataSourceResponse): any => ({ ...obj, }); @@ -1985,6 +2150,9 @@ export interface DeleteFunctionRequest { } export namespace DeleteFunctionRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteFunctionRequest): any => ({ ...obj, }); @@ -1993,6 +2161,9 @@ export namespace DeleteFunctionRequest { export interface DeleteFunctionResponse {} export namespace DeleteFunctionResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteFunctionResponse): any => ({ ...obj, }); @@ -2006,6 +2177,9 @@ export interface DeleteGraphqlApiRequest { } export namespace DeleteGraphqlApiRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteGraphqlApiRequest): any => ({ ...obj, }); @@ -2014,6 +2188,9 @@ export namespace DeleteGraphqlApiRequest { export interface DeleteGraphqlApiResponse {} export namespace DeleteGraphqlApiResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteGraphqlApiResponse): any => ({ ...obj, }); @@ -2037,6 +2214,9 @@ export interface DeleteResolverRequest { } export namespace DeleteResolverRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteResolverRequest): any => ({ ...obj, }); @@ -2045,6 +2225,9 @@ export namespace DeleteResolverRequest { export interface DeleteResolverResponse {} export namespace DeleteResolverResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteResolverResponse): any => ({ ...obj, }); @@ -2063,6 +2246,9 @@ export interface DeleteTypeRequest { } export namespace DeleteTypeRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteTypeRequest): any => ({ ...obj, }); @@ -2071,6 +2257,9 @@ export namespace DeleteTypeRequest { export interface DeleteTypeResponse {} export namespace DeleteTypeResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteTypeResponse): any => ({ ...obj, }); @@ -2087,6 +2276,9 @@ export interface FlushApiCacheRequest { } export namespace FlushApiCacheRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: FlushApiCacheRequest): any => ({ ...obj, }); @@ -2098,6 +2290,9 @@ export namespace FlushApiCacheRequest { export interface FlushApiCacheResponse {} export namespace FlushApiCacheResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: FlushApiCacheResponse): any => ({ ...obj, }); @@ -2114,6 +2309,9 @@ export interface GetApiCacheRequest { } export namespace GetApiCacheRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetApiCacheRequest): any => ({ ...obj, }); @@ -2130,6 +2328,9 @@ export interface GetApiCacheResponse { } export namespace GetApiCacheResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetApiCacheResponse): any => ({ ...obj, }); @@ -2148,6 +2349,9 @@ export interface GetDataSourceRequest { } export namespace GetDataSourceRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetDataSourceRequest): any => ({ ...obj, }); @@ -2161,6 +2365,9 @@ export interface GetDataSourceResponse { } export namespace GetDataSourceResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetDataSourceResponse): any => ({ ...obj, }); @@ -2179,6 +2386,9 @@ export interface GetFunctionRequest { } export namespace GetFunctionRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetFunctionRequest): any => ({ ...obj, }); @@ -2192,6 +2402,9 @@ export interface GetFunctionResponse { } export namespace GetFunctionResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetFunctionResponse): any => ({ ...obj, }); @@ -2205,6 +2418,9 @@ export interface GetGraphqlApiRequest { } export namespace GetGraphqlApiRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetGraphqlApiRequest): any => ({ ...obj, }); @@ -2218,6 +2434,9 @@ export interface GetGraphqlApiResponse { } export namespace GetGraphqlApiResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetGraphqlApiResponse): any => ({ ...obj, }); @@ -2246,6 +2465,9 @@ export interface GetIntrospectionSchemaRequest { } export namespace GetIntrospectionSchemaRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetIntrospectionSchemaRequest): any => ({ ...obj, }); @@ -2261,6 +2483,9 @@ export interface GetIntrospectionSchemaResponse { } export namespace GetIntrospectionSchemaResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetIntrospectionSchemaResponse): any => ({ ...obj, }); @@ -2276,6 +2501,9 @@ export interface GraphQLSchemaException extends __SmithyException, $MetadataBear } export namespace GraphQLSchemaException { + /** + * @internal + */ export const filterSensitiveLog = (obj: GraphQLSchemaException): any => ({ ...obj, }); @@ -2299,6 +2527,9 @@ export interface GetResolverRequest { } export namespace GetResolverRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetResolverRequest): any => ({ ...obj, }); @@ -2312,6 +2543,9 @@ export interface GetResolverResponse { } export namespace GetResolverResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetResolverResponse): any => ({ ...obj, }); @@ -2325,6 +2559,9 @@ export interface GetSchemaCreationStatusRequest { } export namespace GetSchemaCreationStatusRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetSchemaCreationStatusRequest): any => ({ ...obj, }); @@ -2353,6 +2590,9 @@ export interface GetSchemaCreationStatusResponse { } export namespace GetSchemaCreationStatusResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetSchemaCreationStatusResponse): any => ({ ...obj, }); @@ -2376,6 +2616,9 @@ export interface GetTypeRequest { } export namespace GetTypeRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetTypeRequest): any => ({ ...obj, }); @@ -2389,6 +2632,9 @@ export interface GetTypeResponse { } export namespace GetTypeResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetTypeResponse): any => ({ ...obj, }); @@ -2413,6 +2659,9 @@ export interface ListApiKeysRequest { } export namespace ListApiKeysRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListApiKeysRequest): any => ({ ...obj, }); @@ -2432,6 +2681,9 @@ export interface ListApiKeysResponse { } export namespace ListApiKeysResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListApiKeysResponse): any => ({ ...obj, }); @@ -2456,6 +2708,9 @@ export interface ListDataSourcesRequest { } export namespace ListDataSourcesRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListDataSourcesRequest): any => ({ ...obj, }); @@ -2475,6 +2730,9 @@ export interface ListDataSourcesResponse { } export namespace ListDataSourcesResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListDataSourcesResponse): any => ({ ...obj, }); @@ -2499,6 +2757,9 @@ export interface ListFunctionsRequest { } export namespace ListFunctionsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListFunctionsRequest): any => ({ ...obj, }); @@ -2518,6 +2779,9 @@ export interface ListFunctionsResponse { } export namespace ListFunctionsResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListFunctionsResponse): any => ({ ...obj, }); @@ -2537,6 +2801,9 @@ export interface ListGraphqlApisRequest { } export namespace ListGraphqlApisRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListGraphqlApisRequest): any => ({ ...obj, }); @@ -2556,6 +2823,9 @@ export interface ListGraphqlApisResponse { } export namespace ListGraphqlApisResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListGraphqlApisResponse): any => ({ ...obj, }); @@ -2585,6 +2855,9 @@ export interface ListResolversRequest { } export namespace ListResolversRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListResolversRequest): any => ({ ...obj, }); @@ -2604,6 +2877,9 @@ export interface ListResolversResponse { } export namespace ListResolversResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListResolversResponse): any => ({ ...obj, }); @@ -2633,6 +2909,9 @@ export interface ListResolversByFunctionRequest { } export namespace ListResolversByFunctionRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListResolversByFunctionRequest): any => ({ ...obj, }); @@ -2651,6 +2930,9 @@ export interface ListResolversByFunctionResponse { } export namespace ListResolversByFunctionResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListResolversByFunctionResponse): any => ({ ...obj, }); @@ -2664,6 +2946,9 @@ export interface ListTagsForResourceRequest { } export namespace ListTagsForResourceRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListTagsForResourceRequest): any => ({ ...obj, }); @@ -2677,6 +2962,9 @@ export interface ListTagsForResourceResponse { } export namespace ListTagsForResourceResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListTagsForResourceResponse): any => ({ ...obj, }); @@ -2706,6 +2994,9 @@ export interface ListTypesRequest { } export namespace ListTypesRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListTypesRequest): any => ({ ...obj, }); @@ -2725,6 +3016,9 @@ export interface ListTypesResponse { } export namespace ListTypesResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListTypesResponse): any => ({ ...obj, }); @@ -2743,6 +3037,9 @@ export interface StartSchemaCreationRequest { } export namespace StartSchemaCreationRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: StartSchemaCreationRequest): any => ({ ...obj, }); @@ -2757,6 +3054,9 @@ export interface StartSchemaCreationResponse { } export namespace StartSchemaCreationResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: StartSchemaCreationResponse): any => ({ ...obj, }); @@ -2775,6 +3075,9 @@ export interface TagResourceRequest { } export namespace TagResourceRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: TagResourceRequest): any => ({ ...obj, }); @@ -2783,6 +3086,9 @@ export namespace TagResourceRequest { export interface TagResourceResponse {} export namespace TagResourceResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: TagResourceResponse): any => ({ ...obj, }); @@ -2801,6 +3107,9 @@ export interface UntagResourceRequest { } export namespace UntagResourceRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: UntagResourceRequest): any => ({ ...obj, }); @@ -2809,6 +3118,9 @@ export namespace UntagResourceRequest { export interface UntagResourceResponse {} export namespace UntagResourceResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: UntagResourceResponse): any => ({ ...obj, }); @@ -2926,6 +3238,9 @@ export interface UpdateApiCacheRequest { } export namespace UpdateApiCacheRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateApiCacheRequest): any => ({ ...obj, }); @@ -2942,6 +3257,9 @@ export interface UpdateApiCacheResponse { } export namespace UpdateApiCacheResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateApiCacheResponse): any => ({ ...obj, }); @@ -2971,6 +3289,9 @@ export interface UpdateApiKeyRequest { } export namespace UpdateApiKeyRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateApiKeyRequest): any => ({ ...obj, }); @@ -2984,6 +3305,9 @@ export interface UpdateApiKeyResponse { } export namespace UpdateApiKeyResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateApiKeyResponse): any => ({ ...obj, }); @@ -3042,6 +3366,9 @@ export interface UpdateDataSourceRequest { } export namespace UpdateDataSourceRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateDataSourceRequest): any => ({ ...obj, }); @@ -3055,6 +3382,9 @@ export interface UpdateDataSourceResponse { } export namespace UpdateDataSourceResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateDataSourceResponse): any => ({ ...obj, }); @@ -3113,6 +3443,9 @@ export interface UpdateFunctionRequest { } export namespace UpdateFunctionRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateFunctionRequest): any => ({ ...obj, }); @@ -3126,6 +3459,9 @@ export interface UpdateFunctionResponse { } export namespace UpdateFunctionResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateFunctionResponse): any => ({ ...obj, }); @@ -3177,6 +3513,9 @@ export interface UpdateGraphqlApiRequest { } export namespace UpdateGraphqlApiRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateGraphqlApiRequest): any => ({ ...obj, }); @@ -3190,6 +3529,9 @@ export interface UpdateGraphqlApiResponse { } export namespace UpdateGraphqlApiResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateGraphqlApiResponse): any => ({ ...obj, }); @@ -3268,6 +3610,9 @@ export interface UpdateResolverRequest { } export namespace UpdateResolverRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateResolverRequest): any => ({ ...obj, }); @@ -3281,6 +3626,9 @@ export interface UpdateResolverResponse { } export namespace UpdateResolverResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateResolverResponse): any => ({ ...obj, }); @@ -3309,6 +3657,9 @@ export interface UpdateTypeRequest { } export namespace UpdateTypeRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateTypeRequest): any => ({ ...obj, }); @@ -3322,6 +3673,9 @@ export interface UpdateTypeResponse { } export namespace UpdateTypeResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateTypeResponse): any => ({ ...obj, }); diff --git a/clients/client-athena/commands/BatchGetNamedQueryCommand.ts b/clients/client-athena/commands/BatchGetNamedQueryCommand.ts index c06a30d51cdf..210a160433d9 100644 --- a/clients/client-athena/commands/BatchGetNamedQueryCommand.ts +++ b/clients/client-athena/commands/BatchGetNamedQueryCommand.ts @@ -30,6 +30,20 @@ export interface BatchGetNamedQueryCommandOutput extends BatchGetNamedQueryOutpu * queries. Use BatchGetQueryExecutionInput to get details about each * unique query execution, and ListQueryExecutionsInput to get a list of * query execution IDs.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { AthenaClient, BatchGetNamedQueryCommand } from "@aws-sdk/client-athena"; // ES Modules import + * // const { AthenaClient, BatchGetNamedQueryCommand } = require("@aws-sdk/client-athena"); // CommonJS import + * const client = new AthenaClient(config); + * const command = new BatchGetNamedQueryCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link BatchGetNamedQueryCommandInput} for command's `input` shape. + * @see {@link BatchGetNamedQueryCommandOutput} for command's `response` shape. + * @see {@link AthenaClientResolvedConfig | config} for command's `input` shape. + * */ export class BatchGetNamedQueryCommand extends $Command< BatchGetNamedQueryCommandInput, diff --git a/clients/client-athena/commands/BatchGetQueryExecutionCommand.ts b/clients/client-athena/commands/BatchGetQueryExecutionCommand.ts index 48f06aaa3450..2169eec14d6d 100644 --- a/clients/client-athena/commands/BatchGetQueryExecutionCommand.ts +++ b/clients/client-athena/commands/BatchGetQueryExecutionCommand.ts @@ -27,6 +27,20 @@ export interface BatchGetQueryExecutionCommandOutput extends BatchGetQueryExecut * IDs, use ListQueryExecutionsInput$WorkGroup. Query executions differ * from named (saved) queries. Use BatchGetNamedQueryInput to get details * about named queries.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { AthenaClient, BatchGetQueryExecutionCommand } from "@aws-sdk/client-athena"; // ES Modules import + * // const { AthenaClient, BatchGetQueryExecutionCommand } = require("@aws-sdk/client-athena"); // CommonJS import + * const client = new AthenaClient(config); + * const command = new BatchGetQueryExecutionCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link BatchGetQueryExecutionCommandInput} for command's `input` shape. + * @see {@link BatchGetQueryExecutionCommandOutput} for command's `response` shape. + * @see {@link AthenaClientResolvedConfig | config} for command's `input` shape. + * */ export class BatchGetQueryExecutionCommand extends $Command< BatchGetQueryExecutionCommandInput, diff --git a/clients/client-athena/commands/CreateDataCatalogCommand.ts b/clients/client-athena/commands/CreateDataCatalogCommand.ts index 13804aa8ab17..51c9e2c5bd3e 100644 --- a/clients/client-athena/commands/CreateDataCatalogCommand.ts +++ b/clients/client-athena/commands/CreateDataCatalogCommand.ts @@ -23,6 +23,20 @@ export interface CreateDataCatalogCommandOutput extends CreateDataCatalogOutput, /** *

Creates (registers) a data catalog with the specified name and properties. Catalogs * created are visible to all users of the same AWS account.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { AthenaClient, CreateDataCatalogCommand } from "@aws-sdk/client-athena"; // ES Modules import + * // const { AthenaClient, CreateDataCatalogCommand } = require("@aws-sdk/client-athena"); // CommonJS import + * const client = new AthenaClient(config); + * const command = new CreateDataCatalogCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreateDataCatalogCommandInput} for command's `input` shape. + * @see {@link CreateDataCatalogCommandOutput} for command's `response` shape. + * @see {@link AthenaClientResolvedConfig | config} for command's `input` shape. + * */ export class CreateDataCatalogCommand extends $Command< CreateDataCatalogCommandInput, diff --git a/clients/client-athena/commands/CreateNamedQueryCommand.ts b/clients/client-athena/commands/CreateNamedQueryCommand.ts index 00dcac8431cd..511c3674f4fe 100644 --- a/clients/client-athena/commands/CreateNamedQueryCommand.ts +++ b/clients/client-athena/commands/CreateNamedQueryCommand.ts @@ -25,6 +25,20 @@ export interface CreateNamedQueryCommandOutput extends CreateNamedQueryOutput, _ * workgroup.

*

For code samples using the AWS SDK for Java, see Examples and * Code Samples in the Amazon Athena User Guide.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { AthenaClient, CreateNamedQueryCommand } from "@aws-sdk/client-athena"; // ES Modules import + * // const { AthenaClient, CreateNamedQueryCommand } = require("@aws-sdk/client-athena"); // CommonJS import + * const client = new AthenaClient(config); + * const command = new CreateNamedQueryCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreateNamedQueryCommandInput} for command's `input` shape. + * @see {@link CreateNamedQueryCommandOutput} for command's `response` shape. + * @see {@link AthenaClientResolvedConfig | config} for command's `input` shape. + * */ export class CreateNamedQueryCommand extends $Command< CreateNamedQueryCommandInput, diff --git a/clients/client-athena/commands/CreatePreparedStatementCommand.ts b/clients/client-athena/commands/CreatePreparedStatementCommand.ts index 75916ea6e382..2d8e19f3438a 100644 --- a/clients/client-athena/commands/CreatePreparedStatementCommand.ts +++ b/clients/client-athena/commands/CreatePreparedStatementCommand.ts @@ -22,6 +22,20 @@ export interface CreatePreparedStatementCommandOutput extends CreatePreparedStat /** *

Creates a prepared statement for use with SQL queries in Athena.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { AthenaClient, CreatePreparedStatementCommand } from "@aws-sdk/client-athena"; // ES Modules import + * // const { AthenaClient, CreatePreparedStatementCommand } = require("@aws-sdk/client-athena"); // CommonJS import + * const client = new AthenaClient(config); + * const command = new CreatePreparedStatementCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreatePreparedStatementCommandInput} for command's `input` shape. + * @see {@link CreatePreparedStatementCommandOutput} for command's `response` shape. + * @see {@link AthenaClientResolvedConfig | config} for command's `input` shape. + * */ export class CreatePreparedStatementCommand extends $Command< CreatePreparedStatementCommandInput, diff --git a/clients/client-athena/commands/CreateWorkGroupCommand.ts b/clients/client-athena/commands/CreateWorkGroupCommand.ts index 54ddd3a48b27..243db253e685 100644 --- a/clients/client-athena/commands/CreateWorkGroupCommand.ts +++ b/clients/client-athena/commands/CreateWorkGroupCommand.ts @@ -22,6 +22,20 @@ export interface CreateWorkGroupCommandOutput extends CreateWorkGroupOutput, __M /** *

Creates a workgroup with the specified name.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { AthenaClient, CreateWorkGroupCommand } from "@aws-sdk/client-athena"; // ES Modules import + * // const { AthenaClient, CreateWorkGroupCommand } = require("@aws-sdk/client-athena"); // CommonJS import + * const client = new AthenaClient(config); + * const command = new CreateWorkGroupCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreateWorkGroupCommandInput} for command's `input` shape. + * @see {@link CreateWorkGroupCommandOutput} for command's `response` shape. + * @see {@link AthenaClientResolvedConfig | config} for command's `input` shape. + * */ export class CreateWorkGroupCommand extends $Command< CreateWorkGroupCommandInput, diff --git a/clients/client-athena/commands/DeleteDataCatalogCommand.ts b/clients/client-athena/commands/DeleteDataCatalogCommand.ts index 35f24bf0fdc6..d3a0768b38cb 100644 --- a/clients/client-athena/commands/DeleteDataCatalogCommand.ts +++ b/clients/client-athena/commands/DeleteDataCatalogCommand.ts @@ -22,6 +22,20 @@ export interface DeleteDataCatalogCommandOutput extends DeleteDataCatalogOutput, /** *

Deletes a data catalog.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { AthenaClient, DeleteDataCatalogCommand } from "@aws-sdk/client-athena"; // ES Modules import + * // const { AthenaClient, DeleteDataCatalogCommand } = require("@aws-sdk/client-athena"); // CommonJS import + * const client = new AthenaClient(config); + * const command = new DeleteDataCatalogCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteDataCatalogCommandInput} for command's `input` shape. + * @see {@link DeleteDataCatalogCommandOutput} for command's `response` shape. + * @see {@link AthenaClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteDataCatalogCommand extends $Command< DeleteDataCatalogCommandInput, diff --git a/clients/client-athena/commands/DeleteNamedQueryCommand.ts b/clients/client-athena/commands/DeleteNamedQueryCommand.ts index 2473a64b2b73..37e5880b093d 100644 --- a/clients/client-athena/commands/DeleteNamedQueryCommand.ts +++ b/clients/client-athena/commands/DeleteNamedQueryCommand.ts @@ -25,6 +25,20 @@ export interface DeleteNamedQueryCommandOutput extends DeleteNamedQueryOutput, _ * saved.

*

For code samples using the AWS SDK for Java, see Examples and * Code Samples in the Amazon Athena User Guide.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { AthenaClient, DeleteNamedQueryCommand } from "@aws-sdk/client-athena"; // ES Modules import + * // const { AthenaClient, DeleteNamedQueryCommand } = require("@aws-sdk/client-athena"); // CommonJS import + * const client = new AthenaClient(config); + * const command = new DeleteNamedQueryCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteNamedQueryCommandInput} for command's `input` shape. + * @see {@link DeleteNamedQueryCommandOutput} for command's `response` shape. + * @see {@link AthenaClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteNamedQueryCommand extends $Command< DeleteNamedQueryCommandInput, diff --git a/clients/client-athena/commands/DeletePreparedStatementCommand.ts b/clients/client-athena/commands/DeletePreparedStatementCommand.ts index 7226a1a9281b..10f8bc95344e 100644 --- a/clients/client-athena/commands/DeletePreparedStatementCommand.ts +++ b/clients/client-athena/commands/DeletePreparedStatementCommand.ts @@ -23,6 +23,20 @@ export interface DeletePreparedStatementCommandOutput extends DeletePreparedStat /** *

Deletes the prepared statement with the specified name from the specified * workgroup.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { AthenaClient, DeletePreparedStatementCommand } from "@aws-sdk/client-athena"; // ES Modules import + * // const { AthenaClient, DeletePreparedStatementCommand } = require("@aws-sdk/client-athena"); // CommonJS import + * const client = new AthenaClient(config); + * const command = new DeletePreparedStatementCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeletePreparedStatementCommandInput} for command's `input` shape. + * @see {@link DeletePreparedStatementCommandOutput} for command's `response` shape. + * @see {@link AthenaClientResolvedConfig | config} for command's `input` shape. + * */ export class DeletePreparedStatementCommand extends $Command< DeletePreparedStatementCommandInput, diff --git a/clients/client-athena/commands/DeleteWorkGroupCommand.ts b/clients/client-athena/commands/DeleteWorkGroupCommand.ts index 9ab0d41e5d15..9143805547dc 100644 --- a/clients/client-athena/commands/DeleteWorkGroupCommand.ts +++ b/clients/client-athena/commands/DeleteWorkGroupCommand.ts @@ -23,6 +23,20 @@ export interface DeleteWorkGroupCommandOutput extends DeleteWorkGroupOutput, __M /** *

Deletes the workgroup with the specified name. The primary workgroup cannot be * deleted.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { AthenaClient, DeleteWorkGroupCommand } from "@aws-sdk/client-athena"; // ES Modules import + * // const { AthenaClient, DeleteWorkGroupCommand } = require("@aws-sdk/client-athena"); // CommonJS import + * const client = new AthenaClient(config); + * const command = new DeleteWorkGroupCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteWorkGroupCommandInput} for command's `input` shape. + * @see {@link DeleteWorkGroupCommandOutput} for command's `response` shape. + * @see {@link AthenaClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteWorkGroupCommand extends $Command< DeleteWorkGroupCommandInput, diff --git a/clients/client-athena/commands/GetDataCatalogCommand.ts b/clients/client-athena/commands/GetDataCatalogCommand.ts index d29223a43943..92c8103a3b6f 100644 --- a/clients/client-athena/commands/GetDataCatalogCommand.ts +++ b/clients/client-athena/commands/GetDataCatalogCommand.ts @@ -22,6 +22,20 @@ export interface GetDataCatalogCommandOutput extends GetDataCatalogOutput, __Met /** *

Returns the specified data catalog.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { AthenaClient, GetDataCatalogCommand } from "@aws-sdk/client-athena"; // ES Modules import + * // const { AthenaClient, GetDataCatalogCommand } = require("@aws-sdk/client-athena"); // CommonJS import + * const client = new AthenaClient(config); + * const command = new GetDataCatalogCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetDataCatalogCommandInput} for command's `input` shape. + * @see {@link GetDataCatalogCommandOutput} for command's `response` shape. + * @see {@link AthenaClientResolvedConfig | config} for command's `input` shape. + * */ export class GetDataCatalogCommand extends $Command< GetDataCatalogCommandInput, diff --git a/clients/client-athena/commands/GetDatabaseCommand.ts b/clients/client-athena/commands/GetDatabaseCommand.ts index 1e019e854f24..05b142d8f46b 100644 --- a/clients/client-athena/commands/GetDatabaseCommand.ts +++ b/clients/client-athena/commands/GetDatabaseCommand.ts @@ -22,6 +22,20 @@ export interface GetDatabaseCommandOutput extends GetDatabaseOutput, __MetadataB /** *

Returns a database object for the specified database and data catalog.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { AthenaClient, GetDatabaseCommand } from "@aws-sdk/client-athena"; // ES Modules import + * // const { AthenaClient, GetDatabaseCommand } = require("@aws-sdk/client-athena"); // CommonJS import + * const client = new AthenaClient(config); + * const command = new GetDatabaseCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetDatabaseCommandInput} for command's `input` shape. + * @see {@link GetDatabaseCommandOutput} for command's `response` shape. + * @see {@link AthenaClientResolvedConfig | config} for command's `input` shape. + * */ export class GetDatabaseCommand extends $Command< GetDatabaseCommandInput, diff --git a/clients/client-athena/commands/GetNamedQueryCommand.ts b/clients/client-athena/commands/GetNamedQueryCommand.ts index 0b00e4a4f262..b6c0b1985984 100644 --- a/clients/client-athena/commands/GetNamedQueryCommand.ts +++ b/clients/client-athena/commands/GetNamedQueryCommand.ts @@ -23,6 +23,20 @@ export interface GetNamedQueryCommandOutput extends GetNamedQueryOutput, __Metad /** *

Returns information about a single query. Requires that you have access to the * workgroup in which the query was saved.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { AthenaClient, GetNamedQueryCommand } from "@aws-sdk/client-athena"; // ES Modules import + * // const { AthenaClient, GetNamedQueryCommand } = require("@aws-sdk/client-athena"); // CommonJS import + * const client = new AthenaClient(config); + * const command = new GetNamedQueryCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetNamedQueryCommandInput} for command's `input` shape. + * @see {@link GetNamedQueryCommandOutput} for command's `response` shape. + * @see {@link AthenaClientResolvedConfig | config} for command's `input` shape. + * */ export class GetNamedQueryCommand extends $Command< GetNamedQueryCommandInput, diff --git a/clients/client-athena/commands/GetPreparedStatementCommand.ts b/clients/client-athena/commands/GetPreparedStatementCommand.ts index 168fcd9f4ed4..e628af8930e7 100644 --- a/clients/client-athena/commands/GetPreparedStatementCommand.ts +++ b/clients/client-athena/commands/GetPreparedStatementCommand.ts @@ -23,6 +23,20 @@ export interface GetPreparedStatementCommandOutput extends GetPreparedStatementO /** *

Retrieves the prepared statement with the specified name from the specified * workgroup.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { AthenaClient, GetPreparedStatementCommand } from "@aws-sdk/client-athena"; // ES Modules import + * // const { AthenaClient, GetPreparedStatementCommand } = require("@aws-sdk/client-athena"); // CommonJS import + * const client = new AthenaClient(config); + * const command = new GetPreparedStatementCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetPreparedStatementCommandInput} for command's `input` shape. + * @see {@link GetPreparedStatementCommandOutput} for command's `response` shape. + * @see {@link AthenaClientResolvedConfig | config} for command's `input` shape. + * */ export class GetPreparedStatementCommand extends $Command< GetPreparedStatementCommandInput, diff --git a/clients/client-athena/commands/GetQueryExecutionCommand.ts b/clients/client-athena/commands/GetQueryExecutionCommand.ts index 2a3b6153e1ac..f289ce69e56a 100644 --- a/clients/client-athena/commands/GetQueryExecutionCommand.ts +++ b/clients/client-athena/commands/GetQueryExecutionCommand.ts @@ -24,6 +24,20 @@ export interface GetQueryExecutionCommandOutput extends GetQueryExecutionOutput, *

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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { AthenaClient, GetQueryExecutionCommand } from "@aws-sdk/client-athena"; // ES Modules import + * // const { AthenaClient, GetQueryExecutionCommand } = require("@aws-sdk/client-athena"); // CommonJS import + * const client = new AthenaClient(config); + * const command = new GetQueryExecutionCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetQueryExecutionCommandInput} for command's `input` shape. + * @see {@link GetQueryExecutionCommandOutput} for command's `response` shape. + * @see {@link AthenaClientResolvedConfig | config} for command's `input` shape. + * */ export class GetQueryExecutionCommand extends $Command< GetQueryExecutionCommandInput, diff --git a/clients/client-athena/commands/GetQueryResultsCommand.ts b/clients/client-athena/commands/GetQueryResultsCommand.ts index abbe04cfefe6..47f89e5b408d 100644 --- a/clients/client-athena/commands/GetQueryResultsCommand.ts +++ b/clients/client-athena/commands/GetQueryResultsCommand.ts @@ -36,6 +36,20 @@ export interface GetQueryResultsCommandOutput extends GetQueryResultsOutput, __M * role access, ensure that Amazon S3 permissions to the Athena query location are * denied.

* + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { AthenaClient, GetQueryResultsCommand } from "@aws-sdk/client-athena"; // ES Modules import + * // const { AthenaClient, GetQueryResultsCommand } = require("@aws-sdk/client-athena"); // CommonJS import + * const client = new AthenaClient(config); + * const command = new GetQueryResultsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetQueryResultsCommandInput} for command's `input` shape. + * @see {@link GetQueryResultsCommandOutput} for command's `response` shape. + * @see {@link AthenaClientResolvedConfig | config} for command's `input` shape. + * */ export class GetQueryResultsCommand extends $Command< GetQueryResultsCommandInput, diff --git a/clients/client-athena/commands/GetTableMetadataCommand.ts b/clients/client-athena/commands/GetTableMetadataCommand.ts index 7002e7171654..7c1f3ac41138 100644 --- a/clients/client-athena/commands/GetTableMetadataCommand.ts +++ b/clients/client-athena/commands/GetTableMetadataCommand.ts @@ -22,6 +22,20 @@ export interface GetTableMetadataCommandOutput extends GetTableMetadataOutput, _ /** *

Returns table metadata for the specified catalog, database, and table.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { AthenaClient, GetTableMetadataCommand } from "@aws-sdk/client-athena"; // ES Modules import + * // const { AthenaClient, GetTableMetadataCommand } = require("@aws-sdk/client-athena"); // CommonJS import + * const client = new AthenaClient(config); + * const command = new GetTableMetadataCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetTableMetadataCommandInput} for command's `input` shape. + * @see {@link GetTableMetadataCommandOutput} for command's `response` shape. + * @see {@link AthenaClientResolvedConfig | config} for command's `input` shape. + * */ export class GetTableMetadataCommand extends $Command< GetTableMetadataCommandInput, diff --git a/clients/client-athena/commands/GetWorkGroupCommand.ts b/clients/client-athena/commands/GetWorkGroupCommand.ts index ab062673b7b7..a742b1a3e56c 100644 --- a/clients/client-athena/commands/GetWorkGroupCommand.ts +++ b/clients/client-athena/commands/GetWorkGroupCommand.ts @@ -22,6 +22,20 @@ export interface GetWorkGroupCommandOutput extends GetWorkGroupOutput, __Metadat /** *

Returns information about the workgroup with the specified name.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { AthenaClient, GetWorkGroupCommand } from "@aws-sdk/client-athena"; // ES Modules import + * // const { AthenaClient, GetWorkGroupCommand } = require("@aws-sdk/client-athena"); // CommonJS import + * const client = new AthenaClient(config); + * const command = new GetWorkGroupCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetWorkGroupCommandInput} for command's `input` shape. + * @see {@link GetWorkGroupCommandOutput} for command's `response` shape. + * @see {@link AthenaClientResolvedConfig | config} for command's `input` shape. + * */ export class GetWorkGroupCommand extends $Command< GetWorkGroupCommandInput, diff --git a/clients/client-athena/commands/ListDataCatalogsCommand.ts b/clients/client-athena/commands/ListDataCatalogsCommand.ts index 7d9ec6b7673e..b9da1aa41979 100644 --- a/clients/client-athena/commands/ListDataCatalogsCommand.ts +++ b/clients/client-athena/commands/ListDataCatalogsCommand.ts @@ -22,6 +22,20 @@ export interface ListDataCatalogsCommandOutput extends ListDataCatalogsOutput, _ /** *

Lists the data catalogs in the current AWS account.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { AthenaClient, ListDataCatalogsCommand } from "@aws-sdk/client-athena"; // ES Modules import + * // const { AthenaClient, ListDataCatalogsCommand } = require("@aws-sdk/client-athena"); // CommonJS import + * const client = new AthenaClient(config); + * const command = new ListDataCatalogsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListDataCatalogsCommandInput} for command's `input` shape. + * @see {@link ListDataCatalogsCommandOutput} for command's `response` shape. + * @see {@link AthenaClientResolvedConfig | config} for command's `input` shape. + * */ export class ListDataCatalogsCommand extends $Command< ListDataCatalogsCommandInput, diff --git a/clients/client-athena/commands/ListDatabasesCommand.ts b/clients/client-athena/commands/ListDatabasesCommand.ts index 868efcde936e..a27aa9f2ed11 100644 --- a/clients/client-athena/commands/ListDatabasesCommand.ts +++ b/clients/client-athena/commands/ListDatabasesCommand.ts @@ -22,6 +22,20 @@ export interface ListDatabasesCommandOutput extends ListDatabasesOutput, __Metad /** *

Lists the databases in the specified data catalog.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { AthenaClient, ListDatabasesCommand } from "@aws-sdk/client-athena"; // ES Modules import + * // const { AthenaClient, ListDatabasesCommand } = require("@aws-sdk/client-athena"); // CommonJS import + * const client = new AthenaClient(config); + * const command = new ListDatabasesCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListDatabasesCommandInput} for command's `input` shape. + * @see {@link ListDatabasesCommandOutput} for command's `response` shape. + * @see {@link AthenaClientResolvedConfig | config} for command's `input` shape. + * */ export class ListDatabasesCommand extends $Command< ListDatabasesCommandInput, diff --git a/clients/client-athena/commands/ListEngineVersionsCommand.ts b/clients/client-athena/commands/ListEngineVersionsCommand.ts index 14255900abff..984c57e4efa1 100644 --- a/clients/client-athena/commands/ListEngineVersionsCommand.ts +++ b/clients/client-athena/commands/ListEngineVersionsCommand.ts @@ -23,6 +23,20 @@ export interface ListEngineVersionsCommandOutput extends ListEngineVersionsOutpu /** *

Returns a list of engine versions that are available to choose from, including the * Auto option.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { AthenaClient, ListEngineVersionsCommand } from "@aws-sdk/client-athena"; // ES Modules import + * // const { AthenaClient, ListEngineVersionsCommand } = require("@aws-sdk/client-athena"); // CommonJS import + * const client = new AthenaClient(config); + * const command = new ListEngineVersionsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListEngineVersionsCommandInput} for command's `input` shape. + * @see {@link ListEngineVersionsCommandOutput} for command's `response` shape. + * @see {@link AthenaClientResolvedConfig | config} for command's `input` shape. + * */ export class ListEngineVersionsCommand extends $Command< ListEngineVersionsCommandInput, diff --git a/clients/client-athena/commands/ListNamedQueriesCommand.ts b/clients/client-athena/commands/ListNamedQueriesCommand.ts index b154ec87e66a..c1405d95b2db 100644 --- a/clients/client-athena/commands/ListNamedQueriesCommand.ts +++ b/clients/client-athena/commands/ListNamedQueriesCommand.ts @@ -26,6 +26,20 @@ export interface ListNamedQueriesCommandOutput extends ListNamedQueriesOutput, _ * not specified, lists the saved queries for the primary workgroup.

*

For code samples using the AWS SDK for Java, see Examples and * Code Samples in the Amazon Athena User Guide.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { AthenaClient, ListNamedQueriesCommand } from "@aws-sdk/client-athena"; // ES Modules import + * // const { AthenaClient, ListNamedQueriesCommand } = require("@aws-sdk/client-athena"); // CommonJS import + * const client = new AthenaClient(config); + * const command = new ListNamedQueriesCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListNamedQueriesCommandInput} for command's `input` shape. + * @see {@link ListNamedQueriesCommandOutput} for command's `response` shape. + * @see {@link AthenaClientResolvedConfig | config} for command's `input` shape. + * */ export class ListNamedQueriesCommand extends $Command< ListNamedQueriesCommandInput, diff --git a/clients/client-athena/commands/ListPreparedStatementsCommand.ts b/clients/client-athena/commands/ListPreparedStatementsCommand.ts index 2212cf847ee1..db0db6ccc5f9 100644 --- a/clients/client-athena/commands/ListPreparedStatementsCommand.ts +++ b/clients/client-athena/commands/ListPreparedStatementsCommand.ts @@ -22,6 +22,20 @@ export interface ListPreparedStatementsCommandOutput extends ListPreparedStateme /** *

Lists the prepared statements in the specfied workgroup.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { AthenaClient, ListPreparedStatementsCommand } from "@aws-sdk/client-athena"; // ES Modules import + * // const { AthenaClient, ListPreparedStatementsCommand } = require("@aws-sdk/client-athena"); // CommonJS import + * const client = new AthenaClient(config); + * const command = new ListPreparedStatementsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListPreparedStatementsCommandInput} for command's `input` shape. + * @see {@link ListPreparedStatementsCommandOutput} for command's `response` shape. + * @see {@link AthenaClientResolvedConfig | config} for command's `input` shape. + * */ export class ListPreparedStatementsCommand extends $Command< ListPreparedStatementsCommandInput, diff --git a/clients/client-athena/commands/ListQueryExecutionsCommand.ts b/clients/client-athena/commands/ListQueryExecutionsCommand.ts index 7a851a7328da..6447a8aeab07 100644 --- a/clients/client-athena/commands/ListQueryExecutionsCommand.ts +++ b/clients/client-athena/commands/ListQueryExecutionsCommand.ts @@ -27,6 +27,20 @@ export interface ListQueryExecutionsCommandOutput extends ListQueryExecutionsOut * ran.

*

For code samples using the AWS SDK for Java, see Examples and * Code Samples in the Amazon Athena User Guide.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { AthenaClient, ListQueryExecutionsCommand } from "@aws-sdk/client-athena"; // ES Modules import + * // const { AthenaClient, ListQueryExecutionsCommand } = require("@aws-sdk/client-athena"); // CommonJS import + * const client = new AthenaClient(config); + * const command = new ListQueryExecutionsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListQueryExecutionsCommandInput} for command's `input` shape. + * @see {@link ListQueryExecutionsCommandOutput} for command's `response` shape. + * @see {@link AthenaClientResolvedConfig | config} for command's `input` shape. + * */ export class ListQueryExecutionsCommand extends $Command< ListQueryExecutionsCommandInput, diff --git a/clients/client-athena/commands/ListTableMetadataCommand.ts b/clients/client-athena/commands/ListTableMetadataCommand.ts index c0ee2cd75383..3cae840f6cce 100644 --- a/clients/client-athena/commands/ListTableMetadataCommand.ts +++ b/clients/client-athena/commands/ListTableMetadataCommand.ts @@ -22,6 +22,20 @@ export interface ListTableMetadataCommandOutput extends ListTableMetadataOutput, /** *

Lists the metadata for the tables in the specified data catalog database.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { AthenaClient, ListTableMetadataCommand } from "@aws-sdk/client-athena"; // ES Modules import + * // const { AthenaClient, ListTableMetadataCommand } = require("@aws-sdk/client-athena"); // CommonJS import + * const client = new AthenaClient(config); + * const command = new ListTableMetadataCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListTableMetadataCommandInput} for command's `input` shape. + * @see {@link ListTableMetadataCommandOutput} for command's `response` shape. + * @see {@link AthenaClientResolvedConfig | config} for command's `input` shape. + * */ export class ListTableMetadataCommand extends $Command< ListTableMetadataCommandInput, diff --git a/clients/client-athena/commands/ListTagsForResourceCommand.ts b/clients/client-athena/commands/ListTagsForResourceCommand.ts index a5138837983e..f2e47634ad0d 100644 --- a/clients/client-athena/commands/ListTagsForResourceCommand.ts +++ b/clients/client-athena/commands/ListTagsForResourceCommand.ts @@ -22,6 +22,20 @@ export interface ListTagsForResourceCommandOutput extends ListTagsForResourceOut /** *

Lists the tags associated with an Athena workgroup or data catalog resource.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { AthenaClient, ListTagsForResourceCommand } from "@aws-sdk/client-athena"; // ES Modules import + * // const { AthenaClient, ListTagsForResourceCommand } = require("@aws-sdk/client-athena"); // CommonJS import + * const client = new AthenaClient(config); + * const command = new ListTagsForResourceCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListTagsForResourceCommandInput} for command's `input` shape. + * @see {@link ListTagsForResourceCommandOutput} for command's `response` shape. + * @see {@link AthenaClientResolvedConfig | config} for command's `input` shape. + * */ export class ListTagsForResourceCommand extends $Command< ListTagsForResourceCommandInput, diff --git a/clients/client-athena/commands/ListWorkGroupsCommand.ts b/clients/client-athena/commands/ListWorkGroupsCommand.ts index b0f279e3f0c2..23f2c452baee 100644 --- a/clients/client-athena/commands/ListWorkGroupsCommand.ts +++ b/clients/client-athena/commands/ListWorkGroupsCommand.ts @@ -22,6 +22,20 @@ export interface ListWorkGroupsCommandOutput extends ListWorkGroupsOutput, __Met /** *

Lists available workgroups for the account.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { AthenaClient, ListWorkGroupsCommand } from "@aws-sdk/client-athena"; // ES Modules import + * // const { AthenaClient, ListWorkGroupsCommand } = require("@aws-sdk/client-athena"); // CommonJS import + * const client = new AthenaClient(config); + * const command = new ListWorkGroupsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListWorkGroupsCommandInput} for command's `input` shape. + * @see {@link ListWorkGroupsCommandOutput} for command's `response` shape. + * @see {@link AthenaClientResolvedConfig | config} for command's `input` shape. + * */ export class ListWorkGroupsCommand extends $Command< ListWorkGroupsCommandInput, diff --git a/clients/client-athena/commands/StartQueryExecutionCommand.ts b/clients/client-athena/commands/StartQueryExecutionCommand.ts index 43ba3b933b82..f51cf5a8ad3e 100644 --- a/clients/client-athena/commands/StartQueryExecutionCommand.ts +++ b/clients/client-athena/commands/StartQueryExecutionCommand.ts @@ -26,6 +26,20 @@ export interface StartQueryExecutionCommandOutput extends StartQueryExecutionOut * catalog requires GetDataCatalog permission to the catalog. For code * samples using the AWS SDK for Java, see Examples and * Code Samples in the Amazon Athena User Guide.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { AthenaClient, StartQueryExecutionCommand } from "@aws-sdk/client-athena"; // ES Modules import + * // const { AthenaClient, StartQueryExecutionCommand } = require("@aws-sdk/client-athena"); // CommonJS import + * const client = new AthenaClient(config); + * const command = new StartQueryExecutionCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link StartQueryExecutionCommandInput} for command's `input` shape. + * @see {@link StartQueryExecutionCommandOutput} for command's `response` shape. + * @see {@link AthenaClientResolvedConfig | config} for command's `input` shape. + * */ export class StartQueryExecutionCommand extends $Command< StartQueryExecutionCommandInput, diff --git a/clients/client-athena/commands/StopQueryExecutionCommand.ts b/clients/client-athena/commands/StopQueryExecutionCommand.ts index c9bac603a7a1..f9a8a021d5fe 100644 --- a/clients/client-athena/commands/StopQueryExecutionCommand.ts +++ b/clients/client-athena/commands/StopQueryExecutionCommand.ts @@ -25,6 +25,20 @@ export interface StopQueryExecutionCommandOutput extends StopQueryExecutionOutpu * query ran.

*

For code samples using the AWS SDK for Java, see Examples and * Code Samples in the Amazon Athena User Guide.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { AthenaClient, StopQueryExecutionCommand } from "@aws-sdk/client-athena"; // ES Modules import + * // const { AthenaClient, StopQueryExecutionCommand } = require("@aws-sdk/client-athena"); // CommonJS import + * const client = new AthenaClient(config); + * const command = new StopQueryExecutionCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link StopQueryExecutionCommandInput} for command's `input` shape. + * @see {@link StopQueryExecutionCommandOutput} for command's `response` shape. + * @see {@link AthenaClientResolvedConfig | config} for command's `input` shape. + * */ export class StopQueryExecutionCommand extends $Command< StopQueryExecutionCommandInput, diff --git a/clients/client-athena/commands/TagResourceCommand.ts b/clients/client-athena/commands/TagResourceCommand.ts index 996b135c1ef6..0d61c9d097c5 100644 --- a/clients/client-athena/commands/TagResourceCommand.ts +++ b/clients/client-athena/commands/TagResourceCommand.ts @@ -31,6 +31,20 @@ export interface TagResourceCommandOutput extends TagResourceOutput, __MetadataB * 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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { AthenaClient, TagResourceCommand } from "@aws-sdk/client-athena"; // ES Modules import + * // const { AthenaClient, TagResourceCommand } = require("@aws-sdk/client-athena"); // CommonJS import + * const client = new AthenaClient(config); + * const command = new TagResourceCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link TagResourceCommandInput} for command's `input` shape. + * @see {@link TagResourceCommandOutput} for command's `response` shape. + * @see {@link AthenaClientResolvedConfig | config} for command's `input` shape. + * */ export class TagResourceCommand extends $Command< TagResourceCommandInput, diff --git a/clients/client-athena/commands/UntagResourceCommand.ts b/clients/client-athena/commands/UntagResourceCommand.ts index cbbf94a2f31e..a0bd729f45ef 100644 --- a/clients/client-athena/commands/UntagResourceCommand.ts +++ b/clients/client-athena/commands/UntagResourceCommand.ts @@ -22,6 +22,20 @@ export interface UntagResourceCommandOutput extends UntagResourceOutput, __Metad /** *

Removes one or more tags from a data catalog or workgroup resource.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { AthenaClient, UntagResourceCommand } from "@aws-sdk/client-athena"; // ES Modules import + * // const { AthenaClient, UntagResourceCommand } = require("@aws-sdk/client-athena"); // CommonJS import + * const client = new AthenaClient(config); + * const command = new UntagResourceCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link UntagResourceCommandInput} for command's `input` shape. + * @see {@link UntagResourceCommandOutput} for command's `response` shape. + * @see {@link AthenaClientResolvedConfig | config} for command's `input` shape. + * */ export class UntagResourceCommand extends $Command< UntagResourceCommandInput, diff --git a/clients/client-athena/commands/UpdateDataCatalogCommand.ts b/clients/client-athena/commands/UpdateDataCatalogCommand.ts index c3beebcb229a..368c3053022e 100644 --- a/clients/client-athena/commands/UpdateDataCatalogCommand.ts +++ b/clients/client-athena/commands/UpdateDataCatalogCommand.ts @@ -22,6 +22,20 @@ export interface UpdateDataCatalogCommandOutput extends UpdateDataCatalogOutput, /** *

Updates the data catalog that has the specified name.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { AthenaClient, UpdateDataCatalogCommand } from "@aws-sdk/client-athena"; // ES Modules import + * // const { AthenaClient, UpdateDataCatalogCommand } = require("@aws-sdk/client-athena"); // CommonJS import + * const client = new AthenaClient(config); + * const command = new UpdateDataCatalogCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link UpdateDataCatalogCommandInput} for command's `input` shape. + * @see {@link UpdateDataCatalogCommandOutput} for command's `response` shape. + * @see {@link AthenaClientResolvedConfig | config} for command's `input` shape. + * */ export class UpdateDataCatalogCommand extends $Command< UpdateDataCatalogCommandInput, diff --git a/clients/client-athena/commands/UpdatePreparedStatementCommand.ts b/clients/client-athena/commands/UpdatePreparedStatementCommand.ts index d6a49f4bc325..b0d9250cd989 100644 --- a/clients/client-athena/commands/UpdatePreparedStatementCommand.ts +++ b/clients/client-athena/commands/UpdatePreparedStatementCommand.ts @@ -22,6 +22,20 @@ export interface UpdatePreparedStatementCommandOutput extends UpdatePreparedStat /** *

Updates a prepared statement.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { AthenaClient, UpdatePreparedStatementCommand } from "@aws-sdk/client-athena"; // ES Modules import + * // const { AthenaClient, UpdatePreparedStatementCommand } = require("@aws-sdk/client-athena"); // CommonJS import + * const client = new AthenaClient(config); + * const command = new UpdatePreparedStatementCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link UpdatePreparedStatementCommandInput} for command's `input` shape. + * @see {@link UpdatePreparedStatementCommandOutput} for command's `response` shape. + * @see {@link AthenaClientResolvedConfig | config} for command's `input` shape. + * */ export class UpdatePreparedStatementCommand extends $Command< UpdatePreparedStatementCommandInput, diff --git a/clients/client-athena/commands/UpdateWorkGroupCommand.ts b/clients/client-athena/commands/UpdateWorkGroupCommand.ts index 64b991a5a4ef..99eb3af1477f 100644 --- a/clients/client-athena/commands/UpdateWorkGroupCommand.ts +++ b/clients/client-athena/commands/UpdateWorkGroupCommand.ts @@ -23,6 +23,20 @@ export interface UpdateWorkGroupCommandOutput extends UpdateWorkGroupOutput, __M /** *

Updates the workgroup with the specified name. The workgroup's name cannot be * changed.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { AthenaClient, UpdateWorkGroupCommand } from "@aws-sdk/client-athena"; // ES Modules import + * // const { AthenaClient, UpdateWorkGroupCommand } = require("@aws-sdk/client-athena"); // CommonJS import + * const client = new AthenaClient(config); + * const command = new UpdateWorkGroupCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link UpdateWorkGroupCommandInput} for command's `input` shape. + * @see {@link UpdateWorkGroupCommandOutput} for command's `response` shape. + * @see {@link AthenaClientResolvedConfig | config} for command's `input` shape. + * */ export class UpdateWorkGroupCommand extends $Command< UpdateWorkGroupCommandInput, diff --git a/clients/client-athena/models/models_0.ts b/clients/client-athena/models/models_0.ts index dee030110ac9..a245c42dad76 100644 --- a/clients/client-athena/models/models_0.ts +++ b/clients/client-athena/models/models_0.ts @@ -9,6 +9,9 @@ export interface BatchGetNamedQueryInput { } export namespace BatchGetNamedQueryInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: BatchGetNamedQueryInput): any => ({ ...obj, }); @@ -51,6 +54,9 @@ export interface NamedQuery { } export namespace NamedQuery { + /** + * @internal + */ export const filterSensitiveLog = (obj: NamedQuery): any => ({ ...obj, }); @@ -79,6 +85,9 @@ export interface UnprocessedNamedQueryId { } export namespace UnprocessedNamedQueryId { + /** + * @internal + */ export const filterSensitiveLog = (obj: UnprocessedNamedQueryId): any => ({ ...obj, }); @@ -97,6 +106,9 @@ export interface BatchGetNamedQueryOutput { } export namespace BatchGetNamedQueryOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: BatchGetNamedQueryOutput): any => ({ ...obj, }); @@ -113,6 +125,9 @@ export interface InternalServerException extends __SmithyException, $MetadataBea } export namespace InternalServerException { + /** + * @internal + */ export const filterSensitiveLog = (obj: InternalServerException): any => ({ ...obj, }); @@ -135,6 +150,9 @@ export interface InvalidRequestException extends __SmithyException, $MetadataBea } export namespace InvalidRequestException { + /** + * @internal + */ export const filterSensitiveLog = (obj: InvalidRequestException): any => ({ ...obj, }); @@ -148,6 +166,9 @@ export interface BatchGetQueryExecutionInput { } export namespace BatchGetQueryExecutionInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: BatchGetQueryExecutionInput): any => ({ ...obj, }); @@ -172,6 +193,9 @@ export interface EngineVersion { } export namespace EngineVersion { + /** + * @internal + */ export const filterSensitiveLog = (obj: EngineVersion): any => ({ ...obj, }); @@ -193,6 +217,9 @@ export interface QueryExecutionContext { } export namespace QueryExecutionContext { + /** + * @internal + */ export const filterSensitiveLog = (obj: QueryExecutionContext): any => ({ ...obj, }); @@ -228,6 +255,9 @@ export interface EncryptionConfiguration { } export namespace EncryptionConfiguration { + /** + * @internal + */ export const filterSensitiveLog = (obj: EncryptionConfiguration): any => ({ ...obj, }); @@ -262,6 +292,9 @@ export interface ResultConfiguration { } export namespace ResultConfiguration { + /** + * @internal + */ export const filterSensitiveLog = (obj: ResultConfiguration): any => ({ ...obj, }); @@ -326,6 +359,9 @@ export interface QueryExecutionStatistics { } export namespace QueryExecutionStatistics { + /** + * @internal + */ export const filterSensitiveLog = (obj: QueryExecutionStatistics): any => ({ ...obj, }); @@ -377,6 +413,9 @@ export interface QueryExecutionStatus { } export namespace QueryExecutionStatus { + /** + * @internal + */ export const filterSensitiveLog = (obj: QueryExecutionStatus): any => ({ ...obj, }); @@ -442,6 +481,9 @@ export interface QueryExecution { } export namespace QueryExecution { + /** + * @internal + */ export const filterSensitiveLog = (obj: QueryExecution): any => ({ ...obj, }); @@ -470,6 +512,9 @@ export interface UnprocessedQueryExecutionId { } export namespace UnprocessedQueryExecutionId { + /** + * @internal + */ export const filterSensitiveLog = (obj: UnprocessedQueryExecutionId): any => ({ ...obj, }); @@ -488,6 +533,9 @@ export interface BatchGetQueryExecutionOutput { } export namespace BatchGetQueryExecutionOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: BatchGetQueryExecutionOutput): any => ({ ...obj, }); @@ -522,6 +570,9 @@ export interface Tag { } export namespace Tag { + /** + * @internal + */ export const filterSensitiveLog = (obj: Tag): any => ({ ...obj, }); @@ -609,6 +660,9 @@ export interface CreateDataCatalogInput { } export namespace CreateDataCatalogInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateDataCatalogInput): any => ({ ...obj, }); @@ -617,6 +671,9 @@ export namespace CreateDataCatalogInput { export interface CreateDataCatalogOutput {} export namespace CreateDataCatalogOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateDataCatalogOutput): any => ({ ...obj, }); @@ -663,6 +720,9 @@ export interface CreateNamedQueryInput { } export namespace CreateNamedQueryInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateNamedQueryInput): any => ({ ...obj, }); @@ -676,6 +736,9 @@ export interface CreateNamedQueryOutput { } export namespace CreateNamedQueryOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateNamedQueryOutput): any => ({ ...obj, }); @@ -704,6 +767,9 @@ export interface CreatePreparedStatementInput { } export namespace CreatePreparedStatementInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreatePreparedStatementInput): any => ({ ...obj, }); @@ -712,6 +778,9 @@ export namespace CreatePreparedStatementInput { export interface CreatePreparedStatementOutput {} export namespace CreatePreparedStatementOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreatePreparedStatementOutput): any => ({ ...obj, }); @@ -772,6 +841,9 @@ export interface WorkGroupConfiguration { } export namespace WorkGroupConfiguration { + /** + * @internal + */ export const filterSensitiveLog = (obj: WorkGroupConfiguration): any => ({ ...obj, }); @@ -805,6 +877,9 @@ export interface CreateWorkGroupInput { } export namespace CreateWorkGroupInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateWorkGroupInput): any => ({ ...obj, }); @@ -813,6 +888,9 @@ export namespace CreateWorkGroupInput { export interface CreateWorkGroupOutput {} export namespace CreateWorkGroupOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateWorkGroupOutput): any => ({ ...obj, }); @@ -826,6 +904,9 @@ export interface DeleteDataCatalogInput { } export namespace DeleteDataCatalogInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteDataCatalogInput): any => ({ ...obj, }); @@ -834,6 +915,9 @@ export namespace DeleteDataCatalogInput { export interface DeleteDataCatalogOutput {} export namespace DeleteDataCatalogOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteDataCatalogOutput): any => ({ ...obj, }); @@ -847,6 +931,9 @@ export interface DeleteNamedQueryInput { } export namespace DeleteNamedQueryInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteNamedQueryInput): any => ({ ...obj, }); @@ -855,6 +942,9 @@ export namespace DeleteNamedQueryInput { export interface DeleteNamedQueryOutput {} export namespace DeleteNamedQueryOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteNamedQueryOutput): any => ({ ...obj, }); @@ -873,6 +963,9 @@ export interface DeletePreparedStatementInput { } export namespace DeletePreparedStatementInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeletePreparedStatementInput): any => ({ ...obj, }); @@ -881,6 +974,9 @@ export namespace DeletePreparedStatementInput { export interface DeletePreparedStatementOutput {} export namespace DeletePreparedStatementOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeletePreparedStatementOutput): any => ({ ...obj, }); @@ -897,6 +993,9 @@ export interface ResourceNotFoundException extends __SmithyException, $MetadataB } export namespace ResourceNotFoundException { + /** + * @internal + */ export const filterSensitiveLog = (obj: ResourceNotFoundException): any => ({ ...obj, }); @@ -916,6 +1015,9 @@ export interface DeleteWorkGroupInput { } export namespace DeleteWorkGroupInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteWorkGroupInput): any => ({ ...obj, }); @@ -924,6 +1026,9 @@ export namespace DeleteWorkGroupInput { export interface DeleteWorkGroupOutput {} export namespace DeleteWorkGroupOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteWorkGroupOutput): any => ({ ...obj, }); @@ -942,6 +1047,9 @@ export interface GetDatabaseInput { } export namespace GetDatabaseInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetDatabaseInput): any => ({ ...obj, }); @@ -968,6 +1076,9 @@ export interface Database { } export namespace Database { + /** + * @internal + */ export const filterSensitiveLog = (obj: Database): any => ({ ...obj, }); @@ -981,6 +1092,9 @@ export interface GetDatabaseOutput { } export namespace GetDatabaseOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetDatabaseOutput): any => ({ ...obj, }); @@ -1000,6 +1114,9 @@ export interface MetadataException extends __SmithyException, $MetadataBearer { } export namespace MetadataException { + /** + * @internal + */ export const filterSensitiveLog = (obj: MetadataException): any => ({ ...obj, }); @@ -1013,6 +1130,9 @@ export interface GetDataCatalogInput { } export namespace GetDataCatalogInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetDataCatalogInput): any => ({ ...obj, }); @@ -1087,6 +1207,9 @@ export interface DataCatalog { } export namespace DataCatalog { + /** + * @internal + */ export const filterSensitiveLog = (obj: DataCatalog): any => ({ ...obj, }); @@ -1100,6 +1223,9 @@ export interface GetDataCatalogOutput { } export namespace GetDataCatalogOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetDataCatalogOutput): any => ({ ...obj, }); @@ -1114,6 +1240,9 @@ export interface GetNamedQueryInput { } export namespace GetNamedQueryInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetNamedQueryInput): any => ({ ...obj, }); @@ -1127,6 +1256,9 @@ export interface GetNamedQueryOutput { } export namespace GetNamedQueryOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetNamedQueryOutput): any => ({ ...obj, }); @@ -1145,6 +1277,9 @@ export interface GetPreparedStatementInput { } export namespace GetPreparedStatementInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetPreparedStatementInput): any => ({ ...obj, }); @@ -1181,6 +1316,9 @@ export interface PreparedStatement { } export namespace PreparedStatement { + /** + * @internal + */ export const filterSensitiveLog = (obj: PreparedStatement): any => ({ ...obj, }); @@ -1194,6 +1332,9 @@ export interface GetPreparedStatementOutput { } export namespace GetPreparedStatementOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetPreparedStatementOutput): any => ({ ...obj, }); @@ -1207,6 +1348,9 @@ export interface GetQueryExecutionInput { } export namespace GetQueryExecutionInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetQueryExecutionInput): any => ({ ...obj, }); @@ -1220,6 +1364,9 @@ export interface GetQueryExecutionOutput { } export namespace GetQueryExecutionOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetQueryExecutionOutput): any => ({ ...obj, }); @@ -1245,6 +1392,9 @@ export interface GetQueryResultsInput { } export namespace GetQueryResultsInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetQueryResultsInput): any => ({ ...obj, }); @@ -1314,6 +1464,9 @@ export interface ColumnInfo { } export namespace ColumnInfo { + /** + * @internal + */ export const filterSensitiveLog = (obj: ColumnInfo): any => ({ ...obj, }); @@ -1331,6 +1484,9 @@ export interface ResultSetMetadata { } export namespace ResultSetMetadata { + /** + * @internal + */ export const filterSensitiveLog = (obj: ResultSetMetadata): any => ({ ...obj, }); @@ -1347,6 +1503,9 @@ export interface Datum { } export namespace Datum { + /** + * @internal + */ export const filterSensitiveLog = (obj: Datum): any => ({ ...obj, }); @@ -1363,6 +1522,9 @@ export interface Row { } export namespace Row { + /** + * @internal + */ export const filterSensitiveLog = (obj: Row): any => ({ ...obj, }); @@ -1386,6 +1548,9 @@ export interface ResultSet { } export namespace ResultSet { + /** + * @internal + */ export const filterSensitiveLog = (obj: ResultSet): any => ({ ...obj, }); @@ -1411,6 +1576,9 @@ export interface GetQueryResultsOutput { } export namespace GetQueryResultsOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetQueryResultsOutput): any => ({ ...obj, }); @@ -1435,6 +1603,9 @@ export interface GetTableMetadataInput { } export namespace GetTableMetadataInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetTableMetadataInput): any => ({ ...obj, }); @@ -1461,6 +1632,9 @@ export interface Column { } export namespace Column { + /** + * @internal + */ export const filterSensitiveLog = (obj: Column): any => ({ ...obj, }); @@ -1507,6 +1681,9 @@ export interface TableMetadata { } export namespace TableMetadata { + /** + * @internal + */ export const filterSensitiveLog = (obj: TableMetadata): any => ({ ...obj, }); @@ -1520,6 +1697,9 @@ export interface GetTableMetadataOutput { } export namespace GetTableMetadataOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetTableMetadataOutput): any => ({ ...obj, }); @@ -1533,6 +1713,9 @@ export interface GetWorkGroupInput { } export namespace GetWorkGroupInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetWorkGroupInput): any => ({ ...obj, }); @@ -1586,6 +1769,9 @@ export interface WorkGroup { } export namespace WorkGroup { + /** + * @internal + */ export const filterSensitiveLog = (obj: WorkGroup): any => ({ ...obj, }); @@ -1599,6 +1785,9 @@ export interface GetWorkGroupOutput { } export namespace GetWorkGroupOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetWorkGroupOutput): any => ({ ...obj, }); @@ -1624,6 +1813,9 @@ export interface ListDatabasesInput { } export namespace ListDatabasesInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListDatabasesInput): any => ({ ...obj, }); @@ -1644,6 +1836,9 @@ export interface ListDatabasesOutput { } export namespace ListDatabasesOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListDatabasesOutput): any => ({ ...obj, }); @@ -1664,6 +1859,9 @@ export interface ListDataCatalogsInput { } export namespace ListDataCatalogsInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListDataCatalogsInput): any => ({ ...obj, }); @@ -1685,6 +1883,9 @@ export interface DataCatalogSummary { } export namespace DataCatalogSummary { + /** + * @internal + */ export const filterSensitiveLog = (obj: DataCatalogSummary): any => ({ ...obj, }); @@ -1705,6 +1906,9 @@ export interface ListDataCatalogsOutput { } export namespace ListDataCatalogsOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListDataCatalogsOutput): any => ({ ...obj, }); @@ -1725,6 +1929,9 @@ export interface ListEngineVersionsInput { } export namespace ListEngineVersionsInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListEngineVersionsInput): any => ({ ...obj, }); @@ -1745,6 +1952,9 @@ export interface ListEngineVersionsOutput { } export namespace ListEngineVersionsOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListEngineVersionsOutput): any => ({ ...obj, }); @@ -1772,6 +1982,9 @@ export interface ListNamedQueriesInput { } export namespace ListNamedQueriesInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListNamedQueriesInput): any => ({ ...obj, }); @@ -1792,6 +2005,9 @@ export interface ListNamedQueriesOutput { } export namespace ListNamedQueriesOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListNamedQueriesOutput): any => ({ ...obj, }); @@ -1817,6 +2033,9 @@ export interface ListPreparedStatementsInput { } export namespace ListPreparedStatementsInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListPreparedStatementsInput): any => ({ ...obj, }); @@ -1838,6 +2057,9 @@ export interface PreparedStatementSummary { } export namespace PreparedStatementSummary { + /** + * @internal + */ export const filterSensitiveLog = (obj: PreparedStatementSummary): any => ({ ...obj, }); @@ -1858,6 +2080,9 @@ export interface ListPreparedStatementsOutput { } export namespace ListPreparedStatementsOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListPreparedStatementsOutput): any => ({ ...obj, }); @@ -1885,6 +2110,9 @@ export interface ListQueryExecutionsInput { } export namespace ListQueryExecutionsInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListQueryExecutionsInput): any => ({ ...obj, }); @@ -1903,6 +2131,9 @@ export interface ListQueryExecutionsOutput { } export namespace ListQueryExecutionsOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListQueryExecutionsOutput): any => ({ ...obj, }); @@ -1939,6 +2170,9 @@ export interface ListTableMetadataInput { } export namespace ListTableMetadataInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListTableMetadataInput): any => ({ ...obj, }); @@ -1959,6 +2193,9 @@ export interface ListTableMetadataOutput { } export namespace ListTableMetadataOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListTableMetadataOutput): any => ({ ...obj, }); @@ -1985,6 +2222,9 @@ export interface ListTagsForResourceInput { } export namespace ListTagsForResourceInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListTagsForResourceInput): any => ({ ...obj, }); @@ -2003,6 +2243,9 @@ export interface ListTagsForResourceOutput { } export namespace ListTagsForResourceOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListTagsForResourceOutput): any => ({ ...obj, }); @@ -2023,6 +2266,9 @@ export interface ListWorkGroupsInput { } export namespace ListWorkGroupsInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListWorkGroupsInput): any => ({ ...obj, }); @@ -2060,6 +2306,9 @@ export interface WorkGroupSummary { } export namespace WorkGroupSummary { + /** + * @internal + */ export const filterSensitiveLog = (obj: WorkGroupSummary): any => ({ ...obj, }); @@ -2081,6 +2330,9 @@ export interface ListWorkGroupsOutput { } export namespace ListWorkGroupsOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListWorkGroupsOutput): any => ({ ...obj, }); @@ -2125,6 +2377,9 @@ export interface StartQueryExecutionInput { } export namespace StartQueryExecutionInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: StartQueryExecutionInput): any => ({ ...obj, }); @@ -2138,6 +2393,9 @@ export interface StartQueryExecutionOutput { } export namespace StartQueryExecutionOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: StartQueryExecutionOutput): any => ({ ...obj, }); @@ -2162,6 +2420,9 @@ export interface TooManyRequestsException extends __SmithyException, $MetadataBe } export namespace TooManyRequestsException { + /** + * @internal + */ export const filterSensitiveLog = (obj: TooManyRequestsException): any => ({ ...obj, }); @@ -2175,6 +2436,9 @@ export interface StopQueryExecutionInput { } export namespace StopQueryExecutionInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: StopQueryExecutionInput): any => ({ ...obj, }); @@ -2183,6 +2447,9 @@ export namespace StopQueryExecutionInput { export interface StopQueryExecutionOutput {} export namespace StopQueryExecutionOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: StopQueryExecutionOutput): any => ({ ...obj, }); @@ -2203,6 +2470,9 @@ export interface TagResourceInput { } export namespace TagResourceInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: TagResourceInput): any => ({ ...obj, }); @@ -2211,6 +2481,9 @@ export namespace TagResourceInput { export interface TagResourceOutput {} export namespace TagResourceOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: TagResourceOutput): any => ({ ...obj, }); @@ -2230,6 +2503,9 @@ export interface UntagResourceInput { } export namespace UntagResourceInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: UntagResourceInput): any => ({ ...obj, }); @@ -2238,6 +2514,9 @@ export namespace UntagResourceInput { export interface UntagResourceOutput {} export namespace UntagResourceOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: UntagResourceOutput): any => ({ ...obj, }); @@ -2314,6 +2593,9 @@ export interface UpdateDataCatalogInput { } export namespace UpdateDataCatalogInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateDataCatalogInput): any => ({ ...obj, }); @@ -2322,6 +2604,9 @@ export namespace UpdateDataCatalogInput { export interface UpdateDataCatalogOutput {} export namespace UpdateDataCatalogOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateDataCatalogOutput): any => ({ ...obj, }); @@ -2350,6 +2635,9 @@ export interface UpdatePreparedStatementInput { } export namespace UpdatePreparedStatementInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdatePreparedStatementInput): any => ({ ...obj, }); @@ -2358,6 +2646,9 @@ export namespace UpdatePreparedStatementInput { export interface UpdatePreparedStatementOutput {} export namespace UpdatePreparedStatementOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdatePreparedStatementOutput): any => ({ ...obj, }); @@ -2407,6 +2698,9 @@ export interface ResultConfigurationUpdates { } export namespace ResultConfigurationUpdates { + /** + * @internal + */ export const filterSensitiveLog = (obj: ResultConfigurationUpdates): any => ({ ...obj, }); @@ -2468,6 +2762,9 @@ export interface WorkGroupConfigurationUpdates { } export namespace WorkGroupConfigurationUpdates { + /** + * @internal + */ export const filterSensitiveLog = (obj: WorkGroupConfigurationUpdates): any => ({ ...obj, }); @@ -2496,6 +2793,9 @@ export interface UpdateWorkGroupInput { } export namespace UpdateWorkGroupInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateWorkGroupInput): any => ({ ...obj, }); @@ -2504,6 +2804,9 @@ export namespace UpdateWorkGroupInput { export interface UpdateWorkGroupOutput {} export namespace UpdateWorkGroupOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateWorkGroupOutput): any => ({ ...obj, }); diff --git a/clients/client-auditmanager/commands/AssociateAssessmentReportEvidenceFolderCommand.ts b/clients/client-auditmanager/commands/AssociateAssessmentReportEvidenceFolderCommand.ts index a2a26dd48fb9..0d473c5a20a5 100644 --- a/clients/client-auditmanager/commands/AssociateAssessmentReportEvidenceFolderCommand.ts +++ b/clients/client-auditmanager/commands/AssociateAssessmentReportEvidenceFolderCommand.ts @@ -30,6 +30,20 @@ export interface AssociateAssessmentReportEvidenceFolderCommandOutput *

* Associates an evidence folder to the specified assessment report in AWS Audit Manager. *

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { AuditManagerClient, AssociateAssessmentReportEvidenceFolderCommand } from "@aws-sdk/client-auditmanager"; // ES Modules import + * // const { AuditManagerClient, AssociateAssessmentReportEvidenceFolderCommand } = require("@aws-sdk/client-auditmanager"); // CommonJS import + * const client = new AuditManagerClient(config); + * const command = new AssociateAssessmentReportEvidenceFolderCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link AssociateAssessmentReportEvidenceFolderCommandInput} for command's `input` shape. + * @see {@link AssociateAssessmentReportEvidenceFolderCommandOutput} for command's `response` shape. + * @see {@link AuditManagerClientResolvedConfig | config} for command's `input` shape. + * */ export class AssociateAssessmentReportEvidenceFolderCommand extends $Command< AssociateAssessmentReportEvidenceFolderCommandInput, diff --git a/clients/client-auditmanager/commands/BatchAssociateAssessmentReportEvidenceCommand.ts b/clients/client-auditmanager/commands/BatchAssociateAssessmentReportEvidenceCommand.ts index 6d1332421917..6b5b7162d055 100644 --- a/clients/client-auditmanager/commands/BatchAssociateAssessmentReportEvidenceCommand.ts +++ b/clients/client-auditmanager/commands/BatchAssociateAssessmentReportEvidenceCommand.ts @@ -30,6 +30,20 @@ export interface BatchAssociateAssessmentReportEvidenceCommandOutput *

* Associates a list of evidence to an assessment report in an AWS Audit Manager assessment. *

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { AuditManagerClient, BatchAssociateAssessmentReportEvidenceCommand } from "@aws-sdk/client-auditmanager"; // ES Modules import + * // const { AuditManagerClient, BatchAssociateAssessmentReportEvidenceCommand } = require("@aws-sdk/client-auditmanager"); // CommonJS import + * const client = new AuditManagerClient(config); + * const command = new BatchAssociateAssessmentReportEvidenceCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link BatchAssociateAssessmentReportEvidenceCommandInput} for command's `input` shape. + * @see {@link BatchAssociateAssessmentReportEvidenceCommandOutput} for command's `response` shape. + * @see {@link AuditManagerClientResolvedConfig | config} for command's `input` shape. + * */ export class BatchAssociateAssessmentReportEvidenceCommand extends $Command< BatchAssociateAssessmentReportEvidenceCommandInput, diff --git a/clients/client-auditmanager/commands/BatchCreateDelegationByAssessmentCommand.ts b/clients/client-auditmanager/commands/BatchCreateDelegationByAssessmentCommand.ts index db114d4bf2db..992bf1cb678e 100644 --- a/clients/client-auditmanager/commands/BatchCreateDelegationByAssessmentCommand.ts +++ b/clients/client-auditmanager/commands/BatchCreateDelegationByAssessmentCommand.ts @@ -29,6 +29,20 @@ export interface BatchCreateDelegationByAssessmentCommandOutput *

* Create a batch of delegations for a specified assessment in AWS Audit Manager. *

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { AuditManagerClient, BatchCreateDelegationByAssessmentCommand } from "@aws-sdk/client-auditmanager"; // ES Modules import + * // const { AuditManagerClient, BatchCreateDelegationByAssessmentCommand } = require("@aws-sdk/client-auditmanager"); // CommonJS import + * const client = new AuditManagerClient(config); + * const command = new BatchCreateDelegationByAssessmentCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link BatchCreateDelegationByAssessmentCommandInput} for command's `input` shape. + * @see {@link BatchCreateDelegationByAssessmentCommandOutput} for command's `response` shape. + * @see {@link AuditManagerClientResolvedConfig | config} for command's `input` shape. + * */ export class BatchCreateDelegationByAssessmentCommand extends $Command< BatchCreateDelegationByAssessmentCommandInput, diff --git a/clients/client-auditmanager/commands/BatchDeleteDelegationByAssessmentCommand.ts b/clients/client-auditmanager/commands/BatchDeleteDelegationByAssessmentCommand.ts index 4617e332c1b2..ebfa63b6d2f4 100644 --- a/clients/client-auditmanager/commands/BatchDeleteDelegationByAssessmentCommand.ts +++ b/clients/client-auditmanager/commands/BatchDeleteDelegationByAssessmentCommand.ts @@ -29,6 +29,20 @@ export interface BatchDeleteDelegationByAssessmentCommandOutput *

* Deletes the delegations in the specified AWS Audit Manager assessment. *

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { AuditManagerClient, BatchDeleteDelegationByAssessmentCommand } from "@aws-sdk/client-auditmanager"; // ES Modules import + * // const { AuditManagerClient, BatchDeleteDelegationByAssessmentCommand } = require("@aws-sdk/client-auditmanager"); // CommonJS import + * const client = new AuditManagerClient(config); + * const command = new BatchDeleteDelegationByAssessmentCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link BatchDeleteDelegationByAssessmentCommandInput} for command's `input` shape. + * @see {@link BatchDeleteDelegationByAssessmentCommandOutput} for command's `response` shape. + * @see {@link AuditManagerClientResolvedConfig | config} for command's `input` shape. + * */ export class BatchDeleteDelegationByAssessmentCommand extends $Command< BatchDeleteDelegationByAssessmentCommandInput, diff --git a/clients/client-auditmanager/commands/BatchDisassociateAssessmentReportEvidenceCommand.ts b/clients/client-auditmanager/commands/BatchDisassociateAssessmentReportEvidenceCommand.ts index 13c3acfb94f4..6782448a1987 100644 --- a/clients/client-auditmanager/commands/BatchDisassociateAssessmentReportEvidenceCommand.ts +++ b/clients/client-auditmanager/commands/BatchDisassociateAssessmentReportEvidenceCommand.ts @@ -30,6 +30,20 @@ export interface BatchDisassociateAssessmentReportEvidenceCommandOutput *

* Disassociates a list of evidence from the specified assessment report in AWS Audit Manager. *

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { AuditManagerClient, BatchDisassociateAssessmentReportEvidenceCommand } from "@aws-sdk/client-auditmanager"; // ES Modules import + * // const { AuditManagerClient, BatchDisassociateAssessmentReportEvidenceCommand } = require("@aws-sdk/client-auditmanager"); // CommonJS import + * const client = new AuditManagerClient(config); + * const command = new BatchDisassociateAssessmentReportEvidenceCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link BatchDisassociateAssessmentReportEvidenceCommandInput} for command's `input` shape. + * @see {@link BatchDisassociateAssessmentReportEvidenceCommandOutput} for command's `response` shape. + * @see {@link AuditManagerClientResolvedConfig | config} for command's `input` shape. + * */ export class BatchDisassociateAssessmentReportEvidenceCommand extends $Command< BatchDisassociateAssessmentReportEvidenceCommandInput, diff --git a/clients/client-auditmanager/commands/BatchImportEvidenceToAssessmentControlCommand.ts b/clients/client-auditmanager/commands/BatchImportEvidenceToAssessmentControlCommand.ts index d76622ec679d..873a86c97ce5 100644 --- a/clients/client-auditmanager/commands/BatchImportEvidenceToAssessmentControlCommand.ts +++ b/clients/client-auditmanager/commands/BatchImportEvidenceToAssessmentControlCommand.ts @@ -30,6 +30,20 @@ export interface BatchImportEvidenceToAssessmentControlCommandOutput *

* Uploads one or more pieces of evidence to the specified control in the assessment in AWS Audit Manager. *

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { AuditManagerClient, BatchImportEvidenceToAssessmentControlCommand } from "@aws-sdk/client-auditmanager"; // ES Modules import + * // const { AuditManagerClient, BatchImportEvidenceToAssessmentControlCommand } = require("@aws-sdk/client-auditmanager"); // CommonJS import + * const client = new AuditManagerClient(config); + * const command = new BatchImportEvidenceToAssessmentControlCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link BatchImportEvidenceToAssessmentControlCommandInput} for command's `input` shape. + * @see {@link BatchImportEvidenceToAssessmentControlCommandOutput} for command's `response` shape. + * @see {@link AuditManagerClientResolvedConfig | config} for command's `input` shape. + * */ export class BatchImportEvidenceToAssessmentControlCommand extends $Command< BatchImportEvidenceToAssessmentControlCommandInput, diff --git a/clients/client-auditmanager/commands/CreateAssessmentCommand.ts b/clients/client-auditmanager/commands/CreateAssessmentCommand.ts index e406f8bbaa67..4807efbfb5d8 100644 --- a/clients/client-auditmanager/commands/CreateAssessmentCommand.ts +++ b/clients/client-auditmanager/commands/CreateAssessmentCommand.ts @@ -24,6 +24,20 @@ export interface CreateAssessmentCommandOutput extends CreateAssessmentResponse, *

* Creates an assessment in AWS Audit Manager. *

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { AuditManagerClient, CreateAssessmentCommand } from "@aws-sdk/client-auditmanager"; // ES Modules import + * // const { AuditManagerClient, CreateAssessmentCommand } = require("@aws-sdk/client-auditmanager"); // CommonJS import + * const client = new AuditManagerClient(config); + * const command = new CreateAssessmentCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreateAssessmentCommandInput} for command's `input` shape. + * @see {@link CreateAssessmentCommandOutput} for command's `response` shape. + * @see {@link AuditManagerClientResolvedConfig | config} for command's `input` shape. + * */ export class CreateAssessmentCommand extends $Command< CreateAssessmentCommandInput, diff --git a/clients/client-auditmanager/commands/CreateAssessmentFrameworkCommand.ts b/clients/client-auditmanager/commands/CreateAssessmentFrameworkCommand.ts index 09247329cbdc..189f3f4d42dc 100644 --- a/clients/client-auditmanager/commands/CreateAssessmentFrameworkCommand.ts +++ b/clients/client-auditmanager/commands/CreateAssessmentFrameworkCommand.ts @@ -24,6 +24,20 @@ export interface CreateAssessmentFrameworkCommandOutput extends CreateAssessment *

* Creates a custom framework in AWS Audit Manager. *

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { AuditManagerClient, CreateAssessmentFrameworkCommand } from "@aws-sdk/client-auditmanager"; // ES Modules import + * // const { AuditManagerClient, CreateAssessmentFrameworkCommand } = require("@aws-sdk/client-auditmanager"); // CommonJS import + * const client = new AuditManagerClient(config); + * const command = new CreateAssessmentFrameworkCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreateAssessmentFrameworkCommandInput} for command's `input` shape. + * @see {@link CreateAssessmentFrameworkCommandOutput} for command's `response` shape. + * @see {@link AuditManagerClientResolvedConfig | config} for command's `input` shape. + * */ export class CreateAssessmentFrameworkCommand extends $Command< CreateAssessmentFrameworkCommandInput, diff --git a/clients/client-auditmanager/commands/CreateAssessmentReportCommand.ts b/clients/client-auditmanager/commands/CreateAssessmentReportCommand.ts index 095b57ee5b62..8b22031fb533 100644 --- a/clients/client-auditmanager/commands/CreateAssessmentReportCommand.ts +++ b/clients/client-auditmanager/commands/CreateAssessmentReportCommand.ts @@ -24,6 +24,20 @@ export interface CreateAssessmentReportCommandOutput extends CreateAssessmentRep *

* Creates an assessment report for the specified assessment. *

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { AuditManagerClient, CreateAssessmentReportCommand } from "@aws-sdk/client-auditmanager"; // ES Modules import + * // const { AuditManagerClient, CreateAssessmentReportCommand } = require("@aws-sdk/client-auditmanager"); // CommonJS import + * const client = new AuditManagerClient(config); + * const command = new CreateAssessmentReportCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreateAssessmentReportCommandInput} for command's `input` shape. + * @see {@link CreateAssessmentReportCommandOutput} for command's `response` shape. + * @see {@link AuditManagerClientResolvedConfig | config} for command's `input` shape. + * */ export class CreateAssessmentReportCommand extends $Command< CreateAssessmentReportCommandInput, diff --git a/clients/client-auditmanager/commands/CreateControlCommand.ts b/clients/client-auditmanager/commands/CreateControlCommand.ts index 9c21c9a97a2b..ef6bb6ccf56c 100644 --- a/clients/client-auditmanager/commands/CreateControlCommand.ts +++ b/clients/client-auditmanager/commands/CreateControlCommand.ts @@ -24,6 +24,20 @@ export interface CreateControlCommandOutput extends CreateControlResponse, __Met *

* Creates a new custom control in AWS Audit Manager. *

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { AuditManagerClient, CreateControlCommand } from "@aws-sdk/client-auditmanager"; // ES Modules import + * // const { AuditManagerClient, CreateControlCommand } = require("@aws-sdk/client-auditmanager"); // CommonJS import + * const client = new AuditManagerClient(config); + * const command = new CreateControlCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreateControlCommandInput} for command's `input` shape. + * @see {@link CreateControlCommandOutput} for command's `response` shape. + * @see {@link AuditManagerClientResolvedConfig | config} for command's `input` shape. + * */ export class CreateControlCommand extends $Command< CreateControlCommandInput, diff --git a/clients/client-auditmanager/commands/DeleteAssessmentCommand.ts b/clients/client-auditmanager/commands/DeleteAssessmentCommand.ts index e22c36ab8c2f..e558bfd7ceef 100644 --- a/clients/client-auditmanager/commands/DeleteAssessmentCommand.ts +++ b/clients/client-auditmanager/commands/DeleteAssessmentCommand.ts @@ -24,6 +24,20 @@ export interface DeleteAssessmentCommandOutput extends DeleteAssessmentResponse, *

* Deletes an assessment in AWS Audit Manager. *

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { AuditManagerClient, DeleteAssessmentCommand } from "@aws-sdk/client-auditmanager"; // ES Modules import + * // const { AuditManagerClient, DeleteAssessmentCommand } = require("@aws-sdk/client-auditmanager"); // CommonJS import + * const client = new AuditManagerClient(config); + * const command = new DeleteAssessmentCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteAssessmentCommandInput} for command's `input` shape. + * @see {@link DeleteAssessmentCommandOutput} for command's `response` shape. + * @see {@link AuditManagerClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteAssessmentCommand extends $Command< DeleteAssessmentCommandInput, diff --git a/clients/client-auditmanager/commands/DeleteAssessmentFrameworkCommand.ts b/clients/client-auditmanager/commands/DeleteAssessmentFrameworkCommand.ts index 86cc492dcc5d..d6e50750f28e 100644 --- a/clients/client-auditmanager/commands/DeleteAssessmentFrameworkCommand.ts +++ b/clients/client-auditmanager/commands/DeleteAssessmentFrameworkCommand.ts @@ -24,6 +24,20 @@ export interface DeleteAssessmentFrameworkCommandOutput extends DeleteAssessment *

* Deletes a custom framework in AWS Audit Manager. *

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { AuditManagerClient, DeleteAssessmentFrameworkCommand } from "@aws-sdk/client-auditmanager"; // ES Modules import + * // const { AuditManagerClient, DeleteAssessmentFrameworkCommand } = require("@aws-sdk/client-auditmanager"); // CommonJS import + * const client = new AuditManagerClient(config); + * const command = new DeleteAssessmentFrameworkCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteAssessmentFrameworkCommandInput} for command's `input` shape. + * @see {@link DeleteAssessmentFrameworkCommandOutput} for command's `response` shape. + * @see {@link AuditManagerClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteAssessmentFrameworkCommand extends $Command< DeleteAssessmentFrameworkCommandInput, diff --git a/clients/client-auditmanager/commands/DeleteAssessmentReportCommand.ts b/clients/client-auditmanager/commands/DeleteAssessmentReportCommand.ts index 2b3b39372c29..4a0d89ff627d 100644 --- a/clients/client-auditmanager/commands/DeleteAssessmentReportCommand.ts +++ b/clients/client-auditmanager/commands/DeleteAssessmentReportCommand.ts @@ -24,6 +24,20 @@ export interface DeleteAssessmentReportCommandOutput extends DeleteAssessmentRep *

* Deletes an assessment report from an assessment in AWS Audit Manager. *

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { AuditManagerClient, DeleteAssessmentReportCommand } from "@aws-sdk/client-auditmanager"; // ES Modules import + * // const { AuditManagerClient, DeleteAssessmentReportCommand } = require("@aws-sdk/client-auditmanager"); // CommonJS import + * const client = new AuditManagerClient(config); + * const command = new DeleteAssessmentReportCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteAssessmentReportCommandInput} for command's `input` shape. + * @see {@link DeleteAssessmentReportCommandOutput} for command's `response` shape. + * @see {@link AuditManagerClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteAssessmentReportCommand extends $Command< DeleteAssessmentReportCommandInput, diff --git a/clients/client-auditmanager/commands/DeleteControlCommand.ts b/clients/client-auditmanager/commands/DeleteControlCommand.ts index 1631f2642b63..1b58e3e1f491 100644 --- a/clients/client-auditmanager/commands/DeleteControlCommand.ts +++ b/clients/client-auditmanager/commands/DeleteControlCommand.ts @@ -24,6 +24,20 @@ export interface DeleteControlCommandOutput extends DeleteControlResponse, __Met *

* Deletes a custom control in AWS Audit Manager. *

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { AuditManagerClient, DeleteControlCommand } from "@aws-sdk/client-auditmanager"; // ES Modules import + * // const { AuditManagerClient, DeleteControlCommand } = require("@aws-sdk/client-auditmanager"); // CommonJS import + * const client = new AuditManagerClient(config); + * const command = new DeleteControlCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteControlCommandInput} for command's `input` shape. + * @see {@link DeleteControlCommandOutput} for command's `response` shape. + * @see {@link AuditManagerClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteControlCommand extends $Command< DeleteControlCommandInput, diff --git a/clients/client-auditmanager/commands/DeregisterAccountCommand.ts b/clients/client-auditmanager/commands/DeregisterAccountCommand.ts index 850811e36be1..e3783979d409 100644 --- a/clients/client-auditmanager/commands/DeregisterAccountCommand.ts +++ b/clients/client-auditmanager/commands/DeregisterAccountCommand.ts @@ -24,6 +24,20 @@ export interface DeregisterAccountCommandOutput extends DeregisterAccountRespons *

* Deregisters an account in AWS Audit Manager. *

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { AuditManagerClient, DeregisterAccountCommand } from "@aws-sdk/client-auditmanager"; // ES Modules import + * // const { AuditManagerClient, DeregisterAccountCommand } = require("@aws-sdk/client-auditmanager"); // CommonJS import + * const client = new AuditManagerClient(config); + * const command = new DeregisterAccountCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeregisterAccountCommandInput} for command's `input` shape. + * @see {@link DeregisterAccountCommandOutput} for command's `response` shape. + * @see {@link AuditManagerClientResolvedConfig | config} for command's `input` shape. + * */ export class DeregisterAccountCommand extends $Command< DeregisterAccountCommandInput, diff --git a/clients/client-auditmanager/commands/DeregisterOrganizationAdminAccountCommand.ts b/clients/client-auditmanager/commands/DeregisterOrganizationAdminAccountCommand.ts index 04a2ae2e098e..8d1a066c4c3d 100644 --- a/clients/client-auditmanager/commands/DeregisterOrganizationAdminAccountCommand.ts +++ b/clients/client-auditmanager/commands/DeregisterOrganizationAdminAccountCommand.ts @@ -29,6 +29,20 @@ export interface DeregisterOrganizationAdminAccountCommandOutput *

* Deregisters the delegated AWS administrator account from the AWS organization. *

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { AuditManagerClient, DeregisterOrganizationAdminAccountCommand } from "@aws-sdk/client-auditmanager"; // ES Modules import + * // const { AuditManagerClient, DeregisterOrganizationAdminAccountCommand } = require("@aws-sdk/client-auditmanager"); // CommonJS import + * const client = new AuditManagerClient(config); + * const command = new DeregisterOrganizationAdminAccountCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeregisterOrganizationAdminAccountCommandInput} for command's `input` shape. + * @see {@link DeregisterOrganizationAdminAccountCommandOutput} for command's `response` shape. + * @see {@link AuditManagerClientResolvedConfig | config} for command's `input` shape. + * */ export class DeregisterOrganizationAdminAccountCommand extends $Command< DeregisterOrganizationAdminAccountCommandInput, diff --git a/clients/client-auditmanager/commands/DisassociateAssessmentReportEvidenceFolderCommand.ts b/clients/client-auditmanager/commands/DisassociateAssessmentReportEvidenceFolderCommand.ts index c7d4a05597d7..f75b29ea2eb8 100644 --- a/clients/client-auditmanager/commands/DisassociateAssessmentReportEvidenceFolderCommand.ts +++ b/clients/client-auditmanager/commands/DisassociateAssessmentReportEvidenceFolderCommand.ts @@ -30,6 +30,20 @@ export interface DisassociateAssessmentReportEvidenceFolderCommandOutput *

* Disassociates an evidence folder from the specified assessment report in AWS Audit Manager. *

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { AuditManagerClient, DisassociateAssessmentReportEvidenceFolderCommand } from "@aws-sdk/client-auditmanager"; // ES Modules import + * // const { AuditManagerClient, DisassociateAssessmentReportEvidenceFolderCommand } = require("@aws-sdk/client-auditmanager"); // CommonJS import + * const client = new AuditManagerClient(config); + * const command = new DisassociateAssessmentReportEvidenceFolderCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DisassociateAssessmentReportEvidenceFolderCommandInput} for command's `input` shape. + * @see {@link DisassociateAssessmentReportEvidenceFolderCommandOutput} for command's `response` shape. + * @see {@link AuditManagerClientResolvedConfig | config} for command's `input` shape. + * */ export class DisassociateAssessmentReportEvidenceFolderCommand extends $Command< DisassociateAssessmentReportEvidenceFolderCommandInput, diff --git a/clients/client-auditmanager/commands/GetAccountStatusCommand.ts b/clients/client-auditmanager/commands/GetAccountStatusCommand.ts index b3be1b286c35..c1ecc519d807 100644 --- a/clients/client-auditmanager/commands/GetAccountStatusCommand.ts +++ b/clients/client-auditmanager/commands/GetAccountStatusCommand.ts @@ -24,6 +24,20 @@ export interface GetAccountStatusCommandOutput extends GetAccountStatusResponse, *

* Returns the registration status of an account in AWS Audit Manager. *

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { AuditManagerClient, GetAccountStatusCommand } from "@aws-sdk/client-auditmanager"; // ES Modules import + * // const { AuditManagerClient, GetAccountStatusCommand } = require("@aws-sdk/client-auditmanager"); // CommonJS import + * const client = new AuditManagerClient(config); + * const command = new GetAccountStatusCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetAccountStatusCommandInput} for command's `input` shape. + * @see {@link GetAccountStatusCommandOutput} for command's `response` shape. + * @see {@link AuditManagerClientResolvedConfig | config} for command's `input` shape. + * */ export class GetAccountStatusCommand extends $Command< GetAccountStatusCommandInput, diff --git a/clients/client-auditmanager/commands/GetAssessmentCommand.ts b/clients/client-auditmanager/commands/GetAssessmentCommand.ts index c2c4ac0c6512..d5db05cef589 100644 --- a/clients/client-auditmanager/commands/GetAssessmentCommand.ts +++ b/clients/client-auditmanager/commands/GetAssessmentCommand.ts @@ -24,6 +24,20 @@ export interface GetAssessmentCommandOutput extends GetAssessmentResponse, __Met *

* Returns an assessment from AWS Audit Manager. *

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { AuditManagerClient, GetAssessmentCommand } from "@aws-sdk/client-auditmanager"; // ES Modules import + * // const { AuditManagerClient, GetAssessmentCommand } = require("@aws-sdk/client-auditmanager"); // CommonJS import + * const client = new AuditManagerClient(config); + * const command = new GetAssessmentCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetAssessmentCommandInput} for command's `input` shape. + * @see {@link GetAssessmentCommandOutput} for command's `response` shape. + * @see {@link AuditManagerClientResolvedConfig | config} for command's `input` shape. + * */ export class GetAssessmentCommand extends $Command< GetAssessmentCommandInput, diff --git a/clients/client-auditmanager/commands/GetAssessmentFrameworkCommand.ts b/clients/client-auditmanager/commands/GetAssessmentFrameworkCommand.ts index 6274bb21642d..95b92527a190 100644 --- a/clients/client-auditmanager/commands/GetAssessmentFrameworkCommand.ts +++ b/clients/client-auditmanager/commands/GetAssessmentFrameworkCommand.ts @@ -24,6 +24,20 @@ export interface GetAssessmentFrameworkCommandOutput extends GetAssessmentFramew *

* Returns a framework from AWS Audit Manager. *

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { AuditManagerClient, GetAssessmentFrameworkCommand } from "@aws-sdk/client-auditmanager"; // ES Modules import + * // const { AuditManagerClient, GetAssessmentFrameworkCommand } = require("@aws-sdk/client-auditmanager"); // CommonJS import + * const client = new AuditManagerClient(config); + * const command = new GetAssessmentFrameworkCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetAssessmentFrameworkCommandInput} for command's `input` shape. + * @see {@link GetAssessmentFrameworkCommandOutput} for command's `response` shape. + * @see {@link AuditManagerClientResolvedConfig | config} for command's `input` shape. + * */ export class GetAssessmentFrameworkCommand extends $Command< GetAssessmentFrameworkCommandInput, diff --git a/clients/client-auditmanager/commands/GetAssessmentReportUrlCommand.ts b/clients/client-auditmanager/commands/GetAssessmentReportUrlCommand.ts index de83b6887bef..f00cc94e3187 100644 --- a/clients/client-auditmanager/commands/GetAssessmentReportUrlCommand.ts +++ b/clients/client-auditmanager/commands/GetAssessmentReportUrlCommand.ts @@ -24,6 +24,20 @@ export interface GetAssessmentReportUrlCommandOutput extends GetAssessmentReport *

* Returns the URL of a specified assessment report in AWS Audit Manager. *

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { AuditManagerClient, GetAssessmentReportUrlCommand } from "@aws-sdk/client-auditmanager"; // ES Modules import + * // const { AuditManagerClient, GetAssessmentReportUrlCommand } = require("@aws-sdk/client-auditmanager"); // CommonJS import + * const client = new AuditManagerClient(config); + * const command = new GetAssessmentReportUrlCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetAssessmentReportUrlCommandInput} for command's `input` shape. + * @see {@link GetAssessmentReportUrlCommandOutput} for command's `response` shape. + * @see {@link AuditManagerClientResolvedConfig | config} for command's `input` shape. + * */ export class GetAssessmentReportUrlCommand extends $Command< GetAssessmentReportUrlCommandInput, diff --git a/clients/client-auditmanager/commands/GetChangeLogsCommand.ts b/clients/client-auditmanager/commands/GetChangeLogsCommand.ts index e2a50fdd6335..506add1604ec 100644 --- a/clients/client-auditmanager/commands/GetChangeLogsCommand.ts +++ b/clients/client-auditmanager/commands/GetChangeLogsCommand.ts @@ -24,6 +24,20 @@ export interface GetChangeLogsCommandOutput extends GetChangeLogsResponse, __Met *

* Returns a list of changelogs from AWS Audit Manager. *

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { AuditManagerClient, GetChangeLogsCommand } from "@aws-sdk/client-auditmanager"; // ES Modules import + * // const { AuditManagerClient, GetChangeLogsCommand } = require("@aws-sdk/client-auditmanager"); // CommonJS import + * const client = new AuditManagerClient(config); + * const command = new GetChangeLogsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetChangeLogsCommandInput} for command's `input` shape. + * @see {@link GetChangeLogsCommandOutput} for command's `response` shape. + * @see {@link AuditManagerClientResolvedConfig | config} for command's `input` shape. + * */ export class GetChangeLogsCommand extends $Command< GetChangeLogsCommandInput, diff --git a/clients/client-auditmanager/commands/GetControlCommand.ts b/clients/client-auditmanager/commands/GetControlCommand.ts index 0f8b34ca5cb3..23882a8f12df 100644 --- a/clients/client-auditmanager/commands/GetControlCommand.ts +++ b/clients/client-auditmanager/commands/GetControlCommand.ts @@ -24,6 +24,20 @@ export interface GetControlCommandOutput extends GetControlResponse, __MetadataB *

* Returns a control from AWS Audit Manager. *

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { AuditManagerClient, GetControlCommand } from "@aws-sdk/client-auditmanager"; // ES Modules import + * // const { AuditManagerClient, GetControlCommand } = require("@aws-sdk/client-auditmanager"); // CommonJS import + * const client = new AuditManagerClient(config); + * const command = new GetControlCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetControlCommandInput} for command's `input` shape. + * @see {@link GetControlCommandOutput} for command's `response` shape. + * @see {@link AuditManagerClientResolvedConfig | config} for command's `input` shape. + * */ export class GetControlCommand extends $Command< GetControlCommandInput, diff --git a/clients/client-auditmanager/commands/GetDelegationsCommand.ts b/clients/client-auditmanager/commands/GetDelegationsCommand.ts index 90a09d817811..fa4379de079c 100644 --- a/clients/client-auditmanager/commands/GetDelegationsCommand.ts +++ b/clients/client-auditmanager/commands/GetDelegationsCommand.ts @@ -24,6 +24,20 @@ export interface GetDelegationsCommandOutput extends GetDelegationsResponse, __M *

* Returns a list of delegations from an audit owner to a delegate. *

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { AuditManagerClient, GetDelegationsCommand } from "@aws-sdk/client-auditmanager"; // ES Modules import + * // const { AuditManagerClient, GetDelegationsCommand } = require("@aws-sdk/client-auditmanager"); // CommonJS import + * const client = new AuditManagerClient(config); + * const command = new GetDelegationsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetDelegationsCommandInput} for command's `input` shape. + * @see {@link GetDelegationsCommandOutput} for command's `response` shape. + * @see {@link AuditManagerClientResolvedConfig | config} for command's `input` shape. + * */ export class GetDelegationsCommand extends $Command< GetDelegationsCommandInput, diff --git a/clients/client-auditmanager/commands/GetEvidenceByEvidenceFolderCommand.ts b/clients/client-auditmanager/commands/GetEvidenceByEvidenceFolderCommand.ts index b8070b0e57dd..1eb27b841ed1 100644 --- a/clients/client-auditmanager/commands/GetEvidenceByEvidenceFolderCommand.ts +++ b/clients/client-auditmanager/commands/GetEvidenceByEvidenceFolderCommand.ts @@ -26,6 +26,20 @@ export interface GetEvidenceByEvidenceFolderCommandOutput *

* Returns all evidence from a specified evidence folder in AWS Audit Manager. *

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { AuditManagerClient, GetEvidenceByEvidenceFolderCommand } from "@aws-sdk/client-auditmanager"; // ES Modules import + * // const { AuditManagerClient, GetEvidenceByEvidenceFolderCommand } = require("@aws-sdk/client-auditmanager"); // CommonJS import + * const client = new AuditManagerClient(config); + * const command = new GetEvidenceByEvidenceFolderCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetEvidenceByEvidenceFolderCommandInput} for command's `input` shape. + * @see {@link GetEvidenceByEvidenceFolderCommandOutput} for command's `response` shape. + * @see {@link AuditManagerClientResolvedConfig | config} for command's `input` shape. + * */ export class GetEvidenceByEvidenceFolderCommand extends $Command< GetEvidenceByEvidenceFolderCommandInput, diff --git a/clients/client-auditmanager/commands/GetEvidenceCommand.ts b/clients/client-auditmanager/commands/GetEvidenceCommand.ts index 0ce01acec3cb..ec0ac00f2fa3 100644 --- a/clients/client-auditmanager/commands/GetEvidenceCommand.ts +++ b/clients/client-auditmanager/commands/GetEvidenceCommand.ts @@ -24,6 +24,20 @@ export interface GetEvidenceCommandOutput extends GetEvidenceResponse, __Metadat *

* Returns evidence from AWS Audit Manager. *

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { AuditManagerClient, GetEvidenceCommand } from "@aws-sdk/client-auditmanager"; // ES Modules import + * // const { AuditManagerClient, GetEvidenceCommand } = require("@aws-sdk/client-auditmanager"); // CommonJS import + * const client = new AuditManagerClient(config); + * const command = new GetEvidenceCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetEvidenceCommandInput} for command's `input` shape. + * @see {@link GetEvidenceCommandOutput} for command's `response` shape. + * @see {@link AuditManagerClientResolvedConfig | config} for command's `input` shape. + * */ export class GetEvidenceCommand extends $Command< GetEvidenceCommandInput, diff --git a/clients/client-auditmanager/commands/GetEvidenceFolderCommand.ts b/clients/client-auditmanager/commands/GetEvidenceFolderCommand.ts index a4b11549b467..bac128422db6 100644 --- a/clients/client-auditmanager/commands/GetEvidenceFolderCommand.ts +++ b/clients/client-auditmanager/commands/GetEvidenceFolderCommand.ts @@ -24,6 +24,20 @@ export interface GetEvidenceFolderCommandOutput extends GetEvidenceFolderRespons *

* Returns an evidence folder from the specified assessment in AWS Audit Manager. *

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { AuditManagerClient, GetEvidenceFolderCommand } from "@aws-sdk/client-auditmanager"; // ES Modules import + * // const { AuditManagerClient, GetEvidenceFolderCommand } = require("@aws-sdk/client-auditmanager"); // CommonJS import + * const client = new AuditManagerClient(config); + * const command = new GetEvidenceFolderCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetEvidenceFolderCommandInput} for command's `input` shape. + * @see {@link GetEvidenceFolderCommandOutput} for command's `response` shape. + * @see {@link AuditManagerClientResolvedConfig | config} for command's `input` shape. + * */ export class GetEvidenceFolderCommand extends $Command< GetEvidenceFolderCommandInput, diff --git a/clients/client-auditmanager/commands/GetEvidenceFoldersByAssessmentCommand.ts b/clients/client-auditmanager/commands/GetEvidenceFoldersByAssessmentCommand.ts index 35683e60cef5..1557dc797811 100644 --- a/clients/client-auditmanager/commands/GetEvidenceFoldersByAssessmentCommand.ts +++ b/clients/client-auditmanager/commands/GetEvidenceFoldersByAssessmentCommand.ts @@ -26,6 +26,20 @@ export interface GetEvidenceFoldersByAssessmentCommandOutput *

* Returns the evidence folders from a specified assessment in AWS Audit Manager. *

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { AuditManagerClient, GetEvidenceFoldersByAssessmentCommand } from "@aws-sdk/client-auditmanager"; // ES Modules import + * // const { AuditManagerClient, GetEvidenceFoldersByAssessmentCommand } = require("@aws-sdk/client-auditmanager"); // CommonJS import + * const client = new AuditManagerClient(config); + * const command = new GetEvidenceFoldersByAssessmentCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetEvidenceFoldersByAssessmentCommandInput} for command's `input` shape. + * @see {@link GetEvidenceFoldersByAssessmentCommandOutput} for command's `response` shape. + * @see {@link AuditManagerClientResolvedConfig | config} for command's `input` shape. + * */ export class GetEvidenceFoldersByAssessmentCommand extends $Command< GetEvidenceFoldersByAssessmentCommandInput, diff --git a/clients/client-auditmanager/commands/GetEvidenceFoldersByAssessmentControlCommand.ts b/clients/client-auditmanager/commands/GetEvidenceFoldersByAssessmentControlCommand.ts index c1a2ad63fb04..a524a61173d9 100644 --- a/clients/client-auditmanager/commands/GetEvidenceFoldersByAssessmentControlCommand.ts +++ b/clients/client-auditmanager/commands/GetEvidenceFoldersByAssessmentControlCommand.ts @@ -30,6 +30,20 @@ export interface GetEvidenceFoldersByAssessmentControlCommandOutput *

* Returns a list of evidence folders associated with a specified control of an assessment in AWS Audit Manager. *

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { AuditManagerClient, GetEvidenceFoldersByAssessmentControlCommand } from "@aws-sdk/client-auditmanager"; // ES Modules import + * // const { AuditManagerClient, GetEvidenceFoldersByAssessmentControlCommand } = require("@aws-sdk/client-auditmanager"); // CommonJS import + * const client = new AuditManagerClient(config); + * const command = new GetEvidenceFoldersByAssessmentControlCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetEvidenceFoldersByAssessmentControlCommandInput} for command's `input` shape. + * @see {@link GetEvidenceFoldersByAssessmentControlCommandOutput} for command's `response` shape. + * @see {@link AuditManagerClientResolvedConfig | config} for command's `input` shape. + * */ export class GetEvidenceFoldersByAssessmentControlCommand extends $Command< GetEvidenceFoldersByAssessmentControlCommandInput, diff --git a/clients/client-auditmanager/commands/GetOrganizationAdminAccountCommand.ts b/clients/client-auditmanager/commands/GetOrganizationAdminAccountCommand.ts index a10fcb25ce5b..96d9b955e29e 100644 --- a/clients/client-auditmanager/commands/GetOrganizationAdminAccountCommand.ts +++ b/clients/client-auditmanager/commands/GetOrganizationAdminAccountCommand.ts @@ -26,6 +26,20 @@ export interface GetOrganizationAdminAccountCommandOutput *

* Returns the name of the delegated AWS administrator account for the AWS organization. *

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { AuditManagerClient, GetOrganizationAdminAccountCommand } from "@aws-sdk/client-auditmanager"; // ES Modules import + * // const { AuditManagerClient, GetOrganizationAdminAccountCommand } = require("@aws-sdk/client-auditmanager"); // CommonJS import + * const client = new AuditManagerClient(config); + * const command = new GetOrganizationAdminAccountCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetOrganizationAdminAccountCommandInput} for command's `input` shape. + * @see {@link GetOrganizationAdminAccountCommandOutput} for command's `response` shape. + * @see {@link AuditManagerClientResolvedConfig | config} for command's `input` shape. + * */ export class GetOrganizationAdminAccountCommand extends $Command< GetOrganizationAdminAccountCommandInput, diff --git a/clients/client-auditmanager/commands/GetServicesInScopeCommand.ts b/clients/client-auditmanager/commands/GetServicesInScopeCommand.ts index bfc337f3bfdf..6b7ddede1db6 100644 --- a/clients/client-auditmanager/commands/GetServicesInScopeCommand.ts +++ b/clients/client-auditmanager/commands/GetServicesInScopeCommand.ts @@ -24,6 +24,20 @@ export interface GetServicesInScopeCommandOutput extends GetServicesInScopeRespo *

* Returns a list of the in-scope AWS services for the specified assessment. *

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { AuditManagerClient, GetServicesInScopeCommand } from "@aws-sdk/client-auditmanager"; // ES Modules import + * // const { AuditManagerClient, GetServicesInScopeCommand } = require("@aws-sdk/client-auditmanager"); // CommonJS import + * const client = new AuditManagerClient(config); + * const command = new GetServicesInScopeCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetServicesInScopeCommandInput} for command's `input` shape. + * @see {@link GetServicesInScopeCommandOutput} for command's `response` shape. + * @see {@link AuditManagerClientResolvedConfig | config} for command's `input` shape. + * */ export class GetServicesInScopeCommand extends $Command< GetServicesInScopeCommandInput, diff --git a/clients/client-auditmanager/commands/GetSettingsCommand.ts b/clients/client-auditmanager/commands/GetSettingsCommand.ts index 71b304b131fd..b3883b90c52a 100644 --- a/clients/client-auditmanager/commands/GetSettingsCommand.ts +++ b/clients/client-auditmanager/commands/GetSettingsCommand.ts @@ -24,6 +24,20 @@ export interface GetSettingsCommandOutput extends GetSettingsResponse, __Metadat *

* Returns the settings for the specified AWS account. *

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { AuditManagerClient, GetSettingsCommand } from "@aws-sdk/client-auditmanager"; // ES Modules import + * // const { AuditManagerClient, GetSettingsCommand } = require("@aws-sdk/client-auditmanager"); // CommonJS import + * const client = new AuditManagerClient(config); + * const command = new GetSettingsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetSettingsCommandInput} for command's `input` shape. + * @see {@link GetSettingsCommandOutput} for command's `response` shape. + * @see {@link AuditManagerClientResolvedConfig | config} for command's `input` shape. + * */ export class GetSettingsCommand extends $Command< GetSettingsCommandInput, diff --git a/clients/client-auditmanager/commands/ListAssessmentFrameworksCommand.ts b/clients/client-auditmanager/commands/ListAssessmentFrameworksCommand.ts index e484dc8e99ac..3a27bd071063 100644 --- a/clients/client-auditmanager/commands/ListAssessmentFrameworksCommand.ts +++ b/clients/client-auditmanager/commands/ListAssessmentFrameworksCommand.ts @@ -24,6 +24,20 @@ export interface ListAssessmentFrameworksCommandOutput extends ListAssessmentFra *

* Returns a list of the frameworks available in the AWS Audit Manager framework library. *

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { AuditManagerClient, ListAssessmentFrameworksCommand } from "@aws-sdk/client-auditmanager"; // ES Modules import + * // const { AuditManagerClient, ListAssessmentFrameworksCommand } = require("@aws-sdk/client-auditmanager"); // CommonJS import + * const client = new AuditManagerClient(config); + * const command = new ListAssessmentFrameworksCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListAssessmentFrameworksCommandInput} for command's `input` shape. + * @see {@link ListAssessmentFrameworksCommandOutput} for command's `response` shape. + * @see {@link AuditManagerClientResolvedConfig | config} for command's `input` shape. + * */ export class ListAssessmentFrameworksCommand extends $Command< ListAssessmentFrameworksCommandInput, diff --git a/clients/client-auditmanager/commands/ListAssessmentReportsCommand.ts b/clients/client-auditmanager/commands/ListAssessmentReportsCommand.ts index d7498a23a316..46ba57808f33 100644 --- a/clients/client-auditmanager/commands/ListAssessmentReportsCommand.ts +++ b/clients/client-auditmanager/commands/ListAssessmentReportsCommand.ts @@ -24,6 +24,20 @@ export interface ListAssessmentReportsCommandOutput extends ListAssessmentReport *

* Returns a list of assessment reports created in AWS Audit Manager. *

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { AuditManagerClient, ListAssessmentReportsCommand } from "@aws-sdk/client-auditmanager"; // ES Modules import + * // const { AuditManagerClient, ListAssessmentReportsCommand } = require("@aws-sdk/client-auditmanager"); // CommonJS import + * const client = new AuditManagerClient(config); + * const command = new ListAssessmentReportsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListAssessmentReportsCommandInput} for command's `input` shape. + * @see {@link ListAssessmentReportsCommandOutput} for command's `response` shape. + * @see {@link AuditManagerClientResolvedConfig | config} for command's `input` shape. + * */ export class ListAssessmentReportsCommand extends $Command< ListAssessmentReportsCommandInput, diff --git a/clients/client-auditmanager/commands/ListAssessmentsCommand.ts b/clients/client-auditmanager/commands/ListAssessmentsCommand.ts index 22303985ab47..2bce6635ed03 100644 --- a/clients/client-auditmanager/commands/ListAssessmentsCommand.ts +++ b/clients/client-auditmanager/commands/ListAssessmentsCommand.ts @@ -24,6 +24,20 @@ export interface ListAssessmentsCommandOutput extends ListAssessmentsResponse, _ *

* Returns a list of current and past assessments from AWS Audit Manager. *

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { AuditManagerClient, ListAssessmentsCommand } from "@aws-sdk/client-auditmanager"; // ES Modules import + * // const { AuditManagerClient, ListAssessmentsCommand } = require("@aws-sdk/client-auditmanager"); // CommonJS import + * const client = new AuditManagerClient(config); + * const command = new ListAssessmentsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListAssessmentsCommandInput} for command's `input` shape. + * @see {@link ListAssessmentsCommandOutput} for command's `response` shape. + * @see {@link AuditManagerClientResolvedConfig | config} for command's `input` shape. + * */ export class ListAssessmentsCommand extends $Command< ListAssessmentsCommandInput, diff --git a/clients/client-auditmanager/commands/ListControlsCommand.ts b/clients/client-auditmanager/commands/ListControlsCommand.ts index da324890aab6..5cd498790302 100644 --- a/clients/client-auditmanager/commands/ListControlsCommand.ts +++ b/clients/client-auditmanager/commands/ListControlsCommand.ts @@ -24,6 +24,20 @@ export interface ListControlsCommandOutput extends ListControlsResponse, __Metad *

* Returns a list of controls from AWS Audit Manager. *

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { AuditManagerClient, ListControlsCommand } from "@aws-sdk/client-auditmanager"; // ES Modules import + * // const { AuditManagerClient, ListControlsCommand } = require("@aws-sdk/client-auditmanager"); // CommonJS import + * const client = new AuditManagerClient(config); + * const command = new ListControlsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListControlsCommandInput} for command's `input` shape. + * @see {@link ListControlsCommandOutput} for command's `response` shape. + * @see {@link AuditManagerClientResolvedConfig | config} for command's `input` shape. + * */ export class ListControlsCommand extends $Command< ListControlsCommandInput, diff --git a/clients/client-auditmanager/commands/ListKeywordsForDataSourceCommand.ts b/clients/client-auditmanager/commands/ListKeywordsForDataSourceCommand.ts index 6859c6a489c3..520e6e72b48e 100644 --- a/clients/client-auditmanager/commands/ListKeywordsForDataSourceCommand.ts +++ b/clients/client-auditmanager/commands/ListKeywordsForDataSourceCommand.ts @@ -24,6 +24,20 @@ export interface ListKeywordsForDataSourceCommandOutput extends ListKeywordsForD *

* Returns a list of keywords that pre-mapped to the specified control data source. *

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { AuditManagerClient, ListKeywordsForDataSourceCommand } from "@aws-sdk/client-auditmanager"; // ES Modules import + * // const { AuditManagerClient, ListKeywordsForDataSourceCommand } = require("@aws-sdk/client-auditmanager"); // CommonJS import + * const client = new AuditManagerClient(config); + * const command = new ListKeywordsForDataSourceCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListKeywordsForDataSourceCommandInput} for command's `input` shape. + * @see {@link ListKeywordsForDataSourceCommandOutput} for command's `response` shape. + * @see {@link AuditManagerClientResolvedConfig | config} for command's `input` shape. + * */ export class ListKeywordsForDataSourceCommand extends $Command< ListKeywordsForDataSourceCommandInput, diff --git a/clients/client-auditmanager/commands/ListNotificationsCommand.ts b/clients/client-auditmanager/commands/ListNotificationsCommand.ts index 96d99e6dbdb8..39383a6696d6 100644 --- a/clients/client-auditmanager/commands/ListNotificationsCommand.ts +++ b/clients/client-auditmanager/commands/ListNotificationsCommand.ts @@ -24,6 +24,20 @@ export interface ListNotificationsCommandOutput extends ListNotificationsRespons *

* Returns a list of all AWS Audit Manager notifications. *

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { AuditManagerClient, ListNotificationsCommand } from "@aws-sdk/client-auditmanager"; // ES Modules import + * // const { AuditManagerClient, ListNotificationsCommand } = require("@aws-sdk/client-auditmanager"); // CommonJS import + * const client = new AuditManagerClient(config); + * const command = new ListNotificationsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListNotificationsCommandInput} for command's `input` shape. + * @see {@link ListNotificationsCommandOutput} for command's `response` shape. + * @see {@link AuditManagerClientResolvedConfig | config} for command's `input` shape. + * */ export class ListNotificationsCommand extends $Command< ListNotificationsCommandInput, diff --git a/clients/client-auditmanager/commands/ListTagsForResourceCommand.ts b/clients/client-auditmanager/commands/ListTagsForResourceCommand.ts index 9671d3dbf385..d1a4dfe69e73 100644 --- a/clients/client-auditmanager/commands/ListTagsForResourceCommand.ts +++ b/clients/client-auditmanager/commands/ListTagsForResourceCommand.ts @@ -24,6 +24,20 @@ export interface ListTagsForResourceCommandOutput extends ListTagsForResourceRes *

* Returns a list of tags for the specified resource in AWS Audit Manager. *

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { AuditManagerClient, ListTagsForResourceCommand } from "@aws-sdk/client-auditmanager"; // ES Modules import + * // const { AuditManagerClient, ListTagsForResourceCommand } = require("@aws-sdk/client-auditmanager"); // CommonJS import + * const client = new AuditManagerClient(config); + * const command = new ListTagsForResourceCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListTagsForResourceCommandInput} for command's `input` shape. + * @see {@link ListTagsForResourceCommandOutput} for command's `response` shape. + * @see {@link AuditManagerClientResolvedConfig | config} for command's `input` shape. + * */ export class ListTagsForResourceCommand extends $Command< ListTagsForResourceCommandInput, diff --git a/clients/client-auditmanager/commands/RegisterAccountCommand.ts b/clients/client-auditmanager/commands/RegisterAccountCommand.ts index 8b2d64148abc..822e560b3fc8 100644 --- a/clients/client-auditmanager/commands/RegisterAccountCommand.ts +++ b/clients/client-auditmanager/commands/RegisterAccountCommand.ts @@ -24,6 +24,20 @@ export interface RegisterAccountCommandOutput extends RegisterAccountResponse, _ *

* Enables AWS Audit Manager for the specified AWS account. *

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { AuditManagerClient, RegisterAccountCommand } from "@aws-sdk/client-auditmanager"; // ES Modules import + * // const { AuditManagerClient, RegisterAccountCommand } = require("@aws-sdk/client-auditmanager"); // CommonJS import + * const client = new AuditManagerClient(config); + * const command = new RegisterAccountCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link RegisterAccountCommandInput} for command's `input` shape. + * @see {@link RegisterAccountCommandOutput} for command's `response` shape. + * @see {@link AuditManagerClientResolvedConfig | config} for command's `input` shape. + * */ export class RegisterAccountCommand extends $Command< RegisterAccountCommandInput, diff --git a/clients/client-auditmanager/commands/RegisterOrganizationAdminAccountCommand.ts b/clients/client-auditmanager/commands/RegisterOrganizationAdminAccountCommand.ts index 87d708efd29f..1f34c74680c0 100644 --- a/clients/client-auditmanager/commands/RegisterOrganizationAdminAccountCommand.ts +++ b/clients/client-auditmanager/commands/RegisterOrganizationAdminAccountCommand.ts @@ -26,6 +26,20 @@ export interface RegisterOrganizationAdminAccountCommandOutput *

* Enables an AWS account within the organization as the delegated administrator for AWS Audit Manager. *

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { AuditManagerClient, RegisterOrganizationAdminAccountCommand } from "@aws-sdk/client-auditmanager"; // ES Modules import + * // const { AuditManagerClient, RegisterOrganizationAdminAccountCommand } = require("@aws-sdk/client-auditmanager"); // CommonJS import + * const client = new AuditManagerClient(config); + * const command = new RegisterOrganizationAdminAccountCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link RegisterOrganizationAdminAccountCommandInput} for command's `input` shape. + * @see {@link RegisterOrganizationAdminAccountCommandOutput} for command's `response` shape. + * @see {@link AuditManagerClientResolvedConfig | config} for command's `input` shape. + * */ export class RegisterOrganizationAdminAccountCommand extends $Command< RegisterOrganizationAdminAccountCommandInput, diff --git a/clients/client-auditmanager/commands/TagResourceCommand.ts b/clients/client-auditmanager/commands/TagResourceCommand.ts index 85253aacb7b5..5e3bdae02bdd 100644 --- a/clients/client-auditmanager/commands/TagResourceCommand.ts +++ b/clients/client-auditmanager/commands/TagResourceCommand.ts @@ -24,6 +24,20 @@ export interface TagResourceCommandOutput extends TagResourceResponse, __Metadat *

* Tags the specified resource in AWS Audit Manager. *

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { AuditManagerClient, TagResourceCommand } from "@aws-sdk/client-auditmanager"; // ES Modules import + * // const { AuditManagerClient, TagResourceCommand } = require("@aws-sdk/client-auditmanager"); // CommonJS import + * const client = new AuditManagerClient(config); + * const command = new TagResourceCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link TagResourceCommandInput} for command's `input` shape. + * @see {@link TagResourceCommandOutput} for command's `response` shape. + * @see {@link AuditManagerClientResolvedConfig | config} for command's `input` shape. + * */ export class TagResourceCommand extends $Command< TagResourceCommandInput, diff --git a/clients/client-auditmanager/commands/UntagResourceCommand.ts b/clients/client-auditmanager/commands/UntagResourceCommand.ts index 62dc0738c7e3..0eb357986424 100644 --- a/clients/client-auditmanager/commands/UntagResourceCommand.ts +++ b/clients/client-auditmanager/commands/UntagResourceCommand.ts @@ -24,6 +24,20 @@ export interface UntagResourceCommandOutput extends UntagResourceResponse, __Met *

* Removes a tag from a resource in AWS Audit Manager. *

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { AuditManagerClient, UntagResourceCommand } from "@aws-sdk/client-auditmanager"; // ES Modules import + * // const { AuditManagerClient, UntagResourceCommand } = require("@aws-sdk/client-auditmanager"); // CommonJS import + * const client = new AuditManagerClient(config); + * const command = new UntagResourceCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link UntagResourceCommandInput} for command's `input` shape. + * @see {@link UntagResourceCommandOutput} for command's `response` shape. + * @see {@link AuditManagerClientResolvedConfig | config} for command's `input` shape. + * */ export class UntagResourceCommand extends $Command< UntagResourceCommandInput, diff --git a/clients/client-auditmanager/commands/UpdateAssessmentCommand.ts b/clients/client-auditmanager/commands/UpdateAssessmentCommand.ts index cd562dff7ae5..a9a4f95befda 100644 --- a/clients/client-auditmanager/commands/UpdateAssessmentCommand.ts +++ b/clients/client-auditmanager/commands/UpdateAssessmentCommand.ts @@ -24,6 +24,20 @@ export interface UpdateAssessmentCommandOutput extends UpdateAssessmentResponse, *

* Edits an AWS Audit Manager assessment. *

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { AuditManagerClient, UpdateAssessmentCommand } from "@aws-sdk/client-auditmanager"; // ES Modules import + * // const { AuditManagerClient, UpdateAssessmentCommand } = require("@aws-sdk/client-auditmanager"); // CommonJS import + * const client = new AuditManagerClient(config); + * const command = new UpdateAssessmentCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link UpdateAssessmentCommandInput} for command's `input` shape. + * @see {@link UpdateAssessmentCommandOutput} for command's `response` shape. + * @see {@link AuditManagerClientResolvedConfig | config} for command's `input` shape. + * */ export class UpdateAssessmentCommand extends $Command< UpdateAssessmentCommandInput, diff --git a/clients/client-auditmanager/commands/UpdateAssessmentControlCommand.ts b/clients/client-auditmanager/commands/UpdateAssessmentControlCommand.ts index f4b9d4652dc4..371f557f1f4a 100644 --- a/clients/client-auditmanager/commands/UpdateAssessmentControlCommand.ts +++ b/clients/client-auditmanager/commands/UpdateAssessmentControlCommand.ts @@ -24,6 +24,20 @@ export interface UpdateAssessmentControlCommandOutput extends UpdateAssessmentCo *

* Updates a control within an assessment in AWS Audit Manager. *

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { AuditManagerClient, UpdateAssessmentControlCommand } from "@aws-sdk/client-auditmanager"; // ES Modules import + * // const { AuditManagerClient, UpdateAssessmentControlCommand } = require("@aws-sdk/client-auditmanager"); // CommonJS import + * const client = new AuditManagerClient(config); + * const command = new UpdateAssessmentControlCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link UpdateAssessmentControlCommandInput} for command's `input` shape. + * @see {@link UpdateAssessmentControlCommandOutput} for command's `response` shape. + * @see {@link AuditManagerClientResolvedConfig | config} for command's `input` shape. + * */ export class UpdateAssessmentControlCommand extends $Command< UpdateAssessmentControlCommandInput, diff --git a/clients/client-auditmanager/commands/UpdateAssessmentControlSetStatusCommand.ts b/clients/client-auditmanager/commands/UpdateAssessmentControlSetStatusCommand.ts index 797ea510d89d..69009643ead9 100644 --- a/clients/client-auditmanager/commands/UpdateAssessmentControlSetStatusCommand.ts +++ b/clients/client-auditmanager/commands/UpdateAssessmentControlSetStatusCommand.ts @@ -26,6 +26,20 @@ export interface UpdateAssessmentControlSetStatusCommandOutput *

* Updates the status of a control set in an AWS Audit Manager assessment. *

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { AuditManagerClient, UpdateAssessmentControlSetStatusCommand } from "@aws-sdk/client-auditmanager"; // ES Modules import + * // const { AuditManagerClient, UpdateAssessmentControlSetStatusCommand } = require("@aws-sdk/client-auditmanager"); // CommonJS import + * const client = new AuditManagerClient(config); + * const command = new UpdateAssessmentControlSetStatusCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link UpdateAssessmentControlSetStatusCommandInput} for command's `input` shape. + * @see {@link UpdateAssessmentControlSetStatusCommandOutput} for command's `response` shape. + * @see {@link AuditManagerClientResolvedConfig | config} for command's `input` shape. + * */ export class UpdateAssessmentControlSetStatusCommand extends $Command< UpdateAssessmentControlSetStatusCommandInput, diff --git a/clients/client-auditmanager/commands/UpdateAssessmentFrameworkCommand.ts b/clients/client-auditmanager/commands/UpdateAssessmentFrameworkCommand.ts index ac75f0c2a98a..69fc88d4703d 100644 --- a/clients/client-auditmanager/commands/UpdateAssessmentFrameworkCommand.ts +++ b/clients/client-auditmanager/commands/UpdateAssessmentFrameworkCommand.ts @@ -24,6 +24,20 @@ export interface UpdateAssessmentFrameworkCommandOutput extends UpdateAssessment *

* Updates a custom framework in AWS Audit Manager. *

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { AuditManagerClient, UpdateAssessmentFrameworkCommand } from "@aws-sdk/client-auditmanager"; // ES Modules import + * // const { AuditManagerClient, UpdateAssessmentFrameworkCommand } = require("@aws-sdk/client-auditmanager"); // CommonJS import + * const client = new AuditManagerClient(config); + * const command = new UpdateAssessmentFrameworkCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link UpdateAssessmentFrameworkCommandInput} for command's `input` shape. + * @see {@link UpdateAssessmentFrameworkCommandOutput} for command's `response` shape. + * @see {@link AuditManagerClientResolvedConfig | config} for command's `input` shape. + * */ export class UpdateAssessmentFrameworkCommand extends $Command< UpdateAssessmentFrameworkCommandInput, diff --git a/clients/client-auditmanager/commands/UpdateAssessmentStatusCommand.ts b/clients/client-auditmanager/commands/UpdateAssessmentStatusCommand.ts index 54ec6f131d2f..b943ad13c520 100644 --- a/clients/client-auditmanager/commands/UpdateAssessmentStatusCommand.ts +++ b/clients/client-auditmanager/commands/UpdateAssessmentStatusCommand.ts @@ -24,6 +24,20 @@ export interface UpdateAssessmentStatusCommandOutput extends UpdateAssessmentSta *

* Updates the status of an assessment in AWS Audit Manager. *

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { AuditManagerClient, UpdateAssessmentStatusCommand } from "@aws-sdk/client-auditmanager"; // ES Modules import + * // const { AuditManagerClient, UpdateAssessmentStatusCommand } = require("@aws-sdk/client-auditmanager"); // CommonJS import + * const client = new AuditManagerClient(config); + * const command = new UpdateAssessmentStatusCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link UpdateAssessmentStatusCommandInput} for command's `input` shape. + * @see {@link UpdateAssessmentStatusCommandOutput} for command's `response` shape. + * @see {@link AuditManagerClientResolvedConfig | config} for command's `input` shape. + * */ export class UpdateAssessmentStatusCommand extends $Command< UpdateAssessmentStatusCommandInput, diff --git a/clients/client-auditmanager/commands/UpdateControlCommand.ts b/clients/client-auditmanager/commands/UpdateControlCommand.ts index ecb330b32396..5933d982be09 100644 --- a/clients/client-auditmanager/commands/UpdateControlCommand.ts +++ b/clients/client-auditmanager/commands/UpdateControlCommand.ts @@ -24,6 +24,20 @@ export interface UpdateControlCommandOutput extends UpdateControlResponse, __Met *

* Updates a custom control in AWS Audit Manager. *

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { AuditManagerClient, UpdateControlCommand } from "@aws-sdk/client-auditmanager"; // ES Modules import + * // const { AuditManagerClient, UpdateControlCommand } = require("@aws-sdk/client-auditmanager"); // CommonJS import + * const client = new AuditManagerClient(config); + * const command = new UpdateControlCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link UpdateControlCommandInput} for command's `input` shape. + * @see {@link UpdateControlCommandOutput} for command's `response` shape. + * @see {@link AuditManagerClientResolvedConfig | config} for command's `input` shape. + * */ export class UpdateControlCommand extends $Command< UpdateControlCommandInput, diff --git a/clients/client-auditmanager/commands/UpdateSettingsCommand.ts b/clients/client-auditmanager/commands/UpdateSettingsCommand.ts index fbfa8dbe4a8f..c20d8a39673c 100644 --- a/clients/client-auditmanager/commands/UpdateSettingsCommand.ts +++ b/clients/client-auditmanager/commands/UpdateSettingsCommand.ts @@ -24,6 +24,20 @@ export interface UpdateSettingsCommandOutput extends UpdateSettingsResponse, __M *

* Updates AWS Audit Manager settings for the current user account. *

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { AuditManagerClient, UpdateSettingsCommand } from "@aws-sdk/client-auditmanager"; // ES Modules import + * // const { AuditManagerClient, UpdateSettingsCommand } = require("@aws-sdk/client-auditmanager"); // CommonJS import + * const client = new AuditManagerClient(config); + * const command = new UpdateSettingsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link UpdateSettingsCommandInput} for command's `input` shape. + * @see {@link UpdateSettingsCommandOutput} for command's `response` shape. + * @see {@link AuditManagerClientResolvedConfig | config} for command's `input` shape. + * */ export class UpdateSettingsCommand extends $Command< UpdateSettingsCommandInput, diff --git a/clients/client-auditmanager/commands/ValidateAssessmentReportIntegrityCommand.ts b/clients/client-auditmanager/commands/ValidateAssessmentReportIntegrityCommand.ts index 6845150148c9..031ab76386e6 100644 --- a/clients/client-auditmanager/commands/ValidateAssessmentReportIntegrityCommand.ts +++ b/clients/client-auditmanager/commands/ValidateAssessmentReportIntegrityCommand.ts @@ -29,6 +29,20 @@ export interface ValidateAssessmentReportIntegrityCommandOutput *

* Validates the integrity of an assessment report in AWS Audit Manager. *

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { AuditManagerClient, ValidateAssessmentReportIntegrityCommand } from "@aws-sdk/client-auditmanager"; // ES Modules import + * // const { AuditManagerClient, ValidateAssessmentReportIntegrityCommand } = require("@aws-sdk/client-auditmanager"); // CommonJS import + * const client = new AuditManagerClient(config); + * const command = new ValidateAssessmentReportIntegrityCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ValidateAssessmentReportIntegrityCommandInput} for command's `input` shape. + * @see {@link ValidateAssessmentReportIntegrityCommandOutput} for command's `response` shape. + * @see {@link AuditManagerClientResolvedConfig | config} for command's `input` shape. + * */ export class ValidateAssessmentReportIntegrityCommand extends $Command< ValidateAssessmentReportIntegrityCommandInput, diff --git a/clients/client-auditmanager/models/models_0.ts b/clients/client-auditmanager/models/models_0.ts index f1ba9fcf5955..9e747340e2a4 100644 --- a/clients/client-auditmanager/models/models_0.ts +++ b/clients/client-auditmanager/models/models_0.ts @@ -13,6 +13,9 @@ export interface AccessDeniedException extends __SmithyException, $MetadataBeare } export namespace AccessDeniedException { + /** + * @internal + */ export const filterSensitiveLog = (obj: AccessDeniedException): any => ({ ...obj, }); @@ -64,6 +67,9 @@ export interface AWSAccount { } export namespace AWSAccount { + /** + * @internal + */ export const filterSensitiveLog = (obj: AWSAccount): any => ({ ...obj, }); @@ -98,6 +104,9 @@ export interface ControlComment { } export namespace ControlComment { + /** + * @internal + */ export const filterSensitiveLog = (obj: ControlComment): any => ({ ...obj, }); @@ -187,6 +196,9 @@ export interface AssessmentControl { } export namespace AssessmentControl { + /** + * @internal + */ export const filterSensitiveLog = (obj: AssessmentControl): any => ({ ...obj, }); @@ -289,6 +301,9 @@ export interface Delegation { } export namespace Delegation { + /** + * @internal + */ export const filterSensitiveLog = (obj: Delegation): any => ({ ...obj, }); @@ -321,6 +336,9 @@ export interface Role { } export namespace Role { + /** + * @internal + */ export const filterSensitiveLog = (obj: Role): any => ({ ...obj, }); @@ -396,6 +414,9 @@ export interface AssessmentControlSet { } export namespace AssessmentControlSet { + /** + * @internal + */ export const filterSensitiveLog = (obj: AssessmentControlSet): any => ({ ...obj, }); @@ -437,6 +458,9 @@ export interface FrameworkMetadata { } export namespace FrameworkMetadata { + /** + * @internal + */ export const filterSensitiveLog = (obj: FrameworkMetadata): any => ({ ...obj, }); @@ -478,6 +502,9 @@ export interface AssessmentFramework { } export namespace AssessmentFramework { + /** + * @internal + */ export const filterSensitiveLog = (obj: AssessmentFramework): any => ({ ...obj, }); @@ -509,6 +536,9 @@ export interface AssessmentReportsDestination { } export namespace AssessmentReportsDestination { + /** + * @internal + */ export const filterSensitiveLog = (obj: AssessmentReportsDestination): any => ({ ...obj, }); @@ -529,6 +559,9 @@ export interface AWSService { } export namespace AWSService { + /** + * @internal + */ export const filterSensitiveLog = (obj: AWSService): any => ({ ...obj, }); @@ -556,6 +589,9 @@ export interface Scope { } export namespace Scope { + /** + * @internal + */ export const filterSensitiveLog = (obj: Scope): any => ({ ...obj, }); @@ -651,6 +687,9 @@ export interface AssessmentMetadata { } export namespace AssessmentMetadata { + /** + * @internal + */ export const filterSensitiveLog = (obj: AssessmentMetadata): any => ({ ...obj, }); @@ -699,6 +738,9 @@ export interface Assessment { } export namespace Assessment { + /** + * @internal + */ export const filterSensitiveLog = (obj: Assessment): any => ({ ...obj, }); @@ -840,6 +882,9 @@ export interface AssessmentEvidenceFolder { } export namespace AssessmentEvidenceFolder { + /** + * @internal + */ export const filterSensitiveLog = (obj: AssessmentEvidenceFolder): any => ({ ...obj, }); @@ -935,6 +980,9 @@ export interface AssessmentFrameworkMetadata { } export namespace AssessmentFrameworkMetadata { + /** + * @internal + */ export const filterSensitiveLog = (obj: AssessmentFrameworkMetadata): any => ({ ...obj, }); @@ -1004,6 +1052,9 @@ export interface AssessmentMetadataItem { } export namespace AssessmentMetadataItem { + /** + * @internal + */ export const filterSensitiveLog = (obj: AssessmentMetadataItem): any => ({ ...obj, }); @@ -1086,6 +1137,9 @@ export interface AssessmentReport { } export namespace AssessmentReport { + /** + * @internal + */ export const filterSensitiveLog = (obj: AssessmentReport): any => ({ ...obj, }); @@ -1120,6 +1174,9 @@ export interface AssessmentReportEvidenceError { } export namespace AssessmentReportEvidenceError { + /** + * @internal + */ export const filterSensitiveLog = (obj: AssessmentReportEvidenceError): any => ({ ...obj, }); @@ -1188,6 +1245,9 @@ export interface AssessmentReportMetadata { } export namespace AssessmentReportMetadata { + /** + * @internal + */ export const filterSensitiveLog = (obj: AssessmentReportMetadata): any => ({ ...obj, }); @@ -1210,6 +1270,9 @@ export interface AssociateAssessmentReportEvidenceFolderRequest { } export namespace AssociateAssessmentReportEvidenceFolderRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: AssociateAssessmentReportEvidenceFolderRequest): any => ({ ...obj, }); @@ -1218,6 +1281,9 @@ export namespace AssociateAssessmentReportEvidenceFolderRequest { export interface AssociateAssessmentReportEvidenceFolderResponse {} export namespace AssociateAssessmentReportEvidenceFolderResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: AssociateAssessmentReportEvidenceFolderResponse): any => ({ ...obj, }); @@ -1235,6 +1301,9 @@ export interface InternalServerException extends __SmithyException, $MetadataBea } export namespace InternalServerException { + /** + * @internal + */ export const filterSensitiveLog = (obj: InternalServerException): any => ({ ...obj, }); @@ -1265,6 +1334,9 @@ export interface ResourceNotFoundException extends __SmithyException, $MetadataB } export namespace ResourceNotFoundException { + /** + * @internal + */ export const filterSensitiveLog = (obj: ResourceNotFoundException): any => ({ ...obj, }); @@ -1292,6 +1364,9 @@ export interface ValidationExceptionField { } export namespace ValidationExceptionField { + /** + * @internal + */ export const filterSensitiveLog = (obj: ValidationExceptionField): any => ({ ...obj, }); @@ -1329,6 +1404,9 @@ export interface ValidationException extends __SmithyException, $MetadataBearer } export namespace ValidationException { + /** + * @internal + */ export const filterSensitiveLog = (obj: ValidationException): any => ({ ...obj, }); @@ -1358,6 +1436,9 @@ export interface BatchAssociateAssessmentReportEvidenceRequest { } export namespace BatchAssociateAssessmentReportEvidenceRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: BatchAssociateAssessmentReportEvidenceRequest): any => ({ ...obj, }); @@ -1380,6 +1461,9 @@ export interface BatchAssociateAssessmentReportEvidenceResponse { } export namespace BatchAssociateAssessmentReportEvidenceResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: BatchAssociateAssessmentReportEvidenceResponse): any => ({ ...obj, }); @@ -1426,6 +1510,9 @@ export interface CreateDelegationRequest { } export namespace CreateDelegationRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateDelegationRequest): any => ({ ...obj, }); @@ -1448,6 +1535,9 @@ export interface BatchCreateDelegationByAssessmentRequest { } export namespace BatchCreateDelegationByAssessmentRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: BatchCreateDelegationByAssessmentRequest): any => ({ ...obj, }); @@ -1482,6 +1572,9 @@ export interface BatchCreateDelegationByAssessmentError { } export namespace BatchCreateDelegationByAssessmentError { + /** + * @internal + */ export const filterSensitiveLog = (obj: BatchCreateDelegationByAssessmentError): any => ({ ...obj, }); @@ -1504,6 +1597,9 @@ export interface BatchCreateDelegationByAssessmentResponse { } export namespace BatchCreateDelegationByAssessmentResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: BatchCreateDelegationByAssessmentResponse): any => ({ ...obj, }); @@ -1526,6 +1622,9 @@ export interface BatchDeleteDelegationByAssessmentRequest { } export namespace BatchDeleteDelegationByAssessmentRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: BatchDeleteDelegationByAssessmentRequest): any => ({ ...obj, }); @@ -1560,6 +1659,9 @@ export interface BatchDeleteDelegationByAssessmentError { } export namespace BatchDeleteDelegationByAssessmentError { + /** + * @internal + */ export const filterSensitiveLog = (obj: BatchDeleteDelegationByAssessmentError): any => ({ ...obj, }); @@ -1575,6 +1677,9 @@ export interface BatchDeleteDelegationByAssessmentResponse { } export namespace BatchDeleteDelegationByAssessmentResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: BatchDeleteDelegationByAssessmentResponse): any => ({ ...obj, }); @@ -1604,6 +1709,9 @@ export interface BatchDisassociateAssessmentReportEvidenceRequest { } export namespace BatchDisassociateAssessmentReportEvidenceRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: BatchDisassociateAssessmentReportEvidenceRequest): any => ({ ...obj, }); @@ -1626,6 +1734,9 @@ export interface BatchDisassociateAssessmentReportEvidenceResponse { } export namespace BatchDisassociateAssessmentReportEvidenceResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: BatchDisassociateAssessmentReportEvidenceResponse): any => ({ ...obj, }); @@ -1646,6 +1757,9 @@ export interface ManualEvidence { } export namespace ManualEvidence { + /** + * @internal + */ export const filterSensitiveLog = (obj: ManualEvidence): any => ({ ...obj, }); @@ -1683,6 +1797,9 @@ export interface BatchImportEvidenceToAssessmentControlRequest { } export namespace BatchImportEvidenceToAssessmentControlRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: BatchImportEvidenceToAssessmentControlRequest): any => ({ ...obj, }); @@ -1717,6 +1834,9 @@ export interface BatchImportEvidenceToAssessmentControlError { } export namespace BatchImportEvidenceToAssessmentControlError { + /** + * @internal + */ export const filterSensitiveLog = (obj: BatchImportEvidenceToAssessmentControlError): any => ({ ...obj, }); @@ -1732,6 +1852,9 @@ export interface BatchImportEvidenceToAssessmentControlResponse { } export namespace BatchImportEvidenceToAssessmentControlResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: BatchImportEvidenceToAssessmentControlResponse): any => ({ ...obj, }); @@ -1789,6 +1912,9 @@ export interface CreateAssessmentRequest { } export namespace CreateAssessmentRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateAssessmentRequest): any => ({ ...obj, }); @@ -1804,6 +1930,9 @@ export interface CreateAssessmentResponse { } export namespace CreateAssessmentResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateAssessmentResponse): any => ({ ...obj, }); @@ -1824,6 +1953,9 @@ export interface CreateAssessmentFrameworkControl { } export namespace CreateAssessmentFrameworkControl { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateAssessmentFrameworkControl): any => ({ ...obj, }); @@ -1851,6 +1983,9 @@ export interface CreateAssessmentFrameworkControlSet { } export namespace CreateAssessmentFrameworkControlSet { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateAssessmentFrameworkControlSet): any => ({ ...obj, }); @@ -1894,6 +2029,9 @@ export interface CreateAssessmentFrameworkRequest { } export namespace CreateAssessmentFrameworkRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateAssessmentFrameworkRequest): any => ({ ...obj, }); @@ -1931,6 +2069,9 @@ export interface SourceKeyword { } export namespace SourceKeyword { + /** + * @internal + */ export const filterSensitiveLog = (obj: SourceKeyword): any => ({ ...obj, }); @@ -2013,6 +2154,9 @@ export interface ControlMappingSource { } export namespace ControlMappingSource { + /** + * @internal + */ export const filterSensitiveLog = (obj: ControlMappingSource): any => ({ ...obj, }); @@ -2137,6 +2281,9 @@ export interface Control { } export namespace Control { + /** + * @internal + */ export const filterSensitiveLog = (obj: Control): any => ({ ...obj, }); @@ -2171,6 +2318,9 @@ export interface ControlSet { } export namespace ControlSet { + /** + * @internal + */ export const filterSensitiveLog = (obj: ControlSet): any => ({ ...obj, }); @@ -2282,6 +2432,9 @@ export interface Framework { } export namespace Framework { + /** + * @internal + */ export const filterSensitiveLog = (obj: Framework): any => ({ ...obj, }); @@ -2297,6 +2450,9 @@ export interface CreateAssessmentFrameworkResponse { } export namespace CreateAssessmentFrameworkResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateAssessmentFrameworkResponse): any => ({ ...obj, }); @@ -2326,6 +2482,9 @@ export interface CreateAssessmentReportRequest { } export namespace CreateAssessmentReportRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateAssessmentReportRequest): any => ({ ...obj, }); @@ -2341,6 +2500,9 @@ export interface CreateAssessmentReportResponse { } export namespace CreateAssessmentReportResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateAssessmentReportResponse): any => ({ ...obj, }); @@ -2404,6 +2566,9 @@ export interface CreateControlMappingSource { } export namespace CreateControlMappingSource { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateControlMappingSource): any => ({ ...obj, }); @@ -2461,6 +2626,9 @@ export interface CreateControlRequest { } export namespace CreateControlRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateControlRequest): any => ({ ...obj, }); @@ -2476,6 +2644,9 @@ export interface CreateControlResponse { } export namespace CreateControlResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateControlResponse): any => ({ ...obj, }); @@ -2491,6 +2662,9 @@ export interface DeleteAssessmentRequest { } export namespace DeleteAssessmentRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteAssessmentRequest): any => ({ ...obj, }); @@ -2499,6 +2673,9 @@ export namespace DeleteAssessmentRequest { export interface DeleteAssessmentResponse {} export namespace DeleteAssessmentResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteAssessmentResponse): any => ({ ...obj, }); @@ -2514,6 +2691,9 @@ export interface DeleteAssessmentFrameworkRequest { } export namespace DeleteAssessmentFrameworkRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteAssessmentFrameworkRequest): any => ({ ...obj, }); @@ -2522,6 +2702,9 @@ export namespace DeleteAssessmentFrameworkRequest { export interface DeleteAssessmentFrameworkResponse {} export namespace DeleteAssessmentFrameworkResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteAssessmentFrameworkResponse): any => ({ ...obj, }); @@ -2544,6 +2727,9 @@ export interface DeleteAssessmentReportRequest { } export namespace DeleteAssessmentReportRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteAssessmentReportRequest): any => ({ ...obj, }); @@ -2552,6 +2738,9 @@ export namespace DeleteAssessmentReportRequest { export interface DeleteAssessmentReportResponse {} export namespace DeleteAssessmentReportResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteAssessmentReportResponse): any => ({ ...obj, }); @@ -2567,6 +2756,9 @@ export interface DeleteControlRequest { } export namespace DeleteControlRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteControlRequest): any => ({ ...obj, }); @@ -2575,6 +2767,9 @@ export namespace DeleteControlRequest { export interface DeleteControlResponse {} export namespace DeleteControlResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteControlResponse): any => ({ ...obj, }); @@ -2583,6 +2778,9 @@ export namespace DeleteControlResponse { export interface DeregisterAccountRequest {} export namespace DeregisterAccountRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeregisterAccountRequest): any => ({ ...obj, }); @@ -2598,6 +2796,9 @@ export interface DeregisterAccountResponse { } export namespace DeregisterAccountResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeregisterAccountResponse): any => ({ ...obj, }); @@ -2613,6 +2814,9 @@ export interface DeregisterOrganizationAdminAccountRequest { } export namespace DeregisterOrganizationAdminAccountRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeregisterOrganizationAdminAccountRequest): any => ({ ...obj, }); @@ -2621,6 +2825,9 @@ export namespace DeregisterOrganizationAdminAccountRequest { export interface DeregisterOrganizationAdminAccountResponse {} export namespace DeregisterOrganizationAdminAccountResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeregisterOrganizationAdminAccountResponse): any => ({ ...obj, }); @@ -2643,6 +2850,9 @@ export interface DisassociateAssessmentReportEvidenceFolderRequest { } export namespace DisassociateAssessmentReportEvidenceFolderRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DisassociateAssessmentReportEvidenceFolderRequest): any => ({ ...obj, }); @@ -2651,6 +2861,9 @@ export namespace DisassociateAssessmentReportEvidenceFolderRequest { export interface DisassociateAssessmentReportEvidenceFolderResponse {} export namespace DisassociateAssessmentReportEvidenceFolderResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DisassociateAssessmentReportEvidenceFolderResponse): any => ({ ...obj, }); @@ -2659,6 +2872,9 @@ export namespace DisassociateAssessmentReportEvidenceFolderResponse { export interface GetAccountStatusRequest {} export namespace GetAccountStatusRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetAccountStatusRequest): any => ({ ...obj, }); @@ -2674,6 +2890,9 @@ export interface GetAccountStatusResponse { } export namespace GetAccountStatusResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetAccountStatusResponse): any => ({ ...obj, }); @@ -2689,6 +2908,9 @@ export interface GetAssessmentRequest { } export namespace GetAssessmentRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetAssessmentRequest): any => ({ ...obj, }); @@ -2711,6 +2933,9 @@ export interface GetAssessmentResponse { } export namespace GetAssessmentResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetAssessmentResponse): any => ({ ...obj, }); @@ -2726,6 +2951,9 @@ export interface GetAssessmentFrameworkRequest { } export namespace GetAssessmentFrameworkRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetAssessmentFrameworkRequest): any => ({ ...obj, }); @@ -2741,6 +2969,9 @@ export interface GetAssessmentFrameworkResponse { } export namespace GetAssessmentFrameworkResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetAssessmentFrameworkResponse): any => ({ ...obj, }); @@ -2763,6 +2994,9 @@ export interface GetAssessmentReportUrlRequest { } export namespace GetAssessmentReportUrlRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetAssessmentReportUrlRequest): any => ({ ...obj, }); @@ -2790,6 +3024,9 @@ export interface URL { } export namespace URL { + /** + * @internal + */ export const filterSensitiveLog = (obj: URL): any => ({ ...obj, }); @@ -2805,6 +3042,9 @@ export interface GetAssessmentReportUrlResponse { } export namespace GetAssessmentReportUrlResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetAssessmentReportUrlResponse): any => ({ ...obj, }); @@ -2849,6 +3089,9 @@ export interface GetChangeLogsRequest { } export namespace GetChangeLogsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetChangeLogsRequest): any => ({ ...obj, }); @@ -2905,6 +3148,9 @@ export interface ChangeLog { } export namespace ChangeLog { + /** + * @internal + */ export const filterSensitiveLog = (obj: ChangeLog): any => ({ ...obj, }); @@ -2927,6 +3173,9 @@ export interface GetChangeLogsResponse { } export namespace GetChangeLogsResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetChangeLogsResponse): any => ({ ...obj, }); @@ -2943,6 +3192,9 @@ export interface GetControlRequest { } export namespace GetControlRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetControlRequest): any => ({ ...obj, }); @@ -2958,6 +3210,9 @@ export interface GetControlResponse { } export namespace GetControlResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetControlResponse): any => ({ ...obj, }); @@ -2980,6 +3235,9 @@ export interface GetDelegationsRequest { } export namespace GetDelegationsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetDelegationsRequest): any => ({ ...obj, }); @@ -3042,6 +3300,9 @@ export interface DelegationMetadata { } export namespace DelegationMetadata { + /** + * @internal + */ export const filterSensitiveLog = (obj: DelegationMetadata): any => ({ ...obj, }); @@ -3064,6 +3325,9 @@ export interface GetDelegationsResponse { } export namespace GetDelegationsResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetDelegationsResponse): any => ({ ...obj, }); @@ -3100,6 +3364,9 @@ export interface GetEvidenceRequest { } export namespace GetEvidenceRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetEvidenceRequest): any => ({ ...obj, }); @@ -3127,6 +3394,9 @@ export interface Resource { } export namespace Resource { + /** + * @internal + */ export const filterSensitiveLog = (obj: Resource): any => ({ ...obj, }); @@ -3245,6 +3515,9 @@ export interface Evidence { } export namespace Evidence { + /** + * @internal + */ export const filterSensitiveLog = (obj: Evidence): any => ({ ...obj, }); @@ -3260,6 +3533,9 @@ export interface GetEvidenceResponse { } export namespace GetEvidenceResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetEvidenceResponse): any => ({ ...obj, }); @@ -3303,6 +3579,9 @@ export interface GetEvidenceByEvidenceFolderRequest { } export namespace GetEvidenceByEvidenceFolderRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetEvidenceByEvidenceFolderRequest): any => ({ ...obj, }); @@ -3325,6 +3604,9 @@ export interface GetEvidenceByEvidenceFolderResponse { } export namespace GetEvidenceByEvidenceFolderResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetEvidenceByEvidenceFolderResponse): any => ({ ...obj, }); @@ -3354,6 +3636,9 @@ export interface GetEvidenceFolderRequest { } export namespace GetEvidenceFolderRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetEvidenceFolderRequest): any => ({ ...obj, }); @@ -3369,6 +3654,9 @@ export interface GetEvidenceFolderResponse { } export namespace GetEvidenceFolderResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetEvidenceFolderResponse): any => ({ ...obj, }); @@ -3398,6 +3686,9 @@ export interface GetEvidenceFoldersByAssessmentRequest { } export namespace GetEvidenceFoldersByAssessmentRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetEvidenceFoldersByAssessmentRequest): any => ({ ...obj, }); @@ -3420,6 +3711,9 @@ export interface GetEvidenceFoldersByAssessmentResponse { } export namespace GetEvidenceFoldersByAssessmentResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetEvidenceFoldersByAssessmentResponse): any => ({ ...obj, }); @@ -3463,6 +3757,9 @@ export interface GetEvidenceFoldersByAssessmentControlRequest { } export namespace GetEvidenceFoldersByAssessmentControlRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetEvidenceFoldersByAssessmentControlRequest): any => ({ ...obj, }); @@ -3485,6 +3782,9 @@ export interface GetEvidenceFoldersByAssessmentControlResponse { } export namespace GetEvidenceFoldersByAssessmentControlResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetEvidenceFoldersByAssessmentControlResponse): any => ({ ...obj, }); @@ -3493,6 +3793,9 @@ export namespace GetEvidenceFoldersByAssessmentControlResponse { export interface GetOrganizationAdminAccountRequest {} export namespace GetOrganizationAdminAccountRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetOrganizationAdminAccountRequest): any => ({ ...obj, }); @@ -3515,6 +3818,9 @@ export interface GetOrganizationAdminAccountResponse { } export namespace GetOrganizationAdminAccountResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetOrganizationAdminAccountResponse): any => ({ ...obj, }); @@ -3523,6 +3829,9 @@ export namespace GetOrganizationAdminAccountResponse { export interface GetServicesInScopeRequest {} export namespace GetServicesInScopeRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetServicesInScopeRequest): any => ({ ...obj, }); @@ -3564,6 +3873,9 @@ export interface ServiceMetadata { } export namespace ServiceMetadata { + /** + * @internal + */ export const filterSensitiveLog = (obj: ServiceMetadata): any => ({ ...obj, }); @@ -3579,6 +3891,9 @@ export interface GetServicesInScopeResponse { } export namespace GetServicesInScopeResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetServicesInScopeResponse): any => ({ ...obj, }); @@ -3602,6 +3917,9 @@ export interface GetSettingsRequest { } export namespace GetSettingsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetSettingsRequest): any => ({ ...obj, }); @@ -3650,6 +3968,9 @@ export interface Settings { } export namespace Settings { + /** + * @internal + */ export const filterSensitiveLog = (obj: Settings): any => ({ ...obj, }); @@ -3665,6 +3986,9 @@ export interface GetSettingsResponse { } export namespace GetSettingsResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetSettingsResponse): any => ({ ...obj, }); @@ -3694,6 +4018,9 @@ export interface ListAssessmentFrameworksRequest { } export namespace ListAssessmentFrameworksRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListAssessmentFrameworksRequest): any => ({ ...obj, }); @@ -3716,6 +4043,9 @@ export interface ListAssessmentFrameworksResponse { } export namespace ListAssessmentFrameworksResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListAssessmentFrameworksResponse): any => ({ ...obj, }); @@ -3738,6 +4068,9 @@ export interface ListAssessmentReportsRequest { } export namespace ListAssessmentReportsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListAssessmentReportsRequest): any => ({ ...obj, }); @@ -3760,6 +4093,9 @@ export interface ListAssessmentReportsResponse { } export namespace ListAssessmentReportsResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListAssessmentReportsResponse): any => ({ ...obj, }); @@ -3782,6 +4118,9 @@ export interface ListAssessmentsRequest { } export namespace ListAssessmentsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListAssessmentsRequest): any => ({ ...obj, }); @@ -3804,6 +4143,9 @@ export interface ListAssessmentsResponse { } export namespace ListAssessmentsResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListAssessmentsResponse): any => ({ ...obj, }); @@ -3833,6 +4175,9 @@ export interface ListControlsRequest { } export namespace ListControlsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListControlsRequest): any => ({ ...obj, }); @@ -3888,6 +4233,9 @@ export interface ControlMetadata { } export namespace ControlMetadata { + /** + * @internal + */ export const filterSensitiveLog = (obj: ControlMetadata): any => ({ ...obj, }); @@ -3910,6 +4258,9 @@ export interface ListControlsResponse { } export namespace ListControlsResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListControlsResponse): any => ({ ...obj, }); @@ -3939,6 +4290,9 @@ export interface ListKeywordsForDataSourceRequest { } export namespace ListKeywordsForDataSourceRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListKeywordsForDataSourceRequest): any => ({ ...obj, }); @@ -3961,6 +4315,9 @@ export interface ListKeywordsForDataSourceResponse { } export namespace ListKeywordsForDataSourceResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListKeywordsForDataSourceResponse): any => ({ ...obj, }); @@ -3983,6 +4340,9 @@ export interface ListNotificationsRequest { } export namespace ListNotificationsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListNotificationsRequest): any => ({ ...obj, }); @@ -4052,6 +4412,9 @@ export interface Notification { } export namespace Notification { + /** + * @internal + */ export const filterSensitiveLog = (obj: Notification): any => ({ ...obj, }); @@ -4074,6 +4437,9 @@ export interface ListNotificationsResponse { } export namespace ListNotificationsResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListNotificationsResponse): any => ({ ...obj, }); @@ -4089,6 +4455,9 @@ export interface ListTagsForResourceRequest { } export namespace ListTagsForResourceRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListTagsForResourceRequest): any => ({ ...obj, }); @@ -4104,6 +4473,9 @@ export interface ListTagsForResourceResponse { } export namespace ListTagsForResourceResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListTagsForResourceResponse): any => ({ ...obj, }); @@ -4126,6 +4498,9 @@ export interface RegisterAccountRequest { } export namespace RegisterAccountRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: RegisterAccountRequest): any => ({ ...obj, }); @@ -4141,6 +4516,9 @@ export interface RegisterAccountResponse { } export namespace RegisterAccountResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: RegisterAccountResponse): any => ({ ...obj, }); @@ -4156,6 +4534,9 @@ export interface RegisterOrganizationAdminAccountRequest { } export namespace RegisterOrganizationAdminAccountRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: RegisterOrganizationAdminAccountRequest): any => ({ ...obj, }); @@ -4178,6 +4559,9 @@ export interface RegisterOrganizationAdminAccountResponse { } export namespace RegisterOrganizationAdminAccountResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: RegisterOrganizationAdminAccountResponse): any => ({ ...obj, }); @@ -4200,6 +4584,9 @@ export interface TagResourceRequest { } export namespace TagResourceRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: TagResourceRequest): any => ({ ...obj, }); @@ -4208,6 +4595,9 @@ export namespace TagResourceRequest { export interface TagResourceResponse {} export namespace TagResourceResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: TagResourceResponse): any => ({ ...obj, }); @@ -4230,6 +4620,9 @@ export interface UntagResourceRequest { } export namespace UntagResourceRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: UntagResourceRequest): any => ({ ...obj, }); @@ -4238,6 +4631,9 @@ export namespace UntagResourceRequest { export interface UntagResourceResponse {} export namespace UntagResourceResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: UntagResourceResponse): any => ({ ...obj, }); @@ -4288,6 +4684,9 @@ export interface UpdateAssessmentRequest { } export namespace UpdateAssessmentRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateAssessmentRequest): any => ({ ...obj, }); @@ -4303,6 +4702,9 @@ export interface UpdateAssessmentResponse { } export namespace UpdateAssessmentResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateAssessmentResponse): any => ({ ...obj, }); @@ -4347,6 +4749,9 @@ export interface UpdateAssessmentControlRequest { } export namespace UpdateAssessmentControlRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateAssessmentControlRequest): any => ({ ...obj, }); @@ -4362,6 +4767,9 @@ export interface UpdateAssessmentControlResponse { } export namespace UpdateAssessmentControlResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateAssessmentControlResponse): any => ({ ...obj, }); @@ -4398,6 +4806,9 @@ export interface UpdateAssessmentControlSetStatusRequest { } export namespace UpdateAssessmentControlSetStatusRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateAssessmentControlSetStatusRequest): any => ({ ...obj, }); @@ -4413,6 +4824,9 @@ export interface UpdateAssessmentControlSetStatusResponse { } export namespace UpdateAssessmentControlSetStatusResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateAssessmentControlSetStatusResponse): any => ({ ...obj, }); @@ -4447,6 +4861,9 @@ export interface UpdateAssessmentFrameworkControlSet { } export namespace UpdateAssessmentFrameworkControlSet { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateAssessmentFrameworkControlSet): any => ({ ...obj, }); @@ -4490,6 +4907,9 @@ export interface UpdateAssessmentFrameworkRequest { } export namespace UpdateAssessmentFrameworkRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateAssessmentFrameworkRequest): any => ({ ...obj, }); @@ -4505,6 +4925,9 @@ export interface UpdateAssessmentFrameworkResponse { } export namespace UpdateAssessmentFrameworkResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateAssessmentFrameworkResponse): any => ({ ...obj, }); @@ -4527,6 +4950,9 @@ export interface UpdateAssessmentStatusRequest { } export namespace UpdateAssessmentStatusRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateAssessmentStatusRequest): any => ({ ...obj, }); @@ -4542,6 +4968,9 @@ export interface UpdateAssessmentStatusResponse { } export namespace UpdateAssessmentStatusResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateAssessmentStatusResponse): any => ({ ...obj, }); @@ -4600,6 +5029,9 @@ export interface UpdateControlRequest { } export namespace UpdateControlRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateControlRequest): any => ({ ...obj, }); @@ -4615,6 +5047,9 @@ export interface UpdateControlResponse { } export namespace UpdateControlResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateControlResponse): any => ({ ...obj, }); @@ -4651,6 +5086,9 @@ export interface UpdateSettingsRequest { } export namespace UpdateSettingsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateSettingsRequest): any => ({ ...obj, }); @@ -4666,6 +5104,9 @@ export interface UpdateSettingsResponse { } export namespace UpdateSettingsResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateSettingsResponse): any => ({ ...obj, }); @@ -4681,6 +5122,9 @@ export interface ValidateAssessmentReportIntegrityRequest { } export namespace ValidateAssessmentReportIntegrityRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ValidateAssessmentReportIntegrityRequest): any => ({ ...obj, }); @@ -4724,6 +5168,9 @@ export interface ValidateAssessmentReportIntegrityResponse { } export namespace ValidateAssessmentReportIntegrityResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ValidateAssessmentReportIntegrityResponse): any => ({ ...obj, }); diff --git a/clients/client-auto-scaling-plans/commands/CreateScalingPlanCommand.ts b/clients/client-auto-scaling-plans/commands/CreateScalingPlanCommand.ts index 1220fb5c30ee..2285c6546106 100644 --- a/clients/client-auto-scaling-plans/commands/CreateScalingPlanCommand.ts +++ b/clients/client-auto-scaling-plans/commands/CreateScalingPlanCommand.ts @@ -22,6 +22,20 @@ export interface CreateScalingPlanCommandOutput extends CreateScalingPlanRespons /** *

Creates a scaling plan.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { AutoScalingPlansClient, CreateScalingPlanCommand } from "@aws-sdk/client-auto-scaling-plans"; // ES Modules import + * // const { AutoScalingPlansClient, CreateScalingPlanCommand } = require("@aws-sdk/client-auto-scaling-plans"); // CommonJS import + * const client = new AutoScalingPlansClient(config); + * const command = new CreateScalingPlanCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreateScalingPlanCommandInput} for command's `input` shape. + * @see {@link CreateScalingPlanCommandOutput} for command's `response` shape. + * @see {@link AutoScalingPlansClientResolvedConfig | config} for command's `input` shape. + * */ export class CreateScalingPlanCommand extends $Command< CreateScalingPlanCommandInput, diff --git a/clients/client-auto-scaling-plans/commands/DeleteScalingPlanCommand.ts b/clients/client-auto-scaling-plans/commands/DeleteScalingPlanCommand.ts index 531300151c9c..e415131406b7 100644 --- a/clients/client-auto-scaling-plans/commands/DeleteScalingPlanCommand.ts +++ b/clients/client-auto-scaling-plans/commands/DeleteScalingPlanCommand.ts @@ -26,6 +26,20 @@ export interface DeleteScalingPlanCommandOutput extends DeleteScalingPlanRespons * 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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { AutoScalingPlansClient, DeleteScalingPlanCommand } from "@aws-sdk/client-auto-scaling-plans"; // ES Modules import + * // const { AutoScalingPlansClient, DeleteScalingPlanCommand } = require("@aws-sdk/client-auto-scaling-plans"); // CommonJS import + * const client = new AutoScalingPlansClient(config); + * const command = new DeleteScalingPlanCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteScalingPlanCommandInput} for command's `input` shape. + * @see {@link DeleteScalingPlanCommandOutput} for command's `response` shape. + * @see {@link AutoScalingPlansClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteScalingPlanCommand extends $Command< DeleteScalingPlanCommandInput, diff --git a/clients/client-auto-scaling-plans/commands/DescribeScalingPlanResourcesCommand.ts b/clients/client-auto-scaling-plans/commands/DescribeScalingPlanResourcesCommand.ts index ff89e170c23b..b3f32def7397 100644 --- a/clients/client-auto-scaling-plans/commands/DescribeScalingPlanResourcesCommand.ts +++ b/clients/client-auto-scaling-plans/commands/DescribeScalingPlanResourcesCommand.ts @@ -24,6 +24,20 @@ export interface DescribeScalingPlanResourcesCommandOutput /** *

Describes the scalable resources in the specified scaling plan.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { AutoScalingPlansClient, DescribeScalingPlanResourcesCommand } from "@aws-sdk/client-auto-scaling-plans"; // ES Modules import + * // const { AutoScalingPlansClient, DescribeScalingPlanResourcesCommand } = require("@aws-sdk/client-auto-scaling-plans"); // CommonJS import + * const client = new AutoScalingPlansClient(config); + * const command = new DescribeScalingPlanResourcesCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeScalingPlanResourcesCommandInput} for command's `input` shape. + * @see {@link DescribeScalingPlanResourcesCommandOutput} for command's `response` shape. + * @see {@link AutoScalingPlansClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeScalingPlanResourcesCommand extends $Command< DescribeScalingPlanResourcesCommandInput, diff --git a/clients/client-auto-scaling-plans/commands/DescribeScalingPlansCommand.ts b/clients/client-auto-scaling-plans/commands/DescribeScalingPlansCommand.ts index c86a7fa7ac4b..3d49b3b4ff29 100644 --- a/clients/client-auto-scaling-plans/commands/DescribeScalingPlansCommand.ts +++ b/clients/client-auto-scaling-plans/commands/DescribeScalingPlansCommand.ts @@ -22,6 +22,20 @@ export interface DescribeScalingPlansCommandOutput extends DescribeScalingPlansR /** *

Describes one or more of your scaling plans.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { AutoScalingPlansClient, DescribeScalingPlansCommand } from "@aws-sdk/client-auto-scaling-plans"; // ES Modules import + * // const { AutoScalingPlansClient, DescribeScalingPlansCommand } = require("@aws-sdk/client-auto-scaling-plans"); // CommonJS import + * const client = new AutoScalingPlansClient(config); + * const command = new DescribeScalingPlansCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeScalingPlansCommandInput} for command's `input` shape. + * @see {@link DescribeScalingPlansCommandOutput} for command's `response` shape. + * @see {@link AutoScalingPlansClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeScalingPlansCommand extends $Command< DescribeScalingPlansCommandInput, diff --git a/clients/client-auto-scaling-plans/commands/GetScalingPlanResourceForecastDataCommand.ts b/clients/client-auto-scaling-plans/commands/GetScalingPlanResourceForecastDataCommand.ts index 87b717e0e41f..bac3fa244fec 100644 --- a/clients/client-auto-scaling-plans/commands/GetScalingPlanResourceForecastDataCommand.ts +++ b/clients/client-auto-scaling-plans/commands/GetScalingPlanResourceForecastDataCommand.ts @@ -30,6 +30,20 @@ export interface GetScalingPlanResourceForecastDataCommandOutput *

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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { AutoScalingPlansClient, GetScalingPlanResourceForecastDataCommand } from "@aws-sdk/client-auto-scaling-plans"; // ES Modules import + * // const { AutoScalingPlansClient, GetScalingPlanResourceForecastDataCommand } = require("@aws-sdk/client-auto-scaling-plans"); // CommonJS import + * const client = new AutoScalingPlansClient(config); + * const command = new GetScalingPlanResourceForecastDataCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetScalingPlanResourceForecastDataCommandInput} for command's `input` shape. + * @see {@link GetScalingPlanResourceForecastDataCommandOutput} for command's `response` shape. + * @see {@link AutoScalingPlansClientResolvedConfig | config} for command's `input` shape. + * */ export class GetScalingPlanResourceForecastDataCommand extends $Command< GetScalingPlanResourceForecastDataCommandInput, diff --git a/clients/client-auto-scaling-plans/commands/UpdateScalingPlanCommand.ts b/clients/client-auto-scaling-plans/commands/UpdateScalingPlanCommand.ts index 16e6bc0ab941..c9ba2df25ddc 100644 --- a/clients/client-auto-scaling-plans/commands/UpdateScalingPlanCommand.ts +++ b/clients/client-auto-scaling-plans/commands/UpdateScalingPlanCommand.ts @@ -24,6 +24,20 @@ export interface UpdateScalingPlanCommandOutput extends UpdateScalingPlanRespons *

Updates the specified scaling plan.

*

You cannot update a scaling plan if it is in the process of being created, updated, or * deleted.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { AutoScalingPlansClient, UpdateScalingPlanCommand } from "@aws-sdk/client-auto-scaling-plans"; // ES Modules import + * // const { AutoScalingPlansClient, UpdateScalingPlanCommand } = require("@aws-sdk/client-auto-scaling-plans"); // CommonJS import + * const client = new AutoScalingPlansClient(config); + * const command = new UpdateScalingPlanCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link UpdateScalingPlanCommandInput} for command's `input` shape. + * @see {@link UpdateScalingPlanCommandOutput} for command's `response` shape. + * @see {@link AutoScalingPlansClientResolvedConfig | config} for command's `input` shape. + * */ export class UpdateScalingPlanCommand extends $Command< UpdateScalingPlanCommandInput, diff --git a/clients/client-auto-scaling-plans/models/models_0.ts b/clients/client-auto-scaling-plans/models/models_0.ts index cd04586d4dfa..8a6920336f66 100644 --- a/clients/client-auto-scaling-plans/models/models_0.ts +++ b/clients/client-auto-scaling-plans/models/models_0.ts @@ -12,6 +12,9 @@ export interface ConcurrentUpdateException extends __SmithyException, $MetadataB } export namespace ConcurrentUpdateException { + /** + * @internal + */ export const filterSensitiveLog = (obj: ConcurrentUpdateException): any => ({ ...obj, }); @@ -33,6 +36,9 @@ export interface TagFilter { } export namespace TagFilter { + /** + * @internal + */ export const filterSensitiveLog = (obj: TagFilter): any => ({ ...obj, }); @@ -54,6 +60,9 @@ export interface ApplicationSource { } export namespace ApplicationSource { + /** + * @internal + */ export const filterSensitiveLog = (obj: ApplicationSource): any => ({ ...obj, }); @@ -75,6 +84,9 @@ export interface MetricDimension { } export namespace MetricDimension { + /** + * @internal + */ export const filterSensitiveLog = (obj: MetricDimension): any => ({ ...obj, }); @@ -144,6 +156,9 @@ export interface CustomizedLoadMetricSpecification { } export namespace CustomizedLoadMetricSpecification { + /** + * @internal + */ export const filterSensitiveLog = (obj: CustomizedLoadMetricSpecification): any => ({ ...obj, }); @@ -197,6 +212,9 @@ export interface PredefinedLoadMetricSpecification { } export namespace PredefinedLoadMetricSpecification { + /** + * @internal + */ export const filterSensitiveLog = (obj: PredefinedLoadMetricSpecification): any => ({ ...obj, }); @@ -288,6 +306,9 @@ export interface CustomizedScalingMetricSpecification { } export namespace CustomizedScalingMetricSpecification { + /** + * @internal + */ export const filterSensitiveLog = (obj: CustomizedScalingMetricSpecification): any => ({ ...obj, }); @@ -349,6 +370,9 @@ export interface PredefinedScalingMetricSpecification { } export namespace PredefinedScalingMetricSpecification { + /** + * @internal + */ export const filterSensitiveLog = (obj: PredefinedScalingMetricSpecification): any => ({ ...obj, }); @@ -418,6 +442,9 @@ export interface TargetTrackingConfiguration { } export namespace TargetTrackingConfiguration { + /** + * @internal + */ export const filterSensitiveLog = (obj: TargetTrackingConfiguration): any => ({ ...obj, }); @@ -634,6 +661,9 @@ export interface ScalingInstruction { } export namespace ScalingInstruction { + /** + * @internal + */ export const filterSensitiveLog = (obj: ScalingInstruction): any => ({ ...obj, }); @@ -661,6 +691,9 @@ export interface CreateScalingPlanRequest { } export namespace CreateScalingPlanRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateScalingPlanRequest): any => ({ ...obj, }); @@ -675,6 +708,9 @@ export interface CreateScalingPlanResponse { } export namespace CreateScalingPlanResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateScalingPlanResponse): any => ({ ...obj, }); @@ -690,6 +726,9 @@ export interface InternalServiceException extends __SmithyException, $MetadataBe } export namespace InternalServiceException { + /** + * @internal + */ export const filterSensitiveLog = (obj: InternalServiceException): any => ({ ...obj, }); @@ -706,6 +745,9 @@ export interface LimitExceededException extends __SmithyException, $MetadataBear } export namespace LimitExceededException { + /** + * @internal + */ export const filterSensitiveLog = (obj: LimitExceededException): any => ({ ...obj, }); @@ -721,6 +763,9 @@ export interface ValidationException extends __SmithyException, $MetadataBearer } export namespace ValidationException { + /** + * @internal + */ export const filterSensitiveLog = (obj: ValidationException): any => ({ ...obj, }); @@ -740,6 +785,9 @@ export interface DeleteScalingPlanRequest { } export namespace DeleteScalingPlanRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteScalingPlanRequest): any => ({ ...obj, }); @@ -748,6 +796,9 @@ export namespace DeleteScalingPlanRequest { export interface DeleteScalingPlanResponse {} export namespace DeleteScalingPlanResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteScalingPlanResponse): any => ({ ...obj, }); @@ -763,6 +814,9 @@ export interface ObjectNotFoundException extends __SmithyException, $MetadataBea } export namespace ObjectNotFoundException { + /** + * @internal + */ export const filterSensitiveLog = (obj: ObjectNotFoundException): any => ({ ...obj, }); @@ -793,6 +847,9 @@ export interface DescribeScalingPlanResourcesRequest { } export namespace DescribeScalingPlanResourcesRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeScalingPlanResourcesRequest): any => ({ ...obj, }); @@ -824,6 +881,9 @@ export interface ScalingPolicy { } export namespace ScalingPolicy { + /** + * @internal + */ export const filterSensitiveLog = (obj: ScalingPolicy): any => ({ ...obj, }); @@ -960,6 +1020,9 @@ export interface ScalingPlanResource { } export namespace ScalingPlanResource { + /** + * @internal + */ export const filterSensitiveLog = (obj: ScalingPlanResource): any => ({ ...obj, }); @@ -979,6 +1042,9 @@ export interface DescribeScalingPlanResourcesResponse { } export namespace DescribeScalingPlanResourcesResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeScalingPlanResourcesResponse): any => ({ ...obj, }); @@ -994,6 +1060,9 @@ export interface InvalidNextTokenException extends __SmithyException, $MetadataB } export namespace InvalidNextTokenException { + /** + * @internal + */ export const filterSensitiveLog = (obj: InvalidNextTokenException): any => ({ ...obj, }); @@ -1035,6 +1104,9 @@ export interface DescribeScalingPlansRequest { } export namespace DescribeScalingPlansRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeScalingPlansRequest): any => ({ ...obj, }); @@ -1133,6 +1205,9 @@ export interface ScalingPlan { } export namespace ScalingPlan { + /** + * @internal + */ export const filterSensitiveLog = (obj: ScalingPlan): any => ({ ...obj, }); @@ -1152,6 +1227,9 @@ export interface DescribeScalingPlansResponse { } export namespace DescribeScalingPlansResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeScalingPlansResponse): any => ({ ...obj, }); @@ -1239,6 +1317,9 @@ export interface GetScalingPlanResourceForecastDataRequest { } export namespace GetScalingPlanResourceForecastDataRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetScalingPlanResourceForecastDataRequest): any => ({ ...obj, }); @@ -1260,6 +1341,9 @@ export interface Datapoint { } export namespace Datapoint { + /** + * @internal + */ export const filterSensitiveLog = (obj: Datapoint): any => ({ ...obj, }); @@ -1273,6 +1357,9 @@ export interface GetScalingPlanResourceForecastDataResponse { } export namespace GetScalingPlanResourceForecastDataResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetScalingPlanResourceForecastDataResponse): any => ({ ...obj, }); @@ -1304,6 +1391,9 @@ export interface UpdateScalingPlanRequest { } export namespace UpdateScalingPlanRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateScalingPlanRequest): any => ({ ...obj, }); @@ -1312,6 +1402,9 @@ export namespace UpdateScalingPlanRequest { export interface UpdateScalingPlanResponse {} export namespace UpdateScalingPlanResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateScalingPlanResponse): any => ({ ...obj, }); diff --git a/clients/client-auto-scaling/commands/AttachInstancesCommand.ts b/clients/client-auto-scaling/commands/AttachInstancesCommand.ts index d5ed5e3ad509..cf5bd01ced0c 100644 --- a/clients/client-auto-scaling/commands/AttachInstancesCommand.ts +++ b/clients/client-auto-scaling/commands/AttachInstancesCommand.ts @@ -31,6 +31,20 @@ export interface AttachInstancesCommandOutput extends __MetadataBearer {} * 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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { AutoScalingClient, AttachInstancesCommand } from "@aws-sdk/client-auto-scaling"; // ES Modules import + * // const { AutoScalingClient, AttachInstancesCommand } = require("@aws-sdk/client-auto-scaling"); // CommonJS import + * const client = new AutoScalingClient(config); + * const command = new AttachInstancesCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link AttachInstancesCommandInput} for command's `input` shape. + * @see {@link AttachInstancesCommandOutput} for command's `response` shape. + * @see {@link AutoScalingClientResolvedConfig | config} for command's `input` shape. + * */ export class AttachInstancesCommand extends $Command< AttachInstancesCommandInput, diff --git a/clients/client-auto-scaling/commands/AttachLoadBalancerTargetGroupsCommand.ts b/clients/client-auto-scaling/commands/AttachLoadBalancerTargetGroupsCommand.ts index 2eee2ac2f490..83b0a0d56e11 100644 --- a/clients/client-auto-scaling/commands/AttachLoadBalancerTargetGroupsCommand.ts +++ b/clients/client-auto-scaling/commands/AttachLoadBalancerTargetGroupsCommand.ts @@ -42,6 +42,20 @@ export interface AttachLoadBalancerTargetGroupsCommandOutput * the Auto Scaling group, call the DetachLoadBalancerTargetGroups API.

*

For more information, see Elastic Load Balancing and * Amazon EC2 Auto Scaling in the Amazon EC2 Auto Scaling User Guide.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { AutoScalingClient, AttachLoadBalancerTargetGroupsCommand } from "@aws-sdk/client-auto-scaling"; // ES Modules import + * // const { AutoScalingClient, AttachLoadBalancerTargetGroupsCommand } = require("@aws-sdk/client-auto-scaling"); // CommonJS import + * const client = new AutoScalingClient(config); + * const command = new AttachLoadBalancerTargetGroupsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link AttachLoadBalancerTargetGroupsCommandInput} for command's `input` shape. + * @see {@link AttachLoadBalancerTargetGroupsCommandOutput} for command's `response` shape. + * @see {@link AutoScalingClientResolvedConfig | config} for command's `input` shape. + * */ export class AttachLoadBalancerTargetGroupsCommand extends $Command< AttachLoadBalancerTargetGroupsCommandInput, diff --git a/clients/client-auto-scaling/commands/AttachLoadBalancersCommand.ts b/clients/client-auto-scaling/commands/AttachLoadBalancersCommand.ts index 64797945dab6..12e29654ce3d 100644 --- a/clients/client-auto-scaling/commands/AttachLoadBalancersCommand.ts +++ b/clients/client-auto-scaling/commands/AttachLoadBalancersCommand.ts @@ -32,6 +32,20 @@ export interface AttachLoadBalancersCommandOutput extends AttachLoadBalancersRes * group, call the DetachLoadBalancers API.

*

For more information, see Elastic Load Balancing and * Amazon EC2 Auto Scaling in the Amazon EC2 Auto Scaling User Guide.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { AutoScalingClient, AttachLoadBalancersCommand } from "@aws-sdk/client-auto-scaling"; // ES Modules import + * // const { AutoScalingClient, AttachLoadBalancersCommand } = require("@aws-sdk/client-auto-scaling"); // CommonJS import + * const client = new AutoScalingClient(config); + * const command = new AttachLoadBalancersCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link AttachLoadBalancersCommandInput} for command's `input` shape. + * @see {@link AttachLoadBalancersCommandOutput} for command's `response` shape. + * @see {@link AutoScalingClientResolvedConfig | config} for command's `input` shape. + * */ export class AttachLoadBalancersCommand extends $Command< AttachLoadBalancersCommandInput, diff --git a/clients/client-auto-scaling/commands/BatchDeleteScheduledActionCommand.ts b/clients/client-auto-scaling/commands/BatchDeleteScheduledActionCommand.ts index 63f4e6a1106c..317ed3430646 100644 --- a/clients/client-auto-scaling/commands/BatchDeleteScheduledActionCommand.ts +++ b/clients/client-auto-scaling/commands/BatchDeleteScheduledActionCommand.ts @@ -22,6 +22,20 @@ export interface BatchDeleteScheduledActionCommandOutput extends BatchDeleteSche /** *

Deletes one or more scheduled actions for the specified Auto Scaling group.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { AutoScalingClient, BatchDeleteScheduledActionCommand } from "@aws-sdk/client-auto-scaling"; // ES Modules import + * // const { AutoScalingClient, BatchDeleteScheduledActionCommand } = require("@aws-sdk/client-auto-scaling"); // CommonJS import + * const client = new AutoScalingClient(config); + * const command = new BatchDeleteScheduledActionCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link BatchDeleteScheduledActionCommandInput} for command's `input` shape. + * @see {@link BatchDeleteScheduledActionCommandOutput} for command's `response` shape. + * @see {@link AutoScalingClientResolvedConfig | config} for command's `input` shape. + * */ export class BatchDeleteScheduledActionCommand extends $Command< BatchDeleteScheduledActionCommandInput, diff --git a/clients/client-auto-scaling/commands/BatchPutScheduledUpdateGroupActionCommand.ts b/clients/client-auto-scaling/commands/BatchPutScheduledUpdateGroupActionCommand.ts index 67447731acf5..cc4d35a5fa44 100644 --- a/clients/client-auto-scaling/commands/BatchPutScheduledUpdateGroupActionCommand.ts +++ b/clients/client-auto-scaling/commands/BatchPutScheduledUpdateGroupActionCommand.ts @@ -24,6 +24,20 @@ export interface BatchPutScheduledUpdateGroupActionCommandOutput /** *

Creates or updates one or more scheduled scaling actions for an Auto Scaling group.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { AutoScalingClient, BatchPutScheduledUpdateGroupActionCommand } from "@aws-sdk/client-auto-scaling"; // ES Modules import + * // const { AutoScalingClient, BatchPutScheduledUpdateGroupActionCommand } = require("@aws-sdk/client-auto-scaling"); // CommonJS import + * const client = new AutoScalingClient(config); + * const command = new BatchPutScheduledUpdateGroupActionCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link BatchPutScheduledUpdateGroupActionCommandInput} for command's `input` shape. + * @see {@link BatchPutScheduledUpdateGroupActionCommandOutput} for command's `response` shape. + * @see {@link AutoScalingClientResolvedConfig | config} for command's `input` shape. + * */ export class BatchPutScheduledUpdateGroupActionCommand extends $Command< BatchPutScheduledUpdateGroupActionCommandInput, diff --git a/clients/client-auto-scaling/commands/CancelInstanceRefreshCommand.ts b/clients/client-auto-scaling/commands/CancelInstanceRefreshCommand.ts index 7b06091f71f1..8f199a1ff3c1 100644 --- a/clients/client-auto-scaling/commands/CancelInstanceRefreshCommand.ts +++ b/clients/client-auto-scaling/commands/CancelInstanceRefreshCommand.ts @@ -27,6 +27,20 @@ export interface CancelInstanceRefreshCommandOutput extends CancelInstanceRefres *

For more information, see Replacing Auto Scaling instances * based on an instance refresh in the * Amazon EC2 Auto Scaling User Guide.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { AutoScalingClient, CancelInstanceRefreshCommand } from "@aws-sdk/client-auto-scaling"; // ES Modules import + * // const { AutoScalingClient, CancelInstanceRefreshCommand } = require("@aws-sdk/client-auto-scaling"); // CommonJS import + * const client = new AutoScalingClient(config); + * const command = new CancelInstanceRefreshCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CancelInstanceRefreshCommandInput} for command's `input` shape. + * @see {@link CancelInstanceRefreshCommandOutput} for command's `response` shape. + * @see {@link AutoScalingClientResolvedConfig | config} for command's `input` shape. + * */ export class CancelInstanceRefreshCommand extends $Command< CancelInstanceRefreshCommandInput, diff --git a/clients/client-auto-scaling/commands/CompleteLifecycleActionCommand.ts b/clients/client-auto-scaling/commands/CompleteLifecycleActionCommand.ts index fa88aa6bbff6..123096b28add 100644 --- a/clients/client-auto-scaling/commands/CompleteLifecycleActionCommand.ts +++ b/clients/client-auto-scaling/commands/CompleteLifecycleActionCommand.ts @@ -53,6 +53,20 @@ export interface CompleteLifecycleActionCommandOutput extends CompleteLifecycleA * *

For more information, see Amazon EC2 Auto Scaling lifecycle * hooks in the Amazon EC2 Auto Scaling User Guide.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { AutoScalingClient, CompleteLifecycleActionCommand } from "@aws-sdk/client-auto-scaling"; // ES Modules import + * // const { AutoScalingClient, CompleteLifecycleActionCommand } = require("@aws-sdk/client-auto-scaling"); // CommonJS import + * const client = new AutoScalingClient(config); + * const command = new CompleteLifecycleActionCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CompleteLifecycleActionCommandInput} for command's `input` shape. + * @see {@link CompleteLifecycleActionCommandOutput} for command's `response` shape. + * @see {@link AutoScalingClientResolvedConfig | config} for command's `input` shape. + * */ export class CompleteLifecycleActionCommand extends $Command< CompleteLifecycleActionCommandInput, diff --git a/clients/client-auto-scaling/commands/CreateAutoScalingGroupCommand.ts b/clients/client-auto-scaling/commands/CreateAutoScalingGroupCommand.ts index 3cb42cf483c6..7b8b50050aa2 100644 --- a/clients/client-auto-scaling/commands/CreateAutoScalingGroupCommand.ts +++ b/clients/client-auto-scaling/commands/CreateAutoScalingGroupCommand.ts @@ -40,6 +40,20 @@ export interface CreateAutoScalingGroupCommandOutput extends __MetadataBearer {} * 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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { AutoScalingClient, CreateAutoScalingGroupCommand } from "@aws-sdk/client-auto-scaling"; // ES Modules import + * // const { AutoScalingClient, CreateAutoScalingGroupCommand } = require("@aws-sdk/client-auto-scaling"); // CommonJS import + * const client = new AutoScalingClient(config); + * const command = new CreateAutoScalingGroupCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreateAutoScalingGroupCommandInput} for command's `input` shape. + * @see {@link CreateAutoScalingGroupCommandOutput} for command's `response` shape. + * @see {@link AutoScalingClientResolvedConfig | config} for command's `input` shape. + * */ export class CreateAutoScalingGroupCommand extends $Command< CreateAutoScalingGroupCommandInput, diff --git a/clients/client-auto-scaling/commands/CreateLaunchConfigurationCommand.ts b/clients/client-auto-scaling/commands/CreateLaunchConfigurationCommand.ts index a533524cb926..201bbf5e6f74 100644 --- a/clients/client-auto-scaling/commands/CreateLaunchConfigurationCommand.ts +++ b/clients/client-auto-scaling/commands/CreateLaunchConfigurationCommand.ts @@ -28,6 +28,20 @@ export interface CreateLaunchConfigurationCommandOutput extends __MetadataBearer * quotas in the Amazon EC2 Auto Scaling User Guide.

*

For more information, see Launch * configurations in the Amazon EC2 Auto Scaling User Guide.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { AutoScalingClient, CreateLaunchConfigurationCommand } from "@aws-sdk/client-auto-scaling"; // ES Modules import + * // const { AutoScalingClient, CreateLaunchConfigurationCommand } = require("@aws-sdk/client-auto-scaling"); // CommonJS import + * const client = new AutoScalingClient(config); + * const command = new CreateLaunchConfigurationCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreateLaunchConfigurationCommandInput} for command's `input` shape. + * @see {@link CreateLaunchConfigurationCommandOutput} for command's `response` shape. + * @see {@link AutoScalingClientResolvedConfig | config} for command's `input` shape. + * */ export class CreateLaunchConfigurationCommand extends $Command< CreateLaunchConfigurationCommandInput, diff --git a/clients/client-auto-scaling/commands/CreateOrUpdateTagsCommand.ts b/clients/client-auto-scaling/commands/CreateOrUpdateTagsCommand.ts index 9b938b44d904..bc94ff6c5579 100644 --- a/clients/client-auto-scaling/commands/CreateOrUpdateTagsCommand.ts +++ b/clients/client-auto-scaling/commands/CreateOrUpdateTagsCommand.ts @@ -26,6 +26,20 @@ export interface CreateOrUpdateTagsCommandOutput extends __MetadataBearer {} * previous tag definition, and you do not get an error message.

*

For more information, see Tagging Auto Scaling groups and * instances in the Amazon EC2 Auto Scaling User Guide.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { AutoScalingClient, CreateOrUpdateTagsCommand } from "@aws-sdk/client-auto-scaling"; // ES Modules import + * // const { AutoScalingClient, CreateOrUpdateTagsCommand } = require("@aws-sdk/client-auto-scaling"); // CommonJS import + * const client = new AutoScalingClient(config); + * const command = new CreateOrUpdateTagsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreateOrUpdateTagsCommandInput} for command's `input` shape. + * @see {@link CreateOrUpdateTagsCommandOutput} for command's `response` shape. + * @see {@link AutoScalingClientResolvedConfig | config} for command's `input` shape. + * */ export class CreateOrUpdateTagsCommand extends $Command< CreateOrUpdateTagsCommandInput, diff --git a/clients/client-auto-scaling/commands/DeleteAutoScalingGroupCommand.ts b/clients/client-auto-scaling/commands/DeleteAutoScalingGroupCommand.ts index 8833e680787b..8928040ee5ae 100644 --- a/clients/client-auto-scaling/commands/DeleteAutoScalingGroupCommand.ts +++ b/clients/client-auto-scaling/commands/DeleteAutoScalingGroupCommand.ts @@ -31,6 +31,20 @@ export interface DeleteAutoScalingGroupCommandOutput extends __MetadataBearer {} * 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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { AutoScalingClient, DeleteAutoScalingGroupCommand } from "@aws-sdk/client-auto-scaling"; // ES Modules import + * // const { AutoScalingClient, DeleteAutoScalingGroupCommand } = require("@aws-sdk/client-auto-scaling"); // CommonJS import + * const client = new AutoScalingClient(config); + * const command = new DeleteAutoScalingGroupCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteAutoScalingGroupCommandInput} for command's `input` shape. + * @see {@link DeleteAutoScalingGroupCommandOutput} for command's `response` shape. + * @see {@link AutoScalingClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteAutoScalingGroupCommand extends $Command< DeleteAutoScalingGroupCommandInput, diff --git a/clients/client-auto-scaling/commands/DeleteLaunchConfigurationCommand.ts b/clients/client-auto-scaling/commands/DeleteLaunchConfigurationCommand.ts index bcaa99733ae6..de03060c10ab 100644 --- a/clients/client-auto-scaling/commands/DeleteLaunchConfigurationCommand.ts +++ b/clients/client-auto-scaling/commands/DeleteLaunchConfigurationCommand.ts @@ -24,6 +24,20 @@ export interface DeleteLaunchConfigurationCommandOutput extends __MetadataBearer *

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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { AutoScalingClient, DeleteLaunchConfigurationCommand } from "@aws-sdk/client-auto-scaling"; // ES Modules import + * // const { AutoScalingClient, DeleteLaunchConfigurationCommand } = require("@aws-sdk/client-auto-scaling"); // CommonJS import + * const client = new AutoScalingClient(config); + * const command = new DeleteLaunchConfigurationCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteLaunchConfigurationCommandInput} for command's `input` shape. + * @see {@link DeleteLaunchConfigurationCommandOutput} for command's `response` shape. + * @see {@link AutoScalingClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteLaunchConfigurationCommand extends $Command< DeleteLaunchConfigurationCommandInput, diff --git a/clients/client-auto-scaling/commands/DeleteLifecycleHookCommand.ts b/clients/client-auto-scaling/commands/DeleteLifecycleHookCommand.ts index 14d6da56869d..e7586370065c 100644 --- a/clients/client-auto-scaling/commands/DeleteLifecycleHookCommand.ts +++ b/clients/client-auto-scaling/commands/DeleteLifecycleHookCommand.ts @@ -25,6 +25,20 @@ export interface DeleteLifecycleHookCommandOutput extends DeleteLifecycleHookAns *

If there are any outstanding lifecycle actions, they are completed first * (ABANDON for launching instances, CONTINUE for terminating * instances).

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { AutoScalingClient, DeleteLifecycleHookCommand } from "@aws-sdk/client-auto-scaling"; // ES Modules import + * // const { AutoScalingClient, DeleteLifecycleHookCommand } = require("@aws-sdk/client-auto-scaling"); // CommonJS import + * const client = new AutoScalingClient(config); + * const command = new DeleteLifecycleHookCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteLifecycleHookCommandInput} for command's `input` shape. + * @see {@link DeleteLifecycleHookCommandOutput} for command's `response` shape. + * @see {@link AutoScalingClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteLifecycleHookCommand extends $Command< DeleteLifecycleHookCommandInput, diff --git a/clients/client-auto-scaling/commands/DeleteNotificationConfigurationCommand.ts b/clients/client-auto-scaling/commands/DeleteNotificationConfigurationCommand.ts index 871086708cb3..06ddaad4e3a7 100644 --- a/clients/client-auto-scaling/commands/DeleteNotificationConfigurationCommand.ts +++ b/clients/client-auto-scaling/commands/DeleteNotificationConfigurationCommand.ts @@ -22,6 +22,20 @@ export interface DeleteNotificationConfigurationCommandOutput extends __Metadata /** *

Deletes the specified notification.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { AutoScalingClient, DeleteNotificationConfigurationCommand } from "@aws-sdk/client-auto-scaling"; // ES Modules import + * // const { AutoScalingClient, DeleteNotificationConfigurationCommand } = require("@aws-sdk/client-auto-scaling"); // CommonJS import + * const client = new AutoScalingClient(config); + * const command = new DeleteNotificationConfigurationCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteNotificationConfigurationCommandInput} for command's `input` shape. + * @see {@link DeleteNotificationConfigurationCommandOutput} for command's `response` shape. + * @see {@link AutoScalingClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteNotificationConfigurationCommand extends $Command< DeleteNotificationConfigurationCommandInput, diff --git a/clients/client-auto-scaling/commands/DeletePolicyCommand.ts b/clients/client-auto-scaling/commands/DeletePolicyCommand.ts index cee1f10893b6..c3c43a9197e7 100644 --- a/clients/client-auto-scaling/commands/DeletePolicyCommand.ts +++ b/clients/client-auto-scaling/commands/DeletePolicyCommand.ts @@ -24,6 +24,20 @@ export interface DeletePolicyCommandOutput extends __MetadataBearer {} * associated action.

*

For more information, see Deleting a scaling * policy in the Amazon EC2 Auto Scaling User Guide.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { AutoScalingClient, DeletePolicyCommand } from "@aws-sdk/client-auto-scaling"; // ES Modules import + * // const { AutoScalingClient, DeletePolicyCommand } = require("@aws-sdk/client-auto-scaling"); // CommonJS import + * const client = new AutoScalingClient(config); + * const command = new DeletePolicyCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeletePolicyCommandInput} for command's `input` shape. + * @see {@link DeletePolicyCommandOutput} for command's `response` shape. + * @see {@link AutoScalingClientResolvedConfig | config} for command's `input` shape. + * */ export class DeletePolicyCommand extends $Command< DeletePolicyCommandInput, diff --git a/clients/client-auto-scaling/commands/DeleteScheduledActionCommand.ts b/clients/client-auto-scaling/commands/DeleteScheduledActionCommand.ts index 0c688812361d..a9507486413a 100644 --- a/clients/client-auto-scaling/commands/DeleteScheduledActionCommand.ts +++ b/clients/client-auto-scaling/commands/DeleteScheduledActionCommand.ts @@ -22,6 +22,20 @@ export interface DeleteScheduledActionCommandOutput extends __MetadataBearer {} /** *

Deletes the specified scheduled action.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { AutoScalingClient, DeleteScheduledActionCommand } from "@aws-sdk/client-auto-scaling"; // ES Modules import + * // const { AutoScalingClient, DeleteScheduledActionCommand } = require("@aws-sdk/client-auto-scaling"); // CommonJS import + * const client = new AutoScalingClient(config); + * const command = new DeleteScheduledActionCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteScheduledActionCommandInput} for command's `input` shape. + * @see {@link DeleteScheduledActionCommandOutput} for command's `response` shape. + * @see {@link AutoScalingClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteScheduledActionCommand extends $Command< DeleteScheduledActionCommandInput, diff --git a/clients/client-auto-scaling/commands/DeleteTagsCommand.ts b/clients/client-auto-scaling/commands/DeleteTagsCommand.ts index 477c6d31aad3..ccbd5962bf36 100644 --- a/clients/client-auto-scaling/commands/DeleteTagsCommand.ts +++ b/clients/client-auto-scaling/commands/DeleteTagsCommand.ts @@ -19,6 +19,20 @@ export interface DeleteTagsCommandOutput extends __MetadataBearer {} /** *

Deletes the specified tags.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { AutoScalingClient, DeleteTagsCommand } from "@aws-sdk/client-auto-scaling"; // ES Modules import + * // const { AutoScalingClient, DeleteTagsCommand } = require("@aws-sdk/client-auto-scaling"); // CommonJS import + * const client = new AutoScalingClient(config); + * const command = new DeleteTagsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteTagsCommandInput} for command's `input` shape. + * @see {@link DeleteTagsCommandOutput} for command's `response` shape. + * @see {@link AutoScalingClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteTagsCommand extends $Command< DeleteTagsCommandInput, diff --git a/clients/client-auto-scaling/commands/DeleteWarmPoolCommand.ts b/clients/client-auto-scaling/commands/DeleteWarmPoolCommand.ts index d60f136895cc..14a25e455747 100644 --- a/clients/client-auto-scaling/commands/DeleteWarmPoolCommand.ts +++ b/clients/client-auto-scaling/commands/DeleteWarmPoolCommand.ts @@ -22,6 +22,20 @@ export interface DeleteWarmPoolCommandOutput extends DeleteWarmPoolAnswer, __Met /** *

Deletes the warm pool for the specified Auto Scaling group.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { AutoScalingClient, DeleteWarmPoolCommand } from "@aws-sdk/client-auto-scaling"; // ES Modules import + * // const { AutoScalingClient, DeleteWarmPoolCommand } = require("@aws-sdk/client-auto-scaling"); // CommonJS import + * const client = new AutoScalingClient(config); + * const command = new DeleteWarmPoolCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteWarmPoolCommandInput} for command's `input` shape. + * @see {@link DeleteWarmPoolCommandOutput} for command's `response` shape. + * @see {@link AutoScalingClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteWarmPoolCommand extends $Command< DeleteWarmPoolCommandInput, diff --git a/clients/client-auto-scaling/commands/DescribeAccountLimitsCommand.ts b/clients/client-auto-scaling/commands/DescribeAccountLimitsCommand.ts index 72015b6f973c..2417d933d72d 100644 --- a/clients/client-auto-scaling/commands/DescribeAccountLimitsCommand.ts +++ b/clients/client-auto-scaling/commands/DescribeAccountLimitsCommand.ts @@ -24,6 +24,20 @@ export interface DescribeAccountLimitsCommandOutput extends DescribeAccountLimit *

Describes the current Amazon EC2 Auto Scaling resource quotas for your AWS account.

*

For information about requesting an increase, see Amazon EC2 Auto Scaling service * quotas in the Amazon EC2 Auto Scaling User Guide.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { AutoScalingClient, DescribeAccountLimitsCommand } from "@aws-sdk/client-auto-scaling"; // ES Modules import + * // const { AutoScalingClient, DescribeAccountLimitsCommand } = require("@aws-sdk/client-auto-scaling"); // CommonJS import + * const client = new AutoScalingClient(config); + * const command = new DescribeAccountLimitsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeAccountLimitsCommandInput} for command's `input` shape. + * @see {@link DescribeAccountLimitsCommandOutput} for command's `response` shape. + * @see {@link AutoScalingClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeAccountLimitsCommand extends $Command< DescribeAccountLimitsCommandInput, diff --git a/clients/client-auto-scaling/commands/DescribeAdjustmentTypesCommand.ts b/clients/client-auto-scaling/commands/DescribeAdjustmentTypesCommand.ts index 4a942d7d4d00..be89dc6c63ff 100644 --- a/clients/client-auto-scaling/commands/DescribeAdjustmentTypesCommand.ts +++ b/clients/client-auto-scaling/commands/DescribeAdjustmentTypesCommand.ts @@ -36,6 +36,20 @@ export interface DescribeAdjustmentTypesCommandOutput extends DescribeAdjustment *

PercentChangeInCapacity

* * + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { AutoScalingClient, DescribeAdjustmentTypesCommand } from "@aws-sdk/client-auto-scaling"; // ES Modules import + * // const { AutoScalingClient, DescribeAdjustmentTypesCommand } = require("@aws-sdk/client-auto-scaling"); // CommonJS import + * const client = new AutoScalingClient(config); + * const command = new DescribeAdjustmentTypesCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeAdjustmentTypesCommandInput} for command's `input` shape. + * @see {@link DescribeAdjustmentTypesCommandOutput} for command's `response` shape. + * @see {@link AutoScalingClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeAdjustmentTypesCommand extends $Command< DescribeAdjustmentTypesCommandInput, diff --git a/clients/client-auto-scaling/commands/DescribeAutoScalingGroupsCommand.ts b/clients/client-auto-scaling/commands/DescribeAutoScalingGroupsCommand.ts index 75986f464cd2..d462343673b8 100644 --- a/clients/client-auto-scaling/commands/DescribeAutoScalingGroupsCommand.ts +++ b/clients/client-auto-scaling/commands/DescribeAutoScalingGroupsCommand.ts @@ -22,6 +22,20 @@ export interface DescribeAutoScalingGroupsCommandOutput extends AutoScalingGroup /** *

Describes one or more Auto Scaling groups.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { AutoScalingClient, DescribeAutoScalingGroupsCommand } from "@aws-sdk/client-auto-scaling"; // ES Modules import + * // const { AutoScalingClient, DescribeAutoScalingGroupsCommand } = require("@aws-sdk/client-auto-scaling"); // CommonJS import + * const client = new AutoScalingClient(config); + * const command = new DescribeAutoScalingGroupsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeAutoScalingGroupsCommandInput} for command's `input` shape. + * @see {@link DescribeAutoScalingGroupsCommandOutput} for command's `response` shape. + * @see {@link AutoScalingClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeAutoScalingGroupsCommand extends $Command< DescribeAutoScalingGroupsCommandInput, diff --git a/clients/client-auto-scaling/commands/DescribeAutoScalingInstancesCommand.ts b/clients/client-auto-scaling/commands/DescribeAutoScalingInstancesCommand.ts index 48f1902d1463..3fb14c75c527 100644 --- a/clients/client-auto-scaling/commands/DescribeAutoScalingInstancesCommand.ts +++ b/clients/client-auto-scaling/commands/DescribeAutoScalingInstancesCommand.ts @@ -22,6 +22,20 @@ export interface DescribeAutoScalingInstancesCommandOutput extends AutoScalingIn /** *

Describes one or more Auto Scaling instances.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { AutoScalingClient, DescribeAutoScalingInstancesCommand } from "@aws-sdk/client-auto-scaling"; // ES Modules import + * // const { AutoScalingClient, DescribeAutoScalingInstancesCommand } = require("@aws-sdk/client-auto-scaling"); // CommonJS import + * const client = new AutoScalingClient(config); + * const command = new DescribeAutoScalingInstancesCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeAutoScalingInstancesCommandInput} for command's `input` shape. + * @see {@link DescribeAutoScalingInstancesCommandOutput} for command's `response` shape. + * @see {@link AutoScalingClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeAutoScalingInstancesCommand extends $Command< DescribeAutoScalingInstancesCommandInput, diff --git a/clients/client-auto-scaling/commands/DescribeAutoScalingNotificationTypesCommand.ts b/clients/client-auto-scaling/commands/DescribeAutoScalingNotificationTypesCommand.ts index 876bc971658a..a06a6d38b2bc 100644 --- a/clients/client-auto-scaling/commands/DescribeAutoScalingNotificationTypesCommand.ts +++ b/clients/client-auto-scaling/commands/DescribeAutoScalingNotificationTypesCommand.ts @@ -24,6 +24,20 @@ export interface DescribeAutoScalingNotificationTypesCommandOutput /** *

Describes the notification types that are supported by Amazon EC2 Auto Scaling.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { AutoScalingClient, DescribeAutoScalingNotificationTypesCommand } from "@aws-sdk/client-auto-scaling"; // ES Modules import + * // const { AutoScalingClient, DescribeAutoScalingNotificationTypesCommand } = require("@aws-sdk/client-auto-scaling"); // CommonJS import + * const client = new AutoScalingClient(config); + * const command = new DescribeAutoScalingNotificationTypesCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeAutoScalingNotificationTypesCommandInput} for command's `input` shape. + * @see {@link DescribeAutoScalingNotificationTypesCommandOutput} for command's `response` shape. + * @see {@link AutoScalingClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeAutoScalingNotificationTypesCommand extends $Command< DescribeAutoScalingNotificationTypesCommandInput, diff --git a/clients/client-auto-scaling/commands/DescribeInstanceRefreshesCommand.ts b/clients/client-auto-scaling/commands/DescribeInstanceRefreshesCommand.ts index aff20072505f..742ff3c6c9f0 100644 --- a/clients/client-auto-scaling/commands/DescribeInstanceRefreshesCommand.ts +++ b/clients/client-auto-scaling/commands/DescribeInstanceRefreshesCommand.ts @@ -57,6 +57,20 @@ export interface DescribeInstanceRefreshesCommandOutput extends DescribeInstance *

For more information, see Replacing Auto Scaling instances * based on an instance refresh in the * Amazon EC2 Auto Scaling User Guide.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { AutoScalingClient, DescribeInstanceRefreshesCommand } from "@aws-sdk/client-auto-scaling"; // ES Modules import + * // const { AutoScalingClient, DescribeInstanceRefreshesCommand } = require("@aws-sdk/client-auto-scaling"); // CommonJS import + * const client = new AutoScalingClient(config); + * const command = new DescribeInstanceRefreshesCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeInstanceRefreshesCommandInput} for command's `input` shape. + * @see {@link DescribeInstanceRefreshesCommandOutput} for command's `response` shape. + * @see {@link AutoScalingClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeInstanceRefreshesCommand extends $Command< DescribeInstanceRefreshesCommandInput, diff --git a/clients/client-auto-scaling/commands/DescribeLaunchConfigurationsCommand.ts b/clients/client-auto-scaling/commands/DescribeLaunchConfigurationsCommand.ts index c70566ad45d4..9e685763493c 100644 --- a/clients/client-auto-scaling/commands/DescribeLaunchConfigurationsCommand.ts +++ b/clients/client-auto-scaling/commands/DescribeLaunchConfigurationsCommand.ts @@ -22,6 +22,20 @@ export interface DescribeLaunchConfigurationsCommandOutput extends LaunchConfigu /** *

Describes one or more launch configurations.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { AutoScalingClient, DescribeLaunchConfigurationsCommand } from "@aws-sdk/client-auto-scaling"; // ES Modules import + * // const { AutoScalingClient, DescribeLaunchConfigurationsCommand } = require("@aws-sdk/client-auto-scaling"); // CommonJS import + * const client = new AutoScalingClient(config); + * const command = new DescribeLaunchConfigurationsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeLaunchConfigurationsCommandInput} for command's `input` shape. + * @see {@link DescribeLaunchConfigurationsCommandOutput} for command's `response` shape. + * @see {@link AutoScalingClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeLaunchConfigurationsCommand extends $Command< DescribeLaunchConfigurationsCommandInput, diff --git a/clients/client-auto-scaling/commands/DescribeLifecycleHookTypesCommand.ts b/clients/client-auto-scaling/commands/DescribeLifecycleHookTypesCommand.ts index 9b85066f6280..b6d859b55546 100644 --- a/clients/client-auto-scaling/commands/DescribeLifecycleHookTypesCommand.ts +++ b/clients/client-auto-scaling/commands/DescribeLifecycleHookTypesCommand.ts @@ -31,6 +31,20 @@ export interface DescribeLifecycleHookTypesCommandOutput extends DescribeLifecyc *

autoscaling:EC2_INSTANCE_TERMINATING

* * + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { AutoScalingClient, DescribeLifecycleHookTypesCommand } from "@aws-sdk/client-auto-scaling"; // ES Modules import + * // const { AutoScalingClient, DescribeLifecycleHookTypesCommand } = require("@aws-sdk/client-auto-scaling"); // CommonJS import + * const client = new AutoScalingClient(config); + * const command = new DescribeLifecycleHookTypesCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeLifecycleHookTypesCommandInput} for command's `input` shape. + * @see {@link DescribeLifecycleHookTypesCommandOutput} for command's `response` shape. + * @see {@link AutoScalingClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeLifecycleHookTypesCommand extends $Command< DescribeLifecycleHookTypesCommandInput, diff --git a/clients/client-auto-scaling/commands/DescribeLifecycleHooksCommand.ts b/clients/client-auto-scaling/commands/DescribeLifecycleHooksCommand.ts index 8980964edf3c..c42a0f781365 100644 --- a/clients/client-auto-scaling/commands/DescribeLifecycleHooksCommand.ts +++ b/clients/client-auto-scaling/commands/DescribeLifecycleHooksCommand.ts @@ -22,6 +22,20 @@ export interface DescribeLifecycleHooksCommandOutput extends DescribeLifecycleHo /** *

Describes the lifecycle hooks for the specified Auto Scaling group.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { AutoScalingClient, DescribeLifecycleHooksCommand } from "@aws-sdk/client-auto-scaling"; // ES Modules import + * // const { AutoScalingClient, DescribeLifecycleHooksCommand } = require("@aws-sdk/client-auto-scaling"); // CommonJS import + * const client = new AutoScalingClient(config); + * const command = new DescribeLifecycleHooksCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeLifecycleHooksCommandInput} for command's `input` shape. + * @see {@link DescribeLifecycleHooksCommandOutput} for command's `response` shape. + * @see {@link AutoScalingClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeLifecycleHooksCommand extends $Command< DescribeLifecycleHooksCommandInput, diff --git a/clients/client-auto-scaling/commands/DescribeLoadBalancerTargetGroupsCommand.ts b/clients/client-auto-scaling/commands/DescribeLoadBalancerTargetGroupsCommand.ts index 03076810c460..955588299b80 100644 --- a/clients/client-auto-scaling/commands/DescribeLoadBalancerTargetGroupsCommand.ts +++ b/clients/client-auto-scaling/commands/DescribeLoadBalancerTargetGroupsCommand.ts @@ -24,6 +24,20 @@ export interface DescribeLoadBalancerTargetGroupsCommandOutput /** *

Describes the target groups for the specified Auto Scaling group.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { AutoScalingClient, DescribeLoadBalancerTargetGroupsCommand } from "@aws-sdk/client-auto-scaling"; // ES Modules import + * // const { AutoScalingClient, DescribeLoadBalancerTargetGroupsCommand } = require("@aws-sdk/client-auto-scaling"); // CommonJS import + * const client = new AutoScalingClient(config); + * const command = new DescribeLoadBalancerTargetGroupsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeLoadBalancerTargetGroupsCommandInput} for command's `input` shape. + * @see {@link DescribeLoadBalancerTargetGroupsCommandOutput} for command's `response` shape. + * @see {@link AutoScalingClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeLoadBalancerTargetGroupsCommand extends $Command< DescribeLoadBalancerTargetGroupsCommandInput, diff --git a/clients/client-auto-scaling/commands/DescribeLoadBalancersCommand.ts b/clients/client-auto-scaling/commands/DescribeLoadBalancersCommand.ts index 21175b9f3bda..c10fe0fdaba3 100644 --- a/clients/client-auto-scaling/commands/DescribeLoadBalancersCommand.ts +++ b/clients/client-auto-scaling/commands/DescribeLoadBalancersCommand.ts @@ -24,6 +24,20 @@ export interface DescribeLoadBalancersCommandOutput extends DescribeLoadBalancer *

Describes 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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { AutoScalingClient, DescribeLoadBalancersCommand } from "@aws-sdk/client-auto-scaling"; // ES Modules import + * // const { AutoScalingClient, DescribeLoadBalancersCommand } = require("@aws-sdk/client-auto-scaling"); // CommonJS import + * const client = new AutoScalingClient(config); + * const command = new DescribeLoadBalancersCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeLoadBalancersCommandInput} for command's `input` shape. + * @see {@link DescribeLoadBalancersCommandOutput} for command's `response` shape. + * @see {@link AutoScalingClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeLoadBalancersCommand extends $Command< DescribeLoadBalancersCommandInput, diff --git a/clients/client-auto-scaling/commands/DescribeMetricCollectionTypesCommand.ts b/clients/client-auto-scaling/commands/DescribeMetricCollectionTypesCommand.ts index 2e2625a505ed..2c55f8448f2a 100644 --- a/clients/client-auto-scaling/commands/DescribeMetricCollectionTypesCommand.ts +++ b/clients/client-auto-scaling/commands/DescribeMetricCollectionTypesCommand.ts @@ -26,6 +26,20 @@ export interface DescribeMetricCollectionTypesCommandOutput *

Describes the available CloudWatch metrics for Amazon EC2 Auto Scaling.

*

The GroupStandbyInstances metric is not returned by default. You must * explicitly request this metric when calling the EnableMetricsCollection API.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { AutoScalingClient, DescribeMetricCollectionTypesCommand } from "@aws-sdk/client-auto-scaling"; // ES Modules import + * // const { AutoScalingClient, DescribeMetricCollectionTypesCommand } = require("@aws-sdk/client-auto-scaling"); // CommonJS import + * const client = new AutoScalingClient(config); + * const command = new DescribeMetricCollectionTypesCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeMetricCollectionTypesCommandInput} for command's `input` shape. + * @see {@link DescribeMetricCollectionTypesCommandOutput} for command's `response` shape. + * @see {@link AutoScalingClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeMetricCollectionTypesCommand extends $Command< DescribeMetricCollectionTypesCommandInput, diff --git a/clients/client-auto-scaling/commands/DescribeNotificationConfigurationsCommand.ts b/clients/client-auto-scaling/commands/DescribeNotificationConfigurationsCommand.ts index a2316b4b4694..c1fdc26d3bdc 100644 --- a/clients/client-auto-scaling/commands/DescribeNotificationConfigurationsCommand.ts +++ b/clients/client-auto-scaling/commands/DescribeNotificationConfigurationsCommand.ts @@ -24,6 +24,20 @@ export interface DescribeNotificationConfigurationsCommandOutput /** *

Describes the notification actions associated with the specified Auto Scaling group.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { AutoScalingClient, DescribeNotificationConfigurationsCommand } from "@aws-sdk/client-auto-scaling"; // ES Modules import + * // const { AutoScalingClient, DescribeNotificationConfigurationsCommand } = require("@aws-sdk/client-auto-scaling"); // CommonJS import + * const client = new AutoScalingClient(config); + * const command = new DescribeNotificationConfigurationsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeNotificationConfigurationsCommandInput} for command's `input` shape. + * @see {@link DescribeNotificationConfigurationsCommandOutput} for command's `response` shape. + * @see {@link AutoScalingClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeNotificationConfigurationsCommand extends $Command< DescribeNotificationConfigurationsCommandInput, diff --git a/clients/client-auto-scaling/commands/DescribePoliciesCommand.ts b/clients/client-auto-scaling/commands/DescribePoliciesCommand.ts index d2ed3cb127cc..b9114aa72a24 100644 --- a/clients/client-auto-scaling/commands/DescribePoliciesCommand.ts +++ b/clients/client-auto-scaling/commands/DescribePoliciesCommand.ts @@ -22,6 +22,20 @@ export interface DescribePoliciesCommandOutput extends PoliciesType, __MetadataB /** *

Describes the policies for the specified Auto Scaling group.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { AutoScalingClient, DescribePoliciesCommand } from "@aws-sdk/client-auto-scaling"; // ES Modules import + * // const { AutoScalingClient, DescribePoliciesCommand } = require("@aws-sdk/client-auto-scaling"); // CommonJS import + * const client = new AutoScalingClient(config); + * const command = new DescribePoliciesCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribePoliciesCommandInput} for command's `input` shape. + * @see {@link DescribePoliciesCommandOutput} for command's `response` shape. + * @see {@link AutoScalingClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribePoliciesCommand extends $Command< DescribePoliciesCommandInput, diff --git a/clients/client-auto-scaling/commands/DescribeScalingActivitiesCommand.ts b/clients/client-auto-scaling/commands/DescribeScalingActivitiesCommand.ts index 7c9aa2b61d71..7743fd3929dd 100644 --- a/clients/client-auto-scaling/commands/DescribeScalingActivitiesCommand.ts +++ b/clients/client-auto-scaling/commands/DescribeScalingActivitiesCommand.ts @@ -26,6 +26,20 @@ export interface DescribeScalingActivitiesCommandOutput extends ActivitiesType, * you see scaling activity messages in the Activity * history. For more information, see Verifying a scaling * activity for an Auto Scaling group in the Amazon EC2 Auto Scaling User Guide.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { AutoScalingClient, DescribeScalingActivitiesCommand } from "@aws-sdk/client-auto-scaling"; // ES Modules import + * // const { AutoScalingClient, DescribeScalingActivitiesCommand } = require("@aws-sdk/client-auto-scaling"); // CommonJS import + * const client = new AutoScalingClient(config); + * const command = new DescribeScalingActivitiesCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeScalingActivitiesCommandInput} for command's `input` shape. + * @see {@link DescribeScalingActivitiesCommandOutput} for command's `response` shape. + * @see {@link AutoScalingClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeScalingActivitiesCommand extends $Command< DescribeScalingActivitiesCommandInput, diff --git a/clients/client-auto-scaling/commands/DescribeScalingProcessTypesCommand.ts b/clients/client-auto-scaling/commands/DescribeScalingProcessTypesCommand.ts index 49b956e73acc..60e1a70842e4 100644 --- a/clients/client-auto-scaling/commands/DescribeScalingProcessTypesCommand.ts +++ b/clients/client-auto-scaling/commands/DescribeScalingProcessTypesCommand.ts @@ -23,6 +23,20 @@ export interface DescribeScalingProcessTypesCommandOutput extends ProcessesType, /** *

Describes the scaling process types for use with the ResumeProcesses * and SuspendProcesses APIs.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { AutoScalingClient, DescribeScalingProcessTypesCommand } from "@aws-sdk/client-auto-scaling"; // ES Modules import + * // const { AutoScalingClient, DescribeScalingProcessTypesCommand } = require("@aws-sdk/client-auto-scaling"); // CommonJS import + * const client = new AutoScalingClient(config); + * const command = new DescribeScalingProcessTypesCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeScalingProcessTypesCommandInput} for command's `input` shape. + * @see {@link DescribeScalingProcessTypesCommandOutput} for command's `response` shape. + * @see {@link AutoScalingClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeScalingProcessTypesCommand extends $Command< DescribeScalingProcessTypesCommandInput, diff --git a/clients/client-auto-scaling/commands/DescribeScheduledActionsCommand.ts b/clients/client-auto-scaling/commands/DescribeScheduledActionsCommand.ts index a601287b3831..8ae58123ea97 100644 --- a/clients/client-auto-scaling/commands/DescribeScheduledActionsCommand.ts +++ b/clients/client-auto-scaling/commands/DescribeScheduledActionsCommand.ts @@ -23,6 +23,20 @@ export interface DescribeScheduledActionsCommandOutput extends ScheduledActionsT /** *

Describes the actions scheduled for your Auto Scaling group that haven't run or that have not * reached their end time. To describe the actions that have already run, call the DescribeScalingActivities API.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { AutoScalingClient, DescribeScheduledActionsCommand } from "@aws-sdk/client-auto-scaling"; // ES Modules import + * // const { AutoScalingClient, DescribeScheduledActionsCommand } = require("@aws-sdk/client-auto-scaling"); // CommonJS import + * const client = new AutoScalingClient(config); + * const command = new DescribeScheduledActionsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeScheduledActionsCommandInput} for command's `input` shape. + * @see {@link DescribeScheduledActionsCommandOutput} for command's `response` shape. + * @see {@link AutoScalingClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeScheduledActionsCommand extends $Command< DescribeScheduledActionsCommandInput, diff --git a/clients/client-auto-scaling/commands/DescribeTagsCommand.ts b/clients/client-auto-scaling/commands/DescribeTagsCommand.ts index 80be4f91bbf9..d10adcf89fae 100644 --- a/clients/client-auto-scaling/commands/DescribeTagsCommand.ts +++ b/clients/client-auto-scaling/commands/DescribeTagsCommand.ts @@ -27,6 +27,20 @@ export interface DescribeTagsCommandOutput extends TagsType, __MetadataBearer {} * message is returned.

*

For more information, see Tagging Auto Scaling groups and * instances in the Amazon EC2 Auto Scaling User Guide.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { AutoScalingClient, DescribeTagsCommand } from "@aws-sdk/client-auto-scaling"; // ES Modules import + * // const { AutoScalingClient, DescribeTagsCommand } = require("@aws-sdk/client-auto-scaling"); // CommonJS import + * const client = new AutoScalingClient(config); + * const command = new DescribeTagsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeTagsCommandInput} for command's `input` shape. + * @see {@link DescribeTagsCommandOutput} for command's `response` shape. + * @see {@link AutoScalingClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeTagsCommand extends $Command< DescribeTagsCommandInput, diff --git a/clients/client-auto-scaling/commands/DescribeTerminationPolicyTypesCommand.ts b/clients/client-auto-scaling/commands/DescribeTerminationPolicyTypesCommand.ts index ae8d6331edfb..727c3613ecf7 100644 --- a/clients/client-auto-scaling/commands/DescribeTerminationPolicyTypesCommand.ts +++ b/clients/client-auto-scaling/commands/DescribeTerminationPolicyTypesCommand.ts @@ -27,6 +27,20 @@ export interface DescribeTerminationPolicyTypesCommandOutput *

For more information, see Controlling which Auto Scaling * instances terminate during scale in in the * Amazon EC2 Auto Scaling User Guide.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { AutoScalingClient, DescribeTerminationPolicyTypesCommand } from "@aws-sdk/client-auto-scaling"; // ES Modules import + * // const { AutoScalingClient, DescribeTerminationPolicyTypesCommand } = require("@aws-sdk/client-auto-scaling"); // CommonJS import + * const client = new AutoScalingClient(config); + * const command = new DescribeTerminationPolicyTypesCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeTerminationPolicyTypesCommandInput} for command's `input` shape. + * @see {@link DescribeTerminationPolicyTypesCommandOutput} for command's `response` shape. + * @see {@link AutoScalingClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeTerminationPolicyTypesCommand extends $Command< DescribeTerminationPolicyTypesCommandInput, diff --git a/clients/client-auto-scaling/commands/DescribeWarmPoolCommand.ts b/clients/client-auto-scaling/commands/DescribeWarmPoolCommand.ts index 3ddd4621f91d..a47c5a0f5ad7 100644 --- a/clients/client-auto-scaling/commands/DescribeWarmPoolCommand.ts +++ b/clients/client-auto-scaling/commands/DescribeWarmPoolCommand.ts @@ -22,6 +22,20 @@ export interface DescribeWarmPoolCommandOutput extends DescribeWarmPoolAnswer, _ /** *

Describes a warm pool and its instances.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { AutoScalingClient, DescribeWarmPoolCommand } from "@aws-sdk/client-auto-scaling"; // ES Modules import + * // const { AutoScalingClient, DescribeWarmPoolCommand } = require("@aws-sdk/client-auto-scaling"); // CommonJS import + * const client = new AutoScalingClient(config); + * const command = new DescribeWarmPoolCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeWarmPoolCommandInput} for command's `input` shape. + * @see {@link DescribeWarmPoolCommandOutput} for command's `response` shape. + * @see {@link AutoScalingClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeWarmPoolCommand extends $Command< DescribeWarmPoolCommandInput, diff --git a/clients/client-auto-scaling/commands/DetachInstancesCommand.ts b/clients/client-auto-scaling/commands/DetachInstancesCommand.ts index e49119cddeba..3b21a542ca5f 100644 --- a/clients/client-auto-scaling/commands/DetachInstancesCommand.ts +++ b/clients/client-auto-scaling/commands/DetachInstancesCommand.ts @@ -31,6 +31,20 @@ export interface DetachInstancesCommandOutput extends DetachInstancesAnswer, __M * 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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { AutoScalingClient, DetachInstancesCommand } from "@aws-sdk/client-auto-scaling"; // ES Modules import + * // const { AutoScalingClient, DetachInstancesCommand } = require("@aws-sdk/client-auto-scaling"); // CommonJS import + * const client = new AutoScalingClient(config); + * const command = new DetachInstancesCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DetachInstancesCommandInput} for command's `input` shape. + * @see {@link DetachInstancesCommandOutput} for command's `response` shape. + * @see {@link AutoScalingClientResolvedConfig | config} for command's `input` shape. + * */ export class DetachInstancesCommand extends $Command< DetachInstancesCommandInput, diff --git a/clients/client-auto-scaling/commands/DetachLoadBalancerTargetGroupsCommand.ts b/clients/client-auto-scaling/commands/DetachLoadBalancerTargetGroupsCommand.ts index 26a368d953bf..56f487cc23ab 100644 --- a/clients/client-auto-scaling/commands/DetachLoadBalancerTargetGroupsCommand.ts +++ b/clients/client-auto-scaling/commands/DetachLoadBalancerTargetGroupsCommand.ts @@ -24,6 +24,20 @@ export interface DetachLoadBalancerTargetGroupsCommandOutput /** *

Detaches one or more target groups from the specified Auto Scaling group.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { AutoScalingClient, DetachLoadBalancerTargetGroupsCommand } from "@aws-sdk/client-auto-scaling"; // ES Modules import + * // const { AutoScalingClient, DetachLoadBalancerTargetGroupsCommand } = require("@aws-sdk/client-auto-scaling"); // CommonJS import + * const client = new AutoScalingClient(config); + * const command = new DetachLoadBalancerTargetGroupsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DetachLoadBalancerTargetGroupsCommandInput} for command's `input` shape. + * @see {@link DetachLoadBalancerTargetGroupsCommandOutput} for command's `response` shape. + * @see {@link AutoScalingClientResolvedConfig | config} for command's `input` shape. + * */ export class DetachLoadBalancerTargetGroupsCommand extends $Command< DetachLoadBalancerTargetGroupsCommandInput, diff --git a/clients/client-auto-scaling/commands/DetachLoadBalancersCommand.ts b/clients/client-auto-scaling/commands/DetachLoadBalancersCommand.ts index 067575892b36..bc78f3e4cf97 100644 --- a/clients/client-auto-scaling/commands/DetachLoadBalancersCommand.ts +++ b/clients/client-auto-scaling/commands/DetachLoadBalancersCommand.ts @@ -27,6 +27,20 @@ export interface DetachLoadBalancersCommandOutput extends DetachLoadBalancersRes *

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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { AutoScalingClient, DetachLoadBalancersCommand } from "@aws-sdk/client-auto-scaling"; // ES Modules import + * // const { AutoScalingClient, DetachLoadBalancersCommand } = require("@aws-sdk/client-auto-scaling"); // CommonJS import + * const client = new AutoScalingClient(config); + * const command = new DetachLoadBalancersCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DetachLoadBalancersCommandInput} for command's `input` shape. + * @see {@link DetachLoadBalancersCommandOutput} for command's `response` shape. + * @see {@link AutoScalingClientResolvedConfig | config} for command's `input` shape. + * */ export class DetachLoadBalancersCommand extends $Command< DetachLoadBalancersCommandInput, diff --git a/clients/client-auto-scaling/commands/DisableMetricsCollectionCommand.ts b/clients/client-auto-scaling/commands/DisableMetricsCollectionCommand.ts index 6e545932243a..763f6963e5d4 100644 --- a/clients/client-auto-scaling/commands/DisableMetricsCollectionCommand.ts +++ b/clients/client-auto-scaling/commands/DisableMetricsCollectionCommand.ts @@ -22,6 +22,20 @@ export interface DisableMetricsCollectionCommandOutput extends __MetadataBearer /** *

Disables group metrics for the specified Auto Scaling group.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { AutoScalingClient, DisableMetricsCollectionCommand } from "@aws-sdk/client-auto-scaling"; // ES Modules import + * // const { AutoScalingClient, DisableMetricsCollectionCommand } = require("@aws-sdk/client-auto-scaling"); // CommonJS import + * const client = new AutoScalingClient(config); + * const command = new DisableMetricsCollectionCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DisableMetricsCollectionCommandInput} for command's `input` shape. + * @see {@link DisableMetricsCollectionCommandOutput} for command's `response` shape. + * @see {@link AutoScalingClientResolvedConfig | config} for command's `input` shape. + * */ export class DisableMetricsCollectionCommand extends $Command< DisableMetricsCollectionCommandInput, diff --git a/clients/client-auto-scaling/commands/EnableMetricsCollectionCommand.ts b/clients/client-auto-scaling/commands/EnableMetricsCollectionCommand.ts index a0c15ff6d9a6..6e070ee7afb5 100644 --- a/clients/client-auto-scaling/commands/EnableMetricsCollectionCommand.ts +++ b/clients/client-auto-scaling/commands/EnableMetricsCollectionCommand.ts @@ -23,6 +23,20 @@ export interface EnableMetricsCollectionCommandOutput extends __MetadataBearer { /** *

Enables group metrics for the specified Auto Scaling group. For more information, see Monitoring CloudWatch metrics for your Auto Scaling groups and instances in the * Amazon EC2 Auto Scaling User Guide.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { AutoScalingClient, EnableMetricsCollectionCommand } from "@aws-sdk/client-auto-scaling"; // ES Modules import + * // const { AutoScalingClient, EnableMetricsCollectionCommand } = require("@aws-sdk/client-auto-scaling"); // CommonJS import + * const client = new AutoScalingClient(config); + * const command = new EnableMetricsCollectionCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link EnableMetricsCollectionCommandInput} for command's `input` shape. + * @see {@link EnableMetricsCollectionCommandOutput} for command's `response` shape. + * @see {@link AutoScalingClientResolvedConfig | config} for command's `input` shape. + * */ export class EnableMetricsCollectionCommand extends $Command< EnableMetricsCollectionCommandInput, diff --git a/clients/client-auto-scaling/commands/EnterStandbyCommand.ts b/clients/client-auto-scaling/commands/EnterStandbyCommand.ts index fc91bf287c47..7aa2239e29a6 100644 --- a/clients/client-auto-scaling/commands/EnterStandbyCommand.ts +++ b/clients/client-auto-scaling/commands/EnterStandbyCommand.ts @@ -28,6 +28,20 @@ export interface EnterStandbyCommandOutput extends EnterStandbyAnswer, __Metadat *

For more information, see Temporarily removing * instances from your Auto Scaling group in the * Amazon EC2 Auto Scaling User Guide.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { AutoScalingClient, EnterStandbyCommand } from "@aws-sdk/client-auto-scaling"; // ES Modules import + * // const { AutoScalingClient, EnterStandbyCommand } = require("@aws-sdk/client-auto-scaling"); // CommonJS import + * const client = new AutoScalingClient(config); + * const command = new EnterStandbyCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link EnterStandbyCommandInput} for command's `input` shape. + * @see {@link EnterStandbyCommandOutput} for command's `response` shape. + * @see {@link AutoScalingClientResolvedConfig | config} for command's `input` shape. + * */ export class EnterStandbyCommand extends $Command< EnterStandbyCommandInput, diff --git a/clients/client-auto-scaling/commands/ExecutePolicyCommand.ts b/clients/client-auto-scaling/commands/ExecutePolicyCommand.ts index fa6875b07ccc..c1a07668192f 100644 --- a/clients/client-auto-scaling/commands/ExecutePolicyCommand.ts +++ b/clients/client-auto-scaling/commands/ExecutePolicyCommand.ts @@ -23,6 +23,20 @@ export interface ExecutePolicyCommandOutput extends __MetadataBearer {} /** *

Executes the specified policy. This can be useful for testing the design of your * scaling policy.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { AutoScalingClient, ExecutePolicyCommand } from "@aws-sdk/client-auto-scaling"; // ES Modules import + * // const { AutoScalingClient, ExecutePolicyCommand } = require("@aws-sdk/client-auto-scaling"); // CommonJS import + * const client = new AutoScalingClient(config); + * const command = new ExecutePolicyCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ExecutePolicyCommandInput} for command's `input` shape. + * @see {@link ExecutePolicyCommandOutput} for command's `response` shape. + * @see {@link AutoScalingClientResolvedConfig | config} for command's `input` shape. + * */ export class ExecutePolicyCommand extends $Command< ExecutePolicyCommandInput, diff --git a/clients/client-auto-scaling/commands/ExitStandbyCommand.ts b/clients/client-auto-scaling/commands/ExitStandbyCommand.ts index 3512e5c825b7..dc9dcdeef17d 100644 --- a/clients/client-auto-scaling/commands/ExitStandbyCommand.ts +++ b/clients/client-auto-scaling/commands/ExitStandbyCommand.ts @@ -24,6 +24,20 @@ export interface ExitStandbyCommandOutput extends ExitStandbyAnswer, __MetadataB *

For more information, see Temporarily removing * instances from your Auto Scaling group in the * Amazon EC2 Auto Scaling User Guide.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { AutoScalingClient, ExitStandbyCommand } from "@aws-sdk/client-auto-scaling"; // ES Modules import + * // const { AutoScalingClient, ExitStandbyCommand } = require("@aws-sdk/client-auto-scaling"); // CommonJS import + * const client = new AutoScalingClient(config); + * const command = new ExitStandbyCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ExitStandbyCommandInput} for command's `input` shape. + * @see {@link ExitStandbyCommandOutput} for command's `response` shape. + * @see {@link AutoScalingClientResolvedConfig | config} for command's `input` shape. + * */ export class ExitStandbyCommand extends $Command< ExitStandbyCommandInput, diff --git a/clients/client-auto-scaling/commands/PutLifecycleHookCommand.ts b/clients/client-auto-scaling/commands/PutLifecycleHookCommand.ts index 481be3cc217d..a27bc67c2520 100644 --- a/clients/client-auto-scaling/commands/PutLifecycleHookCommand.ts +++ b/clients/client-auto-scaling/commands/PutLifecycleHookCommand.ts @@ -59,6 +59,20 @@ export interface PutLifecycleHookCommandOutput extends PutLifecycleHookAnswer, _ * 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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { AutoScalingClient, PutLifecycleHookCommand } from "@aws-sdk/client-auto-scaling"; // ES Modules import + * // const { AutoScalingClient, PutLifecycleHookCommand } = require("@aws-sdk/client-auto-scaling"); // CommonJS import + * const client = new AutoScalingClient(config); + * const command = new PutLifecycleHookCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link PutLifecycleHookCommandInput} for command's `input` shape. + * @see {@link PutLifecycleHookCommandOutput} for command's `response` shape. + * @see {@link AutoScalingClientResolvedConfig | config} for command's `input` shape. + * */ export class PutLifecycleHookCommand extends $Command< PutLifecycleHookCommandInput, diff --git a/clients/client-auto-scaling/commands/PutNotificationConfigurationCommand.ts b/clients/client-auto-scaling/commands/PutNotificationConfigurationCommand.ts index abcfaae846d3..6b310687a2d7 100644 --- a/clients/client-auto-scaling/commands/PutNotificationConfigurationCommand.ts +++ b/clients/client-auto-scaling/commands/PutNotificationConfigurationCommand.ts @@ -30,6 +30,20 @@ export interface PutNotificationConfigurationCommandOutput extends __MetadataBea * 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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { AutoScalingClient, PutNotificationConfigurationCommand } from "@aws-sdk/client-auto-scaling"; // ES Modules import + * // const { AutoScalingClient, PutNotificationConfigurationCommand } = require("@aws-sdk/client-auto-scaling"); // CommonJS import + * const client = new AutoScalingClient(config); + * const command = new PutNotificationConfigurationCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link PutNotificationConfigurationCommandInput} for command's `input` shape. + * @see {@link PutNotificationConfigurationCommandOutput} for command's `response` shape. + * @see {@link AutoScalingClientResolvedConfig | config} for command's `input` shape. + * */ export class PutNotificationConfigurationCommand extends $Command< PutNotificationConfigurationCommandInput, diff --git a/clients/client-auto-scaling/commands/PutScalingPolicyCommand.ts b/clients/client-auto-scaling/commands/PutScalingPolicyCommand.ts index e6000be07a66..c974b38c33a9 100644 --- a/clients/client-auto-scaling/commands/PutScalingPolicyCommand.ts +++ b/clients/client-auto-scaling/commands/PutScalingPolicyCommand.ts @@ -24,6 +24,20 @@ export interface PutScalingPolicyCommandOutput extends PolicyARNType, __Metadata *

Creates or updates a scaling policy for an Auto Scaling group.

*

For more information about using scaling policies to scale your Auto Scaling group, see Target tracking scaling policies and Step and simple scaling * policies in the Amazon EC2 Auto Scaling User Guide.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { AutoScalingClient, PutScalingPolicyCommand } from "@aws-sdk/client-auto-scaling"; // ES Modules import + * // const { AutoScalingClient, PutScalingPolicyCommand } = require("@aws-sdk/client-auto-scaling"); // CommonJS import + * const client = new AutoScalingClient(config); + * const command = new PutScalingPolicyCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link PutScalingPolicyCommandInput} for command's `input` shape. + * @see {@link PutScalingPolicyCommandOutput} for command's `response` shape. + * @see {@link AutoScalingClientResolvedConfig | config} for command's `input` shape. + * */ export class PutScalingPolicyCommand extends $Command< PutScalingPolicyCommandInput, diff --git a/clients/client-auto-scaling/commands/PutScheduledUpdateGroupActionCommand.ts b/clients/client-auto-scaling/commands/PutScheduledUpdateGroupActionCommand.ts index f80c3f7e5588..f3cc2e4d56d0 100644 --- a/clients/client-auto-scaling/commands/PutScheduledUpdateGroupActionCommand.ts +++ b/clients/client-auto-scaling/commands/PutScheduledUpdateGroupActionCommand.ts @@ -24,6 +24,20 @@ export interface PutScheduledUpdateGroupActionCommandOutput extends __MetadataBe *

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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { AutoScalingClient, PutScheduledUpdateGroupActionCommand } from "@aws-sdk/client-auto-scaling"; // ES Modules import + * // const { AutoScalingClient, PutScheduledUpdateGroupActionCommand } = require("@aws-sdk/client-auto-scaling"); // CommonJS import + * const client = new AutoScalingClient(config); + * const command = new PutScheduledUpdateGroupActionCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link PutScheduledUpdateGroupActionCommandInput} for command's `input` shape. + * @see {@link PutScheduledUpdateGroupActionCommandOutput} for command's `response` shape. + * @see {@link AutoScalingClientResolvedConfig | config} for command's `input` shape. + * */ export class PutScheduledUpdateGroupActionCommand extends $Command< PutScheduledUpdateGroupActionCommandInput, diff --git a/clients/client-auto-scaling/commands/PutWarmPoolCommand.ts b/clients/client-auto-scaling/commands/PutWarmPoolCommand.ts index 70b9ffbf33fa..18ec32d5769a 100644 --- a/clients/client-auto-scaling/commands/PutWarmPoolCommand.ts +++ b/clients/client-auto-scaling/commands/PutWarmPoolCommand.ts @@ -28,6 +28,20 @@ export interface PutWarmPoolCommandOutput extends PutWarmPoolAnswer, __MetadataB * 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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { AutoScalingClient, PutWarmPoolCommand } from "@aws-sdk/client-auto-scaling"; // ES Modules import + * // const { AutoScalingClient, PutWarmPoolCommand } = require("@aws-sdk/client-auto-scaling"); // CommonJS import + * const client = new AutoScalingClient(config); + * const command = new PutWarmPoolCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link PutWarmPoolCommandInput} for command's `input` shape. + * @see {@link PutWarmPoolCommandOutput} for command's `response` shape. + * @see {@link AutoScalingClientResolvedConfig | config} for command's `input` shape. + * */ export class PutWarmPoolCommand extends $Command< PutWarmPoolCommandInput, diff --git a/clients/client-auto-scaling/commands/RecordLifecycleActionHeartbeatCommand.ts b/clients/client-auto-scaling/commands/RecordLifecycleActionHeartbeatCommand.ts index a2bb51f76680..c1e767a374bf 100644 --- a/clients/client-auto-scaling/commands/RecordLifecycleActionHeartbeatCommand.ts +++ b/clients/client-auto-scaling/commands/RecordLifecycleActionHeartbeatCommand.ts @@ -56,6 +56,20 @@ export interface RecordLifecycleActionHeartbeatCommandOutput * *

For more information, see Amazon EC2 Auto Scaling lifecycle * hooks in the Amazon EC2 Auto Scaling User Guide.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { AutoScalingClient, RecordLifecycleActionHeartbeatCommand } from "@aws-sdk/client-auto-scaling"; // ES Modules import + * // const { AutoScalingClient, RecordLifecycleActionHeartbeatCommand } = require("@aws-sdk/client-auto-scaling"); // CommonJS import + * const client = new AutoScalingClient(config); + * const command = new RecordLifecycleActionHeartbeatCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link RecordLifecycleActionHeartbeatCommandInput} for command's `input` shape. + * @see {@link RecordLifecycleActionHeartbeatCommandOutput} for command's `response` shape. + * @see {@link AutoScalingClientResolvedConfig | config} for command's `input` shape. + * */ export class RecordLifecycleActionHeartbeatCommand extends $Command< RecordLifecycleActionHeartbeatCommandInput, diff --git a/clients/client-auto-scaling/commands/ResumeProcessesCommand.ts b/clients/client-auto-scaling/commands/ResumeProcessesCommand.ts index b89e10a05516..159bebeb6308 100644 --- a/clients/client-auto-scaling/commands/ResumeProcessesCommand.ts +++ b/clients/client-auto-scaling/commands/ResumeProcessesCommand.ts @@ -25,6 +25,20 @@ export interface ResumeProcessesCommandOutput extends __MetadataBearer {} * the specified Auto Scaling group.

*

For more information, see Suspending and * resuming scaling processes in the Amazon EC2 Auto Scaling User Guide.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { AutoScalingClient, ResumeProcessesCommand } from "@aws-sdk/client-auto-scaling"; // ES Modules import + * // const { AutoScalingClient, ResumeProcessesCommand } = require("@aws-sdk/client-auto-scaling"); // CommonJS import + * const client = new AutoScalingClient(config); + * const command = new ResumeProcessesCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ResumeProcessesCommandInput} for command's `input` shape. + * @see {@link ResumeProcessesCommandOutput} for command's `response` shape. + * @see {@link AutoScalingClientResolvedConfig | config} for command's `input` shape. + * */ export class ResumeProcessesCommand extends $Command< ResumeProcessesCommandInput, diff --git a/clients/client-auto-scaling/commands/SetDesiredCapacityCommand.ts b/clients/client-auto-scaling/commands/SetDesiredCapacityCommand.ts index 068fb3f44b2e..c81ac0237062 100644 --- a/clients/client-auto-scaling/commands/SetDesiredCapacityCommand.ts +++ b/clients/client-auto-scaling/commands/SetDesiredCapacityCommand.ts @@ -27,6 +27,20 @@ export interface SetDesiredCapacityCommandOutput extends __MetadataBearer {} * policy to determine which instances to terminate.

*

For more information, see Manual scaling in the * Amazon EC2 Auto Scaling User Guide.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { AutoScalingClient, SetDesiredCapacityCommand } from "@aws-sdk/client-auto-scaling"; // ES Modules import + * // const { AutoScalingClient, SetDesiredCapacityCommand } = require("@aws-sdk/client-auto-scaling"); // CommonJS import + * const client = new AutoScalingClient(config); + * const command = new SetDesiredCapacityCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link SetDesiredCapacityCommandInput} for command's `input` shape. + * @see {@link SetDesiredCapacityCommandOutput} for command's `response` shape. + * @see {@link AutoScalingClientResolvedConfig | config} for command's `input` shape. + * */ export class SetDesiredCapacityCommand extends $Command< SetDesiredCapacityCommandInput, diff --git a/clients/client-auto-scaling/commands/SetInstanceHealthCommand.ts b/clients/client-auto-scaling/commands/SetInstanceHealthCommand.ts index d6acaea6f7d1..ec5b9dd6f6df 100644 --- a/clients/client-auto-scaling/commands/SetInstanceHealthCommand.ts +++ b/clients/client-auto-scaling/commands/SetInstanceHealthCommand.ts @@ -24,6 +24,20 @@ export interface SetInstanceHealthCommandOutput extends __MetadataBearer {} *

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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { AutoScalingClient, SetInstanceHealthCommand } from "@aws-sdk/client-auto-scaling"; // ES Modules import + * // const { AutoScalingClient, SetInstanceHealthCommand } = require("@aws-sdk/client-auto-scaling"); // CommonJS import + * const client = new AutoScalingClient(config); + * const command = new SetInstanceHealthCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link SetInstanceHealthCommandInput} for command's `input` shape. + * @see {@link SetInstanceHealthCommandOutput} for command's `response` shape. + * @see {@link AutoScalingClientResolvedConfig | config} for command's `input` shape. + * */ export class SetInstanceHealthCommand extends $Command< SetInstanceHealthCommandInput, diff --git a/clients/client-auto-scaling/commands/SetInstanceProtectionCommand.ts b/clients/client-auto-scaling/commands/SetInstanceProtectionCommand.ts index a0ffe7aaf258..d069c310f654 100644 --- a/clients/client-auto-scaling/commands/SetInstanceProtectionCommand.ts +++ b/clients/client-auto-scaling/commands/SetInstanceProtectionCommand.ts @@ -28,6 +28,20 @@ export interface SetInstanceProtectionCommandOutput extends SetInstanceProtectio * 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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { AutoScalingClient, SetInstanceProtectionCommand } from "@aws-sdk/client-auto-scaling"; // ES Modules import + * // const { AutoScalingClient, SetInstanceProtectionCommand } = require("@aws-sdk/client-auto-scaling"); // CommonJS import + * const client = new AutoScalingClient(config); + * const command = new SetInstanceProtectionCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link SetInstanceProtectionCommandInput} for command's `input` shape. + * @see {@link SetInstanceProtectionCommandOutput} for command's `response` shape. + * @see {@link AutoScalingClientResolvedConfig | config} for command's `input` shape. + * */ export class SetInstanceProtectionCommand extends $Command< SetInstanceProtectionCommandInput, diff --git a/clients/client-auto-scaling/commands/StartInstanceRefreshCommand.ts b/clients/client-auto-scaling/commands/StartInstanceRefreshCommand.ts index 415b9d5b1824..dade9cf99d11 100644 --- a/clients/client-auto-scaling/commands/StartInstanceRefreshCommand.ts +++ b/clients/client-auto-scaling/commands/StartInstanceRefreshCommand.ts @@ -31,6 +31,20 @@ export interface StartInstanceRefreshCommandOutput extends StartInstanceRefreshA *

For more information, see Replacing Auto Scaling instances * based on an instance refresh in the * Amazon EC2 Auto Scaling User Guide.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { AutoScalingClient, StartInstanceRefreshCommand } from "@aws-sdk/client-auto-scaling"; // ES Modules import + * // const { AutoScalingClient, StartInstanceRefreshCommand } = require("@aws-sdk/client-auto-scaling"); // CommonJS import + * const client = new AutoScalingClient(config); + * const command = new StartInstanceRefreshCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link StartInstanceRefreshCommandInput} for command's `input` shape. + * @see {@link StartInstanceRefreshCommandOutput} for command's `response` shape. + * @see {@link AutoScalingClientResolvedConfig | config} for command's `input` shape. + * */ export class StartInstanceRefreshCommand extends $Command< StartInstanceRefreshCommandInput, diff --git a/clients/client-auto-scaling/commands/SuspendProcessesCommand.ts b/clients/client-auto-scaling/commands/SuspendProcessesCommand.ts index efc791a94d5f..ef051707b395 100644 --- a/clients/client-auto-scaling/commands/SuspendProcessesCommand.ts +++ b/clients/client-auto-scaling/commands/SuspendProcessesCommand.ts @@ -28,6 +28,20 @@ export interface SuspendProcessesCommandOutput extends __MetadataBearer {} * Suspending and * resuming scaling processes in the Amazon EC2 Auto Scaling User Guide.

*

To resume processes that have been suspended, call the ResumeProcesses API.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { AutoScalingClient, SuspendProcessesCommand } from "@aws-sdk/client-auto-scaling"; // ES Modules import + * // const { AutoScalingClient, SuspendProcessesCommand } = require("@aws-sdk/client-auto-scaling"); // CommonJS import + * const client = new AutoScalingClient(config); + * const command = new SuspendProcessesCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link SuspendProcessesCommandInput} for command's `input` shape. + * @see {@link SuspendProcessesCommandOutput} for command's `response` shape. + * @see {@link AutoScalingClientResolvedConfig | config} for command's `input` shape. + * */ export class SuspendProcessesCommand extends $Command< SuspendProcessesCommandInput, diff --git a/clients/client-auto-scaling/commands/TerminateInstanceInAutoScalingGroupCommand.ts b/clients/client-auto-scaling/commands/TerminateInstanceInAutoScalingGroupCommand.ts index 3203a4ae0718..f9865f87724c 100644 --- a/clients/client-auto-scaling/commands/TerminateInstanceInAutoScalingGroupCommand.ts +++ b/clients/client-auto-scaling/commands/TerminateInstanceInAutoScalingGroupCommand.ts @@ -33,6 +33,20 @@ export interface TerminateInstanceInAutoScalingGroupCommandOutput extends Activi * 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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { AutoScalingClient, TerminateInstanceInAutoScalingGroupCommand } from "@aws-sdk/client-auto-scaling"; // ES Modules import + * // const { AutoScalingClient, TerminateInstanceInAutoScalingGroupCommand } = require("@aws-sdk/client-auto-scaling"); // CommonJS import + * const client = new AutoScalingClient(config); + * const command = new TerminateInstanceInAutoScalingGroupCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link TerminateInstanceInAutoScalingGroupCommandInput} for command's `input` shape. + * @see {@link TerminateInstanceInAutoScalingGroupCommandOutput} for command's `response` shape. + * @see {@link AutoScalingClientResolvedConfig | config} for command's `input` shape. + * */ export class TerminateInstanceInAutoScalingGroupCommand extends $Command< TerminateInstanceInAutoScalingGroupCommandInput, diff --git a/clients/client-auto-scaling/commands/UpdateAutoScalingGroupCommand.ts b/clients/client-auto-scaling/commands/UpdateAutoScalingGroupCommand.ts index f6474ae66b30..28b3745dbd16 100644 --- a/clients/client-auto-scaling/commands/UpdateAutoScalingGroupCommand.ts +++ b/clients/client-auto-scaling/commands/UpdateAutoScalingGroupCommand.ts @@ -66,6 +66,20 @@ export interface UpdateAutoScalingGroupCommandOutput extends __MetadataBearer {} * group, call the DescribePolicies API. If the group has scaling * policies, you can update them by calling the PutScalingPolicy * API.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { AutoScalingClient, UpdateAutoScalingGroupCommand } from "@aws-sdk/client-auto-scaling"; // ES Modules import + * // const { AutoScalingClient, UpdateAutoScalingGroupCommand } = require("@aws-sdk/client-auto-scaling"); // CommonJS import + * const client = new AutoScalingClient(config); + * const command = new UpdateAutoScalingGroupCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link UpdateAutoScalingGroupCommandInput} for command's `input` shape. + * @see {@link UpdateAutoScalingGroupCommandOutput} for command's `response` shape. + * @see {@link AutoScalingClientResolvedConfig | config} for command's `input` shape. + * */ export class UpdateAutoScalingGroupCommand extends $Command< UpdateAutoScalingGroupCommandInput, diff --git a/clients/client-auto-scaling/models/models_0.ts b/clients/client-auto-scaling/models/models_0.ts index a5c0016566b3..2dc24d10c1eb 100644 --- a/clients/client-auto-scaling/models/models_0.ts +++ b/clients/client-auto-scaling/models/models_0.ts @@ -12,6 +12,9 @@ export interface ActiveInstanceRefreshNotFoundFault extends __SmithyException, $ } export namespace ActiveInstanceRefreshNotFoundFault { + /** + * @internal + */ export const filterSensitiveLog = (obj: ActiveInstanceRefreshNotFoundFault): any => ({ ...obj, }); @@ -100,6 +103,9 @@ export interface Activity { } export namespace Activity { + /** + * @internal + */ export const filterSensitiveLog = (obj: Activity): any => ({ ...obj, }); @@ -122,6 +128,9 @@ export interface ActivitiesType { } export namespace ActivitiesType { + /** + * @internal + */ export const filterSensitiveLog = (obj: ActivitiesType): any => ({ ...obj, }); @@ -135,6 +144,9 @@ export interface ActivityType { } export namespace ActivityType { + /** + * @internal + */ export const filterSensitiveLog = (obj: ActivityType): any => ({ ...obj, }); @@ -152,6 +164,9 @@ export interface AdjustmentType { } export namespace AdjustmentType { + /** + * @internal + */ export const filterSensitiveLog = (obj: AdjustmentType): any => ({ ...obj, }); @@ -173,6 +188,9 @@ export interface Alarm { } export namespace Alarm { + /** + * @internal + */ export const filterSensitiveLog = (obj: Alarm): any => ({ ...obj, }); @@ -191,6 +209,9 @@ export interface AlreadyExistsFault extends __SmithyException, $MetadataBearer { } export namespace AlreadyExistsFault { + /** + * @internal + */ export const filterSensitiveLog = (obj: AlreadyExistsFault): any => ({ ...obj, }); @@ -209,6 +230,9 @@ export interface AttachInstancesQuery { } export namespace AttachInstancesQuery { + /** + * @internal + */ export const filterSensitiveLog = (obj: AttachInstancesQuery): any => ({ ...obj, }); @@ -228,6 +252,9 @@ export interface ResourceContentionFault extends __SmithyException, $MetadataBea } export namespace ResourceContentionFault { + /** + * @internal + */ export const filterSensitiveLog = (obj: ResourceContentionFault): any => ({ ...obj, }); @@ -243,6 +270,9 @@ export interface ServiceLinkedRoleFailure extends __SmithyException, $MetadataBe } export namespace ServiceLinkedRoleFailure { + /** + * @internal + */ export const filterSensitiveLog = (obj: ServiceLinkedRoleFailure): any => ({ ...obj, }); @@ -251,6 +281,9 @@ export namespace ServiceLinkedRoleFailure { export interface AttachLoadBalancersResultType {} export namespace AttachLoadBalancersResultType { + /** + * @internal + */ export const filterSensitiveLog = (obj: AttachLoadBalancersResultType): any => ({ ...obj, }); @@ -269,6 +302,9 @@ export interface AttachLoadBalancersType { } export namespace AttachLoadBalancersType { + /** + * @internal + */ export const filterSensitiveLog = (obj: AttachLoadBalancersType): any => ({ ...obj, }); @@ -277,6 +313,9 @@ export namespace AttachLoadBalancersType { export interface AttachLoadBalancerTargetGroupsResultType {} export namespace AttachLoadBalancerTargetGroupsResultType { + /** + * @internal + */ export const filterSensitiveLog = (obj: AttachLoadBalancerTargetGroupsResultType): any => ({ ...obj, }); @@ -296,6 +335,9 @@ export interface AttachLoadBalancerTargetGroupsType { } export namespace AttachLoadBalancerTargetGroupsType { + /** + * @internal + */ export const filterSensitiveLog = (obj: AttachLoadBalancerTargetGroupsType): any => ({ ...obj, }); @@ -322,6 +364,9 @@ export interface FailedScheduledUpdateGroupActionRequest { } export namespace FailedScheduledUpdateGroupActionRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: FailedScheduledUpdateGroupActionRequest): any => ({ ...obj, }); @@ -336,6 +381,9 @@ export interface BatchDeleteScheduledActionAnswer { } export namespace BatchDeleteScheduledActionAnswer { + /** + * @internal + */ export const filterSensitiveLog = (obj: BatchDeleteScheduledActionAnswer): any => ({ ...obj, }); @@ -355,6 +403,9 @@ export interface BatchDeleteScheduledActionType { } export namespace BatchDeleteScheduledActionType { + /** + * @internal + */ export const filterSensitiveLog = (obj: BatchDeleteScheduledActionType): any => ({ ...obj, }); @@ -369,6 +420,9 @@ export interface BatchPutScheduledUpdateGroupActionAnswer { } export namespace BatchPutScheduledUpdateGroupActionAnswer { + /** + * @internal + */ export const filterSensitiveLog = (obj: BatchPutScheduledUpdateGroupActionAnswer): any => ({ ...obj, }); @@ -438,6 +492,9 @@ export interface ScheduledUpdateGroupActionRequest { } export namespace ScheduledUpdateGroupActionRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ScheduledUpdateGroupActionRequest): any => ({ ...obj, }); @@ -456,6 +513,9 @@ export interface BatchPutScheduledUpdateGroupActionType { } export namespace BatchPutScheduledUpdateGroupActionType { + /** + * @internal + */ export const filterSensitiveLog = (obj: BatchPutScheduledUpdateGroupActionType): any => ({ ...obj, }); @@ -477,6 +537,9 @@ export interface LimitExceededFault extends __SmithyException, $MetadataBearer { } export namespace LimitExceededFault { + /** + * @internal + */ export const filterSensitiveLog = (obj: LimitExceededFault): any => ({ ...obj, }); @@ -490,6 +553,9 @@ export interface CancelInstanceRefreshAnswer { } export namespace CancelInstanceRefreshAnswer { + /** + * @internal + */ export const filterSensitiveLog = (obj: CancelInstanceRefreshAnswer): any => ({ ...obj, }); @@ -503,6 +569,9 @@ export interface CancelInstanceRefreshType { } export namespace CancelInstanceRefreshType { + /** + * @internal + */ export const filterSensitiveLog = (obj: CancelInstanceRefreshType): any => ({ ...obj, }); @@ -511,6 +580,9 @@ export namespace CancelInstanceRefreshType { export interface CompleteLifecycleActionAnswer {} export namespace CompleteLifecycleActionAnswer { + /** + * @internal + */ export const filterSensitiveLog = (obj: CompleteLifecycleActionAnswer): any => ({ ...obj, }); @@ -547,6 +619,9 @@ export interface CompleteLifecycleActionType { } export namespace CompleteLifecycleActionType { + /** + * @internal + */ export const filterSensitiveLog = (obj: CompleteLifecycleActionType): any => ({ ...obj, }); @@ -588,6 +663,9 @@ export interface LaunchTemplateSpecification { } export namespace LaunchTemplateSpecification { + /** + * @internal + */ export const filterSensitiveLog = (obj: LaunchTemplateSpecification): any => ({ ...obj, }); @@ -687,6 +765,9 @@ export interface LifecycleHookSpecification { } export namespace LifecycleHookSpecification { + /** + * @internal + */ export const filterSensitiveLog = (obj: LifecycleHookSpecification): any => ({ ...obj, }); @@ -768,6 +849,9 @@ export interface InstancesDistribution { } export namespace InstancesDistribution { + /** + * @internal + */ export const filterSensitiveLog = (obj: InstancesDistribution): any => ({ ...obj, }); @@ -814,6 +898,9 @@ export interface LaunchTemplateOverrides { } export namespace LaunchTemplateOverrides { + /** + * @internal + */ export const filterSensitiveLog = (obj: LaunchTemplateOverrides): any => ({ ...obj, }); @@ -842,6 +929,9 @@ export interface LaunchTemplate { } export namespace LaunchTemplate { + /** + * @internal + */ export const filterSensitiveLog = (obj: LaunchTemplate): any => ({ ...obj, }); @@ -873,6 +963,9 @@ export interface MixedInstancesPolicy { } export namespace MixedInstancesPolicy { + /** + * @internal + */ export const filterSensitiveLog = (obj: MixedInstancesPolicy): any => ({ ...obj, }); @@ -911,6 +1004,9 @@ export interface Tag { } export namespace Tag { + /** + * @internal + */ export const filterSensitiveLog = (obj: Tag): any => ({ ...obj, }); @@ -1128,6 +1224,9 @@ export interface CreateAutoScalingGroupType { } export namespace CreateAutoScalingGroupType { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateAutoScalingGroupType): any => ({ ...obj, }); @@ -1213,6 +1312,9 @@ export interface Ebs { } export namespace Ebs { + /** + * @internal + */ export const filterSensitiveLog = (obj: Ebs): any => ({ ...obj, }); @@ -1255,6 +1357,9 @@ export interface BlockDeviceMapping { } export namespace BlockDeviceMapping { + /** + * @internal + */ export const filterSensitiveLog = (obj: BlockDeviceMapping): any => ({ ...obj, }); @@ -1272,6 +1377,9 @@ export interface InstanceMonitoring { } export namespace InstanceMonitoring { + /** + * @internal + */ export const filterSensitiveLog = (obj: InstanceMonitoring): any => ({ ...obj, }); @@ -1326,6 +1434,9 @@ export interface InstanceMetadataOptions { } export namespace InstanceMetadataOptions { + /** + * @internal + */ export const filterSensitiveLog = (obj: InstanceMetadataOptions): any => ({ ...obj, }); @@ -1521,6 +1632,9 @@ export interface CreateLaunchConfigurationType { } export namespace CreateLaunchConfigurationType { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateLaunchConfigurationType): any => ({ ...obj, }); @@ -1534,6 +1648,9 @@ export interface CreateOrUpdateTagsType { } export namespace CreateOrUpdateTagsType { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateOrUpdateTagsType): any => ({ ...obj, }); @@ -1552,6 +1669,9 @@ export interface ResourceInUseFault extends __SmithyException, $MetadataBearer { } export namespace ResourceInUseFault { + /** + * @internal + */ export const filterSensitiveLog = (obj: ResourceInUseFault): any => ({ ...obj, }); @@ -1572,6 +1692,9 @@ export interface DeleteAutoScalingGroupType { } export namespace DeleteAutoScalingGroupType { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteAutoScalingGroupType): any => ({ ...obj, }); @@ -1591,6 +1714,9 @@ export interface ScalingActivityInProgressFault extends __SmithyException, $Meta } export namespace ScalingActivityInProgressFault { + /** + * @internal + */ export const filterSensitiveLog = (obj: ScalingActivityInProgressFault): any => ({ ...obj, }); @@ -1604,6 +1730,9 @@ export interface LaunchConfigurationNameType { } export namespace LaunchConfigurationNameType { + /** + * @internal + */ export const filterSensitiveLog = (obj: LaunchConfigurationNameType): any => ({ ...obj, }); @@ -1612,6 +1741,9 @@ export namespace LaunchConfigurationNameType { export interface DeleteLifecycleHookAnswer {} export namespace DeleteLifecycleHookAnswer { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteLifecycleHookAnswer): any => ({ ...obj, }); @@ -1630,6 +1762,9 @@ export interface DeleteLifecycleHookType { } export namespace DeleteLifecycleHookType { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteLifecycleHookType): any => ({ ...obj, }); @@ -1649,6 +1784,9 @@ export interface DeleteNotificationConfigurationType { } export namespace DeleteNotificationConfigurationType { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteNotificationConfigurationType): any => ({ ...obj, }); @@ -1667,6 +1805,9 @@ export interface DeletePolicyType { } export namespace DeletePolicyType { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeletePolicyType): any => ({ ...obj, }); @@ -1685,6 +1826,9 @@ export interface DeleteScheduledActionType { } export namespace DeleteScheduledActionType { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteScheduledActionType): any => ({ ...obj, }); @@ -1698,6 +1842,9 @@ export interface DeleteTagsType { } export namespace DeleteTagsType { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteTagsType): any => ({ ...obj, }); @@ -1706,6 +1853,9 @@ export namespace DeleteTagsType { export interface DeleteWarmPoolAnswer {} export namespace DeleteWarmPoolAnswer { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteWarmPoolAnswer): any => ({ ...obj, }); @@ -1727,6 +1877,9 @@ export interface DeleteWarmPoolType { } export namespace DeleteWarmPoolType { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteWarmPoolType): any => ({ ...obj, }); @@ -1757,6 +1910,9 @@ export interface DescribeAccountLimitsAnswer { } export namespace DescribeAccountLimitsAnswer { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeAccountLimitsAnswer): any => ({ ...obj, }); @@ -1770,6 +1926,9 @@ export interface DescribeAdjustmentTypesAnswer { } export namespace DescribeAdjustmentTypesAnswer { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeAdjustmentTypesAnswer): any => ({ ...obj, }); @@ -1797,6 +1956,9 @@ export interface AutoScalingGroupNamesType { } export namespace AutoScalingGroupNamesType { + /** + * @internal + */ export const filterSensitiveLog = (obj: AutoScalingGroupNamesType): any => ({ ...obj, }); @@ -1920,6 +2082,9 @@ export interface EnabledMetric { } export namespace EnabledMetric { + /** + * @internal + */ export const filterSensitiveLog = (obj: EnabledMetric): any => ({ ...obj, }); @@ -2008,6 +2173,9 @@ export interface Instance { } export namespace Instance { + /** + * @internal + */ export const filterSensitiveLog = (obj: Instance): any => ({ ...obj, }); @@ -2030,6 +2198,9 @@ export interface SuspendedProcess { } export namespace SuspendedProcess { + /** + * @internal + */ export const filterSensitiveLog = (obj: SuspendedProcess): any => ({ ...obj, }); @@ -2068,6 +2239,9 @@ export interface TagDescription { } export namespace TagDescription { + /** + * @internal + */ export const filterSensitiveLog = (obj: TagDescription): any => ({ ...obj, }); @@ -2110,6 +2284,9 @@ export interface WarmPoolConfiguration { } export namespace WarmPoolConfiguration { + /** + * @internal + */ export const filterSensitiveLog = (obj: WarmPoolConfiguration): any => ({ ...obj, }); @@ -2274,6 +2451,9 @@ export interface AutoScalingGroup { } export namespace AutoScalingGroup { + /** + * @internal + */ export const filterSensitiveLog = (obj: AutoScalingGroup): any => ({ ...obj, }); @@ -2295,6 +2475,9 @@ export interface AutoScalingGroupsType { } export namespace AutoScalingGroupsType { + /** + * @internal + */ export const filterSensitiveLog = (obj: AutoScalingGroupsType): any => ({ ...obj, }); @@ -2313,6 +2496,9 @@ export interface InvalidNextToken extends __SmithyException, $MetadataBearer { } export namespace InvalidNextToken { + /** + * @internal + */ export const filterSensitiveLog = (obj: InvalidNextToken): any => ({ ...obj, }); @@ -2393,6 +2579,9 @@ export interface AutoScalingInstanceDetails { } export namespace AutoScalingInstanceDetails { + /** + * @internal + */ export const filterSensitiveLog = (obj: AutoScalingInstanceDetails): any => ({ ...obj, }); @@ -2414,6 +2603,9 @@ export interface AutoScalingInstancesType { } export namespace AutoScalingInstancesType { + /** + * @internal + */ export const filterSensitiveLog = (obj: AutoScalingInstancesType): any => ({ ...obj, }); @@ -2441,6 +2633,9 @@ export interface DescribeAutoScalingInstancesType { } export namespace DescribeAutoScalingInstancesType { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeAutoScalingInstancesType): any => ({ ...obj, }); @@ -2454,6 +2649,9 @@ export interface DescribeAutoScalingNotificationTypesAnswer { } export namespace DescribeAutoScalingNotificationTypesAnswer { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeAutoScalingNotificationTypesAnswer): any => ({ ...obj, }); @@ -2479,6 +2677,9 @@ export interface InstanceRefreshLivePoolProgress { } export namespace InstanceRefreshLivePoolProgress { + /** + * @internal + */ export const filterSensitiveLog = (obj: InstanceRefreshLivePoolProgress): any => ({ ...obj, }); @@ -2504,6 +2705,9 @@ export interface InstanceRefreshWarmPoolProgress { } export namespace InstanceRefreshWarmPoolProgress { + /** + * @internal + */ export const filterSensitiveLog = (obj: InstanceRefreshWarmPoolProgress): any => ({ ...obj, }); @@ -2529,6 +2733,9 @@ export interface InstanceRefreshProgressDetails { } export namespace InstanceRefreshProgressDetails { + /** + * @internal + */ export const filterSensitiveLog = (obj: InstanceRefreshProgressDetails): any => ({ ...obj, }); @@ -2628,6 +2835,9 @@ export interface InstanceRefresh { } export namespace InstanceRefresh { + /** + * @internal + */ export const filterSensitiveLog = (obj: InstanceRefresh): any => ({ ...obj, }); @@ -2649,6 +2859,9 @@ export interface DescribeInstanceRefreshesAnswer { } export namespace DescribeInstanceRefreshesAnswer { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeInstanceRefreshesAnswer): any => ({ ...obj, }); @@ -2679,6 +2892,9 @@ export interface DescribeInstanceRefreshesType { } export namespace DescribeInstanceRefreshesType { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeInstanceRefreshesType): any => ({ ...obj, }); @@ -2705,6 +2921,9 @@ export interface LaunchConfigurationNamesType { } export namespace LaunchConfigurationNamesType { + /** + * @internal + */ export const filterSensitiveLog = (obj: LaunchConfigurationNamesType): any => ({ ...obj, }); @@ -2858,6 +3077,9 @@ export interface LaunchConfiguration { } export namespace LaunchConfiguration { + /** + * @internal + */ export const filterSensitiveLog = (obj: LaunchConfiguration): any => ({ ...obj, }); @@ -2879,6 +3101,9 @@ export interface LaunchConfigurationsType { } export namespace LaunchConfigurationsType { + /** + * @internal + */ export const filterSensitiveLog = (obj: LaunchConfigurationsType): any => ({ ...obj, }); @@ -2957,6 +3182,9 @@ export interface LifecycleHook { } export namespace LifecycleHook { + /** + * @internal + */ export const filterSensitiveLog = (obj: LifecycleHook): any => ({ ...obj, }); @@ -2970,6 +3198,9 @@ export interface DescribeLifecycleHooksAnswer { } export namespace DescribeLifecycleHooksAnswer { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeLifecycleHooksAnswer): any => ({ ...obj, }); @@ -2989,6 +3220,9 @@ export interface DescribeLifecycleHooksType { } export namespace DescribeLifecycleHooksType { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeLifecycleHooksType): any => ({ ...obj, }); @@ -3002,6 +3236,9 @@ export interface DescribeLifecycleHookTypesAnswer { } export namespace DescribeLifecycleHookTypesAnswer { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeLifecycleHookTypesAnswer): any => ({ ...obj, }); @@ -3027,6 +3264,9 @@ export interface DescribeLoadBalancersRequest { } export namespace DescribeLoadBalancersRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeLoadBalancersRequest): any => ({ ...obj, }); @@ -3084,6 +3324,9 @@ export interface LoadBalancerState { } export namespace LoadBalancerState { + /** + * @internal + */ export const filterSensitiveLog = (obj: LoadBalancerState): any => ({ ...obj, }); @@ -3105,6 +3348,9 @@ export interface DescribeLoadBalancersResponse { } export namespace DescribeLoadBalancersResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeLoadBalancersResponse): any => ({ ...obj, }); @@ -3130,6 +3376,9 @@ export interface DescribeLoadBalancerTargetGroupsRequest { } export namespace DescribeLoadBalancerTargetGroupsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeLoadBalancerTargetGroupsRequest): any => ({ ...obj, }); @@ -3185,6 +3434,9 @@ export interface LoadBalancerTargetGroupState { } export namespace LoadBalancerTargetGroupState { + /** + * @internal + */ export const filterSensitiveLog = (obj: LoadBalancerTargetGroupState): any => ({ ...obj, }); @@ -3206,6 +3458,9 @@ export interface DescribeLoadBalancerTargetGroupsResponse { } export namespace DescribeLoadBalancerTargetGroupsResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeLoadBalancerTargetGroupsResponse): any => ({ ...obj, }); @@ -3222,6 +3477,9 @@ export interface MetricGranularityType { } export namespace MetricGranularityType { + /** + * @internal + */ export const filterSensitiveLog = (obj: MetricGranularityType): any => ({ ...obj, }); @@ -3340,6 +3598,9 @@ export interface MetricCollectionType { } export namespace MetricCollectionType { + /** + * @internal + */ export const filterSensitiveLog = (obj: MetricCollectionType): any => ({ ...obj, }); @@ -3358,6 +3619,9 @@ export interface DescribeMetricCollectionTypesAnswer { } export namespace DescribeMetricCollectionTypesAnswer { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeMetricCollectionTypesAnswer): any => ({ ...obj, }); @@ -3412,6 +3676,9 @@ export interface NotificationConfiguration { } export namespace NotificationConfiguration { + /** + * @internal + */ export const filterSensitiveLog = (obj: NotificationConfiguration): any => ({ ...obj, }); @@ -3433,6 +3700,9 @@ export interface DescribeNotificationConfigurationsAnswer { } export namespace DescribeNotificationConfigurationsAnswer { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeNotificationConfigurationsAnswer): any => ({ ...obj, }); @@ -3458,6 +3728,9 @@ export interface DescribeNotificationConfigurationsType { } export namespace DescribeNotificationConfigurationsType { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeNotificationConfigurationsType): any => ({ ...obj, }); @@ -3497,6 +3770,9 @@ export interface DescribePoliciesType { } export namespace DescribePoliciesType { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribePoliciesType): any => ({ ...obj, }); @@ -3568,6 +3844,9 @@ export interface StepAdjustment { } export namespace StepAdjustment { + /** + * @internal + */ export const filterSensitiveLog = (obj: StepAdjustment): any => ({ ...obj, }); @@ -3589,6 +3868,9 @@ export interface MetricDimension { } export namespace MetricDimension { + /** + * @internal + */ export const filterSensitiveLog = (obj: MetricDimension): any => ({ ...obj, }); @@ -3654,6 +3936,9 @@ export interface CustomizedMetricSpecification { } export namespace CustomizedMetricSpecification { + /** + * @internal + */ export const filterSensitiveLog = (obj: CustomizedMetricSpecification): any => ({ ...obj, }); @@ -3726,6 +4011,9 @@ export interface PredefinedMetricSpecification { } export namespace PredefinedMetricSpecification { + /** + * @internal + */ export const filterSensitiveLog = (obj: PredefinedMetricSpecification): any => ({ ...obj, }); @@ -3762,6 +4050,9 @@ export interface TargetTrackingConfiguration { } export namespace TargetTrackingConfiguration { + /** + * @internal + */ export const filterSensitiveLog = (obj: TargetTrackingConfiguration): any => ({ ...obj, }); @@ -3879,6 +4170,9 @@ export interface ScalingPolicy { } export namespace ScalingPolicy { + /** + * @internal + */ export const filterSensitiveLog = (obj: ScalingPolicy): any => ({ ...obj, }); @@ -3900,6 +4194,9 @@ export interface PoliciesType { } export namespace PoliciesType { + /** + * @internal + */ export const filterSensitiveLog = (obj: PoliciesType): any => ({ ...obj, }); @@ -3938,6 +4235,9 @@ export interface DescribeScalingActivitiesType { } export namespace DescribeScalingActivitiesType { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeScalingActivitiesType): any => ({ ...obj, }); @@ -4002,6 +4302,9 @@ export interface ProcessType { } export namespace ProcessType { + /** + * @internal + */ export const filterSensitiveLog = (obj: ProcessType): any => ({ ...obj, }); @@ -4015,6 +4318,9 @@ export interface ProcessesType { } export namespace ProcessesType { + /** + * @internal + */ export const filterSensitiveLog = (obj: ProcessesType): any => ({ ...obj, }); @@ -4059,6 +4365,9 @@ export interface DescribeScheduledActionsType { } export namespace DescribeScheduledActionsType { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeScheduledActionsType): any => ({ ...obj, }); @@ -4134,6 +4443,9 @@ export interface ScheduledUpdateGroupAction { } export namespace ScheduledUpdateGroupAction { + /** + * @internal + */ export const filterSensitiveLog = (obj: ScheduledUpdateGroupAction): any => ({ ...obj, }); @@ -4155,6 +4467,9 @@ export interface ScheduledActionsType { } export namespace ScheduledActionsType { + /** + * @internal + */ export const filterSensitiveLog = (obj: ScheduledActionsType): any => ({ ...obj, }); @@ -4180,6 +4495,9 @@ export interface Filter { } export namespace Filter { + /** + * @internal + */ export const filterSensitiveLog = (obj: Filter): any => ({ ...obj, }); @@ -4206,6 +4524,9 @@ export interface DescribeTagsType { } export namespace DescribeTagsType { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeTagsType): any => ({ ...obj, }); @@ -4227,6 +4548,9 @@ export interface TagsType { } export namespace TagsType { + /** + * @internal + */ export const filterSensitiveLog = (obj: TagsType): any => ({ ...obj, }); @@ -4243,6 +4567,9 @@ export interface DescribeTerminationPolicyTypesAnswer { } export namespace DescribeTerminationPolicyTypesAnswer { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeTerminationPolicyTypesAnswer): any => ({ ...obj, }); @@ -4267,6 +4594,9 @@ export interface DescribeWarmPoolAnswer { } export namespace DescribeWarmPoolAnswer { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeWarmPoolAnswer): any => ({ ...obj, }); @@ -4292,6 +4622,9 @@ export interface DescribeWarmPoolType { } export namespace DescribeWarmPoolType { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeWarmPoolType): any => ({ ...obj, }); @@ -4305,6 +4638,9 @@ export interface DetachInstancesAnswer { } export namespace DetachInstancesAnswer { + /** + * @internal + */ export const filterSensitiveLog = (obj: DetachInstancesAnswer): any => ({ ...obj, }); @@ -4329,6 +4665,9 @@ export interface DetachInstancesQuery { } export namespace DetachInstancesQuery { + /** + * @internal + */ export const filterSensitiveLog = (obj: DetachInstancesQuery): any => ({ ...obj, }); @@ -4337,6 +4676,9 @@ export namespace DetachInstancesQuery { export interface DetachLoadBalancersResultType {} export namespace DetachLoadBalancersResultType { + /** + * @internal + */ export const filterSensitiveLog = (obj: DetachLoadBalancersResultType): any => ({ ...obj, }); @@ -4355,6 +4697,9 @@ export interface DetachLoadBalancersType { } export namespace DetachLoadBalancersType { + /** + * @internal + */ export const filterSensitiveLog = (obj: DetachLoadBalancersType): any => ({ ...obj, }); @@ -4363,6 +4708,9 @@ export namespace DetachLoadBalancersType { export interface DetachLoadBalancerTargetGroupsResultType {} export namespace DetachLoadBalancerTargetGroupsResultType { + /** + * @internal + */ export const filterSensitiveLog = (obj: DetachLoadBalancerTargetGroupsResultType): any => ({ ...obj, }); @@ -4382,6 +4730,9 @@ export interface DetachLoadBalancerTargetGroupsType { } export namespace DetachLoadBalancerTargetGroupsType { + /** + * @internal + */ export const filterSensitiveLog = (obj: DetachLoadBalancerTargetGroupsType): any => ({ ...obj, }); @@ -4503,6 +4854,9 @@ export interface DisableMetricsCollectionQuery { } export namespace DisableMetricsCollectionQuery { + /** + * @internal + */ export const filterSensitiveLog = (obj: DisableMetricsCollectionQuery): any => ({ ...obj, }); @@ -4637,6 +4991,9 @@ export interface EnableMetricsCollectionQuery { } export namespace EnableMetricsCollectionQuery { + /** + * @internal + */ export const filterSensitiveLog = (obj: EnableMetricsCollectionQuery): any => ({ ...obj, }); @@ -4650,6 +5007,9 @@ export interface EnterStandbyAnswer { } export namespace EnterStandbyAnswer { + /** + * @internal + */ export const filterSensitiveLog = (obj: EnterStandbyAnswer): any => ({ ...obj, }); @@ -4674,6 +5034,9 @@ export interface EnterStandbyQuery { } export namespace EnterStandbyQuery { + /** + * @internal + */ export const filterSensitiveLog = (obj: EnterStandbyQuery): any => ({ ...obj, }); @@ -4721,6 +5084,9 @@ export interface ExecutePolicyType { } export namespace ExecutePolicyType { + /** + * @internal + */ export const filterSensitiveLog = (obj: ExecutePolicyType): any => ({ ...obj, }); @@ -4734,6 +5100,9 @@ export interface ExitStandbyAnswer { } export namespace ExitStandbyAnswer { + /** + * @internal + */ export const filterSensitiveLog = (obj: ExitStandbyAnswer): any => ({ ...obj, }); @@ -4752,6 +5121,9 @@ export interface ExitStandbyQuery { } export namespace ExitStandbyQuery { + /** + * @internal + */ export const filterSensitiveLog = (obj: ExitStandbyQuery): any => ({ ...obj, }); @@ -4760,6 +5132,9 @@ export namespace ExitStandbyQuery { export interface PutLifecycleHookAnswer {} export namespace PutLifecycleHookAnswer { + /** + * @internal + */ export const filterSensitiveLog = (obj: PutLifecycleHookAnswer): any => ({ ...obj, }); @@ -4837,6 +5212,9 @@ export interface PutLifecycleHookType { } export namespace PutLifecycleHookType { + /** + * @internal + */ export const filterSensitiveLog = (obj: PutLifecycleHookType): any => ({ ...obj, }); @@ -4862,6 +5240,9 @@ export interface PutNotificationConfigurationType { } export namespace PutNotificationConfigurationType { + /** + * @internal + */ export const filterSensitiveLog = (obj: PutNotificationConfigurationType): any => ({ ...obj, }); @@ -4883,6 +5264,9 @@ export interface PolicyARNType { } export namespace PolicyARNType { + /** + * @internal + */ export const filterSensitiveLog = (obj: PolicyARNType): any => ({ ...obj, }); @@ -5045,6 +5429,9 @@ export interface PutScalingPolicyType { } export namespace PutScalingPolicyType { + /** + * @internal + */ export const filterSensitiveLog = (obj: PutScalingPolicyType): any => ({ ...obj, }); @@ -5122,6 +5509,9 @@ export interface PutScheduledUpdateGroupActionType { } export namespace PutScheduledUpdateGroupActionType { + /** + * @internal + */ export const filterSensitiveLog = (obj: PutScheduledUpdateGroupActionType): any => ({ ...obj, }); @@ -5130,6 +5520,9 @@ export namespace PutScheduledUpdateGroupActionType { export interface PutWarmPoolAnswer {} export namespace PutWarmPoolAnswer { + /** + * @internal + */ export const filterSensitiveLog = (obj: PutWarmPoolAnswer): any => ({ ...obj, }); @@ -5178,6 +5571,9 @@ export interface PutWarmPoolType { } export namespace PutWarmPoolType { + /** + * @internal + */ export const filterSensitiveLog = (obj: PutWarmPoolType): any => ({ ...obj, }); @@ -5186,6 +5582,9 @@ export namespace PutWarmPoolType { export interface RecordLifecycleActionHeartbeatAnswer {} export namespace RecordLifecycleActionHeartbeatAnswer { + /** + * @internal + */ export const filterSensitiveLog = (obj: RecordLifecycleActionHeartbeatAnswer): any => ({ ...obj, }); @@ -5216,6 +5615,9 @@ export interface RecordLifecycleActionHeartbeatType { } export namespace RecordLifecycleActionHeartbeatType { + /** + * @internal + */ export const filterSensitiveLog = (obj: RecordLifecycleActionHeartbeatType): any => ({ ...obj, }); @@ -5282,6 +5684,9 @@ export interface ScalingProcessQuery { } export namespace ScalingProcessQuery { + /** + * @internal + */ export const filterSensitiveLog = (obj: ScalingProcessQuery): any => ({ ...obj, }); @@ -5308,6 +5713,9 @@ export interface SetDesiredCapacityType { } export namespace SetDesiredCapacityType { + /** + * @internal + */ export const filterSensitiveLog = (obj: SetDesiredCapacityType): any => ({ ...obj, }); @@ -5340,6 +5748,9 @@ export interface SetInstanceHealthQuery { } export namespace SetInstanceHealthQuery { + /** + * @internal + */ export const filterSensitiveLog = (obj: SetInstanceHealthQuery): any => ({ ...obj, }); @@ -5348,6 +5759,9 @@ export namespace SetInstanceHealthQuery { export interface SetInstanceProtectionAnswer {} export namespace SetInstanceProtectionAnswer { + /** + * @internal + */ export const filterSensitiveLog = (obj: SetInstanceProtectionAnswer): any => ({ ...obj, }); @@ -5372,6 +5786,9 @@ export interface SetInstanceProtectionQuery { } export namespace SetInstanceProtectionQuery { + /** + * @internal + */ export const filterSensitiveLog = (obj: SetInstanceProtectionQuery): any => ({ ...obj, }); @@ -5388,6 +5805,9 @@ export interface InstanceRefreshInProgressFault extends __SmithyException, $Meta } export namespace InstanceRefreshInProgressFault { + /** + * @internal + */ export const filterSensitiveLog = (obj: InstanceRefreshInProgressFault): any => ({ ...obj, }); @@ -5401,6 +5821,9 @@ export interface StartInstanceRefreshAnswer { } export namespace StartInstanceRefreshAnswer { + /** + * @internal + */ export const filterSensitiveLog = (obj: StartInstanceRefreshAnswer): any => ({ ...obj, }); @@ -5450,6 +5873,9 @@ export interface RefreshPreferences { } export namespace RefreshPreferences { + /** + * @internal + */ export const filterSensitiveLog = (obj: RefreshPreferences): any => ({ ...obj, }); @@ -5488,6 +5914,9 @@ export interface StartInstanceRefreshType { } export namespace StartInstanceRefreshType { + /** + * @internal + */ export const filterSensitiveLog = (obj: StartInstanceRefreshType): any => ({ ...obj, }); @@ -5507,6 +5936,9 @@ export interface TerminateInstanceInAutoScalingGroupType { } export namespace TerminateInstanceInAutoScalingGroupType { + /** + * @internal + */ export const filterSensitiveLog = (obj: TerminateInstanceInAutoScalingGroupType): any => ({ ...obj, }); @@ -5653,6 +6085,9 @@ export interface UpdateAutoScalingGroupType { } export namespace UpdateAutoScalingGroupType { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateAutoScalingGroupType): any => ({ ...obj, }); diff --git a/clients/client-backup/commands/CreateBackupPlanCommand.ts b/clients/client-backup/commands/CreateBackupPlanCommand.ts index fc38dffee2fa..ca877d44fbb9 100644 --- a/clients/client-backup/commands/CreateBackupPlanCommand.ts +++ b/clients/client-backup/commands/CreateBackupPlanCommand.ts @@ -26,6 +26,20 @@ export interface CreateBackupPlanCommandOutput extends CreateBackupPlanOutput, _ * recovery points for resources.

*

If you call CreateBackupPlan with a plan that already exists, an * AlreadyExistsException is returned.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { BackupClient, CreateBackupPlanCommand } from "@aws-sdk/client-backup"; // ES Modules import + * // const { BackupClient, CreateBackupPlanCommand } = require("@aws-sdk/client-backup"); // CommonJS import + * const client = new BackupClient(config); + * const command = new CreateBackupPlanCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreateBackupPlanCommandInput} for command's `input` shape. + * @see {@link CreateBackupPlanCommandOutput} for command's `response` shape. + * @see {@link BackupClientResolvedConfig | config} for command's `input` shape. + * */ export class CreateBackupPlanCommand extends $Command< CreateBackupPlanCommandInput, diff --git a/clients/client-backup/commands/CreateBackupSelectionCommand.ts b/clients/client-backup/commands/CreateBackupSelectionCommand.ts index 21cadab2083b..94a6f6fc8ff7 100644 --- a/clients/client-backup/commands/CreateBackupSelectionCommand.ts +++ b/clients/client-backup/commands/CreateBackupSelectionCommand.ts @@ -61,6 +61,20 @@ export interface CreateBackupSelectionCommandOutput extends CreateBackupSelectio * selected. This shouldn't be confused with a logical AND, where all conditions must match. * The matching patterns are logically put together using the OR operator. * In other words, all patterns that match are selected for backup.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { BackupClient, CreateBackupSelectionCommand } from "@aws-sdk/client-backup"; // ES Modules import + * // const { BackupClient, CreateBackupSelectionCommand } = require("@aws-sdk/client-backup"); // CommonJS import + * const client = new BackupClient(config); + * const command = new CreateBackupSelectionCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreateBackupSelectionCommandInput} for command's `input` shape. + * @see {@link CreateBackupSelectionCommandOutput} for command's `response` shape. + * @see {@link BackupClientResolvedConfig | config} for command's `input` shape. + * */ export class CreateBackupSelectionCommand extends $Command< CreateBackupSelectionCommandInput, diff --git a/clients/client-backup/commands/CreateBackupVaultCommand.ts b/clients/client-backup/commands/CreateBackupVaultCommand.ts index a787cfe79fff..a91aee8ccbf7 100644 --- a/clients/client-backup/commands/CreateBackupVaultCommand.ts +++ b/clients/client-backup/commands/CreateBackupVaultCommand.ts @@ -28,6 +28,20 @@ export interface CreateBackupVaultCommandOutput extends CreateBackupVaultOutput, *

Sensitive data, such as passport numbers, should not be included the name of a backup * vault.

* + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { BackupClient, CreateBackupVaultCommand } from "@aws-sdk/client-backup"; // ES Modules import + * // const { BackupClient, CreateBackupVaultCommand } = require("@aws-sdk/client-backup"); // CommonJS import + * const client = new BackupClient(config); + * const command = new CreateBackupVaultCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreateBackupVaultCommandInput} for command's `input` shape. + * @see {@link CreateBackupVaultCommandOutput} for command's `response` shape. + * @see {@link BackupClientResolvedConfig | config} for command's `input` shape. + * */ export class CreateBackupVaultCommand extends $Command< CreateBackupVaultCommandInput, diff --git a/clients/client-backup/commands/DeleteBackupPlanCommand.ts b/clients/client-backup/commands/DeleteBackupPlanCommand.ts index 354d9e959850..6cbae0dfab5e 100644 --- a/clients/client-backup/commands/DeleteBackupPlanCommand.ts +++ b/clients/client-backup/commands/DeleteBackupPlanCommand.ts @@ -24,6 +24,20 @@ export interface DeleteBackupPlanCommandOutput extends DeleteBackupPlanOutput, _ *

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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { BackupClient, DeleteBackupPlanCommand } from "@aws-sdk/client-backup"; // ES Modules import + * // const { BackupClient, DeleteBackupPlanCommand } = require("@aws-sdk/client-backup"); // CommonJS import + * const client = new BackupClient(config); + * const command = new DeleteBackupPlanCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteBackupPlanCommandInput} for command's `input` shape. + * @see {@link DeleteBackupPlanCommandOutput} for command's `response` shape. + * @see {@link BackupClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteBackupPlanCommand extends $Command< DeleteBackupPlanCommandInput, diff --git a/clients/client-backup/commands/DeleteBackupSelectionCommand.ts b/clients/client-backup/commands/DeleteBackupSelectionCommand.ts index 51c0e3d00a03..c0486ef6770c 100644 --- a/clients/client-backup/commands/DeleteBackupSelectionCommand.ts +++ b/clients/client-backup/commands/DeleteBackupSelectionCommand.ts @@ -23,6 +23,20 @@ export interface DeleteBackupSelectionCommandOutput extends __MetadataBearer {} /** *

Deletes the resource selection associated with a backup plan that is specified by the * SelectionId.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { BackupClient, DeleteBackupSelectionCommand } from "@aws-sdk/client-backup"; // ES Modules import + * // const { BackupClient, DeleteBackupSelectionCommand } = require("@aws-sdk/client-backup"); // CommonJS import + * const client = new BackupClient(config); + * const command = new DeleteBackupSelectionCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteBackupSelectionCommandInput} for command's `input` shape. + * @see {@link DeleteBackupSelectionCommandOutput} for command's `response` shape. + * @see {@link BackupClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteBackupSelectionCommand extends $Command< DeleteBackupSelectionCommandInput, diff --git a/clients/client-backup/commands/DeleteBackupVaultAccessPolicyCommand.ts b/clients/client-backup/commands/DeleteBackupVaultAccessPolicyCommand.ts index 196e67e5292b..6bcf6b26b2d6 100644 --- a/clients/client-backup/commands/DeleteBackupVaultAccessPolicyCommand.ts +++ b/clients/client-backup/commands/DeleteBackupVaultAccessPolicyCommand.ts @@ -22,6 +22,20 @@ export interface DeleteBackupVaultAccessPolicyCommandOutput extends __MetadataBe /** *

Deletes the policy document that manages permissions on a backup vault.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { BackupClient, DeleteBackupVaultAccessPolicyCommand } from "@aws-sdk/client-backup"; // ES Modules import + * // const { BackupClient, DeleteBackupVaultAccessPolicyCommand } = require("@aws-sdk/client-backup"); // CommonJS import + * const client = new BackupClient(config); + * const command = new DeleteBackupVaultAccessPolicyCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteBackupVaultAccessPolicyCommandInput} for command's `input` shape. + * @see {@link DeleteBackupVaultAccessPolicyCommandOutput} for command's `response` shape. + * @see {@link BackupClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteBackupVaultAccessPolicyCommand extends $Command< DeleteBackupVaultAccessPolicyCommandInput, diff --git a/clients/client-backup/commands/DeleteBackupVaultCommand.ts b/clients/client-backup/commands/DeleteBackupVaultCommand.ts index 2c000d1826a0..d3b2600ecb59 100644 --- a/clients/client-backup/commands/DeleteBackupVaultCommand.ts +++ b/clients/client-backup/commands/DeleteBackupVaultCommand.ts @@ -23,6 +23,20 @@ export interface DeleteBackupVaultCommandOutput extends __MetadataBearer {} /** *

Deletes the backup vault identified by its name. A vault can be deleted only if it is * empty.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { BackupClient, DeleteBackupVaultCommand } from "@aws-sdk/client-backup"; // ES Modules import + * // const { BackupClient, DeleteBackupVaultCommand } = require("@aws-sdk/client-backup"); // CommonJS import + * const client = new BackupClient(config); + * const command = new DeleteBackupVaultCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteBackupVaultCommandInput} for command's `input` shape. + * @see {@link DeleteBackupVaultCommandOutput} for command's `response` shape. + * @see {@link BackupClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteBackupVaultCommand extends $Command< DeleteBackupVaultCommandInput, diff --git a/clients/client-backup/commands/DeleteBackupVaultNotificationsCommand.ts b/clients/client-backup/commands/DeleteBackupVaultNotificationsCommand.ts index 0cad976e12d3..e56f67318d83 100644 --- a/clients/client-backup/commands/DeleteBackupVaultNotificationsCommand.ts +++ b/clients/client-backup/commands/DeleteBackupVaultNotificationsCommand.ts @@ -22,6 +22,20 @@ export interface DeleteBackupVaultNotificationsCommandOutput extends __MetadataB /** *

Deletes event notifications for the specified backup vault.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { BackupClient, DeleteBackupVaultNotificationsCommand } from "@aws-sdk/client-backup"; // ES Modules import + * // const { BackupClient, DeleteBackupVaultNotificationsCommand } = require("@aws-sdk/client-backup"); // CommonJS import + * const client = new BackupClient(config); + * const command = new DeleteBackupVaultNotificationsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteBackupVaultNotificationsCommandInput} for command's `input` shape. + * @see {@link DeleteBackupVaultNotificationsCommandOutput} for command's `response` shape. + * @see {@link BackupClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteBackupVaultNotificationsCommand extends $Command< DeleteBackupVaultNotificationsCommandInput, diff --git a/clients/client-backup/commands/DeleteRecoveryPointCommand.ts b/clients/client-backup/commands/DeleteRecoveryPointCommand.ts index 75fdf175221d..986bd323721d 100644 --- a/clients/client-backup/commands/DeleteRecoveryPointCommand.ts +++ b/clients/client-backup/commands/DeleteRecoveryPointCommand.ts @@ -24,6 +24,20 @@ export interface DeleteRecoveryPointCommandOutput extends __MetadataBearer {} *

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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { BackupClient, DeleteRecoveryPointCommand } from "@aws-sdk/client-backup"; // ES Modules import + * // const { BackupClient, DeleteRecoveryPointCommand } = require("@aws-sdk/client-backup"); // CommonJS import + * const client = new BackupClient(config); + * const command = new DeleteRecoveryPointCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteRecoveryPointCommandInput} for command's `input` shape. + * @see {@link DeleteRecoveryPointCommandOutput} for command's `response` shape. + * @see {@link BackupClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteRecoveryPointCommand extends $Command< DeleteRecoveryPointCommandInput, diff --git a/clients/client-backup/commands/DescribeBackupJobCommand.ts b/clients/client-backup/commands/DescribeBackupJobCommand.ts index 97c26a22e623..a2e14f66db2b 100644 --- a/clients/client-backup/commands/DescribeBackupJobCommand.ts +++ b/clients/client-backup/commands/DescribeBackupJobCommand.ts @@ -22,6 +22,20 @@ export interface DescribeBackupJobCommandOutput extends DescribeBackupJobOutput, /** *

Returns backup job details for the specified BackupJobId.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { BackupClient, DescribeBackupJobCommand } from "@aws-sdk/client-backup"; // ES Modules import + * // const { BackupClient, DescribeBackupJobCommand } = require("@aws-sdk/client-backup"); // CommonJS import + * const client = new BackupClient(config); + * const command = new DescribeBackupJobCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeBackupJobCommandInput} for command's `input` shape. + * @see {@link DescribeBackupJobCommandOutput} for command's `response` shape. + * @see {@link BackupClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeBackupJobCommand extends $Command< DescribeBackupJobCommandInput, diff --git a/clients/client-backup/commands/DescribeBackupVaultCommand.ts b/clients/client-backup/commands/DescribeBackupVaultCommand.ts index ebf52889fe68..7c43a2258780 100644 --- a/clients/client-backup/commands/DescribeBackupVaultCommand.ts +++ b/clients/client-backup/commands/DescribeBackupVaultCommand.ts @@ -22,6 +22,20 @@ export interface DescribeBackupVaultCommandOutput extends DescribeBackupVaultOut /** *

Returns metadata about a backup vault specified by its name.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { BackupClient, DescribeBackupVaultCommand } from "@aws-sdk/client-backup"; // ES Modules import + * // const { BackupClient, DescribeBackupVaultCommand } = require("@aws-sdk/client-backup"); // CommonJS import + * const client = new BackupClient(config); + * const command = new DescribeBackupVaultCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeBackupVaultCommandInput} for command's `input` shape. + * @see {@link DescribeBackupVaultCommandOutput} for command's `response` shape. + * @see {@link BackupClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeBackupVaultCommand extends $Command< DescribeBackupVaultCommandInput, diff --git a/clients/client-backup/commands/DescribeCopyJobCommand.ts b/clients/client-backup/commands/DescribeCopyJobCommand.ts index ec1ab207d0e9..aab4a17e9544 100644 --- a/clients/client-backup/commands/DescribeCopyJobCommand.ts +++ b/clients/client-backup/commands/DescribeCopyJobCommand.ts @@ -22,6 +22,20 @@ export interface DescribeCopyJobCommandOutput extends DescribeCopyJobOutput, __M /** *

Returns metadata associated with creating a copy of a resource.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { BackupClient, DescribeCopyJobCommand } from "@aws-sdk/client-backup"; // ES Modules import + * // const { BackupClient, DescribeCopyJobCommand } = require("@aws-sdk/client-backup"); // CommonJS import + * const client = new BackupClient(config); + * const command = new DescribeCopyJobCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeCopyJobCommandInput} for command's `input` shape. + * @see {@link DescribeCopyJobCommandOutput} for command's `response` shape. + * @see {@link BackupClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeCopyJobCommand extends $Command< DescribeCopyJobCommandInput, diff --git a/clients/client-backup/commands/DescribeGlobalSettingsCommand.ts b/clients/client-backup/commands/DescribeGlobalSettingsCommand.ts index b76883fd0c82..9a1de1f6c512 100644 --- a/clients/client-backup/commands/DescribeGlobalSettingsCommand.ts +++ b/clients/client-backup/commands/DescribeGlobalSettingsCommand.ts @@ -23,6 +23,20 @@ export interface DescribeGlobalSettingsCommandOutput extends DescribeGlobalSetti /** *

Describes the global settings of the AWS account, including whether it is opted in to * cross-account backup.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { BackupClient, DescribeGlobalSettingsCommand } from "@aws-sdk/client-backup"; // ES Modules import + * // const { BackupClient, DescribeGlobalSettingsCommand } = require("@aws-sdk/client-backup"); // CommonJS import + * const client = new BackupClient(config); + * const command = new DescribeGlobalSettingsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeGlobalSettingsCommandInput} for command's `input` shape. + * @see {@link DescribeGlobalSettingsCommandOutput} for command's `response` shape. + * @see {@link BackupClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeGlobalSettingsCommand extends $Command< DescribeGlobalSettingsCommandInput, diff --git a/clients/client-backup/commands/DescribeProtectedResourceCommand.ts b/clients/client-backup/commands/DescribeProtectedResourceCommand.ts index 4f29e1f83894..7a6285e0a906 100644 --- a/clients/client-backup/commands/DescribeProtectedResourceCommand.ts +++ b/clients/client-backup/commands/DescribeProtectedResourceCommand.ts @@ -23,6 +23,20 @@ export interface DescribeProtectedResourceCommandOutput extends DescribeProtecte /** *

Returns information about a saved resource, including the last time it was backed up, * its Amazon Resource Name (ARN), and the AWS service type of the saved resource.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { BackupClient, DescribeProtectedResourceCommand } from "@aws-sdk/client-backup"; // ES Modules import + * // const { BackupClient, DescribeProtectedResourceCommand } = require("@aws-sdk/client-backup"); // CommonJS import + * const client = new BackupClient(config); + * const command = new DescribeProtectedResourceCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeProtectedResourceCommandInput} for command's `input` shape. + * @see {@link DescribeProtectedResourceCommandOutput} for command's `response` shape. + * @see {@link BackupClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeProtectedResourceCommand extends $Command< DescribeProtectedResourceCommandInput, diff --git a/clients/client-backup/commands/DescribeRecoveryPointCommand.ts b/clients/client-backup/commands/DescribeRecoveryPointCommand.ts index 32ff9e3aef67..2ad6529b04db 100644 --- a/clients/client-backup/commands/DescribeRecoveryPointCommand.ts +++ b/clients/client-backup/commands/DescribeRecoveryPointCommand.ts @@ -23,6 +23,20 @@ export interface DescribeRecoveryPointCommandOutput extends DescribeRecoveryPoin /** *

Returns metadata associated with a recovery point, including ID, status, encryption, and * lifecycle.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { BackupClient, DescribeRecoveryPointCommand } from "@aws-sdk/client-backup"; // ES Modules import + * // const { BackupClient, DescribeRecoveryPointCommand } = require("@aws-sdk/client-backup"); // CommonJS import + * const client = new BackupClient(config); + * const command = new DescribeRecoveryPointCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeRecoveryPointCommandInput} for command's `input` shape. + * @see {@link DescribeRecoveryPointCommandOutput} for command's `response` shape. + * @see {@link BackupClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeRecoveryPointCommand extends $Command< DescribeRecoveryPointCommandInput, diff --git a/clients/client-backup/commands/DescribeRegionSettingsCommand.ts b/clients/client-backup/commands/DescribeRegionSettingsCommand.ts index ad53179c7ef4..8821832d7b3c 100644 --- a/clients/client-backup/commands/DescribeRegionSettingsCommand.ts +++ b/clients/client-backup/commands/DescribeRegionSettingsCommand.ts @@ -26,6 +26,20 @@ export interface DescribeRegionSettingsCommandOutput extends DescribeRegionSetti * the resource is included in an on-demand backup or scheduled backup plan. Otherwise, AWS * Backup does not try to protect that service's resources in this Region, AWS Backup does not * try to protect that service's resources in this Region.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { BackupClient, DescribeRegionSettingsCommand } from "@aws-sdk/client-backup"; // ES Modules import + * // const { BackupClient, DescribeRegionSettingsCommand } = require("@aws-sdk/client-backup"); // CommonJS import + * const client = new BackupClient(config); + * const command = new DescribeRegionSettingsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeRegionSettingsCommandInput} for command's `input` shape. + * @see {@link DescribeRegionSettingsCommandOutput} for command's `response` shape. + * @see {@link BackupClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeRegionSettingsCommand extends $Command< DescribeRegionSettingsCommandInput, diff --git a/clients/client-backup/commands/DescribeRestoreJobCommand.ts b/clients/client-backup/commands/DescribeRestoreJobCommand.ts index c9aa841dd194..3418ebaba9dd 100644 --- a/clients/client-backup/commands/DescribeRestoreJobCommand.ts +++ b/clients/client-backup/commands/DescribeRestoreJobCommand.ts @@ -22,6 +22,20 @@ export interface DescribeRestoreJobCommandOutput extends DescribeRestoreJobOutpu /** *

Returns metadata associated with a restore job that is specified by a job ID.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { BackupClient, DescribeRestoreJobCommand } from "@aws-sdk/client-backup"; // ES Modules import + * // const { BackupClient, DescribeRestoreJobCommand } = require("@aws-sdk/client-backup"); // CommonJS import + * const client = new BackupClient(config); + * const command = new DescribeRestoreJobCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeRestoreJobCommandInput} for command's `input` shape. + * @see {@link DescribeRestoreJobCommandOutput} for command's `response` shape. + * @see {@link BackupClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeRestoreJobCommand extends $Command< DescribeRestoreJobCommandInput, diff --git a/clients/client-backup/commands/DisassociateRecoveryPointCommand.ts b/clients/client-backup/commands/DisassociateRecoveryPointCommand.ts index 0261e0a91266..5cc7055a2c03 100644 --- a/clients/client-backup/commands/DisassociateRecoveryPointCommand.ts +++ b/clients/client-backup/commands/DisassociateRecoveryPointCommand.ts @@ -26,6 +26,20 @@ export interface DisassociateRecoveryPointCommandOutput extends __MetadataBearer * 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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { BackupClient, DisassociateRecoveryPointCommand } from "@aws-sdk/client-backup"; // ES Modules import + * // const { BackupClient, DisassociateRecoveryPointCommand } = require("@aws-sdk/client-backup"); // CommonJS import + * const client = new BackupClient(config); + * const command = new DisassociateRecoveryPointCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DisassociateRecoveryPointCommandInput} for command's `input` shape. + * @see {@link DisassociateRecoveryPointCommandOutput} for command's `response` shape. + * @see {@link BackupClientResolvedConfig | config} for command's `input` shape. + * */ export class DisassociateRecoveryPointCommand extends $Command< DisassociateRecoveryPointCommandInput, diff --git a/clients/client-backup/commands/ExportBackupPlanTemplateCommand.ts b/clients/client-backup/commands/ExportBackupPlanTemplateCommand.ts index b44f146da282..35efe95757ad 100644 --- a/clients/client-backup/commands/ExportBackupPlanTemplateCommand.ts +++ b/clients/client-backup/commands/ExportBackupPlanTemplateCommand.ts @@ -22,6 +22,20 @@ export interface ExportBackupPlanTemplateCommandOutput extends ExportBackupPlanT /** *

Returns the backup plan that is specified by the plan ID as a backup template.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { BackupClient, ExportBackupPlanTemplateCommand } from "@aws-sdk/client-backup"; // ES Modules import + * // const { BackupClient, ExportBackupPlanTemplateCommand } = require("@aws-sdk/client-backup"); // CommonJS import + * const client = new BackupClient(config); + * const command = new ExportBackupPlanTemplateCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ExportBackupPlanTemplateCommandInput} for command's `input` shape. + * @see {@link ExportBackupPlanTemplateCommandOutput} for command's `response` shape. + * @see {@link BackupClientResolvedConfig | config} for command's `input` shape. + * */ export class ExportBackupPlanTemplateCommand extends $Command< ExportBackupPlanTemplateCommandInput, diff --git a/clients/client-backup/commands/GetBackupPlanCommand.ts b/clients/client-backup/commands/GetBackupPlanCommand.ts index 7f10faa2c7a8..889ed9c59448 100644 --- a/clients/client-backup/commands/GetBackupPlanCommand.ts +++ b/clients/client-backup/commands/GetBackupPlanCommand.ts @@ -23,6 +23,20 @@ export interface GetBackupPlanCommandOutput extends GetBackupPlanOutput, __Metad /** *

Returns BackupPlan details for the specified BackupPlanId. The * details are the body of a backup plan in JSON format, in addition to plan metadata.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { BackupClient, GetBackupPlanCommand } from "@aws-sdk/client-backup"; // ES Modules import + * // const { BackupClient, GetBackupPlanCommand } = require("@aws-sdk/client-backup"); // CommonJS import + * const client = new BackupClient(config); + * const command = new GetBackupPlanCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetBackupPlanCommandInput} for command's `input` shape. + * @see {@link GetBackupPlanCommandOutput} for command's `response` shape. + * @see {@link BackupClientResolvedConfig | config} for command's `input` shape. + * */ export class GetBackupPlanCommand extends $Command< GetBackupPlanCommandInput, diff --git a/clients/client-backup/commands/GetBackupPlanFromJSONCommand.ts b/clients/client-backup/commands/GetBackupPlanFromJSONCommand.ts index b65a358d2fbd..03b0f22f91fb 100644 --- a/clients/client-backup/commands/GetBackupPlanFromJSONCommand.ts +++ b/clients/client-backup/commands/GetBackupPlanFromJSONCommand.ts @@ -22,6 +22,20 @@ export interface GetBackupPlanFromJSONCommandOutput extends GetBackupPlanFromJSO /** *

Returns a valid JSON document specifying a backup plan or an error.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { BackupClient, GetBackupPlanFromJSONCommand } from "@aws-sdk/client-backup"; // ES Modules import + * // const { BackupClient, GetBackupPlanFromJSONCommand } = require("@aws-sdk/client-backup"); // CommonJS import + * const client = new BackupClient(config); + * const command = new GetBackupPlanFromJSONCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetBackupPlanFromJSONCommandInput} for command's `input` shape. + * @see {@link GetBackupPlanFromJSONCommandOutput} for command's `response` shape. + * @see {@link BackupClientResolvedConfig | config} for command's `input` shape. + * */ export class GetBackupPlanFromJSONCommand extends $Command< GetBackupPlanFromJSONCommandInput, diff --git a/clients/client-backup/commands/GetBackupPlanFromTemplateCommand.ts b/clients/client-backup/commands/GetBackupPlanFromTemplateCommand.ts index a12976d6beed..a2085f9cb150 100644 --- a/clients/client-backup/commands/GetBackupPlanFromTemplateCommand.ts +++ b/clients/client-backup/commands/GetBackupPlanFromTemplateCommand.ts @@ -22,6 +22,20 @@ export interface GetBackupPlanFromTemplateCommandOutput extends GetBackupPlanFro /** *

Returns the template specified by its templateId as a backup plan.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { BackupClient, GetBackupPlanFromTemplateCommand } from "@aws-sdk/client-backup"; // ES Modules import + * // const { BackupClient, GetBackupPlanFromTemplateCommand } = require("@aws-sdk/client-backup"); // CommonJS import + * const client = new BackupClient(config); + * const command = new GetBackupPlanFromTemplateCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetBackupPlanFromTemplateCommandInput} for command's `input` shape. + * @see {@link GetBackupPlanFromTemplateCommandOutput} for command's `response` shape. + * @see {@link BackupClientResolvedConfig | config} for command's `input` shape. + * */ export class GetBackupPlanFromTemplateCommand extends $Command< GetBackupPlanFromTemplateCommandInput, diff --git a/clients/client-backup/commands/GetBackupSelectionCommand.ts b/clients/client-backup/commands/GetBackupSelectionCommand.ts index 44a6ccdad8b2..6f890131f0ea 100644 --- a/clients/client-backup/commands/GetBackupSelectionCommand.ts +++ b/clients/client-backup/commands/GetBackupSelectionCommand.ts @@ -23,6 +23,20 @@ export interface GetBackupSelectionCommandOutput extends GetBackupSelectionOutpu /** *

Returns selection metadata and a document in JSON format that specifies a list of * resources that are associated with a backup plan.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { BackupClient, GetBackupSelectionCommand } from "@aws-sdk/client-backup"; // ES Modules import + * // const { BackupClient, GetBackupSelectionCommand } = require("@aws-sdk/client-backup"); // CommonJS import + * const client = new BackupClient(config); + * const command = new GetBackupSelectionCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetBackupSelectionCommandInput} for command's `input` shape. + * @see {@link GetBackupSelectionCommandOutput} for command's `response` shape. + * @see {@link BackupClientResolvedConfig | config} for command's `input` shape. + * */ export class GetBackupSelectionCommand extends $Command< GetBackupSelectionCommandInput, diff --git a/clients/client-backup/commands/GetBackupVaultAccessPolicyCommand.ts b/clients/client-backup/commands/GetBackupVaultAccessPolicyCommand.ts index 28828f141646..723bd5805aa7 100644 --- a/clients/client-backup/commands/GetBackupVaultAccessPolicyCommand.ts +++ b/clients/client-backup/commands/GetBackupVaultAccessPolicyCommand.ts @@ -23,6 +23,20 @@ export interface GetBackupVaultAccessPolicyCommandOutput extends GetBackupVaultA /** *

Returns the access policy document that is associated with the named backup * vault.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { BackupClient, GetBackupVaultAccessPolicyCommand } from "@aws-sdk/client-backup"; // ES Modules import + * // const { BackupClient, GetBackupVaultAccessPolicyCommand } = require("@aws-sdk/client-backup"); // CommonJS import + * const client = new BackupClient(config); + * const command = new GetBackupVaultAccessPolicyCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetBackupVaultAccessPolicyCommandInput} for command's `input` shape. + * @see {@link GetBackupVaultAccessPolicyCommandOutput} for command's `response` shape. + * @see {@link BackupClientResolvedConfig | config} for command's `input` shape. + * */ export class GetBackupVaultAccessPolicyCommand extends $Command< GetBackupVaultAccessPolicyCommandInput, diff --git a/clients/client-backup/commands/GetBackupVaultNotificationsCommand.ts b/clients/client-backup/commands/GetBackupVaultNotificationsCommand.ts index 0dd1e6bb7b23..eebc3c2a25b1 100644 --- a/clients/client-backup/commands/GetBackupVaultNotificationsCommand.ts +++ b/clients/client-backup/commands/GetBackupVaultNotificationsCommand.ts @@ -22,6 +22,20 @@ export interface GetBackupVaultNotificationsCommandOutput extends GetBackupVault /** *

Returns event notifications for the specified backup vault.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { BackupClient, GetBackupVaultNotificationsCommand } from "@aws-sdk/client-backup"; // ES Modules import + * // const { BackupClient, GetBackupVaultNotificationsCommand } = require("@aws-sdk/client-backup"); // CommonJS import + * const client = new BackupClient(config); + * const command = new GetBackupVaultNotificationsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetBackupVaultNotificationsCommandInput} for command's `input` shape. + * @see {@link GetBackupVaultNotificationsCommandOutput} for command's `response` shape. + * @see {@link BackupClientResolvedConfig | config} for command's `input` shape. + * */ export class GetBackupVaultNotificationsCommand extends $Command< GetBackupVaultNotificationsCommandInput, diff --git a/clients/client-backup/commands/GetRecoveryPointRestoreMetadataCommand.ts b/clients/client-backup/commands/GetRecoveryPointRestoreMetadataCommand.ts index 0586b880e05d..91cff770b9d5 100644 --- a/clients/client-backup/commands/GetRecoveryPointRestoreMetadataCommand.ts +++ b/clients/client-backup/commands/GetRecoveryPointRestoreMetadataCommand.ts @@ -24,6 +24,20 @@ export interface GetRecoveryPointRestoreMetadataCommandOutput /** *

Returns a set of metadata key-value pairs that were used to create the backup.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { BackupClient, GetRecoveryPointRestoreMetadataCommand } from "@aws-sdk/client-backup"; // ES Modules import + * // const { BackupClient, GetRecoveryPointRestoreMetadataCommand } = require("@aws-sdk/client-backup"); // CommonJS import + * const client = new BackupClient(config); + * const command = new GetRecoveryPointRestoreMetadataCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetRecoveryPointRestoreMetadataCommandInput} for command's `input` shape. + * @see {@link GetRecoveryPointRestoreMetadataCommandOutput} for command's `response` shape. + * @see {@link BackupClientResolvedConfig | config} for command's `input` shape. + * */ export class GetRecoveryPointRestoreMetadataCommand extends $Command< GetRecoveryPointRestoreMetadataCommandInput, diff --git a/clients/client-backup/commands/GetSupportedResourceTypesCommand.ts b/clients/client-backup/commands/GetSupportedResourceTypesCommand.ts index c861701dc64d..8bfec9fbdda9 100644 --- a/clients/client-backup/commands/GetSupportedResourceTypesCommand.ts +++ b/clients/client-backup/commands/GetSupportedResourceTypesCommand.ts @@ -22,6 +22,20 @@ export interface GetSupportedResourceTypesCommandOutput extends GetSupportedReso /** *

Returns the AWS resource types supported by AWS Backup.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { BackupClient, GetSupportedResourceTypesCommand } from "@aws-sdk/client-backup"; // ES Modules import + * // const { BackupClient, GetSupportedResourceTypesCommand } = require("@aws-sdk/client-backup"); // CommonJS import + * const client = new BackupClient(config); + * const command = new GetSupportedResourceTypesCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetSupportedResourceTypesCommandInput} for command's `input` shape. + * @see {@link GetSupportedResourceTypesCommandOutput} for command's `response` shape. + * @see {@link BackupClientResolvedConfig | config} for command's `input` shape. + * */ export class GetSupportedResourceTypesCommand extends $Command< GetSupportedResourceTypesCommandInput, diff --git a/clients/client-backup/commands/ListBackupJobsCommand.ts b/clients/client-backup/commands/ListBackupJobsCommand.ts index bde830ab5166..8093ab985808 100644 --- a/clients/client-backup/commands/ListBackupJobsCommand.ts +++ b/clients/client-backup/commands/ListBackupJobsCommand.ts @@ -23,6 +23,20 @@ export interface ListBackupJobsCommandOutput extends ListBackupJobsOutput, __Met /** *

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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { BackupClient, ListBackupJobsCommand } from "@aws-sdk/client-backup"; // ES Modules import + * // const { BackupClient, ListBackupJobsCommand } = require("@aws-sdk/client-backup"); // CommonJS import + * const client = new BackupClient(config); + * const command = new ListBackupJobsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListBackupJobsCommandInput} for command's `input` shape. + * @see {@link ListBackupJobsCommandOutput} for command's `response` shape. + * @see {@link BackupClientResolvedConfig | config} for command's `input` shape. + * */ export class ListBackupJobsCommand extends $Command< ListBackupJobsCommandInput, diff --git a/clients/client-backup/commands/ListBackupPlanTemplatesCommand.ts b/clients/client-backup/commands/ListBackupPlanTemplatesCommand.ts index 784b0e81e878..132027b2adce 100644 --- a/clients/client-backup/commands/ListBackupPlanTemplatesCommand.ts +++ b/clients/client-backup/commands/ListBackupPlanTemplatesCommand.ts @@ -23,6 +23,20 @@ export interface ListBackupPlanTemplatesCommandOutput extends ListBackupPlanTemp /** *

Returns metadata of your saved backup plan templates, including the template ID, name, * and the creation and deletion dates.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { BackupClient, ListBackupPlanTemplatesCommand } from "@aws-sdk/client-backup"; // ES Modules import + * // const { BackupClient, ListBackupPlanTemplatesCommand } = require("@aws-sdk/client-backup"); // CommonJS import + * const client = new BackupClient(config); + * const command = new ListBackupPlanTemplatesCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListBackupPlanTemplatesCommandInput} for command's `input` shape. + * @see {@link ListBackupPlanTemplatesCommandOutput} for command's `response` shape. + * @see {@link BackupClientResolvedConfig | config} for command's `input` shape. + * */ export class ListBackupPlanTemplatesCommand extends $Command< ListBackupPlanTemplatesCommandInput, diff --git a/clients/client-backup/commands/ListBackupPlanVersionsCommand.ts b/clients/client-backup/commands/ListBackupPlanVersionsCommand.ts index e9ff0584e82d..75f753fbb6a8 100644 --- a/clients/client-backup/commands/ListBackupPlanVersionsCommand.ts +++ b/clients/client-backup/commands/ListBackupPlanVersionsCommand.ts @@ -23,6 +23,20 @@ export interface ListBackupPlanVersionsCommandOutput extends ListBackupPlanVersi /** *

Returns version metadata of your backup plans, including Amazon Resource Names (ARNs), * backup plan IDs, creation and deletion dates, plan names, and version IDs.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { BackupClient, ListBackupPlanVersionsCommand } from "@aws-sdk/client-backup"; // ES Modules import + * // const { BackupClient, ListBackupPlanVersionsCommand } = require("@aws-sdk/client-backup"); // CommonJS import + * const client = new BackupClient(config); + * const command = new ListBackupPlanVersionsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListBackupPlanVersionsCommandInput} for command's `input` shape. + * @see {@link ListBackupPlanVersionsCommandOutput} for command's `response` shape. + * @see {@link BackupClientResolvedConfig | config} for command's `input` shape. + * */ export class ListBackupPlanVersionsCommand extends $Command< ListBackupPlanVersionsCommandInput, diff --git a/clients/client-backup/commands/ListBackupPlansCommand.ts b/clients/client-backup/commands/ListBackupPlansCommand.ts index 1e4a265640e8..de794e674b5c 100644 --- a/clients/client-backup/commands/ListBackupPlansCommand.ts +++ b/clients/client-backup/commands/ListBackupPlansCommand.ts @@ -25,6 +25,20 @@ export interface ListBackupPlansCommandOutput extends ListBackupPlansOutput, __M * populated only if the advanced option is set for the backup plan. The list contains * information such as Amazon Resource Names (ARNs), plan IDs, creation and deletion dates, * version IDs, plan names, and creator request IDs.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { BackupClient, ListBackupPlansCommand } from "@aws-sdk/client-backup"; // ES Modules import + * // const { BackupClient, ListBackupPlansCommand } = require("@aws-sdk/client-backup"); // CommonJS import + * const client = new BackupClient(config); + * const command = new ListBackupPlansCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListBackupPlansCommandInput} for command's `input` shape. + * @see {@link ListBackupPlansCommandOutput} for command's `response` shape. + * @see {@link BackupClientResolvedConfig | config} for command's `input` shape. + * */ export class ListBackupPlansCommand extends $Command< ListBackupPlansCommandInput, diff --git a/clients/client-backup/commands/ListBackupSelectionsCommand.ts b/clients/client-backup/commands/ListBackupSelectionsCommand.ts index 34a9144ab7b2..94266c627c44 100644 --- a/clients/client-backup/commands/ListBackupSelectionsCommand.ts +++ b/clients/client-backup/commands/ListBackupSelectionsCommand.ts @@ -23,6 +23,20 @@ export interface ListBackupSelectionsCommandOutput extends ListBackupSelectionsO /** *

Returns an array containing metadata of the resources associated with the target backup * plan.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { BackupClient, ListBackupSelectionsCommand } from "@aws-sdk/client-backup"; // ES Modules import + * // const { BackupClient, ListBackupSelectionsCommand } = require("@aws-sdk/client-backup"); // CommonJS import + * const client = new BackupClient(config); + * const command = new ListBackupSelectionsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListBackupSelectionsCommandInput} for command's `input` shape. + * @see {@link ListBackupSelectionsCommandOutput} for command's `response` shape. + * @see {@link BackupClientResolvedConfig | config} for command's `input` shape. + * */ export class ListBackupSelectionsCommand extends $Command< ListBackupSelectionsCommandInput, diff --git a/clients/client-backup/commands/ListBackupVaultsCommand.ts b/clients/client-backup/commands/ListBackupVaultsCommand.ts index 72e749b85b0f..bd403bffcccf 100644 --- a/clients/client-backup/commands/ListBackupVaultsCommand.ts +++ b/clients/client-backup/commands/ListBackupVaultsCommand.ts @@ -23,6 +23,20 @@ export interface ListBackupVaultsCommandOutput extends ListBackupVaultsOutput, _ /** *

Returns a list of recovery point storage containers along with information about * them.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { BackupClient, ListBackupVaultsCommand } from "@aws-sdk/client-backup"; // ES Modules import + * // const { BackupClient, ListBackupVaultsCommand } = require("@aws-sdk/client-backup"); // CommonJS import + * const client = new BackupClient(config); + * const command = new ListBackupVaultsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListBackupVaultsCommandInput} for command's `input` shape. + * @see {@link ListBackupVaultsCommandOutput} for command's `response` shape. + * @see {@link BackupClientResolvedConfig | config} for command's `input` shape. + * */ export class ListBackupVaultsCommand extends $Command< ListBackupVaultsCommandInput, diff --git a/clients/client-backup/commands/ListCopyJobsCommand.ts b/clients/client-backup/commands/ListCopyJobsCommand.ts index 62da27917135..55d5d66a04ea 100644 --- a/clients/client-backup/commands/ListCopyJobsCommand.ts +++ b/clients/client-backup/commands/ListCopyJobsCommand.ts @@ -22,6 +22,20 @@ export interface ListCopyJobsCommandOutput extends ListCopyJobsOutput, __Metadat /** *

Returns metadata about your copy jobs.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { BackupClient, ListCopyJobsCommand } from "@aws-sdk/client-backup"; // ES Modules import + * // const { BackupClient, ListCopyJobsCommand } = require("@aws-sdk/client-backup"); // CommonJS import + * const client = new BackupClient(config); + * const command = new ListCopyJobsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListCopyJobsCommandInput} for command's `input` shape. + * @see {@link ListCopyJobsCommandOutput} for command's `response` shape. + * @see {@link BackupClientResolvedConfig | config} for command's `input` shape. + * */ export class ListCopyJobsCommand extends $Command< ListCopyJobsCommandInput, diff --git a/clients/client-backup/commands/ListProtectedResourcesCommand.ts b/clients/client-backup/commands/ListProtectedResourcesCommand.ts index 1376449a6a14..ec40cd25c8de 100644 --- a/clients/client-backup/commands/ListProtectedResourcesCommand.ts +++ b/clients/client-backup/commands/ListProtectedResourcesCommand.ts @@ -24,6 +24,20 @@ export interface ListProtectedResourcesCommandOutput extends ListProtectedResour *

Returns an array of resources successfully backed up by AWS Backup, including the time * the resource was saved, an Amazon Resource Name (ARN) of the resource, and a resource * type.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { BackupClient, ListProtectedResourcesCommand } from "@aws-sdk/client-backup"; // ES Modules import + * // const { BackupClient, ListProtectedResourcesCommand } = require("@aws-sdk/client-backup"); // CommonJS import + * const client = new BackupClient(config); + * const command = new ListProtectedResourcesCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListProtectedResourcesCommandInput} for command's `input` shape. + * @see {@link ListProtectedResourcesCommandOutput} for command's `response` shape. + * @see {@link BackupClientResolvedConfig | config} for command's `input` shape. + * */ export class ListProtectedResourcesCommand extends $Command< ListProtectedResourcesCommandInput, diff --git a/clients/client-backup/commands/ListRecoveryPointsByBackupVaultCommand.ts b/clients/client-backup/commands/ListRecoveryPointsByBackupVaultCommand.ts index af99587c31f6..f5fd99c5e762 100644 --- a/clients/client-backup/commands/ListRecoveryPointsByBackupVaultCommand.ts +++ b/clients/client-backup/commands/ListRecoveryPointsByBackupVaultCommand.ts @@ -24,6 +24,20 @@ export interface ListRecoveryPointsByBackupVaultCommandOutput /** *

Returns detailed information about the recovery points stored in a backup vault.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { BackupClient, ListRecoveryPointsByBackupVaultCommand } from "@aws-sdk/client-backup"; // ES Modules import + * // const { BackupClient, ListRecoveryPointsByBackupVaultCommand } = require("@aws-sdk/client-backup"); // CommonJS import + * const client = new BackupClient(config); + * const command = new ListRecoveryPointsByBackupVaultCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListRecoveryPointsByBackupVaultCommandInput} for command's `input` shape. + * @see {@link ListRecoveryPointsByBackupVaultCommandOutput} for command's `response` shape. + * @see {@link BackupClientResolvedConfig | config} for command's `input` shape. + * */ export class ListRecoveryPointsByBackupVaultCommand extends $Command< ListRecoveryPointsByBackupVaultCommandInput, diff --git a/clients/client-backup/commands/ListRecoveryPointsByResourceCommand.ts b/clients/client-backup/commands/ListRecoveryPointsByResourceCommand.ts index 0e2805187198..8e870ad2a568 100644 --- a/clients/client-backup/commands/ListRecoveryPointsByResourceCommand.ts +++ b/clients/client-backup/commands/ListRecoveryPointsByResourceCommand.ts @@ -25,6 +25,20 @@ export interface ListRecoveryPointsByResourceCommandOutput /** *

Returns detailed information about recovery points of the type specified by a resource * Amazon Resource Name (ARN).

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { BackupClient, ListRecoveryPointsByResourceCommand } from "@aws-sdk/client-backup"; // ES Modules import + * // const { BackupClient, ListRecoveryPointsByResourceCommand } = require("@aws-sdk/client-backup"); // CommonJS import + * const client = new BackupClient(config); + * const command = new ListRecoveryPointsByResourceCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListRecoveryPointsByResourceCommandInput} for command's `input` shape. + * @see {@link ListRecoveryPointsByResourceCommandOutput} for command's `response` shape. + * @see {@link BackupClientResolvedConfig | config} for command's `input` shape. + * */ export class ListRecoveryPointsByResourceCommand extends $Command< ListRecoveryPointsByResourceCommandInput, diff --git a/clients/client-backup/commands/ListRestoreJobsCommand.ts b/clients/client-backup/commands/ListRestoreJobsCommand.ts index 514b7c9419f4..0dcaf79d6529 100644 --- a/clients/client-backup/commands/ListRestoreJobsCommand.ts +++ b/clients/client-backup/commands/ListRestoreJobsCommand.ts @@ -23,6 +23,20 @@ export interface ListRestoreJobsCommandOutput extends ListRestoreJobsOutput, __M /** *

Returns a list of jobs that AWS Backup initiated to restore a saved resource, including * metadata about the recovery process.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { BackupClient, ListRestoreJobsCommand } from "@aws-sdk/client-backup"; // ES Modules import + * // const { BackupClient, ListRestoreJobsCommand } = require("@aws-sdk/client-backup"); // CommonJS import + * const client = new BackupClient(config); + * const command = new ListRestoreJobsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListRestoreJobsCommandInput} for command's `input` shape. + * @see {@link ListRestoreJobsCommandOutput} for command's `response` shape. + * @see {@link BackupClientResolvedConfig | config} for command's `input` shape. + * */ export class ListRestoreJobsCommand extends $Command< ListRestoreJobsCommandInput, diff --git a/clients/client-backup/commands/ListTagsCommand.ts b/clients/client-backup/commands/ListTagsCommand.ts index 4e68fa014632..6b96d70b2d0e 100644 --- a/clients/client-backup/commands/ListTagsCommand.ts +++ b/clients/client-backup/commands/ListTagsCommand.ts @@ -27,6 +27,20 @@ export interface ListTagsCommandOutput extends ListTagsOutput, __MetadataBearer *

* ListTags are currently only supported with Amazon EFS backups.

* + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { BackupClient, ListTagsCommand } from "@aws-sdk/client-backup"; // ES Modules import + * // const { BackupClient, ListTagsCommand } = require("@aws-sdk/client-backup"); // CommonJS import + * const client = new BackupClient(config); + * const command = new ListTagsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListTagsCommandInput} for command's `input` shape. + * @see {@link ListTagsCommandOutput} for command's `response` shape. + * @see {@link BackupClientResolvedConfig | config} for command's `input` shape. + * */ export class ListTagsCommand extends $Command { // Start section: command_properties diff --git a/clients/client-backup/commands/PutBackupVaultAccessPolicyCommand.ts b/clients/client-backup/commands/PutBackupVaultAccessPolicyCommand.ts index 9e3ab24a6bd7..48b0dc23bfa9 100644 --- a/clients/client-backup/commands/PutBackupVaultAccessPolicyCommand.ts +++ b/clients/client-backup/commands/PutBackupVaultAccessPolicyCommand.ts @@ -24,6 +24,20 @@ export interface PutBackupVaultAccessPolicyCommandOutput extends __MetadataBeare *

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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { BackupClient, PutBackupVaultAccessPolicyCommand } from "@aws-sdk/client-backup"; // ES Modules import + * // const { BackupClient, PutBackupVaultAccessPolicyCommand } = require("@aws-sdk/client-backup"); // CommonJS import + * const client = new BackupClient(config); + * const command = new PutBackupVaultAccessPolicyCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link PutBackupVaultAccessPolicyCommandInput} for command's `input` shape. + * @see {@link PutBackupVaultAccessPolicyCommandOutput} for command's `response` shape. + * @see {@link BackupClientResolvedConfig | config} for command's `input` shape. + * */ export class PutBackupVaultAccessPolicyCommand extends $Command< PutBackupVaultAccessPolicyCommandInput, diff --git a/clients/client-backup/commands/PutBackupVaultNotificationsCommand.ts b/clients/client-backup/commands/PutBackupVaultNotificationsCommand.ts index bf19224ccbcb..d7d95e16f51a 100644 --- a/clients/client-backup/commands/PutBackupVaultNotificationsCommand.ts +++ b/clients/client-backup/commands/PutBackupVaultNotificationsCommand.ts @@ -22,6 +22,20 @@ export interface PutBackupVaultNotificationsCommandOutput extends __MetadataBear /** *

Turns on notifications on a backup vault for the specified topic and events.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { BackupClient, PutBackupVaultNotificationsCommand } from "@aws-sdk/client-backup"; // ES Modules import + * // const { BackupClient, PutBackupVaultNotificationsCommand } = require("@aws-sdk/client-backup"); // CommonJS import + * const client = new BackupClient(config); + * const command = new PutBackupVaultNotificationsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link PutBackupVaultNotificationsCommandInput} for command's `input` shape. + * @see {@link PutBackupVaultNotificationsCommandOutput} for command's `response` shape. + * @see {@link BackupClientResolvedConfig | config} for command's `input` shape. + * */ export class PutBackupVaultNotificationsCommand extends $Command< PutBackupVaultNotificationsCommandInput, diff --git a/clients/client-backup/commands/StartBackupJobCommand.ts b/clients/client-backup/commands/StartBackupJobCommand.ts index faee943b2099..7c14932e38a4 100644 --- a/clients/client-backup/commands/StartBackupJobCommand.ts +++ b/clients/client-backup/commands/StartBackupJobCommand.ts @@ -22,6 +22,20 @@ export interface StartBackupJobCommandOutput extends StartBackupJobOutput, __Met /** *

Starts an on-demand backup job for the specified resource.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { BackupClient, StartBackupJobCommand } from "@aws-sdk/client-backup"; // ES Modules import + * // const { BackupClient, StartBackupJobCommand } = require("@aws-sdk/client-backup"); // CommonJS import + * const client = new BackupClient(config); + * const command = new StartBackupJobCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link StartBackupJobCommandInput} for command's `input` shape. + * @see {@link StartBackupJobCommandOutput} for command's `response` shape. + * @see {@link BackupClientResolvedConfig | config} for command's `input` shape. + * */ export class StartBackupJobCommand extends $Command< StartBackupJobCommandInput, diff --git a/clients/client-backup/commands/StartCopyJobCommand.ts b/clients/client-backup/commands/StartCopyJobCommand.ts index 47d64b258551..c275e226be61 100644 --- a/clients/client-backup/commands/StartCopyJobCommand.ts +++ b/clients/client-backup/commands/StartCopyJobCommand.ts @@ -23,6 +23,20 @@ export interface StartCopyJobCommandOutput extends StartCopyJobOutput, __Metadat /** *

Starts a job to create a one-time copy of the specified resource.

*

Does not support continuous backups.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { BackupClient, StartCopyJobCommand } from "@aws-sdk/client-backup"; // ES Modules import + * // const { BackupClient, StartCopyJobCommand } = require("@aws-sdk/client-backup"); // CommonJS import + * const client = new BackupClient(config); + * const command = new StartCopyJobCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link StartCopyJobCommandInput} for command's `input` shape. + * @see {@link StartCopyJobCommandOutput} for command's `response` shape. + * @see {@link BackupClientResolvedConfig | config} for command's `input` shape. + * */ export class StartCopyJobCommand extends $Command< StartCopyJobCommandInput, diff --git a/clients/client-backup/commands/StartRestoreJobCommand.ts b/clients/client-backup/commands/StartRestoreJobCommand.ts index c7ffb3139608..0a6014e4cf5b 100644 --- a/clients/client-backup/commands/StartRestoreJobCommand.ts +++ b/clients/client-backup/commands/StartRestoreJobCommand.ts @@ -22,6 +22,20 @@ export interface StartRestoreJobCommandOutput extends StartRestoreJobOutput, __M /** *

Recovers the saved resource identified by an Amazon Resource Name (ARN).

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { BackupClient, StartRestoreJobCommand } from "@aws-sdk/client-backup"; // ES Modules import + * // const { BackupClient, StartRestoreJobCommand } = require("@aws-sdk/client-backup"); // CommonJS import + * const client = new BackupClient(config); + * const command = new StartRestoreJobCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link StartRestoreJobCommandInput} for command's `input` shape. + * @see {@link StartRestoreJobCommandOutput} for command's `response` shape. + * @see {@link BackupClientResolvedConfig | config} for command's `input` shape. + * */ export class StartRestoreJobCommand extends $Command< StartRestoreJobCommandInput, diff --git a/clients/client-backup/commands/StopBackupJobCommand.ts b/clients/client-backup/commands/StopBackupJobCommand.ts index e9d0eb8f4a45..acb3bb5a0eb9 100644 --- a/clients/client-backup/commands/StopBackupJobCommand.ts +++ b/clients/client-backup/commands/StopBackupJobCommand.ts @@ -22,6 +22,20 @@ export interface StopBackupJobCommandOutput extends __MetadataBearer {} /** *

Attempts to cancel a job to create a one-time backup of a resource.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { BackupClient, StopBackupJobCommand } from "@aws-sdk/client-backup"; // ES Modules import + * // const { BackupClient, StopBackupJobCommand } = require("@aws-sdk/client-backup"); // CommonJS import + * const client = new BackupClient(config); + * const command = new StopBackupJobCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link StopBackupJobCommandInput} for command's `input` shape. + * @see {@link StopBackupJobCommandOutput} for command's `response` shape. + * @see {@link BackupClientResolvedConfig | config} for command's `input` shape. + * */ export class StopBackupJobCommand extends $Command< StopBackupJobCommandInput, diff --git a/clients/client-backup/commands/TagResourceCommand.ts b/clients/client-backup/commands/TagResourceCommand.ts index cb6a8b7e8a30..9c097eeb0d0e 100644 --- a/clients/client-backup/commands/TagResourceCommand.ts +++ b/clients/client-backup/commands/TagResourceCommand.ts @@ -23,6 +23,20 @@ export interface TagResourceCommandOutput extends __MetadataBearer {} /** *

Assigns a set of key-value pairs to a recovery point, backup plan, or backup vault * identified by an Amazon Resource Name (ARN).

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { BackupClient, TagResourceCommand } from "@aws-sdk/client-backup"; // ES Modules import + * // const { BackupClient, TagResourceCommand } = require("@aws-sdk/client-backup"); // CommonJS import + * const client = new BackupClient(config); + * const command = new TagResourceCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link TagResourceCommandInput} for command's `input` shape. + * @see {@link TagResourceCommandOutput} for command's `response` shape. + * @see {@link BackupClientResolvedConfig | config} for command's `input` shape. + * */ export class TagResourceCommand extends $Command< TagResourceCommandInput, diff --git a/clients/client-backup/commands/UntagResourceCommand.ts b/clients/client-backup/commands/UntagResourceCommand.ts index bb79762317bf..233968db715c 100644 --- a/clients/client-backup/commands/UntagResourceCommand.ts +++ b/clients/client-backup/commands/UntagResourceCommand.ts @@ -23,6 +23,20 @@ export interface UntagResourceCommandOutput extends __MetadataBearer {} /** *

Removes a set of key-value pairs from a recovery point, backup plan, or backup vault * identified by an Amazon Resource Name (ARN)

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { BackupClient, UntagResourceCommand } from "@aws-sdk/client-backup"; // ES Modules import + * // const { BackupClient, UntagResourceCommand } = require("@aws-sdk/client-backup"); // CommonJS import + * const client = new BackupClient(config); + * const command = new UntagResourceCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link UntagResourceCommandInput} for command's `input` shape. + * @see {@link UntagResourceCommandOutput} for command's `response` shape. + * @see {@link BackupClientResolvedConfig | config} for command's `input` shape. + * */ export class UntagResourceCommand extends $Command< UntagResourceCommandInput, diff --git a/clients/client-backup/commands/UpdateBackupPlanCommand.ts b/clients/client-backup/commands/UpdateBackupPlanCommand.ts index f21c247bd68c..5deb4d43c024 100644 --- a/clients/client-backup/commands/UpdateBackupPlanCommand.ts +++ b/clients/client-backup/commands/UpdateBackupPlanCommand.ts @@ -24,6 +24,20 @@ export interface UpdateBackupPlanCommandOutput extends UpdateBackupPlanOutput, _ *

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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { BackupClient, UpdateBackupPlanCommand } from "@aws-sdk/client-backup"; // ES Modules import + * // const { BackupClient, UpdateBackupPlanCommand } = require("@aws-sdk/client-backup"); // CommonJS import + * const client = new BackupClient(config); + * const command = new UpdateBackupPlanCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link UpdateBackupPlanCommandInput} for command's `input` shape. + * @see {@link UpdateBackupPlanCommandOutput} for command's `response` shape. + * @see {@link BackupClientResolvedConfig | config} for command's `input` shape. + * */ export class UpdateBackupPlanCommand extends $Command< UpdateBackupPlanCommandInput, diff --git a/clients/client-backup/commands/UpdateGlobalSettingsCommand.ts b/clients/client-backup/commands/UpdateGlobalSettingsCommand.ts index 48f475c6b770..a49cb9bbbba6 100644 --- a/clients/client-backup/commands/UpdateGlobalSettingsCommand.ts +++ b/clients/client-backup/commands/UpdateGlobalSettingsCommand.ts @@ -23,6 +23,20 @@ export interface UpdateGlobalSettingsCommandOutput extends __MetadataBearer {} /** *

Updates the current global settings for the AWS account. Use the * DescribeGlobalSettings API to determine the current settings.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { BackupClient, UpdateGlobalSettingsCommand } from "@aws-sdk/client-backup"; // ES Modules import + * // const { BackupClient, UpdateGlobalSettingsCommand } = require("@aws-sdk/client-backup"); // CommonJS import + * const client = new BackupClient(config); + * const command = new UpdateGlobalSettingsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link UpdateGlobalSettingsCommandInput} for command's `input` shape. + * @see {@link UpdateGlobalSettingsCommandOutput} for command's `response` shape. + * @see {@link BackupClientResolvedConfig | config} for command's `input` shape. + * */ export class UpdateGlobalSettingsCommand extends $Command< UpdateGlobalSettingsCommandInput, diff --git a/clients/client-backup/commands/UpdateRecoveryPointLifecycleCommand.ts b/clients/client-backup/commands/UpdateRecoveryPointLifecycleCommand.ts index 3e732f76c60f..a7651f6eb10d 100644 --- a/clients/client-backup/commands/UpdateRecoveryPointLifecycleCommand.ts +++ b/clients/client-backup/commands/UpdateRecoveryPointLifecycleCommand.ts @@ -33,6 +33,20 @@ export interface UpdateRecoveryPointLifecycleCommandOutput * be changed after a backup has been transitioned to cold.

*

Only Amazon EFS file system backups can be transitioned to cold storage.

*

Does not support continuous backups.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { BackupClient, UpdateRecoveryPointLifecycleCommand } from "@aws-sdk/client-backup"; // ES Modules import + * // const { BackupClient, UpdateRecoveryPointLifecycleCommand } = require("@aws-sdk/client-backup"); // CommonJS import + * const client = new BackupClient(config); + * const command = new UpdateRecoveryPointLifecycleCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link UpdateRecoveryPointLifecycleCommandInput} for command's `input` shape. + * @see {@link UpdateRecoveryPointLifecycleCommandOutput} for command's `response` shape. + * @see {@link BackupClientResolvedConfig | config} for command's `input` shape. + * */ export class UpdateRecoveryPointLifecycleCommand extends $Command< UpdateRecoveryPointLifecycleCommandInput, diff --git a/clients/client-backup/commands/UpdateRegionSettingsCommand.ts b/clients/client-backup/commands/UpdateRegionSettingsCommand.ts index bd1ee78c606d..5b9fef05bdce 100644 --- a/clients/client-backup/commands/UpdateRegionSettingsCommand.ts +++ b/clients/client-backup/commands/UpdateRegionSettingsCommand.ts @@ -27,6 +27,20 @@ export interface UpdateRegionSettingsCommandOutput extends __MetadataBearer {} * 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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { BackupClient, UpdateRegionSettingsCommand } from "@aws-sdk/client-backup"; // ES Modules import + * // const { BackupClient, UpdateRegionSettingsCommand } = require("@aws-sdk/client-backup"); // CommonJS import + * const client = new BackupClient(config); + * const command = new UpdateRegionSettingsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link UpdateRegionSettingsCommandInput} for command's `input` shape. + * @see {@link UpdateRegionSettingsCommandOutput} for command's `response` shape. + * @see {@link BackupClientResolvedConfig | config} for command's `input` shape. + * */ export class UpdateRegionSettingsCommand extends $Command< UpdateRegionSettingsCommandInput, diff --git a/clients/client-backup/models/models_0.ts b/clients/client-backup/models/models_0.ts index 295cc693e255..d732cf24fd13 100644 --- a/clients/client-backup/models/models_0.ts +++ b/clients/client-backup/models/models_0.ts @@ -32,6 +32,9 @@ export interface AdvancedBackupSetting { } export namespace AdvancedBackupSetting { + /** + * @internal + */ export const filterSensitiveLog = (obj: AdvancedBackupSetting): any => ({ ...obj, }); @@ -67,6 +70,9 @@ export interface AlreadyExistsException extends __SmithyException, $MetadataBear } export namespace AlreadyExistsException { + /** + * @internal + */ export const filterSensitiveLog = (obj: AlreadyExistsException): any => ({ ...obj, }); @@ -102,6 +108,9 @@ export interface RecoveryPointCreator { } export namespace RecoveryPointCreator { + /** + * @internal + */ export const filterSensitiveLog = (obj: RecoveryPointCreator): any => ({ ...obj, }); @@ -257,6 +266,9 @@ export interface BackupJob { } export namespace BackupJob { + /** + * @internal + */ export const filterSensitiveLog = (obj: BackupJob): any => ({ ...obj, }); @@ -286,6 +298,9 @@ export interface Lifecycle { } export namespace Lifecycle { + /** + * @internal + */ export const filterSensitiveLog = (obj: Lifecycle): any => ({ ...obj, }); @@ -315,6 +330,9 @@ export interface CopyAction { } export namespace CopyAction { + /** + * @internal + */ export const filterSensitiveLog = (obj: CopyAction): any => ({ ...obj, }); @@ -396,6 +414,9 @@ export interface BackupRule { } export namespace BackupRule { + /** + * @internal + */ export const filterSensitiveLog = (obj: BackupRule): any => ({ ...obj, ...(obj.RecoveryPointTags && { RecoveryPointTags: SENSITIVE_STRING }), @@ -426,6 +447,9 @@ export interface BackupPlan { } export namespace BackupPlan { + /** + * @internal + */ export const filterSensitiveLog = (obj: BackupPlan): any => ({ ...obj, ...(obj.Rules && { Rules: obj.Rules.map((item) => BackupRule.filterSensitiveLog(item)) }), @@ -498,6 +522,9 @@ export interface BackupRuleInput { } export namespace BackupRuleInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: BackupRuleInput): any => ({ ...obj, ...(obj.RecoveryPointTags && { RecoveryPointTags: SENSITIVE_STRING }), @@ -529,6 +556,9 @@ export interface BackupPlanInput { } export namespace BackupPlanInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: BackupPlanInput): any => ({ ...obj, ...(obj.Rules && { Rules: obj.Rules.map((item) => BackupRuleInput.filterSensitiveLog(item)) }), @@ -598,6 +628,9 @@ export interface BackupPlansListMember { } export namespace BackupPlansListMember { + /** + * @internal + */ export const filterSensitiveLog = (obj: BackupPlansListMember): any => ({ ...obj, }); @@ -619,6 +652,9 @@ export interface BackupPlanTemplatesListMember { } export namespace BackupPlanTemplatesListMember { + /** + * @internal + */ export const filterSensitiveLog = (obj: BackupPlanTemplatesListMember): any => ({ ...obj, }); @@ -654,6 +690,9 @@ export interface Condition { } export namespace Condition { + /** + * @internal + */ export const filterSensitiveLog = (obj: Condition): any => ({ ...obj, }); @@ -690,6 +729,9 @@ export interface BackupSelection { } export namespace BackupSelection { + /** + * @internal + */ export const filterSensitiveLog = (obj: BackupSelection): any => ({ ...obj, }); @@ -736,6 +778,9 @@ export interface BackupSelectionsListMember { } export namespace BackupSelectionsListMember { + /** + * @internal + */ export const filterSensitiveLog = (obj: BackupSelectionsListMember): any => ({ ...obj, }); @@ -803,6 +848,9 @@ export interface BackupVaultListMember { } export namespace BackupVaultListMember { + /** + * @internal + */ export const filterSensitiveLog = (obj: BackupVaultListMember): any => ({ ...obj, }); @@ -833,6 +881,9 @@ export interface CalculatedLifecycle { } export namespace CalculatedLifecycle { + /** + * @internal + */ export const filterSensitiveLog = (obj: CalculatedLifecycle): any => ({ ...obj, }); @@ -938,6 +989,9 @@ export interface CopyJob { } export namespace CopyJob { + /** + * @internal + */ export const filterSensitiveLog = (obj: CopyJob): any => ({ ...obj, }); @@ -966,6 +1020,9 @@ export interface CreateBackupPlanInput { } export namespace CreateBackupPlanInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateBackupPlanInput): any => ({ ...obj, ...(obj.BackupPlan && { BackupPlan: BackupPlanInput.filterSensitiveLog(obj.BackupPlan) }), @@ -1007,6 +1064,9 @@ export interface CreateBackupPlanOutput { } export namespace CreateBackupPlanOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateBackupPlanOutput): any => ({ ...obj, }); @@ -1033,6 +1093,9 @@ export interface InvalidParameterValueException extends __SmithyException, $Meta } export namespace InvalidParameterValueException { + /** + * @internal + */ export const filterSensitiveLog = (obj: InvalidParameterValueException): any => ({ ...obj, }); @@ -1059,6 +1122,9 @@ export interface LimitExceededException extends __SmithyException, $MetadataBear } export namespace LimitExceededException { + /** + * @internal + */ export const filterSensitiveLog = (obj: LimitExceededException): any => ({ ...obj, }); @@ -1084,6 +1150,9 @@ export interface MissingParameterValueException extends __SmithyException, $Meta } export namespace MissingParameterValueException { + /** + * @internal + */ export const filterSensitiveLog = (obj: MissingParameterValueException): any => ({ ...obj, }); @@ -1109,6 +1178,9 @@ export interface ServiceUnavailableException extends __SmithyException, $Metadat } export namespace ServiceUnavailableException { + /** + * @internal + */ export const filterSensitiveLog = (obj: ServiceUnavailableException): any => ({ ...obj, }); @@ -1134,6 +1206,9 @@ export interface CreateBackupSelectionInput { } export namespace CreateBackupSelectionInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateBackupSelectionInput): any => ({ ...obj, }); @@ -1161,6 +1236,9 @@ export interface CreateBackupSelectionOutput { } export namespace CreateBackupSelectionOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateBackupSelectionOutput): any => ({ ...obj, }); @@ -1194,6 +1272,9 @@ export interface CreateBackupVaultInput { } export namespace CreateBackupVaultInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateBackupVaultInput): any => ({ ...obj, ...(obj.BackupVaultTags && { BackupVaultTags: SENSITIVE_STRING }), @@ -1224,6 +1305,9 @@ export interface CreateBackupVaultOutput { } export namespace CreateBackupVaultOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateBackupVaultOutput): any => ({ ...obj, }); @@ -1237,6 +1321,9 @@ export interface DeleteBackupPlanInput { } export namespace DeleteBackupPlanInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteBackupPlanInput): any => ({ ...obj, }); @@ -1270,6 +1357,9 @@ export interface DeleteBackupPlanOutput { } export namespace DeleteBackupPlanOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteBackupPlanOutput): any => ({ ...obj, }); @@ -1296,6 +1386,9 @@ export interface InvalidRequestException extends __SmithyException, $MetadataBea } export namespace InvalidRequestException { + /** + * @internal + */ export const filterSensitiveLog = (obj: InvalidRequestException): any => ({ ...obj, }); @@ -1321,6 +1414,9 @@ export interface ResourceNotFoundException extends __SmithyException, $MetadataB } export namespace ResourceNotFoundException { + /** + * @internal + */ export const filterSensitiveLog = (obj: ResourceNotFoundException): any => ({ ...obj, }); @@ -1340,6 +1436,9 @@ export interface DeleteBackupSelectionInput { } export namespace DeleteBackupSelectionInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteBackupSelectionInput): any => ({ ...obj, }); @@ -1355,6 +1454,9 @@ export interface DeleteBackupVaultInput { } export namespace DeleteBackupVaultInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteBackupVaultInput): any => ({ ...obj, }); @@ -1370,6 +1472,9 @@ export interface DeleteBackupVaultAccessPolicyInput { } export namespace DeleteBackupVaultAccessPolicyInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteBackupVaultAccessPolicyInput): any => ({ ...obj, }); @@ -1385,6 +1490,9 @@ export interface DeleteBackupVaultNotificationsInput { } export namespace DeleteBackupVaultNotificationsInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteBackupVaultNotificationsInput): any => ({ ...obj, }); @@ -1406,6 +1514,9 @@ export interface DeleteRecoveryPointInput { } export namespace DeleteRecoveryPointInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteRecoveryPointInput): any => ({ ...obj, }); @@ -1432,6 +1543,9 @@ export interface InvalidResourceStateException extends __SmithyException, $Metad } export namespace InvalidResourceStateException { + /** + * @internal + */ export const filterSensitiveLog = (obj: InvalidResourceStateException): any => ({ ...obj, }); @@ -1458,6 +1572,9 @@ export interface DependencyFailureException extends __SmithyException, $Metadata } export namespace DependencyFailureException { + /** + * @internal + */ export const filterSensitiveLog = (obj: DependencyFailureException): any => ({ ...obj, }); @@ -1471,6 +1588,9 @@ export interface DescribeBackupJobInput { } export namespace DescribeBackupJobInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeBackupJobInput): any => ({ ...obj, }); @@ -1607,6 +1727,9 @@ export interface DescribeBackupJobOutput { } export namespace DescribeBackupJobOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeBackupJobOutput): any => ({ ...obj, }); @@ -1622,6 +1745,9 @@ export interface DescribeBackupVaultInput { } export namespace DescribeBackupVaultInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeBackupVaultInput): any => ({ ...obj, }); @@ -1668,6 +1794,9 @@ export interface DescribeBackupVaultOutput { } export namespace DescribeBackupVaultOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeBackupVaultOutput): any => ({ ...obj, }); @@ -1681,6 +1810,9 @@ export interface DescribeCopyJobInput { } export namespace DescribeCopyJobInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeCopyJobInput): any => ({ ...obj, }); @@ -1694,6 +1826,9 @@ export interface DescribeCopyJobOutput { } export namespace DescribeCopyJobOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeCopyJobOutput): any => ({ ...obj, }); @@ -1702,6 +1837,9 @@ export namespace DescribeCopyJobOutput { export interface DescribeGlobalSettingsInput {} export namespace DescribeGlobalSettingsInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeGlobalSettingsInput): any => ({ ...obj, }); @@ -1723,6 +1861,9 @@ export interface DescribeGlobalSettingsOutput { } export namespace DescribeGlobalSettingsOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeGlobalSettingsOutput): any => ({ ...obj, }); @@ -1737,6 +1878,9 @@ export interface DescribeProtectedResourceInput { } export namespace DescribeProtectedResourceInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeProtectedResourceInput): any => ({ ...obj, }); @@ -1765,6 +1909,9 @@ export interface DescribeProtectedResourceOutput { } export namespace DescribeProtectedResourceOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeProtectedResourceOutput): any => ({ ...obj, }); @@ -1786,6 +1933,9 @@ export interface DescribeRecoveryPointInput { } export namespace DescribeRecoveryPointInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeRecoveryPointInput): any => ({ ...obj, }); @@ -1934,6 +2084,9 @@ export interface DescribeRecoveryPointOutput { } export namespace DescribeRecoveryPointOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeRecoveryPointOutput): any => ({ ...obj, }); @@ -1942,6 +2095,9 @@ export namespace DescribeRecoveryPointOutput { export interface DescribeRegionSettingsInput {} export namespace DescribeRegionSettingsInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeRegionSettingsInput): any => ({ ...obj, }); @@ -1955,6 +2111,9 @@ export interface DescribeRegionSettingsOutput { } export namespace DescribeRegionSettingsOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeRegionSettingsOutput): any => ({ ...obj, }); @@ -1968,6 +2127,9 @@ export interface DescribeRestoreJobInput { } export namespace DescribeRestoreJobInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeRestoreJobInput): any => ({ ...obj, }); @@ -2062,6 +2224,9 @@ export interface DescribeRestoreJobOutput { } export namespace DescribeRestoreJobOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeRestoreJobOutput): any => ({ ...obj, }); @@ -2081,6 +2246,9 @@ export interface DisassociateRecoveryPointInput { } export namespace DisassociateRecoveryPointInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: DisassociateRecoveryPointInput): any => ({ ...obj, }); @@ -2094,6 +2262,9 @@ export interface ExportBackupPlanTemplateInput { } export namespace ExportBackupPlanTemplateInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: ExportBackupPlanTemplateInput): any => ({ ...obj, }); @@ -2112,6 +2283,9 @@ export interface ExportBackupPlanTemplateOutput { } export namespace ExportBackupPlanTemplateOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: ExportBackupPlanTemplateOutput): any => ({ ...obj, }); @@ -2131,6 +2305,9 @@ export interface GetBackupPlanInput { } export namespace GetBackupPlanInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetBackupPlanInput): any => ({ ...obj, }); @@ -2198,6 +2375,9 @@ export interface GetBackupPlanOutput { } export namespace GetBackupPlanOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetBackupPlanOutput): any => ({ ...obj, ...(obj.BackupPlan && { BackupPlan: BackupPlan.filterSensitiveLog(obj.BackupPlan) }), @@ -2212,6 +2392,9 @@ export interface GetBackupPlanFromJSONInput { } export namespace GetBackupPlanFromJSONInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetBackupPlanFromJSONInput): any => ({ ...obj, }); @@ -2226,6 +2409,9 @@ export interface GetBackupPlanFromJSONOutput { } export namespace GetBackupPlanFromJSONOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetBackupPlanFromJSONOutput): any => ({ ...obj, ...(obj.BackupPlan && { BackupPlan: BackupPlan.filterSensitiveLog(obj.BackupPlan) }), @@ -2240,6 +2426,9 @@ export interface GetBackupPlanFromTemplateInput { } export namespace GetBackupPlanFromTemplateInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetBackupPlanFromTemplateInput): any => ({ ...obj, }); @@ -2254,6 +2443,9 @@ export interface GetBackupPlanFromTemplateOutput { } export namespace GetBackupPlanFromTemplateOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetBackupPlanFromTemplateOutput): any => ({ ...obj, ...(obj.BackupPlanDocument && { BackupPlanDocument: BackupPlan.filterSensitiveLog(obj.BackupPlanDocument) }), @@ -2274,6 +2466,9 @@ export interface GetBackupSelectionInput { } export namespace GetBackupSelectionInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetBackupSelectionInput): any => ({ ...obj, }); @@ -2312,6 +2507,9 @@ export interface GetBackupSelectionOutput { } export namespace GetBackupSelectionOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetBackupSelectionOutput): any => ({ ...obj, }); @@ -2327,6 +2525,9 @@ export interface GetBackupVaultAccessPolicyInput { } export namespace GetBackupVaultAccessPolicyInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetBackupVaultAccessPolicyInput): any => ({ ...obj, }); @@ -2353,6 +2554,9 @@ export interface GetBackupVaultAccessPolicyOutput { } export namespace GetBackupVaultAccessPolicyOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetBackupVaultAccessPolicyOutput): any => ({ ...obj, }); @@ -2368,6 +2572,9 @@ export interface GetBackupVaultNotificationsInput { } export namespace GetBackupVaultNotificationsInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetBackupVaultNotificationsInput): any => ({ ...obj, }); @@ -2401,6 +2608,9 @@ export interface GetBackupVaultNotificationsOutput { } export namespace GetBackupVaultNotificationsOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetBackupVaultNotificationsOutput): any => ({ ...obj, }); @@ -2422,6 +2632,9 @@ export interface GetRecoveryPointRestoreMetadataInput { } export namespace GetRecoveryPointRestoreMetadataInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetRecoveryPointRestoreMetadataInput): any => ({ ...obj, }); @@ -2449,6 +2662,9 @@ export interface GetRecoveryPointRestoreMetadataOutput { } export namespace GetRecoveryPointRestoreMetadataOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetRecoveryPointRestoreMetadataOutput): any => ({ ...obj, ...(obj.RestoreMetadata && { RestoreMetadata: SENSITIVE_STRING }), @@ -2493,6 +2709,9 @@ export interface GetSupportedResourceTypesOutput { } export namespace GetSupportedResourceTypesOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetSupportedResourceTypesOutput): any => ({ ...obj, }); @@ -2586,6 +2805,9 @@ export interface ListBackupJobsInput { } export namespace ListBackupJobsInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListBackupJobsInput): any => ({ ...obj, }); @@ -2608,6 +2830,9 @@ export interface ListBackupJobsOutput { } export namespace ListBackupJobsOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListBackupJobsOutput): any => ({ ...obj, }); @@ -2635,6 +2860,9 @@ export interface ListBackupPlansInput { } export namespace ListBackupPlansInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListBackupPlansInput): any => ({ ...obj, }); @@ -2657,6 +2885,9 @@ export interface ListBackupPlansOutput { } export namespace ListBackupPlansOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListBackupPlansOutput): any => ({ ...obj, }); @@ -2678,6 +2909,9 @@ export interface ListBackupPlanTemplatesInput { } export namespace ListBackupPlanTemplatesInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListBackupPlanTemplatesInput): any => ({ ...obj, }); @@ -2699,6 +2933,9 @@ export interface ListBackupPlanTemplatesOutput { } export namespace ListBackupPlanTemplatesOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListBackupPlanTemplatesOutput): any => ({ ...obj, }); @@ -2725,6 +2962,9 @@ export interface ListBackupPlanVersionsInput { } export namespace ListBackupPlanVersionsInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListBackupPlanVersionsInput): any => ({ ...obj, }); @@ -2746,6 +2986,9 @@ export interface ListBackupPlanVersionsOutput { } export namespace ListBackupPlanVersionsOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListBackupPlanVersionsOutput): any => ({ ...obj, }); @@ -2772,6 +3015,9 @@ export interface ListBackupSelectionsInput { } export namespace ListBackupSelectionsInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListBackupSelectionsInput): any => ({ ...obj, }); @@ -2794,6 +3040,9 @@ export interface ListBackupSelectionsOutput { } export namespace ListBackupSelectionsOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListBackupSelectionsOutput): any => ({ ...obj, }); @@ -2815,6 +3064,9 @@ export interface ListBackupVaultsInput { } export namespace ListBackupVaultsInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListBackupVaultsInput): any => ({ ...obj, }); @@ -2838,6 +3090,9 @@ export interface ListBackupVaultsOutput { } export namespace ListBackupVaultsOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListBackupVaultsOutput): any => ({ ...obj, }); @@ -2927,6 +3182,9 @@ export interface ListCopyJobsInput { } export namespace ListCopyJobsInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListCopyJobsInput): any => ({ ...obj, }); @@ -2948,6 +3206,9 @@ export interface ListCopyJobsOutput { } export namespace ListCopyJobsOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListCopyJobsOutput): any => ({ ...obj, }); @@ -2969,6 +3230,9 @@ export interface ListProtectedResourcesInput { } export namespace ListProtectedResourcesInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListProtectedResourcesInput): any => ({ ...obj, }); @@ -3001,6 +3265,9 @@ export interface ProtectedResource { } export namespace ProtectedResource { + /** + * @internal + */ export const filterSensitiveLog = (obj: ProtectedResource): any => ({ ...obj, }); @@ -3024,6 +3291,9 @@ export interface ListProtectedResourcesOutput { } export namespace ListProtectedResourcesOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListProtectedResourcesOutput): any => ({ ...obj, }); @@ -3078,6 +3348,9 @@ export interface ListRecoveryPointsByBackupVaultInput { } export namespace ListRecoveryPointsByBackupVaultInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListRecoveryPointsByBackupVaultInput): any => ({ ...obj, }); @@ -3204,6 +3477,9 @@ export interface RecoveryPointByBackupVault { } export namespace RecoveryPointByBackupVault { + /** + * @internal + */ export const filterSensitiveLog = (obj: RecoveryPointByBackupVault): any => ({ ...obj, }); @@ -3226,6 +3502,9 @@ export interface ListRecoveryPointsByBackupVaultOutput { } export namespace ListRecoveryPointsByBackupVaultOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListRecoveryPointsByBackupVaultOutput): any => ({ ...obj, }); @@ -3253,6 +3532,9 @@ export interface ListRecoveryPointsByResourceInput { } export namespace ListRecoveryPointsByResourceInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListRecoveryPointsByResourceInput): any => ({ ...obj, }); @@ -3301,6 +3583,9 @@ export interface RecoveryPointByResource { } export namespace RecoveryPointByResource { + /** + * @internal + */ export const filterSensitiveLog = (obj: RecoveryPointByResource): any => ({ ...obj, }); @@ -3323,6 +3608,9 @@ export interface ListRecoveryPointsByResourceOutput { } export namespace ListRecoveryPointsByResourceOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListRecoveryPointsByResourceOutput): any => ({ ...obj, }); @@ -3365,6 +3653,9 @@ export interface ListRestoreJobsInput { } export namespace ListRestoreJobsInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListRestoreJobsInput): any => ({ ...obj, }); @@ -3455,6 +3746,9 @@ export interface RestoreJobsListMember { } export namespace RestoreJobsListMember { + /** + * @internal + */ export const filterSensitiveLog = (obj: RestoreJobsListMember): any => ({ ...obj, }); @@ -3477,6 +3771,9 @@ export interface ListRestoreJobsOutput { } export namespace ListRestoreJobsOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListRestoreJobsOutput): any => ({ ...obj, }); @@ -3505,6 +3802,9 @@ export interface ListTagsInput { } export namespace ListTagsInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListTagsInput): any => ({ ...obj, }); @@ -3527,6 +3827,9 @@ export interface ListTagsOutput { } export namespace ListTagsOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListTagsOutput): any => ({ ...obj, ...(obj.Tags && { Tags: SENSITIVE_STRING }), @@ -3548,6 +3851,9 @@ export interface PutBackupVaultAccessPolicyInput { } export namespace PutBackupVaultAccessPolicyInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: PutBackupVaultAccessPolicyInput): any => ({ ...obj, }); @@ -3575,6 +3881,9 @@ export interface PutBackupVaultNotificationsInput { } export namespace PutBackupVaultNotificationsInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: PutBackupVaultNotificationsInput): any => ({ ...obj, }); @@ -3649,6 +3958,9 @@ export interface StartBackupJobInput { } export namespace StartBackupJobInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: StartBackupJobInput): any => ({ ...obj, ...(obj.RecoveryPointTags && { RecoveryPointTags: SENSITIVE_STRING }), @@ -3677,6 +3989,9 @@ export interface StartBackupJobOutput { } export namespace StartBackupJobOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: StartBackupJobOutput): any => ({ ...obj, }); @@ -3729,6 +4044,9 @@ export interface StartCopyJobInput { } export namespace StartCopyJobInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: StartCopyJobInput): any => ({ ...obj, }); @@ -3750,6 +4068,9 @@ export interface StartCopyJobOutput { } export namespace StartCopyJobOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: StartCopyJobOutput): any => ({ ...obj, }); @@ -3865,6 +4186,9 @@ export interface StartRestoreJobInput { } export namespace StartRestoreJobInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: StartRestoreJobInput): any => ({ ...obj, ...(obj.Metadata && { Metadata: SENSITIVE_STRING }), @@ -3879,6 +4203,9 @@ export interface StartRestoreJobOutput { } export namespace StartRestoreJobOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: StartRestoreJobOutput): any => ({ ...obj, }); @@ -3892,6 +4219,9 @@ export interface StopBackupJobInput { } export namespace StopBackupJobInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: StopBackupJobInput): any => ({ ...obj, }); @@ -3912,6 +4242,9 @@ export interface TagResourceInput { } export namespace TagResourceInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: TagResourceInput): any => ({ ...obj, ...(obj.Tags && { Tags: SENSITIVE_STRING }), @@ -3932,6 +4265,9 @@ export interface UntagResourceInput { } export namespace UntagResourceInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: UntagResourceInput): any => ({ ...obj, ...(obj.TagKeyList && { TagKeyList: SENSITIVE_STRING }), @@ -3952,6 +4288,9 @@ export interface UpdateBackupPlanInput { } export namespace UpdateBackupPlanInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateBackupPlanInput): any => ({ ...obj, ...(obj.BackupPlan && { BackupPlan: BackupPlanInput.filterSensitiveLog(obj.BackupPlan) }), @@ -3991,6 +4330,9 @@ export interface UpdateBackupPlanOutput { } export namespace UpdateBackupPlanOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateBackupPlanOutput): any => ({ ...obj, }); @@ -4004,6 +4346,9 @@ export interface UpdateGlobalSettingsInput { } export namespace UpdateGlobalSettingsInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateGlobalSettingsInput): any => ({ ...obj, }); @@ -4036,6 +4381,9 @@ export interface UpdateRecoveryPointLifecycleInput { } export namespace UpdateRecoveryPointLifecycleInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateRecoveryPointLifecycleInput): any => ({ ...obj, }); @@ -4074,6 +4422,9 @@ export interface UpdateRecoveryPointLifecycleOutput { } export namespace UpdateRecoveryPointLifecycleOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateRecoveryPointLifecycleOutput): any => ({ ...obj, }); @@ -4087,6 +4438,9 @@ export interface UpdateRegionSettingsInput { } export namespace UpdateRegionSettingsInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateRegionSettingsInput): any => ({ ...obj, }); diff --git a/clients/client-batch/commands/CancelJobCommand.ts b/clients/client-batch/commands/CancelJobCommand.ts index d0342e042725..fa28bd34cd83 100644 --- a/clients/client-batch/commands/CancelJobCommand.ts +++ b/clients/client-batch/commands/CancelJobCommand.ts @@ -25,6 +25,20 @@ export interface CancelJobCommandOutput extends CancelJobResponse, __MetadataBea * RUNNABLE state are canceled. Jobs that have progressed to STARTING or RUNNING * aren't canceled, but the API operation still succeeds, even if no job is canceled. These jobs must be terminated with * the TerminateJob operation.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { BatchClient, CancelJobCommand } from "@aws-sdk/client-batch"; // ES Modules import + * // const { BatchClient, CancelJobCommand } = require("@aws-sdk/client-batch"); // CommonJS import + * const client = new BatchClient(config); + * const command = new CancelJobCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CancelJobCommandInput} for command's `input` shape. + * @see {@link CancelJobCommandOutput} for command's `response` shape. + * @see {@link BatchClientResolvedConfig | config} for command's `input` shape. + * */ export class CancelJobCommand extends $Command< CancelJobCommandInput, diff --git a/clients/client-batch/commands/CreateComputeEnvironmentCommand.ts b/clients/client-batch/commands/CreateComputeEnvironmentCommand.ts index 0fecaebb261f..4bc243e138a1 100644 --- a/clients/client-batch/commands/CreateComputeEnvironmentCommand.ts +++ b/clients/client-batch/commands/CreateComputeEnvironmentCommand.ts @@ -62,6 +62,20 @@ export interface CreateComputeEnvironmentCommandOutput extends CreateComputeEnvi * * * + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { BatchClient, CreateComputeEnvironmentCommand } from "@aws-sdk/client-batch"; // ES Modules import + * // const { BatchClient, CreateComputeEnvironmentCommand } = require("@aws-sdk/client-batch"); // CommonJS import + * const client = new BatchClient(config); + * const command = new CreateComputeEnvironmentCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreateComputeEnvironmentCommandInput} for command's `input` shape. + * @see {@link CreateComputeEnvironmentCommandOutput} for command's `response` shape. + * @see {@link BatchClientResolvedConfig | config} for command's `input` shape. + * */ export class CreateComputeEnvironmentCommand extends $Command< CreateComputeEnvironmentCommandInput, diff --git a/clients/client-batch/commands/CreateJobQueueCommand.ts b/clients/client-batch/commands/CreateJobQueueCommand.ts index cf7b2ecd0aae..8dbaf92d47ae 100644 --- a/clients/client-batch/commands/CreateJobQueueCommand.ts +++ b/clients/client-batch/commands/CreateJobQueueCommand.ts @@ -27,6 +27,20 @@ export interface CreateJobQueueCommandOutput extends CreateJobQueueResponse, __M * 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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { BatchClient, CreateJobQueueCommand } from "@aws-sdk/client-batch"; // ES Modules import + * // const { BatchClient, CreateJobQueueCommand } = require("@aws-sdk/client-batch"); // CommonJS import + * const client = new BatchClient(config); + * const command = new CreateJobQueueCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreateJobQueueCommandInput} for command's `input` shape. + * @see {@link CreateJobQueueCommandOutput} for command's `response` shape. + * @see {@link BatchClientResolvedConfig | config} for command's `input` shape. + * */ export class CreateJobQueueCommand extends $Command< CreateJobQueueCommandInput, diff --git a/clients/client-batch/commands/DeleteComputeEnvironmentCommand.ts b/clients/client-batch/commands/DeleteComputeEnvironmentCommand.ts index e8372ba44936..93d9ba2b8829 100644 --- a/clients/client-batch/commands/DeleteComputeEnvironmentCommand.ts +++ b/clients/client-batch/commands/DeleteComputeEnvironmentCommand.ts @@ -25,6 +25,20 @@ export interface DeleteComputeEnvironmentCommandOutput extends DeleteComputeEnvi *

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 AWS 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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { BatchClient, DeleteComputeEnvironmentCommand } from "@aws-sdk/client-batch"; // ES Modules import + * // const { BatchClient, DeleteComputeEnvironmentCommand } = require("@aws-sdk/client-batch"); // CommonJS import + * const client = new BatchClient(config); + * const command = new DeleteComputeEnvironmentCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteComputeEnvironmentCommandInput} for command's `input` shape. + * @see {@link DeleteComputeEnvironmentCommandOutput} for command's `response` shape. + * @see {@link BatchClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteComputeEnvironmentCommand extends $Command< DeleteComputeEnvironmentCommandInput, diff --git a/clients/client-batch/commands/DeleteJobQueueCommand.ts b/clients/client-batch/commands/DeleteJobQueueCommand.ts index 58c0a32f7c91..685ffe593511 100644 --- a/clients/client-batch/commands/DeleteJobQueueCommand.ts +++ b/clients/client-batch/commands/DeleteJobQueueCommand.ts @@ -25,6 +25,20 @@ export interface DeleteJobQueueCommandOutput extends DeleteJobQueueResponse, __M * 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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { BatchClient, DeleteJobQueueCommand } from "@aws-sdk/client-batch"; // ES Modules import + * // const { BatchClient, DeleteJobQueueCommand } = require("@aws-sdk/client-batch"); // CommonJS import + * const client = new BatchClient(config); + * const command = new DeleteJobQueueCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteJobQueueCommandInput} for command's `input` shape. + * @see {@link DeleteJobQueueCommandOutput} for command's `response` shape. + * @see {@link BatchClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteJobQueueCommand extends $Command< DeleteJobQueueCommandInput, diff --git a/clients/client-batch/commands/DeregisterJobDefinitionCommand.ts b/clients/client-batch/commands/DeregisterJobDefinitionCommand.ts index 93429bb9757c..f6d4336a2358 100644 --- a/clients/client-batch/commands/DeregisterJobDefinitionCommand.ts +++ b/clients/client-batch/commands/DeregisterJobDefinitionCommand.ts @@ -22,6 +22,20 @@ export interface DeregisterJobDefinitionCommandOutput extends DeregisterJobDefin /** *

Deregisters an AWS Batch job definition. Job definitions are permanently deleted after 180 days.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { BatchClient, DeregisterJobDefinitionCommand } from "@aws-sdk/client-batch"; // ES Modules import + * // const { BatchClient, DeregisterJobDefinitionCommand } = require("@aws-sdk/client-batch"); // CommonJS import + * const client = new BatchClient(config); + * const command = new DeregisterJobDefinitionCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeregisterJobDefinitionCommandInput} for command's `input` shape. + * @see {@link DeregisterJobDefinitionCommandOutput} for command's `response` shape. + * @see {@link BatchClientResolvedConfig | config} for command's `input` shape. + * */ export class DeregisterJobDefinitionCommand extends $Command< DeregisterJobDefinitionCommandInput, diff --git a/clients/client-batch/commands/DescribeComputeEnvironmentsCommand.ts b/clients/client-batch/commands/DescribeComputeEnvironmentsCommand.ts index a65af9a6b980..aa54d7e6cd60 100644 --- a/clients/client-batch/commands/DescribeComputeEnvironmentsCommand.ts +++ b/clients/client-batch/commands/DescribeComputeEnvironmentsCommand.ts @@ -27,6 +27,20 @@ export interface DescribeComputeEnvironmentsCommandOutput *

If you're using an unmanaged compute environment, you can use the DescribeComputeEnvironment * operation to determine the ecsClusterArn that you should launch your Amazon ECS container instances * into.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { BatchClient, DescribeComputeEnvironmentsCommand } from "@aws-sdk/client-batch"; // ES Modules import + * // const { BatchClient, DescribeComputeEnvironmentsCommand } = require("@aws-sdk/client-batch"); // CommonJS import + * const client = new BatchClient(config); + * const command = new DescribeComputeEnvironmentsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeComputeEnvironmentsCommandInput} for command's `input` shape. + * @see {@link DescribeComputeEnvironmentsCommandOutput} for command's `response` shape. + * @see {@link BatchClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeComputeEnvironmentsCommand extends $Command< DescribeComputeEnvironmentsCommandInput, diff --git a/clients/client-batch/commands/DescribeJobDefinitionsCommand.ts b/clients/client-batch/commands/DescribeJobDefinitionsCommand.ts index 40d0c7f9146f..963121d106ac 100644 --- a/clients/client-batch/commands/DescribeJobDefinitionsCommand.ts +++ b/clients/client-batch/commands/DescribeJobDefinitionsCommand.ts @@ -23,6 +23,20 @@ export interface DescribeJobDefinitionsCommandOutput extends DescribeJobDefiniti /** *

Describes a list of job definitions. You can specify a status (such as ACTIVE) to only * return job definitions that match that status.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { BatchClient, DescribeJobDefinitionsCommand } from "@aws-sdk/client-batch"; // ES Modules import + * // const { BatchClient, DescribeJobDefinitionsCommand } = require("@aws-sdk/client-batch"); // CommonJS import + * const client = new BatchClient(config); + * const command = new DescribeJobDefinitionsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeJobDefinitionsCommandInput} for command's `input` shape. + * @see {@link DescribeJobDefinitionsCommandOutput} for command's `response` shape. + * @see {@link BatchClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeJobDefinitionsCommand extends $Command< DescribeJobDefinitionsCommandInput, diff --git a/clients/client-batch/commands/DescribeJobQueuesCommand.ts b/clients/client-batch/commands/DescribeJobQueuesCommand.ts index ebbe36e9e01a..b466961f1ff6 100644 --- a/clients/client-batch/commands/DescribeJobQueuesCommand.ts +++ b/clients/client-batch/commands/DescribeJobQueuesCommand.ts @@ -22,6 +22,20 @@ export interface DescribeJobQueuesCommandOutput extends DescribeJobQueuesRespons /** *

Describes one or more of your job queues.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { BatchClient, DescribeJobQueuesCommand } from "@aws-sdk/client-batch"; // ES Modules import + * // const { BatchClient, DescribeJobQueuesCommand } = require("@aws-sdk/client-batch"); // CommonJS import + * const client = new BatchClient(config); + * const command = new DescribeJobQueuesCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeJobQueuesCommandInput} for command's `input` shape. + * @see {@link DescribeJobQueuesCommandOutput} for command's `response` shape. + * @see {@link BatchClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeJobQueuesCommand extends $Command< DescribeJobQueuesCommandInput, diff --git a/clients/client-batch/commands/DescribeJobsCommand.ts b/clients/client-batch/commands/DescribeJobsCommand.ts index 117af95e7fdc..e9727286725d 100644 --- a/clients/client-batch/commands/DescribeJobsCommand.ts +++ b/clients/client-batch/commands/DescribeJobsCommand.ts @@ -22,6 +22,20 @@ export interface DescribeJobsCommandOutput extends DescribeJobsResponse, __Metad /** *

Describes a list of AWS Batch jobs.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { BatchClient, DescribeJobsCommand } from "@aws-sdk/client-batch"; // ES Modules import + * // const { BatchClient, DescribeJobsCommand } = require("@aws-sdk/client-batch"); // CommonJS import + * const client = new BatchClient(config); + * const command = new DescribeJobsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeJobsCommandInput} for command's `input` shape. + * @see {@link DescribeJobsCommandOutput} for command's `response` shape. + * @see {@link BatchClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeJobsCommand extends $Command< DescribeJobsCommandInput, diff --git a/clients/client-batch/commands/ListJobsCommand.ts b/clients/client-batch/commands/ListJobsCommand.ts index 5368a3548402..7ea00dc5668e 100644 --- a/clients/client-batch/commands/ListJobsCommand.ts +++ b/clients/client-batch/commands/ListJobsCommand.ts @@ -36,6 +36,20 @@ export interface ListJobsCommandOutput extends ListJobsResponse, __MetadataBeare * *

You can filter the results by job status with the jobStatus parameter. If you don't specify a * status, only RUNNING jobs are returned.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { BatchClient, ListJobsCommand } from "@aws-sdk/client-batch"; // ES Modules import + * // const { BatchClient, ListJobsCommand } = require("@aws-sdk/client-batch"); // CommonJS import + * const client = new BatchClient(config); + * const command = new ListJobsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListJobsCommandInput} for command's `input` shape. + * @see {@link ListJobsCommandOutput} for command's `response` shape. + * @see {@link BatchClientResolvedConfig | config} for command's `input` shape. + * */ export class ListJobsCommand extends $Command { // Start section: command_properties diff --git a/clients/client-batch/commands/ListTagsForResourceCommand.ts b/clients/client-batch/commands/ListTagsForResourceCommand.ts index 1ced02db7664..627401ea3631 100644 --- a/clients/client-batch/commands/ListTagsForResourceCommand.ts +++ b/clients/client-batch/commands/ListTagsForResourceCommand.ts @@ -23,6 +23,20 @@ export interface ListTagsForResourceCommandOutput extends ListTagsForResourceRes /** *

Lists the tags for an AWS Batch resource. AWS Batch resources that support tags are compute environments, jobs, job definitions, and job * queues. ARNs for child jobs of array and multi-node parallel (MNP) jobs are not supported.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { BatchClient, ListTagsForResourceCommand } from "@aws-sdk/client-batch"; // ES Modules import + * // const { BatchClient, ListTagsForResourceCommand } = require("@aws-sdk/client-batch"); // CommonJS import + * const client = new BatchClient(config); + * const command = new ListTagsForResourceCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListTagsForResourceCommandInput} for command's `input` shape. + * @see {@link ListTagsForResourceCommandOutput} for command's `response` shape. + * @see {@link BatchClientResolvedConfig | config} for command's `input` shape. + * */ export class ListTagsForResourceCommand extends $Command< ListTagsForResourceCommandInput, diff --git a/clients/client-batch/commands/RegisterJobDefinitionCommand.ts b/clients/client-batch/commands/RegisterJobDefinitionCommand.ts index f6ee37249112..5c4492661cf0 100644 --- a/clients/client-batch/commands/RegisterJobDefinitionCommand.ts +++ b/clients/client-batch/commands/RegisterJobDefinitionCommand.ts @@ -22,6 +22,20 @@ export interface RegisterJobDefinitionCommandOutput extends RegisterJobDefinitio /** *

Registers an AWS Batch job definition.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { BatchClient, RegisterJobDefinitionCommand } from "@aws-sdk/client-batch"; // ES Modules import + * // const { BatchClient, RegisterJobDefinitionCommand } = require("@aws-sdk/client-batch"); // CommonJS import + * const client = new BatchClient(config); + * const command = new RegisterJobDefinitionCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link RegisterJobDefinitionCommandInput} for command's `input` shape. + * @see {@link RegisterJobDefinitionCommandOutput} for command's `response` shape. + * @see {@link BatchClientResolvedConfig | config} for command's `input` shape. + * */ export class RegisterJobDefinitionCommand extends $Command< RegisterJobDefinitionCommandInput, diff --git a/clients/client-batch/commands/SubmitJobCommand.ts b/clients/client-batch/commands/SubmitJobCommand.ts index d142c3d44a92..f3e9f9adbdbd 100644 --- a/clients/client-batch/commands/SubmitJobCommand.ts +++ b/clients/client-batch/commands/SubmitJobCommand.ts @@ -31,6 +31,20 @@ export interface SubmitJobCommandOutput extends SubmitJobResponse, __MetadataBea *

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.

* + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { BatchClient, SubmitJobCommand } from "@aws-sdk/client-batch"; // ES Modules import + * // const { BatchClient, SubmitJobCommand } = require("@aws-sdk/client-batch"); // CommonJS import + * const client = new BatchClient(config); + * const command = new SubmitJobCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link SubmitJobCommandInput} for command's `input` shape. + * @see {@link SubmitJobCommandOutput} for command's `response` shape. + * @see {@link BatchClientResolvedConfig | config} for command's `input` shape. + * */ export class SubmitJobCommand extends $Command< SubmitJobCommandInput, diff --git a/clients/client-batch/commands/TagResourceCommand.ts b/clients/client-batch/commands/TagResourceCommand.ts index 985f36bf1262..7c15b9809425 100644 --- a/clients/client-batch/commands/TagResourceCommand.ts +++ b/clients/client-batch/commands/TagResourceCommand.ts @@ -25,6 +25,20 @@ export interface TagResourceCommandOutput extends TagResourceResponse, __Metadat * resource aren't specified in the request parameters, they aren't changed. When a resource is deleted, the tags * associated with that resource are deleted as well. AWS Batch resources that support tags are compute environments, jobs, job definitions, and job * queues. ARNs for child jobs of array and multi-node parallel (MNP) jobs are not supported.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { BatchClient, TagResourceCommand } from "@aws-sdk/client-batch"; // ES Modules import + * // const { BatchClient, TagResourceCommand } = require("@aws-sdk/client-batch"); // CommonJS import + * const client = new BatchClient(config); + * const command = new TagResourceCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link TagResourceCommandInput} for command's `input` shape. + * @see {@link TagResourceCommandOutput} for command's `response` shape. + * @see {@link BatchClientResolvedConfig | config} for command's `input` shape. + * */ export class TagResourceCommand extends $Command< TagResourceCommandInput, diff --git a/clients/client-batch/commands/TerminateJobCommand.ts b/clients/client-batch/commands/TerminateJobCommand.ts index 51bf2286238a..ceaf9c7cc4f8 100644 --- a/clients/client-batch/commands/TerminateJobCommand.ts +++ b/clients/client-batch/commands/TerminateJobCommand.ts @@ -24,6 +24,20 @@ export interface TerminateJobCommandOutput extends TerminateJobResponse, __Metad *

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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { BatchClient, TerminateJobCommand } from "@aws-sdk/client-batch"; // ES Modules import + * // const { BatchClient, TerminateJobCommand } = require("@aws-sdk/client-batch"); // CommonJS import + * const client = new BatchClient(config); + * const command = new TerminateJobCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link TerminateJobCommandInput} for command's `input` shape. + * @see {@link TerminateJobCommandOutput} for command's `response` shape. + * @see {@link BatchClientResolvedConfig | config} for command's `input` shape. + * */ export class TerminateJobCommand extends $Command< TerminateJobCommandInput, diff --git a/clients/client-batch/commands/UntagResourceCommand.ts b/clients/client-batch/commands/UntagResourceCommand.ts index 2e7c479e11e7..8c946abfdc25 100644 --- a/clients/client-batch/commands/UntagResourceCommand.ts +++ b/clients/client-batch/commands/UntagResourceCommand.ts @@ -22,6 +22,20 @@ export interface UntagResourceCommandOutput extends UntagResourceResponse, __Met /** *

Deletes specified tags from an AWS Batch resource.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { BatchClient, UntagResourceCommand } from "@aws-sdk/client-batch"; // ES Modules import + * // const { BatchClient, UntagResourceCommand } = require("@aws-sdk/client-batch"); // CommonJS import + * const client = new BatchClient(config); + * const command = new UntagResourceCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link UntagResourceCommandInput} for command's `input` shape. + * @see {@link UntagResourceCommandOutput} for command's `response` shape. + * @see {@link BatchClientResolvedConfig | config} for command's `input` shape. + * */ export class UntagResourceCommand extends $Command< UntagResourceCommandInput, diff --git a/clients/client-batch/commands/UpdateComputeEnvironmentCommand.ts b/clients/client-batch/commands/UpdateComputeEnvironmentCommand.ts index 455efa5da74f..0b2fb614899e 100644 --- a/clients/client-batch/commands/UpdateComputeEnvironmentCommand.ts +++ b/clients/client-batch/commands/UpdateComputeEnvironmentCommand.ts @@ -22,6 +22,20 @@ export interface UpdateComputeEnvironmentCommandOutput extends UpdateComputeEnvi /** *

Updates an AWS Batch compute environment.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { BatchClient, UpdateComputeEnvironmentCommand } from "@aws-sdk/client-batch"; // ES Modules import + * // const { BatchClient, UpdateComputeEnvironmentCommand } = require("@aws-sdk/client-batch"); // CommonJS import + * const client = new BatchClient(config); + * const command = new UpdateComputeEnvironmentCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link UpdateComputeEnvironmentCommandInput} for command's `input` shape. + * @see {@link UpdateComputeEnvironmentCommandOutput} for command's `response` shape. + * @see {@link BatchClientResolvedConfig | config} for command's `input` shape. + * */ export class UpdateComputeEnvironmentCommand extends $Command< UpdateComputeEnvironmentCommandInput, diff --git a/clients/client-batch/commands/UpdateJobQueueCommand.ts b/clients/client-batch/commands/UpdateJobQueueCommand.ts index e8804cba640c..2f1ec229cb12 100644 --- a/clients/client-batch/commands/UpdateJobQueueCommand.ts +++ b/clients/client-batch/commands/UpdateJobQueueCommand.ts @@ -22,6 +22,20 @@ export interface UpdateJobQueueCommandOutput extends UpdateJobQueueResponse, __M /** *

Updates a job queue.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { BatchClient, UpdateJobQueueCommand } from "@aws-sdk/client-batch"; // ES Modules import + * // const { BatchClient, UpdateJobQueueCommand } = require("@aws-sdk/client-batch"); // CommonJS import + * const client = new BatchClient(config); + * const command = new UpdateJobQueueCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link UpdateJobQueueCommandInput} for command's `input` shape. + * @see {@link UpdateJobQueueCommandOutput} for command's `response` shape. + * @see {@link BatchClientResolvedConfig | config} for command's `input` shape. + * */ export class UpdateJobQueueCommand extends $Command< UpdateJobQueueCommandInput, diff --git a/clients/client-batch/models/models_0.ts b/clients/client-batch/models/models_0.ts index bfe1e9bf51aa..2c287df4a6bd 100644 --- a/clients/client-batch/models/models_0.ts +++ b/clients/client-batch/models/models_0.ts @@ -17,6 +17,9 @@ export interface ArrayProperties { } export namespace ArrayProperties { + /** + * @internal + */ export const filterSensitiveLog = (obj: ArrayProperties): any => ({ ...obj, }); @@ -45,6 +48,9 @@ export interface ArrayPropertiesDetail { } export namespace ArrayPropertiesDetail { + /** + * @internal + */ export const filterSensitiveLog = (obj: ArrayPropertiesDetail): any => ({ ...obj, }); @@ -67,6 +73,9 @@ export interface ArrayPropertiesSummary { } export namespace ArrayPropertiesSummary { + /** + * @internal + */ export const filterSensitiveLog = (obj: ArrayPropertiesSummary): any => ({ ...obj, }); @@ -98,6 +107,9 @@ export interface NetworkInterface { } export namespace NetworkInterface { + /** + * @internal + */ export const filterSensitiveLog = (obj: NetworkInterface): any => ({ ...obj, }); @@ -143,6 +155,9 @@ export interface AttemptContainerDetail { } export namespace AttemptContainerDetail { + /** + * @internal + */ export const filterSensitiveLog = (obj: AttemptContainerDetail): any => ({ ...obj, }); @@ -176,6 +191,9 @@ export interface AttemptDetail { } export namespace AttemptDetail { + /** + * @internal + */ export const filterSensitiveLog = (obj: AttemptDetail): any => ({ ...obj, }); @@ -199,6 +217,9 @@ export interface CancelJobRequest { } export namespace CancelJobRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: CancelJobRequest): any => ({ ...obj, }); @@ -207,6 +228,9 @@ export namespace CancelJobRequest { export interface CancelJobResponse {} export namespace CancelJobResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: CancelJobResponse): any => ({ ...obj, }); @@ -223,6 +247,9 @@ export interface ClientException extends __SmithyException, $MetadataBearer { } export namespace ClientException { + /** + * @internal + */ export const filterSensitiveLog = (obj: ClientException): any => ({ ...obj, }); @@ -238,6 +265,9 @@ export interface ServerException extends __SmithyException, $MetadataBearer { } export namespace ServerException { + /** + * @internal + */ export const filterSensitiveLog = (obj: ServerException): any => ({ ...obj, }); @@ -299,6 +329,9 @@ export interface Ec2Configuration { } export namespace Ec2Configuration { + /** + * @internal + */ export const filterSensitiveLog = (obj: Ec2Configuration): any => ({ ...obj, }); @@ -341,6 +374,9 @@ export interface LaunchTemplateSpecification { } export namespace LaunchTemplateSpecification { + /** + * @internal + */ export const filterSensitiveLog = (obj: LaunchTemplateSpecification): any => ({ ...obj, }); @@ -592,6 +628,9 @@ export interface ComputeResource { } export namespace ComputeResource { + /** + * @internal + */ export const filterSensitiveLog = (obj: ComputeResource): any => ({ ...obj, }); @@ -677,6 +716,9 @@ export interface CreateComputeEnvironmentRequest { } export namespace CreateComputeEnvironmentRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateComputeEnvironmentRequest): any => ({ ...obj, }); @@ -696,6 +738,9 @@ export interface CreateComputeEnvironmentResponse { } export namespace CreateComputeEnvironmentResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateComputeEnvironmentResponse): any => ({ ...obj, }); @@ -728,6 +773,9 @@ export interface ComputeEnvironmentOrder { } export namespace ComputeEnvironmentOrder { + /** + * @internal + */ export const filterSensitiveLog = (obj: ComputeEnvironmentOrder): any => ({ ...obj, }); @@ -787,6 +835,9 @@ export interface CreateJobQueueRequest { } export namespace CreateJobQueueRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateJobQueueRequest): any => ({ ...obj, }); @@ -805,6 +856,9 @@ export interface CreateJobQueueResponse { } export namespace CreateJobQueueResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateJobQueueResponse): any => ({ ...obj, }); @@ -821,6 +875,9 @@ export interface DeleteComputeEnvironmentRequest { } export namespace DeleteComputeEnvironmentRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteComputeEnvironmentRequest): any => ({ ...obj, }); @@ -829,6 +886,9 @@ export namespace DeleteComputeEnvironmentRequest { export interface DeleteComputeEnvironmentResponse {} export namespace DeleteComputeEnvironmentResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteComputeEnvironmentResponse): any => ({ ...obj, }); @@ -845,6 +905,9 @@ export interface DeleteJobQueueRequest { } export namespace DeleteJobQueueRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteJobQueueRequest): any => ({ ...obj, }); @@ -853,6 +916,9 @@ export namespace DeleteJobQueueRequest { export interface DeleteJobQueueResponse {} export namespace DeleteJobQueueResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteJobQueueResponse): any => ({ ...obj, }); @@ -866,6 +932,9 @@ export interface DeregisterJobDefinitionRequest { } export namespace DeregisterJobDefinitionRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeregisterJobDefinitionRequest): any => ({ ...obj, }); @@ -874,6 +943,9 @@ export namespace DeregisterJobDefinitionRequest { export interface DeregisterJobDefinitionResponse {} export namespace DeregisterJobDefinitionResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeregisterJobDefinitionResponse): any => ({ ...obj, }); @@ -913,6 +985,9 @@ export interface DescribeComputeEnvironmentsRequest { } export namespace DescribeComputeEnvironmentsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeComputeEnvironmentsRequest): any => ({ ...obj, }); @@ -997,6 +1072,9 @@ export interface ComputeEnvironmentDetail { } export namespace ComputeEnvironmentDetail { + /** + * @internal + */ export const filterSensitiveLog = (obj: ComputeEnvironmentDetail): any => ({ ...obj, }); @@ -1018,6 +1096,9 @@ export interface DescribeComputeEnvironmentsResponse { } export namespace DescribeComputeEnvironmentsResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeComputeEnvironmentsResponse): any => ({ ...obj, }); @@ -1067,6 +1148,9 @@ export interface DescribeJobDefinitionsRequest { } export namespace DescribeJobDefinitionsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeJobDefinitionsRequest): any => ({ ...obj, }); @@ -1089,6 +1173,9 @@ export interface KeyValuePair { } export namespace KeyValuePair { + /** + * @internal + */ export const filterSensitiveLog = (obj: KeyValuePair): any => ({ ...obj, }); @@ -1110,6 +1197,9 @@ export interface FargatePlatformConfiguration { } export namespace FargatePlatformConfiguration { + /** + * @internal + */ export const filterSensitiveLog = (obj: FargatePlatformConfiguration): any => ({ ...obj, }); @@ -1147,6 +1237,9 @@ export interface Device { } export namespace Device { + /** + * @internal + */ export const filterSensitiveLog = (obj: Device): any => ({ ...obj, }); @@ -1184,6 +1277,9 @@ export interface Tmpfs { } export namespace Tmpfs { + /** + * @internal + */ export const filterSensitiveLog = (obj: Tmpfs): any => ({ ...obj, }); @@ -1282,6 +1378,9 @@ export interface LinuxParameters { } export namespace LinuxParameters { + /** + * @internal + */ export const filterSensitiveLog = (obj: LinuxParameters): any => ({ ...obj, }); @@ -1332,6 +1431,9 @@ export interface Secret { } export namespace Secret { + /** + * @internal + */ export const filterSensitiveLog = (obj: Secret): any => ({ ...obj, }); @@ -1419,6 +1521,9 @@ export interface LogConfiguration { } export namespace LogConfiguration { + /** + * @internal + */ export const filterSensitiveLog = (obj: LogConfiguration): any => ({ ...obj, }); @@ -1448,6 +1553,9 @@ export interface MountPoint { } export namespace MountPoint { + /** + * @internal + */ export const filterSensitiveLog = (obj: MountPoint): any => ({ ...obj, }); @@ -1468,6 +1576,9 @@ export interface NetworkConfiguration { } export namespace NetworkConfiguration { + /** + * @internal + */ export const filterSensitiveLog = (obj: NetworkConfiguration): any => ({ ...obj, }); @@ -1612,6 +1723,9 @@ export interface ResourceRequirement { } export namespace ResourceRequirement { + /** + * @internal + */ export const filterSensitiveLog = (obj: ResourceRequirement): any => ({ ...obj, }); @@ -1641,6 +1755,9 @@ export interface Ulimit { } export namespace Ulimit { + /** + * @internal + */ export const filterSensitiveLog = (obj: Ulimit): any => ({ ...obj, }); @@ -1675,6 +1792,9 @@ export interface EFSAuthorizationConfig { } export namespace EFSAuthorizationConfig { + /** + * @internal + */ export const filterSensitiveLog = (obj: EFSAuthorizationConfig): any => ({ ...obj, }); @@ -1730,6 +1850,9 @@ export interface EFSVolumeConfiguration { } export namespace EFSVolumeConfiguration { + /** + * @internal + */ export const filterSensitiveLog = (obj: EFSVolumeConfiguration): any => ({ ...obj, }); @@ -1755,6 +1878,9 @@ export interface Host { } export namespace Host { + /** + * @internal + */ export const filterSensitiveLog = (obj: Host): any => ({ ...obj, }); @@ -1790,6 +1916,9 @@ export interface Volume { } export namespace Volume { + /** + * @internal + */ export const filterSensitiveLog = (obj: Volume): any => ({ ...obj, }); @@ -2019,6 +2148,9 @@ export interface ContainerProperties { } export namespace ContainerProperties { + /** + * @internal + */ export const filterSensitiveLog = (obj: ContainerProperties): any => ({ ...obj, }); @@ -2045,6 +2177,9 @@ export interface NodeRangeProperty { } export namespace NodeRangeProperty { + /** + * @internal + */ export const filterSensitiveLog = (obj: NodeRangeProperty): any => ({ ...obj, }); @@ -2072,6 +2207,9 @@ export interface NodeProperties { } export namespace NodeProperties { + /** + * @internal + */ export const filterSensitiveLog = (obj: NodeProperties): any => ({ ...obj, }); @@ -2124,6 +2262,9 @@ export interface EvaluateOnExit { } export namespace EvaluateOnExit { + /** + * @internal + */ export const filterSensitiveLog = (obj: EvaluateOnExit): any => ({ ...obj, }); @@ -2148,6 +2289,9 @@ export interface RetryStrategy { } export namespace RetryStrategy { + /** + * @internal + */ export const filterSensitiveLog = (obj: RetryStrategy): any => ({ ...obj, }); @@ -2165,6 +2309,9 @@ export interface JobTimeout { } export namespace JobTimeout { + /** + * @internal + */ export const filterSensitiveLog = (obj: JobTimeout): any => ({ ...obj, }); @@ -2255,6 +2402,9 @@ export interface JobDefinition { } export namespace JobDefinition { + /** + * @internal + */ export const filterSensitiveLog = (obj: JobDefinition): any => ({ ...obj, }); @@ -2275,6 +2425,9 @@ export interface DescribeJobDefinitionsResponse { } export namespace DescribeJobDefinitionsResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeJobDefinitionsResponse): any => ({ ...obj, }); @@ -2313,6 +2466,9 @@ export interface DescribeJobQueuesRequest { } export namespace DescribeJobQueuesRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeJobQueuesRequest): any => ({ ...obj, }); @@ -2382,6 +2538,9 @@ export interface JobQueueDetail { } export namespace JobQueueDetail { + /** + * @internal + */ export const filterSensitiveLog = (obj: JobQueueDetail): any => ({ ...obj, }); @@ -2402,6 +2561,9 @@ export interface DescribeJobQueuesResponse { } export namespace DescribeJobQueuesResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeJobQueuesResponse): any => ({ ...obj, }); @@ -2418,6 +2580,9 @@ export interface DescribeJobsRequest { } export namespace DescribeJobsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeJobsRequest): any => ({ ...obj, }); @@ -2625,6 +2790,9 @@ export interface ContainerDetail { } export namespace ContainerDetail { + /** + * @internal + */ export const filterSensitiveLog = (obj: ContainerDetail): any => ({ ...obj, }); @@ -2646,6 +2814,9 @@ export interface JobDependency { } export namespace JobDependency { + /** + * @internal + */ export const filterSensitiveLog = (obj: JobDependency): any => ({ ...obj, }); @@ -2668,6 +2839,9 @@ export interface NodeDetails { } export namespace NodeDetails { + /** + * @internal + */ export const filterSensitiveLog = (obj: NodeDetails): any => ({ ...obj, }); @@ -2817,6 +2991,9 @@ export interface JobDetail { } export namespace JobDetail { + /** + * @internal + */ export const filterSensitiveLog = (obj: JobDetail): any => ({ ...obj, }); @@ -2830,6 +3007,9 @@ export interface DescribeJobsResponse { } export namespace DescribeJobsResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeJobsResponse): any => ({ ...obj, }); @@ -2886,6 +3066,9 @@ export interface ListJobsRequest { } export namespace ListJobsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListJobsRequest): any => ({ ...obj, }); @@ -2908,6 +3091,9 @@ export interface ContainerSummary { } export namespace ContainerSummary { + /** + * @internal + */ export const filterSensitiveLog = (obj: ContainerSummary): any => ({ ...obj, }); @@ -2935,6 +3121,9 @@ export interface NodePropertiesSummary { } export namespace NodePropertiesSummary { + /** + * @internal + */ export const filterSensitiveLog = (obj: NodePropertiesSummary): any => ({ ...obj, }); @@ -3008,6 +3197,9 @@ export interface JobSummary { } export namespace JobSummary { + /** + * @internal + */ export const filterSensitiveLog = (obj: JobSummary): any => ({ ...obj, }); @@ -3028,6 +3220,9 @@ export interface ListJobsResponse { } export namespace ListJobsResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListJobsResponse): any => ({ ...obj, }); @@ -3042,6 +3237,9 @@ export interface ListTagsForResourceRequest { } export namespace ListTagsForResourceRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListTagsForResourceRequest): any => ({ ...obj, }); @@ -3055,6 +3253,9 @@ export interface ListTagsForResourceResponse { } export namespace ListTagsForResourceResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListTagsForResourceResponse): any => ({ ...obj, }); @@ -3152,6 +3353,9 @@ export interface RegisterJobDefinitionRequest { } export namespace RegisterJobDefinitionRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: RegisterJobDefinitionRequest): any => ({ ...obj, }); @@ -3175,6 +3379,9 @@ export interface RegisterJobDefinitionResponse { } export namespace RegisterJobDefinitionResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: RegisterJobDefinitionResponse): any => ({ ...obj, }); @@ -3251,6 +3458,9 @@ export interface ContainerOverrides { } export namespace ContainerOverrides { + /** + * @internal + */ export const filterSensitiveLog = (obj: ContainerOverrides): any => ({ ...obj, }); @@ -3276,6 +3486,9 @@ export interface NodePropertyOverride { } export namespace NodePropertyOverride { + /** + * @internal + */ export const filterSensitiveLog = (obj: NodePropertyOverride): any => ({ ...obj, }); @@ -3317,6 +3530,9 @@ export interface NodeOverrides { } export namespace NodeOverrides { + /** + * @internal + */ export const filterSensitiveLog = (obj: NodeOverrides): any => ({ ...obj, }); @@ -3420,6 +3636,9 @@ export interface SubmitJobRequest { } export namespace SubmitJobRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: SubmitJobRequest): any => ({ ...obj, }); @@ -3443,6 +3662,9 @@ export interface SubmitJobResponse { } export namespace SubmitJobResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: SubmitJobResponse): any => ({ ...obj, }); @@ -3464,6 +3686,9 @@ export interface TagResourceRequest { } export namespace TagResourceRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: TagResourceRequest): any => ({ ...obj, }); @@ -3472,6 +3697,9 @@ export namespace TagResourceRequest { export interface TagResourceResponse {} export namespace TagResourceResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: TagResourceResponse): any => ({ ...obj, }); @@ -3495,6 +3723,9 @@ export interface TerminateJobRequest { } export namespace TerminateJobRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: TerminateJobRequest): any => ({ ...obj, }); @@ -3503,6 +3734,9 @@ export namespace TerminateJobRequest { export interface TerminateJobResponse {} export namespace TerminateJobResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: TerminateJobResponse): any => ({ ...obj, }); @@ -3522,6 +3756,9 @@ export interface UntagResourceRequest { } export namespace UntagResourceRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: UntagResourceRequest): any => ({ ...obj, }); @@ -3530,6 +3767,9 @@ export namespace UntagResourceRequest { export interface UntagResourceResponse {} export namespace UntagResourceResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: UntagResourceResponse): any => ({ ...obj, }); @@ -3586,6 +3826,9 @@ export interface ComputeResourceUpdate { } export namespace ComputeResourceUpdate { + /** + * @internal + */ export const filterSensitiveLog = (obj: ComputeResourceUpdate): any => ({ ...obj, }); @@ -3642,6 +3885,9 @@ export interface UpdateComputeEnvironmentRequest { } export namespace UpdateComputeEnvironmentRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateComputeEnvironmentRequest): any => ({ ...obj, }); @@ -3661,6 +3907,9 @@ export interface UpdateComputeEnvironmentResponse { } export namespace UpdateComputeEnvironmentResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateComputeEnvironmentResponse): any => ({ ...obj, }); @@ -3707,6 +3956,9 @@ export interface UpdateJobQueueRequest { } export namespace UpdateJobQueueRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateJobQueueRequest): any => ({ ...obj, }); @@ -3725,6 +3977,9 @@ export interface UpdateJobQueueResponse { } export namespace UpdateJobQueueResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateJobQueueResponse): any => ({ ...obj, }); diff --git a/clients/client-braket/commands/CancelQuantumTaskCommand.ts b/clients/client-braket/commands/CancelQuantumTaskCommand.ts index c1ab0f5d2283..5add191be385 100644 --- a/clients/client-braket/commands/CancelQuantumTaskCommand.ts +++ b/clients/client-braket/commands/CancelQuantumTaskCommand.ts @@ -22,6 +22,20 @@ export interface CancelQuantumTaskCommandOutput extends CancelQuantumTaskRespons /** *

Cancels the specified task.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { BraketClient, CancelQuantumTaskCommand } from "@aws-sdk/client-braket"; // ES Modules import + * // const { BraketClient, CancelQuantumTaskCommand } = require("@aws-sdk/client-braket"); // CommonJS import + * const client = new BraketClient(config); + * const command = new CancelQuantumTaskCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CancelQuantumTaskCommandInput} for command's `input` shape. + * @see {@link CancelQuantumTaskCommandOutput} for command's `response` shape. + * @see {@link BraketClientResolvedConfig | config} for command's `input` shape. + * */ export class CancelQuantumTaskCommand extends $Command< CancelQuantumTaskCommandInput, diff --git a/clients/client-braket/commands/CreateQuantumTaskCommand.ts b/clients/client-braket/commands/CreateQuantumTaskCommand.ts index 9a5483d4846d..2348115cea83 100644 --- a/clients/client-braket/commands/CreateQuantumTaskCommand.ts +++ b/clients/client-braket/commands/CreateQuantumTaskCommand.ts @@ -22,6 +22,20 @@ export interface CreateQuantumTaskCommandOutput extends CreateQuantumTaskRespons /** *

Creates a quantum task.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { BraketClient, CreateQuantumTaskCommand } from "@aws-sdk/client-braket"; // ES Modules import + * // const { BraketClient, CreateQuantumTaskCommand } = require("@aws-sdk/client-braket"); // CommonJS import + * const client = new BraketClient(config); + * const command = new CreateQuantumTaskCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreateQuantumTaskCommandInput} for command's `input` shape. + * @see {@link CreateQuantumTaskCommandOutput} for command's `response` shape. + * @see {@link BraketClientResolvedConfig | config} for command's `input` shape. + * */ export class CreateQuantumTaskCommand extends $Command< CreateQuantumTaskCommandInput, diff --git a/clients/client-braket/commands/GetDeviceCommand.ts b/clients/client-braket/commands/GetDeviceCommand.ts index 01058d948b40..125b54aed0c9 100644 --- a/clients/client-braket/commands/GetDeviceCommand.ts +++ b/clients/client-braket/commands/GetDeviceCommand.ts @@ -22,6 +22,20 @@ export interface GetDeviceCommandOutput extends GetDeviceResponse, __MetadataBea /** *

Retrieves the devices available in Amazon Braket.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { BraketClient, GetDeviceCommand } from "@aws-sdk/client-braket"; // ES Modules import + * // const { BraketClient, GetDeviceCommand } = require("@aws-sdk/client-braket"); // CommonJS import + * const client = new BraketClient(config); + * const command = new GetDeviceCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetDeviceCommandInput} for command's `input` shape. + * @see {@link GetDeviceCommandOutput} for command's `response` shape. + * @see {@link BraketClientResolvedConfig | config} for command's `input` shape. + * */ export class GetDeviceCommand extends $Command< GetDeviceCommandInput, diff --git a/clients/client-braket/commands/GetQuantumTaskCommand.ts b/clients/client-braket/commands/GetQuantumTaskCommand.ts index dc48ed277dc3..c0bfaa32f5e4 100644 --- a/clients/client-braket/commands/GetQuantumTaskCommand.ts +++ b/clients/client-braket/commands/GetQuantumTaskCommand.ts @@ -22,6 +22,20 @@ export interface GetQuantumTaskCommandOutput extends GetQuantumTaskResponse, __M /** *

Retrieves the specified quantum task.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { BraketClient, GetQuantumTaskCommand } from "@aws-sdk/client-braket"; // ES Modules import + * // const { BraketClient, GetQuantumTaskCommand } = require("@aws-sdk/client-braket"); // CommonJS import + * const client = new BraketClient(config); + * const command = new GetQuantumTaskCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetQuantumTaskCommandInput} for command's `input` shape. + * @see {@link GetQuantumTaskCommandOutput} for command's `response` shape. + * @see {@link BraketClientResolvedConfig | config} for command's `input` shape. + * */ export class GetQuantumTaskCommand extends $Command< GetQuantumTaskCommandInput, diff --git a/clients/client-braket/commands/ListTagsForResourceCommand.ts b/clients/client-braket/commands/ListTagsForResourceCommand.ts index 55111ea85b73..3049e1c4fb44 100644 --- a/clients/client-braket/commands/ListTagsForResourceCommand.ts +++ b/clients/client-braket/commands/ListTagsForResourceCommand.ts @@ -22,6 +22,20 @@ export interface ListTagsForResourceCommandOutput extends ListTagsForResourceRes /** *

Shows the tags associated with this resource.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { BraketClient, ListTagsForResourceCommand } from "@aws-sdk/client-braket"; // ES Modules import + * // const { BraketClient, ListTagsForResourceCommand } = require("@aws-sdk/client-braket"); // CommonJS import + * const client = new BraketClient(config); + * const command = new ListTagsForResourceCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListTagsForResourceCommandInput} for command's `input` shape. + * @see {@link ListTagsForResourceCommandOutput} for command's `response` shape. + * @see {@link BraketClientResolvedConfig | config} for command's `input` shape. + * */ export class ListTagsForResourceCommand extends $Command< ListTagsForResourceCommandInput, diff --git a/clients/client-braket/commands/SearchDevicesCommand.ts b/clients/client-braket/commands/SearchDevicesCommand.ts index 2697449548f1..3251aa35f6ce 100644 --- a/clients/client-braket/commands/SearchDevicesCommand.ts +++ b/clients/client-braket/commands/SearchDevicesCommand.ts @@ -22,6 +22,20 @@ export interface SearchDevicesCommandOutput extends SearchDevicesResponse, __Met /** *

Searches for devices using the specified filters.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { BraketClient, SearchDevicesCommand } from "@aws-sdk/client-braket"; // ES Modules import + * // const { BraketClient, SearchDevicesCommand } = require("@aws-sdk/client-braket"); // CommonJS import + * const client = new BraketClient(config); + * const command = new SearchDevicesCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link SearchDevicesCommandInput} for command's `input` shape. + * @see {@link SearchDevicesCommandOutput} for command's `response` shape. + * @see {@link BraketClientResolvedConfig | config} for command's `input` shape. + * */ export class SearchDevicesCommand extends $Command< SearchDevicesCommandInput, diff --git a/clients/client-braket/commands/SearchQuantumTasksCommand.ts b/clients/client-braket/commands/SearchQuantumTasksCommand.ts index be9b7f1869c1..4da409a14b7c 100644 --- a/clients/client-braket/commands/SearchQuantumTasksCommand.ts +++ b/clients/client-braket/commands/SearchQuantumTasksCommand.ts @@ -22,6 +22,20 @@ export interface SearchQuantumTasksCommandOutput extends SearchQuantumTasksRespo /** *

Searches for tasks that match the specified filter values.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { BraketClient, SearchQuantumTasksCommand } from "@aws-sdk/client-braket"; // ES Modules import + * // const { BraketClient, SearchQuantumTasksCommand } = require("@aws-sdk/client-braket"); // CommonJS import + * const client = new BraketClient(config); + * const command = new SearchQuantumTasksCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link SearchQuantumTasksCommandInput} for command's `input` shape. + * @see {@link SearchQuantumTasksCommandOutput} for command's `response` shape. + * @see {@link BraketClientResolvedConfig | config} for command's `input` shape. + * */ export class SearchQuantumTasksCommand extends $Command< SearchQuantumTasksCommandInput, diff --git a/clients/client-braket/commands/TagResourceCommand.ts b/clients/client-braket/commands/TagResourceCommand.ts index 91958bceb2aa..a6d40aae92dd 100644 --- a/clients/client-braket/commands/TagResourceCommand.ts +++ b/clients/client-braket/commands/TagResourceCommand.ts @@ -22,6 +22,20 @@ export interface TagResourceCommandOutput extends TagResourceResponse, __Metadat /** *

Add a tag to the specified resource.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { BraketClient, TagResourceCommand } from "@aws-sdk/client-braket"; // ES Modules import + * // const { BraketClient, TagResourceCommand } = require("@aws-sdk/client-braket"); // CommonJS import + * const client = new BraketClient(config); + * const command = new TagResourceCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link TagResourceCommandInput} for command's `input` shape. + * @see {@link TagResourceCommandOutput} for command's `response` shape. + * @see {@link BraketClientResolvedConfig | config} for command's `input` shape. + * */ export class TagResourceCommand extends $Command< TagResourceCommandInput, diff --git a/clients/client-braket/commands/UntagResourceCommand.ts b/clients/client-braket/commands/UntagResourceCommand.ts index 8258a021e842..77caa24dcb92 100644 --- a/clients/client-braket/commands/UntagResourceCommand.ts +++ b/clients/client-braket/commands/UntagResourceCommand.ts @@ -22,6 +22,20 @@ export interface UntagResourceCommandOutput extends UntagResourceResponse, __Met /** *

Remove tags from a resource.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { BraketClient, UntagResourceCommand } from "@aws-sdk/client-braket"; // ES Modules import + * // const { BraketClient, UntagResourceCommand } = require("@aws-sdk/client-braket"); // CommonJS import + * const client = new BraketClient(config); + * const command = new UntagResourceCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link UntagResourceCommandInput} for command's `input` shape. + * @see {@link UntagResourceCommandOutput} for command's `response` shape. + * @see {@link BraketClientResolvedConfig | config} for command's `input` shape. + * */ export class UntagResourceCommand extends $Command< UntagResourceCommandInput, diff --git a/clients/client-braket/models/models_0.ts b/clients/client-braket/models/models_0.ts index 40085a247a62..30104242cf0c 100644 --- a/clients/client-braket/models/models_0.ts +++ b/clients/client-braket/models/models_0.ts @@ -11,6 +11,9 @@ export interface AccessDeniedException extends __SmithyException, $MetadataBeare } export namespace AccessDeniedException { + /** + * @internal + */ export const filterSensitiveLog = (obj: AccessDeniedException): any => ({ ...obj, }); @@ -24,6 +27,9 @@ export interface GetDeviceRequest { } export namespace GetDeviceRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetDeviceRequest): any => ({ ...obj, }); @@ -72,6 +78,9 @@ export interface GetDeviceResponse { } export namespace GetDeviceResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetDeviceResponse): any => ({ ...obj, }); @@ -87,6 +96,9 @@ export interface InternalServiceException extends __SmithyException, $MetadataBe } export namespace InternalServiceException { + /** + * @internal + */ export const filterSensitiveLog = (obj: InternalServiceException): any => ({ ...obj, }); @@ -102,6 +114,9 @@ export interface ResourceNotFoundException extends __SmithyException, $MetadataB } export namespace ResourceNotFoundException { + /** + * @internal + */ export const filterSensitiveLog = (obj: ResourceNotFoundException): any => ({ ...obj, }); @@ -117,6 +132,9 @@ export interface ThrottlingException extends __SmithyException, $MetadataBearer } export namespace ThrottlingException { + /** + * @internal + */ export const filterSensitiveLog = (obj: ThrottlingException): any => ({ ...obj, }); @@ -132,6 +150,9 @@ export interface ValidationException extends __SmithyException, $MetadataBearer } export namespace ValidationException { + /** + * @internal + */ export const filterSensitiveLog = (obj: ValidationException): any => ({ ...obj, }); @@ -153,6 +174,9 @@ export interface SearchDevicesFilter { } export namespace SearchDevicesFilter { + /** + * @internal + */ export const filterSensitiveLog = (obj: SearchDevicesFilter): any => ({ ...obj, }); @@ -176,6 +200,9 @@ export interface SearchDevicesRequest { } export namespace SearchDevicesRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: SearchDevicesRequest): any => ({ ...obj, }); @@ -212,6 +239,9 @@ export interface DeviceSummary { } export namespace DeviceSummary { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeviceSummary): any => ({ ...obj, }); @@ -230,6 +260,9 @@ export interface SearchDevicesResponse { } export namespace SearchDevicesResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: SearchDevicesResponse): any => ({ ...obj, }); @@ -243,6 +276,9 @@ export interface ListTagsForResourceRequest { } export namespace ListTagsForResourceRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListTagsForResourceRequest): any => ({ ...obj, }); @@ -256,6 +292,9 @@ export interface ListTagsForResourceResponse { } export namespace ListTagsForResourceResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListTagsForResourceResponse): any => ({ ...obj, }); @@ -274,6 +313,9 @@ export interface CancelQuantumTaskRequest { } export namespace CancelQuantumTaskRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: CancelQuantumTaskRequest): any => ({ ...obj, }); @@ -297,6 +339,9 @@ export interface CancelQuantumTaskResponse { } export namespace CancelQuantumTaskResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: CancelQuantumTaskResponse): any => ({ ...obj, }); @@ -312,6 +357,9 @@ export interface ConflictException extends __SmithyException, $MetadataBearer { } export namespace ConflictException { + /** + * @internal + */ export const filterSensitiveLog = (obj: ConflictException): any => ({ ...obj, }); @@ -360,6 +408,9 @@ export interface CreateQuantumTaskRequest { } export namespace CreateQuantumTaskRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateQuantumTaskRequest): any => ({ ...obj, }); @@ -373,6 +424,9 @@ export interface CreateQuantumTaskResponse { } export namespace CreateQuantumTaskResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateQuantumTaskResponse): any => ({ ...obj, }); @@ -388,6 +442,9 @@ export interface DeviceOfflineException extends __SmithyException, $MetadataBear } export namespace DeviceOfflineException { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeviceOfflineException): any => ({ ...obj, }); @@ -403,6 +460,9 @@ export interface ServiceQuotaExceededException extends __SmithyException, $Metad } export namespace ServiceQuotaExceededException { + /** + * @internal + */ export const filterSensitiveLog = (obj: ServiceQuotaExceededException): any => ({ ...obj, }); @@ -416,6 +476,9 @@ export interface GetQuantumTaskRequest { } export namespace GetQuantumTaskRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetQuantumTaskRequest): any => ({ ...obj, }); @@ -489,6 +552,9 @@ export interface GetQuantumTaskResponse { } export namespace GetQuantumTaskResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetQuantumTaskResponse): any => ({ ...obj, }); @@ -524,6 +590,9 @@ export interface SearchQuantumTasksFilter { } export namespace SearchQuantumTasksFilter { + /** + * @internal + */ export const filterSensitiveLog = (obj: SearchQuantumTasksFilter): any => ({ ...obj, }); @@ -547,6 +616,9 @@ export interface SearchQuantumTasksRequest { } export namespace SearchQuantumTasksRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: SearchQuantumTasksRequest): any => ({ ...obj, }); @@ -603,6 +675,9 @@ export interface QuantumTaskSummary { } export namespace QuantumTaskSummary { + /** + * @internal + */ export const filterSensitiveLog = (obj: QuantumTaskSummary): any => ({ ...obj, }); @@ -621,6 +696,9 @@ export interface SearchQuantumTasksResponse { } export namespace SearchQuantumTasksResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: SearchQuantumTasksResponse): any => ({ ...obj, }); @@ -639,6 +717,9 @@ export interface TagResourceRequest { } export namespace TagResourceRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: TagResourceRequest): any => ({ ...obj, }); @@ -647,6 +728,9 @@ export namespace TagResourceRequest { export interface TagResourceResponse {} export namespace TagResourceResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: TagResourceResponse): any => ({ ...obj, }); @@ -665,6 +749,9 @@ export interface UntagResourceRequest { } export namespace UntagResourceRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: UntagResourceRequest): any => ({ ...obj, }); @@ -673,6 +760,9 @@ export namespace UntagResourceRequest { export interface UntagResourceResponse {} export namespace UntagResourceResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: UntagResourceResponse): any => ({ ...obj, }); diff --git a/clients/client-budgets/commands/CreateBudgetActionCommand.ts b/clients/client-budgets/commands/CreateBudgetActionCommand.ts index 1270dafeecb7..28cd011c36dc 100644 --- a/clients/client-budgets/commands/CreateBudgetActionCommand.ts +++ b/clients/client-budgets/commands/CreateBudgetActionCommand.ts @@ -24,6 +24,20 @@ export interface CreateBudgetActionCommandOutput extends CreateBudgetActionRespo *

* Creates a budget action. *

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { BudgetsClient, CreateBudgetActionCommand } from "@aws-sdk/client-budgets"; // ES Modules import + * // const { BudgetsClient, CreateBudgetActionCommand } = require("@aws-sdk/client-budgets"); // CommonJS import + * const client = new BudgetsClient(config); + * const command = new CreateBudgetActionCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreateBudgetActionCommandInput} for command's `input` shape. + * @see {@link CreateBudgetActionCommandOutput} for command's `response` shape. + * @see {@link BudgetsClientResolvedConfig | config} for command's `input` shape. + * */ export class CreateBudgetActionCommand extends $Command< CreateBudgetActionCommandInput, diff --git a/clients/client-budgets/commands/CreateBudgetCommand.ts b/clients/client-budgets/commands/CreateBudgetCommand.ts index e4245a5e06b7..c58d0b0c26f8 100644 --- a/clients/client-budgets/commands/CreateBudgetCommand.ts +++ b/clients/client-budgets/commands/CreateBudgetCommand.ts @@ -25,6 +25,20 @@ export interface CreateBudgetCommandOutput extends CreateBudgetResponse, __Metad * *

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.

* + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { BudgetsClient, CreateBudgetCommand } from "@aws-sdk/client-budgets"; // ES Modules import + * // const { BudgetsClient, CreateBudgetCommand } = require("@aws-sdk/client-budgets"); // CommonJS import + * const client = new BudgetsClient(config); + * const command = new CreateBudgetCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreateBudgetCommandInput} for command's `input` shape. + * @see {@link CreateBudgetCommandOutput} for command's `response` shape. + * @see {@link BudgetsClientResolvedConfig | config} for command's `input` shape. + * */ export class CreateBudgetCommand extends $Command< CreateBudgetCommandInput, diff --git a/clients/client-budgets/commands/CreateNotificationCommand.ts b/clients/client-budgets/commands/CreateNotificationCommand.ts index 6ba146293af7..f110a87471be 100644 --- a/clients/client-budgets/commands/CreateNotificationCommand.ts +++ b/clients/client-budgets/commands/CreateNotificationCommand.ts @@ -22,6 +22,20 @@ export interface CreateNotificationCommandOutput extends CreateNotificationRespo /** *

Creates a notification. You must create the budget before you create the associated notification.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { BudgetsClient, CreateNotificationCommand } from "@aws-sdk/client-budgets"; // ES Modules import + * // const { BudgetsClient, CreateNotificationCommand } = require("@aws-sdk/client-budgets"); // CommonJS import + * const client = new BudgetsClient(config); + * const command = new CreateNotificationCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreateNotificationCommandInput} for command's `input` shape. + * @see {@link CreateNotificationCommandOutput} for command's `response` shape. + * @see {@link BudgetsClientResolvedConfig | config} for command's `input` shape. + * */ export class CreateNotificationCommand extends $Command< CreateNotificationCommandInput, diff --git a/clients/client-budgets/commands/CreateSubscriberCommand.ts b/clients/client-budgets/commands/CreateSubscriberCommand.ts index 821b9b4769c9..4f4b1d903661 100644 --- a/clients/client-budgets/commands/CreateSubscriberCommand.ts +++ b/clients/client-budgets/commands/CreateSubscriberCommand.ts @@ -22,6 +22,20 @@ export interface CreateSubscriberCommandOutput extends CreateSubscriberResponse, /** *

Creates a subscriber. You must create the associated budget and notification before you create the subscriber.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { BudgetsClient, CreateSubscriberCommand } from "@aws-sdk/client-budgets"; // ES Modules import + * // const { BudgetsClient, CreateSubscriberCommand } = require("@aws-sdk/client-budgets"); // CommonJS import + * const client = new BudgetsClient(config); + * const command = new CreateSubscriberCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreateSubscriberCommandInput} for command's `input` shape. + * @see {@link CreateSubscriberCommandOutput} for command's `response` shape. + * @see {@link BudgetsClientResolvedConfig | config} for command's `input` shape. + * */ export class CreateSubscriberCommand extends $Command< CreateSubscriberCommandInput, diff --git a/clients/client-budgets/commands/DeleteBudgetActionCommand.ts b/clients/client-budgets/commands/DeleteBudgetActionCommand.ts index 7a4d26a940c6..4c1995b39a76 100644 --- a/clients/client-budgets/commands/DeleteBudgetActionCommand.ts +++ b/clients/client-budgets/commands/DeleteBudgetActionCommand.ts @@ -24,6 +24,20 @@ export interface DeleteBudgetActionCommandOutput extends DeleteBudgetActionRespo *

* Deletes a budget action. *

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { BudgetsClient, DeleteBudgetActionCommand } from "@aws-sdk/client-budgets"; // ES Modules import + * // const { BudgetsClient, DeleteBudgetActionCommand } = require("@aws-sdk/client-budgets"); // CommonJS import + * const client = new BudgetsClient(config); + * const command = new DeleteBudgetActionCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteBudgetActionCommandInput} for command's `input` shape. + * @see {@link DeleteBudgetActionCommandOutput} for command's `response` shape. + * @see {@link BudgetsClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteBudgetActionCommand extends $Command< DeleteBudgetActionCommandInput, diff --git a/clients/client-budgets/commands/DeleteBudgetCommand.ts b/clients/client-budgets/commands/DeleteBudgetCommand.ts index 162107c27e62..e883540eadc6 100644 --- a/clients/client-budgets/commands/DeleteBudgetCommand.ts +++ b/clients/client-budgets/commands/DeleteBudgetCommand.ts @@ -25,6 +25,20 @@ export interface DeleteBudgetCommandOutput extends DeleteBudgetResponse, __Metad * *

Deleting a budget also deletes the notifications and subscribers that are associated with that budget.

* + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { BudgetsClient, DeleteBudgetCommand } from "@aws-sdk/client-budgets"; // ES Modules import + * // const { BudgetsClient, DeleteBudgetCommand } = require("@aws-sdk/client-budgets"); // CommonJS import + * const client = new BudgetsClient(config); + * const command = new DeleteBudgetCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteBudgetCommandInput} for command's `input` shape. + * @see {@link DeleteBudgetCommandOutput} for command's `response` shape. + * @see {@link BudgetsClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteBudgetCommand extends $Command< DeleteBudgetCommandInput, diff --git a/clients/client-budgets/commands/DeleteNotificationCommand.ts b/clients/client-budgets/commands/DeleteNotificationCommand.ts index c84849edb768..9b19bf96e8ec 100644 --- a/clients/client-budgets/commands/DeleteNotificationCommand.ts +++ b/clients/client-budgets/commands/DeleteNotificationCommand.ts @@ -25,6 +25,20 @@ export interface DeleteNotificationCommandOutput extends DeleteNotificationRespo * *

Deleting a notification also deletes the subscribers that are associated with the notification.

* + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { BudgetsClient, DeleteNotificationCommand } from "@aws-sdk/client-budgets"; // ES Modules import + * // const { BudgetsClient, DeleteNotificationCommand } = require("@aws-sdk/client-budgets"); // CommonJS import + * const client = new BudgetsClient(config); + * const command = new DeleteNotificationCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteNotificationCommandInput} for command's `input` shape. + * @see {@link DeleteNotificationCommandOutput} for command's `response` shape. + * @see {@link BudgetsClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteNotificationCommand extends $Command< DeleteNotificationCommandInput, diff --git a/clients/client-budgets/commands/DeleteSubscriberCommand.ts b/clients/client-budgets/commands/DeleteSubscriberCommand.ts index f87f4c865ece..0ef0d356022d 100644 --- a/clients/client-budgets/commands/DeleteSubscriberCommand.ts +++ b/clients/client-budgets/commands/DeleteSubscriberCommand.ts @@ -25,6 +25,20 @@ export interface DeleteSubscriberCommandOutput extends DeleteSubscriberResponse, * *

Deleting the last subscriber to a notification also deletes the notification.

* + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { BudgetsClient, DeleteSubscriberCommand } from "@aws-sdk/client-budgets"; // ES Modules import + * // const { BudgetsClient, DeleteSubscriberCommand } = require("@aws-sdk/client-budgets"); // CommonJS import + * const client = new BudgetsClient(config); + * const command = new DeleteSubscriberCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteSubscriberCommandInput} for command's `input` shape. + * @see {@link DeleteSubscriberCommandOutput} for command's `response` shape. + * @see {@link BudgetsClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteSubscriberCommand extends $Command< DeleteSubscriberCommandInput, diff --git a/clients/client-budgets/commands/DescribeBudgetActionCommand.ts b/clients/client-budgets/commands/DescribeBudgetActionCommand.ts index 7a122daae5c3..87c3b9701f38 100644 --- a/clients/client-budgets/commands/DescribeBudgetActionCommand.ts +++ b/clients/client-budgets/commands/DescribeBudgetActionCommand.ts @@ -24,6 +24,20 @@ export interface DescribeBudgetActionCommandOutput extends DescribeBudgetActionR *

* Describes a budget action detail. *

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { BudgetsClient, DescribeBudgetActionCommand } from "@aws-sdk/client-budgets"; // ES Modules import + * // const { BudgetsClient, DescribeBudgetActionCommand } = require("@aws-sdk/client-budgets"); // CommonJS import + * const client = new BudgetsClient(config); + * const command = new DescribeBudgetActionCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeBudgetActionCommandInput} for command's `input` shape. + * @see {@link DescribeBudgetActionCommandOutput} for command's `response` shape. + * @see {@link BudgetsClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeBudgetActionCommand extends $Command< DescribeBudgetActionCommandInput, diff --git a/clients/client-budgets/commands/DescribeBudgetActionHistoriesCommand.ts b/clients/client-budgets/commands/DescribeBudgetActionHistoriesCommand.ts index f17054233947..1c5388be74d1 100644 --- a/clients/client-budgets/commands/DescribeBudgetActionHistoriesCommand.ts +++ b/clients/client-budgets/commands/DescribeBudgetActionHistoriesCommand.ts @@ -26,6 +26,20 @@ export interface DescribeBudgetActionHistoriesCommandOutput *

* Describes a budget action history detail. *

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { BudgetsClient, DescribeBudgetActionHistoriesCommand } from "@aws-sdk/client-budgets"; // ES Modules import + * // const { BudgetsClient, DescribeBudgetActionHistoriesCommand } = require("@aws-sdk/client-budgets"); // CommonJS import + * const client = new BudgetsClient(config); + * const command = new DescribeBudgetActionHistoriesCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeBudgetActionHistoriesCommandInput} for command's `input` shape. + * @see {@link DescribeBudgetActionHistoriesCommandOutput} for command's `response` shape. + * @see {@link BudgetsClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeBudgetActionHistoriesCommand extends $Command< DescribeBudgetActionHistoriesCommandInput, diff --git a/clients/client-budgets/commands/DescribeBudgetActionsForAccountCommand.ts b/clients/client-budgets/commands/DescribeBudgetActionsForAccountCommand.ts index 3a8f620221e1..43615538cf1a 100644 --- a/clients/client-budgets/commands/DescribeBudgetActionsForAccountCommand.ts +++ b/clients/client-budgets/commands/DescribeBudgetActionsForAccountCommand.ts @@ -26,6 +26,20 @@ export interface DescribeBudgetActionsForAccountCommandOutput *

* Describes all of the budget actions for an account. *

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { BudgetsClient, DescribeBudgetActionsForAccountCommand } from "@aws-sdk/client-budgets"; // ES Modules import + * // const { BudgetsClient, DescribeBudgetActionsForAccountCommand } = require("@aws-sdk/client-budgets"); // CommonJS import + * const client = new BudgetsClient(config); + * const command = new DescribeBudgetActionsForAccountCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeBudgetActionsForAccountCommandInput} for command's `input` shape. + * @see {@link DescribeBudgetActionsForAccountCommandOutput} for command's `response` shape. + * @see {@link BudgetsClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeBudgetActionsForAccountCommand extends $Command< DescribeBudgetActionsForAccountCommandInput, diff --git a/clients/client-budgets/commands/DescribeBudgetActionsForBudgetCommand.ts b/clients/client-budgets/commands/DescribeBudgetActionsForBudgetCommand.ts index 06a485550a39..069b17578c3d 100644 --- a/clients/client-budgets/commands/DescribeBudgetActionsForBudgetCommand.ts +++ b/clients/client-budgets/commands/DescribeBudgetActionsForBudgetCommand.ts @@ -26,6 +26,20 @@ export interface DescribeBudgetActionsForBudgetCommandOutput *

* Describes all of the budget actions for a budget. *

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { BudgetsClient, DescribeBudgetActionsForBudgetCommand } from "@aws-sdk/client-budgets"; // ES Modules import + * // const { BudgetsClient, DescribeBudgetActionsForBudgetCommand } = require("@aws-sdk/client-budgets"); // CommonJS import + * const client = new BudgetsClient(config); + * const command = new DescribeBudgetActionsForBudgetCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeBudgetActionsForBudgetCommandInput} for command's `input` shape. + * @see {@link DescribeBudgetActionsForBudgetCommandOutput} for command's `response` shape. + * @see {@link BudgetsClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeBudgetActionsForBudgetCommand extends $Command< DescribeBudgetActionsForBudgetCommandInput, diff --git a/clients/client-budgets/commands/DescribeBudgetCommand.ts b/clients/client-budgets/commands/DescribeBudgetCommand.ts index eb88c3016c1f..5ec882dc0f35 100644 --- a/clients/client-budgets/commands/DescribeBudgetCommand.ts +++ b/clients/client-budgets/commands/DescribeBudgetCommand.ts @@ -25,6 +25,20 @@ export interface DescribeBudgetCommandOutput extends DescribeBudgetResponse, __M * *

The Request Syntax section shows the BudgetLimit syntax. For PlannedBudgetLimits, see the Examples section.

* + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { BudgetsClient, DescribeBudgetCommand } from "@aws-sdk/client-budgets"; // ES Modules import + * // const { BudgetsClient, DescribeBudgetCommand } = require("@aws-sdk/client-budgets"); // CommonJS import + * const client = new BudgetsClient(config); + * const command = new DescribeBudgetCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeBudgetCommandInput} for command's `input` shape. + * @see {@link DescribeBudgetCommandOutput} for command's `response` shape. + * @see {@link BudgetsClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeBudgetCommand extends $Command< DescribeBudgetCommandInput, diff --git a/clients/client-budgets/commands/DescribeBudgetPerformanceHistoryCommand.ts b/clients/client-budgets/commands/DescribeBudgetPerformanceHistoryCommand.ts index fc71c5e9b7fc..1d0d6f80df2c 100644 --- a/clients/client-budgets/commands/DescribeBudgetPerformanceHistoryCommand.ts +++ b/clients/client-budgets/commands/DescribeBudgetPerformanceHistoryCommand.ts @@ -24,6 +24,20 @@ export interface DescribeBudgetPerformanceHistoryCommandOutput /** *

Describes the history for DAILY, MONTHLY, and QUARTERLY budgets. Budget history isn't available for ANNUAL budgets.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { BudgetsClient, DescribeBudgetPerformanceHistoryCommand } from "@aws-sdk/client-budgets"; // ES Modules import + * // const { BudgetsClient, DescribeBudgetPerformanceHistoryCommand } = require("@aws-sdk/client-budgets"); // CommonJS import + * const client = new BudgetsClient(config); + * const command = new DescribeBudgetPerformanceHistoryCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeBudgetPerformanceHistoryCommandInput} for command's `input` shape. + * @see {@link DescribeBudgetPerformanceHistoryCommandOutput} for command's `response` shape. + * @see {@link BudgetsClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeBudgetPerformanceHistoryCommand extends $Command< DescribeBudgetPerformanceHistoryCommandInput, diff --git a/clients/client-budgets/commands/DescribeBudgetsCommand.ts b/clients/client-budgets/commands/DescribeBudgetsCommand.ts index 0a80daa7cc68..00b6720d86de 100644 --- a/clients/client-budgets/commands/DescribeBudgetsCommand.ts +++ b/clients/client-budgets/commands/DescribeBudgetsCommand.ts @@ -25,6 +25,20 @@ export interface DescribeBudgetsCommandOutput extends DescribeBudgetsResponse, _ * *

The Request Syntax section shows the BudgetLimit syntax. For PlannedBudgetLimits, see the Examples section.

* + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { BudgetsClient, DescribeBudgetsCommand } from "@aws-sdk/client-budgets"; // ES Modules import + * // const { BudgetsClient, DescribeBudgetsCommand } = require("@aws-sdk/client-budgets"); // CommonJS import + * const client = new BudgetsClient(config); + * const command = new DescribeBudgetsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeBudgetsCommandInput} for command's `input` shape. + * @see {@link DescribeBudgetsCommandOutput} for command's `response` shape. + * @see {@link BudgetsClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeBudgetsCommand extends $Command< DescribeBudgetsCommandInput, diff --git a/clients/client-budgets/commands/DescribeNotificationsForBudgetCommand.ts b/clients/client-budgets/commands/DescribeNotificationsForBudgetCommand.ts index f2fbe2f362ed..bdd30d917d79 100644 --- a/clients/client-budgets/commands/DescribeNotificationsForBudgetCommand.ts +++ b/clients/client-budgets/commands/DescribeNotificationsForBudgetCommand.ts @@ -24,6 +24,20 @@ export interface DescribeNotificationsForBudgetCommandOutput /** *

Lists the notifications that are associated with a budget.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { BudgetsClient, DescribeNotificationsForBudgetCommand } from "@aws-sdk/client-budgets"; // ES Modules import + * // const { BudgetsClient, DescribeNotificationsForBudgetCommand } = require("@aws-sdk/client-budgets"); // CommonJS import + * const client = new BudgetsClient(config); + * const command = new DescribeNotificationsForBudgetCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeNotificationsForBudgetCommandInput} for command's `input` shape. + * @see {@link DescribeNotificationsForBudgetCommandOutput} for command's `response` shape. + * @see {@link BudgetsClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeNotificationsForBudgetCommand extends $Command< DescribeNotificationsForBudgetCommandInput, diff --git a/clients/client-budgets/commands/DescribeSubscribersForNotificationCommand.ts b/clients/client-budgets/commands/DescribeSubscribersForNotificationCommand.ts index bb4de5fd36ac..432d876977f5 100644 --- a/clients/client-budgets/commands/DescribeSubscribersForNotificationCommand.ts +++ b/clients/client-budgets/commands/DescribeSubscribersForNotificationCommand.ts @@ -27,6 +27,20 @@ export interface DescribeSubscribersForNotificationCommandOutput /** *

Lists the subscribers that are associated with a notification.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { BudgetsClient, DescribeSubscribersForNotificationCommand } from "@aws-sdk/client-budgets"; // ES Modules import + * // const { BudgetsClient, DescribeSubscribersForNotificationCommand } = require("@aws-sdk/client-budgets"); // CommonJS import + * const client = new BudgetsClient(config); + * const command = new DescribeSubscribersForNotificationCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeSubscribersForNotificationCommandInput} for command's `input` shape. + * @see {@link DescribeSubscribersForNotificationCommandOutput} for command's `response` shape. + * @see {@link BudgetsClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeSubscribersForNotificationCommand extends $Command< DescribeSubscribersForNotificationCommandInput, diff --git a/clients/client-budgets/commands/ExecuteBudgetActionCommand.ts b/clients/client-budgets/commands/ExecuteBudgetActionCommand.ts index 3d61975674cc..8e519d1c320a 100644 --- a/clients/client-budgets/commands/ExecuteBudgetActionCommand.ts +++ b/clients/client-budgets/commands/ExecuteBudgetActionCommand.ts @@ -24,6 +24,20 @@ export interface ExecuteBudgetActionCommandOutput extends ExecuteBudgetActionRes *

* Executes a budget action. *

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { BudgetsClient, ExecuteBudgetActionCommand } from "@aws-sdk/client-budgets"; // ES Modules import + * // const { BudgetsClient, ExecuteBudgetActionCommand } = require("@aws-sdk/client-budgets"); // CommonJS import + * const client = new BudgetsClient(config); + * const command = new ExecuteBudgetActionCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ExecuteBudgetActionCommandInput} for command's `input` shape. + * @see {@link ExecuteBudgetActionCommandOutput} for command's `response` shape. + * @see {@link BudgetsClientResolvedConfig | config} for command's `input` shape. + * */ export class ExecuteBudgetActionCommand extends $Command< ExecuteBudgetActionCommandInput, diff --git a/clients/client-budgets/commands/UpdateBudgetActionCommand.ts b/clients/client-budgets/commands/UpdateBudgetActionCommand.ts index 8d5b6a4f0447..1ac1432fbb70 100644 --- a/clients/client-budgets/commands/UpdateBudgetActionCommand.ts +++ b/clients/client-budgets/commands/UpdateBudgetActionCommand.ts @@ -24,6 +24,20 @@ export interface UpdateBudgetActionCommandOutput extends UpdateBudgetActionRespo *

* Updates a budget action. *

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { BudgetsClient, UpdateBudgetActionCommand } from "@aws-sdk/client-budgets"; // ES Modules import + * // const { BudgetsClient, UpdateBudgetActionCommand } = require("@aws-sdk/client-budgets"); // CommonJS import + * const client = new BudgetsClient(config); + * const command = new UpdateBudgetActionCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link UpdateBudgetActionCommandInput} for command's `input` shape. + * @see {@link UpdateBudgetActionCommandOutput} for command's `response` shape. + * @see {@link BudgetsClientResolvedConfig | config} for command's `input` shape. + * */ export class UpdateBudgetActionCommand extends $Command< UpdateBudgetActionCommandInput, diff --git a/clients/client-budgets/commands/UpdateBudgetCommand.ts b/clients/client-budgets/commands/UpdateBudgetCommand.ts index f307050023da..a0b4ba14d07c 100644 --- a/clients/client-budgets/commands/UpdateBudgetCommand.ts +++ b/clients/client-budgets/commands/UpdateBudgetCommand.ts @@ -25,6 +25,20 @@ export interface UpdateBudgetCommandOutput extends UpdateBudgetResponse, __Metad * *

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.

* + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { BudgetsClient, UpdateBudgetCommand } from "@aws-sdk/client-budgets"; // ES Modules import + * // const { BudgetsClient, UpdateBudgetCommand } = require("@aws-sdk/client-budgets"); // CommonJS import + * const client = new BudgetsClient(config); + * const command = new UpdateBudgetCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link UpdateBudgetCommandInput} for command's `input` shape. + * @see {@link UpdateBudgetCommandOutput} for command's `response` shape. + * @see {@link BudgetsClientResolvedConfig | config} for command's `input` shape. + * */ export class UpdateBudgetCommand extends $Command< UpdateBudgetCommandInput, diff --git a/clients/client-budgets/commands/UpdateNotificationCommand.ts b/clients/client-budgets/commands/UpdateNotificationCommand.ts index e80a51e83087..509caf9c0379 100644 --- a/clients/client-budgets/commands/UpdateNotificationCommand.ts +++ b/clients/client-budgets/commands/UpdateNotificationCommand.ts @@ -22,6 +22,20 @@ export interface UpdateNotificationCommandOutput extends UpdateNotificationRespo /** *

Updates a notification.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { BudgetsClient, UpdateNotificationCommand } from "@aws-sdk/client-budgets"; // ES Modules import + * // const { BudgetsClient, UpdateNotificationCommand } = require("@aws-sdk/client-budgets"); // CommonJS import + * const client = new BudgetsClient(config); + * const command = new UpdateNotificationCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link UpdateNotificationCommandInput} for command's `input` shape. + * @see {@link UpdateNotificationCommandOutput} for command's `response` shape. + * @see {@link BudgetsClientResolvedConfig | config} for command's `input` shape. + * */ export class UpdateNotificationCommand extends $Command< UpdateNotificationCommandInput, diff --git a/clients/client-budgets/commands/UpdateSubscriberCommand.ts b/clients/client-budgets/commands/UpdateSubscriberCommand.ts index 610a357a7b00..d29f55aa475b 100644 --- a/clients/client-budgets/commands/UpdateSubscriberCommand.ts +++ b/clients/client-budgets/commands/UpdateSubscriberCommand.ts @@ -22,6 +22,20 @@ export interface UpdateSubscriberCommandOutput extends UpdateSubscriberResponse, /** *

Updates a subscriber.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { BudgetsClient, UpdateSubscriberCommand } from "@aws-sdk/client-budgets"; // ES Modules import + * // const { BudgetsClient, UpdateSubscriberCommand } = require("@aws-sdk/client-budgets"); // CommonJS import + * const client = new BudgetsClient(config); + * const command = new UpdateSubscriberCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link UpdateSubscriberCommandInput} for command's `input` shape. + * @see {@link UpdateSubscriberCommandOutput} for command's `response` shape. + * @see {@link BudgetsClientResolvedConfig | config} for command's `input` shape. + * */ export class UpdateSubscriberCommand extends $Command< UpdateSubscriberCommandInput, diff --git a/clients/client-budgets/models/models_0.ts b/clients/client-budgets/models/models_0.ts index ea03393feb9b..a4d6af0ba66c 100644 --- a/clients/client-budgets/models/models_0.ts +++ b/clients/client-budgets/models/models_0.ts @@ -14,6 +14,9 @@ export interface AccessDeniedException extends __SmithyException, $MetadataBeare } export namespace AccessDeniedException { + /** + * @internal + */ export const filterSensitiveLog = (obj: AccessDeniedException): any => ({ ...obj, }); @@ -42,6 +45,9 @@ export interface ActionThreshold { } export namespace ActionThreshold { + /** + * @internal + */ export const filterSensitiveLog = (obj: ActionThreshold): any => ({ ...obj, }); @@ -94,6 +100,9 @@ export interface IamActionDefinition { } export namespace IamActionDefinition { + /** + * @internal + */ export const filterSensitiveLog = (obj: IamActionDefinition): any => ({ ...obj, }); @@ -121,6 +130,9 @@ export interface ScpActionDefinition { } export namespace ScpActionDefinition { + /** + * @internal + */ export const filterSensitiveLog = (obj: ScpActionDefinition): any => ({ ...obj, }); @@ -160,6 +172,9 @@ export interface SsmActionDefinition { } export namespace SsmActionDefinition { + /** + * @internal + */ export const filterSensitiveLog = (obj: SsmActionDefinition): any => ({ ...obj, }); @@ -194,6 +209,9 @@ export interface Definition { } export namespace Definition { + /** + * @internal + */ export const filterSensitiveLog = (obj: Definition): any => ({ ...obj, }); @@ -250,6 +268,9 @@ export interface Subscriber { } export namespace Subscriber { + /** + * @internal + */ export const filterSensitiveLog = (obj: Subscriber): any => ({ ...obj, ...(obj.Address && { Address: SENSITIVE_STRING }), @@ -328,6 +349,9 @@ export interface Action { } export namespace Action { + /** + * @internal + */ export const filterSensitiveLog = (obj: Action): any => ({ ...obj, ...(obj.Subscribers && { Subscribers: obj.Subscribers.map((item) => Subscriber.filterSensitiveLog(item)) }), @@ -354,6 +378,9 @@ export interface ActionHistoryDetails { } export namespace ActionHistoryDetails { + /** + * @internal + */ export const filterSensitiveLog = (obj: ActionHistoryDetails): any => ({ ...obj, ...(obj.Action && { Action: Action.filterSensitiveLog(obj.Action) }), @@ -402,6 +429,9 @@ export interface ActionHistory { } export namespace ActionHistory { + /** + * @internal + */ export const filterSensitiveLog = (obj: ActionHistory): any => ({ ...obj, ...(obj.ActionHistoryDetails && { @@ -437,6 +467,9 @@ export interface Spend { } export namespace Spend { + /** + * @internal + */ export const filterSensitiveLog = (obj: Spend): any => ({ ...obj, }); @@ -468,6 +501,9 @@ export interface CalculatedSpend { } export namespace CalculatedSpend { + /** + * @internal + */ export const filterSensitiveLog = (obj: CalculatedSpend): any => ({ ...obj, }); @@ -547,6 +583,9 @@ export interface CostTypes { } export namespace CostTypes { + /** + * @internal + */ export const filterSensitiveLog = (obj: CostTypes): any => ({ ...obj, }); @@ -570,6 +609,9 @@ export interface TimePeriod { } export namespace TimePeriod { + /** + * @internal + */ export const filterSensitiveLog = (obj: TimePeriod): any => ({ ...obj, }); @@ -676,6 +718,9 @@ export interface Budget { } export namespace Budget { + /** + * @internal + */ export const filterSensitiveLog = (obj: Budget): any => ({ ...obj, }); @@ -743,6 +788,9 @@ export interface Notification { } export namespace Notification { + /** + * @internal + */ export const filterSensitiveLog = (obj: Notification): any => ({ ...obj, }); @@ -764,6 +812,9 @@ export interface NotificationWithSubscribers { } export namespace NotificationWithSubscribers { + /** + * @internal + */ export const filterSensitiveLog = (obj: NotificationWithSubscribers): any => ({ ...obj, ...(obj.Subscribers && { Subscribers: obj.Subscribers.map((item) => Subscriber.filterSensitiveLog(item)) }), @@ -791,6 +842,9 @@ export interface CreateBudgetRequest { } export namespace CreateBudgetRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateBudgetRequest): any => ({ ...obj, }); @@ -802,6 +856,9 @@ export namespace CreateBudgetRequest { export interface CreateBudgetResponse {} export namespace CreateBudgetResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateBudgetResponse): any => ({ ...obj, }); @@ -820,6 +877,9 @@ export interface CreationLimitExceededException extends __SmithyException, $Meta } export namespace CreationLimitExceededException { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreationLimitExceededException): any => ({ ...obj, }); @@ -838,6 +898,9 @@ export interface DuplicateRecordException extends __SmithyException, $MetadataBe } export namespace DuplicateRecordException { + /** + * @internal + */ export const filterSensitiveLog = (obj: DuplicateRecordException): any => ({ ...obj, }); @@ -856,6 +919,9 @@ export interface InternalErrorException extends __SmithyException, $MetadataBear } export namespace InternalErrorException { + /** + * @internal + */ export const filterSensitiveLog = (obj: InternalErrorException): any => ({ ...obj, }); @@ -874,6 +940,9 @@ export interface InvalidParameterException extends __SmithyException, $MetadataB } export namespace InvalidParameterException { + /** + * @internal + */ export const filterSensitiveLog = (obj: InvalidParameterException): any => ({ ...obj, }); @@ -937,6 +1006,9 @@ export interface CreateBudgetActionRequest { } export namespace CreateBudgetActionRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateBudgetActionRequest): any => ({ ...obj, ...(obj.Subscribers && { Subscribers: obj.Subscribers.map((item) => Subscriber.filterSensitiveLog(item)) }), @@ -963,6 +1035,9 @@ export interface CreateBudgetActionResponse { } export namespace CreateBudgetActionResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateBudgetActionResponse): any => ({ ...obj, }); @@ -981,6 +1056,9 @@ export interface NotFoundException extends __SmithyException, $MetadataBearer { } export namespace NotFoundException { + /** + * @internal + */ export const filterSensitiveLog = (obj: NotFoundException): any => ({ ...obj, }); @@ -1012,6 +1090,9 @@ export interface CreateNotificationRequest { } export namespace CreateNotificationRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateNotificationRequest): any => ({ ...obj, ...(obj.Subscribers && { Subscribers: obj.Subscribers.map((item) => Subscriber.filterSensitiveLog(item)) }), @@ -1024,6 +1105,9 @@ export namespace CreateNotificationRequest { export interface CreateNotificationResponse {} export namespace CreateNotificationResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateNotificationResponse): any => ({ ...obj, }); @@ -1055,6 +1139,9 @@ export interface CreateSubscriberRequest { } export namespace CreateSubscriberRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateSubscriberRequest): any => ({ ...obj, ...(obj.Subscriber && { Subscriber: Subscriber.filterSensitiveLog(obj.Subscriber) }), @@ -1067,6 +1154,9 @@ export namespace CreateSubscriberRequest { export interface CreateSubscriberResponse {} export namespace CreateSubscriberResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateSubscriberResponse): any => ({ ...obj, }); @@ -1088,6 +1178,9 @@ export interface DeleteBudgetRequest { } export namespace DeleteBudgetRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteBudgetRequest): any => ({ ...obj, }); @@ -1099,6 +1192,9 @@ export namespace DeleteBudgetRequest { export interface DeleteBudgetResponse {} export namespace DeleteBudgetResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteBudgetResponse): any => ({ ...obj, }); @@ -1124,6 +1220,9 @@ export interface DeleteBudgetActionRequest { } export namespace DeleteBudgetActionRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteBudgetActionRequest): any => ({ ...obj, }); @@ -1149,6 +1248,9 @@ export interface DeleteBudgetActionResponse { } export namespace DeleteBudgetActionResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteBudgetActionResponse): any => ({ ...obj, ...(obj.Action && { Action: Action.filterSensitiveLog(obj.Action) }), @@ -1169,6 +1271,9 @@ export interface ResourceLockedException extends __SmithyException, $MetadataBea } export namespace ResourceLockedException { + /** + * @internal + */ export const filterSensitiveLog = (obj: ResourceLockedException): any => ({ ...obj, }); @@ -1195,6 +1300,9 @@ export interface DeleteNotificationRequest { } export namespace DeleteNotificationRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteNotificationRequest): any => ({ ...obj, }); @@ -1206,6 +1314,9 @@ export namespace DeleteNotificationRequest { export interface DeleteNotificationResponse {} export namespace DeleteNotificationResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteNotificationResponse): any => ({ ...obj, }); @@ -1237,6 +1348,9 @@ export interface DeleteSubscriberRequest { } export namespace DeleteSubscriberRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteSubscriberRequest): any => ({ ...obj, ...(obj.Subscriber && { Subscriber: Subscriber.filterSensitiveLog(obj.Subscriber) }), @@ -1249,6 +1363,9 @@ export namespace DeleteSubscriberRequest { export interface DeleteSubscriberResponse {} export namespace DeleteSubscriberResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteSubscriberResponse): any => ({ ...obj, }); @@ -1270,6 +1387,9 @@ export interface DescribeBudgetRequest { } export namespace DescribeBudgetRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeBudgetRequest): any => ({ ...obj, }); @@ -1286,6 +1406,9 @@ export interface DescribeBudgetResponse { } export namespace DescribeBudgetResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeBudgetResponse): any => ({ ...obj, }); @@ -1311,6 +1434,9 @@ export interface DescribeBudgetActionRequest { } export namespace DescribeBudgetActionRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeBudgetActionRequest): any => ({ ...obj, }); @@ -1336,6 +1462,9 @@ export interface DescribeBudgetActionResponse { } export namespace DescribeBudgetActionResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeBudgetActionResponse): any => ({ ...obj, ...(obj.Action && { Action: Action.filterSensitiveLog(obj.Action) }), @@ -1377,6 +1506,9 @@ export interface DescribeBudgetActionHistoriesRequest { } export namespace DescribeBudgetActionHistoriesRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeBudgetActionHistoriesRequest): any => ({ ...obj, }); @@ -1397,6 +1529,9 @@ export interface DescribeBudgetActionHistoriesResponse { } export namespace DescribeBudgetActionHistoriesResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeBudgetActionHistoriesResponse): any => ({ ...obj, }); @@ -1415,6 +1550,9 @@ export interface InvalidNextTokenException extends __SmithyException, $MetadataB } export namespace InvalidNextTokenException { + /** + * @internal + */ export const filterSensitiveLog = (obj: InvalidNextTokenException): any => ({ ...obj, }); @@ -1438,6 +1576,9 @@ export interface DescribeBudgetActionsForAccountRequest { } export namespace DescribeBudgetActionsForAccountRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeBudgetActionsForAccountRequest): any => ({ ...obj, }); @@ -1458,6 +1599,9 @@ export interface DescribeBudgetActionsForAccountResponse { } export namespace DescribeBudgetActionsForAccountResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeBudgetActionsForAccountResponse): any => ({ ...obj, }); @@ -1486,6 +1630,9 @@ export interface DescribeBudgetActionsForBudgetRequest { } export namespace DescribeBudgetActionsForBudgetRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeBudgetActionsForBudgetRequest): any => ({ ...obj, }); @@ -1506,6 +1653,9 @@ export interface DescribeBudgetActionsForBudgetResponse { } export namespace DescribeBudgetActionsForBudgetResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeBudgetActionsForBudgetResponse): any => ({ ...obj, }); @@ -1539,6 +1689,9 @@ export interface DescribeBudgetPerformanceHistoryRequest { } export namespace DescribeBudgetPerformanceHistoryRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeBudgetPerformanceHistoryRequest): any => ({ ...obj, }); @@ -1565,6 +1718,9 @@ export interface BudgetedAndActualAmounts { } export namespace BudgetedAndActualAmounts { + /** + * @internal + */ export const filterSensitiveLog = (obj: BudgetedAndActualAmounts): any => ({ ...obj, }); @@ -1608,6 +1764,9 @@ export interface BudgetPerformanceHistory { } export namespace BudgetPerformanceHistory { + /** + * @internal + */ export const filterSensitiveLog = (obj: BudgetPerformanceHistory): any => ({ ...obj, }); @@ -1627,6 +1786,9 @@ export interface DescribeBudgetPerformanceHistoryResponse { } export namespace DescribeBudgetPerformanceHistoryResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeBudgetPerformanceHistoryResponse): any => ({ ...obj, }); @@ -1645,6 +1807,9 @@ export interface ExpiredNextTokenException extends __SmithyException, $MetadataB } export namespace ExpiredNextTokenException { + /** + * @internal + */ export const filterSensitiveLog = (obj: ExpiredNextTokenException): any => ({ ...obj, }); @@ -1671,6 +1836,9 @@ export interface DescribeBudgetsRequest { } export namespace DescribeBudgetsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeBudgetsRequest): any => ({ ...obj, }); @@ -1692,6 +1860,9 @@ export interface DescribeBudgetsResponse { } export namespace DescribeBudgetsResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeBudgetsResponse): any => ({ ...obj, }); @@ -1723,6 +1894,9 @@ export interface DescribeNotificationsForBudgetRequest { } export namespace DescribeNotificationsForBudgetRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeNotificationsForBudgetRequest): any => ({ ...obj, }); @@ -1744,6 +1918,9 @@ export interface DescribeNotificationsForBudgetResponse { } export namespace DescribeNotificationsForBudgetResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeNotificationsForBudgetResponse): any => ({ ...obj, }); @@ -1780,6 +1957,9 @@ export interface DescribeSubscribersForNotificationRequest { } export namespace DescribeSubscribersForNotificationRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeSubscribersForNotificationRequest): any => ({ ...obj, }); @@ -1801,6 +1981,9 @@ export interface DescribeSubscribersForNotificationResponse { } export namespace DescribeSubscribersForNotificationResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeSubscribersForNotificationResponse): any => ({ ...obj, ...(obj.Subscribers && { Subscribers: obj.Subscribers.map((item) => Subscriber.filterSensitiveLog(item)) }), @@ -1841,6 +2024,9 @@ export interface ExecuteBudgetActionRequest { } export namespace ExecuteBudgetActionRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ExecuteBudgetActionRequest): any => ({ ...obj, }); @@ -1873,6 +2059,9 @@ export interface ExecuteBudgetActionResponse { } export namespace ExecuteBudgetActionResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ExecuteBudgetActionResponse): any => ({ ...obj, }); @@ -1894,6 +2083,9 @@ export interface UpdateBudgetRequest { } export namespace UpdateBudgetRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateBudgetRequest): any => ({ ...obj, }); @@ -1905,6 +2097,9 @@ export namespace UpdateBudgetRequest { export interface UpdateBudgetResponse {} export namespace UpdateBudgetResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateBudgetResponse): any => ({ ...obj, }); @@ -1968,6 +2163,9 @@ export interface UpdateBudgetActionRequest { } export namespace UpdateBudgetActionRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateBudgetActionRequest): any => ({ ...obj, ...(obj.Subscribers && { Subscribers: obj.Subscribers.map((item) => Subscriber.filterSensitiveLog(item)) }), @@ -2001,6 +2199,9 @@ export interface UpdateBudgetActionResponse { } export namespace UpdateBudgetActionResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateBudgetActionResponse): any => ({ ...obj, ...(obj.OldAction && { OldAction: Action.filterSensitiveLog(obj.OldAction) }), @@ -2034,6 +2235,9 @@ export interface UpdateNotificationRequest { } export namespace UpdateNotificationRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateNotificationRequest): any => ({ ...obj, }); @@ -2045,6 +2249,9 @@ export namespace UpdateNotificationRequest { export interface UpdateNotificationResponse {} export namespace UpdateNotificationResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateNotificationResponse): any => ({ ...obj, }); @@ -2081,6 +2288,9 @@ export interface UpdateSubscriberRequest { } export namespace UpdateSubscriberRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateSubscriberRequest): any => ({ ...obj, ...(obj.OldSubscriber && { OldSubscriber: Subscriber.filterSensitiveLog(obj.OldSubscriber) }), @@ -2094,6 +2304,9 @@ export namespace UpdateSubscriberRequest { export interface UpdateSubscriberResponse {} export namespace UpdateSubscriberResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateSubscriberResponse): any => ({ ...obj, }); diff --git a/clients/client-chime/commands/AssociatePhoneNumberWithUserCommand.ts b/clients/client-chime/commands/AssociatePhoneNumberWithUserCommand.ts index 92c46e4c545d..bd386dc1d361 100644 --- a/clients/client-chime/commands/AssociatePhoneNumberWithUserCommand.ts +++ b/clients/client-chime/commands/AssociatePhoneNumberWithUserCommand.ts @@ -24,6 +24,20 @@ export interface AssociatePhoneNumberWithUserCommandOutput /** *

Associates a phone number with the specified Amazon Chime user.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ChimeClient, AssociatePhoneNumberWithUserCommand } from "@aws-sdk/client-chime"; // ES Modules import + * // const { ChimeClient, AssociatePhoneNumberWithUserCommand } = require("@aws-sdk/client-chime"); // CommonJS import + * const client = new ChimeClient(config); + * const command = new AssociatePhoneNumberWithUserCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link AssociatePhoneNumberWithUserCommandInput} for command's `input` shape. + * @see {@link AssociatePhoneNumberWithUserCommandOutput} for command's `response` shape. + * @see {@link ChimeClientResolvedConfig | config} for command's `input` shape. + * */ export class AssociatePhoneNumberWithUserCommand extends $Command< AssociatePhoneNumberWithUserCommandInput, diff --git a/clients/client-chime/commands/AssociatePhoneNumbersWithVoiceConnectorCommand.ts b/clients/client-chime/commands/AssociatePhoneNumbersWithVoiceConnectorCommand.ts index a15703814cfc..70495b4ba81e 100644 --- a/clients/client-chime/commands/AssociatePhoneNumbersWithVoiceConnectorCommand.ts +++ b/clients/client-chime/commands/AssociatePhoneNumbersWithVoiceConnectorCommand.ts @@ -28,6 +28,20 @@ export interface AssociatePhoneNumbersWithVoiceConnectorCommandOutput /** *

Associates phone numbers with the specified Amazon Chime Voice Connector.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ChimeClient, AssociatePhoneNumbersWithVoiceConnectorCommand } from "@aws-sdk/client-chime"; // ES Modules import + * // const { ChimeClient, AssociatePhoneNumbersWithVoiceConnectorCommand } = require("@aws-sdk/client-chime"); // CommonJS import + * const client = new ChimeClient(config); + * const command = new AssociatePhoneNumbersWithVoiceConnectorCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link AssociatePhoneNumbersWithVoiceConnectorCommandInput} for command's `input` shape. + * @see {@link AssociatePhoneNumbersWithVoiceConnectorCommandOutput} for command's `response` shape. + * @see {@link ChimeClientResolvedConfig | config} for command's `input` shape. + * */ export class AssociatePhoneNumbersWithVoiceConnectorCommand extends $Command< AssociatePhoneNumbersWithVoiceConnectorCommandInput, diff --git a/clients/client-chime/commands/AssociatePhoneNumbersWithVoiceConnectorGroupCommand.ts b/clients/client-chime/commands/AssociatePhoneNumbersWithVoiceConnectorGroupCommand.ts index 0bf56ad35c98..d3661d01ef69 100644 --- a/clients/client-chime/commands/AssociatePhoneNumbersWithVoiceConnectorGroupCommand.ts +++ b/clients/client-chime/commands/AssociatePhoneNumbersWithVoiceConnectorGroupCommand.ts @@ -28,6 +28,20 @@ export interface AssociatePhoneNumbersWithVoiceConnectorGroupCommandOutput /** *

Associates phone numbers with the specified Amazon Chime Voice Connector group.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ChimeClient, AssociatePhoneNumbersWithVoiceConnectorGroupCommand } from "@aws-sdk/client-chime"; // ES Modules import + * // const { ChimeClient, AssociatePhoneNumbersWithVoiceConnectorGroupCommand } = require("@aws-sdk/client-chime"); // CommonJS import + * const client = new ChimeClient(config); + * const command = new AssociatePhoneNumbersWithVoiceConnectorGroupCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link AssociatePhoneNumbersWithVoiceConnectorGroupCommandInput} for command's `input` shape. + * @see {@link AssociatePhoneNumbersWithVoiceConnectorGroupCommandOutput} for command's `response` shape. + * @see {@link ChimeClientResolvedConfig | config} for command's `input` shape. + * */ export class AssociatePhoneNumbersWithVoiceConnectorGroupCommand extends $Command< AssociatePhoneNumbersWithVoiceConnectorGroupCommandInput, diff --git a/clients/client-chime/commands/AssociateSigninDelegateGroupsWithAccountCommand.ts b/clients/client-chime/commands/AssociateSigninDelegateGroupsWithAccountCommand.ts index 4ffb5e91ba45..057582a5f06d 100644 --- a/clients/client-chime/commands/AssociateSigninDelegateGroupsWithAccountCommand.ts +++ b/clients/client-chime/commands/AssociateSigninDelegateGroupsWithAccountCommand.ts @@ -28,6 +28,20 @@ export interface AssociateSigninDelegateGroupsWithAccountCommandOutput /** *

Associates the specified sign-in delegate groups with the specified Amazon Chime account.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ChimeClient, AssociateSigninDelegateGroupsWithAccountCommand } from "@aws-sdk/client-chime"; // ES Modules import + * // const { ChimeClient, AssociateSigninDelegateGroupsWithAccountCommand } = require("@aws-sdk/client-chime"); // CommonJS import + * const client = new ChimeClient(config); + * const command = new AssociateSigninDelegateGroupsWithAccountCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link AssociateSigninDelegateGroupsWithAccountCommandInput} for command's `input` shape. + * @see {@link AssociateSigninDelegateGroupsWithAccountCommandOutput} for command's `response` shape. + * @see {@link ChimeClientResolvedConfig | config} for command's `input` shape. + * */ export class AssociateSigninDelegateGroupsWithAccountCommand extends $Command< AssociateSigninDelegateGroupsWithAccountCommandInput, diff --git a/clients/client-chime/commands/BatchCreateAttendeeCommand.ts b/clients/client-chime/commands/BatchCreateAttendeeCommand.ts index f1a989b7f5a4..8603eab4531a 100644 --- a/clients/client-chime/commands/BatchCreateAttendeeCommand.ts +++ b/clients/client-chime/commands/BatchCreateAttendeeCommand.ts @@ -27,6 +27,20 @@ export interface BatchCreateAttendeeCommandOutput extends BatchCreateAttendeeRes * in the * Amazon Chime Developer Guide. *

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ChimeClient, BatchCreateAttendeeCommand } from "@aws-sdk/client-chime"; // ES Modules import + * // const { ChimeClient, BatchCreateAttendeeCommand } = require("@aws-sdk/client-chime"); // CommonJS import + * const client = new ChimeClient(config); + * const command = new BatchCreateAttendeeCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link BatchCreateAttendeeCommandInput} for command's `input` shape. + * @see {@link BatchCreateAttendeeCommandOutput} for command's `response` shape. + * @see {@link ChimeClientResolvedConfig | config} for command's `input` shape. + * */ export class BatchCreateAttendeeCommand extends $Command< BatchCreateAttendeeCommandInput, diff --git a/clients/client-chime/commands/BatchCreateRoomMembershipCommand.ts b/clients/client-chime/commands/BatchCreateRoomMembershipCommand.ts index 5f6c29bcfec6..163332efccc9 100644 --- a/clients/client-chime/commands/BatchCreateRoomMembershipCommand.ts +++ b/clients/client-chime/commands/BatchCreateRoomMembershipCommand.ts @@ -22,6 +22,20 @@ export interface BatchCreateRoomMembershipCommandOutput extends BatchCreateRoomM /** *

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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ChimeClient, BatchCreateRoomMembershipCommand } from "@aws-sdk/client-chime"; // ES Modules import + * // const { ChimeClient, BatchCreateRoomMembershipCommand } = require("@aws-sdk/client-chime"); // CommonJS import + * const client = new ChimeClient(config); + * const command = new BatchCreateRoomMembershipCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link BatchCreateRoomMembershipCommandInput} for command's `input` shape. + * @see {@link BatchCreateRoomMembershipCommandOutput} for command's `response` shape. + * @see {@link ChimeClientResolvedConfig | config} for command's `input` shape. + * */ export class BatchCreateRoomMembershipCommand extends $Command< BatchCreateRoomMembershipCommandInput, diff --git a/clients/client-chime/commands/BatchDeletePhoneNumberCommand.ts b/clients/client-chime/commands/BatchDeletePhoneNumberCommand.ts index 064b642320b9..48451fefec61 100644 --- a/clients/client-chime/commands/BatchDeletePhoneNumberCommand.ts +++ b/clients/client-chime/commands/BatchDeletePhoneNumberCommand.ts @@ -30,6 +30,20 @@ export interface BatchDeletePhoneNumberCommandOutput extends BatchDeletePhoneNum * Phone numbers remain in the * Deletion queue for 7 days before they are deleted permanently. *

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ChimeClient, BatchDeletePhoneNumberCommand } from "@aws-sdk/client-chime"; // ES Modules import + * // const { ChimeClient, BatchDeletePhoneNumberCommand } = require("@aws-sdk/client-chime"); // CommonJS import + * const client = new ChimeClient(config); + * const command = new BatchDeletePhoneNumberCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link BatchDeletePhoneNumberCommandInput} for command's `input` shape. + * @see {@link BatchDeletePhoneNumberCommandOutput} for command's `response` shape. + * @see {@link ChimeClientResolvedConfig | config} for command's `input` shape. + * */ export class BatchDeletePhoneNumberCommand extends $Command< BatchDeletePhoneNumberCommandInput, diff --git a/clients/client-chime/commands/BatchSuspendUserCommand.ts b/clients/client-chime/commands/BatchSuspendUserCommand.ts index 61510fcf8ac0..cc46ac5fde12 100644 --- a/clients/client-chime/commands/BatchSuspendUserCommand.ts +++ b/clients/client-chime/commands/BatchSuspendUserCommand.ts @@ -40,6 +40,20 @@ export interface BatchSuspendUserCommandOutput extends BatchSuspendUserResponse, * LogoutUser * action. *

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ChimeClient, BatchSuspendUserCommand } from "@aws-sdk/client-chime"; // ES Modules import + * // const { ChimeClient, BatchSuspendUserCommand } = require("@aws-sdk/client-chime"); // CommonJS import + * const client = new ChimeClient(config); + * const command = new BatchSuspendUserCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link BatchSuspendUserCommandInput} for command's `input` shape. + * @see {@link BatchSuspendUserCommandOutput} for command's `response` shape. + * @see {@link ChimeClientResolvedConfig | config} for command's `input` shape. + * */ export class BatchSuspendUserCommand extends $Command< BatchSuspendUserCommandInput, diff --git a/clients/client-chime/commands/BatchUnsuspendUserCommand.ts b/clients/client-chime/commands/BatchUnsuspendUserCommand.ts index 72c5b267f363..8fc52dd5880a 100644 --- a/clients/client-chime/commands/BatchUnsuspendUserCommand.ts +++ b/clients/client-chime/commands/BatchUnsuspendUserCommand.ts @@ -32,6 +32,20 @@ export interface BatchUnsuspendUserCommandOutput extends BatchUnsuspendUserRespo * Registered * status. Users who are not previously suspended are ignored. *

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ChimeClient, BatchUnsuspendUserCommand } from "@aws-sdk/client-chime"; // ES Modules import + * // const { ChimeClient, BatchUnsuspendUserCommand } = require("@aws-sdk/client-chime"); // CommonJS import + * const client = new ChimeClient(config); + * const command = new BatchUnsuspendUserCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link BatchUnsuspendUserCommandInput} for command's `input` shape. + * @see {@link BatchUnsuspendUserCommandOutput} for command's `response` shape. + * @see {@link ChimeClientResolvedConfig | config} for command's `input` shape. + * */ export class BatchUnsuspendUserCommand extends $Command< BatchUnsuspendUserCommandInput, diff --git a/clients/client-chime/commands/BatchUpdatePhoneNumberCommand.ts b/clients/client-chime/commands/BatchUpdatePhoneNumberCommand.ts index 7d9fd73d3ab7..be34e98806d5 100644 --- a/clients/client-chime/commands/BatchUpdatePhoneNumberCommand.ts +++ b/clients/client-chime/commands/BatchUpdatePhoneNumberCommand.ts @@ -30,6 +30,20 @@ export interface BatchUpdatePhoneNumberCommandOutput extends BatchUpdatePhoneNum * For toll-free numbers, you must use the Amazon Chime Voice Connector 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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ChimeClient, BatchUpdatePhoneNumberCommand } from "@aws-sdk/client-chime"; // ES Modules import + * // const { ChimeClient, BatchUpdatePhoneNumberCommand } = require("@aws-sdk/client-chime"); // CommonJS import + * const client = new ChimeClient(config); + * const command = new BatchUpdatePhoneNumberCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link BatchUpdatePhoneNumberCommandInput} for command's `input` shape. + * @see {@link BatchUpdatePhoneNumberCommandOutput} for command's `response` shape. + * @see {@link ChimeClientResolvedConfig | config} for command's `input` shape. + * */ export class BatchUpdatePhoneNumberCommand extends $Command< BatchUpdatePhoneNumberCommandInput, diff --git a/clients/client-chime/commands/BatchUpdateUserCommand.ts b/clients/client-chime/commands/BatchUpdateUserCommand.ts index a52bde37356e..a1fb1b442550 100644 --- a/clients/client-chime/commands/BatchUpdateUserCommand.ts +++ b/clients/client-chime/commands/BatchUpdateUserCommand.ts @@ -28,6 +28,20 @@ export interface BatchUpdateUserCommandOutput extends BatchUpdateUserResponse, _ * Currently, only LicenseType * updates are supported for this action. *

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ChimeClient, BatchUpdateUserCommand } from "@aws-sdk/client-chime"; // ES Modules import + * // const { ChimeClient, BatchUpdateUserCommand } = require("@aws-sdk/client-chime"); // CommonJS import + * const client = new ChimeClient(config); + * const command = new BatchUpdateUserCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link BatchUpdateUserCommandInput} for command's `input` shape. + * @see {@link BatchUpdateUserCommandOutput} for command's `response` shape. + * @see {@link ChimeClientResolvedConfig | config} for command's `input` shape. + * */ export class BatchUpdateUserCommand extends $Command< BatchUpdateUserCommandInput, diff --git a/clients/client-chime/commands/CreateAccountCommand.ts b/clients/client-chime/commands/CreateAccountCommand.ts index 62d87d433a23..86e21853f100 100644 --- a/clients/client-chime/commands/CreateAccountCommand.ts +++ b/clients/client-chime/commands/CreateAccountCommand.ts @@ -25,6 +25,20 @@ export interface CreateAccountCommandOutput extends CreateAccountResponse, __Met * 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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ChimeClient, CreateAccountCommand } from "@aws-sdk/client-chime"; // ES Modules import + * // const { ChimeClient, CreateAccountCommand } = require("@aws-sdk/client-chime"); // CommonJS import + * const client = new ChimeClient(config); + * const command = new CreateAccountCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreateAccountCommandInput} for command's `input` shape. + * @see {@link CreateAccountCommandOutput} for command's `response` shape. + * @see {@link ChimeClientResolvedConfig | config} for command's `input` shape. + * */ export class CreateAccountCommand extends $Command< CreateAccountCommandInput, diff --git a/clients/client-chime/commands/CreateAppInstanceAdminCommand.ts b/clients/client-chime/commands/CreateAppInstanceAdminCommand.ts index 776465625dc5..5784720c51f1 100644 --- a/clients/client-chime/commands/CreateAppInstanceAdminCommand.ts +++ b/clients/client-chime/commands/CreateAppInstanceAdminCommand.ts @@ -36,6 +36,20 @@ export interface CreateAppInstanceAdminCommandOutput extends CreateAppInstanceAd * * *

Only an AppInstanceUser can be promoted to an AppInstanceAdmin role.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ChimeClient, CreateAppInstanceAdminCommand } from "@aws-sdk/client-chime"; // ES Modules import + * // const { ChimeClient, CreateAppInstanceAdminCommand } = require("@aws-sdk/client-chime"); // CommonJS import + * const client = new ChimeClient(config); + * const command = new CreateAppInstanceAdminCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreateAppInstanceAdminCommandInput} for command's `input` shape. + * @see {@link CreateAppInstanceAdminCommandOutput} for command's `response` shape. + * @see {@link ChimeClientResolvedConfig | config} for command's `input` shape. + * */ export class CreateAppInstanceAdminCommand extends $Command< CreateAppInstanceAdminCommandInput, diff --git a/clients/client-chime/commands/CreateAppInstanceCommand.ts b/clients/client-chime/commands/CreateAppInstanceCommand.ts index 36af211da498..dd0c2ff29d37 100644 --- a/clients/client-chime/commands/CreateAppInstanceCommand.ts +++ b/clients/client-chime/commands/CreateAppInstanceCommand.ts @@ -23,6 +23,20 @@ export interface CreateAppInstanceCommandOutput extends CreateAppInstanceRespons /** *

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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ChimeClient, CreateAppInstanceCommand } from "@aws-sdk/client-chime"; // ES Modules import + * // const { ChimeClient, CreateAppInstanceCommand } = require("@aws-sdk/client-chime"); // CommonJS import + * const client = new ChimeClient(config); + * const command = new CreateAppInstanceCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreateAppInstanceCommandInput} for command's `input` shape. + * @see {@link CreateAppInstanceCommandOutput} for command's `response` shape. + * @see {@link ChimeClientResolvedConfig | config} for command's `input` shape. + * */ export class CreateAppInstanceCommand extends $Command< CreateAppInstanceCommandInput, diff --git a/clients/client-chime/commands/CreateAppInstanceUserCommand.ts b/clients/client-chime/commands/CreateAppInstanceUserCommand.ts index df6cfd0d7d58..00b880dbd888 100644 --- a/clients/client-chime/commands/CreateAppInstanceUserCommand.ts +++ b/clients/client-chime/commands/CreateAppInstanceUserCommand.ts @@ -23,6 +23,20 @@ export interface CreateAppInstanceUserCommandOutput extends CreateAppInstanceUse /** *

Creates a user under an Amazon Chime AppInstance. The request consists of a unique appInstanceUserId and * Name for that user.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ChimeClient, CreateAppInstanceUserCommand } from "@aws-sdk/client-chime"; // ES Modules import + * // const { ChimeClient, CreateAppInstanceUserCommand } = require("@aws-sdk/client-chime"); // CommonJS import + * const client = new ChimeClient(config); + * const command = new CreateAppInstanceUserCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreateAppInstanceUserCommandInput} for command's `input` shape. + * @see {@link CreateAppInstanceUserCommandOutput} for command's `response` shape. + * @see {@link ChimeClientResolvedConfig | config} for command's `input` shape. + * */ export class CreateAppInstanceUserCommand extends $Command< CreateAppInstanceUserCommandInput, diff --git a/clients/client-chime/commands/CreateAttendeeCommand.ts b/clients/client-chime/commands/CreateAttendeeCommand.ts index e0b95c0a204e..16ea76f5ecc7 100644 --- a/clients/client-chime/commands/CreateAttendeeCommand.ts +++ b/clients/client-chime/commands/CreateAttendeeCommand.ts @@ -27,6 +27,20 @@ export interface CreateAttendeeCommandOutput extends CreateAttendeeResponse, __M * in the * Amazon Chime Developer Guide. *

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ChimeClient, CreateAttendeeCommand } from "@aws-sdk/client-chime"; // ES Modules import + * // const { ChimeClient, CreateAttendeeCommand } = require("@aws-sdk/client-chime"); // CommonJS import + * const client = new ChimeClient(config); + * const command = new CreateAttendeeCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreateAttendeeCommandInput} for command's `input` shape. + * @see {@link CreateAttendeeCommandOutput} for command's `response` shape. + * @see {@link ChimeClientResolvedConfig | config} for command's `input` shape. + * */ export class CreateAttendeeCommand extends $Command< CreateAttendeeCommandInput, diff --git a/clients/client-chime/commands/CreateBotCommand.ts b/clients/client-chime/commands/CreateBotCommand.ts index 79eae714f759..469ecd41af36 100644 --- a/clients/client-chime/commands/CreateBotCommand.ts +++ b/clients/client-chime/commands/CreateBotCommand.ts @@ -22,6 +22,20 @@ export interface CreateBotCommandOutput extends CreateBotResponse, __MetadataBea /** *

Creates a bot for an Amazon Chime Enterprise account.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ChimeClient, CreateBotCommand } from "@aws-sdk/client-chime"; // ES Modules import + * // const { ChimeClient, CreateBotCommand } = require("@aws-sdk/client-chime"); // CommonJS import + * const client = new ChimeClient(config); + * const command = new CreateBotCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreateBotCommandInput} for command's `input` shape. + * @see {@link CreateBotCommandOutput} for command's `response` shape. + * @see {@link ChimeClientResolvedConfig | config} for command's `input` shape. + * */ export class CreateBotCommand extends $Command< CreateBotCommandInput, diff --git a/clients/client-chime/commands/CreateChannelBanCommand.ts b/clients/client-chime/commands/CreateChannelBanCommand.ts index 22d11f791d10..81c332191478 100644 --- a/clients/client-chime/commands/CreateChannelBanCommand.ts +++ b/clients/client-chime/commands/CreateChannelBanCommand.ts @@ -31,6 +31,20 @@ export interface CreateChannelBanCommandOutput extends CreateChannelBanResponse, *

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.

* + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ChimeClient, CreateChannelBanCommand } from "@aws-sdk/client-chime"; // ES Modules import + * // const { ChimeClient, CreateChannelBanCommand } = require("@aws-sdk/client-chime"); // CommonJS import + * const client = new ChimeClient(config); + * const command = new CreateChannelBanCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreateChannelBanCommandInput} for command's `input` shape. + * @see {@link CreateChannelBanCommandOutput} for command's `response` shape. + * @see {@link ChimeClientResolvedConfig | config} for command's `input` shape. + * */ export class CreateChannelBanCommand extends $Command< CreateChannelBanCommandInput, diff --git a/clients/client-chime/commands/CreateChannelCommand.ts b/clients/client-chime/commands/CreateChannelCommand.ts index c52302ec2e96..4055a6ac10d0 100644 --- a/clients/client-chime/commands/CreateChannelCommand.ts +++ b/clients/client-chime/commands/CreateChannelCommand.ts @@ -30,6 +30,20 @@ export interface CreateChannelCommandOutput extends CreateChannelResponse, __Met *

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.

* + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ChimeClient, CreateChannelCommand } from "@aws-sdk/client-chime"; // ES Modules import + * // const { ChimeClient, CreateChannelCommand } = require("@aws-sdk/client-chime"); // CommonJS import + * const client = new ChimeClient(config); + * const command = new CreateChannelCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreateChannelCommandInput} for command's `input` shape. + * @see {@link CreateChannelCommandOutput} for command's `response` shape. + * @see {@link ChimeClientResolvedConfig | config} for command's `input` shape. + * */ export class CreateChannelCommand extends $Command< CreateChannelCommandInput, diff --git a/clients/client-chime/commands/CreateChannelMembershipCommand.ts b/clients/client-chime/commands/CreateChannelMembershipCommand.ts index 2c00b37036bc..28f2acd0b900 100644 --- a/clients/client-chime/commands/CreateChannelMembershipCommand.ts +++ b/clients/client-chime/commands/CreateChannelMembershipCommand.ts @@ -57,6 +57,20 @@ export interface CreateChannelMembershipCommandOutput extends CreateChannelMembe *

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.

* + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ChimeClient, CreateChannelMembershipCommand } from "@aws-sdk/client-chime"; // ES Modules import + * // const { ChimeClient, CreateChannelMembershipCommand } = require("@aws-sdk/client-chime"); // CommonJS import + * const client = new ChimeClient(config); + * const command = new CreateChannelMembershipCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreateChannelMembershipCommandInput} for command's `input` shape. + * @see {@link CreateChannelMembershipCommandOutput} for command's `response` shape. + * @see {@link ChimeClientResolvedConfig | config} for command's `input` shape. + * */ export class CreateChannelMembershipCommand extends $Command< CreateChannelMembershipCommandInput, diff --git a/clients/client-chime/commands/CreateChannelModeratorCommand.ts b/clients/client-chime/commands/CreateChannelModeratorCommand.ts index 72cfca9dce70..f12b9320b57c 100644 --- a/clients/client-chime/commands/CreateChannelModeratorCommand.ts +++ b/clients/client-chime/commands/CreateChannelModeratorCommand.ts @@ -45,6 +45,20 @@ export interface CreateChannelModeratorCommandOutput extends CreateChannelModera *

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.

* + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ChimeClient, CreateChannelModeratorCommand } from "@aws-sdk/client-chime"; // ES Modules import + * // const { ChimeClient, CreateChannelModeratorCommand } = require("@aws-sdk/client-chime"); // CommonJS import + * const client = new ChimeClient(config); + * const command = new CreateChannelModeratorCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreateChannelModeratorCommandInput} for command's `input` shape. + * @see {@link CreateChannelModeratorCommandOutput} for command's `response` shape. + * @see {@link ChimeClientResolvedConfig | config} for command's `input` shape. + * */ export class CreateChannelModeratorCommand extends $Command< CreateChannelModeratorCommandInput, diff --git a/clients/client-chime/commands/CreateMeetingCommand.ts b/clients/client-chime/commands/CreateMeetingCommand.ts index 4840b6c0949b..363ec5821d37 100644 --- a/clients/client-chime/commands/CreateMeetingCommand.ts +++ b/clients/client-chime/commands/CreateMeetingCommand.ts @@ -32,6 +32,20 @@ export interface CreateMeetingCommandOutput extends CreateMeetingResponse, __Met * Amazon Chime Developer Guide * . *

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ChimeClient, CreateMeetingCommand } from "@aws-sdk/client-chime"; // ES Modules import + * // const { ChimeClient, CreateMeetingCommand } = require("@aws-sdk/client-chime"); // CommonJS import + * const client = new ChimeClient(config); + * const command = new CreateMeetingCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreateMeetingCommandInput} for command's `input` shape. + * @see {@link CreateMeetingCommandOutput} for command's `response` shape. + * @see {@link ChimeClientResolvedConfig | config} for command's `input` shape. + * */ export class CreateMeetingCommand extends $Command< CreateMeetingCommandInput, diff --git a/clients/client-chime/commands/CreateMeetingDialOutCommand.ts b/clients/client-chime/commands/CreateMeetingDialOutCommand.ts index 15b2c07aba10..0923fcb28e13 100644 --- a/clients/client-chime/commands/CreateMeetingDialOutCommand.ts +++ b/clients/client-chime/commands/CreateMeetingDialOutCommand.ts @@ -26,6 +26,20 @@ export interface CreateMeetingDialOutCommandOutput extends CreateMeetingDialOutR * *

To play welcome audio or implement an interactive voice response (IVR), use the * CreateSipMediaApplicationCall action with the corresponding SIP media application ID.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ChimeClient, CreateMeetingDialOutCommand } from "@aws-sdk/client-chime"; // ES Modules import + * // const { ChimeClient, CreateMeetingDialOutCommand } = require("@aws-sdk/client-chime"); // CommonJS import + * const client = new ChimeClient(config); + * const command = new CreateMeetingDialOutCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreateMeetingDialOutCommandInput} for command's `input` shape. + * @see {@link CreateMeetingDialOutCommandOutput} for command's `response` shape. + * @see {@link ChimeClientResolvedConfig | config} for command's `input` shape. + * */ export class CreateMeetingDialOutCommand extends $Command< CreateMeetingDialOutCommandInput, diff --git a/clients/client-chime/commands/CreateMeetingWithAttendeesCommand.ts b/clients/client-chime/commands/CreateMeetingWithAttendeesCommand.ts index 90cebe3043a7..9882cb2937ea 100644 --- a/clients/client-chime/commands/CreateMeetingWithAttendeesCommand.ts +++ b/clients/client-chime/commands/CreateMeetingWithAttendeesCommand.ts @@ -32,6 +32,20 @@ export interface CreateMeetingWithAttendeesCommandOutput extends CreateMeetingWi * Amazon Chime Developer Guide * . *

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ChimeClient, CreateMeetingWithAttendeesCommand } from "@aws-sdk/client-chime"; // ES Modules import + * // const { ChimeClient, CreateMeetingWithAttendeesCommand } = require("@aws-sdk/client-chime"); // CommonJS import + * const client = new ChimeClient(config); + * const command = new CreateMeetingWithAttendeesCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreateMeetingWithAttendeesCommandInput} for command's `input` shape. + * @see {@link CreateMeetingWithAttendeesCommandOutput} for command's `response` shape. + * @see {@link ChimeClientResolvedConfig | config} for command's `input` shape. + * */ export class CreateMeetingWithAttendeesCommand extends $Command< CreateMeetingWithAttendeesCommandInput, diff --git a/clients/client-chime/commands/CreatePhoneNumberOrderCommand.ts b/clients/client-chime/commands/CreatePhoneNumberOrderCommand.ts index aaeece082b6f..0f509b4a6544 100644 --- a/clients/client-chime/commands/CreatePhoneNumberOrderCommand.ts +++ b/clients/client-chime/commands/CreatePhoneNumberOrderCommand.ts @@ -24,6 +24,20 @@ export interface CreatePhoneNumberOrderCommandOutput extends CreatePhoneNumberOr *

Creates an order for phone numbers to be provisioned. Choose from Amazon Chime Business Calling * and Amazon Chime Voice Connector product types. For toll-free numbers, you must use the * Amazon Chime Voice Connector product type.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ChimeClient, CreatePhoneNumberOrderCommand } from "@aws-sdk/client-chime"; // ES Modules import + * // const { ChimeClient, CreatePhoneNumberOrderCommand } = require("@aws-sdk/client-chime"); // CommonJS import + * const client = new ChimeClient(config); + * const command = new CreatePhoneNumberOrderCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreatePhoneNumberOrderCommandInput} for command's `input` shape. + * @see {@link CreatePhoneNumberOrderCommandOutput} for command's `response` shape. + * @see {@link ChimeClientResolvedConfig | config} for command's `input` shape. + * */ export class CreatePhoneNumberOrderCommand extends $Command< CreatePhoneNumberOrderCommandInput, diff --git a/clients/client-chime/commands/CreateProxySessionCommand.ts b/clients/client-chime/commands/CreateProxySessionCommand.ts index ee15a9a09454..ec3e2d2fbf16 100644 --- a/clients/client-chime/commands/CreateProxySessionCommand.ts +++ b/clients/client-chime/commands/CreateProxySessionCommand.ts @@ -22,6 +22,20 @@ export interface CreateProxySessionCommandOutput extends CreateProxySessionRespo /** *

Creates a proxy session on the specified Amazon Chime Voice Connector for the specified participant phone numbers.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ChimeClient, CreateProxySessionCommand } from "@aws-sdk/client-chime"; // ES Modules import + * // const { ChimeClient, CreateProxySessionCommand } = require("@aws-sdk/client-chime"); // CommonJS import + * const client = new ChimeClient(config); + * const command = new CreateProxySessionCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreateProxySessionCommandInput} for command's `input` shape. + * @see {@link CreateProxySessionCommandOutput} for command's `response` shape. + * @see {@link ChimeClientResolvedConfig | config} for command's `input` shape. + * */ export class CreateProxySessionCommand extends $Command< CreateProxySessionCommandInput, diff --git a/clients/client-chime/commands/CreateRoomCommand.ts b/clients/client-chime/commands/CreateRoomCommand.ts index 49074160afad..917e99b62eeb 100644 --- a/clients/client-chime/commands/CreateRoomCommand.ts +++ b/clients/client-chime/commands/CreateRoomCommand.ts @@ -22,6 +22,20 @@ export interface CreateRoomCommandOutput extends CreateRoomResponse, __MetadataB /** *

Creates a chat room for the specified Amazon Chime Enterprise account.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ChimeClient, CreateRoomCommand } from "@aws-sdk/client-chime"; // ES Modules import + * // const { ChimeClient, CreateRoomCommand } = require("@aws-sdk/client-chime"); // CommonJS import + * const client = new ChimeClient(config); + * const command = new CreateRoomCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreateRoomCommandInput} for command's `input` shape. + * @see {@link CreateRoomCommandOutput} for command's `response` shape. + * @see {@link ChimeClientResolvedConfig | config} for command's `input` shape. + * */ export class CreateRoomCommand extends $Command< CreateRoomCommandInput, diff --git a/clients/client-chime/commands/CreateRoomMembershipCommand.ts b/clients/client-chime/commands/CreateRoomMembershipCommand.ts index 6074cab3eb76..351488d8ceca 100644 --- a/clients/client-chime/commands/CreateRoomMembershipCommand.ts +++ b/clients/client-chime/commands/CreateRoomMembershipCommand.ts @@ -22,6 +22,20 @@ export interface CreateRoomMembershipCommandOutput extends CreateRoomMembershipR /** *

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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ChimeClient, CreateRoomMembershipCommand } from "@aws-sdk/client-chime"; // ES Modules import + * // const { ChimeClient, CreateRoomMembershipCommand } = require("@aws-sdk/client-chime"); // CommonJS import + * const client = new ChimeClient(config); + * const command = new CreateRoomMembershipCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreateRoomMembershipCommandInput} for command's `input` shape. + * @see {@link CreateRoomMembershipCommandOutput} for command's `response` shape. + * @see {@link ChimeClientResolvedConfig | config} for command's `input` shape. + * */ export class CreateRoomMembershipCommand extends $Command< CreateRoomMembershipCommandInput, diff --git a/clients/client-chime/commands/CreateSipMediaApplicationCallCommand.ts b/clients/client-chime/commands/CreateSipMediaApplicationCallCommand.ts index eed195f54c8f..00737a133f18 100644 --- a/clients/client-chime/commands/CreateSipMediaApplicationCallCommand.ts +++ b/clients/client-chime/commands/CreateSipMediaApplicationCallCommand.ts @@ -25,6 +25,20 @@ export interface CreateSipMediaApplicationCallCommandOutput /** *

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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ChimeClient, CreateSipMediaApplicationCallCommand } from "@aws-sdk/client-chime"; // ES Modules import + * // const { ChimeClient, CreateSipMediaApplicationCallCommand } = require("@aws-sdk/client-chime"); // CommonJS import + * const client = new ChimeClient(config); + * const command = new CreateSipMediaApplicationCallCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreateSipMediaApplicationCallCommandInput} for command's `input` shape. + * @see {@link CreateSipMediaApplicationCallCommandOutput} for command's `response` shape. + * @see {@link ChimeClientResolvedConfig | config} for command's `input` shape. + * */ export class CreateSipMediaApplicationCallCommand extends $Command< CreateSipMediaApplicationCallCommandInput, diff --git a/clients/client-chime/commands/CreateSipMediaApplicationCommand.ts b/clients/client-chime/commands/CreateSipMediaApplicationCommand.ts index 6aa414360915..726f8102bbd5 100644 --- a/clients/client-chime/commands/CreateSipMediaApplicationCommand.ts +++ b/clients/client-chime/commands/CreateSipMediaApplicationCommand.ts @@ -22,6 +22,20 @@ export interface CreateSipMediaApplicationCommandOutput extends CreateSipMediaAp /** *

Creates a SIP media application.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ChimeClient, CreateSipMediaApplicationCommand } from "@aws-sdk/client-chime"; // ES Modules import + * // const { ChimeClient, CreateSipMediaApplicationCommand } = require("@aws-sdk/client-chime"); // CommonJS import + * const client = new ChimeClient(config); + * const command = new CreateSipMediaApplicationCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreateSipMediaApplicationCommandInput} for command's `input` shape. + * @see {@link CreateSipMediaApplicationCommandOutput} for command's `response` shape. + * @see {@link ChimeClientResolvedConfig | config} for command's `input` shape. + * */ export class CreateSipMediaApplicationCommand extends $Command< CreateSipMediaApplicationCommandInput, diff --git a/clients/client-chime/commands/CreateSipRuleCommand.ts b/clients/client-chime/commands/CreateSipRuleCommand.ts index 4577492b032b..0ee362271337 100644 --- a/clients/client-chime/commands/CreateSipRuleCommand.ts +++ b/clients/client-chime/commands/CreateSipRuleCommand.ts @@ -22,6 +22,20 @@ export interface CreateSipRuleCommandOutput extends CreateSipRuleResponse, __Met /** *

Creates a SIP rule which can be used to run a SIP media application as a target for a specific trigger type.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ChimeClient, CreateSipRuleCommand } from "@aws-sdk/client-chime"; // ES Modules import + * // const { ChimeClient, CreateSipRuleCommand } = require("@aws-sdk/client-chime"); // CommonJS import + * const client = new ChimeClient(config); + * const command = new CreateSipRuleCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreateSipRuleCommandInput} for command's `input` shape. + * @see {@link CreateSipRuleCommandOutput} for command's `response` shape. + * @see {@link ChimeClientResolvedConfig | config} for command's `input` shape. + * */ export class CreateSipRuleCommand extends $Command< CreateSipRuleCommandInput, diff --git a/clients/client-chime/commands/CreateUserCommand.ts b/clients/client-chime/commands/CreateUserCommand.ts index 6f913b8e1566..f15bba6b8bd3 100644 --- a/clients/client-chime/commands/CreateUserCommand.ts +++ b/clients/client-chime/commands/CreateUserCommand.ts @@ -22,6 +22,20 @@ export interface CreateUserCommandOutput extends CreateUserResponse, __MetadataB /** *

Creates a user under the specified Amazon Chime account.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ChimeClient, CreateUserCommand } from "@aws-sdk/client-chime"; // ES Modules import + * // const { ChimeClient, CreateUserCommand } = require("@aws-sdk/client-chime"); // CommonJS import + * const client = new ChimeClient(config); + * const command = new CreateUserCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreateUserCommandInput} for command's `input` shape. + * @see {@link CreateUserCommandOutput} for command's `response` shape. + * @see {@link ChimeClientResolvedConfig | config} for command's `input` shape. + * */ export class CreateUserCommand extends $Command< CreateUserCommandInput, diff --git a/clients/client-chime/commands/CreateVoiceConnectorCommand.ts b/clients/client-chime/commands/CreateVoiceConnectorCommand.ts index 6e3ce11f02e6..c945f5bc45ee 100644 --- a/clients/client-chime/commands/CreateVoiceConnectorCommand.ts +++ b/clients/client-chime/commands/CreateVoiceConnectorCommand.ts @@ -28,6 +28,20 @@ export interface CreateVoiceConnectorCommandOutput extends CreateVoiceConnectorR * 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. *

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ChimeClient, CreateVoiceConnectorCommand } from "@aws-sdk/client-chime"; // ES Modules import + * // const { ChimeClient, CreateVoiceConnectorCommand } = require("@aws-sdk/client-chime"); // CommonJS import + * const client = new ChimeClient(config); + * const command = new CreateVoiceConnectorCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreateVoiceConnectorCommandInput} for command's `input` shape. + * @see {@link CreateVoiceConnectorCommandOutput} for command's `response` shape. + * @see {@link ChimeClientResolvedConfig | config} for command's `input` shape. + * */ export class CreateVoiceConnectorCommand extends $Command< CreateVoiceConnectorCommandInput, diff --git a/clients/client-chime/commands/CreateVoiceConnectorGroupCommand.ts b/clients/client-chime/commands/CreateVoiceConnectorGroupCommand.ts index 40eaee80d446..dd562205500a 100644 --- a/clients/client-chime/commands/CreateVoiceConnectorGroupCommand.ts +++ b/clients/client-chime/commands/CreateVoiceConnectorGroupCommand.ts @@ -26,6 +26,20 @@ export interface CreateVoiceConnectorGroupCommandOutput extends CreateVoiceConne * 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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ChimeClient, CreateVoiceConnectorGroupCommand } from "@aws-sdk/client-chime"; // ES Modules import + * // const { ChimeClient, CreateVoiceConnectorGroupCommand } = require("@aws-sdk/client-chime"); // CommonJS import + * const client = new ChimeClient(config); + * const command = new CreateVoiceConnectorGroupCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreateVoiceConnectorGroupCommandInput} for command's `input` shape. + * @see {@link CreateVoiceConnectorGroupCommandOutput} for command's `response` shape. + * @see {@link ChimeClientResolvedConfig | config} for command's `input` shape. + * */ export class CreateVoiceConnectorGroupCommand extends $Command< CreateVoiceConnectorGroupCommandInput, diff --git a/clients/client-chime/commands/DeleteAccountCommand.ts b/clients/client-chime/commands/DeleteAccountCommand.ts index 4b83284881ca..1a78388ccc58 100644 --- a/clients/client-chime/commands/DeleteAccountCommand.ts +++ b/clients/client-chime/commands/DeleteAccountCommand.ts @@ -38,6 +38,20 @@ export interface DeleteAccountCommandOutput extends DeleteAccountResponse, __Met * Disabled * accounts list. *

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ChimeClient, DeleteAccountCommand } from "@aws-sdk/client-chime"; // ES Modules import + * // const { ChimeClient, DeleteAccountCommand } = require("@aws-sdk/client-chime"); // CommonJS import + * const client = new ChimeClient(config); + * const command = new DeleteAccountCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteAccountCommandInput} for command's `input` shape. + * @see {@link DeleteAccountCommandOutput} for command's `response` shape. + * @see {@link ChimeClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteAccountCommand extends $Command< DeleteAccountCommandInput, diff --git a/clients/client-chime/commands/DeleteAppInstanceAdminCommand.ts b/clients/client-chime/commands/DeleteAppInstanceAdminCommand.ts index aa1fb6f04e74..9e8a18f89b8c 100644 --- a/clients/client-chime/commands/DeleteAppInstanceAdminCommand.ts +++ b/clients/client-chime/commands/DeleteAppInstanceAdminCommand.ts @@ -22,6 +22,20 @@ export interface DeleteAppInstanceAdminCommandOutput extends __MetadataBearer {} /** *

Demotes an AppInstanceAdmin to an AppInstanceUser. This action does not delete the user.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ChimeClient, DeleteAppInstanceAdminCommand } from "@aws-sdk/client-chime"; // ES Modules import + * // const { ChimeClient, DeleteAppInstanceAdminCommand } = require("@aws-sdk/client-chime"); // CommonJS import + * const client = new ChimeClient(config); + * const command = new DeleteAppInstanceAdminCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteAppInstanceAdminCommandInput} for command's `input` shape. + * @see {@link DeleteAppInstanceAdminCommandOutput} for command's `response` shape. + * @see {@link ChimeClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteAppInstanceAdminCommand extends $Command< DeleteAppInstanceAdminCommandInput, diff --git a/clients/client-chime/commands/DeleteAppInstanceCommand.ts b/clients/client-chime/commands/DeleteAppInstanceCommand.ts index 9772f33d0767..6d008aade52b 100644 --- a/clients/client-chime/commands/DeleteAppInstanceCommand.ts +++ b/clients/client-chime/commands/DeleteAppInstanceCommand.ts @@ -22,6 +22,20 @@ export interface DeleteAppInstanceCommandOutput extends __MetadataBearer {} /** *

Deletes an AppInstance and all associated data asynchronously.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ChimeClient, DeleteAppInstanceCommand } from "@aws-sdk/client-chime"; // ES Modules import + * // const { ChimeClient, DeleteAppInstanceCommand } = require("@aws-sdk/client-chime"); // CommonJS import + * const client = new ChimeClient(config); + * const command = new DeleteAppInstanceCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteAppInstanceCommandInput} for command's `input` shape. + * @see {@link DeleteAppInstanceCommandOutput} for command's `response` shape. + * @see {@link ChimeClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteAppInstanceCommand extends $Command< DeleteAppInstanceCommandInput, diff --git a/clients/client-chime/commands/DeleteAppInstanceStreamingConfigurationsCommand.ts b/clients/client-chime/commands/DeleteAppInstanceStreamingConfigurationsCommand.ts index 1b9f16e17968..907e974f38e2 100644 --- a/clients/client-chime/commands/DeleteAppInstanceStreamingConfigurationsCommand.ts +++ b/clients/client-chime/commands/DeleteAppInstanceStreamingConfigurationsCommand.ts @@ -23,6 +23,20 @@ export interface DeleteAppInstanceStreamingConfigurationsCommandOutput extends _ /** *

Deletes the streaming configurations of an AppInstance.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ChimeClient, DeleteAppInstanceStreamingConfigurationsCommand } from "@aws-sdk/client-chime"; // ES Modules import + * // const { ChimeClient, DeleteAppInstanceStreamingConfigurationsCommand } = require("@aws-sdk/client-chime"); // CommonJS import + * const client = new ChimeClient(config); + * const command = new DeleteAppInstanceStreamingConfigurationsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteAppInstanceStreamingConfigurationsCommandInput} for command's `input` shape. + * @see {@link DeleteAppInstanceStreamingConfigurationsCommandOutput} for command's `response` shape. + * @see {@link ChimeClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteAppInstanceStreamingConfigurationsCommand extends $Command< DeleteAppInstanceStreamingConfigurationsCommandInput, diff --git a/clients/client-chime/commands/DeleteAppInstanceUserCommand.ts b/clients/client-chime/commands/DeleteAppInstanceUserCommand.ts index d5c30390096a..7c5006751651 100644 --- a/clients/client-chime/commands/DeleteAppInstanceUserCommand.ts +++ b/clients/client-chime/commands/DeleteAppInstanceUserCommand.ts @@ -22,6 +22,20 @@ export interface DeleteAppInstanceUserCommandOutput extends __MetadataBearer {} /** *

Deletes an AppInstanceUser.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ChimeClient, DeleteAppInstanceUserCommand } from "@aws-sdk/client-chime"; // ES Modules import + * // const { ChimeClient, DeleteAppInstanceUserCommand } = require("@aws-sdk/client-chime"); // CommonJS import + * const client = new ChimeClient(config); + * const command = new DeleteAppInstanceUserCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteAppInstanceUserCommandInput} for command's `input` shape. + * @see {@link DeleteAppInstanceUserCommandOutput} for command's `response` shape. + * @see {@link ChimeClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteAppInstanceUserCommand extends $Command< DeleteAppInstanceUserCommandInput, diff --git a/clients/client-chime/commands/DeleteAttendeeCommand.ts b/clients/client-chime/commands/DeleteAttendeeCommand.ts index e4a32bd8deb1..13e233f18ed7 100644 --- a/clients/client-chime/commands/DeleteAttendeeCommand.ts +++ b/clients/client-chime/commands/DeleteAttendeeCommand.ts @@ -30,6 +30,20 @@ export interface DeleteAttendeeCommandOutput extends __MetadataBearer {} * Amazon Chime Developer Guide * . *

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ChimeClient, DeleteAttendeeCommand } from "@aws-sdk/client-chime"; // ES Modules import + * // const { ChimeClient, DeleteAttendeeCommand } = require("@aws-sdk/client-chime"); // CommonJS import + * const client = new ChimeClient(config); + * const command = new DeleteAttendeeCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteAttendeeCommandInput} for command's `input` shape. + * @see {@link DeleteAttendeeCommandOutput} for command's `response` shape. + * @see {@link ChimeClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteAttendeeCommand extends $Command< DeleteAttendeeCommandInput, diff --git a/clients/client-chime/commands/DeleteChannelBanCommand.ts b/clients/client-chime/commands/DeleteChannelBanCommand.ts index 0e555ae235ce..38dc6385a123 100644 --- a/clients/client-chime/commands/DeleteChannelBanCommand.ts +++ b/clients/client-chime/commands/DeleteChannelBanCommand.ts @@ -27,6 +27,20 @@ export interface DeleteChannelBanCommandOutput extends __MetadataBearer {} *

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.

* + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ChimeClient, DeleteChannelBanCommand } from "@aws-sdk/client-chime"; // ES Modules import + * // const { ChimeClient, DeleteChannelBanCommand } = require("@aws-sdk/client-chime"); // CommonJS import + * const client = new ChimeClient(config); + * const command = new DeleteChannelBanCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteChannelBanCommandInput} for command's `input` shape. + * @see {@link DeleteChannelBanCommandOutput} for command's `response` shape. + * @see {@link ChimeClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteChannelBanCommand extends $Command< DeleteChannelBanCommandInput, diff --git a/clients/client-chime/commands/DeleteChannelCommand.ts b/clients/client-chime/commands/DeleteChannelCommand.ts index 808ea3bff94a..15f719c75be1 100644 --- a/clients/client-chime/commands/DeleteChannelCommand.ts +++ b/clients/client-chime/commands/DeleteChannelCommand.ts @@ -27,6 +27,20 @@ export interface DeleteChannelCommandOutput extends __MetadataBearer {} *

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.

* + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ChimeClient, DeleteChannelCommand } from "@aws-sdk/client-chime"; // ES Modules import + * // const { ChimeClient, DeleteChannelCommand } = require("@aws-sdk/client-chime"); // CommonJS import + * const client = new ChimeClient(config); + * const command = new DeleteChannelCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteChannelCommandInput} for command's `input` shape. + * @see {@link DeleteChannelCommandOutput} for command's `response` shape. + * @see {@link ChimeClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteChannelCommand extends $Command< DeleteChannelCommandInput, diff --git a/clients/client-chime/commands/DeleteChannelMembershipCommand.ts b/clients/client-chime/commands/DeleteChannelMembershipCommand.ts index ec5d2e0e6da2..65543b3cc773 100644 --- a/clients/client-chime/commands/DeleteChannelMembershipCommand.ts +++ b/clients/client-chime/commands/DeleteChannelMembershipCommand.ts @@ -27,6 +27,20 @@ export interface DeleteChannelMembershipCommandOutput extends __MetadataBearer { *

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.

* + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ChimeClient, DeleteChannelMembershipCommand } from "@aws-sdk/client-chime"; // ES Modules import + * // const { ChimeClient, DeleteChannelMembershipCommand } = require("@aws-sdk/client-chime"); // CommonJS import + * const client = new ChimeClient(config); + * const command = new DeleteChannelMembershipCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteChannelMembershipCommandInput} for command's `input` shape. + * @see {@link DeleteChannelMembershipCommandOutput} for command's `response` shape. + * @see {@link ChimeClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteChannelMembershipCommand extends $Command< DeleteChannelMembershipCommandInput, diff --git a/clients/client-chime/commands/DeleteChannelMessageCommand.ts b/clients/client-chime/commands/DeleteChannelMessageCommand.ts index e9b9d0254300..b2852d9aface 100644 --- a/clients/client-chime/commands/DeleteChannelMessageCommand.ts +++ b/clients/client-chime/commands/DeleteChannelMessageCommand.ts @@ -29,6 +29,20 @@ export interface DeleteChannelMessageCommandOutput extends __MetadataBearer {} *

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.

* + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ChimeClient, DeleteChannelMessageCommand } from "@aws-sdk/client-chime"; // ES Modules import + * // const { ChimeClient, DeleteChannelMessageCommand } = require("@aws-sdk/client-chime"); // CommonJS import + * const client = new ChimeClient(config); + * const command = new DeleteChannelMessageCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteChannelMessageCommandInput} for command's `input` shape. + * @see {@link DeleteChannelMessageCommandOutput} for command's `response` shape. + * @see {@link ChimeClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteChannelMessageCommand extends $Command< DeleteChannelMessageCommandInput, diff --git a/clients/client-chime/commands/DeleteChannelModeratorCommand.ts b/clients/client-chime/commands/DeleteChannelModeratorCommand.ts index 36aa39f71048..be688a6d4e41 100644 --- a/clients/client-chime/commands/DeleteChannelModeratorCommand.ts +++ b/clients/client-chime/commands/DeleteChannelModeratorCommand.ts @@ -27,6 +27,20 @@ export interface DeleteChannelModeratorCommandOutput extends __MetadataBearer {} *

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.

* + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ChimeClient, DeleteChannelModeratorCommand } from "@aws-sdk/client-chime"; // ES Modules import + * // const { ChimeClient, DeleteChannelModeratorCommand } = require("@aws-sdk/client-chime"); // CommonJS import + * const client = new ChimeClient(config); + * const command = new DeleteChannelModeratorCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteChannelModeratorCommandInput} for command's `input` shape. + * @see {@link DeleteChannelModeratorCommandOutput} for command's `response` shape. + * @see {@link ChimeClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteChannelModeratorCommand extends $Command< DeleteChannelModeratorCommandInput, diff --git a/clients/client-chime/commands/DeleteEventsConfigurationCommand.ts b/clients/client-chime/commands/DeleteEventsConfigurationCommand.ts index b83e23b7572f..ec5dbec43fe1 100644 --- a/clients/client-chime/commands/DeleteEventsConfigurationCommand.ts +++ b/clients/client-chime/commands/DeleteEventsConfigurationCommand.ts @@ -22,6 +22,20 @@ export interface DeleteEventsConfigurationCommandOutput extends __MetadataBearer /** *

Deletes the events configuration that allows a bot to receive outgoing events.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ChimeClient, DeleteEventsConfigurationCommand } from "@aws-sdk/client-chime"; // ES Modules import + * // const { ChimeClient, DeleteEventsConfigurationCommand } = require("@aws-sdk/client-chime"); // CommonJS import + * const client = new ChimeClient(config); + * const command = new DeleteEventsConfigurationCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteEventsConfigurationCommandInput} for command's `input` shape. + * @see {@link DeleteEventsConfigurationCommandOutput} for command's `response` shape. + * @see {@link ChimeClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteEventsConfigurationCommand extends $Command< DeleteEventsConfigurationCommandInput, diff --git a/clients/client-chime/commands/DeleteMeetingCommand.ts b/clients/client-chime/commands/DeleteMeetingCommand.ts index bca5e61334d1..d1ca79aaae37 100644 --- a/clients/client-chime/commands/DeleteMeetingCommand.ts +++ b/clients/client-chime/commands/DeleteMeetingCommand.ts @@ -25,6 +25,20 @@ export interface DeleteMeetingCommandOutput extends __MetadataBearer {} * also deleted, clients connected to the meeting are disconnected, and clients can no * longer join the meeting. For more information about the Amazon Chime SDK, see Using the Amazon Chime * SDK in the Amazon Chime Developer Guide.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ChimeClient, DeleteMeetingCommand } from "@aws-sdk/client-chime"; // ES Modules import + * // const { ChimeClient, DeleteMeetingCommand } = require("@aws-sdk/client-chime"); // CommonJS import + * const client = new ChimeClient(config); + * const command = new DeleteMeetingCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteMeetingCommandInput} for command's `input` shape. + * @see {@link DeleteMeetingCommandOutput} for command's `response` shape. + * @see {@link ChimeClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteMeetingCommand extends $Command< DeleteMeetingCommandInput, diff --git a/clients/client-chime/commands/DeletePhoneNumberCommand.ts b/clients/client-chime/commands/DeletePhoneNumberCommand.ts index 466fe0b01c34..8054445a5992 100644 --- a/clients/client-chime/commands/DeletePhoneNumberCommand.ts +++ b/clients/client-chime/commands/DeletePhoneNumberCommand.ts @@ -30,6 +30,20 @@ export interface DeletePhoneNumberCommandOutput extends __MetadataBearer {} * Deletion queue * for 7 days before they are deleted permanently. *

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ChimeClient, DeletePhoneNumberCommand } from "@aws-sdk/client-chime"; // ES Modules import + * // const { ChimeClient, DeletePhoneNumberCommand } = require("@aws-sdk/client-chime"); // CommonJS import + * const client = new ChimeClient(config); + * const command = new DeletePhoneNumberCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeletePhoneNumberCommandInput} for command's `input` shape. + * @see {@link DeletePhoneNumberCommandOutput} for command's `response` shape. + * @see {@link ChimeClientResolvedConfig | config} for command's `input` shape. + * */ export class DeletePhoneNumberCommand extends $Command< DeletePhoneNumberCommandInput, diff --git a/clients/client-chime/commands/DeleteProxySessionCommand.ts b/clients/client-chime/commands/DeleteProxySessionCommand.ts index 6747eac4c596..a219db4493ad 100644 --- a/clients/client-chime/commands/DeleteProxySessionCommand.ts +++ b/clients/client-chime/commands/DeleteProxySessionCommand.ts @@ -22,6 +22,20 @@ export interface DeleteProxySessionCommandOutput extends __MetadataBearer {} /** *

Deletes the specified proxy session from the specified Amazon Chime Voice Connector.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ChimeClient, DeleteProxySessionCommand } from "@aws-sdk/client-chime"; // ES Modules import + * // const { ChimeClient, DeleteProxySessionCommand } = require("@aws-sdk/client-chime"); // CommonJS import + * const client = new ChimeClient(config); + * const command = new DeleteProxySessionCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteProxySessionCommandInput} for command's `input` shape. + * @see {@link DeleteProxySessionCommandOutput} for command's `response` shape. + * @see {@link ChimeClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteProxySessionCommand extends $Command< DeleteProxySessionCommandInput, diff --git a/clients/client-chime/commands/DeleteRoomCommand.ts b/clients/client-chime/commands/DeleteRoomCommand.ts index fc20b614fd07..3cb75b68fe22 100644 --- a/clients/client-chime/commands/DeleteRoomCommand.ts +++ b/clients/client-chime/commands/DeleteRoomCommand.ts @@ -22,6 +22,20 @@ export interface DeleteRoomCommandOutput extends __MetadataBearer {} /** *

Deletes a chat room in an Amazon Chime Enterprise account.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ChimeClient, DeleteRoomCommand } from "@aws-sdk/client-chime"; // ES Modules import + * // const { ChimeClient, DeleteRoomCommand } = require("@aws-sdk/client-chime"); // CommonJS import + * const client = new ChimeClient(config); + * const command = new DeleteRoomCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteRoomCommandInput} for command's `input` shape. + * @see {@link DeleteRoomCommandOutput} for command's `response` shape. + * @see {@link ChimeClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteRoomCommand extends $Command< DeleteRoomCommandInput, diff --git a/clients/client-chime/commands/DeleteRoomMembershipCommand.ts b/clients/client-chime/commands/DeleteRoomMembershipCommand.ts index e9f08be370b4..c13e71600c2c 100644 --- a/clients/client-chime/commands/DeleteRoomMembershipCommand.ts +++ b/clients/client-chime/commands/DeleteRoomMembershipCommand.ts @@ -22,6 +22,20 @@ export interface DeleteRoomMembershipCommandOutput extends __MetadataBearer {} /** *

Removes a member from a chat room in an Amazon Chime Enterprise account.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ChimeClient, DeleteRoomMembershipCommand } from "@aws-sdk/client-chime"; // ES Modules import + * // const { ChimeClient, DeleteRoomMembershipCommand } = require("@aws-sdk/client-chime"); // CommonJS import + * const client = new ChimeClient(config); + * const command = new DeleteRoomMembershipCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteRoomMembershipCommandInput} for command's `input` shape. + * @see {@link DeleteRoomMembershipCommandOutput} for command's `response` shape. + * @see {@link ChimeClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteRoomMembershipCommand extends $Command< DeleteRoomMembershipCommandInput, diff --git a/clients/client-chime/commands/DeleteSipMediaApplicationCommand.ts b/clients/client-chime/commands/DeleteSipMediaApplicationCommand.ts index 5efad0059281..c8efab1626b1 100644 --- a/clients/client-chime/commands/DeleteSipMediaApplicationCommand.ts +++ b/clients/client-chime/commands/DeleteSipMediaApplicationCommand.ts @@ -22,6 +22,20 @@ export interface DeleteSipMediaApplicationCommandOutput extends __MetadataBearer /** *

Deletes a SIP media application.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ChimeClient, DeleteSipMediaApplicationCommand } from "@aws-sdk/client-chime"; // ES Modules import + * // const { ChimeClient, DeleteSipMediaApplicationCommand } = require("@aws-sdk/client-chime"); // CommonJS import + * const client = new ChimeClient(config); + * const command = new DeleteSipMediaApplicationCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteSipMediaApplicationCommandInput} for command's `input` shape. + * @see {@link DeleteSipMediaApplicationCommandOutput} for command's `response` shape. + * @see {@link ChimeClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteSipMediaApplicationCommand extends $Command< DeleteSipMediaApplicationCommandInput, diff --git a/clients/client-chime/commands/DeleteSipRuleCommand.ts b/clients/client-chime/commands/DeleteSipRuleCommand.ts index efb30951f11a..93e2d929d128 100644 --- a/clients/client-chime/commands/DeleteSipRuleCommand.ts +++ b/clients/client-chime/commands/DeleteSipRuleCommand.ts @@ -22,6 +22,20 @@ export interface DeleteSipRuleCommandOutput extends __MetadataBearer {} /** *

Deletes a SIP rule. You must disable a SIP rule before you can delete it.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ChimeClient, DeleteSipRuleCommand } from "@aws-sdk/client-chime"; // ES Modules import + * // const { ChimeClient, DeleteSipRuleCommand } = require("@aws-sdk/client-chime"); // CommonJS import + * const client = new ChimeClient(config); + * const command = new DeleteSipRuleCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteSipRuleCommandInput} for command's `input` shape. + * @see {@link DeleteSipRuleCommandOutput} for command's `response` shape. + * @see {@link ChimeClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteSipRuleCommand extends $Command< DeleteSipRuleCommandInput, diff --git a/clients/client-chime/commands/DeleteVoiceConnectorCommand.ts b/clients/client-chime/commands/DeleteVoiceConnectorCommand.ts index 58ce2dff4e59..bbd07fb61448 100644 --- a/clients/client-chime/commands/DeleteVoiceConnectorCommand.ts +++ b/clients/client-chime/commands/DeleteVoiceConnectorCommand.ts @@ -24,6 +24,20 @@ export interface DeleteVoiceConnectorCommandOutput extends __MetadataBearer {} *

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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ChimeClient, DeleteVoiceConnectorCommand } from "@aws-sdk/client-chime"; // ES Modules import + * // const { ChimeClient, DeleteVoiceConnectorCommand } = require("@aws-sdk/client-chime"); // CommonJS import + * const client = new ChimeClient(config); + * const command = new DeleteVoiceConnectorCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteVoiceConnectorCommandInput} for command's `input` shape. + * @see {@link DeleteVoiceConnectorCommandOutput} for command's `response` shape. + * @see {@link ChimeClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteVoiceConnectorCommand extends $Command< DeleteVoiceConnectorCommandInput, diff --git a/clients/client-chime/commands/DeleteVoiceConnectorEmergencyCallingConfigurationCommand.ts b/clients/client-chime/commands/DeleteVoiceConnectorEmergencyCallingConfigurationCommand.ts index 648fb55089e7..35006b5caaee 100644 --- a/clients/client-chime/commands/DeleteVoiceConnectorEmergencyCallingConfigurationCommand.ts +++ b/clients/client-chime/commands/DeleteVoiceConnectorEmergencyCallingConfigurationCommand.ts @@ -23,6 +23,20 @@ export interface DeleteVoiceConnectorEmergencyCallingConfigurationCommandOutput /** *

Deletes the emergency calling configuration details from the specified Amazon Chime Voice Connector.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ChimeClient, DeleteVoiceConnectorEmergencyCallingConfigurationCommand } from "@aws-sdk/client-chime"; // ES Modules import + * // const { ChimeClient, DeleteVoiceConnectorEmergencyCallingConfigurationCommand } = require("@aws-sdk/client-chime"); // CommonJS import + * const client = new ChimeClient(config); + * const command = new DeleteVoiceConnectorEmergencyCallingConfigurationCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteVoiceConnectorEmergencyCallingConfigurationCommandInput} for command's `input` shape. + * @see {@link DeleteVoiceConnectorEmergencyCallingConfigurationCommandOutput} for command's `response` shape. + * @see {@link ChimeClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteVoiceConnectorEmergencyCallingConfigurationCommand extends $Command< DeleteVoiceConnectorEmergencyCallingConfigurationCommandInput, diff --git a/clients/client-chime/commands/DeleteVoiceConnectorGroupCommand.ts b/clients/client-chime/commands/DeleteVoiceConnectorGroupCommand.ts index 7dc1ef315bb2..f4ddd42e28d8 100644 --- a/clients/client-chime/commands/DeleteVoiceConnectorGroupCommand.ts +++ b/clients/client-chime/commands/DeleteVoiceConnectorGroupCommand.ts @@ -26,6 +26,20 @@ export interface DeleteVoiceConnectorGroupCommandOutput extends __MetadataBearer * VoiceConnectorItems * and phone numbers associated with the group must be removed before it can be deleted. *

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ChimeClient, DeleteVoiceConnectorGroupCommand } from "@aws-sdk/client-chime"; // ES Modules import + * // const { ChimeClient, DeleteVoiceConnectorGroupCommand } = require("@aws-sdk/client-chime"); // CommonJS import + * const client = new ChimeClient(config); + * const command = new DeleteVoiceConnectorGroupCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteVoiceConnectorGroupCommandInput} for command's `input` shape. + * @see {@link DeleteVoiceConnectorGroupCommandOutput} for command's `response` shape. + * @see {@link ChimeClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteVoiceConnectorGroupCommand extends $Command< DeleteVoiceConnectorGroupCommandInput, diff --git a/clients/client-chime/commands/DeleteVoiceConnectorOriginationCommand.ts b/clients/client-chime/commands/DeleteVoiceConnectorOriginationCommand.ts index d37dff41940a..73a9965c5750 100644 --- a/clients/client-chime/commands/DeleteVoiceConnectorOriginationCommand.ts +++ b/clients/client-chime/commands/DeleteVoiceConnectorOriginationCommand.ts @@ -26,6 +26,20 @@ export interface DeleteVoiceConnectorOriginationCommandOutput extends __Metadata * *

If emergency calling is configured for the Amazon Chime Voice Connector, it must be deleted prior to deleting the origination settings.

* + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ChimeClient, DeleteVoiceConnectorOriginationCommand } from "@aws-sdk/client-chime"; // ES Modules import + * // const { ChimeClient, DeleteVoiceConnectorOriginationCommand } = require("@aws-sdk/client-chime"); // CommonJS import + * const client = new ChimeClient(config); + * const command = new DeleteVoiceConnectorOriginationCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteVoiceConnectorOriginationCommandInput} for command's `input` shape. + * @see {@link DeleteVoiceConnectorOriginationCommandOutput} for command's `response` shape. + * @see {@link ChimeClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteVoiceConnectorOriginationCommand extends $Command< DeleteVoiceConnectorOriginationCommandInput, diff --git a/clients/client-chime/commands/DeleteVoiceConnectorProxyCommand.ts b/clients/client-chime/commands/DeleteVoiceConnectorProxyCommand.ts index b6d3d4c38c16..e611ebda00aa 100644 --- a/clients/client-chime/commands/DeleteVoiceConnectorProxyCommand.ts +++ b/clients/client-chime/commands/DeleteVoiceConnectorProxyCommand.ts @@ -22,6 +22,20 @@ export interface DeleteVoiceConnectorProxyCommandOutput extends __MetadataBearer /** *

Deletes the proxy configuration from the specified Amazon Chime Voice Connector.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ChimeClient, DeleteVoiceConnectorProxyCommand } from "@aws-sdk/client-chime"; // ES Modules import + * // const { ChimeClient, DeleteVoiceConnectorProxyCommand } = require("@aws-sdk/client-chime"); // CommonJS import + * const client = new ChimeClient(config); + * const command = new DeleteVoiceConnectorProxyCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteVoiceConnectorProxyCommandInput} for command's `input` shape. + * @see {@link DeleteVoiceConnectorProxyCommandOutput} for command's `response` shape. + * @see {@link ChimeClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteVoiceConnectorProxyCommand extends $Command< DeleteVoiceConnectorProxyCommandInput, diff --git a/clients/client-chime/commands/DeleteVoiceConnectorStreamingConfigurationCommand.ts b/clients/client-chime/commands/DeleteVoiceConnectorStreamingConfigurationCommand.ts index e982b0e8ff71..d9e3ee73c280 100644 --- a/clients/client-chime/commands/DeleteVoiceConnectorStreamingConfigurationCommand.ts +++ b/clients/client-chime/commands/DeleteVoiceConnectorStreamingConfigurationCommand.ts @@ -23,6 +23,20 @@ export interface DeleteVoiceConnectorStreamingConfigurationCommandOutput extends /** *

Deletes the streaming configuration for the specified Amazon Chime Voice Connector.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ChimeClient, DeleteVoiceConnectorStreamingConfigurationCommand } from "@aws-sdk/client-chime"; // ES Modules import + * // const { ChimeClient, DeleteVoiceConnectorStreamingConfigurationCommand } = require("@aws-sdk/client-chime"); // CommonJS import + * const client = new ChimeClient(config); + * const command = new DeleteVoiceConnectorStreamingConfigurationCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteVoiceConnectorStreamingConfigurationCommandInput} for command's `input` shape. + * @see {@link DeleteVoiceConnectorStreamingConfigurationCommandOutput} for command's `response` shape. + * @see {@link ChimeClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteVoiceConnectorStreamingConfigurationCommand extends $Command< DeleteVoiceConnectorStreamingConfigurationCommandInput, diff --git a/clients/client-chime/commands/DeleteVoiceConnectorTerminationCommand.ts b/clients/client-chime/commands/DeleteVoiceConnectorTerminationCommand.ts index ac4d58df23e3..cd40347a1038 100644 --- a/clients/client-chime/commands/DeleteVoiceConnectorTerminationCommand.ts +++ b/clients/client-chime/commands/DeleteVoiceConnectorTerminationCommand.ts @@ -26,6 +26,20 @@ export interface DeleteVoiceConnectorTerminationCommandOutput extends __Metadata * *

If emergency calling is configured for the Amazon Chime Voice Connector, it must be deleted prior to deleting the termination settings.

* + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ChimeClient, DeleteVoiceConnectorTerminationCommand } from "@aws-sdk/client-chime"; // ES Modules import + * // const { ChimeClient, DeleteVoiceConnectorTerminationCommand } = require("@aws-sdk/client-chime"); // CommonJS import + * const client = new ChimeClient(config); + * const command = new DeleteVoiceConnectorTerminationCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteVoiceConnectorTerminationCommandInput} for command's `input` shape. + * @see {@link DeleteVoiceConnectorTerminationCommandOutput} for command's `response` shape. + * @see {@link ChimeClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteVoiceConnectorTerminationCommand extends $Command< DeleteVoiceConnectorTerminationCommandInput, diff --git a/clients/client-chime/commands/DeleteVoiceConnectorTerminationCredentialsCommand.ts b/clients/client-chime/commands/DeleteVoiceConnectorTerminationCredentialsCommand.ts index ff3bf88b5d40..27abe167154d 100644 --- a/clients/client-chime/commands/DeleteVoiceConnectorTerminationCredentialsCommand.ts +++ b/clients/client-chime/commands/DeleteVoiceConnectorTerminationCredentialsCommand.ts @@ -23,6 +23,20 @@ export interface DeleteVoiceConnectorTerminationCredentialsCommandOutput extends /** *

Deletes the specified SIP credentials used by your equipment to authenticate during call termination.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ChimeClient, DeleteVoiceConnectorTerminationCredentialsCommand } from "@aws-sdk/client-chime"; // ES Modules import + * // const { ChimeClient, DeleteVoiceConnectorTerminationCredentialsCommand } = require("@aws-sdk/client-chime"); // CommonJS import + * const client = new ChimeClient(config); + * const command = new DeleteVoiceConnectorTerminationCredentialsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteVoiceConnectorTerminationCredentialsCommandInput} for command's `input` shape. + * @see {@link DeleteVoiceConnectorTerminationCredentialsCommandOutput} for command's `response` shape. + * @see {@link ChimeClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteVoiceConnectorTerminationCredentialsCommand extends $Command< DeleteVoiceConnectorTerminationCredentialsCommandInput, diff --git a/clients/client-chime/commands/DescribeAppInstanceAdminCommand.ts b/clients/client-chime/commands/DescribeAppInstanceAdminCommand.ts index dc531b65099d..cc735c5f4dd4 100644 --- a/clients/client-chime/commands/DescribeAppInstanceAdminCommand.ts +++ b/clients/client-chime/commands/DescribeAppInstanceAdminCommand.ts @@ -22,6 +22,20 @@ export interface DescribeAppInstanceAdminCommandOutput extends DescribeAppInstan /** *

Returns the full details of an AppInstanceAdmin.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ChimeClient, DescribeAppInstanceAdminCommand } from "@aws-sdk/client-chime"; // ES Modules import + * // const { ChimeClient, DescribeAppInstanceAdminCommand } = require("@aws-sdk/client-chime"); // CommonJS import + * const client = new ChimeClient(config); + * const command = new DescribeAppInstanceAdminCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeAppInstanceAdminCommandInput} for command's `input` shape. + * @see {@link DescribeAppInstanceAdminCommandOutput} for command's `response` shape. + * @see {@link ChimeClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeAppInstanceAdminCommand extends $Command< DescribeAppInstanceAdminCommandInput, diff --git a/clients/client-chime/commands/DescribeAppInstanceCommand.ts b/clients/client-chime/commands/DescribeAppInstanceCommand.ts index 64db48afe9d5..3cbae3b20de9 100644 --- a/clients/client-chime/commands/DescribeAppInstanceCommand.ts +++ b/clients/client-chime/commands/DescribeAppInstanceCommand.ts @@ -22,6 +22,20 @@ export interface DescribeAppInstanceCommandOutput extends DescribeAppInstanceRes /** *

Returns the full details of an AppInstance.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ChimeClient, DescribeAppInstanceCommand } from "@aws-sdk/client-chime"; // ES Modules import + * // const { ChimeClient, DescribeAppInstanceCommand } = require("@aws-sdk/client-chime"); // CommonJS import + * const client = new ChimeClient(config); + * const command = new DescribeAppInstanceCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeAppInstanceCommandInput} for command's `input` shape. + * @see {@link DescribeAppInstanceCommandOutput} for command's `response` shape. + * @see {@link ChimeClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeAppInstanceCommand extends $Command< DescribeAppInstanceCommandInput, diff --git a/clients/client-chime/commands/DescribeAppInstanceUserCommand.ts b/clients/client-chime/commands/DescribeAppInstanceUserCommand.ts index f134db6f8314..b48be7e2a882 100644 --- a/clients/client-chime/commands/DescribeAppInstanceUserCommand.ts +++ b/clients/client-chime/commands/DescribeAppInstanceUserCommand.ts @@ -26,6 +26,20 @@ export interface DescribeAppInstanceUserCommandOutput extends DescribeAppInstanc * AppInstanceUser * . *

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ChimeClient, DescribeAppInstanceUserCommand } from "@aws-sdk/client-chime"; // ES Modules import + * // const { ChimeClient, DescribeAppInstanceUserCommand } = require("@aws-sdk/client-chime"); // CommonJS import + * const client = new ChimeClient(config); + * const command = new DescribeAppInstanceUserCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeAppInstanceUserCommandInput} for command's `input` shape. + * @see {@link DescribeAppInstanceUserCommandOutput} for command's `response` shape. + * @see {@link ChimeClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeAppInstanceUserCommand extends $Command< DescribeAppInstanceUserCommandInput, diff --git a/clients/client-chime/commands/DescribeChannelBanCommand.ts b/clients/client-chime/commands/DescribeChannelBanCommand.ts index cf3d609353fb..222a3c1f5e66 100644 --- a/clients/client-chime/commands/DescribeChannelBanCommand.ts +++ b/clients/client-chime/commands/DescribeChannelBanCommand.ts @@ -28,6 +28,20 @@ export interface DescribeChannelBanCommandOutput extends DescribeChannelBanRespo *

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.

* + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ChimeClient, DescribeChannelBanCommand } from "@aws-sdk/client-chime"; // ES Modules import + * // const { ChimeClient, DescribeChannelBanCommand } = require("@aws-sdk/client-chime"); // CommonJS import + * const client = new ChimeClient(config); + * const command = new DescribeChannelBanCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeChannelBanCommandInput} for command's `input` shape. + * @see {@link DescribeChannelBanCommandOutput} for command's `response` shape. + * @see {@link ChimeClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeChannelBanCommand extends $Command< DescribeChannelBanCommandInput, diff --git a/clients/client-chime/commands/DescribeChannelCommand.ts b/clients/client-chime/commands/DescribeChannelCommand.ts index aed7abe5b55d..0033026debf4 100644 --- a/clients/client-chime/commands/DescribeChannelCommand.ts +++ b/clients/client-chime/commands/DescribeChannelCommand.ts @@ -28,6 +28,20 @@ export interface DescribeChannelCommandOutput extends DescribeChannelResponse, _ *

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.

* + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ChimeClient, DescribeChannelCommand } from "@aws-sdk/client-chime"; // ES Modules import + * // const { ChimeClient, DescribeChannelCommand } = require("@aws-sdk/client-chime"); // CommonJS import + * const client = new ChimeClient(config); + * const command = new DescribeChannelCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeChannelCommandInput} for command's `input` shape. + * @see {@link DescribeChannelCommandOutput} for command's `response` shape. + * @see {@link ChimeClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeChannelCommand extends $Command< DescribeChannelCommandInput, diff --git a/clients/client-chime/commands/DescribeChannelMembershipCommand.ts b/clients/client-chime/commands/DescribeChannelMembershipCommand.ts index 2ee3da8d4475..f0be8cd4f450 100644 --- a/clients/client-chime/commands/DescribeChannelMembershipCommand.ts +++ b/clients/client-chime/commands/DescribeChannelMembershipCommand.ts @@ -28,6 +28,20 @@ export interface DescribeChannelMembershipCommandOutput extends DescribeChannelM *

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.

* + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ChimeClient, DescribeChannelMembershipCommand } from "@aws-sdk/client-chime"; // ES Modules import + * // const { ChimeClient, DescribeChannelMembershipCommand } = require("@aws-sdk/client-chime"); // CommonJS import + * const client = new ChimeClient(config); + * const command = new DescribeChannelMembershipCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeChannelMembershipCommandInput} for command's `input` shape. + * @see {@link DescribeChannelMembershipCommandOutput} for command's `response` shape. + * @see {@link ChimeClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeChannelMembershipCommand extends $Command< DescribeChannelMembershipCommandInput, diff --git a/clients/client-chime/commands/DescribeChannelMembershipForAppInstanceUserCommand.ts b/clients/client-chime/commands/DescribeChannelMembershipForAppInstanceUserCommand.ts index b855f2054da1..68a4e7fbc2ec 100644 --- a/clients/client-chime/commands/DescribeChannelMembershipForAppInstanceUserCommand.ts +++ b/clients/client-chime/commands/DescribeChannelMembershipForAppInstanceUserCommand.ts @@ -34,6 +34,20 @@ export interface DescribeChannelMembershipForAppInstanceUserCommandOutput *

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.

* + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ChimeClient, DescribeChannelMembershipForAppInstanceUserCommand } from "@aws-sdk/client-chime"; // ES Modules import + * // const { ChimeClient, DescribeChannelMembershipForAppInstanceUserCommand } = require("@aws-sdk/client-chime"); // CommonJS import + * const client = new ChimeClient(config); + * const command = new DescribeChannelMembershipForAppInstanceUserCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeChannelMembershipForAppInstanceUserCommandInput} for command's `input` shape. + * @see {@link DescribeChannelMembershipForAppInstanceUserCommandOutput} for command's `response` shape. + * @see {@link ChimeClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeChannelMembershipForAppInstanceUserCommand extends $Command< DescribeChannelMembershipForAppInstanceUserCommandInput, diff --git a/clients/client-chime/commands/DescribeChannelModeratedByAppInstanceUserCommand.ts b/clients/client-chime/commands/DescribeChannelModeratedByAppInstanceUserCommand.ts index 732cb32cbad7..c4b90b2c12fd 100644 --- a/clients/client-chime/commands/DescribeChannelModeratedByAppInstanceUserCommand.ts +++ b/clients/client-chime/commands/DescribeChannelModeratedByAppInstanceUserCommand.ts @@ -33,6 +33,20 @@ export interface DescribeChannelModeratedByAppInstanceUserCommandOutput *

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.

* + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ChimeClient, DescribeChannelModeratedByAppInstanceUserCommand } from "@aws-sdk/client-chime"; // ES Modules import + * // const { ChimeClient, DescribeChannelModeratedByAppInstanceUserCommand } = require("@aws-sdk/client-chime"); // CommonJS import + * const client = new ChimeClient(config); + * const command = new DescribeChannelModeratedByAppInstanceUserCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeChannelModeratedByAppInstanceUserCommandInput} for command's `input` shape. + * @see {@link DescribeChannelModeratedByAppInstanceUserCommandOutput} for command's `response` shape. + * @see {@link ChimeClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeChannelModeratedByAppInstanceUserCommand extends $Command< DescribeChannelModeratedByAppInstanceUserCommandInput, diff --git a/clients/client-chime/commands/DescribeChannelModeratorCommand.ts b/clients/client-chime/commands/DescribeChannelModeratorCommand.ts index 42710173227f..251ccc74f631 100644 --- a/clients/client-chime/commands/DescribeChannelModeratorCommand.ts +++ b/clients/client-chime/commands/DescribeChannelModeratorCommand.ts @@ -28,6 +28,20 @@ export interface DescribeChannelModeratorCommandOutput extends DescribeChannelMo *

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.

* + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ChimeClient, DescribeChannelModeratorCommand } from "@aws-sdk/client-chime"; // ES Modules import + * // const { ChimeClient, DescribeChannelModeratorCommand } = require("@aws-sdk/client-chime"); // CommonJS import + * const client = new ChimeClient(config); + * const command = new DescribeChannelModeratorCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeChannelModeratorCommandInput} for command's `input` shape. + * @see {@link DescribeChannelModeratorCommandOutput} for command's `response` shape. + * @see {@link ChimeClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeChannelModeratorCommand extends $Command< DescribeChannelModeratorCommandInput, diff --git a/clients/client-chime/commands/DisassociatePhoneNumberFromUserCommand.ts b/clients/client-chime/commands/DisassociatePhoneNumberFromUserCommand.ts index d8e2b55c2436..d935d648e5dc 100644 --- a/clients/client-chime/commands/DisassociatePhoneNumberFromUserCommand.ts +++ b/clients/client-chime/commands/DisassociatePhoneNumberFromUserCommand.ts @@ -25,6 +25,20 @@ export interface DisassociatePhoneNumberFromUserCommandOutput /** *

Disassociates the primary provisioned phone number from the specified Amazon Chime * user.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ChimeClient, DisassociatePhoneNumberFromUserCommand } from "@aws-sdk/client-chime"; // ES Modules import + * // const { ChimeClient, DisassociatePhoneNumberFromUserCommand } = require("@aws-sdk/client-chime"); // CommonJS import + * const client = new ChimeClient(config); + * const command = new DisassociatePhoneNumberFromUserCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DisassociatePhoneNumberFromUserCommandInput} for command's `input` shape. + * @see {@link DisassociatePhoneNumberFromUserCommandOutput} for command's `response` shape. + * @see {@link ChimeClientResolvedConfig | config} for command's `input` shape. + * */ export class DisassociatePhoneNumberFromUserCommand extends $Command< DisassociatePhoneNumberFromUserCommandInput, diff --git a/clients/client-chime/commands/DisassociatePhoneNumbersFromVoiceConnectorCommand.ts b/clients/client-chime/commands/DisassociatePhoneNumbersFromVoiceConnectorCommand.ts index 89957f3d2747..786c14c6c9c6 100644 --- a/clients/client-chime/commands/DisassociatePhoneNumbersFromVoiceConnectorCommand.ts +++ b/clients/client-chime/commands/DisassociatePhoneNumbersFromVoiceConnectorCommand.ts @@ -28,6 +28,20 @@ export interface DisassociatePhoneNumbersFromVoiceConnectorCommandOutput /** *

Disassociates the specified phone numbers from the specified Amazon Chime Voice Connector.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ChimeClient, DisassociatePhoneNumbersFromVoiceConnectorCommand } from "@aws-sdk/client-chime"; // ES Modules import + * // const { ChimeClient, DisassociatePhoneNumbersFromVoiceConnectorCommand } = require("@aws-sdk/client-chime"); // CommonJS import + * const client = new ChimeClient(config); + * const command = new DisassociatePhoneNumbersFromVoiceConnectorCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DisassociatePhoneNumbersFromVoiceConnectorCommandInput} for command's `input` shape. + * @see {@link DisassociatePhoneNumbersFromVoiceConnectorCommandOutput} for command's `response` shape. + * @see {@link ChimeClientResolvedConfig | config} for command's `input` shape. + * */ export class DisassociatePhoneNumbersFromVoiceConnectorCommand extends $Command< DisassociatePhoneNumbersFromVoiceConnectorCommandInput, diff --git a/clients/client-chime/commands/DisassociatePhoneNumbersFromVoiceConnectorGroupCommand.ts b/clients/client-chime/commands/DisassociatePhoneNumbersFromVoiceConnectorGroupCommand.ts index de233977e356..141ac4df8506 100644 --- a/clients/client-chime/commands/DisassociatePhoneNumbersFromVoiceConnectorGroupCommand.ts +++ b/clients/client-chime/commands/DisassociatePhoneNumbersFromVoiceConnectorGroupCommand.ts @@ -28,6 +28,20 @@ export interface DisassociatePhoneNumbersFromVoiceConnectorGroupCommandOutput /** *

Disassociates the specified phone numbers from the specified Amazon Chime Voice Connector group.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ChimeClient, DisassociatePhoneNumbersFromVoiceConnectorGroupCommand } from "@aws-sdk/client-chime"; // ES Modules import + * // const { ChimeClient, DisassociatePhoneNumbersFromVoiceConnectorGroupCommand } = require("@aws-sdk/client-chime"); // CommonJS import + * const client = new ChimeClient(config); + * const command = new DisassociatePhoneNumbersFromVoiceConnectorGroupCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DisassociatePhoneNumbersFromVoiceConnectorGroupCommandInput} for command's `input` shape. + * @see {@link DisassociatePhoneNumbersFromVoiceConnectorGroupCommandOutput} for command's `response` shape. + * @see {@link ChimeClientResolvedConfig | config} for command's `input` shape. + * */ export class DisassociatePhoneNumbersFromVoiceConnectorGroupCommand extends $Command< DisassociatePhoneNumbersFromVoiceConnectorGroupCommandInput, diff --git a/clients/client-chime/commands/DisassociateSigninDelegateGroupsFromAccountCommand.ts b/clients/client-chime/commands/DisassociateSigninDelegateGroupsFromAccountCommand.ts index 261a4cd9adb6..c4673edbba63 100644 --- a/clients/client-chime/commands/DisassociateSigninDelegateGroupsFromAccountCommand.ts +++ b/clients/client-chime/commands/DisassociateSigninDelegateGroupsFromAccountCommand.ts @@ -28,6 +28,20 @@ export interface DisassociateSigninDelegateGroupsFromAccountCommandOutput /** *

Disassociates the specified sign-in delegate groups from the specified Amazon Chime account.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ChimeClient, DisassociateSigninDelegateGroupsFromAccountCommand } from "@aws-sdk/client-chime"; // ES Modules import + * // const { ChimeClient, DisassociateSigninDelegateGroupsFromAccountCommand } = require("@aws-sdk/client-chime"); // CommonJS import + * const client = new ChimeClient(config); + * const command = new DisassociateSigninDelegateGroupsFromAccountCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DisassociateSigninDelegateGroupsFromAccountCommandInput} for command's `input` shape. + * @see {@link DisassociateSigninDelegateGroupsFromAccountCommandOutput} for command's `response` shape. + * @see {@link ChimeClientResolvedConfig | config} for command's `input` shape. + * */ export class DisassociateSigninDelegateGroupsFromAccountCommand extends $Command< DisassociateSigninDelegateGroupsFromAccountCommandInput, diff --git a/clients/client-chime/commands/GetAccountCommand.ts b/clients/client-chime/commands/GetAccountCommand.ts index 637194c4952d..a7dbd0814af7 100644 --- a/clients/client-chime/commands/GetAccountCommand.ts +++ b/clients/client-chime/commands/GetAccountCommand.ts @@ -23,6 +23,20 @@ export interface GetAccountCommandOutput extends GetAccountResponse, __MetadataB /** *

Retrieves details for the specified Amazon Chime account, such as account type and supported * licenses.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ChimeClient, GetAccountCommand } from "@aws-sdk/client-chime"; // ES Modules import + * // const { ChimeClient, GetAccountCommand } = require("@aws-sdk/client-chime"); // CommonJS import + * const client = new ChimeClient(config); + * const command = new GetAccountCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetAccountCommandInput} for command's `input` shape. + * @see {@link GetAccountCommandOutput} for command's `response` shape. + * @see {@link ChimeClientResolvedConfig | config} for command's `input` shape. + * */ export class GetAccountCommand extends $Command< GetAccountCommandInput, diff --git a/clients/client-chime/commands/GetAccountSettingsCommand.ts b/clients/client-chime/commands/GetAccountSettingsCommand.ts index b6c6f6b3866f..7b7f007219e4 100644 --- a/clients/client-chime/commands/GetAccountSettingsCommand.ts +++ b/clients/client-chime/commands/GetAccountSettingsCommand.ts @@ -24,6 +24,20 @@ export interface GetAccountSettingsCommandOutput extends GetAccountSettingsRespo *

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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ChimeClient, GetAccountSettingsCommand } from "@aws-sdk/client-chime"; // ES Modules import + * // const { ChimeClient, GetAccountSettingsCommand } = require("@aws-sdk/client-chime"); // CommonJS import + * const client = new ChimeClient(config); + * const command = new GetAccountSettingsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetAccountSettingsCommandInput} for command's `input` shape. + * @see {@link GetAccountSettingsCommandOutput} for command's `response` shape. + * @see {@link ChimeClientResolvedConfig | config} for command's `input` shape. + * */ export class GetAccountSettingsCommand extends $Command< GetAccountSettingsCommandInput, diff --git a/clients/client-chime/commands/GetAppInstanceRetentionSettingsCommand.ts b/clients/client-chime/commands/GetAppInstanceRetentionSettingsCommand.ts index b1eae5a2fae1..4a3c18b0d8d0 100644 --- a/clients/client-chime/commands/GetAppInstanceRetentionSettingsCommand.ts +++ b/clients/client-chime/commands/GetAppInstanceRetentionSettingsCommand.ts @@ -24,6 +24,20 @@ export interface GetAppInstanceRetentionSettingsCommandOutput /** *

Gets the retention settings for an AppInstance.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ChimeClient, GetAppInstanceRetentionSettingsCommand } from "@aws-sdk/client-chime"; // ES Modules import + * // const { ChimeClient, GetAppInstanceRetentionSettingsCommand } = require("@aws-sdk/client-chime"); // CommonJS import + * const client = new ChimeClient(config); + * const command = new GetAppInstanceRetentionSettingsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetAppInstanceRetentionSettingsCommandInput} for command's `input` shape. + * @see {@link GetAppInstanceRetentionSettingsCommandOutput} for command's `response` shape. + * @see {@link ChimeClientResolvedConfig | config} for command's `input` shape. + * */ export class GetAppInstanceRetentionSettingsCommand extends $Command< GetAppInstanceRetentionSettingsCommandInput, diff --git a/clients/client-chime/commands/GetAppInstanceStreamingConfigurationsCommand.ts b/clients/client-chime/commands/GetAppInstanceStreamingConfigurationsCommand.ts index dfb01674abb0..800325702092 100644 --- a/clients/client-chime/commands/GetAppInstanceStreamingConfigurationsCommand.ts +++ b/clients/client-chime/commands/GetAppInstanceStreamingConfigurationsCommand.ts @@ -28,6 +28,20 @@ export interface GetAppInstanceStreamingConfigurationsCommandOutput /** *

Gets the streaming settings for an AppInstance.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ChimeClient, GetAppInstanceStreamingConfigurationsCommand } from "@aws-sdk/client-chime"; // ES Modules import + * // const { ChimeClient, GetAppInstanceStreamingConfigurationsCommand } = require("@aws-sdk/client-chime"); // CommonJS import + * const client = new ChimeClient(config); + * const command = new GetAppInstanceStreamingConfigurationsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetAppInstanceStreamingConfigurationsCommandInput} for command's `input` shape. + * @see {@link GetAppInstanceStreamingConfigurationsCommandOutput} for command's `response` shape. + * @see {@link ChimeClientResolvedConfig | config} for command's `input` shape. + * */ export class GetAppInstanceStreamingConfigurationsCommand extends $Command< GetAppInstanceStreamingConfigurationsCommandInput, diff --git a/clients/client-chime/commands/GetAttendeeCommand.ts b/clients/client-chime/commands/GetAttendeeCommand.ts index 94690729fba5..e76e28319291 100644 --- a/clients/client-chime/commands/GetAttendeeCommand.ts +++ b/clients/client-chime/commands/GetAttendeeCommand.ts @@ -28,6 +28,20 @@ export interface GetAttendeeCommandOutput extends GetAttendeeResponse, __Metadat * Amazon Chime Developer Guide * . *

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ChimeClient, GetAttendeeCommand } from "@aws-sdk/client-chime"; // ES Modules import + * // const { ChimeClient, GetAttendeeCommand } = require("@aws-sdk/client-chime"); // CommonJS import + * const client = new ChimeClient(config); + * const command = new GetAttendeeCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetAttendeeCommandInput} for command's `input` shape. + * @see {@link GetAttendeeCommandOutput} for command's `response` shape. + * @see {@link ChimeClientResolvedConfig | config} for command's `input` shape. + * */ export class GetAttendeeCommand extends $Command< GetAttendeeCommandInput, diff --git a/clients/client-chime/commands/GetBotCommand.ts b/clients/client-chime/commands/GetBotCommand.ts index ac47869ff4a6..184d27f2a3e3 100644 --- a/clients/client-chime/commands/GetBotCommand.ts +++ b/clients/client-chime/commands/GetBotCommand.ts @@ -19,6 +19,20 @@ export interface GetBotCommandOutput extends GetBotResponse, __MetadataBearer {} /** *

Retrieves details for the specified bot, such as bot email address, bot type, status, and display name.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ChimeClient, GetBotCommand } from "@aws-sdk/client-chime"; // ES Modules import + * // const { ChimeClient, GetBotCommand } = require("@aws-sdk/client-chime"); // CommonJS import + * const client = new ChimeClient(config); + * const command = new GetBotCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetBotCommandInput} for command's `input` shape. + * @see {@link GetBotCommandOutput} for command's `response` shape. + * @see {@link ChimeClientResolvedConfig | config} for command's `input` shape. + * */ export class GetBotCommand extends $Command { // Start section: command_properties diff --git a/clients/client-chime/commands/GetChannelMessageCommand.ts b/clients/client-chime/commands/GetChannelMessageCommand.ts index 127edc8fae8a..ec99ae4aa457 100644 --- a/clients/client-chime/commands/GetChannelMessageCommand.ts +++ b/clients/client-chime/commands/GetChannelMessageCommand.ts @@ -27,6 +27,20 @@ export interface GetChannelMessageCommandOutput extends GetChannelMessageRespons *

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.

* + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ChimeClient, GetChannelMessageCommand } from "@aws-sdk/client-chime"; // ES Modules import + * // const { ChimeClient, GetChannelMessageCommand } = require("@aws-sdk/client-chime"); // CommonJS import + * const client = new ChimeClient(config); + * const command = new GetChannelMessageCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetChannelMessageCommandInput} for command's `input` shape. + * @see {@link GetChannelMessageCommandOutput} for command's `response` shape. + * @see {@link ChimeClientResolvedConfig | config} for command's `input` shape. + * */ export class GetChannelMessageCommand extends $Command< GetChannelMessageCommandInput, diff --git a/clients/client-chime/commands/GetEventsConfigurationCommand.ts b/clients/client-chime/commands/GetEventsConfigurationCommand.ts index 2c244a014bd5..61c7aa2787a6 100644 --- a/clients/client-chime/commands/GetEventsConfigurationCommand.ts +++ b/clients/client-chime/commands/GetEventsConfigurationCommand.ts @@ -22,6 +22,20 @@ export interface GetEventsConfigurationCommandOutput extends GetEventsConfigurat /** *

Gets details for an events configuration that allows a bot to receive outgoing events, such as an HTTPS endpoint or Lambda function ARN.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ChimeClient, GetEventsConfigurationCommand } from "@aws-sdk/client-chime"; // ES Modules import + * // const { ChimeClient, GetEventsConfigurationCommand } = require("@aws-sdk/client-chime"); // CommonJS import + * const client = new ChimeClient(config); + * const command = new GetEventsConfigurationCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetEventsConfigurationCommandInput} for command's `input` shape. + * @see {@link GetEventsConfigurationCommandOutput} for command's `response` shape. + * @see {@link ChimeClientResolvedConfig | config} for command's `input` shape. + * */ export class GetEventsConfigurationCommand extends $Command< GetEventsConfigurationCommandInput, diff --git a/clients/client-chime/commands/GetGlobalSettingsCommand.ts b/clients/client-chime/commands/GetGlobalSettingsCommand.ts index 8020eb3eacc0..7d2a4f98b82f 100644 --- a/clients/client-chime/commands/GetGlobalSettingsCommand.ts +++ b/clients/client-chime/commands/GetGlobalSettingsCommand.ts @@ -23,6 +23,20 @@ export interface GetGlobalSettingsCommandOutput extends GetGlobalSettingsRespons /** *

Retrieves global settings for the administrator's AWS account, such as Amazon Chime Business * Calling and Amazon Chime Voice Connector settings.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ChimeClient, GetGlobalSettingsCommand } from "@aws-sdk/client-chime"; // ES Modules import + * // const { ChimeClient, GetGlobalSettingsCommand } = require("@aws-sdk/client-chime"); // CommonJS import + * const client = new ChimeClient(config); + * const command = new GetGlobalSettingsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetGlobalSettingsCommandInput} for command's `input` shape. + * @see {@link GetGlobalSettingsCommandOutput} for command's `response` shape. + * @see {@link ChimeClientResolvedConfig | config} for command's `input` shape. + * */ export class GetGlobalSettingsCommand extends $Command< GetGlobalSettingsCommandInput, diff --git a/clients/client-chime/commands/GetMeetingCommand.ts b/clients/client-chime/commands/GetMeetingCommand.ts index a95202fb48a7..2fd51a1828a4 100644 --- a/clients/client-chime/commands/GetMeetingCommand.ts +++ b/clients/client-chime/commands/GetMeetingCommand.ts @@ -28,6 +28,20 @@ export interface GetMeetingCommandOutput extends GetMeetingResponse, __MetadataB * Amazon Chime Developer Guide * . *

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ChimeClient, GetMeetingCommand } from "@aws-sdk/client-chime"; // ES Modules import + * // const { ChimeClient, GetMeetingCommand } = require("@aws-sdk/client-chime"); // CommonJS import + * const client = new ChimeClient(config); + * const command = new GetMeetingCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetMeetingCommandInput} for command's `input` shape. + * @see {@link GetMeetingCommandOutput} for command's `response` shape. + * @see {@link ChimeClientResolvedConfig | config} for command's `input` shape. + * */ export class GetMeetingCommand extends $Command< GetMeetingCommandInput, diff --git a/clients/client-chime/commands/GetMessagingSessionEndpointCommand.ts b/clients/client-chime/commands/GetMessagingSessionEndpointCommand.ts index df7e48245d1f..efa4d6cd7c49 100644 --- a/clients/client-chime/commands/GetMessagingSessionEndpointCommand.ts +++ b/clients/client-chime/commands/GetMessagingSessionEndpointCommand.ts @@ -24,6 +24,20 @@ export interface GetMessagingSessionEndpointCommandOutput /** *

The details of the endpoint for the messaging session.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ChimeClient, GetMessagingSessionEndpointCommand } from "@aws-sdk/client-chime"; // ES Modules import + * // const { ChimeClient, GetMessagingSessionEndpointCommand } = require("@aws-sdk/client-chime"); // CommonJS import + * const client = new ChimeClient(config); + * const command = new GetMessagingSessionEndpointCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetMessagingSessionEndpointCommandInput} for command's `input` shape. + * @see {@link GetMessagingSessionEndpointCommandOutput} for command's `response` shape. + * @see {@link ChimeClientResolvedConfig | config} for command's `input` shape. + * */ export class GetMessagingSessionEndpointCommand extends $Command< GetMessagingSessionEndpointCommandInput, diff --git a/clients/client-chime/commands/GetPhoneNumberCommand.ts b/clients/client-chime/commands/GetPhoneNumberCommand.ts index 531cbf3263cb..bf0a0c16faf1 100644 --- a/clients/client-chime/commands/GetPhoneNumberCommand.ts +++ b/clients/client-chime/commands/GetPhoneNumberCommand.ts @@ -22,6 +22,20 @@ export interface GetPhoneNumberCommandOutput extends GetPhoneNumberResponse, __M /** *

Retrieves details for the specified phone number ID, such as associations, capabilities, and product type.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ChimeClient, GetPhoneNumberCommand } from "@aws-sdk/client-chime"; // ES Modules import + * // const { ChimeClient, GetPhoneNumberCommand } = require("@aws-sdk/client-chime"); // CommonJS import + * const client = new ChimeClient(config); + * const command = new GetPhoneNumberCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetPhoneNumberCommandInput} for command's `input` shape. + * @see {@link GetPhoneNumberCommandOutput} for command's `response` shape. + * @see {@link ChimeClientResolvedConfig | config} for command's `input` shape. + * */ export class GetPhoneNumberCommand extends $Command< GetPhoneNumberCommandInput, diff --git a/clients/client-chime/commands/GetPhoneNumberOrderCommand.ts b/clients/client-chime/commands/GetPhoneNumberOrderCommand.ts index d5a8ead08c06..d2508feeafdf 100644 --- a/clients/client-chime/commands/GetPhoneNumberOrderCommand.ts +++ b/clients/client-chime/commands/GetPhoneNumberOrderCommand.ts @@ -23,6 +23,20 @@ export interface GetPhoneNumberOrderCommandOutput extends GetPhoneNumberOrderRes /** *

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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ChimeClient, GetPhoneNumberOrderCommand } from "@aws-sdk/client-chime"; // ES Modules import + * // const { ChimeClient, GetPhoneNumberOrderCommand } = require("@aws-sdk/client-chime"); // CommonJS import + * const client = new ChimeClient(config); + * const command = new GetPhoneNumberOrderCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetPhoneNumberOrderCommandInput} for command's `input` shape. + * @see {@link GetPhoneNumberOrderCommandOutput} for command's `response` shape. + * @see {@link ChimeClientResolvedConfig | config} for command's `input` shape. + * */ export class GetPhoneNumberOrderCommand extends $Command< GetPhoneNumberOrderCommandInput, diff --git a/clients/client-chime/commands/GetPhoneNumberSettingsCommand.ts b/clients/client-chime/commands/GetPhoneNumberSettingsCommand.ts index d191f1e7d4fc..567d0094f364 100644 --- a/clients/client-chime/commands/GetPhoneNumberSettingsCommand.ts +++ b/clients/client-chime/commands/GetPhoneNumberSettingsCommand.ts @@ -22,6 +22,20 @@ export interface GetPhoneNumberSettingsCommandOutput extends GetPhoneNumberSetti /** *

Retrieves the phone number settings for the administrator's AWS account, such as the default outbound calling name.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ChimeClient, GetPhoneNumberSettingsCommand } from "@aws-sdk/client-chime"; // ES Modules import + * // const { ChimeClient, GetPhoneNumberSettingsCommand } = require("@aws-sdk/client-chime"); // CommonJS import + * const client = new ChimeClient(config); + * const command = new GetPhoneNumberSettingsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetPhoneNumberSettingsCommandInput} for command's `input` shape. + * @see {@link GetPhoneNumberSettingsCommandOutput} for command's `response` shape. + * @see {@link ChimeClientResolvedConfig | config} for command's `input` shape. + * */ export class GetPhoneNumberSettingsCommand extends $Command< GetPhoneNumberSettingsCommandInput, diff --git a/clients/client-chime/commands/GetProxySessionCommand.ts b/clients/client-chime/commands/GetProxySessionCommand.ts index d29ede9f7b15..8e259411f0c0 100644 --- a/clients/client-chime/commands/GetProxySessionCommand.ts +++ b/clients/client-chime/commands/GetProxySessionCommand.ts @@ -22,6 +22,20 @@ export interface GetProxySessionCommandOutput extends GetProxySessionResponse, _ /** *

Gets the specified proxy session details for the specified Amazon Chime Voice Connector.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ChimeClient, GetProxySessionCommand } from "@aws-sdk/client-chime"; // ES Modules import + * // const { ChimeClient, GetProxySessionCommand } = require("@aws-sdk/client-chime"); // CommonJS import + * const client = new ChimeClient(config); + * const command = new GetProxySessionCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetProxySessionCommandInput} for command's `input` shape. + * @see {@link GetProxySessionCommandOutput} for command's `response` shape. + * @see {@link ChimeClientResolvedConfig | config} for command's `input` shape. + * */ export class GetProxySessionCommand extends $Command< GetProxySessionCommandInput, diff --git a/clients/client-chime/commands/GetRetentionSettingsCommand.ts b/clients/client-chime/commands/GetRetentionSettingsCommand.ts index af184c6f2202..a491b433a63d 100644 --- a/clients/client-chime/commands/GetRetentionSettingsCommand.ts +++ b/clients/client-chime/commands/GetRetentionSettingsCommand.ts @@ -28,6 +28,20 @@ export interface GetRetentionSettingsCommandOutput extends GetRetentionSettingsR * Amazon Chime Administration Guide * . *

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ChimeClient, GetRetentionSettingsCommand } from "@aws-sdk/client-chime"; // ES Modules import + * // const { ChimeClient, GetRetentionSettingsCommand } = require("@aws-sdk/client-chime"); // CommonJS import + * const client = new ChimeClient(config); + * const command = new GetRetentionSettingsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetRetentionSettingsCommandInput} for command's `input` shape. + * @see {@link GetRetentionSettingsCommandOutput} for command's `response` shape. + * @see {@link ChimeClientResolvedConfig | config} for command's `input` shape. + * */ export class GetRetentionSettingsCommand extends $Command< GetRetentionSettingsCommandInput, diff --git a/clients/client-chime/commands/GetRoomCommand.ts b/clients/client-chime/commands/GetRoomCommand.ts index fb2428073648..c0ea237476f6 100644 --- a/clients/client-chime/commands/GetRoomCommand.ts +++ b/clients/client-chime/commands/GetRoomCommand.ts @@ -22,6 +22,20 @@ export interface GetRoomCommandOutput extends GetRoomResponse, __MetadataBearer /** *

Retrieves room details, such as the room name, for a room in an Amazon Chime Enterprise account.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ChimeClient, GetRoomCommand } from "@aws-sdk/client-chime"; // ES Modules import + * // const { ChimeClient, GetRoomCommand } = require("@aws-sdk/client-chime"); // CommonJS import + * const client = new ChimeClient(config); + * const command = new GetRoomCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetRoomCommandInput} for command's `input` shape. + * @see {@link GetRoomCommandOutput} for command's `response` shape. + * @see {@link ChimeClientResolvedConfig | config} for command's `input` shape. + * */ export class GetRoomCommand extends $Command { // Start section: command_properties diff --git a/clients/client-chime/commands/GetSipMediaApplicationCommand.ts b/clients/client-chime/commands/GetSipMediaApplicationCommand.ts index e630dacfd5dc..a24ac53d9ef2 100644 --- a/clients/client-chime/commands/GetSipMediaApplicationCommand.ts +++ b/clients/client-chime/commands/GetSipMediaApplicationCommand.ts @@ -22,6 +22,20 @@ export interface GetSipMediaApplicationCommandOutput extends GetSipMediaApplicat /** *

Retrieves the information for a SIP media application, including name, AWS Region, and endpoints.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ChimeClient, GetSipMediaApplicationCommand } from "@aws-sdk/client-chime"; // ES Modules import + * // const { ChimeClient, GetSipMediaApplicationCommand } = require("@aws-sdk/client-chime"); // CommonJS import + * const client = new ChimeClient(config); + * const command = new GetSipMediaApplicationCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetSipMediaApplicationCommandInput} for command's `input` shape. + * @see {@link GetSipMediaApplicationCommandOutput} for command's `response` shape. + * @see {@link ChimeClientResolvedConfig | config} for command's `input` shape. + * */ export class GetSipMediaApplicationCommand extends $Command< GetSipMediaApplicationCommandInput, diff --git a/clients/client-chime/commands/GetSipMediaApplicationLoggingConfigurationCommand.ts b/clients/client-chime/commands/GetSipMediaApplicationLoggingConfigurationCommand.ts index 69f6f3fc9704..3cd2f3286bee 100644 --- a/clients/client-chime/commands/GetSipMediaApplicationLoggingConfigurationCommand.ts +++ b/clients/client-chime/commands/GetSipMediaApplicationLoggingConfigurationCommand.ts @@ -28,6 +28,20 @@ export interface GetSipMediaApplicationLoggingConfigurationCommandOutput /** *

Returns the logging configuration for the specified SIP media application.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ChimeClient, GetSipMediaApplicationLoggingConfigurationCommand } from "@aws-sdk/client-chime"; // ES Modules import + * // const { ChimeClient, GetSipMediaApplicationLoggingConfigurationCommand } = require("@aws-sdk/client-chime"); // CommonJS import + * const client = new ChimeClient(config); + * const command = new GetSipMediaApplicationLoggingConfigurationCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetSipMediaApplicationLoggingConfigurationCommandInput} for command's `input` shape. + * @see {@link GetSipMediaApplicationLoggingConfigurationCommandOutput} for command's `response` shape. + * @see {@link ChimeClientResolvedConfig | config} for command's `input` shape. + * */ export class GetSipMediaApplicationLoggingConfigurationCommand extends $Command< GetSipMediaApplicationLoggingConfigurationCommandInput, diff --git a/clients/client-chime/commands/GetSipRuleCommand.ts b/clients/client-chime/commands/GetSipRuleCommand.ts index 4fb745d1f32f..f987ab6fcb01 100644 --- a/clients/client-chime/commands/GetSipRuleCommand.ts +++ b/clients/client-chime/commands/GetSipRuleCommand.ts @@ -22,6 +22,20 @@ export interface GetSipRuleCommandOutput extends GetSipRuleResponse, __MetadataB /** *

Retrieves the details of a SIP rule, such as the rule ID, name, triggers, and target endpoints.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ChimeClient, GetSipRuleCommand } from "@aws-sdk/client-chime"; // ES Modules import + * // const { ChimeClient, GetSipRuleCommand } = require("@aws-sdk/client-chime"); // CommonJS import + * const client = new ChimeClient(config); + * const command = new GetSipRuleCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetSipRuleCommandInput} for command's `input` shape. + * @see {@link GetSipRuleCommandOutput} for command's `response` shape. + * @see {@link ChimeClientResolvedConfig | config} for command's `input` shape. + * */ export class GetSipRuleCommand extends $Command< GetSipRuleCommandInput, diff --git a/clients/client-chime/commands/GetUserCommand.ts b/clients/client-chime/commands/GetUserCommand.ts index 6c22198e737a..24cb1820217b 100644 --- a/clients/client-chime/commands/GetUserCommand.ts +++ b/clients/client-chime/commands/GetUserCommand.ts @@ -28,6 +28,20 @@ export interface GetUserCommandOutput extends GetUserResponse, __MetadataBearer * ListUsers * action, and then filter by email address. *

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ChimeClient, GetUserCommand } from "@aws-sdk/client-chime"; // ES Modules import + * // const { ChimeClient, GetUserCommand } = require("@aws-sdk/client-chime"); // CommonJS import + * const client = new ChimeClient(config); + * const command = new GetUserCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetUserCommandInput} for command's `input` shape. + * @see {@link GetUserCommandOutput} for command's `response` shape. + * @see {@link ChimeClientResolvedConfig | config} for command's `input` shape. + * */ export class GetUserCommand extends $Command { // Start section: command_properties diff --git a/clients/client-chime/commands/GetUserSettingsCommand.ts b/clients/client-chime/commands/GetUserSettingsCommand.ts index acd40588e696..6f0cebcde844 100644 --- a/clients/client-chime/commands/GetUserSettingsCommand.ts +++ b/clients/client-chime/commands/GetUserSettingsCommand.ts @@ -22,6 +22,20 @@ export interface GetUserSettingsCommandOutput extends GetUserSettingsResponse, _ /** *

Retrieves settings for the specified user ID, such as any associated phone number settings.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ChimeClient, GetUserSettingsCommand } from "@aws-sdk/client-chime"; // ES Modules import + * // const { ChimeClient, GetUserSettingsCommand } = require("@aws-sdk/client-chime"); // CommonJS import + * const client = new ChimeClient(config); + * const command = new GetUserSettingsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetUserSettingsCommandInput} for command's `input` shape. + * @see {@link GetUserSettingsCommandOutput} for command's `response` shape. + * @see {@link ChimeClientResolvedConfig | config} for command's `input` shape. + * */ export class GetUserSettingsCommand extends $Command< GetUserSettingsCommandInput, diff --git a/clients/client-chime/commands/GetVoiceConnectorCommand.ts b/clients/client-chime/commands/GetVoiceConnectorCommand.ts index 6e72b18798cc..13980f01fff2 100644 --- a/clients/client-chime/commands/GetVoiceConnectorCommand.ts +++ b/clients/client-chime/commands/GetVoiceConnectorCommand.ts @@ -22,6 +22,20 @@ export interface GetVoiceConnectorCommandOutput extends GetVoiceConnectorRespons /** *

Retrieves details for the specified Amazon Chime Voice Connector, such as timestamps,name, outbound host, and encryption requirements.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ChimeClient, GetVoiceConnectorCommand } from "@aws-sdk/client-chime"; // ES Modules import + * // const { ChimeClient, GetVoiceConnectorCommand } = require("@aws-sdk/client-chime"); // CommonJS import + * const client = new ChimeClient(config); + * const command = new GetVoiceConnectorCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetVoiceConnectorCommandInput} for command's `input` shape. + * @see {@link GetVoiceConnectorCommandOutput} for command's `response` shape. + * @see {@link ChimeClientResolvedConfig | config} for command's `input` shape. + * */ export class GetVoiceConnectorCommand extends $Command< GetVoiceConnectorCommandInput, diff --git a/clients/client-chime/commands/GetVoiceConnectorEmergencyCallingConfigurationCommand.ts b/clients/client-chime/commands/GetVoiceConnectorEmergencyCallingConfigurationCommand.ts index bb55d8ac49c6..662bb991fd11 100644 --- a/clients/client-chime/commands/GetVoiceConnectorEmergencyCallingConfigurationCommand.ts +++ b/clients/client-chime/commands/GetVoiceConnectorEmergencyCallingConfigurationCommand.ts @@ -28,6 +28,20 @@ export interface GetVoiceConnectorEmergencyCallingConfigurationCommandOutput /** *

Gets the emergency calling configuration details for the specified Amazon Chime Voice Connector.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ChimeClient, GetVoiceConnectorEmergencyCallingConfigurationCommand } from "@aws-sdk/client-chime"; // ES Modules import + * // const { ChimeClient, GetVoiceConnectorEmergencyCallingConfigurationCommand } = require("@aws-sdk/client-chime"); // CommonJS import + * const client = new ChimeClient(config); + * const command = new GetVoiceConnectorEmergencyCallingConfigurationCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetVoiceConnectorEmergencyCallingConfigurationCommandInput} for command's `input` shape. + * @see {@link GetVoiceConnectorEmergencyCallingConfigurationCommandOutput} for command's `response` shape. + * @see {@link ChimeClientResolvedConfig | config} for command's `input` shape. + * */ export class GetVoiceConnectorEmergencyCallingConfigurationCommand extends $Command< GetVoiceConnectorEmergencyCallingConfigurationCommandInput, diff --git a/clients/client-chime/commands/GetVoiceConnectorGroupCommand.ts b/clients/client-chime/commands/GetVoiceConnectorGroupCommand.ts index dd6e9cb7fc4d..c2a43aab6c32 100644 --- a/clients/client-chime/commands/GetVoiceConnectorGroupCommand.ts +++ b/clients/client-chime/commands/GetVoiceConnectorGroupCommand.ts @@ -26,6 +26,20 @@ export interface GetVoiceConnectorGroupCommandOutput extends GetVoiceConnectorGr * VoiceConnectorItems * . *

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ChimeClient, GetVoiceConnectorGroupCommand } from "@aws-sdk/client-chime"; // ES Modules import + * // const { ChimeClient, GetVoiceConnectorGroupCommand } = require("@aws-sdk/client-chime"); // CommonJS import + * const client = new ChimeClient(config); + * const command = new GetVoiceConnectorGroupCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetVoiceConnectorGroupCommandInput} for command's `input` shape. + * @see {@link GetVoiceConnectorGroupCommandOutput} for command's `response` shape. + * @see {@link ChimeClientResolvedConfig | config} for command's `input` shape. + * */ export class GetVoiceConnectorGroupCommand extends $Command< GetVoiceConnectorGroupCommandInput, diff --git a/clients/client-chime/commands/GetVoiceConnectorLoggingConfigurationCommand.ts b/clients/client-chime/commands/GetVoiceConnectorLoggingConfigurationCommand.ts index a7b8af6a4efd..8f54f3d4cc02 100644 --- a/clients/client-chime/commands/GetVoiceConnectorLoggingConfigurationCommand.ts +++ b/clients/client-chime/commands/GetVoiceConnectorLoggingConfigurationCommand.ts @@ -28,6 +28,20 @@ export interface GetVoiceConnectorLoggingConfigurationCommandOutput /** *

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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ChimeClient, GetVoiceConnectorLoggingConfigurationCommand } from "@aws-sdk/client-chime"; // ES Modules import + * // const { ChimeClient, GetVoiceConnectorLoggingConfigurationCommand } = require("@aws-sdk/client-chime"); // CommonJS import + * const client = new ChimeClient(config); + * const command = new GetVoiceConnectorLoggingConfigurationCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetVoiceConnectorLoggingConfigurationCommandInput} for command's `input` shape. + * @see {@link GetVoiceConnectorLoggingConfigurationCommandOutput} for command's `response` shape. + * @see {@link ChimeClientResolvedConfig | config} for command's `input` shape. + * */ export class GetVoiceConnectorLoggingConfigurationCommand extends $Command< GetVoiceConnectorLoggingConfigurationCommandInput, diff --git a/clients/client-chime/commands/GetVoiceConnectorOriginationCommand.ts b/clients/client-chime/commands/GetVoiceConnectorOriginationCommand.ts index e8b1a41296ad..e121d49cb2db 100644 --- a/clients/client-chime/commands/GetVoiceConnectorOriginationCommand.ts +++ b/clients/client-chime/commands/GetVoiceConnectorOriginationCommand.ts @@ -24,6 +24,20 @@ export interface GetVoiceConnectorOriginationCommandOutput /** *

Retrieves origination setting details for the specified Amazon Chime Voice Connector.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ChimeClient, GetVoiceConnectorOriginationCommand } from "@aws-sdk/client-chime"; // ES Modules import + * // const { ChimeClient, GetVoiceConnectorOriginationCommand } = require("@aws-sdk/client-chime"); // CommonJS import + * const client = new ChimeClient(config); + * const command = new GetVoiceConnectorOriginationCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetVoiceConnectorOriginationCommandInput} for command's `input` shape. + * @see {@link GetVoiceConnectorOriginationCommandOutput} for command's `response` shape. + * @see {@link ChimeClientResolvedConfig | config} for command's `input` shape. + * */ export class GetVoiceConnectorOriginationCommand extends $Command< GetVoiceConnectorOriginationCommandInput, diff --git a/clients/client-chime/commands/GetVoiceConnectorProxyCommand.ts b/clients/client-chime/commands/GetVoiceConnectorProxyCommand.ts index e91cea7600ac..1427a2810670 100644 --- a/clients/client-chime/commands/GetVoiceConnectorProxyCommand.ts +++ b/clients/client-chime/commands/GetVoiceConnectorProxyCommand.ts @@ -22,6 +22,20 @@ export interface GetVoiceConnectorProxyCommandOutput extends GetVoiceConnectorPr /** *

Gets the proxy configuration details for the specified Amazon Chime Voice Connector.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ChimeClient, GetVoiceConnectorProxyCommand } from "@aws-sdk/client-chime"; // ES Modules import + * // const { ChimeClient, GetVoiceConnectorProxyCommand } = require("@aws-sdk/client-chime"); // CommonJS import + * const client = new ChimeClient(config); + * const command = new GetVoiceConnectorProxyCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetVoiceConnectorProxyCommandInput} for command's `input` shape. + * @see {@link GetVoiceConnectorProxyCommandOutput} for command's `response` shape. + * @see {@link ChimeClientResolvedConfig | config} for command's `input` shape. + * */ export class GetVoiceConnectorProxyCommand extends $Command< GetVoiceConnectorProxyCommandInput, diff --git a/clients/client-chime/commands/GetVoiceConnectorStreamingConfigurationCommand.ts b/clients/client-chime/commands/GetVoiceConnectorStreamingConfigurationCommand.ts index 69579f24f086..99258cfca047 100644 --- a/clients/client-chime/commands/GetVoiceConnectorStreamingConfigurationCommand.ts +++ b/clients/client-chime/commands/GetVoiceConnectorStreamingConfigurationCommand.ts @@ -30,6 +30,20 @@ export interface GetVoiceConnectorStreamingConfigurationCommandOutput *

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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ChimeClient, GetVoiceConnectorStreamingConfigurationCommand } from "@aws-sdk/client-chime"; // ES Modules import + * // const { ChimeClient, GetVoiceConnectorStreamingConfigurationCommand } = require("@aws-sdk/client-chime"); // CommonJS import + * const client = new ChimeClient(config); + * const command = new GetVoiceConnectorStreamingConfigurationCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetVoiceConnectorStreamingConfigurationCommandInput} for command's `input` shape. + * @see {@link GetVoiceConnectorStreamingConfigurationCommandOutput} for command's `response` shape. + * @see {@link ChimeClientResolvedConfig | config} for command's `input` shape. + * */ export class GetVoiceConnectorStreamingConfigurationCommand extends $Command< GetVoiceConnectorStreamingConfigurationCommandInput, diff --git a/clients/client-chime/commands/GetVoiceConnectorTerminationCommand.ts b/clients/client-chime/commands/GetVoiceConnectorTerminationCommand.ts index ca886353049c..9268b4707d3f 100644 --- a/clients/client-chime/commands/GetVoiceConnectorTerminationCommand.ts +++ b/clients/client-chime/commands/GetVoiceConnectorTerminationCommand.ts @@ -24,6 +24,20 @@ export interface GetVoiceConnectorTerminationCommandOutput /** *

Retrieves termination setting details for the specified Amazon Chime Voice Connector.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ChimeClient, GetVoiceConnectorTerminationCommand } from "@aws-sdk/client-chime"; // ES Modules import + * // const { ChimeClient, GetVoiceConnectorTerminationCommand } = require("@aws-sdk/client-chime"); // CommonJS import + * const client = new ChimeClient(config); + * const command = new GetVoiceConnectorTerminationCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetVoiceConnectorTerminationCommandInput} for command's `input` shape. + * @see {@link GetVoiceConnectorTerminationCommandOutput} for command's `response` shape. + * @see {@link ChimeClientResolvedConfig | config} for command's `input` shape. + * */ export class GetVoiceConnectorTerminationCommand extends $Command< GetVoiceConnectorTerminationCommandInput, diff --git a/clients/client-chime/commands/GetVoiceConnectorTerminationHealthCommand.ts b/clients/client-chime/commands/GetVoiceConnectorTerminationHealthCommand.ts index 8fd0b5efd27a..c0bc02ad17a6 100644 --- a/clients/client-chime/commands/GetVoiceConnectorTerminationHealthCommand.ts +++ b/clients/client-chime/commands/GetVoiceConnectorTerminationHealthCommand.ts @@ -28,6 +28,20 @@ export interface GetVoiceConnectorTerminationHealthCommandOutput /** *

Retrieves information about the last time a SIP OPTIONS ping was received from * your SIP infrastructure for the specified Amazon Chime Voice Connector.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ChimeClient, GetVoiceConnectorTerminationHealthCommand } from "@aws-sdk/client-chime"; // ES Modules import + * // const { ChimeClient, GetVoiceConnectorTerminationHealthCommand } = require("@aws-sdk/client-chime"); // CommonJS import + * const client = new ChimeClient(config); + * const command = new GetVoiceConnectorTerminationHealthCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetVoiceConnectorTerminationHealthCommandInput} for command's `input` shape. + * @see {@link GetVoiceConnectorTerminationHealthCommandOutput} for command's `response` shape. + * @see {@link ChimeClientResolvedConfig | config} for command's `input` shape. + * */ export class GetVoiceConnectorTerminationHealthCommand extends $Command< GetVoiceConnectorTerminationHealthCommandInput, diff --git a/clients/client-chime/commands/InviteUsersCommand.ts b/clients/client-chime/commands/InviteUsersCommand.ts index 516f8fc7887c..00144ea056aa 100644 --- a/clients/client-chime/commands/InviteUsersCommand.ts +++ b/clients/client-chime/commands/InviteUsersCommand.ts @@ -24,6 +24,20 @@ export interface InviteUsersCommandOutput extends InviteUsersResponse, __Metadat *

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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ChimeClient, InviteUsersCommand } from "@aws-sdk/client-chime"; // ES Modules import + * // const { ChimeClient, InviteUsersCommand } = require("@aws-sdk/client-chime"); // CommonJS import + * const client = new ChimeClient(config); + * const command = new InviteUsersCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link InviteUsersCommandInput} for command's `input` shape. + * @see {@link InviteUsersCommandOutput} for command's `response` shape. + * @see {@link ChimeClientResolvedConfig | config} for command's `input` shape. + * */ export class InviteUsersCommand extends $Command< InviteUsersCommandInput, diff --git a/clients/client-chime/commands/ListAccountsCommand.ts b/clients/client-chime/commands/ListAccountsCommand.ts index 35976a2ff469..cba5c0e67e0e 100644 --- a/clients/client-chime/commands/ListAccountsCommand.ts +++ b/clients/client-chime/commands/ListAccountsCommand.ts @@ -24,6 +24,20 @@ export interface ListAccountsCommandOutput extends ListAccountsResponse, __Metad *

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, toucan * filter by the user's email address, which returns one account result.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ChimeClient, ListAccountsCommand } from "@aws-sdk/client-chime"; // ES Modules import + * // const { ChimeClient, ListAccountsCommand } = require("@aws-sdk/client-chime"); // CommonJS import + * const client = new ChimeClient(config); + * const command = new ListAccountsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListAccountsCommandInput} for command's `input` shape. + * @see {@link ListAccountsCommandOutput} for command's `response` shape. + * @see {@link ChimeClientResolvedConfig | config} for command's `input` shape. + * */ export class ListAccountsCommand extends $Command< ListAccountsCommandInput, diff --git a/clients/client-chime/commands/ListAppInstanceAdminsCommand.ts b/clients/client-chime/commands/ListAppInstanceAdminsCommand.ts index 56dfbb122668..b11b2def1c44 100644 --- a/clients/client-chime/commands/ListAppInstanceAdminsCommand.ts +++ b/clients/client-chime/commands/ListAppInstanceAdminsCommand.ts @@ -22,6 +22,20 @@ export interface ListAppInstanceAdminsCommandOutput extends ListAppInstanceAdmin /** *

Returns a list of the administrators in the AppInstance.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ChimeClient, ListAppInstanceAdminsCommand } from "@aws-sdk/client-chime"; // ES Modules import + * // const { ChimeClient, ListAppInstanceAdminsCommand } = require("@aws-sdk/client-chime"); // CommonJS import + * const client = new ChimeClient(config); + * const command = new ListAppInstanceAdminsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListAppInstanceAdminsCommandInput} for command's `input` shape. + * @see {@link ListAppInstanceAdminsCommandOutput} for command's `response` shape. + * @see {@link ChimeClientResolvedConfig | config} for command's `input` shape. + * */ export class ListAppInstanceAdminsCommand extends $Command< ListAppInstanceAdminsCommandInput, diff --git a/clients/client-chime/commands/ListAppInstanceUsersCommand.ts b/clients/client-chime/commands/ListAppInstanceUsersCommand.ts index 0a6b73c1b7ac..77f94fa902a9 100644 --- a/clients/client-chime/commands/ListAppInstanceUsersCommand.ts +++ b/clients/client-chime/commands/ListAppInstanceUsersCommand.ts @@ -26,6 +26,20 @@ export interface ListAppInstanceUsersCommandOutput extends ListAppInstanceUsersR * AppInstanceUsers * created under a single AppInstance. *

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ChimeClient, ListAppInstanceUsersCommand } from "@aws-sdk/client-chime"; // ES Modules import + * // const { ChimeClient, ListAppInstanceUsersCommand } = require("@aws-sdk/client-chime"); // CommonJS import + * const client = new ChimeClient(config); + * const command = new ListAppInstanceUsersCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListAppInstanceUsersCommandInput} for command's `input` shape. + * @see {@link ListAppInstanceUsersCommandOutput} for command's `response` shape. + * @see {@link ChimeClientResolvedConfig | config} for command's `input` shape. + * */ export class ListAppInstanceUsersCommand extends $Command< ListAppInstanceUsersCommandInput, diff --git a/clients/client-chime/commands/ListAppInstancesCommand.ts b/clients/client-chime/commands/ListAppInstancesCommand.ts index 3601b7dea75d..f3b9f3a73fdd 100644 --- a/clients/client-chime/commands/ListAppInstancesCommand.ts +++ b/clients/client-chime/commands/ListAppInstancesCommand.ts @@ -22,6 +22,20 @@ export interface ListAppInstancesCommandOutput extends ListAppInstancesResponse, /** *

Lists all Amazon Chime AppInstances created under a single AWS account.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ChimeClient, ListAppInstancesCommand } from "@aws-sdk/client-chime"; // ES Modules import + * // const { ChimeClient, ListAppInstancesCommand } = require("@aws-sdk/client-chime"); // CommonJS import + * const client = new ChimeClient(config); + * const command = new ListAppInstancesCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListAppInstancesCommandInput} for command's `input` shape. + * @see {@link ListAppInstancesCommandOutput} for command's `response` shape. + * @see {@link ChimeClientResolvedConfig | config} for command's `input` shape. + * */ export class ListAppInstancesCommand extends $Command< ListAppInstancesCommandInput, diff --git a/clients/client-chime/commands/ListAttendeeTagsCommand.ts b/clients/client-chime/commands/ListAttendeeTagsCommand.ts index 02e9c4221eb2..ae54144aacb3 100644 --- a/clients/client-chime/commands/ListAttendeeTagsCommand.ts +++ b/clients/client-chime/commands/ListAttendeeTagsCommand.ts @@ -22,6 +22,20 @@ export interface ListAttendeeTagsCommandOutput extends ListAttendeeTagsResponse, /** *

Lists the tags applied to an Amazon Chime SDK attendee resource.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ChimeClient, ListAttendeeTagsCommand } from "@aws-sdk/client-chime"; // ES Modules import + * // const { ChimeClient, ListAttendeeTagsCommand } = require("@aws-sdk/client-chime"); // CommonJS import + * const client = new ChimeClient(config); + * const command = new ListAttendeeTagsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListAttendeeTagsCommandInput} for command's `input` shape. + * @see {@link ListAttendeeTagsCommandOutput} for command's `response` shape. + * @see {@link ChimeClientResolvedConfig | config} for command's `input` shape. + * */ export class ListAttendeeTagsCommand extends $Command< ListAttendeeTagsCommandInput, diff --git a/clients/client-chime/commands/ListAttendeesCommand.ts b/clients/client-chime/commands/ListAttendeesCommand.ts index 62178b10f245..79ef4ce803a7 100644 --- a/clients/client-chime/commands/ListAttendeesCommand.ts +++ b/clients/client-chime/commands/ListAttendeesCommand.ts @@ -28,6 +28,20 @@ export interface ListAttendeesCommandOutput extends ListAttendeesResponse, __Met * Amazon Chime Developer Guide * . *

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ChimeClient, ListAttendeesCommand } from "@aws-sdk/client-chime"; // ES Modules import + * // const { ChimeClient, ListAttendeesCommand } = require("@aws-sdk/client-chime"); // CommonJS import + * const client = new ChimeClient(config); + * const command = new ListAttendeesCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListAttendeesCommandInput} for command's `input` shape. + * @see {@link ListAttendeesCommandOutput} for command's `response` shape. + * @see {@link ChimeClientResolvedConfig | config} for command's `input` shape. + * */ export class ListAttendeesCommand extends $Command< ListAttendeesCommandInput, diff --git a/clients/client-chime/commands/ListBotsCommand.ts b/clients/client-chime/commands/ListBotsCommand.ts index 85233567ce57..8787074e7970 100644 --- a/clients/client-chime/commands/ListBotsCommand.ts +++ b/clients/client-chime/commands/ListBotsCommand.ts @@ -22,6 +22,20 @@ export interface ListBotsCommandOutput extends ListBotsResponse, __MetadataBeare /** *

Lists the bots associated with the administrator's Amazon Chime Enterprise account ID.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ChimeClient, ListBotsCommand } from "@aws-sdk/client-chime"; // ES Modules import + * // const { ChimeClient, ListBotsCommand } = require("@aws-sdk/client-chime"); // CommonJS import + * const client = new ChimeClient(config); + * const command = new ListBotsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListBotsCommandInput} for command's `input` shape. + * @see {@link ListBotsCommandOutput} for command's `response` shape. + * @see {@link ChimeClientResolvedConfig | config} for command's `input` shape. + * */ export class ListBotsCommand extends $Command { // Start section: command_properties diff --git a/clients/client-chime/commands/ListChannelBansCommand.ts b/clients/client-chime/commands/ListChannelBansCommand.ts index 640f013516c4..7a621b6eb186 100644 --- a/clients/client-chime/commands/ListChannelBansCommand.ts +++ b/clients/client-chime/commands/ListChannelBansCommand.ts @@ -28,6 +28,20 @@ export interface ListChannelBansCommandOutput extends ListChannelBansResponse, _ *

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.

* + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ChimeClient, ListChannelBansCommand } from "@aws-sdk/client-chime"; // ES Modules import + * // const { ChimeClient, ListChannelBansCommand } = require("@aws-sdk/client-chime"); // CommonJS import + * const client = new ChimeClient(config); + * const command = new ListChannelBansCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListChannelBansCommandInput} for command's `input` shape. + * @see {@link ListChannelBansCommandOutput} for command's `response` shape. + * @see {@link ChimeClientResolvedConfig | config} for command's `input` shape. + * */ export class ListChannelBansCommand extends $Command< ListChannelBansCommandInput, diff --git a/clients/client-chime/commands/ListChannelMembershipsCommand.ts b/clients/client-chime/commands/ListChannelMembershipsCommand.ts index cfebf9d44fc3..25046fc0df4e 100644 --- a/clients/client-chime/commands/ListChannelMembershipsCommand.ts +++ b/clients/client-chime/commands/ListChannelMembershipsCommand.ts @@ -28,6 +28,20 @@ export interface ListChannelMembershipsCommandOutput extends ListChannelMembersh *

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.

* + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ChimeClient, ListChannelMembershipsCommand } from "@aws-sdk/client-chime"; // ES Modules import + * // const { ChimeClient, ListChannelMembershipsCommand } = require("@aws-sdk/client-chime"); // CommonJS import + * const client = new ChimeClient(config); + * const command = new ListChannelMembershipsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListChannelMembershipsCommandInput} for command's `input` shape. + * @see {@link ListChannelMembershipsCommandOutput} for command's `response` shape. + * @see {@link ChimeClientResolvedConfig | config} for command's `input` shape. + * */ export class ListChannelMembershipsCommand extends $Command< ListChannelMembershipsCommandInput, diff --git a/clients/client-chime/commands/ListChannelMembershipsForAppInstanceUserCommand.ts b/clients/client-chime/commands/ListChannelMembershipsForAppInstanceUserCommand.ts index 27d1dac2f6fc..a4511619508d 100644 --- a/clients/client-chime/commands/ListChannelMembershipsForAppInstanceUserCommand.ts +++ b/clients/client-chime/commands/ListChannelMembershipsForAppInstanceUserCommand.ts @@ -36,6 +36,20 @@ export interface ListChannelMembershipsForAppInstanceUserCommandOutput *

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.

* + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ChimeClient, ListChannelMembershipsForAppInstanceUserCommand } from "@aws-sdk/client-chime"; // ES Modules import + * // const { ChimeClient, ListChannelMembershipsForAppInstanceUserCommand } = require("@aws-sdk/client-chime"); // CommonJS import + * const client = new ChimeClient(config); + * const command = new ListChannelMembershipsForAppInstanceUserCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListChannelMembershipsForAppInstanceUserCommandInput} for command's `input` shape. + * @see {@link ListChannelMembershipsForAppInstanceUserCommandOutput} for command's `response` shape. + * @see {@link ChimeClientResolvedConfig | config} for command's `input` shape. + * */ export class ListChannelMembershipsForAppInstanceUserCommand extends $Command< ListChannelMembershipsForAppInstanceUserCommandInput, diff --git a/clients/client-chime/commands/ListChannelMessagesCommand.ts b/clients/client-chime/commands/ListChannelMessagesCommand.ts index 0cfee7c6e72b..18e5551c5cc2 100644 --- a/clients/client-chime/commands/ListChannelMessagesCommand.ts +++ b/clients/client-chime/commands/ListChannelMessagesCommand.ts @@ -31,6 +31,20 @@ export interface ListChannelMessagesCommandOutput extends ListChannelMessagesRes *

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.

* + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ChimeClient, ListChannelMessagesCommand } from "@aws-sdk/client-chime"; // ES Modules import + * // const { ChimeClient, ListChannelMessagesCommand } = require("@aws-sdk/client-chime"); // CommonJS import + * const client = new ChimeClient(config); + * const command = new ListChannelMessagesCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListChannelMessagesCommandInput} for command's `input` shape. + * @see {@link ListChannelMessagesCommandOutput} for command's `response` shape. + * @see {@link ChimeClientResolvedConfig | config} for command's `input` shape. + * */ export class ListChannelMessagesCommand extends $Command< ListChannelMessagesCommandInput, diff --git a/clients/client-chime/commands/ListChannelModeratorsCommand.ts b/clients/client-chime/commands/ListChannelModeratorsCommand.ts index 2504eb3d0812..911e7392b73e 100644 --- a/clients/client-chime/commands/ListChannelModeratorsCommand.ts +++ b/clients/client-chime/commands/ListChannelModeratorsCommand.ts @@ -28,6 +28,20 @@ export interface ListChannelModeratorsCommandOutput extends ListChannelModerator *

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.

* + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ChimeClient, ListChannelModeratorsCommand } from "@aws-sdk/client-chime"; // ES Modules import + * // const { ChimeClient, ListChannelModeratorsCommand } = require("@aws-sdk/client-chime"); // CommonJS import + * const client = new ChimeClient(config); + * const command = new ListChannelModeratorsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListChannelModeratorsCommandInput} for command's `input` shape. + * @see {@link ListChannelModeratorsCommandOutput} for command's `response` shape. + * @see {@link ChimeClientResolvedConfig | config} for command's `input` shape. + * */ export class ListChannelModeratorsCommand extends $Command< ListChannelModeratorsCommandInput, diff --git a/clients/client-chime/commands/ListChannelsCommand.ts b/clients/client-chime/commands/ListChannelsCommand.ts index 32a2df560063..39c463e04ecc 100644 --- a/clients/client-chime/commands/ListChannelsCommand.ts +++ b/clients/client-chime/commands/ListChannelsCommand.ts @@ -47,6 +47,20 @@ export interface ListChannelsCommandOutput extends ListChannelsResponse, __Metad *

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.

* + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ChimeClient, ListChannelsCommand } from "@aws-sdk/client-chime"; // ES Modules import + * // const { ChimeClient, ListChannelsCommand } = require("@aws-sdk/client-chime"); // CommonJS import + * const client = new ChimeClient(config); + * const command = new ListChannelsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListChannelsCommandInput} for command's `input` shape. + * @see {@link ListChannelsCommandOutput} for command's `response` shape. + * @see {@link ChimeClientResolvedConfig | config} for command's `input` shape. + * */ export class ListChannelsCommand extends $Command< ListChannelsCommandInput, diff --git a/clients/client-chime/commands/ListChannelsModeratedByAppInstanceUserCommand.ts b/clients/client-chime/commands/ListChannelsModeratedByAppInstanceUserCommand.ts index cfa8a88349d6..7f202df6a1d6 100644 --- a/clients/client-chime/commands/ListChannelsModeratedByAppInstanceUserCommand.ts +++ b/clients/client-chime/commands/ListChannelsModeratedByAppInstanceUserCommand.ts @@ -33,6 +33,20 @@ export interface ListChannelsModeratedByAppInstanceUserCommandOutput *

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.

* + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ChimeClient, ListChannelsModeratedByAppInstanceUserCommand } from "@aws-sdk/client-chime"; // ES Modules import + * // const { ChimeClient, ListChannelsModeratedByAppInstanceUserCommand } = require("@aws-sdk/client-chime"); // CommonJS import + * const client = new ChimeClient(config); + * const command = new ListChannelsModeratedByAppInstanceUserCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListChannelsModeratedByAppInstanceUserCommandInput} for command's `input` shape. + * @see {@link ListChannelsModeratedByAppInstanceUserCommandOutput} for command's `response` shape. + * @see {@link ChimeClientResolvedConfig | config} for command's `input` shape. + * */ export class ListChannelsModeratedByAppInstanceUserCommand extends $Command< ListChannelsModeratedByAppInstanceUserCommandInput, diff --git a/clients/client-chime/commands/ListMeetingTagsCommand.ts b/clients/client-chime/commands/ListMeetingTagsCommand.ts index 6483917a4af5..2ba797e45f93 100644 --- a/clients/client-chime/commands/ListMeetingTagsCommand.ts +++ b/clients/client-chime/commands/ListMeetingTagsCommand.ts @@ -22,6 +22,20 @@ export interface ListMeetingTagsCommandOutput extends ListMeetingTagsResponse, _ /** *

Lists the tags applied to an Amazon Chime SDK meeting resource.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ChimeClient, ListMeetingTagsCommand } from "@aws-sdk/client-chime"; // ES Modules import + * // const { ChimeClient, ListMeetingTagsCommand } = require("@aws-sdk/client-chime"); // CommonJS import + * const client = new ChimeClient(config); + * const command = new ListMeetingTagsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListMeetingTagsCommandInput} for command's `input` shape. + * @see {@link ListMeetingTagsCommandOutput} for command's `response` shape. + * @see {@link ChimeClientResolvedConfig | config} for command's `input` shape. + * */ export class ListMeetingTagsCommand extends $Command< ListMeetingTagsCommandInput, diff --git a/clients/client-chime/commands/ListMeetingsCommand.ts b/clients/client-chime/commands/ListMeetingsCommand.ts index 8d331a48aceb..343529bb309f 100644 --- a/clients/client-chime/commands/ListMeetingsCommand.ts +++ b/clients/client-chime/commands/ListMeetingsCommand.ts @@ -28,6 +28,20 @@ export interface ListMeetingsCommandOutput extends ListMeetingsResponse, __Metad * Amazon Chime Developer Guide * . *

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ChimeClient, ListMeetingsCommand } from "@aws-sdk/client-chime"; // ES Modules import + * // const { ChimeClient, ListMeetingsCommand } = require("@aws-sdk/client-chime"); // CommonJS import + * const client = new ChimeClient(config); + * const command = new ListMeetingsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListMeetingsCommandInput} for command's `input` shape. + * @see {@link ListMeetingsCommandOutput} for command's `response` shape. + * @see {@link ChimeClientResolvedConfig | config} for command's `input` shape. + * */ export class ListMeetingsCommand extends $Command< ListMeetingsCommandInput, diff --git a/clients/client-chime/commands/ListPhoneNumberOrdersCommand.ts b/clients/client-chime/commands/ListPhoneNumberOrdersCommand.ts index 6928dd471ec1..40aa2efe156c 100644 --- a/clients/client-chime/commands/ListPhoneNumberOrdersCommand.ts +++ b/clients/client-chime/commands/ListPhoneNumberOrdersCommand.ts @@ -22,6 +22,20 @@ export interface ListPhoneNumberOrdersCommandOutput extends ListPhoneNumberOrder /** *

Lists the phone number orders for the administrator's Amazon Chime account.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ChimeClient, ListPhoneNumberOrdersCommand } from "@aws-sdk/client-chime"; // ES Modules import + * // const { ChimeClient, ListPhoneNumberOrdersCommand } = require("@aws-sdk/client-chime"); // CommonJS import + * const client = new ChimeClient(config); + * const command = new ListPhoneNumberOrdersCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListPhoneNumberOrdersCommandInput} for command's `input` shape. + * @see {@link ListPhoneNumberOrdersCommandOutput} for command's `response` shape. + * @see {@link ChimeClientResolvedConfig | config} for command's `input` shape. + * */ export class ListPhoneNumberOrdersCommand extends $Command< ListPhoneNumberOrdersCommandInput, diff --git a/clients/client-chime/commands/ListPhoneNumbersCommand.ts b/clients/client-chime/commands/ListPhoneNumbersCommand.ts index 4dd69343fba4..1c416f2543d5 100644 --- a/clients/client-chime/commands/ListPhoneNumbersCommand.ts +++ b/clients/client-chime/commands/ListPhoneNumbersCommand.ts @@ -22,6 +22,20 @@ export interface ListPhoneNumbersCommandOutput extends ListPhoneNumbersResponse, /** *

Lists the phone numbers for the specified Amazon Chime account, Amazon Chime user, Amazon Chime Voice Connector, or Amazon Chime Voice Connector group.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ChimeClient, ListPhoneNumbersCommand } from "@aws-sdk/client-chime"; // ES Modules import + * // const { ChimeClient, ListPhoneNumbersCommand } = require("@aws-sdk/client-chime"); // CommonJS import + * const client = new ChimeClient(config); + * const command = new ListPhoneNumbersCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListPhoneNumbersCommandInput} for command's `input` shape. + * @see {@link ListPhoneNumbersCommandOutput} for command's `response` shape. + * @see {@link ChimeClientResolvedConfig | config} for command's `input` shape. + * */ export class ListPhoneNumbersCommand extends $Command< ListPhoneNumbersCommandInput, diff --git a/clients/client-chime/commands/ListProxySessionsCommand.ts b/clients/client-chime/commands/ListProxySessionsCommand.ts index bb33ba178cbb..405e4bb39ae0 100644 --- a/clients/client-chime/commands/ListProxySessionsCommand.ts +++ b/clients/client-chime/commands/ListProxySessionsCommand.ts @@ -22,6 +22,20 @@ export interface ListProxySessionsCommandOutput extends ListProxySessionsRespons /** *

Lists the proxy sessions for the specified Amazon Chime Voice Connector.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ChimeClient, ListProxySessionsCommand } from "@aws-sdk/client-chime"; // ES Modules import + * // const { ChimeClient, ListProxySessionsCommand } = require("@aws-sdk/client-chime"); // CommonJS import + * const client = new ChimeClient(config); + * const command = new ListProxySessionsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListProxySessionsCommandInput} for command's `input` shape. + * @see {@link ListProxySessionsCommandOutput} for command's `response` shape. + * @see {@link ChimeClientResolvedConfig | config} for command's `input` shape. + * */ export class ListProxySessionsCommand extends $Command< ListProxySessionsCommandInput, diff --git a/clients/client-chime/commands/ListRoomMembershipsCommand.ts b/clients/client-chime/commands/ListRoomMembershipsCommand.ts index dc0883e43a5d..c40158692737 100644 --- a/clients/client-chime/commands/ListRoomMembershipsCommand.ts +++ b/clients/client-chime/commands/ListRoomMembershipsCommand.ts @@ -23,6 +23,20 @@ export interface ListRoomMembershipsCommandOutput extends ListRoomMembershipsRes /** *

Lists the membership details for the specified room in an Amazon Chime Enterprise account, * such as the members' IDs, email addresses, and names.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ChimeClient, ListRoomMembershipsCommand } from "@aws-sdk/client-chime"; // ES Modules import + * // const { ChimeClient, ListRoomMembershipsCommand } = require("@aws-sdk/client-chime"); // CommonJS import + * const client = new ChimeClient(config); + * const command = new ListRoomMembershipsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListRoomMembershipsCommandInput} for command's `input` shape. + * @see {@link ListRoomMembershipsCommandOutput} for command's `response` shape. + * @see {@link ChimeClientResolvedConfig | config} for command's `input` shape. + * */ export class ListRoomMembershipsCommand extends $Command< ListRoomMembershipsCommandInput, diff --git a/clients/client-chime/commands/ListRoomsCommand.ts b/clients/client-chime/commands/ListRoomsCommand.ts index 2445e711c07e..a36be9cb4332 100644 --- a/clients/client-chime/commands/ListRoomsCommand.ts +++ b/clients/client-chime/commands/ListRoomsCommand.ts @@ -22,6 +22,20 @@ export interface ListRoomsCommandOutput extends ListRoomsResponse, __MetadataBea /** *

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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ChimeClient, ListRoomsCommand } from "@aws-sdk/client-chime"; // ES Modules import + * // const { ChimeClient, ListRoomsCommand } = require("@aws-sdk/client-chime"); // CommonJS import + * const client = new ChimeClient(config); + * const command = new ListRoomsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListRoomsCommandInput} for command's `input` shape. + * @see {@link ListRoomsCommandOutput} for command's `response` shape. + * @see {@link ChimeClientResolvedConfig | config} for command's `input` shape. + * */ export class ListRoomsCommand extends $Command< ListRoomsCommandInput, diff --git a/clients/client-chime/commands/ListSipMediaApplicationsCommand.ts b/clients/client-chime/commands/ListSipMediaApplicationsCommand.ts index 120a240170a4..a7402591d162 100644 --- a/clients/client-chime/commands/ListSipMediaApplicationsCommand.ts +++ b/clients/client-chime/commands/ListSipMediaApplicationsCommand.ts @@ -22,6 +22,20 @@ export interface ListSipMediaApplicationsCommandOutput extends ListSipMediaAppli /** *

Lists the SIP media applications under the administrator's AWS account.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ChimeClient, ListSipMediaApplicationsCommand } from "@aws-sdk/client-chime"; // ES Modules import + * // const { ChimeClient, ListSipMediaApplicationsCommand } = require("@aws-sdk/client-chime"); // CommonJS import + * const client = new ChimeClient(config); + * const command = new ListSipMediaApplicationsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListSipMediaApplicationsCommandInput} for command's `input` shape. + * @see {@link ListSipMediaApplicationsCommandOutput} for command's `response` shape. + * @see {@link ChimeClientResolvedConfig | config} for command's `input` shape. + * */ export class ListSipMediaApplicationsCommand extends $Command< ListSipMediaApplicationsCommandInput, diff --git a/clients/client-chime/commands/ListSipRulesCommand.ts b/clients/client-chime/commands/ListSipRulesCommand.ts index 1b064dbc850a..ab3b8043022f 100644 --- a/clients/client-chime/commands/ListSipRulesCommand.ts +++ b/clients/client-chime/commands/ListSipRulesCommand.ts @@ -22,6 +22,20 @@ export interface ListSipRulesCommandOutput extends ListSipRulesResponse, __Metad /** *

Lists the SIP rules under the administrator's AWS account.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ChimeClient, ListSipRulesCommand } from "@aws-sdk/client-chime"; // ES Modules import + * // const { ChimeClient, ListSipRulesCommand } = require("@aws-sdk/client-chime"); // CommonJS import + * const client = new ChimeClient(config); + * const command = new ListSipRulesCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListSipRulesCommandInput} for command's `input` shape. + * @see {@link ListSipRulesCommandOutput} for command's `response` shape. + * @see {@link ChimeClientResolvedConfig | config} for command's `input` shape. + * */ export class ListSipRulesCommand extends $Command< ListSipRulesCommandInput, diff --git a/clients/client-chime/commands/ListTagsForResourceCommand.ts b/clients/client-chime/commands/ListTagsForResourceCommand.ts index c34b1939e213..591117827e77 100644 --- a/clients/client-chime/commands/ListTagsForResourceCommand.ts +++ b/clients/client-chime/commands/ListTagsForResourceCommand.ts @@ -22,6 +22,20 @@ export interface ListTagsForResourceCommandOutput extends ListTagsForResourceRes /** *

Lists the tags applied to an Amazon Chime SDK meeting resource.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ChimeClient, ListTagsForResourceCommand } from "@aws-sdk/client-chime"; // ES Modules import + * // const { ChimeClient, ListTagsForResourceCommand } = require("@aws-sdk/client-chime"); // CommonJS import + * const client = new ChimeClient(config); + * const command = new ListTagsForResourceCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListTagsForResourceCommandInput} for command's `input` shape. + * @see {@link ListTagsForResourceCommandOutput} for command's `response` shape. + * @see {@link ChimeClientResolvedConfig | config} for command's `input` shape. + * */ export class ListTagsForResourceCommand extends $Command< ListTagsForResourceCommandInput, diff --git a/clients/client-chime/commands/ListUsersCommand.ts b/clients/client-chime/commands/ListUsersCommand.ts index e58dfb3229bd..e706e76bec90 100644 --- a/clients/client-chime/commands/ListUsersCommand.ts +++ b/clients/client-chime/commands/ListUsersCommand.ts @@ -23,6 +23,20 @@ export interface ListUsersCommandOutput extends ListUsersResponse, __MetadataBea /** *

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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ChimeClient, ListUsersCommand } from "@aws-sdk/client-chime"; // ES Modules import + * // const { ChimeClient, ListUsersCommand } = require("@aws-sdk/client-chime"); // CommonJS import + * const client = new ChimeClient(config); + * const command = new ListUsersCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListUsersCommandInput} for command's `input` shape. + * @see {@link ListUsersCommandOutput} for command's `response` shape. + * @see {@link ChimeClientResolvedConfig | config} for command's `input` shape. + * */ export class ListUsersCommand extends $Command< ListUsersCommandInput, diff --git a/clients/client-chime/commands/ListVoiceConnectorGroupsCommand.ts b/clients/client-chime/commands/ListVoiceConnectorGroupsCommand.ts index 311fe9306b85..2fdf3464c140 100644 --- a/clients/client-chime/commands/ListVoiceConnectorGroupsCommand.ts +++ b/clients/client-chime/commands/ListVoiceConnectorGroupsCommand.ts @@ -22,6 +22,20 @@ export interface ListVoiceConnectorGroupsCommandOutput extends ListVoiceConnecto /** *

Lists the Amazon Chime Voice Connector groups for the administrator's AWS account.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ChimeClient, ListVoiceConnectorGroupsCommand } from "@aws-sdk/client-chime"; // ES Modules import + * // const { ChimeClient, ListVoiceConnectorGroupsCommand } = require("@aws-sdk/client-chime"); // CommonJS import + * const client = new ChimeClient(config); + * const command = new ListVoiceConnectorGroupsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListVoiceConnectorGroupsCommandInput} for command's `input` shape. + * @see {@link ListVoiceConnectorGroupsCommandOutput} for command's `response` shape. + * @see {@link ChimeClientResolvedConfig | config} for command's `input` shape. + * */ export class ListVoiceConnectorGroupsCommand extends $Command< ListVoiceConnectorGroupsCommandInput, diff --git a/clients/client-chime/commands/ListVoiceConnectorTerminationCredentialsCommand.ts b/clients/client-chime/commands/ListVoiceConnectorTerminationCredentialsCommand.ts index 4a152d50de2e..a82f28acb288 100644 --- a/clients/client-chime/commands/ListVoiceConnectorTerminationCredentialsCommand.ts +++ b/clients/client-chime/commands/ListVoiceConnectorTerminationCredentialsCommand.ts @@ -28,6 +28,20 @@ export interface ListVoiceConnectorTerminationCredentialsCommandOutput /** *

Lists the SIP credentials for the specified Amazon Chime Voice Connector.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ChimeClient, ListVoiceConnectorTerminationCredentialsCommand } from "@aws-sdk/client-chime"; // ES Modules import + * // const { ChimeClient, ListVoiceConnectorTerminationCredentialsCommand } = require("@aws-sdk/client-chime"); // CommonJS import + * const client = new ChimeClient(config); + * const command = new ListVoiceConnectorTerminationCredentialsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListVoiceConnectorTerminationCredentialsCommandInput} for command's `input` shape. + * @see {@link ListVoiceConnectorTerminationCredentialsCommandOutput} for command's `response` shape. + * @see {@link ChimeClientResolvedConfig | config} for command's `input` shape. + * */ export class ListVoiceConnectorTerminationCredentialsCommand extends $Command< ListVoiceConnectorTerminationCredentialsCommandInput, diff --git a/clients/client-chime/commands/ListVoiceConnectorsCommand.ts b/clients/client-chime/commands/ListVoiceConnectorsCommand.ts index c5f110fb61bb..7cad42b17746 100644 --- a/clients/client-chime/commands/ListVoiceConnectorsCommand.ts +++ b/clients/client-chime/commands/ListVoiceConnectorsCommand.ts @@ -22,6 +22,20 @@ export interface ListVoiceConnectorsCommandOutput extends ListVoiceConnectorsRes /** *

Lists the Amazon Chime Voice Connectors for the administrator's AWS account.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ChimeClient, ListVoiceConnectorsCommand } from "@aws-sdk/client-chime"; // ES Modules import + * // const { ChimeClient, ListVoiceConnectorsCommand } = require("@aws-sdk/client-chime"); // CommonJS import + * const client = new ChimeClient(config); + * const command = new ListVoiceConnectorsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListVoiceConnectorsCommandInput} for command's `input` shape. + * @see {@link ListVoiceConnectorsCommandOutput} for command's `response` shape. + * @see {@link ChimeClientResolvedConfig | config} for command's `input` shape. + * */ export class ListVoiceConnectorsCommand extends $Command< ListVoiceConnectorsCommandInput, diff --git a/clients/client-chime/commands/LogoutUserCommand.ts b/clients/client-chime/commands/LogoutUserCommand.ts index 2f508163d289..52478e281ef7 100644 --- a/clients/client-chime/commands/LogoutUserCommand.ts +++ b/clients/client-chime/commands/LogoutUserCommand.ts @@ -22,6 +22,20 @@ export interface LogoutUserCommandOutput extends LogoutUserResponse, __MetadataB /** *

Logs out the specified user from all of the devices they are currently logged into.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ChimeClient, LogoutUserCommand } from "@aws-sdk/client-chime"; // ES Modules import + * // const { ChimeClient, LogoutUserCommand } = require("@aws-sdk/client-chime"); // CommonJS import + * const client = new ChimeClient(config); + * const command = new LogoutUserCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link LogoutUserCommandInput} for command's `input` shape. + * @see {@link LogoutUserCommandOutput} for command's `response` shape. + * @see {@link ChimeClientResolvedConfig | config} for command's `input` shape. + * */ export class LogoutUserCommand extends $Command< LogoutUserCommandInput, diff --git a/clients/client-chime/commands/PutAppInstanceRetentionSettingsCommand.ts b/clients/client-chime/commands/PutAppInstanceRetentionSettingsCommand.ts index 288a18f959e5..18b17ee52dbe 100644 --- a/clients/client-chime/commands/PutAppInstanceRetentionSettingsCommand.ts +++ b/clients/client-chime/commands/PutAppInstanceRetentionSettingsCommand.ts @@ -24,6 +24,20 @@ export interface PutAppInstanceRetentionSettingsCommandOutput /** *

Sets the amount of time in days that a given AppInstance retains data.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ChimeClient, PutAppInstanceRetentionSettingsCommand } from "@aws-sdk/client-chime"; // ES Modules import + * // const { ChimeClient, PutAppInstanceRetentionSettingsCommand } = require("@aws-sdk/client-chime"); // CommonJS import + * const client = new ChimeClient(config); + * const command = new PutAppInstanceRetentionSettingsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link PutAppInstanceRetentionSettingsCommandInput} for command's `input` shape. + * @see {@link PutAppInstanceRetentionSettingsCommandOutput} for command's `response` shape. + * @see {@link ChimeClientResolvedConfig | config} for command's `input` shape. + * */ export class PutAppInstanceRetentionSettingsCommand extends $Command< PutAppInstanceRetentionSettingsCommandInput, diff --git a/clients/client-chime/commands/PutAppInstanceStreamingConfigurationsCommand.ts b/clients/client-chime/commands/PutAppInstanceStreamingConfigurationsCommand.ts index 2d8792767ccc..3230bd714a3f 100644 --- a/clients/client-chime/commands/PutAppInstanceStreamingConfigurationsCommand.ts +++ b/clients/client-chime/commands/PutAppInstanceStreamingConfigurationsCommand.ts @@ -28,6 +28,20 @@ export interface PutAppInstanceStreamingConfigurationsCommandOutput /** *

The data streaming configurations of an AppInstance.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ChimeClient, PutAppInstanceStreamingConfigurationsCommand } from "@aws-sdk/client-chime"; // ES Modules import + * // const { ChimeClient, PutAppInstanceStreamingConfigurationsCommand } = require("@aws-sdk/client-chime"); // CommonJS import + * const client = new ChimeClient(config); + * const command = new PutAppInstanceStreamingConfigurationsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link PutAppInstanceStreamingConfigurationsCommandInput} for command's `input` shape. + * @see {@link PutAppInstanceStreamingConfigurationsCommandOutput} for command's `response` shape. + * @see {@link ChimeClientResolvedConfig | config} for command's `input` shape. + * */ export class PutAppInstanceStreamingConfigurationsCommand extends $Command< PutAppInstanceStreamingConfigurationsCommandInput, diff --git a/clients/client-chime/commands/PutEventsConfigurationCommand.ts b/clients/client-chime/commands/PutEventsConfigurationCommand.ts index 0ea3b46fd5aa..c7e97c6f88ed 100644 --- a/clients/client-chime/commands/PutEventsConfigurationCommand.ts +++ b/clients/client-chime/commands/PutEventsConfigurationCommand.ts @@ -24,6 +24,20 @@ export interface PutEventsConfigurationCommandOutput extends PutEventsConfigurat *

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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ChimeClient, PutEventsConfigurationCommand } from "@aws-sdk/client-chime"; // ES Modules import + * // const { ChimeClient, PutEventsConfigurationCommand } = require("@aws-sdk/client-chime"); // CommonJS import + * const client = new ChimeClient(config); + * const command = new PutEventsConfigurationCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link PutEventsConfigurationCommandInput} for command's `input` shape. + * @see {@link PutEventsConfigurationCommandOutput} for command's `response` shape. + * @see {@link ChimeClientResolvedConfig | config} for command's `input` shape. + * */ export class PutEventsConfigurationCommand extends $Command< PutEventsConfigurationCommandInput, diff --git a/clients/client-chime/commands/PutRetentionSettingsCommand.ts b/clients/client-chime/commands/PutRetentionSettingsCommand.ts index 8c6d95a45f7f..5ac1762c9947 100644 --- a/clients/client-chime/commands/PutRetentionSettingsCommand.ts +++ b/clients/client-chime/commands/PutRetentionSettingsCommand.ts @@ -40,6 +40,20 @@ export interface PutRetentionSettingsCommandOutput extends PutRetentionSettingsR * Amazon Chime Administration Guide * . *

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ChimeClient, PutRetentionSettingsCommand } from "@aws-sdk/client-chime"; // ES Modules import + * // const { ChimeClient, PutRetentionSettingsCommand } = require("@aws-sdk/client-chime"); // CommonJS import + * const client = new ChimeClient(config); + * const command = new PutRetentionSettingsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link PutRetentionSettingsCommandInput} for command's `input` shape. + * @see {@link PutRetentionSettingsCommandOutput} for command's `response` shape. + * @see {@link ChimeClientResolvedConfig | config} for command's `input` shape. + * */ export class PutRetentionSettingsCommand extends $Command< PutRetentionSettingsCommandInput, diff --git a/clients/client-chime/commands/PutSipMediaApplicationLoggingConfigurationCommand.ts b/clients/client-chime/commands/PutSipMediaApplicationLoggingConfigurationCommand.ts index 12d233ac9508..53b4c795638d 100644 --- a/clients/client-chime/commands/PutSipMediaApplicationLoggingConfigurationCommand.ts +++ b/clients/client-chime/commands/PutSipMediaApplicationLoggingConfigurationCommand.ts @@ -28,6 +28,20 @@ export interface PutSipMediaApplicationLoggingConfigurationCommandOutput /** *

Updates the logging configuration for the specified SIP media application.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ChimeClient, PutSipMediaApplicationLoggingConfigurationCommand } from "@aws-sdk/client-chime"; // ES Modules import + * // const { ChimeClient, PutSipMediaApplicationLoggingConfigurationCommand } = require("@aws-sdk/client-chime"); // CommonJS import + * const client = new ChimeClient(config); + * const command = new PutSipMediaApplicationLoggingConfigurationCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link PutSipMediaApplicationLoggingConfigurationCommandInput} for command's `input` shape. + * @see {@link PutSipMediaApplicationLoggingConfigurationCommandOutput} for command's `response` shape. + * @see {@link ChimeClientResolvedConfig | config} for command's `input` shape. + * */ export class PutSipMediaApplicationLoggingConfigurationCommand extends $Command< PutSipMediaApplicationLoggingConfigurationCommandInput, diff --git a/clients/client-chime/commands/PutVoiceConnectorEmergencyCallingConfigurationCommand.ts b/clients/client-chime/commands/PutVoiceConnectorEmergencyCallingConfigurationCommand.ts index 588662181964..f1e83333f2a6 100644 --- a/clients/client-chime/commands/PutVoiceConnectorEmergencyCallingConfigurationCommand.ts +++ b/clients/client-chime/commands/PutVoiceConnectorEmergencyCallingConfigurationCommand.ts @@ -28,6 +28,20 @@ export interface PutVoiceConnectorEmergencyCallingConfigurationCommandOutput /** *

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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ChimeClient, PutVoiceConnectorEmergencyCallingConfigurationCommand } from "@aws-sdk/client-chime"; // ES Modules import + * // const { ChimeClient, PutVoiceConnectorEmergencyCallingConfigurationCommand } = require("@aws-sdk/client-chime"); // CommonJS import + * const client = new ChimeClient(config); + * const command = new PutVoiceConnectorEmergencyCallingConfigurationCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link PutVoiceConnectorEmergencyCallingConfigurationCommandInput} for command's `input` shape. + * @see {@link PutVoiceConnectorEmergencyCallingConfigurationCommandOutput} for command's `response` shape. + * @see {@link ChimeClientResolvedConfig | config} for command's `input` shape. + * */ export class PutVoiceConnectorEmergencyCallingConfigurationCommand extends $Command< PutVoiceConnectorEmergencyCallingConfigurationCommandInput, diff --git a/clients/client-chime/commands/PutVoiceConnectorLoggingConfigurationCommand.ts b/clients/client-chime/commands/PutVoiceConnectorLoggingConfigurationCommand.ts index 9e782d829682..d13ea1ce3e7b 100644 --- a/clients/client-chime/commands/PutVoiceConnectorLoggingConfigurationCommand.ts +++ b/clients/client-chime/commands/PutVoiceConnectorLoggingConfigurationCommand.ts @@ -28,6 +28,20 @@ export interface PutVoiceConnectorLoggingConfigurationCommandOutput /** *

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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ChimeClient, PutVoiceConnectorLoggingConfigurationCommand } from "@aws-sdk/client-chime"; // ES Modules import + * // const { ChimeClient, PutVoiceConnectorLoggingConfigurationCommand } = require("@aws-sdk/client-chime"); // CommonJS import + * const client = new ChimeClient(config); + * const command = new PutVoiceConnectorLoggingConfigurationCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link PutVoiceConnectorLoggingConfigurationCommandInput} for command's `input` shape. + * @see {@link PutVoiceConnectorLoggingConfigurationCommandOutput} for command's `response` shape. + * @see {@link ChimeClientResolvedConfig | config} for command's `input` shape. + * */ export class PutVoiceConnectorLoggingConfigurationCommand extends $Command< PutVoiceConnectorLoggingConfigurationCommandInput, diff --git a/clients/client-chime/commands/PutVoiceConnectorOriginationCommand.ts b/clients/client-chime/commands/PutVoiceConnectorOriginationCommand.ts index 974faefdf29b..c82e02ed3e38 100644 --- a/clients/client-chime/commands/PutVoiceConnectorOriginationCommand.ts +++ b/clients/client-chime/commands/PutVoiceConnectorOriginationCommand.ts @@ -28,6 +28,20 @@ export interface PutVoiceConnectorOriginationCommandOutput * *

If emergency calling is configured for the Amazon Chime Voice Connector, it must be deleted prior to turning off origination settings.

* + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ChimeClient, PutVoiceConnectorOriginationCommand } from "@aws-sdk/client-chime"; // ES Modules import + * // const { ChimeClient, PutVoiceConnectorOriginationCommand } = require("@aws-sdk/client-chime"); // CommonJS import + * const client = new ChimeClient(config); + * const command = new PutVoiceConnectorOriginationCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link PutVoiceConnectorOriginationCommandInput} for command's `input` shape. + * @see {@link PutVoiceConnectorOriginationCommandOutput} for command's `response` shape. + * @see {@link ChimeClientResolvedConfig | config} for command's `input` shape. + * */ export class PutVoiceConnectorOriginationCommand extends $Command< PutVoiceConnectorOriginationCommandInput, diff --git a/clients/client-chime/commands/PutVoiceConnectorProxyCommand.ts b/clients/client-chime/commands/PutVoiceConnectorProxyCommand.ts index b9f93370cb11..ddbbf50f37ce 100644 --- a/clients/client-chime/commands/PutVoiceConnectorProxyCommand.ts +++ b/clients/client-chime/commands/PutVoiceConnectorProxyCommand.ts @@ -22,6 +22,20 @@ export interface PutVoiceConnectorProxyCommandOutput extends PutVoiceConnectorPr /** *

Puts the specified proxy configuration to the specified Amazon Chime Voice Connector.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ChimeClient, PutVoiceConnectorProxyCommand } from "@aws-sdk/client-chime"; // ES Modules import + * // const { ChimeClient, PutVoiceConnectorProxyCommand } = require("@aws-sdk/client-chime"); // CommonJS import + * const client = new ChimeClient(config); + * const command = new PutVoiceConnectorProxyCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link PutVoiceConnectorProxyCommandInput} for command's `input` shape. + * @see {@link PutVoiceConnectorProxyCommandOutput} for command's `response` shape. + * @see {@link ChimeClientResolvedConfig | config} for command's `input` shape. + * */ export class PutVoiceConnectorProxyCommand extends $Command< PutVoiceConnectorProxyCommandInput, diff --git a/clients/client-chime/commands/PutVoiceConnectorStreamingConfigurationCommand.ts b/clients/client-chime/commands/PutVoiceConnectorStreamingConfigurationCommand.ts index 69bf5d209711..6c34fe1649aa 100644 --- a/clients/client-chime/commands/PutVoiceConnectorStreamingConfigurationCommand.ts +++ b/clients/client-chime/commands/PutVoiceConnectorStreamingConfigurationCommand.ts @@ -30,6 +30,20 @@ export interface PutVoiceConnectorStreamingConfigurationCommandOutput *

Adds a streaming configuration for the specified Amazon Chime Voice Connector. The streaming * configuration specifies whether media streaming is enabled for sending to Indonesians. * It also sets the retention period, in hours, for the Amazon Kinesis data.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ChimeClient, PutVoiceConnectorStreamingConfigurationCommand } from "@aws-sdk/client-chime"; // ES Modules import + * // const { ChimeClient, PutVoiceConnectorStreamingConfigurationCommand } = require("@aws-sdk/client-chime"); // CommonJS import + * const client = new ChimeClient(config); + * const command = new PutVoiceConnectorStreamingConfigurationCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link PutVoiceConnectorStreamingConfigurationCommandInput} for command's `input` shape. + * @see {@link PutVoiceConnectorStreamingConfigurationCommandOutput} for command's `response` shape. + * @see {@link ChimeClientResolvedConfig | config} for command's `input` shape. + * */ export class PutVoiceConnectorStreamingConfigurationCommand extends $Command< PutVoiceConnectorStreamingConfigurationCommandInput, diff --git a/clients/client-chime/commands/PutVoiceConnectorTerminationCommand.ts b/clients/client-chime/commands/PutVoiceConnectorTerminationCommand.ts index 07e5be515e65..5ee680754dea 100644 --- a/clients/client-chime/commands/PutVoiceConnectorTerminationCommand.ts +++ b/clients/client-chime/commands/PutVoiceConnectorTerminationCommand.ts @@ -28,6 +28,20 @@ export interface PutVoiceConnectorTerminationCommandOutput * *

If emergency calling is configured for the Amazon Chime Voice Connector, it must be deleted prior to turning off termination settings.

* + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ChimeClient, PutVoiceConnectorTerminationCommand } from "@aws-sdk/client-chime"; // ES Modules import + * // const { ChimeClient, PutVoiceConnectorTerminationCommand } = require("@aws-sdk/client-chime"); // CommonJS import + * const client = new ChimeClient(config); + * const command = new PutVoiceConnectorTerminationCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link PutVoiceConnectorTerminationCommandInput} for command's `input` shape. + * @see {@link PutVoiceConnectorTerminationCommandOutput} for command's `response` shape. + * @see {@link ChimeClientResolvedConfig | config} for command's `input` shape. + * */ export class PutVoiceConnectorTerminationCommand extends $Command< PutVoiceConnectorTerminationCommandInput, diff --git a/clients/client-chime/commands/PutVoiceConnectorTerminationCredentialsCommand.ts b/clients/client-chime/commands/PutVoiceConnectorTerminationCredentialsCommand.ts index 1d0eec8373d1..5694d192ceff 100644 --- a/clients/client-chime/commands/PutVoiceConnectorTerminationCredentialsCommand.ts +++ b/clients/client-chime/commands/PutVoiceConnectorTerminationCredentialsCommand.ts @@ -23,6 +23,20 @@ export interface PutVoiceConnectorTerminationCredentialsCommandOutput extends __ /** *

Adds termination SIP credentials for the specified Amazon Chime Voice Connector.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ChimeClient, PutVoiceConnectorTerminationCredentialsCommand } from "@aws-sdk/client-chime"; // ES Modules import + * // const { ChimeClient, PutVoiceConnectorTerminationCredentialsCommand } = require("@aws-sdk/client-chime"); // CommonJS import + * const client = new ChimeClient(config); + * const command = new PutVoiceConnectorTerminationCredentialsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link PutVoiceConnectorTerminationCredentialsCommandInput} for command's `input` shape. + * @see {@link PutVoiceConnectorTerminationCredentialsCommandOutput} for command's `response` shape. + * @see {@link ChimeClientResolvedConfig | config} for command's `input` shape. + * */ export class PutVoiceConnectorTerminationCredentialsCommand extends $Command< PutVoiceConnectorTerminationCredentialsCommandInput, diff --git a/clients/client-chime/commands/RedactChannelMessageCommand.ts b/clients/client-chime/commands/RedactChannelMessageCommand.ts index ec43514c0078..38ac153cc5ce 100644 --- a/clients/client-chime/commands/RedactChannelMessageCommand.ts +++ b/clients/client-chime/commands/RedactChannelMessageCommand.ts @@ -27,6 +27,20 @@ export interface RedactChannelMessageCommandOutput extends RedactChannelMessageR *

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.

* + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ChimeClient, RedactChannelMessageCommand } from "@aws-sdk/client-chime"; // ES Modules import + * // const { ChimeClient, RedactChannelMessageCommand } = require("@aws-sdk/client-chime"); // CommonJS import + * const client = new ChimeClient(config); + * const command = new RedactChannelMessageCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link RedactChannelMessageCommandInput} for command's `input` shape. + * @see {@link RedactChannelMessageCommandOutput} for command's `response` shape. + * @see {@link ChimeClientResolvedConfig | config} for command's `input` shape. + * */ export class RedactChannelMessageCommand extends $Command< RedactChannelMessageCommandInput, diff --git a/clients/client-chime/commands/RedactConversationMessageCommand.ts b/clients/client-chime/commands/RedactConversationMessageCommand.ts index 78548088027c..74ec4b5e5fca 100644 --- a/clients/client-chime/commands/RedactConversationMessageCommand.ts +++ b/clients/client-chime/commands/RedactConversationMessageCommand.ts @@ -22,6 +22,20 @@ export interface RedactConversationMessageCommandOutput extends RedactConversati /** *

Redacts the specified message from the specified Amazon Chime conversation.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ChimeClient, RedactConversationMessageCommand } from "@aws-sdk/client-chime"; // ES Modules import + * // const { ChimeClient, RedactConversationMessageCommand } = require("@aws-sdk/client-chime"); // CommonJS import + * const client = new ChimeClient(config); + * const command = new RedactConversationMessageCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link RedactConversationMessageCommandInput} for command's `input` shape. + * @see {@link RedactConversationMessageCommandOutput} for command's `response` shape. + * @see {@link ChimeClientResolvedConfig | config} for command's `input` shape. + * */ export class RedactConversationMessageCommand extends $Command< RedactConversationMessageCommandInput, diff --git a/clients/client-chime/commands/RedactRoomMessageCommand.ts b/clients/client-chime/commands/RedactRoomMessageCommand.ts index 0cab9b93dada..23d0f82d215a 100644 --- a/clients/client-chime/commands/RedactRoomMessageCommand.ts +++ b/clients/client-chime/commands/RedactRoomMessageCommand.ts @@ -22,6 +22,20 @@ export interface RedactRoomMessageCommandOutput extends RedactRoomMessageRespons /** *

Redacts the specified message from the specified Amazon Chime channel.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ChimeClient, RedactRoomMessageCommand } from "@aws-sdk/client-chime"; // ES Modules import + * // const { ChimeClient, RedactRoomMessageCommand } = require("@aws-sdk/client-chime"); // CommonJS import + * const client = new ChimeClient(config); + * const command = new RedactRoomMessageCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link RedactRoomMessageCommandInput} for command's `input` shape. + * @see {@link RedactRoomMessageCommandOutput} for command's `response` shape. + * @see {@link ChimeClientResolvedConfig | config} for command's `input` shape. + * */ export class RedactRoomMessageCommand extends $Command< RedactRoomMessageCommandInput, diff --git a/clients/client-chime/commands/RegenerateSecurityTokenCommand.ts b/clients/client-chime/commands/RegenerateSecurityTokenCommand.ts index 1cafb96d28e8..97f3f921c8ce 100644 --- a/clients/client-chime/commands/RegenerateSecurityTokenCommand.ts +++ b/clients/client-chime/commands/RegenerateSecurityTokenCommand.ts @@ -22,6 +22,20 @@ export interface RegenerateSecurityTokenCommandOutput extends RegenerateSecurity /** *

Regenerates the security token for a bot.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ChimeClient, RegenerateSecurityTokenCommand } from "@aws-sdk/client-chime"; // ES Modules import + * // const { ChimeClient, RegenerateSecurityTokenCommand } = require("@aws-sdk/client-chime"); // CommonJS import + * const client = new ChimeClient(config); + * const command = new RegenerateSecurityTokenCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link RegenerateSecurityTokenCommandInput} for command's `input` shape. + * @see {@link RegenerateSecurityTokenCommandOutput} for command's `response` shape. + * @see {@link ChimeClientResolvedConfig | config} for command's `input` shape. + * */ export class RegenerateSecurityTokenCommand extends $Command< RegenerateSecurityTokenCommandInput, diff --git a/clients/client-chime/commands/ResetPersonalPINCommand.ts b/clients/client-chime/commands/ResetPersonalPINCommand.ts index 1785493e364a..c81e1c3ac3c7 100644 --- a/clients/client-chime/commands/ResetPersonalPINCommand.ts +++ b/clients/client-chime/commands/ResetPersonalPINCommand.ts @@ -23,6 +23,20 @@ export interface ResetPersonalPINCommandOutput extends ResetPersonalPINResponse, /** *

Resets the personal meeting PIN for the specified user on an Amazon Chime account. Returns * the User object with the updated personal meeting PIN.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ChimeClient, ResetPersonalPINCommand } from "@aws-sdk/client-chime"; // ES Modules import + * // const { ChimeClient, ResetPersonalPINCommand } = require("@aws-sdk/client-chime"); // CommonJS import + * const client = new ChimeClient(config); + * const command = new ResetPersonalPINCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ResetPersonalPINCommandInput} for command's `input` shape. + * @see {@link ResetPersonalPINCommandOutput} for command's `response` shape. + * @see {@link ChimeClientResolvedConfig | config} for command's `input` shape. + * */ export class ResetPersonalPINCommand extends $Command< ResetPersonalPINCommandInput, diff --git a/clients/client-chime/commands/RestorePhoneNumberCommand.ts b/clients/client-chime/commands/RestorePhoneNumberCommand.ts index ca2e20315f09..22ce67292b20 100644 --- a/clients/client-chime/commands/RestorePhoneNumberCommand.ts +++ b/clients/client-chime/commands/RestorePhoneNumberCommand.ts @@ -23,6 +23,20 @@ export interface RestorePhoneNumberCommandOutput extends RestorePhoneNumberRespo /** *

Moves a phone number from the Deletion queue back into the * phone number Inventory.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ChimeClient, RestorePhoneNumberCommand } from "@aws-sdk/client-chime"; // ES Modules import + * // const { ChimeClient, RestorePhoneNumberCommand } = require("@aws-sdk/client-chime"); // CommonJS import + * const client = new ChimeClient(config); + * const command = new RestorePhoneNumberCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link RestorePhoneNumberCommandInput} for command's `input` shape. + * @see {@link RestorePhoneNumberCommandOutput} for command's `response` shape. + * @see {@link ChimeClientResolvedConfig | config} for command's `input` shape. + * */ export class RestorePhoneNumberCommand extends $Command< RestorePhoneNumberCommandInput, diff --git a/clients/client-chime/commands/SearchAvailablePhoneNumbersCommand.ts b/clients/client-chime/commands/SearchAvailablePhoneNumbersCommand.ts index 84e2c8beeb7b..75bf02e3f3b1 100644 --- a/clients/client-chime/commands/SearchAvailablePhoneNumbersCommand.ts +++ b/clients/client-chime/commands/SearchAvailablePhoneNumbersCommand.ts @@ -24,6 +24,20 @@ export interface SearchAvailablePhoneNumbersCommandOutput /** *

Searches phone numbers that can be ordered.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ChimeClient, SearchAvailablePhoneNumbersCommand } from "@aws-sdk/client-chime"; // ES Modules import + * // const { ChimeClient, SearchAvailablePhoneNumbersCommand } = require("@aws-sdk/client-chime"); // CommonJS import + * const client = new ChimeClient(config); + * const command = new SearchAvailablePhoneNumbersCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link SearchAvailablePhoneNumbersCommandInput} for command's `input` shape. + * @see {@link SearchAvailablePhoneNumbersCommandOutput} for command's `response` shape. + * @see {@link ChimeClientResolvedConfig | config} for command's `input` shape. + * */ export class SearchAvailablePhoneNumbersCommand extends $Command< SearchAvailablePhoneNumbersCommandInput, diff --git a/clients/client-chime/commands/SendChannelMessageCommand.ts b/clients/client-chime/commands/SendChannelMessageCommand.ts index d19137b9618f..e32f208cf2d1 100644 --- a/clients/client-chime/commands/SendChannelMessageCommand.ts +++ b/clients/client-chime/commands/SendChannelMessageCommand.ts @@ -30,6 +30,20 @@ export interface SendChannelMessageCommandOutput extends SendChannelMessageRespo *

Also, STANDARD messages can contain 4KB of data and the 1KB of metadata. CONTROL messages can contain 30 bytes of * data and no metadata.

* + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ChimeClient, SendChannelMessageCommand } from "@aws-sdk/client-chime"; // ES Modules import + * // const { ChimeClient, SendChannelMessageCommand } = require("@aws-sdk/client-chime"); // CommonJS import + * const client = new ChimeClient(config); + * const command = new SendChannelMessageCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link SendChannelMessageCommandInput} for command's `input` shape. + * @see {@link SendChannelMessageCommandOutput} for command's `response` shape. + * @see {@link ChimeClientResolvedConfig | config} for command's `input` shape. + * */ export class SendChannelMessageCommand extends $Command< SendChannelMessageCommandInput, diff --git a/clients/client-chime/commands/TagAttendeeCommand.ts b/clients/client-chime/commands/TagAttendeeCommand.ts index 3e2cd0eb1045..77d5d74695cc 100644 --- a/clients/client-chime/commands/TagAttendeeCommand.ts +++ b/clients/client-chime/commands/TagAttendeeCommand.ts @@ -22,6 +22,20 @@ export interface TagAttendeeCommandOutput extends __MetadataBearer {} /** *

Applies the specified tags to the specified Amazon Chime SDK attendee.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ChimeClient, TagAttendeeCommand } from "@aws-sdk/client-chime"; // ES Modules import + * // const { ChimeClient, TagAttendeeCommand } = require("@aws-sdk/client-chime"); // CommonJS import + * const client = new ChimeClient(config); + * const command = new TagAttendeeCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link TagAttendeeCommandInput} for command's `input` shape. + * @see {@link TagAttendeeCommandOutput} for command's `response` shape. + * @see {@link ChimeClientResolvedConfig | config} for command's `input` shape. + * */ export class TagAttendeeCommand extends $Command< TagAttendeeCommandInput, diff --git a/clients/client-chime/commands/TagMeetingCommand.ts b/clients/client-chime/commands/TagMeetingCommand.ts index 504712684ad5..482cefa21fd3 100644 --- a/clients/client-chime/commands/TagMeetingCommand.ts +++ b/clients/client-chime/commands/TagMeetingCommand.ts @@ -22,6 +22,20 @@ export interface TagMeetingCommandOutput extends __MetadataBearer {} /** *

Applies the specified tags to the specified Amazon Chime SDK meeting.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ChimeClient, TagMeetingCommand } from "@aws-sdk/client-chime"; // ES Modules import + * // const { ChimeClient, TagMeetingCommand } = require("@aws-sdk/client-chime"); // CommonJS import + * const client = new ChimeClient(config); + * const command = new TagMeetingCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link TagMeetingCommandInput} for command's `input` shape. + * @see {@link TagMeetingCommandOutput} for command's `response` shape. + * @see {@link ChimeClientResolvedConfig | config} for command's `input` shape. + * */ export class TagMeetingCommand extends $Command< TagMeetingCommandInput, diff --git a/clients/client-chime/commands/TagResourceCommand.ts b/clients/client-chime/commands/TagResourceCommand.ts index 1af404750c94..51ae59d4265f 100644 --- a/clients/client-chime/commands/TagResourceCommand.ts +++ b/clients/client-chime/commands/TagResourceCommand.ts @@ -22,6 +22,20 @@ export interface TagResourceCommandOutput extends __MetadataBearer {} /** *

Applies the specified tags to the specified Amazon Chime SDK meeting resource.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ChimeClient, TagResourceCommand } from "@aws-sdk/client-chime"; // ES Modules import + * // const { ChimeClient, TagResourceCommand } = require("@aws-sdk/client-chime"); // CommonJS import + * const client = new ChimeClient(config); + * const command = new TagResourceCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link TagResourceCommandInput} for command's `input` shape. + * @see {@link TagResourceCommandOutput} for command's `response` shape. + * @see {@link ChimeClientResolvedConfig | config} for command's `input` shape. + * */ export class TagResourceCommand extends $Command< TagResourceCommandInput, diff --git a/clients/client-chime/commands/UntagAttendeeCommand.ts b/clients/client-chime/commands/UntagAttendeeCommand.ts index 4fd13355a3ba..5c4bc67425e0 100644 --- a/clients/client-chime/commands/UntagAttendeeCommand.ts +++ b/clients/client-chime/commands/UntagAttendeeCommand.ts @@ -22,6 +22,20 @@ export interface UntagAttendeeCommandOutput extends __MetadataBearer {} /** *

Untags the specified tags from the specified Amazon Chime SDK attendee.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ChimeClient, UntagAttendeeCommand } from "@aws-sdk/client-chime"; // ES Modules import + * // const { ChimeClient, UntagAttendeeCommand } = require("@aws-sdk/client-chime"); // CommonJS import + * const client = new ChimeClient(config); + * const command = new UntagAttendeeCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link UntagAttendeeCommandInput} for command's `input` shape. + * @see {@link UntagAttendeeCommandOutput} for command's `response` shape. + * @see {@link ChimeClientResolvedConfig | config} for command's `input` shape. + * */ export class UntagAttendeeCommand extends $Command< UntagAttendeeCommandInput, diff --git a/clients/client-chime/commands/UntagMeetingCommand.ts b/clients/client-chime/commands/UntagMeetingCommand.ts index 8560f42140b4..cd2fc02bac50 100644 --- a/clients/client-chime/commands/UntagMeetingCommand.ts +++ b/clients/client-chime/commands/UntagMeetingCommand.ts @@ -22,6 +22,20 @@ export interface UntagMeetingCommandOutput extends __MetadataBearer {} /** *

Untags the specified tags from the specified Amazon Chime SDK meeting.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ChimeClient, UntagMeetingCommand } from "@aws-sdk/client-chime"; // ES Modules import + * // const { ChimeClient, UntagMeetingCommand } = require("@aws-sdk/client-chime"); // CommonJS import + * const client = new ChimeClient(config); + * const command = new UntagMeetingCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link UntagMeetingCommandInput} for command's `input` shape. + * @see {@link UntagMeetingCommandOutput} for command's `response` shape. + * @see {@link ChimeClientResolvedConfig | config} for command's `input` shape. + * */ export class UntagMeetingCommand extends $Command< UntagMeetingCommandInput, diff --git a/clients/client-chime/commands/UntagResourceCommand.ts b/clients/client-chime/commands/UntagResourceCommand.ts index cc909962cbbd..855c091abbc3 100644 --- a/clients/client-chime/commands/UntagResourceCommand.ts +++ b/clients/client-chime/commands/UntagResourceCommand.ts @@ -22,6 +22,20 @@ export interface UntagResourceCommandOutput extends __MetadataBearer {} /** *

Untags the specified tags from the specified Amazon Chime SDK meeting resource.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ChimeClient, UntagResourceCommand } from "@aws-sdk/client-chime"; // ES Modules import + * // const { ChimeClient, UntagResourceCommand } = require("@aws-sdk/client-chime"); // CommonJS import + * const client = new ChimeClient(config); + * const command = new UntagResourceCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link UntagResourceCommandInput} for command's `input` shape. + * @see {@link UntagResourceCommandOutput} for command's `response` shape. + * @see {@link ChimeClientResolvedConfig | config} for command's `input` shape. + * */ export class UntagResourceCommand extends $Command< UntagResourceCommandInput, diff --git a/clients/client-chime/commands/UpdateAccountCommand.ts b/clients/client-chime/commands/UpdateAccountCommand.ts index 12778229d284..d5c98aab12c1 100644 --- a/clients/client-chime/commands/UpdateAccountCommand.ts +++ b/clients/client-chime/commands/UpdateAccountCommand.ts @@ -23,6 +23,20 @@ export interface UpdateAccountCommandOutput extends UpdateAccountResponse, __Met /** *

Updates account details for the specified Amazon Chime account. Currently, only account name * updates are supported for this action.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ChimeClient, UpdateAccountCommand } from "@aws-sdk/client-chime"; // ES Modules import + * // const { ChimeClient, UpdateAccountCommand } = require("@aws-sdk/client-chime"); // CommonJS import + * const client = new ChimeClient(config); + * const command = new UpdateAccountCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link UpdateAccountCommandInput} for command's `input` shape. + * @see {@link UpdateAccountCommandOutput} for command's `response` shape. + * @see {@link ChimeClientResolvedConfig | config} for command's `input` shape. + * */ export class UpdateAccountCommand extends $Command< UpdateAccountCommandInput, diff --git a/clients/client-chime/commands/UpdateAccountSettingsCommand.ts b/clients/client-chime/commands/UpdateAccountSettingsCommand.ts index f5b01999b5ed..fe3d6af054f3 100644 --- a/clients/client-chime/commands/UpdateAccountSettingsCommand.ts +++ b/clients/client-chime/commands/UpdateAccountSettingsCommand.ts @@ -26,6 +26,20 @@ export interface UpdateAccountSettingsCommandOutput extends UpdateAccountSetting * these settings, see Use * the Policies Page in the Amazon Chime Administration * Guide.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ChimeClient, UpdateAccountSettingsCommand } from "@aws-sdk/client-chime"; // ES Modules import + * // const { ChimeClient, UpdateAccountSettingsCommand } = require("@aws-sdk/client-chime"); // CommonJS import + * const client = new ChimeClient(config); + * const command = new UpdateAccountSettingsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link UpdateAccountSettingsCommandInput} for command's `input` shape. + * @see {@link UpdateAccountSettingsCommandOutput} for command's `response` shape. + * @see {@link ChimeClientResolvedConfig | config} for command's `input` shape. + * */ export class UpdateAccountSettingsCommand extends $Command< UpdateAccountSettingsCommandInput, diff --git a/clients/client-chime/commands/UpdateAppInstanceCommand.ts b/clients/client-chime/commands/UpdateAppInstanceCommand.ts index 54fa6e339822..7708a88ae0c7 100644 --- a/clients/client-chime/commands/UpdateAppInstanceCommand.ts +++ b/clients/client-chime/commands/UpdateAppInstanceCommand.ts @@ -22,6 +22,20 @@ export interface UpdateAppInstanceCommandOutput extends UpdateAppInstanceRespons /** *

Updates AppInstance metadata.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ChimeClient, UpdateAppInstanceCommand } from "@aws-sdk/client-chime"; // ES Modules import + * // const { ChimeClient, UpdateAppInstanceCommand } = require("@aws-sdk/client-chime"); // CommonJS import + * const client = new ChimeClient(config); + * const command = new UpdateAppInstanceCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link UpdateAppInstanceCommandInput} for command's `input` shape. + * @see {@link UpdateAppInstanceCommandOutput} for command's `response` shape. + * @see {@link ChimeClientResolvedConfig | config} for command's `input` shape. + * */ export class UpdateAppInstanceCommand extends $Command< UpdateAppInstanceCommandInput, diff --git a/clients/client-chime/commands/UpdateAppInstanceUserCommand.ts b/clients/client-chime/commands/UpdateAppInstanceUserCommand.ts index 780d463ee68b..93d5423eca4b 100644 --- a/clients/client-chime/commands/UpdateAppInstanceUserCommand.ts +++ b/clients/client-chime/commands/UpdateAppInstanceUserCommand.ts @@ -22,6 +22,20 @@ export interface UpdateAppInstanceUserCommandOutput extends UpdateAppInstanceUse /** *

Updates the details of an AppInstanceUser. You can update names and metadata.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ChimeClient, UpdateAppInstanceUserCommand } from "@aws-sdk/client-chime"; // ES Modules import + * // const { ChimeClient, UpdateAppInstanceUserCommand } = require("@aws-sdk/client-chime"); // CommonJS import + * const client = new ChimeClient(config); + * const command = new UpdateAppInstanceUserCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link UpdateAppInstanceUserCommandInput} for command's `input` shape. + * @see {@link UpdateAppInstanceUserCommandOutput} for command's `response` shape. + * @see {@link ChimeClientResolvedConfig | config} for command's `input` shape. + * */ export class UpdateAppInstanceUserCommand extends $Command< UpdateAppInstanceUserCommandInput, diff --git a/clients/client-chime/commands/UpdateBotCommand.ts b/clients/client-chime/commands/UpdateBotCommand.ts index 9a094e977abc..717cc9e1bdfb 100644 --- a/clients/client-chime/commands/UpdateBotCommand.ts +++ b/clients/client-chime/commands/UpdateBotCommand.ts @@ -22,6 +22,20 @@ export interface UpdateBotCommandOutput extends UpdateBotResponse, __MetadataBea /** *

Updates the status of the specified bot, such as starting or stopping the bot from running in your Amazon Chime Enterprise account.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ChimeClient, UpdateBotCommand } from "@aws-sdk/client-chime"; // ES Modules import + * // const { ChimeClient, UpdateBotCommand } = require("@aws-sdk/client-chime"); // CommonJS import + * const client = new ChimeClient(config); + * const command = new UpdateBotCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link UpdateBotCommandInput} for command's `input` shape. + * @see {@link UpdateBotCommandOutput} for command's `response` shape. + * @see {@link ChimeClientResolvedConfig | config} for command's `input` shape. + * */ export class UpdateBotCommand extends $Command< UpdateBotCommandInput, diff --git a/clients/client-chime/commands/UpdateChannelCommand.ts b/clients/client-chime/commands/UpdateChannelCommand.ts index aae97f10ba45..f175b7ed8316 100644 --- a/clients/client-chime/commands/UpdateChannelCommand.ts +++ b/clients/client-chime/commands/UpdateChannelCommand.ts @@ -30,6 +30,20 @@ export interface UpdateChannelCommandOutput extends UpdateChannelResponse, __Met *

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.

* + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ChimeClient, UpdateChannelCommand } from "@aws-sdk/client-chime"; // ES Modules import + * // const { ChimeClient, UpdateChannelCommand } = require("@aws-sdk/client-chime"); // CommonJS import + * const client = new ChimeClient(config); + * const command = new UpdateChannelCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link UpdateChannelCommandInput} for command's `input` shape. + * @see {@link UpdateChannelCommandOutput} for command's `response` shape. + * @see {@link ChimeClientResolvedConfig | config} for command's `input` shape. + * */ export class UpdateChannelCommand extends $Command< UpdateChannelCommandInput, diff --git a/clients/client-chime/commands/UpdateChannelMessageCommand.ts b/clients/client-chime/commands/UpdateChannelMessageCommand.ts index 47a4557d0e94..e3382e188952 100644 --- a/clients/client-chime/commands/UpdateChannelMessageCommand.ts +++ b/clients/client-chime/commands/UpdateChannelMessageCommand.ts @@ -27,6 +27,20 @@ export interface UpdateChannelMessageCommandOutput extends UpdateChannelMessageR *

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.

* + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ChimeClient, UpdateChannelMessageCommand } from "@aws-sdk/client-chime"; // ES Modules import + * // const { ChimeClient, UpdateChannelMessageCommand } = require("@aws-sdk/client-chime"); // CommonJS import + * const client = new ChimeClient(config); + * const command = new UpdateChannelMessageCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link UpdateChannelMessageCommandInput} for command's `input` shape. + * @see {@link UpdateChannelMessageCommandOutput} for command's `response` shape. + * @see {@link ChimeClientResolvedConfig | config} for command's `input` shape. + * */ export class UpdateChannelMessageCommand extends $Command< UpdateChannelMessageCommandInput, diff --git a/clients/client-chime/commands/UpdateChannelReadMarkerCommand.ts b/clients/client-chime/commands/UpdateChannelReadMarkerCommand.ts index 8a7babeb0a5d..fff795403748 100644 --- a/clients/client-chime/commands/UpdateChannelReadMarkerCommand.ts +++ b/clients/client-chime/commands/UpdateChannelReadMarkerCommand.ts @@ -27,6 +27,20 @@ export interface UpdateChannelReadMarkerCommandOutput extends UpdateChannelReadM *

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.

* + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ChimeClient, UpdateChannelReadMarkerCommand } from "@aws-sdk/client-chime"; // ES Modules import + * // const { ChimeClient, UpdateChannelReadMarkerCommand } = require("@aws-sdk/client-chime"); // CommonJS import + * const client = new ChimeClient(config); + * const command = new UpdateChannelReadMarkerCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link UpdateChannelReadMarkerCommandInput} for command's `input` shape. + * @see {@link UpdateChannelReadMarkerCommandOutput} for command's `response` shape. + * @see {@link ChimeClientResolvedConfig | config} for command's `input` shape. + * */ export class UpdateChannelReadMarkerCommand extends $Command< UpdateChannelReadMarkerCommandInput, diff --git a/clients/client-chime/commands/UpdateGlobalSettingsCommand.ts b/clients/client-chime/commands/UpdateGlobalSettingsCommand.ts index 407b1fb2d5b5..e47c83187b8a 100644 --- a/clients/client-chime/commands/UpdateGlobalSettingsCommand.ts +++ b/clients/client-chime/commands/UpdateGlobalSettingsCommand.ts @@ -22,6 +22,20 @@ export interface UpdateGlobalSettingsCommandOutput extends __MetadataBearer {} /** *

Updates global settings for the administrator's AWS account, such as Amazon Chime Business Calling and Amazon Chime Voice Connector settings.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ChimeClient, UpdateGlobalSettingsCommand } from "@aws-sdk/client-chime"; // ES Modules import + * // const { ChimeClient, UpdateGlobalSettingsCommand } = require("@aws-sdk/client-chime"); // CommonJS import + * const client = new ChimeClient(config); + * const command = new UpdateGlobalSettingsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link UpdateGlobalSettingsCommandInput} for command's `input` shape. + * @see {@link UpdateGlobalSettingsCommandOutput} for command's `response` shape. + * @see {@link ChimeClientResolvedConfig | config} for command's `input` shape. + * */ export class UpdateGlobalSettingsCommand extends $Command< UpdateGlobalSettingsCommandInput, diff --git a/clients/client-chime/commands/UpdatePhoneNumberCommand.ts b/clients/client-chime/commands/UpdatePhoneNumberCommand.ts index df781c04a2eb..31bdca100744 100644 --- a/clients/client-chime/commands/UpdatePhoneNumberCommand.ts +++ b/clients/client-chime/commands/UpdatePhoneNumberCommand.ts @@ -24,6 +24,20 @@ export interface UpdatePhoneNumberCommandOutput extends UpdatePhoneNumberRespons *

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 must use the Amazon Chime Voice Connector 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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ChimeClient, UpdatePhoneNumberCommand } from "@aws-sdk/client-chime"; // ES Modules import + * // const { ChimeClient, UpdatePhoneNumberCommand } = require("@aws-sdk/client-chime"); // CommonJS import + * const client = new ChimeClient(config); + * const command = new UpdatePhoneNumberCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link UpdatePhoneNumberCommandInput} for command's `input` shape. + * @see {@link UpdatePhoneNumberCommandOutput} for command's `response` shape. + * @see {@link ChimeClientResolvedConfig | config} for command's `input` shape. + * */ export class UpdatePhoneNumberCommand extends $Command< UpdatePhoneNumberCommandInput, diff --git a/clients/client-chime/commands/UpdatePhoneNumberSettingsCommand.ts b/clients/client-chime/commands/UpdatePhoneNumberSettingsCommand.ts index bc8bf57ed896..ca72606becbd 100644 --- a/clients/client-chime/commands/UpdatePhoneNumberSettingsCommand.ts +++ b/clients/client-chime/commands/UpdatePhoneNumberSettingsCommand.ts @@ -24,6 +24,20 @@ export interface UpdatePhoneNumberSettingsCommandOutput extends __MetadataBearer *

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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ChimeClient, UpdatePhoneNumberSettingsCommand } from "@aws-sdk/client-chime"; // ES Modules import + * // const { ChimeClient, UpdatePhoneNumberSettingsCommand } = require("@aws-sdk/client-chime"); // CommonJS import + * const client = new ChimeClient(config); + * const command = new UpdatePhoneNumberSettingsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link UpdatePhoneNumberSettingsCommandInput} for command's `input` shape. + * @see {@link UpdatePhoneNumberSettingsCommandOutput} for command's `response` shape. + * @see {@link ChimeClientResolvedConfig | config} for command's `input` shape. + * */ export class UpdatePhoneNumberSettingsCommand extends $Command< UpdatePhoneNumberSettingsCommandInput, diff --git a/clients/client-chime/commands/UpdateProxySessionCommand.ts b/clients/client-chime/commands/UpdateProxySessionCommand.ts index e982ce27af74..5675ce6165d5 100644 --- a/clients/client-chime/commands/UpdateProxySessionCommand.ts +++ b/clients/client-chime/commands/UpdateProxySessionCommand.ts @@ -22,6 +22,20 @@ export interface UpdateProxySessionCommandOutput extends UpdateProxySessionRespo /** *

Updates the specified proxy session details, such as voice or SMS capabilities.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ChimeClient, UpdateProxySessionCommand } from "@aws-sdk/client-chime"; // ES Modules import + * // const { ChimeClient, UpdateProxySessionCommand } = require("@aws-sdk/client-chime"); // CommonJS import + * const client = new ChimeClient(config); + * const command = new UpdateProxySessionCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link UpdateProxySessionCommandInput} for command's `input` shape. + * @see {@link UpdateProxySessionCommandOutput} for command's `response` shape. + * @see {@link ChimeClientResolvedConfig | config} for command's `input` shape. + * */ export class UpdateProxySessionCommand extends $Command< UpdateProxySessionCommandInput, diff --git a/clients/client-chime/commands/UpdateRoomCommand.ts b/clients/client-chime/commands/UpdateRoomCommand.ts index 046ef8ce2699..6e2fd2dc0e1c 100644 --- a/clients/client-chime/commands/UpdateRoomCommand.ts +++ b/clients/client-chime/commands/UpdateRoomCommand.ts @@ -22,6 +22,20 @@ export interface UpdateRoomCommandOutput extends UpdateRoomResponse, __MetadataB /** *

Updates room details, such as the room name, for a room in an Amazon Chime Enterprise account.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ChimeClient, UpdateRoomCommand } from "@aws-sdk/client-chime"; // ES Modules import + * // const { ChimeClient, UpdateRoomCommand } = require("@aws-sdk/client-chime"); // CommonJS import + * const client = new ChimeClient(config); + * const command = new UpdateRoomCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link UpdateRoomCommandInput} for command's `input` shape. + * @see {@link UpdateRoomCommandOutput} for command's `response` shape. + * @see {@link ChimeClientResolvedConfig | config} for command's `input` shape. + * */ export class UpdateRoomCommand extends $Command< UpdateRoomCommandInput, diff --git a/clients/client-chime/commands/UpdateRoomMembershipCommand.ts b/clients/client-chime/commands/UpdateRoomMembershipCommand.ts index ad4b451c7e28..4d3b99c6e9b5 100644 --- a/clients/client-chime/commands/UpdateRoomMembershipCommand.ts +++ b/clients/client-chime/commands/UpdateRoomMembershipCommand.ts @@ -25,6 +25,20 @@ export interface UpdateRoomMembershipCommandOutput extends UpdateRoomMembershipR * 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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ChimeClient, UpdateRoomMembershipCommand } from "@aws-sdk/client-chime"; // ES Modules import + * // const { ChimeClient, UpdateRoomMembershipCommand } = require("@aws-sdk/client-chime"); // CommonJS import + * const client = new ChimeClient(config); + * const command = new UpdateRoomMembershipCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link UpdateRoomMembershipCommandInput} for command's `input` shape. + * @see {@link UpdateRoomMembershipCommandOutput} for command's `response` shape. + * @see {@link ChimeClientResolvedConfig | config} for command's `input` shape. + * */ export class UpdateRoomMembershipCommand extends $Command< UpdateRoomMembershipCommandInput, diff --git a/clients/client-chime/commands/UpdateSipMediaApplicationCommand.ts b/clients/client-chime/commands/UpdateSipMediaApplicationCommand.ts index 7cc3fd31cd26..b4507a99a5ec 100644 --- a/clients/client-chime/commands/UpdateSipMediaApplicationCommand.ts +++ b/clients/client-chime/commands/UpdateSipMediaApplicationCommand.ts @@ -22,6 +22,20 @@ export interface UpdateSipMediaApplicationCommandOutput extends UpdateSipMediaAp /** *

Updates the details of the specified SIP media application.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ChimeClient, UpdateSipMediaApplicationCommand } from "@aws-sdk/client-chime"; // ES Modules import + * // const { ChimeClient, UpdateSipMediaApplicationCommand } = require("@aws-sdk/client-chime"); // CommonJS import + * const client = new ChimeClient(config); + * const command = new UpdateSipMediaApplicationCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link UpdateSipMediaApplicationCommandInput} for command's `input` shape. + * @see {@link UpdateSipMediaApplicationCommandOutput} for command's `response` shape. + * @see {@link ChimeClientResolvedConfig | config} for command's `input` shape. + * */ export class UpdateSipMediaApplicationCommand extends $Command< UpdateSipMediaApplicationCommandInput, diff --git a/clients/client-chime/commands/UpdateSipRuleCommand.ts b/clients/client-chime/commands/UpdateSipRuleCommand.ts index bb46ea2ea70e..fb85aa506fcc 100644 --- a/clients/client-chime/commands/UpdateSipRuleCommand.ts +++ b/clients/client-chime/commands/UpdateSipRuleCommand.ts @@ -22,6 +22,20 @@ export interface UpdateSipRuleCommandOutput extends UpdateSipRuleResponse, __Met /** *

Updates the details of the specified SIP rule.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ChimeClient, UpdateSipRuleCommand } from "@aws-sdk/client-chime"; // ES Modules import + * // const { ChimeClient, UpdateSipRuleCommand } = require("@aws-sdk/client-chime"); // CommonJS import + * const client = new ChimeClient(config); + * const command = new UpdateSipRuleCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link UpdateSipRuleCommandInput} for command's `input` shape. + * @see {@link UpdateSipRuleCommandOutput} for command's `response` shape. + * @see {@link ChimeClientResolvedConfig | config} for command's `input` shape. + * */ export class UpdateSipRuleCommand extends $Command< UpdateSipRuleCommandInput, diff --git a/clients/client-chime/commands/UpdateUserCommand.ts b/clients/client-chime/commands/UpdateUserCommand.ts index c657e585a569..413f4a0de48d 100644 --- a/clients/client-chime/commands/UpdateUserCommand.ts +++ b/clients/client-chime/commands/UpdateUserCommand.ts @@ -26,6 +26,20 @@ export interface UpdateUserCommandOutput extends UpdateUserResponse, __MetadataB * LicenseType * updates are supported for this action. *

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ChimeClient, UpdateUserCommand } from "@aws-sdk/client-chime"; // ES Modules import + * // const { ChimeClient, UpdateUserCommand } = require("@aws-sdk/client-chime"); // CommonJS import + * const client = new ChimeClient(config); + * const command = new UpdateUserCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link UpdateUserCommandInput} for command's `input` shape. + * @see {@link UpdateUserCommandOutput} for command's `response` shape. + * @see {@link ChimeClientResolvedConfig | config} for command's `input` shape. + * */ export class UpdateUserCommand extends $Command< UpdateUserCommandInput, diff --git a/clients/client-chime/commands/UpdateUserSettingsCommand.ts b/clients/client-chime/commands/UpdateUserSettingsCommand.ts index 8698d56f2f63..2758165ee12b 100644 --- a/clients/client-chime/commands/UpdateUserSettingsCommand.ts +++ b/clients/client-chime/commands/UpdateUserSettingsCommand.ts @@ -22,6 +22,20 @@ export interface UpdateUserSettingsCommandOutput extends __MetadataBearer {} /** *

Updates the settings for the specified user, such as phone number settings.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ChimeClient, UpdateUserSettingsCommand } from "@aws-sdk/client-chime"; // ES Modules import + * // const { ChimeClient, UpdateUserSettingsCommand } = require("@aws-sdk/client-chime"); // CommonJS import + * const client = new ChimeClient(config); + * const command = new UpdateUserSettingsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link UpdateUserSettingsCommandInput} for command's `input` shape. + * @see {@link UpdateUserSettingsCommandOutput} for command's `response` shape. + * @see {@link ChimeClientResolvedConfig | config} for command's `input` shape. + * */ export class UpdateUserSettingsCommand extends $Command< UpdateUserSettingsCommandInput, diff --git a/clients/client-chime/commands/UpdateVoiceConnectorCommand.ts b/clients/client-chime/commands/UpdateVoiceConnectorCommand.ts index f55fb16eabc3..559be706cc53 100644 --- a/clients/client-chime/commands/UpdateVoiceConnectorCommand.ts +++ b/clients/client-chime/commands/UpdateVoiceConnectorCommand.ts @@ -22,6 +22,20 @@ export interface UpdateVoiceConnectorCommandOutput extends UpdateVoiceConnectorR /** *

Updates details for the specified Amazon Chime Voice Connector.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ChimeClient, UpdateVoiceConnectorCommand } from "@aws-sdk/client-chime"; // ES Modules import + * // const { ChimeClient, UpdateVoiceConnectorCommand } = require("@aws-sdk/client-chime"); // CommonJS import + * const client = new ChimeClient(config); + * const command = new UpdateVoiceConnectorCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link UpdateVoiceConnectorCommandInput} for command's `input` shape. + * @see {@link UpdateVoiceConnectorCommandOutput} for command's `response` shape. + * @see {@link ChimeClientResolvedConfig | config} for command's `input` shape. + * */ export class UpdateVoiceConnectorCommand extends $Command< UpdateVoiceConnectorCommandInput, diff --git a/clients/client-chime/commands/UpdateVoiceConnectorGroupCommand.ts b/clients/client-chime/commands/UpdateVoiceConnectorGroupCommand.ts index 4c691b1b4201..539256f665a9 100644 --- a/clients/client-chime/commands/UpdateVoiceConnectorGroupCommand.ts +++ b/clients/client-chime/commands/UpdateVoiceConnectorGroupCommand.ts @@ -23,6 +23,20 @@ export interface UpdateVoiceConnectorGroupCommandOutput extends UpdateVoiceConne /** *

Updates details of the specified Amazon Chime Voice Connector group, such as the name and * Amazon Chime Voice Connector priority ranking.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ChimeClient, UpdateVoiceConnectorGroupCommand } from "@aws-sdk/client-chime"; // ES Modules import + * // const { ChimeClient, UpdateVoiceConnectorGroupCommand } = require("@aws-sdk/client-chime"); // CommonJS import + * const client = new ChimeClient(config); + * const command = new UpdateVoiceConnectorGroupCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link UpdateVoiceConnectorGroupCommandInput} for command's `input` shape. + * @see {@link UpdateVoiceConnectorGroupCommandOutput} for command's `response` shape. + * @see {@link ChimeClientResolvedConfig | config} for command's `input` shape. + * */ export class UpdateVoiceConnectorGroupCommand extends $Command< UpdateVoiceConnectorGroupCommandInput, diff --git a/clients/client-chime/models/models_0.ts b/clients/client-chime/models/models_0.ts index 56f11573f16b..faa64b41b997 100644 --- a/clients/client-chime/models/models_0.ts +++ b/clients/client-chime/models/models_0.ts @@ -30,6 +30,9 @@ export interface AccessDeniedException extends __SmithyException, $MetadataBeare } export namespace AccessDeniedException { + /** + * @internal + */ export const filterSensitiveLog = (obj: AccessDeniedException): any => ({ ...obj, }); @@ -60,6 +63,9 @@ export interface SigninDelegateGroup { } export namespace SigninDelegateGroup { + /** + * @internal + */ export const filterSensitiveLog = (obj: SigninDelegateGroup): any => ({ ...obj, }); @@ -113,6 +119,9 @@ export interface Account { } export namespace Account { + /** + * @internal + */ export const filterSensitiveLog = (obj: Account): any => ({ ...obj, }); @@ -139,6 +148,9 @@ export interface AccountSettings { } export namespace AccountSettings { + /** + * @internal + */ export const filterSensitiveLog = (obj: AccountSettings): any => ({ ...obj, }); @@ -160,6 +172,9 @@ export interface AlexaForBusinessMetadata { } export namespace AlexaForBusinessMetadata { + /** + * @internal + */ export const filterSensitiveLog = (obj: AlexaForBusinessMetadata): any => ({ ...obj, ...(obj.AlexaForBusinessRoomArn && { AlexaForBusinessRoomArn: SENSITIVE_STRING }), @@ -197,6 +212,9 @@ export interface AppInstance { } export namespace AppInstance { + /** + * @internal + */ export const filterSensitiveLog = (obj: AppInstance): any => ({ ...obj, ...(obj.Name && { Name: SENSITIVE_STRING }), @@ -220,6 +238,9 @@ export interface Identity { } export namespace Identity { + /** + * @internal + */ export const filterSensitiveLog = (obj: Identity): any => ({ ...obj, ...(obj.Name && { Name: SENSITIVE_STRING }), @@ -247,6 +268,9 @@ export interface AppInstanceAdmin { } export namespace AppInstanceAdmin { + /** + * @internal + */ export const filterSensitiveLog = (obj: AppInstanceAdmin): any => ({ ...obj, ...(obj.Admin && { Admin: Identity.filterSensitiveLog(obj.Admin) }), @@ -264,6 +288,9 @@ export interface AppInstanceAdminSummary { } export namespace AppInstanceAdminSummary { + /** + * @internal + */ export const filterSensitiveLog = (obj: AppInstanceAdminSummary): any => ({ ...obj, ...(obj.Admin && { Admin: Identity.filterSensitiveLog(obj.Admin) }), @@ -296,6 +323,9 @@ export interface AppInstanceSummary { } export namespace AppInstanceSummary { + /** + * @internal + */ export const filterSensitiveLog = (obj: AppInstanceSummary): any => ({ ...obj, ...(obj.Name && { Name: SENSITIVE_STRING }), @@ -314,6 +344,9 @@ export interface ChannelRetentionSettings { } export namespace ChannelRetentionSettings { + /** + * @internal + */ export const filterSensitiveLog = (obj: ChannelRetentionSettings): any => ({ ...obj, }); @@ -330,6 +363,9 @@ export interface AppInstanceRetentionSettings { } export namespace AppInstanceRetentionSettings { + /** + * @internal + */ export const filterSensitiveLog = (obj: AppInstanceRetentionSettings): any => ({ ...obj, }); @@ -351,6 +387,9 @@ export interface AppInstanceStreamingConfiguration { } export namespace AppInstanceStreamingConfiguration { + /** + * @internal + */ export const filterSensitiveLog = (obj: AppInstanceStreamingConfiguration): any => ({ ...obj, ...(obj.ResourceArn && { ResourceArn: SENSITIVE_STRING }), @@ -388,6 +427,9 @@ export interface AppInstanceUser { } export namespace AppInstanceUser { + /** + * @internal + */ export const filterSensitiveLog = (obj: AppInstanceUser): any => ({ ...obj, ...(obj.Name && { Name: SENSITIVE_STRING }), @@ -416,6 +458,9 @@ export interface AppInstanceUserSummary { } export namespace AppInstanceUserSummary { + /** + * @internal + */ export const filterSensitiveLog = (obj: AppInstanceUserSummary): any => ({ ...obj, ...(obj.Name && { Name: SENSITIVE_STRING }), @@ -444,6 +489,9 @@ export interface AppInstanceUserMembershipSummary { } export namespace AppInstanceUserMembershipSummary { + /** + * @internal + */ export const filterSensitiveLog = (obj: AppInstanceUserMembershipSummary): any => ({ ...obj, }); @@ -467,6 +515,9 @@ export interface AssociatePhoneNumbersWithVoiceConnectorRequest { } export namespace AssociatePhoneNumbersWithVoiceConnectorRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: AssociatePhoneNumbersWithVoiceConnectorRequest): any => ({ ...obj, ...(obj.E164PhoneNumbers && { E164PhoneNumbers: SENSITIVE_STRING }), @@ -495,6 +546,9 @@ export interface PhoneNumberError { } export namespace PhoneNumberError { + /** + * @internal + */ export const filterSensitiveLog = (obj: PhoneNumberError): any => ({ ...obj, }); @@ -509,6 +563,9 @@ export interface AssociatePhoneNumbersWithVoiceConnectorResponse { } export namespace AssociatePhoneNumbersWithVoiceConnectorResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: AssociatePhoneNumbersWithVoiceConnectorResponse): any => ({ ...obj, }); @@ -525,6 +582,9 @@ export interface BadRequestException extends __SmithyException, $MetadataBearer } export namespace BadRequestException { + /** + * @internal + */ export const filterSensitiveLog = (obj: BadRequestException): any => ({ ...obj, }); @@ -541,6 +601,9 @@ export interface ForbiddenException extends __SmithyException, $MetadataBearer { } export namespace ForbiddenException { + /** + * @internal + */ export const filterSensitiveLog = (obj: ForbiddenException): any => ({ ...obj, }); @@ -557,6 +620,9 @@ export interface NotFoundException extends __SmithyException, $MetadataBearer { } export namespace NotFoundException { + /** + * @internal + */ export const filterSensitiveLog = (obj: NotFoundException): any => ({ ...obj, }); @@ -573,6 +639,9 @@ export interface ServiceFailureException extends __SmithyException, $MetadataBea } export namespace ServiceFailureException { + /** + * @internal + */ export const filterSensitiveLog = (obj: ServiceFailureException): any => ({ ...obj, }); @@ -589,6 +658,9 @@ export interface ServiceUnavailableException extends __SmithyException, $Metadat } export namespace ServiceUnavailableException { + /** + * @internal + */ export const filterSensitiveLog = (obj: ServiceUnavailableException): any => ({ ...obj, }); @@ -605,6 +677,9 @@ export interface ThrottledClientException extends __SmithyException, $MetadataBe } export namespace ThrottledClientException { + /** + * @internal + */ export const filterSensitiveLog = (obj: ThrottledClientException): any => ({ ...obj, }); @@ -621,6 +696,9 @@ export interface UnauthorizedClientException extends __SmithyException, $Metadat } export namespace UnauthorizedClientException { + /** + * @internal + */ export const filterSensitiveLog = (obj: UnauthorizedClientException): any => ({ ...obj, }); @@ -644,6 +722,9 @@ export interface AssociatePhoneNumbersWithVoiceConnectorGroupRequest { } export namespace AssociatePhoneNumbersWithVoiceConnectorGroupRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: AssociatePhoneNumbersWithVoiceConnectorGroupRequest): any => ({ ...obj, ...(obj.E164PhoneNumbers && { E164PhoneNumbers: SENSITIVE_STRING }), @@ -658,6 +739,9 @@ export interface AssociatePhoneNumbersWithVoiceConnectorGroupResponse { } export namespace AssociatePhoneNumbersWithVoiceConnectorGroupResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: AssociatePhoneNumbersWithVoiceConnectorGroupResponse): any => ({ ...obj, }); @@ -681,6 +765,9 @@ export interface AssociatePhoneNumberWithUserRequest { } export namespace AssociatePhoneNumberWithUserRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: AssociatePhoneNumberWithUserRequest): any => ({ ...obj, ...(obj.E164PhoneNumber && { E164PhoneNumber: SENSITIVE_STRING }), @@ -690,6 +777,9 @@ export namespace AssociatePhoneNumberWithUserRequest { export interface AssociatePhoneNumberWithUserResponse {} export namespace AssociatePhoneNumberWithUserResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: AssociatePhoneNumberWithUserResponse): any => ({ ...obj, }); @@ -708,6 +798,9 @@ export interface AssociateSigninDelegateGroupsWithAccountRequest { } export namespace AssociateSigninDelegateGroupsWithAccountRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: AssociateSigninDelegateGroupsWithAccountRequest): any => ({ ...obj, }); @@ -716,6 +809,9 @@ export namespace AssociateSigninDelegateGroupsWithAccountRequest { export interface AssociateSigninDelegateGroupsWithAccountResponse {} export namespace AssociateSigninDelegateGroupsWithAccountResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: AssociateSigninDelegateGroupsWithAccountResponse): any => ({ ...obj, }); @@ -758,6 +854,9 @@ export interface Attendee { } export namespace Attendee { + /** + * @internal + */ export const filterSensitiveLog = (obj: Attendee): any => ({ ...obj, ...(obj.ExternalUserId && { ExternalUserId: SENSITIVE_STRING }), @@ -781,6 +880,9 @@ export interface Tag { } export namespace Tag { + /** + * @internal + */ export const filterSensitiveLog = (obj: Tag): any => ({ ...obj, ...(obj.Key && { Key: SENSITIVE_STRING }), @@ -804,6 +906,9 @@ export interface CreateAttendeeRequestItem { } export namespace CreateAttendeeRequestItem { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateAttendeeRequestItem): any => ({ ...obj, ...(obj.ExternalUserId && { ExternalUserId: SENSITIVE_STRING }), @@ -824,6 +929,9 @@ export interface BatchCreateAttendeeRequest { } export namespace BatchCreateAttendeeRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: BatchCreateAttendeeRequest): any => ({ ...obj, ...(obj.Attendees && { @@ -853,6 +961,9 @@ export interface CreateAttendeeError { } export namespace CreateAttendeeError { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateAttendeeError): any => ({ ...obj, ...(obj.ExternalUserId && { ExternalUserId: SENSITIVE_STRING }), @@ -872,6 +983,9 @@ export interface BatchCreateAttendeeResponse { } export namespace BatchCreateAttendeeResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: BatchCreateAttendeeResponse): any => ({ ...obj, ...(obj.Attendees && { Attendees: obj.Attendees.map((item) => Attendee.filterSensitiveLog(item)) }), @@ -890,6 +1004,9 @@ export interface ResourceLimitExceededException extends __SmithyException, $Meta } export namespace ResourceLimitExceededException { + /** + * @internal + */ export const filterSensitiveLog = (obj: ResourceLimitExceededException): any => ({ ...obj, }); @@ -916,6 +1033,9 @@ export interface MembershipItem { } export namespace MembershipItem { + /** + * @internal + */ export const filterSensitiveLog = (obj: MembershipItem): any => ({ ...obj, }); @@ -939,6 +1059,9 @@ export interface BatchCreateRoomMembershipRequest { } export namespace BatchCreateRoomMembershipRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: BatchCreateRoomMembershipRequest): any => ({ ...obj, }); @@ -965,6 +1088,9 @@ export interface MemberError { } export namespace MemberError { + /** + * @internal + */ export const filterSensitiveLog = (obj: MemberError): any => ({ ...obj, }); @@ -978,6 +1104,9 @@ export interface BatchCreateRoomMembershipResponse { } export namespace BatchCreateRoomMembershipResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: BatchCreateRoomMembershipResponse): any => ({ ...obj, }); @@ -991,6 +1120,9 @@ export interface BatchDeletePhoneNumberRequest { } export namespace BatchDeletePhoneNumberRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: BatchDeletePhoneNumberRequest): any => ({ ...obj, }); @@ -1004,6 +1136,9 @@ export interface BatchDeletePhoneNumberResponse { } export namespace BatchDeletePhoneNumberResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: BatchDeletePhoneNumberResponse): any => ({ ...obj, }); @@ -1022,6 +1157,9 @@ export interface BatchSuspendUserRequest { } export namespace BatchSuspendUserRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: BatchSuspendUserRequest): any => ({ ...obj, }); @@ -1049,6 +1187,9 @@ export interface UserError { } export namespace UserError { + /** + * @internal + */ export const filterSensitiveLog = (obj: UserError): any => ({ ...obj, }); @@ -1063,6 +1204,9 @@ export interface BatchSuspendUserResponse { } export namespace BatchSuspendUserResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: BatchSuspendUserResponse): any => ({ ...obj, }); @@ -1081,6 +1225,9 @@ export interface BatchUnsuspendUserRequest { } export namespace BatchUnsuspendUserRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: BatchUnsuspendUserRequest): any => ({ ...obj, }); @@ -1095,6 +1242,9 @@ export interface BatchUnsuspendUserResponse { } export namespace BatchUnsuspendUserResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: BatchUnsuspendUserResponse): any => ({ ...obj, }); @@ -1132,6 +1282,9 @@ export interface UpdatePhoneNumberRequestItem { } export namespace UpdatePhoneNumberRequestItem { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdatePhoneNumberRequestItem): any => ({ ...obj, ...(obj.CallingName && { CallingName: SENSITIVE_STRING }), @@ -1146,6 +1299,9 @@ export interface BatchUpdatePhoneNumberRequest { } export namespace BatchUpdatePhoneNumberRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: BatchUpdatePhoneNumberRequest): any => ({ ...obj, ...(obj.UpdatePhoneNumberRequestItems && { @@ -1164,6 +1320,9 @@ export interface BatchUpdatePhoneNumberResponse { } export namespace BatchUpdatePhoneNumberResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: BatchUpdatePhoneNumberResponse): any => ({ ...obj, }); @@ -1204,6 +1363,9 @@ export interface UpdateUserRequestItem { } export namespace UpdateUserRequestItem { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateUserRequestItem): any => ({ ...obj, ...(obj.AlexaForBusinessMetadata && { @@ -1225,6 +1387,9 @@ export interface BatchUpdateUserRequest { } export namespace BatchUpdateUserRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: BatchUpdateUserRequest): any => ({ ...obj, ...(obj.UpdateUserRequestItems && { @@ -1242,6 +1407,9 @@ export interface BatchUpdateUserResponse { } export namespace BatchUpdateUserResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: BatchUpdateUserResponse): any => ({ ...obj, }); @@ -1302,6 +1470,9 @@ export interface Bot { } export namespace Bot { + /** + * @internal + */ export const filterSensitiveLog = (obj: Bot): any => ({ ...obj, ...(obj.DisplayName && { DisplayName: SENSITIVE_STRING }), @@ -1322,6 +1493,9 @@ export interface BusinessCallingSettings { } export namespace BusinessCallingSettings { + /** + * @internal + */ export const filterSensitiveLog = (obj: BusinessCallingSettings): any => ({ ...obj, }); @@ -1400,6 +1574,9 @@ export interface Channel { } export namespace Channel { + /** + * @internal + */ export const filterSensitiveLog = (obj: Channel): any => ({ ...obj, ...(obj.Name && { Name: SENSITIVE_STRING }), @@ -1434,6 +1611,9 @@ export interface ChannelBan { } export namespace ChannelBan { + /** + * @internal + */ export const filterSensitiveLog = (obj: ChannelBan): any => ({ ...obj, ...(obj.Member && { Member: Identity.filterSensitiveLog(obj.Member) }), @@ -1452,6 +1632,9 @@ export interface ChannelBanSummary { } export namespace ChannelBanSummary { + /** + * @internal + */ export const filterSensitiveLog = (obj: ChannelBanSummary): any => ({ ...obj, ...(obj.Member && { Member: Identity.filterSensitiveLog(obj.Member) }), @@ -1494,6 +1677,9 @@ export interface ChannelMembership { } export namespace ChannelMembership { + /** + * @internal + */ export const filterSensitiveLog = (obj: ChannelMembership): any => ({ ...obj, ...(obj.InvitedBy && { InvitedBy: Identity.filterSensitiveLog(obj.InvitedBy) }), @@ -1537,6 +1723,9 @@ export interface ChannelSummary { } export namespace ChannelSummary { + /** + * @internal + */ export const filterSensitiveLog = (obj: ChannelSummary): any => ({ ...obj, ...(obj.Name && { Name: SENSITIVE_STRING }), @@ -1560,6 +1749,9 @@ export interface ChannelMembershipForAppInstanceUserSummary { } export namespace ChannelMembershipForAppInstanceUserSummary { + /** + * @internal + */ export const filterSensitiveLog = (obj: ChannelMembershipForAppInstanceUserSummary): any => ({ ...obj, ...(obj.ChannelSummary && { ChannelSummary: ChannelSummary.filterSensitiveLog(obj.ChannelSummary) }), @@ -1577,6 +1769,9 @@ export interface ChannelMembershipSummary { } export namespace ChannelMembershipSummary { + /** + * @internal + */ export const filterSensitiveLog = (obj: ChannelMembershipSummary): any => ({ ...obj, ...(obj.Member && { Member: Identity.filterSensitiveLog(obj.Member) }), @@ -1654,6 +1849,9 @@ export interface ChannelMessage { } export namespace ChannelMessage { + /** + * @internal + */ export const filterSensitiveLog = (obj: ChannelMessage): any => ({ ...obj, ...(obj.Content && { Content: SENSITIVE_STRING }), @@ -1713,6 +1911,9 @@ export interface ChannelMessageSummary { } export namespace ChannelMessageSummary { + /** + * @internal + */ export const filterSensitiveLog = (obj: ChannelMessageSummary): any => ({ ...obj, ...(obj.Content && { Content: SENSITIVE_STRING }), @@ -1732,6 +1933,9 @@ export interface ChannelModeratedByAppInstanceUserSummary { } export namespace ChannelModeratedByAppInstanceUserSummary { + /** + * @internal + */ export const filterSensitiveLog = (obj: ChannelModeratedByAppInstanceUserSummary): any => ({ ...obj, ...(obj.ChannelSummary && { ChannelSummary: ChannelSummary.filterSensitiveLog(obj.ChannelSummary) }), @@ -1764,6 +1968,9 @@ export interface ChannelModerator { } export namespace ChannelModerator { + /** + * @internal + */ export const filterSensitiveLog = (obj: ChannelModerator): any => ({ ...obj, ...(obj.Moderator && { Moderator: Identity.filterSensitiveLog(obj.Moderator) }), @@ -1782,6 +1989,9 @@ export interface ChannelModeratorSummary { } export namespace ChannelModeratorSummary { + /** + * @internal + */ export const filterSensitiveLog = (obj: ChannelModeratorSummary): any => ({ ...obj, ...(obj.Moderator && { Moderator: Identity.filterSensitiveLog(obj.Moderator) }), @@ -1800,6 +2010,9 @@ export interface ConflictException extends __SmithyException, $MetadataBearer { } export namespace ConflictException { + /** + * @internal + */ export const filterSensitiveLog = (obj: ConflictException): any => ({ ...obj, }); @@ -1816,6 +2029,9 @@ export interface ConversationRetentionSettings { } export namespace ConversationRetentionSettings { + /** + * @internal + */ export const filterSensitiveLog = (obj: ConversationRetentionSettings): any => ({ ...obj, }); @@ -1829,6 +2045,9 @@ export interface CreateAccountRequest { } export namespace CreateAccountRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateAccountRequest): any => ({ ...obj, }); @@ -1842,6 +2061,9 @@ export interface CreateAccountResponse { } export namespace CreateAccountResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateAccountResponse): any => ({ ...obj, }); @@ -1870,6 +2092,9 @@ export interface CreateAppInstanceRequest { } export namespace CreateAppInstanceRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateAppInstanceRequest): any => ({ ...obj, ...(obj.Name && { Name: SENSITIVE_STRING }), @@ -1887,6 +2112,9 @@ export interface CreateAppInstanceResponse { } export namespace CreateAppInstanceResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateAppInstanceResponse): any => ({ ...obj, }); @@ -1905,6 +2133,9 @@ export interface CreateAppInstanceAdminRequest { } export namespace CreateAppInstanceAdminRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateAppInstanceAdminRequest): any => ({ ...obj, }); @@ -1923,6 +2154,9 @@ export interface CreateAppInstanceAdminResponse { } export namespace CreateAppInstanceAdminResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateAppInstanceAdminResponse): any => ({ ...obj, ...(obj.AppInstanceAdmin && { AppInstanceAdmin: Identity.filterSensitiveLog(obj.AppInstanceAdmin) }), @@ -1962,6 +2196,9 @@ export interface CreateAppInstanceUserRequest { } export namespace CreateAppInstanceUserRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateAppInstanceUserRequest): any => ({ ...obj, ...(obj.AppInstanceUserId && { AppInstanceUserId: SENSITIVE_STRING }), @@ -1980,6 +2217,9 @@ export interface CreateAppInstanceUserResponse { } export namespace CreateAppInstanceUserResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateAppInstanceUserResponse): any => ({ ...obj, }); @@ -2003,6 +2243,9 @@ export interface CreateAttendeeRequest { } export namespace CreateAttendeeRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateAttendeeRequest): any => ({ ...obj, ...(obj.ExternalUserId && { ExternalUserId: SENSITIVE_STRING }), @@ -2018,6 +2261,9 @@ export interface CreateAttendeeResponse { } export namespace CreateAttendeeResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateAttendeeResponse): any => ({ ...obj, ...(obj.Attendee && { Attendee: Attendee.filterSensitiveLog(obj.Attendee) }), @@ -2042,6 +2288,9 @@ export interface CreateBotRequest { } export namespace CreateBotRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateBotRequest): any => ({ ...obj, ...(obj.DisplayName && { DisplayName: SENSITIVE_STRING }), @@ -2056,6 +2305,9 @@ export interface CreateBotResponse { } export namespace CreateBotResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateBotResponse): any => ({ ...obj, ...(obj.Bot && { Bot: Bot.filterSensitiveLog(obj.Bot) }), @@ -2107,6 +2359,9 @@ export interface CreateChannelRequest { } export namespace CreateChannelRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateChannelRequest): any => ({ ...obj, ...(obj.Name && { Name: SENSITIVE_STRING }), @@ -2124,6 +2379,9 @@ export interface CreateChannelResponse { } export namespace CreateChannelResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateChannelResponse): any => ({ ...obj, }); @@ -2147,6 +2405,9 @@ export interface CreateChannelBanRequest { } export namespace CreateChannelBanRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateChannelBanRequest): any => ({ ...obj, }); @@ -2165,6 +2426,9 @@ export interface CreateChannelBanResponse { } export namespace CreateChannelBanResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateChannelBanResponse): any => ({ ...obj, ...(obj.Member && { Member: Identity.filterSensitiveLog(obj.Member) }), @@ -2196,6 +2460,9 @@ export interface CreateChannelMembershipRequest { } export namespace CreateChannelMembershipRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateChannelMembershipRequest): any => ({ ...obj, }); @@ -2214,6 +2481,9 @@ export interface CreateChannelMembershipResponse { } export namespace CreateChannelMembershipResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateChannelMembershipResponse): any => ({ ...obj, ...(obj.Member && { Member: Identity.filterSensitiveLog(obj.Member) }), @@ -2238,6 +2508,9 @@ export interface CreateChannelModeratorRequest { } export namespace CreateChannelModeratorRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateChannelModeratorRequest): any => ({ ...obj, }); @@ -2256,6 +2529,9 @@ export interface CreateChannelModeratorResponse { } export namespace CreateChannelModeratorResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateChannelModeratorResponse): any => ({ ...obj, ...(obj.ChannelModerator && { ChannelModerator: Identity.filterSensitiveLog(obj.ChannelModerator) }), @@ -2280,6 +2556,9 @@ export interface MeetingNotificationConfiguration { } export namespace MeetingNotificationConfiguration { + /** + * @internal + */ export const filterSensitiveLog = (obj: MeetingNotificationConfiguration): any => ({ ...obj, ...(obj.SnsTopicArn && { SnsTopicArn: SENSITIVE_STRING }), @@ -2362,6 +2641,9 @@ export interface CreateMeetingRequest { } export namespace CreateMeetingRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateMeetingRequest): any => ({ ...obj, ...(obj.ClientRequestToken && { ClientRequestToken: SENSITIVE_STRING }), @@ -2415,6 +2697,9 @@ export interface MediaPlacement { } export namespace MediaPlacement { + /** + * @internal + */ export const filterSensitiveLog = (obj: MediaPlacement): any => ({ ...obj, }); @@ -2452,6 +2737,9 @@ export interface Meeting { } export namespace Meeting { + /** + * @internal + */ export const filterSensitiveLog = (obj: Meeting): any => ({ ...obj, ...(obj.ExternalMeetingId && { ExternalMeetingId: SENSITIVE_STRING }), @@ -2470,6 +2758,9 @@ export interface CreateMeetingResponse { } export namespace CreateMeetingResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateMeetingResponse): any => ({ ...obj, ...(obj.Meeting && { Meeting: Meeting.filterSensitiveLog(obj.Meeting) }), @@ -2501,6 +2792,9 @@ export interface CreateMeetingDialOutRequest { } export namespace CreateMeetingDialOutRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateMeetingDialOutRequest): any => ({ ...obj, ...(obj.FromPhoneNumber && { FromPhoneNumber: SENSITIVE_STRING }), @@ -2517,6 +2811,9 @@ export interface CreateMeetingDialOutResponse { } export namespace CreateMeetingDialOutResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateMeetingDialOutResponse): any => ({ ...obj, }); @@ -2605,6 +2902,9 @@ export interface CreateMeetingWithAttendeesRequest { } export namespace CreateMeetingWithAttendeesRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateMeetingWithAttendeesRequest): any => ({ ...obj, ...(obj.ClientRequestToken && { ClientRequestToken: SENSITIVE_STRING }), @@ -2638,6 +2938,9 @@ export interface CreateMeetingWithAttendeesResponse { } export namespace CreateMeetingWithAttendeesResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateMeetingWithAttendeesResponse): any => ({ ...obj, ...(obj.Meeting && { Meeting: Meeting.filterSensitiveLog(obj.Meeting) }), @@ -2659,6 +2962,9 @@ export interface CreatePhoneNumberOrderRequest { } export namespace CreatePhoneNumberOrderRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreatePhoneNumberOrderRequest): any => ({ ...obj, ...(obj.E164PhoneNumbers && { E164PhoneNumbers: SENSITIVE_STRING }), @@ -2687,6 +2993,9 @@ export interface OrderedPhoneNumber { } export namespace OrderedPhoneNumber { + /** + * @internal + */ export const filterSensitiveLog = (obj: OrderedPhoneNumber): any => ({ ...obj, ...(obj.E164PhoneNumber && { E164PhoneNumber: SENSITIVE_STRING }), @@ -2737,6 +3046,9 @@ export interface PhoneNumberOrder { } export namespace PhoneNumberOrder { + /** + * @internal + */ export const filterSensitiveLog = (obj: PhoneNumberOrder): any => ({ ...obj, ...(obj.OrderedPhoneNumbers && { @@ -2753,6 +3065,9 @@ export interface CreatePhoneNumberOrderResponse { } export namespace CreatePhoneNumberOrderResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreatePhoneNumberOrderResponse): any => ({ ...obj, ...(obj.PhoneNumberOrder && { PhoneNumberOrder: PhoneNumberOrder.filterSensitiveLog(obj.PhoneNumberOrder) }), @@ -2780,6 +3095,9 @@ export interface GeoMatchParams { } export namespace GeoMatchParams { + /** + * @internal + */ export const filterSensitiveLog = (obj: GeoMatchParams): any => ({ ...obj, }); @@ -2833,6 +3151,9 @@ export interface CreateProxySessionRequest { } export namespace CreateProxySessionRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateProxySessionRequest): any => ({ ...obj, ...(obj.ParticipantPhoneNumbers && { ParticipantPhoneNumbers: SENSITIVE_STRING }), @@ -2856,6 +3177,9 @@ export interface Participant { } export namespace Participant { + /** + * @internal + */ export const filterSensitiveLog = (obj: Participant): any => ({ ...obj, ...(obj.PhoneNumber && { PhoneNumber: SENSITIVE_STRING }), @@ -2940,6 +3264,9 @@ export interface ProxySession { } export namespace ProxySession { + /** + * @internal + */ export const filterSensitiveLog = (obj: ProxySession): any => ({ ...obj, ...(obj.Participants && { Participants: obj.Participants.map((item) => Participant.filterSensitiveLog(item)) }), @@ -2954,6 +3281,9 @@ export interface CreateProxySessionResponse { } export namespace CreateProxySessionResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateProxySessionResponse): any => ({ ...obj, ...(obj.ProxySession && { ProxySession: ProxySession.filterSensitiveLog(obj.ProxySession) }), @@ -2978,6 +3308,9 @@ export interface CreateRoomRequest { } export namespace CreateRoomRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateRoomRequest): any => ({ ...obj, ...(obj.Name && { Name: SENSITIVE_STRING }), @@ -3021,6 +3354,9 @@ export interface Room { } export namespace Room { + /** + * @internal + */ export const filterSensitiveLog = (obj: Room): any => ({ ...obj, ...(obj.Name && { Name: SENSITIVE_STRING }), @@ -3035,6 +3371,9 @@ export interface CreateRoomResponse { } export namespace CreateRoomResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateRoomResponse): any => ({ ...obj, ...(obj.Room && { Room: Room.filterSensitiveLog(obj.Room) }), @@ -3064,6 +3403,9 @@ export interface CreateRoomMembershipRequest { } export namespace CreateRoomMembershipRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateRoomMembershipRequest): any => ({ ...obj, }); @@ -3106,6 +3448,9 @@ export interface Member { } export namespace Member { + /** + * @internal + */ export const filterSensitiveLog = (obj: Member): any => ({ ...obj, ...(obj.Email && { Email: SENSITIVE_STRING }), @@ -3144,6 +3489,9 @@ export interface RoomMembership { } export namespace RoomMembership { + /** + * @internal + */ export const filterSensitiveLog = (obj: RoomMembership): any => ({ ...obj, ...(obj.Member && { Member: Member.filterSensitiveLog(obj.Member) }), @@ -3158,6 +3506,9 @@ export interface CreateRoomMembershipResponse { } export namespace CreateRoomMembershipResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateRoomMembershipResponse): any => ({ ...obj, ...(obj.RoomMembership && { RoomMembership: RoomMembership.filterSensitiveLog(obj.RoomMembership) }), @@ -3175,6 +3526,9 @@ export interface SipMediaApplicationEndpoint { } export namespace SipMediaApplicationEndpoint { + /** + * @internal + */ export const filterSensitiveLog = (obj: SipMediaApplicationEndpoint): any => ({ ...obj, ...(obj.LambdaArn && { LambdaArn: SENSITIVE_STRING }), @@ -3199,6 +3553,9 @@ export interface CreateSipMediaApplicationRequest { } export namespace CreateSipMediaApplicationRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateSipMediaApplicationRequest): any => ({ ...obj, ...(obj.Endpoints && { @@ -3243,6 +3600,9 @@ export interface SipMediaApplication { } export namespace SipMediaApplication { + /** + * @internal + */ export const filterSensitiveLog = (obj: SipMediaApplication): any => ({ ...obj, ...(obj.Endpoints && { @@ -3259,6 +3619,9 @@ export interface CreateSipMediaApplicationResponse { } export namespace CreateSipMediaApplicationResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateSipMediaApplicationResponse): any => ({ ...obj, ...(obj.SipMediaApplication && { @@ -3285,6 +3648,9 @@ export interface CreateSipMediaApplicationCallRequest { } export namespace CreateSipMediaApplicationCallRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateSipMediaApplicationCallRequest): any => ({ ...obj, ...(obj.FromPhoneNumber && { FromPhoneNumber: SENSITIVE_STRING }), @@ -3303,6 +3669,9 @@ export interface SipMediaApplicationCall { } export namespace SipMediaApplicationCall { + /** + * @internal + */ export const filterSensitiveLog = (obj: SipMediaApplicationCall): any => ({ ...obj, }); @@ -3316,6 +3685,9 @@ export interface CreateSipMediaApplicationCallResponse { } export namespace CreateSipMediaApplicationCallResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateSipMediaApplicationCallResponse): any => ({ ...obj, }); @@ -3343,6 +3715,9 @@ export interface SipRuleTargetApplication { } export namespace SipRuleTargetApplication { + /** + * @internal + */ export const filterSensitiveLog = (obj: SipRuleTargetApplication): any => ({ ...obj, }); @@ -3386,6 +3761,9 @@ export interface CreateSipRuleRequest { } export namespace CreateSipRuleRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateSipRuleRequest): any => ({ ...obj, }); @@ -3443,6 +3821,9 @@ export interface SipRule { } export namespace SipRule { + /** + * @internal + */ export const filterSensitiveLog = (obj: SipRule): any => ({ ...obj, }); @@ -3456,6 +3837,9 @@ export interface CreateSipRuleResponse { } export namespace CreateSipRuleResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateSipRuleResponse): any => ({ ...obj, }); @@ -3484,6 +3868,9 @@ export interface CreateUserRequest { } export namespace CreateUserRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateUserRequest): any => ({ ...obj, ...(obj.Email && { Email: SENSITIVE_STRING }), @@ -3573,6 +3960,9 @@ export interface User { } export namespace User { + /** + * @internal + */ export const filterSensitiveLog = (obj: User): any => ({ ...obj, ...(obj.PrimaryEmail && { PrimaryEmail: SENSITIVE_STRING }), @@ -3592,6 +3982,9 @@ export interface CreateUserResponse { } export namespace CreateUserResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateUserResponse): any => ({ ...obj, ...(obj.User && { User: User.filterSensitiveLog(obj.User) }), @@ -3625,6 +4018,9 @@ export interface CreateVoiceConnectorRequest { } export namespace CreateVoiceConnectorRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateVoiceConnectorRequest): any => ({ ...obj, }); @@ -3675,6 +4071,9 @@ export interface VoiceConnector { } export namespace VoiceConnector { + /** + * @internal + */ export const filterSensitiveLog = (obj: VoiceConnector): any => ({ ...obj, }); @@ -3688,6 +4087,9 @@ export interface CreateVoiceConnectorResponse { } export namespace CreateVoiceConnectorResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateVoiceConnectorResponse): any => ({ ...obj, }); @@ -3713,6 +4115,9 @@ export interface VoiceConnectorItem { } export namespace VoiceConnectorItem { + /** + * @internal + */ export const filterSensitiveLog = (obj: VoiceConnectorItem): any => ({ ...obj, }); @@ -3731,6 +4136,9 @@ export interface CreateVoiceConnectorGroupRequest { } export namespace CreateVoiceConnectorGroupRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateVoiceConnectorGroupRequest): any => ({ ...obj, }); @@ -3770,6 +4178,9 @@ export interface VoiceConnectorGroup { } export namespace VoiceConnectorGroup { + /** + * @internal + */ export const filterSensitiveLog = (obj: VoiceConnectorGroup): any => ({ ...obj, }); @@ -3783,6 +4194,9 @@ export interface CreateVoiceConnectorGroupResponse { } export namespace CreateVoiceConnectorGroupResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateVoiceConnectorGroupResponse): any => ({ ...obj, }); @@ -3805,6 +4219,9 @@ export interface Credential { } export namespace Credential { + /** + * @internal + */ export const filterSensitiveLog = (obj: Credential): any => ({ ...obj, ...(obj.Username && { Username: SENSITIVE_STRING }), @@ -3820,6 +4237,9 @@ export interface DeleteAccountRequest { } export namespace DeleteAccountRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteAccountRequest): any => ({ ...obj, }); @@ -3828,6 +4248,9 @@ export namespace DeleteAccountRequest { export interface DeleteAccountResponse {} export namespace DeleteAccountResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteAccountResponse): any => ({ ...obj, }); @@ -3844,6 +4267,9 @@ export interface UnprocessableEntityException extends __SmithyException, $Metada } export namespace UnprocessableEntityException { + /** + * @internal + */ export const filterSensitiveLog = (obj: UnprocessableEntityException): any => ({ ...obj, }); @@ -3857,6 +4283,9 @@ export interface DeleteAppInstanceRequest { } export namespace DeleteAppInstanceRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteAppInstanceRequest): any => ({ ...obj, }); @@ -3875,6 +4304,9 @@ export interface DeleteAppInstanceAdminRequest { } export namespace DeleteAppInstanceAdminRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteAppInstanceAdminRequest): any => ({ ...obj, }); @@ -3888,6 +4320,9 @@ export interface DeleteAppInstanceStreamingConfigurationsRequest { } export namespace DeleteAppInstanceStreamingConfigurationsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteAppInstanceStreamingConfigurationsRequest): any => ({ ...obj, }); @@ -3901,6 +4336,9 @@ export interface DeleteAppInstanceUserRequest { } export namespace DeleteAppInstanceUserRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteAppInstanceUserRequest): any => ({ ...obj, }); @@ -3919,6 +4357,9 @@ export interface DeleteAttendeeRequest { } export namespace DeleteAttendeeRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteAttendeeRequest): any => ({ ...obj, }); @@ -3937,6 +4378,9 @@ export interface DeleteChannelRequest { } export namespace DeleteChannelRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteChannelRequest): any => ({ ...obj, }); @@ -3960,6 +4404,9 @@ export interface DeleteChannelBanRequest { } export namespace DeleteChannelBanRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteChannelBanRequest): any => ({ ...obj, }); @@ -3983,6 +4430,9 @@ export interface DeleteChannelMembershipRequest { } export namespace DeleteChannelMembershipRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteChannelMembershipRequest): any => ({ ...obj, }); @@ -4006,6 +4456,9 @@ export interface DeleteChannelMessageRequest { } export namespace DeleteChannelMessageRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteChannelMessageRequest): any => ({ ...obj, }); @@ -4029,6 +4482,9 @@ export interface DeleteChannelModeratorRequest { } export namespace DeleteChannelModeratorRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteChannelModeratorRequest): any => ({ ...obj, }); @@ -4047,6 +4503,9 @@ export interface DeleteEventsConfigurationRequest { } export namespace DeleteEventsConfigurationRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteEventsConfigurationRequest): any => ({ ...obj, }); @@ -4060,6 +4519,9 @@ export interface DeleteMeetingRequest { } export namespace DeleteMeetingRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteMeetingRequest): any => ({ ...obj, }); @@ -4073,6 +4535,9 @@ export interface DeletePhoneNumberRequest { } export namespace DeletePhoneNumberRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeletePhoneNumberRequest): any => ({ ...obj, }); @@ -4091,6 +4556,9 @@ export interface DeleteProxySessionRequest { } export namespace DeleteProxySessionRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteProxySessionRequest): any => ({ ...obj, }); @@ -4109,6 +4577,9 @@ export interface DeleteRoomRequest { } export namespace DeleteRoomRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteRoomRequest): any => ({ ...obj, }); @@ -4132,6 +4603,9 @@ export interface DeleteRoomMembershipRequest { } export namespace DeleteRoomMembershipRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteRoomMembershipRequest): any => ({ ...obj, }); @@ -4145,6 +4619,9 @@ export interface DeleteSipMediaApplicationRequest { } export namespace DeleteSipMediaApplicationRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteSipMediaApplicationRequest): any => ({ ...obj, }); @@ -4158,6 +4635,9 @@ export interface DeleteSipRuleRequest { } export namespace DeleteSipRuleRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteSipRuleRequest): any => ({ ...obj, }); @@ -4171,6 +4651,9 @@ export interface DeleteVoiceConnectorRequest { } export namespace DeleteVoiceConnectorRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteVoiceConnectorRequest): any => ({ ...obj, }); @@ -4184,6 +4667,9 @@ export interface DeleteVoiceConnectorEmergencyCallingConfigurationRequest { } export namespace DeleteVoiceConnectorEmergencyCallingConfigurationRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteVoiceConnectorEmergencyCallingConfigurationRequest): any => ({ ...obj, }); @@ -4197,6 +4683,9 @@ export interface DeleteVoiceConnectorGroupRequest { } export namespace DeleteVoiceConnectorGroupRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteVoiceConnectorGroupRequest): any => ({ ...obj, }); @@ -4210,6 +4699,9 @@ export interface DeleteVoiceConnectorOriginationRequest { } export namespace DeleteVoiceConnectorOriginationRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteVoiceConnectorOriginationRequest): any => ({ ...obj, }); @@ -4223,6 +4715,9 @@ export interface DeleteVoiceConnectorProxyRequest { } export namespace DeleteVoiceConnectorProxyRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteVoiceConnectorProxyRequest): any => ({ ...obj, }); @@ -4236,6 +4731,9 @@ export interface DeleteVoiceConnectorStreamingConfigurationRequest { } export namespace DeleteVoiceConnectorStreamingConfigurationRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteVoiceConnectorStreamingConfigurationRequest): any => ({ ...obj, }); @@ -4249,6 +4747,9 @@ export interface DeleteVoiceConnectorTerminationRequest { } export namespace DeleteVoiceConnectorTerminationRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteVoiceConnectorTerminationRequest): any => ({ ...obj, }); @@ -4267,6 +4768,9 @@ export interface DeleteVoiceConnectorTerminationCredentialsRequest { } export namespace DeleteVoiceConnectorTerminationCredentialsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteVoiceConnectorTerminationCredentialsRequest): any => ({ ...obj, ...(obj.Usernames && { Usernames: SENSITIVE_STRING }), @@ -4281,6 +4785,9 @@ export interface DescribeAppInstanceRequest { } export namespace DescribeAppInstanceRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeAppInstanceRequest): any => ({ ...obj, }); @@ -4295,6 +4802,9 @@ export interface DescribeAppInstanceResponse { } export namespace DescribeAppInstanceResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeAppInstanceResponse): any => ({ ...obj, ...(obj.AppInstance && { AppInstance: AppInstance.filterSensitiveLog(obj.AppInstance) }), @@ -4314,6 +4824,9 @@ export interface DescribeAppInstanceAdminRequest { } export namespace DescribeAppInstanceAdminRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeAppInstanceAdminRequest): any => ({ ...obj, }); @@ -4328,6 +4841,9 @@ export interface DescribeAppInstanceAdminResponse { } export namespace DescribeAppInstanceAdminResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeAppInstanceAdminResponse): any => ({ ...obj, ...(obj.AppInstanceAdmin && { AppInstanceAdmin: AppInstanceAdmin.filterSensitiveLog(obj.AppInstanceAdmin) }), @@ -4342,6 +4858,9 @@ export interface DescribeAppInstanceUserRequest { } export namespace DescribeAppInstanceUserRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeAppInstanceUserRequest): any => ({ ...obj, }); @@ -4355,6 +4874,9 @@ export interface DescribeAppInstanceUserResponse { } export namespace DescribeAppInstanceUserResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeAppInstanceUserResponse): any => ({ ...obj, ...(obj.AppInstanceUser && { AppInstanceUser: AppInstanceUser.filterSensitiveLog(obj.AppInstanceUser) }), @@ -4374,6 +4896,9 @@ export interface DescribeChannelRequest { } export namespace DescribeChannelRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeChannelRequest): any => ({ ...obj, }); @@ -4387,6 +4912,9 @@ export interface DescribeChannelResponse { } export namespace DescribeChannelResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeChannelResponse): any => ({ ...obj, ...(obj.Channel && { Channel: Channel.filterSensitiveLog(obj.Channel) }), @@ -4411,6 +4939,9 @@ export interface DescribeChannelBanRequest { } export namespace DescribeChannelBanRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeChannelBanRequest): any => ({ ...obj, }); @@ -4424,6 +4955,9 @@ export interface DescribeChannelBanResponse { } export namespace DescribeChannelBanResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeChannelBanResponse): any => ({ ...obj, ...(obj.ChannelBan && { ChannelBan: ChannelBan.filterSensitiveLog(obj.ChannelBan) }), @@ -4448,6 +4982,9 @@ export interface DescribeChannelMembershipRequest { } export namespace DescribeChannelMembershipRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeChannelMembershipRequest): any => ({ ...obj, }); @@ -4461,6 +4998,9 @@ export interface DescribeChannelMembershipResponse { } export namespace DescribeChannelMembershipResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeChannelMembershipResponse): any => ({ ...obj, ...(obj.ChannelMembership && { ChannelMembership: ChannelMembership.filterSensitiveLog(obj.ChannelMembership) }), @@ -4485,6 +5025,9 @@ export interface DescribeChannelMembershipForAppInstanceUserRequest { } export namespace DescribeChannelMembershipForAppInstanceUserRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeChannelMembershipForAppInstanceUserRequest): any => ({ ...obj, }); @@ -4498,6 +5041,9 @@ export interface DescribeChannelMembershipForAppInstanceUserResponse { } export namespace DescribeChannelMembershipForAppInstanceUserResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeChannelMembershipForAppInstanceUserResponse): any => ({ ...obj, ...(obj.ChannelMembership && { @@ -4524,6 +5070,9 @@ export interface DescribeChannelModeratedByAppInstanceUserRequest { } export namespace DescribeChannelModeratedByAppInstanceUserRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeChannelModeratedByAppInstanceUserRequest): any => ({ ...obj, }); @@ -4537,6 +5086,9 @@ export interface DescribeChannelModeratedByAppInstanceUserResponse { } export namespace DescribeChannelModeratedByAppInstanceUserResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeChannelModeratedByAppInstanceUserResponse): any => ({ ...obj, ...(obj.Channel && { Channel: ChannelModeratedByAppInstanceUserSummary.filterSensitiveLog(obj.Channel) }), @@ -4561,6 +5113,9 @@ export interface DescribeChannelModeratorRequest { } export namespace DescribeChannelModeratorRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeChannelModeratorRequest): any => ({ ...obj, }); @@ -4574,6 +5129,9 @@ export interface DescribeChannelModeratorResponse { } export namespace DescribeChannelModeratorResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeChannelModeratorResponse): any => ({ ...obj, ...(obj.ChannelModerator && { ChannelModerator: ChannelModerator.filterSensitiveLog(obj.ChannelModerator) }), @@ -4593,6 +5151,9 @@ export interface DisassociatePhoneNumberFromUserRequest { } export namespace DisassociatePhoneNumberFromUserRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DisassociatePhoneNumberFromUserRequest): any => ({ ...obj, }); @@ -4601,6 +5162,9 @@ export namespace DisassociatePhoneNumberFromUserRequest { export interface DisassociatePhoneNumberFromUserResponse {} export namespace DisassociatePhoneNumberFromUserResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DisassociatePhoneNumberFromUserResponse): any => ({ ...obj, }); @@ -4619,6 +5183,9 @@ export interface DisassociatePhoneNumbersFromVoiceConnectorRequest { } export namespace DisassociatePhoneNumbersFromVoiceConnectorRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DisassociatePhoneNumbersFromVoiceConnectorRequest): any => ({ ...obj, ...(obj.E164PhoneNumbers && { E164PhoneNumbers: SENSITIVE_STRING }), @@ -4633,6 +5200,9 @@ export interface DisassociatePhoneNumbersFromVoiceConnectorResponse { } export namespace DisassociatePhoneNumbersFromVoiceConnectorResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DisassociatePhoneNumbersFromVoiceConnectorResponse): any => ({ ...obj, }); @@ -4651,6 +5221,9 @@ export interface DisassociatePhoneNumbersFromVoiceConnectorGroupRequest { } export namespace DisassociatePhoneNumbersFromVoiceConnectorGroupRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DisassociatePhoneNumbersFromVoiceConnectorGroupRequest): any => ({ ...obj, ...(obj.E164PhoneNumbers && { E164PhoneNumbers: SENSITIVE_STRING }), @@ -4665,6 +5238,9 @@ export interface DisassociatePhoneNumbersFromVoiceConnectorGroupResponse { } export namespace DisassociatePhoneNumbersFromVoiceConnectorGroupResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DisassociatePhoneNumbersFromVoiceConnectorGroupResponse): any => ({ ...obj, }); @@ -4683,6 +5259,9 @@ export interface DisassociateSigninDelegateGroupsFromAccountRequest { } export namespace DisassociateSigninDelegateGroupsFromAccountRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DisassociateSigninDelegateGroupsFromAccountRequest): any => ({ ...obj, }); @@ -4691,6 +5270,9 @@ export namespace DisassociateSigninDelegateGroupsFromAccountRequest { export interface DisassociateSigninDelegateGroupsFromAccountResponse {} export namespace DisassociateSigninDelegateGroupsFromAccountResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DisassociateSigninDelegateGroupsFromAccountResponse): any => ({ ...obj, }); @@ -4717,6 +5299,9 @@ export interface DNISEmergencyCallingConfiguration { } export namespace DNISEmergencyCallingConfiguration { + /** + * @internal + */ export const filterSensitiveLog = (obj: DNISEmergencyCallingConfiguration): any => ({ ...obj, ...(obj.EmergencyPhoneNumber && { EmergencyPhoneNumber: SENSITIVE_STRING }), @@ -4741,6 +5326,9 @@ export interface EmergencyCallingConfiguration { } export namespace EmergencyCallingConfiguration { + /** + * @internal + */ export const filterSensitiveLog = (obj: EmergencyCallingConfiguration): any => ({ ...obj, ...(obj.DNIS && { DNIS: obj.DNIS.map((item) => DNISEmergencyCallingConfiguration.filterSensitiveLog(item)) }), @@ -4768,6 +5356,9 @@ export interface EventsConfiguration { } export namespace EventsConfiguration { + /** + * @internal + */ export const filterSensitiveLog = (obj: EventsConfiguration): any => ({ ...obj, ...(obj.OutboundEventsHTTPSEndpoint && { OutboundEventsHTTPSEndpoint: SENSITIVE_STRING }), @@ -4783,6 +5374,9 @@ export interface GetAccountRequest { } export namespace GetAccountRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetAccountRequest): any => ({ ...obj, }); @@ -4796,6 +5390,9 @@ export interface GetAccountResponse { } export namespace GetAccountResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetAccountResponse): any => ({ ...obj, }); @@ -4809,6 +5406,9 @@ export interface GetAccountSettingsRequest { } export namespace GetAccountSettingsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetAccountSettingsRequest): any => ({ ...obj, }); @@ -4822,6 +5422,9 @@ export interface GetAccountSettingsResponse { } export namespace GetAccountSettingsResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetAccountSettingsResponse): any => ({ ...obj, }); @@ -4835,6 +5438,9 @@ export interface GetAppInstanceRetentionSettingsRequest { } export namespace GetAppInstanceRetentionSettingsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetAppInstanceRetentionSettingsRequest): any => ({ ...obj, }); @@ -4853,6 +5459,9 @@ export interface GetAppInstanceRetentionSettingsResponse { } export namespace GetAppInstanceRetentionSettingsResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetAppInstanceRetentionSettingsResponse): any => ({ ...obj, }); @@ -4866,6 +5475,9 @@ export interface GetAppInstanceStreamingConfigurationsRequest { } export namespace GetAppInstanceStreamingConfigurationsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetAppInstanceStreamingConfigurationsRequest): any => ({ ...obj, }); @@ -4879,6 +5491,9 @@ export interface GetAppInstanceStreamingConfigurationsResponse { } export namespace GetAppInstanceStreamingConfigurationsResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetAppInstanceStreamingConfigurationsResponse): any => ({ ...obj, ...(obj.AppInstanceStreamingConfigurations && { @@ -4902,6 +5517,9 @@ export interface GetAttendeeRequest { } export namespace GetAttendeeRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetAttendeeRequest): any => ({ ...obj, }); @@ -4915,6 +5533,9 @@ export interface GetAttendeeResponse { } export namespace GetAttendeeResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetAttendeeResponse): any => ({ ...obj, ...(obj.Attendee && { Attendee: Attendee.filterSensitiveLog(obj.Attendee) }), @@ -4934,6 +5555,9 @@ export interface GetBotRequest { } export namespace GetBotRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetBotRequest): any => ({ ...obj, }); @@ -4947,6 +5571,9 @@ export interface GetBotResponse { } export namespace GetBotResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetBotResponse): any => ({ ...obj, ...(obj.Bot && { Bot: Bot.filterSensitiveLog(obj.Bot) }), @@ -4971,6 +5598,9 @@ export interface GetChannelMessageRequest { } export namespace GetChannelMessageRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetChannelMessageRequest): any => ({ ...obj, }); @@ -4984,6 +5614,9 @@ export interface GetChannelMessageResponse { } export namespace GetChannelMessageResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetChannelMessageResponse): any => ({ ...obj, ...(obj.ChannelMessage && { ChannelMessage: ChannelMessage.filterSensitiveLog(obj.ChannelMessage) }), @@ -5003,6 +5636,9 @@ export interface GetEventsConfigurationRequest { } export namespace GetEventsConfigurationRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetEventsConfigurationRequest): any => ({ ...obj, }); @@ -5016,6 +5652,9 @@ export interface GetEventsConfigurationResponse { } export namespace GetEventsConfigurationResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetEventsConfigurationResponse): any => ({ ...obj, ...(obj.EventsConfiguration && { @@ -5036,6 +5675,9 @@ export interface VoiceConnectorSettings { } export namespace VoiceConnectorSettings { + /** + * @internal + */ export const filterSensitiveLog = (obj: VoiceConnectorSettings): any => ({ ...obj, }); @@ -5054,6 +5696,9 @@ export interface GetGlobalSettingsResponse { } export namespace GetGlobalSettingsResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetGlobalSettingsResponse): any => ({ ...obj, }); @@ -5067,6 +5712,9 @@ export interface GetMeetingRequest { } export namespace GetMeetingRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetMeetingRequest): any => ({ ...obj, }); @@ -5080,6 +5728,9 @@ export interface GetMeetingResponse { } export namespace GetMeetingResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetMeetingResponse): any => ({ ...obj, ...(obj.Meeting && { Meeting: Meeting.filterSensitiveLog(obj.Meeting) }), @@ -5089,6 +5740,9 @@ export namespace GetMeetingResponse { export interface GetMessagingSessionEndpointRequest {} export namespace GetMessagingSessionEndpointRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetMessagingSessionEndpointRequest): any => ({ ...obj, }); @@ -5105,6 +5759,9 @@ export interface MessagingSessionEndpoint { } export namespace MessagingSessionEndpoint { + /** + * @internal + */ export const filterSensitiveLog = (obj: MessagingSessionEndpoint): any => ({ ...obj, }); @@ -5118,6 +5775,9 @@ export interface GetMessagingSessionEndpointResponse { } export namespace GetMessagingSessionEndpointResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetMessagingSessionEndpointResponse): any => ({ ...obj, }); @@ -5131,6 +5791,9 @@ export interface GetPhoneNumberRequest { } export namespace GetPhoneNumberRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetPhoneNumberRequest): any => ({ ...obj, }); @@ -5167,6 +5830,9 @@ export interface PhoneNumberAssociation { } export namespace PhoneNumberAssociation { + /** + * @internal + */ export const filterSensitiveLog = (obj: PhoneNumberAssociation): any => ({ ...obj, }); @@ -5209,6 +5875,9 @@ export interface PhoneNumberCapabilities { } export namespace PhoneNumberCapabilities { + /** + * @internal + */ export const filterSensitiveLog = (obj: PhoneNumberCapabilities): any => ({ ...obj, }); @@ -5297,6 +5966,9 @@ export interface PhoneNumber { } export namespace PhoneNumber { + /** + * @internal + */ export const filterSensitiveLog = (obj: PhoneNumber): any => ({ ...obj, ...(obj.E164PhoneNumber && { E164PhoneNumber: SENSITIVE_STRING }), @@ -5312,6 +5984,9 @@ export interface GetPhoneNumberResponse { } export namespace GetPhoneNumberResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetPhoneNumberResponse): any => ({ ...obj, ...(obj.PhoneNumber && { PhoneNumber: PhoneNumber.filterSensitiveLog(obj.PhoneNumber) }), @@ -5326,6 +6001,9 @@ export interface GetPhoneNumberOrderRequest { } export namespace GetPhoneNumberOrderRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetPhoneNumberOrderRequest): any => ({ ...obj, }); @@ -5339,6 +6017,9 @@ export interface GetPhoneNumberOrderResponse { } export namespace GetPhoneNumberOrderResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetPhoneNumberOrderResponse): any => ({ ...obj, ...(obj.PhoneNumberOrder && { PhoneNumberOrder: PhoneNumberOrder.filterSensitiveLog(obj.PhoneNumberOrder) }), @@ -5358,6 +6039,9 @@ export interface GetPhoneNumberSettingsResponse { } export namespace GetPhoneNumberSettingsResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetPhoneNumberSettingsResponse): any => ({ ...obj, ...(obj.CallingName && { CallingName: SENSITIVE_STRING }), @@ -5377,6 +6061,9 @@ export interface GetProxySessionRequest { } export namespace GetProxySessionRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetProxySessionRequest): any => ({ ...obj, }); @@ -5390,6 +6077,9 @@ export interface GetProxySessionResponse { } export namespace GetProxySessionResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetProxySessionResponse): any => ({ ...obj, ...(obj.ProxySession && { ProxySession: ProxySession.filterSensitiveLog(obj.ProxySession) }), @@ -5404,6 +6094,9 @@ export interface GetRetentionSettingsRequest { } export namespace GetRetentionSettingsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetRetentionSettingsRequest): any => ({ ...obj, }); @@ -5420,6 +6113,9 @@ export interface RoomRetentionSettings { } export namespace RoomRetentionSettings { + /** + * @internal + */ export const filterSensitiveLog = (obj: RoomRetentionSettings): any => ({ ...obj, }); @@ -5441,6 +6137,9 @@ export interface RetentionSettings { } export namespace RetentionSettings { + /** + * @internal + */ export const filterSensitiveLog = (obj: RetentionSettings): any => ({ ...obj, }); @@ -5459,6 +6158,9 @@ export interface GetRetentionSettingsResponse { } export namespace GetRetentionSettingsResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetRetentionSettingsResponse): any => ({ ...obj, }); @@ -5477,6 +6179,9 @@ export interface GetRoomRequest { } export namespace GetRoomRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetRoomRequest): any => ({ ...obj, }); @@ -5490,6 +6195,9 @@ export interface GetRoomResponse { } export namespace GetRoomResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetRoomResponse): any => ({ ...obj, ...(obj.Room && { Room: Room.filterSensitiveLog(obj.Room) }), @@ -5504,6 +6212,9 @@ export interface GetSipMediaApplicationRequest { } export namespace GetSipMediaApplicationRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetSipMediaApplicationRequest): any => ({ ...obj, }); @@ -5517,6 +6228,9 @@ export interface GetSipMediaApplicationResponse { } export namespace GetSipMediaApplicationResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetSipMediaApplicationResponse): any => ({ ...obj, ...(obj.SipMediaApplication && { @@ -5533,6 +6247,9 @@ export interface GetSipMediaApplicationLoggingConfigurationRequest { } export namespace GetSipMediaApplicationLoggingConfigurationRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetSipMediaApplicationLoggingConfigurationRequest): any => ({ ...obj, }); @@ -5549,6 +6266,9 @@ export interface SipMediaApplicationLoggingConfiguration { } export namespace SipMediaApplicationLoggingConfiguration { + /** + * @internal + */ export const filterSensitiveLog = (obj: SipMediaApplicationLoggingConfiguration): any => ({ ...obj, }); @@ -5562,6 +6282,9 @@ export interface GetSipMediaApplicationLoggingConfigurationResponse { } export namespace GetSipMediaApplicationLoggingConfigurationResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetSipMediaApplicationLoggingConfigurationResponse): any => ({ ...obj, }); @@ -5575,6 +6298,9 @@ export interface GetSipRuleRequest { } export namespace GetSipRuleRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetSipRuleRequest): any => ({ ...obj, }); @@ -5588,6 +6314,9 @@ export interface GetSipRuleResponse { } export namespace GetSipRuleResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetSipRuleResponse): any => ({ ...obj, }); @@ -5606,6 +6335,9 @@ export interface GetUserRequest { } export namespace GetUserRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetUserRequest): any => ({ ...obj, }); @@ -5619,6 +6351,9 @@ export interface GetUserResponse { } export namespace GetUserResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetUserResponse): any => ({ ...obj, ...(obj.User && { User: User.filterSensitiveLog(obj.User) }), @@ -5638,6 +6373,9 @@ export interface GetUserSettingsRequest { } export namespace GetUserSettingsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetUserSettingsRequest): any => ({ ...obj, }); @@ -5665,6 +6403,9 @@ export interface TelephonySettings { } export namespace TelephonySettings { + /** + * @internal + */ export const filterSensitiveLog = (obj: TelephonySettings): any => ({ ...obj, }); @@ -5682,6 +6423,9 @@ export interface UserSettings { } export namespace UserSettings { + /** + * @internal + */ export const filterSensitiveLog = (obj: UserSettings): any => ({ ...obj, }); @@ -5695,6 +6439,9 @@ export interface GetUserSettingsResponse { } export namespace GetUserSettingsResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetUserSettingsResponse): any => ({ ...obj, }); @@ -5708,6 +6455,9 @@ export interface GetVoiceConnectorRequest { } export namespace GetVoiceConnectorRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetVoiceConnectorRequest): any => ({ ...obj, }); @@ -5721,6 +6471,9 @@ export interface GetVoiceConnectorResponse { } export namespace GetVoiceConnectorResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetVoiceConnectorResponse): any => ({ ...obj, }); @@ -5734,6 +6487,9 @@ export interface GetVoiceConnectorEmergencyCallingConfigurationRequest { } export namespace GetVoiceConnectorEmergencyCallingConfigurationRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetVoiceConnectorEmergencyCallingConfigurationRequest): any => ({ ...obj, }); @@ -5747,6 +6503,9 @@ export interface GetVoiceConnectorEmergencyCallingConfigurationResponse { } export namespace GetVoiceConnectorEmergencyCallingConfigurationResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetVoiceConnectorEmergencyCallingConfigurationResponse): any => ({ ...obj, ...(obj.EmergencyCallingConfiguration && { @@ -5765,6 +6524,9 @@ export interface GetVoiceConnectorGroupRequest { } export namespace GetVoiceConnectorGroupRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetVoiceConnectorGroupRequest): any => ({ ...obj, }); @@ -5778,6 +6540,9 @@ export interface GetVoiceConnectorGroupResponse { } export namespace GetVoiceConnectorGroupResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetVoiceConnectorGroupResponse): any => ({ ...obj, }); @@ -5791,6 +6556,9 @@ export interface GetVoiceConnectorLoggingConfigurationRequest { } export namespace GetVoiceConnectorLoggingConfigurationRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetVoiceConnectorLoggingConfigurationRequest): any => ({ ...obj, }); @@ -5807,6 +6575,9 @@ export interface LoggingConfiguration { } export namespace LoggingConfiguration { + /** + * @internal + */ export const filterSensitiveLog = (obj: LoggingConfiguration): any => ({ ...obj, }); @@ -5820,6 +6591,9 @@ export interface GetVoiceConnectorLoggingConfigurationResponse { } export namespace GetVoiceConnectorLoggingConfigurationResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetVoiceConnectorLoggingConfigurationResponse): any => ({ ...obj, }); @@ -5833,6 +6607,9 @@ export interface GetVoiceConnectorOriginationRequest { } export namespace GetVoiceConnectorOriginationRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetVoiceConnectorOriginationRequest): any => ({ ...obj, }); @@ -5878,6 +6655,9 @@ export interface OriginationRoute { } export namespace OriginationRoute { + /** + * @internal + */ export const filterSensitiveLog = (obj: OriginationRoute): any => ({ ...obj, }); @@ -5902,6 +6682,9 @@ export interface Origination { } export namespace Origination { + /** + * @internal + */ export const filterSensitiveLog = (obj: Origination): any => ({ ...obj, }); @@ -5915,6 +6698,9 @@ export interface GetVoiceConnectorOriginationResponse { } export namespace GetVoiceConnectorOriginationResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetVoiceConnectorOriginationResponse): any => ({ ...obj, }); @@ -5928,6 +6714,9 @@ export interface GetVoiceConnectorProxyRequest { } export namespace GetVoiceConnectorProxyRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetVoiceConnectorProxyRequest): any => ({ ...obj, }); @@ -5959,6 +6748,9 @@ export interface Proxy { } export namespace Proxy { + /** + * @internal + */ export const filterSensitiveLog = (obj: Proxy): any => ({ ...obj, ...(obj.FallBackPhoneNumber && { FallBackPhoneNumber: SENSITIVE_STRING }), @@ -5973,6 +6765,9 @@ export interface GetVoiceConnectorProxyResponse { } export namespace GetVoiceConnectorProxyResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetVoiceConnectorProxyResponse): any => ({ ...obj, ...(obj.Proxy && { Proxy: Proxy.filterSensitiveLog(obj.Proxy) }), @@ -5987,6 +6782,9 @@ export interface GetVoiceConnectorStreamingConfigurationRequest { } export namespace GetVoiceConnectorStreamingConfigurationRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetVoiceConnectorStreamingConfigurationRequest): any => ({ ...obj, }); @@ -6009,6 +6807,9 @@ export interface StreamingNotificationTarget { } export namespace StreamingNotificationTarget { + /** + * @internal + */ export const filterSensitiveLog = (obj: StreamingNotificationTarget): any => ({ ...obj, }); @@ -6037,6 +6838,9 @@ export interface StreamingConfiguration { } export namespace StreamingConfiguration { + /** + * @internal + */ export const filterSensitiveLog = (obj: StreamingConfiguration): any => ({ ...obj, }); @@ -6050,6 +6854,9 @@ export interface GetVoiceConnectorStreamingConfigurationResponse { } export namespace GetVoiceConnectorStreamingConfigurationResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetVoiceConnectorStreamingConfigurationResponse): any => ({ ...obj, }); diff --git a/clients/client-chime/models/models_1.ts b/clients/client-chime/models/models_1.ts index bf1ad22c2ce8..7cada49baafb 100644 --- a/clients/client-chime/models/models_1.ts +++ b/clients/client-chime/models/models_1.ts @@ -69,6 +69,9 @@ export interface GetVoiceConnectorTerminationRequest { } export namespace GetVoiceConnectorTerminationRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetVoiceConnectorTerminationRequest): any => ({ ...obj, }); @@ -107,6 +110,9 @@ export interface Termination { } export namespace Termination { + /** + * @internal + */ export const filterSensitiveLog = (obj: Termination): any => ({ ...obj, ...(obj.DefaultPhoneNumber && { DefaultPhoneNumber: SENSITIVE_STRING }), @@ -121,6 +127,9 @@ export interface GetVoiceConnectorTerminationResponse { } export namespace GetVoiceConnectorTerminationResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetVoiceConnectorTerminationResponse): any => ({ ...obj, ...(obj.Termination && { Termination: Termination.filterSensitiveLog(obj.Termination) }), @@ -135,6 +144,9 @@ export interface GetVoiceConnectorTerminationHealthRequest { } export namespace GetVoiceConnectorTerminationHealthRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetVoiceConnectorTerminationHealthRequest): any => ({ ...obj, }); @@ -157,6 +169,9 @@ export interface TerminationHealth { } export namespace TerminationHealth { + /** + * @internal + */ export const filterSensitiveLog = (obj: TerminationHealth): any => ({ ...obj, }); @@ -170,6 +185,9 @@ export interface GetVoiceConnectorTerminationHealthResponse { } export namespace GetVoiceConnectorTerminationHealthResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetVoiceConnectorTerminationHealthResponse): any => ({ ...obj, }); @@ -202,6 +220,9 @@ export interface Invite { } export namespace Invite { + /** + * @internal + */ export const filterSensitiveLog = (obj: Invite): any => ({ ...obj, ...(obj.EmailAddress && { EmailAddress: SENSITIVE_STRING }), @@ -226,6 +247,9 @@ export interface InviteUsersRequest { } export namespace InviteUsersRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: InviteUsersRequest): any => ({ ...obj, ...(obj.UserEmailList && { UserEmailList: SENSITIVE_STRING }), @@ -240,6 +264,9 @@ export interface InviteUsersResponse { } export namespace InviteUsersResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: InviteUsersResponse): any => ({ ...obj, ...(obj.Invites && { Invites: obj.Invites.map((item) => Invite.filterSensitiveLog(item)) }), @@ -269,6 +296,9 @@ export interface ListAccountsRequest { } export namespace ListAccountsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListAccountsRequest): any => ({ ...obj, ...(obj.UserEmail && { UserEmail: SENSITIVE_STRING }), @@ -288,6 +318,9 @@ export interface ListAccountsResponse { } export namespace ListAccountsResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListAccountsResponse): any => ({ ...obj, }); @@ -311,6 +344,9 @@ export interface ListAppInstanceAdminsRequest { } export namespace ListAppInstanceAdminsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListAppInstanceAdminsRequest): any => ({ ...obj, ...(obj.NextToken && { NextToken: SENSITIVE_STRING }), @@ -335,6 +371,9 @@ export interface ListAppInstanceAdminsResponse { } export namespace ListAppInstanceAdminsResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListAppInstanceAdminsResponse): any => ({ ...obj, ...(obj.AppInstanceAdmins && { @@ -357,6 +396,9 @@ export interface ListAppInstancesRequest { } export namespace ListAppInstancesRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListAppInstancesRequest): any => ({ ...obj, ...(obj.NextToken && { NextToken: SENSITIVE_STRING }), @@ -376,6 +418,9 @@ export interface ListAppInstancesResponse { } export namespace ListAppInstancesResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListAppInstancesResponse): any => ({ ...obj, ...(obj.AppInstances && { @@ -403,6 +448,9 @@ export interface ListAppInstanceUsersRequest { } export namespace ListAppInstanceUsersRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListAppInstanceUsersRequest): any => ({ ...obj, ...(obj.NextToken && { NextToken: SENSITIVE_STRING }), @@ -427,6 +475,9 @@ export interface ListAppInstanceUsersResponse { } export namespace ListAppInstanceUsersResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListAppInstanceUsersResponse): any => ({ ...obj, ...(obj.AppInstanceUsers && { @@ -454,6 +505,9 @@ export interface ListAttendeesRequest { } export namespace ListAttendeesRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListAttendeesRequest): any => ({ ...obj, }); @@ -472,6 +526,9 @@ export interface ListAttendeesResponse { } export namespace ListAttendeesResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListAttendeesResponse): any => ({ ...obj, ...(obj.Attendees && { Attendees: obj.Attendees.map((item) => Attendee.filterSensitiveLog(item)) }), @@ -491,6 +548,9 @@ export interface ListAttendeeTagsRequest { } export namespace ListAttendeeTagsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListAttendeeTagsRequest): any => ({ ...obj, }); @@ -504,6 +564,9 @@ export interface ListAttendeeTagsResponse { } export namespace ListAttendeeTagsResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListAttendeeTagsResponse): any => ({ ...obj, ...(obj.Tags && { Tags: obj.Tags.map((item) => Tag.filterSensitiveLog(item)) }), @@ -528,6 +591,9 @@ export interface ListBotsRequest { } export namespace ListBotsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListBotsRequest): any => ({ ...obj, }); @@ -546,6 +612,9 @@ export interface ListBotsResponse { } export namespace ListBotsResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListBotsResponse): any => ({ ...obj, ...(obj.Bots && { Bots: obj.Bots.map((item) => Bot.filterSensitiveLog(item)) }), @@ -575,6 +644,9 @@ export interface ListChannelBansRequest { } export namespace ListChannelBansRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListChannelBansRequest): any => ({ ...obj, ...(obj.NextToken && { NextToken: SENSITIVE_STRING }), @@ -599,6 +671,9 @@ export interface ListChannelBansResponse { } export namespace ListChannelBansResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListChannelBansResponse): any => ({ ...obj, ...(obj.NextToken && { NextToken: SENSITIVE_STRING }), @@ -636,6 +711,9 @@ export interface ListChannelMembershipsRequest { } export namespace ListChannelMembershipsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListChannelMembershipsRequest): any => ({ ...obj, ...(obj.NextToken && { NextToken: SENSITIVE_STRING }), @@ -660,6 +738,9 @@ export interface ListChannelMembershipsResponse { } export namespace ListChannelMembershipsResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListChannelMembershipsResponse): any => ({ ...obj, ...(obj.ChannelMemberships && { @@ -692,6 +773,9 @@ export interface ListChannelMembershipsForAppInstanceUserRequest { } export namespace ListChannelMembershipsForAppInstanceUserRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListChannelMembershipsForAppInstanceUserRequest): any => ({ ...obj, ...(obj.NextToken && { NextToken: SENSITIVE_STRING }), @@ -711,6 +795,9 @@ export interface ListChannelMembershipsForAppInstanceUserResponse { } export namespace ListChannelMembershipsForAppInstanceUserResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListChannelMembershipsForAppInstanceUserResponse): any => ({ ...obj, ...(obj.ChannelMemberships && { @@ -765,6 +852,9 @@ export interface ListChannelMessagesRequest { } export namespace ListChannelMessagesRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListChannelMessagesRequest): any => ({ ...obj, ...(obj.NextToken && { NextToken: SENSITIVE_STRING }), @@ -789,6 +879,9 @@ export interface ListChannelMessagesResponse { } export namespace ListChannelMessagesResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListChannelMessagesResponse): any => ({ ...obj, ...(obj.NextToken && { NextToken: SENSITIVE_STRING }), @@ -821,6 +914,9 @@ export interface ListChannelModeratorsRequest { } export namespace ListChannelModeratorsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListChannelModeratorsRequest): any => ({ ...obj, ...(obj.NextToken && { NextToken: SENSITIVE_STRING }), @@ -845,6 +941,9 @@ export interface ListChannelModeratorsResponse { } export namespace ListChannelModeratorsResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListChannelModeratorsResponse): any => ({ ...obj, ...(obj.NextToken && { NextToken: SENSITIVE_STRING }), @@ -888,6 +987,9 @@ export interface ListChannelsRequest { } export namespace ListChannelsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListChannelsRequest): any => ({ ...obj, ...(obj.NextToken && { NextToken: SENSITIVE_STRING }), @@ -907,6 +1009,9 @@ export interface ListChannelsResponse { } export namespace ListChannelsResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListChannelsResponse): any => ({ ...obj, ...(obj.Channels && { Channels: obj.Channels.map((item) => ChannelSummary.filterSensitiveLog(item)) }), @@ -937,6 +1042,9 @@ export interface ListChannelsModeratedByAppInstanceUserRequest { } export namespace ListChannelsModeratedByAppInstanceUserRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListChannelsModeratedByAppInstanceUserRequest): any => ({ ...obj, ...(obj.NextToken && { NextToken: SENSITIVE_STRING }), @@ -956,6 +1064,9 @@ export interface ListChannelsModeratedByAppInstanceUserResponse { } export namespace ListChannelsModeratedByAppInstanceUserResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListChannelsModeratedByAppInstanceUserResponse): any => ({ ...obj, ...(obj.Channels && { @@ -978,6 +1089,9 @@ export interface ListMeetingsRequest { } export namespace ListMeetingsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListMeetingsRequest): any => ({ ...obj, }); @@ -996,6 +1110,9 @@ export interface ListMeetingsResponse { } export namespace ListMeetingsResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListMeetingsResponse): any => ({ ...obj, ...(obj.Meetings && { Meetings: obj.Meetings.map((item) => Meeting.filterSensitiveLog(item)) }), @@ -1010,6 +1127,9 @@ export interface ListMeetingTagsRequest { } export namespace ListMeetingTagsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListMeetingTagsRequest): any => ({ ...obj, }); @@ -1023,6 +1143,9 @@ export interface ListMeetingTagsResponse { } export namespace ListMeetingTagsResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListMeetingTagsResponse): any => ({ ...obj, ...(obj.Tags && { Tags: obj.Tags.map((item) => Tag.filterSensitiveLog(item)) }), @@ -1042,6 +1165,9 @@ export interface ListPhoneNumberOrdersRequest { } export namespace ListPhoneNumberOrdersRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListPhoneNumberOrdersRequest): any => ({ ...obj, }); @@ -1060,6 +1186,9 @@ export interface ListPhoneNumberOrdersResponse { } export namespace ListPhoneNumberOrdersResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListPhoneNumberOrdersResponse): any => ({ ...obj, }); @@ -1098,6 +1227,9 @@ export interface ListPhoneNumbersRequest { } export namespace ListPhoneNumbersRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListPhoneNumbersRequest): any => ({ ...obj, }); @@ -1116,6 +1248,9 @@ export interface ListPhoneNumbersResponse { } export namespace ListPhoneNumbersResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListPhoneNumbersResponse): any => ({ ...obj, ...(obj.PhoneNumbers && { PhoneNumbers: obj.PhoneNumbers.map((item) => PhoneNumber.filterSensitiveLog(item)) }), @@ -1145,6 +1280,9 @@ export interface ListProxySessionsRequest { } export namespace ListProxySessionsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListProxySessionsRequest): any => ({ ...obj, }); @@ -1163,6 +1301,9 @@ export interface ListProxySessionsResponse { } export namespace ListProxySessionsResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListProxySessionsResponse): any => ({ ...obj, }); @@ -1191,6 +1332,9 @@ export interface ListRoomMembershipsRequest { } export namespace ListRoomMembershipsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListRoomMembershipsRequest): any => ({ ...obj, }); @@ -1209,6 +1353,9 @@ export interface ListRoomMembershipsResponse { } export namespace ListRoomMembershipsResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListRoomMembershipsResponse): any => ({ ...obj, ...(obj.RoomMemberships && { @@ -1240,6 +1387,9 @@ export interface ListRoomsRequest { } export namespace ListRoomsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListRoomsRequest): any => ({ ...obj, }); @@ -1258,6 +1408,9 @@ export interface ListRoomsResponse { } export namespace ListRoomsResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListRoomsResponse): any => ({ ...obj, ...(obj.Rooms && { Rooms: obj.Rooms.map((item) => Room.filterSensitiveLog(item)) }), @@ -1277,6 +1430,9 @@ export interface ListSipMediaApplicationsRequest { } export namespace ListSipMediaApplicationsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListSipMediaApplicationsRequest): any => ({ ...obj, }); @@ -1295,6 +1451,9 @@ export interface ListSipMediaApplicationsResponse { } export namespace ListSipMediaApplicationsResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListSipMediaApplicationsResponse): any => ({ ...obj, }); @@ -1318,6 +1477,9 @@ export interface ListSipRulesRequest { } export namespace ListSipRulesRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListSipRulesRequest): any => ({ ...obj, }); @@ -1336,6 +1498,9 @@ export interface ListSipRulesResponse { } export namespace ListSipRulesResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListSipRulesResponse): any => ({ ...obj, }); @@ -1349,6 +1514,9 @@ export interface ListTagsForResourceRequest { } export namespace ListTagsForResourceRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListTagsForResourceRequest): any => ({ ...obj, ...(obj.ResourceARN && { ResourceARN: SENSITIVE_STRING }), @@ -1363,6 +1531,9 @@ export interface ListTagsForResourceResponse { } export namespace ListTagsForResourceResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListTagsForResourceResponse): any => ({ ...obj, ...(obj.Tags && { Tags: obj.Tags.map((item) => Tag.filterSensitiveLog(item)) }), @@ -1397,6 +1568,9 @@ export interface ListUsersRequest { } export namespace ListUsersRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListUsersRequest): any => ({ ...obj, ...(obj.UserEmail && { UserEmail: SENSITIVE_STRING }), @@ -1416,6 +1590,9 @@ export interface ListUsersResponse { } export namespace ListUsersResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListUsersResponse): any => ({ ...obj, ...(obj.Users && { Users: obj.Users.map((item) => User.filterSensitiveLog(item)) }), @@ -1435,6 +1612,9 @@ export interface ListVoiceConnectorGroupsRequest { } export namespace ListVoiceConnectorGroupsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListVoiceConnectorGroupsRequest): any => ({ ...obj, }); @@ -1453,6 +1633,9 @@ export interface ListVoiceConnectorGroupsResponse { } export namespace ListVoiceConnectorGroupsResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListVoiceConnectorGroupsResponse): any => ({ ...obj, }); @@ -1471,6 +1654,9 @@ export interface ListVoiceConnectorsRequest { } export namespace ListVoiceConnectorsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListVoiceConnectorsRequest): any => ({ ...obj, }); @@ -1489,6 +1675,9 @@ export interface ListVoiceConnectorsResponse { } export namespace ListVoiceConnectorsResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListVoiceConnectorsResponse): any => ({ ...obj, }); @@ -1502,6 +1691,9 @@ export interface ListVoiceConnectorTerminationCredentialsRequest { } export namespace ListVoiceConnectorTerminationCredentialsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListVoiceConnectorTerminationCredentialsRequest): any => ({ ...obj, }); @@ -1515,6 +1707,9 @@ export interface ListVoiceConnectorTerminationCredentialsResponse { } export namespace ListVoiceConnectorTerminationCredentialsResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListVoiceConnectorTerminationCredentialsResponse): any => ({ ...obj, ...(obj.Usernames && { Usernames: SENSITIVE_STRING }), @@ -1534,6 +1729,9 @@ export interface LogoutUserRequest { } export namespace LogoutUserRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: LogoutUserRequest): any => ({ ...obj, }); @@ -1542,6 +1740,9 @@ export namespace LogoutUserRequest { export interface LogoutUserResponse {} export namespace LogoutUserResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: LogoutUserResponse): any => ({ ...obj, }); @@ -1560,6 +1761,9 @@ export interface PutAppInstanceRetentionSettingsRequest { } export namespace PutAppInstanceRetentionSettingsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: PutAppInstanceRetentionSettingsRequest): any => ({ ...obj, }); @@ -1578,6 +1782,9 @@ export interface PutAppInstanceRetentionSettingsResponse { } export namespace PutAppInstanceRetentionSettingsResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: PutAppInstanceRetentionSettingsResponse): any => ({ ...obj, }); @@ -1596,6 +1803,9 @@ export interface PutAppInstanceStreamingConfigurationsRequest { } export namespace PutAppInstanceStreamingConfigurationsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: PutAppInstanceStreamingConfigurationsRequest): any => ({ ...obj, ...(obj.AppInstanceStreamingConfigurations && { @@ -1614,6 +1824,9 @@ export interface PutAppInstanceStreamingConfigurationsResponse { } export namespace PutAppInstanceStreamingConfigurationsResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: PutAppInstanceStreamingConfigurationsResponse): any => ({ ...obj, ...(obj.AppInstanceStreamingConfigurations && { @@ -1647,6 +1860,9 @@ export interface PutEventsConfigurationRequest { } export namespace PutEventsConfigurationRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: PutEventsConfigurationRequest): any => ({ ...obj, ...(obj.OutboundEventsHTTPSEndpoint && { OutboundEventsHTTPSEndpoint: SENSITIVE_STRING }), @@ -1662,6 +1878,9 @@ export interface PutEventsConfigurationResponse { } export namespace PutEventsConfigurationResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: PutEventsConfigurationResponse): any => ({ ...obj, ...(obj.EventsConfiguration && { @@ -1683,6 +1902,9 @@ export interface PutRetentionSettingsRequest { } export namespace PutRetentionSettingsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: PutRetentionSettingsRequest): any => ({ ...obj, }); @@ -1701,6 +1923,9 @@ export interface PutRetentionSettingsResponse { } export namespace PutRetentionSettingsResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: PutRetentionSettingsResponse): any => ({ ...obj, }); @@ -1719,6 +1944,9 @@ export interface PutSipMediaApplicationLoggingConfigurationRequest { } export namespace PutSipMediaApplicationLoggingConfigurationRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: PutSipMediaApplicationLoggingConfigurationRequest): any => ({ ...obj, }); @@ -1732,6 +1960,9 @@ export interface PutSipMediaApplicationLoggingConfigurationResponse { } export namespace PutSipMediaApplicationLoggingConfigurationResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: PutSipMediaApplicationLoggingConfigurationResponse): any => ({ ...obj, }); @@ -1750,6 +1981,9 @@ export interface PutVoiceConnectorEmergencyCallingConfigurationRequest { } export namespace PutVoiceConnectorEmergencyCallingConfigurationRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: PutVoiceConnectorEmergencyCallingConfigurationRequest): any => ({ ...obj, ...(obj.EmergencyCallingConfiguration && { @@ -1768,6 +2002,9 @@ export interface PutVoiceConnectorEmergencyCallingConfigurationResponse { } export namespace PutVoiceConnectorEmergencyCallingConfigurationResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: PutVoiceConnectorEmergencyCallingConfigurationResponse): any => ({ ...obj, ...(obj.EmergencyCallingConfiguration && { @@ -1791,6 +2028,9 @@ export interface PutVoiceConnectorLoggingConfigurationRequest { } export namespace PutVoiceConnectorLoggingConfigurationRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: PutVoiceConnectorLoggingConfigurationRequest): any => ({ ...obj, }); @@ -1804,6 +2044,9 @@ export interface PutVoiceConnectorLoggingConfigurationResponse { } export namespace PutVoiceConnectorLoggingConfigurationResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: PutVoiceConnectorLoggingConfigurationResponse): any => ({ ...obj, }); @@ -1822,6 +2065,9 @@ export interface PutVoiceConnectorOriginationRequest { } export namespace PutVoiceConnectorOriginationRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: PutVoiceConnectorOriginationRequest): any => ({ ...obj, }); @@ -1835,6 +2081,9 @@ export interface PutVoiceConnectorOriginationResponse { } export namespace PutVoiceConnectorOriginationResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: PutVoiceConnectorOriginationResponse): any => ({ ...obj, }); @@ -1868,6 +2117,9 @@ export interface PutVoiceConnectorProxyRequest { } export namespace PutVoiceConnectorProxyRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: PutVoiceConnectorProxyRequest): any => ({ ...obj, ...(obj.FallBackPhoneNumber && { FallBackPhoneNumber: SENSITIVE_STRING }), @@ -1882,6 +2134,9 @@ export interface PutVoiceConnectorProxyResponse { } export namespace PutVoiceConnectorProxyResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: PutVoiceConnectorProxyResponse): any => ({ ...obj, ...(obj.Proxy && { Proxy: Proxy.filterSensitiveLog(obj.Proxy) }), @@ -1901,6 +2156,9 @@ export interface PutVoiceConnectorStreamingConfigurationRequest { } export namespace PutVoiceConnectorStreamingConfigurationRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: PutVoiceConnectorStreamingConfigurationRequest): any => ({ ...obj, }); @@ -1914,6 +2172,9 @@ export interface PutVoiceConnectorStreamingConfigurationResponse { } export namespace PutVoiceConnectorStreamingConfigurationResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: PutVoiceConnectorStreamingConfigurationResponse): any => ({ ...obj, }); @@ -1932,6 +2193,9 @@ export interface PutVoiceConnectorTerminationRequest { } export namespace PutVoiceConnectorTerminationRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: PutVoiceConnectorTerminationRequest): any => ({ ...obj, ...(obj.Termination && { Termination: Termination.filterSensitiveLog(obj.Termination) }), @@ -1946,6 +2210,9 @@ export interface PutVoiceConnectorTerminationResponse { } export namespace PutVoiceConnectorTerminationResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: PutVoiceConnectorTerminationResponse): any => ({ ...obj, ...(obj.Termination && { Termination: Termination.filterSensitiveLog(obj.Termination) }), @@ -1965,6 +2232,9 @@ export interface PutVoiceConnectorTerminationCredentialsRequest { } export namespace PutVoiceConnectorTerminationCredentialsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: PutVoiceConnectorTerminationCredentialsRequest): any => ({ ...obj, ...(obj.Credentials && { Credentials: obj.Credentials.map((item) => Credential.filterSensitiveLog(item)) }), @@ -1989,6 +2259,9 @@ export interface RedactChannelMessageRequest { } export namespace RedactChannelMessageRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: RedactChannelMessageRequest): any => ({ ...obj, }); @@ -2007,6 +2280,9 @@ export interface RedactChannelMessageResponse { } export namespace RedactChannelMessageResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: RedactChannelMessageResponse): any => ({ ...obj, }); @@ -2030,6 +2306,9 @@ export interface RedactConversationMessageRequest { } export namespace RedactConversationMessageRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: RedactConversationMessageRequest): any => ({ ...obj, }); @@ -2038,6 +2317,9 @@ export namespace RedactConversationMessageRequest { export interface RedactConversationMessageResponse {} export namespace RedactConversationMessageResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: RedactConversationMessageResponse): any => ({ ...obj, }); @@ -2061,6 +2343,9 @@ export interface RedactRoomMessageRequest { } export namespace RedactRoomMessageRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: RedactRoomMessageRequest): any => ({ ...obj, }); @@ -2069,6 +2354,9 @@ export namespace RedactRoomMessageRequest { export interface RedactRoomMessageResponse {} export namespace RedactRoomMessageResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: RedactRoomMessageResponse): any => ({ ...obj, }); @@ -2087,6 +2375,9 @@ export interface RegenerateSecurityTokenRequest { } export namespace RegenerateSecurityTokenRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: RegenerateSecurityTokenRequest): any => ({ ...obj, }); @@ -2100,6 +2391,9 @@ export interface RegenerateSecurityTokenResponse { } export namespace RegenerateSecurityTokenResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: RegenerateSecurityTokenResponse): any => ({ ...obj, ...(obj.Bot && { Bot: Bot.filterSensitiveLog(obj.Bot) }), @@ -2119,6 +2413,9 @@ export interface ResetPersonalPINRequest { } export namespace ResetPersonalPINRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ResetPersonalPINRequest): any => ({ ...obj, }); @@ -2132,6 +2429,9 @@ export interface ResetPersonalPINResponse { } export namespace ResetPersonalPINResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ResetPersonalPINResponse): any => ({ ...obj, ...(obj.User && { User: User.filterSensitiveLog(obj.User) }), @@ -2146,6 +2446,9 @@ export interface RestorePhoneNumberRequest { } export namespace RestorePhoneNumberRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: RestorePhoneNumberRequest): any => ({ ...obj, }); @@ -2159,6 +2462,9 @@ export interface RestorePhoneNumberResponse { } export namespace RestorePhoneNumberResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: RestorePhoneNumberResponse): any => ({ ...obj, ...(obj.PhoneNumber && { PhoneNumber: PhoneNumber.filterSensitiveLog(obj.PhoneNumber) }), @@ -2203,6 +2509,9 @@ export interface SearchAvailablePhoneNumbersRequest { } export namespace SearchAvailablePhoneNumbersRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: SearchAvailablePhoneNumbersRequest): any => ({ ...obj, }); @@ -2216,6 +2525,9 @@ export interface SearchAvailablePhoneNumbersResponse { } export namespace SearchAvailablePhoneNumbersResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: SearchAvailablePhoneNumbersResponse): any => ({ ...obj, ...(obj.E164PhoneNumbers && { E164PhoneNumbers: SENSITIVE_STRING }), @@ -2260,6 +2572,9 @@ export interface SendChannelMessageRequest { } export namespace SendChannelMessageRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: SendChannelMessageRequest): any => ({ ...obj, ...(obj.Content && { Content: SENSITIVE_STRING }), @@ -2281,6 +2596,9 @@ export interface SendChannelMessageResponse { } export namespace SendChannelMessageResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: SendChannelMessageResponse): any => ({ ...obj, }); @@ -2304,6 +2622,9 @@ export interface TagAttendeeRequest { } export namespace TagAttendeeRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: TagAttendeeRequest): any => ({ ...obj, ...(obj.Tags && { Tags: obj.Tags.map((item) => Tag.filterSensitiveLog(item)) }), @@ -2323,6 +2644,9 @@ export interface TagMeetingRequest { } export namespace TagMeetingRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: TagMeetingRequest): any => ({ ...obj, ...(obj.Tags && { Tags: obj.Tags.map((item) => Tag.filterSensitiveLog(item)) }), @@ -2342,6 +2666,9 @@ export interface TagResourceRequest { } export namespace TagResourceRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: TagResourceRequest): any => ({ ...obj, ...(obj.ResourceARN && { ResourceARN: SENSITIVE_STRING }), @@ -2367,6 +2694,9 @@ export interface UntagAttendeeRequest { } export namespace UntagAttendeeRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: UntagAttendeeRequest): any => ({ ...obj, ...(obj.TagKeys && { TagKeys: SENSITIVE_STRING }), @@ -2386,6 +2716,9 @@ export interface UntagMeetingRequest { } export namespace UntagMeetingRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: UntagMeetingRequest): any => ({ ...obj, ...(obj.TagKeys && { TagKeys: SENSITIVE_STRING }), @@ -2405,6 +2738,9 @@ export interface UntagResourceRequest { } export namespace UntagResourceRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: UntagResourceRequest): any => ({ ...obj, ...(obj.ResourceARN && { ResourceARN: SENSITIVE_STRING }), @@ -2425,6 +2761,9 @@ export interface UpdateAccountRequest { } export namespace UpdateAccountRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateAccountRequest): any => ({ ...obj, }); @@ -2438,6 +2777,9 @@ export interface UpdateAccountResponse { } export namespace UpdateAccountResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateAccountResponse): any => ({ ...obj, }); @@ -2456,6 +2798,9 @@ export interface UpdateAccountSettingsRequest { } export namespace UpdateAccountSettingsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateAccountSettingsRequest): any => ({ ...obj, }); @@ -2464,6 +2809,9 @@ export namespace UpdateAccountSettingsRequest { export interface UpdateAccountSettingsResponse {} export namespace UpdateAccountSettingsResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateAccountSettingsResponse): any => ({ ...obj, }); @@ -2487,6 +2835,9 @@ export interface UpdateAppInstanceRequest { } export namespace UpdateAppInstanceRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateAppInstanceRequest): any => ({ ...obj, ...(obj.Name && { Name: SENSITIVE_STRING }), @@ -2502,6 +2853,9 @@ export interface UpdateAppInstanceResponse { } export namespace UpdateAppInstanceResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateAppInstanceResponse): any => ({ ...obj, }); @@ -2525,6 +2879,9 @@ export interface UpdateAppInstanceUserRequest { } export namespace UpdateAppInstanceUserRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateAppInstanceUserRequest): any => ({ ...obj, ...(obj.Name && { Name: SENSITIVE_STRING }), @@ -2540,6 +2897,9 @@ export interface UpdateAppInstanceUserResponse { } export namespace UpdateAppInstanceUserResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateAppInstanceUserResponse): any => ({ ...obj, }); @@ -2563,6 +2923,9 @@ export interface UpdateBotRequest { } export namespace UpdateBotRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateBotRequest): any => ({ ...obj, }); @@ -2576,6 +2939,9 @@ export interface UpdateBotResponse { } export namespace UpdateBotResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateBotResponse): any => ({ ...obj, ...(obj.Bot && { Bot: Bot.filterSensitiveLog(obj.Bot) }), @@ -2610,6 +2976,9 @@ export interface UpdateChannelRequest { } export namespace UpdateChannelRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateChannelRequest): any => ({ ...obj, ...(obj.Name && { Name: SENSITIVE_STRING }), @@ -2625,6 +2994,9 @@ export interface UpdateChannelResponse { } export namespace UpdateChannelResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateChannelResponse): any => ({ ...obj, }); @@ -2658,6 +3030,9 @@ export interface UpdateChannelMessageRequest { } export namespace UpdateChannelMessageRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateChannelMessageRequest): any => ({ ...obj, ...(obj.Content && { Content: SENSITIVE_STRING }), @@ -2678,6 +3053,9 @@ export interface UpdateChannelMessageResponse { } export namespace UpdateChannelMessageResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateChannelMessageResponse): any => ({ ...obj, }); @@ -2696,6 +3074,9 @@ export interface UpdateChannelReadMarkerRequest { } export namespace UpdateChannelReadMarkerRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateChannelReadMarkerRequest): any => ({ ...obj, }); @@ -2709,6 +3090,9 @@ export interface UpdateChannelReadMarkerResponse { } export namespace UpdateChannelReadMarkerResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateChannelReadMarkerResponse): any => ({ ...obj, }); @@ -2727,6 +3111,9 @@ export interface UpdateGlobalSettingsRequest { } export namespace UpdateGlobalSettingsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateGlobalSettingsRequest): any => ({ ...obj, }); @@ -2750,6 +3137,9 @@ export interface UpdatePhoneNumberRequest { } export namespace UpdatePhoneNumberRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdatePhoneNumberRequest): any => ({ ...obj, ...(obj.CallingName && { CallingName: SENSITIVE_STRING }), @@ -2764,6 +3154,9 @@ export interface UpdatePhoneNumberResponse { } export namespace UpdatePhoneNumberResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdatePhoneNumberResponse): any => ({ ...obj, ...(obj.PhoneNumber && { PhoneNumber: PhoneNumber.filterSensitiveLog(obj.PhoneNumber) }), @@ -2778,6 +3171,9 @@ export interface UpdatePhoneNumberSettingsRequest { } export namespace UpdatePhoneNumberSettingsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdatePhoneNumberSettingsRequest): any => ({ ...obj, ...(obj.CallingName && { CallingName: SENSITIVE_STRING }), @@ -2807,6 +3203,9 @@ export interface UpdateProxySessionRequest { } export namespace UpdateProxySessionRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateProxySessionRequest): any => ({ ...obj, }); @@ -2820,6 +3219,9 @@ export interface UpdateProxySessionResponse { } export namespace UpdateProxySessionResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateProxySessionResponse): any => ({ ...obj, ...(obj.ProxySession && { ProxySession: ProxySession.filterSensitiveLog(obj.ProxySession) }), @@ -2844,6 +3246,9 @@ export interface UpdateRoomRequest { } export namespace UpdateRoomRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateRoomRequest): any => ({ ...obj, ...(obj.Name && { Name: SENSITIVE_STRING }), @@ -2858,6 +3263,9 @@ export interface UpdateRoomResponse { } export namespace UpdateRoomResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateRoomResponse): any => ({ ...obj, ...(obj.Room && { Room: Room.filterSensitiveLog(obj.Room) }), @@ -2887,6 +3295,9 @@ export interface UpdateRoomMembershipRequest { } export namespace UpdateRoomMembershipRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateRoomMembershipRequest): any => ({ ...obj, }); @@ -2900,6 +3311,9 @@ export interface UpdateRoomMembershipResponse { } export namespace UpdateRoomMembershipResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateRoomMembershipResponse): any => ({ ...obj, ...(obj.RoomMembership && { RoomMembership: RoomMembership.filterSensitiveLog(obj.RoomMembership) }), @@ -2924,6 +3338,9 @@ export interface UpdateSipMediaApplicationRequest { } export namespace UpdateSipMediaApplicationRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateSipMediaApplicationRequest): any => ({ ...obj, ...(obj.Endpoints && { @@ -2940,6 +3357,9 @@ export interface UpdateSipMediaApplicationResponse { } export namespace UpdateSipMediaApplicationResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateSipMediaApplicationResponse): any => ({ ...obj, ...(obj.SipMediaApplication && { @@ -2971,6 +3391,9 @@ export interface UpdateSipRuleRequest { } export namespace UpdateSipRuleRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateSipRuleRequest): any => ({ ...obj, }); @@ -2984,6 +3407,9 @@ export interface UpdateSipRuleResponse { } export namespace UpdateSipRuleResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateSipRuleResponse): any => ({ ...obj, }); @@ -3018,6 +3444,9 @@ export interface UpdateUserRequest { } export namespace UpdateUserRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateUserRequest): any => ({ ...obj, ...(obj.AlexaForBusinessMetadata && { @@ -3034,6 +3463,9 @@ export interface UpdateUserResponse { } export namespace UpdateUserResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateUserResponse): any => ({ ...obj, ...(obj.User && { User: User.filterSensitiveLog(obj.User) }), @@ -3058,6 +3490,9 @@ export interface UpdateUserSettingsRequest { } export namespace UpdateUserSettingsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateUserSettingsRequest): any => ({ ...obj, }); @@ -3081,6 +3516,9 @@ export interface UpdateVoiceConnectorRequest { } export namespace UpdateVoiceConnectorRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateVoiceConnectorRequest): any => ({ ...obj, }); @@ -3094,6 +3532,9 @@ export interface UpdateVoiceConnectorResponse { } export namespace UpdateVoiceConnectorResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateVoiceConnectorResponse): any => ({ ...obj, }); @@ -3121,6 +3562,9 @@ export interface UpdateVoiceConnectorGroupRequest { } export namespace UpdateVoiceConnectorGroupRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateVoiceConnectorGroupRequest): any => ({ ...obj, }); @@ -3134,6 +3578,9 @@ export interface UpdateVoiceConnectorGroupResponse { } export namespace UpdateVoiceConnectorGroupResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateVoiceConnectorGroupResponse): any => ({ ...obj, }); diff --git a/clients/client-cloud9/commands/CreateEnvironmentEC2Command.ts b/clients/client-cloud9/commands/CreateEnvironmentEC2Command.ts index 6027139ee40b..01b817736306 100644 --- a/clients/client-cloud9/commands/CreateEnvironmentEC2Command.ts +++ b/clients/client-cloud9/commands/CreateEnvironmentEC2Command.ts @@ -22,6 +22,20 @@ export interface CreateEnvironmentEC2CommandOutput extends CreateEnvironmentEC2R /** *

Creates an AWS Cloud9 development environment, launches an Amazon Elastic Compute Cloud (Amazon EC2) instance, and then connects from the instance to the environment.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { Cloud9Client, CreateEnvironmentEC2Command } from "@aws-sdk/client-cloud9"; // ES Modules import + * // const { Cloud9Client, CreateEnvironmentEC2Command } = require("@aws-sdk/client-cloud9"); // CommonJS import + * const client = new Cloud9Client(config); + * const command = new CreateEnvironmentEC2Command(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreateEnvironmentEC2CommandInput} for command's `input` shape. + * @see {@link CreateEnvironmentEC2CommandOutput} for command's `response` shape. + * @see {@link Cloud9ClientResolvedConfig | config} for command's `input` shape. + * */ export class CreateEnvironmentEC2Command extends $Command< CreateEnvironmentEC2CommandInput, diff --git a/clients/client-cloud9/commands/CreateEnvironmentMembershipCommand.ts b/clients/client-cloud9/commands/CreateEnvironmentMembershipCommand.ts index 3b5395971c48..130f07318789 100644 --- a/clients/client-cloud9/commands/CreateEnvironmentMembershipCommand.ts +++ b/clients/client-cloud9/commands/CreateEnvironmentMembershipCommand.ts @@ -22,6 +22,20 @@ export interface CreateEnvironmentMembershipCommandOutput extends CreateEnvironm /** *

Adds an environment member to an AWS Cloud9 development environment.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { Cloud9Client, CreateEnvironmentMembershipCommand } from "@aws-sdk/client-cloud9"; // ES Modules import + * // const { Cloud9Client, CreateEnvironmentMembershipCommand } = require("@aws-sdk/client-cloud9"); // CommonJS import + * const client = new Cloud9Client(config); + * const command = new CreateEnvironmentMembershipCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreateEnvironmentMembershipCommandInput} for command's `input` shape. + * @see {@link CreateEnvironmentMembershipCommandOutput} for command's `response` shape. + * @see {@link Cloud9ClientResolvedConfig | config} for command's `input` shape. + * */ export class CreateEnvironmentMembershipCommand extends $Command< CreateEnvironmentMembershipCommandInput, diff --git a/clients/client-cloud9/commands/DeleteEnvironmentCommand.ts b/clients/client-cloud9/commands/DeleteEnvironmentCommand.ts index 765a56d5b498..4c27b2fe582a 100644 --- a/clients/client-cloud9/commands/DeleteEnvironmentCommand.ts +++ b/clients/client-cloud9/commands/DeleteEnvironmentCommand.ts @@ -22,6 +22,20 @@ export interface DeleteEnvironmentCommandOutput extends DeleteEnvironmentResult, /** *

Deletes an AWS Cloud9 development environment. If an Amazon EC2 instance is connected to the environment, also terminates the instance.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { Cloud9Client, DeleteEnvironmentCommand } from "@aws-sdk/client-cloud9"; // ES Modules import + * // const { Cloud9Client, DeleteEnvironmentCommand } = require("@aws-sdk/client-cloud9"); // CommonJS import + * const client = new Cloud9Client(config); + * const command = new DeleteEnvironmentCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteEnvironmentCommandInput} for command's `input` shape. + * @see {@link DeleteEnvironmentCommandOutput} for command's `response` shape. + * @see {@link Cloud9ClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteEnvironmentCommand extends $Command< DeleteEnvironmentCommandInput, diff --git a/clients/client-cloud9/commands/DeleteEnvironmentMembershipCommand.ts b/clients/client-cloud9/commands/DeleteEnvironmentMembershipCommand.ts index 8b90dce42bb8..bef07b7d7b70 100644 --- a/clients/client-cloud9/commands/DeleteEnvironmentMembershipCommand.ts +++ b/clients/client-cloud9/commands/DeleteEnvironmentMembershipCommand.ts @@ -22,6 +22,20 @@ export interface DeleteEnvironmentMembershipCommandOutput extends DeleteEnvironm /** *

Deletes an environment member from an AWS Cloud9 development environment.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { Cloud9Client, DeleteEnvironmentMembershipCommand } from "@aws-sdk/client-cloud9"; // ES Modules import + * // const { Cloud9Client, DeleteEnvironmentMembershipCommand } = require("@aws-sdk/client-cloud9"); // CommonJS import + * const client = new Cloud9Client(config); + * const command = new DeleteEnvironmentMembershipCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteEnvironmentMembershipCommandInput} for command's `input` shape. + * @see {@link DeleteEnvironmentMembershipCommandOutput} for command's `response` shape. + * @see {@link Cloud9ClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteEnvironmentMembershipCommand extends $Command< DeleteEnvironmentMembershipCommandInput, diff --git a/clients/client-cloud9/commands/DescribeEnvironmentMembershipsCommand.ts b/clients/client-cloud9/commands/DescribeEnvironmentMembershipsCommand.ts index b25602d5b10d..10e37d332835 100644 --- a/clients/client-cloud9/commands/DescribeEnvironmentMembershipsCommand.ts +++ b/clients/client-cloud9/commands/DescribeEnvironmentMembershipsCommand.ts @@ -24,6 +24,20 @@ export interface DescribeEnvironmentMembershipsCommandOutput /** *

Gets information about environment members for an AWS Cloud9 development environment.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { Cloud9Client, DescribeEnvironmentMembershipsCommand } from "@aws-sdk/client-cloud9"; // ES Modules import + * // const { Cloud9Client, DescribeEnvironmentMembershipsCommand } = require("@aws-sdk/client-cloud9"); // CommonJS import + * const client = new Cloud9Client(config); + * const command = new DescribeEnvironmentMembershipsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeEnvironmentMembershipsCommandInput} for command's `input` shape. + * @see {@link DescribeEnvironmentMembershipsCommandOutput} for command's `response` shape. + * @see {@link Cloud9ClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeEnvironmentMembershipsCommand extends $Command< DescribeEnvironmentMembershipsCommandInput, diff --git a/clients/client-cloud9/commands/DescribeEnvironmentStatusCommand.ts b/clients/client-cloud9/commands/DescribeEnvironmentStatusCommand.ts index 68d0375073dc..58e9748b3f26 100644 --- a/clients/client-cloud9/commands/DescribeEnvironmentStatusCommand.ts +++ b/clients/client-cloud9/commands/DescribeEnvironmentStatusCommand.ts @@ -22,6 +22,20 @@ export interface DescribeEnvironmentStatusCommandOutput extends DescribeEnvironm /** *

Gets status information for an AWS Cloud9 development environment.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { Cloud9Client, DescribeEnvironmentStatusCommand } from "@aws-sdk/client-cloud9"; // ES Modules import + * // const { Cloud9Client, DescribeEnvironmentStatusCommand } = require("@aws-sdk/client-cloud9"); // CommonJS import + * const client = new Cloud9Client(config); + * const command = new DescribeEnvironmentStatusCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeEnvironmentStatusCommandInput} for command's `input` shape. + * @see {@link DescribeEnvironmentStatusCommandOutput} for command's `response` shape. + * @see {@link Cloud9ClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeEnvironmentStatusCommand extends $Command< DescribeEnvironmentStatusCommandInput, diff --git a/clients/client-cloud9/commands/DescribeEnvironmentsCommand.ts b/clients/client-cloud9/commands/DescribeEnvironmentsCommand.ts index c133a711b026..61493530a514 100644 --- a/clients/client-cloud9/commands/DescribeEnvironmentsCommand.ts +++ b/clients/client-cloud9/commands/DescribeEnvironmentsCommand.ts @@ -22,6 +22,20 @@ export interface DescribeEnvironmentsCommandOutput extends DescribeEnvironmentsR /** *

Gets information about AWS Cloud9 development environments.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { Cloud9Client, DescribeEnvironmentsCommand } from "@aws-sdk/client-cloud9"; // ES Modules import + * // const { Cloud9Client, DescribeEnvironmentsCommand } = require("@aws-sdk/client-cloud9"); // CommonJS import + * const client = new Cloud9Client(config); + * const command = new DescribeEnvironmentsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeEnvironmentsCommandInput} for command's `input` shape. + * @see {@link DescribeEnvironmentsCommandOutput} for command's `response` shape. + * @see {@link Cloud9ClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeEnvironmentsCommand extends $Command< DescribeEnvironmentsCommandInput, diff --git a/clients/client-cloud9/commands/ListEnvironmentsCommand.ts b/clients/client-cloud9/commands/ListEnvironmentsCommand.ts index 409236691634..d97c2efe8861 100644 --- a/clients/client-cloud9/commands/ListEnvironmentsCommand.ts +++ b/clients/client-cloud9/commands/ListEnvironmentsCommand.ts @@ -22,6 +22,20 @@ export interface ListEnvironmentsCommandOutput extends ListEnvironmentsResult, _ /** *

Gets a list of AWS Cloud9 development environment identifiers.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { Cloud9Client, ListEnvironmentsCommand } from "@aws-sdk/client-cloud9"; // ES Modules import + * // const { Cloud9Client, ListEnvironmentsCommand } = require("@aws-sdk/client-cloud9"); // CommonJS import + * const client = new Cloud9Client(config); + * const command = new ListEnvironmentsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListEnvironmentsCommandInput} for command's `input` shape. + * @see {@link ListEnvironmentsCommandOutput} for command's `response` shape. + * @see {@link Cloud9ClientResolvedConfig | config} for command's `input` shape. + * */ export class ListEnvironmentsCommand extends $Command< ListEnvironmentsCommandInput, diff --git a/clients/client-cloud9/commands/ListTagsForResourceCommand.ts b/clients/client-cloud9/commands/ListTagsForResourceCommand.ts index 852e79e70d88..b1fa8f60fe53 100644 --- a/clients/client-cloud9/commands/ListTagsForResourceCommand.ts +++ b/clients/client-cloud9/commands/ListTagsForResourceCommand.ts @@ -22,6 +22,20 @@ export interface ListTagsForResourceCommandOutput extends ListTagsForResourceRes /** *

Gets a list of the tags associated with an AWS Cloud9 development environment.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { Cloud9Client, ListTagsForResourceCommand } from "@aws-sdk/client-cloud9"; // ES Modules import + * // const { Cloud9Client, ListTagsForResourceCommand } = require("@aws-sdk/client-cloud9"); // CommonJS import + * const client = new Cloud9Client(config); + * const command = new ListTagsForResourceCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListTagsForResourceCommandInput} for command's `input` shape. + * @see {@link ListTagsForResourceCommandOutput} for command's `response` shape. + * @see {@link Cloud9ClientResolvedConfig | config} for command's `input` shape. + * */ export class ListTagsForResourceCommand extends $Command< ListTagsForResourceCommandInput, diff --git a/clients/client-cloud9/commands/TagResourceCommand.ts b/clients/client-cloud9/commands/TagResourceCommand.ts index f9020cd4b709..7b57f09c5114 100644 --- a/clients/client-cloud9/commands/TagResourceCommand.ts +++ b/clients/client-cloud9/commands/TagResourceCommand.ts @@ -25,6 +25,20 @@ export interface TagResourceCommandOutput extends TagResourceResponse, __Metadat * *

Tags that you add to an AWS Cloud9 environment by using this method will NOT be automatically propagated to underlying resources.

* + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { Cloud9Client, TagResourceCommand } from "@aws-sdk/client-cloud9"; // ES Modules import + * // const { Cloud9Client, TagResourceCommand } = require("@aws-sdk/client-cloud9"); // CommonJS import + * const client = new Cloud9Client(config); + * const command = new TagResourceCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link TagResourceCommandInput} for command's `input` shape. + * @see {@link TagResourceCommandOutput} for command's `response` shape. + * @see {@link Cloud9ClientResolvedConfig | config} for command's `input` shape. + * */ export class TagResourceCommand extends $Command< TagResourceCommandInput, diff --git a/clients/client-cloud9/commands/UntagResourceCommand.ts b/clients/client-cloud9/commands/UntagResourceCommand.ts index bdbb6ee0c61d..81a92a3986c1 100644 --- a/clients/client-cloud9/commands/UntagResourceCommand.ts +++ b/clients/client-cloud9/commands/UntagResourceCommand.ts @@ -22,6 +22,20 @@ export interface UntagResourceCommandOutput extends UntagResourceResponse, __Met /** *

Removes tags from an AWS Cloud9 development environment.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { Cloud9Client, UntagResourceCommand } from "@aws-sdk/client-cloud9"; // ES Modules import + * // const { Cloud9Client, UntagResourceCommand } = require("@aws-sdk/client-cloud9"); // CommonJS import + * const client = new Cloud9Client(config); + * const command = new UntagResourceCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link UntagResourceCommandInput} for command's `input` shape. + * @see {@link UntagResourceCommandOutput} for command's `response` shape. + * @see {@link Cloud9ClientResolvedConfig | config} for command's `input` shape. + * */ export class UntagResourceCommand extends $Command< UntagResourceCommandInput, diff --git a/clients/client-cloud9/commands/UpdateEnvironmentCommand.ts b/clients/client-cloud9/commands/UpdateEnvironmentCommand.ts index 6ce0cf923558..bb4d81eabdfb 100644 --- a/clients/client-cloud9/commands/UpdateEnvironmentCommand.ts +++ b/clients/client-cloud9/commands/UpdateEnvironmentCommand.ts @@ -22,6 +22,20 @@ export interface UpdateEnvironmentCommandOutput extends UpdateEnvironmentResult, /** *

Changes the settings of an existing AWS Cloud9 development environment.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { Cloud9Client, UpdateEnvironmentCommand } from "@aws-sdk/client-cloud9"; // ES Modules import + * // const { Cloud9Client, UpdateEnvironmentCommand } = require("@aws-sdk/client-cloud9"); // CommonJS import + * const client = new Cloud9Client(config); + * const command = new UpdateEnvironmentCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link UpdateEnvironmentCommandInput} for command's `input` shape. + * @see {@link UpdateEnvironmentCommandOutput} for command's `response` shape. + * @see {@link Cloud9ClientResolvedConfig | config} for command's `input` shape. + * */ export class UpdateEnvironmentCommand extends $Command< UpdateEnvironmentCommandInput, diff --git a/clients/client-cloud9/commands/UpdateEnvironmentMembershipCommand.ts b/clients/client-cloud9/commands/UpdateEnvironmentMembershipCommand.ts index afaa4e8ecf87..90e8e2dd9ea7 100644 --- a/clients/client-cloud9/commands/UpdateEnvironmentMembershipCommand.ts +++ b/clients/client-cloud9/commands/UpdateEnvironmentMembershipCommand.ts @@ -22,6 +22,20 @@ export interface UpdateEnvironmentMembershipCommandOutput extends UpdateEnvironm /** *

Changes the settings of an existing environment member for an AWS Cloud9 development environment.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { Cloud9Client, UpdateEnvironmentMembershipCommand } from "@aws-sdk/client-cloud9"; // ES Modules import + * // const { Cloud9Client, UpdateEnvironmentMembershipCommand } = require("@aws-sdk/client-cloud9"); // CommonJS import + * const client = new Cloud9Client(config); + * const command = new UpdateEnvironmentMembershipCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link UpdateEnvironmentMembershipCommandInput} for command's `input` shape. + * @see {@link UpdateEnvironmentMembershipCommandOutput} for command's `response` shape. + * @see {@link Cloud9ClientResolvedConfig | config} for command's `input` shape. + * */ export class UpdateEnvironmentMembershipCommand extends $Command< UpdateEnvironmentMembershipCommandInput, diff --git a/clients/client-cloud9/models/models_0.ts b/clients/client-cloud9/models/models_0.ts index 9857c95d17f8..9f9f5ceb5c5b 100644 --- a/clients/client-cloud9/models/models_0.ts +++ b/clients/client-cloud9/models/models_0.ts @@ -13,6 +13,9 @@ export interface BadRequestException extends __SmithyException, $MetadataBearer } export namespace BadRequestException { + /** + * @internal + */ export const filterSensitiveLog = (obj: BadRequestException): any => ({ ...obj, }); @@ -30,6 +33,9 @@ export interface ConflictException extends __SmithyException, $MetadataBearer { } export namespace ConflictException { + /** + * @internal + */ export const filterSensitiveLog = (obj: ConflictException): any => ({ ...obj, }); @@ -56,6 +62,9 @@ export interface Tag { } export namespace Tag { + /** + * @internal + */ export const filterSensitiveLog = (obj: Tag): any => ({ ...obj, ...(obj.Key && { Key: SENSITIVE_STRING }), @@ -160,6 +169,9 @@ export interface CreateEnvironmentEC2Request { } export namespace CreateEnvironmentEC2Request { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateEnvironmentEC2Request): any => ({ ...obj, ...(obj.description && { description: SENSITIVE_STRING }), @@ -175,6 +187,9 @@ export interface CreateEnvironmentEC2Result { } export namespace CreateEnvironmentEC2Result { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateEnvironmentEC2Result): any => ({ ...obj, }); @@ -192,6 +207,9 @@ export interface ForbiddenException extends __SmithyException, $MetadataBearer { } export namespace ForbiddenException { + /** + * @internal + */ export const filterSensitiveLog = (obj: ForbiddenException): any => ({ ...obj, }); @@ -209,6 +227,9 @@ export interface InternalServerErrorException extends __SmithyException, $Metada } export namespace InternalServerErrorException { + /** + * @internal + */ export const filterSensitiveLog = (obj: InternalServerErrorException): any => ({ ...obj, }); @@ -226,6 +247,9 @@ export interface LimitExceededException extends __SmithyException, $MetadataBear } export namespace LimitExceededException { + /** + * @internal + */ export const filterSensitiveLog = (obj: LimitExceededException): any => ({ ...obj, }); @@ -243,6 +267,9 @@ export interface NotFoundException extends __SmithyException, $MetadataBearer { } export namespace NotFoundException { + /** + * @internal + */ export const filterSensitiveLog = (obj: NotFoundException): any => ({ ...obj, }); @@ -260,6 +287,9 @@ export interface TooManyRequestsException extends __SmithyException, $MetadataBe } export namespace TooManyRequestsException { + /** + * @internal + */ export const filterSensitiveLog = (obj: TooManyRequestsException): any => ({ ...obj, }); @@ -298,6 +328,9 @@ export interface CreateEnvironmentMembershipRequest { } export namespace CreateEnvironmentMembershipRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateEnvironmentMembershipRequest): any => ({ ...obj, }); @@ -354,6 +387,9 @@ export interface EnvironmentMember { } export namespace EnvironmentMember { + /** + * @internal + */ export const filterSensitiveLog = (obj: EnvironmentMember): any => ({ ...obj, }); @@ -367,6 +403,9 @@ export interface CreateEnvironmentMembershipResult { } export namespace CreateEnvironmentMembershipResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateEnvironmentMembershipResult): any => ({ ...obj, }); @@ -380,6 +419,9 @@ export interface DeleteEnvironmentRequest { } export namespace DeleteEnvironmentRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteEnvironmentRequest): any => ({ ...obj, }); @@ -388,6 +430,9 @@ export namespace DeleteEnvironmentRequest { export interface DeleteEnvironmentResult {} export namespace DeleteEnvironmentResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteEnvironmentResult): any => ({ ...obj, }); @@ -406,6 +451,9 @@ export interface DeleteEnvironmentMembershipRequest { } export namespace DeleteEnvironmentMembershipRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteEnvironmentMembershipRequest): any => ({ ...obj, }); @@ -414,6 +462,9 @@ export namespace DeleteEnvironmentMembershipRequest { export interface DeleteEnvironmentMembershipResult {} export namespace DeleteEnvironmentMembershipResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteEnvironmentMembershipResult): any => ({ ...obj, }); @@ -462,6 +513,9 @@ export interface DescribeEnvironmentMembershipsRequest { } export namespace DescribeEnvironmentMembershipsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeEnvironmentMembershipsRequest): any => ({ ...obj, }); @@ -480,6 +534,9 @@ export interface DescribeEnvironmentMembershipsResult { } export namespace DescribeEnvironmentMembershipsResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeEnvironmentMembershipsResult): any => ({ ...obj, }); @@ -493,6 +550,9 @@ export interface DescribeEnvironmentsRequest { } export namespace DescribeEnvironmentsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeEnvironmentsRequest): any => ({ ...obj, }); @@ -549,6 +609,9 @@ export interface EnvironmentLifecycle { } export namespace EnvironmentLifecycle { + /** + * @internal + */ export const filterSensitiveLog = (obj: EnvironmentLifecycle): any => ({ ...obj, }); @@ -687,6 +750,9 @@ export interface Environment { } export namespace Environment { + /** + * @internal + */ export const filterSensitiveLog = (obj: Environment): any => ({ ...obj, ...(obj.description && { description: SENSITIVE_STRING }), @@ -701,6 +767,9 @@ export interface DescribeEnvironmentsResult { } export namespace DescribeEnvironmentsResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeEnvironmentsResult): any => ({ ...obj, ...(obj.environments && { environments: obj.environments.map((item) => Environment.filterSensitiveLog(item)) }), @@ -715,6 +784,9 @@ export interface DescribeEnvironmentStatusRequest { } export namespace DescribeEnvironmentStatusRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeEnvironmentStatusRequest): any => ({ ...obj, }); @@ -773,6 +845,9 @@ export interface DescribeEnvironmentStatusResult { } export namespace DescribeEnvironmentStatusResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeEnvironmentStatusResult): any => ({ ...obj, }); @@ -791,6 +866,9 @@ export interface ListEnvironmentsRequest { } export namespace ListEnvironmentsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListEnvironmentsRequest): any => ({ ...obj, }); @@ -809,6 +887,9 @@ export interface ListEnvironmentsResult { } export namespace ListEnvironmentsResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListEnvironmentsResult): any => ({ ...obj, }); @@ -822,6 +903,9 @@ export interface ListTagsForResourceRequest { } export namespace ListTagsForResourceRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListTagsForResourceRequest): any => ({ ...obj, }); @@ -835,6 +919,9 @@ export interface ListTagsForResourceResponse { } export namespace ListTagsForResourceResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListTagsForResourceResponse): any => ({ ...obj, ...(obj.Tags && { Tags: SENSITIVE_STRING }), @@ -853,6 +940,9 @@ export interface ConcurrentAccessException extends __SmithyException, $MetadataB } export namespace ConcurrentAccessException { + /** + * @internal + */ export const filterSensitiveLog = (obj: ConcurrentAccessException): any => ({ ...obj, }); @@ -871,6 +961,9 @@ export interface TagResourceRequest { } export namespace TagResourceRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: TagResourceRequest): any => ({ ...obj, ...(obj.Tags && { Tags: SENSITIVE_STRING }), @@ -880,6 +973,9 @@ export namespace TagResourceRequest { export interface TagResourceResponse {} export namespace TagResourceResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: TagResourceResponse): any => ({ ...obj, }); @@ -898,6 +994,9 @@ export interface UntagResourceRequest { } export namespace UntagResourceRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: UntagResourceRequest): any => ({ ...obj, ...(obj.TagKeys && { TagKeys: SENSITIVE_STRING }), @@ -907,6 +1006,9 @@ export namespace UntagResourceRequest { export interface UntagResourceResponse {} export namespace UntagResourceResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: UntagResourceResponse): any => ({ ...obj, }); @@ -930,6 +1032,9 @@ export interface UpdateEnvironmentRequest { } export namespace UpdateEnvironmentRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateEnvironmentRequest): any => ({ ...obj, ...(obj.description && { description: SENSITIVE_STRING }), @@ -939,6 +1044,9 @@ export namespace UpdateEnvironmentRequest { export interface UpdateEnvironmentResult {} export namespace UpdateEnvironmentResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateEnvironmentResult): any => ({ ...obj, }); @@ -972,6 +1080,9 @@ export interface UpdateEnvironmentMembershipRequest { } export namespace UpdateEnvironmentMembershipRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateEnvironmentMembershipRequest): any => ({ ...obj, }); @@ -985,6 +1096,9 @@ export interface UpdateEnvironmentMembershipResult { } export namespace UpdateEnvironmentMembershipResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateEnvironmentMembershipResult): any => ({ ...obj, }); diff --git a/clients/client-clouddirectory/commands/AddFacetToObjectCommand.ts b/clients/client-clouddirectory/commands/AddFacetToObjectCommand.ts index d1e613d5cddc..89b1a33e0ad6 100644 --- a/clients/client-clouddirectory/commands/AddFacetToObjectCommand.ts +++ b/clients/client-clouddirectory/commands/AddFacetToObjectCommand.ts @@ -22,6 +22,20 @@ export interface AddFacetToObjectCommandOutput extends AddFacetToObjectResponse, /** *

Adds a new Facet to an object. An object can have more than one facet applied on it.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { CloudDirectoryClient, AddFacetToObjectCommand } from "@aws-sdk/client-clouddirectory"; // ES Modules import + * // const { CloudDirectoryClient, AddFacetToObjectCommand } = require("@aws-sdk/client-clouddirectory"); // CommonJS import + * const client = new CloudDirectoryClient(config); + * const command = new AddFacetToObjectCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link AddFacetToObjectCommandInput} for command's `input` shape. + * @see {@link AddFacetToObjectCommandOutput} for command's `response` shape. + * @see {@link CloudDirectoryClientResolvedConfig | config} for command's `input` shape. + * */ export class AddFacetToObjectCommand extends $Command< AddFacetToObjectCommandInput, diff --git a/clients/client-clouddirectory/commands/ApplySchemaCommand.ts b/clients/client-clouddirectory/commands/ApplySchemaCommand.ts index 360eb48b6d24..a199048646e2 100644 --- a/clients/client-clouddirectory/commands/ApplySchemaCommand.ts +++ b/clients/client-clouddirectory/commands/ApplySchemaCommand.ts @@ -23,6 +23,20 @@ export interface ApplySchemaCommandOutput extends ApplySchemaResponse, __Metadat /** *

Copies the input published schema, at the specified version, into the Directory with the same * name and version as that of the published schema.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { CloudDirectoryClient, ApplySchemaCommand } from "@aws-sdk/client-clouddirectory"; // ES Modules import + * // const { CloudDirectoryClient, ApplySchemaCommand } = require("@aws-sdk/client-clouddirectory"); // CommonJS import + * const client = new CloudDirectoryClient(config); + * const command = new ApplySchemaCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ApplySchemaCommandInput} for command's `input` shape. + * @see {@link ApplySchemaCommandOutput} for command's `response` shape. + * @see {@link CloudDirectoryClientResolvedConfig | config} for command's `input` shape. + * */ export class ApplySchemaCommand extends $Command< ApplySchemaCommandInput, diff --git a/clients/client-clouddirectory/commands/AttachObjectCommand.ts b/clients/client-clouddirectory/commands/AttachObjectCommand.ts index 2498fcc56d47..ed2a26e40ced 100644 --- a/clients/client-clouddirectory/commands/AttachObjectCommand.ts +++ b/clients/client-clouddirectory/commands/AttachObjectCommand.ts @@ -32,6 +32,20 @@ export interface AttachObjectCommandOutput extends AttachObjectResponse, __Metad *

* * + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { CloudDirectoryClient, AttachObjectCommand } from "@aws-sdk/client-clouddirectory"; // ES Modules import + * // const { CloudDirectoryClient, AttachObjectCommand } = require("@aws-sdk/client-clouddirectory"); // CommonJS import + * const client = new CloudDirectoryClient(config); + * const command = new AttachObjectCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link AttachObjectCommandInput} for command's `input` shape. + * @see {@link AttachObjectCommandOutput} for command's `response` shape. + * @see {@link CloudDirectoryClientResolvedConfig | config} for command's `input` shape. + * */ export class AttachObjectCommand extends $Command< AttachObjectCommandInput, diff --git a/clients/client-clouddirectory/commands/AttachPolicyCommand.ts b/clients/client-clouddirectory/commands/AttachPolicyCommand.ts index 41ade0a2c9a2..8614767771c9 100644 --- a/clients/client-clouddirectory/commands/AttachPolicyCommand.ts +++ b/clients/client-clouddirectory/commands/AttachPolicyCommand.ts @@ -23,6 +23,20 @@ export interface AttachPolicyCommandOutput extends AttachPolicyResponse, __Metad /** *

Attaches a policy object to a regular object. An object can have a limited number of attached * policies.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { CloudDirectoryClient, AttachPolicyCommand } from "@aws-sdk/client-clouddirectory"; // ES Modules import + * // const { CloudDirectoryClient, AttachPolicyCommand } = require("@aws-sdk/client-clouddirectory"); // CommonJS import + * const client = new CloudDirectoryClient(config); + * const command = new AttachPolicyCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link AttachPolicyCommandInput} for command's `input` shape. + * @see {@link AttachPolicyCommandOutput} for command's `response` shape. + * @see {@link CloudDirectoryClientResolvedConfig | config} for command's `input` shape. + * */ export class AttachPolicyCommand extends $Command< AttachPolicyCommandInput, diff --git a/clients/client-clouddirectory/commands/AttachToIndexCommand.ts b/clients/client-clouddirectory/commands/AttachToIndexCommand.ts index 21a3bdf016d1..db6fa20c25ff 100644 --- a/clients/client-clouddirectory/commands/AttachToIndexCommand.ts +++ b/clients/client-clouddirectory/commands/AttachToIndexCommand.ts @@ -22,6 +22,20 @@ export interface AttachToIndexCommandOutput extends AttachToIndexResponse, __Met /** *

Attaches the specified object to the specified index.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { CloudDirectoryClient, AttachToIndexCommand } from "@aws-sdk/client-clouddirectory"; // ES Modules import + * // const { CloudDirectoryClient, AttachToIndexCommand } = require("@aws-sdk/client-clouddirectory"); // CommonJS import + * const client = new CloudDirectoryClient(config); + * const command = new AttachToIndexCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link AttachToIndexCommandInput} for command's `input` shape. + * @see {@link AttachToIndexCommandOutput} for command's `response` shape. + * @see {@link CloudDirectoryClientResolvedConfig | config} for command's `input` shape. + * */ export class AttachToIndexCommand extends $Command< AttachToIndexCommandInput, diff --git a/clients/client-clouddirectory/commands/AttachTypedLinkCommand.ts b/clients/client-clouddirectory/commands/AttachTypedLinkCommand.ts index 9078b953d4ba..69eb09ebe548 100644 --- a/clients/client-clouddirectory/commands/AttachTypedLinkCommand.ts +++ b/clients/client-clouddirectory/commands/AttachTypedLinkCommand.ts @@ -22,6 +22,20 @@ export interface AttachTypedLinkCommandOutput extends AttachTypedLinkResponse, _ /** *

Attaches a typed link to a specified source and target object. For more information, see Typed Links.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { CloudDirectoryClient, AttachTypedLinkCommand } from "@aws-sdk/client-clouddirectory"; // ES Modules import + * // const { CloudDirectoryClient, AttachTypedLinkCommand } = require("@aws-sdk/client-clouddirectory"); // CommonJS import + * const client = new CloudDirectoryClient(config); + * const command = new AttachTypedLinkCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link AttachTypedLinkCommandInput} for command's `input` shape. + * @see {@link AttachTypedLinkCommandOutput} for command's `response` shape. + * @see {@link CloudDirectoryClientResolvedConfig | config} for command's `input` shape. + * */ export class AttachTypedLinkCommand extends $Command< AttachTypedLinkCommandInput, diff --git a/clients/client-clouddirectory/commands/BatchReadCommand.ts b/clients/client-clouddirectory/commands/BatchReadCommand.ts index f33344a8d33d..cdc80208326b 100644 --- a/clients/client-clouddirectory/commands/BatchReadCommand.ts +++ b/clients/client-clouddirectory/commands/BatchReadCommand.ts @@ -22,6 +22,20 @@ export interface BatchReadCommandOutput extends BatchReadResponse, __MetadataBea /** *

Performs all the read operations in a batch.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { CloudDirectoryClient, BatchReadCommand } from "@aws-sdk/client-clouddirectory"; // ES Modules import + * // const { CloudDirectoryClient, BatchReadCommand } = require("@aws-sdk/client-clouddirectory"); // CommonJS import + * const client = new CloudDirectoryClient(config); + * const command = new BatchReadCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link BatchReadCommandInput} for command's `input` shape. + * @see {@link BatchReadCommandOutput} for command's `response` shape. + * @see {@link CloudDirectoryClientResolvedConfig | config} for command's `input` shape. + * */ export class BatchReadCommand extends $Command< BatchReadCommandInput, diff --git a/clients/client-clouddirectory/commands/BatchWriteCommand.ts b/clients/client-clouddirectory/commands/BatchWriteCommand.ts index 54dcacf978d2..84b4306f8533 100644 --- a/clients/client-clouddirectory/commands/BatchWriteCommand.ts +++ b/clients/client-clouddirectory/commands/BatchWriteCommand.ts @@ -23,6 +23,20 @@ export interface BatchWriteCommandOutput extends BatchWriteResponse, __MetadataB /** *

Performs all the write operations in a batch. Either all the operations succeed or * none.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { CloudDirectoryClient, BatchWriteCommand } from "@aws-sdk/client-clouddirectory"; // ES Modules import + * // const { CloudDirectoryClient, BatchWriteCommand } = require("@aws-sdk/client-clouddirectory"); // CommonJS import + * const client = new CloudDirectoryClient(config); + * const command = new BatchWriteCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link BatchWriteCommandInput} for command's `input` shape. + * @see {@link BatchWriteCommandOutput} for command's `response` shape. + * @see {@link CloudDirectoryClientResolvedConfig | config} for command's `input` shape. + * */ export class BatchWriteCommand extends $Command< BatchWriteCommandInput, diff --git a/clients/client-clouddirectory/commands/CreateDirectoryCommand.ts b/clients/client-clouddirectory/commands/CreateDirectoryCommand.ts index cfd2a7b383d7..92ced2024838 100644 --- a/clients/client-clouddirectory/commands/CreateDirectoryCommand.ts +++ b/clients/client-clouddirectory/commands/CreateDirectoryCommand.ts @@ -25,6 +25,20 @@ export interface CreateDirectoryCommandOutput extends CreateDirectoryResponse, _ * 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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { CloudDirectoryClient, CreateDirectoryCommand } from "@aws-sdk/client-clouddirectory"; // ES Modules import + * // const { CloudDirectoryClient, CreateDirectoryCommand } = require("@aws-sdk/client-clouddirectory"); // CommonJS import + * const client = new CloudDirectoryClient(config); + * const command = new CreateDirectoryCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreateDirectoryCommandInput} for command's `input` shape. + * @see {@link CreateDirectoryCommandOutput} for command's `response` shape. + * @see {@link CloudDirectoryClientResolvedConfig | config} for command's `input` shape. + * */ export class CreateDirectoryCommand extends $Command< CreateDirectoryCommandInput, diff --git a/clients/client-clouddirectory/commands/CreateFacetCommand.ts b/clients/client-clouddirectory/commands/CreateFacetCommand.ts index 66ed5e88958f..49c048a4328f 100644 --- a/clients/client-clouddirectory/commands/CreateFacetCommand.ts +++ b/clients/client-clouddirectory/commands/CreateFacetCommand.ts @@ -23,6 +23,20 @@ export interface CreateFacetCommandOutput extends CreateFacetResponse, __Metadat /** *

Creates a new Facet in a schema. Facet creation is allowed only * in development or applied schemas.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { CloudDirectoryClient, CreateFacetCommand } from "@aws-sdk/client-clouddirectory"; // ES Modules import + * // const { CloudDirectoryClient, CreateFacetCommand } = require("@aws-sdk/client-clouddirectory"); // CommonJS import + * const client = new CloudDirectoryClient(config); + * const command = new CreateFacetCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreateFacetCommandInput} for command's `input` shape. + * @see {@link CreateFacetCommandOutput} for command's `response` shape. + * @see {@link CloudDirectoryClientResolvedConfig | config} for command's `input` shape. + * */ export class CreateFacetCommand extends $Command< CreateFacetCommandInput, diff --git a/clients/client-clouddirectory/commands/CreateIndexCommand.ts b/clients/client-clouddirectory/commands/CreateIndexCommand.ts index aa7c3209743e..e0d83492cd3f 100644 --- a/clients/client-clouddirectory/commands/CreateIndexCommand.ts +++ b/clients/client-clouddirectory/commands/CreateIndexCommand.ts @@ -22,6 +22,20 @@ export interface CreateIndexCommandOutput extends CreateIndexResponse, __Metadat /** *

Creates an index object. See Indexing and search for more information.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { CloudDirectoryClient, CreateIndexCommand } from "@aws-sdk/client-clouddirectory"; // ES Modules import + * // const { CloudDirectoryClient, CreateIndexCommand } = require("@aws-sdk/client-clouddirectory"); // CommonJS import + * const client = new CloudDirectoryClient(config); + * const command = new CreateIndexCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreateIndexCommandInput} for command's `input` shape. + * @see {@link CreateIndexCommandOutput} for command's `response` shape. + * @see {@link CloudDirectoryClientResolvedConfig | config} for command's `input` shape. + * */ export class CreateIndexCommand extends $Command< CreateIndexCommandInput, diff --git a/clients/client-clouddirectory/commands/CreateObjectCommand.ts b/clients/client-clouddirectory/commands/CreateObjectCommand.ts index cff40ce8480d..d6368a8e55cc 100644 --- a/clients/client-clouddirectory/commands/CreateObjectCommand.ts +++ b/clients/client-clouddirectory/commands/CreateObjectCommand.ts @@ -25,6 +25,20 @@ export interface CreateObjectCommandOutput extends CreateObjectResponse, __Metad * 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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { CloudDirectoryClient, CreateObjectCommand } from "@aws-sdk/client-clouddirectory"; // ES Modules import + * // const { CloudDirectoryClient, CreateObjectCommand } = require("@aws-sdk/client-clouddirectory"); // CommonJS import + * const client = new CloudDirectoryClient(config); + * const command = new CreateObjectCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreateObjectCommandInput} for command's `input` shape. + * @see {@link CreateObjectCommandOutput} for command's `response` shape. + * @see {@link CloudDirectoryClientResolvedConfig | config} for command's `input` shape. + * */ export class CreateObjectCommand extends $Command< CreateObjectCommandInput, diff --git a/clients/client-clouddirectory/commands/CreateSchemaCommand.ts b/clients/client-clouddirectory/commands/CreateSchemaCommand.ts index ab9184ce3b8c..d1d288105e2e 100644 --- a/clients/client-clouddirectory/commands/CreateSchemaCommand.ts +++ b/clients/client-clouddirectory/commands/CreateSchemaCommand.ts @@ -42,6 +42,20 @@ export interface CreateSchemaCommandOutput extends CreateSchemaResponse, __Metad * facets. You can apply only published schemas to directories.

* * + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { CloudDirectoryClient, CreateSchemaCommand } from "@aws-sdk/client-clouddirectory"; // ES Modules import + * // const { CloudDirectoryClient, CreateSchemaCommand } = require("@aws-sdk/client-clouddirectory"); // CommonJS import + * const client = new CloudDirectoryClient(config); + * const command = new CreateSchemaCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreateSchemaCommandInput} for command's `input` shape. + * @see {@link CreateSchemaCommandOutput} for command's `response` shape. + * @see {@link CloudDirectoryClientResolvedConfig | config} for command's `input` shape. + * */ export class CreateSchemaCommand extends $Command< CreateSchemaCommandInput, diff --git a/clients/client-clouddirectory/commands/CreateTypedLinkFacetCommand.ts b/clients/client-clouddirectory/commands/CreateTypedLinkFacetCommand.ts index 1390d6313305..3e17db4a3e12 100644 --- a/clients/client-clouddirectory/commands/CreateTypedLinkFacetCommand.ts +++ b/clients/client-clouddirectory/commands/CreateTypedLinkFacetCommand.ts @@ -22,6 +22,20 @@ export interface CreateTypedLinkFacetCommandOutput extends CreateTypedLinkFacetR /** *

Creates a TypedLinkFacet. For more information, see Typed Links.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { CloudDirectoryClient, CreateTypedLinkFacetCommand } from "@aws-sdk/client-clouddirectory"; // ES Modules import + * // const { CloudDirectoryClient, CreateTypedLinkFacetCommand } = require("@aws-sdk/client-clouddirectory"); // CommonJS import + * const client = new CloudDirectoryClient(config); + * const command = new CreateTypedLinkFacetCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreateTypedLinkFacetCommandInput} for command's `input` shape. + * @see {@link CreateTypedLinkFacetCommandOutput} for command's `response` shape. + * @see {@link CloudDirectoryClientResolvedConfig | config} for command's `input` shape. + * */ export class CreateTypedLinkFacetCommand extends $Command< CreateTypedLinkFacetCommandInput, diff --git a/clients/client-clouddirectory/commands/DeleteDirectoryCommand.ts b/clients/client-clouddirectory/commands/DeleteDirectoryCommand.ts index f118f04c0df6..7e2b8bd4c102 100644 --- a/clients/client-clouddirectory/commands/DeleteDirectoryCommand.ts +++ b/clients/client-clouddirectory/commands/DeleteDirectoryCommand.ts @@ -24,6 +24,20 @@ export interface DeleteDirectoryCommandOutput extends DeleteDirectoryResponse, _ *

Deletes a directory. Only disabled directories can be deleted. A deleted directory cannot be undone. Exercise extreme * caution * when deleting directories.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { CloudDirectoryClient, DeleteDirectoryCommand } from "@aws-sdk/client-clouddirectory"; // ES Modules import + * // const { CloudDirectoryClient, DeleteDirectoryCommand } = require("@aws-sdk/client-clouddirectory"); // CommonJS import + * const client = new CloudDirectoryClient(config); + * const command = new DeleteDirectoryCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteDirectoryCommandInput} for command's `input` shape. + * @see {@link DeleteDirectoryCommandOutput} for command's `response` shape. + * @see {@link CloudDirectoryClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteDirectoryCommand extends $Command< DeleteDirectoryCommandInput, diff --git a/clients/client-clouddirectory/commands/DeleteFacetCommand.ts b/clients/client-clouddirectory/commands/DeleteFacetCommand.ts index b92a28a9892e..31a7bd5b7778 100644 --- a/clients/client-clouddirectory/commands/DeleteFacetCommand.ts +++ b/clients/client-clouddirectory/commands/DeleteFacetCommand.ts @@ -24,6 +24,20 @@ export interface DeleteFacetCommandOutput extends DeleteFacetResponse, __Metadat *

Deletes a given Facet. All attributes and Rules * that are associated with the facet will be deleted. Only development schema facets are allowed * deletion.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { CloudDirectoryClient, DeleteFacetCommand } from "@aws-sdk/client-clouddirectory"; // ES Modules import + * // const { CloudDirectoryClient, DeleteFacetCommand } = require("@aws-sdk/client-clouddirectory"); // CommonJS import + * const client = new CloudDirectoryClient(config); + * const command = new DeleteFacetCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteFacetCommandInput} for command's `input` shape. + * @see {@link DeleteFacetCommandOutput} for command's `response` shape. + * @see {@link CloudDirectoryClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteFacetCommand extends $Command< DeleteFacetCommandInput, diff --git a/clients/client-clouddirectory/commands/DeleteObjectCommand.ts b/clients/client-clouddirectory/commands/DeleteObjectCommand.ts index 0a23d75fa433..a64d12510ec1 100644 --- a/clients/client-clouddirectory/commands/DeleteObjectCommand.ts +++ b/clients/client-clouddirectory/commands/DeleteObjectCommand.ts @@ -23,6 +23,20 @@ export interface DeleteObjectCommandOutput extends DeleteObjectResponse, __Metad /** *

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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { CloudDirectoryClient, DeleteObjectCommand } from "@aws-sdk/client-clouddirectory"; // ES Modules import + * // const { CloudDirectoryClient, DeleteObjectCommand } = require("@aws-sdk/client-clouddirectory"); // CommonJS import + * const client = new CloudDirectoryClient(config); + * const command = new DeleteObjectCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteObjectCommandInput} for command's `input` shape. + * @see {@link DeleteObjectCommandOutput} for command's `response` shape. + * @see {@link CloudDirectoryClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteObjectCommand extends $Command< DeleteObjectCommandInput, diff --git a/clients/client-clouddirectory/commands/DeleteSchemaCommand.ts b/clients/client-clouddirectory/commands/DeleteSchemaCommand.ts index 4dbf8e8a1d61..2cfa06e0c74d 100644 --- a/clients/client-clouddirectory/commands/DeleteSchemaCommand.ts +++ b/clients/client-clouddirectory/commands/DeleteSchemaCommand.ts @@ -22,6 +22,20 @@ export interface DeleteSchemaCommandOutput extends DeleteSchemaResponse, __Metad /** *

Deletes a given schema. Schemas in a development and published state can only be deleted.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { CloudDirectoryClient, DeleteSchemaCommand } from "@aws-sdk/client-clouddirectory"; // ES Modules import + * // const { CloudDirectoryClient, DeleteSchemaCommand } = require("@aws-sdk/client-clouddirectory"); // CommonJS import + * const client = new CloudDirectoryClient(config); + * const command = new DeleteSchemaCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteSchemaCommandInput} for command's `input` shape. + * @see {@link DeleteSchemaCommandOutput} for command's `response` shape. + * @see {@link CloudDirectoryClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteSchemaCommand extends $Command< DeleteSchemaCommandInput, diff --git a/clients/client-clouddirectory/commands/DeleteTypedLinkFacetCommand.ts b/clients/client-clouddirectory/commands/DeleteTypedLinkFacetCommand.ts index 4c58c9e4c310..b9751e00b7af 100644 --- a/clients/client-clouddirectory/commands/DeleteTypedLinkFacetCommand.ts +++ b/clients/client-clouddirectory/commands/DeleteTypedLinkFacetCommand.ts @@ -22,6 +22,20 @@ export interface DeleteTypedLinkFacetCommandOutput extends DeleteTypedLinkFacetR /** *

Deletes a TypedLinkFacet. For more information, see Typed Links.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { CloudDirectoryClient, DeleteTypedLinkFacetCommand } from "@aws-sdk/client-clouddirectory"; // ES Modules import + * // const { CloudDirectoryClient, DeleteTypedLinkFacetCommand } = require("@aws-sdk/client-clouddirectory"); // CommonJS import + * const client = new CloudDirectoryClient(config); + * const command = new DeleteTypedLinkFacetCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteTypedLinkFacetCommandInput} for command's `input` shape. + * @see {@link DeleteTypedLinkFacetCommandOutput} for command's `response` shape. + * @see {@link CloudDirectoryClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteTypedLinkFacetCommand extends $Command< DeleteTypedLinkFacetCommandInput, diff --git a/clients/client-clouddirectory/commands/DetachFromIndexCommand.ts b/clients/client-clouddirectory/commands/DetachFromIndexCommand.ts index d57d71959e11..5a1f60f41e70 100644 --- a/clients/client-clouddirectory/commands/DetachFromIndexCommand.ts +++ b/clients/client-clouddirectory/commands/DetachFromIndexCommand.ts @@ -22,6 +22,20 @@ export interface DetachFromIndexCommandOutput extends DetachFromIndexResponse, _ /** *

Detaches the specified object from the specified index.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { CloudDirectoryClient, DetachFromIndexCommand } from "@aws-sdk/client-clouddirectory"; // ES Modules import + * // const { CloudDirectoryClient, DetachFromIndexCommand } = require("@aws-sdk/client-clouddirectory"); // CommonJS import + * const client = new CloudDirectoryClient(config); + * const command = new DetachFromIndexCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DetachFromIndexCommandInput} for command's `input` shape. + * @see {@link DetachFromIndexCommandOutput} for command's `response` shape. + * @see {@link CloudDirectoryClientResolvedConfig | config} for command's `input` shape. + * */ export class DetachFromIndexCommand extends $Command< DetachFromIndexCommandInput, diff --git a/clients/client-clouddirectory/commands/DetachObjectCommand.ts b/clients/client-clouddirectory/commands/DetachObjectCommand.ts index a10a7f0cea8d..39a83ca61a0e 100644 --- a/clients/client-clouddirectory/commands/DetachObjectCommand.ts +++ b/clients/client-clouddirectory/commands/DetachObjectCommand.ts @@ -23,6 +23,20 @@ export interface DetachObjectCommandOutput extends DetachObjectResponse, __Metad /** *

Detaches a given object from the parent object. The object that is to be detached from the * parent is specified by the link name.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { CloudDirectoryClient, DetachObjectCommand } from "@aws-sdk/client-clouddirectory"; // ES Modules import + * // const { CloudDirectoryClient, DetachObjectCommand } = require("@aws-sdk/client-clouddirectory"); // CommonJS import + * const client = new CloudDirectoryClient(config); + * const command = new DetachObjectCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DetachObjectCommandInput} for command's `input` shape. + * @see {@link DetachObjectCommandOutput} for command's `response` shape. + * @see {@link CloudDirectoryClientResolvedConfig | config} for command's `input` shape. + * */ export class DetachObjectCommand extends $Command< DetachObjectCommandInput, diff --git a/clients/client-clouddirectory/commands/DetachPolicyCommand.ts b/clients/client-clouddirectory/commands/DetachPolicyCommand.ts index c64f7deb6354..e1db2ce65d9a 100644 --- a/clients/client-clouddirectory/commands/DetachPolicyCommand.ts +++ b/clients/client-clouddirectory/commands/DetachPolicyCommand.ts @@ -22,6 +22,20 @@ export interface DetachPolicyCommandOutput extends DetachPolicyResponse, __Metad /** *

Detaches a policy from an object.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { CloudDirectoryClient, DetachPolicyCommand } from "@aws-sdk/client-clouddirectory"; // ES Modules import + * // const { CloudDirectoryClient, DetachPolicyCommand } = require("@aws-sdk/client-clouddirectory"); // CommonJS import + * const client = new CloudDirectoryClient(config); + * const command = new DetachPolicyCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DetachPolicyCommandInput} for command's `input` shape. + * @see {@link DetachPolicyCommandOutput} for command's `response` shape. + * @see {@link CloudDirectoryClientResolvedConfig | config} for command's `input` shape. + * */ export class DetachPolicyCommand extends $Command< DetachPolicyCommandInput, diff --git a/clients/client-clouddirectory/commands/DetachTypedLinkCommand.ts b/clients/client-clouddirectory/commands/DetachTypedLinkCommand.ts index b9aafd8b5c25..3b80e1844a75 100644 --- a/clients/client-clouddirectory/commands/DetachTypedLinkCommand.ts +++ b/clients/client-clouddirectory/commands/DetachTypedLinkCommand.ts @@ -22,6 +22,20 @@ export interface DetachTypedLinkCommandOutput extends __MetadataBearer {} /** *

Detaches a typed link from a specified source and target object. For more information, see Typed Links.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { CloudDirectoryClient, DetachTypedLinkCommand } from "@aws-sdk/client-clouddirectory"; // ES Modules import + * // const { CloudDirectoryClient, DetachTypedLinkCommand } = require("@aws-sdk/client-clouddirectory"); // CommonJS import + * const client = new CloudDirectoryClient(config); + * const command = new DetachTypedLinkCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DetachTypedLinkCommandInput} for command's `input` shape. + * @see {@link DetachTypedLinkCommandOutput} for command's `response` shape. + * @see {@link CloudDirectoryClientResolvedConfig | config} for command's `input` shape. + * */ export class DetachTypedLinkCommand extends $Command< DetachTypedLinkCommandInput, diff --git a/clients/client-clouddirectory/commands/DisableDirectoryCommand.ts b/clients/client-clouddirectory/commands/DisableDirectoryCommand.ts index 20c93068f070..ec64cd5cafe7 100644 --- a/clients/client-clouddirectory/commands/DisableDirectoryCommand.ts +++ b/clients/client-clouddirectory/commands/DisableDirectoryCommand.ts @@ -23,6 +23,20 @@ export interface DisableDirectoryCommandOutput extends DisableDirectoryResponse, /** *

Disables the specified directory. Disabled directories cannot be read or written to. * Only enabled directories can be disabled. Disabled directories may be reenabled.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { CloudDirectoryClient, DisableDirectoryCommand } from "@aws-sdk/client-clouddirectory"; // ES Modules import + * // const { CloudDirectoryClient, DisableDirectoryCommand } = require("@aws-sdk/client-clouddirectory"); // CommonJS import + * const client = new CloudDirectoryClient(config); + * const command = new DisableDirectoryCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DisableDirectoryCommandInput} for command's `input` shape. + * @see {@link DisableDirectoryCommandOutput} for command's `response` shape. + * @see {@link CloudDirectoryClientResolvedConfig | config} for command's `input` shape. + * */ export class DisableDirectoryCommand extends $Command< DisableDirectoryCommandInput, diff --git a/clients/client-clouddirectory/commands/EnableDirectoryCommand.ts b/clients/client-clouddirectory/commands/EnableDirectoryCommand.ts index 3a0648969738..acba805c4f8f 100644 --- a/clients/client-clouddirectory/commands/EnableDirectoryCommand.ts +++ b/clients/client-clouddirectory/commands/EnableDirectoryCommand.ts @@ -23,6 +23,20 @@ export interface EnableDirectoryCommandOutput extends EnableDirectoryResponse, _ /** *

Enables the specified directory. Only disabled directories can be enabled. Once * enabled, the directory can then be read and written to.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { CloudDirectoryClient, EnableDirectoryCommand } from "@aws-sdk/client-clouddirectory"; // ES Modules import + * // const { CloudDirectoryClient, EnableDirectoryCommand } = require("@aws-sdk/client-clouddirectory"); // CommonJS import + * const client = new CloudDirectoryClient(config); + * const command = new EnableDirectoryCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link EnableDirectoryCommandInput} for command's `input` shape. + * @see {@link EnableDirectoryCommandOutput} for command's `response` shape. + * @see {@link CloudDirectoryClientResolvedConfig | config} for command's `input` shape. + * */ export class EnableDirectoryCommand extends $Command< EnableDirectoryCommandInput, diff --git a/clients/client-clouddirectory/commands/GetAppliedSchemaVersionCommand.ts b/clients/client-clouddirectory/commands/GetAppliedSchemaVersionCommand.ts index 9b185c15c1c4..35a9d9ae4e2f 100644 --- a/clients/client-clouddirectory/commands/GetAppliedSchemaVersionCommand.ts +++ b/clients/client-clouddirectory/commands/GetAppliedSchemaVersionCommand.ts @@ -22,6 +22,20 @@ export interface GetAppliedSchemaVersionCommandOutput extends GetAppliedSchemaVe /** *

Returns current applied schema version ARN, including the minor version in use.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { CloudDirectoryClient, GetAppliedSchemaVersionCommand } from "@aws-sdk/client-clouddirectory"; // ES Modules import + * // const { CloudDirectoryClient, GetAppliedSchemaVersionCommand } = require("@aws-sdk/client-clouddirectory"); // CommonJS import + * const client = new CloudDirectoryClient(config); + * const command = new GetAppliedSchemaVersionCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetAppliedSchemaVersionCommandInput} for command's `input` shape. + * @see {@link GetAppliedSchemaVersionCommandOutput} for command's `response` shape. + * @see {@link CloudDirectoryClientResolvedConfig | config} for command's `input` shape. + * */ export class GetAppliedSchemaVersionCommand extends $Command< GetAppliedSchemaVersionCommandInput, diff --git a/clients/client-clouddirectory/commands/GetDirectoryCommand.ts b/clients/client-clouddirectory/commands/GetDirectoryCommand.ts index fb7b40f19539..d31f43a71a69 100644 --- a/clients/client-clouddirectory/commands/GetDirectoryCommand.ts +++ b/clients/client-clouddirectory/commands/GetDirectoryCommand.ts @@ -22,6 +22,20 @@ export interface GetDirectoryCommandOutput extends GetDirectoryResponse, __Metad /** *

Retrieves metadata about a directory.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { CloudDirectoryClient, GetDirectoryCommand } from "@aws-sdk/client-clouddirectory"; // ES Modules import + * // const { CloudDirectoryClient, GetDirectoryCommand } = require("@aws-sdk/client-clouddirectory"); // CommonJS import + * const client = new CloudDirectoryClient(config); + * const command = new GetDirectoryCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetDirectoryCommandInput} for command's `input` shape. + * @see {@link GetDirectoryCommandOutput} for command's `response` shape. + * @see {@link CloudDirectoryClientResolvedConfig | config} for command's `input` shape. + * */ export class GetDirectoryCommand extends $Command< GetDirectoryCommandInput, diff --git a/clients/client-clouddirectory/commands/GetFacetCommand.ts b/clients/client-clouddirectory/commands/GetFacetCommand.ts index 7515b6d3de24..b0a2f87f0a88 100644 --- a/clients/client-clouddirectory/commands/GetFacetCommand.ts +++ b/clients/client-clouddirectory/commands/GetFacetCommand.ts @@ -23,6 +23,20 @@ export interface GetFacetCommandOutput extends GetFacetResponse, __MetadataBeare /** *

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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { CloudDirectoryClient, GetFacetCommand } from "@aws-sdk/client-clouddirectory"; // ES Modules import + * // const { CloudDirectoryClient, GetFacetCommand } = require("@aws-sdk/client-clouddirectory"); // CommonJS import + * const client = new CloudDirectoryClient(config); + * const command = new GetFacetCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetFacetCommandInput} for command's `input` shape. + * @see {@link GetFacetCommandOutput} for command's `response` shape. + * @see {@link CloudDirectoryClientResolvedConfig | config} for command's `input` shape. + * */ export class GetFacetCommand extends $Command< GetFacetCommandInput, diff --git a/clients/client-clouddirectory/commands/GetLinkAttributesCommand.ts b/clients/client-clouddirectory/commands/GetLinkAttributesCommand.ts index 3b8006764672..138f8dceafcd 100644 --- a/clients/client-clouddirectory/commands/GetLinkAttributesCommand.ts +++ b/clients/client-clouddirectory/commands/GetLinkAttributesCommand.ts @@ -22,6 +22,20 @@ export interface GetLinkAttributesCommandOutput extends GetLinkAttributesRespons /** *

Retrieves attributes that are associated with a typed link.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { CloudDirectoryClient, GetLinkAttributesCommand } from "@aws-sdk/client-clouddirectory"; // ES Modules import + * // const { CloudDirectoryClient, GetLinkAttributesCommand } = require("@aws-sdk/client-clouddirectory"); // CommonJS import + * const client = new CloudDirectoryClient(config); + * const command = new GetLinkAttributesCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetLinkAttributesCommandInput} for command's `input` shape. + * @see {@link GetLinkAttributesCommandOutput} for command's `response` shape. + * @see {@link CloudDirectoryClientResolvedConfig | config} for command's `input` shape. + * */ export class GetLinkAttributesCommand extends $Command< GetLinkAttributesCommandInput, diff --git a/clients/client-clouddirectory/commands/GetObjectAttributesCommand.ts b/clients/client-clouddirectory/commands/GetObjectAttributesCommand.ts index 8cad065acb36..141021e3a164 100644 --- a/clients/client-clouddirectory/commands/GetObjectAttributesCommand.ts +++ b/clients/client-clouddirectory/commands/GetObjectAttributesCommand.ts @@ -22,6 +22,20 @@ export interface GetObjectAttributesCommandOutput extends GetObjectAttributesRes /** *

Retrieves attributes within a facet that are associated with an object.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { CloudDirectoryClient, GetObjectAttributesCommand } from "@aws-sdk/client-clouddirectory"; // ES Modules import + * // const { CloudDirectoryClient, GetObjectAttributesCommand } = require("@aws-sdk/client-clouddirectory"); // CommonJS import + * const client = new CloudDirectoryClient(config); + * const command = new GetObjectAttributesCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetObjectAttributesCommandInput} for command's `input` shape. + * @see {@link GetObjectAttributesCommandOutput} for command's `response` shape. + * @see {@link CloudDirectoryClientResolvedConfig | config} for command's `input` shape. + * */ export class GetObjectAttributesCommand extends $Command< GetObjectAttributesCommandInput, diff --git a/clients/client-clouddirectory/commands/GetObjectInformationCommand.ts b/clients/client-clouddirectory/commands/GetObjectInformationCommand.ts index fa5240582605..649125748b63 100644 --- a/clients/client-clouddirectory/commands/GetObjectInformationCommand.ts +++ b/clients/client-clouddirectory/commands/GetObjectInformationCommand.ts @@ -22,6 +22,20 @@ export interface GetObjectInformationCommandOutput extends GetObjectInformationR /** *

Retrieves metadata about an object.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { CloudDirectoryClient, GetObjectInformationCommand } from "@aws-sdk/client-clouddirectory"; // ES Modules import + * // const { CloudDirectoryClient, GetObjectInformationCommand } = require("@aws-sdk/client-clouddirectory"); // CommonJS import + * const client = new CloudDirectoryClient(config); + * const command = new GetObjectInformationCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetObjectInformationCommandInput} for command's `input` shape. + * @see {@link GetObjectInformationCommandOutput} for command's `response` shape. + * @see {@link CloudDirectoryClientResolvedConfig | config} for command's `input` shape. + * */ export class GetObjectInformationCommand extends $Command< GetObjectInformationCommandInput, diff --git a/clients/client-clouddirectory/commands/GetSchemaAsJsonCommand.ts b/clients/client-clouddirectory/commands/GetSchemaAsJsonCommand.ts index f6daa38e5236..89a0dfee6506 100644 --- a/clients/client-clouddirectory/commands/GetSchemaAsJsonCommand.ts +++ b/clients/client-clouddirectory/commands/GetSchemaAsJsonCommand.ts @@ -22,6 +22,20 @@ export interface GetSchemaAsJsonCommandOutput extends GetSchemaAsJsonResponse, _ /** *

Retrieves a JSON representation of the schema. See JSON Schema Format for more information.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { CloudDirectoryClient, GetSchemaAsJsonCommand } from "@aws-sdk/client-clouddirectory"; // ES Modules import + * // const { CloudDirectoryClient, GetSchemaAsJsonCommand } = require("@aws-sdk/client-clouddirectory"); // CommonJS import + * const client = new CloudDirectoryClient(config); + * const command = new GetSchemaAsJsonCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetSchemaAsJsonCommandInput} for command's `input` shape. + * @see {@link GetSchemaAsJsonCommandOutput} for command's `response` shape. + * @see {@link CloudDirectoryClientResolvedConfig | config} for command's `input` shape. + * */ export class GetSchemaAsJsonCommand extends $Command< GetSchemaAsJsonCommandInput, diff --git a/clients/client-clouddirectory/commands/GetTypedLinkFacetInformationCommand.ts b/clients/client-clouddirectory/commands/GetTypedLinkFacetInformationCommand.ts index 60dae1514b36..b9a582c74a17 100644 --- a/clients/client-clouddirectory/commands/GetTypedLinkFacetInformationCommand.ts +++ b/clients/client-clouddirectory/commands/GetTypedLinkFacetInformationCommand.ts @@ -24,6 +24,20 @@ export interface GetTypedLinkFacetInformationCommandOutput /** *

Returns the identity attribute order for a specific TypedLinkFacet. For more information, see Typed Links.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { CloudDirectoryClient, GetTypedLinkFacetInformationCommand } from "@aws-sdk/client-clouddirectory"; // ES Modules import + * // const { CloudDirectoryClient, GetTypedLinkFacetInformationCommand } = require("@aws-sdk/client-clouddirectory"); // CommonJS import + * const client = new CloudDirectoryClient(config); + * const command = new GetTypedLinkFacetInformationCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetTypedLinkFacetInformationCommandInput} for command's `input` shape. + * @see {@link GetTypedLinkFacetInformationCommandOutput} for command's `response` shape. + * @see {@link CloudDirectoryClientResolvedConfig | config} for command's `input` shape. + * */ export class GetTypedLinkFacetInformationCommand extends $Command< GetTypedLinkFacetInformationCommandInput, diff --git a/clients/client-clouddirectory/commands/ListAppliedSchemaArnsCommand.ts b/clients/client-clouddirectory/commands/ListAppliedSchemaArnsCommand.ts index 4f2c5be3a63b..79e1aeeb1c75 100644 --- a/clients/client-clouddirectory/commands/ListAppliedSchemaArnsCommand.ts +++ b/clients/client-clouddirectory/commands/ListAppliedSchemaArnsCommand.ts @@ -22,6 +22,20 @@ export interface ListAppliedSchemaArnsCommandOutput extends ListAppliedSchemaArn /** *

Lists schema major versions applied to a directory. If SchemaArn is provided, lists the minor version.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { CloudDirectoryClient, ListAppliedSchemaArnsCommand } from "@aws-sdk/client-clouddirectory"; // ES Modules import + * // const { CloudDirectoryClient, ListAppliedSchemaArnsCommand } = require("@aws-sdk/client-clouddirectory"); // CommonJS import + * const client = new CloudDirectoryClient(config); + * const command = new ListAppliedSchemaArnsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListAppliedSchemaArnsCommandInput} for command's `input` shape. + * @see {@link ListAppliedSchemaArnsCommandOutput} for command's `response` shape. + * @see {@link CloudDirectoryClientResolvedConfig | config} for command's `input` shape. + * */ export class ListAppliedSchemaArnsCommand extends $Command< ListAppliedSchemaArnsCommandInput, diff --git a/clients/client-clouddirectory/commands/ListAttachedIndicesCommand.ts b/clients/client-clouddirectory/commands/ListAttachedIndicesCommand.ts index 10422c548d0c..7696d05f481e 100644 --- a/clients/client-clouddirectory/commands/ListAttachedIndicesCommand.ts +++ b/clients/client-clouddirectory/commands/ListAttachedIndicesCommand.ts @@ -22,6 +22,20 @@ export interface ListAttachedIndicesCommandOutput extends ListAttachedIndicesRes /** *

Lists indices attached to the specified object.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { CloudDirectoryClient, ListAttachedIndicesCommand } from "@aws-sdk/client-clouddirectory"; // ES Modules import + * // const { CloudDirectoryClient, ListAttachedIndicesCommand } = require("@aws-sdk/client-clouddirectory"); // CommonJS import + * const client = new CloudDirectoryClient(config); + * const command = new ListAttachedIndicesCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListAttachedIndicesCommandInput} for command's `input` shape. + * @see {@link ListAttachedIndicesCommandOutput} for command's `response` shape. + * @see {@link CloudDirectoryClientResolvedConfig | config} for command's `input` shape. + * */ export class ListAttachedIndicesCommand extends $Command< ListAttachedIndicesCommandInput, diff --git a/clients/client-clouddirectory/commands/ListDevelopmentSchemaArnsCommand.ts b/clients/client-clouddirectory/commands/ListDevelopmentSchemaArnsCommand.ts index 5dde9489015e..3de5d34cbb40 100644 --- a/clients/client-clouddirectory/commands/ListDevelopmentSchemaArnsCommand.ts +++ b/clients/client-clouddirectory/commands/ListDevelopmentSchemaArnsCommand.ts @@ -23,6 +23,20 @@ export interface ListDevelopmentSchemaArnsCommandOutput extends ListDevelopmentS /** *

Retrieves each Amazon Resource Name (ARN) of schemas in the development * state.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { CloudDirectoryClient, ListDevelopmentSchemaArnsCommand } from "@aws-sdk/client-clouddirectory"; // ES Modules import + * // const { CloudDirectoryClient, ListDevelopmentSchemaArnsCommand } = require("@aws-sdk/client-clouddirectory"); // CommonJS import + * const client = new CloudDirectoryClient(config); + * const command = new ListDevelopmentSchemaArnsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListDevelopmentSchemaArnsCommandInput} for command's `input` shape. + * @see {@link ListDevelopmentSchemaArnsCommandOutput} for command's `response` shape. + * @see {@link CloudDirectoryClientResolvedConfig | config} for command's `input` shape. + * */ export class ListDevelopmentSchemaArnsCommand extends $Command< ListDevelopmentSchemaArnsCommandInput, diff --git a/clients/client-clouddirectory/commands/ListDirectoriesCommand.ts b/clients/client-clouddirectory/commands/ListDirectoriesCommand.ts index 86508687cbf6..30bdd365b76b 100644 --- a/clients/client-clouddirectory/commands/ListDirectoriesCommand.ts +++ b/clients/client-clouddirectory/commands/ListDirectoriesCommand.ts @@ -22,6 +22,20 @@ export interface ListDirectoriesCommandOutput extends ListDirectoriesResponse, _ /** *

Lists directories created within an account.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { CloudDirectoryClient, ListDirectoriesCommand } from "@aws-sdk/client-clouddirectory"; // ES Modules import + * // const { CloudDirectoryClient, ListDirectoriesCommand } = require("@aws-sdk/client-clouddirectory"); // CommonJS import + * const client = new CloudDirectoryClient(config); + * const command = new ListDirectoriesCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListDirectoriesCommandInput} for command's `input` shape. + * @see {@link ListDirectoriesCommandOutput} for command's `response` shape. + * @see {@link CloudDirectoryClientResolvedConfig | config} for command's `input` shape. + * */ export class ListDirectoriesCommand extends $Command< ListDirectoriesCommandInput, diff --git a/clients/client-clouddirectory/commands/ListFacetAttributesCommand.ts b/clients/client-clouddirectory/commands/ListFacetAttributesCommand.ts index deafdf242076..a8c9dda015e5 100644 --- a/clients/client-clouddirectory/commands/ListFacetAttributesCommand.ts +++ b/clients/client-clouddirectory/commands/ListFacetAttributesCommand.ts @@ -22,6 +22,20 @@ export interface ListFacetAttributesCommandOutput extends ListFacetAttributesRes /** *

Retrieves attributes attached to the facet.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { CloudDirectoryClient, ListFacetAttributesCommand } from "@aws-sdk/client-clouddirectory"; // ES Modules import + * // const { CloudDirectoryClient, ListFacetAttributesCommand } = require("@aws-sdk/client-clouddirectory"); // CommonJS import + * const client = new CloudDirectoryClient(config); + * const command = new ListFacetAttributesCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListFacetAttributesCommandInput} for command's `input` shape. + * @see {@link ListFacetAttributesCommandOutput} for command's `response` shape. + * @see {@link CloudDirectoryClientResolvedConfig | config} for command's `input` shape. + * */ export class ListFacetAttributesCommand extends $Command< ListFacetAttributesCommandInput, diff --git a/clients/client-clouddirectory/commands/ListFacetNamesCommand.ts b/clients/client-clouddirectory/commands/ListFacetNamesCommand.ts index cabe77146188..fd0239b3b2b2 100644 --- a/clients/client-clouddirectory/commands/ListFacetNamesCommand.ts +++ b/clients/client-clouddirectory/commands/ListFacetNamesCommand.ts @@ -22,6 +22,20 @@ export interface ListFacetNamesCommandOutput extends ListFacetNamesResponse, __M /** *

Retrieves the names of facets that exist in a schema.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { CloudDirectoryClient, ListFacetNamesCommand } from "@aws-sdk/client-clouddirectory"; // ES Modules import + * // const { CloudDirectoryClient, ListFacetNamesCommand } = require("@aws-sdk/client-clouddirectory"); // CommonJS import + * const client = new CloudDirectoryClient(config); + * const command = new ListFacetNamesCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListFacetNamesCommandInput} for command's `input` shape. + * @see {@link ListFacetNamesCommandOutput} for command's `response` shape. + * @see {@link CloudDirectoryClientResolvedConfig | config} for command's `input` shape. + * */ export class ListFacetNamesCommand extends $Command< ListFacetNamesCommandInput, diff --git a/clients/client-clouddirectory/commands/ListIncomingTypedLinksCommand.ts b/clients/client-clouddirectory/commands/ListIncomingTypedLinksCommand.ts index 60e538078ac2..1fe97c7b3015 100644 --- a/clients/client-clouddirectory/commands/ListIncomingTypedLinksCommand.ts +++ b/clients/client-clouddirectory/commands/ListIncomingTypedLinksCommand.ts @@ -24,6 +24,20 @@ export interface ListIncomingTypedLinksCommandOutput extends ListIncomingTypedLi *

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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { CloudDirectoryClient, ListIncomingTypedLinksCommand } from "@aws-sdk/client-clouddirectory"; // ES Modules import + * // const { CloudDirectoryClient, ListIncomingTypedLinksCommand } = require("@aws-sdk/client-clouddirectory"); // CommonJS import + * const client = new CloudDirectoryClient(config); + * const command = new ListIncomingTypedLinksCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListIncomingTypedLinksCommandInput} for command's `input` shape. + * @see {@link ListIncomingTypedLinksCommandOutput} for command's `response` shape. + * @see {@link CloudDirectoryClientResolvedConfig | config} for command's `input` shape. + * */ export class ListIncomingTypedLinksCommand extends $Command< ListIncomingTypedLinksCommandInput, diff --git a/clients/client-clouddirectory/commands/ListIndexCommand.ts b/clients/client-clouddirectory/commands/ListIndexCommand.ts index 84dc07cfe8b7..8634d876ba27 100644 --- a/clients/client-clouddirectory/commands/ListIndexCommand.ts +++ b/clients/client-clouddirectory/commands/ListIndexCommand.ts @@ -22,6 +22,20 @@ export interface ListIndexCommandOutput extends ListIndexResponse, __MetadataBea /** *

Lists objects attached to the specified index.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { CloudDirectoryClient, ListIndexCommand } from "@aws-sdk/client-clouddirectory"; // ES Modules import + * // const { CloudDirectoryClient, ListIndexCommand } = require("@aws-sdk/client-clouddirectory"); // CommonJS import + * const client = new CloudDirectoryClient(config); + * const command = new ListIndexCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListIndexCommandInput} for command's `input` shape. + * @see {@link ListIndexCommandOutput} for command's `response` shape. + * @see {@link CloudDirectoryClientResolvedConfig | config} for command's `input` shape. + * */ export class ListIndexCommand extends $Command< ListIndexCommandInput, diff --git a/clients/client-clouddirectory/commands/ListManagedSchemaArnsCommand.ts b/clients/client-clouddirectory/commands/ListManagedSchemaArnsCommand.ts index 2e18d4f93ec0..3e1bf0bec2f2 100644 --- a/clients/client-clouddirectory/commands/ListManagedSchemaArnsCommand.ts +++ b/clients/client-clouddirectory/commands/ListManagedSchemaArnsCommand.ts @@ -22,6 +22,20 @@ export interface ListManagedSchemaArnsCommandOutput extends ListManagedSchemaArn /** *

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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { CloudDirectoryClient, ListManagedSchemaArnsCommand } from "@aws-sdk/client-clouddirectory"; // ES Modules import + * // const { CloudDirectoryClient, ListManagedSchemaArnsCommand } = require("@aws-sdk/client-clouddirectory"); // CommonJS import + * const client = new CloudDirectoryClient(config); + * const command = new ListManagedSchemaArnsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListManagedSchemaArnsCommandInput} for command's `input` shape. + * @see {@link ListManagedSchemaArnsCommandOutput} for command's `response` shape. + * @see {@link CloudDirectoryClientResolvedConfig | config} for command's `input` shape. + * */ export class ListManagedSchemaArnsCommand extends $Command< ListManagedSchemaArnsCommandInput, diff --git a/clients/client-clouddirectory/commands/ListObjectAttributesCommand.ts b/clients/client-clouddirectory/commands/ListObjectAttributesCommand.ts index 2745a5b4d6de..a0e5c0229bef 100644 --- a/clients/client-clouddirectory/commands/ListObjectAttributesCommand.ts +++ b/clients/client-clouddirectory/commands/ListObjectAttributesCommand.ts @@ -23,6 +23,20 @@ export interface ListObjectAttributesCommandOutput extends ListObjectAttributesR /** *

Lists all attributes that are associated with an object. *

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { CloudDirectoryClient, ListObjectAttributesCommand } from "@aws-sdk/client-clouddirectory"; // ES Modules import + * // const { CloudDirectoryClient, ListObjectAttributesCommand } = require("@aws-sdk/client-clouddirectory"); // CommonJS import + * const client = new CloudDirectoryClient(config); + * const command = new ListObjectAttributesCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListObjectAttributesCommandInput} for command's `input` shape. + * @see {@link ListObjectAttributesCommandOutput} for command's `response` shape. + * @see {@link CloudDirectoryClientResolvedConfig | config} for command's `input` shape. + * */ export class ListObjectAttributesCommand extends $Command< ListObjectAttributesCommandInput, diff --git a/clients/client-clouddirectory/commands/ListObjectChildrenCommand.ts b/clients/client-clouddirectory/commands/ListObjectChildrenCommand.ts index 67950c9b1b16..23da4699c979 100644 --- a/clients/client-clouddirectory/commands/ListObjectChildrenCommand.ts +++ b/clients/client-clouddirectory/commands/ListObjectChildrenCommand.ts @@ -23,6 +23,20 @@ export interface ListObjectChildrenCommandOutput extends ListObjectChildrenRespo /** *

Returns a paginated list of child objects that are associated with a given * object.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { CloudDirectoryClient, ListObjectChildrenCommand } from "@aws-sdk/client-clouddirectory"; // ES Modules import + * // const { CloudDirectoryClient, ListObjectChildrenCommand } = require("@aws-sdk/client-clouddirectory"); // CommonJS import + * const client = new CloudDirectoryClient(config); + * const command = new ListObjectChildrenCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListObjectChildrenCommandInput} for command's `input` shape. + * @see {@link ListObjectChildrenCommandOutput} for command's `response` shape. + * @see {@link CloudDirectoryClientResolvedConfig | config} for command's `input` shape. + * */ export class ListObjectChildrenCommand extends $Command< ListObjectChildrenCommandInput, diff --git a/clients/client-clouddirectory/commands/ListObjectParentPathsCommand.ts b/clients/client-clouddirectory/commands/ListObjectParentPathsCommand.ts index 2c1b96482ed6..bf7c6ace64ef 100644 --- a/clients/client-clouddirectory/commands/ListObjectParentPathsCommand.ts +++ b/clients/client-clouddirectory/commands/ListObjectParentPathsCommand.ts @@ -29,6 +29,20 @@ export interface ListObjectParentPathsCommandOutput extends ListObjectParentPath * 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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { CloudDirectoryClient, ListObjectParentPathsCommand } from "@aws-sdk/client-clouddirectory"; // ES Modules import + * // const { CloudDirectoryClient, ListObjectParentPathsCommand } = require("@aws-sdk/client-clouddirectory"); // CommonJS import + * const client = new CloudDirectoryClient(config); + * const command = new ListObjectParentPathsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListObjectParentPathsCommandInput} for command's `input` shape. + * @see {@link ListObjectParentPathsCommandOutput} for command's `response` shape. + * @see {@link CloudDirectoryClientResolvedConfig | config} for command's `input` shape. + * */ export class ListObjectParentPathsCommand extends $Command< ListObjectParentPathsCommandInput, diff --git a/clients/client-clouddirectory/commands/ListObjectParentsCommand.ts b/clients/client-clouddirectory/commands/ListObjectParentsCommand.ts index 2a56e4187a92..e1a7737c3aa1 100644 --- a/clients/client-clouddirectory/commands/ListObjectParentsCommand.ts +++ b/clients/client-clouddirectory/commands/ListObjectParentsCommand.ts @@ -23,6 +23,20 @@ export interface ListObjectParentsCommandOutput extends ListObjectParentsRespons /** *

Lists parent objects that are associated with a given object in pagination * fashion.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { CloudDirectoryClient, ListObjectParentsCommand } from "@aws-sdk/client-clouddirectory"; // ES Modules import + * // const { CloudDirectoryClient, ListObjectParentsCommand } = require("@aws-sdk/client-clouddirectory"); // CommonJS import + * const client = new CloudDirectoryClient(config); + * const command = new ListObjectParentsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListObjectParentsCommandInput} for command's `input` shape. + * @see {@link ListObjectParentsCommandOutput} for command's `response` shape. + * @see {@link CloudDirectoryClientResolvedConfig | config} for command's `input` shape. + * */ export class ListObjectParentsCommand extends $Command< ListObjectParentsCommandInput, diff --git a/clients/client-clouddirectory/commands/ListObjectPoliciesCommand.ts b/clients/client-clouddirectory/commands/ListObjectPoliciesCommand.ts index b8571d49ea6b..dfd4dc67c0bb 100644 --- a/clients/client-clouddirectory/commands/ListObjectPoliciesCommand.ts +++ b/clients/client-clouddirectory/commands/ListObjectPoliciesCommand.ts @@ -22,6 +22,20 @@ export interface ListObjectPoliciesCommandOutput extends ListObjectPoliciesRespo /** *

Returns policies attached to an object in pagination fashion.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { CloudDirectoryClient, ListObjectPoliciesCommand } from "@aws-sdk/client-clouddirectory"; // ES Modules import + * // const { CloudDirectoryClient, ListObjectPoliciesCommand } = require("@aws-sdk/client-clouddirectory"); // CommonJS import + * const client = new CloudDirectoryClient(config); + * const command = new ListObjectPoliciesCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListObjectPoliciesCommandInput} for command's `input` shape. + * @see {@link ListObjectPoliciesCommandOutput} for command's `response` shape. + * @see {@link CloudDirectoryClientResolvedConfig | config} for command's `input` shape. + * */ export class ListObjectPoliciesCommand extends $Command< ListObjectPoliciesCommandInput, diff --git a/clients/client-clouddirectory/commands/ListOutgoingTypedLinksCommand.ts b/clients/client-clouddirectory/commands/ListOutgoingTypedLinksCommand.ts index 7bd28cdc5d61..f5ee9cb4fc92 100644 --- a/clients/client-clouddirectory/commands/ListOutgoingTypedLinksCommand.ts +++ b/clients/client-clouddirectory/commands/ListOutgoingTypedLinksCommand.ts @@ -24,6 +24,20 @@ export interface ListOutgoingTypedLinksCommandOutput extends ListOutgoingTypedLi *

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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { CloudDirectoryClient, ListOutgoingTypedLinksCommand } from "@aws-sdk/client-clouddirectory"; // ES Modules import + * // const { CloudDirectoryClient, ListOutgoingTypedLinksCommand } = require("@aws-sdk/client-clouddirectory"); // CommonJS import + * const client = new CloudDirectoryClient(config); + * const command = new ListOutgoingTypedLinksCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListOutgoingTypedLinksCommandInput} for command's `input` shape. + * @see {@link ListOutgoingTypedLinksCommandOutput} for command's `response` shape. + * @see {@link CloudDirectoryClientResolvedConfig | config} for command's `input` shape. + * */ export class ListOutgoingTypedLinksCommand extends $Command< ListOutgoingTypedLinksCommandInput, diff --git a/clients/client-clouddirectory/commands/ListPolicyAttachmentsCommand.ts b/clients/client-clouddirectory/commands/ListPolicyAttachmentsCommand.ts index 41fffb4174c9..cf497517e38d 100644 --- a/clients/client-clouddirectory/commands/ListPolicyAttachmentsCommand.ts +++ b/clients/client-clouddirectory/commands/ListPolicyAttachmentsCommand.ts @@ -22,6 +22,20 @@ export interface ListPolicyAttachmentsCommandOutput extends ListPolicyAttachment /** *

Returns all of the ObjectIdentifiers to which a given policy is attached.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { CloudDirectoryClient, ListPolicyAttachmentsCommand } from "@aws-sdk/client-clouddirectory"; // ES Modules import + * // const { CloudDirectoryClient, ListPolicyAttachmentsCommand } = require("@aws-sdk/client-clouddirectory"); // CommonJS import + * const client = new CloudDirectoryClient(config); + * const command = new ListPolicyAttachmentsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListPolicyAttachmentsCommandInput} for command's `input` shape. + * @see {@link ListPolicyAttachmentsCommandOutput} for command's `response` shape. + * @see {@link CloudDirectoryClientResolvedConfig | config} for command's `input` shape. + * */ export class ListPolicyAttachmentsCommand extends $Command< ListPolicyAttachmentsCommandInput, diff --git a/clients/client-clouddirectory/commands/ListPublishedSchemaArnsCommand.ts b/clients/client-clouddirectory/commands/ListPublishedSchemaArnsCommand.ts index 564a4f4c0155..ba38ea2d17bc 100644 --- a/clients/client-clouddirectory/commands/ListPublishedSchemaArnsCommand.ts +++ b/clients/client-clouddirectory/commands/ListPublishedSchemaArnsCommand.ts @@ -22,6 +22,20 @@ export interface ListPublishedSchemaArnsCommandOutput extends ListPublishedSchem /** *

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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { CloudDirectoryClient, ListPublishedSchemaArnsCommand } from "@aws-sdk/client-clouddirectory"; // ES Modules import + * // const { CloudDirectoryClient, ListPublishedSchemaArnsCommand } = require("@aws-sdk/client-clouddirectory"); // CommonJS import + * const client = new CloudDirectoryClient(config); + * const command = new ListPublishedSchemaArnsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListPublishedSchemaArnsCommandInput} for command's `input` shape. + * @see {@link ListPublishedSchemaArnsCommandOutput} for command's `response` shape. + * @see {@link CloudDirectoryClientResolvedConfig | config} for command's `input` shape. + * */ export class ListPublishedSchemaArnsCommand extends $Command< ListPublishedSchemaArnsCommandInput, diff --git a/clients/client-clouddirectory/commands/ListTagsForResourceCommand.ts b/clients/client-clouddirectory/commands/ListTagsForResourceCommand.ts index 5fc11182024c..e7e2b5d13c80 100644 --- a/clients/client-clouddirectory/commands/ListTagsForResourceCommand.ts +++ b/clients/client-clouddirectory/commands/ListTagsForResourceCommand.ts @@ -24,6 +24,20 @@ export interface ListTagsForResourceCommandOutput extends ListTagsForResourceRes *

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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { CloudDirectoryClient, ListTagsForResourceCommand } from "@aws-sdk/client-clouddirectory"; // ES Modules import + * // const { CloudDirectoryClient, ListTagsForResourceCommand } = require("@aws-sdk/client-clouddirectory"); // CommonJS import + * const client = new CloudDirectoryClient(config); + * const command = new ListTagsForResourceCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListTagsForResourceCommandInput} for command's `input` shape. + * @see {@link ListTagsForResourceCommandOutput} for command's `response` shape. + * @see {@link CloudDirectoryClientResolvedConfig | config} for command's `input` shape. + * */ export class ListTagsForResourceCommand extends $Command< ListTagsForResourceCommandInput, diff --git a/clients/client-clouddirectory/commands/ListTypedLinkFacetAttributesCommand.ts b/clients/client-clouddirectory/commands/ListTypedLinkFacetAttributesCommand.ts index 11d56da8b283..6bc581abb6f1 100644 --- a/clients/client-clouddirectory/commands/ListTypedLinkFacetAttributesCommand.ts +++ b/clients/client-clouddirectory/commands/ListTypedLinkFacetAttributesCommand.ts @@ -24,6 +24,20 @@ export interface ListTypedLinkFacetAttributesCommandOutput /** *

Returns a paginated list of all attribute definitions for a particular TypedLinkFacet. For more information, see Typed Links.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { CloudDirectoryClient, ListTypedLinkFacetAttributesCommand } from "@aws-sdk/client-clouddirectory"; // ES Modules import + * // const { CloudDirectoryClient, ListTypedLinkFacetAttributesCommand } = require("@aws-sdk/client-clouddirectory"); // CommonJS import + * const client = new CloudDirectoryClient(config); + * const command = new ListTypedLinkFacetAttributesCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListTypedLinkFacetAttributesCommandInput} for command's `input` shape. + * @see {@link ListTypedLinkFacetAttributesCommandOutput} for command's `response` shape. + * @see {@link CloudDirectoryClientResolvedConfig | config} for command's `input` shape. + * */ export class ListTypedLinkFacetAttributesCommand extends $Command< ListTypedLinkFacetAttributesCommandInput, diff --git a/clients/client-clouddirectory/commands/ListTypedLinkFacetNamesCommand.ts b/clients/client-clouddirectory/commands/ListTypedLinkFacetNamesCommand.ts index f0e40b38c0f4..1804d08c001b 100644 --- a/clients/client-clouddirectory/commands/ListTypedLinkFacetNamesCommand.ts +++ b/clients/client-clouddirectory/commands/ListTypedLinkFacetNamesCommand.ts @@ -23,6 +23,20 @@ export interface ListTypedLinkFacetNamesCommandOutput extends ListTypedLinkFacet /** *

Returns a paginated list of TypedLink facet names for a particular schema. * For more information, see Typed Links.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { CloudDirectoryClient, ListTypedLinkFacetNamesCommand } from "@aws-sdk/client-clouddirectory"; // ES Modules import + * // const { CloudDirectoryClient, ListTypedLinkFacetNamesCommand } = require("@aws-sdk/client-clouddirectory"); // CommonJS import + * const client = new CloudDirectoryClient(config); + * const command = new ListTypedLinkFacetNamesCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListTypedLinkFacetNamesCommandInput} for command's `input` shape. + * @see {@link ListTypedLinkFacetNamesCommandOutput} for command's `response` shape. + * @see {@link CloudDirectoryClientResolvedConfig | config} for command's `input` shape. + * */ export class ListTypedLinkFacetNamesCommand extends $Command< ListTypedLinkFacetNamesCommandInput, diff --git a/clients/client-clouddirectory/commands/LookupPolicyCommand.ts b/clients/client-clouddirectory/commands/LookupPolicyCommand.ts index a681c42144ba..ca50d7c7f4be 100644 --- a/clients/client-clouddirectory/commands/LookupPolicyCommand.ts +++ b/clients/client-clouddirectory/commands/LookupPolicyCommand.ts @@ -27,6 +27,20 @@ export interface LookupPolicyCommandOutput extends LookupPolicyResponse, __Metad * 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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { CloudDirectoryClient, LookupPolicyCommand } from "@aws-sdk/client-clouddirectory"; // ES Modules import + * // const { CloudDirectoryClient, LookupPolicyCommand } = require("@aws-sdk/client-clouddirectory"); // CommonJS import + * const client = new CloudDirectoryClient(config); + * const command = new LookupPolicyCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link LookupPolicyCommandInput} for command's `input` shape. + * @see {@link LookupPolicyCommandOutput} for command's `response` shape. + * @see {@link CloudDirectoryClientResolvedConfig | config} for command's `input` shape. + * */ export class LookupPolicyCommand extends $Command< LookupPolicyCommandInput, diff --git a/clients/client-clouddirectory/commands/PublishSchemaCommand.ts b/clients/client-clouddirectory/commands/PublishSchemaCommand.ts index c2f871dab7c5..b3d8e99545f3 100644 --- a/clients/client-clouddirectory/commands/PublishSchemaCommand.ts +++ b/clients/client-clouddirectory/commands/PublishSchemaCommand.ts @@ -22,6 +22,20 @@ export interface PublishSchemaCommandOutput extends PublishSchemaResponse, __Met /** *

Publishes a development schema with a major version and a recommended minor version.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { CloudDirectoryClient, PublishSchemaCommand } from "@aws-sdk/client-clouddirectory"; // ES Modules import + * // const { CloudDirectoryClient, PublishSchemaCommand } = require("@aws-sdk/client-clouddirectory"); // CommonJS import + * const client = new CloudDirectoryClient(config); + * const command = new PublishSchemaCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link PublishSchemaCommandInput} for command's `input` shape. + * @see {@link PublishSchemaCommandOutput} for command's `response` shape. + * @see {@link CloudDirectoryClientResolvedConfig | config} for command's `input` shape. + * */ export class PublishSchemaCommand extends $Command< PublishSchemaCommandInput, diff --git a/clients/client-clouddirectory/commands/PutSchemaFromJsonCommand.ts b/clients/client-clouddirectory/commands/PutSchemaFromJsonCommand.ts index 3c6bc2c78f7c..6ce6e30cb9ee 100644 --- a/clients/client-clouddirectory/commands/PutSchemaFromJsonCommand.ts +++ b/clients/client-clouddirectory/commands/PutSchemaFromJsonCommand.ts @@ -22,6 +22,20 @@ export interface PutSchemaFromJsonCommandOutput extends PutSchemaFromJsonRespons /** *

Allows a schema to be updated using JSON upload. Only available for development schemas. See JSON Schema Format for more information.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { CloudDirectoryClient, PutSchemaFromJsonCommand } from "@aws-sdk/client-clouddirectory"; // ES Modules import + * // const { CloudDirectoryClient, PutSchemaFromJsonCommand } = require("@aws-sdk/client-clouddirectory"); // CommonJS import + * const client = new CloudDirectoryClient(config); + * const command = new PutSchemaFromJsonCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link PutSchemaFromJsonCommandInput} for command's `input` shape. + * @see {@link PutSchemaFromJsonCommandOutput} for command's `response` shape. + * @see {@link CloudDirectoryClientResolvedConfig | config} for command's `input` shape. + * */ export class PutSchemaFromJsonCommand extends $Command< PutSchemaFromJsonCommandInput, diff --git a/clients/client-clouddirectory/commands/RemoveFacetFromObjectCommand.ts b/clients/client-clouddirectory/commands/RemoveFacetFromObjectCommand.ts index 36d3fa831c11..3c136fba7415 100644 --- a/clients/client-clouddirectory/commands/RemoveFacetFromObjectCommand.ts +++ b/clients/client-clouddirectory/commands/RemoveFacetFromObjectCommand.ts @@ -22,6 +22,20 @@ export interface RemoveFacetFromObjectCommandOutput extends RemoveFacetFromObjec /** *

Removes the specified facet from the specified object.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { CloudDirectoryClient, RemoveFacetFromObjectCommand } from "@aws-sdk/client-clouddirectory"; // ES Modules import + * // const { CloudDirectoryClient, RemoveFacetFromObjectCommand } = require("@aws-sdk/client-clouddirectory"); // CommonJS import + * const client = new CloudDirectoryClient(config); + * const command = new RemoveFacetFromObjectCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link RemoveFacetFromObjectCommandInput} for command's `input` shape. + * @see {@link RemoveFacetFromObjectCommandOutput} for command's `response` shape. + * @see {@link CloudDirectoryClientResolvedConfig | config} for command's `input` shape. + * */ export class RemoveFacetFromObjectCommand extends $Command< RemoveFacetFromObjectCommandInput, diff --git a/clients/client-clouddirectory/commands/TagResourceCommand.ts b/clients/client-clouddirectory/commands/TagResourceCommand.ts index 72dfb5dc1693..07888693bdab 100644 --- a/clients/client-clouddirectory/commands/TagResourceCommand.ts +++ b/clients/client-clouddirectory/commands/TagResourceCommand.ts @@ -22,6 +22,20 @@ export interface TagResourceCommandOutput extends TagResourceResponse, __Metadat /** *

An API operation for adding tags to a resource.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { CloudDirectoryClient, TagResourceCommand } from "@aws-sdk/client-clouddirectory"; // ES Modules import + * // const { CloudDirectoryClient, TagResourceCommand } = require("@aws-sdk/client-clouddirectory"); // CommonJS import + * const client = new CloudDirectoryClient(config); + * const command = new TagResourceCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link TagResourceCommandInput} for command's `input` shape. + * @see {@link TagResourceCommandOutput} for command's `response` shape. + * @see {@link CloudDirectoryClientResolvedConfig | config} for command's `input` shape. + * */ export class TagResourceCommand extends $Command< TagResourceCommandInput, diff --git a/clients/client-clouddirectory/commands/UntagResourceCommand.ts b/clients/client-clouddirectory/commands/UntagResourceCommand.ts index 82e6eec72ece..eb0b9e362b92 100644 --- a/clients/client-clouddirectory/commands/UntagResourceCommand.ts +++ b/clients/client-clouddirectory/commands/UntagResourceCommand.ts @@ -22,6 +22,20 @@ export interface UntagResourceCommandOutput extends UntagResourceResponse, __Met /** *

An API operation for removing tags from a resource.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { CloudDirectoryClient, UntagResourceCommand } from "@aws-sdk/client-clouddirectory"; // ES Modules import + * // const { CloudDirectoryClient, UntagResourceCommand } = require("@aws-sdk/client-clouddirectory"); // CommonJS import + * const client = new CloudDirectoryClient(config); + * const command = new UntagResourceCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link UntagResourceCommandInput} for command's `input` shape. + * @see {@link UntagResourceCommandOutput} for command's `response` shape. + * @see {@link CloudDirectoryClientResolvedConfig | config} for command's `input` shape. + * */ export class UntagResourceCommand extends $Command< UntagResourceCommandInput, diff --git a/clients/client-clouddirectory/commands/UpdateFacetCommand.ts b/clients/client-clouddirectory/commands/UpdateFacetCommand.ts index 4461ee586acf..d204c171a77f 100644 --- a/clients/client-clouddirectory/commands/UpdateFacetCommand.ts +++ b/clients/client-clouddirectory/commands/UpdateFacetCommand.ts @@ -33,6 +33,20 @@ export interface UpdateFacetCommandOutput extends UpdateFacetResponse, __Metadat *

Deletes existing Attributes, Rules, or ObjectTypes.

* * + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { CloudDirectoryClient, UpdateFacetCommand } from "@aws-sdk/client-clouddirectory"; // ES Modules import + * // const { CloudDirectoryClient, UpdateFacetCommand } = require("@aws-sdk/client-clouddirectory"); // CommonJS import + * const client = new CloudDirectoryClient(config); + * const command = new UpdateFacetCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link UpdateFacetCommandInput} for command's `input` shape. + * @see {@link UpdateFacetCommandOutput} for command's `response` shape. + * @see {@link CloudDirectoryClientResolvedConfig | config} for command's `input` shape. + * */ export class UpdateFacetCommand extends $Command< UpdateFacetCommandInput, diff --git a/clients/client-clouddirectory/commands/UpdateLinkAttributesCommand.ts b/clients/client-clouddirectory/commands/UpdateLinkAttributesCommand.ts index efaf8b8fd0fc..5545df28c96b 100644 --- a/clients/client-clouddirectory/commands/UpdateLinkAttributesCommand.ts +++ b/clients/client-clouddirectory/commands/UpdateLinkAttributesCommand.ts @@ -22,6 +22,20 @@ export interface UpdateLinkAttributesCommandOutput extends UpdateLinkAttributesR /** *

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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { CloudDirectoryClient, UpdateLinkAttributesCommand } from "@aws-sdk/client-clouddirectory"; // ES Modules import + * // const { CloudDirectoryClient, UpdateLinkAttributesCommand } = require("@aws-sdk/client-clouddirectory"); // CommonJS import + * const client = new CloudDirectoryClient(config); + * const command = new UpdateLinkAttributesCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link UpdateLinkAttributesCommandInput} for command's `input` shape. + * @see {@link UpdateLinkAttributesCommandOutput} for command's `response` shape. + * @see {@link CloudDirectoryClientResolvedConfig | config} for command's `input` shape. + * */ export class UpdateLinkAttributesCommand extends $Command< UpdateLinkAttributesCommandInput, diff --git a/clients/client-clouddirectory/commands/UpdateObjectAttributesCommand.ts b/clients/client-clouddirectory/commands/UpdateObjectAttributesCommand.ts index f3f3c8f8369f..304c75af8443 100644 --- a/clients/client-clouddirectory/commands/UpdateObjectAttributesCommand.ts +++ b/clients/client-clouddirectory/commands/UpdateObjectAttributesCommand.ts @@ -22,6 +22,20 @@ export interface UpdateObjectAttributesCommandOutput extends UpdateObjectAttribu /** *

Updates a given object's attributes.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { CloudDirectoryClient, UpdateObjectAttributesCommand } from "@aws-sdk/client-clouddirectory"; // ES Modules import + * // const { CloudDirectoryClient, UpdateObjectAttributesCommand } = require("@aws-sdk/client-clouddirectory"); // CommonJS import + * const client = new CloudDirectoryClient(config); + * const command = new UpdateObjectAttributesCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link UpdateObjectAttributesCommandInput} for command's `input` shape. + * @see {@link UpdateObjectAttributesCommandOutput} for command's `response` shape. + * @see {@link CloudDirectoryClientResolvedConfig | config} for command's `input` shape. + * */ export class UpdateObjectAttributesCommand extends $Command< UpdateObjectAttributesCommandInput, diff --git a/clients/client-clouddirectory/commands/UpdateSchemaCommand.ts b/clients/client-clouddirectory/commands/UpdateSchemaCommand.ts index 476fe36a74ce..9da87a6024d5 100644 --- a/clients/client-clouddirectory/commands/UpdateSchemaCommand.ts +++ b/clients/client-clouddirectory/commands/UpdateSchemaCommand.ts @@ -23,6 +23,20 @@ export interface UpdateSchemaCommandOutput extends UpdateSchemaResponse, __Metad /** *

Updates the schema name with a new name. Only development schema names can be * updated.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { CloudDirectoryClient, UpdateSchemaCommand } from "@aws-sdk/client-clouddirectory"; // ES Modules import + * // const { CloudDirectoryClient, UpdateSchemaCommand } = require("@aws-sdk/client-clouddirectory"); // CommonJS import + * const client = new CloudDirectoryClient(config); + * const command = new UpdateSchemaCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link UpdateSchemaCommandInput} for command's `input` shape. + * @see {@link UpdateSchemaCommandOutput} for command's `response` shape. + * @see {@link CloudDirectoryClientResolvedConfig | config} for command's `input` shape. + * */ export class UpdateSchemaCommand extends $Command< UpdateSchemaCommandInput, diff --git a/clients/client-clouddirectory/commands/UpdateTypedLinkFacetCommand.ts b/clients/client-clouddirectory/commands/UpdateTypedLinkFacetCommand.ts index 9ee0262c71a1..01c639170857 100644 --- a/clients/client-clouddirectory/commands/UpdateTypedLinkFacetCommand.ts +++ b/clients/client-clouddirectory/commands/UpdateTypedLinkFacetCommand.ts @@ -22,6 +22,20 @@ export interface UpdateTypedLinkFacetCommandOutput extends UpdateTypedLinkFacetR /** *

Updates a TypedLinkFacet. For more information, see Typed Links.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { CloudDirectoryClient, UpdateTypedLinkFacetCommand } from "@aws-sdk/client-clouddirectory"; // ES Modules import + * // const { CloudDirectoryClient, UpdateTypedLinkFacetCommand } = require("@aws-sdk/client-clouddirectory"); // CommonJS import + * const client = new CloudDirectoryClient(config); + * const command = new UpdateTypedLinkFacetCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link UpdateTypedLinkFacetCommandInput} for command's `input` shape. + * @see {@link UpdateTypedLinkFacetCommandOutput} for command's `response` shape. + * @see {@link CloudDirectoryClientResolvedConfig | config} for command's `input` shape. + * */ export class UpdateTypedLinkFacetCommand extends $Command< UpdateTypedLinkFacetCommandInput, diff --git a/clients/client-clouddirectory/commands/UpgradeAppliedSchemaCommand.ts b/clients/client-clouddirectory/commands/UpgradeAppliedSchemaCommand.ts index 84450bbd68cf..79a99d11d94f 100644 --- a/clients/client-clouddirectory/commands/UpgradeAppliedSchemaCommand.ts +++ b/clients/client-clouddirectory/commands/UpgradeAppliedSchemaCommand.ts @@ -22,6 +22,20 @@ export interface UpgradeAppliedSchemaCommandOutput extends UpgradeAppliedSchemaR /** *

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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { CloudDirectoryClient, UpgradeAppliedSchemaCommand } from "@aws-sdk/client-clouddirectory"; // ES Modules import + * // const { CloudDirectoryClient, UpgradeAppliedSchemaCommand } = require("@aws-sdk/client-clouddirectory"); // CommonJS import + * const client = new CloudDirectoryClient(config); + * const command = new UpgradeAppliedSchemaCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link UpgradeAppliedSchemaCommandInput} for command's `input` shape. + * @see {@link UpgradeAppliedSchemaCommandOutput} for command's `response` shape. + * @see {@link CloudDirectoryClientResolvedConfig | config} for command's `input` shape. + * */ export class UpgradeAppliedSchemaCommand extends $Command< UpgradeAppliedSchemaCommandInput, diff --git a/clients/client-clouddirectory/commands/UpgradePublishedSchemaCommand.ts b/clients/client-clouddirectory/commands/UpgradePublishedSchemaCommand.ts index 80a146eebe15..9b8e51fd3b42 100644 --- a/clients/client-clouddirectory/commands/UpgradePublishedSchemaCommand.ts +++ b/clients/client-clouddirectory/commands/UpgradePublishedSchemaCommand.ts @@ -22,6 +22,20 @@ export interface UpgradePublishedSchemaCommandOutput extends UpgradePublishedSch /** *

Upgrades a published schema under a new minor version revision using the current contents of DevelopmentSchemaArn.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { CloudDirectoryClient, UpgradePublishedSchemaCommand } from "@aws-sdk/client-clouddirectory"; // ES Modules import + * // const { CloudDirectoryClient, UpgradePublishedSchemaCommand } = require("@aws-sdk/client-clouddirectory"); // CommonJS import + * const client = new CloudDirectoryClient(config); + * const command = new UpgradePublishedSchemaCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link UpgradePublishedSchemaCommandInput} for command's `input` shape. + * @see {@link UpgradePublishedSchemaCommandOutput} for command's `response` shape. + * @see {@link CloudDirectoryClientResolvedConfig | config} for command's `input` shape. + * */ export class UpgradePublishedSchemaCommand extends $Command< UpgradePublishedSchemaCommandInput, diff --git a/clients/client-clouddirectory/models/models_0.ts b/clients/client-clouddirectory/models/models_0.ts index baac0afe518a..d6718eba4e02 100644 --- a/clients/client-clouddirectory/models/models_0.ts +++ b/clients/client-clouddirectory/models/models_0.ts @@ -11,6 +11,9 @@ export interface AccessDeniedException extends __SmithyException, $MetadataBeare } export namespace AccessDeniedException { + /** + * @internal + */ export const filterSensitiveLog = (obj: AccessDeniedException): any => ({ ...obj, }); @@ -38,6 +41,9 @@ export interface AttributeKey { } export namespace AttributeKey { + /** + * @internal + */ export const filterSensitiveLog = (obj: AttributeKey): any => ({ ...obj, }); @@ -144,6 +150,9 @@ export namespace TypedAttributeValue { return visitor._(value.$unknown[0], value.$unknown[1]); }; + /** + * @internal + */ export const filterSensitiveLog = (obj: TypedAttributeValue): any => { if (obj.StringValue !== undefined) return { StringValue: obj.StringValue }; if (obj.BinaryValue !== undefined) return { BinaryValue: obj.BinaryValue }; @@ -170,6 +179,9 @@ export interface AttributeKeyAndValue { } export namespace AttributeKeyAndValue { + /** + * @internal + */ export const filterSensitiveLog = (obj: AttributeKeyAndValue): any => ({ ...obj, ...(obj.Value && { Value: TypedAttributeValue.filterSensitiveLog(obj.Value) }), @@ -201,6 +213,9 @@ export interface ObjectReference { } export namespace ObjectReference { + /** + * @internal + */ export const filterSensitiveLog = (obj: ObjectReference): any => ({ ...obj, }); @@ -222,6 +237,9 @@ export interface SchemaFacet { } export namespace SchemaFacet { + /** + * @internal + */ export const filterSensitiveLog = (obj: SchemaFacet): any => ({ ...obj, }); @@ -251,6 +269,9 @@ export interface AddFacetToObjectRequest { } export namespace AddFacetToObjectRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: AddFacetToObjectRequest): any => ({ ...obj, ...(obj.ObjectAttributeList && { @@ -262,6 +283,9 @@ export namespace AddFacetToObjectRequest { export interface AddFacetToObjectResponse {} export namespace AddFacetToObjectResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: AddFacetToObjectResponse): any => ({ ...obj, }); @@ -277,6 +301,9 @@ export interface DirectoryNotEnabledException extends __SmithyException, $Metada } export namespace DirectoryNotEnabledException { + /** + * @internal + */ export const filterSensitiveLog = (obj: DirectoryNotEnabledException): any => ({ ...obj, }); @@ -293,6 +320,9 @@ export interface FacetValidationException extends __SmithyException, $MetadataBe } export namespace FacetValidationException { + /** + * @internal + */ export const filterSensitiveLog = (obj: FacetValidationException): any => ({ ...obj, }); @@ -308,6 +338,9 @@ export interface InternalServiceException extends __SmithyException, $MetadataBe } export namespace InternalServiceException { + /** + * @internal + */ export const filterSensitiveLog = (obj: InternalServiceException): any => ({ ...obj, }); @@ -323,6 +356,9 @@ export interface InvalidArnException extends __SmithyException, $MetadataBearer } export namespace InvalidArnException { + /** + * @internal + */ export const filterSensitiveLog = (obj: InvalidArnException): any => ({ ...obj, }); @@ -338,6 +374,9 @@ export interface LimitExceededException extends __SmithyException, $MetadataBear } export namespace LimitExceededException { + /** + * @internal + */ export const filterSensitiveLog = (obj: LimitExceededException): any => ({ ...obj, }); @@ -353,6 +392,9 @@ export interface ResourceNotFoundException extends __SmithyException, $MetadataB } export namespace ResourceNotFoundException { + /** + * @internal + */ export const filterSensitiveLog = (obj: ResourceNotFoundException): any => ({ ...obj, }); @@ -368,6 +410,9 @@ export interface RetryableConflictException extends __SmithyException, $Metadata } export namespace RetryableConflictException { + /** + * @internal + */ export const filterSensitiveLog = (obj: RetryableConflictException): any => ({ ...obj, }); @@ -384,6 +429,9 @@ export interface ValidationException extends __SmithyException, $MetadataBearer } export namespace ValidationException { + /** + * @internal + */ export const filterSensitiveLog = (obj: ValidationException): any => ({ ...obj, }); @@ -404,6 +452,9 @@ export interface ApplySchemaRequest { } export namespace ApplySchemaRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ApplySchemaRequest): any => ({ ...obj, }); @@ -424,6 +475,9 @@ export interface ApplySchemaResponse { } export namespace ApplySchemaResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ApplySchemaResponse): any => ({ ...obj, }); @@ -440,6 +494,9 @@ export interface InvalidAttachmentException extends __SmithyException, $Metadata } export namespace InvalidAttachmentException { + /** + * @internal + */ export const filterSensitiveLog = (obj: InvalidAttachmentException): any => ({ ...obj, }); @@ -456,6 +513,9 @@ export interface SchemaAlreadyExistsException extends __SmithyException, $Metada } export namespace SchemaAlreadyExistsException { + /** + * @internal + */ export const filterSensitiveLog = (obj: SchemaAlreadyExistsException): any => ({ ...obj, }); @@ -485,6 +545,9 @@ export interface AttachObjectRequest { } export namespace AttachObjectRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: AttachObjectRequest): any => ({ ...obj, }); @@ -499,6 +562,9 @@ export interface AttachObjectResponse { } export namespace AttachObjectResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: AttachObjectResponse): any => ({ ...obj, }); @@ -515,6 +581,9 @@ export interface LinkNameAlreadyInUseException extends __SmithyException, $Metad } export namespace LinkNameAlreadyInUseException { + /** + * @internal + */ export const filterSensitiveLog = (obj: LinkNameAlreadyInUseException): any => ({ ...obj, }); @@ -540,6 +609,9 @@ export interface AttachPolicyRequest { } export namespace AttachPolicyRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: AttachPolicyRequest): any => ({ ...obj, }); @@ -548,6 +620,9 @@ export namespace AttachPolicyRequest { export interface AttachPolicyResponse {} export namespace AttachPolicyResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: AttachPolicyResponse): any => ({ ...obj, }); @@ -563,6 +638,9 @@ export interface NotPolicyException extends __SmithyException, $MetadataBearer { } export namespace NotPolicyException { + /** + * @internal + */ export const filterSensitiveLog = (obj: NotPolicyException): any => ({ ...obj, }); @@ -587,6 +665,9 @@ export interface AttachToIndexRequest { } export namespace AttachToIndexRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: AttachToIndexRequest): any => ({ ...obj, }); @@ -600,6 +681,9 @@ export interface AttachToIndexResponse { } export namespace AttachToIndexResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: AttachToIndexResponse): any => ({ ...obj, }); @@ -615,6 +699,9 @@ export interface IndexedAttributeMissingException extends __SmithyException, $Me } export namespace IndexedAttributeMissingException { + /** + * @internal + */ export const filterSensitiveLog = (obj: IndexedAttributeMissingException): any => ({ ...obj, }); @@ -630,6 +717,9 @@ export interface NotIndexException extends __SmithyException, $MetadataBearer { } export namespace NotIndexException { + /** + * @internal + */ export const filterSensitiveLog = (obj: NotIndexException): any => ({ ...obj, }); @@ -651,6 +741,9 @@ export interface AttributeNameAndValue { } export namespace AttributeNameAndValue { + /** + * @internal + */ export const filterSensitiveLog = (obj: AttributeNameAndValue): any => ({ ...obj, ...(obj.Value && { Value: TypedAttributeValue.filterSensitiveLog(obj.Value) }), @@ -675,6 +768,9 @@ export interface TypedLinkSchemaAndFacetName { } export namespace TypedLinkSchemaAndFacetName { + /** + * @internal + */ export const filterSensitiveLog = (obj: TypedLinkSchemaAndFacetName): any => ({ ...obj, }); @@ -709,6 +805,9 @@ export interface AttachTypedLinkRequest { } export namespace AttachTypedLinkRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: AttachTypedLinkRequest): any => ({ ...obj, ...(obj.Attributes && { Attributes: obj.Attributes.map((item) => AttributeNameAndValue.filterSensitiveLog(item)) }), @@ -745,6 +844,9 @@ export interface TypedLinkSpecifier { } export namespace TypedLinkSpecifier { + /** + * @internal + */ export const filterSensitiveLog = (obj: TypedLinkSpecifier): any => ({ ...obj, ...(obj.IdentityAttributeValues && { @@ -763,6 +865,9 @@ export interface AttachTypedLinkResponse { } export namespace AttachTypedLinkResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: AttachTypedLinkResponse): any => ({ ...obj, ...(obj.TypedLinkSpecifier && { @@ -792,6 +897,9 @@ export interface BatchGetLinkAttributes { } export namespace BatchGetLinkAttributes { + /** + * @internal + */ export const filterSensitiveLog = (obj: BatchGetLinkAttributes): any => ({ ...obj, ...(obj.TypedLinkSpecifier && { @@ -821,6 +929,9 @@ export interface BatchGetObjectAttributes { } export namespace BatchGetObjectAttributes { + /** + * @internal + */ export const filterSensitiveLog = (obj: BatchGetObjectAttributes): any => ({ ...obj, }); @@ -837,6 +948,9 @@ export interface BatchGetObjectInformation { } export namespace BatchGetObjectInformation { + /** + * @internal + */ export const filterSensitiveLog = (obj: BatchGetObjectInformation): any => ({ ...obj, }); @@ -863,6 +977,9 @@ export interface BatchListAttachedIndices { } export namespace BatchListAttachedIndices { + /** + * @internal + */ export const filterSensitiveLog = (obj: BatchListAttachedIndices): any => ({ ...obj, }); @@ -902,6 +1019,9 @@ export interface TypedAttributeValueRange { } export namespace TypedAttributeValueRange { + /** + * @internal + */ export const filterSensitiveLog = (obj: TypedAttributeValueRange): any => ({ ...obj, ...(obj.StartValue && { StartValue: TypedAttributeValue.filterSensitiveLog(obj.StartValue) }), @@ -925,6 +1045,9 @@ export interface TypedLinkAttributeRange { } export namespace TypedLinkAttributeRange { + /** + * @internal + */ export const filterSensitiveLog = (obj: TypedLinkAttributeRange): any => ({ ...obj, ...(obj.Range && { Range: TypedAttributeValueRange.filterSensitiveLog(obj.Range) }), @@ -965,6 +1088,9 @@ export interface BatchListIncomingTypedLinks { } export namespace BatchListIncomingTypedLinks { + /** + * @internal + */ export const filterSensitiveLog = (obj: BatchListIncomingTypedLinks): any => ({ ...obj, ...(obj.FilterAttributeRanges && { @@ -989,6 +1115,9 @@ export interface ObjectAttributeRange { } export namespace ObjectAttributeRange { + /** + * @internal + */ export const filterSensitiveLog = (obj: ObjectAttributeRange): any => ({ ...obj, ...(obj.Range && { Range: TypedAttributeValueRange.filterSensitiveLog(obj.Range) }), @@ -1021,6 +1150,9 @@ export interface BatchListIndex { } export namespace BatchListIndex { + /** + * @internal + */ export const filterSensitiveLog = (obj: BatchListIndex): any => ({ ...obj, ...(obj.RangesOnIndexedValues && { @@ -1057,6 +1189,9 @@ export interface BatchListObjectAttributes { } export namespace BatchListObjectAttributes { + /** + * @internal + */ export const filterSensitiveLog = (obj: BatchListObjectAttributes): any => ({ ...obj, }); @@ -1084,6 +1219,9 @@ export interface BatchListObjectChildren { } export namespace BatchListObjectChildren { + /** + * @internal + */ export const filterSensitiveLog = (obj: BatchListObjectChildren): any => ({ ...obj, }); @@ -1110,6 +1248,9 @@ export interface BatchListObjectParentPaths { } export namespace BatchListObjectParentPaths { + /** + * @internal + */ export const filterSensitiveLog = (obj: BatchListObjectParentPaths): any => ({ ...obj, }); @@ -1126,6 +1267,9 @@ export interface BatchListObjectParents { } export namespace BatchListObjectParents { + /** + * @internal + */ export const filterSensitiveLog = (obj: BatchListObjectParents): any => ({ ...obj, }); @@ -1152,6 +1296,9 @@ export interface BatchListObjectPolicies { } export namespace BatchListObjectPolicies { + /** + * @internal + */ export const filterSensitiveLog = (obj: BatchListObjectPolicies): any => ({ ...obj, }); @@ -1191,6 +1338,9 @@ export interface BatchListOutgoingTypedLinks { } export namespace BatchListOutgoingTypedLinks { + /** + * @internal + */ export const filterSensitiveLog = (obj: BatchListOutgoingTypedLinks): any => ({ ...obj, ...(obj.FilterAttributeRanges && { @@ -1220,6 +1370,9 @@ export interface BatchListPolicyAttachments { } export namespace BatchListPolicyAttachments { + /** + * @internal + */ export const filterSensitiveLog = (obj: BatchListPolicyAttachments): any => ({ ...obj, }); @@ -1246,6 +1399,9 @@ export interface BatchLookupPolicy { } export namespace BatchLookupPolicy { + /** + * @internal + */ export const filterSensitiveLog = (obj: BatchLookupPolicy): any => ({ ...obj, }); @@ -1334,6 +1490,9 @@ export interface BatchReadOperation { } export namespace BatchReadOperation { + /** + * @internal + */ export const filterSensitiveLog = (obj: BatchReadOperation): any => ({ ...obj, ...(obj.ListIndex && { ListIndex: BatchListIndex.filterSensitiveLog(obj.ListIndex) }), @@ -1369,6 +1528,9 @@ export interface BatchReadRequest { } export namespace BatchReadRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: BatchReadRequest): any => ({ ...obj, }); @@ -1407,6 +1569,9 @@ export interface BatchReadException { } export namespace BatchReadException { + /** + * @internal + */ export const filterSensitiveLog = (obj: BatchReadException): any => ({ ...obj, }); @@ -1423,6 +1588,9 @@ export interface BatchGetLinkAttributesResponse { } export namespace BatchGetLinkAttributesResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: BatchGetLinkAttributesResponse): any => ({ ...obj, ...(obj.Attributes && { Attributes: obj.Attributes.map((item) => AttributeKeyAndValue.filterSensitiveLog(item)) }), @@ -1440,6 +1608,9 @@ export interface BatchGetObjectAttributesResponse { } export namespace BatchGetObjectAttributesResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: BatchGetObjectAttributesResponse): any => ({ ...obj, ...(obj.Attributes && { Attributes: obj.Attributes.map((item) => AttributeKeyAndValue.filterSensitiveLog(item)) }), @@ -1462,6 +1633,9 @@ export interface BatchGetObjectInformationResponse { } export namespace BatchGetObjectInformationResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: BatchGetObjectInformationResponse): any => ({ ...obj, }); @@ -1483,6 +1657,9 @@ export interface IndexAttachment { } export namespace IndexAttachment { + /** + * @internal + */ export const filterSensitiveLog = (obj: IndexAttachment): any => ({ ...obj, ...(obj.IndexedAttributes && { @@ -1507,6 +1684,9 @@ export interface BatchListAttachedIndicesResponse { } export namespace BatchListAttachedIndicesResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: BatchListAttachedIndicesResponse): any => ({ ...obj, }); @@ -1528,6 +1708,9 @@ export interface BatchListIncomingTypedLinksResponse { } export namespace BatchListIncomingTypedLinksResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: BatchListIncomingTypedLinksResponse): any => ({ ...obj, }); @@ -1549,6 +1732,9 @@ export interface BatchListIndexResponse { } export namespace BatchListIndexResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: BatchListIndexResponse): any => ({ ...obj, }); @@ -1571,6 +1757,9 @@ export interface BatchListObjectAttributesResponse { } export namespace BatchListObjectAttributesResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: BatchListObjectAttributesResponse): any => ({ ...obj, ...(obj.Attributes && { Attributes: obj.Attributes.map((item) => AttributeKeyAndValue.filterSensitiveLog(item)) }), @@ -1594,6 +1783,9 @@ export interface BatchListObjectChildrenResponse { } export namespace BatchListObjectChildrenResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: BatchListObjectChildrenResponse): any => ({ ...obj, }); @@ -1617,6 +1809,9 @@ export interface PathToObjectIdentifiers { } export namespace PathToObjectIdentifiers { + /** + * @internal + */ export const filterSensitiveLog = (obj: PathToObjectIdentifiers): any => ({ ...obj, }); @@ -1639,6 +1834,9 @@ export interface BatchListObjectParentPathsResponse { } export namespace BatchListObjectParentPathsResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: BatchListObjectParentPathsResponse): any => ({ ...obj, }); @@ -1660,6 +1858,9 @@ export interface ObjectIdentifierAndLinkNameTuple { } export namespace ObjectIdentifierAndLinkNameTuple { + /** + * @internal + */ export const filterSensitiveLog = (obj: ObjectIdentifierAndLinkNameTuple): any => ({ ...obj, }); @@ -1671,6 +1872,9 @@ export interface BatchListObjectParentsResponse { } export namespace BatchListObjectParentsResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: BatchListObjectParentsResponse): any => ({ ...obj, }); @@ -1693,6 +1897,9 @@ export interface BatchListObjectPoliciesResponse { } export namespace BatchListObjectPoliciesResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: BatchListObjectPoliciesResponse): any => ({ ...obj, }); @@ -1714,6 +1921,9 @@ export interface BatchListOutgoingTypedLinksResponse { } export namespace BatchListOutgoingTypedLinksResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: BatchListOutgoingTypedLinksResponse): any => ({ ...obj, }); @@ -1735,6 +1945,9 @@ export interface BatchListPolicyAttachmentsResponse { } export namespace BatchListPolicyAttachmentsResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: BatchListPolicyAttachmentsResponse): any => ({ ...obj, }); @@ -1764,6 +1977,9 @@ export interface PolicyAttachment { } export namespace PolicyAttachment { + /** + * @internal + */ export const filterSensitiveLog = (obj: PolicyAttachment): any => ({ ...obj, }); @@ -1787,6 +2003,9 @@ export interface PolicyToPath { } export namespace PolicyToPath { + /** + * @internal + */ export const filterSensitiveLog = (obj: PolicyToPath): any => ({ ...obj, }); @@ -1810,6 +2029,9 @@ export interface BatchLookupPolicyResponse { } export namespace BatchLookupPolicyResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: BatchLookupPolicyResponse): any => ({ ...obj, }); @@ -1899,6 +2121,9 @@ export interface BatchReadSuccessfulResponse { } export namespace BatchReadSuccessfulResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: BatchReadSuccessfulResponse): any => ({ ...obj, ...(obj.ListObjectAttributes && { @@ -1929,6 +2154,9 @@ export interface BatchReadOperationResponse { } export namespace BatchReadOperationResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: BatchReadOperationResponse): any => ({ ...obj, ...(obj.SuccessfulResponse && { @@ -1945,6 +2173,9 @@ export interface BatchReadResponse { } export namespace BatchReadResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: BatchReadResponse): any => ({ ...obj, }); @@ -1983,6 +2214,9 @@ export interface BatchWriteException extends __SmithyException, $MetadataBearer } export namespace BatchWriteException { + /** + * @internal + */ export const filterSensitiveLog = (obj: BatchWriteException): any => ({ ...obj, }); @@ -2009,6 +2243,9 @@ export interface BatchAddFacetToObject { } export namespace BatchAddFacetToObject { + /** + * @internal + */ export const filterSensitiveLog = (obj: BatchAddFacetToObject): any => ({ ...obj, ...(obj.ObjectAttributeList && { @@ -2038,6 +2275,9 @@ export interface BatchAttachObject { } export namespace BatchAttachObject { + /** + * @internal + */ export const filterSensitiveLog = (obj: BatchAttachObject): any => ({ ...obj, }); @@ -2060,6 +2300,9 @@ export interface BatchAttachPolicy { } export namespace BatchAttachPolicy { + /** + * @internal + */ export const filterSensitiveLog = (obj: BatchAttachPolicy): any => ({ ...obj, }); @@ -2081,6 +2324,9 @@ export interface BatchAttachToIndex { } export namespace BatchAttachToIndex { + /** + * @internal + */ export const filterSensitiveLog = (obj: BatchAttachToIndex): any => ({ ...obj, }); @@ -2112,6 +2358,9 @@ export interface BatchAttachTypedLink { } export namespace BatchAttachTypedLink { + /** + * @internal + */ export const filterSensitiveLog = (obj: BatchAttachTypedLink): any => ({ ...obj, ...(obj.Attributes && { Attributes: obj.Attributes.map((item) => AttributeNameAndValue.filterSensitiveLog(item)) }), @@ -2151,6 +2400,9 @@ export interface BatchCreateIndex { } export namespace BatchCreateIndex { + /** + * @internal + */ export const filterSensitiveLog = (obj: BatchCreateIndex): any => ({ ...obj, }); @@ -2189,6 +2441,9 @@ export interface BatchCreateObject { } export namespace BatchCreateObject { + /** + * @internal + */ export const filterSensitiveLog = (obj: BatchCreateObject): any => ({ ...obj, ...(obj.ObjectAttributeList && { @@ -2208,6 +2463,9 @@ export interface BatchDeleteObject { } export namespace BatchDeleteObject { + /** + * @internal + */ export const filterSensitiveLog = (obj: BatchDeleteObject): any => ({ ...obj, }); @@ -2229,6 +2487,9 @@ export interface BatchDetachFromIndex { } export namespace BatchDetachFromIndex { + /** + * @internal + */ export const filterSensitiveLog = (obj: BatchDetachFromIndex): any => ({ ...obj, }); @@ -2256,6 +2517,9 @@ export interface BatchDetachObject { } export namespace BatchDetachObject { + /** + * @internal + */ export const filterSensitiveLog = (obj: BatchDetachObject): any => ({ ...obj, }); @@ -2277,6 +2541,9 @@ export interface BatchDetachPolicy { } export namespace BatchDetachPolicy { + /** + * @internal + */ export const filterSensitiveLog = (obj: BatchDetachPolicy): any => ({ ...obj, }); @@ -2293,6 +2560,9 @@ export interface BatchDetachTypedLink { } export namespace BatchDetachTypedLink { + /** + * @internal + */ export const filterSensitiveLog = (obj: BatchDetachTypedLink): any => ({ ...obj, ...(obj.TypedLinkSpecifier && { @@ -2317,6 +2587,9 @@ export interface BatchRemoveFacetFromObject { } export namespace BatchRemoveFacetFromObject { + /** + * @internal + */ export const filterSensitiveLog = (obj: BatchRemoveFacetFromObject): any => ({ ...obj, }); @@ -2343,6 +2616,9 @@ export interface LinkAttributeAction { } export namespace LinkAttributeAction { + /** + * @internal + */ export const filterSensitiveLog = (obj: LinkAttributeAction): any => ({ ...obj, ...(obj.AttributeUpdateValue && { @@ -2367,6 +2643,9 @@ export interface LinkAttributeUpdate { } export namespace LinkAttributeUpdate { + /** + * @internal + */ export const filterSensitiveLog = (obj: LinkAttributeUpdate): any => ({ ...obj, ...(obj.AttributeAction && { AttributeAction: LinkAttributeAction.filterSensitiveLog(obj.AttributeAction) }), @@ -2389,6 +2668,9 @@ export interface BatchUpdateLinkAttributes { } export namespace BatchUpdateLinkAttributes { + /** + * @internal + */ export const filterSensitiveLog = (obj: BatchUpdateLinkAttributes): any => ({ ...obj, ...(obj.TypedLinkSpecifier && { @@ -2416,6 +2698,9 @@ export interface ObjectAttributeAction { } export namespace ObjectAttributeAction { + /** + * @internal + */ export const filterSensitiveLog = (obj: ObjectAttributeAction): any => ({ ...obj, ...(obj.ObjectAttributeUpdateValue && { @@ -2440,6 +2725,9 @@ export interface ObjectAttributeUpdate { } export namespace ObjectAttributeUpdate { + /** + * @internal + */ export const filterSensitiveLog = (obj: ObjectAttributeUpdate): any => ({ ...obj, ...(obj.ObjectAttributeAction && { @@ -2464,6 +2752,9 @@ export interface BatchUpdateObjectAttributes { } export namespace BatchUpdateObjectAttributes { + /** + * @internal + */ export const filterSensitiveLog = (obj: BatchUpdateObjectAttributes): any => ({ ...obj, ...(obj.AttributeUpdates && { @@ -2554,6 +2845,9 @@ export interface BatchWriteOperation { } export namespace BatchWriteOperation { + /** + * @internal + */ export const filterSensitiveLog = (obj: BatchWriteOperation): any => ({ ...obj, ...(obj.UpdateObjectAttributes && { @@ -2582,6 +2876,9 @@ export interface BatchWriteRequest { } export namespace BatchWriteRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: BatchWriteRequest): any => ({ ...obj, }); @@ -2593,6 +2890,9 @@ export namespace BatchWriteRequest { export interface BatchAddFacetToObjectResponse {} export namespace BatchAddFacetToObjectResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: BatchAddFacetToObjectResponse): any => ({ ...obj, }); @@ -2609,6 +2909,9 @@ export interface BatchAttachObjectResponse { } export namespace BatchAttachObjectResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: BatchAttachObjectResponse): any => ({ ...obj, }); @@ -2621,6 +2924,9 @@ export namespace BatchAttachObjectResponse { export interface BatchAttachPolicyResponse {} export namespace BatchAttachPolicyResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: BatchAttachPolicyResponse): any => ({ ...obj, }); @@ -2637,6 +2943,9 @@ export interface BatchAttachToIndexResponse { } export namespace BatchAttachToIndexResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: BatchAttachToIndexResponse): any => ({ ...obj, }); @@ -2653,6 +2962,9 @@ export interface BatchAttachTypedLinkResponse { } export namespace BatchAttachTypedLinkResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: BatchAttachTypedLinkResponse): any => ({ ...obj, ...(obj.TypedLinkSpecifier && { @@ -2672,6 +2984,9 @@ export interface BatchCreateIndexResponse { } export namespace BatchCreateIndexResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: BatchCreateIndexResponse): any => ({ ...obj, }); @@ -2688,6 +3003,9 @@ export interface BatchCreateObjectResponse { } export namespace BatchCreateObjectResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: BatchCreateObjectResponse): any => ({ ...obj, }); @@ -2699,6 +3017,9 @@ export namespace BatchCreateObjectResponse { export interface BatchDeleteObjectResponse {} export namespace BatchDeleteObjectResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: BatchDeleteObjectResponse): any => ({ ...obj, }); @@ -2715,6 +3036,9 @@ export interface BatchDetachFromIndexResponse { } export namespace BatchDetachFromIndexResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: BatchDetachFromIndexResponse): any => ({ ...obj, }); @@ -2731,6 +3055,9 @@ export interface BatchDetachObjectResponse { } export namespace BatchDetachObjectResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: BatchDetachObjectResponse): any => ({ ...obj, }); @@ -2742,6 +3069,9 @@ export namespace BatchDetachObjectResponse { export interface BatchDetachPolicyResponse {} export namespace BatchDetachPolicyResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: BatchDetachPolicyResponse): any => ({ ...obj, }); @@ -2753,6 +3083,9 @@ export namespace BatchDetachPolicyResponse { export interface BatchDetachTypedLinkResponse {} export namespace BatchDetachTypedLinkResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: BatchDetachTypedLinkResponse): any => ({ ...obj, }); @@ -2764,6 +3097,9 @@ export namespace BatchDetachTypedLinkResponse { export interface BatchRemoveFacetFromObjectResponse {} export namespace BatchRemoveFacetFromObjectResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: BatchRemoveFacetFromObjectResponse): any => ({ ...obj, }); @@ -2775,6 +3111,9 @@ export namespace BatchRemoveFacetFromObjectResponse { export interface BatchUpdateLinkAttributesResponse {} export namespace BatchUpdateLinkAttributesResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: BatchUpdateLinkAttributesResponse): any => ({ ...obj, }); @@ -2791,6 +3130,9 @@ export interface BatchUpdateObjectAttributesResponse { } export namespace BatchUpdateObjectAttributesResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: BatchUpdateObjectAttributesResponse): any => ({ ...obj, }); @@ -2878,6 +3220,9 @@ export interface BatchWriteOperationResponse { } export namespace BatchWriteOperationResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: BatchWriteOperationResponse): any => ({ ...obj, ...(obj.AttachTypedLink && { @@ -2894,6 +3239,9 @@ export interface BatchWriteResponse { } export namespace BatchWriteResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: BatchWriteResponse): any => ({ ...obj, }); @@ -2914,6 +3262,9 @@ export interface CreateDirectoryRequest { } export namespace CreateDirectoryRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateDirectoryRequest): any => ({ ...obj, }); @@ -2945,6 +3296,9 @@ export interface CreateDirectoryResponse { } export namespace CreateDirectoryResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateDirectoryResponse): any => ({ ...obj, }); @@ -2961,6 +3315,9 @@ export interface DirectoryAlreadyExistsException extends __SmithyException, $Met } export namespace DirectoryAlreadyExistsException { + /** + * @internal + */ export const filterSensitiveLog = (obj: DirectoryAlreadyExistsException): any => ({ ...obj, }); @@ -2990,6 +3347,9 @@ export interface Rule { } export namespace Rule { + /** + * @internal + */ export const filterSensitiveLog = (obj: Rule): any => ({ ...obj, }); @@ -3030,6 +3390,9 @@ export interface FacetAttributeDefinition { } export namespace FacetAttributeDefinition { + /** + * @internal + */ export const filterSensitiveLog = (obj: FacetAttributeDefinition): any => ({ ...obj, ...(obj.DefaultValue && { DefaultValue: TypedAttributeValue.filterSensitiveLog(obj.DefaultValue) }), @@ -3053,6 +3416,9 @@ export interface FacetAttributeReference { } export namespace FacetAttributeReference { + /** + * @internal + */ export const filterSensitiveLog = (obj: FacetAttributeReference): any => ({ ...obj, }); @@ -3090,6 +3456,9 @@ export interface FacetAttribute { } export namespace FacetAttribute { + /** + * @internal + */ export const filterSensitiveLog = (obj: FacetAttribute): any => ({ ...obj, ...(obj.AttributeDefinition && { @@ -3161,6 +3530,9 @@ export interface CreateFacetRequest { } export namespace CreateFacetRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateFacetRequest): any => ({ ...obj, ...(obj.Attributes && { Attributes: obj.Attributes.map((item) => FacetAttribute.filterSensitiveLog(item)) }), @@ -3170,6 +3542,9 @@ export namespace CreateFacetRequest { export interface CreateFacetResponse {} export namespace CreateFacetResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateFacetResponse): any => ({ ...obj, }); @@ -3185,6 +3560,9 @@ export interface FacetAlreadyExistsException extends __SmithyException, $Metadat } export namespace FacetAlreadyExistsException { + /** + * @internal + */ export const filterSensitiveLog = (obj: FacetAlreadyExistsException): any => ({ ...obj, }); @@ -3200,6 +3578,9 @@ export interface InvalidRuleException extends __SmithyException, $MetadataBearer } export namespace InvalidRuleException { + /** + * @internal + */ export const filterSensitiveLog = (obj: InvalidRuleException): any => ({ ...obj, }); @@ -3235,6 +3616,9 @@ export interface CreateIndexRequest { } export namespace CreateIndexRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateIndexRequest): any => ({ ...obj, }); @@ -3248,6 +3632,9 @@ export interface CreateIndexResponse { } export namespace CreateIndexResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateIndexResponse): any => ({ ...obj, }); @@ -3263,6 +3650,9 @@ export interface UnsupportedIndexTypeException extends __SmithyException, $Metad } export namespace UnsupportedIndexTypeException { + /** + * @internal + */ export const filterSensitiveLog = (obj: UnsupportedIndexTypeException): any => ({ ...obj, }); @@ -3298,6 +3688,9 @@ export interface CreateObjectRequest { } export namespace CreateObjectRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateObjectRequest): any => ({ ...obj, ...(obj.ObjectAttributeList && { @@ -3314,6 +3707,9 @@ export interface CreateObjectResponse { } export namespace CreateObjectResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateObjectResponse): any => ({ ...obj, }); @@ -3328,6 +3724,9 @@ export interface CreateSchemaRequest { } export namespace CreateSchemaRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateSchemaRequest): any => ({ ...obj, }); @@ -3342,6 +3741,9 @@ export interface CreateSchemaResponse { } export namespace CreateSchemaResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateSchemaResponse): any => ({ ...obj, }); @@ -3383,6 +3785,9 @@ export interface TypedLinkAttributeDefinition { } export namespace TypedLinkAttributeDefinition { + /** + * @internal + */ export const filterSensitiveLog = (obj: TypedLinkAttributeDefinition): any => ({ ...obj, ...(obj.DefaultValue && { DefaultValue: TypedAttributeValue.filterSensitiveLog(obj.DefaultValue) }), @@ -3411,6 +3816,9 @@ export interface TypedLinkFacet { } export namespace TypedLinkFacet { + /** + * @internal + */ export const filterSensitiveLog = (obj: TypedLinkFacet): any => ({ ...obj, ...(obj.Attributes && { @@ -3435,6 +3843,9 @@ export interface CreateTypedLinkFacetRequest { } export namespace CreateTypedLinkFacetRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateTypedLinkFacetRequest): any => ({ ...obj, ...(obj.Facet && { Facet: TypedLinkFacet.filterSensitiveLog(obj.Facet) }), @@ -3444,6 +3855,9 @@ export namespace CreateTypedLinkFacetRequest { export interface CreateTypedLinkFacetResponse {} export namespace CreateTypedLinkFacetResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateTypedLinkFacetResponse): any => ({ ...obj, }); @@ -3457,6 +3871,9 @@ export interface DeleteDirectoryRequest { } export namespace DeleteDirectoryRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteDirectoryRequest): any => ({ ...obj, }); @@ -3470,6 +3887,9 @@ export interface DeleteDirectoryResponse { } export namespace DeleteDirectoryResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteDirectoryResponse): any => ({ ...obj, }); @@ -3486,6 +3906,9 @@ export interface DirectoryDeletedException extends __SmithyException, $MetadataB } export namespace DirectoryDeletedException { + /** + * @internal + */ export const filterSensitiveLog = (obj: DirectoryDeletedException): any => ({ ...obj, }); @@ -3501,6 +3924,9 @@ export interface DirectoryNotDisabledException extends __SmithyException, $Metad } export namespace DirectoryNotDisabledException { + /** + * @internal + */ export const filterSensitiveLog = (obj: DirectoryNotDisabledException): any => ({ ...obj, }); @@ -3520,6 +3946,9 @@ export interface DeleteFacetRequest { } export namespace DeleteFacetRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteFacetRequest): any => ({ ...obj, }); @@ -3528,6 +3957,9 @@ export namespace DeleteFacetRequest { export interface DeleteFacetResponse {} export namespace DeleteFacetResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteFacetResponse): any => ({ ...obj, }); @@ -3544,6 +3976,9 @@ export interface FacetInUseException extends __SmithyException, $MetadataBearer } export namespace FacetInUseException { + /** + * @internal + */ export const filterSensitiveLog = (obj: FacetInUseException): any => ({ ...obj, }); @@ -3559,6 +3994,9 @@ export interface FacetNotFoundException extends __SmithyException, $MetadataBear } export namespace FacetNotFoundException { + /** + * @internal + */ export const filterSensitiveLog = (obj: FacetNotFoundException): any => ({ ...obj, }); @@ -3578,6 +4016,9 @@ export interface DeleteObjectRequest { } export namespace DeleteObjectRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteObjectRequest): any => ({ ...obj, }); @@ -3586,6 +4027,9 @@ export namespace DeleteObjectRequest { export interface DeleteObjectResponse {} export namespace DeleteObjectResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteObjectResponse): any => ({ ...obj, }); @@ -3602,6 +4046,9 @@ export interface ObjectNotDetachedException extends __SmithyException, $Metadata } export namespace ObjectNotDetachedException { + /** + * @internal + */ export const filterSensitiveLog = (obj: ObjectNotDetachedException): any => ({ ...obj, }); @@ -3616,6 +4063,9 @@ export interface DeleteSchemaRequest { } export namespace DeleteSchemaRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteSchemaRequest): any => ({ ...obj, }); @@ -3630,6 +4080,9 @@ export interface DeleteSchemaResponse { } export namespace DeleteSchemaResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteSchemaResponse): any => ({ ...obj, }); @@ -3646,6 +4099,9 @@ export interface StillContainsLinksException extends __SmithyException, $Metadat } export namespace StillContainsLinksException { + /** + * @internal + */ export const filterSensitiveLog = (obj: StillContainsLinksException): any => ({ ...obj, }); @@ -3665,6 +4121,9 @@ export interface DeleteTypedLinkFacetRequest { } export namespace DeleteTypedLinkFacetRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteTypedLinkFacetRequest): any => ({ ...obj, }); @@ -3673,6 +4132,9 @@ export namespace DeleteTypedLinkFacetRequest { export interface DeleteTypedLinkFacetResponse {} export namespace DeleteTypedLinkFacetResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteTypedLinkFacetResponse): any => ({ ...obj, }); @@ -3697,6 +4159,9 @@ export interface DetachFromIndexRequest { } export namespace DetachFromIndexRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DetachFromIndexRequest): any => ({ ...obj, }); @@ -3710,6 +4175,9 @@ export interface DetachFromIndexResponse { } export namespace DetachFromIndexResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DetachFromIndexResponse): any => ({ ...obj, }); @@ -3725,6 +4193,9 @@ export interface ObjectAlreadyDetachedException extends __SmithyException, $Meta } export namespace ObjectAlreadyDetachedException { + /** + * @internal + */ export const filterSensitiveLog = (obj: ObjectAlreadyDetachedException): any => ({ ...obj, }); @@ -3750,6 +4221,9 @@ export interface DetachObjectRequest { } export namespace DetachObjectRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DetachObjectRequest): any => ({ ...obj, }); @@ -3763,6 +4237,9 @@ export interface DetachObjectResponse { } export namespace DetachObjectResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DetachObjectResponse): any => ({ ...obj, }); @@ -3779,6 +4256,9 @@ export interface NotNodeException extends __SmithyException, $MetadataBearer { } export namespace NotNodeException { + /** + * @internal + */ export const filterSensitiveLog = (obj: NotNodeException): any => ({ ...obj, }); @@ -3803,6 +4283,9 @@ export interface DetachPolicyRequest { } export namespace DetachPolicyRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DetachPolicyRequest): any => ({ ...obj, }); @@ -3811,6 +4294,9 @@ export namespace DetachPolicyRequest { export interface DetachPolicyResponse {} export namespace DetachPolicyResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DetachPolicyResponse): any => ({ ...obj, }); @@ -3830,6 +4316,9 @@ export interface DetachTypedLinkRequest { } export namespace DetachTypedLinkRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DetachTypedLinkRequest): any => ({ ...obj, ...(obj.TypedLinkSpecifier && { @@ -3846,6 +4335,9 @@ export interface DisableDirectoryRequest { } export namespace DisableDirectoryRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DisableDirectoryRequest): any => ({ ...obj, }); @@ -3859,6 +4351,9 @@ export interface DisableDirectoryResponse { } export namespace DisableDirectoryResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DisableDirectoryResponse): any => ({ ...obj, }); @@ -3872,6 +4367,9 @@ export interface EnableDirectoryRequest { } export namespace EnableDirectoryRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: EnableDirectoryRequest): any => ({ ...obj, }); @@ -3885,6 +4383,9 @@ export interface EnableDirectoryResponse { } export namespace EnableDirectoryResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: EnableDirectoryResponse): any => ({ ...obj, }); @@ -3898,6 +4399,9 @@ export interface GetAppliedSchemaVersionRequest { } export namespace GetAppliedSchemaVersionRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetAppliedSchemaVersionRequest): any => ({ ...obj, }); @@ -3911,6 +4415,9 @@ export interface GetAppliedSchemaVersionResponse { } export namespace GetAppliedSchemaVersionResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetAppliedSchemaVersionResponse): any => ({ ...obj, }); @@ -3924,6 +4431,9 @@ export interface GetDirectoryRequest { } export namespace GetDirectoryRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetDirectoryRequest): any => ({ ...obj, }); @@ -3962,6 +4472,9 @@ export interface Directory { } export namespace Directory { + /** + * @internal + */ export const filterSensitiveLog = (obj: Directory): any => ({ ...obj, }); @@ -3975,6 +4488,9 @@ export interface GetDirectoryResponse { } export namespace GetDirectoryResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetDirectoryResponse): any => ({ ...obj, }); @@ -3994,6 +4510,9 @@ export interface GetFacetRequest { } export namespace GetFacetRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetFacetRequest): any => ({ ...obj, }); @@ -4022,6 +4541,9 @@ export interface Facet { } export namespace Facet { + /** + * @internal + */ export const filterSensitiveLog = (obj: Facet): any => ({ ...obj, }); @@ -4035,6 +4557,9 @@ export interface GetFacetResponse { } export namespace GetFacetResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetFacetResponse): any => ({ ...obj, }); @@ -4063,6 +4588,9 @@ export interface GetLinkAttributesRequest { } export namespace GetLinkAttributesRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetLinkAttributesRequest): any => ({ ...obj, ...(obj.TypedLinkSpecifier && { @@ -4079,6 +4607,9 @@ export interface GetLinkAttributesResponse { } export namespace GetLinkAttributesResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetLinkAttributesResponse): any => ({ ...obj, ...(obj.Attributes && { Attributes: obj.Attributes.map((item) => AttributeKeyAndValue.filterSensitiveLog(item)) }), @@ -4113,6 +4644,9 @@ export interface GetObjectAttributesRequest { } export namespace GetObjectAttributesRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetObjectAttributesRequest): any => ({ ...obj, }); @@ -4126,6 +4660,9 @@ export interface GetObjectAttributesResponse { } export namespace GetObjectAttributesResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetObjectAttributesResponse): any => ({ ...obj, ...(obj.Attributes && { Attributes: obj.Attributes.map((item) => AttributeKeyAndValue.filterSensitiveLog(item)) }), @@ -4150,6 +4687,9 @@ export interface GetObjectInformationRequest { } export namespace GetObjectInformationRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetObjectInformationRequest): any => ({ ...obj, }); @@ -4168,6 +4708,9 @@ export interface GetObjectInformationResponse { } export namespace GetObjectInformationResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetObjectInformationResponse): any => ({ ...obj, }); @@ -4181,6 +4724,9 @@ export interface GetSchemaAsJsonRequest { } export namespace GetSchemaAsJsonRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetSchemaAsJsonRequest): any => ({ ...obj, }); @@ -4199,6 +4745,9 @@ export interface GetSchemaAsJsonResponse { } export namespace GetSchemaAsJsonResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetSchemaAsJsonResponse): any => ({ ...obj, }); @@ -4218,6 +4767,9 @@ export interface GetTypedLinkFacetInformationRequest { } export namespace GetTypedLinkFacetInformationRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetTypedLinkFacetInformationRequest): any => ({ ...obj, }); @@ -4236,6 +4788,9 @@ export interface GetTypedLinkFacetInformationResponse { } export namespace GetTypedLinkFacetInformationResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetTypedLinkFacetInformationResponse): any => ({ ...obj, }); @@ -4251,6 +4806,9 @@ export interface InvalidNextTokenException extends __SmithyException, $MetadataB } export namespace InvalidNextTokenException { + /** + * @internal + */ export const filterSensitiveLog = (obj: InvalidNextTokenException): any => ({ ...obj, }); @@ -4279,6 +4837,9 @@ export interface ListAppliedSchemaArnsRequest { } export namespace ListAppliedSchemaArnsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListAppliedSchemaArnsRequest): any => ({ ...obj, }); @@ -4297,6 +4858,9 @@ export interface ListAppliedSchemaArnsResponse { } export namespace ListAppliedSchemaArnsResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListAppliedSchemaArnsResponse): any => ({ ...obj, }); @@ -4330,6 +4894,9 @@ export interface ListAttachedIndicesRequest { } export namespace ListAttachedIndicesRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListAttachedIndicesRequest): any => ({ ...obj, }); @@ -4348,6 +4915,9 @@ export interface ListAttachedIndicesResponse { } export namespace ListAttachedIndicesResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListAttachedIndicesResponse): any => ({ ...obj, }); @@ -4366,6 +4936,9 @@ export interface ListDevelopmentSchemaArnsRequest { } export namespace ListDevelopmentSchemaArnsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListDevelopmentSchemaArnsRequest): any => ({ ...obj, }); @@ -4384,6 +4957,9 @@ export interface ListDevelopmentSchemaArnsResponse { } export namespace ListDevelopmentSchemaArnsResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListDevelopmentSchemaArnsResponse): any => ({ ...obj, }); @@ -4408,6 +4984,9 @@ export interface ListDirectoriesRequest { } export namespace ListDirectoriesRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListDirectoriesRequest): any => ({ ...obj, }); @@ -4427,6 +5006,9 @@ export interface ListDirectoriesResponse { } export namespace ListDirectoriesResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListDirectoriesResponse): any => ({ ...obj, }); @@ -4455,6 +5037,9 @@ export interface ListFacetAttributesRequest { } export namespace ListFacetAttributesRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListFacetAttributesRequest): any => ({ ...obj, }); @@ -4473,6 +5058,9 @@ export interface ListFacetAttributesResponse { } export namespace ListFacetAttributesResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListFacetAttributesResponse): any => ({ ...obj, ...(obj.Attributes && { Attributes: obj.Attributes.map((item) => FacetAttribute.filterSensitiveLog(item)) }), @@ -4497,6 +5085,9 @@ export interface ListFacetNamesRequest { } export namespace ListFacetNamesRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListFacetNamesRequest): any => ({ ...obj, }); @@ -4515,6 +5106,9 @@ export interface ListFacetNamesResponse { } export namespace ListFacetNamesResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListFacetNamesResponse): any => ({ ...obj, }); @@ -4562,6 +5156,9 @@ export interface ListIncomingTypedLinksRequest { } export namespace ListIncomingTypedLinksRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListIncomingTypedLinksRequest): any => ({ ...obj, ...(obj.FilterAttributeRanges && { @@ -4583,6 +5180,9 @@ export interface ListIncomingTypedLinksResponse { } export namespace ListIncomingTypedLinksResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListIncomingTypedLinksResponse): any => ({ ...obj, }); @@ -4621,6 +5221,9 @@ export interface ListIndexRequest { } export namespace ListIndexRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListIndexRequest): any => ({ ...obj, ...(obj.RangesOnIndexedValues && { @@ -4642,6 +5245,9 @@ export interface ListIndexResponse { } export namespace ListIndexResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListIndexResponse): any => ({ ...obj, }); @@ -4665,6 +5271,9 @@ export interface ListManagedSchemaArnsRequest { } export namespace ListManagedSchemaArnsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListManagedSchemaArnsRequest): any => ({ ...obj, }); @@ -4683,6 +5292,9 @@ export interface ListManagedSchemaArnsResponse { } export namespace ListManagedSchemaArnsResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListManagedSchemaArnsResponse): any => ({ ...obj, }); @@ -4725,6 +5337,9 @@ export interface ListObjectAttributesRequest { } export namespace ListObjectAttributesRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListObjectAttributesRequest): any => ({ ...obj, }); @@ -4744,6 +5359,9 @@ export interface ListObjectAttributesResponse { } export namespace ListObjectAttributesResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListObjectAttributesResponse): any => ({ ...obj, ...(obj.Attributes && { Attributes: obj.Attributes.map((item) => AttributeKeyAndValue.filterSensitiveLog(item)) }), @@ -4782,6 +5400,9 @@ export interface ListObjectChildrenRequest { } export namespace ListObjectChildrenRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListObjectChildrenRequest): any => ({ ...obj, }); @@ -4801,6 +5422,9 @@ export interface ListObjectChildrenResponse { } export namespace ListObjectChildrenResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListObjectChildrenResponse): any => ({ ...obj, }); @@ -4830,6 +5454,9 @@ export interface ListObjectParentPathsRequest { } export namespace ListObjectParentPathsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListObjectParentPathsRequest): any => ({ ...obj, }); @@ -4849,6 +5476,9 @@ export interface ListObjectParentPathsResponse { } export namespace ListObjectParentPathsResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListObjectParentPathsResponse): any => ({ ...obj, }); @@ -4864,6 +5494,9 @@ export interface CannotListParentOfRootException extends __SmithyException, $Met } export namespace CannotListParentOfRootException { + /** + * @internal + */ export const filterSensitiveLog = (obj: CannotListParentOfRootException): any => ({ ...obj, }); @@ -4906,6 +5539,9 @@ export interface ListObjectParentsRequest { } export namespace ListObjectParentsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListObjectParentsRequest): any => ({ ...obj, }); @@ -4930,6 +5566,9 @@ export interface ListObjectParentsResponse { } export namespace ListObjectParentsResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListObjectParentsResponse): any => ({ ...obj, }); @@ -4966,6 +5605,9 @@ export interface ListObjectPoliciesRequest { } export namespace ListObjectPoliciesRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListObjectPoliciesRequest): any => ({ ...obj, }); @@ -4985,6 +5627,9 @@ export interface ListObjectPoliciesResponse { } export namespace ListObjectPoliciesResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListObjectPoliciesResponse): any => ({ ...obj, }); @@ -5032,6 +5677,9 @@ export interface ListOutgoingTypedLinksRequest { } export namespace ListOutgoingTypedLinksRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListOutgoingTypedLinksRequest): any => ({ ...obj, ...(obj.FilterAttributeRanges && { @@ -5053,6 +5701,9 @@ export interface ListOutgoingTypedLinksResponse { } export namespace ListOutgoingTypedLinksResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListOutgoingTypedLinksResponse): any => ({ ...obj, }); @@ -5089,6 +5740,9 @@ export interface ListPolicyAttachmentsRequest { } export namespace ListPolicyAttachmentsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListPolicyAttachmentsRequest): any => ({ ...obj, }); @@ -5107,6 +5761,9 @@ export interface ListPolicyAttachmentsResponse { } export namespace ListPolicyAttachmentsResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListPolicyAttachmentsResponse): any => ({ ...obj, }); @@ -5130,6 +5787,9 @@ export interface ListPublishedSchemaArnsRequest { } export namespace ListPublishedSchemaArnsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListPublishedSchemaArnsRequest): any => ({ ...obj, }); @@ -5148,6 +5808,9 @@ export interface ListPublishedSchemaArnsResponse { } export namespace ListPublishedSchemaArnsResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListPublishedSchemaArnsResponse): any => ({ ...obj, }); @@ -5163,6 +5826,9 @@ export interface InvalidTaggingRequestException extends __SmithyException, $Meta } export namespace InvalidTaggingRequestException { + /** + * @internal + */ export const filterSensitiveLog = (obj: InvalidTaggingRequestException): any => ({ ...obj, }); @@ -5189,6 +5855,9 @@ export interface ListTagsForResourceRequest { } export namespace ListTagsForResourceRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListTagsForResourceRequest): any => ({ ...obj, }); @@ -5210,6 +5879,9 @@ export interface Tag { } export namespace Tag { + /** + * @internal + */ export const filterSensitiveLog = (obj: Tag): any => ({ ...obj, }); @@ -5228,6 +5900,9 @@ export interface ListTagsForResourceResponse { } export namespace ListTagsForResourceResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListTagsForResourceResponse): any => ({ ...obj, }); @@ -5257,6 +5932,9 @@ export interface ListTypedLinkFacetAttributesRequest { } export namespace ListTypedLinkFacetAttributesRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListTypedLinkFacetAttributesRequest): any => ({ ...obj, }); @@ -5275,6 +5953,9 @@ export interface ListTypedLinkFacetAttributesResponse { } export namespace ListTypedLinkFacetAttributesResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListTypedLinkFacetAttributesResponse): any => ({ ...obj, ...(obj.Attributes && { @@ -5302,6 +5983,9 @@ export interface ListTypedLinkFacetNamesRequest { } export namespace ListTypedLinkFacetNamesRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListTypedLinkFacetNamesRequest): any => ({ ...obj, }); @@ -5320,6 +6004,9 @@ export interface ListTypedLinkFacetNamesResponse { } export namespace ListTypedLinkFacetNamesResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListTypedLinkFacetNamesResponse): any => ({ ...obj, }); @@ -5350,6 +6037,9 @@ export interface LookupPolicyRequest { } export namespace LookupPolicyRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: LookupPolicyRequest): any => ({ ...obj, }); @@ -5370,6 +6060,9 @@ export interface LookupPolicyResponse { } export namespace LookupPolicyResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: LookupPolicyResponse): any => ({ ...obj, }); @@ -5400,6 +6093,9 @@ export interface PublishSchemaRequest { } export namespace PublishSchemaRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: PublishSchemaRequest): any => ({ ...obj, }); @@ -5413,6 +6109,9 @@ export interface PublishSchemaResponse { } export namespace PublishSchemaResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: PublishSchemaResponse): any => ({ ...obj, }); @@ -5428,6 +6127,9 @@ export interface SchemaAlreadyPublishedException extends __SmithyException, $Met } export namespace SchemaAlreadyPublishedException { + /** + * @internal + */ export const filterSensitiveLog = (obj: SchemaAlreadyPublishedException): any => ({ ...obj, }); @@ -5443,6 +6145,9 @@ export interface InvalidSchemaDocException extends __SmithyException, $MetadataB } export namespace InvalidSchemaDocException { + /** + * @internal + */ export const filterSensitiveLog = (obj: InvalidSchemaDocException): any => ({ ...obj, }); @@ -5461,6 +6166,9 @@ export interface PutSchemaFromJsonRequest { } export namespace PutSchemaFromJsonRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: PutSchemaFromJsonRequest): any => ({ ...obj, }); @@ -5474,6 +6182,9 @@ export interface PutSchemaFromJsonResponse { } export namespace PutSchemaFromJsonResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: PutSchemaFromJsonResponse): any => ({ ...obj, }); @@ -5497,6 +6208,9 @@ export interface RemoveFacetFromObjectRequest { } export namespace RemoveFacetFromObjectRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: RemoveFacetFromObjectRequest): any => ({ ...obj, }); @@ -5505,6 +6219,9 @@ export namespace RemoveFacetFromObjectRequest { export interface RemoveFacetFromObjectResponse {} export namespace RemoveFacetFromObjectResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: RemoveFacetFromObjectResponse): any => ({ ...obj, }); @@ -5524,6 +6241,9 @@ export interface TagResourceRequest { } export namespace TagResourceRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: TagResourceRequest): any => ({ ...obj, }); @@ -5532,6 +6252,9 @@ export namespace TagResourceRequest { export interface TagResourceResponse {} export namespace TagResourceResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: TagResourceResponse): any => ({ ...obj, }); @@ -5551,6 +6274,9 @@ export interface UntagResourceRequest { } export namespace UntagResourceRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: UntagResourceRequest): any => ({ ...obj, }); @@ -5559,6 +6285,9 @@ export namespace UntagResourceRequest { export interface UntagResourceResponse {} export namespace UntagResourceResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: UntagResourceResponse): any => ({ ...obj, }); @@ -5575,6 +6304,9 @@ export interface InvalidFacetUpdateException extends __SmithyException, $Metadat } export namespace InvalidFacetUpdateException { + /** + * @internal + */ export const filterSensitiveLog = (obj: InvalidFacetUpdateException): any => ({ ...obj, }); @@ -5596,6 +6328,9 @@ export interface FacetAttributeUpdate { } export namespace FacetAttributeUpdate { + /** + * @internal + */ export const filterSensitiveLog = (obj: FacetAttributeUpdate): any => ({ ...obj, ...(obj.Attribute && { Attribute: FacetAttribute.filterSensitiveLog(obj.Attribute) }), @@ -5628,6 +6363,9 @@ export interface UpdateFacetRequest { } export namespace UpdateFacetRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateFacetRequest): any => ({ ...obj, ...(obj.AttributeUpdates && { @@ -5639,6 +6377,9 @@ export namespace UpdateFacetRequest { export interface UpdateFacetResponse {} export namespace UpdateFacetResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateFacetResponse): any => ({ ...obj, }); @@ -5662,6 +6403,9 @@ export interface UpdateLinkAttributesRequest { } export namespace UpdateLinkAttributesRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateLinkAttributesRequest): any => ({ ...obj, ...(obj.TypedLinkSpecifier && { @@ -5676,6 +6420,9 @@ export namespace UpdateLinkAttributesRequest { export interface UpdateLinkAttributesResponse {} export namespace UpdateLinkAttributesResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateLinkAttributesResponse): any => ({ ...obj, }); @@ -5700,6 +6447,9 @@ export interface UpdateObjectAttributesRequest { } export namespace UpdateObjectAttributesRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateObjectAttributesRequest): any => ({ ...obj, ...(obj.AttributeUpdates && { @@ -5716,6 +6466,9 @@ export interface UpdateObjectAttributesResponse { } export namespace UpdateObjectAttributesResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateObjectAttributesResponse): any => ({ ...obj, }); @@ -5735,6 +6488,9 @@ export interface UpdateSchemaRequest { } export namespace UpdateSchemaRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateSchemaRequest): any => ({ ...obj, }); @@ -5748,6 +6504,9 @@ export interface UpdateSchemaResponse { } export namespace UpdateSchemaResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateSchemaResponse): any => ({ ...obj, }); @@ -5769,6 +6528,9 @@ export interface TypedLinkFacetAttributeUpdate { } export namespace TypedLinkFacetAttributeUpdate { + /** + * @internal + */ export const filterSensitiveLog = (obj: TypedLinkFacetAttributeUpdate): any => ({ ...obj, ...(obj.Attribute && { Attribute: TypedLinkAttributeDefinition.filterSensitiveLog(obj.Attribute) }), @@ -5804,6 +6566,9 @@ export interface UpdateTypedLinkFacetRequest { } export namespace UpdateTypedLinkFacetRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateTypedLinkFacetRequest): any => ({ ...obj, ...(obj.AttributeUpdates && { @@ -5815,6 +6580,9 @@ export namespace UpdateTypedLinkFacetRequest { export interface UpdateTypedLinkFacetResponse {} export namespace UpdateTypedLinkFacetResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateTypedLinkFacetResponse): any => ({ ...obj, }); @@ -5830,6 +6598,9 @@ export interface IncompatibleSchemaException extends __SmithyException, $Metadat } export namespace IncompatibleSchemaException { + /** + * @internal + */ export const filterSensitiveLog = (obj: IncompatibleSchemaException): any => ({ ...obj, }); @@ -5853,6 +6624,9 @@ export interface UpgradeAppliedSchemaRequest { } export namespace UpgradeAppliedSchemaRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpgradeAppliedSchemaRequest): any => ({ ...obj, }); @@ -5871,6 +6645,9 @@ export interface UpgradeAppliedSchemaResponse { } export namespace UpgradeAppliedSchemaResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpgradeAppliedSchemaResponse): any => ({ ...obj, }); @@ -5899,6 +6676,9 @@ export interface UpgradePublishedSchemaRequest { } export namespace UpgradePublishedSchemaRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpgradePublishedSchemaRequest): any => ({ ...obj, }); @@ -5912,6 +6692,9 @@ export interface UpgradePublishedSchemaResponse { } export namespace UpgradePublishedSchemaResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpgradePublishedSchemaResponse): any => ({ ...obj, }); diff --git a/clients/client-cloudformation/commands/CancelUpdateStackCommand.ts b/clients/client-cloudformation/commands/CancelUpdateStackCommand.ts index d81fe429f275..6b1701034654 100644 --- a/clients/client-cloudformation/commands/CancelUpdateStackCommand.ts +++ b/clients/client-cloudformation/commands/CancelUpdateStackCommand.ts @@ -26,6 +26,20 @@ export interface CancelUpdateStackCommandOutput extends __MetadataBearer {} * *

You can cancel only stacks that are in the UPDATE_IN_PROGRESS state.

* + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { CloudFormationClient, CancelUpdateStackCommand } from "@aws-sdk/client-cloudformation"; // ES Modules import + * // const { CloudFormationClient, CancelUpdateStackCommand } = require("@aws-sdk/client-cloudformation"); // CommonJS import + * const client = new CloudFormationClient(config); + * const command = new CancelUpdateStackCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CancelUpdateStackCommandInput} for command's `input` shape. + * @see {@link CancelUpdateStackCommandOutput} for command's `response` shape. + * @see {@link CloudFormationClientResolvedConfig | config} for command's `input` shape. + * */ export class CancelUpdateStackCommand extends $Command< CancelUpdateStackCommandInput, diff --git a/clients/client-cloudformation/commands/ContinueUpdateRollbackCommand.ts b/clients/client-cloudformation/commands/ContinueUpdateRollbackCommand.ts index d016d17631ca..12943fb3faf9 100644 --- a/clients/client-cloudformation/commands/ContinueUpdateRollbackCommand.ts +++ b/clients/client-cloudformation/commands/ContinueUpdateRollbackCommand.ts @@ -32,6 +32,20 @@ export interface ContinueUpdateRollbackCommandOutput extends ContinueUpdateRollb * outside of AWS CloudFormation. Because AWS 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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { CloudFormationClient, ContinueUpdateRollbackCommand } from "@aws-sdk/client-cloudformation"; // ES Modules import + * // const { CloudFormationClient, ContinueUpdateRollbackCommand } = require("@aws-sdk/client-cloudformation"); // CommonJS import + * const client = new CloudFormationClient(config); + * const command = new ContinueUpdateRollbackCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ContinueUpdateRollbackCommandInput} for command's `input` shape. + * @see {@link ContinueUpdateRollbackCommandOutput} for command's `response` shape. + * @see {@link CloudFormationClientResolvedConfig | config} for command's `input` shape. + * */ export class ContinueUpdateRollbackCommand extends $Command< ContinueUpdateRollbackCommandInput, diff --git a/clients/client-cloudformation/commands/CreateChangeSetCommand.ts b/clients/client-cloudformation/commands/CreateChangeSetCommand.ts index 66a07060021a..9d288f8d45fa 100644 --- a/clients/client-cloudformation/commands/CreateChangeSetCommand.ts +++ b/clients/client-cloudformation/commands/CreateChangeSetCommand.ts @@ -42,6 +42,20 @@ export interface CreateChangeSetCommandOutput extends CreateChangeSetOutput, __M * changes until you execute the change set.

*

To create a change set for the entire stack hierachy, set * IncludeNestedStacks to True.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { CloudFormationClient, CreateChangeSetCommand } from "@aws-sdk/client-cloudformation"; // ES Modules import + * // const { CloudFormationClient, CreateChangeSetCommand } = require("@aws-sdk/client-cloudformation"); // CommonJS import + * const client = new CloudFormationClient(config); + * const command = new CreateChangeSetCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreateChangeSetCommandInput} for command's `input` shape. + * @see {@link CreateChangeSetCommandOutput} for command's `response` shape. + * @see {@link CloudFormationClientResolvedConfig | config} for command's `input` shape. + * */ export class CreateChangeSetCommand extends $Command< CreateChangeSetCommandInput, diff --git a/clients/client-cloudformation/commands/CreateStackCommand.ts b/clients/client-cloudformation/commands/CreateStackCommand.ts index 35c150d12570..e4239aff74d8 100644 --- a/clients/client-cloudformation/commands/CreateStackCommand.ts +++ b/clients/client-cloudformation/commands/CreateStackCommand.ts @@ -20,6 +20,20 @@ export interface CreateStackCommandOutput extends CreateStackOutput, __MetadataB /** *

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 via the DescribeStacks API.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { CloudFormationClient, CreateStackCommand } from "@aws-sdk/client-cloudformation"; // ES Modules import + * // const { CloudFormationClient, CreateStackCommand } = require("@aws-sdk/client-cloudformation"); // CommonJS import + * const client = new CloudFormationClient(config); + * const command = new CreateStackCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreateStackCommandInput} for command's `input` shape. + * @see {@link CreateStackCommandOutput} for command's `response` shape. + * @see {@link CloudFormationClientResolvedConfig | config} for command's `input` shape. + * */ export class CreateStackCommand extends $Command< CreateStackCommandInput, diff --git a/clients/client-cloudformation/commands/CreateStackInstancesCommand.ts b/clients/client-cloudformation/commands/CreateStackInstancesCommand.ts index 62cd6138a373..0d242fa906fc 100644 --- a/clients/client-cloudformation/commands/CreateStackInstancesCommand.ts +++ b/clients/client-cloudformation/commands/CreateStackInstancesCommand.ts @@ -23,6 +23,20 @@ export interface CreateStackInstancesCommandOutput extends CreateStackInstancesO /** *

Creates stack instances for the specified accounts, within the specified 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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { CloudFormationClient, CreateStackInstancesCommand } from "@aws-sdk/client-cloudformation"; // ES Modules import + * // const { CloudFormationClient, CreateStackInstancesCommand } = require("@aws-sdk/client-cloudformation"); // CommonJS import + * const client = new CloudFormationClient(config); + * const command = new CreateStackInstancesCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreateStackInstancesCommandInput} for command's `input` shape. + * @see {@link CreateStackInstancesCommandOutput} for command's `response` shape. + * @see {@link CloudFormationClientResolvedConfig | config} for command's `input` shape. + * */ export class CreateStackInstancesCommand extends $Command< CreateStackInstancesCommandInput, diff --git a/clients/client-cloudformation/commands/CreateStackSetCommand.ts b/clients/client-cloudformation/commands/CreateStackSetCommand.ts index 261d7b423499..26d1d1215cfc 100644 --- a/clients/client-cloudformation/commands/CreateStackSetCommand.ts +++ b/clients/client-cloudformation/commands/CreateStackSetCommand.ts @@ -22,6 +22,20 @@ export interface CreateStackSetCommandOutput extends CreateStackSetOutput, __Met /** *

Creates a stack set.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { CloudFormationClient, CreateStackSetCommand } from "@aws-sdk/client-cloudformation"; // ES Modules import + * // const { CloudFormationClient, CreateStackSetCommand } = require("@aws-sdk/client-cloudformation"); // CommonJS import + * const client = new CloudFormationClient(config); + * const command = new CreateStackSetCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreateStackSetCommandInput} for command's `input` shape. + * @see {@link CreateStackSetCommandOutput} for command's `response` shape. + * @see {@link CloudFormationClientResolvedConfig | config} for command's `input` shape. + * */ export class CreateStackSetCommand extends $Command< CreateStackSetCommandInput, diff --git a/clients/client-cloudformation/commands/DeleteChangeSetCommand.ts b/clients/client-cloudformation/commands/DeleteChangeSetCommand.ts index 304a5aaca096..2834f69856b1 100644 --- a/clients/client-cloudformation/commands/DeleteChangeSetCommand.ts +++ b/clients/client-cloudformation/commands/DeleteChangeSetCommand.ts @@ -28,6 +28,20 @@ export interface DeleteChangeSetCommandOutput extends DeleteChangeSetOutput, __M *

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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { CloudFormationClient, DeleteChangeSetCommand } from "@aws-sdk/client-cloudformation"; // ES Modules import + * // const { CloudFormationClient, DeleteChangeSetCommand } = require("@aws-sdk/client-cloudformation"); // CommonJS import + * const client = new CloudFormationClient(config); + * const command = new DeleteChangeSetCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteChangeSetCommandInput} for command's `input` shape. + * @see {@link DeleteChangeSetCommandOutput} for command's `response` shape. + * @see {@link CloudFormationClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteChangeSetCommand extends $Command< DeleteChangeSetCommandInput, diff --git a/clients/client-cloudformation/commands/DeleteStackCommand.ts b/clients/client-cloudformation/commands/DeleteStackCommand.ts index 91dac458fc57..ef328450f3ae 100644 --- a/clients/client-cloudformation/commands/DeleteStackCommand.ts +++ b/clients/client-cloudformation/commands/DeleteStackCommand.ts @@ -21,6 +21,20 @@ export interface DeleteStackCommandOutput extends __MetadataBearer {} *

Deletes a specified stack. Once the call completes successfully, stack deletion * starts. Deleted stacks do not show up in the DescribeStacks API if the * deletion has been completed successfully.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { CloudFormationClient, DeleteStackCommand } from "@aws-sdk/client-cloudformation"; // ES Modules import + * // const { CloudFormationClient, DeleteStackCommand } = require("@aws-sdk/client-cloudformation"); // CommonJS import + * const client = new CloudFormationClient(config); + * const command = new DeleteStackCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteStackCommandInput} for command's `input` shape. + * @see {@link DeleteStackCommandOutput} for command's `response` shape. + * @see {@link CloudFormationClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteStackCommand extends $Command< DeleteStackCommandInput, diff --git a/clients/client-cloudformation/commands/DeleteStackInstancesCommand.ts b/clients/client-cloudformation/commands/DeleteStackInstancesCommand.ts index fc8845c7e45c..be792cb3b58f 100644 --- a/clients/client-cloudformation/commands/DeleteStackInstancesCommand.ts +++ b/clients/client-cloudformation/commands/DeleteStackInstancesCommand.ts @@ -22,6 +22,20 @@ export interface DeleteStackInstancesCommandOutput extends DeleteStackInstancesO /** *

Deletes stack instances for the specified accounts, in the specified Regions.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { CloudFormationClient, DeleteStackInstancesCommand } from "@aws-sdk/client-cloudformation"; // ES Modules import + * // const { CloudFormationClient, DeleteStackInstancesCommand } = require("@aws-sdk/client-cloudformation"); // CommonJS import + * const client = new CloudFormationClient(config); + * const command = new DeleteStackInstancesCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteStackInstancesCommandInput} for command's `input` shape. + * @see {@link DeleteStackInstancesCommandOutput} for command's `response` shape. + * @see {@link CloudFormationClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteStackInstancesCommand extends $Command< DeleteStackInstancesCommandInput, diff --git a/clients/client-cloudformation/commands/DeleteStackSetCommand.ts b/clients/client-cloudformation/commands/DeleteStackSetCommand.ts index acd93d484350..92483cd69a79 100644 --- a/clients/client-cloudformation/commands/DeleteStackSetCommand.ts +++ b/clients/client-cloudformation/commands/DeleteStackSetCommand.ts @@ -23,6 +23,20 @@ export interface DeleteStackSetCommandOutput extends DeleteStackSetOutput, __Met /** *

Deletes a stack set. Before you can delete a stack set, all of its member stack * instances must be deleted. For more information about how to do this, see DeleteStackInstances.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { CloudFormationClient, DeleteStackSetCommand } from "@aws-sdk/client-cloudformation"; // ES Modules import + * // const { CloudFormationClient, DeleteStackSetCommand } = require("@aws-sdk/client-cloudformation"); // CommonJS import + * const client = new CloudFormationClient(config); + * const command = new DeleteStackSetCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteStackSetCommandInput} for command's `input` shape. + * @see {@link DeleteStackSetCommandOutput} for command's `response` shape. + * @see {@link CloudFormationClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteStackSetCommand extends $Command< DeleteStackSetCommandInput, diff --git a/clients/client-cloudformation/commands/DeregisterTypeCommand.ts b/clients/client-cloudformation/commands/DeregisterTypeCommand.ts index e385c339a9d0..a01658afa2af 100644 --- a/clients/client-cloudformation/commands/DeregisterTypeCommand.ts +++ b/clients/client-cloudformation/commands/DeregisterTypeCommand.ts @@ -25,6 +25,20 @@ export interface DeregisterTypeCommandOutput extends DeregisterTypeOutput, __Met *

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 cannot 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 textensionype itself is deregistered as well and marked as deprecated.

*

To view the deprecation status of an extension or extension version, use DescribeType.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { CloudFormationClient, DeregisterTypeCommand } from "@aws-sdk/client-cloudformation"; // ES Modules import + * // const { CloudFormationClient, DeregisterTypeCommand } = require("@aws-sdk/client-cloudformation"); // CommonJS import + * const client = new CloudFormationClient(config); + * const command = new DeregisterTypeCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeregisterTypeCommandInput} for command's `input` shape. + * @see {@link DeregisterTypeCommandOutput} for command's `response` shape. + * @see {@link CloudFormationClientResolvedConfig | config} for command's `input` shape. + * */ export class DeregisterTypeCommand extends $Command< DeregisterTypeCommandInput, diff --git a/clients/client-cloudformation/commands/DescribeAccountLimitsCommand.ts b/clients/client-cloudformation/commands/DescribeAccountLimitsCommand.ts index eb5a9903918d..2d26ed783a21 100644 --- a/clients/client-cloudformation/commands/DescribeAccountLimitsCommand.ts +++ b/clients/client-cloudformation/commands/DescribeAccountLimitsCommand.ts @@ -25,6 +25,20 @@ export interface DescribeAccountLimitsCommandOutput extends DescribeAccountLimit * stacks that you can create in your account. For more information about account limits, see * AWS CloudFormation * Limits in the AWS CloudFormation User Guide.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { CloudFormationClient, DescribeAccountLimitsCommand } from "@aws-sdk/client-cloudformation"; // ES Modules import + * // const { CloudFormationClient, DescribeAccountLimitsCommand } = require("@aws-sdk/client-cloudformation"); // CommonJS import + * const client = new CloudFormationClient(config); + * const command = new DescribeAccountLimitsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeAccountLimitsCommandInput} for command's `input` shape. + * @see {@link DescribeAccountLimitsCommandOutput} for command's `response` shape. + * @see {@link CloudFormationClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeAccountLimitsCommand extends $Command< DescribeAccountLimitsCommandInput, diff --git a/clients/client-cloudformation/commands/DescribeChangeSetCommand.ts b/clients/client-cloudformation/commands/DescribeChangeSetCommand.ts index be16befcaae7..27f5ce38f675 100644 --- a/clients/client-cloudformation/commands/DescribeChangeSetCommand.ts +++ b/clients/client-cloudformation/commands/DescribeChangeSetCommand.ts @@ -24,6 +24,20 @@ export interface DescribeChangeSetCommandOutput extends DescribeChangeSetOutput, *

Returns the inputs for the change set and a list of changes that AWS CloudFormation * will make if you execute the change set. For more information, see Updating Stacks Using Change Sets in the AWS CloudFormation User * Guide.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { CloudFormationClient, DescribeChangeSetCommand } from "@aws-sdk/client-cloudformation"; // ES Modules import + * // const { CloudFormationClient, DescribeChangeSetCommand } = require("@aws-sdk/client-cloudformation"); // CommonJS import + * const client = new CloudFormationClient(config); + * const command = new DescribeChangeSetCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeChangeSetCommandInput} for command's `input` shape. + * @see {@link DescribeChangeSetCommandOutput} for command's `response` shape. + * @see {@link CloudFormationClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeChangeSetCommand extends $Command< DescribeChangeSetCommandInput, diff --git a/clients/client-cloudformation/commands/DescribeStackDriftDetectionStatusCommand.ts b/clients/client-cloudformation/commands/DescribeStackDriftDetectionStatusCommand.ts index f9b44389d01b..60366a99aaa4 100644 --- a/clients/client-cloudformation/commands/DescribeStackDriftDetectionStatusCommand.ts +++ b/clients/client-cloudformation/commands/DescribeStackDriftDetectionStatusCommand.ts @@ -36,6 +36,20 @@ export interface DescribeStackDriftDetectionStatusCommandOutput * DescribeStackDriftDetectionStatus. Once the drift detection operation has * completed, use DescribeStackResourceDrifts to return drift information * about the stack and its resources.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { CloudFormationClient, DescribeStackDriftDetectionStatusCommand } from "@aws-sdk/client-cloudformation"; // ES Modules import + * // const { CloudFormationClient, DescribeStackDriftDetectionStatusCommand } = require("@aws-sdk/client-cloudformation"); // CommonJS import + * const client = new CloudFormationClient(config); + * const command = new DescribeStackDriftDetectionStatusCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeStackDriftDetectionStatusCommandInput} for command's `input` shape. + * @see {@link DescribeStackDriftDetectionStatusCommandOutput} for command's `response` shape. + * @see {@link CloudFormationClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeStackDriftDetectionStatusCommand extends $Command< DescribeStackDriftDetectionStatusCommandInput, diff --git a/clients/client-cloudformation/commands/DescribeStackEventsCommand.ts b/clients/client-cloudformation/commands/DescribeStackEventsCommand.ts index d7365d6d12e2..d171fac63235 100644 --- a/clients/client-cloudformation/commands/DescribeStackEventsCommand.ts +++ b/clients/client-cloudformation/commands/DescribeStackEventsCommand.ts @@ -27,6 +27,20 @@ export interface DescribeStackEventsCommandOutput extends DescribeStackEventsOut *

You can list events for stacks that have failed to create or have been deleted by * specifying the unique stack identifier (stack ID).

* + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { CloudFormationClient, DescribeStackEventsCommand } from "@aws-sdk/client-cloudformation"; // ES Modules import + * // const { CloudFormationClient, DescribeStackEventsCommand } = require("@aws-sdk/client-cloudformation"); // CommonJS import + * const client = new CloudFormationClient(config); + * const command = new DescribeStackEventsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeStackEventsCommandInput} for command's `input` shape. + * @see {@link DescribeStackEventsCommandOutput} for command's `response` shape. + * @see {@link CloudFormationClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeStackEventsCommand extends $Command< DescribeStackEventsCommandInput, diff --git a/clients/client-cloudformation/commands/DescribeStackInstanceCommand.ts b/clients/client-cloudformation/commands/DescribeStackInstanceCommand.ts index ad84c1f894ca..e6ace53e9f05 100644 --- a/clients/client-cloudformation/commands/DescribeStackInstanceCommand.ts +++ b/clients/client-cloudformation/commands/DescribeStackInstanceCommand.ts @@ -25,6 +25,20 @@ export interface DescribeStackInstanceCommandOutput extends DescribeStackInstanc * account, and Region.

*

For a list of stack instances that are associated with a specific stack set, use * ListStackInstances.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { CloudFormationClient, DescribeStackInstanceCommand } from "@aws-sdk/client-cloudformation"; // ES Modules import + * // const { CloudFormationClient, DescribeStackInstanceCommand } = require("@aws-sdk/client-cloudformation"); // CommonJS import + * const client = new CloudFormationClient(config); + * const command = new DescribeStackInstanceCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeStackInstanceCommandInput} for command's `input` shape. + * @see {@link DescribeStackInstanceCommandOutput} for command's `response` shape. + * @see {@link CloudFormationClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeStackInstanceCommand extends $Command< DescribeStackInstanceCommandInput, diff --git a/clients/client-cloudformation/commands/DescribeStackResourceCommand.ts b/clients/client-cloudformation/commands/DescribeStackResourceCommand.ts index 006c42bde3bd..6e6b21065ff0 100644 --- a/clients/client-cloudformation/commands/DescribeStackResourceCommand.ts +++ b/clients/client-cloudformation/commands/DescribeStackResourceCommand.ts @@ -24,6 +24,20 @@ export interface DescribeStackResourceCommandOutput extends DescribeStackResourc *

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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { CloudFormationClient, DescribeStackResourceCommand } from "@aws-sdk/client-cloudformation"; // ES Modules import + * // const { CloudFormationClient, DescribeStackResourceCommand } = require("@aws-sdk/client-cloudformation"); // CommonJS import + * const client = new CloudFormationClient(config); + * const command = new DescribeStackResourceCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeStackResourceCommandInput} for command's `input` shape. + * @see {@link DescribeStackResourceCommandOutput} for command's `response` shape. + * @see {@link CloudFormationClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeStackResourceCommand extends $Command< DescribeStackResourceCommandInput, diff --git a/clients/client-cloudformation/commands/DescribeStackResourceDriftsCommand.ts b/clients/client-cloudformation/commands/DescribeStackResourceDriftsCommand.ts index 69226ccdc55f..03b0332566c0 100644 --- a/clients/client-cloudformation/commands/DescribeStackResourceDriftsCommand.ts +++ b/clients/client-cloudformation/commands/DescribeStackResourceDriftsCommand.ts @@ -32,6 +32,20 @@ export interface DescribeStackResourceDriftsCommandOutput extends DescribeStackR *

Use DetectStackResourceDrift to detect drift on individual * resources, or DetectStackDrift to detect drift on all supported resources * for a given stack.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { CloudFormationClient, DescribeStackResourceDriftsCommand } from "@aws-sdk/client-cloudformation"; // ES Modules import + * // const { CloudFormationClient, DescribeStackResourceDriftsCommand } = require("@aws-sdk/client-cloudformation"); // CommonJS import + * const client = new CloudFormationClient(config); + * const command = new DescribeStackResourceDriftsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeStackResourceDriftsCommandInput} for command's `input` shape. + * @see {@link DescribeStackResourceDriftsCommandOutput} for command's `response` shape. + * @see {@link CloudFormationClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeStackResourceDriftsCommand extends $Command< DescribeStackResourceDriftsCommandInput, diff --git a/clients/client-cloudformation/commands/DescribeStackResourcesCommand.ts b/clients/client-cloudformation/commands/DescribeStackResourcesCommand.ts index f931c7e08840..41ee24ca7ef0 100644 --- a/clients/client-cloudformation/commands/DescribeStackResourcesCommand.ts +++ b/clients/client-cloudformation/commands/DescribeStackResourcesCommand.ts @@ -41,6 +41,20 @@ export interface DescribeStackResourcesCommandOutput extends DescribeStackResour * StackName and PhysicalResourceId in the same * request.

* + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { CloudFormationClient, DescribeStackResourcesCommand } from "@aws-sdk/client-cloudformation"; // ES Modules import + * // const { CloudFormationClient, DescribeStackResourcesCommand } = require("@aws-sdk/client-cloudformation"); // CommonJS import + * const client = new CloudFormationClient(config); + * const command = new DescribeStackResourcesCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeStackResourcesCommandInput} for command's `input` shape. + * @see {@link DescribeStackResourcesCommandOutput} for command's `response` shape. + * @see {@link CloudFormationClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeStackResourcesCommand extends $Command< DescribeStackResourcesCommandInput, diff --git a/clients/client-cloudformation/commands/DescribeStackSetCommand.ts b/clients/client-cloudformation/commands/DescribeStackSetCommand.ts index 7954211dd49c..c892e2c06099 100644 --- a/clients/client-cloudformation/commands/DescribeStackSetCommand.ts +++ b/clients/client-cloudformation/commands/DescribeStackSetCommand.ts @@ -22,6 +22,20 @@ export interface DescribeStackSetCommandOutput extends DescribeStackSetOutput, _ /** *

Returns the description of the specified stack set.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { CloudFormationClient, DescribeStackSetCommand } from "@aws-sdk/client-cloudformation"; // ES Modules import + * // const { CloudFormationClient, DescribeStackSetCommand } = require("@aws-sdk/client-cloudformation"); // CommonJS import + * const client = new CloudFormationClient(config); + * const command = new DescribeStackSetCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeStackSetCommandInput} for command's `input` shape. + * @see {@link DescribeStackSetCommandOutput} for command's `response` shape. + * @see {@link CloudFormationClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeStackSetCommand extends $Command< DescribeStackSetCommandInput, diff --git a/clients/client-cloudformation/commands/DescribeStackSetOperationCommand.ts b/clients/client-cloudformation/commands/DescribeStackSetOperationCommand.ts index daf769659663..cdc94cdef410 100644 --- a/clients/client-cloudformation/commands/DescribeStackSetOperationCommand.ts +++ b/clients/client-cloudformation/commands/DescribeStackSetOperationCommand.ts @@ -22,6 +22,20 @@ export interface DescribeStackSetOperationCommandOutput extends DescribeStackSet /** *

Returns the description of the specified stack set operation.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { CloudFormationClient, DescribeStackSetOperationCommand } from "@aws-sdk/client-cloudformation"; // ES Modules import + * // const { CloudFormationClient, DescribeStackSetOperationCommand } = require("@aws-sdk/client-cloudformation"); // CommonJS import + * const client = new CloudFormationClient(config); + * const command = new DescribeStackSetOperationCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeStackSetOperationCommandInput} for command's `input` shape. + * @see {@link DescribeStackSetOperationCommandOutput} for command's `response` shape. + * @see {@link CloudFormationClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeStackSetOperationCommand extends $Command< DescribeStackSetOperationCommandInput, diff --git a/clients/client-cloudformation/commands/DescribeStacksCommand.ts b/clients/client-cloudformation/commands/DescribeStacksCommand.ts index de54f13d8a7e..73d1dad809aa 100644 --- a/clients/client-cloudformation/commands/DescribeStacksCommand.ts +++ b/clients/client-cloudformation/commands/DescribeStacksCommand.ts @@ -27,6 +27,20 @@ export interface DescribeStacksCommandOutput extends DescribeStacksOutput, __Met *

If the stack does not exist, an AmazonCloudFormationException is * returned.

* + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { CloudFormationClient, DescribeStacksCommand } from "@aws-sdk/client-cloudformation"; // ES Modules import + * // const { CloudFormationClient, DescribeStacksCommand } = require("@aws-sdk/client-cloudformation"); // CommonJS import + * const client = new CloudFormationClient(config); + * const command = new DescribeStacksCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeStacksCommandInput} for command's `input` shape. + * @see {@link DescribeStacksCommandOutput} for command's `response` shape. + * @see {@link CloudFormationClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeStacksCommand extends $Command< DescribeStacksCommandInput, diff --git a/clients/client-cloudformation/commands/DescribeTypeCommand.ts b/clients/client-cloudformation/commands/DescribeTypeCommand.ts index 444f3662b38b..caa2832a75db 100644 --- a/clients/client-cloudformation/commands/DescribeTypeCommand.ts +++ b/clients/client-cloudformation/commands/DescribeTypeCommand.ts @@ -20,6 +20,20 @@ export interface DescribeTypeCommandOutput extends DescribeTypeOutput, __Metadat /** *

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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { CloudFormationClient, DescribeTypeCommand } from "@aws-sdk/client-cloudformation"; // ES Modules import + * // const { CloudFormationClient, DescribeTypeCommand } = require("@aws-sdk/client-cloudformation"); // CommonJS import + * const client = new CloudFormationClient(config); + * const command = new DescribeTypeCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeTypeCommandInput} for command's `input` shape. + * @see {@link DescribeTypeCommandOutput} for command's `response` shape. + * @see {@link CloudFormationClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeTypeCommand extends $Command< DescribeTypeCommandInput, diff --git a/clients/client-cloudformation/commands/DescribeTypeRegistrationCommand.ts b/clients/client-cloudformation/commands/DescribeTypeRegistrationCommand.ts index 1df1ae6fe5d8..9ec3afd4ad39 100644 --- a/clients/client-cloudformation/commands/DescribeTypeRegistrationCommand.ts +++ b/clients/client-cloudformation/commands/DescribeTypeRegistrationCommand.ts @@ -30,6 +30,20 @@ export interface DescribeTypeRegistrationCommandOutput extends DescribeTypeRegis *

Once the registration request has completed, use * DescribeType * to return detailed information about an extension.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { CloudFormationClient, DescribeTypeRegistrationCommand } from "@aws-sdk/client-cloudformation"; // ES Modules import + * // const { CloudFormationClient, DescribeTypeRegistrationCommand } = require("@aws-sdk/client-cloudformation"); // CommonJS import + * const client = new CloudFormationClient(config); + * const command = new DescribeTypeRegistrationCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeTypeRegistrationCommandInput} for command's `input` shape. + * @see {@link DescribeTypeRegistrationCommandOutput} for command's `response` shape. + * @see {@link CloudFormationClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeTypeRegistrationCommand extends $Command< DescribeTypeRegistrationCommandInput, diff --git a/clients/client-cloudformation/commands/DetectStackDriftCommand.ts b/clients/client-cloudformation/commands/DetectStackDriftCommand.ts index 00afb463f283..48c8ace1c28b 100644 --- a/clients/client-cloudformation/commands/DetectStackDriftCommand.ts +++ b/clients/client-cloudformation/commands/DetectStackDriftCommand.ts @@ -42,6 +42,20 @@ export interface DetectStackDriftCommandOutput extends DetectStackDriftOutput, _ *

When detecting drift on a stack, AWS CloudFormation does not detect drift on any nested stacks * belonging to that stack. Perform DetectStackDrift directly on the nested stack * itself.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { CloudFormationClient, DetectStackDriftCommand } from "@aws-sdk/client-cloudformation"; // ES Modules import + * // const { CloudFormationClient, DetectStackDriftCommand } = require("@aws-sdk/client-cloudformation"); // CommonJS import + * const client = new CloudFormationClient(config); + * const command = new DetectStackDriftCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DetectStackDriftCommandInput} for command's `input` shape. + * @see {@link DetectStackDriftCommandOutput} for command's `response` shape. + * @see {@link CloudFormationClientResolvedConfig | config} for command's `input` shape. + * */ export class DetectStackDriftCommand extends $Command< DetectStackDriftCommandInput, diff --git a/clients/client-cloudformation/commands/DetectStackResourceDriftCommand.ts b/clients/client-cloudformation/commands/DetectStackResourceDriftCommand.ts index 1760befaf945..145a1fa10168 100644 --- a/clients/client-cloudformation/commands/DetectStackResourceDriftCommand.ts +++ b/clients/client-cloudformation/commands/DetectStackResourceDriftCommand.ts @@ -33,6 +33,20 @@ export interface DetectStackResourceDriftCommandOutput extends DetectStackResour * that support drift detection.

*

Resources that do not currently support drift detection cannot be checked. For a list * of resources that support drift detection, see Resources that Support Drift Detection.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { CloudFormationClient, DetectStackResourceDriftCommand } from "@aws-sdk/client-cloudformation"; // ES Modules import + * // const { CloudFormationClient, DetectStackResourceDriftCommand } = require("@aws-sdk/client-cloudformation"); // CommonJS import + * const client = new CloudFormationClient(config); + * const command = new DetectStackResourceDriftCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DetectStackResourceDriftCommandInput} for command's `input` shape. + * @see {@link DetectStackResourceDriftCommandOutput} for command's `response` shape. + * @see {@link CloudFormationClientResolvedConfig | config} for command's `input` shape. + * */ export class DetectStackResourceDriftCommand extends $Command< DetectStackResourceDriftCommandInput, diff --git a/clients/client-cloudformation/commands/DetectStackSetDriftCommand.ts b/clients/client-cloudformation/commands/DetectStackSetDriftCommand.ts index f7f79382d2d1..880816212c7c 100644 --- a/clients/client-cloudformation/commands/DetectStackSetDriftCommand.ts +++ b/clients/client-cloudformation/commands/DetectStackSetDriftCommand.ts @@ -66,6 +66,20 @@ export interface DetectStackSetDriftCommandOutput extends DetectStackSetDriftOut *

To stop a drift detection stack set operation, use * StopStackSetOperation * .

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { CloudFormationClient, DetectStackSetDriftCommand } from "@aws-sdk/client-cloudformation"; // ES Modules import + * // const { CloudFormationClient, DetectStackSetDriftCommand } = require("@aws-sdk/client-cloudformation"); // CommonJS import + * const client = new CloudFormationClient(config); + * const command = new DetectStackSetDriftCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DetectStackSetDriftCommandInput} for command's `input` shape. + * @see {@link DetectStackSetDriftCommandOutput} for command's `response` shape. + * @see {@link CloudFormationClientResolvedConfig | config} for command's `input` shape. + * */ export class DetectStackSetDriftCommand extends $Command< DetectStackSetDriftCommandInput, diff --git a/clients/client-cloudformation/commands/EstimateTemplateCostCommand.ts b/clients/client-cloudformation/commands/EstimateTemplateCostCommand.ts index 7262a0db383c..bf6be6cfd0e6 100644 --- a/clients/client-cloudformation/commands/EstimateTemplateCostCommand.ts +++ b/clients/client-cloudformation/commands/EstimateTemplateCostCommand.ts @@ -24,6 +24,20 @@ export interface EstimateTemplateCostCommandOutput extends EstimateTemplateCostO *

Returns the estimated monthly cost of a template. The return value is an AWS Simple * Monthly Calculator URL with a query string that describes the resources required to run the * template.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { CloudFormationClient, EstimateTemplateCostCommand } from "@aws-sdk/client-cloudformation"; // ES Modules import + * // const { CloudFormationClient, EstimateTemplateCostCommand } = require("@aws-sdk/client-cloudformation"); // CommonJS import + * const client = new CloudFormationClient(config); + * const command = new EstimateTemplateCostCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link EstimateTemplateCostCommandInput} for command's `input` shape. + * @see {@link EstimateTemplateCostCommandOutput} for command's `response` shape. + * @see {@link CloudFormationClientResolvedConfig | config} for command's `input` shape. + * */ export class EstimateTemplateCostCommand extends $Command< EstimateTemplateCostCommandInput, diff --git a/clients/client-cloudformation/commands/ExecuteChangeSetCommand.ts b/clients/client-cloudformation/commands/ExecuteChangeSetCommand.ts index 7d69a01b010f..8935a2f1f268 100644 --- a/clients/client-cloudformation/commands/ExecuteChangeSetCommand.ts +++ b/clients/client-cloudformation/commands/ExecuteChangeSetCommand.ts @@ -32,6 +32,20 @@ export interface ExecuteChangeSetCommandOutput extends ExecuteChangeSetOutput, _ * current policy.

*

To create a change set for the entire stack hierachy, IncludeNestedStacks * must have been set to True.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { CloudFormationClient, ExecuteChangeSetCommand } from "@aws-sdk/client-cloudformation"; // ES Modules import + * // const { CloudFormationClient, ExecuteChangeSetCommand } = require("@aws-sdk/client-cloudformation"); // CommonJS import + * const client = new CloudFormationClient(config); + * const command = new ExecuteChangeSetCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ExecuteChangeSetCommandInput} for command's `input` shape. + * @see {@link ExecuteChangeSetCommandOutput} for command's `response` shape. + * @see {@link CloudFormationClientResolvedConfig | config} for command's `input` shape. + * */ export class ExecuteChangeSetCommand extends $Command< ExecuteChangeSetCommandInput, diff --git a/clients/client-cloudformation/commands/GetStackPolicyCommand.ts b/clients/client-cloudformation/commands/GetStackPolicyCommand.ts index 8eceb5a37c56..142ee988bc02 100644 --- a/clients/client-cloudformation/commands/GetStackPolicyCommand.ts +++ b/clients/client-cloudformation/commands/GetStackPolicyCommand.ts @@ -23,6 +23,20 @@ export interface GetStackPolicyCommandOutput extends GetStackPolicyOutput, __Met /** *

Returns the stack policy for a specified stack. If a stack doesn't have a policy, a * null value is returned.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { CloudFormationClient, GetStackPolicyCommand } from "@aws-sdk/client-cloudformation"; // ES Modules import + * // const { CloudFormationClient, GetStackPolicyCommand } = require("@aws-sdk/client-cloudformation"); // CommonJS import + * const client = new CloudFormationClient(config); + * const command = new GetStackPolicyCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetStackPolicyCommandInput} for command's `input` shape. + * @see {@link GetStackPolicyCommandOutput} for command's `response` shape. + * @see {@link CloudFormationClientResolvedConfig | config} for command's `input` shape. + * */ export class GetStackPolicyCommand extends $Command< GetStackPolicyCommandInput, diff --git a/clients/client-cloudformation/commands/GetTemplateCommand.ts b/clients/client-cloudformation/commands/GetTemplateCommand.ts index 70c5b46aa6e9..ba6bbdaaeff4 100644 --- a/clients/client-cloudformation/commands/GetTemplateCommand.ts +++ b/clients/client-cloudformation/commands/GetTemplateCommand.ts @@ -26,6 +26,20 @@ export interface GetTemplateCommandOutput extends GetTemplateOutput, __MetadataB *

If the template does not exist, a ValidationError is returned. *

* + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { CloudFormationClient, GetTemplateCommand } from "@aws-sdk/client-cloudformation"; // ES Modules import + * // const { CloudFormationClient, GetTemplateCommand } = require("@aws-sdk/client-cloudformation"); // CommonJS import + * const client = new CloudFormationClient(config); + * const command = new GetTemplateCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetTemplateCommandInput} for command's `input` shape. + * @see {@link GetTemplateCommandOutput} for command's `response` shape. + * @see {@link CloudFormationClientResolvedConfig | config} for command's `input` shape. + * */ export class GetTemplateCommand extends $Command< GetTemplateCommandInput, diff --git a/clients/client-cloudformation/commands/GetTemplateSummaryCommand.ts b/clients/client-cloudformation/commands/GetTemplateSummaryCommand.ts index adbdccbfdf78..5af7d9d5dbd2 100644 --- a/clients/client-cloudformation/commands/GetTemplateSummaryCommand.ts +++ b/clients/client-cloudformation/commands/GetTemplateSummaryCommand.ts @@ -30,6 +30,20 @@ export interface GetTemplateSummaryCommandOutput extends GetTemplateSummaryOutpu *

For deleted stacks, GetTemplateSummary returns the template information * for up to 90 days after the stack has been deleted. If the template does not exist, a * ValidationError is returned.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { CloudFormationClient, GetTemplateSummaryCommand } from "@aws-sdk/client-cloudformation"; // ES Modules import + * // const { CloudFormationClient, GetTemplateSummaryCommand } = require("@aws-sdk/client-cloudformation"); // CommonJS import + * const client = new CloudFormationClient(config); + * const command = new GetTemplateSummaryCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetTemplateSummaryCommandInput} for command's `input` shape. + * @see {@link GetTemplateSummaryCommandOutput} for command's `response` shape. + * @see {@link CloudFormationClientResolvedConfig | config} for command's `input` shape. + * */ export class GetTemplateSummaryCommand extends $Command< GetTemplateSummaryCommandInput, diff --git a/clients/client-cloudformation/commands/ListChangeSetsCommand.ts b/clients/client-cloudformation/commands/ListChangeSetsCommand.ts index b0fa95978fb6..60ae42783258 100644 --- a/clients/client-cloudformation/commands/ListChangeSetsCommand.ts +++ b/clients/client-cloudformation/commands/ListChangeSetsCommand.ts @@ -24,6 +24,20 @@ export interface ListChangeSetsCommandOutput extends ListChangeSetsOutput, __Met *

Returns the ID and status of each active change set for a stack. For example, AWS * CloudFormation lists change sets that are in the CREATE_IN_PROGRESS or * CREATE_PENDING state.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { CloudFormationClient, ListChangeSetsCommand } from "@aws-sdk/client-cloudformation"; // ES Modules import + * // const { CloudFormationClient, ListChangeSetsCommand } = require("@aws-sdk/client-cloudformation"); // CommonJS import + * const client = new CloudFormationClient(config); + * const command = new ListChangeSetsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListChangeSetsCommandInput} for command's `input` shape. + * @see {@link ListChangeSetsCommandOutput} for command's `response` shape. + * @see {@link CloudFormationClientResolvedConfig | config} for command's `input` shape. + * */ export class ListChangeSetsCommand extends $Command< ListChangeSetsCommandInput, diff --git a/clients/client-cloudformation/commands/ListExportsCommand.ts b/clients/client-cloudformation/commands/ListExportsCommand.ts index 31f2d257b1dd..b2d8a1cbe945 100644 --- a/clients/client-cloudformation/commands/ListExportsCommand.ts +++ b/clients/client-cloudformation/commands/ListExportsCommand.ts @@ -25,6 +25,20 @@ export interface ListExportsCommandOutput extends ListExportsOutput, __MetadataB * function.

*

For more information, see AWS * CloudFormation Export Stack Output Values.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { CloudFormationClient, ListExportsCommand } from "@aws-sdk/client-cloudformation"; // ES Modules import + * // const { CloudFormationClient, ListExportsCommand } = require("@aws-sdk/client-cloudformation"); // CommonJS import + * const client = new CloudFormationClient(config); + * const command = new ListExportsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListExportsCommandInput} for command's `input` shape. + * @see {@link ListExportsCommandOutput} for command's `response` shape. + * @see {@link CloudFormationClientResolvedConfig | config} for command's `input` shape. + * */ export class ListExportsCommand extends $Command< ListExportsCommandInput, diff --git a/clients/client-cloudformation/commands/ListImportsCommand.ts b/clients/client-cloudformation/commands/ListImportsCommand.ts index d1440aadd1d1..2e17bd68e88a 100644 --- a/clients/client-cloudformation/commands/ListImportsCommand.ts +++ b/clients/client-cloudformation/commands/ListImportsCommand.ts @@ -24,6 +24,20 @@ export interface ListImportsCommandOutput extends ListImportsOutput, __MetadataB *

For more information about importing an exported output value, see the * Fn::ImportValue * function.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { CloudFormationClient, ListImportsCommand } from "@aws-sdk/client-cloudformation"; // ES Modules import + * // const { CloudFormationClient, ListImportsCommand } = require("@aws-sdk/client-cloudformation"); // CommonJS import + * const client = new CloudFormationClient(config); + * const command = new ListImportsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListImportsCommandInput} for command's `input` shape. + * @see {@link ListImportsCommandOutput} for command's `response` shape. + * @see {@link CloudFormationClientResolvedConfig | config} for command's `input` shape. + * */ export class ListImportsCommand extends $Command< ListImportsCommandInput, diff --git a/clients/client-cloudformation/commands/ListStackInstancesCommand.ts b/clients/client-cloudformation/commands/ListStackInstancesCommand.ts index 538b396e7f00..b40b79f04b9f 100644 --- a/clients/client-cloudformation/commands/ListStackInstancesCommand.ts +++ b/clients/client-cloudformation/commands/ListStackInstancesCommand.ts @@ -24,6 +24,20 @@ export interface ListStackInstancesCommandOutput extends ListStackInstancesOutpu *

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 * AWS account name or Region, or that have a specific status.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { CloudFormationClient, ListStackInstancesCommand } from "@aws-sdk/client-cloudformation"; // ES Modules import + * // const { CloudFormationClient, ListStackInstancesCommand } = require("@aws-sdk/client-cloudformation"); // CommonJS import + * const client = new CloudFormationClient(config); + * const command = new ListStackInstancesCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListStackInstancesCommandInput} for command's `input` shape. + * @see {@link ListStackInstancesCommandOutput} for command's `response` shape. + * @see {@link CloudFormationClientResolvedConfig | config} for command's `input` shape. + * */ export class ListStackInstancesCommand extends $Command< ListStackInstancesCommandInput, diff --git a/clients/client-cloudformation/commands/ListStackResourcesCommand.ts b/clients/client-cloudformation/commands/ListStackResourcesCommand.ts index 54cb3c58d2f6..cee910d2e84d 100644 --- a/clients/client-cloudformation/commands/ListStackResourcesCommand.ts +++ b/clients/client-cloudformation/commands/ListStackResourcesCommand.ts @@ -24,6 +24,20 @@ export interface ListStackResourcesCommandOutput extends ListStackResourcesOutpu *

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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { CloudFormationClient, ListStackResourcesCommand } from "@aws-sdk/client-cloudformation"; // ES Modules import + * // const { CloudFormationClient, ListStackResourcesCommand } = require("@aws-sdk/client-cloudformation"); // CommonJS import + * const client = new CloudFormationClient(config); + * const command = new ListStackResourcesCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListStackResourcesCommandInput} for command's `input` shape. + * @see {@link ListStackResourcesCommandOutput} for command's `response` shape. + * @see {@link CloudFormationClientResolvedConfig | config} for command's `input` shape. + * */ export class ListStackResourcesCommand extends $Command< ListStackResourcesCommandInput, diff --git a/clients/client-cloudformation/commands/ListStackSetOperationResultsCommand.ts b/clients/client-cloudformation/commands/ListStackSetOperationResultsCommand.ts index 6e6632bccb06..3f081d71014f 100644 --- a/clients/client-cloudformation/commands/ListStackSetOperationResultsCommand.ts +++ b/clients/client-cloudformation/commands/ListStackSetOperationResultsCommand.ts @@ -24,6 +24,20 @@ export interface ListStackSetOperationResultsCommandOutput /** *

Returns summary information about the results of a stack set operation.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { CloudFormationClient, ListStackSetOperationResultsCommand } from "@aws-sdk/client-cloudformation"; // ES Modules import + * // const { CloudFormationClient, ListStackSetOperationResultsCommand } = require("@aws-sdk/client-cloudformation"); // CommonJS import + * const client = new CloudFormationClient(config); + * const command = new ListStackSetOperationResultsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListStackSetOperationResultsCommandInput} for command's `input` shape. + * @see {@link ListStackSetOperationResultsCommandOutput} for command's `response` shape. + * @see {@link CloudFormationClientResolvedConfig | config} for command's `input` shape. + * */ export class ListStackSetOperationResultsCommand extends $Command< ListStackSetOperationResultsCommandInput, diff --git a/clients/client-cloudformation/commands/ListStackSetOperationsCommand.ts b/clients/client-cloudformation/commands/ListStackSetOperationsCommand.ts index 3af8811bb4d1..3fe7eab53ac0 100644 --- a/clients/client-cloudformation/commands/ListStackSetOperationsCommand.ts +++ b/clients/client-cloudformation/commands/ListStackSetOperationsCommand.ts @@ -22,6 +22,20 @@ export interface ListStackSetOperationsCommandOutput extends ListStackSetOperati /** *

Returns summary information about operations performed on a stack set.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { CloudFormationClient, ListStackSetOperationsCommand } from "@aws-sdk/client-cloudformation"; // ES Modules import + * // const { CloudFormationClient, ListStackSetOperationsCommand } = require("@aws-sdk/client-cloudformation"); // CommonJS import + * const client = new CloudFormationClient(config); + * const command = new ListStackSetOperationsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListStackSetOperationsCommandInput} for command's `input` shape. + * @see {@link ListStackSetOperationsCommandOutput} for command's `response` shape. + * @see {@link CloudFormationClientResolvedConfig | config} for command's `input` shape. + * */ export class ListStackSetOperationsCommand extends $Command< ListStackSetOperationsCommandInput, diff --git a/clients/client-cloudformation/commands/ListStackSetsCommand.ts b/clients/client-cloudformation/commands/ListStackSetsCommand.ts index 898adf178221..af6152a73a09 100644 --- a/clients/client-cloudformation/commands/ListStackSetsCommand.ts +++ b/clients/client-cloudformation/commands/ListStackSetsCommand.ts @@ -34,6 +34,20 @@ export interface ListStackSetsCommandOutput extends ListStackSetsOutput, __Metad *

[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.

* * + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { CloudFormationClient, ListStackSetsCommand } from "@aws-sdk/client-cloudformation"; // ES Modules import + * // const { CloudFormationClient, ListStackSetsCommand } = require("@aws-sdk/client-cloudformation"); // CommonJS import + * const client = new CloudFormationClient(config); + * const command = new ListStackSetsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListStackSetsCommandInput} for command's `input` shape. + * @see {@link ListStackSetsCommandOutput} for command's `response` shape. + * @see {@link CloudFormationClientResolvedConfig | config} for command's `input` shape. + * */ export class ListStackSetsCommand extends $Command< ListStackSetsCommandInput, diff --git a/clients/client-cloudformation/commands/ListStacksCommand.ts b/clients/client-cloudformation/commands/ListStacksCommand.ts index 5433c30ee9ca..60dac0ea1782 100644 --- a/clients/client-cloudformation/commands/ListStacksCommand.ts +++ b/clients/client-cloudformation/commands/ListStacksCommand.ts @@ -23,6 +23,20 @@ export interface ListStacksCommandOutput extends ListStacksOutput, __MetadataBea * 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).

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { CloudFormationClient, ListStacksCommand } from "@aws-sdk/client-cloudformation"; // ES Modules import + * // const { CloudFormationClient, ListStacksCommand } = require("@aws-sdk/client-cloudformation"); // CommonJS import + * const client = new CloudFormationClient(config); + * const command = new ListStacksCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListStacksCommandInput} for command's `input` shape. + * @see {@link ListStacksCommandOutput} for command's `response` shape. + * @see {@link CloudFormationClientResolvedConfig | config} for command's `input` shape. + * */ export class ListStacksCommand extends $Command< ListStacksCommandInput, diff --git a/clients/client-cloudformation/commands/ListTypeRegistrationsCommand.ts b/clients/client-cloudformation/commands/ListTypeRegistrationsCommand.ts index ebe73bd82ed2..291da655dd6f 100644 --- a/clients/client-cloudformation/commands/ListTypeRegistrationsCommand.ts +++ b/clients/client-cloudformation/commands/ListTypeRegistrationsCommand.ts @@ -22,6 +22,20 @@ export interface ListTypeRegistrationsCommandOutput extends ListTypeRegistration /** *

Returns a list of registration tokens for the specified extension(s).

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { CloudFormationClient, ListTypeRegistrationsCommand } from "@aws-sdk/client-cloudformation"; // ES Modules import + * // const { CloudFormationClient, ListTypeRegistrationsCommand } = require("@aws-sdk/client-cloudformation"); // CommonJS import + * const client = new CloudFormationClient(config); + * const command = new ListTypeRegistrationsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListTypeRegistrationsCommandInput} for command's `input` shape. + * @see {@link ListTypeRegistrationsCommandOutput} for command's `response` shape. + * @see {@link CloudFormationClientResolvedConfig | config} for command's `input` shape. + * */ export class ListTypeRegistrationsCommand extends $Command< ListTypeRegistrationsCommandInput, diff --git a/clients/client-cloudformation/commands/ListTypeVersionsCommand.ts b/clients/client-cloudformation/commands/ListTypeVersionsCommand.ts index 0c19ba70233c..c2b437de9df9 100644 --- a/clients/client-cloudformation/commands/ListTypeVersionsCommand.ts +++ b/clients/client-cloudformation/commands/ListTypeVersionsCommand.ts @@ -22,6 +22,20 @@ export interface ListTypeVersionsCommandOutput extends ListTypeVersionsOutput, _ /** *

Returns summary information about the versions of an extension.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { CloudFormationClient, ListTypeVersionsCommand } from "@aws-sdk/client-cloudformation"; // ES Modules import + * // const { CloudFormationClient, ListTypeVersionsCommand } = require("@aws-sdk/client-cloudformation"); // CommonJS import + * const client = new CloudFormationClient(config); + * const command = new ListTypeVersionsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListTypeVersionsCommandInput} for command's `input` shape. + * @see {@link ListTypeVersionsCommandOutput} for command's `response` shape. + * @see {@link CloudFormationClientResolvedConfig | config} for command's `input` shape. + * */ export class ListTypeVersionsCommand extends $Command< ListTypeVersionsCommandInput, diff --git a/clients/client-cloudformation/commands/ListTypesCommand.ts b/clients/client-cloudformation/commands/ListTypesCommand.ts index ad8894f1e059..4071e1f53aef 100644 --- a/clients/client-cloudformation/commands/ListTypesCommand.ts +++ b/clients/client-cloudformation/commands/ListTypesCommand.ts @@ -19,6 +19,20 @@ export interface ListTypesCommandOutput extends ListTypesOutput, __MetadataBeare /** *

Returns summary information about extension that have been registered with CloudFormation.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { CloudFormationClient, ListTypesCommand } from "@aws-sdk/client-cloudformation"; // ES Modules import + * // const { CloudFormationClient, ListTypesCommand } = require("@aws-sdk/client-cloudformation"); // CommonJS import + * const client = new CloudFormationClient(config); + * const command = new ListTypesCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListTypesCommandInput} for command's `input` shape. + * @see {@link ListTypesCommandOutput} for command's `response` shape. + * @see {@link CloudFormationClientResolvedConfig | config} for command's `input` shape. + * */ export class ListTypesCommand extends $Command< ListTypesCommandInput, diff --git a/clients/client-cloudformation/commands/RecordHandlerProgressCommand.ts b/clients/client-cloudformation/commands/RecordHandlerProgressCommand.ts index 865216e6e84c..aec8bba60f03 100644 --- a/clients/client-cloudformation/commands/RecordHandlerProgressCommand.ts +++ b/clients/client-cloudformation/commands/RecordHandlerProgressCommand.ts @@ -23,6 +23,20 @@ export interface RecordHandlerProgressCommandOutput extends RecordHandlerProgres /** *

Reports progress of a resource handler to CloudFormation.

*

Reserved for use by the CloudFormation CLI. Do not use this API in your code.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { CloudFormationClient, RecordHandlerProgressCommand } from "@aws-sdk/client-cloudformation"; // ES Modules import + * // const { CloudFormationClient, RecordHandlerProgressCommand } = require("@aws-sdk/client-cloudformation"); // CommonJS import + * const client = new CloudFormationClient(config); + * const command = new RecordHandlerProgressCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link RecordHandlerProgressCommandInput} for command's `input` shape. + * @see {@link RecordHandlerProgressCommandOutput} for command's `response` shape. + * @see {@link CloudFormationClientResolvedConfig | config} for command's `input` shape. + * */ export class RecordHandlerProgressCommand extends $Command< RecordHandlerProgressCommandInput, diff --git a/clients/client-cloudformation/commands/RegisterTypeCommand.ts b/clients/client-cloudformation/commands/RegisterTypeCommand.ts index e58e6405b5e8..9ca698c21a99 100644 --- a/clients/client-cloudformation/commands/RegisterTypeCommand.ts +++ b/clients/client-cloudformation/commands/RegisterTypeCommand.ts @@ -37,6 +37,20 @@ export interface RegisterTypeCommandOutput extends RegisterTypeOutput, __Metadat * , you can use * DescribeTypeRegistration * to monitor the progress of the registration request.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { CloudFormationClient, RegisterTypeCommand } from "@aws-sdk/client-cloudformation"; // ES Modules import + * // const { CloudFormationClient, RegisterTypeCommand } = require("@aws-sdk/client-cloudformation"); // CommonJS import + * const client = new CloudFormationClient(config); + * const command = new RegisterTypeCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link RegisterTypeCommandInput} for command's `input` shape. + * @see {@link RegisterTypeCommandOutput} for command's `response` shape. + * @see {@link CloudFormationClientResolvedConfig | config} for command's `input` shape. + * */ export class RegisterTypeCommand extends $Command< RegisterTypeCommandInput, diff --git a/clients/client-cloudformation/commands/SetStackPolicyCommand.ts b/clients/client-cloudformation/commands/SetStackPolicyCommand.ts index 099355e77fb8..806e0dfc44cd 100644 --- a/clients/client-cloudformation/commands/SetStackPolicyCommand.ts +++ b/clients/client-cloudformation/commands/SetStackPolicyCommand.ts @@ -22,6 +22,20 @@ export interface SetStackPolicyCommandOutput extends __MetadataBearer {} /** *

Sets a stack policy for a specified stack.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { CloudFormationClient, SetStackPolicyCommand } from "@aws-sdk/client-cloudformation"; // ES Modules import + * // const { CloudFormationClient, SetStackPolicyCommand } = require("@aws-sdk/client-cloudformation"); // CommonJS import + * const client = new CloudFormationClient(config); + * const command = new SetStackPolicyCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link SetStackPolicyCommandInput} for command's `input` shape. + * @see {@link SetStackPolicyCommandOutput} for command's `response` shape. + * @see {@link CloudFormationClientResolvedConfig | config} for command's `input` shape. + * */ export class SetStackPolicyCommand extends $Command< SetStackPolicyCommandInput, diff --git a/clients/client-cloudformation/commands/SetTypeDefaultVersionCommand.ts b/clients/client-cloudformation/commands/SetTypeDefaultVersionCommand.ts index ab987f09e28c..afd229ec2664 100644 --- a/clients/client-cloudformation/commands/SetTypeDefaultVersionCommand.ts +++ b/clients/client-cloudformation/commands/SetTypeDefaultVersionCommand.ts @@ -22,6 +22,20 @@ export interface SetTypeDefaultVersionCommandOutput extends SetTypeDefaultVersio /** *

Specify the default version of an extension. The default version of an extension will be used in CloudFormation operations.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { CloudFormationClient, SetTypeDefaultVersionCommand } from "@aws-sdk/client-cloudformation"; // ES Modules import + * // const { CloudFormationClient, SetTypeDefaultVersionCommand } = require("@aws-sdk/client-cloudformation"); // CommonJS import + * const client = new CloudFormationClient(config); + * const command = new SetTypeDefaultVersionCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link SetTypeDefaultVersionCommandInput} for command's `input` shape. + * @see {@link SetTypeDefaultVersionCommandOutput} for command's `response` shape. + * @see {@link CloudFormationClientResolvedConfig | config} for command's `input` shape. + * */ export class SetTypeDefaultVersionCommand extends $Command< SetTypeDefaultVersionCommandInput, diff --git a/clients/client-cloudformation/commands/SignalResourceCommand.ts b/clients/client-cloudformation/commands/SignalResourceCommand.ts index 2c37317042c1..d416dc6994cb 100644 --- a/clients/client-cloudformation/commands/SignalResourceCommand.ts +++ b/clients/client-cloudformation/commands/SignalResourceCommand.ts @@ -27,6 +27,20 @@ export interface SignalResourceCommandOutput extends __MetadataBearer {} * required number of signals or the timeout period is exceeded. The SignalResource API is * useful in cases where you want to send signals from anywhere other than an Amazon EC2 * instance.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { CloudFormationClient, SignalResourceCommand } from "@aws-sdk/client-cloudformation"; // ES Modules import + * // const { CloudFormationClient, SignalResourceCommand } = require("@aws-sdk/client-cloudformation"); // CommonJS import + * const client = new CloudFormationClient(config); + * const command = new SignalResourceCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link SignalResourceCommandInput} for command's `input` shape. + * @see {@link SignalResourceCommandOutput} for command's `response` shape. + * @see {@link CloudFormationClientResolvedConfig | config} for command's `input` shape. + * */ export class SignalResourceCommand extends $Command< SignalResourceCommandInput, diff --git a/clients/client-cloudformation/commands/StopStackSetOperationCommand.ts b/clients/client-cloudformation/commands/StopStackSetOperationCommand.ts index d5b401c6b44c..a0156d7ada24 100644 --- a/clients/client-cloudformation/commands/StopStackSetOperationCommand.ts +++ b/clients/client-cloudformation/commands/StopStackSetOperationCommand.ts @@ -22,6 +22,20 @@ export interface StopStackSetOperationCommandOutput extends StopStackSetOperatio /** *

Stops an in-progress operation on a stack set and its associated stack instances.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { CloudFormationClient, StopStackSetOperationCommand } from "@aws-sdk/client-cloudformation"; // ES Modules import + * // const { CloudFormationClient, StopStackSetOperationCommand } = require("@aws-sdk/client-cloudformation"); // CommonJS import + * const client = new CloudFormationClient(config); + * const command = new StopStackSetOperationCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link StopStackSetOperationCommandInput} for command's `input` shape. + * @see {@link StopStackSetOperationCommandOutput} for command's `response` shape. + * @see {@link CloudFormationClientResolvedConfig | config} for command's `input` shape. + * */ export class StopStackSetOperationCommand extends $Command< StopStackSetOperationCommandInput, diff --git a/clients/client-cloudformation/commands/UpdateStackCommand.ts b/clients/client-cloudformation/commands/UpdateStackCommand.ts index 9f0789a67ca9..0ad5176497bc 100644 --- a/clients/client-cloudformation/commands/UpdateStackCommand.ts +++ b/clients/client-cloudformation/commands/UpdateStackCommand.ts @@ -24,6 +24,20 @@ export interface UpdateStackCommandOutput extends UpdateStackOutput, __MetadataB *

For more information about creating an update template, updating a stack, and * monitoring the progress of the update, see Updating a * Stack.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { CloudFormationClient, UpdateStackCommand } from "@aws-sdk/client-cloudformation"; // ES Modules import + * // const { CloudFormationClient, UpdateStackCommand } = require("@aws-sdk/client-cloudformation"); // CommonJS import + * const client = new CloudFormationClient(config); + * const command = new UpdateStackCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link UpdateStackCommandInput} for command's `input` shape. + * @see {@link UpdateStackCommandOutput} for command's `response` shape. + * @see {@link CloudFormationClientResolvedConfig | config} for command's `input` shape. + * */ export class UpdateStackCommand extends $Command< UpdateStackCommandInput, diff --git a/clients/client-cloudformation/commands/UpdateStackInstancesCommand.ts b/clients/client-cloudformation/commands/UpdateStackInstancesCommand.ts index fa4c2d2eed33..92386987c762 100644 --- a/clients/client-cloudformation/commands/UpdateStackInstancesCommand.ts +++ b/clients/client-cloudformation/commands/UpdateStackInstancesCommand.ts @@ -34,6 +34,20 @@ export interface UpdateStackInstancesCommandOutput extends UpdateStackInstancesO * 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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { CloudFormationClient, UpdateStackInstancesCommand } from "@aws-sdk/client-cloudformation"; // ES Modules import + * // const { CloudFormationClient, UpdateStackInstancesCommand } = require("@aws-sdk/client-cloudformation"); // CommonJS import + * const client = new CloudFormationClient(config); + * const command = new UpdateStackInstancesCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link UpdateStackInstancesCommandInput} for command's `input` shape. + * @see {@link UpdateStackInstancesCommandOutput} for command's `response` shape. + * @see {@link CloudFormationClientResolvedConfig | config} for command's `input` shape. + * */ export class UpdateStackInstancesCommand extends $Command< UpdateStackInstancesCommandInput, diff --git a/clients/client-cloudformation/commands/UpdateStackSetCommand.ts b/clients/client-cloudformation/commands/UpdateStackSetCommand.ts index 33906e6ad6e7..2933f0b757cd 100644 --- a/clients/client-cloudformation/commands/UpdateStackSetCommand.ts +++ b/clients/client-cloudformation/commands/UpdateStackSetCommand.ts @@ -27,6 +27,20 @@ export interface UpdateStackSetCommandOutput extends UpdateStackSetOutput, __Met * 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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { CloudFormationClient, UpdateStackSetCommand } from "@aws-sdk/client-cloudformation"; // ES Modules import + * // const { CloudFormationClient, UpdateStackSetCommand } = require("@aws-sdk/client-cloudformation"); // CommonJS import + * const client = new CloudFormationClient(config); + * const command = new UpdateStackSetCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link UpdateStackSetCommandInput} for command's `input` shape. + * @see {@link UpdateStackSetCommandOutput} for command's `response` shape. + * @see {@link CloudFormationClientResolvedConfig | config} for command's `input` shape. + * */ export class UpdateStackSetCommand extends $Command< UpdateStackSetCommandInput, diff --git a/clients/client-cloudformation/commands/UpdateTerminationProtectionCommand.ts b/clients/client-cloudformation/commands/UpdateTerminationProtectionCommand.ts index c815d028a1a3..8f2a6ee5e757 100644 --- a/clients/client-cloudformation/commands/UpdateTerminationProtectionCommand.ts +++ b/clients/client-cloudformation/commands/UpdateTerminationProtectionCommand.ts @@ -28,6 +28,20 @@ export interface UpdateTerminationProtectionCommandOutput extends UpdateTerminat *

For nested * stacks, termination protection is set on the root stack and cannot be changed * directly on the nested stack.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { CloudFormationClient, UpdateTerminationProtectionCommand } from "@aws-sdk/client-cloudformation"; // ES Modules import + * // const { CloudFormationClient, UpdateTerminationProtectionCommand } = require("@aws-sdk/client-cloudformation"); // CommonJS import + * const client = new CloudFormationClient(config); + * const command = new UpdateTerminationProtectionCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link UpdateTerminationProtectionCommandInput} for command's `input` shape. + * @see {@link UpdateTerminationProtectionCommandOutput} for command's `response` shape. + * @see {@link CloudFormationClientResolvedConfig | config} for command's `input` shape. + * */ export class UpdateTerminationProtectionCommand extends $Command< UpdateTerminationProtectionCommandInput, diff --git a/clients/client-cloudformation/commands/ValidateTemplateCommand.ts b/clients/client-cloudformation/commands/ValidateTemplateCommand.ts index 31efb2ab0def..3f470517900d 100644 --- a/clients/client-cloudformation/commands/ValidateTemplateCommand.ts +++ b/clients/client-cloudformation/commands/ValidateTemplateCommand.ts @@ -24,6 +24,20 @@ export interface ValidateTemplateCommandOutput extends ValidateTemplateOutput, _ *

Validates a specified template. AWS CloudFormation first checks if the template is * valid JSON. If it isn't, AWS CloudFormation checks if the template is valid YAML. If both * these checks fail, AWS CloudFormation returns a template validation error.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { CloudFormationClient, ValidateTemplateCommand } from "@aws-sdk/client-cloudformation"; // ES Modules import + * // const { CloudFormationClient, ValidateTemplateCommand } = require("@aws-sdk/client-cloudformation"); // CommonJS import + * const client = new CloudFormationClient(config); + * const command = new ValidateTemplateCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ValidateTemplateCommandInput} for command's `input` shape. + * @see {@link ValidateTemplateCommandOutput} for command's `response` shape. + * @see {@link CloudFormationClientResolvedConfig | config} for command's `input` shape. + * */ export class ValidateTemplateCommand extends $Command< ValidateTemplateCommandInput, diff --git a/clients/client-cloudformation/models/models_0.ts b/clients/client-cloudformation/models/models_0.ts index f38303c2b990..bcbb24befe6a 100644 --- a/clients/client-cloudformation/models/models_0.ts +++ b/clients/client-cloudformation/models/models_0.ts @@ -71,6 +71,9 @@ export interface AccountGateResult { } export namespace AccountGateResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: AccountGateResult): any => ({ ...obj, }); @@ -110,6 +113,9 @@ export interface AccountLimit { } export namespace AccountLimit { + /** + * @internal + */ export const filterSensitiveLog = (obj: AccountLimit): any => ({ ...obj, }); @@ -125,6 +131,9 @@ export interface AlreadyExistsException extends __SmithyException, $MetadataBear } export namespace AlreadyExistsException { + /** + * @internal + */ export const filterSensitiveLog = (obj: AlreadyExistsException): any => ({ ...obj, }); @@ -146,6 +155,9 @@ export interface AutoDeployment { } export namespace AutoDeployment { + /** + * @internal + */ export const filterSensitiveLog = (obj: AutoDeployment): any => ({ ...obj, }); @@ -176,6 +188,9 @@ export interface CancelUpdateStackInput { } export namespace CancelUpdateStackInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: CancelUpdateStackInput): any => ({ ...obj, }); @@ -191,6 +206,9 @@ export interface TokenAlreadyExistsException extends __SmithyException, $Metadat } export namespace TokenAlreadyExistsException { + /** + * @internal + */ export const filterSensitiveLog = (obj: TokenAlreadyExistsException): any => ({ ...obj, }); @@ -212,6 +230,9 @@ export interface CFNRegistryException extends __SmithyException, $MetadataBearer } export namespace CFNRegistryException { + /** + * @internal + */ export const filterSensitiveLog = (obj: CFNRegistryException): any => ({ ...obj, }); @@ -282,6 +303,9 @@ export interface ResourceTargetDefinition { } export namespace ResourceTargetDefinition { + /** + * @internal + */ export const filterSensitiveLog = (obj: ResourceTargetDefinition): any => ({ ...obj, }); @@ -370,6 +394,9 @@ export interface ResourceChangeDetail { } export namespace ResourceChangeDetail { + /** + * @internal + */ export const filterSensitiveLog = (obj: ResourceChangeDetail): any => ({ ...obj, }); @@ -401,6 +428,9 @@ export interface ModuleInfo { } export namespace ModuleInfo { + /** + * @internal + */ export const filterSensitiveLog = (obj: ModuleInfo): any => ({ ...obj, }); @@ -485,6 +515,9 @@ export interface ResourceChange { } export namespace ResourceChange { + /** + * @internal + */ export const filterSensitiveLog = (obj: ResourceChange): any => ({ ...obj, }); @@ -513,6 +546,9 @@ export interface Change { } export namespace Change { + /** + * @internal + */ export const filterSensitiveLog = (obj: Change): any => ({ ...obj, }); @@ -529,6 +565,9 @@ export interface ChangeSetNotFoundException extends __SmithyException, $Metadata } export namespace ChangeSetNotFoundException { + /** + * @internal + */ export const filterSensitiveLog = (obj: ChangeSetNotFoundException): any => ({ ...obj, }); @@ -628,6 +667,9 @@ export interface ChangeSetSummary { } export namespace ChangeSetSummary { + /** + * @internal + */ export const filterSensitiveLog = (obj: ChangeSetSummary): any => ({ ...obj, }); @@ -712,6 +754,9 @@ export interface ContinueUpdateRollbackInput { } export namespace ContinueUpdateRollbackInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: ContinueUpdateRollbackInput): any => ({ ...obj, }); @@ -723,6 +768,9 @@ export namespace ContinueUpdateRollbackInput { export interface ContinueUpdateRollbackOutput {} export namespace ContinueUpdateRollbackOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: ContinueUpdateRollbackOutput): any => ({ ...obj, }); @@ -760,6 +808,9 @@ export interface Parameter { } export namespace Parameter { + /** + * @internal + */ export const filterSensitiveLog = (obj: Parameter): any => ({ ...obj, }); @@ -788,6 +839,9 @@ export interface ResourceToImport { } export namespace ResourceToImport { + /** + * @internal + */ export const filterSensitiveLog = (obj: ResourceToImport): any => ({ ...obj, }); @@ -814,6 +868,9 @@ export interface RollbackTrigger { } export namespace RollbackTrigger { + /** + * @internal + */ export const filterSensitiveLog = (obj: RollbackTrigger): any => ({ ...obj, }); @@ -874,6 +931,9 @@ export interface RollbackConfiguration { } export namespace RollbackConfiguration { + /** + * @internal + */ export const filterSensitiveLog = (obj: RollbackConfiguration): any => ({ ...obj, }); @@ -901,6 +961,9 @@ export interface Tag { } export namespace Tag { + /** + * @internal + */ export const filterSensitiveLog = (obj: Tag): any => ({ ...obj, }); @@ -1151,6 +1214,9 @@ export interface CreateChangeSetInput { } export namespace CreateChangeSetInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateChangeSetInput): any => ({ ...obj, }); @@ -1172,6 +1238,9 @@ export interface CreateChangeSetOutput { } export namespace CreateChangeSetOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateChangeSetOutput): any => ({ ...obj, }); @@ -1188,6 +1257,9 @@ export interface InsufficientCapabilitiesException extends __SmithyException, $M } export namespace InsufficientCapabilitiesException { + /** + * @internal + */ export const filterSensitiveLog = (obj: InsufficientCapabilitiesException): any => ({ ...obj, }); @@ -1205,6 +1277,9 @@ export interface LimitExceededException extends __SmithyException, $MetadataBear } export namespace LimitExceededException { + /** + * @internal + */ export const filterSensitiveLog = (obj: LimitExceededException): any => ({ ...obj, }); @@ -1488,6 +1563,9 @@ export interface CreateStackInput { } export namespace CreateStackInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateStackInput): any => ({ ...obj, }); @@ -1504,6 +1582,9 @@ export interface CreateStackOutput { } export namespace CreateStackOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateStackOutput): any => ({ ...obj, }); @@ -1531,6 +1612,9 @@ export interface DeploymentTargets { } export namespace DeploymentTargets { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeploymentTargets): any => ({ ...obj, }); @@ -1608,6 +1692,9 @@ export interface StackSetOperationPreferences { } export namespace StackSetOperationPreferences { + /** + * @internal + */ export const filterSensitiveLog = (obj: StackSetOperationPreferences): any => ({ ...obj, }); @@ -1714,6 +1801,9 @@ export interface CreateStackInstancesInput { } export namespace CreateStackInstancesInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateStackInstancesInput): any => ({ ...obj, }); @@ -1727,6 +1817,9 @@ export interface CreateStackInstancesOutput { } export namespace CreateStackInstancesOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateStackInstancesOutput): any => ({ ...obj, }); @@ -1742,6 +1835,9 @@ export interface InvalidOperationException extends __SmithyException, $MetadataB } export namespace InvalidOperationException { + /** + * @internal + */ export const filterSensitiveLog = (obj: InvalidOperationException): any => ({ ...obj, }); @@ -1757,6 +1853,9 @@ export interface OperationIdAlreadyExistsException extends __SmithyException, $M } export namespace OperationIdAlreadyExistsException { + /** + * @internal + */ export const filterSensitiveLog = (obj: OperationIdAlreadyExistsException): any => ({ ...obj, }); @@ -1773,6 +1872,9 @@ export interface OperationInProgressException extends __SmithyException, $Metada } export namespace OperationInProgressException { + /** + * @internal + */ export const filterSensitiveLog = (obj: OperationInProgressException): any => ({ ...obj, }); @@ -1788,6 +1890,9 @@ export interface StackSetNotFoundException extends __SmithyException, $MetadataB } export namespace StackSetNotFoundException { + /** + * @internal + */ export const filterSensitiveLog = (obj: StackSetNotFoundException): any => ({ ...obj, }); @@ -1804,6 +1909,9 @@ export interface StaleRequestException extends __SmithyException, $MetadataBeare } export namespace StaleRequestException { + /** + * @internal + */ export const filterSensitiveLog = (obj: StaleRequestException): any => ({ ...obj, }); @@ -1819,6 +1927,9 @@ export interface CreatedButModifiedException extends __SmithyException, $Metadat } export namespace CreatedButModifiedException { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreatedButModifiedException): any => ({ ...obj, }); @@ -2045,6 +2156,9 @@ export interface CreateStackSetInput { } export namespace CreateStackSetInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateStackSetInput): any => ({ ...obj, }); @@ -2058,6 +2172,9 @@ export interface CreateStackSetOutput { } export namespace CreateStackSetOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateStackSetOutput): any => ({ ...obj, }); @@ -2073,6 +2190,9 @@ export interface NameAlreadyExistsException extends __SmithyException, $Metadata } export namespace NameAlreadyExistsException { + /** + * @internal + */ export const filterSensitiveLog = (obj: NameAlreadyExistsException): any => ({ ...obj, }); @@ -2096,6 +2216,9 @@ export interface DeleteChangeSetInput { } export namespace DeleteChangeSetInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteChangeSetInput): any => ({ ...obj, }); @@ -2107,6 +2230,9 @@ export namespace DeleteChangeSetInput { export interface DeleteChangeSetOutput {} export namespace DeleteChangeSetOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteChangeSetOutput): any => ({ ...obj, }); @@ -2124,6 +2250,9 @@ export interface InvalidChangeSetStatusException extends __SmithyException, $Met } export namespace InvalidChangeSetStatusException { + /** + * @internal + */ export const filterSensitiveLog = (obj: InvalidChangeSetStatusException): any => ({ ...obj, }); @@ -2178,6 +2307,9 @@ export interface DeleteStackInput { } export namespace DeleteStackInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteStackInput): any => ({ ...obj, }); @@ -2249,6 +2381,9 @@ export interface DeleteStackInstancesInput { } export namespace DeleteStackInstancesInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteStackInstancesInput): any => ({ ...obj, }); @@ -2262,6 +2397,9 @@ export interface DeleteStackInstancesOutput { } export namespace DeleteStackInstancesOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteStackInstancesOutput): any => ({ ...obj, }); @@ -2291,6 +2429,9 @@ export interface DeleteStackSetInput { } export namespace DeleteStackSetInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteStackSetInput): any => ({ ...obj, }); @@ -2299,6 +2440,9 @@ export namespace DeleteStackSetInput { export interface DeleteStackSetOutput {} export namespace DeleteStackSetOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteStackSetOutput): any => ({ ...obj, }); @@ -2316,6 +2460,9 @@ export interface StackSetNotEmptyException extends __SmithyException, $MetadataB } export namespace StackSetNotEmptyException { + /** + * @internal + */ export const filterSensitiveLog = (obj: StackSetNotEmptyException): any => ({ ...obj, }); @@ -2349,6 +2496,9 @@ export interface DeregisterTypeInput { } export namespace DeregisterTypeInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeregisterTypeInput): any => ({ ...obj, }); @@ -2357,6 +2507,9 @@ export namespace DeregisterTypeInput { export interface DeregisterTypeOutput {} export namespace DeregisterTypeOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeregisterTypeOutput): any => ({ ...obj, }); @@ -2372,6 +2525,9 @@ export interface TypeNotFoundException extends __SmithyException, $MetadataBeare } export namespace TypeNotFoundException { + /** + * @internal + */ export const filterSensitiveLog = (obj: TypeNotFoundException): any => ({ ...obj, }); @@ -2388,6 +2544,9 @@ export interface DescribeAccountLimitsInput { } export namespace DescribeAccountLimitsInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeAccountLimitsInput): any => ({ ...obj, }); @@ -2411,6 +2570,9 @@ export interface DescribeAccountLimitsOutput { } export namespace DescribeAccountLimitsOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeAccountLimitsOutput): any => ({ ...obj, }); @@ -2440,6 +2602,9 @@ export interface DescribeChangeSetInput { } export namespace DescribeChangeSetInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeChangeSetInput): any => ({ ...obj, }); @@ -2559,6 +2724,9 @@ export interface DescribeChangeSetOutput { } export namespace DescribeChangeSetOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeChangeSetOutput): any => ({ ...obj, }); @@ -2575,6 +2743,9 @@ export interface DescribeStackDriftDetectionStatusInput { } export namespace DescribeStackDriftDetectionStatusInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeStackDriftDetectionStatusInput): any => ({ ...obj, }); @@ -2680,6 +2851,9 @@ export interface DescribeStackDriftDetectionStatusOutput { } export namespace DescribeStackDriftDetectionStatusOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeStackDriftDetectionStatusOutput): any => ({ ...obj, }); @@ -2712,6 +2886,9 @@ export interface DescribeStackEventsInput { } export namespace DescribeStackEventsInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeStackEventsInput): any => ({ ...obj, }); @@ -2810,6 +2987,9 @@ export interface StackEvent { } export namespace StackEvent { + /** + * @internal + */ export const filterSensitiveLog = (obj: StackEvent): any => ({ ...obj, }); @@ -2832,6 +3012,9 @@ export interface DescribeStackEventsOutput { } export namespace DescribeStackEventsOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeStackEventsOutput): any => ({ ...obj, }); @@ -2871,6 +3054,9 @@ export interface DescribeStackInstanceInput { } export namespace DescribeStackInstanceInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeStackInstanceInput): any => ({ ...obj, }); @@ -2916,6 +3102,9 @@ export interface StackInstanceComprehensiveStatus { } export namespace StackInstanceComprehensiveStatus { + /** + * @internal + */ export const filterSensitiveLog = (obj: StackInstanceComprehensiveStatus): any => ({ ...obj, }); @@ -3051,6 +3240,9 @@ export interface StackInstance { } export namespace StackInstance { + /** + * @internal + */ export const filterSensitiveLog = (obj: StackInstance): any => ({ ...obj, }); @@ -3064,6 +3256,9 @@ export interface DescribeStackInstanceOutput { } export namespace DescribeStackInstanceOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeStackInstanceOutput): any => ({ ...obj, }); @@ -3079,6 +3274,9 @@ export interface StackInstanceNotFoundException extends __SmithyException, $Meta } export namespace StackInstanceNotFoundException { + /** + * @internal + */ export const filterSensitiveLog = (obj: StackInstanceNotFoundException): any => ({ ...obj, }); @@ -3112,6 +3310,9 @@ export interface DescribeStackResourceInput { } export namespace DescribeStackResourceInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeStackResourceInput): any => ({ ...obj, }); @@ -3167,6 +3368,9 @@ export interface StackResourceDriftInformation { } export namespace StackResourceDriftInformation { + /** + * @internal + */ export const filterSensitiveLog = (obj: StackResourceDriftInformation): any => ({ ...obj, }); @@ -3245,6 +3449,9 @@ export interface StackResourceDetail { } export namespace StackResourceDetail { + /** + * @internal + */ export const filterSensitiveLog = (obj: StackResourceDetail): any => ({ ...obj, }); @@ -3262,6 +3469,9 @@ export interface DescribeStackResourceOutput { } export namespace DescribeStackResourceOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeStackResourceOutput): any => ({ ...obj, }); @@ -3315,6 +3525,9 @@ export interface DescribeStackResourceDriftsInput { } export namespace DescribeStackResourceDriftsInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeStackResourceDriftsInput): any => ({ ...obj, }); @@ -3339,6 +3552,9 @@ export interface PhysicalResourceIdContextKeyValuePair { } export namespace PhysicalResourceIdContextKeyValuePair { + /** + * @internal + */ export const filterSensitiveLog = (obj: PhysicalResourceIdContextKeyValuePair): any => ({ ...obj, }); @@ -3399,6 +3615,9 @@ export interface PropertyDifference { } export namespace PropertyDifference { + /** + * @internal + */ export const filterSensitiveLog = (obj: PropertyDifference): any => ({ ...obj, }); @@ -3511,6 +3730,9 @@ export interface StackResourceDrift { } export namespace StackResourceDrift { + /** + * @internal + */ export const filterSensitiveLog = (obj: StackResourceDrift): any => ({ ...obj, }); @@ -3540,6 +3762,9 @@ export interface DescribeStackResourceDriftsOutput { } export namespace DescribeStackResourceDriftsOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeStackResourceDriftsOutput): any => ({ ...obj, }); @@ -3588,6 +3813,9 @@ export interface DescribeStackResourcesInput { } export namespace DescribeStackResourcesInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeStackResourcesInput): any => ({ ...obj, }); @@ -3659,6 +3887,9 @@ export interface StackResource { } export namespace StackResource { + /** + * @internal + */ export const filterSensitiveLog = (obj: StackResource): any => ({ ...obj, }); @@ -3675,6 +3906,9 @@ export interface DescribeStackResourcesOutput { } export namespace DescribeStackResourcesOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeStackResourcesOutput): any => ({ ...obj, }); @@ -3707,6 +3941,9 @@ export interface DescribeStacksInput { } export namespace DescribeStacksInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeStacksInput): any => ({ ...obj, }); @@ -3755,6 +3992,9 @@ export interface StackDriftInformation { } export namespace StackDriftInformation { + /** + * @internal + */ export const filterSensitiveLog = (obj: StackDriftInformation): any => ({ ...obj, }); @@ -3786,6 +4026,9 @@ export interface Output { } export namespace Output { + /** + * @internal + */ export const filterSensitiveLog = (obj: Output): any => ({ ...obj, }); @@ -3960,6 +4203,9 @@ export interface Stack { } export namespace Stack { + /** + * @internal + */ export const filterSensitiveLog = (obj: Stack): any => ({ ...obj, }); @@ -3982,6 +4228,9 @@ export interface DescribeStacksOutput { } export namespace DescribeStacksOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeStacksOutput): any => ({ ...obj, }); @@ -4010,6 +4259,9 @@ export interface DescribeStackSetInput { } export namespace DescribeStackSetInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeStackSetInput): any => ({ ...obj, }); @@ -4150,6 +4402,9 @@ export interface StackSetDriftDetectionDetails { } export namespace StackSetDriftDetectionDetails { + /** + * @internal + */ export const filterSensitiveLog = (obj: StackSetDriftDetectionDetails): any => ({ ...obj, }); @@ -4265,6 +4520,9 @@ export interface StackSet { } export namespace StackSet { + /** + * @internal + */ export const filterSensitiveLog = (obj: StackSet): any => ({ ...obj, }); @@ -4278,6 +4536,9 @@ export interface DescribeStackSetOutput { } export namespace DescribeStackSetOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeStackSetOutput): any => ({ ...obj, }); @@ -4311,6 +4572,9 @@ export interface DescribeStackSetOperationInput { } export namespace DescribeStackSetOperationInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeStackSetOperationInput): any => ({ ...obj, }); @@ -4447,6 +4711,9 @@ export interface StackSetOperation { } export namespace StackSetOperation { + /** + * @internal + */ export const filterSensitiveLog = (obj: StackSetOperation): any => ({ ...obj, }); @@ -4460,6 +4727,9 @@ export interface DescribeStackSetOperationOutput { } export namespace DescribeStackSetOperationOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeStackSetOperationOutput): any => ({ ...obj, }); @@ -4475,6 +4745,9 @@ export interface OperationNotFoundException extends __SmithyException, $Metadata } export namespace OperationNotFoundException { + /** + * @internal + */ export const filterSensitiveLog = (obj: OperationNotFoundException): any => ({ ...obj, }); @@ -4507,6 +4780,9 @@ export interface DescribeTypeInput { } export namespace DescribeTypeInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeTypeInput): any => ({ ...obj, }); @@ -4530,6 +4806,9 @@ export interface LoggingConfig { } export namespace LoggingConfig { + /** + * @internal + */ export const filterSensitiveLog = (obj: LoggingConfig): any => ({ ...obj, }); @@ -4681,6 +4960,9 @@ export interface DescribeTypeOutput { } export namespace DescribeTypeOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeTypeOutput): any => ({ ...obj, }); @@ -4697,6 +4979,9 @@ export interface DescribeTypeRegistrationInput { } export namespace DescribeTypeRegistrationInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeTypeRegistrationInput): any => ({ ...obj, }); @@ -4729,6 +5014,9 @@ export interface DescribeTypeRegistrationOutput { } export namespace DescribeTypeRegistrationOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeTypeRegistrationOutput): any => ({ ...obj, }); @@ -4747,6 +5035,9 @@ export interface DetectStackDriftInput { } export namespace DetectStackDriftInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: DetectStackDriftInput): any => ({ ...obj, }); @@ -4763,6 +5054,9 @@ export interface DetectStackDriftOutput { } export namespace DetectStackDriftOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: DetectStackDriftOutput): any => ({ ...obj, }); @@ -4781,6 +5075,9 @@ export interface DetectStackResourceDriftInput { } export namespace DetectStackResourceDriftInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: DetectStackResourceDriftInput): any => ({ ...obj, }); @@ -4796,6 +5093,9 @@ export interface DetectStackResourceDriftOutput { } export namespace DetectStackResourceDriftOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: DetectStackResourceDriftOutput): any => ({ ...obj, }); @@ -4838,6 +5138,9 @@ export interface DetectStackSetDriftInput { } export namespace DetectStackSetDriftInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: DetectStackSetDriftInput): any => ({ ...obj, }); @@ -4854,6 +5157,9 @@ export interface DetectStackSetDriftOutput { } export namespace DetectStackSetDriftOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: DetectStackSetDriftOutput): any => ({ ...obj, }); @@ -4889,6 +5195,9 @@ export interface EstimateTemplateCostInput { } export namespace EstimateTemplateCostInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: EstimateTemplateCostInput): any => ({ ...obj, }); @@ -4906,6 +5215,9 @@ export interface EstimateTemplateCostOutput { } export namespace EstimateTemplateCostOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: EstimateTemplateCostOutput): any => ({ ...obj, }); @@ -4938,6 +5250,9 @@ export interface ExecuteChangeSetInput { } export namespace ExecuteChangeSetInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: ExecuteChangeSetInput): any => ({ ...obj, }); @@ -4949,6 +5264,9 @@ export namespace ExecuteChangeSetInput { export interface ExecuteChangeSetOutput {} export namespace ExecuteChangeSetOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: ExecuteChangeSetOutput): any => ({ ...obj, }); @@ -4966,6 +5284,9 @@ export interface GetStackPolicyInput { } export namespace GetStackPolicyInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetStackPolicyInput): any => ({ ...obj, }); @@ -4983,6 +5304,9 @@ export interface GetStackPolicyOutput { } export namespace GetStackPolicyOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetStackPolicyOutput): any => ({ ...obj, }); @@ -5033,6 +5357,9 @@ export interface GetTemplateInput { } export namespace GetTemplateInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetTemplateInput): any => ({ ...obj, }); @@ -5060,6 +5387,9 @@ export interface GetTemplateOutput { } export namespace GetTemplateOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetTemplateOutput): any => ({ ...obj, }); @@ -5124,6 +5454,9 @@ export interface GetTemplateSummaryInput { } export namespace GetTemplateSummaryInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetTemplateSummaryInput): any => ({ ...obj, }); @@ -5142,6 +5475,9 @@ export interface ParameterConstraints { } export namespace ParameterConstraints { + /** + * @internal + */ export const filterSensitiveLog = (obj: ParameterConstraints): any => ({ ...obj, }); @@ -5184,6 +5520,9 @@ export interface ParameterDeclaration { } export namespace ParameterDeclaration { + /** + * @internal + */ export const filterSensitiveLog = (obj: ParameterDeclaration): any => ({ ...obj, }); @@ -5216,6 +5555,9 @@ export interface ResourceIdentifierSummary { } export namespace ResourceIdentifierSummary { + /** + * @internal + */ export const filterSensitiveLog = (obj: ResourceIdentifierSummary): any => ({ ...obj, }); @@ -5286,6 +5628,9 @@ export interface GetTemplateSummaryOutput { } export namespace GetTemplateSummaryOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetTemplateSummaryOutput): any => ({ ...obj, }); @@ -5309,6 +5654,9 @@ export interface ListChangeSetsInput { } export namespace ListChangeSetsInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListChangeSetsInput): any => ({ ...obj, }); @@ -5332,6 +5680,9 @@ export interface ListChangeSetsOutput { } export namespace ListChangeSetsOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListChangeSetsOutput): any => ({ ...obj, }); @@ -5346,6 +5697,9 @@ export interface ListExportsInput { } export namespace ListExportsInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListExportsInput): any => ({ ...obj, }); @@ -5378,6 +5732,9 @@ export interface Export { } export namespace Export { + /** + * @internal + */ export const filterSensitiveLog = (obj: Export): any => ({ ...obj, }); @@ -5397,6 +5754,9 @@ export interface ListExportsOutput { } export namespace ListExportsOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListExportsOutput): any => ({ ...obj, }); @@ -5418,6 +5778,9 @@ export interface ListImportsInput { } export namespace ListImportsInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListImportsInput): any => ({ ...obj, }); @@ -5438,6 +5801,9 @@ export interface ListImportsOutput { } export namespace ListImportsOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListImportsOutput): any => ({ ...obj, }); @@ -5461,6 +5827,9 @@ export interface StackInstanceFilter { } export namespace StackInstanceFilter { + /** + * @internal + */ export const filterSensitiveLog = (obj: StackInstanceFilter): any => ({ ...obj, }); @@ -5522,6 +5891,9 @@ export interface ListStackInstancesInput { } export namespace ListStackInstancesInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListStackInstancesInput): any => ({ ...obj, }); @@ -5644,6 +6016,9 @@ export interface StackInstanceSummary { } export namespace StackInstanceSummary { + /** + * @internal + */ export const filterSensitiveLog = (obj: StackInstanceSummary): any => ({ ...obj, }); @@ -5667,6 +6042,9 @@ export interface ListStackInstancesOutput { } export namespace ListStackInstancesOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListStackInstancesOutput): any => ({ ...obj, }); @@ -5700,6 +6078,9 @@ export interface ListStackResourcesInput { } export namespace ListStackResourcesInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListStackResourcesInput): any => ({ ...obj, }); @@ -5750,6 +6131,9 @@ export interface StackResourceDriftInformationSummary { } export namespace StackResourceDriftInformationSummary { + /** + * @internal + */ export const filterSensitiveLog = (obj: StackResourceDriftInformationSummary): any => ({ ...obj, }); @@ -5806,6 +6190,9 @@ export interface StackResourceSummary { } export namespace StackResourceSummary { + /** + * @internal + */ export const filterSensitiveLog = (obj: StackResourceSummary): any => ({ ...obj, }); @@ -5828,6 +6215,9 @@ export interface ListStackResourcesOutput { } export namespace ListStackResourcesOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListStackResourcesOutput): any => ({ ...obj, }); @@ -5851,6 +6241,9 @@ export interface ListStacksInput { } export namespace ListStacksInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListStacksInput): any => ({ ...obj, }); @@ -5899,6 +6292,9 @@ export interface StackDriftInformationSummary { } export namespace StackDriftInformationSummary { + /** + * @internal + */ export const filterSensitiveLog = (obj: StackDriftInformationSummary): any => ({ ...obj, }); @@ -5976,6 +6372,9 @@ export interface StackSummary { } export namespace StackSummary { + /** + * @internal + */ export const filterSensitiveLog = (obj: StackSummary): any => ({ ...obj, }); @@ -5999,6 +6398,9 @@ export interface ListStacksOutput { } export namespace ListStacksOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListStacksOutput): any => ({ ...obj, }); @@ -6051,6 +6453,9 @@ export interface ListStackSetOperationResultsInput { } export namespace ListStackSetOperationResultsInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListStackSetOperationResultsInput): any => ({ ...obj, }); @@ -6127,6 +6532,9 @@ export interface StackSetOperationResultSummary { } export namespace StackSetOperationResultSummary { + /** + * @internal + */ export const filterSensitiveLog = (obj: StackSetOperationResultSummary): any => ({ ...obj, }); @@ -6150,6 +6558,9 @@ export interface ListStackSetOperationResultsOutput { } export namespace ListStackSetOperationResultsOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListStackSetOperationResultsOutput): any => ({ ...obj, }); @@ -6197,6 +6608,9 @@ export interface ListStackSetOperationsInput { } export namespace ListStackSetOperationsInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListStackSetOperationsInput): any => ({ ...obj, }); @@ -6279,6 +6693,9 @@ export interface StackSetOperationSummary { } export namespace StackSetOperationSummary { + /** + * @internal + */ export const filterSensitiveLog = (obj: StackSetOperationSummary): any => ({ ...obj, }); @@ -6301,6 +6718,9 @@ export interface ListStackSetOperationsOutput { } export namespace ListStackSetOperationsOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListStackSetOperationsOutput): any => ({ ...obj, }); @@ -6348,6 +6768,9 @@ export interface ListStackSetsInput { } export namespace ListStackSetsInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListStackSetsInput): any => ({ ...obj, }); @@ -6436,6 +6859,9 @@ export interface StackSetSummary { } export namespace StackSetSummary { + /** + * @internal + */ export const filterSensitiveLog = (obj: StackSetSummary): any => ({ ...obj, }); @@ -6459,6 +6885,9 @@ export interface ListStackSetsOutput { } export namespace ListStackSetsOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListStackSetsOutput): any => ({ ...obj, }); @@ -6501,6 +6930,9 @@ export interface ListTypeRegistrationsInput { } export namespace ListTypeRegistrationsInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListTypeRegistrationsInput): any => ({ ...obj, }); @@ -6522,6 +6954,9 @@ export interface ListTypeRegistrationsOutput { } export namespace ListTypeRegistrationsOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListTypeRegistrationsOutput): any => ({ ...obj, }); @@ -6598,6 +7033,9 @@ export interface ListTypesInput { } export namespace ListTypesInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListTypesInput): any => ({ ...obj, }); @@ -6642,6 +7080,9 @@ export interface TypeSummary { } export namespace TypeSummary { + /** + * @internal + */ export const filterSensitiveLog = (obj: TypeSummary): any => ({ ...obj, }); @@ -6660,6 +7101,9 @@ export interface ListTypesOutput { } export namespace ListTypesOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListTypesOutput): any => ({ ...obj, }); @@ -6713,6 +7157,9 @@ export interface ListTypeVersionsInput { } export namespace ListTypeVersionsInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListTypeVersionsInput): any => ({ ...obj, }); @@ -6759,6 +7206,9 @@ export interface TypeVersionSummary { } export namespace TypeVersionSummary { + /** + * @internal + */ export const filterSensitiveLog = (obj: TypeVersionSummary): any => ({ ...obj, }); @@ -6777,6 +7227,9 @@ export interface ListTypeVersionsOutput { } export namespace ListTypeVersionsOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListTypeVersionsOutput): any => ({ ...obj, }); @@ -6792,6 +7245,9 @@ export interface InvalidStateTransitionException extends __SmithyException, $Met } export namespace InvalidStateTransitionException { + /** + * @internal + */ export const filterSensitiveLog = (obj: InvalidStateTransitionException): any => ({ ...obj, }); @@ -6807,6 +7263,9 @@ export interface OperationStatusCheckFailedException extends __SmithyException, } export namespace OperationStatusCheckFailedException { + /** + * @internal + */ export const filterSensitiveLog = (obj: OperationStatusCheckFailedException): any => ({ ...obj, }); @@ -6874,6 +7333,9 @@ export interface RecordHandlerProgressInput { } export namespace RecordHandlerProgressInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: RecordHandlerProgressInput): any => ({ ...obj, }); @@ -6882,6 +7344,9 @@ export namespace RecordHandlerProgressInput { export interface RecordHandlerProgressOutput {} export namespace RecordHandlerProgressOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: RecordHandlerProgressOutput): any => ({ ...obj, }); @@ -6970,6 +7435,9 @@ export interface RegisterTypeInput { } export namespace RegisterTypeInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: RegisterTypeInput): any => ({ ...obj, }); @@ -6986,6 +7454,9 @@ export interface RegisterTypeOutput { } export namespace RegisterTypeOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: RegisterTypeOutput): any => ({ ...obj, }); @@ -7018,6 +7489,9 @@ export interface SetStackPolicyInput { } export namespace SetStackPolicyInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: SetStackPolicyInput): any => ({ ...obj, }); @@ -7049,6 +7523,9 @@ export interface SetTypeDefaultVersionInput { } export namespace SetTypeDefaultVersionInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: SetTypeDefaultVersionInput): any => ({ ...obj, }); @@ -7057,6 +7534,9 @@ export namespace SetTypeDefaultVersionInput { export interface SetTypeDefaultVersionOutput {} export namespace SetTypeDefaultVersionOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: SetTypeDefaultVersionOutput): any => ({ ...obj, }); @@ -7099,6 +7579,9 @@ export interface SignalResourceInput { } export namespace SignalResourceInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: SignalResourceInput): any => ({ ...obj, }); @@ -7133,6 +7616,9 @@ export interface StopStackSetOperationInput { } export namespace StopStackSetOperationInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: StopStackSetOperationInput): any => ({ ...obj, }); @@ -7141,6 +7627,9 @@ export namespace StopStackSetOperationInput { export interface StopStackSetOperationOutput {} export namespace StopStackSetOperationOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: StopStackSetOperationOutput): any => ({ ...obj, }); @@ -7409,6 +7898,9 @@ export interface UpdateStackInput { } export namespace UpdateStackInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateStackInput): any => ({ ...obj, }); @@ -7425,6 +7917,9 @@ export interface UpdateStackOutput { } export namespace UpdateStackOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateStackOutput): any => ({ ...obj, }); @@ -7537,6 +8032,9 @@ export interface UpdateStackInstancesInput { } export namespace UpdateStackInstancesInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateStackInstancesInput): any => ({ ...obj, }); @@ -7550,6 +8048,9 @@ export interface UpdateStackInstancesOutput { } export namespace UpdateStackInstancesOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateStackInstancesOutput): any => ({ ...obj, }); @@ -7852,6 +8353,9 @@ export interface UpdateStackSetInput { } export namespace UpdateStackSetInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateStackSetInput): any => ({ ...obj, }); @@ -7865,6 +8369,9 @@ export interface UpdateStackSetOutput { } export namespace UpdateStackSetOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateStackSetOutput): any => ({ ...obj, }); @@ -7884,6 +8391,9 @@ export interface UpdateTerminationProtectionInput { } export namespace UpdateTerminationProtectionInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateTerminationProtectionInput): any => ({ ...obj, }); @@ -7897,6 +8407,9 @@ export interface UpdateTerminationProtectionOutput { } export namespace UpdateTerminationProtectionOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateTerminationProtectionOutput): any => ({ ...obj, }); @@ -7927,6 +8440,9 @@ export interface ValidateTemplateInput { } export namespace ValidateTemplateInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: ValidateTemplateInput): any => ({ ...obj, }); @@ -7959,6 +8475,9 @@ export interface TemplateParameter { } export namespace TemplateParameter { + /** + * @internal + */ export const filterSensitiveLog = (obj: TemplateParameter): any => ({ ...obj, }); @@ -8000,6 +8519,9 @@ export interface ValidateTemplateOutput { } export namespace ValidateTemplateOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: ValidateTemplateOutput): any => ({ ...obj, }); diff --git a/clients/client-cloudfront/commands/CreateCachePolicyCommand.ts b/clients/client-cloudfront/commands/CreateCachePolicyCommand.ts index 0050a27ebf73..14a8ef616a22 100644 --- a/clients/client-cloudfront/commands/CreateCachePolicyCommand.ts +++ b/clients/client-cloudfront/commands/CreateCachePolicyCommand.ts @@ -42,6 +42,20 @@ export interface CreateCachePolicyCommandOutput extends CreateCachePolicyResult, * OriginRequestPolicy.

*

For more information about cache policies, see Controlling the cache key in the * Amazon CloudFront Developer Guide.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { CloudFrontClient, CreateCachePolicyCommand } from "@aws-sdk/client-cloudfront"; // ES Modules import + * // const { CloudFrontClient, CreateCachePolicyCommand } = require("@aws-sdk/client-cloudfront"); // CommonJS import + * const client = new CloudFrontClient(config); + * const command = new CreateCachePolicyCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreateCachePolicyCommandInput} for command's `input` shape. + * @see {@link CreateCachePolicyCommandOutput} for command's `response` shape. + * @see {@link CloudFrontClientResolvedConfig | config} for command's `input` shape. + * */ export class CreateCachePolicyCommand extends $Command< CreateCachePolicyCommandInput, diff --git a/clients/client-cloudfront/commands/CreateCloudFrontOriginAccessIdentityCommand.ts b/clients/client-cloudfront/commands/CreateCloudFrontOriginAccessIdentityCommand.ts index 9c4fac0d563f..e582b84edc35 100644 --- a/clients/client-cloudfront/commands/CreateCloudFrontOriginAccessIdentityCommand.ts +++ b/clients/client-cloudfront/commands/CreateCloudFrontOriginAccessIdentityCommand.ts @@ -30,6 +30,20 @@ export interface CreateCloudFrontOriginAccessIdentityCommandOutput * 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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { CloudFrontClient, CreateCloudFrontOriginAccessIdentityCommand } from "@aws-sdk/client-cloudfront"; // ES Modules import + * // const { CloudFrontClient, CreateCloudFrontOriginAccessIdentityCommand } = require("@aws-sdk/client-cloudfront"); // CommonJS import + * const client = new CloudFrontClient(config); + * const command = new CreateCloudFrontOriginAccessIdentityCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreateCloudFrontOriginAccessIdentityCommandInput} for command's `input` shape. + * @see {@link CreateCloudFrontOriginAccessIdentityCommandOutput} for command's `response` shape. + * @see {@link CloudFrontClientResolvedConfig | config} for command's `input` shape. + * */ export class CreateCloudFrontOriginAccessIdentityCommand extends $Command< CreateCloudFrontOriginAccessIdentityCommandInput, diff --git a/clients/client-cloudfront/commands/CreateDistributionCommand.ts b/clients/client-cloudfront/commands/CreateDistributionCommand.ts index ad8aaf8a1d7f..95be08933cf2 100644 --- a/clients/client-cloudfront/commands/CreateDistributionCommand.ts +++ b/clients/client-cloudfront/commands/CreateDistributionCommand.ts @@ -34,6 +34,20 @@ export interface CreateDistributionCommandOutput extends CreateDistributionResul * see Required * Fields for Create Distribution and Update Distribution in the Amazon CloudFront Developer Guide.

* + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { CloudFrontClient, CreateDistributionCommand } from "@aws-sdk/client-cloudfront"; // ES Modules import + * // const { CloudFrontClient, CreateDistributionCommand } = require("@aws-sdk/client-cloudfront"); // CommonJS import + * const client = new CloudFrontClient(config); + * const command = new CreateDistributionCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreateDistributionCommandInput} for command's `input` shape. + * @see {@link CreateDistributionCommandOutput} for command's `response` shape. + * @see {@link CloudFrontClientResolvedConfig | config} for command's `input` shape. + * */ export class CreateDistributionCommand extends $Command< CreateDistributionCommandInput, diff --git a/clients/client-cloudfront/commands/CreateDistributionWithTagsCommand.ts b/clients/client-cloudfront/commands/CreateDistributionWithTagsCommand.ts index 02e68b81c110..528d9e109f2d 100644 --- a/clients/client-cloudfront/commands/CreateDistributionWithTagsCommand.ts +++ b/clients/client-cloudfront/commands/CreateDistributionWithTagsCommand.ts @@ -22,6 +22,20 @@ export interface CreateDistributionWithTagsCommandOutput extends CreateDistribut /** *

Create a new distribution with tags.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { CloudFrontClient, CreateDistributionWithTagsCommand } from "@aws-sdk/client-cloudfront"; // ES Modules import + * // const { CloudFrontClient, CreateDistributionWithTagsCommand } = require("@aws-sdk/client-cloudfront"); // CommonJS import + * const client = new CloudFrontClient(config); + * const command = new CreateDistributionWithTagsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreateDistributionWithTagsCommandInput} for command's `input` shape. + * @see {@link CreateDistributionWithTagsCommandOutput} for command's `response` shape. + * @see {@link CloudFrontClientResolvedConfig | config} for command's `input` shape. + * */ export class CreateDistributionWithTagsCommand extends $Command< CreateDistributionWithTagsCommandInput, diff --git a/clients/client-cloudfront/commands/CreateFieldLevelEncryptionConfigCommand.ts b/clients/client-cloudfront/commands/CreateFieldLevelEncryptionConfigCommand.ts index 5067dcef449c..817228269332 100644 --- a/clients/client-cloudfront/commands/CreateFieldLevelEncryptionConfigCommand.ts +++ b/clients/client-cloudfront/commands/CreateFieldLevelEncryptionConfigCommand.ts @@ -24,6 +24,20 @@ export interface CreateFieldLevelEncryptionConfigCommandOutput /** *

Create a new field-level encryption configuration.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { CloudFrontClient, CreateFieldLevelEncryptionConfigCommand } from "@aws-sdk/client-cloudfront"; // ES Modules import + * // const { CloudFrontClient, CreateFieldLevelEncryptionConfigCommand } = require("@aws-sdk/client-cloudfront"); // CommonJS import + * const client = new CloudFrontClient(config); + * const command = new CreateFieldLevelEncryptionConfigCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreateFieldLevelEncryptionConfigCommandInput} for command's `input` shape. + * @see {@link CreateFieldLevelEncryptionConfigCommandOutput} for command's `response` shape. + * @see {@link CloudFrontClientResolvedConfig | config} for command's `input` shape. + * */ export class CreateFieldLevelEncryptionConfigCommand extends $Command< CreateFieldLevelEncryptionConfigCommandInput, diff --git a/clients/client-cloudfront/commands/CreateFieldLevelEncryptionProfileCommand.ts b/clients/client-cloudfront/commands/CreateFieldLevelEncryptionProfileCommand.ts index e3d1ff00ea0d..a485e101009d 100644 --- a/clients/client-cloudfront/commands/CreateFieldLevelEncryptionProfileCommand.ts +++ b/clients/client-cloudfront/commands/CreateFieldLevelEncryptionProfileCommand.ts @@ -24,6 +24,20 @@ export interface CreateFieldLevelEncryptionProfileCommandOutput /** *

Create a field-level encryption profile.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { CloudFrontClient, CreateFieldLevelEncryptionProfileCommand } from "@aws-sdk/client-cloudfront"; // ES Modules import + * // const { CloudFrontClient, CreateFieldLevelEncryptionProfileCommand } = require("@aws-sdk/client-cloudfront"); // CommonJS import + * const client = new CloudFrontClient(config); + * const command = new CreateFieldLevelEncryptionProfileCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreateFieldLevelEncryptionProfileCommandInput} for command's `input` shape. + * @see {@link CreateFieldLevelEncryptionProfileCommandOutput} for command's `response` shape. + * @see {@link CloudFrontClientResolvedConfig | config} for command's `input` shape. + * */ export class CreateFieldLevelEncryptionProfileCommand extends $Command< CreateFieldLevelEncryptionProfileCommandInput, diff --git a/clients/client-cloudfront/commands/CreateInvalidationCommand.ts b/clients/client-cloudfront/commands/CreateInvalidationCommand.ts index b08c7330f8cd..4f0afd11f579 100644 --- a/clients/client-cloudfront/commands/CreateInvalidationCommand.ts +++ b/clients/client-cloudfront/commands/CreateInvalidationCommand.ts @@ -22,6 +22,20 @@ export interface CreateInvalidationCommandOutput extends CreateInvalidationResul /** *

Create a new invalidation.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { CloudFrontClient, CreateInvalidationCommand } from "@aws-sdk/client-cloudfront"; // ES Modules import + * // const { CloudFrontClient, CreateInvalidationCommand } = require("@aws-sdk/client-cloudfront"); // CommonJS import + * const client = new CloudFrontClient(config); + * const command = new CreateInvalidationCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreateInvalidationCommandInput} for command's `input` shape. + * @see {@link CreateInvalidationCommandOutput} for command's `response` shape. + * @see {@link CloudFrontClientResolvedConfig | config} for command's `input` shape. + * */ export class CreateInvalidationCommand extends $Command< CreateInvalidationCommandInput, diff --git a/clients/client-cloudfront/commands/CreateKeyGroupCommand.ts b/clients/client-cloudfront/commands/CreateKeyGroupCommand.ts index b331343d1b29..a5ed6ed721b0 100644 --- a/clients/client-cloudfront/commands/CreateKeyGroupCommand.ts +++ b/clients/client-cloudfront/commands/CreateKeyGroupCommand.ts @@ -29,6 +29,20 @@ export interface CreateKeyGroupCommandOutput extends CreateKeyGroupResult, __Met * 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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { CloudFrontClient, CreateKeyGroupCommand } from "@aws-sdk/client-cloudfront"; // ES Modules import + * // const { CloudFrontClient, CreateKeyGroupCommand } = require("@aws-sdk/client-cloudfront"); // CommonJS import + * const client = new CloudFrontClient(config); + * const command = new CreateKeyGroupCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreateKeyGroupCommandInput} for command's `input` shape. + * @see {@link CreateKeyGroupCommandOutput} for command's `response` shape. + * @see {@link CloudFrontClientResolvedConfig | config} for command's `input` shape. + * */ export class CreateKeyGroupCommand extends $Command< CreateKeyGroupCommandInput, diff --git a/clients/client-cloudfront/commands/CreateMonitoringSubscriptionCommand.ts b/clients/client-cloudfront/commands/CreateMonitoringSubscriptionCommand.ts index c2ee22311723..537965c9d6f8 100644 --- a/clients/client-cloudfront/commands/CreateMonitoringSubscriptionCommand.ts +++ b/clients/client-cloudfront/commands/CreateMonitoringSubscriptionCommand.ts @@ -27,6 +27,20 @@ export interface CreateMonitoringSubscriptionCommandOutput * additional metrics incur an additional cost.

*

For more information, see Viewing additional CloudFront distribution metrics in the * Amazon CloudFront Developer Guide.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { CloudFrontClient, CreateMonitoringSubscriptionCommand } from "@aws-sdk/client-cloudfront"; // ES Modules import + * // const { CloudFrontClient, CreateMonitoringSubscriptionCommand } = require("@aws-sdk/client-cloudfront"); // CommonJS import + * const client = new CloudFrontClient(config); + * const command = new CreateMonitoringSubscriptionCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreateMonitoringSubscriptionCommandInput} for command's `input` shape. + * @see {@link CreateMonitoringSubscriptionCommandOutput} for command's `response` shape. + * @see {@link CloudFrontClientResolvedConfig | config} for command's `input` shape. + * */ export class CreateMonitoringSubscriptionCommand extends $Command< CreateMonitoringSubscriptionCommandInput, diff --git a/clients/client-cloudfront/commands/CreateOriginRequestPolicyCommand.ts b/clients/client-cloudfront/commands/CreateOriginRequestPolicyCommand.ts index bc9930104298..a51feb5bb1ea 100644 --- a/clients/client-cloudfront/commands/CreateOriginRequestPolicyCommand.ts +++ b/clients/client-cloudfront/commands/CreateOriginRequestPolicyCommand.ts @@ -46,6 +46,20 @@ export interface CreateOriginRequestPolicyCommandOutput extends CreateOriginRequ * key, use CachePolicy.

*

For more information about origin request policies, see Controlling origin requests in the * Amazon CloudFront Developer Guide.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { CloudFrontClient, CreateOriginRequestPolicyCommand } from "@aws-sdk/client-cloudfront"; // ES Modules import + * // const { CloudFrontClient, CreateOriginRequestPolicyCommand } = require("@aws-sdk/client-cloudfront"); // CommonJS import + * const client = new CloudFrontClient(config); + * const command = new CreateOriginRequestPolicyCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreateOriginRequestPolicyCommandInput} for command's `input` shape. + * @see {@link CreateOriginRequestPolicyCommandOutput} for command's `response` shape. + * @see {@link CloudFrontClientResolvedConfig | config} for command's `input` shape. + * */ export class CreateOriginRequestPolicyCommand extends $Command< CreateOriginRequestPolicyCommandInput, diff --git a/clients/client-cloudfront/commands/CreatePublicKeyCommand.ts b/clients/client-cloudfront/commands/CreatePublicKeyCommand.ts index 6804f78a75af..649ec8b4e2bf 100644 --- a/clients/client-cloudfront/commands/CreatePublicKeyCommand.ts +++ b/clients/client-cloudfront/commands/CreatePublicKeyCommand.ts @@ -22,6 +22,20 @@ export interface CreatePublicKeyCommandOutput extends CreatePublicKeyResult, __M /** *

Uploads a public key to CloudFront that you can use with signed URLs and signed cookies, or with field-level encryption.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { CloudFrontClient, CreatePublicKeyCommand } from "@aws-sdk/client-cloudfront"; // ES Modules import + * // const { CloudFrontClient, CreatePublicKeyCommand } = require("@aws-sdk/client-cloudfront"); // CommonJS import + * const client = new CloudFrontClient(config); + * const command = new CreatePublicKeyCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreatePublicKeyCommandInput} for command's `input` shape. + * @see {@link CreatePublicKeyCommandOutput} for command's `response` shape. + * @see {@link CloudFrontClientResolvedConfig | config} for command's `input` shape. + * */ export class CreatePublicKeyCommand extends $Command< CreatePublicKeyCommandInput, diff --git a/clients/client-cloudfront/commands/CreateRealtimeLogConfigCommand.ts b/clients/client-cloudfront/commands/CreateRealtimeLogConfigCommand.ts index 8a5feb262b7f..1645ae910123 100644 --- a/clients/client-cloudfront/commands/CreateRealtimeLogConfigCommand.ts +++ b/clients/client-cloudfront/commands/CreateRealtimeLogConfigCommand.ts @@ -25,6 +25,20 @@ export interface CreateRealtimeLogConfigCommandOutput extends CreateRealtimeLogC *

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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { CloudFrontClient, CreateRealtimeLogConfigCommand } from "@aws-sdk/client-cloudfront"; // ES Modules import + * // const { CloudFrontClient, CreateRealtimeLogConfigCommand } = require("@aws-sdk/client-cloudfront"); // CommonJS import + * const client = new CloudFrontClient(config); + * const command = new CreateRealtimeLogConfigCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreateRealtimeLogConfigCommandInput} for command's `input` shape. + * @see {@link CreateRealtimeLogConfigCommandOutput} for command's `response` shape. + * @see {@link CloudFrontClientResolvedConfig | config} for command's `input` shape. + * */ export class CreateRealtimeLogConfigCommand extends $Command< CreateRealtimeLogConfigCommandInput, diff --git a/clients/client-cloudfront/commands/CreateStreamingDistributionCommand.ts b/clients/client-cloudfront/commands/CreateStreamingDistributionCommand.ts index 3e11475b4e49..2455be10ecfd 100644 --- a/clients/client-cloudfront/commands/CreateStreamingDistributionCommand.ts +++ b/clients/client-cloudfront/commands/CreateStreamingDistributionCommand.ts @@ -24,6 +24,20 @@ export interface CreateStreamingDistributionCommandOutput extends CreateStreamin *

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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { CloudFrontClient, CreateStreamingDistributionCommand } from "@aws-sdk/client-cloudfront"; // ES Modules import + * // const { CloudFrontClient, CreateStreamingDistributionCommand } = require("@aws-sdk/client-cloudfront"); // CommonJS import + * const client = new CloudFrontClient(config); + * const command = new CreateStreamingDistributionCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreateStreamingDistributionCommandInput} for command's `input` shape. + * @see {@link CreateStreamingDistributionCommandOutput} for command's `response` shape. + * @see {@link CloudFrontClientResolvedConfig | config} for command's `input` shape. + * */ export class CreateStreamingDistributionCommand extends $Command< CreateStreamingDistributionCommandInput, diff --git a/clients/client-cloudfront/commands/CreateStreamingDistributionWithTagsCommand.ts b/clients/client-cloudfront/commands/CreateStreamingDistributionWithTagsCommand.ts index 1d70c9bc8e00..b333993baa08 100644 --- a/clients/client-cloudfront/commands/CreateStreamingDistributionWithTagsCommand.ts +++ b/clients/client-cloudfront/commands/CreateStreamingDistributionWithTagsCommand.ts @@ -29,6 +29,20 @@ export interface CreateStreamingDistributionWithTagsCommandOutput *

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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { CloudFrontClient, CreateStreamingDistributionWithTagsCommand } from "@aws-sdk/client-cloudfront"; // ES Modules import + * // const { CloudFrontClient, CreateStreamingDistributionWithTagsCommand } = require("@aws-sdk/client-cloudfront"); // CommonJS import + * const client = new CloudFrontClient(config); + * const command = new CreateStreamingDistributionWithTagsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreateStreamingDistributionWithTagsCommandInput} for command's `input` shape. + * @see {@link CreateStreamingDistributionWithTagsCommandOutput} for command's `response` shape. + * @see {@link CloudFrontClientResolvedConfig | config} for command's `input` shape. + * */ export class CreateStreamingDistributionWithTagsCommand extends $Command< CreateStreamingDistributionWithTagsCommandInput, diff --git a/clients/client-cloudfront/commands/DeleteCachePolicyCommand.ts b/clients/client-cloudfront/commands/DeleteCachePolicyCommand.ts index b15f563046a4..1c61654d2d46 100644 --- a/clients/client-cloudfront/commands/DeleteCachePolicyCommand.ts +++ b/clients/client-cloudfront/commands/DeleteCachePolicyCommand.ts @@ -28,6 +28,20 @@ export interface DeleteCachePolicyCommandOutput extends __MetadataBearer {} *

To delete a cache policy, you must provide the policy’s identifier and version. To get these * values, you can use ListCachePolicies or * GetCachePolicy.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { CloudFrontClient, DeleteCachePolicyCommand } from "@aws-sdk/client-cloudfront"; // ES Modules import + * // const { CloudFrontClient, DeleteCachePolicyCommand } = require("@aws-sdk/client-cloudfront"); // CommonJS import + * const client = new CloudFrontClient(config); + * const command = new DeleteCachePolicyCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteCachePolicyCommandInput} for command's `input` shape. + * @see {@link DeleteCachePolicyCommandOutput} for command's `response` shape. + * @see {@link CloudFrontClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteCachePolicyCommand extends $Command< DeleteCachePolicyCommandInput, diff --git a/clients/client-cloudfront/commands/DeleteCloudFrontOriginAccessIdentityCommand.ts b/clients/client-cloudfront/commands/DeleteCloudFrontOriginAccessIdentityCommand.ts index e612439af555..ba5567478508 100644 --- a/clients/client-cloudfront/commands/DeleteCloudFrontOriginAccessIdentityCommand.ts +++ b/clients/client-cloudfront/commands/DeleteCloudFrontOriginAccessIdentityCommand.ts @@ -22,6 +22,20 @@ export interface DeleteCloudFrontOriginAccessIdentityCommandOutput extends __Met /** *

Delete an origin access identity.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { CloudFrontClient, DeleteCloudFrontOriginAccessIdentityCommand } from "@aws-sdk/client-cloudfront"; // ES Modules import + * // const { CloudFrontClient, DeleteCloudFrontOriginAccessIdentityCommand } = require("@aws-sdk/client-cloudfront"); // CommonJS import + * const client = new CloudFrontClient(config); + * const command = new DeleteCloudFrontOriginAccessIdentityCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteCloudFrontOriginAccessIdentityCommandInput} for command's `input` shape. + * @see {@link DeleteCloudFrontOriginAccessIdentityCommandOutput} for command's `response` shape. + * @see {@link CloudFrontClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteCloudFrontOriginAccessIdentityCommand extends $Command< DeleteCloudFrontOriginAccessIdentityCommandInput, diff --git a/clients/client-cloudfront/commands/DeleteDistributionCommand.ts b/clients/client-cloudfront/commands/DeleteDistributionCommand.ts index 069226d34a3a..66e50cc51528 100644 --- a/clients/client-cloudfront/commands/DeleteDistributionCommand.ts +++ b/clients/client-cloudfront/commands/DeleteDistributionCommand.ts @@ -22,6 +22,20 @@ export interface DeleteDistributionCommandOutput extends __MetadataBearer {} /** *

Delete a distribution.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { CloudFrontClient, DeleteDistributionCommand } from "@aws-sdk/client-cloudfront"; // ES Modules import + * // const { CloudFrontClient, DeleteDistributionCommand } = require("@aws-sdk/client-cloudfront"); // CommonJS import + * const client = new CloudFrontClient(config); + * const command = new DeleteDistributionCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteDistributionCommandInput} for command's `input` shape. + * @see {@link DeleteDistributionCommandOutput} for command's `response` shape. + * @see {@link CloudFrontClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteDistributionCommand extends $Command< DeleteDistributionCommandInput, diff --git a/clients/client-cloudfront/commands/DeleteFieldLevelEncryptionConfigCommand.ts b/clients/client-cloudfront/commands/DeleteFieldLevelEncryptionConfigCommand.ts index 1a5f7967f18d..82b07fa9656c 100644 --- a/clients/client-cloudfront/commands/DeleteFieldLevelEncryptionConfigCommand.ts +++ b/clients/client-cloudfront/commands/DeleteFieldLevelEncryptionConfigCommand.ts @@ -22,6 +22,20 @@ export interface DeleteFieldLevelEncryptionConfigCommandOutput extends __Metadat /** *

Remove a field-level encryption configuration.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { CloudFrontClient, DeleteFieldLevelEncryptionConfigCommand } from "@aws-sdk/client-cloudfront"; // ES Modules import + * // const { CloudFrontClient, DeleteFieldLevelEncryptionConfigCommand } = require("@aws-sdk/client-cloudfront"); // CommonJS import + * const client = new CloudFrontClient(config); + * const command = new DeleteFieldLevelEncryptionConfigCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteFieldLevelEncryptionConfigCommandInput} for command's `input` shape. + * @see {@link DeleteFieldLevelEncryptionConfigCommandOutput} for command's `response` shape. + * @see {@link CloudFrontClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteFieldLevelEncryptionConfigCommand extends $Command< DeleteFieldLevelEncryptionConfigCommandInput, diff --git a/clients/client-cloudfront/commands/DeleteFieldLevelEncryptionProfileCommand.ts b/clients/client-cloudfront/commands/DeleteFieldLevelEncryptionProfileCommand.ts index 29c3f6220b77..22e437c71736 100644 --- a/clients/client-cloudfront/commands/DeleteFieldLevelEncryptionProfileCommand.ts +++ b/clients/client-cloudfront/commands/DeleteFieldLevelEncryptionProfileCommand.ts @@ -22,6 +22,20 @@ export interface DeleteFieldLevelEncryptionProfileCommandOutput extends __Metada /** *

Remove a field-level encryption profile.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { CloudFrontClient, DeleteFieldLevelEncryptionProfileCommand } from "@aws-sdk/client-cloudfront"; // ES Modules import + * // const { CloudFrontClient, DeleteFieldLevelEncryptionProfileCommand } = require("@aws-sdk/client-cloudfront"); // CommonJS import + * const client = new CloudFrontClient(config); + * const command = new DeleteFieldLevelEncryptionProfileCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteFieldLevelEncryptionProfileCommandInput} for command's `input` shape. + * @see {@link DeleteFieldLevelEncryptionProfileCommandOutput} for command's `response` shape. + * @see {@link CloudFrontClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteFieldLevelEncryptionProfileCommand extends $Command< DeleteFieldLevelEncryptionProfileCommandInput, diff --git a/clients/client-cloudfront/commands/DeleteKeyGroupCommand.ts b/clients/client-cloudfront/commands/DeleteKeyGroupCommand.ts index dcd1e56eef2a..ac79bfc2f20e 100644 --- a/clients/client-cloudfront/commands/DeleteKeyGroupCommand.ts +++ b/clients/client-cloudfront/commands/DeleteKeyGroupCommand.ts @@ -28,6 +28,20 @@ export interface DeleteKeyGroupCommandOutput extends __MetadataBearer {} *

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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { CloudFrontClient, DeleteKeyGroupCommand } from "@aws-sdk/client-cloudfront"; // ES Modules import + * // const { CloudFrontClient, DeleteKeyGroupCommand } = require("@aws-sdk/client-cloudfront"); // CommonJS import + * const client = new CloudFrontClient(config); + * const command = new DeleteKeyGroupCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteKeyGroupCommandInput} for command's `input` shape. + * @see {@link DeleteKeyGroupCommandOutput} for command's `response` shape. + * @see {@link CloudFrontClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteKeyGroupCommand extends $Command< DeleteKeyGroupCommandInput, diff --git a/clients/client-cloudfront/commands/DeleteMonitoringSubscriptionCommand.ts b/clients/client-cloudfront/commands/DeleteMonitoringSubscriptionCommand.ts index 3ba39d973601..3335f29c4c4e 100644 --- a/clients/client-cloudfront/commands/DeleteMonitoringSubscriptionCommand.ts +++ b/clients/client-cloudfront/commands/DeleteMonitoringSubscriptionCommand.ts @@ -24,6 +24,20 @@ export interface DeleteMonitoringSubscriptionCommandOutput /** *

Disables additional CloudWatch metrics for the specified CloudFront distribution.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { CloudFrontClient, DeleteMonitoringSubscriptionCommand } from "@aws-sdk/client-cloudfront"; // ES Modules import + * // const { CloudFrontClient, DeleteMonitoringSubscriptionCommand } = require("@aws-sdk/client-cloudfront"); // CommonJS import + * const client = new CloudFrontClient(config); + * const command = new DeleteMonitoringSubscriptionCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteMonitoringSubscriptionCommandInput} for command's `input` shape. + * @see {@link DeleteMonitoringSubscriptionCommandOutput} for command's `response` shape. + * @see {@link CloudFrontClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteMonitoringSubscriptionCommand extends $Command< DeleteMonitoringSubscriptionCommandInput, diff --git a/clients/client-cloudfront/commands/DeleteOriginRequestPolicyCommand.ts b/clients/client-cloudfront/commands/DeleteOriginRequestPolicyCommand.ts index b9ce52313f2c..deca3812be6a 100644 --- a/clients/client-cloudfront/commands/DeleteOriginRequestPolicyCommand.ts +++ b/clients/client-cloudfront/commands/DeleteOriginRequestPolicyCommand.ts @@ -28,6 +28,20 @@ export interface DeleteOriginRequestPolicyCommandOutput extends __MetadataBearer *

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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { CloudFrontClient, DeleteOriginRequestPolicyCommand } from "@aws-sdk/client-cloudfront"; // ES Modules import + * // const { CloudFrontClient, DeleteOriginRequestPolicyCommand } = require("@aws-sdk/client-cloudfront"); // CommonJS import + * const client = new CloudFrontClient(config); + * const command = new DeleteOriginRequestPolicyCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteOriginRequestPolicyCommandInput} for command's `input` shape. + * @see {@link DeleteOriginRequestPolicyCommandOutput} for command's `response` shape. + * @see {@link CloudFrontClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteOriginRequestPolicyCommand extends $Command< DeleteOriginRequestPolicyCommandInput, diff --git a/clients/client-cloudfront/commands/DeletePublicKeyCommand.ts b/clients/client-cloudfront/commands/DeletePublicKeyCommand.ts index 4af6b451db0c..f9ccc9e43c8c 100644 --- a/clients/client-cloudfront/commands/DeletePublicKeyCommand.ts +++ b/clients/client-cloudfront/commands/DeletePublicKeyCommand.ts @@ -22,6 +22,20 @@ export interface DeletePublicKeyCommandOutput extends __MetadataBearer {} /** *

Remove a public key you previously added to CloudFront.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { CloudFrontClient, DeletePublicKeyCommand } from "@aws-sdk/client-cloudfront"; // ES Modules import + * // const { CloudFrontClient, DeletePublicKeyCommand } = require("@aws-sdk/client-cloudfront"); // CommonJS import + * const client = new CloudFrontClient(config); + * const command = new DeletePublicKeyCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeletePublicKeyCommandInput} for command's `input` shape. + * @see {@link DeletePublicKeyCommandOutput} for command's `response` shape. + * @see {@link CloudFrontClientResolvedConfig | config} for command's `input` shape. + * */ export class DeletePublicKeyCommand extends $Command< DeletePublicKeyCommandInput, diff --git a/clients/client-cloudfront/commands/DeleteRealtimeLogConfigCommand.ts b/clients/client-cloudfront/commands/DeleteRealtimeLogConfigCommand.ts index b4d7873014e8..e7464c4543d6 100644 --- a/clients/client-cloudfront/commands/DeleteRealtimeLogConfigCommand.ts +++ b/clients/client-cloudfront/commands/DeleteRealtimeLogConfigCommand.ts @@ -28,6 +28,20 @@ export interface DeleteRealtimeLogConfigCommandOutput extends __MetadataBearer { *

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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { CloudFrontClient, DeleteRealtimeLogConfigCommand } from "@aws-sdk/client-cloudfront"; // ES Modules import + * // const { CloudFrontClient, DeleteRealtimeLogConfigCommand } = require("@aws-sdk/client-cloudfront"); // CommonJS import + * const client = new CloudFrontClient(config); + * const command = new DeleteRealtimeLogConfigCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteRealtimeLogConfigCommandInput} for command's `input` shape. + * @see {@link DeleteRealtimeLogConfigCommandOutput} for command's `response` shape. + * @see {@link CloudFrontClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteRealtimeLogConfigCommand extends $Command< DeleteRealtimeLogConfigCommandInput, diff --git a/clients/client-cloudfront/commands/DeleteStreamingDistributionCommand.ts b/clients/client-cloudfront/commands/DeleteStreamingDistributionCommand.ts index 2dbf20b81324..48c246348db1 100644 --- a/clients/client-cloudfront/commands/DeleteStreamingDistributionCommand.ts +++ b/clients/client-cloudfront/commands/DeleteStreamingDistributionCommand.ts @@ -69,6 +69,20 @@ export interface DeleteStreamingDistributionCommandOutput extends __MetadataBear * *

For information about deleting a distribution using the CloudFront console, see Deleting a Distribution in the * Amazon CloudFront Developer Guide.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { CloudFrontClient, DeleteStreamingDistributionCommand } from "@aws-sdk/client-cloudfront"; // ES Modules import + * // const { CloudFrontClient, DeleteStreamingDistributionCommand } = require("@aws-sdk/client-cloudfront"); // CommonJS import + * const client = new CloudFrontClient(config); + * const command = new DeleteStreamingDistributionCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteStreamingDistributionCommandInput} for command's `input` shape. + * @see {@link DeleteStreamingDistributionCommandOutput} for command's `response` shape. + * @see {@link CloudFrontClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteStreamingDistributionCommand extends $Command< DeleteStreamingDistributionCommandInput, diff --git a/clients/client-cloudfront/commands/GetCachePolicyCommand.ts b/clients/client-cloudfront/commands/GetCachePolicyCommand.ts index 56c304c2267a..a3a8da3575c3 100644 --- a/clients/client-cloudfront/commands/GetCachePolicyCommand.ts +++ b/clients/client-cloudfront/commands/GetCachePolicyCommand.ts @@ -35,6 +35,20 @@ export interface GetCachePolicyCommandOutput extends GetCachePolicyResult, __Met * ListDistributions or GetDistribution. If the cache policy is * not attached to a cache behavior, you can get the identifier using * ListCachePolicies.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { CloudFrontClient, GetCachePolicyCommand } from "@aws-sdk/client-cloudfront"; // ES Modules import + * // const { CloudFrontClient, GetCachePolicyCommand } = require("@aws-sdk/client-cloudfront"); // CommonJS import + * const client = new CloudFrontClient(config); + * const command = new GetCachePolicyCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetCachePolicyCommandInput} for command's `input` shape. + * @see {@link GetCachePolicyCommandOutput} for command's `response` shape. + * @see {@link CloudFrontClientResolvedConfig | config} for command's `input` shape. + * */ export class GetCachePolicyCommand extends $Command< GetCachePolicyCommandInput, diff --git a/clients/client-cloudfront/commands/GetCachePolicyConfigCommand.ts b/clients/client-cloudfront/commands/GetCachePolicyConfigCommand.ts index 4aa67a24e37e..3141e2c35a73 100644 --- a/clients/client-cloudfront/commands/GetCachePolicyConfigCommand.ts +++ b/clients/client-cloudfront/commands/GetCachePolicyConfigCommand.ts @@ -27,6 +27,20 @@ export interface GetCachePolicyConfigCommandOutput extends GetCachePolicyConfigR * identifier using ListDistributions or GetDistribution. If the * cache policy is not attached to a cache behavior, you can get the identifier using * ListCachePolicies.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { CloudFrontClient, GetCachePolicyConfigCommand } from "@aws-sdk/client-cloudfront"; // ES Modules import + * // const { CloudFrontClient, GetCachePolicyConfigCommand } = require("@aws-sdk/client-cloudfront"); // CommonJS import + * const client = new CloudFrontClient(config); + * const command = new GetCachePolicyConfigCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetCachePolicyConfigCommandInput} for command's `input` shape. + * @see {@link GetCachePolicyConfigCommandOutput} for command's `response` shape. + * @see {@link CloudFrontClientResolvedConfig | config} for command's `input` shape. + * */ export class GetCachePolicyConfigCommand extends $Command< GetCachePolicyConfigCommandInput, diff --git a/clients/client-cloudfront/commands/GetCloudFrontOriginAccessIdentityCommand.ts b/clients/client-cloudfront/commands/GetCloudFrontOriginAccessIdentityCommand.ts index a5d77f0fdb47..738561a974af 100644 --- a/clients/client-cloudfront/commands/GetCloudFrontOriginAccessIdentityCommand.ts +++ b/clients/client-cloudfront/commands/GetCloudFrontOriginAccessIdentityCommand.ts @@ -24,6 +24,20 @@ export interface GetCloudFrontOriginAccessIdentityCommandOutput /** *

Get the information about an origin access identity.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { CloudFrontClient, GetCloudFrontOriginAccessIdentityCommand } from "@aws-sdk/client-cloudfront"; // ES Modules import + * // const { CloudFrontClient, GetCloudFrontOriginAccessIdentityCommand } = require("@aws-sdk/client-cloudfront"); // CommonJS import + * const client = new CloudFrontClient(config); + * const command = new GetCloudFrontOriginAccessIdentityCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetCloudFrontOriginAccessIdentityCommandInput} for command's `input` shape. + * @see {@link GetCloudFrontOriginAccessIdentityCommandOutput} for command's `response` shape. + * @see {@link CloudFrontClientResolvedConfig | config} for command's `input` shape. + * */ export class GetCloudFrontOriginAccessIdentityCommand extends $Command< GetCloudFrontOriginAccessIdentityCommandInput, diff --git a/clients/client-cloudfront/commands/GetCloudFrontOriginAccessIdentityConfigCommand.ts b/clients/client-cloudfront/commands/GetCloudFrontOriginAccessIdentityConfigCommand.ts index 5864ea3ec95b..a38f1a052efc 100644 --- a/clients/client-cloudfront/commands/GetCloudFrontOriginAccessIdentityConfigCommand.ts +++ b/clients/client-cloudfront/commands/GetCloudFrontOriginAccessIdentityConfigCommand.ts @@ -28,6 +28,20 @@ export interface GetCloudFrontOriginAccessIdentityConfigCommandOutput /** *

Get the configuration information about an origin access identity.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { CloudFrontClient, GetCloudFrontOriginAccessIdentityConfigCommand } from "@aws-sdk/client-cloudfront"; // ES Modules import + * // const { CloudFrontClient, GetCloudFrontOriginAccessIdentityConfigCommand } = require("@aws-sdk/client-cloudfront"); // CommonJS import + * const client = new CloudFrontClient(config); + * const command = new GetCloudFrontOriginAccessIdentityConfigCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetCloudFrontOriginAccessIdentityConfigCommandInput} for command's `input` shape. + * @see {@link GetCloudFrontOriginAccessIdentityConfigCommandOutput} for command's `response` shape. + * @see {@link CloudFrontClientResolvedConfig | config} for command's `input` shape. + * */ export class GetCloudFrontOriginAccessIdentityConfigCommand extends $Command< GetCloudFrontOriginAccessIdentityConfigCommandInput, diff --git a/clients/client-cloudfront/commands/GetDistributionCommand.ts b/clients/client-cloudfront/commands/GetDistributionCommand.ts index 2da7b7a9f7a2..89ceb2c37a65 100644 --- a/clients/client-cloudfront/commands/GetDistributionCommand.ts +++ b/clients/client-cloudfront/commands/GetDistributionCommand.ts @@ -22,6 +22,20 @@ export interface GetDistributionCommandOutput extends GetDistributionResult, __M /** *

Get the information about a distribution.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { CloudFrontClient, GetDistributionCommand } from "@aws-sdk/client-cloudfront"; // ES Modules import + * // const { CloudFrontClient, GetDistributionCommand } = require("@aws-sdk/client-cloudfront"); // CommonJS import + * const client = new CloudFrontClient(config); + * const command = new GetDistributionCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetDistributionCommandInput} for command's `input` shape. + * @see {@link GetDistributionCommandOutput} for command's `response` shape. + * @see {@link CloudFrontClientResolvedConfig | config} for command's `input` shape. + * */ export class GetDistributionCommand extends $Command< GetDistributionCommandInput, diff --git a/clients/client-cloudfront/commands/GetDistributionConfigCommand.ts b/clients/client-cloudfront/commands/GetDistributionConfigCommand.ts index fc5d9b448446..f91d88fba637 100644 --- a/clients/client-cloudfront/commands/GetDistributionConfigCommand.ts +++ b/clients/client-cloudfront/commands/GetDistributionConfigCommand.ts @@ -22,6 +22,20 @@ export interface GetDistributionConfigCommandOutput extends GetDistributionConfi /** *

Get the configuration information about a distribution.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { CloudFrontClient, GetDistributionConfigCommand } from "@aws-sdk/client-cloudfront"; // ES Modules import + * // const { CloudFrontClient, GetDistributionConfigCommand } = require("@aws-sdk/client-cloudfront"); // CommonJS import + * const client = new CloudFrontClient(config); + * const command = new GetDistributionConfigCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetDistributionConfigCommandInput} for command's `input` shape. + * @see {@link GetDistributionConfigCommandOutput} for command's `response` shape. + * @see {@link CloudFrontClientResolvedConfig | config} for command's `input` shape. + * */ export class GetDistributionConfigCommand extends $Command< GetDistributionConfigCommandInput, diff --git a/clients/client-cloudfront/commands/GetFieldLevelEncryptionCommand.ts b/clients/client-cloudfront/commands/GetFieldLevelEncryptionCommand.ts index 508345b2e09e..616b6017bed5 100644 --- a/clients/client-cloudfront/commands/GetFieldLevelEncryptionCommand.ts +++ b/clients/client-cloudfront/commands/GetFieldLevelEncryptionCommand.ts @@ -22,6 +22,20 @@ export interface GetFieldLevelEncryptionCommandOutput extends GetFieldLevelEncry /** *

Get the field-level encryption configuration information.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { CloudFrontClient, GetFieldLevelEncryptionCommand } from "@aws-sdk/client-cloudfront"; // ES Modules import + * // const { CloudFrontClient, GetFieldLevelEncryptionCommand } = require("@aws-sdk/client-cloudfront"); // CommonJS import + * const client = new CloudFrontClient(config); + * const command = new GetFieldLevelEncryptionCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetFieldLevelEncryptionCommandInput} for command's `input` shape. + * @see {@link GetFieldLevelEncryptionCommandOutput} for command's `response` shape. + * @see {@link CloudFrontClientResolvedConfig | config} for command's `input` shape. + * */ export class GetFieldLevelEncryptionCommand extends $Command< GetFieldLevelEncryptionCommandInput, diff --git a/clients/client-cloudfront/commands/GetFieldLevelEncryptionConfigCommand.ts b/clients/client-cloudfront/commands/GetFieldLevelEncryptionConfigCommand.ts index 0b475e094820..be746dbe7319 100644 --- a/clients/client-cloudfront/commands/GetFieldLevelEncryptionConfigCommand.ts +++ b/clients/client-cloudfront/commands/GetFieldLevelEncryptionConfigCommand.ts @@ -24,6 +24,20 @@ export interface GetFieldLevelEncryptionConfigCommandOutput /** *

Get the field-level encryption configuration information.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { CloudFrontClient, GetFieldLevelEncryptionConfigCommand } from "@aws-sdk/client-cloudfront"; // ES Modules import + * // const { CloudFrontClient, GetFieldLevelEncryptionConfigCommand } = require("@aws-sdk/client-cloudfront"); // CommonJS import + * const client = new CloudFrontClient(config); + * const command = new GetFieldLevelEncryptionConfigCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetFieldLevelEncryptionConfigCommandInput} for command's `input` shape. + * @see {@link GetFieldLevelEncryptionConfigCommandOutput} for command's `response` shape. + * @see {@link CloudFrontClientResolvedConfig | config} for command's `input` shape. + * */ export class GetFieldLevelEncryptionConfigCommand extends $Command< GetFieldLevelEncryptionConfigCommandInput, diff --git a/clients/client-cloudfront/commands/GetFieldLevelEncryptionProfileCommand.ts b/clients/client-cloudfront/commands/GetFieldLevelEncryptionProfileCommand.ts index 34947afaff61..e9fc5f6efa32 100644 --- a/clients/client-cloudfront/commands/GetFieldLevelEncryptionProfileCommand.ts +++ b/clients/client-cloudfront/commands/GetFieldLevelEncryptionProfileCommand.ts @@ -24,6 +24,20 @@ export interface GetFieldLevelEncryptionProfileCommandOutput /** *

Get the field-level encryption profile information.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { CloudFrontClient, GetFieldLevelEncryptionProfileCommand } from "@aws-sdk/client-cloudfront"; // ES Modules import + * // const { CloudFrontClient, GetFieldLevelEncryptionProfileCommand } = require("@aws-sdk/client-cloudfront"); // CommonJS import + * const client = new CloudFrontClient(config); + * const command = new GetFieldLevelEncryptionProfileCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetFieldLevelEncryptionProfileCommandInput} for command's `input` shape. + * @see {@link GetFieldLevelEncryptionProfileCommandOutput} for command's `response` shape. + * @see {@link CloudFrontClientResolvedConfig | config} for command's `input` shape. + * */ export class GetFieldLevelEncryptionProfileCommand extends $Command< GetFieldLevelEncryptionProfileCommandInput, diff --git a/clients/client-cloudfront/commands/GetFieldLevelEncryptionProfileConfigCommand.ts b/clients/client-cloudfront/commands/GetFieldLevelEncryptionProfileConfigCommand.ts index f8454039a7ea..3ddce5ab4e60 100644 --- a/clients/client-cloudfront/commands/GetFieldLevelEncryptionProfileConfigCommand.ts +++ b/clients/client-cloudfront/commands/GetFieldLevelEncryptionProfileConfigCommand.ts @@ -27,6 +27,20 @@ export interface GetFieldLevelEncryptionProfileConfigCommandOutput /** *

Get the field-level encryption profile configuration information.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { CloudFrontClient, GetFieldLevelEncryptionProfileConfigCommand } from "@aws-sdk/client-cloudfront"; // ES Modules import + * // const { CloudFrontClient, GetFieldLevelEncryptionProfileConfigCommand } = require("@aws-sdk/client-cloudfront"); // CommonJS import + * const client = new CloudFrontClient(config); + * const command = new GetFieldLevelEncryptionProfileConfigCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetFieldLevelEncryptionProfileConfigCommandInput} for command's `input` shape. + * @see {@link GetFieldLevelEncryptionProfileConfigCommandOutput} for command's `response` shape. + * @see {@link CloudFrontClientResolvedConfig | config} for command's `input` shape. + * */ export class GetFieldLevelEncryptionProfileConfigCommand extends $Command< GetFieldLevelEncryptionProfileConfigCommandInput, diff --git a/clients/client-cloudfront/commands/GetInvalidationCommand.ts b/clients/client-cloudfront/commands/GetInvalidationCommand.ts index 07423c6852d4..83bd918a368c 100644 --- a/clients/client-cloudfront/commands/GetInvalidationCommand.ts +++ b/clients/client-cloudfront/commands/GetInvalidationCommand.ts @@ -22,6 +22,20 @@ export interface GetInvalidationCommandOutput extends GetInvalidationResult, __M /** *

Get the information about an invalidation.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { CloudFrontClient, GetInvalidationCommand } from "@aws-sdk/client-cloudfront"; // ES Modules import + * // const { CloudFrontClient, GetInvalidationCommand } = require("@aws-sdk/client-cloudfront"); // CommonJS import + * const client = new CloudFrontClient(config); + * const command = new GetInvalidationCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetInvalidationCommandInput} for command's `input` shape. + * @see {@link GetInvalidationCommandOutput} for command's `response` shape. + * @see {@link CloudFrontClientResolvedConfig | config} for command's `input` shape. + * */ export class GetInvalidationCommand extends $Command< GetInvalidationCommandInput, diff --git a/clients/client-cloudfront/commands/GetKeyGroupCommand.ts b/clients/client-cloudfront/commands/GetKeyGroupCommand.ts index 098509d90c2b..b1e8c616eab3 100644 --- a/clients/client-cloudfront/commands/GetKeyGroupCommand.ts +++ b/clients/client-cloudfront/commands/GetKeyGroupCommand.ts @@ -27,6 +27,20 @@ export interface GetKeyGroupCommandOutput extends GetKeyGroupResult, __MetadataB * using ListDistributions or GetDistribution. If the key group * is not referenced in a cache behavior, you can get the identifier using * ListKeyGroups.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { CloudFrontClient, GetKeyGroupCommand } from "@aws-sdk/client-cloudfront"; // ES Modules import + * // const { CloudFrontClient, GetKeyGroupCommand } = require("@aws-sdk/client-cloudfront"); // CommonJS import + * const client = new CloudFrontClient(config); + * const command = new GetKeyGroupCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetKeyGroupCommandInput} for command's `input` shape. + * @see {@link GetKeyGroupCommandOutput} for command's `response` shape. + * @see {@link CloudFrontClientResolvedConfig | config} for command's `input` shape. + * */ export class GetKeyGroupCommand extends $Command< GetKeyGroupCommandInput, diff --git a/clients/client-cloudfront/commands/GetKeyGroupConfigCommand.ts b/clients/client-cloudfront/commands/GetKeyGroupConfigCommand.ts index 88d54d4ec22b..683b8d23afaa 100644 --- a/clients/client-cloudfront/commands/GetKeyGroupConfigCommand.ts +++ b/clients/client-cloudfront/commands/GetKeyGroupConfigCommand.ts @@ -27,6 +27,20 @@ export interface GetKeyGroupConfigCommandOutput extends GetKeyGroupConfigResult, * identifier using ListDistributions or GetDistribution. If the * key group is not referenced in a cache behavior, you can get the identifier using * ListKeyGroups.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { CloudFrontClient, GetKeyGroupConfigCommand } from "@aws-sdk/client-cloudfront"; // ES Modules import + * // const { CloudFrontClient, GetKeyGroupConfigCommand } = require("@aws-sdk/client-cloudfront"); // CommonJS import + * const client = new CloudFrontClient(config); + * const command = new GetKeyGroupConfigCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetKeyGroupConfigCommandInput} for command's `input` shape. + * @see {@link GetKeyGroupConfigCommandOutput} for command's `response` shape. + * @see {@link CloudFrontClientResolvedConfig | config} for command's `input` shape. + * */ export class GetKeyGroupConfigCommand extends $Command< GetKeyGroupConfigCommandInput, diff --git a/clients/client-cloudfront/commands/GetMonitoringSubscriptionCommand.ts b/clients/client-cloudfront/commands/GetMonitoringSubscriptionCommand.ts index 92fc3d51b8b2..8a02e1b870f1 100644 --- a/clients/client-cloudfront/commands/GetMonitoringSubscriptionCommand.ts +++ b/clients/client-cloudfront/commands/GetMonitoringSubscriptionCommand.ts @@ -23,6 +23,20 @@ export interface GetMonitoringSubscriptionCommandOutput extends GetMonitoringSub /** *

Gets information about whether additional CloudWatch metrics are enabled for the specified * CloudFront distribution.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { CloudFrontClient, GetMonitoringSubscriptionCommand } from "@aws-sdk/client-cloudfront"; // ES Modules import + * // const { CloudFrontClient, GetMonitoringSubscriptionCommand } = require("@aws-sdk/client-cloudfront"); // CommonJS import + * const client = new CloudFrontClient(config); + * const command = new GetMonitoringSubscriptionCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetMonitoringSubscriptionCommandInput} for command's `input` shape. + * @see {@link GetMonitoringSubscriptionCommandOutput} for command's `response` shape. + * @see {@link CloudFrontClientResolvedConfig | config} for command's `input` shape. + * */ export class GetMonitoringSubscriptionCommand extends $Command< GetMonitoringSubscriptionCommandInput, diff --git a/clients/client-cloudfront/commands/GetOriginRequestPolicyCommand.ts b/clients/client-cloudfront/commands/GetOriginRequestPolicyCommand.ts index e3ac7ecf0488..4f6cb7b6376c 100644 --- a/clients/client-cloudfront/commands/GetOriginRequestPolicyCommand.ts +++ b/clients/client-cloudfront/commands/GetOriginRequestPolicyCommand.ts @@ -35,6 +35,20 @@ export interface GetOriginRequestPolicyCommandOutput extends GetOriginRequestPol * identifier using ListDistributions or GetDistribution. If the * origin request policy is not attached to a cache behavior, you can get the identifier * using ListOriginRequestPolicies.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { CloudFrontClient, GetOriginRequestPolicyCommand } from "@aws-sdk/client-cloudfront"; // ES Modules import + * // const { CloudFrontClient, GetOriginRequestPolicyCommand } = require("@aws-sdk/client-cloudfront"); // CommonJS import + * const client = new CloudFrontClient(config); + * const command = new GetOriginRequestPolicyCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetOriginRequestPolicyCommandInput} for command's `input` shape. + * @see {@link GetOriginRequestPolicyCommandOutput} for command's `response` shape. + * @see {@link CloudFrontClientResolvedConfig | config} for command's `input` shape. + * */ export class GetOriginRequestPolicyCommand extends $Command< GetOriginRequestPolicyCommandInput, diff --git a/clients/client-cloudfront/commands/GetOriginRequestPolicyConfigCommand.ts b/clients/client-cloudfront/commands/GetOriginRequestPolicyConfigCommand.ts index 12f9848247e2..b185b169bae7 100644 --- a/clients/client-cloudfront/commands/GetOriginRequestPolicyConfigCommand.ts +++ b/clients/client-cloudfront/commands/GetOriginRequestPolicyConfigCommand.ts @@ -30,6 +30,20 @@ export interface GetOriginRequestPolicyConfigCommandOutput * GetDistribution. If the origin request policy is not attached to a cache * behavior, you can get the identifier using * ListOriginRequestPolicies.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { CloudFrontClient, GetOriginRequestPolicyConfigCommand } from "@aws-sdk/client-cloudfront"; // ES Modules import + * // const { CloudFrontClient, GetOriginRequestPolicyConfigCommand } = require("@aws-sdk/client-cloudfront"); // CommonJS import + * const client = new CloudFrontClient(config); + * const command = new GetOriginRequestPolicyConfigCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetOriginRequestPolicyConfigCommandInput} for command's `input` shape. + * @see {@link GetOriginRequestPolicyConfigCommandOutput} for command's `response` shape. + * @see {@link CloudFrontClientResolvedConfig | config} for command's `input` shape. + * */ export class GetOriginRequestPolicyConfigCommand extends $Command< GetOriginRequestPolicyConfigCommandInput, diff --git a/clients/client-cloudfront/commands/GetPublicKeyCommand.ts b/clients/client-cloudfront/commands/GetPublicKeyCommand.ts index 11eaeebfe0b7..904ccf554769 100644 --- a/clients/client-cloudfront/commands/GetPublicKeyCommand.ts +++ b/clients/client-cloudfront/commands/GetPublicKeyCommand.ts @@ -22,6 +22,20 @@ export interface GetPublicKeyCommandOutput extends GetPublicKeyResult, __Metadat /** *

Gets a public key.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { CloudFrontClient, GetPublicKeyCommand } from "@aws-sdk/client-cloudfront"; // ES Modules import + * // const { CloudFrontClient, GetPublicKeyCommand } = require("@aws-sdk/client-cloudfront"); // CommonJS import + * const client = new CloudFrontClient(config); + * const command = new GetPublicKeyCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetPublicKeyCommandInput} for command's `input` shape. + * @see {@link GetPublicKeyCommandOutput} for command's `response` shape. + * @see {@link CloudFrontClientResolvedConfig | config} for command's `input` shape. + * */ export class GetPublicKeyCommand extends $Command< GetPublicKeyCommandInput, diff --git a/clients/client-cloudfront/commands/GetPublicKeyConfigCommand.ts b/clients/client-cloudfront/commands/GetPublicKeyConfigCommand.ts index e3328ebaa72e..2ae37a6b36a2 100644 --- a/clients/client-cloudfront/commands/GetPublicKeyConfigCommand.ts +++ b/clients/client-cloudfront/commands/GetPublicKeyConfigCommand.ts @@ -22,6 +22,20 @@ export interface GetPublicKeyConfigCommandOutput extends GetPublicKeyConfigResul /** *

Gets a public key configuration.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { CloudFrontClient, GetPublicKeyConfigCommand } from "@aws-sdk/client-cloudfront"; // ES Modules import + * // const { CloudFrontClient, GetPublicKeyConfigCommand } = require("@aws-sdk/client-cloudfront"); // CommonJS import + * const client = new CloudFrontClient(config); + * const command = new GetPublicKeyConfigCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetPublicKeyConfigCommandInput} for command's `input` shape. + * @see {@link GetPublicKeyConfigCommandOutput} for command's `response` shape. + * @see {@link CloudFrontClientResolvedConfig | config} for command's `input` shape. + * */ export class GetPublicKeyConfigCommand extends $Command< GetPublicKeyConfigCommandInput, diff --git a/clients/client-cloudfront/commands/GetRealtimeLogConfigCommand.ts b/clients/client-cloudfront/commands/GetRealtimeLogConfigCommand.ts index 05b5d915ac09..8034e8a7e3c8 100644 --- a/clients/client-cloudfront/commands/GetRealtimeLogConfigCommand.ts +++ b/clients/client-cloudfront/commands/GetRealtimeLogConfigCommand.ts @@ -26,6 +26,20 @@ export interface GetRealtimeLogConfigCommandOutput extends GetRealtimeLogConfigR *

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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { CloudFrontClient, GetRealtimeLogConfigCommand } from "@aws-sdk/client-cloudfront"; // ES Modules import + * // const { CloudFrontClient, GetRealtimeLogConfigCommand } = require("@aws-sdk/client-cloudfront"); // CommonJS import + * const client = new CloudFrontClient(config); + * const command = new GetRealtimeLogConfigCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetRealtimeLogConfigCommandInput} for command's `input` shape. + * @see {@link GetRealtimeLogConfigCommandOutput} for command's `response` shape. + * @see {@link CloudFrontClientResolvedConfig | config} for command's `input` shape. + * */ export class GetRealtimeLogConfigCommand extends $Command< GetRealtimeLogConfigCommandInput, diff --git a/clients/client-cloudfront/commands/GetStreamingDistributionCommand.ts b/clients/client-cloudfront/commands/GetStreamingDistributionCommand.ts index e99f5a6cf79a..cda5624bef85 100644 --- a/clients/client-cloudfront/commands/GetStreamingDistributionCommand.ts +++ b/clients/client-cloudfront/commands/GetStreamingDistributionCommand.ts @@ -22,6 +22,20 @@ export interface GetStreamingDistributionCommandOutput extends GetStreamingDistr /** *

Gets information about a specified RTMP distribution, including the distribution configuration.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { CloudFrontClient, GetStreamingDistributionCommand } from "@aws-sdk/client-cloudfront"; // ES Modules import + * // const { CloudFrontClient, GetStreamingDistributionCommand } = require("@aws-sdk/client-cloudfront"); // CommonJS import + * const client = new CloudFrontClient(config); + * const command = new GetStreamingDistributionCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetStreamingDistributionCommandInput} for command's `input` shape. + * @see {@link GetStreamingDistributionCommandOutput} for command's `response` shape. + * @see {@link CloudFrontClientResolvedConfig | config} for command's `input` shape. + * */ export class GetStreamingDistributionCommand extends $Command< GetStreamingDistributionCommandInput, diff --git a/clients/client-cloudfront/commands/GetStreamingDistributionConfigCommand.ts b/clients/client-cloudfront/commands/GetStreamingDistributionConfigCommand.ts index 2eee26a26a0c..f9186332caa9 100644 --- a/clients/client-cloudfront/commands/GetStreamingDistributionConfigCommand.ts +++ b/clients/client-cloudfront/commands/GetStreamingDistributionConfigCommand.ts @@ -24,6 +24,20 @@ export interface GetStreamingDistributionConfigCommandOutput /** *

Get the configuration information about a streaming distribution.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { CloudFrontClient, GetStreamingDistributionConfigCommand } from "@aws-sdk/client-cloudfront"; // ES Modules import + * // const { CloudFrontClient, GetStreamingDistributionConfigCommand } = require("@aws-sdk/client-cloudfront"); // CommonJS import + * const client = new CloudFrontClient(config); + * const command = new GetStreamingDistributionConfigCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetStreamingDistributionConfigCommandInput} for command's `input` shape. + * @see {@link GetStreamingDistributionConfigCommandOutput} for command's `response` shape. + * @see {@link CloudFrontClientResolvedConfig | config} for command's `input` shape. + * */ export class GetStreamingDistributionConfigCommand extends $Command< GetStreamingDistributionConfigCommandInput, diff --git a/clients/client-cloudfront/commands/ListCachePoliciesCommand.ts b/clients/client-cloudfront/commands/ListCachePoliciesCommand.ts index 9b902a56d6a9..ad0141ea558a 100644 --- a/clients/client-cloudfront/commands/ListCachePoliciesCommand.ts +++ b/clients/client-cloudfront/commands/ListCachePoliciesCommand.ts @@ -29,6 +29,20 @@ export interface ListCachePoliciesCommandOutput extends ListCachePoliciesResult, * 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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { CloudFrontClient, ListCachePoliciesCommand } from "@aws-sdk/client-cloudfront"; // ES Modules import + * // const { CloudFrontClient, ListCachePoliciesCommand } = require("@aws-sdk/client-cloudfront"); // CommonJS import + * const client = new CloudFrontClient(config); + * const command = new ListCachePoliciesCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListCachePoliciesCommandInput} for command's `input` shape. + * @see {@link ListCachePoliciesCommandOutput} for command's `response` shape. + * @see {@link CloudFrontClientResolvedConfig | config} for command's `input` shape. + * */ export class ListCachePoliciesCommand extends $Command< ListCachePoliciesCommandInput, diff --git a/clients/client-cloudfront/commands/ListCloudFrontOriginAccessIdentitiesCommand.ts b/clients/client-cloudfront/commands/ListCloudFrontOriginAccessIdentitiesCommand.ts index aa3c544a5bfe..450401937b88 100644 --- a/clients/client-cloudfront/commands/ListCloudFrontOriginAccessIdentitiesCommand.ts +++ b/clients/client-cloudfront/commands/ListCloudFrontOriginAccessIdentitiesCommand.ts @@ -27,6 +27,20 @@ export interface ListCloudFrontOriginAccessIdentitiesCommandOutput /** *

Lists origin access identities.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { CloudFrontClient, ListCloudFrontOriginAccessIdentitiesCommand } from "@aws-sdk/client-cloudfront"; // ES Modules import + * // const { CloudFrontClient, ListCloudFrontOriginAccessIdentitiesCommand } = require("@aws-sdk/client-cloudfront"); // CommonJS import + * const client = new CloudFrontClient(config); + * const command = new ListCloudFrontOriginAccessIdentitiesCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListCloudFrontOriginAccessIdentitiesCommandInput} for command's `input` shape. + * @see {@link ListCloudFrontOriginAccessIdentitiesCommandOutput} for command's `response` shape. + * @see {@link CloudFrontClientResolvedConfig | config} for command's `input` shape. + * */ export class ListCloudFrontOriginAccessIdentitiesCommand extends $Command< ListCloudFrontOriginAccessIdentitiesCommandInput, diff --git a/clients/client-cloudfront/commands/ListDistributionsByCachePolicyIdCommand.ts b/clients/client-cloudfront/commands/ListDistributionsByCachePolicyIdCommand.ts index 1933c0ef5d1d..8da993c1506d 100644 --- a/clients/client-cloudfront/commands/ListDistributionsByCachePolicyIdCommand.ts +++ b/clients/client-cloudfront/commands/ListDistributionsByCachePolicyIdCommand.ts @@ -30,6 +30,20 @@ export interface ListDistributionsByCachePolicyIdCommandOutput * 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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { CloudFrontClient, ListDistributionsByCachePolicyIdCommand } from "@aws-sdk/client-cloudfront"; // ES Modules import + * // const { CloudFrontClient, ListDistributionsByCachePolicyIdCommand } = require("@aws-sdk/client-cloudfront"); // CommonJS import + * const client = new CloudFrontClient(config); + * const command = new ListDistributionsByCachePolicyIdCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListDistributionsByCachePolicyIdCommandInput} for command's `input` shape. + * @see {@link ListDistributionsByCachePolicyIdCommandOutput} for command's `response` shape. + * @see {@link CloudFrontClientResolvedConfig | config} for command's `input` shape. + * */ export class ListDistributionsByCachePolicyIdCommand extends $Command< ListDistributionsByCachePolicyIdCommandInput, diff --git a/clients/client-cloudfront/commands/ListDistributionsByKeyGroupCommand.ts b/clients/client-cloudfront/commands/ListDistributionsByKeyGroupCommand.ts index 9962b33081b3..d321941ca509 100644 --- a/clients/client-cloudfront/commands/ListDistributionsByKeyGroupCommand.ts +++ b/clients/client-cloudfront/commands/ListDistributionsByKeyGroupCommand.ts @@ -28,6 +28,20 @@ export interface ListDistributionsByKeyGroupCommandOutput extends ListDistributi * 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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { CloudFrontClient, ListDistributionsByKeyGroupCommand } from "@aws-sdk/client-cloudfront"; // ES Modules import + * // const { CloudFrontClient, ListDistributionsByKeyGroupCommand } = require("@aws-sdk/client-cloudfront"); // CommonJS import + * const client = new CloudFrontClient(config); + * const command = new ListDistributionsByKeyGroupCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListDistributionsByKeyGroupCommandInput} for command's `input` shape. + * @see {@link ListDistributionsByKeyGroupCommandOutput} for command's `response` shape. + * @see {@link CloudFrontClientResolvedConfig | config} for command's `input` shape. + * */ export class ListDistributionsByKeyGroupCommand extends $Command< ListDistributionsByKeyGroupCommandInput, diff --git a/clients/client-cloudfront/commands/ListDistributionsByOriginRequestPolicyIdCommand.ts b/clients/client-cloudfront/commands/ListDistributionsByOriginRequestPolicyIdCommand.ts index 392718e9a0f1..8d47277779aa 100644 --- a/clients/client-cloudfront/commands/ListDistributionsByOriginRequestPolicyIdCommand.ts +++ b/clients/client-cloudfront/commands/ListDistributionsByOriginRequestPolicyIdCommand.ts @@ -34,6 +34,20 @@ export interface ListDistributionsByOriginRequestPolicyIdCommandOutput * 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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { CloudFrontClient, ListDistributionsByOriginRequestPolicyIdCommand } from "@aws-sdk/client-cloudfront"; // ES Modules import + * // const { CloudFrontClient, ListDistributionsByOriginRequestPolicyIdCommand } = require("@aws-sdk/client-cloudfront"); // CommonJS import + * const client = new CloudFrontClient(config); + * const command = new ListDistributionsByOriginRequestPolicyIdCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListDistributionsByOriginRequestPolicyIdCommandInput} for command's `input` shape. + * @see {@link ListDistributionsByOriginRequestPolicyIdCommandOutput} for command's `response` shape. + * @see {@link CloudFrontClientResolvedConfig | config} for command's `input` shape. + * */ export class ListDistributionsByOriginRequestPolicyIdCommand extends $Command< ListDistributionsByOriginRequestPolicyIdCommandInput, diff --git a/clients/client-cloudfront/commands/ListDistributionsByRealtimeLogConfigCommand.ts b/clients/client-cloudfront/commands/ListDistributionsByRealtimeLogConfigCommand.ts index 7b1c0d13abad..f1cb65d10599 100644 --- a/clients/client-cloudfront/commands/ListDistributionsByRealtimeLogConfigCommand.ts +++ b/clients/client-cloudfront/commands/ListDistributionsByRealtimeLogConfigCommand.ts @@ -36,6 +36,20 @@ export interface ListDistributionsByRealtimeLogConfigCommandOutput * 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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { CloudFrontClient, ListDistributionsByRealtimeLogConfigCommand } from "@aws-sdk/client-cloudfront"; // ES Modules import + * // const { CloudFrontClient, ListDistributionsByRealtimeLogConfigCommand } = require("@aws-sdk/client-cloudfront"); // CommonJS import + * const client = new CloudFrontClient(config); + * const command = new ListDistributionsByRealtimeLogConfigCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListDistributionsByRealtimeLogConfigCommandInput} for command's `input` shape. + * @see {@link ListDistributionsByRealtimeLogConfigCommandOutput} for command's `response` shape. + * @see {@link CloudFrontClientResolvedConfig | config} for command's `input` shape. + * */ export class ListDistributionsByRealtimeLogConfigCommand extends $Command< ListDistributionsByRealtimeLogConfigCommandInput, diff --git a/clients/client-cloudfront/commands/ListDistributionsByWebACLIdCommand.ts b/clients/client-cloudfront/commands/ListDistributionsByWebACLIdCommand.ts index 663d2f61c9c3..5f5ebf6f89ec 100644 --- a/clients/client-cloudfront/commands/ListDistributionsByWebACLIdCommand.ts +++ b/clients/client-cloudfront/commands/ListDistributionsByWebACLIdCommand.ts @@ -22,6 +22,20 @@ export interface ListDistributionsByWebACLIdCommandOutput extends ListDistributi /** *

List the distributions that are associated with a specified AWS WAF web ACL.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { CloudFrontClient, ListDistributionsByWebACLIdCommand } from "@aws-sdk/client-cloudfront"; // ES Modules import + * // const { CloudFrontClient, ListDistributionsByWebACLIdCommand } = require("@aws-sdk/client-cloudfront"); // CommonJS import + * const client = new CloudFrontClient(config); + * const command = new ListDistributionsByWebACLIdCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListDistributionsByWebACLIdCommandInput} for command's `input` shape. + * @see {@link ListDistributionsByWebACLIdCommandOutput} for command's `response` shape. + * @see {@link CloudFrontClientResolvedConfig | config} for command's `input` shape. + * */ export class ListDistributionsByWebACLIdCommand extends $Command< ListDistributionsByWebACLIdCommandInput, diff --git a/clients/client-cloudfront/commands/ListDistributionsCommand.ts b/clients/client-cloudfront/commands/ListDistributionsCommand.ts index 68a4693f5569..0154215abbfa 100644 --- a/clients/client-cloudfront/commands/ListDistributionsCommand.ts +++ b/clients/client-cloudfront/commands/ListDistributionsCommand.ts @@ -22,6 +22,20 @@ export interface ListDistributionsCommandOutput extends ListDistributionsResult, /** *

List CloudFront distributions.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { CloudFrontClient, ListDistributionsCommand } from "@aws-sdk/client-cloudfront"; // ES Modules import + * // const { CloudFrontClient, ListDistributionsCommand } = require("@aws-sdk/client-cloudfront"); // CommonJS import + * const client = new CloudFrontClient(config); + * const command = new ListDistributionsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListDistributionsCommandInput} for command's `input` shape. + * @see {@link ListDistributionsCommandOutput} for command's `response` shape. + * @see {@link CloudFrontClientResolvedConfig | config} for command's `input` shape. + * */ export class ListDistributionsCommand extends $Command< ListDistributionsCommandInput, diff --git a/clients/client-cloudfront/commands/ListFieldLevelEncryptionConfigsCommand.ts b/clients/client-cloudfront/commands/ListFieldLevelEncryptionConfigsCommand.ts index 6f4365cf21c6..1be89bb7958b 100644 --- a/clients/client-cloudfront/commands/ListFieldLevelEncryptionConfigsCommand.ts +++ b/clients/client-cloudfront/commands/ListFieldLevelEncryptionConfigsCommand.ts @@ -24,6 +24,20 @@ export interface ListFieldLevelEncryptionConfigsCommandOutput /** *

List all field-level encryption configurations that have been created in CloudFront for this account.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { CloudFrontClient, ListFieldLevelEncryptionConfigsCommand } from "@aws-sdk/client-cloudfront"; // ES Modules import + * // const { CloudFrontClient, ListFieldLevelEncryptionConfigsCommand } = require("@aws-sdk/client-cloudfront"); // CommonJS import + * const client = new CloudFrontClient(config); + * const command = new ListFieldLevelEncryptionConfigsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListFieldLevelEncryptionConfigsCommandInput} for command's `input` shape. + * @see {@link ListFieldLevelEncryptionConfigsCommandOutput} for command's `response` shape. + * @see {@link CloudFrontClientResolvedConfig | config} for command's `input` shape. + * */ export class ListFieldLevelEncryptionConfigsCommand extends $Command< ListFieldLevelEncryptionConfigsCommandInput, diff --git a/clients/client-cloudfront/commands/ListFieldLevelEncryptionProfilesCommand.ts b/clients/client-cloudfront/commands/ListFieldLevelEncryptionProfilesCommand.ts index b18a1c1188f4..e27b44df8ccc 100644 --- a/clients/client-cloudfront/commands/ListFieldLevelEncryptionProfilesCommand.ts +++ b/clients/client-cloudfront/commands/ListFieldLevelEncryptionProfilesCommand.ts @@ -24,6 +24,20 @@ export interface ListFieldLevelEncryptionProfilesCommandOutput /** *

Request a list of field-level encryption profiles that have been created in CloudFront for this account.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { CloudFrontClient, ListFieldLevelEncryptionProfilesCommand } from "@aws-sdk/client-cloudfront"; // ES Modules import + * // const { CloudFrontClient, ListFieldLevelEncryptionProfilesCommand } = require("@aws-sdk/client-cloudfront"); // CommonJS import + * const client = new CloudFrontClient(config); + * const command = new ListFieldLevelEncryptionProfilesCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListFieldLevelEncryptionProfilesCommandInput} for command's `input` shape. + * @see {@link ListFieldLevelEncryptionProfilesCommandOutput} for command's `response` shape. + * @see {@link CloudFrontClientResolvedConfig | config} for command's `input` shape. + * */ export class ListFieldLevelEncryptionProfilesCommand extends $Command< ListFieldLevelEncryptionProfilesCommandInput, diff --git a/clients/client-cloudfront/commands/ListInvalidationsCommand.ts b/clients/client-cloudfront/commands/ListInvalidationsCommand.ts index 5c617ea9e8c0..d5280c19cf61 100644 --- a/clients/client-cloudfront/commands/ListInvalidationsCommand.ts +++ b/clients/client-cloudfront/commands/ListInvalidationsCommand.ts @@ -22,6 +22,20 @@ export interface ListInvalidationsCommandOutput extends ListInvalidationsResult, /** *

Lists invalidation batches.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { CloudFrontClient, ListInvalidationsCommand } from "@aws-sdk/client-cloudfront"; // ES Modules import + * // const { CloudFrontClient, ListInvalidationsCommand } = require("@aws-sdk/client-cloudfront"); // CommonJS import + * const client = new CloudFrontClient(config); + * const command = new ListInvalidationsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListInvalidationsCommandInput} for command's `input` shape. + * @see {@link ListInvalidationsCommandOutput} for command's `response` shape. + * @see {@link CloudFrontClientResolvedConfig | config} for command's `input` shape. + * */ export class ListInvalidationsCommand extends $Command< ListInvalidationsCommandInput, diff --git a/clients/client-cloudfront/commands/ListKeyGroupsCommand.ts b/clients/client-cloudfront/commands/ListKeyGroupsCommand.ts index 4b5497787519..4afb6ddded38 100644 --- a/clients/client-cloudfront/commands/ListKeyGroupsCommand.ts +++ b/clients/client-cloudfront/commands/ListKeyGroupsCommand.ts @@ -27,6 +27,20 @@ export interface ListKeyGroupsCommandOutput extends ListKeyGroupsResult, __Metad * 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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { CloudFrontClient, ListKeyGroupsCommand } from "@aws-sdk/client-cloudfront"; // ES Modules import + * // const { CloudFrontClient, ListKeyGroupsCommand } = require("@aws-sdk/client-cloudfront"); // CommonJS import + * const client = new CloudFrontClient(config); + * const command = new ListKeyGroupsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListKeyGroupsCommandInput} for command's `input` shape. + * @see {@link ListKeyGroupsCommandOutput} for command's `response` shape. + * @see {@link CloudFrontClientResolvedConfig | config} for command's `input` shape. + * */ export class ListKeyGroupsCommand extends $Command< ListKeyGroupsCommandInput, diff --git a/clients/client-cloudfront/commands/ListOriginRequestPoliciesCommand.ts b/clients/client-cloudfront/commands/ListOriginRequestPoliciesCommand.ts index 37d2b49d243d..ea810b47ea26 100644 --- a/clients/client-cloudfront/commands/ListOriginRequestPoliciesCommand.ts +++ b/clients/client-cloudfront/commands/ListOriginRequestPoliciesCommand.ts @@ -29,6 +29,20 @@ export interface ListOriginRequestPoliciesCommandOutput extends ListOriginReques * 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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { CloudFrontClient, ListOriginRequestPoliciesCommand } from "@aws-sdk/client-cloudfront"; // ES Modules import + * // const { CloudFrontClient, ListOriginRequestPoliciesCommand } = require("@aws-sdk/client-cloudfront"); // CommonJS import + * const client = new CloudFrontClient(config); + * const command = new ListOriginRequestPoliciesCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListOriginRequestPoliciesCommandInput} for command's `input` shape. + * @see {@link ListOriginRequestPoliciesCommandOutput} for command's `response` shape. + * @see {@link CloudFrontClientResolvedConfig | config} for command's `input` shape. + * */ export class ListOriginRequestPoliciesCommand extends $Command< ListOriginRequestPoliciesCommandInput, diff --git a/clients/client-cloudfront/commands/ListPublicKeysCommand.ts b/clients/client-cloudfront/commands/ListPublicKeysCommand.ts index a76aaa92b7d6..74ce9d91c1d5 100644 --- a/clients/client-cloudfront/commands/ListPublicKeysCommand.ts +++ b/clients/client-cloudfront/commands/ListPublicKeysCommand.ts @@ -22,6 +22,20 @@ export interface ListPublicKeysCommandOutput extends ListPublicKeysResult, __Met /** *

List all public keys that have been added to CloudFront for this account.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { CloudFrontClient, ListPublicKeysCommand } from "@aws-sdk/client-cloudfront"; // ES Modules import + * // const { CloudFrontClient, ListPublicKeysCommand } = require("@aws-sdk/client-cloudfront"); // CommonJS import + * const client = new CloudFrontClient(config); + * const command = new ListPublicKeysCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListPublicKeysCommandInput} for command's `input` shape. + * @see {@link ListPublicKeysCommandOutput} for command's `response` shape. + * @see {@link CloudFrontClientResolvedConfig | config} for command's `input` shape. + * */ export class ListPublicKeysCommand extends $Command< ListPublicKeysCommandInput, diff --git a/clients/client-cloudfront/commands/ListRealtimeLogConfigsCommand.ts b/clients/client-cloudfront/commands/ListRealtimeLogConfigsCommand.ts index fc755b5a2200..7501c82e74d0 100644 --- a/clients/client-cloudfront/commands/ListRealtimeLogConfigsCommand.ts +++ b/clients/client-cloudfront/commands/ListRealtimeLogConfigsCommand.ts @@ -27,6 +27,20 @@ export interface ListRealtimeLogConfigsCommandOutput extends ListRealtimeLogConf * 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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { CloudFrontClient, ListRealtimeLogConfigsCommand } from "@aws-sdk/client-cloudfront"; // ES Modules import + * // const { CloudFrontClient, ListRealtimeLogConfigsCommand } = require("@aws-sdk/client-cloudfront"); // CommonJS import + * const client = new CloudFrontClient(config); + * const command = new ListRealtimeLogConfigsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListRealtimeLogConfigsCommandInput} for command's `input` shape. + * @see {@link ListRealtimeLogConfigsCommandOutput} for command's `response` shape. + * @see {@link CloudFrontClientResolvedConfig | config} for command's `input` shape. + * */ export class ListRealtimeLogConfigsCommand extends $Command< ListRealtimeLogConfigsCommandInput, diff --git a/clients/client-cloudfront/commands/ListStreamingDistributionsCommand.ts b/clients/client-cloudfront/commands/ListStreamingDistributionsCommand.ts index 4a329367cc4d..c8a910175ae6 100644 --- a/clients/client-cloudfront/commands/ListStreamingDistributionsCommand.ts +++ b/clients/client-cloudfront/commands/ListStreamingDistributionsCommand.ts @@ -22,6 +22,20 @@ export interface ListStreamingDistributionsCommandOutput extends ListStreamingDi /** *

List streaming distributions.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { CloudFrontClient, ListStreamingDistributionsCommand } from "@aws-sdk/client-cloudfront"; // ES Modules import + * // const { CloudFrontClient, ListStreamingDistributionsCommand } = require("@aws-sdk/client-cloudfront"); // CommonJS import + * const client = new CloudFrontClient(config); + * const command = new ListStreamingDistributionsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListStreamingDistributionsCommandInput} for command's `input` shape. + * @see {@link ListStreamingDistributionsCommandOutput} for command's `response` shape. + * @see {@link CloudFrontClientResolvedConfig | config} for command's `input` shape. + * */ export class ListStreamingDistributionsCommand extends $Command< ListStreamingDistributionsCommandInput, diff --git a/clients/client-cloudfront/commands/ListTagsForResourceCommand.ts b/clients/client-cloudfront/commands/ListTagsForResourceCommand.ts index 0e7c11e7fa9b..d14c4d721924 100644 --- a/clients/client-cloudfront/commands/ListTagsForResourceCommand.ts +++ b/clients/client-cloudfront/commands/ListTagsForResourceCommand.ts @@ -22,6 +22,20 @@ export interface ListTagsForResourceCommandOutput extends ListTagsForResourceRes /** *

List tags for a CloudFront resource.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { CloudFrontClient, ListTagsForResourceCommand } from "@aws-sdk/client-cloudfront"; // ES Modules import + * // const { CloudFrontClient, ListTagsForResourceCommand } = require("@aws-sdk/client-cloudfront"); // CommonJS import + * const client = new CloudFrontClient(config); + * const command = new ListTagsForResourceCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListTagsForResourceCommandInput} for command's `input` shape. + * @see {@link ListTagsForResourceCommandOutput} for command's `response` shape. + * @see {@link CloudFrontClientResolvedConfig | config} for command's `input` shape. + * */ export class ListTagsForResourceCommand extends $Command< ListTagsForResourceCommandInput, diff --git a/clients/client-cloudfront/commands/TagResourceCommand.ts b/clients/client-cloudfront/commands/TagResourceCommand.ts index 2b223838a8da..bded4104349d 100644 --- a/clients/client-cloudfront/commands/TagResourceCommand.ts +++ b/clients/client-cloudfront/commands/TagResourceCommand.ts @@ -22,6 +22,20 @@ export interface TagResourceCommandOutput extends __MetadataBearer {} /** *

Add tags to a CloudFront resource.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { CloudFrontClient, TagResourceCommand } from "@aws-sdk/client-cloudfront"; // ES Modules import + * // const { CloudFrontClient, TagResourceCommand } = require("@aws-sdk/client-cloudfront"); // CommonJS import + * const client = new CloudFrontClient(config); + * const command = new TagResourceCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link TagResourceCommandInput} for command's `input` shape. + * @see {@link TagResourceCommandOutput} for command's `response` shape. + * @see {@link CloudFrontClientResolvedConfig | config} for command's `input` shape. + * */ export class TagResourceCommand extends $Command< TagResourceCommandInput, diff --git a/clients/client-cloudfront/commands/UntagResourceCommand.ts b/clients/client-cloudfront/commands/UntagResourceCommand.ts index b7d370765659..eca7f4def98e 100644 --- a/clients/client-cloudfront/commands/UntagResourceCommand.ts +++ b/clients/client-cloudfront/commands/UntagResourceCommand.ts @@ -22,6 +22,20 @@ export interface UntagResourceCommandOutput extends __MetadataBearer {} /** *

Remove tags from a CloudFront resource.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { CloudFrontClient, UntagResourceCommand } from "@aws-sdk/client-cloudfront"; // ES Modules import + * // const { CloudFrontClient, UntagResourceCommand } = require("@aws-sdk/client-cloudfront"); // CommonJS import + * const client = new CloudFrontClient(config); + * const command = new UntagResourceCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link UntagResourceCommandInput} for command's `input` shape. + * @see {@link UntagResourceCommandOutput} for command's `response` shape. + * @see {@link CloudFrontClientResolvedConfig | config} for command's `input` shape. + * */ export class UntagResourceCommand extends $Command< UntagResourceCommandInput, diff --git a/clients/client-cloudfront/commands/UpdateCachePolicyCommand.ts b/clients/client-cloudfront/commands/UpdateCachePolicyCommand.ts index e5e617b917b8..f631df57f717 100644 --- a/clients/client-cloudfront/commands/UpdateCachePolicyCommand.ts +++ b/clients/client-cloudfront/commands/UpdateCachePolicyCommand.ts @@ -39,6 +39,20 @@ export interface UpdateCachePolicyCommandOutput extends UpdateCachePolicyResult, * didn’t.

* * + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { CloudFrontClient, UpdateCachePolicyCommand } from "@aws-sdk/client-cloudfront"; // ES Modules import + * // const { CloudFrontClient, UpdateCachePolicyCommand } = require("@aws-sdk/client-cloudfront"); // CommonJS import + * const client = new CloudFrontClient(config); + * const command = new UpdateCachePolicyCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link UpdateCachePolicyCommandInput} for command's `input` shape. + * @see {@link UpdateCachePolicyCommandOutput} for command's `response` shape. + * @see {@link CloudFrontClientResolvedConfig | config} for command's `input` shape. + * */ export class UpdateCachePolicyCommand extends $Command< UpdateCachePolicyCommandInput, diff --git a/clients/client-cloudfront/commands/UpdateCloudFrontOriginAccessIdentityCommand.ts b/clients/client-cloudfront/commands/UpdateCloudFrontOriginAccessIdentityCommand.ts index a1edb1f91c62..b1da212c54a3 100644 --- a/clients/client-cloudfront/commands/UpdateCloudFrontOriginAccessIdentityCommand.ts +++ b/clients/client-cloudfront/commands/UpdateCloudFrontOriginAccessIdentityCommand.ts @@ -27,6 +27,20 @@ export interface UpdateCloudFrontOriginAccessIdentityCommandOutput /** *

Update an origin access identity.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { CloudFrontClient, UpdateCloudFrontOriginAccessIdentityCommand } from "@aws-sdk/client-cloudfront"; // ES Modules import + * // const { CloudFrontClient, UpdateCloudFrontOriginAccessIdentityCommand } = require("@aws-sdk/client-cloudfront"); // CommonJS import + * const client = new CloudFrontClient(config); + * const command = new UpdateCloudFrontOriginAccessIdentityCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link UpdateCloudFrontOriginAccessIdentityCommandInput} for command's `input` shape. + * @see {@link UpdateCloudFrontOriginAccessIdentityCommandOutput} for command's `response` shape. + * @see {@link CloudFrontClientResolvedConfig | config} for command's `input` shape. + * */ export class UpdateCloudFrontOriginAccessIdentityCommand extends $Command< UpdateCloudFrontOriginAccessIdentityCommandInput, diff --git a/clients/client-cloudfront/commands/UpdateDistributionCommand.ts b/clients/client-cloudfront/commands/UpdateDistributionCommand.ts index ce6589246453..e87c2ed9246b 100644 --- a/clients/client-cloudfront/commands/UpdateDistributionCommand.ts +++ b/clients/client-cloudfront/commands/UpdateDistributionCommand.ts @@ -100,6 +100,20 @@ export interface UpdateDistributionCommandOutput extends UpdateDistributionResul * When propagation is complete, the value of Status is Deployed.

* * + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { CloudFrontClient, UpdateDistributionCommand } from "@aws-sdk/client-cloudfront"; // ES Modules import + * // const { CloudFrontClient, UpdateDistributionCommand } = require("@aws-sdk/client-cloudfront"); // CommonJS import + * const client = new CloudFrontClient(config); + * const command = new UpdateDistributionCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link UpdateDistributionCommandInput} for command's `input` shape. + * @see {@link UpdateDistributionCommandOutput} for command's `response` shape. + * @see {@link CloudFrontClientResolvedConfig | config} for command's `input` shape. + * */ export class UpdateDistributionCommand extends $Command< UpdateDistributionCommandInput, diff --git a/clients/client-cloudfront/commands/UpdateFieldLevelEncryptionConfigCommand.ts b/clients/client-cloudfront/commands/UpdateFieldLevelEncryptionConfigCommand.ts index 73ba8b752895..7042afb3af9d 100644 --- a/clients/client-cloudfront/commands/UpdateFieldLevelEncryptionConfigCommand.ts +++ b/clients/client-cloudfront/commands/UpdateFieldLevelEncryptionConfigCommand.ts @@ -24,6 +24,20 @@ export interface UpdateFieldLevelEncryptionConfigCommandOutput /** *

Update a field-level encryption configuration.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { CloudFrontClient, UpdateFieldLevelEncryptionConfigCommand } from "@aws-sdk/client-cloudfront"; // ES Modules import + * // const { CloudFrontClient, UpdateFieldLevelEncryptionConfigCommand } = require("@aws-sdk/client-cloudfront"); // CommonJS import + * const client = new CloudFrontClient(config); + * const command = new UpdateFieldLevelEncryptionConfigCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link UpdateFieldLevelEncryptionConfigCommandInput} for command's `input` shape. + * @see {@link UpdateFieldLevelEncryptionConfigCommandOutput} for command's `response` shape. + * @see {@link CloudFrontClientResolvedConfig | config} for command's `input` shape. + * */ export class UpdateFieldLevelEncryptionConfigCommand extends $Command< UpdateFieldLevelEncryptionConfigCommandInput, diff --git a/clients/client-cloudfront/commands/UpdateFieldLevelEncryptionProfileCommand.ts b/clients/client-cloudfront/commands/UpdateFieldLevelEncryptionProfileCommand.ts index f51d46b1bd4c..f02f8988895d 100644 --- a/clients/client-cloudfront/commands/UpdateFieldLevelEncryptionProfileCommand.ts +++ b/clients/client-cloudfront/commands/UpdateFieldLevelEncryptionProfileCommand.ts @@ -24,6 +24,20 @@ export interface UpdateFieldLevelEncryptionProfileCommandOutput /** *

Update a field-level encryption profile.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { CloudFrontClient, UpdateFieldLevelEncryptionProfileCommand } from "@aws-sdk/client-cloudfront"; // ES Modules import + * // const { CloudFrontClient, UpdateFieldLevelEncryptionProfileCommand } = require("@aws-sdk/client-cloudfront"); // CommonJS import + * const client = new CloudFrontClient(config); + * const command = new UpdateFieldLevelEncryptionProfileCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link UpdateFieldLevelEncryptionProfileCommandInput} for command's `input` shape. + * @see {@link UpdateFieldLevelEncryptionProfileCommandOutput} for command's `response` shape. + * @see {@link CloudFrontClientResolvedConfig | config} for command's `input` shape. + * */ export class UpdateFieldLevelEncryptionProfileCommand extends $Command< UpdateFieldLevelEncryptionProfileCommandInput, diff --git a/clients/client-cloudfront/commands/UpdateKeyGroupCommand.ts b/clients/client-cloudfront/commands/UpdateKeyGroupCommand.ts index 05cbde11a0f4..a6b53d7ac0fd 100644 --- a/clients/client-cloudfront/commands/UpdateKeyGroupCommand.ts +++ b/clients/client-cloudfront/commands/UpdateKeyGroupCommand.ts @@ -39,6 +39,20 @@ export interface UpdateKeyGroupCommandOutput extends UpdateKeyGroupResult, __Met * the fields that you modified and those that you didn’t.

* * + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { CloudFrontClient, UpdateKeyGroupCommand } from "@aws-sdk/client-cloudfront"; // ES Modules import + * // const { CloudFrontClient, UpdateKeyGroupCommand } = require("@aws-sdk/client-cloudfront"); // CommonJS import + * const client = new CloudFrontClient(config); + * const command = new UpdateKeyGroupCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link UpdateKeyGroupCommandInput} for command's `input` shape. + * @see {@link UpdateKeyGroupCommandOutput} for command's `response` shape. + * @see {@link CloudFrontClientResolvedConfig | config} for command's `input` shape. + * */ export class UpdateKeyGroupCommand extends $Command< UpdateKeyGroupCommandInput, diff --git a/clients/client-cloudfront/commands/UpdateOriginRequestPolicyCommand.ts b/clients/client-cloudfront/commands/UpdateOriginRequestPolicyCommand.ts index 62d1b3ca79e5..adf4d8f675eb 100644 --- a/clients/client-cloudfront/commands/UpdateOriginRequestPolicyCommand.ts +++ b/clients/client-cloudfront/commands/UpdateOriginRequestPolicyCommand.ts @@ -39,6 +39,20 @@ export interface UpdateOriginRequestPolicyCommandOutput extends UpdateOriginRequ * that you didn’t.

* * + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { CloudFrontClient, UpdateOriginRequestPolicyCommand } from "@aws-sdk/client-cloudfront"; // ES Modules import + * // const { CloudFrontClient, UpdateOriginRequestPolicyCommand } = require("@aws-sdk/client-cloudfront"); // CommonJS import + * const client = new CloudFrontClient(config); + * const command = new UpdateOriginRequestPolicyCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link UpdateOriginRequestPolicyCommandInput} for command's `input` shape. + * @see {@link UpdateOriginRequestPolicyCommandOutput} for command's `response` shape. + * @see {@link CloudFrontClientResolvedConfig | config} for command's `input` shape. + * */ export class UpdateOriginRequestPolicyCommand extends $Command< UpdateOriginRequestPolicyCommandInput, diff --git a/clients/client-cloudfront/commands/UpdatePublicKeyCommand.ts b/clients/client-cloudfront/commands/UpdatePublicKeyCommand.ts index d36057863ba8..87a53f33c348 100644 --- a/clients/client-cloudfront/commands/UpdatePublicKeyCommand.ts +++ b/clients/client-cloudfront/commands/UpdatePublicKeyCommand.ts @@ -22,6 +22,20 @@ export interface UpdatePublicKeyCommandOutput extends UpdatePublicKeyResult, __M /** *

Update public key information. Note that the only value you can change is the comment.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { CloudFrontClient, UpdatePublicKeyCommand } from "@aws-sdk/client-cloudfront"; // ES Modules import + * // const { CloudFrontClient, UpdatePublicKeyCommand } = require("@aws-sdk/client-cloudfront"); // CommonJS import + * const client = new CloudFrontClient(config); + * const command = new UpdatePublicKeyCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link UpdatePublicKeyCommandInput} for command's `input` shape. + * @see {@link UpdatePublicKeyCommandOutput} for command's `response` shape. + * @see {@link CloudFrontClientResolvedConfig | config} for command's `input` shape. + * */ export class UpdatePublicKeyCommand extends $Command< UpdatePublicKeyCommandInput, diff --git a/clients/client-cloudfront/commands/UpdateRealtimeLogConfigCommand.ts b/clients/client-cloudfront/commands/UpdateRealtimeLogConfigCommand.ts index 616576161238..3867656791af 100644 --- a/clients/client-cloudfront/commands/UpdateRealtimeLogConfigCommand.ts +++ b/clients/client-cloudfront/commands/UpdateRealtimeLogConfigCommand.ts @@ -42,6 +42,20 @@ export interface UpdateRealtimeLogConfigCommandOutput extends UpdateRealtimeLogC * *

You cannot update a real-time log configuration’s Name or * ARN.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { CloudFrontClient, UpdateRealtimeLogConfigCommand } from "@aws-sdk/client-cloudfront"; // ES Modules import + * // const { CloudFrontClient, UpdateRealtimeLogConfigCommand } = require("@aws-sdk/client-cloudfront"); // CommonJS import + * const client = new CloudFrontClient(config); + * const command = new UpdateRealtimeLogConfigCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link UpdateRealtimeLogConfigCommandInput} for command's `input` shape. + * @see {@link UpdateRealtimeLogConfigCommandOutput} for command's `response` shape. + * @see {@link CloudFrontClientResolvedConfig | config} for command's `input` shape. + * */ export class UpdateRealtimeLogConfigCommand extends $Command< UpdateRealtimeLogConfigCommandInput, diff --git a/clients/client-cloudfront/commands/UpdateStreamingDistributionCommand.ts b/clients/client-cloudfront/commands/UpdateStreamingDistributionCommand.ts index 36a347835364..d3e9f49ef6d6 100644 --- a/clients/client-cloudfront/commands/UpdateStreamingDistributionCommand.ts +++ b/clients/client-cloudfront/commands/UpdateStreamingDistributionCommand.ts @@ -22,6 +22,20 @@ export interface UpdateStreamingDistributionCommandOutput extends UpdateStreamin /** *

Update a streaming distribution.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { CloudFrontClient, UpdateStreamingDistributionCommand } from "@aws-sdk/client-cloudfront"; // ES Modules import + * // const { CloudFrontClient, UpdateStreamingDistributionCommand } = require("@aws-sdk/client-cloudfront"); // CommonJS import + * const client = new CloudFrontClient(config); + * const command = new UpdateStreamingDistributionCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link UpdateStreamingDistributionCommandInput} for command's `input` shape. + * @see {@link UpdateStreamingDistributionCommandOutput} for command's `response` shape. + * @see {@link CloudFrontClientResolvedConfig | config} for command's `input` shape. + * */ export class UpdateStreamingDistributionCommand extends $Command< UpdateStreamingDistributionCommandInput, diff --git a/clients/client-cloudfront/models/models_0.ts b/clients/client-cloudfront/models/models_0.ts index 5a4a074bfa02..884224396aaf 100644 --- a/clients/client-cloudfront/models/models_0.ts +++ b/clients/client-cloudfront/models/models_0.ts @@ -11,6 +11,9 @@ export interface AccessDenied extends __SmithyException, $MetadataBearer { } export namespace AccessDenied { + /** + * @internal + */ export const filterSensitiveLog = (obj: AccessDenied): any => ({ ...obj, }); @@ -32,6 +35,9 @@ export interface KeyPairIds { } export namespace KeyPairIds { + /** + * @internal + */ export const filterSensitiveLog = (obj: KeyPairIds): any => ({ ...obj, }); @@ -54,6 +60,9 @@ export interface KGKeyPairIds { } export namespace KGKeyPairIds { + /** + * @internal + */ export const filterSensitiveLog = (obj: KGKeyPairIds): any => ({ ...obj, }); @@ -84,6 +93,9 @@ export interface ActiveTrustedKeyGroups { } export namespace ActiveTrustedKeyGroups { + /** + * @internal + */ export const filterSensitiveLog = (obj: ActiveTrustedKeyGroups): any => ({ ...obj, }); @@ -109,6 +121,9 @@ export interface Signer { } export namespace Signer { + /** + * @internal + */ export const filterSensitiveLog = (obj: Signer): any => ({ ...obj, }); @@ -139,6 +154,9 @@ export interface ActiveTrustedSigners { } export namespace ActiveTrustedSigners { + /** + * @internal + */ export const filterSensitiveLog = (obj: ActiveTrustedSigners): any => ({ ...obj, }); @@ -163,6 +181,9 @@ export interface Aliases { } export namespace Aliases { + /** + * @internal + */ export const filterSensitiveLog = (obj: Aliases): any => ({ ...obj, }); @@ -212,6 +233,9 @@ export interface AliasICPRecordal { } export namespace AliasICPRecordal { + /** + * @internal + */ export const filterSensitiveLog = (obj: AliasICPRecordal): any => ({ ...obj, }); @@ -252,6 +276,9 @@ export interface CachedMethods { } export namespace CachedMethods { + /** + * @internal + */ export const filterSensitiveLog = (obj: CachedMethods): any => ({ ...obj, }); @@ -313,6 +340,9 @@ export interface AllowedMethods { } export namespace AllowedMethods { + /** + * @internal + */ export const filterSensitiveLog = (obj: AllowedMethods): any => ({ ...obj, }); @@ -328,6 +358,9 @@ export interface BatchTooLarge extends __SmithyException, $MetadataBearer { } export namespace BatchTooLarge { + /** + * @internal + */ export const filterSensitiveLog = (obj: BatchTooLarge): any => ({ ...obj, }); @@ -351,6 +384,9 @@ export interface CookieNames { } export namespace CookieNames { + /** + * @internal + */ export const filterSensitiveLog = (obj: CookieNames): any => ({ ...obj, }); @@ -409,6 +445,9 @@ export interface CookiePreference { } export namespace CookiePreference { + /** + * @internal + */ export const filterSensitiveLog = (obj: CookiePreference): any => ({ ...obj, }); @@ -430,6 +469,9 @@ export interface Headers { } export namespace Headers { + /** + * @internal + */ export const filterSensitiveLog = (obj: Headers): any => ({ ...obj, }); @@ -464,6 +506,9 @@ export interface QueryStringCacheKeys { } export namespace QueryStringCacheKeys { + /** + * @internal + */ export const filterSensitiveLog = (obj: QueryStringCacheKeys): any => ({ ...obj, }); @@ -553,6 +598,9 @@ export interface ForwardedValues { } export namespace ForwardedValues { + /** + * @internal + */ export const filterSensitiveLog = (obj: ForwardedValues): any => ({ ...obj, }); @@ -608,6 +656,9 @@ export interface LambdaFunctionAssociation { } export namespace LambdaFunctionAssociation { + /** + * @internal + */ export const filterSensitiveLog = (obj: LambdaFunctionAssociation): any => ({ ...obj, }); @@ -643,6 +694,9 @@ export interface LambdaFunctionAssociations { } export namespace LambdaFunctionAssociations { + /** + * @internal + */ export const filterSensitiveLog = (obj: LambdaFunctionAssociations): any => ({ ...obj, }); @@ -672,6 +726,9 @@ export interface TrustedKeyGroups { } export namespace TrustedKeyGroups { + /** + * @internal + */ export const filterSensitiveLog = (obj: TrustedKeyGroups): any => ({ ...obj, }); @@ -701,6 +758,9 @@ export interface TrustedSigners { } export namespace TrustedSigners { + /** + * @internal + */ export const filterSensitiveLog = (obj: TrustedSigners): any => ({ ...obj, }); @@ -948,6 +1008,9 @@ export interface CacheBehavior { } export namespace CacheBehavior { + /** + * @internal + */ export const filterSensitiveLog = (obj: CacheBehavior): any => ({ ...obj, }); @@ -971,6 +1034,9 @@ export interface CacheBehaviors { } export namespace CacheBehaviors { + /** + * @internal + */ export const filterSensitiveLog = (obj: CacheBehaviors): any => ({ ...obj, }); @@ -1028,6 +1094,9 @@ export interface CachePolicyCookiesConfig { } export namespace CachePolicyCookiesConfig { + /** + * @internal + */ export const filterSensitiveLog = (obj: CachePolicyCookiesConfig): any => ({ ...obj, }); @@ -1071,6 +1140,9 @@ export interface CachePolicyHeadersConfig { } export namespace CachePolicyHeadersConfig { + /** + * @internal + */ export const filterSensitiveLog = (obj: CachePolicyHeadersConfig): any => ({ ...obj, }); @@ -1094,6 +1166,9 @@ export interface QueryStringNames { } export namespace QueryStringNames { + /** + * @internal + */ export const filterSensitiveLog = (obj: QueryStringNames): any => ({ ...obj, }); @@ -1163,6 +1238,9 @@ export interface CachePolicyQueryStringsConfig { } export namespace CachePolicyQueryStringsConfig { + /** + * @internal + */ export const filterSensitiveLog = (obj: CachePolicyQueryStringsConfig): any => ({ ...obj, }); @@ -1270,6 +1348,9 @@ export interface ParametersInCacheKeyAndForwardedToOrigin { } export namespace ParametersInCacheKeyAndForwardedToOrigin { + /** + * @internal + */ export const filterSensitiveLog = (obj: ParametersInCacheKeyAndForwardedToOrigin): any => ({ ...obj, }); @@ -1348,6 +1429,9 @@ export interface CachePolicyConfig { } export namespace CachePolicyConfig { + /** + * @internal + */ export const filterSensitiveLog = (obj: CachePolicyConfig): any => ({ ...obj, }); @@ -1392,6 +1476,9 @@ export interface CachePolicy { } export namespace CachePolicy { + /** + * @internal + */ export const filterSensitiveLog = (obj: CachePolicy): any => ({ ...obj, }); @@ -1408,6 +1495,9 @@ export interface CachePolicyAlreadyExists extends __SmithyException, $MetadataBe } export namespace CachePolicyAlreadyExists { + /** + * @internal + */ export const filterSensitiveLog = (obj: CachePolicyAlreadyExists): any => ({ ...obj, }); @@ -1424,6 +1514,9 @@ export interface CachePolicyInUse extends __SmithyException, $MetadataBearer { } export namespace CachePolicyInUse { + /** + * @internal + */ export const filterSensitiveLog = (obj: CachePolicyInUse): any => ({ ...obj, }); @@ -1448,6 +1541,9 @@ export interface CachePolicySummary { } export namespace CachePolicySummary { + /** + * @internal + */ export const filterSensitiveLog = (obj: CachePolicySummary): any => ({ ...obj, }); @@ -1481,6 +1577,9 @@ export interface CachePolicyList { } export namespace CachePolicyList { + /** + * @internal + */ export const filterSensitiveLog = (obj: CachePolicyList): any => ({ ...obj, }); @@ -1496,6 +1595,9 @@ export interface CannotChangeImmutablePublicKeyFields extends __SmithyException, } export namespace CannotChangeImmutablePublicKeyFields { + /** + * @internal + */ export const filterSensitiveLog = (obj: CannotChangeImmutablePublicKeyFields): any => ({ ...obj, }); @@ -1511,6 +1613,9 @@ export interface CreateCachePolicyRequest { } export namespace CreateCachePolicyRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateCachePolicyRequest): any => ({ ...obj, }); @@ -1534,6 +1639,9 @@ export interface CreateCachePolicyResult { } export namespace CreateCachePolicyResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateCachePolicyResult): any => ({ ...obj, }); @@ -1549,6 +1657,9 @@ export interface InconsistentQuantities extends __SmithyException, $MetadataBear } export namespace InconsistentQuantities { + /** + * @internal + */ export const filterSensitiveLog = (obj: InconsistentQuantities): any => ({ ...obj, }); @@ -1564,6 +1675,9 @@ export interface InvalidArgument extends __SmithyException, $MetadataBearer { } export namespace InvalidArgument { + /** + * @internal + */ export const filterSensitiveLog = (obj: InvalidArgument): any => ({ ...obj, }); @@ -1581,6 +1695,9 @@ export interface TooManyCachePolicies extends __SmithyException, $MetadataBearer } export namespace TooManyCachePolicies { + /** + * @internal + */ export const filterSensitiveLog = (obj: TooManyCachePolicies): any => ({ ...obj, }); @@ -1598,6 +1715,9 @@ export interface TooManyCookiesInCachePolicy extends __SmithyException, $Metadat } export namespace TooManyCookiesInCachePolicy { + /** + * @internal + */ export const filterSensitiveLog = (obj: TooManyCookiesInCachePolicy): any => ({ ...obj, }); @@ -1615,6 +1735,9 @@ export interface TooManyHeadersInCachePolicy extends __SmithyException, $Metadat } export namespace TooManyHeadersInCachePolicy { + /** + * @internal + */ export const filterSensitiveLog = (obj: TooManyHeadersInCachePolicy): any => ({ ...obj, }); @@ -1632,6 +1755,9 @@ export interface TooManyQueryStringsInCachePolicy extends __SmithyException, $Me } export namespace TooManyQueryStringsInCachePolicy { + /** + * @internal + */ export const filterSensitiveLog = (obj: TooManyQueryStringsInCachePolicy): any => ({ ...obj, }); @@ -1649,6 +1775,9 @@ export interface CloudFrontOriginAccessIdentityAlreadyExists extends __SmithyExc } export namespace CloudFrontOriginAccessIdentityAlreadyExists { + /** + * @internal + */ export const filterSensitiveLog = (obj: CloudFrontOriginAccessIdentityAlreadyExists): any => ({ ...obj, }); @@ -1683,6 +1812,9 @@ export interface CloudFrontOriginAccessIdentityConfig { } export namespace CloudFrontOriginAccessIdentityConfig { + /** + * @internal + */ export const filterSensitiveLog = (obj: CloudFrontOriginAccessIdentityConfig): any => ({ ...obj, }); @@ -1703,6 +1835,9 @@ export interface CreateCloudFrontOriginAccessIdentityRequest { } export namespace CreateCloudFrontOriginAccessIdentityRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateCloudFrontOriginAccessIdentityRequest): any => ({ ...obj, }); @@ -1731,6 +1866,9 @@ export interface CloudFrontOriginAccessIdentity { } export namespace CloudFrontOriginAccessIdentity { + /** + * @internal + */ export const filterSensitiveLog = (obj: CloudFrontOriginAccessIdentity): any => ({ ...obj, }); @@ -1757,6 +1895,9 @@ export interface CreateCloudFrontOriginAccessIdentityResult { } export namespace CreateCloudFrontOriginAccessIdentityResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateCloudFrontOriginAccessIdentityResult): any => ({ ...obj, }); @@ -1772,6 +1913,9 @@ export interface MissingBody extends __SmithyException, $MetadataBearer { } export namespace MissingBody { + /** + * @internal + */ export const filterSensitiveLog = (obj: MissingBody): any => ({ ...obj, }); @@ -1787,6 +1931,9 @@ export interface TooManyCloudFrontOriginAccessIdentities extends __SmithyExcepti } export namespace TooManyCloudFrontOriginAccessIdentities { + /** + * @internal + */ export const filterSensitiveLog = (obj: TooManyCloudFrontOriginAccessIdentities): any => ({ ...obj, }); @@ -1802,6 +1949,9 @@ export interface CNAMEAlreadyExists extends __SmithyException, $MetadataBearer { } export namespace CNAMEAlreadyExists { + /** + * @internal + */ export const filterSensitiveLog = (obj: CNAMEAlreadyExists): any => ({ ...obj, }); @@ -1892,6 +2042,9 @@ export interface CustomErrorResponse { } export namespace CustomErrorResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: CustomErrorResponse): any => ({ ...obj, }); @@ -1928,6 +2081,9 @@ export interface CustomErrorResponses { } export namespace CustomErrorResponses { + /** + * @internal + */ export const filterSensitiveLog = (obj: CustomErrorResponses): any => ({ ...obj, }); @@ -2143,6 +2299,9 @@ export interface DefaultCacheBehavior { } export namespace DefaultCacheBehavior { + /** + * @internal + */ export const filterSensitiveLog = (obj: DefaultCacheBehavior): any => ({ ...obj, }); @@ -2191,6 +2350,9 @@ export interface LoggingConfig { } export namespace LoggingConfig { + /** + * @internal + */ export const filterSensitiveLog = (obj: LoggingConfig): any => ({ ...obj, }); @@ -2213,6 +2375,9 @@ export interface StatusCodes { } export namespace StatusCodes { + /** + * @internal + */ export const filterSensitiveLog = (obj: StatusCodes): any => ({ ...obj, }); @@ -2231,6 +2396,9 @@ export interface OriginGroupFailoverCriteria { } export namespace OriginGroupFailoverCriteria { + /** + * @internal + */ export const filterSensitiveLog = (obj: OriginGroupFailoverCriteria): any => ({ ...obj, }); @@ -2247,6 +2415,9 @@ export interface OriginGroupMember { } export namespace OriginGroupMember { + /** + * @internal + */ export const filterSensitiveLog = (obj: OriginGroupMember): any => ({ ...obj, }); @@ -2268,6 +2439,9 @@ export interface OriginGroupMembers { } export namespace OriginGroupMembers { + /** + * @internal + */ export const filterSensitiveLog = (obj: OriginGroupMembers): any => ({ ...obj, }); @@ -2297,6 +2471,9 @@ export interface OriginGroup { } export namespace OriginGroup { + /** + * @internal + */ export const filterSensitiveLog = (obj: OriginGroup): any => ({ ...obj, }); @@ -2318,6 +2495,9 @@ export interface OriginGroups { } export namespace OriginGroups { + /** + * @internal + */ export const filterSensitiveLog = (obj: OriginGroups): any => ({ ...obj, }); @@ -2343,6 +2523,9 @@ export interface OriginCustomHeader { } export namespace OriginCustomHeader { + /** + * @internal + */ export const filterSensitiveLog = (obj: OriginCustomHeader): any => ({ ...obj, }); @@ -2367,6 +2550,9 @@ export interface CustomHeaders { } export namespace CustomHeaders { + /** + * @internal + */ export const filterSensitiveLog = (obj: CustomHeaders): any => ({ ...obj, }); @@ -2394,6 +2580,9 @@ export interface OriginSslProtocols { } export namespace OriginSslProtocols { + /** + * @internal + */ export const filterSensitiveLog = (obj: OriginSslProtocols): any => ({ ...obj, }); @@ -2471,6 +2660,9 @@ export interface CustomOriginConfig { } export namespace CustomOriginConfig { + /** + * @internal + */ export const filterSensitiveLog = (obj: CustomOriginConfig): any => ({ ...obj, }); @@ -2504,6 +2696,9 @@ export interface OriginShield { } export namespace OriginShield { + /** + * @internal + */ export const filterSensitiveLog = (obj: OriginShield): any => ({ ...obj, }); @@ -2540,6 +2735,9 @@ export interface S3OriginConfig { } export namespace S3OriginConfig { + /** + * @internal + */ export const filterSensitiveLog = (obj: S3OriginConfig): any => ({ ...obj, }); @@ -2656,6 +2854,9 @@ export interface Origin { } export namespace Origin { + /** + * @internal + */ export const filterSensitiveLog = (obj: Origin): any => ({ ...obj, }); @@ -2677,6 +2878,9 @@ export interface Origins { } export namespace Origins { + /** + * @internal + */ export const filterSensitiveLog = (obj: Origins): any => ({ ...obj, }); @@ -2738,6 +2942,9 @@ export interface GeoRestriction { } export namespace GeoRestriction { + /** + * @internal + */ export const filterSensitiveLog = (obj: GeoRestriction): any => ({ ...obj, }); @@ -2756,6 +2963,9 @@ export interface Restrictions { } export namespace Restrictions { + /** + * @internal + */ export const filterSensitiveLog = (obj: Restrictions): any => ({ ...obj, }); @@ -3004,6 +3214,9 @@ export interface ViewerCertificate { } export namespace ViewerCertificate { + /** + * @internal + */ export const filterSensitiveLog = (obj: ViewerCertificate): any => ({ ...obj, }); @@ -3208,6 +3421,9 @@ export interface DistributionConfig { } export namespace DistributionConfig { + /** + * @internal + */ export const filterSensitiveLog = (obj: DistributionConfig): any => ({ ...obj, ...(obj.Comment && { Comment: SENSITIVE_STRING }), @@ -3225,6 +3441,9 @@ export interface CreateDistributionRequest { } export namespace CreateDistributionRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateDistributionRequest): any => ({ ...obj, ...(obj.DistributionConfig && { @@ -3311,6 +3530,9 @@ export interface Distribution { } export namespace Distribution { + /** + * @internal + */ export const filterSensitiveLog = (obj: Distribution): any => ({ ...obj, ...(obj.DistributionConfig && { @@ -3340,6 +3562,9 @@ export interface CreateDistributionResult { } export namespace CreateDistributionResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateDistributionResult): any => ({ ...obj, ...(obj.Distribution && { Distribution: Distribution.filterSensitiveLog(obj.Distribution) }), @@ -3356,6 +3581,9 @@ export interface DistributionAlreadyExists extends __SmithyException, $MetadataB } export namespace DistributionAlreadyExists { + /** + * @internal + */ export const filterSensitiveLog = (obj: DistributionAlreadyExists): any => ({ ...obj, }); @@ -3373,6 +3601,9 @@ export interface IllegalFieldLevelEncryptionConfigAssociationWithCacheBehavior } export namespace IllegalFieldLevelEncryptionConfigAssociationWithCacheBehavior { + /** + * @internal + */ export const filterSensitiveLog = (obj: IllegalFieldLevelEncryptionConfigAssociationWithCacheBehavior): any => ({ ...obj, }); @@ -3388,6 +3619,9 @@ export interface InvalidDefaultRootObject extends __SmithyException, $MetadataBe } export namespace InvalidDefaultRootObject { + /** + * @internal + */ export const filterSensitiveLog = (obj: InvalidDefaultRootObject): any => ({ ...obj, }); @@ -3403,6 +3637,9 @@ export interface InvalidErrorCode extends __SmithyException, $MetadataBearer { } export namespace InvalidErrorCode { + /** + * @internal + */ export const filterSensitiveLog = (obj: InvalidErrorCode): any => ({ ...obj, }); @@ -3419,6 +3656,9 @@ export interface InvalidForwardCookies extends __SmithyException, $MetadataBeare } export namespace InvalidForwardCookies { + /** + * @internal + */ export const filterSensitiveLog = (obj: InvalidForwardCookies): any => ({ ...obj, }); @@ -3434,6 +3674,9 @@ export interface InvalidGeoRestrictionParameter extends __SmithyException, $Meta } export namespace InvalidGeoRestrictionParameter { + /** + * @internal + */ export const filterSensitiveLog = (obj: InvalidGeoRestrictionParameter): any => ({ ...obj, }); @@ -3449,6 +3692,9 @@ export interface InvalidHeadersForS3Origin extends __SmithyException, $MetadataB } export namespace InvalidHeadersForS3Origin { + /** + * @internal + */ export const filterSensitiveLog = (obj: InvalidHeadersForS3Origin): any => ({ ...obj, }); @@ -3464,6 +3710,9 @@ export interface InvalidLambdaFunctionAssociation extends __SmithyException, $Me } export namespace InvalidLambdaFunctionAssociation { + /** + * @internal + */ export const filterSensitiveLog = (obj: InvalidLambdaFunctionAssociation): any => ({ ...obj, }); @@ -3479,6 +3728,9 @@ export interface InvalidLocationCode extends __SmithyException, $MetadataBearer } export namespace InvalidLocationCode { + /** + * @internal + */ export const filterSensitiveLog = (obj: InvalidLocationCode): any => ({ ...obj, }); @@ -3494,6 +3746,9 @@ export interface InvalidMinimumProtocolVersion extends __SmithyException, $Metad } export namespace InvalidMinimumProtocolVersion { + /** + * @internal + */ export const filterSensitiveLog = (obj: InvalidMinimumProtocolVersion): any => ({ ...obj, }); @@ -3509,6 +3764,9 @@ export interface InvalidOrigin extends __SmithyException, $MetadataBearer { } export namespace InvalidOrigin { + /** + * @internal + */ export const filterSensitiveLog = (obj: InvalidOrigin): any => ({ ...obj, }); @@ -3524,6 +3782,9 @@ export interface InvalidOriginAccessIdentity extends __SmithyException, $Metadat } export namespace InvalidOriginAccessIdentity { + /** + * @internal + */ export const filterSensitiveLog = (obj: InvalidOriginAccessIdentity): any => ({ ...obj, }); @@ -3539,6 +3800,9 @@ export interface InvalidOriginKeepaliveTimeout extends __SmithyException, $Metad } export namespace InvalidOriginKeepaliveTimeout { + /** + * @internal + */ export const filterSensitiveLog = (obj: InvalidOriginKeepaliveTimeout): any => ({ ...obj, }); @@ -3554,6 +3818,9 @@ export interface InvalidOriginReadTimeout extends __SmithyException, $MetadataBe } export namespace InvalidOriginReadTimeout { + /** + * @internal + */ export const filterSensitiveLog = (obj: InvalidOriginReadTimeout): any => ({ ...obj, }); @@ -3570,6 +3837,9 @@ export interface InvalidProtocolSettings extends __SmithyException, $MetadataBea } export namespace InvalidProtocolSettings { + /** + * @internal + */ export const filterSensitiveLog = (obj: InvalidProtocolSettings): any => ({ ...obj, }); @@ -3585,6 +3855,9 @@ export interface InvalidQueryStringParameters extends __SmithyException, $Metada } export namespace InvalidQueryStringParameters { + /** + * @internal + */ export const filterSensitiveLog = (obj: InvalidQueryStringParameters): any => ({ ...obj, }); @@ -3600,6 +3873,9 @@ export interface InvalidRelativePath extends __SmithyException, $MetadataBearer } export namespace InvalidRelativePath { + /** + * @internal + */ export const filterSensitiveLog = (obj: InvalidRelativePath): any => ({ ...obj, }); @@ -3616,6 +3892,9 @@ export interface InvalidRequiredProtocol extends __SmithyException, $MetadataBea } export namespace InvalidRequiredProtocol { + /** + * @internal + */ export const filterSensitiveLog = (obj: InvalidRequiredProtocol): any => ({ ...obj, }); @@ -3631,6 +3910,9 @@ export interface InvalidResponseCode extends __SmithyException, $MetadataBearer } export namespace InvalidResponseCode { + /** + * @internal + */ export const filterSensitiveLog = (obj: InvalidResponseCode): any => ({ ...obj, }); @@ -3646,6 +3928,9 @@ export interface InvalidTTLOrder extends __SmithyException, $MetadataBearer { } export namespace InvalidTTLOrder { + /** + * @internal + */ export const filterSensitiveLog = (obj: InvalidTTLOrder): any => ({ ...obj, }); @@ -3661,6 +3946,9 @@ export interface InvalidViewerCertificate extends __SmithyException, $MetadataBe } export namespace InvalidViewerCertificate { + /** + * @internal + */ export const filterSensitiveLog = (obj: InvalidViewerCertificate): any => ({ ...obj, }); @@ -3680,6 +3968,9 @@ export interface InvalidWebACLId extends __SmithyException, $MetadataBearer { } export namespace InvalidWebACLId { + /** + * @internal + */ export const filterSensitiveLog = (obj: InvalidWebACLId): any => ({ ...obj, }); @@ -3695,6 +3986,9 @@ export interface NoSuchCachePolicy extends __SmithyException, $MetadataBearer { } export namespace NoSuchCachePolicy { + /** + * @internal + */ export const filterSensitiveLog = (obj: NoSuchCachePolicy): any => ({ ...obj, }); @@ -3710,6 +4004,9 @@ export interface NoSuchFieldLevelEncryptionConfig extends __SmithyException, $Me } export namespace NoSuchFieldLevelEncryptionConfig { + /** + * @internal + */ export const filterSensitiveLog = (obj: NoSuchFieldLevelEncryptionConfig): any => ({ ...obj, }); @@ -3725,6 +4022,9 @@ export interface NoSuchOrigin extends __SmithyException, $MetadataBearer { } export namespace NoSuchOrigin { + /** + * @internal + */ export const filterSensitiveLog = (obj: NoSuchOrigin): any => ({ ...obj, }); @@ -3740,6 +4040,9 @@ export interface NoSuchOriginRequestPolicy extends __SmithyException, $MetadataB } export namespace NoSuchOriginRequestPolicy { + /** + * @internal + */ export const filterSensitiveLog = (obj: NoSuchOriginRequestPolicy): any => ({ ...obj, }); @@ -3755,6 +4058,9 @@ export interface TooManyCacheBehaviors extends __SmithyException, $MetadataBeare } export namespace TooManyCacheBehaviors { + /** + * @internal + */ export const filterSensitiveLog = (obj: TooManyCacheBehaviors): any => ({ ...obj, }); @@ -3770,6 +4076,9 @@ export interface TooManyCertificates extends __SmithyException, $MetadataBearer } export namespace TooManyCertificates { + /** + * @internal + */ export const filterSensitiveLog = (obj: TooManyCertificates): any => ({ ...obj, }); @@ -3785,6 +4094,9 @@ export interface TooManyCookieNamesInWhiteList extends __SmithyException, $Metad } export namespace TooManyCookieNamesInWhiteList { + /** + * @internal + */ export const filterSensitiveLog = (obj: TooManyCookieNamesInWhiteList): any => ({ ...obj, }); @@ -3800,6 +4112,9 @@ export interface TooManyDistributionCNAMEs extends __SmithyException, $MetadataB } export namespace TooManyDistributionCNAMEs { + /** + * @internal + */ export const filterSensitiveLog = (obj: TooManyDistributionCNAMEs): any => ({ ...obj, }); @@ -3815,6 +4130,9 @@ export interface TooManyDistributions extends __SmithyException, $MetadataBearer } export namespace TooManyDistributions { + /** + * @internal + */ export const filterSensitiveLog = (obj: TooManyDistributions): any => ({ ...obj, }); @@ -3832,6 +4150,9 @@ export interface TooManyDistributionsAssociatedToCachePolicy extends __SmithyExc } export namespace TooManyDistributionsAssociatedToCachePolicy { + /** + * @internal + */ export const filterSensitiveLog = (obj: TooManyDistributionsAssociatedToCachePolicy): any => ({ ...obj, }); @@ -3847,6 +4168,9 @@ export interface TooManyDistributionsAssociatedToFieldLevelEncryptionConfig exte } export namespace TooManyDistributionsAssociatedToFieldLevelEncryptionConfig { + /** + * @internal + */ export const filterSensitiveLog = (obj: TooManyDistributionsAssociatedToFieldLevelEncryptionConfig): any => ({ ...obj, }); @@ -3864,6 +4188,9 @@ export interface TooManyDistributionsAssociatedToKeyGroup extends __SmithyExcept } export namespace TooManyDistributionsAssociatedToKeyGroup { + /** + * @internal + */ export const filterSensitiveLog = (obj: TooManyDistributionsAssociatedToKeyGroup): any => ({ ...obj, }); @@ -3881,6 +4208,9 @@ export interface TooManyDistributionsAssociatedToOriginRequestPolicy extends __S } export namespace TooManyDistributionsAssociatedToOriginRequestPolicy { + /** + * @internal + */ export const filterSensitiveLog = (obj: TooManyDistributionsAssociatedToOriginRequestPolicy): any => ({ ...obj, }); @@ -3897,6 +4227,9 @@ export interface TooManyDistributionsWithLambdaAssociations extends __SmithyExce } export namespace TooManyDistributionsWithLambdaAssociations { + /** + * @internal + */ export const filterSensitiveLog = (obj: TooManyDistributionsWithLambdaAssociations): any => ({ ...obj, }); @@ -3913,6 +4246,9 @@ export interface TooManyDistributionsWithSingleFunctionARN extends __SmithyExcep } export namespace TooManyDistributionsWithSingleFunctionARN { + /** + * @internal + */ export const filterSensitiveLog = (obj: TooManyDistributionsWithSingleFunctionARN): any => ({ ...obj, }); @@ -3928,6 +4264,9 @@ export interface TooManyHeadersInForwardedValues extends __SmithyException, $Met } export namespace TooManyHeadersInForwardedValues { + /** + * @internal + */ export const filterSensitiveLog = (obj: TooManyHeadersInForwardedValues): any => ({ ...obj, }); @@ -3945,6 +4284,9 @@ export interface TooManyKeyGroupsAssociatedToDistribution extends __SmithyExcept } export namespace TooManyKeyGroupsAssociatedToDistribution { + /** + * @internal + */ export const filterSensitiveLog = (obj: TooManyKeyGroupsAssociatedToDistribution): any => ({ ...obj, }); @@ -3960,6 +4302,9 @@ export interface TooManyLambdaFunctionAssociations extends __SmithyException, $M } export namespace TooManyLambdaFunctionAssociations { + /** + * @internal + */ export const filterSensitiveLog = (obj: TooManyLambdaFunctionAssociations): any => ({ ...obj, }); @@ -3975,6 +4320,9 @@ export interface TooManyOriginCustomHeaders extends __SmithyException, $Metadata } export namespace TooManyOriginCustomHeaders { + /** + * @internal + */ export const filterSensitiveLog = (obj: TooManyOriginCustomHeaders): any => ({ ...obj, }); @@ -3990,6 +4338,9 @@ export interface TooManyOriginGroupsPerDistribution extends __SmithyException, $ } export namespace TooManyOriginGroupsPerDistribution { + /** + * @internal + */ export const filterSensitiveLog = (obj: TooManyOriginGroupsPerDistribution): any => ({ ...obj, }); @@ -4005,6 +4356,9 @@ export interface TooManyOrigins extends __SmithyException, $MetadataBearer { } export namespace TooManyOrigins { + /** + * @internal + */ export const filterSensitiveLog = (obj: TooManyOrigins): any => ({ ...obj, }); @@ -4020,6 +4374,9 @@ export interface TooManyQueryStringParameters extends __SmithyException, $Metada } export namespace TooManyQueryStringParameters { + /** + * @internal + */ export const filterSensitiveLog = (obj: TooManyQueryStringParameters): any => ({ ...obj, }); @@ -4035,6 +4392,9 @@ export interface TooManyTrustedSigners extends __SmithyException, $MetadataBeare } export namespace TooManyTrustedSigners { + /** + * @internal + */ export const filterSensitiveLog = (obj: TooManyTrustedSigners): any => ({ ...obj, }); @@ -4050,6 +4410,9 @@ export interface TrustedKeyGroupDoesNotExist extends __SmithyException, $Metadat } export namespace TrustedKeyGroupDoesNotExist { + /** + * @internal + */ export const filterSensitiveLog = (obj: TrustedKeyGroupDoesNotExist): any => ({ ...obj, }); @@ -4065,6 +4428,9 @@ export interface TrustedSignerDoesNotExist extends __SmithyException, $MetadataB } export namespace TrustedSignerDoesNotExist { + /** + * @internal + */ export const filterSensitiveLog = (obj: TrustedSignerDoesNotExist): any => ({ ...obj, }); @@ -4092,6 +4458,9 @@ export interface Tag { } export namespace Tag { + /** + * @internal + */ export const filterSensitiveLog = (obj: Tag): any => ({ ...obj, }); @@ -4108,6 +4477,9 @@ export interface Tags { } export namespace Tags { + /** + * @internal + */ export const filterSensitiveLog = (obj: Tags): any => ({ ...obj, }); @@ -4130,6 +4502,9 @@ export interface DistributionConfigWithTags { } export namespace DistributionConfigWithTags { + /** + * @internal + */ export const filterSensitiveLog = (obj: DistributionConfigWithTags): any => ({ ...obj, ...(obj.DistributionConfig && { @@ -4149,6 +4524,9 @@ export interface CreateDistributionWithTagsRequest { } export namespace CreateDistributionWithTagsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateDistributionWithTagsRequest): any => ({ ...obj, ...(obj.DistributionConfigWithTags && { @@ -4178,6 +4556,9 @@ export interface CreateDistributionWithTagsResult { } export namespace CreateDistributionWithTagsResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateDistributionWithTagsResult): any => ({ ...obj, ...(obj.Distribution && { Distribution: Distribution.filterSensitiveLog(obj.Distribution) }), @@ -4194,6 +4575,9 @@ export interface InvalidTagging extends __SmithyException, $MetadataBearer { } export namespace InvalidTagging { + /** + * @internal + */ export const filterSensitiveLog = (obj: InvalidTagging): any => ({ ...obj, }); @@ -4222,6 +4606,9 @@ export interface ContentTypeProfile { } export namespace ContentTypeProfile { + /** + * @internal + */ export const filterSensitiveLog = (obj: ContentTypeProfile): any => ({ ...obj, }); @@ -4243,6 +4630,9 @@ export interface ContentTypeProfiles { } export namespace ContentTypeProfiles { + /** + * @internal + */ export const filterSensitiveLog = (obj: ContentTypeProfiles): any => ({ ...obj, }); @@ -4267,6 +4657,9 @@ export interface ContentTypeProfileConfig { } export namespace ContentTypeProfileConfig { + /** + * @internal + */ export const filterSensitiveLog = (obj: ContentTypeProfileConfig): any => ({ ...obj, }); @@ -4288,6 +4681,9 @@ export interface QueryArgProfile { } export namespace QueryArgProfile { + /** + * @internal + */ export const filterSensitiveLog = (obj: QueryArgProfile): any => ({ ...obj, }); @@ -4309,6 +4705,9 @@ export interface QueryArgProfiles { } export namespace QueryArgProfiles { + /** + * @internal + */ export const filterSensitiveLog = (obj: QueryArgProfiles): any => ({ ...obj, }); @@ -4331,6 +4730,9 @@ export interface QueryArgProfileConfig { } export namespace QueryArgProfileConfig { + /** + * @internal + */ export const filterSensitiveLog = (obj: QueryArgProfileConfig): any => ({ ...obj, }); @@ -4364,6 +4766,9 @@ export interface FieldLevelEncryptionConfig { } export namespace FieldLevelEncryptionConfig { + /** + * @internal + */ export const filterSensitiveLog = (obj: FieldLevelEncryptionConfig): any => ({ ...obj, }); @@ -4377,6 +4782,9 @@ export interface CreateFieldLevelEncryptionConfigRequest { } export namespace CreateFieldLevelEncryptionConfigRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateFieldLevelEncryptionConfigRequest): any => ({ ...obj, }); @@ -4404,6 +4812,9 @@ export interface FieldLevelEncryption { } export namespace FieldLevelEncryption { + /** + * @internal + */ export const filterSensitiveLog = (obj: FieldLevelEncryption): any => ({ ...obj, }); @@ -4427,6 +4838,9 @@ export interface CreateFieldLevelEncryptionConfigResult { } export namespace CreateFieldLevelEncryptionConfigResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateFieldLevelEncryptionConfigResult): any => ({ ...obj, }); @@ -4442,6 +4856,9 @@ export interface FieldLevelEncryptionConfigAlreadyExists extends __SmithyExcepti } export namespace FieldLevelEncryptionConfigAlreadyExists { + /** + * @internal + */ export const filterSensitiveLog = (obj: FieldLevelEncryptionConfigAlreadyExists): any => ({ ...obj, }); @@ -4457,6 +4874,9 @@ export interface NoSuchFieldLevelEncryptionProfile extends __SmithyException, $M } export namespace NoSuchFieldLevelEncryptionProfile { + /** + * @internal + */ export const filterSensitiveLog = (obj: NoSuchFieldLevelEncryptionProfile): any => ({ ...obj, }); @@ -4472,6 +4892,9 @@ export interface QueryArgProfileEmpty extends __SmithyException, $MetadataBearer } export namespace QueryArgProfileEmpty { + /** + * @internal + */ export const filterSensitiveLog = (obj: QueryArgProfileEmpty): any => ({ ...obj, }); @@ -4487,6 +4910,9 @@ export interface TooManyFieldLevelEncryptionConfigs extends __SmithyException, $ } export namespace TooManyFieldLevelEncryptionConfigs { + /** + * @internal + */ export const filterSensitiveLog = (obj: TooManyFieldLevelEncryptionConfigs): any => ({ ...obj, }); @@ -4502,6 +4928,9 @@ export interface TooManyFieldLevelEncryptionContentTypeProfiles extends __Smithy } export namespace TooManyFieldLevelEncryptionContentTypeProfiles { + /** + * @internal + */ export const filterSensitiveLog = (obj: TooManyFieldLevelEncryptionContentTypeProfiles): any => ({ ...obj, }); @@ -4517,6 +4946,9 @@ export interface TooManyFieldLevelEncryptionQueryArgProfiles extends __SmithyExc } export namespace TooManyFieldLevelEncryptionQueryArgProfiles { + /** + * @internal + */ export const filterSensitiveLog = (obj: TooManyFieldLevelEncryptionQueryArgProfiles): any => ({ ...obj, }); @@ -4538,6 +4970,9 @@ export interface FieldPatterns { } export namespace FieldPatterns { + /** + * @internal + */ export const filterSensitiveLog = (obj: FieldPatterns): any => ({ ...obj, }); @@ -4568,6 +5003,9 @@ export interface EncryptionEntity { } export namespace EncryptionEntity { + /** + * @internal + */ export const filterSensitiveLog = (obj: EncryptionEntity): any => ({ ...obj, }); @@ -4589,6 +5027,9 @@ export interface EncryptionEntities { } export namespace EncryptionEntities { + /** + * @internal + */ export const filterSensitiveLog = (obj: EncryptionEntities): any => ({ ...obj, }); @@ -4621,6 +5062,9 @@ export interface FieldLevelEncryptionProfileConfig { } export namespace FieldLevelEncryptionProfileConfig { + /** + * @internal + */ export const filterSensitiveLog = (obj: FieldLevelEncryptionProfileConfig): any => ({ ...obj, }); @@ -4634,6 +5078,9 @@ export interface CreateFieldLevelEncryptionProfileRequest { } export namespace CreateFieldLevelEncryptionProfileRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateFieldLevelEncryptionProfileRequest): any => ({ ...obj, }); @@ -4661,6 +5108,9 @@ export interface FieldLevelEncryptionProfile { } export namespace FieldLevelEncryptionProfile { + /** + * @internal + */ export const filterSensitiveLog = (obj: FieldLevelEncryptionProfile): any => ({ ...obj, }); @@ -4684,6 +5134,9 @@ export interface CreateFieldLevelEncryptionProfileResult { } export namespace CreateFieldLevelEncryptionProfileResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateFieldLevelEncryptionProfileResult): any => ({ ...obj, }); @@ -4699,6 +5152,9 @@ export interface FieldLevelEncryptionProfileAlreadyExists extends __SmithyExcept } export namespace FieldLevelEncryptionProfileAlreadyExists { + /** + * @internal + */ export const filterSensitiveLog = (obj: FieldLevelEncryptionProfileAlreadyExists): any => ({ ...obj, }); @@ -4714,6 +5170,9 @@ export interface FieldLevelEncryptionProfileSizeExceeded extends __SmithyExcepti } export namespace FieldLevelEncryptionProfileSizeExceeded { + /** + * @internal + */ export const filterSensitiveLog = (obj: FieldLevelEncryptionProfileSizeExceeded): any => ({ ...obj, }); @@ -4729,6 +5188,9 @@ export interface NoSuchPublicKey extends __SmithyException, $MetadataBearer { } export namespace NoSuchPublicKey { + /** + * @internal + */ export const filterSensitiveLog = (obj: NoSuchPublicKey): any => ({ ...obj, }); @@ -4744,6 +5206,9 @@ export interface TooManyFieldLevelEncryptionEncryptionEntities extends __SmithyE } export namespace TooManyFieldLevelEncryptionEncryptionEntities { + /** + * @internal + */ export const filterSensitiveLog = (obj: TooManyFieldLevelEncryptionEncryptionEntities): any => ({ ...obj, }); @@ -4759,6 +5224,9 @@ export interface TooManyFieldLevelEncryptionFieldPatterns extends __SmithyExcept } export namespace TooManyFieldLevelEncryptionFieldPatterns { + /** + * @internal + */ export const filterSensitiveLog = (obj: TooManyFieldLevelEncryptionFieldPatterns): any => ({ ...obj, }); @@ -4774,6 +5242,9 @@ export interface TooManyFieldLevelEncryptionProfiles extends __SmithyException, } export namespace TooManyFieldLevelEncryptionProfiles { + /** + * @internal + */ export const filterSensitiveLog = (obj: TooManyFieldLevelEncryptionProfiles): any => ({ ...obj, }); @@ -4797,6 +5268,9 @@ export interface Paths { } export namespace Paths { + /** + * @internal + */ export const filterSensitiveLog = (obj: Paths): any => ({ ...obj, }); @@ -4832,6 +5306,9 @@ export interface InvalidationBatch { } export namespace InvalidationBatch { + /** + * @internal + */ export const filterSensitiveLog = (obj: InvalidationBatch): any => ({ ...obj, }); @@ -4853,6 +5330,9 @@ export interface CreateInvalidationRequest { } export namespace CreateInvalidationRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateInvalidationRequest): any => ({ ...obj, }); @@ -4886,6 +5366,9 @@ export interface Invalidation { } export namespace Invalidation { + /** + * @internal + */ export const filterSensitiveLog = (obj: Invalidation): any => ({ ...obj, }); @@ -4908,6 +5391,9 @@ export interface CreateInvalidationResult { } export namespace CreateInvalidationResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateInvalidationResult): any => ({ ...obj, }); @@ -4923,6 +5409,9 @@ export interface NoSuchDistribution extends __SmithyException, $MetadataBearer { } export namespace NoSuchDistribution { + /** + * @internal + */ export const filterSensitiveLog = (obj: NoSuchDistribution): any => ({ ...obj, }); @@ -4938,6 +5427,9 @@ export interface TooManyInvalidationsInProgress extends __SmithyException, $Meta } export namespace TooManyInvalidationsInProgress { + /** + * @internal + */ export const filterSensitiveLog = (obj: TooManyInvalidationsInProgress): any => ({ ...obj, }); @@ -4965,6 +5457,9 @@ export interface KeyGroupConfig { } export namespace KeyGroupConfig { + /** + * @internal + */ export const filterSensitiveLog = (obj: KeyGroupConfig): any => ({ ...obj, }); @@ -4978,6 +5473,9 @@ export interface CreateKeyGroupRequest { } export namespace CreateKeyGroupRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateKeyGroupRequest): any => ({ ...obj, }); @@ -5005,6 +5503,9 @@ export interface KeyGroup { } export namespace KeyGroup { + /** + * @internal + */ export const filterSensitiveLog = (obj: KeyGroup): any => ({ ...obj, }); @@ -5028,6 +5529,9 @@ export interface CreateKeyGroupResult { } export namespace CreateKeyGroupResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateKeyGroupResult): any => ({ ...obj, }); @@ -5044,6 +5548,9 @@ export interface KeyGroupAlreadyExists extends __SmithyException, $MetadataBeare } export namespace KeyGroupAlreadyExists { + /** + * @internal + */ export const filterSensitiveLog = (obj: KeyGroupAlreadyExists): any => ({ ...obj, }); @@ -5061,6 +5568,9 @@ export interface TooManyKeyGroups extends __SmithyException, $MetadataBearer { } export namespace TooManyKeyGroups { + /** + * @internal + */ export const filterSensitiveLog = (obj: TooManyKeyGroups): any => ({ ...obj, }); @@ -5078,6 +5588,9 @@ export interface TooManyPublicKeysInKeyGroup extends __SmithyException, $Metadat } export namespace TooManyPublicKeysInKeyGroup { + /** + * @internal + */ export const filterSensitiveLog = (obj: TooManyPublicKeysInKeyGroup): any => ({ ...obj, }); @@ -5100,6 +5613,9 @@ export interface RealtimeMetricsSubscriptionConfig { } export namespace RealtimeMetricsSubscriptionConfig { + /** + * @internal + */ export const filterSensitiveLog = (obj: RealtimeMetricsSubscriptionConfig): any => ({ ...obj, }); @@ -5117,6 +5633,9 @@ export interface MonitoringSubscription { } export namespace MonitoringSubscription { + /** + * @internal + */ export const filterSensitiveLog = (obj: MonitoringSubscription): any => ({ ...obj, }); @@ -5136,6 +5655,9 @@ export interface CreateMonitoringSubscriptionRequest { } export namespace CreateMonitoringSubscriptionRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateMonitoringSubscriptionRequest): any => ({ ...obj, }); @@ -5150,6 +5672,9 @@ export interface CreateMonitoringSubscriptionResult { } export namespace CreateMonitoringSubscriptionResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateMonitoringSubscriptionResult): any => ({ ...obj, }); @@ -5196,6 +5721,9 @@ export interface OriginRequestPolicyCookiesConfig { } export namespace OriginRequestPolicyCookiesConfig { + /** + * @internal + */ export const filterSensitiveLog = (obj: OriginRequestPolicyCookiesConfig): any => ({ ...obj, }); @@ -5248,6 +5776,9 @@ export interface OriginRequestPolicyHeadersConfig { } export namespace OriginRequestPolicyHeadersConfig { + /** + * @internal + */ export const filterSensitiveLog = (obj: OriginRequestPolicyHeadersConfig): any => ({ ...obj, }); @@ -5294,6 +5825,9 @@ export interface OriginRequestPolicyQueryStringsConfig { } export namespace OriginRequestPolicyQueryStringsConfig { + /** + * @internal + */ export const filterSensitiveLog = (obj: OriginRequestPolicyQueryStringsConfig): any => ({ ...obj, }); @@ -5352,6 +5886,9 @@ export interface OriginRequestPolicyConfig { } export namespace OriginRequestPolicyConfig { + /** + * @internal + */ export const filterSensitiveLog = (obj: OriginRequestPolicyConfig): any => ({ ...obj, }); @@ -5365,6 +5902,9 @@ export interface CreateOriginRequestPolicyRequest { } export namespace CreateOriginRequestPolicyRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateOriginRequestPolicyRequest): any => ({ ...obj, }); @@ -5413,6 +5953,9 @@ export interface OriginRequestPolicy { } export namespace OriginRequestPolicy { + /** + * @internal + */ export const filterSensitiveLog = (obj: OriginRequestPolicy): any => ({ ...obj, }); @@ -5436,6 +5979,9 @@ export interface CreateOriginRequestPolicyResult { } export namespace CreateOriginRequestPolicyResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateOriginRequestPolicyResult): any => ({ ...obj, }); @@ -5453,6 +5999,9 @@ export interface OriginRequestPolicyAlreadyExists extends __SmithyException, $Me } export namespace OriginRequestPolicyAlreadyExists { + /** + * @internal + */ export const filterSensitiveLog = (obj: OriginRequestPolicyAlreadyExists): any => ({ ...obj, }); @@ -5470,6 +6019,9 @@ export interface TooManyCookiesInOriginRequestPolicy extends __SmithyException, } export namespace TooManyCookiesInOriginRequestPolicy { + /** + * @internal + */ export const filterSensitiveLog = (obj: TooManyCookiesInOriginRequestPolicy): any => ({ ...obj, }); @@ -5487,6 +6039,9 @@ export interface TooManyHeadersInOriginRequestPolicy extends __SmithyException, } export namespace TooManyHeadersInOriginRequestPolicy { + /** + * @internal + */ export const filterSensitiveLog = (obj: TooManyHeadersInOriginRequestPolicy): any => ({ ...obj, }); @@ -5504,6 +6059,9 @@ export interface TooManyOriginRequestPolicies extends __SmithyException, $Metada } export namespace TooManyOriginRequestPolicies { + /** + * @internal + */ export const filterSensitiveLog = (obj: TooManyOriginRequestPolicies): any => ({ ...obj, }); @@ -5521,6 +6079,9 @@ export interface TooManyQueryStringsInOriginRequestPolicy extends __SmithyExcept } export namespace TooManyQueryStringsInOriginRequestPolicy { + /** + * @internal + */ export const filterSensitiveLog = (obj: TooManyQueryStringsInOriginRequestPolicy): any => ({ ...obj, }); @@ -5553,6 +6114,9 @@ export interface PublicKeyConfig { } export namespace PublicKeyConfig { + /** + * @internal + */ export const filterSensitiveLog = (obj: PublicKeyConfig): any => ({ ...obj, }); @@ -5566,6 +6130,9 @@ export interface CreatePublicKeyRequest { } export namespace CreatePublicKeyRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreatePublicKeyRequest): any => ({ ...obj, }); @@ -5592,6 +6159,9 @@ export interface PublicKey { } export namespace PublicKey { + /** + * @internal + */ export const filterSensitiveLog = (obj: PublicKey): any => ({ ...obj, }); @@ -5615,6 +6185,9 @@ export interface CreatePublicKeyResult { } export namespace CreatePublicKeyResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreatePublicKeyResult): any => ({ ...obj, }); @@ -5630,6 +6203,9 @@ export interface PublicKeyAlreadyExists extends __SmithyException, $MetadataBear } export namespace PublicKeyAlreadyExists { + /** + * @internal + */ export const filterSensitiveLog = (obj: PublicKeyAlreadyExists): any => ({ ...obj, }); @@ -5645,6 +6221,9 @@ export interface TooManyPublicKeys extends __SmithyException, $MetadataBearer { } export namespace TooManyPublicKeys { + /** + * @internal + */ export const filterSensitiveLog = (obj: TooManyPublicKeys): any => ({ ...obj, }); @@ -5671,6 +6250,9 @@ export interface KinesisStreamConfig { } export namespace KinesisStreamConfig { + /** + * @internal + */ export const filterSensitiveLog = (obj: KinesisStreamConfig): any => ({ ...obj, }); @@ -5695,6 +6277,9 @@ export interface EndPoint { } export namespace EndPoint { + /** + * @internal + */ export const filterSensitiveLog = (obj: EndPoint): any => ({ ...obj, }); @@ -5728,6 +6313,9 @@ export interface CreateRealtimeLogConfigRequest { } export namespace CreateRealtimeLogConfigRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateRealtimeLogConfigRequest): any => ({ ...obj, }); @@ -5771,6 +6359,9 @@ export interface RealtimeLogConfig { } export namespace RealtimeLogConfig { + /** + * @internal + */ export const filterSensitiveLog = (obj: RealtimeLogConfig): any => ({ ...obj, }); @@ -5784,6 +6375,9 @@ export interface CreateRealtimeLogConfigResult { } export namespace CreateRealtimeLogConfigResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateRealtimeLogConfigResult): any => ({ ...obj, }); @@ -5801,6 +6395,9 @@ export interface RealtimeLogConfigAlreadyExists extends __SmithyException, $Meta } export namespace RealtimeLogConfigAlreadyExists { + /** + * @internal + */ export const filterSensitiveLog = (obj: RealtimeLogConfigAlreadyExists): any => ({ ...obj, }); @@ -5818,6 +6415,9 @@ export interface TooManyRealtimeLogConfigs extends __SmithyException, $MetadataB } export namespace TooManyRealtimeLogConfigs { + /** + * @internal + */ export const filterSensitiveLog = (obj: TooManyRealtimeLogConfigs): any => ({ ...obj, }); @@ -5852,6 +6452,9 @@ export interface StreamingLoggingConfig { } export namespace StreamingLoggingConfig { + /** + * @internal + */ export const filterSensitiveLog = (obj: StreamingLoggingConfig): any => ({ ...obj, }); @@ -5886,6 +6489,9 @@ export interface S3Origin { } export namespace S3Origin { + /** + * @internal + */ export const filterSensitiveLog = (obj: S3Origin): any => ({ ...obj, }); @@ -5951,6 +6557,9 @@ export interface StreamingDistributionConfig { } export namespace StreamingDistributionConfig { + /** + * @internal + */ export const filterSensitiveLog = (obj: StreamingDistributionConfig): any => ({ ...obj, }); @@ -5967,6 +6576,9 @@ export interface CreateStreamingDistributionRequest { } export namespace CreateStreamingDistributionRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateStreamingDistributionRequest): any => ({ ...obj, }); @@ -6027,6 +6639,9 @@ export interface StreamingDistribution { } export namespace StreamingDistribution { + /** + * @internal + */ export const filterSensitiveLog = (obj: StreamingDistribution): any => ({ ...obj, }); @@ -6053,6 +6668,9 @@ export interface CreateStreamingDistributionResult { } export namespace CreateStreamingDistributionResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateStreamingDistributionResult): any => ({ ...obj, }); @@ -6069,6 +6687,9 @@ export interface StreamingDistributionAlreadyExists extends __SmithyException, $ } export namespace StreamingDistributionAlreadyExists { + /** + * @internal + */ export const filterSensitiveLog = (obj: StreamingDistributionAlreadyExists): any => ({ ...obj, }); @@ -6084,6 +6705,9 @@ export interface TooManyStreamingDistributionCNAMEs extends __SmithyException, $ } export namespace TooManyStreamingDistributionCNAMEs { + /** + * @internal + */ export const filterSensitiveLog = (obj: TooManyStreamingDistributionCNAMEs): any => ({ ...obj, }); @@ -6099,6 +6723,9 @@ export interface TooManyStreamingDistributions extends __SmithyException, $Metad } export namespace TooManyStreamingDistributions { + /** + * @internal + */ export const filterSensitiveLog = (obj: TooManyStreamingDistributions): any => ({ ...obj, }); @@ -6121,6 +6748,9 @@ export interface StreamingDistributionConfigWithTags { } export namespace StreamingDistributionConfigWithTags { + /** + * @internal + */ export const filterSensitiveLog = (obj: StreamingDistributionConfigWithTags): any => ({ ...obj, }); @@ -6137,6 +6767,9 @@ export interface CreateStreamingDistributionWithTagsRequest { } export namespace CreateStreamingDistributionWithTagsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateStreamingDistributionWithTagsRequest): any => ({ ...obj, }); @@ -6163,6 +6796,9 @@ export interface CreateStreamingDistributionWithTagsResult { } export namespace CreateStreamingDistributionWithTagsResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateStreamingDistributionWithTagsResult): any => ({ ...obj, }); @@ -6185,6 +6821,9 @@ export interface DeleteCachePolicyRequest { } export namespace DeleteCachePolicyRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteCachePolicyRequest): any => ({ ...obj, }); @@ -6200,6 +6839,9 @@ export interface IllegalDelete extends __SmithyException, $MetadataBearer { } export namespace IllegalDelete { + /** + * @internal + */ export const filterSensitiveLog = (obj: IllegalDelete): any => ({ ...obj, }); @@ -6215,6 +6857,9 @@ export interface InvalidIfMatchVersion extends __SmithyException, $MetadataBeare } export namespace InvalidIfMatchVersion { + /** + * @internal + */ export const filterSensitiveLog = (obj: InvalidIfMatchVersion): any => ({ ...obj, }); @@ -6231,6 +6876,9 @@ export interface PreconditionFailed extends __SmithyException, $MetadataBearer { } export namespace PreconditionFailed { + /** + * @internal + */ export const filterSensitiveLog = (obj: PreconditionFailed): any => ({ ...obj, }); @@ -6246,6 +6894,9 @@ export interface CloudFrontOriginAccessIdentityInUse extends __SmithyException, } export namespace CloudFrontOriginAccessIdentityInUse { + /** + * @internal + */ export const filterSensitiveLog = (obj: CloudFrontOriginAccessIdentityInUse): any => ({ ...obj, }); @@ -6268,6 +6919,9 @@ export interface DeleteCloudFrontOriginAccessIdentityRequest { } export namespace DeleteCloudFrontOriginAccessIdentityRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteCloudFrontOriginAccessIdentityRequest): any => ({ ...obj, }); @@ -6283,6 +6937,9 @@ export interface NoSuchCloudFrontOriginAccessIdentity extends __SmithyException, } export namespace NoSuchCloudFrontOriginAccessIdentity { + /** + * @internal + */ export const filterSensitiveLog = (obj: NoSuchCloudFrontOriginAccessIdentity): any => ({ ...obj, }); @@ -6351,6 +7008,9 @@ export interface DeleteDistributionRequest { } export namespace DeleteDistributionRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteDistributionRequest): any => ({ ...obj, }); @@ -6367,6 +7027,9 @@ export interface DistributionNotDisabled extends __SmithyException, $MetadataBea } export namespace DistributionNotDisabled { + /** + * @internal + */ export const filterSensitiveLog = (obj: DistributionNotDisabled): any => ({ ...obj, }); @@ -6386,6 +7049,9 @@ export interface DeleteFieldLevelEncryptionConfigRequest { } export namespace DeleteFieldLevelEncryptionConfigRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteFieldLevelEncryptionConfigRequest): any => ({ ...obj, }); @@ -6401,6 +7067,9 @@ export interface FieldLevelEncryptionConfigInUse extends __SmithyException, $Met } export namespace FieldLevelEncryptionConfigInUse { + /** + * @internal + */ export const filterSensitiveLog = (obj: FieldLevelEncryptionConfigInUse): any => ({ ...obj, }); @@ -6420,6 +7089,9 @@ export interface DeleteFieldLevelEncryptionProfileRequest { } export namespace DeleteFieldLevelEncryptionProfileRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteFieldLevelEncryptionProfileRequest): any => ({ ...obj, }); @@ -6435,6 +7107,9 @@ export interface FieldLevelEncryptionProfileInUse extends __SmithyException, $Me } export namespace FieldLevelEncryptionProfileInUse { + /** + * @internal + */ export const filterSensitiveLog = (obj: FieldLevelEncryptionProfileInUse): any => ({ ...obj, }); @@ -6456,6 +7131,9 @@ export interface DeleteKeyGroupRequest { } export namespace DeleteKeyGroupRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteKeyGroupRequest): any => ({ ...obj, }); @@ -6471,6 +7149,9 @@ export interface NoSuchResource extends __SmithyException, $MetadataBearer { } export namespace NoSuchResource { + /** + * @internal + */ export const filterSensitiveLog = (obj: NoSuchResource): any => ({ ...obj, }); @@ -6486,6 +7167,9 @@ export interface ResourceInUse extends __SmithyException, $MetadataBearer { } export namespace ResourceInUse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ResourceInUse): any => ({ ...obj, }); @@ -6499,6 +7183,9 @@ export interface DeleteMonitoringSubscriptionRequest { } export namespace DeleteMonitoringSubscriptionRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteMonitoringSubscriptionRequest): any => ({ ...obj, }); @@ -6507,6 +7194,9 @@ export namespace DeleteMonitoringSubscriptionRequest { export interface DeleteMonitoringSubscriptionResult {} export namespace DeleteMonitoringSubscriptionResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteMonitoringSubscriptionResult): any => ({ ...obj, }); @@ -6529,6 +7219,9 @@ export interface DeleteOriginRequestPolicyRequest { } export namespace DeleteOriginRequestPolicyRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteOriginRequestPolicyRequest): any => ({ ...obj, }); @@ -6545,6 +7238,9 @@ export interface OriginRequestPolicyInUse extends __SmithyException, $MetadataBe } export namespace OriginRequestPolicyInUse { + /** + * @internal + */ export const filterSensitiveLog = (obj: OriginRequestPolicyInUse): any => ({ ...obj, }); @@ -6564,6 +7260,9 @@ export interface DeletePublicKeyRequest { } export namespace DeletePublicKeyRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeletePublicKeyRequest): any => ({ ...obj, }); @@ -6579,6 +7278,9 @@ export interface PublicKeyInUse extends __SmithyException, $MetadataBearer { } export namespace PublicKeyInUse { + /** + * @internal + */ export const filterSensitiveLog = (obj: PublicKeyInUse): any => ({ ...obj, }); @@ -6597,6 +7299,9 @@ export interface DeleteRealtimeLogConfigRequest { } export namespace DeleteRealtimeLogConfigRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteRealtimeLogConfigRequest): any => ({ ...obj, }); @@ -6612,6 +7317,9 @@ export interface NoSuchRealtimeLogConfig extends __SmithyException, $MetadataBea } export namespace NoSuchRealtimeLogConfig { + /** + * @internal + */ export const filterSensitiveLog = (obj: NoSuchRealtimeLogConfig): any => ({ ...obj, }); @@ -6628,6 +7336,9 @@ export interface RealtimeLogConfigInUse extends __SmithyException, $MetadataBear } export namespace RealtimeLogConfigInUse { + /** + * @internal + */ export const filterSensitiveLog = (obj: RealtimeLogConfigInUse): any => ({ ...obj, }); @@ -6650,6 +7361,9 @@ export interface DeleteStreamingDistributionRequest { } export namespace DeleteStreamingDistributionRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteStreamingDistributionRequest): any => ({ ...obj, }); @@ -6665,6 +7379,9 @@ export interface NoSuchStreamingDistribution extends __SmithyException, $Metadat } export namespace NoSuchStreamingDistribution { + /** + * @internal + */ export const filterSensitiveLog = (obj: NoSuchStreamingDistribution): any => ({ ...obj, }); @@ -6681,6 +7398,9 @@ export interface StreamingDistributionNotDisabled extends __SmithyException, $Me } export namespace StreamingDistributionNotDisabled { + /** + * @internal + */ export const filterSensitiveLog = (obj: StreamingDistributionNotDisabled): any => ({ ...obj, }); @@ -6698,6 +7418,9 @@ export interface GetCachePolicyRequest { } export namespace GetCachePolicyRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetCachePolicyRequest): any => ({ ...obj, }); @@ -6716,6 +7439,9 @@ export interface GetCachePolicyResult { } export namespace GetCachePolicyResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetCachePolicyResult): any => ({ ...obj, }); @@ -6733,6 +7459,9 @@ export interface GetCachePolicyConfigRequest { } export namespace GetCachePolicyConfigRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetCachePolicyConfigRequest): any => ({ ...obj, }); @@ -6751,6 +7480,9 @@ export interface GetCachePolicyConfigResult { } export namespace GetCachePolicyConfigResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetCachePolicyConfigResult): any => ({ ...obj, }); @@ -6767,6 +7499,9 @@ export interface GetCloudFrontOriginAccessIdentityRequest { } export namespace GetCloudFrontOriginAccessIdentityRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetCloudFrontOriginAccessIdentityRequest): any => ({ ...obj, }); @@ -6789,6 +7524,9 @@ export interface GetCloudFrontOriginAccessIdentityResult { } export namespace GetCloudFrontOriginAccessIdentityResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetCloudFrontOriginAccessIdentityResult): any => ({ ...obj, }); @@ -6806,6 +7544,9 @@ export interface GetCloudFrontOriginAccessIdentityConfigRequest { } export namespace GetCloudFrontOriginAccessIdentityConfigRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetCloudFrontOriginAccessIdentityConfigRequest): any => ({ ...obj, }); @@ -6828,6 +7569,9 @@ export interface GetCloudFrontOriginAccessIdentityConfigResult { } export namespace GetCloudFrontOriginAccessIdentityConfigResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetCloudFrontOriginAccessIdentityConfigResult): any => ({ ...obj, }); @@ -6844,6 +7588,9 @@ export interface GetDistributionRequest { } export namespace GetDistributionRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetDistributionRequest): any => ({ ...obj, }); @@ -6866,6 +7613,9 @@ export interface GetDistributionResult { } export namespace GetDistributionResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetDistributionResult): any => ({ ...obj, ...(obj.Distribution && { Distribution: Distribution.filterSensitiveLog(obj.Distribution) }), @@ -6883,6 +7633,9 @@ export interface GetDistributionConfigRequest { } export namespace GetDistributionConfigRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetDistributionConfigRequest): any => ({ ...obj, }); @@ -6905,6 +7658,9 @@ export interface GetDistributionConfigResult { } export namespace GetDistributionConfigResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetDistributionConfigResult): any => ({ ...obj, ...(obj.DistributionConfig && { @@ -6921,6 +7677,9 @@ export interface GetFieldLevelEncryptionRequest { } export namespace GetFieldLevelEncryptionRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetFieldLevelEncryptionRequest): any => ({ ...obj, }); @@ -6939,6 +7698,9 @@ export interface GetFieldLevelEncryptionResult { } export namespace GetFieldLevelEncryptionResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetFieldLevelEncryptionResult): any => ({ ...obj, }); @@ -6952,6 +7714,9 @@ export interface GetFieldLevelEncryptionConfigRequest { } export namespace GetFieldLevelEncryptionConfigRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetFieldLevelEncryptionConfigRequest): any => ({ ...obj, }); @@ -6970,6 +7735,9 @@ export interface GetFieldLevelEncryptionConfigResult { } export namespace GetFieldLevelEncryptionConfigResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetFieldLevelEncryptionConfigResult): any => ({ ...obj, }); @@ -6983,6 +7751,9 @@ export interface GetFieldLevelEncryptionProfileRequest { } export namespace GetFieldLevelEncryptionProfileRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetFieldLevelEncryptionProfileRequest): any => ({ ...obj, }); @@ -7001,6 +7772,9 @@ export interface GetFieldLevelEncryptionProfileResult { } export namespace GetFieldLevelEncryptionProfileResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetFieldLevelEncryptionProfileResult): any => ({ ...obj, }); @@ -7014,6 +7788,9 @@ export interface GetFieldLevelEncryptionProfileConfigRequest { } export namespace GetFieldLevelEncryptionProfileConfigRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetFieldLevelEncryptionProfileConfigRequest): any => ({ ...obj, }); @@ -7032,6 +7809,9 @@ export interface GetFieldLevelEncryptionProfileConfigResult { } export namespace GetFieldLevelEncryptionProfileConfigResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetFieldLevelEncryptionProfileConfigResult): any => ({ ...obj, }); @@ -7054,6 +7834,9 @@ export interface GetInvalidationRequest { } export namespace GetInvalidationRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetInvalidationRequest): any => ({ ...obj, }); @@ -7070,6 +7853,9 @@ export interface GetInvalidationResult { } export namespace GetInvalidationResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetInvalidationResult): any => ({ ...obj, }); @@ -7085,6 +7871,9 @@ export interface NoSuchInvalidation extends __SmithyException, $MetadataBearer { } export namespace NoSuchInvalidation { + /** + * @internal + */ export const filterSensitiveLog = (obj: NoSuchInvalidation): any => ({ ...obj, }); @@ -7099,6 +7888,9 @@ export interface GetKeyGroupRequest { } export namespace GetKeyGroupRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetKeyGroupRequest): any => ({ ...obj, }); @@ -7117,6 +7909,9 @@ export interface GetKeyGroupResult { } export namespace GetKeyGroupResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetKeyGroupResult): any => ({ ...obj, }); @@ -7131,6 +7926,9 @@ export interface GetKeyGroupConfigRequest { } export namespace GetKeyGroupConfigRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetKeyGroupConfigRequest): any => ({ ...obj, }); @@ -7149,6 +7947,9 @@ export interface GetKeyGroupConfigResult { } export namespace GetKeyGroupConfigResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetKeyGroupConfigResult): any => ({ ...obj, }); @@ -7162,6 +7963,9 @@ export interface GetMonitoringSubscriptionRequest { } export namespace GetMonitoringSubscriptionRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetMonitoringSubscriptionRequest): any => ({ ...obj, }); @@ -7176,6 +7980,9 @@ export interface GetMonitoringSubscriptionResult { } export namespace GetMonitoringSubscriptionResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetMonitoringSubscriptionResult): any => ({ ...obj, }); @@ -7193,6 +8000,9 @@ export interface GetOriginRequestPolicyRequest { } export namespace GetOriginRequestPolicyRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetOriginRequestPolicyRequest): any => ({ ...obj, }); @@ -7211,6 +8021,9 @@ export interface GetOriginRequestPolicyResult { } export namespace GetOriginRequestPolicyResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetOriginRequestPolicyResult): any => ({ ...obj, }); @@ -7228,6 +8041,9 @@ export interface GetOriginRequestPolicyConfigRequest { } export namespace GetOriginRequestPolicyConfigRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetOriginRequestPolicyConfigRequest): any => ({ ...obj, }); @@ -7246,6 +8062,9 @@ export interface GetOriginRequestPolicyConfigResult { } export namespace GetOriginRequestPolicyConfigResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetOriginRequestPolicyConfigResult): any => ({ ...obj, }); @@ -7259,6 +8078,9 @@ export interface GetPublicKeyRequest { } export namespace GetPublicKeyRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetPublicKeyRequest): any => ({ ...obj, }); @@ -7277,6 +8099,9 @@ export interface GetPublicKeyResult { } export namespace GetPublicKeyResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetPublicKeyResult): any => ({ ...obj, }); @@ -7290,6 +8115,9 @@ export interface GetPublicKeyConfigRequest { } export namespace GetPublicKeyConfigRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetPublicKeyConfigRequest): any => ({ ...obj, }); @@ -7308,6 +8136,9 @@ export interface GetPublicKeyConfigResult { } export namespace GetPublicKeyConfigResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetPublicKeyConfigResult): any => ({ ...obj, }); @@ -7326,6 +8157,9 @@ export interface GetRealtimeLogConfigRequest { } export namespace GetRealtimeLogConfigRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetRealtimeLogConfigRequest): any => ({ ...obj, }); diff --git a/clients/client-cloudfront/models/models_1.ts b/clients/client-cloudfront/models/models_1.ts index cf368e87148b..15ff92612055 100644 --- a/clients/client-cloudfront/models/models_1.ts +++ b/clients/client-cloudfront/models/models_1.ts @@ -50,6 +50,9 @@ export interface GetRealtimeLogConfigResult { } export namespace GetRealtimeLogConfigResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetRealtimeLogConfigResult): any => ({ ...obj, }); @@ -66,6 +69,9 @@ export interface GetStreamingDistributionRequest { } export namespace GetStreamingDistributionRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetStreamingDistributionRequest): any => ({ ...obj, }); @@ -88,6 +94,9 @@ export interface GetStreamingDistributionResult { } export namespace GetStreamingDistributionResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetStreamingDistributionResult): any => ({ ...obj, }); @@ -104,6 +113,9 @@ export interface GetStreamingDistributionConfigRequest { } export namespace GetStreamingDistributionConfigRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetStreamingDistributionConfigRequest): any => ({ ...obj, }); @@ -126,6 +138,9 @@ export interface GetStreamingDistributionConfigResult { } export namespace GetStreamingDistributionConfigResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetStreamingDistributionConfigResult): any => ({ ...obj, }); @@ -164,6 +179,9 @@ export interface ListCachePoliciesRequest { } export namespace ListCachePoliciesRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListCachePoliciesRequest): any => ({ ...obj, }); @@ -177,6 +195,9 @@ export interface ListCachePoliciesResult { } export namespace ListCachePoliciesResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListCachePoliciesResult): any => ({ ...obj, }); @@ -203,6 +224,9 @@ export interface ListCloudFrontOriginAccessIdentitiesRequest { } export namespace ListCloudFrontOriginAccessIdentitiesRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListCloudFrontOriginAccessIdentitiesRequest): any => ({ ...obj, }); @@ -232,6 +256,9 @@ export interface CloudFrontOriginAccessIdentitySummary { } export namespace CloudFrontOriginAccessIdentitySummary { + /** + * @internal + */ export const filterSensitiveLog = (obj: CloudFrontOriginAccessIdentitySummary): any => ({ ...obj, }); @@ -291,6 +318,9 @@ export interface CloudFrontOriginAccessIdentityList { } export namespace CloudFrontOriginAccessIdentityList { + /** + * @internal + */ export const filterSensitiveLog = (obj: CloudFrontOriginAccessIdentityList): any => ({ ...obj, }); @@ -307,6 +337,9 @@ export interface ListCloudFrontOriginAccessIdentitiesResult { } export namespace ListCloudFrontOriginAccessIdentitiesResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListCloudFrontOriginAccessIdentitiesResult): any => ({ ...obj, }); @@ -332,6 +365,9 @@ export interface ListDistributionsRequest { } export namespace ListDistributionsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListDistributionsRequest): any => ({ ...obj, }); @@ -464,6 +500,9 @@ export interface DistributionSummary { } export namespace DistributionSummary { + /** + * @internal + */ export const filterSensitiveLog = (obj: DistributionSummary): any => ({ ...obj, }); @@ -510,6 +549,9 @@ export interface DistributionList { } export namespace DistributionList { + /** + * @internal + */ export const filterSensitiveLog = (obj: DistributionList): any => ({ ...obj, }); @@ -526,6 +568,9 @@ export interface ListDistributionsResult { } export namespace ListDistributionsResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListDistributionsResult): any => ({ ...obj, }); @@ -552,6 +597,9 @@ export interface ListDistributionsByCachePolicyIdRequest { } export namespace ListDistributionsByCachePolicyIdRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListDistributionsByCachePolicyIdRequest): any => ({ ...obj, }); @@ -596,6 +644,9 @@ export interface DistributionIdList { } export namespace DistributionIdList { + /** + * @internal + */ export const filterSensitiveLog = (obj: DistributionIdList): any => ({ ...obj, }); @@ -609,6 +660,9 @@ export interface ListDistributionsByCachePolicyIdResult { } export namespace ListDistributionsByCachePolicyIdResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListDistributionsByCachePolicyIdResult): any => ({ ...obj, }); @@ -635,6 +689,9 @@ export interface ListDistributionsByKeyGroupRequest { } export namespace ListDistributionsByKeyGroupRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListDistributionsByKeyGroupRequest): any => ({ ...obj, }); @@ -648,6 +705,9 @@ export interface ListDistributionsByKeyGroupResult { } export namespace ListDistributionsByKeyGroupResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListDistributionsByKeyGroupResult): any => ({ ...obj, }); @@ -675,6 +735,9 @@ export interface ListDistributionsByOriginRequestPolicyIdRequest { } export namespace ListDistributionsByOriginRequestPolicyIdRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListDistributionsByOriginRequestPolicyIdRequest): any => ({ ...obj, }); @@ -688,6 +751,9 @@ export interface ListDistributionsByOriginRequestPolicyIdResult { } export namespace ListDistributionsByOriginRequestPolicyIdResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListDistributionsByOriginRequestPolicyIdResult): any => ({ ...obj, }); @@ -721,6 +787,9 @@ export interface ListDistributionsByRealtimeLogConfigRequest { } export namespace ListDistributionsByRealtimeLogConfigRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListDistributionsByRealtimeLogConfigRequest): any => ({ ...obj, }); @@ -734,6 +803,9 @@ export interface ListDistributionsByRealtimeLogConfigResult { } export namespace ListDistributionsByRealtimeLogConfigResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListDistributionsByRealtimeLogConfigResult): any => ({ ...obj, }); @@ -768,6 +840,9 @@ export interface ListDistributionsByWebACLIdRequest { } export namespace ListDistributionsByWebACLIdRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListDistributionsByWebACLIdRequest): any => ({ ...obj, }); @@ -785,6 +860,9 @@ export interface ListDistributionsByWebACLIdResult { } export namespace ListDistributionsByWebACLIdResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListDistributionsByWebACLIdResult): any => ({ ...obj, }); @@ -805,6 +883,9 @@ export interface ListFieldLevelEncryptionConfigsRequest { } export namespace ListFieldLevelEncryptionConfigsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListFieldLevelEncryptionConfigsRequest): any => ({ ...obj, }); @@ -845,6 +926,9 @@ export interface FieldLevelEncryptionSummary { } export namespace FieldLevelEncryptionSummary { + /** + * @internal + */ export const filterSensitiveLog = (obj: FieldLevelEncryptionSummary): any => ({ ...obj, }); @@ -878,6 +962,9 @@ export interface FieldLevelEncryptionList { } export namespace FieldLevelEncryptionList { + /** + * @internal + */ export const filterSensitiveLog = (obj: FieldLevelEncryptionList): any => ({ ...obj, }); @@ -891,6 +978,9 @@ export interface ListFieldLevelEncryptionConfigsResult { } export namespace ListFieldLevelEncryptionConfigsResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListFieldLevelEncryptionConfigsResult): any => ({ ...obj, }); @@ -911,6 +1001,9 @@ export interface ListFieldLevelEncryptionProfilesRequest { } export namespace ListFieldLevelEncryptionProfilesRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListFieldLevelEncryptionProfilesRequest): any => ({ ...obj, }); @@ -948,6 +1041,9 @@ export interface FieldLevelEncryptionProfileSummary { } export namespace FieldLevelEncryptionProfileSummary { + /** + * @internal + */ export const filterSensitiveLog = (obj: FieldLevelEncryptionProfileSummary): any => ({ ...obj, }); @@ -981,6 +1077,9 @@ export interface FieldLevelEncryptionProfileList { } export namespace FieldLevelEncryptionProfileList { + /** + * @internal + */ export const filterSensitiveLog = (obj: FieldLevelEncryptionProfileList): any => ({ ...obj, }); @@ -994,6 +1093,9 @@ export interface ListFieldLevelEncryptionProfilesResult { } export namespace ListFieldLevelEncryptionProfilesResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListFieldLevelEncryptionProfilesResult): any => ({ ...obj, }); @@ -1026,6 +1128,9 @@ export interface ListInvalidationsRequest { } export namespace ListInvalidationsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListInvalidationsRequest): any => ({ ...obj, }); @@ -1052,6 +1157,9 @@ export interface InvalidationSummary { } export namespace InvalidationSummary { + /** + * @internal + */ export const filterSensitiveLog = (obj: InvalidationSummary): any => ({ ...obj, }); @@ -1102,6 +1210,9 @@ export interface InvalidationList { } export namespace InvalidationList { + /** + * @internal + */ export const filterSensitiveLog = (obj: InvalidationList): any => ({ ...obj, }); @@ -1118,6 +1229,9 @@ export interface ListInvalidationsResult { } export namespace ListInvalidationsResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListInvalidationsResult): any => ({ ...obj, }); @@ -1139,6 +1253,9 @@ export interface ListKeyGroupsRequest { } export namespace ListKeyGroupsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListKeyGroupsRequest): any => ({ ...obj, }); @@ -1155,6 +1272,9 @@ export interface KeyGroupSummary { } export namespace KeyGroupSummary { + /** + * @internal + */ export const filterSensitiveLog = (obj: KeyGroupSummary): any => ({ ...obj, }); @@ -1188,6 +1308,9 @@ export interface KeyGroupList { } export namespace KeyGroupList { + /** + * @internal + */ export const filterSensitiveLog = (obj: KeyGroupList): any => ({ ...obj, }); @@ -1201,6 +1324,9 @@ export interface ListKeyGroupsResult { } export namespace ListKeyGroupsResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListKeyGroupsResult): any => ({ ...obj, }); @@ -1241,6 +1367,9 @@ export interface ListOriginRequestPoliciesRequest { } export namespace ListOriginRequestPoliciesRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListOriginRequestPoliciesRequest): any => ({ ...obj, }); @@ -1263,6 +1392,9 @@ export interface OriginRequestPolicySummary { } export namespace OriginRequestPolicySummary { + /** + * @internal + */ export const filterSensitiveLog = (obj: OriginRequestPolicySummary): any => ({ ...obj, }); @@ -1297,6 +1429,9 @@ export interface OriginRequestPolicyList { } export namespace OriginRequestPolicyList { + /** + * @internal + */ export const filterSensitiveLog = (obj: OriginRequestPolicyList): any => ({ ...obj, }); @@ -1310,6 +1445,9 @@ export interface ListOriginRequestPoliciesResult { } export namespace ListOriginRequestPoliciesResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListOriginRequestPoliciesResult): any => ({ ...obj, }); @@ -1330,6 +1468,9 @@ export interface ListPublicKeysRequest { } export namespace ListPublicKeysRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListPublicKeysRequest): any => ({ ...obj, }); @@ -1366,6 +1507,9 @@ export interface PublicKeySummary { } export namespace PublicKeySummary { + /** + * @internal + */ export const filterSensitiveLog = (obj: PublicKeySummary): any => ({ ...obj, }); @@ -1399,6 +1543,9 @@ export interface PublicKeyList { } export namespace PublicKeyList { + /** + * @internal + */ export const filterSensitiveLog = (obj: PublicKeyList): any => ({ ...obj, }); @@ -1412,6 +1559,9 @@ export interface ListPublicKeysResult { } export namespace ListPublicKeysResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListPublicKeysResult): any => ({ ...obj, }); @@ -1433,6 +1583,9 @@ export interface ListRealtimeLogConfigsRequest { } export namespace ListRealtimeLogConfigsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListRealtimeLogConfigsRequest): any => ({ ...obj, }); @@ -1473,6 +1626,9 @@ export interface RealtimeLogConfigs { } export namespace RealtimeLogConfigs { + /** + * @internal + */ export const filterSensitiveLog = (obj: RealtimeLogConfigs): any => ({ ...obj, }); @@ -1486,6 +1642,9 @@ export interface ListRealtimeLogConfigsResult { } export namespace ListRealtimeLogConfigsResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListRealtimeLogConfigsResult): any => ({ ...obj, }); @@ -1507,6 +1666,9 @@ export interface ListStreamingDistributionsRequest { } export namespace ListStreamingDistributionsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListStreamingDistributionsRequest): any => ({ ...obj, }); @@ -1592,6 +1754,9 @@ export interface StreamingDistributionSummary { } export namespace StreamingDistributionSummary { + /** + * @internal + */ export const filterSensitiveLog = (obj: StreamingDistributionSummary): any => ({ ...obj, }); @@ -1639,6 +1804,9 @@ export interface StreamingDistributionList { } export namespace StreamingDistributionList { + /** + * @internal + */ export const filterSensitiveLog = (obj: StreamingDistributionList): any => ({ ...obj, }); @@ -1655,6 +1823,9 @@ export interface ListStreamingDistributionsResult { } export namespace ListStreamingDistributionsResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListStreamingDistributionsResult): any => ({ ...obj, }); @@ -1671,6 +1842,9 @@ export interface ListTagsForResourceRequest { } export namespace ListTagsForResourceRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListTagsForResourceRequest): any => ({ ...obj, }); @@ -1687,6 +1861,9 @@ export interface ListTagsForResourceResult { } export namespace ListTagsForResourceResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListTagsForResourceResult): any => ({ ...obj, }); @@ -1708,6 +1885,9 @@ export interface TagResourceRequest { } export namespace TagResourceRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: TagResourceRequest): any => ({ ...obj, }); @@ -1724,6 +1904,9 @@ export interface TagKeys { } export namespace TagKeys { + /** + * @internal + */ export const filterSensitiveLog = (obj: TagKeys): any => ({ ...obj, }); @@ -1745,6 +1928,9 @@ export interface UntagResourceRequest { } export namespace UntagResourceRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: UntagResourceRequest): any => ({ ...obj, }); @@ -1760,6 +1946,9 @@ export interface IllegalUpdate extends __SmithyException, $MetadataBearer { } export namespace IllegalUpdate { + /** + * @internal + */ export const filterSensitiveLog = (obj: IllegalUpdate): any => ({ ...obj, }); @@ -1787,6 +1976,9 @@ export interface UpdateCachePolicyRequest { } export namespace UpdateCachePolicyRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateCachePolicyRequest): any => ({ ...obj, }); @@ -1805,6 +1997,9 @@ export interface UpdateCachePolicyResult { } export namespace UpdateCachePolicyResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateCachePolicyResult): any => ({ ...obj, }); @@ -1832,6 +2027,9 @@ export interface UpdateCloudFrontOriginAccessIdentityRequest { } export namespace UpdateCloudFrontOriginAccessIdentityRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateCloudFrontOriginAccessIdentityRequest): any => ({ ...obj, }); @@ -1854,6 +2052,9 @@ export interface UpdateCloudFrontOriginAccessIdentityResult { } export namespace UpdateCloudFrontOriginAccessIdentityResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateCloudFrontOriginAccessIdentityResult): any => ({ ...obj, }); @@ -1881,6 +2082,9 @@ export interface UpdateDistributionRequest { } export namespace UpdateDistributionRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateDistributionRequest): any => ({ ...obj, ...(obj.DistributionConfig && { @@ -1906,6 +2110,9 @@ export interface UpdateDistributionResult { } export namespace UpdateDistributionResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateDistributionResult): any => ({ ...obj, ...(obj.Distribution && { Distribution: Distribution.filterSensitiveLog(obj.Distribution) }), @@ -1931,6 +2138,9 @@ export interface UpdateFieldLevelEncryptionConfigRequest { } export namespace UpdateFieldLevelEncryptionConfigRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateFieldLevelEncryptionConfigRequest): any => ({ ...obj, }); @@ -1950,6 +2160,9 @@ export interface UpdateFieldLevelEncryptionConfigResult { } export namespace UpdateFieldLevelEncryptionConfigResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateFieldLevelEncryptionConfigResult): any => ({ ...obj, }); @@ -1974,6 +2187,9 @@ export interface UpdateFieldLevelEncryptionProfileRequest { } export namespace UpdateFieldLevelEncryptionProfileRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateFieldLevelEncryptionProfileRequest): any => ({ ...obj, }); @@ -1992,6 +2208,9 @@ export interface UpdateFieldLevelEncryptionProfileResult { } export namespace UpdateFieldLevelEncryptionProfileResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateFieldLevelEncryptionProfileResult): any => ({ ...obj, }); @@ -2016,6 +2235,9 @@ export interface UpdateKeyGroupRequest { } export namespace UpdateKeyGroupRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateKeyGroupRequest): any => ({ ...obj, }); @@ -2034,6 +2256,9 @@ export interface UpdateKeyGroupResult { } export namespace UpdateKeyGroupResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateKeyGroupResult): any => ({ ...obj, }); @@ -2061,6 +2286,9 @@ export interface UpdateOriginRequestPolicyRequest { } export namespace UpdateOriginRequestPolicyRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateOriginRequestPolicyRequest): any => ({ ...obj, }); @@ -2079,6 +2307,9 @@ export interface UpdateOriginRequestPolicyResult { } export namespace UpdateOriginRequestPolicyResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateOriginRequestPolicyResult): any => ({ ...obj, }); @@ -2103,6 +2334,9 @@ export interface UpdatePublicKeyRequest { } export namespace UpdatePublicKeyRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdatePublicKeyRequest): any => ({ ...obj, }); @@ -2121,6 +2355,9 @@ export interface UpdatePublicKeyResult { } export namespace UpdatePublicKeyResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdatePublicKeyResult): any => ({ ...obj, }); @@ -2159,6 +2396,9 @@ export interface UpdateRealtimeLogConfigRequest { } export namespace UpdateRealtimeLogConfigRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateRealtimeLogConfigRequest): any => ({ ...obj, }); @@ -2172,6 +2412,9 @@ export interface UpdateRealtimeLogConfigResult { } export namespace UpdateRealtimeLogConfigResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateRealtimeLogConfigResult): any => ({ ...obj, }); @@ -2199,6 +2442,9 @@ export interface UpdateStreamingDistributionRequest { } export namespace UpdateStreamingDistributionRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateStreamingDistributionRequest): any => ({ ...obj, }); @@ -2221,6 +2467,9 @@ export interface UpdateStreamingDistributionResult { } export namespace UpdateStreamingDistributionResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateStreamingDistributionResult): any => ({ ...obj, }); diff --git a/clients/client-cloudhsm-v2/commands/CopyBackupToRegionCommand.ts b/clients/client-cloudhsm-v2/commands/CopyBackupToRegionCommand.ts index 626055e259bb..79da90a2ca74 100644 --- a/clients/client-cloudhsm-v2/commands/CopyBackupToRegionCommand.ts +++ b/clients/client-cloudhsm-v2/commands/CopyBackupToRegionCommand.ts @@ -22,6 +22,20 @@ export interface CopyBackupToRegionCommandOutput extends CopyBackupToRegionRespo /** *

Copy an AWS CloudHSM cluster backup to a different region.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { CloudHSMV2Client, CopyBackupToRegionCommand } from "@aws-sdk/client-cloudhsm-v2"; // ES Modules import + * // const { CloudHSMV2Client, CopyBackupToRegionCommand } = require("@aws-sdk/client-cloudhsm-v2"); // CommonJS import + * const client = new CloudHSMV2Client(config); + * const command = new CopyBackupToRegionCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CopyBackupToRegionCommandInput} for command's `input` shape. + * @see {@link CopyBackupToRegionCommandOutput} for command's `response` shape. + * @see {@link CloudHSMV2ClientResolvedConfig | config} for command's `input` shape. + * */ export class CopyBackupToRegionCommand extends $Command< CopyBackupToRegionCommandInput, diff --git a/clients/client-cloudhsm-v2/commands/CreateClusterCommand.ts b/clients/client-cloudhsm-v2/commands/CreateClusterCommand.ts index cb83a8291587..b23ba3a670f6 100644 --- a/clients/client-cloudhsm-v2/commands/CreateClusterCommand.ts +++ b/clients/client-cloudhsm-v2/commands/CreateClusterCommand.ts @@ -22,6 +22,20 @@ export interface CreateClusterCommandOutput extends CreateClusterResponse, __Met /** *

Creates a new AWS CloudHSM cluster.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { CloudHSMV2Client, CreateClusterCommand } from "@aws-sdk/client-cloudhsm-v2"; // ES Modules import + * // const { CloudHSMV2Client, CreateClusterCommand } = require("@aws-sdk/client-cloudhsm-v2"); // CommonJS import + * const client = new CloudHSMV2Client(config); + * const command = new CreateClusterCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreateClusterCommandInput} for command's `input` shape. + * @see {@link CreateClusterCommandOutput} for command's `response` shape. + * @see {@link CloudHSMV2ClientResolvedConfig | config} for command's `input` shape. + * */ export class CreateClusterCommand extends $Command< CreateClusterCommandInput, diff --git a/clients/client-cloudhsm-v2/commands/CreateHsmCommand.ts b/clients/client-cloudhsm-v2/commands/CreateHsmCommand.ts index e9b319ce4441..320c1fa29b0f 100644 --- a/clients/client-cloudhsm-v2/commands/CreateHsmCommand.ts +++ b/clients/client-cloudhsm-v2/commands/CreateHsmCommand.ts @@ -20,6 +20,20 @@ export interface CreateHsmCommandOutput extends CreateHsmResponse, __MetadataBea /** *

Creates a new hardware security module (HSM) in the specified AWS CloudHSM * cluster.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { CloudHSMV2Client, CreateHsmCommand } from "@aws-sdk/client-cloudhsm-v2"; // ES Modules import + * // const { CloudHSMV2Client, CreateHsmCommand } = require("@aws-sdk/client-cloudhsm-v2"); // CommonJS import + * const client = new CloudHSMV2Client(config); + * const command = new CreateHsmCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreateHsmCommandInput} for command's `input` shape. + * @see {@link CreateHsmCommandOutput} for command's `response` shape. + * @see {@link CloudHSMV2ClientResolvedConfig | config} for command's `input` shape. + * */ export class CreateHsmCommand extends $Command< CreateHsmCommandInput, diff --git a/clients/client-cloudhsm-v2/commands/DeleteBackupCommand.ts b/clients/client-cloudhsm-v2/commands/DeleteBackupCommand.ts index bcf990a09b71..50e0b58cf823 100644 --- a/clients/client-cloudhsm-v2/commands/DeleteBackupCommand.ts +++ b/clients/client-cloudhsm-v2/commands/DeleteBackupCommand.ts @@ -24,6 +24,20 @@ export interface DeleteBackupCommandOutput extends DeleteBackupResponse, __Metad *

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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { CloudHSMV2Client, DeleteBackupCommand } from "@aws-sdk/client-cloudhsm-v2"; // ES Modules import + * // const { CloudHSMV2Client, DeleteBackupCommand } = require("@aws-sdk/client-cloudhsm-v2"); // CommonJS import + * const client = new CloudHSMV2Client(config); + * const command = new DeleteBackupCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteBackupCommandInput} for command's `input` shape. + * @see {@link DeleteBackupCommandOutput} for command's `response` shape. + * @see {@link CloudHSMV2ClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteBackupCommand extends $Command< DeleteBackupCommandInput, diff --git a/clients/client-cloudhsm-v2/commands/DeleteClusterCommand.ts b/clients/client-cloudhsm-v2/commands/DeleteClusterCommand.ts index 2c9e851ae879..6b9cee369cfb 100644 --- a/clients/client-cloudhsm-v2/commands/DeleteClusterCommand.ts +++ b/clients/client-cloudhsm-v2/commands/DeleteClusterCommand.ts @@ -23,6 +23,20 @@ export interface DeleteClusterCommandOutput extends DeleteClusterResponse, __Met /** *

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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { CloudHSMV2Client, DeleteClusterCommand } from "@aws-sdk/client-cloudhsm-v2"; // ES Modules import + * // const { CloudHSMV2Client, DeleteClusterCommand } = require("@aws-sdk/client-cloudhsm-v2"); // CommonJS import + * const client = new CloudHSMV2Client(config); + * const command = new DeleteClusterCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteClusterCommandInput} for command's `input` shape. + * @see {@link DeleteClusterCommandOutput} for command's `response` shape. + * @see {@link CloudHSMV2ClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteClusterCommand extends $Command< DeleteClusterCommandInput, diff --git a/clients/client-cloudhsm-v2/commands/DeleteHsmCommand.ts b/clients/client-cloudhsm-v2/commands/DeleteHsmCommand.ts index 3641559b0855..b29762076d0b 100644 --- a/clients/client-cloudhsm-v2/commands/DeleteHsmCommand.ts +++ b/clients/client-cloudhsm-v2/commands/DeleteHsmCommand.ts @@ -21,6 +21,20 @@ export interface DeleteHsmCommandOutput extends DeleteHsmResponse, __MetadataBea *

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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { CloudHSMV2Client, DeleteHsmCommand } from "@aws-sdk/client-cloudhsm-v2"; // ES Modules import + * // const { CloudHSMV2Client, DeleteHsmCommand } = require("@aws-sdk/client-cloudhsm-v2"); // CommonJS import + * const client = new CloudHSMV2Client(config); + * const command = new DeleteHsmCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteHsmCommandInput} for command's `input` shape. + * @see {@link DeleteHsmCommandOutput} for command's `response` shape. + * @see {@link CloudHSMV2ClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteHsmCommand extends $Command< DeleteHsmCommandInput, diff --git a/clients/client-cloudhsm-v2/commands/DescribeBackupsCommand.ts b/clients/client-cloudhsm-v2/commands/DescribeBackupsCommand.ts index 58ca600e5797..8f2c5e36db26 100644 --- a/clients/client-cloudhsm-v2/commands/DescribeBackupsCommand.ts +++ b/clients/client-cloudhsm-v2/commands/DescribeBackupsCommand.ts @@ -27,6 +27,20 @@ export interface DescribeBackupsCommandOutput extends DescribeBackupsResponse, _ * 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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { CloudHSMV2Client, DescribeBackupsCommand } from "@aws-sdk/client-cloudhsm-v2"; // ES Modules import + * // const { CloudHSMV2Client, DescribeBackupsCommand } = require("@aws-sdk/client-cloudhsm-v2"); // CommonJS import + * const client = new CloudHSMV2Client(config); + * const command = new DescribeBackupsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeBackupsCommandInput} for command's `input` shape. + * @see {@link DescribeBackupsCommandOutput} for command's `response` shape. + * @see {@link CloudHSMV2ClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeBackupsCommand extends $Command< DescribeBackupsCommandInput, diff --git a/clients/client-cloudhsm-v2/commands/DescribeClustersCommand.ts b/clients/client-cloudhsm-v2/commands/DescribeClustersCommand.ts index 5de8b5cb6898..c890112093cd 100644 --- a/clients/client-cloudhsm-v2/commands/DescribeClustersCommand.ts +++ b/clients/client-cloudhsm-v2/commands/DescribeClustersCommand.ts @@ -27,6 +27,20 @@ export interface DescribeClustersCommandOutput extends DescribeClustersResponse, * 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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { CloudHSMV2Client, DescribeClustersCommand } from "@aws-sdk/client-cloudhsm-v2"; // ES Modules import + * // const { CloudHSMV2Client, DescribeClustersCommand } = require("@aws-sdk/client-cloudhsm-v2"); // CommonJS import + * const client = new CloudHSMV2Client(config); + * const command = new DescribeClustersCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeClustersCommandInput} for command's `input` shape. + * @see {@link DescribeClustersCommandOutput} for command's `response` shape. + * @see {@link CloudHSMV2ClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeClustersCommand extends $Command< DescribeClustersCommandInput, diff --git a/clients/client-cloudhsm-v2/commands/InitializeClusterCommand.ts b/clients/client-cloudhsm-v2/commands/InitializeClusterCommand.ts index 21c43ab3c322..e06938d1f71b 100644 --- a/clients/client-cloudhsm-v2/commands/InitializeClusterCommand.ts +++ b/clients/client-cloudhsm-v2/commands/InitializeClusterCommand.ts @@ -25,6 +25,20 @@ export interface InitializeClusterCommandOutput extends InitializeClusterRespons * 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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { CloudHSMV2Client, InitializeClusterCommand } from "@aws-sdk/client-cloudhsm-v2"; // ES Modules import + * // const { CloudHSMV2Client, InitializeClusterCommand } = require("@aws-sdk/client-cloudhsm-v2"); // CommonJS import + * const client = new CloudHSMV2Client(config); + * const command = new InitializeClusterCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link InitializeClusterCommandInput} for command's `input` shape. + * @see {@link InitializeClusterCommandOutput} for command's `response` shape. + * @see {@link CloudHSMV2ClientResolvedConfig | config} for command's `input` shape. + * */ export class InitializeClusterCommand extends $Command< InitializeClusterCommandInput, diff --git a/clients/client-cloudhsm-v2/commands/ListTagsCommand.ts b/clients/client-cloudhsm-v2/commands/ListTagsCommand.ts index f0c20280faca..9dc494c04c76 100644 --- a/clients/client-cloudhsm-v2/commands/ListTagsCommand.ts +++ b/clients/client-cloudhsm-v2/commands/ListTagsCommand.ts @@ -24,6 +24,20 @@ export interface ListTagsCommandOutput extends ListTagsResponse, __MetadataBeare * 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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { CloudHSMV2Client, ListTagsCommand } from "@aws-sdk/client-cloudhsm-v2"; // ES Modules import + * // const { CloudHSMV2Client, ListTagsCommand } = require("@aws-sdk/client-cloudhsm-v2"); // CommonJS import + * const client = new CloudHSMV2Client(config); + * const command = new ListTagsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListTagsCommandInput} for command's `input` shape. + * @see {@link ListTagsCommandOutput} for command's `response` shape. + * @see {@link CloudHSMV2ClientResolvedConfig | config} for command's `input` shape. + * */ export class ListTagsCommand extends $Command< ListTagsCommandInput, diff --git a/clients/client-cloudhsm-v2/commands/ModifyBackupAttributesCommand.ts b/clients/client-cloudhsm-v2/commands/ModifyBackupAttributesCommand.ts index 04f6bc11f5e7..f252f4c693ca 100644 --- a/clients/client-cloudhsm-v2/commands/ModifyBackupAttributesCommand.ts +++ b/clients/client-cloudhsm-v2/commands/ModifyBackupAttributesCommand.ts @@ -22,6 +22,20 @@ export interface ModifyBackupAttributesCommandOutput extends ModifyBackupAttribu /** *

Modifies attributes for AWS CloudHSM backup.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { CloudHSMV2Client, ModifyBackupAttributesCommand } from "@aws-sdk/client-cloudhsm-v2"; // ES Modules import + * // const { CloudHSMV2Client, ModifyBackupAttributesCommand } = require("@aws-sdk/client-cloudhsm-v2"); // CommonJS import + * const client = new CloudHSMV2Client(config); + * const command = new ModifyBackupAttributesCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ModifyBackupAttributesCommandInput} for command's `input` shape. + * @see {@link ModifyBackupAttributesCommandOutput} for command's `response` shape. + * @see {@link CloudHSMV2ClientResolvedConfig | config} for command's `input` shape. + * */ export class ModifyBackupAttributesCommand extends $Command< ModifyBackupAttributesCommandInput, diff --git a/clients/client-cloudhsm-v2/commands/ModifyClusterCommand.ts b/clients/client-cloudhsm-v2/commands/ModifyClusterCommand.ts index 29bd4cd4ce52..5378d2c91039 100644 --- a/clients/client-cloudhsm-v2/commands/ModifyClusterCommand.ts +++ b/clients/client-cloudhsm-v2/commands/ModifyClusterCommand.ts @@ -22,6 +22,20 @@ export interface ModifyClusterCommandOutput extends ModifyClusterResponse, __Met /** *

Modifies AWS CloudHSM cluster.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { CloudHSMV2Client, ModifyClusterCommand } from "@aws-sdk/client-cloudhsm-v2"; // ES Modules import + * // const { CloudHSMV2Client, ModifyClusterCommand } = require("@aws-sdk/client-cloudhsm-v2"); // CommonJS import + * const client = new CloudHSMV2Client(config); + * const command = new ModifyClusterCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ModifyClusterCommandInput} for command's `input` shape. + * @see {@link ModifyClusterCommandOutput} for command's `response` shape. + * @see {@link CloudHSMV2ClientResolvedConfig | config} for command's `input` shape. + * */ export class ModifyClusterCommand extends $Command< ModifyClusterCommandInput, diff --git a/clients/client-cloudhsm-v2/commands/RestoreBackupCommand.ts b/clients/client-cloudhsm-v2/commands/RestoreBackupCommand.ts index b2e9e4959de5..3ae676b088d4 100644 --- a/clients/client-cloudhsm-v2/commands/RestoreBackupCommand.ts +++ b/clients/client-cloudhsm-v2/commands/RestoreBackupCommand.ts @@ -24,6 +24,20 @@ export interface RestoreBackupCommandOutput extends RestoreBackupResponse, __Met *

Restores a specified AWS CloudHSM backup that is in the * PENDING_DELETION state. For mor information on deleting a backup, see * DeleteBackup.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { CloudHSMV2Client, RestoreBackupCommand } from "@aws-sdk/client-cloudhsm-v2"; // ES Modules import + * // const { CloudHSMV2Client, RestoreBackupCommand } = require("@aws-sdk/client-cloudhsm-v2"); // CommonJS import + * const client = new CloudHSMV2Client(config); + * const command = new RestoreBackupCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link RestoreBackupCommandInput} for command's `input` shape. + * @see {@link RestoreBackupCommandOutput} for command's `response` shape. + * @see {@link CloudHSMV2ClientResolvedConfig | config} for command's `input` shape. + * */ export class RestoreBackupCommand extends $Command< RestoreBackupCommandInput, diff --git a/clients/client-cloudhsm-v2/commands/TagResourceCommand.ts b/clients/client-cloudhsm-v2/commands/TagResourceCommand.ts index d5112578c33d..ffd8512627c1 100644 --- a/clients/client-cloudhsm-v2/commands/TagResourceCommand.ts +++ b/clients/client-cloudhsm-v2/commands/TagResourceCommand.ts @@ -22,6 +22,20 @@ export interface TagResourceCommandOutput extends TagResourceResponse, __Metadat /** *

Adds or overwrites one or more tags for the specified AWS CloudHSM cluster.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { CloudHSMV2Client, TagResourceCommand } from "@aws-sdk/client-cloudhsm-v2"; // ES Modules import + * // const { CloudHSMV2Client, TagResourceCommand } = require("@aws-sdk/client-cloudhsm-v2"); // CommonJS import + * const client = new CloudHSMV2Client(config); + * const command = new TagResourceCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link TagResourceCommandInput} for command's `input` shape. + * @see {@link TagResourceCommandOutput} for command's `response` shape. + * @see {@link CloudHSMV2ClientResolvedConfig | config} for command's `input` shape. + * */ export class TagResourceCommand extends $Command< TagResourceCommandInput, diff --git a/clients/client-cloudhsm-v2/commands/UntagResourceCommand.ts b/clients/client-cloudhsm-v2/commands/UntagResourceCommand.ts index 75fdff1ad294..8e63ca28febb 100644 --- a/clients/client-cloudhsm-v2/commands/UntagResourceCommand.ts +++ b/clients/client-cloudhsm-v2/commands/UntagResourceCommand.ts @@ -22,6 +22,20 @@ export interface UntagResourceCommandOutput extends UntagResourceResponse, __Met /** *

Removes the specified tag or tags from the specified AWS CloudHSM cluster.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { CloudHSMV2Client, UntagResourceCommand } from "@aws-sdk/client-cloudhsm-v2"; // ES Modules import + * // const { CloudHSMV2Client, UntagResourceCommand } = require("@aws-sdk/client-cloudhsm-v2"); // CommonJS import + * const client = new CloudHSMV2Client(config); + * const command = new UntagResourceCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link UntagResourceCommandInput} for command's `input` shape. + * @see {@link UntagResourceCommandOutput} for command's `response` shape. + * @see {@link CloudHSMV2ClientResolvedConfig | config} for command's `input` shape. + * */ export class UntagResourceCommand extends $Command< UntagResourceCommandInput, diff --git a/clients/client-cloudhsm-v2/models/models_0.ts b/clients/client-cloudhsm-v2/models/models_0.ts index 7052ffc430fb..5cd683e5e3cf 100644 --- a/clients/client-cloudhsm-v2/models/models_0.ts +++ b/clients/client-cloudhsm-v2/models/models_0.ts @@ -24,6 +24,9 @@ export interface Tag { } export namespace Tag { + /** + * @internal + */ export const filterSensitiveLog = (obj: Tag): any => ({ ...obj, }); @@ -99,6 +102,9 @@ export interface Backup { } export namespace Backup { + /** + * @internal + */ export const filterSensitiveLog = (obj: Backup): any => ({ ...obj, }); @@ -129,6 +135,9 @@ export interface BackupRetentionPolicy { } export namespace BackupRetentionPolicy { + /** + * @internal + */ export const filterSensitiveLog = (obj: BackupRetentionPolicy): any => ({ ...obj, }); @@ -145,6 +154,9 @@ export interface CloudHsmAccessDeniedException extends __SmithyException, $Metad } export namespace CloudHsmAccessDeniedException { + /** + * @internal + */ export const filterSensitiveLog = (obj: CloudHsmAccessDeniedException): any => ({ ...obj, }); @@ -161,6 +173,9 @@ export interface CloudHsmInternalFailureException extends __SmithyException, $Me } export namespace CloudHsmInternalFailureException { + /** + * @internal + */ export const filterSensitiveLog = (obj: CloudHsmInternalFailureException): any => ({ ...obj, }); @@ -176,6 +191,9 @@ export interface CloudHsmInvalidRequestException extends __SmithyException, $Met } export namespace CloudHsmInvalidRequestException { + /** + * @internal + */ export const filterSensitiveLog = (obj: CloudHsmInvalidRequestException): any => ({ ...obj, }); @@ -192,6 +210,9 @@ export interface CloudHsmResourceNotFoundException extends __SmithyException, $M } export namespace CloudHsmResourceNotFoundException { + /** + * @internal + */ export const filterSensitiveLog = (obj: CloudHsmResourceNotFoundException): any => ({ ...obj, }); @@ -207,6 +228,9 @@ export interface CloudHsmServiceException extends __SmithyException, $MetadataBe } export namespace CloudHsmServiceException { + /** + * @internal + */ export const filterSensitiveLog = (obj: CloudHsmServiceException): any => ({ ...obj, }); @@ -222,6 +246,9 @@ export interface CloudHsmTagException extends __SmithyException, $MetadataBearer } export namespace CloudHsmTagException { + /** + * @internal + */ export const filterSensitiveLog = (obj: CloudHsmTagException): any => ({ ...obj, }); @@ -245,6 +272,9 @@ export interface CopyBackupToRegionRequest { } export namespace CopyBackupToRegionRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: CopyBackupToRegionRequest): any => ({ ...obj, }); @@ -276,6 +306,9 @@ export interface DestinationBackup { } export namespace DestinationBackup { + /** + * @internal + */ export const filterSensitiveLog = (obj: DestinationBackup): any => ({ ...obj, }); @@ -294,6 +327,9 @@ export interface CopyBackupToRegionResponse { } export namespace CopyBackupToRegionResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: CopyBackupToRegionResponse): any => ({ ...obj, }); @@ -339,6 +375,9 @@ export interface CreateClusterRequest { } export namespace CreateClusterRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateClusterRequest): any => ({ ...obj, }); @@ -377,6 +416,9 @@ export interface Certificates { } export namespace Certificates { + /** + * @internal + */ export const filterSensitiveLog = (obj: Certificates): any => ({ ...obj, }); @@ -437,6 +479,9 @@ export interface Hsm { } export namespace Hsm { + /** + * @internal + */ export const filterSensitiveLog = (obj: Hsm): any => ({ ...obj, }); @@ -537,6 +582,9 @@ export interface Cluster { } export namespace Cluster { + /** + * @internal + */ export const filterSensitiveLog = (obj: Cluster): any => ({ ...obj, }); @@ -550,6 +598,9 @@ export interface CreateClusterResponse { } export namespace CreateClusterResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateClusterResponse): any => ({ ...obj, }); @@ -576,6 +627,9 @@ export interface CreateHsmRequest { } export namespace CreateHsmRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateHsmRequest): any => ({ ...obj, }); @@ -589,6 +643,9 @@ export interface CreateHsmResponse { } export namespace CreateHsmResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateHsmResponse): any => ({ ...obj, }); @@ -602,6 +659,9 @@ export interface DeleteBackupRequest { } export namespace DeleteBackupRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteBackupRequest): any => ({ ...obj, }); @@ -615,6 +675,9 @@ export interface DeleteBackupResponse { } export namespace DeleteBackupResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteBackupResponse): any => ({ ...obj, }); @@ -629,6 +692,9 @@ export interface DeleteClusterRequest { } export namespace DeleteClusterRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteClusterRequest): any => ({ ...obj, }); @@ -642,6 +708,9 @@ export interface DeleteClusterResponse { } export namespace DeleteClusterResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteClusterResponse): any => ({ ...obj, }); @@ -673,6 +742,9 @@ export interface DeleteHsmRequest { } export namespace DeleteHsmRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteHsmRequest): any => ({ ...obj, }); @@ -686,6 +758,9 @@ export interface DeleteHsmResponse { } export namespace DeleteHsmResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteHsmResponse): any => ({ ...obj, }); @@ -729,6 +804,9 @@ export interface DescribeBackupsRequest { } export namespace DescribeBackupsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeBackupsRequest): any => ({ ...obj, }); @@ -749,6 +827,9 @@ export interface DescribeBackupsResponse { } export namespace DescribeBackupsResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeBackupsResponse): any => ({ ...obj, }); @@ -780,6 +861,9 @@ export interface DescribeClustersRequest { } export namespace DescribeClustersRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeClustersRequest): any => ({ ...obj, }); @@ -800,6 +884,9 @@ export interface DescribeClustersResponse { } export namespace DescribeClustersResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeClustersResponse): any => ({ ...obj, }); @@ -828,6 +915,9 @@ export interface InitializeClusterRequest { } export namespace InitializeClusterRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: InitializeClusterRequest): any => ({ ...obj, }); @@ -846,6 +936,9 @@ export interface InitializeClusterResponse { } export namespace InitializeClusterResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: InitializeClusterResponse): any => ({ ...obj, }); @@ -872,6 +965,9 @@ export interface ListTagsRequest { } export namespace ListTagsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListTagsRequest): any => ({ ...obj, }); @@ -891,6 +987,9 @@ export interface ListTagsResponse { } export namespace ListTagsResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListTagsResponse): any => ({ ...obj, }); @@ -910,6 +1009,9 @@ export interface ModifyBackupAttributesRequest { } export namespace ModifyBackupAttributesRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ModifyBackupAttributesRequest): any => ({ ...obj, }); @@ -928,6 +1030,9 @@ export interface ModifyBackupAttributesResponse { } export namespace ModifyBackupAttributesResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ModifyBackupAttributesResponse): any => ({ ...obj, }); @@ -947,6 +1052,9 @@ export interface ModifyClusterRequest { } export namespace ModifyClusterRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ModifyClusterRequest): any => ({ ...obj, }); @@ -960,6 +1068,9 @@ export interface ModifyClusterResponse { } export namespace ModifyClusterResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ModifyClusterResponse): any => ({ ...obj, }); @@ -973,6 +1084,9 @@ export interface RestoreBackupRequest { } export namespace RestoreBackupRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: RestoreBackupRequest): any => ({ ...obj, }); @@ -986,6 +1100,9 @@ export interface RestoreBackupResponse { } export namespace RestoreBackupResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: RestoreBackupResponse): any => ({ ...obj, }); @@ -1005,6 +1122,9 @@ export interface TagResourceRequest { } export namespace TagResourceRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: TagResourceRequest): any => ({ ...obj, }); @@ -1013,6 +1133,9 @@ export namespace TagResourceRequest { export interface TagResourceResponse {} export namespace TagResourceResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: TagResourceResponse): any => ({ ...obj, }); @@ -1033,6 +1156,9 @@ export interface UntagResourceRequest { } export namespace UntagResourceRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: UntagResourceRequest): any => ({ ...obj, }); @@ -1041,6 +1167,9 @@ export namespace UntagResourceRequest { export interface UntagResourceResponse {} export namespace UntagResourceResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: UntagResourceResponse): any => ({ ...obj, }); diff --git a/clients/client-cloudhsm/commands/AddTagsToResourceCommand.ts b/clients/client-cloudhsm/commands/AddTagsToResourceCommand.ts index bf32ddeefdfe..a66749c57289 100644 --- a/clients/client-cloudhsm/commands/AddTagsToResourceCommand.ts +++ b/clients/client-cloudhsm/commands/AddTagsToResourceCommand.ts @@ -34,6 +34,20 @@ export interface AddTagsToResourceCommandOutput extends AddTagsToResourceRespons *

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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { CloudHSMClient, AddTagsToResourceCommand } from "@aws-sdk/client-cloudhsm"; // ES Modules import + * // const { CloudHSMClient, AddTagsToResourceCommand } = require("@aws-sdk/client-cloudhsm"); // CommonJS import + * const client = new CloudHSMClient(config); + * const command = new AddTagsToResourceCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link AddTagsToResourceCommandInput} for command's `input` shape. + * @see {@link AddTagsToResourceCommandOutput} for command's `response` shape. + * @see {@link CloudHSMClientResolvedConfig | config} for command's `input` shape. + * */ export class AddTagsToResourceCommand extends $Command< AddTagsToResourceCommandInput, diff --git a/clients/client-cloudhsm/commands/CreateHapgCommand.ts b/clients/client-cloudhsm/commands/CreateHapgCommand.ts index 143f242aafd4..3d363f5eee21 100644 --- a/clients/client-cloudhsm/commands/CreateHapgCommand.ts +++ b/clients/client-cloudhsm/commands/CreateHapgCommand.ts @@ -33,6 +33,20 @@ export interface CreateHapgCommandOutput extends CreateHapgResponse, __MetadataB * Reference.

*

Creates a high-availability partition group. A high-availability partition group is a * group of partitions that spans multiple physical HSMs.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { CloudHSMClient, CreateHapgCommand } from "@aws-sdk/client-cloudhsm"; // ES Modules import + * // const { CloudHSMClient, CreateHapgCommand } = require("@aws-sdk/client-cloudhsm"); // CommonJS import + * const client = new CloudHSMClient(config); + * const command = new CreateHapgCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreateHapgCommandInput} for command's `input` shape. + * @see {@link CreateHapgCommandOutput} for command's `response` shape. + * @see {@link CloudHSMClientResolvedConfig | config} for command's `input` shape. + * */ export class CreateHapgCommand extends $Command< CreateHapgCommandInput, diff --git a/clients/client-cloudhsm/commands/CreateHsmCommand.ts b/clients/client-cloudhsm/commands/CreateHsmCommand.ts index 77e4cee9f78c..6ad8ac9c43d5 100644 --- a/clients/client-cloudhsm/commands/CreateHsmCommand.ts +++ b/clients/client-cloudhsm/commands/CreateHsmCommand.ts @@ -38,6 +38,20 @@ export interface CreateHsmCommandOutput extends CreateHsmResponse, __MetadataBea * status of the HSM with the DescribeHsm operation. The HSM is ready to be * initialized when the status changes to RUNNING.

* + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { CloudHSMClient, CreateHsmCommand } from "@aws-sdk/client-cloudhsm"; // ES Modules import + * // const { CloudHSMClient, CreateHsmCommand } = require("@aws-sdk/client-cloudhsm"); // CommonJS import + * const client = new CloudHSMClient(config); + * const command = new CreateHsmCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreateHsmCommandInput} for command's `input` shape. + * @see {@link CreateHsmCommandOutput} for command's `response` shape. + * @see {@link CloudHSMClientResolvedConfig | config} for command's `input` shape. + * */ export class CreateHsmCommand extends $Command< CreateHsmCommandInput, diff --git a/clients/client-cloudhsm/commands/CreateLunaClientCommand.ts b/clients/client-cloudhsm/commands/CreateLunaClientCommand.ts index e8db8bf87748..d31fb6ca8aeb 100644 --- a/clients/client-cloudhsm/commands/CreateLunaClientCommand.ts +++ b/clients/client-cloudhsm/commands/CreateLunaClientCommand.ts @@ -32,6 +32,20 @@ export interface CreateLunaClientCommandOutput extends CreateLunaClientResponse, * and the AWS CloudHSM API * Reference.

*

Creates an HSM client.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { CloudHSMClient, CreateLunaClientCommand } from "@aws-sdk/client-cloudhsm"; // ES Modules import + * // const { CloudHSMClient, CreateLunaClientCommand } = require("@aws-sdk/client-cloudhsm"); // CommonJS import + * const client = new CloudHSMClient(config); + * const command = new CreateLunaClientCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreateLunaClientCommandInput} for command's `input` shape. + * @see {@link CreateLunaClientCommandOutput} for command's `response` shape. + * @see {@link CloudHSMClientResolvedConfig | config} for command's `input` shape. + * */ export class CreateLunaClientCommand extends $Command< CreateLunaClientCommandInput, diff --git a/clients/client-cloudhsm/commands/DeleteHapgCommand.ts b/clients/client-cloudhsm/commands/DeleteHapgCommand.ts index a5943f5a09b4..73e9826fdded 100644 --- a/clients/client-cloudhsm/commands/DeleteHapgCommand.ts +++ b/clients/client-cloudhsm/commands/DeleteHapgCommand.ts @@ -32,6 +32,20 @@ export interface DeleteHapgCommandOutput extends DeleteHapgResponse, __MetadataB * and the AWS CloudHSM API * Reference.

*

Deletes a high-availability partition group.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { CloudHSMClient, DeleteHapgCommand } from "@aws-sdk/client-cloudhsm"; // ES Modules import + * // const { CloudHSMClient, DeleteHapgCommand } = require("@aws-sdk/client-cloudhsm"); // CommonJS import + * const client = new CloudHSMClient(config); + * const command = new DeleteHapgCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteHapgCommandInput} for command's `input` shape. + * @see {@link DeleteHapgCommandOutput} for command's `response` shape. + * @see {@link CloudHSMClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteHapgCommand extends $Command< DeleteHapgCommandInput, diff --git a/clients/client-cloudhsm/commands/DeleteHsmCommand.ts b/clients/client-cloudhsm/commands/DeleteHsmCommand.ts index c286ceeb979c..2fa02b5e7546 100644 --- a/clients/client-cloudhsm/commands/DeleteHsmCommand.ts +++ b/clients/client-cloudhsm/commands/DeleteHsmCommand.ts @@ -30,6 +30,20 @@ export interface DeleteHsmCommandOutput extends DeleteHsmResponse, __MetadataBea * Reference.

*

Deletes an HSM. After completion, this operation cannot be undone and your key material * cannot be recovered.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { CloudHSMClient, DeleteHsmCommand } from "@aws-sdk/client-cloudhsm"; // ES Modules import + * // const { CloudHSMClient, DeleteHsmCommand } = require("@aws-sdk/client-cloudhsm"); // CommonJS import + * const client = new CloudHSMClient(config); + * const command = new DeleteHsmCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteHsmCommandInput} for command's `input` shape. + * @see {@link DeleteHsmCommandOutput} for command's `response` shape. + * @see {@link CloudHSMClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteHsmCommand extends $Command< DeleteHsmCommandInput, diff --git a/clients/client-cloudhsm/commands/DeleteLunaClientCommand.ts b/clients/client-cloudhsm/commands/DeleteLunaClientCommand.ts index f6820c951e6e..409728906657 100644 --- a/clients/client-cloudhsm/commands/DeleteLunaClientCommand.ts +++ b/clients/client-cloudhsm/commands/DeleteLunaClientCommand.ts @@ -32,6 +32,20 @@ export interface DeleteLunaClientCommandOutput extends DeleteLunaClientResponse, * and the AWS CloudHSM API * Reference.

*

Deletes a client.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { CloudHSMClient, DeleteLunaClientCommand } from "@aws-sdk/client-cloudhsm"; // ES Modules import + * // const { CloudHSMClient, DeleteLunaClientCommand } = require("@aws-sdk/client-cloudhsm"); // CommonJS import + * const client = new CloudHSMClient(config); + * const command = new DeleteLunaClientCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteLunaClientCommandInput} for command's `input` shape. + * @see {@link DeleteLunaClientCommandOutput} for command's `response` shape. + * @see {@link CloudHSMClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteLunaClientCommand extends $Command< DeleteLunaClientCommandInput, diff --git a/clients/client-cloudhsm/commands/DescribeHapgCommand.ts b/clients/client-cloudhsm/commands/DescribeHapgCommand.ts index f5eda677e8f3..75a5d432bf5d 100644 --- a/clients/client-cloudhsm/commands/DescribeHapgCommand.ts +++ b/clients/client-cloudhsm/commands/DescribeHapgCommand.ts @@ -32,6 +32,20 @@ export interface DescribeHapgCommandOutput extends DescribeHapgResponse, __Metad * and the AWS CloudHSM API * Reference.

*

Retrieves information about a high-availability partition group.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { CloudHSMClient, DescribeHapgCommand } from "@aws-sdk/client-cloudhsm"; // ES Modules import + * // const { CloudHSMClient, DescribeHapgCommand } = require("@aws-sdk/client-cloudhsm"); // CommonJS import + * const client = new CloudHSMClient(config); + * const command = new DescribeHapgCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeHapgCommandInput} for command's `input` shape. + * @see {@link DescribeHapgCommandOutput} for command's `response` shape. + * @see {@link CloudHSMClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeHapgCommand extends $Command< DescribeHapgCommandInput, diff --git a/clients/client-cloudhsm/commands/DescribeHsmCommand.ts b/clients/client-cloudhsm/commands/DescribeHsmCommand.ts index 2c95dce78212..81c219d3d898 100644 --- a/clients/client-cloudhsm/commands/DescribeHsmCommand.ts +++ b/clients/client-cloudhsm/commands/DescribeHsmCommand.ts @@ -33,6 +33,20 @@ export interface DescribeHsmCommandOutput extends DescribeHsmResponse, __Metadat * Reference.

*

Retrieves information about an HSM. You can identify the HSM by its ARN or its serial * number.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { CloudHSMClient, DescribeHsmCommand } from "@aws-sdk/client-cloudhsm"; // ES Modules import + * // const { CloudHSMClient, DescribeHsmCommand } = require("@aws-sdk/client-cloudhsm"); // CommonJS import + * const client = new CloudHSMClient(config); + * const command = new DescribeHsmCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeHsmCommandInput} for command's `input` shape. + * @see {@link DescribeHsmCommandOutput} for command's `response` shape. + * @see {@link CloudHSMClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeHsmCommand extends $Command< DescribeHsmCommandInput, diff --git a/clients/client-cloudhsm/commands/DescribeLunaClientCommand.ts b/clients/client-cloudhsm/commands/DescribeLunaClientCommand.ts index f9fe01af17c9..5bc2a5ffd856 100644 --- a/clients/client-cloudhsm/commands/DescribeLunaClientCommand.ts +++ b/clients/client-cloudhsm/commands/DescribeLunaClientCommand.ts @@ -32,6 +32,20 @@ export interface DescribeLunaClientCommandOutput extends DescribeLunaClientRespo * and the AWS CloudHSM API * Reference.

*

Retrieves information about an HSM client.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { CloudHSMClient, DescribeLunaClientCommand } from "@aws-sdk/client-cloudhsm"; // ES Modules import + * // const { CloudHSMClient, DescribeLunaClientCommand } = require("@aws-sdk/client-cloudhsm"); // CommonJS import + * const client = new CloudHSMClient(config); + * const command = new DescribeLunaClientCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeLunaClientCommandInput} for command's `input` shape. + * @see {@link DescribeLunaClientCommandOutput} for command's `response` shape. + * @see {@link CloudHSMClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeLunaClientCommand extends $Command< DescribeLunaClientCommandInput, diff --git a/clients/client-cloudhsm/commands/GetConfigCommand.ts b/clients/client-cloudhsm/commands/GetConfigCommand.ts index 2fe6fc911002..d1fbaaa5772b 100644 --- a/clients/client-cloudhsm/commands/GetConfigCommand.ts +++ b/clients/client-cloudhsm/commands/GetConfigCommand.ts @@ -30,6 +30,20 @@ export interface GetConfigCommandOutput extends GetConfigResponse, __MetadataBea * Reference.

*

Gets the configuration files necessary to connect to all high availability partition * groups the client is associated with.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { CloudHSMClient, GetConfigCommand } from "@aws-sdk/client-cloudhsm"; // ES Modules import + * // const { CloudHSMClient, GetConfigCommand } = require("@aws-sdk/client-cloudhsm"); // CommonJS import + * const client = new CloudHSMClient(config); + * const command = new GetConfigCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetConfigCommandInput} for command's `input` shape. + * @see {@link GetConfigCommandOutput} for command's `response` shape. + * @see {@link CloudHSMClientResolvedConfig | config} for command's `input` shape. + * */ export class GetConfigCommand extends $Command< GetConfigCommandInput, diff --git a/clients/client-cloudhsm/commands/ListAvailableZonesCommand.ts b/clients/client-cloudhsm/commands/ListAvailableZonesCommand.ts index 013e7b831e69..405aebafdd2a 100644 --- a/clients/client-cloudhsm/commands/ListAvailableZonesCommand.ts +++ b/clients/client-cloudhsm/commands/ListAvailableZonesCommand.ts @@ -32,6 +32,20 @@ export interface ListAvailableZonesCommandOutput extends ListAvailableZonesRespo * and the AWS CloudHSM API * Reference.

*

Lists the Availability Zones that have available AWS CloudHSM capacity.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { CloudHSMClient, ListAvailableZonesCommand } from "@aws-sdk/client-cloudhsm"; // ES Modules import + * // const { CloudHSMClient, ListAvailableZonesCommand } = require("@aws-sdk/client-cloudhsm"); // CommonJS import + * const client = new CloudHSMClient(config); + * const command = new ListAvailableZonesCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListAvailableZonesCommandInput} for command's `input` shape. + * @see {@link ListAvailableZonesCommandOutput} for command's `response` shape. + * @see {@link CloudHSMClientResolvedConfig | config} for command's `input` shape. + * */ export class ListAvailableZonesCommand extends $Command< ListAvailableZonesCommandInput, diff --git a/clients/client-cloudhsm/commands/ListHapgsCommand.ts b/clients/client-cloudhsm/commands/ListHapgsCommand.ts index 7c202a8c1202..1853275e2594 100644 --- a/clients/client-cloudhsm/commands/ListHapgsCommand.ts +++ b/clients/client-cloudhsm/commands/ListHapgsCommand.ts @@ -33,6 +33,20 @@ export interface ListHapgsCommandOutput extends ListHapgsResponse, __MetadataBea * 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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { CloudHSMClient, ListHapgsCommand } from "@aws-sdk/client-cloudhsm"; // ES Modules import + * // const { CloudHSMClient, ListHapgsCommand } = require("@aws-sdk/client-cloudhsm"); // CommonJS import + * const client = new CloudHSMClient(config); + * const command = new ListHapgsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListHapgsCommandInput} for command's `input` shape. + * @see {@link ListHapgsCommandOutput} for command's `response` shape. + * @see {@link CloudHSMClientResolvedConfig | config} for command's `input` shape. + * */ export class ListHapgsCommand extends $Command< ListHapgsCommandInput, diff --git a/clients/client-cloudhsm/commands/ListHsmsCommand.ts b/clients/client-cloudhsm/commands/ListHsmsCommand.ts index 54a8f6e08d55..de7cf5f508a9 100644 --- a/clients/client-cloudhsm/commands/ListHsmsCommand.ts +++ b/clients/client-cloudhsm/commands/ListHsmsCommand.ts @@ -34,6 +34,20 @@ export interface ListHsmsCommandOutput extends ListHsmsResponse, __MetadataBeare * 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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { CloudHSMClient, ListHsmsCommand } from "@aws-sdk/client-cloudhsm"; // ES Modules import + * // const { CloudHSMClient, ListHsmsCommand } = require("@aws-sdk/client-cloudhsm"); // CommonJS import + * const client = new CloudHSMClient(config); + * const command = new ListHsmsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListHsmsCommandInput} for command's `input` shape. + * @see {@link ListHsmsCommandOutput} for command's `response` shape. + * @see {@link CloudHSMClientResolvedConfig | config} for command's `input` shape. + * */ export class ListHsmsCommand extends $Command< ListHsmsCommandInput, diff --git a/clients/client-cloudhsm/commands/ListLunaClientsCommand.ts b/clients/client-cloudhsm/commands/ListLunaClientsCommand.ts index e479fe4b95e8..1db035cb2ec1 100644 --- a/clients/client-cloudhsm/commands/ListLunaClientsCommand.ts +++ b/clients/client-cloudhsm/commands/ListLunaClientsCommand.ts @@ -36,6 +36,20 @@ export interface ListLunaClientsCommandOutput extends ListLunaClientsResponse, _ * 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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { CloudHSMClient, ListLunaClientsCommand } from "@aws-sdk/client-cloudhsm"; // ES Modules import + * // const { CloudHSMClient, ListLunaClientsCommand } = require("@aws-sdk/client-cloudhsm"); // CommonJS import + * const client = new CloudHSMClient(config); + * const command = new ListLunaClientsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListLunaClientsCommandInput} for command's `input` shape. + * @see {@link ListLunaClientsCommandOutput} for command's `response` shape. + * @see {@link CloudHSMClientResolvedConfig | config} for command's `input` shape. + * */ export class ListLunaClientsCommand extends $Command< ListLunaClientsCommandInput, diff --git a/clients/client-cloudhsm/commands/ListTagsForResourceCommand.ts b/clients/client-cloudhsm/commands/ListTagsForResourceCommand.ts index f4a2037dbcfb..206eab315df6 100644 --- a/clients/client-cloudhsm/commands/ListTagsForResourceCommand.ts +++ b/clients/client-cloudhsm/commands/ListTagsForResourceCommand.ts @@ -32,6 +32,20 @@ export interface ListTagsForResourceCommandOutput extends ListTagsForResourceRes * and the AWS CloudHSM API * Reference.

*

Returns a list of all tags for the specified AWS CloudHSM resource.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { CloudHSMClient, ListTagsForResourceCommand } from "@aws-sdk/client-cloudhsm"; // ES Modules import + * // const { CloudHSMClient, ListTagsForResourceCommand } = require("@aws-sdk/client-cloudhsm"); // CommonJS import + * const client = new CloudHSMClient(config); + * const command = new ListTagsForResourceCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListTagsForResourceCommandInput} for command's `input` shape. + * @see {@link ListTagsForResourceCommandOutput} for command's `response` shape. + * @see {@link CloudHSMClientResolvedConfig | config} for command's `input` shape. + * */ export class ListTagsForResourceCommand extends $Command< ListTagsForResourceCommandInput, diff --git a/clients/client-cloudhsm/commands/ModifyHapgCommand.ts b/clients/client-cloudhsm/commands/ModifyHapgCommand.ts index 5cad6e6c6d02..a210cd926c50 100644 --- a/clients/client-cloudhsm/commands/ModifyHapgCommand.ts +++ b/clients/client-cloudhsm/commands/ModifyHapgCommand.ts @@ -32,6 +32,20 @@ export interface ModifyHapgCommandOutput extends ModifyHapgResponse, __MetadataB * and the AWS CloudHSM API * Reference.

*

Modifies an existing high-availability partition group.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { CloudHSMClient, ModifyHapgCommand } from "@aws-sdk/client-cloudhsm"; // ES Modules import + * // const { CloudHSMClient, ModifyHapgCommand } = require("@aws-sdk/client-cloudhsm"); // CommonJS import + * const client = new CloudHSMClient(config); + * const command = new ModifyHapgCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ModifyHapgCommandInput} for command's `input` shape. + * @see {@link ModifyHapgCommandOutput} for command's `response` shape. + * @see {@link CloudHSMClientResolvedConfig | config} for command's `input` shape. + * */ export class ModifyHapgCommand extends $Command< ModifyHapgCommandInput, diff --git a/clients/client-cloudhsm/commands/ModifyHsmCommand.ts b/clients/client-cloudhsm/commands/ModifyHsmCommand.ts index 25df296bc492..fb25eb8148c4 100644 --- a/clients/client-cloudhsm/commands/ModifyHsmCommand.ts +++ b/clients/client-cloudhsm/commands/ModifyHsmCommand.ts @@ -35,6 +35,20 @@ export interface ModifyHsmCommandOutput extends ModifyHsmResponse, __MetadataBea * that your AWS CloudHSM service is configured for high availability, and consider executing this * operation during a maintenance window.

* + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { CloudHSMClient, ModifyHsmCommand } from "@aws-sdk/client-cloudhsm"; // ES Modules import + * // const { CloudHSMClient, ModifyHsmCommand } = require("@aws-sdk/client-cloudhsm"); // CommonJS import + * const client = new CloudHSMClient(config); + * const command = new ModifyHsmCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ModifyHsmCommandInput} for command's `input` shape. + * @see {@link ModifyHsmCommandOutput} for command's `response` shape. + * @see {@link CloudHSMClientResolvedConfig | config} for command's `input` shape. + * */ export class ModifyHsmCommand extends $Command< ModifyHsmCommandInput, diff --git a/clients/client-cloudhsm/commands/ModifyLunaClientCommand.ts b/clients/client-cloudhsm/commands/ModifyLunaClientCommand.ts index 4c9c93ec31a9..2974e0908391 100644 --- a/clients/client-cloudhsm/commands/ModifyLunaClientCommand.ts +++ b/clients/client-cloudhsm/commands/ModifyLunaClientCommand.ts @@ -34,6 +34,20 @@ export interface ModifyLunaClientCommandOutput extends ModifyLunaClientResponse, *

Modifies the certificate used by the client.

*

This action can potentially start a workflow to install the new certificate on the * client's HSMs.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { CloudHSMClient, ModifyLunaClientCommand } from "@aws-sdk/client-cloudhsm"; // ES Modules import + * // const { CloudHSMClient, ModifyLunaClientCommand } = require("@aws-sdk/client-cloudhsm"); // CommonJS import + * const client = new CloudHSMClient(config); + * const command = new ModifyLunaClientCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ModifyLunaClientCommandInput} for command's `input` shape. + * @see {@link ModifyLunaClientCommandOutput} for command's `response` shape. + * @see {@link CloudHSMClientResolvedConfig | config} for command's `input` shape. + * */ export class ModifyLunaClientCommand extends $Command< ModifyLunaClientCommandInput, diff --git a/clients/client-cloudhsm/commands/RemoveTagsFromResourceCommand.ts b/clients/client-cloudhsm/commands/RemoveTagsFromResourceCommand.ts index 557674a37549..b93648743b45 100644 --- a/clients/client-cloudhsm/commands/RemoveTagsFromResourceCommand.ts +++ b/clients/client-cloudhsm/commands/RemoveTagsFromResourceCommand.ts @@ -34,6 +34,20 @@ export interface RemoveTagsFromResourceCommandOutput extends RemoveTagsFromResou *

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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { CloudHSMClient, RemoveTagsFromResourceCommand } from "@aws-sdk/client-cloudhsm"; // ES Modules import + * // const { CloudHSMClient, RemoveTagsFromResourceCommand } = require("@aws-sdk/client-cloudhsm"); // CommonJS import + * const client = new CloudHSMClient(config); + * const command = new RemoveTagsFromResourceCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link RemoveTagsFromResourceCommandInput} for command's `input` shape. + * @see {@link RemoveTagsFromResourceCommandOutput} for command's `response` shape. + * @see {@link CloudHSMClientResolvedConfig | config} for command's `input` shape. + * */ export class RemoveTagsFromResourceCommand extends $Command< RemoveTagsFromResourceCommandInput, diff --git a/clients/client-cloudhsm/models/models_0.ts b/clients/client-cloudhsm/models/models_0.ts index bf9f52cd307f..cc9942ca3da6 100644 --- a/clients/client-cloudhsm/models/models_0.ts +++ b/clients/client-cloudhsm/models/models_0.ts @@ -18,6 +18,9 @@ export interface Tag { } export namespace Tag { + /** + * @internal + */ export const filterSensitiveLog = (obj: Tag): any => ({ ...obj, }); @@ -36,6 +39,9 @@ export interface AddTagsToResourceRequest { } export namespace AddTagsToResourceRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: AddTagsToResourceRequest): any => ({ ...obj, }); @@ -49,6 +55,9 @@ export interface AddTagsToResourceResponse { } export namespace AddTagsToResourceResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: AddTagsToResourceResponse): any => ({ ...obj, }); @@ -72,6 +81,9 @@ export interface CloudHsmInternalException extends __SmithyException, $MetadataB } export namespace CloudHsmInternalException { + /** + * @internal + */ export const filterSensitiveLog = (obj: CloudHsmInternalException): any => ({ ...obj, }); @@ -95,6 +107,9 @@ export interface CloudHsmServiceException extends __SmithyException, $MetadataBe } export namespace CloudHsmServiceException { + /** + * @internal + */ export const filterSensitiveLog = (obj: CloudHsmServiceException): any => ({ ...obj, }); @@ -118,6 +133,9 @@ export interface InvalidRequestException extends __SmithyException, $MetadataBea } export namespace InvalidRequestException { + /** + * @internal + */ export const filterSensitiveLog = (obj: InvalidRequestException): any => ({ ...obj, }); @@ -139,6 +157,9 @@ export interface CreateHapgRequest { } export namespace CreateHapgRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateHapgRequest): any => ({ ...obj, }); @@ -155,6 +176,9 @@ export interface CreateHapgResponse { } export namespace CreateHapgResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateHapgResponse): any => ({ ...obj, }); @@ -227,6 +251,9 @@ export interface CreateHsmRequest { } export namespace CreateHsmRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateHsmRequest): any => ({ ...obj, }); @@ -243,6 +270,9 @@ export interface CreateHsmResponse { } export namespace CreateHsmResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateHsmResponse): any => ({ ...obj, }); @@ -265,6 +295,9 @@ export interface CreateLunaClientRequest { } export namespace CreateLunaClientRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateLunaClientRequest): any => ({ ...obj, }); @@ -281,6 +314,9 @@ export interface CreateLunaClientResponse { } export namespace CreateLunaClientResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateLunaClientResponse): any => ({ ...obj, }); @@ -297,6 +333,9 @@ export interface DeleteHapgRequest { } export namespace DeleteHapgRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteHapgRequest): any => ({ ...obj, }); @@ -313,6 +352,9 @@ export interface DeleteHapgResponse { } export namespace DeleteHapgResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteHapgResponse): any => ({ ...obj, }); @@ -329,6 +371,9 @@ export interface DeleteHsmRequest { } export namespace DeleteHsmRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteHsmRequest): any => ({ ...obj, }); @@ -345,6 +390,9 @@ export interface DeleteHsmResponse { } export namespace DeleteHsmResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteHsmResponse): any => ({ ...obj, }); @@ -358,6 +406,9 @@ export interface DeleteLunaClientRequest { } export namespace DeleteLunaClientRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteLunaClientRequest): any => ({ ...obj, }); @@ -371,6 +422,9 @@ export interface DeleteLunaClientResponse { } export namespace DeleteLunaClientResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteLunaClientResponse): any => ({ ...obj, }); @@ -387,6 +441,9 @@ export interface DescribeHapgRequest { } export namespace DescribeHapgRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeHapgRequest): any => ({ ...obj, }); @@ -450,6 +507,9 @@ export interface DescribeHapgResponse { } export namespace DescribeHapgResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeHapgResponse): any => ({ ...obj, }); @@ -473,6 +533,9 @@ export interface DescribeHsmRequest { } export namespace DescribeHsmRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeHsmRequest): any => ({ ...obj, }); @@ -611,6 +674,9 @@ export interface DescribeHsmResponse { } export namespace DescribeHsmResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeHsmResponse): any => ({ ...obj, }); @@ -629,6 +695,9 @@ export interface DescribeLunaClientRequest { } export namespace DescribeLunaClientRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeLunaClientRequest): any => ({ ...obj, }); @@ -662,6 +731,9 @@ export interface DescribeLunaClientResponse { } export namespace DescribeLunaClientResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeLunaClientResponse): any => ({ ...obj, }); @@ -686,6 +758,9 @@ export interface GetConfigRequest { } export namespace GetConfigRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetConfigRequest): any => ({ ...obj, }); @@ -709,6 +784,9 @@ export interface GetConfigResponse { } export namespace GetConfigResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetConfigResponse): any => ({ ...obj, }); @@ -720,6 +798,9 @@ export namespace GetConfigResponse { export interface ListAvailableZonesRequest {} export namespace ListAvailableZonesRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListAvailableZonesRequest): any => ({ ...obj, }); @@ -733,6 +814,9 @@ export interface ListAvailableZonesResponse { } export namespace ListAvailableZonesResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListAvailableZonesResponse): any => ({ ...obj, }); @@ -747,6 +831,9 @@ export interface ListHapgsRequest { } export namespace ListHapgsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListHapgsRequest): any => ({ ...obj, }); @@ -766,6 +853,9 @@ export interface ListHapgsResponse { } export namespace ListHapgsResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListHapgsResponse): any => ({ ...obj, }); @@ -780,6 +870,9 @@ export interface ListHsmsRequest { } export namespace ListHsmsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListHsmsRequest): any => ({ ...obj, }); @@ -802,6 +895,9 @@ export interface ListHsmsResponse { } export namespace ListHsmsResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListHsmsResponse): any => ({ ...obj, }); @@ -816,6 +912,9 @@ export interface ListLunaClientsRequest { } export namespace ListLunaClientsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListLunaClientsRequest): any => ({ ...obj, }); @@ -835,6 +934,9 @@ export interface ListLunaClientsResponse { } export namespace ListLunaClientsResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListLunaClientsResponse): any => ({ ...obj, }); @@ -848,6 +950,9 @@ export interface ListTagsForResourceRequest { } export namespace ListTagsForResourceRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListTagsForResourceRequest): any => ({ ...obj, }); @@ -861,6 +966,9 @@ export interface ListTagsForResourceResponse { } export namespace ListTagsForResourceResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListTagsForResourceResponse): any => ({ ...obj, }); @@ -885,6 +993,9 @@ export interface ModifyHapgRequest { } export namespace ModifyHapgRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ModifyHapgRequest): any => ({ ...obj, }); @@ -898,6 +1009,9 @@ export interface ModifyHapgResponse { } export namespace ModifyHapgResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ModifyHapgResponse): any => ({ ...obj, }); @@ -944,6 +1058,9 @@ export interface ModifyHsmRequest { } export namespace ModifyHsmRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ModifyHsmRequest): any => ({ ...obj, }); @@ -960,6 +1077,9 @@ export interface ModifyHsmResponse { } export namespace ModifyHsmResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ModifyHsmResponse): any => ({ ...obj, }); @@ -978,6 +1098,9 @@ export interface ModifyLunaClientRequest { } export namespace ModifyLunaClientRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ModifyLunaClientRequest): any => ({ ...obj, }); @@ -991,6 +1114,9 @@ export interface ModifyLunaClientResponse { } export namespace ModifyLunaClientResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ModifyLunaClientResponse): any => ({ ...obj, }); @@ -1011,6 +1137,9 @@ export interface RemoveTagsFromResourceRequest { } export namespace RemoveTagsFromResourceRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: RemoveTagsFromResourceRequest): any => ({ ...obj, }); @@ -1024,6 +1153,9 @@ export interface RemoveTagsFromResourceResponse { } export namespace RemoveTagsFromResourceResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: RemoveTagsFromResourceResponse): any => ({ ...obj, }); diff --git a/clients/client-cloudsearch-domain/commands/SearchCommand.ts b/clients/client-cloudsearch-domain/commands/SearchCommand.ts index b5aafa15ff3e..6c2eb96b6427 100644 --- a/clients/client-cloudsearch-domain/commands/SearchCommand.ts +++ b/clients/client-cloudsearch-domain/commands/SearchCommand.ts @@ -31,6 +31,20 @@ export interface SearchCommandOutput extends SearchResponse, __MetadataBearer {} * *

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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { CloudSearchDomainClient, SearchCommand } from "@aws-sdk/client-cloudsearch-domain"; // ES Modules import + * // const { CloudSearchDomainClient, SearchCommand } = require("@aws-sdk/client-cloudsearch-domain"); // CommonJS import + * const client = new CloudSearchDomainClient(config); + * const command = new SearchCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link SearchCommandInput} for command's `input` shape. + * @see {@link SearchCommandOutput} for command's `response` shape. + * @see {@link CloudSearchDomainClientResolvedConfig | config} for command's `input` shape. + * */ export class SearchCommand extends $Command< SearchCommandInput, diff --git a/clients/client-cloudsearch-domain/commands/SuggestCommand.ts b/clients/client-cloudsearch-domain/commands/SuggestCommand.ts index b20c6d1cda5f..849ea31332aa 100644 --- a/clients/client-cloudsearch-domain/commands/SuggestCommand.ts +++ b/clients/client-cloudsearch-domain/commands/SuggestCommand.ts @@ -29,6 +29,20 @@ export interface SuggestCommandOutput extends SuggestResponse, __MetadataBearer *

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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { CloudSearchDomainClient, SuggestCommand } from "@aws-sdk/client-cloudsearch-domain"; // ES Modules import + * // const { CloudSearchDomainClient, SuggestCommand } = require("@aws-sdk/client-cloudsearch-domain"); // CommonJS import + * const client = new CloudSearchDomainClient(config); + * const command = new SuggestCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link SuggestCommandInput} for command's `input` shape. + * @see {@link SuggestCommandOutput} for command's `response` shape. + * @see {@link CloudSearchDomainClientResolvedConfig | config} for command's `input` shape. + * */ export class SuggestCommand extends $Command< SuggestCommandInput, diff --git a/clients/client-cloudsearch-domain/commands/UploadDocumentsCommand.ts b/clients/client-cloudsearch-domain/commands/UploadDocumentsCommand.ts index 3ac4fd88d70f..59a034938ed0 100644 --- a/clients/client-cloudsearch-domain/commands/UploadDocumentsCommand.ts +++ b/clients/client-cloudsearch-domain/commands/UploadDocumentsCommand.ts @@ -38,6 +38,20 @@ export interface UploadDocumentsCommandOutput extends UploadDocumentsResponse, _ *

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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { CloudSearchDomainClient, UploadDocumentsCommand } from "@aws-sdk/client-cloudsearch-domain"; // ES Modules import + * // const { CloudSearchDomainClient, UploadDocumentsCommand } = require("@aws-sdk/client-cloudsearch-domain"); // CommonJS import + * const client = new CloudSearchDomainClient(config); + * const command = new UploadDocumentsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link UploadDocumentsCommandInput} for command's `input` shape. + * @see {@link UploadDocumentsCommandOutput} for command's `response` shape. + * @see {@link CloudSearchDomainClientResolvedConfig | config} for command's `input` shape. + * */ export class UploadDocumentsCommand extends $Command< UploadDocumentsCommandInput, diff --git a/clients/client-cloudsearch-domain/models/models_0.ts b/clients/client-cloudsearch-domain/models/models_0.ts index be32bb0a6c7b..afcdfbf1dfba 100644 --- a/clients/client-cloudsearch-domain/models/models_0.ts +++ b/clients/client-cloudsearch-domain/models/models_0.ts @@ -15,6 +15,9 @@ export interface SearchException extends __SmithyException, $MetadataBearer { } export namespace SearchException { + /** + * @internal + */ export const filterSensitiveLog = (obj: SearchException): any => ({ ...obj, }); @@ -309,6 +312,9 @@ export interface SearchRequest { } export namespace SearchRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: SearchRequest): any => ({ ...obj, }); @@ -330,6 +336,9 @@ export interface Bucket { } export namespace Bucket { + /** + * @internal + */ export const filterSensitiveLog = (obj: Bucket): any => ({ ...obj, }); @@ -346,6 +355,9 @@ export interface BucketInfo { } export namespace BucketInfo { + /** + * @internal + */ export const filterSensitiveLog = (obj: BucketInfo): any => ({ ...obj, }); @@ -377,6 +389,9 @@ export interface Hit { } export namespace Hit { + /** + * @internal + */ export const filterSensitiveLog = (obj: Hit): any => ({ ...obj, }); @@ -408,6 +423,9 @@ export interface Hits { } export namespace Hits { + /** + * @internal + */ export const filterSensitiveLog = (obj: Hits): any => ({ ...obj, }); @@ -462,6 +480,9 @@ export interface FieldStats { } export namespace FieldStats { + /** + * @internal + */ export const filterSensitiveLog = (obj: FieldStats): any => ({ ...obj, }); @@ -483,6 +504,9 @@ export interface SearchStatus { } export namespace SearchStatus { + /** + * @internal + */ export const filterSensitiveLog = (obj: SearchStatus): any => ({ ...obj, }); @@ -514,6 +538,9 @@ export interface SearchResponse { } export namespace SearchResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: SearchResponse): any => ({ ...obj, }); @@ -540,6 +567,9 @@ export interface SuggestRequest { } export namespace SuggestRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: SuggestRequest): any => ({ ...obj, }); @@ -561,6 +591,9 @@ export interface SuggestStatus { } export namespace SuggestStatus { + /** + * @internal + */ export const filterSensitiveLog = (obj: SuggestStatus): any => ({ ...obj, }); @@ -587,6 +620,9 @@ export interface SuggestionMatch { } export namespace SuggestionMatch { + /** + * @internal + */ export const filterSensitiveLog = (obj: SuggestionMatch): any => ({ ...obj, }); @@ -613,6 +649,9 @@ export interface SuggestModel { } export namespace SuggestModel { + /** + * @internal + */ export const filterSensitiveLog = (obj: SuggestModel): any => ({ ...obj, }); @@ -634,6 +673,9 @@ export interface SuggestResponse { } export namespace SuggestResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: SuggestResponse): any => ({ ...obj, }); @@ -657,6 +699,9 @@ export interface DocumentServiceException extends __SmithyException, $MetadataBe } export namespace DocumentServiceException { + /** + * @internal + */ export const filterSensitiveLog = (obj: DocumentServiceException): any => ({ ...obj, }); @@ -684,6 +729,9 @@ export interface UploadDocumentsRequest { } export namespace UploadDocumentsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: UploadDocumentsRequest): any => ({ ...obj, }); @@ -700,6 +748,9 @@ export interface DocumentServiceWarning { } export namespace DocumentServiceWarning { + /** + * @internal + */ export const filterSensitiveLog = (obj: DocumentServiceWarning): any => ({ ...obj, }); @@ -731,6 +782,9 @@ export interface UploadDocumentsResponse { } export namespace UploadDocumentsResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: UploadDocumentsResponse): any => ({ ...obj, }); diff --git a/clients/client-cloudsearch/commands/BuildSuggestersCommand.ts b/clients/client-cloudsearch/commands/BuildSuggestersCommand.ts index 759bacefc92d..62776fac0733 100644 --- a/clients/client-cloudsearch/commands/BuildSuggestersCommand.ts +++ b/clients/client-cloudsearch/commands/BuildSuggestersCommand.ts @@ -22,6 +22,20 @@ export interface BuildSuggestersCommandOutput extends BuildSuggestersResponse, _ /** *

Indexes the search suggestions. For more information, see Configuring Suggesters in the Amazon CloudSearch Developer Guide.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { CloudSearchClient, BuildSuggestersCommand } from "@aws-sdk/client-cloudsearch"; // ES Modules import + * // const { CloudSearchClient, BuildSuggestersCommand } = require("@aws-sdk/client-cloudsearch"); // CommonJS import + * const client = new CloudSearchClient(config); + * const command = new BuildSuggestersCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link BuildSuggestersCommandInput} for command's `input` shape. + * @see {@link BuildSuggestersCommandOutput} for command's `response` shape. + * @see {@link CloudSearchClientResolvedConfig | config} for command's `input` shape. + * */ export class BuildSuggestersCommand extends $Command< BuildSuggestersCommandInput, diff --git a/clients/client-cloudsearch/commands/CreateDomainCommand.ts b/clients/client-cloudsearch/commands/CreateDomainCommand.ts index 8b6140f5b278..2bf8c2bec507 100644 --- a/clients/client-cloudsearch/commands/CreateDomainCommand.ts +++ b/clients/client-cloudsearch/commands/CreateDomainCommand.ts @@ -20,6 +20,20 @@ export interface CreateDomainCommandOutput extends CreateDomainResponse, __Metad /** *

Creates a new search domain. For more information, * see Creating a Search Domain in the Amazon CloudSearch Developer Guide.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { CloudSearchClient, CreateDomainCommand } from "@aws-sdk/client-cloudsearch"; // ES Modules import + * // const { CloudSearchClient, CreateDomainCommand } = require("@aws-sdk/client-cloudsearch"); // CommonJS import + * const client = new CloudSearchClient(config); + * const command = new CreateDomainCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreateDomainCommandInput} for command's `input` shape. + * @see {@link CreateDomainCommandOutput} for command's `response` shape. + * @see {@link CloudSearchClientResolvedConfig | config} for command's `input` shape. + * */ export class CreateDomainCommand extends $Command< CreateDomainCommandInput, diff --git a/clients/client-cloudsearch/commands/DefineAnalysisSchemeCommand.ts b/clients/client-cloudsearch/commands/DefineAnalysisSchemeCommand.ts index c89aca742b20..b690ec7d0b81 100644 --- a/clients/client-cloudsearch/commands/DefineAnalysisSchemeCommand.ts +++ b/clients/client-cloudsearch/commands/DefineAnalysisSchemeCommand.ts @@ -22,6 +22,20 @@ export interface DefineAnalysisSchemeCommandOutput extends DefineAnalysisSchemeR /** *

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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { CloudSearchClient, DefineAnalysisSchemeCommand } from "@aws-sdk/client-cloudsearch"; // ES Modules import + * // const { CloudSearchClient, DefineAnalysisSchemeCommand } = require("@aws-sdk/client-cloudsearch"); // CommonJS import + * const client = new CloudSearchClient(config); + * const command = new DefineAnalysisSchemeCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DefineAnalysisSchemeCommandInput} for command's `input` shape. + * @see {@link DefineAnalysisSchemeCommandOutput} for command's `response` shape. + * @see {@link CloudSearchClientResolvedConfig | config} for command's `input` shape. + * */ export class DefineAnalysisSchemeCommand extends $Command< DefineAnalysisSchemeCommandInput, diff --git a/clients/client-cloudsearch/commands/DefineExpressionCommand.ts b/clients/client-cloudsearch/commands/DefineExpressionCommand.ts index 44773161c8a3..31d007b46842 100644 --- a/clients/client-cloudsearch/commands/DefineExpressionCommand.ts +++ b/clients/client-cloudsearch/commands/DefineExpressionCommand.ts @@ -22,6 +22,20 @@ export interface DefineExpressionCommandOutput extends DefineExpressionResponse, /** *

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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { CloudSearchClient, DefineExpressionCommand } from "@aws-sdk/client-cloudsearch"; // ES Modules import + * // const { CloudSearchClient, DefineExpressionCommand } = require("@aws-sdk/client-cloudsearch"); // CommonJS import + * const client = new CloudSearchClient(config); + * const command = new DefineExpressionCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DefineExpressionCommandInput} for command's `input` shape. + * @see {@link DefineExpressionCommandOutput} for command's `response` shape. + * @see {@link CloudSearchClientResolvedConfig | config} for command's `input` shape. + * */ export class DefineExpressionCommand extends $Command< DefineExpressionCommandInput, diff --git a/clients/client-cloudsearch/commands/DefineIndexFieldCommand.ts b/clients/client-cloudsearch/commands/DefineIndexFieldCommand.ts index 0914be74e148..91b59d1f01c5 100644 --- a/clients/client-cloudsearch/commands/DefineIndexFieldCommand.ts +++ b/clients/client-cloudsearch/commands/DefineIndexFieldCommand.ts @@ -22,6 +22,20 @@ export interface DefineIndexFieldCommandOutput extends DefineIndexFieldResponse, /** *

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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { CloudSearchClient, DefineIndexFieldCommand } from "@aws-sdk/client-cloudsearch"; // ES Modules import + * // const { CloudSearchClient, DefineIndexFieldCommand } = require("@aws-sdk/client-cloudsearch"); // CommonJS import + * const client = new CloudSearchClient(config); + * const command = new DefineIndexFieldCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DefineIndexFieldCommandInput} for command's `input` shape. + * @see {@link DefineIndexFieldCommandOutput} for command's `response` shape. + * @see {@link CloudSearchClientResolvedConfig | config} for command's `input` shape. + * */ export class DefineIndexFieldCommand extends $Command< DefineIndexFieldCommandInput, diff --git a/clients/client-cloudsearch/commands/DefineSuggesterCommand.ts b/clients/client-cloudsearch/commands/DefineSuggesterCommand.ts index ce6a4ec451f8..e6617cd8777a 100644 --- a/clients/client-cloudsearch/commands/DefineSuggesterCommand.ts +++ b/clients/client-cloudsearch/commands/DefineSuggesterCommand.ts @@ -22,6 +22,20 @@ export interface DefineSuggesterCommandOutput extends DefineSuggesterResponse, _ /** *

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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { CloudSearchClient, DefineSuggesterCommand } from "@aws-sdk/client-cloudsearch"; // ES Modules import + * // const { CloudSearchClient, DefineSuggesterCommand } = require("@aws-sdk/client-cloudsearch"); // CommonJS import + * const client = new CloudSearchClient(config); + * const command = new DefineSuggesterCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DefineSuggesterCommandInput} for command's `input` shape. + * @see {@link DefineSuggesterCommandOutput} for command's `response` shape. + * @see {@link CloudSearchClientResolvedConfig | config} for command's `input` shape. + * */ export class DefineSuggesterCommand extends $Command< DefineSuggesterCommandInput, diff --git a/clients/client-cloudsearch/commands/DeleteAnalysisSchemeCommand.ts b/clients/client-cloudsearch/commands/DeleteAnalysisSchemeCommand.ts index e7854e865850..a141b2700a21 100644 --- a/clients/client-cloudsearch/commands/DeleteAnalysisSchemeCommand.ts +++ b/clients/client-cloudsearch/commands/DeleteAnalysisSchemeCommand.ts @@ -22,6 +22,20 @@ export interface DeleteAnalysisSchemeCommandOutput extends DeleteAnalysisSchemeR /** *

Deletes an analysis scheme. For more information, see Configuring Analysis Schemes in the Amazon CloudSearch Developer Guide.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { CloudSearchClient, DeleteAnalysisSchemeCommand } from "@aws-sdk/client-cloudsearch"; // ES Modules import + * // const { CloudSearchClient, DeleteAnalysisSchemeCommand } = require("@aws-sdk/client-cloudsearch"); // CommonJS import + * const client = new CloudSearchClient(config); + * const command = new DeleteAnalysisSchemeCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteAnalysisSchemeCommandInput} for command's `input` shape. + * @see {@link DeleteAnalysisSchemeCommandOutput} for command's `response` shape. + * @see {@link CloudSearchClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteAnalysisSchemeCommand extends $Command< DeleteAnalysisSchemeCommandInput, diff --git a/clients/client-cloudsearch/commands/DeleteDomainCommand.ts b/clients/client-cloudsearch/commands/DeleteDomainCommand.ts index 807059b87529..62f49090a6e0 100644 --- a/clients/client-cloudsearch/commands/DeleteDomainCommand.ts +++ b/clients/client-cloudsearch/commands/DeleteDomainCommand.ts @@ -20,6 +20,20 @@ export interface DeleteDomainCommandOutput extends DeleteDomainResponse, __Metad /** *

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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { CloudSearchClient, DeleteDomainCommand } from "@aws-sdk/client-cloudsearch"; // ES Modules import + * // const { CloudSearchClient, DeleteDomainCommand } = require("@aws-sdk/client-cloudsearch"); // CommonJS import + * const client = new CloudSearchClient(config); + * const command = new DeleteDomainCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteDomainCommandInput} for command's `input` shape. + * @see {@link DeleteDomainCommandOutput} for command's `response` shape. + * @see {@link CloudSearchClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteDomainCommand extends $Command< DeleteDomainCommandInput, diff --git a/clients/client-cloudsearch/commands/DeleteExpressionCommand.ts b/clients/client-cloudsearch/commands/DeleteExpressionCommand.ts index 86d37714236b..22ef0c42b947 100644 --- a/clients/client-cloudsearch/commands/DeleteExpressionCommand.ts +++ b/clients/client-cloudsearch/commands/DeleteExpressionCommand.ts @@ -22,6 +22,20 @@ export interface DeleteExpressionCommandOutput extends DeleteExpressionResponse, /** *

Removes an Expression from the search domain. For more information, see Configuring Expressions in the Amazon CloudSearch Developer Guide.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { CloudSearchClient, DeleteExpressionCommand } from "@aws-sdk/client-cloudsearch"; // ES Modules import + * // const { CloudSearchClient, DeleteExpressionCommand } = require("@aws-sdk/client-cloudsearch"); // CommonJS import + * const client = new CloudSearchClient(config); + * const command = new DeleteExpressionCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteExpressionCommandInput} for command's `input` shape. + * @see {@link DeleteExpressionCommandOutput} for command's `response` shape. + * @see {@link CloudSearchClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteExpressionCommand extends $Command< DeleteExpressionCommandInput, diff --git a/clients/client-cloudsearch/commands/DeleteIndexFieldCommand.ts b/clients/client-cloudsearch/commands/DeleteIndexFieldCommand.ts index 1f46a5f79000..270ea2112282 100644 --- a/clients/client-cloudsearch/commands/DeleteIndexFieldCommand.ts +++ b/clients/client-cloudsearch/commands/DeleteIndexFieldCommand.ts @@ -22,6 +22,20 @@ export interface DeleteIndexFieldCommandOutput extends DeleteIndexFieldResponse, /** *

Removes an IndexField from the search domain. For more information, see Configuring Index Fields in the Amazon CloudSearch Developer Guide.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { CloudSearchClient, DeleteIndexFieldCommand } from "@aws-sdk/client-cloudsearch"; // ES Modules import + * // const { CloudSearchClient, DeleteIndexFieldCommand } = require("@aws-sdk/client-cloudsearch"); // CommonJS import + * const client = new CloudSearchClient(config); + * const command = new DeleteIndexFieldCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteIndexFieldCommandInput} for command's `input` shape. + * @see {@link DeleteIndexFieldCommandOutput} for command's `response` shape. + * @see {@link CloudSearchClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteIndexFieldCommand extends $Command< DeleteIndexFieldCommandInput, diff --git a/clients/client-cloudsearch/commands/DeleteSuggesterCommand.ts b/clients/client-cloudsearch/commands/DeleteSuggesterCommand.ts index 04e1b8959bc1..1eb899643460 100644 --- a/clients/client-cloudsearch/commands/DeleteSuggesterCommand.ts +++ b/clients/client-cloudsearch/commands/DeleteSuggesterCommand.ts @@ -22,6 +22,20 @@ export interface DeleteSuggesterCommandOutput extends DeleteSuggesterResponse, _ /** *

Deletes a suggester. For more information, see Getting Search Suggestions in the Amazon CloudSearch Developer Guide.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { CloudSearchClient, DeleteSuggesterCommand } from "@aws-sdk/client-cloudsearch"; // ES Modules import + * // const { CloudSearchClient, DeleteSuggesterCommand } = require("@aws-sdk/client-cloudsearch"); // CommonJS import + * const client = new CloudSearchClient(config); + * const command = new DeleteSuggesterCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteSuggesterCommandInput} for command's `input` shape. + * @see {@link DeleteSuggesterCommandOutput} for command's `response` shape. + * @see {@link CloudSearchClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteSuggesterCommand extends $Command< DeleteSuggesterCommandInput, diff --git a/clients/client-cloudsearch/commands/DescribeAnalysisSchemesCommand.ts b/clients/client-cloudsearch/commands/DescribeAnalysisSchemesCommand.ts index d4bfffe18bfd..850f47700ea3 100644 --- a/clients/client-cloudsearch/commands/DescribeAnalysisSchemesCommand.ts +++ b/clients/client-cloudsearch/commands/DescribeAnalysisSchemesCommand.ts @@ -22,6 +22,20 @@ export interface DescribeAnalysisSchemesCommandOutput extends DescribeAnalysisSc /** *

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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { CloudSearchClient, DescribeAnalysisSchemesCommand } from "@aws-sdk/client-cloudsearch"; // ES Modules import + * // const { CloudSearchClient, DescribeAnalysisSchemesCommand } = require("@aws-sdk/client-cloudsearch"); // CommonJS import + * const client = new CloudSearchClient(config); + * const command = new DescribeAnalysisSchemesCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeAnalysisSchemesCommandInput} for command's `input` shape. + * @see {@link DescribeAnalysisSchemesCommandOutput} for command's `response` shape. + * @see {@link CloudSearchClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeAnalysisSchemesCommand extends $Command< DescribeAnalysisSchemesCommandInput, diff --git a/clients/client-cloudsearch/commands/DescribeAvailabilityOptionsCommand.ts b/clients/client-cloudsearch/commands/DescribeAvailabilityOptionsCommand.ts index 321ee15e22bb..c7c95e9e4a4b 100644 --- a/clients/client-cloudsearch/commands/DescribeAvailabilityOptionsCommand.ts +++ b/clients/client-cloudsearch/commands/DescribeAvailabilityOptionsCommand.ts @@ -24,6 +24,20 @@ export interface DescribeAvailabilityOptionsCommandOutput /** *

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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { CloudSearchClient, DescribeAvailabilityOptionsCommand } from "@aws-sdk/client-cloudsearch"; // ES Modules import + * // const { CloudSearchClient, DescribeAvailabilityOptionsCommand } = require("@aws-sdk/client-cloudsearch"); // CommonJS import + * const client = new CloudSearchClient(config); + * const command = new DescribeAvailabilityOptionsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeAvailabilityOptionsCommandInput} for command's `input` shape. + * @see {@link DescribeAvailabilityOptionsCommandOutput} for command's `response` shape. + * @see {@link CloudSearchClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeAvailabilityOptionsCommand extends $Command< DescribeAvailabilityOptionsCommandInput, diff --git a/clients/client-cloudsearch/commands/DescribeDomainEndpointOptionsCommand.ts b/clients/client-cloudsearch/commands/DescribeDomainEndpointOptionsCommand.ts index 8d7c1595f625..8f0d880609a4 100644 --- a/clients/client-cloudsearch/commands/DescribeDomainEndpointOptionsCommand.ts +++ b/clients/client-cloudsearch/commands/DescribeDomainEndpointOptionsCommand.ts @@ -24,6 +24,20 @@ export interface DescribeDomainEndpointOptionsCommandOutput /** *

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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { CloudSearchClient, DescribeDomainEndpointOptionsCommand } from "@aws-sdk/client-cloudsearch"; // ES Modules import + * // const { CloudSearchClient, DescribeDomainEndpointOptionsCommand } = require("@aws-sdk/client-cloudsearch"); // CommonJS import + * const client = new CloudSearchClient(config); + * const command = new DescribeDomainEndpointOptionsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeDomainEndpointOptionsCommandInput} for command's `input` shape. + * @see {@link DescribeDomainEndpointOptionsCommandOutput} for command's `response` shape. + * @see {@link CloudSearchClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeDomainEndpointOptionsCommand extends $Command< DescribeDomainEndpointOptionsCommandInput, diff --git a/clients/client-cloudsearch/commands/DescribeDomainsCommand.ts b/clients/client-cloudsearch/commands/DescribeDomainsCommand.ts index 53e75d7f2366..b20581289849 100644 --- a/clients/client-cloudsearch/commands/DescribeDomainsCommand.ts +++ b/clients/client-cloudsearch/commands/DescribeDomainsCommand.ts @@ -24,6 +24,20 @@ export interface DescribeDomainsCommandOutput extends DescribeDomainsResponse, _ *

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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { CloudSearchClient, DescribeDomainsCommand } from "@aws-sdk/client-cloudsearch"; // ES Modules import + * // const { CloudSearchClient, DescribeDomainsCommand } = require("@aws-sdk/client-cloudsearch"); // CommonJS import + * const client = new CloudSearchClient(config); + * const command = new DescribeDomainsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeDomainsCommandInput} for command's `input` shape. + * @see {@link DescribeDomainsCommandOutput} for command's `response` shape. + * @see {@link CloudSearchClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeDomainsCommand extends $Command< DescribeDomainsCommandInput, diff --git a/clients/client-cloudsearch/commands/DescribeExpressionsCommand.ts b/clients/client-cloudsearch/commands/DescribeExpressionsCommand.ts index c3544e45a95e..65cbef3c45b1 100644 --- a/clients/client-cloudsearch/commands/DescribeExpressionsCommand.ts +++ b/clients/client-cloudsearch/commands/DescribeExpressionsCommand.ts @@ -22,6 +22,20 @@ export interface DescribeExpressionsCommandOutput extends DescribeExpressionsRes /** *

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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { CloudSearchClient, DescribeExpressionsCommand } from "@aws-sdk/client-cloudsearch"; // ES Modules import + * // const { CloudSearchClient, DescribeExpressionsCommand } = require("@aws-sdk/client-cloudsearch"); // CommonJS import + * const client = new CloudSearchClient(config); + * const command = new DescribeExpressionsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeExpressionsCommandInput} for command's `input` shape. + * @see {@link DescribeExpressionsCommandOutput} for command's `response` shape. + * @see {@link CloudSearchClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeExpressionsCommand extends $Command< DescribeExpressionsCommandInput, diff --git a/clients/client-cloudsearch/commands/DescribeIndexFieldsCommand.ts b/clients/client-cloudsearch/commands/DescribeIndexFieldsCommand.ts index 65828f03f5cc..c22a5eecbb95 100644 --- a/clients/client-cloudsearch/commands/DescribeIndexFieldsCommand.ts +++ b/clients/client-cloudsearch/commands/DescribeIndexFieldsCommand.ts @@ -24,6 +24,20 @@ export interface DescribeIndexFieldsCommandOutput extends DescribeIndexFieldsRes *

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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { CloudSearchClient, DescribeIndexFieldsCommand } from "@aws-sdk/client-cloudsearch"; // ES Modules import + * // const { CloudSearchClient, DescribeIndexFieldsCommand } = require("@aws-sdk/client-cloudsearch"); // CommonJS import + * const client = new CloudSearchClient(config); + * const command = new DescribeIndexFieldsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeIndexFieldsCommandInput} for command's `input` shape. + * @see {@link DescribeIndexFieldsCommandOutput} for command's `response` shape. + * @see {@link CloudSearchClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeIndexFieldsCommand extends $Command< DescribeIndexFieldsCommandInput, diff --git a/clients/client-cloudsearch/commands/DescribeScalingParametersCommand.ts b/clients/client-cloudsearch/commands/DescribeScalingParametersCommand.ts index 2c877ba231a4..65f064c1a239 100644 --- a/clients/client-cloudsearch/commands/DescribeScalingParametersCommand.ts +++ b/clients/client-cloudsearch/commands/DescribeScalingParametersCommand.ts @@ -22,6 +22,20 @@ export interface DescribeScalingParametersCommandOutput extends DescribeScalingP /** *

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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { CloudSearchClient, DescribeScalingParametersCommand } from "@aws-sdk/client-cloudsearch"; // ES Modules import + * // const { CloudSearchClient, DescribeScalingParametersCommand } = require("@aws-sdk/client-cloudsearch"); // CommonJS import + * const client = new CloudSearchClient(config); + * const command = new DescribeScalingParametersCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeScalingParametersCommandInput} for command's `input` shape. + * @see {@link DescribeScalingParametersCommandOutput} for command's `response` shape. + * @see {@link CloudSearchClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeScalingParametersCommand extends $Command< DescribeScalingParametersCommandInput, diff --git a/clients/client-cloudsearch/commands/DescribeServiceAccessPoliciesCommand.ts b/clients/client-cloudsearch/commands/DescribeServiceAccessPoliciesCommand.ts index 2184ccff50f2..db6304cafb49 100644 --- a/clients/client-cloudsearch/commands/DescribeServiceAccessPoliciesCommand.ts +++ b/clients/client-cloudsearch/commands/DescribeServiceAccessPoliciesCommand.ts @@ -25,6 +25,20 @@ export interface DescribeServiceAccessPoliciesCommandOutput /** *

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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { CloudSearchClient, DescribeServiceAccessPoliciesCommand } from "@aws-sdk/client-cloudsearch"; // ES Modules import + * // const { CloudSearchClient, DescribeServiceAccessPoliciesCommand } = require("@aws-sdk/client-cloudsearch"); // CommonJS import + * const client = new CloudSearchClient(config); + * const command = new DescribeServiceAccessPoliciesCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeServiceAccessPoliciesCommandInput} for command's `input` shape. + * @see {@link DescribeServiceAccessPoliciesCommandOutput} for command's `response` shape. + * @see {@link CloudSearchClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeServiceAccessPoliciesCommand extends $Command< DescribeServiceAccessPoliciesCommandInput, diff --git a/clients/client-cloudsearch/commands/DescribeSuggestersCommand.ts b/clients/client-cloudsearch/commands/DescribeSuggestersCommand.ts index 76f9a477287d..1a34ac962858 100644 --- a/clients/client-cloudsearch/commands/DescribeSuggestersCommand.ts +++ b/clients/client-cloudsearch/commands/DescribeSuggestersCommand.ts @@ -22,6 +22,20 @@ export interface DescribeSuggestersCommandOutput extends DescribeSuggestersRespo /** *

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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { CloudSearchClient, DescribeSuggestersCommand } from "@aws-sdk/client-cloudsearch"; // ES Modules import + * // const { CloudSearchClient, DescribeSuggestersCommand } = require("@aws-sdk/client-cloudsearch"); // CommonJS import + * const client = new CloudSearchClient(config); + * const command = new DescribeSuggestersCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeSuggestersCommandInput} for command's `input` shape. + * @see {@link DescribeSuggestersCommandOutput} for command's `response` shape. + * @see {@link CloudSearchClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeSuggestersCommand extends $Command< DescribeSuggestersCommandInput, diff --git a/clients/client-cloudsearch/commands/IndexDocumentsCommand.ts b/clients/client-cloudsearch/commands/IndexDocumentsCommand.ts index d206da2e9e0c..4de579ac2e56 100644 --- a/clients/client-cloudsearch/commands/IndexDocumentsCommand.ts +++ b/clients/client-cloudsearch/commands/IndexDocumentsCommand.ts @@ -22,6 +22,20 @@ export interface IndexDocumentsCommandOutput extends IndexDocumentsResponse, __M /** *

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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { CloudSearchClient, IndexDocumentsCommand } from "@aws-sdk/client-cloudsearch"; // ES Modules import + * // const { CloudSearchClient, IndexDocumentsCommand } = require("@aws-sdk/client-cloudsearch"); // CommonJS import + * const client = new CloudSearchClient(config); + * const command = new IndexDocumentsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link IndexDocumentsCommandInput} for command's `input` shape. + * @see {@link IndexDocumentsCommandOutput} for command's `response` shape. + * @see {@link CloudSearchClientResolvedConfig | config} for command's `input` shape. + * */ export class IndexDocumentsCommand extends $Command< IndexDocumentsCommandInput, diff --git a/clients/client-cloudsearch/commands/ListDomainNamesCommand.ts b/clients/client-cloudsearch/commands/ListDomainNamesCommand.ts index fca4ad80a75a..228435c6e10b 100644 --- a/clients/client-cloudsearch/commands/ListDomainNamesCommand.ts +++ b/clients/client-cloudsearch/commands/ListDomainNamesCommand.ts @@ -22,6 +22,20 @@ export interface ListDomainNamesCommandOutput extends ListDomainNamesResponse, _ /** *

Lists all search domains owned by an account.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { CloudSearchClient, ListDomainNamesCommand } from "@aws-sdk/client-cloudsearch"; // ES Modules import + * // const { CloudSearchClient, ListDomainNamesCommand } = require("@aws-sdk/client-cloudsearch"); // CommonJS import + * const client = new CloudSearchClient(config); + * const command = new ListDomainNamesCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListDomainNamesCommandInput} for command's `input` shape. + * @see {@link ListDomainNamesCommandOutput} for command's `response` shape. + * @see {@link CloudSearchClientResolvedConfig | config} for command's `input` shape. + * */ export class ListDomainNamesCommand extends $Command< ListDomainNamesCommandInput, diff --git a/clients/client-cloudsearch/commands/UpdateAvailabilityOptionsCommand.ts b/clients/client-cloudsearch/commands/UpdateAvailabilityOptionsCommand.ts index bb003552d239..e532f3ff956e 100644 --- a/clients/client-cloudsearch/commands/UpdateAvailabilityOptionsCommand.ts +++ b/clients/client-cloudsearch/commands/UpdateAvailabilityOptionsCommand.ts @@ -22,6 +22,20 @@ export interface UpdateAvailabilityOptionsCommandOutput extends UpdateAvailabili /** *

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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { CloudSearchClient, UpdateAvailabilityOptionsCommand } from "@aws-sdk/client-cloudsearch"; // ES Modules import + * // const { CloudSearchClient, UpdateAvailabilityOptionsCommand } = require("@aws-sdk/client-cloudsearch"); // CommonJS import + * const client = new CloudSearchClient(config); + * const command = new UpdateAvailabilityOptionsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link UpdateAvailabilityOptionsCommandInput} for command's `input` shape. + * @see {@link UpdateAvailabilityOptionsCommandOutput} for command's `response` shape. + * @see {@link CloudSearchClientResolvedConfig | config} for command's `input` shape. + * */ export class UpdateAvailabilityOptionsCommand extends $Command< UpdateAvailabilityOptionsCommandInput, diff --git a/clients/client-cloudsearch/commands/UpdateDomainEndpointOptionsCommand.ts b/clients/client-cloudsearch/commands/UpdateDomainEndpointOptionsCommand.ts index 221c82628d57..5020c783c49d 100644 --- a/clients/client-cloudsearch/commands/UpdateDomainEndpointOptionsCommand.ts +++ b/clients/client-cloudsearch/commands/UpdateDomainEndpointOptionsCommand.ts @@ -24,6 +24,20 @@ export interface UpdateDomainEndpointOptionsCommandOutput /** *

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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { CloudSearchClient, UpdateDomainEndpointOptionsCommand } from "@aws-sdk/client-cloudsearch"; // ES Modules import + * // const { CloudSearchClient, UpdateDomainEndpointOptionsCommand } = require("@aws-sdk/client-cloudsearch"); // CommonJS import + * const client = new CloudSearchClient(config); + * const command = new UpdateDomainEndpointOptionsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link UpdateDomainEndpointOptionsCommandInput} for command's `input` shape. + * @see {@link UpdateDomainEndpointOptionsCommandOutput} for command's `response` shape. + * @see {@link CloudSearchClientResolvedConfig | config} for command's `input` shape. + * */ export class UpdateDomainEndpointOptionsCommand extends $Command< UpdateDomainEndpointOptionsCommandInput, diff --git a/clients/client-cloudsearch/commands/UpdateScalingParametersCommand.ts b/clients/client-cloudsearch/commands/UpdateScalingParametersCommand.ts index d8c3d17c2b27..cde05a6ce0bd 100644 --- a/clients/client-cloudsearch/commands/UpdateScalingParametersCommand.ts +++ b/clients/client-cloudsearch/commands/UpdateScalingParametersCommand.ts @@ -22,6 +22,20 @@ export interface UpdateScalingParametersCommandOutput extends UpdateScalingParam /** *

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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { CloudSearchClient, UpdateScalingParametersCommand } from "@aws-sdk/client-cloudsearch"; // ES Modules import + * // const { CloudSearchClient, UpdateScalingParametersCommand } = require("@aws-sdk/client-cloudsearch"); // CommonJS import + * const client = new CloudSearchClient(config); + * const command = new UpdateScalingParametersCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link UpdateScalingParametersCommandInput} for command's `input` shape. + * @see {@link UpdateScalingParametersCommandOutput} for command's `response` shape. + * @see {@link CloudSearchClientResolvedConfig | config} for command's `input` shape. + * */ export class UpdateScalingParametersCommand extends $Command< UpdateScalingParametersCommandInput, diff --git a/clients/client-cloudsearch/commands/UpdateServiceAccessPoliciesCommand.ts b/clients/client-cloudsearch/commands/UpdateServiceAccessPoliciesCommand.ts index b4c2367a9b26..bc6897a023ee 100644 --- a/clients/client-cloudsearch/commands/UpdateServiceAccessPoliciesCommand.ts +++ b/clients/client-cloudsearch/commands/UpdateServiceAccessPoliciesCommand.ts @@ -26,6 +26,20 @@ export interface UpdateServiceAccessPoliciesCommandOutput *

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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { CloudSearchClient, UpdateServiceAccessPoliciesCommand } from "@aws-sdk/client-cloudsearch"; // ES Modules import + * // const { CloudSearchClient, UpdateServiceAccessPoliciesCommand } = require("@aws-sdk/client-cloudsearch"); // CommonJS import + * const client = new CloudSearchClient(config); + * const command = new UpdateServiceAccessPoliciesCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link UpdateServiceAccessPoliciesCommandInput} for command's `input` shape. + * @see {@link UpdateServiceAccessPoliciesCommandOutput} for command's `response` shape. + * @see {@link CloudSearchClientResolvedConfig | config} for command's `input` shape. + * */ export class UpdateServiceAccessPoliciesCommand extends $Command< UpdateServiceAccessPoliciesCommandInput, diff --git a/clients/client-cloudsearch/models/models_0.ts b/clients/client-cloudsearch/models/models_0.ts index 333d734cbd4e..77622ec2f451 100644 --- a/clients/client-cloudsearch/models/models_0.ts +++ b/clients/client-cloudsearch/models/models_0.ts @@ -19,6 +19,9 @@ export interface BaseException extends __SmithyException, $MetadataBearer { } export namespace BaseException { + /** + * @internal + */ export const filterSensitiveLog = (obj: BaseException): any => ({ ...obj, }); @@ -35,6 +38,9 @@ export interface BuildSuggestersRequest { } export namespace BuildSuggestersRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: BuildSuggestersRequest): any => ({ ...obj, }); @@ -51,6 +57,9 @@ export interface BuildSuggestersResponse { } export namespace BuildSuggestersResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: BuildSuggestersResponse): any => ({ ...obj, }); @@ -75,6 +84,9 @@ export interface InternalException extends __SmithyException, $MetadataBearer { } export namespace InternalException { + /** + * @internal + */ export const filterSensitiveLog = (obj: InternalException): any => ({ ...obj, }); @@ -98,6 +110,9 @@ export interface ResourceNotFoundException extends __SmithyException, $MetadataB } export namespace ResourceNotFoundException { + /** + * @internal + */ export const filterSensitiveLog = (obj: ResourceNotFoundException): any => ({ ...obj, }); @@ -114,6 +129,9 @@ export interface CreateDomainRequest { } export namespace CreateDomainRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateDomainRequest): any => ({ ...obj, }); @@ -130,6 +148,9 @@ export interface ServiceEndpoint { } export namespace ServiceEndpoint { + /** + * @internal + */ export const filterSensitiveLog = (obj: ServiceEndpoint): any => ({ ...obj, }); @@ -141,6 +162,9 @@ export interface Limits { } export namespace Limits { + /** + * @internal + */ export const filterSensitiveLog = (obj: Limits): any => ({ ...obj, }); @@ -214,6 +238,9 @@ export interface DomainStatus { } export namespace DomainStatus { + /** + * @internal + */ export const filterSensitiveLog = (obj: DomainStatus): any => ({ ...obj, }); @@ -230,6 +257,9 @@ export interface CreateDomainResponse { } export namespace CreateDomainResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateDomainResponse): any => ({ ...obj, }); @@ -253,6 +283,9 @@ export interface LimitExceededException extends __SmithyException, $MetadataBear } export namespace LimitExceededException { + /** + * @internal + */ export const filterSensitiveLog = (obj: LimitExceededException): any => ({ ...obj, }); @@ -291,6 +324,9 @@ export interface AnalysisOptions { } export namespace AnalysisOptions { + /** + * @internal + */ export const filterSensitiveLog = (obj: AnalysisOptions): any => ({ ...obj, }); @@ -355,6 +391,9 @@ export interface AnalysisScheme { } export namespace AnalysisScheme { + /** + * @internal + */ export const filterSensitiveLog = (obj: AnalysisScheme): any => ({ ...obj, }); @@ -376,6 +415,9 @@ export interface DefineAnalysisSchemeRequest { } export namespace DefineAnalysisSchemeRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DefineAnalysisSchemeRequest): any => ({ ...obj, }); @@ -419,6 +461,9 @@ export interface OptionStatus { } export namespace OptionStatus { + /** + * @internal + */ export const filterSensitiveLog = (obj: OptionStatus): any => ({ ...obj, }); @@ -440,6 +485,9 @@ export interface AnalysisSchemeStatus { } export namespace AnalysisSchemeStatus { + /** + * @internal + */ export const filterSensitiveLog = (obj: AnalysisSchemeStatus): any => ({ ...obj, }); @@ -456,6 +504,9 @@ export interface DefineAnalysisSchemeResponse { } export namespace DefineAnalysisSchemeResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DefineAnalysisSchemeResponse): any => ({ ...obj, }); @@ -479,6 +530,9 @@ export interface InvalidTypeException extends __SmithyException, $MetadataBearer } export namespace InvalidTypeException { + /** + * @internal + */ export const filterSensitiveLog = (obj: InvalidTypeException): any => ({ ...obj, }); @@ -501,6 +555,9 @@ export interface Expression { } export namespace Expression { + /** + * @internal + */ export const filterSensitiveLog = (obj: Expression): any => ({ ...obj, }); @@ -522,6 +579,9 @@ export interface DefineExpressionRequest { } export namespace DefineExpressionRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DefineExpressionRequest): any => ({ ...obj, }); @@ -543,6 +603,9 @@ export interface ExpressionStatus { } export namespace ExpressionStatus { + /** + * @internal + */ export const filterSensitiveLog = (obj: ExpressionStatus): any => ({ ...obj, }); @@ -559,6 +622,9 @@ export interface DefineExpressionResponse { } export namespace DefineExpressionResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DefineExpressionResponse): any => ({ ...obj, }); @@ -595,6 +661,9 @@ export interface DateArrayOptions { } export namespace DateArrayOptions { + /** + * @internal + */ export const filterSensitiveLog = (obj: DateArrayOptions): any => ({ ...obj, }); @@ -649,6 +718,9 @@ export interface DateOptions { } export namespace DateOptions { + /** + * @internal + */ export const filterSensitiveLog = (obj: DateOptions): any => ({ ...obj, }); @@ -685,6 +757,9 @@ export interface DoubleArrayOptions { } export namespace DoubleArrayOptions { + /** + * @internal + */ export const filterSensitiveLog = (obj: DoubleArrayOptions): any => ({ ...obj, }); @@ -726,6 +801,9 @@ export interface DoubleOptions { } export namespace DoubleOptions { + /** + * @internal + */ export const filterSensitiveLog = (obj: DoubleOptions): any => ({ ...obj, }); @@ -775,6 +853,9 @@ export interface IntArrayOptions { } export namespace IntArrayOptions { + /** + * @internal + */ export const filterSensitiveLog = (obj: IntArrayOptions): any => ({ ...obj, }); @@ -816,6 +897,9 @@ export interface IntOptions { } export namespace IntOptions { + /** + * @internal + */ export const filterSensitiveLog = (obj: IntOptions): any => ({ ...obj, }); @@ -870,6 +954,9 @@ export interface LatLonOptions { } export namespace LatLonOptions { + /** + * @internal + */ export const filterSensitiveLog = (obj: LatLonOptions): any => ({ ...obj, }); @@ -906,6 +993,9 @@ export interface LiteralArrayOptions { } export namespace LiteralArrayOptions { + /** + * @internal + */ export const filterSensitiveLog = (obj: LiteralArrayOptions): any => ({ ...obj, }); @@ -960,6 +1050,9 @@ export interface LiteralOptions { } export namespace LiteralOptions { + /** + * @internal + */ export const filterSensitiveLog = (obj: LiteralOptions): any => ({ ...obj, }); @@ -996,6 +1089,9 @@ export interface TextArrayOptions { } export namespace TextArrayOptions { + /** + * @internal + */ export const filterSensitiveLog = (obj: TextArrayOptions): any => ({ ...obj, }); @@ -1050,6 +1146,9 @@ export interface TextOptions { } export namespace TextOptions { + /** + * @internal + */ export const filterSensitiveLog = (obj: TextOptions): any => ({ ...obj, }); @@ -1139,6 +1238,9 @@ export interface IndexField { } export namespace IndexField { + /** + * @internal + */ export const filterSensitiveLog = (obj: IndexField): any => ({ ...obj, }); @@ -1160,6 +1262,9 @@ export interface DefineIndexFieldRequest { } export namespace DefineIndexFieldRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DefineIndexFieldRequest): any => ({ ...obj, }); @@ -1181,6 +1286,9 @@ export interface IndexFieldStatus { } export namespace IndexFieldStatus { + /** + * @internal + */ export const filterSensitiveLog = (obj: IndexFieldStatus): any => ({ ...obj, }); @@ -1197,6 +1305,9 @@ export interface DefineIndexFieldResponse { } export namespace DefineIndexFieldResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DefineIndexFieldResponse): any => ({ ...obj, }); @@ -1231,6 +1342,9 @@ export interface DocumentSuggesterOptions { } export namespace DocumentSuggesterOptions { + /** + * @internal + */ export const filterSensitiveLog = (obj: DocumentSuggesterOptions): any => ({ ...obj, }); @@ -1253,6 +1367,9 @@ export interface Suggester { } export namespace Suggester { + /** + * @internal + */ export const filterSensitiveLog = (obj: Suggester): any => ({ ...obj, }); @@ -1274,6 +1391,9 @@ export interface DefineSuggesterRequest { } export namespace DefineSuggesterRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DefineSuggesterRequest): any => ({ ...obj, }); @@ -1295,6 +1415,9 @@ export interface SuggesterStatus { } export namespace SuggesterStatus { + /** + * @internal + */ export const filterSensitiveLog = (obj: SuggesterStatus): any => ({ ...obj, }); @@ -1311,6 +1434,9 @@ export interface DefineSuggesterResponse { } export namespace DefineSuggesterResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DefineSuggesterResponse): any => ({ ...obj, }); @@ -1332,6 +1458,9 @@ export interface DeleteAnalysisSchemeRequest { } export namespace DeleteAnalysisSchemeRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteAnalysisSchemeRequest): any => ({ ...obj, }); @@ -1348,6 +1477,9 @@ export interface DeleteAnalysisSchemeResponse { } export namespace DeleteAnalysisSchemeResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteAnalysisSchemeResponse): any => ({ ...obj, }); @@ -1364,6 +1496,9 @@ export interface DeleteDomainRequest { } export namespace DeleteDomainRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteDomainRequest): any => ({ ...obj, }); @@ -1380,6 +1515,9 @@ export interface DeleteDomainResponse { } export namespace DeleteDomainResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteDomainResponse): any => ({ ...obj, }); @@ -1401,6 +1539,9 @@ export interface DeleteExpressionRequest { } export namespace DeleteExpressionRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteExpressionRequest): any => ({ ...obj, }); @@ -1417,6 +1558,9 @@ export interface DeleteExpressionResponse { } export namespace DeleteExpressionResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteExpressionResponse): any => ({ ...obj, }); @@ -1438,6 +1582,9 @@ export interface DeleteIndexFieldRequest { } export namespace DeleteIndexFieldRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteIndexFieldRequest): any => ({ ...obj, }); @@ -1454,6 +1601,9 @@ export interface DeleteIndexFieldResponse { } export namespace DeleteIndexFieldResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteIndexFieldResponse): any => ({ ...obj, }); @@ -1475,6 +1625,9 @@ export interface DeleteSuggesterRequest { } export namespace DeleteSuggesterRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteSuggesterRequest): any => ({ ...obj, }); @@ -1491,6 +1644,9 @@ export interface DeleteSuggesterResponse { } export namespace DeleteSuggesterResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteSuggesterResponse): any => ({ ...obj, }); @@ -1517,6 +1673,9 @@ export interface DescribeAnalysisSchemesRequest { } export namespace DescribeAnalysisSchemesRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeAnalysisSchemesRequest): any => ({ ...obj, }); @@ -1533,6 +1692,9 @@ export interface DescribeAnalysisSchemesResponse { } export namespace DescribeAnalysisSchemesResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeAnalysisSchemesResponse): any => ({ ...obj, }); @@ -1554,6 +1716,9 @@ export interface DescribeAvailabilityOptionsRequest { } export namespace DescribeAvailabilityOptionsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeAvailabilityOptionsRequest): any => ({ ...obj, }); @@ -1575,6 +1740,9 @@ export interface AvailabilityOptionsStatus { } export namespace AvailabilityOptionsStatus { + /** + * @internal + */ export const filterSensitiveLog = (obj: AvailabilityOptionsStatus): any => ({ ...obj, }); @@ -1591,6 +1759,9 @@ export interface DescribeAvailabilityOptionsResponse { } export namespace DescribeAvailabilityOptionsResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeAvailabilityOptionsResponse): any => ({ ...obj, }); @@ -1614,6 +1785,9 @@ export interface DisabledOperationException extends __SmithyException, $Metadata } export namespace DisabledOperationException { + /** + * @internal + */ export const filterSensitiveLog = (obj: DisabledOperationException): any => ({ ...obj, }); @@ -1635,6 +1809,9 @@ export interface DescribeDomainEndpointOptionsRequest { } export namespace DescribeDomainEndpointOptionsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeDomainEndpointOptionsRequest): any => ({ ...obj, }); @@ -1661,6 +1838,9 @@ export interface DomainEndpointOptions { } export namespace DomainEndpointOptions { + /** + * @internal + */ export const filterSensitiveLog = (obj: DomainEndpointOptions): any => ({ ...obj, }); @@ -1682,6 +1862,9 @@ export interface DomainEndpointOptionsStatus { } export namespace DomainEndpointOptionsStatus { + /** + * @internal + */ export const filterSensitiveLog = (obj: DomainEndpointOptionsStatus): any => ({ ...obj, }); @@ -1698,6 +1881,9 @@ export interface DescribeDomainEndpointOptionsResponse { } export namespace DescribeDomainEndpointOptionsResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeDomainEndpointOptionsResponse): any => ({ ...obj, }); @@ -1714,6 +1900,9 @@ export interface DescribeDomainsRequest { } export namespace DescribeDomainsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeDomainsRequest): any => ({ ...obj, }); @@ -1730,6 +1919,9 @@ export interface DescribeDomainsResponse { } export namespace DescribeDomainsResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeDomainsResponse): any => ({ ...obj, }); @@ -1757,6 +1949,9 @@ export interface DescribeExpressionsRequest { } export namespace DescribeExpressionsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeExpressionsRequest): any => ({ ...obj, }); @@ -1773,6 +1968,9 @@ export interface DescribeExpressionsResponse { } export namespace DescribeExpressionsResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeExpressionsResponse): any => ({ ...obj, }); @@ -1799,6 +1997,9 @@ export interface DescribeIndexFieldsRequest { } export namespace DescribeIndexFieldsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeIndexFieldsRequest): any => ({ ...obj, }); @@ -1815,6 +2016,9 @@ export interface DescribeIndexFieldsResponse { } export namespace DescribeIndexFieldsResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeIndexFieldsResponse): any => ({ ...obj, }); @@ -1831,6 +2035,9 @@ export interface DescribeScalingParametersRequest { } export namespace DescribeScalingParametersRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeScalingParametersRequest): any => ({ ...obj, }); @@ -1873,6 +2080,9 @@ export interface ScalingParameters { } export namespace ScalingParameters { + /** + * @internal + */ export const filterSensitiveLog = (obj: ScalingParameters): any => ({ ...obj, }); @@ -1894,6 +2104,9 @@ export interface ScalingParametersStatus { } export namespace ScalingParametersStatus { + /** + * @internal + */ export const filterSensitiveLog = (obj: ScalingParametersStatus): any => ({ ...obj, }); @@ -1910,6 +2123,9 @@ export interface DescribeScalingParametersResponse { } export namespace DescribeScalingParametersResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeScalingParametersResponse): any => ({ ...obj, }); @@ -1931,6 +2147,9 @@ export interface DescribeServiceAccessPoliciesRequest { } export namespace DescribeServiceAccessPoliciesRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeServiceAccessPoliciesRequest): any => ({ ...obj, }); @@ -1952,6 +2171,9 @@ export interface AccessPoliciesStatus { } export namespace AccessPoliciesStatus { + /** + * @internal + */ export const filterSensitiveLog = (obj: AccessPoliciesStatus): any => ({ ...obj, }); @@ -1968,6 +2190,9 @@ export interface DescribeServiceAccessPoliciesResponse { } export namespace DescribeServiceAccessPoliciesResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeServiceAccessPoliciesResponse): any => ({ ...obj, }); @@ -1994,6 +2219,9 @@ export interface DescribeSuggestersRequest { } export namespace DescribeSuggestersRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeSuggestersRequest): any => ({ ...obj, }); @@ -2010,6 +2238,9 @@ export interface DescribeSuggestersResponse { } export namespace DescribeSuggestersResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeSuggestersResponse): any => ({ ...obj, }); @@ -2026,6 +2257,9 @@ export interface IndexDocumentsRequest { } export namespace IndexDocumentsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: IndexDocumentsRequest): any => ({ ...obj, }); @@ -2042,6 +2276,9 @@ export interface IndexDocumentsResponse { } export namespace IndexDocumentsResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: IndexDocumentsResponse): any => ({ ...obj, }); @@ -2058,6 +2295,9 @@ export interface ListDomainNamesResponse { } export namespace ListDomainNamesResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListDomainNamesResponse): any => ({ ...obj, }); @@ -2079,6 +2319,9 @@ export interface UpdateAvailabilityOptionsRequest { } export namespace UpdateAvailabilityOptionsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateAvailabilityOptionsRequest): any => ({ ...obj, }); @@ -2095,6 +2338,9 @@ export interface UpdateAvailabilityOptionsResponse { } export namespace UpdateAvailabilityOptionsResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateAvailabilityOptionsResponse): any => ({ ...obj, }); @@ -2118,6 +2364,9 @@ export interface ValidationException extends __SmithyException, $MetadataBearer } export namespace ValidationException { + /** + * @internal + */ export const filterSensitiveLog = (obj: ValidationException): any => ({ ...obj, }); @@ -2139,6 +2388,9 @@ export interface UpdateDomainEndpointOptionsRequest { } export namespace UpdateDomainEndpointOptionsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateDomainEndpointOptionsRequest): any => ({ ...obj, }); @@ -2155,6 +2407,9 @@ export interface UpdateDomainEndpointOptionsResponse { } export namespace UpdateDomainEndpointOptionsResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateDomainEndpointOptionsResponse): any => ({ ...obj, }); @@ -2176,6 +2431,9 @@ export interface UpdateScalingParametersRequest { } export namespace UpdateScalingParametersRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateScalingParametersRequest): any => ({ ...obj, }); @@ -2192,6 +2450,9 @@ export interface UpdateScalingParametersResponse { } export namespace UpdateScalingParametersResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateScalingParametersResponse): any => ({ ...obj, }); @@ -2213,6 +2474,9 @@ export interface UpdateServiceAccessPoliciesRequest { } export namespace UpdateServiceAccessPoliciesRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateServiceAccessPoliciesRequest): any => ({ ...obj, }); @@ -2229,6 +2493,9 @@ export interface UpdateServiceAccessPoliciesResponse { } export namespace UpdateServiceAccessPoliciesResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateServiceAccessPoliciesResponse): any => ({ ...obj, }); diff --git a/clients/client-cloudtrail/commands/AddTagsCommand.ts b/clients/client-cloudtrail/commands/AddTagsCommand.ts index 1dbcb5875b2c..7a04e9164101 100644 --- a/clients/client-cloudtrail/commands/AddTagsCommand.ts +++ b/clients/client-cloudtrail/commands/AddTagsCommand.ts @@ -22,6 +22,20 @@ export interface AddTagsCommandOutput extends AddTagsResponse, __MetadataBearer * Tag key names must be unique for a trail; 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 that applies to all AWS Regions only from the Region in which the trail was created (also known as its home region).

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { CloudTrailClient, AddTagsCommand } from "@aws-sdk/client-cloudtrail"; // ES Modules import + * // const { CloudTrailClient, AddTagsCommand } = require("@aws-sdk/client-cloudtrail"); // CommonJS import + * const client = new CloudTrailClient(config); + * const command = new AddTagsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link AddTagsCommandInput} for command's `input` shape. + * @see {@link AddTagsCommandOutput} for command's `response` shape. + * @see {@link CloudTrailClientResolvedConfig | config} for command's `input` shape. + * */ export class AddTagsCommand extends $Command< AddTagsCommandInput, diff --git a/clients/client-cloudtrail/commands/CreateTrailCommand.ts b/clients/client-cloudtrail/commands/CreateTrailCommand.ts index bbd91f81facb..9409807c72a1 100644 --- a/clients/client-cloudtrail/commands/CreateTrailCommand.ts +++ b/clients/client-cloudtrail/commands/CreateTrailCommand.ts @@ -22,6 +22,20 @@ export interface CreateTrailCommandOutput extends CreateTrailResponse, __Metadat /** *

Creates a trail that specifies the settings for delivery of log data to an Amazon S3 bucket.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { CloudTrailClient, CreateTrailCommand } from "@aws-sdk/client-cloudtrail"; // ES Modules import + * // const { CloudTrailClient, CreateTrailCommand } = require("@aws-sdk/client-cloudtrail"); // CommonJS import + * const client = new CloudTrailClient(config); + * const command = new CreateTrailCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreateTrailCommandInput} for command's `input` shape. + * @see {@link CreateTrailCommandOutput} for command's `response` shape. + * @see {@link CloudTrailClientResolvedConfig | config} for command's `input` shape. + * */ export class CreateTrailCommand extends $Command< CreateTrailCommandInput, diff --git a/clients/client-cloudtrail/commands/DeleteTrailCommand.ts b/clients/client-cloudtrail/commands/DeleteTrailCommand.ts index 0e4eb4a1a92b..fae340a3ef5c 100644 --- a/clients/client-cloudtrail/commands/DeleteTrailCommand.ts +++ b/clients/client-cloudtrail/commands/DeleteTrailCommand.ts @@ -24,6 +24,20 @@ export interface DeleteTrailCommandOutput extends DeleteTrailResponse, __Metadat *

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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { CloudTrailClient, DeleteTrailCommand } from "@aws-sdk/client-cloudtrail"; // ES Modules import + * // const { CloudTrailClient, DeleteTrailCommand } = require("@aws-sdk/client-cloudtrail"); // CommonJS import + * const client = new CloudTrailClient(config); + * const command = new DeleteTrailCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteTrailCommandInput} for command's `input` shape. + * @see {@link DeleteTrailCommandOutput} for command's `response` shape. + * @see {@link CloudTrailClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteTrailCommand extends $Command< DeleteTrailCommandInput, diff --git a/clients/client-cloudtrail/commands/DescribeTrailsCommand.ts b/clients/client-cloudtrail/commands/DescribeTrailsCommand.ts index b52337150e0a..f092ee7e7e63 100644 --- a/clients/client-cloudtrail/commands/DescribeTrailsCommand.ts +++ b/clients/client-cloudtrail/commands/DescribeTrailsCommand.ts @@ -22,6 +22,20 @@ export interface DescribeTrailsCommandOutput extends DescribeTrailsResponse, __M /** *

Retrieves settings for one or more trails associated with the current region for your account.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { CloudTrailClient, DescribeTrailsCommand } from "@aws-sdk/client-cloudtrail"; // ES Modules import + * // const { CloudTrailClient, DescribeTrailsCommand } = require("@aws-sdk/client-cloudtrail"); // CommonJS import + * const client = new CloudTrailClient(config); + * const command = new DescribeTrailsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeTrailsCommandInput} for command's `input` shape. + * @see {@link DescribeTrailsCommandOutput} for command's `response` shape. + * @see {@link CloudTrailClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeTrailsCommand extends $Command< DescribeTrailsCommandInput, diff --git a/clients/client-cloudtrail/commands/GetEventSelectorsCommand.ts b/clients/client-cloudtrail/commands/GetEventSelectorsCommand.ts index e52bf8ddd34d..85547cdfe731 100644 --- a/clients/client-cloudtrail/commands/GetEventSelectorsCommand.ts +++ b/clients/client-cloudtrail/commands/GetEventSelectorsCommand.ts @@ -38,6 +38,20 @@ export interface GetEventSelectorsCommandOutput extends GetEventSelectorsRespons * *

For more information, see Logging Data and Management Events for Trails * in the AWS CloudTrail User Guide.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { CloudTrailClient, GetEventSelectorsCommand } from "@aws-sdk/client-cloudtrail"; // ES Modules import + * // const { CloudTrailClient, GetEventSelectorsCommand } = require("@aws-sdk/client-cloudtrail"); // CommonJS import + * const client = new CloudTrailClient(config); + * const command = new GetEventSelectorsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetEventSelectorsCommandInput} for command's `input` shape. + * @see {@link GetEventSelectorsCommandOutput} for command's `response` shape. + * @see {@link CloudTrailClientResolvedConfig | config} for command's `input` shape. + * */ export class GetEventSelectorsCommand extends $Command< GetEventSelectorsCommandInput, diff --git a/clients/client-cloudtrail/commands/GetInsightSelectorsCommand.ts b/clients/client-cloudtrail/commands/GetInsightSelectorsCommand.ts index f41b55c1d3d3..8aa1a6bdd5da 100644 --- a/clients/client-cloudtrail/commands/GetInsightSelectorsCommand.ts +++ b/clients/client-cloudtrail/commands/GetInsightSelectorsCommand.ts @@ -28,6 +28,20 @@ export interface GetInsightSelectorsCommandOutput extends GetInsightSelectorsRes *

*

For more information, see Logging CloudTrail Insights Events for Trails * in the AWS CloudTrail User Guide.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { CloudTrailClient, GetInsightSelectorsCommand } from "@aws-sdk/client-cloudtrail"; // ES Modules import + * // const { CloudTrailClient, GetInsightSelectorsCommand } = require("@aws-sdk/client-cloudtrail"); // CommonJS import + * const client = new CloudTrailClient(config); + * const command = new GetInsightSelectorsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetInsightSelectorsCommandInput} for command's `input` shape. + * @see {@link GetInsightSelectorsCommandOutput} for command's `response` shape. + * @see {@link CloudTrailClientResolvedConfig | config} for command's `input` shape. + * */ export class GetInsightSelectorsCommand extends $Command< GetInsightSelectorsCommandInput, diff --git a/clients/client-cloudtrail/commands/GetTrailCommand.ts b/clients/client-cloudtrail/commands/GetTrailCommand.ts index 21062fac7169..e3864c0bcd6c 100644 --- a/clients/client-cloudtrail/commands/GetTrailCommand.ts +++ b/clients/client-cloudtrail/commands/GetTrailCommand.ts @@ -19,6 +19,20 @@ export interface GetTrailCommandOutput extends GetTrailResponse, __MetadataBeare /** *

Returns settings information for a specified trail.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { CloudTrailClient, GetTrailCommand } from "@aws-sdk/client-cloudtrail"; // ES Modules import + * // const { CloudTrailClient, GetTrailCommand } = require("@aws-sdk/client-cloudtrail"); // CommonJS import + * const client = new CloudTrailClient(config); + * const command = new GetTrailCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetTrailCommandInput} for command's `input` shape. + * @see {@link GetTrailCommandOutput} for command's `response` shape. + * @see {@link CloudTrailClientResolvedConfig | config} for command's `input` shape. + * */ export class GetTrailCommand extends $Command< GetTrailCommandInput, diff --git a/clients/client-cloudtrail/commands/GetTrailStatusCommand.ts b/clients/client-cloudtrail/commands/GetTrailStatusCommand.ts index d8612217e4e2..218f231269fc 100644 --- a/clients/client-cloudtrail/commands/GetTrailStatusCommand.ts +++ b/clients/client-cloudtrail/commands/GetTrailStatusCommand.ts @@ -22,6 +22,20 @@ export interface GetTrailStatusCommandOutput extends GetTrailStatusResponse, __M /** *

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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { CloudTrailClient, GetTrailStatusCommand } from "@aws-sdk/client-cloudtrail"; // ES Modules import + * // const { CloudTrailClient, GetTrailStatusCommand } = require("@aws-sdk/client-cloudtrail"); // CommonJS import + * const client = new CloudTrailClient(config); + * const command = new GetTrailStatusCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetTrailStatusCommandInput} for command's `input` shape. + * @see {@link GetTrailStatusCommandOutput} for command's `response` shape. + * @see {@link CloudTrailClientResolvedConfig | config} for command's `input` shape. + * */ export class GetTrailStatusCommand extends $Command< GetTrailStatusCommandInput, diff --git a/clients/client-cloudtrail/commands/ListPublicKeysCommand.ts b/clients/client-cloudtrail/commands/ListPublicKeysCommand.ts index b8c1bf9712f4..8c1cdcfa7ec8 100644 --- a/clients/client-cloudtrail/commands/ListPublicKeysCommand.ts +++ b/clients/client-cloudtrail/commands/ListPublicKeysCommand.ts @@ -25,6 +25,20 @@ export interface ListPublicKeysCommandOutput extends ListPublicKeysResponse, __M * *

CloudTrail uses different private/public key pairs per region. Each digest file is signed with a private key unique to its region. Therefore, when you validate a digest file from a particular region, you must look in the same region for its corresponding public key.

* + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { CloudTrailClient, ListPublicKeysCommand } from "@aws-sdk/client-cloudtrail"; // ES Modules import + * // const { CloudTrailClient, ListPublicKeysCommand } = require("@aws-sdk/client-cloudtrail"); // CommonJS import + * const client = new CloudTrailClient(config); + * const command = new ListPublicKeysCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListPublicKeysCommandInput} for command's `input` shape. + * @see {@link ListPublicKeysCommandOutput} for command's `response` shape. + * @see {@link CloudTrailClientResolvedConfig | config} for command's `input` shape. + * */ export class ListPublicKeysCommand extends $Command< ListPublicKeysCommandInput, diff --git a/clients/client-cloudtrail/commands/ListTagsCommand.ts b/clients/client-cloudtrail/commands/ListTagsCommand.ts index 30d2efa661f7..85a069a0485d 100644 --- a/clients/client-cloudtrail/commands/ListTagsCommand.ts +++ b/clients/client-cloudtrail/commands/ListTagsCommand.ts @@ -19,6 +19,20 @@ export interface ListTagsCommandOutput extends ListTagsResponse, __MetadataBeare /** *

Lists the tags for the trail in the current region.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { CloudTrailClient, ListTagsCommand } from "@aws-sdk/client-cloudtrail"; // ES Modules import + * // const { CloudTrailClient, ListTagsCommand } = require("@aws-sdk/client-cloudtrail"); // CommonJS import + * const client = new CloudTrailClient(config); + * const command = new ListTagsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListTagsCommandInput} for command's `input` shape. + * @see {@link ListTagsCommandOutput} for command's `response` shape. + * @see {@link CloudTrailClientResolvedConfig | config} for command's `input` shape. + * */ export class ListTagsCommand extends $Command< ListTagsCommandInput, diff --git a/clients/client-cloudtrail/commands/ListTrailsCommand.ts b/clients/client-cloudtrail/commands/ListTrailsCommand.ts index f161340caf89..8e7f32d8dd9b 100644 --- a/clients/client-cloudtrail/commands/ListTrailsCommand.ts +++ b/clients/client-cloudtrail/commands/ListTrailsCommand.ts @@ -22,6 +22,20 @@ export interface ListTrailsCommandOutput extends ListTrailsResponse, __MetadataB /** *

Lists trails that are in the current account.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { CloudTrailClient, ListTrailsCommand } from "@aws-sdk/client-cloudtrail"; // ES Modules import + * // const { CloudTrailClient, ListTrailsCommand } = require("@aws-sdk/client-cloudtrail"); // CommonJS import + * const client = new CloudTrailClient(config); + * const command = new ListTrailsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListTrailsCommandInput} for command's `input` shape. + * @see {@link ListTrailsCommandOutput} for command's `response` shape. + * @see {@link CloudTrailClientResolvedConfig | config} for command's `input` shape. + * */ export class ListTrailsCommand extends $Command< ListTrailsCommandInput, diff --git a/clients/client-cloudtrail/commands/LookupEventsCommand.ts b/clients/client-cloudtrail/commands/LookupEventsCommand.ts index 214698dce6c7..8239e62d7c51 100644 --- a/clients/client-cloudtrail/commands/LookupEventsCommand.ts +++ b/clients/client-cloudtrail/commands/LookupEventsCommand.ts @@ -69,6 +69,20 @@ export interface LookupEventsCommandOutput extends LookupEventsResponse, __Metad *

The rate of lookup requests is limited to two per second, per account, per region. If this * limit is exceeded, a throttling error occurs.

* + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { CloudTrailClient, LookupEventsCommand } from "@aws-sdk/client-cloudtrail"; // ES Modules import + * // const { CloudTrailClient, LookupEventsCommand } = require("@aws-sdk/client-cloudtrail"); // CommonJS import + * const client = new CloudTrailClient(config); + * const command = new LookupEventsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link LookupEventsCommandInput} for command's `input` shape. + * @see {@link LookupEventsCommandOutput} for command's `response` shape. + * @see {@link CloudTrailClientResolvedConfig | config} for command's `input` shape. + * */ export class LookupEventsCommand extends $Command< LookupEventsCommandInput, diff --git a/clients/client-cloudtrail/commands/PutEventSelectorsCommand.ts b/clients/client-cloudtrail/commands/PutEventSelectorsCommand.ts index dd7ade1ec05d..abd2ad70a14b 100644 --- a/clients/client-cloudtrail/commands/PutEventSelectorsCommand.ts +++ b/clients/client-cloudtrail/commands/PutEventSelectorsCommand.ts @@ -66,6 +66,20 @@ export interface PutEventSelectorsCommandOutput extends PutEventSelectorsRespons * advanced event selectors, see * Logging * data events for trails in the AWS CloudTrail User Guide.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { CloudTrailClient, PutEventSelectorsCommand } from "@aws-sdk/client-cloudtrail"; // ES Modules import + * // const { CloudTrailClient, PutEventSelectorsCommand } = require("@aws-sdk/client-cloudtrail"); // CommonJS import + * const client = new CloudTrailClient(config); + * const command = new PutEventSelectorsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link PutEventSelectorsCommandInput} for command's `input` shape. + * @see {@link PutEventSelectorsCommandOutput} for command's `response` shape. + * @see {@link CloudTrailClientResolvedConfig | config} for command's `input` shape. + * */ export class PutEventSelectorsCommand extends $Command< PutEventSelectorsCommandInput, diff --git a/clients/client-cloudtrail/commands/PutInsightSelectorsCommand.ts b/clients/client-cloudtrail/commands/PutInsightSelectorsCommand.ts index b8530b76bc34..56c9827e1fab 100644 --- a/clients/client-cloudtrail/commands/PutInsightSelectorsCommand.ts +++ b/clients/client-cloudtrail/commands/PutInsightSelectorsCommand.ts @@ -25,6 +25,20 @@ export interface PutInsightSelectorsCommandOutput extends PutInsightSelectorsRes * 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. * In this release, only ApiCallRateInsight is supported as an Insights selector.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { CloudTrailClient, PutInsightSelectorsCommand } from "@aws-sdk/client-cloudtrail"; // ES Modules import + * // const { CloudTrailClient, PutInsightSelectorsCommand } = require("@aws-sdk/client-cloudtrail"); // CommonJS import + * const client = new CloudTrailClient(config); + * const command = new PutInsightSelectorsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link PutInsightSelectorsCommandInput} for command's `input` shape. + * @see {@link PutInsightSelectorsCommandOutput} for command's `response` shape. + * @see {@link CloudTrailClientResolvedConfig | config} for command's `input` shape. + * */ export class PutInsightSelectorsCommand extends $Command< PutInsightSelectorsCommandInput, diff --git a/clients/client-cloudtrail/commands/RemoveTagsCommand.ts b/clients/client-cloudtrail/commands/RemoveTagsCommand.ts index ddf9fcc7624e..3c7b96200453 100644 --- a/clients/client-cloudtrail/commands/RemoveTagsCommand.ts +++ b/clients/client-cloudtrail/commands/RemoveTagsCommand.ts @@ -22,6 +22,20 @@ export interface RemoveTagsCommandOutput extends RemoveTagsResponse, __MetadataB /** *

Removes the specified tags from a trail.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { CloudTrailClient, RemoveTagsCommand } from "@aws-sdk/client-cloudtrail"; // ES Modules import + * // const { CloudTrailClient, RemoveTagsCommand } = require("@aws-sdk/client-cloudtrail"); // CommonJS import + * const client = new CloudTrailClient(config); + * const command = new RemoveTagsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link RemoveTagsCommandInput} for command's `input` shape. + * @see {@link RemoveTagsCommandOutput} for command's `response` shape. + * @see {@link CloudTrailClientResolvedConfig | config} for command's `input` shape. + * */ export class RemoveTagsCommand extends $Command< RemoveTagsCommandInput, diff --git a/clients/client-cloudtrail/commands/StartLoggingCommand.ts b/clients/client-cloudtrail/commands/StartLoggingCommand.ts index bc12e0d00836..e5a18f2a648e 100644 --- a/clients/client-cloudtrail/commands/StartLoggingCommand.ts +++ b/clients/client-cloudtrail/commands/StartLoggingCommand.ts @@ -22,6 +22,20 @@ export interface StartLoggingCommandOutput extends StartLoggingResponse, __Metad /** *

Starts the recording of AWS 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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { CloudTrailClient, StartLoggingCommand } from "@aws-sdk/client-cloudtrail"; // ES Modules import + * // const { CloudTrailClient, StartLoggingCommand } = require("@aws-sdk/client-cloudtrail"); // CommonJS import + * const client = new CloudTrailClient(config); + * const command = new StartLoggingCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link StartLoggingCommandInput} for command's `input` shape. + * @see {@link StartLoggingCommandOutput} for command's `response` shape. + * @see {@link CloudTrailClientResolvedConfig | config} for command's `input` shape. + * */ export class StartLoggingCommand extends $Command< StartLoggingCommandInput, diff --git a/clients/client-cloudtrail/commands/StopLoggingCommand.ts b/clients/client-cloudtrail/commands/StopLoggingCommand.ts index 96700804ac58..5aa41e4a27e7 100644 --- a/clients/client-cloudtrail/commands/StopLoggingCommand.ts +++ b/clients/client-cloudtrail/commands/StopLoggingCommand.ts @@ -28,6 +28,20 @@ export interface StopLoggingCommandOutput extends StopLoggingResponse, __Metadat * 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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { CloudTrailClient, StopLoggingCommand } from "@aws-sdk/client-cloudtrail"; // ES Modules import + * // const { CloudTrailClient, StopLoggingCommand } = require("@aws-sdk/client-cloudtrail"); // CommonJS import + * const client = new CloudTrailClient(config); + * const command = new StopLoggingCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link StopLoggingCommandInput} for command's `input` shape. + * @see {@link StopLoggingCommandOutput} for command's `response` shape. + * @see {@link CloudTrailClientResolvedConfig | config} for command's `input` shape. + * */ export class StopLoggingCommand extends $Command< StopLoggingCommandInput, diff --git a/clients/client-cloudtrail/commands/UpdateTrailCommand.ts b/clients/client-cloudtrail/commands/UpdateTrailCommand.ts index 16ca48741a9b..b5157f6f5d84 100644 --- a/clients/client-cloudtrail/commands/UpdateTrailCommand.ts +++ b/clients/client-cloudtrail/commands/UpdateTrailCommand.ts @@ -27,6 +27,20 @@ export interface UpdateTrailCommandOutput extends UpdateTrailResponse, __Metadat * 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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { CloudTrailClient, UpdateTrailCommand } from "@aws-sdk/client-cloudtrail"; // ES Modules import + * // const { CloudTrailClient, UpdateTrailCommand } = require("@aws-sdk/client-cloudtrail"); // CommonJS import + * const client = new CloudTrailClient(config); + * const command = new UpdateTrailCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link UpdateTrailCommandInput} for command's `input` shape. + * @see {@link UpdateTrailCommandOutput} for command's `response` shape. + * @see {@link CloudTrailClientResolvedConfig | config} for command's `input` shape. + * */ export class UpdateTrailCommand extends $Command< UpdateTrailCommandInput, diff --git a/clients/client-cloudtrail/models/models_0.ts b/clients/client-cloudtrail/models/models_0.ts index accd6cc8fac4..042deb934d99 100644 --- a/clients/client-cloudtrail/models/models_0.ts +++ b/clients/client-cloudtrail/models/models_0.ts @@ -17,6 +17,9 @@ export interface Tag { } export namespace Tag { + /** + * @internal + */ export const filterSensitiveLog = (obj: Tag): any => ({ ...obj, }); @@ -41,6 +44,9 @@ export interface AddTagsRequest { } export namespace AddTagsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: AddTagsRequest): any => ({ ...obj, }); @@ -52,6 +58,9 @@ export namespace AddTagsRequest { export interface AddTagsResponse {} export namespace AddTagsResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: AddTagsResponse): any => ({ ...obj, }); @@ -73,6 +82,9 @@ export interface CloudTrailARNInvalidException extends __SmithyException, $Metad } export namespace CloudTrailARNInvalidException { + /** + * @internal + */ export const filterSensitiveLog = (obj: CloudTrailARNInvalidException): any => ({ ...obj, }); @@ -92,6 +104,9 @@ export interface InvalidTagParameterException extends __SmithyException, $Metada } export namespace InvalidTagParameterException { + /** + * @internal + */ export const filterSensitiveLog = (obj: InvalidTagParameterException): any => ({ ...obj, }); @@ -128,6 +143,9 @@ export interface InvalidTrailNameException extends __SmithyException, $MetadataB } export namespace InvalidTrailNameException { + /** + * @internal + */ export const filterSensitiveLog = (obj: InvalidTrailNameException): any => ({ ...obj, }); @@ -148,6 +166,9 @@ export interface NotOrganizationMasterAccountException extends __SmithyException } export namespace NotOrganizationMasterAccountException { + /** + * @internal + */ export const filterSensitiveLog = (obj: NotOrganizationMasterAccountException): any => ({ ...obj, }); @@ -166,6 +187,9 @@ export interface OperationNotPermittedException extends __SmithyException, $Meta } export namespace OperationNotPermittedException { + /** + * @internal + */ export const filterSensitiveLog = (obj: OperationNotPermittedException): any => ({ ...obj, }); @@ -184,6 +208,9 @@ export interface ResourceNotFoundException extends __SmithyException, $MetadataB } export namespace ResourceNotFoundException { + /** + * @internal + */ export const filterSensitiveLog = (obj: ResourceNotFoundException): any => ({ ...obj, }); @@ -202,6 +229,9 @@ export interface ResourceTypeNotSupportedException extends __SmithyException, $M } export namespace ResourceTypeNotSupportedException { + /** + * @internal + */ export const filterSensitiveLog = (obj: ResourceTypeNotSupportedException): any => ({ ...obj, }); @@ -220,6 +250,9 @@ export interface TagsLimitExceededException extends __SmithyException, $Metadata } export namespace TagsLimitExceededException { + /** + * @internal + */ export const filterSensitiveLog = (obj: TagsLimitExceededException): any => ({ ...obj, }); @@ -238,6 +271,9 @@ export interface UnsupportedOperationException extends __SmithyException, $Metad } export namespace UnsupportedOperationException { + /** + * @internal + */ export const filterSensitiveLog = (obj: UnsupportedOperationException): any => ({ ...obj, }); @@ -381,6 +417,9 @@ export interface AdvancedFieldSelector { } export namespace AdvancedFieldSelector { + /** + * @internal + */ export const filterSensitiveLog = (obj: AdvancedFieldSelector): any => ({ ...obj, }); @@ -439,6 +478,9 @@ export interface AdvancedEventSelector { } export namespace AdvancedEventSelector { + /** + * @internal + */ export const filterSensitiveLog = (obj: AdvancedEventSelector): any => ({ ...obj, }); @@ -459,6 +501,9 @@ export interface CloudTrailAccessNotEnabledException extends __SmithyException, } export namespace CloudTrailAccessNotEnabledException { + /** + * @internal + */ export const filterSensitiveLog = (obj: CloudTrailAccessNotEnabledException): any => ({ ...obj, }); @@ -478,6 +523,9 @@ export interface CloudTrailInvalidClientTokenIdException extends __SmithyExcepti } export namespace CloudTrailInvalidClientTokenIdException { + /** + * @internal + */ export const filterSensitiveLog = (obj: CloudTrailInvalidClientTokenIdException): any => ({ ...obj, }); @@ -496,6 +544,9 @@ export interface CloudWatchLogsDeliveryUnavailableException extends __SmithyExce } export namespace CloudWatchLogsDeliveryUnavailableException { + /** + * @internal + */ export const filterSensitiveLog = (obj: CloudWatchLogsDeliveryUnavailableException): any => ({ ...obj, }); @@ -610,6 +661,9 @@ export interface CreateTrailRequest { } export namespace CreateTrailRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateTrailRequest): any => ({ ...obj, }); @@ -699,6 +753,9 @@ export interface CreateTrailResponse { } export namespace CreateTrailResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateTrailResponse): any => ({ ...obj, }); @@ -719,6 +776,9 @@ export interface InsufficientDependencyServiceAccessPermissionException extends } export namespace InsufficientDependencyServiceAccessPermissionException { + /** + * @internal + */ export const filterSensitiveLog = (obj: InsufficientDependencyServiceAccessPermissionException): any => ({ ...obj, }); @@ -737,6 +797,9 @@ export interface InsufficientEncryptionPolicyException extends __SmithyException } export namespace InsufficientEncryptionPolicyException { + /** + * @internal + */ export const filterSensitiveLog = (obj: InsufficientEncryptionPolicyException): any => ({ ...obj, }); @@ -755,6 +818,9 @@ export interface InsufficientS3BucketPolicyException extends __SmithyException, } export namespace InsufficientS3BucketPolicyException { + /** + * @internal + */ export const filterSensitiveLog = (obj: InsufficientS3BucketPolicyException): any => ({ ...obj, }); @@ -773,6 +839,9 @@ export interface InsufficientSnsTopicPolicyException extends __SmithyException, } export namespace InsufficientSnsTopicPolicyException { + /** + * @internal + */ export const filterSensitiveLog = (obj: InsufficientSnsTopicPolicyException): any => ({ ...obj, }); @@ -791,6 +860,9 @@ export interface InvalidCloudWatchLogsLogGroupArnException extends __SmithyExcep } export namespace InvalidCloudWatchLogsLogGroupArnException { + /** + * @internal + */ export const filterSensitiveLog = (obj: InvalidCloudWatchLogsLogGroupArnException): any => ({ ...obj, }); @@ -809,6 +881,9 @@ export interface InvalidCloudWatchLogsRoleArnException extends __SmithyException } export namespace InvalidCloudWatchLogsRoleArnException { + /** + * @internal + */ export const filterSensitiveLog = (obj: InvalidCloudWatchLogsRoleArnException): any => ({ ...obj, }); @@ -827,6 +902,9 @@ export interface InvalidKmsKeyIdException extends __SmithyException, $MetadataBe } export namespace InvalidKmsKeyIdException { + /** + * @internal + */ export const filterSensitiveLog = (obj: InvalidKmsKeyIdException): any => ({ ...obj, }); @@ -845,6 +923,9 @@ export interface InvalidParameterCombinationException extends __SmithyException, } export namespace InvalidParameterCombinationException { + /** + * @internal + */ export const filterSensitiveLog = (obj: InvalidParameterCombinationException): any => ({ ...obj, }); @@ -863,6 +944,9 @@ export interface InvalidS3BucketNameException extends __SmithyException, $Metada } export namespace InvalidS3BucketNameException { + /** + * @internal + */ export const filterSensitiveLog = (obj: InvalidS3BucketNameException): any => ({ ...obj, }); @@ -881,6 +965,9 @@ export interface InvalidS3PrefixException extends __SmithyException, $MetadataBe } export namespace InvalidS3PrefixException { + /** + * @internal + */ export const filterSensitiveLog = (obj: InvalidS3PrefixException): any => ({ ...obj, }); @@ -899,6 +986,9 @@ export interface InvalidSnsTopicNameException extends __SmithyException, $Metada } export namespace InvalidSnsTopicNameException { + /** + * @internal + */ export const filterSensitiveLog = (obj: InvalidSnsTopicNameException): any => ({ ...obj, }); @@ -917,6 +1007,9 @@ export interface KmsException extends __SmithyException, $MetadataBearer { } export namespace KmsException { + /** + * @internal + */ export const filterSensitiveLog = (obj: KmsException): any => ({ ...obj, }); @@ -937,6 +1030,9 @@ export interface KmsKeyDisabledException extends __SmithyException, $MetadataBea } export namespace KmsKeyDisabledException { + /** + * @internal + */ export const filterSensitiveLog = (obj: KmsKeyDisabledException): any => ({ ...obj, }); @@ -957,6 +1053,9 @@ export interface KmsKeyNotFoundException extends __SmithyException, $MetadataBea } export namespace KmsKeyNotFoundException { + /** + * @internal + */ export const filterSensitiveLog = (obj: KmsKeyNotFoundException): any => ({ ...obj, }); @@ -975,6 +1074,9 @@ export interface MaximumNumberOfTrailsExceededException extends __SmithyExceptio } export namespace MaximumNumberOfTrailsExceededException { + /** + * @internal + */ export const filterSensitiveLog = (obj: MaximumNumberOfTrailsExceededException): any => ({ ...obj, }); @@ -995,6 +1097,9 @@ export interface OrganizationNotInAllFeaturesModeException extends __SmithyExcep } export namespace OrganizationNotInAllFeaturesModeException { + /** + * @internal + */ export const filterSensitiveLog = (obj: OrganizationNotInAllFeaturesModeException): any => ({ ...obj, }); @@ -1014,6 +1119,9 @@ export interface OrganizationsNotInUseException extends __SmithyException, $Meta } export namespace OrganizationsNotInUseException { + /** + * @internal + */ export const filterSensitiveLog = (obj: OrganizationsNotInUseException): any => ({ ...obj, }); @@ -1032,6 +1140,9 @@ export interface S3BucketDoesNotExistException extends __SmithyException, $Metad } export namespace S3BucketDoesNotExistException { + /** + * @internal + */ export const filterSensitiveLog = (obj: S3BucketDoesNotExistException): any => ({ ...obj, }); @@ -1050,6 +1161,9 @@ export interface TrailAlreadyExistsException extends __SmithyException, $Metadat } export namespace TrailAlreadyExistsException { + /** + * @internal + */ export const filterSensitiveLog = (obj: TrailAlreadyExistsException): any => ({ ...obj, }); @@ -1068,6 +1182,9 @@ export interface TrailNotProvidedException extends __SmithyException, $MetadataB } export namespace TrailNotProvidedException { + /** + * @internal + */ export const filterSensitiveLog = (obj: TrailNotProvidedException): any => ({ ...obj, }); @@ -1088,6 +1205,9 @@ export interface ConflictException extends __SmithyException, $MetadataBearer { } export namespace ConflictException { + /** + * @internal + */ export const filterSensitiveLog = (obj: ConflictException): any => ({ ...obj, }); @@ -1107,6 +1227,9 @@ export interface DeleteTrailRequest { } export namespace DeleteTrailRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteTrailRequest): any => ({ ...obj, }); @@ -1118,6 +1241,9 @@ export namespace DeleteTrailRequest { export interface DeleteTrailResponse {} export namespace DeleteTrailResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteTrailResponse): any => ({ ...obj, }); @@ -1136,6 +1262,9 @@ export interface InvalidHomeRegionException extends __SmithyException, $Metadata } export namespace InvalidHomeRegionException { + /** + * @internal + */ export const filterSensitiveLog = (obj: InvalidHomeRegionException): any => ({ ...obj, }); @@ -1154,6 +1283,9 @@ export interface TrailNotFoundException extends __SmithyException, $MetadataBear } export namespace TrailNotFoundException { + /** + * @internal + */ export const filterSensitiveLog = (obj: TrailNotFoundException): any => ({ ...obj, }); @@ -1194,6 +1326,9 @@ export interface DescribeTrailsRequest { } export namespace DescribeTrailsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeTrailsRequest): any => ({ ...obj, }); @@ -1300,6 +1435,9 @@ export interface Trail { } export namespace Trail { + /** + * @internal + */ export const filterSensitiveLog = (obj: Trail): any => ({ ...obj, }); @@ -1318,6 +1456,9 @@ export interface DescribeTrailsResponse { } export namespace DescribeTrailsResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeTrailsResponse): any => ({ ...obj, }); @@ -1354,6 +1495,9 @@ export interface GetEventSelectorsRequest { } export namespace GetEventSelectorsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetEventSelectorsRequest): any => ({ ...obj, }); @@ -1464,6 +1608,9 @@ export interface DataResource { } export namespace DataResource { + /** + * @internal + */ export const filterSensitiveLog = (obj: DataResource): any => ({ ...obj, }); @@ -1523,6 +1670,9 @@ export interface EventSelector { } export namespace EventSelector { + /** + * @internal + */ export const filterSensitiveLog = (obj: EventSelector): any => ({ ...obj, }); @@ -1548,6 +1698,9 @@ export interface GetEventSelectorsResponse { } export namespace GetEventSelectorsResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetEventSelectorsResponse): any => ({ ...obj, }); @@ -1584,6 +1737,9 @@ export interface GetInsightSelectorsRequest { } export namespace GetInsightSelectorsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetInsightSelectorsRequest): any => ({ ...obj, }); @@ -1604,6 +1760,9 @@ export interface InsightSelector { } export namespace InsightSelector { + /** + * @internal + */ export const filterSensitiveLog = (obj: InsightSelector): any => ({ ...obj, }); @@ -1622,6 +1781,9 @@ export interface GetInsightSelectorsResponse { } export namespace GetInsightSelectorsResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetInsightSelectorsResponse): any => ({ ...obj, }); @@ -1640,6 +1802,9 @@ export interface InsightNotEnabledException extends __SmithyException, $Metadata } export namespace InsightNotEnabledException { + /** + * @internal + */ export const filterSensitiveLog = (obj: InsightNotEnabledException): any => ({ ...obj, }); @@ -1653,6 +1818,9 @@ export interface GetTrailRequest { } export namespace GetTrailRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetTrailRequest): any => ({ ...obj, }); @@ -1666,6 +1834,9 @@ export interface GetTrailResponse { } export namespace GetTrailResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetTrailResponse): any => ({ ...obj, }); @@ -1685,6 +1856,9 @@ export interface GetTrailStatusRequest { } export namespace GetTrailStatusRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetTrailStatusRequest): any => ({ ...obj, }); @@ -1799,6 +1973,9 @@ export interface GetTrailStatusResponse { } export namespace GetTrailStatusResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetTrailStatusResponse): any => ({ ...obj, }); @@ -1817,6 +1994,9 @@ export interface InvalidTimeRangeException extends __SmithyException, $MetadataB } export namespace InvalidTimeRangeException { + /** + * @internal + */ export const filterSensitiveLog = (obj: InvalidTimeRangeException): any => ({ ...obj, }); @@ -1835,6 +2015,9 @@ export interface InvalidTokenException extends __SmithyException, $MetadataBeare } export namespace InvalidTokenException { + /** + * @internal + */ export const filterSensitiveLog = (obj: InvalidTokenException): any => ({ ...obj, }); @@ -1861,6 +2044,9 @@ export interface ListPublicKeysRequest { } export namespace ListPublicKeysRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListPublicKeysRequest): any => ({ ...obj, }); @@ -1892,6 +2078,9 @@ export interface PublicKey { } export namespace PublicKey { + /** + * @internal + */ export const filterSensitiveLog = (obj: PublicKey): any => ({ ...obj, }); @@ -1916,6 +2105,9 @@ export interface ListPublicKeysResponse { } export namespace ListPublicKeysResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListPublicKeysResponse): any => ({ ...obj, }); @@ -1940,6 +2132,9 @@ export interface ListTagsRequest { } export namespace ListTagsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListTagsRequest): any => ({ ...obj, }); @@ -1961,6 +2156,9 @@ export interface ResourceTag { } export namespace ResourceTag { + /** + * @internal + */ export const filterSensitiveLog = (obj: ResourceTag): any => ({ ...obj, }); @@ -1982,6 +2180,9 @@ export interface ListTagsResponse { } export namespace ListTagsResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListTagsResponse): any => ({ ...obj, }); @@ -1998,6 +2199,9 @@ export interface ListTrailsRequest { } export namespace ListTrailsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListTrailsRequest): any => ({ ...obj, }); @@ -2024,6 +2228,9 @@ export interface TrailInfo { } export namespace TrailInfo { + /** + * @internal + */ export const filterSensitiveLog = (obj: TrailInfo): any => ({ ...obj, }); @@ -2045,6 +2252,9 @@ export interface ListTrailsResponse { } export namespace ListTrailsResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListTrailsResponse): any => ({ ...obj, }); @@ -2063,6 +2273,9 @@ export interface InvalidEventCategoryException extends __SmithyException, $Metad } export namespace InvalidEventCategoryException { + /** + * @internal + */ export const filterSensitiveLog = (obj: InvalidEventCategoryException): any => ({ ...obj, }); @@ -2081,6 +2294,9 @@ export interface InvalidLookupAttributesException extends __SmithyException, $Me } export namespace InvalidLookupAttributesException { + /** + * @internal + */ export const filterSensitiveLog = (obj: InvalidLookupAttributesException): any => ({ ...obj, }); @@ -2099,6 +2315,9 @@ export interface InvalidMaxResultsException extends __SmithyException, $Metadata } export namespace InvalidMaxResultsException { + /** + * @internal + */ export const filterSensitiveLog = (obj: InvalidMaxResultsException): any => ({ ...obj, }); @@ -2117,6 +2336,9 @@ export interface InvalidNextTokenException extends __SmithyException, $MetadataB } export namespace InvalidNextTokenException { + /** + * @internal + */ export const filterSensitiveLog = (obj: InvalidNextTokenException): any => ({ ...obj, }); @@ -2153,6 +2375,9 @@ export interface LookupAttribute { } export namespace LookupAttribute { + /** + * @internal + */ export const filterSensitiveLog = (obj: LookupAttribute): any => ({ ...obj, }); @@ -2196,6 +2421,9 @@ export interface LookupEventsRequest { } export namespace LookupEventsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: LookupEventsRequest): any => ({ ...obj, }); @@ -2220,6 +2448,9 @@ export interface Resource { } export namespace Resource { + /** + * @internal + */ export const filterSensitiveLog = (obj: Resource): any => ({ ...obj, }); @@ -2277,6 +2508,9 @@ export interface Event { } export namespace Event { + /** + * @internal + */ export const filterSensitiveLog = (obj: Event): any => ({ ...obj, }); @@ -2301,6 +2535,9 @@ export interface LookupEventsResponse { } export namespace LookupEventsResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: LookupEventsResponse): any => ({ ...obj, }); @@ -2341,6 +2578,9 @@ export interface InvalidEventSelectorsException extends __SmithyException, $Meta } export namespace InvalidEventSelectorsException { + /** + * @internal + */ export const filterSensitiveLog = (obj: InvalidEventSelectorsException): any => ({ ...obj, }); @@ -2397,6 +2637,9 @@ export interface PutEventSelectorsRequest { } export namespace PutEventSelectorsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: PutEventSelectorsRequest): any => ({ ...obj, }); @@ -2424,6 +2667,9 @@ export interface PutEventSelectorsResponse { } export namespace PutEventSelectorsResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: PutEventSelectorsResponse): any => ({ ...obj, }); @@ -2443,6 +2689,9 @@ export interface InvalidInsightSelectorsException extends __SmithyException, $Me } export namespace InvalidInsightSelectorsException { + /** + * @internal + */ export const filterSensitiveLog = (obj: InvalidInsightSelectorsException): any => ({ ...obj, }); @@ -2461,6 +2710,9 @@ export interface PutInsightSelectorsRequest { } export namespace PutInsightSelectorsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: PutInsightSelectorsRequest): any => ({ ...obj, }); @@ -2479,6 +2731,9 @@ export interface PutInsightSelectorsResponse { } export namespace PutInsightSelectorsResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: PutInsightSelectorsResponse): any => ({ ...obj, }); @@ -2503,6 +2758,9 @@ export interface RemoveTagsRequest { } export namespace RemoveTagsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: RemoveTagsRequest): any => ({ ...obj, }); @@ -2514,6 +2772,9 @@ export namespace RemoveTagsRequest { export interface RemoveTagsResponse {} export namespace RemoveTagsResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: RemoveTagsResponse): any => ({ ...obj, }); @@ -2533,6 +2794,9 @@ export interface StartLoggingRequest { } export namespace StartLoggingRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: StartLoggingRequest): any => ({ ...obj, }); @@ -2544,6 +2808,9 @@ export namespace StartLoggingRequest { export interface StartLoggingResponse {} export namespace StartLoggingResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: StartLoggingResponse): any => ({ ...obj, }); @@ -2563,6 +2830,9 @@ export interface StopLoggingRequest { } export namespace StopLoggingRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: StopLoggingRequest): any => ({ ...obj, }); @@ -2574,6 +2844,9 @@ export namespace StopLoggingRequest { export interface StopLoggingResponse {} export namespace StopLoggingResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: StopLoggingResponse): any => ({ ...obj, }); @@ -2691,6 +2964,9 @@ export interface UpdateTrailRequest { } export namespace UpdateTrailRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateTrailRequest): any => ({ ...obj, }); @@ -2782,6 +3058,9 @@ export interface UpdateTrailResponse { } export namespace UpdateTrailResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateTrailResponse): any => ({ ...obj, }); diff --git a/clients/client-cloudwatch-events/commands/ActivateEventSourceCommand.ts b/clients/client-cloudwatch-events/commands/ActivateEventSourceCommand.ts index 89ddaf4eb7d7..67796817669d 100644 --- a/clients/client-cloudwatch-events/commands/ActivateEventSourceCommand.ts +++ b/clients/client-cloudwatch-events/commands/ActivateEventSourceCommand.ts @@ -23,6 +23,20 @@ export interface ActivateEventSourceCommandOutput extends __MetadataBearer {} /** *

Activates a partner event source that has been deactivated. Once activated, your matching * event bus will start receiving events from the event source.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { CloudWatchEventsClient, ActivateEventSourceCommand } from "@aws-sdk/client-cloudwatch-events"; // ES Modules import + * // const { CloudWatchEventsClient, ActivateEventSourceCommand } = require("@aws-sdk/client-cloudwatch-events"); // CommonJS import + * const client = new CloudWatchEventsClient(config); + * const command = new ActivateEventSourceCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ActivateEventSourceCommandInput} for command's `input` shape. + * @see {@link ActivateEventSourceCommandOutput} for command's `response` shape. + * @see {@link CloudWatchEventsClientResolvedConfig | config} for command's `input` shape. + * */ export class ActivateEventSourceCommand extends $Command< ActivateEventSourceCommandInput, diff --git a/clients/client-cloudwatch-events/commands/CancelReplayCommand.ts b/clients/client-cloudwatch-events/commands/CancelReplayCommand.ts index 53baa54dde0e..349228a55028 100644 --- a/clients/client-cloudwatch-events/commands/CancelReplayCommand.ts +++ b/clients/client-cloudwatch-events/commands/CancelReplayCommand.ts @@ -22,6 +22,20 @@ export interface CancelReplayCommandOutput extends CancelReplayResponse, __Metad /** *

Cancels the specified replay.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { CloudWatchEventsClient, CancelReplayCommand } from "@aws-sdk/client-cloudwatch-events"; // ES Modules import + * // const { CloudWatchEventsClient, CancelReplayCommand } = require("@aws-sdk/client-cloudwatch-events"); // CommonJS import + * const client = new CloudWatchEventsClient(config); + * const command = new CancelReplayCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CancelReplayCommandInput} for command's `input` shape. + * @see {@link CancelReplayCommandOutput} for command's `response` shape. + * @see {@link CloudWatchEventsClientResolvedConfig | config} for command's `input` shape. + * */ export class CancelReplayCommand extends $Command< CancelReplayCommandInput, diff --git a/clients/client-cloudwatch-events/commands/CreateApiDestinationCommand.ts b/clients/client-cloudwatch-events/commands/CreateApiDestinationCommand.ts index 95862ab2a400..9a923ccc1fdd 100644 --- a/clients/client-cloudwatch-events/commands/CreateApiDestinationCommand.ts +++ b/clients/client-cloudwatch-events/commands/CreateApiDestinationCommand.ts @@ -23,6 +23,20 @@ export interface CreateApiDestinationCommandOutput extends CreateApiDestinationR /** *

Creates an API destination, which is an HTTP invocation endpoint configured as a target * for events.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { CloudWatchEventsClient, CreateApiDestinationCommand } from "@aws-sdk/client-cloudwatch-events"; // ES Modules import + * // const { CloudWatchEventsClient, CreateApiDestinationCommand } = require("@aws-sdk/client-cloudwatch-events"); // CommonJS import + * const client = new CloudWatchEventsClient(config); + * const command = new CreateApiDestinationCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreateApiDestinationCommandInput} for command's `input` shape. + * @see {@link CreateApiDestinationCommandOutput} for command's `response` shape. + * @see {@link CloudWatchEventsClientResolvedConfig | config} for command's `input` shape. + * */ export class CreateApiDestinationCommand extends $Command< CreateApiDestinationCommandInput, diff --git a/clients/client-cloudwatch-events/commands/CreateArchiveCommand.ts b/clients/client-cloudwatch-events/commands/CreateArchiveCommand.ts index a1cadcbc93cc..3598ea1d4874 100644 --- a/clients/client-cloudwatch-events/commands/CreateArchiveCommand.ts +++ b/clients/client-cloudwatch-events/commands/CreateArchiveCommand.ts @@ -26,6 +26,20 @@ export interface CreateArchiveCommandOutput extends CreateArchiveResponse, __Met * 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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { CloudWatchEventsClient, CreateArchiveCommand } from "@aws-sdk/client-cloudwatch-events"; // ES Modules import + * // const { CloudWatchEventsClient, CreateArchiveCommand } = require("@aws-sdk/client-cloudwatch-events"); // CommonJS import + * const client = new CloudWatchEventsClient(config); + * const command = new CreateArchiveCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreateArchiveCommandInput} for command's `input` shape. + * @see {@link CreateArchiveCommandOutput} for command's `response` shape. + * @see {@link CloudWatchEventsClientResolvedConfig | config} for command's `input` shape. + * */ export class CreateArchiveCommand extends $Command< CreateArchiveCommandInput, diff --git a/clients/client-cloudwatch-events/commands/CreateConnectionCommand.ts b/clients/client-cloudwatch-events/commands/CreateConnectionCommand.ts index 1e3ff1750d7e..5ee9b7ca94d9 100644 --- a/clients/client-cloudwatch-events/commands/CreateConnectionCommand.ts +++ b/clients/client-cloudwatch-events/commands/CreateConnectionCommand.ts @@ -23,6 +23,20 @@ export interface CreateConnectionCommandOutput extends CreateConnectionResponse, /** *

Creates a connection. A connection defines the authorization type and credentials to use * for authorization with an API destination HTTP endpoint.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { CloudWatchEventsClient, CreateConnectionCommand } from "@aws-sdk/client-cloudwatch-events"; // ES Modules import + * // const { CloudWatchEventsClient, CreateConnectionCommand } = require("@aws-sdk/client-cloudwatch-events"); // CommonJS import + * const client = new CloudWatchEventsClient(config); + * const command = new CreateConnectionCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreateConnectionCommandInput} for command's `input` shape. + * @see {@link CreateConnectionCommandOutput} for command's `response` shape. + * @see {@link CloudWatchEventsClientResolvedConfig | config} for command's `input` shape. + * */ export class CreateConnectionCommand extends $Command< CreateConnectionCommandInput, diff --git a/clients/client-cloudwatch-events/commands/CreateEventBusCommand.ts b/clients/client-cloudwatch-events/commands/CreateEventBusCommand.ts index f9a0e510833f..285e68d90abc 100644 --- a/clients/client-cloudwatch-events/commands/CreateEventBusCommand.ts +++ b/clients/client-cloudwatch-events/commands/CreateEventBusCommand.ts @@ -24,6 +24,20 @@ export interface CreateEventBusCommandOutput extends CreateEventBusResponse, __M *

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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { CloudWatchEventsClient, CreateEventBusCommand } from "@aws-sdk/client-cloudwatch-events"; // ES Modules import + * // const { CloudWatchEventsClient, CreateEventBusCommand } = require("@aws-sdk/client-cloudwatch-events"); // CommonJS import + * const client = new CloudWatchEventsClient(config); + * const command = new CreateEventBusCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreateEventBusCommandInput} for command's `input` shape. + * @see {@link CreateEventBusCommandOutput} for command's `response` shape. + * @see {@link CloudWatchEventsClientResolvedConfig | config} for command's `input` shape. + * */ export class CreateEventBusCommand extends $Command< CreateEventBusCommandInput, diff --git a/clients/client-cloudwatch-events/commands/CreatePartnerEventSourceCommand.ts b/clients/client-cloudwatch-events/commands/CreatePartnerEventSourceCommand.ts index 34b6a59f6165..b726ee37460c 100644 --- a/clients/client-cloudwatch-events/commands/CreatePartnerEventSourceCommand.ts +++ b/clients/client-cloudwatch-events/commands/CreatePartnerEventSourceCommand.ts @@ -45,6 +45,20 @@ export interface CreatePartnerEventSourceCommandOutput extends CreatePartnerEven * an event-generating resource within the partner system. The combination of * event_namespace and event_name should help AWS * customers decide whether to create an event bus to receive these events.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { CloudWatchEventsClient, CreatePartnerEventSourceCommand } from "@aws-sdk/client-cloudwatch-events"; // ES Modules import + * // const { CloudWatchEventsClient, CreatePartnerEventSourceCommand } = require("@aws-sdk/client-cloudwatch-events"); // CommonJS import + * const client = new CloudWatchEventsClient(config); + * const command = new CreatePartnerEventSourceCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreatePartnerEventSourceCommandInput} for command's `input` shape. + * @see {@link CreatePartnerEventSourceCommandOutput} for command's `response` shape. + * @see {@link CloudWatchEventsClientResolvedConfig | config} for command's `input` shape. + * */ export class CreatePartnerEventSourceCommand extends $Command< CreatePartnerEventSourceCommandInput, diff --git a/clients/client-cloudwatch-events/commands/DeactivateEventSourceCommand.ts b/clients/client-cloudwatch-events/commands/DeactivateEventSourceCommand.ts index 4e87c130d3d2..e5f6196c465f 100644 --- a/clients/client-cloudwatch-events/commands/DeactivateEventSourceCommand.ts +++ b/clients/client-cloudwatch-events/commands/DeactivateEventSourceCommand.ts @@ -26,6 +26,20 @@ export interface DeactivateEventSourceCommandOutput extends __MetadataBearer {} *

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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { CloudWatchEventsClient, DeactivateEventSourceCommand } from "@aws-sdk/client-cloudwatch-events"; // ES Modules import + * // const { CloudWatchEventsClient, DeactivateEventSourceCommand } = require("@aws-sdk/client-cloudwatch-events"); // CommonJS import + * const client = new CloudWatchEventsClient(config); + * const command = new DeactivateEventSourceCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeactivateEventSourceCommandInput} for command's `input` shape. + * @see {@link DeactivateEventSourceCommandOutput} for command's `response` shape. + * @see {@link CloudWatchEventsClientResolvedConfig | config} for command's `input` shape. + * */ export class DeactivateEventSourceCommand extends $Command< DeactivateEventSourceCommandInput, diff --git a/clients/client-cloudwatch-events/commands/DeauthorizeConnectionCommand.ts b/clients/client-cloudwatch-events/commands/DeauthorizeConnectionCommand.ts index 013edd84ffa0..45060d7ae24a 100644 --- a/clients/client-cloudwatch-events/commands/DeauthorizeConnectionCommand.ts +++ b/clients/client-cloudwatch-events/commands/DeauthorizeConnectionCommand.ts @@ -23,6 +23,20 @@ export interface DeauthorizeConnectionCommandOutput extends DeauthorizeConnectio /** *

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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { CloudWatchEventsClient, DeauthorizeConnectionCommand } from "@aws-sdk/client-cloudwatch-events"; // ES Modules import + * // const { CloudWatchEventsClient, DeauthorizeConnectionCommand } = require("@aws-sdk/client-cloudwatch-events"); // CommonJS import + * const client = new CloudWatchEventsClient(config); + * const command = new DeauthorizeConnectionCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeauthorizeConnectionCommandInput} for command's `input` shape. + * @see {@link DeauthorizeConnectionCommandOutput} for command's `response` shape. + * @see {@link CloudWatchEventsClientResolvedConfig | config} for command's `input` shape. + * */ export class DeauthorizeConnectionCommand extends $Command< DeauthorizeConnectionCommandInput, diff --git a/clients/client-cloudwatch-events/commands/DeleteApiDestinationCommand.ts b/clients/client-cloudwatch-events/commands/DeleteApiDestinationCommand.ts index b98cfa09331b..f95ff7bf90e8 100644 --- a/clients/client-cloudwatch-events/commands/DeleteApiDestinationCommand.ts +++ b/clients/client-cloudwatch-events/commands/DeleteApiDestinationCommand.ts @@ -22,6 +22,20 @@ export interface DeleteApiDestinationCommandOutput extends DeleteApiDestinationR /** *

Deletes the specified API destination.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { CloudWatchEventsClient, DeleteApiDestinationCommand } from "@aws-sdk/client-cloudwatch-events"; // ES Modules import + * // const { CloudWatchEventsClient, DeleteApiDestinationCommand } = require("@aws-sdk/client-cloudwatch-events"); // CommonJS import + * const client = new CloudWatchEventsClient(config); + * const command = new DeleteApiDestinationCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteApiDestinationCommandInput} for command's `input` shape. + * @see {@link DeleteApiDestinationCommandOutput} for command's `response` shape. + * @see {@link CloudWatchEventsClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteApiDestinationCommand extends $Command< DeleteApiDestinationCommandInput, diff --git a/clients/client-cloudwatch-events/commands/DeleteArchiveCommand.ts b/clients/client-cloudwatch-events/commands/DeleteArchiveCommand.ts index a46338beec69..35ec3009920c 100644 --- a/clients/client-cloudwatch-events/commands/DeleteArchiveCommand.ts +++ b/clients/client-cloudwatch-events/commands/DeleteArchiveCommand.ts @@ -22,6 +22,20 @@ export interface DeleteArchiveCommandOutput extends DeleteArchiveResponse, __Met /** *

Deletes the specified archive.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { CloudWatchEventsClient, DeleteArchiveCommand } from "@aws-sdk/client-cloudwatch-events"; // ES Modules import + * // const { CloudWatchEventsClient, DeleteArchiveCommand } = require("@aws-sdk/client-cloudwatch-events"); // CommonJS import + * const client = new CloudWatchEventsClient(config); + * const command = new DeleteArchiveCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteArchiveCommandInput} for command's `input` shape. + * @see {@link DeleteArchiveCommandOutput} for command's `response` shape. + * @see {@link CloudWatchEventsClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteArchiveCommand extends $Command< DeleteArchiveCommandInput, diff --git a/clients/client-cloudwatch-events/commands/DeleteConnectionCommand.ts b/clients/client-cloudwatch-events/commands/DeleteConnectionCommand.ts index e3a9f4f19014..178e4f567eee 100644 --- a/clients/client-cloudwatch-events/commands/DeleteConnectionCommand.ts +++ b/clients/client-cloudwatch-events/commands/DeleteConnectionCommand.ts @@ -22,6 +22,20 @@ export interface DeleteConnectionCommandOutput extends DeleteConnectionResponse, /** *

Deletes a connection.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { CloudWatchEventsClient, DeleteConnectionCommand } from "@aws-sdk/client-cloudwatch-events"; // ES Modules import + * // const { CloudWatchEventsClient, DeleteConnectionCommand } = require("@aws-sdk/client-cloudwatch-events"); // CommonJS import + * const client = new CloudWatchEventsClient(config); + * const command = new DeleteConnectionCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteConnectionCommandInput} for command's `input` shape. + * @see {@link DeleteConnectionCommandOutput} for command's `response` shape. + * @see {@link CloudWatchEventsClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteConnectionCommand extends $Command< DeleteConnectionCommandInput, diff --git a/clients/client-cloudwatch-events/commands/DeleteEventBusCommand.ts b/clients/client-cloudwatch-events/commands/DeleteEventBusCommand.ts index ab596ca0e241..ee6d882e94c0 100644 --- a/clients/client-cloudwatch-events/commands/DeleteEventBusCommand.ts +++ b/clients/client-cloudwatch-events/commands/DeleteEventBusCommand.ts @@ -23,6 +23,20 @@ export interface DeleteEventBusCommandOutput extends __MetadataBearer {} /** *

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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { CloudWatchEventsClient, DeleteEventBusCommand } from "@aws-sdk/client-cloudwatch-events"; // ES Modules import + * // const { CloudWatchEventsClient, DeleteEventBusCommand } = require("@aws-sdk/client-cloudwatch-events"); // CommonJS import + * const client = new CloudWatchEventsClient(config); + * const command = new DeleteEventBusCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteEventBusCommandInput} for command's `input` shape. + * @see {@link DeleteEventBusCommandOutput} for command's `response` shape. + * @see {@link CloudWatchEventsClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteEventBusCommand extends $Command< DeleteEventBusCommandInput, diff --git a/clients/client-cloudwatch-events/commands/DeletePartnerEventSourceCommand.ts b/clients/client-cloudwatch-events/commands/DeletePartnerEventSourceCommand.ts index 2b604ce8c06c..1a7a86f2df92 100644 --- a/clients/client-cloudwatch-events/commands/DeletePartnerEventSourceCommand.ts +++ b/clients/client-cloudwatch-events/commands/DeletePartnerEventSourceCommand.ts @@ -26,6 +26,20 @@ export interface DeletePartnerEventSourceCommandOutput extends __MetadataBearer *

When you delete an event source, the status of the corresponding partner event bus in the * AWS customer account becomes DELETED.

*

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { CloudWatchEventsClient, DeletePartnerEventSourceCommand } from "@aws-sdk/client-cloudwatch-events"; // ES Modules import + * // const { CloudWatchEventsClient, DeletePartnerEventSourceCommand } = require("@aws-sdk/client-cloudwatch-events"); // CommonJS import + * const client = new CloudWatchEventsClient(config); + * const command = new DeletePartnerEventSourceCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeletePartnerEventSourceCommandInput} for command's `input` shape. + * @see {@link DeletePartnerEventSourceCommandOutput} for command's `response` shape. + * @see {@link CloudWatchEventsClientResolvedConfig | config} for command's `input` shape. + * */ export class DeletePartnerEventSourceCommand extends $Command< DeletePartnerEventSourceCommandInput, diff --git a/clients/client-cloudwatch-events/commands/DeleteRuleCommand.ts b/clients/client-cloudwatch-events/commands/DeleteRuleCommand.ts index 9b23c36dfcc1..2714df16a86d 100644 --- a/clients/client-cloudwatch-events/commands/DeleteRuleCommand.ts +++ b/clients/client-cloudwatch-events/commands/DeleteRuleCommand.ts @@ -31,6 +31,20 @@ export interface DeleteRuleCommandOutput extends __MetadataBearer {} * rules are created by those other AWS 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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { CloudWatchEventsClient, DeleteRuleCommand } from "@aws-sdk/client-cloudwatch-events"; // ES Modules import + * // const { CloudWatchEventsClient, DeleteRuleCommand } = require("@aws-sdk/client-cloudwatch-events"); // CommonJS import + * const client = new CloudWatchEventsClient(config); + * const command = new DeleteRuleCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteRuleCommandInput} for command's `input` shape. + * @see {@link DeleteRuleCommandOutput} for command's `response` shape. + * @see {@link CloudWatchEventsClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteRuleCommand extends $Command< DeleteRuleCommandInput, diff --git a/clients/client-cloudwatch-events/commands/DescribeApiDestinationCommand.ts b/clients/client-cloudwatch-events/commands/DescribeApiDestinationCommand.ts index 94c43898e789..e0e7abc956c7 100644 --- a/clients/client-cloudwatch-events/commands/DescribeApiDestinationCommand.ts +++ b/clients/client-cloudwatch-events/commands/DescribeApiDestinationCommand.ts @@ -22,6 +22,20 @@ export interface DescribeApiDestinationCommandOutput extends DescribeApiDestinat /** *

Retrieves details about an API destination.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { CloudWatchEventsClient, DescribeApiDestinationCommand } from "@aws-sdk/client-cloudwatch-events"; // ES Modules import + * // const { CloudWatchEventsClient, DescribeApiDestinationCommand } = require("@aws-sdk/client-cloudwatch-events"); // CommonJS import + * const client = new CloudWatchEventsClient(config); + * const command = new DescribeApiDestinationCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeApiDestinationCommandInput} for command's `input` shape. + * @see {@link DescribeApiDestinationCommandOutput} for command's `response` shape. + * @see {@link CloudWatchEventsClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeApiDestinationCommand extends $Command< DescribeApiDestinationCommandInput, diff --git a/clients/client-cloudwatch-events/commands/DescribeArchiveCommand.ts b/clients/client-cloudwatch-events/commands/DescribeArchiveCommand.ts index 65d55bc60a02..2cadbbbc6c27 100644 --- a/clients/client-cloudwatch-events/commands/DescribeArchiveCommand.ts +++ b/clients/client-cloudwatch-events/commands/DescribeArchiveCommand.ts @@ -22,6 +22,20 @@ export interface DescribeArchiveCommandOutput extends DescribeArchiveResponse, _ /** *

Retrieves details about an archive.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { CloudWatchEventsClient, DescribeArchiveCommand } from "@aws-sdk/client-cloudwatch-events"; // ES Modules import + * // const { CloudWatchEventsClient, DescribeArchiveCommand } = require("@aws-sdk/client-cloudwatch-events"); // CommonJS import + * const client = new CloudWatchEventsClient(config); + * const command = new DescribeArchiveCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeArchiveCommandInput} for command's `input` shape. + * @see {@link DescribeArchiveCommandOutput} for command's `response` shape. + * @see {@link CloudWatchEventsClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeArchiveCommand extends $Command< DescribeArchiveCommandInput, diff --git a/clients/client-cloudwatch-events/commands/DescribeConnectionCommand.ts b/clients/client-cloudwatch-events/commands/DescribeConnectionCommand.ts index 67d9df767048..6fefd65d87c0 100644 --- a/clients/client-cloudwatch-events/commands/DescribeConnectionCommand.ts +++ b/clients/client-cloudwatch-events/commands/DescribeConnectionCommand.ts @@ -22,6 +22,20 @@ export interface DescribeConnectionCommandOutput extends DescribeConnectionRespo /** *

Retrieves details about a connection.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { CloudWatchEventsClient, DescribeConnectionCommand } from "@aws-sdk/client-cloudwatch-events"; // ES Modules import + * // const { CloudWatchEventsClient, DescribeConnectionCommand } = require("@aws-sdk/client-cloudwatch-events"); // CommonJS import + * const client = new CloudWatchEventsClient(config); + * const command = new DescribeConnectionCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeConnectionCommandInput} for command's `input` shape. + * @see {@link DescribeConnectionCommandOutput} for command's `response` shape. + * @see {@link CloudWatchEventsClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeConnectionCommand extends $Command< DescribeConnectionCommandInput, diff --git a/clients/client-cloudwatch-events/commands/DescribeEventBusCommand.ts b/clients/client-cloudwatch-events/commands/DescribeEventBusCommand.ts index 47533a1cbf51..98c61972d8c7 100644 --- a/clients/client-cloudwatch-events/commands/DescribeEventBusCommand.ts +++ b/clients/client-cloudwatch-events/commands/DescribeEventBusCommand.ts @@ -28,6 +28,20 @@ export interface DescribeEventBusCommandOutput extends DescribeEventBusResponse, *

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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { CloudWatchEventsClient, DescribeEventBusCommand } from "@aws-sdk/client-cloudwatch-events"; // ES Modules import + * // const { CloudWatchEventsClient, DescribeEventBusCommand } = require("@aws-sdk/client-cloudwatch-events"); // CommonJS import + * const client = new CloudWatchEventsClient(config); + * const command = new DescribeEventBusCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeEventBusCommandInput} for command's `input` shape. + * @see {@link DescribeEventBusCommandOutput} for command's `response` shape. + * @see {@link CloudWatchEventsClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeEventBusCommand extends $Command< DescribeEventBusCommandInput, diff --git a/clients/client-cloudwatch-events/commands/DescribeEventSourceCommand.ts b/clients/client-cloudwatch-events/commands/DescribeEventSourceCommand.ts index 3eca5a3f50e4..9cf9bb66d72f 100644 --- a/clients/client-cloudwatch-events/commands/DescribeEventSourceCommand.ts +++ b/clients/client-cloudwatch-events/commands/DescribeEventSourceCommand.ts @@ -23,6 +23,20 @@ export interface DescribeEventSourceCommandOutput extends DescribeEventSourceRes /** *

This operation lists details about a partner event source that is shared with your * account.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { CloudWatchEventsClient, DescribeEventSourceCommand } from "@aws-sdk/client-cloudwatch-events"; // ES Modules import + * // const { CloudWatchEventsClient, DescribeEventSourceCommand } = require("@aws-sdk/client-cloudwatch-events"); // CommonJS import + * const client = new CloudWatchEventsClient(config); + * const command = new DescribeEventSourceCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeEventSourceCommandInput} for command's `input` shape. + * @see {@link DescribeEventSourceCommandOutput} for command's `response` shape. + * @see {@link CloudWatchEventsClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeEventSourceCommand extends $Command< DescribeEventSourceCommandInput, diff --git a/clients/client-cloudwatch-events/commands/DescribePartnerEventSourceCommand.ts b/clients/client-cloudwatch-events/commands/DescribePartnerEventSourceCommand.ts index 02080cae23f1..0301bd5baa8d 100644 --- a/clients/client-cloudwatch-events/commands/DescribePartnerEventSourceCommand.ts +++ b/clients/client-cloudwatch-events/commands/DescribePartnerEventSourceCommand.ts @@ -25,6 +25,20 @@ export interface DescribePartnerEventSourceCommandOutput extends DescribePartner * they have created. AWS customers do not use this operation. Instead, AWS customers can use * DescribeEventSource to see details about a partner event source that is * shared with them.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { CloudWatchEventsClient, DescribePartnerEventSourceCommand } from "@aws-sdk/client-cloudwatch-events"; // ES Modules import + * // const { CloudWatchEventsClient, DescribePartnerEventSourceCommand } = require("@aws-sdk/client-cloudwatch-events"); // CommonJS import + * const client = new CloudWatchEventsClient(config); + * const command = new DescribePartnerEventSourceCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribePartnerEventSourceCommandInput} for command's `input` shape. + * @see {@link DescribePartnerEventSourceCommandOutput} for command's `response` shape. + * @see {@link CloudWatchEventsClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribePartnerEventSourceCommand extends $Command< DescribePartnerEventSourceCommandInput, diff --git a/clients/client-cloudwatch-events/commands/DescribeReplayCommand.ts b/clients/client-cloudwatch-events/commands/DescribeReplayCommand.ts index 9c9347076233..398658b5e284 100644 --- a/clients/client-cloudwatch-events/commands/DescribeReplayCommand.ts +++ b/clients/client-cloudwatch-events/commands/DescribeReplayCommand.ts @@ -30,6 +30,20 @@ export interface DescribeReplayCommandOutput extends DescribeReplayResponse, __M * 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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { CloudWatchEventsClient, DescribeReplayCommand } from "@aws-sdk/client-cloudwatch-events"; // ES Modules import + * // const { CloudWatchEventsClient, DescribeReplayCommand } = require("@aws-sdk/client-cloudwatch-events"); // CommonJS import + * const client = new CloudWatchEventsClient(config); + * const command = new DescribeReplayCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeReplayCommandInput} for command's `input` shape. + * @see {@link DescribeReplayCommandOutput} for command's `response` shape. + * @see {@link CloudWatchEventsClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeReplayCommand extends $Command< DescribeReplayCommandInput, diff --git a/clients/client-cloudwatch-events/commands/DescribeRuleCommand.ts b/clients/client-cloudwatch-events/commands/DescribeRuleCommand.ts index c60617873f14..6c72991e0ea6 100644 --- a/clients/client-cloudwatch-events/commands/DescribeRuleCommand.ts +++ b/clients/client-cloudwatch-events/commands/DescribeRuleCommand.ts @@ -24,6 +24,20 @@ export interface DescribeRuleCommandOutput extends DescribeRuleResponse, __Metad *

Describes the specified rule.

*

DescribeRule does not list the targets of a rule. To see the targets associated with a * rule, use ListTargetsByRule.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { CloudWatchEventsClient, DescribeRuleCommand } from "@aws-sdk/client-cloudwatch-events"; // ES Modules import + * // const { CloudWatchEventsClient, DescribeRuleCommand } = require("@aws-sdk/client-cloudwatch-events"); // CommonJS import + * const client = new CloudWatchEventsClient(config); + * const command = new DescribeRuleCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeRuleCommandInput} for command's `input` shape. + * @see {@link DescribeRuleCommandOutput} for command's `response` shape. + * @see {@link CloudWatchEventsClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeRuleCommand extends $Command< DescribeRuleCommandInput, diff --git a/clients/client-cloudwatch-events/commands/DisableRuleCommand.ts b/clients/client-cloudwatch-events/commands/DisableRuleCommand.ts index 9b6370343a43..6f064f5f358a 100644 --- a/clients/client-cloudwatch-events/commands/DisableRuleCommand.ts +++ b/clients/client-cloudwatch-events/commands/DisableRuleCommand.ts @@ -26,6 +26,20 @@ export interface DisableRuleCommandOutput extends __MetadataBearer {} * *

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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { CloudWatchEventsClient, DisableRuleCommand } from "@aws-sdk/client-cloudwatch-events"; // ES Modules import + * // const { CloudWatchEventsClient, DisableRuleCommand } = require("@aws-sdk/client-cloudwatch-events"); // CommonJS import + * const client = new CloudWatchEventsClient(config); + * const command = new DisableRuleCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DisableRuleCommandInput} for command's `input` shape. + * @see {@link DisableRuleCommandOutput} for command's `response` shape. + * @see {@link CloudWatchEventsClientResolvedConfig | config} for command's `input` shape. + * */ export class DisableRuleCommand extends $Command< DisableRuleCommandInput, diff --git a/clients/client-cloudwatch-events/commands/EnableRuleCommand.ts b/clients/client-cloudwatch-events/commands/EnableRuleCommand.ts index cd297a02cf6a..5a882bc86bb4 100644 --- a/clients/client-cloudwatch-events/commands/EnableRuleCommand.ts +++ b/clients/client-cloudwatch-events/commands/EnableRuleCommand.ts @@ -25,6 +25,20 @@ export interface EnableRuleCommandOutput extends __MetadataBearer {} * *

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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { CloudWatchEventsClient, EnableRuleCommand } from "@aws-sdk/client-cloudwatch-events"; // ES Modules import + * // const { CloudWatchEventsClient, EnableRuleCommand } = require("@aws-sdk/client-cloudwatch-events"); // CommonJS import + * const client = new CloudWatchEventsClient(config); + * const command = new EnableRuleCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link EnableRuleCommandInput} for command's `input` shape. + * @see {@link EnableRuleCommandOutput} for command's `response` shape. + * @see {@link CloudWatchEventsClientResolvedConfig | config} for command's `input` shape. + * */ export class EnableRuleCommand extends $Command< EnableRuleCommandInput, diff --git a/clients/client-cloudwatch-events/commands/ListApiDestinationsCommand.ts b/clients/client-cloudwatch-events/commands/ListApiDestinationsCommand.ts index 4757ea19cba0..994dceb52fe3 100644 --- a/clients/client-cloudwatch-events/commands/ListApiDestinationsCommand.ts +++ b/clients/client-cloudwatch-events/commands/ListApiDestinationsCommand.ts @@ -22,6 +22,20 @@ export interface ListApiDestinationsCommandOutput extends ListApiDestinationsRes /** *

Retrieves a list of API destination in the account in the current Region.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { CloudWatchEventsClient, ListApiDestinationsCommand } from "@aws-sdk/client-cloudwatch-events"; // ES Modules import + * // const { CloudWatchEventsClient, ListApiDestinationsCommand } = require("@aws-sdk/client-cloudwatch-events"); // CommonJS import + * const client = new CloudWatchEventsClient(config); + * const command = new ListApiDestinationsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListApiDestinationsCommandInput} for command's `input` shape. + * @see {@link ListApiDestinationsCommandOutput} for command's `response` shape. + * @see {@link CloudWatchEventsClientResolvedConfig | config} for command's `input` shape. + * */ export class ListApiDestinationsCommand extends $Command< ListApiDestinationsCommandInput, diff --git a/clients/client-cloudwatch-events/commands/ListArchivesCommand.ts b/clients/client-cloudwatch-events/commands/ListArchivesCommand.ts index 044886f66676..71865dac3b3d 100644 --- a/clients/client-cloudwatch-events/commands/ListArchivesCommand.ts +++ b/clients/client-cloudwatch-events/commands/ListArchivesCommand.ts @@ -23,6 +23,20 @@ export interface ListArchivesCommandOutput extends ListArchivesResponse, __Metad /** *

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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { CloudWatchEventsClient, ListArchivesCommand } from "@aws-sdk/client-cloudwatch-events"; // ES Modules import + * // const { CloudWatchEventsClient, ListArchivesCommand } = require("@aws-sdk/client-cloudwatch-events"); // CommonJS import + * const client = new CloudWatchEventsClient(config); + * const command = new ListArchivesCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListArchivesCommandInput} for command's `input` shape. + * @see {@link ListArchivesCommandOutput} for command's `response` shape. + * @see {@link CloudWatchEventsClientResolvedConfig | config} for command's `input` shape. + * */ export class ListArchivesCommand extends $Command< ListArchivesCommandInput, diff --git a/clients/client-cloudwatch-events/commands/ListConnectionsCommand.ts b/clients/client-cloudwatch-events/commands/ListConnectionsCommand.ts index 963ff50b7064..466912f15c87 100644 --- a/clients/client-cloudwatch-events/commands/ListConnectionsCommand.ts +++ b/clients/client-cloudwatch-events/commands/ListConnectionsCommand.ts @@ -22,6 +22,20 @@ export interface ListConnectionsCommandOutput extends ListConnectionsResponse, _ /** *

Retrieves a list of connections from the account.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { CloudWatchEventsClient, ListConnectionsCommand } from "@aws-sdk/client-cloudwatch-events"; // ES Modules import + * // const { CloudWatchEventsClient, ListConnectionsCommand } = require("@aws-sdk/client-cloudwatch-events"); // CommonJS import + * const client = new CloudWatchEventsClient(config); + * const command = new ListConnectionsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListConnectionsCommandInput} for command's `input` shape. + * @see {@link ListConnectionsCommandOutput} for command's `response` shape. + * @see {@link CloudWatchEventsClientResolvedConfig | config} for command's `input` shape. + * */ export class ListConnectionsCommand extends $Command< ListConnectionsCommandInput, diff --git a/clients/client-cloudwatch-events/commands/ListEventBusesCommand.ts b/clients/client-cloudwatch-events/commands/ListEventBusesCommand.ts index 035266f8ef04..5086c343c174 100644 --- a/clients/client-cloudwatch-events/commands/ListEventBusesCommand.ts +++ b/clients/client-cloudwatch-events/commands/ListEventBusesCommand.ts @@ -23,6 +23,20 @@ export interface ListEventBusesCommandOutput extends ListEventBusesResponse, __M /** *

Lists all the event buses in your account, including the default event bus, custom event * buses, and partner event buses.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { CloudWatchEventsClient, ListEventBusesCommand } from "@aws-sdk/client-cloudwatch-events"; // ES Modules import + * // const { CloudWatchEventsClient, ListEventBusesCommand } = require("@aws-sdk/client-cloudwatch-events"); // CommonJS import + * const client = new CloudWatchEventsClient(config); + * const command = new ListEventBusesCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListEventBusesCommandInput} for command's `input` shape. + * @see {@link ListEventBusesCommandOutput} for command's `response` shape. + * @see {@link CloudWatchEventsClientResolvedConfig | config} for command's `input` shape. + * */ export class ListEventBusesCommand extends $Command< ListEventBusesCommandInput, diff --git a/clients/client-cloudwatch-events/commands/ListEventSourcesCommand.ts b/clients/client-cloudwatch-events/commands/ListEventSourcesCommand.ts index f12d5a92e1f9..390642c2b5e1 100644 --- a/clients/client-cloudwatch-events/commands/ListEventSourcesCommand.ts +++ b/clients/client-cloudwatch-events/commands/ListEventSourcesCommand.ts @@ -23,6 +23,20 @@ export interface ListEventSourcesCommandOutput extends ListEventSourcesResponse, /** *

You can use this to see all the partner event sources that have been shared with your AWS * account. For more information about partner event sources, see CreateEventBus.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { CloudWatchEventsClient, ListEventSourcesCommand } from "@aws-sdk/client-cloudwatch-events"; // ES Modules import + * // const { CloudWatchEventsClient, ListEventSourcesCommand } = require("@aws-sdk/client-cloudwatch-events"); // CommonJS import + * const client = new CloudWatchEventsClient(config); + * const command = new ListEventSourcesCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListEventSourcesCommandInput} for command's `input` shape. + * @see {@link ListEventSourcesCommandOutput} for command's `response` shape. + * @see {@link CloudWatchEventsClientResolvedConfig | config} for command's `input` shape. + * */ export class ListEventSourcesCommand extends $Command< ListEventSourcesCommandInput, diff --git a/clients/client-cloudwatch-events/commands/ListPartnerEventSourceAccountsCommand.ts b/clients/client-cloudwatch-events/commands/ListPartnerEventSourceAccountsCommand.ts index 5fe272dad5d5..2a973a7c0075 100644 --- a/clients/client-cloudwatch-events/commands/ListPartnerEventSourceAccountsCommand.ts +++ b/clients/client-cloudwatch-events/commands/ListPartnerEventSourceAccountsCommand.ts @@ -26,6 +26,20 @@ export interface ListPartnerEventSourceAccountsCommandOutput *

An SaaS partner can use this operation to display the AWS account ID that a particular * partner event source name is associated with. This operation is not used by AWS * customers.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { CloudWatchEventsClient, ListPartnerEventSourceAccountsCommand } from "@aws-sdk/client-cloudwatch-events"; // ES Modules import + * // const { CloudWatchEventsClient, ListPartnerEventSourceAccountsCommand } = require("@aws-sdk/client-cloudwatch-events"); // CommonJS import + * const client = new CloudWatchEventsClient(config); + * const command = new ListPartnerEventSourceAccountsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListPartnerEventSourceAccountsCommandInput} for command's `input` shape. + * @see {@link ListPartnerEventSourceAccountsCommandOutput} for command's `response` shape. + * @see {@link CloudWatchEventsClientResolvedConfig | config} for command's `input` shape. + * */ export class ListPartnerEventSourceAccountsCommand extends $Command< ListPartnerEventSourceAccountsCommandInput, diff --git a/clients/client-cloudwatch-events/commands/ListPartnerEventSourcesCommand.ts b/clients/client-cloudwatch-events/commands/ListPartnerEventSourcesCommand.ts index ce9fe7725163..5ab2ecf91613 100644 --- a/clients/client-cloudwatch-events/commands/ListPartnerEventSourcesCommand.ts +++ b/clients/client-cloudwatch-events/commands/ListPartnerEventSourcesCommand.ts @@ -23,6 +23,20 @@ export interface ListPartnerEventSourcesCommandOutput extends ListPartnerEventSo /** *

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 AWS customers.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { CloudWatchEventsClient, ListPartnerEventSourcesCommand } from "@aws-sdk/client-cloudwatch-events"; // ES Modules import + * // const { CloudWatchEventsClient, ListPartnerEventSourcesCommand } = require("@aws-sdk/client-cloudwatch-events"); // CommonJS import + * const client = new CloudWatchEventsClient(config); + * const command = new ListPartnerEventSourcesCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListPartnerEventSourcesCommandInput} for command's `input` shape. + * @see {@link ListPartnerEventSourcesCommandOutput} for command's `response` shape. + * @see {@link CloudWatchEventsClientResolvedConfig | config} for command's `input` shape. + * */ export class ListPartnerEventSourcesCommand extends $Command< ListPartnerEventSourcesCommandInput, diff --git a/clients/client-cloudwatch-events/commands/ListReplaysCommand.ts b/clients/client-cloudwatch-events/commands/ListReplaysCommand.ts index baaa2eb891cd..4e94c58565bd 100644 --- a/clients/client-cloudwatch-events/commands/ListReplaysCommand.ts +++ b/clients/client-cloudwatch-events/commands/ListReplaysCommand.ts @@ -23,6 +23,20 @@ export interface ListReplaysCommandOutput extends ListReplaysResponse, __Metadat /** *

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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { CloudWatchEventsClient, ListReplaysCommand } from "@aws-sdk/client-cloudwatch-events"; // ES Modules import + * // const { CloudWatchEventsClient, ListReplaysCommand } = require("@aws-sdk/client-cloudwatch-events"); // CommonJS import + * const client = new CloudWatchEventsClient(config); + * const command = new ListReplaysCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListReplaysCommandInput} for command's `input` shape. + * @see {@link ListReplaysCommandOutput} for command's `response` shape. + * @see {@link CloudWatchEventsClientResolvedConfig | config} for command's `input` shape. + * */ export class ListReplaysCommand extends $Command< ListReplaysCommandInput, diff --git a/clients/client-cloudwatch-events/commands/ListRuleNamesByTargetCommand.ts b/clients/client-cloudwatch-events/commands/ListRuleNamesByTargetCommand.ts index 9d4ec191cd24..2d2cf12cdcd0 100644 --- a/clients/client-cloudwatch-events/commands/ListRuleNamesByTargetCommand.ts +++ b/clients/client-cloudwatch-events/commands/ListRuleNamesByTargetCommand.ts @@ -23,6 +23,20 @@ export interface ListRuleNamesByTargetCommandOutput extends ListRuleNamesByTarge /** *

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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { CloudWatchEventsClient, ListRuleNamesByTargetCommand } from "@aws-sdk/client-cloudwatch-events"; // ES Modules import + * // const { CloudWatchEventsClient, ListRuleNamesByTargetCommand } = require("@aws-sdk/client-cloudwatch-events"); // CommonJS import + * const client = new CloudWatchEventsClient(config); + * const command = new ListRuleNamesByTargetCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListRuleNamesByTargetCommandInput} for command's `input` shape. + * @see {@link ListRuleNamesByTargetCommandOutput} for command's `response` shape. + * @see {@link CloudWatchEventsClientResolvedConfig | config} for command's `input` shape. + * */ export class ListRuleNamesByTargetCommand extends $Command< ListRuleNamesByTargetCommandInput, diff --git a/clients/client-cloudwatch-events/commands/ListRulesCommand.ts b/clients/client-cloudwatch-events/commands/ListRulesCommand.ts index f0e99515acef..7dc407b491bd 100644 --- a/clients/client-cloudwatch-events/commands/ListRulesCommand.ts +++ b/clients/client-cloudwatch-events/commands/ListRulesCommand.ts @@ -23,6 +23,20 @@ export interface ListRulesCommandOutput extends ListRulesResponse, __MetadataBea * *

ListRules does not list the targets of a rule. To see the targets associated with a rule, * use ListTargetsByRule.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { CloudWatchEventsClient, ListRulesCommand } from "@aws-sdk/client-cloudwatch-events"; // ES Modules import + * // const { CloudWatchEventsClient, ListRulesCommand } = require("@aws-sdk/client-cloudwatch-events"); // CommonJS import + * const client = new CloudWatchEventsClient(config); + * const command = new ListRulesCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListRulesCommandInput} for command's `input` shape. + * @see {@link ListRulesCommandOutput} for command's `response` shape. + * @see {@link CloudWatchEventsClientResolvedConfig | config} for command's `input` shape. + * */ export class ListRulesCommand extends $Command< ListRulesCommandInput, diff --git a/clients/client-cloudwatch-events/commands/ListTagsForResourceCommand.ts b/clients/client-cloudwatch-events/commands/ListTagsForResourceCommand.ts index f3ae29bf931e..d0d9a8aeaf23 100644 --- a/clients/client-cloudwatch-events/commands/ListTagsForResourceCommand.ts +++ b/clients/client-cloudwatch-events/commands/ListTagsForResourceCommand.ts @@ -23,6 +23,20 @@ export interface ListTagsForResourceCommandOutput extends ListTagsForResourceRes /** *

Displays the tags associated with an EventBridge resource. In EventBridge, rules and event * buses can be tagged.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { CloudWatchEventsClient, ListTagsForResourceCommand } from "@aws-sdk/client-cloudwatch-events"; // ES Modules import + * // const { CloudWatchEventsClient, ListTagsForResourceCommand } = require("@aws-sdk/client-cloudwatch-events"); // CommonJS import + * const client = new CloudWatchEventsClient(config); + * const command = new ListTagsForResourceCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListTagsForResourceCommandInput} for command's `input` shape. + * @see {@link ListTagsForResourceCommandOutput} for command's `response` shape. + * @see {@link CloudWatchEventsClientResolvedConfig | config} for command's `input` shape. + * */ export class ListTagsForResourceCommand extends $Command< ListTagsForResourceCommandInput, diff --git a/clients/client-cloudwatch-events/commands/ListTargetsByRuleCommand.ts b/clients/client-cloudwatch-events/commands/ListTargetsByRuleCommand.ts index 9a8654a6f74e..250546a4559f 100644 --- a/clients/client-cloudwatch-events/commands/ListTargetsByRuleCommand.ts +++ b/clients/client-cloudwatch-events/commands/ListTargetsByRuleCommand.ts @@ -22,6 +22,20 @@ export interface ListTargetsByRuleCommandOutput extends ListTargetsByRuleRespons /** *

Lists the targets assigned to the specified rule.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { CloudWatchEventsClient, ListTargetsByRuleCommand } from "@aws-sdk/client-cloudwatch-events"; // ES Modules import + * // const { CloudWatchEventsClient, ListTargetsByRuleCommand } = require("@aws-sdk/client-cloudwatch-events"); // CommonJS import + * const client = new CloudWatchEventsClient(config); + * const command = new ListTargetsByRuleCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListTargetsByRuleCommandInput} for command's `input` shape. + * @see {@link ListTargetsByRuleCommandOutput} for command's `response` shape. + * @see {@link CloudWatchEventsClientResolvedConfig | config} for command's `input` shape. + * */ export class ListTargetsByRuleCommand extends $Command< ListTargetsByRuleCommandInput, diff --git a/clients/client-cloudwatch-events/commands/PutEventsCommand.ts b/clients/client-cloudwatch-events/commands/PutEventsCommand.ts index adcf0bcd33cd..1c006090bd0d 100644 --- a/clients/client-cloudwatch-events/commands/PutEventsCommand.ts +++ b/clients/client-cloudwatch-events/commands/PutEventsCommand.ts @@ -19,6 +19,20 @@ export interface PutEventsCommandOutput extends PutEventsResponse, __MetadataBea /** *

Sends custom events to Amazon EventBridge so that they can be matched to rules.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { CloudWatchEventsClient, PutEventsCommand } from "@aws-sdk/client-cloudwatch-events"; // ES Modules import + * // const { CloudWatchEventsClient, PutEventsCommand } = require("@aws-sdk/client-cloudwatch-events"); // CommonJS import + * const client = new CloudWatchEventsClient(config); + * const command = new PutEventsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link PutEventsCommandInput} for command's `input` shape. + * @see {@link PutEventsCommandOutput} for command's `response` shape. + * @see {@link CloudWatchEventsClientResolvedConfig | config} for command's `input` shape. + * */ export class PutEventsCommand extends $Command< PutEventsCommandInput, diff --git a/clients/client-cloudwatch-events/commands/PutPartnerEventsCommand.ts b/clients/client-cloudwatch-events/commands/PutPartnerEventsCommand.ts index 7a3038130c6b..2ec665364fae 100644 --- a/clients/client-cloudwatch-events/commands/PutPartnerEventsCommand.ts +++ b/clients/client-cloudwatch-events/commands/PutPartnerEventsCommand.ts @@ -23,6 +23,20 @@ export interface PutPartnerEventsCommandOutput extends PutPartnerEventsResponse, /** *

This is used by SaaS partners to write events to a customer's partner event bus. AWS * customers do not use this operation.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { CloudWatchEventsClient, PutPartnerEventsCommand } from "@aws-sdk/client-cloudwatch-events"; // ES Modules import + * // const { CloudWatchEventsClient, PutPartnerEventsCommand } = require("@aws-sdk/client-cloudwatch-events"); // CommonJS import + * const client = new CloudWatchEventsClient(config); + * const command = new PutPartnerEventsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link PutPartnerEventsCommandInput} for command's `input` shape. + * @see {@link PutPartnerEventsCommandOutput} for command's `response` shape. + * @see {@link CloudWatchEventsClientResolvedConfig | config} for command's `input` shape. + * */ export class PutPartnerEventsCommand extends $Command< PutPartnerEventsCommandInput, diff --git a/clients/client-cloudwatch-events/commands/PutPermissionCommand.ts b/clients/client-cloudwatch-events/commands/PutPermissionCommand.ts index 9a13e1e4c6e4..3db82e973673 100644 --- a/clients/client-cloudwatch-events/commands/PutPermissionCommand.ts +++ b/clients/client-cloudwatch-events/commands/PutPermissionCommand.ts @@ -41,6 +41,20 @@ export interface PutPermissionCommandOutput extends __MetadataBearer {} * Guide.

* *

The permission policy on the default event bus cannot exceed 10 KB in size.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { CloudWatchEventsClient, PutPermissionCommand } from "@aws-sdk/client-cloudwatch-events"; // ES Modules import + * // const { CloudWatchEventsClient, PutPermissionCommand } = require("@aws-sdk/client-cloudwatch-events"); // CommonJS import + * const client = new CloudWatchEventsClient(config); + * const command = new PutPermissionCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link PutPermissionCommandInput} for command's `input` shape. + * @see {@link PutPermissionCommandOutput} for command's `response` shape. + * @see {@link CloudWatchEventsClientResolvedConfig | config} for command's `input` shape. + * */ export class PutPermissionCommand extends $Command< PutPermissionCommandInput, diff --git a/clients/client-cloudwatch-events/commands/PutRuleCommand.ts b/clients/client-cloudwatch-events/commands/PutRuleCommand.ts index 6802753dd525..774fc252cbab 100644 --- a/clients/client-cloudwatch-events/commands/PutRuleCommand.ts +++ b/clients/client-cloudwatch-events/commands/PutRuleCommand.ts @@ -65,6 +65,20 @@ export interface PutRuleCommandOutput extends PutRuleResponse, __MetadataBearer * budgeting, which alerts you when charges exceed your specified limit. For more information, * see Managing Your Costs with * Budgets.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { CloudWatchEventsClient, PutRuleCommand } from "@aws-sdk/client-cloudwatch-events"; // ES Modules import + * // const { CloudWatchEventsClient, PutRuleCommand } = require("@aws-sdk/client-cloudwatch-events"); // CommonJS import + * const client = new CloudWatchEventsClient(config); + * const command = new PutRuleCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link PutRuleCommandInput} for command's `input` shape. + * @see {@link PutRuleCommandOutput} for command's `response` shape. + * @see {@link CloudWatchEventsClientResolvedConfig | config} for command's `input` shape. + * */ export class PutRuleCommand extends $Command< PutRuleCommandInput, diff --git a/clients/client-cloudwatch-events/commands/PutTargetsCommand.ts b/clients/client-cloudwatch-events/commands/PutTargetsCommand.ts index 34d5fb352d84..3b04f03cf773 100644 --- a/clients/client-cloudwatch-events/commands/PutTargetsCommand.ts +++ b/clients/client-cloudwatch-events/commands/PutTargetsCommand.ts @@ -169,6 +169,20 @@ export interface PutTargetsCommandOutput extends PutTargetsResponse, __MetadataB *

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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { CloudWatchEventsClient, PutTargetsCommand } from "@aws-sdk/client-cloudwatch-events"; // ES Modules import + * // const { CloudWatchEventsClient, PutTargetsCommand } = require("@aws-sdk/client-cloudwatch-events"); // CommonJS import + * const client = new CloudWatchEventsClient(config); + * const command = new PutTargetsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link PutTargetsCommandInput} for command's `input` shape. + * @see {@link PutTargetsCommandOutput} for command's `response` shape. + * @see {@link CloudWatchEventsClientResolvedConfig | config} for command's `input` shape. + * */ export class PutTargetsCommand extends $Command< PutTargetsCommandInput, diff --git a/clients/client-cloudwatch-events/commands/RemovePermissionCommand.ts b/clients/client-cloudwatch-events/commands/RemovePermissionCommand.ts index b866f279e57b..e87181f15518 100644 --- a/clients/client-cloudwatch-events/commands/RemovePermissionCommand.ts +++ b/clients/client-cloudwatch-events/commands/RemovePermissionCommand.ts @@ -25,6 +25,20 @@ export interface RemovePermissionCommandOutput extends __MetadataBearer {} * 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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { CloudWatchEventsClient, RemovePermissionCommand } from "@aws-sdk/client-cloudwatch-events"; // ES Modules import + * // const { CloudWatchEventsClient, RemovePermissionCommand } = require("@aws-sdk/client-cloudwatch-events"); // CommonJS import + * const client = new CloudWatchEventsClient(config); + * const command = new RemovePermissionCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link RemovePermissionCommandInput} for command's `input` shape. + * @see {@link RemovePermissionCommandOutput} for command's `response` shape. + * @see {@link CloudWatchEventsClientResolvedConfig | config} for command's `input` shape. + * */ export class RemovePermissionCommand extends $Command< RemovePermissionCommandInput, diff --git a/clients/client-cloudwatch-events/commands/RemoveTargetsCommand.ts b/clients/client-cloudwatch-events/commands/RemoveTargetsCommand.ts index c7b38e810c09..bb7d9934c7f3 100644 --- a/clients/client-cloudwatch-events/commands/RemoveTargetsCommand.ts +++ b/clients/client-cloudwatch-events/commands/RemoveTargetsCommand.ts @@ -30,6 +30,20 @@ export interface RemoveTargetsCommandOutput extends RemoveTargetsResponse, __Met *

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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { CloudWatchEventsClient, RemoveTargetsCommand } from "@aws-sdk/client-cloudwatch-events"; // ES Modules import + * // const { CloudWatchEventsClient, RemoveTargetsCommand } = require("@aws-sdk/client-cloudwatch-events"); // CommonJS import + * const client = new CloudWatchEventsClient(config); + * const command = new RemoveTargetsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link RemoveTargetsCommandInput} for command's `input` shape. + * @see {@link RemoveTargetsCommandOutput} for command's `response` shape. + * @see {@link CloudWatchEventsClientResolvedConfig | config} for command's `input` shape. + * */ export class RemoveTargetsCommand extends $Command< RemoveTargetsCommandInput, diff --git a/clients/client-cloudwatch-events/commands/StartReplayCommand.ts b/clients/client-cloudwatch-events/commands/StartReplayCommand.ts index 0a71404421dc..5c8351aa36ec 100644 --- a/clients/client-cloudwatch-events/commands/StartReplayCommand.ts +++ b/clients/client-cloudwatch-events/commands/StartReplayCommand.ts @@ -30,6 +30,20 @@ export interface StartReplayCommandOutput extends StartReplayResponse, __Metadat * 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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { CloudWatchEventsClient, StartReplayCommand } from "@aws-sdk/client-cloudwatch-events"; // ES Modules import + * // const { CloudWatchEventsClient, StartReplayCommand } = require("@aws-sdk/client-cloudwatch-events"); // CommonJS import + * const client = new CloudWatchEventsClient(config); + * const command = new StartReplayCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link StartReplayCommandInput} for command's `input` shape. + * @see {@link StartReplayCommandOutput} for command's `response` shape. + * @see {@link CloudWatchEventsClientResolvedConfig | config} for command's `input` shape. + * */ export class StartReplayCommand extends $Command< StartReplayCommandInput, diff --git a/clients/client-cloudwatch-events/commands/TagResourceCommand.ts b/clients/client-cloudwatch-events/commands/TagResourceCommand.ts index 800cdaf40ae6..2fc83b76671a 100644 --- a/clients/client-cloudwatch-events/commands/TagResourceCommand.ts +++ b/clients/client-cloudwatch-events/commands/TagResourceCommand.ts @@ -32,6 +32,20 @@ export interface TagResourceCommandOutput extends TagResourceResponse, __Metadat * 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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { CloudWatchEventsClient, TagResourceCommand } from "@aws-sdk/client-cloudwatch-events"; // ES Modules import + * // const { CloudWatchEventsClient, TagResourceCommand } = require("@aws-sdk/client-cloudwatch-events"); // CommonJS import + * const client = new CloudWatchEventsClient(config); + * const command = new TagResourceCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link TagResourceCommandInput} for command's `input` shape. + * @see {@link TagResourceCommandOutput} for command's `response` shape. + * @see {@link CloudWatchEventsClientResolvedConfig | config} for command's `input` shape. + * */ export class TagResourceCommand extends $Command< TagResourceCommandInput, diff --git a/clients/client-cloudwatch-events/commands/TestEventPatternCommand.ts b/clients/client-cloudwatch-events/commands/TestEventPatternCommand.ts index acb8a92fdbde..2f566863cdb6 100644 --- a/clients/client-cloudwatch-events/commands/TestEventPatternCommand.ts +++ b/clients/client-cloudwatch-events/commands/TestEventPatternCommand.ts @@ -26,6 +26,20 @@ export interface TestEventPatternCommandOutput extends TestEventPatternResponse, * 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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { CloudWatchEventsClient, TestEventPatternCommand } from "@aws-sdk/client-cloudwatch-events"; // ES Modules import + * // const { CloudWatchEventsClient, TestEventPatternCommand } = require("@aws-sdk/client-cloudwatch-events"); // CommonJS import + * const client = new CloudWatchEventsClient(config); + * const command = new TestEventPatternCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link TestEventPatternCommandInput} for command's `input` shape. + * @see {@link TestEventPatternCommandOutput} for command's `response` shape. + * @see {@link CloudWatchEventsClientResolvedConfig | config} for command's `input` shape. + * */ export class TestEventPatternCommand extends $Command< TestEventPatternCommandInput, diff --git a/clients/client-cloudwatch-events/commands/UntagResourceCommand.ts b/clients/client-cloudwatch-events/commands/UntagResourceCommand.ts index 8088e7b4916c..2021ed7a2a2f 100644 --- a/clients/client-cloudwatch-events/commands/UntagResourceCommand.ts +++ b/clients/client-cloudwatch-events/commands/UntagResourceCommand.ts @@ -23,6 +23,20 @@ export interface UntagResourceCommandOutput extends UntagResourceResponse, __Met /** *

Removes one or more tags from the specified EventBridge resource. In Amazon EventBridge * (CloudWatch Events, rules and event buses can be tagged.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { CloudWatchEventsClient, UntagResourceCommand } from "@aws-sdk/client-cloudwatch-events"; // ES Modules import + * // const { CloudWatchEventsClient, UntagResourceCommand } = require("@aws-sdk/client-cloudwatch-events"); // CommonJS import + * const client = new CloudWatchEventsClient(config); + * const command = new UntagResourceCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link UntagResourceCommandInput} for command's `input` shape. + * @see {@link UntagResourceCommandOutput} for command's `response` shape. + * @see {@link CloudWatchEventsClientResolvedConfig | config} for command's `input` shape. + * */ export class UntagResourceCommand extends $Command< UntagResourceCommandInput, diff --git a/clients/client-cloudwatch-events/commands/UpdateApiDestinationCommand.ts b/clients/client-cloudwatch-events/commands/UpdateApiDestinationCommand.ts index 030d0f809cb0..824a224079b7 100644 --- a/clients/client-cloudwatch-events/commands/UpdateApiDestinationCommand.ts +++ b/clients/client-cloudwatch-events/commands/UpdateApiDestinationCommand.ts @@ -22,6 +22,20 @@ export interface UpdateApiDestinationCommandOutput extends UpdateApiDestinationR /** *

Updates an API destination.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { CloudWatchEventsClient, UpdateApiDestinationCommand } from "@aws-sdk/client-cloudwatch-events"; // ES Modules import + * // const { CloudWatchEventsClient, UpdateApiDestinationCommand } = require("@aws-sdk/client-cloudwatch-events"); // CommonJS import + * const client = new CloudWatchEventsClient(config); + * const command = new UpdateApiDestinationCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link UpdateApiDestinationCommandInput} for command's `input` shape. + * @see {@link UpdateApiDestinationCommandOutput} for command's `response` shape. + * @see {@link CloudWatchEventsClientResolvedConfig | config} for command's `input` shape. + * */ export class UpdateApiDestinationCommand extends $Command< UpdateApiDestinationCommandInput, diff --git a/clients/client-cloudwatch-events/commands/UpdateArchiveCommand.ts b/clients/client-cloudwatch-events/commands/UpdateArchiveCommand.ts index bfae9f22948d..3337dbff996e 100644 --- a/clients/client-cloudwatch-events/commands/UpdateArchiveCommand.ts +++ b/clients/client-cloudwatch-events/commands/UpdateArchiveCommand.ts @@ -22,6 +22,20 @@ export interface UpdateArchiveCommandOutput extends UpdateArchiveResponse, __Met /** *

Updates the specified archive.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { CloudWatchEventsClient, UpdateArchiveCommand } from "@aws-sdk/client-cloudwatch-events"; // ES Modules import + * // const { CloudWatchEventsClient, UpdateArchiveCommand } = require("@aws-sdk/client-cloudwatch-events"); // CommonJS import + * const client = new CloudWatchEventsClient(config); + * const command = new UpdateArchiveCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link UpdateArchiveCommandInput} for command's `input` shape. + * @see {@link UpdateArchiveCommandOutput} for command's `response` shape. + * @see {@link CloudWatchEventsClientResolvedConfig | config} for command's `input` shape. + * */ export class UpdateArchiveCommand extends $Command< UpdateArchiveCommandInput, diff --git a/clients/client-cloudwatch-events/commands/UpdateConnectionCommand.ts b/clients/client-cloudwatch-events/commands/UpdateConnectionCommand.ts index 8c02d27296e0..48eee7767626 100644 --- a/clients/client-cloudwatch-events/commands/UpdateConnectionCommand.ts +++ b/clients/client-cloudwatch-events/commands/UpdateConnectionCommand.ts @@ -22,6 +22,20 @@ export interface UpdateConnectionCommandOutput extends UpdateConnectionResponse, /** *

Updates settings for a connection.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { CloudWatchEventsClient, UpdateConnectionCommand } from "@aws-sdk/client-cloudwatch-events"; // ES Modules import + * // const { CloudWatchEventsClient, UpdateConnectionCommand } = require("@aws-sdk/client-cloudwatch-events"); // CommonJS import + * const client = new CloudWatchEventsClient(config); + * const command = new UpdateConnectionCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link UpdateConnectionCommandInput} for command's `input` shape. + * @see {@link UpdateConnectionCommandOutput} for command's `response` shape. + * @see {@link CloudWatchEventsClientResolvedConfig | config} for command's `input` shape. + * */ export class UpdateConnectionCommand extends $Command< UpdateConnectionCommandInput, diff --git a/clients/client-cloudwatch-events/models/models_0.ts b/clients/client-cloudwatch-events/models/models_0.ts index b1172f60f3fc..c84bc9c09f7f 100644 --- a/clients/client-cloudwatch-events/models/models_0.ts +++ b/clients/client-cloudwatch-events/models/models_0.ts @@ -9,6 +9,9 @@ export interface ActivateEventSourceRequest { } export namespace ActivateEventSourceRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ActivateEventSourceRequest): any => ({ ...obj, }); @@ -24,6 +27,9 @@ export interface ConcurrentModificationException extends __SmithyException, $Met } export namespace ConcurrentModificationException { + /** + * @internal + */ export const filterSensitiveLog = (obj: ConcurrentModificationException): any => ({ ...obj, }); @@ -39,6 +45,9 @@ export interface InternalException extends __SmithyException, $MetadataBearer { } export namespace InternalException { + /** + * @internal + */ export const filterSensitiveLog = (obj: InternalException): any => ({ ...obj, }); @@ -54,6 +63,9 @@ export interface InvalidStateException extends __SmithyException, $MetadataBeare } export namespace InvalidStateException { + /** + * @internal + */ export const filterSensitiveLog = (obj: InvalidStateException): any => ({ ...obj, }); @@ -69,6 +81,9 @@ export interface OperationDisabledException extends __SmithyException, $Metadata } export namespace OperationDisabledException { + /** + * @internal + */ export const filterSensitiveLog = (obj: OperationDisabledException): any => ({ ...obj, }); @@ -84,6 +99,9 @@ export interface ResourceNotFoundException extends __SmithyException, $MetadataB } export namespace ResourceNotFoundException { + /** + * @internal + */ export const filterSensitiveLog = (obj: ResourceNotFoundException): any => ({ ...obj, }); @@ -155,6 +173,9 @@ export interface ApiDestination { } export namespace ApiDestination { + /** + * @internal + */ export const filterSensitiveLog = (obj: ApiDestination): any => ({ ...obj, }); @@ -216,6 +237,9 @@ export interface Archive { } export namespace Archive { + /** + * @internal + */ export const filterSensitiveLog = (obj: Archive): any => ({ ...obj, }); @@ -234,6 +258,9 @@ export interface CancelReplayRequest { } export namespace CancelReplayRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: CancelReplayRequest): any => ({ ...obj, }); @@ -266,6 +293,9 @@ export interface CancelReplayResponse { } export namespace CancelReplayResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: CancelReplayResponse): any => ({ ...obj, }); @@ -282,6 +312,9 @@ export interface IllegalStatusException extends __SmithyException, $MetadataBear } export namespace IllegalStatusException { + /** + * @internal + */ export const filterSensitiveLog = (obj: IllegalStatusException): any => ({ ...obj, }); @@ -321,6 +354,9 @@ export interface CreateApiDestinationRequest { } export namespace CreateApiDestinationRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateApiDestinationRequest): any => ({ ...obj, }); @@ -349,6 +385,9 @@ export interface CreateApiDestinationResponse { } export namespace CreateApiDestinationResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateApiDestinationResponse): any => ({ ...obj, }); @@ -365,6 +404,9 @@ export interface LimitExceededException extends __SmithyException, $MetadataBear } export namespace LimitExceededException { + /** + * @internal + */ export const filterSensitiveLog = (obj: LimitExceededException): any => ({ ...obj, }); @@ -380,6 +422,9 @@ export interface ResourceAlreadyExistsException extends __SmithyException, $Meta } export namespace ResourceAlreadyExistsException { + /** + * @internal + */ export const filterSensitiveLog = (obj: ResourceAlreadyExistsException): any => ({ ...obj, }); @@ -414,6 +459,9 @@ export interface CreateArchiveRequest { } export namespace CreateArchiveRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateArchiveRequest): any => ({ ...obj, }); @@ -442,6 +490,9 @@ export interface CreateArchiveResponse { } export namespace CreateArchiveResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateArchiveResponse): any => ({ ...obj, }); @@ -457,6 +508,9 @@ export interface InvalidEventPatternException extends __SmithyException, $Metada } export namespace InvalidEventPatternException { + /** + * @internal + */ export const filterSensitiveLog = (obj: InvalidEventPatternException): any => ({ ...obj, }); @@ -484,6 +538,9 @@ export interface CreateConnectionApiKeyAuthRequestParameters { } export namespace CreateConnectionApiKeyAuthRequestParameters { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateConnectionApiKeyAuthRequestParameters): any => ({ ...obj, }); @@ -505,6 +562,9 @@ export interface CreateConnectionBasicAuthRequestParameters { } export namespace CreateConnectionBasicAuthRequestParameters { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateConnectionBasicAuthRequestParameters): any => ({ ...obj, }); @@ -532,6 +592,9 @@ export interface ConnectionBodyParameter { } export namespace ConnectionBodyParameter { + /** + * @internal + */ export const filterSensitiveLog = (obj: ConnectionBodyParameter): any => ({ ...obj, }); @@ -559,6 +622,9 @@ export interface ConnectionHeaderParameter { } export namespace ConnectionHeaderParameter { + /** + * @internal + */ export const filterSensitiveLog = (obj: ConnectionHeaderParameter): any => ({ ...obj, }); @@ -587,6 +653,9 @@ export interface ConnectionQueryStringParameter { } export namespace ConnectionQueryStringParameter { + /** + * @internal + */ export const filterSensitiveLog = (obj: ConnectionQueryStringParameter): any => ({ ...obj, }); @@ -613,6 +682,9 @@ export interface ConnectionHttpParameters { } export namespace ConnectionHttpParameters { + /** + * @internal + */ export const filterSensitiveLog = (obj: ConnectionHttpParameters): any => ({ ...obj, }); @@ -635,6 +707,9 @@ export interface CreateConnectionOAuthClientRequestParameters { } export namespace CreateConnectionOAuthClientRequestParameters { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateConnectionOAuthClientRequestParameters): any => ({ ...obj, }); @@ -675,6 +750,9 @@ export interface CreateConnectionOAuthRequestParameters { } export namespace CreateConnectionOAuthRequestParameters { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateConnectionOAuthRequestParameters): any => ({ ...obj, }); @@ -712,6 +790,9 @@ export interface CreateConnectionAuthRequestParameters { } export namespace CreateConnectionAuthRequestParameters { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateConnectionAuthRequestParameters): any => ({ ...obj, }); @@ -741,6 +822,9 @@ export interface CreateConnectionRequest { } export namespace CreateConnectionRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateConnectionRequest): any => ({ ...obj, }); @@ -779,6 +863,9 @@ export interface CreateConnectionResponse { } export namespace CreateConnectionResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateConnectionResponse): any => ({ ...obj, }); @@ -802,6 +889,9 @@ export interface Tag { } export namespace Tag { + /** + * @internal + */ export const filterSensitiveLog = (obj: Tag): any => ({ ...obj, }); @@ -831,6 +921,9 @@ export interface CreateEventBusRequest { } export namespace CreateEventBusRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateEventBusRequest): any => ({ ...obj, }); @@ -844,6 +937,9 @@ export interface CreateEventBusResponse { } export namespace CreateEventBusResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateEventBusResponse): any => ({ ...obj, }); @@ -868,6 +964,9 @@ export interface CreatePartnerEventSourceRequest { } export namespace CreatePartnerEventSourceRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreatePartnerEventSourceRequest): any => ({ ...obj, }); @@ -881,6 +980,9 @@ export interface CreatePartnerEventSourceResponse { } export namespace CreatePartnerEventSourceResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreatePartnerEventSourceResponse): any => ({ ...obj, }); @@ -894,6 +996,9 @@ export interface DeactivateEventSourceRequest { } export namespace DeactivateEventSourceRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeactivateEventSourceRequest): any => ({ ...obj, }); @@ -907,6 +1012,9 @@ export interface DeauthorizeConnectionRequest { } export namespace DeauthorizeConnectionRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeauthorizeConnectionRequest): any => ({ ...obj, }); @@ -940,6 +1048,9 @@ export interface DeauthorizeConnectionResponse { } export namespace DeauthorizeConnectionResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeauthorizeConnectionResponse): any => ({ ...obj, }); @@ -953,6 +1064,9 @@ export interface DeleteApiDestinationRequest { } export namespace DeleteApiDestinationRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteApiDestinationRequest): any => ({ ...obj, }); @@ -961,6 +1075,9 @@ export namespace DeleteApiDestinationRequest { export interface DeleteApiDestinationResponse {} export namespace DeleteApiDestinationResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteApiDestinationResponse): any => ({ ...obj, }); @@ -974,6 +1091,9 @@ export interface DeleteArchiveRequest { } export namespace DeleteArchiveRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteArchiveRequest): any => ({ ...obj, }); @@ -982,6 +1102,9 @@ export namespace DeleteArchiveRequest { export interface DeleteArchiveResponse {} export namespace DeleteArchiveResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteArchiveResponse): any => ({ ...obj, }); @@ -995,6 +1118,9 @@ export interface DeleteConnectionRequest { } export namespace DeleteConnectionRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteConnectionRequest): any => ({ ...obj, }); @@ -1030,6 +1156,9 @@ export interface DeleteConnectionResponse { } export namespace DeleteConnectionResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteConnectionResponse): any => ({ ...obj, }); @@ -1043,6 +1172,9 @@ export interface DeleteEventBusRequest { } export namespace DeleteEventBusRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteEventBusRequest): any => ({ ...obj, }); @@ -1061,6 +1193,9 @@ export interface DeletePartnerEventSourceRequest { } export namespace DeletePartnerEventSourceRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeletePartnerEventSourceRequest): any => ({ ...obj, }); @@ -1089,6 +1224,9 @@ export interface DeleteRuleRequest { } export namespace DeleteRuleRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteRuleRequest): any => ({ ...obj, }); @@ -1109,6 +1247,9 @@ export interface ManagedRuleException extends __SmithyException, $MetadataBearer } export namespace ManagedRuleException { + /** + * @internal + */ export const filterSensitiveLog = (obj: ManagedRuleException): any => ({ ...obj, }); @@ -1122,6 +1263,9 @@ export interface DescribeApiDestinationRequest { } export namespace DescribeApiDestinationRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeApiDestinationRequest): any => ({ ...obj, }); @@ -1185,6 +1329,9 @@ export interface DescribeApiDestinationResponse { } export namespace DescribeApiDestinationResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeApiDestinationResponse): any => ({ ...obj, }); @@ -1198,6 +1345,9 @@ export interface DescribeArchiveRequest { } export namespace DescribeArchiveRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeArchiveRequest): any => ({ ...obj, }); @@ -1261,6 +1411,9 @@ export interface DescribeArchiveResponse { } export namespace DescribeArchiveResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeArchiveResponse): any => ({ ...obj, }); @@ -1274,6 +1427,9 @@ export interface DescribeConnectionRequest { } export namespace DescribeConnectionRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeConnectionRequest): any => ({ ...obj, }); @@ -1291,6 +1447,9 @@ export interface ConnectionApiKeyAuthResponseParameters { } export namespace ConnectionApiKeyAuthResponseParameters { + /** + * @internal + */ export const filterSensitiveLog = (obj: ConnectionApiKeyAuthResponseParameters): any => ({ ...obj, }); @@ -1308,6 +1467,9 @@ export interface ConnectionBasicAuthResponseParameters { } export namespace ConnectionBasicAuthResponseParameters { + /** + * @internal + */ export const filterSensitiveLog = (obj: ConnectionBasicAuthResponseParameters): any => ({ ...obj, }); @@ -1325,6 +1487,9 @@ export interface ConnectionOAuthClientResponseParameters { } export namespace ConnectionOAuthClientResponseParameters { + /** + * @internal + */ export const filterSensitiveLog = (obj: ConnectionOAuthClientResponseParameters): any => ({ ...obj, }); @@ -1357,6 +1522,9 @@ export interface ConnectionOAuthResponseParameters { } export namespace ConnectionOAuthResponseParameters { + /** + * @internal + */ export const filterSensitiveLog = (obj: ConnectionOAuthResponseParameters): any => ({ ...obj, }); @@ -1389,6 +1557,9 @@ export interface ConnectionAuthResponseParameters { } export namespace ConnectionAuthResponseParameters { + /** + * @internal + */ export const filterSensitiveLog = (obj: ConnectionAuthResponseParameters): any => ({ ...obj, }); @@ -1453,6 +1624,9 @@ export interface DescribeConnectionResponse { } export namespace DescribeConnectionResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeConnectionResponse): any => ({ ...obj, }); @@ -1467,6 +1641,9 @@ export interface DescribeEventBusRequest { } export namespace DescribeEventBusRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeEventBusRequest): any => ({ ...obj, }); @@ -1491,6 +1668,9 @@ export interface DescribeEventBusResponse { } export namespace DescribeEventBusResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeEventBusResponse): any => ({ ...obj, }); @@ -1504,6 +1684,9 @@ export interface DescribeEventSourceRequest { } export namespace DescribeEventSourceRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeEventSourceRequest): any => ({ ...obj, }); @@ -1552,6 +1735,9 @@ export interface DescribeEventSourceResponse { } export namespace DescribeEventSourceResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeEventSourceResponse): any => ({ ...obj, }); @@ -1565,6 +1751,9 @@ export interface DescribePartnerEventSourceRequest { } export namespace DescribePartnerEventSourceRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribePartnerEventSourceRequest): any => ({ ...obj, }); @@ -1583,6 +1772,9 @@ export interface DescribePartnerEventSourceResponse { } export namespace DescribePartnerEventSourceResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribePartnerEventSourceResponse): any => ({ ...obj, }); @@ -1596,6 +1788,9 @@ export interface DescribeReplayRequest { } export namespace DescribeReplayRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeReplayRequest): any => ({ ...obj, }); @@ -1618,6 +1813,9 @@ export interface ReplayDestination { } export namespace ReplayDestination { + /** + * @internal + */ export const filterSensitiveLog = (obj: ReplayDestination): any => ({ ...obj, }); @@ -1686,6 +1884,9 @@ export interface DescribeReplayResponse { } export namespace DescribeReplayResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeReplayResponse): any => ({ ...obj, }); @@ -1705,6 +1906,9 @@ export interface DescribeRuleRequest { } export namespace DescribeRuleRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeRuleRequest): any => ({ ...obj, }); @@ -1774,6 +1978,9 @@ export interface DescribeRuleResponse { } export namespace DescribeRuleResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeRuleResponse): any => ({ ...obj, }); @@ -1793,6 +2000,9 @@ export interface DisableRuleRequest { } export namespace DisableRuleRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DisableRuleRequest): any => ({ ...obj, }); @@ -1812,6 +2022,9 @@ export interface EnableRuleRequest { } export namespace EnableRuleRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: EnableRuleRequest): any => ({ ...obj, }); @@ -1841,6 +2054,9 @@ export interface ListApiDestinationsRequest { } export namespace ListApiDestinationsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListApiDestinationsRequest): any => ({ ...obj, }); @@ -1860,6 +2076,9 @@ export interface ListApiDestinationsResponse { } export namespace ListApiDestinationsResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListApiDestinationsResponse): any => ({ ...obj, }); @@ -1894,6 +2113,9 @@ export interface ListArchivesRequest { } export namespace ListArchivesRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListArchivesRequest): any => ({ ...obj, }); @@ -1912,6 +2134,9 @@ export interface ListArchivesResponse { } export namespace ListArchivesResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListArchivesResponse): any => ({ ...obj, }); @@ -1941,6 +2166,9 @@ export interface ListConnectionsRequest { } export namespace ListConnectionsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListConnectionsRequest): any => ({ ...obj, }); @@ -1992,6 +2220,9 @@ export interface Connection { } export namespace Connection { + /** + * @internal + */ export const filterSensitiveLog = (obj: Connection): any => ({ ...obj, }); @@ -2010,6 +2241,9 @@ export interface ListConnectionsResponse { } export namespace ListConnectionsResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListConnectionsResponse): any => ({ ...obj, }); @@ -2036,6 +2270,9 @@ export interface ListEventBusesRequest { } export namespace ListEventBusesRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListEventBusesRequest): any => ({ ...obj, }); @@ -2067,6 +2304,9 @@ export interface EventBus { } export namespace EventBus { + /** + * @internal + */ export const filterSensitiveLog = (obj: EventBus): any => ({ ...obj, }); @@ -2085,6 +2325,9 @@ export interface ListEventBusesResponse { } export namespace ListEventBusesResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListEventBusesResponse): any => ({ ...obj, }); @@ -2111,6 +2354,9 @@ export interface ListEventSourcesRequest { } export namespace ListEventSourcesRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListEventSourcesRequest): any => ({ ...obj, }); @@ -2158,6 +2404,9 @@ export interface EventSource { } export namespace EventSource { + /** + * @internal + */ export const filterSensitiveLog = (obj: EventSource): any => ({ ...obj, }); @@ -2176,6 +2425,9 @@ export interface ListEventSourcesResponse { } export namespace ListEventSourcesResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListEventSourcesResponse): any => ({ ...obj, }); @@ -2202,6 +2454,9 @@ export interface ListPartnerEventSourceAccountsRequest { } export namespace ListPartnerEventSourceAccountsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListPartnerEventSourceAccountsRequest): any => ({ ...obj, }); @@ -2237,6 +2492,9 @@ export interface PartnerEventSourceAccount { } export namespace PartnerEventSourceAccount { + /** + * @internal + */ export const filterSensitiveLog = (obj: PartnerEventSourceAccount): any => ({ ...obj, }); @@ -2255,6 +2513,9 @@ export interface ListPartnerEventSourceAccountsResponse { } export namespace ListPartnerEventSourceAccountsResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListPartnerEventSourceAccountsResponse): any => ({ ...obj, }); @@ -2282,6 +2543,9 @@ export interface ListPartnerEventSourcesRequest { } export namespace ListPartnerEventSourcesRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListPartnerEventSourcesRequest): any => ({ ...obj, }); @@ -2305,6 +2569,9 @@ export interface PartnerEventSource { } export namespace PartnerEventSource { + /** + * @internal + */ export const filterSensitiveLog = (obj: PartnerEventSource): any => ({ ...obj, }); @@ -2323,6 +2590,9 @@ export interface ListPartnerEventSourcesResponse { } export namespace ListPartnerEventSourcesResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListPartnerEventSourcesResponse): any => ({ ...obj, }); @@ -2357,6 +2627,9 @@ export interface ListReplaysRequest { } export namespace ListReplaysRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListReplaysRequest): any => ({ ...obj, }); @@ -2415,6 +2688,9 @@ export interface Replay { } export namespace Replay { + /** + * @internal + */ export const filterSensitiveLog = (obj: Replay): any => ({ ...obj, }); @@ -2433,6 +2709,9 @@ export interface ListReplaysResponse { } export namespace ListReplaysResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListReplaysResponse): any => ({ ...obj, }); @@ -2462,6 +2741,9 @@ export interface ListRuleNamesByTargetRequest { } export namespace ListRuleNamesByTargetRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListRuleNamesByTargetRequest): any => ({ ...obj, }); @@ -2481,6 +2763,9 @@ export interface ListRuleNamesByTargetResponse { } export namespace ListRuleNamesByTargetResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListRuleNamesByTargetResponse): any => ({ ...obj, }); @@ -2510,6 +2795,9 @@ export interface ListRulesRequest { } export namespace ListRulesRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListRulesRequest): any => ({ ...obj, }); @@ -2569,6 +2857,9 @@ export interface Rule { } export namespace Rule { + /** + * @internal + */ export const filterSensitiveLog = (obj: Rule): any => ({ ...obj, }); @@ -2588,6 +2879,9 @@ export interface ListRulesResponse { } export namespace ListRulesResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListRulesResponse): any => ({ ...obj, }); @@ -2601,6 +2895,9 @@ export interface ListTagsForResourceRequest { } export namespace ListTagsForResourceRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListTagsForResourceRequest): any => ({ ...obj, }); @@ -2614,6 +2911,9 @@ export interface ListTagsForResourceResponse { } export namespace ListTagsForResourceResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListTagsForResourceResponse): any => ({ ...obj, }); @@ -2643,6 +2943,9 @@ export interface ListTargetsByRuleRequest { } export namespace ListTargetsByRuleRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListTargetsByRuleRequest): any => ({ ...obj, }); @@ -2662,6 +2965,9 @@ export interface BatchArrayProperties { } export namespace BatchArrayProperties { + /** + * @internal + */ export const filterSensitiveLog = (obj: BatchArrayProperties): any => ({ ...obj, }); @@ -2680,6 +2986,9 @@ export interface BatchRetryStrategy { } export namespace BatchRetryStrategy { + /** + * @internal + */ export const filterSensitiveLog = (obj: BatchRetryStrategy): any => ({ ...obj, }); @@ -2717,6 +3026,9 @@ export interface BatchParameters { } export namespace BatchParameters { + /** + * @internal + */ export const filterSensitiveLog = (obj: BatchParameters): any => ({ ...obj, }); @@ -2734,6 +3046,9 @@ export interface DeadLetterConfig { } export namespace DeadLetterConfig { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeadLetterConfig): any => ({ ...obj, }); @@ -2772,6 +3087,9 @@ export interface AwsVpcConfiguration { } export namespace AwsVpcConfiguration { + /** + * @internal + */ export const filterSensitiveLog = (obj: AwsVpcConfiguration): any => ({ ...obj, }); @@ -2790,6 +3108,9 @@ export interface NetworkConfiguration { } export namespace NetworkConfiguration { + /** + * @internal + */ export const filterSensitiveLog = (obj: NetworkConfiguration): any => ({ ...obj, }); @@ -2847,6 +3168,9 @@ export interface EcsParameters { } export namespace EcsParameters { + /** + * @internal + */ export const filterSensitiveLog = (obj: EcsParameters): any => ({ ...obj, }); @@ -2878,6 +3202,9 @@ export interface HttpParameters { } export namespace HttpParameters { + /** + * @internal + */ export const filterSensitiveLog = (obj: HttpParameters): any => ({ ...obj, }); @@ -2973,6 +3300,9 @@ export interface InputTransformer { } export namespace InputTransformer { + /** + * @internal + */ export const filterSensitiveLog = (obj: InputTransformer): any => ({ ...obj, }); @@ -2994,6 +3324,9 @@ export interface KinesisParameters { } export namespace KinesisParameters { + /** + * @internal + */ export const filterSensitiveLog = (obj: KinesisParameters): any => ({ ...obj, }); @@ -3039,6 +3372,9 @@ export interface RedshiftDataParameters { } export namespace RedshiftDataParameters { + /** + * @internal + */ export const filterSensitiveLog = (obj: RedshiftDataParameters): any => ({ ...obj, }); @@ -3063,6 +3399,9 @@ export interface RetryPolicy { } export namespace RetryPolicy { + /** + * @internal + */ export const filterSensitiveLog = (obj: RetryPolicy): any => ({ ...obj, }); @@ -3091,6 +3430,9 @@ export interface RunCommandTarget { } export namespace RunCommandTarget { + /** + * @internal + */ export const filterSensitiveLog = (obj: RunCommandTarget): any => ({ ...obj, }); @@ -3109,6 +3451,9 @@ export interface RunCommandParameters { } export namespace RunCommandParameters { + /** + * @internal + */ export const filterSensitiveLog = (obj: RunCommandParameters): any => ({ ...obj, }); @@ -3131,6 +3476,9 @@ export interface SageMakerPipelineParameter { } export namespace SageMakerPipelineParameter { + /** + * @internal + */ export const filterSensitiveLog = (obj: SageMakerPipelineParameter): any => ({ ...obj, }); @@ -3148,6 +3496,9 @@ export interface SageMakerPipelineParameters { } export namespace SageMakerPipelineParameters { + /** + * @internal + */ export const filterSensitiveLog = (obj: SageMakerPipelineParameters): any => ({ ...obj, }); @@ -3165,6 +3516,9 @@ export interface SqsParameters { } export namespace SqsParameters { + /** + * @internal + */ export const filterSensitiveLog = (obj: SqsParameters): any => ({ ...obj, }); @@ -3295,6 +3649,9 @@ export interface Target { } export namespace Target { + /** + * @internal + */ export const filterSensitiveLog = (obj: Target): any => ({ ...obj, }); @@ -3314,6 +3671,9 @@ export interface ListTargetsByRuleResponse { } export namespace ListTargetsByRuleResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListTargetsByRuleResponse): any => ({ ...obj, }); @@ -3365,6 +3725,9 @@ export interface PutEventsRequestEntry { } export namespace PutEventsRequestEntry { + /** + * @internal + */ export const filterSensitiveLog = (obj: PutEventsRequestEntry): any => ({ ...obj, }); @@ -3380,6 +3743,9 @@ export interface PutEventsRequest { } export namespace PutEventsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: PutEventsRequest): any => ({ ...obj, }); @@ -3406,6 +3772,9 @@ export interface PutEventsResultEntry { } export namespace PutEventsResultEntry { + /** + * @internal + */ export const filterSensitiveLog = (obj: PutEventsResultEntry): any => ({ ...obj, }); @@ -3426,6 +3795,9 @@ export interface PutEventsResponse { } export namespace PutEventsResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: PutEventsResponse): any => ({ ...obj, }); @@ -3464,6 +3836,9 @@ export interface PutPartnerEventsRequestEntry { } export namespace PutPartnerEventsRequestEntry { + /** + * @internal + */ export const filterSensitiveLog = (obj: PutPartnerEventsRequestEntry): any => ({ ...obj, }); @@ -3477,6 +3852,9 @@ export interface PutPartnerEventsRequest { } export namespace PutPartnerEventsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: PutPartnerEventsRequest): any => ({ ...obj, }); @@ -3503,6 +3881,9 @@ export interface PutPartnerEventsResultEntry { } export namespace PutPartnerEventsResultEntry { + /** + * @internal + */ export const filterSensitiveLog = (obj: PutPartnerEventsResultEntry): any => ({ ...obj, }); @@ -3523,6 +3904,9 @@ export interface PutPartnerEventsResponse { } export namespace PutPartnerEventsResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: PutPartnerEventsResponse): any => ({ ...obj, }); @@ -3538,6 +3922,9 @@ export interface PolicyLengthExceededException extends __SmithyException, $Metad } export namespace PolicyLengthExceededException { + /** + * @internal + */ export const filterSensitiveLog = (obj: PolicyLengthExceededException): any => ({ ...obj, }); @@ -3575,6 +3962,9 @@ export interface Condition { } export namespace Condition { + /** + * @internal + */ export const filterSensitiveLog = (obj: Condition): any => ({ ...obj, }); @@ -3635,6 +4025,9 @@ export interface PutPermissionRequest { } export namespace PutPermissionRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: PutPermissionRequest): any => ({ ...obj, }); @@ -3685,6 +4078,9 @@ export interface PutRuleRequest { } export namespace PutRuleRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: PutRuleRequest): any => ({ ...obj, }); @@ -3698,6 +4094,9 @@ export interface PutRuleResponse { } export namespace PutRuleResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: PutRuleResponse): any => ({ ...obj, }); @@ -3722,6 +4121,9 @@ export interface PutTargetsRequest { } export namespace PutTargetsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: PutTargetsRequest): any => ({ ...obj, }); @@ -3750,6 +4152,9 @@ export interface PutTargetsResultEntry { } export namespace PutTargetsResultEntry { + /** + * @internal + */ export const filterSensitiveLog = (obj: PutTargetsResultEntry): any => ({ ...obj, }); @@ -3768,6 +4173,9 @@ export interface PutTargetsResponse { } export namespace PutTargetsResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: PutTargetsResponse): any => ({ ...obj, }); @@ -3793,6 +4201,9 @@ export interface RemovePermissionRequest { } export namespace RemovePermissionRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: RemovePermissionRequest): any => ({ ...obj, }); @@ -3826,6 +4237,9 @@ export interface RemoveTargetsRequest { } export namespace RemoveTargetsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: RemoveTargetsRequest): any => ({ ...obj, }); @@ -3854,6 +4268,9 @@ export interface RemoveTargetsResultEntry { } export namespace RemoveTargetsResultEntry { + /** + * @internal + */ export const filterSensitiveLog = (obj: RemoveTargetsResultEntry): any => ({ ...obj, }); @@ -3872,6 +4289,9 @@ export interface RemoveTargetsResponse { } export namespace RemoveTargetsResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: RemoveTargetsResponse): any => ({ ...obj, }); @@ -3913,6 +4333,9 @@ export interface StartReplayRequest { } export namespace StartReplayRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: StartReplayRequest): any => ({ ...obj, }); @@ -3941,6 +4364,9 @@ export interface StartReplayResponse { } export namespace StartReplayResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: StartReplayResponse): any => ({ ...obj, }); @@ -3959,6 +4385,9 @@ export interface TagResourceRequest { } export namespace TagResourceRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: TagResourceRequest): any => ({ ...obj, }); @@ -3967,6 +4396,9 @@ export namespace TagResourceRequest { export interface TagResourceResponse {} export namespace TagResourceResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: TagResourceResponse): any => ({ ...obj, }); @@ -4025,6 +4457,9 @@ export interface TestEventPatternRequest { } export namespace TestEventPatternRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: TestEventPatternRequest): any => ({ ...obj, }); @@ -4038,6 +4473,9 @@ export interface TestEventPatternResponse { } export namespace TestEventPatternResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: TestEventPatternResponse): any => ({ ...obj, }); @@ -4056,6 +4494,9 @@ export interface UntagResourceRequest { } export namespace UntagResourceRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: UntagResourceRequest): any => ({ ...obj, }); @@ -4064,6 +4505,9 @@ export namespace UntagResourceRequest { export interface UntagResourceResponse {} export namespace UntagResourceResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: UntagResourceResponse): any => ({ ...obj, }); @@ -4102,6 +4546,9 @@ export interface UpdateApiDestinationRequest { } export namespace UpdateApiDestinationRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateApiDestinationRequest): any => ({ ...obj, }); @@ -4130,6 +4577,9 @@ export interface UpdateApiDestinationResponse { } export namespace UpdateApiDestinationResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateApiDestinationResponse): any => ({ ...obj, }); @@ -4158,6 +4608,9 @@ export interface UpdateArchiveRequest { } export namespace UpdateArchiveRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateArchiveRequest): any => ({ ...obj, }); @@ -4186,6 +4639,9 @@ export interface UpdateArchiveResponse { } export namespace UpdateArchiveResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateArchiveResponse): any => ({ ...obj, }); @@ -4207,6 +4663,9 @@ export interface UpdateConnectionApiKeyAuthRequestParameters { } export namespace UpdateConnectionApiKeyAuthRequestParameters { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateConnectionApiKeyAuthRequestParameters): any => ({ ...obj, }); @@ -4228,6 +4687,9 @@ export interface UpdateConnectionBasicAuthRequestParameters { } export namespace UpdateConnectionBasicAuthRequestParameters { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateConnectionBasicAuthRequestParameters): any => ({ ...obj, }); @@ -4249,6 +4711,9 @@ export interface UpdateConnectionOAuthClientRequestParameters { } export namespace UpdateConnectionOAuthClientRequestParameters { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateConnectionOAuthClientRequestParameters): any => ({ ...obj, }); @@ -4283,6 +4748,9 @@ export interface UpdateConnectionOAuthRequestParameters { } export namespace UpdateConnectionOAuthRequestParameters { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateConnectionOAuthRequestParameters): any => ({ ...obj, }); @@ -4318,6 +4786,9 @@ export interface UpdateConnectionAuthRequestParameters { } export namespace UpdateConnectionAuthRequestParameters { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateConnectionAuthRequestParameters): any => ({ ...obj, }); @@ -4346,6 +4817,9 @@ export interface UpdateConnectionRequest { } export namespace UpdateConnectionRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateConnectionRequest): any => ({ ...obj, }); @@ -4379,6 +4853,9 @@ export interface UpdateConnectionResponse { } export namespace UpdateConnectionResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateConnectionResponse): any => ({ ...obj, }); diff --git a/clients/client-cloudwatch-logs/commands/AssociateKmsKeyCommand.ts b/clients/client-cloudwatch-logs/commands/AssociateKmsKeyCommand.ts index d44b2f9579cf..a317f45df8a7 100644 --- a/clients/client-cloudwatch-logs/commands/AssociateKmsKeyCommand.ts +++ b/clients/client-cloudwatch-logs/commands/AssociateKmsKeyCommand.ts @@ -34,6 +34,20 @@ export interface AssociateKmsKeyCommandOutput extends __MetadataBearer {} *

It can take up to 5 minutes for this operation to take effect.

*

If you attempt to associate a CMK with a log group but the CMK does not exist or the * CMK is disabled, you receive an InvalidParameterException error.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { CloudWatchLogsClient, AssociateKmsKeyCommand } from "@aws-sdk/client-cloudwatch-logs"; // ES Modules import + * // const { CloudWatchLogsClient, AssociateKmsKeyCommand } = require("@aws-sdk/client-cloudwatch-logs"); // CommonJS import + * const client = new CloudWatchLogsClient(config); + * const command = new AssociateKmsKeyCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link AssociateKmsKeyCommandInput} for command's `input` shape. + * @see {@link AssociateKmsKeyCommandOutput} for command's `response` shape. + * @see {@link CloudWatchLogsClientResolvedConfig | config} for command's `input` shape. + * */ export class AssociateKmsKeyCommand extends $Command< AssociateKmsKeyCommandInput, diff --git a/clients/client-cloudwatch-logs/commands/CancelExportTaskCommand.ts b/clients/client-cloudwatch-logs/commands/CancelExportTaskCommand.ts index 569d2543835d..eba8d2550a19 100644 --- a/clients/client-cloudwatch-logs/commands/CancelExportTaskCommand.ts +++ b/clients/client-cloudwatch-logs/commands/CancelExportTaskCommand.ts @@ -23,6 +23,20 @@ export interface CancelExportTaskCommandOutput extends __MetadataBearer {} /** *

Cancels the specified export task.

*

The task must be in the PENDING or RUNNING state.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { CloudWatchLogsClient, CancelExportTaskCommand } from "@aws-sdk/client-cloudwatch-logs"; // ES Modules import + * // const { CloudWatchLogsClient, CancelExportTaskCommand } = require("@aws-sdk/client-cloudwatch-logs"); // CommonJS import + * const client = new CloudWatchLogsClient(config); + * const command = new CancelExportTaskCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CancelExportTaskCommandInput} for command's `input` shape. + * @see {@link CancelExportTaskCommandOutput} for command's `response` shape. + * @see {@link CloudWatchLogsClientResolvedConfig | config} for command's `input` shape. + * */ export class CancelExportTaskCommand extends $Command< CancelExportTaskCommandInput, diff --git a/clients/client-cloudwatch-logs/commands/CreateExportTaskCommand.ts b/clients/client-cloudwatch-logs/commands/CreateExportTaskCommand.ts index 6ffb6bbdd549..f0b125b7fa1d 100644 --- a/clients/client-cloudwatch-logs/commands/CreateExportTaskCommand.ts +++ b/clients/client-cloudwatch-logs/commands/CreateExportTaskCommand.ts @@ -35,6 +35,20 @@ export interface CreateExportTaskCommandOutput extends CreateExportTaskResponse, * the Amazon S3 key prefix for all exported objects.

*

Exporting to S3 buckets that are encrypted with AES-256 is supported. Exporting to S3 buckets * encrypted with SSE-KMS is not supported.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { CloudWatchLogsClient, CreateExportTaskCommand } from "@aws-sdk/client-cloudwatch-logs"; // ES Modules import + * // const { CloudWatchLogsClient, CreateExportTaskCommand } = require("@aws-sdk/client-cloudwatch-logs"); // CommonJS import + * const client = new CloudWatchLogsClient(config); + * const command = new CreateExportTaskCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreateExportTaskCommandInput} for command's `input` shape. + * @see {@link CreateExportTaskCommandOutput} for command's `response` shape. + * @see {@link CloudWatchLogsClientResolvedConfig | config} for command's `input` shape. + * */ export class CreateExportTaskCommand extends $Command< CreateExportTaskCommandInput, diff --git a/clients/client-cloudwatch-logs/commands/CreateLogGroupCommand.ts b/clients/client-cloudwatch-logs/commands/CreateLogGroupCommand.ts index 317c7559bd78..5653e79458ac 100644 --- a/clients/client-cloudwatch-logs/commands/CreateLogGroupCommand.ts +++ b/clients/client-cloudwatch-logs/commands/CreateLogGroupCommand.ts @@ -48,6 +48,20 @@ export interface CreateLogGroupCommandOutput extends __MetadataBearer {} * your log group. For more information, see Using Symmetric and Asymmetric * Keys.

* + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { CloudWatchLogsClient, CreateLogGroupCommand } from "@aws-sdk/client-cloudwatch-logs"; // ES Modules import + * // const { CloudWatchLogsClient, CreateLogGroupCommand } = require("@aws-sdk/client-cloudwatch-logs"); // CommonJS import + * const client = new CloudWatchLogsClient(config); + * const command = new CreateLogGroupCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreateLogGroupCommandInput} for command's `input` shape. + * @see {@link CreateLogGroupCommandOutput} for command's `response` shape. + * @see {@link CloudWatchLogsClientResolvedConfig | config} for command's `input` shape. + * */ export class CreateLogGroupCommand extends $Command< CreateLogGroupCommandInput, diff --git a/clients/client-cloudwatch-logs/commands/CreateLogStreamCommand.ts b/clients/client-cloudwatch-logs/commands/CreateLogStreamCommand.ts index 900ee71ab8f3..e5997732ad43 100644 --- a/clients/client-cloudwatch-logs/commands/CreateLogStreamCommand.ts +++ b/clients/client-cloudwatch-logs/commands/CreateLogStreamCommand.ts @@ -38,6 +38,20 @@ export interface CreateLogStreamCommandOutput extends __MetadataBearer {} *

The ':' (colon) and '*' (asterisk) characters are not allowed.

* * + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { CloudWatchLogsClient, CreateLogStreamCommand } from "@aws-sdk/client-cloudwatch-logs"; // ES Modules import + * // const { CloudWatchLogsClient, CreateLogStreamCommand } = require("@aws-sdk/client-cloudwatch-logs"); // CommonJS import + * const client = new CloudWatchLogsClient(config); + * const command = new CreateLogStreamCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreateLogStreamCommandInput} for command's `input` shape. + * @see {@link CreateLogStreamCommandOutput} for command's `response` shape. + * @see {@link CloudWatchLogsClientResolvedConfig | config} for command's `input` shape. + * */ export class CreateLogStreamCommand extends $Command< CreateLogStreamCommandInput, diff --git a/clients/client-cloudwatch-logs/commands/DeleteDestinationCommand.ts b/clients/client-cloudwatch-logs/commands/DeleteDestinationCommand.ts index 179732c4fa4c..5ced04c21444 100644 --- a/clients/client-cloudwatch-logs/commands/DeleteDestinationCommand.ts +++ b/clients/client-cloudwatch-logs/commands/DeleteDestinationCommand.ts @@ -24,6 +24,20 @@ export interface DeleteDestinationCommandOutput extends __MetadataBearer {} *

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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { CloudWatchLogsClient, DeleteDestinationCommand } from "@aws-sdk/client-cloudwatch-logs"; // ES Modules import + * // const { CloudWatchLogsClient, DeleteDestinationCommand } = require("@aws-sdk/client-cloudwatch-logs"); // CommonJS import + * const client = new CloudWatchLogsClient(config); + * const command = new DeleteDestinationCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteDestinationCommandInput} for command's `input` shape. + * @see {@link DeleteDestinationCommandOutput} for command's `response` shape. + * @see {@link CloudWatchLogsClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteDestinationCommand extends $Command< DeleteDestinationCommandInput, diff --git a/clients/client-cloudwatch-logs/commands/DeleteLogGroupCommand.ts b/clients/client-cloudwatch-logs/commands/DeleteLogGroupCommand.ts index 7407bdde350d..1ff1ee57e4bf 100644 --- a/clients/client-cloudwatch-logs/commands/DeleteLogGroupCommand.ts +++ b/clients/client-cloudwatch-logs/commands/DeleteLogGroupCommand.ts @@ -23,6 +23,20 @@ export interface DeleteLogGroupCommandOutput extends __MetadataBearer {} /** *

Deletes the specified log group and permanently deletes all the archived * log events associated with the log group.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { CloudWatchLogsClient, DeleteLogGroupCommand } from "@aws-sdk/client-cloudwatch-logs"; // ES Modules import + * // const { CloudWatchLogsClient, DeleteLogGroupCommand } = require("@aws-sdk/client-cloudwatch-logs"); // CommonJS import + * const client = new CloudWatchLogsClient(config); + * const command = new DeleteLogGroupCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteLogGroupCommandInput} for command's `input` shape. + * @see {@link DeleteLogGroupCommandOutput} for command's `response` shape. + * @see {@link CloudWatchLogsClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteLogGroupCommand extends $Command< DeleteLogGroupCommandInput, diff --git a/clients/client-cloudwatch-logs/commands/DeleteLogStreamCommand.ts b/clients/client-cloudwatch-logs/commands/DeleteLogStreamCommand.ts index 78417aeafb1a..91e6eb5bff24 100644 --- a/clients/client-cloudwatch-logs/commands/DeleteLogStreamCommand.ts +++ b/clients/client-cloudwatch-logs/commands/DeleteLogStreamCommand.ts @@ -23,6 +23,20 @@ export interface DeleteLogStreamCommandOutput extends __MetadataBearer {} /** *

Deletes the specified log stream and permanently deletes all the archived log events associated * with the log stream.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { CloudWatchLogsClient, DeleteLogStreamCommand } from "@aws-sdk/client-cloudwatch-logs"; // ES Modules import + * // const { CloudWatchLogsClient, DeleteLogStreamCommand } = require("@aws-sdk/client-cloudwatch-logs"); // CommonJS import + * const client = new CloudWatchLogsClient(config); + * const command = new DeleteLogStreamCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteLogStreamCommandInput} for command's `input` shape. + * @see {@link DeleteLogStreamCommandOutput} for command's `response` shape. + * @see {@link CloudWatchLogsClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteLogStreamCommand extends $Command< DeleteLogStreamCommandInput, diff --git a/clients/client-cloudwatch-logs/commands/DeleteMetricFilterCommand.ts b/clients/client-cloudwatch-logs/commands/DeleteMetricFilterCommand.ts index 46e7d5c6a2d2..6577b5888c03 100644 --- a/clients/client-cloudwatch-logs/commands/DeleteMetricFilterCommand.ts +++ b/clients/client-cloudwatch-logs/commands/DeleteMetricFilterCommand.ts @@ -22,6 +22,20 @@ export interface DeleteMetricFilterCommandOutput extends __MetadataBearer {} /** *

Deletes the specified metric filter.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { CloudWatchLogsClient, DeleteMetricFilterCommand } from "@aws-sdk/client-cloudwatch-logs"; // ES Modules import + * // const { CloudWatchLogsClient, DeleteMetricFilterCommand } = require("@aws-sdk/client-cloudwatch-logs"); // CommonJS import + * const client = new CloudWatchLogsClient(config); + * const command = new DeleteMetricFilterCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteMetricFilterCommandInput} for command's `input` shape. + * @see {@link DeleteMetricFilterCommandOutput} for command's `response` shape. + * @see {@link CloudWatchLogsClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteMetricFilterCommand extends $Command< DeleteMetricFilterCommandInput, diff --git a/clients/client-cloudwatch-logs/commands/DeleteQueryDefinitionCommand.ts b/clients/client-cloudwatch-logs/commands/DeleteQueryDefinitionCommand.ts index 626d6806047e..7f4cc1c32790 100644 --- a/clients/client-cloudwatch-logs/commands/DeleteQueryDefinitionCommand.ts +++ b/clients/client-cloudwatch-logs/commands/DeleteQueryDefinitionCommand.ts @@ -26,6 +26,20 @@ export interface DeleteQueryDefinitionCommandOutput extends DeleteQueryDefinitio *

Each DeleteQueryDefinition operation can delete one query definition.

*

You must have the logs:DeleteQueryDefinition permission to be able to perform * this operation.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { CloudWatchLogsClient, DeleteQueryDefinitionCommand } from "@aws-sdk/client-cloudwatch-logs"; // ES Modules import + * // const { CloudWatchLogsClient, DeleteQueryDefinitionCommand } = require("@aws-sdk/client-cloudwatch-logs"); // CommonJS import + * const client = new CloudWatchLogsClient(config); + * const command = new DeleteQueryDefinitionCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteQueryDefinitionCommandInput} for command's `input` shape. + * @see {@link DeleteQueryDefinitionCommandOutput} for command's `response` shape. + * @see {@link CloudWatchLogsClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteQueryDefinitionCommand extends $Command< DeleteQueryDefinitionCommandInput, diff --git a/clients/client-cloudwatch-logs/commands/DeleteResourcePolicyCommand.ts b/clients/client-cloudwatch-logs/commands/DeleteResourcePolicyCommand.ts index 99b660927c86..04a208d49c43 100644 --- a/clients/client-cloudwatch-logs/commands/DeleteResourcePolicyCommand.ts +++ b/clients/client-cloudwatch-logs/commands/DeleteResourcePolicyCommand.ts @@ -23,6 +23,20 @@ export interface DeleteResourcePolicyCommandOutput extends __MetadataBearer {} /** *

Deletes a resource policy from this account. This revokes * the access of the identities in that policy to put log events to this account.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { CloudWatchLogsClient, DeleteResourcePolicyCommand } from "@aws-sdk/client-cloudwatch-logs"; // ES Modules import + * // const { CloudWatchLogsClient, DeleteResourcePolicyCommand } = require("@aws-sdk/client-cloudwatch-logs"); // CommonJS import + * const client = new CloudWatchLogsClient(config); + * const command = new DeleteResourcePolicyCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteResourcePolicyCommandInput} for command's `input` shape. + * @see {@link DeleteResourcePolicyCommandOutput} for command's `response` shape. + * @see {@link CloudWatchLogsClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteResourcePolicyCommand extends $Command< DeleteResourcePolicyCommandInput, diff --git a/clients/client-cloudwatch-logs/commands/DeleteRetentionPolicyCommand.ts b/clients/client-cloudwatch-logs/commands/DeleteRetentionPolicyCommand.ts index 715cebb721e8..7326e6f96ffd 100644 --- a/clients/client-cloudwatch-logs/commands/DeleteRetentionPolicyCommand.ts +++ b/clients/client-cloudwatch-logs/commands/DeleteRetentionPolicyCommand.ts @@ -23,6 +23,20 @@ export interface DeleteRetentionPolicyCommandOutput extends __MetadataBearer {} /** *

Deletes the specified retention policy.

*

Log events do not expire if they belong to log groups without a retention policy.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { CloudWatchLogsClient, DeleteRetentionPolicyCommand } from "@aws-sdk/client-cloudwatch-logs"; // ES Modules import + * // const { CloudWatchLogsClient, DeleteRetentionPolicyCommand } = require("@aws-sdk/client-cloudwatch-logs"); // CommonJS import + * const client = new CloudWatchLogsClient(config); + * const command = new DeleteRetentionPolicyCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteRetentionPolicyCommandInput} for command's `input` shape. + * @see {@link DeleteRetentionPolicyCommandOutput} for command's `response` shape. + * @see {@link CloudWatchLogsClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteRetentionPolicyCommand extends $Command< DeleteRetentionPolicyCommandInput, diff --git a/clients/client-cloudwatch-logs/commands/DeleteSubscriptionFilterCommand.ts b/clients/client-cloudwatch-logs/commands/DeleteSubscriptionFilterCommand.ts index cf08c1d9d785..cb57fcc7ea12 100644 --- a/clients/client-cloudwatch-logs/commands/DeleteSubscriptionFilterCommand.ts +++ b/clients/client-cloudwatch-logs/commands/DeleteSubscriptionFilterCommand.ts @@ -22,6 +22,20 @@ export interface DeleteSubscriptionFilterCommandOutput extends __MetadataBearer /** *

Deletes the specified subscription filter.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { CloudWatchLogsClient, DeleteSubscriptionFilterCommand } from "@aws-sdk/client-cloudwatch-logs"; // ES Modules import + * // const { CloudWatchLogsClient, DeleteSubscriptionFilterCommand } = require("@aws-sdk/client-cloudwatch-logs"); // CommonJS import + * const client = new CloudWatchLogsClient(config); + * const command = new DeleteSubscriptionFilterCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteSubscriptionFilterCommandInput} for command's `input` shape. + * @see {@link DeleteSubscriptionFilterCommandOutput} for command's `response` shape. + * @see {@link CloudWatchLogsClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteSubscriptionFilterCommand extends $Command< DeleteSubscriptionFilterCommandInput, diff --git a/clients/client-cloudwatch-logs/commands/DescribeDestinationsCommand.ts b/clients/client-cloudwatch-logs/commands/DescribeDestinationsCommand.ts index 1c06c2a29315..7cbac27fe431 100644 --- a/clients/client-cloudwatch-logs/commands/DescribeDestinationsCommand.ts +++ b/clients/client-cloudwatch-logs/commands/DescribeDestinationsCommand.ts @@ -22,6 +22,20 @@ export interface DescribeDestinationsCommandOutput extends DescribeDestinationsR /** *

Lists all your destinations. The results are ASCII-sorted by destination name.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { CloudWatchLogsClient, DescribeDestinationsCommand } from "@aws-sdk/client-cloudwatch-logs"; // ES Modules import + * // const { CloudWatchLogsClient, DescribeDestinationsCommand } = require("@aws-sdk/client-cloudwatch-logs"); // CommonJS import + * const client = new CloudWatchLogsClient(config); + * const command = new DescribeDestinationsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeDestinationsCommandInput} for command's `input` shape. + * @see {@link DescribeDestinationsCommandOutput} for command's `response` shape. + * @see {@link CloudWatchLogsClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeDestinationsCommand extends $Command< DescribeDestinationsCommandInput, diff --git a/clients/client-cloudwatch-logs/commands/DescribeExportTasksCommand.ts b/clients/client-cloudwatch-logs/commands/DescribeExportTasksCommand.ts index 45b8c09e4e6c..d309b2a53c29 100644 --- a/clients/client-cloudwatch-logs/commands/DescribeExportTasksCommand.ts +++ b/clients/client-cloudwatch-logs/commands/DescribeExportTasksCommand.ts @@ -23,6 +23,20 @@ export interface DescribeExportTasksCommandOutput extends DescribeExportTasksRes /** *

Lists the specified export tasks. You can list all your export tasks or filter * the results based on task ID or task status.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { CloudWatchLogsClient, DescribeExportTasksCommand } from "@aws-sdk/client-cloudwatch-logs"; // ES Modules import + * // const { CloudWatchLogsClient, DescribeExportTasksCommand } = require("@aws-sdk/client-cloudwatch-logs"); // CommonJS import + * const client = new CloudWatchLogsClient(config); + * const command = new DescribeExportTasksCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeExportTasksCommandInput} for command's `input` shape. + * @see {@link DescribeExportTasksCommandOutput} for command's `response` shape. + * @see {@link CloudWatchLogsClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeExportTasksCommand extends $Command< DescribeExportTasksCommandInput, diff --git a/clients/client-cloudwatch-logs/commands/DescribeLogGroupsCommand.ts b/clients/client-cloudwatch-logs/commands/DescribeLogGroupsCommand.ts index fce2f8c579fc..e39f5618c1d2 100644 --- a/clients/client-cloudwatch-logs/commands/DescribeLogGroupsCommand.ts +++ b/clients/client-cloudwatch-logs/commands/DescribeLogGroupsCommand.ts @@ -23,6 +23,20 @@ export interface DescribeLogGroupsCommandOutput extends DescribeLogGroupsRespons /** *

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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { CloudWatchLogsClient, DescribeLogGroupsCommand } from "@aws-sdk/client-cloudwatch-logs"; // ES Modules import + * // const { CloudWatchLogsClient, DescribeLogGroupsCommand } = require("@aws-sdk/client-cloudwatch-logs"); // CommonJS import + * const client = new CloudWatchLogsClient(config); + * const command = new DescribeLogGroupsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeLogGroupsCommandInput} for command's `input` shape. + * @see {@link DescribeLogGroupsCommandOutput} for command's `response` shape. + * @see {@link CloudWatchLogsClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeLogGroupsCommand extends $Command< DescribeLogGroupsCommandInput, diff --git a/clients/client-cloudwatch-logs/commands/DescribeLogStreamsCommand.ts b/clients/client-cloudwatch-logs/commands/DescribeLogStreamsCommand.ts index dd71dd2c2d78..21362a28fd16 100644 --- a/clients/client-cloudwatch-logs/commands/DescribeLogStreamsCommand.ts +++ b/clients/client-cloudwatch-logs/commands/DescribeLogStreamsCommand.ts @@ -25,6 +25,20 @@ export interface DescribeLogStreamsCommandOutput extends DescribeLogStreamsRespo * You can list all the log streams or filter the results by prefix. * You can also control how the results are ordered.

*

This operation has a limit of five transactions per second, after which transactions are throttled.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { CloudWatchLogsClient, DescribeLogStreamsCommand } from "@aws-sdk/client-cloudwatch-logs"; // ES Modules import + * // const { CloudWatchLogsClient, DescribeLogStreamsCommand } = require("@aws-sdk/client-cloudwatch-logs"); // CommonJS import + * const client = new CloudWatchLogsClient(config); + * const command = new DescribeLogStreamsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeLogStreamsCommandInput} for command's `input` shape. + * @see {@link DescribeLogStreamsCommandOutput} for command's `response` shape. + * @see {@link CloudWatchLogsClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeLogStreamsCommand extends $Command< DescribeLogStreamsCommandInput, diff --git a/clients/client-cloudwatch-logs/commands/DescribeMetricFiltersCommand.ts b/clients/client-cloudwatch-logs/commands/DescribeMetricFiltersCommand.ts index 70e0399197a8..770babb3f1a3 100644 --- a/clients/client-cloudwatch-logs/commands/DescribeMetricFiltersCommand.ts +++ b/clients/client-cloudwatch-logs/commands/DescribeMetricFiltersCommand.ts @@ -24,6 +24,20 @@ export interface DescribeMetricFiltersCommandOutput extends DescribeMetricFilter *

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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { CloudWatchLogsClient, DescribeMetricFiltersCommand } from "@aws-sdk/client-cloudwatch-logs"; // ES Modules import + * // const { CloudWatchLogsClient, DescribeMetricFiltersCommand } = require("@aws-sdk/client-cloudwatch-logs"); // CommonJS import + * const client = new CloudWatchLogsClient(config); + * const command = new DescribeMetricFiltersCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeMetricFiltersCommandInput} for command's `input` shape. + * @see {@link DescribeMetricFiltersCommandOutput} for command's `response` shape. + * @see {@link CloudWatchLogsClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeMetricFiltersCommand extends $Command< DescribeMetricFiltersCommandInput, diff --git a/clients/client-cloudwatch-logs/commands/DescribeQueriesCommand.ts b/clients/client-cloudwatch-logs/commands/DescribeQueriesCommand.ts index e3eb3472badc..e8858e299b90 100644 --- a/clients/client-cloudwatch-logs/commands/DescribeQueriesCommand.ts +++ b/clients/client-cloudwatch-logs/commands/DescribeQueriesCommand.ts @@ -24,6 +24,20 @@ export interface DescribeQueriesCommandOutput extends DescribeQueriesResponse, _ *

Returns a list of CloudWatch Logs Insights queries that are scheduled, executing, or have * been executed 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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { CloudWatchLogsClient, DescribeQueriesCommand } from "@aws-sdk/client-cloudwatch-logs"; // ES Modules import + * // const { CloudWatchLogsClient, DescribeQueriesCommand } = require("@aws-sdk/client-cloudwatch-logs"); // CommonJS import + * const client = new CloudWatchLogsClient(config); + * const command = new DescribeQueriesCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeQueriesCommandInput} for command's `input` shape. + * @see {@link DescribeQueriesCommandOutput} for command's `response` shape. + * @see {@link CloudWatchLogsClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeQueriesCommand extends $Command< DescribeQueriesCommandInput, diff --git a/clients/client-cloudwatch-logs/commands/DescribeQueryDefinitionsCommand.ts b/clients/client-cloudwatch-logs/commands/DescribeQueryDefinitionsCommand.ts index 5a2837ea6016..ca9274c2ffe5 100644 --- a/clients/client-cloudwatch-logs/commands/DescribeQueryDefinitionsCommand.ts +++ b/clients/client-cloudwatch-logs/commands/DescribeQueryDefinitionsCommand.ts @@ -24,6 +24,20 @@ export interface DescribeQueryDefinitionsCommandOutput extends DescribeQueryDefi *

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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { CloudWatchLogsClient, DescribeQueryDefinitionsCommand } from "@aws-sdk/client-cloudwatch-logs"; // ES Modules import + * // const { CloudWatchLogsClient, DescribeQueryDefinitionsCommand } = require("@aws-sdk/client-cloudwatch-logs"); // CommonJS import + * const client = new CloudWatchLogsClient(config); + * const command = new DescribeQueryDefinitionsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeQueryDefinitionsCommandInput} for command's `input` shape. + * @see {@link DescribeQueryDefinitionsCommandOutput} for command's `response` shape. + * @see {@link CloudWatchLogsClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeQueryDefinitionsCommand extends $Command< DescribeQueryDefinitionsCommandInput, diff --git a/clients/client-cloudwatch-logs/commands/DescribeResourcePoliciesCommand.ts b/clients/client-cloudwatch-logs/commands/DescribeResourcePoliciesCommand.ts index dedd52cf5588..e1cc3ad185b7 100644 --- a/clients/client-cloudwatch-logs/commands/DescribeResourcePoliciesCommand.ts +++ b/clients/client-cloudwatch-logs/commands/DescribeResourcePoliciesCommand.ts @@ -22,6 +22,20 @@ export interface DescribeResourcePoliciesCommandOutput extends DescribeResourceP /** *

Lists the resource policies in this account.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { CloudWatchLogsClient, DescribeResourcePoliciesCommand } from "@aws-sdk/client-cloudwatch-logs"; // ES Modules import + * // const { CloudWatchLogsClient, DescribeResourcePoliciesCommand } = require("@aws-sdk/client-cloudwatch-logs"); // CommonJS import + * const client = new CloudWatchLogsClient(config); + * const command = new DescribeResourcePoliciesCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeResourcePoliciesCommandInput} for command's `input` shape. + * @see {@link DescribeResourcePoliciesCommandOutput} for command's `response` shape. + * @see {@link CloudWatchLogsClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeResourcePoliciesCommand extends $Command< DescribeResourcePoliciesCommandInput, diff --git a/clients/client-cloudwatch-logs/commands/DescribeSubscriptionFiltersCommand.ts b/clients/client-cloudwatch-logs/commands/DescribeSubscriptionFiltersCommand.ts index 3d2d05537c50..bbf3f3629f23 100644 --- a/clients/client-cloudwatch-logs/commands/DescribeSubscriptionFiltersCommand.ts +++ b/clients/client-cloudwatch-logs/commands/DescribeSubscriptionFiltersCommand.ts @@ -25,6 +25,20 @@ export interface DescribeSubscriptionFiltersCommandOutput /** *

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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { CloudWatchLogsClient, DescribeSubscriptionFiltersCommand } from "@aws-sdk/client-cloudwatch-logs"; // ES Modules import + * // const { CloudWatchLogsClient, DescribeSubscriptionFiltersCommand } = require("@aws-sdk/client-cloudwatch-logs"); // CommonJS import + * const client = new CloudWatchLogsClient(config); + * const command = new DescribeSubscriptionFiltersCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeSubscriptionFiltersCommandInput} for command's `input` shape. + * @see {@link DescribeSubscriptionFiltersCommandOutput} for command's `response` shape. + * @see {@link CloudWatchLogsClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeSubscriptionFiltersCommand extends $Command< DescribeSubscriptionFiltersCommandInput, diff --git a/clients/client-cloudwatch-logs/commands/DisassociateKmsKeyCommand.ts b/clients/client-cloudwatch-logs/commands/DisassociateKmsKeyCommand.ts index 50c804458785..0369f6b40e18 100644 --- a/clients/client-cloudwatch-logs/commands/DisassociateKmsKeyCommand.ts +++ b/clients/client-cloudwatch-logs/commands/DisassociateKmsKeyCommand.ts @@ -25,6 +25,20 @@ export interface DisassociateKmsKeyCommandOutput extends __MetadataBearer {} *

After the AWS KMS CMK is disassociated from the log group, AWS CloudWatch Logs stops encrypting newly ingested data for the log group. * All previously ingested data remains encrypted, and AWS CloudWatch Logs requires permissions for the CMK whenever the encrypted data is requested.

*

Note that it can take up to 5 minutes for this operation to take effect.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { CloudWatchLogsClient, DisassociateKmsKeyCommand } from "@aws-sdk/client-cloudwatch-logs"; // ES Modules import + * // const { CloudWatchLogsClient, DisassociateKmsKeyCommand } = require("@aws-sdk/client-cloudwatch-logs"); // CommonJS import + * const client = new CloudWatchLogsClient(config); + * const command = new DisassociateKmsKeyCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DisassociateKmsKeyCommandInput} for command's `input` shape. + * @see {@link DisassociateKmsKeyCommandOutput} for command's `response` shape. + * @see {@link CloudWatchLogsClientResolvedConfig | config} for command's `input` shape. + * */ export class DisassociateKmsKeyCommand extends $Command< DisassociateKmsKeyCommandInput, diff --git a/clients/client-cloudwatch-logs/commands/FilterLogEventsCommand.ts b/clients/client-cloudwatch-logs/commands/FilterLogEventsCommand.ts index cbfd256ddc0f..f7c31ffc7182 100644 --- a/clients/client-cloudwatch-logs/commands/FilterLogEventsCommand.ts +++ b/clients/client-cloudwatch-logs/commands/FilterLogEventsCommand.ts @@ -30,6 +30,20 @@ export interface FilterLogEventsCommandOutput extends FilterLogEventsResponse, _ * 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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { CloudWatchLogsClient, FilterLogEventsCommand } from "@aws-sdk/client-cloudwatch-logs"; // ES Modules import + * // const { CloudWatchLogsClient, FilterLogEventsCommand } = require("@aws-sdk/client-cloudwatch-logs"); // CommonJS import + * const client = new CloudWatchLogsClient(config); + * const command = new FilterLogEventsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link FilterLogEventsCommandInput} for command's `input` shape. + * @see {@link FilterLogEventsCommandOutput} for command's `response` shape. + * @see {@link CloudWatchLogsClientResolvedConfig | config} for command's `input` shape. + * */ export class FilterLogEventsCommand extends $Command< FilterLogEventsCommandInput, diff --git a/clients/client-cloudwatch-logs/commands/GetLogEventsCommand.ts b/clients/client-cloudwatch-logs/commands/GetLogEventsCommand.ts index 0586f1c790b6..8f434d655ab8 100644 --- a/clients/client-cloudwatch-logs/commands/GetLogEventsCommand.ts +++ b/clients/client-cloudwatch-logs/commands/GetLogEventsCommand.ts @@ -27,6 +27,20 @@ export interface GetLogEventsCommandOutput extends GetLogEventsResponse, __Metad *

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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { CloudWatchLogsClient, GetLogEventsCommand } from "@aws-sdk/client-cloudwatch-logs"; // ES Modules import + * // const { CloudWatchLogsClient, GetLogEventsCommand } = require("@aws-sdk/client-cloudwatch-logs"); // CommonJS import + * const client = new CloudWatchLogsClient(config); + * const command = new GetLogEventsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetLogEventsCommandInput} for command's `input` shape. + * @see {@link GetLogEventsCommandOutput} for command's `response` shape. + * @see {@link CloudWatchLogsClientResolvedConfig | config} for command's `input` shape. + * */ export class GetLogEventsCommand extends $Command< GetLogEventsCommandInput, diff --git a/clients/client-cloudwatch-logs/commands/GetLogGroupFieldsCommand.ts b/clients/client-cloudwatch-logs/commands/GetLogGroupFieldsCommand.ts index 494cb645b9f7..00cab8765621 100644 --- a/clients/client-cloudwatch-logs/commands/GetLogGroupFieldsCommand.ts +++ b/clients/client-cloudwatch-logs/commands/GetLogGroupFieldsCommand.ts @@ -29,6 +29,20 @@ export interface GetLogGroupFieldsCommandOutput extends GetLogGroupFieldsRespons * Supported Logs and Discovered Fields.

*

The response results are sorted by the frequency percentage, starting * with the highest percentage.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { CloudWatchLogsClient, GetLogGroupFieldsCommand } from "@aws-sdk/client-cloudwatch-logs"; // ES Modules import + * // const { CloudWatchLogsClient, GetLogGroupFieldsCommand } = require("@aws-sdk/client-cloudwatch-logs"); // CommonJS import + * const client = new CloudWatchLogsClient(config); + * const command = new GetLogGroupFieldsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetLogGroupFieldsCommandInput} for command's `input` shape. + * @see {@link GetLogGroupFieldsCommandOutput} for command's `response` shape. + * @see {@link CloudWatchLogsClientResolvedConfig | config} for command's `input` shape. + * */ export class GetLogGroupFieldsCommand extends $Command< GetLogGroupFieldsCommandInput, diff --git a/clients/client-cloudwatch-logs/commands/GetLogRecordCommand.ts b/clients/client-cloudwatch-logs/commands/GetLogRecordCommand.ts index 21e4099169f0..ff3b06bdb9eb 100644 --- a/clients/client-cloudwatch-logs/commands/GetLogRecordCommand.ts +++ b/clients/client-cloudwatch-logs/commands/GetLogRecordCommand.ts @@ -25,6 +25,20 @@ export interface GetLogRecordCommandOutput extends GetLogRecordResponse, __Metad * 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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { CloudWatchLogsClient, GetLogRecordCommand } from "@aws-sdk/client-cloudwatch-logs"; // ES Modules import + * // const { CloudWatchLogsClient, GetLogRecordCommand } = require("@aws-sdk/client-cloudwatch-logs"); // CommonJS import + * const client = new CloudWatchLogsClient(config); + * const command = new GetLogRecordCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetLogRecordCommandInput} for command's `input` shape. + * @see {@link GetLogRecordCommandOutput} for command's `response` shape. + * @see {@link CloudWatchLogsClientResolvedConfig | config} for command's `input` shape. + * */ export class GetLogRecordCommand extends $Command< GetLogRecordCommandInput, diff --git a/clients/client-cloudwatch-logs/commands/GetQueryResultsCommand.ts b/clients/client-cloudwatch-logs/commands/GetQueryResultsCommand.ts index cfbfa0ecde18..62c05e7b3169 100644 --- a/clients/client-cloudwatch-logs/commands/GetQueryResultsCommand.ts +++ b/clients/client-cloudwatch-logs/commands/GetQueryResultsCommand.ts @@ -32,6 +32,20 @@ export interface GetQueryResultsCommandOutput extends GetQueryResultsResponse, _ *

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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { CloudWatchLogsClient, GetQueryResultsCommand } from "@aws-sdk/client-cloudwatch-logs"; // ES Modules import + * // const { CloudWatchLogsClient, GetQueryResultsCommand } = require("@aws-sdk/client-cloudwatch-logs"); // CommonJS import + * const client = new CloudWatchLogsClient(config); + * const command = new GetQueryResultsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetQueryResultsCommandInput} for command's `input` shape. + * @see {@link GetQueryResultsCommandOutput} for command's `response` shape. + * @see {@link CloudWatchLogsClientResolvedConfig | config} for command's `input` shape. + * */ export class GetQueryResultsCommand extends $Command< GetQueryResultsCommandInput, diff --git a/clients/client-cloudwatch-logs/commands/ListTagsLogGroupCommand.ts b/clients/client-cloudwatch-logs/commands/ListTagsLogGroupCommand.ts index 72d931502921..861bcfb723f1 100644 --- a/clients/client-cloudwatch-logs/commands/ListTagsLogGroupCommand.ts +++ b/clients/client-cloudwatch-logs/commands/ListTagsLogGroupCommand.ts @@ -22,6 +22,20 @@ export interface ListTagsLogGroupCommandOutput extends ListTagsLogGroupResponse, /** *

Lists the tags for the specified log group.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { CloudWatchLogsClient, ListTagsLogGroupCommand } from "@aws-sdk/client-cloudwatch-logs"; // ES Modules import + * // const { CloudWatchLogsClient, ListTagsLogGroupCommand } = require("@aws-sdk/client-cloudwatch-logs"); // CommonJS import + * const client = new CloudWatchLogsClient(config); + * const command = new ListTagsLogGroupCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListTagsLogGroupCommandInput} for command's `input` shape. + * @see {@link ListTagsLogGroupCommandOutput} for command's `response` shape. + * @see {@link CloudWatchLogsClientResolvedConfig | config} for command's `input` shape. + * */ export class ListTagsLogGroupCommand extends $Command< ListTagsLogGroupCommandInput, diff --git a/clients/client-cloudwatch-logs/commands/PutDestinationCommand.ts b/clients/client-cloudwatch-logs/commands/PutDestinationCommand.ts index e83cb9982644..6c82a55f1451 100644 --- a/clients/client-cloudwatch-logs/commands/PutDestinationCommand.ts +++ b/clients/client-cloudwatch-logs/commands/PutDestinationCommand.ts @@ -31,6 +31,20 @@ export interface PutDestinationCommandOutput extends PutDestinationResponse, __M * 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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { CloudWatchLogsClient, PutDestinationCommand } from "@aws-sdk/client-cloudwatch-logs"; // ES Modules import + * // const { CloudWatchLogsClient, PutDestinationCommand } = require("@aws-sdk/client-cloudwatch-logs"); // CommonJS import + * const client = new CloudWatchLogsClient(config); + * const command = new PutDestinationCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link PutDestinationCommandInput} for command's `input` shape. + * @see {@link PutDestinationCommandOutput} for command's `response` shape. + * @see {@link CloudWatchLogsClientResolvedConfig | config} for command's `input` shape. + * */ export class PutDestinationCommand extends $Command< PutDestinationCommandInput, diff --git a/clients/client-cloudwatch-logs/commands/PutDestinationPolicyCommand.ts b/clients/client-cloudwatch-logs/commands/PutDestinationPolicyCommand.ts index 5dba05c6c537..89ce26dcf8d6 100644 --- a/clients/client-cloudwatch-logs/commands/PutDestinationPolicyCommand.ts +++ b/clients/client-cloudwatch-logs/commands/PutDestinationPolicyCommand.ts @@ -24,6 +24,20 @@ export interface PutDestinationPolicyCommandOutput extends __MetadataBearer {} *

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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { CloudWatchLogsClient, PutDestinationPolicyCommand } from "@aws-sdk/client-cloudwatch-logs"; // ES Modules import + * // const { CloudWatchLogsClient, PutDestinationPolicyCommand } = require("@aws-sdk/client-cloudwatch-logs"); // CommonJS import + * const client = new CloudWatchLogsClient(config); + * const command = new PutDestinationPolicyCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link PutDestinationPolicyCommandInput} for command's `input` shape. + * @see {@link PutDestinationPolicyCommandOutput} for command's `response` shape. + * @see {@link CloudWatchLogsClientResolvedConfig | config} for command's `input` shape. + * */ export class PutDestinationPolicyCommand extends $Command< PutDestinationPolicyCommandInput, diff --git a/clients/client-cloudwatch-logs/commands/PutLogEventsCommand.ts b/clients/client-cloudwatch-logs/commands/PutLogEventsCommand.ts index 9371c5ee8e40..f1ba51867394 100644 --- a/clients/client-cloudwatch-logs/commands/PutLogEventsCommand.ts +++ b/clients/client-cloudwatch-logs/commands/PutLogEventsCommand.ts @@ -59,6 +59,20 @@ export interface PutLogEventsCommandOutput extends PutLogEventsResponse, __Metad * * *

If a call to PutLogEvents returns "UnrecognizedClientException" the most likely cause is an invalid AWS access key ID or secret key.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { CloudWatchLogsClient, PutLogEventsCommand } from "@aws-sdk/client-cloudwatch-logs"; // ES Modules import + * // const { CloudWatchLogsClient, PutLogEventsCommand } = require("@aws-sdk/client-cloudwatch-logs"); // CommonJS import + * const client = new CloudWatchLogsClient(config); + * const command = new PutLogEventsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link PutLogEventsCommandInput} for command's `input` shape. + * @see {@link PutLogEventsCommandOutput} for command's `response` shape. + * @see {@link CloudWatchLogsClientResolvedConfig | config} for command's `input` shape. + * */ export class PutLogEventsCommand extends $Command< PutLogEventsCommandInput, diff --git a/clients/client-cloudwatch-logs/commands/PutMetricFilterCommand.ts b/clients/client-cloudwatch-logs/commands/PutMetricFilterCommand.ts index 7d10e1e63421..65fcb5b97dc8 100644 --- a/clients/client-cloudwatch-logs/commands/PutMetricFilterCommand.ts +++ b/clients/client-cloudwatch-logs/commands/PutMetricFilterCommand.ts @@ -26,6 +26,20 @@ export interface PutMetricFilterCommandOutput extends __MetadataBearer {} * through PutLogEvents.

*

The maximum number of metric filters that can be associated with a log group is * 100.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { CloudWatchLogsClient, PutMetricFilterCommand } from "@aws-sdk/client-cloudwatch-logs"; // ES Modules import + * // const { CloudWatchLogsClient, PutMetricFilterCommand } = require("@aws-sdk/client-cloudwatch-logs"); // CommonJS import + * const client = new CloudWatchLogsClient(config); + * const command = new PutMetricFilterCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link PutMetricFilterCommandInput} for command's `input` shape. + * @see {@link PutMetricFilterCommandOutput} for command's `response` shape. + * @see {@link CloudWatchLogsClientResolvedConfig | config} for command's `input` shape. + * */ export class PutMetricFilterCommand extends $Command< PutMetricFilterCommandInput, diff --git a/clients/client-cloudwatch-logs/commands/PutQueryDefinitionCommand.ts b/clients/client-cloudwatch-logs/commands/PutQueryDefinitionCommand.ts index 82aa78e283b0..b486b01ebcb1 100644 --- a/clients/client-cloudwatch-logs/commands/PutQueryDefinitionCommand.ts +++ b/clients/client-cloudwatch-logs/commands/PutQueryDefinitionCommand.ts @@ -33,6 +33,20 @@ export interface PutQueryDefinitionCommandOutput extends PutQueryDefinitionRespo * to contain no log groups.

*

You must have the logs:PutQueryDefinition permission to be able to perform * this operation.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { CloudWatchLogsClient, PutQueryDefinitionCommand } from "@aws-sdk/client-cloudwatch-logs"; // ES Modules import + * // const { CloudWatchLogsClient, PutQueryDefinitionCommand } = require("@aws-sdk/client-cloudwatch-logs"); // CommonJS import + * const client = new CloudWatchLogsClient(config); + * const command = new PutQueryDefinitionCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link PutQueryDefinitionCommandInput} for command's `input` shape. + * @see {@link PutQueryDefinitionCommandOutput} for command's `response` shape. + * @see {@link CloudWatchLogsClientResolvedConfig | config} for command's `input` shape. + * */ export class PutQueryDefinitionCommand extends $Command< PutQueryDefinitionCommandInput, diff --git a/clients/client-cloudwatch-logs/commands/PutResourcePolicyCommand.ts b/clients/client-cloudwatch-logs/commands/PutResourcePolicyCommand.ts index ecd68ea27b73..45de73d562e5 100644 --- a/clients/client-cloudwatch-logs/commands/PutResourcePolicyCommand.ts +++ b/clients/client-cloudwatch-logs/commands/PutResourcePolicyCommand.ts @@ -24,6 +24,20 @@ export interface PutResourcePolicyCommandOutput extends PutResourcePolicyRespons *

Creates or updates a resource policy allowing other AWS services to put log events to * this account, such as Amazon Route 53. An account can have up to 10 resource policies per AWS * Region.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { CloudWatchLogsClient, PutResourcePolicyCommand } from "@aws-sdk/client-cloudwatch-logs"; // ES Modules import + * // const { CloudWatchLogsClient, PutResourcePolicyCommand } = require("@aws-sdk/client-cloudwatch-logs"); // CommonJS import + * const client = new CloudWatchLogsClient(config); + * const command = new PutResourcePolicyCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link PutResourcePolicyCommandInput} for command's `input` shape. + * @see {@link PutResourcePolicyCommandOutput} for command's `response` shape. + * @see {@link CloudWatchLogsClientResolvedConfig | config} for command's `input` shape. + * */ export class PutResourcePolicyCommand extends $Command< PutResourcePolicyCommandInput, diff --git a/clients/client-cloudwatch-logs/commands/PutRetentionPolicyCommand.ts b/clients/client-cloudwatch-logs/commands/PutRetentionPolicyCommand.ts index bd21a8d7002c..0e12c8ee596f 100644 --- a/clients/client-cloudwatch-logs/commands/PutRetentionPolicyCommand.ts +++ b/clients/client-cloudwatch-logs/commands/PutRetentionPolicyCommand.ts @@ -24,6 +24,20 @@ export interface PutRetentionPolicyCommandOutput extends __MetadataBearer {} *

Sets the retention of the specified log group. A retention policy allows you to * configure the number of days for which to retain log events in the specified log * group.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { CloudWatchLogsClient, PutRetentionPolicyCommand } from "@aws-sdk/client-cloudwatch-logs"; // ES Modules import + * // const { CloudWatchLogsClient, PutRetentionPolicyCommand } = require("@aws-sdk/client-cloudwatch-logs"); // CommonJS import + * const client = new CloudWatchLogsClient(config); + * const command = new PutRetentionPolicyCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link PutRetentionPolicyCommandInput} for command's `input` shape. + * @see {@link PutRetentionPolicyCommandOutput} for command's `response` shape. + * @see {@link CloudWatchLogsClientResolvedConfig | config} for command's `input` shape. + * */ export class PutRetentionPolicyCommand extends $Command< PutRetentionPolicyCommandInput, diff --git a/clients/client-cloudwatch-logs/commands/PutSubscriptionFilterCommand.ts b/clients/client-cloudwatch-logs/commands/PutSubscriptionFilterCommand.ts index 2360f9430f27..0ea463a1b8bb 100644 --- a/clients/client-cloudwatch-logs/commands/PutSubscriptionFilterCommand.ts +++ b/clients/client-cloudwatch-logs/commands/PutSubscriptionFilterCommand.ts @@ -51,6 +51,20 @@ export interface PutSubscriptionFilterCommandOutput extends __MetadataBearer {} * group.

*

To perform a PutSubscriptionFilter operation, you must also have the * iam:PassRole permission.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { CloudWatchLogsClient, PutSubscriptionFilterCommand } from "@aws-sdk/client-cloudwatch-logs"; // ES Modules import + * // const { CloudWatchLogsClient, PutSubscriptionFilterCommand } = require("@aws-sdk/client-cloudwatch-logs"); // CommonJS import + * const client = new CloudWatchLogsClient(config); + * const command = new PutSubscriptionFilterCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link PutSubscriptionFilterCommandInput} for command's `input` shape. + * @see {@link PutSubscriptionFilterCommandOutput} for command's `response` shape. + * @see {@link CloudWatchLogsClientResolvedConfig | config} for command's `input` shape. + * */ export class PutSubscriptionFilterCommand extends $Command< PutSubscriptionFilterCommandInput, diff --git a/clients/client-cloudwatch-logs/commands/StartQueryCommand.ts b/clients/client-cloudwatch-logs/commands/StartQueryCommand.ts index e4f3b8e3a802..77d93f77d559 100644 --- a/clients/client-cloudwatch-logs/commands/StartQueryCommand.ts +++ b/clients/client-cloudwatch-logs/commands/StartQueryCommand.ts @@ -27,6 +27,20 @@ export interface StartQueryCommandOutput extends StartQueryResponse, __MetadataB * *

Queries time out after 15 minutes of execution. If your queries are timing out, reduce the * time range being searched or partition your query into a number of queries.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { CloudWatchLogsClient, StartQueryCommand } from "@aws-sdk/client-cloudwatch-logs"; // ES Modules import + * // const { CloudWatchLogsClient, StartQueryCommand } = require("@aws-sdk/client-cloudwatch-logs"); // CommonJS import + * const client = new CloudWatchLogsClient(config); + * const command = new StartQueryCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link StartQueryCommandInput} for command's `input` shape. + * @see {@link StartQueryCommandOutput} for command's `response` shape. + * @see {@link CloudWatchLogsClientResolvedConfig | config} for command's `input` shape. + * */ export class StartQueryCommand extends $Command< StartQueryCommandInput, diff --git a/clients/client-cloudwatch-logs/commands/StopQueryCommand.ts b/clients/client-cloudwatch-logs/commands/StopQueryCommand.ts index 24fdaec387c9..07f3d8e2df2e 100644 --- a/clients/client-cloudwatch-logs/commands/StopQueryCommand.ts +++ b/clients/client-cloudwatch-logs/commands/StopQueryCommand.ts @@ -20,6 +20,20 @@ export interface StopQueryCommandOutput extends StopQueryResponse, __MetadataBea /** *

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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { CloudWatchLogsClient, StopQueryCommand } from "@aws-sdk/client-cloudwatch-logs"; // ES Modules import + * // const { CloudWatchLogsClient, StopQueryCommand } = require("@aws-sdk/client-cloudwatch-logs"); // CommonJS import + * const client = new CloudWatchLogsClient(config); + * const command = new StopQueryCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link StopQueryCommandInput} for command's `input` shape. + * @see {@link StopQueryCommandOutput} for command's `response` shape. + * @see {@link CloudWatchLogsClientResolvedConfig | config} for command's `input` shape. + * */ export class StopQueryCommand extends $Command< StopQueryCommandInput, diff --git a/clients/client-cloudwatch-logs/commands/TagLogGroupCommand.ts b/clients/client-cloudwatch-logs/commands/TagLogGroupCommand.ts index 7740cde14fa2..a4d46e29f334 100644 --- a/clients/client-cloudwatch-logs/commands/TagLogGroupCommand.ts +++ b/clients/client-cloudwatch-logs/commands/TagLogGroupCommand.ts @@ -26,6 +26,20 @@ export interface TagLogGroupCommandOutput extends __MetadataBearer {} * To remove tags, use UntagLogGroup.

*

For more information about tags, see Tag Log Groups in Amazon CloudWatch Logs * in the Amazon CloudWatch Logs User Guide.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { CloudWatchLogsClient, TagLogGroupCommand } from "@aws-sdk/client-cloudwatch-logs"; // ES Modules import + * // const { CloudWatchLogsClient, TagLogGroupCommand } = require("@aws-sdk/client-cloudwatch-logs"); // CommonJS import + * const client = new CloudWatchLogsClient(config); + * const command = new TagLogGroupCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link TagLogGroupCommandInput} for command's `input` shape. + * @see {@link TagLogGroupCommandOutput} for command's `response` shape. + * @see {@link CloudWatchLogsClientResolvedConfig | config} for command's `input` shape. + * */ export class TagLogGroupCommand extends $Command< TagLogGroupCommandInput, diff --git a/clients/client-cloudwatch-logs/commands/TestMetricFilterCommand.ts b/clients/client-cloudwatch-logs/commands/TestMetricFilterCommand.ts index 5419d3cb9b07..ba2406b55560 100644 --- a/clients/client-cloudwatch-logs/commands/TestMetricFilterCommand.ts +++ b/clients/client-cloudwatch-logs/commands/TestMetricFilterCommand.ts @@ -23,6 +23,20 @@ export interface TestMetricFilterCommandOutput extends TestMetricFilterResponse, /** *

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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { CloudWatchLogsClient, TestMetricFilterCommand } from "@aws-sdk/client-cloudwatch-logs"; // ES Modules import + * // const { CloudWatchLogsClient, TestMetricFilterCommand } = require("@aws-sdk/client-cloudwatch-logs"); // CommonJS import + * const client = new CloudWatchLogsClient(config); + * const command = new TestMetricFilterCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link TestMetricFilterCommandInput} for command's `input` shape. + * @see {@link TestMetricFilterCommandOutput} for command's `response` shape. + * @see {@link CloudWatchLogsClientResolvedConfig | config} for command's `input` shape. + * */ export class TestMetricFilterCommand extends $Command< TestMetricFilterCommandInput, diff --git a/clients/client-cloudwatch-logs/commands/UntagLogGroupCommand.ts b/clients/client-cloudwatch-logs/commands/UntagLogGroupCommand.ts index d4df6d49012b..e8b60b6a014b 100644 --- a/clients/client-cloudwatch-logs/commands/UntagLogGroupCommand.ts +++ b/clients/client-cloudwatch-logs/commands/UntagLogGroupCommand.ts @@ -24,6 +24,20 @@ export interface UntagLogGroupCommandOutput extends __MetadataBearer {} *

Removes the specified tags from the specified log group.

*

To list the tags for a log group, use ListTagsLogGroup. * To add tags, use TagLogGroup.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { CloudWatchLogsClient, UntagLogGroupCommand } from "@aws-sdk/client-cloudwatch-logs"; // ES Modules import + * // const { CloudWatchLogsClient, UntagLogGroupCommand } = require("@aws-sdk/client-cloudwatch-logs"); // CommonJS import + * const client = new CloudWatchLogsClient(config); + * const command = new UntagLogGroupCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link UntagLogGroupCommandInput} for command's `input` shape. + * @see {@link UntagLogGroupCommandOutput} for command's `response` shape. + * @see {@link CloudWatchLogsClientResolvedConfig | config} for command's `input` shape. + * */ export class UntagLogGroupCommand extends $Command< UntagLogGroupCommandInput, diff --git a/clients/client-cloudwatch-logs/models/models_0.ts b/clients/client-cloudwatch-logs/models/models_0.ts index 42fe7ad0e1dc..d2903cc6b115 100644 --- a/clients/client-cloudwatch-logs/models/models_0.ts +++ b/clients/client-cloudwatch-logs/models/models_0.ts @@ -15,6 +15,9 @@ export interface AssociateKmsKeyRequest { } export namespace AssociateKmsKeyRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: AssociateKmsKeyRequest): any => ({ ...obj, }); @@ -30,6 +33,9 @@ export interface InvalidParameterException extends __SmithyException, $MetadataB } export namespace InvalidParameterException { + /** + * @internal + */ export const filterSensitiveLog = (obj: InvalidParameterException): any => ({ ...obj, }); @@ -45,6 +51,9 @@ export interface OperationAbortedException extends __SmithyException, $MetadataB } export namespace OperationAbortedException { + /** + * @internal + */ export const filterSensitiveLog = (obj: OperationAbortedException): any => ({ ...obj, }); @@ -60,6 +69,9 @@ export interface ResourceNotFoundException extends __SmithyException, $MetadataB } export namespace ResourceNotFoundException { + /** + * @internal + */ export const filterSensitiveLog = (obj: ResourceNotFoundException): any => ({ ...obj, }); @@ -75,6 +87,9 @@ export interface ServiceUnavailableException extends __SmithyException, $Metadat } export namespace ServiceUnavailableException { + /** + * @internal + */ export const filterSensitiveLog = (obj: ServiceUnavailableException): any => ({ ...obj, }); @@ -88,6 +103,9 @@ export interface CancelExportTaskRequest { } export namespace CancelExportTaskRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: CancelExportTaskRequest): any => ({ ...obj, }); @@ -103,6 +121,9 @@ export interface InvalidOperationException extends __SmithyException, $MetadataB } export namespace InvalidOperationException { + /** + * @internal + */ export const filterSensitiveLog = (obj: InvalidOperationException): any => ({ ...obj, }); @@ -152,6 +173,9 @@ export interface CreateExportTaskRequest { } export namespace CreateExportTaskRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateExportTaskRequest): any => ({ ...obj, }); @@ -165,6 +189,9 @@ export interface CreateExportTaskResponse { } export namespace CreateExportTaskResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateExportTaskResponse): any => ({ ...obj, }); @@ -180,6 +207,9 @@ export interface LimitExceededException extends __SmithyException, $MetadataBear } export namespace LimitExceededException { + /** + * @internal + */ export const filterSensitiveLog = (obj: LimitExceededException): any => ({ ...obj, }); @@ -195,6 +225,9 @@ export interface ResourceAlreadyExistsException extends __SmithyException, $Meta } export namespace ResourceAlreadyExistsException { + /** + * @internal + */ export const filterSensitiveLog = (obj: ResourceAlreadyExistsException): any => ({ ...obj, }); @@ -219,6 +252,9 @@ export interface CreateLogGroupRequest { } export namespace CreateLogGroupRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateLogGroupRequest): any => ({ ...obj, }); @@ -237,6 +273,9 @@ export interface CreateLogStreamRequest { } export namespace CreateLogStreamRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateLogStreamRequest): any => ({ ...obj, }); @@ -253,6 +292,9 @@ export interface DataAlreadyAcceptedException extends __SmithyException, $Metada } export namespace DataAlreadyAcceptedException { + /** + * @internal + */ export const filterSensitiveLog = (obj: DataAlreadyAcceptedException): any => ({ ...obj, }); @@ -266,6 +308,9 @@ export interface DeleteDestinationRequest { } export namespace DeleteDestinationRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteDestinationRequest): any => ({ ...obj, }); @@ -279,6 +324,9 @@ export interface DeleteLogGroupRequest { } export namespace DeleteLogGroupRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteLogGroupRequest): any => ({ ...obj, }); @@ -297,6 +345,9 @@ export interface DeleteLogStreamRequest { } export namespace DeleteLogStreamRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteLogStreamRequest): any => ({ ...obj, }); @@ -315,6 +366,9 @@ export interface DeleteMetricFilterRequest { } export namespace DeleteMetricFilterRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteMetricFilterRequest): any => ({ ...obj, }); @@ -329,6 +383,9 @@ export interface DeleteQueryDefinitionRequest { } export namespace DeleteQueryDefinitionRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteQueryDefinitionRequest): any => ({ ...obj, }); @@ -343,6 +400,9 @@ export interface DeleteQueryDefinitionResponse { } export namespace DeleteQueryDefinitionResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteQueryDefinitionResponse): any => ({ ...obj, }); @@ -356,6 +416,9 @@ export interface DeleteResourcePolicyRequest { } export namespace DeleteResourcePolicyRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteResourcePolicyRequest): any => ({ ...obj, }); @@ -369,6 +432,9 @@ export interface DeleteRetentionPolicyRequest { } export namespace DeleteRetentionPolicyRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteRetentionPolicyRequest): any => ({ ...obj, }); @@ -387,6 +453,9 @@ export interface DeleteSubscriptionFilterRequest { } export namespace DeleteSubscriptionFilterRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteSubscriptionFilterRequest): any => ({ ...obj, }); @@ -410,6 +479,9 @@ export interface DescribeDestinationsRequest { } export namespace DescribeDestinationsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeDestinationsRequest): any => ({ ...obj, }); @@ -454,6 +526,9 @@ export interface Destination { } export namespace Destination { + /** + * @internal + */ export const filterSensitiveLog = (obj: Destination): any => ({ ...obj, }); @@ -472,6 +547,9 @@ export interface DescribeDestinationsResponse { } export namespace DescribeDestinationsResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeDestinationsResponse): any => ({ ...obj, }); @@ -509,6 +587,9 @@ export interface DescribeExportTasksRequest { } export namespace DescribeExportTasksRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeExportTasksRequest): any => ({ ...obj, }); @@ -532,6 +613,9 @@ export interface ExportTaskExecutionInfo { } export namespace ExportTaskExecutionInfo { + /** + * @internal + */ export const filterSensitiveLog = (obj: ExportTaskExecutionInfo): any => ({ ...obj, }); @@ -553,6 +637,9 @@ export interface ExportTaskStatus { } export namespace ExportTaskStatus { + /** + * @internal + */ export const filterSensitiveLog = (obj: ExportTaskStatus): any => ({ ...obj, }); @@ -611,6 +698,9 @@ export interface ExportTask { } export namespace ExportTask { + /** + * @internal + */ export const filterSensitiveLog = (obj: ExportTask): any => ({ ...obj, }); @@ -629,6 +719,9 @@ export interface DescribeExportTasksResponse { } export namespace DescribeExportTasksResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeExportTasksResponse): any => ({ ...obj, }); @@ -652,6 +745,9 @@ export interface DescribeLogGroupsRequest { } export namespace DescribeLogGroupsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeLogGroupsRequest): any => ({ ...obj, }); @@ -702,6 +798,9 @@ export interface LogGroup { } export namespace LogGroup { + /** + * @internal + */ export const filterSensitiveLog = (obj: LogGroup): any => ({ ...obj, }); @@ -722,6 +821,9 @@ export interface DescribeLogGroupsResponse { } export namespace DescribeLogGroupsResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeLogGroupsResponse): any => ({ ...obj, }); @@ -778,6 +880,9 @@ export interface DescribeLogStreamsRequest { } export namespace DescribeLogStreamsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeLogStreamsRequest): any => ({ ...obj, }); @@ -843,6 +948,9 @@ export interface LogStream { } export namespace LogStream { + /** + * @internal + */ export const filterSensitiveLog = (obj: LogStream): any => ({ ...obj, }); @@ -861,6 +969,9 @@ export interface DescribeLogStreamsResponse { } export namespace DescribeLogStreamsResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeLogStreamsResponse): any => ({ ...obj, }); @@ -902,6 +1013,9 @@ export interface DescribeMetricFiltersRequest { } export namespace DescribeMetricFiltersRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeMetricFiltersRequest): any => ({ ...obj, }); @@ -936,6 +1050,9 @@ export interface MetricTransformation { } export namespace MetricTransformation { + /** + * @internal + */ export const filterSensitiveLog = (obj: MetricTransformation): any => ({ ...obj, }); @@ -976,6 +1093,9 @@ export interface MetricFilter { } export namespace MetricFilter { + /** + * @internal + */ export const filterSensitiveLog = (obj: MetricFilter): any => ({ ...obj, }); @@ -994,6 +1114,9 @@ export interface DescribeMetricFiltersResponse { } export namespace DescribeMetricFiltersResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeMetricFiltersResponse): any => ({ ...obj, }); @@ -1031,6 +1154,9 @@ export interface DescribeQueriesRequest { } export namespace DescribeQueriesRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeQueriesRequest): any => ({ ...obj, }); @@ -1068,6 +1194,9 @@ export interface QueryInfo { } export namespace QueryInfo { + /** + * @internal + */ export const filterSensitiveLog = (obj: QueryInfo): any => ({ ...obj, }); @@ -1086,6 +1215,9 @@ export interface DescribeQueriesResponse { } export namespace DescribeQueriesResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeQueriesResponse): any => ({ ...obj, }); @@ -1109,6 +1241,9 @@ export interface DescribeQueryDefinitionsRequest { } export namespace DescribeQueryDefinitionsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeQueryDefinitionsRequest): any => ({ ...obj, }); @@ -1146,6 +1281,9 @@ export interface QueryDefinition { } export namespace QueryDefinition { + /** + * @internal + */ export const filterSensitiveLog = (obj: QueryDefinition): any => ({ ...obj, }); @@ -1164,6 +1302,9 @@ export interface DescribeQueryDefinitionsResponse { } export namespace DescribeQueryDefinitionsResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeQueryDefinitionsResponse): any => ({ ...obj, }); @@ -1182,6 +1323,9 @@ export interface DescribeResourcePoliciesRequest { } export namespace DescribeResourcePoliciesRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeResourcePoliciesRequest): any => ({ ...obj, }); @@ -1209,6 +1353,9 @@ export interface ResourcePolicy { } export namespace ResourcePolicy { + /** + * @internal + */ export const filterSensitiveLog = (obj: ResourcePolicy): any => ({ ...obj, }); @@ -1227,6 +1374,9 @@ export interface DescribeResourcePoliciesResponse { } export namespace DescribeResourcePoliciesResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeResourcePoliciesResponse): any => ({ ...obj, }); @@ -1255,6 +1405,9 @@ export interface DescribeSubscriptionFiltersRequest { } export namespace DescribeSubscriptionFiltersRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeSubscriptionFiltersRequest): any => ({ ...obj, }); @@ -1310,6 +1463,9 @@ export interface SubscriptionFilter { } export namespace SubscriptionFilter { + /** + * @internal + */ export const filterSensitiveLog = (obj: SubscriptionFilter): any => ({ ...obj, }); @@ -1328,6 +1484,9 @@ export interface DescribeSubscriptionFiltersResponse { } export namespace DescribeSubscriptionFiltersResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeSubscriptionFiltersResponse): any => ({ ...obj, }); @@ -1341,6 +1500,9 @@ export interface DisassociateKmsKeyRequest { } export namespace DisassociateKmsKeyRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DisassociateKmsKeyRequest): any => ({ ...obj, }); @@ -1379,6 +1541,9 @@ export interface FilteredLogEvent { } export namespace FilteredLogEvent { + /** + * @internal + */ export const filterSensitiveLog = (obj: FilteredLogEvent): any => ({ ...obj, }); @@ -1451,6 +1616,9 @@ export interface FilterLogEventsRequest { } export namespace FilterLogEventsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: FilterLogEventsRequest): any => ({ ...obj, }); @@ -1472,6 +1640,9 @@ export interface SearchedLogStream { } export namespace SearchedLogStream { + /** + * @internal + */ export const filterSensitiveLog = (obj: SearchedLogStream): any => ({ ...obj, }); @@ -1499,6 +1670,9 @@ export interface FilterLogEventsResponse { } export namespace FilterLogEventsResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: FilterLogEventsResponse): any => ({ ...obj, }); @@ -1551,6 +1725,9 @@ export interface GetLogEventsRequest { } export namespace GetLogEventsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetLogEventsRequest): any => ({ ...obj, }); @@ -1579,6 +1756,9 @@ export interface OutputLogEvent { } export namespace OutputLogEvent { + /** + * @internal + */ export const filterSensitiveLog = (obj: OutputLogEvent): any => ({ ...obj, }); @@ -1606,6 +1786,9 @@ export interface GetLogEventsResponse { } export namespace GetLogEventsResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetLogEventsResponse): any => ({ ...obj, }); @@ -1628,6 +1811,9 @@ export interface GetLogGroupFieldsRequest { } export namespace GetLogGroupFieldsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetLogGroupFieldsRequest): any => ({ ...obj, }); @@ -1650,6 +1836,9 @@ export interface LogGroupField { } export namespace LogGroupField { + /** + * @internal + */ export const filterSensitiveLog = (obj: LogGroupField): any => ({ ...obj, }); @@ -1664,6 +1853,9 @@ export interface GetLogGroupFieldsResponse { } export namespace GetLogGroupFieldsResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetLogGroupFieldsResponse): any => ({ ...obj, }); @@ -1680,6 +1872,9 @@ export interface GetLogRecordRequest { } export namespace GetLogRecordRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetLogRecordRequest): any => ({ ...obj, }); @@ -1693,6 +1888,9 @@ export interface GetLogRecordResponse { } export namespace GetLogRecordResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetLogRecordResponse): any => ({ ...obj, }); @@ -1706,6 +1904,9 @@ export interface GetQueryResultsRequest { } export namespace GetQueryResultsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetQueryResultsRequest): any => ({ ...obj, }); @@ -1730,6 +1931,9 @@ export interface ResultField { } export namespace ResultField { + /** + * @internal + */ export const filterSensitiveLog = (obj: ResultField): any => ({ ...obj, }); @@ -1757,6 +1961,9 @@ export interface QueryStatistics { } export namespace QueryStatistics { + /** + * @internal + */ export const filterSensitiveLog = (obj: QueryStatistics): any => ({ ...obj, }); @@ -1789,6 +1996,9 @@ export interface GetQueryResultsResponse { } export namespace GetQueryResultsResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetQueryResultsResponse): any => ({ ...obj, }); @@ -1812,6 +2022,9 @@ export interface InputLogEvent { } export namespace InputLogEvent { + /** + * @internal + */ export const filterSensitiveLog = (obj: InputLogEvent): any => ({ ...obj, }); @@ -1830,6 +2043,9 @@ export interface InvalidSequenceTokenException extends __SmithyException, $Metad } export namespace InvalidSequenceTokenException { + /** + * @internal + */ export const filterSensitiveLog = (obj: InvalidSequenceTokenException): any => ({ ...obj, }); @@ -1843,6 +2059,9 @@ export interface ListTagsLogGroupRequest { } export namespace ListTagsLogGroupRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListTagsLogGroupRequest): any => ({ ...obj, }); @@ -1856,6 +2075,9 @@ export interface ListTagsLogGroupResponse { } export namespace ListTagsLogGroupResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListTagsLogGroupResponse): any => ({ ...obj, }); @@ -1880,6 +2102,9 @@ export interface PutDestinationRequest { } export namespace PutDestinationRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: PutDestinationRequest): any => ({ ...obj, }); @@ -1893,6 +2118,9 @@ export interface PutDestinationResponse { } export namespace PutDestinationResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: PutDestinationResponse): any => ({ ...obj, }); @@ -1912,6 +2140,9 @@ export interface PutDestinationPolicyRequest { } export namespace PutDestinationPolicyRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: PutDestinationPolicyRequest): any => ({ ...obj, }); @@ -1944,6 +2175,9 @@ export interface PutLogEventsRequest { } export namespace PutLogEventsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: PutLogEventsRequest): any => ({ ...obj, }); @@ -1970,6 +2204,9 @@ export interface RejectedLogEventsInfo { } export namespace RejectedLogEventsInfo { + /** + * @internal + */ export const filterSensitiveLog = (obj: RejectedLogEventsInfo): any => ({ ...obj, }); @@ -1988,6 +2225,9 @@ export interface PutLogEventsResponse { } export namespace PutLogEventsResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: PutLogEventsResponse): any => ({ ...obj, }); @@ -2003,6 +2243,9 @@ export interface UnrecognizedClientException extends __SmithyException, $Metadat } export namespace UnrecognizedClientException { + /** + * @internal + */ export const filterSensitiveLog = (obj: UnrecognizedClientException): any => ({ ...obj, }); @@ -2031,6 +2274,9 @@ export interface PutMetricFilterRequest { } export namespace PutMetricFilterRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: PutMetricFilterRequest): any => ({ ...obj, }); @@ -2069,6 +2315,9 @@ export interface PutQueryDefinitionRequest { } export namespace PutQueryDefinitionRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: PutQueryDefinitionRequest): any => ({ ...obj, }); @@ -2082,6 +2331,9 @@ export interface PutQueryDefinitionResponse { } export namespace PutQueryDefinitionResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: PutQueryDefinitionResponse): any => ({ ...obj, }); @@ -2122,6 +2374,9 @@ export interface PutResourcePolicyRequest { } export namespace PutResourcePolicyRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: PutResourcePolicyRequest): any => ({ ...obj, }); @@ -2135,6 +2390,9 @@ export interface PutResourcePolicyResponse { } export namespace PutResourcePolicyResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: PutResourcePolicyResponse): any => ({ ...obj, }); @@ -2156,6 +2414,9 @@ export interface PutRetentionPolicyRequest { } export namespace PutRetentionPolicyRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: PutRetentionPolicyRequest): any => ({ ...obj, }); @@ -2220,6 +2481,9 @@ export interface PutSubscriptionFilterRequest { } export namespace PutSubscriptionFilterRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: PutSubscriptionFilterRequest): any => ({ ...obj, }); @@ -2241,6 +2505,9 @@ export interface QueryCompileErrorLocation { } export namespace QueryCompileErrorLocation { + /** + * @internal + */ export const filterSensitiveLog = (obj: QueryCompileErrorLocation): any => ({ ...obj, }); @@ -2262,6 +2529,9 @@ export interface QueryCompileError { } export namespace QueryCompileError { + /** + * @internal + */ export const filterSensitiveLog = (obj: QueryCompileError): any => ({ ...obj, }); @@ -2286,6 +2556,9 @@ export interface MalformedQueryException extends __SmithyException, $MetadataBea } export namespace MalformedQueryException { + /** + * @internal + */ export const filterSensitiveLog = (obj: MalformedQueryException): any => ({ ...obj, }); @@ -2334,6 +2607,9 @@ export interface StartQueryRequest { } export namespace StartQueryRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: StartQueryRequest): any => ({ ...obj, }); @@ -2347,6 +2623,9 @@ export interface StartQueryResponse { } export namespace StartQueryResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: StartQueryResponse): any => ({ ...obj, }); @@ -2361,6 +2640,9 @@ export interface StopQueryRequest { } export namespace StopQueryRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: StopQueryRequest): any => ({ ...obj, }); @@ -2374,6 +2656,9 @@ export interface StopQueryResponse { } export namespace StopQueryResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: StopQueryResponse): any => ({ ...obj, }); @@ -2392,6 +2677,9 @@ export interface TagLogGroupRequest { } export namespace TagLogGroupRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: TagLogGroupRequest): any => ({ ...obj, }); @@ -2412,6 +2700,9 @@ export interface TestMetricFilterRequest { } export namespace TestMetricFilterRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: TestMetricFilterRequest): any => ({ ...obj, }); @@ -2438,6 +2729,9 @@ export interface MetricFilterMatchRecord { } export namespace MetricFilterMatchRecord { + /** + * @internal + */ export const filterSensitiveLog = (obj: MetricFilterMatchRecord): any => ({ ...obj, }); @@ -2451,6 +2745,9 @@ export interface TestMetricFilterResponse { } export namespace TestMetricFilterResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: TestMetricFilterResponse): any => ({ ...obj, }); @@ -2469,6 +2766,9 @@ export interface UntagLogGroupRequest { } export namespace UntagLogGroupRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: UntagLogGroupRequest): any => ({ ...obj, }); diff --git a/clients/client-cloudwatch/commands/DeleteAlarmsCommand.ts b/clients/client-cloudwatch/commands/DeleteAlarmsCommand.ts index 02101af9aaad..991402e757dc 100644 --- a/clients/client-cloudwatch/commands/DeleteAlarmsCommand.ts +++ b/clients/client-cloudwatch/commands/DeleteAlarmsCommand.ts @@ -34,6 +34,20 @@ export interface DeleteAlarmsCommandOutput extends __MetadataBearer {} *

Additionally, the evaluation of composite alarms stops if CloudWatch detects a cycle in the evaluation path. *

* + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { CloudWatchClient, DeleteAlarmsCommand } from "@aws-sdk/client-cloudwatch"; // ES Modules import + * // const { CloudWatchClient, DeleteAlarmsCommand } = require("@aws-sdk/client-cloudwatch"); // CommonJS import + * const client = new CloudWatchClient(config); + * const command = new DeleteAlarmsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteAlarmsCommandInput} for command's `input` shape. + * @see {@link DeleteAlarmsCommandOutput} for command's `response` shape. + * @see {@link CloudWatchClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteAlarmsCommand extends $Command< DeleteAlarmsCommandInput, diff --git a/clients/client-cloudwatch/commands/DeleteAnomalyDetectorCommand.ts b/clients/client-cloudwatch/commands/DeleteAnomalyDetectorCommand.ts index 21d480c2ce6f..6ea8f3d92ca9 100644 --- a/clients/client-cloudwatch/commands/DeleteAnomalyDetectorCommand.ts +++ b/clients/client-cloudwatch/commands/DeleteAnomalyDetectorCommand.ts @@ -22,6 +22,20 @@ export interface DeleteAnomalyDetectorCommandOutput extends DeleteAnomalyDetecto /** *

Deletes the specified anomaly detection model from your account.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { CloudWatchClient, DeleteAnomalyDetectorCommand } from "@aws-sdk/client-cloudwatch"; // ES Modules import + * // const { CloudWatchClient, DeleteAnomalyDetectorCommand } = require("@aws-sdk/client-cloudwatch"); // CommonJS import + * const client = new CloudWatchClient(config); + * const command = new DeleteAnomalyDetectorCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteAnomalyDetectorCommandInput} for command's `input` shape. + * @see {@link DeleteAnomalyDetectorCommandOutput} for command's `response` shape. + * @see {@link CloudWatchClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteAnomalyDetectorCommand extends $Command< DeleteAnomalyDetectorCommandInput, diff --git a/clients/client-cloudwatch/commands/DeleteDashboardsCommand.ts b/clients/client-cloudwatch/commands/DeleteDashboardsCommand.ts index bbd2eb1211e6..55601f6870d8 100644 --- a/clients/client-cloudwatch/commands/DeleteDashboardsCommand.ts +++ b/clients/client-cloudwatch/commands/DeleteDashboardsCommand.ts @@ -24,6 +24,20 @@ export interface DeleteDashboardsCommandOutput extends DeleteDashboardsOutput, _ *

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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { CloudWatchClient, DeleteDashboardsCommand } from "@aws-sdk/client-cloudwatch"; // ES Modules import + * // const { CloudWatchClient, DeleteDashboardsCommand } = require("@aws-sdk/client-cloudwatch"); // CommonJS import + * const client = new CloudWatchClient(config); + * const command = new DeleteDashboardsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteDashboardsCommandInput} for command's `input` shape. + * @see {@link DeleteDashboardsCommandOutput} for command's `response` shape. + * @see {@link CloudWatchClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteDashboardsCommand extends $Command< DeleteDashboardsCommandInput, diff --git a/clients/client-cloudwatch/commands/DeleteInsightRulesCommand.ts b/clients/client-cloudwatch/commands/DeleteInsightRulesCommand.ts index f07b5768a593..9cf1e7d2b47c 100644 --- a/clients/client-cloudwatch/commands/DeleteInsightRulesCommand.ts +++ b/clients/client-cloudwatch/commands/DeleteInsightRulesCommand.ts @@ -25,6 +25,20 @@ export interface DeleteInsightRulesCommandOutput extends DeleteInsightRulesOutpu *

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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { CloudWatchClient, DeleteInsightRulesCommand } from "@aws-sdk/client-cloudwatch"; // ES Modules import + * // const { CloudWatchClient, DeleteInsightRulesCommand } = require("@aws-sdk/client-cloudwatch"); // CommonJS import + * const client = new CloudWatchClient(config); + * const command = new DeleteInsightRulesCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteInsightRulesCommandInput} for command's `input` shape. + * @see {@link DeleteInsightRulesCommandOutput} for command's `response` shape. + * @see {@link CloudWatchClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteInsightRulesCommand extends $Command< DeleteInsightRulesCommandInput, diff --git a/clients/client-cloudwatch/commands/DeleteMetricStreamCommand.ts b/clients/client-cloudwatch/commands/DeleteMetricStreamCommand.ts index 741ed946afb2..ea749ba51ad6 100644 --- a/clients/client-cloudwatch/commands/DeleteMetricStreamCommand.ts +++ b/clients/client-cloudwatch/commands/DeleteMetricStreamCommand.ts @@ -22,6 +22,20 @@ export interface DeleteMetricStreamCommandOutput extends DeleteMetricStreamOutpu /** *

Permanently deletes the metric stream that you specify.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { CloudWatchClient, DeleteMetricStreamCommand } from "@aws-sdk/client-cloudwatch"; // ES Modules import + * // const { CloudWatchClient, DeleteMetricStreamCommand } = require("@aws-sdk/client-cloudwatch"); // CommonJS import + * const client = new CloudWatchClient(config); + * const command = new DeleteMetricStreamCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteMetricStreamCommandInput} for command's `input` shape. + * @see {@link DeleteMetricStreamCommandOutput} for command's `response` shape. + * @see {@link CloudWatchClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteMetricStreamCommand extends $Command< DeleteMetricStreamCommandInput, diff --git a/clients/client-cloudwatch/commands/DescribeAlarmHistoryCommand.ts b/clients/client-cloudwatch/commands/DescribeAlarmHistoryCommand.ts index 3c454e66640f..4e376e88531b 100644 --- a/clients/client-cloudwatch/commands/DescribeAlarmHistoryCommand.ts +++ b/clients/client-cloudwatch/commands/DescribeAlarmHistoryCommand.ts @@ -24,6 +24,20 @@ export interface DescribeAlarmHistoryCommandOutput extends DescribeAlarmHistoryO *

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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { CloudWatchClient, DescribeAlarmHistoryCommand } from "@aws-sdk/client-cloudwatch"; // ES Modules import + * // const { CloudWatchClient, DescribeAlarmHistoryCommand } = require("@aws-sdk/client-cloudwatch"); // CommonJS import + * const client = new CloudWatchClient(config); + * const command = new DescribeAlarmHistoryCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeAlarmHistoryCommandInput} for command's `input` shape. + * @see {@link DescribeAlarmHistoryCommandOutput} for command's `response` shape. + * @see {@link CloudWatchClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeAlarmHistoryCommand extends $Command< DescribeAlarmHistoryCommandInput, diff --git a/clients/client-cloudwatch/commands/DescribeAlarmsCommand.ts b/clients/client-cloudwatch/commands/DescribeAlarmsCommand.ts index dd678ffcb52b..e5c6bf536550 100644 --- a/clients/client-cloudwatch/commands/DescribeAlarmsCommand.ts +++ b/clients/client-cloudwatch/commands/DescribeAlarmsCommand.ts @@ -23,6 +23,20 @@ export interface DescribeAlarmsCommandOutput extends DescribeAlarmsOutput, __Met /** *

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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { CloudWatchClient, DescribeAlarmsCommand } from "@aws-sdk/client-cloudwatch"; // ES Modules import + * // const { CloudWatchClient, DescribeAlarmsCommand } = require("@aws-sdk/client-cloudwatch"); // CommonJS import + * const client = new CloudWatchClient(config); + * const command = new DescribeAlarmsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeAlarmsCommandInput} for command's `input` shape. + * @see {@link DescribeAlarmsCommandOutput} for command's `response` shape. + * @see {@link CloudWatchClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeAlarmsCommand extends $Command< DescribeAlarmsCommandInput, diff --git a/clients/client-cloudwatch/commands/DescribeAlarmsForMetricCommand.ts b/clients/client-cloudwatch/commands/DescribeAlarmsForMetricCommand.ts index 730781c935d9..7aea33cb10d3 100644 --- a/clients/client-cloudwatch/commands/DescribeAlarmsForMetricCommand.ts +++ b/clients/client-cloudwatch/commands/DescribeAlarmsForMetricCommand.ts @@ -26,6 +26,20 @@ export interface DescribeAlarmsForMetricCommandOutput extends DescribeAlarmsForM *

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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { CloudWatchClient, DescribeAlarmsForMetricCommand } from "@aws-sdk/client-cloudwatch"; // ES Modules import + * // const { CloudWatchClient, DescribeAlarmsForMetricCommand } = require("@aws-sdk/client-cloudwatch"); // CommonJS import + * const client = new CloudWatchClient(config); + * const command = new DescribeAlarmsForMetricCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeAlarmsForMetricCommandInput} for command's `input` shape. + * @see {@link DescribeAlarmsForMetricCommandOutput} for command's `response` shape. + * @see {@link CloudWatchClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeAlarmsForMetricCommand extends $Command< DescribeAlarmsForMetricCommandInput, diff --git a/clients/client-cloudwatch/commands/DescribeAnomalyDetectorsCommand.ts b/clients/client-cloudwatch/commands/DescribeAnomalyDetectorsCommand.ts index 3804f166fd1e..e6baca738b17 100644 --- a/clients/client-cloudwatch/commands/DescribeAnomalyDetectorsCommand.ts +++ b/clients/client-cloudwatch/commands/DescribeAnomalyDetectorsCommand.ts @@ -24,6 +24,20 @@ export interface DescribeAnomalyDetectorsCommandOutput extends DescribeAnomalyDe *

Lists the anomaly detection models that you have created in your account. You can list all * models in your account or filter the results to only the models that are related to a * certain namespace, metric name, or metric dimension.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { CloudWatchClient, DescribeAnomalyDetectorsCommand } from "@aws-sdk/client-cloudwatch"; // ES Modules import + * // const { CloudWatchClient, DescribeAnomalyDetectorsCommand } = require("@aws-sdk/client-cloudwatch"); // CommonJS import + * const client = new CloudWatchClient(config); + * const command = new DescribeAnomalyDetectorsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeAnomalyDetectorsCommandInput} for command's `input` shape. + * @see {@link DescribeAnomalyDetectorsCommandOutput} for command's `response` shape. + * @see {@link CloudWatchClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeAnomalyDetectorsCommand extends $Command< DescribeAnomalyDetectorsCommandInput, diff --git a/clients/client-cloudwatch/commands/DescribeInsightRulesCommand.ts b/clients/client-cloudwatch/commands/DescribeInsightRulesCommand.ts index b6156c1154d9..7bbc72d346e1 100644 --- a/clients/client-cloudwatch/commands/DescribeInsightRulesCommand.ts +++ b/clients/client-cloudwatch/commands/DescribeInsightRulesCommand.ts @@ -25,6 +25,20 @@ export interface DescribeInsightRulesCommandOutput extends DescribeInsightRulesO * *

For more information about Contributor Insights, see * Using Contributor Insights to Analyze High-Cardinality Data.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { CloudWatchClient, DescribeInsightRulesCommand } from "@aws-sdk/client-cloudwatch"; // ES Modules import + * // const { CloudWatchClient, DescribeInsightRulesCommand } = require("@aws-sdk/client-cloudwatch"); // CommonJS import + * const client = new CloudWatchClient(config); + * const command = new DescribeInsightRulesCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeInsightRulesCommandInput} for command's `input` shape. + * @see {@link DescribeInsightRulesCommandOutput} for command's `response` shape. + * @see {@link CloudWatchClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeInsightRulesCommand extends $Command< DescribeInsightRulesCommandInput, diff --git a/clients/client-cloudwatch/commands/DisableAlarmActionsCommand.ts b/clients/client-cloudwatch/commands/DisableAlarmActionsCommand.ts index 630cd8f8c748..950cbd910fe3 100644 --- a/clients/client-cloudwatch/commands/DisableAlarmActionsCommand.ts +++ b/clients/client-cloudwatch/commands/DisableAlarmActionsCommand.ts @@ -23,6 +23,20 @@ export interface DisableAlarmActionsCommandOutput extends __MetadataBearer {} /** *

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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { CloudWatchClient, DisableAlarmActionsCommand } from "@aws-sdk/client-cloudwatch"; // ES Modules import + * // const { CloudWatchClient, DisableAlarmActionsCommand } = require("@aws-sdk/client-cloudwatch"); // CommonJS import + * const client = new CloudWatchClient(config); + * const command = new DisableAlarmActionsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DisableAlarmActionsCommandInput} for command's `input` shape. + * @see {@link DisableAlarmActionsCommandOutput} for command's `response` shape. + * @see {@link CloudWatchClientResolvedConfig | config} for command's `input` shape. + * */ export class DisableAlarmActionsCommand extends $Command< DisableAlarmActionsCommandInput, diff --git a/clients/client-cloudwatch/commands/DisableInsightRulesCommand.ts b/clients/client-cloudwatch/commands/DisableInsightRulesCommand.ts index 0bc2429243a5..f330b13bc570 100644 --- a/clients/client-cloudwatch/commands/DisableInsightRulesCommand.ts +++ b/clients/client-cloudwatch/commands/DisableInsightRulesCommand.ts @@ -23,6 +23,20 @@ export interface DisableInsightRulesCommandOutput extends DisableInsightRulesOut /** *

Disables the specified Contributor Insights rules. When rules are disabled, they do not analyze log groups and do * not incur costs.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { CloudWatchClient, DisableInsightRulesCommand } from "@aws-sdk/client-cloudwatch"; // ES Modules import + * // const { CloudWatchClient, DisableInsightRulesCommand } = require("@aws-sdk/client-cloudwatch"); // CommonJS import + * const client = new CloudWatchClient(config); + * const command = new DisableInsightRulesCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DisableInsightRulesCommandInput} for command's `input` shape. + * @see {@link DisableInsightRulesCommandOutput} for command's `response` shape. + * @see {@link CloudWatchClientResolvedConfig | config} for command's `input` shape. + * */ export class DisableInsightRulesCommand extends $Command< DisableInsightRulesCommandInput, diff --git a/clients/client-cloudwatch/commands/EnableAlarmActionsCommand.ts b/clients/client-cloudwatch/commands/EnableAlarmActionsCommand.ts index 1ddb7c8e10b1..0ab2cfc22704 100644 --- a/clients/client-cloudwatch/commands/EnableAlarmActionsCommand.ts +++ b/clients/client-cloudwatch/commands/EnableAlarmActionsCommand.ts @@ -22,6 +22,20 @@ export interface EnableAlarmActionsCommandOutput extends __MetadataBearer {} /** *

Enables the actions for the specified alarms.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { CloudWatchClient, EnableAlarmActionsCommand } from "@aws-sdk/client-cloudwatch"; // ES Modules import + * // const { CloudWatchClient, EnableAlarmActionsCommand } = require("@aws-sdk/client-cloudwatch"); // CommonJS import + * const client = new CloudWatchClient(config); + * const command = new EnableAlarmActionsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link EnableAlarmActionsCommandInput} for command's `input` shape. + * @see {@link EnableAlarmActionsCommandOutput} for command's `response` shape. + * @see {@link CloudWatchClientResolvedConfig | config} for command's `input` shape. + * */ export class EnableAlarmActionsCommand extends $Command< EnableAlarmActionsCommandInput, diff --git a/clients/client-cloudwatch/commands/EnableInsightRulesCommand.ts b/clients/client-cloudwatch/commands/EnableInsightRulesCommand.ts index c09c8912b965..9262b68b7280 100644 --- a/clients/client-cloudwatch/commands/EnableInsightRulesCommand.ts +++ b/clients/client-cloudwatch/commands/EnableInsightRulesCommand.ts @@ -22,6 +22,20 @@ export interface EnableInsightRulesCommandOutput extends EnableInsightRulesOutpu /** *

Enables the specified Contributor Insights rules. When rules are enabled, they immediately begin analyzing log data.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { CloudWatchClient, EnableInsightRulesCommand } from "@aws-sdk/client-cloudwatch"; // ES Modules import + * // const { CloudWatchClient, EnableInsightRulesCommand } = require("@aws-sdk/client-cloudwatch"); // CommonJS import + * const client = new CloudWatchClient(config); + * const command = new EnableInsightRulesCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link EnableInsightRulesCommandInput} for command's `input` shape. + * @see {@link EnableInsightRulesCommandOutput} for command's `response` shape. + * @see {@link CloudWatchClientResolvedConfig | config} for command's `input` shape. + * */ export class EnableInsightRulesCommand extends $Command< EnableInsightRulesCommandInput, diff --git a/clients/client-cloudwatch/commands/GetDashboardCommand.ts b/clients/client-cloudwatch/commands/GetDashboardCommand.ts index fd47610f477d..47c6bda5f010 100644 --- a/clients/client-cloudwatch/commands/GetDashboardCommand.ts +++ b/clients/client-cloudwatch/commands/GetDashboardCommand.ts @@ -22,6 +22,20 @@ export interface GetDashboardCommandOutput extends GetDashboardOutput, __Metadat *

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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { CloudWatchClient, GetDashboardCommand } from "@aws-sdk/client-cloudwatch"; // ES Modules import + * // const { CloudWatchClient, GetDashboardCommand } = require("@aws-sdk/client-cloudwatch"); // CommonJS import + * const client = new CloudWatchClient(config); + * const command = new GetDashboardCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetDashboardCommandInput} for command's `input` shape. + * @see {@link GetDashboardCommandOutput} for command's `response` shape. + * @see {@link CloudWatchClientResolvedConfig | config} for command's `input` shape. + * */ export class GetDashboardCommand extends $Command< GetDashboardCommandInput, diff --git a/clients/client-cloudwatch/commands/GetInsightRuleReportCommand.ts b/clients/client-cloudwatch/commands/GetInsightRuleReportCommand.ts index e81fe0b5c904..932882d64b3f 100644 --- a/clients/client-cloudwatch/commands/GetInsightRuleReportCommand.ts +++ b/clients/client-cloudwatch/commands/GetInsightRuleReportCommand.ts @@ -58,6 +58,20 @@ export interface GetInsightRuleReportCommandOutput extends GetInsightRuleReportO * Average -- the average value from all contributors during the time period represented by that data point.

* * + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { CloudWatchClient, GetInsightRuleReportCommand } from "@aws-sdk/client-cloudwatch"; // ES Modules import + * // const { CloudWatchClient, GetInsightRuleReportCommand } = require("@aws-sdk/client-cloudwatch"); // CommonJS import + * const client = new CloudWatchClient(config); + * const command = new GetInsightRuleReportCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetInsightRuleReportCommandInput} for command's `input` shape. + * @see {@link GetInsightRuleReportCommandOutput} for command's `response` shape. + * @see {@link CloudWatchClientResolvedConfig | config} for command's `input` shape. + * */ export class GetInsightRuleReportCommand extends $Command< GetInsightRuleReportCommandInput, diff --git a/clients/client-cloudwatch/commands/GetMetricDataCommand.ts b/clients/client-cloudwatch/commands/GetMetricDataCommand.ts index d0aa807e8d85..dcb866bc68d4 100644 --- a/clients/client-cloudwatch/commands/GetMetricDataCommand.ts +++ b/clients/client-cloudwatch/commands/GetMetricDataCommand.ts @@ -57,6 +57,20 @@ export interface GetMetricDataCommandOutput extends GetMetricDataOutput, __Metad *

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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { CloudWatchClient, GetMetricDataCommand } from "@aws-sdk/client-cloudwatch"; // ES Modules import + * // const { CloudWatchClient, GetMetricDataCommand } = require("@aws-sdk/client-cloudwatch"); // CommonJS import + * const client = new CloudWatchClient(config); + * const command = new GetMetricDataCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetMetricDataCommandInput} for command's `input` shape. + * @see {@link GetMetricDataCommandOutput} for command's `response` shape. + * @see {@link CloudWatchClientResolvedConfig | config} for command's `input` shape. + * */ export class GetMetricDataCommand extends $Command< GetMetricDataCommandInput, diff --git a/clients/client-cloudwatch/commands/GetMetricStatisticsCommand.ts b/clients/client-cloudwatch/commands/GetMetricStatisticsCommand.ts index 0ac4c02cf284..f994eaa4a673 100644 --- a/clients/client-cloudwatch/commands/GetMetricStatisticsCommand.ts +++ b/clients/client-cloudwatch/commands/GetMetricStatisticsCommand.ts @@ -73,6 +73,20 @@ export interface GetMetricStatisticsCommandOutput extends GetMetricStatisticsOut *

For information about metrics and dimensions supported by AWS services, see the * Amazon CloudWatch Metrics and Dimensions Reference in the * Amazon CloudWatch User Guide.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { CloudWatchClient, GetMetricStatisticsCommand } from "@aws-sdk/client-cloudwatch"; // ES Modules import + * // const { CloudWatchClient, GetMetricStatisticsCommand } = require("@aws-sdk/client-cloudwatch"); // CommonJS import + * const client = new CloudWatchClient(config); + * const command = new GetMetricStatisticsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetMetricStatisticsCommandInput} for command's `input` shape. + * @see {@link GetMetricStatisticsCommandOutput} for command's `response` shape. + * @see {@link CloudWatchClientResolvedConfig | config} for command's `input` shape. + * */ export class GetMetricStatisticsCommand extends $Command< GetMetricStatisticsCommandInput, diff --git a/clients/client-cloudwatch/commands/GetMetricStreamCommand.ts b/clients/client-cloudwatch/commands/GetMetricStreamCommand.ts index 1900d8567674..9a88b36af71c 100644 --- a/clients/client-cloudwatch/commands/GetMetricStreamCommand.ts +++ b/clients/client-cloudwatch/commands/GetMetricStreamCommand.ts @@ -22,6 +22,20 @@ export interface GetMetricStreamCommandOutput extends GetMetricStreamOutput, __M /** *

Returns information about the metric stream that you specify.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { CloudWatchClient, GetMetricStreamCommand } from "@aws-sdk/client-cloudwatch"; // ES Modules import + * // const { CloudWatchClient, GetMetricStreamCommand } = require("@aws-sdk/client-cloudwatch"); // CommonJS import + * const client = new CloudWatchClient(config); + * const command = new GetMetricStreamCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetMetricStreamCommandInput} for command's `input` shape. + * @see {@link GetMetricStreamCommandOutput} for command's `response` shape. + * @see {@link CloudWatchClientResolvedConfig | config} for command's `input` shape. + * */ export class GetMetricStreamCommand extends $Command< GetMetricStreamCommandInput, diff --git a/clients/client-cloudwatch/commands/GetMetricWidgetImageCommand.ts b/clients/client-cloudwatch/commands/GetMetricWidgetImageCommand.ts index fcc441909680..bea3df5132a3 100644 --- a/clients/client-cloudwatch/commands/GetMetricWidgetImageCommand.ts +++ b/clients/client-cloudwatch/commands/GetMetricWidgetImageCommand.ts @@ -39,6 +39,20 @@ export interface GetMetricWidgetImageCommandOutput extends GetMetricWidgetImageO *

Up to 100 KB uncompressed payload.

* * + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { CloudWatchClient, GetMetricWidgetImageCommand } from "@aws-sdk/client-cloudwatch"; // ES Modules import + * // const { CloudWatchClient, GetMetricWidgetImageCommand } = require("@aws-sdk/client-cloudwatch"); // CommonJS import + * const client = new CloudWatchClient(config); + * const command = new GetMetricWidgetImageCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetMetricWidgetImageCommandInput} for command's `input` shape. + * @see {@link GetMetricWidgetImageCommandOutput} for command's `response` shape. + * @see {@link CloudWatchClientResolvedConfig | config} for command's `input` shape. + * */ export class GetMetricWidgetImageCommand extends $Command< GetMetricWidgetImageCommandInput, diff --git a/clients/client-cloudwatch/commands/ListDashboardsCommand.ts b/clients/client-cloudwatch/commands/ListDashboardsCommand.ts index fcc157de0cf8..f7bbccf3d0d8 100644 --- a/clients/client-cloudwatch/commands/ListDashboardsCommand.ts +++ b/clients/client-cloudwatch/commands/ListDashboardsCommand.ts @@ -30,6 +30,20 @@ export interface ListDashboardsCommandOutput extends ListDashboardsOutput, __Met * 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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { CloudWatchClient, ListDashboardsCommand } from "@aws-sdk/client-cloudwatch"; // ES Modules import + * // const { CloudWatchClient, ListDashboardsCommand } = require("@aws-sdk/client-cloudwatch"); // CommonJS import + * const client = new CloudWatchClient(config); + * const command = new ListDashboardsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListDashboardsCommandInput} for command's `input` shape. + * @see {@link ListDashboardsCommandOutput} for command's `response` shape. + * @see {@link CloudWatchClientResolvedConfig | config} for command's `input` shape. + * */ export class ListDashboardsCommand extends $Command< ListDashboardsCommandInput, diff --git a/clients/client-cloudwatch/commands/ListMetricStreamsCommand.ts b/clients/client-cloudwatch/commands/ListMetricStreamsCommand.ts index 35c44649e338..c395a2760932 100644 --- a/clients/client-cloudwatch/commands/ListMetricStreamsCommand.ts +++ b/clients/client-cloudwatch/commands/ListMetricStreamsCommand.ts @@ -22,6 +22,20 @@ export interface ListMetricStreamsCommandOutput extends ListMetricStreamsOutput, /** *

Returns a list of metric streams in this account.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { CloudWatchClient, ListMetricStreamsCommand } from "@aws-sdk/client-cloudwatch"; // ES Modules import + * // const { CloudWatchClient, ListMetricStreamsCommand } = require("@aws-sdk/client-cloudwatch"); // CommonJS import + * const client = new CloudWatchClient(config); + * const command = new ListMetricStreamsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListMetricStreamsCommandInput} for command's `input` shape. + * @see {@link ListMetricStreamsCommandOutput} for command's `response` shape. + * @see {@link CloudWatchClientResolvedConfig | config} for command's `input` shape. + * */ export class ListMetricStreamsCommand extends $Command< ListMetricStreamsCommandInput, diff --git a/clients/client-cloudwatch/commands/ListMetricsCommand.ts b/clients/client-cloudwatch/commands/ListMetricsCommand.ts index fb4a5c1353ab..c3acddc1b082 100644 --- a/clients/client-cloudwatch/commands/ListMetricsCommand.ts +++ b/clients/client-cloudwatch/commands/ListMetricsCommand.ts @@ -32,6 +32,20 @@ export interface ListMetricsCommandOutput extends ListMetricsOutput, __MetadataB * reported data in the past two weeks. To retrieve those metrics, use * GetMetricData or * GetMetricStatistics.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { CloudWatchClient, ListMetricsCommand } from "@aws-sdk/client-cloudwatch"; // ES Modules import + * // const { CloudWatchClient, ListMetricsCommand } = require("@aws-sdk/client-cloudwatch"); // CommonJS import + * const client = new CloudWatchClient(config); + * const command = new ListMetricsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListMetricsCommandInput} for command's `input` shape. + * @see {@link ListMetricsCommandOutput} for command's `response` shape. + * @see {@link CloudWatchClientResolvedConfig | config} for command's `input` shape. + * */ export class ListMetricsCommand extends $Command< ListMetricsCommandInput, diff --git a/clients/client-cloudwatch/commands/ListTagsForResourceCommand.ts b/clients/client-cloudwatch/commands/ListTagsForResourceCommand.ts index 102d8c6e34c1..707d25ad5df1 100644 --- a/clients/client-cloudwatch/commands/ListTagsForResourceCommand.ts +++ b/clients/client-cloudwatch/commands/ListTagsForResourceCommand.ts @@ -23,6 +23,20 @@ export interface ListTagsForResourceCommandOutput extends ListTagsForResourceOut /** *

Displays the tags associated with a CloudWatch resource. Currently, alarms * and Contributor Insights rules support tagging.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { CloudWatchClient, ListTagsForResourceCommand } from "@aws-sdk/client-cloudwatch"; // ES Modules import + * // const { CloudWatchClient, ListTagsForResourceCommand } = require("@aws-sdk/client-cloudwatch"); // CommonJS import + * const client = new CloudWatchClient(config); + * const command = new ListTagsForResourceCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListTagsForResourceCommandInput} for command's `input` shape. + * @see {@link ListTagsForResourceCommandOutput} for command's `response` shape. + * @see {@link CloudWatchClientResolvedConfig | config} for command's `input` shape. + * */ export class ListTagsForResourceCommand extends $Command< ListTagsForResourceCommandInput, diff --git a/clients/client-cloudwatch/commands/PutAnomalyDetectorCommand.ts b/clients/client-cloudwatch/commands/PutAnomalyDetectorCommand.ts index 1b9d86a29c6a..9d924ec23e70 100644 --- a/clients/client-cloudwatch/commands/PutAnomalyDetectorCommand.ts +++ b/clients/client-cloudwatch/commands/PutAnomalyDetectorCommand.ts @@ -24,6 +24,20 @@ export interface PutAnomalyDetectorCommandOutput extends PutAnomalyDetectorOutpu *

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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { CloudWatchClient, PutAnomalyDetectorCommand } from "@aws-sdk/client-cloudwatch"; // ES Modules import + * // const { CloudWatchClient, PutAnomalyDetectorCommand } = require("@aws-sdk/client-cloudwatch"); // CommonJS import + * const client = new CloudWatchClient(config); + * const command = new PutAnomalyDetectorCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link PutAnomalyDetectorCommandInput} for command's `input` shape. + * @see {@link PutAnomalyDetectorCommandOutput} for command's `response` shape. + * @see {@link CloudWatchClientResolvedConfig | config} for command's `input` shape. + * */ export class PutAnomalyDetectorCommand extends $Command< PutAnomalyDetectorCommandInput, diff --git a/clients/client-cloudwatch/commands/PutCompositeAlarmCommand.ts b/clients/client-cloudwatch/commands/PutCompositeAlarmCommand.ts index 49cbd1900d1a..e7edef9dfe53 100644 --- a/clients/client-cloudwatch/commands/PutCompositeAlarmCommand.ts +++ b/clients/client-cloudwatch/commands/PutCompositeAlarmCommand.ts @@ -57,6 +57,20 @@ export interface PutCompositeAlarmCommandOutput extends __MetadataBearer {} * *

If you are an IAM user, you must have iam:CreateServiceLinkedRole to create * a composite alarm that has Systems Manager OpsItem actions.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { CloudWatchClient, PutCompositeAlarmCommand } from "@aws-sdk/client-cloudwatch"; // ES Modules import + * // const { CloudWatchClient, PutCompositeAlarmCommand } = require("@aws-sdk/client-cloudwatch"); // CommonJS import + * const client = new CloudWatchClient(config); + * const command = new PutCompositeAlarmCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link PutCompositeAlarmCommandInput} for command's `input` shape. + * @see {@link PutCompositeAlarmCommandOutput} for command's `response` shape. + * @see {@link CloudWatchClientResolvedConfig | config} for command's `input` shape. + * */ export class PutCompositeAlarmCommand extends $Command< PutCompositeAlarmCommandInput, diff --git a/clients/client-cloudwatch/commands/PutDashboardCommand.ts b/clients/client-cloudwatch/commands/PutDashboardCommand.ts index 885178e9b4a5..fcdfc8edf834 100644 --- a/clients/client-cloudwatch/commands/PutDashboardCommand.ts +++ b/clients/client-cloudwatch/commands/PutDashboardCommand.ts @@ -32,6 +32,20 @@ export interface PutDashboardCommandOutput extends PutDashboardOutput, __Metadat * 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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { CloudWatchClient, PutDashboardCommand } from "@aws-sdk/client-cloudwatch"; // ES Modules import + * // const { CloudWatchClient, PutDashboardCommand } = require("@aws-sdk/client-cloudwatch"); // CommonJS import + * const client = new CloudWatchClient(config); + * const command = new PutDashboardCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link PutDashboardCommandInput} for command's `input` shape. + * @see {@link PutDashboardCommandOutput} for command's `response` shape. + * @see {@link CloudWatchClientResolvedConfig | config} for command's `input` shape. + * */ export class PutDashboardCommand extends $Command< PutDashboardCommandInput, diff --git a/clients/client-cloudwatch/commands/PutInsightRuleCommand.ts b/clients/client-cloudwatch/commands/PutInsightRuleCommand.ts index 1c1bccb13a38..84cafd72b459 100644 --- a/clients/client-cloudwatch/commands/PutInsightRuleCommand.ts +++ b/clients/client-cloudwatch/commands/PutInsightRuleCommand.ts @@ -26,6 +26,20 @@ export interface PutInsightRuleCommandOutput extends PutInsightRuleOutput, __Met * 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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { CloudWatchClient, PutInsightRuleCommand } from "@aws-sdk/client-cloudwatch"; // ES Modules import + * // const { CloudWatchClient, PutInsightRuleCommand } = require("@aws-sdk/client-cloudwatch"); // CommonJS import + * const client = new CloudWatchClient(config); + * const command = new PutInsightRuleCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link PutInsightRuleCommandInput} for command's `input` shape. + * @see {@link PutInsightRuleCommandOutput} for command's `response` shape. + * @see {@link CloudWatchClientResolvedConfig | config} for command's `input` shape. + * */ export class PutInsightRuleCommand extends $Command< PutInsightRuleCommandInput, diff --git a/clients/client-cloudwatch/commands/PutMetricAlarmCommand.ts b/clients/client-cloudwatch/commands/PutMetricAlarmCommand.ts index b00ea7e21afd..cffd994eec48 100644 --- a/clients/client-cloudwatch/commands/PutMetricAlarmCommand.ts +++ b/clients/client-cloudwatch/commands/PutMetricAlarmCommand.ts @@ -55,6 +55,20 @@ export interface PutMetricAlarmCommandOutput extends __MetadataBearer {} * are called AWSServiceRoleForCloudWatchEvents and * AWSServiceRoleForCloudWatchAlarms_ActionSSM. * For more information, see AWS service-linked role.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { CloudWatchClient, PutMetricAlarmCommand } from "@aws-sdk/client-cloudwatch"; // ES Modules import + * // const { CloudWatchClient, PutMetricAlarmCommand } = require("@aws-sdk/client-cloudwatch"); // CommonJS import + * const client = new CloudWatchClient(config); + * const command = new PutMetricAlarmCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link PutMetricAlarmCommandInput} for command's `input` shape. + * @see {@link PutMetricAlarmCommandOutput} for command's `response` shape. + * @see {@link CloudWatchClientResolvedConfig | config} for command's `input` shape. + * */ export class PutMetricAlarmCommand extends $Command< PutMetricAlarmCommandInput, diff --git a/clients/client-cloudwatch/commands/PutMetricDataCommand.ts b/clients/client-cloudwatch/commands/PutMetricDataCommand.ts index 8d97a5f2b144..993c0462ee32 100644 --- a/clients/client-cloudwatch/commands/PutMetricDataCommand.ts +++ b/clients/client-cloudwatch/commands/PutMetricDataCommand.ts @@ -66,6 +66,20 @@ export interface PutMetricDataCommandOutput extends __MetadataBearer {} * multiplied by SampleCount.

* * + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { CloudWatchClient, PutMetricDataCommand } from "@aws-sdk/client-cloudwatch"; // ES Modules import + * // const { CloudWatchClient, PutMetricDataCommand } = require("@aws-sdk/client-cloudwatch"); // CommonJS import + * const client = new CloudWatchClient(config); + * const command = new PutMetricDataCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link PutMetricDataCommandInput} for command's `input` shape. + * @see {@link PutMetricDataCommandOutput} for command's `response` shape. + * @see {@link CloudWatchClientResolvedConfig | config} for command's `input` shape. + * */ export class PutMetricDataCommand extends $Command< PutMetricDataCommandInput, diff --git a/clients/client-cloudwatch/commands/PutMetricStreamCommand.ts b/clients/client-cloudwatch/commands/PutMetricStreamCommand.ts index e82f584c63ce..c301b8eb8457 100644 --- a/clients/client-cloudwatch/commands/PutMetricStreamCommand.ts +++ b/clients/client-cloudwatch/commands/PutMetricStreamCommand.ts @@ -49,6 +49,20 @@ export interface PutMetricStreamCommandOutput extends PutMetricStreamOutput, __M *

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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { CloudWatchClient, PutMetricStreamCommand } from "@aws-sdk/client-cloudwatch"; // ES Modules import + * // const { CloudWatchClient, PutMetricStreamCommand } = require("@aws-sdk/client-cloudwatch"); // CommonJS import + * const client = new CloudWatchClient(config); + * const command = new PutMetricStreamCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link PutMetricStreamCommandInput} for command's `input` shape. + * @see {@link PutMetricStreamCommandOutput} for command's `response` shape. + * @see {@link CloudWatchClientResolvedConfig | config} for command's `input` shape. + * */ export class PutMetricStreamCommand extends $Command< PutMetricStreamCommandInput, diff --git a/clients/client-cloudwatch/commands/SetAlarmStateCommand.ts b/clients/client-cloudwatch/commands/SetAlarmStateCommand.ts index afdf1a74562f..a2bfd9110d89 100644 --- a/clients/client-cloudwatch/commands/SetAlarmStateCommand.ts +++ b/clients/client-cloudwatch/commands/SetAlarmStateCommand.ts @@ -37,6 +37,20 @@ export interface SetAlarmStateCommandOutput extends __MetadataBearer {} * 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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { CloudWatchClient, SetAlarmStateCommand } from "@aws-sdk/client-cloudwatch"; // ES Modules import + * // const { CloudWatchClient, SetAlarmStateCommand } = require("@aws-sdk/client-cloudwatch"); // CommonJS import + * const client = new CloudWatchClient(config); + * const command = new SetAlarmStateCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link SetAlarmStateCommandInput} for command's `input` shape. + * @see {@link SetAlarmStateCommandOutput} for command's `response` shape. + * @see {@link CloudWatchClientResolvedConfig | config} for command's `input` shape. + * */ export class SetAlarmStateCommand extends $Command< SetAlarmStateCommandInput, diff --git a/clients/client-cloudwatch/commands/StartMetricStreamsCommand.ts b/clients/client-cloudwatch/commands/StartMetricStreamsCommand.ts index 8b8881fc0bc3..73f26df6a291 100644 --- a/clients/client-cloudwatch/commands/StartMetricStreamsCommand.ts +++ b/clients/client-cloudwatch/commands/StartMetricStreamsCommand.ts @@ -22,6 +22,20 @@ export interface StartMetricStreamsCommandOutput extends StartMetricStreamsOutpu /** *

Starts the streaming of metrics for one or more of your metric streams.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { CloudWatchClient, StartMetricStreamsCommand } from "@aws-sdk/client-cloudwatch"; // ES Modules import + * // const { CloudWatchClient, StartMetricStreamsCommand } = require("@aws-sdk/client-cloudwatch"); // CommonJS import + * const client = new CloudWatchClient(config); + * const command = new StartMetricStreamsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link StartMetricStreamsCommandInput} for command's `input` shape. + * @see {@link StartMetricStreamsCommandOutput} for command's `response` shape. + * @see {@link CloudWatchClientResolvedConfig | config} for command's `input` shape. + * */ export class StartMetricStreamsCommand extends $Command< StartMetricStreamsCommandInput, diff --git a/clients/client-cloudwatch/commands/StopMetricStreamsCommand.ts b/clients/client-cloudwatch/commands/StopMetricStreamsCommand.ts index 641591374a60..f1d177fb701a 100644 --- a/clients/client-cloudwatch/commands/StopMetricStreamsCommand.ts +++ b/clients/client-cloudwatch/commands/StopMetricStreamsCommand.ts @@ -22,6 +22,20 @@ export interface StopMetricStreamsCommandOutput extends StopMetricStreamsOutput, /** *

Stops the streaming of metrics for one or more of your metric streams.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { CloudWatchClient, StopMetricStreamsCommand } from "@aws-sdk/client-cloudwatch"; // ES Modules import + * // const { CloudWatchClient, StopMetricStreamsCommand } = require("@aws-sdk/client-cloudwatch"); // CommonJS import + * const client = new CloudWatchClient(config); + * const command = new StopMetricStreamsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link StopMetricStreamsCommandInput} for command's `input` shape. + * @see {@link StopMetricStreamsCommandOutput} for command's `response` shape. + * @see {@link CloudWatchClientResolvedConfig | config} for command's `input` shape. + * */ export class StopMetricStreamsCommand extends $Command< StopMetricStreamsCommandInput, diff --git a/clients/client-cloudwatch/commands/TagResourceCommand.ts b/clients/client-cloudwatch/commands/TagResourceCommand.ts index 55d44c6fbe81..e5ab347e9c5a 100644 --- a/clients/client-cloudwatch/commands/TagResourceCommand.ts +++ b/clients/client-cloudwatch/commands/TagResourceCommand.ts @@ -29,6 +29,20 @@ export interface TagResourceCommandOutput extends TagResourceOutput, __MetadataB * 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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { CloudWatchClient, TagResourceCommand } from "@aws-sdk/client-cloudwatch"; // ES Modules import + * // const { CloudWatchClient, TagResourceCommand } = require("@aws-sdk/client-cloudwatch"); // CommonJS import + * const client = new CloudWatchClient(config); + * const command = new TagResourceCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link TagResourceCommandInput} for command's `input` shape. + * @see {@link TagResourceCommandOutput} for command's `response` shape. + * @see {@link CloudWatchClientResolvedConfig | config} for command's `input` shape. + * */ export class TagResourceCommand extends $Command< TagResourceCommandInput, diff --git a/clients/client-cloudwatch/commands/UntagResourceCommand.ts b/clients/client-cloudwatch/commands/UntagResourceCommand.ts index 071a0ac832bf..b0614608d5a9 100644 --- a/clients/client-cloudwatch/commands/UntagResourceCommand.ts +++ b/clients/client-cloudwatch/commands/UntagResourceCommand.ts @@ -22,6 +22,20 @@ export interface UntagResourceCommandOutput extends UntagResourceOutput, __Metad /** *

Removes one or more tags from the specified resource.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { CloudWatchClient, UntagResourceCommand } from "@aws-sdk/client-cloudwatch"; // ES Modules import + * // const { CloudWatchClient, UntagResourceCommand } = require("@aws-sdk/client-cloudwatch"); // CommonJS import + * const client = new CloudWatchClient(config); + * const command = new UntagResourceCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link UntagResourceCommandInput} for command's `input` shape. + * @see {@link UntagResourceCommandOutput} for command's `response` shape. + * @see {@link CloudWatchClientResolvedConfig | config} for command's `input` shape. + * */ export class UntagResourceCommand extends $Command< UntagResourceCommandInput, diff --git a/clients/client-cloudwatch/models/models_0.ts b/clients/client-cloudwatch/models/models_0.ts index 2ac9656facc6..84e221e2a9cc 100644 --- a/clients/client-cloudwatch/models/models_0.ts +++ b/clients/client-cloudwatch/models/models_0.ts @@ -41,6 +41,9 @@ export interface AlarmHistoryItem { } export namespace AlarmHistoryItem { + /** + * @internal + */ export const filterSensitiveLog = (obj: AlarmHistoryItem): any => ({ ...obj, }); @@ -65,6 +68,9 @@ export interface Range { } export namespace Range { + /** + * @internal + */ export const filterSensitiveLog = (obj: Range): any => ({ ...obj, }); @@ -94,6 +100,9 @@ export interface AnomalyDetectorConfiguration { } export namespace AnomalyDetectorConfiguration { + /** + * @internal + */ export const filterSensitiveLog = (obj: AnomalyDetectorConfiguration): any => ({ ...obj, }); @@ -120,6 +129,9 @@ export interface Dimension { } export namespace Dimension { + /** + * @internal + */ export const filterSensitiveLog = (obj: Dimension): any => ({ ...obj, }); @@ -169,6 +181,9 @@ export interface AnomalyDetector { } export namespace AnomalyDetector { + /** + * @internal + */ export const filterSensitiveLog = (obj: AnomalyDetector): any => ({ ...obj, }); @@ -201,6 +216,9 @@ export interface PartialFailure { } export namespace PartialFailure { + /** + * @internal + */ export const filterSensitiveLog = (obj: PartialFailure): any => ({ ...obj, }); @@ -288,6 +306,9 @@ export interface CompositeAlarm { } export namespace CompositeAlarm { + /** + * @internal + */ export const filterSensitiveLog = (obj: CompositeAlarm): any => ({ ...obj, }); @@ -303,6 +324,9 @@ export interface ConcurrentModificationException extends __SmithyException, $Met } export namespace ConcurrentModificationException { + /** + * @internal + */ export const filterSensitiveLog = (obj: ConcurrentModificationException): any => ({ ...obj, }); @@ -335,6 +359,9 @@ export interface DashboardEntry { } export namespace DashboardEntry { + /** + * @internal + */ export const filterSensitiveLog = (obj: DashboardEntry): any => ({ ...obj, }); @@ -356,6 +383,9 @@ export interface DashboardValidationMessage { } export namespace DashboardValidationMessage { + /** + * @internal + */ export const filterSensitiveLog = (obj: DashboardValidationMessage): any => ({ ...obj, }); @@ -372,6 +402,9 @@ export interface DashboardInvalidInputError extends __SmithyException, $Metadata } export namespace DashboardInvalidInputError { + /** + * @internal + */ export const filterSensitiveLog = (obj: DashboardInvalidInputError): any => ({ ...obj, }); @@ -387,6 +420,9 @@ export interface DashboardNotFoundError extends __SmithyException, $MetadataBear } export namespace DashboardNotFoundError { + /** + * @internal + */ export const filterSensitiveLog = (obj: DashboardNotFoundError): any => ({ ...obj, }); @@ -468,6 +504,9 @@ export interface Datapoint { } export namespace Datapoint { + /** + * @internal + */ export const filterSensitiveLog = (obj: Datapoint): any => ({ ...obj, }); @@ -481,6 +520,9 @@ export interface DeleteAlarmsInput { } export namespace DeleteAlarmsInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteAlarmsInput): any => ({ ...obj, }); @@ -499,6 +541,9 @@ export interface ResourceNotFound extends __SmithyException, $MetadataBearer { } export namespace ResourceNotFound { + /** + * @internal + */ export const filterSensitiveLog = (obj: ResourceNotFound): any => ({ ...obj, }); @@ -527,6 +572,9 @@ export interface DeleteAnomalyDetectorInput { } export namespace DeleteAnomalyDetectorInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteAnomalyDetectorInput): any => ({ ...obj, }); @@ -535,6 +583,9 @@ export namespace DeleteAnomalyDetectorInput { export interface DeleteAnomalyDetectorOutput {} export namespace DeleteAnomalyDetectorOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteAnomalyDetectorOutput): any => ({ ...obj, }); @@ -553,6 +604,9 @@ export interface InternalServiceFault extends __SmithyException, $MetadataBearer } export namespace InternalServiceFault { + /** + * @internal + */ export const filterSensitiveLog = (obj: InternalServiceFault): any => ({ ...obj, }); @@ -571,6 +625,9 @@ export interface InvalidParameterValueException extends __SmithyException, $Meta } export namespace InvalidParameterValueException { + /** + * @internal + */ export const filterSensitiveLog = (obj: InvalidParameterValueException): any => ({ ...obj, }); @@ -589,6 +646,9 @@ export interface MissingRequiredParameterException extends __SmithyException, $M } export namespace MissingRequiredParameterException { + /** + * @internal + */ export const filterSensitiveLog = (obj: MissingRequiredParameterException): any => ({ ...obj, }); @@ -606,6 +666,9 @@ export interface ResourceNotFoundException extends __SmithyException, $MetadataB } export namespace ResourceNotFoundException { + /** + * @internal + */ export const filterSensitiveLog = (obj: ResourceNotFoundException): any => ({ ...obj, }); @@ -619,6 +682,9 @@ export interface DeleteDashboardsInput { } export namespace DeleteDashboardsInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteDashboardsInput): any => ({ ...obj, }); @@ -627,6 +693,9 @@ export namespace DeleteDashboardsInput { export interface DeleteDashboardsOutput {} export namespace DeleteDashboardsOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteDashboardsOutput): any => ({ ...obj, }); @@ -640,6 +709,9 @@ export interface DeleteInsightRulesInput { } export namespace DeleteInsightRulesInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteInsightRulesInput): any => ({ ...obj, }); @@ -653,6 +725,9 @@ export interface DeleteInsightRulesOutput { } export namespace DeleteInsightRulesOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteInsightRulesOutput): any => ({ ...obj, }); @@ -666,6 +741,9 @@ export interface DeleteMetricStreamInput { } export namespace DeleteMetricStreamInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteMetricStreamInput): any => ({ ...obj, }); @@ -674,6 +752,9 @@ export namespace DeleteMetricStreamInput { export interface DeleteMetricStreamOutput {} export namespace DeleteMetricStreamOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteMetricStreamOutput): any => ({ ...obj, }); @@ -730,6 +811,9 @@ export interface DescribeAlarmHistoryInput { } export namespace DescribeAlarmHistoryInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeAlarmHistoryInput): any => ({ ...obj, }); @@ -748,6 +832,9 @@ export interface DescribeAlarmHistoryOutput { } export namespace DescribeAlarmHistoryOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeAlarmHistoryOutput): any => ({ ...obj, }); @@ -766,6 +853,9 @@ export interface InvalidNextToken extends __SmithyException, $MetadataBearer { } export namespace InvalidNextToken { + /** + * @internal + */ export const filterSensitiveLog = (obj: InvalidNextToken): any => ({ ...obj, }); @@ -855,6 +945,9 @@ export interface DescribeAlarmsInput { } export namespace DescribeAlarmsInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeAlarmsInput): any => ({ ...obj, }); @@ -881,6 +974,9 @@ export interface Metric { } export namespace Metric { + /** + * @internal + */ export const filterSensitiveLog = (obj: Metric): any => ({ ...obj, }); @@ -931,6 +1027,9 @@ export interface MetricStat { } export namespace MetricStat { + /** + * @internal + */ export const filterSensitiveLog = (obj: MetricStat): any => ({ ...obj, }); @@ -1022,6 +1121,9 @@ export interface MetricDataQuery { } export namespace MetricDataQuery { + /** + * @internal + */ export const filterSensitiveLog = (obj: MetricDataQuery): any => ({ ...obj, }); @@ -1188,6 +1290,9 @@ export interface MetricAlarm { } export namespace MetricAlarm { + /** + * @internal + */ export const filterSensitiveLog = (obj: MetricAlarm): any => ({ ...obj, }); @@ -1211,6 +1316,9 @@ export interface DescribeAlarmsOutput { } export namespace DescribeAlarmsOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeAlarmsOutput): any => ({ ...obj, }); @@ -1257,6 +1365,9 @@ export interface DescribeAlarmsForMetricInput { } export namespace DescribeAlarmsForMetricInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeAlarmsForMetricInput): any => ({ ...obj, }); @@ -1270,6 +1381,9 @@ export interface DescribeAlarmsForMetricOutput { } export namespace DescribeAlarmsForMetricOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeAlarmsForMetricOutput): any => ({ ...obj, }); @@ -1311,6 +1425,9 @@ export interface DescribeAnomalyDetectorsInput { } export namespace DescribeAnomalyDetectorsInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeAnomalyDetectorsInput): any => ({ ...obj, }); @@ -1330,6 +1447,9 @@ export interface DescribeAnomalyDetectorsOutput { } export namespace DescribeAnomalyDetectorsOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeAnomalyDetectorsOutput): any => ({ ...obj, }); @@ -1349,6 +1469,9 @@ export interface DescribeInsightRulesInput { } export namespace DescribeInsightRulesInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeInsightRulesInput): any => ({ ...obj, }); @@ -1385,6 +1508,9 @@ export interface InsightRule { } export namespace InsightRule { + /** + * @internal + */ export const filterSensitiveLog = (obj: InsightRule): any => ({ ...obj, }); @@ -1403,6 +1529,9 @@ export interface DescribeInsightRulesOutput { } export namespace DescribeInsightRulesOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeInsightRulesOutput): any => ({ ...obj, }); @@ -1424,6 +1553,9 @@ export interface DimensionFilter { } export namespace DimensionFilter { + /** + * @internal + */ export const filterSensitiveLog = (obj: DimensionFilter): any => ({ ...obj, }); @@ -1437,6 +1569,9 @@ export interface DisableAlarmActionsInput { } export namespace DisableAlarmActionsInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: DisableAlarmActionsInput): any => ({ ...obj, }); @@ -1450,6 +1585,9 @@ export interface DisableInsightRulesInput { } export namespace DisableInsightRulesInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: DisableInsightRulesInput): any => ({ ...obj, }); @@ -1463,6 +1601,9 @@ export interface DisableInsightRulesOutput { } export namespace DisableInsightRulesOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: DisableInsightRulesOutput): any => ({ ...obj, }); @@ -1476,6 +1617,9 @@ export interface EnableAlarmActionsInput { } export namespace EnableAlarmActionsInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: EnableAlarmActionsInput): any => ({ ...obj, }); @@ -1489,6 +1633,9 @@ export interface EnableInsightRulesInput { } export namespace EnableInsightRulesInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: EnableInsightRulesInput): any => ({ ...obj, }); @@ -1502,6 +1649,9 @@ export interface EnableInsightRulesOutput { } export namespace EnableInsightRulesOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: EnableInsightRulesOutput): any => ({ ...obj, }); @@ -1517,6 +1667,9 @@ export interface LimitExceededException extends __SmithyException, $MetadataBear } export namespace LimitExceededException { + /** + * @internal + */ export const filterSensitiveLog = (obj: LimitExceededException): any => ({ ...obj, }); @@ -1530,6 +1683,9 @@ export interface GetDashboardInput { } export namespace GetDashboardInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetDashboardInput): any => ({ ...obj, }); @@ -1555,6 +1711,9 @@ export interface GetDashboardOutput { } export namespace GetDashboardOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetDashboardOutput): any => ({ ...obj, }); @@ -1637,6 +1796,9 @@ export interface GetInsightRuleReportInput { } export namespace GetInsightRuleReportInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetInsightRuleReportInput): any => ({ ...obj, }); @@ -1660,6 +1822,9 @@ export interface InsightRuleContributorDatapoint { } export namespace InsightRuleContributorDatapoint { + /** + * @internal + */ export const filterSensitiveLog = (obj: InsightRuleContributorDatapoint): any => ({ ...obj, }); @@ -1689,6 +1854,9 @@ export interface InsightRuleContributor { } export namespace InsightRuleContributor { + /** + * @internal + */ export const filterSensitiveLog = (obj: InsightRuleContributor): any => ({ ...obj, }); @@ -1750,6 +1918,9 @@ export interface InsightRuleMetricDatapoint { } export namespace InsightRuleMetricDatapoint { + /** + * @internal + */ export const filterSensitiveLog = (obj: InsightRuleMetricDatapoint): any => ({ ...obj, }); @@ -1790,6 +1961,9 @@ export interface GetInsightRuleReportOutput { } export namespace GetInsightRuleReportOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetInsightRuleReportOutput): any => ({ ...obj, }); @@ -1816,6 +1990,9 @@ export interface LabelOptions { } export namespace LabelOptions { + /** + * @internal + */ export const filterSensitiveLog = (obj: LabelOptions): any => ({ ...obj, }); @@ -1902,6 +2079,9 @@ export interface GetMetricDataInput { } export namespace GetMetricDataInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetMetricDataInput): any => ({ ...obj, }); @@ -1923,6 +2103,9 @@ export interface MessageData { } export namespace MessageData { + /** + * @internal + */ export const filterSensitiveLog = (obj: MessageData): any => ({ ...obj, }); @@ -1980,6 +2163,9 @@ export interface MetricDataResult { } export namespace MetricDataResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: MetricDataResult): any => ({ ...obj, }); @@ -2008,6 +2194,9 @@ export interface GetMetricDataOutput { } export namespace GetMetricDataOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetMetricDataOutput): any => ({ ...obj, }); @@ -2116,6 +2305,9 @@ export interface GetMetricStatisticsInput { } export namespace GetMetricStatisticsInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetMetricStatisticsInput): any => ({ ...obj, }); @@ -2134,6 +2326,9 @@ export interface GetMetricStatisticsOutput { } export namespace GetMetricStatisticsOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetMetricStatisticsOutput): any => ({ ...obj, }); @@ -2152,6 +2347,9 @@ export interface InvalidParameterCombinationException extends __SmithyException, } export namespace InvalidParameterCombinationException { + /** + * @internal + */ export const filterSensitiveLog = (obj: InvalidParameterCombinationException): any => ({ ...obj, }); @@ -2165,6 +2363,9 @@ export interface GetMetricStreamInput { } export namespace GetMetricStreamInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetMetricStreamInput): any => ({ ...obj, }); @@ -2182,6 +2383,9 @@ export interface MetricStreamFilter { } export namespace MetricStreamFilter { + /** + * @internal + */ export const filterSensitiveLog = (obj: MetricStreamFilter): any => ({ ...obj, }); @@ -2251,6 +2455,9 @@ export interface GetMetricStreamOutput { } export namespace GetMetricStreamOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetMetricStreamOutput): any => ({ ...obj, }); @@ -2317,6 +2524,9 @@ export interface GetMetricWidgetImageInput { } export namespace GetMetricWidgetImageInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetMetricWidgetImageInput): any => ({ ...obj, }); @@ -2330,6 +2540,9 @@ export interface GetMetricWidgetImageOutput { } export namespace GetMetricWidgetImageOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetMetricWidgetImageOutput): any => ({ ...obj, }); @@ -2352,6 +2565,9 @@ export interface ListDashboardsInput { } export namespace ListDashboardsInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListDashboardsInput): any => ({ ...obj, }); @@ -2370,6 +2586,9 @@ export interface ListDashboardsOutput { } export namespace ListDashboardsOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListDashboardsOutput): any => ({ ...obj, }); @@ -2417,6 +2636,9 @@ export interface ListMetricsInput { } export namespace ListMetricsInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListMetricsInput): any => ({ ...obj, }); @@ -2435,6 +2657,9 @@ export interface ListMetricsOutput { } export namespace ListMetricsOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListMetricsOutput): any => ({ ...obj, }); @@ -2453,6 +2678,9 @@ export interface ListMetricStreamsInput { } export namespace ListMetricStreamsInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListMetricStreamsInput): any => ({ ...obj, }); @@ -2501,6 +2729,9 @@ export interface MetricStreamEntry { } export namespace MetricStreamEntry { + /** + * @internal + */ export const filterSensitiveLog = (obj: MetricStreamEntry): any => ({ ...obj, }); @@ -2520,6 +2751,9 @@ export interface ListMetricStreamsOutput { } export namespace ListMetricStreamsOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListMetricStreamsOutput): any => ({ ...obj, }); @@ -2544,6 +2778,9 @@ export interface ListTagsForResourceInput { } export namespace ListTagsForResourceInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListTagsForResourceInput): any => ({ ...obj, }); @@ -2566,6 +2803,9 @@ export interface Tag { } export namespace Tag { + /** + * @internal + */ export const filterSensitiveLog = (obj: Tag): any => ({ ...obj, }); @@ -2579,6 +2819,9 @@ export interface ListTagsForResourceOutput { } export namespace ListTagsForResourceOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListTagsForResourceOutput): any => ({ ...obj, }); @@ -2617,6 +2860,9 @@ export interface PutAnomalyDetectorInput { } export namespace PutAnomalyDetectorInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: PutAnomalyDetectorInput): any => ({ ...obj, }); @@ -2625,6 +2871,9 @@ export namespace PutAnomalyDetectorInput { export interface PutAnomalyDetectorOutput {} export namespace PutAnomalyDetectorOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: PutAnomalyDetectorOutput): any => ({ ...obj, }); @@ -2643,6 +2892,9 @@ export interface LimitExceededFault extends __SmithyException, $MetadataBearer { } export namespace LimitExceededFault { + /** + * @internal + */ export const filterSensitiveLog = (obj: LimitExceededFault): any => ({ ...obj, }); @@ -2775,6 +3027,9 @@ export interface PutCompositeAlarmInput { } export namespace PutCompositeAlarmInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: PutCompositeAlarmInput): any => ({ ...obj, }); @@ -2798,6 +3053,9 @@ export interface PutDashboardInput { } export namespace PutDashboardInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: PutDashboardInput): any => ({ ...obj, }); @@ -2815,6 +3073,9 @@ export interface PutDashboardOutput { } export namespace PutDashboardOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: PutDashboardOutput): any => ({ ...obj, }); @@ -2855,6 +3116,9 @@ export interface PutInsightRuleInput { } export namespace PutInsightRuleInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: PutInsightRuleInput): any => ({ ...obj, }); @@ -2863,6 +3127,9 @@ export namespace PutInsightRuleInput { export interface PutInsightRuleOutput {} export namespace PutInsightRuleOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: PutInsightRuleOutput): any => ({ ...obj, }); @@ -3119,6 +3386,9 @@ export interface PutMetricAlarmInput { } export namespace PutMetricAlarmInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: PutMetricAlarmInput): any => ({ ...obj, }); @@ -3150,6 +3420,9 @@ export interface StatisticSet { } export namespace StatisticSet { + /** + * @internal + */ export const filterSensitiveLog = (obj: StatisticSet): any => ({ ...obj, }); @@ -3228,6 +3501,9 @@ export interface MetricDatum { } export namespace MetricDatum { + /** + * @internal + */ export const filterSensitiveLog = (obj: MetricDatum): any => ({ ...obj, }); @@ -3249,6 +3525,9 @@ export interface PutMetricDataInput { } export namespace PutMetricDataInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: PutMetricDataInput): any => ({ ...obj, }); @@ -3321,6 +3600,9 @@ export interface PutMetricStreamInput { } export namespace PutMetricStreamInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: PutMetricStreamInput): any => ({ ...obj, }); @@ -3334,6 +3616,9 @@ export interface PutMetricStreamOutput { } export namespace PutMetricStreamOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: PutMetricStreamOutput): any => ({ ...obj, }); @@ -3352,6 +3637,9 @@ export interface InvalidFormatFault extends __SmithyException, $MetadataBearer { } export namespace InvalidFormatFault { + /** + * @internal + */ export const filterSensitiveLog = (obj: InvalidFormatFault): any => ({ ...obj, }); @@ -3382,6 +3670,9 @@ export interface SetAlarmStateInput { } export namespace SetAlarmStateInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: SetAlarmStateInput): any => ({ ...obj, }); @@ -3398,6 +3689,9 @@ export interface StartMetricStreamsInput { } export namespace StartMetricStreamsInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: StartMetricStreamsInput): any => ({ ...obj, }); @@ -3406,6 +3700,9 @@ export namespace StartMetricStreamsInput { export interface StartMetricStreamsOutput {} export namespace StartMetricStreamsOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: StartMetricStreamsOutput): any => ({ ...obj, }); @@ -3422,6 +3719,9 @@ export interface StopMetricStreamsInput { } export namespace StopMetricStreamsInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: StopMetricStreamsInput): any => ({ ...obj, }); @@ -3430,6 +3730,9 @@ export namespace StopMetricStreamsInput { export interface StopMetricStreamsOutput {} export namespace StopMetricStreamsOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: StopMetricStreamsOutput): any => ({ ...obj, }); @@ -3459,6 +3762,9 @@ export interface TagResourceInput { } export namespace TagResourceInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: TagResourceInput): any => ({ ...obj, }); @@ -3467,6 +3773,9 @@ export namespace TagResourceInput { export interface TagResourceOutput {} export namespace TagResourceOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: TagResourceOutput): any => ({ ...obj, }); @@ -3496,6 +3805,9 @@ export interface UntagResourceInput { } export namespace UntagResourceInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: UntagResourceInput): any => ({ ...obj, }); @@ -3504,6 +3816,9 @@ export namespace UntagResourceInput { export interface UntagResourceOutput {} export namespace UntagResourceOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: UntagResourceOutput): any => ({ ...obj, }); diff --git a/clients/client-codeartifact/commands/AssociateExternalConnectionCommand.ts b/clients/client-codeartifact/commands/AssociateExternalConnectionCommand.ts index 25755a07521e..e00ae7a27441 100644 --- a/clients/client-codeartifact/commands/AssociateExternalConnectionCommand.ts +++ b/clients/client-codeartifact/commands/AssociateExternalConnectionCommand.ts @@ -26,6 +26,20 @@ export interface AssociateExternalConnectionCommandOutput extends AssociateExter * *

A repository can have one or more upstream repositories, or an external connection.

* + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { CodeartifactClient, AssociateExternalConnectionCommand } from "@aws-sdk/client-codeartifact"; // ES Modules import + * // const { CodeartifactClient, AssociateExternalConnectionCommand } = require("@aws-sdk/client-codeartifact"); // CommonJS import + * const client = new CodeartifactClient(config); + * const command = new AssociateExternalConnectionCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link AssociateExternalConnectionCommandInput} for command's `input` shape. + * @see {@link AssociateExternalConnectionCommandOutput} for command's `response` shape. + * @see {@link CodeartifactClientResolvedConfig | config} for command's `input` shape. + * */ export class AssociateExternalConnectionCommand extends $Command< AssociateExternalConnectionCommandInput, diff --git a/clients/client-codeartifact/commands/CopyPackageVersionsCommand.ts b/clients/client-codeartifact/commands/CopyPackageVersionsCommand.ts index bf7eb85f9d6c..79dcc9e50223 100644 --- a/clients/client-codeartifact/commands/CopyPackageVersionsCommand.ts +++ b/clients/client-codeartifact/commands/CopyPackageVersionsCommand.ts @@ -29,6 +29,20 @@ export interface CopyPackageVersionsCommandOutput extends CopyPackageVersionsRes * You must specify versions or versionRevisions. You cannot specify both. *

* + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { CodeartifactClient, CopyPackageVersionsCommand } from "@aws-sdk/client-codeartifact"; // ES Modules import + * // const { CodeartifactClient, CopyPackageVersionsCommand } = require("@aws-sdk/client-codeartifact"); // CommonJS import + * const client = new CodeartifactClient(config); + * const command = new CopyPackageVersionsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CopyPackageVersionsCommandInput} for command's `input` shape. + * @see {@link CopyPackageVersionsCommandOutput} for command's `response` shape. + * @see {@link CodeartifactClientResolvedConfig | config} for command's `input` shape. + * */ export class CopyPackageVersionsCommand extends $Command< CopyPackageVersionsCommandInput, diff --git a/clients/client-codeartifact/commands/CreateDomainCommand.ts b/clients/client-codeartifact/commands/CreateDomainCommand.ts index 57bcd9514d90..6ddc3fc2480e 100644 --- a/clients/client-codeartifact/commands/CreateDomainCommand.ts +++ b/clients/client-codeartifact/commands/CreateDomainCommand.ts @@ -32,6 +32,20 @@ export interface CreateDomainCommandOutput extends CreateDomainResult, __Metadat * 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. *

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { CodeartifactClient, CreateDomainCommand } from "@aws-sdk/client-codeartifact"; // ES Modules import + * // const { CodeartifactClient, CreateDomainCommand } = require("@aws-sdk/client-codeartifact"); // CommonJS import + * const client = new CodeartifactClient(config); + * const command = new CreateDomainCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreateDomainCommandInput} for command's `input` shape. + * @see {@link CreateDomainCommandOutput} for command's `response` shape. + * @see {@link CodeartifactClientResolvedConfig | config} for command's `input` shape. + * */ export class CreateDomainCommand extends $Command< CreateDomainCommandInput, diff --git a/clients/client-codeartifact/commands/CreateRepositoryCommand.ts b/clients/client-codeartifact/commands/CreateRepositoryCommand.ts index 2af3aadcc552..bcd796a31ba8 100644 --- a/clients/client-codeartifact/commands/CreateRepositoryCommand.ts +++ b/clients/client-codeartifact/commands/CreateRepositoryCommand.ts @@ -24,6 +24,20 @@ export interface CreateRepositoryCommandOutput extends CreateRepositoryResult, _ *

* Creates a repository. *

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { CodeartifactClient, CreateRepositoryCommand } from "@aws-sdk/client-codeartifact"; // ES Modules import + * // const { CodeartifactClient, CreateRepositoryCommand } = require("@aws-sdk/client-codeartifact"); // CommonJS import + * const client = new CodeartifactClient(config); + * const command = new CreateRepositoryCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreateRepositoryCommandInput} for command's `input` shape. + * @see {@link CreateRepositoryCommandOutput} for command's `response` shape. + * @see {@link CodeartifactClientResolvedConfig | config} for command's `input` shape. + * */ export class CreateRepositoryCommand extends $Command< CreateRepositoryCommandInput, diff --git a/clients/client-codeartifact/commands/DeleteDomainCommand.ts b/clients/client-codeartifact/commands/DeleteDomainCommand.ts index 46d1e3334632..43d5cfd028f9 100644 --- a/clients/client-codeartifact/commands/DeleteDomainCommand.ts +++ b/clients/client-codeartifact/commands/DeleteDomainCommand.ts @@ -25,6 +25,20 @@ export interface DeleteDomainCommandOutput extends DeleteDomainResult, __Metadat * Deletes a domain. You cannot delete a domain that contains repositories. If you want to delete a domain * with repositories, first delete its repositories. *

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { CodeartifactClient, DeleteDomainCommand } from "@aws-sdk/client-codeartifact"; // ES Modules import + * // const { CodeartifactClient, DeleteDomainCommand } = require("@aws-sdk/client-codeartifact"); // CommonJS import + * const client = new CodeartifactClient(config); + * const command = new DeleteDomainCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteDomainCommandInput} for command's `input` shape. + * @see {@link DeleteDomainCommandOutput} for command's `response` shape. + * @see {@link CodeartifactClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteDomainCommand extends $Command< DeleteDomainCommandInput, diff --git a/clients/client-codeartifact/commands/DeleteDomainPermissionsPolicyCommand.ts b/clients/client-codeartifact/commands/DeleteDomainPermissionsPolicyCommand.ts index feef53245ff9..e26237c99403 100644 --- a/clients/client-codeartifact/commands/DeleteDomainPermissionsPolicyCommand.ts +++ b/clients/client-codeartifact/commands/DeleteDomainPermissionsPolicyCommand.ts @@ -26,6 +26,20 @@ export interface DeleteDomainPermissionsPolicyCommandOutput *

* Deletes the resource policy set on a domain. *

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { CodeartifactClient, DeleteDomainPermissionsPolicyCommand } from "@aws-sdk/client-codeartifact"; // ES Modules import + * // const { CodeartifactClient, DeleteDomainPermissionsPolicyCommand } = require("@aws-sdk/client-codeartifact"); // CommonJS import + * const client = new CodeartifactClient(config); + * const command = new DeleteDomainPermissionsPolicyCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteDomainPermissionsPolicyCommandInput} for command's `input` shape. + * @see {@link DeleteDomainPermissionsPolicyCommandOutput} for command's `response` shape. + * @see {@link CodeartifactClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteDomainPermissionsPolicyCommand extends $Command< DeleteDomainPermissionsPolicyCommandInput, diff --git a/clients/client-codeartifact/commands/DeletePackageVersionsCommand.ts b/clients/client-codeartifact/commands/DeletePackageVersionsCommand.ts index cc28ddef3dc2..34731f7b8648 100644 --- a/clients/client-codeartifact/commands/DeletePackageVersionsCommand.ts +++ b/clients/client-codeartifact/commands/DeletePackageVersionsCommand.ts @@ -26,6 +26,20 @@ export interface DeletePackageVersionsCommandOutput extends DeletePackageVersion * 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, * ListackageVersions), but you can restore them using UpdatePackageVersionsStatus.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { CodeartifactClient, DeletePackageVersionsCommand } from "@aws-sdk/client-codeartifact"; // ES Modules import + * // const { CodeartifactClient, DeletePackageVersionsCommand } = require("@aws-sdk/client-codeartifact"); // CommonJS import + * const client = new CodeartifactClient(config); + * const command = new DeletePackageVersionsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeletePackageVersionsCommandInput} for command's `input` shape. + * @see {@link DeletePackageVersionsCommandOutput} for command's `response` shape. + * @see {@link CodeartifactClientResolvedConfig | config} for command's `input` shape. + * */ export class DeletePackageVersionsCommand extends $Command< DeletePackageVersionsCommandInput, diff --git a/clients/client-codeartifact/commands/DeleteRepositoryCommand.ts b/clients/client-codeartifact/commands/DeleteRepositoryCommand.ts index f889b2369c4e..e68e3296ba69 100644 --- a/clients/client-codeartifact/commands/DeleteRepositoryCommand.ts +++ b/clients/client-codeartifact/commands/DeleteRepositoryCommand.ts @@ -24,6 +24,20 @@ export interface DeleteRepositoryCommandOutput extends DeleteRepositoryResult, _ *

* Deletes a repository. *

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { CodeartifactClient, DeleteRepositoryCommand } from "@aws-sdk/client-codeartifact"; // ES Modules import + * // const { CodeartifactClient, DeleteRepositoryCommand } = require("@aws-sdk/client-codeartifact"); // CommonJS import + * const client = new CodeartifactClient(config); + * const command = new DeleteRepositoryCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteRepositoryCommandInput} for command's `input` shape. + * @see {@link DeleteRepositoryCommandOutput} for command's `response` shape. + * @see {@link CodeartifactClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteRepositoryCommand extends $Command< DeleteRepositoryCommandInput, diff --git a/clients/client-codeartifact/commands/DeleteRepositoryPermissionsPolicyCommand.ts b/clients/client-codeartifact/commands/DeleteRepositoryPermissionsPolicyCommand.ts index 6a7a5f109647..50712a5c43a6 100644 --- a/clients/client-codeartifact/commands/DeleteRepositoryPermissionsPolicyCommand.ts +++ b/clients/client-codeartifact/commands/DeleteRepositoryPermissionsPolicyCommand.ts @@ -33,6 +33,20 @@ export interface DeleteRepositoryPermissionsPolicyCommandOutput * the repository actions granted by the deleted policy. *

* + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { CodeartifactClient, DeleteRepositoryPermissionsPolicyCommand } from "@aws-sdk/client-codeartifact"; // ES Modules import + * // const { CodeartifactClient, DeleteRepositoryPermissionsPolicyCommand } = require("@aws-sdk/client-codeartifact"); // CommonJS import + * const client = new CodeartifactClient(config); + * const command = new DeleteRepositoryPermissionsPolicyCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteRepositoryPermissionsPolicyCommandInput} for command's `input` shape. + * @see {@link DeleteRepositoryPermissionsPolicyCommandOutput} for command's `response` shape. + * @see {@link CodeartifactClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteRepositoryPermissionsPolicyCommand extends $Command< DeleteRepositoryPermissionsPolicyCommandInput, diff --git a/clients/client-codeartifact/commands/DescribeDomainCommand.ts b/clients/client-codeartifact/commands/DescribeDomainCommand.ts index 00dc472b3ec0..e30ce9892040 100644 --- a/clients/client-codeartifact/commands/DescribeDomainCommand.ts +++ b/clients/client-codeartifact/commands/DescribeDomainCommand.ts @@ -28,6 +28,20 @@ export interface DescribeDomainCommandOutput extends DescribeDomainResult, __Met * * object that contains information about the requested domain. *

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { CodeartifactClient, DescribeDomainCommand } from "@aws-sdk/client-codeartifact"; // ES Modules import + * // const { CodeartifactClient, DescribeDomainCommand } = require("@aws-sdk/client-codeartifact"); // CommonJS import + * const client = new CodeartifactClient(config); + * const command = new DescribeDomainCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeDomainCommandInput} for command's `input` shape. + * @see {@link DescribeDomainCommandOutput} for command's `response` shape. + * @see {@link CodeartifactClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeDomainCommand extends $Command< DescribeDomainCommandInput, diff --git a/clients/client-codeartifact/commands/DescribePackageVersionCommand.ts b/clients/client-codeartifact/commands/DescribePackageVersionCommand.ts index 2e888a7ad980..b266d4946d51 100644 --- a/clients/client-codeartifact/commands/DescribePackageVersionCommand.ts +++ b/clients/client-codeartifact/commands/DescribePackageVersionCommand.ts @@ -28,6 +28,20 @@ export interface DescribePackageVersionCommandOutput extends DescribePackageVers * * object that contains information about the requested package version. *

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { CodeartifactClient, DescribePackageVersionCommand } from "@aws-sdk/client-codeartifact"; // ES Modules import + * // const { CodeartifactClient, DescribePackageVersionCommand } = require("@aws-sdk/client-codeartifact"); // CommonJS import + * const client = new CodeartifactClient(config); + * const command = new DescribePackageVersionCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribePackageVersionCommandInput} for command's `input` shape. + * @see {@link DescribePackageVersionCommandOutput} for command's `response` shape. + * @see {@link CodeartifactClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribePackageVersionCommand extends $Command< DescribePackageVersionCommandInput, diff --git a/clients/client-codeartifact/commands/DescribeRepositoryCommand.ts b/clients/client-codeartifact/commands/DescribeRepositoryCommand.ts index 19bdfc15d2ae..f2cdfcdb5a47 100644 --- a/clients/client-codeartifact/commands/DescribeRepositoryCommand.ts +++ b/clients/client-codeartifact/commands/DescribeRepositoryCommand.ts @@ -25,6 +25,20 @@ export interface DescribeRepositoryCommandOutput extends DescribeRepositoryResul * Returns a RepositoryDescription object that contains detailed information * about the requested repository. *

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { CodeartifactClient, DescribeRepositoryCommand } from "@aws-sdk/client-codeartifact"; // ES Modules import + * // const { CodeartifactClient, DescribeRepositoryCommand } = require("@aws-sdk/client-codeartifact"); // CommonJS import + * const client = new CodeartifactClient(config); + * const command = new DescribeRepositoryCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeRepositoryCommandInput} for command's `input` shape. + * @see {@link DescribeRepositoryCommandOutput} for command's `response` shape. + * @see {@link CodeartifactClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeRepositoryCommand extends $Command< DescribeRepositoryCommandInput, diff --git a/clients/client-codeartifact/commands/DisassociateExternalConnectionCommand.ts b/clients/client-codeartifact/commands/DisassociateExternalConnectionCommand.ts index a751bd3a2dad..91c1be11afa0 100644 --- a/clients/client-codeartifact/commands/DisassociateExternalConnectionCommand.ts +++ b/clients/client-codeartifact/commands/DisassociateExternalConnectionCommand.ts @@ -26,6 +26,20 @@ export interface DisassociateExternalConnectionCommandOutput *

* Removes an existing external connection from a repository. *

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { CodeartifactClient, DisassociateExternalConnectionCommand } from "@aws-sdk/client-codeartifact"; // ES Modules import + * // const { CodeartifactClient, DisassociateExternalConnectionCommand } = require("@aws-sdk/client-codeartifact"); // CommonJS import + * const client = new CodeartifactClient(config); + * const command = new DisassociateExternalConnectionCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DisassociateExternalConnectionCommandInput} for command's `input` shape. + * @see {@link DisassociateExternalConnectionCommandOutput} for command's `response` shape. + * @see {@link CodeartifactClientResolvedConfig | config} for command's `input` shape. + * */ export class DisassociateExternalConnectionCommand extends $Command< DisassociateExternalConnectionCommandInput, diff --git a/clients/client-codeartifact/commands/DisposePackageVersionsCommand.ts b/clients/client-codeartifact/commands/DisposePackageVersionsCommand.ts index 445b5a7c8b06..4aa3e2a2ab0c 100644 --- a/clients/client-codeartifact/commands/DisposePackageVersionsCommand.ts +++ b/clients/client-codeartifact/commands/DisposePackageVersionsCommand.ts @@ -41,6 +41,20 @@ export interface DisposePackageVersionsCommandOutput extends DisposePackageVersi * DescribePackageVersion * .. *

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { CodeartifactClient, DisposePackageVersionsCommand } from "@aws-sdk/client-codeartifact"; // ES Modules import + * // const { CodeartifactClient, DisposePackageVersionsCommand } = require("@aws-sdk/client-codeartifact"); // CommonJS import + * const client = new CodeartifactClient(config); + * const command = new DisposePackageVersionsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DisposePackageVersionsCommandInput} for command's `input` shape. + * @see {@link DisposePackageVersionsCommandOutput} for command's `response` shape. + * @see {@link CodeartifactClientResolvedConfig | config} for command's `input` shape. + * */ export class DisposePackageVersionsCommand extends $Command< DisposePackageVersionsCommandInput, diff --git a/clients/client-codeartifact/commands/GetAuthorizationTokenCommand.ts b/clients/client-codeartifact/commands/GetAuthorizationTokenCommand.ts index 33bf9d08dae1..229b9790a283 100644 --- a/clients/client-codeartifact/commands/GetAuthorizationTokenCommand.ts +++ b/clients/client-codeartifact/commands/GetAuthorizationTokenCommand.ts @@ -42,6 +42,20 @@ export interface GetAuthorizationTokenCommandOutput extends GetAuthorizationToke * Using IAM Roles * for more information on controlling session duration.

* + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { CodeartifactClient, GetAuthorizationTokenCommand } from "@aws-sdk/client-codeartifact"; // ES Modules import + * // const { CodeartifactClient, GetAuthorizationTokenCommand } = require("@aws-sdk/client-codeartifact"); // CommonJS import + * const client = new CodeartifactClient(config); + * const command = new GetAuthorizationTokenCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetAuthorizationTokenCommandInput} for command's `input` shape. + * @see {@link GetAuthorizationTokenCommandOutput} for command's `response` shape. + * @see {@link CodeartifactClientResolvedConfig | config} for command's `input` shape. + * */ export class GetAuthorizationTokenCommand extends $Command< GetAuthorizationTokenCommandInput, diff --git a/clients/client-codeartifact/commands/GetDomainPermissionsPolicyCommand.ts b/clients/client-codeartifact/commands/GetDomainPermissionsPolicyCommand.ts index ee19d7d3ec14..c78e57f1aa8b 100644 --- a/clients/client-codeartifact/commands/GetDomainPermissionsPolicyCommand.ts +++ b/clients/client-codeartifact/commands/GetDomainPermissionsPolicyCommand.ts @@ -31,6 +31,20 @@ export interface GetDomainPermissionsPolicyCommandOutput extends GetDomainPermis * and resource-based policies in the AWS Identity and Access Management User Guide. *

* + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { CodeartifactClient, GetDomainPermissionsPolicyCommand } from "@aws-sdk/client-codeartifact"; // ES Modules import + * // const { CodeartifactClient, GetDomainPermissionsPolicyCommand } = require("@aws-sdk/client-codeartifact"); // CommonJS import + * const client = new CodeartifactClient(config); + * const command = new GetDomainPermissionsPolicyCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetDomainPermissionsPolicyCommandInput} for command's `input` shape. + * @see {@link GetDomainPermissionsPolicyCommandOutput} for command's `response` shape. + * @see {@link CodeartifactClientResolvedConfig | config} for command's `input` shape. + * */ export class GetDomainPermissionsPolicyCommand extends $Command< GetDomainPermissionsPolicyCommandInput, diff --git a/clients/client-codeartifact/commands/GetPackageVersionAssetCommand.ts b/clients/client-codeartifact/commands/GetPackageVersionAssetCommand.ts index 2d3c15502d7e..068b95b57253 100644 --- a/clients/client-codeartifact/commands/GetPackageVersionAssetCommand.ts +++ b/clients/client-codeartifact/commands/GetPackageVersionAssetCommand.ts @@ -26,6 +26,20 @@ export interface GetPackageVersionAssetCommandOutput extends GetPackageVersionAs * GetPackageVersionAsset to download a JAR file, a POM file, * or any other assets in the package version. *

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { CodeartifactClient, GetPackageVersionAssetCommand } from "@aws-sdk/client-codeartifact"; // ES Modules import + * // const { CodeartifactClient, GetPackageVersionAssetCommand } = require("@aws-sdk/client-codeartifact"); // CommonJS import + * const client = new CodeartifactClient(config); + * const command = new GetPackageVersionAssetCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetPackageVersionAssetCommandInput} for command's `input` shape. + * @see {@link GetPackageVersionAssetCommandOutput} for command's `response` shape. + * @see {@link CodeartifactClientResolvedConfig | config} for command's `input` shape. + * */ export class GetPackageVersionAssetCommand extends $Command< GetPackageVersionAssetCommandInput, diff --git a/clients/client-codeartifact/commands/GetPackageVersionReadmeCommand.ts b/clients/client-codeartifact/commands/GetPackageVersionReadmeCommand.ts index 109133490dfc..e3f97544898f 100644 --- a/clients/client-codeartifact/commands/GetPackageVersionReadmeCommand.ts +++ b/clients/client-codeartifact/commands/GetPackageVersionReadmeCommand.ts @@ -29,6 +29,20 @@ export interface GetPackageVersionReadmeCommandOutput extends GetPackageVersionR *

* The returned text might contain formatting. For example, it might contain formatting for Markdown or reStructuredText. *

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { CodeartifactClient, GetPackageVersionReadmeCommand } from "@aws-sdk/client-codeartifact"; // ES Modules import + * // const { CodeartifactClient, GetPackageVersionReadmeCommand } = require("@aws-sdk/client-codeartifact"); // CommonJS import + * const client = new CodeartifactClient(config); + * const command = new GetPackageVersionReadmeCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetPackageVersionReadmeCommandInput} for command's `input` shape. + * @see {@link GetPackageVersionReadmeCommandOutput} for command's `response` shape. + * @see {@link CodeartifactClientResolvedConfig | config} for command's `input` shape. + * */ export class GetPackageVersionReadmeCommand extends $Command< GetPackageVersionReadmeCommandInput, diff --git a/clients/client-codeartifact/commands/GetRepositoryEndpointCommand.ts b/clients/client-codeartifact/commands/GetRepositoryEndpointCommand.ts index 77fa94c2e3e7..9b4dc7feec04 100644 --- a/clients/client-codeartifact/commands/GetRepositoryEndpointCommand.ts +++ b/clients/client-codeartifact/commands/GetRepositoryEndpointCommand.ts @@ -42,6 +42,20 @@ export interface GetRepositoryEndpointCommandOutput extends GetRepositoryEndpoin *

* * + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { CodeartifactClient, GetRepositoryEndpointCommand } from "@aws-sdk/client-codeartifact"; // ES Modules import + * // const { CodeartifactClient, GetRepositoryEndpointCommand } = require("@aws-sdk/client-codeartifact"); // CommonJS import + * const client = new CodeartifactClient(config); + * const command = new GetRepositoryEndpointCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetRepositoryEndpointCommandInput} for command's `input` shape. + * @see {@link GetRepositoryEndpointCommandOutput} for command's `response` shape. + * @see {@link CodeartifactClientResolvedConfig | config} for command's `input` shape. + * */ export class GetRepositoryEndpointCommand extends $Command< GetRepositoryEndpointCommandInput, diff --git a/clients/client-codeartifact/commands/GetRepositoryPermissionsPolicyCommand.ts b/clients/client-codeartifact/commands/GetRepositoryPermissionsPolicyCommand.ts index 0dc5de877ce3..3abd13270567 100644 --- a/clients/client-codeartifact/commands/GetRepositoryPermissionsPolicyCommand.ts +++ b/clients/client-codeartifact/commands/GetRepositoryPermissionsPolicyCommand.ts @@ -26,6 +26,20 @@ export interface GetRepositoryPermissionsPolicyCommandOutput *

* Returns the resource policy that is set on a repository. *

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { CodeartifactClient, GetRepositoryPermissionsPolicyCommand } from "@aws-sdk/client-codeartifact"; // ES Modules import + * // const { CodeartifactClient, GetRepositoryPermissionsPolicyCommand } = require("@aws-sdk/client-codeartifact"); // CommonJS import + * const client = new CodeartifactClient(config); + * const command = new GetRepositoryPermissionsPolicyCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetRepositoryPermissionsPolicyCommandInput} for command's `input` shape. + * @see {@link GetRepositoryPermissionsPolicyCommandOutput} for command's `response` shape. + * @see {@link CodeartifactClientResolvedConfig | config} for command's `input` shape. + * */ export class GetRepositoryPermissionsPolicyCommand extends $Command< GetRepositoryPermissionsPolicyCommandInput, diff --git a/clients/client-codeartifact/commands/ListDomainsCommand.ts b/clients/client-codeartifact/commands/ListDomainsCommand.ts index b921825bbef4..c8918233830a 100644 --- a/clients/client-codeartifact/commands/ListDomainsCommand.ts +++ b/clients/client-codeartifact/commands/ListDomainsCommand.ts @@ -24,6 +24,20 @@ export interface ListDomainsCommandOutput extends ListDomainsResult, __MetadataB *

Returns a list of DomainSummary objects for all domains owned by the AWS account that makes * this call. Each returned DomainSummary object contains information about a * domain.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { CodeartifactClient, ListDomainsCommand } from "@aws-sdk/client-codeartifact"; // ES Modules import + * // const { CodeartifactClient, ListDomainsCommand } = require("@aws-sdk/client-codeartifact"); // CommonJS import + * const client = new CodeartifactClient(config); + * const command = new ListDomainsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListDomainsCommandInput} for command's `input` shape. + * @see {@link ListDomainsCommandOutput} for command's `response` shape. + * @see {@link CodeartifactClientResolvedConfig | config} for command's `input` shape. + * */ export class ListDomainsCommand extends $Command< ListDomainsCommandInput, diff --git a/clients/client-codeartifact/commands/ListPackageVersionAssetsCommand.ts b/clients/client-codeartifact/commands/ListPackageVersionAssetsCommand.ts index 787d6355e6f2..9a4d4f3b5433 100644 --- a/clients/client-codeartifact/commands/ListPackageVersionAssetsCommand.ts +++ b/clients/client-codeartifact/commands/ListPackageVersionAssetsCommand.ts @@ -28,6 +28,20 @@ export interface ListPackageVersionAssetsCommandOutput extends ListPackageVersio * * objects for assets in a package version. *

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { CodeartifactClient, ListPackageVersionAssetsCommand } from "@aws-sdk/client-codeartifact"; // ES Modules import + * // const { CodeartifactClient, ListPackageVersionAssetsCommand } = require("@aws-sdk/client-codeartifact"); // CommonJS import + * const client = new CodeartifactClient(config); + * const command = new ListPackageVersionAssetsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListPackageVersionAssetsCommandInput} for command's `input` shape. + * @see {@link ListPackageVersionAssetsCommandOutput} for command's `response` shape. + * @see {@link CodeartifactClientResolvedConfig | config} for command's `input` shape. + * */ export class ListPackageVersionAssetsCommand extends $Command< ListPackageVersionAssetsCommandInput, diff --git a/clients/client-codeartifact/commands/ListPackageVersionDependenciesCommand.ts b/clients/client-codeartifact/commands/ListPackageVersionDependenciesCommand.ts index 8bb39b517a26..f902e12c0c4c 100644 --- a/clients/client-codeartifact/commands/ListPackageVersionDependenciesCommand.ts +++ b/clients/client-codeartifact/commands/ListPackageVersionDependenciesCommand.ts @@ -32,6 +32,20 @@ export interface ListPackageVersionDependenciesCommandOutput * 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. *

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { CodeartifactClient, ListPackageVersionDependenciesCommand } from "@aws-sdk/client-codeartifact"; // ES Modules import + * // const { CodeartifactClient, ListPackageVersionDependenciesCommand } = require("@aws-sdk/client-codeartifact"); // CommonJS import + * const client = new CodeartifactClient(config); + * const command = new ListPackageVersionDependenciesCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListPackageVersionDependenciesCommandInput} for command's `input` shape. + * @see {@link ListPackageVersionDependenciesCommandOutput} for command's `response` shape. + * @see {@link CodeartifactClientResolvedConfig | config} for command's `input` shape. + * */ export class ListPackageVersionDependenciesCommand extends $Command< ListPackageVersionDependenciesCommandInput, diff --git a/clients/client-codeartifact/commands/ListPackageVersionsCommand.ts b/clients/client-codeartifact/commands/ListPackageVersionsCommand.ts index e677f0474eaa..57919ed118a4 100644 --- a/clients/client-codeartifact/commands/ListPackageVersionsCommand.ts +++ b/clients/client-codeartifact/commands/ListPackageVersionsCommand.ts @@ -28,6 +28,20 @@ export interface ListPackageVersionsCommandOutput extends ListPackageVersionsRes * * objects for package versions in a repository that match the request parameters. *

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { CodeartifactClient, ListPackageVersionsCommand } from "@aws-sdk/client-codeartifact"; // ES Modules import + * // const { CodeartifactClient, ListPackageVersionsCommand } = require("@aws-sdk/client-codeartifact"); // CommonJS import + * const client = new CodeartifactClient(config); + * const command = new ListPackageVersionsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListPackageVersionsCommandInput} for command's `input` shape. + * @see {@link ListPackageVersionsCommandOutput} for command's `response` shape. + * @see {@link CodeartifactClientResolvedConfig | config} for command's `input` shape. + * */ export class ListPackageVersionsCommand extends $Command< ListPackageVersionsCommandInput, diff --git a/clients/client-codeartifact/commands/ListPackagesCommand.ts b/clients/client-codeartifact/commands/ListPackagesCommand.ts index 379674866b5f..24c5f66a74f5 100644 --- a/clients/client-codeartifact/commands/ListPackagesCommand.ts +++ b/clients/client-codeartifact/commands/ListPackagesCommand.ts @@ -28,6 +28,20 @@ export interface ListPackagesCommandOutput extends ListPackagesResult, __Metadat * * objects for packages in a repository that match the request parameters. *

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { CodeartifactClient, ListPackagesCommand } from "@aws-sdk/client-codeartifact"; // ES Modules import + * // const { CodeartifactClient, ListPackagesCommand } = require("@aws-sdk/client-codeartifact"); // CommonJS import + * const client = new CodeartifactClient(config); + * const command = new ListPackagesCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListPackagesCommandInput} for command's `input` shape. + * @see {@link ListPackagesCommandOutput} for command's `response` shape. + * @see {@link CodeartifactClientResolvedConfig | config} for command's `input` shape. + * */ export class ListPackagesCommand extends $Command< ListPackagesCommandInput, diff --git a/clients/client-codeartifact/commands/ListRepositoriesCommand.ts b/clients/client-codeartifact/commands/ListRepositoriesCommand.ts index 1add8a0706d3..c36cf6bdd71b 100644 --- a/clients/client-codeartifact/commands/ListRepositoriesCommand.ts +++ b/clients/client-codeartifact/commands/ListRepositoriesCommand.ts @@ -29,6 +29,20 @@ export interface ListRepositoriesCommandOutput extends ListRepositoriesResult, _ * objects. Each RepositorySummary contains information about a repository in the specified AWS account and that matches the input * parameters. *

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { CodeartifactClient, ListRepositoriesCommand } from "@aws-sdk/client-codeartifact"; // ES Modules import + * // const { CodeartifactClient, ListRepositoriesCommand } = require("@aws-sdk/client-codeartifact"); // CommonJS import + * const client = new CodeartifactClient(config); + * const command = new ListRepositoriesCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListRepositoriesCommandInput} for command's `input` shape. + * @see {@link ListRepositoriesCommandOutput} for command's `response` shape. + * @see {@link CodeartifactClientResolvedConfig | config} for command's `input` shape. + * */ export class ListRepositoriesCommand extends $Command< ListRepositoriesCommandInput, diff --git a/clients/client-codeartifact/commands/ListRepositoriesInDomainCommand.ts b/clients/client-codeartifact/commands/ListRepositoriesInDomainCommand.ts index f1fcc12bb14c..b368a2642af9 100644 --- a/clients/client-codeartifact/commands/ListRepositoriesInDomainCommand.ts +++ b/clients/client-codeartifact/commands/ListRepositoriesInDomainCommand.ts @@ -29,6 +29,20 @@ export interface ListRepositoriesInDomainCommandOutput extends ListRepositoriesI * objects. Each RepositorySummary contains information about a repository in the specified domain and that matches the input * parameters. *

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { CodeartifactClient, ListRepositoriesInDomainCommand } from "@aws-sdk/client-codeartifact"; // ES Modules import + * // const { CodeartifactClient, ListRepositoriesInDomainCommand } = require("@aws-sdk/client-codeartifact"); // CommonJS import + * const client = new CodeartifactClient(config); + * const command = new ListRepositoriesInDomainCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListRepositoriesInDomainCommandInput} for command's `input` shape. + * @see {@link ListRepositoriesInDomainCommandOutput} for command's `response` shape. + * @see {@link CodeartifactClientResolvedConfig | config} for command's `input` shape. + * */ export class ListRepositoriesInDomainCommand extends $Command< ListRepositoriesInDomainCommandInput, diff --git a/clients/client-codeartifact/commands/ListTagsForResourceCommand.ts b/clients/client-codeartifact/commands/ListTagsForResourceCommand.ts index 5dfb564515bd..98a71e7492ef 100644 --- a/clients/client-codeartifact/commands/ListTagsForResourceCommand.ts +++ b/clients/client-codeartifact/commands/ListTagsForResourceCommand.ts @@ -22,6 +22,20 @@ export interface ListTagsForResourceCommandOutput extends ListTagsForResourceRes /** *

Gets information about AWS tags for a specified Amazon Resource Name (ARN) in AWS CodeArtifact.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { CodeartifactClient, ListTagsForResourceCommand } from "@aws-sdk/client-codeartifact"; // ES Modules import + * // const { CodeartifactClient, ListTagsForResourceCommand } = require("@aws-sdk/client-codeartifact"); // CommonJS import + * const client = new CodeartifactClient(config); + * const command = new ListTagsForResourceCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListTagsForResourceCommandInput} for command's `input` shape. + * @see {@link ListTagsForResourceCommandOutput} for command's `response` shape. + * @see {@link CodeartifactClientResolvedConfig | config} for command's `input` shape. + * */ export class ListTagsForResourceCommand extends $Command< ListTagsForResourceCommandInput, diff --git a/clients/client-codeartifact/commands/PutDomainPermissionsPolicyCommand.ts b/clients/client-codeartifact/commands/PutDomainPermissionsPolicyCommand.ts index 7f73e8332530..9122cc61478c 100644 --- a/clients/client-codeartifact/commands/PutDomainPermissionsPolicyCommand.ts +++ b/clients/client-codeartifact/commands/PutDomainPermissionsPolicyCommand.ts @@ -29,6 +29,20 @@ export interface PutDomainPermissionsPolicyCommandOutput extends PutDomainPermis * 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. *

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { CodeartifactClient, PutDomainPermissionsPolicyCommand } from "@aws-sdk/client-codeartifact"; // ES Modules import + * // const { CodeartifactClient, PutDomainPermissionsPolicyCommand } = require("@aws-sdk/client-codeartifact"); // CommonJS import + * const client = new CodeartifactClient(config); + * const command = new PutDomainPermissionsPolicyCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link PutDomainPermissionsPolicyCommandInput} for command's `input` shape. + * @see {@link PutDomainPermissionsPolicyCommandOutput} for command's `response` shape. + * @see {@link CodeartifactClientResolvedConfig | config} for command's `input` shape. + * */ export class PutDomainPermissionsPolicyCommand extends $Command< PutDomainPermissionsPolicyCommandInput, diff --git a/clients/client-codeartifact/commands/PutRepositoryPermissionsPolicyCommand.ts b/clients/client-codeartifact/commands/PutRepositoryPermissionsPolicyCommand.ts index 1658724413bc..1b93c6d59c39 100644 --- a/clients/client-codeartifact/commands/PutRepositoryPermissionsPolicyCommand.ts +++ b/clients/client-codeartifact/commands/PutRepositoryPermissionsPolicyCommand.ts @@ -31,6 +31,20 @@ export interface PutRepositoryPermissionsPolicyCommandOutput * 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. *

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { CodeartifactClient, PutRepositoryPermissionsPolicyCommand } from "@aws-sdk/client-codeartifact"; // ES Modules import + * // const { CodeartifactClient, PutRepositoryPermissionsPolicyCommand } = require("@aws-sdk/client-codeartifact"); // CommonJS import + * const client = new CodeartifactClient(config); + * const command = new PutRepositoryPermissionsPolicyCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link PutRepositoryPermissionsPolicyCommandInput} for command's `input` shape. + * @see {@link PutRepositoryPermissionsPolicyCommandOutput} for command's `response` shape. + * @see {@link CodeartifactClientResolvedConfig | config} for command's `input` shape. + * */ export class PutRepositoryPermissionsPolicyCommand extends $Command< PutRepositoryPermissionsPolicyCommandInput, diff --git a/clients/client-codeartifact/commands/TagResourceCommand.ts b/clients/client-codeartifact/commands/TagResourceCommand.ts index f3be462ed2ff..3ac769a55e94 100644 --- a/clients/client-codeartifact/commands/TagResourceCommand.ts +++ b/clients/client-codeartifact/commands/TagResourceCommand.ts @@ -22,6 +22,20 @@ export interface TagResourceCommandOutput extends TagResourceResult, __MetadataB /** *

Adds or updates tags for a resource in AWS CodeArtifact.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { CodeartifactClient, TagResourceCommand } from "@aws-sdk/client-codeartifact"; // ES Modules import + * // const { CodeartifactClient, TagResourceCommand } = require("@aws-sdk/client-codeartifact"); // CommonJS import + * const client = new CodeartifactClient(config); + * const command = new TagResourceCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link TagResourceCommandInput} for command's `input` shape. + * @see {@link TagResourceCommandOutput} for command's `response` shape. + * @see {@link CodeartifactClientResolvedConfig | config} for command's `input` shape. + * */ export class TagResourceCommand extends $Command< TagResourceCommandInput, diff --git a/clients/client-codeartifact/commands/UntagResourceCommand.ts b/clients/client-codeartifact/commands/UntagResourceCommand.ts index 802d0bbcad2d..a62165426a8e 100644 --- a/clients/client-codeartifact/commands/UntagResourceCommand.ts +++ b/clients/client-codeartifact/commands/UntagResourceCommand.ts @@ -22,6 +22,20 @@ export interface UntagResourceCommandOutput extends UntagResourceResult, __Metad /** *

Removes tags from a resource in AWS CodeArtifact.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { CodeartifactClient, UntagResourceCommand } from "@aws-sdk/client-codeartifact"; // ES Modules import + * // const { CodeartifactClient, UntagResourceCommand } = require("@aws-sdk/client-codeartifact"); // CommonJS import + * const client = new CodeartifactClient(config); + * const command = new UntagResourceCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link UntagResourceCommandInput} for command's `input` shape. + * @see {@link UntagResourceCommandOutput} for command's `response` shape. + * @see {@link CodeartifactClientResolvedConfig | config} for command's `input` shape. + * */ export class UntagResourceCommand extends $Command< UntagResourceCommandInput, diff --git a/clients/client-codeartifact/commands/UpdatePackageVersionsStatusCommand.ts b/clients/client-codeartifact/commands/UpdatePackageVersionsStatusCommand.ts index fdd09f8d9ec7..a93b6a784153 100644 --- a/clients/client-codeartifact/commands/UpdatePackageVersionsStatusCommand.ts +++ b/clients/client-codeartifact/commands/UpdatePackageVersionsStatusCommand.ts @@ -24,6 +24,20 @@ export interface UpdatePackageVersionsStatusCommandOutput extends UpdatePackageV *

* Updates the status of one or more versions of a package. *

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { CodeartifactClient, UpdatePackageVersionsStatusCommand } from "@aws-sdk/client-codeartifact"; // ES Modules import + * // const { CodeartifactClient, UpdatePackageVersionsStatusCommand } = require("@aws-sdk/client-codeartifact"); // CommonJS import + * const client = new CodeartifactClient(config); + * const command = new UpdatePackageVersionsStatusCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link UpdatePackageVersionsStatusCommandInput} for command's `input` shape. + * @see {@link UpdatePackageVersionsStatusCommandOutput} for command's `response` shape. + * @see {@link CodeartifactClientResolvedConfig | config} for command's `input` shape. + * */ export class UpdatePackageVersionsStatusCommand extends $Command< UpdatePackageVersionsStatusCommandInput, diff --git a/clients/client-codeartifact/commands/UpdateRepositoryCommand.ts b/clients/client-codeartifact/commands/UpdateRepositoryCommand.ts index 604f15267a0a..25dc38d77765 100644 --- a/clients/client-codeartifact/commands/UpdateRepositoryCommand.ts +++ b/clients/client-codeartifact/commands/UpdateRepositoryCommand.ts @@ -24,6 +24,20 @@ export interface UpdateRepositoryCommandOutput extends UpdateRepositoryResult, _ *

* Update the properties of a repository. *

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { CodeartifactClient, UpdateRepositoryCommand } from "@aws-sdk/client-codeartifact"; // ES Modules import + * // const { CodeartifactClient, UpdateRepositoryCommand } = require("@aws-sdk/client-codeartifact"); // CommonJS import + * const client = new CodeartifactClient(config); + * const command = new UpdateRepositoryCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link UpdateRepositoryCommandInput} for command's `input` shape. + * @see {@link UpdateRepositoryCommandOutput} for command's `response` shape. + * @see {@link CodeartifactClientResolvedConfig | config} for command's `input` shape. + * */ export class UpdateRepositoryCommand extends $Command< UpdateRepositoryCommandInput, diff --git a/clients/client-codeartifact/models/models_0.ts b/clients/client-codeartifact/models/models_0.ts index c87047cc037e..10dae8d8aef6 100644 --- a/clients/client-codeartifact/models/models_0.ts +++ b/clients/client-codeartifact/models/models_0.ts @@ -14,6 +14,9 @@ export interface AccessDeniedException extends __SmithyException, $MetadataBeare } export namespace AccessDeniedException { + /** + * @internal + */ export const filterSensitiveLog = (obj: AccessDeniedException): any => ({ ...obj, }); @@ -55,6 +58,9 @@ export interface AssetSummary { } export namespace AssetSummary { + /** + * @internal + */ export const filterSensitiveLog = (obj: AssetSummary): any => ({ ...obj, }); @@ -122,6 +128,9 @@ export interface AssociateExternalConnectionRequest { } export namespace AssociateExternalConnectionRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: AssociateExternalConnectionRequest): any => ({ ...obj, }); @@ -182,6 +191,9 @@ export interface RepositoryExternalConnectionInfo { } export namespace RepositoryExternalConnectionInfo { + /** + * @internal + */ export const filterSensitiveLog = (obj: RepositoryExternalConnectionInfo): any => ({ ...obj, }); @@ -200,6 +212,9 @@ export interface UpstreamRepositoryInfo { } export namespace UpstreamRepositoryInfo { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpstreamRepositoryInfo): any => ({ ...obj, }); @@ -269,6 +284,9 @@ export interface RepositoryDescription { } export namespace RepositoryDescription { + /** + * @internal + */ export const filterSensitiveLog = (obj: RepositoryDescription): any => ({ ...obj, }); @@ -284,6 +302,9 @@ export interface AssociateExternalConnectionResult { } export namespace AssociateExternalConnectionResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: AssociateExternalConnectionResult): any => ({ ...obj, }); @@ -322,6 +343,9 @@ export interface ConflictException extends __SmithyException, $MetadataBearer { } export namespace ConflictException { + /** + * @internal + */ export const filterSensitiveLog = (obj: ConflictException): any => ({ ...obj, }); @@ -337,6 +361,9 @@ export interface InternalServerException extends __SmithyException, $MetadataBea } export namespace InternalServerException { + /** + * @internal + */ export const filterSensitiveLog = (obj: InternalServerException): any => ({ ...obj, }); @@ -367,6 +394,9 @@ export interface ResourceNotFoundException extends __SmithyException, $MetadataB } export namespace ResourceNotFoundException { + /** + * @internal + */ export const filterSensitiveLog = (obj: ResourceNotFoundException): any => ({ ...obj, }); @@ -397,6 +427,9 @@ export interface ServiceQuotaExceededException extends __SmithyException, $Metad } export namespace ServiceQuotaExceededException { + /** + * @internal + */ export const filterSensitiveLog = (obj: ServiceQuotaExceededException): any => ({ ...obj, }); @@ -420,6 +453,9 @@ export interface ThrottlingException extends __SmithyException, $MetadataBearer } export namespace ThrottlingException { + /** + * @internal + */ export const filterSensitiveLog = (obj: ThrottlingException): any => ({ ...obj, }); @@ -451,6 +487,9 @@ export interface ValidationException extends __SmithyException, $MetadataBearer } export namespace ValidationException { + /** + * @internal + */ export const filterSensitiveLog = (obj: ValidationException): any => ({ ...obj, }); @@ -588,6 +627,9 @@ export interface CopyPackageVersionsRequest { } export namespace CopyPackageVersionsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: CopyPackageVersionsRequest): any => ({ ...obj, }); @@ -654,6 +696,9 @@ export interface PackageVersionError { } export namespace PackageVersionError { + /** + * @internal + */ export const filterSensitiveLog = (obj: PackageVersionError): any => ({ ...obj, }); @@ -717,6 +762,9 @@ export interface SuccessfulPackageVersionInfo { } export namespace SuccessfulPackageVersionInfo { + /** + * @internal + */ export const filterSensitiveLog = (obj: SuccessfulPackageVersionInfo): any => ({ ...obj, }); @@ -772,6 +820,9 @@ export interface CopyPackageVersionsResult { } export namespace CopyPackageVersionsResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: CopyPackageVersionsResult): any => ({ ...obj, }); @@ -793,6 +844,9 @@ export interface Tag { } export namespace Tag { + /** + * @internal + */ export const filterSensitiveLog = (obj: Tag): any => ({ ...obj, }); @@ -829,6 +883,9 @@ export interface CreateDomainRequest { } export namespace CreateDomainRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateDomainRequest): any => ({ ...obj, }); @@ -913,6 +970,9 @@ export interface DomainDescription { } export namespace DomainDescription { + /** + * @internal + */ export const filterSensitiveLog = (obj: DomainDescription): any => ({ ...obj, }); @@ -928,6 +988,9 @@ export interface CreateDomainResult { } export namespace CreateDomainResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateDomainResult): any => ({ ...obj, }); @@ -952,6 +1015,9 @@ export interface UpstreamRepository { } export namespace UpstreamRepository { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpstreamRepository): any => ({ ...obj, }); @@ -999,6 +1065,9 @@ export interface CreateRepositoryRequest { } export namespace CreateRepositoryRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateRepositoryRequest): any => ({ ...obj, }); @@ -1014,6 +1083,9 @@ export interface CreateRepositoryResult { } export namespace CreateRepositoryResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateRepositoryResult): any => ({ ...obj, }); @@ -1037,6 +1109,9 @@ export interface DeleteDomainRequest { } export namespace DeleteDomainRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteDomainRequest): any => ({ ...obj, }); @@ -1052,6 +1127,9 @@ export interface DeleteDomainResult { } export namespace DeleteDomainResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteDomainResult): any => ({ ...obj, }); @@ -1083,6 +1161,9 @@ export interface DeleteDomainPermissionsPolicyRequest { } export namespace DeleteDomainPermissionsPolicyRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteDomainPermissionsPolicyRequest): any => ({ ...obj, }); @@ -1117,6 +1198,9 @@ export interface ResourcePolicy { } export namespace ResourcePolicy { + /** + * @internal + */ export const filterSensitiveLog = (obj: ResourcePolicy): any => ({ ...obj, }); @@ -1132,6 +1216,9 @@ export interface DeleteDomainPermissionsPolicyResult { } export namespace DeleteDomainPermissionsPolicyResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteDomainPermissionsPolicyResult): any => ({ ...obj, }); @@ -1260,6 +1347,9 @@ export interface DeletePackageVersionsRequest { } export namespace DeletePackageVersionsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeletePackageVersionsRequest): any => ({ ...obj, }); @@ -1315,6 +1405,9 @@ export interface DeletePackageVersionsResult { } export namespace DeletePackageVersionsResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeletePackageVersionsResult): any => ({ ...obj, }); @@ -1343,6 +1436,9 @@ export interface DeleteRepositoryRequest { } export namespace DeleteRepositoryRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteRepositoryRequest): any => ({ ...obj, }); @@ -1358,6 +1454,9 @@ export interface DeleteRepositoryResult { } export namespace DeleteRepositoryResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteRepositoryResult): any => ({ ...obj, }); @@ -1396,6 +1495,9 @@ export interface DeleteRepositoryPermissionsPolicyRequest { } export namespace DeleteRepositoryPermissionsPolicyRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteRepositoryPermissionsPolicyRequest): any => ({ ...obj, }); @@ -1411,6 +1513,9 @@ export interface DeleteRepositoryPermissionsPolicyResult { } export namespace DeleteRepositoryPermissionsPolicyResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteRepositoryPermissionsPolicyResult): any => ({ ...obj, }); @@ -1434,6 +1539,9 @@ export interface DescribeDomainRequest { } export namespace DescribeDomainRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeDomainRequest): any => ({ ...obj, }); @@ -1450,6 +1558,9 @@ export interface DescribeDomainResult { } export namespace DescribeDomainResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeDomainResult): any => ({ ...obj, }); @@ -1540,6 +1651,9 @@ export interface DescribePackageVersionRequest { } export namespace DescribePackageVersionRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribePackageVersionRequest): any => ({ ...obj, }); @@ -1567,6 +1681,9 @@ export interface LicenseInfo { } export namespace LicenseInfo { + /** + * @internal + */ export const filterSensitiveLog = (obj: LicenseInfo): any => ({ ...obj, }); @@ -1731,6 +1848,9 @@ export interface PackageVersionDescription { } export namespace PackageVersionDescription { + /** + * @internal + */ export const filterSensitiveLog = (obj: PackageVersionDescription): any => ({ ...obj, }); @@ -1747,6 +1867,9 @@ export interface DescribePackageVersionResult { } export namespace DescribePackageVersionResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribePackageVersionResult): any => ({ ...obj, }); @@ -1777,6 +1900,9 @@ export interface DescribeRepositoryRequest { } export namespace DescribeRepositoryRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeRepositoryRequest): any => ({ ...obj, }); @@ -1792,6 +1918,9 @@ export interface DescribeRepositoryResult { } export namespace DescribeRepositoryResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeRepositoryResult): any => ({ ...obj, }); @@ -1824,6 +1953,9 @@ export interface DisassociateExternalConnectionRequest { } export namespace DisassociateExternalConnectionRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DisassociateExternalConnectionRequest): any => ({ ...obj, }); @@ -1839,6 +1971,9 @@ export interface DisassociateExternalConnectionResult { } export namespace DisassociateExternalConnectionResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: DisassociateExternalConnectionResult): any => ({ ...obj, }); @@ -1974,6 +2109,9 @@ export interface DisposePackageVersionsRequest { } export namespace DisposePackageVersionsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DisposePackageVersionsRequest): any => ({ ...obj, }); @@ -2029,6 +2167,9 @@ export interface DisposePackageVersionsResult { } export namespace DisposePackageVersionsResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: DisposePackageVersionsResult): any => ({ ...obj, }); @@ -2060,6 +2201,9 @@ export interface GetAuthorizationTokenRequest { } export namespace GetAuthorizationTokenRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetAuthorizationTokenRequest): any => ({ ...obj, }); @@ -2082,6 +2226,9 @@ export interface GetAuthorizationTokenResult { } export namespace GetAuthorizationTokenResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetAuthorizationTokenResult): any => ({ ...obj, }); @@ -2105,6 +2252,9 @@ export interface GetDomainPermissionsPolicyRequest { } export namespace GetDomainPermissionsPolicyRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetDomainPermissionsPolicyRequest): any => ({ ...obj, }); @@ -2120,6 +2270,9 @@ export interface GetDomainPermissionsPolicyResult { } export namespace GetDomainPermissionsPolicyResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetDomainPermissionsPolicyResult): any => ({ ...obj, }); @@ -2228,6 +2381,9 @@ export interface GetPackageVersionAssetRequest { } export namespace GetPackageVersionAssetRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetPackageVersionAssetRequest): any => ({ ...obj, }); @@ -2262,6 +2418,9 @@ export interface GetPackageVersionAssetResult { } export namespace GetPackageVersionAssetResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetPackageVersionAssetResult): any => ({ ...obj, }); @@ -2356,6 +2515,9 @@ export interface GetPackageVersionReadmeRequest { } export namespace GetPackageVersionReadmeRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetPackageVersionReadmeRequest): any => ({ ...obj, }); @@ -2442,6 +2604,9 @@ export interface GetPackageVersionReadmeResult { } export namespace GetPackageVersionReadmeResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetPackageVersionReadmeResult): any => ({ ...obj, }); @@ -2497,6 +2662,9 @@ export interface GetRepositoryEndpointRequest { } export namespace GetRepositoryEndpointRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetRepositoryEndpointRequest): any => ({ ...obj, }); @@ -2512,6 +2680,9 @@ export interface GetRepositoryEndpointResult { } export namespace GetRepositoryEndpointResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetRepositoryEndpointResult): any => ({ ...obj, }); @@ -2542,6 +2713,9 @@ export interface GetRepositoryPermissionsPolicyRequest { } export namespace GetRepositoryPermissionsPolicyRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetRepositoryPermissionsPolicyRequest): any => ({ ...obj, }); @@ -2557,6 +2731,9 @@ export interface GetRepositoryPermissionsPolicyResult { } export namespace GetRepositoryPermissionsPolicyResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetRepositoryPermissionsPolicyResult): any => ({ ...obj, }); @@ -2579,6 +2756,9 @@ export interface ListDomainsRequest { } export namespace ListDomainsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListDomainsRequest): any => ({ ...obj, }); @@ -2649,6 +2829,9 @@ export interface DomainSummary { } export namespace DomainSummary { + /** + * @internal + */ export const filterSensitiveLog = (obj: DomainSummary): any => ({ ...obj, }); @@ -2671,6 +2854,9 @@ export interface ListDomainsResult { } export namespace ListDomainsResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListDomainsResult): any => ({ ...obj, }); @@ -2773,6 +2959,9 @@ export interface ListPackagesRequest { } export namespace ListPackagesRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListPackagesRequest): any => ({ ...obj, }); @@ -2847,6 +3036,9 @@ export interface PackageSummary { } export namespace PackageSummary { + /** + * @internal + */ export const filterSensitiveLog = (obj: PackageSummary): any => ({ ...obj, }); @@ -2872,6 +3064,9 @@ export interface ListPackagesResult { } export namespace ListPackagesResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListPackagesResult): any => ({ ...obj, }); @@ -2980,6 +3175,9 @@ export interface ListPackageVersionAssetsRequest { } export namespace ListPackageVersionAssetsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListPackageVersionAssetsRequest): any => ({ ...obj, }); @@ -3058,6 +3256,9 @@ export interface ListPackageVersionAssetsResult { } export namespace ListPackageVersionAssetsResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListPackageVersionAssetsResult): any => ({ ...obj, }); @@ -3159,6 +3360,9 @@ export interface ListPackageVersionDependenciesRequest { } export namespace ListPackageVersionDependenciesRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListPackageVersionDependenciesRequest): any => ({ ...obj, }); @@ -3221,6 +3425,9 @@ export interface PackageDependency { } export namespace PackageDependency { + /** + * @internal + */ export const filterSensitiveLog = (obj: PackageDependency): any => ({ ...obj, }); @@ -3316,6 +3523,9 @@ export interface ListPackageVersionDependenciesResult { } export namespace ListPackageVersionDependenciesResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListPackageVersionDependenciesResult): any => ({ ...obj, }); @@ -3462,6 +3672,9 @@ export interface ListPackageVersionsRequest { } export namespace ListPackageVersionsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListPackageVersionsRequest): any => ({ ...obj, }); @@ -3527,6 +3740,9 @@ export interface PackageVersionSummary { } export namespace PackageVersionSummary { + /** + * @internal + */ export const filterSensitiveLog = (obj: PackageVersionSummary): any => ({ ...obj, }); @@ -3630,6 +3846,9 @@ export interface ListPackageVersionsResult { } export namespace ListPackageVersionsResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListPackageVersionsResult): any => ({ ...obj, }); @@ -3658,6 +3877,9 @@ export interface ListRepositoriesRequest { } export namespace ListRepositoriesRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListRepositoriesRequest): any => ({ ...obj, }); @@ -3714,6 +3936,9 @@ export interface RepositorySummary { } export namespace RepositorySummary { + /** + * @internal + */ export const filterSensitiveLog = (obj: RepositorySummary): any => ({ ...obj, }); @@ -3739,6 +3964,9 @@ export interface ListRepositoriesResult { } export namespace ListRepositoriesResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListRepositoriesResult): any => ({ ...obj, }); @@ -3791,6 +4019,9 @@ export interface ListRepositoriesInDomainRequest { } export namespace ListRepositoriesInDomainRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListRepositoriesInDomainRequest): any => ({ ...obj, }); @@ -3813,6 +4044,9 @@ export interface ListRepositoriesInDomainResult { } export namespace ListRepositoriesInDomainResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListRepositoriesInDomainResult): any => ({ ...obj, }); @@ -3826,6 +4060,9 @@ export interface ListTagsForResourceRequest { } export namespace ListTagsForResourceRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListTagsForResourceRequest): any => ({ ...obj, }); @@ -3839,6 +4076,9 @@ export interface ListTagsForResourceResult { } export namespace ListTagsForResourceResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListTagsForResourceResult): any => ({ ...obj, }); @@ -3876,6 +4116,9 @@ export interface PutDomainPermissionsPolicyRequest { } export namespace PutDomainPermissionsPolicyRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: PutDomainPermissionsPolicyRequest): any => ({ ...obj, }); @@ -3889,6 +4132,9 @@ export interface PutDomainPermissionsPolicyResult { } export namespace PutDomainPermissionsPolicyResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: PutDomainPermissionsPolicyResult): any => ({ ...obj, }); @@ -3932,6 +4178,9 @@ export interface PutRepositoryPermissionsPolicyRequest { } export namespace PutRepositoryPermissionsPolicyRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: PutRepositoryPermissionsPolicyRequest): any => ({ ...obj, }); @@ -3945,6 +4194,9 @@ export interface PutRepositoryPermissionsPolicyResult { } export namespace PutRepositoryPermissionsPolicyResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: PutRepositoryPermissionsPolicyResult): any => ({ ...obj, }); @@ -3963,6 +4215,9 @@ export interface TagResourceRequest { } export namespace TagResourceRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: TagResourceRequest): any => ({ ...obj, }); @@ -3971,6 +4226,9 @@ export namespace TagResourceRequest { export interface TagResourceResult {} export namespace TagResourceResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: TagResourceResult): any => ({ ...obj, }); @@ -3989,6 +4247,9 @@ export interface UntagResourceRequest { } export namespace UntagResourceRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: UntagResourceRequest): any => ({ ...obj, }); @@ -3997,6 +4258,9 @@ export namespace UntagResourceRequest { export interface UntagResourceResult {} export namespace UntagResourceResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: UntagResourceResult): any => ({ ...obj, }); @@ -4113,6 +4377,9 @@ export interface UpdatePackageVersionsStatusRequest { } export namespace UpdatePackageVersionsStatusRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdatePackageVersionsStatusRequest): any => ({ ...obj, }); @@ -4135,6 +4402,9 @@ export interface UpdatePackageVersionsStatusResult { } export namespace UpdatePackageVersionsStatusResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdatePackageVersionsStatusResult): any => ({ ...obj, }); @@ -4179,6 +4449,9 @@ export interface UpdateRepositoryRequest { } export namespace UpdateRepositoryRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateRepositoryRequest): any => ({ ...obj, }); @@ -4194,6 +4467,9 @@ export interface UpdateRepositoryResult { } export namespace UpdateRepositoryResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateRepositoryResult): any => ({ ...obj, }); diff --git a/clients/client-codebuild/commands/BatchDeleteBuildsCommand.ts b/clients/client-codebuild/commands/BatchDeleteBuildsCommand.ts index ccae3f72c07f..ab2c5bbccaaa 100644 --- a/clients/client-codebuild/commands/BatchDeleteBuildsCommand.ts +++ b/clients/client-codebuild/commands/BatchDeleteBuildsCommand.ts @@ -22,6 +22,20 @@ export interface BatchDeleteBuildsCommandOutput extends BatchDeleteBuildsOutput, /** *

Deletes one or more builds.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { CodeBuildClient, BatchDeleteBuildsCommand } from "@aws-sdk/client-codebuild"; // ES Modules import + * // const { CodeBuildClient, BatchDeleteBuildsCommand } = require("@aws-sdk/client-codebuild"); // CommonJS import + * const client = new CodeBuildClient(config); + * const command = new BatchDeleteBuildsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link BatchDeleteBuildsCommandInput} for command's `input` shape. + * @see {@link BatchDeleteBuildsCommandOutput} for command's `response` shape. + * @see {@link CodeBuildClientResolvedConfig | config} for command's `input` shape. + * */ export class BatchDeleteBuildsCommand extends $Command< BatchDeleteBuildsCommandInput, diff --git a/clients/client-codebuild/commands/BatchGetBuildBatchesCommand.ts b/clients/client-codebuild/commands/BatchGetBuildBatchesCommand.ts index 3eae691019d6..713befc7318f 100644 --- a/clients/client-codebuild/commands/BatchGetBuildBatchesCommand.ts +++ b/clients/client-codebuild/commands/BatchGetBuildBatchesCommand.ts @@ -22,6 +22,20 @@ export interface BatchGetBuildBatchesCommandOutput extends BatchGetBuildBatchesO /** *

Retrieves information about one or more batch builds.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { CodeBuildClient, BatchGetBuildBatchesCommand } from "@aws-sdk/client-codebuild"; // ES Modules import + * // const { CodeBuildClient, BatchGetBuildBatchesCommand } = require("@aws-sdk/client-codebuild"); // CommonJS import + * const client = new CodeBuildClient(config); + * const command = new BatchGetBuildBatchesCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link BatchGetBuildBatchesCommandInput} for command's `input` shape. + * @see {@link BatchGetBuildBatchesCommandOutput} for command's `response` shape. + * @see {@link CodeBuildClientResolvedConfig | config} for command's `input` shape. + * */ export class BatchGetBuildBatchesCommand extends $Command< BatchGetBuildBatchesCommandInput, diff --git a/clients/client-codebuild/commands/BatchGetBuildsCommand.ts b/clients/client-codebuild/commands/BatchGetBuildsCommand.ts index 5644be801f84..f6d8a73f506c 100644 --- a/clients/client-codebuild/commands/BatchGetBuildsCommand.ts +++ b/clients/client-codebuild/commands/BatchGetBuildsCommand.ts @@ -22,6 +22,20 @@ export interface BatchGetBuildsCommandOutput extends BatchGetBuildsOutput, __Met /** *

Gets information about one or more builds.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { CodeBuildClient, BatchGetBuildsCommand } from "@aws-sdk/client-codebuild"; // ES Modules import + * // const { CodeBuildClient, BatchGetBuildsCommand } = require("@aws-sdk/client-codebuild"); // CommonJS import + * const client = new CodeBuildClient(config); + * const command = new BatchGetBuildsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link BatchGetBuildsCommandInput} for command's `input` shape. + * @see {@link BatchGetBuildsCommandOutput} for command's `response` shape. + * @see {@link CodeBuildClientResolvedConfig | config} for command's `input` shape. + * */ export class BatchGetBuildsCommand extends $Command< BatchGetBuildsCommandInput, diff --git a/clients/client-codebuild/commands/BatchGetProjectsCommand.ts b/clients/client-codebuild/commands/BatchGetProjectsCommand.ts index bba9a6d30ca9..de4021c00870 100644 --- a/clients/client-codebuild/commands/BatchGetProjectsCommand.ts +++ b/clients/client-codebuild/commands/BatchGetProjectsCommand.ts @@ -22,6 +22,20 @@ export interface BatchGetProjectsCommandOutput extends BatchGetProjectsOutput, _ /** *

Gets information about one or more build projects.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { CodeBuildClient, BatchGetProjectsCommand } from "@aws-sdk/client-codebuild"; // ES Modules import + * // const { CodeBuildClient, BatchGetProjectsCommand } = require("@aws-sdk/client-codebuild"); // CommonJS import + * const client = new CodeBuildClient(config); + * const command = new BatchGetProjectsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link BatchGetProjectsCommandInput} for command's `input` shape. + * @see {@link BatchGetProjectsCommandOutput} for command's `response` shape. + * @see {@link CodeBuildClientResolvedConfig | config} for command's `input` shape. + * */ export class BatchGetProjectsCommand extends $Command< BatchGetProjectsCommandInput, diff --git a/clients/client-codebuild/commands/BatchGetReportGroupsCommand.ts b/clients/client-codebuild/commands/BatchGetReportGroupsCommand.ts index 58a731696727..9a37762f4b8e 100644 --- a/clients/client-codebuild/commands/BatchGetReportGroupsCommand.ts +++ b/clients/client-codebuild/commands/BatchGetReportGroupsCommand.ts @@ -24,6 +24,20 @@ export interface BatchGetReportGroupsCommandOutput extends BatchGetReportGroupsO *

* Returns an array of report groups. *

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { CodeBuildClient, BatchGetReportGroupsCommand } from "@aws-sdk/client-codebuild"; // ES Modules import + * // const { CodeBuildClient, BatchGetReportGroupsCommand } = require("@aws-sdk/client-codebuild"); // CommonJS import + * const client = new CodeBuildClient(config); + * const command = new BatchGetReportGroupsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link BatchGetReportGroupsCommandInput} for command's `input` shape. + * @see {@link BatchGetReportGroupsCommandOutput} for command's `response` shape. + * @see {@link CodeBuildClientResolvedConfig | config} for command's `input` shape. + * */ export class BatchGetReportGroupsCommand extends $Command< BatchGetReportGroupsCommandInput, diff --git a/clients/client-codebuild/commands/BatchGetReportsCommand.ts b/clients/client-codebuild/commands/BatchGetReportsCommand.ts index 342d71461f2b..2f5bfa3c7286 100644 --- a/clients/client-codebuild/commands/BatchGetReportsCommand.ts +++ b/clients/client-codebuild/commands/BatchGetReportsCommand.ts @@ -24,6 +24,20 @@ export interface BatchGetReportsCommandOutput extends BatchGetReportsOutput, __M *

* Returns an array of reports. *

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { CodeBuildClient, BatchGetReportsCommand } from "@aws-sdk/client-codebuild"; // ES Modules import + * // const { CodeBuildClient, BatchGetReportsCommand } = require("@aws-sdk/client-codebuild"); // CommonJS import + * const client = new CodeBuildClient(config); + * const command = new BatchGetReportsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link BatchGetReportsCommandInput} for command's `input` shape. + * @see {@link BatchGetReportsCommandOutput} for command's `response` shape. + * @see {@link CodeBuildClientResolvedConfig | config} for command's `input` shape. + * */ export class BatchGetReportsCommand extends $Command< BatchGetReportsCommandInput, diff --git a/clients/client-codebuild/commands/CreateProjectCommand.ts b/clients/client-codebuild/commands/CreateProjectCommand.ts index bf6f646b3f4d..04990535bb8f 100644 --- a/clients/client-codebuild/commands/CreateProjectCommand.ts +++ b/clients/client-codebuild/commands/CreateProjectCommand.ts @@ -22,6 +22,20 @@ export interface CreateProjectCommandOutput extends CreateProjectOutput, __Metad /** *

Creates a build project.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { CodeBuildClient, CreateProjectCommand } from "@aws-sdk/client-codebuild"; // ES Modules import + * // const { CodeBuildClient, CreateProjectCommand } = require("@aws-sdk/client-codebuild"); // CommonJS import + * const client = new CodeBuildClient(config); + * const command = new CreateProjectCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreateProjectCommandInput} for command's `input` shape. + * @see {@link CreateProjectCommandOutput} for command's `response` shape. + * @see {@link CodeBuildClientResolvedConfig | config} for command's `input` shape. + * */ export class CreateProjectCommand extends $Command< CreateProjectCommandInput, diff --git a/clients/client-codebuild/commands/CreateReportGroupCommand.ts b/clients/client-codebuild/commands/CreateReportGroupCommand.ts index 8b37e5408bb7..d515157863b6 100644 --- a/clients/client-codebuild/commands/CreateReportGroupCommand.ts +++ b/clients/client-codebuild/commands/CreateReportGroupCommand.ts @@ -24,6 +24,20 @@ export interface CreateReportGroupCommandOutput extends CreateReportGroupOutput, *

* Creates a report group. A report group contains a collection of reports. *

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { CodeBuildClient, CreateReportGroupCommand } from "@aws-sdk/client-codebuild"; // ES Modules import + * // const { CodeBuildClient, CreateReportGroupCommand } = require("@aws-sdk/client-codebuild"); // CommonJS import + * const client = new CodeBuildClient(config); + * const command = new CreateReportGroupCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreateReportGroupCommandInput} for command's `input` shape. + * @see {@link CreateReportGroupCommandOutput} for command's `response` shape. + * @see {@link CodeBuildClientResolvedConfig | config} for command's `input` shape. + * */ export class CreateReportGroupCommand extends $Command< CreateReportGroupCommandInput, diff --git a/clients/client-codebuild/commands/CreateWebhookCommand.ts b/clients/client-codebuild/commands/CreateWebhookCommand.ts index 090942a79f6c..809bd92feb3b 100644 --- a/clients/client-codebuild/commands/CreateWebhookCommand.ts +++ b/clients/client-codebuild/commands/CreateWebhookCommand.ts @@ -32,6 +32,20 @@ export interface CreateWebhookCommandOutput extends CreateWebhookOutput, __Metad * recommend that you disable webhooks in AWS CodeBuild. In the AWS CodeBuild console, clear the * Webhook box. For more information, see step 5 in Change a Build Project's Settings.

* + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { CodeBuildClient, CreateWebhookCommand } from "@aws-sdk/client-codebuild"; // ES Modules import + * // const { CodeBuildClient, CreateWebhookCommand } = require("@aws-sdk/client-codebuild"); // CommonJS import + * const client = new CodeBuildClient(config); + * const command = new CreateWebhookCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreateWebhookCommandInput} for command's `input` shape. + * @see {@link CreateWebhookCommandOutput} for command's `response` shape. + * @see {@link CodeBuildClientResolvedConfig | config} for command's `input` shape. + * */ export class CreateWebhookCommand extends $Command< CreateWebhookCommandInput, diff --git a/clients/client-codebuild/commands/DeleteBuildBatchCommand.ts b/clients/client-codebuild/commands/DeleteBuildBatchCommand.ts index 60f03313eea1..2cd9e5e78a7a 100644 --- a/clients/client-codebuild/commands/DeleteBuildBatchCommand.ts +++ b/clients/client-codebuild/commands/DeleteBuildBatchCommand.ts @@ -22,6 +22,20 @@ export interface DeleteBuildBatchCommandOutput extends DeleteBuildBatchOutput, _ /** *

Deletes a batch build.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { CodeBuildClient, DeleteBuildBatchCommand } from "@aws-sdk/client-codebuild"; // ES Modules import + * // const { CodeBuildClient, DeleteBuildBatchCommand } = require("@aws-sdk/client-codebuild"); // CommonJS import + * const client = new CodeBuildClient(config); + * const command = new DeleteBuildBatchCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteBuildBatchCommandInput} for command's `input` shape. + * @see {@link DeleteBuildBatchCommandOutput} for command's `response` shape. + * @see {@link CodeBuildClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteBuildBatchCommand extends $Command< DeleteBuildBatchCommandInput, diff --git a/clients/client-codebuild/commands/DeleteProjectCommand.ts b/clients/client-codebuild/commands/DeleteProjectCommand.ts index 58f9d6103891..6b79dff69111 100644 --- a/clients/client-codebuild/commands/DeleteProjectCommand.ts +++ b/clients/client-codebuild/commands/DeleteProjectCommand.ts @@ -23,6 +23,20 @@ export interface DeleteProjectCommandOutput extends DeleteProjectOutput, __Metad /** *

Deletes a build project. When you delete a project, its builds are not deleted. *

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { CodeBuildClient, DeleteProjectCommand } from "@aws-sdk/client-codebuild"; // ES Modules import + * // const { CodeBuildClient, DeleteProjectCommand } = require("@aws-sdk/client-codebuild"); // CommonJS import + * const client = new CodeBuildClient(config); + * const command = new DeleteProjectCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteProjectCommandInput} for command's `input` shape. + * @see {@link DeleteProjectCommandOutput} for command's `response` shape. + * @see {@link CodeBuildClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteProjectCommand extends $Command< DeleteProjectCommandInput, diff --git a/clients/client-codebuild/commands/DeleteReportCommand.ts b/clients/client-codebuild/commands/DeleteReportCommand.ts index 7a1df52e1795..e5ef06a55152 100644 --- a/clients/client-codebuild/commands/DeleteReportCommand.ts +++ b/clients/client-codebuild/commands/DeleteReportCommand.ts @@ -24,6 +24,20 @@ export interface DeleteReportCommandOutput extends DeleteReportOutput, __Metadat *

* Deletes a report. *

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { CodeBuildClient, DeleteReportCommand } from "@aws-sdk/client-codebuild"; // ES Modules import + * // const { CodeBuildClient, DeleteReportCommand } = require("@aws-sdk/client-codebuild"); // CommonJS import + * const client = new CodeBuildClient(config); + * const command = new DeleteReportCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteReportCommandInput} for command's `input` shape. + * @see {@link DeleteReportCommandOutput} for command's `response` shape. + * @see {@link CodeBuildClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteReportCommand extends $Command< DeleteReportCommandInput, diff --git a/clients/client-codebuild/commands/DeleteReportGroupCommand.ts b/clients/client-codebuild/commands/DeleteReportGroupCommand.ts index 5566e716208e..fa7977d128f8 100644 --- a/clients/client-codebuild/commands/DeleteReportGroupCommand.ts +++ b/clients/client-codebuild/commands/DeleteReportGroupCommand.ts @@ -22,6 +22,20 @@ export interface DeleteReportGroupCommandOutput extends DeleteReportGroupOutput, /** *

Deletes a report group. Before you delete a report group, you must delete its reports.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { CodeBuildClient, DeleteReportGroupCommand } from "@aws-sdk/client-codebuild"; // ES Modules import + * // const { CodeBuildClient, DeleteReportGroupCommand } = require("@aws-sdk/client-codebuild"); // CommonJS import + * const client = new CodeBuildClient(config); + * const command = new DeleteReportGroupCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteReportGroupCommandInput} for command's `input` shape. + * @see {@link DeleteReportGroupCommandOutput} for command's `response` shape. + * @see {@link CodeBuildClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteReportGroupCommand extends $Command< DeleteReportGroupCommandInput, diff --git a/clients/client-codebuild/commands/DeleteResourcePolicyCommand.ts b/clients/client-codebuild/commands/DeleteResourcePolicyCommand.ts index d3df89c47663..752f2d254fa2 100644 --- a/clients/client-codebuild/commands/DeleteResourcePolicyCommand.ts +++ b/clients/client-codebuild/commands/DeleteResourcePolicyCommand.ts @@ -22,6 +22,20 @@ export interface DeleteResourcePolicyCommandOutput extends DeleteResourcePolicyO /** *

Deletes a resource policy that is identified by its resource ARN.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { CodeBuildClient, DeleteResourcePolicyCommand } from "@aws-sdk/client-codebuild"; // ES Modules import + * // const { CodeBuildClient, DeleteResourcePolicyCommand } = require("@aws-sdk/client-codebuild"); // CommonJS import + * const client = new CodeBuildClient(config); + * const command = new DeleteResourcePolicyCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteResourcePolicyCommandInput} for command's `input` shape. + * @see {@link DeleteResourcePolicyCommandOutput} for command's `response` shape. + * @see {@link CodeBuildClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteResourcePolicyCommand extends $Command< DeleteResourcePolicyCommandInput, diff --git a/clients/client-codebuild/commands/DeleteSourceCredentialsCommand.ts b/clients/client-codebuild/commands/DeleteSourceCredentialsCommand.ts index 7ef22f3cc273..5142a13e52b3 100644 --- a/clients/client-codebuild/commands/DeleteSourceCredentialsCommand.ts +++ b/clients/client-codebuild/commands/DeleteSourceCredentialsCommand.ts @@ -22,6 +22,20 @@ export interface DeleteSourceCredentialsCommandOutput extends DeleteSourceCreden /** *

Deletes a set of GitHub, GitHub Enterprise, or Bitbucket source credentials.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { CodeBuildClient, DeleteSourceCredentialsCommand } from "@aws-sdk/client-codebuild"; // ES Modules import + * // const { CodeBuildClient, DeleteSourceCredentialsCommand } = require("@aws-sdk/client-codebuild"); // CommonJS import + * const client = new CodeBuildClient(config); + * const command = new DeleteSourceCredentialsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteSourceCredentialsCommandInput} for command's `input` shape. + * @see {@link DeleteSourceCredentialsCommandOutput} for command's `response` shape. + * @see {@link CodeBuildClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteSourceCredentialsCommand extends $Command< DeleteSourceCredentialsCommandInput, diff --git a/clients/client-codebuild/commands/DeleteWebhookCommand.ts b/clients/client-codebuild/commands/DeleteWebhookCommand.ts index 08f96c9eb7c8..b6fef2441ead 100644 --- a/clients/client-codebuild/commands/DeleteWebhookCommand.ts +++ b/clients/client-codebuild/commands/DeleteWebhookCommand.ts @@ -24,6 +24,20 @@ export interface DeleteWebhookCommandOutput extends DeleteWebhookOutput, __Metad *

For an existing AWS CodeBuild build project that has its source code stored in a GitHub or * Bitbucket repository, stops AWS CodeBuild from rebuilding the source code every time a code * change is pushed to the repository.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { CodeBuildClient, DeleteWebhookCommand } from "@aws-sdk/client-codebuild"; // ES Modules import + * // const { CodeBuildClient, DeleteWebhookCommand } = require("@aws-sdk/client-codebuild"); // CommonJS import + * const client = new CodeBuildClient(config); + * const command = new DeleteWebhookCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteWebhookCommandInput} for command's `input` shape. + * @see {@link DeleteWebhookCommandOutput} for command's `response` shape. + * @see {@link CodeBuildClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteWebhookCommand extends $Command< DeleteWebhookCommandInput, diff --git a/clients/client-codebuild/commands/DescribeCodeCoveragesCommand.ts b/clients/client-codebuild/commands/DescribeCodeCoveragesCommand.ts index a8628cce809f..a432470ae985 100644 --- a/clients/client-codebuild/commands/DescribeCodeCoveragesCommand.ts +++ b/clients/client-codebuild/commands/DescribeCodeCoveragesCommand.ts @@ -22,6 +22,20 @@ export interface DescribeCodeCoveragesCommandOutput extends DescribeCodeCoverage /** *

Retrieves one or more code coverage reports.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { CodeBuildClient, DescribeCodeCoveragesCommand } from "@aws-sdk/client-codebuild"; // ES Modules import + * // const { CodeBuildClient, DescribeCodeCoveragesCommand } = require("@aws-sdk/client-codebuild"); // CommonJS import + * const client = new CodeBuildClient(config); + * const command = new DescribeCodeCoveragesCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeCodeCoveragesCommandInput} for command's `input` shape. + * @see {@link DescribeCodeCoveragesCommandOutput} for command's `response` shape. + * @see {@link CodeBuildClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeCodeCoveragesCommand extends $Command< DescribeCodeCoveragesCommandInput, diff --git a/clients/client-codebuild/commands/DescribeTestCasesCommand.ts b/clients/client-codebuild/commands/DescribeTestCasesCommand.ts index 8e21b3c40208..16418356e3e0 100644 --- a/clients/client-codebuild/commands/DescribeTestCasesCommand.ts +++ b/clients/client-codebuild/commands/DescribeTestCasesCommand.ts @@ -24,6 +24,20 @@ export interface DescribeTestCasesCommandOutput extends DescribeTestCasesOutput, *

* Returns a list of details about test cases for a report. *

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { CodeBuildClient, DescribeTestCasesCommand } from "@aws-sdk/client-codebuild"; // ES Modules import + * // const { CodeBuildClient, DescribeTestCasesCommand } = require("@aws-sdk/client-codebuild"); // CommonJS import + * const client = new CodeBuildClient(config); + * const command = new DescribeTestCasesCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeTestCasesCommandInput} for command's `input` shape. + * @see {@link DescribeTestCasesCommandOutput} for command's `response` shape. + * @see {@link CodeBuildClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeTestCasesCommand extends $Command< DescribeTestCasesCommandInput, diff --git a/clients/client-codebuild/commands/GetReportGroupTrendCommand.ts b/clients/client-codebuild/commands/GetReportGroupTrendCommand.ts index 693cb4905b13..1b2113881a98 100644 --- a/clients/client-codebuild/commands/GetReportGroupTrendCommand.ts +++ b/clients/client-codebuild/commands/GetReportGroupTrendCommand.ts @@ -22,6 +22,20 @@ export interface GetReportGroupTrendCommandOutput extends GetReportGroupTrendOut /** *

Analyzes and accumulates test report values for the specified test reports.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { CodeBuildClient, GetReportGroupTrendCommand } from "@aws-sdk/client-codebuild"; // ES Modules import + * // const { CodeBuildClient, GetReportGroupTrendCommand } = require("@aws-sdk/client-codebuild"); // CommonJS import + * const client = new CodeBuildClient(config); + * const command = new GetReportGroupTrendCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetReportGroupTrendCommandInput} for command's `input` shape. + * @see {@link GetReportGroupTrendCommandOutput} for command's `response` shape. + * @see {@link CodeBuildClientResolvedConfig | config} for command's `input` shape. + * */ export class GetReportGroupTrendCommand extends $Command< GetReportGroupTrendCommandInput, diff --git a/clients/client-codebuild/commands/GetResourcePolicyCommand.ts b/clients/client-codebuild/commands/GetResourcePolicyCommand.ts index c4ff167c0f71..8e29f92b1f04 100644 --- a/clients/client-codebuild/commands/GetResourcePolicyCommand.ts +++ b/clients/client-codebuild/commands/GetResourcePolicyCommand.ts @@ -22,6 +22,20 @@ export interface GetResourcePolicyCommandOutput extends GetResourcePolicyOutput, /** *

Gets a resource policy that is identified by its resource ARN.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { CodeBuildClient, GetResourcePolicyCommand } from "@aws-sdk/client-codebuild"; // ES Modules import + * // const { CodeBuildClient, GetResourcePolicyCommand } = require("@aws-sdk/client-codebuild"); // CommonJS import + * const client = new CodeBuildClient(config); + * const command = new GetResourcePolicyCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetResourcePolicyCommandInput} for command's `input` shape. + * @see {@link GetResourcePolicyCommandOutput} for command's `response` shape. + * @see {@link CodeBuildClientResolvedConfig | config} for command's `input` shape. + * */ export class GetResourcePolicyCommand extends $Command< GetResourcePolicyCommandInput, diff --git a/clients/client-codebuild/commands/ImportSourceCredentialsCommand.ts b/clients/client-codebuild/commands/ImportSourceCredentialsCommand.ts index 6e95a5dcd168..3263aff2822e 100644 --- a/clients/client-codebuild/commands/ImportSourceCredentialsCommand.ts +++ b/clients/client-codebuild/commands/ImportSourceCredentialsCommand.ts @@ -23,6 +23,20 @@ export interface ImportSourceCredentialsCommandOutput extends ImportSourceCreden /** *

Imports the source repository credentials for an AWS CodeBuild project that has its * source code stored in a GitHub, GitHub Enterprise, or Bitbucket repository.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { CodeBuildClient, ImportSourceCredentialsCommand } from "@aws-sdk/client-codebuild"; // ES Modules import + * // const { CodeBuildClient, ImportSourceCredentialsCommand } = require("@aws-sdk/client-codebuild"); // CommonJS import + * const client = new CodeBuildClient(config); + * const command = new ImportSourceCredentialsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ImportSourceCredentialsCommandInput} for command's `input` shape. + * @see {@link ImportSourceCredentialsCommandOutput} for command's `response` shape. + * @see {@link CodeBuildClientResolvedConfig | config} for command's `input` shape. + * */ export class ImportSourceCredentialsCommand extends $Command< ImportSourceCredentialsCommandInput, diff --git a/clients/client-codebuild/commands/InvalidateProjectCacheCommand.ts b/clients/client-codebuild/commands/InvalidateProjectCacheCommand.ts index d5f739a14d6a..bf5af15bb8ba 100644 --- a/clients/client-codebuild/commands/InvalidateProjectCacheCommand.ts +++ b/clients/client-codebuild/commands/InvalidateProjectCacheCommand.ts @@ -22,6 +22,20 @@ export interface InvalidateProjectCacheCommandOutput extends InvalidateProjectCa /** *

Resets the cache for a project.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { CodeBuildClient, InvalidateProjectCacheCommand } from "@aws-sdk/client-codebuild"; // ES Modules import + * // const { CodeBuildClient, InvalidateProjectCacheCommand } = require("@aws-sdk/client-codebuild"); // CommonJS import + * const client = new CodeBuildClient(config); + * const command = new InvalidateProjectCacheCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link InvalidateProjectCacheCommandInput} for command's `input` shape. + * @see {@link InvalidateProjectCacheCommandOutput} for command's `response` shape. + * @see {@link CodeBuildClientResolvedConfig | config} for command's `input` shape. + * */ export class InvalidateProjectCacheCommand extends $Command< InvalidateProjectCacheCommandInput, diff --git a/clients/client-codebuild/commands/ListBuildBatchesCommand.ts b/clients/client-codebuild/commands/ListBuildBatchesCommand.ts index 8e1d220c5390..202701f4bdd0 100644 --- a/clients/client-codebuild/commands/ListBuildBatchesCommand.ts +++ b/clients/client-codebuild/commands/ListBuildBatchesCommand.ts @@ -22,6 +22,20 @@ export interface ListBuildBatchesCommandOutput extends ListBuildBatchesOutput, _ /** *

Retrieves the identifiers of your build batches in the current region.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { CodeBuildClient, ListBuildBatchesCommand } from "@aws-sdk/client-codebuild"; // ES Modules import + * // const { CodeBuildClient, ListBuildBatchesCommand } = require("@aws-sdk/client-codebuild"); // CommonJS import + * const client = new CodeBuildClient(config); + * const command = new ListBuildBatchesCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListBuildBatchesCommandInput} for command's `input` shape. + * @see {@link ListBuildBatchesCommandOutput} for command's `response` shape. + * @see {@link CodeBuildClientResolvedConfig | config} for command's `input` shape. + * */ export class ListBuildBatchesCommand extends $Command< ListBuildBatchesCommandInput, diff --git a/clients/client-codebuild/commands/ListBuildBatchesForProjectCommand.ts b/clients/client-codebuild/commands/ListBuildBatchesForProjectCommand.ts index 0100a58e2809..76492bfaa5fb 100644 --- a/clients/client-codebuild/commands/ListBuildBatchesForProjectCommand.ts +++ b/clients/client-codebuild/commands/ListBuildBatchesForProjectCommand.ts @@ -22,6 +22,20 @@ export interface ListBuildBatchesForProjectCommandOutput extends ListBuildBatche /** *

Retrieves the identifiers of the build batches for a specific project.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { CodeBuildClient, ListBuildBatchesForProjectCommand } from "@aws-sdk/client-codebuild"; // ES Modules import + * // const { CodeBuildClient, ListBuildBatchesForProjectCommand } = require("@aws-sdk/client-codebuild"); // CommonJS import + * const client = new CodeBuildClient(config); + * const command = new ListBuildBatchesForProjectCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListBuildBatchesForProjectCommandInput} for command's `input` shape. + * @see {@link ListBuildBatchesForProjectCommandOutput} for command's `response` shape. + * @see {@link CodeBuildClientResolvedConfig | config} for command's `input` shape. + * */ export class ListBuildBatchesForProjectCommand extends $Command< ListBuildBatchesForProjectCommandInput, diff --git a/clients/client-codebuild/commands/ListBuildsCommand.ts b/clients/client-codebuild/commands/ListBuildsCommand.ts index e5d4b1e4040e..3cf8fc41bcff 100644 --- a/clients/client-codebuild/commands/ListBuildsCommand.ts +++ b/clients/client-codebuild/commands/ListBuildsCommand.ts @@ -22,6 +22,20 @@ export interface ListBuildsCommandOutput extends ListBuildsOutput, __MetadataBea /** *

Gets a list of build IDs, with each build ID representing a single build.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { CodeBuildClient, ListBuildsCommand } from "@aws-sdk/client-codebuild"; // ES Modules import + * // const { CodeBuildClient, ListBuildsCommand } = require("@aws-sdk/client-codebuild"); // CommonJS import + * const client = new CodeBuildClient(config); + * const command = new ListBuildsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListBuildsCommandInput} for command's `input` shape. + * @see {@link ListBuildsCommandOutput} for command's `response` shape. + * @see {@link CodeBuildClientResolvedConfig | config} for command's `input` shape. + * */ export class ListBuildsCommand extends $Command< ListBuildsCommandInput, diff --git a/clients/client-codebuild/commands/ListBuildsForProjectCommand.ts b/clients/client-codebuild/commands/ListBuildsForProjectCommand.ts index f5611cda9cfb..3a923c45124b 100644 --- a/clients/client-codebuild/commands/ListBuildsForProjectCommand.ts +++ b/clients/client-codebuild/commands/ListBuildsForProjectCommand.ts @@ -23,6 +23,20 @@ export interface ListBuildsForProjectCommandOutput extends ListBuildsForProjectO /** *

Gets a list of build identifiers for the specified build project, with each build * identifier representing a single build.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { CodeBuildClient, ListBuildsForProjectCommand } from "@aws-sdk/client-codebuild"; // ES Modules import + * // const { CodeBuildClient, ListBuildsForProjectCommand } = require("@aws-sdk/client-codebuild"); // CommonJS import + * const client = new CodeBuildClient(config); + * const command = new ListBuildsForProjectCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListBuildsForProjectCommandInput} for command's `input` shape. + * @see {@link ListBuildsForProjectCommandOutput} for command's `response` shape. + * @see {@link CodeBuildClientResolvedConfig | config} for command's `input` shape. + * */ export class ListBuildsForProjectCommand extends $Command< ListBuildsForProjectCommandInput, diff --git a/clients/client-codebuild/commands/ListCuratedEnvironmentImagesCommand.ts b/clients/client-codebuild/commands/ListCuratedEnvironmentImagesCommand.ts index b07f911a2fc2..ee732a3e8266 100644 --- a/clients/client-codebuild/commands/ListCuratedEnvironmentImagesCommand.ts +++ b/clients/client-codebuild/commands/ListCuratedEnvironmentImagesCommand.ts @@ -24,6 +24,20 @@ export interface ListCuratedEnvironmentImagesCommandOutput /** *

Gets information about Docker images that are managed by AWS CodeBuild.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { CodeBuildClient, ListCuratedEnvironmentImagesCommand } from "@aws-sdk/client-codebuild"; // ES Modules import + * // const { CodeBuildClient, ListCuratedEnvironmentImagesCommand } = require("@aws-sdk/client-codebuild"); // CommonJS import + * const client = new CodeBuildClient(config); + * const command = new ListCuratedEnvironmentImagesCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListCuratedEnvironmentImagesCommandInput} for command's `input` shape. + * @see {@link ListCuratedEnvironmentImagesCommandOutput} for command's `response` shape. + * @see {@link CodeBuildClientResolvedConfig | config} for command's `input` shape. + * */ export class ListCuratedEnvironmentImagesCommand extends $Command< ListCuratedEnvironmentImagesCommandInput, diff --git a/clients/client-codebuild/commands/ListProjectsCommand.ts b/clients/client-codebuild/commands/ListProjectsCommand.ts index 7ef5b38484c2..75718f3f3906 100644 --- a/clients/client-codebuild/commands/ListProjectsCommand.ts +++ b/clients/client-codebuild/commands/ListProjectsCommand.ts @@ -23,6 +23,20 @@ export interface ListProjectsCommandOutput extends ListProjectsOutput, __Metadat /** *

Gets a list of build project names, with each build project name representing a single * build project.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { CodeBuildClient, ListProjectsCommand } from "@aws-sdk/client-codebuild"; // ES Modules import + * // const { CodeBuildClient, ListProjectsCommand } = require("@aws-sdk/client-codebuild"); // CommonJS import + * const client = new CodeBuildClient(config); + * const command = new ListProjectsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListProjectsCommandInput} for command's `input` shape. + * @see {@link ListProjectsCommandOutput} for command's `response` shape. + * @see {@link CodeBuildClientResolvedConfig | config} for command's `input` shape. + * */ export class ListProjectsCommand extends $Command< ListProjectsCommandInput, diff --git a/clients/client-codebuild/commands/ListReportGroupsCommand.ts b/clients/client-codebuild/commands/ListReportGroupsCommand.ts index 040ad02156fd..65b2d270ee68 100644 --- a/clients/client-codebuild/commands/ListReportGroupsCommand.ts +++ b/clients/client-codebuild/commands/ListReportGroupsCommand.ts @@ -24,6 +24,20 @@ export interface ListReportGroupsCommandOutput extends ListReportGroupsOutput, _ *

* Gets a list ARNs for the report groups in the current AWS account. *

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { CodeBuildClient, ListReportGroupsCommand } from "@aws-sdk/client-codebuild"; // ES Modules import + * // const { CodeBuildClient, ListReportGroupsCommand } = require("@aws-sdk/client-codebuild"); // CommonJS import + * const client = new CodeBuildClient(config); + * const command = new ListReportGroupsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListReportGroupsCommandInput} for command's `input` shape. + * @see {@link ListReportGroupsCommandOutput} for command's `response` shape. + * @see {@link CodeBuildClientResolvedConfig | config} for command's `input` shape. + * */ export class ListReportGroupsCommand extends $Command< ListReportGroupsCommandInput, diff --git a/clients/client-codebuild/commands/ListReportsCommand.ts b/clients/client-codebuild/commands/ListReportsCommand.ts index e1a19327bbee..b66e1931fc84 100644 --- a/clients/client-codebuild/commands/ListReportsCommand.ts +++ b/clients/client-codebuild/commands/ListReportsCommand.ts @@ -24,6 +24,20 @@ export interface ListReportsCommandOutput extends ListReportsOutput, __MetadataB *

* Returns a list of ARNs for the reports in the current AWS account. *

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { CodeBuildClient, ListReportsCommand } from "@aws-sdk/client-codebuild"; // ES Modules import + * // const { CodeBuildClient, ListReportsCommand } = require("@aws-sdk/client-codebuild"); // CommonJS import + * const client = new CodeBuildClient(config); + * const command = new ListReportsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListReportsCommandInput} for command's `input` shape. + * @see {@link ListReportsCommandOutput} for command's `response` shape. + * @see {@link CodeBuildClientResolvedConfig | config} for command's `input` shape. + * */ export class ListReportsCommand extends $Command< ListReportsCommandInput, diff --git a/clients/client-codebuild/commands/ListReportsForReportGroupCommand.ts b/clients/client-codebuild/commands/ListReportsForReportGroupCommand.ts index ddae577b8fc8..4e0c445b28a4 100644 --- a/clients/client-codebuild/commands/ListReportsForReportGroupCommand.ts +++ b/clients/client-codebuild/commands/ListReportsForReportGroupCommand.ts @@ -24,6 +24,20 @@ export interface ListReportsForReportGroupCommandOutput extends ListReportsForRe *

* Returns a list of ARNs for the reports that belong to a ReportGroup. *

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { CodeBuildClient, ListReportsForReportGroupCommand } from "@aws-sdk/client-codebuild"; // ES Modules import + * // const { CodeBuildClient, ListReportsForReportGroupCommand } = require("@aws-sdk/client-codebuild"); // CommonJS import + * const client = new CodeBuildClient(config); + * const command = new ListReportsForReportGroupCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListReportsForReportGroupCommandInput} for command's `input` shape. + * @see {@link ListReportsForReportGroupCommandOutput} for command's `response` shape. + * @see {@link CodeBuildClientResolvedConfig | config} for command's `input` shape. + * */ export class ListReportsForReportGroupCommand extends $Command< ListReportsForReportGroupCommandInput, diff --git a/clients/client-codebuild/commands/ListSharedProjectsCommand.ts b/clients/client-codebuild/commands/ListSharedProjectsCommand.ts index fee65db4bff1..f88c98324910 100644 --- a/clients/client-codebuild/commands/ListSharedProjectsCommand.ts +++ b/clients/client-codebuild/commands/ListSharedProjectsCommand.ts @@ -22,6 +22,20 @@ export interface ListSharedProjectsCommandOutput extends ListSharedProjectsOutpu /** *

Gets a list of projects that are shared with other AWS accounts or users.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { CodeBuildClient, ListSharedProjectsCommand } from "@aws-sdk/client-codebuild"; // ES Modules import + * // const { CodeBuildClient, ListSharedProjectsCommand } = require("@aws-sdk/client-codebuild"); // CommonJS import + * const client = new CodeBuildClient(config); + * const command = new ListSharedProjectsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListSharedProjectsCommandInput} for command's `input` shape. + * @see {@link ListSharedProjectsCommandOutput} for command's `response` shape. + * @see {@link CodeBuildClientResolvedConfig | config} for command's `input` shape. + * */ export class ListSharedProjectsCommand extends $Command< ListSharedProjectsCommandInput, diff --git a/clients/client-codebuild/commands/ListSharedReportGroupsCommand.ts b/clients/client-codebuild/commands/ListSharedReportGroupsCommand.ts index 4d637f1ab5ea..01479908166b 100644 --- a/clients/client-codebuild/commands/ListSharedReportGroupsCommand.ts +++ b/clients/client-codebuild/commands/ListSharedReportGroupsCommand.ts @@ -23,6 +23,20 @@ export interface ListSharedReportGroupsCommandOutput extends ListSharedReportGro /** *

Gets a list of report groups that are shared with other AWS accounts or users. *

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { CodeBuildClient, ListSharedReportGroupsCommand } from "@aws-sdk/client-codebuild"; // ES Modules import + * // const { CodeBuildClient, ListSharedReportGroupsCommand } = require("@aws-sdk/client-codebuild"); // CommonJS import + * const client = new CodeBuildClient(config); + * const command = new ListSharedReportGroupsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListSharedReportGroupsCommandInput} for command's `input` shape. + * @see {@link ListSharedReportGroupsCommandOutput} for command's `response` shape. + * @see {@link CodeBuildClientResolvedConfig | config} for command's `input` shape. + * */ export class ListSharedReportGroupsCommand extends $Command< ListSharedReportGroupsCommandInput, diff --git a/clients/client-codebuild/commands/ListSourceCredentialsCommand.ts b/clients/client-codebuild/commands/ListSourceCredentialsCommand.ts index f5de45b4a30c..3f0604b5af6f 100644 --- a/clients/client-codebuild/commands/ListSourceCredentialsCommand.ts +++ b/clients/client-codebuild/commands/ListSourceCredentialsCommand.ts @@ -22,6 +22,20 @@ export interface ListSourceCredentialsCommandOutput extends ListSourceCredential /** *

Returns a list of SourceCredentialsInfo objects.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { CodeBuildClient, ListSourceCredentialsCommand } from "@aws-sdk/client-codebuild"; // ES Modules import + * // const { CodeBuildClient, ListSourceCredentialsCommand } = require("@aws-sdk/client-codebuild"); // CommonJS import + * const client = new CodeBuildClient(config); + * const command = new ListSourceCredentialsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListSourceCredentialsCommandInput} for command's `input` shape. + * @see {@link ListSourceCredentialsCommandOutput} for command's `response` shape. + * @see {@link CodeBuildClientResolvedConfig | config} for command's `input` shape. + * */ export class ListSourceCredentialsCommand extends $Command< ListSourceCredentialsCommandInput, diff --git a/clients/client-codebuild/commands/PutResourcePolicyCommand.ts b/clients/client-codebuild/commands/PutResourcePolicyCommand.ts index be3d4e82c831..1ce44234a656 100644 --- a/clients/client-codebuild/commands/PutResourcePolicyCommand.ts +++ b/clients/client-codebuild/commands/PutResourcePolicyCommand.ts @@ -23,6 +23,20 @@ export interface PutResourcePolicyCommandOutput extends PutResourcePolicyOutput, /** *

Stores a resource policy for the ARN of a Project or * ReportGroup object.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { CodeBuildClient, PutResourcePolicyCommand } from "@aws-sdk/client-codebuild"; // ES Modules import + * // const { CodeBuildClient, PutResourcePolicyCommand } = require("@aws-sdk/client-codebuild"); // CommonJS import + * const client = new CodeBuildClient(config); + * const command = new PutResourcePolicyCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link PutResourcePolicyCommandInput} for command's `input` shape. + * @see {@link PutResourcePolicyCommandOutput} for command's `response` shape. + * @see {@link CodeBuildClientResolvedConfig | config} for command's `input` shape. + * */ export class PutResourcePolicyCommand extends $Command< PutResourcePolicyCommandInput, diff --git a/clients/client-codebuild/commands/RetryBuildBatchCommand.ts b/clients/client-codebuild/commands/RetryBuildBatchCommand.ts index 7bcb718f60ca..a697d1060207 100644 --- a/clients/client-codebuild/commands/RetryBuildBatchCommand.ts +++ b/clients/client-codebuild/commands/RetryBuildBatchCommand.ts @@ -22,6 +22,20 @@ export interface RetryBuildBatchCommandOutput extends RetryBuildBatchOutput, __M /** *

Restarts a failed batch build. Only batch builds that have failed can be retried.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { CodeBuildClient, RetryBuildBatchCommand } from "@aws-sdk/client-codebuild"; // ES Modules import + * // const { CodeBuildClient, RetryBuildBatchCommand } = require("@aws-sdk/client-codebuild"); // CommonJS import + * const client = new CodeBuildClient(config); + * const command = new RetryBuildBatchCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link RetryBuildBatchCommandInput} for command's `input` shape. + * @see {@link RetryBuildBatchCommandOutput} for command's `response` shape. + * @see {@link CodeBuildClientResolvedConfig | config} for command's `input` shape. + * */ export class RetryBuildBatchCommand extends $Command< RetryBuildBatchCommandInput, diff --git a/clients/client-codebuild/commands/RetryBuildCommand.ts b/clients/client-codebuild/commands/RetryBuildCommand.ts index 8cd613e96a06..8748f132eba4 100644 --- a/clients/client-codebuild/commands/RetryBuildCommand.ts +++ b/clients/client-codebuild/commands/RetryBuildCommand.ts @@ -22,6 +22,20 @@ export interface RetryBuildCommandOutput extends RetryBuildOutput, __MetadataBea /** *

Restarts a build.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { CodeBuildClient, RetryBuildCommand } from "@aws-sdk/client-codebuild"; // ES Modules import + * // const { CodeBuildClient, RetryBuildCommand } = require("@aws-sdk/client-codebuild"); // CommonJS import + * const client = new CodeBuildClient(config); + * const command = new RetryBuildCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link RetryBuildCommandInput} for command's `input` shape. + * @see {@link RetryBuildCommandOutput} for command's `response` shape. + * @see {@link CodeBuildClientResolvedConfig | config} for command's `input` shape. + * */ export class RetryBuildCommand extends $Command< RetryBuildCommandInput, diff --git a/clients/client-codebuild/commands/StartBuildBatchCommand.ts b/clients/client-codebuild/commands/StartBuildBatchCommand.ts index 9916f6247a51..f6bf1e90b338 100644 --- a/clients/client-codebuild/commands/StartBuildBatchCommand.ts +++ b/clients/client-codebuild/commands/StartBuildBatchCommand.ts @@ -22,6 +22,20 @@ export interface StartBuildBatchCommandOutput extends StartBuildBatchOutput, __M /** *

Starts a batch build for a project.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { CodeBuildClient, StartBuildBatchCommand } from "@aws-sdk/client-codebuild"; // ES Modules import + * // const { CodeBuildClient, StartBuildBatchCommand } = require("@aws-sdk/client-codebuild"); // CommonJS import + * const client = new CodeBuildClient(config); + * const command = new StartBuildBatchCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link StartBuildBatchCommandInput} for command's `input` shape. + * @see {@link StartBuildBatchCommandOutput} for command's `response` shape. + * @see {@link CodeBuildClientResolvedConfig | config} for command's `input` shape. + * */ export class StartBuildBatchCommand extends $Command< StartBuildBatchCommandInput, diff --git a/clients/client-codebuild/commands/StartBuildCommand.ts b/clients/client-codebuild/commands/StartBuildCommand.ts index 4ca8e1261d1a..6bfb50fd2516 100644 --- a/clients/client-codebuild/commands/StartBuildCommand.ts +++ b/clients/client-codebuild/commands/StartBuildCommand.ts @@ -22,6 +22,20 @@ export interface StartBuildCommandOutput extends StartBuildOutput, __MetadataBea /** *

Starts running a build.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { CodeBuildClient, StartBuildCommand } from "@aws-sdk/client-codebuild"; // ES Modules import + * // const { CodeBuildClient, StartBuildCommand } = require("@aws-sdk/client-codebuild"); // CommonJS import + * const client = new CodeBuildClient(config); + * const command = new StartBuildCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link StartBuildCommandInput} for command's `input` shape. + * @see {@link StartBuildCommandOutput} for command's `response` shape. + * @see {@link CodeBuildClientResolvedConfig | config} for command's `input` shape. + * */ export class StartBuildCommand extends $Command< StartBuildCommandInput, diff --git a/clients/client-codebuild/commands/StopBuildBatchCommand.ts b/clients/client-codebuild/commands/StopBuildBatchCommand.ts index 94ea41353edb..1587facb644d 100644 --- a/clients/client-codebuild/commands/StopBuildBatchCommand.ts +++ b/clients/client-codebuild/commands/StopBuildBatchCommand.ts @@ -22,6 +22,20 @@ export interface StopBuildBatchCommandOutput extends StopBuildBatchOutput, __Met /** *

Stops a running batch build.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { CodeBuildClient, StopBuildBatchCommand } from "@aws-sdk/client-codebuild"; // ES Modules import + * // const { CodeBuildClient, StopBuildBatchCommand } = require("@aws-sdk/client-codebuild"); // CommonJS import + * const client = new CodeBuildClient(config); + * const command = new StopBuildBatchCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link StopBuildBatchCommandInput} for command's `input` shape. + * @see {@link StopBuildBatchCommandOutput} for command's `response` shape. + * @see {@link CodeBuildClientResolvedConfig | config} for command's `input` shape. + * */ export class StopBuildBatchCommand extends $Command< StopBuildBatchCommandInput, diff --git a/clients/client-codebuild/commands/StopBuildCommand.ts b/clients/client-codebuild/commands/StopBuildCommand.ts index a22c74f9db36..321af2cb2dc5 100644 --- a/clients/client-codebuild/commands/StopBuildCommand.ts +++ b/clients/client-codebuild/commands/StopBuildCommand.ts @@ -19,6 +19,20 @@ export interface StopBuildCommandOutput extends StopBuildOutput, __MetadataBeare /** *

Attempts to stop running a build.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { CodeBuildClient, StopBuildCommand } from "@aws-sdk/client-codebuild"; // ES Modules import + * // const { CodeBuildClient, StopBuildCommand } = require("@aws-sdk/client-codebuild"); // CommonJS import + * const client = new CodeBuildClient(config); + * const command = new StopBuildCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link StopBuildCommandInput} for command's `input` shape. + * @see {@link StopBuildCommandOutput} for command's `response` shape. + * @see {@link CodeBuildClientResolvedConfig | config} for command's `input` shape. + * */ export class StopBuildCommand extends $Command< StopBuildCommandInput, diff --git a/clients/client-codebuild/commands/UpdateProjectCommand.ts b/clients/client-codebuild/commands/UpdateProjectCommand.ts index c03f4e883072..37867f353987 100644 --- a/clients/client-codebuild/commands/UpdateProjectCommand.ts +++ b/clients/client-codebuild/commands/UpdateProjectCommand.ts @@ -22,6 +22,20 @@ export interface UpdateProjectCommandOutput extends UpdateProjectOutput, __Metad /** *

Changes the settings of a build project.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { CodeBuildClient, UpdateProjectCommand } from "@aws-sdk/client-codebuild"; // ES Modules import + * // const { CodeBuildClient, UpdateProjectCommand } = require("@aws-sdk/client-codebuild"); // CommonJS import + * const client = new CodeBuildClient(config); + * const command = new UpdateProjectCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link UpdateProjectCommandInput} for command's `input` shape. + * @see {@link UpdateProjectCommandOutput} for command's `response` shape. + * @see {@link CodeBuildClientResolvedConfig | config} for command's `input` shape. + * */ export class UpdateProjectCommand extends $Command< UpdateProjectCommandInput, diff --git a/clients/client-codebuild/commands/UpdateReportGroupCommand.ts b/clients/client-codebuild/commands/UpdateReportGroupCommand.ts index 22829cff21bc..8b69bc7e2b1e 100644 --- a/clients/client-codebuild/commands/UpdateReportGroupCommand.ts +++ b/clients/client-codebuild/commands/UpdateReportGroupCommand.ts @@ -24,6 +24,20 @@ export interface UpdateReportGroupCommandOutput extends UpdateReportGroupOutput, *

* Updates a report group. *

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { CodeBuildClient, UpdateReportGroupCommand } from "@aws-sdk/client-codebuild"; // ES Modules import + * // const { CodeBuildClient, UpdateReportGroupCommand } = require("@aws-sdk/client-codebuild"); // CommonJS import + * const client = new CodeBuildClient(config); + * const command = new UpdateReportGroupCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link UpdateReportGroupCommandInput} for command's `input` shape. + * @see {@link UpdateReportGroupCommandOutput} for command's `response` shape. + * @see {@link CodeBuildClientResolvedConfig | config} for command's `input` shape. + * */ export class UpdateReportGroupCommand extends $Command< UpdateReportGroupCommandInput, diff --git a/clients/client-codebuild/commands/UpdateWebhookCommand.ts b/clients/client-codebuild/commands/UpdateWebhookCommand.ts index 210ca5896b55..901ae0ffb4df 100644 --- a/clients/client-codebuild/commands/UpdateWebhookCommand.ts +++ b/clients/client-codebuild/commands/UpdateWebhookCommand.ts @@ -26,6 +26,20 @@ export interface UpdateWebhookCommandOutput extends UpdateWebhookOutput, __Metad *

If you use Bitbucket for your repository, rotateSecret is ignored. *

* + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { CodeBuildClient, UpdateWebhookCommand } from "@aws-sdk/client-codebuild"; // ES Modules import + * // const { CodeBuildClient, UpdateWebhookCommand } = require("@aws-sdk/client-codebuild"); // CommonJS import + * const client = new CodeBuildClient(config); + * const command = new UpdateWebhookCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link UpdateWebhookCommandInput} for command's `input` shape. + * @see {@link UpdateWebhookCommandOutput} for command's `response` shape. + * @see {@link CodeBuildClientResolvedConfig | config} for command's `input` shape. + * */ export class UpdateWebhookCommand extends $Command< UpdateWebhookCommandInput, diff --git a/clients/client-codebuild/models/models_0.ts b/clients/client-codebuild/models/models_0.ts index 5e3e4b141b5a..94550b679dbc 100644 --- a/clients/client-codebuild/models/models_0.ts +++ b/clients/client-codebuild/models/models_0.ts @@ -11,6 +11,9 @@ export interface AccountLimitExceededException extends __SmithyException, $Metad } export namespace AccountLimitExceededException { + /** + * @internal + */ export const filterSensitiveLog = (obj: AccountLimitExceededException): any => ({ ...obj, }); @@ -46,6 +49,9 @@ export interface BatchDeleteBuildsInput { } export namespace BatchDeleteBuildsInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: BatchDeleteBuildsInput): any => ({ ...obj, }); @@ -67,6 +73,9 @@ export interface BuildNotDeleted { } export namespace BuildNotDeleted { + /** + * @internal + */ export const filterSensitiveLog = (obj: BuildNotDeleted): any => ({ ...obj, }); @@ -85,6 +94,9 @@ export interface BatchDeleteBuildsOutput { } export namespace BatchDeleteBuildsOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: BatchDeleteBuildsOutput): any => ({ ...obj, }); @@ -100,6 +112,9 @@ export interface InvalidInputException extends __SmithyException, $MetadataBeare } export namespace InvalidInputException { + /** + * @internal + */ export const filterSensitiveLog = (obj: InvalidInputException): any => ({ ...obj, }); @@ -113,6 +128,9 @@ export interface BatchGetBuildBatchesInput { } export namespace BatchGetBuildBatchesInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: BatchGetBuildBatchesInput): any => ({ ...obj, }); @@ -216,6 +234,9 @@ export interface BuildArtifacts { } export namespace BuildArtifacts { + /** + * @internal + */ export const filterSensitiveLog = (obj: BuildArtifacts): any => ({ ...obj, }); @@ -240,6 +261,9 @@ export interface BatchRestrictions { } export namespace BatchRestrictions { + /** + * @internal + */ export const filterSensitiveLog = (obj: BatchRestrictions): any => ({ ...obj, }); @@ -273,6 +297,9 @@ export interface ProjectBuildBatchConfig { } export namespace ProjectBuildBatchConfig { + /** + * @internal + */ export const filterSensitiveLog = (obj: ProjectBuildBatchConfig): any => ({ ...obj, }); @@ -309,6 +336,9 @@ export interface ResolvedArtifact { } export namespace ResolvedArtifact { + /** + * @internal + */ export const filterSensitiveLog = (obj: ResolvedArtifact): any => ({ ...obj, }); @@ -373,6 +403,9 @@ export interface BuildSummary { } export namespace BuildSummary { + /** + * @internal + */ export const filterSensitiveLog = (obj: BuildSummary): any => ({ ...obj, }); @@ -414,6 +447,9 @@ export interface BuildGroup { } export namespace BuildGroup { + /** + * @internal + */ export const filterSensitiveLog = (obj: BuildGroup): any => ({ ...obj, }); @@ -534,6 +570,9 @@ export interface ProjectCache { } export namespace ProjectCache { + /** + * @internal + */ export const filterSensitiveLog = (obj: ProjectCache): any => ({ ...obj, }); @@ -602,6 +641,9 @@ export interface EnvironmentVariable { } export namespace EnvironmentVariable { + /** + * @internal + */ export const filterSensitiveLog = (obj: EnvironmentVariable): any => ({ ...obj, }); @@ -650,6 +692,9 @@ export interface RegistryCredential { } export namespace RegistryCredential { + /** + * @internal + */ export const filterSensitiveLog = (obj: RegistryCredential): any => ({ ...obj, }); @@ -830,6 +875,9 @@ export interface ProjectEnvironment { } export namespace ProjectEnvironment { + /** + * @internal + */ export const filterSensitiveLog = (obj: ProjectEnvironment): any => ({ ...obj, }); @@ -891,6 +939,9 @@ export interface ProjectFileSystemLocation { } export namespace ProjectFileSystemLocation { + /** + * @internal + */ export const filterSensitiveLog = (obj: ProjectFileSystemLocation): any => ({ ...obj, }); @@ -934,6 +985,9 @@ export interface CloudWatchLogsConfig { } export namespace CloudWatchLogsConfig { + /** + * @internal + */ export const filterSensitiveLog = (obj: CloudWatchLogsConfig): any => ({ ...obj, }); @@ -1016,6 +1070,9 @@ export interface S3LogsConfig { } export namespace S3LogsConfig { + /** + * @internal + */ export const filterSensitiveLog = (obj: S3LogsConfig): any => ({ ...obj, }); @@ -1039,6 +1096,9 @@ export interface LogsConfig { } export namespace LogsConfig { + /** + * @internal + */ export const filterSensitiveLog = (obj: LogsConfig): any => ({ ...obj, }); @@ -1062,6 +1122,9 @@ export interface PhaseContext { } export namespace PhaseContext { + /** + * @internal + */ export const filterSensitiveLog = (obj: PhaseContext): any => ({ ...obj, }); @@ -1177,6 +1240,9 @@ export interface BuildBatchPhase { } export namespace BuildBatchPhase { + /** + * @internal + */ export const filterSensitiveLog = (obj: BuildBatchPhase): any => ({ ...obj, }); @@ -1209,6 +1275,9 @@ export interface SourceAuth { } export namespace SourceAuth { + /** + * @internal + */ export const filterSensitiveLog = (obj: SourceAuth): any => ({ ...obj, }); @@ -1257,6 +1326,9 @@ export interface BuildStatusConfig { } export namespace BuildStatusConfig { + /** + * @internal + */ export const filterSensitiveLog = (obj: BuildStatusConfig): any => ({ ...obj, }); @@ -1274,6 +1346,9 @@ export interface GitSubmodulesConfig { } export namespace GitSubmodulesConfig { + /** + * @internal + */ export const filterSensitiveLog = (obj: GitSubmodulesConfig): any => ({ ...obj, }); @@ -1458,6 +1533,9 @@ export interface ProjectSource { } export namespace ProjectSource { + /** + * @internal + */ export const filterSensitiveLog = (obj: ProjectSource): any => ({ ...obj, }); @@ -1506,6 +1584,9 @@ export interface ProjectSourceVersion { } export namespace ProjectSourceVersion { + /** + * @internal + */ export const filterSensitiveLog = (obj: ProjectSourceVersion): any => ({ ...obj, }); @@ -1532,6 +1613,9 @@ export interface VpcConfig { } export namespace VpcConfig { + /** + * @internal + */ export const filterSensitiveLog = (obj: VpcConfig): any => ({ ...obj, }); @@ -1763,6 +1847,9 @@ export interface BuildBatch { } export namespace BuildBatch { + /** + * @internal + */ export const filterSensitiveLog = (obj: BuildBatch): any => ({ ...obj, }); @@ -1782,6 +1869,9 @@ export interface BatchGetBuildBatchesOutput { } export namespace BatchGetBuildBatchesOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: BatchGetBuildBatchesOutput): any => ({ ...obj, }); @@ -1795,6 +1885,9 @@ export interface BatchGetBuildsInput { } export namespace BatchGetBuildsInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: BatchGetBuildsInput): any => ({ ...obj, }); @@ -1819,6 +1912,9 @@ export interface DebugSession { } export namespace DebugSession { + /** + * @internal + */ export const filterSensitiveLog = (obj: DebugSession): any => ({ ...obj, }); @@ -1850,6 +1946,9 @@ export interface ExportedEnvironmentVariable { } export namespace ExportedEnvironmentVariable { + /** + * @internal + */ export const filterSensitiveLog = (obj: ExportedEnvironmentVariable): any => ({ ...obj, }); @@ -1905,6 +2004,9 @@ export interface LogsLocation { } export namespace LogsLocation { + /** + * @internal + */ export const filterSensitiveLog = (obj: LogsLocation): any => ({ ...obj, }); @@ -1926,6 +2028,9 @@ export interface NetworkInterface { } export namespace NetworkInterface { + /** + * @internal + */ export const filterSensitiveLog = (obj: NetworkInterface): any => ({ ...obj, }); @@ -2068,6 +2173,9 @@ export interface BuildPhase { } export namespace BuildPhase { + /** + * @internal + */ export const filterSensitiveLog = (obj: BuildPhase): any => ({ ...obj, }); @@ -2340,6 +2448,9 @@ export interface Build { } export namespace Build { + /** + * @internal + */ export const filterSensitiveLog = (obj: Build): any => ({ ...obj, }); @@ -2358,6 +2469,9 @@ export interface BatchGetBuildsOutput { } export namespace BatchGetBuildsOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: BatchGetBuildsOutput): any => ({ ...obj, }); @@ -2373,6 +2487,9 @@ export interface BatchGetProjectsInput { } export namespace BatchGetProjectsInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: BatchGetProjectsInput): any => ({ ...obj, }); @@ -2626,6 +2743,9 @@ export interface ProjectArtifacts { } export namespace ProjectArtifacts { + /** + * @internal + */ export const filterSensitiveLog = (obj: ProjectArtifacts): any => ({ ...obj, }); @@ -2649,6 +2769,9 @@ export interface ProjectBadge { } export namespace ProjectBadge { + /** + * @internal + */ export const filterSensitiveLog = (obj: ProjectBadge): any => ({ ...obj, }); @@ -2671,6 +2794,9 @@ export interface Tag { } export namespace Tag { + /** + * @internal + */ export const filterSensitiveLog = (obj: Tag): any => ({ ...obj, }); @@ -2795,6 +2921,9 @@ export interface WebhookFilter { } export namespace WebhookFilter { + /** + * @internal + */ export const filterSensitiveLog = (obj: WebhookFilter): any => ({ ...obj, }); @@ -2857,6 +2986,9 @@ export interface Webhook { } export namespace Webhook { + /** + * @internal + */ export const filterSensitiveLog = (obj: Webhook): any => ({ ...obj, }); @@ -3047,6 +3179,9 @@ export interface Project { } export namespace Project { + /** + * @internal + */ export const filterSensitiveLog = (obj: Project): any => ({ ...obj, }); @@ -3065,6 +3200,9 @@ export interface BatchGetProjectsOutput { } export namespace BatchGetProjectsOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: BatchGetProjectsOutput): any => ({ ...obj, }); @@ -3080,6 +3218,9 @@ export interface BatchGetReportGroupsInput { } export namespace BatchGetReportGroupsInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: BatchGetReportGroupsInput): any => ({ ...obj, }); @@ -3144,6 +3285,9 @@ export interface S3ReportExportConfig { } export namespace S3ReportExportConfig { + /** + * @internal + */ export const filterSensitiveLog = (obj: S3ReportExportConfig): any => ({ ...obj, }); @@ -3176,6 +3320,9 @@ export interface ReportExportConfig { } export namespace ReportExportConfig { + /** + * @internal + */ export const filterSensitiveLog = (obj: ReportExportConfig): any => ({ ...obj, }); @@ -3266,6 +3413,9 @@ export interface ReportGroup { } export namespace ReportGroup { + /** + * @internal + */ export const filterSensitiveLog = (obj: ReportGroup): any => ({ ...obj, }); @@ -3288,6 +3438,9 @@ export interface BatchGetReportGroupsOutput { } export namespace BatchGetReportGroupsOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: BatchGetReportGroupsOutput): any => ({ ...obj, }); @@ -3303,6 +3456,9 @@ export interface BatchGetReportsInput { } export namespace BatchGetReportsInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: BatchGetReportsInput): any => ({ ...obj, }); @@ -3348,6 +3504,9 @@ export interface CodeCoverageReportSummary { } export namespace CodeCoverageReportSummary { + /** + * @internal + */ export const filterSensitiveLog = (obj: CodeCoverageReportSummary): any => ({ ...obj, }); @@ -3385,6 +3544,9 @@ export interface TestReportSummary { } export namespace TestReportSummary { + /** + * @internal + */ export const filterSensitiveLog = (obj: TestReportSummary): any => ({ ...obj, }); @@ -3474,6 +3636,9 @@ export interface Report { } export namespace Report { + /** + * @internal + */ export const filterSensitiveLog = (obj: Report): any => ({ ...obj, }); @@ -3496,6 +3661,9 @@ export interface BatchGetReportsOutput { } export namespace BatchGetReportsOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: BatchGetReportsOutput): any => ({ ...obj, }); @@ -3513,6 +3681,9 @@ export interface BuildBatchFilter { } export namespace BuildBatchFilter { + /** + * @internal + */ export const filterSensitiveLog = (obj: BuildBatchFilter): any => ({ ...obj, }); @@ -3681,6 +3852,9 @@ export interface CreateProjectInput { } export namespace CreateProjectInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateProjectInput): any => ({ ...obj, }); @@ -3694,6 +3868,9 @@ export interface CreateProjectOutput { } export namespace CreateProjectOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateProjectOutput): any => ({ ...obj, }); @@ -3710,6 +3887,9 @@ export interface ResourceAlreadyExistsException extends __SmithyException, $Meta } export namespace ResourceAlreadyExistsException { + /** + * @internal + */ export const filterSensitiveLog = (obj: ResourceAlreadyExistsException): any => ({ ...obj, }); @@ -3748,6 +3928,9 @@ export interface CreateReportGroupInput { } export namespace CreateReportGroupInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateReportGroupInput): any => ({ ...obj, }); @@ -3763,6 +3946,9 @@ export interface CreateReportGroupOutput { } export namespace CreateReportGroupOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateReportGroupOutput): any => ({ ...obj, }); @@ -3802,6 +3988,9 @@ export interface CreateWebhookInput { } export namespace CreateWebhookInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateWebhookInput): any => ({ ...obj, }); @@ -3816,6 +4005,9 @@ export interface CreateWebhookOutput { } export namespace CreateWebhookOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateWebhookOutput): any => ({ ...obj, }); @@ -3831,6 +4023,9 @@ export interface OAuthProviderException extends __SmithyException, $MetadataBear } export namespace OAuthProviderException { + /** + * @internal + */ export const filterSensitiveLog = (obj: OAuthProviderException): any => ({ ...obj, }); @@ -3846,6 +4041,9 @@ export interface ResourceNotFoundException extends __SmithyException, $MetadataB } export namespace ResourceNotFoundException { + /** + * @internal + */ export const filterSensitiveLog = (obj: ResourceNotFoundException): any => ({ ...obj, }); @@ -3859,6 +4057,9 @@ export interface DeleteBuildBatchInput { } export namespace DeleteBuildBatchInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteBuildBatchInput): any => ({ ...obj, }); @@ -3883,6 +4084,9 @@ export interface DeleteBuildBatchOutput { } export namespace DeleteBuildBatchOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteBuildBatchOutput): any => ({ ...obj, }); @@ -3896,6 +4100,9 @@ export interface DeleteProjectInput { } export namespace DeleteProjectInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteProjectInput): any => ({ ...obj, }); @@ -3904,6 +4111,9 @@ export namespace DeleteProjectInput { export interface DeleteProjectOutput {} export namespace DeleteProjectOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteProjectOutput): any => ({ ...obj, }); @@ -3919,6 +4129,9 @@ export interface DeleteReportInput { } export namespace DeleteReportInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteReportInput): any => ({ ...obj, }); @@ -3927,6 +4140,9 @@ export namespace DeleteReportInput { export interface DeleteReportOutput {} export namespace DeleteReportOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteReportOutput): any => ({ ...obj, }); @@ -3949,6 +4165,9 @@ export interface DeleteReportGroupInput { } export namespace DeleteReportGroupInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteReportGroupInput): any => ({ ...obj, }); @@ -3957,6 +4176,9 @@ export namespace DeleteReportGroupInput { export interface DeleteReportGroupOutput {} export namespace DeleteReportGroupOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteReportGroupOutput): any => ({ ...obj, }); @@ -3970,6 +4192,9 @@ export interface DeleteResourcePolicyInput { } export namespace DeleteResourcePolicyInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteResourcePolicyInput): any => ({ ...obj, }); @@ -3978,6 +4203,9 @@ export namespace DeleteResourcePolicyInput { export interface DeleteResourcePolicyOutput {} export namespace DeleteResourcePolicyOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteResourcePolicyOutput): any => ({ ...obj, }); @@ -3991,6 +4219,9 @@ export interface DeleteSourceCredentialsInput { } export namespace DeleteSourceCredentialsInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteSourceCredentialsInput): any => ({ ...obj, }); @@ -4004,6 +4235,9 @@ export interface DeleteSourceCredentialsOutput { } export namespace DeleteSourceCredentialsOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteSourceCredentialsOutput): any => ({ ...obj, }); @@ -4017,6 +4251,9 @@ export interface DeleteWebhookInput { } export namespace DeleteWebhookInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteWebhookInput): any => ({ ...obj, }); @@ -4025,6 +4262,9 @@ export namespace DeleteWebhookInput { export interface DeleteWebhookOutput {} export namespace DeleteWebhookOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteWebhookOutput): any => ({ ...obj, }); @@ -4092,6 +4332,9 @@ export interface DescribeCodeCoveragesInput { } export namespace DescribeCodeCoveragesInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeCodeCoveragesInput): any => ({ ...obj, }); @@ -4157,6 +4400,9 @@ export interface CodeCoverage { } export namespace CodeCoverage { + /** + * @internal + */ export const filterSensitiveLog = (obj: CodeCoverage): any => ({ ...obj, }); @@ -4176,6 +4422,9 @@ export interface DescribeCodeCoveragesOutput { } export namespace DescribeCodeCoveragesOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeCodeCoveragesOutput): any => ({ ...obj, }); @@ -4228,6 +4477,9 @@ export interface TestCaseFilter { } export namespace TestCaseFilter { + /** + * @internal + */ export const filterSensitiveLog = (obj: TestCaseFilter): any => ({ ...obj, }); @@ -4269,6 +4521,9 @@ export interface DescribeTestCasesInput { } export namespace DescribeTestCasesInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeTestCasesInput): any => ({ ...obj, }); @@ -4326,6 +4581,9 @@ export interface TestCase { } export namespace TestCase { + /** + * @internal + */ export const filterSensitiveLog = (obj: TestCase): any => ({ ...obj, }); @@ -4352,6 +4610,9 @@ export interface DescribeTestCasesOutput { } export namespace DescribeTestCasesOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeTestCasesOutput): any => ({ ...obj, }); @@ -4448,6 +4709,9 @@ export interface GetReportGroupTrendInput { } export namespace GetReportGroupTrendInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetReportGroupTrendInput): any => ({ ...obj, }); @@ -4469,6 +4733,9 @@ export interface ReportWithRawData { } export namespace ReportWithRawData { + /** + * @internal + */ export const filterSensitiveLog = (obj: ReportWithRawData): any => ({ ...obj, }); @@ -4496,6 +4763,9 @@ export interface ReportGroupTrendStats { } export namespace ReportGroupTrendStats { + /** + * @internal + */ export const filterSensitiveLog = (obj: ReportGroupTrendStats): any => ({ ...obj, }); @@ -4514,6 +4784,9 @@ export interface GetReportGroupTrendOutput { } export namespace GetReportGroupTrendOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetReportGroupTrendOutput): any => ({ ...obj, }); @@ -4527,6 +4800,9 @@ export interface GetResourcePolicyInput { } export namespace GetResourcePolicyInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetResourcePolicyInput): any => ({ ...obj, }); @@ -4540,6 +4816,9 @@ export interface GetResourcePolicyOutput { } export namespace GetResourcePolicyOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetResourcePolicyOutput): any => ({ ...obj, }); @@ -4585,6 +4864,9 @@ export interface ImportSourceCredentialsInput { } export namespace ImportSourceCredentialsInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: ImportSourceCredentialsInput): any => ({ ...obj, ...(obj.token && { token: SENSITIVE_STRING }), @@ -4599,6 +4881,9 @@ export interface ImportSourceCredentialsOutput { } export namespace ImportSourceCredentialsOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: ImportSourceCredentialsOutput): any => ({ ...obj, }); @@ -4612,6 +4897,9 @@ export interface InvalidateProjectCacheInput { } export namespace InvalidateProjectCacheInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: InvalidateProjectCacheInput): any => ({ ...obj, }); @@ -4620,6 +4908,9 @@ export namespace InvalidateProjectCacheInput { export interface InvalidateProjectCacheOutput {} export namespace InvalidateProjectCacheOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: InvalidateProjectCacheOutput): any => ({ ...obj, }); @@ -4660,6 +4951,9 @@ export interface ListBuildBatchesInput { } export namespace ListBuildBatchesInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListBuildBatchesInput): any => ({ ...obj, }); @@ -4679,6 +4973,9 @@ export interface ListBuildBatchesOutput { } export namespace ListBuildBatchesOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListBuildBatchesOutput): any => ({ ...obj, }); @@ -4726,6 +5023,9 @@ export interface ListBuildBatchesForProjectInput { } export namespace ListBuildBatchesForProjectInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListBuildBatchesForProjectInput): any => ({ ...obj, }); @@ -4746,6 +5046,9 @@ export interface ListBuildBatchesForProjectOutput { } export namespace ListBuildBatchesForProjectOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListBuildBatchesForProjectOutput): any => ({ ...obj, }); @@ -4781,6 +5084,9 @@ export interface ListBuildsInput { } export namespace ListBuildsInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListBuildsInput): any => ({ ...obj, }); @@ -4802,6 +5108,9 @@ export interface ListBuildsOutput { } export namespace ListBuildsOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListBuildsOutput): any => ({ ...obj, }); @@ -4846,6 +5155,9 @@ export interface ListBuildsForProjectInput { } export namespace ListBuildsForProjectInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListBuildsForProjectInput): any => ({ ...obj, }); @@ -4868,6 +5180,9 @@ export interface ListBuildsForProjectOutput { } export namespace ListBuildsForProjectOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListBuildsForProjectOutput): any => ({ ...obj, }); @@ -4876,6 +5191,9 @@ export namespace ListBuildsForProjectOutput { export interface ListCuratedEnvironmentImagesInput {} export namespace ListCuratedEnvironmentImagesInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListCuratedEnvironmentImagesInput): any => ({ ...obj, }); @@ -4902,6 +5220,9 @@ export interface EnvironmentImage { } export namespace EnvironmentImage { + /** + * @internal + */ export const filterSensitiveLog = (obj: EnvironmentImage): any => ({ ...obj, }); @@ -4938,6 +5259,9 @@ export interface EnvironmentLanguage { } export namespace EnvironmentLanguage { + /** + * @internal + */ export const filterSensitiveLog = (obj: EnvironmentLanguage): any => ({ ...obj, }); @@ -4967,6 +5291,9 @@ export interface EnvironmentPlatform { } export namespace EnvironmentPlatform { + /** + * @internal + */ export const filterSensitiveLog = (obj: EnvironmentPlatform): any => ({ ...obj, }); @@ -4981,6 +5308,9 @@ export interface ListCuratedEnvironmentImagesOutput { } export namespace ListCuratedEnvironmentImagesOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListCuratedEnvironmentImagesOutput): any => ({ ...obj, }); @@ -5045,6 +5375,9 @@ export interface ListProjectsInput { } export namespace ListProjectsInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListProjectsInput): any => ({ ...obj, }); @@ -5067,6 +5400,9 @@ export interface ListProjectsOutput { } export namespace ListProjectsOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListProjectsOutput): any => ({ ...obj, }); @@ -5130,6 +5466,9 @@ export interface ListReportGroupsInput { } export namespace ListReportGroupsInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListReportGroupsInput): any => ({ ...obj, }); @@ -5156,6 +5495,9 @@ export interface ListReportGroupsOutput { } export namespace ListReportGroupsOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListReportGroupsOutput): any => ({ ...obj, }); @@ -5173,6 +5515,9 @@ export interface ReportFilter { } export namespace ReportFilter { + /** + * @internal + */ export const filterSensitiveLog = (obj: ReportFilter): any => ({ ...obj, }); @@ -5226,6 +5571,9 @@ export interface ListReportsInput { } export namespace ListReportsInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListReportsInput): any => ({ ...obj, }); @@ -5252,6 +5600,9 @@ export interface ListReportsOutput { } export namespace ListReportsOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListReportsOutput): any => ({ ...obj, }); @@ -5300,6 +5651,9 @@ export interface ListReportsForReportGroupInput { } export namespace ListReportsForReportGroupInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListReportsForReportGroupInput): any => ({ ...obj, }); @@ -5326,6 +5680,9 @@ export interface ListReportsForReportGroupOutput { } export namespace ListReportsForReportGroupOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListReportsForReportGroupOutput): any => ({ ...obj, }); @@ -5388,6 +5745,9 @@ export interface ListSharedProjectsInput { } export namespace ListSharedProjectsInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListSharedProjectsInput): any => ({ ...obj, }); @@ -5412,6 +5772,9 @@ export interface ListSharedProjectsOutput { } export namespace ListSharedProjectsOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListSharedProjectsOutput): any => ({ ...obj, }); @@ -5469,6 +5832,9 @@ export interface ListSharedReportGroupsInput { } export namespace ListSharedReportGroupsInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListSharedReportGroupsInput): any => ({ ...obj, }); @@ -5493,6 +5859,9 @@ export interface ListSharedReportGroupsOutput { } export namespace ListSharedReportGroupsOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListSharedReportGroupsOutput): any => ({ ...obj, }); @@ -5501,6 +5870,9 @@ export namespace ListSharedReportGroupsOutput { export interface ListSourceCredentialsInput {} export namespace ListSourceCredentialsInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListSourceCredentialsInput): any => ({ ...obj, }); @@ -5530,6 +5902,9 @@ export interface SourceCredentialsInfo { } export namespace SourceCredentialsInfo { + /** + * @internal + */ export const filterSensitiveLog = (obj: SourceCredentialsInfo): any => ({ ...obj, }); @@ -5545,6 +5920,9 @@ export interface ListSourceCredentialsOutput { } export namespace ListSourceCredentialsOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListSourceCredentialsOutput): any => ({ ...obj, }); @@ -5566,6 +5944,9 @@ export interface PutResourcePolicyInput { } export namespace PutResourcePolicyInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: PutResourcePolicyInput): any => ({ ...obj, }); @@ -5580,6 +5961,9 @@ export interface PutResourcePolicyOutput { } export namespace PutResourcePolicyOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: PutResourcePolicyOutput): any => ({ ...obj, }); @@ -5602,6 +5986,9 @@ export interface RetryBuildInput { } export namespace RetryBuildInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: RetryBuildInput): any => ({ ...obj, }); @@ -5615,6 +6002,9 @@ export interface RetryBuildOutput { } export namespace RetryBuildOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: RetryBuildOutput): any => ({ ...obj, }); @@ -5647,6 +6037,9 @@ export interface RetryBuildBatchInput { } export namespace RetryBuildBatchInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: RetryBuildBatchInput): any => ({ ...obj, }); @@ -5660,6 +6053,9 @@ export interface RetryBuildBatchOutput { } export namespace RetryBuildBatchOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: RetryBuildBatchOutput): any => ({ ...obj, }); @@ -5922,6 +6318,9 @@ export interface StartBuildInput { } export namespace StartBuildInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: StartBuildInput): any => ({ ...obj, }); @@ -5935,6 +6334,9 @@ export interface StartBuildOutput { } export namespace StartBuildOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: StartBuildOutput): any => ({ ...obj, }); @@ -6195,6 +6597,9 @@ export interface StartBuildBatchInput { } export namespace StartBuildBatchInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: StartBuildBatchInput): any => ({ ...obj, }); @@ -6208,6 +6613,9 @@ export interface StartBuildBatchOutput { } export namespace StartBuildBatchOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: StartBuildBatchOutput): any => ({ ...obj, }); @@ -6221,6 +6629,9 @@ export interface StopBuildInput { } export namespace StopBuildInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: StopBuildInput): any => ({ ...obj, }); @@ -6234,6 +6645,9 @@ export interface StopBuildOutput { } export namespace StopBuildOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: StopBuildOutput): any => ({ ...obj, }); @@ -6247,6 +6661,9 @@ export interface StopBuildBatchInput { } export namespace StopBuildBatchInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: StopBuildBatchInput): any => ({ ...obj, }); @@ -6260,6 +6677,9 @@ export interface StopBuildBatchOutput { } export namespace StopBuildBatchOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: StopBuildBatchOutput): any => ({ ...obj, }); @@ -6431,6 +6851,9 @@ export interface UpdateProjectInput { } export namespace UpdateProjectInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateProjectInput): any => ({ ...obj, }); @@ -6444,6 +6867,9 @@ export interface UpdateProjectOutput { } export namespace UpdateProjectOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateProjectOutput): any => ({ ...obj, }); @@ -6487,6 +6913,9 @@ export interface UpdateReportGroupInput { } export namespace UpdateReportGroupInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateReportGroupInput): any => ({ ...obj, }); @@ -6502,6 +6931,9 @@ export interface UpdateReportGroupOutput { } export namespace UpdateReportGroupOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateReportGroupOutput): any => ({ ...obj, }); @@ -6546,6 +6978,9 @@ export interface UpdateWebhookInput { } export namespace UpdateWebhookInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateWebhookInput): any => ({ ...obj, }); @@ -6560,6 +6995,9 @@ export interface UpdateWebhookOutput { } export namespace UpdateWebhookOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateWebhookOutput): any => ({ ...obj, }); diff --git a/clients/client-codecommit/commands/AssociateApprovalRuleTemplateWithRepositoryCommand.ts b/clients/client-codecommit/commands/AssociateApprovalRuleTemplateWithRepositoryCommand.ts index a654645e7dd4..a1f828de1def 100644 --- a/clients/client-codecommit/commands/AssociateApprovalRuleTemplateWithRepositoryCommand.ts +++ b/clients/client-codecommit/commands/AssociateApprovalRuleTemplateWithRepositoryCommand.ts @@ -29,6 +29,20 @@ export interface AssociateApprovalRuleTemplateWithRepositoryCommandOutput extend * 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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { CodeCommitClient, AssociateApprovalRuleTemplateWithRepositoryCommand } from "@aws-sdk/client-codecommit"; // ES Modules import + * // const { CodeCommitClient, AssociateApprovalRuleTemplateWithRepositoryCommand } = require("@aws-sdk/client-codecommit"); // CommonJS import + * const client = new CodeCommitClient(config); + * const command = new AssociateApprovalRuleTemplateWithRepositoryCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link AssociateApprovalRuleTemplateWithRepositoryCommandInput} for command's `input` shape. + * @see {@link AssociateApprovalRuleTemplateWithRepositoryCommandOutput} for command's `response` shape. + * @see {@link CodeCommitClientResolvedConfig | config} for command's `input` shape. + * */ export class AssociateApprovalRuleTemplateWithRepositoryCommand extends $Command< AssociateApprovalRuleTemplateWithRepositoryCommandInput, diff --git a/clients/client-codecommit/commands/BatchAssociateApprovalRuleTemplateWithRepositoriesCommand.ts b/clients/client-codecommit/commands/BatchAssociateApprovalRuleTemplateWithRepositoriesCommand.ts index f9ed905dce07..85199f2787d7 100644 --- a/clients/client-codecommit/commands/BatchAssociateApprovalRuleTemplateWithRepositoriesCommand.ts +++ b/clients/client-codecommit/commands/BatchAssociateApprovalRuleTemplateWithRepositoriesCommand.ts @@ -28,6 +28,20 @@ export interface BatchAssociateApprovalRuleTemplateWithRepositoriesCommandOutput /** *

Creates an association between an approval rule template and one or more specified repositories.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { CodeCommitClient, BatchAssociateApprovalRuleTemplateWithRepositoriesCommand } from "@aws-sdk/client-codecommit"; // ES Modules import + * // const { CodeCommitClient, BatchAssociateApprovalRuleTemplateWithRepositoriesCommand } = require("@aws-sdk/client-codecommit"); // CommonJS import + * const client = new CodeCommitClient(config); + * const command = new BatchAssociateApprovalRuleTemplateWithRepositoriesCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link BatchAssociateApprovalRuleTemplateWithRepositoriesCommandInput} for command's `input` shape. + * @see {@link BatchAssociateApprovalRuleTemplateWithRepositoriesCommandOutput} for command's `response` shape. + * @see {@link CodeCommitClientResolvedConfig | config} for command's `input` shape. + * */ export class BatchAssociateApprovalRuleTemplateWithRepositoriesCommand extends $Command< BatchAssociateApprovalRuleTemplateWithRepositoriesCommandInput, diff --git a/clients/client-codecommit/commands/BatchDescribeMergeConflictsCommand.ts b/clients/client-codecommit/commands/BatchDescribeMergeConflictsCommand.ts index eb3acaeaa25a..6d3dc809b3d8 100644 --- a/clients/client-codecommit/commands/BatchDescribeMergeConflictsCommand.ts +++ b/clients/client-codecommit/commands/BatchDescribeMergeConflictsCommand.ts @@ -22,6 +22,20 @@ export interface BatchDescribeMergeConflictsCommandOutput extends BatchDescribeM /** *

Returns information about one or more merge conflicts in the attempted merge of two commit specifiers using the squash or three-way merge strategy.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { CodeCommitClient, BatchDescribeMergeConflictsCommand } from "@aws-sdk/client-codecommit"; // ES Modules import + * // const { CodeCommitClient, BatchDescribeMergeConflictsCommand } = require("@aws-sdk/client-codecommit"); // CommonJS import + * const client = new CodeCommitClient(config); + * const command = new BatchDescribeMergeConflictsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link BatchDescribeMergeConflictsCommandInput} for command's `input` shape. + * @see {@link BatchDescribeMergeConflictsCommandOutput} for command's `response` shape. + * @see {@link CodeCommitClientResolvedConfig | config} for command's `input` shape. + * */ export class BatchDescribeMergeConflictsCommand extends $Command< BatchDescribeMergeConflictsCommandInput, diff --git a/clients/client-codecommit/commands/BatchDisassociateApprovalRuleTemplateFromRepositoriesCommand.ts b/clients/client-codecommit/commands/BatchDisassociateApprovalRuleTemplateFromRepositoriesCommand.ts index efb24b8f6462..8f9c6859730b 100644 --- a/clients/client-codecommit/commands/BatchDisassociateApprovalRuleTemplateFromRepositoriesCommand.ts +++ b/clients/client-codecommit/commands/BatchDisassociateApprovalRuleTemplateFromRepositoriesCommand.ts @@ -28,6 +28,20 @@ export interface BatchDisassociateApprovalRuleTemplateFromRepositoriesCommandOut /** *

Removes the association between an approval rule template and one or more specified repositories.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { CodeCommitClient, BatchDisassociateApprovalRuleTemplateFromRepositoriesCommand } from "@aws-sdk/client-codecommit"; // ES Modules import + * // const { CodeCommitClient, BatchDisassociateApprovalRuleTemplateFromRepositoriesCommand } = require("@aws-sdk/client-codecommit"); // CommonJS import + * const client = new CodeCommitClient(config); + * const command = new BatchDisassociateApprovalRuleTemplateFromRepositoriesCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link BatchDisassociateApprovalRuleTemplateFromRepositoriesCommandInput} for command's `input` shape. + * @see {@link BatchDisassociateApprovalRuleTemplateFromRepositoriesCommandOutput} for command's `response` shape. + * @see {@link CodeCommitClientResolvedConfig | config} for command's `input` shape. + * */ export class BatchDisassociateApprovalRuleTemplateFromRepositoriesCommand extends $Command< BatchDisassociateApprovalRuleTemplateFromRepositoriesCommandInput, diff --git a/clients/client-codecommit/commands/BatchGetCommitsCommand.ts b/clients/client-codecommit/commands/BatchGetCommitsCommand.ts index e5bb318b8c3f..6c626886c918 100644 --- a/clients/client-codecommit/commands/BatchGetCommitsCommand.ts +++ b/clients/client-codecommit/commands/BatchGetCommitsCommand.ts @@ -22,6 +22,20 @@ export interface BatchGetCommitsCommandOutput extends BatchGetCommitsOutput, __M /** *

Returns information about the contents of one or more commits in a repository.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { CodeCommitClient, BatchGetCommitsCommand } from "@aws-sdk/client-codecommit"; // ES Modules import + * // const { CodeCommitClient, BatchGetCommitsCommand } = require("@aws-sdk/client-codecommit"); // CommonJS import + * const client = new CodeCommitClient(config); + * const command = new BatchGetCommitsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link BatchGetCommitsCommandInput} for command's `input` shape. + * @see {@link BatchGetCommitsCommandOutput} for command's `response` shape. + * @see {@link CodeCommitClientResolvedConfig | config} for command's `input` shape. + * */ export class BatchGetCommitsCommand extends $Command< BatchGetCommitsCommandInput, diff --git a/clients/client-codecommit/commands/BatchGetRepositoriesCommand.ts b/clients/client-codecommit/commands/BatchGetRepositoriesCommand.ts index 978a38de43a8..a85f70fd5a6b 100644 --- a/clients/client-codecommit/commands/BatchGetRepositoriesCommand.ts +++ b/clients/client-codecommit/commands/BatchGetRepositoriesCommand.ts @@ -29,6 +29,20 @@ export interface BatchGetRepositoriesCommandOutput extends BatchGetRepositoriesO * HTML-encode the description field in any application that uses this API to display * the repository description on a webpage.

* + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { CodeCommitClient, BatchGetRepositoriesCommand } from "@aws-sdk/client-codecommit"; // ES Modules import + * // const { CodeCommitClient, BatchGetRepositoriesCommand } = require("@aws-sdk/client-codecommit"); // CommonJS import + * const client = new CodeCommitClient(config); + * const command = new BatchGetRepositoriesCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link BatchGetRepositoriesCommandInput} for command's `input` shape. + * @see {@link BatchGetRepositoriesCommandOutput} for command's `response` shape. + * @see {@link CodeCommitClientResolvedConfig | config} for command's `input` shape. + * */ export class BatchGetRepositoriesCommand extends $Command< BatchGetRepositoriesCommandInput, diff --git a/clients/client-codecommit/commands/CreateApprovalRuleTemplateCommand.ts b/clients/client-codecommit/commands/CreateApprovalRuleTemplateCommand.ts index c68580e9257d..cbe8f7b90eaf 100644 --- a/clients/client-codecommit/commands/CreateApprovalRuleTemplateCommand.ts +++ b/clients/client-codecommit/commands/CreateApprovalRuleTemplateCommand.ts @@ -26,6 +26,20 @@ export interface CreateApprovalRuleTemplateCommandOutput extends CreateApprovalR * 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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { CodeCommitClient, CreateApprovalRuleTemplateCommand } from "@aws-sdk/client-codecommit"; // ES Modules import + * // const { CodeCommitClient, CreateApprovalRuleTemplateCommand } = require("@aws-sdk/client-codecommit"); // CommonJS import + * const client = new CodeCommitClient(config); + * const command = new CreateApprovalRuleTemplateCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreateApprovalRuleTemplateCommandInput} for command's `input` shape. + * @see {@link CreateApprovalRuleTemplateCommandOutput} for command's `response` shape. + * @see {@link CodeCommitClientResolvedConfig | config} for command's `input` shape. + * */ export class CreateApprovalRuleTemplateCommand extends $Command< CreateApprovalRuleTemplateCommandInput, diff --git a/clients/client-codecommit/commands/CreateBranchCommand.ts b/clients/client-codecommit/commands/CreateBranchCommand.ts index 15652e150646..49057ea59cb4 100644 --- a/clients/client-codecommit/commands/CreateBranchCommand.ts +++ b/clients/client-codecommit/commands/CreateBranchCommand.ts @@ -25,6 +25,20 @@ export interface CreateBranchCommandOutput extends __MetadataBearer {} * *

Calling the create branch operation does not set a repository's default branch. To do this, call the update default branch operation.

* + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { CodeCommitClient, CreateBranchCommand } from "@aws-sdk/client-codecommit"; // ES Modules import + * // const { CodeCommitClient, CreateBranchCommand } = require("@aws-sdk/client-codecommit"); // CommonJS import + * const client = new CodeCommitClient(config); + * const command = new CreateBranchCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreateBranchCommandInput} for command's `input` shape. + * @see {@link CreateBranchCommandOutput} for command's `response` shape. + * @see {@link CodeCommitClientResolvedConfig | config} for command's `input` shape. + * */ export class CreateBranchCommand extends $Command< CreateBranchCommandInput, diff --git a/clients/client-codecommit/commands/CreateCommitCommand.ts b/clients/client-codecommit/commands/CreateCommitCommand.ts index 4275469a9a90..83a7d494ab31 100644 --- a/clients/client-codecommit/commands/CreateCommitCommand.ts +++ b/clients/client-codecommit/commands/CreateCommitCommand.ts @@ -22,6 +22,20 @@ export interface CreateCommitCommandOutput extends CreateCommitOutput, __Metadat /** *

Creates a commit for a repository on the tip of a specified branch.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { CodeCommitClient, CreateCommitCommand } from "@aws-sdk/client-codecommit"; // ES Modules import + * // const { CodeCommitClient, CreateCommitCommand } = require("@aws-sdk/client-codecommit"); // CommonJS import + * const client = new CodeCommitClient(config); + * const command = new CreateCommitCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreateCommitCommandInput} for command's `input` shape. + * @see {@link CreateCommitCommandOutput} for command's `response` shape. + * @see {@link CodeCommitClientResolvedConfig | config} for command's `input` shape. + * */ export class CreateCommitCommand extends $Command< CreateCommitCommandInput, diff --git a/clients/client-codecommit/commands/CreatePullRequestApprovalRuleCommand.ts b/clients/client-codecommit/commands/CreatePullRequestApprovalRuleCommand.ts index 118f346a97a2..8589133a34e4 100644 --- a/clients/client-codecommit/commands/CreatePullRequestApprovalRuleCommand.ts +++ b/clients/client-codecommit/commands/CreatePullRequestApprovalRuleCommand.ts @@ -24,6 +24,20 @@ export interface CreatePullRequestApprovalRuleCommandOutput /** *

Creates an approval rule for a pull request.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { CodeCommitClient, CreatePullRequestApprovalRuleCommand } from "@aws-sdk/client-codecommit"; // ES Modules import + * // const { CodeCommitClient, CreatePullRequestApprovalRuleCommand } = require("@aws-sdk/client-codecommit"); // CommonJS import + * const client = new CodeCommitClient(config); + * const command = new CreatePullRequestApprovalRuleCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreatePullRequestApprovalRuleCommandInput} for command's `input` shape. + * @see {@link CreatePullRequestApprovalRuleCommandOutput} for command's `response` shape. + * @see {@link CodeCommitClientResolvedConfig | config} for command's `input` shape. + * */ export class CreatePullRequestApprovalRuleCommand extends $Command< CreatePullRequestApprovalRuleCommandInput, diff --git a/clients/client-codecommit/commands/CreatePullRequestCommand.ts b/clients/client-codecommit/commands/CreatePullRequestCommand.ts index 5d899618a38e..2c5f62039281 100644 --- a/clients/client-codecommit/commands/CreatePullRequestCommand.ts +++ b/clients/client-codecommit/commands/CreatePullRequestCommand.ts @@ -22,6 +22,20 @@ export interface CreatePullRequestCommandOutput extends CreatePullRequestOutput, /** *

Creates a pull request in the specified repository.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { CodeCommitClient, CreatePullRequestCommand } from "@aws-sdk/client-codecommit"; // ES Modules import + * // const { CodeCommitClient, CreatePullRequestCommand } = require("@aws-sdk/client-codecommit"); // CommonJS import + * const client = new CodeCommitClient(config); + * const command = new CreatePullRequestCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreatePullRequestCommandInput} for command's `input` shape. + * @see {@link CreatePullRequestCommandOutput} for command's `response` shape. + * @see {@link CodeCommitClientResolvedConfig | config} for command's `input` shape. + * */ export class CreatePullRequestCommand extends $Command< CreatePullRequestCommandInput, diff --git a/clients/client-codecommit/commands/CreateRepositoryCommand.ts b/clients/client-codecommit/commands/CreateRepositoryCommand.ts index 654337b0aa88..8b8a2baa8311 100644 --- a/clients/client-codecommit/commands/CreateRepositoryCommand.ts +++ b/clients/client-codecommit/commands/CreateRepositoryCommand.ts @@ -22,6 +22,20 @@ export interface CreateRepositoryCommandOutput extends CreateRepositoryOutput, _ /** *

Creates a new, empty repository.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { CodeCommitClient, CreateRepositoryCommand } from "@aws-sdk/client-codecommit"; // ES Modules import + * // const { CodeCommitClient, CreateRepositoryCommand } = require("@aws-sdk/client-codecommit"); // CommonJS import + * const client = new CodeCommitClient(config); + * const command = new CreateRepositoryCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreateRepositoryCommandInput} for command's `input` shape. + * @see {@link CreateRepositoryCommandOutput} for command's `response` shape. + * @see {@link CodeCommitClientResolvedConfig | config} for command's `input` shape. + * */ export class CreateRepositoryCommand extends $Command< CreateRepositoryCommandInput, diff --git a/clients/client-codecommit/commands/CreateUnreferencedMergeCommitCommand.ts b/clients/client-codecommit/commands/CreateUnreferencedMergeCommitCommand.ts index 543dc4de86ee..a78593cc9156 100644 --- a/clients/client-codecommit/commands/CreateUnreferencedMergeCommitCommand.ts +++ b/clients/client-codecommit/commands/CreateUnreferencedMergeCommitCommand.ts @@ -31,6 +31,20 @@ export interface CreateUnreferencedMergeCommitCommandOutput *

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.

* + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { CodeCommitClient, CreateUnreferencedMergeCommitCommand } from "@aws-sdk/client-codecommit"; // ES Modules import + * // const { CodeCommitClient, CreateUnreferencedMergeCommitCommand } = require("@aws-sdk/client-codecommit"); // CommonJS import + * const client = new CodeCommitClient(config); + * const command = new CreateUnreferencedMergeCommitCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreateUnreferencedMergeCommitCommandInput} for command's `input` shape. + * @see {@link CreateUnreferencedMergeCommitCommandOutput} for command's `response` shape. + * @see {@link CodeCommitClientResolvedConfig | config} for command's `input` shape. + * */ export class CreateUnreferencedMergeCommitCommand extends $Command< CreateUnreferencedMergeCommitCommandInput, diff --git a/clients/client-codecommit/commands/DeleteApprovalRuleTemplateCommand.ts b/clients/client-codecommit/commands/DeleteApprovalRuleTemplateCommand.ts index 6aa8ebb74cf5..537381445226 100644 --- a/clients/client-codecommit/commands/DeleteApprovalRuleTemplateCommand.ts +++ b/clients/client-codecommit/commands/DeleteApprovalRuleTemplateCommand.ts @@ -22,6 +22,20 @@ export interface DeleteApprovalRuleTemplateCommandOutput extends DeleteApprovalR /** *

Deletes a specified approval rule template. Deleting a template does not remove approval rules on pull requests already created with the template.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { CodeCommitClient, DeleteApprovalRuleTemplateCommand } from "@aws-sdk/client-codecommit"; // ES Modules import + * // const { CodeCommitClient, DeleteApprovalRuleTemplateCommand } = require("@aws-sdk/client-codecommit"); // CommonJS import + * const client = new CodeCommitClient(config); + * const command = new DeleteApprovalRuleTemplateCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteApprovalRuleTemplateCommandInput} for command's `input` shape. + * @see {@link DeleteApprovalRuleTemplateCommandOutput} for command's `response` shape. + * @see {@link CodeCommitClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteApprovalRuleTemplateCommand extends $Command< DeleteApprovalRuleTemplateCommandInput, diff --git a/clients/client-codecommit/commands/DeleteBranchCommand.ts b/clients/client-codecommit/commands/DeleteBranchCommand.ts index c514aa579529..fe2156514f55 100644 --- a/clients/client-codecommit/commands/DeleteBranchCommand.ts +++ b/clients/client-codecommit/commands/DeleteBranchCommand.ts @@ -22,6 +22,20 @@ export interface DeleteBranchCommandOutput extends DeleteBranchOutput, __Metadat /** *

Deletes a branch from a repository, unless that branch is the default branch for the repository.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { CodeCommitClient, DeleteBranchCommand } from "@aws-sdk/client-codecommit"; // ES Modules import + * // const { CodeCommitClient, DeleteBranchCommand } = require("@aws-sdk/client-codecommit"); // CommonJS import + * const client = new CodeCommitClient(config); + * const command = new DeleteBranchCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteBranchCommandInput} for command's `input` shape. + * @see {@link DeleteBranchCommandOutput} for command's `response` shape. + * @see {@link CodeCommitClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteBranchCommand extends $Command< DeleteBranchCommandInput, diff --git a/clients/client-codecommit/commands/DeleteCommentContentCommand.ts b/clients/client-codecommit/commands/DeleteCommentContentCommand.ts index 6295ca269cd3..8a2bb5c4d7c4 100644 --- a/clients/client-codecommit/commands/DeleteCommentContentCommand.ts +++ b/clients/client-codecommit/commands/DeleteCommentContentCommand.ts @@ -22,6 +22,20 @@ export interface DeleteCommentContentCommandOutput extends DeleteCommentContentO /** *

Deletes the content of a comment made on a change, file, or commit in a repository.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { CodeCommitClient, DeleteCommentContentCommand } from "@aws-sdk/client-codecommit"; // ES Modules import + * // const { CodeCommitClient, DeleteCommentContentCommand } = require("@aws-sdk/client-codecommit"); // CommonJS import + * const client = new CodeCommitClient(config); + * const command = new DeleteCommentContentCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteCommentContentCommandInput} for command's `input` shape. + * @see {@link DeleteCommentContentCommandOutput} for command's `response` shape. + * @see {@link CodeCommitClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteCommentContentCommand extends $Command< DeleteCommentContentCommandInput, diff --git a/clients/client-codecommit/commands/DeleteFileCommand.ts b/clients/client-codecommit/commands/DeleteFileCommand.ts index 40d68aa660ce..db85bfde877f 100644 --- a/clients/client-codecommit/commands/DeleteFileCommand.ts +++ b/clients/client-codecommit/commands/DeleteFileCommand.ts @@ -24,6 +24,20 @@ export interface DeleteFileCommandOutput extends DeleteFileOutput, __MetadataBea *

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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { CodeCommitClient, DeleteFileCommand } from "@aws-sdk/client-codecommit"; // ES Modules import + * // const { CodeCommitClient, DeleteFileCommand } = require("@aws-sdk/client-codecommit"); // CommonJS import + * const client = new CodeCommitClient(config); + * const command = new DeleteFileCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteFileCommandInput} for command's `input` shape. + * @see {@link DeleteFileCommandOutput} for command's `response` shape. + * @see {@link CodeCommitClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteFileCommand extends $Command< DeleteFileCommandInput, diff --git a/clients/client-codecommit/commands/DeletePullRequestApprovalRuleCommand.ts b/clients/client-codecommit/commands/DeletePullRequestApprovalRuleCommand.ts index 03178fbb3ef1..388666ca2e29 100644 --- a/clients/client-codecommit/commands/DeletePullRequestApprovalRuleCommand.ts +++ b/clients/client-codecommit/commands/DeletePullRequestApprovalRuleCommand.ts @@ -26,6 +26,20 @@ export interface DeletePullRequestApprovalRuleCommandOutput *

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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { CodeCommitClient, DeletePullRequestApprovalRuleCommand } from "@aws-sdk/client-codecommit"; // ES Modules import + * // const { CodeCommitClient, DeletePullRequestApprovalRuleCommand } = require("@aws-sdk/client-codecommit"); // CommonJS import + * const client = new CodeCommitClient(config); + * const command = new DeletePullRequestApprovalRuleCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeletePullRequestApprovalRuleCommandInput} for command's `input` shape. + * @see {@link DeletePullRequestApprovalRuleCommandOutput} for command's `response` shape. + * @see {@link CodeCommitClientResolvedConfig | config} for command's `input` shape. + * */ export class DeletePullRequestApprovalRuleCommand extends $Command< DeletePullRequestApprovalRuleCommandInput, diff --git a/clients/client-codecommit/commands/DeleteRepositoryCommand.ts b/clients/client-codecommit/commands/DeleteRepositoryCommand.ts index cef98043327b..784541765f09 100644 --- a/clients/client-codecommit/commands/DeleteRepositoryCommand.ts +++ b/clients/client-codecommit/commands/DeleteRepositoryCommand.ts @@ -27,6 +27,20 @@ export interface DeleteRepositoryCommandOutput extends DeleteRepositoryOutput, _ *

Deleting a repository also deletes all associated objects and metadata. After a repository is * deleted, all future push calls to the deleted repository fail.

* + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { CodeCommitClient, DeleteRepositoryCommand } from "@aws-sdk/client-codecommit"; // ES Modules import + * // const { CodeCommitClient, DeleteRepositoryCommand } = require("@aws-sdk/client-codecommit"); // CommonJS import + * const client = new CodeCommitClient(config); + * const command = new DeleteRepositoryCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteRepositoryCommandInput} for command's `input` shape. + * @see {@link DeleteRepositoryCommandOutput} for command's `response` shape. + * @see {@link CodeCommitClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteRepositoryCommand extends $Command< DeleteRepositoryCommandInput, diff --git a/clients/client-codecommit/commands/DescribeMergeConflictsCommand.ts b/clients/client-codecommit/commands/DescribeMergeConflictsCommand.ts index 4b79e85cffef..48387a8b8a1f 100644 --- a/clients/client-codecommit/commands/DescribeMergeConflictsCommand.ts +++ b/clients/client-codecommit/commands/DescribeMergeConflictsCommand.ts @@ -24,6 +24,20 @@ export interface DescribeMergeConflictsCommandOutput extends DescribeMergeConfli *

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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { CodeCommitClient, DescribeMergeConflictsCommand } from "@aws-sdk/client-codecommit"; // ES Modules import + * // const { CodeCommitClient, DescribeMergeConflictsCommand } = require("@aws-sdk/client-codecommit"); // CommonJS import + * const client = new CodeCommitClient(config); + * const command = new DescribeMergeConflictsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeMergeConflictsCommandInput} for command's `input` shape. + * @see {@link DescribeMergeConflictsCommandOutput} for command's `response` shape. + * @see {@link CodeCommitClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeMergeConflictsCommand extends $Command< DescribeMergeConflictsCommandInput, diff --git a/clients/client-codecommit/commands/DescribePullRequestEventsCommand.ts b/clients/client-codecommit/commands/DescribePullRequestEventsCommand.ts index 243fc6278a87..3b75ad701f08 100644 --- a/clients/client-codecommit/commands/DescribePullRequestEventsCommand.ts +++ b/clients/client-codecommit/commands/DescribePullRequestEventsCommand.ts @@ -22,6 +22,20 @@ export interface DescribePullRequestEventsCommandOutput extends DescribePullRequ /** *

Returns information about one or more pull request events.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { CodeCommitClient, DescribePullRequestEventsCommand } from "@aws-sdk/client-codecommit"; // ES Modules import + * // const { CodeCommitClient, DescribePullRequestEventsCommand } = require("@aws-sdk/client-codecommit"); // CommonJS import + * const client = new CodeCommitClient(config); + * const command = new DescribePullRequestEventsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribePullRequestEventsCommandInput} for command's `input` shape. + * @see {@link DescribePullRequestEventsCommandOutput} for command's `response` shape. + * @see {@link CodeCommitClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribePullRequestEventsCommand extends $Command< DescribePullRequestEventsCommandInput, diff --git a/clients/client-codecommit/commands/DisassociateApprovalRuleTemplateFromRepositoryCommand.ts b/clients/client-codecommit/commands/DisassociateApprovalRuleTemplateFromRepositoryCommand.ts index baf573f51c74..b719132486bf 100644 --- a/clients/client-codecommit/commands/DisassociateApprovalRuleTemplateFromRepositoryCommand.ts +++ b/clients/client-codecommit/commands/DisassociateApprovalRuleTemplateFromRepositoryCommand.ts @@ -26,6 +26,20 @@ export interface DisassociateApprovalRuleTemplateFromRepositoryCommandOutput ext * 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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { CodeCommitClient, DisassociateApprovalRuleTemplateFromRepositoryCommand } from "@aws-sdk/client-codecommit"; // ES Modules import + * // const { CodeCommitClient, DisassociateApprovalRuleTemplateFromRepositoryCommand } = require("@aws-sdk/client-codecommit"); // CommonJS import + * const client = new CodeCommitClient(config); + * const command = new DisassociateApprovalRuleTemplateFromRepositoryCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DisassociateApprovalRuleTemplateFromRepositoryCommandInput} for command's `input` shape. + * @see {@link DisassociateApprovalRuleTemplateFromRepositoryCommandOutput} for command's `response` shape. + * @see {@link CodeCommitClientResolvedConfig | config} for command's `input` shape. + * */ export class DisassociateApprovalRuleTemplateFromRepositoryCommand extends $Command< DisassociateApprovalRuleTemplateFromRepositoryCommandInput, diff --git a/clients/client-codecommit/commands/EvaluatePullRequestApprovalRulesCommand.ts b/clients/client-codecommit/commands/EvaluatePullRequestApprovalRulesCommand.ts index a2a04b81bd93..386d71ff61ad 100644 --- a/clients/client-codecommit/commands/EvaluatePullRequestApprovalRulesCommand.ts +++ b/clients/client-codecommit/commands/EvaluatePullRequestApprovalRulesCommand.ts @@ -24,6 +24,20 @@ export interface EvaluatePullRequestApprovalRulesCommandOutput /** *

Evaluates whether a pull request has met all the conditions specified in its associated approval rules.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { CodeCommitClient, EvaluatePullRequestApprovalRulesCommand } from "@aws-sdk/client-codecommit"; // ES Modules import + * // const { CodeCommitClient, EvaluatePullRequestApprovalRulesCommand } = require("@aws-sdk/client-codecommit"); // CommonJS import + * const client = new CodeCommitClient(config); + * const command = new EvaluatePullRequestApprovalRulesCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link EvaluatePullRequestApprovalRulesCommandInput} for command's `input` shape. + * @see {@link EvaluatePullRequestApprovalRulesCommandOutput} for command's `response` shape. + * @see {@link CodeCommitClientResolvedConfig | config} for command's `input` shape. + * */ export class EvaluatePullRequestApprovalRulesCommand extends $Command< EvaluatePullRequestApprovalRulesCommandInput, diff --git a/clients/client-codecommit/commands/GetApprovalRuleTemplateCommand.ts b/clients/client-codecommit/commands/GetApprovalRuleTemplateCommand.ts index e453b629f635..73754ee51ea1 100644 --- a/clients/client-codecommit/commands/GetApprovalRuleTemplateCommand.ts +++ b/clients/client-codecommit/commands/GetApprovalRuleTemplateCommand.ts @@ -22,6 +22,20 @@ export interface GetApprovalRuleTemplateCommandOutput extends GetApprovalRuleTem /** *

Returns information about a specified approval rule template.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { CodeCommitClient, GetApprovalRuleTemplateCommand } from "@aws-sdk/client-codecommit"; // ES Modules import + * // const { CodeCommitClient, GetApprovalRuleTemplateCommand } = require("@aws-sdk/client-codecommit"); // CommonJS import + * const client = new CodeCommitClient(config); + * const command = new GetApprovalRuleTemplateCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetApprovalRuleTemplateCommandInput} for command's `input` shape. + * @see {@link GetApprovalRuleTemplateCommandOutput} for command's `response` shape. + * @see {@link CodeCommitClientResolvedConfig | config} for command's `input` shape. + * */ export class GetApprovalRuleTemplateCommand extends $Command< GetApprovalRuleTemplateCommandInput, diff --git a/clients/client-codecommit/commands/GetBlobCommand.ts b/clients/client-codecommit/commands/GetBlobCommand.ts index 1c5df75e9952..e961ca1cb006 100644 --- a/clients/client-codecommit/commands/GetBlobCommand.ts +++ b/clients/client-codecommit/commands/GetBlobCommand.ts @@ -19,6 +19,20 @@ export interface GetBlobCommandOutput extends GetBlobOutput, __MetadataBearer {} /** *

Returns the base-64 encoded content of an individual blob in a repository.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { CodeCommitClient, GetBlobCommand } from "@aws-sdk/client-codecommit"; // ES Modules import + * // const { CodeCommitClient, GetBlobCommand } = require("@aws-sdk/client-codecommit"); // CommonJS import + * const client = new CodeCommitClient(config); + * const command = new GetBlobCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetBlobCommandInput} for command's `input` shape. + * @see {@link GetBlobCommandOutput} for command's `response` shape. + * @see {@link CodeCommitClientResolvedConfig | config} for command's `input` shape. + * */ export class GetBlobCommand extends $Command< GetBlobCommandInput, diff --git a/clients/client-codecommit/commands/GetBranchCommand.ts b/clients/client-codecommit/commands/GetBranchCommand.ts index cc17b76cc213..1e66c19b7077 100644 --- a/clients/client-codecommit/commands/GetBranchCommand.ts +++ b/clients/client-codecommit/commands/GetBranchCommand.ts @@ -19,6 +19,20 @@ export interface GetBranchCommandOutput extends GetBranchOutput, __MetadataBeare /** *

Returns information about a repository branch, including its name and the last commit ID.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { CodeCommitClient, GetBranchCommand } from "@aws-sdk/client-codecommit"; // ES Modules import + * // const { CodeCommitClient, GetBranchCommand } = require("@aws-sdk/client-codecommit"); // CommonJS import + * const client = new CodeCommitClient(config); + * const command = new GetBranchCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetBranchCommandInput} for command's `input` shape. + * @see {@link GetBranchCommandOutput} for command's `response` shape. + * @see {@link CodeCommitClientResolvedConfig | config} for command's `input` shape. + * */ export class GetBranchCommand extends $Command< GetBranchCommandInput, diff --git a/clients/client-codecommit/commands/GetCommentCommand.ts b/clients/client-codecommit/commands/GetCommentCommand.ts index 4e15d8aef9db..d2b3d057c8a7 100644 --- a/clients/client-codecommit/commands/GetCommentCommand.ts +++ b/clients/client-codecommit/commands/GetCommentCommand.ts @@ -26,6 +26,20 @@ export interface GetCommentCommandOutput extends GetCommentOutput, __MetadataBea *

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.

* + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { CodeCommitClient, GetCommentCommand } from "@aws-sdk/client-codecommit"; // ES Modules import + * // const { CodeCommitClient, GetCommentCommand } = require("@aws-sdk/client-codecommit"); // CommonJS import + * const client = new CodeCommitClient(config); + * const command = new GetCommentCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetCommentCommandInput} for command's `input` shape. + * @see {@link GetCommentCommandOutput} for command's `response` shape. + * @see {@link CodeCommitClientResolvedConfig | config} for command's `input` shape. + * */ export class GetCommentCommand extends $Command< GetCommentCommandInput, diff --git a/clients/client-codecommit/commands/GetCommentReactionsCommand.ts b/clients/client-codecommit/commands/GetCommentReactionsCommand.ts index 91248b694f8c..794e52f22673 100644 --- a/clients/client-codecommit/commands/GetCommentReactionsCommand.ts +++ b/clients/client-codecommit/commands/GetCommentReactionsCommand.ts @@ -22,6 +22,20 @@ export interface GetCommentReactionsCommandOutput extends GetCommentReactionsOut /** *

Returns information about reactions to a specified comment ID. Reactions from users who have been deleted will not be included in the count.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { CodeCommitClient, GetCommentReactionsCommand } from "@aws-sdk/client-codecommit"; // ES Modules import + * // const { CodeCommitClient, GetCommentReactionsCommand } = require("@aws-sdk/client-codecommit"); // CommonJS import + * const client = new CodeCommitClient(config); + * const command = new GetCommentReactionsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetCommentReactionsCommandInput} for command's `input` shape. + * @see {@link GetCommentReactionsCommandOutput} for command's `response` shape. + * @see {@link CodeCommitClientResolvedConfig | config} for command's `input` shape. + * */ export class GetCommentReactionsCommand extends $Command< GetCommentReactionsCommandInput, diff --git a/clients/client-codecommit/commands/GetCommentsForComparedCommitCommand.ts b/clients/client-codecommit/commands/GetCommentsForComparedCommitCommand.ts index f22ef325dda8..17412f9d68de 100644 --- a/clients/client-codecommit/commands/GetCommentsForComparedCommitCommand.ts +++ b/clients/client-codecommit/commands/GetCommentsForComparedCommitCommand.ts @@ -28,6 +28,20 @@ export interface GetCommentsForComparedCommitCommandOutput *

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.

* + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { CodeCommitClient, GetCommentsForComparedCommitCommand } from "@aws-sdk/client-codecommit"; // ES Modules import + * // const { CodeCommitClient, GetCommentsForComparedCommitCommand } = require("@aws-sdk/client-codecommit"); // CommonJS import + * const client = new CodeCommitClient(config); + * const command = new GetCommentsForComparedCommitCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetCommentsForComparedCommitCommandInput} for command's `input` shape. + * @see {@link GetCommentsForComparedCommitCommandOutput} for command's `response` shape. + * @see {@link CodeCommitClientResolvedConfig | config} for command's `input` shape. + * */ export class GetCommentsForComparedCommitCommand extends $Command< GetCommentsForComparedCommitCommandInput, diff --git a/clients/client-codecommit/commands/GetCommentsForPullRequestCommand.ts b/clients/client-codecommit/commands/GetCommentsForPullRequestCommand.ts index a05230e15eaa..61864b3919c7 100644 --- a/clients/client-codecommit/commands/GetCommentsForPullRequestCommand.ts +++ b/clients/client-codecommit/commands/GetCommentsForPullRequestCommand.ts @@ -26,6 +26,20 @@ export interface GetCommentsForPullRequestCommandOutput extends GetCommentsForPu *

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.

* + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { CodeCommitClient, GetCommentsForPullRequestCommand } from "@aws-sdk/client-codecommit"; // ES Modules import + * // const { CodeCommitClient, GetCommentsForPullRequestCommand } = require("@aws-sdk/client-codecommit"); // CommonJS import + * const client = new CodeCommitClient(config); + * const command = new GetCommentsForPullRequestCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetCommentsForPullRequestCommandInput} for command's `input` shape. + * @see {@link GetCommentsForPullRequestCommandOutput} for command's `response` shape. + * @see {@link CodeCommitClientResolvedConfig | config} for command's `input` shape. + * */ export class GetCommentsForPullRequestCommand extends $Command< GetCommentsForPullRequestCommandInput, diff --git a/clients/client-codecommit/commands/GetCommitCommand.ts b/clients/client-codecommit/commands/GetCommitCommand.ts index 5e473c4609cb..98d992d7d6b5 100644 --- a/clients/client-codecommit/commands/GetCommitCommand.ts +++ b/clients/client-codecommit/commands/GetCommitCommand.ts @@ -19,6 +19,20 @@ export interface GetCommitCommandOutput extends GetCommitOutput, __MetadataBeare /** *

Returns information about a commit, including commit message and committer information.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { CodeCommitClient, GetCommitCommand } from "@aws-sdk/client-codecommit"; // ES Modules import + * // const { CodeCommitClient, GetCommitCommand } = require("@aws-sdk/client-codecommit"); // CommonJS import + * const client = new CodeCommitClient(config); + * const command = new GetCommitCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetCommitCommandInput} for command's `input` shape. + * @see {@link GetCommitCommandOutput} for command's `response` shape. + * @see {@link CodeCommitClientResolvedConfig | config} for command's `input` shape. + * */ export class GetCommitCommand extends $Command< GetCommitCommandInput, diff --git a/clients/client-codecommit/commands/GetDifferencesCommand.ts b/clients/client-codecommit/commands/GetDifferencesCommand.ts index 0a95eae27fb6..1a38e6323063 100644 --- a/clients/client-codecommit/commands/GetDifferencesCommand.ts +++ b/clients/client-codecommit/commands/GetDifferencesCommand.ts @@ -24,6 +24,20 @@ export interface GetDifferencesCommandOutput extends GetDifferencesOutput, __Met *

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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { CodeCommitClient, GetDifferencesCommand } from "@aws-sdk/client-codecommit"; // ES Modules import + * // const { CodeCommitClient, GetDifferencesCommand } = require("@aws-sdk/client-codecommit"); // CommonJS import + * const client = new CodeCommitClient(config); + * const command = new GetDifferencesCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetDifferencesCommandInput} for command's `input` shape. + * @see {@link GetDifferencesCommandOutput} for command's `response` shape. + * @see {@link CodeCommitClientResolvedConfig | config} for command's `input` shape. + * */ export class GetDifferencesCommand extends $Command< GetDifferencesCommandInput, diff --git a/clients/client-codecommit/commands/GetFileCommand.ts b/clients/client-codecommit/commands/GetFileCommand.ts index a638a5a8f515..699255d58acb 100644 --- a/clients/client-codecommit/commands/GetFileCommand.ts +++ b/clients/client-codecommit/commands/GetFileCommand.ts @@ -19,6 +19,20 @@ export interface GetFileCommandOutput extends GetFileOutput, __MetadataBearer {} /** *

Returns the base-64 encoded contents of a specified file and its metadata.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { CodeCommitClient, GetFileCommand } from "@aws-sdk/client-codecommit"; // ES Modules import + * // const { CodeCommitClient, GetFileCommand } = require("@aws-sdk/client-codecommit"); // CommonJS import + * const client = new CodeCommitClient(config); + * const command = new GetFileCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetFileCommandInput} for command's `input` shape. + * @see {@link GetFileCommandOutput} for command's `response` shape. + * @see {@link CodeCommitClientResolvedConfig | config} for command's `input` shape. + * */ export class GetFileCommand extends $Command< GetFileCommandInput, diff --git a/clients/client-codecommit/commands/GetFolderCommand.ts b/clients/client-codecommit/commands/GetFolderCommand.ts index eb16e111b132..fccf6c1b8bd1 100644 --- a/clients/client-codecommit/commands/GetFolderCommand.ts +++ b/clients/client-codecommit/commands/GetFolderCommand.ts @@ -19,6 +19,20 @@ export interface GetFolderCommandOutput extends GetFolderOutput, __MetadataBeare /** *

Returns the contents of a specified folder in a repository.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { CodeCommitClient, GetFolderCommand } from "@aws-sdk/client-codecommit"; // ES Modules import + * // const { CodeCommitClient, GetFolderCommand } = require("@aws-sdk/client-codecommit"); // CommonJS import + * const client = new CodeCommitClient(config); + * const command = new GetFolderCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetFolderCommandInput} for command's `input` shape. + * @see {@link GetFolderCommandOutput} for command's `response` shape. + * @see {@link CodeCommitClientResolvedConfig | config} for command's `input` shape. + * */ export class GetFolderCommand extends $Command< GetFolderCommandInput, diff --git a/clients/client-codecommit/commands/GetMergeCommitCommand.ts b/clients/client-codecommit/commands/GetMergeCommitCommand.ts index 18089f721e7f..eeaa6dfa1273 100644 --- a/clients/client-codecommit/commands/GetMergeCommitCommand.ts +++ b/clients/client-codecommit/commands/GetMergeCommitCommand.ts @@ -22,6 +22,20 @@ export interface GetMergeCommitCommandOutput extends GetMergeCommitOutput, __Met /** *

Returns information about a specified merge commit.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { CodeCommitClient, GetMergeCommitCommand } from "@aws-sdk/client-codecommit"; // ES Modules import + * // const { CodeCommitClient, GetMergeCommitCommand } = require("@aws-sdk/client-codecommit"); // CommonJS import + * const client = new CodeCommitClient(config); + * const command = new GetMergeCommitCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetMergeCommitCommandInput} for command's `input` shape. + * @see {@link GetMergeCommitCommandOutput} for command's `response` shape. + * @see {@link CodeCommitClientResolvedConfig | config} for command's `input` shape. + * */ export class GetMergeCommitCommand extends $Command< GetMergeCommitCommandInput, diff --git a/clients/client-codecommit/commands/GetMergeConflictsCommand.ts b/clients/client-codecommit/commands/GetMergeConflictsCommand.ts index 7a63a0a20a8f..399984a31e1a 100644 --- a/clients/client-codecommit/commands/GetMergeConflictsCommand.ts +++ b/clients/client-codecommit/commands/GetMergeConflictsCommand.ts @@ -22,6 +22,20 @@ export interface GetMergeConflictsCommandOutput extends GetMergeConflictsOutput, /** *

Returns information about merge conflicts between the before and after commit IDs for a pull request in a repository.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { CodeCommitClient, GetMergeConflictsCommand } from "@aws-sdk/client-codecommit"; // ES Modules import + * // const { CodeCommitClient, GetMergeConflictsCommand } = require("@aws-sdk/client-codecommit"); // CommonJS import + * const client = new CodeCommitClient(config); + * const command = new GetMergeConflictsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetMergeConflictsCommandInput} for command's `input` shape. + * @see {@link GetMergeConflictsCommandOutput} for command's `response` shape. + * @see {@link CodeCommitClientResolvedConfig | config} for command's `input` shape. + * */ export class GetMergeConflictsCommand extends $Command< GetMergeConflictsCommandInput, diff --git a/clients/client-codecommit/commands/GetMergeOptionsCommand.ts b/clients/client-codecommit/commands/GetMergeOptionsCommand.ts index 0154f0d0dcd0..685776868f20 100644 --- a/clients/client-codecommit/commands/GetMergeOptionsCommand.ts +++ b/clients/client-codecommit/commands/GetMergeOptionsCommand.ts @@ -24,6 +24,20 @@ export interface GetMergeOptionsCommandOutput extends GetMergeOptionsOutput, __M *

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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { CodeCommitClient, GetMergeOptionsCommand } from "@aws-sdk/client-codecommit"; // ES Modules import + * // const { CodeCommitClient, GetMergeOptionsCommand } = require("@aws-sdk/client-codecommit"); // CommonJS import + * const client = new CodeCommitClient(config); + * const command = new GetMergeOptionsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetMergeOptionsCommandInput} for command's `input` shape. + * @see {@link GetMergeOptionsCommandOutput} for command's `response` shape. + * @see {@link CodeCommitClientResolvedConfig | config} for command's `input` shape. + * */ export class GetMergeOptionsCommand extends $Command< GetMergeOptionsCommandInput, diff --git a/clients/client-codecommit/commands/GetPullRequestApprovalStatesCommand.ts b/clients/client-codecommit/commands/GetPullRequestApprovalStatesCommand.ts index 4484657cf6f4..50056890ccb4 100644 --- a/clients/client-codecommit/commands/GetPullRequestApprovalStatesCommand.ts +++ b/clients/client-codecommit/commands/GetPullRequestApprovalStatesCommand.ts @@ -25,6 +25,20 @@ export interface GetPullRequestApprovalStatesCommandOutput /** *

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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { CodeCommitClient, GetPullRequestApprovalStatesCommand } from "@aws-sdk/client-codecommit"; // ES Modules import + * // const { CodeCommitClient, GetPullRequestApprovalStatesCommand } = require("@aws-sdk/client-codecommit"); // CommonJS import + * const client = new CodeCommitClient(config); + * const command = new GetPullRequestApprovalStatesCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetPullRequestApprovalStatesCommandInput} for command's `input` shape. + * @see {@link GetPullRequestApprovalStatesCommandOutput} for command's `response` shape. + * @see {@link CodeCommitClientResolvedConfig | config} for command's `input` shape. + * */ export class GetPullRequestApprovalStatesCommand extends $Command< GetPullRequestApprovalStatesCommandInput, diff --git a/clients/client-codecommit/commands/GetPullRequestCommand.ts b/clients/client-codecommit/commands/GetPullRequestCommand.ts index 17f087129dd7..0723ff7c1241 100644 --- a/clients/client-codecommit/commands/GetPullRequestCommand.ts +++ b/clients/client-codecommit/commands/GetPullRequestCommand.ts @@ -22,6 +22,20 @@ export interface GetPullRequestCommandOutput extends GetPullRequestOutput, __Met /** *

Gets information about a pull request in a specified repository.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { CodeCommitClient, GetPullRequestCommand } from "@aws-sdk/client-codecommit"; // ES Modules import + * // const { CodeCommitClient, GetPullRequestCommand } = require("@aws-sdk/client-codecommit"); // CommonJS import + * const client = new CodeCommitClient(config); + * const command = new GetPullRequestCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetPullRequestCommandInput} for command's `input` shape. + * @see {@link GetPullRequestCommandOutput} for command's `response` shape. + * @see {@link CodeCommitClientResolvedConfig | config} for command's `input` shape. + * */ export class GetPullRequestCommand extends $Command< GetPullRequestCommandInput, diff --git a/clients/client-codecommit/commands/GetPullRequestOverrideStateCommand.ts b/clients/client-codecommit/commands/GetPullRequestOverrideStateCommand.ts index 47a0cf0588ee..83beaed0d1b4 100644 --- a/clients/client-codecommit/commands/GetPullRequestOverrideStateCommand.ts +++ b/clients/client-codecommit/commands/GetPullRequestOverrideStateCommand.ts @@ -23,6 +23,20 @@ export interface GetPullRequestOverrideStateCommandOutput extends GetPullRequest /** *

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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { CodeCommitClient, GetPullRequestOverrideStateCommand } from "@aws-sdk/client-codecommit"; // ES Modules import + * // const { CodeCommitClient, GetPullRequestOverrideStateCommand } = require("@aws-sdk/client-codecommit"); // CommonJS import + * const client = new CodeCommitClient(config); + * const command = new GetPullRequestOverrideStateCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetPullRequestOverrideStateCommandInput} for command's `input` shape. + * @see {@link GetPullRequestOverrideStateCommandOutput} for command's `response` shape. + * @see {@link CodeCommitClientResolvedConfig | config} for command's `input` shape. + * */ export class GetPullRequestOverrideStateCommand extends $Command< GetPullRequestOverrideStateCommandInput, diff --git a/clients/client-codecommit/commands/GetRepositoryCommand.ts b/clients/client-codecommit/commands/GetRepositoryCommand.ts index 5a038b0ad523..4ce7f19b95e7 100644 --- a/clients/client-codecommit/commands/GetRepositoryCommand.ts +++ b/clients/client-codecommit/commands/GetRepositoryCommand.ts @@ -30,6 +30,20 @@ export interface GetRepositoryCommandOutput extends GetRepositoryOutput, __Metad * HTML-encode the description field in any application that uses this API to display * the repository description on a webpage.

* + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { CodeCommitClient, GetRepositoryCommand } from "@aws-sdk/client-codecommit"; // ES Modules import + * // const { CodeCommitClient, GetRepositoryCommand } = require("@aws-sdk/client-codecommit"); // CommonJS import + * const client = new CodeCommitClient(config); + * const command = new GetRepositoryCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetRepositoryCommandInput} for command's `input` shape. + * @see {@link GetRepositoryCommandOutput} for command's `response` shape. + * @see {@link CodeCommitClientResolvedConfig | config} for command's `input` shape. + * */ export class GetRepositoryCommand extends $Command< GetRepositoryCommandInput, diff --git a/clients/client-codecommit/commands/GetRepositoryTriggersCommand.ts b/clients/client-codecommit/commands/GetRepositoryTriggersCommand.ts index e4c990bd3e7a..9f4df7e22c25 100644 --- a/clients/client-codecommit/commands/GetRepositoryTriggersCommand.ts +++ b/clients/client-codecommit/commands/GetRepositoryTriggersCommand.ts @@ -22,6 +22,20 @@ export interface GetRepositoryTriggersCommandOutput extends GetRepositoryTrigger /** *

Gets information about triggers configured for a repository.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { CodeCommitClient, GetRepositoryTriggersCommand } from "@aws-sdk/client-codecommit"; // ES Modules import + * // const { CodeCommitClient, GetRepositoryTriggersCommand } = require("@aws-sdk/client-codecommit"); // CommonJS import + * const client = new CodeCommitClient(config); + * const command = new GetRepositoryTriggersCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetRepositoryTriggersCommandInput} for command's `input` shape. + * @see {@link GetRepositoryTriggersCommandOutput} for command's `response` shape. + * @see {@link CodeCommitClientResolvedConfig | config} for command's `input` shape. + * */ export class GetRepositoryTriggersCommand extends $Command< GetRepositoryTriggersCommandInput, diff --git a/clients/client-codecommit/commands/ListApprovalRuleTemplatesCommand.ts b/clients/client-codecommit/commands/ListApprovalRuleTemplatesCommand.ts index ed8a547ac5f6..3e89f1ea9299 100644 --- a/clients/client-codecommit/commands/ListApprovalRuleTemplatesCommand.ts +++ b/clients/client-codecommit/commands/ListApprovalRuleTemplatesCommand.ts @@ -23,6 +23,20 @@ export interface ListApprovalRuleTemplatesCommandOutput extends ListApprovalRule /** *

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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { CodeCommitClient, ListApprovalRuleTemplatesCommand } from "@aws-sdk/client-codecommit"; // ES Modules import + * // const { CodeCommitClient, ListApprovalRuleTemplatesCommand } = require("@aws-sdk/client-codecommit"); // CommonJS import + * const client = new CodeCommitClient(config); + * const command = new ListApprovalRuleTemplatesCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListApprovalRuleTemplatesCommandInput} for command's `input` shape. + * @see {@link ListApprovalRuleTemplatesCommandOutput} for command's `response` shape. + * @see {@link CodeCommitClientResolvedConfig | config} for command's `input` shape. + * */ export class ListApprovalRuleTemplatesCommand extends $Command< ListApprovalRuleTemplatesCommandInput, diff --git a/clients/client-codecommit/commands/ListAssociatedApprovalRuleTemplatesForRepositoryCommand.ts b/clients/client-codecommit/commands/ListAssociatedApprovalRuleTemplatesForRepositoryCommand.ts index 2c35e313c737..4166af0f982f 100644 --- a/clients/client-codecommit/commands/ListAssociatedApprovalRuleTemplatesForRepositoryCommand.ts +++ b/clients/client-codecommit/commands/ListAssociatedApprovalRuleTemplatesForRepositoryCommand.ts @@ -28,6 +28,20 @@ export interface ListAssociatedApprovalRuleTemplatesForRepositoryCommandOutput /** *

Lists all approval rule templates that are associated with a specified repository.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { CodeCommitClient, ListAssociatedApprovalRuleTemplatesForRepositoryCommand } from "@aws-sdk/client-codecommit"; // ES Modules import + * // const { CodeCommitClient, ListAssociatedApprovalRuleTemplatesForRepositoryCommand } = require("@aws-sdk/client-codecommit"); // CommonJS import + * const client = new CodeCommitClient(config); + * const command = new ListAssociatedApprovalRuleTemplatesForRepositoryCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListAssociatedApprovalRuleTemplatesForRepositoryCommandInput} for command's `input` shape. + * @see {@link ListAssociatedApprovalRuleTemplatesForRepositoryCommandOutput} for command's `response` shape. + * @see {@link CodeCommitClientResolvedConfig | config} for command's `input` shape. + * */ export class ListAssociatedApprovalRuleTemplatesForRepositoryCommand extends $Command< ListAssociatedApprovalRuleTemplatesForRepositoryCommandInput, diff --git a/clients/client-codecommit/commands/ListBranchesCommand.ts b/clients/client-codecommit/commands/ListBranchesCommand.ts index f8e29b73a3d6..750f9b5a316f 100644 --- a/clients/client-codecommit/commands/ListBranchesCommand.ts +++ b/clients/client-codecommit/commands/ListBranchesCommand.ts @@ -22,6 +22,20 @@ export interface ListBranchesCommandOutput extends ListBranchesOutput, __Metadat /** *

Gets information about one or more branches in a repository.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { CodeCommitClient, ListBranchesCommand } from "@aws-sdk/client-codecommit"; // ES Modules import + * // const { CodeCommitClient, ListBranchesCommand } = require("@aws-sdk/client-codecommit"); // CommonJS import + * const client = new CodeCommitClient(config); + * const command = new ListBranchesCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListBranchesCommandInput} for command's `input` shape. + * @see {@link ListBranchesCommandOutput} for command's `response` shape. + * @see {@link CodeCommitClientResolvedConfig | config} for command's `input` shape. + * */ export class ListBranchesCommand extends $Command< ListBranchesCommandInput, diff --git a/clients/client-codecommit/commands/ListPullRequestsCommand.ts b/clients/client-codecommit/commands/ListPullRequestsCommand.ts index 326bf09e78dd..c048676eda1e 100644 --- a/clients/client-codecommit/commands/ListPullRequestsCommand.ts +++ b/clients/client-codecommit/commands/ListPullRequestsCommand.ts @@ -23,6 +23,20 @@ export interface ListPullRequestsCommandOutput extends ListPullRequestsOutput, _ /** *

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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { CodeCommitClient, ListPullRequestsCommand } from "@aws-sdk/client-codecommit"; // ES Modules import + * // const { CodeCommitClient, ListPullRequestsCommand } = require("@aws-sdk/client-codecommit"); // CommonJS import + * const client = new CodeCommitClient(config); + * const command = new ListPullRequestsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListPullRequestsCommandInput} for command's `input` shape. + * @see {@link ListPullRequestsCommandOutput} for command's `response` shape. + * @see {@link CodeCommitClientResolvedConfig | config} for command's `input` shape. + * */ export class ListPullRequestsCommand extends $Command< ListPullRequestsCommandInput, diff --git a/clients/client-codecommit/commands/ListRepositoriesCommand.ts b/clients/client-codecommit/commands/ListRepositoriesCommand.ts index 6f5e923cecdd..1a69f985dafa 100644 --- a/clients/client-codecommit/commands/ListRepositoriesCommand.ts +++ b/clients/client-codecommit/commands/ListRepositoriesCommand.ts @@ -22,6 +22,20 @@ export interface ListRepositoriesCommandOutput extends ListRepositoriesOutput, _ /** *

Gets information about one or more repositories.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { CodeCommitClient, ListRepositoriesCommand } from "@aws-sdk/client-codecommit"; // ES Modules import + * // const { CodeCommitClient, ListRepositoriesCommand } = require("@aws-sdk/client-codecommit"); // CommonJS import + * const client = new CodeCommitClient(config); + * const command = new ListRepositoriesCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListRepositoriesCommandInput} for command's `input` shape. + * @see {@link ListRepositoriesCommandOutput} for command's `response` shape. + * @see {@link CodeCommitClientResolvedConfig | config} for command's `input` shape. + * */ export class ListRepositoriesCommand extends $Command< ListRepositoriesCommandInput, diff --git a/clients/client-codecommit/commands/ListRepositoriesForApprovalRuleTemplateCommand.ts b/clients/client-codecommit/commands/ListRepositoriesForApprovalRuleTemplateCommand.ts index 1dfaa2d4b118..1c987606e048 100644 --- a/clients/client-codecommit/commands/ListRepositoriesForApprovalRuleTemplateCommand.ts +++ b/clients/client-codecommit/commands/ListRepositoriesForApprovalRuleTemplateCommand.ts @@ -28,6 +28,20 @@ export interface ListRepositoriesForApprovalRuleTemplateCommandOutput /** *

Lists all repositories associated with the specified approval rule template.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { CodeCommitClient, ListRepositoriesForApprovalRuleTemplateCommand } from "@aws-sdk/client-codecommit"; // ES Modules import + * // const { CodeCommitClient, ListRepositoriesForApprovalRuleTemplateCommand } = require("@aws-sdk/client-codecommit"); // CommonJS import + * const client = new CodeCommitClient(config); + * const command = new ListRepositoriesForApprovalRuleTemplateCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListRepositoriesForApprovalRuleTemplateCommandInput} for command's `input` shape. + * @see {@link ListRepositoriesForApprovalRuleTemplateCommandOutput} for command's `response` shape. + * @see {@link CodeCommitClientResolvedConfig | config} for command's `input` shape. + * */ export class ListRepositoriesForApprovalRuleTemplateCommand extends $Command< ListRepositoriesForApprovalRuleTemplateCommandInput, diff --git a/clients/client-codecommit/commands/ListTagsForResourceCommand.ts b/clients/client-codecommit/commands/ListTagsForResourceCommand.ts index 7338a192a7f8..056c26fb5a2e 100644 --- a/clients/client-codecommit/commands/ListTagsForResourceCommand.ts +++ b/clients/client-codecommit/commands/ListTagsForResourceCommand.ts @@ -24,6 +24,20 @@ export interface ListTagsForResourceCommandOutput extends ListTagsForResourceOut *

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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { CodeCommitClient, ListTagsForResourceCommand } from "@aws-sdk/client-codecommit"; // ES Modules import + * // const { CodeCommitClient, ListTagsForResourceCommand } = require("@aws-sdk/client-codecommit"); // CommonJS import + * const client = new CodeCommitClient(config); + * const command = new ListTagsForResourceCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListTagsForResourceCommandInput} for command's `input` shape. + * @see {@link ListTagsForResourceCommandOutput} for command's `response` shape. + * @see {@link CodeCommitClientResolvedConfig | config} for command's `input` shape. + * */ export class ListTagsForResourceCommand extends $Command< ListTagsForResourceCommandInput, diff --git a/clients/client-codecommit/commands/MergeBranchesByFastForwardCommand.ts b/clients/client-codecommit/commands/MergeBranchesByFastForwardCommand.ts index a25778c4fbd7..b61c69975b4d 100644 --- a/clients/client-codecommit/commands/MergeBranchesByFastForwardCommand.ts +++ b/clients/client-codecommit/commands/MergeBranchesByFastForwardCommand.ts @@ -22,6 +22,20 @@ export interface MergeBranchesByFastForwardCommandOutput extends MergeBranchesBy /** *

Merges two branches using the fast-forward merge strategy.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { CodeCommitClient, MergeBranchesByFastForwardCommand } from "@aws-sdk/client-codecommit"; // ES Modules import + * // const { CodeCommitClient, MergeBranchesByFastForwardCommand } = require("@aws-sdk/client-codecommit"); // CommonJS import + * const client = new CodeCommitClient(config); + * const command = new MergeBranchesByFastForwardCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link MergeBranchesByFastForwardCommandInput} for command's `input` shape. + * @see {@link MergeBranchesByFastForwardCommandOutput} for command's `response` shape. + * @see {@link CodeCommitClientResolvedConfig | config} for command's `input` shape. + * */ export class MergeBranchesByFastForwardCommand extends $Command< MergeBranchesByFastForwardCommandInput, diff --git a/clients/client-codecommit/commands/MergeBranchesBySquashCommand.ts b/clients/client-codecommit/commands/MergeBranchesBySquashCommand.ts index 4824e95a7dfe..9d71fe67a47d 100644 --- a/clients/client-codecommit/commands/MergeBranchesBySquashCommand.ts +++ b/clients/client-codecommit/commands/MergeBranchesBySquashCommand.ts @@ -22,6 +22,20 @@ export interface MergeBranchesBySquashCommandOutput extends MergeBranchesBySquas /** *

Merges two branches using the squash merge strategy.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { CodeCommitClient, MergeBranchesBySquashCommand } from "@aws-sdk/client-codecommit"; // ES Modules import + * // const { CodeCommitClient, MergeBranchesBySquashCommand } = require("@aws-sdk/client-codecommit"); // CommonJS import + * const client = new CodeCommitClient(config); + * const command = new MergeBranchesBySquashCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link MergeBranchesBySquashCommandInput} for command's `input` shape. + * @see {@link MergeBranchesBySquashCommandOutput} for command's `response` shape. + * @see {@link CodeCommitClientResolvedConfig | config} for command's `input` shape. + * */ export class MergeBranchesBySquashCommand extends $Command< MergeBranchesBySquashCommandInput, diff --git a/clients/client-codecommit/commands/MergeBranchesByThreeWayCommand.ts b/clients/client-codecommit/commands/MergeBranchesByThreeWayCommand.ts index d2cd0bd521d9..43f7f6042a90 100644 --- a/clients/client-codecommit/commands/MergeBranchesByThreeWayCommand.ts +++ b/clients/client-codecommit/commands/MergeBranchesByThreeWayCommand.ts @@ -22,6 +22,20 @@ export interface MergeBranchesByThreeWayCommandOutput extends MergeBranchesByThr /** *

Merges two specified branches using the three-way merge strategy.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { CodeCommitClient, MergeBranchesByThreeWayCommand } from "@aws-sdk/client-codecommit"; // ES Modules import + * // const { CodeCommitClient, MergeBranchesByThreeWayCommand } = require("@aws-sdk/client-codecommit"); // CommonJS import + * const client = new CodeCommitClient(config); + * const command = new MergeBranchesByThreeWayCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link MergeBranchesByThreeWayCommandInput} for command's `input` shape. + * @see {@link MergeBranchesByThreeWayCommandOutput} for command's `response` shape. + * @see {@link CodeCommitClientResolvedConfig | config} for command's `input` shape. + * */ export class MergeBranchesByThreeWayCommand extends $Command< MergeBranchesByThreeWayCommandInput, diff --git a/clients/client-codecommit/commands/MergePullRequestByFastForwardCommand.ts b/clients/client-codecommit/commands/MergePullRequestByFastForwardCommand.ts index 4883548932b7..f46da9f1ac72 100644 --- a/clients/client-codecommit/commands/MergePullRequestByFastForwardCommand.ts +++ b/clients/client-codecommit/commands/MergePullRequestByFastForwardCommand.ts @@ -25,6 +25,20 @@ export interface MergePullRequestByFastForwardCommandOutput /** *

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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { CodeCommitClient, MergePullRequestByFastForwardCommand } from "@aws-sdk/client-codecommit"; // ES Modules import + * // const { CodeCommitClient, MergePullRequestByFastForwardCommand } = require("@aws-sdk/client-codecommit"); // CommonJS import + * const client = new CodeCommitClient(config); + * const command = new MergePullRequestByFastForwardCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link MergePullRequestByFastForwardCommandInput} for command's `input` shape. + * @see {@link MergePullRequestByFastForwardCommandOutput} for command's `response` shape. + * @see {@link CodeCommitClientResolvedConfig | config} for command's `input` shape. + * */ export class MergePullRequestByFastForwardCommand extends $Command< MergePullRequestByFastForwardCommandInput, diff --git a/clients/client-codecommit/commands/MergePullRequestBySquashCommand.ts b/clients/client-codecommit/commands/MergePullRequestBySquashCommand.ts index e4f86377c140..f3d377a19713 100644 --- a/clients/client-codecommit/commands/MergePullRequestBySquashCommand.ts +++ b/clients/client-codecommit/commands/MergePullRequestBySquashCommand.ts @@ -23,6 +23,20 @@ export interface MergePullRequestBySquashCommandOutput extends MergePullRequestB /** *

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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { CodeCommitClient, MergePullRequestBySquashCommand } from "@aws-sdk/client-codecommit"; // ES Modules import + * // const { CodeCommitClient, MergePullRequestBySquashCommand } = require("@aws-sdk/client-codecommit"); // CommonJS import + * const client = new CodeCommitClient(config); + * const command = new MergePullRequestBySquashCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link MergePullRequestBySquashCommandInput} for command's `input` shape. + * @see {@link MergePullRequestBySquashCommandOutput} for command's `response` shape. + * @see {@link CodeCommitClientResolvedConfig | config} for command's `input` shape. + * */ export class MergePullRequestBySquashCommand extends $Command< MergePullRequestBySquashCommandInput, diff --git a/clients/client-codecommit/commands/MergePullRequestByThreeWayCommand.ts b/clients/client-codecommit/commands/MergePullRequestByThreeWayCommand.ts index d1d7ebc0d99c..df430180c13c 100644 --- a/clients/client-codecommit/commands/MergePullRequestByThreeWayCommand.ts +++ b/clients/client-codecommit/commands/MergePullRequestByThreeWayCommand.ts @@ -23,6 +23,20 @@ export interface MergePullRequestByThreeWayCommandOutput extends MergePullReques /** *

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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { CodeCommitClient, MergePullRequestByThreeWayCommand } from "@aws-sdk/client-codecommit"; // ES Modules import + * // const { CodeCommitClient, MergePullRequestByThreeWayCommand } = require("@aws-sdk/client-codecommit"); // CommonJS import + * const client = new CodeCommitClient(config); + * const command = new MergePullRequestByThreeWayCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link MergePullRequestByThreeWayCommandInput} for command's `input` shape. + * @see {@link MergePullRequestByThreeWayCommandOutput} for command's `response` shape. + * @see {@link CodeCommitClientResolvedConfig | config} for command's `input` shape. + * */ export class MergePullRequestByThreeWayCommand extends $Command< MergePullRequestByThreeWayCommandInput, diff --git a/clients/client-codecommit/commands/OverridePullRequestApprovalRulesCommand.ts b/clients/client-codecommit/commands/OverridePullRequestApprovalRulesCommand.ts index f5d0d84a0e7e..c3172c992949 100644 --- a/clients/client-codecommit/commands/OverridePullRequestApprovalRulesCommand.ts +++ b/clients/client-codecommit/commands/OverridePullRequestApprovalRulesCommand.ts @@ -22,6 +22,20 @@ export interface OverridePullRequestApprovalRulesCommandOutput extends __Metadat /** *

Sets aside (overrides) all approval rule requirements for a specified pull request.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { CodeCommitClient, OverridePullRequestApprovalRulesCommand } from "@aws-sdk/client-codecommit"; // ES Modules import + * // const { CodeCommitClient, OverridePullRequestApprovalRulesCommand } = require("@aws-sdk/client-codecommit"); // CommonJS import + * const client = new CodeCommitClient(config); + * const command = new OverridePullRequestApprovalRulesCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link OverridePullRequestApprovalRulesCommandInput} for command's `input` shape. + * @see {@link OverridePullRequestApprovalRulesCommandOutput} for command's `response` shape. + * @see {@link CodeCommitClientResolvedConfig | config} for command's `input` shape. + * */ export class OverridePullRequestApprovalRulesCommand extends $Command< OverridePullRequestApprovalRulesCommandInput, diff --git a/clients/client-codecommit/commands/PostCommentForComparedCommitCommand.ts b/clients/client-codecommit/commands/PostCommentForComparedCommitCommand.ts index d948d918ebaa..1821b679edbb 100644 --- a/clients/client-codecommit/commands/PostCommentForComparedCommitCommand.ts +++ b/clients/client-codecommit/commands/PostCommentForComparedCommitCommand.ts @@ -24,6 +24,20 @@ export interface PostCommentForComparedCommitCommandOutput /** *

Posts a comment on the comparison between two commits.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { CodeCommitClient, PostCommentForComparedCommitCommand } from "@aws-sdk/client-codecommit"; // ES Modules import + * // const { CodeCommitClient, PostCommentForComparedCommitCommand } = require("@aws-sdk/client-codecommit"); // CommonJS import + * const client = new CodeCommitClient(config); + * const command = new PostCommentForComparedCommitCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link PostCommentForComparedCommitCommandInput} for command's `input` shape. + * @see {@link PostCommentForComparedCommitCommandOutput} for command's `response` shape. + * @see {@link CodeCommitClientResolvedConfig | config} for command's `input` shape. + * */ export class PostCommentForComparedCommitCommand extends $Command< PostCommentForComparedCommitCommandInput, diff --git a/clients/client-codecommit/commands/PostCommentForPullRequestCommand.ts b/clients/client-codecommit/commands/PostCommentForPullRequestCommand.ts index f6898a3a25eb..186215719b9d 100644 --- a/clients/client-codecommit/commands/PostCommentForPullRequestCommand.ts +++ b/clients/client-codecommit/commands/PostCommentForPullRequestCommand.ts @@ -22,6 +22,20 @@ export interface PostCommentForPullRequestCommandOutput extends PostCommentForPu /** *

Posts a comment on a pull request.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { CodeCommitClient, PostCommentForPullRequestCommand } from "@aws-sdk/client-codecommit"; // ES Modules import + * // const { CodeCommitClient, PostCommentForPullRequestCommand } = require("@aws-sdk/client-codecommit"); // CommonJS import + * const client = new CodeCommitClient(config); + * const command = new PostCommentForPullRequestCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link PostCommentForPullRequestCommandInput} for command's `input` shape. + * @see {@link PostCommentForPullRequestCommandOutput} for command's `response` shape. + * @see {@link CodeCommitClientResolvedConfig | config} for command's `input` shape. + * */ export class PostCommentForPullRequestCommand extends $Command< PostCommentForPullRequestCommandInput, diff --git a/clients/client-codecommit/commands/PostCommentReplyCommand.ts b/clients/client-codecommit/commands/PostCommentReplyCommand.ts index 10ca020c079e..104dabb309e0 100644 --- a/clients/client-codecommit/commands/PostCommentReplyCommand.ts +++ b/clients/client-codecommit/commands/PostCommentReplyCommand.ts @@ -22,6 +22,20 @@ export interface PostCommentReplyCommandOutput extends PostCommentReplyOutput, _ /** *

Posts a comment in reply to an existing comment on a comparison between commits or a pull request.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { CodeCommitClient, PostCommentReplyCommand } from "@aws-sdk/client-codecommit"; // ES Modules import + * // const { CodeCommitClient, PostCommentReplyCommand } = require("@aws-sdk/client-codecommit"); // CommonJS import + * const client = new CodeCommitClient(config); + * const command = new PostCommentReplyCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link PostCommentReplyCommandInput} for command's `input` shape. + * @see {@link PostCommentReplyCommandOutput} for command's `response` shape. + * @see {@link CodeCommitClientResolvedConfig | config} for command's `input` shape. + * */ export class PostCommentReplyCommand extends $Command< PostCommentReplyCommandInput, diff --git a/clients/client-codecommit/commands/PutCommentReactionCommand.ts b/clients/client-codecommit/commands/PutCommentReactionCommand.ts index 94d9dba4e165..16241659dc55 100644 --- a/clients/client-codecommit/commands/PutCommentReactionCommand.ts +++ b/clients/client-codecommit/commands/PutCommentReactionCommand.ts @@ -23,6 +23,20 @@ export interface PutCommentReactionCommandOutput extends __MetadataBearer {} /** *

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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { CodeCommitClient, PutCommentReactionCommand } from "@aws-sdk/client-codecommit"; // ES Modules import + * // const { CodeCommitClient, PutCommentReactionCommand } = require("@aws-sdk/client-codecommit"); // CommonJS import + * const client = new CodeCommitClient(config); + * const command = new PutCommentReactionCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link PutCommentReactionCommandInput} for command's `input` shape. + * @see {@link PutCommentReactionCommandOutput} for command's `response` shape. + * @see {@link CodeCommitClientResolvedConfig | config} for command's `input` shape. + * */ export class PutCommentReactionCommand extends $Command< PutCommentReactionCommandInput, diff --git a/clients/client-codecommit/commands/PutFileCommand.ts b/clients/client-codecommit/commands/PutFileCommand.ts index 4ca11ffebb2a..cf488a82879b 100644 --- a/clients/client-codecommit/commands/PutFileCommand.ts +++ b/clients/client-codecommit/commands/PutFileCommand.ts @@ -19,6 +19,20 @@ export interface PutFileCommandOutput extends PutFileOutput, __MetadataBearer {} /** *

Adds or updates a file in a branch in an AWS CodeCommit repository, and generates a commit for the addition in the specified branch.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { CodeCommitClient, PutFileCommand } from "@aws-sdk/client-codecommit"; // ES Modules import + * // const { CodeCommitClient, PutFileCommand } = require("@aws-sdk/client-codecommit"); // CommonJS import + * const client = new CodeCommitClient(config); + * const command = new PutFileCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link PutFileCommandInput} for command's `input` shape. + * @see {@link PutFileCommandOutput} for command's `response` shape. + * @see {@link CodeCommitClientResolvedConfig | config} for command's `input` shape. + * */ export class PutFileCommand extends $Command< PutFileCommandInput, diff --git a/clients/client-codecommit/commands/PutRepositoryTriggersCommand.ts b/clients/client-codecommit/commands/PutRepositoryTriggersCommand.ts index f1cb97b28cd6..dbb4e0484a8b 100644 --- a/clients/client-codecommit/commands/PutRepositoryTriggersCommand.ts +++ b/clients/client-codecommit/commands/PutRepositoryTriggersCommand.ts @@ -22,6 +22,20 @@ export interface PutRepositoryTriggersCommandOutput extends PutRepositoryTrigger /** *

Replaces all triggers for a repository. Used to create or delete triggers.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { CodeCommitClient, PutRepositoryTriggersCommand } from "@aws-sdk/client-codecommit"; // ES Modules import + * // const { CodeCommitClient, PutRepositoryTriggersCommand } = require("@aws-sdk/client-codecommit"); // CommonJS import + * const client = new CodeCommitClient(config); + * const command = new PutRepositoryTriggersCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link PutRepositoryTriggersCommandInput} for command's `input` shape. + * @see {@link PutRepositoryTriggersCommandOutput} for command's `response` shape. + * @see {@link CodeCommitClientResolvedConfig | config} for command's `input` shape. + * */ export class PutRepositoryTriggersCommand extends $Command< PutRepositoryTriggersCommandInput, diff --git a/clients/client-codecommit/commands/TagResourceCommand.ts b/clients/client-codecommit/commands/TagResourceCommand.ts index 437a3290bb26..c70057d8358c 100644 --- a/clients/client-codecommit/commands/TagResourceCommand.ts +++ b/clients/client-codecommit/commands/TagResourceCommand.ts @@ -24,6 +24,20 @@ export interface TagResourceCommandOutput extends __MetadataBearer {} *

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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { CodeCommitClient, TagResourceCommand } from "@aws-sdk/client-codecommit"; // ES Modules import + * // const { CodeCommitClient, TagResourceCommand } = require("@aws-sdk/client-codecommit"); // CommonJS import + * const client = new CodeCommitClient(config); + * const command = new TagResourceCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link TagResourceCommandInput} for command's `input` shape. + * @see {@link TagResourceCommandOutput} for command's `response` shape. + * @see {@link CodeCommitClientResolvedConfig | config} for command's `input` shape. + * */ export class TagResourceCommand extends $Command< TagResourceCommandInput, diff --git a/clients/client-codecommit/commands/TestRepositoryTriggersCommand.ts b/clients/client-codecommit/commands/TestRepositoryTriggersCommand.ts index 98d7895cc95e..0bc7d4818b47 100644 --- a/clients/client-codecommit/commands/TestRepositoryTriggersCommand.ts +++ b/clients/client-codecommit/commands/TestRepositoryTriggersCommand.ts @@ -24,6 +24,20 @@ export interface TestRepositoryTriggersCommandOutput extends TestRepositoryTrigg *

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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { CodeCommitClient, TestRepositoryTriggersCommand } from "@aws-sdk/client-codecommit"; // ES Modules import + * // const { CodeCommitClient, TestRepositoryTriggersCommand } = require("@aws-sdk/client-codecommit"); // CommonJS import + * const client = new CodeCommitClient(config); + * const command = new TestRepositoryTriggersCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link TestRepositoryTriggersCommandInput} for command's `input` shape. + * @see {@link TestRepositoryTriggersCommandOutput} for command's `response` shape. + * @see {@link CodeCommitClientResolvedConfig | config} for command's `input` shape. + * */ export class TestRepositoryTriggersCommand extends $Command< TestRepositoryTriggersCommandInput, diff --git a/clients/client-codecommit/commands/UntagResourceCommand.ts b/clients/client-codecommit/commands/UntagResourceCommand.ts index 41fa7c93d1d3..5bce960b2866 100644 --- a/clients/client-codecommit/commands/UntagResourceCommand.ts +++ b/clients/client-codecommit/commands/UntagResourceCommand.ts @@ -24,6 +24,20 @@ export interface UntagResourceCommandOutput extends __MetadataBearer {} *

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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { CodeCommitClient, UntagResourceCommand } from "@aws-sdk/client-codecommit"; // ES Modules import + * // const { CodeCommitClient, UntagResourceCommand } = require("@aws-sdk/client-codecommit"); // CommonJS import + * const client = new CodeCommitClient(config); + * const command = new UntagResourceCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link UntagResourceCommandInput} for command's `input` shape. + * @see {@link UntagResourceCommandOutput} for command's `response` shape. + * @see {@link CodeCommitClientResolvedConfig | config} for command's `input` shape. + * */ export class UntagResourceCommand extends $Command< UntagResourceCommandInput, diff --git a/clients/client-codecommit/commands/UpdateApprovalRuleTemplateContentCommand.ts b/clients/client-codecommit/commands/UpdateApprovalRuleTemplateContentCommand.ts index 3b93380508b2..68073b33ac91 100644 --- a/clients/client-codecommit/commands/UpdateApprovalRuleTemplateContentCommand.ts +++ b/clients/client-codecommit/commands/UpdateApprovalRuleTemplateContentCommand.ts @@ -26,6 +26,20 @@ export interface UpdateApprovalRuleTemplateContentCommandOutput *

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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { CodeCommitClient, UpdateApprovalRuleTemplateContentCommand } from "@aws-sdk/client-codecommit"; // ES Modules import + * // const { CodeCommitClient, UpdateApprovalRuleTemplateContentCommand } = require("@aws-sdk/client-codecommit"); // CommonJS import + * const client = new CodeCommitClient(config); + * const command = new UpdateApprovalRuleTemplateContentCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link UpdateApprovalRuleTemplateContentCommandInput} for command's `input` shape. + * @see {@link UpdateApprovalRuleTemplateContentCommandOutput} for command's `response` shape. + * @see {@link CodeCommitClientResolvedConfig | config} for command's `input` shape. + * */ export class UpdateApprovalRuleTemplateContentCommand extends $Command< UpdateApprovalRuleTemplateContentCommandInput, diff --git a/clients/client-codecommit/commands/UpdateApprovalRuleTemplateDescriptionCommand.ts b/clients/client-codecommit/commands/UpdateApprovalRuleTemplateDescriptionCommand.ts index 7c29ea0cf121..7323d6fada90 100644 --- a/clients/client-codecommit/commands/UpdateApprovalRuleTemplateDescriptionCommand.ts +++ b/clients/client-codecommit/commands/UpdateApprovalRuleTemplateDescriptionCommand.ts @@ -27,6 +27,20 @@ export interface UpdateApprovalRuleTemplateDescriptionCommandOutput /** *

Updates the description for a specified approval rule template.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { CodeCommitClient, UpdateApprovalRuleTemplateDescriptionCommand } from "@aws-sdk/client-codecommit"; // ES Modules import + * // const { CodeCommitClient, UpdateApprovalRuleTemplateDescriptionCommand } = require("@aws-sdk/client-codecommit"); // CommonJS import + * const client = new CodeCommitClient(config); + * const command = new UpdateApprovalRuleTemplateDescriptionCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link UpdateApprovalRuleTemplateDescriptionCommandInput} for command's `input` shape. + * @see {@link UpdateApprovalRuleTemplateDescriptionCommandOutput} for command's `response` shape. + * @see {@link CodeCommitClientResolvedConfig | config} for command's `input` shape. + * */ export class UpdateApprovalRuleTemplateDescriptionCommand extends $Command< UpdateApprovalRuleTemplateDescriptionCommandInput, diff --git a/clients/client-codecommit/commands/UpdateApprovalRuleTemplateNameCommand.ts b/clients/client-codecommit/commands/UpdateApprovalRuleTemplateNameCommand.ts index 9df70e51db67..2348406730ac 100644 --- a/clients/client-codecommit/commands/UpdateApprovalRuleTemplateNameCommand.ts +++ b/clients/client-codecommit/commands/UpdateApprovalRuleTemplateNameCommand.ts @@ -24,6 +24,20 @@ export interface UpdateApprovalRuleTemplateNameCommandOutput /** *

Updates the name of a specified approval rule template.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { CodeCommitClient, UpdateApprovalRuleTemplateNameCommand } from "@aws-sdk/client-codecommit"; // ES Modules import + * // const { CodeCommitClient, UpdateApprovalRuleTemplateNameCommand } = require("@aws-sdk/client-codecommit"); // CommonJS import + * const client = new CodeCommitClient(config); + * const command = new UpdateApprovalRuleTemplateNameCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link UpdateApprovalRuleTemplateNameCommandInput} for command's `input` shape. + * @see {@link UpdateApprovalRuleTemplateNameCommandOutput} for command's `response` shape. + * @see {@link CodeCommitClientResolvedConfig | config} for command's `input` shape. + * */ export class UpdateApprovalRuleTemplateNameCommand extends $Command< UpdateApprovalRuleTemplateNameCommandInput, diff --git a/clients/client-codecommit/commands/UpdateCommentCommand.ts b/clients/client-codecommit/commands/UpdateCommentCommand.ts index ce3658ce8194..4293f728d096 100644 --- a/clients/client-codecommit/commands/UpdateCommentCommand.ts +++ b/clients/client-codecommit/commands/UpdateCommentCommand.ts @@ -22,6 +22,20 @@ export interface UpdateCommentCommandOutput extends UpdateCommentOutput, __Metad /** *

Replaces the contents of a comment.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { CodeCommitClient, UpdateCommentCommand } from "@aws-sdk/client-codecommit"; // ES Modules import + * // const { CodeCommitClient, UpdateCommentCommand } = require("@aws-sdk/client-codecommit"); // CommonJS import + * const client = new CodeCommitClient(config); + * const command = new UpdateCommentCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link UpdateCommentCommandInput} for command's `input` shape. + * @see {@link UpdateCommentCommandOutput} for command's `response` shape. + * @see {@link CodeCommitClientResolvedConfig | config} for command's `input` shape. + * */ export class UpdateCommentCommand extends $Command< UpdateCommentCommandInput, diff --git a/clients/client-codecommit/commands/UpdateDefaultBranchCommand.ts b/clients/client-codecommit/commands/UpdateDefaultBranchCommand.ts index 5d4f3fc2bb77..1cbeb5b755a0 100644 --- a/clients/client-codecommit/commands/UpdateDefaultBranchCommand.ts +++ b/clients/client-codecommit/commands/UpdateDefaultBranchCommand.ts @@ -25,6 +25,20 @@ export interface UpdateDefaultBranchCommandOutput extends __MetadataBearer {} * *

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.

* + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { CodeCommitClient, UpdateDefaultBranchCommand } from "@aws-sdk/client-codecommit"; // ES Modules import + * // const { CodeCommitClient, UpdateDefaultBranchCommand } = require("@aws-sdk/client-codecommit"); // CommonJS import + * const client = new CodeCommitClient(config); + * const command = new UpdateDefaultBranchCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link UpdateDefaultBranchCommandInput} for command's `input` shape. + * @see {@link UpdateDefaultBranchCommandOutput} for command's `response` shape. + * @see {@link CodeCommitClientResolvedConfig | config} for command's `input` shape. + * */ export class UpdateDefaultBranchCommand extends $Command< UpdateDefaultBranchCommandInput, diff --git a/clients/client-codecommit/commands/UpdatePullRequestApprovalRuleContentCommand.ts b/clients/client-codecommit/commands/UpdatePullRequestApprovalRuleContentCommand.ts index aee791c40e1c..93a1dadc19a2 100644 --- a/clients/client-codecommit/commands/UpdatePullRequestApprovalRuleContentCommand.ts +++ b/clients/client-codecommit/commands/UpdatePullRequestApprovalRuleContentCommand.ts @@ -28,6 +28,20 @@ export interface UpdatePullRequestApprovalRuleContentCommandOutput /** *

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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { CodeCommitClient, UpdatePullRequestApprovalRuleContentCommand } from "@aws-sdk/client-codecommit"; // ES Modules import + * // const { CodeCommitClient, UpdatePullRequestApprovalRuleContentCommand } = require("@aws-sdk/client-codecommit"); // CommonJS import + * const client = new CodeCommitClient(config); + * const command = new UpdatePullRequestApprovalRuleContentCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link UpdatePullRequestApprovalRuleContentCommandInput} for command's `input` shape. + * @see {@link UpdatePullRequestApprovalRuleContentCommandOutput} for command's `response` shape. + * @see {@link CodeCommitClientResolvedConfig | config} for command's `input` shape. + * */ export class UpdatePullRequestApprovalRuleContentCommand extends $Command< UpdatePullRequestApprovalRuleContentCommandInput, diff --git a/clients/client-codecommit/commands/UpdatePullRequestApprovalStateCommand.ts b/clients/client-codecommit/commands/UpdatePullRequestApprovalStateCommand.ts index 8057a666f455..9f8209a237d0 100644 --- a/clients/client-codecommit/commands/UpdatePullRequestApprovalStateCommand.ts +++ b/clients/client-codecommit/commands/UpdatePullRequestApprovalStateCommand.ts @@ -22,6 +22,20 @@ export interface UpdatePullRequestApprovalStateCommandOutput extends __MetadataB /** *

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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { CodeCommitClient, UpdatePullRequestApprovalStateCommand } from "@aws-sdk/client-codecommit"; // ES Modules import + * // const { CodeCommitClient, UpdatePullRequestApprovalStateCommand } = require("@aws-sdk/client-codecommit"); // CommonJS import + * const client = new CodeCommitClient(config); + * const command = new UpdatePullRequestApprovalStateCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link UpdatePullRequestApprovalStateCommandInput} for command's `input` shape. + * @see {@link UpdatePullRequestApprovalStateCommandOutput} for command's `response` shape. + * @see {@link CodeCommitClientResolvedConfig | config} for command's `input` shape. + * */ export class UpdatePullRequestApprovalStateCommand extends $Command< UpdatePullRequestApprovalStateCommandInput, diff --git a/clients/client-codecommit/commands/UpdatePullRequestDescriptionCommand.ts b/clients/client-codecommit/commands/UpdatePullRequestDescriptionCommand.ts index 53adc57fdf4a..5057e8192438 100644 --- a/clients/client-codecommit/commands/UpdatePullRequestDescriptionCommand.ts +++ b/clients/client-codecommit/commands/UpdatePullRequestDescriptionCommand.ts @@ -24,6 +24,20 @@ export interface UpdatePullRequestDescriptionCommandOutput /** *

Replaces the contents of the description of a pull request.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { CodeCommitClient, UpdatePullRequestDescriptionCommand } from "@aws-sdk/client-codecommit"; // ES Modules import + * // const { CodeCommitClient, UpdatePullRequestDescriptionCommand } = require("@aws-sdk/client-codecommit"); // CommonJS import + * const client = new CodeCommitClient(config); + * const command = new UpdatePullRequestDescriptionCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link UpdatePullRequestDescriptionCommandInput} for command's `input` shape. + * @see {@link UpdatePullRequestDescriptionCommandOutput} for command's `response` shape. + * @see {@link CodeCommitClientResolvedConfig | config} for command's `input` shape. + * */ export class UpdatePullRequestDescriptionCommand extends $Command< UpdatePullRequestDescriptionCommandInput, diff --git a/clients/client-codecommit/commands/UpdatePullRequestStatusCommand.ts b/clients/client-codecommit/commands/UpdatePullRequestStatusCommand.ts index f35a415eb7be..fa1ef3f87b62 100644 --- a/clients/client-codecommit/commands/UpdatePullRequestStatusCommand.ts +++ b/clients/client-codecommit/commands/UpdatePullRequestStatusCommand.ts @@ -22,6 +22,20 @@ export interface UpdatePullRequestStatusCommandOutput extends UpdatePullRequestS /** *

Updates the status of a pull request.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { CodeCommitClient, UpdatePullRequestStatusCommand } from "@aws-sdk/client-codecommit"; // ES Modules import + * // const { CodeCommitClient, UpdatePullRequestStatusCommand } = require("@aws-sdk/client-codecommit"); // CommonJS import + * const client = new CodeCommitClient(config); + * const command = new UpdatePullRequestStatusCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link UpdatePullRequestStatusCommandInput} for command's `input` shape. + * @see {@link UpdatePullRequestStatusCommandOutput} for command's `response` shape. + * @see {@link CodeCommitClientResolvedConfig | config} for command's `input` shape. + * */ export class UpdatePullRequestStatusCommand extends $Command< UpdatePullRequestStatusCommandInput, diff --git a/clients/client-codecommit/commands/UpdatePullRequestTitleCommand.ts b/clients/client-codecommit/commands/UpdatePullRequestTitleCommand.ts index 93277b6d3fcc..c12e49ad2460 100644 --- a/clients/client-codecommit/commands/UpdatePullRequestTitleCommand.ts +++ b/clients/client-codecommit/commands/UpdatePullRequestTitleCommand.ts @@ -22,6 +22,20 @@ export interface UpdatePullRequestTitleCommandOutput extends UpdatePullRequestTi /** *

Replaces the title of a pull request.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { CodeCommitClient, UpdatePullRequestTitleCommand } from "@aws-sdk/client-codecommit"; // ES Modules import + * // const { CodeCommitClient, UpdatePullRequestTitleCommand } = require("@aws-sdk/client-codecommit"); // CommonJS import + * const client = new CodeCommitClient(config); + * const command = new UpdatePullRequestTitleCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link UpdatePullRequestTitleCommandInput} for command's `input` shape. + * @see {@link UpdatePullRequestTitleCommandOutput} for command's `response` shape. + * @see {@link CodeCommitClientResolvedConfig | config} for command's `input` shape. + * */ export class UpdatePullRequestTitleCommand extends $Command< UpdatePullRequestTitleCommandInput, diff --git a/clients/client-codecommit/commands/UpdateRepositoryDescriptionCommand.ts b/clients/client-codecommit/commands/UpdateRepositoryDescriptionCommand.ts index 4838f5a0f4a0..693ff73380bb 100644 --- a/clients/client-codecommit/commands/UpdateRepositoryDescriptionCommand.ts +++ b/clients/client-codecommit/commands/UpdateRepositoryDescriptionCommand.ts @@ -29,6 +29,20 @@ export interface UpdateRepositoryDescriptionCommandOutput extends __MetadataBear * HTML-encode the description field in any application that uses this API to display * the repository description on a webpage.

* + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { CodeCommitClient, UpdateRepositoryDescriptionCommand } from "@aws-sdk/client-codecommit"; // ES Modules import + * // const { CodeCommitClient, UpdateRepositoryDescriptionCommand } = require("@aws-sdk/client-codecommit"); // CommonJS import + * const client = new CodeCommitClient(config); + * const command = new UpdateRepositoryDescriptionCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link UpdateRepositoryDescriptionCommandInput} for command's `input` shape. + * @see {@link UpdateRepositoryDescriptionCommandOutput} for command's `response` shape. + * @see {@link CodeCommitClientResolvedConfig | config} for command's `input` shape. + * */ export class UpdateRepositoryDescriptionCommand extends $Command< UpdateRepositoryDescriptionCommandInput, diff --git a/clients/client-codecommit/commands/UpdateRepositoryNameCommand.ts b/clients/client-codecommit/commands/UpdateRepositoryNameCommand.ts index 16db0beab11d..a477f0c4c148 100644 --- a/clients/client-codecommit/commands/UpdateRepositoryNameCommand.ts +++ b/clients/client-codecommit/commands/UpdateRepositoryNameCommand.ts @@ -26,6 +26,20 @@ export interface UpdateRepositoryNameCommandOutput extends __MetadataBearer {} * 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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { CodeCommitClient, UpdateRepositoryNameCommand } from "@aws-sdk/client-codecommit"; // ES Modules import + * // const { CodeCommitClient, UpdateRepositoryNameCommand } = require("@aws-sdk/client-codecommit"); // CommonJS import + * const client = new CodeCommitClient(config); + * const command = new UpdateRepositoryNameCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link UpdateRepositoryNameCommandInput} for command's `input` shape. + * @see {@link UpdateRepositoryNameCommandOutput} for command's `response` shape. + * @see {@link CodeCommitClientResolvedConfig | config} for command's `input` shape. + * */ export class UpdateRepositoryNameCommand extends $Command< UpdateRepositoryNameCommandInput, diff --git a/clients/client-codecommit/models/models_0.ts b/clients/client-codecommit/models/models_0.ts index 6361acde0625..0decfaf6aa67 100644 --- a/clients/client-codecommit/models/models_0.ts +++ b/clients/client-codecommit/models/models_0.ts @@ -14,6 +14,9 @@ export interface ActorDoesNotExistException extends __SmithyException, $Metadata } export namespace ActorDoesNotExistException { + /** + * @internal + */ export const filterSensitiveLog = (obj: ActorDoesNotExistException): any => ({ ...obj, }); @@ -40,6 +43,9 @@ export interface Approval { } export namespace Approval { + /** + * @internal + */ export const filterSensitiveLog = (obj: Approval): any => ({ ...obj, }); @@ -61,6 +67,9 @@ export interface OriginApprovalRuleTemplate { } export namespace OriginApprovalRuleTemplate { + /** + * @internal + */ export const filterSensitiveLog = (obj: OriginApprovalRuleTemplate): any => ({ ...obj, }); @@ -112,6 +121,9 @@ export interface ApprovalRule { } export namespace ApprovalRule { + /** + * @internal + */ export const filterSensitiveLog = (obj: ApprovalRule): any => ({ ...obj, }); @@ -130,6 +142,9 @@ export interface ApprovalRuleContentRequiredException extends __SmithyException, } export namespace ApprovalRuleContentRequiredException { + /** + * @internal + */ export const filterSensitiveLog = (obj: ApprovalRuleContentRequiredException): any => ({ ...obj, }); @@ -148,6 +163,9 @@ export interface ApprovalRuleDoesNotExistException extends __SmithyException, $M } export namespace ApprovalRuleDoesNotExistException { + /** + * @internal + */ export const filterSensitiveLog = (obj: ApprovalRuleDoesNotExistException): any => ({ ...obj, }); @@ -174,6 +192,9 @@ export interface ApprovalRuleEventMetadata { } export namespace ApprovalRuleEventMetadata { + /** + * @internal + */ export const filterSensitiveLog = (obj: ApprovalRuleEventMetadata): any => ({ ...obj, }); @@ -193,6 +214,9 @@ export interface ApprovalRuleNameAlreadyExistsException extends __SmithyExceptio } export namespace ApprovalRuleNameAlreadyExistsException { + /** + * @internal + */ export const filterSensitiveLog = (obj: ApprovalRuleNameAlreadyExistsException): any => ({ ...obj, }); @@ -211,6 +235,9 @@ export interface ApprovalRuleNameRequiredException extends __SmithyException, $M } export namespace ApprovalRuleNameRequiredException { + /** + * @internal + */ export const filterSensitiveLog = (obj: ApprovalRuleNameRequiredException): any => ({ ...obj, }); @@ -237,6 +264,9 @@ export interface ApprovalRuleOverriddenEventMetadata { } export namespace ApprovalRuleOverriddenEventMetadata { + /** + * @internal + */ export const filterSensitiveLog = (obj: ApprovalRuleOverriddenEventMetadata): any => ({ ...obj, }); @@ -288,6 +318,9 @@ export interface ApprovalRuleTemplate { } export namespace ApprovalRuleTemplate { + /** + * @internal + */ export const filterSensitiveLog = (obj: ApprovalRuleTemplate): any => ({ ...obj, }); @@ -306,6 +339,9 @@ export interface ApprovalRuleTemplateContentRequiredException extends __SmithyEx } export namespace ApprovalRuleTemplateContentRequiredException { + /** + * @internal + */ export const filterSensitiveLog = (obj: ApprovalRuleTemplateContentRequiredException): any => ({ ...obj, }); @@ -325,6 +361,9 @@ export interface ApprovalRuleTemplateDoesNotExistException extends __SmithyExcep } export namespace ApprovalRuleTemplateDoesNotExistException { + /** + * @internal + */ export const filterSensitiveLog = (obj: ApprovalRuleTemplateDoesNotExistException): any => ({ ...obj, }); @@ -344,6 +383,9 @@ export interface ApprovalRuleTemplateInUseException extends __SmithyException, $ } export namespace ApprovalRuleTemplateInUseException { + /** + * @internal + */ export const filterSensitiveLog = (obj: ApprovalRuleTemplateInUseException): any => ({ ...obj, }); @@ -364,6 +406,9 @@ export interface ApprovalRuleTemplateNameAlreadyExistsException extends __Smithy } export namespace ApprovalRuleTemplateNameAlreadyExistsException { + /** + * @internal + */ export const filterSensitiveLog = (obj: ApprovalRuleTemplateNameAlreadyExistsException): any => ({ ...obj, }); @@ -382,6 +427,9 @@ export interface ApprovalRuleTemplateNameRequiredException extends __SmithyExcep } export namespace ApprovalRuleTemplateNameRequiredException { + /** + * @internal + */ export const filterSensitiveLog = (obj: ApprovalRuleTemplateNameRequiredException): any => ({ ...obj, }); @@ -403,6 +451,9 @@ export interface ApprovalStateChangedEventMetadata { } export namespace ApprovalStateChangedEventMetadata { + /** + * @internal + */ export const filterSensitiveLog = (obj: ApprovalStateChangedEventMetadata): any => ({ ...obj, }); @@ -421,6 +472,9 @@ export interface ApprovalStateRequiredException extends __SmithyException, $Meta } export namespace ApprovalStateRequiredException { + /** + * @internal + */ export const filterSensitiveLog = (obj: ApprovalStateRequiredException): any => ({ ...obj, }); @@ -439,6 +493,9 @@ export interface AssociateApprovalRuleTemplateWithRepositoryInput { } export namespace AssociateApprovalRuleTemplateWithRepositoryInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: AssociateApprovalRuleTemplateWithRepositoryInput): any => ({ ...obj, }); @@ -457,6 +514,9 @@ export interface EncryptionIntegrityChecksFailedException extends __SmithyExcept } export namespace EncryptionIntegrityChecksFailedException { + /** + * @internal + */ export const filterSensitiveLog = (obj: EncryptionIntegrityChecksFailedException): any => ({ ...obj, }); @@ -475,6 +535,9 @@ export interface EncryptionKeyAccessDeniedException extends __SmithyException, $ } export namespace EncryptionKeyAccessDeniedException { + /** + * @internal + */ export const filterSensitiveLog = (obj: EncryptionKeyAccessDeniedException): any => ({ ...obj, }); @@ -493,6 +556,9 @@ export interface EncryptionKeyDisabledException extends __SmithyException, $Meta } export namespace EncryptionKeyDisabledException { + /** + * @internal + */ export const filterSensitiveLog = (obj: EncryptionKeyDisabledException): any => ({ ...obj, }); @@ -511,6 +577,9 @@ export interface EncryptionKeyNotFoundException extends __SmithyException, $Meta } export namespace EncryptionKeyNotFoundException { + /** + * @internal + */ export const filterSensitiveLog = (obj: EncryptionKeyNotFoundException): any => ({ ...obj, }); @@ -529,6 +598,9 @@ export interface EncryptionKeyUnavailableException extends __SmithyException, $M } export namespace EncryptionKeyUnavailableException { + /** + * @internal + */ export const filterSensitiveLog = (obj: EncryptionKeyUnavailableException): any => ({ ...obj, }); @@ -550,6 +622,9 @@ export interface InvalidApprovalRuleTemplateNameException extends __SmithyExcept } export namespace InvalidApprovalRuleTemplateNameException { + /** + * @internal + */ export const filterSensitiveLog = (obj: InvalidApprovalRuleTemplateNameException): any => ({ ...obj, }); @@ -574,6 +649,9 @@ export interface InvalidRepositoryNameException extends __SmithyException, $Meta } export namespace InvalidRepositoryNameException { + /** + * @internal + */ export const filterSensitiveLog = (obj: InvalidRepositoryNameException): any => ({ ...obj, }); @@ -593,6 +671,9 @@ export interface MaximumRuleTemplatesAssociatedWithRepositoryException extends _ } export namespace MaximumRuleTemplatesAssociatedWithRepositoryException { + /** + * @internal + */ export const filterSensitiveLog = (obj: MaximumRuleTemplatesAssociatedWithRepositoryException): any => ({ ...obj, }); @@ -611,6 +692,9 @@ export interface RepositoryDoesNotExistException extends __SmithyException, $Met } export namespace RepositoryDoesNotExistException { + /** + * @internal + */ export const filterSensitiveLog = (obj: RepositoryDoesNotExistException): any => ({ ...obj, }); @@ -629,6 +713,9 @@ export interface RepositoryNameRequiredException extends __SmithyException, $Met } export namespace RepositoryNameRequiredException { + /** + * @internal + */ export const filterSensitiveLog = (obj: RepositoryNameRequiredException): any => ({ ...obj, }); @@ -647,6 +734,9 @@ export interface AuthorDoesNotExistException extends __SmithyException, $Metadat } export namespace AuthorDoesNotExistException { + /** + * @internal + */ export const filterSensitiveLog = (obj: AuthorDoesNotExistException): any => ({ ...obj, }); @@ -668,6 +758,9 @@ export interface BatchAssociateApprovalRuleTemplateWithRepositoriesInput { } export namespace BatchAssociateApprovalRuleTemplateWithRepositoriesInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: BatchAssociateApprovalRuleTemplateWithRepositoriesInput): any => ({ ...obj, }); @@ -694,6 +787,9 @@ export interface BatchAssociateApprovalRuleTemplateWithRepositoriesError { } export namespace BatchAssociateApprovalRuleTemplateWithRepositoriesError { + /** + * @internal + */ export const filterSensitiveLog = (obj: BatchAssociateApprovalRuleTemplateWithRepositoriesError): any => ({ ...obj, }); @@ -712,6 +808,9 @@ export interface BatchAssociateApprovalRuleTemplateWithRepositoriesOutput { } export namespace BatchAssociateApprovalRuleTemplateWithRepositoriesOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: BatchAssociateApprovalRuleTemplateWithRepositoriesOutput): any => ({ ...obj, }); @@ -730,6 +829,9 @@ export interface MaximumRepositoryNamesExceededException extends __SmithyExcepti } export namespace MaximumRepositoryNamesExceededException { + /** + * @internal + */ export const filterSensitiveLog = (obj: MaximumRepositoryNamesExceededException): any => ({ ...obj, }); @@ -748,6 +850,9 @@ export interface RepositoryNamesRequiredException extends __SmithyException, $Me } export namespace RepositoryNamesRequiredException { + /** + * @internal + */ export const filterSensitiveLog = (obj: RepositoryNamesRequiredException): any => ({ ...obj, }); @@ -832,6 +937,9 @@ export interface BatchDescribeMergeConflictsInput { } export namespace BatchDescribeMergeConflictsInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: BatchDescribeMergeConflictsInput): any => ({ ...obj, }); @@ -864,6 +972,9 @@ export interface FileModes { } export namespace FileModes { + /** + * @internal + */ export const filterSensitiveLog = (obj: FileModes): any => ({ ...obj, }); @@ -890,6 +1001,9 @@ export interface FileSizes { } export namespace FileSizes { + /** + * @internal + */ export const filterSensitiveLog = (obj: FileSizes): any => ({ ...obj, }); @@ -916,6 +1030,9 @@ export interface IsBinaryFile { } export namespace IsBinaryFile { + /** + * @internal + */ export const filterSensitiveLog = (obj: IsBinaryFile): any => ({ ...obj, }); @@ -944,6 +1061,9 @@ export interface MergeOperations { } export namespace MergeOperations { + /** + * @internal + */ export const filterSensitiveLog = (obj: MergeOperations): any => ({ ...obj, }); @@ -977,6 +1097,9 @@ export interface ObjectTypes { } export namespace ObjectTypes { + /** + * @internal + */ export const filterSensitiveLog = (obj: ObjectTypes): any => ({ ...obj, }); @@ -1038,6 +1161,9 @@ export interface ConflictMetadata { } export namespace ConflictMetadata { + /** + * @internal + */ export const filterSensitiveLog = (obj: ConflictMetadata): any => ({ ...obj, }); @@ -1065,6 +1191,9 @@ export interface MergeHunkDetail { } export namespace MergeHunkDetail { + /** + * @internal + */ export const filterSensitiveLog = (obj: MergeHunkDetail): any => ({ ...obj, }); @@ -1100,6 +1229,9 @@ export interface MergeHunk { } export namespace MergeHunk { + /** + * @internal + */ export const filterSensitiveLog = (obj: MergeHunk): any => ({ ...obj, }); @@ -1121,6 +1253,9 @@ export interface Conflict { } export namespace Conflict { + /** + * @internal + */ export const filterSensitiveLog = (obj: Conflict): any => ({ ...obj, }); @@ -1147,6 +1282,9 @@ export interface BatchDescribeMergeConflictsError { } export namespace BatchDescribeMergeConflictsError { + /** + * @internal + */ export const filterSensitiveLog = (obj: BatchDescribeMergeConflictsError): any => ({ ...obj, }); @@ -1185,6 +1323,9 @@ export interface BatchDescribeMergeConflictsOutput { } export namespace BatchDescribeMergeConflictsOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: BatchDescribeMergeConflictsOutput): any => ({ ...obj, }); @@ -1203,6 +1344,9 @@ export interface CommitDoesNotExistException extends __SmithyException, $Metadat } export namespace CommitDoesNotExistException { + /** + * @internal + */ export const filterSensitiveLog = (obj: CommitDoesNotExistException): any => ({ ...obj, }); @@ -1221,6 +1365,9 @@ export interface CommitRequiredException extends __SmithyException, $MetadataBea } export namespace CommitRequiredException { + /** + * @internal + */ export const filterSensitiveLog = (obj: CommitRequiredException): any => ({ ...obj, }); @@ -1239,6 +1386,9 @@ export interface InvalidCommitException extends __SmithyException, $MetadataBear } export namespace InvalidCommitException { + /** + * @internal + */ export const filterSensitiveLog = (obj: InvalidCommitException): any => ({ ...obj, }); @@ -1257,6 +1407,9 @@ export interface InvalidConflictDetailLevelException extends __SmithyException, } export namespace InvalidConflictDetailLevelException { + /** + * @internal + */ export const filterSensitiveLog = (obj: InvalidConflictDetailLevelException): any => ({ ...obj, }); @@ -1275,6 +1428,9 @@ export interface InvalidConflictResolutionStrategyException extends __SmithyExce } export namespace InvalidConflictResolutionStrategyException { + /** + * @internal + */ export const filterSensitiveLog = (obj: InvalidConflictResolutionStrategyException): any => ({ ...obj, }); @@ -1293,6 +1449,9 @@ export interface InvalidContinuationTokenException extends __SmithyException, $M } export namespace InvalidContinuationTokenException { + /** + * @internal + */ export const filterSensitiveLog = (obj: InvalidContinuationTokenException): any => ({ ...obj, }); @@ -1311,6 +1470,9 @@ export interface InvalidMaxConflictFilesException extends __SmithyException, $Me } export namespace InvalidMaxConflictFilesException { + /** + * @internal + */ export const filterSensitiveLog = (obj: InvalidMaxConflictFilesException): any => ({ ...obj, }); @@ -1329,6 +1491,9 @@ export interface InvalidMaxMergeHunksException extends __SmithyException, $Metad } export namespace InvalidMaxMergeHunksException { + /** + * @internal + */ export const filterSensitiveLog = (obj: InvalidMaxMergeHunksException): any => ({ ...obj, }); @@ -1347,6 +1512,9 @@ export interface InvalidMergeOptionException extends __SmithyException, $Metadat } export namespace InvalidMergeOptionException { + /** + * @internal + */ export const filterSensitiveLog = (obj: InvalidMergeOptionException): any => ({ ...obj, }); @@ -1365,6 +1533,9 @@ export interface MaximumFileContentToLoadExceededException extends __SmithyExcep } export namespace MaximumFileContentToLoadExceededException { + /** + * @internal + */ export const filterSensitiveLog = (obj: MaximumFileContentToLoadExceededException): any => ({ ...obj, }); @@ -1383,6 +1554,9 @@ export interface MaximumItemsToCompareExceededException extends __SmithyExceptio } export namespace MaximumItemsToCompareExceededException { + /** + * @internal + */ export const filterSensitiveLog = (obj: MaximumItemsToCompareExceededException): any => ({ ...obj, }); @@ -1401,6 +1575,9 @@ export interface MergeOptionRequiredException extends __SmithyException, $Metada } export namespace MergeOptionRequiredException { + /** + * @internal + */ export const filterSensitiveLog = (obj: MergeOptionRequiredException): any => ({ ...obj, }); @@ -1420,6 +1597,9 @@ export interface TipsDivergenceExceededException extends __SmithyException, $Met } export namespace TipsDivergenceExceededException { + /** + * @internal + */ export const filterSensitiveLog = (obj: TipsDivergenceExceededException): any => ({ ...obj, }); @@ -1442,6 +1622,9 @@ export interface BatchDisassociateApprovalRuleTemplateFromRepositoriesInput { } export namespace BatchDisassociateApprovalRuleTemplateFromRepositoriesInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: BatchDisassociateApprovalRuleTemplateFromRepositoriesInput): any => ({ ...obj, }); @@ -1469,6 +1652,9 @@ export interface BatchDisassociateApprovalRuleTemplateFromRepositoriesError { } export namespace BatchDisassociateApprovalRuleTemplateFromRepositoriesError { + /** + * @internal + */ export const filterSensitiveLog = (obj: BatchDisassociateApprovalRuleTemplateFromRepositoriesError): any => ({ ...obj, }); @@ -1488,6 +1674,9 @@ export interface BatchDisassociateApprovalRuleTemplateFromRepositoriesOutput { } export namespace BatchDisassociateApprovalRuleTemplateFromRepositoriesOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: BatchDisassociateApprovalRuleTemplateFromRepositoriesOutput): any => ({ ...obj, }); @@ -1510,6 +1699,9 @@ export interface BatchGetCommitsInput { } export namespace BatchGetCommitsInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: BatchGetCommitsInput): any => ({ ...obj, }); @@ -1536,6 +1728,9 @@ export interface UserInfo { } export namespace UserInfo { + /** + * @internal + */ export const filterSensitiveLog = (obj: UserInfo): any => ({ ...obj, }); @@ -1589,6 +1784,9 @@ export interface Commit { } export namespace Commit { + /** + * @internal + */ export const filterSensitiveLog = (obj: Commit): any => ({ ...obj, }); @@ -1615,6 +1813,9 @@ export interface BatchGetCommitsError { } export namespace BatchGetCommitsError { + /** + * @internal + */ export const filterSensitiveLog = (obj: BatchGetCommitsError): any => ({ ...obj, }); @@ -1635,6 +1836,9 @@ export interface BatchGetCommitsOutput { } export namespace BatchGetCommitsOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: BatchGetCommitsOutput): any => ({ ...obj, }); @@ -1653,6 +1857,9 @@ export interface CommitIdsLimitExceededException extends __SmithyException, $Met } export namespace CommitIdsLimitExceededException { + /** + * @internal + */ export const filterSensitiveLog = (obj: CommitIdsLimitExceededException): any => ({ ...obj, }); @@ -1671,6 +1878,9 @@ export interface CommitIdsListRequiredException extends __SmithyException, $Meta } export namespace CommitIdsListRequiredException { + /** + * @internal + */ export const filterSensitiveLog = (obj: CommitIdsListRequiredException): any => ({ ...obj, }); @@ -1690,6 +1900,9 @@ export interface BatchGetRepositoriesInput { } export namespace BatchGetRepositoriesInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: BatchGetRepositoriesInput): any => ({ ...obj, }); @@ -1751,6 +1964,9 @@ export interface RepositoryMetadata { } export namespace RepositoryMetadata { + /** + * @internal + */ export const filterSensitiveLog = (obj: RepositoryMetadata): any => ({ ...obj, }); @@ -1772,6 +1988,9 @@ export interface BatchGetRepositoriesOutput { } export namespace BatchGetRepositoriesOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: BatchGetRepositoriesOutput): any => ({ ...obj, }); @@ -1790,6 +2009,9 @@ export interface BeforeCommitIdAndAfterCommitIdAreSameException extends __Smithy } export namespace BeforeCommitIdAndAfterCommitIdAreSameException { + /** + * @internal + */ export const filterSensitiveLog = (obj: BeforeCommitIdAndAfterCommitIdAreSameException): any => ({ ...obj, }); @@ -1808,6 +2030,9 @@ export interface BlobIdDoesNotExistException extends __SmithyException, $Metadat } export namespace BlobIdDoesNotExistException { + /** + * @internal + */ export const filterSensitiveLog = (obj: BlobIdDoesNotExistException): any => ({ ...obj, }); @@ -1826,6 +2051,9 @@ export interface BlobIdRequiredException extends __SmithyException, $MetadataBea } export namespace BlobIdRequiredException { + /** + * @internal + */ export const filterSensitiveLog = (obj: BlobIdRequiredException): any => ({ ...obj, }); @@ -1870,6 +2098,9 @@ export interface BlobMetadata { } export namespace BlobMetadata { + /** + * @internal + */ export const filterSensitiveLog = (obj: BlobMetadata): any => ({ ...obj, }); @@ -1888,6 +2119,9 @@ export interface BranchDoesNotExistException extends __SmithyException, $Metadat } export namespace BranchDoesNotExistException { + /** + * @internal + */ export const filterSensitiveLog = (obj: BranchDoesNotExistException): any => ({ ...obj, }); @@ -1909,6 +2143,9 @@ export interface BranchInfo { } export namespace BranchInfo { + /** + * @internal + */ export const filterSensitiveLog = (obj: BranchInfo): any => ({ ...obj, }); @@ -1928,6 +2165,9 @@ export interface BranchNameExistsException extends __SmithyException, $MetadataB } export namespace BranchNameExistsException { + /** + * @internal + */ export const filterSensitiveLog = (obj: BranchNameExistsException): any => ({ ...obj, }); @@ -1947,6 +2187,9 @@ export interface BranchNameIsTagNameException extends __SmithyException, $Metada } export namespace BranchNameIsTagNameException { + /** + * @internal + */ export const filterSensitiveLog = (obj: BranchNameIsTagNameException): any => ({ ...obj, }); @@ -1965,6 +2208,9 @@ export interface BranchNameRequiredException extends __SmithyException, $Metadat } export namespace BranchNameRequiredException { + /** + * @internal + */ export const filterSensitiveLog = (obj: BranchNameRequiredException): any => ({ ...obj, }); @@ -1984,6 +2230,9 @@ export interface CannotDeleteApprovalRuleFromTemplateException extends __SmithyE } export namespace CannotDeleteApprovalRuleFromTemplateException { + /** + * @internal + */ export const filterSensitiveLog = (obj: CannotDeleteApprovalRuleFromTemplateException): any => ({ ...obj, }); @@ -2003,6 +2252,9 @@ export interface CannotModifyApprovalRuleFromTemplateException extends __SmithyE } export namespace CannotModifyApprovalRuleFromTemplateException { + /** + * @internal + */ export const filterSensitiveLog = (obj: CannotModifyApprovalRuleFromTemplateException): any => ({ ...obj, }); @@ -2025,6 +2277,9 @@ export interface ClientRequestTokenRequiredException extends __SmithyException, } export namespace ClientRequestTokenRequiredException { + /** + * @internal + */ export const filterSensitiveLog = (obj: ClientRequestTokenRequiredException): any => ({ ...obj, }); @@ -2095,6 +2350,9 @@ export interface CreateApprovalRuleTemplateInput { } export namespace CreateApprovalRuleTemplateInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateApprovalRuleTemplateInput): any => ({ ...obj, }); @@ -2108,6 +2366,9 @@ export interface CreateApprovalRuleTemplateOutput { } export namespace CreateApprovalRuleTemplateOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateApprovalRuleTemplateOutput): any => ({ ...obj, }); @@ -2126,6 +2387,9 @@ export interface InvalidApprovalRuleTemplateContentException extends __SmithyExc } export namespace InvalidApprovalRuleTemplateContentException { + /** + * @internal + */ export const filterSensitiveLog = (obj: InvalidApprovalRuleTemplateContentException): any => ({ ...obj, }); @@ -2147,6 +2411,9 @@ export interface InvalidApprovalRuleTemplateDescriptionException extends __Smith } export namespace InvalidApprovalRuleTemplateDescriptionException { + /** + * @internal + */ export const filterSensitiveLog = (obj: InvalidApprovalRuleTemplateDescriptionException): any => ({ ...obj, }); @@ -2165,6 +2432,9 @@ export interface NumberOfRuleTemplatesExceededException extends __SmithyExceptio } export namespace NumberOfRuleTemplatesExceededException { + /** + * @internal + */ export const filterSensitiveLog = (obj: NumberOfRuleTemplatesExceededException): any => ({ ...obj, }); @@ -2183,6 +2453,9 @@ export interface CommitIdRequiredException extends __SmithyException, $MetadataB } export namespace CommitIdRequiredException { + /** + * @internal + */ export const filterSensitiveLog = (obj: CommitIdRequiredException): any => ({ ...obj, }); @@ -2209,6 +2482,9 @@ export interface CreateBranchInput { } export namespace CreateBranchInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateBranchInput): any => ({ ...obj, }); @@ -2227,6 +2503,9 @@ export interface InvalidBranchNameException extends __SmithyException, $Metadata } export namespace InvalidBranchNameException { + /** + * @internal + */ export const filterSensitiveLog = (obj: InvalidBranchNameException): any => ({ ...obj, }); @@ -2245,6 +2524,9 @@ export interface InvalidCommitIdException extends __SmithyException, $MetadataBe } export namespace InvalidCommitIdException { + /** + * @internal + */ export const filterSensitiveLog = (obj: InvalidCommitIdException): any => ({ ...obj, }); @@ -2263,6 +2545,9 @@ export interface CommitMessageLengthExceededException extends __SmithyException, } export namespace CommitMessageLengthExceededException { + /** + * @internal + */ export const filterSensitiveLog = (obj: CommitMessageLengthExceededException): any => ({ ...obj, }); @@ -2279,6 +2564,9 @@ export interface DeleteFileEntry { } export namespace DeleteFileEntry { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteFileEntry): any => ({ ...obj, }); @@ -2300,6 +2588,9 @@ export interface SourceFileSpecifier { } export namespace SourceFileSpecifier { + /** + * @internal + */ export const filterSensitiveLog = (obj: SourceFileSpecifier): any => ({ ...obj, }); @@ -2332,6 +2623,9 @@ export interface PutFileEntry { } export namespace PutFileEntry { + /** + * @internal + */ export const filterSensitiveLog = (obj: PutFileEntry): any => ({ ...obj, }); @@ -2353,6 +2647,9 @@ export interface SetFileModeEntry { } export namespace SetFileModeEntry { + /** + * @internal + */ export const filterSensitiveLog = (obj: SetFileModeEntry): any => ({ ...obj, }); @@ -2416,6 +2713,9 @@ export interface CreateCommitInput { } export namespace CreateCommitInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateCommitInput): any => ({ ...obj, }); @@ -2443,6 +2743,9 @@ export interface FileMetadata { } export namespace FileMetadata { + /** + * @internal + */ export const filterSensitiveLog = (obj: FileMetadata): any => ({ ...obj, }); @@ -2476,6 +2779,9 @@ export interface CreateCommitOutput { } export namespace CreateCommitOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateCommitOutput): any => ({ ...obj, }); @@ -2495,6 +2801,9 @@ export interface DirectoryNameConflictsWithFileNameException extends __SmithyExc } export namespace DirectoryNameConflictsWithFileNameException { + /** + * @internal + */ export const filterSensitiveLog = (obj: DirectoryNameConflictsWithFileNameException): any => ({ ...obj, }); @@ -2515,6 +2824,9 @@ export interface FileContentAndSourceFileSpecifiedException extends __SmithyExce } export namespace FileContentAndSourceFileSpecifiedException { + /** + * @internal + */ export const filterSensitiveLog = (obj: FileContentAndSourceFileSpecifiedException): any => ({ ...obj, }); @@ -2535,6 +2847,9 @@ export interface FileContentSizeLimitExceededException extends __SmithyException } export namespace FileContentSizeLimitExceededException { + /** + * @internal + */ export const filterSensitiveLog = (obj: FileContentSizeLimitExceededException): any => ({ ...obj, }); @@ -2554,6 +2869,9 @@ export interface FileDoesNotExistException extends __SmithyException, $MetadataB } export namespace FileDoesNotExistException { + /** + * @internal + */ export const filterSensitiveLog = (obj: FileDoesNotExistException): any => ({ ...obj, }); @@ -2572,6 +2890,9 @@ export interface FileEntryRequiredException extends __SmithyException, $Metadata } export namespace FileEntryRequiredException { + /** + * @internal + */ export const filterSensitiveLog = (obj: FileEntryRequiredException): any => ({ ...obj, }); @@ -2591,6 +2912,9 @@ export interface FileModeRequiredException extends __SmithyException, $MetadataB } export namespace FileModeRequiredException { + /** + * @internal + */ export const filterSensitiveLog = (obj: FileModeRequiredException): any => ({ ...obj, }); @@ -2610,6 +2934,9 @@ export interface FileNameConflictsWithDirectoryNameException extends __SmithyExc } export namespace FileNameConflictsWithDirectoryNameException { + /** + * @internal + */ export const filterSensitiveLog = (obj: FileNameConflictsWithDirectoryNameException): any => ({ ...obj, }); @@ -2629,6 +2956,9 @@ export interface FilePathConflictsWithSubmodulePathException extends __SmithyExc } export namespace FilePathConflictsWithSubmodulePathException { + /** + * @internal + */ export const filterSensitiveLog = (obj: FilePathConflictsWithSubmodulePathException): any => ({ ...obj, }); @@ -2649,6 +2979,9 @@ export interface FolderContentSizeLimitExceededException extends __SmithyExcepti } export namespace FolderContentSizeLimitExceededException { + /** + * @internal + */ export const filterSensitiveLog = (obj: FolderContentSizeLimitExceededException): any => ({ ...obj, }); @@ -2667,6 +3000,9 @@ export interface InvalidDeletionParameterException extends __SmithyException, $M } export namespace InvalidDeletionParameterException { + /** + * @internal + */ export const filterSensitiveLog = (obj: InvalidDeletionParameterException): any => ({ ...obj, }); @@ -2686,6 +3022,9 @@ export interface InvalidEmailException extends __SmithyException, $MetadataBeare } export namespace InvalidEmailException { + /** + * @internal + */ export const filterSensitiveLog = (obj: InvalidEmailException): any => ({ ...obj, }); @@ -2704,6 +3043,9 @@ export interface InvalidFileModeException extends __SmithyException, $MetadataBe } export namespace InvalidFileModeException { + /** + * @internal + */ export const filterSensitiveLog = (obj: InvalidFileModeException): any => ({ ...obj, }); @@ -2723,6 +3065,9 @@ export interface InvalidParentCommitIdException extends __SmithyException, $Meta } export namespace InvalidParentCommitIdException { + /** + * @internal + */ export const filterSensitiveLog = (obj: InvalidParentCommitIdException): any => ({ ...obj, }); @@ -2741,6 +3086,9 @@ export interface InvalidPathException extends __SmithyException, $MetadataBearer } export namespace InvalidPathException { + /** + * @internal + */ export const filterSensitiveLog = (obj: InvalidPathException): any => ({ ...obj, }); @@ -2760,6 +3108,9 @@ export interface MaximumFileEntriesExceededException extends __SmithyException, } export namespace MaximumFileEntriesExceededException { + /** + * @internal + */ export const filterSensitiveLog = (obj: MaximumFileEntriesExceededException): any => ({ ...obj, }); @@ -2778,6 +3129,9 @@ export interface NameLengthExceededException extends __SmithyException, $Metadat } export namespace NameLengthExceededException { + /** + * @internal + */ export const filterSensitiveLog = (obj: NameLengthExceededException): any => ({ ...obj, }); @@ -2796,6 +3150,9 @@ export interface NoChangeException extends __SmithyException, $MetadataBearer { } export namespace NoChangeException { + /** + * @internal + */ export const filterSensitiveLog = (obj: NoChangeException): any => ({ ...obj, }); @@ -2814,6 +3171,9 @@ export interface ParentCommitDoesNotExistException extends __SmithyException, $M } export namespace ParentCommitDoesNotExistException { + /** + * @internal + */ export const filterSensitiveLog = (obj: ParentCommitDoesNotExistException): any => ({ ...obj, }); @@ -2833,6 +3193,9 @@ export interface ParentCommitIdOutdatedException extends __SmithyException, $Met } export namespace ParentCommitIdOutdatedException { + /** + * @internal + */ export const filterSensitiveLog = (obj: ParentCommitIdOutdatedException): any => ({ ...obj, }); @@ -2852,6 +3215,9 @@ export interface ParentCommitIdRequiredException extends __SmithyException, $Met } export namespace ParentCommitIdRequiredException { + /** + * @internal + */ export const filterSensitiveLog = (obj: ParentCommitIdRequiredException): any => ({ ...obj, }); @@ -2870,6 +3236,9 @@ export interface PathRequiredException extends __SmithyException, $MetadataBeare } export namespace PathRequiredException { + /** + * @internal + */ export const filterSensitiveLog = (obj: PathRequiredException): any => ({ ...obj, }); @@ -2888,6 +3257,9 @@ export interface PutFileEntryConflictException extends __SmithyException, $Metad } export namespace PutFileEntryConflictException { + /** + * @internal + */ export const filterSensitiveLog = (obj: PutFileEntryConflictException): any => ({ ...obj, }); @@ -2906,6 +3278,9 @@ export interface RestrictedSourceFileException extends __SmithyException, $Metad } export namespace RestrictedSourceFileException { + /** + * @internal + */ export const filterSensitiveLog = (obj: RestrictedSourceFileException): any => ({ ...obj, }); @@ -2926,6 +3301,9 @@ export interface SamePathRequestException extends __SmithyException, $MetadataBe } export namespace SamePathRequestException { + /** + * @internal + */ export const filterSensitiveLog = (obj: SamePathRequestException): any => ({ ...obj, }); @@ -2944,6 +3322,9 @@ export interface SourceFileOrContentRequiredException extends __SmithyException, } export namespace SourceFileOrContentRequiredException { + /** + * @internal + */ export const filterSensitiveLog = (obj: SourceFileOrContentRequiredException): any => ({ ...obj, }); @@ -2971,6 +3352,9 @@ export interface Target { } export namespace Target { + /** + * @internal + */ export const filterSensitiveLog = (obj: Target): any => ({ ...obj, }); @@ -3009,6 +3393,9 @@ export interface CreatePullRequestInput { } export namespace CreatePullRequestInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreatePullRequestInput): any => ({ ...obj, }); @@ -3045,6 +3432,9 @@ export interface MergeMetadata { } export namespace MergeMetadata { + /** + * @internal + */ export const filterSensitiveLog = (obj: MergeMetadata): any => ({ ...obj, }); @@ -3094,6 +3484,9 @@ export interface PullRequestTarget { } export namespace PullRequestTarget { + /** + * @internal + */ export const filterSensitiveLog = (obj: PullRequestTarget): any => ({ ...obj, }); @@ -3164,6 +3557,9 @@ export interface PullRequest { } export namespace PullRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: PullRequest): any => ({ ...obj, }); @@ -3177,6 +3573,9 @@ export interface CreatePullRequestOutput { } export namespace CreatePullRequestOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreatePullRequestOutput): any => ({ ...obj, }); @@ -3196,6 +3595,9 @@ export interface IdempotencyParameterMismatchException extends __SmithyException } export namespace IdempotencyParameterMismatchException { + /** + * @internal + */ export const filterSensitiveLog = (obj: IdempotencyParameterMismatchException): any => ({ ...obj, }); @@ -3214,6 +3616,9 @@ export interface InvalidClientRequestTokenException extends __SmithyException, $ } export namespace InvalidClientRequestTokenException { + /** + * @internal + */ export const filterSensitiveLog = (obj: InvalidClientRequestTokenException): any => ({ ...obj, }); @@ -3233,6 +3638,9 @@ export interface InvalidDescriptionException extends __SmithyException, $Metadat } export namespace InvalidDescriptionException { + /** + * @internal + */ export const filterSensitiveLog = (obj: InvalidDescriptionException): any => ({ ...obj, }); @@ -3253,6 +3661,9 @@ export interface InvalidReferenceNameException extends __SmithyException, $Metad } export namespace InvalidReferenceNameException { + /** + * @internal + */ export const filterSensitiveLog = (obj: InvalidReferenceNameException): any => ({ ...obj, }); @@ -3271,6 +3682,9 @@ export interface InvalidTargetException extends __SmithyException, $MetadataBear } export namespace InvalidTargetException { + /** + * @internal + */ export const filterSensitiveLog = (obj: InvalidTargetException): any => ({ ...obj, }); @@ -3290,6 +3704,9 @@ export interface InvalidTargetsException extends __SmithyException, $MetadataBea } export namespace InvalidTargetsException { + /** + * @internal + */ export const filterSensitiveLog = (obj: InvalidTargetsException): any => ({ ...obj, }); @@ -3308,6 +3725,9 @@ export interface InvalidTitleException extends __SmithyException, $MetadataBeare } export namespace InvalidTitleException { + /** + * @internal + */ export const filterSensitiveLog = (obj: InvalidTitleException): any => ({ ...obj, }); @@ -3327,6 +3747,9 @@ export interface MaximumOpenPullRequestsExceededException extends __SmithyExcept } export namespace MaximumOpenPullRequestsExceededException { + /** + * @internal + */ export const filterSensitiveLog = (obj: MaximumOpenPullRequestsExceededException): any => ({ ...obj, }); @@ -3345,6 +3768,9 @@ export interface MultipleRepositoriesInPullRequestException extends __SmithyExce } export namespace MultipleRepositoriesInPullRequestException { + /** + * @internal + */ export const filterSensitiveLog = (obj: MultipleRepositoriesInPullRequestException): any => ({ ...obj, }); @@ -3363,6 +3789,9 @@ export interface ReferenceDoesNotExistException extends __SmithyException, $Meta } export namespace ReferenceDoesNotExistException { + /** + * @internal + */ export const filterSensitiveLog = (obj: ReferenceDoesNotExistException): any => ({ ...obj, }); @@ -3381,6 +3810,9 @@ export interface ReferenceNameRequiredException extends __SmithyException, $Meta } export namespace ReferenceNameRequiredException { + /** + * @internal + */ export const filterSensitiveLog = (obj: ReferenceNameRequiredException): any => ({ ...obj, }); @@ -3399,6 +3831,9 @@ export interface ReferenceTypeNotSupportedException extends __SmithyException, $ } export namespace ReferenceTypeNotSupportedException { + /** + * @internal + */ export const filterSensitiveLog = (obj: ReferenceTypeNotSupportedException): any => ({ ...obj, }); @@ -3418,6 +3853,9 @@ export interface SourceAndDestinationAreSameException extends __SmithyException, } export namespace SourceAndDestinationAreSameException { + /** + * @internal + */ export const filterSensitiveLog = (obj: SourceAndDestinationAreSameException): any => ({ ...obj, }); @@ -3436,6 +3874,9 @@ export interface TargetRequiredException extends __SmithyException, $MetadataBea } export namespace TargetRequiredException { + /** + * @internal + */ export const filterSensitiveLog = (obj: TargetRequiredException): any => ({ ...obj, }); @@ -3454,6 +3895,9 @@ export interface TargetsRequiredException extends __SmithyException, $MetadataBe } export namespace TargetsRequiredException { + /** + * @internal + */ export const filterSensitiveLog = (obj: TargetsRequiredException): any => ({ ...obj, }); @@ -3472,6 +3916,9 @@ export interface TitleRequiredException extends __SmithyException, $MetadataBear } export namespace TitleRequiredException { + /** + * @internal + */ export const filterSensitiveLog = (obj: TitleRequiredException): any => ({ ...obj, }); @@ -3537,6 +3984,9 @@ export interface CreatePullRequestApprovalRuleInput { } export namespace CreatePullRequestApprovalRuleInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreatePullRequestApprovalRuleInput): any => ({ ...obj, }); @@ -3550,6 +4000,9 @@ export interface CreatePullRequestApprovalRuleOutput { } export namespace CreatePullRequestApprovalRuleOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreatePullRequestApprovalRuleOutput): any => ({ ...obj, }); @@ -3568,6 +4021,9 @@ export interface InvalidApprovalRuleContentException extends __SmithyException, } export namespace InvalidApprovalRuleContentException { + /** + * @internal + */ export const filterSensitiveLog = (obj: InvalidApprovalRuleContentException): any => ({ ...obj, }); @@ -3586,6 +4042,9 @@ export interface InvalidApprovalRuleNameException extends __SmithyException, $Me } export namespace InvalidApprovalRuleNameException { + /** + * @internal + */ export const filterSensitiveLog = (obj: InvalidApprovalRuleNameException): any => ({ ...obj, }); @@ -3604,6 +4063,9 @@ export interface InvalidPullRequestIdException extends __SmithyException, $Metad } export namespace InvalidPullRequestIdException { + /** + * @internal + */ export const filterSensitiveLog = (obj: InvalidPullRequestIdException): any => ({ ...obj, }); @@ -3622,6 +4084,9 @@ export interface NumberOfRulesExceededException extends __SmithyException, $Meta } export namespace NumberOfRulesExceededException { + /** + * @internal + */ export const filterSensitiveLog = (obj: NumberOfRulesExceededException): any => ({ ...obj, }); @@ -3640,6 +4105,9 @@ export interface PullRequestAlreadyClosedException extends __SmithyException, $M } export namespace PullRequestAlreadyClosedException { + /** + * @internal + */ export const filterSensitiveLog = (obj: PullRequestAlreadyClosedException): any => ({ ...obj, }); @@ -3658,6 +4126,9 @@ export interface PullRequestDoesNotExistException extends __SmithyException, $Me } export namespace PullRequestDoesNotExistException { + /** + * @internal + */ export const filterSensitiveLog = (obj: PullRequestDoesNotExistException): any => ({ ...obj, }); @@ -3676,6 +4147,9 @@ export interface PullRequestIdRequiredException extends __SmithyException, $Meta } export namespace PullRequestIdRequiredException { + /** + * @internal + */ export const filterSensitiveLog = (obj: PullRequestIdRequiredException): any => ({ ...obj, }); @@ -3716,6 +4190,9 @@ export interface CreateRepositoryInput { } export namespace CreateRepositoryInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateRepositoryInput): any => ({ ...obj, }); @@ -3732,6 +4209,9 @@ export interface CreateRepositoryOutput { } export namespace CreateRepositoryOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateRepositoryOutput): any => ({ ...obj, }); @@ -3750,6 +4230,9 @@ export interface InvalidRepositoryDescriptionException extends __SmithyException } export namespace InvalidRepositoryDescriptionException { + /** + * @internal + */ export const filterSensitiveLog = (obj: InvalidRepositoryDescriptionException): any => ({ ...obj, }); @@ -3768,6 +4251,9 @@ export interface InvalidSystemTagUsageException extends __SmithyException, $Meta } export namespace InvalidSystemTagUsageException { + /** + * @internal + */ export const filterSensitiveLog = (obj: InvalidSystemTagUsageException): any => ({ ...obj, }); @@ -3786,6 +4272,9 @@ export interface InvalidTagsMapException extends __SmithyException, $MetadataBea } export namespace InvalidTagsMapException { + /** + * @internal + */ export const filterSensitiveLog = (obj: InvalidTagsMapException): any => ({ ...obj, }); @@ -3804,6 +4293,9 @@ export interface RepositoryLimitExceededException extends __SmithyException, $Me } export namespace RepositoryLimitExceededException { + /** + * @internal + */ export const filterSensitiveLog = (obj: RepositoryLimitExceededException): any => ({ ...obj, }); @@ -3822,6 +4314,9 @@ export interface RepositoryNameExistsException extends __SmithyException, $Metad } export namespace RepositoryNameExistsException { + /** + * @internal + */ export const filterSensitiveLog = (obj: RepositoryNameExistsException): any => ({ ...obj, }); @@ -3840,6 +4335,9 @@ export interface TagPolicyException extends __SmithyException, $MetadataBearer { } export namespace TagPolicyException { + /** + * @internal + */ export const filterSensitiveLog = (obj: TagPolicyException): any => ({ ...obj, }); @@ -3858,6 +4356,9 @@ export interface TooManyTagsException extends __SmithyException, $MetadataBearer } export namespace TooManyTagsException { + /** + * @internal + */ export const filterSensitiveLog = (obj: TooManyTagsException): any => ({ ...obj, }); @@ -3876,6 +4377,9 @@ export interface ConcurrentReferenceUpdateException extends __SmithyException, $ } export namespace ConcurrentReferenceUpdateException { + /** + * @internal + */ export const filterSensitiveLog = (obj: ConcurrentReferenceUpdateException): any => ({ ...obj, }); @@ -3914,6 +4418,9 @@ export interface ReplaceContentEntry { } export namespace ReplaceContentEntry { + /** + * @internal + */ export const filterSensitiveLog = (obj: ReplaceContentEntry): any => ({ ...obj, }); @@ -3941,6 +4448,9 @@ export interface ConflictResolution { } export namespace ConflictResolution { + /** + * @internal + */ export const filterSensitiveLog = (obj: ConflictResolution): any => ({ ...obj, }); @@ -4015,6 +4525,9 @@ export interface CreateUnreferencedMergeCommitInput { } export namespace CreateUnreferencedMergeCommitInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateUnreferencedMergeCommitInput): any => ({ ...obj, }); @@ -4033,6 +4546,9 @@ export interface CreateUnreferencedMergeCommitOutput { } export namespace CreateUnreferencedMergeCommitOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateUnreferencedMergeCommitOutput): any => ({ ...obj, }); @@ -4051,6 +4567,9 @@ export interface InvalidConflictResolutionException extends __SmithyException, $ } export namespace InvalidConflictResolutionException { + /** + * @internal + */ export const filterSensitiveLog = (obj: InvalidConflictResolutionException): any => ({ ...obj, }); @@ -4069,6 +4588,9 @@ export interface InvalidReplacementContentException extends __SmithyException, $ } export namespace InvalidReplacementContentException { + /** + * @internal + */ export const filterSensitiveLog = (obj: InvalidReplacementContentException): any => ({ ...obj, }); @@ -4087,6 +4609,9 @@ export interface InvalidReplacementTypeException extends __SmithyException, $Met } export namespace InvalidReplacementTypeException { + /** + * @internal + */ export const filterSensitiveLog = (obj: InvalidReplacementTypeException): any => ({ ...obj, }); @@ -4105,6 +4630,9 @@ export interface ManualMergeRequiredException extends __SmithyException, $Metada } export namespace ManualMergeRequiredException { + /** + * @internal + */ export const filterSensitiveLog = (obj: ManualMergeRequiredException): any => ({ ...obj, }); @@ -4123,6 +4651,9 @@ export interface MaximumConflictResolutionEntriesExceededException extends __Smi } export namespace MaximumConflictResolutionEntriesExceededException { + /** + * @internal + */ export const filterSensitiveLog = (obj: MaximumConflictResolutionEntriesExceededException): any => ({ ...obj, }); @@ -4141,6 +4672,9 @@ export interface MultipleConflictResolutionEntriesException extends __SmithyExce } export namespace MultipleConflictResolutionEntriesException { + /** + * @internal + */ export const filterSensitiveLog = (obj: MultipleConflictResolutionEntriesException): any => ({ ...obj, }); @@ -4159,6 +4693,9 @@ export interface ReplacementContentRequiredException extends __SmithyException, } export namespace ReplacementContentRequiredException { + /** + * @internal + */ export const filterSensitiveLog = (obj: ReplacementContentRequiredException): any => ({ ...obj, }); @@ -4177,6 +4714,9 @@ export interface ReplacementTypeRequiredException extends __SmithyException, $Me } export namespace ReplacementTypeRequiredException { + /** + * @internal + */ export const filterSensitiveLog = (obj: ReplacementTypeRequiredException): any => ({ ...obj, }); @@ -4190,6 +4730,9 @@ export interface DeleteApprovalRuleTemplateInput { } export namespace DeleteApprovalRuleTemplateInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteApprovalRuleTemplateInput): any => ({ ...obj, }); @@ -4204,6 +4747,9 @@ export interface DeleteApprovalRuleTemplateOutput { } export namespace DeleteApprovalRuleTemplateOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteApprovalRuleTemplateOutput): any => ({ ...obj, }); @@ -4222,6 +4768,9 @@ export interface DefaultBranchCannotBeDeletedException extends __SmithyException } export namespace DefaultBranchCannotBeDeletedException { + /** + * @internal + */ export const filterSensitiveLog = (obj: DefaultBranchCannotBeDeletedException): any => ({ ...obj, }); @@ -4243,6 +4792,9 @@ export interface DeleteBranchInput { } export namespace DeleteBranchInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteBranchInput): any => ({ ...obj, }); @@ -4259,6 +4811,9 @@ export interface DeleteBranchOutput { } export namespace DeleteBranchOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteBranchOutput): any => ({ ...obj, }); @@ -4277,6 +4832,9 @@ export interface CommentDeletedException extends __SmithyException, $MetadataBea } export namespace CommentDeletedException { + /** + * @internal + */ export const filterSensitiveLog = (obj: CommentDeletedException): any => ({ ...obj, }); @@ -4296,6 +4854,9 @@ export interface CommentDoesNotExistException extends __SmithyException, $Metada } export namespace CommentDoesNotExistException { + /** + * @internal + */ export const filterSensitiveLog = (obj: CommentDoesNotExistException): any => ({ ...obj, }); @@ -4314,6 +4875,9 @@ export interface CommentIdRequiredException extends __SmithyException, $Metadata } export namespace CommentIdRequiredException { + /** + * @internal + */ export const filterSensitiveLog = (obj: CommentIdRequiredException): any => ({ ...obj, }); @@ -4328,6 +4892,9 @@ export interface DeleteCommentContentInput { } export namespace DeleteCommentContentInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteCommentContentInput): any => ({ ...obj, }); @@ -4392,6 +4959,9 @@ export interface Comment { } export namespace Comment { + /** + * @internal + */ export const filterSensitiveLog = (obj: Comment): any => ({ ...obj, }); @@ -4405,6 +4975,9 @@ export interface DeleteCommentContentOutput { } export namespace DeleteCommentContentOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteCommentContentOutput): any => ({ ...obj, }); @@ -4423,6 +4996,9 @@ export interface InvalidCommentIdException extends __SmithyException, $MetadataB } export namespace InvalidCommentIdException { + /** + * @internal + */ export const filterSensitiveLog = (obj: InvalidCommentIdException): any => ({ ...obj, }); @@ -4482,6 +5058,9 @@ export interface DeleteFileInput { } export namespace DeleteFileInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteFileInput): any => ({ ...obj, }); @@ -4511,6 +5090,9 @@ export interface DeleteFileOutput { } export namespace DeleteFileOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteFileOutput): any => ({ ...obj, }); @@ -4529,6 +5111,9 @@ export interface DeletePullRequestApprovalRuleInput { } export namespace DeletePullRequestApprovalRuleInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeletePullRequestApprovalRuleInput): any => ({ ...obj, }); @@ -4546,6 +5131,9 @@ export interface DeletePullRequestApprovalRuleOutput { } export namespace DeletePullRequestApprovalRuleOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeletePullRequestApprovalRuleOutput): any => ({ ...obj, }); @@ -4562,6 +5150,9 @@ export interface DeleteRepositoryInput { } export namespace DeleteRepositoryInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteRepositoryInput): any => ({ ...obj, }); @@ -4578,6 +5169,9 @@ export interface DeleteRepositoryOutput { } export namespace DeleteRepositoryOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteRepositoryOutput): any => ({ ...obj, }); @@ -4639,6 +5233,9 @@ export interface DescribeMergeConflictsInput { } export namespace DescribeMergeConflictsInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeMergeConflictsInput): any => ({ ...obj, }); @@ -4677,6 +5274,9 @@ export interface DescribeMergeConflictsOutput { } export namespace DescribeMergeConflictsOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeMergeConflictsOutput): any => ({ ...obj, }); @@ -4726,6 +5326,9 @@ export interface DescribePullRequestEventsInput { } export namespace DescribePullRequestEventsInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribePullRequestEventsInput): any => ({ ...obj, }); @@ -4757,6 +5360,9 @@ export interface PullRequestCreatedEventMetadata { } export namespace PullRequestCreatedEventMetadata { + /** + * @internal + */ export const filterSensitiveLog = (obj: PullRequestCreatedEventMetadata): any => ({ ...obj, }); @@ -4783,6 +5389,9 @@ export interface PullRequestMergedStateChangedEventMetadata { } export namespace PullRequestMergedStateChangedEventMetadata { + /** + * @internal + */ export const filterSensitiveLog = (obj: PullRequestMergedStateChangedEventMetadata): any => ({ ...obj, }); @@ -4814,6 +5423,9 @@ export interface PullRequestSourceReferenceUpdatedEventMetadata { } export namespace PullRequestSourceReferenceUpdatedEventMetadata { + /** + * @internal + */ export const filterSensitiveLog = (obj: PullRequestSourceReferenceUpdatedEventMetadata): any => ({ ...obj, }); @@ -4830,6 +5442,9 @@ export interface PullRequestStatusChangedEventMetadata { } export namespace PullRequestStatusChangedEventMetadata { + /** + * @internal + */ export const filterSensitiveLog = (obj: PullRequestStatusChangedEventMetadata): any => ({ ...obj, }); @@ -4900,6 +5515,9 @@ export interface PullRequestEvent { } export namespace PullRequestEvent { + /** + * @internal + */ export const filterSensitiveLog = (obj: PullRequestEvent): any => ({ ...obj, }); @@ -4918,6 +5536,9 @@ export interface DescribePullRequestEventsOutput { } export namespace DescribePullRequestEventsOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribePullRequestEventsOutput): any => ({ ...obj, }); @@ -4937,6 +5558,9 @@ export interface InvalidActorArnException extends __SmithyException, $MetadataBe } export namespace InvalidActorArnException { + /** + * @internal + */ export const filterSensitiveLog = (obj: InvalidActorArnException): any => ({ ...obj, }); @@ -4955,6 +5579,9 @@ export interface InvalidMaxResultsException extends __SmithyException, $Metadata } export namespace InvalidMaxResultsException { + /** + * @internal + */ export const filterSensitiveLog = (obj: InvalidMaxResultsException): any => ({ ...obj, }); @@ -4973,6 +5600,9 @@ export interface InvalidPullRequestEventTypeException extends __SmithyException, } export namespace InvalidPullRequestEventTypeException { + /** + * @internal + */ export const filterSensitiveLog = (obj: InvalidPullRequestEventTypeException): any => ({ ...obj, }); @@ -4991,6 +5621,9 @@ export interface DisassociateApprovalRuleTemplateFromRepositoryInput { } export namespace DisassociateApprovalRuleTemplateFromRepositoryInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: DisassociateApprovalRuleTemplateFromRepositoryInput): any => ({ ...obj, }); @@ -5011,6 +5644,9 @@ export interface EvaluatePullRequestApprovalRulesInput { } export namespace EvaluatePullRequestApprovalRulesInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: EvaluatePullRequestApprovalRulesInput): any => ({ ...obj, }); @@ -5042,6 +5678,9 @@ export interface Evaluation { } export namespace Evaluation { + /** + * @internal + */ export const filterSensitiveLog = (obj: Evaluation): any => ({ ...obj, }); @@ -5056,6 +5695,9 @@ export interface EvaluatePullRequestApprovalRulesOutput { } export namespace EvaluatePullRequestApprovalRulesOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: EvaluatePullRequestApprovalRulesOutput): any => ({ ...obj, }); @@ -5074,6 +5716,9 @@ export interface InvalidRevisionIdException extends __SmithyException, $Metadata } export namespace InvalidRevisionIdException { + /** + * @internal + */ export const filterSensitiveLog = (obj: InvalidRevisionIdException): any => ({ ...obj, }); @@ -5092,6 +5737,9 @@ export interface RevisionIdRequiredException extends __SmithyException, $Metadat } export namespace RevisionIdRequiredException { + /** + * @internal + */ export const filterSensitiveLog = (obj: RevisionIdRequiredException): any => ({ ...obj, }); @@ -5110,6 +5758,9 @@ export interface RevisionNotCurrentException extends __SmithyException, $Metadat } export namespace RevisionNotCurrentException { + /** + * @internal + */ export const filterSensitiveLog = (obj: RevisionNotCurrentException): any => ({ ...obj, }); @@ -5123,6 +5774,9 @@ export interface GetApprovalRuleTemplateInput { } export namespace GetApprovalRuleTemplateInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetApprovalRuleTemplateInput): any => ({ ...obj, }); @@ -5136,6 +5790,9 @@ export interface GetApprovalRuleTemplateOutput { } export namespace GetApprovalRuleTemplateOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetApprovalRuleTemplateOutput): any => ({ ...obj, }); @@ -5155,6 +5812,9 @@ export interface FileTooLargeException extends __SmithyException, $MetadataBeare } export namespace FileTooLargeException { + /** + * @internal + */ export const filterSensitiveLog = (obj: FileTooLargeException): any => ({ ...obj, }); @@ -5176,6 +5836,9 @@ export interface GetBlobInput { } export namespace GetBlobInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetBlobInput): any => ({ ...obj, }); @@ -5192,6 +5855,9 @@ export interface GetBlobOutput { } export namespace GetBlobOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetBlobOutput): any => ({ ...obj, }); @@ -5210,6 +5876,9 @@ export interface InvalidBlobIdException extends __SmithyException, $MetadataBear } export namespace InvalidBlobIdException { + /** + * @internal + */ export const filterSensitiveLog = (obj: InvalidBlobIdException): any => ({ ...obj, }); @@ -5231,6 +5900,9 @@ export interface GetBranchInput { } export namespace GetBranchInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetBranchInput): any => ({ ...obj, }); @@ -5247,6 +5919,9 @@ export interface GetBranchOutput { } export namespace GetBranchOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetBranchOutput): any => ({ ...obj, }); @@ -5261,6 +5936,9 @@ export interface GetCommentInput { } export namespace GetCommentInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetCommentInput): any => ({ ...obj, }); @@ -5274,6 +5952,9 @@ export interface GetCommentOutput { } export namespace GetCommentOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetCommentOutput): any => ({ ...obj, }); @@ -5302,6 +5983,9 @@ export interface GetCommentReactionsInput { } export namespace GetCommentReactionsInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetCommentReactionsInput): any => ({ ...obj, }); @@ -5328,6 +6012,9 @@ export interface ReactionValueFormats { } export namespace ReactionValueFormats { + /** + * @internal + */ export const filterSensitiveLog = (obj: ReactionValueFormats): any => ({ ...obj, }); @@ -5355,6 +6042,9 @@ export interface ReactionForComment { } export namespace ReactionForComment { + /** + * @internal + */ export const filterSensitiveLog = (obj: ReactionForComment): any => ({ ...obj, }); @@ -5373,6 +6063,9 @@ export interface GetCommentReactionsOutput { } export namespace GetCommentReactionsOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetCommentReactionsOutput): any => ({ ...obj, }); @@ -5391,6 +6084,9 @@ export interface InvalidReactionUserArnException extends __SmithyException, $Met } export namespace InvalidReactionUserArnException { + /** + * @internal + */ export const filterSensitiveLog = (obj: InvalidReactionUserArnException): any => ({ ...obj, }); @@ -5427,6 +6123,9 @@ export interface GetCommentsForComparedCommitInput { } export namespace GetCommentsForComparedCommitInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetCommentsForComparedCommitInput): any => ({ ...obj, }); @@ -5459,6 +6158,9 @@ export interface Location { } export namespace Location { + /** + * @internal + */ export const filterSensitiveLog = (obj: Location): any => ({ ...obj, }); @@ -5509,6 +6211,9 @@ export interface CommentsForComparedCommit { } export namespace CommentsForComparedCommit { + /** + * @internal + */ export const filterSensitiveLog = (obj: CommentsForComparedCommit): any => ({ ...obj, }); @@ -5527,6 +6232,9 @@ export interface GetCommentsForComparedCommitOutput { } export namespace GetCommentsForComparedCommitOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetCommentsForComparedCommitOutput): any => ({ ...obj, }); @@ -5567,6 +6275,9 @@ export interface GetCommentsForPullRequestInput { } export namespace GetCommentsForPullRequestInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetCommentsForPullRequestInput): any => ({ ...obj, }); @@ -5623,6 +6334,9 @@ export interface CommentsForPullRequest { } export namespace CommentsForPullRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: CommentsForPullRequest): any => ({ ...obj, }); @@ -5641,6 +6355,9 @@ export interface GetCommentsForPullRequestOutput { } export namespace GetCommentsForPullRequestOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetCommentsForPullRequestOutput): any => ({ ...obj, }); @@ -5659,6 +6376,9 @@ export interface RepositoryNotAssociatedWithPullRequestException extends __Smith } export namespace RepositoryNotAssociatedWithPullRequestException { + /** + * @internal + */ export const filterSensitiveLog = (obj: RepositoryNotAssociatedWithPullRequestException): any => ({ ...obj, }); @@ -5677,6 +6397,9 @@ export interface CommitIdDoesNotExistException extends __SmithyException, $Metad } export namespace CommitIdDoesNotExistException { + /** + * @internal + */ export const filterSensitiveLog = (obj: CommitIdDoesNotExistException): any => ({ ...obj, }); @@ -5698,6 +6421,9 @@ export interface GetCommitInput { } export namespace GetCommitInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetCommitInput): any => ({ ...obj, }); @@ -5714,6 +6440,9 @@ export interface GetCommitOutput { } export namespace GetCommitOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetCommitOutput): any => ({ ...obj, }); @@ -5767,6 +6496,9 @@ export interface GetDifferencesInput { } export namespace GetDifferencesInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetDifferencesInput): any => ({ ...obj, }); @@ -5795,6 +6527,9 @@ export interface Difference { } export namespace Difference { + /** + * @internal + */ export const filterSensitiveLog = (obj: Difference): any => ({ ...obj, }); @@ -5814,6 +6549,9 @@ export interface GetDifferencesOutput { } export namespace GetDifferencesOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetDifferencesOutput): any => ({ ...obj, }); @@ -5832,6 +6570,9 @@ export interface PathDoesNotExistException extends __SmithyException, $MetadataB } export namespace PathDoesNotExistException { + /** + * @internal + */ export const filterSensitiveLog = (obj: PathDoesNotExistException): any => ({ ...obj, }); @@ -5859,6 +6600,9 @@ export interface GetFileInput { } export namespace GetFileInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetFileInput): any => ({ ...obj, }); @@ -5903,6 +6647,9 @@ export interface GetFileOutput { } export namespace GetFileOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetFileOutput): any => ({ ...obj, }); @@ -5922,6 +6669,9 @@ export interface FolderDoesNotExistException extends __SmithyException, $Metadat } export namespace FolderDoesNotExistException { + /** + * @internal + */ export const filterSensitiveLog = (obj: FolderDoesNotExistException): any => ({ ...obj, }); @@ -5950,6 +6700,9 @@ export interface GetFolderInput { } export namespace GetFolderInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetFolderInput): any => ({ ...obj, }); @@ -5981,6 +6734,9 @@ export interface File { } export namespace File { + /** + * @internal + */ export const filterSensitiveLog = (obj: File): any => ({ ...obj, }); @@ -6007,6 +6763,9 @@ export interface Folder { } export namespace Folder { + /** + * @internal + */ export const filterSensitiveLog = (obj: Folder): any => ({ ...obj, }); @@ -6033,6 +6792,9 @@ export interface SubModule { } export namespace SubModule { + /** + * @internal + */ export const filterSensitiveLog = (obj: SubModule): any => ({ ...obj, }); @@ -6064,6 +6826,9 @@ export interface SymbolicLink { } export namespace SymbolicLink { + /** + * @internal + */ export const filterSensitiveLog = (obj: SymbolicLink): any => ({ ...obj, }); @@ -6109,6 +6874,9 @@ export interface GetFolderOutput { } export namespace GetFolderOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetFolderOutput): any => ({ ...obj, }); @@ -6149,6 +6917,9 @@ export interface GetMergeCommitInput { } export namespace GetMergeCommitInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetMergeCommitInput): any => ({ ...obj, }); @@ -6179,6 +6950,9 @@ export interface GetMergeCommitOutput { } export namespace GetMergeCommitOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetMergeCommitOutput): any => ({ ...obj, }); @@ -6235,6 +7009,9 @@ export interface GetMergeConflictsInput { } export namespace GetMergeConflictsInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetMergeConflictsInput): any => ({ ...obj, }); @@ -6274,6 +7051,9 @@ export interface GetMergeConflictsOutput { } export namespace GetMergeConflictsOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetMergeConflictsOutput): any => ({ ...obj, }); @@ -6292,6 +7072,9 @@ export interface InvalidDestinationCommitSpecifierException extends __SmithyExce } export namespace InvalidDestinationCommitSpecifierException { + /** + * @internal + */ export const filterSensitiveLog = (obj: InvalidDestinationCommitSpecifierException): any => ({ ...obj, }); @@ -6310,6 +7093,9 @@ export interface InvalidSourceCommitSpecifierException extends __SmithyException } export namespace InvalidSourceCommitSpecifierException { + /** + * @internal + */ export const filterSensitiveLog = (obj: InvalidSourceCommitSpecifierException): any => ({ ...obj, }); @@ -6350,6 +7136,9 @@ export interface GetMergeOptionsInput { } export namespace GetMergeOptionsInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetMergeOptionsInput): any => ({ ...obj, }); @@ -6378,6 +7167,9 @@ export interface GetMergeOptionsOutput { } export namespace GetMergeOptionsOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetMergeOptionsOutput): any => ({ ...obj, }); @@ -6391,6 +7183,9 @@ export interface GetPullRequestInput { } export namespace GetPullRequestInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetPullRequestInput): any => ({ ...obj, }); @@ -6404,6 +7199,9 @@ export interface GetPullRequestOutput { } export namespace GetPullRequestOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetPullRequestOutput): any => ({ ...obj, }); @@ -6422,6 +7220,9 @@ export interface GetPullRequestApprovalStatesInput { } export namespace GetPullRequestApprovalStatesInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetPullRequestApprovalStatesInput): any => ({ ...obj, }); @@ -6435,6 +7236,9 @@ export interface GetPullRequestApprovalStatesOutput { } export namespace GetPullRequestApprovalStatesOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetPullRequestApprovalStatesOutput): any => ({ ...obj, }); @@ -6455,6 +7259,9 @@ export interface GetPullRequestOverrideStateInput { } export namespace GetPullRequestOverrideStateInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetPullRequestOverrideStateInput): any => ({ ...obj, }); @@ -6473,6 +7280,9 @@ export interface GetPullRequestOverrideStateOutput { } export namespace GetPullRequestOverrideStateOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetPullRequestOverrideStateOutput): any => ({ ...obj, }); @@ -6489,6 +7299,9 @@ export interface GetRepositoryInput { } export namespace GetRepositoryInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetRepositoryInput): any => ({ ...obj, }); @@ -6505,6 +7318,9 @@ export interface GetRepositoryOutput { } export namespace GetRepositoryOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetRepositoryOutput): any => ({ ...obj, }); @@ -6521,6 +7337,9 @@ export interface GetRepositoryTriggersInput { } export namespace GetRepositoryTriggersInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetRepositoryTriggersInput): any => ({ ...obj, }); @@ -6576,6 +7395,9 @@ export interface RepositoryTrigger { } export namespace RepositoryTrigger { + /** + * @internal + */ export const filterSensitiveLog = (obj: RepositoryTrigger): any => ({ ...obj, }); @@ -6597,6 +7419,9 @@ export interface GetRepositoryTriggersOutput { } export namespace GetRepositoryTriggersOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetRepositoryTriggersOutput): any => ({ ...obj, }); @@ -6616,6 +7441,9 @@ export interface ListApprovalRuleTemplatesInput { } export namespace ListApprovalRuleTemplatesInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListApprovalRuleTemplatesInput): any => ({ ...obj, }); @@ -6634,6 +7462,9 @@ export interface ListApprovalRuleTemplatesOutput { } export namespace ListApprovalRuleTemplatesOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListApprovalRuleTemplatesOutput): any => ({ ...obj, }); @@ -6658,6 +7489,9 @@ export interface ListAssociatedApprovalRuleTemplatesForRepositoryInput { } export namespace ListAssociatedApprovalRuleTemplatesForRepositoryInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListAssociatedApprovalRuleTemplatesForRepositoryInput): any => ({ ...obj, }); @@ -6676,6 +7510,9 @@ export interface ListAssociatedApprovalRuleTemplatesForRepositoryOutput { } export namespace ListAssociatedApprovalRuleTemplatesForRepositoryOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListAssociatedApprovalRuleTemplatesForRepositoryOutput): any => ({ ...obj, }); @@ -6697,6 +7534,9 @@ export interface ListBranchesInput { } export namespace ListBranchesInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListBranchesInput): any => ({ ...obj, }); @@ -6718,6 +7558,9 @@ export interface ListBranchesOutput { } export namespace ListBranchesOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListBranchesOutput): any => ({ ...obj, }); @@ -6736,6 +7579,9 @@ export interface InvalidAuthorArnException extends __SmithyException, $MetadataB } export namespace InvalidAuthorArnException { + /** + * @internal + */ export const filterSensitiveLog = (obj: InvalidAuthorArnException): any => ({ ...obj, }); @@ -6754,6 +7600,9 @@ export interface InvalidPullRequestStatusException extends __SmithyException, $M } export namespace InvalidPullRequestStatusException { + /** + * @internal + */ export const filterSensitiveLog = (obj: InvalidPullRequestStatusException): any => ({ ...obj, }); @@ -6789,6 +7638,9 @@ export interface ListPullRequestsInput { } export namespace ListPullRequestsInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListPullRequestsInput): any => ({ ...obj, }); @@ -6807,6 +7659,9 @@ export interface ListPullRequestsOutput { } export namespace ListPullRequestsOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListPullRequestsOutput): any => ({ ...obj, }); @@ -6825,6 +7680,9 @@ export interface InvalidOrderException extends __SmithyException, $MetadataBeare } export namespace InvalidOrderException { + /** + * @internal + */ export const filterSensitiveLog = (obj: InvalidOrderException): any => ({ ...obj, }); @@ -6843,6 +7701,9 @@ export interface InvalidSortByException extends __SmithyException, $MetadataBear } export namespace InvalidSortByException { + /** + * @internal + */ export const filterSensitiveLog = (obj: InvalidSortByException): any => ({ ...obj, }); diff --git a/clients/client-codecommit/models/models_1.ts b/clients/client-codecommit/models/models_1.ts index 6dfd57cdf38c..f520297b5aaa 100644 --- a/clients/client-codecommit/models/models_1.ts +++ b/clients/client-codecommit/models/models_1.ts @@ -49,6 +49,9 @@ export interface ListRepositoriesInput { } export namespace ListRepositoriesInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListRepositoriesInput): any => ({ ...obj, }); @@ -70,6 +73,9 @@ export interface RepositoryNameIdPair { } export namespace RepositoryNameIdPair { + /** + * @internal + */ export const filterSensitiveLog = (obj: RepositoryNameIdPair): any => ({ ...obj, }); @@ -93,6 +99,9 @@ export interface ListRepositoriesOutput { } export namespace ListRepositoriesOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListRepositoriesOutput): any => ({ ...obj, }); @@ -117,6 +126,9 @@ export interface ListRepositoriesForApprovalRuleTemplateInput { } export namespace ListRepositoriesForApprovalRuleTemplateInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListRepositoriesForApprovalRuleTemplateInput): any => ({ ...obj, }); @@ -135,6 +147,9 @@ export interface ListRepositoriesForApprovalRuleTemplateOutput { } export namespace ListRepositoriesForApprovalRuleTemplateOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListRepositoriesForApprovalRuleTemplateOutput): any => ({ ...obj, }); @@ -155,6 +170,9 @@ export interface InvalidResourceArnException extends __SmithyException, $Metadat } export namespace InvalidResourceArnException { + /** + * @internal + */ export const filterSensitiveLog = (obj: InvalidResourceArnException): any => ({ ...obj, }); @@ -175,6 +193,9 @@ export interface ListTagsForResourceInput { } export namespace ListTagsForResourceInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListTagsForResourceInput): any => ({ ...obj, }); @@ -193,6 +214,9 @@ export interface ListTagsForResourceOutput { } export namespace ListTagsForResourceOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListTagsForResourceOutput): any => ({ ...obj, }); @@ -213,6 +237,9 @@ export interface ResourceArnRequiredException extends __SmithyException, $Metada } export namespace ResourceArnRequiredException { + /** + * @internal + */ export const filterSensitiveLog = (obj: ResourceArnRequiredException): any => ({ ...obj, }); @@ -231,6 +258,9 @@ export interface InvalidTargetBranchException extends __SmithyException, $Metada } export namespace InvalidTargetBranchException { + /** + * @internal + */ export const filterSensitiveLog = (obj: InvalidTargetBranchException): any => ({ ...obj, }); @@ -261,6 +291,9 @@ export interface MergeBranchesByFastForwardInput { } export namespace MergeBranchesByFastForwardInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: MergeBranchesByFastForwardInput): any => ({ ...obj, }); @@ -279,6 +312,9 @@ export interface MergeBranchesByFastForwardOutput { } export namespace MergeBranchesByFastForwardOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: MergeBranchesByFastForwardOutput): any => ({ ...obj, }); @@ -354,6 +390,9 @@ export interface MergeBranchesBySquashInput { } export namespace MergeBranchesBySquashInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: MergeBranchesBySquashInput): any => ({ ...obj, }); @@ -372,6 +411,9 @@ export interface MergeBranchesBySquashOutput { } export namespace MergeBranchesBySquashOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: MergeBranchesBySquashOutput): any => ({ ...obj, }); @@ -447,6 +489,9 @@ export interface MergeBranchesByThreeWayInput { } export namespace MergeBranchesByThreeWayInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: MergeBranchesByThreeWayInput): any => ({ ...obj, }); @@ -465,6 +510,9 @@ export interface MergeBranchesByThreeWayOutput { } export namespace MergeBranchesByThreeWayOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: MergeBranchesByThreeWayOutput): any => ({ ...obj, }); @@ -489,6 +537,9 @@ export interface MergePullRequestByFastForwardInput { } export namespace MergePullRequestByFastForwardInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: MergePullRequestByFastForwardInput): any => ({ ...obj, }); @@ -502,6 +553,9 @@ export interface MergePullRequestByFastForwardOutput { } export namespace MergePullRequestByFastForwardOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: MergePullRequestByFastForwardOutput): any => ({ ...obj, }); @@ -520,6 +574,9 @@ export interface PullRequestApprovalRulesNotSatisfiedException extends __SmithyE } export namespace PullRequestApprovalRulesNotSatisfiedException { + /** + * @internal + */ export const filterSensitiveLog = (obj: PullRequestApprovalRulesNotSatisfiedException): any => ({ ...obj, }); @@ -539,6 +596,9 @@ export interface TipOfSourceReferenceIsDifferentException extends __SmithyExcept } export namespace TipOfSourceReferenceIsDifferentException { + /** + * @internal + */ export const filterSensitiveLog = (obj: TipOfSourceReferenceIsDifferentException): any => ({ ...obj, }); @@ -608,6 +668,9 @@ export interface MergePullRequestBySquashInput { } export namespace MergePullRequestBySquashInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: MergePullRequestBySquashInput): any => ({ ...obj, }); @@ -621,6 +684,9 @@ export interface MergePullRequestBySquashOutput { } export namespace MergePullRequestBySquashOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: MergePullRequestBySquashOutput): any => ({ ...obj, }); @@ -690,6 +756,9 @@ export interface MergePullRequestByThreeWayInput { } export namespace MergePullRequestByThreeWayInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: MergePullRequestByThreeWayInput): any => ({ ...obj, }); @@ -703,6 +772,9 @@ export interface MergePullRequestByThreeWayOutput { } export namespace MergePullRequestByThreeWayOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: MergePullRequestByThreeWayOutput): any => ({ ...obj, }); @@ -721,6 +793,9 @@ export interface InvalidOverrideStatusException extends __SmithyException, $Meta } export namespace InvalidOverrideStatusException { + /** + * @internal + */ export const filterSensitiveLog = (obj: InvalidOverrideStatusException): any => ({ ...obj, }); @@ -739,6 +814,9 @@ export interface OverrideAlreadySetException extends __SmithyException, $Metadat } export namespace OverrideAlreadySetException { + /** + * @internal + */ export const filterSensitiveLog = (obj: OverrideAlreadySetException): any => ({ ...obj, }); @@ -766,6 +844,9 @@ export interface OverridePullRequestApprovalRulesInput { } export namespace OverridePullRequestApprovalRulesInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: OverridePullRequestApprovalRulesInput): any => ({ ...obj, }); @@ -784,6 +865,9 @@ export interface OverrideStatusRequiredException extends __SmithyException, $Met } export namespace OverrideStatusRequiredException { + /** + * @internal + */ export const filterSensitiveLog = (obj: OverrideStatusRequiredException): any => ({ ...obj, }); @@ -802,6 +886,9 @@ export interface CommentContentRequiredException extends __SmithyException, $Met } export namespace CommentContentRequiredException { + /** + * @internal + */ export const filterSensitiveLog = (obj: CommentContentRequiredException): any => ({ ...obj, }); @@ -820,6 +907,9 @@ export interface CommentContentSizeLimitExceededException extends __SmithyExcept } export namespace CommentContentSizeLimitExceededException { + /** + * @internal + */ export const filterSensitiveLog = (obj: CommentContentSizeLimitExceededException): any => ({ ...obj, }); @@ -839,6 +929,9 @@ export interface InvalidFileLocationException extends __SmithyException, $Metada } export namespace InvalidFileLocationException { + /** + * @internal + */ export const filterSensitiveLog = (obj: InvalidFileLocationException): any => ({ ...obj, }); @@ -857,6 +950,9 @@ export interface InvalidFilePositionException extends __SmithyException, $Metada } export namespace InvalidFilePositionException { + /** + * @internal + */ export const filterSensitiveLog = (obj: InvalidFilePositionException): any => ({ ...obj, }); @@ -875,6 +971,9 @@ export interface InvalidRelativeFileVersionEnumException extends __SmithyExcepti } export namespace InvalidRelativeFileVersionEnumException { + /** + * @internal + */ export const filterSensitiveLog = (obj: InvalidRelativeFileVersionEnumException): any => ({ ...obj, }); @@ -919,6 +1018,9 @@ export interface PostCommentForComparedCommitInput { } export namespace PostCommentForComparedCommitInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: PostCommentForComparedCommitInput): any => ({ ...obj, }); @@ -962,6 +1064,9 @@ export interface PostCommentForComparedCommitOutput { } export namespace PostCommentForComparedCommitOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: PostCommentForComparedCommitOutput): any => ({ ...obj, }); @@ -1010,6 +1115,9 @@ export interface PostCommentForPullRequestInput { } export namespace PostCommentForPullRequestInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: PostCommentForPullRequestInput): any => ({ ...obj, }); @@ -1060,6 +1168,9 @@ export interface PostCommentForPullRequestOutput { } export namespace PostCommentForPullRequestOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: PostCommentForPullRequestOutput): any => ({ ...obj, }); @@ -1087,6 +1198,9 @@ export interface PostCommentReplyInput { } export namespace PostCommentReplyInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: PostCommentReplyInput): any => ({ ...obj, }); @@ -1100,6 +1214,9 @@ export interface PostCommentReplyOutput { } export namespace PostCommentReplyOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: PostCommentReplyOutput): any => ({ ...obj, }); @@ -1118,6 +1235,9 @@ export interface InvalidReactionValueException extends __SmithyException, $Metad } export namespace InvalidReactionValueException { + /** + * @internal + */ export const filterSensitiveLog = (obj: InvalidReactionValueException): any => ({ ...obj, }); @@ -1137,6 +1257,9 @@ export interface PutCommentReactionInput { } export namespace PutCommentReactionInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: PutCommentReactionInput): any => ({ ...obj, }); @@ -1155,6 +1278,9 @@ export interface ReactionLimitExceededException extends __SmithyException, $Meta } export namespace ReactionLimitExceededException { + /** + * @internal + */ export const filterSensitiveLog = (obj: ReactionLimitExceededException): any => ({ ...obj, }); @@ -1173,6 +1299,9 @@ export interface ReactionValueRequiredException extends __SmithyException, $Meta } export namespace ReactionValueRequiredException { + /** + * @internal + */ export const filterSensitiveLog = (obj: ReactionValueRequiredException): any => ({ ...obj, }); @@ -1191,6 +1320,9 @@ export interface FileContentRequiredException extends __SmithyException, $Metada } export namespace FileContentRequiredException { + /** + * @internal + */ export const filterSensitiveLog = (obj: FileContentRequiredException): any => ({ ...obj, }); @@ -1255,6 +1387,9 @@ export interface PutFileInput { } export namespace PutFileInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: PutFileInput): any => ({ ...obj, }); @@ -1278,6 +1413,9 @@ export interface PutFileOutput { } export namespace PutFileOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: PutFileOutput): any => ({ ...obj, }); @@ -1297,6 +1435,9 @@ export interface SameFileContentException extends __SmithyException, $MetadataBe } export namespace SameFileContentException { + /** + * @internal + */ export const filterSensitiveLog = (obj: SameFileContentException): any => ({ ...obj, }); @@ -1315,6 +1456,9 @@ export interface InvalidRepositoryTriggerBranchNameException extends __SmithyExc } export namespace InvalidRepositoryTriggerBranchNameException { + /** + * @internal + */ export const filterSensitiveLog = (obj: InvalidRepositoryTriggerBranchNameException): any => ({ ...obj, }); @@ -1333,6 +1477,9 @@ export interface InvalidRepositoryTriggerCustomDataException extends __SmithyExc } export namespace InvalidRepositoryTriggerCustomDataException { + /** + * @internal + */ export const filterSensitiveLog = (obj: InvalidRepositoryTriggerCustomDataException): any => ({ ...obj, }); @@ -1351,6 +1498,9 @@ export interface InvalidRepositoryTriggerDestinationArnException extends __Smith } export namespace InvalidRepositoryTriggerDestinationArnException { + /** + * @internal + */ export const filterSensitiveLog = (obj: InvalidRepositoryTriggerDestinationArnException): any => ({ ...obj, }); @@ -1369,6 +1519,9 @@ export interface InvalidRepositoryTriggerEventsException extends __SmithyExcepti } export namespace InvalidRepositoryTriggerEventsException { + /** + * @internal + */ export const filterSensitiveLog = (obj: InvalidRepositoryTriggerEventsException): any => ({ ...obj, }); @@ -1387,6 +1540,9 @@ export interface InvalidRepositoryTriggerNameException extends __SmithyException } export namespace InvalidRepositoryTriggerNameException { + /** + * @internal + */ export const filterSensitiveLog = (obj: InvalidRepositoryTriggerNameException): any => ({ ...obj, }); @@ -1407,6 +1563,9 @@ export interface InvalidRepositoryTriggerRegionException extends __SmithyExcepti } export namespace InvalidRepositoryTriggerRegionException { + /** + * @internal + */ export const filterSensitiveLog = (obj: InvalidRepositoryTriggerRegionException): any => ({ ...obj, }); @@ -1425,6 +1584,9 @@ export interface MaximumBranchesExceededException extends __SmithyException, $Me } export namespace MaximumBranchesExceededException { + /** + * @internal + */ export const filterSensitiveLog = (obj: MaximumBranchesExceededException): any => ({ ...obj, }); @@ -1443,6 +1605,9 @@ export interface MaximumRepositoryTriggersExceededException extends __SmithyExce } export namespace MaximumRepositoryTriggersExceededException { + /** + * @internal + */ export const filterSensitiveLog = (obj: MaximumRepositoryTriggersExceededException): any => ({ ...obj, }); @@ -1464,6 +1629,9 @@ export interface PutRepositoryTriggersInput { } export namespace PutRepositoryTriggersInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: PutRepositoryTriggersInput): any => ({ ...obj, }); @@ -1480,6 +1648,9 @@ export interface PutRepositoryTriggersOutput { } export namespace PutRepositoryTriggersOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: PutRepositoryTriggersOutput): any => ({ ...obj, }); @@ -1499,6 +1670,9 @@ export interface RepositoryTriggerBranchNameListRequiredException extends __Smit } export namespace RepositoryTriggerBranchNameListRequiredException { + /** + * @internal + */ export const filterSensitiveLog = (obj: RepositoryTriggerBranchNameListRequiredException): any => ({ ...obj, }); @@ -1518,6 +1692,9 @@ export interface RepositoryTriggerDestinationArnRequiredException extends __Smit } export namespace RepositoryTriggerDestinationArnRequiredException { + /** + * @internal + */ export const filterSensitiveLog = (obj: RepositoryTriggerDestinationArnRequiredException): any => ({ ...obj, }); @@ -1536,6 +1713,9 @@ export interface RepositoryTriggerEventsListRequiredException extends __SmithyEx } export namespace RepositoryTriggerEventsListRequiredException { + /** + * @internal + */ export const filterSensitiveLog = (obj: RepositoryTriggerEventsListRequiredException): any => ({ ...obj, }); @@ -1554,6 +1734,9 @@ export interface RepositoryTriggerNameRequiredException extends __SmithyExceptio } export namespace RepositoryTriggerNameRequiredException { + /** + * @internal + */ export const filterSensitiveLog = (obj: RepositoryTriggerNameRequiredException): any => ({ ...obj, }); @@ -1572,6 +1755,9 @@ export interface RepositoryTriggersListRequiredException extends __SmithyExcepti } export namespace RepositoryTriggersListRequiredException { + /** + * @internal + */ export const filterSensitiveLog = (obj: RepositoryTriggersListRequiredException): any => ({ ...obj, }); @@ -1590,6 +1776,9 @@ export interface TagResourceInput { } export namespace TagResourceInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: TagResourceInput): any => ({ ...obj, }); @@ -1608,6 +1797,9 @@ export interface TagsMapRequiredException extends __SmithyException, $MetadataBe } export namespace TagsMapRequiredException { + /** + * @internal + */ export const filterSensitiveLog = (obj: TagsMapRequiredException): any => ({ ...obj, }); @@ -1629,6 +1821,9 @@ export interface TestRepositoryTriggersInput { } export namespace TestRepositoryTriggersInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: TestRepositoryTriggersInput): any => ({ ...obj, }); @@ -1650,6 +1845,9 @@ export interface RepositoryTriggerExecutionFailure { } export namespace RepositoryTriggerExecutionFailure { + /** + * @internal + */ export const filterSensitiveLog = (obj: RepositoryTriggerExecutionFailure): any => ({ ...obj, }); @@ -1672,6 +1870,9 @@ export interface TestRepositoryTriggersOutput { } export namespace TestRepositoryTriggersOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: TestRepositoryTriggersOutput): any => ({ ...obj, }); @@ -1690,6 +1891,9 @@ export interface InvalidTagKeysListException extends __SmithyException, $Metadat } export namespace InvalidTagKeysListException { + /** + * @internal + */ export const filterSensitiveLog = (obj: InvalidTagKeysListException): any => ({ ...obj, }); @@ -1708,6 +1912,9 @@ export interface TagKeysListRequiredException extends __SmithyException, $Metada } export namespace TagKeysListRequiredException { + /** + * @internal + */ export const filterSensitiveLog = (obj: TagKeysListRequiredException): any => ({ ...obj, }); @@ -1726,6 +1933,9 @@ export interface UntagResourceInput { } export namespace UntagResourceInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: UntagResourceInput): any => ({ ...obj, }); @@ -1744,6 +1954,9 @@ export interface InvalidRuleContentSha256Exception extends __SmithyException, $M } export namespace InvalidRuleContentSha256Exception { + /** + * @internal + */ export const filterSensitiveLog = (obj: InvalidRuleContentSha256Exception): any => ({ ...obj, }); @@ -1770,6 +1983,9 @@ export interface UpdateApprovalRuleTemplateContentInput { } export namespace UpdateApprovalRuleTemplateContentInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateApprovalRuleTemplateContentInput): any => ({ ...obj, }); @@ -1783,6 +1999,9 @@ export interface UpdateApprovalRuleTemplateContentOutput { } export namespace UpdateApprovalRuleTemplateContentOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateApprovalRuleTemplateContentOutput): any => ({ ...obj, }); @@ -1801,6 +2020,9 @@ export interface UpdateApprovalRuleTemplateDescriptionInput { } export namespace UpdateApprovalRuleTemplateDescriptionInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateApprovalRuleTemplateDescriptionInput): any => ({ ...obj, }); @@ -1814,6 +2036,9 @@ export interface UpdateApprovalRuleTemplateDescriptionOutput { } export namespace UpdateApprovalRuleTemplateDescriptionOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateApprovalRuleTemplateDescriptionOutput): any => ({ ...obj, }); @@ -1832,6 +2057,9 @@ export interface UpdateApprovalRuleTemplateNameInput { } export namespace UpdateApprovalRuleTemplateNameInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateApprovalRuleTemplateNameInput): any => ({ ...obj, }); @@ -1845,6 +2073,9 @@ export interface UpdateApprovalRuleTemplateNameOutput { } export namespace UpdateApprovalRuleTemplateNameOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateApprovalRuleTemplateNameOutput): any => ({ ...obj, }); @@ -1863,6 +2094,9 @@ export interface CommentNotCreatedByCallerException extends __SmithyException, $ } export namespace CommentNotCreatedByCallerException { + /** + * @internal + */ export const filterSensitiveLog = (obj: CommentNotCreatedByCallerException): any => ({ ...obj, }); @@ -1882,6 +2116,9 @@ export interface UpdateCommentInput { } export namespace UpdateCommentInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateCommentInput): any => ({ ...obj, }); @@ -1895,6 +2132,9 @@ export interface UpdateCommentOutput { } export namespace UpdateCommentOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateCommentOutput): any => ({ ...obj, }); @@ -1916,6 +2156,9 @@ export interface UpdateDefaultBranchInput { } export namespace UpdateDefaultBranchInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateDefaultBranchInput): any => ({ ...obj, }); @@ -1986,6 +2229,9 @@ export interface UpdatePullRequestApprovalRuleContentInput { } export namespace UpdatePullRequestApprovalRuleContentInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdatePullRequestApprovalRuleContentInput): any => ({ ...obj, }); @@ -1999,6 +2245,9 @@ export interface UpdatePullRequestApprovalRuleContentOutput { } export namespace UpdatePullRequestApprovalRuleContentOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdatePullRequestApprovalRuleContentOutput): any => ({ ...obj, }); @@ -2017,6 +2266,9 @@ export interface InvalidApprovalStateException extends __SmithyException, $Metad } export namespace InvalidApprovalStateException { + /** + * @internal + */ export const filterSensitiveLog = (obj: InvalidApprovalStateException): any => ({ ...obj, }); @@ -2035,6 +2287,9 @@ export interface MaximumNumberOfApprovalsExceededException extends __SmithyExcep } export namespace MaximumNumberOfApprovalsExceededException { + /** + * @internal + */ export const filterSensitiveLog = (obj: MaximumNumberOfApprovalsExceededException): any => ({ ...obj, }); @@ -2054,6 +2309,9 @@ export interface PullRequestCannotBeApprovedByAuthorException extends __SmithyEx } export namespace PullRequestCannotBeApprovedByAuthorException { + /** + * @internal + */ export const filterSensitiveLog = (obj: PullRequestCannotBeApprovedByAuthorException): any => ({ ...obj, }); @@ -2077,6 +2335,9 @@ export interface UpdatePullRequestApprovalStateInput { } export namespace UpdatePullRequestApprovalStateInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdatePullRequestApprovalStateInput): any => ({ ...obj, }); @@ -2096,6 +2357,9 @@ export interface UpdatePullRequestDescriptionInput { } export namespace UpdatePullRequestDescriptionInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdatePullRequestDescriptionInput): any => ({ ...obj, }); @@ -2109,6 +2373,9 @@ export interface UpdatePullRequestDescriptionOutput { } export namespace UpdatePullRequestDescriptionOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdatePullRequestDescriptionOutput): any => ({ ...obj, }); @@ -2127,6 +2394,9 @@ export interface InvalidPullRequestStatusUpdateException extends __SmithyExcepti } export namespace InvalidPullRequestStatusUpdateException { + /** + * @internal + */ export const filterSensitiveLog = (obj: InvalidPullRequestStatusUpdateException): any => ({ ...obj, }); @@ -2145,6 +2415,9 @@ export interface PullRequestStatusRequiredException extends __SmithyException, $ } export namespace PullRequestStatusRequiredException { + /** + * @internal + */ export const filterSensitiveLog = (obj: PullRequestStatusRequiredException): any => ({ ...obj, }); @@ -2165,6 +2438,9 @@ export interface UpdatePullRequestStatusInput { } export namespace UpdatePullRequestStatusInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdatePullRequestStatusInput): any => ({ ...obj, }); @@ -2178,6 +2454,9 @@ export interface UpdatePullRequestStatusOutput { } export namespace UpdatePullRequestStatusOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdatePullRequestStatusOutput): any => ({ ...obj, }); @@ -2196,6 +2475,9 @@ export interface UpdatePullRequestTitleInput { } export namespace UpdatePullRequestTitleInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdatePullRequestTitleInput): any => ({ ...obj, }); @@ -2209,6 +2491,9 @@ export interface UpdatePullRequestTitleOutput { } export namespace UpdatePullRequestTitleOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdatePullRequestTitleOutput): any => ({ ...obj, }); @@ -2230,6 +2515,9 @@ export interface UpdateRepositoryDescriptionInput { } export namespace UpdateRepositoryDescriptionInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateRepositoryDescriptionInput): any => ({ ...obj, }); @@ -2251,6 +2539,9 @@ export interface UpdateRepositoryNameInput { } export namespace UpdateRepositoryNameInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateRepositoryNameInput): any => ({ ...obj, }); diff --git a/clients/client-codedeploy/commands/AddTagsToOnPremisesInstancesCommand.ts b/clients/client-codedeploy/commands/AddTagsToOnPremisesInstancesCommand.ts index 11073e2e7a94..82b571309016 100644 --- a/clients/client-codedeploy/commands/AddTagsToOnPremisesInstancesCommand.ts +++ b/clients/client-codedeploy/commands/AddTagsToOnPremisesInstancesCommand.ts @@ -22,6 +22,20 @@ export interface AddTagsToOnPremisesInstancesCommandOutput extends __MetadataBea /** *

Adds tags to on-premises instances.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { CodeDeployClient, AddTagsToOnPremisesInstancesCommand } from "@aws-sdk/client-codedeploy"; // ES Modules import + * // const { CodeDeployClient, AddTagsToOnPremisesInstancesCommand } = require("@aws-sdk/client-codedeploy"); // CommonJS import + * const client = new CodeDeployClient(config); + * const command = new AddTagsToOnPremisesInstancesCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link AddTagsToOnPremisesInstancesCommandInput} for command's `input` shape. + * @see {@link AddTagsToOnPremisesInstancesCommandOutput} for command's `response` shape. + * @see {@link CodeDeployClientResolvedConfig | config} for command's `input` shape. + * */ export class AddTagsToOnPremisesInstancesCommand extends $Command< AddTagsToOnPremisesInstancesCommandInput, diff --git a/clients/client-codedeploy/commands/BatchGetApplicationRevisionsCommand.ts b/clients/client-codedeploy/commands/BatchGetApplicationRevisionsCommand.ts index 2a050f29864f..4ddd9ea843da 100644 --- a/clients/client-codedeploy/commands/BatchGetApplicationRevisionsCommand.ts +++ b/clients/client-codedeploy/commands/BatchGetApplicationRevisionsCommand.ts @@ -25,6 +25,20 @@ export interface BatchGetApplicationRevisionsCommandOutput /** *

Gets information about one or more application revisions. The maximum number of * application revisions that can be returned is 25.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { CodeDeployClient, BatchGetApplicationRevisionsCommand } from "@aws-sdk/client-codedeploy"; // ES Modules import + * // const { CodeDeployClient, BatchGetApplicationRevisionsCommand } = require("@aws-sdk/client-codedeploy"); // CommonJS import + * const client = new CodeDeployClient(config); + * const command = new BatchGetApplicationRevisionsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link BatchGetApplicationRevisionsCommandInput} for command's `input` shape. + * @see {@link BatchGetApplicationRevisionsCommandOutput} for command's `response` shape. + * @see {@link CodeDeployClientResolvedConfig | config} for command's `input` shape. + * */ export class BatchGetApplicationRevisionsCommand extends $Command< BatchGetApplicationRevisionsCommandInput, diff --git a/clients/client-codedeploy/commands/BatchGetApplicationsCommand.ts b/clients/client-codedeploy/commands/BatchGetApplicationsCommand.ts index a813cea35192..498c68d2c788 100644 --- a/clients/client-codedeploy/commands/BatchGetApplicationsCommand.ts +++ b/clients/client-codedeploy/commands/BatchGetApplicationsCommand.ts @@ -23,6 +23,20 @@ export interface BatchGetApplicationsCommandOutput extends BatchGetApplicationsO /** *

Gets information about one or more applications. The maximum number of applications * that can be returned is 100.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { CodeDeployClient, BatchGetApplicationsCommand } from "@aws-sdk/client-codedeploy"; // ES Modules import + * // const { CodeDeployClient, BatchGetApplicationsCommand } = require("@aws-sdk/client-codedeploy"); // CommonJS import + * const client = new CodeDeployClient(config); + * const command = new BatchGetApplicationsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link BatchGetApplicationsCommandInput} for command's `input` shape. + * @see {@link BatchGetApplicationsCommandOutput} for command's `response` shape. + * @see {@link CodeDeployClientResolvedConfig | config} for command's `input` shape. + * */ export class BatchGetApplicationsCommand extends $Command< BatchGetApplicationsCommandInput, diff --git a/clients/client-codedeploy/commands/BatchGetDeploymentGroupsCommand.ts b/clients/client-codedeploy/commands/BatchGetDeploymentGroupsCommand.ts index 8d3945d7b8d0..a8c513e47768 100644 --- a/clients/client-codedeploy/commands/BatchGetDeploymentGroupsCommand.ts +++ b/clients/client-codedeploy/commands/BatchGetDeploymentGroupsCommand.ts @@ -22,6 +22,20 @@ export interface BatchGetDeploymentGroupsCommandOutput extends BatchGetDeploymen /** *

Gets information about one or more deployment groups.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { CodeDeployClient, BatchGetDeploymentGroupsCommand } from "@aws-sdk/client-codedeploy"; // ES Modules import + * // const { CodeDeployClient, BatchGetDeploymentGroupsCommand } = require("@aws-sdk/client-codedeploy"); // CommonJS import + * const client = new CodeDeployClient(config); + * const command = new BatchGetDeploymentGroupsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link BatchGetDeploymentGroupsCommandInput} for command's `input` shape. + * @see {@link BatchGetDeploymentGroupsCommandOutput} for command's `response` shape. + * @see {@link CodeDeployClientResolvedConfig | config} for command's `input` shape. + * */ export class BatchGetDeploymentGroupsCommand extends $Command< BatchGetDeploymentGroupsCommandInput, diff --git a/clients/client-codedeploy/commands/BatchGetDeploymentInstancesCommand.ts b/clients/client-codedeploy/commands/BatchGetDeploymentInstancesCommand.ts index 0723d0162ba4..c9661039a01a 100644 --- a/clients/client-codedeploy/commands/BatchGetDeploymentInstancesCommand.ts +++ b/clients/client-codedeploy/commands/BatchGetDeploymentInstancesCommand.ts @@ -31,6 +31,20 @@ export interface BatchGetDeploymentInstancesCommandOutput extends BatchGetDeploy * works with EC2/On-premises and AWS Lambda compute platforms. The newer * BatchGetDeploymentTargets works with all compute platforms. The maximum * number of instances that can be returned is 25.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { CodeDeployClient, BatchGetDeploymentInstancesCommand } from "@aws-sdk/client-codedeploy"; // ES Modules import + * // const { CodeDeployClient, BatchGetDeploymentInstancesCommand } = require("@aws-sdk/client-codedeploy"); // CommonJS import + * const client = new CodeDeployClient(config); + * const command = new BatchGetDeploymentInstancesCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link BatchGetDeploymentInstancesCommandInput} for command's `input` shape. + * @see {@link BatchGetDeploymentInstancesCommandOutput} for command's `response` shape. + * @see {@link CodeDeployClientResolvedConfig | config} for command's `input` shape. + * */ export class BatchGetDeploymentInstancesCommand extends $Command< BatchGetDeploymentInstancesCommandInput, diff --git a/clients/client-codedeploy/commands/BatchGetDeploymentTargetsCommand.ts b/clients/client-codedeploy/commands/BatchGetDeploymentTargetsCommand.ts index b65ac40a8ebc..1a21ed1aba2f 100644 --- a/clients/client-codedeploy/commands/BatchGetDeploymentTargetsCommand.ts +++ b/clients/client-codedeploy/commands/BatchGetDeploymentTargetsCommand.ts @@ -49,6 +49,20 @@ export interface BatchGetDeploymentTargetsCommandOutput extends BatchGetDeployme * blue/green deployments initiated by a CloudFormation stack update.

* * + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { CodeDeployClient, BatchGetDeploymentTargetsCommand } from "@aws-sdk/client-codedeploy"; // ES Modules import + * // const { CodeDeployClient, BatchGetDeploymentTargetsCommand } = require("@aws-sdk/client-codedeploy"); // CommonJS import + * const client = new CodeDeployClient(config); + * const command = new BatchGetDeploymentTargetsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link BatchGetDeploymentTargetsCommandInput} for command's `input` shape. + * @see {@link BatchGetDeploymentTargetsCommandOutput} for command's `response` shape. + * @see {@link CodeDeployClientResolvedConfig | config} for command's `input` shape. + * */ export class BatchGetDeploymentTargetsCommand extends $Command< BatchGetDeploymentTargetsCommandInput, diff --git a/clients/client-codedeploy/commands/BatchGetDeploymentsCommand.ts b/clients/client-codedeploy/commands/BatchGetDeploymentsCommand.ts index 1621b38fea6b..36949e35d099 100644 --- a/clients/client-codedeploy/commands/BatchGetDeploymentsCommand.ts +++ b/clients/client-codedeploy/commands/BatchGetDeploymentsCommand.ts @@ -23,6 +23,20 @@ export interface BatchGetDeploymentsCommandOutput extends BatchGetDeploymentsOut /** *

Gets information about one or more deployments. The maximum number of deployments that * can be returned is 25.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { CodeDeployClient, BatchGetDeploymentsCommand } from "@aws-sdk/client-codedeploy"; // ES Modules import + * // const { CodeDeployClient, BatchGetDeploymentsCommand } = require("@aws-sdk/client-codedeploy"); // CommonJS import + * const client = new CodeDeployClient(config); + * const command = new BatchGetDeploymentsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link BatchGetDeploymentsCommandInput} for command's `input` shape. + * @see {@link BatchGetDeploymentsCommandOutput} for command's `response` shape. + * @see {@link CodeDeployClientResolvedConfig | config} for command's `input` shape. + * */ export class BatchGetDeploymentsCommand extends $Command< BatchGetDeploymentsCommandInput, diff --git a/clients/client-codedeploy/commands/BatchGetOnPremisesInstancesCommand.ts b/clients/client-codedeploy/commands/BatchGetOnPremisesInstancesCommand.ts index a704659d3301..8259fbeb1e37 100644 --- a/clients/client-codedeploy/commands/BatchGetOnPremisesInstancesCommand.ts +++ b/clients/client-codedeploy/commands/BatchGetOnPremisesInstancesCommand.ts @@ -23,6 +23,20 @@ export interface BatchGetOnPremisesInstancesCommandOutput extends BatchGetOnPrem /** *

Gets information about one or more on-premises instances. The maximum number of * on-premises instances that can be returned is 25.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { CodeDeployClient, BatchGetOnPremisesInstancesCommand } from "@aws-sdk/client-codedeploy"; // ES Modules import + * // const { CodeDeployClient, BatchGetOnPremisesInstancesCommand } = require("@aws-sdk/client-codedeploy"); // CommonJS import + * const client = new CodeDeployClient(config); + * const command = new BatchGetOnPremisesInstancesCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link BatchGetOnPremisesInstancesCommandInput} for command's `input` shape. + * @see {@link BatchGetOnPremisesInstancesCommandOutput} for command's `response` shape. + * @see {@link CodeDeployClientResolvedConfig | config} for command's `input` shape. + * */ export class BatchGetOnPremisesInstancesCommand extends $Command< BatchGetOnPremisesInstancesCommandInput, diff --git a/clients/client-codedeploy/commands/ContinueDeploymentCommand.ts b/clients/client-codedeploy/commands/ContinueDeploymentCommand.ts index a44383e348d8..4a8819d141dc 100644 --- a/clients/client-codedeploy/commands/ContinueDeploymentCommand.ts +++ b/clients/client-codedeploy/commands/ContinueDeploymentCommand.ts @@ -26,6 +26,20 @@ export interface ContinueDeploymentCommandOutput extends __MetadataBearer {} * 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.)

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { CodeDeployClient, ContinueDeploymentCommand } from "@aws-sdk/client-codedeploy"; // ES Modules import + * // const { CodeDeployClient, ContinueDeploymentCommand } = require("@aws-sdk/client-codedeploy"); // CommonJS import + * const client = new CodeDeployClient(config); + * const command = new ContinueDeploymentCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ContinueDeploymentCommandInput} for command's `input` shape. + * @see {@link ContinueDeploymentCommandOutput} for command's `response` shape. + * @see {@link CodeDeployClientResolvedConfig | config} for command's `input` shape. + * */ export class ContinueDeploymentCommand extends $Command< ContinueDeploymentCommandInput, diff --git a/clients/client-codedeploy/commands/CreateApplicationCommand.ts b/clients/client-codedeploy/commands/CreateApplicationCommand.ts index c8368639ea60..e60d0305c41b 100644 --- a/clients/client-codedeploy/commands/CreateApplicationCommand.ts +++ b/clients/client-codedeploy/commands/CreateApplicationCommand.ts @@ -22,6 +22,20 @@ export interface CreateApplicationCommandOutput extends CreateApplicationOutput, /** *

Creates an application.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { CodeDeployClient, CreateApplicationCommand } from "@aws-sdk/client-codedeploy"; // ES Modules import + * // const { CodeDeployClient, CreateApplicationCommand } = require("@aws-sdk/client-codedeploy"); // CommonJS import + * const client = new CodeDeployClient(config); + * const command = new CreateApplicationCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreateApplicationCommandInput} for command's `input` shape. + * @see {@link CreateApplicationCommandOutput} for command's `response` shape. + * @see {@link CodeDeployClientResolvedConfig | config} for command's `input` shape. + * */ export class CreateApplicationCommand extends $Command< CreateApplicationCommandInput, diff --git a/clients/client-codedeploy/commands/CreateDeploymentCommand.ts b/clients/client-codedeploy/commands/CreateDeploymentCommand.ts index 6e3a8226a88c..e95543e29b88 100644 --- a/clients/client-codedeploy/commands/CreateDeploymentCommand.ts +++ b/clients/client-codedeploy/commands/CreateDeploymentCommand.ts @@ -22,6 +22,20 @@ export interface CreateDeploymentCommandOutput extends CreateDeploymentOutput, _ /** *

Deploys an application revision through the specified deployment group.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { CodeDeployClient, CreateDeploymentCommand } from "@aws-sdk/client-codedeploy"; // ES Modules import + * // const { CodeDeployClient, CreateDeploymentCommand } = require("@aws-sdk/client-codedeploy"); // CommonJS import + * const client = new CodeDeployClient(config); + * const command = new CreateDeploymentCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreateDeploymentCommandInput} for command's `input` shape. + * @see {@link CreateDeploymentCommandOutput} for command's `response` shape. + * @see {@link CodeDeployClientResolvedConfig | config} for command's `input` shape. + * */ export class CreateDeploymentCommand extends $Command< CreateDeploymentCommandInput, diff --git a/clients/client-codedeploy/commands/CreateDeploymentConfigCommand.ts b/clients/client-codedeploy/commands/CreateDeploymentConfigCommand.ts index 7a0cb1d3d0d0..f49312f91208 100644 --- a/clients/client-codedeploy/commands/CreateDeploymentConfigCommand.ts +++ b/clients/client-codedeploy/commands/CreateDeploymentConfigCommand.ts @@ -22,6 +22,20 @@ export interface CreateDeploymentConfigCommandOutput extends CreateDeploymentCon /** *

Creates a deployment configuration.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { CodeDeployClient, CreateDeploymentConfigCommand } from "@aws-sdk/client-codedeploy"; // ES Modules import + * // const { CodeDeployClient, CreateDeploymentConfigCommand } = require("@aws-sdk/client-codedeploy"); // CommonJS import + * const client = new CodeDeployClient(config); + * const command = new CreateDeploymentConfigCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreateDeploymentConfigCommandInput} for command's `input` shape. + * @see {@link CreateDeploymentConfigCommandOutput} for command's `response` shape. + * @see {@link CodeDeployClientResolvedConfig | config} for command's `input` shape. + * */ export class CreateDeploymentConfigCommand extends $Command< CreateDeploymentConfigCommandInput, diff --git a/clients/client-codedeploy/commands/CreateDeploymentGroupCommand.ts b/clients/client-codedeploy/commands/CreateDeploymentGroupCommand.ts index 27bc09a5300b..2b815d33e072 100644 --- a/clients/client-codedeploy/commands/CreateDeploymentGroupCommand.ts +++ b/clients/client-codedeploy/commands/CreateDeploymentGroupCommand.ts @@ -22,6 +22,20 @@ export interface CreateDeploymentGroupCommandOutput extends CreateDeploymentGrou /** *

Creates a deployment group to which application revisions are deployed.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { CodeDeployClient, CreateDeploymentGroupCommand } from "@aws-sdk/client-codedeploy"; // ES Modules import + * // const { CodeDeployClient, CreateDeploymentGroupCommand } = require("@aws-sdk/client-codedeploy"); // CommonJS import + * const client = new CodeDeployClient(config); + * const command = new CreateDeploymentGroupCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreateDeploymentGroupCommandInput} for command's `input` shape. + * @see {@link CreateDeploymentGroupCommandOutput} for command's `response` shape. + * @see {@link CodeDeployClientResolvedConfig | config} for command's `input` shape. + * */ export class CreateDeploymentGroupCommand extends $Command< CreateDeploymentGroupCommandInput, diff --git a/clients/client-codedeploy/commands/DeleteApplicationCommand.ts b/clients/client-codedeploy/commands/DeleteApplicationCommand.ts index 3312e61186fd..f07612cc4937 100644 --- a/clients/client-codedeploy/commands/DeleteApplicationCommand.ts +++ b/clients/client-codedeploy/commands/DeleteApplicationCommand.ts @@ -22,6 +22,20 @@ export interface DeleteApplicationCommandOutput extends __MetadataBearer {} /** *

Deletes an application.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { CodeDeployClient, DeleteApplicationCommand } from "@aws-sdk/client-codedeploy"; // ES Modules import + * // const { CodeDeployClient, DeleteApplicationCommand } = require("@aws-sdk/client-codedeploy"); // CommonJS import + * const client = new CodeDeployClient(config); + * const command = new DeleteApplicationCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteApplicationCommandInput} for command's `input` shape. + * @see {@link DeleteApplicationCommandOutput} for command's `response` shape. + * @see {@link CodeDeployClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteApplicationCommand extends $Command< DeleteApplicationCommandInput, diff --git a/clients/client-codedeploy/commands/DeleteDeploymentConfigCommand.ts b/clients/client-codedeploy/commands/DeleteDeploymentConfigCommand.ts index 62c6e58100a3..11f5a23b8bc6 100644 --- a/clients/client-codedeploy/commands/DeleteDeploymentConfigCommand.ts +++ b/clients/client-codedeploy/commands/DeleteDeploymentConfigCommand.ts @@ -26,6 +26,20 @@ export interface DeleteDeploymentConfigCommandOutput extends __MetadataBearer {} *

A deployment configuration cannot be deleted if it is currently in use. Predefined * configurations cannot be deleted.

* + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { CodeDeployClient, DeleteDeploymentConfigCommand } from "@aws-sdk/client-codedeploy"; // ES Modules import + * // const { CodeDeployClient, DeleteDeploymentConfigCommand } = require("@aws-sdk/client-codedeploy"); // CommonJS import + * const client = new CodeDeployClient(config); + * const command = new DeleteDeploymentConfigCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteDeploymentConfigCommandInput} for command's `input` shape. + * @see {@link DeleteDeploymentConfigCommandOutput} for command's `response` shape. + * @see {@link CodeDeployClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteDeploymentConfigCommand extends $Command< DeleteDeploymentConfigCommandInput, diff --git a/clients/client-codedeploy/commands/DeleteDeploymentGroupCommand.ts b/clients/client-codedeploy/commands/DeleteDeploymentGroupCommand.ts index 47b3d3e21b6f..1ea40fe198ce 100644 --- a/clients/client-codedeploy/commands/DeleteDeploymentGroupCommand.ts +++ b/clients/client-codedeploy/commands/DeleteDeploymentGroupCommand.ts @@ -22,6 +22,20 @@ export interface DeleteDeploymentGroupCommandOutput extends DeleteDeploymentGrou /** *

Deletes a deployment group.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { CodeDeployClient, DeleteDeploymentGroupCommand } from "@aws-sdk/client-codedeploy"; // ES Modules import + * // const { CodeDeployClient, DeleteDeploymentGroupCommand } = require("@aws-sdk/client-codedeploy"); // CommonJS import + * const client = new CodeDeployClient(config); + * const command = new DeleteDeploymentGroupCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteDeploymentGroupCommandInput} for command's `input` shape. + * @see {@link DeleteDeploymentGroupCommandOutput} for command's `response` shape. + * @see {@link CodeDeployClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteDeploymentGroupCommand extends $Command< DeleteDeploymentGroupCommandInput, diff --git a/clients/client-codedeploy/commands/DeleteGitHubAccountTokenCommand.ts b/clients/client-codedeploy/commands/DeleteGitHubAccountTokenCommand.ts index cf86876a3715..79f0794f749b 100644 --- a/clients/client-codedeploy/commands/DeleteGitHubAccountTokenCommand.ts +++ b/clients/client-codedeploy/commands/DeleteGitHubAccountTokenCommand.ts @@ -22,6 +22,20 @@ export interface DeleteGitHubAccountTokenCommandOutput extends DeleteGitHubAccou /** *

Deletes a GitHub account connection.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { CodeDeployClient, DeleteGitHubAccountTokenCommand } from "@aws-sdk/client-codedeploy"; // ES Modules import + * // const { CodeDeployClient, DeleteGitHubAccountTokenCommand } = require("@aws-sdk/client-codedeploy"); // CommonJS import + * const client = new CodeDeployClient(config); + * const command = new DeleteGitHubAccountTokenCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteGitHubAccountTokenCommandInput} for command's `input` shape. + * @see {@link DeleteGitHubAccountTokenCommandOutput} for command's `response` shape. + * @see {@link CodeDeployClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteGitHubAccountTokenCommand extends $Command< DeleteGitHubAccountTokenCommandInput, diff --git a/clients/client-codedeploy/commands/DeleteResourcesByExternalIdCommand.ts b/clients/client-codedeploy/commands/DeleteResourcesByExternalIdCommand.ts index 665037ea0602..97652280f8f2 100644 --- a/clients/client-codedeploy/commands/DeleteResourcesByExternalIdCommand.ts +++ b/clients/client-codedeploy/commands/DeleteResourcesByExternalIdCommand.ts @@ -22,6 +22,20 @@ export interface DeleteResourcesByExternalIdCommandOutput extends DeleteResource /** *

Deletes resources linked to an external ID.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { CodeDeployClient, DeleteResourcesByExternalIdCommand } from "@aws-sdk/client-codedeploy"; // ES Modules import + * // const { CodeDeployClient, DeleteResourcesByExternalIdCommand } = require("@aws-sdk/client-codedeploy"); // CommonJS import + * const client = new CodeDeployClient(config); + * const command = new DeleteResourcesByExternalIdCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteResourcesByExternalIdCommandInput} for command's `input` shape. + * @see {@link DeleteResourcesByExternalIdCommandOutput} for command's `response` shape. + * @see {@link CodeDeployClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteResourcesByExternalIdCommand extends $Command< DeleteResourcesByExternalIdCommandInput, diff --git a/clients/client-codedeploy/commands/DeregisterOnPremisesInstanceCommand.ts b/clients/client-codedeploy/commands/DeregisterOnPremisesInstanceCommand.ts index 5bb224a3a704..a37a00ee1280 100644 --- a/clients/client-codedeploy/commands/DeregisterOnPremisesInstanceCommand.ts +++ b/clients/client-codedeploy/commands/DeregisterOnPremisesInstanceCommand.ts @@ -22,6 +22,20 @@ export interface DeregisterOnPremisesInstanceCommandOutput extends __MetadataBea /** *

Deregisters an on-premises instance.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { CodeDeployClient, DeregisterOnPremisesInstanceCommand } from "@aws-sdk/client-codedeploy"; // ES Modules import + * // const { CodeDeployClient, DeregisterOnPremisesInstanceCommand } = require("@aws-sdk/client-codedeploy"); // CommonJS import + * const client = new CodeDeployClient(config); + * const command = new DeregisterOnPremisesInstanceCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeregisterOnPremisesInstanceCommandInput} for command's `input` shape. + * @see {@link DeregisterOnPremisesInstanceCommandOutput} for command's `response` shape. + * @see {@link CodeDeployClientResolvedConfig | config} for command's `input` shape. + * */ export class DeregisterOnPremisesInstanceCommand extends $Command< DeregisterOnPremisesInstanceCommandInput, diff --git a/clients/client-codedeploy/commands/GetApplicationCommand.ts b/clients/client-codedeploy/commands/GetApplicationCommand.ts index 1d1bb528e57e..8a2e374a5fb5 100644 --- a/clients/client-codedeploy/commands/GetApplicationCommand.ts +++ b/clients/client-codedeploy/commands/GetApplicationCommand.ts @@ -22,6 +22,20 @@ export interface GetApplicationCommandOutput extends GetApplicationOutput, __Met /** *

Gets information about an application.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { CodeDeployClient, GetApplicationCommand } from "@aws-sdk/client-codedeploy"; // ES Modules import + * // const { CodeDeployClient, GetApplicationCommand } = require("@aws-sdk/client-codedeploy"); // CommonJS import + * const client = new CodeDeployClient(config); + * const command = new GetApplicationCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetApplicationCommandInput} for command's `input` shape. + * @see {@link GetApplicationCommandOutput} for command's `response` shape. + * @see {@link CodeDeployClientResolvedConfig | config} for command's `input` shape. + * */ export class GetApplicationCommand extends $Command< GetApplicationCommandInput, diff --git a/clients/client-codedeploy/commands/GetApplicationRevisionCommand.ts b/clients/client-codedeploy/commands/GetApplicationRevisionCommand.ts index 122b888218d2..fdaee6cc9179 100644 --- a/clients/client-codedeploy/commands/GetApplicationRevisionCommand.ts +++ b/clients/client-codedeploy/commands/GetApplicationRevisionCommand.ts @@ -22,6 +22,20 @@ export interface GetApplicationRevisionCommandOutput extends GetApplicationRevis /** *

Gets information about an application revision.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { CodeDeployClient, GetApplicationRevisionCommand } from "@aws-sdk/client-codedeploy"; // ES Modules import + * // const { CodeDeployClient, GetApplicationRevisionCommand } = require("@aws-sdk/client-codedeploy"); // CommonJS import + * const client = new CodeDeployClient(config); + * const command = new GetApplicationRevisionCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetApplicationRevisionCommandInput} for command's `input` shape. + * @see {@link GetApplicationRevisionCommandOutput} for command's `response` shape. + * @see {@link CodeDeployClientResolvedConfig | config} for command's `input` shape. + * */ export class GetApplicationRevisionCommand extends $Command< GetApplicationRevisionCommandInput, diff --git a/clients/client-codedeploy/commands/GetDeploymentCommand.ts b/clients/client-codedeploy/commands/GetDeploymentCommand.ts index 7225105ff4ae..30325155405d 100644 --- a/clients/client-codedeploy/commands/GetDeploymentCommand.ts +++ b/clients/client-codedeploy/commands/GetDeploymentCommand.ts @@ -28,6 +28,20 @@ export interface GetDeploymentCommandOutput extends GetDeploymentOutput, __Metad * the sha256 property of the returned appSpecContent object * to get the content of the deployment’s AppSpec file.

* + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { CodeDeployClient, GetDeploymentCommand } from "@aws-sdk/client-codedeploy"; // ES Modules import + * // const { CodeDeployClient, GetDeploymentCommand } = require("@aws-sdk/client-codedeploy"); // CommonJS import + * const client = new CodeDeployClient(config); + * const command = new GetDeploymentCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetDeploymentCommandInput} for command's `input` shape. + * @see {@link GetDeploymentCommandOutput} for command's `response` shape. + * @see {@link CodeDeployClientResolvedConfig | config} for command's `input` shape. + * */ export class GetDeploymentCommand extends $Command< GetDeploymentCommandInput, diff --git a/clients/client-codedeploy/commands/GetDeploymentConfigCommand.ts b/clients/client-codedeploy/commands/GetDeploymentConfigCommand.ts index a92229997f70..835bcb9b823a 100644 --- a/clients/client-codedeploy/commands/GetDeploymentConfigCommand.ts +++ b/clients/client-codedeploy/commands/GetDeploymentConfigCommand.ts @@ -22,6 +22,20 @@ export interface GetDeploymentConfigCommandOutput extends GetDeploymentConfigOut /** *

Gets information about a deployment configuration.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { CodeDeployClient, GetDeploymentConfigCommand } from "@aws-sdk/client-codedeploy"; // ES Modules import + * // const { CodeDeployClient, GetDeploymentConfigCommand } = require("@aws-sdk/client-codedeploy"); // CommonJS import + * const client = new CodeDeployClient(config); + * const command = new GetDeploymentConfigCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetDeploymentConfigCommandInput} for command's `input` shape. + * @see {@link GetDeploymentConfigCommandOutput} for command's `response` shape. + * @see {@link CodeDeployClientResolvedConfig | config} for command's `input` shape. + * */ export class GetDeploymentConfigCommand extends $Command< GetDeploymentConfigCommandInput, diff --git a/clients/client-codedeploy/commands/GetDeploymentGroupCommand.ts b/clients/client-codedeploy/commands/GetDeploymentGroupCommand.ts index d835a6c2b2b2..4bfe64fa7ec7 100644 --- a/clients/client-codedeploy/commands/GetDeploymentGroupCommand.ts +++ b/clients/client-codedeploy/commands/GetDeploymentGroupCommand.ts @@ -22,6 +22,20 @@ export interface GetDeploymentGroupCommandOutput extends GetDeploymentGroupOutpu /** *

Gets information about a deployment group.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { CodeDeployClient, GetDeploymentGroupCommand } from "@aws-sdk/client-codedeploy"; // ES Modules import + * // const { CodeDeployClient, GetDeploymentGroupCommand } = require("@aws-sdk/client-codedeploy"); // CommonJS import + * const client = new CodeDeployClient(config); + * const command = new GetDeploymentGroupCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetDeploymentGroupCommandInput} for command's `input` shape. + * @see {@link GetDeploymentGroupCommandOutput} for command's `response` shape. + * @see {@link CodeDeployClientResolvedConfig | config} for command's `input` shape. + * */ export class GetDeploymentGroupCommand extends $Command< GetDeploymentGroupCommandInput, diff --git a/clients/client-codedeploy/commands/GetDeploymentInstanceCommand.ts b/clients/client-codedeploy/commands/GetDeploymentInstanceCommand.ts index ad49d7e12498..0147059271f1 100644 --- a/clients/client-codedeploy/commands/GetDeploymentInstanceCommand.ts +++ b/clients/client-codedeploy/commands/GetDeploymentInstanceCommand.ts @@ -24,6 +24,20 @@ export interface GetDeploymentInstanceCommandOutput extends GetDeploymentInstanc * @deprecated * *

Gets information about an instance as part of a deployment.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { CodeDeployClient, GetDeploymentInstanceCommand } from "@aws-sdk/client-codedeploy"; // ES Modules import + * // const { CodeDeployClient, GetDeploymentInstanceCommand } = require("@aws-sdk/client-codedeploy"); // CommonJS import + * const client = new CodeDeployClient(config); + * const command = new GetDeploymentInstanceCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetDeploymentInstanceCommandInput} for command's `input` shape. + * @see {@link GetDeploymentInstanceCommandOutput} for command's `response` shape. + * @see {@link CodeDeployClientResolvedConfig | config} for command's `input` shape. + * */ export class GetDeploymentInstanceCommand extends $Command< GetDeploymentInstanceCommandInput, diff --git a/clients/client-codedeploy/commands/GetDeploymentTargetCommand.ts b/clients/client-codedeploy/commands/GetDeploymentTargetCommand.ts index de83076885cd..a26e1521f76e 100644 --- a/clients/client-codedeploy/commands/GetDeploymentTargetCommand.ts +++ b/clients/client-codedeploy/commands/GetDeploymentTargetCommand.ts @@ -22,6 +22,20 @@ export interface GetDeploymentTargetCommandOutput extends GetDeploymentTargetOut /** *

Returns information about a deployment target.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { CodeDeployClient, GetDeploymentTargetCommand } from "@aws-sdk/client-codedeploy"; // ES Modules import + * // const { CodeDeployClient, GetDeploymentTargetCommand } = require("@aws-sdk/client-codedeploy"); // CommonJS import + * const client = new CodeDeployClient(config); + * const command = new GetDeploymentTargetCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetDeploymentTargetCommandInput} for command's `input` shape. + * @see {@link GetDeploymentTargetCommandOutput} for command's `response` shape. + * @see {@link CodeDeployClientResolvedConfig | config} for command's `input` shape. + * */ export class GetDeploymentTargetCommand extends $Command< GetDeploymentTargetCommandInput, diff --git a/clients/client-codedeploy/commands/GetOnPremisesInstanceCommand.ts b/clients/client-codedeploy/commands/GetOnPremisesInstanceCommand.ts index 54ab003830e0..11d49dab72d3 100644 --- a/clients/client-codedeploy/commands/GetOnPremisesInstanceCommand.ts +++ b/clients/client-codedeploy/commands/GetOnPremisesInstanceCommand.ts @@ -22,6 +22,20 @@ export interface GetOnPremisesInstanceCommandOutput extends GetOnPremisesInstanc /** *

Gets information about an on-premises instance.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { CodeDeployClient, GetOnPremisesInstanceCommand } from "@aws-sdk/client-codedeploy"; // ES Modules import + * // const { CodeDeployClient, GetOnPremisesInstanceCommand } = require("@aws-sdk/client-codedeploy"); // CommonJS import + * const client = new CodeDeployClient(config); + * const command = new GetOnPremisesInstanceCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetOnPremisesInstanceCommandInput} for command's `input` shape. + * @see {@link GetOnPremisesInstanceCommandOutput} for command's `response` shape. + * @see {@link CodeDeployClientResolvedConfig | config} for command's `input` shape. + * */ export class GetOnPremisesInstanceCommand extends $Command< GetOnPremisesInstanceCommandInput, diff --git a/clients/client-codedeploy/commands/ListApplicationRevisionsCommand.ts b/clients/client-codedeploy/commands/ListApplicationRevisionsCommand.ts index 54529f7b8e06..4725a61a4e4c 100644 --- a/clients/client-codedeploy/commands/ListApplicationRevisionsCommand.ts +++ b/clients/client-codedeploy/commands/ListApplicationRevisionsCommand.ts @@ -22,6 +22,20 @@ export interface ListApplicationRevisionsCommandOutput extends ListApplicationRe /** *

Lists information about revisions for an application.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { CodeDeployClient, ListApplicationRevisionsCommand } from "@aws-sdk/client-codedeploy"; // ES Modules import + * // const { CodeDeployClient, ListApplicationRevisionsCommand } = require("@aws-sdk/client-codedeploy"); // CommonJS import + * const client = new CodeDeployClient(config); + * const command = new ListApplicationRevisionsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListApplicationRevisionsCommandInput} for command's `input` shape. + * @see {@link ListApplicationRevisionsCommandOutput} for command's `response` shape. + * @see {@link CodeDeployClientResolvedConfig | config} for command's `input` shape. + * */ export class ListApplicationRevisionsCommand extends $Command< ListApplicationRevisionsCommandInput, diff --git a/clients/client-codedeploy/commands/ListApplicationsCommand.ts b/clients/client-codedeploy/commands/ListApplicationsCommand.ts index cefba9b5cdc4..99748e9a7fe8 100644 --- a/clients/client-codedeploy/commands/ListApplicationsCommand.ts +++ b/clients/client-codedeploy/commands/ListApplicationsCommand.ts @@ -22,6 +22,20 @@ export interface ListApplicationsCommandOutput extends ListApplicationsOutput, _ /** *

Lists the applications registered with the IAM user or AWS account.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { CodeDeployClient, ListApplicationsCommand } from "@aws-sdk/client-codedeploy"; // ES Modules import + * // const { CodeDeployClient, ListApplicationsCommand } = require("@aws-sdk/client-codedeploy"); // CommonJS import + * const client = new CodeDeployClient(config); + * const command = new ListApplicationsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListApplicationsCommandInput} for command's `input` shape. + * @see {@link ListApplicationsCommandOutput} for command's `response` shape. + * @see {@link CodeDeployClientResolvedConfig | config} for command's `input` shape. + * */ export class ListApplicationsCommand extends $Command< ListApplicationsCommandInput, diff --git a/clients/client-codedeploy/commands/ListDeploymentConfigsCommand.ts b/clients/client-codedeploy/commands/ListDeploymentConfigsCommand.ts index 3955db27655f..ebe0d50358d5 100644 --- a/clients/client-codedeploy/commands/ListDeploymentConfigsCommand.ts +++ b/clients/client-codedeploy/commands/ListDeploymentConfigsCommand.ts @@ -22,6 +22,20 @@ export interface ListDeploymentConfigsCommandOutput extends ListDeploymentConfig /** *

Lists the deployment configurations with the IAM user or AWS account.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { CodeDeployClient, ListDeploymentConfigsCommand } from "@aws-sdk/client-codedeploy"; // ES Modules import + * // const { CodeDeployClient, ListDeploymentConfigsCommand } = require("@aws-sdk/client-codedeploy"); // CommonJS import + * const client = new CodeDeployClient(config); + * const command = new ListDeploymentConfigsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListDeploymentConfigsCommandInput} for command's `input` shape. + * @see {@link ListDeploymentConfigsCommandOutput} for command's `response` shape. + * @see {@link CodeDeployClientResolvedConfig | config} for command's `input` shape. + * */ export class ListDeploymentConfigsCommand extends $Command< ListDeploymentConfigsCommandInput, diff --git a/clients/client-codedeploy/commands/ListDeploymentGroupsCommand.ts b/clients/client-codedeploy/commands/ListDeploymentGroupsCommand.ts index 04e185a0c89c..59cfc0c8794e 100644 --- a/clients/client-codedeploy/commands/ListDeploymentGroupsCommand.ts +++ b/clients/client-codedeploy/commands/ListDeploymentGroupsCommand.ts @@ -23,6 +23,20 @@ export interface ListDeploymentGroupsCommandOutput extends ListDeploymentGroupsO /** *

Lists the deployment groups for an application registered with the IAM user or AWS * account.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { CodeDeployClient, ListDeploymentGroupsCommand } from "@aws-sdk/client-codedeploy"; // ES Modules import + * // const { CodeDeployClient, ListDeploymentGroupsCommand } = require("@aws-sdk/client-codedeploy"); // CommonJS import + * const client = new CodeDeployClient(config); + * const command = new ListDeploymentGroupsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListDeploymentGroupsCommandInput} for command's `input` shape. + * @see {@link ListDeploymentGroupsCommandOutput} for command's `response` shape. + * @see {@link CodeDeployClientResolvedConfig | config} for command's `input` shape. + * */ export class ListDeploymentGroupsCommand extends $Command< ListDeploymentGroupsCommandInput, diff --git a/clients/client-codedeploy/commands/ListDeploymentInstancesCommand.ts b/clients/client-codedeploy/commands/ListDeploymentInstancesCommand.ts index 29e309812214..25ff08eefa0e 100644 --- a/clients/client-codedeploy/commands/ListDeploymentInstancesCommand.ts +++ b/clients/client-codedeploy/commands/ListDeploymentInstancesCommand.ts @@ -30,6 +30,20 @@ export interface ListDeploymentInstancesCommandOutput extends ListDeploymentInst * Lambda.

* *

Lists the instance for a deployment associated with the IAM user or AWS account.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { CodeDeployClient, ListDeploymentInstancesCommand } from "@aws-sdk/client-codedeploy"; // ES Modules import + * // const { CodeDeployClient, ListDeploymentInstancesCommand } = require("@aws-sdk/client-codedeploy"); // CommonJS import + * const client = new CodeDeployClient(config); + * const command = new ListDeploymentInstancesCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListDeploymentInstancesCommandInput} for command's `input` shape. + * @see {@link ListDeploymentInstancesCommandOutput} for command's `response` shape. + * @see {@link CodeDeployClientResolvedConfig | config} for command's `input` shape. + * */ export class ListDeploymentInstancesCommand extends $Command< ListDeploymentInstancesCommandInput, diff --git a/clients/client-codedeploy/commands/ListDeploymentTargetsCommand.ts b/clients/client-codedeploy/commands/ListDeploymentTargetsCommand.ts index caf75fe7ba49..e7ff38091d48 100644 --- a/clients/client-codedeploy/commands/ListDeploymentTargetsCommand.ts +++ b/clients/client-codedeploy/commands/ListDeploymentTargetsCommand.ts @@ -22,6 +22,20 @@ export interface ListDeploymentTargetsCommandOutput extends ListDeploymentTarget /** *

Returns an array of target IDs that are associated a deployment.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { CodeDeployClient, ListDeploymentTargetsCommand } from "@aws-sdk/client-codedeploy"; // ES Modules import + * // const { CodeDeployClient, ListDeploymentTargetsCommand } = require("@aws-sdk/client-codedeploy"); // CommonJS import + * const client = new CodeDeployClient(config); + * const command = new ListDeploymentTargetsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListDeploymentTargetsCommandInput} for command's `input` shape. + * @see {@link ListDeploymentTargetsCommandOutput} for command's `response` shape. + * @see {@link CodeDeployClientResolvedConfig | config} for command's `input` shape. + * */ export class ListDeploymentTargetsCommand extends $Command< ListDeploymentTargetsCommandInput, diff --git a/clients/client-codedeploy/commands/ListDeploymentsCommand.ts b/clients/client-codedeploy/commands/ListDeploymentsCommand.ts index 21856fd7b985..f50fe06dd324 100644 --- a/clients/client-codedeploy/commands/ListDeploymentsCommand.ts +++ b/clients/client-codedeploy/commands/ListDeploymentsCommand.ts @@ -23,6 +23,20 @@ export interface ListDeploymentsCommandOutput extends ListDeploymentsOutput, __M /** *

Lists the deployments in a deployment group for an application registered with the IAM * user or AWS account.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { CodeDeployClient, ListDeploymentsCommand } from "@aws-sdk/client-codedeploy"; // ES Modules import + * // const { CodeDeployClient, ListDeploymentsCommand } = require("@aws-sdk/client-codedeploy"); // CommonJS import + * const client = new CodeDeployClient(config); + * const command = new ListDeploymentsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListDeploymentsCommandInput} for command's `input` shape. + * @see {@link ListDeploymentsCommandOutput} for command's `response` shape. + * @see {@link CodeDeployClientResolvedConfig | config} for command's `input` shape. + * */ export class ListDeploymentsCommand extends $Command< ListDeploymentsCommandInput, diff --git a/clients/client-codedeploy/commands/ListGitHubAccountTokenNamesCommand.ts b/clients/client-codedeploy/commands/ListGitHubAccountTokenNamesCommand.ts index 774bb6a1c129..876d41f4a78d 100644 --- a/clients/client-codedeploy/commands/ListGitHubAccountTokenNamesCommand.ts +++ b/clients/client-codedeploy/commands/ListGitHubAccountTokenNamesCommand.ts @@ -22,6 +22,20 @@ export interface ListGitHubAccountTokenNamesCommandOutput extends ListGitHubAcco /** *

Lists the names of stored connections to GitHub accounts.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { CodeDeployClient, ListGitHubAccountTokenNamesCommand } from "@aws-sdk/client-codedeploy"; // ES Modules import + * // const { CodeDeployClient, ListGitHubAccountTokenNamesCommand } = require("@aws-sdk/client-codedeploy"); // CommonJS import + * const client = new CodeDeployClient(config); + * const command = new ListGitHubAccountTokenNamesCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListGitHubAccountTokenNamesCommandInput} for command's `input` shape. + * @see {@link ListGitHubAccountTokenNamesCommandOutput} for command's `response` shape. + * @see {@link CodeDeployClientResolvedConfig | config} for command's `input` shape. + * */ export class ListGitHubAccountTokenNamesCommand extends $Command< ListGitHubAccountTokenNamesCommandInput, diff --git a/clients/client-codedeploy/commands/ListOnPremisesInstancesCommand.ts b/clients/client-codedeploy/commands/ListOnPremisesInstancesCommand.ts index 757eeb0aa23f..689c74b6c262 100644 --- a/clients/client-codedeploy/commands/ListOnPremisesInstancesCommand.ts +++ b/clients/client-codedeploy/commands/ListOnPremisesInstancesCommand.ts @@ -25,6 +25,20 @@ export interface ListOnPremisesInstancesCommandOutput extends ListOnPremisesInst *

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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { CodeDeployClient, ListOnPremisesInstancesCommand } from "@aws-sdk/client-codedeploy"; // ES Modules import + * // const { CodeDeployClient, ListOnPremisesInstancesCommand } = require("@aws-sdk/client-codedeploy"); // CommonJS import + * const client = new CodeDeployClient(config); + * const command = new ListOnPremisesInstancesCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListOnPremisesInstancesCommandInput} for command's `input` shape. + * @see {@link ListOnPremisesInstancesCommandOutput} for command's `response` shape. + * @see {@link CodeDeployClientResolvedConfig | config} for command's `input` shape. + * */ export class ListOnPremisesInstancesCommand extends $Command< ListOnPremisesInstancesCommandInput, diff --git a/clients/client-codedeploy/commands/ListTagsForResourceCommand.ts b/clients/client-codedeploy/commands/ListTagsForResourceCommand.ts index bc79e30ccfd0..d19a5ed08de1 100644 --- a/clients/client-codedeploy/commands/ListTagsForResourceCommand.ts +++ b/clients/client-codedeploy/commands/ListTagsForResourceCommand.ts @@ -23,6 +23,20 @@ export interface ListTagsForResourceCommandOutput extends ListTagsForResourceOut /** *

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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { CodeDeployClient, ListTagsForResourceCommand } from "@aws-sdk/client-codedeploy"; // ES Modules import + * // const { CodeDeployClient, ListTagsForResourceCommand } = require("@aws-sdk/client-codedeploy"); // CommonJS import + * const client = new CodeDeployClient(config); + * const command = new ListTagsForResourceCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListTagsForResourceCommandInput} for command's `input` shape. + * @see {@link ListTagsForResourceCommandOutput} for command's `response` shape. + * @see {@link CodeDeployClientResolvedConfig | config} for command's `input` shape. + * */ export class ListTagsForResourceCommand extends $Command< ListTagsForResourceCommandInput, diff --git a/clients/client-codedeploy/commands/PutLifecycleEventHookExecutionStatusCommand.ts b/clients/client-codedeploy/commands/PutLifecycleEventHookExecutionStatusCommand.ts index c2af2afdab6a..b12e5f4086f8 100644 --- a/clients/client-codedeploy/commands/PutLifecycleEventHookExecutionStatusCommand.ts +++ b/clients/client-codedeploy/commands/PutLifecycleEventHookExecutionStatusCommand.ts @@ -35,6 +35,20 @@ export interface PutLifecycleEventHookExecutionStatusCommandOutput * BeforeAllowTraffic, and AfterAllowTraffic. Lambda * validation functions return Succeeded or Failed. For more * information, see AppSpec 'hooks' Section for an AWS Lambda Deployment and AppSpec 'hooks' Section for an Amazon ECS Deployment.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { CodeDeployClient, PutLifecycleEventHookExecutionStatusCommand } from "@aws-sdk/client-codedeploy"; // ES Modules import + * // const { CodeDeployClient, PutLifecycleEventHookExecutionStatusCommand } = require("@aws-sdk/client-codedeploy"); // CommonJS import + * const client = new CodeDeployClient(config); + * const command = new PutLifecycleEventHookExecutionStatusCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link PutLifecycleEventHookExecutionStatusCommandInput} for command's `input` shape. + * @see {@link PutLifecycleEventHookExecutionStatusCommandOutput} for command's `response` shape. + * @see {@link CodeDeployClientResolvedConfig | config} for command's `input` shape. + * */ export class PutLifecycleEventHookExecutionStatusCommand extends $Command< PutLifecycleEventHookExecutionStatusCommandInput, diff --git a/clients/client-codedeploy/commands/RegisterApplicationRevisionCommand.ts b/clients/client-codedeploy/commands/RegisterApplicationRevisionCommand.ts index 7e0e62897ea6..ce044d744e35 100644 --- a/clients/client-codedeploy/commands/RegisterApplicationRevisionCommand.ts +++ b/clients/client-codedeploy/commands/RegisterApplicationRevisionCommand.ts @@ -22,6 +22,20 @@ export interface RegisterApplicationRevisionCommandOutput extends __MetadataBear /** *

Registers with AWS CodeDeploy a revision for the specified application.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { CodeDeployClient, RegisterApplicationRevisionCommand } from "@aws-sdk/client-codedeploy"; // ES Modules import + * // const { CodeDeployClient, RegisterApplicationRevisionCommand } = require("@aws-sdk/client-codedeploy"); // CommonJS import + * const client = new CodeDeployClient(config); + * const command = new RegisterApplicationRevisionCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link RegisterApplicationRevisionCommandInput} for command's `input` shape. + * @see {@link RegisterApplicationRevisionCommandOutput} for command's `response` shape. + * @see {@link CodeDeployClientResolvedConfig | config} for command's `input` shape. + * */ export class RegisterApplicationRevisionCommand extends $Command< RegisterApplicationRevisionCommandInput, diff --git a/clients/client-codedeploy/commands/RegisterOnPremisesInstanceCommand.ts b/clients/client-codedeploy/commands/RegisterOnPremisesInstanceCommand.ts index 09ae85cf2786..6ab04fce874d 100644 --- a/clients/client-codedeploy/commands/RegisterOnPremisesInstanceCommand.ts +++ b/clients/client-codedeploy/commands/RegisterOnPremisesInstanceCommand.ts @@ -26,6 +26,20 @@ export interface RegisterOnPremisesInstanceCommandOutput extends __MetadataBeare *

Only one IAM ARN (an IAM session ARN or IAM user ARN) is supported in the request. * You cannot use both.

* + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { CodeDeployClient, RegisterOnPremisesInstanceCommand } from "@aws-sdk/client-codedeploy"; // ES Modules import + * // const { CodeDeployClient, RegisterOnPremisesInstanceCommand } = require("@aws-sdk/client-codedeploy"); // CommonJS import + * const client = new CodeDeployClient(config); + * const command = new RegisterOnPremisesInstanceCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link RegisterOnPremisesInstanceCommandInput} for command's `input` shape. + * @see {@link RegisterOnPremisesInstanceCommandOutput} for command's `response` shape. + * @see {@link CodeDeployClientResolvedConfig | config} for command's `input` shape. + * */ export class RegisterOnPremisesInstanceCommand extends $Command< RegisterOnPremisesInstanceCommandInput, diff --git a/clients/client-codedeploy/commands/RemoveTagsFromOnPremisesInstancesCommand.ts b/clients/client-codedeploy/commands/RemoveTagsFromOnPremisesInstancesCommand.ts index 892ed00011b3..96d9f84e8454 100644 --- a/clients/client-codedeploy/commands/RemoveTagsFromOnPremisesInstancesCommand.ts +++ b/clients/client-codedeploy/commands/RemoveTagsFromOnPremisesInstancesCommand.ts @@ -22,6 +22,20 @@ export interface RemoveTagsFromOnPremisesInstancesCommandOutput extends __Metada /** *

Removes one or more tags from one or more on-premises instances.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { CodeDeployClient, RemoveTagsFromOnPremisesInstancesCommand } from "@aws-sdk/client-codedeploy"; // ES Modules import + * // const { CodeDeployClient, RemoveTagsFromOnPremisesInstancesCommand } = require("@aws-sdk/client-codedeploy"); // CommonJS import + * const client = new CodeDeployClient(config); + * const command = new RemoveTagsFromOnPremisesInstancesCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link RemoveTagsFromOnPremisesInstancesCommandInput} for command's `input` shape. + * @see {@link RemoveTagsFromOnPremisesInstancesCommandOutput} for command's `response` shape. + * @see {@link CodeDeployClientResolvedConfig | config} for command's `input` shape. + * */ export class RemoveTagsFromOnPremisesInstancesCommand extends $Command< RemoveTagsFromOnPremisesInstancesCommandInput, diff --git a/clients/client-codedeploy/commands/SkipWaitTimeForInstanceTerminationCommand.ts b/clients/client-codedeploy/commands/SkipWaitTimeForInstanceTerminationCommand.ts index 3ab32b79a72a..a2c1bb3179fc 100644 --- a/clients/client-codedeploy/commands/SkipWaitTimeForInstanceTerminationCommand.ts +++ b/clients/client-codedeploy/commands/SkipWaitTimeForInstanceTerminationCommand.ts @@ -25,6 +25,20 @@ export interface SkipWaitTimeForInstanceTerminationCommandOutput extends __Metad * *

In a blue/green deployment, overrides any specified wait time and starts terminating * instances immediately after the traffic routing is complete.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { CodeDeployClient, SkipWaitTimeForInstanceTerminationCommand } from "@aws-sdk/client-codedeploy"; // ES Modules import + * // const { CodeDeployClient, SkipWaitTimeForInstanceTerminationCommand } = require("@aws-sdk/client-codedeploy"); // CommonJS import + * const client = new CodeDeployClient(config); + * const command = new SkipWaitTimeForInstanceTerminationCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link SkipWaitTimeForInstanceTerminationCommandInput} for command's `input` shape. + * @see {@link SkipWaitTimeForInstanceTerminationCommandOutput} for command's `response` shape. + * @see {@link CodeDeployClientResolvedConfig | config} for command's `input` shape. + * */ export class SkipWaitTimeForInstanceTerminationCommand extends $Command< SkipWaitTimeForInstanceTerminationCommandInput, diff --git a/clients/client-codedeploy/commands/StopDeploymentCommand.ts b/clients/client-codedeploy/commands/StopDeploymentCommand.ts index 81a5ac018f21..08fbbfb2d5f1 100644 --- a/clients/client-codedeploy/commands/StopDeploymentCommand.ts +++ b/clients/client-codedeploy/commands/StopDeploymentCommand.ts @@ -22,6 +22,20 @@ export interface StopDeploymentCommandOutput extends StopDeploymentOutput, __Met /** *

Attempts to stop an ongoing deployment.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { CodeDeployClient, StopDeploymentCommand } from "@aws-sdk/client-codedeploy"; // ES Modules import + * // const { CodeDeployClient, StopDeploymentCommand } = require("@aws-sdk/client-codedeploy"); // CommonJS import + * const client = new CodeDeployClient(config); + * const command = new StopDeploymentCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link StopDeploymentCommandInput} for command's `input` shape. + * @see {@link StopDeploymentCommandOutput} for command's `response` shape. + * @see {@link CodeDeployClientResolvedConfig | config} for command's `input` shape. + * */ export class StopDeploymentCommand extends $Command< StopDeploymentCommandInput, diff --git a/clients/client-codedeploy/commands/TagResourceCommand.ts b/clients/client-codedeploy/commands/TagResourceCommand.ts index a48df606530e..0cbe949e7932 100644 --- a/clients/client-codedeploy/commands/TagResourceCommand.ts +++ b/clients/client-codedeploy/commands/TagResourceCommand.ts @@ -23,6 +23,20 @@ export interface TagResourceCommandOutput extends TagResourceOutput, __MetadataB /** *

Associates the list of tags in the input Tags parameter with the * resource identified by the ResourceArn input parameter.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { CodeDeployClient, TagResourceCommand } from "@aws-sdk/client-codedeploy"; // ES Modules import + * // const { CodeDeployClient, TagResourceCommand } = require("@aws-sdk/client-codedeploy"); // CommonJS import + * const client = new CodeDeployClient(config); + * const command = new TagResourceCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link TagResourceCommandInput} for command's `input` shape. + * @see {@link TagResourceCommandOutput} for command's `response` shape. + * @see {@link CodeDeployClientResolvedConfig | config} for command's `input` shape. + * */ export class TagResourceCommand extends $Command< TagResourceCommandInput, diff --git a/clients/client-codedeploy/commands/UntagResourceCommand.ts b/clients/client-codedeploy/commands/UntagResourceCommand.ts index 04e79010a772..81b2bb3c1be9 100644 --- a/clients/client-codedeploy/commands/UntagResourceCommand.ts +++ b/clients/client-codedeploy/commands/UntagResourceCommand.ts @@ -24,6 +24,20 @@ export interface UntagResourceCommandOutput extends UntagResourceOutput, __Metad *

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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { CodeDeployClient, UntagResourceCommand } from "@aws-sdk/client-codedeploy"; // ES Modules import + * // const { CodeDeployClient, UntagResourceCommand } = require("@aws-sdk/client-codedeploy"); // CommonJS import + * const client = new CodeDeployClient(config); + * const command = new UntagResourceCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link UntagResourceCommandInput} for command's `input` shape. + * @see {@link UntagResourceCommandOutput} for command's `response` shape. + * @see {@link CodeDeployClientResolvedConfig | config} for command's `input` shape. + * */ export class UntagResourceCommand extends $Command< UntagResourceCommandInput, diff --git a/clients/client-codedeploy/commands/UpdateApplicationCommand.ts b/clients/client-codedeploy/commands/UpdateApplicationCommand.ts index 862dcfafdb89..2e523c4b9390 100644 --- a/clients/client-codedeploy/commands/UpdateApplicationCommand.ts +++ b/clients/client-codedeploy/commands/UpdateApplicationCommand.ts @@ -22,6 +22,20 @@ export interface UpdateApplicationCommandOutput extends __MetadataBearer {} /** *

Changes the name of an application.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { CodeDeployClient, UpdateApplicationCommand } from "@aws-sdk/client-codedeploy"; // ES Modules import + * // const { CodeDeployClient, UpdateApplicationCommand } = require("@aws-sdk/client-codedeploy"); // CommonJS import + * const client = new CodeDeployClient(config); + * const command = new UpdateApplicationCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link UpdateApplicationCommandInput} for command's `input` shape. + * @see {@link UpdateApplicationCommandOutput} for command's `response` shape. + * @see {@link CodeDeployClientResolvedConfig | config} for command's `input` shape. + * */ export class UpdateApplicationCommand extends $Command< UpdateApplicationCommandInput, diff --git a/clients/client-codedeploy/commands/UpdateDeploymentGroupCommand.ts b/clients/client-codedeploy/commands/UpdateDeploymentGroupCommand.ts index 27903192ba6a..42ddd9f12294 100644 --- a/clients/client-codedeploy/commands/UpdateDeploymentGroupCommand.ts +++ b/clients/client-codedeploy/commands/UpdateDeploymentGroupCommand.ts @@ -22,6 +22,20 @@ export interface UpdateDeploymentGroupCommandOutput extends UpdateDeploymentGrou /** *

Changes information about a deployment group.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { CodeDeployClient, UpdateDeploymentGroupCommand } from "@aws-sdk/client-codedeploy"; // ES Modules import + * // const { CodeDeployClient, UpdateDeploymentGroupCommand } = require("@aws-sdk/client-codedeploy"); // CommonJS import + * const client = new CodeDeployClient(config); + * const command = new UpdateDeploymentGroupCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link UpdateDeploymentGroupCommandInput} for command's `input` shape. + * @see {@link UpdateDeploymentGroupCommandOutput} for command's `response` shape. + * @see {@link CodeDeployClientResolvedConfig | config} for command's `input` shape. + * */ export class UpdateDeploymentGroupCommand extends $Command< UpdateDeploymentGroupCommandInput, diff --git a/clients/client-codedeploy/models/models_0.ts b/clients/client-codedeploy/models/models_0.ts index 7eabb4c14df0..03edd946b4f3 100644 --- a/clients/client-codedeploy/models/models_0.ts +++ b/clients/client-codedeploy/models/models_0.ts @@ -17,6 +17,9 @@ export interface Tag { } export namespace Tag { + /** + * @internal + */ export const filterSensitiveLog = (obj: Tag): any => ({ ...obj, }); @@ -40,6 +43,9 @@ export interface AddTagsToOnPremisesInstancesInput { } export namespace AddTagsToOnPremisesInstancesInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: AddTagsToOnPremisesInstancesInput): any => ({ ...obj, }); @@ -59,6 +65,9 @@ export interface InstanceLimitExceededException extends __SmithyException, $Meta } export namespace InstanceLimitExceededException { + /** + * @internal + */ export const filterSensitiveLog = (obj: InstanceLimitExceededException): any => ({ ...obj, }); @@ -77,6 +86,9 @@ export interface InstanceNameRequiredException extends __SmithyException, $Metad } export namespace InstanceNameRequiredException { + /** + * @internal + */ export const filterSensitiveLog = (obj: InstanceNameRequiredException): any => ({ ...obj, }); @@ -95,6 +107,9 @@ export interface InstanceNotRegisteredException extends __SmithyException, $Meta } export namespace InstanceNotRegisteredException { + /** + * @internal + */ export const filterSensitiveLog = (obj: InstanceNotRegisteredException): any => ({ ...obj, }); @@ -113,6 +128,9 @@ export interface InvalidInstanceNameException extends __SmithyException, $Metada } export namespace InvalidInstanceNameException { + /** + * @internal + */ export const filterSensitiveLog = (obj: InvalidInstanceNameException): any => ({ ...obj, }); @@ -131,6 +149,9 @@ export interface InvalidTagException extends __SmithyException, $MetadataBearer } export namespace InvalidTagException { + /** + * @internal + */ export const filterSensitiveLog = (obj: InvalidTagException): any => ({ ...obj, }); @@ -149,6 +170,9 @@ export interface TagLimitExceededException extends __SmithyException, $MetadataB } export namespace TagLimitExceededException { + /** + * @internal + */ export const filterSensitiveLog = (obj: TagLimitExceededException): any => ({ ...obj, }); @@ -167,6 +191,9 @@ export interface TagRequiredException extends __SmithyException, $MetadataBearer } export namespace TagRequiredException { + /** + * @internal + */ export const filterSensitiveLog = (obj: TagRequiredException): any => ({ ...obj, }); @@ -184,6 +211,9 @@ export interface Alarm { } export namespace Alarm { + /** + * @internal + */ export const filterSensitiveLog = (obj: Alarm): any => ({ ...obj, }); @@ -224,6 +254,9 @@ export interface AlarmConfiguration { } export namespace AlarmConfiguration { + /** + * @internal + */ export const filterSensitiveLog = (obj: AlarmConfiguration): any => ({ ...obj, }); @@ -242,6 +275,9 @@ export interface AlarmsLimitExceededException extends __SmithyException, $Metada } export namespace AlarmsLimitExceededException { + /** + * @internal + */ export const filterSensitiveLog = (obj: AlarmsLimitExceededException): any => ({ ...obj, }); @@ -261,6 +297,9 @@ export interface ApplicationAlreadyExistsException extends __SmithyException, $M } export namespace ApplicationAlreadyExistsException { + /** + * @internal + */ export const filterSensitiveLog = (obj: ApplicationAlreadyExistsException): any => ({ ...obj, }); @@ -279,6 +318,9 @@ export interface ApplicationDoesNotExistException extends __SmithyException, $Me } export namespace ApplicationDoesNotExistException { + /** + * @internal + */ export const filterSensitiveLog = (obj: ApplicationDoesNotExistException): any => ({ ...obj, }); @@ -328,6 +370,9 @@ export interface ApplicationInfo { } export namespace ApplicationInfo { + /** + * @internal + */ export const filterSensitiveLog = (obj: ApplicationInfo): any => ({ ...obj, }); @@ -346,6 +391,9 @@ export interface ApplicationLimitExceededException extends __SmithyException, $M } export namespace ApplicationLimitExceededException { + /** + * @internal + */ export const filterSensitiveLog = (obj: ApplicationLimitExceededException): any => ({ ...obj, }); @@ -364,6 +412,9 @@ export interface ApplicationNameRequiredException extends __SmithyException, $Me } export namespace ApplicationNameRequiredException { + /** + * @internal + */ export const filterSensitiveLog = (obj: ApplicationNameRequiredException): any => ({ ...obj, }); @@ -402,6 +453,9 @@ export interface AppSpecContent { } export namespace AppSpecContent { + /** + * @internal + */ export const filterSensitiveLog = (obj: AppSpecContent): any => ({ ...obj, }); @@ -421,6 +475,9 @@ export interface ArnNotSupportedException extends __SmithyException, $MetadataBe } export namespace ArnNotSupportedException { + /** + * @internal + */ export const filterSensitiveLog = (obj: ArnNotSupportedException): any => ({ ...obj, }); @@ -450,6 +507,9 @@ export interface AutoRollbackConfiguration { } export namespace AutoRollbackConfiguration { + /** + * @internal + */ export const filterSensitiveLog = (obj: AutoRollbackConfiguration): any => ({ ...obj, }); @@ -471,6 +531,9 @@ export interface AutoScalingGroup { } export namespace AutoScalingGroup { + /** + * @internal + */ export const filterSensitiveLog = (obj: AutoScalingGroup): any => ({ ...obj, }); @@ -495,6 +558,9 @@ export interface GitHubLocation { } export namespace GitHubLocation { + /** + * @internal + */ export const filterSensitiveLog = (obj: GitHubLocation): any => ({ ...obj, }); @@ -567,6 +633,9 @@ export interface S3Location { } export namespace S3Location { + /** + * @internal + */ export const filterSensitiveLog = (obj: S3Location): any => ({ ...obj, }); @@ -593,6 +662,9 @@ export interface RawString { } export namespace RawString { + /** + * @internal + */ export const filterSensitiveLog = (obj: RawString): any => ({ ...obj, }); @@ -651,6 +723,9 @@ export interface RevisionLocation { } export namespace RevisionLocation { + /** + * @internal + */ export const filterSensitiveLog = (obj: RevisionLocation): any => ({ ...obj, }); @@ -675,6 +750,9 @@ export interface BatchGetApplicationRevisionsInput { } export namespace BatchGetApplicationRevisionsInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: BatchGetApplicationRevisionsInput): any => ({ ...obj, }); @@ -711,6 +789,9 @@ export interface GenericRevisionInfo { } export namespace GenericRevisionInfo { + /** + * @internal + */ export const filterSensitiveLog = (obj: GenericRevisionInfo): any => ({ ...obj, }); @@ -733,6 +814,9 @@ export interface RevisionInfo { } export namespace RevisionInfo { + /** + * @internal + */ export const filterSensitiveLog = (obj: RevisionInfo): any => ({ ...obj, }); @@ -759,6 +843,9 @@ export interface BatchGetApplicationRevisionsOutput { } export namespace BatchGetApplicationRevisionsOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: BatchGetApplicationRevisionsOutput): any => ({ ...obj, }); @@ -777,6 +864,9 @@ export interface BatchLimitExceededException extends __SmithyException, $Metadat } export namespace BatchLimitExceededException { + /** + * @internal + */ export const filterSensitiveLog = (obj: BatchLimitExceededException): any => ({ ...obj, }); @@ -795,6 +885,9 @@ export interface InvalidApplicationNameException extends __SmithyException, $Met } export namespace InvalidApplicationNameException { + /** + * @internal + */ export const filterSensitiveLog = (obj: InvalidApplicationNameException): any => ({ ...obj, }); @@ -813,6 +906,9 @@ export interface InvalidRevisionException extends __SmithyException, $MetadataBe } export namespace InvalidRevisionException { + /** + * @internal + */ export const filterSensitiveLog = (obj: InvalidRevisionException): any => ({ ...obj, }); @@ -831,6 +927,9 @@ export interface RevisionRequiredException extends __SmithyException, $MetadataB } export namespace RevisionRequiredException { + /** + * @internal + */ export const filterSensitiveLog = (obj: RevisionRequiredException): any => ({ ...obj, }); @@ -848,6 +947,9 @@ export interface BatchGetApplicationsInput { } export namespace BatchGetApplicationsInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: BatchGetApplicationsInput): any => ({ ...obj, }); @@ -864,6 +966,9 @@ export interface BatchGetApplicationsOutput { } export namespace BatchGetApplicationsOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: BatchGetApplicationsOutput): any => ({ ...obj, }); @@ -886,6 +991,9 @@ export interface BatchGetDeploymentGroupsInput { } export namespace BatchGetDeploymentGroupsInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: BatchGetDeploymentGroupsInput): any => ({ ...obj, }); @@ -929,6 +1037,9 @@ export interface DeploymentReadyOption { } export namespace DeploymentReadyOption { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeploymentReadyOption): any => ({ ...obj, }); @@ -963,6 +1074,9 @@ export interface GreenFleetProvisioningOption { } export namespace GreenFleetProvisioningOption { + /** + * @internal + */ export const filterSensitiveLog = (obj: GreenFleetProvisioningOption): any => ({ ...obj, }); @@ -1012,6 +1126,9 @@ export interface BlueInstanceTerminationOption { } export namespace BlueInstanceTerminationOption { + /** + * @internal + */ export const filterSensitiveLog = (obj: BlueInstanceTerminationOption): any => ({ ...obj, }); @@ -1041,6 +1158,9 @@ export interface BlueGreenDeploymentConfiguration { } export namespace BlueGreenDeploymentConfiguration { + /** + * @internal + */ export const filterSensitiveLog = (obj: BlueGreenDeploymentConfiguration): any => ({ ...obj, }); @@ -1073,6 +1193,9 @@ export interface DeploymentStyle { } export namespace DeploymentStyle { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeploymentStyle): any => ({ ...obj, }); @@ -1119,6 +1242,9 @@ export interface EC2TagFilter { } export namespace EC2TagFilter { + /** + * @internal + */ export const filterSensitiveLog = (obj: EC2TagFilter): any => ({ ...obj, }); @@ -1137,6 +1263,9 @@ export interface EC2TagSet { } export namespace EC2TagSet { + /** + * @internal + */ export const filterSensitiveLog = (obj: EC2TagSet): any => ({ ...obj, }); @@ -1159,6 +1288,9 @@ export interface ECSService { } export namespace ECSService { + /** + * @internal + */ export const filterSensitiveLog = (obj: ECSService): any => ({ ...obj, }); @@ -1204,6 +1336,9 @@ export interface LastDeploymentInfo { } export namespace LastDeploymentInfo { + /** + * @internal + */ export const filterSensitiveLog = (obj: LastDeploymentInfo): any => ({ ...obj, }); @@ -1226,6 +1361,9 @@ export interface ELBInfo { } export namespace ELBInfo { + /** + * @internal + */ export const filterSensitiveLog = (obj: ELBInfo): any => ({ ...obj, }); @@ -1248,6 +1386,9 @@ export interface TargetGroupInfo { } export namespace TargetGroupInfo { + /** + * @internal + */ export const filterSensitiveLog = (obj: TargetGroupInfo): any => ({ ...obj, }); @@ -1267,6 +1408,9 @@ export interface TrafficRoute { } export namespace TrafficRoute { + /** + * @internal + */ export const filterSensitiveLog = (obj: TrafficRoute): any => ({ ...obj, }); @@ -1299,6 +1443,9 @@ export interface TargetGroupPairInfo { } export namespace TargetGroupPairInfo { + /** + * @internal + */ export const filterSensitiveLog = (obj: TargetGroupPairInfo): any => ({ ...obj, }); @@ -1337,6 +1484,9 @@ export interface LoadBalancerInfo { } export namespace LoadBalancerInfo { + /** + * @internal + */ export const filterSensitiveLog = (obj: LoadBalancerInfo): any => ({ ...obj, }); @@ -1380,6 +1530,9 @@ export interface TagFilter { } export namespace TagFilter { + /** + * @internal + */ export const filterSensitiveLog = (obj: TagFilter): any => ({ ...obj, }); @@ -1398,6 +1551,9 @@ export interface OnPremisesTagSet { } export namespace OnPremisesTagSet { + /** + * @internal + */ export const filterSensitiveLog = (obj: OnPremisesTagSet): any => ({ ...obj, }); @@ -1443,6 +1599,9 @@ export interface TriggerConfig { } export namespace TriggerConfig { + /** + * @internal + */ export const filterSensitiveLog = (obj: TriggerConfig): any => ({ ...obj, }); @@ -1588,6 +1747,9 @@ export interface DeploymentGroupInfo { } export namespace DeploymentGroupInfo { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeploymentGroupInfo): any => ({ ...obj, }); @@ -1609,6 +1771,9 @@ export interface BatchGetDeploymentGroupsOutput { } export namespace BatchGetDeploymentGroupsOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: BatchGetDeploymentGroupsOutput): any => ({ ...obj, }); @@ -1627,6 +1792,9 @@ export interface DeploymentConfigDoesNotExistException extends __SmithyException } export namespace DeploymentConfigDoesNotExistException { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeploymentConfigDoesNotExistException): any => ({ ...obj, }); @@ -1645,6 +1813,9 @@ export interface DeploymentGroupNameRequiredException extends __SmithyException, } export namespace DeploymentGroupNameRequiredException { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeploymentGroupNameRequiredException): any => ({ ...obj, }); @@ -1663,6 +1834,9 @@ export interface InvalidDeploymentGroupNameException extends __SmithyException, } export namespace InvalidDeploymentGroupNameException { + /** + * @internal + */ export const filterSensitiveLog = (obj: InvalidDeploymentGroupNameException): any => ({ ...obj, }); @@ -1685,6 +1859,9 @@ export interface BatchGetDeploymentInstancesInput { } export namespace BatchGetDeploymentInstancesInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: BatchGetDeploymentInstancesInput): any => ({ ...obj, }); @@ -1754,6 +1931,9 @@ export interface Diagnostics { } export namespace Diagnostics { + /** + * @internal + */ export const filterSensitiveLog = (obj: Diagnostics): any => ({ ...obj, }); @@ -1821,6 +2001,9 @@ export interface LifecycleEvent { } export namespace LifecycleEvent { + /** + * @internal + */ export const filterSensitiveLog = (obj: LifecycleEvent): any => ({ ...obj, }); @@ -1914,6 +2097,9 @@ export interface InstanceSummary { } export namespace InstanceSummary { + /** + * @internal + */ export const filterSensitiveLog = (obj: InstanceSummary): any => ({ ...obj, }); @@ -1935,6 +2121,9 @@ export interface BatchGetDeploymentInstancesOutput { } export namespace BatchGetDeploymentInstancesOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: BatchGetDeploymentInstancesOutput): any => ({ ...obj, }); @@ -1953,6 +2142,9 @@ export interface DeploymentDoesNotExistException extends __SmithyException, $Met } export namespace DeploymentDoesNotExistException { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeploymentDoesNotExistException): any => ({ ...obj, }); @@ -1971,6 +2163,9 @@ export interface DeploymentIdRequiredException extends __SmithyException, $Metad } export namespace DeploymentIdRequiredException { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeploymentIdRequiredException): any => ({ ...obj, }); @@ -1991,6 +2186,9 @@ export interface InstanceIdRequiredException extends __SmithyException, $Metadat } export namespace InstanceIdRequiredException { + /** + * @internal + */ export const filterSensitiveLog = (obj: InstanceIdRequiredException): any => ({ ...obj, }); @@ -2010,6 +2208,9 @@ export interface InvalidComputePlatformException extends __SmithyException, $Met } export namespace InvalidComputePlatformException { + /** + * @internal + */ export const filterSensitiveLog = (obj: InvalidComputePlatformException): any => ({ ...obj, }); @@ -2028,6 +2229,9 @@ export interface InvalidDeploymentIdException extends __SmithyException, $Metada } export namespace InvalidDeploymentIdException { + /** + * @internal + */ export const filterSensitiveLog = (obj: InvalidDeploymentIdException): any => ({ ...obj, }); @@ -2045,6 +2249,9 @@ export interface BatchGetDeploymentsInput { } export namespace BatchGetDeploymentsInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: BatchGetDeploymentsInput): any => ({ ...obj, }); @@ -2098,6 +2305,9 @@ export interface DeploymentOverview { } export namespace DeploymentOverview { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeploymentOverview): any => ({ ...obj, }); @@ -2211,6 +2421,9 @@ export interface ErrorInformation { } export namespace ErrorInformation { + /** + * @internal + */ export const filterSensitiveLog = (obj: ErrorInformation): any => ({ ...obj, }); @@ -2239,6 +2452,9 @@ export interface RelatedDeployments { } export namespace RelatedDeployments { + /** + * @internal + */ export const filterSensitiveLog = (obj: RelatedDeployments): any => ({ ...obj, }); @@ -2267,6 +2483,9 @@ export interface RollbackInfo { } export namespace RollbackInfo { + /** + * @internal + */ export const filterSensitiveLog = (obj: RollbackInfo): any => ({ ...obj, }); @@ -2299,6 +2518,9 @@ export interface TargetInstances { } export namespace TargetInstances { + /** + * @internal + */ export const filterSensitiveLog = (obj: TargetInstances): any => ({ ...obj, }); @@ -2535,6 +2757,9 @@ export interface DeploymentInfo { } export namespace DeploymentInfo { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeploymentInfo): any => ({ ...obj, }); @@ -2551,6 +2776,9 @@ export interface BatchGetDeploymentsOutput { } export namespace BatchGetDeploymentsOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: BatchGetDeploymentsOutput): any => ({ ...obj, }); @@ -2594,6 +2822,9 @@ export interface BatchGetDeploymentTargetsInput { } export namespace BatchGetDeploymentTargetsInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: BatchGetDeploymentTargetsInput): any => ({ ...obj, }); @@ -2657,6 +2888,9 @@ export interface CloudFormationTarget { } export namespace CloudFormationTarget { + /** + * @internal + */ export const filterSensitiveLog = (obj: CloudFormationTarget): any => ({ ...obj, }); @@ -2753,6 +2987,9 @@ export interface ECSTaskSet { } export namespace ECSTaskSet { + /** + * @internal + */ export const filterSensitiveLog = (obj: ECSTaskSet): any => ({ ...obj, }); @@ -2801,6 +3038,9 @@ export interface ECSTarget { } export namespace ECSTarget { + /** + * @internal + */ export const filterSensitiveLog = (obj: ECSTarget): any => ({ ...obj, }); @@ -2850,6 +3090,9 @@ export interface InstanceTarget { } export namespace InstanceTarget { + /** + * @internal + */ export const filterSensitiveLog = (obj: InstanceTarget): any => ({ ...obj, }); @@ -2889,6 +3132,9 @@ export interface LambdaFunctionInfo { } export namespace LambdaFunctionInfo { + /** + * @internal + */ export const filterSensitiveLog = (obj: LambdaFunctionInfo): any => ({ ...obj, }); @@ -2939,6 +3185,9 @@ export interface LambdaTarget { } export namespace LambdaTarget { + /** + * @internal + */ export const filterSensitiveLog = (obj: LambdaTarget): any => ({ ...obj, }); @@ -2981,6 +3230,9 @@ export interface DeploymentTarget { } export namespace DeploymentTarget { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeploymentTarget): any => ({ ...obj, }); @@ -3018,6 +3270,9 @@ export interface BatchGetDeploymentTargetsOutput { } export namespace BatchGetDeploymentTargetsOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: BatchGetDeploymentTargetsOutput): any => ({ ...obj, }); @@ -3036,6 +3291,9 @@ export interface DeploymentNotStartedException extends __SmithyException, $Metad } export namespace DeploymentNotStartedException { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeploymentNotStartedException): any => ({ ...obj, }); @@ -3054,6 +3312,9 @@ export interface DeploymentTargetDoesNotExistException extends __SmithyException } export namespace DeploymentTargetDoesNotExistException { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeploymentTargetDoesNotExistException): any => ({ ...obj, }); @@ -3072,6 +3333,9 @@ export interface DeploymentTargetIdRequiredException extends __SmithyException, } export namespace DeploymentTargetIdRequiredException { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeploymentTargetIdRequiredException): any => ({ ...obj, }); @@ -3092,6 +3356,9 @@ export interface DeploymentTargetListSizeExceededException extends __SmithyExcep } export namespace DeploymentTargetListSizeExceededException { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeploymentTargetListSizeExceededException): any => ({ ...obj, }); @@ -3112,6 +3379,9 @@ export interface InstanceDoesNotExistException extends __SmithyException, $Metad } export namespace InstanceDoesNotExistException { + /** + * @internal + */ export const filterSensitiveLog = (obj: InstanceDoesNotExistException): any => ({ ...obj, }); @@ -3130,6 +3400,9 @@ export interface InvalidDeploymentTargetIdException extends __SmithyException, $ } export namespace InvalidDeploymentTargetIdException { + /** + * @internal + */ export const filterSensitiveLog = (obj: InvalidDeploymentTargetIdException): any => ({ ...obj, }); @@ -3147,6 +3420,9 @@ export interface BatchGetOnPremisesInstancesInput { } export namespace BatchGetOnPremisesInstancesInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: BatchGetOnPremisesInstancesInput): any => ({ ...obj, }); @@ -3194,6 +3470,9 @@ export interface InstanceInfo { } export namespace InstanceInfo { + /** + * @internal + */ export const filterSensitiveLog = (obj: InstanceInfo): any => ({ ...obj, }); @@ -3210,6 +3489,9 @@ export interface BatchGetOnPremisesInstancesOutput { } export namespace BatchGetOnPremisesInstancesOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: BatchGetOnPremisesInstancesOutput): any => ({ ...obj, }); @@ -3228,6 +3510,9 @@ export interface BucketNameFilterRequiredException extends __SmithyException, $M } export namespace BucketNameFilterRequiredException { + /** + * @internal + */ export const filterSensitiveLog = (obj: BucketNameFilterRequiredException): any => ({ ...obj, }); @@ -3255,6 +3540,9 @@ export interface ContinueDeploymentInput { } export namespace ContinueDeploymentInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: ContinueDeploymentInput): any => ({ ...obj, }); @@ -3273,6 +3561,9 @@ export interface DeploymentAlreadyCompletedException extends __SmithyException, } export namespace DeploymentAlreadyCompletedException { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeploymentAlreadyCompletedException): any => ({ ...obj, }); @@ -3291,6 +3582,9 @@ export interface DeploymentIsNotInReadyStateException extends __SmithyException, } export namespace DeploymentIsNotInReadyStateException { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeploymentIsNotInReadyStateException): any => ({ ...obj, }); @@ -3309,6 +3603,9 @@ export interface InvalidDeploymentStatusException extends __SmithyException, $Me } export namespace InvalidDeploymentStatusException { + /** + * @internal + */ export const filterSensitiveLog = (obj: InvalidDeploymentStatusException): any => ({ ...obj, }); @@ -3327,6 +3624,9 @@ export interface InvalidDeploymentWaitTypeException extends __SmithyException, $ } export namespace InvalidDeploymentWaitTypeException { + /** + * @internal + */ export const filterSensitiveLog = (obj: InvalidDeploymentWaitTypeException): any => ({ ...obj, }); @@ -3345,6 +3645,9 @@ export interface UnsupportedActionForDeploymentTypeException extends __SmithyExc } export namespace UnsupportedActionForDeploymentTypeException { + /** + * @internal + */ export const filterSensitiveLog = (obj: UnsupportedActionForDeploymentTypeException): any => ({ ...obj, }); @@ -3375,6 +3678,9 @@ export interface CreateApplicationInput { } export namespace CreateApplicationInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateApplicationInput): any => ({ ...obj, }); @@ -3391,6 +3697,9 @@ export interface CreateApplicationOutput { } export namespace CreateApplicationOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateApplicationOutput): any => ({ ...obj, }); @@ -3409,6 +3718,9 @@ export interface InvalidTagsToAddException extends __SmithyException, $MetadataB } export namespace InvalidTagsToAddException { + /** + * @internal + */ export const filterSensitiveLog = (obj: InvalidTagsToAddException): any => ({ ...obj, }); @@ -3519,6 +3831,9 @@ export interface CreateDeploymentInput { } export namespace CreateDeploymentInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateDeploymentInput): any => ({ ...obj, }); @@ -3535,6 +3850,9 @@ export interface CreateDeploymentOutput { } export namespace CreateDeploymentOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateDeploymentOutput): any => ({ ...obj, }); @@ -3553,6 +3871,9 @@ export interface DeploymentGroupDoesNotExistException extends __SmithyException, } export namespace DeploymentGroupDoesNotExistException { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeploymentGroupDoesNotExistException): any => ({ ...obj, }); @@ -3571,6 +3892,9 @@ export interface DeploymentLimitExceededException extends __SmithyException, $Me } export namespace DeploymentLimitExceededException { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeploymentLimitExceededException): any => ({ ...obj, }); @@ -3589,6 +3913,9 @@ export interface DescriptionTooLongException extends __SmithyException, $Metadat } export namespace DescriptionTooLongException { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescriptionTooLongException): any => ({ ...obj, }); @@ -3609,6 +3936,9 @@ export interface InvalidAutoRollbackConfigException extends __SmithyException, $ } export namespace InvalidAutoRollbackConfigException { + /** + * @internal + */ export const filterSensitiveLog = (obj: InvalidAutoRollbackConfigException): any => ({ ...obj, }); @@ -3627,6 +3957,9 @@ export interface InvalidAutoScalingGroupException extends __SmithyException, $Me } export namespace InvalidAutoScalingGroupException { + /** + * @internal + */ export const filterSensitiveLog = (obj: InvalidAutoScalingGroupException): any => ({ ...obj, }); @@ -3645,6 +3978,9 @@ export interface InvalidDeploymentConfigNameException extends __SmithyException, } export namespace InvalidDeploymentConfigNameException { + /** + * @internal + */ export const filterSensitiveLog = (obj: InvalidDeploymentConfigNameException): any => ({ ...obj, }); @@ -3666,6 +4002,9 @@ export interface InvalidFileExistsBehaviorException extends __SmithyException, $ } export namespace InvalidFileExistsBehaviorException { + /** + * @internal + */ export const filterSensitiveLog = (obj: InvalidFileExistsBehaviorException): any => ({ ...obj, }); @@ -3684,6 +4023,9 @@ export interface InvalidGitHubAccountTokenException extends __SmithyException, $ } export namespace InvalidGitHubAccountTokenException { + /** + * @internal + */ export const filterSensitiveLog = (obj: InvalidGitHubAccountTokenException): any => ({ ...obj, }); @@ -3704,6 +4046,9 @@ export interface InvalidIgnoreApplicationStopFailuresValueException extends __Sm } export namespace InvalidIgnoreApplicationStopFailuresValueException { + /** + * @internal + */ export const filterSensitiveLog = (obj: InvalidIgnoreApplicationStopFailuresValueException): any => ({ ...obj, }); @@ -3722,6 +4067,9 @@ export interface InvalidLoadBalancerInfoException extends __SmithyException, $Me } export namespace InvalidLoadBalancerInfoException { + /** + * @internal + */ export const filterSensitiveLog = (obj: InvalidLoadBalancerInfoException): any => ({ ...obj, }); @@ -3742,6 +4090,9 @@ export interface InvalidRoleException extends __SmithyException, $MetadataBearer } export namespace InvalidRoleException { + /** + * @internal + */ export const filterSensitiveLog = (obj: InvalidRoleException): any => ({ ...obj, }); @@ -3775,6 +4126,9 @@ export interface InvalidTargetInstancesException extends __SmithyException, $Met } export namespace InvalidTargetInstancesException { + /** + * @internal + */ export const filterSensitiveLog = (obj: InvalidTargetInstancesException): any => ({ ...obj, }); @@ -3794,6 +4148,9 @@ export interface InvalidTrafficRoutingConfigurationException extends __SmithyExc } export namespace InvalidTrafficRoutingConfigurationException { + /** + * @internal + */ export const filterSensitiveLog = (obj: InvalidTrafficRoutingConfigurationException): any => ({ ...obj, }); @@ -3814,6 +4171,9 @@ export interface InvalidUpdateOutdatedInstancesOnlyValueException extends __Smit } export namespace InvalidUpdateOutdatedInstancesOnlyValueException { + /** + * @internal + */ export const filterSensitiveLog = (obj: InvalidUpdateOutdatedInstancesOnlyValueException): any => ({ ...obj, }); @@ -3832,6 +4192,9 @@ export interface RevisionDoesNotExistException extends __SmithyException, $Metad } export namespace RevisionDoesNotExistException { + /** + * @internal + */ export const filterSensitiveLog = (obj: RevisionDoesNotExistException): any => ({ ...obj, }); @@ -3850,6 +4213,9 @@ export interface ThrottlingException extends __SmithyException, $MetadataBearer } export namespace ThrottlingException { + /** + * @internal + */ export const filterSensitiveLog = (obj: ThrottlingException): any => ({ ...obj, }); @@ -3904,6 +4270,9 @@ export interface MinimumHealthyHosts { } export namespace MinimumHealthyHosts { + /** + * @internal + */ export const filterSensitiveLog = (obj: MinimumHealthyHosts): any => ({ ...obj, }); @@ -3929,6 +4298,9 @@ export interface TimeBasedCanary { } export namespace TimeBasedCanary { + /** + * @internal + */ export const filterSensitiveLog = (obj: TimeBasedCanary): any => ({ ...obj, }); @@ -3955,6 +4327,9 @@ export interface TimeBasedLinear { } export namespace TimeBasedLinear { + /** + * @internal + */ export const filterSensitiveLog = (obj: TimeBasedLinear): any => ({ ...obj, }); @@ -3995,6 +4370,9 @@ export interface TrafficRoutingConfig { } export namespace TrafficRoutingConfig { + /** + * @internal + */ export const filterSensitiveLog = (obj: TrafficRoutingConfig): any => ({ ...obj, }); @@ -4045,6 +4423,9 @@ export interface CreateDeploymentConfigInput { } export namespace CreateDeploymentConfigInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateDeploymentConfigInput): any => ({ ...obj, }); @@ -4061,6 +4442,9 @@ export interface CreateDeploymentConfigOutput { } export namespace CreateDeploymentConfigOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateDeploymentConfigOutput): any => ({ ...obj, }); @@ -4080,6 +4464,9 @@ export interface DeploymentConfigAlreadyExistsException extends __SmithyExceptio } export namespace DeploymentConfigAlreadyExistsException { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeploymentConfigAlreadyExistsException): any => ({ ...obj, }); @@ -4098,6 +4485,9 @@ export interface DeploymentConfigLimitExceededException extends __SmithyExceptio } export namespace DeploymentConfigLimitExceededException { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeploymentConfigLimitExceededException): any => ({ ...obj, }); @@ -4116,6 +4506,9 @@ export interface DeploymentConfigNameRequiredException extends __SmithyException } export namespace DeploymentConfigNameRequiredException { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeploymentConfigNameRequiredException): any => ({ ...obj, }); @@ -4134,6 +4527,9 @@ export interface InvalidMinimumHealthyHostValueException extends __SmithyExcepti } export namespace InvalidMinimumHealthyHostValueException { + /** + * @internal + */ export const filterSensitiveLog = (obj: InvalidMinimumHealthyHostValueException): any => ({ ...obj, }); @@ -4272,6 +4668,9 @@ export interface CreateDeploymentGroupInput { } export namespace CreateDeploymentGroupInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateDeploymentGroupInput): any => ({ ...obj, }); @@ -4288,6 +4687,9 @@ export interface CreateDeploymentGroupOutput { } export namespace CreateDeploymentGroupOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateDeploymentGroupOutput): any => ({ ...obj, }); @@ -4307,6 +4709,9 @@ export interface DeploymentGroupAlreadyExistsException extends __SmithyException } export namespace DeploymentGroupAlreadyExistsException { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeploymentGroupAlreadyExistsException): any => ({ ...obj, }); @@ -4325,6 +4730,9 @@ export interface DeploymentGroupLimitExceededException extends __SmithyException } export namespace DeploymentGroupLimitExceededException { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeploymentGroupLimitExceededException): any => ({ ...obj, }); @@ -4344,6 +4752,9 @@ export interface ECSServiceMappingLimitExceededException extends __SmithyExcepti } export namespace ECSServiceMappingLimitExceededException { + /** + * @internal + */ export const filterSensitiveLog = (obj: ECSServiceMappingLimitExceededException): any => ({ ...obj, }); @@ -4379,6 +4790,9 @@ export interface InvalidAlarmConfigException extends __SmithyException, $Metadat } export namespace InvalidAlarmConfigException { + /** + * @internal + */ export const filterSensitiveLog = (obj: InvalidAlarmConfigException): any => ({ ...obj, }); @@ -4398,6 +4812,9 @@ export interface InvalidBlueGreenDeploymentConfigurationException extends __Smit } export namespace InvalidBlueGreenDeploymentConfigurationException { + /** + * @internal + */ export const filterSensitiveLog = (obj: InvalidBlueGreenDeploymentConfigurationException): any => ({ ...obj, }); @@ -4418,6 +4835,9 @@ export interface InvalidDeploymentStyleException extends __SmithyException, $Met } export namespace InvalidDeploymentStyleException { + /** + * @internal + */ export const filterSensitiveLog = (obj: InvalidDeploymentStyleException): any => ({ ...obj, }); @@ -4437,6 +4857,9 @@ export interface InvalidEC2TagCombinationException extends __SmithyException, $M } export namespace InvalidEC2TagCombinationException { + /** + * @internal + */ export const filterSensitiveLog = (obj: InvalidEC2TagCombinationException): any => ({ ...obj, }); @@ -4455,6 +4878,9 @@ export interface InvalidEC2TagException extends __SmithyException, $MetadataBear } export namespace InvalidEC2TagException { + /** + * @internal + */ export const filterSensitiveLog = (obj: InvalidEC2TagException): any => ({ ...obj, }); @@ -4473,6 +4899,9 @@ export interface InvalidECSServiceException extends __SmithyException, $Metadata } export namespace InvalidECSServiceException { + /** + * @internal + */ export const filterSensitiveLog = (obj: InvalidECSServiceException): any => ({ ...obj, }); @@ -4491,6 +4920,9 @@ export interface InvalidInputException extends __SmithyException, $MetadataBeare } export namespace InvalidInputException { + /** + * @internal + */ export const filterSensitiveLog = (obj: InvalidInputException): any => ({ ...obj, }); @@ -4510,6 +4942,9 @@ export interface InvalidOnPremisesTagCombinationException extends __SmithyExcept } export namespace InvalidOnPremisesTagCombinationException { + /** + * @internal + */ export const filterSensitiveLog = (obj: InvalidOnPremisesTagCombinationException): any => ({ ...obj, }); @@ -4528,6 +4963,9 @@ export interface InvalidTargetGroupPairException extends __SmithyException, $Met } export namespace InvalidTargetGroupPairException { + /** + * @internal + */ export const filterSensitiveLog = (obj: InvalidTargetGroupPairException): any => ({ ...obj, }); @@ -4546,6 +4984,9 @@ export interface InvalidTriggerConfigException extends __SmithyException, $Metad } export namespace InvalidTriggerConfigException { + /** + * @internal + */ export const filterSensitiveLog = (obj: InvalidTriggerConfigException): any => ({ ...obj, }); @@ -4564,6 +5005,9 @@ export interface LifecycleHookLimitExceededException extends __SmithyException, } export namespace LifecycleHookLimitExceededException { + /** + * @internal + */ export const filterSensitiveLog = (obj: LifecycleHookLimitExceededException): any => ({ ...obj, }); @@ -4582,6 +5026,9 @@ export interface RoleRequiredException extends __SmithyException, $MetadataBeare } export namespace RoleRequiredException { + /** + * @internal + */ export const filterSensitiveLog = (obj: RoleRequiredException): any => ({ ...obj, }); @@ -4601,6 +5048,9 @@ export interface TagSetListLimitExceededException extends __SmithyException, $Me } export namespace TagSetListLimitExceededException { + /** + * @internal + */ export const filterSensitiveLog = (obj: TagSetListLimitExceededException): any => ({ ...obj, }); @@ -4619,6 +5069,9 @@ export interface TriggerTargetsLimitExceededException extends __SmithyException, } export namespace TriggerTargetsLimitExceededException { + /** + * @internal + */ export const filterSensitiveLog = (obj: TriggerTargetsLimitExceededException): any => ({ ...obj, }); @@ -4636,6 +5089,9 @@ export interface DeleteApplicationInput { } export namespace DeleteApplicationInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteApplicationInput): any => ({ ...obj, }); @@ -4653,6 +5109,9 @@ export interface DeleteDeploymentConfigInput { } export namespace DeleteDeploymentConfigInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteDeploymentConfigInput): any => ({ ...obj, }); @@ -4671,6 +5130,9 @@ export interface DeploymentConfigInUseException extends __SmithyException, $Meta } export namespace DeploymentConfigInUseException { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeploymentConfigInUseException): any => ({ ...obj, }); @@ -4689,6 +5151,9 @@ export interface InvalidOperationException extends __SmithyException, $MetadataB } export namespace InvalidOperationException { + /** + * @internal + */ export const filterSensitiveLog = (obj: InvalidOperationException): any => ({ ...obj, }); @@ -4711,6 +5176,9 @@ export interface DeleteDeploymentGroupInput { } export namespace DeleteDeploymentGroupInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteDeploymentGroupInput): any => ({ ...obj, }); @@ -4731,6 +5199,9 @@ export interface DeleteDeploymentGroupOutput { } export namespace DeleteDeploymentGroupOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteDeploymentGroupOutput): any => ({ ...obj, }); @@ -4747,6 +5218,9 @@ export interface DeleteGitHubAccountTokenInput { } export namespace DeleteGitHubAccountTokenInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteGitHubAccountTokenInput): any => ({ ...obj, }); @@ -4763,6 +5237,9 @@ export interface DeleteGitHubAccountTokenOutput { } export namespace DeleteGitHubAccountTokenOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteGitHubAccountTokenOutput): any => ({ ...obj, }); @@ -4781,6 +5258,9 @@ export interface GitHubAccountTokenDoesNotExistException extends __SmithyExcepti } export namespace GitHubAccountTokenDoesNotExistException { + /** + * @internal + */ export const filterSensitiveLog = (obj: GitHubAccountTokenDoesNotExistException): any => ({ ...obj, }); @@ -4799,6 +5279,9 @@ export interface GitHubAccountTokenNameRequiredException extends __SmithyExcepti } export namespace GitHubAccountTokenNameRequiredException { + /** + * @internal + */ export const filterSensitiveLog = (obj: GitHubAccountTokenNameRequiredException): any => ({ ...obj, }); @@ -4817,6 +5300,9 @@ export interface InvalidGitHubAccountTokenNameException extends __SmithyExceptio } export namespace InvalidGitHubAccountTokenNameException { + /** + * @internal + */ export const filterSensitiveLog = (obj: InvalidGitHubAccountTokenNameException): any => ({ ...obj, }); @@ -4835,6 +5321,9 @@ export interface OperationNotSupportedException extends __SmithyException, $Meta } export namespace OperationNotSupportedException { + /** + * @internal + */ export const filterSensitiveLog = (obj: OperationNotSupportedException): any => ({ ...obj, }); @@ -4853,6 +5342,9 @@ export interface ResourceValidationException extends __SmithyException, $Metadat } export namespace ResourceValidationException { + /** + * @internal + */ export const filterSensitiveLog = (obj: ResourceValidationException): any => ({ ...obj, }); @@ -4867,6 +5359,9 @@ export interface DeleteResourcesByExternalIdInput { } export namespace DeleteResourcesByExternalIdInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteResourcesByExternalIdInput): any => ({ ...obj, }); @@ -4875,6 +5370,9 @@ export namespace DeleteResourcesByExternalIdInput { export interface DeleteResourcesByExternalIdOutput {} export namespace DeleteResourcesByExternalIdOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteResourcesByExternalIdOutput): any => ({ ...obj, }); @@ -4891,6 +5389,9 @@ export interface DeregisterOnPremisesInstanceInput { } export namespace DeregisterOnPremisesInstanceInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeregisterOnPremisesInstanceInput): any => ({ ...obj, }); @@ -4908,6 +5409,9 @@ export interface GetApplicationInput { } export namespace GetApplicationInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetApplicationInput): any => ({ ...obj, }); @@ -4924,6 +5428,9 @@ export interface GetApplicationOutput { } export namespace GetApplicationOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetApplicationOutput): any => ({ ...obj, }); @@ -4945,6 +5452,9 @@ export interface GetApplicationRevisionInput { } export namespace GetApplicationRevisionInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetApplicationRevisionInput): any => ({ ...obj, }); @@ -4971,6 +5481,9 @@ export interface GetApplicationRevisionOutput { } export namespace GetApplicationRevisionOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetApplicationRevisionOutput): any => ({ ...obj, }); @@ -4987,6 +5500,9 @@ export interface GetDeploymentInput { } export namespace GetDeploymentInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetDeploymentInput): any => ({ ...obj, }); @@ -5003,6 +5519,9 @@ export interface GetDeploymentOutput { } export namespace GetDeploymentOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetDeploymentOutput): any => ({ ...obj, }); @@ -5020,6 +5539,9 @@ export interface GetDeploymentConfigInput { } export namespace GetDeploymentConfigInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetDeploymentConfigInput): any => ({ ...obj, }); @@ -5063,6 +5585,9 @@ export interface DeploymentConfigInfo { } export namespace DeploymentConfigInfo { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeploymentConfigInfo): any => ({ ...obj, }); @@ -5079,6 +5604,9 @@ export interface GetDeploymentConfigOutput { } export namespace GetDeploymentConfigOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetDeploymentConfigOutput): any => ({ ...obj, }); @@ -5101,6 +5629,9 @@ export interface GetDeploymentGroupInput { } export namespace GetDeploymentGroupInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetDeploymentGroupInput): any => ({ ...obj, }); @@ -5117,6 +5648,9 @@ export interface GetDeploymentGroupOutput { } export namespace GetDeploymentGroupOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetDeploymentGroupOutput): any => ({ ...obj, }); @@ -5138,6 +5672,9 @@ export interface GetDeploymentInstanceInput { } export namespace GetDeploymentInstanceInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetDeploymentInstanceInput): any => ({ ...obj, }); @@ -5156,6 +5693,9 @@ export interface GetDeploymentInstanceOutput { } export namespace GetDeploymentInstanceOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetDeploymentInstanceOutput): any => ({ ...obj, }); @@ -5174,6 +5714,9 @@ export interface GetDeploymentTargetInput { } export namespace GetDeploymentTargetInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetDeploymentTargetInput): any => ({ ...obj, }); @@ -5191,6 +5734,9 @@ export interface GetDeploymentTargetOutput { } export namespace GetDeploymentTargetOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetDeploymentTargetOutput): any => ({ ...obj, }); @@ -5207,6 +5753,9 @@ export interface GetOnPremisesInstanceInput { } export namespace GetOnPremisesInstanceInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetOnPremisesInstanceInput): any => ({ ...obj, }); @@ -5223,6 +5772,9 @@ export interface GetOnPremisesInstanceOutput { } export namespace GetOnPremisesInstanceOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetOnPremisesInstanceOutput): any => ({ ...obj, }); @@ -5241,6 +5793,9 @@ export interface InvalidBucketNameFilterException extends __SmithyException, $Me } export namespace InvalidBucketNameFilterException { + /** + * @internal + */ export const filterSensitiveLog = (obj: InvalidBucketNameFilterException): any => ({ ...obj, }); @@ -5259,6 +5814,9 @@ export interface InvalidDeployedStateFilterException extends __SmithyException, } export namespace InvalidDeployedStateFilterException { + /** + * @internal + */ export const filterSensitiveLog = (obj: InvalidDeployedStateFilterException): any => ({ ...obj, }); @@ -5277,6 +5835,9 @@ export interface InvalidKeyPrefixFilterException extends __SmithyException, $Met } export namespace InvalidKeyPrefixFilterException { + /** + * @internal + */ export const filterSensitiveLog = (obj: InvalidKeyPrefixFilterException): any => ({ ...obj, }); @@ -5295,6 +5856,9 @@ export interface InvalidNextTokenException extends __SmithyException, $MetadataB } export namespace InvalidNextTokenException { + /** + * @internal + */ export const filterSensitiveLog = (obj: InvalidNextTokenException): any => ({ ...obj, }); @@ -5314,6 +5878,9 @@ export interface InvalidSortByException extends __SmithyException, $MetadataBear } export namespace InvalidSortByException { + /** + * @internal + */ export const filterSensitiveLog = (obj: InvalidSortByException): any => ({ ...obj, }); @@ -5332,6 +5899,9 @@ export interface InvalidSortOrderException extends __SmithyException, $MetadataB } export namespace InvalidSortOrderException { + /** + * @internal + */ export const filterSensitiveLog = (obj: InvalidSortOrderException): any => ({ ...obj, }); @@ -5441,6 +6011,9 @@ export interface ListApplicationRevisionsInput { } export namespace ListApplicationRevisionsInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListApplicationRevisionsInput): any => ({ ...obj, }); @@ -5464,6 +6037,9 @@ export interface ListApplicationRevisionsOutput { } export namespace ListApplicationRevisionsOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListApplicationRevisionsOutput): any => ({ ...obj, }); @@ -5481,6 +6057,9 @@ export interface ListApplicationsInput { } export namespace ListApplicationsInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListApplicationsInput): any => ({ ...obj, }); @@ -5504,6 +6083,9 @@ export interface ListApplicationsOutput { } export namespace ListApplicationsOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListApplicationsOutput): any => ({ ...obj, }); @@ -5521,6 +6103,9 @@ export interface ListDeploymentConfigsInput { } export namespace ListDeploymentConfigsInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListDeploymentConfigsInput): any => ({ ...obj, }); @@ -5545,6 +6130,9 @@ export interface ListDeploymentConfigsOutput { } export namespace ListDeploymentConfigsOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListDeploymentConfigsOutput): any => ({ ...obj, }); @@ -5568,6 +6156,9 @@ export interface ListDeploymentGroupsInput { } export namespace ListDeploymentGroupsInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListDeploymentGroupsInput): any => ({ ...obj, }); @@ -5596,6 +6187,9 @@ export interface ListDeploymentGroupsOutput { } export namespace ListDeploymentGroupsOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListDeploymentGroupsOutput): any => ({ ...obj, }); @@ -5615,6 +6209,9 @@ export interface InvalidDeploymentInstanceTypeException extends __SmithyExceptio } export namespace InvalidDeploymentInstanceTypeException { + /** + * @internal + */ export const filterSensitiveLog = (obj: InvalidDeploymentInstanceTypeException): any => ({ ...obj, }); @@ -5633,6 +6230,9 @@ export interface InvalidInstanceStatusException extends __SmithyException, $Meta } export namespace InvalidInstanceStatusException { + /** + * @internal + */ export const filterSensitiveLog = (obj: InvalidInstanceStatusException): any => ({ ...obj, }); @@ -5653,6 +6253,9 @@ export interface InvalidInstanceTypeException extends __SmithyException, $Metada } export namespace InvalidInstanceTypeException { + /** + * @internal + */ export const filterSensitiveLog = (obj: InvalidInstanceTypeException): any => ({ ...obj, }); @@ -5671,6 +6274,9 @@ export interface InvalidTargetFilterNameException extends __SmithyException, $Me } export namespace InvalidTargetFilterNameException { + /** + * @internal + */ export const filterSensitiveLog = (obj: InvalidTargetFilterNameException): any => ({ ...obj, }); @@ -5734,6 +6340,9 @@ export interface ListDeploymentInstancesInput { } export namespace ListDeploymentInstancesInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListDeploymentInstancesInput): any => ({ ...obj, }); @@ -5757,6 +6366,9 @@ export interface ListDeploymentInstancesOutput { } export namespace ListDeploymentInstancesOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListDeploymentInstancesOutput): any => ({ ...obj, }); @@ -5775,6 +6387,9 @@ export interface InvalidExternalIdException extends __SmithyException, $Metadata } export namespace InvalidExternalIdException { + /** + * @internal + */ export const filterSensitiveLog = (obj: InvalidExternalIdException): any => ({ ...obj, }); @@ -5793,6 +6408,9 @@ export interface InvalidTimeRangeException extends __SmithyException, $MetadataB } export namespace InvalidTimeRangeException { + /** + * @internal + */ export const filterSensitiveLog = (obj: InvalidTimeRangeException): any => ({ ...obj, }); @@ -5820,6 +6438,9 @@ export interface TimeRange { } export namespace TimeRange { + /** + * @internal + */ export const filterSensitiveLog = (obj: TimeRange): any => ({ ...obj, }); @@ -5904,6 +6525,9 @@ export interface ListDeploymentsInput { } export namespace ListDeploymentsInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListDeploymentsInput): any => ({ ...obj, }); @@ -5927,6 +6551,9 @@ export interface ListDeploymentsOutput { } export namespace ListDeploymentsOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListDeploymentsOutput): any => ({ ...obj, }); @@ -5970,6 +6597,9 @@ export interface ListDeploymentTargetsInput { } export namespace ListDeploymentTargetsInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListDeploymentTargetsInput): any => ({ ...obj, }); @@ -5990,6 +6620,9 @@ export interface ListDeploymentTargetsOutput { } export namespace ListDeploymentTargetsOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListDeploymentTargetsOutput): any => ({ ...obj, }); @@ -6007,6 +6640,9 @@ export interface ListGitHubAccountTokenNamesInput { } export namespace ListGitHubAccountTokenNamesInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListGitHubAccountTokenNamesInput): any => ({ ...obj, }); @@ -6030,6 +6666,9 @@ export interface ListGitHubAccountTokenNamesOutput { } export namespace ListGitHubAccountTokenNamesOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListGitHubAccountTokenNamesOutput): any => ({ ...obj, }); @@ -6048,6 +6687,9 @@ export interface InvalidRegistrationStatusException extends __SmithyException, $ } export namespace InvalidRegistrationStatusException { + /** + * @internal + */ export const filterSensitiveLog = (obj: InvalidRegistrationStatusException): any => ({ ...obj, }); @@ -6066,6 +6708,9 @@ export interface InvalidTagFilterException extends __SmithyException, $MetadataB } export namespace InvalidTagFilterException { + /** + * @internal + */ export const filterSensitiveLog = (obj: InvalidTagFilterException): any => ({ ...obj, }); @@ -6111,6 +6756,9 @@ export interface ListOnPremisesInstancesInput { } export namespace ListOnPremisesInstancesInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListOnPremisesInstancesInput): any => ({ ...obj, }); @@ -6134,6 +6782,9 @@ export interface ListOnPremisesInstancesOutput { } export namespace ListOnPremisesInstancesOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListOnPremisesInstancesOutput): any => ({ ...obj, }); @@ -6152,6 +6803,9 @@ export interface InvalidArnException extends __SmithyException, $MetadataBearer } export namespace InvalidArnException { + /** + * @internal + */ export const filterSensitiveLog = (obj: InvalidArnException): any => ({ ...obj, }); @@ -6173,6 +6827,9 @@ export interface ListTagsForResourceInput { } export namespace ListTagsForResourceInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListTagsForResourceInput): any => ({ ...obj, }); @@ -6194,6 +6851,9 @@ export interface ListTagsForResourceOutput { } export namespace ListTagsForResourceOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListTagsForResourceOutput): any => ({ ...obj, }); @@ -6212,6 +6872,9 @@ export interface ResourceArnRequiredException extends __SmithyException, $Metada } export namespace ResourceArnRequiredException { + /** + * @internal + */ export const filterSensitiveLog = (obj: ResourceArnRequiredException): any => ({ ...obj, }); @@ -6232,6 +6895,9 @@ export interface InvalidLifecycleEventHookExecutionIdException extends __SmithyE } export namespace InvalidLifecycleEventHookExecutionIdException { + /** + * @internal + */ export const filterSensitiveLog = (obj: InvalidLifecycleEventHookExecutionIdException): any => ({ ...obj, }); @@ -6251,6 +6917,9 @@ export interface InvalidLifecycleEventHookExecutionStatusException extends __Smi } export namespace InvalidLifecycleEventHookExecutionStatusException { + /** + * @internal + */ export const filterSensitiveLog = (obj: InvalidLifecycleEventHookExecutionStatusException): any => ({ ...obj, }); @@ -6270,6 +6939,9 @@ export interface LifecycleEventAlreadyCompletedException extends __SmithyExcepti } export namespace LifecycleEventAlreadyCompletedException { + /** + * @internal + */ export const filterSensitiveLog = (obj: LifecycleEventAlreadyCompletedException): any => ({ ...obj, }); @@ -6297,6 +6969,9 @@ export interface PutLifecycleEventHookExecutionStatusInput { } export namespace PutLifecycleEventHookExecutionStatusInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: PutLifecycleEventHookExecutionStatusInput): any => ({ ...obj, }); @@ -6311,6 +6986,9 @@ export interface PutLifecycleEventHookExecutionStatusOutput { } export namespace PutLifecycleEventHookExecutionStatusOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: PutLifecycleEventHookExecutionStatusOutput): any => ({ ...obj, }); @@ -6339,6 +7017,9 @@ export interface RegisterApplicationRevisionInput { } export namespace RegisterApplicationRevisionInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: RegisterApplicationRevisionInput): any => ({ ...obj, }); @@ -6358,6 +7039,9 @@ export interface IamArnRequiredException extends __SmithyException, $MetadataBea } export namespace IamArnRequiredException { + /** + * @internal + */ export const filterSensitiveLog = (obj: IamArnRequiredException): any => ({ ...obj, }); @@ -6377,6 +7061,9 @@ export interface IamSessionArnAlreadyRegisteredException extends __SmithyExcepti } export namespace IamSessionArnAlreadyRegisteredException { + /** + * @internal + */ export const filterSensitiveLog = (obj: IamSessionArnAlreadyRegisteredException): any => ({ ...obj, }); @@ -6395,6 +7082,9 @@ export interface IamUserArnAlreadyRegisteredException extends __SmithyException, } export namespace IamUserArnAlreadyRegisteredException { + /** + * @internal + */ export const filterSensitiveLog = (obj: IamUserArnAlreadyRegisteredException): any => ({ ...obj, }); @@ -6413,6 +7103,9 @@ export interface IamUserArnRequiredException extends __SmithyException, $Metadat } export namespace IamUserArnRequiredException { + /** + * @internal + */ export const filterSensitiveLog = (obj: IamUserArnRequiredException): any => ({ ...obj, }); @@ -6431,6 +7124,9 @@ export interface InstanceNameAlreadyRegisteredException extends __SmithyExceptio } export namespace InstanceNameAlreadyRegisteredException { + /** + * @internal + */ export const filterSensitiveLog = (obj: InstanceNameAlreadyRegisteredException): any => ({ ...obj, }); @@ -6449,6 +7145,9 @@ export interface InvalidIamSessionArnException extends __SmithyException, $Metad } export namespace InvalidIamSessionArnException { + /** + * @internal + */ export const filterSensitiveLog = (obj: InvalidIamSessionArnException): any => ({ ...obj, }); @@ -6467,6 +7166,9 @@ export interface InvalidIamUserArnException extends __SmithyException, $Metadata } export namespace InvalidIamUserArnException { + /** + * @internal + */ export const filterSensitiveLog = (obj: InvalidIamUserArnException): any => ({ ...obj, }); @@ -6486,6 +7188,9 @@ export interface MultipleIamArnsProvidedException extends __SmithyException, $Me } export namespace MultipleIamArnsProvidedException { + /** + * @internal + */ export const filterSensitiveLog = (obj: MultipleIamArnsProvidedException): any => ({ ...obj, }); @@ -6512,6 +7217,9 @@ export interface RegisterOnPremisesInstanceInput { } export namespace RegisterOnPremisesInstanceInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: RegisterOnPremisesInstanceInput): any => ({ ...obj, }); @@ -6534,6 +7242,9 @@ export interface RemoveTagsFromOnPremisesInstancesInput { } export namespace RemoveTagsFromOnPremisesInstancesInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: RemoveTagsFromOnPremisesInstancesInput): any => ({ ...obj, }); @@ -6548,6 +7259,9 @@ export interface SkipWaitTimeForInstanceTerminationInput { } export namespace SkipWaitTimeForInstanceTerminationInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: SkipWaitTimeForInstanceTerminationInput): any => ({ ...obj, }); @@ -6570,6 +7284,9 @@ export interface StopDeploymentInput { } export namespace StopDeploymentInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: StopDeploymentInput): any => ({ ...obj, }); @@ -6604,6 +7321,9 @@ export interface StopDeploymentOutput { } export namespace StopDeploymentOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: StopDeploymentOutput): any => ({ ...obj, }); @@ -6623,6 +7343,9 @@ export interface TagResourceInput { } export namespace TagResourceInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: TagResourceInput): any => ({ ...obj, }); @@ -6631,6 +7354,9 @@ export namespace TagResourceInput { export interface TagResourceOutput {} export namespace TagResourceOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: TagResourceOutput): any => ({ ...obj, }); @@ -6652,6 +7378,9 @@ export interface UntagResourceInput { } export namespace UntagResourceInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: UntagResourceInput): any => ({ ...obj, }); @@ -6660,6 +7389,9 @@ export namespace UntagResourceInput { export interface UntagResourceOutput {} export namespace UntagResourceOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: UntagResourceOutput): any => ({ ...obj, }); @@ -6681,6 +7413,9 @@ export interface UpdateApplicationInput { } export namespace UpdateApplicationInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateApplicationInput): any => ({ ...obj, }); @@ -6806,6 +7541,9 @@ export interface UpdateDeploymentGroupInput { } export namespace UpdateDeploymentGroupInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateDeploymentGroupInput): any => ({ ...obj, }); @@ -6826,6 +7564,9 @@ export interface UpdateDeploymentGroupOutput { } export namespace UpdateDeploymentGroupOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateDeploymentGroupOutput): any => ({ ...obj, }); diff --git a/clients/client-codeguru-reviewer/commands/AssociateRepositoryCommand.ts b/clients/client-codeguru-reviewer/commands/AssociateRepositoryCommand.ts index 21648bf826b2..4ea288fd5114 100644 --- a/clients/client-codeguru-reviewer/commands/AssociateRepositoryCommand.ts +++ b/clients/client-codeguru-reviewer/commands/AssociateRepositoryCommand.ts @@ -46,6 +46,20 @@ export interface AssociateRepositoryCommandOutput extends AssociateRepositoryRes * started with CodeGuru Reviewer in the CodeGuru Reviewer User Guide. *

* + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { CodeGuruReviewerClient, AssociateRepositoryCommand } from "@aws-sdk/client-codeguru-reviewer"; // ES Modules import + * // const { CodeGuruReviewerClient, AssociateRepositoryCommand } = require("@aws-sdk/client-codeguru-reviewer"); // CommonJS import + * const client = new CodeGuruReviewerClient(config); + * const command = new AssociateRepositoryCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link AssociateRepositoryCommandInput} for command's `input` shape. + * @see {@link AssociateRepositoryCommandOutput} for command's `response` shape. + * @see {@link CodeGuruReviewerClientResolvedConfig | config} for command's `input` shape. + * */ export class AssociateRepositoryCommand extends $Command< AssociateRepositoryCommandInput, diff --git a/clients/client-codeguru-reviewer/commands/CreateCodeReviewCommand.ts b/clients/client-codeguru-reviewer/commands/CreateCodeReviewCommand.ts index ea4c4c6039af..ff06acb73edd 100644 --- a/clients/client-codeguru-reviewer/commands/CreateCodeReviewCommand.ts +++ b/clients/client-codeguru-reviewer/commands/CreateCodeReviewCommand.ts @@ -28,6 +28,20 @@ export interface CreateCodeReviewCommandOutput extends CreateCodeReviewResponse, * 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 so cannot be created using this method. *

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { CodeGuruReviewerClient, CreateCodeReviewCommand } from "@aws-sdk/client-codeguru-reviewer"; // ES Modules import + * // const { CodeGuruReviewerClient, CreateCodeReviewCommand } = require("@aws-sdk/client-codeguru-reviewer"); // CommonJS import + * const client = new CodeGuruReviewerClient(config); + * const command = new CreateCodeReviewCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreateCodeReviewCommandInput} for command's `input` shape. + * @see {@link CreateCodeReviewCommandOutput} for command's `response` shape. + * @see {@link CodeGuruReviewerClientResolvedConfig | config} for command's `input` shape. + * */ export class CreateCodeReviewCommand extends $Command< CreateCodeReviewCommandInput, diff --git a/clients/client-codeguru-reviewer/commands/DescribeCodeReviewCommand.ts b/clients/client-codeguru-reviewer/commands/DescribeCodeReviewCommand.ts index c2c0c7293525..a5c322221662 100644 --- a/clients/client-codeguru-reviewer/commands/DescribeCodeReviewCommand.ts +++ b/clients/client-codeguru-reviewer/commands/DescribeCodeReviewCommand.ts @@ -22,6 +22,20 @@ export interface DescribeCodeReviewCommandOutput extends DescribeCodeReviewRespo /** *

Returns the metadata associated with the code review along with its status.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { CodeGuruReviewerClient, DescribeCodeReviewCommand } from "@aws-sdk/client-codeguru-reviewer"; // ES Modules import + * // const { CodeGuruReviewerClient, DescribeCodeReviewCommand } = require("@aws-sdk/client-codeguru-reviewer"); // CommonJS import + * const client = new CodeGuruReviewerClient(config); + * const command = new DescribeCodeReviewCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeCodeReviewCommandInput} for command's `input` shape. + * @see {@link DescribeCodeReviewCommandOutput} for command's `response` shape. + * @see {@link CodeGuruReviewerClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeCodeReviewCommand extends $Command< DescribeCodeReviewCommandInput, diff --git a/clients/client-codeguru-reviewer/commands/DescribeRecommendationFeedbackCommand.ts b/clients/client-codeguru-reviewer/commands/DescribeRecommendationFeedbackCommand.ts index 94e2a56dd1aa..f7000bc5b8ee 100644 --- a/clients/client-codeguru-reviewer/commands/DescribeRecommendationFeedbackCommand.ts +++ b/clients/client-codeguru-reviewer/commands/DescribeRecommendationFeedbackCommand.ts @@ -26,6 +26,20 @@ export interface DescribeRecommendationFeedbackCommandOutput *

* Describes the customer feedback for a CodeGuru Reviewer recommendation. *

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { CodeGuruReviewerClient, DescribeRecommendationFeedbackCommand } from "@aws-sdk/client-codeguru-reviewer"; // ES Modules import + * // const { CodeGuruReviewerClient, DescribeRecommendationFeedbackCommand } = require("@aws-sdk/client-codeguru-reviewer"); // CommonJS import + * const client = new CodeGuruReviewerClient(config); + * const command = new DescribeRecommendationFeedbackCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeRecommendationFeedbackCommandInput} for command's `input` shape. + * @see {@link DescribeRecommendationFeedbackCommandOutput} for command's `response` shape. + * @see {@link CodeGuruReviewerClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeRecommendationFeedbackCommand extends $Command< DescribeRecommendationFeedbackCommandInput, diff --git a/clients/client-codeguru-reviewer/commands/DescribeRepositoryAssociationCommand.ts b/clients/client-codeguru-reviewer/commands/DescribeRepositoryAssociationCommand.ts index cca4a24a4921..251b6aa9d133 100644 --- a/clients/client-codeguru-reviewer/commands/DescribeRepositoryAssociationCommand.ts +++ b/clients/client-codeguru-reviewer/commands/DescribeRepositoryAssociationCommand.ts @@ -29,6 +29,20 @@ export interface DescribeRepositoryAssociationCommandOutput * object * that contains information about the requested repository association. *

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { CodeGuruReviewerClient, DescribeRepositoryAssociationCommand } from "@aws-sdk/client-codeguru-reviewer"; // ES Modules import + * // const { CodeGuruReviewerClient, DescribeRepositoryAssociationCommand } = require("@aws-sdk/client-codeguru-reviewer"); // CommonJS import + * const client = new CodeGuruReviewerClient(config); + * const command = new DescribeRepositoryAssociationCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeRepositoryAssociationCommandInput} for command's `input` shape. + * @see {@link DescribeRepositoryAssociationCommandOutput} for command's `response` shape. + * @see {@link CodeGuruReviewerClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeRepositoryAssociationCommand extends $Command< DescribeRepositoryAssociationCommandInput, diff --git a/clients/client-codeguru-reviewer/commands/DisassociateRepositoryCommand.ts b/clients/client-codeguru-reviewer/commands/DisassociateRepositoryCommand.ts index 61750c27405f..086c1ba71b20 100644 --- a/clients/client-codeguru-reviewer/commands/DisassociateRepositoryCommand.ts +++ b/clients/client-codeguru-reviewer/commands/DisassociateRepositoryCommand.ts @@ -22,6 +22,20 @@ export interface DisassociateRepositoryCommandOutput extends DisassociateReposit /** *

Removes the association between Amazon CodeGuru Reviewer and a repository.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { CodeGuruReviewerClient, DisassociateRepositoryCommand } from "@aws-sdk/client-codeguru-reviewer"; // ES Modules import + * // const { CodeGuruReviewerClient, DisassociateRepositoryCommand } = require("@aws-sdk/client-codeguru-reviewer"); // CommonJS import + * const client = new CodeGuruReviewerClient(config); + * const command = new DisassociateRepositoryCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DisassociateRepositoryCommandInput} for command's `input` shape. + * @see {@link DisassociateRepositoryCommandOutput} for command's `response` shape. + * @see {@link CodeGuruReviewerClientResolvedConfig | config} for command's `input` shape. + * */ export class DisassociateRepositoryCommand extends $Command< DisassociateRepositoryCommandInput, diff --git a/clients/client-codeguru-reviewer/commands/ListCodeReviewsCommand.ts b/clients/client-codeguru-reviewer/commands/ListCodeReviewsCommand.ts index 41fc6d32afc2..0360e911ea3e 100644 --- a/clients/client-codeguru-reviewer/commands/ListCodeReviewsCommand.ts +++ b/clients/client-codeguru-reviewer/commands/ListCodeReviewsCommand.ts @@ -24,6 +24,20 @@ export interface ListCodeReviewsCommandOutput extends ListCodeReviewsResponse, _ *

* Lists all the code reviews that the customer has created in the past 90 days. *

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { CodeGuruReviewerClient, ListCodeReviewsCommand } from "@aws-sdk/client-codeguru-reviewer"; // ES Modules import + * // const { CodeGuruReviewerClient, ListCodeReviewsCommand } = require("@aws-sdk/client-codeguru-reviewer"); // CommonJS import + * const client = new CodeGuruReviewerClient(config); + * const command = new ListCodeReviewsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListCodeReviewsCommandInput} for command's `input` shape. + * @see {@link ListCodeReviewsCommandOutput} for command's `response` shape. + * @see {@link CodeGuruReviewerClientResolvedConfig | config} for command's `input` shape. + * */ export class ListCodeReviewsCommand extends $Command< ListCodeReviewsCommandInput, diff --git a/clients/client-codeguru-reviewer/commands/ListRecommendationFeedbackCommand.ts b/clients/client-codeguru-reviewer/commands/ListRecommendationFeedbackCommand.ts index 3eb68328e991..333b84d8b5bc 100644 --- a/clients/client-codeguru-reviewer/commands/ListRecommendationFeedbackCommand.ts +++ b/clients/client-codeguru-reviewer/commands/ListRecommendationFeedbackCommand.ts @@ -28,6 +28,20 @@ export interface ListRecommendationFeedbackCommandOutput extends ListRecommendat * * objects that contain customer recommendation feedback for all CodeGuru Reviewer users. *

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { CodeGuruReviewerClient, ListRecommendationFeedbackCommand } from "@aws-sdk/client-codeguru-reviewer"; // ES Modules import + * // const { CodeGuruReviewerClient, ListRecommendationFeedbackCommand } = require("@aws-sdk/client-codeguru-reviewer"); // CommonJS import + * const client = new CodeGuruReviewerClient(config); + * const command = new ListRecommendationFeedbackCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListRecommendationFeedbackCommandInput} for command's `input` shape. + * @see {@link ListRecommendationFeedbackCommandOutput} for command's `response` shape. + * @see {@link CodeGuruReviewerClientResolvedConfig | config} for command's `input` shape. + * */ export class ListRecommendationFeedbackCommand extends $Command< ListRecommendationFeedbackCommandInput, diff --git a/clients/client-codeguru-reviewer/commands/ListRecommendationsCommand.ts b/clients/client-codeguru-reviewer/commands/ListRecommendationsCommand.ts index 4904e167b78c..9c2abb53a4cf 100644 --- a/clients/client-codeguru-reviewer/commands/ListRecommendationsCommand.ts +++ b/clients/client-codeguru-reviewer/commands/ListRecommendationsCommand.ts @@ -24,6 +24,20 @@ export interface ListRecommendationsCommandOutput extends ListRecommendationsRes *

* Returns the list of all recommendations for a completed code review. *

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { CodeGuruReviewerClient, ListRecommendationsCommand } from "@aws-sdk/client-codeguru-reviewer"; // ES Modules import + * // const { CodeGuruReviewerClient, ListRecommendationsCommand } = require("@aws-sdk/client-codeguru-reviewer"); // CommonJS import + * const client = new CodeGuruReviewerClient(config); + * const command = new ListRecommendationsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListRecommendationsCommandInput} for command's `input` shape. + * @see {@link ListRecommendationsCommandOutput} for command's `response` shape. + * @see {@link CodeGuruReviewerClientResolvedConfig | config} for command's `input` shape. + * */ export class ListRecommendationsCommand extends $Command< ListRecommendationsCommandInput, diff --git a/clients/client-codeguru-reviewer/commands/ListRepositoryAssociationsCommand.ts b/clients/client-codeguru-reviewer/commands/ListRepositoryAssociationsCommand.ts index 5019632bd3af..380bf0146645 100644 --- a/clients/client-codeguru-reviewer/commands/ListRepositoryAssociationsCommand.ts +++ b/clients/client-codeguru-reviewer/commands/ListRepositoryAssociationsCommand.ts @@ -39,6 +39,20 @@ export interface ListRepositoryAssociationsCommandOutput extends ListRepositoryA * Owner * . *

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { CodeGuruReviewerClient, ListRepositoryAssociationsCommand } from "@aws-sdk/client-codeguru-reviewer"; // ES Modules import + * // const { CodeGuruReviewerClient, ListRepositoryAssociationsCommand } = require("@aws-sdk/client-codeguru-reviewer"); // CommonJS import + * const client = new CodeGuruReviewerClient(config); + * const command = new ListRepositoryAssociationsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListRepositoryAssociationsCommandInput} for command's `input` shape. + * @see {@link ListRepositoryAssociationsCommandOutput} for command's `response` shape. + * @see {@link CodeGuruReviewerClientResolvedConfig | config} for command's `input` shape. + * */ export class ListRepositoryAssociationsCommand extends $Command< ListRepositoryAssociationsCommandInput, diff --git a/clients/client-codeguru-reviewer/commands/ListTagsForResourceCommand.ts b/clients/client-codeguru-reviewer/commands/ListTagsForResourceCommand.ts index abdd1f38ed8e..7009e57f5b06 100644 --- a/clients/client-codeguru-reviewer/commands/ListTagsForResourceCommand.ts +++ b/clients/client-codeguru-reviewer/commands/ListTagsForResourceCommand.ts @@ -22,6 +22,20 @@ export interface ListTagsForResourceCommandOutput extends ListTagsForResourceRes /** *

Returns the list of tags associated with an associated repository resource.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { CodeGuruReviewerClient, ListTagsForResourceCommand } from "@aws-sdk/client-codeguru-reviewer"; // ES Modules import + * // const { CodeGuruReviewerClient, ListTagsForResourceCommand } = require("@aws-sdk/client-codeguru-reviewer"); // CommonJS import + * const client = new CodeGuruReviewerClient(config); + * const command = new ListTagsForResourceCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListTagsForResourceCommandInput} for command's `input` shape. + * @see {@link ListTagsForResourceCommandOutput} for command's `response` shape. + * @see {@link CodeGuruReviewerClientResolvedConfig | config} for command's `input` shape. + * */ export class ListTagsForResourceCommand extends $Command< ListTagsForResourceCommandInput, diff --git a/clients/client-codeguru-reviewer/commands/PutRecommendationFeedbackCommand.ts b/clients/client-codeguru-reviewer/commands/PutRecommendationFeedbackCommand.ts index 3f42f54bbc1b..ea472cc78722 100644 --- a/clients/client-codeguru-reviewer/commands/PutRecommendationFeedbackCommand.ts +++ b/clients/client-codeguru-reviewer/commands/PutRecommendationFeedbackCommand.ts @@ -24,6 +24,20 @@ export interface PutRecommendationFeedbackCommandOutput extends PutRecommendatio *

* Stores customer feedback for a CodeGuru Reviewer recommendation. When this API is called again with different reactions the previous feedback is overwritten. *

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { CodeGuruReviewerClient, PutRecommendationFeedbackCommand } from "@aws-sdk/client-codeguru-reviewer"; // ES Modules import + * // const { CodeGuruReviewerClient, PutRecommendationFeedbackCommand } = require("@aws-sdk/client-codeguru-reviewer"); // CommonJS import + * const client = new CodeGuruReviewerClient(config); + * const command = new PutRecommendationFeedbackCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link PutRecommendationFeedbackCommandInput} for command's `input` shape. + * @see {@link PutRecommendationFeedbackCommandOutput} for command's `response` shape. + * @see {@link CodeGuruReviewerClientResolvedConfig | config} for command's `input` shape. + * */ export class PutRecommendationFeedbackCommand extends $Command< PutRecommendationFeedbackCommandInput, diff --git a/clients/client-codeguru-reviewer/commands/TagResourceCommand.ts b/clients/client-codeguru-reviewer/commands/TagResourceCommand.ts index 2dace66d6939..16ee154ce425 100644 --- a/clients/client-codeguru-reviewer/commands/TagResourceCommand.ts +++ b/clients/client-codeguru-reviewer/commands/TagResourceCommand.ts @@ -22,6 +22,20 @@ export interface TagResourceCommandOutput extends TagResourceResponse, __Metadat /** *

Adds one or more tags to an associated repository.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { CodeGuruReviewerClient, TagResourceCommand } from "@aws-sdk/client-codeguru-reviewer"; // ES Modules import + * // const { CodeGuruReviewerClient, TagResourceCommand } = require("@aws-sdk/client-codeguru-reviewer"); // CommonJS import + * const client = new CodeGuruReviewerClient(config); + * const command = new TagResourceCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link TagResourceCommandInput} for command's `input` shape. + * @see {@link TagResourceCommandOutput} for command's `response` shape. + * @see {@link CodeGuruReviewerClientResolvedConfig | config} for command's `input` shape. + * */ export class TagResourceCommand extends $Command< TagResourceCommandInput, diff --git a/clients/client-codeguru-reviewer/commands/UntagResourceCommand.ts b/clients/client-codeguru-reviewer/commands/UntagResourceCommand.ts index 5c945c7023f0..027e174f7f85 100644 --- a/clients/client-codeguru-reviewer/commands/UntagResourceCommand.ts +++ b/clients/client-codeguru-reviewer/commands/UntagResourceCommand.ts @@ -22,6 +22,20 @@ export interface UntagResourceCommandOutput extends UntagResourceResponse, __Met /** *

Removes a tag from an associated repository.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { CodeGuruReviewerClient, UntagResourceCommand } from "@aws-sdk/client-codeguru-reviewer"; // ES Modules import + * // const { CodeGuruReviewerClient, UntagResourceCommand } = require("@aws-sdk/client-codeguru-reviewer"); // CommonJS import + * const client = new CodeGuruReviewerClient(config); + * const command = new UntagResourceCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link UntagResourceCommandInput} for command's `input` shape. + * @see {@link UntagResourceCommandOutput} for command's `response` shape. + * @see {@link CodeGuruReviewerClientResolvedConfig | config} for command's `input` shape. + * */ export class UntagResourceCommand extends $Command< UntagResourceCommandInput, diff --git a/clients/client-codeguru-reviewer/models/models_0.ts b/clients/client-codeguru-reviewer/models/models_0.ts index 7a6059621afa..60a5bc61eabd 100644 --- a/clients/client-codeguru-reviewer/models/models_0.ts +++ b/clients/client-codeguru-reviewer/models/models_0.ts @@ -11,6 +11,9 @@ export interface AccessDeniedException extends __SmithyException, $MetadataBeare } export namespace AccessDeniedException { + /** + * @internal + */ export const filterSensitiveLog = (obj: AccessDeniedException): any => ({ ...obj, }); @@ -48,6 +51,9 @@ export interface KMSKeyDetails { } export namespace KMSKeyDetails { + /** + * @internal + */ export const filterSensitiveLog = (obj: KMSKeyDetails): any => ({ ...obj, }); @@ -88,6 +94,9 @@ export interface ThirdPartySourceRepository { } export namespace ThirdPartySourceRepository { + /** + * @internal + */ export const filterSensitiveLog = (obj: ThirdPartySourceRepository): any => ({ ...obj, }); @@ -107,6 +116,9 @@ export interface CodeCommitRepository { } export namespace CodeCommitRepository { + /** + * @internal + */ export const filterSensitiveLog = (obj: CodeCommitRepository): any => ({ ...obj, }); @@ -141,6 +153,9 @@ export interface Repository { } export namespace Repository { + /** + * @internal + */ export const filterSensitiveLog = (obj: Repository): any => ({ ...obj, }); @@ -195,6 +210,9 @@ export interface AssociateRepositoryRequest { } export namespace AssociateRepositoryRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: AssociateRepositoryRequest): any => ({ ...obj, }); @@ -352,6 +370,9 @@ export interface RepositoryAssociation { } export namespace RepositoryAssociation { + /** + * @internal + */ export const filterSensitiveLog = (obj: RepositoryAssociation): any => ({ ...obj, }); @@ -385,6 +406,9 @@ export interface AssociateRepositoryResponse { } export namespace AssociateRepositoryResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: AssociateRepositoryResponse): any => ({ ...obj, }); @@ -401,6 +425,9 @@ export interface ConflictException extends __SmithyException, $MetadataBearer { } export namespace ConflictException { + /** + * @internal + */ export const filterSensitiveLog = (obj: ConflictException): any => ({ ...obj, }); @@ -416,6 +443,9 @@ export interface InternalServerException extends __SmithyException, $MetadataBea } export namespace InternalServerException { + /** + * @internal + */ export const filterSensitiveLog = (obj: InternalServerException): any => ({ ...obj, }); @@ -431,6 +461,9 @@ export interface ThrottlingException extends __SmithyException, $MetadataBearer } export namespace ThrottlingException { + /** + * @internal + */ export const filterSensitiveLog = (obj: ThrottlingException): any => ({ ...obj, }); @@ -446,6 +479,9 @@ export interface ValidationException extends __SmithyException, $MetadataBearer } export namespace ValidationException { + /** + * @internal + */ export const filterSensitiveLog = (obj: ValidationException): any => ({ ...obj, }); @@ -470,6 +506,9 @@ export interface RepositoryHeadSourceCodeType { } export namespace RepositoryHeadSourceCodeType { + /** + * @internal + */ export const filterSensitiveLog = (obj: RepositoryHeadSourceCodeType): any => ({ ...obj, }); @@ -494,6 +533,9 @@ export interface RepositoryAnalysis { } export namespace RepositoryAnalysis { + /** + * @internal + */ export const filterSensitiveLog = (obj: RepositoryAnalysis): any => ({ ...obj, }); @@ -533,6 +575,9 @@ export interface CodeReviewType { } export namespace CodeReviewType { + /** + * @internal + */ export const filterSensitiveLog = (obj: CodeReviewType): any => ({ ...obj, }); @@ -585,6 +630,9 @@ export interface CreateCodeReviewRequest { } export namespace CreateCodeReviewRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateCodeReviewRequest): any => ({ ...obj, }); @@ -618,6 +666,9 @@ export interface Metrics { } export namespace Metrics { + /** + * @internal + */ export const filterSensitiveLog = (obj: Metrics): any => ({ ...obj, }); @@ -648,6 +699,9 @@ export interface CommitDiffSourceCodeType { } export namespace CommitDiffSourceCodeType { + /** + * @internal + */ export const filterSensitiveLog = (obj: CommitDiffSourceCodeType): any => ({ ...obj, }); @@ -682,6 +736,9 @@ export interface SourceCodeType { } export namespace SourceCodeType { + /** + * @internal + */ export const filterSensitiveLog = (obj: SourceCodeType): any => ({ ...obj, }); @@ -832,6 +889,9 @@ export interface CodeReview { } export namespace CodeReview { + /** + * @internal + */ export const filterSensitiveLog = (obj: CodeReview): any => ({ ...obj, }); @@ -847,6 +907,9 @@ export interface CreateCodeReviewResponse { } export namespace CreateCodeReviewResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateCodeReviewResponse): any => ({ ...obj, }); @@ -864,6 +927,9 @@ export interface ResourceNotFoundException extends __SmithyException, $MetadataB } export namespace ResourceNotFoundException { + /** + * @internal + */ export const filterSensitiveLog = (obj: ResourceNotFoundException): any => ({ ...obj, }); @@ -880,6 +946,9 @@ export interface DescribeCodeReviewRequest { } export namespace DescribeCodeReviewRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeCodeReviewRequest): any => ({ ...obj, }); @@ -895,6 +964,9 @@ export interface DescribeCodeReviewResponse { } export namespace DescribeCodeReviewResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeCodeReviewResponse): any => ({ ...obj, }); @@ -930,6 +1002,9 @@ export interface DescribeRecommendationFeedbackRequest { } export namespace DescribeRecommendationFeedbackRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeRecommendationFeedbackRequest): any => ({ ...obj, }); @@ -996,6 +1071,9 @@ export interface RecommendationFeedback { } export namespace RecommendationFeedback { + /** + * @internal + */ export const filterSensitiveLog = (obj: RecommendationFeedback): any => ({ ...obj, }); @@ -1011,6 +1089,9 @@ export interface DescribeRecommendationFeedbackResponse { } export namespace DescribeRecommendationFeedbackResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeRecommendationFeedbackResponse): any => ({ ...obj, }); @@ -1033,6 +1114,9 @@ export interface DescribeRepositoryAssociationRequest { } export namespace DescribeRepositoryAssociationRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeRepositoryAssociationRequest): any => ({ ...obj, }); @@ -1066,6 +1150,9 @@ export interface DescribeRepositoryAssociationResponse { } export namespace DescribeRepositoryAssociationResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeRepositoryAssociationResponse): any => ({ ...obj, }); @@ -1081,6 +1168,9 @@ export interface NotFoundException extends __SmithyException, $MetadataBearer { } export namespace NotFoundException { + /** + * @internal + */ export const filterSensitiveLog = (obj: NotFoundException): any => ({ ...obj, }); @@ -1103,6 +1193,9 @@ export interface DisassociateRepositoryRequest { } export namespace DisassociateRepositoryRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DisassociateRepositoryRequest): any => ({ ...obj, }); @@ -1136,6 +1229,9 @@ export interface DisassociateRepositoryResponse { } export namespace DisassociateRepositoryResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DisassociateRepositoryResponse): any => ({ ...obj, }); @@ -1210,6 +1306,9 @@ export interface ListCodeReviewsRequest { } export namespace ListCodeReviewsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListCodeReviewsRequest): any => ({ ...obj, }); @@ -1243,6 +1342,9 @@ export interface MetricsSummary { } export namespace MetricsSummary { + /** + * @internal + */ export const filterSensitiveLog = (obj: MetricsSummary): any => ({ ...obj, }); @@ -1356,6 +1458,9 @@ export interface CodeReviewSummary { } export namespace CodeReviewSummary { + /** + * @internal + */ export const filterSensitiveLog = (obj: CodeReviewSummary): any => ({ ...obj, }); @@ -1378,6 +1483,9 @@ export interface ListCodeReviewsResponse { } export namespace ListCodeReviewsResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListCodeReviewsResponse): any => ({ ...obj, }); @@ -1428,6 +1536,9 @@ export interface ListRecommendationFeedbackRequest { } export namespace ListRecommendationFeedbackRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListRecommendationFeedbackRequest): any => ({ ...obj, }); @@ -1467,6 +1578,9 @@ export interface RecommendationFeedbackSummary { } export namespace RecommendationFeedbackSummary { + /** + * @internal + */ export const filterSensitiveLog = (obj: RecommendationFeedbackSummary): any => ({ ...obj, }); @@ -1488,6 +1602,9 @@ export interface ListRecommendationFeedbackResponse { } export namespace ListRecommendationFeedbackResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListRecommendationFeedbackResponse): any => ({ ...obj, }); @@ -1518,6 +1635,9 @@ export interface ListRecommendationsRequest { } export namespace ListRecommendationsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListRecommendationsRequest): any => ({ ...obj, }); @@ -1564,6 +1684,9 @@ export interface RecommendationSummary { } export namespace RecommendationSummary { + /** + * @internal + */ export const filterSensitiveLog = (obj: RecommendationSummary): any => ({ ...obj, }); @@ -1586,6 +1709,9 @@ export interface ListRecommendationsResponse { } export namespace ListRecommendationsResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListRecommendationsResponse): any => ({ ...obj, }); @@ -1696,6 +1822,9 @@ export interface ListRepositoryAssociationsRequest { } export namespace ListRepositoryAssociationsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListRepositoryAssociationsRequest): any => ({ ...obj, }); @@ -1826,6 +1955,9 @@ export interface RepositoryAssociationSummary { } export namespace RepositoryAssociationSummary { + /** + * @internal + */ export const filterSensitiveLog = (obj: RepositoryAssociationSummary): any => ({ ...obj, }); @@ -1847,6 +1979,9 @@ export interface ListRepositoryAssociationsResponse { } export namespace ListRepositoryAssociationsResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListRepositoryAssociationsResponse): any => ({ ...obj, }); @@ -1869,6 +2004,9 @@ export interface ListTagsForResourceRequest { } export namespace ListTagsForResourceRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListTagsForResourceRequest): any => ({ ...obj, }); @@ -1897,6 +2035,9 @@ export interface ListTagsForResourceResponse { } export namespace ListTagsForResourceResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListTagsForResourceResponse): any => ({ ...obj, }); @@ -1927,6 +2068,9 @@ export interface PutRecommendationFeedbackRequest { } export namespace PutRecommendationFeedbackRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: PutRecommendationFeedbackRequest): any => ({ ...obj, }); @@ -1935,6 +2079,9 @@ export namespace PutRecommendationFeedbackRequest { export interface PutRecommendationFeedbackResponse {} export namespace PutRecommendationFeedbackResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: PutRecommendationFeedbackResponse): any => ({ ...obj, }); @@ -1977,6 +2124,9 @@ export interface TagResourceRequest { } export namespace TagResourceRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: TagResourceRequest): any => ({ ...obj, }); @@ -1985,6 +2135,9 @@ export namespace TagResourceRequest { export interface TagResourceResponse {} export namespace TagResourceResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: TagResourceResponse): any => ({ ...obj, }); @@ -2012,6 +2165,9 @@ export interface UntagResourceRequest { } export namespace UntagResourceRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: UntagResourceRequest): any => ({ ...obj, }); @@ -2020,6 +2176,9 @@ export namespace UntagResourceRequest { export interface UntagResourceResponse {} export namespace UntagResourceResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: UntagResourceResponse): any => ({ ...obj, }); diff --git a/clients/client-codeguruprofiler/commands/AddNotificationChannelsCommand.ts b/clients/client-codeguruprofiler/commands/AddNotificationChannelsCommand.ts index 0dc83475dd10..cabb1c9f50cb 100644 --- a/clients/client-codeguruprofiler/commands/AddNotificationChannelsCommand.ts +++ b/clients/client-codeguruprofiler/commands/AddNotificationChannelsCommand.ts @@ -22,6 +22,20 @@ export interface AddNotificationChannelsCommandOutput extends AddNotificationCha /** *

Add up to 2 anomaly notifications channels for a profiling group.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { CodeGuruProfilerClient, AddNotificationChannelsCommand } from "@aws-sdk/client-codeguruprofiler"; // ES Modules import + * // const { CodeGuruProfilerClient, AddNotificationChannelsCommand } = require("@aws-sdk/client-codeguruprofiler"); // CommonJS import + * const client = new CodeGuruProfilerClient(config); + * const command = new AddNotificationChannelsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link AddNotificationChannelsCommandInput} for command's `input` shape. + * @see {@link AddNotificationChannelsCommandOutput} for command's `response` shape. + * @see {@link CodeGuruProfilerClientResolvedConfig | config} for command's `input` shape. + * */ export class AddNotificationChannelsCommand extends $Command< AddNotificationChannelsCommandInput, diff --git a/clients/client-codeguruprofiler/commands/BatchGetFrameMetricDataCommand.ts b/clients/client-codeguruprofiler/commands/BatchGetFrameMetricDataCommand.ts index 8707feea6107..1cce04a4aada 100644 --- a/clients/client-codeguruprofiler/commands/BatchGetFrameMetricDataCommand.ts +++ b/clients/client-codeguruprofiler/commands/BatchGetFrameMetricDataCommand.ts @@ -24,6 +24,20 @@ export interface BatchGetFrameMetricDataCommandOutput extends BatchGetFrameMetri *

* Returns the time series of values for a requested list * of frame metrics from a time period.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { CodeGuruProfilerClient, BatchGetFrameMetricDataCommand } from "@aws-sdk/client-codeguruprofiler"; // ES Modules import + * // const { CodeGuruProfilerClient, BatchGetFrameMetricDataCommand } = require("@aws-sdk/client-codeguruprofiler"); // CommonJS import + * const client = new CodeGuruProfilerClient(config); + * const command = new BatchGetFrameMetricDataCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link BatchGetFrameMetricDataCommandInput} for command's `input` shape. + * @see {@link BatchGetFrameMetricDataCommandOutput} for command's `response` shape. + * @see {@link CodeGuruProfilerClientResolvedConfig | config} for command's `input` shape. + * */ export class BatchGetFrameMetricDataCommand extends $Command< BatchGetFrameMetricDataCommandInput, diff --git a/clients/client-codeguruprofiler/commands/ConfigureAgentCommand.ts b/clients/client-codeguruprofiler/commands/ConfigureAgentCommand.ts index 7e09af94eeb9..6748bb7831f7 100644 --- a/clients/client-codeguruprofiler/commands/ConfigureAgentCommand.ts +++ b/clients/client-codeguruprofiler/commands/ConfigureAgentCommand.ts @@ -26,6 +26,20 @@ export interface ConfigureAgentCommandOutput extends ConfigureAgentResponse, __M * 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. *

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { CodeGuruProfilerClient, ConfigureAgentCommand } from "@aws-sdk/client-codeguruprofiler"; // ES Modules import + * // const { CodeGuruProfilerClient, ConfigureAgentCommand } = require("@aws-sdk/client-codeguruprofiler"); // CommonJS import + * const client = new CodeGuruProfilerClient(config); + * const command = new ConfigureAgentCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ConfigureAgentCommandInput} for command's `input` shape. + * @see {@link ConfigureAgentCommandOutput} for command's `response` shape. + * @see {@link CodeGuruProfilerClientResolvedConfig | config} for command's `input` shape. + * */ export class ConfigureAgentCommand extends $Command< ConfigureAgentCommandInput, diff --git a/clients/client-codeguruprofiler/commands/CreateProfilingGroupCommand.ts b/clients/client-codeguruprofiler/commands/CreateProfilingGroupCommand.ts index 3eafe8874fa0..28697cd2b57b 100644 --- a/clients/client-codeguruprofiler/commands/CreateProfilingGroupCommand.ts +++ b/clients/client-codeguruprofiler/commands/CreateProfilingGroupCommand.ts @@ -22,6 +22,20 @@ export interface CreateProfilingGroupCommandOutput extends CreateProfilingGroupR /** *

Creates a profiling group.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { CodeGuruProfilerClient, CreateProfilingGroupCommand } from "@aws-sdk/client-codeguruprofiler"; // ES Modules import + * // const { CodeGuruProfilerClient, CreateProfilingGroupCommand } = require("@aws-sdk/client-codeguruprofiler"); // CommonJS import + * const client = new CodeGuruProfilerClient(config); + * const command = new CreateProfilingGroupCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreateProfilingGroupCommandInput} for command's `input` shape. + * @see {@link CreateProfilingGroupCommandOutput} for command's `response` shape. + * @see {@link CodeGuruProfilerClientResolvedConfig | config} for command's `input` shape. + * */ export class CreateProfilingGroupCommand extends $Command< CreateProfilingGroupCommandInput, diff --git a/clients/client-codeguruprofiler/commands/DeleteProfilingGroupCommand.ts b/clients/client-codeguruprofiler/commands/DeleteProfilingGroupCommand.ts index 977b4d0e8bf0..27f5740d0e24 100644 --- a/clients/client-codeguruprofiler/commands/DeleteProfilingGroupCommand.ts +++ b/clients/client-codeguruprofiler/commands/DeleteProfilingGroupCommand.ts @@ -22,6 +22,20 @@ export interface DeleteProfilingGroupCommandOutput extends DeleteProfilingGroupR /** *

Deletes a profiling group.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { CodeGuruProfilerClient, DeleteProfilingGroupCommand } from "@aws-sdk/client-codeguruprofiler"; // ES Modules import + * // const { CodeGuruProfilerClient, DeleteProfilingGroupCommand } = require("@aws-sdk/client-codeguruprofiler"); // CommonJS import + * const client = new CodeGuruProfilerClient(config); + * const command = new DeleteProfilingGroupCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteProfilingGroupCommandInput} for command's `input` shape. + * @see {@link DeleteProfilingGroupCommandOutput} for command's `response` shape. + * @see {@link CodeGuruProfilerClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteProfilingGroupCommand extends $Command< DeleteProfilingGroupCommandInput, diff --git a/clients/client-codeguruprofiler/commands/DescribeProfilingGroupCommand.ts b/clients/client-codeguruprofiler/commands/DescribeProfilingGroupCommand.ts index 27dc1b2cff64..8aa585c275de 100644 --- a/clients/client-codeguruprofiler/commands/DescribeProfilingGroupCommand.ts +++ b/clients/client-codeguruprofiler/commands/DescribeProfilingGroupCommand.ts @@ -27,6 +27,20 @@ export interface DescribeProfilingGroupCommandOutput extends DescribeProfilingGr * * object that contains information about the requested profiling group. *

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { CodeGuruProfilerClient, DescribeProfilingGroupCommand } from "@aws-sdk/client-codeguruprofiler"; // ES Modules import + * // const { CodeGuruProfilerClient, DescribeProfilingGroupCommand } = require("@aws-sdk/client-codeguruprofiler"); // CommonJS import + * const client = new CodeGuruProfilerClient(config); + * const command = new DescribeProfilingGroupCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeProfilingGroupCommandInput} for command's `input` shape. + * @see {@link DescribeProfilingGroupCommandOutput} for command's `response` shape. + * @see {@link CodeGuruProfilerClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeProfilingGroupCommand extends $Command< DescribeProfilingGroupCommandInput, diff --git a/clients/client-codeguruprofiler/commands/GetFindingsReportAccountSummaryCommand.ts b/clients/client-codeguruprofiler/commands/GetFindingsReportAccountSummaryCommand.ts index 80c09b85e881..fb07ea43573e 100644 --- a/clients/client-codeguruprofiler/commands/GetFindingsReportAccountSummaryCommand.ts +++ b/clients/client-codeguruprofiler/commands/GetFindingsReportAccountSummaryCommand.ts @@ -30,6 +30,20 @@ export interface GetFindingsReportAccountSummaryCommandOutput * * objects that contain analysis results for all profiling groups in your AWS account. *

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { CodeGuruProfilerClient, GetFindingsReportAccountSummaryCommand } from "@aws-sdk/client-codeguruprofiler"; // ES Modules import + * // const { CodeGuruProfilerClient, GetFindingsReportAccountSummaryCommand } = require("@aws-sdk/client-codeguruprofiler"); // CommonJS import + * const client = new CodeGuruProfilerClient(config); + * const command = new GetFindingsReportAccountSummaryCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetFindingsReportAccountSummaryCommandInput} for command's `input` shape. + * @see {@link GetFindingsReportAccountSummaryCommandOutput} for command's `response` shape. + * @see {@link CodeGuruProfilerClientResolvedConfig | config} for command's `input` shape. + * */ export class GetFindingsReportAccountSummaryCommand extends $Command< GetFindingsReportAccountSummaryCommandInput, diff --git a/clients/client-codeguruprofiler/commands/GetNotificationConfigurationCommand.ts b/clients/client-codeguruprofiler/commands/GetNotificationConfigurationCommand.ts index bb30f45d6311..d2e67fe9b3d3 100644 --- a/clients/client-codeguruprofiler/commands/GetNotificationConfigurationCommand.ts +++ b/clients/client-codeguruprofiler/commands/GetNotificationConfigurationCommand.ts @@ -24,6 +24,20 @@ export interface GetNotificationConfigurationCommandOutput /** *

Get the current configuration for anomaly notifications for a profiling group.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { CodeGuruProfilerClient, GetNotificationConfigurationCommand } from "@aws-sdk/client-codeguruprofiler"; // ES Modules import + * // const { CodeGuruProfilerClient, GetNotificationConfigurationCommand } = require("@aws-sdk/client-codeguruprofiler"); // CommonJS import + * const client = new CodeGuruProfilerClient(config); + * const command = new GetNotificationConfigurationCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetNotificationConfigurationCommandInput} for command's `input` shape. + * @see {@link GetNotificationConfigurationCommandOutput} for command's `response` shape. + * @see {@link CodeGuruProfilerClientResolvedConfig | config} for command's `input` shape. + * */ export class GetNotificationConfigurationCommand extends $Command< GetNotificationConfigurationCommandInput, diff --git a/clients/client-codeguruprofiler/commands/GetPolicyCommand.ts b/clients/client-codeguruprofiler/commands/GetPolicyCommand.ts index 32d04f6d3caa..c76afde2ac46 100644 --- a/clients/client-codeguruprofiler/commands/GetPolicyCommand.ts +++ b/clients/client-codeguruprofiler/commands/GetPolicyCommand.ts @@ -24,6 +24,20 @@ export interface GetPolicyCommandOutput extends GetPolicyResponse, __MetadataBea *

* Returns the JSON-formatted resource-based policy on a profiling group. *

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { CodeGuruProfilerClient, GetPolicyCommand } from "@aws-sdk/client-codeguruprofiler"; // ES Modules import + * // const { CodeGuruProfilerClient, GetPolicyCommand } = require("@aws-sdk/client-codeguruprofiler"); // CommonJS import + * const client = new CodeGuruProfilerClient(config); + * const command = new GetPolicyCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetPolicyCommandInput} for command's `input` shape. + * @see {@link GetPolicyCommandOutput} for command's `response` shape. + * @see {@link CodeGuruProfilerClientResolvedConfig | config} for command's `input` shape. + * */ export class GetPolicyCommand extends $Command< GetPolicyCommandInput, diff --git a/clients/client-codeguruprofiler/commands/GetProfileCommand.ts b/clients/client-codeguruprofiler/commands/GetProfileCommand.ts index 128e442c7fe3..0af6d53fb349 100644 --- a/clients/client-codeguruprofiler/commands/GetProfileCommand.ts +++ b/clients/client-codeguruprofiler/commands/GetProfileCommand.ts @@ -93,6 +93,20 @@ export interface GetProfileCommandOutput extends GetProfileResponse, __MetadataB * * * + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { CodeGuruProfilerClient, GetProfileCommand } from "@aws-sdk/client-codeguruprofiler"; // ES Modules import + * // const { CodeGuruProfilerClient, GetProfileCommand } = require("@aws-sdk/client-codeguruprofiler"); // CommonJS import + * const client = new CodeGuruProfilerClient(config); + * const command = new GetProfileCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetProfileCommandInput} for command's `input` shape. + * @see {@link GetProfileCommandOutput} for command's `response` shape. + * @see {@link CodeGuruProfilerClientResolvedConfig | config} for command's `input` shape. + * */ export class GetProfileCommand extends $Command< GetProfileCommandInput, diff --git a/clients/client-codeguruprofiler/commands/GetRecommendationsCommand.ts b/clients/client-codeguruprofiler/commands/GetRecommendationsCommand.ts index 1f1602ff6e73..d4f7f691178b 100644 --- a/clients/client-codeguruprofiler/commands/GetRecommendationsCommand.ts +++ b/clients/client-codeguruprofiler/commands/GetRecommendationsCommand.ts @@ -33,6 +33,20 @@ export interface GetRecommendationsCommandOutput extends GetRecommendationsRespo * objects that contains details about anomalies detected in the profiling group for the same time period is also * returned. *

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { CodeGuruProfilerClient, GetRecommendationsCommand } from "@aws-sdk/client-codeguruprofiler"; // ES Modules import + * // const { CodeGuruProfilerClient, GetRecommendationsCommand } = require("@aws-sdk/client-codeguruprofiler"); // CommonJS import + * const client = new CodeGuruProfilerClient(config); + * const command = new GetRecommendationsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetRecommendationsCommandInput} for command's `input` shape. + * @see {@link GetRecommendationsCommandOutput} for command's `response` shape. + * @see {@link CodeGuruProfilerClientResolvedConfig | config} for command's `input` shape. + * */ export class GetRecommendationsCommand extends $Command< GetRecommendationsCommandInput, diff --git a/clients/client-codeguruprofiler/commands/ListFindingsReportsCommand.ts b/clients/client-codeguruprofiler/commands/ListFindingsReportsCommand.ts index 34a88d57972a..c5c0a25942ce 100644 --- a/clients/client-codeguruprofiler/commands/ListFindingsReportsCommand.ts +++ b/clients/client-codeguruprofiler/commands/ListFindingsReportsCommand.ts @@ -22,6 +22,20 @@ export interface ListFindingsReportsCommandOutput extends ListFindingsReportsRes /** *

List the available reports for a given profiling group and time range.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { CodeGuruProfilerClient, ListFindingsReportsCommand } from "@aws-sdk/client-codeguruprofiler"; // ES Modules import + * // const { CodeGuruProfilerClient, ListFindingsReportsCommand } = require("@aws-sdk/client-codeguruprofiler"); // CommonJS import + * const client = new CodeGuruProfilerClient(config); + * const command = new ListFindingsReportsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListFindingsReportsCommandInput} for command's `input` shape. + * @see {@link ListFindingsReportsCommandOutput} for command's `response` shape. + * @see {@link CodeGuruProfilerClientResolvedConfig | config} for command's `input` shape. + * */ export class ListFindingsReportsCommand extends $Command< ListFindingsReportsCommandInput, diff --git a/clients/client-codeguruprofiler/commands/ListProfileTimesCommand.ts b/clients/client-codeguruprofiler/commands/ListProfileTimesCommand.ts index 5e7df9f472cd..5b0e4a8c3ef7 100644 --- a/clients/client-codeguruprofiler/commands/ListProfileTimesCommand.ts +++ b/clients/client-codeguruprofiler/commands/ListProfileTimesCommand.ts @@ -23,6 +23,20 @@ export interface ListProfileTimesCommandOutput extends ListProfileTimesResponse, /** *

Lists the start times of the available aggregated profiles of a profiling group * for an aggregation period within the specified time range.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { CodeGuruProfilerClient, ListProfileTimesCommand } from "@aws-sdk/client-codeguruprofiler"; // ES Modules import + * // const { CodeGuruProfilerClient, ListProfileTimesCommand } = require("@aws-sdk/client-codeguruprofiler"); // CommonJS import + * const client = new CodeGuruProfilerClient(config); + * const command = new ListProfileTimesCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListProfileTimesCommandInput} for command's `input` shape. + * @see {@link ListProfileTimesCommandOutput} for command's `response` shape. + * @see {@link CodeGuruProfilerClientResolvedConfig | config} for command's `input` shape. + * */ export class ListProfileTimesCommand extends $Command< ListProfileTimesCommandInput, diff --git a/clients/client-codeguruprofiler/commands/ListProfilingGroupsCommand.ts b/clients/client-codeguruprofiler/commands/ListProfilingGroupsCommand.ts index 1f6bc5759a9f..0590f6848703 100644 --- a/clients/client-codeguruprofiler/commands/ListProfilingGroupsCommand.ts +++ b/clients/client-codeguruprofiler/commands/ListProfilingGroupsCommand.ts @@ -28,6 +28,20 @@ export interface ListProfilingGroupsCommandOutput extends ListProfilingGroupsRes * * objects. *

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { CodeGuruProfilerClient, ListProfilingGroupsCommand } from "@aws-sdk/client-codeguruprofiler"; // ES Modules import + * // const { CodeGuruProfilerClient, ListProfilingGroupsCommand } = require("@aws-sdk/client-codeguruprofiler"); // CommonJS import + * const client = new CodeGuruProfilerClient(config); + * const command = new ListProfilingGroupsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListProfilingGroupsCommandInput} for command's `input` shape. + * @see {@link ListProfilingGroupsCommandOutput} for command's `response` shape. + * @see {@link CodeGuruProfilerClientResolvedConfig | config} for command's `input` shape. + * */ export class ListProfilingGroupsCommand extends $Command< ListProfilingGroupsCommandInput, diff --git a/clients/client-codeguruprofiler/commands/ListTagsForResourceCommand.ts b/clients/client-codeguruprofiler/commands/ListTagsForResourceCommand.ts index 64cc0c5e74a9..5d54f7f61215 100644 --- a/clients/client-codeguruprofiler/commands/ListTagsForResourceCommand.ts +++ b/clients/client-codeguruprofiler/commands/ListTagsForResourceCommand.ts @@ -24,6 +24,20 @@ export interface ListTagsForResourceCommandOutput extends ListTagsForResourceRes *

* Returns a list of the tags that are assigned to a specified resource. *

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { CodeGuruProfilerClient, ListTagsForResourceCommand } from "@aws-sdk/client-codeguruprofiler"; // ES Modules import + * // const { CodeGuruProfilerClient, ListTagsForResourceCommand } = require("@aws-sdk/client-codeguruprofiler"); // CommonJS import + * const client = new CodeGuruProfilerClient(config); + * const command = new ListTagsForResourceCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListTagsForResourceCommandInput} for command's `input` shape. + * @see {@link ListTagsForResourceCommandOutput} for command's `response` shape. + * @see {@link CodeGuruProfilerClientResolvedConfig | config} for command's `input` shape. + * */ export class ListTagsForResourceCommand extends $Command< ListTagsForResourceCommandInput, diff --git a/clients/client-codeguruprofiler/commands/PostAgentProfileCommand.ts b/clients/client-codeguruprofiler/commands/PostAgentProfileCommand.ts index 96bcfee8063c..60a40449e198 100644 --- a/clients/client-codeguruprofiler/commands/PostAgentProfileCommand.ts +++ b/clients/client-codeguruprofiler/commands/PostAgentProfileCommand.ts @@ -28,6 +28,20 @@ export interface PostAgentProfileCommandOutput extends PostAgentProfileResponse, * GetProfile * . *

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { CodeGuruProfilerClient, PostAgentProfileCommand } from "@aws-sdk/client-codeguruprofiler"; // ES Modules import + * // const { CodeGuruProfilerClient, PostAgentProfileCommand } = require("@aws-sdk/client-codeguruprofiler"); // CommonJS import + * const client = new CodeGuruProfilerClient(config); + * const command = new PostAgentProfileCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link PostAgentProfileCommandInput} for command's `input` shape. + * @see {@link PostAgentProfileCommandOutput} for command's `response` shape. + * @see {@link CodeGuruProfilerClientResolvedConfig | config} for command's `input` shape. + * */ export class PostAgentProfileCommand extends $Command< PostAgentProfileCommandInput, diff --git a/clients/client-codeguruprofiler/commands/PutPermissionCommand.ts b/clients/client-codeguruprofiler/commands/PutPermissionCommand.ts index fc17b7b9a7c6..6be1d82f2482 100644 --- a/clients/client-codeguruprofiler/commands/PutPermissionCommand.ts +++ b/clients/client-codeguruprofiler/commands/PutPermissionCommand.ts @@ -47,6 +47,20 @@ export interface PutPermissionCommandOutput extends PutPermissionResponse, __Met *

* The response contains the profiling group's JSON-formatted resource policy. *

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { CodeGuruProfilerClient, PutPermissionCommand } from "@aws-sdk/client-codeguruprofiler"; // ES Modules import + * // const { CodeGuruProfilerClient, PutPermissionCommand } = require("@aws-sdk/client-codeguruprofiler"); // CommonJS import + * const client = new CodeGuruProfilerClient(config); + * const command = new PutPermissionCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link PutPermissionCommandInput} for command's `input` shape. + * @see {@link PutPermissionCommandOutput} for command's `response` shape. + * @see {@link CodeGuruProfilerClientResolvedConfig | config} for command's `input` shape. + * */ export class PutPermissionCommand extends $Command< PutPermissionCommandInput, diff --git a/clients/client-codeguruprofiler/commands/RemoveNotificationChannelCommand.ts b/clients/client-codeguruprofiler/commands/RemoveNotificationChannelCommand.ts index d5f4c75f594c..0e788f13362d 100644 --- a/clients/client-codeguruprofiler/commands/RemoveNotificationChannelCommand.ts +++ b/clients/client-codeguruprofiler/commands/RemoveNotificationChannelCommand.ts @@ -22,6 +22,20 @@ export interface RemoveNotificationChannelCommandOutput extends RemoveNotificati /** *

Remove one anomaly notifications channel for a profiling group.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { CodeGuruProfilerClient, RemoveNotificationChannelCommand } from "@aws-sdk/client-codeguruprofiler"; // ES Modules import + * // const { CodeGuruProfilerClient, RemoveNotificationChannelCommand } = require("@aws-sdk/client-codeguruprofiler"); // CommonJS import + * const client = new CodeGuruProfilerClient(config); + * const command = new RemoveNotificationChannelCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link RemoveNotificationChannelCommandInput} for command's `input` shape. + * @see {@link RemoveNotificationChannelCommandOutput} for command's `response` shape. + * @see {@link CodeGuruProfilerClientResolvedConfig | config} for command's `input` shape. + * */ export class RemoveNotificationChannelCommand extends $Command< RemoveNotificationChannelCommandInput, diff --git a/clients/client-codeguruprofiler/commands/RemovePermissionCommand.ts b/clients/client-codeguruprofiler/commands/RemovePermissionCommand.ts index 03b385a44954..f34733e65c1e 100644 --- a/clients/client-codeguruprofiler/commands/RemovePermissionCommand.ts +++ b/clients/client-codeguruprofiler/commands/RemovePermissionCommand.ts @@ -30,6 +30,20 @@ export interface RemovePermissionCommandOutput extends RemovePermissionResponse, * , and * PostAgentProfile * .

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { CodeGuruProfilerClient, RemovePermissionCommand } from "@aws-sdk/client-codeguruprofiler"; // ES Modules import + * // const { CodeGuruProfilerClient, RemovePermissionCommand } = require("@aws-sdk/client-codeguruprofiler"); // CommonJS import + * const client = new CodeGuruProfilerClient(config); + * const command = new RemovePermissionCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link RemovePermissionCommandInput} for command's `input` shape. + * @see {@link RemovePermissionCommandOutput} for command's `response` shape. + * @see {@link CodeGuruProfilerClientResolvedConfig | config} for command's `input` shape. + * */ export class RemovePermissionCommand extends $Command< RemovePermissionCommandInput, diff --git a/clients/client-codeguruprofiler/commands/SubmitFeedbackCommand.ts b/clients/client-codeguruprofiler/commands/SubmitFeedbackCommand.ts index 615fb7035260..96ff32e98cba 100644 --- a/clients/client-codeguruprofiler/commands/SubmitFeedbackCommand.ts +++ b/clients/client-codeguruprofiler/commands/SubmitFeedbackCommand.ts @@ -23,6 +23,20 @@ export interface SubmitFeedbackCommandOutput extends SubmitFeedbackResponse, __M /** *

Sends feedback to CodeGuru Profiler about whether the anomaly detected by the analysis is * useful or not.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { CodeGuruProfilerClient, SubmitFeedbackCommand } from "@aws-sdk/client-codeguruprofiler"; // ES Modules import + * // const { CodeGuruProfilerClient, SubmitFeedbackCommand } = require("@aws-sdk/client-codeguruprofiler"); // CommonJS import + * const client = new CodeGuruProfilerClient(config); + * const command = new SubmitFeedbackCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link SubmitFeedbackCommandInput} for command's `input` shape. + * @see {@link SubmitFeedbackCommandOutput} for command's `response` shape. + * @see {@link CodeGuruProfilerClientResolvedConfig | config} for command's `input` shape. + * */ export class SubmitFeedbackCommand extends $Command< SubmitFeedbackCommandInput, diff --git a/clients/client-codeguruprofiler/commands/TagResourceCommand.ts b/clients/client-codeguruprofiler/commands/TagResourceCommand.ts index bfc794f59a81..b70aa5716425 100644 --- a/clients/client-codeguruprofiler/commands/TagResourceCommand.ts +++ b/clients/client-codeguruprofiler/commands/TagResourceCommand.ts @@ -24,6 +24,20 @@ export interface TagResourceCommandOutput extends TagResourceResponse, __Metadat *

* Use to assign one or more tags to a resource. *

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { CodeGuruProfilerClient, TagResourceCommand } from "@aws-sdk/client-codeguruprofiler"; // ES Modules import + * // const { CodeGuruProfilerClient, TagResourceCommand } = require("@aws-sdk/client-codeguruprofiler"); // CommonJS import + * const client = new CodeGuruProfilerClient(config); + * const command = new TagResourceCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link TagResourceCommandInput} for command's `input` shape. + * @see {@link TagResourceCommandOutput} for command's `response` shape. + * @see {@link CodeGuruProfilerClientResolvedConfig | config} for command's `input` shape. + * */ export class TagResourceCommand extends $Command< TagResourceCommandInput, diff --git a/clients/client-codeguruprofiler/commands/UntagResourceCommand.ts b/clients/client-codeguruprofiler/commands/UntagResourceCommand.ts index 20b1a072480a..d1fb3cb2840d 100644 --- a/clients/client-codeguruprofiler/commands/UntagResourceCommand.ts +++ b/clients/client-codeguruprofiler/commands/UntagResourceCommand.ts @@ -24,6 +24,20 @@ export interface UntagResourceCommandOutput extends UntagResourceResponse, __Met *

* Use to remove one or more tags from a resource. *

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { CodeGuruProfilerClient, UntagResourceCommand } from "@aws-sdk/client-codeguruprofiler"; // ES Modules import + * // const { CodeGuruProfilerClient, UntagResourceCommand } = require("@aws-sdk/client-codeguruprofiler"); // CommonJS import + * const client = new CodeGuruProfilerClient(config); + * const command = new UntagResourceCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link UntagResourceCommandInput} for command's `input` shape. + * @see {@link UntagResourceCommandOutput} for command's `response` shape. + * @see {@link CodeGuruProfilerClientResolvedConfig | config} for command's `input` shape. + * */ export class UntagResourceCommand extends $Command< UntagResourceCommandInput, diff --git a/clients/client-codeguruprofiler/commands/UpdateProfilingGroupCommand.ts b/clients/client-codeguruprofiler/commands/UpdateProfilingGroupCommand.ts index 0ae2fc59cce2..b4c46f8d4776 100644 --- a/clients/client-codeguruprofiler/commands/UpdateProfilingGroupCommand.ts +++ b/clients/client-codeguruprofiler/commands/UpdateProfilingGroupCommand.ts @@ -22,6 +22,20 @@ export interface UpdateProfilingGroupCommandOutput extends UpdateProfilingGroupR /** *

Updates a profiling group.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { CodeGuruProfilerClient, UpdateProfilingGroupCommand } from "@aws-sdk/client-codeguruprofiler"; // ES Modules import + * // const { CodeGuruProfilerClient, UpdateProfilingGroupCommand } = require("@aws-sdk/client-codeguruprofiler"); // CommonJS import + * const client = new CodeGuruProfilerClient(config); + * const command = new UpdateProfilingGroupCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link UpdateProfilingGroupCommandInput} for command's `input` shape. + * @see {@link UpdateProfilingGroupCommandOutput} for command's `response` shape. + * @see {@link CodeGuruProfilerClientResolvedConfig | config} for command's `input` shape. + * */ export class UpdateProfilingGroupCommand extends $Command< UpdateProfilingGroupCommandInput, diff --git a/clients/client-codeguruprofiler/models/models_0.ts b/clients/client-codeguruprofiler/models/models_0.ts index 1b7aac5a3193..90099e5be3d6 100644 --- a/clients/client-codeguruprofiler/models/models_0.ts +++ b/clients/client-codeguruprofiler/models/models_0.ts @@ -36,6 +36,9 @@ export interface Channel { } export namespace Channel { + /** + * @internal + */ export const filterSensitiveLog = (obj: Channel): any => ({ ...obj, }); @@ -57,6 +60,9 @@ export interface AddNotificationChannelsRequest { } export namespace AddNotificationChannelsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: AddNotificationChannelsRequest): any => ({ ...obj, }); @@ -75,6 +81,9 @@ export interface NotificationConfiguration { } export namespace NotificationConfiguration { + /** + * @internal + */ export const filterSensitiveLog = (obj: NotificationConfiguration): any => ({ ...obj, }); @@ -91,6 +100,9 @@ export interface AddNotificationChannelsResponse { } export namespace AddNotificationChannelsResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: AddNotificationChannelsResponse): any => ({ ...obj, }); @@ -109,6 +121,9 @@ export interface ConflictException extends __SmithyException, $MetadataBearer { } export namespace ConflictException { + /** + * @internal + */ export const filterSensitiveLog = (obj: ConflictException): any => ({ ...obj, }); @@ -125,6 +140,9 @@ export interface InternalServerException extends __SmithyException, $MetadataBea } export namespace InternalServerException { + /** + * @internal + */ export const filterSensitiveLog = (obj: InternalServerException): any => ({ ...obj, }); @@ -140,6 +158,9 @@ export interface ResourceNotFoundException extends __SmithyException, $MetadataB } export namespace ResourceNotFoundException { + /** + * @internal + */ export const filterSensitiveLog = (obj: ResourceNotFoundException): any => ({ ...obj, }); @@ -159,6 +180,9 @@ export interface ServiceQuotaExceededException extends __SmithyException, $Metad } export namespace ServiceQuotaExceededException { + /** + * @internal + */ export const filterSensitiveLog = (obj: ServiceQuotaExceededException): any => ({ ...obj, }); @@ -175,6 +199,9 @@ export interface ThrottlingException extends __SmithyException, $MetadataBearer } export namespace ThrottlingException { + /** + * @internal + */ export const filterSensitiveLog = (obj: ThrottlingException): any => ({ ...obj, }); @@ -190,6 +217,9 @@ export interface ValidationException extends __SmithyException, $MetadataBearer } export namespace ValidationException { + /** + * @internal + */ export const filterSensitiveLog = (obj: ValidationException): any => ({ ...obj, }); @@ -292,6 +322,9 @@ export interface AgentConfiguration { } export namespace AgentConfiguration { + /** + * @internal + */ export const filterSensitiveLog = (obj: AgentConfiguration): any => ({ ...obj, }); @@ -317,6 +350,9 @@ export interface AgentOrchestrationConfig { } export namespace AgentOrchestrationConfig { + /** + * @internal + */ export const filterSensitiveLog = (obj: AgentOrchestrationConfig): any => ({ ...obj, }); @@ -388,6 +424,9 @@ export interface AggregatedProfileTime { } export namespace AggregatedProfileTime { + /** + * @internal + */ export const filterSensitiveLog = (obj: AggregatedProfileTime): any => ({ ...obj, }); @@ -417,6 +456,9 @@ export interface UserFeedback { } export namespace UserFeedback { + /** + * @internal + */ export const filterSensitiveLog = (obj: UserFeedback): any => ({ ...obj, }); @@ -460,6 +502,9 @@ export interface AnomalyInstance { } export namespace AnomalyInstance { + /** + * @internal + */ export const filterSensitiveLog = (obj: AnomalyInstance): any => ({ ...obj, }); @@ -507,6 +552,9 @@ export interface Metric { } export namespace Metric { + /** + * @internal + */ export const filterSensitiveLog = (obj: Metric): any => ({ ...obj, }); @@ -542,6 +590,9 @@ export interface Anomaly { } export namespace Anomaly { + /** + * @internal + */ export const filterSensitiveLog = (obj: Anomaly): any => ({ ...obj, }); @@ -573,6 +624,9 @@ export interface FrameMetric { } export namespace FrameMetric { + /** + * @internal + */ export const filterSensitiveLog = (obj: FrameMetric): any => ({ ...obj, }); @@ -655,6 +709,9 @@ export interface BatchGetFrameMetricDataRequest { } export namespace BatchGetFrameMetricDataRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: BatchGetFrameMetricDataRequest): any => ({ ...obj, }); @@ -679,6 +736,9 @@ export interface TimestampStructure { } export namespace TimestampStructure { + /** + * @internal + */ export const filterSensitiveLog = (obj: TimestampStructure): any => ({ ...obj, }); @@ -706,6 +766,9 @@ export interface FrameMetricDatum { } export namespace FrameMetricDatum { + /** + * @internal + */ export const filterSensitiveLog = (obj: FrameMetricDatum): any => ({ ...obj, }); @@ -783,6 +846,9 @@ export interface BatchGetFrameMetricDataResponse { } export namespace BatchGetFrameMetricDataResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: BatchGetFrameMetricDataResponse): any => ({ ...obj, }); @@ -822,6 +888,9 @@ export interface GetFindingsReportAccountSummaryRequest { } export namespace GetFindingsReportAccountSummaryRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetFindingsReportAccountSummaryRequest): any => ({ ...obj, }); @@ -869,6 +938,9 @@ export interface FindingsReportSummary { } export namespace FindingsReportSummary { + /** + * @internal + */ export const filterSensitiveLog = (obj: FindingsReportSummary): any => ({ ...obj, }); @@ -897,6 +969,9 @@ export interface GetFindingsReportAccountSummaryResponse { } export namespace GetFindingsReportAccountSummaryResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetFindingsReportAccountSummaryResponse): any => ({ ...obj, }); @@ -912,6 +987,9 @@ export interface ListTagsForResourceRequest { } export namespace ListTagsForResourceRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListTagsForResourceRequest): any => ({ ...obj, }); @@ -928,6 +1006,9 @@ export interface ListTagsForResourceResponse { } export namespace ListTagsForResourceResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListTagsForResourceResponse): any => ({ ...obj, }); @@ -1045,6 +1126,9 @@ export interface ConfigureAgentRequest { } export namespace ConfigureAgentRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ConfigureAgentRequest): any => ({ ...obj, }); @@ -1066,6 +1150,9 @@ export interface ConfigureAgentResponse { } export namespace ConfigureAgentResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ConfigureAgentResponse): any => ({ ...obj, }); @@ -1123,6 +1210,9 @@ export interface CreateProfilingGroupRequest { } export namespace CreateProfilingGroupRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateProfilingGroupRequest): any => ({ ...obj, }); @@ -1162,6 +1252,9 @@ export interface ProfilingStatus { } export namespace ProfilingStatus { + /** + * @internal + */ export const filterSensitiveLog = (obj: ProfilingStatus): any => ({ ...obj, }); @@ -1241,6 +1334,9 @@ export interface ProfilingGroupDescription { } export namespace ProfilingGroupDescription { + /** + * @internal + */ export const filterSensitiveLog = (obj: ProfilingGroupDescription): any => ({ ...obj, }); @@ -1260,6 +1356,9 @@ export interface CreateProfilingGroupResponse { } export namespace CreateProfilingGroupResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateProfilingGroupResponse): any => ({ ...obj, }); @@ -1276,6 +1375,9 @@ export interface DeleteProfilingGroupRequest { } export namespace DeleteProfilingGroupRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteProfilingGroupRequest): any => ({ ...obj, }); @@ -1287,6 +1389,9 @@ export namespace DeleteProfilingGroupRequest { export interface DeleteProfilingGroupResponse {} export namespace DeleteProfilingGroupResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteProfilingGroupResponse): any => ({ ...obj, }); @@ -1305,6 +1410,9 @@ export interface DescribeProfilingGroupRequest { } export namespace DescribeProfilingGroupRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeProfilingGroupRequest): any => ({ ...obj, }); @@ -1326,6 +1434,9 @@ export interface DescribeProfilingGroupResponse { } export namespace DescribeProfilingGroupResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeProfilingGroupResponse): any => ({ ...obj, }); @@ -1342,6 +1453,9 @@ export interface GetNotificationConfigurationRequest { } export namespace GetNotificationConfigurationRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetNotificationConfigurationRequest): any => ({ ...obj, }); @@ -1358,6 +1472,9 @@ export interface GetNotificationConfigurationResponse { } export namespace GetNotificationConfigurationResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetNotificationConfigurationResponse): any => ({ ...obj, }); @@ -1376,6 +1493,9 @@ export interface GetPolicyRequest { } export namespace GetPolicyRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetPolicyRequest): any => ({ ...obj, }); @@ -1397,6 +1517,9 @@ export interface GetPolicyResponse { } export namespace GetPolicyResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetPolicyResponse): any => ({ ...obj, }); @@ -1487,6 +1610,9 @@ export interface GetProfileRequest { } export namespace GetProfileRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetProfileRequest): any => ({ ...obj, }); @@ -1515,6 +1641,9 @@ export interface GetProfileResponse { } export namespace GetProfileResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetProfileResponse): any => ({ ...obj, }); @@ -1618,6 +1747,9 @@ export interface GetRecommendationsRequest { } export namespace GetRecommendationsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetRecommendationsRequest): any => ({ ...obj, }); @@ -1676,6 +1808,9 @@ export interface Pattern { } export namespace Pattern { + /** + * @internal + */ export const filterSensitiveLog = (obj: Pattern): any => ({ ...obj, }); @@ -1702,6 +1837,9 @@ export interface Match { } export namespace Match { + /** + * @internal + */ export const filterSensitiveLog = (obj: Match): any => ({ ...obj, }); @@ -1749,6 +1887,9 @@ export interface Recommendation { } export namespace Recommendation { + /** + * @internal + */ export const filterSensitiveLog = (obj: Recommendation): any => ({ ...obj, }); @@ -1795,6 +1936,9 @@ export interface GetRecommendationsResponse { } export namespace GetRecommendationsResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetRecommendationsResponse): any => ({ ...obj, }); @@ -1860,6 +2004,9 @@ export interface ListFindingsReportsRequest { } export namespace ListFindingsReportsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListFindingsReportsRequest): any => ({ ...obj, }); @@ -1884,6 +2031,9 @@ export interface ListFindingsReportsResponse { } export namespace ListFindingsReportsResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListFindingsReportsResponse): any => ({ ...obj, }); @@ -1977,6 +2127,9 @@ export interface ListProfileTimesRequest { } export namespace ListProfileTimesRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListProfileTimesRequest): any => ({ ...obj, }); @@ -1997,6 +2150,9 @@ export interface ProfileTime { } export namespace ProfileTime { + /** + * @internal + */ export const filterSensitiveLog = (obj: ProfileTime): any => ({ ...obj, }); @@ -2023,6 +2179,9 @@ export interface ListProfileTimesResponse { } export namespace ListProfileTimesResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListProfileTimesResponse): any => ({ ...obj, }); @@ -2069,6 +2228,9 @@ export interface ListProfilingGroupsRequest { } export namespace ListProfilingGroupsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListProfilingGroupsRequest): any => ({ ...obj, }); @@ -2115,6 +2277,9 @@ export interface ListProfilingGroupsResponse { } export namespace ListProfilingGroupsResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListProfilingGroupsResponse): any => ({ ...obj, }); @@ -2171,6 +2336,9 @@ export interface PostAgentProfileRequest { } export namespace PostAgentProfileRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: PostAgentProfileRequest): any => ({ ...obj, }); @@ -2182,6 +2350,9 @@ export namespace PostAgentProfileRequest { export interface PostAgentProfileResponse {} export namespace PostAgentProfileResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: PostAgentProfileResponse): any => ({ ...obj, }); @@ -2226,6 +2397,9 @@ export interface PutPermissionRequest { } export namespace PutPermissionRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: PutPermissionRequest): any => ({ ...obj, }); @@ -2252,6 +2426,9 @@ export interface PutPermissionResponse { } export namespace PutPermissionResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: PutPermissionResponse): any => ({ ...obj, }); @@ -2273,6 +2450,9 @@ export interface RemoveNotificationChannelRequest { } export namespace RemoveNotificationChannelRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: RemoveNotificationChannelRequest): any => ({ ...obj, }); @@ -2289,6 +2469,9 @@ export interface RemoveNotificationChannelResponse { } export namespace RemoveNotificationChannelResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: RemoveNotificationChannelResponse): any => ({ ...obj, }); @@ -2324,6 +2507,9 @@ export interface RemovePermissionRequest { } export namespace RemovePermissionRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: RemovePermissionRequest): any => ({ ...obj, }); @@ -2350,6 +2536,9 @@ export interface RemovePermissionResponse { } export namespace RemovePermissionResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: RemovePermissionResponse): any => ({ ...obj, }); @@ -2387,6 +2576,9 @@ export interface SubmitFeedbackRequest { } export namespace SubmitFeedbackRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: SubmitFeedbackRequest): any => ({ ...obj, }); @@ -2398,6 +2590,9 @@ export namespace SubmitFeedbackRequest { export interface SubmitFeedbackResponse {} export namespace SubmitFeedbackResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: SubmitFeedbackResponse): any => ({ ...obj, }); @@ -2421,6 +2616,9 @@ export interface UpdateProfilingGroupRequest { } export namespace UpdateProfilingGroupRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateProfilingGroupRequest): any => ({ ...obj, }); @@ -2442,6 +2640,9 @@ export interface UpdateProfilingGroupResponse { } export namespace UpdateProfilingGroupResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateProfilingGroupResponse): any => ({ ...obj, }); @@ -2464,6 +2665,9 @@ export interface TagResourceRequest { } export namespace TagResourceRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: TagResourceRequest): any => ({ ...obj, }); @@ -2472,6 +2676,9 @@ export namespace TagResourceRequest { export interface TagResourceResponse {} export namespace TagResourceResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: TagResourceResponse): any => ({ ...obj, }); @@ -2495,6 +2702,9 @@ export interface UntagResourceRequest { } export namespace UntagResourceRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: UntagResourceRequest): any => ({ ...obj, }); @@ -2503,6 +2713,9 @@ export namespace UntagResourceRequest { export interface UntagResourceResponse {} export namespace UntagResourceResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: UntagResourceResponse): any => ({ ...obj, }); diff --git a/clients/client-codepipeline/commands/AcknowledgeJobCommand.ts b/clients/client-codepipeline/commands/AcknowledgeJobCommand.ts index 24156183230c..316d15f6ac45 100644 --- a/clients/client-codepipeline/commands/AcknowledgeJobCommand.ts +++ b/clients/client-codepipeline/commands/AcknowledgeJobCommand.ts @@ -23,6 +23,20 @@ export interface AcknowledgeJobCommandOutput extends AcknowledgeJobOutput, __Met /** *

Returns information about a specified job and whether that job has been received by * the job worker. Used for custom actions only.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { CodePipelineClient, AcknowledgeJobCommand } from "@aws-sdk/client-codepipeline"; // ES Modules import + * // const { CodePipelineClient, AcknowledgeJobCommand } = require("@aws-sdk/client-codepipeline"); // CommonJS import + * const client = new CodePipelineClient(config); + * const command = new AcknowledgeJobCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link AcknowledgeJobCommandInput} for command's `input` shape. + * @see {@link AcknowledgeJobCommandOutput} for command's `response` shape. + * @see {@link CodePipelineClientResolvedConfig | config} for command's `input` shape. + * */ export class AcknowledgeJobCommand extends $Command< AcknowledgeJobCommandInput, diff --git a/clients/client-codepipeline/commands/AcknowledgeThirdPartyJobCommand.ts b/clients/client-codepipeline/commands/AcknowledgeThirdPartyJobCommand.ts index 27efab08bd12..e0f9f32a97d8 100644 --- a/clients/client-codepipeline/commands/AcknowledgeThirdPartyJobCommand.ts +++ b/clients/client-codepipeline/commands/AcknowledgeThirdPartyJobCommand.ts @@ -23,6 +23,20 @@ export interface AcknowledgeThirdPartyJobCommandOutput extends AcknowledgeThirdP /** *

Confirms a job worker has received the specified job. Used for partner actions * only.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { CodePipelineClient, AcknowledgeThirdPartyJobCommand } from "@aws-sdk/client-codepipeline"; // ES Modules import + * // const { CodePipelineClient, AcknowledgeThirdPartyJobCommand } = require("@aws-sdk/client-codepipeline"); // CommonJS import + * const client = new CodePipelineClient(config); + * const command = new AcknowledgeThirdPartyJobCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link AcknowledgeThirdPartyJobCommandInput} for command's `input` shape. + * @see {@link AcknowledgeThirdPartyJobCommandOutput} for command's `response` shape. + * @see {@link CodePipelineClientResolvedConfig | config} for command's `input` shape. + * */ export class AcknowledgeThirdPartyJobCommand extends $Command< AcknowledgeThirdPartyJobCommandInput, diff --git a/clients/client-codepipeline/commands/CreateCustomActionTypeCommand.ts b/clients/client-codepipeline/commands/CreateCustomActionTypeCommand.ts index 8e0655ffdce9..5978f3201de0 100644 --- a/clients/client-codepipeline/commands/CreateCustomActionTypeCommand.ts +++ b/clients/client-codepipeline/commands/CreateCustomActionTypeCommand.ts @@ -23,6 +23,20 @@ export interface CreateCustomActionTypeCommandOutput extends CreateCustomActionT /** *

Creates a new custom action that can be used in all pipelines associated with the * AWS account. Only used for custom actions.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { CodePipelineClient, CreateCustomActionTypeCommand } from "@aws-sdk/client-codepipeline"; // ES Modules import + * // const { CodePipelineClient, CreateCustomActionTypeCommand } = require("@aws-sdk/client-codepipeline"); // CommonJS import + * const client = new CodePipelineClient(config); + * const command = new CreateCustomActionTypeCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreateCustomActionTypeCommandInput} for command's `input` shape. + * @see {@link CreateCustomActionTypeCommandOutput} for command's `response` shape. + * @see {@link CodePipelineClientResolvedConfig | config} for command's `input` shape. + * */ export class CreateCustomActionTypeCommand extends $Command< CreateCustomActionTypeCommandInput, diff --git a/clients/client-codepipeline/commands/CreatePipelineCommand.ts b/clients/client-codepipeline/commands/CreatePipelineCommand.ts index e75654b4ade0..5e7104f27468 100644 --- a/clients/client-codepipeline/commands/CreatePipelineCommand.ts +++ b/clients/client-codepipeline/commands/CreatePipelineCommand.ts @@ -28,6 +28,20 @@ export interface CreatePipelineCommandOutput extends CreatePipelineOutput, __Met * create a cross-region action in your pipeline, you must use * artifactStores.

* + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { CodePipelineClient, CreatePipelineCommand } from "@aws-sdk/client-codepipeline"; // ES Modules import + * // const { CodePipelineClient, CreatePipelineCommand } = require("@aws-sdk/client-codepipeline"); // CommonJS import + * const client = new CodePipelineClient(config); + * const command = new CreatePipelineCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreatePipelineCommandInput} for command's `input` shape. + * @see {@link CreatePipelineCommandOutput} for command's `response` shape. + * @see {@link CodePipelineClientResolvedConfig | config} for command's `input` shape. + * */ export class CreatePipelineCommand extends $Command< CreatePipelineCommandInput, diff --git a/clients/client-codepipeline/commands/DeleteCustomActionTypeCommand.ts b/clients/client-codepipeline/commands/DeleteCustomActionTypeCommand.ts index aeb1406cf601..14ebe49aef84 100644 --- a/clients/client-codepipeline/commands/DeleteCustomActionTypeCommand.ts +++ b/clients/client-codepipeline/commands/DeleteCustomActionTypeCommand.ts @@ -30,6 +30,20 @@ export interface DeleteCustomActionTypeCommandOutput extends __MetadataBearer {} * that is identical to the deleted action, including the original string in the * version field.

* + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { CodePipelineClient, DeleteCustomActionTypeCommand } from "@aws-sdk/client-codepipeline"; // ES Modules import + * // const { CodePipelineClient, DeleteCustomActionTypeCommand } = require("@aws-sdk/client-codepipeline"); // CommonJS import + * const client = new CodePipelineClient(config); + * const command = new DeleteCustomActionTypeCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteCustomActionTypeCommandInput} for command's `input` shape. + * @see {@link DeleteCustomActionTypeCommandOutput} for command's `response` shape. + * @see {@link CodePipelineClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteCustomActionTypeCommand extends $Command< DeleteCustomActionTypeCommandInput, diff --git a/clients/client-codepipeline/commands/DeletePipelineCommand.ts b/clients/client-codepipeline/commands/DeletePipelineCommand.ts index 1e0d648d9641..83ad095427f7 100644 --- a/clients/client-codepipeline/commands/DeletePipelineCommand.ts +++ b/clients/client-codepipeline/commands/DeletePipelineCommand.ts @@ -22,6 +22,20 @@ export interface DeletePipelineCommandOutput extends __MetadataBearer {} /** *

Deletes the specified pipeline.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { CodePipelineClient, DeletePipelineCommand } from "@aws-sdk/client-codepipeline"; // ES Modules import + * // const { CodePipelineClient, DeletePipelineCommand } = require("@aws-sdk/client-codepipeline"); // CommonJS import + * const client = new CodePipelineClient(config); + * const command = new DeletePipelineCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeletePipelineCommandInput} for command's `input` shape. + * @see {@link DeletePipelineCommandOutput} for command's `response` shape. + * @see {@link CodePipelineClientResolvedConfig | config} for command's `input` shape. + * */ export class DeletePipelineCommand extends $Command< DeletePipelineCommandInput, diff --git a/clients/client-codepipeline/commands/DeleteWebhookCommand.ts b/clients/client-codepipeline/commands/DeleteWebhookCommand.ts index 8f28db146304..c5f3a66a1231 100644 --- a/clients/client-codepipeline/commands/DeleteWebhookCommand.ts +++ b/clients/client-codepipeline/commands/DeleteWebhookCommand.ts @@ -26,6 +26,20 @@ export interface DeleteWebhookCommandOutput extends DeleteWebhookOutput, __Metad * 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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { CodePipelineClient, DeleteWebhookCommand } from "@aws-sdk/client-codepipeline"; // ES Modules import + * // const { CodePipelineClient, DeleteWebhookCommand } = require("@aws-sdk/client-codepipeline"); // CommonJS import + * const client = new CodePipelineClient(config); + * const command = new DeleteWebhookCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteWebhookCommandInput} for command's `input` shape. + * @see {@link DeleteWebhookCommandOutput} for command's `response` shape. + * @see {@link CodePipelineClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteWebhookCommand extends $Command< DeleteWebhookCommandInput, diff --git a/clients/client-codepipeline/commands/DeregisterWebhookWithThirdPartyCommand.ts b/clients/client-codepipeline/commands/DeregisterWebhookWithThirdPartyCommand.ts index 205649a4c63f..2f36f6d62423 100644 --- a/clients/client-codepipeline/commands/DeregisterWebhookWithThirdPartyCommand.ts +++ b/clients/client-codepipeline/commands/DeregisterWebhookWithThirdPartyCommand.ts @@ -26,6 +26,20 @@ export interface DeregisterWebhookWithThirdPartyCommandOutput *

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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { CodePipelineClient, DeregisterWebhookWithThirdPartyCommand } from "@aws-sdk/client-codepipeline"; // ES Modules import + * // const { CodePipelineClient, DeregisterWebhookWithThirdPartyCommand } = require("@aws-sdk/client-codepipeline"); // CommonJS import + * const client = new CodePipelineClient(config); + * const command = new DeregisterWebhookWithThirdPartyCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeregisterWebhookWithThirdPartyCommandInput} for command's `input` shape. + * @see {@link DeregisterWebhookWithThirdPartyCommandOutput} for command's `response` shape. + * @see {@link CodePipelineClientResolvedConfig | config} for command's `input` shape. + * */ export class DeregisterWebhookWithThirdPartyCommand extends $Command< DeregisterWebhookWithThirdPartyCommandInput, diff --git a/clients/client-codepipeline/commands/DisableStageTransitionCommand.ts b/clients/client-codepipeline/commands/DisableStageTransitionCommand.ts index 098c32b170f1..d4a844248644 100644 --- a/clients/client-codepipeline/commands/DisableStageTransitionCommand.ts +++ b/clients/client-codepipeline/commands/DisableStageTransitionCommand.ts @@ -23,6 +23,20 @@ export interface DisableStageTransitionCommandOutput extends __MetadataBearer {} /** *

Prevents artifacts in a pipeline from transitioning to the next stage in the * pipeline.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { CodePipelineClient, DisableStageTransitionCommand } from "@aws-sdk/client-codepipeline"; // ES Modules import + * // const { CodePipelineClient, DisableStageTransitionCommand } = require("@aws-sdk/client-codepipeline"); // CommonJS import + * const client = new CodePipelineClient(config); + * const command = new DisableStageTransitionCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DisableStageTransitionCommandInput} for command's `input` shape. + * @see {@link DisableStageTransitionCommandOutput} for command's `response` shape. + * @see {@link CodePipelineClientResolvedConfig | config} for command's `input` shape. + * */ export class DisableStageTransitionCommand extends $Command< DisableStageTransitionCommandInput, diff --git a/clients/client-codepipeline/commands/EnableStageTransitionCommand.ts b/clients/client-codepipeline/commands/EnableStageTransitionCommand.ts index 2b3f43710997..928d7cdeefed 100644 --- a/clients/client-codepipeline/commands/EnableStageTransitionCommand.ts +++ b/clients/client-codepipeline/commands/EnableStageTransitionCommand.ts @@ -22,6 +22,20 @@ export interface EnableStageTransitionCommandOutput extends __MetadataBearer {} /** *

Enables artifacts in a pipeline to transition to a stage in a pipeline.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { CodePipelineClient, EnableStageTransitionCommand } from "@aws-sdk/client-codepipeline"; // ES Modules import + * // const { CodePipelineClient, EnableStageTransitionCommand } = require("@aws-sdk/client-codepipeline"); // CommonJS import + * const client = new CodePipelineClient(config); + * const command = new EnableStageTransitionCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link EnableStageTransitionCommandInput} for command's `input` shape. + * @see {@link EnableStageTransitionCommandOutput} for command's `response` shape. + * @see {@link CodePipelineClientResolvedConfig | config} for command's `input` shape. + * */ export class EnableStageTransitionCommand extends $Command< EnableStageTransitionCommandInput, diff --git a/clients/client-codepipeline/commands/GetActionTypeCommand.ts b/clients/client-codepipeline/commands/GetActionTypeCommand.ts index bb989c2e5d8a..36152f3ab37f 100644 --- a/clients/client-codepipeline/commands/GetActionTypeCommand.ts +++ b/clients/client-codepipeline/commands/GetActionTypeCommand.ts @@ -24,6 +24,20 @@ export interface GetActionTypeCommandOutput extends GetActionTypeOutput, __Metad *

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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { CodePipelineClient, GetActionTypeCommand } from "@aws-sdk/client-codepipeline"; // ES Modules import + * // const { CodePipelineClient, GetActionTypeCommand } = require("@aws-sdk/client-codepipeline"); // CommonJS import + * const client = new CodePipelineClient(config); + * const command = new GetActionTypeCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetActionTypeCommandInput} for command's `input` shape. + * @see {@link GetActionTypeCommandOutput} for command's `response` shape. + * @see {@link CodePipelineClientResolvedConfig | config} for command's `input` shape. + * */ export class GetActionTypeCommand extends $Command< GetActionTypeCommandInput, diff --git a/clients/client-codepipeline/commands/GetJobDetailsCommand.ts b/clients/client-codepipeline/commands/GetJobDetailsCommand.ts index c01f2d48de6b..cafb5401c5fd 100644 --- a/clients/client-codepipeline/commands/GetJobDetailsCommand.ts +++ b/clients/client-codepipeline/commands/GetJobDetailsCommand.ts @@ -28,6 +28,20 @@ export interface GetJobDetailsCommandOutput extends GetJobDetailsOutput, __Metad * that S3 bucket for input or output artifacts. This API also returns any secret * values defined for the action.

* + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { CodePipelineClient, GetJobDetailsCommand } from "@aws-sdk/client-codepipeline"; // ES Modules import + * // const { CodePipelineClient, GetJobDetailsCommand } = require("@aws-sdk/client-codepipeline"); // CommonJS import + * const client = new CodePipelineClient(config); + * const command = new GetJobDetailsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetJobDetailsCommandInput} for command's `input` shape. + * @see {@link GetJobDetailsCommandOutput} for command's `response` shape. + * @see {@link CodePipelineClientResolvedConfig | config} for command's `input` shape. + * */ export class GetJobDetailsCommand extends $Command< GetJobDetailsCommandInput, diff --git a/clients/client-codepipeline/commands/GetPipelineCommand.ts b/clients/client-codepipeline/commands/GetPipelineCommand.ts index 7856f6e5c671..35b2f698ce43 100644 --- a/clients/client-codepipeline/commands/GetPipelineCommand.ts +++ b/clients/client-codepipeline/commands/GetPipelineCommand.ts @@ -24,6 +24,20 @@ export interface GetPipelineCommandOutput extends GetPipelineOutput, __MetadataB *

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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { CodePipelineClient, GetPipelineCommand } from "@aws-sdk/client-codepipeline"; // ES Modules import + * // const { CodePipelineClient, GetPipelineCommand } = require("@aws-sdk/client-codepipeline"); // CommonJS import + * const client = new CodePipelineClient(config); + * const command = new GetPipelineCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetPipelineCommandInput} for command's `input` shape. + * @see {@link GetPipelineCommandOutput} for command's `response` shape. + * @see {@link CodePipelineClientResolvedConfig | config} for command's `input` shape. + * */ export class GetPipelineCommand extends $Command< GetPipelineCommandInput, diff --git a/clients/client-codepipeline/commands/GetPipelineExecutionCommand.ts b/clients/client-codepipeline/commands/GetPipelineExecutionCommand.ts index 5d9820628349..8cb5efafdbf6 100644 --- a/clients/client-codepipeline/commands/GetPipelineExecutionCommand.ts +++ b/clients/client-codepipeline/commands/GetPipelineExecutionCommand.ts @@ -24,6 +24,20 @@ export interface GetPipelineExecutionCommandOutput extends GetPipelineExecutionO *

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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { CodePipelineClient, GetPipelineExecutionCommand } from "@aws-sdk/client-codepipeline"; // ES Modules import + * // const { CodePipelineClient, GetPipelineExecutionCommand } = require("@aws-sdk/client-codepipeline"); // CommonJS import + * const client = new CodePipelineClient(config); + * const command = new GetPipelineExecutionCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetPipelineExecutionCommandInput} for command's `input` shape. + * @see {@link GetPipelineExecutionCommandOutput} for command's `response` shape. + * @see {@link CodePipelineClientResolvedConfig | config} for command's `input` shape. + * */ export class GetPipelineExecutionCommand extends $Command< GetPipelineExecutionCommandInput, diff --git a/clients/client-codepipeline/commands/GetPipelineStateCommand.ts b/clients/client-codepipeline/commands/GetPipelineStateCommand.ts index a52f08362a7a..bccb7c45e35d 100644 --- a/clients/client-codepipeline/commands/GetPipelineStateCommand.ts +++ b/clients/client-codepipeline/commands/GetPipelineStateCommand.ts @@ -28,6 +28,20 @@ export interface GetPipelineStateCommandOutput extends GetPipelineStateOutput, _ * fields indicate the source revision information, such as the commit ID, for the * current state.

* + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { CodePipelineClient, GetPipelineStateCommand } from "@aws-sdk/client-codepipeline"; // ES Modules import + * // const { CodePipelineClient, GetPipelineStateCommand } = require("@aws-sdk/client-codepipeline"); // CommonJS import + * const client = new CodePipelineClient(config); + * const command = new GetPipelineStateCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetPipelineStateCommandInput} for command's `input` shape. + * @see {@link GetPipelineStateCommandOutput} for command's `response` shape. + * @see {@link CodePipelineClientResolvedConfig | config} for command's `input` shape. + * */ export class GetPipelineStateCommand extends $Command< GetPipelineStateCommandInput, diff --git a/clients/client-codepipeline/commands/GetThirdPartyJobDetailsCommand.ts b/clients/client-codepipeline/commands/GetThirdPartyJobDetailsCommand.ts index ff7b6e275db6..0b1901293505 100644 --- a/clients/client-codepipeline/commands/GetThirdPartyJobDetailsCommand.ts +++ b/clients/client-codepipeline/commands/GetThirdPartyJobDetailsCommand.ts @@ -29,6 +29,20 @@ export interface GetThirdPartyJobDetailsCommandOutput extends GetThirdPartyJobDe * that S3 bucket for input or output artifacts. This API also returns any secret * values defined for the action.

* + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { CodePipelineClient, GetThirdPartyJobDetailsCommand } from "@aws-sdk/client-codepipeline"; // ES Modules import + * // const { CodePipelineClient, GetThirdPartyJobDetailsCommand } = require("@aws-sdk/client-codepipeline"); // CommonJS import + * const client = new CodePipelineClient(config); + * const command = new GetThirdPartyJobDetailsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetThirdPartyJobDetailsCommandInput} for command's `input` shape. + * @see {@link GetThirdPartyJobDetailsCommandOutput} for command's `response` shape. + * @see {@link CodePipelineClientResolvedConfig | config} for command's `input` shape. + * */ export class GetThirdPartyJobDetailsCommand extends $Command< GetThirdPartyJobDetailsCommandInput, diff --git a/clients/client-codepipeline/commands/ListActionExecutionsCommand.ts b/clients/client-codepipeline/commands/ListActionExecutionsCommand.ts index 6da3751a52fb..b37245b3935f 100644 --- a/clients/client-codepipeline/commands/ListActionExecutionsCommand.ts +++ b/clients/client-codepipeline/commands/ListActionExecutionsCommand.ts @@ -22,6 +22,20 @@ export interface ListActionExecutionsCommandOutput extends ListActionExecutionsO /** *

Lists the action executions that have occurred in a pipeline.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { CodePipelineClient, ListActionExecutionsCommand } from "@aws-sdk/client-codepipeline"; // ES Modules import + * // const { CodePipelineClient, ListActionExecutionsCommand } = require("@aws-sdk/client-codepipeline"); // CommonJS import + * const client = new CodePipelineClient(config); + * const command = new ListActionExecutionsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListActionExecutionsCommandInput} for command's `input` shape. + * @see {@link ListActionExecutionsCommandOutput} for command's `response` shape. + * @see {@link CodePipelineClientResolvedConfig | config} for command's `input` shape. + * */ export class ListActionExecutionsCommand extends $Command< ListActionExecutionsCommandInput, diff --git a/clients/client-codepipeline/commands/ListActionTypesCommand.ts b/clients/client-codepipeline/commands/ListActionTypesCommand.ts index 3e75891a7c2b..f369e810af4f 100644 --- a/clients/client-codepipeline/commands/ListActionTypesCommand.ts +++ b/clients/client-codepipeline/commands/ListActionTypesCommand.ts @@ -23,6 +23,20 @@ export interface ListActionTypesCommandOutput extends ListActionTypesOutput, __M /** *

Gets a summary of all AWS CodePipeline action types associated with your * account.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { CodePipelineClient, ListActionTypesCommand } from "@aws-sdk/client-codepipeline"; // ES Modules import + * // const { CodePipelineClient, ListActionTypesCommand } = require("@aws-sdk/client-codepipeline"); // CommonJS import + * const client = new CodePipelineClient(config); + * const command = new ListActionTypesCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListActionTypesCommandInput} for command's `input` shape. + * @see {@link ListActionTypesCommandOutput} for command's `response` shape. + * @see {@link CodePipelineClientResolvedConfig | config} for command's `input` shape. + * */ export class ListActionTypesCommand extends $Command< ListActionTypesCommandInput, diff --git a/clients/client-codepipeline/commands/ListPipelineExecutionsCommand.ts b/clients/client-codepipeline/commands/ListPipelineExecutionsCommand.ts index 15c7120050bb..f86a688c51f7 100644 --- a/clients/client-codepipeline/commands/ListPipelineExecutionsCommand.ts +++ b/clients/client-codepipeline/commands/ListPipelineExecutionsCommand.ts @@ -22,6 +22,20 @@ export interface ListPipelineExecutionsCommandOutput extends ListPipelineExecuti /** *

Gets a summary of the most recent executions for a pipeline.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { CodePipelineClient, ListPipelineExecutionsCommand } from "@aws-sdk/client-codepipeline"; // ES Modules import + * // const { CodePipelineClient, ListPipelineExecutionsCommand } = require("@aws-sdk/client-codepipeline"); // CommonJS import + * const client = new CodePipelineClient(config); + * const command = new ListPipelineExecutionsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListPipelineExecutionsCommandInput} for command's `input` shape. + * @see {@link ListPipelineExecutionsCommandOutput} for command's `response` shape. + * @see {@link CodePipelineClientResolvedConfig | config} for command's `input` shape. + * */ export class ListPipelineExecutionsCommand extends $Command< ListPipelineExecutionsCommandInput, diff --git a/clients/client-codepipeline/commands/ListPipelinesCommand.ts b/clients/client-codepipeline/commands/ListPipelinesCommand.ts index 9876f37b88f7..d8432dfa7578 100644 --- a/clients/client-codepipeline/commands/ListPipelinesCommand.ts +++ b/clients/client-codepipeline/commands/ListPipelinesCommand.ts @@ -22,6 +22,20 @@ export interface ListPipelinesCommandOutput extends ListPipelinesOutput, __Metad /** *

Gets a summary of all of the pipelines associated with your account.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { CodePipelineClient, ListPipelinesCommand } from "@aws-sdk/client-codepipeline"; // ES Modules import + * // const { CodePipelineClient, ListPipelinesCommand } = require("@aws-sdk/client-codepipeline"); // CommonJS import + * const client = new CodePipelineClient(config); + * const command = new ListPipelinesCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListPipelinesCommandInput} for command's `input` shape. + * @see {@link ListPipelinesCommandOutput} for command's `response` shape. + * @see {@link CodePipelineClientResolvedConfig | config} for command's `input` shape. + * */ export class ListPipelinesCommand extends $Command< ListPipelinesCommandInput, diff --git a/clients/client-codepipeline/commands/ListTagsForResourceCommand.ts b/clients/client-codepipeline/commands/ListTagsForResourceCommand.ts index 4444b8f25fd1..bf40f05b6934 100644 --- a/clients/client-codepipeline/commands/ListTagsForResourceCommand.ts +++ b/clients/client-codepipeline/commands/ListTagsForResourceCommand.ts @@ -23,6 +23,20 @@ export interface ListTagsForResourceCommandOutput extends ListTagsForResourceOut /** *

Gets the set of key-value pairs (metadata) that are used to manage the * resource.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { CodePipelineClient, ListTagsForResourceCommand } from "@aws-sdk/client-codepipeline"; // ES Modules import + * // const { CodePipelineClient, ListTagsForResourceCommand } = require("@aws-sdk/client-codepipeline"); // CommonJS import + * const client = new CodePipelineClient(config); + * const command = new ListTagsForResourceCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListTagsForResourceCommandInput} for command's `input` shape. + * @see {@link ListTagsForResourceCommandOutput} for command's `response` shape. + * @see {@link CodePipelineClientResolvedConfig | config} for command's `input` shape. + * */ export class ListTagsForResourceCommand extends $Command< ListTagsForResourceCommandInput, diff --git a/clients/client-codepipeline/commands/ListWebhooksCommand.ts b/clients/client-codepipeline/commands/ListWebhooksCommand.ts index f02d437a4820..3d562289cbb0 100644 --- a/clients/client-codepipeline/commands/ListWebhooksCommand.ts +++ b/clients/client-codepipeline/commands/ListWebhooksCommand.ts @@ -24,6 +24,20 @@ export interface ListWebhooksCommandOutput extends ListWebhooksOutput, __Metadat *

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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { CodePipelineClient, ListWebhooksCommand } from "@aws-sdk/client-codepipeline"; // ES Modules import + * // const { CodePipelineClient, ListWebhooksCommand } = require("@aws-sdk/client-codepipeline"); // CommonJS import + * const client = new CodePipelineClient(config); + * const command = new ListWebhooksCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListWebhooksCommandInput} for command's `input` shape. + * @see {@link ListWebhooksCommandOutput} for command's `response` shape. + * @see {@link CodePipelineClientResolvedConfig | config} for command's `input` shape. + * */ export class ListWebhooksCommand extends $Command< ListWebhooksCommandInput, diff --git a/clients/client-codepipeline/commands/PollForJobsCommand.ts b/clients/client-codepipeline/commands/PollForJobsCommand.ts index 3a24f95ca1d3..b0f9280f2a6e 100644 --- a/clients/client-codepipeline/commands/PollForJobsCommand.ts +++ b/clients/client-codepipeline/commands/PollForJobsCommand.ts @@ -31,6 +31,20 @@ export interface PollForJobsCommandOutput extends PollForJobsOutput, __MetadataB * that S3 bucket for input or output artifacts. This API also returns any secret * values defined for the action.

* + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { CodePipelineClient, PollForJobsCommand } from "@aws-sdk/client-codepipeline"; // ES Modules import + * // const { CodePipelineClient, PollForJobsCommand } = require("@aws-sdk/client-codepipeline"); // CommonJS import + * const client = new CodePipelineClient(config); + * const command = new PollForJobsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link PollForJobsCommandInput} for command's `input` shape. + * @see {@link PollForJobsCommandOutput} for command's `response` shape. + * @see {@link CodePipelineClientResolvedConfig | config} for command's `input` shape. + * */ export class PollForJobsCommand extends $Command< PollForJobsCommandInput, diff --git a/clients/client-codepipeline/commands/PollForThirdPartyJobsCommand.ts b/clients/client-codepipeline/commands/PollForThirdPartyJobsCommand.ts index 3eb47e3f463d..937a6dc62393 100644 --- a/clients/client-codepipeline/commands/PollForThirdPartyJobsCommand.ts +++ b/clients/client-codepipeline/commands/PollForThirdPartyJobsCommand.ts @@ -28,6 +28,20 @@ export interface PollForThirdPartyJobsCommandOutput extends PollForThirdPartyJob * S3 bucket used to store artifacts for the pipeline, if the action requires access to * that S3 bucket for input or output artifacts.

* + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { CodePipelineClient, PollForThirdPartyJobsCommand } from "@aws-sdk/client-codepipeline"; // ES Modules import + * // const { CodePipelineClient, PollForThirdPartyJobsCommand } = require("@aws-sdk/client-codepipeline"); // CommonJS import + * const client = new CodePipelineClient(config); + * const command = new PollForThirdPartyJobsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link PollForThirdPartyJobsCommandInput} for command's `input` shape. + * @see {@link PollForThirdPartyJobsCommandOutput} for command's `response` shape. + * @see {@link CodePipelineClientResolvedConfig | config} for command's `input` shape. + * */ export class PollForThirdPartyJobsCommand extends $Command< PollForThirdPartyJobsCommandInput, diff --git a/clients/client-codepipeline/commands/PutActionRevisionCommand.ts b/clients/client-codepipeline/commands/PutActionRevisionCommand.ts index 299a1b4271a9..b293a4fe6120 100644 --- a/clients/client-codepipeline/commands/PutActionRevisionCommand.ts +++ b/clients/client-codepipeline/commands/PutActionRevisionCommand.ts @@ -22,6 +22,20 @@ export interface PutActionRevisionCommandOutput extends PutActionRevisionOutput, /** *

Provides information to AWS CodePipeline about new revisions to a source.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { CodePipelineClient, PutActionRevisionCommand } from "@aws-sdk/client-codepipeline"; // ES Modules import + * // const { CodePipelineClient, PutActionRevisionCommand } = require("@aws-sdk/client-codepipeline"); // CommonJS import + * const client = new CodePipelineClient(config); + * const command = new PutActionRevisionCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link PutActionRevisionCommandInput} for command's `input` shape. + * @see {@link PutActionRevisionCommandOutput} for command's `response` shape. + * @see {@link CodePipelineClientResolvedConfig | config} for command's `input` shape. + * */ export class PutActionRevisionCommand extends $Command< PutActionRevisionCommandInput, diff --git a/clients/client-codepipeline/commands/PutApprovalResultCommand.ts b/clients/client-codepipeline/commands/PutApprovalResultCommand.ts index 0ce522560681..ca09d49be808 100644 --- a/clients/client-codepipeline/commands/PutApprovalResultCommand.ts +++ b/clients/client-codepipeline/commands/PutApprovalResultCommand.ts @@ -23,6 +23,20 @@ export interface PutApprovalResultCommandOutput extends PutApprovalResultOutput, /** *

Provides the response to a manual approval request to AWS CodePipeline. Valid * responses include Approved and Rejected.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { CodePipelineClient, PutApprovalResultCommand } from "@aws-sdk/client-codepipeline"; // ES Modules import + * // const { CodePipelineClient, PutApprovalResultCommand } = require("@aws-sdk/client-codepipeline"); // CommonJS import + * const client = new CodePipelineClient(config); + * const command = new PutApprovalResultCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link PutApprovalResultCommandInput} for command's `input` shape. + * @see {@link PutApprovalResultCommandOutput} for command's `response` shape. + * @see {@link CodePipelineClientResolvedConfig | config} for command's `input` shape. + * */ export class PutApprovalResultCommand extends $Command< PutApprovalResultCommandInput, diff --git a/clients/client-codepipeline/commands/PutJobFailureResultCommand.ts b/clients/client-codepipeline/commands/PutJobFailureResultCommand.ts index 0a4ee60afb35..af57296bd858 100644 --- a/clients/client-codepipeline/commands/PutJobFailureResultCommand.ts +++ b/clients/client-codepipeline/commands/PutJobFailureResultCommand.ts @@ -23,6 +23,20 @@ export interface PutJobFailureResultCommandOutput extends __MetadataBearer {} /** *

Represents the failure of a job as returned to the pipeline by a job worker. Used * for custom actions only.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { CodePipelineClient, PutJobFailureResultCommand } from "@aws-sdk/client-codepipeline"; // ES Modules import + * // const { CodePipelineClient, PutJobFailureResultCommand } = require("@aws-sdk/client-codepipeline"); // CommonJS import + * const client = new CodePipelineClient(config); + * const command = new PutJobFailureResultCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link PutJobFailureResultCommandInput} for command's `input` shape. + * @see {@link PutJobFailureResultCommandOutput} for command's `response` shape. + * @see {@link CodePipelineClientResolvedConfig | config} for command's `input` shape. + * */ export class PutJobFailureResultCommand extends $Command< PutJobFailureResultCommandInput, diff --git a/clients/client-codepipeline/commands/PutJobSuccessResultCommand.ts b/clients/client-codepipeline/commands/PutJobSuccessResultCommand.ts index 005a7a673d48..b0bf06c84799 100644 --- a/clients/client-codepipeline/commands/PutJobSuccessResultCommand.ts +++ b/clients/client-codepipeline/commands/PutJobSuccessResultCommand.ts @@ -23,6 +23,20 @@ export interface PutJobSuccessResultCommandOutput extends __MetadataBearer {} /** *

Represents the success of a job as returned to the pipeline by a job worker. Used * for custom actions only.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { CodePipelineClient, PutJobSuccessResultCommand } from "@aws-sdk/client-codepipeline"; // ES Modules import + * // const { CodePipelineClient, PutJobSuccessResultCommand } = require("@aws-sdk/client-codepipeline"); // CommonJS import + * const client = new CodePipelineClient(config); + * const command = new PutJobSuccessResultCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link PutJobSuccessResultCommandInput} for command's `input` shape. + * @see {@link PutJobSuccessResultCommandOutput} for command's `response` shape. + * @see {@link CodePipelineClientResolvedConfig | config} for command's `input` shape. + * */ export class PutJobSuccessResultCommand extends $Command< PutJobSuccessResultCommandInput, diff --git a/clients/client-codepipeline/commands/PutThirdPartyJobFailureResultCommand.ts b/clients/client-codepipeline/commands/PutThirdPartyJobFailureResultCommand.ts index 1eecc8e9b35d..1d6db6cad7c8 100644 --- a/clients/client-codepipeline/commands/PutThirdPartyJobFailureResultCommand.ts +++ b/clients/client-codepipeline/commands/PutThirdPartyJobFailureResultCommand.ts @@ -23,6 +23,20 @@ export interface PutThirdPartyJobFailureResultCommandOutput extends __MetadataBe /** *

Represents the failure of a third party job as returned to the pipeline by a job * worker. Used for partner actions only.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { CodePipelineClient, PutThirdPartyJobFailureResultCommand } from "@aws-sdk/client-codepipeline"; // ES Modules import + * // const { CodePipelineClient, PutThirdPartyJobFailureResultCommand } = require("@aws-sdk/client-codepipeline"); // CommonJS import + * const client = new CodePipelineClient(config); + * const command = new PutThirdPartyJobFailureResultCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link PutThirdPartyJobFailureResultCommandInput} for command's `input` shape. + * @see {@link PutThirdPartyJobFailureResultCommandOutput} for command's `response` shape. + * @see {@link CodePipelineClientResolvedConfig | config} for command's `input` shape. + * */ export class PutThirdPartyJobFailureResultCommand extends $Command< PutThirdPartyJobFailureResultCommandInput, diff --git a/clients/client-codepipeline/commands/PutThirdPartyJobSuccessResultCommand.ts b/clients/client-codepipeline/commands/PutThirdPartyJobSuccessResultCommand.ts index 27f84fd5600a..3f2f0c942cc8 100644 --- a/clients/client-codepipeline/commands/PutThirdPartyJobSuccessResultCommand.ts +++ b/clients/client-codepipeline/commands/PutThirdPartyJobSuccessResultCommand.ts @@ -23,6 +23,20 @@ export interface PutThirdPartyJobSuccessResultCommandOutput extends __MetadataBe /** *

Represents the success of a third party job as returned to the pipeline by a job * worker. Used for partner actions only.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { CodePipelineClient, PutThirdPartyJobSuccessResultCommand } from "@aws-sdk/client-codepipeline"; // ES Modules import + * // const { CodePipelineClient, PutThirdPartyJobSuccessResultCommand } = require("@aws-sdk/client-codepipeline"); // CommonJS import + * const client = new CodePipelineClient(config); + * const command = new PutThirdPartyJobSuccessResultCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link PutThirdPartyJobSuccessResultCommandInput} for command's `input` shape. + * @see {@link PutThirdPartyJobSuccessResultCommandOutput} for command's `response` shape. + * @see {@link CodePipelineClientResolvedConfig | config} for command's `input` shape. + * */ export class PutThirdPartyJobSuccessResultCommand extends $Command< PutThirdPartyJobSuccessResultCommandInput, diff --git a/clients/client-codepipeline/commands/PutWebhookCommand.ts b/clients/client-codepipeline/commands/PutWebhookCommand.ts index f294d86f060a..b794ab7fb475 100644 --- a/clients/client-codepipeline/commands/PutWebhookCommand.ts +++ b/clients/client-codepipeline/commands/PutWebhookCommand.ts @@ -28,6 +28,20 @@ export interface PutWebhookCommandOutput extends PutWebhookOutput, __MetadataBea * 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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { CodePipelineClient, PutWebhookCommand } from "@aws-sdk/client-codepipeline"; // ES Modules import + * // const { CodePipelineClient, PutWebhookCommand } = require("@aws-sdk/client-codepipeline"); // CommonJS import + * const client = new CodePipelineClient(config); + * const command = new PutWebhookCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link PutWebhookCommandInput} for command's `input` shape. + * @see {@link PutWebhookCommandOutput} for command's `response` shape. + * @see {@link CodePipelineClientResolvedConfig | config} for command's `input` shape. + * */ export class PutWebhookCommand extends $Command< PutWebhookCommandInput, diff --git a/clients/client-codepipeline/commands/RegisterWebhookWithThirdPartyCommand.ts b/clients/client-codepipeline/commands/RegisterWebhookWithThirdPartyCommand.ts index 38795775be2f..64ac5a9c6718 100644 --- a/clients/client-codepipeline/commands/RegisterWebhookWithThirdPartyCommand.ts +++ b/clients/client-codepipeline/commands/RegisterWebhookWithThirdPartyCommand.ts @@ -25,6 +25,20 @@ export interface RegisterWebhookWithThirdPartyCommandOutput /** *

Configures a connection between the webhook that was created and the external tool * with events to be detected.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { CodePipelineClient, RegisterWebhookWithThirdPartyCommand } from "@aws-sdk/client-codepipeline"; // ES Modules import + * // const { CodePipelineClient, RegisterWebhookWithThirdPartyCommand } = require("@aws-sdk/client-codepipeline"); // CommonJS import + * const client = new CodePipelineClient(config); + * const command = new RegisterWebhookWithThirdPartyCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link RegisterWebhookWithThirdPartyCommandInput} for command's `input` shape. + * @see {@link RegisterWebhookWithThirdPartyCommandOutput} for command's `response` shape. + * @see {@link CodePipelineClientResolvedConfig | config} for command's `input` shape. + * */ export class RegisterWebhookWithThirdPartyCommand extends $Command< RegisterWebhookWithThirdPartyCommandInput, diff --git a/clients/client-codepipeline/commands/RetryStageExecutionCommand.ts b/clients/client-codepipeline/commands/RetryStageExecutionCommand.ts index 842dc2b8c04d..9aa6a1a89456 100644 --- a/clients/client-codepipeline/commands/RetryStageExecutionCommand.ts +++ b/clients/client-codepipeline/commands/RetryStageExecutionCommand.ts @@ -25,6 +25,20 @@ export interface RetryStageExecutionCommandOutput extends RetryStageExecutionOut * 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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { CodePipelineClient, RetryStageExecutionCommand } from "@aws-sdk/client-codepipeline"; // ES Modules import + * // const { CodePipelineClient, RetryStageExecutionCommand } = require("@aws-sdk/client-codepipeline"); // CommonJS import + * const client = new CodePipelineClient(config); + * const command = new RetryStageExecutionCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link RetryStageExecutionCommandInput} for command's `input` shape. + * @see {@link RetryStageExecutionCommandOutput} for command's `response` shape. + * @see {@link CodePipelineClientResolvedConfig | config} for command's `input` shape. + * */ export class RetryStageExecutionCommand extends $Command< RetryStageExecutionCommandInput, diff --git a/clients/client-codepipeline/commands/StartPipelineExecutionCommand.ts b/clients/client-codepipeline/commands/StartPipelineExecutionCommand.ts index 301bab7b64e8..6c6d3d614a23 100644 --- a/clients/client-codepipeline/commands/StartPipelineExecutionCommand.ts +++ b/clients/client-codepipeline/commands/StartPipelineExecutionCommand.ts @@ -23,6 +23,20 @@ export interface StartPipelineExecutionCommandOutput extends StartPipelineExecut /** *

Starts the specified pipeline. Specifically, it begins processing the latest commit * to the source location specified as part of the pipeline.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { CodePipelineClient, StartPipelineExecutionCommand } from "@aws-sdk/client-codepipeline"; // ES Modules import + * // const { CodePipelineClient, StartPipelineExecutionCommand } = require("@aws-sdk/client-codepipeline"); // CommonJS import + * const client = new CodePipelineClient(config); + * const command = new StartPipelineExecutionCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link StartPipelineExecutionCommandInput} for command's `input` shape. + * @see {@link StartPipelineExecutionCommandOutput} for command's `response` shape. + * @see {@link CodePipelineClientResolvedConfig | config} for command's `input` shape. + * */ export class StartPipelineExecutionCommand extends $Command< StartPipelineExecutionCommandInput, diff --git a/clients/client-codepipeline/commands/StopPipelineExecutionCommand.ts b/clients/client-codepipeline/commands/StopPipelineExecutionCommand.ts index a3d480741ef6..ed9bf8b824c6 100644 --- a/clients/client-codepipeline/commands/StopPipelineExecutionCommand.ts +++ b/clients/client-codepipeline/commands/StopPipelineExecutionCommand.ts @@ -27,6 +27,20 @@ export interface StopPipelineExecutionCommandOutput extends StopPipelineExecutio * pipeline execution is in a Stopping state. After all in-progress actions * are completed or abandoned, the pipeline execution is in a Stopped * state.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { CodePipelineClient, StopPipelineExecutionCommand } from "@aws-sdk/client-codepipeline"; // ES Modules import + * // const { CodePipelineClient, StopPipelineExecutionCommand } = require("@aws-sdk/client-codepipeline"); // CommonJS import + * const client = new CodePipelineClient(config); + * const command = new StopPipelineExecutionCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link StopPipelineExecutionCommandInput} for command's `input` shape. + * @see {@link StopPipelineExecutionCommandOutput} for command's `response` shape. + * @see {@link CodePipelineClientResolvedConfig | config} for command's `input` shape. + * */ export class StopPipelineExecutionCommand extends $Command< StopPipelineExecutionCommandInput, diff --git a/clients/client-codepipeline/commands/TagResourceCommand.ts b/clients/client-codepipeline/commands/TagResourceCommand.ts index 571d5d37f5f8..0132dec5f535 100644 --- a/clients/client-codepipeline/commands/TagResourceCommand.ts +++ b/clients/client-codepipeline/commands/TagResourceCommand.ts @@ -23,6 +23,20 @@ export interface TagResourceCommandOutput extends TagResourceOutput, __MetadataB /** *

Adds to or modifies the tags of the given resource. Tags are metadata that can be used * to manage a resource.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { CodePipelineClient, TagResourceCommand } from "@aws-sdk/client-codepipeline"; // ES Modules import + * // const { CodePipelineClient, TagResourceCommand } = require("@aws-sdk/client-codepipeline"); // CommonJS import + * const client = new CodePipelineClient(config); + * const command = new TagResourceCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link TagResourceCommandInput} for command's `input` shape. + * @see {@link TagResourceCommandOutput} for command's `response` shape. + * @see {@link CodePipelineClientResolvedConfig | config} for command's `input` shape. + * */ export class TagResourceCommand extends $Command< TagResourceCommandInput, diff --git a/clients/client-codepipeline/commands/UntagResourceCommand.ts b/clients/client-codepipeline/commands/UntagResourceCommand.ts index 313b3d4c6166..22083a6e23c3 100644 --- a/clients/client-codepipeline/commands/UntagResourceCommand.ts +++ b/clients/client-codepipeline/commands/UntagResourceCommand.ts @@ -22,6 +22,20 @@ export interface UntagResourceCommandOutput extends UntagResourceOutput, __Metad /** *

Removes tags from an AWS resource.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { CodePipelineClient, UntagResourceCommand } from "@aws-sdk/client-codepipeline"; // ES Modules import + * // const { CodePipelineClient, UntagResourceCommand } = require("@aws-sdk/client-codepipeline"); // CommonJS import + * const client = new CodePipelineClient(config); + * const command = new UntagResourceCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link UntagResourceCommandInput} for command's `input` shape. + * @see {@link UntagResourceCommandOutput} for command's `response` shape. + * @see {@link CodePipelineClientResolvedConfig | config} for command's `input` shape. + * */ export class UntagResourceCommand extends $Command< UntagResourceCommandInput, diff --git a/clients/client-codepipeline/commands/UpdateActionTypeCommand.ts b/clients/client-codepipeline/commands/UpdateActionTypeCommand.ts index 1047892903f6..71d3df9033a3 100644 --- a/clients/client-codepipeline/commands/UpdateActionTypeCommand.ts +++ b/clients/client-codepipeline/commands/UpdateActionTypeCommand.ts @@ -25,6 +25,20 @@ export interface UpdateActionTypeCommandOutput extends __MetadataBearer {} * 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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { CodePipelineClient, UpdateActionTypeCommand } from "@aws-sdk/client-codepipeline"; // ES Modules import + * // const { CodePipelineClient, UpdateActionTypeCommand } = require("@aws-sdk/client-codepipeline"); // CommonJS import + * const client = new CodePipelineClient(config); + * const command = new UpdateActionTypeCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link UpdateActionTypeCommandInput} for command's `input` shape. + * @see {@link UpdateActionTypeCommandOutput} for command's `response` shape. + * @see {@link CodePipelineClientResolvedConfig | config} for command's `input` shape. + * */ export class UpdateActionTypeCommand extends $Command< UpdateActionTypeCommandInput, diff --git a/clients/client-codepipeline/commands/UpdatePipelineCommand.ts b/clients/client-codepipeline/commands/UpdatePipelineCommand.ts index 527e6442c709..2a2adf6d792b 100644 --- a/clients/client-codepipeline/commands/UpdatePipelineCommand.ts +++ b/clients/client-codepipeline/commands/UpdatePipelineCommand.ts @@ -25,6 +25,20 @@ export interface UpdatePipelineCommandOutput extends UpdatePipelineOutput, __Met * 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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { CodePipelineClient, UpdatePipelineCommand } from "@aws-sdk/client-codepipeline"; // ES Modules import + * // const { CodePipelineClient, UpdatePipelineCommand } = require("@aws-sdk/client-codepipeline"); // CommonJS import + * const client = new CodePipelineClient(config); + * const command = new UpdatePipelineCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link UpdatePipelineCommandInput} for command's `input` shape. + * @see {@link UpdatePipelineCommandOutput} for command's `response` shape. + * @see {@link CodePipelineClientResolvedConfig | config} for command's `input` shape. + * */ export class UpdatePipelineCommand extends $Command< UpdatePipelineCommandInput, diff --git a/clients/client-codepipeline/models/models_0.ts b/clients/client-codepipeline/models/models_0.ts index f86d5c41e0a5..b708cc042511 100644 --- a/clients/client-codepipeline/models/models_0.ts +++ b/clients/client-codepipeline/models/models_0.ts @@ -20,6 +20,9 @@ export interface AcknowledgeJobInput { } export namespace AcknowledgeJobInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: AcknowledgeJobInput): any => ({ ...obj, }); @@ -46,6 +49,9 @@ export interface AcknowledgeJobOutput { } export namespace AcknowledgeJobOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: AcknowledgeJobOutput): any => ({ ...obj, }); @@ -64,6 +70,9 @@ export interface InvalidNonceException extends __SmithyException, $MetadataBeare } export namespace InvalidNonceException { + /** + * @internal + */ export const filterSensitiveLog = (obj: InvalidNonceException): any => ({ ...obj, }); @@ -82,6 +91,9 @@ export interface JobNotFoundException extends __SmithyException, $MetadataBearer } export namespace JobNotFoundException { + /** + * @internal + */ export const filterSensitiveLog = (obj: JobNotFoundException): any => ({ ...obj, }); @@ -100,6 +112,9 @@ export interface ValidationException extends __SmithyException, $MetadataBearer } export namespace ValidationException { + /** + * @internal + */ export const filterSensitiveLog = (obj: ValidationException): any => ({ ...obj, }); @@ -128,6 +143,9 @@ export interface AcknowledgeThirdPartyJobInput { } export namespace AcknowledgeThirdPartyJobInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: AcknowledgeThirdPartyJobInput): any => ({ ...obj, }); @@ -144,6 +162,9 @@ export interface AcknowledgeThirdPartyJobOutput { } export namespace AcknowledgeThirdPartyJobOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: AcknowledgeThirdPartyJobOutput): any => ({ ...obj, }); @@ -162,6 +183,9 @@ export interface InvalidClientTokenException extends __SmithyException, $Metadat } export namespace InvalidClientTokenException { + /** + * @internal + */ export const filterSensitiveLog = (obj: InvalidClientTokenException): any => ({ ...obj, }); @@ -187,6 +211,9 @@ export interface ActionConfiguration { } export namespace ActionConfiguration { + /** + * @internal + */ export const filterSensitiveLog = (obj: ActionConfiguration): any => ({ ...obj, }); @@ -250,6 +277,9 @@ export interface ActionConfigurationProperty { } export namespace ActionConfigurationProperty { + /** + * @internal + */ export const filterSensitiveLog = (obj: ActionConfigurationProperty): any => ({ ...obj, }); @@ -272,6 +302,9 @@ export interface ActionContext { } export namespace ActionContext { + /** + * @internal + */ export const filterSensitiveLog = (obj: ActionContext): any => ({ ...obj, }); @@ -337,6 +370,9 @@ export interface ActionTypeId { } export namespace ActionTypeId { + /** + * @internal + */ export const filterSensitiveLog = (obj: ActionTypeId): any => ({ ...obj, }); @@ -359,6 +395,9 @@ export interface InputArtifact { } export namespace InputArtifact { + /** + * @internal + */ export const filterSensitiveLog = (obj: InputArtifact): any => ({ ...obj, }); @@ -381,6 +420,9 @@ export interface OutputArtifact { } export namespace OutputArtifact { + /** + * @internal + */ export const filterSensitiveLog = (obj: OutputArtifact): any => ({ ...obj, }); @@ -454,6 +496,9 @@ export interface ActionDeclaration { } export namespace ActionDeclaration { + /** + * @internal + */ export const filterSensitiveLog = (obj: ActionDeclaration): any => ({ ...obj, }); @@ -475,6 +520,9 @@ export interface ErrorDetails { } export namespace ErrorDetails { + /** + * @internal + */ export const filterSensitiveLog = (obj: ErrorDetails): any => ({ ...obj, }); @@ -553,6 +601,9 @@ export interface ActionExecution { } export namespace ActionExecution { + /** + * @internal + */ export const filterSensitiveLog = (obj: ActionExecution): any => ({ ...obj, }); @@ -574,6 +625,9 @@ export interface S3Location { } export namespace S3Location { + /** + * @internal + */ export const filterSensitiveLog = (obj: S3Location): any => ({ ...obj, }); @@ -595,6 +649,9 @@ export interface ArtifactDetail { } export namespace ArtifactDetail { + /** + * @internal + */ export const filterSensitiveLog = (obj: ArtifactDetail): any => ({ ...obj, }); @@ -645,6 +702,9 @@ export interface ActionExecutionInput { } export namespace ActionExecutionInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: ActionExecutionInput): any => ({ ...obj, }); @@ -672,6 +732,9 @@ export interface ActionExecutionResult { } export namespace ActionExecutionResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: ActionExecutionResult): any => ({ ...obj, }); @@ -702,6 +765,9 @@ export interface ActionExecutionOutput { } export namespace ActionExecutionOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: ActionExecutionOutput): any => ({ ...obj, }); @@ -766,6 +832,9 @@ export interface ActionExecutionDetail { } export namespace ActionExecutionDetail { + /** + * @internal + */ export const filterSensitiveLog = (obj: ActionExecutionDetail): any => ({ ...obj, }); @@ -782,6 +851,9 @@ export interface ActionExecutionFilter { } export namespace ActionExecutionFilter { + /** + * @internal + */ export const filterSensitiveLog = (obj: ActionExecutionFilter): any => ({ ...obj, }); @@ -800,6 +872,9 @@ export interface ActionNotFoundException extends __SmithyException, $MetadataBea } export namespace ActionNotFoundException { + /** + * @internal + */ export const filterSensitiveLog = (obj: ActionNotFoundException): any => ({ ...obj, }); @@ -829,6 +904,9 @@ export interface ActionRevision { } export namespace ActionRevision { + /** + * @internal + */ export const filterSensitiveLog = (obj: ActionRevision): any => ({ ...obj, }); @@ -867,6 +945,9 @@ export interface ActionState { } export namespace ActionState { + /** + * @internal + */ export const filterSensitiveLog = (obj: ActionState): any => ({ ...obj, }); @@ -888,6 +969,9 @@ export interface ArtifactDetails { } export namespace ArtifactDetails { + /** + * @internal + */ export const filterSensitiveLog = (obj: ArtifactDetails): any => ({ ...obj, }); @@ -927,6 +1011,9 @@ export interface ActionTypeSettings { } export namespace ActionTypeSettings { + /** + * @internal + */ export const filterSensitiveLog = (obj: ActionTypeSettings): any => ({ ...obj, }); @@ -963,6 +1050,9 @@ export interface ActionType { } export namespace ActionType { + /** + * @internal + */ export const filterSensitiveLog = (obj: ActionType): any => ({ ...obj, }); @@ -989,6 +1079,9 @@ export interface ActionTypeArtifactDetails { } export namespace ActionTypeArtifactDetails { + /** + * @internal + */ export const filterSensitiveLog = (obj: ActionTypeArtifactDetails): any => ({ ...obj, }); @@ -1013,6 +1106,9 @@ export interface JobWorkerExecutorConfiguration { } export namespace JobWorkerExecutorConfiguration { + /** + * @internal + */ export const filterSensitiveLog = (obj: JobWorkerExecutorConfiguration): any => ({ ...obj, }); @@ -1030,6 +1126,9 @@ export interface LambdaExecutorConfiguration { } export namespace LambdaExecutorConfiguration { + /** + * @internal + */ export const filterSensitiveLog = (obj: LambdaExecutorConfiguration): any => ({ ...obj, }); @@ -1053,6 +1152,9 @@ export interface ExecutorConfiguration { } export namespace ExecutorConfiguration { + /** + * @internal + */ export const filterSensitiveLog = (obj: ExecutorConfiguration): any => ({ ...obj, }); @@ -1102,6 +1204,9 @@ export interface ActionTypeExecutor { } export namespace ActionTypeExecutor { + /** + * @internal + */ export const filterSensitiveLog = (obj: ActionTypeExecutor): any => ({ ...obj, }); @@ -1167,6 +1272,9 @@ export interface ActionTypeIdentifier { } export namespace ActionTypeIdentifier { + /** + * @internal + */ export const filterSensitiveLog = (obj: ActionTypeIdentifier): any => ({ ...obj, }); @@ -1184,6 +1292,9 @@ export interface ActionTypePermissions { } export namespace ActionTypePermissions { + /** + * @internal + */ export const filterSensitiveLog = (obj: ActionTypePermissions): any => ({ ...obj, }); @@ -1231,6 +1342,9 @@ export interface ActionTypeProperty { } export namespace ActionTypeProperty { + /** + * @internal + */ export const filterSensitiveLog = (obj: ActionTypeProperty): any => ({ ...obj, }); @@ -1269,6 +1383,9 @@ export interface ActionTypeUrls { } export namespace ActionTypeUrls { + /** + * @internal + */ export const filterSensitiveLog = (obj: ActionTypeUrls): any => ({ ...obj, }); @@ -1326,6 +1443,9 @@ export interface ActionTypeDeclaration { } export namespace ActionTypeDeclaration { + /** + * @internal + */ export const filterSensitiveLog = (obj: ActionTypeDeclaration): any => ({ ...obj, }); @@ -1344,6 +1464,9 @@ export interface ActionTypeNotFoundException extends __SmithyException, $Metadat } export namespace ActionTypeNotFoundException { + /** + * @internal + */ export const filterSensitiveLog = (obj: ActionTypeNotFoundException): any => ({ ...obj, }); @@ -1362,6 +1485,9 @@ export interface ApprovalAlreadyCompletedException extends __SmithyException, $M } export namespace ApprovalAlreadyCompletedException { + /** + * @internal + */ export const filterSensitiveLog = (obj: ApprovalAlreadyCompletedException): any => ({ ...obj, }); @@ -1389,6 +1515,9 @@ export interface ApprovalResult { } export namespace ApprovalResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: ApprovalResult): any => ({ ...obj, }); @@ -1411,6 +1540,9 @@ export interface S3ArtifactLocation { } export namespace S3ArtifactLocation { + /** + * @internal + */ export const filterSensitiveLog = (obj: S3ArtifactLocation): any => ({ ...obj, }); @@ -1436,6 +1568,9 @@ export interface ArtifactLocation { } export namespace ArtifactLocation { + /** + * @internal + */ export const filterSensitiveLog = (obj: ArtifactLocation): any => ({ ...obj, }); @@ -1464,6 +1599,9 @@ export interface Artifact { } export namespace Artifact { + /** + * @internal + */ export const filterSensitiveLog = (obj: Artifact): any => ({ ...obj, }); @@ -1512,6 +1650,9 @@ export interface ArtifactRevision { } export namespace ArtifactRevision { + /** + * @internal + */ export const filterSensitiveLog = (obj: ArtifactRevision): any => ({ ...obj, }); @@ -1545,6 +1686,9 @@ export interface EncryptionKey { } export namespace EncryptionKey { + /** + * @internal + */ export const filterSensitiveLog = (obj: EncryptionKey): any => ({ ...obj, }); @@ -1587,6 +1731,9 @@ export interface ArtifactStore { } export namespace ArtifactStore { + /** + * @internal + */ export const filterSensitiveLog = (obj: ArtifactStore): any => ({ ...obj, }); @@ -1616,6 +1763,9 @@ export interface AWSSessionCredentials { } export namespace AWSSessionCredentials { + /** + * @internal + */ export const filterSensitiveLog = (obj: AWSSessionCredentials): any => ({ ...obj, ...(obj.accessKeyId && { accessKeyId: SENSITIVE_STRING }), @@ -1644,6 +1794,9 @@ export interface BlockerDeclaration { } export namespace BlockerDeclaration { + /** + * @internal + */ export const filterSensitiveLog = (obj: BlockerDeclaration): any => ({ ...obj, }); @@ -1659,6 +1812,9 @@ export interface ConcurrentModificationException extends __SmithyException, $Met } export namespace ConcurrentModificationException { + /** + * @internal + */ export const filterSensitiveLog = (obj: ConcurrentModificationException): any => ({ ...obj, }); @@ -1680,6 +1836,9 @@ export interface Tag { } export namespace Tag { + /** + * @internal + */ export const filterSensitiveLog = (obj: Tag): any => ({ ...obj, }); @@ -1740,6 +1899,9 @@ export interface CreateCustomActionTypeInput { } export namespace CreateCustomActionTypeInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateCustomActionTypeInput): any => ({ ...obj, }); @@ -1761,6 +1923,9 @@ export interface CreateCustomActionTypeOutput { } export namespace CreateCustomActionTypeOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateCustomActionTypeOutput): any => ({ ...obj, }); @@ -1776,6 +1941,9 @@ export interface InvalidTagsException extends __SmithyException, $MetadataBearer } export namespace InvalidTagsException { + /** + * @internal + */ export const filterSensitiveLog = (obj: InvalidTagsException): any => ({ ...obj, }); @@ -1795,6 +1963,9 @@ export interface LimitExceededException extends __SmithyException, $MetadataBear } export namespace LimitExceededException { + /** + * @internal + */ export const filterSensitiveLog = (obj: LimitExceededException): any => ({ ...obj, }); @@ -1810,6 +1981,9 @@ export interface TooManyTagsException extends __SmithyException, $MetadataBearer } export namespace TooManyTagsException { + /** + * @internal + */ export const filterSensitiveLog = (obj: TooManyTagsException): any => ({ ...obj, }); @@ -1836,6 +2010,9 @@ export interface StageDeclaration { } export namespace StageDeclaration { + /** + * @internal + */ export const filterSensitiveLog = (obj: StageDeclaration): any => ({ ...obj, }); @@ -1896,6 +2073,9 @@ export interface PipelineDeclaration { } export namespace PipelineDeclaration { + /** + * @internal + */ export const filterSensitiveLog = (obj: PipelineDeclaration): any => ({ ...obj, }); @@ -1918,6 +2098,9 @@ export interface CreatePipelineInput { } export namespace CreatePipelineInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreatePipelineInput): any => ({ ...obj, }); @@ -1940,6 +2123,9 @@ export interface CreatePipelineOutput { } export namespace CreatePipelineOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreatePipelineOutput): any => ({ ...obj, }); @@ -1958,6 +2144,9 @@ export interface InvalidActionDeclarationException extends __SmithyException, $M } export namespace InvalidActionDeclarationException { + /** + * @internal + */ export const filterSensitiveLog = (obj: InvalidActionDeclarationException): any => ({ ...obj, }); @@ -1976,6 +2165,9 @@ export interface InvalidBlockerDeclarationException extends __SmithyException, $ } export namespace InvalidBlockerDeclarationException { + /** + * @internal + */ export const filterSensitiveLog = (obj: InvalidBlockerDeclarationException): any => ({ ...obj, }); @@ -1994,6 +2186,9 @@ export interface InvalidStageDeclarationException extends __SmithyException, $Me } export namespace InvalidStageDeclarationException { + /** + * @internal + */ export const filterSensitiveLog = (obj: InvalidStageDeclarationException): any => ({ ...obj, }); @@ -2012,6 +2207,9 @@ export interface InvalidStructureException extends __SmithyException, $MetadataB } export namespace InvalidStructureException { + /** + * @internal + */ export const filterSensitiveLog = (obj: InvalidStructureException): any => ({ ...obj, }); @@ -2030,6 +2228,9 @@ export interface PipelineNameInUseException extends __SmithyException, $Metadata } export namespace PipelineNameInUseException { + /** + * @internal + */ export const filterSensitiveLog = (obj: PipelineNameInUseException): any => ({ ...obj, }); @@ -2059,6 +2260,9 @@ export interface DeleteCustomActionTypeInput { } export namespace DeleteCustomActionTypeInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteCustomActionTypeInput): any => ({ ...obj, }); @@ -2075,6 +2279,9 @@ export interface DeletePipelineInput { } export namespace DeletePipelineInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeletePipelineInput): any => ({ ...obj, }); @@ -2088,6 +2295,9 @@ export interface DeleteWebhookInput { } export namespace DeleteWebhookInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteWebhookInput): any => ({ ...obj, }); @@ -2096,6 +2306,9 @@ export namespace DeleteWebhookInput { export interface DeleteWebhookOutput {} export namespace DeleteWebhookOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteWebhookOutput): any => ({ ...obj, }); @@ -2109,6 +2322,9 @@ export interface DeregisterWebhookWithThirdPartyInput { } export namespace DeregisterWebhookWithThirdPartyInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeregisterWebhookWithThirdPartyInput): any => ({ ...obj, }); @@ -2117,6 +2333,9 @@ export namespace DeregisterWebhookWithThirdPartyInput { export interface DeregisterWebhookWithThirdPartyOutput {} export namespace DeregisterWebhookWithThirdPartyOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeregisterWebhookWithThirdPartyOutput): any => ({ ...obj, }); @@ -2132,6 +2351,9 @@ export interface WebhookNotFoundException extends __SmithyException, $MetadataBe } export namespace WebhookNotFoundException { + /** + * @internal + */ export const filterSensitiveLog = (obj: WebhookNotFoundException): any => ({ ...obj, }); @@ -2175,6 +2397,9 @@ export interface DisableStageTransitionInput { } export namespace DisableStageTransitionInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: DisableStageTransitionInput): any => ({ ...obj, }); @@ -2193,6 +2418,9 @@ export interface PipelineNotFoundException extends __SmithyException, $MetadataB } export namespace PipelineNotFoundException { + /** + * @internal + */ export const filterSensitiveLog = (obj: PipelineNotFoundException): any => ({ ...obj, }); @@ -2211,6 +2439,9 @@ export interface StageNotFoundException extends __SmithyException, $MetadataBear } export namespace StageNotFoundException { + /** + * @internal + */ export const filterSensitiveLog = (obj: StageNotFoundException): any => ({ ...obj, }); @@ -2241,6 +2472,9 @@ export interface EnableStageTransitionInput { } export namespace EnableStageTransitionInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: EnableStageTransitionInput): any => ({ ...obj, }); @@ -2304,6 +2538,9 @@ export interface GetActionTypeInput { } export namespace GetActionTypeInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetActionTypeInput): any => ({ ...obj, }); @@ -2318,6 +2555,9 @@ export interface GetActionTypeOutput { } export namespace GetActionTypeOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetActionTypeOutput): any => ({ ...obj, }); @@ -2334,6 +2574,9 @@ export interface GetJobDetailsInput { } export namespace GetJobDetailsInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetJobDetailsInput): any => ({ ...obj, }); @@ -2350,6 +2593,9 @@ export interface StageContext { } export namespace StageContext { + /** + * @internal + */ export const filterSensitiveLog = (obj: StageContext): any => ({ ...obj, }); @@ -2393,6 +2639,9 @@ export interface PipelineContext { } export namespace PipelineContext { + /** + * @internal + */ export const filterSensitiveLog = (obj: PipelineContext): any => ({ ...obj, }); @@ -2454,6 +2703,9 @@ export interface JobData { } export namespace JobData { + /** + * @internal + */ export const filterSensitiveLog = (obj: JobData): any => ({ ...obj, ...(obj.artifactCredentials && { artifactCredentials: SENSITIVE_STRING }), @@ -2482,6 +2734,9 @@ export interface JobDetails { } export namespace JobDetails { + /** + * @internal + */ export const filterSensitiveLog = (obj: JobDetails): any => ({ ...obj, ...(obj.data && { data: JobData.filterSensitiveLog(obj.data) }), @@ -2503,6 +2758,9 @@ export interface GetJobDetailsOutput { } export namespace GetJobDetailsOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetJobDetailsOutput): any => ({ ...obj, ...(obj.jobDetails && { jobDetails: JobDetails.filterSensitiveLog(obj.jobDetails) }), @@ -2527,6 +2785,9 @@ export interface GetPipelineInput { } export namespace GetPipelineInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetPipelineInput): any => ({ ...obj, }); @@ -2553,6 +2814,9 @@ export interface PipelineMetadata { } export namespace PipelineMetadata { + /** + * @internal + */ export const filterSensitiveLog = (obj: PipelineMetadata): any => ({ ...obj, }); @@ -2576,6 +2840,9 @@ export interface GetPipelineOutput { } export namespace GetPipelineOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetPipelineOutput): any => ({ ...obj, }); @@ -2595,6 +2862,9 @@ export interface PipelineVersionNotFoundException extends __SmithyException, $Me } export namespace PipelineVersionNotFoundException { + /** + * @internal + */ export const filterSensitiveLog = (obj: PipelineVersionNotFoundException): any => ({ ...obj, }); @@ -2617,6 +2887,9 @@ export interface GetPipelineExecutionInput { } export namespace GetPipelineExecutionInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetPipelineExecutionInput): any => ({ ...obj, }); @@ -2698,6 +2971,9 @@ export interface PipelineExecution { } export namespace PipelineExecution { + /** + * @internal + */ export const filterSensitiveLog = (obj: PipelineExecution): any => ({ ...obj, }); @@ -2714,6 +2990,9 @@ export interface GetPipelineExecutionOutput { } export namespace GetPipelineExecutionOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetPipelineExecutionOutput): any => ({ ...obj, }); @@ -2733,6 +3012,9 @@ export interface PipelineExecutionNotFoundException extends __SmithyException, $ } export namespace PipelineExecutionNotFoundException { + /** + * @internal + */ export const filterSensitiveLog = (obj: PipelineExecutionNotFoundException): any => ({ ...obj, }); @@ -2749,6 +3031,9 @@ export interface GetPipelineStateInput { } export namespace GetPipelineStateInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetPipelineStateInput): any => ({ ...obj, }); @@ -2784,6 +3069,9 @@ export interface StageExecution { } export namespace StageExecution { + /** + * @internal + */ export const filterSensitiveLog = (obj: StageExecution): any => ({ ...obj, }); @@ -2818,6 +3106,9 @@ export interface TransitionState { } export namespace TransitionState { + /** + * @internal + */ export const filterSensitiveLog = (obj: TransitionState): any => ({ ...obj, }); @@ -2855,6 +3146,9 @@ export interface StageState { } export namespace StageState { + /** + * @internal + */ export const filterSensitiveLog = (obj: StageState): any => ({ ...obj, }); @@ -2896,6 +3190,9 @@ export interface GetPipelineStateOutput { } export namespace GetPipelineStateOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetPipelineStateOutput): any => ({ ...obj, }); @@ -2918,6 +3215,9 @@ export interface GetThirdPartyJobDetailsInput { } export namespace GetThirdPartyJobDetailsInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetThirdPartyJobDetailsInput): any => ({ ...obj, }); @@ -2984,6 +3284,9 @@ export interface ThirdPartyJobData { } export namespace ThirdPartyJobData { + /** + * @internal + */ export const filterSensitiveLog = (obj: ThirdPartyJobData): any => ({ ...obj, ...(obj.artifactCredentials && { artifactCredentials: SENSITIVE_STRING }), @@ -3013,6 +3316,9 @@ export interface ThirdPartyJobDetails { } export namespace ThirdPartyJobDetails { + /** + * @internal + */ export const filterSensitiveLog = (obj: ThirdPartyJobDetails): any => ({ ...obj, ...(obj.data && { data: ThirdPartyJobData.filterSensitiveLog(obj.data) }), @@ -3031,6 +3337,9 @@ export interface GetThirdPartyJobDetailsOutput { } export namespace GetThirdPartyJobDetailsOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetThirdPartyJobDetailsOutput): any => ({ ...obj, ...(obj.jobDetails && { jobDetails: ThirdPartyJobDetails.filterSensitiveLog(obj.jobDetails) }), @@ -3050,6 +3359,9 @@ export interface InvalidJobException extends __SmithyException, $MetadataBearer } export namespace InvalidJobException { + /** + * @internal + */ export const filterSensitiveLog = (obj: InvalidJobException): any => ({ ...obj, }); @@ -3069,6 +3381,9 @@ export interface InvalidNextTokenException extends __SmithyException, $MetadataB } export namespace InvalidNextTokenException { + /** + * @internal + */ export const filterSensitiveLog = (obj: InvalidNextTokenException): any => ({ ...obj, }); @@ -3105,6 +3420,9 @@ export interface ListActionExecutionsInput { } export namespace ListActionExecutionsInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListActionExecutionsInput): any => ({ ...obj, }); @@ -3125,6 +3443,9 @@ export interface ListActionExecutionsOutput { } export namespace ListActionExecutionsOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListActionExecutionsOutput): any => ({ ...obj, }); @@ -3152,6 +3473,9 @@ export interface ListActionTypesInput { } export namespace ListActionTypesInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListActionTypesInput): any => ({ ...obj, }); @@ -3175,6 +3499,9 @@ export interface ListActionTypesOutput { } export namespace ListActionTypesOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListActionTypesOutput): any => ({ ...obj, }); @@ -3207,6 +3534,9 @@ export interface ListPipelineExecutionsInput { } export namespace ListPipelineExecutionsInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListPipelineExecutionsInput): any => ({ ...obj, }); @@ -3245,6 +3575,9 @@ export interface SourceRevision { } export namespace SourceRevision { + /** + * @internal + */ export const filterSensitiveLog = (obj: SourceRevision): any => ({ ...obj, }); @@ -3261,6 +3594,9 @@ export interface StopExecutionTrigger { } export namespace StopExecutionTrigger { + /** + * @internal + */ export const filterSensitiveLog = (obj: StopExecutionTrigger): any => ({ ...obj, }); @@ -3294,6 +3630,9 @@ export interface ExecutionTrigger { } export namespace ExecutionTrigger { + /** + * @internal + */ export const filterSensitiveLog = (obj: ExecutionTrigger): any => ({ ...obj, }); @@ -3368,6 +3707,9 @@ export interface PipelineExecutionSummary { } export namespace PipelineExecutionSummary { + /** + * @internal + */ export const filterSensitiveLog = (obj: PipelineExecutionSummary): any => ({ ...obj, }); @@ -3391,6 +3733,9 @@ export interface ListPipelineExecutionsOutput { } export namespace ListPipelineExecutionsOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListPipelineExecutionsOutput): any => ({ ...obj, }); @@ -3415,6 +3760,9 @@ export interface ListPipelinesInput { } export namespace ListPipelinesInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListPipelinesInput): any => ({ ...obj, }); @@ -3447,6 +3795,9 @@ export interface PipelineSummary { } export namespace PipelineSummary { + /** + * @internal + */ export const filterSensitiveLog = (obj: PipelineSummary): any => ({ ...obj, }); @@ -3470,6 +3821,9 @@ export interface ListPipelinesOutput { } export namespace ListPipelinesOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListPipelinesOutput): any => ({ ...obj, }); @@ -3485,6 +3839,9 @@ export interface InvalidArnException extends __SmithyException, $MetadataBearer } export namespace InvalidArnException { + /** + * @internal + */ export const filterSensitiveLog = (obj: InvalidArnException): any => ({ ...obj, }); @@ -3510,6 +3867,9 @@ export interface ListTagsForResourceInput { } export namespace ListTagsForResourceInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListTagsForResourceInput): any => ({ ...obj, }); @@ -3531,6 +3891,9 @@ export interface ListTagsForResourceOutput { } export namespace ListTagsForResourceOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListTagsForResourceOutput): any => ({ ...obj, }); @@ -3549,6 +3912,9 @@ export interface ResourceNotFoundException extends __SmithyException, $MetadataB } export namespace ResourceNotFoundException { + /** + * @internal + */ export const filterSensitiveLog = (obj: ResourceNotFoundException): any => ({ ...obj, }); @@ -3569,6 +3935,9 @@ export interface ListWebhooksInput { } export namespace ListWebhooksInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListWebhooksInput): any => ({ ...obj, }); @@ -3599,6 +3968,9 @@ export interface WebhookAuthConfiguration { } export namespace WebhookAuthConfiguration { + /** + * @internal + */ export const filterSensitiveLog = (obj: WebhookAuthConfiguration): any => ({ ...obj, }); @@ -3632,6 +4004,9 @@ export interface WebhookFilterRule { } export namespace WebhookFilterRule { + /** + * @internal + */ export const filterSensitiveLog = (obj: WebhookFilterRule): any => ({ ...obj, }); @@ -3696,6 +4071,9 @@ export interface WebhookDefinition { } export namespace WebhookDefinition { + /** + * @internal + */ export const filterSensitiveLog = (obj: WebhookDefinition): any => ({ ...obj, }); @@ -3748,6 +4126,9 @@ export interface ListWebhookItem { } export namespace ListWebhookItem { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListWebhookItem): any => ({ ...obj, }); @@ -3769,6 +4150,9 @@ export interface ListWebhooksOutput { } export namespace ListWebhooksOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListWebhooksOutput): any => ({ ...obj, }); @@ -3798,6 +4182,9 @@ export interface PollForJobsInput { } export namespace PollForJobsInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: PollForJobsInput): any => ({ ...obj, }); @@ -3830,6 +4217,9 @@ export interface Job { } export namespace Job { + /** + * @internal + */ export const filterSensitiveLog = (obj: Job): any => ({ ...obj, ...(obj.data && { data: JobData.filterSensitiveLog(obj.data) }), @@ -3847,6 +4237,9 @@ export interface PollForJobsOutput { } export namespace PollForJobsOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: PollForJobsOutput): any => ({ ...obj, ...(obj.jobs && { jobs: obj.jobs.map((item) => Job.filterSensitiveLog(item)) }), @@ -3869,6 +4262,9 @@ export interface PollForThirdPartyJobsInput { } export namespace PollForThirdPartyJobsInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: PollForThirdPartyJobsInput): any => ({ ...obj, }); @@ -3893,6 +4289,9 @@ export interface ThirdPartyJob { } export namespace ThirdPartyJob { + /** + * @internal + */ export const filterSensitiveLog = (obj: ThirdPartyJob): any => ({ ...obj, }); @@ -3909,6 +4308,9 @@ export interface PollForThirdPartyJobsOutput { } export namespace PollForThirdPartyJobsOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: PollForThirdPartyJobsOutput): any => ({ ...obj, }); @@ -3941,6 +4343,9 @@ export interface PutActionRevisionInput { } export namespace PutActionRevisionInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: PutActionRevisionInput): any => ({ ...obj, }); @@ -3963,6 +4368,9 @@ export interface PutActionRevisionOutput { } export namespace PutActionRevisionOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: PutActionRevisionOutput): any => ({ ...obj, }); @@ -3981,6 +4389,9 @@ export interface InvalidApprovalTokenException extends __SmithyException, $Metad } export namespace InvalidApprovalTokenException { + /** + * @internal + */ export const filterSensitiveLog = (obj: InvalidApprovalTokenException): any => ({ ...obj, }); @@ -4019,6 +4430,9 @@ export interface PutApprovalResultInput { } export namespace PutApprovalResultInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: PutApprovalResultInput): any => ({ ...obj, }); @@ -4035,6 +4449,9 @@ export interface PutApprovalResultOutput { } export namespace PutApprovalResultOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: PutApprovalResultOutput): any => ({ ...obj, }); @@ -4053,6 +4470,9 @@ export interface InvalidJobStateException extends __SmithyException, $MetadataBe } export namespace InvalidJobStateException { + /** + * @internal + */ export const filterSensitiveLog = (obj: InvalidJobStateException): any => ({ ...obj, }); @@ -4088,6 +4508,9 @@ export interface FailureDetails { } export namespace FailureDetails { + /** + * @internal + */ export const filterSensitiveLog = (obj: FailureDetails): any => ({ ...obj, }); @@ -4110,6 +4533,9 @@ export interface PutJobFailureResultInput { } export namespace PutJobFailureResultInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: PutJobFailureResultInput): any => ({ ...obj, }); @@ -4125,6 +4551,9 @@ export interface OutputVariablesSizeExceededException extends __SmithyException, } export namespace OutputVariablesSizeExceededException { + /** + * @internal + */ export const filterSensitiveLog = (obj: OutputVariablesSizeExceededException): any => ({ ...obj, }); @@ -4157,6 +4586,9 @@ export interface CurrentRevision { } export namespace CurrentRevision { + /** + * @internal + */ export const filterSensitiveLog = (obj: CurrentRevision): any => ({ ...obj, }); @@ -4186,6 +4618,9 @@ export interface ExecutionDetails { } export namespace ExecutionDetails { + /** + * @internal + */ export const filterSensitiveLog = (obj: ExecutionDetails): any => ({ ...obj, }); @@ -4231,6 +4666,9 @@ export interface PutJobSuccessResultInput { } export namespace PutJobSuccessResultInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: PutJobSuccessResultInput): any => ({ ...obj, }); @@ -4260,6 +4698,9 @@ export interface PutThirdPartyJobFailureResultInput { } export namespace PutThirdPartyJobFailureResultInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: PutThirdPartyJobFailureResultInput): any => ({ ...obj, }); @@ -4304,6 +4745,9 @@ export interface PutThirdPartyJobSuccessResultInput { } export namespace PutThirdPartyJobSuccessResultInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: PutThirdPartyJobSuccessResultInput): any => ({ ...obj, }); @@ -4322,6 +4766,9 @@ export interface InvalidWebhookAuthenticationParametersException extends __Smith } export namespace InvalidWebhookAuthenticationParametersException { + /** + * @internal + */ export const filterSensitiveLog = (obj: InvalidWebhookAuthenticationParametersException): any => ({ ...obj, }); @@ -4340,6 +4787,9 @@ export interface InvalidWebhookFilterPatternException extends __SmithyException, } export namespace InvalidWebhookFilterPatternException { + /** + * @internal + */ export const filterSensitiveLog = (obj: InvalidWebhookFilterPatternException): any => ({ ...obj, }); @@ -4361,6 +4811,9 @@ export interface PutWebhookInput { } export namespace PutWebhookInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: PutWebhookInput): any => ({ ...obj, }); @@ -4375,6 +4828,9 @@ export interface PutWebhookOutput { } export namespace PutWebhookOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: PutWebhookOutput): any => ({ ...obj, }); @@ -4389,6 +4845,9 @@ export interface RegisterWebhookWithThirdPartyInput { } export namespace RegisterWebhookWithThirdPartyInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: RegisterWebhookWithThirdPartyInput): any => ({ ...obj, }); @@ -4397,6 +4856,9 @@ export namespace RegisterWebhookWithThirdPartyInput { export interface RegisterWebhookWithThirdPartyOutput {} export namespace RegisterWebhookWithThirdPartyOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: RegisterWebhookWithThirdPartyOutput): any => ({ ...obj, }); @@ -4413,6 +4875,9 @@ export interface ConflictException extends __SmithyException, $MetadataBearer { } export namespace ConflictException { + /** + * @internal + */ export const filterSensitiveLog = (obj: ConflictException): any => ({ ...obj, }); @@ -4432,6 +4897,9 @@ export interface NotLatestPipelineExecutionException extends __SmithyException, } export namespace NotLatestPipelineExecutionException { + /** + * @internal + */ export const filterSensitiveLog = (obj: NotLatestPipelineExecutionException): any => ({ ...obj, }); @@ -4469,6 +4937,9 @@ export interface RetryStageExecutionInput { } export namespace RetryStageExecutionInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: RetryStageExecutionInput): any => ({ ...obj, }); @@ -4485,6 +4956,9 @@ export interface RetryStageExecutionOutput { } export namespace RetryStageExecutionOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: RetryStageExecutionOutput): any => ({ ...obj, }); @@ -4505,6 +4979,9 @@ export interface StageNotRetryableException extends __SmithyException, $Metadata } export namespace StageNotRetryableException { + /** + * @internal + */ export const filterSensitiveLog = (obj: StageNotRetryableException): any => ({ ...obj, }); @@ -4527,6 +5004,9 @@ export interface StartPipelineExecutionInput { } export namespace StartPipelineExecutionInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: StartPipelineExecutionInput): any => ({ ...obj, }); @@ -4544,6 +5024,9 @@ export interface StartPipelineExecutionOutput { } export namespace StartPipelineExecutionOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: StartPipelineExecutionOutput): any => ({ ...obj, }); @@ -4563,6 +5046,9 @@ export interface DuplicatedStopRequestException extends __SmithyException, $Meta } export namespace DuplicatedStopRequestException { + /** + * @internal + */ export const filterSensitiveLog = (obj: DuplicatedStopRequestException): any => ({ ...obj, }); @@ -4579,6 +5065,9 @@ export interface PipelineExecutionNotStoppableException extends __SmithyExceptio } export namespace PipelineExecutionNotStoppableException { + /** + * @internal + */ export const filterSensitiveLog = (obj: PipelineExecutionNotStoppableException): any => ({ ...obj, }); @@ -4613,6 +5102,9 @@ export interface StopPipelineExecutionInput { } export namespace StopPipelineExecutionInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: StopPipelineExecutionInput): any => ({ ...obj, }); @@ -4626,6 +5118,9 @@ export interface StopPipelineExecutionOutput { } export namespace StopPipelineExecutionOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: StopPipelineExecutionOutput): any => ({ ...obj, }); @@ -4644,6 +5139,9 @@ export interface TagResourceInput { } export namespace TagResourceInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: TagResourceInput): any => ({ ...obj, }); @@ -4652,6 +5150,9 @@ export namespace TagResourceInput { export interface TagResourceOutput {} export namespace TagResourceOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: TagResourceOutput): any => ({ ...obj, }); @@ -4670,6 +5171,9 @@ export interface UntagResourceInput { } export namespace UntagResourceInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: UntagResourceInput): any => ({ ...obj, }); @@ -4678,6 +5182,9 @@ export namespace UntagResourceInput { export interface UntagResourceOutput {} export namespace UntagResourceOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: UntagResourceOutput): any => ({ ...obj, }); @@ -4693,6 +5200,9 @@ export interface RequestFailedException extends __SmithyException, $MetadataBear } export namespace RequestFailedException { + /** + * @internal + */ export const filterSensitiveLog = (obj: RequestFailedException): any => ({ ...obj, }); @@ -4706,6 +5216,9 @@ export interface UpdateActionTypeInput { } export namespace UpdateActionTypeInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateActionTypeInput): any => ({ ...obj, }); @@ -4722,6 +5235,9 @@ export interface UpdatePipelineInput { } export namespace UpdatePipelineInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdatePipelineInput): any => ({ ...obj, }); @@ -4738,6 +5254,9 @@ export interface UpdatePipelineOutput { } export namespace UpdatePipelineOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdatePipelineOutput): any => ({ ...obj, }); diff --git a/clients/client-codestar-connections/commands/CreateConnectionCommand.ts b/clients/client-codestar-connections/commands/CreateConnectionCommand.ts index c1dd0f882a38..d695a27d7ba8 100644 --- a/clients/client-codestar-connections/commands/CreateConnectionCommand.ts +++ b/clients/client-codestar-connections/commands/CreateConnectionCommand.ts @@ -28,6 +28,20 @@ export interface CreateConnectionCommandOutput extends CreateConnectionOutput, _ *

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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { CodeStarConnectionsClient, CreateConnectionCommand } from "@aws-sdk/client-codestar-connections"; // ES Modules import + * // const { CodeStarConnectionsClient, CreateConnectionCommand } = require("@aws-sdk/client-codestar-connections"); // CommonJS import + * const client = new CodeStarConnectionsClient(config); + * const command = new CreateConnectionCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreateConnectionCommandInput} for command's `input` shape. + * @see {@link CreateConnectionCommandOutput} for command's `response` shape. + * @see {@link CodeStarConnectionsClientResolvedConfig | config} for command's `input` shape. + * */ export class CreateConnectionCommand extends $Command< CreateConnectionCommandInput, diff --git a/clients/client-codestar-connections/commands/CreateHostCommand.ts b/clients/client-codestar-connections/commands/CreateHostCommand.ts index 8fa8403ef24e..cededa90043d 100644 --- a/clients/client-codestar-connections/commands/CreateHostCommand.ts +++ b/clients/client-codestar-connections/commands/CreateHostCommand.ts @@ -33,6 +33,20 @@ export interface CreateHostCommandOutput extends CreateHostOutput, __MetadataBea *

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.

* + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { CodeStarConnectionsClient, CreateHostCommand } from "@aws-sdk/client-codestar-connections"; // ES Modules import + * // const { CodeStarConnectionsClient, CreateHostCommand } = require("@aws-sdk/client-codestar-connections"); // CommonJS import + * const client = new CodeStarConnectionsClient(config); + * const command = new CreateHostCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreateHostCommandInput} for command's `input` shape. + * @see {@link CreateHostCommandOutput} for command's `response` shape. + * @see {@link CodeStarConnectionsClientResolvedConfig | config} for command's `input` shape. + * */ export class CreateHostCommand extends $Command< CreateHostCommandInput, diff --git a/clients/client-codestar-connections/commands/DeleteConnectionCommand.ts b/clients/client-codestar-connections/commands/DeleteConnectionCommand.ts index 6f5c311ba547..0af56c0eb718 100644 --- a/clients/client-codestar-connections/commands/DeleteConnectionCommand.ts +++ b/clients/client-codestar-connections/commands/DeleteConnectionCommand.ts @@ -26,6 +26,20 @@ export interface DeleteConnectionCommandOutput extends DeleteConnectionOutput, _ /** *

The connection to be deleted.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { CodeStarConnectionsClient, DeleteConnectionCommand } from "@aws-sdk/client-codestar-connections"; // ES Modules import + * // const { CodeStarConnectionsClient, DeleteConnectionCommand } = require("@aws-sdk/client-codestar-connections"); // CommonJS import + * const client = new CodeStarConnectionsClient(config); + * const command = new DeleteConnectionCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteConnectionCommandInput} for command's `input` shape. + * @see {@link DeleteConnectionCommandOutput} for command's `response` shape. + * @see {@link CodeStarConnectionsClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteConnectionCommand extends $Command< DeleteConnectionCommandInput, diff --git a/clients/client-codestar-connections/commands/DeleteHostCommand.ts b/clients/client-codestar-connections/commands/DeleteHostCommand.ts index 663278f2aa90..d8000cf292c1 100644 --- a/clients/client-codestar-connections/commands/DeleteHostCommand.ts +++ b/clients/client-codestar-connections/commands/DeleteHostCommand.ts @@ -29,6 +29,20 @@ export interface DeleteHostCommandOutput extends DeleteHostOutput, __MetadataBea * *

A host cannot be deleted if it is in the VPC_CONFIG_INITIALIZING or VPC_CONFIG_DELETING state.

* + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { CodeStarConnectionsClient, DeleteHostCommand } from "@aws-sdk/client-codestar-connections"; // ES Modules import + * // const { CodeStarConnectionsClient, DeleteHostCommand } = require("@aws-sdk/client-codestar-connections"); // CommonJS import + * const client = new CodeStarConnectionsClient(config); + * const command = new DeleteHostCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteHostCommandInput} for command's `input` shape. + * @see {@link DeleteHostCommandOutput} for command's `response` shape. + * @see {@link CodeStarConnectionsClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteHostCommand extends $Command< DeleteHostCommandInput, diff --git a/clients/client-codestar-connections/commands/GetConnectionCommand.ts b/clients/client-codestar-connections/commands/GetConnectionCommand.ts index 72df02ec1303..fa4a7934ef6c 100644 --- a/clients/client-codestar-connections/commands/GetConnectionCommand.ts +++ b/clients/client-codestar-connections/commands/GetConnectionCommand.ts @@ -26,6 +26,20 @@ export interface GetConnectionCommandOutput extends GetConnectionOutput, __Metad /** *

Returns the connection ARN and details such as status, owner, and provider type.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { CodeStarConnectionsClient, GetConnectionCommand } from "@aws-sdk/client-codestar-connections"; // ES Modules import + * // const { CodeStarConnectionsClient, GetConnectionCommand } = require("@aws-sdk/client-codestar-connections"); // CommonJS import + * const client = new CodeStarConnectionsClient(config); + * const command = new GetConnectionCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetConnectionCommandInput} for command's `input` shape. + * @see {@link GetConnectionCommandOutput} for command's `response` shape. + * @see {@link CodeStarConnectionsClientResolvedConfig | config} for command's `input` shape. + * */ export class GetConnectionCommand extends $Command< GetConnectionCommandInput, diff --git a/clients/client-codestar-connections/commands/GetHostCommand.ts b/clients/client-codestar-connections/commands/GetHostCommand.ts index 031483375ec1..848e80c7a455 100644 --- a/clients/client-codestar-connections/commands/GetHostCommand.ts +++ b/clients/client-codestar-connections/commands/GetHostCommand.ts @@ -24,6 +24,20 @@ export interface GetHostCommandOutput extends GetHostOutput, __MetadataBearer {} /** *

Returns the host ARN and details such as status, provider type, endpoint, and, if * applicable, the VPC configuration.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { CodeStarConnectionsClient, GetHostCommand } from "@aws-sdk/client-codestar-connections"; // ES Modules import + * // const { CodeStarConnectionsClient, GetHostCommand } = require("@aws-sdk/client-codestar-connections"); // CommonJS import + * const client = new CodeStarConnectionsClient(config); + * const command = new GetHostCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetHostCommandInput} for command's `input` shape. + * @see {@link GetHostCommandOutput} for command's `response` shape. + * @see {@link CodeStarConnectionsClientResolvedConfig | config} for command's `input` shape. + * */ export class GetHostCommand extends $Command< GetHostCommandInput, diff --git a/clients/client-codestar-connections/commands/ListConnectionsCommand.ts b/clients/client-codestar-connections/commands/ListConnectionsCommand.ts index 81cda055f198..37dd9e1768fe 100644 --- a/clients/client-codestar-connections/commands/ListConnectionsCommand.ts +++ b/clients/client-codestar-connections/commands/ListConnectionsCommand.ts @@ -26,6 +26,20 @@ export interface ListConnectionsCommandOutput extends ListConnectionsOutput, __M /** *

Lists the connections associated with your account.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { CodeStarConnectionsClient, ListConnectionsCommand } from "@aws-sdk/client-codestar-connections"; // ES Modules import + * // const { CodeStarConnectionsClient, ListConnectionsCommand } = require("@aws-sdk/client-codestar-connections"); // CommonJS import + * const client = new CodeStarConnectionsClient(config); + * const command = new ListConnectionsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListConnectionsCommandInput} for command's `input` shape. + * @see {@link ListConnectionsCommandOutput} for command's `response` shape. + * @see {@link CodeStarConnectionsClientResolvedConfig | config} for command's `input` shape. + * */ export class ListConnectionsCommand extends $Command< ListConnectionsCommandInput, diff --git a/clients/client-codestar-connections/commands/ListHostsCommand.ts b/clients/client-codestar-connections/commands/ListHostsCommand.ts index 6955c802970c..6fec33d54f26 100644 --- a/clients/client-codestar-connections/commands/ListHostsCommand.ts +++ b/clients/client-codestar-connections/commands/ListHostsCommand.ts @@ -23,6 +23,20 @@ export interface ListHostsCommandOutput extends ListHostsOutput, __MetadataBeare /** *

Lists the hosts associated with your account.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { CodeStarConnectionsClient, ListHostsCommand } from "@aws-sdk/client-codestar-connections"; // ES Modules import + * // const { CodeStarConnectionsClient, ListHostsCommand } = require("@aws-sdk/client-codestar-connections"); // CommonJS import + * const client = new CodeStarConnectionsClient(config); + * const command = new ListHostsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListHostsCommandInput} for command's `input` shape. + * @see {@link ListHostsCommandOutput} for command's `response` shape. + * @see {@link CodeStarConnectionsClientResolvedConfig | config} for command's `input` shape. + * */ export class ListHostsCommand extends $Command< ListHostsCommandInput, diff --git a/clients/client-codestar-connections/commands/ListTagsForResourceCommand.ts b/clients/client-codestar-connections/commands/ListTagsForResourceCommand.ts index 3cc83151ceed..6b96e9557841 100644 --- a/clients/client-codestar-connections/commands/ListTagsForResourceCommand.ts +++ b/clients/client-codestar-connections/commands/ListTagsForResourceCommand.ts @@ -26,6 +26,20 @@ export interface ListTagsForResourceCommandOutput extends ListTagsForResourceOut /** *

Gets the set of key-value pairs (metadata) that are used to manage the resource.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { CodeStarConnectionsClient, ListTagsForResourceCommand } from "@aws-sdk/client-codestar-connections"; // ES Modules import + * // const { CodeStarConnectionsClient, ListTagsForResourceCommand } = require("@aws-sdk/client-codestar-connections"); // CommonJS import + * const client = new CodeStarConnectionsClient(config); + * const command = new ListTagsForResourceCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListTagsForResourceCommandInput} for command's `input` shape. + * @see {@link ListTagsForResourceCommandOutput} for command's `response` shape. + * @see {@link CodeStarConnectionsClientResolvedConfig | config} for command's `input` shape. + * */ export class ListTagsForResourceCommand extends $Command< ListTagsForResourceCommandInput, diff --git a/clients/client-codestar-connections/commands/TagResourceCommand.ts b/clients/client-codestar-connections/commands/TagResourceCommand.ts index 7702ea6ade80..7faf09f16e06 100644 --- a/clients/client-codestar-connections/commands/TagResourceCommand.ts +++ b/clients/client-codestar-connections/commands/TagResourceCommand.ts @@ -27,6 +27,20 @@ export interface TagResourceCommandOutput extends TagResourceOutput, __MetadataB /** *

Adds to or modifies the tags of the given resource. Tags are metadata that can be used * to manage a resource.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { CodeStarConnectionsClient, TagResourceCommand } from "@aws-sdk/client-codestar-connections"; // ES Modules import + * // const { CodeStarConnectionsClient, TagResourceCommand } = require("@aws-sdk/client-codestar-connections"); // CommonJS import + * const client = new CodeStarConnectionsClient(config); + * const command = new TagResourceCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link TagResourceCommandInput} for command's `input` shape. + * @see {@link TagResourceCommandOutput} for command's `response` shape. + * @see {@link CodeStarConnectionsClientResolvedConfig | config} for command's `input` shape. + * */ export class TagResourceCommand extends $Command< TagResourceCommandInput, diff --git a/clients/client-codestar-connections/commands/UntagResourceCommand.ts b/clients/client-codestar-connections/commands/UntagResourceCommand.ts index ae1359c0a3b8..cc7eb7250e19 100644 --- a/clients/client-codestar-connections/commands/UntagResourceCommand.ts +++ b/clients/client-codestar-connections/commands/UntagResourceCommand.ts @@ -26,6 +26,20 @@ export interface UntagResourceCommandOutput extends UntagResourceOutput, __Metad /** *

Removes tags from an AWS resource.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { CodeStarConnectionsClient, UntagResourceCommand } from "@aws-sdk/client-codestar-connections"; // ES Modules import + * // const { CodeStarConnectionsClient, UntagResourceCommand } = require("@aws-sdk/client-codestar-connections"); // CommonJS import + * const client = new CodeStarConnectionsClient(config); + * const command = new UntagResourceCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link UntagResourceCommandInput} for command's `input` shape. + * @see {@link UntagResourceCommandOutput} for command's `response` shape. + * @see {@link CodeStarConnectionsClientResolvedConfig | config} for command's `input` shape. + * */ export class UntagResourceCommand extends $Command< UntagResourceCommandInput, diff --git a/clients/client-codestar-connections/commands/UpdateHostCommand.ts b/clients/client-codestar-connections/commands/UpdateHostCommand.ts index 87a71e84fb9c..386b469da885 100644 --- a/clients/client-codestar-connections/commands/UpdateHostCommand.ts +++ b/clients/client-codestar-connections/commands/UpdateHostCommand.ts @@ -26,6 +26,20 @@ export interface UpdateHostCommandOutput extends UpdateHostOutput, __MetadataBea /** *

Updates a specified host with the provided configurations.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { CodeStarConnectionsClient, UpdateHostCommand } from "@aws-sdk/client-codestar-connections"; // ES Modules import + * // const { CodeStarConnectionsClient, UpdateHostCommand } = require("@aws-sdk/client-codestar-connections"); // CommonJS import + * const client = new CodeStarConnectionsClient(config); + * const command = new UpdateHostCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link UpdateHostCommandInput} for command's `input` shape. + * @see {@link UpdateHostCommandOutput} for command's `response` shape. + * @see {@link CodeStarConnectionsClientResolvedConfig | config} for command's `input` shape. + * */ export class UpdateHostCommand extends $Command< UpdateHostCommandInput, diff --git a/clients/client-codestar-connections/models/models_0.ts b/clients/client-codestar-connections/models/models_0.ts index 42f3a8234204..bb66533c5495 100644 --- a/clients/client-codestar-connections/models/models_0.ts +++ b/clients/client-codestar-connections/models/models_0.ts @@ -24,6 +24,9 @@ export interface Tag { } export namespace Tag { + /** + * @internal + */ export const filterSensitiveLog = (obj: Tag): any => ({ ...obj, }); @@ -54,6 +57,9 @@ export interface CreateConnectionInput { } export namespace CreateConnectionInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateConnectionInput): any => ({ ...obj, }); @@ -76,6 +82,9 @@ export interface CreateConnectionOutput { } export namespace CreateConnectionOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateConnectionOutput): any => ({ ...obj, }); @@ -91,6 +100,9 @@ export interface LimitExceededException extends __SmithyException, $MetadataBear } export namespace LimitExceededException { + /** + * @internal + */ export const filterSensitiveLog = (obj: LimitExceededException): any => ({ ...obj, }); @@ -106,6 +118,9 @@ export interface ResourceNotFoundException extends __SmithyException, $MetadataB } export namespace ResourceNotFoundException { + /** + * @internal + */ export const filterSensitiveLog = (obj: ResourceNotFoundException): any => ({ ...obj, }); @@ -121,6 +136,9 @@ export interface ResourceUnavailableException extends __SmithyException, $Metada } export namespace ResourceUnavailableException { + /** + * @internal + */ export const filterSensitiveLog = (obj: ResourceUnavailableException): any => ({ ...obj, }); @@ -155,6 +173,9 @@ export interface VpcConfiguration { } export namespace VpcConfiguration { + /** + * @internal + */ export const filterSensitiveLog = (obj: VpcConfiguration): any => ({ ...obj, }); @@ -190,6 +211,9 @@ export interface CreateHostInput { } export namespace CreateHostInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateHostInput): any => ({ ...obj, }); @@ -205,6 +229,9 @@ export interface CreateHostOutput { } export namespace CreateHostOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateHostOutput): any => ({ ...obj, }); @@ -221,6 +248,9 @@ export interface DeleteConnectionInput { } export namespace DeleteConnectionInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteConnectionInput): any => ({ ...obj, }); @@ -229,6 +259,9 @@ export namespace DeleteConnectionInput { export interface DeleteConnectionOutput {} export namespace DeleteConnectionOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteConnectionOutput): any => ({ ...obj, }); @@ -242,6 +275,9 @@ export interface DeleteHostInput { } export namespace DeleteHostInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteHostInput): any => ({ ...obj, }); @@ -250,6 +286,9 @@ export namespace DeleteHostInput { export interface DeleteHostOutput {} export namespace DeleteHostOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteHostOutput): any => ({ ...obj, }); @@ -263,6 +302,9 @@ export interface GetConnectionInput { } export namespace GetConnectionInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetConnectionInput): any => ({ ...obj, }); @@ -318,6 +360,9 @@ export interface Connection { } export namespace Connection { + /** + * @internal + */ export const filterSensitiveLog = (obj: Connection): any => ({ ...obj, }); @@ -331,6 +376,9 @@ export interface GetConnectionOutput { } export namespace GetConnectionOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetConnectionOutput): any => ({ ...obj, }); @@ -344,6 +392,9 @@ export interface GetHostInput { } export namespace GetHostInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetHostInput): any => ({ ...obj, }); @@ -377,6 +428,9 @@ export interface GetHostOutput { } export namespace GetHostOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetHostOutput): any => ({ ...obj, }); @@ -408,6 +462,9 @@ export interface ListConnectionsInput { } export namespace ListConnectionsInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListConnectionsInput): any => ({ ...obj, }); @@ -429,6 +486,9 @@ export interface ListConnectionsOutput { } export namespace ListConnectionsOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListConnectionsOutput): any => ({ ...obj, }); @@ -449,6 +509,9 @@ export interface ListHostsInput { } export namespace ListHostsInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListHostsInput): any => ({ ...obj, }); @@ -503,6 +566,9 @@ export interface Host { } export namespace Host { + /** + * @internal + */ export const filterSensitiveLog = (obj: Host): any => ({ ...obj, }); @@ -524,6 +590,9 @@ export interface ListHostsOutput { } export namespace ListHostsOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListHostsOutput): any => ({ ...obj, }); @@ -537,6 +606,9 @@ export interface ListTagsForResourceInput { } export namespace ListTagsForResourceInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListTagsForResourceInput): any => ({ ...obj, }); @@ -550,6 +622,9 @@ export interface ListTagsForResourceOutput { } export namespace ListTagsForResourceOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListTagsForResourceOutput): any => ({ ...obj, }); @@ -568,6 +643,9 @@ export interface TagResourceInput { } export namespace TagResourceInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: TagResourceInput): any => ({ ...obj, }); @@ -576,6 +654,9 @@ export namespace TagResourceInput { export interface TagResourceOutput {} export namespace TagResourceOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: TagResourceOutput): any => ({ ...obj, }); @@ -594,6 +675,9 @@ export interface UntagResourceInput { } export namespace UntagResourceInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: UntagResourceInput): any => ({ ...obj, }); @@ -602,6 +686,9 @@ export namespace UntagResourceInput { export interface UntagResourceOutput {} export namespace UntagResourceOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: UntagResourceOutput): any => ({ ...obj, }); @@ -617,6 +704,9 @@ export interface ConflictException extends __SmithyException, $MetadataBearer { } export namespace ConflictException { + /** + * @internal + */ export const filterSensitiveLog = (obj: ConflictException): any => ({ ...obj, }); @@ -632,6 +722,9 @@ export interface UnsupportedOperationException extends __SmithyException, $Metad } export namespace UnsupportedOperationException { + /** + * @internal + */ export const filterSensitiveLog = (obj: UnsupportedOperationException): any => ({ ...obj, }); @@ -656,6 +749,9 @@ export interface UpdateHostInput { } export namespace UpdateHostInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateHostInput): any => ({ ...obj, }); @@ -664,6 +760,9 @@ export namespace UpdateHostInput { export interface UpdateHostOutput {} export namespace UpdateHostOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateHostOutput): any => ({ ...obj, }); diff --git a/clients/client-codestar-notifications/commands/CreateNotificationRuleCommand.ts b/clients/client-codestar-notifications/commands/CreateNotificationRuleCommand.ts index b32276f18a81..ec39bd5f930f 100644 --- a/clients/client-codestar-notifications/commands/CreateNotificationRuleCommand.ts +++ b/clients/client-codestar-notifications/commands/CreateNotificationRuleCommand.ts @@ -28,6 +28,20 @@ export interface CreateNotificationRuleCommandOutput extends CreateNotificationR *

Creates a notification rule for a resource. The rule specifies the events you want * notifications about and the targets (such as SNS topics) where you want to receive * them.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { CodestarNotificationsClient, CreateNotificationRuleCommand } from "@aws-sdk/client-codestar-notifications"; // ES Modules import + * // const { CodestarNotificationsClient, CreateNotificationRuleCommand } = require("@aws-sdk/client-codestar-notifications"); // CommonJS import + * const client = new CodestarNotificationsClient(config); + * const command = new CreateNotificationRuleCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreateNotificationRuleCommandInput} for command's `input` shape. + * @see {@link CreateNotificationRuleCommandOutput} for command's `response` shape. + * @see {@link CodestarNotificationsClientResolvedConfig | config} for command's `input` shape. + * */ export class CreateNotificationRuleCommand extends $Command< CreateNotificationRuleCommandInput, diff --git a/clients/client-codestar-notifications/commands/DeleteNotificationRuleCommand.ts b/clients/client-codestar-notifications/commands/DeleteNotificationRuleCommand.ts index 81880261ed83..89c0547c4d5a 100644 --- a/clients/client-codestar-notifications/commands/DeleteNotificationRuleCommand.ts +++ b/clients/client-codestar-notifications/commands/DeleteNotificationRuleCommand.ts @@ -26,6 +26,20 @@ export interface DeleteNotificationRuleCommandOutput extends DeleteNotificationR /** *

Deletes a notification rule for a resource.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { CodestarNotificationsClient, DeleteNotificationRuleCommand } from "@aws-sdk/client-codestar-notifications"; // ES Modules import + * // const { CodestarNotificationsClient, DeleteNotificationRuleCommand } = require("@aws-sdk/client-codestar-notifications"); // CommonJS import + * const client = new CodestarNotificationsClient(config); + * const command = new DeleteNotificationRuleCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteNotificationRuleCommandInput} for command's `input` shape. + * @see {@link DeleteNotificationRuleCommandOutput} for command's `response` shape. + * @see {@link CodestarNotificationsClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteNotificationRuleCommand extends $Command< DeleteNotificationRuleCommandInput, diff --git a/clients/client-codestar-notifications/commands/DeleteTargetCommand.ts b/clients/client-codestar-notifications/commands/DeleteTargetCommand.ts index 29b7ac038c84..ed2ae3773c29 100644 --- a/clients/client-codestar-notifications/commands/DeleteTargetCommand.ts +++ b/clients/client-codestar-notifications/commands/DeleteTargetCommand.ts @@ -26,6 +26,20 @@ export interface DeleteTargetCommandOutput extends DeleteTargetResult, __Metadat /** *

Deletes a specified target for notifications.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { CodestarNotificationsClient, DeleteTargetCommand } from "@aws-sdk/client-codestar-notifications"; // ES Modules import + * // const { CodestarNotificationsClient, DeleteTargetCommand } = require("@aws-sdk/client-codestar-notifications"); // CommonJS import + * const client = new CodestarNotificationsClient(config); + * const command = new DeleteTargetCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteTargetCommandInput} for command's `input` shape. + * @see {@link DeleteTargetCommandOutput} for command's `response` shape. + * @see {@link CodestarNotificationsClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteTargetCommand extends $Command< DeleteTargetCommandInput, diff --git a/clients/client-codestar-notifications/commands/DescribeNotificationRuleCommand.ts b/clients/client-codestar-notifications/commands/DescribeNotificationRuleCommand.ts index bf91aa301ce5..a8ec5faba9d2 100644 --- a/clients/client-codestar-notifications/commands/DescribeNotificationRuleCommand.ts +++ b/clients/client-codestar-notifications/commands/DescribeNotificationRuleCommand.ts @@ -26,6 +26,20 @@ export interface DescribeNotificationRuleCommandOutput extends DescribeNotificat /** *

Returns information about a specified notification rule.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { CodestarNotificationsClient, DescribeNotificationRuleCommand } from "@aws-sdk/client-codestar-notifications"; // ES Modules import + * // const { CodestarNotificationsClient, DescribeNotificationRuleCommand } = require("@aws-sdk/client-codestar-notifications"); // CommonJS import + * const client = new CodestarNotificationsClient(config); + * const command = new DescribeNotificationRuleCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeNotificationRuleCommandInput} for command's `input` shape. + * @see {@link DescribeNotificationRuleCommandOutput} for command's `response` shape. + * @see {@link CodestarNotificationsClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeNotificationRuleCommand extends $Command< DescribeNotificationRuleCommandInput, diff --git a/clients/client-codestar-notifications/commands/ListEventTypesCommand.ts b/clients/client-codestar-notifications/commands/ListEventTypesCommand.ts index 584ddd510d69..b1f5b274e303 100644 --- a/clients/client-codestar-notifications/commands/ListEventTypesCommand.ts +++ b/clients/client-codestar-notifications/commands/ListEventTypesCommand.ts @@ -26,6 +26,20 @@ export interface ListEventTypesCommandOutput extends ListEventTypesResult, __Met /** *

Returns information about the event types available for configuring notifications.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { CodestarNotificationsClient, ListEventTypesCommand } from "@aws-sdk/client-codestar-notifications"; // ES Modules import + * // const { CodestarNotificationsClient, ListEventTypesCommand } = require("@aws-sdk/client-codestar-notifications"); // CommonJS import + * const client = new CodestarNotificationsClient(config); + * const command = new ListEventTypesCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListEventTypesCommandInput} for command's `input` shape. + * @see {@link ListEventTypesCommandOutput} for command's `response` shape. + * @see {@link CodestarNotificationsClientResolvedConfig | config} for command's `input` shape. + * */ export class ListEventTypesCommand extends $Command< ListEventTypesCommandInput, diff --git a/clients/client-codestar-notifications/commands/ListNotificationRulesCommand.ts b/clients/client-codestar-notifications/commands/ListNotificationRulesCommand.ts index 67305445f3c6..e5633f96a33c 100644 --- a/clients/client-codestar-notifications/commands/ListNotificationRulesCommand.ts +++ b/clients/client-codestar-notifications/commands/ListNotificationRulesCommand.ts @@ -26,6 +26,20 @@ export interface ListNotificationRulesCommandOutput extends ListNotificationRule /** *

Returns a list of the notification rules for an AWS account.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { CodestarNotificationsClient, ListNotificationRulesCommand } from "@aws-sdk/client-codestar-notifications"; // ES Modules import + * // const { CodestarNotificationsClient, ListNotificationRulesCommand } = require("@aws-sdk/client-codestar-notifications"); // CommonJS import + * const client = new CodestarNotificationsClient(config); + * const command = new ListNotificationRulesCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListNotificationRulesCommandInput} for command's `input` shape. + * @see {@link ListNotificationRulesCommandOutput} for command's `response` shape. + * @see {@link CodestarNotificationsClientResolvedConfig | config} for command's `input` shape. + * */ export class ListNotificationRulesCommand extends $Command< ListNotificationRulesCommandInput, diff --git a/clients/client-codestar-notifications/commands/ListTagsForResourceCommand.ts b/clients/client-codestar-notifications/commands/ListTagsForResourceCommand.ts index 95b388c1bf21..19be80686081 100644 --- a/clients/client-codestar-notifications/commands/ListTagsForResourceCommand.ts +++ b/clients/client-codestar-notifications/commands/ListTagsForResourceCommand.ts @@ -26,6 +26,20 @@ export interface ListTagsForResourceCommandOutput extends ListTagsForResourceRes /** *

Returns a list of the tags associated with a notification rule.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { CodestarNotificationsClient, ListTagsForResourceCommand } from "@aws-sdk/client-codestar-notifications"; // ES Modules import + * // const { CodestarNotificationsClient, ListTagsForResourceCommand } = require("@aws-sdk/client-codestar-notifications"); // CommonJS import + * const client = new CodestarNotificationsClient(config); + * const command = new ListTagsForResourceCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListTagsForResourceCommandInput} for command's `input` shape. + * @see {@link ListTagsForResourceCommandOutput} for command's `response` shape. + * @see {@link CodestarNotificationsClientResolvedConfig | config} for command's `input` shape. + * */ export class ListTagsForResourceCommand extends $Command< ListTagsForResourceCommandInput, diff --git a/clients/client-codestar-notifications/commands/ListTargetsCommand.ts b/clients/client-codestar-notifications/commands/ListTargetsCommand.ts index 805135ebe69f..9f97a748c26c 100644 --- a/clients/client-codestar-notifications/commands/ListTargetsCommand.ts +++ b/clients/client-codestar-notifications/commands/ListTargetsCommand.ts @@ -26,6 +26,20 @@ export interface ListTargetsCommandOutput extends ListTargetsResult, __MetadataB /** *

Returns a list of the notification rule targets for an AWS account.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { CodestarNotificationsClient, ListTargetsCommand } from "@aws-sdk/client-codestar-notifications"; // ES Modules import + * // const { CodestarNotificationsClient, ListTargetsCommand } = require("@aws-sdk/client-codestar-notifications"); // CommonJS import + * const client = new CodestarNotificationsClient(config); + * const command = new ListTargetsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListTargetsCommandInput} for command's `input` shape. + * @see {@link ListTargetsCommandOutput} for command's `response` shape. + * @see {@link CodestarNotificationsClientResolvedConfig | config} for command's `input` shape. + * */ export class ListTargetsCommand extends $Command< ListTargetsCommandInput, diff --git a/clients/client-codestar-notifications/commands/SubscribeCommand.ts b/clients/client-codestar-notifications/commands/SubscribeCommand.ts index 53ed6f21b87a..73d93f92fd9e 100644 --- a/clients/client-codestar-notifications/commands/SubscribeCommand.ts +++ b/clients/client-codestar-notifications/commands/SubscribeCommand.ts @@ -28,6 +28,20 @@ export interface SubscribeCommandOutput extends SubscribeResult, __MetadataBeare *

Creates an association between a notification rule and an SNS topic so that the * associated target can receive notifications when the events described in the rule are * triggered.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { CodestarNotificationsClient, SubscribeCommand } from "@aws-sdk/client-codestar-notifications"; // ES Modules import + * // const { CodestarNotificationsClient, SubscribeCommand } = require("@aws-sdk/client-codestar-notifications"); // CommonJS import + * const client = new CodestarNotificationsClient(config); + * const command = new SubscribeCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link SubscribeCommandInput} for command's `input` shape. + * @see {@link SubscribeCommandOutput} for command's `response` shape. + * @see {@link CodestarNotificationsClientResolvedConfig | config} for command's `input` shape. + * */ export class SubscribeCommand extends $Command< SubscribeCommandInput, diff --git a/clients/client-codestar-notifications/commands/TagResourceCommand.ts b/clients/client-codestar-notifications/commands/TagResourceCommand.ts index 118691c49b7f..8fa05130f1de 100644 --- a/clients/client-codestar-notifications/commands/TagResourceCommand.ts +++ b/clients/client-codestar-notifications/commands/TagResourceCommand.ts @@ -26,6 +26,20 @@ export interface TagResourceCommandOutput extends TagResourceResult, __MetadataB /** *

Associates a set of provided tags with a notification rule.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { CodestarNotificationsClient, TagResourceCommand } from "@aws-sdk/client-codestar-notifications"; // ES Modules import + * // const { CodestarNotificationsClient, TagResourceCommand } = require("@aws-sdk/client-codestar-notifications"); // CommonJS import + * const client = new CodestarNotificationsClient(config); + * const command = new TagResourceCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link TagResourceCommandInput} for command's `input` shape. + * @see {@link TagResourceCommandOutput} for command's `response` shape. + * @see {@link CodestarNotificationsClientResolvedConfig | config} for command's `input` shape. + * */ export class TagResourceCommand extends $Command< TagResourceCommandInput, diff --git a/clients/client-codestar-notifications/commands/UnsubscribeCommand.ts b/clients/client-codestar-notifications/commands/UnsubscribeCommand.ts index 15b5548d6186..5b34f96ead5c 100644 --- a/clients/client-codestar-notifications/commands/UnsubscribeCommand.ts +++ b/clients/client-codestar-notifications/commands/UnsubscribeCommand.ts @@ -28,6 +28,20 @@ export interface UnsubscribeCommandOutput extends UnsubscribeResult, __MetadataB *

Removes an association between a notification rule and an Amazon SNS topic so that * subscribers to that topic stop receiving notifications when the events described in the * rule are triggered.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { CodestarNotificationsClient, UnsubscribeCommand } from "@aws-sdk/client-codestar-notifications"; // ES Modules import + * // const { CodestarNotificationsClient, UnsubscribeCommand } = require("@aws-sdk/client-codestar-notifications"); // CommonJS import + * const client = new CodestarNotificationsClient(config); + * const command = new UnsubscribeCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link UnsubscribeCommandInput} for command's `input` shape. + * @see {@link UnsubscribeCommandOutput} for command's `response` shape. + * @see {@link CodestarNotificationsClientResolvedConfig | config} for command's `input` shape. + * */ export class UnsubscribeCommand extends $Command< UnsubscribeCommandInput, diff --git a/clients/client-codestar-notifications/commands/UntagResourceCommand.ts b/clients/client-codestar-notifications/commands/UntagResourceCommand.ts index 61403e9a0320..6c9a8ba8a172 100644 --- a/clients/client-codestar-notifications/commands/UntagResourceCommand.ts +++ b/clients/client-codestar-notifications/commands/UntagResourceCommand.ts @@ -27,6 +27,20 @@ export interface UntagResourceCommandOutput extends UntagResourceResult, __Metad /** *

Removes the association between one or more provided tags and a notification * rule.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { CodestarNotificationsClient, UntagResourceCommand } from "@aws-sdk/client-codestar-notifications"; // ES Modules import + * // const { CodestarNotificationsClient, UntagResourceCommand } = require("@aws-sdk/client-codestar-notifications"); // CommonJS import + * const client = new CodestarNotificationsClient(config); + * const command = new UntagResourceCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link UntagResourceCommandInput} for command's `input` shape. + * @see {@link UntagResourceCommandOutput} for command's `response` shape. + * @see {@link CodestarNotificationsClientResolvedConfig | config} for command's `input` shape. + * */ export class UntagResourceCommand extends $Command< UntagResourceCommandInput, diff --git a/clients/client-codestar-notifications/commands/UpdateNotificationRuleCommand.ts b/clients/client-codestar-notifications/commands/UpdateNotificationRuleCommand.ts index 4ef87ffd4101..b1c1950ea995 100644 --- a/clients/client-codestar-notifications/commands/UpdateNotificationRuleCommand.ts +++ b/clients/client-codestar-notifications/commands/UpdateNotificationRuleCommand.ts @@ -31,6 +31,20 @@ export interface UpdateNotificationRuleCommandOutput extends UpdateNotificationR * *

To add or remove tags for a notification rule, you must use TagResource and UntagResource.

* + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { CodestarNotificationsClient, UpdateNotificationRuleCommand } from "@aws-sdk/client-codestar-notifications"; // ES Modules import + * // const { CodestarNotificationsClient, UpdateNotificationRuleCommand } = require("@aws-sdk/client-codestar-notifications"); // CommonJS import + * const client = new CodestarNotificationsClient(config); + * const command = new UpdateNotificationRuleCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link UpdateNotificationRuleCommandInput} for command's `input` shape. + * @see {@link UpdateNotificationRuleCommandOutput} for command's `response` shape. + * @see {@link CodestarNotificationsClientResolvedConfig | config} for command's `input` shape. + * */ export class UpdateNotificationRuleCommand extends $Command< UpdateNotificationRuleCommandInput, diff --git a/clients/client-codestar-notifications/models/models_0.ts b/clients/client-codestar-notifications/models/models_0.ts index fdffb03547e9..7f59c80827ff 100644 --- a/clients/client-codestar-notifications/models/models_0.ts +++ b/clients/client-codestar-notifications/models/models_0.ts @@ -12,6 +12,9 @@ export interface AccessDeniedException extends __SmithyException, $MetadataBeare } export namespace AccessDeniedException { + /** + * @internal + */ export const filterSensitiveLog = (obj: AccessDeniedException): any => ({ ...obj, }); @@ -28,6 +31,9 @@ export interface ConcurrentModificationException extends __SmithyException, $Met } export namespace ConcurrentModificationException { + /** + * @internal + */ export const filterSensitiveLog = (obj: ConcurrentModificationException): any => ({ ...obj, }); @@ -43,6 +49,9 @@ export interface ConfigurationException extends __SmithyException, $MetadataBear } export namespace ConfigurationException { + /** + * @internal + */ export const filterSensitiveLog = (obj: ConfigurationException): any => ({ ...obj, }); @@ -74,6 +83,9 @@ export interface Target { } export namespace Target { + /** + * @internal + */ export const filterSensitiveLog = (obj: Target): any => ({ ...obj, ...(obj.TargetAddress && { TargetAddress: SENSITIVE_STRING }), @@ -137,6 +149,9 @@ export interface CreateNotificationRuleRequest { } export namespace CreateNotificationRuleRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateNotificationRuleRequest): any => ({ ...obj, ...(obj.Name && { Name: SENSITIVE_STRING }), @@ -152,6 +167,9 @@ export interface CreateNotificationRuleResult { } export namespace CreateNotificationRuleResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateNotificationRuleResult): any => ({ ...obj, }); @@ -169,6 +187,9 @@ export interface LimitExceededException extends __SmithyException, $MetadataBear } export namespace LimitExceededException { + /** + * @internal + */ export const filterSensitiveLog = (obj: LimitExceededException): any => ({ ...obj, }); @@ -185,6 +206,9 @@ export interface ResourceAlreadyExistsException extends __SmithyException, $Meta } export namespace ResourceAlreadyExistsException { + /** + * @internal + */ export const filterSensitiveLog = (obj: ResourceAlreadyExistsException): any => ({ ...obj, }); @@ -200,6 +224,9 @@ export interface ValidationException extends __SmithyException, $MetadataBearer } export namespace ValidationException { + /** + * @internal + */ export const filterSensitiveLog = (obj: ValidationException): any => ({ ...obj, }); @@ -213,6 +240,9 @@ export interface DeleteNotificationRuleRequest { } export namespace DeleteNotificationRuleRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteNotificationRuleRequest): any => ({ ...obj, }); @@ -226,6 +256,9 @@ export interface DeleteNotificationRuleResult { } export namespace DeleteNotificationRuleResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteNotificationRuleResult): any => ({ ...obj, }); @@ -246,6 +279,9 @@ export interface DeleteTargetRequest { } export namespace DeleteTargetRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteTargetRequest): any => ({ ...obj, ...(obj.TargetAddress && { TargetAddress: SENSITIVE_STRING }), @@ -255,6 +291,9 @@ export namespace DeleteTargetRequest { export interface DeleteTargetResult {} export namespace DeleteTargetResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteTargetResult): any => ({ ...obj, }); @@ -268,6 +307,9 @@ export interface DescribeNotificationRuleRequest { } export namespace DescribeNotificationRuleRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeNotificationRuleRequest): any => ({ ...obj, }); @@ -299,6 +341,9 @@ export interface EventTypeSummary { } export namespace EventTypeSummary { + /** + * @internal + */ export const filterSensitiveLog = (obj: EventTypeSummary): any => ({ ...obj, }); @@ -333,6 +378,9 @@ export interface TargetSummary { } export namespace TargetSummary { + /** + * @internal + */ export const filterSensitiveLog = (obj: TargetSummary): any => ({ ...obj, ...(obj.TargetAddress && { TargetAddress: SENSITIVE_STRING }), @@ -402,6 +450,9 @@ export interface DescribeNotificationRuleResult { } export namespace DescribeNotificationRuleResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeNotificationRuleResult): any => ({ ...obj, ...(obj.Name && { Name: SENSITIVE_STRING }), @@ -419,6 +470,9 @@ export interface ResourceNotFoundException extends __SmithyException, $MetadataB } export namespace ResourceNotFoundException { + /** + * @internal + */ export const filterSensitiveLog = (obj: ResourceNotFoundException): any => ({ ...obj, }); @@ -434,6 +488,9 @@ export interface InvalidNextTokenException extends __SmithyException, $MetadataB } export namespace InvalidNextTokenException { + /** + * @internal + */ export const filterSensitiveLog = (obj: InvalidNextTokenException): any => ({ ...obj, }); @@ -462,6 +519,9 @@ export interface ListEventTypesFilter { } export namespace ListEventTypesFilter { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListEventTypesFilter): any => ({ ...obj, }); @@ -487,6 +547,9 @@ export interface ListEventTypesRequest { } export namespace ListEventTypesRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListEventTypesRequest): any => ({ ...obj, }); @@ -506,6 +569,9 @@ export interface ListEventTypesResult { } export namespace ListEventTypesResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListEventTypesResult): any => ({ ...obj, }); @@ -536,6 +602,9 @@ export interface ListNotificationRulesFilter { } export namespace ListNotificationRulesFilter { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListNotificationRulesFilter): any => ({ ...obj, }); @@ -565,6 +634,9 @@ export interface ListNotificationRulesRequest { } export namespace ListNotificationRulesRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListNotificationRulesRequest): any => ({ ...obj, }); @@ -586,6 +658,9 @@ export interface NotificationRuleSummary { } export namespace NotificationRuleSummary { + /** + * @internal + */ export const filterSensitiveLog = (obj: NotificationRuleSummary): any => ({ ...obj, }); @@ -604,6 +679,9 @@ export interface ListNotificationRulesResult { } export namespace ListNotificationRulesResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListNotificationRulesResult): any => ({ ...obj, }); @@ -617,6 +695,9 @@ export interface ListTagsForResourceRequest { } export namespace ListTagsForResourceRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListTagsForResourceRequest): any => ({ ...obj, }); @@ -630,6 +711,9 @@ export interface ListTagsForResourceResult { } export namespace ListTagsForResourceResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListTagsForResourceResult): any => ({ ...obj, }); @@ -663,6 +747,9 @@ export interface ListTargetsFilter { } export namespace ListTargetsFilter { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListTargetsFilter): any => ({ ...obj, }); @@ -692,6 +779,9 @@ export interface ListTargetsRequest { } export namespace ListTargetsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListTargetsRequest): any => ({ ...obj, }); @@ -711,6 +801,9 @@ export interface ListTargetsResult { } export namespace ListTargetsResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListTargetsResult): any => ({ ...obj, ...(obj.Targets && { Targets: obj.Targets.map((item) => TargetSummary.filterSensitiveLog(item)) }), @@ -736,6 +829,9 @@ export interface SubscribeRequest { } export namespace SubscribeRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: SubscribeRequest): any => ({ ...obj, ...(obj.Target && { Target: Target.filterSensitiveLog(obj.Target) }), @@ -750,6 +846,9 @@ export interface SubscribeResult { } export namespace SubscribeResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: SubscribeResult): any => ({ ...obj, }); @@ -768,6 +867,9 @@ export interface TagResourceRequest { } export namespace TagResourceRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: TagResourceRequest): any => ({ ...obj, }); @@ -781,6 +883,9 @@ export interface TagResourceResult { } export namespace TagResourceResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: TagResourceResult): any => ({ ...obj, }); @@ -799,6 +904,9 @@ export interface UnsubscribeRequest { } export namespace UnsubscribeRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: UnsubscribeRequest): any => ({ ...obj, ...(obj.TargetAddress && { TargetAddress: SENSITIVE_STRING }), @@ -813,6 +921,9 @@ export interface UnsubscribeResult { } export namespace UnsubscribeResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: UnsubscribeResult): any => ({ ...obj, }); @@ -832,6 +943,9 @@ export interface UntagResourceRequest { } export namespace UntagResourceRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: UntagResourceRequest): any => ({ ...obj, }); @@ -840,6 +954,9 @@ export namespace UntagResourceRequest { export interface UntagResourceResult {} export namespace UntagResourceResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: UntagResourceResult): any => ({ ...obj, }); @@ -882,6 +999,9 @@ export interface UpdateNotificationRuleRequest { } export namespace UpdateNotificationRuleRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateNotificationRuleRequest): any => ({ ...obj, ...(obj.Name && { Name: SENSITIVE_STRING }), @@ -892,6 +1012,9 @@ export namespace UpdateNotificationRuleRequest { export interface UpdateNotificationRuleResult {} export namespace UpdateNotificationRuleResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateNotificationRuleResult): any => ({ ...obj, }); diff --git a/clients/client-codestar/commands/AssociateTeamMemberCommand.ts b/clients/client-codestar/commands/AssociateTeamMemberCommand.ts index e3ef6d7d4fd4..567d6d63a4fc 100644 --- a/clients/client-codestar/commands/AssociateTeamMemberCommand.ts +++ b/clients/client-codestar/commands/AssociateTeamMemberCommand.ts @@ -22,6 +22,20 @@ export interface AssociateTeamMemberCommandOutput extends AssociateTeamMemberRes /** *

Adds an IAM user to the team for an AWS CodeStar project.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { CodeStarClient, AssociateTeamMemberCommand } from "@aws-sdk/client-codestar"; // ES Modules import + * // const { CodeStarClient, AssociateTeamMemberCommand } = require("@aws-sdk/client-codestar"); // CommonJS import + * const client = new CodeStarClient(config); + * const command = new AssociateTeamMemberCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link AssociateTeamMemberCommandInput} for command's `input` shape. + * @see {@link AssociateTeamMemberCommandOutput} for command's `response` shape. + * @see {@link CodeStarClientResolvedConfig | config} for command's `input` shape. + * */ export class AssociateTeamMemberCommand extends $Command< AssociateTeamMemberCommandInput, diff --git a/clients/client-codestar/commands/CreateProjectCommand.ts b/clients/client-codestar/commands/CreateProjectCommand.ts index 9aace4172bc6..fcf0f8e37b6e 100644 --- a/clients/client-codestar/commands/CreateProjectCommand.ts +++ b/clients/client-codestar/commands/CreateProjectCommand.ts @@ -24,6 +24,20 @@ export interface CreateProjectCommandOutput extends CreateProjectResult, __Metad *

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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { CodeStarClient, CreateProjectCommand } from "@aws-sdk/client-codestar"; // ES Modules import + * // const { CodeStarClient, CreateProjectCommand } = require("@aws-sdk/client-codestar"); // CommonJS import + * const client = new CodeStarClient(config); + * const command = new CreateProjectCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreateProjectCommandInput} for command's `input` shape. + * @see {@link CreateProjectCommandOutput} for command's `response` shape. + * @see {@link CodeStarClientResolvedConfig | config} for command's `input` shape. + * */ export class CreateProjectCommand extends $Command< CreateProjectCommandInput, diff --git a/clients/client-codestar/commands/CreateUserProfileCommand.ts b/clients/client-codestar/commands/CreateUserProfileCommand.ts index 7e8c64c37d9f..9b0713e90ab3 100644 --- a/clients/client-codestar/commands/CreateUserProfileCommand.ts +++ b/clients/client-codestar/commands/CreateUserProfileCommand.ts @@ -25,6 +25,20 @@ export interface CreateUserProfileCommandOutput extends CreateUserProfileResult, * 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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { CodeStarClient, CreateUserProfileCommand } from "@aws-sdk/client-codestar"; // ES Modules import + * // const { CodeStarClient, CreateUserProfileCommand } = require("@aws-sdk/client-codestar"); // CommonJS import + * const client = new CodeStarClient(config); + * const command = new CreateUserProfileCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreateUserProfileCommandInput} for command's `input` shape. + * @see {@link CreateUserProfileCommandOutput} for command's `response` shape. + * @see {@link CodeStarClientResolvedConfig | config} for command's `input` shape. + * */ export class CreateUserProfileCommand extends $Command< CreateUserProfileCommandInput, diff --git a/clients/client-codestar/commands/DeleteProjectCommand.ts b/clients/client-codestar/commands/DeleteProjectCommand.ts index 663b7f8b7f29..dd6817d9e6b7 100644 --- a/clients/client-codestar/commands/DeleteProjectCommand.ts +++ b/clients/client-codestar/commands/DeleteProjectCommand.ts @@ -23,6 +23,20 @@ export interface DeleteProjectCommandOutput extends DeleteProjectResult, __Metad /** *

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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { CodeStarClient, DeleteProjectCommand } from "@aws-sdk/client-codestar"; // ES Modules import + * // const { CodeStarClient, DeleteProjectCommand } = require("@aws-sdk/client-codestar"); // CommonJS import + * const client = new CodeStarClient(config); + * const command = new DeleteProjectCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteProjectCommandInput} for command's `input` shape. + * @see {@link DeleteProjectCommandOutput} for command's `response` shape. + * @see {@link CodeStarClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteProjectCommand extends $Command< DeleteProjectCommandInput, diff --git a/clients/client-codestar/commands/DeleteUserProfileCommand.ts b/clients/client-codestar/commands/DeleteUserProfileCommand.ts index 34034efe8409..99e731ca9a3c 100644 --- a/clients/client-codestar/commands/DeleteUserProfileCommand.ts +++ b/clients/client-codestar/commands/DeleteUserProfileCommand.ts @@ -24,6 +24,20 @@ export interface DeleteUserProfileCommandOutput extends DeleteUserProfileResult, *

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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { CodeStarClient, DeleteUserProfileCommand } from "@aws-sdk/client-codestar"; // ES Modules import + * // const { CodeStarClient, DeleteUserProfileCommand } = require("@aws-sdk/client-codestar"); // CommonJS import + * const client = new CodeStarClient(config); + * const command = new DeleteUserProfileCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteUserProfileCommandInput} for command's `input` shape. + * @see {@link DeleteUserProfileCommandOutput} for command's `response` shape. + * @see {@link CodeStarClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteUserProfileCommand extends $Command< DeleteUserProfileCommandInput, diff --git a/clients/client-codestar/commands/DescribeProjectCommand.ts b/clients/client-codestar/commands/DescribeProjectCommand.ts index 54ba2e33de7a..f7676e04081b 100644 --- a/clients/client-codestar/commands/DescribeProjectCommand.ts +++ b/clients/client-codestar/commands/DescribeProjectCommand.ts @@ -22,6 +22,20 @@ export interface DescribeProjectCommandOutput extends DescribeProjectResult, __M /** *

Describes a project and its resources.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { CodeStarClient, DescribeProjectCommand } from "@aws-sdk/client-codestar"; // ES Modules import + * // const { CodeStarClient, DescribeProjectCommand } = require("@aws-sdk/client-codestar"); // CommonJS import + * const client = new CodeStarClient(config); + * const command = new DescribeProjectCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeProjectCommandInput} for command's `input` shape. + * @see {@link DescribeProjectCommandOutput} for command's `response` shape. + * @see {@link CodeStarClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeProjectCommand extends $Command< DescribeProjectCommandInput, diff --git a/clients/client-codestar/commands/DescribeUserProfileCommand.ts b/clients/client-codestar/commands/DescribeUserProfileCommand.ts index 40e2de6e7821..c6b81a359b5a 100644 --- a/clients/client-codestar/commands/DescribeUserProfileCommand.ts +++ b/clients/client-codestar/commands/DescribeUserProfileCommand.ts @@ -22,6 +22,20 @@ export interface DescribeUserProfileCommandOutput extends DescribeUserProfileRes /** *

Describes a user in AWS CodeStar and the user attributes across all projects.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { CodeStarClient, DescribeUserProfileCommand } from "@aws-sdk/client-codestar"; // ES Modules import + * // const { CodeStarClient, DescribeUserProfileCommand } = require("@aws-sdk/client-codestar"); // CommonJS import + * const client = new CodeStarClient(config); + * const command = new DescribeUserProfileCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeUserProfileCommandInput} for command's `input` shape. + * @see {@link DescribeUserProfileCommandOutput} for command's `response` shape. + * @see {@link CodeStarClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeUserProfileCommand extends $Command< DescribeUserProfileCommandInput, diff --git a/clients/client-codestar/commands/DisassociateTeamMemberCommand.ts b/clients/client-codestar/commands/DisassociateTeamMemberCommand.ts index b831fe84dd01..b1208eb78e1d 100644 --- a/clients/client-codestar/commands/DisassociateTeamMemberCommand.ts +++ b/clients/client-codestar/commands/DisassociateTeamMemberCommand.ts @@ -25,6 +25,20 @@ export interface DisassociateTeamMemberCommandOutput extends DisassociateTeamMem * 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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { CodeStarClient, DisassociateTeamMemberCommand } from "@aws-sdk/client-codestar"; // ES Modules import + * // const { CodeStarClient, DisassociateTeamMemberCommand } = require("@aws-sdk/client-codestar"); // CommonJS import + * const client = new CodeStarClient(config); + * const command = new DisassociateTeamMemberCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DisassociateTeamMemberCommandInput} for command's `input` shape. + * @see {@link DisassociateTeamMemberCommandOutput} for command's `response` shape. + * @see {@link CodeStarClientResolvedConfig | config} for command's `input` shape. + * */ export class DisassociateTeamMemberCommand extends $Command< DisassociateTeamMemberCommandInput, diff --git a/clients/client-codestar/commands/ListProjectsCommand.ts b/clients/client-codestar/commands/ListProjectsCommand.ts index 6618afbd3d4c..afc042c68d08 100644 --- a/clients/client-codestar/commands/ListProjectsCommand.ts +++ b/clients/client-codestar/commands/ListProjectsCommand.ts @@ -22,6 +22,20 @@ export interface ListProjectsCommandOutput extends ListProjectsResult, __Metadat /** *

Lists all projects in AWS CodeStar associated with your AWS account.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { CodeStarClient, ListProjectsCommand } from "@aws-sdk/client-codestar"; // ES Modules import + * // const { CodeStarClient, ListProjectsCommand } = require("@aws-sdk/client-codestar"); // CommonJS import + * const client = new CodeStarClient(config); + * const command = new ListProjectsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListProjectsCommandInput} for command's `input` shape. + * @see {@link ListProjectsCommandOutput} for command's `response` shape. + * @see {@link CodeStarClientResolvedConfig | config} for command's `input` shape. + * */ export class ListProjectsCommand extends $Command< ListProjectsCommandInput, diff --git a/clients/client-codestar/commands/ListResourcesCommand.ts b/clients/client-codestar/commands/ListResourcesCommand.ts index 8f3aa870ac15..4f6f58d946a8 100644 --- a/clients/client-codestar/commands/ListResourcesCommand.ts +++ b/clients/client-codestar/commands/ListResourcesCommand.ts @@ -22,6 +22,20 @@ export interface ListResourcesCommandOutput extends ListResourcesResult, __Metad /** *

Lists resources associated with a project in AWS CodeStar.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { CodeStarClient, ListResourcesCommand } from "@aws-sdk/client-codestar"; // ES Modules import + * // const { CodeStarClient, ListResourcesCommand } = require("@aws-sdk/client-codestar"); // CommonJS import + * const client = new CodeStarClient(config); + * const command = new ListResourcesCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListResourcesCommandInput} for command's `input` shape. + * @see {@link ListResourcesCommandOutput} for command's `response` shape. + * @see {@link CodeStarClientResolvedConfig | config} for command's `input` shape. + * */ export class ListResourcesCommand extends $Command< ListResourcesCommandInput, diff --git a/clients/client-codestar/commands/ListTagsForProjectCommand.ts b/clients/client-codestar/commands/ListTagsForProjectCommand.ts index b0b16c266fd4..41256004a21e 100644 --- a/clients/client-codestar/commands/ListTagsForProjectCommand.ts +++ b/clients/client-codestar/commands/ListTagsForProjectCommand.ts @@ -22,6 +22,20 @@ export interface ListTagsForProjectCommandOutput extends ListTagsForProjectResul /** *

Gets the tags for a project.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { CodeStarClient, ListTagsForProjectCommand } from "@aws-sdk/client-codestar"; // ES Modules import + * // const { CodeStarClient, ListTagsForProjectCommand } = require("@aws-sdk/client-codestar"); // CommonJS import + * const client = new CodeStarClient(config); + * const command = new ListTagsForProjectCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListTagsForProjectCommandInput} for command's `input` shape. + * @see {@link ListTagsForProjectCommandOutput} for command's `response` shape. + * @see {@link CodeStarClientResolvedConfig | config} for command's `input` shape. + * */ export class ListTagsForProjectCommand extends $Command< ListTagsForProjectCommandInput, diff --git a/clients/client-codestar/commands/ListTeamMembersCommand.ts b/clients/client-codestar/commands/ListTeamMembersCommand.ts index 5f460e0e3760..cc515a577707 100644 --- a/clients/client-codestar/commands/ListTeamMembersCommand.ts +++ b/clients/client-codestar/commands/ListTeamMembersCommand.ts @@ -22,6 +22,20 @@ export interface ListTeamMembersCommandOutput extends ListTeamMembersResult, __M /** *

Lists all team members associated with a project.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { CodeStarClient, ListTeamMembersCommand } from "@aws-sdk/client-codestar"; // ES Modules import + * // const { CodeStarClient, ListTeamMembersCommand } = require("@aws-sdk/client-codestar"); // CommonJS import + * const client = new CodeStarClient(config); + * const command = new ListTeamMembersCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListTeamMembersCommandInput} for command's `input` shape. + * @see {@link ListTeamMembersCommandOutput} for command's `response` shape. + * @see {@link CodeStarClientResolvedConfig | config} for command's `input` shape. + * */ export class ListTeamMembersCommand extends $Command< ListTeamMembersCommandInput, diff --git a/clients/client-codestar/commands/ListUserProfilesCommand.ts b/clients/client-codestar/commands/ListUserProfilesCommand.ts index 94bf7d55cec0..f2d64417e033 100644 --- a/clients/client-codestar/commands/ListUserProfilesCommand.ts +++ b/clients/client-codestar/commands/ListUserProfilesCommand.ts @@ -22,6 +22,20 @@ export interface ListUserProfilesCommandOutput extends ListUserProfilesResult, _ /** *

Lists all the user profiles configured for your AWS account in AWS CodeStar.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { CodeStarClient, ListUserProfilesCommand } from "@aws-sdk/client-codestar"; // ES Modules import + * // const { CodeStarClient, ListUserProfilesCommand } = require("@aws-sdk/client-codestar"); // CommonJS import + * const client = new CodeStarClient(config); + * const command = new ListUserProfilesCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListUserProfilesCommandInput} for command's `input` shape. + * @see {@link ListUserProfilesCommandOutput} for command's `response` shape. + * @see {@link CodeStarClientResolvedConfig | config} for command's `input` shape. + * */ export class ListUserProfilesCommand extends $Command< ListUserProfilesCommandInput, diff --git a/clients/client-codestar/commands/TagProjectCommand.ts b/clients/client-codestar/commands/TagProjectCommand.ts index 4df94eae6f12..7a81c08e5d45 100644 --- a/clients/client-codestar/commands/TagProjectCommand.ts +++ b/clients/client-codestar/commands/TagProjectCommand.ts @@ -22,6 +22,20 @@ export interface TagProjectCommandOutput extends TagProjectResult, __MetadataBea /** *

Adds tags to a project.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { CodeStarClient, TagProjectCommand } from "@aws-sdk/client-codestar"; // ES Modules import + * // const { CodeStarClient, TagProjectCommand } = require("@aws-sdk/client-codestar"); // CommonJS import + * const client = new CodeStarClient(config); + * const command = new TagProjectCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link TagProjectCommandInput} for command's `input` shape. + * @see {@link TagProjectCommandOutput} for command's `response` shape. + * @see {@link CodeStarClientResolvedConfig | config} for command's `input` shape. + * */ export class TagProjectCommand extends $Command< TagProjectCommandInput, diff --git a/clients/client-codestar/commands/UntagProjectCommand.ts b/clients/client-codestar/commands/UntagProjectCommand.ts index 687f8ff92342..3a0f0712d786 100644 --- a/clients/client-codestar/commands/UntagProjectCommand.ts +++ b/clients/client-codestar/commands/UntagProjectCommand.ts @@ -22,6 +22,20 @@ export interface UntagProjectCommandOutput extends UntagProjectResult, __Metadat /** *

Removes tags from a project.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { CodeStarClient, UntagProjectCommand } from "@aws-sdk/client-codestar"; // ES Modules import + * // const { CodeStarClient, UntagProjectCommand } = require("@aws-sdk/client-codestar"); // CommonJS import + * const client = new CodeStarClient(config); + * const command = new UntagProjectCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link UntagProjectCommandInput} for command's `input` shape. + * @see {@link UntagProjectCommandOutput} for command's `response` shape. + * @see {@link CodeStarClientResolvedConfig | config} for command's `input` shape. + * */ export class UntagProjectCommand extends $Command< UntagProjectCommandInput, diff --git a/clients/client-codestar/commands/UpdateProjectCommand.ts b/clients/client-codestar/commands/UpdateProjectCommand.ts index 26cb4c4cba8d..2924a4957ebe 100644 --- a/clients/client-codestar/commands/UpdateProjectCommand.ts +++ b/clients/client-codestar/commands/UpdateProjectCommand.ts @@ -22,6 +22,20 @@ export interface UpdateProjectCommandOutput extends UpdateProjectResult, __Metad /** *

Updates a project in AWS CodeStar.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { CodeStarClient, UpdateProjectCommand } from "@aws-sdk/client-codestar"; // ES Modules import + * // const { CodeStarClient, UpdateProjectCommand } = require("@aws-sdk/client-codestar"); // CommonJS import + * const client = new CodeStarClient(config); + * const command = new UpdateProjectCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link UpdateProjectCommandInput} for command's `input` shape. + * @see {@link UpdateProjectCommandOutput} for command's `response` shape. + * @see {@link CodeStarClientResolvedConfig | config} for command's `input` shape. + * */ export class UpdateProjectCommand extends $Command< UpdateProjectCommandInput, diff --git a/clients/client-codestar/commands/UpdateTeamMemberCommand.ts b/clients/client-codestar/commands/UpdateTeamMemberCommand.ts index eb71d7c9102d..b6ee4d49fd02 100644 --- a/clients/client-codestar/commands/UpdateTeamMemberCommand.ts +++ b/clients/client-codestar/commands/UpdateTeamMemberCommand.ts @@ -24,6 +24,20 @@ export interface UpdateTeamMemberCommandOutput extends UpdateTeamMemberResult, _ *

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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { CodeStarClient, UpdateTeamMemberCommand } from "@aws-sdk/client-codestar"; // ES Modules import + * // const { CodeStarClient, UpdateTeamMemberCommand } = require("@aws-sdk/client-codestar"); // CommonJS import + * const client = new CodeStarClient(config); + * const command = new UpdateTeamMemberCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link UpdateTeamMemberCommandInput} for command's `input` shape. + * @see {@link UpdateTeamMemberCommandOutput} for command's `response` shape. + * @see {@link CodeStarClientResolvedConfig | config} for command's `input` shape. + * */ export class UpdateTeamMemberCommand extends $Command< UpdateTeamMemberCommandInput, diff --git a/clients/client-codestar/commands/UpdateUserProfileCommand.ts b/clients/client-codestar/commands/UpdateUserProfileCommand.ts index cbee9a50debc..a3a05df74cf7 100644 --- a/clients/client-codestar/commands/UpdateUserProfileCommand.ts +++ b/clients/client-codestar/commands/UpdateUserProfileCommand.ts @@ -24,6 +24,20 @@ export interface UpdateUserProfileCommandOutput extends UpdateUserProfileResult, *

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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { CodeStarClient, UpdateUserProfileCommand } from "@aws-sdk/client-codestar"; // ES Modules import + * // const { CodeStarClient, UpdateUserProfileCommand } = require("@aws-sdk/client-codestar"); // CommonJS import + * const client = new CodeStarClient(config); + * const command = new UpdateUserProfileCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link UpdateUserProfileCommandInput} for command's `input` shape. + * @see {@link UpdateUserProfileCommandOutput} for command's `response` shape. + * @see {@link CodeStarClientResolvedConfig | config} for command's `input` shape. + * */ export class UpdateUserProfileCommand extends $Command< UpdateUserProfileCommandInput, diff --git a/clients/client-codestar/models/models_0.ts b/clients/client-codestar/models/models_0.ts index 3957b1220fec..355b58ca38cb 100644 --- a/clients/client-codestar/models/models_0.ts +++ b/clients/client-codestar/models/models_0.ts @@ -33,6 +33,9 @@ export interface AssociateTeamMemberRequest { } export namespace AssociateTeamMemberRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: AssociateTeamMemberRequest): any => ({ ...obj, }); @@ -47,6 +50,9 @@ export interface AssociateTeamMemberResult { } export namespace AssociateTeamMemberResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: AssociateTeamMemberResult): any => ({ ...obj, }); @@ -63,6 +69,9 @@ export interface ConcurrentModificationException extends __SmithyException, $Met } export namespace ConcurrentModificationException { + /** + * @internal + */ export const filterSensitiveLog = (obj: ConcurrentModificationException): any => ({ ...obj, }); @@ -78,6 +87,9 @@ export interface InvalidServiceRoleException extends __SmithyException, $Metadat } export namespace InvalidServiceRoleException { + /** + * @internal + */ export const filterSensitiveLog = (obj: InvalidServiceRoleException): any => ({ ...obj, }); @@ -93,6 +105,9 @@ export interface LimitExceededException extends __SmithyException, $MetadataBear } export namespace LimitExceededException { + /** + * @internal + */ export const filterSensitiveLog = (obj: LimitExceededException): any => ({ ...obj, }); @@ -108,6 +123,9 @@ export interface ProjectConfigurationException extends __SmithyException, $Metad } export namespace ProjectConfigurationException { + /** + * @internal + */ export const filterSensitiveLog = (obj: ProjectConfigurationException): any => ({ ...obj, }); @@ -123,6 +141,9 @@ export interface ProjectNotFoundException extends __SmithyException, $MetadataBe } export namespace ProjectNotFoundException { + /** + * @internal + */ export const filterSensitiveLog = (obj: ProjectNotFoundException): any => ({ ...obj, }); @@ -138,6 +159,9 @@ export interface TeamMemberAlreadyAssociatedException extends __SmithyException, } export namespace TeamMemberAlreadyAssociatedException { + /** + * @internal + */ export const filterSensitiveLog = (obj: TeamMemberAlreadyAssociatedException): any => ({ ...obj, }); @@ -153,6 +177,9 @@ export interface ValidationException extends __SmithyException, $MetadataBearer } export namespace ValidationException { + /** + * @internal + */ export const filterSensitiveLog = (obj: ValidationException): any => ({ ...obj, }); @@ -170,6 +197,9 @@ export interface CodeCommitCodeDestination { } export namespace CodeCommitCodeDestination { + /** + * @internal + */ export const filterSensitiveLog = (obj: CodeCommitCodeDestination): any => ({ ...obj, }); @@ -219,6 +249,9 @@ export interface GitHubCodeDestination { } export namespace GitHubCodeDestination { + /** + * @internal + */ export const filterSensitiveLog = (obj: GitHubCodeDestination): any => ({ ...obj, ...(obj.token && { token: SENSITIVE_STRING }), @@ -244,6 +277,9 @@ export interface CodeDestination { } export namespace CodeDestination { + /** + * @internal + */ export const filterSensitiveLog = (obj: CodeDestination): any => ({ ...obj, ...(obj.gitHub && { gitHub: GitHubCodeDestination.filterSensitiveLog(obj.gitHub) }), @@ -269,6 +305,9 @@ export interface S3Location { } export namespace S3Location { + /** + * @internal + */ export const filterSensitiveLog = (obj: S3Location): any => ({ ...obj, }); @@ -287,6 +326,9 @@ export interface CodeSource { } export namespace CodeSource { + /** + * @internal + */ export const filterSensitiveLog = (obj: CodeSource): any => ({ ...obj, }); @@ -312,6 +354,9 @@ export interface Code { } export namespace Code { + /** + * @internal + */ export const filterSensitiveLog = (obj: Code): any => ({ ...obj, ...(obj.destination && { destination: CodeDestination.filterSensitiveLog(obj.destination) }), @@ -331,6 +376,9 @@ export interface ToolchainSource { } export namespace ToolchainSource { + /** + * @internal + */ export const filterSensitiveLog = (obj: ToolchainSource): any => ({ ...obj, }); @@ -361,6 +409,9 @@ export interface Toolchain { } export namespace Toolchain { + /** + * @internal + */ export const filterSensitiveLog = (obj: Toolchain): any => ({ ...obj, ...(obj.stackParameters && { stackParameters: SENSITIVE_STRING }), @@ -408,6 +459,9 @@ export interface CreateProjectRequest { } export namespace CreateProjectRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateProjectRequest): any => ({ ...obj, ...(obj.name && { name: SENSITIVE_STRING }), @@ -441,6 +495,9 @@ export interface CreateProjectResult { } export namespace CreateProjectResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateProjectResult): any => ({ ...obj, }); @@ -457,6 +514,9 @@ export interface ProjectAlreadyExistsException extends __SmithyException, $Metad } export namespace ProjectAlreadyExistsException { + /** + * @internal + */ export const filterSensitiveLog = (obj: ProjectAlreadyExistsException): any => ({ ...obj, }); @@ -473,6 +533,9 @@ export interface ProjectCreationFailedException extends __SmithyException, $Meta } export namespace ProjectCreationFailedException { + /** + * @internal + */ export const filterSensitiveLog = (obj: ProjectCreationFailedException): any => ({ ...obj, }); @@ -504,6 +567,9 @@ export interface CreateUserProfileRequest { } export namespace CreateUserProfileRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateUserProfileRequest): any => ({ ...obj, ...(obj.displayName && { displayName: SENSITIVE_STRING }), @@ -546,6 +612,9 @@ export interface CreateUserProfileResult { } export namespace CreateUserProfileResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateUserProfileResult): any => ({ ...obj, ...(obj.displayName && { displayName: SENSITIVE_STRING }), @@ -564,6 +633,9 @@ export interface UserProfileAlreadyExistsException extends __SmithyException, $M } export namespace UserProfileAlreadyExistsException { + /** + * @internal + */ export const filterSensitiveLog = (obj: UserProfileAlreadyExistsException): any => ({ ...obj, }); @@ -591,6 +663,9 @@ export interface DeleteProjectRequest { } export namespace DeleteProjectRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteProjectRequest): any => ({ ...obj, }); @@ -610,6 +685,9 @@ export interface DeleteProjectResult { } export namespace DeleteProjectResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteProjectResult): any => ({ ...obj, }); @@ -623,6 +701,9 @@ export interface DeleteUserProfileRequest { } export namespace DeleteUserProfileRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteUserProfileRequest): any => ({ ...obj, }); @@ -636,6 +717,9 @@ export interface DeleteUserProfileResult { } export namespace DeleteUserProfileResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteUserProfileResult): any => ({ ...obj, }); @@ -649,6 +733,9 @@ export interface DescribeProjectRequest { } export namespace DescribeProjectRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeProjectRequest): any => ({ ...obj, }); @@ -672,6 +759,9 @@ export interface ProjectStatus { } export namespace ProjectStatus { + /** + * @internal + */ export const filterSensitiveLog = (obj: ProjectStatus): any => ({ ...obj, }); @@ -727,6 +817,9 @@ export interface DescribeProjectResult { } export namespace DescribeProjectResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeProjectResult): any => ({ ...obj, ...(obj.name && { name: SENSITIVE_STRING }), @@ -742,6 +835,9 @@ export interface DescribeUserProfileRequest { } export namespace DescribeUserProfileRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeUserProfileRequest): any => ({ ...obj, }); @@ -792,6 +888,9 @@ export interface DescribeUserProfileResult { } export namespace DescribeUserProfileResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeUserProfileResult): any => ({ ...obj, ...(obj.displayName && { displayName: SENSITIVE_STRING }), @@ -809,6 +908,9 @@ export interface UserProfileNotFoundException extends __SmithyException, $Metada } export namespace UserProfileNotFoundException { + /** + * @internal + */ export const filterSensitiveLog = (obj: UserProfileNotFoundException): any => ({ ...obj, }); @@ -828,6 +930,9 @@ export interface DisassociateTeamMemberRequest { } export namespace DisassociateTeamMemberRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DisassociateTeamMemberRequest): any => ({ ...obj, }); @@ -836,6 +941,9 @@ export namespace DisassociateTeamMemberRequest { export interface DisassociateTeamMemberResult {} export namespace DisassociateTeamMemberResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: DisassociateTeamMemberResult): any => ({ ...obj, }); @@ -851,6 +959,9 @@ export interface InvalidNextTokenException extends __SmithyException, $MetadataB } export namespace InvalidNextTokenException { + /** + * @internal + */ export const filterSensitiveLog = (obj: InvalidNextTokenException): any => ({ ...obj, }); @@ -870,6 +981,9 @@ export interface ListProjectsRequest { } export namespace ListProjectsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListProjectsRequest): any => ({ ...obj, }); @@ -891,6 +1005,9 @@ export interface ProjectSummary { } export namespace ProjectSummary { + /** + * @internal + */ export const filterSensitiveLog = (obj: ProjectSummary): any => ({ ...obj, }); @@ -910,6 +1027,9 @@ export interface ListProjectsResult { } export namespace ListProjectsResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListProjectsResult): any => ({ ...obj, }); @@ -934,6 +1054,9 @@ export interface ListResourcesRequest { } export namespace ListResourcesRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListResourcesRequest): any => ({ ...obj, }); @@ -950,6 +1073,9 @@ export interface Resource { } export namespace Resource { + /** + * @internal + */ export const filterSensitiveLog = (obj: Resource): any => ({ ...obj, }); @@ -969,6 +1095,9 @@ export interface ListResourcesResult { } export namespace ListResourcesResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListResourcesResult): any => ({ ...obj, }); @@ -992,6 +1121,9 @@ export interface ListTagsForProjectRequest { } export namespace ListTagsForProjectRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListTagsForProjectRequest): any => ({ ...obj, }); @@ -1010,6 +1142,9 @@ export interface ListTagsForProjectResult { } export namespace ListTagsForProjectResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListTagsForProjectResult): any => ({ ...obj, }); @@ -1034,6 +1169,9 @@ export interface ListTeamMembersRequest { } export namespace ListTeamMembersRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListTeamMembersRequest): any => ({ ...obj, }); @@ -1063,6 +1201,9 @@ export interface TeamMember { } export namespace TeamMember { + /** + * @internal + */ export const filterSensitiveLog = (obj: TeamMember): any => ({ ...obj, }); @@ -1082,6 +1223,9 @@ export interface ListTeamMembersResult { } export namespace ListTeamMembersResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListTeamMembersResult): any => ({ ...obj, }); @@ -1101,6 +1245,9 @@ export interface ListUserProfilesRequest { } export namespace ListUserProfilesRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListUserProfilesRequest): any => ({ ...obj, }); @@ -1141,6 +1288,9 @@ export interface UserProfileSummary { } export namespace UserProfileSummary { + /** + * @internal + */ export const filterSensitiveLog = (obj: UserProfileSummary): any => ({ ...obj, ...(obj.displayName && { displayName: SENSITIVE_STRING }), @@ -1162,6 +1312,9 @@ export interface ListUserProfilesResult { } export namespace ListUserProfilesResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListUserProfilesResult): any => ({ ...obj, ...(obj.userProfiles && { @@ -1183,6 +1336,9 @@ export interface TagProjectRequest { } export namespace TagProjectRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: TagProjectRequest): any => ({ ...obj, }); @@ -1196,6 +1352,9 @@ export interface TagProjectResult { } export namespace TagProjectResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: TagProjectResult): any => ({ ...obj, }); @@ -1214,6 +1373,9 @@ export interface UntagProjectRequest { } export namespace UntagProjectRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: UntagProjectRequest): any => ({ ...obj, }); @@ -1222,6 +1384,9 @@ export namespace UntagProjectRequest { export interface UntagProjectResult {} export namespace UntagProjectResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: UntagProjectResult): any => ({ ...obj, }); @@ -1245,6 +1410,9 @@ export interface UpdateProjectRequest { } export namespace UpdateProjectRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateProjectRequest): any => ({ ...obj, ...(obj.name && { name: SENSITIVE_STRING }), @@ -1255,6 +1423,9 @@ export namespace UpdateProjectRequest { export interface UpdateProjectResult {} export namespace UpdateProjectResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateProjectResult): any => ({ ...obj, }); @@ -1270,6 +1441,9 @@ export interface TeamMemberNotFoundException extends __SmithyException, $Metadat } export namespace TeamMemberNotFoundException { + /** + * @internal + */ export const filterSensitiveLog = (obj: TeamMemberNotFoundException): any => ({ ...obj, }); @@ -1303,6 +1477,9 @@ export interface UpdateTeamMemberRequest { } export namespace UpdateTeamMemberRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateTeamMemberRequest): any => ({ ...obj, }); @@ -1328,6 +1505,9 @@ export interface UpdateTeamMemberResult { } export namespace UpdateTeamMemberResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateTeamMemberResult): any => ({ ...obj, }); @@ -1360,6 +1540,9 @@ export interface UpdateUserProfileRequest { } export namespace UpdateUserProfileRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateUserProfileRequest): any => ({ ...obj, ...(obj.displayName && { displayName: SENSITIVE_STRING }), @@ -1403,6 +1586,9 @@ export interface UpdateUserProfileResult { } export namespace UpdateUserProfileResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateUserProfileResult): any => ({ ...obj, ...(obj.displayName && { displayName: SENSITIVE_STRING }), diff --git a/clients/client-cognito-identity-provider/commands/AddCustomAttributesCommand.ts b/clients/client-cognito-identity-provider/commands/AddCustomAttributesCommand.ts index cba9c2837bb9..b614e77de805 100644 --- a/clients/client-cognito-identity-provider/commands/AddCustomAttributesCommand.ts +++ b/clients/client-cognito-identity-provider/commands/AddCustomAttributesCommand.ts @@ -27,6 +27,20 @@ export interface AddCustomAttributesCommandOutput extends AddCustomAttributesRes /** *

Adds additional user attributes to the user pool schema.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { CognitoIdentityProviderClient, AddCustomAttributesCommand } from "@aws-sdk/client-cognito-identity-provider"; // ES Modules import + * // const { CognitoIdentityProviderClient, AddCustomAttributesCommand } = require("@aws-sdk/client-cognito-identity-provider"); // CommonJS import + * const client = new CognitoIdentityProviderClient(config); + * const command = new AddCustomAttributesCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link AddCustomAttributesCommandInput} for command's `input` shape. + * @see {@link AddCustomAttributesCommandOutput} for command's `response` shape. + * @see {@link CognitoIdentityProviderClientResolvedConfig | config} for command's `input` shape. + * */ export class AddCustomAttributesCommand extends $Command< AddCustomAttributesCommandInput, diff --git a/clients/client-cognito-identity-provider/commands/AdminAddUserToGroupCommand.ts b/clients/client-cognito-identity-provider/commands/AdminAddUserToGroupCommand.ts index bae4de028482..da823b5c7707 100644 --- a/clients/client-cognito-identity-provider/commands/AdminAddUserToGroupCommand.ts +++ b/clients/client-cognito-identity-provider/commands/AdminAddUserToGroupCommand.ts @@ -28,6 +28,20 @@ export interface AdminAddUserToGroupCommandOutput extends __MetadataBearer {} /** *

Adds the specified user to the specified group.

*

Calling this action requires developer credentials.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { CognitoIdentityProviderClient, AdminAddUserToGroupCommand } from "@aws-sdk/client-cognito-identity-provider"; // ES Modules import + * // const { CognitoIdentityProviderClient, AdminAddUserToGroupCommand } = require("@aws-sdk/client-cognito-identity-provider"); // CommonJS import + * const client = new CognitoIdentityProviderClient(config); + * const command = new AdminAddUserToGroupCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link AdminAddUserToGroupCommandInput} for command's `input` shape. + * @see {@link AdminAddUserToGroupCommandOutput} for command's `response` shape. + * @see {@link CognitoIdentityProviderClientResolvedConfig | config} for command's `input` shape. + * */ export class AdminAddUserToGroupCommand extends $Command< AdminAddUserToGroupCommandInput, diff --git a/clients/client-cognito-identity-provider/commands/AdminConfirmSignUpCommand.ts b/clients/client-cognito-identity-provider/commands/AdminConfirmSignUpCommand.ts index dca2708e80c5..e2f9bbd33e30 100644 --- a/clients/client-cognito-identity-provider/commands/AdminConfirmSignUpCommand.ts +++ b/clients/client-cognito-identity-provider/commands/AdminConfirmSignUpCommand.ts @@ -29,6 +29,20 @@ export interface AdminConfirmSignUpCommandOutput extends AdminConfirmSignUpRespo *

Confirms user registration as an admin without using a confirmation code. Works on any * user.

*

Calling this action requires developer credentials.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { CognitoIdentityProviderClient, AdminConfirmSignUpCommand } from "@aws-sdk/client-cognito-identity-provider"; // ES Modules import + * // const { CognitoIdentityProviderClient, AdminConfirmSignUpCommand } = require("@aws-sdk/client-cognito-identity-provider"); // CommonJS import + * const client = new CognitoIdentityProviderClient(config); + * const command = new AdminConfirmSignUpCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link AdminConfirmSignUpCommandInput} for command's `input` shape. + * @see {@link AdminConfirmSignUpCommandOutput} for command's `response` shape. + * @see {@link CognitoIdentityProviderClientResolvedConfig | config} for command's `input` shape. + * */ export class AdminConfirmSignUpCommand extends $Command< AdminConfirmSignUpCommandInput, diff --git a/clients/client-cognito-identity-provider/commands/AdminCreateUserCommand.ts b/clients/client-cognito-identity-provider/commands/AdminCreateUserCommand.ts index 0f76cfb91e6e..4b9712e76977 100644 --- a/clients/client-cognito-identity-provider/commands/AdminCreateUserCommand.ts +++ b/clients/client-cognito-identity-provider/commands/AdminCreateUserCommand.ts @@ -38,6 +38,20 @@ export interface AdminCreateUserCommandOutput extends AdminCreateUserResponse, _ * they sign in and change their password.

*

* AdminCreateUser requires developer credentials.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { CognitoIdentityProviderClient, AdminCreateUserCommand } from "@aws-sdk/client-cognito-identity-provider"; // ES Modules import + * // const { CognitoIdentityProviderClient, AdminCreateUserCommand } = require("@aws-sdk/client-cognito-identity-provider"); // CommonJS import + * const client = new CognitoIdentityProviderClient(config); + * const command = new AdminCreateUserCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link AdminCreateUserCommandInput} for command's `input` shape. + * @see {@link AdminCreateUserCommandOutput} for command's `response` shape. + * @see {@link CognitoIdentityProviderClientResolvedConfig | config} for command's `input` shape. + * */ export class AdminCreateUserCommand extends $Command< AdminCreateUserCommandInput, diff --git a/clients/client-cognito-identity-provider/commands/AdminDeleteUserAttributesCommand.ts b/clients/client-cognito-identity-provider/commands/AdminDeleteUserAttributesCommand.ts index 8a285bb36e27..d049a8420a20 100644 --- a/clients/client-cognito-identity-provider/commands/AdminDeleteUserAttributesCommand.ts +++ b/clients/client-cognito-identity-provider/commands/AdminDeleteUserAttributesCommand.ts @@ -29,6 +29,20 @@ export interface AdminDeleteUserAttributesCommandOutput extends AdminDeleteUserA *

Deletes the user attributes in a user pool as an administrator. Works on any * user.

*

Calling this action requires developer credentials.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { CognitoIdentityProviderClient, AdminDeleteUserAttributesCommand } from "@aws-sdk/client-cognito-identity-provider"; // ES Modules import + * // const { CognitoIdentityProviderClient, AdminDeleteUserAttributesCommand } = require("@aws-sdk/client-cognito-identity-provider"); // CommonJS import + * const client = new CognitoIdentityProviderClient(config); + * const command = new AdminDeleteUserAttributesCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link AdminDeleteUserAttributesCommandInput} for command's `input` shape. + * @see {@link AdminDeleteUserAttributesCommandOutput} for command's `response` shape. + * @see {@link CognitoIdentityProviderClientResolvedConfig | config} for command's `input` shape. + * */ export class AdminDeleteUserAttributesCommand extends $Command< AdminDeleteUserAttributesCommandInput, diff --git a/clients/client-cognito-identity-provider/commands/AdminDeleteUserCommand.ts b/clients/client-cognito-identity-provider/commands/AdminDeleteUserCommand.ts index 4fc0f9c21bca..97cfb6ed560e 100644 --- a/clients/client-cognito-identity-provider/commands/AdminDeleteUserCommand.ts +++ b/clients/client-cognito-identity-provider/commands/AdminDeleteUserCommand.ts @@ -28,6 +28,20 @@ export interface AdminDeleteUserCommandOutput extends __MetadataBearer {} /** *

Deletes a user as an administrator. Works on any user.

*

Calling this action requires developer credentials.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { CognitoIdentityProviderClient, AdminDeleteUserCommand } from "@aws-sdk/client-cognito-identity-provider"; // ES Modules import + * // const { CognitoIdentityProviderClient, AdminDeleteUserCommand } = require("@aws-sdk/client-cognito-identity-provider"); // CommonJS import + * const client = new CognitoIdentityProviderClient(config); + * const command = new AdminDeleteUserCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link AdminDeleteUserCommandInput} for command's `input` shape. + * @see {@link AdminDeleteUserCommandOutput} for command's `response` shape. + * @see {@link CognitoIdentityProviderClientResolvedConfig | config} for command's `input` shape. + * */ export class AdminDeleteUserCommand extends $Command< AdminDeleteUserCommandInput, diff --git a/clients/client-cognito-identity-provider/commands/AdminDisableProviderForUserCommand.ts b/clients/client-cognito-identity-provider/commands/AdminDisableProviderForUserCommand.ts index c0ee5d3a3ba2..466369b631f6 100644 --- a/clients/client-cognito-identity-provider/commands/AdminDisableProviderForUserCommand.ts +++ b/clients/client-cognito-identity-provider/commands/AdminDisableProviderForUserCommand.ts @@ -56,6 +56,20 @@ export interface AdminDisableProviderForUserCommandOutput * ProviderAttributeName must be Cognito_Subject and * ProviderAttributeValue must be the subject of the SAML * assertion.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { CognitoIdentityProviderClient, AdminDisableProviderForUserCommand } from "@aws-sdk/client-cognito-identity-provider"; // ES Modules import + * // const { CognitoIdentityProviderClient, AdminDisableProviderForUserCommand } = require("@aws-sdk/client-cognito-identity-provider"); // CommonJS import + * const client = new CognitoIdentityProviderClient(config); + * const command = new AdminDisableProviderForUserCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link AdminDisableProviderForUserCommandInput} for command's `input` shape. + * @see {@link AdminDisableProviderForUserCommandOutput} for command's `response` shape. + * @see {@link CognitoIdentityProviderClientResolvedConfig | config} for command's `input` shape. + * */ export class AdminDisableProviderForUserCommand extends $Command< AdminDisableProviderForUserCommandInput, diff --git a/clients/client-cognito-identity-provider/commands/AdminDisableUserCommand.ts b/clients/client-cognito-identity-provider/commands/AdminDisableUserCommand.ts index e9387ebf24d9..5c81d27bbe14 100644 --- a/clients/client-cognito-identity-provider/commands/AdminDisableUserCommand.ts +++ b/clients/client-cognito-identity-provider/commands/AdminDisableUserCommand.ts @@ -28,6 +28,20 @@ export interface AdminDisableUserCommandOutput extends AdminDisableUserResponse, /** *

Disables the specified user.

*

Calling this action requires developer credentials.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { CognitoIdentityProviderClient, AdminDisableUserCommand } from "@aws-sdk/client-cognito-identity-provider"; // ES Modules import + * // const { CognitoIdentityProviderClient, AdminDisableUserCommand } = require("@aws-sdk/client-cognito-identity-provider"); // CommonJS import + * const client = new CognitoIdentityProviderClient(config); + * const command = new AdminDisableUserCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link AdminDisableUserCommandInput} for command's `input` shape. + * @see {@link AdminDisableUserCommandOutput} for command's `response` shape. + * @see {@link CognitoIdentityProviderClientResolvedConfig | config} for command's `input` shape. + * */ export class AdminDisableUserCommand extends $Command< AdminDisableUserCommandInput, diff --git a/clients/client-cognito-identity-provider/commands/AdminEnableUserCommand.ts b/clients/client-cognito-identity-provider/commands/AdminEnableUserCommand.ts index 713302fa5500..b5df0bbe6e37 100644 --- a/clients/client-cognito-identity-provider/commands/AdminEnableUserCommand.ts +++ b/clients/client-cognito-identity-provider/commands/AdminEnableUserCommand.ts @@ -28,6 +28,20 @@ export interface AdminEnableUserCommandOutput extends AdminEnableUserResponse, _ /** *

Enables the specified user as an administrator. Works on any user.

*

Calling this action requires developer credentials.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { CognitoIdentityProviderClient, AdminEnableUserCommand } from "@aws-sdk/client-cognito-identity-provider"; // ES Modules import + * // const { CognitoIdentityProviderClient, AdminEnableUserCommand } = require("@aws-sdk/client-cognito-identity-provider"); // CommonJS import + * const client = new CognitoIdentityProviderClient(config); + * const command = new AdminEnableUserCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link AdminEnableUserCommandInput} for command's `input` shape. + * @see {@link AdminEnableUserCommandOutput} for command's `response` shape. + * @see {@link CognitoIdentityProviderClientResolvedConfig | config} for command's `input` shape. + * */ export class AdminEnableUserCommand extends $Command< AdminEnableUserCommandInput, diff --git a/clients/client-cognito-identity-provider/commands/AdminForgetDeviceCommand.ts b/clients/client-cognito-identity-provider/commands/AdminForgetDeviceCommand.ts index 9b8ecd73175d..9321935183bb 100644 --- a/clients/client-cognito-identity-provider/commands/AdminForgetDeviceCommand.ts +++ b/clients/client-cognito-identity-provider/commands/AdminForgetDeviceCommand.ts @@ -28,6 +28,20 @@ export interface AdminForgetDeviceCommandOutput extends __MetadataBearer {} /** *

Forgets the device, as an administrator.

*

Calling this action requires developer credentials.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { CognitoIdentityProviderClient, AdminForgetDeviceCommand } from "@aws-sdk/client-cognito-identity-provider"; // ES Modules import + * // const { CognitoIdentityProviderClient, AdminForgetDeviceCommand } = require("@aws-sdk/client-cognito-identity-provider"); // CommonJS import + * const client = new CognitoIdentityProviderClient(config); + * const command = new AdminForgetDeviceCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link AdminForgetDeviceCommandInput} for command's `input` shape. + * @see {@link AdminForgetDeviceCommandOutput} for command's `response` shape. + * @see {@link CognitoIdentityProviderClientResolvedConfig | config} for command's `input` shape. + * */ export class AdminForgetDeviceCommand extends $Command< AdminForgetDeviceCommandInput, diff --git a/clients/client-cognito-identity-provider/commands/AdminGetDeviceCommand.ts b/clients/client-cognito-identity-provider/commands/AdminGetDeviceCommand.ts index 1984dfc2e35d..095d5313ed74 100644 --- a/clients/client-cognito-identity-provider/commands/AdminGetDeviceCommand.ts +++ b/clients/client-cognito-identity-provider/commands/AdminGetDeviceCommand.ts @@ -28,6 +28,20 @@ export interface AdminGetDeviceCommandOutput extends AdminGetDeviceResponse, __M /** *

Gets the device, as an administrator.

*

Calling this action requires developer credentials.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { CognitoIdentityProviderClient, AdminGetDeviceCommand } from "@aws-sdk/client-cognito-identity-provider"; // ES Modules import + * // const { CognitoIdentityProviderClient, AdminGetDeviceCommand } = require("@aws-sdk/client-cognito-identity-provider"); // CommonJS import + * const client = new CognitoIdentityProviderClient(config); + * const command = new AdminGetDeviceCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link AdminGetDeviceCommandInput} for command's `input` shape. + * @see {@link AdminGetDeviceCommandOutput} for command's `response` shape. + * @see {@link CognitoIdentityProviderClientResolvedConfig | config} for command's `input` shape. + * */ export class AdminGetDeviceCommand extends $Command< AdminGetDeviceCommandInput, diff --git a/clients/client-cognito-identity-provider/commands/AdminGetUserCommand.ts b/clients/client-cognito-identity-provider/commands/AdminGetUserCommand.ts index bad38b62981f..0f2cce63f3e1 100644 --- a/clients/client-cognito-identity-provider/commands/AdminGetUserCommand.ts +++ b/clients/client-cognito-identity-provider/commands/AdminGetUserCommand.ts @@ -29,6 +29,20 @@ export interface AdminGetUserCommandOutput extends AdminGetUserResponse, __Metad *

Gets the specified user by user name in a user pool as an administrator. Works on any * user.

*

Calling this action requires developer credentials.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { CognitoIdentityProviderClient, AdminGetUserCommand } from "@aws-sdk/client-cognito-identity-provider"; // ES Modules import + * // const { CognitoIdentityProviderClient, AdminGetUserCommand } = require("@aws-sdk/client-cognito-identity-provider"); // CommonJS import + * const client = new CognitoIdentityProviderClient(config); + * const command = new AdminGetUserCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link AdminGetUserCommandInput} for command's `input` shape. + * @see {@link AdminGetUserCommandOutput} for command's `response` shape. + * @see {@link CognitoIdentityProviderClientResolvedConfig | config} for command's `input` shape. + * */ export class AdminGetUserCommand extends $Command< AdminGetUserCommandInput, diff --git a/clients/client-cognito-identity-provider/commands/AdminInitiateAuthCommand.ts b/clients/client-cognito-identity-provider/commands/AdminInitiateAuthCommand.ts index 8fec87db3e70..f45445256f9b 100644 --- a/clients/client-cognito-identity-provider/commands/AdminInitiateAuthCommand.ts +++ b/clients/client-cognito-identity-provider/commands/AdminInitiateAuthCommand.ts @@ -28,6 +28,20 @@ export interface AdminInitiateAuthCommandOutput extends AdminInitiateAuthRespons /** *

Initiates the authentication flow, as an administrator.

*

Calling this action requires developer credentials.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { CognitoIdentityProviderClient, AdminInitiateAuthCommand } from "@aws-sdk/client-cognito-identity-provider"; // ES Modules import + * // const { CognitoIdentityProviderClient, AdminInitiateAuthCommand } = require("@aws-sdk/client-cognito-identity-provider"); // CommonJS import + * const client = new CognitoIdentityProviderClient(config); + * const command = new AdminInitiateAuthCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link AdminInitiateAuthCommandInput} for command's `input` shape. + * @see {@link AdminInitiateAuthCommandOutput} for command's `response` shape. + * @see {@link CognitoIdentityProviderClientResolvedConfig | config} for command's `input` shape. + * */ export class AdminInitiateAuthCommand extends $Command< AdminInitiateAuthCommandInput, diff --git a/clients/client-cognito-identity-provider/commands/AdminLinkProviderForUserCommand.ts b/clients/client-cognito-identity-provider/commands/AdminLinkProviderForUserCommand.ts index 353de9737a95..4a586b0a0dee 100644 --- a/clients/client-cognito-identity-provider/commands/AdminLinkProviderForUserCommand.ts +++ b/clients/client-cognito-identity-provider/commands/AdminLinkProviderForUserCommand.ts @@ -47,6 +47,20 @@ export interface AdminLinkProviderForUserCommandOutput extends AdminLinkProvider * *

This action is enabled only for admin access and requires developer * credentials.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { CognitoIdentityProviderClient, AdminLinkProviderForUserCommand } from "@aws-sdk/client-cognito-identity-provider"; // ES Modules import + * // const { CognitoIdentityProviderClient, AdminLinkProviderForUserCommand } = require("@aws-sdk/client-cognito-identity-provider"); // CommonJS import + * const client = new CognitoIdentityProviderClient(config); + * const command = new AdminLinkProviderForUserCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link AdminLinkProviderForUserCommandInput} for command's `input` shape. + * @see {@link AdminLinkProviderForUserCommandOutput} for command's `response` shape. + * @see {@link CognitoIdentityProviderClientResolvedConfig | config} for command's `input` shape. + * */ export class AdminLinkProviderForUserCommand extends $Command< AdminLinkProviderForUserCommandInput, diff --git a/clients/client-cognito-identity-provider/commands/AdminListDevicesCommand.ts b/clients/client-cognito-identity-provider/commands/AdminListDevicesCommand.ts index b705d0fc1c0c..4e0a8d6aa097 100644 --- a/clients/client-cognito-identity-provider/commands/AdminListDevicesCommand.ts +++ b/clients/client-cognito-identity-provider/commands/AdminListDevicesCommand.ts @@ -28,6 +28,20 @@ export interface AdminListDevicesCommandOutput extends AdminListDevicesResponse, /** *

Lists devices, as an administrator.

*

Calling this action requires developer credentials.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { CognitoIdentityProviderClient, AdminListDevicesCommand } from "@aws-sdk/client-cognito-identity-provider"; // ES Modules import + * // const { CognitoIdentityProviderClient, AdminListDevicesCommand } = require("@aws-sdk/client-cognito-identity-provider"); // CommonJS import + * const client = new CognitoIdentityProviderClient(config); + * const command = new AdminListDevicesCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link AdminListDevicesCommandInput} for command's `input` shape. + * @see {@link AdminListDevicesCommandOutput} for command's `response` shape. + * @see {@link CognitoIdentityProviderClientResolvedConfig | config} for command's `input` shape. + * */ export class AdminListDevicesCommand extends $Command< AdminListDevicesCommandInput, diff --git a/clients/client-cognito-identity-provider/commands/AdminListGroupsForUserCommand.ts b/clients/client-cognito-identity-provider/commands/AdminListGroupsForUserCommand.ts index fdc5d6a4ca62..bb560f2b2bf1 100644 --- a/clients/client-cognito-identity-provider/commands/AdminListGroupsForUserCommand.ts +++ b/clients/client-cognito-identity-provider/commands/AdminListGroupsForUserCommand.ts @@ -28,6 +28,20 @@ export interface AdminListGroupsForUserCommandOutput extends AdminListGroupsForU /** *

Lists the groups that the user belongs to.

*

Calling this action requires developer credentials.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { CognitoIdentityProviderClient, AdminListGroupsForUserCommand } from "@aws-sdk/client-cognito-identity-provider"; // ES Modules import + * // const { CognitoIdentityProviderClient, AdminListGroupsForUserCommand } = require("@aws-sdk/client-cognito-identity-provider"); // CommonJS import + * const client = new CognitoIdentityProviderClient(config); + * const command = new AdminListGroupsForUserCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link AdminListGroupsForUserCommandInput} for command's `input` shape. + * @see {@link AdminListGroupsForUserCommandOutput} for command's `response` shape. + * @see {@link CognitoIdentityProviderClientResolvedConfig | config} for command's `input` shape. + * */ export class AdminListGroupsForUserCommand extends $Command< AdminListGroupsForUserCommandInput, diff --git a/clients/client-cognito-identity-provider/commands/AdminListUserAuthEventsCommand.ts b/clients/client-cognito-identity-provider/commands/AdminListUserAuthEventsCommand.ts index 1bcb0301c3b0..9f1e1c029408 100644 --- a/clients/client-cognito-identity-provider/commands/AdminListUserAuthEventsCommand.ts +++ b/clients/client-cognito-identity-provider/commands/AdminListUserAuthEventsCommand.ts @@ -28,6 +28,20 @@ export interface AdminListUserAuthEventsCommandOutput extends AdminListUserAuthE /** *

Lists a history of user activity and any risks detected as part of Amazon Cognito * advanced security.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { CognitoIdentityProviderClient, AdminListUserAuthEventsCommand } from "@aws-sdk/client-cognito-identity-provider"; // ES Modules import + * // const { CognitoIdentityProviderClient, AdminListUserAuthEventsCommand } = require("@aws-sdk/client-cognito-identity-provider"); // CommonJS import + * const client = new CognitoIdentityProviderClient(config); + * const command = new AdminListUserAuthEventsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link AdminListUserAuthEventsCommandInput} for command's `input` shape. + * @see {@link AdminListUserAuthEventsCommandOutput} for command's `response` shape. + * @see {@link CognitoIdentityProviderClientResolvedConfig | config} for command's `input` shape. + * */ export class AdminListUserAuthEventsCommand extends $Command< AdminListUserAuthEventsCommandInput, diff --git a/clients/client-cognito-identity-provider/commands/AdminRemoveUserFromGroupCommand.ts b/clients/client-cognito-identity-provider/commands/AdminRemoveUserFromGroupCommand.ts index 57dbde4b40b5..cc67b987314d 100644 --- a/clients/client-cognito-identity-provider/commands/AdminRemoveUserFromGroupCommand.ts +++ b/clients/client-cognito-identity-provider/commands/AdminRemoveUserFromGroupCommand.ts @@ -28,6 +28,20 @@ export interface AdminRemoveUserFromGroupCommandOutput extends __MetadataBearer /** *

Removes the specified user from the specified group.

*

Calling this action requires developer credentials.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { CognitoIdentityProviderClient, AdminRemoveUserFromGroupCommand } from "@aws-sdk/client-cognito-identity-provider"; // ES Modules import + * // const { CognitoIdentityProviderClient, AdminRemoveUserFromGroupCommand } = require("@aws-sdk/client-cognito-identity-provider"); // CommonJS import + * const client = new CognitoIdentityProviderClient(config); + * const command = new AdminRemoveUserFromGroupCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link AdminRemoveUserFromGroupCommandInput} for command's `input` shape. + * @see {@link AdminRemoveUserFromGroupCommandOutput} for command's `response` shape. + * @see {@link CognitoIdentityProviderClientResolvedConfig | config} for command's `input` shape. + * */ export class AdminRemoveUserFromGroupCommand extends $Command< AdminRemoveUserFromGroupCommandInput, diff --git a/clients/client-cognito-identity-provider/commands/AdminResetUserPasswordCommand.ts b/clients/client-cognito-identity-provider/commands/AdminResetUserPasswordCommand.ts index 3880146e8c73..86329481003d 100644 --- a/clients/client-cognito-identity-provider/commands/AdminResetUserPasswordCommand.ts +++ b/clients/client-cognito-identity-provider/commands/AdminResetUserPasswordCommand.ts @@ -37,6 +37,20 @@ export interface AdminResetUserPasswordCommandOutput extends AdminResetUserPassw * calling this API will also result in sending a message to the end user with the code to * change their password.

*

Calling this action requires developer credentials.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { CognitoIdentityProviderClient, AdminResetUserPasswordCommand } from "@aws-sdk/client-cognito-identity-provider"; // ES Modules import + * // const { CognitoIdentityProviderClient, AdminResetUserPasswordCommand } = require("@aws-sdk/client-cognito-identity-provider"); // CommonJS import + * const client = new CognitoIdentityProviderClient(config); + * const command = new AdminResetUserPasswordCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link AdminResetUserPasswordCommandInput} for command's `input` shape. + * @see {@link AdminResetUserPasswordCommandOutput} for command's `response` shape. + * @see {@link CognitoIdentityProviderClientResolvedConfig | config} for command's `input` shape. + * */ export class AdminResetUserPasswordCommand extends $Command< AdminResetUserPasswordCommandInput, diff --git a/clients/client-cognito-identity-provider/commands/AdminRespondToAuthChallengeCommand.ts b/clients/client-cognito-identity-provider/commands/AdminRespondToAuthChallengeCommand.ts index d23ebb2f170a..ad71d0a10d93 100644 --- a/clients/client-cognito-identity-provider/commands/AdminRespondToAuthChallengeCommand.ts +++ b/clients/client-cognito-identity-provider/commands/AdminRespondToAuthChallengeCommand.ts @@ -30,6 +30,20 @@ export interface AdminRespondToAuthChallengeCommandOutput /** *

Responds to an authentication challenge, as an administrator.

*

Calling this action requires developer credentials.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { CognitoIdentityProviderClient, AdminRespondToAuthChallengeCommand } from "@aws-sdk/client-cognito-identity-provider"; // ES Modules import + * // const { CognitoIdentityProviderClient, AdminRespondToAuthChallengeCommand } = require("@aws-sdk/client-cognito-identity-provider"); // CommonJS import + * const client = new CognitoIdentityProviderClient(config); + * const command = new AdminRespondToAuthChallengeCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link AdminRespondToAuthChallengeCommandInput} for command's `input` shape. + * @see {@link AdminRespondToAuthChallengeCommandOutput} for command's `response` shape. + * @see {@link CognitoIdentityProviderClientResolvedConfig | config} for command's `input` shape. + * */ export class AdminRespondToAuthChallengeCommand extends $Command< AdminRespondToAuthChallengeCommandInput, diff --git a/clients/client-cognito-identity-provider/commands/AdminSetUserMFAPreferenceCommand.ts b/clients/client-cognito-identity-provider/commands/AdminSetUserMFAPreferenceCommand.ts index 8f441caa9092..a471b9b46454 100644 --- a/clients/client-cognito-identity-provider/commands/AdminSetUserMFAPreferenceCommand.ts +++ b/clients/client-cognito-identity-provider/commands/AdminSetUserMFAPreferenceCommand.ts @@ -31,6 +31,20 @@ export interface AdminSetUserMFAPreferenceCommandOutput extends AdminSetUserMFAP * The preferred MFA factor will be used to authenticate a user if multiple factors are * enabled. If multiple options are enabled and no preference is set, a challenge to choose * an MFA option will be returned during sign in.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { CognitoIdentityProviderClient, AdminSetUserMFAPreferenceCommand } from "@aws-sdk/client-cognito-identity-provider"; // ES Modules import + * // const { CognitoIdentityProviderClient, AdminSetUserMFAPreferenceCommand } = require("@aws-sdk/client-cognito-identity-provider"); // CommonJS import + * const client = new CognitoIdentityProviderClient(config); + * const command = new AdminSetUserMFAPreferenceCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link AdminSetUserMFAPreferenceCommandInput} for command's `input` shape. + * @see {@link AdminSetUserMFAPreferenceCommandOutput} for command's `response` shape. + * @see {@link CognitoIdentityProviderClientResolvedConfig | config} for command's `input` shape. + * */ export class AdminSetUserMFAPreferenceCommand extends $Command< AdminSetUserMFAPreferenceCommandInput, diff --git a/clients/client-cognito-identity-provider/commands/AdminSetUserPasswordCommand.ts b/clients/client-cognito-identity-provider/commands/AdminSetUserPasswordCommand.ts index a1df42496372..6d2e3e37f3f4 100644 --- a/clients/client-cognito-identity-provider/commands/AdminSetUserPasswordCommand.ts +++ b/clients/client-cognito-identity-provider/commands/AdminSetUserPasswordCommand.ts @@ -36,6 +36,20 @@ export interface AdminSetUserPasswordCommandOutput extends AdminSetUserPasswordR * by an administrator.

*

Once the user has set a new password, or the password is permanent, the user status * will be set to Confirmed.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { CognitoIdentityProviderClient, AdminSetUserPasswordCommand } from "@aws-sdk/client-cognito-identity-provider"; // ES Modules import + * // const { CognitoIdentityProviderClient, AdminSetUserPasswordCommand } = require("@aws-sdk/client-cognito-identity-provider"); // CommonJS import + * const client = new CognitoIdentityProviderClient(config); + * const command = new AdminSetUserPasswordCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link AdminSetUserPasswordCommandInput} for command's `input` shape. + * @see {@link AdminSetUserPasswordCommandOutput} for command's `response` shape. + * @see {@link CognitoIdentityProviderClientResolvedConfig | config} for command's `input` shape. + * */ export class AdminSetUserPasswordCommand extends $Command< AdminSetUserPasswordCommandInput, diff --git a/clients/client-cognito-identity-provider/commands/AdminSetUserSettingsCommand.ts b/clients/client-cognito-identity-provider/commands/AdminSetUserSettingsCommand.ts index 7842950468c8..4f33540228e5 100644 --- a/clients/client-cognito-identity-provider/commands/AdminSetUserSettingsCommand.ts +++ b/clients/client-cognito-identity-provider/commands/AdminSetUserSettingsCommand.ts @@ -30,6 +30,20 @@ export interface AdminSetUserSettingsCommandOutput extends AdminSetUserSettingsR * This action is no longer supported. You can use it to configure * only SMS MFA. You can't use it to configure TOTP software token MFA. To configure either * type of MFA, use AdminSetUserMFAPreference instead.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { CognitoIdentityProviderClient, AdminSetUserSettingsCommand } from "@aws-sdk/client-cognito-identity-provider"; // ES Modules import + * // const { CognitoIdentityProviderClient, AdminSetUserSettingsCommand } = require("@aws-sdk/client-cognito-identity-provider"); // CommonJS import + * const client = new CognitoIdentityProviderClient(config); + * const command = new AdminSetUserSettingsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link AdminSetUserSettingsCommandInput} for command's `input` shape. + * @see {@link AdminSetUserSettingsCommandOutput} for command's `response` shape. + * @see {@link CognitoIdentityProviderClientResolvedConfig | config} for command's `input` shape. + * */ export class AdminSetUserSettingsCommand extends $Command< AdminSetUserSettingsCommandInput, diff --git a/clients/client-cognito-identity-provider/commands/AdminUpdateAuthEventFeedbackCommand.ts b/clients/client-cognito-identity-provider/commands/AdminUpdateAuthEventFeedbackCommand.ts index af16d987d541..aa96ddba60e1 100644 --- a/clients/client-cognito-identity-provider/commands/AdminUpdateAuthEventFeedbackCommand.ts +++ b/clients/client-cognito-identity-provider/commands/AdminUpdateAuthEventFeedbackCommand.ts @@ -31,6 +31,20 @@ export interface AdminUpdateAuthEventFeedbackCommandOutput *

Provides feedback for an authentication event as to whether 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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { CognitoIdentityProviderClient, AdminUpdateAuthEventFeedbackCommand } from "@aws-sdk/client-cognito-identity-provider"; // ES Modules import + * // const { CognitoIdentityProviderClient, AdminUpdateAuthEventFeedbackCommand } = require("@aws-sdk/client-cognito-identity-provider"); // CommonJS import + * const client = new CognitoIdentityProviderClient(config); + * const command = new AdminUpdateAuthEventFeedbackCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link AdminUpdateAuthEventFeedbackCommandInput} for command's `input` shape. + * @see {@link AdminUpdateAuthEventFeedbackCommandOutput} for command's `response` shape. + * @see {@link CognitoIdentityProviderClientResolvedConfig | config} for command's `input` shape. + * */ export class AdminUpdateAuthEventFeedbackCommand extends $Command< AdminUpdateAuthEventFeedbackCommandInput, diff --git a/clients/client-cognito-identity-provider/commands/AdminUpdateDeviceStatusCommand.ts b/clients/client-cognito-identity-provider/commands/AdminUpdateDeviceStatusCommand.ts index d592b32deffc..126ae71f7af4 100644 --- a/clients/client-cognito-identity-provider/commands/AdminUpdateDeviceStatusCommand.ts +++ b/clients/client-cognito-identity-provider/commands/AdminUpdateDeviceStatusCommand.ts @@ -28,6 +28,20 @@ export interface AdminUpdateDeviceStatusCommandOutput extends AdminUpdateDeviceS /** *

Updates the device status as an administrator.

*

Calling this action requires developer credentials.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { CognitoIdentityProviderClient, AdminUpdateDeviceStatusCommand } from "@aws-sdk/client-cognito-identity-provider"; // ES Modules import + * // const { CognitoIdentityProviderClient, AdminUpdateDeviceStatusCommand } = require("@aws-sdk/client-cognito-identity-provider"); // CommonJS import + * const client = new CognitoIdentityProviderClient(config); + * const command = new AdminUpdateDeviceStatusCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link AdminUpdateDeviceStatusCommandInput} for command's `input` shape. + * @see {@link AdminUpdateDeviceStatusCommandOutput} for command's `response` shape. + * @see {@link CognitoIdentityProviderClientResolvedConfig | config} for command's `input` shape. + * */ export class AdminUpdateDeviceStatusCommand extends $Command< AdminUpdateDeviceStatusCommandInput, diff --git a/clients/client-cognito-identity-provider/commands/AdminUpdateUserAttributesCommand.ts b/clients/client-cognito-identity-provider/commands/AdminUpdateUserAttributesCommand.ts index 6e1748a73c2e..523be52cc0e5 100644 --- a/clients/client-cognito-identity-provider/commands/AdminUpdateUserAttributesCommand.ts +++ b/clients/client-cognito-identity-provider/commands/AdminUpdateUserAttributesCommand.ts @@ -33,6 +33,20 @@ export interface AdminUpdateUserAttributesCommandOutput extends AdminUpdateUserA *

In addition to updating user attributes, this API can also be used to mark phone and * email as verified.

*

Calling this action requires developer credentials.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { CognitoIdentityProviderClient, AdminUpdateUserAttributesCommand } from "@aws-sdk/client-cognito-identity-provider"; // ES Modules import + * // const { CognitoIdentityProviderClient, AdminUpdateUserAttributesCommand } = require("@aws-sdk/client-cognito-identity-provider"); // CommonJS import + * const client = new CognitoIdentityProviderClient(config); + * const command = new AdminUpdateUserAttributesCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link AdminUpdateUserAttributesCommandInput} for command's `input` shape. + * @see {@link AdminUpdateUserAttributesCommandOutput} for command's `response` shape. + * @see {@link CognitoIdentityProviderClientResolvedConfig | config} for command's `input` shape. + * */ export class AdminUpdateUserAttributesCommand extends $Command< AdminUpdateUserAttributesCommandInput, diff --git a/clients/client-cognito-identity-provider/commands/AdminUserGlobalSignOutCommand.ts b/clients/client-cognito-identity-provider/commands/AdminUserGlobalSignOutCommand.ts index 3e016c913261..186f15316a5f 100644 --- a/clients/client-cognito-identity-provider/commands/AdminUserGlobalSignOutCommand.ts +++ b/clients/client-cognito-identity-provider/commands/AdminUserGlobalSignOutCommand.ts @@ -30,6 +30,20 @@ export interface AdminUserGlobalSignOutCommandOutput extends AdminUserGlobalSign * tokens issued to a user. The user's current access and Id tokens remain valid until * their expiry. Access and Id tokens expire one hour after they are issued.

*

Calling this action requires developer credentials.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { CognitoIdentityProviderClient, AdminUserGlobalSignOutCommand } from "@aws-sdk/client-cognito-identity-provider"; // ES Modules import + * // const { CognitoIdentityProviderClient, AdminUserGlobalSignOutCommand } = require("@aws-sdk/client-cognito-identity-provider"); // CommonJS import + * const client = new CognitoIdentityProviderClient(config); + * const command = new AdminUserGlobalSignOutCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link AdminUserGlobalSignOutCommandInput} for command's `input` shape. + * @see {@link AdminUserGlobalSignOutCommandOutput} for command's `response` shape. + * @see {@link CognitoIdentityProviderClientResolvedConfig | config} for command's `input` shape. + * */ export class AdminUserGlobalSignOutCommand extends $Command< AdminUserGlobalSignOutCommandInput, diff --git a/clients/client-cognito-identity-provider/commands/AssociateSoftwareTokenCommand.ts b/clients/client-cognito-identity-provider/commands/AssociateSoftwareTokenCommand.ts index de6eff10331f..5c7d9432e833 100644 --- a/clients/client-cognito-identity-provider/commands/AssociateSoftwareTokenCommand.ts +++ b/clients/client-cognito-identity-provider/commands/AssociateSoftwareTokenCommand.ts @@ -28,6 +28,20 @@ export interface AssociateSoftwareTokenCommandOutput extends AssociateSoftwareTo /** *

Returns a unique generated shared secret key code for the user account. The request * takes an access token or a session string, but not both.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { CognitoIdentityProviderClient, AssociateSoftwareTokenCommand } from "@aws-sdk/client-cognito-identity-provider"; // ES Modules import + * // const { CognitoIdentityProviderClient, AssociateSoftwareTokenCommand } = require("@aws-sdk/client-cognito-identity-provider"); // CommonJS import + * const client = new CognitoIdentityProviderClient(config); + * const command = new AssociateSoftwareTokenCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link AssociateSoftwareTokenCommandInput} for command's `input` shape. + * @see {@link AssociateSoftwareTokenCommandOutput} for command's `response` shape. + * @see {@link CognitoIdentityProviderClientResolvedConfig | config} for command's `input` shape. + * */ export class AssociateSoftwareTokenCommand extends $Command< AssociateSoftwareTokenCommandInput, diff --git a/clients/client-cognito-identity-provider/commands/ChangePasswordCommand.ts b/clients/client-cognito-identity-provider/commands/ChangePasswordCommand.ts index 80fb6dcce784..9a1862f36dc0 100644 --- a/clients/client-cognito-identity-provider/commands/ChangePasswordCommand.ts +++ b/clients/client-cognito-identity-provider/commands/ChangePasswordCommand.ts @@ -26,6 +26,20 @@ export interface ChangePasswordCommandOutput extends ChangePasswordResponse, __M /** *

Changes the password for a specified user in a user pool.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { CognitoIdentityProviderClient, ChangePasswordCommand } from "@aws-sdk/client-cognito-identity-provider"; // ES Modules import + * // const { CognitoIdentityProviderClient, ChangePasswordCommand } = require("@aws-sdk/client-cognito-identity-provider"); // CommonJS import + * const client = new CognitoIdentityProviderClient(config); + * const command = new ChangePasswordCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ChangePasswordCommandInput} for command's `input` shape. + * @see {@link ChangePasswordCommandOutput} for command's `response` shape. + * @see {@link CognitoIdentityProviderClientResolvedConfig | config} for command's `input` shape. + * */ export class ChangePasswordCommand extends $Command< ChangePasswordCommandInput, diff --git a/clients/client-cognito-identity-provider/commands/ConfirmDeviceCommand.ts b/clients/client-cognito-identity-provider/commands/ConfirmDeviceCommand.ts index 77a125800aa7..bf45832a671b 100644 --- a/clients/client-cognito-identity-provider/commands/ConfirmDeviceCommand.ts +++ b/clients/client-cognito-identity-provider/commands/ConfirmDeviceCommand.ts @@ -28,6 +28,20 @@ export interface ConfirmDeviceCommandOutput extends ConfirmDeviceResponse, __Met /** *

Confirms tracking of the device. This API call is the call that begins device * tracking.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { CognitoIdentityProviderClient, ConfirmDeviceCommand } from "@aws-sdk/client-cognito-identity-provider"; // ES Modules import + * // const { CognitoIdentityProviderClient, ConfirmDeviceCommand } = require("@aws-sdk/client-cognito-identity-provider"); // CommonJS import + * const client = new CognitoIdentityProviderClient(config); + * const command = new ConfirmDeviceCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ConfirmDeviceCommandInput} for command's `input` shape. + * @see {@link ConfirmDeviceCommandOutput} for command's `response` shape. + * @see {@link CognitoIdentityProviderClientResolvedConfig | config} for command's `input` shape. + * */ export class ConfirmDeviceCommand extends $Command< ConfirmDeviceCommandInput, diff --git a/clients/client-cognito-identity-provider/commands/ConfirmForgotPasswordCommand.ts b/clients/client-cognito-identity-provider/commands/ConfirmForgotPasswordCommand.ts index 52789f863ba4..4b40af364dd0 100644 --- a/clients/client-cognito-identity-provider/commands/ConfirmForgotPasswordCommand.ts +++ b/clients/client-cognito-identity-provider/commands/ConfirmForgotPasswordCommand.ts @@ -26,6 +26,20 @@ export interface ConfirmForgotPasswordCommandOutput extends ConfirmForgotPasswor /** *

Allows a user to enter a confirmation code to reset a forgotten password.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { CognitoIdentityProviderClient, ConfirmForgotPasswordCommand } from "@aws-sdk/client-cognito-identity-provider"; // ES Modules import + * // const { CognitoIdentityProviderClient, ConfirmForgotPasswordCommand } = require("@aws-sdk/client-cognito-identity-provider"); // CommonJS import + * const client = new CognitoIdentityProviderClient(config); + * const command = new ConfirmForgotPasswordCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ConfirmForgotPasswordCommandInput} for command's `input` shape. + * @see {@link ConfirmForgotPasswordCommandOutput} for command's `response` shape. + * @see {@link CognitoIdentityProviderClientResolvedConfig | config} for command's `input` shape. + * */ export class ConfirmForgotPasswordCommand extends $Command< ConfirmForgotPasswordCommandInput, diff --git a/clients/client-cognito-identity-provider/commands/ConfirmSignUpCommand.ts b/clients/client-cognito-identity-provider/commands/ConfirmSignUpCommand.ts index a94db58a2e66..6c1dedeac90b 100644 --- a/clients/client-cognito-identity-provider/commands/ConfirmSignUpCommand.ts +++ b/clients/client-cognito-identity-provider/commands/ConfirmSignUpCommand.ts @@ -27,6 +27,20 @@ export interface ConfirmSignUpCommandOutput extends ConfirmSignUpResponse, __Met /** *

Confirms registration of a user and handles the existing alias from a previous * user.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { CognitoIdentityProviderClient, ConfirmSignUpCommand } from "@aws-sdk/client-cognito-identity-provider"; // ES Modules import + * // const { CognitoIdentityProviderClient, ConfirmSignUpCommand } = require("@aws-sdk/client-cognito-identity-provider"); // CommonJS import + * const client = new CognitoIdentityProviderClient(config); + * const command = new ConfirmSignUpCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ConfirmSignUpCommandInput} for command's `input` shape. + * @see {@link ConfirmSignUpCommandOutput} for command's `response` shape. + * @see {@link CognitoIdentityProviderClientResolvedConfig | config} for command's `input` shape. + * */ export class ConfirmSignUpCommand extends $Command< ConfirmSignUpCommandInput, diff --git a/clients/client-cognito-identity-provider/commands/CreateGroupCommand.ts b/clients/client-cognito-identity-provider/commands/CreateGroupCommand.ts index c25946766179..5d022a91177d 100644 --- a/clients/client-cognito-identity-provider/commands/CreateGroupCommand.ts +++ b/clients/client-cognito-identity-provider/commands/CreateGroupCommand.ts @@ -28,6 +28,20 @@ export interface CreateGroupCommandOutput extends CreateGroupResponse, __Metadat /** *

Creates a new group in the specified user pool.

*

Calling this action requires developer credentials.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { CognitoIdentityProviderClient, CreateGroupCommand } from "@aws-sdk/client-cognito-identity-provider"; // ES Modules import + * // const { CognitoIdentityProviderClient, CreateGroupCommand } = require("@aws-sdk/client-cognito-identity-provider"); // CommonJS import + * const client = new CognitoIdentityProviderClient(config); + * const command = new CreateGroupCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreateGroupCommandInput} for command's `input` shape. + * @see {@link CreateGroupCommandOutput} for command's `response` shape. + * @see {@link CognitoIdentityProviderClientResolvedConfig | config} for command's `input` shape. + * */ export class CreateGroupCommand extends $Command< CreateGroupCommandInput, diff --git a/clients/client-cognito-identity-provider/commands/CreateIdentityProviderCommand.ts b/clients/client-cognito-identity-provider/commands/CreateIdentityProviderCommand.ts index 9e5edf2e7fa8..7675353f07c3 100644 --- a/clients/client-cognito-identity-provider/commands/CreateIdentityProviderCommand.ts +++ b/clients/client-cognito-identity-provider/commands/CreateIdentityProviderCommand.ts @@ -27,6 +27,20 @@ export interface CreateIdentityProviderCommandOutput extends CreateIdentityProvi /** *

Creates an identity provider for a user pool.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { CognitoIdentityProviderClient, CreateIdentityProviderCommand } from "@aws-sdk/client-cognito-identity-provider"; // ES Modules import + * // const { CognitoIdentityProviderClient, CreateIdentityProviderCommand } = require("@aws-sdk/client-cognito-identity-provider"); // CommonJS import + * const client = new CognitoIdentityProviderClient(config); + * const command = new CreateIdentityProviderCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreateIdentityProviderCommandInput} for command's `input` shape. + * @see {@link CreateIdentityProviderCommandOutput} for command's `response` shape. + * @see {@link CognitoIdentityProviderClientResolvedConfig | config} for command's `input` shape. + * */ export class CreateIdentityProviderCommand extends $Command< CreateIdentityProviderCommandInput, diff --git a/clients/client-cognito-identity-provider/commands/CreateResourceServerCommand.ts b/clients/client-cognito-identity-provider/commands/CreateResourceServerCommand.ts index 14808277b19a..401c9fd5b273 100644 --- a/clients/client-cognito-identity-provider/commands/CreateResourceServerCommand.ts +++ b/clients/client-cognito-identity-provider/commands/CreateResourceServerCommand.ts @@ -27,6 +27,20 @@ export interface CreateResourceServerCommandOutput extends CreateResourceServerR /** *

Creates a new OAuth2.0 resource server and defines custom scopes in it.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { CognitoIdentityProviderClient, CreateResourceServerCommand } from "@aws-sdk/client-cognito-identity-provider"; // ES Modules import + * // const { CognitoIdentityProviderClient, CreateResourceServerCommand } = require("@aws-sdk/client-cognito-identity-provider"); // CommonJS import + * const client = new CognitoIdentityProviderClient(config); + * const command = new CreateResourceServerCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreateResourceServerCommandInput} for command's `input` shape. + * @see {@link CreateResourceServerCommandOutput} for command's `response` shape. + * @see {@link CognitoIdentityProviderClientResolvedConfig | config} for command's `input` shape. + * */ export class CreateResourceServerCommand extends $Command< CreateResourceServerCommandInput, diff --git a/clients/client-cognito-identity-provider/commands/CreateUserImportJobCommand.ts b/clients/client-cognito-identity-provider/commands/CreateUserImportJobCommand.ts index 59d8e5fa9404..ef96a32a7c19 100644 --- a/clients/client-cognito-identity-provider/commands/CreateUserImportJobCommand.ts +++ b/clients/client-cognito-identity-provider/commands/CreateUserImportJobCommand.ts @@ -27,6 +27,20 @@ export interface CreateUserImportJobCommandOutput extends CreateUserImportJobRes /** *

Creates the user import job.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { CognitoIdentityProviderClient, CreateUserImportJobCommand } from "@aws-sdk/client-cognito-identity-provider"; // ES Modules import + * // const { CognitoIdentityProviderClient, CreateUserImportJobCommand } = require("@aws-sdk/client-cognito-identity-provider"); // CommonJS import + * const client = new CognitoIdentityProviderClient(config); + * const command = new CreateUserImportJobCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreateUserImportJobCommandInput} for command's `input` shape. + * @see {@link CreateUserImportJobCommandOutput} for command's `response` shape. + * @see {@link CognitoIdentityProviderClientResolvedConfig | config} for command's `input` shape. + * */ export class CreateUserImportJobCommand extends $Command< CreateUserImportJobCommandInput, diff --git a/clients/client-cognito-identity-provider/commands/CreateUserPoolClientCommand.ts b/clients/client-cognito-identity-provider/commands/CreateUserPoolClientCommand.ts index 44d2c4af2266..901fa8a425fc 100644 --- a/clients/client-cognito-identity-provider/commands/CreateUserPoolClientCommand.ts +++ b/clients/client-cognito-identity-provider/commands/CreateUserPoolClientCommand.ts @@ -27,6 +27,20 @@ export interface CreateUserPoolClientCommandOutput extends CreateUserPoolClientR /** *

Creates the user pool client.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { CognitoIdentityProviderClient, CreateUserPoolClientCommand } from "@aws-sdk/client-cognito-identity-provider"; // ES Modules import + * // const { CognitoIdentityProviderClient, CreateUserPoolClientCommand } = require("@aws-sdk/client-cognito-identity-provider"); // CommonJS import + * const client = new CognitoIdentityProviderClient(config); + * const command = new CreateUserPoolClientCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreateUserPoolClientCommandInput} for command's `input` shape. + * @see {@link CreateUserPoolClientCommandOutput} for command's `response` shape. + * @see {@link CognitoIdentityProviderClientResolvedConfig | config} for command's `input` shape. + * */ export class CreateUserPoolClientCommand extends $Command< CreateUserPoolClientCommandInput, diff --git a/clients/client-cognito-identity-provider/commands/CreateUserPoolCommand.ts b/clients/client-cognito-identity-provider/commands/CreateUserPoolCommand.ts index c0cc3b1b10bb..da903c041745 100644 --- a/clients/client-cognito-identity-provider/commands/CreateUserPoolCommand.ts +++ b/clients/client-cognito-identity-provider/commands/CreateUserPoolCommand.ts @@ -28,6 +28,20 @@ export interface CreateUserPoolCommandOutput extends CreateUserPoolResponse, __M /** *

Creates a new Amazon Cognito user pool and sets the password policy for the * pool.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { CognitoIdentityProviderClient, CreateUserPoolCommand } from "@aws-sdk/client-cognito-identity-provider"; // ES Modules import + * // const { CognitoIdentityProviderClient, CreateUserPoolCommand } = require("@aws-sdk/client-cognito-identity-provider"); // CommonJS import + * const client = new CognitoIdentityProviderClient(config); + * const command = new CreateUserPoolCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreateUserPoolCommandInput} for command's `input` shape. + * @see {@link CreateUserPoolCommandOutput} for command's `response` shape. + * @see {@link CognitoIdentityProviderClientResolvedConfig | config} for command's `input` shape. + * */ export class CreateUserPoolCommand extends $Command< CreateUserPoolCommandInput, diff --git a/clients/client-cognito-identity-provider/commands/CreateUserPoolDomainCommand.ts b/clients/client-cognito-identity-provider/commands/CreateUserPoolDomainCommand.ts index d9fdc12b1fa9..29a6837cab27 100644 --- a/clients/client-cognito-identity-provider/commands/CreateUserPoolDomainCommand.ts +++ b/clients/client-cognito-identity-provider/commands/CreateUserPoolDomainCommand.ts @@ -27,6 +27,20 @@ export interface CreateUserPoolDomainCommandOutput extends CreateUserPoolDomainR /** *

Creates a new domain for a user pool.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { CognitoIdentityProviderClient, CreateUserPoolDomainCommand } from "@aws-sdk/client-cognito-identity-provider"; // ES Modules import + * // const { CognitoIdentityProviderClient, CreateUserPoolDomainCommand } = require("@aws-sdk/client-cognito-identity-provider"); // CommonJS import + * const client = new CognitoIdentityProviderClient(config); + * const command = new CreateUserPoolDomainCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreateUserPoolDomainCommandInput} for command's `input` shape. + * @see {@link CreateUserPoolDomainCommandOutput} for command's `response` shape. + * @see {@link CognitoIdentityProviderClientResolvedConfig | config} for command's `input` shape. + * */ export class CreateUserPoolDomainCommand extends $Command< CreateUserPoolDomainCommandInput, diff --git a/clients/client-cognito-identity-provider/commands/DeleteGroupCommand.ts b/clients/client-cognito-identity-provider/commands/DeleteGroupCommand.ts index 0002419bff67..301495f29ee0 100644 --- a/clients/client-cognito-identity-provider/commands/DeleteGroupCommand.ts +++ b/clients/client-cognito-identity-provider/commands/DeleteGroupCommand.ts @@ -28,6 +28,20 @@ export interface DeleteGroupCommandOutput extends __MetadataBearer {} /** *

Deletes a group.

*

Calling this action requires developer credentials.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { CognitoIdentityProviderClient, DeleteGroupCommand } from "@aws-sdk/client-cognito-identity-provider"; // ES Modules import + * // const { CognitoIdentityProviderClient, DeleteGroupCommand } = require("@aws-sdk/client-cognito-identity-provider"); // CommonJS import + * const client = new CognitoIdentityProviderClient(config); + * const command = new DeleteGroupCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteGroupCommandInput} for command's `input` shape. + * @see {@link DeleteGroupCommandOutput} for command's `response` shape. + * @see {@link CognitoIdentityProviderClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteGroupCommand extends $Command< DeleteGroupCommandInput, diff --git a/clients/client-cognito-identity-provider/commands/DeleteIdentityProviderCommand.ts b/clients/client-cognito-identity-provider/commands/DeleteIdentityProviderCommand.ts index ca6505cfd107..8e3264fb30f7 100644 --- a/clients/client-cognito-identity-provider/commands/DeleteIdentityProviderCommand.ts +++ b/clients/client-cognito-identity-provider/commands/DeleteIdentityProviderCommand.ts @@ -27,6 +27,20 @@ export interface DeleteIdentityProviderCommandOutput extends __MetadataBearer {} /** *

Deletes an identity provider for a user pool.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { CognitoIdentityProviderClient, DeleteIdentityProviderCommand } from "@aws-sdk/client-cognito-identity-provider"; // ES Modules import + * // const { CognitoIdentityProviderClient, DeleteIdentityProviderCommand } = require("@aws-sdk/client-cognito-identity-provider"); // CommonJS import + * const client = new CognitoIdentityProviderClient(config); + * const command = new DeleteIdentityProviderCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteIdentityProviderCommandInput} for command's `input` shape. + * @see {@link DeleteIdentityProviderCommandOutput} for command's `response` shape. + * @see {@link CognitoIdentityProviderClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteIdentityProviderCommand extends $Command< DeleteIdentityProviderCommandInput, diff --git a/clients/client-cognito-identity-provider/commands/DeleteResourceServerCommand.ts b/clients/client-cognito-identity-provider/commands/DeleteResourceServerCommand.ts index 418ea0280895..05e3a152575b 100644 --- a/clients/client-cognito-identity-provider/commands/DeleteResourceServerCommand.ts +++ b/clients/client-cognito-identity-provider/commands/DeleteResourceServerCommand.ts @@ -27,6 +27,20 @@ export interface DeleteResourceServerCommandOutput extends __MetadataBearer {} /** *

Deletes a resource server.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { CognitoIdentityProviderClient, DeleteResourceServerCommand } from "@aws-sdk/client-cognito-identity-provider"; // ES Modules import + * // const { CognitoIdentityProviderClient, DeleteResourceServerCommand } = require("@aws-sdk/client-cognito-identity-provider"); // CommonJS import + * const client = new CognitoIdentityProviderClient(config); + * const command = new DeleteResourceServerCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteResourceServerCommandInput} for command's `input` shape. + * @see {@link DeleteResourceServerCommandOutput} for command's `response` shape. + * @see {@link CognitoIdentityProviderClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteResourceServerCommand extends $Command< DeleteResourceServerCommandInput, diff --git a/clients/client-cognito-identity-provider/commands/DeleteUserAttributesCommand.ts b/clients/client-cognito-identity-provider/commands/DeleteUserAttributesCommand.ts index 5d9e911039a3..1bc406d022d3 100644 --- a/clients/client-cognito-identity-provider/commands/DeleteUserAttributesCommand.ts +++ b/clients/client-cognito-identity-provider/commands/DeleteUserAttributesCommand.ts @@ -26,6 +26,20 @@ export interface DeleteUserAttributesCommandOutput extends DeleteUserAttributesR /** *

Deletes the attributes for a user.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { CognitoIdentityProviderClient, DeleteUserAttributesCommand } from "@aws-sdk/client-cognito-identity-provider"; // ES Modules import + * // const { CognitoIdentityProviderClient, DeleteUserAttributesCommand } = require("@aws-sdk/client-cognito-identity-provider"); // CommonJS import + * const client = new CognitoIdentityProviderClient(config); + * const command = new DeleteUserAttributesCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteUserAttributesCommandInput} for command's `input` shape. + * @see {@link DeleteUserAttributesCommandOutput} for command's `response` shape. + * @see {@link CognitoIdentityProviderClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteUserAttributesCommand extends $Command< DeleteUserAttributesCommandInput, diff --git a/clients/client-cognito-identity-provider/commands/DeleteUserCommand.ts b/clients/client-cognito-identity-provider/commands/DeleteUserCommand.ts index a7be3a11c74e..e785baf5c55a 100644 --- a/clients/client-cognito-identity-provider/commands/DeleteUserCommand.ts +++ b/clients/client-cognito-identity-provider/commands/DeleteUserCommand.ts @@ -26,6 +26,20 @@ export interface DeleteUserCommandOutput extends __MetadataBearer {} /** *

Allows a user to delete himself or herself.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { CognitoIdentityProviderClient, DeleteUserCommand } from "@aws-sdk/client-cognito-identity-provider"; // ES Modules import + * // const { CognitoIdentityProviderClient, DeleteUserCommand } = require("@aws-sdk/client-cognito-identity-provider"); // CommonJS import + * const client = new CognitoIdentityProviderClient(config); + * const command = new DeleteUserCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteUserCommandInput} for command's `input` shape. + * @see {@link DeleteUserCommandOutput} for command's `response` shape. + * @see {@link CognitoIdentityProviderClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteUserCommand extends $Command< DeleteUserCommandInput, diff --git a/clients/client-cognito-identity-provider/commands/DeleteUserPoolClientCommand.ts b/clients/client-cognito-identity-provider/commands/DeleteUserPoolClientCommand.ts index 56bf7b9a33dc..58fc24ad8f7e 100644 --- a/clients/client-cognito-identity-provider/commands/DeleteUserPoolClientCommand.ts +++ b/clients/client-cognito-identity-provider/commands/DeleteUserPoolClientCommand.ts @@ -27,6 +27,20 @@ export interface DeleteUserPoolClientCommandOutput extends __MetadataBearer {} /** *

Allows the developer to delete the user pool client.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { CognitoIdentityProviderClient, DeleteUserPoolClientCommand } from "@aws-sdk/client-cognito-identity-provider"; // ES Modules import + * // const { CognitoIdentityProviderClient, DeleteUserPoolClientCommand } = require("@aws-sdk/client-cognito-identity-provider"); // CommonJS import + * const client = new CognitoIdentityProviderClient(config); + * const command = new DeleteUserPoolClientCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteUserPoolClientCommandInput} for command's `input` shape. + * @see {@link DeleteUserPoolClientCommandOutput} for command's `response` shape. + * @see {@link CognitoIdentityProviderClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteUserPoolClientCommand extends $Command< DeleteUserPoolClientCommandInput, diff --git a/clients/client-cognito-identity-provider/commands/DeleteUserPoolCommand.ts b/clients/client-cognito-identity-provider/commands/DeleteUserPoolCommand.ts index ff9fcdab8740..52978822e2f5 100644 --- a/clients/client-cognito-identity-provider/commands/DeleteUserPoolCommand.ts +++ b/clients/client-cognito-identity-provider/commands/DeleteUserPoolCommand.ts @@ -27,6 +27,20 @@ export interface DeleteUserPoolCommandOutput extends __MetadataBearer {} /** *

Deletes the specified Amazon Cognito user pool.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { CognitoIdentityProviderClient, DeleteUserPoolCommand } from "@aws-sdk/client-cognito-identity-provider"; // ES Modules import + * // const { CognitoIdentityProviderClient, DeleteUserPoolCommand } = require("@aws-sdk/client-cognito-identity-provider"); // CommonJS import + * const client = new CognitoIdentityProviderClient(config); + * const command = new DeleteUserPoolCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteUserPoolCommandInput} for command's `input` shape. + * @see {@link DeleteUserPoolCommandOutput} for command's `response` shape. + * @see {@link CognitoIdentityProviderClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteUserPoolCommand extends $Command< DeleteUserPoolCommandInput, diff --git a/clients/client-cognito-identity-provider/commands/DeleteUserPoolDomainCommand.ts b/clients/client-cognito-identity-provider/commands/DeleteUserPoolDomainCommand.ts index a81d1e62d665..467b29139e9d 100644 --- a/clients/client-cognito-identity-provider/commands/DeleteUserPoolDomainCommand.ts +++ b/clients/client-cognito-identity-provider/commands/DeleteUserPoolDomainCommand.ts @@ -27,6 +27,20 @@ export interface DeleteUserPoolDomainCommandOutput extends DeleteUserPoolDomainR /** *

Deletes a domain for a user pool.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { CognitoIdentityProviderClient, DeleteUserPoolDomainCommand } from "@aws-sdk/client-cognito-identity-provider"; // ES Modules import + * // const { CognitoIdentityProviderClient, DeleteUserPoolDomainCommand } = require("@aws-sdk/client-cognito-identity-provider"); // CommonJS import + * const client = new CognitoIdentityProviderClient(config); + * const command = new DeleteUserPoolDomainCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteUserPoolDomainCommandInput} for command's `input` shape. + * @see {@link DeleteUserPoolDomainCommandOutput} for command's `response` shape. + * @see {@link CognitoIdentityProviderClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteUserPoolDomainCommand extends $Command< DeleteUserPoolDomainCommandInput, diff --git a/clients/client-cognito-identity-provider/commands/DescribeIdentityProviderCommand.ts b/clients/client-cognito-identity-provider/commands/DescribeIdentityProviderCommand.ts index e166d1623f9c..623fa2865c49 100644 --- a/clients/client-cognito-identity-provider/commands/DescribeIdentityProviderCommand.ts +++ b/clients/client-cognito-identity-provider/commands/DescribeIdentityProviderCommand.ts @@ -27,6 +27,20 @@ export interface DescribeIdentityProviderCommandOutput extends DescribeIdentityP /** *

Gets information about a specific identity provider.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { CognitoIdentityProviderClient, DescribeIdentityProviderCommand } from "@aws-sdk/client-cognito-identity-provider"; // ES Modules import + * // const { CognitoIdentityProviderClient, DescribeIdentityProviderCommand } = require("@aws-sdk/client-cognito-identity-provider"); // CommonJS import + * const client = new CognitoIdentityProviderClient(config); + * const command = new DescribeIdentityProviderCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeIdentityProviderCommandInput} for command's `input` shape. + * @see {@link DescribeIdentityProviderCommandOutput} for command's `response` shape. + * @see {@link CognitoIdentityProviderClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeIdentityProviderCommand extends $Command< DescribeIdentityProviderCommandInput, diff --git a/clients/client-cognito-identity-provider/commands/DescribeResourceServerCommand.ts b/clients/client-cognito-identity-provider/commands/DescribeResourceServerCommand.ts index ca769396351c..797d7c4b5b92 100644 --- a/clients/client-cognito-identity-provider/commands/DescribeResourceServerCommand.ts +++ b/clients/client-cognito-identity-provider/commands/DescribeResourceServerCommand.ts @@ -27,6 +27,20 @@ export interface DescribeResourceServerCommandOutput extends DescribeResourceSer /** *

Describes a resource server.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { CognitoIdentityProviderClient, DescribeResourceServerCommand } from "@aws-sdk/client-cognito-identity-provider"; // ES Modules import + * // const { CognitoIdentityProviderClient, DescribeResourceServerCommand } = require("@aws-sdk/client-cognito-identity-provider"); // CommonJS import + * const client = new CognitoIdentityProviderClient(config); + * const command = new DescribeResourceServerCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeResourceServerCommandInput} for command's `input` shape. + * @see {@link DescribeResourceServerCommandOutput} for command's `response` shape. + * @see {@link CognitoIdentityProviderClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeResourceServerCommand extends $Command< DescribeResourceServerCommandInput, diff --git a/clients/client-cognito-identity-provider/commands/DescribeRiskConfigurationCommand.ts b/clients/client-cognito-identity-provider/commands/DescribeRiskConfigurationCommand.ts index 027701198d53..d9da17202633 100644 --- a/clients/client-cognito-identity-provider/commands/DescribeRiskConfigurationCommand.ts +++ b/clients/client-cognito-identity-provider/commands/DescribeRiskConfigurationCommand.ts @@ -27,6 +27,20 @@ export interface DescribeRiskConfigurationCommandOutput extends DescribeRiskConf /** *

Describes the risk configuration.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { CognitoIdentityProviderClient, DescribeRiskConfigurationCommand } from "@aws-sdk/client-cognito-identity-provider"; // ES Modules import + * // const { CognitoIdentityProviderClient, DescribeRiskConfigurationCommand } = require("@aws-sdk/client-cognito-identity-provider"); // CommonJS import + * const client = new CognitoIdentityProviderClient(config); + * const command = new DescribeRiskConfigurationCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeRiskConfigurationCommandInput} for command's `input` shape. + * @see {@link DescribeRiskConfigurationCommandOutput} for command's `response` shape. + * @see {@link CognitoIdentityProviderClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeRiskConfigurationCommand extends $Command< DescribeRiskConfigurationCommandInput, diff --git a/clients/client-cognito-identity-provider/commands/DescribeUserImportJobCommand.ts b/clients/client-cognito-identity-provider/commands/DescribeUserImportJobCommand.ts index 4732f5ad4c6f..31234367bc50 100644 --- a/clients/client-cognito-identity-provider/commands/DescribeUserImportJobCommand.ts +++ b/clients/client-cognito-identity-provider/commands/DescribeUserImportJobCommand.ts @@ -27,6 +27,20 @@ export interface DescribeUserImportJobCommandOutput extends DescribeUserImportJo /** *

Describes the user import job.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { CognitoIdentityProviderClient, DescribeUserImportJobCommand } from "@aws-sdk/client-cognito-identity-provider"; // ES Modules import + * // const { CognitoIdentityProviderClient, DescribeUserImportJobCommand } = require("@aws-sdk/client-cognito-identity-provider"); // CommonJS import + * const client = new CognitoIdentityProviderClient(config); + * const command = new DescribeUserImportJobCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeUserImportJobCommandInput} for command's `input` shape. + * @see {@link DescribeUserImportJobCommandOutput} for command's `response` shape. + * @see {@link CognitoIdentityProviderClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeUserImportJobCommand extends $Command< DescribeUserImportJobCommandInput, diff --git a/clients/client-cognito-identity-provider/commands/DescribeUserPoolClientCommand.ts b/clients/client-cognito-identity-provider/commands/DescribeUserPoolClientCommand.ts index ee5d4c89d72e..b14695ec8198 100644 --- a/clients/client-cognito-identity-provider/commands/DescribeUserPoolClientCommand.ts +++ b/clients/client-cognito-identity-provider/commands/DescribeUserPoolClientCommand.ts @@ -28,6 +28,20 @@ export interface DescribeUserPoolClientCommandOutput extends DescribeUserPoolCli /** *

Client method for returning the configuration information and metadata of the * specified user pool app client.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { CognitoIdentityProviderClient, DescribeUserPoolClientCommand } from "@aws-sdk/client-cognito-identity-provider"; // ES Modules import + * // const { CognitoIdentityProviderClient, DescribeUserPoolClientCommand } = require("@aws-sdk/client-cognito-identity-provider"); // CommonJS import + * const client = new CognitoIdentityProviderClient(config); + * const command = new DescribeUserPoolClientCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeUserPoolClientCommandInput} for command's `input` shape. + * @see {@link DescribeUserPoolClientCommandOutput} for command's `response` shape. + * @see {@link CognitoIdentityProviderClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeUserPoolClientCommand extends $Command< DescribeUserPoolClientCommandInput, diff --git a/clients/client-cognito-identity-provider/commands/DescribeUserPoolCommand.ts b/clients/client-cognito-identity-provider/commands/DescribeUserPoolCommand.ts index dd3b9159a206..1f1b658628d1 100644 --- a/clients/client-cognito-identity-provider/commands/DescribeUserPoolCommand.ts +++ b/clients/client-cognito-identity-provider/commands/DescribeUserPoolCommand.ts @@ -27,6 +27,20 @@ export interface DescribeUserPoolCommandOutput extends DescribeUserPoolResponse, /** *

Returns the configuration information and metadata of the specified user pool.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { CognitoIdentityProviderClient, DescribeUserPoolCommand } from "@aws-sdk/client-cognito-identity-provider"; // ES Modules import + * // const { CognitoIdentityProviderClient, DescribeUserPoolCommand } = require("@aws-sdk/client-cognito-identity-provider"); // CommonJS import + * const client = new CognitoIdentityProviderClient(config); + * const command = new DescribeUserPoolCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeUserPoolCommandInput} for command's `input` shape. + * @see {@link DescribeUserPoolCommandOutput} for command's `response` shape. + * @see {@link CognitoIdentityProviderClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeUserPoolCommand extends $Command< DescribeUserPoolCommandInput, diff --git a/clients/client-cognito-identity-provider/commands/DescribeUserPoolDomainCommand.ts b/clients/client-cognito-identity-provider/commands/DescribeUserPoolDomainCommand.ts index ed4aa2a3a6f7..14a9bf1980ea 100644 --- a/clients/client-cognito-identity-provider/commands/DescribeUserPoolDomainCommand.ts +++ b/clients/client-cognito-identity-provider/commands/DescribeUserPoolDomainCommand.ts @@ -27,6 +27,20 @@ export interface DescribeUserPoolDomainCommandOutput extends DescribeUserPoolDom /** *

Gets information about a domain.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { CognitoIdentityProviderClient, DescribeUserPoolDomainCommand } from "@aws-sdk/client-cognito-identity-provider"; // ES Modules import + * // const { CognitoIdentityProviderClient, DescribeUserPoolDomainCommand } = require("@aws-sdk/client-cognito-identity-provider"); // CommonJS import + * const client = new CognitoIdentityProviderClient(config); + * const command = new DescribeUserPoolDomainCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeUserPoolDomainCommandInput} for command's `input` shape. + * @see {@link DescribeUserPoolDomainCommandOutput} for command's `response` shape. + * @see {@link CognitoIdentityProviderClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeUserPoolDomainCommand extends $Command< DescribeUserPoolDomainCommandInput, diff --git a/clients/client-cognito-identity-provider/commands/ForgetDeviceCommand.ts b/clients/client-cognito-identity-provider/commands/ForgetDeviceCommand.ts index 59f4ba075643..98ddbae5c7c8 100644 --- a/clients/client-cognito-identity-provider/commands/ForgetDeviceCommand.ts +++ b/clients/client-cognito-identity-provider/commands/ForgetDeviceCommand.ts @@ -27,6 +27,20 @@ export interface ForgetDeviceCommandOutput extends __MetadataBearer {} /** *

Forgets the specified device.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { CognitoIdentityProviderClient, ForgetDeviceCommand } from "@aws-sdk/client-cognito-identity-provider"; // ES Modules import + * // const { CognitoIdentityProviderClient, ForgetDeviceCommand } = require("@aws-sdk/client-cognito-identity-provider"); // CommonJS import + * const client = new CognitoIdentityProviderClient(config); + * const command = new ForgetDeviceCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ForgetDeviceCommandInput} for command's `input` shape. + * @see {@link ForgetDeviceCommandOutput} for command's `response` shape. + * @see {@link CognitoIdentityProviderClientResolvedConfig | config} for command's `input` shape. + * */ export class ForgetDeviceCommand extends $Command< ForgetDeviceCommandInput, diff --git a/clients/client-cognito-identity-provider/commands/ForgotPasswordCommand.ts b/clients/client-cognito-identity-provider/commands/ForgotPasswordCommand.ts index 516e1e9f5cff..b737f8dc4153 100644 --- a/clients/client-cognito-identity-provider/commands/ForgotPasswordCommand.ts +++ b/clients/client-cognito-identity-provider/commands/ForgotPasswordCommand.ts @@ -33,6 +33,20 @@ export interface ForgotPasswordCommandOutput extends ForgotPasswordResponse, __M * 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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { CognitoIdentityProviderClient, ForgotPasswordCommand } from "@aws-sdk/client-cognito-identity-provider"; // ES Modules import + * // const { CognitoIdentityProviderClient, ForgotPasswordCommand } = require("@aws-sdk/client-cognito-identity-provider"); // CommonJS import + * const client = new CognitoIdentityProviderClient(config); + * const command = new ForgotPasswordCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ForgotPasswordCommandInput} for command's `input` shape. + * @see {@link ForgotPasswordCommandOutput} for command's `response` shape. + * @see {@link CognitoIdentityProviderClientResolvedConfig | config} for command's `input` shape. + * */ export class ForgotPasswordCommand extends $Command< ForgotPasswordCommandInput, diff --git a/clients/client-cognito-identity-provider/commands/GetCSVHeaderCommand.ts b/clients/client-cognito-identity-provider/commands/GetCSVHeaderCommand.ts index f6c82f79e849..a1cb7685e750 100644 --- a/clients/client-cognito-identity-provider/commands/GetCSVHeaderCommand.ts +++ b/clients/client-cognito-identity-provider/commands/GetCSVHeaderCommand.ts @@ -28,6 +28,20 @@ export interface GetCSVHeaderCommandOutput extends GetCSVHeaderResponse, __Metad /** *

Gets the header information for the .csv file to be used as input for the user import * job.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { CognitoIdentityProviderClient, GetCSVHeaderCommand } from "@aws-sdk/client-cognito-identity-provider"; // ES Modules import + * // const { CognitoIdentityProviderClient, GetCSVHeaderCommand } = require("@aws-sdk/client-cognito-identity-provider"); // CommonJS import + * const client = new CognitoIdentityProviderClient(config); + * const command = new GetCSVHeaderCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetCSVHeaderCommandInput} for command's `input` shape. + * @see {@link GetCSVHeaderCommandOutput} for command's `response` shape. + * @see {@link CognitoIdentityProviderClientResolvedConfig | config} for command's `input` shape. + * */ export class GetCSVHeaderCommand extends $Command< GetCSVHeaderCommandInput, diff --git a/clients/client-cognito-identity-provider/commands/GetDeviceCommand.ts b/clients/client-cognito-identity-provider/commands/GetDeviceCommand.ts index 140af3e41c54..57fcfa66dd49 100644 --- a/clients/client-cognito-identity-provider/commands/GetDeviceCommand.ts +++ b/clients/client-cognito-identity-provider/commands/GetDeviceCommand.ts @@ -24,6 +24,20 @@ export interface GetDeviceCommandOutput extends GetDeviceResponse, __MetadataBea /** *

Gets the device.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { CognitoIdentityProviderClient, GetDeviceCommand } from "@aws-sdk/client-cognito-identity-provider"; // ES Modules import + * // const { CognitoIdentityProviderClient, GetDeviceCommand } = require("@aws-sdk/client-cognito-identity-provider"); // CommonJS import + * const client = new CognitoIdentityProviderClient(config); + * const command = new GetDeviceCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetDeviceCommandInput} for command's `input` shape. + * @see {@link GetDeviceCommandOutput} for command's `response` shape. + * @see {@link CognitoIdentityProviderClientResolvedConfig | config} for command's `input` shape. + * */ export class GetDeviceCommand extends $Command< GetDeviceCommandInput, diff --git a/clients/client-cognito-identity-provider/commands/GetGroupCommand.ts b/clients/client-cognito-identity-provider/commands/GetGroupCommand.ts index d60ddfa0a4be..35bb7c6ab5b1 100644 --- a/clients/client-cognito-identity-provider/commands/GetGroupCommand.ts +++ b/clients/client-cognito-identity-provider/commands/GetGroupCommand.ts @@ -25,6 +25,20 @@ export interface GetGroupCommandOutput extends GetGroupResponse, __MetadataBeare /** *

Gets a group.

*

Calling this action requires developer credentials.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { CognitoIdentityProviderClient, GetGroupCommand } from "@aws-sdk/client-cognito-identity-provider"; // ES Modules import + * // const { CognitoIdentityProviderClient, GetGroupCommand } = require("@aws-sdk/client-cognito-identity-provider"); // CommonJS import + * const client = new CognitoIdentityProviderClient(config); + * const command = new GetGroupCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetGroupCommandInput} for command's `input` shape. + * @see {@link GetGroupCommandOutput} for command's `response` shape. + * @see {@link CognitoIdentityProviderClientResolvedConfig | config} for command's `input` shape. + * */ export class GetGroupCommand extends $Command< GetGroupCommandInput, diff --git a/clients/client-cognito-identity-provider/commands/GetIdentityProviderByIdentifierCommand.ts b/clients/client-cognito-identity-provider/commands/GetIdentityProviderByIdentifierCommand.ts index 0cdf0ad6e442..0d4517a730a5 100644 --- a/clients/client-cognito-identity-provider/commands/GetIdentityProviderByIdentifierCommand.ts +++ b/clients/client-cognito-identity-provider/commands/GetIdentityProviderByIdentifierCommand.ts @@ -29,6 +29,20 @@ export interface GetIdentityProviderByIdentifierCommandOutput /** *

Gets the specified identity provider.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { CognitoIdentityProviderClient, GetIdentityProviderByIdentifierCommand } from "@aws-sdk/client-cognito-identity-provider"; // ES Modules import + * // const { CognitoIdentityProviderClient, GetIdentityProviderByIdentifierCommand } = require("@aws-sdk/client-cognito-identity-provider"); // CommonJS import + * const client = new CognitoIdentityProviderClient(config); + * const command = new GetIdentityProviderByIdentifierCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetIdentityProviderByIdentifierCommandInput} for command's `input` shape. + * @see {@link GetIdentityProviderByIdentifierCommandOutput} for command's `response` shape. + * @see {@link CognitoIdentityProviderClientResolvedConfig | config} for command's `input` shape. + * */ export class GetIdentityProviderByIdentifierCommand extends $Command< GetIdentityProviderByIdentifierCommandInput, diff --git a/clients/client-cognito-identity-provider/commands/GetSigningCertificateCommand.ts b/clients/client-cognito-identity-provider/commands/GetSigningCertificateCommand.ts index fab33e07466a..d6904ea2ad09 100644 --- a/clients/client-cognito-identity-provider/commands/GetSigningCertificateCommand.ts +++ b/clients/client-cognito-identity-provider/commands/GetSigningCertificateCommand.ts @@ -27,6 +27,20 @@ export interface GetSigningCertificateCommandOutput extends GetSigningCertificat /** *

This method takes a user pool ID, and returns the signing certificate.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { CognitoIdentityProviderClient, GetSigningCertificateCommand } from "@aws-sdk/client-cognito-identity-provider"; // ES Modules import + * // const { CognitoIdentityProviderClient, GetSigningCertificateCommand } = require("@aws-sdk/client-cognito-identity-provider"); // CommonJS import + * const client = new CognitoIdentityProviderClient(config); + * const command = new GetSigningCertificateCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetSigningCertificateCommandInput} for command's `input` shape. + * @see {@link GetSigningCertificateCommandOutput} for command's `response` shape. + * @see {@link CognitoIdentityProviderClientResolvedConfig | config} for command's `input` shape. + * */ export class GetSigningCertificateCommand extends $Command< GetSigningCertificateCommandInput, diff --git a/clients/client-cognito-identity-provider/commands/GetUICustomizationCommand.ts b/clients/client-cognito-identity-provider/commands/GetUICustomizationCommand.ts index d5c155fd6d8c..250dd96d387e 100644 --- a/clients/client-cognito-identity-provider/commands/GetUICustomizationCommand.ts +++ b/clients/client-cognito-identity-provider/commands/GetUICustomizationCommand.ts @@ -30,6 +30,20 @@ export interface GetUICustomizationCommandOutput extends GetUICustomizationRespo * is something set. If nothing is set for the particular client, but there is an existing * pool level customization (app clientId will be ALL), then that * is returned. If nothing is present, then an empty shape is returned.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { CognitoIdentityProviderClient, GetUICustomizationCommand } from "@aws-sdk/client-cognito-identity-provider"; // ES Modules import + * // const { CognitoIdentityProviderClient, GetUICustomizationCommand } = require("@aws-sdk/client-cognito-identity-provider"); // CommonJS import + * const client = new CognitoIdentityProviderClient(config); + * const command = new GetUICustomizationCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetUICustomizationCommandInput} for command's `input` shape. + * @see {@link GetUICustomizationCommandOutput} for command's `response` shape. + * @see {@link CognitoIdentityProviderClientResolvedConfig | config} for command's `input` shape. + * */ export class GetUICustomizationCommand extends $Command< GetUICustomizationCommandInput, diff --git a/clients/client-cognito-identity-provider/commands/GetUserAttributeVerificationCodeCommand.ts b/clients/client-cognito-identity-provider/commands/GetUserAttributeVerificationCodeCommand.ts index bf5d36e9d45f..4e70a7c55a12 100644 --- a/clients/client-cognito-identity-provider/commands/GetUserAttributeVerificationCodeCommand.ts +++ b/clients/client-cognito-identity-provider/commands/GetUserAttributeVerificationCodeCommand.ts @@ -28,6 +28,20 @@ export interface GetUserAttributeVerificationCodeCommandOutput /** *

Gets the user attribute verification code for the specified attribute name.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { CognitoIdentityProviderClient, GetUserAttributeVerificationCodeCommand } from "@aws-sdk/client-cognito-identity-provider"; // ES Modules import + * // const { CognitoIdentityProviderClient, GetUserAttributeVerificationCodeCommand } = require("@aws-sdk/client-cognito-identity-provider"); // CommonJS import + * const client = new CognitoIdentityProviderClient(config); + * const command = new GetUserAttributeVerificationCodeCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetUserAttributeVerificationCodeCommandInput} for command's `input` shape. + * @see {@link GetUserAttributeVerificationCodeCommandOutput} for command's `response` shape. + * @see {@link CognitoIdentityProviderClientResolvedConfig | config} for command's `input` shape. + * */ export class GetUserAttributeVerificationCodeCommand extends $Command< GetUserAttributeVerificationCodeCommandInput, diff --git a/clients/client-cognito-identity-provider/commands/GetUserCommand.ts b/clients/client-cognito-identity-provider/commands/GetUserCommand.ts index 8275d9d7524e..0e77c5cdc918 100644 --- a/clients/client-cognito-identity-provider/commands/GetUserCommand.ts +++ b/clients/client-cognito-identity-provider/commands/GetUserCommand.ts @@ -23,6 +23,20 @@ export interface GetUserCommandOutput extends GetUserResponse, __MetadataBearer /** *

Gets the user attributes and metadata for a user.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { CognitoIdentityProviderClient, GetUserCommand } from "@aws-sdk/client-cognito-identity-provider"; // ES Modules import + * // const { CognitoIdentityProviderClient, GetUserCommand } = require("@aws-sdk/client-cognito-identity-provider"); // CommonJS import + * const client = new CognitoIdentityProviderClient(config); + * const command = new GetUserCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetUserCommandInput} for command's `input` shape. + * @see {@link GetUserCommandOutput} for command's `response` shape. + * @see {@link CognitoIdentityProviderClientResolvedConfig | config} for command's `input` shape. + * */ export class GetUserCommand extends $Command< GetUserCommandInput, diff --git a/clients/client-cognito-identity-provider/commands/GetUserPoolMfaConfigCommand.ts b/clients/client-cognito-identity-provider/commands/GetUserPoolMfaConfigCommand.ts index 5fa2e847c075..fd7feb6b1ca6 100644 --- a/clients/client-cognito-identity-provider/commands/GetUserPoolMfaConfigCommand.ts +++ b/clients/client-cognito-identity-provider/commands/GetUserPoolMfaConfigCommand.ts @@ -27,6 +27,20 @@ export interface GetUserPoolMfaConfigCommandOutput extends GetUserPoolMfaConfigR /** *

Gets the user pool multi-factor authentication (MFA) configuration.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { CognitoIdentityProviderClient, GetUserPoolMfaConfigCommand } from "@aws-sdk/client-cognito-identity-provider"; // ES Modules import + * // const { CognitoIdentityProviderClient, GetUserPoolMfaConfigCommand } = require("@aws-sdk/client-cognito-identity-provider"); // CommonJS import + * const client = new CognitoIdentityProviderClient(config); + * const command = new GetUserPoolMfaConfigCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetUserPoolMfaConfigCommandInput} for command's `input` shape. + * @see {@link GetUserPoolMfaConfigCommandOutput} for command's `response` shape. + * @see {@link CognitoIdentityProviderClientResolvedConfig | config} for command's `input` shape. + * */ export class GetUserPoolMfaConfigCommand extends $Command< GetUserPoolMfaConfigCommandInput, diff --git a/clients/client-cognito-identity-provider/commands/GlobalSignOutCommand.ts b/clients/client-cognito-identity-provider/commands/GlobalSignOutCommand.ts index 3dffdf086758..ce49fb0cfae9 100644 --- a/clients/client-cognito-identity-provider/commands/GlobalSignOutCommand.ts +++ b/clients/client-cognito-identity-provider/commands/GlobalSignOutCommand.ts @@ -29,6 +29,20 @@ export interface GlobalSignOutCommandOutput extends GlobalSignOutResponse, __Met *

Signs out users from all devices. It also invalidates all refresh tokens issued to a * user. The user's current access and Id tokens remain valid until their expiry. Access * and Id tokens expire one hour after they are issued.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { CognitoIdentityProviderClient, GlobalSignOutCommand } from "@aws-sdk/client-cognito-identity-provider"; // ES Modules import + * // const { CognitoIdentityProviderClient, GlobalSignOutCommand } = require("@aws-sdk/client-cognito-identity-provider"); // CommonJS import + * const client = new CognitoIdentityProviderClient(config); + * const command = new GlobalSignOutCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GlobalSignOutCommandInput} for command's `input` shape. + * @see {@link GlobalSignOutCommandOutput} for command's `response` shape. + * @see {@link CognitoIdentityProviderClientResolvedConfig | config} for command's `input` shape. + * */ export class GlobalSignOutCommand extends $Command< GlobalSignOutCommandInput, diff --git a/clients/client-cognito-identity-provider/commands/InitiateAuthCommand.ts b/clients/client-cognito-identity-provider/commands/InitiateAuthCommand.ts index 1c426ea5f73d..8231705f1237 100644 --- a/clients/client-cognito-identity-provider/commands/InitiateAuthCommand.ts +++ b/clients/client-cognito-identity-provider/commands/InitiateAuthCommand.ts @@ -26,6 +26,20 @@ export interface InitiateAuthCommandOutput extends InitiateAuthResponse, __Metad /** *

Initiates the authentication flow.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { CognitoIdentityProviderClient, InitiateAuthCommand } from "@aws-sdk/client-cognito-identity-provider"; // ES Modules import + * // const { CognitoIdentityProviderClient, InitiateAuthCommand } = require("@aws-sdk/client-cognito-identity-provider"); // CommonJS import + * const client = new CognitoIdentityProviderClient(config); + * const command = new InitiateAuthCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link InitiateAuthCommandInput} for command's `input` shape. + * @see {@link InitiateAuthCommandOutput} for command's `response` shape. + * @see {@link CognitoIdentityProviderClientResolvedConfig | config} for command's `input` shape. + * */ export class InitiateAuthCommand extends $Command< InitiateAuthCommandInput, diff --git a/clients/client-cognito-identity-provider/commands/ListDevicesCommand.ts b/clients/client-cognito-identity-provider/commands/ListDevicesCommand.ts index 3392b8a05f71..002e399b7ff4 100644 --- a/clients/client-cognito-identity-provider/commands/ListDevicesCommand.ts +++ b/clients/client-cognito-identity-provider/commands/ListDevicesCommand.ts @@ -27,6 +27,20 @@ export interface ListDevicesCommandOutput extends ListDevicesResponse, __Metadat /** *

Lists the devices.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { CognitoIdentityProviderClient, ListDevicesCommand } from "@aws-sdk/client-cognito-identity-provider"; // ES Modules import + * // const { CognitoIdentityProviderClient, ListDevicesCommand } = require("@aws-sdk/client-cognito-identity-provider"); // CommonJS import + * const client = new CognitoIdentityProviderClient(config); + * const command = new ListDevicesCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListDevicesCommandInput} for command's `input` shape. + * @see {@link ListDevicesCommandOutput} for command's `response` shape. + * @see {@link CognitoIdentityProviderClientResolvedConfig | config} for command's `input` shape. + * */ export class ListDevicesCommand extends $Command< ListDevicesCommandInput, diff --git a/clients/client-cognito-identity-provider/commands/ListGroupsCommand.ts b/clients/client-cognito-identity-provider/commands/ListGroupsCommand.ts index 8ce621c3d880..81cdc4a011ea 100644 --- a/clients/client-cognito-identity-provider/commands/ListGroupsCommand.ts +++ b/clients/client-cognito-identity-provider/commands/ListGroupsCommand.ts @@ -28,6 +28,20 @@ export interface ListGroupsCommandOutput extends ListGroupsResponse, __MetadataB /** *

Lists the groups associated with a user pool.

*

Calling this action requires developer credentials.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { CognitoIdentityProviderClient, ListGroupsCommand } from "@aws-sdk/client-cognito-identity-provider"; // ES Modules import + * // const { CognitoIdentityProviderClient, ListGroupsCommand } = require("@aws-sdk/client-cognito-identity-provider"); // CommonJS import + * const client = new CognitoIdentityProviderClient(config); + * const command = new ListGroupsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListGroupsCommandInput} for command's `input` shape. + * @see {@link ListGroupsCommandOutput} for command's `response` shape. + * @see {@link CognitoIdentityProviderClientResolvedConfig | config} for command's `input` shape. + * */ export class ListGroupsCommand extends $Command< ListGroupsCommandInput, diff --git a/clients/client-cognito-identity-provider/commands/ListIdentityProvidersCommand.ts b/clients/client-cognito-identity-provider/commands/ListIdentityProvidersCommand.ts index 4dae801aebea..b325816724bc 100644 --- a/clients/client-cognito-identity-provider/commands/ListIdentityProvidersCommand.ts +++ b/clients/client-cognito-identity-provider/commands/ListIdentityProvidersCommand.ts @@ -27,6 +27,20 @@ export interface ListIdentityProvidersCommandOutput extends ListIdentityProvider /** *

Lists information about all identity providers for a user pool.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { CognitoIdentityProviderClient, ListIdentityProvidersCommand } from "@aws-sdk/client-cognito-identity-provider"; // ES Modules import + * // const { CognitoIdentityProviderClient, ListIdentityProvidersCommand } = require("@aws-sdk/client-cognito-identity-provider"); // CommonJS import + * const client = new CognitoIdentityProviderClient(config); + * const command = new ListIdentityProvidersCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListIdentityProvidersCommandInput} for command's `input` shape. + * @see {@link ListIdentityProvidersCommandOutput} for command's `response` shape. + * @see {@link CognitoIdentityProviderClientResolvedConfig | config} for command's `input` shape. + * */ export class ListIdentityProvidersCommand extends $Command< ListIdentityProvidersCommandInput, diff --git a/clients/client-cognito-identity-provider/commands/ListResourceServersCommand.ts b/clients/client-cognito-identity-provider/commands/ListResourceServersCommand.ts index 4f48bae16589..94b1bea5b5bb 100644 --- a/clients/client-cognito-identity-provider/commands/ListResourceServersCommand.ts +++ b/clients/client-cognito-identity-provider/commands/ListResourceServersCommand.ts @@ -27,6 +27,20 @@ export interface ListResourceServersCommandOutput extends ListResourceServersRes /** *

Lists the resource servers for a user pool.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { CognitoIdentityProviderClient, ListResourceServersCommand } from "@aws-sdk/client-cognito-identity-provider"; // ES Modules import + * // const { CognitoIdentityProviderClient, ListResourceServersCommand } = require("@aws-sdk/client-cognito-identity-provider"); // CommonJS import + * const client = new CognitoIdentityProviderClient(config); + * const command = new ListResourceServersCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListResourceServersCommandInput} for command's `input` shape. + * @see {@link ListResourceServersCommandOutput} for command's `response` shape. + * @see {@link CognitoIdentityProviderClientResolvedConfig | config} for command's `input` shape. + * */ export class ListResourceServersCommand extends $Command< ListResourceServersCommandInput, diff --git a/clients/client-cognito-identity-provider/commands/ListTagsForResourceCommand.ts b/clients/client-cognito-identity-provider/commands/ListTagsForResourceCommand.ts index a0cf631e6f81..9c99433a3ec9 100644 --- a/clients/client-cognito-identity-provider/commands/ListTagsForResourceCommand.ts +++ b/clients/client-cognito-identity-provider/commands/ListTagsForResourceCommand.ts @@ -30,6 +30,20 @@ export interface ListTagsForResourceCommandOutput extends ListTagsForResourceRes *

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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { CognitoIdentityProviderClient, ListTagsForResourceCommand } from "@aws-sdk/client-cognito-identity-provider"; // ES Modules import + * // const { CognitoIdentityProviderClient, ListTagsForResourceCommand } = require("@aws-sdk/client-cognito-identity-provider"); // CommonJS import + * const client = new CognitoIdentityProviderClient(config); + * const command = new ListTagsForResourceCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListTagsForResourceCommandInput} for command's `input` shape. + * @see {@link ListTagsForResourceCommandOutput} for command's `response` shape. + * @see {@link CognitoIdentityProviderClientResolvedConfig | config} for command's `input` shape. + * */ export class ListTagsForResourceCommand extends $Command< ListTagsForResourceCommandInput, diff --git a/clients/client-cognito-identity-provider/commands/ListUserImportJobsCommand.ts b/clients/client-cognito-identity-provider/commands/ListUserImportJobsCommand.ts index a0d21cbb9170..adeb3667819b 100644 --- a/clients/client-cognito-identity-provider/commands/ListUserImportJobsCommand.ts +++ b/clients/client-cognito-identity-provider/commands/ListUserImportJobsCommand.ts @@ -27,6 +27,20 @@ export interface ListUserImportJobsCommandOutput extends ListUserImportJobsRespo /** *

Lists the user import jobs.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { CognitoIdentityProviderClient, ListUserImportJobsCommand } from "@aws-sdk/client-cognito-identity-provider"; // ES Modules import + * // const { CognitoIdentityProviderClient, ListUserImportJobsCommand } = require("@aws-sdk/client-cognito-identity-provider"); // CommonJS import + * const client = new CognitoIdentityProviderClient(config); + * const command = new ListUserImportJobsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListUserImportJobsCommandInput} for command's `input` shape. + * @see {@link ListUserImportJobsCommandOutput} for command's `response` shape. + * @see {@link CognitoIdentityProviderClientResolvedConfig | config} for command's `input` shape. + * */ export class ListUserImportJobsCommand extends $Command< ListUserImportJobsCommandInput, diff --git a/clients/client-cognito-identity-provider/commands/ListUserPoolClientsCommand.ts b/clients/client-cognito-identity-provider/commands/ListUserPoolClientsCommand.ts index d4fbef032868..ccf0a1418f7c 100644 --- a/clients/client-cognito-identity-provider/commands/ListUserPoolClientsCommand.ts +++ b/clients/client-cognito-identity-provider/commands/ListUserPoolClientsCommand.ts @@ -27,6 +27,20 @@ export interface ListUserPoolClientsCommandOutput extends ListUserPoolClientsRes /** *

Lists the clients that have been created for the specified user pool.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { CognitoIdentityProviderClient, ListUserPoolClientsCommand } from "@aws-sdk/client-cognito-identity-provider"; // ES Modules import + * // const { CognitoIdentityProviderClient, ListUserPoolClientsCommand } = require("@aws-sdk/client-cognito-identity-provider"); // CommonJS import + * const client = new CognitoIdentityProviderClient(config); + * const command = new ListUserPoolClientsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListUserPoolClientsCommandInput} for command's `input` shape. + * @see {@link ListUserPoolClientsCommandOutput} for command's `response` shape. + * @see {@link CognitoIdentityProviderClientResolvedConfig | config} for command's `input` shape. + * */ export class ListUserPoolClientsCommand extends $Command< ListUserPoolClientsCommandInput, diff --git a/clients/client-cognito-identity-provider/commands/ListUserPoolsCommand.ts b/clients/client-cognito-identity-provider/commands/ListUserPoolsCommand.ts index 4d14110b8d25..6d95366914eb 100644 --- a/clients/client-cognito-identity-provider/commands/ListUserPoolsCommand.ts +++ b/clients/client-cognito-identity-provider/commands/ListUserPoolsCommand.ts @@ -27,6 +27,20 @@ export interface ListUserPoolsCommandOutput extends ListUserPoolsResponse, __Met /** *

Lists the user pools associated with an AWS account.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { CognitoIdentityProviderClient, ListUserPoolsCommand } from "@aws-sdk/client-cognito-identity-provider"; // ES Modules import + * // const { CognitoIdentityProviderClient, ListUserPoolsCommand } = require("@aws-sdk/client-cognito-identity-provider"); // CommonJS import + * const client = new CognitoIdentityProviderClient(config); + * const command = new ListUserPoolsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListUserPoolsCommandInput} for command's `input` shape. + * @see {@link ListUserPoolsCommandOutput} for command's `response` shape. + * @see {@link CognitoIdentityProviderClientResolvedConfig | config} for command's `input` shape. + * */ export class ListUserPoolsCommand extends $Command< ListUserPoolsCommandInput, diff --git a/clients/client-cognito-identity-provider/commands/ListUsersCommand.ts b/clients/client-cognito-identity-provider/commands/ListUsersCommand.ts index e53bedab1b88..e59119e90152 100644 --- a/clients/client-cognito-identity-provider/commands/ListUsersCommand.ts +++ b/clients/client-cognito-identity-provider/commands/ListUsersCommand.ts @@ -24,6 +24,20 @@ export interface ListUsersCommandOutput extends ListUsersResponse, __MetadataBea /** *

Lists the users in the Amazon Cognito user pool.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { CognitoIdentityProviderClient, ListUsersCommand } from "@aws-sdk/client-cognito-identity-provider"; // ES Modules import + * // const { CognitoIdentityProviderClient, ListUsersCommand } = require("@aws-sdk/client-cognito-identity-provider"); // CommonJS import + * const client = new CognitoIdentityProviderClient(config); + * const command = new ListUsersCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListUsersCommandInput} for command's `input` shape. + * @see {@link ListUsersCommandOutput} for command's `response` shape. + * @see {@link CognitoIdentityProviderClientResolvedConfig | config} for command's `input` shape. + * */ export class ListUsersCommand extends $Command< ListUsersCommandInput, diff --git a/clients/client-cognito-identity-provider/commands/ListUsersInGroupCommand.ts b/clients/client-cognito-identity-provider/commands/ListUsersInGroupCommand.ts index db394467d5fe..82b82b995ace 100644 --- a/clients/client-cognito-identity-provider/commands/ListUsersInGroupCommand.ts +++ b/clients/client-cognito-identity-provider/commands/ListUsersInGroupCommand.ts @@ -28,6 +28,20 @@ export interface ListUsersInGroupCommandOutput extends ListUsersInGroupResponse, /** *

Lists the users in the specified group.

*

Calling this action requires developer credentials.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { CognitoIdentityProviderClient, ListUsersInGroupCommand } from "@aws-sdk/client-cognito-identity-provider"; // ES Modules import + * // const { CognitoIdentityProviderClient, ListUsersInGroupCommand } = require("@aws-sdk/client-cognito-identity-provider"); // CommonJS import + * const client = new CognitoIdentityProviderClient(config); + * const command = new ListUsersInGroupCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListUsersInGroupCommandInput} for command's `input` shape. + * @see {@link ListUsersInGroupCommandOutput} for command's `response` shape. + * @see {@link CognitoIdentityProviderClientResolvedConfig | config} for command's `input` shape. + * */ export class ListUsersInGroupCommand extends $Command< ListUsersInGroupCommandInput, diff --git a/clients/client-cognito-identity-provider/commands/ResendConfirmationCodeCommand.ts b/clients/client-cognito-identity-provider/commands/ResendConfirmationCodeCommand.ts index cc52188a4b8e..40646d21e622 100644 --- a/clients/client-cognito-identity-provider/commands/ResendConfirmationCodeCommand.ts +++ b/clients/client-cognito-identity-provider/commands/ResendConfirmationCodeCommand.ts @@ -27,6 +27,20 @@ export interface ResendConfirmationCodeCommandOutput extends ResendConfirmationC /** *

Resends the confirmation (for confirmation of registration) to a specific user in the * user pool.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { CognitoIdentityProviderClient, ResendConfirmationCodeCommand } from "@aws-sdk/client-cognito-identity-provider"; // ES Modules import + * // const { CognitoIdentityProviderClient, ResendConfirmationCodeCommand } = require("@aws-sdk/client-cognito-identity-provider"); // CommonJS import + * const client = new CognitoIdentityProviderClient(config); + * const command = new ResendConfirmationCodeCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ResendConfirmationCodeCommandInput} for command's `input` shape. + * @see {@link ResendConfirmationCodeCommandOutput} for command's `response` shape. + * @see {@link CognitoIdentityProviderClientResolvedConfig | config} for command's `input` shape. + * */ export class ResendConfirmationCodeCommand extends $Command< ResendConfirmationCodeCommandInput, diff --git a/clients/client-cognito-identity-provider/commands/RespondToAuthChallengeCommand.ts b/clients/client-cognito-identity-provider/commands/RespondToAuthChallengeCommand.ts index 624cef13543d..5b96e8df81e7 100644 --- a/clients/client-cognito-identity-provider/commands/RespondToAuthChallengeCommand.ts +++ b/clients/client-cognito-identity-provider/commands/RespondToAuthChallengeCommand.ts @@ -26,6 +26,20 @@ export interface RespondToAuthChallengeCommandOutput extends RespondToAuthChalle /** *

Responds to the authentication challenge.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { CognitoIdentityProviderClient, RespondToAuthChallengeCommand } from "@aws-sdk/client-cognito-identity-provider"; // ES Modules import + * // const { CognitoIdentityProviderClient, RespondToAuthChallengeCommand } = require("@aws-sdk/client-cognito-identity-provider"); // CommonJS import + * const client = new CognitoIdentityProviderClient(config); + * const command = new RespondToAuthChallengeCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link RespondToAuthChallengeCommandInput} for command's `input` shape. + * @see {@link RespondToAuthChallengeCommandOutput} for command's `response` shape. + * @see {@link CognitoIdentityProviderClientResolvedConfig | config} for command's `input` shape. + * */ export class RespondToAuthChallengeCommand extends $Command< RespondToAuthChallengeCommandInput, diff --git a/clients/client-cognito-identity-provider/commands/SetRiskConfigurationCommand.ts b/clients/client-cognito-identity-provider/commands/SetRiskConfigurationCommand.ts index 8ebc7b9929bd..44680a44404a 100644 --- a/clients/client-cognito-identity-provider/commands/SetRiskConfigurationCommand.ts +++ b/clients/client-cognito-identity-provider/commands/SetRiskConfigurationCommand.ts @@ -31,6 +31,20 @@ export interface SetRiskConfigurationCommandOutput extends SetRiskConfigurationR * configuration types.

*

To enable Amazon Cognito advanced security features, update the user pool to include * the UserPoolAddOns keyAdvancedSecurityMode.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { CognitoIdentityProviderClient, SetRiskConfigurationCommand } from "@aws-sdk/client-cognito-identity-provider"; // ES Modules import + * // const { CognitoIdentityProviderClient, SetRiskConfigurationCommand } = require("@aws-sdk/client-cognito-identity-provider"); // CommonJS import + * const client = new CognitoIdentityProviderClient(config); + * const command = new SetRiskConfigurationCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link SetRiskConfigurationCommandInput} for command's `input` shape. + * @see {@link SetRiskConfigurationCommandOutput} for command's `response` shape. + * @see {@link CognitoIdentityProviderClientResolvedConfig | config} for command's `input` shape. + * */ export class SetRiskConfigurationCommand extends $Command< SetRiskConfigurationCommandInput, diff --git a/clients/client-cognito-identity-provider/commands/SetUICustomizationCommand.ts b/clients/client-cognito-identity-provider/commands/SetUICustomizationCommand.ts index 32b128a8a0e9..a64f81dc0828 100644 --- a/clients/client-cognito-identity-provider/commands/SetUICustomizationCommand.ts +++ b/clients/client-cognito-identity-provider/commands/SetUICustomizationCommand.ts @@ -38,6 +38,20 @@ export interface SetUICustomizationCommandOutput extends SetUICustomizationRespo * there is no place to host the app's pages, and the service will throw an * error.

* + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { CognitoIdentityProviderClient, SetUICustomizationCommand } from "@aws-sdk/client-cognito-identity-provider"; // ES Modules import + * // const { CognitoIdentityProviderClient, SetUICustomizationCommand } = require("@aws-sdk/client-cognito-identity-provider"); // CommonJS import + * const client = new CognitoIdentityProviderClient(config); + * const command = new SetUICustomizationCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link SetUICustomizationCommandInput} for command's `input` shape. + * @see {@link SetUICustomizationCommandOutput} for command's `response` shape. + * @see {@link CognitoIdentityProviderClientResolvedConfig | config} for command's `input` shape. + * */ export class SetUICustomizationCommand extends $Command< SetUICustomizationCommandInput, diff --git a/clients/client-cognito-identity-provider/commands/SetUserMFAPreferenceCommand.ts b/clients/client-cognito-identity-provider/commands/SetUserMFAPreferenceCommand.ts index 410479e40a1e..8a301a0f10df 100644 --- a/clients/client-cognito-identity-provider/commands/SetUserMFAPreferenceCommand.ts +++ b/clients/client-cognito-identity-provider/commands/SetUserMFAPreferenceCommand.ts @@ -35,6 +35,20 @@ export interface SetUserMFAPreferenceCommandOutput extends SetUserMFAPreferenceR * unless device tracking is turned on and the device has been trusted. If you would like * MFA to be applied selectively based on the assessed risk level of sign in attempts, * disable MFA for users and turn on Adaptive Authentication for the user pool.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { CognitoIdentityProviderClient, SetUserMFAPreferenceCommand } from "@aws-sdk/client-cognito-identity-provider"; // ES Modules import + * // const { CognitoIdentityProviderClient, SetUserMFAPreferenceCommand } = require("@aws-sdk/client-cognito-identity-provider"); // CommonJS import + * const client = new CognitoIdentityProviderClient(config); + * const command = new SetUserMFAPreferenceCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link SetUserMFAPreferenceCommandInput} for command's `input` shape. + * @see {@link SetUserMFAPreferenceCommandOutput} for command's `response` shape. + * @see {@link CognitoIdentityProviderClientResolvedConfig | config} for command's `input` shape. + * */ export class SetUserMFAPreferenceCommand extends $Command< SetUserMFAPreferenceCommandInput, diff --git a/clients/client-cognito-identity-provider/commands/SetUserPoolMfaConfigCommand.ts b/clients/client-cognito-identity-provider/commands/SetUserPoolMfaConfigCommand.ts index 413092a243d1..ae23cc50b8c8 100644 --- a/clients/client-cognito-identity-provider/commands/SetUserPoolMfaConfigCommand.ts +++ b/clients/client-cognito-identity-provider/commands/SetUserPoolMfaConfigCommand.ts @@ -27,6 +27,20 @@ export interface SetUserPoolMfaConfigCommandOutput extends SetUserPoolMfaConfigR /** *

Set the user pool multi-factor authentication (MFA) configuration.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { CognitoIdentityProviderClient, SetUserPoolMfaConfigCommand } from "@aws-sdk/client-cognito-identity-provider"; // ES Modules import + * // const { CognitoIdentityProviderClient, SetUserPoolMfaConfigCommand } = require("@aws-sdk/client-cognito-identity-provider"); // CommonJS import + * const client = new CognitoIdentityProviderClient(config); + * const command = new SetUserPoolMfaConfigCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link SetUserPoolMfaConfigCommandInput} for command's `input` shape. + * @see {@link SetUserPoolMfaConfigCommandOutput} for command's `response` shape. + * @see {@link CognitoIdentityProviderClientResolvedConfig | config} for command's `input` shape. + * */ export class SetUserPoolMfaConfigCommand extends $Command< SetUserPoolMfaConfigCommandInput, diff --git a/clients/client-cognito-identity-provider/commands/SetUserSettingsCommand.ts b/clients/client-cognito-identity-provider/commands/SetUserSettingsCommand.ts index 12396506b618..ef4c1bee5d60 100644 --- a/clients/client-cognito-identity-provider/commands/SetUserSettingsCommand.ts +++ b/clients/client-cognito-identity-provider/commands/SetUserSettingsCommand.ts @@ -29,6 +29,20 @@ export interface SetUserSettingsCommandOutput extends SetUserSettingsResponse, _ * This action is no longer supported. You can use it to configure * only SMS MFA. You can't use it to configure TOTP software token MFA. To configure either * type of MFA, use SetUserMFAPreference instead.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { CognitoIdentityProviderClient, SetUserSettingsCommand } from "@aws-sdk/client-cognito-identity-provider"; // ES Modules import + * // const { CognitoIdentityProviderClient, SetUserSettingsCommand } = require("@aws-sdk/client-cognito-identity-provider"); // CommonJS import + * const client = new CognitoIdentityProviderClient(config); + * const command = new SetUserSettingsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link SetUserSettingsCommandInput} for command's `input` shape. + * @see {@link SetUserSettingsCommandOutput} for command's `response` shape. + * @see {@link CognitoIdentityProviderClientResolvedConfig | config} for command's `input` shape. + * */ export class SetUserSettingsCommand extends $Command< SetUserSettingsCommandInput, diff --git a/clients/client-cognito-identity-provider/commands/SignUpCommand.ts b/clients/client-cognito-identity-provider/commands/SignUpCommand.ts index a38d873962c5..7cbea4774798 100644 --- a/clients/client-cognito-identity-provider/commands/SignUpCommand.ts +++ b/clients/client-cognito-identity-provider/commands/SignUpCommand.ts @@ -24,6 +24,20 @@ export interface SignUpCommandOutput extends SignUpResponse, __MetadataBearer {} /** *

Registers the user in the specified user pool and creates a user name, password, and * user attributes.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { CognitoIdentityProviderClient, SignUpCommand } from "@aws-sdk/client-cognito-identity-provider"; // ES Modules import + * // const { CognitoIdentityProviderClient, SignUpCommand } = require("@aws-sdk/client-cognito-identity-provider"); // CommonJS import + * const client = new CognitoIdentityProviderClient(config); + * const command = new SignUpCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link SignUpCommandInput} for command's `input` shape. + * @see {@link SignUpCommandOutput} for command's `response` shape. + * @see {@link CognitoIdentityProviderClientResolvedConfig | config} for command's `input` shape. + * */ export class SignUpCommand extends $Command< SignUpCommandInput, diff --git a/clients/client-cognito-identity-provider/commands/StartUserImportJobCommand.ts b/clients/client-cognito-identity-provider/commands/StartUserImportJobCommand.ts index b52f63716d3a..bc4e993de17f 100644 --- a/clients/client-cognito-identity-provider/commands/StartUserImportJobCommand.ts +++ b/clients/client-cognito-identity-provider/commands/StartUserImportJobCommand.ts @@ -27,6 +27,20 @@ export interface StartUserImportJobCommandOutput extends StartUserImportJobRespo /** *

Starts the user import.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { CognitoIdentityProviderClient, StartUserImportJobCommand } from "@aws-sdk/client-cognito-identity-provider"; // ES Modules import + * // const { CognitoIdentityProviderClient, StartUserImportJobCommand } = require("@aws-sdk/client-cognito-identity-provider"); // CommonJS import + * const client = new CognitoIdentityProviderClient(config); + * const command = new StartUserImportJobCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link StartUserImportJobCommandInput} for command's `input` shape. + * @see {@link StartUserImportJobCommandOutput} for command's `response` shape. + * @see {@link CognitoIdentityProviderClientResolvedConfig | config} for command's `input` shape. + * */ export class StartUserImportJobCommand extends $Command< StartUserImportJobCommandInput, diff --git a/clients/client-cognito-identity-provider/commands/StopUserImportJobCommand.ts b/clients/client-cognito-identity-provider/commands/StopUserImportJobCommand.ts index fa277619363d..90944f6ee590 100644 --- a/clients/client-cognito-identity-provider/commands/StopUserImportJobCommand.ts +++ b/clients/client-cognito-identity-provider/commands/StopUserImportJobCommand.ts @@ -27,6 +27,20 @@ export interface StopUserImportJobCommandOutput extends StopUserImportJobRespons /** *

Stops the user import job.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { CognitoIdentityProviderClient, StopUserImportJobCommand } from "@aws-sdk/client-cognito-identity-provider"; // ES Modules import + * // const { CognitoIdentityProviderClient, StopUserImportJobCommand } = require("@aws-sdk/client-cognito-identity-provider"); // CommonJS import + * const client = new CognitoIdentityProviderClient(config); + * const command = new StopUserImportJobCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link StopUserImportJobCommandInput} for command's `input` shape. + * @see {@link StopUserImportJobCommandOutput} for command's `response` shape. + * @see {@link CognitoIdentityProviderClientResolvedConfig | config} for command's `input` shape. + * */ export class StopUserImportJobCommand extends $Command< StopUserImportJobCommandInput, diff --git a/clients/client-cognito-identity-provider/commands/TagResourceCommand.ts b/clients/client-cognito-identity-provider/commands/TagResourceCommand.ts index 9f7c064cabc2..fdc05e01a4c0 100644 --- a/clients/client-cognito-identity-provider/commands/TagResourceCommand.ts +++ b/clients/client-cognito-identity-provider/commands/TagResourceCommand.ts @@ -40,6 +40,20 @@ export interface TagResourceCommandOutput extends TagResourceResponse, __Metadat * 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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { CognitoIdentityProviderClient, TagResourceCommand } from "@aws-sdk/client-cognito-identity-provider"; // ES Modules import + * // const { CognitoIdentityProviderClient, TagResourceCommand } = require("@aws-sdk/client-cognito-identity-provider"); // CommonJS import + * const client = new CognitoIdentityProviderClient(config); + * const command = new TagResourceCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link TagResourceCommandInput} for command's `input` shape. + * @see {@link TagResourceCommandOutput} for command's `response` shape. + * @see {@link CognitoIdentityProviderClientResolvedConfig | config} for command's `input` shape. + * */ export class TagResourceCommand extends $Command< TagResourceCommandInput, diff --git a/clients/client-cognito-identity-provider/commands/UntagResourceCommand.ts b/clients/client-cognito-identity-provider/commands/UntagResourceCommand.ts index 973df4a54b81..650e5eb5d68f 100644 --- a/clients/client-cognito-identity-provider/commands/UntagResourceCommand.ts +++ b/clients/client-cognito-identity-provider/commands/UntagResourceCommand.ts @@ -28,6 +28,20 @@ export interface UntagResourceCommandOutput extends UntagResourceResponse, __Met /** *

Removes the specified tags from an Amazon Cognito user pool. You can use this action * up to 5 times per second, per account

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { CognitoIdentityProviderClient, UntagResourceCommand } from "@aws-sdk/client-cognito-identity-provider"; // ES Modules import + * // const { CognitoIdentityProviderClient, UntagResourceCommand } = require("@aws-sdk/client-cognito-identity-provider"); // CommonJS import + * const client = new CognitoIdentityProviderClient(config); + * const command = new UntagResourceCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link UntagResourceCommandInput} for command's `input` shape. + * @see {@link UntagResourceCommandOutput} for command's `response` shape. + * @see {@link CognitoIdentityProviderClientResolvedConfig | config} for command's `input` shape. + * */ export class UntagResourceCommand extends $Command< UntagResourceCommandInput, diff --git a/clients/client-cognito-identity-provider/commands/UpdateAuthEventFeedbackCommand.ts b/clients/client-cognito-identity-provider/commands/UpdateAuthEventFeedbackCommand.ts index e335da097bb6..98cf63297594 100644 --- a/clients/client-cognito-identity-provider/commands/UpdateAuthEventFeedbackCommand.ts +++ b/clients/client-cognito-identity-provider/commands/UpdateAuthEventFeedbackCommand.ts @@ -29,6 +29,20 @@ export interface UpdateAuthEventFeedbackCommandOutput extends UpdateAuthEventFee *

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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { CognitoIdentityProviderClient, UpdateAuthEventFeedbackCommand } from "@aws-sdk/client-cognito-identity-provider"; // ES Modules import + * // const { CognitoIdentityProviderClient, UpdateAuthEventFeedbackCommand } = require("@aws-sdk/client-cognito-identity-provider"); // CommonJS import + * const client = new CognitoIdentityProviderClient(config); + * const command = new UpdateAuthEventFeedbackCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link UpdateAuthEventFeedbackCommandInput} for command's `input` shape. + * @see {@link UpdateAuthEventFeedbackCommandOutput} for command's `response` shape. + * @see {@link CognitoIdentityProviderClientResolvedConfig | config} for command's `input` shape. + * */ export class UpdateAuthEventFeedbackCommand extends $Command< UpdateAuthEventFeedbackCommandInput, diff --git a/clients/client-cognito-identity-provider/commands/UpdateDeviceStatusCommand.ts b/clients/client-cognito-identity-provider/commands/UpdateDeviceStatusCommand.ts index 72357f7ccea0..e631db436a3a 100644 --- a/clients/client-cognito-identity-provider/commands/UpdateDeviceStatusCommand.ts +++ b/clients/client-cognito-identity-provider/commands/UpdateDeviceStatusCommand.ts @@ -27,6 +27,20 @@ export interface UpdateDeviceStatusCommandOutput extends UpdateDeviceStatusRespo /** *

Updates the device status.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { CognitoIdentityProviderClient, UpdateDeviceStatusCommand } from "@aws-sdk/client-cognito-identity-provider"; // ES Modules import + * // const { CognitoIdentityProviderClient, UpdateDeviceStatusCommand } = require("@aws-sdk/client-cognito-identity-provider"); // CommonJS import + * const client = new CognitoIdentityProviderClient(config); + * const command = new UpdateDeviceStatusCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link UpdateDeviceStatusCommandInput} for command's `input` shape. + * @see {@link UpdateDeviceStatusCommandOutput} for command's `response` shape. + * @see {@link CognitoIdentityProviderClientResolvedConfig | config} for command's `input` shape. + * */ export class UpdateDeviceStatusCommand extends $Command< UpdateDeviceStatusCommandInput, diff --git a/clients/client-cognito-identity-provider/commands/UpdateGroupCommand.ts b/clients/client-cognito-identity-provider/commands/UpdateGroupCommand.ts index 2a97916f1c76..6d07a5c0863c 100644 --- a/clients/client-cognito-identity-provider/commands/UpdateGroupCommand.ts +++ b/clients/client-cognito-identity-provider/commands/UpdateGroupCommand.ts @@ -32,6 +32,20 @@ export interface UpdateGroupCommandOutput extends UpdateGroupResponse, __Metadat *

If you don't provide a value for an attribute, it will be set to the default * value.

* + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { CognitoIdentityProviderClient, UpdateGroupCommand } from "@aws-sdk/client-cognito-identity-provider"; // ES Modules import + * // const { CognitoIdentityProviderClient, UpdateGroupCommand } = require("@aws-sdk/client-cognito-identity-provider"); // CommonJS import + * const client = new CognitoIdentityProviderClient(config); + * const command = new UpdateGroupCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link UpdateGroupCommandInput} for command's `input` shape. + * @see {@link UpdateGroupCommandOutput} for command's `response` shape. + * @see {@link CognitoIdentityProviderClientResolvedConfig | config} for command's `input` shape. + * */ export class UpdateGroupCommand extends $Command< UpdateGroupCommandInput, diff --git a/clients/client-cognito-identity-provider/commands/UpdateIdentityProviderCommand.ts b/clients/client-cognito-identity-provider/commands/UpdateIdentityProviderCommand.ts index 951e79c15350..6e64f78aafc3 100644 --- a/clients/client-cognito-identity-provider/commands/UpdateIdentityProviderCommand.ts +++ b/clients/client-cognito-identity-provider/commands/UpdateIdentityProviderCommand.ts @@ -27,6 +27,20 @@ export interface UpdateIdentityProviderCommandOutput extends UpdateIdentityProvi /** *

Updates identity provider information for a user pool.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { CognitoIdentityProviderClient, UpdateIdentityProviderCommand } from "@aws-sdk/client-cognito-identity-provider"; // ES Modules import + * // const { CognitoIdentityProviderClient, UpdateIdentityProviderCommand } = require("@aws-sdk/client-cognito-identity-provider"); // CommonJS import + * const client = new CognitoIdentityProviderClient(config); + * const command = new UpdateIdentityProviderCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link UpdateIdentityProviderCommandInput} for command's `input` shape. + * @see {@link UpdateIdentityProviderCommandOutput} for command's `response` shape. + * @see {@link CognitoIdentityProviderClientResolvedConfig | config} for command's `input` shape. + * */ export class UpdateIdentityProviderCommand extends $Command< UpdateIdentityProviderCommandInput, diff --git a/clients/client-cognito-identity-provider/commands/UpdateResourceServerCommand.ts b/clients/client-cognito-identity-provider/commands/UpdateResourceServerCommand.ts index 788c87f29660..433cfec1542e 100644 --- a/clients/client-cognito-identity-provider/commands/UpdateResourceServerCommand.ts +++ b/clients/client-cognito-identity-provider/commands/UpdateResourceServerCommand.ts @@ -31,6 +31,20 @@ export interface UpdateResourceServerCommandOutput extends UpdateResourceServerR *

If you don't provide a value for an attribute, it will be set to the default * value.

* + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { CognitoIdentityProviderClient, UpdateResourceServerCommand } from "@aws-sdk/client-cognito-identity-provider"; // ES Modules import + * // const { CognitoIdentityProviderClient, UpdateResourceServerCommand } = require("@aws-sdk/client-cognito-identity-provider"); // CommonJS import + * const client = new CognitoIdentityProviderClient(config); + * const command = new UpdateResourceServerCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link UpdateResourceServerCommandInput} for command's `input` shape. + * @see {@link UpdateResourceServerCommandOutput} for command's `response` shape. + * @see {@link CognitoIdentityProviderClientResolvedConfig | config} for command's `input` shape. + * */ export class UpdateResourceServerCommand extends $Command< UpdateResourceServerCommandInput, diff --git a/clients/client-cognito-identity-provider/commands/UpdateUserAttributesCommand.ts b/clients/client-cognito-identity-provider/commands/UpdateUserAttributesCommand.ts index 595ea60c02b8..66c1f9fcc239 100644 --- a/clients/client-cognito-identity-provider/commands/UpdateUserAttributesCommand.ts +++ b/clients/client-cognito-identity-provider/commands/UpdateUserAttributesCommand.ts @@ -26,6 +26,20 @@ export interface UpdateUserAttributesCommandOutput extends UpdateUserAttributesR /** *

Allows a user to update a specific attribute (one at a time).

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { CognitoIdentityProviderClient, UpdateUserAttributesCommand } from "@aws-sdk/client-cognito-identity-provider"; // ES Modules import + * // const { CognitoIdentityProviderClient, UpdateUserAttributesCommand } = require("@aws-sdk/client-cognito-identity-provider"); // CommonJS import + * const client = new CognitoIdentityProviderClient(config); + * const command = new UpdateUserAttributesCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link UpdateUserAttributesCommandInput} for command's `input` shape. + * @see {@link UpdateUserAttributesCommandOutput} for command's `response` shape. + * @see {@link CognitoIdentityProviderClientResolvedConfig | config} for command's `input` shape. + * */ export class UpdateUserAttributesCommand extends $Command< UpdateUserAttributesCommandInput, diff --git a/clients/client-cognito-identity-provider/commands/UpdateUserPoolClientCommand.ts b/clients/client-cognito-identity-provider/commands/UpdateUserPoolClientCommand.ts index b70cca644b64..b054498a954b 100644 --- a/clients/client-cognito-identity-provider/commands/UpdateUserPoolClientCommand.ts +++ b/clients/client-cognito-identity-provider/commands/UpdateUserPoolClientCommand.ts @@ -32,6 +32,20 @@ export interface UpdateUserPoolClientCommandOutput extends UpdateUserPoolClientR *

If you don't provide a value for an attribute, it will be set to the default * value.

* + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { CognitoIdentityProviderClient, UpdateUserPoolClientCommand } from "@aws-sdk/client-cognito-identity-provider"; // ES Modules import + * // const { CognitoIdentityProviderClient, UpdateUserPoolClientCommand } = require("@aws-sdk/client-cognito-identity-provider"); // CommonJS import + * const client = new CognitoIdentityProviderClient(config); + * const command = new UpdateUserPoolClientCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link UpdateUserPoolClientCommandInput} for command's `input` shape. + * @see {@link UpdateUserPoolClientCommandOutput} for command's `response` shape. + * @see {@link CognitoIdentityProviderClientResolvedConfig | config} for command's `input` shape. + * */ export class UpdateUserPoolClientCommand extends $Command< UpdateUserPoolClientCommandInput, diff --git a/clients/client-cognito-identity-provider/commands/UpdateUserPoolCommand.ts b/clients/client-cognito-identity-provider/commands/UpdateUserPoolCommand.ts index 98594f31775a..2c7fb85fd9e3 100644 --- a/clients/client-cognito-identity-provider/commands/UpdateUserPoolCommand.ts +++ b/clients/client-cognito-identity-provider/commands/UpdateUserPoolCommand.ts @@ -32,6 +32,20 @@ export interface UpdateUserPoolCommandOutput extends UpdateUserPoolResponse, __M *

If you don't provide a value for an attribute, it will be set to the default * value.

* + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { CognitoIdentityProviderClient, UpdateUserPoolCommand } from "@aws-sdk/client-cognito-identity-provider"; // ES Modules import + * // const { CognitoIdentityProviderClient, UpdateUserPoolCommand } = require("@aws-sdk/client-cognito-identity-provider"); // CommonJS import + * const client = new CognitoIdentityProviderClient(config); + * const command = new UpdateUserPoolCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link UpdateUserPoolCommandInput} for command's `input` shape. + * @see {@link UpdateUserPoolCommandOutput} for command's `response` shape. + * @see {@link CognitoIdentityProviderClientResolvedConfig | config} for command's `input` shape. + * */ export class UpdateUserPoolCommand extends $Command< UpdateUserPoolCommandInput, diff --git a/clients/client-cognito-identity-provider/commands/UpdateUserPoolDomainCommand.ts b/clients/client-cognito-identity-provider/commands/UpdateUserPoolDomainCommand.ts index 916d97ab87a9..98d29c6a4009 100644 --- a/clients/client-cognito-identity-provider/commands/UpdateUserPoolDomainCommand.ts +++ b/clients/client-cognito-identity-provider/commands/UpdateUserPoolDomainCommand.ts @@ -47,6 +47,20 @@ export interface UpdateUserPoolDomainCommandOutput extends UpdateUserPoolDomainR *

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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { CognitoIdentityProviderClient, UpdateUserPoolDomainCommand } from "@aws-sdk/client-cognito-identity-provider"; // ES Modules import + * // const { CognitoIdentityProviderClient, UpdateUserPoolDomainCommand } = require("@aws-sdk/client-cognito-identity-provider"); // CommonJS import + * const client = new CognitoIdentityProviderClient(config); + * const command = new UpdateUserPoolDomainCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link UpdateUserPoolDomainCommandInput} for command's `input` shape. + * @see {@link UpdateUserPoolDomainCommandOutput} for command's `response` shape. + * @see {@link CognitoIdentityProviderClientResolvedConfig | config} for command's `input` shape. + * */ export class UpdateUserPoolDomainCommand extends $Command< UpdateUserPoolDomainCommandInput, diff --git a/clients/client-cognito-identity-provider/commands/VerifySoftwareTokenCommand.ts b/clients/client-cognito-identity-provider/commands/VerifySoftwareTokenCommand.ts index de91b023b7e0..3ae6eefd0bce 100644 --- a/clients/client-cognito-identity-provider/commands/VerifySoftwareTokenCommand.ts +++ b/clients/client-cognito-identity-provider/commands/VerifySoftwareTokenCommand.ts @@ -29,6 +29,20 @@ export interface VerifySoftwareTokenCommandOutput extends VerifySoftwareTokenRes *

Use this API to register a user's entered 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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { CognitoIdentityProviderClient, VerifySoftwareTokenCommand } from "@aws-sdk/client-cognito-identity-provider"; // ES Modules import + * // const { CognitoIdentityProviderClient, VerifySoftwareTokenCommand } = require("@aws-sdk/client-cognito-identity-provider"); // CommonJS import + * const client = new CognitoIdentityProviderClient(config); + * const command = new VerifySoftwareTokenCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link VerifySoftwareTokenCommandInput} for command's `input` shape. + * @see {@link VerifySoftwareTokenCommandOutput} for command's `response` shape. + * @see {@link CognitoIdentityProviderClientResolvedConfig | config} for command's `input` shape. + * */ export class VerifySoftwareTokenCommand extends $Command< VerifySoftwareTokenCommandInput, diff --git a/clients/client-cognito-identity-provider/commands/VerifyUserAttributeCommand.ts b/clients/client-cognito-identity-provider/commands/VerifyUserAttributeCommand.ts index f43e31e5db9b..d7d63d5d672c 100644 --- a/clients/client-cognito-identity-provider/commands/VerifyUserAttributeCommand.ts +++ b/clients/client-cognito-identity-provider/commands/VerifyUserAttributeCommand.ts @@ -26,6 +26,20 @@ export interface VerifyUserAttributeCommandOutput extends VerifyUserAttributeRes /** *

Verifies the specified user attributes in the user pool.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { CognitoIdentityProviderClient, VerifyUserAttributeCommand } from "@aws-sdk/client-cognito-identity-provider"; // ES Modules import + * // const { CognitoIdentityProviderClient, VerifyUserAttributeCommand } = require("@aws-sdk/client-cognito-identity-provider"); // CommonJS import + * const client = new CognitoIdentityProviderClient(config); + * const command = new VerifyUserAttributeCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link VerifyUserAttributeCommandInput} for command's `input` shape. + * @see {@link VerifyUserAttributeCommandOutput} for command's `response` shape. + * @see {@link CognitoIdentityProviderClientResolvedConfig | config} for command's `input` shape. + * */ export class VerifyUserAttributeCommand extends $Command< VerifyUserAttributeCommandInput, diff --git a/clients/client-cognito-identity-provider/models/models_0.ts b/clients/client-cognito-identity-provider/models/models_0.ts index 9b1396f33950..669b8ca61b45 100644 --- a/clients/client-cognito-identity-provider/models/models_0.ts +++ b/clients/client-cognito-identity-provider/models/models_0.ts @@ -24,6 +24,9 @@ export interface RecoveryOptionType { } export namespace RecoveryOptionType { + /** + * @internal + */ export const filterSensitiveLog = (obj: RecoveryOptionType): any => ({ ...obj, }); @@ -40,6 +43,9 @@ export interface AccountRecoverySettingType { } export namespace AccountRecoverySettingType { + /** + * @internal + */ export const filterSensitiveLog = (obj: AccountRecoverySettingType): any => ({ ...obj, }); @@ -88,6 +94,9 @@ export interface AccountTakeoverActionType { } export namespace AccountTakeoverActionType { + /** + * @internal + */ export const filterSensitiveLog = (obj: AccountTakeoverActionType): any => ({ ...obj, }); @@ -114,6 +123,9 @@ export interface AccountTakeoverActionsType { } export namespace AccountTakeoverActionsType { + /** + * @internal + */ export const filterSensitiveLog = (obj: AccountTakeoverActionsType): any => ({ ...obj, }); @@ -140,6 +152,9 @@ export interface NotifyEmailType { } export namespace NotifyEmailType { + /** + * @internal + */ export const filterSensitiveLog = (obj: NotifyEmailType): any => ({ ...obj, }); @@ -184,6 +199,9 @@ export interface NotifyConfigurationType { } export namespace NotifyConfigurationType { + /** + * @internal + */ export const filterSensitiveLog = (obj: NotifyConfigurationType): any => ({ ...obj, }); @@ -206,6 +224,9 @@ export interface AccountTakeoverRiskConfigurationType { } export namespace AccountTakeoverRiskConfigurationType { + /** + * @internal + */ export const filterSensitiveLog = (obj: AccountTakeoverRiskConfigurationType): any => ({ ...obj, }); @@ -234,6 +255,9 @@ export interface NumberAttributeConstraintsType { } export namespace NumberAttributeConstraintsType { + /** + * @internal + */ export const filterSensitiveLog = (obj: NumberAttributeConstraintsType): any => ({ ...obj, }); @@ -255,6 +279,9 @@ export interface StringAttributeConstraintsType { } export namespace StringAttributeConstraintsType { + /** + * @internal + */ export const filterSensitiveLog = (obj: StringAttributeConstraintsType): any => ({ ...obj, }); @@ -316,6 +343,9 @@ export interface SchemaAttributeType { } export namespace SchemaAttributeType { + /** + * @internal + */ export const filterSensitiveLog = (obj: SchemaAttributeType): any => ({ ...obj, }); @@ -337,6 +367,9 @@ export interface AddCustomAttributesRequest { } export namespace AddCustomAttributesRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: AddCustomAttributesRequest): any => ({ ...obj, }); @@ -349,6 +382,9 @@ export namespace AddCustomAttributesRequest { export interface AddCustomAttributesResponse {} export namespace AddCustomAttributesResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: AddCustomAttributesResponse): any => ({ ...obj, }); @@ -367,6 +403,9 @@ export interface InternalErrorException extends __SmithyException, $MetadataBear } export namespace InternalErrorException { + /** + * @internal + */ export const filterSensitiveLog = (obj: InternalErrorException): any => ({ ...obj, }); @@ -387,6 +426,9 @@ export interface InvalidParameterException extends __SmithyException, $MetadataB } export namespace InvalidParameterException { + /** + * @internal + */ export const filterSensitiveLog = (obj: InvalidParameterException): any => ({ ...obj, }); @@ -406,6 +448,9 @@ export interface NotAuthorizedException extends __SmithyException, $MetadataBear } export namespace NotAuthorizedException { + /** + * @internal + */ export const filterSensitiveLog = (obj: NotAuthorizedException): any => ({ ...obj, }); @@ -426,6 +471,9 @@ export interface ResourceNotFoundException extends __SmithyException, $MetadataB } export namespace ResourceNotFoundException { + /** + * @internal + */ export const filterSensitiveLog = (obj: ResourceNotFoundException): any => ({ ...obj, }); @@ -446,6 +494,9 @@ export interface TooManyRequestsException extends __SmithyException, $MetadataBe } export namespace TooManyRequestsException { + /** + * @internal + */ export const filterSensitiveLog = (obj: TooManyRequestsException): any => ({ ...obj, }); @@ -465,6 +516,9 @@ export interface UserImportInProgressException extends __SmithyException, $Metad } export namespace UserImportInProgressException { + /** + * @internal + */ export const filterSensitiveLog = (obj: UserImportInProgressException): any => ({ ...obj, }); @@ -488,6 +542,9 @@ export interface AdminAddUserToGroupRequest { } export namespace AdminAddUserToGroupRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: AdminAddUserToGroupRequest): any => ({ ...obj, ...(obj.Username && { Username: SENSITIVE_STRING }), @@ -507,6 +564,9 @@ export interface UserNotFoundException extends __SmithyException, $MetadataBeare } export namespace UserNotFoundException { + /** + * @internal + */ export const filterSensitiveLog = (obj: UserNotFoundException): any => ({ ...obj, }); @@ -563,6 +623,9 @@ export interface AdminConfirmSignUpRequest { } export namespace AdminConfirmSignUpRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: AdminConfirmSignUpRequest): any => ({ ...obj, ...(obj.Username && { Username: SENSITIVE_STRING }), @@ -576,6 +639,9 @@ export namespace AdminConfirmSignUpRequest { export interface AdminConfirmSignUpResponse {} export namespace AdminConfirmSignUpResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: AdminConfirmSignUpResponse): any => ({ ...obj, }); @@ -596,6 +662,9 @@ export interface InvalidLambdaResponseException extends __SmithyException, $Meta } export namespace InvalidLambdaResponseException { + /** + * @internal + */ export const filterSensitiveLog = (obj: InvalidLambdaResponseException): any => ({ ...obj, }); @@ -615,6 +684,9 @@ export interface LimitExceededException extends __SmithyException, $MetadataBear } export namespace LimitExceededException { + /** + * @internal + */ export const filterSensitiveLog = (obj: LimitExceededException): any => ({ ...obj, }); @@ -635,6 +707,9 @@ export interface TooManyFailedAttemptsException extends __SmithyException, $Meta } export namespace TooManyFailedAttemptsException { + /** + * @internal + */ export const filterSensitiveLog = (obj: TooManyFailedAttemptsException): any => ({ ...obj, }); @@ -655,6 +730,9 @@ export interface UnexpectedLambdaException extends __SmithyException, $MetadataB } export namespace UnexpectedLambdaException { + /** + * @internal + */ export const filterSensitiveLog = (obj: UnexpectedLambdaException): any => ({ ...obj, }); @@ -675,6 +753,9 @@ export interface UserLambdaValidationException extends __SmithyException, $Metad } export namespace UserLambdaValidationException { + /** + * @internal + */ export const filterSensitiveLog = (obj: UserLambdaValidationException): any => ({ ...obj, }); @@ -706,6 +787,9 @@ export interface AttributeType { } export namespace AttributeType { + /** + * @internal + */ export const filterSensitiveLog = (obj: AttributeType): any => ({ ...obj, ...(obj.Value && { Value: SENSITIVE_STRING }), @@ -860,6 +944,9 @@ export interface AdminCreateUserRequest { } export namespace AdminCreateUserRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: AdminCreateUserRequest): any => ({ ...obj, ...(obj.Username && { Username: SENSITIVE_STRING }), @@ -894,6 +981,9 @@ export interface MFAOptionType { } export namespace MFAOptionType { + /** + * @internal + */ export const filterSensitiveLog = (obj: MFAOptionType): any => ({ ...obj, }); @@ -976,6 +1066,9 @@ export interface UserType { } export namespace UserType { + /** + * @internal + */ export const filterSensitiveLog = (obj: UserType): any => ({ ...obj, ...(obj.Username && { Username: SENSITIVE_STRING }), @@ -994,6 +1087,9 @@ export interface AdminCreateUserResponse { } export namespace AdminCreateUserResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: AdminCreateUserResponse): any => ({ ...obj, ...(obj.User && { User: UserType.filterSensitiveLog(obj.User) }), @@ -1014,6 +1110,9 @@ export interface CodeDeliveryFailureException extends __SmithyException, $Metada } export namespace CodeDeliveryFailureException { + /** + * @internal + */ export const filterSensitiveLog = (obj: CodeDeliveryFailureException): any => ({ ...obj, }); @@ -1034,6 +1133,9 @@ export interface InvalidPasswordException extends __SmithyException, $MetadataBe } export namespace InvalidPasswordException { + /** + * @internal + */ export const filterSensitiveLog = (obj: InvalidPasswordException): any => ({ ...obj, }); @@ -1054,6 +1156,9 @@ export interface InvalidSmsRoleAccessPolicyException extends __SmithyException, } export namespace InvalidSmsRoleAccessPolicyException { + /** + * @internal + */ export const filterSensitiveLog = (obj: InvalidSmsRoleAccessPolicyException): any => ({ ...obj, }); @@ -1075,6 +1180,9 @@ export interface InvalidSmsRoleTrustRelationshipException extends __SmithyExcept } export namespace InvalidSmsRoleTrustRelationshipException { + /** + * @internal + */ export const filterSensitiveLog = (obj: InvalidSmsRoleTrustRelationshipException): any => ({ ...obj, }); @@ -1093,6 +1201,9 @@ export interface PreconditionNotMetException extends __SmithyException, $Metadat } export namespace PreconditionNotMetException { + /** + * @internal + */ export const filterSensitiveLog = (obj: PreconditionNotMetException): any => ({ ...obj, }); @@ -1111,6 +1222,9 @@ export interface UnsupportedUserStateException extends __SmithyException, $Metad } export namespace UnsupportedUserStateException { + /** + * @internal + */ export const filterSensitiveLog = (obj: UnsupportedUserStateException): any => ({ ...obj, }); @@ -1130,6 +1244,9 @@ export interface UsernameExistsException extends __SmithyException, $MetadataBea } export namespace UsernameExistsException { + /** + * @internal + */ export const filterSensitiveLog = (obj: UsernameExistsException): any => ({ ...obj, }); @@ -1156,6 +1273,9 @@ export interface MessageTemplateType { } export namespace MessageTemplateType { + /** + * @internal + */ export const filterSensitiveLog = (obj: MessageTemplateType): any => ({ ...obj, }); @@ -1193,6 +1313,9 @@ export interface AdminCreateUserConfigType { } export namespace AdminCreateUserConfigType { + /** + * @internal + */ export const filterSensitiveLog = (obj: AdminCreateUserConfigType): any => ({ ...obj, }); @@ -1214,6 +1337,9 @@ export interface AdminDeleteUserRequest { } export namespace AdminDeleteUserRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: AdminDeleteUserRequest): any => ({ ...obj, ...(obj.Username && { Username: SENSITIVE_STRING }), @@ -1243,6 +1369,9 @@ export interface AdminDeleteUserAttributesRequest { } export namespace AdminDeleteUserAttributesRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: AdminDeleteUserAttributesRequest): any => ({ ...obj, ...(obj.Username && { Username: SENSITIVE_STRING }), @@ -1256,6 +1385,9 @@ export namespace AdminDeleteUserAttributesRequest { export interface AdminDeleteUserAttributesResponse {} export namespace AdminDeleteUserAttributesResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: AdminDeleteUserAttributesResponse): any => ({ ...obj, }); @@ -1284,6 +1416,9 @@ export interface ProviderUserIdentifierType { } export namespace ProviderUserIdentifierType { + /** + * @internal + */ export const filterSensitiveLog = (obj: ProviderUserIdentifierType): any => ({ ...obj, }); @@ -1302,6 +1437,9 @@ export interface AdminDisableProviderForUserRequest { } export namespace AdminDisableProviderForUserRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: AdminDisableProviderForUserRequest): any => ({ ...obj, }); @@ -1310,6 +1448,9 @@ export namespace AdminDisableProviderForUserRequest { export interface AdminDisableProviderForUserResponse {} export namespace AdminDisableProviderForUserResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: AdminDisableProviderForUserResponse): any => ({ ...obj, }); @@ -1330,6 +1471,9 @@ export interface AliasExistsException extends __SmithyException, $MetadataBearer } export namespace AliasExistsException { + /** + * @internal + */ export const filterSensitiveLog = (obj: AliasExistsException): any => ({ ...obj, }); @@ -1351,6 +1495,9 @@ export interface AdminDisableUserRequest { } export namespace AdminDisableUserRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: AdminDisableUserRequest): any => ({ ...obj, ...(obj.Username && { Username: SENSITIVE_STRING }), @@ -1364,6 +1511,9 @@ export namespace AdminDisableUserRequest { export interface AdminDisableUserResponse {} export namespace AdminDisableUserResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: AdminDisableUserResponse): any => ({ ...obj, }); @@ -1385,6 +1535,9 @@ export interface AdminEnableUserRequest { } export namespace AdminEnableUserRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: AdminEnableUserRequest): any => ({ ...obj, ...(obj.Username && { Username: SENSITIVE_STRING }), @@ -1398,6 +1551,9 @@ export namespace AdminEnableUserRequest { export interface AdminEnableUserResponse {} export namespace AdminEnableUserResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: AdminEnableUserResponse): any => ({ ...obj, }); @@ -1424,6 +1580,9 @@ export interface AdminForgetDeviceRequest { } export namespace AdminForgetDeviceRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: AdminForgetDeviceRequest): any => ({ ...obj, ...(obj.Username && { Username: SENSITIVE_STRING }), @@ -1443,6 +1602,9 @@ export interface InvalidUserPoolConfigurationException extends __SmithyException } export namespace InvalidUserPoolConfigurationException { + /** + * @internal + */ export const filterSensitiveLog = (obj: InvalidUserPoolConfigurationException): any => ({ ...obj, }); @@ -1469,6 +1631,9 @@ export interface AdminGetDeviceRequest { } export namespace AdminGetDeviceRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: AdminGetDeviceRequest): any => ({ ...obj, ...(obj.Username && { Username: SENSITIVE_STRING }), @@ -1506,6 +1671,9 @@ export interface DeviceType { } export namespace DeviceType { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeviceType): any => ({ ...obj, ...(obj.DeviceAttributes && { @@ -1525,6 +1693,9 @@ export interface AdminGetDeviceResponse { } export namespace AdminGetDeviceResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: AdminGetDeviceResponse): any => ({ ...obj, ...(obj.Device && { Device: DeviceType.filterSensitiveLog(obj.Device) }), @@ -1548,6 +1719,9 @@ export interface AdminGetUserRequest { } export namespace AdminGetUserRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: AdminGetUserRequest): any => ({ ...obj, ...(obj.Username && { Username: SENSITIVE_STRING }), @@ -1637,6 +1811,9 @@ export interface AdminGetUserResponse { } export namespace AdminGetUserResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: AdminGetUserResponse): any => ({ ...obj, ...(obj.Username && { Username: SENSITIVE_STRING }), @@ -1664,6 +1841,9 @@ export interface AnalyticsMetadataType { } export namespace AnalyticsMetadataType { + /** + * @internal + */ export const filterSensitiveLog = (obj: AnalyticsMetadataType): any => ({ ...obj, }); @@ -1695,6 +1875,9 @@ export interface HttpHeader { } export namespace HttpHeader { + /** + * @internal + */ export const filterSensitiveLog = (obj: HttpHeader): any => ({ ...obj, }); @@ -1733,6 +1916,9 @@ export interface ContextDataType { } export namespace ContextDataType { + /** + * @internal + */ export const filterSensitiveLog = (obj: ContextDataType): any => ({ ...obj, }); @@ -1934,6 +2120,9 @@ export interface AdminInitiateAuthRequest { } export namespace AdminInitiateAuthRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: AdminInitiateAuthRequest): any => ({ ...obj, ...(obj.ClientId && { ClientId: SENSITIVE_STRING }), @@ -1957,6 +2146,9 @@ export interface NewDeviceMetadataType { } export namespace NewDeviceMetadataType { + /** + * @internal + */ export const filterSensitiveLog = (obj: NewDeviceMetadataType): any => ({ ...obj, }); @@ -1998,6 +2190,9 @@ export interface AuthenticationResultType { } export namespace AuthenticationResultType { + /** + * @internal + */ export const filterSensitiveLog = (obj: AuthenticationResultType): any => ({ ...obj, ...(obj.AccessToken && { AccessToken: SENSITIVE_STRING }), @@ -2134,6 +2329,9 @@ export interface AdminInitiateAuthResponse { } export namespace AdminInitiateAuthResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: AdminInitiateAuthResponse): any => ({ ...obj, ...(obj.AuthenticationResult && { @@ -2157,6 +2355,9 @@ export interface MFAMethodNotFoundException extends __SmithyException, $Metadata } export namespace MFAMethodNotFoundException { + /** + * @internal + */ export const filterSensitiveLog = (obj: MFAMethodNotFoundException): any => ({ ...obj, }); @@ -2175,6 +2376,9 @@ export interface PasswordResetRequiredException extends __SmithyException, $Meta } export namespace PasswordResetRequiredException { + /** + * @internal + */ export const filterSensitiveLog = (obj: PasswordResetRequiredException): any => ({ ...obj, }); @@ -2193,6 +2397,9 @@ export interface UserNotConfirmedException extends __SmithyException, $MetadataB } export namespace UserNotConfirmedException { + /** + * @internal + */ export const filterSensitiveLog = (obj: UserNotConfirmedException): any => ({ ...obj, }); @@ -2246,6 +2453,9 @@ export interface AdminLinkProviderForUserRequest { } export namespace AdminLinkProviderForUserRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: AdminLinkProviderForUserRequest): any => ({ ...obj, }); @@ -2254,6 +2464,9 @@ export namespace AdminLinkProviderForUserRequest { export interface AdminLinkProviderForUserResponse {} export namespace AdminLinkProviderForUserResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: AdminLinkProviderForUserResponse): any => ({ ...obj, }); @@ -2285,6 +2498,9 @@ export interface AdminListDevicesRequest { } export namespace AdminListDevicesRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: AdminListDevicesRequest): any => ({ ...obj, ...(obj.Username && { Username: SENSITIVE_STRING }), @@ -2307,6 +2523,9 @@ export interface AdminListDevicesResponse { } export namespace AdminListDevicesResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: AdminListDevicesResponse): any => ({ ...obj, }); @@ -2336,6 +2555,9 @@ export interface AdminListGroupsForUserRequest { } export namespace AdminListGroupsForUserRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: AdminListGroupsForUserRequest): any => ({ ...obj, ...(obj.Username && { Username: SENSITIVE_STRING }), @@ -2396,6 +2618,9 @@ export interface GroupType { } export namespace GroupType { + /** + * @internal + */ export const filterSensitiveLog = (obj: GroupType): any => ({ ...obj, }); @@ -2415,6 +2640,9 @@ export interface AdminListGroupsForUserResponse { } export namespace AdminListGroupsForUserResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: AdminListGroupsForUserResponse): any => ({ ...obj, }); @@ -2443,6 +2671,9 @@ export interface AdminListUserAuthEventsRequest { } export namespace AdminListUserAuthEventsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: AdminListUserAuthEventsRequest): any => ({ ...obj, ...(obj.Username && { Username: SENSITIVE_STRING }), @@ -2475,6 +2706,9 @@ export interface ChallengeResponseType { } export namespace ChallengeResponseType { + /** + * @internal + */ export const filterSensitiveLog = (obj: ChallengeResponseType): any => ({ ...obj, }); @@ -2511,6 +2745,9 @@ export interface EventContextDataType { } export namespace EventContextDataType { + /** + * @internal + */ export const filterSensitiveLog = (obj: EventContextDataType): any => ({ ...obj, }); @@ -2542,6 +2779,9 @@ export interface EventFeedbackType { } export namespace EventFeedbackType { + /** + * @internal + */ export const filterSensitiveLog = (obj: EventFeedbackType): any => ({ ...obj, }); @@ -2586,6 +2826,9 @@ export interface EventRiskType { } export namespace EventRiskType { + /** + * @internal + */ export const filterSensitiveLog = (obj: EventRiskType): any => ({ ...obj, }); @@ -2645,6 +2888,9 @@ export interface AuthEventType { } export namespace AuthEventType { + /** + * @internal + */ export const filterSensitiveLog = (obj: AuthEventType): any => ({ ...obj, }); @@ -2665,6 +2911,9 @@ export interface AdminListUserAuthEventsResponse { } export namespace AdminListUserAuthEventsResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: AdminListUserAuthEventsResponse): any => ({ ...obj, }); @@ -2680,6 +2929,9 @@ export interface UserPoolAddOnNotEnabledException extends __SmithyException, $Me } export namespace UserPoolAddOnNotEnabledException { + /** + * @internal + */ export const filterSensitiveLog = (obj: UserPoolAddOnNotEnabledException): any => ({ ...obj, }); @@ -2703,6 +2955,9 @@ export interface AdminRemoveUserFromGroupRequest { } export namespace AdminRemoveUserFromGroupRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: AdminRemoveUserFromGroupRequest): any => ({ ...obj, ...(obj.Username && { Username: SENSITIVE_STRING }), @@ -2761,6 +3016,9 @@ export interface AdminResetUserPasswordRequest { } export namespace AdminResetUserPasswordRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: AdminResetUserPasswordRequest): any => ({ ...obj, ...(obj.Username && { Username: SENSITIVE_STRING }), @@ -2774,6 +3032,9 @@ export namespace AdminResetUserPasswordRequest { export interface AdminResetUserPasswordResponse {} export namespace AdminResetUserPasswordResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: AdminResetUserPasswordResponse): any => ({ ...obj, }); @@ -2794,6 +3055,9 @@ export interface InvalidEmailRoleAccessPolicyException extends __SmithyException } export namespace InvalidEmailRoleAccessPolicyException { + /** + * @internal + */ export const filterSensitiveLog = (obj: InvalidEmailRoleAccessPolicyException): any => ({ ...obj, }); @@ -2926,6 +3190,9 @@ export interface AdminRespondToAuthChallengeRequest { } export namespace AdminRespondToAuthChallengeRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: AdminRespondToAuthChallengeRequest): any => ({ ...obj, ...(obj.ClientId && { ClientId: SENSITIVE_STRING }), @@ -2961,6 +3228,9 @@ export interface AdminRespondToAuthChallengeResponse { } export namespace AdminRespondToAuthChallengeResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: AdminRespondToAuthChallengeResponse): any => ({ ...obj, ...(obj.AuthenticationResult && { @@ -2983,6 +3253,9 @@ export interface CodeMismatchException extends __SmithyException, $MetadataBeare } export namespace CodeMismatchException { + /** + * @internal + */ export const filterSensitiveLog = (obj: CodeMismatchException): any => ({ ...obj, }); @@ -3001,6 +3274,9 @@ export interface ExpiredCodeException extends __SmithyException, $MetadataBearer } export namespace ExpiredCodeException { + /** + * @internal + */ export const filterSensitiveLog = (obj: ExpiredCodeException): any => ({ ...obj, }); @@ -3017,6 +3293,9 @@ export interface SoftwareTokenMFANotFoundException extends __SmithyException, $M } export namespace SoftwareTokenMFANotFoundException { + /** + * @internal + */ export const filterSensitiveLog = (obj: SoftwareTokenMFANotFoundException): any => ({ ...obj, }); @@ -3045,6 +3324,9 @@ export interface SMSMfaSettingsType { } export namespace SMSMfaSettingsType { + /** + * @internal + */ export const filterSensitiveLog = (obj: SMSMfaSettingsType): any => ({ ...obj, }); @@ -3072,6 +3354,9 @@ export interface SoftwareTokenMfaSettingsType { } export namespace SoftwareTokenMfaSettingsType { + /** + * @internal + */ export const filterSensitiveLog = (obj: SoftwareTokenMfaSettingsType): any => ({ ...obj, }); @@ -3100,6 +3385,9 @@ export interface AdminSetUserMFAPreferenceRequest { } export namespace AdminSetUserMFAPreferenceRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: AdminSetUserMFAPreferenceRequest): any => ({ ...obj, ...(obj.Username && { Username: SENSITIVE_STRING }), @@ -3109,6 +3397,9 @@ export namespace AdminSetUserMFAPreferenceRequest { export interface AdminSetUserMFAPreferenceResponse {} export namespace AdminSetUserMFAPreferenceResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: AdminSetUserMFAPreferenceResponse): any => ({ ...obj, }); @@ -3139,6 +3430,9 @@ export interface AdminSetUserPasswordRequest { } export namespace AdminSetUserPasswordRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: AdminSetUserPasswordRequest): any => ({ ...obj, ...(obj.Username && { Username: SENSITIVE_STRING }), @@ -3149,6 +3443,9 @@ export namespace AdminSetUserPasswordRequest { export interface AdminSetUserPasswordResponse {} export namespace AdminSetUserPasswordResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: AdminSetUserPasswordResponse): any => ({ ...obj, }); @@ -3178,6 +3475,9 @@ export interface AdminSetUserSettingsRequest { } export namespace AdminSetUserSettingsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: AdminSetUserSettingsRequest): any => ({ ...obj, ...(obj.Username && { Username: SENSITIVE_STRING }), @@ -3191,6 +3491,9 @@ export namespace AdminSetUserSettingsRequest { export interface AdminSetUserSettingsResponse {} export namespace AdminSetUserSettingsResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: AdminSetUserSettingsResponse): any => ({ ...obj, }); @@ -3219,6 +3522,9 @@ export interface AdminUpdateAuthEventFeedbackRequest { } export namespace AdminUpdateAuthEventFeedbackRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: AdminUpdateAuthEventFeedbackRequest): any => ({ ...obj, ...(obj.Username && { Username: SENSITIVE_STRING }), @@ -3228,6 +3534,9 @@ export namespace AdminUpdateAuthEventFeedbackRequest { export interface AdminUpdateAuthEventFeedbackResponse {} export namespace AdminUpdateAuthEventFeedbackResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: AdminUpdateAuthEventFeedbackResponse): any => ({ ...obj, }); @@ -3264,6 +3573,9 @@ export interface AdminUpdateDeviceStatusRequest { } export namespace AdminUpdateDeviceStatusRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: AdminUpdateDeviceStatusRequest): any => ({ ...obj, ...(obj.Username && { Username: SENSITIVE_STRING }), @@ -3276,6 +3588,9 @@ export namespace AdminUpdateDeviceStatusRequest { export interface AdminUpdateDeviceStatusResponse {} export namespace AdminUpdateDeviceStatusResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: AdminUpdateDeviceStatusResponse): any => ({ ...obj, }); @@ -3340,6 +3655,9 @@ export interface AdminUpdateUserAttributesRequest { } export namespace AdminUpdateUserAttributesRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: AdminUpdateUserAttributesRequest): any => ({ ...obj, ...(obj.Username && { Username: SENSITIVE_STRING }), @@ -3356,6 +3674,9 @@ export namespace AdminUpdateUserAttributesRequest { export interface AdminUpdateUserAttributesResponse {} export namespace AdminUpdateUserAttributesResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: AdminUpdateUserAttributesResponse): any => ({ ...obj, }); @@ -3377,6 +3698,9 @@ export interface AdminUserGlobalSignOutRequest { } export namespace AdminUserGlobalSignOutRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: AdminUserGlobalSignOutRequest): any => ({ ...obj, ...(obj.Username && { Username: SENSITIVE_STRING }), @@ -3389,6 +3713,9 @@ export namespace AdminUserGlobalSignOutRequest { export interface AdminUserGlobalSignOutResponse {} export namespace AdminUserGlobalSignOutResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: AdminUserGlobalSignOutResponse): any => ({ ...obj, }); @@ -3448,6 +3775,9 @@ export interface AnalyticsConfigurationType { } export namespace AnalyticsConfigurationType { + /** + * @internal + */ export const filterSensitiveLog = (obj: AnalyticsConfigurationType): any => ({ ...obj, }); @@ -3467,6 +3797,9 @@ export interface AssociateSoftwareTokenRequest { } export namespace AssociateSoftwareTokenRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: AssociateSoftwareTokenRequest): any => ({ ...obj, ...(obj.AccessToken && { AccessToken: SENSITIVE_STRING }), @@ -3488,6 +3821,9 @@ export interface AssociateSoftwareTokenResponse { } export namespace AssociateSoftwareTokenResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: AssociateSoftwareTokenResponse): any => ({ ...obj, ...(obj.SecretCode && { SecretCode: SENSITIVE_STRING }), @@ -3508,6 +3844,9 @@ export interface ConcurrentModificationException extends __SmithyException, $Met } export namespace ConcurrentModificationException { + /** + * @internal + */ export const filterSensitiveLog = (obj: ConcurrentModificationException): any => ({ ...obj, }); @@ -3534,6 +3873,9 @@ export interface ChangePasswordRequest { } export namespace ChangePasswordRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ChangePasswordRequest): any => ({ ...obj, ...(obj.PreviousPassword && { PreviousPassword: SENSITIVE_STRING }), @@ -3548,6 +3890,9 @@ export namespace ChangePasswordRequest { export interface ChangePasswordResponse {} export namespace ChangePasswordResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ChangePasswordResponse): any => ({ ...obj, }); @@ -3569,6 +3914,9 @@ export interface DeviceSecretVerifierConfigType { } export namespace DeviceSecretVerifierConfigType { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeviceSecretVerifierConfigType): any => ({ ...obj, }); @@ -3600,6 +3948,9 @@ export interface ConfirmDeviceRequest { } export namespace ConfirmDeviceRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ConfirmDeviceRequest): any => ({ ...obj, ...(obj.AccessToken && { AccessToken: SENSITIVE_STRING }), @@ -3618,6 +3969,9 @@ export interface ConfirmDeviceResponse { } export namespace ConfirmDeviceResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ConfirmDeviceResponse): any => ({ ...obj, }); @@ -3638,6 +3992,9 @@ export interface UserContextDataType { } export namespace UserContextDataType { + /** + * @internal + */ export const filterSensitiveLog = (obj: UserContextDataType): any => ({ ...obj, }); @@ -3726,6 +4083,9 @@ export interface ConfirmForgotPasswordRequest { } export namespace ConfirmForgotPasswordRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ConfirmForgotPasswordRequest): any => ({ ...obj, ...(obj.ClientId && { ClientId: SENSITIVE_STRING }), @@ -3742,6 +4102,9 @@ export namespace ConfirmForgotPasswordRequest { export interface ConfirmForgotPasswordResponse {} export namespace ConfirmForgotPasswordResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ConfirmForgotPasswordResponse): any => ({ ...obj, }); @@ -3832,6 +4195,9 @@ export interface ConfirmSignUpRequest { } export namespace ConfirmSignUpRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ConfirmSignUpRequest): any => ({ ...obj, ...(obj.ClientId && { ClientId: SENSITIVE_STRING }), @@ -3846,6 +4212,9 @@ export namespace ConfirmSignUpRequest { export interface ConfirmSignUpResponse {} export namespace ConfirmSignUpResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ConfirmSignUpResponse): any => ({ ...obj, }); @@ -3892,6 +4261,9 @@ export interface CreateGroupRequest { } export namespace CreateGroupRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateGroupRequest): any => ({ ...obj, }); @@ -3905,6 +4277,9 @@ export interface CreateGroupResponse { } export namespace CreateGroupResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateGroupResponse): any => ({ ...obj, }); @@ -3921,6 +4296,9 @@ export interface GroupExistsException extends __SmithyException, $MetadataBearer } export namespace GroupExistsException { + /** + * @internal + */ export const filterSensitiveLog = (obj: GroupExistsException): any => ({ ...obj, }); @@ -4075,6 +4453,9 @@ export interface CreateIdentityProviderRequest { } export namespace CreateIdentityProviderRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateIdentityProviderRequest): any => ({ ...obj, }); @@ -4236,6 +4617,9 @@ export interface IdentityProviderType { } export namespace IdentityProviderType { + /** + * @internal + */ export const filterSensitiveLog = (obj: IdentityProviderType): any => ({ ...obj, }); @@ -4249,6 +4633,9 @@ export interface CreateIdentityProviderResponse { } export namespace CreateIdentityProviderResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateIdentityProviderResponse): any => ({ ...obj, }); @@ -4265,6 +4652,9 @@ export interface DuplicateProviderException extends __SmithyException, $Metadata } export namespace DuplicateProviderException { + /** + * @internal + */ export const filterSensitiveLog = (obj: DuplicateProviderException): any => ({ ...obj, }); @@ -4286,6 +4676,9 @@ export interface ResourceServerScopeType { } export namespace ResourceServerScopeType { + /** + * @internal + */ export const filterSensitiveLog = (obj: ResourceServerScopeType): any => ({ ...obj, }); @@ -4317,6 +4710,9 @@ export interface CreateResourceServerRequest { } export namespace CreateResourceServerRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateResourceServerRequest): any => ({ ...obj, }); @@ -4348,6 +4744,9 @@ export interface ResourceServerType { } export namespace ResourceServerType { + /** + * @internal + */ export const filterSensitiveLog = (obj: ResourceServerType): any => ({ ...obj, }); @@ -4361,6 +4760,9 @@ export interface CreateResourceServerResponse { } export namespace CreateResourceServerResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateResourceServerResponse): any => ({ ...obj, }); @@ -4387,6 +4789,9 @@ export interface CreateUserImportJobRequest { } export namespace CreateUserImportJobRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateUserImportJobRequest): any => ({ ...obj, }); @@ -4516,6 +4921,9 @@ export interface UserImportJobType { } export namespace UserImportJobType { + /** + * @internal + */ export const filterSensitiveLog = (obj: UserImportJobType): any => ({ ...obj, }); @@ -4533,6 +4941,9 @@ export interface CreateUserImportJobResponse { } export namespace CreateUserImportJobResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateUserImportJobResponse): any => ({ ...obj, }); @@ -4560,6 +4971,9 @@ export interface DeviceConfigurationType { } export namespace DeviceConfigurationType { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeviceConfigurationType): any => ({ ...obj, }); @@ -4710,6 +5124,9 @@ export interface EmailConfigurationType { } export namespace EmailConfigurationType { + /** + * @internal + */ export const filterSensitiveLog = (obj: EmailConfigurationType): any => ({ ...obj, }); @@ -4738,6 +5155,9 @@ export interface CustomEmailLambdaVersionConfigType { } export namespace CustomEmailLambdaVersionConfigType { + /** + * @internal + */ export const filterSensitiveLog = (obj: CustomEmailLambdaVersionConfigType): any => ({ ...obj, }); @@ -4766,6 +5186,9 @@ export interface CustomSMSLambdaVersionConfigType { } export namespace CustomSMSLambdaVersionConfigType { + /** + * @internal + */ export const filterSensitiveLog = (obj: CustomSMSLambdaVersionConfigType): any => ({ ...obj, }); @@ -4844,6 +5267,9 @@ export interface LambdaConfigType { } export namespace LambdaConfigType { + /** + * @internal + */ export const filterSensitiveLog = (obj: LambdaConfigType): any => ({ ...obj, }); @@ -4903,6 +5329,9 @@ export interface PasswordPolicyType { } export namespace PasswordPolicyType { + /** + * @internal + */ export const filterSensitiveLog = (obj: PasswordPolicyType): any => ({ ...obj, }); @@ -4919,6 +5348,9 @@ export interface UserPoolPolicyType { } export namespace UserPoolPolicyType { + /** + * @internal + */ export const filterSensitiveLog = (obj: UserPoolPolicyType): any => ({ ...obj, }); @@ -4955,6 +5387,9 @@ export interface SmsConfigurationType { } export namespace SmsConfigurationType { + /** + * @internal + */ export const filterSensitiveLog = (obj: SmsConfigurationType): any => ({ ...obj, }); @@ -5000,6 +5435,9 @@ export interface UsernameConfigurationType { } export namespace UsernameConfigurationType { + /** + * @internal + */ export const filterSensitiveLog = (obj: UsernameConfigurationType): any => ({ ...obj, }); @@ -5016,6 +5454,9 @@ export interface UserPoolAddOnsType { } export namespace UserPoolAddOnsType { + /** + * @internal + */ export const filterSensitiveLog = (obj: UserPoolAddOnsType): any => ({ ...obj, }); @@ -5065,6 +5506,9 @@ export interface VerificationMessageTemplateType { } export namespace VerificationMessageTemplateType { + /** + * @internal + */ export const filterSensitiveLog = (obj: VerificationMessageTemplateType): any => ({ ...obj, }); @@ -5208,6 +5652,9 @@ export interface CreateUserPoolRequest { } export namespace CreateUserPoolRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateUserPoolRequest): any => ({ ...obj, }); @@ -5410,6 +5857,9 @@ export interface UserPoolType { } export namespace UserPoolType { + /** + * @internal + */ export const filterSensitiveLog = (obj: UserPoolType): any => ({ ...obj, }); @@ -5426,6 +5876,9 @@ export interface CreateUserPoolResponse { } export namespace CreateUserPoolResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateUserPoolResponse): any => ({ ...obj, }); @@ -5441,6 +5894,9 @@ export interface UserPoolTaggingException extends __SmithyException, $MetadataBe } export namespace UserPoolTaggingException { + /** + * @internal + */ export const filterSensitiveLog = (obj: UserPoolTaggingException): any => ({ ...obj, }); @@ -5500,6 +5956,9 @@ export interface TokenValidityUnitsType { } export namespace TokenValidityUnitsType { + /** + * @internal + */ export const filterSensitiveLog = (obj: TokenValidityUnitsType): any => ({ ...obj, }); @@ -5735,6 +6194,9 @@ export interface CreateUserPoolClientRequest { } export namespace CreateUserPoolClientRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateUserPoolClientRequest): any => ({ ...obj, }); @@ -5972,6 +6434,9 @@ export interface UserPoolClientType { } export namespace UserPoolClientType { + /** + * @internal + */ export const filterSensitiveLog = (obj: UserPoolClientType): any => ({ ...obj, ...(obj.ClientId && { ClientId: SENSITIVE_STRING }), @@ -5990,6 +6455,9 @@ export interface CreateUserPoolClientResponse { } export namespace CreateUserPoolClientResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateUserPoolClientResponse): any => ({ ...obj, ...(obj.UserPoolClient && { UserPoolClient: UserPoolClientType.filterSensitiveLog(obj.UserPoolClient) }), @@ -6006,6 +6474,9 @@ export interface InvalidOAuthFlowException extends __SmithyException, $MetadataB } export namespace InvalidOAuthFlowException { + /** + * @internal + */ export const filterSensitiveLog = (obj: InvalidOAuthFlowException): any => ({ ...obj, }); @@ -6021,6 +6492,9 @@ export interface ScopeDoesNotExistException extends __SmithyException, $Metadata } export namespace ScopeDoesNotExistException { + /** + * @internal + */ export const filterSensitiveLog = (obj: ScopeDoesNotExistException): any => ({ ...obj, }); @@ -6039,6 +6513,9 @@ export interface CustomDomainConfigType { } export namespace CustomDomainConfigType { + /** + * @internal + */ export const filterSensitiveLog = (obj: CustomDomainConfigType): any => ({ ...obj, }); @@ -6067,6 +6544,9 @@ export interface CreateUserPoolDomainRequest { } export namespace CreateUserPoolDomainRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateUserPoolDomainRequest): any => ({ ...obj, }); @@ -6081,6 +6561,9 @@ export interface CreateUserPoolDomainResponse { } export namespace CreateUserPoolDomainResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateUserPoolDomainResponse): any => ({ ...obj, }); @@ -6099,6 +6582,9 @@ export interface DeleteGroupRequest { } export namespace DeleteGroupRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteGroupRequest): any => ({ ...obj, }); @@ -6117,6 +6603,9 @@ export interface DeleteIdentityProviderRequest { } export namespace DeleteIdentityProviderRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteIdentityProviderRequest): any => ({ ...obj, }); @@ -6132,6 +6621,9 @@ export interface UnsupportedIdentityProviderException extends __SmithyException, } export namespace UnsupportedIdentityProviderException { + /** + * @internal + */ export const filterSensitiveLog = (obj: UnsupportedIdentityProviderException): any => ({ ...obj, }); @@ -6150,6 +6642,9 @@ export interface DeleteResourceServerRequest { } export namespace DeleteResourceServerRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteResourceServerRequest): any => ({ ...obj, }); @@ -6166,6 +6661,9 @@ export interface DeleteUserRequest { } export namespace DeleteUserRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteUserRequest): any => ({ ...obj, ...(obj.AccessToken && { AccessToken: SENSITIVE_STRING }), @@ -6190,6 +6688,9 @@ export interface DeleteUserAttributesRequest { } export namespace DeleteUserAttributesRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteUserAttributesRequest): any => ({ ...obj, ...(obj.AccessToken && { AccessToken: SENSITIVE_STRING }), @@ -6202,6 +6703,9 @@ export namespace DeleteUserAttributesRequest { export interface DeleteUserAttributesResponse {} export namespace DeleteUserAttributesResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteUserAttributesResponse): any => ({ ...obj, }); @@ -6218,6 +6722,9 @@ export interface DeleteUserPoolRequest { } export namespace DeleteUserPoolRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteUserPoolRequest): any => ({ ...obj, }); @@ -6239,6 +6746,9 @@ export interface DeleteUserPoolClientRequest { } export namespace DeleteUserPoolClientRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteUserPoolClientRequest): any => ({ ...obj, ...(obj.ClientId && { ClientId: SENSITIVE_STRING }), @@ -6258,6 +6768,9 @@ export interface DeleteUserPoolDomainRequest { } export namespace DeleteUserPoolDomainRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteUserPoolDomainRequest): any => ({ ...obj, }); @@ -6266,6 +6779,9 @@ export namespace DeleteUserPoolDomainRequest { export interface DeleteUserPoolDomainResponse {} export namespace DeleteUserPoolDomainResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteUserPoolDomainResponse): any => ({ ...obj, }); @@ -6284,6 +6800,9 @@ export interface DescribeIdentityProviderRequest { } export namespace DescribeIdentityProviderRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeIdentityProviderRequest): any => ({ ...obj, }); @@ -6297,6 +6816,9 @@ export interface DescribeIdentityProviderResponse { } export namespace DescribeIdentityProviderResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeIdentityProviderResponse): any => ({ ...obj, }); @@ -6315,6 +6837,9 @@ export interface DescribeResourceServerRequest { } export namespace DescribeResourceServerRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeResourceServerRequest): any => ({ ...obj, }); @@ -6328,6 +6853,9 @@ export interface DescribeResourceServerResponse { } export namespace DescribeResourceServerResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeResourceServerResponse): any => ({ ...obj, }); @@ -6346,6 +6874,9 @@ export interface DescribeRiskConfigurationRequest { } export namespace DescribeRiskConfigurationRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeRiskConfigurationRequest): any => ({ ...obj, ...(obj.ClientId && { ClientId: SENSITIVE_STRING }), @@ -6368,6 +6899,9 @@ export interface CompromisedCredentialsActionsType { } export namespace CompromisedCredentialsActionsType { + /** + * @internal + */ export const filterSensitiveLog = (obj: CompromisedCredentialsActionsType): any => ({ ...obj, }); @@ -6396,6 +6930,9 @@ export interface CompromisedCredentialsRiskConfigurationType { } export namespace CompromisedCredentialsRiskConfigurationType { + /** + * @internal + */ export const filterSensitiveLog = (obj: CompromisedCredentialsRiskConfigurationType): any => ({ ...obj, }); @@ -6420,6 +6957,9 @@ export interface RiskExceptionConfigurationType { } export namespace RiskExceptionConfigurationType { + /** + * @internal + */ export const filterSensitiveLog = (obj: RiskExceptionConfigurationType): any => ({ ...obj, }); @@ -6465,6 +7005,9 @@ export interface RiskConfigurationType { } export namespace RiskConfigurationType { + /** + * @internal + */ export const filterSensitiveLog = (obj: RiskConfigurationType): any => ({ ...obj, ...(obj.ClientId && { ClientId: SENSITIVE_STRING }), @@ -6479,6 +7022,9 @@ export interface DescribeRiskConfigurationResponse { } export namespace DescribeRiskConfigurationResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeRiskConfigurationResponse): any => ({ ...obj, ...(obj.RiskConfiguration && { @@ -6503,6 +7049,9 @@ export interface DescribeUserImportJobRequest { } export namespace DescribeUserImportJobRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeUserImportJobRequest): any => ({ ...obj, }); @@ -6520,6 +7069,9 @@ export interface DescribeUserImportJobResponse { } export namespace DescribeUserImportJobResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeUserImportJobResponse): any => ({ ...obj, }); @@ -6536,6 +7088,9 @@ export interface DescribeUserPoolRequest { } export namespace DescribeUserPoolRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeUserPoolRequest): any => ({ ...obj, }); @@ -6552,6 +7107,9 @@ export interface DescribeUserPoolResponse { } export namespace DescribeUserPoolResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeUserPoolResponse): any => ({ ...obj, }); @@ -6573,6 +7131,9 @@ export interface DescribeUserPoolClientRequest { } export namespace DescribeUserPoolClientRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeUserPoolClientRequest): any => ({ ...obj, ...(obj.ClientId && { ClientId: SENSITIVE_STRING }), @@ -6591,6 +7152,9 @@ export interface DescribeUserPoolClientResponse { } export namespace DescribeUserPoolClientResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeUserPoolClientResponse): any => ({ ...obj, ...(obj.UserPoolClient && { UserPoolClient: UserPoolClientType.filterSensitiveLog(obj.UserPoolClient) }), @@ -6605,6 +7169,9 @@ export interface DescribeUserPoolDomainRequest { } export namespace DescribeUserPoolDomainRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeUserPoolDomainRequest): any => ({ ...obj, }); @@ -6665,6 +7232,9 @@ export interface DomainDescriptionType { } export namespace DomainDescriptionType { + /** + * @internal + */ export const filterSensitiveLog = (obj: DomainDescriptionType): any => ({ ...obj, }); @@ -6678,6 +7248,9 @@ export interface DescribeUserPoolDomainResponse { } export namespace DescribeUserPoolDomainResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeUserPoolDomainResponse): any => ({ ...obj, }); @@ -6699,6 +7272,9 @@ export interface ForgetDeviceRequest { } export namespace ForgetDeviceRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ForgetDeviceRequest): any => ({ ...obj, ...(obj.AccessToken && { AccessToken: SENSITIVE_STRING }), @@ -6778,6 +7354,9 @@ export interface ForgotPasswordRequest { } export namespace ForgotPasswordRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ForgotPasswordRequest): any => ({ ...obj, ...(obj.ClientId && { ClientId: SENSITIVE_STRING }), @@ -6807,6 +7386,9 @@ export interface CodeDeliveryDetailsType { } export namespace CodeDeliveryDetailsType { + /** + * @internal + */ export const filterSensitiveLog = (obj: CodeDeliveryDetailsType): any => ({ ...obj, }); @@ -6825,6 +7407,9 @@ export interface ForgotPasswordResponse { } export namespace ForgotPasswordResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ForgotPasswordResponse): any => ({ ...obj, }); @@ -6842,6 +7427,9 @@ export interface GetCSVHeaderRequest { } export namespace GetCSVHeaderRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetCSVHeaderRequest): any => ({ ...obj, }); @@ -6864,6 +7452,9 @@ export interface GetCSVHeaderResponse { } export namespace GetCSVHeaderResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetCSVHeaderResponse): any => ({ ...obj, }); @@ -6885,6 +7476,9 @@ export interface GetDeviceRequest { } export namespace GetDeviceRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetDeviceRequest): any => ({ ...obj, ...(obj.AccessToken && { AccessToken: SENSITIVE_STRING }), @@ -6902,6 +7496,9 @@ export interface GetDeviceResponse { } export namespace GetDeviceResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetDeviceResponse): any => ({ ...obj, ...(obj.Device && { Device: DeviceType.filterSensitiveLog(obj.Device) }), @@ -6921,6 +7518,9 @@ export interface GetGroupRequest { } export namespace GetGroupRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetGroupRequest): any => ({ ...obj, }); @@ -6934,6 +7534,9 @@ export interface GetGroupResponse { } export namespace GetGroupResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetGroupResponse): any => ({ ...obj, }); @@ -6952,6 +7555,9 @@ export interface GetIdentityProviderByIdentifierRequest { } export namespace GetIdentityProviderByIdentifierRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetIdentityProviderByIdentifierRequest): any => ({ ...obj, }); @@ -6965,6 +7571,9 @@ export interface GetIdentityProviderByIdentifierResponse { } export namespace GetIdentityProviderByIdentifierResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetIdentityProviderByIdentifierResponse): any => ({ ...obj, }); @@ -6981,6 +7590,9 @@ export interface GetSigningCertificateRequest { } export namespace GetSigningCertificateRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetSigningCertificateRequest): any => ({ ...obj, }); @@ -6997,6 +7609,9 @@ export interface GetSigningCertificateResponse { } export namespace GetSigningCertificateResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetSigningCertificateResponse): any => ({ ...obj, }); @@ -7015,6 +7630,9 @@ export interface GetUICustomizationRequest { } export namespace GetUICustomizationRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetUICustomizationRequest): any => ({ ...obj, ...(obj.ClientId && { ClientId: SENSITIVE_STRING }), @@ -7063,6 +7681,9 @@ export interface UICustomizationType { } export namespace UICustomizationType { + /** + * @internal + */ export const filterSensitiveLog = (obj: UICustomizationType): any => ({ ...obj, ...(obj.ClientId && { ClientId: SENSITIVE_STRING }), @@ -7077,6 +7698,9 @@ export interface GetUICustomizationResponse { } export namespace GetUICustomizationResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetUICustomizationResponse): any => ({ ...obj, ...(obj.UICustomization && { UICustomization: UICustomizationType.filterSensitiveLog(obj.UICustomization) }), @@ -7095,6 +7719,9 @@ export interface GetUserRequest { } export namespace GetUserRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetUserRequest): any => ({ ...obj, ...(obj.AccessToken && { AccessToken: SENSITIVE_STRING }), @@ -7140,6 +7767,9 @@ export interface GetUserResponse { } export namespace GetUserResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetUserResponse): any => ({ ...obj, ...(obj.Username && { Username: SENSITIVE_STRING }), @@ -7203,6 +7833,9 @@ export interface GetUserAttributeVerificationCodeRequest { } export namespace GetUserAttributeVerificationCodeRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetUserAttributeVerificationCodeRequest): any => ({ ...obj, ...(obj.AccessToken && { AccessToken: SENSITIVE_STRING }), @@ -7222,6 +7855,9 @@ export interface GetUserAttributeVerificationCodeResponse { } export namespace GetUserAttributeVerificationCodeResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetUserAttributeVerificationCodeResponse): any => ({ ...obj, }); @@ -7235,6 +7871,9 @@ export interface GetUserPoolMfaConfigRequest { } export namespace GetUserPoolMfaConfigRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetUserPoolMfaConfigRequest): any => ({ ...obj, }); @@ -7258,6 +7897,9 @@ export interface SmsMfaConfigType { } export namespace SmsMfaConfigType { + /** + * @internal + */ export const filterSensitiveLog = (obj: SmsMfaConfigType): any => ({ ...obj, }); @@ -7274,6 +7916,9 @@ export interface SoftwareTokenMfaConfigType { } export namespace SoftwareTokenMfaConfigType { + /** + * @internal + */ export const filterSensitiveLog = (obj: SoftwareTokenMfaConfigType): any => ({ ...obj, }); @@ -7312,6 +7957,9 @@ export interface GetUserPoolMfaConfigResponse { } export namespace GetUserPoolMfaConfigResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetUserPoolMfaConfigResponse): any => ({ ...obj, }); @@ -7328,6 +7976,9 @@ export interface GlobalSignOutRequest { } export namespace GlobalSignOutRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GlobalSignOutRequest): any => ({ ...obj, ...(obj.AccessToken && { AccessToken: SENSITIVE_STRING }), @@ -7340,6 +7991,9 @@ export namespace GlobalSignOutRequest { export interface GlobalSignOutResponse {} export namespace GlobalSignOutResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: GlobalSignOutResponse): any => ({ ...obj, }); @@ -7528,6 +8182,9 @@ export interface InitiateAuthRequest { } export namespace InitiateAuthRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: InitiateAuthRequest): any => ({ ...obj, ...(obj.AuthParameters && { AuthParameters: SENSITIVE_STRING }), @@ -7627,6 +8284,9 @@ export interface InitiateAuthResponse { } export namespace InitiateAuthResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: InitiateAuthResponse): any => ({ ...obj, ...(obj.AuthenticationResult && { @@ -7656,6 +8316,9 @@ export interface ListDevicesRequest { } export namespace ListDevicesRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListDevicesRequest): any => ({ ...obj, ...(obj.AccessToken && { AccessToken: SENSITIVE_STRING }), @@ -7678,6 +8341,9 @@ export interface ListDevicesResponse { } export namespace ListDevicesResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListDevicesResponse): any => ({ ...obj, }); @@ -7702,6 +8368,9 @@ export interface ListGroupsRequest { } export namespace ListGroupsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListGroupsRequest): any => ({ ...obj, }); @@ -7721,6 +8390,9 @@ export interface ListGroupsResponse { } export namespace ListGroupsResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListGroupsResponse): any => ({ ...obj, }); @@ -7744,6 +8416,9 @@ export interface ListIdentityProvidersRequest { } export namespace ListIdentityProvidersRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListIdentityProvidersRequest): any => ({ ...obj, }); @@ -7775,6 +8450,9 @@ export interface ProviderDescription { } export namespace ProviderDescription { + /** + * @internal + */ export const filterSensitiveLog = (obj: ProviderDescription): any => ({ ...obj, }); @@ -7793,6 +8471,9 @@ export interface ListIdentityProvidersResponse { } export namespace ListIdentityProvidersResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListIdentityProvidersResponse): any => ({ ...obj, }); @@ -7816,6 +8497,9 @@ export interface ListResourceServersRequest { } export namespace ListResourceServersRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListResourceServersRequest): any => ({ ...obj, }); @@ -7834,6 +8518,9 @@ export interface ListResourceServersResponse { } export namespace ListResourceServersResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListResourceServersResponse): any => ({ ...obj, }); @@ -7847,6 +8534,9 @@ export interface ListTagsForResourceRequest { } export namespace ListTagsForResourceRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListTagsForResourceRequest): any => ({ ...obj, }); @@ -7860,6 +8550,9 @@ export interface ListTagsForResourceResponse { } export namespace ListTagsForResourceResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListTagsForResourceResponse): any => ({ ...obj, }); @@ -7888,6 +8581,9 @@ export interface ListUserImportJobsRequest { } export namespace ListUserImportJobsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListUserImportJobsRequest): any => ({ ...obj, }); @@ -7911,6 +8607,9 @@ export interface ListUserImportJobsResponse { } export namespace ListUserImportJobsResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListUserImportJobsResponse): any => ({ ...obj, }); @@ -7939,6 +8638,9 @@ export interface ListUserPoolClientsRequest { } export namespace ListUserPoolClientsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListUserPoolClientsRequest): any => ({ ...obj, }); @@ -7966,6 +8668,9 @@ export interface UserPoolClientDescription { } export namespace UserPoolClientDescription { + /** + * @internal + */ export const filterSensitiveLog = (obj: UserPoolClientDescription): any => ({ ...obj, ...(obj.ClientId && { ClientId: SENSITIVE_STRING }), @@ -7989,6 +8694,9 @@ export interface ListUserPoolClientsResponse { } export namespace ListUserPoolClientsResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListUserPoolClientsResponse): any => ({ ...obj, ...(obj.UserPoolClients && { @@ -8015,6 +8723,9 @@ export interface ListUserPoolsRequest { } export namespace ListUserPoolsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListUserPoolsRequest): any => ({ ...obj, }); @@ -8056,6 +8767,9 @@ export interface UserPoolDescriptionType { } export namespace UserPoolDescriptionType { + /** + * @internal + */ export const filterSensitiveLog = (obj: UserPoolDescriptionType): any => ({ ...obj, }); @@ -8078,6 +8792,9 @@ export interface ListUserPoolsResponse { } export namespace ListUserPoolsResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListUserPoolsResponse): any => ({ ...obj, }); @@ -8195,6 +8912,9 @@ export interface ListUsersRequest { } export namespace ListUsersRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListUsersRequest): any => ({ ...obj, }); @@ -8217,6 +8937,9 @@ export interface ListUsersResponse { } export namespace ListUsersResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListUsersResponse): any => ({ ...obj, ...(obj.Users && { Users: obj.Users.map((item) => UserType.filterSensitiveLog(item)) }), @@ -8247,6 +8970,9 @@ export interface ListUsersInGroupRequest { } export namespace ListUsersInGroupRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListUsersInGroupRequest): any => ({ ...obj, }); @@ -8266,6 +8992,9 @@ export interface ListUsersInGroupResponse { } export namespace ListUsersInGroupResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListUsersInGroupResponse): any => ({ ...obj, ...(obj.Users && { Users: obj.Users.map((item) => UserType.filterSensitiveLog(item)) }), @@ -8343,6 +9072,9 @@ export interface ResendConfirmationCodeRequest { } export namespace ResendConfirmationCodeRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ResendConfirmationCodeRequest): any => ({ ...obj, ...(obj.ClientId && { ClientId: SENSITIVE_STRING }), @@ -8364,6 +9096,9 @@ export interface ResendConfirmationCodeResponse { } export namespace ResendConfirmationCodeResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ResendConfirmationCodeResponse): any => ({ ...obj, }); @@ -8497,6 +9232,9 @@ export interface RespondToAuthChallengeRequest { } export namespace RespondToAuthChallengeRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: RespondToAuthChallengeRequest): any => ({ ...obj, ...(obj.ClientId && { ClientId: SENSITIVE_STRING }), @@ -8533,6 +9271,9 @@ export interface RespondToAuthChallengeResponse { } export namespace RespondToAuthChallengeResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: RespondToAuthChallengeResponse): any => ({ ...obj, ...(obj.AuthenticationResult && { @@ -8574,6 +9315,9 @@ export interface SetRiskConfigurationRequest { } export namespace SetRiskConfigurationRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: SetRiskConfigurationRequest): any => ({ ...obj, ...(obj.ClientId && { ClientId: SENSITIVE_STRING }), @@ -8588,6 +9332,9 @@ export interface SetRiskConfigurationResponse { } export namespace SetRiskConfigurationResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: SetRiskConfigurationResponse): any => ({ ...obj, ...(obj.RiskConfiguration && { @@ -8619,6 +9366,9 @@ export interface SetUICustomizationRequest { } export namespace SetUICustomizationRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: SetUICustomizationRequest): any => ({ ...obj, ...(obj.ClientId && { ClientId: SENSITIVE_STRING }), @@ -8633,6 +9383,9 @@ export interface SetUICustomizationResponse { } export namespace SetUICustomizationResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: SetUICustomizationResponse): any => ({ ...obj, ...(obj.UICustomization && { UICustomization: UICustomizationType.filterSensitiveLog(obj.UICustomization) }), @@ -8657,6 +9410,9 @@ export interface SetUserMFAPreferenceRequest { } export namespace SetUserMFAPreferenceRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: SetUserMFAPreferenceRequest): any => ({ ...obj, ...(obj.AccessToken && { AccessToken: SENSITIVE_STRING }), @@ -8666,6 +9422,9 @@ export namespace SetUserMFAPreferenceRequest { export interface SetUserMFAPreferenceResponse {} export namespace SetUserMFAPreferenceResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: SetUserMFAPreferenceResponse): any => ({ ...obj, }); @@ -8712,6 +9471,9 @@ export interface SetUserPoolMfaConfigRequest { } export namespace SetUserPoolMfaConfigRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: SetUserPoolMfaConfigRequest): any => ({ ...obj, }); @@ -8750,6 +9512,9 @@ export interface SetUserPoolMfaConfigResponse { } export namespace SetUserPoolMfaConfigResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: SetUserPoolMfaConfigResponse): any => ({ ...obj, }); @@ -8772,6 +9537,9 @@ export interface SetUserSettingsRequest { } export namespace SetUserSettingsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: SetUserSettingsRequest): any => ({ ...obj, ...(obj.AccessToken && { AccessToken: SENSITIVE_STRING }), @@ -8784,6 +9552,9 @@ export namespace SetUserSettingsRequest { export interface SetUserSettingsResponse {} export namespace SetUserSettingsResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: SetUserSettingsResponse): any => ({ ...obj, }); @@ -8877,6 +9648,9 @@ export interface SignUpRequest { } export namespace SignUpRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: SignUpRequest): any => ({ ...obj, ...(obj.ClientId && { ClientId: SENSITIVE_STRING }), @@ -8916,6 +9690,9 @@ export interface SignUpResponse { } export namespace SignUpResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: SignUpResponse): any => ({ ...obj, }); @@ -8937,6 +9714,9 @@ export interface StartUserImportJobRequest { } export namespace StartUserImportJobRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: StartUserImportJobRequest): any => ({ ...obj, }); @@ -8954,6 +9734,9 @@ export interface StartUserImportJobResponse { } export namespace StartUserImportJobResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: StartUserImportJobResponse): any => ({ ...obj, }); @@ -8975,6 +9758,9 @@ export interface StopUserImportJobRequest { } export namespace StopUserImportJobRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: StopUserImportJobRequest): any => ({ ...obj, }); @@ -8992,6 +9778,9 @@ export interface StopUserImportJobResponse { } export namespace StopUserImportJobResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: StopUserImportJobResponse): any => ({ ...obj, }); @@ -9010,6 +9799,9 @@ export interface TagResourceRequest { } export namespace TagResourceRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: TagResourceRequest): any => ({ ...obj, }); @@ -9018,6 +9810,9 @@ export namespace TagResourceRequest { export interface TagResourceResponse {} export namespace TagResourceResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: TagResourceResponse): any => ({ ...obj, }); diff --git a/clients/client-cognito-identity-provider/models/models_1.ts b/clients/client-cognito-identity-provider/models/models_1.ts index e1aa9746f0ce..65ad7f4f107a 100644 --- a/clients/client-cognito-identity-provider/models/models_1.ts +++ b/clients/client-cognito-identity-provider/models/models_1.ts @@ -42,6 +42,9 @@ export interface UntagResourceRequest { } export namespace UntagResourceRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: UntagResourceRequest): any => ({ ...obj, }); @@ -50,6 +53,9 @@ export namespace UntagResourceRequest { export interface UntagResourceResponse {} export namespace UntagResourceResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: UntagResourceResponse): any => ({ ...obj, }); @@ -83,6 +89,9 @@ export interface UpdateAuthEventFeedbackRequest { } export namespace UpdateAuthEventFeedbackRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateAuthEventFeedbackRequest): any => ({ ...obj, ...(obj.Username && { Username: SENSITIVE_STRING }), @@ -93,6 +102,9 @@ export namespace UpdateAuthEventFeedbackRequest { export interface UpdateAuthEventFeedbackResponse {} export namespace UpdateAuthEventFeedbackResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateAuthEventFeedbackResponse): any => ({ ...obj, }); @@ -119,6 +131,9 @@ export interface UpdateDeviceStatusRequest { } export namespace UpdateDeviceStatusRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateDeviceStatusRequest): any => ({ ...obj, ...(obj.AccessToken && { AccessToken: SENSITIVE_STRING }), @@ -131,6 +146,9 @@ export namespace UpdateDeviceStatusRequest { export interface UpdateDeviceStatusResponse {} export namespace UpdateDeviceStatusResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateDeviceStatusResponse): any => ({ ...obj, }); @@ -167,6 +185,9 @@ export interface UpdateGroupRequest { } export namespace UpdateGroupRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateGroupRequest): any => ({ ...obj, }); @@ -180,6 +201,9 @@ export interface UpdateGroupResponse { } export namespace UpdateGroupResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateGroupResponse): any => ({ ...obj, }); @@ -214,6 +238,9 @@ export interface UpdateIdentityProviderRequest { } export namespace UpdateIdentityProviderRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateIdentityProviderRequest): any => ({ ...obj, }); @@ -227,6 +254,9 @@ export interface UpdateIdentityProviderResponse { } export namespace UpdateIdentityProviderResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateIdentityProviderResponse): any => ({ ...obj, }); @@ -255,6 +285,9 @@ export interface UpdateResourceServerRequest { } export namespace UpdateResourceServerRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateResourceServerRequest): any => ({ ...obj, }); @@ -268,6 +301,9 @@ export interface UpdateResourceServerResponse { } export namespace UpdateResourceServerResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateResourceServerResponse): any => ({ ...obj, }); @@ -326,6 +362,9 @@ export interface UpdateUserAttributesRequest { } export namespace UpdateUserAttributesRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateUserAttributesRequest): any => ({ ...obj, ...(obj.UserAttributes && { @@ -348,6 +387,9 @@ export interface UpdateUserAttributesResponse { } export namespace UpdateUserAttributesResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateUserAttributesResponse): any => ({ ...obj, }); @@ -473,6 +515,9 @@ export interface UpdateUserPoolRequest { } export namespace UpdateUserPoolRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateUserPoolRequest): any => ({ ...obj, }); @@ -485,6 +530,9 @@ export namespace UpdateUserPoolRequest { export interface UpdateUserPoolResponse {} export namespace UpdateUserPoolResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateUserPoolResponse): any => ({ ...obj, }); @@ -709,6 +757,9 @@ export interface UpdateUserPoolClientRequest { } export namespace UpdateUserPoolClientRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateUserPoolClientRequest): any => ({ ...obj, ...(obj.ClientId && { ClientId: SENSITIVE_STRING }), @@ -728,6 +779,9 @@ export interface UpdateUserPoolClientResponse { } export namespace UpdateUserPoolClientResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateUserPoolClientResponse): any => ({ ...obj, ...(obj.UserPoolClient && { UserPoolClient: UserPoolClientType.filterSensitiveLog(obj.UserPoolClient) }), @@ -761,6 +815,9 @@ export interface UpdateUserPoolDomainRequest { } export namespace UpdateUserPoolDomainRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateUserPoolDomainRequest): any => ({ ...obj, }); @@ -778,6 +835,9 @@ export interface UpdateUserPoolDomainResponse { } export namespace UpdateUserPoolDomainResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateUserPoolDomainResponse): any => ({ ...obj, }); @@ -794,6 +854,9 @@ export interface EnableSoftwareTokenMFAException extends __SmithyException, $Met } export namespace EnableSoftwareTokenMFAException { + /** + * @internal + */ export const filterSensitiveLog = (obj: EnableSoftwareTokenMFAException): any => ({ ...obj, }); @@ -823,6 +886,9 @@ export interface VerifySoftwareTokenRequest { } export namespace VerifySoftwareTokenRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: VerifySoftwareTokenRequest): any => ({ ...obj, ...(obj.AccessToken && { AccessToken: SENSITIVE_STRING }), @@ -848,6 +914,9 @@ export interface VerifySoftwareTokenResponse { } export namespace VerifySoftwareTokenResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: VerifySoftwareTokenResponse): any => ({ ...obj, }); @@ -874,6 +943,9 @@ export interface VerifyUserAttributeRequest { } export namespace VerifyUserAttributeRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: VerifyUserAttributeRequest): any => ({ ...obj, ...(obj.AccessToken && { AccessToken: SENSITIVE_STRING }), @@ -887,6 +959,9 @@ export namespace VerifyUserAttributeRequest { export interface VerifyUserAttributeResponse {} export namespace VerifyUserAttributeResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: VerifyUserAttributeResponse): any => ({ ...obj, }); diff --git a/clients/client-cognito-identity/commands/CreateIdentityPoolCommand.ts b/clients/client-cognito-identity/commands/CreateIdentityPoolCommand.ts index 01f1e94a0ef4..f1ad3d83394c 100644 --- a/clients/client-cognito-identity/commands/CreateIdentityPoolCommand.ts +++ b/clients/client-cognito-identity/commands/CreateIdentityPoolCommand.ts @@ -49,6 +49,20 @@ export interface CreateIdentityPoolCommandOutput extends IdentityPool, __Metadat * * *

You must use AWS Developer credentials to call this API.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { CognitoIdentityClient, CreateIdentityPoolCommand } from "@aws-sdk/client-cognito-identity"; // ES Modules import + * // const { CognitoIdentityClient, CreateIdentityPoolCommand } = require("@aws-sdk/client-cognito-identity"); // CommonJS import + * const client = new CognitoIdentityClient(config); + * const command = new CreateIdentityPoolCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreateIdentityPoolCommandInput} for command's `input` shape. + * @see {@link CreateIdentityPoolCommandOutput} for command's `response` shape. + * @see {@link CognitoIdentityClientResolvedConfig | config} for command's `input` shape. + * */ export class CreateIdentityPoolCommand extends $Command< CreateIdentityPoolCommandInput, diff --git a/clients/client-cognito-identity/commands/DeleteIdentitiesCommand.ts b/clients/client-cognito-identity/commands/DeleteIdentitiesCommand.ts index 533bc6453a18..cc0d632bb439 100644 --- a/clients/client-cognito-identity/commands/DeleteIdentitiesCommand.ts +++ b/clients/client-cognito-identity/commands/DeleteIdentitiesCommand.ts @@ -25,6 +25,20 @@ export interface DeleteIdentitiesCommandOutput extends DeleteIdentitiesResponse, *

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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { CognitoIdentityClient, DeleteIdentitiesCommand } from "@aws-sdk/client-cognito-identity"; // ES Modules import + * // const { CognitoIdentityClient, DeleteIdentitiesCommand } = require("@aws-sdk/client-cognito-identity"); // CommonJS import + * const client = new CognitoIdentityClient(config); + * const command = new DeleteIdentitiesCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteIdentitiesCommandInput} for command's `input` shape. + * @see {@link DeleteIdentitiesCommandOutput} for command's `response` shape. + * @see {@link CognitoIdentityClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteIdentitiesCommand extends $Command< DeleteIdentitiesCommandInput, diff --git a/clients/client-cognito-identity/commands/DeleteIdentityPoolCommand.ts b/clients/client-cognito-identity/commands/DeleteIdentityPoolCommand.ts index 9ed8f938034a..94794f675abb 100644 --- a/clients/client-cognito-identity/commands/DeleteIdentityPoolCommand.ts +++ b/clients/client-cognito-identity/commands/DeleteIdentityPoolCommand.ts @@ -25,6 +25,20 @@ export interface DeleteIdentityPoolCommandOutput extends __MetadataBearer {} *

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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { CognitoIdentityClient, DeleteIdentityPoolCommand } from "@aws-sdk/client-cognito-identity"; // ES Modules import + * // const { CognitoIdentityClient, DeleteIdentityPoolCommand } = require("@aws-sdk/client-cognito-identity"); // CommonJS import + * const client = new CognitoIdentityClient(config); + * const command = new DeleteIdentityPoolCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteIdentityPoolCommandInput} for command's `input` shape. + * @see {@link DeleteIdentityPoolCommandOutput} for command's `response` shape. + * @see {@link CognitoIdentityClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteIdentityPoolCommand extends $Command< DeleteIdentityPoolCommandInput, diff --git a/clients/client-cognito-identity/commands/DescribeIdentityCommand.ts b/clients/client-cognito-identity/commands/DescribeIdentityCommand.ts index e5f6f8671b75..894a98b1a108 100644 --- a/clients/client-cognito-identity/commands/DescribeIdentityCommand.ts +++ b/clients/client-cognito-identity/commands/DescribeIdentityCommand.ts @@ -25,6 +25,20 @@ export interface DescribeIdentityCommandOutput extends IdentityDescription, __Me *

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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { CognitoIdentityClient, DescribeIdentityCommand } from "@aws-sdk/client-cognito-identity"; // ES Modules import + * // const { CognitoIdentityClient, DescribeIdentityCommand } = require("@aws-sdk/client-cognito-identity"); // CommonJS import + * const client = new CognitoIdentityClient(config); + * const command = new DescribeIdentityCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeIdentityCommandInput} for command's `input` shape. + * @see {@link DescribeIdentityCommandOutput} for command's `response` shape. + * @see {@link CognitoIdentityClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeIdentityCommand extends $Command< DescribeIdentityCommandInput, diff --git a/clients/client-cognito-identity/commands/DescribeIdentityPoolCommand.ts b/clients/client-cognito-identity/commands/DescribeIdentityPoolCommand.ts index 371d50a4c294..d14d28005e64 100644 --- a/clients/client-cognito-identity/commands/DescribeIdentityPoolCommand.ts +++ b/clients/client-cognito-identity/commands/DescribeIdentityPoolCommand.ts @@ -25,6 +25,20 @@ export interface DescribeIdentityPoolCommandOutput extends IdentityPool, __Metad *

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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { CognitoIdentityClient, DescribeIdentityPoolCommand } from "@aws-sdk/client-cognito-identity"; // ES Modules import + * // const { CognitoIdentityClient, DescribeIdentityPoolCommand } = require("@aws-sdk/client-cognito-identity"); // CommonJS import + * const client = new CognitoIdentityClient(config); + * const command = new DescribeIdentityPoolCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeIdentityPoolCommandInput} for command's `input` shape. + * @see {@link DescribeIdentityPoolCommandOutput} for command's `response` shape. + * @see {@link CognitoIdentityClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeIdentityPoolCommand extends $Command< DescribeIdentityPoolCommandInput, diff --git a/clients/client-cognito-identity/commands/GetCredentialsForIdentityCommand.ts b/clients/client-cognito-identity/commands/GetCredentialsForIdentityCommand.ts index 960a78c502b1..0ca9975ca28e 100644 --- a/clients/client-cognito-identity/commands/GetCredentialsForIdentityCommand.ts +++ b/clients/client-cognito-identity/commands/GetCredentialsForIdentityCommand.ts @@ -26,6 +26,20 @@ export interface GetCredentialsForIdentityCommandOutput extends GetCredentialsFo * 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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { CognitoIdentityClient, GetCredentialsForIdentityCommand } from "@aws-sdk/client-cognito-identity"; // ES Modules import + * // const { CognitoIdentityClient, GetCredentialsForIdentityCommand } = require("@aws-sdk/client-cognito-identity"); // CommonJS import + * const client = new CognitoIdentityClient(config); + * const command = new GetCredentialsForIdentityCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetCredentialsForIdentityCommandInput} for command's `input` shape. + * @see {@link GetCredentialsForIdentityCommandOutput} for command's `response` shape. + * @see {@link CognitoIdentityClientResolvedConfig | config} for command's `input` shape. + * */ export class GetCredentialsForIdentityCommand extends $Command< GetCredentialsForIdentityCommandInput, diff --git a/clients/client-cognito-identity/commands/GetIdCommand.ts b/clients/client-cognito-identity/commands/GetIdCommand.ts index 34d6a2c2ff7b..1c921cdcba87 100644 --- a/clients/client-cognito-identity/commands/GetIdCommand.ts +++ b/clients/client-cognito-identity/commands/GetIdCommand.ts @@ -21,6 +21,20 @@ export interface GetIdCommandOutput extends GetIdResponse, __MetadataBearer {} *

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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { CognitoIdentityClient, GetIdCommand } from "@aws-sdk/client-cognito-identity"; // ES Modules import + * // const { CognitoIdentityClient, GetIdCommand } = require("@aws-sdk/client-cognito-identity"); // CommonJS import + * const client = new CognitoIdentityClient(config); + * const command = new GetIdCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetIdCommandInput} for command's `input` shape. + * @see {@link GetIdCommandOutput} for command's `response` shape. + * @see {@link CognitoIdentityClientResolvedConfig | config} for command's `input` shape. + * */ export class GetIdCommand extends $Command { // Start section: command_properties diff --git a/clients/client-cognito-identity/commands/GetIdentityPoolRolesCommand.ts b/clients/client-cognito-identity/commands/GetIdentityPoolRolesCommand.ts index 0b0563b10e1b..81c656f434bb 100644 --- a/clients/client-cognito-identity/commands/GetIdentityPoolRolesCommand.ts +++ b/clients/client-cognito-identity/commands/GetIdentityPoolRolesCommand.ts @@ -24,6 +24,20 @@ export interface GetIdentityPoolRolesCommandOutput extends GetIdentityPoolRolesR /** *

Gets the roles for an identity pool.

*

You must use AWS Developer credentials to call this API.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { CognitoIdentityClient, GetIdentityPoolRolesCommand } from "@aws-sdk/client-cognito-identity"; // ES Modules import + * // const { CognitoIdentityClient, GetIdentityPoolRolesCommand } = require("@aws-sdk/client-cognito-identity"); // CommonJS import + * const client = new CognitoIdentityClient(config); + * const command = new GetIdentityPoolRolesCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetIdentityPoolRolesCommandInput} for command's `input` shape. + * @see {@link GetIdentityPoolRolesCommandOutput} for command's `response` shape. + * @see {@link CognitoIdentityClientResolvedConfig | config} for command's `input` shape. + * */ export class GetIdentityPoolRolesCommand extends $Command< GetIdentityPoolRolesCommandInput, diff --git a/clients/client-cognito-identity/commands/GetOpenIdTokenCommand.ts b/clients/client-cognito-identity/commands/GetOpenIdTokenCommand.ts index ea62b3966d21..9825852dc9ff 100644 --- a/clients/client-cognito-identity/commands/GetOpenIdTokenCommand.ts +++ b/clients/client-cognito-identity/commands/GetOpenIdTokenCommand.ts @@ -26,6 +26,20 @@ export interface GetOpenIdTokenCommandOutput extends GetOpenIdTokenResponse, __M * 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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { CognitoIdentityClient, GetOpenIdTokenCommand } from "@aws-sdk/client-cognito-identity"; // ES Modules import + * // const { CognitoIdentityClient, GetOpenIdTokenCommand } = require("@aws-sdk/client-cognito-identity"); // CommonJS import + * const client = new CognitoIdentityClient(config); + * const command = new GetOpenIdTokenCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetOpenIdTokenCommandInput} for command's `input` shape. + * @see {@link GetOpenIdTokenCommandOutput} for command's `response` shape. + * @see {@link CognitoIdentityClientResolvedConfig | config} for command's `input` shape. + * */ export class GetOpenIdTokenCommand extends $Command< GetOpenIdTokenCommandInput, diff --git a/clients/client-cognito-identity/commands/GetOpenIdTokenForDeveloperIdentityCommand.ts b/clients/client-cognito-identity/commands/GetOpenIdTokenForDeveloperIdentityCommand.ts index f524770e5102..5e8fc4fdd065 100644 --- a/clients/client-cognito-identity/commands/GetOpenIdTokenForDeveloperIdentityCommand.ts +++ b/clients/client-cognito-identity/commands/GetOpenIdTokenForDeveloperIdentityCommand.ts @@ -40,6 +40,20 @@ export interface GetOpenIdTokenForDeveloperIdentityCommandOutput * IdentityId. This API will create the identity in the specified * IdentityPoolId.

*

You must use AWS Developer credentials to call this API.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { CognitoIdentityClient, GetOpenIdTokenForDeveloperIdentityCommand } from "@aws-sdk/client-cognito-identity"; // ES Modules import + * // const { CognitoIdentityClient, GetOpenIdTokenForDeveloperIdentityCommand } = require("@aws-sdk/client-cognito-identity"); // CommonJS import + * const client = new CognitoIdentityClient(config); + * const command = new GetOpenIdTokenForDeveloperIdentityCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetOpenIdTokenForDeveloperIdentityCommandInput} for command's `input` shape. + * @see {@link GetOpenIdTokenForDeveloperIdentityCommandOutput} for command's `response` shape. + * @see {@link CognitoIdentityClientResolvedConfig | config} for command's `input` shape. + * */ export class GetOpenIdTokenForDeveloperIdentityCommand extends $Command< GetOpenIdTokenForDeveloperIdentityCommandInput, diff --git a/clients/client-cognito-identity/commands/GetPrincipalTagAttributeMapCommand.ts b/clients/client-cognito-identity/commands/GetPrincipalTagAttributeMapCommand.ts index 613d71e9cd60..a6280a74f662 100644 --- a/clients/client-cognito-identity/commands/GetPrincipalTagAttributeMapCommand.ts +++ b/clients/client-cognito-identity/commands/GetPrincipalTagAttributeMapCommand.ts @@ -25,6 +25,20 @@ export interface GetPrincipalTagAttributeMapCommandOutput /** *

Use GetPrincipalTagAttributeMap to list all mappings between PrincipalTags and user attributes.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { CognitoIdentityClient, GetPrincipalTagAttributeMapCommand } from "@aws-sdk/client-cognito-identity"; // ES Modules import + * // const { CognitoIdentityClient, GetPrincipalTagAttributeMapCommand } = require("@aws-sdk/client-cognito-identity"); // CommonJS import + * const client = new CognitoIdentityClient(config); + * const command = new GetPrincipalTagAttributeMapCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetPrincipalTagAttributeMapCommandInput} for command's `input` shape. + * @see {@link GetPrincipalTagAttributeMapCommandOutput} for command's `response` shape. + * @see {@link CognitoIdentityClientResolvedConfig | config} for command's `input` shape. + * */ export class GetPrincipalTagAttributeMapCommand extends $Command< GetPrincipalTagAttributeMapCommandInput, diff --git a/clients/client-cognito-identity/commands/ListIdentitiesCommand.ts b/clients/client-cognito-identity/commands/ListIdentitiesCommand.ts index 86de02500fa3..abc70e89ae54 100644 --- a/clients/client-cognito-identity/commands/ListIdentitiesCommand.ts +++ b/clients/client-cognito-identity/commands/ListIdentitiesCommand.ts @@ -24,6 +24,20 @@ export interface ListIdentitiesCommandOutput extends ListIdentitiesResponse, __M /** *

Lists the identities in an identity pool.

*

You must use AWS Developer credentials to call this API.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { CognitoIdentityClient, ListIdentitiesCommand } from "@aws-sdk/client-cognito-identity"; // ES Modules import + * // const { CognitoIdentityClient, ListIdentitiesCommand } = require("@aws-sdk/client-cognito-identity"); // CommonJS import + * const client = new CognitoIdentityClient(config); + * const command = new ListIdentitiesCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListIdentitiesCommandInput} for command's `input` shape. + * @see {@link ListIdentitiesCommandOutput} for command's `response` shape. + * @see {@link CognitoIdentityClientResolvedConfig | config} for command's `input` shape. + * */ export class ListIdentitiesCommand extends $Command< ListIdentitiesCommandInput, diff --git a/clients/client-cognito-identity/commands/ListIdentityPoolsCommand.ts b/clients/client-cognito-identity/commands/ListIdentityPoolsCommand.ts index a005e9b1433e..343738bd5348 100644 --- a/clients/client-cognito-identity/commands/ListIdentityPoolsCommand.ts +++ b/clients/client-cognito-identity/commands/ListIdentityPoolsCommand.ts @@ -24,6 +24,20 @@ export interface ListIdentityPoolsCommandOutput extends ListIdentityPoolsRespons /** *

Lists all of the Cognito identity pools registered for your account.

*

You must use AWS Developer credentials to call this API.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { CognitoIdentityClient, ListIdentityPoolsCommand } from "@aws-sdk/client-cognito-identity"; // ES Modules import + * // const { CognitoIdentityClient, ListIdentityPoolsCommand } = require("@aws-sdk/client-cognito-identity"); // CommonJS import + * const client = new CognitoIdentityClient(config); + * const command = new ListIdentityPoolsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListIdentityPoolsCommandInput} for command's `input` shape. + * @see {@link ListIdentityPoolsCommandOutput} for command's `response` shape. + * @see {@link CognitoIdentityClientResolvedConfig | config} for command's `input` shape. + * */ export class ListIdentityPoolsCommand extends $Command< ListIdentityPoolsCommandInput, diff --git a/clients/client-cognito-identity/commands/ListTagsForResourceCommand.ts b/clients/client-cognito-identity/commands/ListTagsForResourceCommand.ts index 25bbc6a8267a..d0aee9279243 100644 --- a/clients/client-cognito-identity/commands/ListTagsForResourceCommand.ts +++ b/clients/client-cognito-identity/commands/ListTagsForResourceCommand.ts @@ -26,6 +26,20 @@ export interface ListTagsForResourceCommandOutput extends ListTagsForResourceRes *

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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { CognitoIdentityClient, ListTagsForResourceCommand } from "@aws-sdk/client-cognito-identity"; // ES Modules import + * // const { CognitoIdentityClient, ListTagsForResourceCommand } = require("@aws-sdk/client-cognito-identity"); // CommonJS import + * const client = new CognitoIdentityClient(config); + * const command = new ListTagsForResourceCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListTagsForResourceCommandInput} for command's `input` shape. + * @see {@link ListTagsForResourceCommandOutput} for command's `response` shape. + * @see {@link CognitoIdentityClientResolvedConfig | config} for command's `input` shape. + * */ export class ListTagsForResourceCommand extends $Command< ListTagsForResourceCommandInput, diff --git a/clients/client-cognito-identity/commands/LookupDeveloperIdentityCommand.ts b/clients/client-cognito-identity/commands/LookupDeveloperIdentityCommand.ts index 91a10b8044a6..a2280a0be0e5 100644 --- a/clients/client-cognito-identity/commands/LookupDeveloperIdentityCommand.ts +++ b/clients/client-cognito-identity/commands/LookupDeveloperIdentityCommand.ts @@ -39,6 +39,20 @@ export interface LookupDeveloperIdentityCommandOutput extends LookupDeveloperIde * 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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { CognitoIdentityClient, LookupDeveloperIdentityCommand } from "@aws-sdk/client-cognito-identity"; // ES Modules import + * // const { CognitoIdentityClient, LookupDeveloperIdentityCommand } = require("@aws-sdk/client-cognito-identity"); // CommonJS import + * const client = new CognitoIdentityClient(config); + * const command = new LookupDeveloperIdentityCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link LookupDeveloperIdentityCommandInput} for command's `input` shape. + * @see {@link LookupDeveloperIdentityCommandOutput} for command's `response` shape. + * @see {@link CognitoIdentityClientResolvedConfig | config} for command's `input` shape. + * */ export class LookupDeveloperIdentityCommand extends $Command< LookupDeveloperIdentityCommandInput, diff --git a/clients/client-cognito-identity/commands/MergeDeveloperIdentitiesCommand.ts b/clients/client-cognito-identity/commands/MergeDeveloperIdentitiesCommand.ts index 291d0123507d..35747c5a1372 100644 --- a/clients/client-cognito-identity/commands/MergeDeveloperIdentitiesCommand.ts +++ b/clients/client-cognito-identity/commands/MergeDeveloperIdentitiesCommand.ts @@ -35,6 +35,20 @@ export interface MergeDeveloperIdentitiesCommandOutput extends MergeDeveloperIde * DestinationUserIdentifier, together should not be larger than 20. * Otherwise, an exception will be thrown.

*

You must use AWS Developer credentials to call this API.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { CognitoIdentityClient, MergeDeveloperIdentitiesCommand } from "@aws-sdk/client-cognito-identity"; // ES Modules import + * // const { CognitoIdentityClient, MergeDeveloperIdentitiesCommand } = require("@aws-sdk/client-cognito-identity"); // CommonJS import + * const client = new CognitoIdentityClient(config); + * const command = new MergeDeveloperIdentitiesCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link MergeDeveloperIdentitiesCommandInput} for command's `input` shape. + * @see {@link MergeDeveloperIdentitiesCommandOutput} for command's `response` shape. + * @see {@link CognitoIdentityClientResolvedConfig | config} for command's `input` shape. + * */ export class MergeDeveloperIdentitiesCommand extends $Command< MergeDeveloperIdentitiesCommandInput, diff --git a/clients/client-cognito-identity/commands/SetIdentityPoolRolesCommand.ts b/clients/client-cognito-identity/commands/SetIdentityPoolRolesCommand.ts index 2e57d2f68102..c9195650ed24 100644 --- a/clients/client-cognito-identity/commands/SetIdentityPoolRolesCommand.ts +++ b/clients/client-cognito-identity/commands/SetIdentityPoolRolesCommand.ts @@ -24,6 +24,20 @@ export interface SetIdentityPoolRolesCommandOutput extends __MetadataBearer {} /** *

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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { CognitoIdentityClient, SetIdentityPoolRolesCommand } from "@aws-sdk/client-cognito-identity"; // ES Modules import + * // const { CognitoIdentityClient, SetIdentityPoolRolesCommand } = require("@aws-sdk/client-cognito-identity"); // CommonJS import + * const client = new CognitoIdentityClient(config); + * const command = new SetIdentityPoolRolesCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link SetIdentityPoolRolesCommandInput} for command's `input` shape. + * @see {@link SetIdentityPoolRolesCommandOutput} for command's `response` shape. + * @see {@link CognitoIdentityClientResolvedConfig | config} for command's `input` shape. + * */ export class SetIdentityPoolRolesCommand extends $Command< SetIdentityPoolRolesCommandInput, diff --git a/clients/client-cognito-identity/commands/SetPrincipalTagAttributeMapCommand.ts b/clients/client-cognito-identity/commands/SetPrincipalTagAttributeMapCommand.ts index 81db66ed9829..93fa2fa622dc 100644 --- a/clients/client-cognito-identity/commands/SetPrincipalTagAttributeMapCommand.ts +++ b/clients/client-cognito-identity/commands/SetPrincipalTagAttributeMapCommand.ts @@ -25,6 +25,20 @@ export interface SetPrincipalTagAttributeMapCommandOutput /** *

You can use this operation to use default (username and clientID) attribute or custom attribute mappings.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { CognitoIdentityClient, SetPrincipalTagAttributeMapCommand } from "@aws-sdk/client-cognito-identity"; // ES Modules import + * // const { CognitoIdentityClient, SetPrincipalTagAttributeMapCommand } = require("@aws-sdk/client-cognito-identity"); // CommonJS import + * const client = new CognitoIdentityClient(config); + * const command = new SetPrincipalTagAttributeMapCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link SetPrincipalTagAttributeMapCommandInput} for command's `input` shape. + * @see {@link SetPrincipalTagAttributeMapCommandOutput} for command's `response` shape. + * @see {@link CognitoIdentityClientResolvedConfig | config} for command's `input` shape. + * */ export class SetPrincipalTagAttributeMapCommand extends $Command< SetPrincipalTagAttributeMapCommandInput, diff --git a/clients/client-cognito-identity/commands/TagResourceCommand.ts b/clients/client-cognito-identity/commands/TagResourceCommand.ts index 7f35cbaff2a1..74a367de3435 100644 --- a/clients/client-cognito-identity/commands/TagResourceCommand.ts +++ b/clients/client-cognito-identity/commands/TagResourceCommand.ts @@ -37,6 +37,20 @@ export interface TagResourceCommandOutput extends TagResourceResponse, __Metadat * 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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { CognitoIdentityClient, TagResourceCommand } from "@aws-sdk/client-cognito-identity"; // ES Modules import + * // const { CognitoIdentityClient, TagResourceCommand } = require("@aws-sdk/client-cognito-identity"); // CommonJS import + * const client = new CognitoIdentityClient(config); + * const command = new TagResourceCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link TagResourceCommandInput} for command's `input` shape. + * @see {@link TagResourceCommandOutput} for command's `response` shape. + * @see {@link CognitoIdentityClientResolvedConfig | config} for command's `input` shape. + * */ export class TagResourceCommand extends $Command< TagResourceCommandInput, diff --git a/clients/client-cognito-identity/commands/UnlinkDeveloperIdentityCommand.ts b/clients/client-cognito-identity/commands/UnlinkDeveloperIdentityCommand.ts index 9cfc9fd06084..9b0277371e06 100644 --- a/clients/client-cognito-identity/commands/UnlinkDeveloperIdentityCommand.ts +++ b/clients/client-cognito-identity/commands/UnlinkDeveloperIdentityCommand.ts @@ -27,6 +27,20 @@ export interface UnlinkDeveloperIdentityCommandOutput extends __MetadataBearer { * 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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { CognitoIdentityClient, UnlinkDeveloperIdentityCommand } from "@aws-sdk/client-cognito-identity"; // ES Modules import + * // const { CognitoIdentityClient, UnlinkDeveloperIdentityCommand } = require("@aws-sdk/client-cognito-identity"); // CommonJS import + * const client = new CognitoIdentityClient(config); + * const command = new UnlinkDeveloperIdentityCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link UnlinkDeveloperIdentityCommandInput} for command's `input` shape. + * @see {@link UnlinkDeveloperIdentityCommandOutput} for command's `response` shape. + * @see {@link CognitoIdentityClientResolvedConfig | config} for command's `input` shape. + * */ export class UnlinkDeveloperIdentityCommand extends $Command< UnlinkDeveloperIdentityCommandInput, diff --git a/clients/client-cognito-identity/commands/UnlinkIdentityCommand.ts b/clients/client-cognito-identity/commands/UnlinkIdentityCommand.ts index d72c966fb778..3de4bf239ada 100644 --- a/clients/client-cognito-identity/commands/UnlinkIdentityCommand.ts +++ b/clients/client-cognito-identity/commands/UnlinkIdentityCommand.ts @@ -25,6 +25,20 @@ export interface UnlinkIdentityCommandOutput extends __MetadataBearer {} * 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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { CognitoIdentityClient, UnlinkIdentityCommand } from "@aws-sdk/client-cognito-identity"; // ES Modules import + * // const { CognitoIdentityClient, UnlinkIdentityCommand } = require("@aws-sdk/client-cognito-identity"); // CommonJS import + * const client = new CognitoIdentityClient(config); + * const command = new UnlinkIdentityCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link UnlinkIdentityCommandInput} for command's `input` shape. + * @see {@link UnlinkIdentityCommandOutput} for command's `response` shape. + * @see {@link CognitoIdentityClientResolvedConfig | config} for command's `input` shape. + * */ export class UnlinkIdentityCommand extends $Command< UnlinkIdentityCommandInput, diff --git a/clients/client-cognito-identity/commands/UntagResourceCommand.ts b/clients/client-cognito-identity/commands/UntagResourceCommand.ts index a4d53deeda06..5ef433252286 100644 --- a/clients/client-cognito-identity/commands/UntagResourceCommand.ts +++ b/clients/client-cognito-identity/commands/UntagResourceCommand.ts @@ -24,6 +24,20 @@ export interface UntagResourceCommandOutput extends UntagResourceResponse, __Met /** *

Removes the specified tags from the specified Amazon Cognito identity pool. You can use * this action up to 5 times per second, per account

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { CognitoIdentityClient, UntagResourceCommand } from "@aws-sdk/client-cognito-identity"; // ES Modules import + * // const { CognitoIdentityClient, UntagResourceCommand } = require("@aws-sdk/client-cognito-identity"); // CommonJS import + * const client = new CognitoIdentityClient(config); + * const command = new UntagResourceCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link UntagResourceCommandInput} for command's `input` shape. + * @see {@link UntagResourceCommandOutput} for command's `response` shape. + * @see {@link CognitoIdentityClientResolvedConfig | config} for command's `input` shape. + * */ export class UntagResourceCommand extends $Command< UntagResourceCommandInput, diff --git a/clients/client-cognito-identity/commands/UpdateIdentityPoolCommand.ts b/clients/client-cognito-identity/commands/UpdateIdentityPoolCommand.ts index 2642d7c42655..266887ce7c0e 100644 --- a/clients/client-cognito-identity/commands/UpdateIdentityPoolCommand.ts +++ b/clients/client-cognito-identity/commands/UpdateIdentityPoolCommand.ts @@ -24,6 +24,20 @@ export interface UpdateIdentityPoolCommandOutput extends IdentityPool, __Metadat /** *

Updates an identity pool.

*

You must use AWS Developer credentials to call this API.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { CognitoIdentityClient, UpdateIdentityPoolCommand } from "@aws-sdk/client-cognito-identity"; // ES Modules import + * // const { CognitoIdentityClient, UpdateIdentityPoolCommand } = require("@aws-sdk/client-cognito-identity"); // CommonJS import + * const client = new CognitoIdentityClient(config); + * const command = new UpdateIdentityPoolCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link UpdateIdentityPoolCommandInput} for command's `input` shape. + * @see {@link UpdateIdentityPoolCommandOutput} for command's `response` shape. + * @see {@link CognitoIdentityClientResolvedConfig | config} for command's `input` shape. + * */ export class UpdateIdentityPoolCommand extends $Command< UpdateIdentityPoolCommandInput, diff --git a/clients/client-cognito-identity/models/models_0.ts b/clients/client-cognito-identity/models/models_0.ts index 87b97771038e..e0b2c2b6279b 100644 --- a/clients/client-cognito-identity/models/models_0.ts +++ b/clients/client-cognito-identity/models/models_0.ts @@ -35,6 +35,9 @@ export interface CognitoIdentityProvider { } export namespace CognitoIdentityProvider { + /** + * @internal + */ export const filterSensitiveLog = (obj: CognitoIdentityProvider): any => ({ ...obj, }); @@ -101,6 +104,9 @@ export interface CreateIdentityPoolInput { } export namespace CreateIdentityPoolInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateIdentityPoolInput): any => ({ ...obj, }); @@ -166,6 +172,9 @@ export interface IdentityPool { } export namespace IdentityPool { + /** + * @internal + */ export const filterSensitiveLog = (obj: IdentityPool): any => ({ ...obj, }); @@ -184,6 +193,9 @@ export interface InternalErrorException extends __SmithyException, $MetadataBear } export namespace InternalErrorException { + /** + * @internal + */ export const filterSensitiveLog = (obj: InternalErrorException): any => ({ ...obj, }); @@ -202,6 +214,9 @@ export interface InvalidParameterException extends __SmithyException, $MetadataB } export namespace InvalidParameterException { + /** + * @internal + */ export const filterSensitiveLog = (obj: InvalidParameterException): any => ({ ...obj, }); @@ -220,6 +235,9 @@ export interface LimitExceededException extends __SmithyException, $MetadataBear } export namespace LimitExceededException { + /** + * @internal + */ export const filterSensitiveLog = (obj: LimitExceededException): any => ({ ...obj, }); @@ -238,6 +256,9 @@ export interface NotAuthorizedException extends __SmithyException, $MetadataBear } export namespace NotAuthorizedException { + /** + * @internal + */ export const filterSensitiveLog = (obj: NotAuthorizedException): any => ({ ...obj, }); @@ -257,6 +278,9 @@ export interface ResourceConflictException extends __SmithyException, $MetadataB } export namespace ResourceConflictException { + /** + * @internal + */ export const filterSensitiveLog = (obj: ResourceConflictException): any => ({ ...obj, }); @@ -275,6 +299,9 @@ export interface TooManyRequestsException extends __SmithyException, $MetadataBe } export namespace TooManyRequestsException { + /** + * @internal + */ export const filterSensitiveLog = (obj: TooManyRequestsException): any => ({ ...obj, }); @@ -291,6 +318,9 @@ export interface DeleteIdentitiesInput { } export namespace DeleteIdentitiesInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteIdentitiesInput): any => ({ ...obj, }); @@ -318,6 +348,9 @@ export interface UnprocessedIdentityId { } export namespace UnprocessedIdentityId { + /** + * @internal + */ export const filterSensitiveLog = (obj: UnprocessedIdentityId): any => ({ ...obj, }); @@ -336,6 +369,9 @@ export interface DeleteIdentitiesResponse { } export namespace DeleteIdentitiesResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteIdentitiesResponse): any => ({ ...obj, }); @@ -352,6 +388,9 @@ export interface DeleteIdentityPoolInput { } export namespace DeleteIdentityPoolInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteIdentityPoolInput): any => ({ ...obj, }); @@ -371,6 +410,9 @@ export interface ResourceNotFoundException extends __SmithyException, $MetadataB } export namespace ResourceNotFoundException { + /** + * @internal + */ export const filterSensitiveLog = (obj: ResourceNotFoundException): any => ({ ...obj, }); @@ -387,6 +429,9 @@ export interface DescribeIdentityInput { } export namespace DescribeIdentityInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeIdentityInput): any => ({ ...obj, }); @@ -418,6 +463,9 @@ export interface IdentityDescription { } export namespace IdentityDescription { + /** + * @internal + */ export const filterSensitiveLog = (obj: IdentityDescription): any => ({ ...obj, }); @@ -434,6 +482,9 @@ export interface DescribeIdentityPoolInput { } export namespace DescribeIdentityPoolInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeIdentityPoolInput): any => ({ ...obj, }); @@ -453,6 +504,9 @@ export interface ExternalServiceException extends __SmithyException, $MetadataBe } export namespace ExternalServiceException { + /** + * @internal + */ export const filterSensitiveLog = (obj: ExternalServiceException): any => ({ ...obj, }); @@ -490,6 +544,9 @@ export interface GetCredentialsForIdentityInput { } export namespace GetCredentialsForIdentityInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetCredentialsForIdentityInput): any => ({ ...obj, }); @@ -521,6 +578,9 @@ export interface Credentials { } export namespace Credentials { + /** + * @internal + */ export const filterSensitiveLog = (obj: Credentials): any => ({ ...obj, }); @@ -543,6 +603,9 @@ export interface GetCredentialsForIdentityResponse { } export namespace GetCredentialsForIdentityResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetCredentialsForIdentityResponse): any => ({ ...obj, }); @@ -563,6 +626,9 @@ export interface InvalidIdentityPoolConfigurationException extends __SmithyExcep } export namespace InvalidIdentityPoolConfigurationException { + /** + * @internal + */ export const filterSensitiveLog = (obj: InvalidIdentityPoolConfigurationException): any => ({ ...obj, }); @@ -618,6 +684,9 @@ export interface GetIdInput { } export namespace GetIdInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetIdInput): any => ({ ...obj, }); @@ -634,6 +703,9 @@ export interface GetIdResponse { } export namespace GetIdResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetIdResponse): any => ({ ...obj, }); @@ -650,6 +722,9 @@ export interface GetIdentityPoolRolesInput { } export namespace GetIdentityPoolRolesInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetIdentityPoolRolesInput): any => ({ ...obj, }); @@ -691,6 +766,9 @@ export interface MappingRule { } export namespace MappingRule { + /** + * @internal + */ export const filterSensitiveLog = (obj: MappingRule): any => ({ ...obj, }); @@ -708,6 +786,9 @@ export interface RulesConfigurationType { } export namespace RulesConfigurationType { + /** + * @internal + */ export const filterSensitiveLog = (obj: RulesConfigurationType): any => ({ ...obj, }); @@ -749,6 +830,9 @@ export interface RoleMapping { } export namespace RoleMapping { + /** + * @internal + */ export const filterSensitiveLog = (obj: RoleMapping): any => ({ ...obj, }); @@ -780,6 +864,9 @@ export interface GetIdentityPoolRolesResponse { } export namespace GetIdentityPoolRolesResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetIdentityPoolRolesResponse): any => ({ ...obj, }); @@ -804,6 +891,9 @@ export interface GetOpenIdTokenInput { } export namespace GetOpenIdTokenInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetOpenIdTokenInput): any => ({ ...obj, }); @@ -826,6 +916,9 @@ export interface GetOpenIdTokenResponse { } export namespace GetOpenIdTokenResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetOpenIdTokenResponse): any => ({ ...obj, }); @@ -845,6 +938,9 @@ export interface DeveloperUserAlreadyRegisteredException extends __SmithyExcepti } export namespace DeveloperUserAlreadyRegisteredException { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeveloperUserAlreadyRegisteredException): any => ({ ...obj, }); @@ -897,6 +993,9 @@ export interface GetOpenIdTokenForDeveloperIdentityInput { } export namespace GetOpenIdTokenForDeveloperIdentityInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetOpenIdTokenForDeveloperIdentityInput): any => ({ ...obj, }); @@ -919,6 +1018,9 @@ export interface GetOpenIdTokenForDeveloperIdentityResponse { } export namespace GetOpenIdTokenForDeveloperIdentityResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetOpenIdTokenForDeveloperIdentityResponse): any => ({ ...obj, }); @@ -937,6 +1039,9 @@ export interface GetPrincipalTagAttributeMapInput { } export namespace GetPrincipalTagAttributeMapInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetPrincipalTagAttributeMapInput): any => ({ ...obj, }); @@ -965,6 +1070,9 @@ export interface GetPrincipalTagAttributeMapResponse { } export namespace GetPrincipalTagAttributeMapResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetPrincipalTagAttributeMapResponse): any => ({ ...obj, }); @@ -997,6 +1105,9 @@ export interface ListIdentitiesInput { } export namespace ListIdentitiesInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListIdentitiesInput): any => ({ ...obj, }); @@ -1023,6 +1134,9 @@ export interface ListIdentitiesResponse { } export namespace ListIdentitiesResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListIdentitiesResponse): any => ({ ...obj, }); @@ -1044,6 +1158,9 @@ export interface ListIdentityPoolsInput { } export namespace ListIdentityPoolsInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListIdentityPoolsInput): any => ({ ...obj, }); @@ -1065,6 +1182,9 @@ export interface IdentityPoolShortDescription { } export namespace IdentityPoolShortDescription { + /** + * @internal + */ export const filterSensitiveLog = (obj: IdentityPoolShortDescription): any => ({ ...obj, }); @@ -1086,6 +1206,9 @@ export interface ListIdentityPoolsResponse { } export namespace ListIdentityPoolsResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListIdentityPoolsResponse): any => ({ ...obj, }); @@ -1100,6 +1223,9 @@ export interface ListTagsForResourceInput { } export namespace ListTagsForResourceInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListTagsForResourceInput): any => ({ ...obj, }); @@ -1113,6 +1239,9 @@ export interface ListTagsForResourceResponse { } export namespace ListTagsForResourceResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListTagsForResourceResponse): any => ({ ...obj, }); @@ -1156,6 +1285,9 @@ export interface LookupDeveloperIdentityInput { } export namespace LookupDeveloperIdentityInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: LookupDeveloperIdentityInput): any => ({ ...obj, }); @@ -1190,6 +1322,9 @@ export interface LookupDeveloperIdentityResponse { } export namespace LookupDeveloperIdentityResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: LookupDeveloperIdentityResponse): any => ({ ...obj, }); @@ -1227,6 +1362,9 @@ export interface MergeDeveloperIdentitiesInput { } export namespace MergeDeveloperIdentitiesInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: MergeDeveloperIdentitiesInput): any => ({ ...obj, }); @@ -1244,6 +1382,9 @@ export interface MergeDeveloperIdentitiesResponse { } export namespace MergeDeveloperIdentitiesResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: MergeDeveloperIdentitiesResponse): any => ({ ...obj, }); @@ -1262,6 +1403,9 @@ export interface ConcurrentModificationException extends __SmithyException, $Met } export namespace ConcurrentModificationException { + /** + * @internal + */ export const filterSensitiveLog = (obj: ConcurrentModificationException): any => ({ ...obj, }); @@ -1293,6 +1437,9 @@ export interface SetIdentityPoolRolesInput { } export namespace SetIdentityPoolRolesInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: SetIdentityPoolRolesInput): any => ({ ...obj, }); @@ -1321,6 +1468,9 @@ export interface SetPrincipalTagAttributeMapInput { } export namespace SetPrincipalTagAttributeMapInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: SetPrincipalTagAttributeMapInput): any => ({ ...obj, }); @@ -1349,6 +1499,9 @@ export interface SetPrincipalTagAttributeMapResponse { } export namespace SetPrincipalTagAttributeMapResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: SetPrincipalTagAttributeMapResponse): any => ({ ...obj, }); @@ -1367,6 +1520,9 @@ export interface TagResourceInput { } export namespace TagResourceInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: TagResourceInput): any => ({ ...obj, }); @@ -1375,6 +1531,9 @@ export namespace TagResourceInput { export interface TagResourceResponse {} export namespace TagResourceResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: TagResourceResponse): any => ({ ...obj, }); @@ -1406,6 +1565,9 @@ export interface UnlinkDeveloperIdentityInput { } export namespace UnlinkDeveloperIdentityInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: UnlinkDeveloperIdentityInput): any => ({ ...obj, }); @@ -1433,6 +1595,9 @@ export interface UnlinkIdentityInput { } export namespace UnlinkIdentityInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: UnlinkIdentityInput): any => ({ ...obj, }); @@ -1451,6 +1616,9 @@ export interface UntagResourceInput { } export namespace UntagResourceInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: UntagResourceInput): any => ({ ...obj, }); @@ -1459,6 +1627,9 @@ export namespace UntagResourceInput { export interface UntagResourceResponse {} export namespace UntagResourceResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: UntagResourceResponse): any => ({ ...obj, }); diff --git a/clients/client-cognito-sync/commands/BulkPublishCommand.ts b/clients/client-cognito-sync/commands/BulkPublishCommand.ts index f545d6d2018b..e04976e2046e 100644 --- a/clients/client-cognito-sync/commands/BulkPublishCommand.ts +++ b/clients/client-cognito-sync/commands/BulkPublishCommand.ts @@ -22,6 +22,20 @@ export interface BulkPublishCommandOutput extends BulkPublishResponse, __Metadat /** *

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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { CognitoSyncClient, BulkPublishCommand } from "@aws-sdk/client-cognito-sync"; // ES Modules import + * // const { CognitoSyncClient, BulkPublishCommand } = require("@aws-sdk/client-cognito-sync"); // CommonJS import + * const client = new CognitoSyncClient(config); + * const command = new BulkPublishCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link BulkPublishCommandInput} for command's `input` shape. + * @see {@link BulkPublishCommandOutput} for command's `response` shape. + * @see {@link CognitoSyncClientResolvedConfig | config} for command's `input` shape. + * */ export class BulkPublishCommand extends $Command< BulkPublishCommandInput, diff --git a/clients/client-cognito-sync/commands/DeleteDatasetCommand.ts b/clients/client-cognito-sync/commands/DeleteDatasetCommand.ts index c93c61c215ec..04d507bebff4 100644 --- a/clients/client-cognito-sync/commands/DeleteDatasetCommand.ts +++ b/clients/client-cognito-sync/commands/DeleteDatasetCommand.ts @@ -26,6 +26,20 @@ export interface DeleteDatasetCommandOutput extends DeleteDatasetResponse, __Met * 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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { CognitoSyncClient, DeleteDatasetCommand } from "@aws-sdk/client-cognito-sync"; // ES Modules import + * // const { CognitoSyncClient, DeleteDatasetCommand } = require("@aws-sdk/client-cognito-sync"); // CommonJS import + * const client = new CognitoSyncClient(config); + * const command = new DeleteDatasetCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteDatasetCommandInput} for command's `input` shape. + * @see {@link DeleteDatasetCommandOutput} for command's `response` shape. + * @see {@link CognitoSyncClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteDatasetCommand extends $Command< DeleteDatasetCommandInput, diff --git a/clients/client-cognito-sync/commands/DescribeDatasetCommand.ts b/clients/client-cognito-sync/commands/DescribeDatasetCommand.ts index 6aabce1414b3..76e355312690 100644 --- a/clients/client-cognito-sync/commands/DescribeDatasetCommand.ts +++ b/clients/client-cognito-sync/commands/DescribeDatasetCommand.ts @@ -25,6 +25,20 @@ export interface DescribeDatasetCommandOutput extends DescribeDatasetResponse, _ * 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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { CognitoSyncClient, DescribeDatasetCommand } from "@aws-sdk/client-cognito-sync"; // ES Modules import + * // const { CognitoSyncClient, DescribeDatasetCommand } = require("@aws-sdk/client-cognito-sync"); // CommonJS import + * const client = new CognitoSyncClient(config); + * const command = new DescribeDatasetCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeDatasetCommandInput} for command's `input` shape. + * @see {@link DescribeDatasetCommandOutput} for command's `response` shape. + * @see {@link CognitoSyncClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeDatasetCommand extends $Command< DescribeDatasetCommandInput, diff --git a/clients/client-cognito-sync/commands/DescribeIdentityPoolUsageCommand.ts b/clients/client-cognito-sync/commands/DescribeIdentityPoolUsageCommand.ts index 9af36cb88479..5787f72bb82f 100644 --- a/clients/client-cognito-sync/commands/DescribeIdentityPoolUsageCommand.ts +++ b/clients/client-cognito-sync/commands/DescribeIdentityPoolUsageCommand.ts @@ -70,6 +70,20 @@ export interface DescribeIdentityPoolUsageCommandOutput extends DescribeIdentity * * * + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { CognitoSyncClient, DescribeIdentityPoolUsageCommand } from "@aws-sdk/client-cognito-sync"; // ES Modules import + * // const { CognitoSyncClient, DescribeIdentityPoolUsageCommand } = require("@aws-sdk/client-cognito-sync"); // CommonJS import + * const client = new CognitoSyncClient(config); + * const command = new DescribeIdentityPoolUsageCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeIdentityPoolUsageCommandInput} for command's `input` shape. + * @see {@link DescribeIdentityPoolUsageCommandOutput} for command's `response` shape. + * @see {@link CognitoSyncClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeIdentityPoolUsageCommand extends $Command< DescribeIdentityPoolUsageCommandInput, diff --git a/clients/client-cognito-sync/commands/DescribeIdentityUsageCommand.ts b/clients/client-cognito-sync/commands/DescribeIdentityUsageCommand.ts index 1cc989e57587..1150b2901746 100644 --- a/clients/client-cognito-sync/commands/DescribeIdentityUsageCommand.ts +++ b/clients/client-cognito-sync/commands/DescribeIdentityUsageCommand.ts @@ -71,6 +71,20 @@ export interface DescribeIdentityUsageCommandOutput extends DescribeIdentityUsag * * * + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { CognitoSyncClient, DescribeIdentityUsageCommand } from "@aws-sdk/client-cognito-sync"; // ES Modules import + * // const { CognitoSyncClient, DescribeIdentityUsageCommand } = require("@aws-sdk/client-cognito-sync"); // CommonJS import + * const client = new CognitoSyncClient(config); + * const command = new DescribeIdentityUsageCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeIdentityUsageCommandInput} for command's `input` shape. + * @see {@link DescribeIdentityUsageCommandOutput} for command's `response` shape. + * @see {@link CognitoSyncClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeIdentityUsageCommand extends $Command< DescribeIdentityUsageCommandInput, diff --git a/clients/client-cognito-sync/commands/GetBulkPublishDetailsCommand.ts b/clients/client-cognito-sync/commands/GetBulkPublishDetailsCommand.ts index 6129bd27d5c0..1dbb93040433 100644 --- a/clients/client-cognito-sync/commands/GetBulkPublishDetailsCommand.ts +++ b/clients/client-cognito-sync/commands/GetBulkPublishDetailsCommand.ts @@ -22,6 +22,20 @@ export interface GetBulkPublishDetailsCommandOutput extends GetBulkPublishDetail /** *

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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { CognitoSyncClient, GetBulkPublishDetailsCommand } from "@aws-sdk/client-cognito-sync"; // ES Modules import + * // const { CognitoSyncClient, GetBulkPublishDetailsCommand } = require("@aws-sdk/client-cognito-sync"); // CommonJS import + * const client = new CognitoSyncClient(config); + * const command = new GetBulkPublishDetailsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetBulkPublishDetailsCommandInput} for command's `input` shape. + * @see {@link GetBulkPublishDetailsCommandOutput} for command's `response` shape. + * @see {@link CognitoSyncClientResolvedConfig | config} for command's `input` shape. + * */ export class GetBulkPublishDetailsCommand extends $Command< GetBulkPublishDetailsCommandInput, diff --git a/clients/client-cognito-sync/commands/GetCognitoEventsCommand.ts b/clients/client-cognito-sync/commands/GetCognitoEventsCommand.ts index 1bc0ccac0904..357de785f4c5 100644 --- a/clients/client-cognito-sync/commands/GetCognitoEventsCommand.ts +++ b/clients/client-cognito-sync/commands/GetCognitoEventsCommand.ts @@ -22,6 +22,20 @@ export interface GetCognitoEventsCommandOutput extends GetCognitoEventsResponse, /** *

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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { CognitoSyncClient, GetCognitoEventsCommand } from "@aws-sdk/client-cognito-sync"; // ES Modules import + * // const { CognitoSyncClient, GetCognitoEventsCommand } = require("@aws-sdk/client-cognito-sync"); // CommonJS import + * const client = new CognitoSyncClient(config); + * const command = new GetCognitoEventsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetCognitoEventsCommandInput} for command's `input` shape. + * @see {@link GetCognitoEventsCommandOutput} for command's `response` shape. + * @see {@link CognitoSyncClientResolvedConfig | config} for command's `input` shape. + * */ export class GetCognitoEventsCommand extends $Command< GetCognitoEventsCommandInput, diff --git a/clients/client-cognito-sync/commands/GetIdentityPoolConfigurationCommand.ts b/clients/client-cognito-sync/commands/GetIdentityPoolConfigurationCommand.ts index e973ed1d3709..cade1177fec2 100644 --- a/clients/client-cognito-sync/commands/GetIdentityPoolConfigurationCommand.ts +++ b/clients/client-cognito-sync/commands/GetIdentityPoolConfigurationCommand.ts @@ -70,6 +70,20 @@ export interface GetIdentityPoolConfigurationCommandOutput * * * + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { CognitoSyncClient, GetIdentityPoolConfigurationCommand } from "@aws-sdk/client-cognito-sync"; // ES Modules import + * // const { CognitoSyncClient, GetIdentityPoolConfigurationCommand } = require("@aws-sdk/client-cognito-sync"); // CommonJS import + * const client = new CognitoSyncClient(config); + * const command = new GetIdentityPoolConfigurationCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetIdentityPoolConfigurationCommandInput} for command's `input` shape. + * @see {@link GetIdentityPoolConfigurationCommandOutput} for command's `response` shape. + * @see {@link CognitoSyncClientResolvedConfig | config} for command's `input` shape. + * */ export class GetIdentityPoolConfigurationCommand extends $Command< GetIdentityPoolConfigurationCommandInput, diff --git a/clients/client-cognito-sync/commands/ListDatasetsCommand.ts b/clients/client-cognito-sync/commands/ListDatasetsCommand.ts index a00e1a74604c..edecf745b304 100644 --- a/clients/client-cognito-sync/commands/ListDatasetsCommand.ts +++ b/clients/client-cognito-sync/commands/ListDatasetsCommand.ts @@ -80,6 +80,20 @@ export interface ListDatasetsCommandOutput extends ListDatasetsResponse, __Metad * * * + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { CognitoSyncClient, ListDatasetsCommand } from "@aws-sdk/client-cognito-sync"; // ES Modules import + * // const { CognitoSyncClient, ListDatasetsCommand } = require("@aws-sdk/client-cognito-sync"); // CommonJS import + * const client = new CognitoSyncClient(config); + * const command = new ListDatasetsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListDatasetsCommandInput} for command's `input` shape. + * @see {@link ListDatasetsCommandOutput} for command's `response` shape. + * @see {@link CognitoSyncClientResolvedConfig | config} for command's `input` shape. + * */ export class ListDatasetsCommand extends $Command< ListDatasetsCommandInput, diff --git a/clients/client-cognito-sync/commands/ListIdentityPoolUsageCommand.ts b/clients/client-cognito-sync/commands/ListIdentityPoolUsageCommand.ts index beab254f1c14..b34122a9fdba 100644 --- a/clients/client-cognito-sync/commands/ListIdentityPoolUsageCommand.ts +++ b/clients/client-cognito-sync/commands/ListIdentityPoolUsageCommand.ts @@ -80,6 +80,20 @@ export interface ListIdentityPoolUsageCommandOutput extends ListIdentityPoolUsag * * * + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { CognitoSyncClient, ListIdentityPoolUsageCommand } from "@aws-sdk/client-cognito-sync"; // ES Modules import + * // const { CognitoSyncClient, ListIdentityPoolUsageCommand } = require("@aws-sdk/client-cognito-sync"); // CommonJS import + * const client = new CognitoSyncClient(config); + * const command = new ListIdentityPoolUsageCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListIdentityPoolUsageCommandInput} for command's `input` shape. + * @see {@link ListIdentityPoolUsageCommandOutput} for command's `response` shape. + * @see {@link CognitoSyncClientResolvedConfig | config} for command's `input` shape. + * */ export class ListIdentityPoolUsageCommand extends $Command< ListIdentityPoolUsageCommandInput, diff --git a/clients/client-cognito-sync/commands/ListRecordsCommand.ts b/clients/client-cognito-sync/commands/ListRecordsCommand.ts index 7396966279ab..c9f873a7db40 100644 --- a/clients/client-cognito-sync/commands/ListRecordsCommand.ts +++ b/clients/client-cognito-sync/commands/ListRecordsCommand.ts @@ -77,6 +77,20 @@ export interface ListRecordsCommandOutput extends ListRecordsResponse, __Metadat * * * + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { CognitoSyncClient, ListRecordsCommand } from "@aws-sdk/client-cognito-sync"; // ES Modules import + * // const { CognitoSyncClient, ListRecordsCommand } = require("@aws-sdk/client-cognito-sync"); // CommonJS import + * const client = new CognitoSyncClient(config); + * const command = new ListRecordsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListRecordsCommandInput} for command's `input` shape. + * @see {@link ListRecordsCommandOutput} for command's `response` shape. + * @see {@link CognitoSyncClientResolvedConfig | config} for command's `input` shape. + * */ export class ListRecordsCommand extends $Command< ListRecordsCommandInput, diff --git a/clients/client-cognito-sync/commands/RegisterDeviceCommand.ts b/clients/client-cognito-sync/commands/RegisterDeviceCommand.ts index baa7444ed4f5..d4d7fb89b844 100644 --- a/clients/client-cognito-sync/commands/RegisterDeviceCommand.ts +++ b/clients/client-cognito-sync/commands/RegisterDeviceCommand.ts @@ -66,6 +66,20 @@ export interface RegisterDeviceCommandOutput extends RegisterDeviceResponse, __M * * * + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { CognitoSyncClient, RegisterDeviceCommand } from "@aws-sdk/client-cognito-sync"; // ES Modules import + * // const { CognitoSyncClient, RegisterDeviceCommand } = require("@aws-sdk/client-cognito-sync"); // CommonJS import + * const client = new CognitoSyncClient(config); + * const command = new RegisterDeviceCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link RegisterDeviceCommandInput} for command's `input` shape. + * @see {@link RegisterDeviceCommandOutput} for command's `response` shape. + * @see {@link CognitoSyncClientResolvedConfig | config} for command's `input` shape. + * */ export class RegisterDeviceCommand extends $Command< RegisterDeviceCommandInput, diff --git a/clients/client-cognito-sync/commands/SetCognitoEventsCommand.ts b/clients/client-cognito-sync/commands/SetCognitoEventsCommand.ts index 23d4aca25272..88d0805963af 100644 --- a/clients/client-cognito-sync/commands/SetCognitoEventsCommand.ts +++ b/clients/client-cognito-sync/commands/SetCognitoEventsCommand.ts @@ -22,6 +22,20 @@ export interface SetCognitoEventsCommandOutput extends __MetadataBearer {} /** *

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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { CognitoSyncClient, SetCognitoEventsCommand } from "@aws-sdk/client-cognito-sync"; // ES Modules import + * // const { CognitoSyncClient, SetCognitoEventsCommand } = require("@aws-sdk/client-cognito-sync"); // CommonJS import + * const client = new CognitoSyncClient(config); + * const command = new SetCognitoEventsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link SetCognitoEventsCommandInput} for command's `input` shape. + * @see {@link SetCognitoEventsCommandOutput} for command's `response` shape. + * @see {@link CognitoSyncClientResolvedConfig | config} for command's `input` shape. + * */ export class SetCognitoEventsCommand extends $Command< SetCognitoEventsCommandInput, diff --git a/clients/client-cognito-sync/commands/SetIdentityPoolConfigurationCommand.ts b/clients/client-cognito-sync/commands/SetIdentityPoolConfigurationCommand.ts index 82b13176bb4c..54009667c7d5 100644 --- a/clients/client-cognito-sync/commands/SetIdentityPoolConfigurationCommand.ts +++ b/clients/client-cognito-sync/commands/SetIdentityPoolConfigurationCommand.ts @@ -74,6 +74,20 @@ export interface SetIdentityPoolConfigurationCommandOutput * * * + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { CognitoSyncClient, SetIdentityPoolConfigurationCommand } from "@aws-sdk/client-cognito-sync"; // ES Modules import + * // const { CognitoSyncClient, SetIdentityPoolConfigurationCommand } = require("@aws-sdk/client-cognito-sync"); // CommonJS import + * const client = new CognitoSyncClient(config); + * const command = new SetIdentityPoolConfigurationCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link SetIdentityPoolConfigurationCommandInput} for command's `input` shape. + * @see {@link SetIdentityPoolConfigurationCommandOutput} for command's `response` shape. + * @see {@link CognitoSyncClientResolvedConfig | config} for command's `input` shape. + * */ export class SetIdentityPoolConfigurationCommand extends $Command< SetIdentityPoolConfigurationCommandInput, diff --git a/clients/client-cognito-sync/commands/SubscribeToDatasetCommand.ts b/clients/client-cognito-sync/commands/SubscribeToDatasetCommand.ts index 323647e7d23f..06d145ebc8be 100644 --- a/clients/client-cognito-sync/commands/SubscribeToDatasetCommand.ts +++ b/clients/client-cognito-sync/commands/SubscribeToDatasetCommand.ts @@ -65,6 +65,20 @@ export interface SubscribeToDatasetCommandOutput extends SubscribeToDatasetRespo * * * + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { CognitoSyncClient, SubscribeToDatasetCommand } from "@aws-sdk/client-cognito-sync"; // ES Modules import + * // const { CognitoSyncClient, SubscribeToDatasetCommand } = require("@aws-sdk/client-cognito-sync"); // CommonJS import + * const client = new CognitoSyncClient(config); + * const command = new SubscribeToDatasetCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link SubscribeToDatasetCommandInput} for command's `input` shape. + * @see {@link SubscribeToDatasetCommandOutput} for command's `response` shape. + * @see {@link CognitoSyncClientResolvedConfig | config} for command's `input` shape. + * */ export class SubscribeToDatasetCommand extends $Command< SubscribeToDatasetCommandInput, diff --git a/clients/client-cognito-sync/commands/UnsubscribeFromDatasetCommand.ts b/clients/client-cognito-sync/commands/UnsubscribeFromDatasetCommand.ts index 977374d2ac2a..bc10eb3cd151 100644 --- a/clients/client-cognito-sync/commands/UnsubscribeFromDatasetCommand.ts +++ b/clients/client-cognito-sync/commands/UnsubscribeFromDatasetCommand.ts @@ -66,6 +66,20 @@ export interface UnsubscribeFromDatasetCommandOutput extends UnsubscribeFromData * * * + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { CognitoSyncClient, UnsubscribeFromDatasetCommand } from "@aws-sdk/client-cognito-sync"; // ES Modules import + * // const { CognitoSyncClient, UnsubscribeFromDatasetCommand } = require("@aws-sdk/client-cognito-sync"); // CommonJS import + * const client = new CognitoSyncClient(config); + * const command = new UnsubscribeFromDatasetCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link UnsubscribeFromDatasetCommandInput} for command's `input` shape. + * @see {@link UnsubscribeFromDatasetCommandOutput} for command's `response` shape. + * @see {@link CognitoSyncClientResolvedConfig | config} for command's `input` shape. + * */ export class UnsubscribeFromDatasetCommand extends $Command< UnsubscribeFromDatasetCommandInput, diff --git a/clients/client-cognito-sync/commands/UpdateRecordsCommand.ts b/clients/client-cognito-sync/commands/UpdateRecordsCommand.ts index 12dd519988a5..90ac1aaa212c 100644 --- a/clients/client-cognito-sync/commands/UpdateRecordsCommand.ts +++ b/clients/client-cognito-sync/commands/UpdateRecordsCommand.ts @@ -24,6 +24,20 @@ export interface UpdateRecordsCommandOutput extends UpdateRecordsResponse, __Met *

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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { CognitoSyncClient, UpdateRecordsCommand } from "@aws-sdk/client-cognito-sync"; // ES Modules import + * // const { CognitoSyncClient, UpdateRecordsCommand } = require("@aws-sdk/client-cognito-sync"); // CommonJS import + * const client = new CognitoSyncClient(config); + * const command = new UpdateRecordsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link UpdateRecordsCommandInput} for command's `input` shape. + * @see {@link UpdateRecordsCommandOutput} for command's `response` shape. + * @see {@link CognitoSyncClientResolvedConfig | config} for command's `input` shape. + * */ export class UpdateRecordsCommand extends $Command< UpdateRecordsCommandInput, diff --git a/clients/client-cognito-sync/models/models_0.ts b/clients/client-cognito-sync/models/models_0.ts index 04916f3904e3..fe8862396ea7 100644 --- a/clients/client-cognito-sync/models/models_0.ts +++ b/clients/client-cognito-sync/models/models_0.ts @@ -14,6 +14,9 @@ export interface AlreadyStreamedException extends __SmithyException, $MetadataBe } export namespace AlreadyStreamedException { + /** + * @internal + */ export const filterSensitiveLog = (obj: AlreadyStreamedException): any => ({ ...obj, }); @@ -32,6 +35,9 @@ export interface BulkPublishRequest { } export namespace BulkPublishRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: BulkPublishRequest): any => ({ ...obj, }); @@ -50,6 +56,9 @@ export interface BulkPublishResponse { } export namespace BulkPublishResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: BulkPublishResponse): any => ({ ...obj, }); @@ -68,6 +77,9 @@ export interface DuplicateRequestException extends __SmithyException, $MetadataB } export namespace DuplicateRequestException { + /** + * @internal + */ export const filterSensitiveLog = (obj: DuplicateRequestException): any => ({ ...obj, }); @@ -88,6 +100,9 @@ export interface InternalErrorException extends __SmithyException, $MetadataBear } export namespace InternalErrorException { + /** + * @internal + */ export const filterSensitiveLog = (obj: InternalErrorException): any => ({ ...obj, }); @@ -108,6 +123,9 @@ export interface InvalidParameterException extends __SmithyException, $MetadataB } export namespace InvalidParameterException { + /** + * @internal + */ export const filterSensitiveLog = (obj: InvalidParameterException): any => ({ ...obj, }); @@ -128,6 +146,9 @@ export interface NotAuthorizedException extends __SmithyException, $MetadataBear } export namespace NotAuthorizedException { + /** + * @internal + */ export const filterSensitiveLog = (obj: NotAuthorizedException): any => ({ ...obj, }); @@ -148,6 +169,9 @@ export interface ResourceNotFoundException extends __SmithyException, $MetadataB } export namespace ResourceNotFoundException { + /** + * @internal + */ export const filterSensitiveLog = (obj: ResourceNotFoundException): any => ({ ...obj, }); @@ -181,6 +205,9 @@ export interface DeleteDatasetRequest { } export namespace DeleteDatasetRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteDatasetRequest): any => ({ ...obj, }); @@ -238,6 +265,9 @@ export interface Dataset { } export namespace Dataset { + /** + * @internal + */ export const filterSensitiveLog = (obj: Dataset): any => ({ ...obj, }); @@ -259,6 +289,9 @@ export interface DeleteDatasetResponse { } export namespace DeleteDatasetResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteDatasetResponse): any => ({ ...obj, }); @@ -279,6 +312,9 @@ export interface ResourceConflictException extends __SmithyException, $MetadataB } export namespace ResourceConflictException { + /** + * @internal + */ export const filterSensitiveLog = (obj: ResourceConflictException): any => ({ ...obj, }); @@ -299,6 +335,9 @@ export interface TooManyRequestsException extends __SmithyException, $MetadataBe } export namespace TooManyRequestsException { + /** + * @internal + */ export const filterSensitiveLog = (obj: TooManyRequestsException): any => ({ ...obj, }); @@ -332,6 +371,9 @@ export interface DescribeDatasetRequest { } export namespace DescribeDatasetRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeDatasetRequest): any => ({ ...obj, }); @@ -353,6 +395,9 @@ export interface DescribeDatasetResponse { } export namespace DescribeDatasetResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeDatasetResponse): any => ({ ...obj, }); @@ -372,6 +417,9 @@ export interface DescribeIdentityPoolUsageRequest { } export namespace DescribeIdentityPoolUsageRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeIdentityPoolUsageRequest): any => ({ ...obj, }); @@ -409,6 +457,9 @@ export interface IdentityPoolUsage { } export namespace IdentityPoolUsage { + /** + * @internal + */ export const filterSensitiveLog = (obj: IdentityPoolUsage): any => ({ ...obj, }); @@ -427,6 +478,9 @@ export interface DescribeIdentityPoolUsageResponse { } export namespace DescribeIdentityPoolUsageResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeIdentityPoolUsageResponse): any => ({ ...obj, }); @@ -453,6 +507,9 @@ export interface DescribeIdentityUsageRequest { } export namespace DescribeIdentityUsageRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeIdentityUsageRequest): any => ({ ...obj, }); @@ -496,6 +553,9 @@ export interface IdentityUsage { } export namespace IdentityUsage { + /** + * @internal + */ export const filterSensitiveLog = (obj: IdentityUsage): any => ({ ...obj, }); @@ -514,6 +574,9 @@ export interface DescribeIdentityUsageResponse { } export namespace DescribeIdentityUsageResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeIdentityUsageResponse): any => ({ ...obj, }); @@ -532,6 +595,9 @@ export interface GetBulkPublishDetailsRequest { } export namespace GetBulkPublishDetailsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetBulkPublishDetailsRequest): any => ({ ...obj, }); @@ -581,6 +647,9 @@ export interface GetBulkPublishDetailsResponse { } export namespace GetBulkPublishDetailsResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetBulkPublishDetailsResponse): any => ({ ...obj, }); @@ -597,6 +666,9 @@ export interface GetCognitoEventsRequest { } export namespace GetCognitoEventsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetCognitoEventsRequest): any => ({ ...obj, }); @@ -613,6 +685,9 @@ export interface GetCognitoEventsResponse { } export namespace GetCognitoEventsResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetCognitoEventsResponse): any => ({ ...obj, }); @@ -630,6 +705,9 @@ export interface GetIdentityPoolConfigurationRequest { } export namespace GetIdentityPoolConfigurationRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetIdentityPoolConfigurationRequest): any => ({ ...obj, }); @@ -660,6 +738,9 @@ export interface CognitoStreams { } export namespace CognitoStreams { + /** + * @internal + */ export const filterSensitiveLog = (obj: CognitoStreams): any => ({ ...obj, }); @@ -681,6 +762,9 @@ export interface PushSync { } export namespace PushSync { + /** + * @internal + */ export const filterSensitiveLog = (obj: PushSync): any => ({ ...obj, }); @@ -708,6 +792,9 @@ export interface GetIdentityPoolConfigurationResponse { } export namespace GetIdentityPoolConfigurationResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetIdentityPoolConfigurationResponse): any => ({ ...obj, }); @@ -746,6 +833,9 @@ export interface ListDatasetsRequest { } export namespace ListDatasetsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListDatasetsRequest): any => ({ ...obj, }); @@ -774,6 +864,9 @@ export interface ListDatasetsResponse { } export namespace ListDatasetsResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListDatasetsResponse): any => ({ ...obj, }); @@ -798,6 +891,9 @@ export interface ListIdentityPoolUsageRequest { } export namespace ListIdentityPoolUsageRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListIdentityPoolUsageRequest): any => ({ ...obj, }); @@ -834,6 +930,9 @@ export interface ListIdentityPoolUsageResponse { } export namespace ListIdentityPoolUsageResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListIdentityPoolUsageResponse): any => ({ ...obj, }); @@ -889,6 +988,9 @@ export interface ListRecordsRequest { } export namespace ListRecordsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListRecordsRequest): any => ({ ...obj, }); @@ -933,6 +1035,9 @@ export interface _Record { } export namespace _Record { + /** + * @internal + */ export const filterSensitiveLog = (obj: _Record): any => ({ ...obj, }); @@ -997,6 +1102,9 @@ export interface ListRecordsResponse { } export namespace ListRecordsResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListRecordsResponse): any => ({ ...obj, }); @@ -1013,6 +1121,9 @@ export interface InvalidConfigurationException extends __SmithyException, $Metad } export namespace InvalidConfigurationException { + /** + * @internal + */ export const filterSensitiveLog = (obj: InvalidConfigurationException): any => ({ ...obj, }); @@ -1047,6 +1158,9 @@ export interface RegisterDeviceRequest { } export namespace RegisterDeviceRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: RegisterDeviceRequest): any => ({ ...obj, }); @@ -1063,6 +1177,9 @@ export interface RegisterDeviceResponse { } export namespace RegisterDeviceResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: RegisterDeviceResponse): any => ({ ...obj, }); @@ -1084,6 +1201,9 @@ export interface SetCognitoEventsRequest { } export namespace SetCognitoEventsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: SetCognitoEventsRequest): any => ({ ...obj, }); @@ -1102,6 +1222,9 @@ export interface ConcurrentModificationException extends __SmithyException, $Met } export namespace ConcurrentModificationException { + /** + * @internal + */ export const filterSensitiveLog = (obj: ConcurrentModificationException): any => ({ ...obj, }); @@ -1129,6 +1252,9 @@ export interface SetIdentityPoolConfigurationRequest { } export namespace SetIdentityPoolConfigurationRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: SetIdentityPoolConfigurationRequest): any => ({ ...obj, }); @@ -1156,6 +1282,9 @@ export interface SetIdentityPoolConfigurationResponse { } export namespace SetIdentityPoolConfigurationResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: SetIdentityPoolConfigurationResponse): any => ({ ...obj, }); @@ -1188,6 +1317,9 @@ export interface SubscribeToDatasetRequest { } export namespace SubscribeToDatasetRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: SubscribeToDatasetRequest): any => ({ ...obj, }); @@ -1199,6 +1331,9 @@ export namespace SubscribeToDatasetRequest { export interface SubscribeToDatasetResponse {} export namespace SubscribeToDatasetResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: SubscribeToDatasetResponse): any => ({ ...obj, }); @@ -1231,6 +1366,9 @@ export interface UnsubscribeFromDatasetRequest { } export namespace UnsubscribeFromDatasetRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: UnsubscribeFromDatasetRequest): any => ({ ...obj, }); @@ -1242,6 +1380,9 @@ export namespace UnsubscribeFromDatasetRequest { export interface UnsubscribeFromDatasetResponse {} export namespace UnsubscribeFromDatasetResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: UnsubscribeFromDatasetResponse): any => ({ ...obj, }); @@ -1260,6 +1401,9 @@ export interface InvalidLambdaFunctionOutputException extends __SmithyException, } export namespace InvalidLambdaFunctionOutputException { + /** + * @internal + */ export const filterSensitiveLog = (obj: InvalidLambdaFunctionOutputException): any => ({ ...obj, }); @@ -1278,6 +1422,9 @@ export interface LambdaThrottledException extends __SmithyException, $MetadataBe } export namespace LambdaThrottledException { + /** + * @internal + */ export const filterSensitiveLog = (obj: LambdaThrottledException): any => ({ ...obj, }); @@ -1298,6 +1445,9 @@ export interface LimitExceededException extends __SmithyException, $MetadataBear } export namespace LimitExceededException { + /** + * @internal + */ export const filterSensitiveLog = (obj: LimitExceededException): any => ({ ...obj, }); @@ -1339,6 +1489,9 @@ export interface RecordPatch { } export namespace RecordPatch { + /** + * @internal + */ export const filterSensitiveLog = (obj: RecordPatch): any => ({ ...obj, }); @@ -1396,6 +1549,9 @@ export interface UpdateRecordsRequest { } export namespace UpdateRecordsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateRecordsRequest): any => ({ ...obj, }); @@ -1414,6 +1570,9 @@ export interface UpdateRecordsResponse { } export namespace UpdateRecordsResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateRecordsResponse): any => ({ ...obj, }); diff --git a/clients/client-comprehend/commands/BatchDetectDominantLanguageCommand.ts b/clients/client-comprehend/commands/BatchDetectDominantLanguageCommand.ts index 355e9633221f..465fb2638f43 100644 --- a/clients/client-comprehend/commands/BatchDetectDominantLanguageCommand.ts +++ b/clients/client-comprehend/commands/BatchDetectDominantLanguageCommand.ts @@ -26,6 +26,20 @@ export interface BatchDetectDominantLanguageCommandOutput *

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. *

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ComprehendClient, BatchDetectDominantLanguageCommand } from "@aws-sdk/client-comprehend"; // ES Modules import + * // const { ComprehendClient, BatchDetectDominantLanguageCommand } = require("@aws-sdk/client-comprehend"); // CommonJS import + * const client = new ComprehendClient(config); + * const command = new BatchDetectDominantLanguageCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link BatchDetectDominantLanguageCommandInput} for command's `input` shape. + * @see {@link BatchDetectDominantLanguageCommandOutput} for command's `response` shape. + * @see {@link ComprehendClientResolvedConfig | config} for command's `input` shape. + * */ export class BatchDetectDominantLanguageCommand extends $Command< BatchDetectDominantLanguageCommandInput, diff --git a/clients/client-comprehend/commands/BatchDetectEntitiesCommand.ts b/clients/client-comprehend/commands/BatchDetectEntitiesCommand.ts index 78313fb4e676..25501b1e506b 100644 --- a/clients/client-comprehend/commands/BatchDetectEntitiesCommand.ts +++ b/clients/client-comprehend/commands/BatchDetectEntitiesCommand.ts @@ -24,6 +24,20 @@ export interface BatchDetectEntitiesCommandOutput extends BatchDetectEntitiesRes *

Inspects the text of a batch of documents for named entities and returns information * about them. For more information about named entities, see how-entities *

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ComprehendClient, BatchDetectEntitiesCommand } from "@aws-sdk/client-comprehend"; // ES Modules import + * // const { ComprehendClient, BatchDetectEntitiesCommand } = require("@aws-sdk/client-comprehend"); // CommonJS import + * const client = new ComprehendClient(config); + * const command = new BatchDetectEntitiesCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link BatchDetectEntitiesCommandInput} for command's `input` shape. + * @see {@link BatchDetectEntitiesCommandOutput} for command's `response` shape. + * @see {@link ComprehendClientResolvedConfig | config} for command's `input` shape. + * */ export class BatchDetectEntitiesCommand extends $Command< BatchDetectEntitiesCommandInput, diff --git a/clients/client-comprehend/commands/BatchDetectKeyPhrasesCommand.ts b/clients/client-comprehend/commands/BatchDetectKeyPhrasesCommand.ts index f0151b6112da..2dd3cff62e03 100644 --- a/clients/client-comprehend/commands/BatchDetectKeyPhrasesCommand.ts +++ b/clients/client-comprehend/commands/BatchDetectKeyPhrasesCommand.ts @@ -22,6 +22,20 @@ export interface BatchDetectKeyPhrasesCommandOutput extends BatchDetectKeyPhrase /** *

Detects the key noun phrases found in a batch of documents.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ComprehendClient, BatchDetectKeyPhrasesCommand } from "@aws-sdk/client-comprehend"; // ES Modules import + * // const { ComprehendClient, BatchDetectKeyPhrasesCommand } = require("@aws-sdk/client-comprehend"); // CommonJS import + * const client = new ComprehendClient(config); + * const command = new BatchDetectKeyPhrasesCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link BatchDetectKeyPhrasesCommandInput} for command's `input` shape. + * @see {@link BatchDetectKeyPhrasesCommandOutput} for command's `response` shape. + * @see {@link ComprehendClientResolvedConfig | config} for command's `input` shape. + * */ export class BatchDetectKeyPhrasesCommand extends $Command< BatchDetectKeyPhrasesCommandInput, diff --git a/clients/client-comprehend/commands/BatchDetectSentimentCommand.ts b/clients/client-comprehend/commands/BatchDetectSentimentCommand.ts index bf4434f04124..3530455b9368 100644 --- a/clients/client-comprehend/commands/BatchDetectSentimentCommand.ts +++ b/clients/client-comprehend/commands/BatchDetectSentimentCommand.ts @@ -24,6 +24,20 @@ export interface BatchDetectSentimentCommandOutput extends BatchDetectSentimentR *

Inspects a batch of documents and returns an inference of the prevailing sentiment, * POSITIVE, NEUTRAL, MIXED, or NEGATIVE, * in each one.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ComprehendClient, BatchDetectSentimentCommand } from "@aws-sdk/client-comprehend"; // ES Modules import + * // const { ComprehendClient, BatchDetectSentimentCommand } = require("@aws-sdk/client-comprehend"); // CommonJS import + * const client = new ComprehendClient(config); + * const command = new BatchDetectSentimentCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link BatchDetectSentimentCommandInput} for command's `input` shape. + * @see {@link BatchDetectSentimentCommandOutput} for command's `response` shape. + * @see {@link ComprehendClientResolvedConfig | config} for command's `input` shape. + * */ export class BatchDetectSentimentCommand extends $Command< BatchDetectSentimentCommandInput, diff --git a/clients/client-comprehend/commands/BatchDetectSyntaxCommand.ts b/clients/client-comprehend/commands/BatchDetectSyntaxCommand.ts index 9b4a3a28ace8..4cd340890b83 100644 --- a/clients/client-comprehend/commands/BatchDetectSyntaxCommand.ts +++ b/clients/client-comprehend/commands/BatchDetectSyntaxCommand.ts @@ -23,6 +23,20 @@ export interface BatchDetectSyntaxCommandOutput extends BatchDetectSyntaxRespons /** *

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 how-syntax.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ComprehendClient, BatchDetectSyntaxCommand } from "@aws-sdk/client-comprehend"; // ES Modules import + * // const { ComprehendClient, BatchDetectSyntaxCommand } = require("@aws-sdk/client-comprehend"); // CommonJS import + * const client = new ComprehendClient(config); + * const command = new BatchDetectSyntaxCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link BatchDetectSyntaxCommandInput} for command's `input` shape. + * @see {@link BatchDetectSyntaxCommandOutput} for command's `response` shape. + * @see {@link ComprehendClientResolvedConfig | config} for command's `input` shape. + * */ export class BatchDetectSyntaxCommand extends $Command< BatchDetectSyntaxCommandInput, diff --git a/clients/client-comprehend/commands/ClassifyDocumentCommand.ts b/clients/client-comprehend/commands/ClassifyDocumentCommand.ts index 3fb76e2b1e03..3085268137bd 100644 --- a/clients/client-comprehend/commands/ClassifyDocumentCommand.ts +++ b/clients/client-comprehend/commands/ClassifyDocumentCommand.ts @@ -23,6 +23,20 @@ export interface ClassifyDocumentCommandOutput extends ClassifyDocumentResponse, /** *

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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ComprehendClient, ClassifyDocumentCommand } from "@aws-sdk/client-comprehend"; // ES Modules import + * // const { ComprehendClient, ClassifyDocumentCommand } = require("@aws-sdk/client-comprehend"); // CommonJS import + * const client = new ComprehendClient(config); + * const command = new ClassifyDocumentCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ClassifyDocumentCommandInput} for command's `input` shape. + * @see {@link ClassifyDocumentCommandOutput} for command's `response` shape. + * @see {@link ComprehendClientResolvedConfig | config} for command's `input` shape. + * */ export class ClassifyDocumentCommand extends $Command< ClassifyDocumentCommandInput, diff --git a/clients/client-comprehend/commands/ContainsPiiEntitiesCommand.ts b/clients/client-comprehend/commands/ContainsPiiEntitiesCommand.ts index 026a84ab350f..c487a1d669fc 100644 --- a/clients/client-comprehend/commands/ContainsPiiEntitiesCommand.ts +++ b/clients/client-comprehend/commands/ContainsPiiEntitiesCommand.ts @@ -24,6 +24,20 @@ export interface ContainsPiiEntitiesCommandOutput extends ContainsPiiEntitiesRes *

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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ComprehendClient, ContainsPiiEntitiesCommand } from "@aws-sdk/client-comprehend"; // ES Modules import + * // const { ComprehendClient, ContainsPiiEntitiesCommand } = require("@aws-sdk/client-comprehend"); // CommonJS import + * const client = new ComprehendClient(config); + * const command = new ContainsPiiEntitiesCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ContainsPiiEntitiesCommandInput} for command's `input` shape. + * @see {@link ContainsPiiEntitiesCommandOutput} for command's `response` shape. + * @see {@link ComprehendClientResolvedConfig | config} for command's `input` shape. + * */ export class ContainsPiiEntitiesCommand extends $Command< ContainsPiiEntitiesCommandInput, diff --git a/clients/client-comprehend/commands/CreateDocumentClassifierCommand.ts b/clients/client-comprehend/commands/CreateDocumentClassifierCommand.ts index e02c9990f27c..bcf2a424444e 100644 --- a/clients/client-comprehend/commands/CreateDocumentClassifierCommand.ts +++ b/clients/client-comprehend/commands/CreateDocumentClassifierCommand.ts @@ -25,6 +25,20 @@ export interface CreateDocumentClassifierCommandOutput extends CreateDocumentCla * 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 how-document-classification.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ComprehendClient, CreateDocumentClassifierCommand } from "@aws-sdk/client-comprehend"; // ES Modules import + * // const { ComprehendClient, CreateDocumentClassifierCommand } = require("@aws-sdk/client-comprehend"); // CommonJS import + * const client = new ComprehendClient(config); + * const command = new CreateDocumentClassifierCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreateDocumentClassifierCommandInput} for command's `input` shape. + * @see {@link CreateDocumentClassifierCommandOutput} for command's `response` shape. + * @see {@link ComprehendClientResolvedConfig | config} for command's `input` shape. + * */ export class CreateDocumentClassifierCommand extends $Command< CreateDocumentClassifierCommandInput, diff --git a/clients/client-comprehend/commands/CreateEndpointCommand.ts b/clients/client-comprehend/commands/CreateEndpointCommand.ts index 78dc29cf5de0..b2c5002ba7b6 100644 --- a/clients/client-comprehend/commands/CreateEndpointCommand.ts +++ b/clients/client-comprehend/commands/CreateEndpointCommand.ts @@ -24,6 +24,20 @@ export interface CreateEndpointCommandOutput extends CreateEndpointResponse, __M *

Creates a model-specific endpoint for synchronous inference for a previously trained * custom model *

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ComprehendClient, CreateEndpointCommand } from "@aws-sdk/client-comprehend"; // ES Modules import + * // const { ComprehendClient, CreateEndpointCommand } = require("@aws-sdk/client-comprehend"); // CommonJS import + * const client = new ComprehendClient(config); + * const command = new CreateEndpointCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreateEndpointCommandInput} for command's `input` shape. + * @see {@link CreateEndpointCommandOutput} for command's `response` shape. + * @see {@link ComprehendClientResolvedConfig | config} for command's `input` shape. + * */ export class CreateEndpointCommand extends $Command< CreateEndpointCommandInput, diff --git a/clients/client-comprehend/commands/CreateEntityRecognizerCommand.ts b/clients/client-comprehend/commands/CreateEntityRecognizerCommand.ts index d03ac79182e0..985a8bd9df4c 100644 --- a/clients/client-comprehend/commands/CreateEntityRecognizerCommand.ts +++ b/clients/client-comprehend/commands/CreateEntityRecognizerCommand.ts @@ -24,6 +24,20 @@ export interface CreateEntityRecognizerCommandOutput extends CreateEntityRecogni *

Creates an entity recognizer using submitted files. After your * CreateEntityRecognizer request is submitted, you can check job status using the * API.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ComprehendClient, CreateEntityRecognizerCommand } from "@aws-sdk/client-comprehend"; // ES Modules import + * // const { ComprehendClient, CreateEntityRecognizerCommand } = require("@aws-sdk/client-comprehend"); // CommonJS import + * const client = new ComprehendClient(config); + * const command = new CreateEntityRecognizerCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreateEntityRecognizerCommandInput} for command's `input` shape. + * @see {@link CreateEntityRecognizerCommandOutput} for command's `response` shape. + * @see {@link ComprehendClientResolvedConfig | config} for command's `input` shape. + * */ export class CreateEntityRecognizerCommand extends $Command< CreateEntityRecognizerCommandInput, diff --git a/clients/client-comprehend/commands/DeleteDocumentClassifierCommand.ts b/clients/client-comprehend/commands/DeleteDocumentClassifierCommand.ts index c90658cb0bc7..8f301df9b2ae 100644 --- a/clients/client-comprehend/commands/DeleteDocumentClassifierCommand.ts +++ b/clients/client-comprehend/commands/DeleteDocumentClassifierCommand.ts @@ -28,6 +28,20 @@ export interface DeleteDocumentClassifierCommandOutput extends DeleteDocumentCla *

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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ComprehendClient, DeleteDocumentClassifierCommand } from "@aws-sdk/client-comprehend"; // ES Modules import + * // const { ComprehendClient, DeleteDocumentClassifierCommand } = require("@aws-sdk/client-comprehend"); // CommonJS import + * const client = new ComprehendClient(config); + * const command = new DeleteDocumentClassifierCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteDocumentClassifierCommandInput} for command's `input` shape. + * @see {@link DeleteDocumentClassifierCommandOutput} for command's `response` shape. + * @see {@link ComprehendClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteDocumentClassifierCommand extends $Command< DeleteDocumentClassifierCommandInput, diff --git a/clients/client-comprehend/commands/DeleteEndpointCommand.ts b/clients/client-comprehend/commands/DeleteEndpointCommand.ts index 7b2cc5a4ddc4..bc7594cece0f 100644 --- a/clients/client-comprehend/commands/DeleteEndpointCommand.ts +++ b/clients/client-comprehend/commands/DeleteEndpointCommand.ts @@ -23,6 +23,20 @@ export interface DeleteEndpointCommandOutput extends DeleteEndpointResponse, __M /** *

Deletes a model-specific endpoint for a previously-trained custom model. All endpoints * must be deleted in order for the model to be deleted.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ComprehendClient, DeleteEndpointCommand } from "@aws-sdk/client-comprehend"; // ES Modules import + * // const { ComprehendClient, DeleteEndpointCommand } = require("@aws-sdk/client-comprehend"); // CommonJS import + * const client = new ComprehendClient(config); + * const command = new DeleteEndpointCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteEndpointCommandInput} for command's `input` shape. + * @see {@link DeleteEndpointCommandOutput} for command's `response` shape. + * @see {@link ComprehendClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteEndpointCommand extends $Command< DeleteEndpointCommandInput, diff --git a/clients/client-comprehend/commands/DeleteEntityRecognizerCommand.ts b/clients/client-comprehend/commands/DeleteEntityRecognizerCommand.ts index 08e3a74686ec..879959df4295 100644 --- a/clients/client-comprehend/commands/DeleteEntityRecognizerCommand.ts +++ b/clients/client-comprehend/commands/DeleteEntityRecognizerCommand.ts @@ -28,6 +28,20 @@ export interface DeleteEntityRecognizerCommandOutput extends DeleteEntityRecogni *

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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ComprehendClient, DeleteEntityRecognizerCommand } from "@aws-sdk/client-comprehend"; // ES Modules import + * // const { ComprehendClient, DeleteEntityRecognizerCommand } = require("@aws-sdk/client-comprehend"); // CommonJS import + * const client = new ComprehendClient(config); + * const command = new DeleteEntityRecognizerCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteEntityRecognizerCommandInput} for command's `input` shape. + * @see {@link DeleteEntityRecognizerCommandOutput} for command's `response` shape. + * @see {@link ComprehendClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteEntityRecognizerCommand extends $Command< DeleteEntityRecognizerCommandInput, diff --git a/clients/client-comprehend/commands/DescribeDocumentClassificationJobCommand.ts b/clients/client-comprehend/commands/DescribeDocumentClassificationJobCommand.ts index e4b5e0f4e223..7073dce2c8fb 100644 --- a/clients/client-comprehend/commands/DescribeDocumentClassificationJobCommand.ts +++ b/clients/client-comprehend/commands/DescribeDocumentClassificationJobCommand.ts @@ -28,6 +28,20 @@ export interface DescribeDocumentClassificationJobCommandOutput /** *

Gets the properties associated with a document classification job. Use this operation to * get the status of a classification job.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ComprehendClient, DescribeDocumentClassificationJobCommand } from "@aws-sdk/client-comprehend"; // ES Modules import + * // const { ComprehendClient, DescribeDocumentClassificationJobCommand } = require("@aws-sdk/client-comprehend"); // CommonJS import + * const client = new ComprehendClient(config); + * const command = new DescribeDocumentClassificationJobCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeDocumentClassificationJobCommandInput} for command's `input` shape. + * @see {@link DescribeDocumentClassificationJobCommandOutput} for command's `response` shape. + * @see {@link ComprehendClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeDocumentClassificationJobCommand extends $Command< DescribeDocumentClassificationJobCommandInput, diff --git a/clients/client-comprehend/commands/DescribeDocumentClassifierCommand.ts b/clients/client-comprehend/commands/DescribeDocumentClassifierCommand.ts index 21a90780bbb8..c4bcaf868bb2 100644 --- a/clients/client-comprehend/commands/DescribeDocumentClassifierCommand.ts +++ b/clients/client-comprehend/commands/DescribeDocumentClassifierCommand.ts @@ -22,6 +22,20 @@ export interface DescribeDocumentClassifierCommandOutput extends DescribeDocumen /** *

Gets the properties associated with a document classifier.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ComprehendClient, DescribeDocumentClassifierCommand } from "@aws-sdk/client-comprehend"; // ES Modules import + * // const { ComprehendClient, DescribeDocumentClassifierCommand } = require("@aws-sdk/client-comprehend"); // CommonJS import + * const client = new ComprehendClient(config); + * const command = new DescribeDocumentClassifierCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeDocumentClassifierCommandInput} for command's `input` shape. + * @see {@link DescribeDocumentClassifierCommandOutput} for command's `response` shape. + * @see {@link ComprehendClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeDocumentClassifierCommand extends $Command< DescribeDocumentClassifierCommandInput, diff --git a/clients/client-comprehend/commands/DescribeDominantLanguageDetectionJobCommand.ts b/clients/client-comprehend/commands/DescribeDominantLanguageDetectionJobCommand.ts index 2dd0ea11b5bb..6a4ded0f29dd 100644 --- a/clients/client-comprehend/commands/DescribeDominantLanguageDetectionJobCommand.ts +++ b/clients/client-comprehend/commands/DescribeDominantLanguageDetectionJobCommand.ts @@ -28,6 +28,20 @@ export interface DescribeDominantLanguageDetectionJobCommandOutput /** *

Gets the properties associated with a dominant language detection job. Use this operation * to get the status of a detection job.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ComprehendClient, DescribeDominantLanguageDetectionJobCommand } from "@aws-sdk/client-comprehend"; // ES Modules import + * // const { ComprehendClient, DescribeDominantLanguageDetectionJobCommand } = require("@aws-sdk/client-comprehend"); // CommonJS import + * const client = new ComprehendClient(config); + * const command = new DescribeDominantLanguageDetectionJobCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeDominantLanguageDetectionJobCommandInput} for command's `input` shape. + * @see {@link DescribeDominantLanguageDetectionJobCommandOutput} for command's `response` shape. + * @see {@link ComprehendClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeDominantLanguageDetectionJobCommand extends $Command< DescribeDominantLanguageDetectionJobCommandInput, diff --git a/clients/client-comprehend/commands/DescribeEndpointCommand.ts b/clients/client-comprehend/commands/DescribeEndpointCommand.ts index 31ce232cc40d..3805703d5dca 100644 --- a/clients/client-comprehend/commands/DescribeEndpointCommand.ts +++ b/clients/client-comprehend/commands/DescribeEndpointCommand.ts @@ -23,6 +23,20 @@ export interface DescribeEndpointCommandOutput extends DescribeEndpointResponse, /** *

Gets the properties associated with a specific endpoint. Use this operation to get the * status of an endpoint.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ComprehendClient, DescribeEndpointCommand } from "@aws-sdk/client-comprehend"; // ES Modules import + * // const { ComprehendClient, DescribeEndpointCommand } = require("@aws-sdk/client-comprehend"); // CommonJS import + * const client = new ComprehendClient(config); + * const command = new DescribeEndpointCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeEndpointCommandInput} for command's `input` shape. + * @see {@link DescribeEndpointCommandOutput} for command's `response` shape. + * @see {@link ComprehendClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeEndpointCommand extends $Command< DescribeEndpointCommandInput, diff --git a/clients/client-comprehend/commands/DescribeEntitiesDetectionJobCommand.ts b/clients/client-comprehend/commands/DescribeEntitiesDetectionJobCommand.ts index ef5d3191fa88..25172e967930 100644 --- a/clients/client-comprehend/commands/DescribeEntitiesDetectionJobCommand.ts +++ b/clients/client-comprehend/commands/DescribeEntitiesDetectionJobCommand.ts @@ -25,6 +25,20 @@ export interface DescribeEntitiesDetectionJobCommandOutput /** *

Gets the properties associated with an entities detection job. Use this operation to get * the status of a detection job.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ComprehendClient, DescribeEntitiesDetectionJobCommand } from "@aws-sdk/client-comprehend"; // ES Modules import + * // const { ComprehendClient, DescribeEntitiesDetectionJobCommand } = require("@aws-sdk/client-comprehend"); // CommonJS import + * const client = new ComprehendClient(config); + * const command = new DescribeEntitiesDetectionJobCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeEntitiesDetectionJobCommandInput} for command's `input` shape. + * @see {@link DescribeEntitiesDetectionJobCommandOutput} for command's `response` shape. + * @see {@link ComprehendClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeEntitiesDetectionJobCommand extends $Command< DescribeEntitiesDetectionJobCommandInput, diff --git a/clients/client-comprehend/commands/DescribeEntityRecognizerCommand.ts b/clients/client-comprehend/commands/DescribeEntityRecognizerCommand.ts index b6137c1c7089..9c4f482a99ba 100644 --- a/clients/client-comprehend/commands/DescribeEntityRecognizerCommand.ts +++ b/clients/client-comprehend/commands/DescribeEntityRecognizerCommand.ts @@ -23,6 +23,20 @@ export interface DescribeEntityRecognizerCommandOutput extends DescribeEntityRec /** *

Provides details about an entity recognizer including status, S3 buckets containing * training data, recognizer metadata, metrics, and so on.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ComprehendClient, DescribeEntityRecognizerCommand } from "@aws-sdk/client-comprehend"; // ES Modules import + * // const { ComprehendClient, DescribeEntityRecognizerCommand } = require("@aws-sdk/client-comprehend"); // CommonJS import + * const client = new ComprehendClient(config); + * const command = new DescribeEntityRecognizerCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeEntityRecognizerCommandInput} for command's `input` shape. + * @see {@link DescribeEntityRecognizerCommandOutput} for command's `response` shape. + * @see {@link ComprehendClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeEntityRecognizerCommand extends $Command< DescribeEntityRecognizerCommandInput, diff --git a/clients/client-comprehend/commands/DescribeEventsDetectionJobCommand.ts b/clients/client-comprehend/commands/DescribeEventsDetectionJobCommand.ts index 752327421927..f34c3a29b723 100644 --- a/clients/client-comprehend/commands/DescribeEventsDetectionJobCommand.ts +++ b/clients/client-comprehend/commands/DescribeEventsDetectionJobCommand.ts @@ -22,6 +22,20 @@ export interface DescribeEventsDetectionJobCommandOutput extends DescribeEventsD /** *

Gets the status and details of an events detection job.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ComprehendClient, DescribeEventsDetectionJobCommand } from "@aws-sdk/client-comprehend"; // ES Modules import + * // const { ComprehendClient, DescribeEventsDetectionJobCommand } = require("@aws-sdk/client-comprehend"); // CommonJS import + * const client = new ComprehendClient(config); + * const command = new DescribeEventsDetectionJobCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeEventsDetectionJobCommandInput} for command's `input` shape. + * @see {@link DescribeEventsDetectionJobCommandOutput} for command's `response` shape. + * @see {@link ComprehendClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeEventsDetectionJobCommand extends $Command< DescribeEventsDetectionJobCommandInput, diff --git a/clients/client-comprehend/commands/DescribeKeyPhrasesDetectionJobCommand.ts b/clients/client-comprehend/commands/DescribeKeyPhrasesDetectionJobCommand.ts index 35ea59a505ac..22c2c38cc9ac 100644 --- a/clients/client-comprehend/commands/DescribeKeyPhrasesDetectionJobCommand.ts +++ b/clients/client-comprehend/commands/DescribeKeyPhrasesDetectionJobCommand.ts @@ -25,6 +25,20 @@ export interface DescribeKeyPhrasesDetectionJobCommandOutput /** *

Gets the properties associated with a key phrases detection job. Use this operation to get * the status of a detection job.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ComprehendClient, DescribeKeyPhrasesDetectionJobCommand } from "@aws-sdk/client-comprehend"; // ES Modules import + * // const { ComprehendClient, DescribeKeyPhrasesDetectionJobCommand } = require("@aws-sdk/client-comprehend"); // CommonJS import + * const client = new ComprehendClient(config); + * const command = new DescribeKeyPhrasesDetectionJobCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeKeyPhrasesDetectionJobCommandInput} for command's `input` shape. + * @see {@link DescribeKeyPhrasesDetectionJobCommandOutput} for command's `response` shape. + * @see {@link ComprehendClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeKeyPhrasesDetectionJobCommand extends $Command< DescribeKeyPhrasesDetectionJobCommandInput, diff --git a/clients/client-comprehend/commands/DescribePiiEntitiesDetectionJobCommand.ts b/clients/client-comprehend/commands/DescribePiiEntitiesDetectionJobCommand.ts index d51c10eaec6d..8eee680e379f 100644 --- a/clients/client-comprehend/commands/DescribePiiEntitiesDetectionJobCommand.ts +++ b/clients/client-comprehend/commands/DescribePiiEntitiesDetectionJobCommand.ts @@ -25,6 +25,20 @@ export interface DescribePiiEntitiesDetectionJobCommandOutput /** *

Gets the properties associated with a PII entities detection job. For example, you can use * this operation to get the job status.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ComprehendClient, DescribePiiEntitiesDetectionJobCommand } from "@aws-sdk/client-comprehend"; // ES Modules import + * // const { ComprehendClient, DescribePiiEntitiesDetectionJobCommand } = require("@aws-sdk/client-comprehend"); // CommonJS import + * const client = new ComprehendClient(config); + * const command = new DescribePiiEntitiesDetectionJobCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribePiiEntitiesDetectionJobCommandInput} for command's `input` shape. + * @see {@link DescribePiiEntitiesDetectionJobCommandOutput} for command's `response` shape. + * @see {@link ComprehendClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribePiiEntitiesDetectionJobCommand extends $Command< DescribePiiEntitiesDetectionJobCommandInput, diff --git a/clients/client-comprehend/commands/DescribeSentimentDetectionJobCommand.ts b/clients/client-comprehend/commands/DescribeSentimentDetectionJobCommand.ts index 7ce0c54c2680..df97f3be7205 100644 --- a/clients/client-comprehend/commands/DescribeSentimentDetectionJobCommand.ts +++ b/clients/client-comprehend/commands/DescribeSentimentDetectionJobCommand.ts @@ -25,6 +25,20 @@ export interface DescribeSentimentDetectionJobCommandOutput /** *

Gets the properties associated with a sentiment detection job. Use this operation to get * the status of a detection job.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ComprehendClient, DescribeSentimentDetectionJobCommand } from "@aws-sdk/client-comprehend"; // ES Modules import + * // const { ComprehendClient, DescribeSentimentDetectionJobCommand } = require("@aws-sdk/client-comprehend"); // CommonJS import + * const client = new ComprehendClient(config); + * const command = new DescribeSentimentDetectionJobCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeSentimentDetectionJobCommandInput} for command's `input` shape. + * @see {@link DescribeSentimentDetectionJobCommandOutput} for command's `response` shape. + * @see {@link ComprehendClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeSentimentDetectionJobCommand extends $Command< DescribeSentimentDetectionJobCommandInput, diff --git a/clients/client-comprehend/commands/DescribeTopicsDetectionJobCommand.ts b/clients/client-comprehend/commands/DescribeTopicsDetectionJobCommand.ts index d64d37be682d..3716a69bd4d2 100644 --- a/clients/client-comprehend/commands/DescribeTopicsDetectionJobCommand.ts +++ b/clients/client-comprehend/commands/DescribeTopicsDetectionJobCommand.ts @@ -23,6 +23,20 @@ export interface DescribeTopicsDetectionJobCommandOutput extends DescribeTopicsD /** *

Gets the properties associated with a topic detection job. Use this operation to get * the status of a detection job.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ComprehendClient, DescribeTopicsDetectionJobCommand } from "@aws-sdk/client-comprehend"; // ES Modules import + * // const { ComprehendClient, DescribeTopicsDetectionJobCommand } = require("@aws-sdk/client-comprehend"); // CommonJS import + * const client = new ComprehendClient(config); + * const command = new DescribeTopicsDetectionJobCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeTopicsDetectionJobCommandInput} for command's `input` shape. + * @see {@link DescribeTopicsDetectionJobCommandOutput} for command's `response` shape. + * @see {@link ComprehendClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeTopicsDetectionJobCommand extends $Command< DescribeTopicsDetectionJobCommandInput, diff --git a/clients/client-comprehend/commands/DetectDominantLanguageCommand.ts b/clients/client-comprehend/commands/DetectDominantLanguageCommand.ts index 3a7d9526f648..468190b9d723 100644 --- a/clients/client-comprehend/commands/DetectDominantLanguageCommand.ts +++ b/clients/client-comprehend/commands/DetectDominantLanguageCommand.ts @@ -23,6 +23,20 @@ export interface DetectDominantLanguageCommandOutput extends DetectDominantLangu /** *

Determines the dominant language of the input text. For a list of languages that Amazon * Comprehend can detect, see Amazon Comprehend Supported Languages.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ComprehendClient, DetectDominantLanguageCommand } from "@aws-sdk/client-comprehend"; // ES Modules import + * // const { ComprehendClient, DetectDominantLanguageCommand } = require("@aws-sdk/client-comprehend"); // CommonJS import + * const client = new ComprehendClient(config); + * const command = new DetectDominantLanguageCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DetectDominantLanguageCommandInput} for command's `input` shape. + * @see {@link DetectDominantLanguageCommandOutput} for command's `response` shape. + * @see {@link ComprehendClientResolvedConfig | config} for command's `input` shape. + * */ export class DetectDominantLanguageCommand extends $Command< DetectDominantLanguageCommandInput, diff --git a/clients/client-comprehend/commands/DetectEntitiesCommand.ts b/clients/client-comprehend/commands/DetectEntitiesCommand.ts index d0f012cba4d2..d8c3eb08ae48 100644 --- a/clients/client-comprehend/commands/DetectEntitiesCommand.ts +++ b/clients/client-comprehend/commands/DetectEntitiesCommand.ts @@ -23,6 +23,20 @@ export interface DetectEntitiesCommandOutput extends DetectEntitiesResponse, __M /** *

Inspects text for named entities, and returns information about them. For more * information, about named entities, see how-entities.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ComprehendClient, DetectEntitiesCommand } from "@aws-sdk/client-comprehend"; // ES Modules import + * // const { ComprehendClient, DetectEntitiesCommand } = require("@aws-sdk/client-comprehend"); // CommonJS import + * const client = new ComprehendClient(config); + * const command = new DetectEntitiesCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DetectEntitiesCommandInput} for command's `input` shape. + * @see {@link DetectEntitiesCommandOutput} for command's `response` shape. + * @see {@link ComprehendClientResolvedConfig | config} for command's `input` shape. + * */ export class DetectEntitiesCommand extends $Command< DetectEntitiesCommandInput, diff --git a/clients/client-comprehend/commands/DetectKeyPhrasesCommand.ts b/clients/client-comprehend/commands/DetectKeyPhrasesCommand.ts index f37754bdbc48..30c64e9fadcb 100644 --- a/clients/client-comprehend/commands/DetectKeyPhrasesCommand.ts +++ b/clients/client-comprehend/commands/DetectKeyPhrasesCommand.ts @@ -22,6 +22,20 @@ export interface DetectKeyPhrasesCommandOutput extends DetectKeyPhrasesResponse, /** *

Detects the key noun phrases found in the text.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ComprehendClient, DetectKeyPhrasesCommand } from "@aws-sdk/client-comprehend"; // ES Modules import + * // const { ComprehendClient, DetectKeyPhrasesCommand } = require("@aws-sdk/client-comprehend"); // CommonJS import + * const client = new ComprehendClient(config); + * const command = new DetectKeyPhrasesCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DetectKeyPhrasesCommandInput} for command's `input` shape. + * @see {@link DetectKeyPhrasesCommandOutput} for command's `response` shape. + * @see {@link ComprehendClientResolvedConfig | config} for command's `input` shape. + * */ export class DetectKeyPhrasesCommand extends $Command< DetectKeyPhrasesCommandInput, diff --git a/clients/client-comprehend/commands/DetectPiiEntitiesCommand.ts b/clients/client-comprehend/commands/DetectPiiEntitiesCommand.ts index 98e39ce8d339..3358a54f1a87 100644 --- a/clients/client-comprehend/commands/DetectPiiEntitiesCommand.ts +++ b/clients/client-comprehend/commands/DetectPiiEntitiesCommand.ts @@ -23,6 +23,20 @@ export interface DetectPiiEntitiesCommandOutput extends DetectPiiEntitiesRespons /** *

Inspects the input text for entities that contain personally identifiable information * (PII) and returns information about them.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ComprehendClient, DetectPiiEntitiesCommand } from "@aws-sdk/client-comprehend"; // ES Modules import + * // const { ComprehendClient, DetectPiiEntitiesCommand } = require("@aws-sdk/client-comprehend"); // CommonJS import + * const client = new ComprehendClient(config); + * const command = new DetectPiiEntitiesCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DetectPiiEntitiesCommandInput} for command's `input` shape. + * @see {@link DetectPiiEntitiesCommandOutput} for command's `response` shape. + * @see {@link ComprehendClientResolvedConfig | config} for command's `input` shape. + * */ export class DetectPiiEntitiesCommand extends $Command< DetectPiiEntitiesCommandInput, diff --git a/clients/client-comprehend/commands/DetectSentimentCommand.ts b/clients/client-comprehend/commands/DetectSentimentCommand.ts index 23c76ce62917..65cb08785fca 100644 --- a/clients/client-comprehend/commands/DetectSentimentCommand.ts +++ b/clients/client-comprehend/commands/DetectSentimentCommand.ts @@ -23,6 +23,20 @@ export interface DetectSentimentCommandOutput extends DetectSentimentResponse, _ /** *

Inspects text and returns an inference of the prevailing sentiment * (POSITIVE, NEUTRAL, MIXED, or NEGATIVE).

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ComprehendClient, DetectSentimentCommand } from "@aws-sdk/client-comprehend"; // ES Modules import + * // const { ComprehendClient, DetectSentimentCommand } = require("@aws-sdk/client-comprehend"); // CommonJS import + * const client = new ComprehendClient(config); + * const command = new DetectSentimentCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DetectSentimentCommandInput} for command's `input` shape. + * @see {@link DetectSentimentCommandOutput} for command's `response` shape. + * @see {@link ComprehendClientResolvedConfig | config} for command's `input` shape. + * */ export class DetectSentimentCommand extends $Command< DetectSentimentCommandInput, diff --git a/clients/client-comprehend/commands/DetectSyntaxCommand.ts b/clients/client-comprehend/commands/DetectSyntaxCommand.ts index bf0488b21ce8..678ac9336b85 100644 --- a/clients/client-comprehend/commands/DetectSyntaxCommand.ts +++ b/clients/client-comprehend/commands/DetectSyntaxCommand.ts @@ -23,6 +23,20 @@ export interface DetectSyntaxCommandOutput extends DetectSyntaxResponse, __Metad /** *

Inspects text for syntax and the part of speech of words in the document. For more * information, how-syntax.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ComprehendClient, DetectSyntaxCommand } from "@aws-sdk/client-comprehend"; // ES Modules import + * // const { ComprehendClient, DetectSyntaxCommand } = require("@aws-sdk/client-comprehend"); // CommonJS import + * const client = new ComprehendClient(config); + * const command = new DetectSyntaxCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DetectSyntaxCommandInput} for command's `input` shape. + * @see {@link DetectSyntaxCommandOutput} for command's `response` shape. + * @see {@link ComprehendClientResolvedConfig | config} for command's `input` shape. + * */ export class DetectSyntaxCommand extends $Command< DetectSyntaxCommandInput, diff --git a/clients/client-comprehend/commands/ListDocumentClassificationJobsCommand.ts b/clients/client-comprehend/commands/ListDocumentClassificationJobsCommand.ts index 41f2792c862d..5e4c1759c449 100644 --- a/clients/client-comprehend/commands/ListDocumentClassificationJobsCommand.ts +++ b/clients/client-comprehend/commands/ListDocumentClassificationJobsCommand.ts @@ -24,6 +24,20 @@ export interface ListDocumentClassificationJobsCommandOutput /** *

Gets a list of the documentation classification jobs that you have submitted.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ComprehendClient, ListDocumentClassificationJobsCommand } from "@aws-sdk/client-comprehend"; // ES Modules import + * // const { ComprehendClient, ListDocumentClassificationJobsCommand } = require("@aws-sdk/client-comprehend"); // CommonJS import + * const client = new ComprehendClient(config); + * const command = new ListDocumentClassificationJobsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListDocumentClassificationJobsCommandInput} for command's `input` shape. + * @see {@link ListDocumentClassificationJobsCommandOutput} for command's `response` shape. + * @see {@link ComprehendClientResolvedConfig | config} for command's `input` shape. + * */ export class ListDocumentClassificationJobsCommand extends $Command< ListDocumentClassificationJobsCommandInput, diff --git a/clients/client-comprehend/commands/ListDocumentClassifiersCommand.ts b/clients/client-comprehend/commands/ListDocumentClassifiersCommand.ts index 0744d3164c37..5dd68444a0d1 100644 --- a/clients/client-comprehend/commands/ListDocumentClassifiersCommand.ts +++ b/clients/client-comprehend/commands/ListDocumentClassifiersCommand.ts @@ -22,6 +22,20 @@ export interface ListDocumentClassifiersCommandOutput extends ListDocumentClassi /** *

Gets a list of the document classifiers that you have created.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ComprehendClient, ListDocumentClassifiersCommand } from "@aws-sdk/client-comprehend"; // ES Modules import + * // const { ComprehendClient, ListDocumentClassifiersCommand } = require("@aws-sdk/client-comprehend"); // CommonJS import + * const client = new ComprehendClient(config); + * const command = new ListDocumentClassifiersCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListDocumentClassifiersCommandInput} for command's `input` shape. + * @see {@link ListDocumentClassifiersCommandOutput} for command's `response` shape. + * @see {@link ComprehendClientResolvedConfig | config} for command's `input` shape. + * */ export class ListDocumentClassifiersCommand extends $Command< ListDocumentClassifiersCommandInput, diff --git a/clients/client-comprehend/commands/ListDominantLanguageDetectionJobsCommand.ts b/clients/client-comprehend/commands/ListDominantLanguageDetectionJobsCommand.ts index 0e83c5e8f865..87e762d4e631 100644 --- a/clients/client-comprehend/commands/ListDominantLanguageDetectionJobsCommand.ts +++ b/clients/client-comprehend/commands/ListDominantLanguageDetectionJobsCommand.ts @@ -27,6 +27,20 @@ export interface ListDominantLanguageDetectionJobsCommandOutput /** *

Gets a list of the dominant language detection jobs that you have submitted.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ComprehendClient, ListDominantLanguageDetectionJobsCommand } from "@aws-sdk/client-comprehend"; // ES Modules import + * // const { ComprehendClient, ListDominantLanguageDetectionJobsCommand } = require("@aws-sdk/client-comprehend"); // CommonJS import + * const client = new ComprehendClient(config); + * const command = new ListDominantLanguageDetectionJobsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListDominantLanguageDetectionJobsCommandInput} for command's `input` shape. + * @see {@link ListDominantLanguageDetectionJobsCommandOutput} for command's `response` shape. + * @see {@link ComprehendClientResolvedConfig | config} for command's `input` shape. + * */ export class ListDominantLanguageDetectionJobsCommand extends $Command< ListDominantLanguageDetectionJobsCommandInput, diff --git a/clients/client-comprehend/commands/ListEndpointsCommand.ts b/clients/client-comprehend/commands/ListEndpointsCommand.ts index 505d295341c2..2e68a00d91aa 100644 --- a/clients/client-comprehend/commands/ListEndpointsCommand.ts +++ b/clients/client-comprehend/commands/ListEndpointsCommand.ts @@ -22,6 +22,20 @@ export interface ListEndpointsCommandOutput extends ListEndpointsResponse, __Met /** *

Gets a list of all existing endpoints that you've created.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ComprehendClient, ListEndpointsCommand } from "@aws-sdk/client-comprehend"; // ES Modules import + * // const { ComprehendClient, ListEndpointsCommand } = require("@aws-sdk/client-comprehend"); // CommonJS import + * const client = new ComprehendClient(config); + * const command = new ListEndpointsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListEndpointsCommandInput} for command's `input` shape. + * @see {@link ListEndpointsCommandOutput} for command's `response` shape. + * @see {@link ComprehendClientResolvedConfig | config} for command's `input` shape. + * */ export class ListEndpointsCommand extends $Command< ListEndpointsCommandInput, diff --git a/clients/client-comprehend/commands/ListEntitiesDetectionJobsCommand.ts b/clients/client-comprehend/commands/ListEntitiesDetectionJobsCommand.ts index c7a83f6283bb..067efa540228 100644 --- a/clients/client-comprehend/commands/ListEntitiesDetectionJobsCommand.ts +++ b/clients/client-comprehend/commands/ListEntitiesDetectionJobsCommand.ts @@ -22,6 +22,20 @@ export interface ListEntitiesDetectionJobsCommandOutput extends ListEntitiesDete /** *

Gets a list of the entity detection jobs that you have submitted.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ComprehendClient, ListEntitiesDetectionJobsCommand } from "@aws-sdk/client-comprehend"; // ES Modules import + * // const { ComprehendClient, ListEntitiesDetectionJobsCommand } = require("@aws-sdk/client-comprehend"); // CommonJS import + * const client = new ComprehendClient(config); + * const command = new ListEntitiesDetectionJobsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListEntitiesDetectionJobsCommandInput} for command's `input` shape. + * @see {@link ListEntitiesDetectionJobsCommandOutput} for command's `response` shape. + * @see {@link ComprehendClientResolvedConfig | config} for command's `input` shape. + * */ export class ListEntitiesDetectionJobsCommand extends $Command< ListEntitiesDetectionJobsCommandInput, diff --git a/clients/client-comprehend/commands/ListEntityRecognizersCommand.ts b/clients/client-comprehend/commands/ListEntityRecognizersCommand.ts index 09925f01fd12..4405bf5f125b 100644 --- a/clients/client-comprehend/commands/ListEntityRecognizersCommand.ts +++ b/clients/client-comprehend/commands/ListEntityRecognizersCommand.ts @@ -27,6 +27,20 @@ export interface ListEntityRecognizersCommandOutput extends ListEntityRecognizer * 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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ComprehendClient, ListEntityRecognizersCommand } from "@aws-sdk/client-comprehend"; // ES Modules import + * // const { ComprehendClient, ListEntityRecognizersCommand } = require("@aws-sdk/client-comprehend"); // CommonJS import + * const client = new ComprehendClient(config); + * const command = new ListEntityRecognizersCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListEntityRecognizersCommandInput} for command's `input` shape. + * @see {@link ListEntityRecognizersCommandOutput} for command's `response` shape. + * @see {@link ComprehendClientResolvedConfig | config} for command's `input` shape. + * */ export class ListEntityRecognizersCommand extends $Command< ListEntityRecognizersCommandInput, diff --git a/clients/client-comprehend/commands/ListEventsDetectionJobsCommand.ts b/clients/client-comprehend/commands/ListEventsDetectionJobsCommand.ts index 60795925eaa3..0d5e9f580d70 100644 --- a/clients/client-comprehend/commands/ListEventsDetectionJobsCommand.ts +++ b/clients/client-comprehend/commands/ListEventsDetectionJobsCommand.ts @@ -22,6 +22,20 @@ export interface ListEventsDetectionJobsCommandOutput extends ListEventsDetectio /** *

Gets a list of the events detection jobs that you have submitted.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ComprehendClient, ListEventsDetectionJobsCommand } from "@aws-sdk/client-comprehend"; // ES Modules import + * // const { ComprehendClient, ListEventsDetectionJobsCommand } = require("@aws-sdk/client-comprehend"); // CommonJS import + * const client = new ComprehendClient(config); + * const command = new ListEventsDetectionJobsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListEventsDetectionJobsCommandInput} for command's `input` shape. + * @see {@link ListEventsDetectionJobsCommandOutput} for command's `response` shape. + * @see {@link ComprehendClientResolvedConfig | config} for command's `input` shape. + * */ export class ListEventsDetectionJobsCommand extends $Command< ListEventsDetectionJobsCommandInput, diff --git a/clients/client-comprehend/commands/ListKeyPhrasesDetectionJobsCommand.ts b/clients/client-comprehend/commands/ListKeyPhrasesDetectionJobsCommand.ts index c74bb5908a02..27f0e658713b 100644 --- a/clients/client-comprehend/commands/ListKeyPhrasesDetectionJobsCommand.ts +++ b/clients/client-comprehend/commands/ListKeyPhrasesDetectionJobsCommand.ts @@ -24,6 +24,20 @@ export interface ListKeyPhrasesDetectionJobsCommandOutput /** *

Get a list of key phrase detection jobs that you have submitted.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ComprehendClient, ListKeyPhrasesDetectionJobsCommand } from "@aws-sdk/client-comprehend"; // ES Modules import + * // const { ComprehendClient, ListKeyPhrasesDetectionJobsCommand } = require("@aws-sdk/client-comprehend"); // CommonJS import + * const client = new ComprehendClient(config); + * const command = new ListKeyPhrasesDetectionJobsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListKeyPhrasesDetectionJobsCommandInput} for command's `input` shape. + * @see {@link ListKeyPhrasesDetectionJobsCommandOutput} for command's `response` shape. + * @see {@link ComprehendClientResolvedConfig | config} for command's `input` shape. + * */ export class ListKeyPhrasesDetectionJobsCommand extends $Command< ListKeyPhrasesDetectionJobsCommandInput, diff --git a/clients/client-comprehend/commands/ListPiiEntitiesDetectionJobsCommand.ts b/clients/client-comprehend/commands/ListPiiEntitiesDetectionJobsCommand.ts index 8dae649f54b7..eaa7ed5d7d4c 100644 --- a/clients/client-comprehend/commands/ListPiiEntitiesDetectionJobsCommand.ts +++ b/clients/client-comprehend/commands/ListPiiEntitiesDetectionJobsCommand.ts @@ -24,6 +24,20 @@ export interface ListPiiEntitiesDetectionJobsCommandOutput /** *

Gets a list of the PII entity detection jobs that you have submitted.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ComprehendClient, ListPiiEntitiesDetectionJobsCommand } from "@aws-sdk/client-comprehend"; // ES Modules import + * // const { ComprehendClient, ListPiiEntitiesDetectionJobsCommand } = require("@aws-sdk/client-comprehend"); // CommonJS import + * const client = new ComprehendClient(config); + * const command = new ListPiiEntitiesDetectionJobsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListPiiEntitiesDetectionJobsCommandInput} for command's `input` shape. + * @see {@link ListPiiEntitiesDetectionJobsCommandOutput} for command's `response` shape. + * @see {@link ComprehendClientResolvedConfig | config} for command's `input` shape. + * */ export class ListPiiEntitiesDetectionJobsCommand extends $Command< ListPiiEntitiesDetectionJobsCommandInput, diff --git a/clients/client-comprehend/commands/ListSentimentDetectionJobsCommand.ts b/clients/client-comprehend/commands/ListSentimentDetectionJobsCommand.ts index 28bc0a64b4ae..9fc4d3f01066 100644 --- a/clients/client-comprehend/commands/ListSentimentDetectionJobsCommand.ts +++ b/clients/client-comprehend/commands/ListSentimentDetectionJobsCommand.ts @@ -22,6 +22,20 @@ export interface ListSentimentDetectionJobsCommandOutput extends ListSentimentDe /** *

Gets a list of sentiment detection jobs that you have submitted.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ComprehendClient, ListSentimentDetectionJobsCommand } from "@aws-sdk/client-comprehend"; // ES Modules import + * // const { ComprehendClient, ListSentimentDetectionJobsCommand } = require("@aws-sdk/client-comprehend"); // CommonJS import + * const client = new ComprehendClient(config); + * const command = new ListSentimentDetectionJobsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListSentimentDetectionJobsCommandInput} for command's `input` shape. + * @see {@link ListSentimentDetectionJobsCommandOutput} for command's `response` shape. + * @see {@link ComprehendClientResolvedConfig | config} for command's `input` shape. + * */ export class ListSentimentDetectionJobsCommand extends $Command< ListSentimentDetectionJobsCommandInput, diff --git a/clients/client-comprehend/commands/ListTagsForResourceCommand.ts b/clients/client-comprehend/commands/ListTagsForResourceCommand.ts index 4bba4953322d..0fc66f07b176 100644 --- a/clients/client-comprehend/commands/ListTagsForResourceCommand.ts +++ b/clients/client-comprehend/commands/ListTagsForResourceCommand.ts @@ -22,6 +22,20 @@ export interface ListTagsForResourceCommandOutput extends ListTagsForResourceRes /** *

Lists all tags associated with a given Amazon Comprehend resource.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ComprehendClient, ListTagsForResourceCommand } from "@aws-sdk/client-comprehend"; // ES Modules import + * // const { ComprehendClient, ListTagsForResourceCommand } = require("@aws-sdk/client-comprehend"); // CommonJS import + * const client = new ComprehendClient(config); + * const command = new ListTagsForResourceCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListTagsForResourceCommandInput} for command's `input` shape. + * @see {@link ListTagsForResourceCommandOutput} for command's `response` shape. + * @see {@link ComprehendClientResolvedConfig | config} for command's `input` shape. + * */ export class ListTagsForResourceCommand extends $Command< ListTagsForResourceCommandInput, diff --git a/clients/client-comprehend/commands/ListTopicsDetectionJobsCommand.ts b/clients/client-comprehend/commands/ListTopicsDetectionJobsCommand.ts index 61375e55279e..e07057854a3e 100644 --- a/clients/client-comprehend/commands/ListTopicsDetectionJobsCommand.ts +++ b/clients/client-comprehend/commands/ListTopicsDetectionJobsCommand.ts @@ -22,6 +22,20 @@ export interface ListTopicsDetectionJobsCommandOutput extends ListTopicsDetectio /** *

Gets a list of the topic detection jobs that you have submitted.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ComprehendClient, ListTopicsDetectionJobsCommand } from "@aws-sdk/client-comprehend"; // ES Modules import + * // const { ComprehendClient, ListTopicsDetectionJobsCommand } = require("@aws-sdk/client-comprehend"); // CommonJS import + * const client = new ComprehendClient(config); + * const command = new ListTopicsDetectionJobsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListTopicsDetectionJobsCommandInput} for command's `input` shape. + * @see {@link ListTopicsDetectionJobsCommandOutput} for command's `response` shape. + * @see {@link ComprehendClientResolvedConfig | config} for command's `input` shape. + * */ export class ListTopicsDetectionJobsCommand extends $Command< ListTopicsDetectionJobsCommandInput, diff --git a/clients/client-comprehend/commands/StartDocumentClassificationJobCommand.ts b/clients/client-comprehend/commands/StartDocumentClassificationJobCommand.ts index cbd2230a5bee..fdb246c0e009 100644 --- a/clients/client-comprehend/commands/StartDocumentClassificationJobCommand.ts +++ b/clients/client-comprehend/commands/StartDocumentClassificationJobCommand.ts @@ -25,6 +25,20 @@ export interface StartDocumentClassificationJobCommandOutput /** *

Starts an asynchronous document classification job. Use the operation to track the progress of the * job.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ComprehendClient, StartDocumentClassificationJobCommand } from "@aws-sdk/client-comprehend"; // ES Modules import + * // const { ComprehendClient, StartDocumentClassificationJobCommand } = require("@aws-sdk/client-comprehend"); // CommonJS import + * const client = new ComprehendClient(config); + * const command = new StartDocumentClassificationJobCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link StartDocumentClassificationJobCommandInput} for command's `input` shape. + * @see {@link StartDocumentClassificationJobCommandOutput} for command's `response` shape. + * @see {@link ComprehendClientResolvedConfig | config} for command's `input` shape. + * */ export class StartDocumentClassificationJobCommand extends $Command< StartDocumentClassificationJobCommandInput, diff --git a/clients/client-comprehend/commands/StartDominantLanguageDetectionJobCommand.ts b/clients/client-comprehend/commands/StartDominantLanguageDetectionJobCommand.ts index c41f67178ed0..c6a4c29688a4 100644 --- a/clients/client-comprehend/commands/StartDominantLanguageDetectionJobCommand.ts +++ b/clients/client-comprehend/commands/StartDominantLanguageDetectionJobCommand.ts @@ -29,6 +29,20 @@ export interface StartDominantLanguageDetectionJobCommandOutput *

Starts an asynchronous dominant language detection job for a collection of documents. Use * the operation to track the status * of a job.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ComprehendClient, StartDominantLanguageDetectionJobCommand } from "@aws-sdk/client-comprehend"; // ES Modules import + * // const { ComprehendClient, StartDominantLanguageDetectionJobCommand } = require("@aws-sdk/client-comprehend"); // CommonJS import + * const client = new ComprehendClient(config); + * const command = new StartDominantLanguageDetectionJobCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link StartDominantLanguageDetectionJobCommandInput} for command's `input` shape. + * @see {@link StartDominantLanguageDetectionJobCommandOutput} for command's `response` shape. + * @see {@link ComprehendClientResolvedConfig | config} for command's `input` shape. + * */ export class StartDominantLanguageDetectionJobCommand extends $Command< StartDominantLanguageDetectionJobCommandInput, diff --git a/clients/client-comprehend/commands/StartEntitiesDetectionJobCommand.ts b/clients/client-comprehend/commands/StartEntitiesDetectionJobCommand.ts index d25d22b05314..dc979579c6c3 100644 --- a/clients/client-comprehend/commands/StartEntitiesDetectionJobCommand.ts +++ b/clients/client-comprehend/commands/StartEntitiesDetectionJobCommand.ts @@ -26,6 +26,20 @@ export interface StartEntitiesDetectionJobCommandOutput extends StartEntitiesDet * 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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ComprehendClient, StartEntitiesDetectionJobCommand } from "@aws-sdk/client-comprehend"; // ES Modules import + * // const { ComprehendClient, StartEntitiesDetectionJobCommand } = require("@aws-sdk/client-comprehend"); // CommonJS import + * const client = new ComprehendClient(config); + * const command = new StartEntitiesDetectionJobCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link StartEntitiesDetectionJobCommandInput} for command's `input` shape. + * @see {@link StartEntitiesDetectionJobCommandOutput} for command's `response` shape. + * @see {@link ComprehendClientResolvedConfig | config} for command's `input` shape. + * */ export class StartEntitiesDetectionJobCommand extends $Command< StartEntitiesDetectionJobCommandInput, diff --git a/clients/client-comprehend/commands/StartEventsDetectionJobCommand.ts b/clients/client-comprehend/commands/StartEventsDetectionJobCommand.ts index 286454a20574..8f7ca5446258 100644 --- a/clients/client-comprehend/commands/StartEventsDetectionJobCommand.ts +++ b/clients/client-comprehend/commands/StartEventsDetectionJobCommand.ts @@ -22,6 +22,20 @@ export interface StartEventsDetectionJobCommandOutput extends StartEventsDetecti /** *

Starts an asynchronous event detection job for a collection of documents.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ComprehendClient, StartEventsDetectionJobCommand } from "@aws-sdk/client-comprehend"; // ES Modules import + * // const { ComprehendClient, StartEventsDetectionJobCommand } = require("@aws-sdk/client-comprehend"); // CommonJS import + * const client = new ComprehendClient(config); + * const command = new StartEventsDetectionJobCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link StartEventsDetectionJobCommandInput} for command's `input` shape. + * @see {@link StartEventsDetectionJobCommandOutput} for command's `response` shape. + * @see {@link ComprehendClientResolvedConfig | config} for command's `input` shape. + * */ export class StartEventsDetectionJobCommand extends $Command< StartEventsDetectionJobCommandInput, diff --git a/clients/client-comprehend/commands/StartKeyPhrasesDetectionJobCommand.ts b/clients/client-comprehend/commands/StartKeyPhrasesDetectionJobCommand.ts index 15a6526e31aa..cdb3c16494aa 100644 --- a/clients/client-comprehend/commands/StartKeyPhrasesDetectionJobCommand.ts +++ b/clients/client-comprehend/commands/StartKeyPhrasesDetectionJobCommand.ts @@ -26,6 +26,20 @@ export interface StartKeyPhrasesDetectionJobCommandOutput *

Starts an asynchronous key phrase detection job for a collection of documents. Use the * operation to track the status of a * job.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ComprehendClient, StartKeyPhrasesDetectionJobCommand } from "@aws-sdk/client-comprehend"; // ES Modules import + * // const { ComprehendClient, StartKeyPhrasesDetectionJobCommand } = require("@aws-sdk/client-comprehend"); // CommonJS import + * const client = new ComprehendClient(config); + * const command = new StartKeyPhrasesDetectionJobCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link StartKeyPhrasesDetectionJobCommandInput} for command's `input` shape. + * @see {@link StartKeyPhrasesDetectionJobCommandOutput} for command's `response` shape. + * @see {@link ComprehendClientResolvedConfig | config} for command's `input` shape. + * */ export class StartKeyPhrasesDetectionJobCommand extends $Command< StartKeyPhrasesDetectionJobCommandInput, diff --git a/clients/client-comprehend/commands/StartPiiEntitiesDetectionJobCommand.ts b/clients/client-comprehend/commands/StartPiiEntitiesDetectionJobCommand.ts index 63d71c17e622..fd31d101ca4d 100644 --- a/clients/client-comprehend/commands/StartPiiEntitiesDetectionJobCommand.ts +++ b/clients/client-comprehend/commands/StartPiiEntitiesDetectionJobCommand.ts @@ -24,6 +24,20 @@ export interface StartPiiEntitiesDetectionJobCommandOutput /** *

Starts an asynchronous PII entity detection job for a collection of documents.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ComprehendClient, StartPiiEntitiesDetectionJobCommand } from "@aws-sdk/client-comprehend"; // ES Modules import + * // const { ComprehendClient, StartPiiEntitiesDetectionJobCommand } = require("@aws-sdk/client-comprehend"); // CommonJS import + * const client = new ComprehendClient(config); + * const command = new StartPiiEntitiesDetectionJobCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link StartPiiEntitiesDetectionJobCommandInput} for command's `input` shape. + * @see {@link StartPiiEntitiesDetectionJobCommandOutput} for command's `response` shape. + * @see {@link ComprehendClientResolvedConfig | config} for command's `input` shape. + * */ export class StartPiiEntitiesDetectionJobCommand extends $Command< StartPiiEntitiesDetectionJobCommandInput, diff --git a/clients/client-comprehend/commands/StartSentimentDetectionJobCommand.ts b/clients/client-comprehend/commands/StartSentimentDetectionJobCommand.ts index 7794377a05c5..f11dcfb6815f 100644 --- a/clients/client-comprehend/commands/StartSentimentDetectionJobCommand.ts +++ b/clients/client-comprehend/commands/StartSentimentDetectionJobCommand.ts @@ -24,6 +24,20 @@ export interface StartSentimentDetectionJobCommandOutput extends StartSentimentD *

Starts an asynchronous sentiment detection job for a collection of documents. use the * operation to track the status of a * job.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ComprehendClient, StartSentimentDetectionJobCommand } from "@aws-sdk/client-comprehend"; // ES Modules import + * // const { ComprehendClient, StartSentimentDetectionJobCommand } = require("@aws-sdk/client-comprehend"); // CommonJS import + * const client = new ComprehendClient(config); + * const command = new StartSentimentDetectionJobCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link StartSentimentDetectionJobCommandInput} for command's `input` shape. + * @see {@link StartSentimentDetectionJobCommandOutput} for command's `response` shape. + * @see {@link ComprehendClientResolvedConfig | config} for command's `input` shape. + * */ export class StartSentimentDetectionJobCommand extends $Command< StartSentimentDetectionJobCommandInput, diff --git a/clients/client-comprehend/commands/StartTopicsDetectionJobCommand.ts b/clients/client-comprehend/commands/StartTopicsDetectionJobCommand.ts index 4ab8ed09507a..593ff8bb4cbc 100644 --- a/clients/client-comprehend/commands/StartTopicsDetectionJobCommand.ts +++ b/clients/client-comprehend/commands/StartTopicsDetectionJobCommand.ts @@ -23,6 +23,20 @@ export interface StartTopicsDetectionJobCommandOutput extends StartTopicsDetecti /** *

Starts an asynchronous topic detection job. Use the * DescribeTopicDetectionJob operation to track the status of a job.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ComprehendClient, StartTopicsDetectionJobCommand } from "@aws-sdk/client-comprehend"; // ES Modules import + * // const { ComprehendClient, StartTopicsDetectionJobCommand } = require("@aws-sdk/client-comprehend"); // CommonJS import + * const client = new ComprehendClient(config); + * const command = new StartTopicsDetectionJobCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link StartTopicsDetectionJobCommandInput} for command's `input` shape. + * @see {@link StartTopicsDetectionJobCommandOutput} for command's `response` shape. + * @see {@link ComprehendClientResolvedConfig | config} for command's `input` shape. + * */ export class StartTopicsDetectionJobCommand extends $Command< StartTopicsDetectionJobCommandInput, diff --git a/clients/client-comprehend/commands/StopDominantLanguageDetectionJobCommand.ts b/clients/client-comprehend/commands/StopDominantLanguageDetectionJobCommand.ts index 28583ec092a2..accce8f83100 100644 --- a/clients/client-comprehend/commands/StopDominantLanguageDetectionJobCommand.ts +++ b/clients/client-comprehend/commands/StopDominantLanguageDetectionJobCommand.ts @@ -33,6 +33,20 @@ export interface StopDominantLanguageDetectionJobCommandOutput * Internal Request Exception.

*

When a job is stopped, any documents already processed are written to the output * location.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ComprehendClient, StopDominantLanguageDetectionJobCommand } from "@aws-sdk/client-comprehend"; // ES Modules import + * // const { ComprehendClient, StopDominantLanguageDetectionJobCommand } = require("@aws-sdk/client-comprehend"); // CommonJS import + * const client = new ComprehendClient(config); + * const command = new StopDominantLanguageDetectionJobCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link StopDominantLanguageDetectionJobCommandInput} for command's `input` shape. + * @see {@link StopDominantLanguageDetectionJobCommandOutput} for command's `response` shape. + * @see {@link ComprehendClientResolvedConfig | config} for command's `input` shape. + * */ export class StopDominantLanguageDetectionJobCommand extends $Command< StopDominantLanguageDetectionJobCommandInput, diff --git a/clients/client-comprehend/commands/StopEntitiesDetectionJobCommand.ts b/clients/client-comprehend/commands/StopEntitiesDetectionJobCommand.ts index e9fdc21553d0..7736546bb34b 100644 --- a/clients/client-comprehend/commands/StopEntitiesDetectionJobCommand.ts +++ b/clients/client-comprehend/commands/StopEntitiesDetectionJobCommand.ts @@ -31,6 +31,20 @@ export interface StopEntitiesDetectionJobCommandOutput extends StopEntitiesDetec * Internal Request Exception.

*

When a job is stopped, any documents already processed are written to the output * location.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ComprehendClient, StopEntitiesDetectionJobCommand } from "@aws-sdk/client-comprehend"; // ES Modules import + * // const { ComprehendClient, StopEntitiesDetectionJobCommand } = require("@aws-sdk/client-comprehend"); // CommonJS import + * const client = new ComprehendClient(config); + * const command = new StopEntitiesDetectionJobCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link StopEntitiesDetectionJobCommandInput} for command's `input` shape. + * @see {@link StopEntitiesDetectionJobCommandOutput} for command's `response` shape. + * @see {@link ComprehendClientResolvedConfig | config} for command's `input` shape. + * */ export class StopEntitiesDetectionJobCommand extends $Command< StopEntitiesDetectionJobCommandInput, diff --git a/clients/client-comprehend/commands/StopEventsDetectionJobCommand.ts b/clients/client-comprehend/commands/StopEventsDetectionJobCommand.ts index 1e53901792fd..24f2f5529788 100644 --- a/clients/client-comprehend/commands/StopEventsDetectionJobCommand.ts +++ b/clients/client-comprehend/commands/StopEventsDetectionJobCommand.ts @@ -22,6 +22,20 @@ export interface StopEventsDetectionJobCommandOutput extends StopEventsDetection /** *

Stops an events detection job in progress.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ComprehendClient, StopEventsDetectionJobCommand } from "@aws-sdk/client-comprehend"; // ES Modules import + * // const { ComprehendClient, StopEventsDetectionJobCommand } = require("@aws-sdk/client-comprehend"); // CommonJS import + * const client = new ComprehendClient(config); + * const command = new StopEventsDetectionJobCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link StopEventsDetectionJobCommandInput} for command's `input` shape. + * @see {@link StopEventsDetectionJobCommandOutput} for command's `response` shape. + * @see {@link ComprehendClientResolvedConfig | config} for command's `input` shape. + * */ export class StopEventsDetectionJobCommand extends $Command< StopEventsDetectionJobCommandInput, diff --git a/clients/client-comprehend/commands/StopKeyPhrasesDetectionJobCommand.ts b/clients/client-comprehend/commands/StopKeyPhrasesDetectionJobCommand.ts index f2e4fce4f6ac..16c41a2bbd55 100644 --- a/clients/client-comprehend/commands/StopKeyPhrasesDetectionJobCommand.ts +++ b/clients/client-comprehend/commands/StopKeyPhrasesDetectionJobCommand.ts @@ -31,6 +31,20 @@ export interface StopKeyPhrasesDetectionJobCommandOutput extends StopKeyPhrasesD * Internal Request Exception.

*

When a job is stopped, any documents already processed are written to the output * location.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ComprehendClient, StopKeyPhrasesDetectionJobCommand } from "@aws-sdk/client-comprehend"; // ES Modules import + * // const { ComprehendClient, StopKeyPhrasesDetectionJobCommand } = require("@aws-sdk/client-comprehend"); // CommonJS import + * const client = new ComprehendClient(config); + * const command = new StopKeyPhrasesDetectionJobCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link StopKeyPhrasesDetectionJobCommandInput} for command's `input` shape. + * @see {@link StopKeyPhrasesDetectionJobCommandOutput} for command's `response` shape. + * @see {@link ComprehendClientResolvedConfig | config} for command's `input` shape. + * */ export class StopKeyPhrasesDetectionJobCommand extends $Command< StopKeyPhrasesDetectionJobCommandInput, diff --git a/clients/client-comprehend/commands/StopPiiEntitiesDetectionJobCommand.ts b/clients/client-comprehend/commands/StopPiiEntitiesDetectionJobCommand.ts index 90dfdb350e3c..40bac34d2484 100644 --- a/clients/client-comprehend/commands/StopPiiEntitiesDetectionJobCommand.ts +++ b/clients/client-comprehend/commands/StopPiiEntitiesDetectionJobCommand.ts @@ -24,6 +24,20 @@ export interface StopPiiEntitiesDetectionJobCommandOutput /** *

Stops a PII entities detection job in progress.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ComprehendClient, StopPiiEntitiesDetectionJobCommand } from "@aws-sdk/client-comprehend"; // ES Modules import + * // const { ComprehendClient, StopPiiEntitiesDetectionJobCommand } = require("@aws-sdk/client-comprehend"); // CommonJS import + * const client = new ComprehendClient(config); + * const command = new StopPiiEntitiesDetectionJobCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link StopPiiEntitiesDetectionJobCommandInput} for command's `input` shape. + * @see {@link StopPiiEntitiesDetectionJobCommandOutput} for command's `response` shape. + * @see {@link ComprehendClientResolvedConfig | config} for command's `input` shape. + * */ export class StopPiiEntitiesDetectionJobCommand extends $Command< StopPiiEntitiesDetectionJobCommandInput, diff --git a/clients/client-comprehend/commands/StopSentimentDetectionJobCommand.ts b/clients/client-comprehend/commands/StopSentimentDetectionJobCommand.ts index b20928b74435..bbc2f58b9ebd 100644 --- a/clients/client-comprehend/commands/StopSentimentDetectionJobCommand.ts +++ b/clients/client-comprehend/commands/StopSentimentDetectionJobCommand.ts @@ -31,6 +31,20 @@ export interface StopSentimentDetectionJobCommandOutput extends StopSentimentDet * Internal Request Exception.

*

When a job is stopped, any documents already processed are written to the output * location.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ComprehendClient, StopSentimentDetectionJobCommand } from "@aws-sdk/client-comprehend"; // ES Modules import + * // const { ComprehendClient, StopSentimentDetectionJobCommand } = require("@aws-sdk/client-comprehend"); // CommonJS import + * const client = new ComprehendClient(config); + * const command = new StopSentimentDetectionJobCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link StopSentimentDetectionJobCommandInput} for command's `input` shape. + * @see {@link StopSentimentDetectionJobCommandOutput} for command's `response` shape. + * @see {@link ComprehendClientResolvedConfig | config} for command's `input` shape. + * */ export class StopSentimentDetectionJobCommand extends $Command< StopSentimentDetectionJobCommandInput, diff --git a/clients/client-comprehend/commands/StopTrainingDocumentClassifierCommand.ts b/clients/client-comprehend/commands/StopTrainingDocumentClassifierCommand.ts index 0ad1c8efe365..d6837e4d0d84 100644 --- a/clients/client-comprehend/commands/StopTrainingDocumentClassifierCommand.ts +++ b/clients/client-comprehend/commands/StopTrainingDocumentClassifierCommand.ts @@ -29,6 +29,20 @@ export interface StopTrainingDocumentClassifierCommandOutput * 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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ComprehendClient, StopTrainingDocumentClassifierCommand } from "@aws-sdk/client-comprehend"; // ES Modules import + * // const { ComprehendClient, StopTrainingDocumentClassifierCommand } = require("@aws-sdk/client-comprehend"); // CommonJS import + * const client = new ComprehendClient(config); + * const command = new StopTrainingDocumentClassifierCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link StopTrainingDocumentClassifierCommandInput} for command's `input` shape. + * @see {@link StopTrainingDocumentClassifierCommandOutput} for command's `response` shape. + * @see {@link ComprehendClientResolvedConfig | config} for command's `input` shape. + * */ export class StopTrainingDocumentClassifierCommand extends $Command< StopTrainingDocumentClassifierCommandInput, diff --git a/clients/client-comprehend/commands/StopTrainingEntityRecognizerCommand.ts b/clients/client-comprehend/commands/StopTrainingEntityRecognizerCommand.ts index 4b2ef9bea715..f29d5c31d8b7 100644 --- a/clients/client-comprehend/commands/StopTrainingEntityRecognizerCommand.ts +++ b/clients/client-comprehend/commands/StopTrainingEntityRecognizerCommand.ts @@ -29,6 +29,20 @@ export interface StopTrainingEntityRecognizerCommandOutput * 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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ComprehendClient, StopTrainingEntityRecognizerCommand } from "@aws-sdk/client-comprehend"; // ES Modules import + * // const { ComprehendClient, StopTrainingEntityRecognizerCommand } = require("@aws-sdk/client-comprehend"); // CommonJS import + * const client = new ComprehendClient(config); + * const command = new StopTrainingEntityRecognizerCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link StopTrainingEntityRecognizerCommandInput} for command's `input` shape. + * @see {@link StopTrainingEntityRecognizerCommandOutput} for command's `response` shape. + * @see {@link ComprehendClientResolvedConfig | config} for command's `input` shape. + * */ export class StopTrainingEntityRecognizerCommand extends $Command< StopTrainingEntityRecognizerCommandInput, diff --git a/clients/client-comprehend/commands/TagResourceCommand.ts b/clients/client-comprehend/commands/TagResourceCommand.ts index 255cbf158872..8b34f7692b5e 100644 --- a/clients/client-comprehend/commands/TagResourceCommand.ts +++ b/clients/client-comprehend/commands/TagResourceCommand.ts @@ -25,6 +25,20 @@ export interface TagResourceCommandOutput extends TagResourceResponse, __Metadat * 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. *

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ComprehendClient, TagResourceCommand } from "@aws-sdk/client-comprehend"; // ES Modules import + * // const { ComprehendClient, TagResourceCommand } = require("@aws-sdk/client-comprehend"); // CommonJS import + * const client = new ComprehendClient(config); + * const command = new TagResourceCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link TagResourceCommandInput} for command's `input` shape. + * @see {@link TagResourceCommandOutput} for command's `response` shape. + * @see {@link ComprehendClientResolvedConfig | config} for command's `input` shape. + * */ export class TagResourceCommand extends $Command< TagResourceCommandInput, diff --git a/clients/client-comprehend/commands/UntagResourceCommand.ts b/clients/client-comprehend/commands/UntagResourceCommand.ts index 6d48599c3827..86709fffb22e 100644 --- a/clients/client-comprehend/commands/UntagResourceCommand.ts +++ b/clients/client-comprehend/commands/UntagResourceCommand.ts @@ -22,6 +22,20 @@ export interface UntagResourceCommandOutput extends UntagResourceResponse, __Met /** *

Removes a specific tag associated with an Amazon Comprehend resource.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ComprehendClient, UntagResourceCommand } from "@aws-sdk/client-comprehend"; // ES Modules import + * // const { ComprehendClient, UntagResourceCommand } = require("@aws-sdk/client-comprehend"); // CommonJS import + * const client = new ComprehendClient(config); + * const command = new UntagResourceCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link UntagResourceCommandInput} for command's `input` shape. + * @see {@link UntagResourceCommandOutput} for command's `response` shape. + * @see {@link ComprehendClientResolvedConfig | config} for command's `input` shape. + * */ export class UntagResourceCommand extends $Command< UntagResourceCommandInput, diff --git a/clients/client-comprehend/commands/UpdateEndpointCommand.ts b/clients/client-comprehend/commands/UpdateEndpointCommand.ts index 3e4207bc778d..88421f04c41d 100644 --- a/clients/client-comprehend/commands/UpdateEndpointCommand.ts +++ b/clients/client-comprehend/commands/UpdateEndpointCommand.ts @@ -22,6 +22,20 @@ export interface UpdateEndpointCommandOutput extends UpdateEndpointResponse, __M /** *

Updates information about the specified endpoint.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ComprehendClient, UpdateEndpointCommand } from "@aws-sdk/client-comprehend"; // ES Modules import + * // const { ComprehendClient, UpdateEndpointCommand } = require("@aws-sdk/client-comprehend"); // CommonJS import + * const client = new ComprehendClient(config); + * const command = new UpdateEndpointCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link UpdateEndpointCommandInput} for command's `input` shape. + * @see {@link UpdateEndpointCommandOutput} for command's `response` shape. + * @see {@link ComprehendClientResolvedConfig | config} for command's `input` shape. + * */ export class UpdateEndpointCommand extends $Command< UpdateEndpointCommandInput, diff --git a/clients/client-comprehend/models/models_0.ts b/clients/client-comprehend/models/models_0.ts index 91aa8b91aa54..cfaad026560a 100644 --- a/clients/client-comprehend/models/models_0.ts +++ b/clients/client-comprehend/models/models_0.ts @@ -25,6 +25,9 @@ export interface AugmentedManifestsListItem { } export namespace AugmentedManifestsListItem { + /** + * @internal + */ export const filterSensitiveLog = (obj: AugmentedManifestsListItem): any => ({ ...obj, }); @@ -40,6 +43,9 @@ export interface BatchDetectDominantLanguageRequest { } export namespace BatchDetectDominantLanguageRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: BatchDetectDominantLanguageRequest): any => ({ ...obj, ...(obj.TextList && { TextList: SENSITIVE_STRING }), @@ -69,6 +75,9 @@ export interface BatchItemError { } export namespace BatchItemError { + /** + * @internal + */ export const filterSensitiveLog = (obj: BatchItemError): any => ({ ...obj, }); @@ -94,6 +103,9 @@ export interface DominantLanguage { } export namespace DominantLanguage { + /** + * @internal + */ export const filterSensitiveLog = (obj: DominantLanguage): any => ({ ...obj, }); @@ -118,6 +130,9 @@ export interface BatchDetectDominantLanguageItemResult { } export namespace BatchDetectDominantLanguageItemResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: BatchDetectDominantLanguageItemResult): any => ({ ...obj, }); @@ -142,6 +157,9 @@ export interface BatchDetectDominantLanguageResponse { } export namespace BatchDetectDominantLanguageResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: BatchDetectDominantLanguageResponse): any => ({ ...obj, }); @@ -158,6 +176,9 @@ export interface BatchSizeLimitExceededException extends __SmithyException, $Met } export namespace BatchSizeLimitExceededException { + /** + * @internal + */ export const filterSensitiveLog = (obj: BatchSizeLimitExceededException): any => ({ ...obj, }); @@ -173,6 +194,9 @@ export interface InternalServerException extends __SmithyException, $MetadataBea } export namespace InternalServerException { + /** + * @internal + */ export const filterSensitiveLog = (obj: InternalServerException): any => ({ ...obj, }); @@ -188,6 +212,9 @@ export interface InvalidRequestException extends __SmithyException, $MetadataBea } export namespace InvalidRequestException { + /** + * @internal + */ export const filterSensitiveLog = (obj: InvalidRequestException): any => ({ ...obj, }); @@ -203,6 +230,9 @@ export interface TextSizeLimitExceededException extends __SmithyException, $Meta } export namespace TextSizeLimitExceededException { + /** + * @internal + */ export const filterSensitiveLog = (obj: TextSizeLimitExceededException): any => ({ ...obj, }); @@ -239,6 +269,9 @@ export interface BatchDetectEntitiesRequest { } export namespace BatchDetectEntitiesRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: BatchDetectEntitiesRequest): any => ({ ...obj, ...(obj.TextList && { TextList: SENSITIVE_STRING }), @@ -297,6 +330,9 @@ export interface Entity { } export namespace Entity { + /** + * @internal + */ export const filterSensitiveLog = (obj: Entity): any => ({ ...obj, }); @@ -321,6 +357,9 @@ export interface BatchDetectEntitiesItemResult { } export namespace BatchDetectEntitiesItemResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: BatchDetectEntitiesItemResult): any => ({ ...obj, }); @@ -345,6 +384,9 @@ export interface BatchDetectEntitiesResponse { } export namespace BatchDetectEntitiesResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: BatchDetectEntitiesResponse): any => ({ ...obj, }); @@ -362,6 +404,9 @@ export interface UnsupportedLanguageException extends __SmithyException, $Metada } export namespace UnsupportedLanguageException { + /** + * @internal + */ export const filterSensitiveLog = (obj: UnsupportedLanguageException): any => ({ ...obj, }); @@ -383,6 +428,9 @@ export interface BatchDetectKeyPhrasesRequest { } export namespace BatchDetectKeyPhrasesRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: BatchDetectKeyPhrasesRequest): any => ({ ...obj, ...(obj.TextList && { TextList: SENSITIVE_STRING }), @@ -423,6 +471,9 @@ export interface KeyPhrase { } export namespace KeyPhrase { + /** + * @internal + */ export const filterSensitiveLog = (obj: KeyPhrase): any => ({ ...obj, }); @@ -447,6 +498,9 @@ export interface BatchDetectKeyPhrasesItemResult { } export namespace BatchDetectKeyPhrasesItemResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: BatchDetectKeyPhrasesItemResult): any => ({ ...obj, }); @@ -471,6 +525,9 @@ export interface BatchDetectKeyPhrasesResponse { } export namespace BatchDetectKeyPhrasesResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: BatchDetectKeyPhrasesResponse): any => ({ ...obj, }); @@ -492,6 +549,9 @@ export interface BatchDetectSentimentRequest { } export namespace BatchDetectSentimentRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: BatchDetectSentimentRequest): any => ({ ...obj, ...(obj.TextList && { TextList: SENSITIVE_STRING }), @@ -536,6 +596,9 @@ export interface SentimentScore { } export namespace SentimentScore { + /** + * @internal + */ export const filterSensitiveLog = (obj: SentimentScore): any => ({ ...obj, }); @@ -565,6 +628,9 @@ export interface BatchDetectSentimentItemResult { } export namespace BatchDetectSentimentItemResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: BatchDetectSentimentItemResult): any => ({ ...obj, }); @@ -589,6 +655,9 @@ export interface BatchDetectSentimentResponse { } export namespace BatchDetectSentimentResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: BatchDetectSentimentResponse): any => ({ ...obj, }); @@ -620,6 +689,9 @@ export interface BatchDetectSyntaxRequest { } export namespace BatchDetectSyntaxRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: BatchDetectSyntaxRequest): any => ({ ...obj, ...(obj.TextList && { TextList: SENSITIVE_STRING }), @@ -666,6 +738,9 @@ export interface PartOfSpeechTag { } export namespace PartOfSpeechTag { + /** + * @internal + */ export const filterSensitiveLog = (obj: PartOfSpeechTag): any => ({ ...obj, }); @@ -706,6 +781,9 @@ export interface SyntaxToken { } export namespace SyntaxToken { + /** + * @internal + */ export const filterSensitiveLog = (obj: SyntaxToken): any => ({ ...obj, }); @@ -728,6 +806,9 @@ export interface BatchDetectSyntaxItemResult { } export namespace BatchDetectSyntaxItemResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: BatchDetectSyntaxItemResult): any => ({ ...obj, }); @@ -752,6 +833,9 @@ export interface BatchDetectSyntaxResponse { } export namespace BatchDetectSyntaxResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: BatchDetectSyntaxResponse): any => ({ ...obj, }); @@ -824,6 +908,9 @@ export interface ClassifierEvaluationMetrics { } export namespace ClassifierEvaluationMetrics { + /** + * @internal + */ export const filterSensitiveLog = (obj: ClassifierEvaluationMetrics): any => ({ ...obj, }); @@ -858,6 +945,9 @@ export interface ClassifierMetadata { } export namespace ClassifierMetadata { + /** + * @internal + */ export const filterSensitiveLog = (obj: ClassifierMetadata): any => ({ ...obj, }); @@ -876,6 +966,9 @@ export interface ClassifyDocumentRequest { } export namespace ClassifyDocumentRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ClassifyDocumentRequest): any => ({ ...obj, ...(obj.Text && { Text: SENSITIVE_STRING }), @@ -898,6 +991,9 @@ export interface DocumentClass { } export namespace DocumentClass { + /** + * @internal + */ export const filterSensitiveLog = (obj: DocumentClass): any => ({ ...obj, }); @@ -919,6 +1015,9 @@ export interface DocumentLabel { } export namespace DocumentLabel { + /** + * @internal + */ export const filterSensitiveLog = (obj: DocumentLabel): any => ({ ...obj, }); @@ -943,6 +1042,9 @@ export interface ClassifyDocumentResponse { } export namespace ClassifyDocumentResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ClassifyDocumentResponse): any => ({ ...obj, }); @@ -959,6 +1061,9 @@ export interface ResourceUnavailableException extends __SmithyException, $Metada } export namespace ResourceUnavailableException { + /** + * @internal + */ export const filterSensitiveLog = (obj: ResourceUnavailableException): any => ({ ...obj, }); @@ -978,6 +1083,9 @@ export interface ContainsPiiEntitiesRequest { } export namespace ContainsPiiEntitiesRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ContainsPiiEntitiesRequest): any => ({ ...obj, }); @@ -1027,6 +1135,9 @@ export interface EntityLabel { } export namespace EntityLabel { + /** + * @internal + */ export const filterSensitiveLog = (obj: EntityLabel): any => ({ ...obj, }); @@ -1041,6 +1152,9 @@ export interface ContainsPiiEntitiesResponse { } export namespace ContainsPiiEntitiesResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ContainsPiiEntitiesResponse): any => ({ ...obj, }); @@ -1112,6 +1226,9 @@ export interface DocumentClassifierInputDataConfig { } export namespace DocumentClassifierInputDataConfig { + /** + * @internal + */ export const filterSensitiveLog = (obj: DocumentClassifierInputDataConfig): any => ({ ...obj, }); @@ -1166,6 +1283,9 @@ export interface DocumentClassifierOutputDataConfig { } export namespace DocumentClassifierOutputDataConfig { + /** + * @internal + */ export const filterSensitiveLog = (obj: DocumentClassifierOutputDataConfig): any => ({ ...obj, }); @@ -1195,6 +1315,9 @@ export interface Tag { } export namespace Tag { + /** + * @internal + */ export const filterSensitiveLog = (obj: Tag): any => ({ ...obj, }); @@ -1226,6 +1349,9 @@ export interface VpcConfig { } export namespace VpcConfig { + /** + * @internal + */ export const filterSensitiveLog = (obj: VpcConfig): any => ({ ...obj, }); @@ -1328,6 +1454,9 @@ export interface CreateDocumentClassifierRequest { } export namespace CreateDocumentClassifierRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateDocumentClassifierRequest): any => ({ ...obj, }); @@ -1341,6 +1470,9 @@ export interface CreateDocumentClassifierResponse { } export namespace CreateDocumentClassifierResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateDocumentClassifierResponse): any => ({ ...obj, }); @@ -1357,6 +1489,9 @@ export interface KmsKeyValidationException extends __SmithyException, $MetadataB } export namespace KmsKeyValidationException { + /** + * @internal + */ export const filterSensitiveLog = (obj: KmsKeyValidationException): any => ({ ...obj, }); @@ -1373,6 +1508,9 @@ export interface ResourceInUseException extends __SmithyException, $MetadataBear } export namespace ResourceInUseException { + /** + * @internal + */ export const filterSensitiveLog = (obj: ResourceInUseException): any => ({ ...obj, }); @@ -1389,6 +1527,9 @@ export interface ResourceLimitExceededException extends __SmithyException, $Meta } export namespace ResourceLimitExceededException { + /** + * @internal + */ export const filterSensitiveLog = (obj: ResourceLimitExceededException): any => ({ ...obj, }); @@ -1404,6 +1545,9 @@ export interface TooManyRequestsException extends __SmithyException, $MetadataBe } export namespace TooManyRequestsException { + /** + * @internal + */ export const filterSensitiveLog = (obj: TooManyRequestsException): any => ({ ...obj, }); @@ -1421,6 +1565,9 @@ export interface TooManyTagsException extends __SmithyException, $MetadataBearer } export namespace TooManyTagsException { + /** + * @internal + */ export const filterSensitiveLog = (obj: TooManyTagsException): any => ({ ...obj, }); @@ -1469,6 +1616,9 @@ export interface CreateEndpointRequest { } export namespace CreateEndpointRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateEndpointRequest): any => ({ ...obj, }); @@ -1482,6 +1632,9 @@ export interface CreateEndpointResponse { } export namespace CreateEndpointResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateEndpointResponse): any => ({ ...obj, }); @@ -1497,6 +1650,9 @@ export interface ResourceNotFoundException extends __SmithyException, $MetadataB } export namespace ResourceNotFoundException { + /** + * @internal + */ export const filterSensitiveLog = (obj: ResourceNotFoundException): any => ({ ...obj, }); @@ -1514,6 +1670,9 @@ export interface EntityRecognizerAnnotations { } export namespace EntityRecognizerAnnotations { + /** + * @internal + */ export const filterSensitiveLog = (obj: EntityRecognizerAnnotations): any => ({ ...obj, }); @@ -1537,6 +1696,9 @@ export interface EntityRecognizerDocuments { } export namespace EntityRecognizerDocuments { + /** + * @internal + */ export const filterSensitiveLog = (obj: EntityRecognizerDocuments): any => ({ ...obj, }); @@ -1554,6 +1716,9 @@ export interface EntityRecognizerEntityList { } export namespace EntityRecognizerEntityList { + /** + * @internal + */ export const filterSensitiveLog = (obj: EntityRecognizerEntityList): any => ({ ...obj, }); @@ -1575,6 +1740,9 @@ export interface EntityTypesListItem { } export namespace EntityTypesListItem { + /** + * @internal + */ export const filterSensitiveLog = (obj: EntityTypesListItem): any => ({ ...obj, }); @@ -1652,6 +1820,9 @@ export interface EntityRecognizerInputDataConfig { } export namespace EntityRecognizerInputDataConfig { + /** + * @internal + */ export const filterSensitiveLog = (obj: EntityRecognizerInputDataConfig): any => ({ ...obj, }); @@ -1743,6 +1914,9 @@ export interface CreateEntityRecognizerRequest { } export namespace CreateEntityRecognizerRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateEntityRecognizerRequest): any => ({ ...obj, }); @@ -1756,6 +1930,9 @@ export interface CreateEntityRecognizerResponse { } export namespace CreateEntityRecognizerResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateEntityRecognizerResponse): any => ({ ...obj, }); @@ -1769,6 +1946,9 @@ export interface DeleteDocumentClassifierRequest { } export namespace DeleteDocumentClassifierRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteDocumentClassifierRequest): any => ({ ...obj, }); @@ -1777,6 +1957,9 @@ export namespace DeleteDocumentClassifierRequest { export interface DeleteDocumentClassifierResponse {} export namespace DeleteDocumentClassifierResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteDocumentClassifierResponse): any => ({ ...obj, }); @@ -1790,6 +1973,9 @@ export interface DeleteEndpointRequest { } export namespace DeleteEndpointRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteEndpointRequest): any => ({ ...obj, }); @@ -1798,6 +1984,9 @@ export namespace DeleteEndpointRequest { export interface DeleteEndpointResponse {} export namespace DeleteEndpointResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteEndpointResponse): any => ({ ...obj, }); @@ -1811,6 +2000,9 @@ export interface DeleteEntityRecognizerRequest { } export namespace DeleteEntityRecognizerRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteEntityRecognizerRequest): any => ({ ...obj, }); @@ -1819,6 +2011,9 @@ export namespace DeleteEntityRecognizerRequest { export interface DeleteEntityRecognizerResponse {} export namespace DeleteEntityRecognizerResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteEntityRecognizerResponse): any => ({ ...obj, }); @@ -1833,6 +2028,9 @@ export interface DescribeDocumentClassificationJobRequest { } export namespace DescribeDocumentClassificationJobRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeDocumentClassificationJobRequest): any => ({ ...obj, }); @@ -1878,6 +2076,9 @@ export interface InputDataConfig { } export namespace InputDataConfig { + /** + * @internal + */ export const filterSensitiveLog = (obj: InputDataConfig): any => ({ ...obj, }); @@ -1937,6 +2138,9 @@ export interface OutputDataConfig { } export namespace OutputDataConfig { + /** + * @internal + */ export const filterSensitiveLog = (obj: OutputDataConfig): any => ({ ...obj, }); @@ -2027,6 +2231,9 @@ export interface DocumentClassificationJobProperties { } export namespace DocumentClassificationJobProperties { + /** + * @internal + */ export const filterSensitiveLog = (obj: DocumentClassificationJobProperties): any => ({ ...obj, }); @@ -2041,6 +2248,9 @@ export interface DescribeDocumentClassificationJobResponse { } export namespace DescribeDocumentClassificationJobResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeDocumentClassificationJobResponse): any => ({ ...obj, }); @@ -2056,6 +2266,9 @@ export interface JobNotFoundException extends __SmithyException, $MetadataBearer } export namespace JobNotFoundException { + /** + * @internal + */ export const filterSensitiveLog = (obj: JobNotFoundException): any => ({ ...obj, }); @@ -2070,6 +2283,9 @@ export interface DescribeDocumentClassifierRequest { } export namespace DescribeDocumentClassifierRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeDocumentClassifierRequest): any => ({ ...obj, }); @@ -2210,6 +2426,9 @@ export interface DocumentClassifierProperties { } export namespace DocumentClassifierProperties { + /** + * @internal + */ export const filterSensitiveLog = (obj: DocumentClassifierProperties): any => ({ ...obj, ...(obj.ClassifierMetadata && { ClassifierMetadata: SENSITIVE_STRING }), @@ -2224,6 +2443,9 @@ export interface DescribeDocumentClassifierResponse { } export namespace DescribeDocumentClassifierResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeDocumentClassifierResponse): any => ({ ...obj, ...(obj.DocumentClassifierProperties && { @@ -2241,6 +2463,9 @@ export interface DescribeDominantLanguageDetectionJobRequest { } export namespace DescribeDominantLanguageDetectionJobRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeDominantLanguageDetectionJobRequest): any => ({ ...obj, }); @@ -2327,6 +2552,9 @@ export interface DominantLanguageDetectionJobProperties { } export namespace DominantLanguageDetectionJobProperties { + /** + * @internal + */ export const filterSensitiveLog = (obj: DominantLanguageDetectionJobProperties): any => ({ ...obj, }); @@ -2341,6 +2569,9 @@ export interface DescribeDominantLanguageDetectionJobResponse { } export namespace DescribeDominantLanguageDetectionJobResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeDominantLanguageDetectionJobResponse): any => ({ ...obj, }); @@ -2354,6 +2585,9 @@ export interface DescribeEndpointRequest { } export namespace DescribeEndpointRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeEndpointRequest): any => ({ ...obj, }); @@ -2424,6 +2658,9 @@ export interface EndpointProperties { } export namespace EndpointProperties { + /** + * @internal + */ export const filterSensitiveLog = (obj: EndpointProperties): any => ({ ...obj, }); @@ -2437,6 +2674,9 @@ export interface DescribeEndpointResponse { } export namespace DescribeEndpointResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeEndpointResponse): any => ({ ...obj, }); @@ -2451,6 +2691,9 @@ export interface DescribeEntitiesDetectionJobRequest { } export namespace DescribeEntitiesDetectionJobRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeEntitiesDetectionJobRequest): any => ({ ...obj, }); @@ -2546,6 +2789,9 @@ export interface EntitiesDetectionJobProperties { } export namespace EntitiesDetectionJobProperties { + /** + * @internal + */ export const filterSensitiveLog = (obj: EntitiesDetectionJobProperties): any => ({ ...obj, }); @@ -2559,6 +2805,9 @@ export interface DescribeEntitiesDetectionJobResponse { } export namespace DescribeEntitiesDetectionJobResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeEntitiesDetectionJobResponse): any => ({ ...obj, }); @@ -2572,6 +2821,9 @@ export interface DescribeEntityRecognizerRequest { } export namespace DescribeEntityRecognizerRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeEntityRecognizerRequest): any => ({ ...obj, }); @@ -2605,6 +2857,9 @@ export interface EntityTypesEvaluationMetrics { } export namespace EntityTypesEvaluationMetrics { + /** + * @internal + */ export const filterSensitiveLog = (obj: EntityTypesEvaluationMetrics): any => ({ ...obj, }); @@ -2634,6 +2889,9 @@ export interface EntityRecognizerMetadataEntityTypesListItem { } export namespace EntityRecognizerMetadataEntityTypesListItem { + /** + * @internal + */ export const filterSensitiveLog = (obj: EntityRecognizerMetadataEntityTypesListItem): any => ({ ...obj, }); @@ -2665,6 +2923,9 @@ export interface EntityRecognizerEvaluationMetrics { } export namespace EntityRecognizerEvaluationMetrics { + /** + * @internal + */ export const filterSensitiveLog = (obj: EntityRecognizerEvaluationMetrics): any => ({ ...obj, }); @@ -2698,6 +2959,9 @@ export interface EntityRecognizerMetadata { } export namespace EntityRecognizerMetadata { + /** + * @internal + */ export const filterSensitiveLog = (obj: EntityRecognizerMetadata): any => ({ ...obj, }); @@ -2808,6 +3072,9 @@ export interface EntityRecognizerProperties { } export namespace EntityRecognizerProperties { + /** + * @internal + */ export const filterSensitiveLog = (obj: EntityRecognizerProperties): any => ({ ...obj, ...(obj.RecognizerMetadata && { RecognizerMetadata: SENSITIVE_STRING }), @@ -2822,6 +3089,9 @@ export interface DescribeEntityRecognizerResponse { } export namespace DescribeEntityRecognizerResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeEntityRecognizerResponse): any => ({ ...obj, ...(obj.EntityRecognizerProperties && { @@ -2838,6 +3108,9 @@ export interface DescribeEventsDetectionJobRequest { } export namespace DescribeEventsDetectionJobRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeEventsDetectionJobRequest): any => ({ ...obj, }); @@ -2907,6 +3180,9 @@ export interface EventsDetectionJobProperties { } export namespace EventsDetectionJobProperties { + /** + * @internal + */ export const filterSensitiveLog = (obj: EventsDetectionJobProperties): any => ({ ...obj, }); @@ -2920,6 +3196,9 @@ export interface DescribeEventsDetectionJobResponse { } export namespace DescribeEventsDetectionJobResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeEventsDetectionJobResponse): any => ({ ...obj, }); @@ -2934,6 +3213,9 @@ export interface DescribeKeyPhrasesDetectionJobRequest { } export namespace DescribeKeyPhrasesDetectionJobRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeKeyPhrasesDetectionJobRequest): any => ({ ...obj, }); @@ -3024,6 +3306,9 @@ export interface KeyPhrasesDetectionJobProperties { } export namespace KeyPhrasesDetectionJobProperties { + /** + * @internal + */ export const filterSensitiveLog = (obj: KeyPhrasesDetectionJobProperties): any => ({ ...obj, }); @@ -3038,6 +3323,9 @@ export interface DescribeKeyPhrasesDetectionJobResponse { } export namespace DescribeKeyPhrasesDetectionJobResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeKeyPhrasesDetectionJobResponse): any => ({ ...obj, }); @@ -3052,6 +3340,9 @@ export interface DescribePiiEntitiesDetectionJobRequest { } export namespace DescribePiiEntitiesDetectionJobRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribePiiEntitiesDetectionJobRequest): any => ({ ...obj, }); @@ -3080,6 +3371,9 @@ export interface PiiOutputDataConfig { } export namespace PiiOutputDataConfig { + /** + * @internal + */ export const filterSensitiveLog = (obj: PiiOutputDataConfig): any => ({ ...obj, }); @@ -3113,6 +3407,9 @@ export interface RedactionConfig { } export namespace RedactionConfig { + /** + * @internal + */ export const filterSensitiveLog = (obj: RedactionConfig): any => ({ ...obj, }); @@ -3191,6 +3488,9 @@ export interface PiiEntitiesDetectionJobProperties { } export namespace PiiEntitiesDetectionJobProperties { + /** + * @internal + */ export const filterSensitiveLog = (obj: PiiEntitiesDetectionJobProperties): any => ({ ...obj, }); @@ -3204,6 +3504,9 @@ export interface DescribePiiEntitiesDetectionJobResponse { } export namespace DescribePiiEntitiesDetectionJobResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribePiiEntitiesDetectionJobResponse): any => ({ ...obj, }); @@ -3218,6 +3521,9 @@ export interface DescribeSentimentDetectionJobRequest { } export namespace DescribeSentimentDetectionJobRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeSentimentDetectionJobRequest): any => ({ ...obj, }); @@ -3308,6 +3614,9 @@ export interface SentimentDetectionJobProperties { } export namespace SentimentDetectionJobProperties { + /** + * @internal + */ export const filterSensitiveLog = (obj: SentimentDetectionJobProperties): any => ({ ...obj, }); @@ -3321,6 +3630,9 @@ export interface DescribeSentimentDetectionJobResponse { } export namespace DescribeSentimentDetectionJobResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeSentimentDetectionJobResponse): any => ({ ...obj, }); @@ -3334,6 +3646,9 @@ export interface DescribeTopicsDetectionJobRequest { } export namespace DescribeTopicsDetectionJobRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeTopicsDetectionJobRequest): any => ({ ...obj, }); @@ -3425,6 +3740,9 @@ export interface TopicsDetectionJobProperties { } export namespace TopicsDetectionJobProperties { + /** + * @internal + */ export const filterSensitiveLog = (obj: TopicsDetectionJobProperties): any => ({ ...obj, }); @@ -3438,6 +3756,9 @@ export interface DescribeTopicsDetectionJobResponse { } export namespace DescribeTopicsDetectionJobResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeTopicsDetectionJobResponse): any => ({ ...obj, }); @@ -3452,6 +3773,9 @@ export interface DetectDominantLanguageRequest { } export namespace DetectDominantLanguageRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DetectDominantLanguageRequest): any => ({ ...obj, ...(obj.Text && { Text: SENSITIVE_STRING }), @@ -3469,6 +3793,9 @@ export interface DetectDominantLanguageResponse { } export namespace DetectDominantLanguageResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DetectDominantLanguageResponse): any => ({ ...obj, }); @@ -3501,6 +3828,9 @@ export interface DetectEntitiesRequest { } export namespace DetectEntitiesRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DetectEntitiesRequest): any => ({ ...obj, ...(obj.Text && { Text: SENSITIVE_STRING }), @@ -3520,6 +3850,9 @@ export interface DetectEntitiesResponse { } export namespace DetectEntitiesResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DetectEntitiesResponse): any => ({ ...obj, }); @@ -3540,6 +3873,9 @@ export interface DetectKeyPhrasesRequest { } export namespace DetectKeyPhrasesRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DetectKeyPhrasesRequest): any => ({ ...obj, ...(obj.Text && { Text: SENSITIVE_STRING }), @@ -3557,6 +3893,9 @@ export interface DetectKeyPhrasesResponse { } export namespace DetectKeyPhrasesResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DetectKeyPhrasesResponse): any => ({ ...obj, }); @@ -3576,6 +3915,9 @@ export interface DetectPiiEntitiesRequest { } export namespace DetectPiiEntitiesRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DetectPiiEntitiesRequest): any => ({ ...obj, }); @@ -3615,6 +3957,9 @@ export interface PiiEntity { } export namespace PiiEntity { + /** + * @internal + */ export const filterSensitiveLog = (obj: PiiEntity): any => ({ ...obj, }); @@ -3630,6 +3975,9 @@ export interface DetectPiiEntitiesResponse { } export namespace DetectPiiEntitiesResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DetectPiiEntitiesResponse): any => ({ ...obj, }); @@ -3650,6 +3998,9 @@ export interface DetectSentimentRequest { } export namespace DetectSentimentRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DetectSentimentRequest): any => ({ ...obj, ...(obj.Text && { Text: SENSITIVE_STRING }), @@ -3671,6 +4022,9 @@ export interface DetectSentimentResponse { } export namespace DetectSentimentResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DetectSentimentResponse): any => ({ ...obj, }); @@ -3692,6 +4046,9 @@ export interface DetectSyntaxRequest { } export namespace DetectSyntaxRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DetectSyntaxRequest): any => ({ ...obj, ...(obj.Text && { Text: SENSITIVE_STRING }), @@ -3708,6 +4065,9 @@ export interface DetectSyntaxResponse { } export namespace DetectSyntaxResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DetectSyntaxResponse): any => ({ ...obj, }); @@ -3724,6 +4084,9 @@ export interface InvalidFilterException extends __SmithyException, $MetadataBear } export namespace InvalidFilterException { + /** + * @internal + */ export const filterSensitiveLog = (obj: InvalidFilterException): any => ({ ...obj, }); @@ -3761,6 +4124,9 @@ export interface DocumentClassificationJobFilter { } export namespace DocumentClassificationJobFilter { + /** + * @internal + */ export const filterSensitiveLog = (obj: DocumentClassificationJobFilter): any => ({ ...obj, }); @@ -3785,6 +4151,9 @@ export interface ListDocumentClassificationJobsRequest { } export namespace ListDocumentClassificationJobsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListDocumentClassificationJobsRequest): any => ({ ...obj, }); @@ -3803,6 +4172,9 @@ export interface ListDocumentClassificationJobsResponse { } export namespace ListDocumentClassificationJobsResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListDocumentClassificationJobsResponse): any => ({ ...obj, }); @@ -3834,6 +4206,9 @@ export interface DocumentClassifierFilter { } export namespace DocumentClassifierFilter { + /** + * @internal + */ export const filterSensitiveLog = (obj: DocumentClassifierFilter): any => ({ ...obj, }); @@ -3858,6 +4233,9 @@ export interface ListDocumentClassifiersRequest { } export namespace ListDocumentClassifiersRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListDocumentClassifiersRequest): any => ({ ...obj, }); @@ -3876,6 +4254,9 @@ export interface ListDocumentClassifiersResponse { } export namespace ListDocumentClassifiersResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListDocumentClassifiersResponse): any => ({ ...obj, ...(obj.DocumentClassifierPropertiesList && { @@ -3918,6 +4299,9 @@ export interface DominantLanguageDetectionJobFilter { } export namespace DominantLanguageDetectionJobFilter { + /** + * @internal + */ export const filterSensitiveLog = (obj: DominantLanguageDetectionJobFilter): any => ({ ...obj, }); @@ -3942,6 +4326,9 @@ export interface ListDominantLanguageDetectionJobsRequest { } export namespace ListDominantLanguageDetectionJobsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListDominantLanguageDetectionJobsRequest): any => ({ ...obj, }); @@ -3960,6 +4347,9 @@ export interface ListDominantLanguageDetectionJobsResponse { } export namespace ListDominantLanguageDetectionJobsResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListDominantLanguageDetectionJobsResponse): any => ({ ...obj, }); @@ -3994,6 +4384,9 @@ export interface EndpointFilter { } export namespace EndpointFilter { + /** + * @internal + */ export const filterSensitiveLog = (obj: EndpointFilter): any => ({ ...obj, }); @@ -4019,6 +4412,9 @@ export interface ListEndpointsRequest { } export namespace ListEndpointsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListEndpointsRequest): any => ({ ...obj, }); @@ -4038,6 +4434,9 @@ export interface ListEndpointsResponse { } export namespace ListEndpointsResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListEndpointsResponse): any => ({ ...obj, }); @@ -4075,6 +4474,9 @@ export interface EntitiesDetectionJobFilter { } export namespace EntitiesDetectionJobFilter { + /** + * @internal + */ export const filterSensitiveLog = (obj: EntitiesDetectionJobFilter): any => ({ ...obj, }); @@ -4099,6 +4501,9 @@ export interface ListEntitiesDetectionJobsRequest { } export namespace ListEntitiesDetectionJobsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListEntitiesDetectionJobsRequest): any => ({ ...obj, }); @@ -4117,6 +4522,9 @@ export interface ListEntitiesDetectionJobsResponse { } export namespace ListEntitiesDetectionJobsResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListEntitiesDetectionJobsResponse): any => ({ ...obj, }); @@ -4148,6 +4556,9 @@ export interface EntityRecognizerFilter { } export namespace EntityRecognizerFilter { + /** + * @internal + */ export const filterSensitiveLog = (obj: EntityRecognizerFilter): any => ({ ...obj, }); @@ -4173,6 +4584,9 @@ export interface ListEntityRecognizersRequest { } export namespace ListEntityRecognizersRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListEntityRecognizersRequest): any => ({ ...obj, }); @@ -4191,6 +4605,9 @@ export interface ListEntityRecognizersResponse { } export namespace ListEntityRecognizersResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListEntityRecognizersResponse): any => ({ ...obj, ...(obj.EntityRecognizerPropertiesList && { @@ -4232,6 +4649,9 @@ export interface EventsDetectionJobFilter { } export namespace EventsDetectionJobFilter { + /** + * @internal + */ export const filterSensitiveLog = (obj: EventsDetectionJobFilter): any => ({ ...obj, }); @@ -4256,6 +4676,9 @@ export interface ListEventsDetectionJobsRequest { } export namespace ListEventsDetectionJobsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListEventsDetectionJobsRequest): any => ({ ...obj, }); @@ -4274,6 +4697,9 @@ export interface ListEventsDetectionJobsResponse { } export namespace ListEventsDetectionJobsResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListEventsDetectionJobsResponse): any => ({ ...obj, }); @@ -4311,6 +4737,9 @@ export interface KeyPhrasesDetectionJobFilter { } export namespace KeyPhrasesDetectionJobFilter { + /** + * @internal + */ export const filterSensitiveLog = (obj: KeyPhrasesDetectionJobFilter): any => ({ ...obj, }); @@ -4335,6 +4764,9 @@ export interface ListKeyPhrasesDetectionJobsRequest { } export namespace ListKeyPhrasesDetectionJobsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListKeyPhrasesDetectionJobsRequest): any => ({ ...obj, }); @@ -4353,6 +4785,9 @@ export interface ListKeyPhrasesDetectionJobsResponse { } export namespace ListKeyPhrasesDetectionJobsResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListKeyPhrasesDetectionJobsResponse): any => ({ ...obj, }); @@ -4389,6 +4824,9 @@ export interface PiiEntitiesDetectionJobFilter { } export namespace PiiEntitiesDetectionJobFilter { + /** + * @internal + */ export const filterSensitiveLog = (obj: PiiEntitiesDetectionJobFilter): any => ({ ...obj, }); @@ -4413,6 +4851,9 @@ export interface ListPiiEntitiesDetectionJobsRequest { } export namespace ListPiiEntitiesDetectionJobsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListPiiEntitiesDetectionJobsRequest): any => ({ ...obj, }); @@ -4431,6 +4872,9 @@ export interface ListPiiEntitiesDetectionJobsResponse { } export namespace ListPiiEntitiesDetectionJobsResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListPiiEntitiesDetectionJobsResponse): any => ({ ...obj, }); @@ -4468,6 +4912,9 @@ export interface SentimentDetectionJobFilter { } export namespace SentimentDetectionJobFilter { + /** + * @internal + */ export const filterSensitiveLog = (obj: SentimentDetectionJobFilter): any => ({ ...obj, }); @@ -4492,6 +4939,9 @@ export interface ListSentimentDetectionJobsRequest { } export namespace ListSentimentDetectionJobsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListSentimentDetectionJobsRequest): any => ({ ...obj, }); @@ -4510,6 +4960,9 @@ export interface ListSentimentDetectionJobsResponse { } export namespace ListSentimentDetectionJobsResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListSentimentDetectionJobsResponse): any => ({ ...obj, }); @@ -4524,6 +4977,9 @@ export interface ListTagsForResourceRequest { } export namespace ListTagsForResourceRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListTagsForResourceRequest): any => ({ ...obj, }); @@ -4546,6 +5002,9 @@ export interface ListTagsForResourceResponse { } export namespace ListTagsForResourceResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListTagsForResourceResponse): any => ({ ...obj, }); @@ -4583,6 +5042,9 @@ export interface TopicsDetectionJobFilter { } export namespace TopicsDetectionJobFilter { + /** + * @internal + */ export const filterSensitiveLog = (obj: TopicsDetectionJobFilter): any => ({ ...obj, }); @@ -4607,6 +5069,9 @@ export interface ListTopicsDetectionJobsRequest { } export namespace ListTopicsDetectionJobsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListTopicsDetectionJobsRequest): any => ({ ...obj, }); @@ -4625,6 +5090,9 @@ export interface ListTopicsDetectionJobsResponse { } export namespace ListTopicsDetectionJobsResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListTopicsDetectionJobsResponse): any => ({ ...obj, }); @@ -4692,6 +5160,9 @@ export interface StartDocumentClassificationJobRequest { } export namespace StartDocumentClassificationJobRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: StartDocumentClassificationJobRequest): any => ({ ...obj, }); @@ -4732,6 +5203,9 @@ export interface StartDocumentClassificationJobResponse { } export namespace StartDocumentClassificationJobResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: StartDocumentClassificationJobResponse): any => ({ ...obj, }); @@ -4792,6 +5266,9 @@ export interface StartDominantLanguageDetectionJobRequest { } export namespace StartDominantLanguageDetectionJobRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: StartDominantLanguageDetectionJobRequest): any => ({ ...obj, }); @@ -4825,6 +5302,9 @@ export interface StartDominantLanguageDetectionJobResponse { } export namespace StartDominantLanguageDetectionJobResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: StartDominantLanguageDetectionJobResponse): any => ({ ...obj, }); @@ -4900,6 +5380,9 @@ export interface StartEntitiesDetectionJobRequest { } export namespace StartEntitiesDetectionJobRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: StartEntitiesDetectionJobRequest): any => ({ ...obj, }); @@ -4940,6 +5423,9 @@ export interface StartEntitiesDetectionJobResponse { } export namespace StartEntitiesDetectionJobResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: StartEntitiesDetectionJobResponse): any => ({ ...obj, }); @@ -4985,6 +5471,9 @@ export interface StartEventsDetectionJobRequest { } export namespace StartEventsDetectionJobRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: StartEventsDetectionJobRequest): any => ({ ...obj, }); @@ -5004,6 +5493,9 @@ export interface StartEventsDetectionJobResponse { } export namespace StartEventsDetectionJobResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: StartEventsDetectionJobResponse): any => ({ ...obj, }); @@ -5071,6 +5563,9 @@ export interface StartKeyPhrasesDetectionJobRequest { } export namespace StartKeyPhrasesDetectionJobRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: StartKeyPhrasesDetectionJobRequest): any => ({ ...obj, }); @@ -5104,6 +5599,9 @@ export interface StartKeyPhrasesDetectionJobResponse { } export namespace StartKeyPhrasesDetectionJobResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: StartKeyPhrasesDetectionJobResponse): any => ({ ...obj, }); @@ -5158,6 +5656,9 @@ export interface StartPiiEntitiesDetectionJobRequest { } export namespace StartPiiEntitiesDetectionJobRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: StartPiiEntitiesDetectionJobRequest): any => ({ ...obj, }); @@ -5176,6 +5677,9 @@ export interface StartPiiEntitiesDetectionJobResponse { } export namespace StartPiiEntitiesDetectionJobResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: StartPiiEntitiesDetectionJobResponse): any => ({ ...obj, }); @@ -5242,6 +5746,9 @@ export interface StartSentimentDetectionJobRequest { } export namespace StartSentimentDetectionJobRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: StartSentimentDetectionJobRequest): any => ({ ...obj, }); @@ -5275,6 +5782,9 @@ export interface StartSentimentDetectionJobResponse { } export namespace StartSentimentDetectionJobResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: StartSentimentDetectionJobResponse): any => ({ ...obj, }); @@ -5342,6 +5852,9 @@ export interface StartTopicsDetectionJobRequest { } export namespace StartTopicsDetectionJobRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: StartTopicsDetectionJobRequest): any => ({ ...obj, }); @@ -5377,6 +5890,9 @@ export interface StartTopicsDetectionJobResponse { } export namespace StartTopicsDetectionJobResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: StartTopicsDetectionJobResponse): any => ({ ...obj, }); @@ -5390,6 +5906,9 @@ export interface StopDominantLanguageDetectionJobRequest { } export namespace StopDominantLanguageDetectionJobRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: StopDominantLanguageDetectionJobRequest): any => ({ ...obj, }); @@ -5410,6 +5929,9 @@ export interface StopDominantLanguageDetectionJobResponse { } export namespace StopDominantLanguageDetectionJobResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: StopDominantLanguageDetectionJobResponse): any => ({ ...obj, }); @@ -5423,6 +5945,9 @@ export interface StopEntitiesDetectionJobRequest { } export namespace StopEntitiesDetectionJobRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: StopEntitiesDetectionJobRequest): any => ({ ...obj, }); @@ -5443,6 +5968,9 @@ export interface StopEntitiesDetectionJobResponse { } export namespace StopEntitiesDetectionJobResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: StopEntitiesDetectionJobResponse): any => ({ ...obj, }); @@ -5456,6 +5984,9 @@ export interface StopEventsDetectionJobRequest { } export namespace StopEventsDetectionJobRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: StopEventsDetectionJobRequest): any => ({ ...obj, }); @@ -5474,6 +6005,9 @@ export interface StopEventsDetectionJobResponse { } export namespace StopEventsDetectionJobResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: StopEventsDetectionJobResponse): any => ({ ...obj, }); @@ -5487,6 +6021,9 @@ export interface StopKeyPhrasesDetectionJobRequest { } export namespace StopKeyPhrasesDetectionJobRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: StopKeyPhrasesDetectionJobRequest): any => ({ ...obj, }); @@ -5507,6 +6044,9 @@ export interface StopKeyPhrasesDetectionJobResponse { } export namespace StopKeyPhrasesDetectionJobResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: StopKeyPhrasesDetectionJobResponse): any => ({ ...obj, }); @@ -5520,6 +6060,9 @@ export interface StopPiiEntitiesDetectionJobRequest { } export namespace StopPiiEntitiesDetectionJobRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: StopPiiEntitiesDetectionJobRequest): any => ({ ...obj, }); @@ -5538,6 +6081,9 @@ export interface StopPiiEntitiesDetectionJobResponse { } export namespace StopPiiEntitiesDetectionJobResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: StopPiiEntitiesDetectionJobResponse): any => ({ ...obj, }); @@ -5551,6 +6097,9 @@ export interface StopSentimentDetectionJobRequest { } export namespace StopSentimentDetectionJobRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: StopSentimentDetectionJobRequest): any => ({ ...obj, }); @@ -5571,6 +6120,9 @@ export interface StopSentimentDetectionJobResponse { } export namespace StopSentimentDetectionJobResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: StopSentimentDetectionJobResponse): any => ({ ...obj, }); @@ -5585,6 +6137,9 @@ export interface StopTrainingDocumentClassifierRequest { } export namespace StopTrainingDocumentClassifierRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: StopTrainingDocumentClassifierRequest): any => ({ ...obj, }); @@ -5593,6 +6148,9 @@ export namespace StopTrainingDocumentClassifierRequest { export interface StopTrainingDocumentClassifierResponse {} export namespace StopTrainingDocumentClassifierResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: StopTrainingDocumentClassifierResponse): any => ({ ...obj, }); @@ -5607,6 +6165,9 @@ export interface StopTrainingEntityRecognizerRequest { } export namespace StopTrainingEntityRecognizerRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: StopTrainingEntityRecognizerRequest): any => ({ ...obj, }); @@ -5615,6 +6176,9 @@ export namespace StopTrainingEntityRecognizerRequest { export interface StopTrainingEntityRecognizerResponse {} export namespace StopTrainingEntityRecognizerResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: StopTrainingEntityRecognizerResponse): any => ({ ...obj, }); @@ -5631,6 +6195,9 @@ export interface ConcurrentModificationException extends __SmithyException, $Met } export namespace ConcurrentModificationException { + /** + * @internal + */ export const filterSensitiveLog = (obj: ConcurrentModificationException): any => ({ ...obj, }); @@ -5651,6 +6218,9 @@ export interface TagResourceRequest { } export namespace TagResourceRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: TagResourceRequest): any => ({ ...obj, }); @@ -5659,6 +6229,9 @@ export namespace TagResourceRequest { export interface TagResourceResponse {} export namespace TagResourceResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: TagResourceResponse): any => ({ ...obj, }); @@ -5675,6 +6248,9 @@ export interface TooManyTagKeysException extends __SmithyException, $MetadataBea } export namespace TooManyTagKeysException { + /** + * @internal + */ export const filterSensitiveLog = (obj: TooManyTagKeysException): any => ({ ...obj, }); @@ -5697,6 +6273,9 @@ export interface UntagResourceRequest { } export namespace UntagResourceRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: UntagResourceRequest): any => ({ ...obj, }); @@ -5705,6 +6284,9 @@ export namespace UntagResourceRequest { export interface UntagResourceResponse {} export namespace UntagResourceResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: UntagResourceResponse): any => ({ ...obj, }); @@ -5725,6 +6307,9 @@ export interface UpdateEndpointRequest { } export namespace UpdateEndpointRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateEndpointRequest): any => ({ ...obj, }); @@ -5733,6 +6318,9 @@ export namespace UpdateEndpointRequest { export interface UpdateEndpointResponse {} export namespace UpdateEndpointResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateEndpointResponse): any => ({ ...obj, }); diff --git a/clients/client-comprehendmedical/commands/DescribeEntitiesDetectionV2JobCommand.ts b/clients/client-comprehendmedical/commands/DescribeEntitiesDetectionV2JobCommand.ts index d3cd7869a844..3f19c0acbd3a 100644 --- a/clients/client-comprehendmedical/commands/DescribeEntitiesDetectionV2JobCommand.ts +++ b/clients/client-comprehendmedical/commands/DescribeEntitiesDetectionV2JobCommand.ts @@ -29,6 +29,20 @@ export interface DescribeEntitiesDetectionV2JobCommandOutput /** *

Gets the properties associated with a medical entities detection job. Use this operation * to get the status of a detection job.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ComprehendMedicalClient, DescribeEntitiesDetectionV2JobCommand } from "@aws-sdk/client-comprehendmedical"; // ES Modules import + * // const { ComprehendMedicalClient, DescribeEntitiesDetectionV2JobCommand } = require("@aws-sdk/client-comprehendmedical"); // CommonJS import + * const client = new ComprehendMedicalClient(config); + * const command = new DescribeEntitiesDetectionV2JobCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeEntitiesDetectionV2JobCommandInput} for command's `input` shape. + * @see {@link DescribeEntitiesDetectionV2JobCommandOutput} for command's `response` shape. + * @see {@link ComprehendMedicalClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeEntitiesDetectionV2JobCommand extends $Command< DescribeEntitiesDetectionV2JobCommandInput, diff --git a/clients/client-comprehendmedical/commands/DescribeICD10CMInferenceJobCommand.ts b/clients/client-comprehendmedical/commands/DescribeICD10CMInferenceJobCommand.ts index 25636cb389c5..c42d3f1634cc 100644 --- a/clients/client-comprehendmedical/commands/DescribeICD10CMInferenceJobCommand.ts +++ b/clients/client-comprehendmedical/commands/DescribeICD10CMInferenceJobCommand.ts @@ -29,6 +29,20 @@ export interface DescribeICD10CMInferenceJobCommandOutput /** *

Gets the properties associated with an InferICD10CM job. Use this operation to get the * status of an inference job.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ComprehendMedicalClient, DescribeICD10CMInferenceJobCommand } from "@aws-sdk/client-comprehendmedical"; // ES Modules import + * // const { ComprehendMedicalClient, DescribeICD10CMInferenceJobCommand } = require("@aws-sdk/client-comprehendmedical"); // CommonJS import + * const client = new ComprehendMedicalClient(config); + * const command = new DescribeICD10CMInferenceJobCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeICD10CMInferenceJobCommandInput} for command's `input` shape. + * @see {@link DescribeICD10CMInferenceJobCommandOutput} for command's `response` shape. + * @see {@link ComprehendMedicalClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeICD10CMInferenceJobCommand extends $Command< DescribeICD10CMInferenceJobCommandInput, diff --git a/clients/client-comprehendmedical/commands/DescribePHIDetectionJobCommand.ts b/clients/client-comprehendmedical/commands/DescribePHIDetectionJobCommand.ts index af99f221b480..8d0b607697e8 100644 --- a/clients/client-comprehendmedical/commands/DescribePHIDetectionJobCommand.ts +++ b/clients/client-comprehendmedical/commands/DescribePHIDetectionJobCommand.ts @@ -27,6 +27,20 @@ export interface DescribePHIDetectionJobCommandOutput extends DescribePHIDetecti /** *

Gets the properties associated with a protected health information (PHI) detection job. * Use this operation to get the status of a detection job.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ComprehendMedicalClient, DescribePHIDetectionJobCommand } from "@aws-sdk/client-comprehendmedical"; // ES Modules import + * // const { ComprehendMedicalClient, DescribePHIDetectionJobCommand } = require("@aws-sdk/client-comprehendmedical"); // CommonJS import + * const client = new ComprehendMedicalClient(config); + * const command = new DescribePHIDetectionJobCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribePHIDetectionJobCommandInput} for command's `input` shape. + * @see {@link DescribePHIDetectionJobCommandOutput} for command's `response` shape. + * @see {@link ComprehendMedicalClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribePHIDetectionJobCommand extends $Command< DescribePHIDetectionJobCommandInput, diff --git a/clients/client-comprehendmedical/commands/DescribeRxNormInferenceJobCommand.ts b/clients/client-comprehendmedical/commands/DescribeRxNormInferenceJobCommand.ts index 8e59558b602f..ca881e283b75 100644 --- a/clients/client-comprehendmedical/commands/DescribeRxNormInferenceJobCommand.ts +++ b/clients/client-comprehendmedical/commands/DescribeRxNormInferenceJobCommand.ts @@ -27,6 +27,20 @@ export interface DescribeRxNormInferenceJobCommandOutput extends DescribeRxNormI /** *

Gets the properties associated with an InferRxNorm job. Use this operation to get the * status of an inference job.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ComprehendMedicalClient, DescribeRxNormInferenceJobCommand } from "@aws-sdk/client-comprehendmedical"; // ES Modules import + * // const { ComprehendMedicalClient, DescribeRxNormInferenceJobCommand } = require("@aws-sdk/client-comprehendmedical"); // CommonJS import + * const client = new ComprehendMedicalClient(config); + * const command = new DescribeRxNormInferenceJobCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeRxNormInferenceJobCommandInput} for command's `input` shape. + * @see {@link DescribeRxNormInferenceJobCommandOutput} for command's `response` shape. + * @see {@link ComprehendMedicalClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeRxNormInferenceJobCommand extends $Command< DescribeRxNormInferenceJobCommandInput, diff --git a/clients/client-comprehendmedical/commands/DetectEntitiesCommand.ts b/clients/client-comprehendmedical/commands/DetectEntitiesCommand.ts index 396894da5dc2..9ae4aff2e7d4 100644 --- a/clients/client-comprehendmedical/commands/DetectEntitiesCommand.ts +++ b/clients/client-comprehendmedical/commands/DetectEntitiesCommand.ts @@ -31,6 +31,20 @@ export interface DetectEntitiesCommandOutput extends DetectEntitiesResponse, __M *

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 .

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ComprehendMedicalClient, DetectEntitiesCommand } from "@aws-sdk/client-comprehendmedical"; // ES Modules import + * // const { ComprehendMedicalClient, DetectEntitiesCommand } = require("@aws-sdk/client-comprehendmedical"); // CommonJS import + * const client = new ComprehendMedicalClient(config); + * const command = new DetectEntitiesCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DetectEntitiesCommandInput} for command's `input` shape. + * @see {@link DetectEntitiesCommandOutput} for command's `response` shape. + * @see {@link ComprehendMedicalClientResolvedConfig | config} for command's `input` shape. + * */ export class DetectEntitiesCommand extends $Command< DetectEntitiesCommandInput, diff --git a/clients/client-comprehendmedical/commands/DetectEntitiesV2Command.ts b/clients/client-comprehendmedical/commands/DetectEntitiesV2Command.ts index c4a672ed344b..88de6c0536fe 100644 --- a/clients/client-comprehendmedical/commands/DetectEntitiesV2Command.ts +++ b/clients/client-comprehendmedical/commands/DetectEntitiesV2Command.ts @@ -35,6 +35,20 @@ export interface DetectEntitiesV2CommandOutput extends DetectEntitiesV2Response, * DetectEntitiesV2 operation in all new applications.

*

The DetectEntitiesV2 operation returns the Acuity and * Direction entities as attributes instead of types.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ComprehendMedicalClient, DetectEntitiesV2Command } from "@aws-sdk/client-comprehendmedical"; // ES Modules import + * // const { ComprehendMedicalClient, DetectEntitiesV2Command } = require("@aws-sdk/client-comprehendmedical"); // CommonJS import + * const client = new ComprehendMedicalClient(config); + * const command = new DetectEntitiesV2Command(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DetectEntitiesV2CommandInput} for command's `input` shape. + * @see {@link DetectEntitiesV2CommandOutput} for command's `response` shape. + * @see {@link ComprehendMedicalClientResolvedConfig | config} for command's `input` shape. + * */ export class DetectEntitiesV2Command extends $Command< DetectEntitiesV2CommandInput, diff --git a/clients/client-comprehendmedical/commands/DetectPHICommand.ts b/clients/client-comprehendmedical/commands/DetectPHICommand.ts index 0263b56b53e1..9450fd0e727d 100644 --- a/clients/client-comprehendmedical/commands/DetectPHICommand.ts +++ b/clients/client-comprehendmedical/commands/DetectPHICommand.ts @@ -25,6 +25,20 @@ export interface DetectPHICommandOutput extends DetectPHIResponse, __MetadataBea *

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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ComprehendMedicalClient, DetectPHICommand } from "@aws-sdk/client-comprehendmedical"; // ES Modules import + * // const { ComprehendMedicalClient, DetectPHICommand } = require("@aws-sdk/client-comprehendmedical"); // CommonJS import + * const client = new ComprehendMedicalClient(config); + * const command = new DetectPHICommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DetectPHICommandInput} for command's `input` shape. + * @see {@link DetectPHICommandOutput} for command's `response` shape. + * @see {@link ComprehendMedicalClientResolvedConfig | config} for command's `input` shape. + * */ export class DetectPHICommand extends $Command< DetectPHICommandInput, diff --git a/clients/client-comprehendmedical/commands/InferICD10CMCommand.ts b/clients/client-comprehendmedical/commands/InferICD10CMCommand.ts index 57625d145e78..42e5eb62195c 100644 --- a/clients/client-comprehendmedical/commands/InferICD10CMCommand.ts +++ b/clients/client-comprehendmedical/commands/InferICD10CMCommand.ts @@ -29,6 +29,20 @@ export interface InferICD10CMCommandOutput extends InferICD10CMResponse, __Metad * 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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ComprehendMedicalClient, InferICD10CMCommand } from "@aws-sdk/client-comprehendmedical"; // ES Modules import + * // const { ComprehendMedicalClient, InferICD10CMCommand } = require("@aws-sdk/client-comprehendmedical"); // CommonJS import + * const client = new ComprehendMedicalClient(config); + * const command = new InferICD10CMCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link InferICD10CMCommandInput} for command's `input` shape. + * @see {@link InferICD10CMCommandOutput} for command's `response` shape. + * @see {@link ComprehendMedicalClientResolvedConfig | config} for command's `input` shape. + * */ export class InferICD10CMCommand extends $Command< InferICD10CMCommandInput, diff --git a/clients/client-comprehendmedical/commands/InferRxNormCommand.ts b/clients/client-comprehendmedical/commands/InferRxNormCommand.ts index d3bd6c8f0598..7dd8a1774879 100644 --- a/clients/client-comprehendmedical/commands/InferRxNormCommand.ts +++ b/clients/client-comprehendmedical/commands/InferRxNormCommand.ts @@ -28,6 +28,20 @@ export interface InferRxNormCommandOutput extends InferRxNormResponse, __Metadat *

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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ComprehendMedicalClient, InferRxNormCommand } from "@aws-sdk/client-comprehendmedical"; // ES Modules import + * // const { ComprehendMedicalClient, InferRxNormCommand } = require("@aws-sdk/client-comprehendmedical"); // CommonJS import + * const client = new ComprehendMedicalClient(config); + * const command = new InferRxNormCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link InferRxNormCommandInput} for command's `input` shape. + * @see {@link InferRxNormCommandOutput} for command's `response` shape. + * @see {@link ComprehendMedicalClientResolvedConfig | config} for command's `input` shape. + * */ export class InferRxNormCommand extends $Command< InferRxNormCommandInput, diff --git a/clients/client-comprehendmedical/commands/ListEntitiesDetectionV2JobsCommand.ts b/clients/client-comprehendmedical/commands/ListEntitiesDetectionV2JobsCommand.ts index 6d3a830777fe..088cb92fb901 100644 --- a/clients/client-comprehendmedical/commands/ListEntitiesDetectionV2JobsCommand.ts +++ b/clients/client-comprehendmedical/commands/ListEntitiesDetectionV2JobsCommand.ts @@ -28,6 +28,20 @@ export interface ListEntitiesDetectionV2JobsCommandOutput /** *

Gets a list of medical entity detection jobs that you have submitted.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ComprehendMedicalClient, ListEntitiesDetectionV2JobsCommand } from "@aws-sdk/client-comprehendmedical"; // ES Modules import + * // const { ComprehendMedicalClient, ListEntitiesDetectionV2JobsCommand } = require("@aws-sdk/client-comprehendmedical"); // CommonJS import + * const client = new ComprehendMedicalClient(config); + * const command = new ListEntitiesDetectionV2JobsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListEntitiesDetectionV2JobsCommandInput} for command's `input` shape. + * @see {@link ListEntitiesDetectionV2JobsCommandOutput} for command's `response` shape. + * @see {@link ComprehendMedicalClientResolvedConfig | config} for command's `input` shape. + * */ export class ListEntitiesDetectionV2JobsCommand extends $Command< ListEntitiesDetectionV2JobsCommandInput, diff --git a/clients/client-comprehendmedical/commands/ListICD10CMInferenceJobsCommand.ts b/clients/client-comprehendmedical/commands/ListICD10CMInferenceJobsCommand.ts index 916539bd9dcb..e40b4718f486 100644 --- a/clients/client-comprehendmedical/commands/ListICD10CMInferenceJobsCommand.ts +++ b/clients/client-comprehendmedical/commands/ListICD10CMInferenceJobsCommand.ts @@ -26,6 +26,20 @@ export interface ListICD10CMInferenceJobsCommandOutput extends ListICD10CMInfere /** *

Gets a list of InferICD10CM jobs that you have submitted.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ComprehendMedicalClient, ListICD10CMInferenceJobsCommand } from "@aws-sdk/client-comprehendmedical"; // ES Modules import + * // const { ComprehendMedicalClient, ListICD10CMInferenceJobsCommand } = require("@aws-sdk/client-comprehendmedical"); // CommonJS import + * const client = new ComprehendMedicalClient(config); + * const command = new ListICD10CMInferenceJobsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListICD10CMInferenceJobsCommandInput} for command's `input` shape. + * @see {@link ListICD10CMInferenceJobsCommandOutput} for command's `response` shape. + * @see {@link ComprehendMedicalClientResolvedConfig | config} for command's `input` shape. + * */ export class ListICD10CMInferenceJobsCommand extends $Command< ListICD10CMInferenceJobsCommandInput, diff --git a/clients/client-comprehendmedical/commands/ListPHIDetectionJobsCommand.ts b/clients/client-comprehendmedical/commands/ListPHIDetectionJobsCommand.ts index 41a5a91f38dc..6a6d6a9a05c8 100644 --- a/clients/client-comprehendmedical/commands/ListPHIDetectionJobsCommand.ts +++ b/clients/client-comprehendmedical/commands/ListPHIDetectionJobsCommand.ts @@ -27,6 +27,20 @@ export interface ListPHIDetectionJobsCommandOutput extends ListPHIDetectionJobsR /** *

Gets a list of protected health information (PHI) detection jobs that you have * submitted.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ComprehendMedicalClient, ListPHIDetectionJobsCommand } from "@aws-sdk/client-comprehendmedical"; // ES Modules import + * // const { ComprehendMedicalClient, ListPHIDetectionJobsCommand } = require("@aws-sdk/client-comprehendmedical"); // CommonJS import + * const client = new ComprehendMedicalClient(config); + * const command = new ListPHIDetectionJobsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListPHIDetectionJobsCommandInput} for command's `input` shape. + * @see {@link ListPHIDetectionJobsCommandOutput} for command's `response` shape. + * @see {@link ComprehendMedicalClientResolvedConfig | config} for command's `input` shape. + * */ export class ListPHIDetectionJobsCommand extends $Command< ListPHIDetectionJobsCommandInput, diff --git a/clients/client-comprehendmedical/commands/ListRxNormInferenceJobsCommand.ts b/clients/client-comprehendmedical/commands/ListRxNormInferenceJobsCommand.ts index 47329ed0c3ad..874b1a3eae0b 100644 --- a/clients/client-comprehendmedical/commands/ListRxNormInferenceJobsCommand.ts +++ b/clients/client-comprehendmedical/commands/ListRxNormInferenceJobsCommand.ts @@ -26,6 +26,20 @@ export interface ListRxNormInferenceJobsCommandOutput extends ListRxNormInferenc /** *

Gets a list of InferRxNorm jobs that you have submitted.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ComprehendMedicalClient, ListRxNormInferenceJobsCommand } from "@aws-sdk/client-comprehendmedical"; // ES Modules import + * // const { ComprehendMedicalClient, ListRxNormInferenceJobsCommand } = require("@aws-sdk/client-comprehendmedical"); // CommonJS import + * const client = new ComprehendMedicalClient(config); + * const command = new ListRxNormInferenceJobsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListRxNormInferenceJobsCommandInput} for command's `input` shape. + * @see {@link ListRxNormInferenceJobsCommandOutput} for command's `response` shape. + * @see {@link ComprehendMedicalClientResolvedConfig | config} for command's `input` shape. + * */ export class ListRxNormInferenceJobsCommand extends $Command< ListRxNormInferenceJobsCommandInput, diff --git a/clients/client-comprehendmedical/commands/StartEntitiesDetectionV2JobCommand.ts b/clients/client-comprehendmedical/commands/StartEntitiesDetectionV2JobCommand.ts index 828e9057704b..36491d923da0 100644 --- a/clients/client-comprehendmedical/commands/StartEntitiesDetectionV2JobCommand.ts +++ b/clients/client-comprehendmedical/commands/StartEntitiesDetectionV2JobCommand.ts @@ -29,6 +29,20 @@ export interface StartEntitiesDetectionV2JobCommandOutput /** *

Starts an asynchronous medical entity detection job for a collection of documents. Use the * DescribeEntitiesDetectionV2Job operation to track the status of a job.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ComprehendMedicalClient, StartEntitiesDetectionV2JobCommand } from "@aws-sdk/client-comprehendmedical"; // ES Modules import + * // const { ComprehendMedicalClient, StartEntitiesDetectionV2JobCommand } = require("@aws-sdk/client-comprehendmedical"); // CommonJS import + * const client = new ComprehendMedicalClient(config); + * const command = new StartEntitiesDetectionV2JobCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link StartEntitiesDetectionV2JobCommandInput} for command's `input` shape. + * @see {@link StartEntitiesDetectionV2JobCommandOutput} for command's `response` shape. + * @see {@link ComprehendMedicalClientResolvedConfig | config} for command's `input` shape. + * */ export class StartEntitiesDetectionV2JobCommand extends $Command< StartEntitiesDetectionV2JobCommandInput, diff --git a/clients/client-comprehendmedical/commands/StartICD10CMInferenceJobCommand.ts b/clients/client-comprehendmedical/commands/StartICD10CMInferenceJobCommand.ts index a2f65a703b4a..68bd7bc545aa 100644 --- a/clients/client-comprehendmedical/commands/StartICD10CMInferenceJobCommand.ts +++ b/clients/client-comprehendmedical/commands/StartICD10CMInferenceJobCommand.ts @@ -28,6 +28,20 @@ export interface StartICD10CMInferenceJobCommandOutput extends StartICD10CMInfer *

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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ComprehendMedicalClient, StartICD10CMInferenceJobCommand } from "@aws-sdk/client-comprehendmedical"; // ES Modules import + * // const { ComprehendMedicalClient, StartICD10CMInferenceJobCommand } = require("@aws-sdk/client-comprehendmedical"); // CommonJS import + * const client = new ComprehendMedicalClient(config); + * const command = new StartICD10CMInferenceJobCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link StartICD10CMInferenceJobCommandInput} for command's `input` shape. + * @see {@link StartICD10CMInferenceJobCommandOutput} for command's `response` shape. + * @see {@link ComprehendMedicalClientResolvedConfig | config} for command's `input` shape. + * */ export class StartICD10CMInferenceJobCommand extends $Command< StartICD10CMInferenceJobCommandInput, diff --git a/clients/client-comprehendmedical/commands/StartPHIDetectionJobCommand.ts b/clients/client-comprehendmedical/commands/StartPHIDetectionJobCommand.ts index 75139ed6b6eb..92db2ad8ac54 100644 --- a/clients/client-comprehendmedical/commands/StartPHIDetectionJobCommand.ts +++ b/clients/client-comprehendmedical/commands/StartPHIDetectionJobCommand.ts @@ -27,6 +27,20 @@ export interface StartPHIDetectionJobCommandOutput extends StartPHIDetectionJobR /** *

Starts an asynchronous job to detect protected health information (PHI). Use the * DescribePHIDetectionJob operation to track the status of a job.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ComprehendMedicalClient, StartPHIDetectionJobCommand } from "@aws-sdk/client-comprehendmedical"; // ES Modules import + * // const { ComprehendMedicalClient, StartPHIDetectionJobCommand } = require("@aws-sdk/client-comprehendmedical"); // CommonJS import + * const client = new ComprehendMedicalClient(config); + * const command = new StartPHIDetectionJobCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link StartPHIDetectionJobCommandInput} for command's `input` shape. + * @see {@link StartPHIDetectionJobCommandOutput} for command's `response` shape. + * @see {@link ComprehendMedicalClientResolvedConfig | config} for command's `input` shape. + * */ export class StartPHIDetectionJobCommand extends $Command< StartPHIDetectionJobCommandInput, diff --git a/clients/client-comprehendmedical/commands/StartRxNormInferenceJobCommand.ts b/clients/client-comprehendmedical/commands/StartRxNormInferenceJobCommand.ts index 730ddc20964f..a4e7d5a97346 100644 --- a/clients/client-comprehendmedical/commands/StartRxNormInferenceJobCommand.ts +++ b/clients/client-comprehendmedical/commands/StartRxNormInferenceJobCommand.ts @@ -28,6 +28,20 @@ export interface StartRxNormInferenceJobCommandOutput extends StartRxNormInferen *

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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ComprehendMedicalClient, StartRxNormInferenceJobCommand } from "@aws-sdk/client-comprehendmedical"; // ES Modules import + * // const { ComprehendMedicalClient, StartRxNormInferenceJobCommand } = require("@aws-sdk/client-comprehendmedical"); // CommonJS import + * const client = new ComprehendMedicalClient(config); + * const command = new StartRxNormInferenceJobCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link StartRxNormInferenceJobCommandInput} for command's `input` shape. + * @see {@link StartRxNormInferenceJobCommandOutput} for command's `response` shape. + * @see {@link ComprehendMedicalClientResolvedConfig | config} for command's `input` shape. + * */ export class StartRxNormInferenceJobCommand extends $Command< StartRxNormInferenceJobCommandInput, diff --git a/clients/client-comprehendmedical/commands/StopEntitiesDetectionV2JobCommand.ts b/clients/client-comprehendmedical/commands/StopEntitiesDetectionV2JobCommand.ts index 6d4c08fe9b71..6c0487237747 100644 --- a/clients/client-comprehendmedical/commands/StopEntitiesDetectionV2JobCommand.ts +++ b/clients/client-comprehendmedical/commands/StopEntitiesDetectionV2JobCommand.ts @@ -26,6 +26,20 @@ export interface StopEntitiesDetectionV2JobCommandOutput extends StopEntitiesDet /** *

Stops a medical entities detection job in progress.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ComprehendMedicalClient, StopEntitiesDetectionV2JobCommand } from "@aws-sdk/client-comprehendmedical"; // ES Modules import + * // const { ComprehendMedicalClient, StopEntitiesDetectionV2JobCommand } = require("@aws-sdk/client-comprehendmedical"); // CommonJS import + * const client = new ComprehendMedicalClient(config); + * const command = new StopEntitiesDetectionV2JobCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link StopEntitiesDetectionV2JobCommandInput} for command's `input` shape. + * @see {@link StopEntitiesDetectionV2JobCommandOutput} for command's `response` shape. + * @see {@link ComprehendMedicalClientResolvedConfig | config} for command's `input` shape. + * */ export class StopEntitiesDetectionV2JobCommand extends $Command< StopEntitiesDetectionV2JobCommandInput, diff --git a/clients/client-comprehendmedical/commands/StopICD10CMInferenceJobCommand.ts b/clients/client-comprehendmedical/commands/StopICD10CMInferenceJobCommand.ts index 9921e6c5bf9f..9f4cfdc5f405 100644 --- a/clients/client-comprehendmedical/commands/StopICD10CMInferenceJobCommand.ts +++ b/clients/client-comprehendmedical/commands/StopICD10CMInferenceJobCommand.ts @@ -26,6 +26,20 @@ export interface StopICD10CMInferenceJobCommandOutput extends StopICD10CMInferen /** *

Stops an InferICD10CM inference job in progress.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ComprehendMedicalClient, StopICD10CMInferenceJobCommand } from "@aws-sdk/client-comprehendmedical"; // ES Modules import + * // const { ComprehendMedicalClient, StopICD10CMInferenceJobCommand } = require("@aws-sdk/client-comprehendmedical"); // CommonJS import + * const client = new ComprehendMedicalClient(config); + * const command = new StopICD10CMInferenceJobCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link StopICD10CMInferenceJobCommandInput} for command's `input` shape. + * @see {@link StopICD10CMInferenceJobCommandOutput} for command's `response` shape. + * @see {@link ComprehendMedicalClientResolvedConfig | config} for command's `input` shape. + * */ export class StopICD10CMInferenceJobCommand extends $Command< StopICD10CMInferenceJobCommandInput, diff --git a/clients/client-comprehendmedical/commands/StopPHIDetectionJobCommand.ts b/clients/client-comprehendmedical/commands/StopPHIDetectionJobCommand.ts index b2d60c92a209..9e70839fda0b 100644 --- a/clients/client-comprehendmedical/commands/StopPHIDetectionJobCommand.ts +++ b/clients/client-comprehendmedical/commands/StopPHIDetectionJobCommand.ts @@ -26,6 +26,20 @@ export interface StopPHIDetectionJobCommandOutput extends StopPHIDetectionJobRes /** *

Stops a protected health information (PHI) detection job in progress.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ComprehendMedicalClient, StopPHIDetectionJobCommand } from "@aws-sdk/client-comprehendmedical"; // ES Modules import + * // const { ComprehendMedicalClient, StopPHIDetectionJobCommand } = require("@aws-sdk/client-comprehendmedical"); // CommonJS import + * const client = new ComprehendMedicalClient(config); + * const command = new StopPHIDetectionJobCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link StopPHIDetectionJobCommandInput} for command's `input` shape. + * @see {@link StopPHIDetectionJobCommandOutput} for command's `response` shape. + * @see {@link ComprehendMedicalClientResolvedConfig | config} for command's `input` shape. + * */ export class StopPHIDetectionJobCommand extends $Command< StopPHIDetectionJobCommandInput, diff --git a/clients/client-comprehendmedical/commands/StopRxNormInferenceJobCommand.ts b/clients/client-comprehendmedical/commands/StopRxNormInferenceJobCommand.ts index 2a3a884b9c08..f90b32cf5bf2 100644 --- a/clients/client-comprehendmedical/commands/StopRxNormInferenceJobCommand.ts +++ b/clients/client-comprehendmedical/commands/StopRxNormInferenceJobCommand.ts @@ -26,6 +26,20 @@ export interface StopRxNormInferenceJobCommandOutput extends StopRxNormInference /** *

Stops an InferRxNorm inference job in progress.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ComprehendMedicalClient, StopRxNormInferenceJobCommand } from "@aws-sdk/client-comprehendmedical"; // ES Modules import + * // const { ComprehendMedicalClient, StopRxNormInferenceJobCommand } = require("@aws-sdk/client-comprehendmedical"); // CommonJS import + * const client = new ComprehendMedicalClient(config); + * const command = new StopRxNormInferenceJobCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link StopRxNormInferenceJobCommandInput} for command's `input` shape. + * @see {@link StopRxNormInferenceJobCommandOutput} for command's `response` shape. + * @see {@link ComprehendMedicalClientResolvedConfig | config} for command's `input` shape. + * */ export class StopRxNormInferenceJobCommand extends $Command< StopRxNormInferenceJobCommandInput, diff --git a/clients/client-comprehendmedical/models/models_0.ts b/clients/client-comprehendmedical/models/models_0.ts index a68cae597ba2..a7dd1b91c358 100644 --- a/clients/client-comprehendmedical/models/models_0.ts +++ b/clients/client-comprehendmedical/models/models_0.ts @@ -54,6 +54,9 @@ export interface Trait { } export namespace Trait { + /** + * @internal + */ export const filterSensitiveLog = (obj: Trait): any => ({ ...obj, }); @@ -162,6 +165,9 @@ export interface Attribute { } export namespace Attribute { + /** + * @internal + */ export const filterSensitiveLog = (obj: Attribute): any => ({ ...obj, }); @@ -177,6 +183,9 @@ export interface DescribeEntitiesDetectionV2JobRequest { } export namespace DescribeEntitiesDetectionV2JobRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeEntitiesDetectionV2JobRequest): any => ({ ...obj, }); @@ -202,6 +211,9 @@ export interface InputDataConfig { } export namespace InputDataConfig { + /** + * @internal + */ export const filterSensitiveLog = (obj: InputDataConfig): any => ({ ...obj, }); @@ -242,6 +254,9 @@ export interface OutputDataConfig { } export namespace OutputDataConfig { + /** + * @internal + */ export const filterSensitiveLog = (obj: OutputDataConfig): any => ({ ...obj, }); @@ -329,6 +344,9 @@ export interface ComprehendMedicalAsyncJobProperties { } export namespace ComprehendMedicalAsyncJobProperties { + /** + * @internal + */ export const filterSensitiveLog = (obj: ComprehendMedicalAsyncJobProperties): any => ({ ...obj, }); @@ -342,6 +360,9 @@ export interface DescribeEntitiesDetectionV2JobResponse { } export namespace DescribeEntitiesDetectionV2JobResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeEntitiesDetectionV2JobResponse): any => ({ ...obj, }); @@ -357,6 +378,9 @@ export interface InternalServerException extends __SmithyException, $MetadataBea } export namespace InternalServerException { + /** + * @internal + */ export const filterSensitiveLog = (obj: InternalServerException): any => ({ ...obj, }); @@ -373,6 +397,9 @@ export interface InvalidRequestException extends __SmithyException, $MetadataBea } export namespace InvalidRequestException { + /** + * @internal + */ export const filterSensitiveLog = (obj: InvalidRequestException): any => ({ ...obj, }); @@ -389,6 +416,9 @@ export interface ResourceNotFoundException extends __SmithyException, $MetadataB } export namespace ResourceNotFoundException { + /** + * @internal + */ export const filterSensitiveLog = (obj: ResourceNotFoundException): any => ({ ...obj, }); @@ -406,6 +436,9 @@ export interface TooManyRequestsException extends __SmithyException, $MetadataBe } export namespace TooManyRequestsException { + /** + * @internal + */ export const filterSensitiveLog = (obj: TooManyRequestsException): any => ({ ...obj, }); @@ -420,6 +453,9 @@ export interface DescribeICD10CMInferenceJobRequest { } export namespace DescribeICD10CMInferenceJobRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeICD10CMInferenceJobRequest): any => ({ ...obj, }); @@ -433,6 +469,9 @@ export interface DescribeICD10CMInferenceJobResponse { } export namespace DescribeICD10CMInferenceJobResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeICD10CMInferenceJobResponse): any => ({ ...obj, }); @@ -447,6 +486,9 @@ export interface DescribePHIDetectionJobRequest { } export namespace DescribePHIDetectionJobRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribePHIDetectionJobRequest): any => ({ ...obj, }); @@ -460,6 +502,9 @@ export interface DescribePHIDetectionJobResponse { } export namespace DescribePHIDetectionJobResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribePHIDetectionJobResponse): any => ({ ...obj, }); @@ -474,6 +519,9 @@ export interface DescribeRxNormInferenceJobRequest { } export namespace DescribeRxNormInferenceJobRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeRxNormInferenceJobRequest): any => ({ ...obj, }); @@ -487,6 +535,9 @@ export interface DescribeRxNormInferenceJobResponse { } export namespace DescribeRxNormInferenceJobResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeRxNormInferenceJobResponse): any => ({ ...obj, }); @@ -501,6 +552,9 @@ export interface DetectEntitiesRequest { } export namespace DetectEntitiesRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DetectEntitiesRequest): any => ({ ...obj, }); @@ -560,6 +614,9 @@ export interface Entity { } export namespace Entity { + /** + * @internal + */ export const filterSensitiveLog = (obj: Entity): any => ({ ...obj, }); @@ -583,6 +640,9 @@ export interface UnmappedAttribute { } export namespace UnmappedAttribute { + /** + * @internal + */ export const filterSensitiveLog = (obj: UnmappedAttribute): any => ({ ...obj, }); @@ -618,6 +678,9 @@ export interface DetectEntitiesResponse { } export namespace DetectEntitiesResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DetectEntitiesResponse): any => ({ ...obj, }); @@ -634,6 +697,9 @@ export interface InvalidEncodingException extends __SmithyException, $MetadataBe } export namespace InvalidEncodingException { + /** + * @internal + */ export const filterSensitiveLog = (obj: InvalidEncodingException): any => ({ ...obj, }); @@ -650,6 +716,9 @@ export interface ServiceUnavailableException extends __SmithyException, $Metadat } export namespace ServiceUnavailableException { + /** + * @internal + */ export const filterSensitiveLog = (obj: ServiceUnavailableException): any => ({ ...obj, }); @@ -666,6 +735,9 @@ export interface TextSizeLimitExceededException extends __SmithyException, $Meta } export namespace TextSizeLimitExceededException { + /** + * @internal + */ export const filterSensitiveLog = (obj: TextSizeLimitExceededException): any => ({ ...obj, }); @@ -680,6 +752,9 @@ export interface DetectEntitiesV2Request { } export namespace DetectEntitiesV2Request { + /** + * @internal + */ export const filterSensitiveLog = (obj: DetectEntitiesV2Request): any => ({ ...obj, }); @@ -714,6 +789,9 @@ export interface DetectEntitiesV2Response { } export namespace DetectEntitiesV2Response { + /** + * @internal + */ export const filterSensitiveLog = (obj: DetectEntitiesV2Response): any => ({ ...obj, }); @@ -728,6 +806,9 @@ export interface DetectPHIRequest { } export namespace DetectPHIRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DetectPHIRequest): any => ({ ...obj, }); @@ -757,6 +838,9 @@ export interface DetectPHIResponse { } export namespace DetectPHIResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DetectPHIResponse): any => ({ ...obj, }); @@ -771,6 +855,9 @@ export interface InferICD10CMRequest { } export namespace InferICD10CMRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: InferICD10CMRequest): any => ({ ...obj, }); @@ -812,6 +899,9 @@ export interface ICD10CMTrait { } export namespace ICD10CMTrait { + /** + * @internal + */ export const filterSensitiveLog = (obj: ICD10CMTrait): any => ({ ...obj, }); @@ -895,6 +985,9 @@ export interface ICD10CMAttribute { } export namespace ICD10CMAttribute { + /** + * @internal + */ export const filterSensitiveLog = (obj: ICD10CMAttribute): any => ({ ...obj, }); @@ -928,6 +1021,9 @@ export interface ICD10CMConcept { } export namespace ICD10CMConcept { + /** + * @internal + */ export const filterSensitiveLog = (obj: ICD10CMConcept): any => ({ ...obj, }); @@ -1005,6 +1101,9 @@ export interface ICD10CMEntity { } export namespace ICD10CMEntity { + /** + * @internal + */ export const filterSensitiveLog = (obj: ICD10CMEntity): any => ({ ...obj, }); @@ -1033,6 +1132,9 @@ export interface InferICD10CMResponse { } export namespace InferICD10CMResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: InferICD10CMResponse): any => ({ ...obj, }); @@ -1047,6 +1149,9 @@ export interface InferRxNormRequest { } export namespace InferRxNormRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: InferRxNormRequest): any => ({ ...obj, }); @@ -1075,6 +1180,9 @@ export interface RxNormTrait { } export namespace RxNormTrait { + /** + * @internal + */ export const filterSensitiveLog = (obj: RxNormTrait): any => ({ ...obj, }); @@ -1146,6 +1254,9 @@ export interface RxNormAttribute { } export namespace RxNormAttribute { + /** + * @internal + */ export const filterSensitiveLog = (obj: RxNormAttribute): any => ({ ...obj, }); @@ -1178,6 +1289,9 @@ export interface RxNormConcept { } export namespace RxNormConcept { + /** + * @internal + */ export const filterSensitiveLog = (obj: RxNormConcept): any => ({ ...obj, }); @@ -1258,6 +1372,9 @@ export interface RxNormEntity { } export namespace RxNormEntity { + /** + * @internal + */ export const filterSensitiveLog = (obj: RxNormEntity): any => ({ ...obj, }); @@ -1286,6 +1403,9 @@ export interface InferRxNormResponse { } export namespace InferRxNormResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: InferRxNormResponse): any => ({ ...obj, }); @@ -1322,6 +1442,9 @@ export interface ComprehendMedicalAsyncJobFilter { } export namespace ComprehendMedicalAsyncJobFilter { + /** + * @internal + */ export const filterSensitiveLog = (obj: ComprehendMedicalAsyncJobFilter): any => ({ ...obj, }); @@ -1346,6 +1469,9 @@ export interface ListEntitiesDetectionV2JobsRequest { } export namespace ListEntitiesDetectionV2JobsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListEntitiesDetectionV2JobsRequest): any => ({ ...obj, }); @@ -1364,6 +1490,9 @@ export interface ListEntitiesDetectionV2JobsResponse { } export namespace ListEntitiesDetectionV2JobsResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListEntitiesDetectionV2JobsResponse): any => ({ ...obj, }); @@ -1380,6 +1509,9 @@ export interface ValidationException extends __SmithyException, $MetadataBearer } export namespace ValidationException { + /** + * @internal + */ export const filterSensitiveLog = (obj: ValidationException): any => ({ ...obj, }); @@ -1404,6 +1536,9 @@ export interface ListICD10CMInferenceJobsRequest { } export namespace ListICD10CMInferenceJobsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListICD10CMInferenceJobsRequest): any => ({ ...obj, }); @@ -1422,6 +1557,9 @@ export interface ListICD10CMInferenceJobsResponse { } export namespace ListICD10CMInferenceJobsResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListICD10CMInferenceJobsResponse): any => ({ ...obj, }); @@ -1446,6 +1584,9 @@ export interface ListPHIDetectionJobsRequest { } export namespace ListPHIDetectionJobsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListPHIDetectionJobsRequest): any => ({ ...obj, }); @@ -1464,6 +1605,9 @@ export interface ListPHIDetectionJobsResponse { } export namespace ListPHIDetectionJobsResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListPHIDetectionJobsResponse): any => ({ ...obj, }); @@ -1488,6 +1632,9 @@ export interface ListRxNormInferenceJobsRequest { } export namespace ListRxNormInferenceJobsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListRxNormInferenceJobsRequest): any => ({ ...obj, }); @@ -1506,6 +1653,9 @@ export interface ListRxNormInferenceJobsResponse { } export namespace ListRxNormInferenceJobsResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListRxNormInferenceJobsResponse): any => ({ ...obj, }); @@ -1552,6 +1702,9 @@ export interface StartEntitiesDetectionV2JobRequest { } export namespace StartEntitiesDetectionV2JobRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: StartEntitiesDetectionV2JobRequest): any => ({ ...obj, }); @@ -1566,6 +1719,9 @@ export interface StartEntitiesDetectionV2JobResponse { } export namespace StartEntitiesDetectionV2JobResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: StartEntitiesDetectionV2JobResponse): any => ({ ...obj, }); @@ -1612,6 +1768,9 @@ export interface StartICD10CMInferenceJobRequest { } export namespace StartICD10CMInferenceJobRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: StartICD10CMInferenceJobRequest): any => ({ ...obj, }); @@ -1626,6 +1785,9 @@ export interface StartICD10CMInferenceJobResponse { } export namespace StartICD10CMInferenceJobResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: StartICD10CMInferenceJobResponse): any => ({ ...obj, }); @@ -1672,6 +1834,9 @@ export interface StartPHIDetectionJobRequest { } export namespace StartPHIDetectionJobRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: StartPHIDetectionJobRequest): any => ({ ...obj, }); @@ -1686,6 +1851,9 @@ export interface StartPHIDetectionJobResponse { } export namespace StartPHIDetectionJobResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: StartPHIDetectionJobResponse): any => ({ ...obj, }); @@ -1732,6 +1900,9 @@ export interface StartRxNormInferenceJobRequest { } export namespace StartRxNormInferenceJobRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: StartRxNormInferenceJobRequest): any => ({ ...obj, }); @@ -1745,6 +1916,9 @@ export interface StartRxNormInferenceJobResponse { } export namespace StartRxNormInferenceJobResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: StartRxNormInferenceJobResponse): any => ({ ...obj, }); @@ -1758,6 +1932,9 @@ export interface StopEntitiesDetectionV2JobRequest { } export namespace StopEntitiesDetectionV2JobRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: StopEntitiesDetectionV2JobRequest): any => ({ ...obj, }); @@ -1771,6 +1948,9 @@ export interface StopEntitiesDetectionV2JobResponse { } export namespace StopEntitiesDetectionV2JobResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: StopEntitiesDetectionV2JobResponse): any => ({ ...obj, }); @@ -1784,6 +1964,9 @@ export interface StopICD10CMInferenceJobRequest { } export namespace StopICD10CMInferenceJobRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: StopICD10CMInferenceJobRequest): any => ({ ...obj, }); @@ -1798,6 +1981,9 @@ export interface StopICD10CMInferenceJobResponse { } export namespace StopICD10CMInferenceJobResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: StopICD10CMInferenceJobResponse): any => ({ ...obj, }); @@ -1811,6 +1997,9 @@ export interface StopPHIDetectionJobRequest { } export namespace StopPHIDetectionJobRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: StopPHIDetectionJobRequest): any => ({ ...obj, }); @@ -1824,6 +2013,9 @@ export interface StopPHIDetectionJobResponse { } export namespace StopPHIDetectionJobResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: StopPHIDetectionJobResponse): any => ({ ...obj, }); @@ -1837,6 +2029,9 @@ export interface StopRxNormInferenceJobRequest { } export namespace StopRxNormInferenceJobRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: StopRxNormInferenceJobRequest): any => ({ ...obj, }); @@ -1851,6 +2046,9 @@ export interface StopRxNormInferenceJobResponse { } export namespace StopRxNormInferenceJobResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: StopRxNormInferenceJobResponse): any => ({ ...obj, }); diff --git a/clients/client-compute-optimizer/commands/DescribeRecommendationExportJobsCommand.ts b/clients/client-compute-optimizer/commands/DescribeRecommendationExportJobsCommand.ts index 9758480fd8f1..548e70a63c0f 100644 --- a/clients/client-compute-optimizer/commands/DescribeRecommendationExportJobsCommand.ts +++ b/clients/client-compute-optimizer/commands/DescribeRecommendationExportJobsCommand.ts @@ -29,6 +29,20 @@ export interface DescribeRecommendationExportJobsCommandOutput * ExportEC2InstanceRecommendations actions to request an export of your * recommendations. Then use the DescribeRecommendationExportJobs action to * view your export jobs.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ComputeOptimizerClient, DescribeRecommendationExportJobsCommand } from "@aws-sdk/client-compute-optimizer"; // ES Modules import + * // const { ComputeOptimizerClient, DescribeRecommendationExportJobsCommand } = require("@aws-sdk/client-compute-optimizer"); // CommonJS import + * const client = new ComputeOptimizerClient(config); + * const command = new DescribeRecommendationExportJobsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeRecommendationExportJobsCommandInput} for command's `input` shape. + * @see {@link DescribeRecommendationExportJobsCommandOutput} for command's `response` shape. + * @see {@link ComputeOptimizerClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeRecommendationExportJobsCommand extends $Command< DescribeRecommendationExportJobsCommandInput, diff --git a/clients/client-compute-optimizer/commands/ExportAutoScalingGroupRecommendationsCommand.ts b/clients/client-compute-optimizer/commands/ExportAutoScalingGroupRecommendationsCommand.ts index 1cc9a32bbbfb..70fb37cc2fe7 100644 --- a/clients/client-compute-optimizer/commands/ExportAutoScalingGroupRecommendationsCommand.ts +++ b/clients/client-compute-optimizer/commands/ExportAutoScalingGroupRecommendationsCommand.ts @@ -35,6 +35,20 @@ export interface ExportAutoScalingGroupRecommendationsCommandOutput * Recommendations in the Compute Optimizer User Guide.

* *

You can have only one Auto Scaling group export job in progress per AWS Region.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ComputeOptimizerClient, ExportAutoScalingGroupRecommendationsCommand } from "@aws-sdk/client-compute-optimizer"; // ES Modules import + * // const { ComputeOptimizerClient, ExportAutoScalingGroupRecommendationsCommand } = require("@aws-sdk/client-compute-optimizer"); // CommonJS import + * const client = new ComputeOptimizerClient(config); + * const command = new ExportAutoScalingGroupRecommendationsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ExportAutoScalingGroupRecommendationsCommandInput} for command's `input` shape. + * @see {@link ExportAutoScalingGroupRecommendationsCommandOutput} for command's `response` shape. + * @see {@link ComputeOptimizerClientResolvedConfig | config} for command's `input` shape. + * */ export class ExportAutoScalingGroupRecommendationsCommand extends $Command< ExportAutoScalingGroupRecommendationsCommandInput, diff --git a/clients/client-compute-optimizer/commands/ExportEC2InstanceRecommendationsCommand.ts b/clients/client-compute-optimizer/commands/ExportEC2InstanceRecommendationsCommand.ts index a02bef8607fa..aaa0938f811a 100644 --- a/clients/client-compute-optimizer/commands/ExportEC2InstanceRecommendationsCommand.ts +++ b/clients/client-compute-optimizer/commands/ExportEC2InstanceRecommendationsCommand.ts @@ -31,6 +31,20 @@ export interface ExportEC2InstanceRecommendationsCommandOutput * Recommendations in the Compute Optimizer User Guide.

* *

You can have only one Amazon EC2 instance export job in progress per AWS Region.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ComputeOptimizerClient, ExportEC2InstanceRecommendationsCommand } from "@aws-sdk/client-compute-optimizer"; // ES Modules import + * // const { ComputeOptimizerClient, ExportEC2InstanceRecommendationsCommand } = require("@aws-sdk/client-compute-optimizer"); // CommonJS import + * const client = new ComputeOptimizerClient(config); + * const command = new ExportEC2InstanceRecommendationsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ExportEC2InstanceRecommendationsCommandInput} for command's `input` shape. + * @see {@link ExportEC2InstanceRecommendationsCommandOutput} for command's `response` shape. + * @see {@link ComputeOptimizerClientResolvedConfig | config} for command's `input` shape. + * */ export class ExportEC2InstanceRecommendationsCommand extends $Command< ExportEC2InstanceRecommendationsCommandInput, diff --git a/clients/client-compute-optimizer/commands/GetAutoScalingGroupRecommendationsCommand.ts b/clients/client-compute-optimizer/commands/GetAutoScalingGroupRecommendationsCommand.ts index 0aaf28cfbd40..4024f836e944 100644 --- a/clients/client-compute-optimizer/commands/GetAutoScalingGroupRecommendationsCommand.ts +++ b/clients/client-compute-optimizer/commands/GetAutoScalingGroupRecommendationsCommand.ts @@ -31,6 +31,20 @@ export interface GetAutoScalingGroupRecommendationsCommandOutput *

AWS 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 AWS Compute Optimizer User Guide.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ComputeOptimizerClient, GetAutoScalingGroupRecommendationsCommand } from "@aws-sdk/client-compute-optimizer"; // ES Modules import + * // const { ComputeOptimizerClient, GetAutoScalingGroupRecommendationsCommand } = require("@aws-sdk/client-compute-optimizer"); // CommonJS import + * const client = new ComputeOptimizerClient(config); + * const command = new GetAutoScalingGroupRecommendationsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetAutoScalingGroupRecommendationsCommandInput} for command's `input` shape. + * @see {@link GetAutoScalingGroupRecommendationsCommandOutput} for command's `response` shape. + * @see {@link ComputeOptimizerClientResolvedConfig | config} for command's `input` shape. + * */ export class GetAutoScalingGroupRecommendationsCommand extends $Command< GetAutoScalingGroupRecommendationsCommandInput, diff --git a/clients/client-compute-optimizer/commands/GetEBSVolumeRecommendationsCommand.ts b/clients/client-compute-optimizer/commands/GetEBSVolumeRecommendationsCommand.ts index 7e1a0f3ee8dc..a5bb5fffe46b 100644 --- a/clients/client-compute-optimizer/commands/GetEBSVolumeRecommendationsCommand.ts +++ b/clients/client-compute-optimizer/commands/GetEBSVolumeRecommendationsCommand.ts @@ -28,6 +28,20 @@ export interface GetEBSVolumeRecommendationsCommandOutput *

AWS 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 AWS Compute Optimizer User Guide.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ComputeOptimizerClient, GetEBSVolumeRecommendationsCommand } from "@aws-sdk/client-compute-optimizer"; // ES Modules import + * // const { ComputeOptimizerClient, GetEBSVolumeRecommendationsCommand } = require("@aws-sdk/client-compute-optimizer"); // CommonJS import + * const client = new ComputeOptimizerClient(config); + * const command = new GetEBSVolumeRecommendationsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetEBSVolumeRecommendationsCommandInput} for command's `input` shape. + * @see {@link GetEBSVolumeRecommendationsCommandOutput} for command's `response` shape. + * @see {@link ComputeOptimizerClientResolvedConfig | config} for command's `input` shape. + * */ export class GetEBSVolumeRecommendationsCommand extends $Command< GetEBSVolumeRecommendationsCommandInput, diff --git a/clients/client-compute-optimizer/commands/GetEC2InstanceRecommendationsCommand.ts b/clients/client-compute-optimizer/commands/GetEC2InstanceRecommendationsCommand.ts index c1f3440352e1..68c902332969 100644 --- a/clients/client-compute-optimizer/commands/GetEC2InstanceRecommendationsCommand.ts +++ b/clients/client-compute-optimizer/commands/GetEC2InstanceRecommendationsCommand.ts @@ -28,6 +28,20 @@ export interface GetEC2InstanceRecommendationsCommandOutput *

AWS 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 AWS Compute Optimizer User Guide.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ComputeOptimizerClient, GetEC2InstanceRecommendationsCommand } from "@aws-sdk/client-compute-optimizer"; // ES Modules import + * // const { ComputeOptimizerClient, GetEC2InstanceRecommendationsCommand } = require("@aws-sdk/client-compute-optimizer"); // CommonJS import + * const client = new ComputeOptimizerClient(config); + * const command = new GetEC2InstanceRecommendationsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetEC2InstanceRecommendationsCommandInput} for command's `input` shape. + * @see {@link GetEC2InstanceRecommendationsCommandOutput} for command's `response` shape. + * @see {@link ComputeOptimizerClientResolvedConfig | config} for command's `input` shape. + * */ export class GetEC2InstanceRecommendationsCommand extends $Command< GetEC2InstanceRecommendationsCommandInput, diff --git a/clients/client-compute-optimizer/commands/GetEC2RecommendationProjectedMetricsCommand.ts b/clients/client-compute-optimizer/commands/GetEC2RecommendationProjectedMetricsCommand.ts index f709ec0d1bf8..c2b9d1520848 100644 --- a/clients/client-compute-optimizer/commands/GetEC2RecommendationProjectedMetricsCommand.ts +++ b/clients/client-compute-optimizer/commands/GetEC2RecommendationProjectedMetricsCommand.ts @@ -35,6 +35,20 @@ export interface GetEC2RecommendationProjectedMetricsCommandOutput * CloudWatch agent installed on them. For more information, see Enabling Memory * Utilization with the CloudWatch Agent.

* + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ComputeOptimizerClient, GetEC2RecommendationProjectedMetricsCommand } from "@aws-sdk/client-compute-optimizer"; // ES Modules import + * // const { ComputeOptimizerClient, GetEC2RecommendationProjectedMetricsCommand } = require("@aws-sdk/client-compute-optimizer"); // CommonJS import + * const client = new ComputeOptimizerClient(config); + * const command = new GetEC2RecommendationProjectedMetricsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetEC2RecommendationProjectedMetricsCommandInput} for command's `input` shape. + * @see {@link GetEC2RecommendationProjectedMetricsCommandOutput} for command's `response` shape. + * @see {@link ComputeOptimizerClientResolvedConfig | config} for command's `input` shape. + * */ export class GetEC2RecommendationProjectedMetricsCommand extends $Command< GetEC2RecommendationProjectedMetricsCommandInput, diff --git a/clients/client-compute-optimizer/commands/GetEnrollmentStatusCommand.ts b/clients/client-compute-optimizer/commands/GetEnrollmentStatusCommand.ts index 92e64ce83b75..f07fb6b8722a 100644 --- a/clients/client-compute-optimizer/commands/GetEnrollmentStatusCommand.ts +++ b/clients/client-compute-optimizer/commands/GetEnrollmentStatusCommand.ts @@ -24,6 +24,20 @@ export interface GetEnrollmentStatusCommandOutput extends GetEnrollmentStatusRes *

Returns the enrollment (opt in) status of an account to the AWS Compute Optimizer service.

*

If the account is the management account of an organization, this action also confirms * the enrollment status of member accounts within the organization.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ComputeOptimizerClient, GetEnrollmentStatusCommand } from "@aws-sdk/client-compute-optimizer"; // ES Modules import + * // const { ComputeOptimizerClient, GetEnrollmentStatusCommand } = require("@aws-sdk/client-compute-optimizer"); // CommonJS import + * const client = new ComputeOptimizerClient(config); + * const command = new GetEnrollmentStatusCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetEnrollmentStatusCommandInput} for command's `input` shape. + * @see {@link GetEnrollmentStatusCommandOutput} for command's `response` shape. + * @see {@link ComputeOptimizerClientResolvedConfig | config} for command's `input` shape. + * */ export class GetEnrollmentStatusCommand extends $Command< GetEnrollmentStatusCommandInput, diff --git a/clients/client-compute-optimizer/commands/GetLambdaFunctionRecommendationsCommand.ts b/clients/client-compute-optimizer/commands/GetLambdaFunctionRecommendationsCommand.ts index eda9d353d96a..bdb59abdee9f 100644 --- a/clients/client-compute-optimizer/commands/GetLambdaFunctionRecommendationsCommand.ts +++ b/clients/client-compute-optimizer/commands/GetLambdaFunctionRecommendationsCommand.ts @@ -28,6 +28,20 @@ export interface GetLambdaFunctionRecommendationsCommandOutput *

AWS Compute Optimizer generates recommendations for functions that meet a specific set of * requirements. For more information, see the Supported resources and * requirements in the AWS Compute Optimizer User Guide.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ComputeOptimizerClient, GetLambdaFunctionRecommendationsCommand } from "@aws-sdk/client-compute-optimizer"; // ES Modules import + * // const { ComputeOptimizerClient, GetLambdaFunctionRecommendationsCommand } = require("@aws-sdk/client-compute-optimizer"); // CommonJS import + * const client = new ComputeOptimizerClient(config); + * const command = new GetLambdaFunctionRecommendationsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetLambdaFunctionRecommendationsCommandInput} for command's `input` shape. + * @see {@link GetLambdaFunctionRecommendationsCommandOutput} for command's `response` shape. + * @see {@link ComputeOptimizerClientResolvedConfig | config} for command's `input` shape. + * */ export class GetLambdaFunctionRecommendationsCommand extends $Command< GetLambdaFunctionRecommendationsCommandInput, diff --git a/clients/client-compute-optimizer/commands/GetRecommendationSummariesCommand.ts b/clients/client-compute-optimizer/commands/GetRecommendationSummariesCommand.ts index f6836221ab45..c44028db5b39 100644 --- a/clients/client-compute-optimizer/commands/GetRecommendationSummariesCommand.ts +++ b/clients/client-compute-optimizer/commands/GetRecommendationSummariesCommand.ts @@ -41,6 +41,20 @@ export interface GetRecommendationSummariesCommandOutput extends GetRecommendati * Optimized.

* * + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ComputeOptimizerClient, GetRecommendationSummariesCommand } from "@aws-sdk/client-compute-optimizer"; // ES Modules import + * // const { ComputeOptimizerClient, GetRecommendationSummariesCommand } = require("@aws-sdk/client-compute-optimizer"); // CommonJS import + * const client = new ComputeOptimizerClient(config); + * const command = new GetRecommendationSummariesCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetRecommendationSummariesCommandInput} for command's `input` shape. + * @see {@link GetRecommendationSummariesCommandOutput} for command's `response` shape. + * @see {@link ComputeOptimizerClientResolvedConfig | config} for command's `input` shape. + * */ export class GetRecommendationSummariesCommand extends $Command< GetRecommendationSummariesCommandInput, diff --git a/clients/client-compute-optimizer/commands/UpdateEnrollmentStatusCommand.ts b/clients/client-compute-optimizer/commands/UpdateEnrollmentStatusCommand.ts index 5a4d4a22c240..49035169ae1b 100644 --- a/clients/client-compute-optimizer/commands/UpdateEnrollmentStatusCommand.ts +++ b/clients/client-compute-optimizer/commands/UpdateEnrollmentStatusCommand.ts @@ -34,6 +34,20 @@ export interface UpdateEnrollmentStatusCommandOutput extends UpdateEnrollmentSta *

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 AWS Compute Optimizer in the Compute Optimizer User Guide.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ComputeOptimizerClient, UpdateEnrollmentStatusCommand } from "@aws-sdk/client-compute-optimizer"; // ES Modules import + * // const { ComputeOptimizerClient, UpdateEnrollmentStatusCommand } = require("@aws-sdk/client-compute-optimizer"); // CommonJS import + * const client = new ComputeOptimizerClient(config); + * const command = new UpdateEnrollmentStatusCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link UpdateEnrollmentStatusCommandInput} for command's `input` shape. + * @see {@link UpdateEnrollmentStatusCommandOutput} for command's `response` shape. + * @see {@link ComputeOptimizerClientResolvedConfig | config} for command's `input` shape. + * */ export class UpdateEnrollmentStatusCommand extends $Command< UpdateEnrollmentStatusCommandInput, diff --git a/clients/client-compute-optimizer/models/models_0.ts b/clients/client-compute-optimizer/models/models_0.ts index e57b8f4f6c76..95d515a9b0e7 100644 --- a/clients/client-compute-optimizer/models/models_0.ts +++ b/clients/client-compute-optimizer/models/models_0.ts @@ -11,6 +11,9 @@ export interface AccessDeniedException extends __SmithyException, $MetadataBeare } export namespace AccessDeniedException { + /** + * @internal + */ export const filterSensitiveLog = (obj: AccessDeniedException): any => ({ ...obj, }); @@ -42,6 +45,9 @@ export interface AutoScalingGroupConfiguration { } export namespace AutoScalingGroupConfiguration { + /** + * @internal + */ export const filterSensitiveLog = (obj: AutoScalingGroupConfiguration): any => ({ ...obj, }); @@ -153,6 +159,9 @@ export interface UtilizationMetric { } export namespace UtilizationMetric { + /** + * @internal + */ export const filterSensitiveLog = (obj: UtilizationMetric): any => ({ ...obj, }); @@ -198,6 +207,9 @@ export interface AutoScalingGroupRecommendationOption { } export namespace AutoScalingGroupRecommendationOption { + /** + * @internal + */ export const filterSensitiveLog = (obj: AutoScalingGroupRecommendationOption): any => ({ ...obj, }); @@ -276,6 +288,9 @@ export interface AutoScalingGroupRecommendation { } export namespace AutoScalingGroupRecommendation { + /** + * @internal + */ export const filterSensitiveLog = (obj: AutoScalingGroupRecommendation): any => ({ ...obj, }); @@ -329,6 +344,9 @@ export interface JobFilter { } export namespace JobFilter { + /** + * @internal + */ export const filterSensitiveLog = (obj: JobFilter): any => ({ ...obj, }); @@ -367,6 +385,9 @@ export interface DescribeRecommendationExportJobsRequest { } export namespace DescribeRecommendationExportJobsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeRecommendationExportJobsRequest): any => ({ ...obj, }); @@ -396,6 +417,9 @@ export interface S3Destination { } export namespace S3Destination { + /** + * @internal + */ export const filterSensitiveLog = (obj: S3Destination): any => ({ ...obj, }); @@ -413,6 +437,9 @@ export interface ExportDestination { } export namespace ExportDestination { + /** + * @internal + */ export const filterSensitiveLog = (obj: ExportDestination): any => ({ ...obj, }); @@ -480,6 +507,9 @@ export interface RecommendationExportJob { } export namespace RecommendationExportJob { + /** + * @internal + */ export const filterSensitiveLog = (obj: RecommendationExportJob): any => ({ ...obj, }); @@ -499,6 +529,9 @@ export interface DescribeRecommendationExportJobsResponse { } export namespace DescribeRecommendationExportJobsResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeRecommendationExportJobsResponse): any => ({ ...obj, }); @@ -514,6 +547,9 @@ export interface InternalServerException extends __SmithyException, $MetadataBea } export namespace InternalServerException { + /** + * @internal + */ export const filterSensitiveLog = (obj: InternalServerException): any => ({ ...obj, }); @@ -529,6 +565,9 @@ export interface InvalidParameterValueException extends __SmithyException, $Meta } export namespace InvalidParameterValueException { + /** + * @internal + */ export const filterSensitiveLog = (obj: InvalidParameterValueException): any => ({ ...obj, }); @@ -545,6 +584,9 @@ export interface MissingAuthenticationToken extends __SmithyException, $Metadata } export namespace MissingAuthenticationToken { + /** + * @internal + */ export const filterSensitiveLog = (obj: MissingAuthenticationToken): any => ({ ...obj, }); @@ -560,6 +602,9 @@ export interface OptInRequiredException extends __SmithyException, $MetadataBear } export namespace OptInRequiredException { + /** + * @internal + */ export const filterSensitiveLog = (obj: OptInRequiredException): any => ({ ...obj, }); @@ -575,6 +620,9 @@ export interface ResourceNotFoundException extends __SmithyException, $MetadataB } export namespace ResourceNotFoundException { + /** + * @internal + */ export const filterSensitiveLog = (obj: ResourceNotFoundException): any => ({ ...obj, }); @@ -590,6 +638,9 @@ export interface ServiceUnavailableException extends __SmithyException, $Metadat } export namespace ServiceUnavailableException { + /** + * @internal + */ export const filterSensitiveLog = (obj: ServiceUnavailableException): any => ({ ...obj, }); @@ -605,6 +656,9 @@ export interface ThrottlingException extends __SmithyException, $MetadataBearer } export namespace ThrottlingException { + /** + * @internal + */ export const filterSensitiveLog = (obj: ThrottlingException): any => ({ ...obj, }); @@ -707,6 +761,9 @@ export interface Filter { } export namespace Filter { + /** + * @internal + */ export const filterSensitiveLog = (obj: Filter): any => ({ ...obj, }); @@ -736,6 +793,9 @@ export interface S3DestinationConfig { } export namespace S3DestinationConfig { + /** + * @internal + */ export const filterSensitiveLog = (obj: S3DestinationConfig): any => ({ ...obj, }); @@ -800,6 +860,9 @@ export interface ExportAutoScalingGroupRecommendationsRequest { } export namespace ExportAutoScalingGroupRecommendationsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ExportAutoScalingGroupRecommendationsRequest): any => ({ ...obj, }); @@ -821,6 +884,9 @@ export interface ExportAutoScalingGroupRecommendationsResponse { } export namespace ExportAutoScalingGroupRecommendationsResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ExportAutoScalingGroupRecommendationsResponse): any => ({ ...obj, }); @@ -836,6 +902,9 @@ export interface LimitExceededException extends __SmithyException, $MetadataBear } export namespace LimitExceededException { + /** + * @internal + */ export const filterSensitiveLog = (obj: LimitExceededException): any => ({ ...obj, }); @@ -934,6 +1003,9 @@ export interface ExportEC2InstanceRecommendationsRequest { } export namespace ExportEC2InstanceRecommendationsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ExportEC2InstanceRecommendationsRequest): any => ({ ...obj, }); @@ -955,6 +1027,9 @@ export interface ExportEC2InstanceRecommendationsResponse { } export namespace ExportEC2InstanceRecommendationsResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ExportEC2InstanceRecommendationsResponse): any => ({ ...obj, }); @@ -997,6 +1072,9 @@ export interface GetAutoScalingGroupRecommendationsRequest { } export namespace GetAutoScalingGroupRecommendationsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetAutoScalingGroupRecommendationsRequest): any => ({ ...obj, }); @@ -1026,6 +1104,9 @@ export interface GetRecommendationError { } export namespace GetRecommendationError { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetRecommendationError): any => ({ ...obj, }); @@ -1053,6 +1134,9 @@ export interface GetAutoScalingGroupRecommendationsResponse { } export namespace GetAutoScalingGroupRecommendationsResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetAutoScalingGroupRecommendationsResponse): any => ({ ...obj, }); @@ -1086,6 +1170,9 @@ export interface EBSFilter { } export namespace EBSFilter { + /** + * @internal + */ export const filterSensitiveLog = (obj: EBSFilter): any => ({ ...obj, }); @@ -1126,6 +1213,9 @@ export interface GetEBSVolumeRecommendationsRequest { } export namespace GetEBSVolumeRecommendationsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetEBSVolumeRecommendationsRequest): any => ({ ...obj, }); @@ -1171,6 +1261,9 @@ export interface VolumeConfiguration { } export namespace VolumeConfiguration { + /** + * @internal + */ export const filterSensitiveLog = (obj: VolumeConfiguration): any => ({ ...obj, }); @@ -1251,6 +1344,9 @@ export interface EBSUtilizationMetric { } export namespace EBSUtilizationMetric { + /** + * @internal + */ export const filterSensitiveLog = (obj: EBSUtilizationMetric): any => ({ ...obj, }); @@ -1282,6 +1378,9 @@ export interface VolumeRecommendationOption { } export namespace VolumeRecommendationOption { + /** + * @internal + */ export const filterSensitiveLog = (obj: VolumeRecommendationOption): any => ({ ...obj, }); @@ -1355,6 +1454,9 @@ export interface VolumeRecommendation { } export namespace VolumeRecommendation { + /** + * @internal + */ export const filterSensitiveLog = (obj: VolumeRecommendation): any => ({ ...obj, }); @@ -1382,6 +1484,9 @@ export interface GetEBSVolumeRecommendationsResponse { } export namespace GetEBSVolumeRecommendationsResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetEBSVolumeRecommendationsResponse): any => ({ ...obj, }); @@ -1422,6 +1527,9 @@ export interface GetEC2InstanceRecommendationsRequest { } export namespace GetEC2InstanceRecommendationsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetEC2InstanceRecommendationsRequest): any => ({ ...obj, }); @@ -1467,6 +1575,9 @@ export interface InstanceRecommendationOption { } export namespace InstanceRecommendationOption { + /** + * @internal + */ export const filterSensitiveLog = (obj: InstanceRecommendationOption): any => ({ ...obj, }); @@ -1496,6 +1607,9 @@ export interface RecommendationSource { } export namespace RecommendationSource { + /** + * @internal + */ export const filterSensitiveLog = (obj: RecommendationSource): any => ({ ...obj, }); @@ -1593,6 +1707,9 @@ export interface InstanceRecommendation { } export namespace InstanceRecommendation { + /** + * @internal + */ export const filterSensitiveLog = (obj: InstanceRecommendation): any => ({ ...obj, }); @@ -1620,6 +1737,9 @@ export interface GetEC2InstanceRecommendationsResponse { } export namespace GetEC2InstanceRecommendationsResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetEC2InstanceRecommendationsResponse): any => ({ ...obj, }); @@ -1654,6 +1774,9 @@ export interface GetEC2RecommendationProjectedMetricsRequest { } export namespace GetEC2RecommendationProjectedMetricsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetEC2RecommendationProjectedMetricsRequest): any => ({ ...obj, }); @@ -1722,6 +1845,9 @@ export interface ProjectedMetric { } export namespace ProjectedMetric { + /** + * @internal + */ export const filterSensitiveLog = (obj: ProjectedMetric): any => ({ ...obj, }); @@ -1761,6 +1887,9 @@ export interface RecommendedOptionProjectedMetric { } export namespace RecommendedOptionProjectedMetric { + /** + * @internal + */ export const filterSensitiveLog = (obj: RecommendedOptionProjectedMetric): any => ({ ...obj, }); @@ -1774,6 +1903,9 @@ export interface GetEC2RecommendationProjectedMetricsResponse { } export namespace GetEC2RecommendationProjectedMetricsResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetEC2RecommendationProjectedMetricsResponse): any => ({ ...obj, }); @@ -1782,6 +1914,9 @@ export namespace GetEC2RecommendationProjectedMetricsResponse { export interface GetEnrollmentStatusRequest {} export namespace GetEnrollmentStatusRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetEnrollmentStatusRequest): any => ({ ...obj, }); @@ -1815,6 +1950,9 @@ export interface GetEnrollmentStatusResponse { } export namespace GetEnrollmentStatusResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetEnrollmentStatusResponse): any => ({ ...obj, }); @@ -1865,6 +2003,9 @@ export interface LambdaFunctionRecommendationFilter { } export namespace LambdaFunctionRecommendationFilter { + /** + * @internal + */ export const filterSensitiveLog = (obj: LambdaFunctionRecommendationFilter): any => ({ ...obj, }); @@ -1915,6 +2056,9 @@ export interface GetLambdaFunctionRecommendationsRequest { } export namespace GetLambdaFunctionRecommendationsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetLambdaFunctionRecommendationsRequest): any => ({ ...obj, }); @@ -1965,6 +2109,9 @@ export interface LambdaFunctionMemoryProjectedMetric { } export namespace LambdaFunctionMemoryProjectedMetric { + /** + * @internal + */ export const filterSensitiveLog = (obj: LambdaFunctionMemoryProjectedMetric): any => ({ ...obj, }); @@ -1994,6 +2141,9 @@ export interface LambdaFunctionMemoryRecommendationOption { } export namespace LambdaFunctionMemoryRecommendationOption { + /** + * @internal + */ export const filterSensitiveLog = (obj: LambdaFunctionMemoryRecommendationOption): any => ({ ...obj, }); @@ -2053,6 +2203,9 @@ export interface LambdaFunctionUtilizationMetric { } export namespace LambdaFunctionUtilizationMetric { + /** + * @internal + */ export const filterSensitiveLog = (obj: LambdaFunctionUtilizationMetric): any => ({ ...obj, }); @@ -2212,6 +2365,9 @@ export interface LambdaFunctionRecommendation { } export namespace LambdaFunctionRecommendation { + /** + * @internal + */ export const filterSensitiveLog = (obj: LambdaFunctionRecommendation): any => ({ ...obj, }); @@ -2233,6 +2389,9 @@ export interface GetLambdaFunctionRecommendationsResponse { } export namespace GetLambdaFunctionRecommendationsResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetLambdaFunctionRecommendationsResponse): any => ({ ...obj, }); @@ -2261,6 +2420,9 @@ export interface GetRecommendationSummariesRequest { } export namespace GetRecommendationSummariesRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetRecommendationSummariesRequest): any => ({ ...obj, }); @@ -2287,6 +2449,9 @@ export interface ReasonCodeSummary { } export namespace ReasonCodeSummary { + /** + * @internal + */ export const filterSensitiveLog = (obj: ReasonCodeSummary): any => ({ ...obj, }); @@ -2313,6 +2478,9 @@ export interface Summary { } export namespace Summary { + /** + * @internal + */ export const filterSensitiveLog = (obj: Summary): any => ({ ...obj, }); @@ -2339,6 +2507,9 @@ export interface RecommendationSummary { } export namespace RecommendationSummary { + /** + * @internal + */ export const filterSensitiveLog = (obj: RecommendationSummary): any => ({ ...obj, }); @@ -2359,6 +2530,9 @@ export interface GetRecommendationSummariesResponse { } export namespace GetRecommendationSummariesResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetRecommendationSummariesResponse): any => ({ ...obj, }); @@ -2399,6 +2573,9 @@ export interface UpdateEnrollmentStatusRequest { } export namespace UpdateEnrollmentStatusRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateEnrollmentStatusRequest): any => ({ ...obj, }); @@ -2419,6 +2596,9 @@ export interface UpdateEnrollmentStatusResponse { } export namespace UpdateEnrollmentStatusResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateEnrollmentStatusResponse): any => ({ ...obj, }); diff --git a/clients/client-config-service/commands/BatchGetAggregateResourceConfigCommand.ts b/clients/client-config-service/commands/BatchGetAggregateResourceConfigCommand.ts index 4a459ac7cd6b..8a7a97322428 100644 --- a/clients/client-config-service/commands/BatchGetAggregateResourceConfigCommand.ts +++ b/clients/client-config-service/commands/BatchGetAggregateResourceConfigCommand.ts @@ -36,6 +36,20 @@ export interface BatchGetAggregateResourceConfigCommandOutput * * * + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ConfigServiceClient, BatchGetAggregateResourceConfigCommand } from "@aws-sdk/client-config-service"; // ES Modules import + * // const { ConfigServiceClient, BatchGetAggregateResourceConfigCommand } = require("@aws-sdk/client-config-service"); // CommonJS import + * const client = new ConfigServiceClient(config); + * const command = new BatchGetAggregateResourceConfigCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link BatchGetAggregateResourceConfigCommandInput} for command's `input` shape. + * @see {@link BatchGetAggregateResourceConfigCommandOutput} for command's `response` shape. + * @see {@link ConfigServiceClientResolvedConfig | config} for command's `input` shape. + * */ export class BatchGetAggregateResourceConfigCommand extends $Command< BatchGetAggregateResourceConfigCommandInput, diff --git a/clients/client-config-service/commands/BatchGetResourceConfigCommand.ts b/clients/client-config-service/commands/BatchGetResourceConfigCommand.ts index fb4001eeed35..d8bf61db94e1 100644 --- a/clients/client-config-service/commands/BatchGetResourceConfigCommand.ts +++ b/clients/client-config-service/commands/BatchGetResourceConfigCommand.ts @@ -40,6 +40,20 @@ export interface BatchGetResourceConfigCommandOutput extends BatchGetResourceCon * * * + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ConfigServiceClient, BatchGetResourceConfigCommand } from "@aws-sdk/client-config-service"; // ES Modules import + * // const { ConfigServiceClient, BatchGetResourceConfigCommand } = require("@aws-sdk/client-config-service"); // CommonJS import + * const client = new ConfigServiceClient(config); + * const command = new BatchGetResourceConfigCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link BatchGetResourceConfigCommandInput} for command's `input` shape. + * @see {@link BatchGetResourceConfigCommandOutput} for command's `response` shape. + * @see {@link ConfigServiceClientResolvedConfig | config} for command's `input` shape. + * */ export class BatchGetResourceConfigCommand extends $Command< BatchGetResourceConfigCommandInput, diff --git a/clients/client-config-service/commands/DeleteAggregationAuthorizationCommand.ts b/clients/client-config-service/commands/DeleteAggregationAuthorizationCommand.ts index c410ac25e62c..c73e65a226b0 100644 --- a/clients/client-config-service/commands/DeleteAggregationAuthorizationCommand.ts +++ b/clients/client-config-service/commands/DeleteAggregationAuthorizationCommand.ts @@ -23,6 +23,20 @@ export interface DeleteAggregationAuthorizationCommandOutput extends __MetadataB /** *

Deletes the authorization granted to the specified * configuration aggregator account in a specified region.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ConfigServiceClient, DeleteAggregationAuthorizationCommand } from "@aws-sdk/client-config-service"; // ES Modules import + * // const { ConfigServiceClient, DeleteAggregationAuthorizationCommand } = require("@aws-sdk/client-config-service"); // CommonJS import + * const client = new ConfigServiceClient(config); + * const command = new DeleteAggregationAuthorizationCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteAggregationAuthorizationCommandInput} for command's `input` shape. + * @see {@link DeleteAggregationAuthorizationCommandOutput} for command's `response` shape. + * @see {@link ConfigServiceClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteAggregationAuthorizationCommand extends $Command< DeleteAggregationAuthorizationCommandInput, diff --git a/clients/client-config-service/commands/DeleteConfigRuleCommand.ts b/clients/client-config-service/commands/DeleteConfigRuleCommand.ts index ad09e460234f..29f2b729fae9 100644 --- a/clients/client-config-service/commands/DeleteConfigRuleCommand.ts +++ b/clients/client-config-service/commands/DeleteConfigRuleCommand.ts @@ -30,6 +30,20 @@ export interface DeleteConfigRuleCommandOutput extends __MetadataBearer {} * receive a ResourceInUseException.

*

You can check the state of a rule by using the * DescribeConfigRules request.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ConfigServiceClient, DeleteConfigRuleCommand } from "@aws-sdk/client-config-service"; // ES Modules import + * // const { ConfigServiceClient, DeleteConfigRuleCommand } = require("@aws-sdk/client-config-service"); // CommonJS import + * const client = new ConfigServiceClient(config); + * const command = new DeleteConfigRuleCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteConfigRuleCommandInput} for command's `input` shape. + * @see {@link DeleteConfigRuleCommandOutput} for command's `response` shape. + * @see {@link ConfigServiceClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteConfigRuleCommand extends $Command< DeleteConfigRuleCommandInput, diff --git a/clients/client-config-service/commands/DeleteConfigurationAggregatorCommand.ts b/clients/client-config-service/commands/DeleteConfigurationAggregatorCommand.ts index 5a8798bb569d..313bd9b57b27 100644 --- a/clients/client-config-service/commands/DeleteConfigurationAggregatorCommand.ts +++ b/clients/client-config-service/commands/DeleteConfigurationAggregatorCommand.ts @@ -23,6 +23,20 @@ export interface DeleteConfigurationAggregatorCommandOutput extends __MetadataBe /** *

Deletes the specified configuration aggregator and the * aggregated data associated with the aggregator.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ConfigServiceClient, DeleteConfigurationAggregatorCommand } from "@aws-sdk/client-config-service"; // ES Modules import + * // const { ConfigServiceClient, DeleteConfigurationAggregatorCommand } = require("@aws-sdk/client-config-service"); // CommonJS import + * const client = new ConfigServiceClient(config); + * const command = new DeleteConfigurationAggregatorCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteConfigurationAggregatorCommandInput} for command's `input` shape. + * @see {@link DeleteConfigurationAggregatorCommandOutput} for command's `response` shape. + * @see {@link ConfigServiceClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteConfigurationAggregatorCommand extends $Command< DeleteConfigurationAggregatorCommandInput, diff --git a/clients/client-config-service/commands/DeleteConfigurationRecorderCommand.ts b/clients/client-config-service/commands/DeleteConfigurationRecorderCommand.ts index 1a1914825def..ca13c99a9c32 100644 --- a/clients/client-config-service/commands/DeleteConfigurationRecorderCommand.ts +++ b/clients/client-config-service/commands/DeleteConfigurationRecorderCommand.ts @@ -31,6 +31,20 @@ export interface DeleteConfigurationRecorderCommandOutput extends __MetadataBear * GetResourceConfigHistory action, but you will not * be able to access this information in the AWS Config console until * you create a new configuration recorder.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ConfigServiceClient, DeleteConfigurationRecorderCommand } from "@aws-sdk/client-config-service"; // ES Modules import + * // const { ConfigServiceClient, DeleteConfigurationRecorderCommand } = require("@aws-sdk/client-config-service"); // CommonJS import + * const client = new ConfigServiceClient(config); + * const command = new DeleteConfigurationRecorderCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteConfigurationRecorderCommandInput} for command's `input` shape. + * @see {@link DeleteConfigurationRecorderCommandOutput} for command's `response` shape. + * @see {@link ConfigServiceClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteConfigurationRecorderCommand extends $Command< DeleteConfigurationRecorderCommandInput, diff --git a/clients/client-config-service/commands/DeleteConformancePackCommand.ts b/clients/client-config-service/commands/DeleteConformancePackCommand.ts index b96b9180a5c5..97d7020e2a7e 100644 --- a/clients/client-config-service/commands/DeleteConformancePackCommand.ts +++ b/clients/client-config-service/commands/DeleteConformancePackCommand.ts @@ -25,6 +25,20 @@ export interface DeleteConformancePackCommandOutput extends __MetadataBearer {} * conformance pack.

*

AWS 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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ConfigServiceClient, DeleteConformancePackCommand } from "@aws-sdk/client-config-service"; // ES Modules import + * // const { ConfigServiceClient, DeleteConformancePackCommand } = require("@aws-sdk/client-config-service"); // CommonJS import + * const client = new ConfigServiceClient(config); + * const command = new DeleteConformancePackCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteConformancePackCommandInput} for command's `input` shape. + * @see {@link DeleteConformancePackCommandOutput} for command's `response` shape. + * @see {@link ConfigServiceClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteConformancePackCommand extends $Command< DeleteConformancePackCommandInput, diff --git a/clients/client-config-service/commands/DeleteDeliveryChannelCommand.ts b/clients/client-config-service/commands/DeleteDeliveryChannelCommand.ts index 276cfcdfc687..09a4cdec0332 100644 --- a/clients/client-config-service/commands/DeleteDeliveryChannelCommand.ts +++ b/clients/client-config-service/commands/DeleteDeliveryChannelCommand.ts @@ -24,6 +24,20 @@ export interface DeleteDeliveryChannelCommandOutput extends __MetadataBearer {} *

Deletes the delivery channel.

*

Before you can delete the delivery channel, you must stop the * configuration recorder by using the StopConfigurationRecorder action.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ConfigServiceClient, DeleteDeliveryChannelCommand } from "@aws-sdk/client-config-service"; // ES Modules import + * // const { ConfigServiceClient, DeleteDeliveryChannelCommand } = require("@aws-sdk/client-config-service"); // CommonJS import + * const client = new ConfigServiceClient(config); + * const command = new DeleteDeliveryChannelCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteDeliveryChannelCommandInput} for command's `input` shape. + * @see {@link DeleteDeliveryChannelCommandOutput} for command's `response` shape. + * @see {@link ConfigServiceClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteDeliveryChannelCommand extends $Command< DeleteDeliveryChannelCommandInput, diff --git a/clients/client-config-service/commands/DeleteEvaluationResultsCommand.ts b/clients/client-config-service/commands/DeleteEvaluationResultsCommand.ts index 6651e17ef3e8..2350b4605b7e 100644 --- a/clients/client-config-service/commands/DeleteEvaluationResultsCommand.ts +++ b/clients/client-config-service/commands/DeleteEvaluationResultsCommand.ts @@ -25,6 +25,20 @@ export interface DeleteEvaluationResultsCommandOutput extends DeleteEvaluationRe * rule. You can specify one AWS Config rule per request. After you * delete the evaluation results, you can call the StartConfigRulesEvaluation API to start evaluating * your AWS resources against the rule.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ConfigServiceClient, DeleteEvaluationResultsCommand } from "@aws-sdk/client-config-service"; // ES Modules import + * // const { ConfigServiceClient, DeleteEvaluationResultsCommand } = require("@aws-sdk/client-config-service"); // CommonJS import + * const client = new ConfigServiceClient(config); + * const command = new DeleteEvaluationResultsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteEvaluationResultsCommandInput} for command's `input` shape. + * @see {@link DeleteEvaluationResultsCommandOutput} for command's `response` shape. + * @see {@link ConfigServiceClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteEvaluationResultsCommand extends $Command< DeleteEvaluationResultsCommandInput, diff --git a/clients/client-config-service/commands/DeleteOrganizationConfigRuleCommand.ts b/clients/client-config-service/commands/DeleteOrganizationConfigRuleCommand.ts index 70dcc39ebdf7..8a6ec7cf790b 100644 --- a/clients/client-config-service/commands/DeleteOrganizationConfigRuleCommand.ts +++ b/clients/client-config-service/commands/DeleteOrganizationConfigRuleCommand.ts @@ -27,6 +27,20 @@ export interface DeleteOrganizationConfigRuleCommandOutput extends __MetadataBea * ListDelegatedAdministrator permissions are added.

*

AWS 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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ConfigServiceClient, DeleteOrganizationConfigRuleCommand } from "@aws-sdk/client-config-service"; // ES Modules import + * // const { ConfigServiceClient, DeleteOrganizationConfigRuleCommand } = require("@aws-sdk/client-config-service"); // CommonJS import + * const client = new ConfigServiceClient(config); + * const command = new DeleteOrganizationConfigRuleCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteOrganizationConfigRuleCommandInput} for command's `input` shape. + * @see {@link DeleteOrganizationConfigRuleCommandOutput} for command's `response` shape. + * @see {@link ConfigServiceClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteOrganizationConfigRuleCommand extends $Command< DeleteOrganizationConfigRuleCommandInput, diff --git a/clients/client-config-service/commands/DeleteOrganizationConformancePackCommand.ts b/clients/client-config-service/commands/DeleteOrganizationConformancePackCommand.ts index 4a0021c51ffd..77aa70392f01 100644 --- a/clients/client-config-service/commands/DeleteOrganizationConformancePackCommand.ts +++ b/clients/client-config-service/commands/DeleteOrganizationConformancePackCommand.ts @@ -28,6 +28,20 @@ export interface DeleteOrganizationConformancePackCommandOutput extends __Metada * ListDelegatedAdministrator permissions are added.

*

AWS 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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ConfigServiceClient, DeleteOrganizationConformancePackCommand } from "@aws-sdk/client-config-service"; // ES Modules import + * // const { ConfigServiceClient, DeleteOrganizationConformancePackCommand } = require("@aws-sdk/client-config-service"); // CommonJS import + * const client = new ConfigServiceClient(config); + * const command = new DeleteOrganizationConformancePackCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteOrganizationConformancePackCommandInput} for command's `input` shape. + * @see {@link DeleteOrganizationConformancePackCommandOutput} for command's `response` shape. + * @see {@link ConfigServiceClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteOrganizationConformancePackCommand extends $Command< DeleteOrganizationConformancePackCommandInput, diff --git a/clients/client-config-service/commands/DeletePendingAggregationRequestCommand.ts b/clients/client-config-service/commands/DeletePendingAggregationRequestCommand.ts index b4de5096263b..f31be1d580a0 100644 --- a/clients/client-config-service/commands/DeletePendingAggregationRequestCommand.ts +++ b/clients/client-config-service/commands/DeletePendingAggregationRequestCommand.ts @@ -23,6 +23,20 @@ export interface DeletePendingAggregationRequestCommandOutput extends __Metadata /** *

Deletes pending authorization requests for a specified * aggregator account in a specified region.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ConfigServiceClient, DeletePendingAggregationRequestCommand } from "@aws-sdk/client-config-service"; // ES Modules import + * // const { ConfigServiceClient, DeletePendingAggregationRequestCommand } = require("@aws-sdk/client-config-service"); // CommonJS import + * const client = new ConfigServiceClient(config); + * const command = new DeletePendingAggregationRequestCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeletePendingAggregationRequestCommandInput} for command's `input` shape. + * @see {@link DeletePendingAggregationRequestCommandOutput} for command's `response` shape. + * @see {@link ConfigServiceClientResolvedConfig | config} for command's `input` shape. + * */ export class DeletePendingAggregationRequestCommand extends $Command< DeletePendingAggregationRequestCommandInput, diff --git a/clients/client-config-service/commands/DeleteRemediationConfigurationCommand.ts b/clients/client-config-service/commands/DeleteRemediationConfigurationCommand.ts index 81a6203ac74a..eaeae404fa87 100644 --- a/clients/client-config-service/commands/DeleteRemediationConfigurationCommand.ts +++ b/clients/client-config-service/commands/DeleteRemediationConfigurationCommand.ts @@ -24,6 +24,20 @@ export interface DeleteRemediationConfigurationCommandOutput /** *

Deletes the remediation configuration.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ConfigServiceClient, DeleteRemediationConfigurationCommand } from "@aws-sdk/client-config-service"; // ES Modules import + * // const { ConfigServiceClient, DeleteRemediationConfigurationCommand } = require("@aws-sdk/client-config-service"); // CommonJS import + * const client = new ConfigServiceClient(config); + * const command = new DeleteRemediationConfigurationCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteRemediationConfigurationCommandInput} for command's `input` shape. + * @see {@link DeleteRemediationConfigurationCommandOutput} for command's `response` shape. + * @see {@link ConfigServiceClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteRemediationConfigurationCommand extends $Command< DeleteRemediationConfigurationCommandInput, diff --git a/clients/client-config-service/commands/DeleteRemediationExceptionsCommand.ts b/clients/client-config-service/commands/DeleteRemediationExceptionsCommand.ts index 773da468a1a2..733a668253d1 100644 --- a/clients/client-config-service/commands/DeleteRemediationExceptionsCommand.ts +++ b/clients/client-config-service/commands/DeleteRemediationExceptionsCommand.ts @@ -28,6 +28,20 @@ export interface DeleteRemediationExceptionsCommandOutput *

AWS 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.

* + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ConfigServiceClient, DeleteRemediationExceptionsCommand } from "@aws-sdk/client-config-service"; // ES Modules import + * // const { ConfigServiceClient, DeleteRemediationExceptionsCommand } = require("@aws-sdk/client-config-service"); // CommonJS import + * const client = new ConfigServiceClient(config); + * const command = new DeleteRemediationExceptionsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteRemediationExceptionsCommandInput} for command's `input` shape. + * @see {@link DeleteRemediationExceptionsCommandOutput} for command's `response` shape. + * @see {@link ConfigServiceClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteRemediationExceptionsCommand extends $Command< DeleteRemediationExceptionsCommandInput, diff --git a/clients/client-config-service/commands/DeleteResourceConfigCommand.ts b/clients/client-config-service/commands/DeleteResourceConfigCommand.ts index 3fad7dde4c81..6e537cd0ebbc 100644 --- a/clients/client-config-service/commands/DeleteResourceConfigCommand.ts +++ b/clients/client-config-service/commands/DeleteResourceConfigCommand.ts @@ -23,6 +23,20 @@ export interface DeleteResourceConfigCommandOutput extends __MetadataBearer {} /** *

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 AWS Config History. *

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ConfigServiceClient, DeleteResourceConfigCommand } from "@aws-sdk/client-config-service"; // ES Modules import + * // const { ConfigServiceClient, DeleteResourceConfigCommand } = require("@aws-sdk/client-config-service"); // CommonJS import + * const client = new ConfigServiceClient(config); + * const command = new DeleteResourceConfigCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteResourceConfigCommandInput} for command's `input` shape. + * @see {@link DeleteResourceConfigCommandOutput} for command's `response` shape. + * @see {@link ConfigServiceClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteResourceConfigCommand extends $Command< DeleteResourceConfigCommandInput, diff --git a/clients/client-config-service/commands/DeleteRetentionConfigurationCommand.ts b/clients/client-config-service/commands/DeleteRetentionConfigurationCommand.ts index e2614ed7cc63..d954dd2bc675 100644 --- a/clients/client-config-service/commands/DeleteRetentionConfigurationCommand.ts +++ b/clients/client-config-service/commands/DeleteRetentionConfigurationCommand.ts @@ -22,6 +22,20 @@ export interface DeleteRetentionConfigurationCommandOutput extends __MetadataBea /** *

Deletes the retention configuration.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ConfigServiceClient, DeleteRetentionConfigurationCommand } from "@aws-sdk/client-config-service"; // ES Modules import + * // const { ConfigServiceClient, DeleteRetentionConfigurationCommand } = require("@aws-sdk/client-config-service"); // CommonJS import + * const client = new ConfigServiceClient(config); + * const command = new DeleteRetentionConfigurationCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteRetentionConfigurationCommandInput} for command's `input` shape. + * @see {@link DeleteRetentionConfigurationCommandOutput} for command's `response` shape. + * @see {@link ConfigServiceClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteRetentionConfigurationCommand extends $Command< DeleteRetentionConfigurationCommandInput, diff --git a/clients/client-config-service/commands/DeleteStoredQueryCommand.ts b/clients/client-config-service/commands/DeleteStoredQueryCommand.ts index 690fd18237cb..9dd0d74a4935 100644 --- a/clients/client-config-service/commands/DeleteStoredQueryCommand.ts +++ b/clients/client-config-service/commands/DeleteStoredQueryCommand.ts @@ -22,6 +22,20 @@ export interface DeleteStoredQueryCommandOutput extends DeleteStoredQueryRespons /** *

Deletes the stored query for a single AWS account and a single AWS Region.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ConfigServiceClient, DeleteStoredQueryCommand } from "@aws-sdk/client-config-service"; // ES Modules import + * // const { ConfigServiceClient, DeleteStoredQueryCommand } = require("@aws-sdk/client-config-service"); // CommonJS import + * const client = new ConfigServiceClient(config); + * const command = new DeleteStoredQueryCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteStoredQueryCommandInput} for command's `input` shape. + * @see {@link DeleteStoredQueryCommandOutput} for command's `response` shape. + * @see {@link ConfigServiceClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteStoredQueryCommand extends $Command< DeleteStoredQueryCommandInput, diff --git a/clients/client-config-service/commands/DeliverConfigSnapshotCommand.ts b/clients/client-config-service/commands/DeliverConfigSnapshotCommand.ts index 2d9d6ab70bd2..75a75db117b0 100644 --- a/clients/client-config-service/commands/DeliverConfigSnapshotCommand.ts +++ b/clients/client-config-service/commands/DeliverConfigSnapshotCommand.ts @@ -38,6 +38,20 @@ export interface DeliverConfigSnapshotCommandOutput extends DeliverConfigSnapsho * failed.

* * + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ConfigServiceClient, DeliverConfigSnapshotCommand } from "@aws-sdk/client-config-service"; // ES Modules import + * // const { ConfigServiceClient, DeliverConfigSnapshotCommand } = require("@aws-sdk/client-config-service"); // CommonJS import + * const client = new ConfigServiceClient(config); + * const command = new DeliverConfigSnapshotCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeliverConfigSnapshotCommandInput} for command's `input` shape. + * @see {@link DeliverConfigSnapshotCommandOutput} for command's `response` shape. + * @see {@link ConfigServiceClientResolvedConfig | config} for command's `input` shape. + * */ export class DeliverConfigSnapshotCommand extends $Command< DeliverConfigSnapshotCommandInput, diff --git a/clients/client-config-service/commands/DescribeAggregateComplianceByConfigRulesCommand.ts b/clients/client-config-service/commands/DescribeAggregateComplianceByConfigRulesCommand.ts index 9e016716ed52..5ca8183d20b9 100644 --- a/clients/client-config-service/commands/DescribeAggregateComplianceByConfigRulesCommand.ts +++ b/clients/client-config-service/commands/DescribeAggregateComplianceByConfigRulesCommand.ts @@ -35,6 +35,20 @@ export interface DescribeAggregateComplianceByConfigRulesCommandOutput * have a nextToken, the results are displayed on the next * page.

* + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ConfigServiceClient, DescribeAggregateComplianceByConfigRulesCommand } from "@aws-sdk/client-config-service"; // ES Modules import + * // const { ConfigServiceClient, DescribeAggregateComplianceByConfigRulesCommand } = require("@aws-sdk/client-config-service"); // CommonJS import + * const client = new ConfigServiceClient(config); + * const command = new DescribeAggregateComplianceByConfigRulesCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeAggregateComplianceByConfigRulesCommandInput} for command's `input` shape. + * @see {@link DescribeAggregateComplianceByConfigRulesCommandOutput} for command's `response` shape. + * @see {@link ConfigServiceClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeAggregateComplianceByConfigRulesCommand extends $Command< DescribeAggregateComplianceByConfigRulesCommandInput, diff --git a/clients/client-config-service/commands/DescribeAggregateComplianceByConformancePacksCommand.ts b/clients/client-config-service/commands/DescribeAggregateComplianceByConformancePacksCommand.ts index 06f3e84f07e3..a0be75c6be7b 100644 --- a/clients/client-config-service/commands/DescribeAggregateComplianceByConformancePacksCommand.ts +++ b/clients/client-config-service/commands/DescribeAggregateComplianceByConformancePacksCommand.ts @@ -32,6 +32,20 @@ export interface DescribeAggregateComplianceByConformancePacksCommandOutput * *

The results can return an empty result page, but if you have a nextToken, the results are displayed on the next page.

* + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ConfigServiceClient, DescribeAggregateComplianceByConformancePacksCommand } from "@aws-sdk/client-config-service"; // ES Modules import + * // const { ConfigServiceClient, DescribeAggregateComplianceByConformancePacksCommand } = require("@aws-sdk/client-config-service"); // CommonJS import + * const client = new ConfigServiceClient(config); + * const command = new DescribeAggregateComplianceByConformancePacksCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeAggregateComplianceByConformancePacksCommandInput} for command's `input` shape. + * @see {@link DescribeAggregateComplianceByConformancePacksCommandOutput} for command's `response` shape. + * @see {@link ConfigServiceClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeAggregateComplianceByConformancePacksCommand extends $Command< DescribeAggregateComplianceByConformancePacksCommandInput, diff --git a/clients/client-config-service/commands/DescribeAggregationAuthorizationsCommand.ts b/clients/client-config-service/commands/DescribeAggregationAuthorizationsCommand.ts index ec49fa572792..ebb4c01da753 100644 --- a/clients/client-config-service/commands/DescribeAggregationAuthorizationsCommand.ts +++ b/clients/client-config-service/commands/DescribeAggregationAuthorizationsCommand.ts @@ -28,6 +28,20 @@ export interface DescribeAggregationAuthorizationsCommandOutput /** *

Returns a list of authorizations granted to various aggregator * accounts and regions.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ConfigServiceClient, DescribeAggregationAuthorizationsCommand } from "@aws-sdk/client-config-service"; // ES Modules import + * // const { ConfigServiceClient, DescribeAggregationAuthorizationsCommand } = require("@aws-sdk/client-config-service"); // CommonJS import + * const client = new ConfigServiceClient(config); + * const command = new DescribeAggregationAuthorizationsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeAggregationAuthorizationsCommandInput} for command's `input` shape. + * @see {@link DescribeAggregationAuthorizationsCommandOutput} for command's `response` shape. + * @see {@link ConfigServiceClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeAggregationAuthorizationsCommand extends $Command< DescribeAggregationAuthorizationsCommandInput, diff --git a/clients/client-config-service/commands/DescribeComplianceByConfigRuleCommand.ts b/clients/client-config-service/commands/DescribeComplianceByConfigRuleCommand.ts index 7689bab2cd4c..1965fb041c0f 100644 --- a/clients/client-config-service/commands/DescribeComplianceByConfigRuleCommand.ts +++ b/clients/client-config-service/commands/DescribeComplianceByConfigRuleCommand.ts @@ -56,6 +56,20 @@ export interface DescribeComplianceByConfigRuleCommandOutput * the rule's scope.

* * + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ConfigServiceClient, DescribeComplianceByConfigRuleCommand } from "@aws-sdk/client-config-service"; // ES Modules import + * // const { ConfigServiceClient, DescribeComplianceByConfigRuleCommand } = require("@aws-sdk/client-config-service"); // CommonJS import + * const client = new ConfigServiceClient(config); + * const command = new DescribeComplianceByConfigRuleCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeComplianceByConfigRuleCommandInput} for command's `input` shape. + * @see {@link DescribeComplianceByConfigRuleCommandOutput} for command's `response` shape. + * @see {@link ConfigServiceClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeComplianceByConfigRuleCommand extends $Command< DescribeComplianceByConfigRuleCommandInput, diff --git a/clients/client-config-service/commands/DescribeComplianceByResourceCommand.ts b/clients/client-config-service/commands/DescribeComplianceByResourceCommand.ts index f86580b2b990..85b467b61d52 100644 --- a/clients/client-config-service/commands/DescribeComplianceByResourceCommand.ts +++ b/clients/client-config-service/commands/DescribeComplianceByResourceCommand.ts @@ -57,6 +57,20 @@ export interface DescribeComplianceByResourceCommandOutput * the rule's scope.

* * + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ConfigServiceClient, DescribeComplianceByResourceCommand } from "@aws-sdk/client-config-service"; // ES Modules import + * // const { ConfigServiceClient, DescribeComplianceByResourceCommand } = require("@aws-sdk/client-config-service"); // CommonJS import + * const client = new ConfigServiceClient(config); + * const command = new DescribeComplianceByResourceCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeComplianceByResourceCommandInput} for command's `input` shape. + * @see {@link DescribeComplianceByResourceCommandOutput} for command's `response` shape. + * @see {@link ConfigServiceClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeComplianceByResourceCommand extends $Command< DescribeComplianceByResourceCommandInput, diff --git a/clients/client-config-service/commands/DescribeConfigRuleEvaluationStatusCommand.ts b/clients/client-config-service/commands/DescribeConfigRuleEvaluationStatusCommand.ts index 5a9f041a1a7c..5c534921123d 100644 --- a/clients/client-config-service/commands/DescribeConfigRuleEvaluationStatusCommand.ts +++ b/clients/client-config-service/commands/DescribeConfigRuleEvaluationStatusCommand.ts @@ -30,6 +30,20 @@ export interface DescribeConfigRuleEvaluationStatusCommandOutput * rules. The status includes information such as the last time AWS * Config invoked the rule, the last time AWS Config failed to invoke * the rule, and the related error for the last failure.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ConfigServiceClient, DescribeConfigRuleEvaluationStatusCommand } from "@aws-sdk/client-config-service"; // ES Modules import + * // const { ConfigServiceClient, DescribeConfigRuleEvaluationStatusCommand } = require("@aws-sdk/client-config-service"); // CommonJS import + * const client = new ConfigServiceClient(config); + * const command = new DescribeConfigRuleEvaluationStatusCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeConfigRuleEvaluationStatusCommandInput} for command's `input` shape. + * @see {@link DescribeConfigRuleEvaluationStatusCommandOutput} for command's `response` shape. + * @see {@link ConfigServiceClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeConfigRuleEvaluationStatusCommand extends $Command< DescribeConfigRuleEvaluationStatusCommandInput, diff --git a/clients/client-config-service/commands/DescribeConfigRulesCommand.ts b/clients/client-config-service/commands/DescribeConfigRulesCommand.ts index a5e34ba42444..be11d3dc2e28 100644 --- a/clients/client-config-service/commands/DescribeConfigRulesCommand.ts +++ b/clients/client-config-service/commands/DescribeConfigRulesCommand.ts @@ -22,6 +22,20 @@ export interface DescribeConfigRulesCommandOutput extends DescribeConfigRulesRes /** *

Returns details about your AWS Config rules.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ConfigServiceClient, DescribeConfigRulesCommand } from "@aws-sdk/client-config-service"; // ES Modules import + * // const { ConfigServiceClient, DescribeConfigRulesCommand } = require("@aws-sdk/client-config-service"); // CommonJS import + * const client = new ConfigServiceClient(config); + * const command = new DescribeConfigRulesCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeConfigRulesCommandInput} for command's `input` shape. + * @see {@link DescribeConfigRulesCommandOutput} for command's `response` shape. + * @see {@link ConfigServiceClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeConfigRulesCommand extends $Command< DescribeConfigRulesCommandInput, diff --git a/clients/client-config-service/commands/DescribeConfigurationAggregatorSourcesStatusCommand.ts b/clients/client-config-service/commands/DescribeConfigurationAggregatorSourcesStatusCommand.ts index 7d6709693466..b077c617107b 100644 --- a/clients/client-config-service/commands/DescribeConfigurationAggregatorSourcesStatusCommand.ts +++ b/clients/client-config-service/commands/DescribeConfigurationAggregatorSourcesStatusCommand.ts @@ -29,6 +29,20 @@ export interface DescribeConfigurationAggregatorSourcesStatusCommandOutput /** *

Returns status information for sources within an aggregator. * The status includes information about the last time AWS 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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ConfigServiceClient, DescribeConfigurationAggregatorSourcesStatusCommand } from "@aws-sdk/client-config-service"; // ES Modules import + * // const { ConfigServiceClient, DescribeConfigurationAggregatorSourcesStatusCommand } = require("@aws-sdk/client-config-service"); // CommonJS import + * const client = new ConfigServiceClient(config); + * const command = new DescribeConfigurationAggregatorSourcesStatusCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeConfigurationAggregatorSourcesStatusCommandInput} for command's `input` shape. + * @see {@link DescribeConfigurationAggregatorSourcesStatusCommandOutput} for command's `response` shape. + * @see {@link ConfigServiceClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeConfigurationAggregatorSourcesStatusCommand extends $Command< DescribeConfigurationAggregatorSourcesStatusCommandInput, diff --git a/clients/client-config-service/commands/DescribeConfigurationAggregatorsCommand.ts b/clients/client-config-service/commands/DescribeConfigurationAggregatorsCommand.ts index 7faf8d391c60..a51b7d78fece 100644 --- a/clients/client-config-service/commands/DescribeConfigurationAggregatorsCommand.ts +++ b/clients/client-config-service/commands/DescribeConfigurationAggregatorsCommand.ts @@ -27,6 +27,20 @@ export interface DescribeConfigurationAggregatorsCommandOutput * If the configuration aggregator is not specified, this action * returns the details for all the configuration aggregators associated * with the account.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ConfigServiceClient, DescribeConfigurationAggregatorsCommand } from "@aws-sdk/client-config-service"; // ES Modules import + * // const { ConfigServiceClient, DescribeConfigurationAggregatorsCommand } = require("@aws-sdk/client-config-service"); // CommonJS import + * const client = new ConfigServiceClient(config); + * const command = new DescribeConfigurationAggregatorsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeConfigurationAggregatorsCommandInput} for command's `input` shape. + * @see {@link DescribeConfigurationAggregatorsCommandOutput} for command's `response` shape. + * @see {@link ConfigServiceClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeConfigurationAggregatorsCommand extends $Command< DescribeConfigurationAggregatorsCommandInput, diff --git a/clients/client-config-service/commands/DescribeConfigurationRecorderStatusCommand.ts b/clients/client-config-service/commands/DescribeConfigurationRecorderStatusCommand.ts index 763d72ed785a..5c7c892ed30d 100644 --- a/clients/client-config-service/commands/DescribeConfigurationRecorderStatusCommand.ts +++ b/clients/client-config-service/commands/DescribeConfigurationRecorderStatusCommand.ts @@ -34,6 +34,20 @@ export interface DescribeConfigurationRecorderStatusCommandOutput *

Currently, you can specify only one configuration recorder * per region in your account.

* + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ConfigServiceClient, DescribeConfigurationRecorderStatusCommand } from "@aws-sdk/client-config-service"; // ES Modules import + * // const { ConfigServiceClient, DescribeConfigurationRecorderStatusCommand } = require("@aws-sdk/client-config-service"); // CommonJS import + * const client = new ConfigServiceClient(config); + * const command = new DescribeConfigurationRecorderStatusCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeConfigurationRecorderStatusCommandInput} for command's `input` shape. + * @see {@link DescribeConfigurationRecorderStatusCommandOutput} for command's `response` shape. + * @see {@link ConfigServiceClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeConfigurationRecorderStatusCommand extends $Command< DescribeConfigurationRecorderStatusCommandInput, diff --git a/clients/client-config-service/commands/DescribeConfigurationRecordersCommand.ts b/clients/client-config-service/commands/DescribeConfigurationRecordersCommand.ts index 0259d9c82f51..beab55768a5b 100644 --- a/clients/client-config-service/commands/DescribeConfigurationRecordersCommand.ts +++ b/clients/client-config-service/commands/DescribeConfigurationRecordersCommand.ts @@ -31,6 +31,20 @@ export interface DescribeConfigurationRecordersCommandOutput *

Currently, you can specify only one configuration recorder * per region in your account.

* + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ConfigServiceClient, DescribeConfigurationRecordersCommand } from "@aws-sdk/client-config-service"; // ES Modules import + * // const { ConfigServiceClient, DescribeConfigurationRecordersCommand } = require("@aws-sdk/client-config-service"); // CommonJS import + * const client = new ConfigServiceClient(config); + * const command = new DescribeConfigurationRecordersCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeConfigurationRecordersCommandInput} for command's `input` shape. + * @see {@link DescribeConfigurationRecordersCommandOutput} for command's `response` shape. + * @see {@link ConfigServiceClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeConfigurationRecordersCommand extends $Command< DescribeConfigurationRecordersCommandInput, diff --git a/clients/client-config-service/commands/DescribeConformancePackComplianceCommand.ts b/clients/client-config-service/commands/DescribeConformancePackComplianceCommand.ts index 854444ebbf13..3cb8e2710d44 100644 --- a/clients/client-config-service/commands/DescribeConformancePackComplianceCommand.ts +++ b/clients/client-config-service/commands/DescribeConformancePackComplianceCommand.ts @@ -30,6 +30,20 @@ export interface DescribeConformancePackComplianceCommandOutput * *

You must provide exact rule names.

* + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ConfigServiceClient, DescribeConformancePackComplianceCommand } from "@aws-sdk/client-config-service"; // ES Modules import + * // const { ConfigServiceClient, DescribeConformancePackComplianceCommand } = require("@aws-sdk/client-config-service"); // CommonJS import + * const client = new ConfigServiceClient(config); + * const command = new DescribeConformancePackComplianceCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeConformancePackComplianceCommandInput} for command's `input` shape. + * @see {@link DescribeConformancePackComplianceCommandOutput} for command's `response` shape. + * @see {@link ConfigServiceClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeConformancePackComplianceCommand extends $Command< DescribeConformancePackComplianceCommandInput, diff --git a/clients/client-config-service/commands/DescribeConformancePackStatusCommand.ts b/clients/client-config-service/commands/DescribeConformancePackStatusCommand.ts index c623ec84c739..5a9f36d52a3a 100644 --- a/clients/client-config-service/commands/DescribeConformancePackStatusCommand.ts +++ b/clients/client-config-service/commands/DescribeConformancePackStatusCommand.ts @@ -27,6 +27,20 @@ export interface DescribeConformancePackStatusCommandOutput * *

If there are no conformance packs then you will see an empty result.

* + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ConfigServiceClient, DescribeConformancePackStatusCommand } from "@aws-sdk/client-config-service"; // ES Modules import + * // const { ConfigServiceClient, DescribeConformancePackStatusCommand } = require("@aws-sdk/client-config-service"); // CommonJS import + * const client = new ConfigServiceClient(config); + * const command = new DescribeConformancePackStatusCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeConformancePackStatusCommandInput} for command's `input` shape. + * @see {@link DescribeConformancePackStatusCommandOutput} for command's `response` shape. + * @see {@link ConfigServiceClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeConformancePackStatusCommand extends $Command< DescribeConformancePackStatusCommandInput, diff --git a/clients/client-config-service/commands/DescribeConformancePacksCommand.ts b/clients/client-config-service/commands/DescribeConformancePacksCommand.ts index 924b8a212745..addc42c079a8 100644 --- a/clients/client-config-service/commands/DescribeConformancePacksCommand.ts +++ b/clients/client-config-service/commands/DescribeConformancePacksCommand.ts @@ -22,6 +22,20 @@ export interface DescribeConformancePacksCommandOutput extends DescribeConforman /** *

Returns a list of one or more conformance packs.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ConfigServiceClient, DescribeConformancePacksCommand } from "@aws-sdk/client-config-service"; // ES Modules import + * // const { ConfigServiceClient, DescribeConformancePacksCommand } = require("@aws-sdk/client-config-service"); // CommonJS import + * const client = new ConfigServiceClient(config); + * const command = new DescribeConformancePacksCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeConformancePacksCommandInput} for command's `input` shape. + * @see {@link DescribeConformancePacksCommandOutput} for command's `response` shape. + * @see {@link ConfigServiceClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeConformancePacksCommand extends $Command< DescribeConformancePacksCommandInput, diff --git a/clients/client-config-service/commands/DescribeDeliveryChannelStatusCommand.ts b/clients/client-config-service/commands/DescribeDeliveryChannelStatusCommand.ts index 4be28db0978c..448d966f9dd6 100644 --- a/clients/client-config-service/commands/DescribeDeliveryChannelStatusCommand.ts +++ b/clients/client-config-service/commands/DescribeDeliveryChannelStatusCommand.ts @@ -31,6 +31,20 @@ export interface DescribeDeliveryChannelStatusCommandOutput *

Currently, you can specify only one delivery channel per * region in your account.

* + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ConfigServiceClient, DescribeDeliveryChannelStatusCommand } from "@aws-sdk/client-config-service"; // ES Modules import + * // const { ConfigServiceClient, DescribeDeliveryChannelStatusCommand } = require("@aws-sdk/client-config-service"); // CommonJS import + * const client = new ConfigServiceClient(config); + * const command = new DescribeDeliveryChannelStatusCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeDeliveryChannelStatusCommandInput} for command's `input` shape. + * @see {@link DescribeDeliveryChannelStatusCommandOutput} for command's `response` shape. + * @see {@link ConfigServiceClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeDeliveryChannelStatusCommand extends $Command< DescribeDeliveryChannelStatusCommandInput, diff --git a/clients/client-config-service/commands/DescribeDeliveryChannelsCommand.ts b/clients/client-config-service/commands/DescribeDeliveryChannelsCommand.ts index 358a688a8009..9bdbe0674ba0 100644 --- a/clients/client-config-service/commands/DescribeDeliveryChannelsCommand.ts +++ b/clients/client-config-service/commands/DescribeDeliveryChannelsCommand.ts @@ -28,6 +28,20 @@ export interface DescribeDeliveryChannelsCommandOutput extends DescribeDeliveryC *

Currently, you can specify only one delivery channel per * region in your account.

* + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ConfigServiceClient, DescribeDeliveryChannelsCommand } from "@aws-sdk/client-config-service"; // ES Modules import + * // const { ConfigServiceClient, DescribeDeliveryChannelsCommand } = require("@aws-sdk/client-config-service"); // CommonJS import + * const client = new ConfigServiceClient(config); + * const command = new DescribeDeliveryChannelsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeDeliveryChannelsCommandInput} for command's `input` shape. + * @see {@link DescribeDeliveryChannelsCommandOutput} for command's `response` shape. + * @see {@link ConfigServiceClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeDeliveryChannelsCommand extends $Command< DescribeDeliveryChannelsCommandInput, diff --git a/clients/client-config-service/commands/DescribeOrganizationConfigRuleStatusesCommand.ts b/clients/client-config-service/commands/DescribeOrganizationConfigRuleStatusesCommand.ts index 47ecde75077a..9bb8a671dc47 100644 --- a/clients/client-config-service/commands/DescribeOrganizationConfigRuleStatusesCommand.ts +++ b/clients/client-config-service/commands/DescribeOrganizationConfigRuleStatusesCommand.ts @@ -36,6 +36,20 @@ export interface DescribeOrganizationConfigRuleStatusesCommandOutput * 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.

* + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ConfigServiceClient, DescribeOrganizationConfigRuleStatusesCommand } from "@aws-sdk/client-config-service"; // ES Modules import + * // const { ConfigServiceClient, DescribeOrganizationConfigRuleStatusesCommand } = require("@aws-sdk/client-config-service"); // CommonJS import + * const client = new ConfigServiceClient(config); + * const command = new DescribeOrganizationConfigRuleStatusesCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeOrganizationConfigRuleStatusesCommandInput} for command's `input` shape. + * @see {@link DescribeOrganizationConfigRuleStatusesCommandOutput} for command's `response` shape. + * @see {@link ConfigServiceClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeOrganizationConfigRuleStatusesCommand extends $Command< DescribeOrganizationConfigRuleStatusesCommandInput, diff --git a/clients/client-config-service/commands/DescribeOrganizationConfigRulesCommand.ts b/clients/client-config-service/commands/DescribeOrganizationConfigRulesCommand.ts index 9f636d62e6ba..6f5bc18291d0 100644 --- a/clients/client-config-service/commands/DescribeOrganizationConfigRulesCommand.ts +++ b/clients/client-config-service/commands/DescribeOrganizationConfigRulesCommand.ts @@ -30,6 +30,20 @@ export interface DescribeOrganizationConfigRulesCommandOutput * 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.

* + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ConfigServiceClient, DescribeOrganizationConfigRulesCommand } from "@aws-sdk/client-config-service"; // ES Modules import + * // const { ConfigServiceClient, DescribeOrganizationConfigRulesCommand } = require("@aws-sdk/client-config-service"); // CommonJS import + * const client = new ConfigServiceClient(config); + * const command = new DescribeOrganizationConfigRulesCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeOrganizationConfigRulesCommandInput} for command's `input` shape. + * @see {@link DescribeOrganizationConfigRulesCommandOutput} for command's `response` shape. + * @see {@link ConfigServiceClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeOrganizationConfigRulesCommand extends $Command< DescribeOrganizationConfigRulesCommandInput, diff --git a/clients/client-config-service/commands/DescribeOrganizationConformancePackStatusesCommand.ts b/clients/client-config-service/commands/DescribeOrganizationConformancePackStatusesCommand.ts index 3a5a3de67667..8e2c18381dac 100644 --- a/clients/client-config-service/commands/DescribeOrganizationConformancePackStatusesCommand.ts +++ b/clients/client-config-service/commands/DescribeOrganizationConformancePackStatusesCommand.ts @@ -35,6 +35,20 @@ export interface DescribeOrganizationConformancePackStatusesCommandOutput * 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.

* + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ConfigServiceClient, DescribeOrganizationConformancePackStatusesCommand } from "@aws-sdk/client-config-service"; // ES Modules import + * // const { ConfigServiceClient, DescribeOrganizationConformancePackStatusesCommand } = require("@aws-sdk/client-config-service"); // CommonJS import + * const client = new ConfigServiceClient(config); + * const command = new DescribeOrganizationConformancePackStatusesCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeOrganizationConformancePackStatusesCommandInput} for command's `input` shape. + * @see {@link DescribeOrganizationConformancePackStatusesCommandOutput} for command's `response` shape. + * @see {@link ConfigServiceClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeOrganizationConformancePackStatusesCommand extends $Command< DescribeOrganizationConformancePackStatusesCommandInput, diff --git a/clients/client-config-service/commands/DescribeOrganizationConformancePacksCommand.ts b/clients/client-config-service/commands/DescribeOrganizationConformancePacksCommand.ts index eccf6e9f7734..c635aca5ee49 100644 --- a/clients/client-config-service/commands/DescribeOrganizationConformancePacksCommand.ts +++ b/clients/client-config-service/commands/DescribeOrganizationConformancePacksCommand.ts @@ -32,6 +32,20 @@ export interface DescribeOrganizationConformancePacksCommandOutput *

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.

* + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ConfigServiceClient, DescribeOrganizationConformancePacksCommand } from "@aws-sdk/client-config-service"; // ES Modules import + * // const { ConfigServiceClient, DescribeOrganizationConformancePacksCommand } = require("@aws-sdk/client-config-service"); // CommonJS import + * const client = new ConfigServiceClient(config); + * const command = new DescribeOrganizationConformancePacksCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeOrganizationConformancePacksCommandInput} for command's `input` shape. + * @see {@link DescribeOrganizationConformancePacksCommandOutput} for command's `response` shape. + * @see {@link ConfigServiceClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeOrganizationConformancePacksCommand extends $Command< DescribeOrganizationConformancePacksCommandInput, diff --git a/clients/client-config-service/commands/DescribePendingAggregationRequestsCommand.ts b/clients/client-config-service/commands/DescribePendingAggregationRequestsCommand.ts index 37304a772530..30d91c8a3c45 100644 --- a/clients/client-config-service/commands/DescribePendingAggregationRequestsCommand.ts +++ b/clients/client-config-service/commands/DescribePendingAggregationRequestsCommand.ts @@ -27,6 +27,20 @@ export interface DescribePendingAggregationRequestsCommandOutput /** *

Returns a list of all pending aggregation requests.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ConfigServiceClient, DescribePendingAggregationRequestsCommand } from "@aws-sdk/client-config-service"; // ES Modules import + * // const { ConfigServiceClient, DescribePendingAggregationRequestsCommand } = require("@aws-sdk/client-config-service"); // CommonJS import + * const client = new ConfigServiceClient(config); + * const command = new DescribePendingAggregationRequestsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribePendingAggregationRequestsCommandInput} for command's `input` shape. + * @see {@link DescribePendingAggregationRequestsCommandOutput} for command's `response` shape. + * @see {@link ConfigServiceClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribePendingAggregationRequestsCommand extends $Command< DescribePendingAggregationRequestsCommandInput, diff --git a/clients/client-config-service/commands/DescribeRemediationConfigurationsCommand.ts b/clients/client-config-service/commands/DescribeRemediationConfigurationsCommand.ts index 9bc92ebf689c..438cb4693dc0 100644 --- a/clients/client-config-service/commands/DescribeRemediationConfigurationsCommand.ts +++ b/clients/client-config-service/commands/DescribeRemediationConfigurationsCommand.ts @@ -27,6 +27,20 @@ export interface DescribeRemediationConfigurationsCommandOutput /** *

Returns the details of one or more remediation configurations.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ConfigServiceClient, DescribeRemediationConfigurationsCommand } from "@aws-sdk/client-config-service"; // ES Modules import + * // const { ConfigServiceClient, DescribeRemediationConfigurationsCommand } = require("@aws-sdk/client-config-service"); // CommonJS import + * const client = new ConfigServiceClient(config); + * const command = new DescribeRemediationConfigurationsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeRemediationConfigurationsCommandInput} for command's `input` shape. + * @see {@link DescribeRemediationConfigurationsCommandOutput} for command's `response` shape. + * @see {@link ConfigServiceClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeRemediationConfigurationsCommand extends $Command< DescribeRemediationConfigurationsCommandInput, diff --git a/clients/client-config-service/commands/DescribeRemediationExceptionsCommand.ts b/clients/client-config-service/commands/DescribeRemediationExceptionsCommand.ts index 84c962ab084b..06bf5895d69c 100644 --- a/clients/client-config-service/commands/DescribeRemediationExceptionsCommand.ts +++ b/clients/client-config-service/commands/DescribeRemediationExceptionsCommand.ts @@ -31,6 +31,20 @@ export interface DescribeRemediationExceptionsCommandOutput *

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.

* + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ConfigServiceClient, DescribeRemediationExceptionsCommand } from "@aws-sdk/client-config-service"; // ES Modules import + * // const { ConfigServiceClient, DescribeRemediationExceptionsCommand } = require("@aws-sdk/client-config-service"); // CommonJS import + * const client = new ConfigServiceClient(config); + * const command = new DescribeRemediationExceptionsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeRemediationExceptionsCommandInput} for command's `input` shape. + * @see {@link DescribeRemediationExceptionsCommandOutput} for command's `response` shape. + * @see {@link ConfigServiceClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeRemediationExceptionsCommand extends $Command< DescribeRemediationExceptionsCommandInput, diff --git a/clients/client-config-service/commands/DescribeRemediationExecutionStatusCommand.ts b/clients/client-config-service/commands/DescribeRemediationExecutionStatusCommand.ts index 49f1655271ef..4f06431e169f 100644 --- a/clients/client-config-service/commands/DescribeRemediationExecutionStatusCommand.ts +++ b/clients/client-config-service/commands/DescribeRemediationExecutionStatusCommand.ts @@ -28,6 +28,20 @@ export interface DescribeRemediationExecutionStatusCommandOutput /** *

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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ConfigServiceClient, DescribeRemediationExecutionStatusCommand } from "@aws-sdk/client-config-service"; // ES Modules import + * // const { ConfigServiceClient, DescribeRemediationExecutionStatusCommand } = require("@aws-sdk/client-config-service"); // CommonJS import + * const client = new ConfigServiceClient(config); + * const command = new DescribeRemediationExecutionStatusCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeRemediationExecutionStatusCommandInput} for command's `input` shape. + * @see {@link DescribeRemediationExecutionStatusCommandOutput} for command's `response` shape. + * @see {@link ConfigServiceClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeRemediationExecutionStatusCommand extends $Command< DescribeRemediationExecutionStatusCommandInput, diff --git a/clients/client-config-service/commands/DescribeRetentionConfigurationsCommand.ts b/clients/client-config-service/commands/DescribeRetentionConfigurationsCommand.ts index 16629c7801a7..281394d9fb1e 100644 --- a/clients/client-config-service/commands/DescribeRetentionConfigurationsCommand.ts +++ b/clients/client-config-service/commands/DescribeRetentionConfigurationsCommand.ts @@ -31,6 +31,20 @@ export interface DescribeRetentionConfigurationsCommandOutput *

Currently, AWS Config supports only one retention * configuration per region in your account.

* + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ConfigServiceClient, DescribeRetentionConfigurationsCommand } from "@aws-sdk/client-config-service"; // ES Modules import + * // const { ConfigServiceClient, DescribeRetentionConfigurationsCommand } = require("@aws-sdk/client-config-service"); // CommonJS import + * const client = new ConfigServiceClient(config); + * const command = new DescribeRetentionConfigurationsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeRetentionConfigurationsCommandInput} for command's `input` shape. + * @see {@link DescribeRetentionConfigurationsCommandOutput} for command's `response` shape. + * @see {@link ConfigServiceClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeRetentionConfigurationsCommand extends $Command< DescribeRetentionConfigurationsCommandInput, diff --git a/clients/client-config-service/commands/GetAggregateComplianceDetailsByConfigRuleCommand.ts b/clients/client-config-service/commands/GetAggregateComplianceDetailsByConfigRuleCommand.ts index c9f385cfccf8..d757c77cc863 100644 --- a/clients/client-config-service/commands/GetAggregateComplianceDetailsByConfigRuleCommand.ts +++ b/clients/client-config-service/commands/GetAggregateComplianceDetailsByConfigRuleCommand.ts @@ -36,6 +36,20 @@ export interface GetAggregateComplianceDetailsByConfigRuleCommandOutput * have a nextToken, the results are displayed on the next * page.

* + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ConfigServiceClient, GetAggregateComplianceDetailsByConfigRuleCommand } from "@aws-sdk/client-config-service"; // ES Modules import + * // const { ConfigServiceClient, GetAggregateComplianceDetailsByConfigRuleCommand } = require("@aws-sdk/client-config-service"); // CommonJS import + * const client = new ConfigServiceClient(config); + * const command = new GetAggregateComplianceDetailsByConfigRuleCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetAggregateComplianceDetailsByConfigRuleCommandInput} for command's `input` shape. + * @see {@link GetAggregateComplianceDetailsByConfigRuleCommandOutput} for command's `response` shape. + * @see {@link ConfigServiceClientResolvedConfig | config} for command's `input` shape. + * */ export class GetAggregateComplianceDetailsByConfigRuleCommand extends $Command< GetAggregateComplianceDetailsByConfigRuleCommandInput, diff --git a/clients/client-config-service/commands/GetAggregateConfigRuleComplianceSummaryCommand.ts b/clients/client-config-service/commands/GetAggregateConfigRuleComplianceSummaryCommand.ts index f03452caa05b..cb60e659f1a9 100644 --- a/clients/client-config-service/commands/GetAggregateConfigRuleComplianceSummaryCommand.ts +++ b/clients/client-config-service/commands/GetAggregateConfigRuleComplianceSummaryCommand.ts @@ -34,6 +34,20 @@ export interface GetAggregateConfigRuleComplianceSummaryCommandOutput * have a nextToken, the results are displayed on the next * page.

* + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ConfigServiceClient, GetAggregateConfigRuleComplianceSummaryCommand } from "@aws-sdk/client-config-service"; // ES Modules import + * // const { ConfigServiceClient, GetAggregateConfigRuleComplianceSummaryCommand } = require("@aws-sdk/client-config-service"); // CommonJS import + * const client = new ConfigServiceClient(config); + * const command = new GetAggregateConfigRuleComplianceSummaryCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetAggregateConfigRuleComplianceSummaryCommandInput} for command's `input` shape. + * @see {@link GetAggregateConfigRuleComplianceSummaryCommandOutput} for command's `response` shape. + * @see {@link ConfigServiceClientResolvedConfig | config} for command's `input` shape. + * */ export class GetAggregateConfigRuleComplianceSummaryCommand extends $Command< GetAggregateConfigRuleComplianceSummaryCommandInput, diff --git a/clients/client-config-service/commands/GetAggregateConformancePackComplianceSummaryCommand.ts b/clients/client-config-service/commands/GetAggregateConformancePackComplianceSummaryCommand.ts index 5bdd4a3a1d12..7281460960f1 100644 --- a/clients/client-config-service/commands/GetAggregateConformancePackComplianceSummaryCommand.ts +++ b/clients/client-config-service/commands/GetAggregateConformancePackComplianceSummaryCommand.ts @@ -31,6 +31,20 @@ export interface GetAggregateConformancePackComplianceSummaryCommandOutput * *

The results can return an empty result page, but if you have a nextToken, the results are displayed on the next page.

* + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ConfigServiceClient, GetAggregateConformancePackComplianceSummaryCommand } from "@aws-sdk/client-config-service"; // ES Modules import + * // const { ConfigServiceClient, GetAggregateConformancePackComplianceSummaryCommand } = require("@aws-sdk/client-config-service"); // CommonJS import + * const client = new ConfigServiceClient(config); + * const command = new GetAggregateConformancePackComplianceSummaryCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetAggregateConformancePackComplianceSummaryCommandInput} for command's `input` shape. + * @see {@link GetAggregateConformancePackComplianceSummaryCommandOutput} for command's `response` shape. + * @see {@link ConfigServiceClientResolvedConfig | config} for command's `input` shape. + * */ export class GetAggregateConformancePackComplianceSummaryCommand extends $Command< GetAggregateConformancePackComplianceSummaryCommandInput, diff --git a/clients/client-config-service/commands/GetAggregateDiscoveredResourceCountsCommand.ts b/clients/client-config-service/commands/GetAggregateDiscoveredResourceCountsCommand.ts index 730562048c5b..fd109d7e0d0a 100644 --- a/clients/client-config-service/commands/GetAggregateDiscoveredResourceCountsCommand.ts +++ b/clients/client-config-service/commands/GetAggregateDiscoveredResourceCountsCommand.ts @@ -29,6 +29,20 @@ export interface GetAggregateDiscoveredResourceCountsCommandOutput *

Returns the resource counts across accounts and regions that are present in your AWS 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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ConfigServiceClient, GetAggregateDiscoveredResourceCountsCommand } from "@aws-sdk/client-config-service"; // ES Modules import + * // const { ConfigServiceClient, GetAggregateDiscoveredResourceCountsCommand } = require("@aws-sdk/client-config-service"); // CommonJS import + * const client = new ConfigServiceClient(config); + * const command = new GetAggregateDiscoveredResourceCountsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetAggregateDiscoveredResourceCountsCommandInput} for command's `input` shape. + * @see {@link GetAggregateDiscoveredResourceCountsCommandOutput} for command's `response` shape. + * @see {@link ConfigServiceClientResolvedConfig | config} for command's `input` shape. + * */ export class GetAggregateDiscoveredResourceCountsCommand extends $Command< GetAggregateDiscoveredResourceCountsCommandInput, diff --git a/clients/client-config-service/commands/GetAggregateResourceConfigCommand.ts b/clients/client-config-service/commands/GetAggregateResourceConfigCommand.ts index a311b3d1caf0..c609d1205184 100644 --- a/clients/client-config-service/commands/GetAggregateResourceConfigCommand.ts +++ b/clients/client-config-service/commands/GetAggregateResourceConfigCommand.ts @@ -22,6 +22,20 @@ export interface GetAggregateResourceConfigCommandOutput extends GetAggregateRes /** *

Returns configuration item that is aggregated for your specific resource in a specific source account and region.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ConfigServiceClient, GetAggregateResourceConfigCommand } from "@aws-sdk/client-config-service"; // ES Modules import + * // const { ConfigServiceClient, GetAggregateResourceConfigCommand } = require("@aws-sdk/client-config-service"); // CommonJS import + * const client = new ConfigServiceClient(config); + * const command = new GetAggregateResourceConfigCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetAggregateResourceConfigCommandInput} for command's `input` shape. + * @see {@link GetAggregateResourceConfigCommandOutput} for command's `response` shape. + * @see {@link ConfigServiceClientResolvedConfig | config} for command's `input` shape. + * */ export class GetAggregateResourceConfigCommand extends $Command< GetAggregateResourceConfigCommandInput, diff --git a/clients/client-config-service/commands/GetComplianceDetailsByConfigRuleCommand.ts b/clients/client-config-service/commands/GetComplianceDetailsByConfigRuleCommand.ts index 360c19fbca5d..2364f14beb67 100644 --- a/clients/client-config-service/commands/GetComplianceDetailsByConfigRuleCommand.ts +++ b/clients/client-config-service/commands/GetComplianceDetailsByConfigRuleCommand.ts @@ -27,6 +27,20 @@ export interface GetComplianceDetailsByConfigRuleCommandOutput * rule. The results indicate which AWS resources were evaluated by the * rule, when each resource was last evaluated, and whether each * resource complies with the rule.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ConfigServiceClient, GetComplianceDetailsByConfigRuleCommand } from "@aws-sdk/client-config-service"; // ES Modules import + * // const { ConfigServiceClient, GetComplianceDetailsByConfigRuleCommand } = require("@aws-sdk/client-config-service"); // CommonJS import + * const client = new ConfigServiceClient(config); + * const command = new GetComplianceDetailsByConfigRuleCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetComplianceDetailsByConfigRuleCommandInput} for command's `input` shape. + * @see {@link GetComplianceDetailsByConfigRuleCommandOutput} for command's `response` shape. + * @see {@link ConfigServiceClientResolvedConfig | config} for command's `input` shape. + * */ export class GetComplianceDetailsByConfigRuleCommand extends $Command< GetComplianceDetailsByConfigRuleCommandInput, diff --git a/clients/client-config-service/commands/GetComplianceDetailsByResourceCommand.ts b/clients/client-config-service/commands/GetComplianceDetailsByResourceCommand.ts index 3abe0bb910e7..1a75bdc34999 100644 --- a/clients/client-config-service/commands/GetComplianceDetailsByResourceCommand.ts +++ b/clients/client-config-service/commands/GetComplianceDetailsByResourceCommand.ts @@ -27,6 +27,20 @@ export interface GetComplianceDetailsByResourceCommandOutput * The results indicate which AWS Config rules were used to evaluate * the resource, when each rule was last used, and whether the resource * complies with each rule.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ConfigServiceClient, GetComplianceDetailsByResourceCommand } from "@aws-sdk/client-config-service"; // ES Modules import + * // const { ConfigServiceClient, GetComplianceDetailsByResourceCommand } = require("@aws-sdk/client-config-service"); // CommonJS import + * const client = new ConfigServiceClient(config); + * const command = new GetComplianceDetailsByResourceCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetComplianceDetailsByResourceCommandInput} for command's `input` shape. + * @see {@link GetComplianceDetailsByResourceCommandOutput} for command's `response` shape. + * @see {@link ConfigServiceClientResolvedConfig | config} for command's `input` shape. + * */ export class GetComplianceDetailsByResourceCommand extends $Command< GetComplianceDetailsByResourceCommandInput, diff --git a/clients/client-config-service/commands/GetComplianceSummaryByConfigRuleCommand.ts b/clients/client-config-service/commands/GetComplianceSummaryByConfigRuleCommand.ts index b4403c42ab1e..45b9dbcc4a14 100644 --- a/clients/client-config-service/commands/GetComplianceSummaryByConfigRuleCommand.ts +++ b/clients/client-config-service/commands/GetComplianceSummaryByConfigRuleCommand.ts @@ -25,6 +25,20 @@ export interface GetComplianceSummaryByConfigRuleCommandOutput /** *

Returns the number of AWS Config rules that are compliant and * noncompliant, up to a maximum of 25 for each.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ConfigServiceClient, GetComplianceSummaryByConfigRuleCommand } from "@aws-sdk/client-config-service"; // ES Modules import + * // const { ConfigServiceClient, GetComplianceSummaryByConfigRuleCommand } = require("@aws-sdk/client-config-service"); // CommonJS import + * const client = new ConfigServiceClient(config); + * const command = new GetComplianceSummaryByConfigRuleCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetComplianceSummaryByConfigRuleCommandInput} for command's `input` shape. + * @see {@link GetComplianceSummaryByConfigRuleCommandOutput} for command's `response` shape. + * @see {@link ConfigServiceClientResolvedConfig | config} for command's `input` shape. + * */ export class GetComplianceSummaryByConfigRuleCommand extends $Command< GetComplianceSummaryByConfigRuleCommandInput, diff --git a/clients/client-config-service/commands/GetComplianceSummaryByResourceTypeCommand.ts b/clients/client-config-service/commands/GetComplianceSummaryByResourceTypeCommand.ts index f7a045f4acbe..3ec06b97c685 100644 --- a/clients/client-config-service/commands/GetComplianceSummaryByResourceTypeCommand.ts +++ b/clients/client-config-service/commands/GetComplianceSummaryByResourceTypeCommand.ts @@ -30,6 +30,20 @@ export interface GetComplianceSummaryByResourceTypeCommandOutput * 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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ConfigServiceClient, GetComplianceSummaryByResourceTypeCommand } from "@aws-sdk/client-config-service"; // ES Modules import + * // const { ConfigServiceClient, GetComplianceSummaryByResourceTypeCommand } = require("@aws-sdk/client-config-service"); // CommonJS import + * const client = new ConfigServiceClient(config); + * const command = new GetComplianceSummaryByResourceTypeCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetComplianceSummaryByResourceTypeCommandInput} for command's `input` shape. + * @see {@link GetComplianceSummaryByResourceTypeCommandOutput} for command's `response` shape. + * @see {@link ConfigServiceClientResolvedConfig | config} for command's `input` shape. + * */ export class GetComplianceSummaryByResourceTypeCommand extends $Command< GetComplianceSummaryByResourceTypeCommandInput, diff --git a/clients/client-config-service/commands/GetConformancePackComplianceDetailsCommand.ts b/clients/client-config-service/commands/GetConformancePackComplianceDetailsCommand.ts index a7960ad7122e..7d3c82530ad2 100644 --- a/clients/client-config-service/commands/GetConformancePackComplianceDetailsCommand.ts +++ b/clients/client-config-service/commands/GetConformancePackComplianceDetailsCommand.ts @@ -27,6 +27,20 @@ export interface GetConformancePackComplianceDetailsCommandOutput /** *

Returns compliance details of a conformance pack for all AWS resources that are monitered by conformance pack.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ConfigServiceClient, GetConformancePackComplianceDetailsCommand } from "@aws-sdk/client-config-service"; // ES Modules import + * // const { ConfigServiceClient, GetConformancePackComplianceDetailsCommand } = require("@aws-sdk/client-config-service"); // CommonJS import + * const client = new ConfigServiceClient(config); + * const command = new GetConformancePackComplianceDetailsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetConformancePackComplianceDetailsCommandInput} for command's `input` shape. + * @see {@link GetConformancePackComplianceDetailsCommandOutput} for command's `response` shape. + * @see {@link ConfigServiceClientResolvedConfig | config} for command's `input` shape. + * */ export class GetConformancePackComplianceDetailsCommand extends $Command< GetConformancePackComplianceDetailsCommandInput, diff --git a/clients/client-config-service/commands/GetConformancePackComplianceSummaryCommand.ts b/clients/client-config-service/commands/GetConformancePackComplianceSummaryCommand.ts index 49f3c431d50a..f205cfc8dda9 100644 --- a/clients/client-config-service/commands/GetConformancePackComplianceSummaryCommand.ts +++ b/clients/client-config-service/commands/GetConformancePackComplianceSummaryCommand.ts @@ -27,6 +27,20 @@ export interface GetConformancePackComplianceSummaryCommandOutput /** *

Returns compliance details for the conformance pack based on the cumulative compliance results of all the rules in that conformance pack.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ConfigServiceClient, GetConformancePackComplianceSummaryCommand } from "@aws-sdk/client-config-service"; // ES Modules import + * // const { ConfigServiceClient, GetConformancePackComplianceSummaryCommand } = require("@aws-sdk/client-config-service"); // CommonJS import + * const client = new ConfigServiceClient(config); + * const command = new GetConformancePackComplianceSummaryCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetConformancePackComplianceSummaryCommandInput} for command's `input` shape. + * @see {@link GetConformancePackComplianceSummaryCommandOutput} for command's `response` shape. + * @see {@link ConfigServiceClientResolvedConfig | config} for command's `input` shape. + * */ export class GetConformancePackComplianceSummaryCommand extends $Command< GetConformancePackComplianceSummaryCommandInput, diff --git a/clients/client-config-service/commands/GetDiscoveredResourceCountsCommand.ts b/clients/client-config-service/commands/GetDiscoveredResourceCountsCommand.ts index c82125aa0a61..40156ce598b6 100644 --- a/clients/client-config-service/commands/GetDiscoveredResourceCountsCommand.ts +++ b/clients/client-config-service/commands/GetDiscoveredResourceCountsCommand.ts @@ -87,6 +87,20 @@ export interface GetDiscoveredResourceCountsCommandOutput * GetDiscoveredResourceCounts action. *

* + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ConfigServiceClient, GetDiscoveredResourceCountsCommand } from "@aws-sdk/client-config-service"; // ES Modules import + * // const { ConfigServiceClient, GetDiscoveredResourceCountsCommand } = require("@aws-sdk/client-config-service"); // CommonJS import + * const client = new ConfigServiceClient(config); + * const command = new GetDiscoveredResourceCountsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetDiscoveredResourceCountsCommandInput} for command's `input` shape. + * @see {@link GetDiscoveredResourceCountsCommandOutput} for command's `response` shape. + * @see {@link ConfigServiceClientResolvedConfig | config} for command's `input` shape. + * */ export class GetDiscoveredResourceCountsCommand extends $Command< GetDiscoveredResourceCountsCommandInput, diff --git a/clients/client-config-service/commands/GetOrganizationConfigRuleDetailedStatusCommand.ts b/clients/client-config-service/commands/GetOrganizationConfigRuleDetailedStatusCommand.ts index cec8ab1c663f..563b7d0d0489 100644 --- a/clients/client-config-service/commands/GetOrganizationConfigRuleDetailedStatusCommand.ts +++ b/clients/client-config-service/commands/GetOrganizationConfigRuleDetailedStatusCommand.ts @@ -28,6 +28,20 @@ export interface GetOrganizationConfigRuleDetailedStatusCommandOutput /** *

Returns detailed status for each member account within an organization for a given organization config rule.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ConfigServiceClient, GetOrganizationConfigRuleDetailedStatusCommand } from "@aws-sdk/client-config-service"; // ES Modules import + * // const { ConfigServiceClient, GetOrganizationConfigRuleDetailedStatusCommand } = require("@aws-sdk/client-config-service"); // CommonJS import + * const client = new ConfigServiceClient(config); + * const command = new GetOrganizationConfigRuleDetailedStatusCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetOrganizationConfigRuleDetailedStatusCommandInput} for command's `input` shape. + * @see {@link GetOrganizationConfigRuleDetailedStatusCommandOutput} for command's `response` shape. + * @see {@link ConfigServiceClientResolvedConfig | config} for command's `input` shape. + * */ export class GetOrganizationConfigRuleDetailedStatusCommand extends $Command< GetOrganizationConfigRuleDetailedStatusCommandInput, diff --git a/clients/client-config-service/commands/GetOrganizationConformancePackDetailedStatusCommand.ts b/clients/client-config-service/commands/GetOrganizationConformancePackDetailedStatusCommand.ts index f2f31d3d9b0c..7f5277b63549 100644 --- a/clients/client-config-service/commands/GetOrganizationConformancePackDetailedStatusCommand.ts +++ b/clients/client-config-service/commands/GetOrganizationConformancePackDetailedStatusCommand.ts @@ -28,6 +28,20 @@ export interface GetOrganizationConformancePackDetailedStatusCommandOutput /** *

Returns detailed status for each member account within an organization for a given organization conformance pack.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ConfigServiceClient, GetOrganizationConformancePackDetailedStatusCommand } from "@aws-sdk/client-config-service"; // ES Modules import + * // const { ConfigServiceClient, GetOrganizationConformancePackDetailedStatusCommand } = require("@aws-sdk/client-config-service"); // CommonJS import + * const client = new ConfigServiceClient(config); + * const command = new GetOrganizationConformancePackDetailedStatusCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetOrganizationConformancePackDetailedStatusCommandInput} for command's `input` shape. + * @see {@link GetOrganizationConformancePackDetailedStatusCommandOutput} for command's `response` shape. + * @see {@link ConfigServiceClientResolvedConfig | config} for command's `input` shape. + * */ export class GetOrganizationConformancePackDetailedStatusCommand extends $Command< GetOrganizationConformancePackDetailedStatusCommandInput, diff --git a/clients/client-config-service/commands/GetResourceConfigHistoryCommand.ts b/clients/client-config-service/commands/GetResourceConfigHistoryCommand.ts index 12b39be2997a..590350c693ef 100644 --- a/clients/client-config-service/commands/GetResourceConfigHistoryCommand.ts +++ b/clients/client-config-service/commands/GetResourceConfigHistoryCommand.ts @@ -41,6 +41,20 @@ export interface GetResourceConfigHistoryCommandOutput extends GetResourceConfig * you can make another call, using the * nextToken.

* + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ConfigServiceClient, GetResourceConfigHistoryCommand } from "@aws-sdk/client-config-service"; // ES Modules import + * // const { ConfigServiceClient, GetResourceConfigHistoryCommand } = require("@aws-sdk/client-config-service"); // CommonJS import + * const client = new ConfigServiceClient(config); + * const command = new GetResourceConfigHistoryCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetResourceConfigHistoryCommandInput} for command's `input` shape. + * @see {@link GetResourceConfigHistoryCommandOutput} for command's `response` shape. + * @see {@link ConfigServiceClientResolvedConfig | config} for command's `input` shape. + * */ export class GetResourceConfigHistoryCommand extends $Command< GetResourceConfigHistoryCommandInput, diff --git a/clients/client-config-service/commands/GetStoredQueryCommand.ts b/clients/client-config-service/commands/GetStoredQueryCommand.ts index 1e91066e55cf..57b9c307b9d3 100644 --- a/clients/client-config-service/commands/GetStoredQueryCommand.ts +++ b/clients/client-config-service/commands/GetStoredQueryCommand.ts @@ -22,6 +22,20 @@ export interface GetStoredQueryCommandOutput extends GetStoredQueryResponse, __M /** *

Returns the details of a specific stored query.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ConfigServiceClient, GetStoredQueryCommand } from "@aws-sdk/client-config-service"; // ES Modules import + * // const { ConfigServiceClient, GetStoredQueryCommand } = require("@aws-sdk/client-config-service"); // CommonJS import + * const client = new ConfigServiceClient(config); + * const command = new GetStoredQueryCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetStoredQueryCommandInput} for command's `input` shape. + * @see {@link GetStoredQueryCommandOutput} for command's `response` shape. + * @see {@link ConfigServiceClientResolvedConfig | config} for command's `input` shape. + * */ export class GetStoredQueryCommand extends $Command< GetStoredQueryCommandInput, diff --git a/clients/client-config-service/commands/ListAggregateDiscoveredResourcesCommand.ts b/clients/client-config-service/commands/ListAggregateDiscoveredResourcesCommand.ts index a30ed5a449bd..49e1d71e6b20 100644 --- a/clients/client-config-service/commands/ListAggregateDiscoveredResourcesCommand.ts +++ b/clients/client-config-service/commands/ListAggregateDiscoveredResourcesCommand.ts @@ -27,6 +27,20 @@ export interface ListAggregateDiscoveredResourcesCommandOutput * 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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ConfigServiceClient, ListAggregateDiscoveredResourcesCommand } from "@aws-sdk/client-config-service"; // ES Modules import + * // const { ConfigServiceClient, ListAggregateDiscoveredResourcesCommand } = require("@aws-sdk/client-config-service"); // CommonJS import + * const client = new ConfigServiceClient(config); + * const command = new ListAggregateDiscoveredResourcesCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListAggregateDiscoveredResourcesCommandInput} for command's `input` shape. + * @see {@link ListAggregateDiscoveredResourcesCommandOutput} for command's `response` shape. + * @see {@link ConfigServiceClientResolvedConfig | config} for command's `input` shape. + * */ export class ListAggregateDiscoveredResourcesCommand extends $Command< ListAggregateDiscoveredResourcesCommandInput, diff --git a/clients/client-config-service/commands/ListDiscoveredResourcesCommand.ts b/clients/client-config-service/commands/ListDiscoveredResourcesCommand.ts index c793dc84dc26..e9c72d709be3 100644 --- a/clients/client-config-service/commands/ListDiscoveredResourcesCommand.ts +++ b/clients/client-config-service/commands/ListDiscoveredResourcesCommand.ts @@ -38,6 +38,20 @@ export interface ListDiscoveredResourcesCommandOutput extends ListDiscoveredReso * nextToken string. To get the next page of results, * run the request again and specify the string for the * nextToken parameter.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ConfigServiceClient, ListDiscoveredResourcesCommand } from "@aws-sdk/client-config-service"; // ES Modules import + * // const { ConfigServiceClient, ListDiscoveredResourcesCommand } = require("@aws-sdk/client-config-service"); // CommonJS import + * const client = new ConfigServiceClient(config); + * const command = new ListDiscoveredResourcesCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListDiscoveredResourcesCommandInput} for command's `input` shape. + * @see {@link ListDiscoveredResourcesCommandOutput} for command's `response` shape. + * @see {@link ConfigServiceClientResolvedConfig | config} for command's `input` shape. + * */ export class ListDiscoveredResourcesCommand extends $Command< ListDiscoveredResourcesCommandInput, diff --git a/clients/client-config-service/commands/ListStoredQueriesCommand.ts b/clients/client-config-service/commands/ListStoredQueriesCommand.ts index be1c39133c79..f53de046e4c6 100644 --- a/clients/client-config-service/commands/ListStoredQueriesCommand.ts +++ b/clients/client-config-service/commands/ListStoredQueriesCommand.ts @@ -22,6 +22,20 @@ export interface ListStoredQueriesCommandOutput extends ListStoredQueriesRespons /** *

Lists the stored queries for a single AWS account and a single AWS Region. The default is 100.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ConfigServiceClient, ListStoredQueriesCommand } from "@aws-sdk/client-config-service"; // ES Modules import + * // const { ConfigServiceClient, ListStoredQueriesCommand } = require("@aws-sdk/client-config-service"); // CommonJS import + * const client = new ConfigServiceClient(config); + * const command = new ListStoredQueriesCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListStoredQueriesCommandInput} for command's `input` shape. + * @see {@link ListStoredQueriesCommandOutput} for command's `response` shape. + * @see {@link ConfigServiceClientResolvedConfig | config} for command's `input` shape. + * */ export class ListStoredQueriesCommand extends $Command< ListStoredQueriesCommandInput, diff --git a/clients/client-config-service/commands/ListTagsForResourceCommand.ts b/clients/client-config-service/commands/ListTagsForResourceCommand.ts index e76180f14968..1afe7c3ab3d2 100644 --- a/clients/client-config-service/commands/ListTagsForResourceCommand.ts +++ b/clients/client-config-service/commands/ListTagsForResourceCommand.ts @@ -22,6 +22,20 @@ export interface ListTagsForResourceCommandOutput extends ListTagsForResourceRes /** *

List the tags for AWS Config resource.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ConfigServiceClient, ListTagsForResourceCommand } from "@aws-sdk/client-config-service"; // ES Modules import + * // const { ConfigServiceClient, ListTagsForResourceCommand } = require("@aws-sdk/client-config-service"); // CommonJS import + * const client = new ConfigServiceClient(config); + * const command = new ListTagsForResourceCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListTagsForResourceCommandInput} for command's `input` shape. + * @see {@link ListTagsForResourceCommandOutput} for command's `response` shape. + * @see {@link ConfigServiceClientResolvedConfig | config} for command's `input` shape. + * */ export class ListTagsForResourceCommand extends $Command< ListTagsForResourceCommandInput, diff --git a/clients/client-config-service/commands/PutAggregationAuthorizationCommand.ts b/clients/client-config-service/commands/PutAggregationAuthorizationCommand.ts index 92cc9dc24cfb..fe33751e3b90 100644 --- a/clients/client-config-service/commands/PutAggregationAuthorizationCommand.ts +++ b/clients/client-config-service/commands/PutAggregationAuthorizationCommand.ts @@ -25,6 +25,20 @@ export interface PutAggregationAuthorizationCommandOutput /** *

Authorizes the aggregator account and region to collect data * from the source account and region.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ConfigServiceClient, PutAggregationAuthorizationCommand } from "@aws-sdk/client-config-service"; // ES Modules import + * // const { ConfigServiceClient, PutAggregationAuthorizationCommand } = require("@aws-sdk/client-config-service"); // CommonJS import + * const client = new ConfigServiceClient(config); + * const command = new PutAggregationAuthorizationCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link PutAggregationAuthorizationCommandInput} for command's `input` shape. + * @see {@link PutAggregationAuthorizationCommandOutput} for command's `response` shape. + * @see {@link ConfigServiceClientResolvedConfig | config} for command's `input` shape. + * */ export class PutAggregationAuthorizationCommand extends $Command< PutAggregationAuthorizationCommandInput, diff --git a/clients/client-config-service/commands/PutConfigRuleCommand.ts b/clients/client-config-service/commands/PutConfigRuleCommand.ts index 6ee158512696..a4c3aea10136 100644 --- a/clients/client-config-service/commands/PutConfigRuleCommand.ts +++ b/clients/client-config-service/commands/PutConfigRuleCommand.ts @@ -57,6 +57,20 @@ export interface PutConfigRuleCommandOutput extends __MetadataBearer {} *

For more information about developing and using AWS Config * rules, see Evaluating AWS Resource Configurations with AWS Config * in the AWS Config Developer Guide.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ConfigServiceClient, PutConfigRuleCommand } from "@aws-sdk/client-config-service"; // ES Modules import + * // const { ConfigServiceClient, PutConfigRuleCommand } = require("@aws-sdk/client-config-service"); // CommonJS import + * const client = new ConfigServiceClient(config); + * const command = new PutConfigRuleCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link PutConfigRuleCommandInput} for command's `input` shape. + * @see {@link PutConfigRuleCommandOutput} for command's `response` shape. + * @see {@link ConfigServiceClientResolvedConfig | config} for command's `input` shape. + * */ export class PutConfigRuleCommand extends $Command< PutConfigRuleCommandInput, diff --git a/clients/client-config-service/commands/PutConfigurationAggregatorCommand.ts b/clients/client-config-service/commands/PutConfigurationAggregatorCommand.ts index d3f3795f2038..9321572461b0 100644 --- a/clients/client-config-service/commands/PutConfigurationAggregatorCommand.ts +++ b/clients/client-config-service/commands/PutConfigurationAggregatorCommand.ts @@ -37,6 +37,20 @@ export interface PutConfigurationAggregatorCommandOutput extends PutConfiguratio * If the caller is a registered delegated administrator, AWS 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 AWS Config developer guide.

* + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ConfigServiceClient, PutConfigurationAggregatorCommand } from "@aws-sdk/client-config-service"; // ES Modules import + * // const { ConfigServiceClient, PutConfigurationAggregatorCommand } = require("@aws-sdk/client-config-service"); // CommonJS import + * const client = new ConfigServiceClient(config); + * const command = new PutConfigurationAggregatorCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link PutConfigurationAggregatorCommandInput} for command's `input` shape. + * @see {@link PutConfigurationAggregatorCommandOutput} for command's `response` shape. + * @see {@link ConfigServiceClientResolvedConfig | config} for command's `input` shape. + * */ export class PutConfigurationAggregatorCommand extends $Command< PutConfigurationAggregatorCommandInput, diff --git a/clients/client-config-service/commands/PutConfigurationRecorderCommand.ts b/clients/client-config-service/commands/PutConfigurationRecorderCommand.ts index e9e22fe4e607..caebb5541feb 100644 --- a/clients/client-config-service/commands/PutConfigurationRecorderCommand.ts +++ b/clients/client-config-service/commands/PutConfigurationRecorderCommand.ts @@ -35,6 +35,20 @@ export interface PutConfigurationRecorderCommandOutput extends __MetadataBearer * specified, the default is to record all supported resource * types.

* + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ConfigServiceClient, PutConfigurationRecorderCommand } from "@aws-sdk/client-config-service"; // ES Modules import + * // const { ConfigServiceClient, PutConfigurationRecorderCommand } = require("@aws-sdk/client-config-service"); // CommonJS import + * const client = new ConfigServiceClient(config); + * const command = new PutConfigurationRecorderCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link PutConfigurationRecorderCommandInput} for command's `input` shape. + * @see {@link PutConfigurationRecorderCommandOutput} for command's `response` shape. + * @see {@link ConfigServiceClientResolvedConfig | config} for command's `input` shape. + * */ export class PutConfigurationRecorderCommand extends $Command< PutConfigurationRecorderCommandInput, diff --git a/clients/client-config-service/commands/PutConformancePackCommand.ts b/clients/client-config-service/commands/PutConformancePackCommand.ts index 73f99aed3996..870f29b9fef8 100644 --- a/clients/client-config-service/commands/PutConformancePackCommand.ts +++ b/clients/client-config-service/commands/PutConformancePackCommand.ts @@ -28,6 +28,20 @@ export interface PutConformancePackCommandOutput extends PutConformancePackRespo *

You must specify either the TemplateS3Uri or the TemplateBody parameter, but not both. * If you provide both AWS Config uses the TemplateS3Uri parameter and ignores the TemplateBody parameter.

* + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ConfigServiceClient, PutConformancePackCommand } from "@aws-sdk/client-config-service"; // ES Modules import + * // const { ConfigServiceClient, PutConformancePackCommand } = require("@aws-sdk/client-config-service"); // CommonJS import + * const client = new ConfigServiceClient(config); + * const command = new PutConformancePackCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link PutConformancePackCommandInput} for command's `input` shape. + * @see {@link PutConformancePackCommandOutput} for command's `response` shape. + * @see {@link ConfigServiceClientResolvedConfig | config} for command's `input` shape. + * */ export class PutConformancePackCommand extends $Command< PutConformancePackCommandInput, diff --git a/clients/client-config-service/commands/PutDeliveryChannelCommand.ts b/clients/client-config-service/commands/PutDeliveryChannelCommand.ts index 3c30e81b1a42..3aa3193befb0 100644 --- a/clients/client-config-service/commands/PutDeliveryChannelCommand.ts +++ b/clients/client-config-service/commands/PutDeliveryChannelCommand.ts @@ -38,6 +38,20 @@ export interface PutDeliveryChannelCommandOutput extends __MetadataBearer {} * * * + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ConfigServiceClient, PutDeliveryChannelCommand } from "@aws-sdk/client-config-service"; // ES Modules import + * // const { ConfigServiceClient, PutDeliveryChannelCommand } = require("@aws-sdk/client-config-service"); // CommonJS import + * const client = new ConfigServiceClient(config); + * const command = new PutDeliveryChannelCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link PutDeliveryChannelCommandInput} for command's `input` shape. + * @see {@link PutDeliveryChannelCommandOutput} for command's `response` shape. + * @see {@link ConfigServiceClientResolvedConfig | config} for command's `input` shape. + * */ export class PutDeliveryChannelCommand extends $Command< PutDeliveryChannelCommandInput, diff --git a/clients/client-config-service/commands/PutEvaluationsCommand.ts b/clients/client-config-service/commands/PutEvaluationsCommand.ts index a7cc7c1a91ec..8c953dd0ef17 100644 --- a/clients/client-config-service/commands/PutEvaluationsCommand.ts +++ b/clients/client-config-service/commands/PutEvaluationsCommand.ts @@ -24,6 +24,20 @@ export interface PutEvaluationsCommandOutput extends PutEvaluationsResponse, __M *

Used by an AWS Lambda function to deliver evaluation results to * AWS Config. This action is required in every AWS Lambda function * that is invoked by an AWS Config rule.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ConfigServiceClient, PutEvaluationsCommand } from "@aws-sdk/client-config-service"; // ES Modules import + * // const { ConfigServiceClient, PutEvaluationsCommand } = require("@aws-sdk/client-config-service"); // CommonJS import + * const client = new ConfigServiceClient(config); + * const command = new PutEvaluationsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link PutEvaluationsCommandInput} for command's `input` shape. + * @see {@link PutEvaluationsCommandOutput} for command's `response` shape. + * @see {@link ConfigServiceClientResolvedConfig | config} for command's `input` shape. + * */ export class PutEvaluationsCommand extends $Command< PutEvaluationsCommandInput, diff --git a/clients/client-config-service/commands/PutExternalEvaluationCommand.ts b/clients/client-config-service/commands/PutExternalEvaluationCommand.ts index 9bea689d3826..bf7cc1e2ef16 100644 --- a/clients/client-config-service/commands/PutExternalEvaluationCommand.ts +++ b/clients/client-config-service/commands/PutExternalEvaluationCommand.ts @@ -23,6 +23,20 @@ export interface PutExternalEvaluationCommandOutput extends PutExternalEvaluatio /** *

Add or updates the evaluations for process checks. * This API checks if the rule is a process check when the name of the AWS Config rule is provided.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ConfigServiceClient, PutExternalEvaluationCommand } from "@aws-sdk/client-config-service"; // ES Modules import + * // const { ConfigServiceClient, PutExternalEvaluationCommand } = require("@aws-sdk/client-config-service"); // CommonJS import + * const client = new ConfigServiceClient(config); + * const command = new PutExternalEvaluationCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link PutExternalEvaluationCommandInput} for command's `input` shape. + * @see {@link PutExternalEvaluationCommandOutput} for command's `response` shape. + * @see {@link ConfigServiceClientResolvedConfig | config} for command's `input` shape. + * */ export class PutExternalEvaluationCommand extends $Command< PutExternalEvaluationCommandInput, diff --git a/clients/client-config-service/commands/PutOrganizationConfigRuleCommand.ts b/clients/client-config-service/commands/PutOrganizationConfigRuleCommand.ts index 9fd7def7a5e0..03289475f862 100644 --- a/clients/client-config-service/commands/PutOrganizationConfigRuleCommand.ts +++ b/clients/client-config-service/commands/PutOrganizationConfigRuleCommand.ts @@ -43,6 +43,20 @@ export interface PutOrganizationConfigRuleCommandOutput extends PutOrganizationC *

Prerequisite: Ensure you call EnableAllFeatures API to enable all features in an organization.

*

Specify either OrganizationCustomRuleMetadata or OrganizationManagedRuleMetadata.

* + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ConfigServiceClient, PutOrganizationConfigRuleCommand } from "@aws-sdk/client-config-service"; // ES Modules import + * // const { ConfigServiceClient, PutOrganizationConfigRuleCommand } = require("@aws-sdk/client-config-service"); // CommonJS import + * const client = new ConfigServiceClient(config); + * const command = new PutOrganizationConfigRuleCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link PutOrganizationConfigRuleCommandInput} for command's `input` shape. + * @see {@link PutOrganizationConfigRuleCommandOutput} for command's `response` shape. + * @see {@link ConfigServiceClientResolvedConfig | config} for command's `input` shape. + * */ export class PutOrganizationConfigRuleCommand extends $Command< PutOrganizationConfigRuleCommandInput, diff --git a/clients/client-config-service/commands/PutOrganizationConformancePackCommand.ts b/clients/client-config-service/commands/PutOrganizationConformancePackCommand.ts index 74b7a58a8a49..6ea3d4727a74 100644 --- a/clients/client-config-service/commands/PutOrganizationConformancePackCommand.ts +++ b/clients/client-config-service/commands/PutOrganizationConformancePackCommand.ts @@ -44,6 +44,20 @@ export interface PutOrganizationConformancePackCommandOutput * You cannot update a conformance pack while it is in this state.

*

You can create 50 conformance packs with 25 AWS Config rules in each pack and 3 delegated administrator per organization.

* + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ConfigServiceClient, PutOrganizationConformancePackCommand } from "@aws-sdk/client-config-service"; // ES Modules import + * // const { ConfigServiceClient, PutOrganizationConformancePackCommand } = require("@aws-sdk/client-config-service"); // CommonJS import + * const client = new ConfigServiceClient(config); + * const command = new PutOrganizationConformancePackCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link PutOrganizationConformancePackCommandInput} for command's `input` shape. + * @see {@link PutOrganizationConformancePackCommandOutput} for command's `response` shape. + * @see {@link ConfigServiceClientResolvedConfig | config} for command's `input` shape. + * */ export class PutOrganizationConformancePackCommand extends $Command< PutOrganizationConformancePackCommandInput, diff --git a/clients/client-config-service/commands/PutRemediationConfigurationsCommand.ts b/clients/client-config-service/commands/PutRemediationConfigurationsCommand.ts index b7b0a335c45c..b46b33be17e4 100644 --- a/clients/client-config-service/commands/PutRemediationConfigurationsCommand.ts +++ b/clients/client-config-service/commands/PutRemediationConfigurationsCommand.ts @@ -34,6 +34,20 @@ export interface PutRemediationConfigurationsCommandOutput *

This API does not support adding remediation configurations for service-linked AWS Config Rules such as Organization Config rules, * the rules deployed by conformance packs, and rules deployed by AWS Security Hub.

* + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ConfigServiceClient, PutRemediationConfigurationsCommand } from "@aws-sdk/client-config-service"; // ES Modules import + * // const { ConfigServiceClient, PutRemediationConfigurationsCommand } = require("@aws-sdk/client-config-service"); // CommonJS import + * const client = new ConfigServiceClient(config); + * const command = new PutRemediationConfigurationsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link PutRemediationConfigurationsCommandInput} for command's `input` shape. + * @see {@link PutRemediationConfigurationsCommandOutput} for command's `response` shape. + * @see {@link ConfigServiceClientResolvedConfig | config} for command's `input` shape. + * */ export class PutRemediationConfigurationsCommand extends $Command< PutRemediationConfigurationsCommandInput, diff --git a/clients/client-config-service/commands/PutRemediationExceptionsCommand.ts b/clients/client-config-service/commands/PutRemediationExceptionsCommand.ts index fe61af7f0945..3f84e2c95f62 100644 --- a/clients/client-config-service/commands/PutRemediationExceptionsCommand.ts +++ b/clients/client-config-service/commands/PutRemediationExceptionsCommand.ts @@ -27,6 +27,20 @@ export interface PutRemediationExceptionsCommandOutput extends PutRemediationExc *

AWS 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.

* + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ConfigServiceClient, PutRemediationExceptionsCommand } from "@aws-sdk/client-config-service"; // ES Modules import + * // const { ConfigServiceClient, PutRemediationExceptionsCommand } = require("@aws-sdk/client-config-service"); // CommonJS import + * const client = new ConfigServiceClient(config); + * const command = new PutRemediationExceptionsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link PutRemediationExceptionsCommandInput} for command's `input` shape. + * @see {@link PutRemediationExceptionsCommandOutput} for command's `response` shape. + * @see {@link ConfigServiceClientResolvedConfig | config} for command's `input` shape. + * */ export class PutRemediationExceptionsCommand extends $Command< PutRemediationExceptionsCommandInput, diff --git a/clients/client-config-service/commands/PutResourceConfigCommand.ts b/clients/client-config-service/commands/PutResourceConfigCommand.ts index be503db1d4b3..1fcc3a409dab 100644 --- a/clients/client-config-service/commands/PutResourceConfigCommand.ts +++ b/clients/client-config-service/commands/PutResourceConfigCommand.ts @@ -31,6 +31,20 @@ export interface PutResourceConfigCommandOutput extends __MetadataBearer {} *

*

Write-only schema properites are not recorded as part of the published configuration item.

* + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ConfigServiceClient, PutResourceConfigCommand } from "@aws-sdk/client-config-service"; // ES Modules import + * // const { ConfigServiceClient, PutResourceConfigCommand } = require("@aws-sdk/client-config-service"); // CommonJS import + * const client = new ConfigServiceClient(config); + * const command = new PutResourceConfigCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link PutResourceConfigCommandInput} for command's `input` shape. + * @see {@link PutResourceConfigCommandOutput} for command's `response` shape. + * @see {@link ConfigServiceClientResolvedConfig | config} for command's `input` shape. + * */ export class PutResourceConfigCommand extends $Command< PutResourceConfigCommandInput, diff --git a/clients/client-config-service/commands/PutRetentionConfigurationCommand.ts b/clients/client-config-service/commands/PutRetentionConfigurationCommand.ts index f562d3cfb5d7..ba93fbc52869 100644 --- a/clients/client-config-service/commands/PutRetentionConfigurationCommand.ts +++ b/clients/client-config-service/commands/PutRetentionConfigurationCommand.ts @@ -32,6 +32,20 @@ export interface PutRetentionConfigurationCommandOutput extends PutRetentionConf *

Currently, AWS Config supports only one retention * configuration per region in your account.

* + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ConfigServiceClient, PutRetentionConfigurationCommand } from "@aws-sdk/client-config-service"; // ES Modules import + * // const { ConfigServiceClient, PutRetentionConfigurationCommand } = require("@aws-sdk/client-config-service"); // CommonJS import + * const client = new ConfigServiceClient(config); + * const command = new PutRetentionConfigurationCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link PutRetentionConfigurationCommandInput} for command's `input` shape. + * @see {@link PutRetentionConfigurationCommandOutput} for command's `response` shape. + * @see {@link ConfigServiceClientResolvedConfig | config} for command's `input` shape. + * */ export class PutRetentionConfigurationCommand extends $Command< PutRetentionConfigurationCommandInput, diff --git a/clients/client-config-service/commands/PutStoredQueryCommand.ts b/clients/client-config-service/commands/PutStoredQueryCommand.ts index 32dfd764149c..69393729b7fd 100644 --- a/clients/client-config-service/commands/PutStoredQueryCommand.ts +++ b/clients/client-config-service/commands/PutStoredQueryCommand.ts @@ -23,6 +23,20 @@ export interface PutStoredQueryCommandOutput extends PutStoredQueryResponse, __M /** *

Saves a new query or updates an existing saved query. The QueryName must be unique for a single AWS account and a single AWS Region. * You can create upto 300 queries in a single AWS account and a single AWS Region.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ConfigServiceClient, PutStoredQueryCommand } from "@aws-sdk/client-config-service"; // ES Modules import + * // const { ConfigServiceClient, PutStoredQueryCommand } = require("@aws-sdk/client-config-service"); // CommonJS import + * const client = new ConfigServiceClient(config); + * const command = new PutStoredQueryCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link PutStoredQueryCommandInput} for command's `input` shape. + * @see {@link PutStoredQueryCommandOutput} for command's `response` shape. + * @see {@link ConfigServiceClientResolvedConfig | config} for command's `input` shape. + * */ export class PutStoredQueryCommand extends $Command< PutStoredQueryCommandInput, diff --git a/clients/client-config-service/commands/SelectAggregateResourceConfigCommand.ts b/clients/client-config-service/commands/SelectAggregateResourceConfigCommand.ts index 94244bc14e68..32f7900c3835 100644 --- a/clients/client-config-service/commands/SelectAggregateResourceConfigCommand.ts +++ b/clients/client-config-service/commands/SelectAggregateResourceConfigCommand.ts @@ -29,6 +29,20 @@ export interface SelectAggregateResourceConfigCommandOutput * * Query Components * section in the AWS Config Developer Guide.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ConfigServiceClient, SelectAggregateResourceConfigCommand } from "@aws-sdk/client-config-service"; // ES Modules import + * // const { ConfigServiceClient, SelectAggregateResourceConfigCommand } = require("@aws-sdk/client-config-service"); // CommonJS import + * const client = new ConfigServiceClient(config); + * const command = new SelectAggregateResourceConfigCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link SelectAggregateResourceConfigCommandInput} for command's `input` shape. + * @see {@link SelectAggregateResourceConfigCommandOutput} for command's `response` shape. + * @see {@link ConfigServiceClientResolvedConfig | config} for command's `input` shape. + * */ export class SelectAggregateResourceConfigCommand extends $Command< SelectAggregateResourceConfigCommandInput, diff --git a/clients/client-config-service/commands/SelectResourceConfigCommand.ts b/clients/client-config-service/commands/SelectResourceConfigCommand.ts index 1253c7d1cf9a..c4cf174ee73a 100644 --- a/clients/client-config-service/commands/SelectResourceConfigCommand.ts +++ b/clients/client-config-service/commands/SelectResourceConfigCommand.ts @@ -26,6 +26,20 @@ export interface SelectResourceConfigCommandOutput extends SelectResourceConfigR * * Query Components * section in the AWS Config Developer Guide.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ConfigServiceClient, SelectResourceConfigCommand } from "@aws-sdk/client-config-service"; // ES Modules import + * // const { ConfigServiceClient, SelectResourceConfigCommand } = require("@aws-sdk/client-config-service"); // CommonJS import + * const client = new ConfigServiceClient(config); + * const command = new SelectResourceConfigCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link SelectResourceConfigCommandInput} for command's `input` shape. + * @see {@link SelectResourceConfigCommandOutput} for command's `response` shape. + * @see {@link ConfigServiceClientResolvedConfig | config} for command's `input` shape. + * */ export class SelectResourceConfigCommand extends $Command< SelectResourceConfigCommandInput, diff --git a/clients/client-config-service/commands/StartConfigRulesEvaluationCommand.ts b/clients/client-config-service/commands/StartConfigRulesEvaluationCommand.ts index 9e0e1c85bdf0..ade5d11037af 100644 --- a/clients/client-config-service/commands/StartConfigRulesEvaluationCommand.ts +++ b/clients/client-config-service/commands/StartConfigRulesEvaluationCommand.ts @@ -69,6 +69,20 @@ export interface StartConfigRulesEvaluationCommandOutput extends StartConfigRule * every 24 hours.

* * + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ConfigServiceClient, StartConfigRulesEvaluationCommand } from "@aws-sdk/client-config-service"; // ES Modules import + * // const { ConfigServiceClient, StartConfigRulesEvaluationCommand } = require("@aws-sdk/client-config-service"); // CommonJS import + * const client = new ConfigServiceClient(config); + * const command = new StartConfigRulesEvaluationCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link StartConfigRulesEvaluationCommandInput} for command's `input` shape. + * @see {@link StartConfigRulesEvaluationCommandOutput} for command's `response` shape. + * @see {@link ConfigServiceClientResolvedConfig | config} for command's `input` shape. + * */ export class StartConfigRulesEvaluationCommand extends $Command< StartConfigRulesEvaluationCommandInput, diff --git a/clients/client-config-service/commands/StartConfigurationRecorderCommand.ts b/clients/client-config-service/commands/StartConfigurationRecorderCommand.ts index 1a2168745521..e7ae56f74ce6 100644 --- a/clients/client-config-service/commands/StartConfigurationRecorderCommand.ts +++ b/clients/client-config-service/commands/StartConfigurationRecorderCommand.ts @@ -25,6 +25,20 @@ export interface StartConfigurationRecorderCommandOutput extends __MetadataBeare * selected to record in your AWS account.

*

You must have created at least one delivery channel to * successfully start the configuration recorder.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ConfigServiceClient, StartConfigurationRecorderCommand } from "@aws-sdk/client-config-service"; // ES Modules import + * // const { ConfigServiceClient, StartConfigurationRecorderCommand } = require("@aws-sdk/client-config-service"); // CommonJS import + * const client = new ConfigServiceClient(config); + * const command = new StartConfigurationRecorderCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link StartConfigurationRecorderCommandInput} for command's `input` shape. + * @see {@link StartConfigurationRecorderCommandOutput} for command's `response` shape. + * @see {@link ConfigServiceClientResolvedConfig | config} for command's `input` shape. + * */ export class StartConfigurationRecorderCommand extends $Command< StartConfigurationRecorderCommandInput, diff --git a/clients/client-config-service/commands/StartRemediationExecutionCommand.ts b/clients/client-config-service/commands/StartRemediationExecutionCommand.ts index 0064857d8317..7b2aa99502fd 100644 --- a/clients/client-config-service/commands/StartRemediationExecutionCommand.ts +++ b/clients/client-config-service/commands/StartRemediationExecutionCommand.ts @@ -23,6 +23,20 @@ export interface StartRemediationExecutionCommandOutput extends StartRemediation /** *

Runs an on-demand remediation for the specified AWS 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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ConfigServiceClient, StartRemediationExecutionCommand } from "@aws-sdk/client-config-service"; // ES Modules import + * // const { ConfigServiceClient, StartRemediationExecutionCommand } = require("@aws-sdk/client-config-service"); // CommonJS import + * const client = new ConfigServiceClient(config); + * const command = new StartRemediationExecutionCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link StartRemediationExecutionCommandInput} for command's `input` shape. + * @see {@link StartRemediationExecutionCommandOutput} for command's `response` shape. + * @see {@link ConfigServiceClientResolvedConfig | config} for command's `input` shape. + * */ export class StartRemediationExecutionCommand extends $Command< StartRemediationExecutionCommandInput, diff --git a/clients/client-config-service/commands/StopConfigurationRecorderCommand.ts b/clients/client-config-service/commands/StopConfigurationRecorderCommand.ts index 9c83a4675ca0..f95aee498d83 100644 --- a/clients/client-config-service/commands/StopConfigurationRecorderCommand.ts +++ b/clients/client-config-service/commands/StopConfigurationRecorderCommand.ts @@ -22,6 +22,20 @@ export interface StopConfigurationRecorderCommandOutput extends __MetadataBearer /** *

Stops recording configurations of the AWS resources you have selected to record in your AWS account.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ConfigServiceClient, StopConfigurationRecorderCommand } from "@aws-sdk/client-config-service"; // ES Modules import + * // const { ConfigServiceClient, StopConfigurationRecorderCommand } = require("@aws-sdk/client-config-service"); // CommonJS import + * const client = new ConfigServiceClient(config); + * const command = new StopConfigurationRecorderCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link StopConfigurationRecorderCommandInput} for command's `input` shape. + * @see {@link StopConfigurationRecorderCommandOutput} for command's `response` shape. + * @see {@link ConfigServiceClientResolvedConfig | config} for command's `input` shape. + * */ export class StopConfigurationRecorderCommand extends $Command< StopConfigurationRecorderCommandInput, diff --git a/clients/client-config-service/commands/TagResourceCommand.ts b/clients/client-config-service/commands/TagResourceCommand.ts index c37ac4460ee1..366ba7dbd3f6 100644 --- a/clients/client-config-service/commands/TagResourceCommand.ts +++ b/clients/client-config-service/commands/TagResourceCommand.ts @@ -23,6 +23,20 @@ export interface TagResourceCommandOutput extends __MetadataBearer {} /** *

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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ConfigServiceClient, TagResourceCommand } from "@aws-sdk/client-config-service"; // ES Modules import + * // const { ConfigServiceClient, TagResourceCommand } = require("@aws-sdk/client-config-service"); // CommonJS import + * const client = new ConfigServiceClient(config); + * const command = new TagResourceCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link TagResourceCommandInput} for command's `input` shape. + * @see {@link TagResourceCommandOutput} for command's `response` shape. + * @see {@link ConfigServiceClientResolvedConfig | config} for command's `input` shape. + * */ export class TagResourceCommand extends $Command< TagResourceCommandInput, diff --git a/clients/client-config-service/commands/UntagResourceCommand.ts b/clients/client-config-service/commands/UntagResourceCommand.ts index 493cb8083d93..620f7ce24f89 100644 --- a/clients/client-config-service/commands/UntagResourceCommand.ts +++ b/clients/client-config-service/commands/UntagResourceCommand.ts @@ -22,6 +22,20 @@ export interface UntagResourceCommandOutput extends __MetadataBearer {} /** *

Deletes specified tags from a resource.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ConfigServiceClient, UntagResourceCommand } from "@aws-sdk/client-config-service"; // ES Modules import + * // const { ConfigServiceClient, UntagResourceCommand } = require("@aws-sdk/client-config-service"); // CommonJS import + * const client = new ConfigServiceClient(config); + * const command = new UntagResourceCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link UntagResourceCommandInput} for command's `input` shape. + * @see {@link UntagResourceCommandOutput} for command's `response` shape. + * @see {@link ConfigServiceClientResolvedConfig | config} for command's `input` shape. + * */ export class UntagResourceCommand extends $Command< UntagResourceCommandInput, diff --git a/clients/client-config-service/models/models_0.ts b/clients/client-config-service/models/models_0.ts index b289e3f773e4..8703035e69b9 100644 --- a/clients/client-config-service/models/models_0.ts +++ b/clients/client-config-service/models/models_0.ts @@ -24,6 +24,9 @@ export interface AccountAggregationSource { } export namespace AccountAggregationSource { + /** + * @internal + */ export const filterSensitiveLog = (obj: AccountAggregationSource): any => ({ ...obj, }); @@ -48,6 +51,9 @@ export interface ComplianceContributorCount { } export namespace ComplianceContributorCount { + /** + * @internal + */ export const filterSensitiveLog = (obj: ComplianceContributorCount): any => ({ ...obj, }); @@ -95,6 +101,9 @@ export interface Compliance { } export namespace Compliance { + /** + * @internal + */ export const filterSensitiveLog = (obj: Compliance): any => ({ ...obj, }); @@ -132,6 +141,9 @@ export interface AggregateComplianceByConfigRule { } export namespace AggregateComplianceByConfigRule { + /** + * @internal + */ export const filterSensitiveLog = (obj: AggregateComplianceByConfigRule): any => ({ ...obj, }); @@ -174,6 +186,9 @@ export interface AggregateConformancePackCompliance { } export namespace AggregateConformancePackCompliance { + /** + * @internal + */ export const filterSensitiveLog = (obj: AggregateConformancePackCompliance): any => ({ ...obj, }); @@ -208,6 +223,9 @@ export interface AggregateComplianceByConformancePack { } export namespace AggregateComplianceByConformancePack { + /** + * @internal + */ export const filterSensitiveLog = (obj: AggregateComplianceByConformancePack): any => ({ ...obj, }); @@ -240,6 +258,9 @@ export interface ComplianceSummary { } export namespace ComplianceSummary { + /** + * @internal + */ export const filterSensitiveLog = (obj: ComplianceSummary): any => ({ ...obj, }); @@ -264,6 +285,9 @@ export interface AggregateComplianceCount { } export namespace AggregateComplianceCount { + /** + * @internal + */ export const filterSensitiveLog = (obj: AggregateComplianceCount): any => ({ ...obj, }); @@ -285,6 +309,9 @@ export interface AggregateConformancePackComplianceCount { } export namespace AggregateConformancePackComplianceCount { + /** + * @internal + */ export const filterSensitiveLog = (obj: AggregateConformancePackComplianceCount): any => ({ ...obj, }); @@ -316,6 +343,9 @@ export interface AggregateConformancePackComplianceFilters { } export namespace AggregateConformancePackComplianceFilters { + /** + * @internal + */ export const filterSensitiveLog = (obj: AggregateConformancePackComplianceFilters): any => ({ ...obj, }); @@ -337,6 +367,9 @@ export interface AggregateConformancePackComplianceSummary { } export namespace AggregateConformancePackComplianceSummary { + /** + * @internal + */ export const filterSensitiveLog = (obj: AggregateConformancePackComplianceSummary): any => ({ ...obj, }); @@ -358,6 +391,9 @@ export interface AggregateConformancePackComplianceSummaryFilters { } export namespace AggregateConformancePackComplianceSummaryFilters { + /** + * @internal + */ export const filterSensitiveLog = (obj: AggregateConformancePackComplianceSummaryFilters): any => ({ ...obj, }); @@ -437,6 +473,9 @@ export interface AggregatedSourceStatus { } export namespace AggregatedSourceStatus { + /** + * @internal + */ export const filterSensitiveLog = (obj: AggregatedSourceStatus): any => ({ ...obj, }); @@ -466,6 +505,9 @@ export interface EvaluationResultQualifier { } export namespace EvaluationResultQualifier { + /** + * @internal + */ export const filterSensitiveLog = (obj: EvaluationResultQualifier): any => ({ ...obj, }); @@ -492,6 +534,9 @@ export interface EvaluationResultIdentifier { } export namespace EvaluationResultIdentifier { + /** + * @internal + */ export const filterSensitiveLog = (obj: EvaluationResultIdentifier): any => ({ ...obj, }); @@ -549,6 +594,9 @@ export interface AggregateEvaluationResult { } export namespace AggregateEvaluationResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: AggregateEvaluationResult): any => ({ ...obj, }); @@ -685,6 +733,9 @@ export interface AggregateResourceIdentifier { } export namespace AggregateResourceIdentifier { + /** + * @internal + */ export const filterSensitiveLog = (obj: AggregateResourceIdentifier): any => ({ ...obj, }); @@ -720,6 +771,9 @@ export interface AggregationAuthorization { } export namespace AggregationAuthorization { + /** + * @internal + */ export const filterSensitiveLog = (obj: AggregationAuthorization): any => ({ ...obj, }); @@ -833,6 +887,9 @@ export interface BaseConfigurationItem { } export namespace BaseConfigurationItem { + /** + * @internal + */ export const filterSensitiveLog = (obj: BaseConfigurationItem): any => ({ ...obj, }); @@ -851,6 +908,9 @@ export interface BatchGetAggregateResourceConfigRequest { } export namespace BatchGetAggregateResourceConfigRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: BatchGetAggregateResourceConfigRequest): any => ({ ...obj, }); @@ -869,6 +929,9 @@ export interface BatchGetAggregateResourceConfigResponse { } export namespace BatchGetAggregateResourceConfigResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: BatchGetAggregateResourceConfigResponse): any => ({ ...obj, }); @@ -887,6 +950,9 @@ export interface NoSuchConfigurationAggregatorException extends __SmithyExceptio } export namespace NoSuchConfigurationAggregatorException { + /** + * @internal + */ export const filterSensitiveLog = (obj: NoSuchConfigurationAggregatorException): any => ({ ...obj, }); @@ -907,6 +973,9 @@ export interface ValidationException extends __SmithyException, $MetadataBearer } export namespace ValidationException { + /** + * @internal + */ export const filterSensitiveLog = (obj: ValidationException): any => ({ ...obj, }); @@ -929,6 +998,9 @@ export interface ResourceKey { } export namespace ResourceKey { + /** + * @internal + */ export const filterSensitiveLog = (obj: ResourceKey): any => ({ ...obj, }); @@ -944,6 +1016,9 @@ export interface BatchGetResourceConfigRequest { } export namespace BatchGetResourceConfigRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: BatchGetResourceConfigRequest): any => ({ ...obj, }); @@ -969,6 +1044,9 @@ export interface BatchGetResourceConfigResponse { } export namespace BatchGetResourceConfigResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: BatchGetResourceConfigResponse): any => ({ ...obj, }); @@ -989,6 +1067,9 @@ export interface NoAvailableConfigurationRecorderException extends __SmithyExcep } export namespace NoAvailableConfigurationRecorderException { + /** + * @internal + */ export const filterSensitiveLog = (obj: NoAvailableConfigurationRecorderException): any => ({ ...obj, }); @@ -1018,6 +1099,9 @@ export interface ComplianceByConfigRule { } export namespace ComplianceByConfigRule { + /** + * @internal + */ export const filterSensitiveLog = (obj: ComplianceByConfigRule): any => ({ ...obj, }); @@ -1049,6 +1133,9 @@ export interface ComplianceByResource { } export namespace ComplianceByResource { + /** + * @internal + */ export const filterSensitiveLog = (obj: ComplianceByResource): any => ({ ...obj, }); @@ -1073,6 +1160,9 @@ export interface ComplianceSummaryByResourceType { } export namespace ComplianceSummaryByResourceType { + /** + * @internal + */ export const filterSensitiveLog = (obj: ComplianceSummaryByResourceType): any => ({ ...obj, }); @@ -1123,6 +1213,9 @@ export interface ConfigExportDeliveryInfo { } export namespace ConfigExportDeliveryInfo { + /** + * @internal + */ export const filterSensitiveLog = (obj: ConfigExportDeliveryInfo): any => ({ ...obj, }); @@ -1185,6 +1278,9 @@ export interface Scope { } export namespace Scope { + /** + * @internal + */ export const filterSensitiveLog = (obj: Scope): any => ({ ...obj, }); @@ -1291,6 +1387,9 @@ export interface SourceDetail { } export namespace SourceDetail { + /** + * @internal + */ export const filterSensitiveLog = (obj: SourceDetail): any => ({ ...obj, }); @@ -1326,6 +1425,9 @@ export interface Source { } export namespace Source { + /** + * @internal + */ export const filterSensitiveLog = (obj: Source): any => ({ ...obj, }); @@ -1463,6 +1565,9 @@ export interface ConfigRule { } export namespace ConfigRule { + /** + * @internal + */ export const filterSensitiveLog = (obj: ConfigRule): any => ({ ...obj, }); @@ -1502,6 +1607,9 @@ export interface ConfigRuleComplianceFilters { } export namespace ConfigRuleComplianceFilters { + /** + * @internal + */ export const filterSensitiveLog = (obj: ConfigRuleComplianceFilters): any => ({ ...obj, }); @@ -1524,6 +1632,9 @@ export interface ConfigRuleComplianceSummaryFilters { } export namespace ConfigRuleComplianceSummaryFilters { + /** + * @internal + */ export const filterSensitiveLog = (obj: ConfigRuleComplianceSummaryFilters): any => ({ ...obj, }); @@ -1626,6 +1737,9 @@ export interface ConfigRuleEvaluationStatus { } export namespace ConfigRuleEvaluationStatus { + /** + * @internal + */ export const filterSensitiveLog = (obj: ConfigRuleEvaluationStatus): any => ({ ...obj, }); @@ -1705,6 +1819,9 @@ export interface ConfigSnapshotDeliveryProperties { } export namespace ConfigSnapshotDeliveryProperties { + /** + * @internal + */ export const filterSensitiveLog = (obj: ConfigSnapshotDeliveryProperties): any => ({ ...obj, }); @@ -1741,6 +1858,9 @@ export interface ConfigStreamDeliveryInfo { } export namespace ConfigStreamDeliveryInfo { + /** + * @internal + */ export const filterSensitiveLog = (obj: ConfigStreamDeliveryInfo): any => ({ ...obj, }); @@ -1770,6 +1890,9 @@ export interface OrganizationAggregationSource { } export namespace OrganizationAggregationSource { + /** + * @internal + */ export const filterSensitiveLog = (obj: OrganizationAggregationSource): any => ({ ...obj, }); @@ -1821,6 +1944,9 @@ export interface ConfigurationAggregator { } export namespace ConfigurationAggregator { + /** + * @internal + */ export const filterSensitiveLog = (obj: ConfigurationAggregator): any => ({ ...obj, }); @@ -1855,6 +1981,9 @@ export interface Relationship { } export namespace Relationship { + /** + * @internal + */ export const filterSensitiveLog = (obj: Relationship): any => ({ ...obj, }); @@ -1995,6 +2124,9 @@ export interface ConfigurationItem { } export namespace ConfigurationItem { + /** + * @internal + */ export const filterSensitiveLog = (obj: ConfigurationItem): any => ({ ...obj, }); @@ -2081,6 +2213,9 @@ export interface RecordingGroup { } export namespace RecordingGroup { + /** + * @internal + */ export const filterSensitiveLog = (obj: RecordingGroup): any => ({ ...obj, }); @@ -2112,6 +2247,9 @@ export interface ConfigurationRecorder { } export namespace ConfigurationRecorder { + /** + * @internal + */ export const filterSensitiveLog = (obj: ConfigurationRecorder): any => ({ ...obj, }); @@ -2171,6 +2309,9 @@ export interface ConfigurationRecorderStatus { } export namespace ConfigurationRecorderStatus { + /** + * @internal + */ export const filterSensitiveLog = (obj: ConfigurationRecorderStatus): any => ({ ...obj, }); @@ -2193,6 +2334,9 @@ export interface ConformancePackComplianceFilters { } export namespace ConformancePackComplianceFilters { + /** + * @internal + */ export const filterSensitiveLog = (obj: ConformancePackComplianceFilters): any => ({ ...obj, }); @@ -2214,6 +2358,9 @@ export interface ConformancePackComplianceSummary { } export namespace ConformancePackComplianceSummary { + /** + * @internal + */ export const filterSensitiveLog = (obj: ConformancePackComplianceSummary): any => ({ ...obj, }); @@ -2236,6 +2383,9 @@ export interface ConformancePackInputParameter { } export namespace ConformancePackInputParameter { + /** + * @internal + */ export const filterSensitiveLog = (obj: ConformancePackInputParameter): any => ({ ...obj, }); @@ -2293,6 +2443,9 @@ export interface ConformancePackDetail { } export namespace ConformancePackDetail { + /** + * @internal + */ export const filterSensitiveLog = (obj: ConformancePackDetail): any => ({ ...obj, }); @@ -2328,6 +2481,9 @@ export interface ConformancePackEvaluationFilters { } export namespace ConformancePackEvaluationFilters { + /** + * @internal + */ export const filterSensitiveLog = (obj: ConformancePackEvaluationFilters): any => ({ ...obj, }); @@ -2364,6 +2520,9 @@ export interface ConformancePackEvaluationResult { } export namespace ConformancePackEvaluationResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: ConformancePackEvaluationResult): any => ({ ...obj, }); @@ -2392,6 +2551,9 @@ export interface ConformancePackRuleCompliance { } export namespace ConformancePackRuleCompliance { + /** + * @internal + */ export const filterSensitiveLog = (obj: ConformancePackRuleCompliance): any => ({ ...obj, }); @@ -2469,6 +2631,9 @@ export interface ConformancePackStatusDetail { } export namespace ConformancePackStatusDetail { + /** + * @internal + */ export const filterSensitiveLog = (obj: ConformancePackStatusDetail): any => ({ ...obj, }); @@ -2487,6 +2652,9 @@ export interface ConformancePackTemplateValidationException extends __SmithyExce } export namespace ConformancePackTemplateValidationException { + /** + * @internal + */ export const filterSensitiveLog = (obj: ConformancePackTemplateValidationException): any => ({ ...obj, }); @@ -2506,6 +2674,9 @@ export interface DeleteAggregationAuthorizationRequest { } export namespace DeleteAggregationAuthorizationRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteAggregationAuthorizationRequest): any => ({ ...obj, }); @@ -2525,6 +2696,9 @@ export interface InvalidParameterValueException extends __SmithyException, $Meta } export namespace InvalidParameterValueException { + /** + * @internal + */ export const filterSensitiveLog = (obj: InvalidParameterValueException): any => ({ ...obj, }); @@ -2542,6 +2716,9 @@ export interface DeleteConfigRuleRequest { } export namespace DeleteConfigRuleRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteConfigRuleRequest): any => ({ ...obj, }); @@ -2561,6 +2738,9 @@ export interface NoSuchConfigRuleException extends __SmithyException, $MetadataB } export namespace NoSuchConfigRuleException { + /** + * @internal + */ export const filterSensitiveLog = (obj: NoSuchConfigRuleException): any => ({ ...obj, }); @@ -2602,6 +2782,9 @@ export interface ResourceInUseException extends __SmithyException, $MetadataBear } export namespace ResourceInUseException { + /** + * @internal + */ export const filterSensitiveLog = (obj: ResourceInUseException): any => ({ ...obj, }); @@ -2615,6 +2798,9 @@ export interface DeleteConfigurationAggregatorRequest { } export namespace DeleteConfigurationAggregatorRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteConfigurationAggregatorRequest): any => ({ ...obj, }); @@ -2634,6 +2820,9 @@ export interface DeleteConfigurationRecorderRequest { } export namespace DeleteConfigurationRecorderRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteConfigurationRecorderRequest): any => ({ ...obj, }); @@ -2653,6 +2842,9 @@ export interface NoSuchConfigurationRecorderException extends __SmithyException, } export namespace NoSuchConfigurationRecorderException { + /** + * @internal + */ export const filterSensitiveLog = (obj: NoSuchConfigurationRecorderException): any => ({ ...obj, }); @@ -2666,6 +2858,9 @@ export interface DeleteConformancePackRequest { } export namespace DeleteConformancePackRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteConformancePackRequest): any => ({ ...obj, }); @@ -2684,6 +2879,9 @@ export interface NoSuchConformancePackException extends __SmithyException, $Meta } export namespace NoSuchConformancePackException { + /** + * @internal + */ export const filterSensitiveLog = (obj: NoSuchConformancePackException): any => ({ ...obj, }); @@ -2702,6 +2900,9 @@ export interface DeleteDeliveryChannelRequest { } export namespace DeleteDeliveryChannelRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteDeliveryChannelRequest): any => ({ ...obj, }); @@ -2721,6 +2922,9 @@ export interface LastDeliveryChannelDeleteFailedException extends __SmithyExcept } export namespace LastDeliveryChannelDeleteFailedException { + /** + * @internal + */ export const filterSensitiveLog = (obj: LastDeliveryChannelDeleteFailedException): any => ({ ...obj, }); @@ -2740,6 +2944,9 @@ export interface NoSuchDeliveryChannelException extends __SmithyException, $Meta } export namespace NoSuchDeliveryChannelException { + /** + * @internal + */ export const filterSensitiveLog = (obj: NoSuchDeliveryChannelException): any => ({ ...obj, }); @@ -2757,6 +2964,9 @@ export interface DeleteEvaluationResultsRequest { } export namespace DeleteEvaluationResultsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteEvaluationResultsRequest): any => ({ ...obj, }); @@ -2769,6 +2979,9 @@ export namespace DeleteEvaluationResultsRequest { export interface DeleteEvaluationResultsResponse {} export namespace DeleteEvaluationResultsResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteEvaluationResultsResponse): any => ({ ...obj, }); @@ -2782,6 +2995,9 @@ export interface DeleteOrganizationConfigRuleRequest { } export namespace DeleteOrganizationConfigRuleRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteOrganizationConfigRuleRequest): any => ({ ...obj, }); @@ -2800,6 +3016,9 @@ export interface NoSuchOrganizationConfigRuleException extends __SmithyException } export namespace NoSuchOrganizationConfigRuleException { + /** + * @internal + */ export const filterSensitiveLog = (obj: NoSuchOrganizationConfigRuleException): any => ({ ...obj, }); @@ -2836,6 +3055,9 @@ export interface OrganizationAccessDeniedException extends __SmithyException, $M } export namespace OrganizationAccessDeniedException { + /** + * @internal + */ export const filterSensitiveLog = (obj: OrganizationAccessDeniedException): any => ({ ...obj, }); @@ -2849,6 +3071,9 @@ export interface DeleteOrganizationConformancePackRequest { } export namespace DeleteOrganizationConformancePackRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteOrganizationConformancePackRequest): any => ({ ...obj, }); @@ -2868,6 +3093,9 @@ export interface NoSuchOrganizationConformancePackException extends __SmithyExce } export namespace NoSuchOrganizationConformancePackException { + /** + * @internal + */ export const filterSensitiveLog = (obj: NoSuchOrganizationConformancePackException): any => ({ ...obj, }); @@ -2887,6 +3115,9 @@ export interface DeletePendingAggregationRequestRequest { } export namespace DeletePendingAggregationRequestRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeletePendingAggregationRequestRequest): any => ({ ...obj, }); @@ -2905,6 +3136,9 @@ export interface DeleteRemediationConfigurationRequest { } export namespace DeleteRemediationConfigurationRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteRemediationConfigurationRequest): any => ({ ...obj, }); @@ -2913,6 +3147,9 @@ export namespace DeleteRemediationConfigurationRequest { export interface DeleteRemediationConfigurationResponse {} export namespace DeleteRemediationConfigurationResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteRemediationConfigurationResponse): any => ({ ...obj, }); @@ -2953,6 +3190,9 @@ export interface InsufficientPermissionsException extends __SmithyException, $Me } export namespace InsufficientPermissionsException { + /** + * @internal + */ export const filterSensitiveLog = (obj: InsufficientPermissionsException): any => ({ ...obj, }); @@ -2971,6 +3211,9 @@ export interface NoSuchRemediationConfigurationException extends __SmithyExcepti } export namespace NoSuchRemediationConfigurationException { + /** + * @internal + */ export const filterSensitiveLog = (obj: NoSuchRemediationConfigurationException): any => ({ ...obj, }); @@ -2989,6 +3232,9 @@ export interface RemediationInProgressException extends __SmithyException, $Meta } export namespace RemediationInProgressException { + /** + * @internal + */ export const filterSensitiveLog = (obj: RemediationInProgressException): any => ({ ...obj, }); @@ -3010,6 +3256,9 @@ export interface RemediationExceptionResourceKey { } export namespace RemediationExceptionResourceKey { + /** + * @internal + */ export const filterSensitiveLog = (obj: RemediationExceptionResourceKey): any => ({ ...obj, }); @@ -3028,6 +3277,9 @@ export interface DeleteRemediationExceptionsRequest { } export namespace DeleteRemediationExceptionsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteRemediationExceptionsRequest): any => ({ ...obj, }); @@ -3049,6 +3301,9 @@ export interface FailedDeleteRemediationExceptionsBatch { } export namespace FailedDeleteRemediationExceptionsBatch { + /** + * @internal + */ export const filterSensitiveLog = (obj: FailedDeleteRemediationExceptionsBatch): any => ({ ...obj, }); @@ -3062,6 +3317,9 @@ export interface DeleteRemediationExceptionsResponse { } export namespace DeleteRemediationExceptionsResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteRemediationExceptionsResponse): any => ({ ...obj, }); @@ -3080,6 +3338,9 @@ export interface NoSuchRemediationExceptionException extends __SmithyException, } export namespace NoSuchRemediationExceptionException { + /** + * @internal + */ export const filterSensitiveLog = (obj: NoSuchRemediationExceptionException): any => ({ ...obj, }); @@ -3098,6 +3359,9 @@ export interface DeleteResourceConfigRequest { } export namespace DeleteResourceConfigRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteResourceConfigRequest): any => ({ ...obj, }); @@ -3116,6 +3380,9 @@ export interface NoRunningConfigurationRecorderException extends __SmithyExcepti } export namespace NoRunningConfigurationRecorderException { + /** + * @internal + */ export const filterSensitiveLog = (obj: NoRunningConfigurationRecorderException): any => ({ ...obj, }); @@ -3129,6 +3396,9 @@ export interface DeleteRetentionConfigurationRequest { } export namespace DeleteRetentionConfigurationRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteRetentionConfigurationRequest): any => ({ ...obj, }); @@ -3147,6 +3417,9 @@ export interface NoSuchRetentionConfigurationException extends __SmithyException } export namespace NoSuchRetentionConfigurationException { + /** + * @internal + */ export const filterSensitiveLog = (obj: NoSuchRetentionConfigurationException): any => ({ ...obj, }); @@ -3160,6 +3433,9 @@ export interface DeleteStoredQueryRequest { } export namespace DeleteStoredQueryRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteStoredQueryRequest): any => ({ ...obj, }); @@ -3168,6 +3444,9 @@ export namespace DeleteStoredQueryRequest { export interface DeleteStoredQueryResponse {} export namespace DeleteStoredQueryResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteStoredQueryResponse): any => ({ ...obj, }); @@ -3186,6 +3465,9 @@ export interface ResourceNotFoundException extends __SmithyException, $MetadataB } export namespace ResourceNotFoundException { + /** + * @internal + */ export const filterSensitiveLog = (obj: ResourceNotFoundException): any => ({ ...obj, }); @@ -3204,6 +3486,9 @@ export interface DeliverConfigSnapshotRequest { } export namespace DeliverConfigSnapshotRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeliverConfigSnapshotRequest): any => ({ ...obj, }); @@ -3221,6 +3506,9 @@ export interface DeliverConfigSnapshotResponse { } export namespace DeliverConfigSnapshotResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeliverConfigSnapshotResponse): any => ({ ...obj, }); @@ -3281,6 +3569,9 @@ export interface DeliveryChannel { } export namespace DeliveryChannel { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeliveryChannel): any => ({ ...obj, }); @@ -3318,6 +3609,9 @@ export interface DeliveryChannelStatus { } export namespace DeliveryChannelStatus { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeliveryChannelStatus): any => ({ ...obj, }); @@ -3351,6 +3645,9 @@ export interface DescribeAggregateComplianceByConfigRulesRequest { } export namespace DescribeAggregateComplianceByConfigRulesRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeAggregateComplianceByConfigRulesRequest): any => ({ ...obj, }); @@ -3371,6 +3668,9 @@ export interface DescribeAggregateComplianceByConfigRulesResponse { } export namespace DescribeAggregateComplianceByConfigRulesResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeAggregateComplianceByConfigRulesResponse): any => ({ ...obj, }); @@ -3389,6 +3689,9 @@ export interface InvalidLimitException extends __SmithyException, $MetadataBeare } export namespace InvalidLimitException { + /** + * @internal + */ export const filterSensitiveLog = (obj: InvalidLimitException): any => ({ ...obj, }); @@ -3409,6 +3712,9 @@ export interface InvalidNextTokenException extends __SmithyException, $MetadataB } export namespace InvalidNextTokenException { + /** + * @internal + */ export const filterSensitiveLog = (obj: InvalidNextTokenException): any => ({ ...obj, }); @@ -3437,6 +3743,9 @@ export interface DescribeAggregateComplianceByConformancePacksRequest { } export namespace DescribeAggregateComplianceByConformancePacksRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeAggregateComplianceByConformancePacksRequest): any => ({ ...obj, }); @@ -3455,6 +3764,9 @@ export interface DescribeAggregateComplianceByConformancePacksResponse { } export namespace DescribeAggregateComplianceByConformancePacksResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeAggregateComplianceByConformancePacksResponse): any => ({ ...obj, }); @@ -3476,6 +3788,9 @@ export interface DescribeAggregationAuthorizationsRequest { } export namespace DescribeAggregationAuthorizationsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeAggregationAuthorizationsRequest): any => ({ ...obj, }); @@ -3496,6 +3811,9 @@ export interface DescribeAggregationAuthorizationsResponse { } export namespace DescribeAggregationAuthorizationsResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeAggregationAuthorizationsResponse): any => ({ ...obj, }); @@ -3526,6 +3844,9 @@ export interface DescribeComplianceByConfigRuleRequest { } export namespace DescribeComplianceByConfigRuleRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeComplianceByConfigRuleRequest): any => ({ ...obj, }); @@ -3549,6 +3870,9 @@ export interface DescribeComplianceByConfigRuleResponse { } export namespace DescribeComplianceByConfigRuleResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeComplianceByConfigRuleResponse): any => ({ ...obj, }); @@ -3596,6 +3920,9 @@ export interface DescribeComplianceByResourceRequest { } export namespace DescribeComplianceByResourceRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeComplianceByResourceRequest): any => ({ ...obj, }); @@ -3619,6 +3946,9 @@ export interface DescribeComplianceByResourceResponse { } export namespace DescribeComplianceByResourceResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeComplianceByResourceResponse): any => ({ ...obj, }); @@ -3657,6 +3987,9 @@ export interface DescribeConfigRuleEvaluationStatusRequest { } export namespace DescribeConfigRuleEvaluationStatusRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeConfigRuleEvaluationStatusRequest): any => ({ ...obj, }); @@ -3680,6 +4013,9 @@ export interface DescribeConfigRuleEvaluationStatusResponse { } export namespace DescribeConfigRuleEvaluationStatusResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeConfigRuleEvaluationStatusResponse): any => ({ ...obj, }); @@ -3705,6 +4041,9 @@ export interface DescribeConfigRulesRequest { } export namespace DescribeConfigRulesRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeConfigRulesRequest): any => ({ ...obj, }); @@ -3727,6 +4066,9 @@ export interface DescribeConfigRulesResponse { } export namespace DescribeConfigRulesResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeConfigRulesResponse): any => ({ ...obj, }); @@ -3753,6 +4095,9 @@ export interface DescribeConfigurationAggregatorsRequest { } export namespace DescribeConfigurationAggregatorsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeConfigurationAggregatorsRequest): any => ({ ...obj, }); @@ -3772,6 +4117,9 @@ export interface DescribeConfigurationAggregatorsResponse { } export namespace DescribeConfigurationAggregatorsResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeConfigurationAggregatorsResponse): any => ({ ...obj, }); @@ -3817,6 +4165,9 @@ export interface DescribeConfigurationAggregatorSourcesStatusRequest { } export namespace DescribeConfigurationAggregatorSourcesStatusRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeConfigurationAggregatorSourcesStatusRequest): any => ({ ...obj, }); @@ -3837,6 +4188,9 @@ export interface DescribeConfigurationAggregatorSourcesStatusResponse { } export namespace DescribeConfigurationAggregatorSourcesStatusResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeConfigurationAggregatorSourcesStatusResponse): any => ({ ...obj, }); @@ -3853,6 +4207,9 @@ export interface DescribeConfigurationRecordersRequest { } export namespace DescribeConfigurationRecordersRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeConfigurationRecordersRequest): any => ({ ...obj, }); @@ -3870,6 +4227,9 @@ export interface DescribeConfigurationRecordersResponse { } export namespace DescribeConfigurationRecordersResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeConfigurationRecordersResponse): any => ({ ...obj, }); @@ -3889,6 +4249,9 @@ export interface DescribeConfigurationRecorderStatusRequest { } export namespace DescribeConfigurationRecorderStatusRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeConfigurationRecorderStatusRequest): any => ({ ...obj, }); @@ -3907,6 +4270,9 @@ export interface DescribeConfigurationRecorderStatusResponse { } export namespace DescribeConfigurationRecorderStatusResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeConfigurationRecorderStatusResponse): any => ({ ...obj, }); @@ -3935,6 +4301,9 @@ export interface DescribeConformancePackComplianceRequest { } export namespace DescribeConformancePackComplianceRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeConformancePackComplianceRequest): any => ({ ...obj, }); @@ -3958,6 +4327,9 @@ export interface DescribeConformancePackComplianceResponse { } export namespace DescribeConformancePackComplianceResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeConformancePackComplianceResponse): any => ({ ...obj, }); @@ -3976,6 +4348,9 @@ export interface NoSuchConfigRuleInConformancePackException extends __SmithyExce } export namespace NoSuchConfigRuleInConformancePackException { + /** + * @internal + */ export const filterSensitiveLog = (obj: NoSuchConfigRuleInConformancePackException): any => ({ ...obj, }); @@ -3999,6 +4374,9 @@ export interface DescribeConformancePacksRequest { } export namespace DescribeConformancePacksRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeConformancePacksRequest): any => ({ ...obj, }); @@ -4017,6 +4395,9 @@ export interface DescribeConformancePacksResponse { } export namespace DescribeConformancePacksResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeConformancePacksResponse): any => ({ ...obj, }); @@ -4040,6 +4421,9 @@ export interface DescribeConformancePackStatusRequest { } export namespace DescribeConformancePackStatusRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeConformancePackStatusRequest): any => ({ ...obj, }); @@ -4058,6 +4442,9 @@ export interface DescribeConformancePackStatusResponse { } export namespace DescribeConformancePackStatusResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeConformancePackStatusResponse): any => ({ ...obj, }); @@ -4075,6 +4462,9 @@ export interface DescribeDeliveryChannelsRequest { } export namespace DescribeDeliveryChannelsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeDeliveryChannelsRequest): any => ({ ...obj, }); @@ -4093,6 +4483,9 @@ export interface DescribeDeliveryChannelsResponse { } export namespace DescribeDeliveryChannelsResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeDeliveryChannelsResponse): any => ({ ...obj, }); @@ -4110,6 +4503,9 @@ export interface DescribeDeliveryChannelStatusRequest { } export namespace DescribeDeliveryChannelStatusRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeDeliveryChannelStatusRequest): any => ({ ...obj, }); @@ -4127,6 +4523,9 @@ export interface DescribeDeliveryChannelStatusResponse { } export namespace DescribeDeliveryChannelStatusResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeDeliveryChannelStatusResponse): any => ({ ...obj, }); @@ -4150,6 +4549,9 @@ export interface DescribeOrganizationConfigRulesRequest { } export namespace DescribeOrganizationConfigRulesRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeOrganizationConfigRulesRequest): any => ({ ...obj, }); @@ -4237,6 +4639,9 @@ export interface OrganizationCustomRuleMetadata { } export namespace OrganizationCustomRuleMetadata { + /** + * @internal + */ export const filterSensitiveLog = (obj: OrganizationCustomRuleMetadata): any => ({ ...obj, }); @@ -4297,6 +4702,9 @@ export interface OrganizationManagedRuleMetadata { } export namespace OrganizationManagedRuleMetadata { + /** + * @internal + */ export const filterSensitiveLog = (obj: OrganizationManagedRuleMetadata): any => ({ ...obj, }); @@ -4338,6 +4746,9 @@ export interface OrganizationConfigRule { } export namespace OrganizationConfigRule { + /** + * @internal + */ export const filterSensitiveLog = (obj: OrganizationConfigRule): any => ({ ...obj, }); @@ -4356,6 +4767,9 @@ export interface DescribeOrganizationConfigRulesResponse { } export namespace DescribeOrganizationConfigRulesResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeOrganizationConfigRulesResponse): any => ({ ...obj, }); @@ -4379,6 +4793,9 @@ export interface DescribeOrganizationConfigRuleStatusesRequest { } export namespace DescribeOrganizationConfigRuleStatusesRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeOrganizationConfigRuleStatusesRequest): any => ({ ...obj, }); @@ -4469,6 +4886,9 @@ export interface OrganizationConfigRuleStatus { } export namespace OrganizationConfigRuleStatus { + /** + * @internal + */ export const filterSensitiveLog = (obj: OrganizationConfigRuleStatus): any => ({ ...obj, }); @@ -4487,6 +4907,9 @@ export interface DescribeOrganizationConfigRuleStatusesResponse { } export namespace DescribeOrganizationConfigRuleStatusesResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeOrganizationConfigRuleStatusesResponse): any => ({ ...obj, }); @@ -4512,6 +4935,9 @@ export interface DescribeOrganizationConformancePacksRequest { } export namespace DescribeOrganizationConformancePacksRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeOrganizationConformancePacksRequest): any => ({ ...obj, }); @@ -4564,6 +4990,9 @@ export interface OrganizationConformancePack { } export namespace OrganizationConformancePack { + /** + * @internal + */ export const filterSensitiveLog = (obj: OrganizationConformancePack): any => ({ ...obj, }); @@ -4583,6 +5012,9 @@ export interface DescribeOrganizationConformancePacksResponse { } export namespace DescribeOrganizationConformancePacksResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeOrganizationConformancePacksResponse): any => ({ ...obj, }); @@ -4608,6 +5040,9 @@ export interface DescribeOrganizationConformancePackStatusesRequest { } export namespace DescribeOrganizationConformancePackStatusesRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeOrganizationConformancePackStatusesRequest): any => ({ ...obj, }); @@ -4704,6 +5139,9 @@ export interface OrganizationConformancePackStatus { } export namespace OrganizationConformancePackStatus { + /** + * @internal + */ export const filterSensitiveLog = (obj: OrganizationConformancePackStatus): any => ({ ...obj, }); @@ -4722,6 +5160,9 @@ export interface DescribeOrganizationConformancePackStatusesResponse { } export namespace DescribeOrganizationConformancePackStatusesResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeOrganizationConformancePackStatusesResponse): any => ({ ...obj, }); @@ -4743,6 +5184,9 @@ export interface DescribePendingAggregationRequestsRequest { } export namespace DescribePendingAggregationRequestsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribePendingAggregationRequestsRequest): any => ({ ...obj, }); @@ -4767,6 +5211,9 @@ export interface PendingAggregationRequest { } export namespace PendingAggregationRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: PendingAggregationRequest): any => ({ ...obj, }); @@ -4786,6 +5233,9 @@ export interface DescribePendingAggregationRequestsResponse { } export namespace DescribePendingAggregationRequestsResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribePendingAggregationRequestsResponse): any => ({ ...obj, }); @@ -4799,6 +5249,9 @@ export interface DescribeRemediationConfigurationsRequest { } export namespace DescribeRemediationConfigurationsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeRemediationConfigurationsRequest): any => ({ ...obj, }); @@ -4822,6 +5275,9 @@ export interface SsmControls { } export namespace SsmControls { + /** + * @internal + */ export const filterSensitiveLog = (obj: SsmControls): any => ({ ...obj, }); @@ -4838,6 +5294,9 @@ export interface ExecutionControls { } export namespace ExecutionControls { + /** + * @internal + */ export const filterSensitiveLog = (obj: ExecutionControls): any => ({ ...obj, }); @@ -4858,6 +5317,9 @@ export interface ResourceValue { } export namespace ResourceValue { + /** + * @internal + */ export const filterSensitiveLog = (obj: ResourceValue): any => ({ ...obj, }); @@ -4874,6 +5336,9 @@ export interface StaticValue { } export namespace StaticValue { + /** + * @internal + */ export const filterSensitiveLog = (obj: StaticValue): any => ({ ...obj, }); @@ -4895,6 +5360,9 @@ export interface RemediationParameterValue { } export namespace RemediationParameterValue { + /** + * @internal + */ export const filterSensitiveLog = (obj: RemediationParameterValue): any => ({ ...obj, }); @@ -4979,6 +5447,9 @@ export interface RemediationConfiguration { } export namespace RemediationConfiguration { + /** + * @internal + */ export const filterSensitiveLog = (obj: RemediationConfiguration): any => ({ ...obj, }); @@ -4992,6 +5463,9 @@ export interface DescribeRemediationConfigurationsResponse { } export namespace DescribeRemediationConfigurationsResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeRemediationConfigurationsResponse): any => ({ ...obj, }); @@ -5020,6 +5494,9 @@ export interface DescribeRemediationExceptionsRequest { } export namespace DescribeRemediationExceptionsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeRemediationExceptionsRequest): any => ({ ...obj, }); @@ -5056,6 +5533,9 @@ export interface RemediationException { } export namespace RemediationException { + /** + * @internal + */ export const filterSensitiveLog = (obj: RemediationException): any => ({ ...obj, }); @@ -5074,6 +5554,9 @@ export interface DescribeRemediationExceptionsResponse { } export namespace DescribeRemediationExceptionsResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeRemediationExceptionsResponse): any => ({ ...obj, }); @@ -5102,6 +5585,9 @@ export interface DescribeRemediationExecutionStatusRequest { } export namespace DescribeRemediationExecutionStatusRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeRemediationExecutionStatusRequest): any => ({ ...obj, }); @@ -5151,6 +5637,9 @@ export interface RemediationExecutionStep { } export namespace RemediationExecutionStep { + /** + * @internal + */ export const filterSensitiveLog = (obj: RemediationExecutionStep): any => ({ ...obj, }); @@ -5188,6 +5677,9 @@ export interface RemediationExecutionStatus { } export namespace RemediationExecutionStatus { + /** + * @internal + */ export const filterSensitiveLog = (obj: RemediationExecutionStatus): any => ({ ...obj, }); @@ -5206,6 +5698,9 @@ export interface DescribeRemediationExecutionStatusResponse { } export namespace DescribeRemediationExecutionStatusResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeRemediationExecutionStatusResponse): any => ({ ...obj, }); @@ -5232,6 +5727,9 @@ export interface DescribeRetentionConfigurationsRequest { } export namespace DescribeRetentionConfigurationsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeRetentionConfigurationsRequest): any => ({ ...obj, }); @@ -5256,6 +5754,9 @@ export interface RetentionConfiguration { } export namespace RetentionConfiguration { + /** + * @internal + */ export const filterSensitiveLog = (obj: RetentionConfiguration): any => ({ ...obj, }); @@ -5276,6 +5777,9 @@ export interface DescribeRetentionConfigurationsResponse { } export namespace DescribeRetentionConfigurationsResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeRetentionConfigurationsResponse): any => ({ ...obj, }); @@ -5331,6 +5835,9 @@ export interface Evaluation { } export namespace Evaluation { + /** + * @internal + */ export const filterSensitiveLog = (obj: Evaluation): any => ({ ...obj, }); @@ -5385,6 +5892,9 @@ export interface EvaluationResult { } export namespace EvaluationResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: EvaluationResult): any => ({ ...obj, }); @@ -5421,6 +5931,9 @@ export interface ExternalEvaluation { } export namespace ExternalEvaluation { + /** + * @internal + */ export const filterSensitiveLog = (obj: ExternalEvaluation): any => ({ ...obj, }); @@ -5442,6 +5955,9 @@ export interface FailedRemediationBatch { } export namespace FailedRemediationBatch { + /** + * @internal + */ export const filterSensitiveLog = (obj: FailedRemediationBatch): any => ({ ...obj, }); @@ -5463,6 +5979,9 @@ export interface FailedRemediationExceptionBatch { } export namespace FailedRemediationExceptionBatch { + /** + * @internal + */ export const filterSensitiveLog = (obj: FailedRemediationExceptionBatch): any => ({ ...obj, }); @@ -5479,6 +5998,9 @@ export interface FieldInfo { } export namespace FieldInfo { + /** + * @internal + */ export const filterSensitiveLog = (obj: FieldInfo): any => ({ ...obj, }); @@ -5534,6 +6056,9 @@ export interface GetAggregateComplianceDetailsByConfigRuleRequest { } export namespace GetAggregateComplianceDetailsByConfigRuleRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetAggregateComplianceDetailsByConfigRuleRequest): any => ({ ...obj, }); @@ -5553,6 +6078,9 @@ export interface GetAggregateComplianceDetailsByConfigRuleResponse { } export namespace GetAggregateComplianceDetailsByConfigRuleResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetAggregateComplianceDetailsByConfigRuleResponse): any => ({ ...obj, }); @@ -5590,6 +6118,9 @@ export interface GetAggregateConfigRuleComplianceSummaryRequest { } export namespace GetAggregateConfigRuleComplianceSummaryRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetAggregateConfigRuleComplianceSummaryRequest): any => ({ ...obj, }); @@ -5614,6 +6145,9 @@ export interface GetAggregateConfigRuleComplianceSummaryResponse { } export namespace GetAggregateConfigRuleComplianceSummaryResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetAggregateConfigRuleComplianceSummaryResponse): any => ({ ...obj, }); @@ -5647,6 +6181,9 @@ export interface GetAggregateConformancePackComplianceSummaryRequest { } export namespace GetAggregateConformancePackComplianceSummaryRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetAggregateConformancePackComplianceSummaryRequest): any => ({ ...obj, }); @@ -5670,6 +6207,9 @@ export interface GetAggregateConformancePackComplianceSummaryResponse { } export namespace GetAggregateConformancePackComplianceSummaryResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetAggregateConformancePackComplianceSummaryResponse): any => ({ ...obj, }); @@ -5696,6 +6236,9 @@ export interface ResourceCountFilters { } export namespace ResourceCountFilters { + /** + * @internal + */ export const filterSensitiveLog = (obj: ResourceCountFilters): any => ({ ...obj, }); @@ -5735,6 +6278,9 @@ export interface GetAggregateDiscoveredResourceCountsRequest { } export namespace GetAggregateDiscoveredResourceCountsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetAggregateDiscoveredResourceCountsRequest): any => ({ ...obj, }); @@ -5756,6 +6302,9 @@ export interface GroupedResourceCount { } export namespace GroupedResourceCount { + /** + * @internal + */ export const filterSensitiveLog = (obj: GroupedResourceCount): any => ({ ...obj, }); @@ -5784,6 +6333,9 @@ export interface GetAggregateDiscoveredResourceCountsResponse { } export namespace GetAggregateDiscoveredResourceCountsResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetAggregateDiscoveredResourceCountsResponse): any => ({ ...obj, }); @@ -5802,6 +6354,9 @@ export interface GetAggregateResourceConfigRequest { } export namespace GetAggregateResourceConfigRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetAggregateResourceConfigRequest): any => ({ ...obj, }); @@ -5815,6 +6370,9 @@ export interface GetAggregateResourceConfigResponse { } export namespace GetAggregateResourceConfigResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetAggregateResourceConfigResponse): any => ({ ...obj, }); @@ -5833,6 +6391,9 @@ export interface OversizedConfigurationItemException extends __SmithyException, } export namespace OversizedConfigurationItemException { + /** + * @internal + */ export const filterSensitiveLog = (obj: OversizedConfigurationItemException): any => ({ ...obj, }); @@ -5852,6 +6413,9 @@ export interface ResourceNotDiscoveredException extends __SmithyException, $Meta } export namespace ResourceNotDiscoveredException { + /** + * @internal + */ export const filterSensitiveLog = (obj: ResourceNotDiscoveredException): any => ({ ...obj, }); @@ -5891,6 +6455,9 @@ export interface GetComplianceDetailsByConfigRuleRequest { } export namespace GetComplianceDetailsByConfigRuleRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetComplianceDetailsByConfigRuleRequest): any => ({ ...obj, }); @@ -5914,6 +6481,9 @@ export interface GetComplianceDetailsByConfigRuleResponse { } export namespace GetComplianceDetailsByConfigRuleResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetComplianceDetailsByConfigRuleResponse): any => ({ ...obj, }); @@ -5952,6 +6522,9 @@ export interface GetComplianceDetailsByResourceRequest { } export namespace GetComplianceDetailsByResourceRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetComplianceDetailsByResourceRequest): any => ({ ...obj, }); @@ -5975,6 +6548,9 @@ export interface GetComplianceDetailsByResourceResponse { } export namespace GetComplianceDetailsByResourceResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetComplianceDetailsByResourceResponse): any => ({ ...obj, }); @@ -5993,6 +6569,9 @@ export interface GetComplianceSummaryByConfigRuleResponse { } export namespace GetComplianceSummaryByConfigRuleResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetComplianceSummaryByConfigRuleResponse): any => ({ ...obj, }); @@ -6015,6 +6594,9 @@ export interface GetComplianceSummaryByResourceTypeRequest { } export namespace GetComplianceSummaryByResourceTypeRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetComplianceSummaryByResourceTypeRequest): any => ({ ...obj, }); @@ -6034,6 +6616,9 @@ export interface GetComplianceSummaryByResourceTypeResponse { } export namespace GetComplianceSummaryByResourceTypeResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetComplianceSummaryByResourceTypeResponse): any => ({ ...obj, }); @@ -6062,6 +6647,9 @@ export interface GetConformancePackComplianceDetailsRequest { } export namespace GetConformancePackComplianceDetailsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetConformancePackComplianceDetailsRequest): any => ({ ...obj, }); @@ -6085,6 +6673,9 @@ export interface GetConformancePackComplianceDetailsResponse { } export namespace GetConformancePackComplianceDetailsResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetConformancePackComplianceDetailsResponse): any => ({ ...obj, }); @@ -6108,6 +6699,9 @@ export interface GetConformancePackComplianceSummaryRequest { } export namespace GetConformancePackComplianceSummaryRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetConformancePackComplianceSummaryRequest): any => ({ ...obj, }); @@ -6126,6 +6720,9 @@ export interface GetConformancePackComplianceSummaryResponse { } export namespace GetConformancePackComplianceSummaryResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetConformancePackComplianceSummaryResponse): any => ({ ...obj, }); @@ -6168,6 +6765,9 @@ export interface GetDiscoveredResourceCountsRequest { } export namespace GetDiscoveredResourceCountsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetDiscoveredResourceCountsRequest): any => ({ ...obj, }); @@ -6191,6 +6791,9 @@ export interface ResourceCount { } export namespace ResourceCount { + /** + * @internal + */ export const filterSensitiveLog = (obj: ResourceCount): any => ({ ...obj, }); @@ -6243,6 +6846,9 @@ export interface GetDiscoveredResourceCountsResponse { } export namespace GetDiscoveredResourceCountsResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetDiscoveredResourceCountsResponse): any => ({ ...obj, }); @@ -6319,6 +6925,9 @@ export interface StatusDetailFilters { } export namespace StatusDetailFilters { + /** + * @internal + */ export const filterSensitiveLog = (obj: StatusDetailFilters): any => ({ ...obj, }); @@ -6347,6 +6956,9 @@ export interface GetOrganizationConfigRuleDetailedStatusRequest { } export namespace GetOrganizationConfigRuleDetailedStatusRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetOrganizationConfigRuleDetailedStatusRequest): any => ({ ...obj, }); @@ -6431,6 +7043,9 @@ export interface MemberAccountStatus { } export namespace MemberAccountStatus { + /** + * @internal + */ export const filterSensitiveLog = (obj: MemberAccountStatus): any => ({ ...obj, }); @@ -6449,6 +7064,9 @@ export interface GetOrganizationConfigRuleDetailedStatusResponse { } export namespace GetOrganizationConfigRuleDetailedStatusResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetOrganizationConfigRuleDetailedStatusResponse): any => ({ ...obj, }); @@ -6525,6 +7143,9 @@ export interface OrganizationResourceDetailedStatusFilters { } export namespace OrganizationResourceDetailedStatusFilters { + /** + * @internal + */ export const filterSensitiveLog = (obj: OrganizationResourceDetailedStatusFilters): any => ({ ...obj, }); @@ -6554,6 +7175,9 @@ export interface GetOrganizationConformancePackDetailedStatusRequest { } export namespace GetOrganizationConformancePackDetailedStatusRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetOrganizationConformancePackDetailedStatusRequest): any => ({ ...obj, }); @@ -6642,6 +7266,9 @@ export interface OrganizationConformancePackDetailedStatus { } export namespace OrganizationConformancePackDetailedStatus { + /** + * @internal + */ export const filterSensitiveLog = (obj: OrganizationConformancePackDetailedStatus): any => ({ ...obj, }); @@ -6660,6 +7287,9 @@ export interface GetOrganizationConformancePackDetailedStatusResponse { } export namespace GetOrganizationConformancePackDetailedStatusResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetOrganizationConformancePackDetailedStatusResponse): any => ({ ...obj, }); @@ -6718,6 +7348,9 @@ export interface GetResourceConfigHistoryRequest { } export namespace GetResourceConfigHistoryRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetResourceConfigHistoryRequest): any => ({ ...obj, }); @@ -6742,6 +7375,9 @@ export interface GetResourceConfigHistoryResponse { } export namespace GetResourceConfigHistoryResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetResourceConfigHistoryResponse): any => ({ ...obj, }); @@ -6761,6 +7397,9 @@ export interface InvalidTimeRangeException extends __SmithyException, $MetadataB } export namespace InvalidTimeRangeException { + /** + * @internal + */ export const filterSensitiveLog = (obj: InvalidTimeRangeException): any => ({ ...obj, }); @@ -6774,6 +7413,9 @@ export interface GetStoredQueryRequest { } export namespace GetStoredQueryRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetStoredQueryRequest): any => ({ ...obj, }); @@ -6817,6 +7459,9 @@ export interface StoredQuery { } export namespace StoredQuery { + /** + * @internal + */ export const filterSensitiveLog = (obj: StoredQuery): any => ({ ...obj, }); @@ -6830,6 +7475,9 @@ export interface GetStoredQueryResponse { } export namespace GetStoredQueryResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetStoredQueryResponse): any => ({ ...obj, }); @@ -6849,6 +7497,9 @@ export interface InsufficientDeliveryPolicyException extends __SmithyException, } export namespace InsufficientDeliveryPolicyException { + /** + * @internal + */ export const filterSensitiveLog = (obj: InsufficientDeliveryPolicyException): any => ({ ...obj, }); @@ -6868,6 +7519,9 @@ export interface InvalidConfigurationRecorderNameException extends __SmithyExcep } export namespace InvalidConfigurationRecorderNameException { + /** + * @internal + */ export const filterSensitiveLog = (obj: InvalidConfigurationRecorderNameException): any => ({ ...obj, }); @@ -6886,6 +7540,9 @@ export interface InvalidDeliveryChannelNameException extends __SmithyException, } export namespace InvalidDeliveryChannelNameException { + /** + * @internal + */ export const filterSensitiveLog = (obj: InvalidDeliveryChannelNameException): any => ({ ...obj, }); @@ -6904,6 +7561,9 @@ export interface InvalidExpressionException extends __SmithyException, $Metadata } export namespace InvalidExpressionException { + /** + * @internal + */ export const filterSensitiveLog = (obj: InvalidExpressionException): any => ({ ...obj, }); @@ -6922,6 +7582,9 @@ export interface InvalidRecordingGroupException extends __SmithyException, $Meta } export namespace InvalidRecordingGroupException { + /** + * @internal + */ export const filterSensitiveLog = (obj: InvalidRecordingGroupException): any => ({ ...obj, }); @@ -6940,6 +7603,9 @@ export interface InvalidResultTokenException extends __SmithyException, $Metadat } export namespace InvalidResultTokenException { + /** + * @internal + */ export const filterSensitiveLog = (obj: InvalidResultTokenException): any => ({ ...obj, }); @@ -6958,6 +7624,9 @@ export interface InvalidRoleException extends __SmithyException, $MetadataBearer } export namespace InvalidRoleException { + /** + * @internal + */ export const filterSensitiveLog = (obj: InvalidRoleException): any => ({ ...obj, }); @@ -6976,6 +7645,9 @@ export interface InvalidS3KeyPrefixException extends __SmithyException, $Metadat } export namespace InvalidS3KeyPrefixException { + /** + * @internal + */ export const filterSensitiveLog = (obj: InvalidS3KeyPrefixException): any => ({ ...obj, }); @@ -6994,6 +7666,9 @@ export interface InvalidS3KmsKeyArnException extends __SmithyException, $Metadat } export namespace InvalidS3KmsKeyArnException { + /** + * @internal + */ export const filterSensitiveLog = (obj: InvalidS3KmsKeyArnException): any => ({ ...obj, }); @@ -7012,6 +7687,9 @@ export interface InvalidSNSTopicARNException extends __SmithyException, $Metadat } export namespace InvalidSNSTopicARNException { + /** + * @internal + */ export const filterSensitiveLog = (obj: InvalidSNSTopicARNException): any => ({ ...obj, }); @@ -7035,6 +7713,9 @@ export interface LimitExceededException extends __SmithyException, $MetadataBear } export namespace LimitExceededException { + /** + * @internal + */ export const filterSensitiveLog = (obj: LimitExceededException): any => ({ ...obj, }); @@ -7066,6 +7747,9 @@ export interface ResourceFilters { } export namespace ResourceFilters { + /** + * @internal + */ export const filterSensitiveLog = (obj: ResourceFilters): any => ({ ...obj, }); @@ -7099,6 +7783,9 @@ export interface ListAggregateDiscoveredResourcesRequest { } export namespace ListAggregateDiscoveredResourcesRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListAggregateDiscoveredResourcesRequest): any => ({ ...obj, }); @@ -7117,6 +7804,9 @@ export interface ListAggregateDiscoveredResourcesResponse { } export namespace ListAggregateDiscoveredResourcesResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListAggregateDiscoveredResourcesResponse): any => ({ ...obj, }); @@ -7170,6 +7860,9 @@ export interface ListDiscoveredResourcesRequest { } export namespace ListDiscoveredResourcesRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListDiscoveredResourcesRequest): any => ({ ...obj, }); @@ -7204,6 +7897,9 @@ export interface ResourceIdentifier { } export namespace ResourceIdentifier { + /** + * @internal + */ export const filterSensitiveLog = (obj: ResourceIdentifier): any => ({ ...obj, }); @@ -7228,6 +7924,9 @@ export interface ListDiscoveredResourcesResponse { } export namespace ListDiscoveredResourcesResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListDiscoveredResourcesResponse): any => ({ ...obj, }); @@ -7246,6 +7945,9 @@ export interface ListStoredQueriesRequest { } export namespace ListStoredQueriesRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListStoredQueriesRequest): any => ({ ...obj, }); @@ -7277,6 +7979,9 @@ export interface StoredQueryMetadata { } export namespace StoredQueryMetadata { + /** + * @internal + */ export const filterSensitiveLog = (obj: StoredQueryMetadata): any => ({ ...obj, }); @@ -7297,6 +8002,9 @@ export interface ListStoredQueriesResponse { } export namespace ListStoredQueriesResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListStoredQueriesResponse): any => ({ ...obj, }); @@ -7320,6 +8028,9 @@ export interface ListTagsForResourceRequest { } export namespace ListTagsForResourceRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListTagsForResourceRequest): any => ({ ...obj, }); @@ -7343,6 +8054,9 @@ export interface Tag { } export namespace Tag { + /** + * @internal + */ export const filterSensitiveLog = (obj: Tag): any => ({ ...obj, }); @@ -7361,6 +8075,9 @@ export interface ListTagsForResourceResponse { } export namespace ListTagsForResourceResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListTagsForResourceResponse): any => ({ ...obj, }); @@ -7380,6 +8097,9 @@ export interface MaxActiveResourcesExceededException extends __SmithyException, } export namespace MaxActiveResourcesExceededException { + /** + * @internal + */ export const filterSensitiveLog = (obj: MaxActiveResourcesExceededException): any => ({ ...obj, }); @@ -7400,6 +8120,9 @@ export interface MaxNumberOfConfigRulesExceededException extends __SmithyExcepti } export namespace MaxNumberOfConfigRulesExceededException { + /** + * @internal + */ export const filterSensitiveLog = (obj: MaxNumberOfConfigRulesExceededException): any => ({ ...obj, }); @@ -7419,6 +8142,9 @@ export interface MaxNumberOfConfigurationRecordersExceededException extends __Sm } export namespace MaxNumberOfConfigurationRecordersExceededException { + /** + * @internal + */ export const filterSensitiveLog = (obj: MaxNumberOfConfigurationRecordersExceededException): any => ({ ...obj, }); @@ -7437,6 +8163,9 @@ export interface MaxNumberOfConformancePacksExceededException extends __SmithyEx } export namespace MaxNumberOfConformancePacksExceededException { + /** + * @internal + */ export const filterSensitiveLog = (obj: MaxNumberOfConformancePacksExceededException): any => ({ ...obj, }); @@ -7456,6 +8185,9 @@ export interface MaxNumberOfDeliveryChannelsExceededException extends __SmithyEx } export namespace MaxNumberOfDeliveryChannelsExceededException { + /** + * @internal + */ export const filterSensitiveLog = (obj: MaxNumberOfDeliveryChannelsExceededException): any => ({ ...obj, }); @@ -7474,6 +8206,9 @@ export interface MaxNumberOfOrganizationConfigRulesExceededException extends __S } export namespace MaxNumberOfOrganizationConfigRulesExceededException { + /** + * @internal + */ export const filterSensitiveLog = (obj: MaxNumberOfOrganizationConfigRulesExceededException): any => ({ ...obj, }); @@ -7492,6 +8227,9 @@ export interface MaxNumberOfOrganizationConformancePacksExceededException extend } export namespace MaxNumberOfOrganizationConformancePacksExceededException { + /** + * @internal + */ export const filterSensitiveLog = (obj: MaxNumberOfOrganizationConformancePacksExceededException): any => ({ ...obj, }); @@ -7510,6 +8248,9 @@ export interface MaxNumberOfRetentionConfigurationsExceededException extends __S } export namespace MaxNumberOfRetentionConfigurationsExceededException { + /** + * @internal + */ export const filterSensitiveLog = (obj: MaxNumberOfRetentionConfigurationsExceededException): any => ({ ...obj, }); @@ -7529,6 +8270,9 @@ export interface NoAvailableDeliveryChannelException extends __SmithyException, } export namespace NoAvailableDeliveryChannelException { + /** + * @internal + */ export const filterSensitiveLog = (obj: NoAvailableDeliveryChannelException): any => ({ ...obj, }); @@ -7547,6 +8291,9 @@ export interface NoAvailableOrganizationException extends __SmithyException, $Me } export namespace NoAvailableOrganizationException { + /** + * @internal + */ export const filterSensitiveLog = (obj: NoAvailableOrganizationException): any => ({ ...obj, }); @@ -7565,6 +8312,9 @@ export interface NoSuchBucketException extends __SmithyException, $MetadataBeare } export namespace NoSuchBucketException { + /** + * @internal + */ export const filterSensitiveLog = (obj: NoSuchBucketException): any => ({ ...obj, }); @@ -7583,6 +8333,9 @@ export interface OrganizationAllFeaturesNotEnabledException extends __SmithyExce } export namespace OrganizationAllFeaturesNotEnabledException { + /** + * @internal + */ export const filterSensitiveLog = (obj: OrganizationAllFeaturesNotEnabledException): any => ({ ...obj, }); @@ -7601,6 +8354,9 @@ export interface OrganizationConformancePackTemplateValidationException extends } export namespace OrganizationConformancePackTemplateValidationException { + /** + * @internal + */ export const filterSensitiveLog = (obj: OrganizationConformancePackTemplateValidationException): any => ({ ...obj, }); @@ -7624,6 +8380,9 @@ export interface PutAggregationAuthorizationRequest { } export namespace PutAggregationAuthorizationRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: PutAggregationAuthorizationRequest): any => ({ ...obj, }); @@ -7639,6 +8398,9 @@ export interface PutAggregationAuthorizationResponse { } export namespace PutAggregationAuthorizationResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: PutAggregationAuthorizationResponse): any => ({ ...obj, }); @@ -7657,6 +8419,9 @@ export interface PutConfigRuleRequest { } export namespace PutConfigRuleRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: PutConfigRuleRequest): any => ({ ...obj, }); @@ -7687,6 +8452,9 @@ export interface PutConfigurationAggregatorRequest { } export namespace PutConfigurationAggregatorRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: PutConfigurationAggregatorRequest): any => ({ ...obj, }); @@ -7700,6 +8468,9 @@ export interface PutConfigurationAggregatorResponse { } export namespace PutConfigurationAggregatorResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: PutConfigurationAggregatorResponse): any => ({ ...obj, }); @@ -7718,6 +8489,9 @@ export interface PutConfigurationRecorderRequest { } export namespace PutConfigurationRecorderRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: PutConfigurationRecorderRequest): any => ({ ...obj, }); @@ -7768,6 +8542,9 @@ export interface PutConformancePackRequest { } export namespace PutConformancePackRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: PutConformancePackRequest): any => ({ ...obj, }); @@ -7781,6 +8558,9 @@ export interface PutConformancePackResponse { } export namespace PutConformancePackResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: PutConformancePackResponse): any => ({ ...obj, }); @@ -7800,6 +8580,9 @@ export interface PutDeliveryChannelRequest { } export namespace PutDeliveryChannelRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: PutDeliveryChannelRequest): any => ({ ...obj, }); @@ -7842,6 +8625,9 @@ export interface PutEvaluationsRequest { } export namespace PutEvaluationsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: PutEvaluationsRequest): any => ({ ...obj, }); @@ -7859,6 +8645,9 @@ export interface PutEvaluationsResponse { } export namespace PutEvaluationsResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: PutEvaluationsResponse): any => ({ ...obj, }); @@ -7877,6 +8666,9 @@ export interface PutExternalEvaluationRequest { } export namespace PutExternalEvaluationRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: PutExternalEvaluationRequest): any => ({ ...obj, }); @@ -7885,6 +8677,9 @@ export namespace PutExternalEvaluationRequest { export interface PutExternalEvaluationResponse {} export namespace PutExternalEvaluationResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: PutExternalEvaluationResponse): any => ({ ...obj, }); @@ -7913,6 +8708,9 @@ export interface PutOrganizationConfigRuleRequest { } export namespace PutOrganizationConfigRuleRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: PutOrganizationConfigRuleRequest): any => ({ ...obj, }); @@ -7926,6 +8724,9 @@ export interface PutOrganizationConfigRuleResponse { } export namespace PutOrganizationConfigRuleResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: PutOrganizationConfigRuleResponse): any => ({ ...obj, }); @@ -7980,6 +8781,9 @@ export interface PutOrganizationConformancePackRequest { } export namespace PutOrganizationConformancePackRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: PutOrganizationConformancePackRequest): any => ({ ...obj, }); @@ -7993,6 +8797,9 @@ export interface PutOrganizationConformancePackResponse { } export namespace PutOrganizationConformancePackResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: PutOrganizationConformancePackResponse): any => ({ ...obj, }); @@ -8006,6 +8813,9 @@ export interface PutRemediationConfigurationsRequest { } export namespace PutRemediationConfigurationsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: PutRemediationConfigurationsRequest): any => ({ ...obj, }); @@ -8019,6 +8829,9 @@ export interface PutRemediationConfigurationsResponse { } export namespace PutRemediationConfigurationsResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: PutRemediationConfigurationsResponse): any => ({ ...obj, }); @@ -8047,6 +8860,9 @@ export interface PutRemediationExceptionsRequest { } export namespace PutRemediationExceptionsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: PutRemediationExceptionsRequest): any => ({ ...obj, }); @@ -8060,6 +8876,9 @@ export interface PutRemediationExceptionsResponse { } export namespace PutRemediationExceptionsResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: PutRemediationExceptionsResponse): any => ({ ...obj, }); diff --git a/clients/client-config-service/models/models_1.ts b/clients/client-config-service/models/models_1.ts index 67dee38201d4..dc1b7951f8d7 100644 --- a/clients/client-config-service/models/models_1.ts +++ b/clients/client-config-service/models/models_1.ts @@ -41,6 +41,9 @@ export interface PutResourceConfigRequest { } export namespace PutResourceConfigRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: PutResourceConfigRequest): any => ({ ...obj, }); @@ -59,6 +62,9 @@ export interface PutRetentionConfigurationRequest { } export namespace PutRetentionConfigurationRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: PutRetentionConfigurationRequest): any => ({ ...obj, }); @@ -72,6 +78,9 @@ export interface PutRetentionConfigurationResponse { } export namespace PutRetentionConfigurationResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: PutRetentionConfigurationResponse): any => ({ ...obj, }); @@ -95,6 +104,9 @@ export interface PutStoredQueryRequest { } export namespace PutStoredQueryRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: PutStoredQueryRequest): any => ({ ...obj, }); @@ -109,6 +121,9 @@ export interface PutStoredQueryResponse { } export namespace PutStoredQueryResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: PutStoredQueryResponse): any => ({ ...obj, }); @@ -124,6 +139,9 @@ export interface ResourceConcurrentModificationException extends __SmithyExcepti } export namespace ResourceConcurrentModificationException { + /** + * @internal + */ export const filterSensitiveLog = (obj: ResourceConcurrentModificationException): any => ({ ...obj, }); @@ -142,6 +160,9 @@ export interface TooManyTagsException extends __SmithyException, $MetadataBearer } export namespace TooManyTagsException { + /** + * @internal + */ export const filterSensitiveLog = (obj: TooManyTagsException): any => ({ ...obj, }); @@ -158,6 +179,9 @@ export interface QueryInfo { } export namespace QueryInfo { + /** + * @internal + */ export const filterSensitiveLog = (obj: QueryInfo): any => ({ ...obj, }); @@ -191,6 +215,9 @@ export interface SelectAggregateResourceConfigRequest { } export namespace SelectAggregateResourceConfigRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: SelectAggregateResourceConfigRequest): any => ({ ...obj, }); @@ -214,6 +241,9 @@ export interface SelectAggregateResourceConfigResponse { } export namespace SelectAggregateResourceConfigResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: SelectAggregateResourceConfigResponse): any => ({ ...obj, }); @@ -237,6 +267,9 @@ export interface SelectResourceConfigRequest { } export namespace SelectResourceConfigRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: SelectResourceConfigRequest): any => ({ ...obj, }); @@ -260,6 +293,9 @@ export interface SelectResourceConfigResponse { } export namespace SelectResourceConfigResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: SelectResourceConfigResponse): any => ({ ...obj, }); @@ -277,6 +313,9 @@ export interface StartConfigRulesEvaluationRequest { } export namespace StartConfigRulesEvaluationRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: StartConfigRulesEvaluationRequest): any => ({ ...obj, }); @@ -289,6 +328,9 @@ export namespace StartConfigRulesEvaluationRequest { export interface StartConfigRulesEvaluationResponse {} export namespace StartConfigRulesEvaluationResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: StartConfigRulesEvaluationResponse): any => ({ ...obj, }); @@ -307,6 +349,9 @@ export interface StartConfigurationRecorderRequest { } export namespace StartConfigurationRecorderRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: StartConfigurationRecorderRequest): any => ({ ...obj, }); @@ -325,6 +370,9 @@ export interface StartRemediationExecutionRequest { } export namespace StartRemediationExecutionRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: StartRemediationExecutionRequest): any => ({ ...obj, }); @@ -343,6 +391,9 @@ export interface StartRemediationExecutionResponse { } export namespace StartRemediationExecutionResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: StartRemediationExecutionResponse): any => ({ ...obj, }); @@ -359,6 +410,9 @@ export interface StopConfigurationRecorderRequest { } export namespace StopConfigurationRecorderRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: StopConfigurationRecorderRequest): any => ({ ...obj, }); @@ -377,6 +431,9 @@ export interface TagResourceRequest { } export namespace TagResourceRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: TagResourceRequest): any => ({ ...obj, }); @@ -395,6 +452,9 @@ export interface UntagResourceRequest { } export namespace UntagResourceRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: UntagResourceRequest): any => ({ ...obj, }); diff --git a/clients/client-connect-contact-lens/commands/ListRealtimeContactAnalysisSegmentsCommand.ts b/clients/client-connect-contact-lens/commands/ListRealtimeContactAnalysisSegmentsCommand.ts index dfa153e57a22..7bb5614b8ce6 100644 --- a/clients/client-connect-contact-lens/commands/ListRealtimeContactAnalysisSegmentsCommand.ts +++ b/clients/client-connect-contact-lens/commands/ListRealtimeContactAnalysisSegmentsCommand.ts @@ -31,6 +31,20 @@ export interface ListRealtimeContactAnalysisSegmentsCommandOutput /** *

Provides a list of analysis segments for a real-time analysis session.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ConnectContactLensClient, ListRealtimeContactAnalysisSegmentsCommand } from "@aws-sdk/client-connect-contact-lens"; // ES Modules import + * // const { ConnectContactLensClient, ListRealtimeContactAnalysisSegmentsCommand } = require("@aws-sdk/client-connect-contact-lens"); // CommonJS import + * const client = new ConnectContactLensClient(config); + * const command = new ListRealtimeContactAnalysisSegmentsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListRealtimeContactAnalysisSegmentsCommandInput} for command's `input` shape. + * @see {@link ListRealtimeContactAnalysisSegmentsCommandOutput} for command's `response` shape. + * @see {@link ConnectContactLensClientResolvedConfig | config} for command's `input` shape. + * */ export class ListRealtimeContactAnalysisSegmentsCommand extends $Command< ListRealtimeContactAnalysisSegmentsCommandInput, diff --git a/clients/client-connect-contact-lens/models/models_0.ts b/clients/client-connect-contact-lens/models/models_0.ts index 7fa604bad2e0..95945ae658a0 100644 --- a/clients/client-connect-contact-lens/models/models_0.ts +++ b/clients/client-connect-contact-lens/models/models_0.ts @@ -11,6 +11,9 @@ export interface AccessDeniedException extends __SmithyException, $MetadataBeare } export namespace AccessDeniedException { + /** + * @internal + */ export const filterSensitiveLog = (obj: AccessDeniedException): any => ({ ...obj, }); @@ -26,6 +29,9 @@ export interface InternalServiceException extends __SmithyException, $MetadataBe } export namespace InternalServiceException { + /** + * @internal + */ export const filterSensitiveLog = (obj: InternalServiceException): any => ({ ...obj, }); @@ -41,6 +47,9 @@ export interface InvalidRequestException extends __SmithyException, $MetadataBea } export namespace InvalidRequestException { + /** + * @internal + */ export const filterSensitiveLog = (obj: InvalidRequestException): any => ({ ...obj, }); @@ -70,6 +79,9 @@ export interface ListRealtimeContactAnalysisSegmentsRequest { } export namespace ListRealtimeContactAnalysisSegmentsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListRealtimeContactAnalysisSegmentsRequest): any => ({ ...obj, }); @@ -91,6 +103,9 @@ export interface PointOfInterest { } export namespace PointOfInterest { + /** + * @internal + */ export const filterSensitiveLog = (obj: PointOfInterest): any => ({ ...obj, }); @@ -107,6 +122,9 @@ export interface CategoryDetails { } export namespace CategoryDetails { + /** + * @internal + */ export const filterSensitiveLog = (obj: CategoryDetails): any => ({ ...obj, }); @@ -129,6 +147,9 @@ export interface Categories { } export namespace Categories { + /** + * @internal + */ export const filterSensitiveLog = (obj: Categories): any => ({ ...obj, }); @@ -150,6 +171,9 @@ export interface CharacterOffsets { } export namespace CharacterOffsets { + /** + * @internal + */ export const filterSensitiveLog = (obj: CharacterOffsets): any => ({ ...obj, }); @@ -167,6 +191,9 @@ export interface IssueDetected { } export namespace IssueDetected { + /** + * @internal + */ export const filterSensitiveLog = (obj: IssueDetected): any => ({ ...obj, }); @@ -224,6 +251,9 @@ export interface Transcript { } export namespace Transcript { + /** + * @internal + */ export const filterSensitiveLog = (obj: Transcript): any => ({ ...obj, }); @@ -245,6 +275,9 @@ export interface RealtimeContactAnalysisSegment { } export namespace RealtimeContactAnalysisSegment { + /** + * @internal + */ export const filterSensitiveLog = (obj: RealtimeContactAnalysisSegment): any => ({ ...obj, }); @@ -274,6 +307,9 @@ export interface ListRealtimeContactAnalysisSegmentsResponse { } export namespace ListRealtimeContactAnalysisSegmentsResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListRealtimeContactAnalysisSegmentsResponse): any => ({ ...obj, }); @@ -289,6 +325,9 @@ export interface ResourceNotFoundException extends __SmithyException, $MetadataB } export namespace ResourceNotFoundException { + /** + * @internal + */ export const filterSensitiveLog = (obj: ResourceNotFoundException): any => ({ ...obj, }); @@ -304,6 +343,9 @@ export interface ThrottlingException extends __SmithyException, $MetadataBearer } export namespace ThrottlingException { + /** + * @internal + */ export const filterSensitiveLog = (obj: ThrottlingException): any => ({ ...obj, }); diff --git a/clients/client-connect/commands/AssociateApprovedOriginCommand.ts b/clients/client-connect/commands/AssociateApprovedOriginCommand.ts index dab619b29360..71e8c716d4ed 100644 --- a/clients/client-connect/commands/AssociateApprovedOriginCommand.ts +++ b/clients/client-connect/commands/AssociateApprovedOriginCommand.ts @@ -23,6 +23,20 @@ export interface AssociateApprovedOriginCommandOutput extends __MetadataBearer { /** *

This API is in preview release for Amazon Connect and is subject to change.

*

Associates an approved origin to an Amazon Connect instance.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ConnectClient, AssociateApprovedOriginCommand } from "@aws-sdk/client-connect"; // ES Modules import + * // const { ConnectClient, AssociateApprovedOriginCommand } = require("@aws-sdk/client-connect"); // CommonJS import + * const client = new ConnectClient(config); + * const command = new AssociateApprovedOriginCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link AssociateApprovedOriginCommandInput} for command's `input` shape. + * @see {@link AssociateApprovedOriginCommandOutput} for command's `response` shape. + * @see {@link ConnectClientResolvedConfig | config} for command's `input` shape. + * */ export class AssociateApprovedOriginCommand extends $Command< AssociateApprovedOriginCommandInput, diff --git a/clients/client-connect/commands/AssociateInstanceStorageConfigCommand.ts b/clients/client-connect/commands/AssociateInstanceStorageConfigCommand.ts index 7c4a7bc3661a..3ebca087fec6 100644 --- a/clients/client-connect/commands/AssociateInstanceStorageConfigCommand.ts +++ b/clients/client-connect/commands/AssociateInstanceStorageConfigCommand.ts @@ -30,6 +30,20 @@ export interface AssociateInstanceStorageConfigCommandOutput *

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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ConnectClient, AssociateInstanceStorageConfigCommand } from "@aws-sdk/client-connect"; // ES Modules import + * // const { ConnectClient, AssociateInstanceStorageConfigCommand } = require("@aws-sdk/client-connect"); // CommonJS import + * const client = new ConnectClient(config); + * const command = new AssociateInstanceStorageConfigCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link AssociateInstanceStorageConfigCommandInput} for command's `input` shape. + * @see {@link AssociateInstanceStorageConfigCommandOutput} for command's `response` shape. + * @see {@link ConnectClientResolvedConfig | config} for command's `input` shape. + * */ export class AssociateInstanceStorageConfigCommand extends $Command< AssociateInstanceStorageConfigCommandInput, diff --git a/clients/client-connect/commands/AssociateLambdaFunctionCommand.ts b/clients/client-connect/commands/AssociateLambdaFunctionCommand.ts index b241b1a46a4b..9850da0a15de 100644 --- a/clients/client-connect/commands/AssociateLambdaFunctionCommand.ts +++ b/clients/client-connect/commands/AssociateLambdaFunctionCommand.ts @@ -23,6 +23,20 @@ export interface AssociateLambdaFunctionCommandOutput extends __MetadataBearer { /** *

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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ConnectClient, AssociateLambdaFunctionCommand } from "@aws-sdk/client-connect"; // ES Modules import + * // const { ConnectClient, AssociateLambdaFunctionCommand } = require("@aws-sdk/client-connect"); // CommonJS import + * const client = new ConnectClient(config); + * const command = new AssociateLambdaFunctionCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link AssociateLambdaFunctionCommandInput} for command's `input` shape. + * @see {@link AssociateLambdaFunctionCommandOutput} for command's `response` shape. + * @see {@link ConnectClientResolvedConfig | config} for command's `input` shape. + * */ export class AssociateLambdaFunctionCommand extends $Command< AssociateLambdaFunctionCommandInput, diff --git a/clients/client-connect/commands/AssociateLexBotCommand.ts b/clients/client-connect/commands/AssociateLexBotCommand.ts index 586a4ccffddb..18a3aaa2f7aa 100644 --- a/clients/client-connect/commands/AssociateLexBotCommand.ts +++ b/clients/client-connect/commands/AssociateLexBotCommand.ts @@ -23,6 +23,20 @@ export interface AssociateLexBotCommandOutput extends __MetadataBearer {} /** *

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 bot.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ConnectClient, AssociateLexBotCommand } from "@aws-sdk/client-connect"; // ES Modules import + * // const { ConnectClient, AssociateLexBotCommand } = require("@aws-sdk/client-connect"); // CommonJS import + * const client = new ConnectClient(config); + * const command = new AssociateLexBotCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link AssociateLexBotCommandInput} for command's `input` shape. + * @see {@link AssociateLexBotCommandOutput} for command's `response` shape. + * @see {@link ConnectClientResolvedConfig | config} for command's `input` shape. + * */ export class AssociateLexBotCommand extends $Command< AssociateLexBotCommandInput, diff --git a/clients/client-connect/commands/AssociateQueueQuickConnectsCommand.ts b/clients/client-connect/commands/AssociateQueueQuickConnectsCommand.ts index 34ec238da8ac..4e987da0f8e6 100644 --- a/clients/client-connect/commands/AssociateQueueQuickConnectsCommand.ts +++ b/clients/client-connect/commands/AssociateQueueQuickConnectsCommand.ts @@ -23,6 +23,20 @@ export interface AssociateQueueQuickConnectsCommandOutput extends __MetadataBear /** *

This API is in preview release for Amazon Connect and is subject to change.

*

Associates a set of quick connects with a queue.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ConnectClient, AssociateQueueQuickConnectsCommand } from "@aws-sdk/client-connect"; // ES Modules import + * // const { ConnectClient, AssociateQueueQuickConnectsCommand } = require("@aws-sdk/client-connect"); // CommonJS import + * const client = new ConnectClient(config); + * const command = new AssociateQueueQuickConnectsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link AssociateQueueQuickConnectsCommandInput} for command's `input` shape. + * @see {@link AssociateQueueQuickConnectsCommandOutput} for command's `response` shape. + * @see {@link ConnectClientResolvedConfig | config} for command's `input` shape. + * */ export class AssociateQueueQuickConnectsCommand extends $Command< AssociateQueueQuickConnectsCommandInput, diff --git a/clients/client-connect/commands/AssociateRoutingProfileQueuesCommand.ts b/clients/client-connect/commands/AssociateRoutingProfileQueuesCommand.ts index 4ce833ee3c2e..d12d6bffe60c 100644 --- a/clients/client-connect/commands/AssociateRoutingProfileQueuesCommand.ts +++ b/clients/client-connect/commands/AssociateRoutingProfileQueuesCommand.ts @@ -22,6 +22,20 @@ export interface AssociateRoutingProfileQueuesCommandOutput extends __MetadataBe /** *

Associates a set of queues with a routing profile.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ConnectClient, AssociateRoutingProfileQueuesCommand } from "@aws-sdk/client-connect"; // ES Modules import + * // const { ConnectClient, AssociateRoutingProfileQueuesCommand } = require("@aws-sdk/client-connect"); // CommonJS import + * const client = new ConnectClient(config); + * const command = new AssociateRoutingProfileQueuesCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link AssociateRoutingProfileQueuesCommandInput} for command's `input` shape. + * @see {@link AssociateRoutingProfileQueuesCommandOutput} for command's `response` shape. + * @see {@link ConnectClientResolvedConfig | config} for command's `input` shape. + * */ export class AssociateRoutingProfileQueuesCommand extends $Command< AssociateRoutingProfileQueuesCommandInput, diff --git a/clients/client-connect/commands/AssociateSecurityKeyCommand.ts b/clients/client-connect/commands/AssociateSecurityKeyCommand.ts index f2dcbfe8c610..9fef2264b05d 100644 --- a/clients/client-connect/commands/AssociateSecurityKeyCommand.ts +++ b/clients/client-connect/commands/AssociateSecurityKeyCommand.ts @@ -23,6 +23,20 @@ export interface AssociateSecurityKeyCommandOutput extends AssociateSecurityKeyR /** *

This API is in preview release for Amazon Connect and is subject to change.

*

Associates a security key to the instance.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ConnectClient, AssociateSecurityKeyCommand } from "@aws-sdk/client-connect"; // ES Modules import + * // const { ConnectClient, AssociateSecurityKeyCommand } = require("@aws-sdk/client-connect"); // CommonJS import + * const client = new ConnectClient(config); + * const command = new AssociateSecurityKeyCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link AssociateSecurityKeyCommandInput} for command's `input` shape. + * @see {@link AssociateSecurityKeyCommandOutput} for command's `response` shape. + * @see {@link ConnectClientResolvedConfig | config} for command's `input` shape. + * */ export class AssociateSecurityKeyCommand extends $Command< AssociateSecurityKeyCommandInput, diff --git a/clients/client-connect/commands/CreateContactFlowCommand.ts b/clients/client-connect/commands/CreateContactFlowCommand.ts index de30bdd52c8a..1085262221ed 100644 --- a/clients/client-connect/commands/CreateContactFlowCommand.ts +++ b/clients/client-connect/commands/CreateContactFlowCommand.ts @@ -24,6 +24,20 @@ export interface CreateContactFlowCommandOutput extends CreateContactFlowRespons *

Creates a contact flow for the specified Amazon Connect instance.

*

You can also create and update contact flows using the Amazon Connect * Flow language.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ConnectClient, CreateContactFlowCommand } from "@aws-sdk/client-connect"; // ES Modules import + * // const { ConnectClient, CreateContactFlowCommand } = require("@aws-sdk/client-connect"); // CommonJS import + * const client = new ConnectClient(config); + * const command = new CreateContactFlowCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreateContactFlowCommandInput} for command's `input` shape. + * @see {@link CreateContactFlowCommandOutput} for command's `response` shape. + * @see {@link ConnectClientResolvedConfig | config} for command's `input` shape. + * */ export class CreateContactFlowCommand extends $Command< CreateContactFlowCommandInput, diff --git a/clients/client-connect/commands/CreateInstanceCommand.ts b/clients/client-connect/commands/CreateInstanceCommand.ts index 896cf3c7eaf1..1d25eff6b7ad 100644 --- a/clients/client-connect/commands/CreateInstanceCommand.ts +++ b/clients/client-connect/commands/CreateInstanceCommand.ts @@ -25,6 +25,20 @@ export interface CreateInstanceCommandOutput extends CreateInstanceResponse, __M *

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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ConnectClient, CreateInstanceCommand } from "@aws-sdk/client-connect"; // ES Modules import + * // const { ConnectClient, CreateInstanceCommand } = require("@aws-sdk/client-connect"); // CommonJS import + * const client = new ConnectClient(config); + * const command = new CreateInstanceCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreateInstanceCommandInput} for command's `input` shape. + * @see {@link CreateInstanceCommandOutput} for command's `response` shape. + * @see {@link ConnectClientResolvedConfig | config} for command's `input` shape. + * */ export class CreateInstanceCommand extends $Command< CreateInstanceCommandInput, diff --git a/clients/client-connect/commands/CreateIntegrationAssociationCommand.ts b/clients/client-connect/commands/CreateIntegrationAssociationCommand.ts index 7dfb2276dd5c..af6795478ab8 100644 --- a/clients/client-connect/commands/CreateIntegrationAssociationCommand.ts +++ b/clients/client-connect/commands/CreateIntegrationAssociationCommand.ts @@ -25,6 +25,20 @@ export interface CreateIntegrationAssociationCommandOutput /** *

This API is in preview release for Amazon Connect and is subject to change.

*

Create an AppIntegration association with an Amazon Connect instance.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ConnectClient, CreateIntegrationAssociationCommand } from "@aws-sdk/client-connect"; // ES Modules import + * // const { ConnectClient, CreateIntegrationAssociationCommand } = require("@aws-sdk/client-connect"); // CommonJS import + * const client = new ConnectClient(config); + * const command = new CreateIntegrationAssociationCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreateIntegrationAssociationCommandInput} for command's `input` shape. + * @see {@link CreateIntegrationAssociationCommandOutput} for command's `response` shape. + * @see {@link ConnectClientResolvedConfig | config} for command's `input` shape. + * */ export class CreateIntegrationAssociationCommand extends $Command< CreateIntegrationAssociationCommandInput, diff --git a/clients/client-connect/commands/CreateQueueCommand.ts b/clients/client-connect/commands/CreateQueueCommand.ts index 299cd534f98e..c0515a713787 100644 --- a/clients/client-connect/commands/CreateQueueCommand.ts +++ b/clients/client-connect/commands/CreateQueueCommand.ts @@ -23,6 +23,20 @@ export interface CreateQueueCommandOutput extends CreateQueueResponse, __Metadat /** *

This API is in preview release for Amazon Connect and is subject to change.

*

Creates a new queue for the specified Amazon Connect instance.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ConnectClient, CreateQueueCommand } from "@aws-sdk/client-connect"; // ES Modules import + * // const { ConnectClient, CreateQueueCommand } = require("@aws-sdk/client-connect"); // CommonJS import + * const client = new ConnectClient(config); + * const command = new CreateQueueCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreateQueueCommandInput} for command's `input` shape. + * @see {@link CreateQueueCommandOutput} for command's `response` shape. + * @see {@link ConnectClientResolvedConfig | config} for command's `input` shape. + * */ export class CreateQueueCommand extends $Command< CreateQueueCommandInput, diff --git a/clients/client-connect/commands/CreateQuickConnectCommand.ts b/clients/client-connect/commands/CreateQuickConnectCommand.ts index c04b4eecb59c..854791b3eecd 100644 --- a/clients/client-connect/commands/CreateQuickConnectCommand.ts +++ b/clients/client-connect/commands/CreateQuickConnectCommand.ts @@ -23,6 +23,20 @@ export interface CreateQuickConnectCommandOutput extends CreateQuickConnectRespo /** *

This API is in preview release for Amazon Connect and is subject to change.

*

Creates a quick connect for the specified Amazon Connect instance.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ConnectClient, CreateQuickConnectCommand } from "@aws-sdk/client-connect"; // ES Modules import + * // const { ConnectClient, CreateQuickConnectCommand } = require("@aws-sdk/client-connect"); // CommonJS import + * const client = new ConnectClient(config); + * const command = new CreateQuickConnectCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreateQuickConnectCommandInput} for command's `input` shape. + * @see {@link CreateQuickConnectCommandOutput} for command's `response` shape. + * @see {@link ConnectClientResolvedConfig | config} for command's `input` shape. + * */ export class CreateQuickConnectCommand extends $Command< CreateQuickConnectCommandInput, diff --git a/clients/client-connect/commands/CreateRoutingProfileCommand.ts b/clients/client-connect/commands/CreateRoutingProfileCommand.ts index 802ad2ac5778..158160778a81 100644 --- a/clients/client-connect/commands/CreateRoutingProfileCommand.ts +++ b/clients/client-connect/commands/CreateRoutingProfileCommand.ts @@ -22,6 +22,20 @@ export interface CreateRoutingProfileCommandOutput extends CreateRoutingProfileR /** *

Creates a new routing profile.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ConnectClient, CreateRoutingProfileCommand } from "@aws-sdk/client-connect"; // ES Modules import + * // const { ConnectClient, CreateRoutingProfileCommand } = require("@aws-sdk/client-connect"); // CommonJS import + * const client = new ConnectClient(config); + * const command = new CreateRoutingProfileCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreateRoutingProfileCommandInput} for command's `input` shape. + * @see {@link CreateRoutingProfileCommandOutput} for command's `response` shape. + * @see {@link ConnectClientResolvedConfig | config} for command's `input` shape. + * */ export class CreateRoutingProfileCommand extends $Command< CreateRoutingProfileCommandInput, diff --git a/clients/client-connect/commands/CreateUseCaseCommand.ts b/clients/client-connect/commands/CreateUseCaseCommand.ts index bc25a66c0784..36f72b1f3a06 100644 --- a/clients/client-connect/commands/CreateUseCaseCommand.ts +++ b/clients/client-connect/commands/CreateUseCaseCommand.ts @@ -23,6 +23,20 @@ export interface CreateUseCaseCommandOutput extends CreateUseCaseResponse, __Met /** *

This API is in preview release for Amazon Connect and is subject to change.

*

Creates a use case for an AppIntegration association.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ConnectClient, CreateUseCaseCommand } from "@aws-sdk/client-connect"; // ES Modules import + * // const { ConnectClient, CreateUseCaseCommand } = require("@aws-sdk/client-connect"); // CommonJS import + * const client = new ConnectClient(config); + * const command = new CreateUseCaseCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreateUseCaseCommandInput} for command's `input` shape. + * @see {@link CreateUseCaseCommandOutput} for command's `response` shape. + * @see {@link ConnectClientResolvedConfig | config} for command's `input` shape. + * */ export class CreateUseCaseCommand extends $Command< CreateUseCaseCommandInput, diff --git a/clients/client-connect/commands/CreateUserCommand.ts b/clients/client-connect/commands/CreateUserCommand.ts index bceb1dc86af4..f2854fdc4b66 100644 --- a/clients/client-connect/commands/CreateUserCommand.ts +++ b/clients/client-connect/commands/CreateUserCommand.ts @@ -24,6 +24,20 @@ export interface CreateUserCommandOutput extends CreateUserResponse, __MetadataB *

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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ConnectClient, CreateUserCommand } from "@aws-sdk/client-connect"; // ES Modules import + * // const { ConnectClient, CreateUserCommand } = require("@aws-sdk/client-connect"); // CommonJS import + * const client = new ConnectClient(config); + * const command = new CreateUserCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreateUserCommandInput} for command's `input` shape. + * @see {@link CreateUserCommandOutput} for command's `response` shape. + * @see {@link ConnectClientResolvedConfig | config} for command's `input` shape. + * */ export class CreateUserCommand extends $Command< CreateUserCommandInput, diff --git a/clients/client-connect/commands/CreateUserHierarchyGroupCommand.ts b/clients/client-connect/commands/CreateUserHierarchyGroupCommand.ts index 0cf8b1104eb1..a9f92f9f710f 100644 --- a/clients/client-connect/commands/CreateUserHierarchyGroupCommand.ts +++ b/clients/client-connect/commands/CreateUserHierarchyGroupCommand.ts @@ -22,6 +22,20 @@ export interface CreateUserHierarchyGroupCommandOutput extends CreateUserHierarc /** *

Creates a new user hierarchy group.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ConnectClient, CreateUserHierarchyGroupCommand } from "@aws-sdk/client-connect"; // ES Modules import + * // const { ConnectClient, CreateUserHierarchyGroupCommand } = require("@aws-sdk/client-connect"); // CommonJS import + * const client = new ConnectClient(config); + * const command = new CreateUserHierarchyGroupCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreateUserHierarchyGroupCommandInput} for command's `input` shape. + * @see {@link CreateUserHierarchyGroupCommandOutput} for command's `response` shape. + * @see {@link ConnectClientResolvedConfig | config} for command's `input` shape. + * */ export class CreateUserHierarchyGroupCommand extends $Command< CreateUserHierarchyGroupCommandInput, diff --git a/clients/client-connect/commands/DeleteInstanceCommand.ts b/clients/client-connect/commands/DeleteInstanceCommand.ts index 6ce9cef57add..52b4f2291719 100644 --- a/clients/client-connect/commands/DeleteInstanceCommand.ts +++ b/clients/client-connect/commands/DeleteInstanceCommand.ts @@ -23,6 +23,20 @@ export interface DeleteInstanceCommandOutput extends __MetadataBearer {} /** *

This API is in preview release for Amazon Connect and is subject to change.

*

Deletes the Amazon Connect instance.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ConnectClient, DeleteInstanceCommand } from "@aws-sdk/client-connect"; // ES Modules import + * // const { ConnectClient, DeleteInstanceCommand } = require("@aws-sdk/client-connect"); // CommonJS import + * const client = new ConnectClient(config); + * const command = new DeleteInstanceCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteInstanceCommandInput} for command's `input` shape. + * @see {@link DeleteInstanceCommandOutput} for command's `response` shape. + * @see {@link ConnectClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteInstanceCommand extends $Command< DeleteInstanceCommandInput, diff --git a/clients/client-connect/commands/DeleteIntegrationAssociationCommand.ts b/clients/client-connect/commands/DeleteIntegrationAssociationCommand.ts index 3b6c81a5b58d..1805a8cd9f6f 100644 --- a/clients/client-connect/commands/DeleteIntegrationAssociationCommand.ts +++ b/clients/client-connect/commands/DeleteIntegrationAssociationCommand.ts @@ -24,6 +24,20 @@ export interface DeleteIntegrationAssociationCommandOutput extends __MetadataBea *

This API is in preview release for Amazon Connect and is subject to change.

*

Deletes an AppIntegration association from an Amazon Connect instance. The association must not have * any use cases associated with it.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ConnectClient, DeleteIntegrationAssociationCommand } from "@aws-sdk/client-connect"; // ES Modules import + * // const { ConnectClient, DeleteIntegrationAssociationCommand } = require("@aws-sdk/client-connect"); // CommonJS import + * const client = new ConnectClient(config); + * const command = new DeleteIntegrationAssociationCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteIntegrationAssociationCommandInput} for command's `input` shape. + * @see {@link DeleteIntegrationAssociationCommandOutput} for command's `response` shape. + * @see {@link ConnectClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteIntegrationAssociationCommand extends $Command< DeleteIntegrationAssociationCommandInput, diff --git a/clients/client-connect/commands/DeleteQuickConnectCommand.ts b/clients/client-connect/commands/DeleteQuickConnectCommand.ts index af07c5c8c4bd..f07ef85d93d0 100644 --- a/clients/client-connect/commands/DeleteQuickConnectCommand.ts +++ b/clients/client-connect/commands/DeleteQuickConnectCommand.ts @@ -23,6 +23,20 @@ export interface DeleteQuickConnectCommandOutput extends __MetadataBearer {} /** *

This API is in preview release for Amazon Connect and is subject to change.

*

Deletes a quick connect.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ConnectClient, DeleteQuickConnectCommand } from "@aws-sdk/client-connect"; // ES Modules import + * // const { ConnectClient, DeleteQuickConnectCommand } = require("@aws-sdk/client-connect"); // CommonJS import + * const client = new ConnectClient(config); + * const command = new DeleteQuickConnectCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteQuickConnectCommandInput} for command's `input` shape. + * @see {@link DeleteQuickConnectCommandOutput} for command's `response` shape. + * @see {@link ConnectClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteQuickConnectCommand extends $Command< DeleteQuickConnectCommandInput, diff --git a/clients/client-connect/commands/DeleteUseCaseCommand.ts b/clients/client-connect/commands/DeleteUseCaseCommand.ts index 8f3c6f5018ec..75a2b90d5d54 100644 --- a/clients/client-connect/commands/DeleteUseCaseCommand.ts +++ b/clients/client-connect/commands/DeleteUseCaseCommand.ts @@ -23,6 +23,20 @@ export interface DeleteUseCaseCommandOutput extends __MetadataBearer {} /** *

This API is in preview release for Amazon Connect and is subject to change.

*

Deletes a use case from an AppIntegration association.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ConnectClient, DeleteUseCaseCommand } from "@aws-sdk/client-connect"; // ES Modules import + * // const { ConnectClient, DeleteUseCaseCommand } = require("@aws-sdk/client-connect"); // CommonJS import + * const client = new ConnectClient(config); + * const command = new DeleteUseCaseCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteUseCaseCommandInput} for command's `input` shape. + * @see {@link DeleteUseCaseCommandOutput} for command's `response` shape. + * @see {@link ConnectClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteUseCaseCommand extends $Command< DeleteUseCaseCommandInput, diff --git a/clients/client-connect/commands/DeleteUserCommand.ts b/clients/client-connect/commands/DeleteUserCommand.ts index 8056b19707b2..68f90eee3bda 100644 --- a/clients/client-connect/commands/DeleteUserCommand.ts +++ b/clients/client-connect/commands/DeleteUserCommand.ts @@ -25,6 +25,20 @@ export interface DeleteUserCommandOutput extends __MetadataBearer {} *

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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ConnectClient, DeleteUserCommand } from "@aws-sdk/client-connect"; // ES Modules import + * // const { ConnectClient, DeleteUserCommand } = require("@aws-sdk/client-connect"); // CommonJS import + * const client = new ConnectClient(config); + * const command = new DeleteUserCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteUserCommandInput} for command's `input` shape. + * @see {@link DeleteUserCommandOutput} for command's `response` shape. + * @see {@link ConnectClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteUserCommand extends $Command< DeleteUserCommandInput, diff --git a/clients/client-connect/commands/DeleteUserHierarchyGroupCommand.ts b/clients/client-connect/commands/DeleteUserHierarchyGroupCommand.ts index 61afb3099cce..cd370a1ce100 100644 --- a/clients/client-connect/commands/DeleteUserHierarchyGroupCommand.ts +++ b/clients/client-connect/commands/DeleteUserHierarchyGroupCommand.ts @@ -23,6 +23,20 @@ export interface DeleteUserHierarchyGroupCommandOutput extends __MetadataBearer /** *

Deletes an existing user hierarchy group. It must not be associated with any agents or have * any active child groups.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ConnectClient, DeleteUserHierarchyGroupCommand } from "@aws-sdk/client-connect"; // ES Modules import + * // const { ConnectClient, DeleteUserHierarchyGroupCommand } = require("@aws-sdk/client-connect"); // CommonJS import + * const client = new ConnectClient(config); + * const command = new DeleteUserHierarchyGroupCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteUserHierarchyGroupCommandInput} for command's `input` shape. + * @see {@link DeleteUserHierarchyGroupCommandOutput} for command's `response` shape. + * @see {@link ConnectClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteUserHierarchyGroupCommand extends $Command< DeleteUserHierarchyGroupCommandInput, diff --git a/clients/client-connect/commands/DescribeContactFlowCommand.ts b/clients/client-connect/commands/DescribeContactFlowCommand.ts index 2b18939432dc..473dae6e0a82 100644 --- a/clients/client-connect/commands/DescribeContactFlowCommand.ts +++ b/clients/client-connect/commands/DescribeContactFlowCommand.ts @@ -24,6 +24,20 @@ export interface DescribeContactFlowCommandOutput extends DescribeContactFlowRes *

Describes the specified contact flow.

*

You can also create and update contact flows using the Amazon Connect * Flow language.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ConnectClient, DescribeContactFlowCommand } from "@aws-sdk/client-connect"; // ES Modules import + * // const { ConnectClient, DescribeContactFlowCommand } = require("@aws-sdk/client-connect"); // CommonJS import + * const client = new ConnectClient(config); + * const command = new DescribeContactFlowCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeContactFlowCommandInput} for command's `input` shape. + * @see {@link DescribeContactFlowCommandOutput} for command's `response` shape. + * @see {@link ConnectClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeContactFlowCommand extends $Command< DescribeContactFlowCommandInput, diff --git a/clients/client-connect/commands/DescribeHoursOfOperationCommand.ts b/clients/client-connect/commands/DescribeHoursOfOperationCommand.ts index 79ebe61cb238..d16e2c97f1bb 100644 --- a/clients/client-connect/commands/DescribeHoursOfOperationCommand.ts +++ b/clients/client-connect/commands/DescribeHoursOfOperationCommand.ts @@ -23,6 +23,20 @@ export interface DescribeHoursOfOperationCommandOutput extends DescribeHoursOfOp /** *

This API is in preview release for Amazon Connect and is subject to change.

*

Describes the hours of operation.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ConnectClient, DescribeHoursOfOperationCommand } from "@aws-sdk/client-connect"; // ES Modules import + * // const { ConnectClient, DescribeHoursOfOperationCommand } = require("@aws-sdk/client-connect"); // CommonJS import + * const client = new ConnectClient(config); + * const command = new DescribeHoursOfOperationCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeHoursOfOperationCommandInput} for command's `input` shape. + * @see {@link DescribeHoursOfOperationCommandOutput} for command's `response` shape. + * @see {@link ConnectClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeHoursOfOperationCommand extends $Command< DescribeHoursOfOperationCommandInput, diff --git a/clients/client-connect/commands/DescribeInstanceAttributeCommand.ts b/clients/client-connect/commands/DescribeInstanceAttributeCommand.ts index 4461c2513078..e2f461bad624 100644 --- a/clients/client-connect/commands/DescribeInstanceAttributeCommand.ts +++ b/clients/client-connect/commands/DescribeInstanceAttributeCommand.ts @@ -23,6 +23,20 @@ export interface DescribeInstanceAttributeCommandOutput extends DescribeInstance /** *

This API is in preview release for Amazon Connect and is subject to change.

*

Describes the specified instance attribute.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ConnectClient, DescribeInstanceAttributeCommand } from "@aws-sdk/client-connect"; // ES Modules import + * // const { ConnectClient, DescribeInstanceAttributeCommand } = require("@aws-sdk/client-connect"); // CommonJS import + * const client = new ConnectClient(config); + * const command = new DescribeInstanceAttributeCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeInstanceAttributeCommandInput} for command's `input` shape. + * @see {@link DescribeInstanceAttributeCommandOutput} for command's `response` shape. + * @see {@link ConnectClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeInstanceAttributeCommand extends $Command< DescribeInstanceAttributeCommandInput, diff --git a/clients/client-connect/commands/DescribeInstanceCommand.ts b/clients/client-connect/commands/DescribeInstanceCommand.ts index ad5a69b0485d..6c4247eed46d 100644 --- a/clients/client-connect/commands/DescribeInstanceCommand.ts +++ b/clients/client-connect/commands/DescribeInstanceCommand.ts @@ -27,6 +27,20 @@ export interface DescribeInstanceCommandOutput extends DescribeInstanceResponse, *

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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ConnectClient, DescribeInstanceCommand } from "@aws-sdk/client-connect"; // ES Modules import + * // const { ConnectClient, DescribeInstanceCommand } = require("@aws-sdk/client-connect"); // CommonJS import + * const client = new ConnectClient(config); + * const command = new DescribeInstanceCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeInstanceCommandInput} for command's `input` shape. + * @see {@link DescribeInstanceCommandOutput} for command's `response` shape. + * @see {@link ConnectClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeInstanceCommand extends $Command< DescribeInstanceCommandInput, diff --git a/clients/client-connect/commands/DescribeInstanceStorageConfigCommand.ts b/clients/client-connect/commands/DescribeInstanceStorageConfigCommand.ts index 2852c5b6b9c4..019b66f75652 100644 --- a/clients/client-connect/commands/DescribeInstanceStorageConfigCommand.ts +++ b/clients/client-connect/commands/DescribeInstanceStorageConfigCommand.ts @@ -26,6 +26,20 @@ export interface DescribeInstanceStorageConfigCommandOutput *

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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ConnectClient, DescribeInstanceStorageConfigCommand } from "@aws-sdk/client-connect"; // ES Modules import + * // const { ConnectClient, DescribeInstanceStorageConfigCommand } = require("@aws-sdk/client-connect"); // CommonJS import + * const client = new ConnectClient(config); + * const command = new DescribeInstanceStorageConfigCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeInstanceStorageConfigCommandInput} for command's `input` shape. + * @see {@link DescribeInstanceStorageConfigCommandOutput} for command's `response` shape. + * @see {@link ConnectClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeInstanceStorageConfigCommand extends $Command< DescribeInstanceStorageConfigCommandInput, diff --git a/clients/client-connect/commands/DescribeQueueCommand.ts b/clients/client-connect/commands/DescribeQueueCommand.ts index 8cb125b46630..0ff1d4c92092 100644 --- a/clients/client-connect/commands/DescribeQueueCommand.ts +++ b/clients/client-connect/commands/DescribeQueueCommand.ts @@ -23,6 +23,20 @@ export interface DescribeQueueCommandOutput extends DescribeQueueResponse, __Met /** *

This API is in preview release for Amazon Connect and is subject to change.

*

Describes the specified queue.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ConnectClient, DescribeQueueCommand } from "@aws-sdk/client-connect"; // ES Modules import + * // const { ConnectClient, DescribeQueueCommand } = require("@aws-sdk/client-connect"); // CommonJS import + * const client = new ConnectClient(config); + * const command = new DescribeQueueCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeQueueCommandInput} for command's `input` shape. + * @see {@link DescribeQueueCommandOutput} for command's `response` shape. + * @see {@link ConnectClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeQueueCommand extends $Command< DescribeQueueCommandInput, diff --git a/clients/client-connect/commands/DescribeQuickConnectCommand.ts b/clients/client-connect/commands/DescribeQuickConnectCommand.ts index 8eb07e19cf6e..0b20e435ff0e 100644 --- a/clients/client-connect/commands/DescribeQuickConnectCommand.ts +++ b/clients/client-connect/commands/DescribeQuickConnectCommand.ts @@ -23,6 +23,20 @@ export interface DescribeQuickConnectCommandOutput extends DescribeQuickConnectR /** *

This API is in preview release for Amazon Connect and is subject to change.

*

Describes the quick connect.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ConnectClient, DescribeQuickConnectCommand } from "@aws-sdk/client-connect"; // ES Modules import + * // const { ConnectClient, DescribeQuickConnectCommand } = require("@aws-sdk/client-connect"); // CommonJS import + * const client = new ConnectClient(config); + * const command = new DescribeQuickConnectCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeQuickConnectCommandInput} for command's `input` shape. + * @see {@link DescribeQuickConnectCommandOutput} for command's `response` shape. + * @see {@link ConnectClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeQuickConnectCommand extends $Command< DescribeQuickConnectCommandInput, diff --git a/clients/client-connect/commands/DescribeRoutingProfileCommand.ts b/clients/client-connect/commands/DescribeRoutingProfileCommand.ts index 1890f3326e61..c412abc6ff1e 100644 --- a/clients/client-connect/commands/DescribeRoutingProfileCommand.ts +++ b/clients/client-connect/commands/DescribeRoutingProfileCommand.ts @@ -22,6 +22,20 @@ export interface DescribeRoutingProfileCommandOutput extends DescribeRoutingProf /** *

Describes the specified routing profile.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ConnectClient, DescribeRoutingProfileCommand } from "@aws-sdk/client-connect"; // ES Modules import + * // const { ConnectClient, DescribeRoutingProfileCommand } = require("@aws-sdk/client-connect"); // CommonJS import + * const client = new ConnectClient(config); + * const command = new DescribeRoutingProfileCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeRoutingProfileCommandInput} for command's `input` shape. + * @see {@link DescribeRoutingProfileCommandOutput} for command's `response` shape. + * @see {@link ConnectClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeRoutingProfileCommand extends $Command< DescribeRoutingProfileCommandInput, diff --git a/clients/client-connect/commands/DescribeUserCommand.ts b/clients/client-connect/commands/DescribeUserCommand.ts index 3f48089ab55f..99101b53b3ae 100644 --- a/clients/client-connect/commands/DescribeUserCommand.ts +++ b/clients/client-connect/commands/DescribeUserCommand.ts @@ -24,6 +24,20 @@ export interface DescribeUserCommandOutput extends DescribeUserResponse, __Metad *

Describes the specified user account. You can find the instance ID in the 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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ConnectClient, DescribeUserCommand } from "@aws-sdk/client-connect"; // ES Modules import + * // const { ConnectClient, DescribeUserCommand } = require("@aws-sdk/client-connect"); // CommonJS import + * const client = new ConnectClient(config); + * const command = new DescribeUserCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeUserCommandInput} for command's `input` shape. + * @see {@link DescribeUserCommandOutput} for command's `response` shape. + * @see {@link ConnectClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeUserCommand extends $Command< DescribeUserCommandInput, diff --git a/clients/client-connect/commands/DescribeUserHierarchyGroupCommand.ts b/clients/client-connect/commands/DescribeUserHierarchyGroupCommand.ts index e53fb886ebe4..d85be29d8fad 100644 --- a/clients/client-connect/commands/DescribeUserHierarchyGroupCommand.ts +++ b/clients/client-connect/commands/DescribeUserHierarchyGroupCommand.ts @@ -22,6 +22,20 @@ export interface DescribeUserHierarchyGroupCommandOutput extends DescribeUserHie /** *

Describes the specified hierarchy group.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ConnectClient, DescribeUserHierarchyGroupCommand } from "@aws-sdk/client-connect"; // ES Modules import + * // const { ConnectClient, DescribeUserHierarchyGroupCommand } = require("@aws-sdk/client-connect"); // CommonJS import + * const client = new ConnectClient(config); + * const command = new DescribeUserHierarchyGroupCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeUserHierarchyGroupCommandInput} for command's `input` shape. + * @see {@link DescribeUserHierarchyGroupCommandOutput} for command's `response` shape. + * @see {@link ConnectClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeUserHierarchyGroupCommand extends $Command< DescribeUserHierarchyGroupCommandInput, diff --git a/clients/client-connect/commands/DescribeUserHierarchyStructureCommand.ts b/clients/client-connect/commands/DescribeUserHierarchyStructureCommand.ts index 04e2d1d605b0..b4acaeb5e1ba 100644 --- a/clients/client-connect/commands/DescribeUserHierarchyStructureCommand.ts +++ b/clients/client-connect/commands/DescribeUserHierarchyStructureCommand.ts @@ -24,6 +24,20 @@ export interface DescribeUserHierarchyStructureCommandOutput /** *

Describes the hierarchy structure of the specified Amazon Connect instance.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ConnectClient, DescribeUserHierarchyStructureCommand } from "@aws-sdk/client-connect"; // ES Modules import + * // const { ConnectClient, DescribeUserHierarchyStructureCommand } = require("@aws-sdk/client-connect"); // CommonJS import + * const client = new ConnectClient(config); + * const command = new DescribeUserHierarchyStructureCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeUserHierarchyStructureCommandInput} for command's `input` shape. + * @see {@link DescribeUserHierarchyStructureCommandOutput} for command's `response` shape. + * @see {@link ConnectClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeUserHierarchyStructureCommand extends $Command< DescribeUserHierarchyStructureCommandInput, diff --git a/clients/client-connect/commands/DisassociateApprovedOriginCommand.ts b/clients/client-connect/commands/DisassociateApprovedOriginCommand.ts index c929c32038d1..532abc4d9ad7 100644 --- a/clients/client-connect/commands/DisassociateApprovedOriginCommand.ts +++ b/clients/client-connect/commands/DisassociateApprovedOriginCommand.ts @@ -23,6 +23,20 @@ export interface DisassociateApprovedOriginCommandOutput extends __MetadataBeare /** *

This API is in preview release for Amazon Connect and is subject to change.

*

Revokes access to integrated applications from Amazon Connect.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ConnectClient, DisassociateApprovedOriginCommand } from "@aws-sdk/client-connect"; // ES Modules import + * // const { ConnectClient, DisassociateApprovedOriginCommand } = require("@aws-sdk/client-connect"); // CommonJS import + * const client = new ConnectClient(config); + * const command = new DisassociateApprovedOriginCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DisassociateApprovedOriginCommandInput} for command's `input` shape. + * @see {@link DisassociateApprovedOriginCommandOutput} for command's `response` shape. + * @see {@link ConnectClientResolvedConfig | config} for command's `input` shape. + * */ export class DisassociateApprovedOriginCommand extends $Command< DisassociateApprovedOriginCommandInput, diff --git a/clients/client-connect/commands/DisassociateInstanceStorageConfigCommand.ts b/clients/client-connect/commands/DisassociateInstanceStorageConfigCommand.ts index 75406ec6ff67..eb3abb7014b5 100644 --- a/clients/client-connect/commands/DisassociateInstanceStorageConfigCommand.ts +++ b/clients/client-connect/commands/DisassociateInstanceStorageConfigCommand.ts @@ -24,6 +24,20 @@ export interface DisassociateInstanceStorageConfigCommandOutput extends __Metada *

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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ConnectClient, DisassociateInstanceStorageConfigCommand } from "@aws-sdk/client-connect"; // ES Modules import + * // const { ConnectClient, DisassociateInstanceStorageConfigCommand } = require("@aws-sdk/client-connect"); // CommonJS import + * const client = new ConnectClient(config); + * const command = new DisassociateInstanceStorageConfigCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DisassociateInstanceStorageConfigCommandInput} for command's `input` shape. + * @see {@link DisassociateInstanceStorageConfigCommandOutput} for command's `response` shape. + * @see {@link ConnectClientResolvedConfig | config} for command's `input` shape. + * */ export class DisassociateInstanceStorageConfigCommand extends $Command< DisassociateInstanceStorageConfigCommandInput, diff --git a/clients/client-connect/commands/DisassociateLambdaFunctionCommand.ts b/clients/client-connect/commands/DisassociateLambdaFunctionCommand.ts index 55c49721fd53..91bd32893182 100644 --- a/clients/client-connect/commands/DisassociateLambdaFunctionCommand.ts +++ b/clients/client-connect/commands/DisassociateLambdaFunctionCommand.ts @@ -24,6 +24,20 @@ export interface DisassociateLambdaFunctionCommandOutput extends __MetadataBeare *

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 contact flow * blocks.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ConnectClient, DisassociateLambdaFunctionCommand } from "@aws-sdk/client-connect"; // ES Modules import + * // const { ConnectClient, DisassociateLambdaFunctionCommand } = require("@aws-sdk/client-connect"); // CommonJS import + * const client = new ConnectClient(config); + * const command = new DisassociateLambdaFunctionCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DisassociateLambdaFunctionCommandInput} for command's `input` shape. + * @see {@link DisassociateLambdaFunctionCommandOutput} for command's `response` shape. + * @see {@link ConnectClientResolvedConfig | config} for command's `input` shape. + * */ export class DisassociateLambdaFunctionCommand extends $Command< DisassociateLambdaFunctionCommandInput, diff --git a/clients/client-connect/commands/DisassociateLexBotCommand.ts b/clients/client-connect/commands/DisassociateLexBotCommand.ts index 48b8eb7ea16b..d472d5fb3c4c 100644 --- a/clients/client-connect/commands/DisassociateLexBotCommand.ts +++ b/clients/client-connect/commands/DisassociateLexBotCommand.ts @@ -23,6 +23,20 @@ export interface DisassociateLexBotCommandOutput extends __MetadataBearer {} /** *

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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ConnectClient, DisassociateLexBotCommand } from "@aws-sdk/client-connect"; // ES Modules import + * // const { ConnectClient, DisassociateLexBotCommand } = require("@aws-sdk/client-connect"); // CommonJS import + * const client = new ConnectClient(config); + * const command = new DisassociateLexBotCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DisassociateLexBotCommandInput} for command's `input` shape. + * @see {@link DisassociateLexBotCommandOutput} for command's `response` shape. + * @see {@link ConnectClientResolvedConfig | config} for command's `input` shape. + * */ export class DisassociateLexBotCommand extends $Command< DisassociateLexBotCommandInput, diff --git a/clients/client-connect/commands/DisassociateQueueQuickConnectsCommand.ts b/clients/client-connect/commands/DisassociateQueueQuickConnectsCommand.ts index a9eb11048dbf..81f7beec42a4 100644 --- a/clients/client-connect/commands/DisassociateQueueQuickConnectsCommand.ts +++ b/clients/client-connect/commands/DisassociateQueueQuickConnectsCommand.ts @@ -23,6 +23,20 @@ export interface DisassociateQueueQuickConnectsCommandOutput extends __MetadataB /** *

This API is in preview release for Amazon Connect and is subject to change.

*

Disassociates a set of quick connects from a queue.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ConnectClient, DisassociateQueueQuickConnectsCommand } from "@aws-sdk/client-connect"; // ES Modules import + * // const { ConnectClient, DisassociateQueueQuickConnectsCommand } = require("@aws-sdk/client-connect"); // CommonJS import + * const client = new ConnectClient(config); + * const command = new DisassociateQueueQuickConnectsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DisassociateQueueQuickConnectsCommandInput} for command's `input` shape. + * @see {@link DisassociateQueueQuickConnectsCommandOutput} for command's `response` shape. + * @see {@link ConnectClientResolvedConfig | config} for command's `input` shape. + * */ export class DisassociateQueueQuickConnectsCommand extends $Command< DisassociateQueueQuickConnectsCommandInput, diff --git a/clients/client-connect/commands/DisassociateRoutingProfileQueuesCommand.ts b/clients/client-connect/commands/DisassociateRoutingProfileQueuesCommand.ts index d03ea37fe4ed..2c1489520fbb 100644 --- a/clients/client-connect/commands/DisassociateRoutingProfileQueuesCommand.ts +++ b/clients/client-connect/commands/DisassociateRoutingProfileQueuesCommand.ts @@ -22,6 +22,20 @@ export interface DisassociateRoutingProfileQueuesCommandOutput extends __Metadat /** *

Disassociates a set of queues from a routing profile.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ConnectClient, DisassociateRoutingProfileQueuesCommand } from "@aws-sdk/client-connect"; // ES Modules import + * // const { ConnectClient, DisassociateRoutingProfileQueuesCommand } = require("@aws-sdk/client-connect"); // CommonJS import + * const client = new ConnectClient(config); + * const command = new DisassociateRoutingProfileQueuesCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DisassociateRoutingProfileQueuesCommandInput} for command's `input` shape. + * @see {@link DisassociateRoutingProfileQueuesCommandOutput} for command's `response` shape. + * @see {@link ConnectClientResolvedConfig | config} for command's `input` shape. + * */ export class DisassociateRoutingProfileQueuesCommand extends $Command< DisassociateRoutingProfileQueuesCommandInput, diff --git a/clients/client-connect/commands/DisassociateSecurityKeyCommand.ts b/clients/client-connect/commands/DisassociateSecurityKeyCommand.ts index 282f124eb5b1..6e9050a337cd 100644 --- a/clients/client-connect/commands/DisassociateSecurityKeyCommand.ts +++ b/clients/client-connect/commands/DisassociateSecurityKeyCommand.ts @@ -23,6 +23,20 @@ export interface DisassociateSecurityKeyCommandOutput extends __MetadataBearer { /** *

This API is in preview release for Amazon Connect and is subject to change.

*

Deletes the specified security key.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ConnectClient, DisassociateSecurityKeyCommand } from "@aws-sdk/client-connect"; // ES Modules import + * // const { ConnectClient, DisassociateSecurityKeyCommand } = require("@aws-sdk/client-connect"); // CommonJS import + * const client = new ConnectClient(config); + * const command = new DisassociateSecurityKeyCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DisassociateSecurityKeyCommandInput} for command's `input` shape. + * @see {@link DisassociateSecurityKeyCommandOutput} for command's `response` shape. + * @see {@link ConnectClientResolvedConfig | config} for command's `input` shape. + * */ export class DisassociateSecurityKeyCommand extends $Command< DisassociateSecurityKeyCommandInput, diff --git a/clients/client-connect/commands/GetContactAttributesCommand.ts b/clients/client-connect/commands/GetContactAttributesCommand.ts index 6ae325c1fa7a..803fa7ce0e2c 100644 --- a/clients/client-connect/commands/GetContactAttributesCommand.ts +++ b/clients/client-connect/commands/GetContactAttributesCommand.ts @@ -22,6 +22,20 @@ export interface GetContactAttributesCommandOutput extends GetContactAttributesR /** *

Retrieves the contact attributes for the specified contact.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ConnectClient, GetContactAttributesCommand } from "@aws-sdk/client-connect"; // ES Modules import + * // const { ConnectClient, GetContactAttributesCommand } = require("@aws-sdk/client-connect"); // CommonJS import + * const client = new ConnectClient(config); + * const command = new GetContactAttributesCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetContactAttributesCommandInput} for command's `input` shape. + * @see {@link GetContactAttributesCommandOutput} for command's `response` shape. + * @see {@link ConnectClientResolvedConfig | config} for command's `input` shape. + * */ export class GetContactAttributesCommand extends $Command< GetContactAttributesCommandInput, diff --git a/clients/client-connect/commands/GetCurrentMetricDataCommand.ts b/clients/client-connect/commands/GetCurrentMetricDataCommand.ts index 385744f4debf..ec2036ecf266 100644 --- a/clients/client-connect/commands/GetCurrentMetricDataCommand.ts +++ b/clients/client-connect/commands/GetCurrentMetricDataCommand.ts @@ -24,6 +24,20 @@ export interface GetCurrentMetricDataCommandOutput extends GetCurrentMetricDataR *

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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ConnectClient, GetCurrentMetricDataCommand } from "@aws-sdk/client-connect"; // ES Modules import + * // const { ConnectClient, GetCurrentMetricDataCommand } = require("@aws-sdk/client-connect"); // CommonJS import + * const client = new ConnectClient(config); + * const command = new GetCurrentMetricDataCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetCurrentMetricDataCommandInput} for command's `input` shape. + * @see {@link GetCurrentMetricDataCommandOutput} for command's `response` shape. + * @see {@link ConnectClientResolvedConfig | config} for command's `input` shape. + * */ export class GetCurrentMetricDataCommand extends $Command< GetCurrentMetricDataCommandInput, diff --git a/clients/client-connect/commands/GetFederationTokenCommand.ts b/clients/client-connect/commands/GetFederationTokenCommand.ts index fa25bd79fc85..b5786ce1c50e 100644 --- a/clients/client-connect/commands/GetFederationTokenCommand.ts +++ b/clients/client-connect/commands/GetFederationTokenCommand.ts @@ -22,6 +22,20 @@ export interface GetFederationTokenCommandOutput extends GetFederationTokenRespo /** *

Retrieves a token for federation.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ConnectClient, GetFederationTokenCommand } from "@aws-sdk/client-connect"; // ES Modules import + * // const { ConnectClient, GetFederationTokenCommand } = require("@aws-sdk/client-connect"); // CommonJS import + * const client = new ConnectClient(config); + * const command = new GetFederationTokenCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetFederationTokenCommandInput} for command's `input` shape. + * @see {@link GetFederationTokenCommandOutput} for command's `response` shape. + * @see {@link ConnectClientResolvedConfig | config} for command's `input` shape. + * */ export class GetFederationTokenCommand extends $Command< GetFederationTokenCommandInput, diff --git a/clients/client-connect/commands/GetMetricDataCommand.ts b/clients/client-connect/commands/GetMetricDataCommand.ts index df5884a9c1d7..e1c1cf997cba 100644 --- a/clients/client-connect/commands/GetMetricDataCommand.ts +++ b/clients/client-connect/commands/GetMetricDataCommand.ts @@ -24,6 +24,20 @@ export interface GetMetricDataCommandOutput extends GetMetricDataResponse, __Met *

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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ConnectClient, GetMetricDataCommand } from "@aws-sdk/client-connect"; // ES Modules import + * // const { ConnectClient, GetMetricDataCommand } = require("@aws-sdk/client-connect"); // CommonJS import + * const client = new ConnectClient(config); + * const command = new GetMetricDataCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetMetricDataCommandInput} for command's `input` shape. + * @see {@link GetMetricDataCommandOutput} for command's `response` shape. + * @see {@link ConnectClientResolvedConfig | config} for command's `input` shape. + * */ export class GetMetricDataCommand extends $Command< GetMetricDataCommandInput, diff --git a/clients/client-connect/commands/ListApprovedOriginsCommand.ts b/clients/client-connect/commands/ListApprovedOriginsCommand.ts index 81e838e414c1..3f6fe7e95ac1 100644 --- a/clients/client-connect/commands/ListApprovedOriginsCommand.ts +++ b/clients/client-connect/commands/ListApprovedOriginsCommand.ts @@ -23,6 +23,20 @@ export interface ListApprovedOriginsCommandOutput extends ListApprovedOriginsRes /** *

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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ConnectClient, ListApprovedOriginsCommand } from "@aws-sdk/client-connect"; // ES Modules import + * // const { ConnectClient, ListApprovedOriginsCommand } = require("@aws-sdk/client-connect"); // CommonJS import + * const client = new ConnectClient(config); + * const command = new ListApprovedOriginsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListApprovedOriginsCommandInput} for command's `input` shape. + * @see {@link ListApprovedOriginsCommandOutput} for command's `response` shape. + * @see {@link ConnectClientResolvedConfig | config} for command's `input` shape. + * */ export class ListApprovedOriginsCommand extends $Command< ListApprovedOriginsCommandInput, diff --git a/clients/client-connect/commands/ListContactFlowsCommand.ts b/clients/client-connect/commands/ListContactFlowsCommand.ts index 21cf0163b198..859e5461664c 100644 --- a/clients/client-connect/commands/ListContactFlowsCommand.ts +++ b/clients/client-connect/commands/ListContactFlowsCommand.ts @@ -26,6 +26,20 @@ export interface ListContactFlowsCommandOutput extends ListContactFlowsResponse, * Flow language.

*

For more information about contact flows, see Contact Flows in the * Amazon Connect Administrator Guide.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ConnectClient, ListContactFlowsCommand } from "@aws-sdk/client-connect"; // ES Modules import + * // const { ConnectClient, ListContactFlowsCommand } = require("@aws-sdk/client-connect"); // CommonJS import + * const client = new ConnectClient(config); + * const command = new ListContactFlowsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListContactFlowsCommandInput} for command's `input` shape. + * @see {@link ListContactFlowsCommandOutput} for command's `response` shape. + * @see {@link ConnectClientResolvedConfig | config} for command's `input` shape. + * */ export class ListContactFlowsCommand extends $Command< ListContactFlowsCommandInput, diff --git a/clients/client-connect/commands/ListHoursOfOperationsCommand.ts b/clients/client-connect/commands/ListHoursOfOperationsCommand.ts index e9e0f53d9e0c..e0ed19124261 100644 --- a/clients/client-connect/commands/ListHoursOfOperationsCommand.ts +++ b/clients/client-connect/commands/ListHoursOfOperationsCommand.ts @@ -24,6 +24,20 @@ export interface ListHoursOfOperationsCommandOutput extends ListHoursOfOperation *

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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ConnectClient, ListHoursOfOperationsCommand } from "@aws-sdk/client-connect"; // ES Modules import + * // const { ConnectClient, ListHoursOfOperationsCommand } = require("@aws-sdk/client-connect"); // CommonJS import + * const client = new ConnectClient(config); + * const command = new ListHoursOfOperationsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListHoursOfOperationsCommandInput} for command's `input` shape. + * @see {@link ListHoursOfOperationsCommandOutput} for command's `response` shape. + * @see {@link ConnectClientResolvedConfig | config} for command's `input` shape. + * */ export class ListHoursOfOperationsCommand extends $Command< ListHoursOfOperationsCommandInput, diff --git a/clients/client-connect/commands/ListInstanceAttributesCommand.ts b/clients/client-connect/commands/ListInstanceAttributesCommand.ts index b9dd47a25dd2..728915a69b7a 100644 --- a/clients/client-connect/commands/ListInstanceAttributesCommand.ts +++ b/clients/client-connect/commands/ListInstanceAttributesCommand.ts @@ -23,6 +23,20 @@ export interface ListInstanceAttributesCommandOutput extends ListInstanceAttribu /** *

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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ConnectClient, ListInstanceAttributesCommand } from "@aws-sdk/client-connect"; // ES Modules import + * // const { ConnectClient, ListInstanceAttributesCommand } = require("@aws-sdk/client-connect"); // CommonJS import + * const client = new ConnectClient(config); + * const command = new ListInstanceAttributesCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListInstanceAttributesCommandInput} for command's `input` shape. + * @see {@link ListInstanceAttributesCommandOutput} for command's `response` shape. + * @see {@link ConnectClientResolvedConfig | config} for command's `input` shape. + * */ export class ListInstanceAttributesCommand extends $Command< ListInstanceAttributesCommandInput, diff --git a/clients/client-connect/commands/ListInstanceStorageConfigsCommand.ts b/clients/client-connect/commands/ListInstanceStorageConfigsCommand.ts index 681065347e27..b5d605bb9b05 100644 --- a/clients/client-connect/commands/ListInstanceStorageConfigsCommand.ts +++ b/clients/client-connect/commands/ListInstanceStorageConfigsCommand.ts @@ -25,6 +25,20 @@ export interface ListInstanceStorageConfigsCommandOutput extends ListInstanceSto * *

Returns a paginated list of storage configs for the identified instance and resource * type.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ConnectClient, ListInstanceStorageConfigsCommand } from "@aws-sdk/client-connect"; // ES Modules import + * // const { ConnectClient, ListInstanceStorageConfigsCommand } = require("@aws-sdk/client-connect"); // CommonJS import + * const client = new ConnectClient(config); + * const command = new ListInstanceStorageConfigsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListInstanceStorageConfigsCommandInput} for command's `input` shape. + * @see {@link ListInstanceStorageConfigsCommandOutput} for command's `response` shape. + * @see {@link ConnectClientResolvedConfig | config} for command's `input` shape. + * */ export class ListInstanceStorageConfigsCommand extends $Command< ListInstanceStorageConfigsCommandInput, diff --git a/clients/client-connect/commands/ListInstancesCommand.ts b/clients/client-connect/commands/ListInstancesCommand.ts index 75903f216326..b44c64e559b9 100644 --- a/clients/client-connect/commands/ListInstancesCommand.ts +++ b/clients/client-connect/commands/ListInstancesCommand.ts @@ -25,6 +25,20 @@ export interface ListInstancesCommandOutput extends ListInstancesResponse, __Met *

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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ConnectClient, ListInstancesCommand } from "@aws-sdk/client-connect"; // ES Modules import + * // const { ConnectClient, ListInstancesCommand } = require("@aws-sdk/client-connect"); // CommonJS import + * const client = new ConnectClient(config); + * const command = new ListInstancesCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListInstancesCommandInput} for command's `input` shape. + * @see {@link ListInstancesCommandOutput} for command's `response` shape. + * @see {@link ConnectClientResolvedConfig | config} for command's `input` shape. + * */ export class ListInstancesCommand extends $Command< ListInstancesCommandInput, diff --git a/clients/client-connect/commands/ListIntegrationAssociationsCommand.ts b/clients/client-connect/commands/ListIntegrationAssociationsCommand.ts index 522cf88f97bf..4373af551e5f 100644 --- a/clients/client-connect/commands/ListIntegrationAssociationsCommand.ts +++ b/clients/client-connect/commands/ListIntegrationAssociationsCommand.ts @@ -26,6 +26,20 @@ export interface ListIntegrationAssociationsCommandOutput *

This API is in preview release for Amazon Connect and is subject to change.

*

Provides summary information about the AppIntegration associations for the specified Amazon Connect * instance.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ConnectClient, ListIntegrationAssociationsCommand } from "@aws-sdk/client-connect"; // ES Modules import + * // const { ConnectClient, ListIntegrationAssociationsCommand } = require("@aws-sdk/client-connect"); // CommonJS import + * const client = new ConnectClient(config); + * const command = new ListIntegrationAssociationsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListIntegrationAssociationsCommandInput} for command's `input` shape. + * @see {@link ListIntegrationAssociationsCommandOutput} for command's `response` shape. + * @see {@link ConnectClientResolvedConfig | config} for command's `input` shape. + * */ export class ListIntegrationAssociationsCommand extends $Command< ListIntegrationAssociationsCommandInput, diff --git a/clients/client-connect/commands/ListLambdaFunctionsCommand.ts b/clients/client-connect/commands/ListLambdaFunctionsCommand.ts index 166d566b8abf..501fdab89766 100644 --- a/clients/client-connect/commands/ListLambdaFunctionsCommand.ts +++ b/clients/client-connect/commands/ListLambdaFunctionsCommand.ts @@ -24,6 +24,20 @@ export interface ListLambdaFunctionsCommandOutput extends ListLambdaFunctionsRes *

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 contact flow blocks.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ConnectClient, ListLambdaFunctionsCommand } from "@aws-sdk/client-connect"; // ES Modules import + * // const { ConnectClient, ListLambdaFunctionsCommand } = require("@aws-sdk/client-connect"); // CommonJS import + * const client = new ConnectClient(config); + * const command = new ListLambdaFunctionsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListLambdaFunctionsCommandInput} for command's `input` shape. + * @see {@link ListLambdaFunctionsCommandOutput} for command's `response` shape. + * @see {@link ConnectClientResolvedConfig | config} for command's `input` shape. + * */ export class ListLambdaFunctionsCommand extends $Command< ListLambdaFunctionsCommandInput, diff --git a/clients/client-connect/commands/ListLexBotsCommand.ts b/clients/client-connect/commands/ListLexBotsCommand.ts index a0977cc7aece..a6e8acb02229 100644 --- a/clients/client-connect/commands/ListLexBotsCommand.ts +++ b/clients/client-connect/commands/ListLexBotsCommand.ts @@ -24,6 +24,20 @@ export interface ListLexBotsCommandOutput extends ListLexBotsResponse, __Metadat *

This API is in preview release for Amazon Connect and is subject to change.

*

Returns a paginated list of all the Amazon Lex bots currently associated with the * instance.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ConnectClient, ListLexBotsCommand } from "@aws-sdk/client-connect"; // ES Modules import + * // const { ConnectClient, ListLexBotsCommand } = require("@aws-sdk/client-connect"); // CommonJS import + * const client = new ConnectClient(config); + * const command = new ListLexBotsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListLexBotsCommandInput} for command's `input` shape. + * @see {@link ListLexBotsCommandOutput} for command's `response` shape. + * @see {@link ConnectClientResolvedConfig | config} for command's `input` shape. + * */ export class ListLexBotsCommand extends $Command< ListLexBotsCommandInput, diff --git a/clients/client-connect/commands/ListPhoneNumbersCommand.ts b/clients/client-connect/commands/ListPhoneNumbersCommand.ts index 952a9eb8d7a0..70d77840a565 100644 --- a/clients/client-connect/commands/ListPhoneNumbersCommand.ts +++ b/clients/client-connect/commands/ListPhoneNumbersCommand.ts @@ -24,6 +24,20 @@ export interface ListPhoneNumbersCommandOutput extends ListPhoneNumbersResponse, *

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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ConnectClient, ListPhoneNumbersCommand } from "@aws-sdk/client-connect"; // ES Modules import + * // const { ConnectClient, ListPhoneNumbersCommand } = require("@aws-sdk/client-connect"); // CommonJS import + * const client = new ConnectClient(config); + * const command = new ListPhoneNumbersCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListPhoneNumbersCommandInput} for command's `input` shape. + * @see {@link ListPhoneNumbersCommandOutput} for command's `response` shape. + * @see {@link ConnectClientResolvedConfig | config} for command's `input` shape. + * */ export class ListPhoneNumbersCommand extends $Command< ListPhoneNumbersCommandInput, diff --git a/clients/client-connect/commands/ListPromptsCommand.ts b/clients/client-connect/commands/ListPromptsCommand.ts index a3e7dfb909c0..7a1fab8ff7ca 100644 --- a/clients/client-connect/commands/ListPromptsCommand.ts +++ b/clients/client-connect/commands/ListPromptsCommand.ts @@ -22,6 +22,20 @@ export interface ListPromptsCommandOutput extends ListPromptsResponse, __Metadat /** *

Provides information about the prompts for the specified Amazon Connect instance.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ConnectClient, ListPromptsCommand } from "@aws-sdk/client-connect"; // ES Modules import + * // const { ConnectClient, ListPromptsCommand } = require("@aws-sdk/client-connect"); // CommonJS import + * const client = new ConnectClient(config); + * const command = new ListPromptsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListPromptsCommandInput} for command's `input` shape. + * @see {@link ListPromptsCommandOutput} for command's `response` shape. + * @see {@link ConnectClientResolvedConfig | config} for command's `input` shape. + * */ export class ListPromptsCommand extends $Command< ListPromptsCommandInput, diff --git a/clients/client-connect/commands/ListQueueQuickConnectsCommand.ts b/clients/client-connect/commands/ListQueueQuickConnectsCommand.ts index 6ce4677cbeef..49d977b74fa3 100644 --- a/clients/client-connect/commands/ListQueueQuickConnectsCommand.ts +++ b/clients/client-connect/commands/ListQueueQuickConnectsCommand.ts @@ -23,6 +23,20 @@ export interface ListQueueQuickConnectsCommandOutput extends ListQueueQuickConne /** *

This API is in preview release for Amazon Connect and is subject to change.

*

Lists the quick connects associated with a queue.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ConnectClient, ListQueueQuickConnectsCommand } from "@aws-sdk/client-connect"; // ES Modules import + * // const { ConnectClient, ListQueueQuickConnectsCommand } = require("@aws-sdk/client-connect"); // CommonJS import + * const client = new ConnectClient(config); + * const command = new ListQueueQuickConnectsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListQueueQuickConnectsCommandInput} for command's `input` shape. + * @see {@link ListQueueQuickConnectsCommandOutput} for command's `response` shape. + * @see {@link ConnectClientResolvedConfig | config} for command's `input` shape. + * */ export class ListQueueQuickConnectsCommand extends $Command< ListQueueQuickConnectsCommandInput, diff --git a/clients/client-connect/commands/ListQueuesCommand.ts b/clients/client-connect/commands/ListQueuesCommand.ts index 40fabaf0abdf..e6a1e4319fca 100644 --- a/clients/client-connect/commands/ListQueuesCommand.ts +++ b/clients/client-connect/commands/ListQueuesCommand.ts @@ -24,6 +24,20 @@ export interface ListQueuesCommandOutput extends ListQueuesResponse, __MetadataB *

Provides information about the queues for the specified Amazon Connect instance.

*

For more information about queues, see Queues: Standard and * Agent in the Amazon Connect Administrator Guide.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ConnectClient, ListQueuesCommand } from "@aws-sdk/client-connect"; // ES Modules import + * // const { ConnectClient, ListQueuesCommand } = require("@aws-sdk/client-connect"); // CommonJS import + * const client = new ConnectClient(config); + * const command = new ListQueuesCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListQueuesCommandInput} for command's `input` shape. + * @see {@link ListQueuesCommandOutput} for command's `response` shape. + * @see {@link ConnectClientResolvedConfig | config} for command's `input` shape. + * */ export class ListQueuesCommand extends $Command< ListQueuesCommandInput, diff --git a/clients/client-connect/commands/ListQuickConnectsCommand.ts b/clients/client-connect/commands/ListQuickConnectsCommand.ts index 5d19106a70da..68dca39cad91 100644 --- a/clients/client-connect/commands/ListQuickConnectsCommand.ts +++ b/clients/client-connect/commands/ListQuickConnectsCommand.ts @@ -23,6 +23,20 @@ export interface ListQuickConnectsCommandOutput extends ListQuickConnectsRespons /** *

This API is in preview release for Amazon Connect and is subject to change.

*

Provides information about the quick connects for the specified Amazon Connect instance.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ConnectClient, ListQuickConnectsCommand } from "@aws-sdk/client-connect"; // ES Modules import + * // const { ConnectClient, ListQuickConnectsCommand } = require("@aws-sdk/client-connect"); // CommonJS import + * const client = new ConnectClient(config); + * const command = new ListQuickConnectsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListQuickConnectsCommandInput} for command's `input` shape. + * @see {@link ListQuickConnectsCommandOutput} for command's `response` shape. + * @see {@link ConnectClientResolvedConfig | config} for command's `input` shape. + * */ export class ListQuickConnectsCommand extends $Command< ListQuickConnectsCommandInput, diff --git a/clients/client-connect/commands/ListRoutingProfileQueuesCommand.ts b/clients/client-connect/commands/ListRoutingProfileQueuesCommand.ts index 4ca311b1c360..00038f99495b 100644 --- a/clients/client-connect/commands/ListRoutingProfileQueuesCommand.ts +++ b/clients/client-connect/commands/ListRoutingProfileQueuesCommand.ts @@ -22,6 +22,20 @@ export interface ListRoutingProfileQueuesCommandOutput extends ListRoutingProfil /** *

Lists the queues associated with a routing profile.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ConnectClient, ListRoutingProfileQueuesCommand } from "@aws-sdk/client-connect"; // ES Modules import + * // const { ConnectClient, ListRoutingProfileQueuesCommand } = require("@aws-sdk/client-connect"); // CommonJS import + * const client = new ConnectClient(config); + * const command = new ListRoutingProfileQueuesCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListRoutingProfileQueuesCommandInput} for command's `input` shape. + * @see {@link ListRoutingProfileQueuesCommandOutput} for command's `response` shape. + * @see {@link ConnectClientResolvedConfig | config} for command's `input` shape. + * */ export class ListRoutingProfileQueuesCommand extends $Command< ListRoutingProfileQueuesCommandInput, diff --git a/clients/client-connect/commands/ListRoutingProfilesCommand.ts b/clients/client-connect/commands/ListRoutingProfilesCommand.ts index ff9336258443..cca6a855b984 100644 --- a/clients/client-connect/commands/ListRoutingProfilesCommand.ts +++ b/clients/client-connect/commands/ListRoutingProfilesCommand.ts @@ -25,6 +25,20 @@ export interface ListRoutingProfilesCommandOutput extends ListRoutingProfilesRes * instance.

*

For more information about routing profiles, see Routing Profiles and Create a Routing * Profile in the Amazon Connect Administrator Guide.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ConnectClient, ListRoutingProfilesCommand } from "@aws-sdk/client-connect"; // ES Modules import + * // const { ConnectClient, ListRoutingProfilesCommand } = require("@aws-sdk/client-connect"); // CommonJS import + * const client = new ConnectClient(config); + * const command = new ListRoutingProfilesCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListRoutingProfilesCommandInput} for command's `input` shape. + * @see {@link ListRoutingProfilesCommandOutput} for command's `response` shape. + * @see {@link ConnectClientResolvedConfig | config} for command's `input` shape. + * */ export class ListRoutingProfilesCommand extends $Command< ListRoutingProfilesCommandInput, diff --git a/clients/client-connect/commands/ListSecurityKeysCommand.ts b/clients/client-connect/commands/ListSecurityKeysCommand.ts index 2d46b3ad2fc4..b9e6c1fec390 100644 --- a/clients/client-connect/commands/ListSecurityKeysCommand.ts +++ b/clients/client-connect/commands/ListSecurityKeysCommand.ts @@ -23,6 +23,20 @@ export interface ListSecurityKeysCommandOutput extends ListSecurityKeysResponse, /** *

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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ConnectClient, ListSecurityKeysCommand } from "@aws-sdk/client-connect"; // ES Modules import + * // const { ConnectClient, ListSecurityKeysCommand } = require("@aws-sdk/client-connect"); // CommonJS import + * const client = new ConnectClient(config); + * const command = new ListSecurityKeysCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListSecurityKeysCommandInput} for command's `input` shape. + * @see {@link ListSecurityKeysCommandOutput} for command's `response` shape. + * @see {@link ConnectClientResolvedConfig | config} for command's `input` shape. + * */ export class ListSecurityKeysCommand extends $Command< ListSecurityKeysCommandInput, diff --git a/clients/client-connect/commands/ListSecurityProfilesCommand.ts b/clients/client-connect/commands/ListSecurityProfilesCommand.ts index 3d63395172b5..eb3d59e52ee9 100644 --- a/clients/client-connect/commands/ListSecurityProfilesCommand.ts +++ b/clients/client-connect/commands/ListSecurityProfilesCommand.ts @@ -25,6 +25,20 @@ export interface ListSecurityProfilesCommandOutput extends ListSecurityProfilesR * instance.

*

For more information about security profiles, see Security Profiles in the * Amazon Connect Administrator Guide.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ConnectClient, ListSecurityProfilesCommand } from "@aws-sdk/client-connect"; // ES Modules import + * // const { ConnectClient, ListSecurityProfilesCommand } = require("@aws-sdk/client-connect"); // CommonJS import + * const client = new ConnectClient(config); + * const command = new ListSecurityProfilesCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListSecurityProfilesCommandInput} for command's `input` shape. + * @see {@link ListSecurityProfilesCommandOutput} for command's `response` shape. + * @see {@link ConnectClientResolvedConfig | config} for command's `input` shape. + * */ export class ListSecurityProfilesCommand extends $Command< ListSecurityProfilesCommandInput, diff --git a/clients/client-connect/commands/ListTagsForResourceCommand.ts b/clients/client-connect/commands/ListTagsForResourceCommand.ts index 6abb85e0bd27..d43863b328f5 100644 --- a/clients/client-connect/commands/ListTagsForResourceCommand.ts +++ b/clients/client-connect/commands/ListTagsForResourceCommand.ts @@ -24,6 +24,20 @@ export interface ListTagsForResourceCommandOutput extends ListTagsForResourceRes *

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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ConnectClient, ListTagsForResourceCommand } from "@aws-sdk/client-connect"; // ES Modules import + * // const { ConnectClient, ListTagsForResourceCommand } = require("@aws-sdk/client-connect"); // CommonJS import + * const client = new ConnectClient(config); + * const command = new ListTagsForResourceCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListTagsForResourceCommandInput} for command's `input` shape. + * @see {@link ListTagsForResourceCommandOutput} for command's `response` shape. + * @see {@link ConnectClientResolvedConfig | config} for command's `input` shape. + * */ export class ListTagsForResourceCommand extends $Command< ListTagsForResourceCommandInput, diff --git a/clients/client-connect/commands/ListUseCasesCommand.ts b/clients/client-connect/commands/ListUseCasesCommand.ts index d620783ac58a..dafc84702226 100644 --- a/clients/client-connect/commands/ListUseCasesCommand.ts +++ b/clients/client-connect/commands/ListUseCasesCommand.ts @@ -23,6 +23,20 @@ export interface ListUseCasesCommandOutput extends ListUseCasesResponse, __Metad /** *

This API is in preview release for Amazon Connect and is subject to change.

*

Lists the use cases.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ConnectClient, ListUseCasesCommand } from "@aws-sdk/client-connect"; // ES Modules import + * // const { ConnectClient, ListUseCasesCommand } = require("@aws-sdk/client-connect"); // CommonJS import + * const client = new ConnectClient(config); + * const command = new ListUseCasesCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListUseCasesCommandInput} for command's `input` shape. + * @see {@link ListUseCasesCommandOutput} for command's `response` shape. + * @see {@link ConnectClientResolvedConfig | config} for command's `input` shape. + * */ export class ListUseCasesCommand extends $Command< ListUseCasesCommandInput, diff --git a/clients/client-connect/commands/ListUserHierarchyGroupsCommand.ts b/clients/client-connect/commands/ListUserHierarchyGroupsCommand.ts index 1dc890db43db..981f93e950da 100644 --- a/clients/client-connect/commands/ListUserHierarchyGroupsCommand.ts +++ b/clients/client-connect/commands/ListUserHierarchyGroupsCommand.ts @@ -25,6 +25,20 @@ export interface ListUserHierarchyGroupsCommandOutput extends ListUserHierarchyG * instance.

*

For more information about agent hierarchies, see Set Up Agent Hierarchies in the * Amazon Connect Administrator Guide.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ConnectClient, ListUserHierarchyGroupsCommand } from "@aws-sdk/client-connect"; // ES Modules import + * // const { ConnectClient, ListUserHierarchyGroupsCommand } = require("@aws-sdk/client-connect"); // CommonJS import + * const client = new ConnectClient(config); + * const command = new ListUserHierarchyGroupsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListUserHierarchyGroupsCommandInput} for command's `input` shape. + * @see {@link ListUserHierarchyGroupsCommandOutput} for command's `response` shape. + * @see {@link ConnectClientResolvedConfig | config} for command's `input` shape. + * */ export class ListUserHierarchyGroupsCommand extends $Command< ListUserHierarchyGroupsCommandInput, diff --git a/clients/client-connect/commands/ListUsersCommand.ts b/clients/client-connect/commands/ListUsersCommand.ts index e402e68a8921..ef648bc15289 100644 --- a/clients/client-connect/commands/ListUsersCommand.ts +++ b/clients/client-connect/commands/ListUsersCommand.ts @@ -22,6 +22,20 @@ export interface ListUsersCommandOutput extends ListUsersResponse, __MetadataBea /** *

Provides summary information about the users for the specified Amazon Connect instance.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ConnectClient, ListUsersCommand } from "@aws-sdk/client-connect"; // ES Modules import + * // const { ConnectClient, ListUsersCommand } = require("@aws-sdk/client-connect"); // CommonJS import + * const client = new ConnectClient(config); + * const command = new ListUsersCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListUsersCommandInput} for command's `input` shape. + * @see {@link ListUsersCommandOutput} for command's `response` shape. + * @see {@link ConnectClientResolvedConfig | config} for command's `input` shape. + * */ export class ListUsersCommand extends $Command< ListUsersCommandInput, diff --git a/clients/client-connect/commands/ResumeContactRecordingCommand.ts b/clients/client-connect/commands/ResumeContactRecordingCommand.ts index b2120b390c65..52dd36bd1344 100644 --- a/clients/client-connect/commands/ResumeContactRecordingCommand.ts +++ b/clients/client-connect/commands/ResumeContactRecordingCommand.ts @@ -25,6 +25,20 @@ export interface ResumeContactRecordingCommandOutput extends ResumeContactRecord * SuspendContactRecording, this API resumes recording the call.

* *

Only voice recordings are supported at this time.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ConnectClient, ResumeContactRecordingCommand } from "@aws-sdk/client-connect"; // ES Modules import + * // const { ConnectClient, ResumeContactRecordingCommand } = require("@aws-sdk/client-connect"); // CommonJS import + * const client = new ConnectClient(config); + * const command = new ResumeContactRecordingCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ResumeContactRecordingCommandInput} for command's `input` shape. + * @see {@link ResumeContactRecordingCommandOutput} for command's `response` shape. + * @see {@link ConnectClientResolvedConfig | config} for command's `input` shape. + * */ export class ResumeContactRecordingCommand extends $Command< ResumeContactRecordingCommandInput, diff --git a/clients/client-connect/commands/StartChatContactCommand.ts b/clients/client-connect/commands/StartChatContactCommand.ts index d16139e91e9e..8267ed1a24a0 100644 --- a/clients/client-connect/commands/StartChatContactCommand.ts +++ b/clients/client-connect/commands/StartChatContactCommand.ts @@ -42,6 +42,20 @@ export interface StartChatContactCommandOutput extends StartChatContactResponse, * *

For more information about chat, see Chat in the Amazon Connect Administrator * Guide.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ConnectClient, StartChatContactCommand } from "@aws-sdk/client-connect"; // ES Modules import + * // const { ConnectClient, StartChatContactCommand } = require("@aws-sdk/client-connect"); // CommonJS import + * const client = new ConnectClient(config); + * const command = new StartChatContactCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link StartChatContactCommandInput} for command's `input` shape. + * @see {@link StartChatContactCommandOutput} for command's `response` shape. + * @see {@link ConnectClientResolvedConfig | config} for command's `input` shape. + * */ export class StartChatContactCommand extends $Command< StartChatContactCommandInput, diff --git a/clients/client-connect/commands/StartContactRecordingCommand.ts b/clients/client-connect/commands/StartContactRecordingCommand.ts index 5d3b7e121c0c..c84b6380bd87 100644 --- a/clients/client-connect/commands/StartContactRecordingCommand.ts +++ b/clients/client-connect/commands/StartContactRecordingCommand.ts @@ -29,6 +29,20 @@ export interface StartContactRecordingCommandOutput extends StartContactRecordin *

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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ConnectClient, StartContactRecordingCommand } from "@aws-sdk/client-connect"; // ES Modules import + * // const { ConnectClient, StartContactRecordingCommand } = require("@aws-sdk/client-connect"); // CommonJS import + * const client = new ConnectClient(config); + * const command = new StartContactRecordingCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link StartContactRecordingCommandInput} for command's `input` shape. + * @see {@link StartContactRecordingCommandOutput} for command's `response` shape. + * @see {@link ConnectClientResolvedConfig | config} for command's `input` shape. + * */ export class StartContactRecordingCommand extends $Command< StartContactRecordingCommandInput, diff --git a/clients/client-connect/commands/StartOutboundVoiceContactCommand.ts b/clients/client-connect/commands/StartOutboundVoiceContactCommand.ts index b4614410e90d..494afb4bbb04 100644 --- a/clients/client-connect/commands/StartOutboundVoiceContactCommand.ts +++ b/clients/client-connect/commands/StartOutboundVoiceContactCommand.ts @@ -35,6 +35,20 @@ export interface StartOutboundVoiceContactCommandOutput extends StartOutboundVoi * mobile numbers, you must submit a service quota increase request. For more information, see * Amazon Connect Service Quotas in the Amazon Connect Administrator Guide.

* + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ConnectClient, StartOutboundVoiceContactCommand } from "@aws-sdk/client-connect"; // ES Modules import + * // const { ConnectClient, StartOutboundVoiceContactCommand } = require("@aws-sdk/client-connect"); // CommonJS import + * const client = new ConnectClient(config); + * const command = new StartOutboundVoiceContactCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link StartOutboundVoiceContactCommandInput} for command's `input` shape. + * @see {@link StartOutboundVoiceContactCommandOutput} for command's `response` shape. + * @see {@link ConnectClientResolvedConfig | config} for command's `input` shape. + * */ export class StartOutboundVoiceContactCommand extends $Command< StartOutboundVoiceContactCommandInput, diff --git a/clients/client-connect/commands/StartTaskContactCommand.ts b/clients/client-connect/commands/StartTaskContactCommand.ts index ca6d9912b431..197f289eccad 100644 --- a/clients/client-connect/commands/StartTaskContactCommand.ts +++ b/clients/client-connect/commands/StartTaskContactCommand.ts @@ -22,6 +22,20 @@ export interface StartTaskContactCommandOutput extends StartTaskContactResponse, /** *

Initiates a contact flow to start a new task.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ConnectClient, StartTaskContactCommand } from "@aws-sdk/client-connect"; // ES Modules import + * // const { ConnectClient, StartTaskContactCommand } = require("@aws-sdk/client-connect"); // CommonJS import + * const client = new ConnectClient(config); + * const command = new StartTaskContactCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link StartTaskContactCommandInput} for command's `input` shape. + * @see {@link StartTaskContactCommandOutput} for command's `response` shape. + * @see {@link ConnectClientResolvedConfig | config} for command's `input` shape. + * */ export class StartTaskContactCommand extends $Command< StartTaskContactCommandInput, diff --git a/clients/client-connect/commands/StopContactCommand.ts b/clients/client-connect/commands/StopContactCommand.ts index eb3e271a3ddf..5906181bc021 100644 --- a/clients/client-connect/commands/StopContactCommand.ts +++ b/clients/client-connect/commands/StopContactCommand.ts @@ -22,6 +22,20 @@ export interface StopContactCommandOutput extends StopContactResponse, __Metadat /** *

Ends the specified contact.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ConnectClient, StopContactCommand } from "@aws-sdk/client-connect"; // ES Modules import + * // const { ConnectClient, StopContactCommand } = require("@aws-sdk/client-connect"); // CommonJS import + * const client = new ConnectClient(config); + * const command = new StopContactCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link StopContactCommandInput} for command's `input` shape. + * @see {@link StopContactCommandOutput} for command's `response` shape. + * @see {@link ConnectClientResolvedConfig | config} for command's `input` shape. + * */ export class StopContactCommand extends $Command< StopContactCommandInput, diff --git a/clients/client-connect/commands/StopContactRecordingCommand.ts b/clients/client-connect/commands/StopContactRecordingCommand.ts index 089b42eea3ac..e0333628d641 100644 --- a/clients/client-connect/commands/StopContactRecordingCommand.ts +++ b/clients/client-connect/commands/StopContactRecordingCommand.ts @@ -28,6 +28,20 @@ export interface StopContactRecordingCommandOutput extends StopContactRecordingR * restart it, use SuspendContactRecording and ResumeContactRecording.

* *

Only voice recordings are supported at this time.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ConnectClient, StopContactRecordingCommand } from "@aws-sdk/client-connect"; // ES Modules import + * // const { ConnectClient, StopContactRecordingCommand } = require("@aws-sdk/client-connect"); // CommonJS import + * const client = new ConnectClient(config); + * const command = new StopContactRecordingCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link StopContactRecordingCommandInput} for command's `input` shape. + * @see {@link StopContactRecordingCommandOutput} for command's `response` shape. + * @see {@link ConnectClientResolvedConfig | config} for command's `input` shape. + * */ export class StopContactRecordingCommand extends $Command< StopContactRecordingCommandInput, diff --git a/clients/client-connect/commands/SuspendContactRecordingCommand.ts b/clients/client-connect/commands/SuspendContactRecordingCommand.ts index ff831f1b8c91..12373a98cd24 100644 --- a/clients/client-connect/commands/SuspendContactRecordingCommand.ts +++ b/clients/client-connect/commands/SuspendContactRecordingCommand.ts @@ -27,6 +27,20 @@ export interface SuspendContactRecordingCommandOutput extends SuspendContactReco *

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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ConnectClient, SuspendContactRecordingCommand } from "@aws-sdk/client-connect"; // ES Modules import + * // const { ConnectClient, SuspendContactRecordingCommand } = require("@aws-sdk/client-connect"); // CommonJS import + * const client = new ConnectClient(config); + * const command = new SuspendContactRecordingCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link SuspendContactRecordingCommandInput} for command's `input` shape. + * @see {@link SuspendContactRecordingCommandOutput} for command's `response` shape. + * @see {@link ConnectClientResolvedConfig | config} for command's `input` shape. + * */ export class SuspendContactRecordingCommand extends $Command< SuspendContactRecordingCommandInput, diff --git a/clients/client-connect/commands/TagResourceCommand.ts b/clients/client-connect/commands/TagResourceCommand.ts index 7c6fdd9440ea..f72a9e88688d 100644 --- a/clients/client-connect/commands/TagResourceCommand.ts +++ b/clients/client-connect/commands/TagResourceCommand.ts @@ -26,6 +26,20 @@ export interface TagResourceCommandOutput extends __MetadataBearer {} * flows.

*

For sample policies that use tags, see Amazon Connect Identity-Based * Policy Examples in the Amazon Connect Administrator Guide.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ConnectClient, TagResourceCommand } from "@aws-sdk/client-connect"; // ES Modules import + * // const { ConnectClient, TagResourceCommand } = require("@aws-sdk/client-connect"); // CommonJS import + * const client = new ConnectClient(config); + * const command = new TagResourceCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link TagResourceCommandInput} for command's `input` shape. + * @see {@link TagResourceCommandOutput} for command's `response` shape. + * @see {@link ConnectClientResolvedConfig | config} for command's `input` shape. + * */ export class TagResourceCommand extends $Command< TagResourceCommandInput, diff --git a/clients/client-connect/commands/UntagResourceCommand.ts b/clients/client-connect/commands/UntagResourceCommand.ts index 4e2346254bb5..d2278d285841 100644 --- a/clients/client-connect/commands/UntagResourceCommand.ts +++ b/clients/client-connect/commands/UntagResourceCommand.ts @@ -22,6 +22,20 @@ export interface UntagResourceCommandOutput extends __MetadataBearer {} /** *

Removes the specified tags from the specified resource.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ConnectClient, UntagResourceCommand } from "@aws-sdk/client-connect"; // ES Modules import + * // const { ConnectClient, UntagResourceCommand } = require("@aws-sdk/client-connect"); // CommonJS import + * const client = new ConnectClient(config); + * const command = new UntagResourceCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link UntagResourceCommandInput} for command's `input` shape. + * @see {@link UntagResourceCommandOutput} for command's `response` shape. + * @see {@link ConnectClientResolvedConfig | config} for command's `input` shape. + * */ export class UntagResourceCommand extends $Command< UntagResourceCommandInput, diff --git a/clients/client-connect/commands/UpdateContactAttributesCommand.ts b/clients/client-connect/commands/UpdateContactAttributesCommand.ts index ed9e54ccd1b5..7a6e6770a280 100644 --- a/clients/client-connect/commands/UpdateContactAttributesCommand.ts +++ b/clients/client-connect/commands/UpdateContactAttributesCommand.ts @@ -37,6 +37,20 @@ export interface UpdateContactAttributesCommandOutput extends UpdateContactAttri * you attempt to update attributes for a contact that occurred prior to the release of the API, a * 400 error is returned. This applies also to queued callbacks that were initiated prior to the * release of the API but are still active in your instance.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ConnectClient, UpdateContactAttributesCommand } from "@aws-sdk/client-connect"; // ES Modules import + * // const { ConnectClient, UpdateContactAttributesCommand } = require("@aws-sdk/client-connect"); // CommonJS import + * const client = new ConnectClient(config); + * const command = new UpdateContactAttributesCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link UpdateContactAttributesCommandInput} for command's `input` shape. + * @see {@link UpdateContactAttributesCommandOutput} for command's `response` shape. + * @see {@link ConnectClientResolvedConfig | config} for command's `input` shape. + * */ export class UpdateContactAttributesCommand extends $Command< UpdateContactAttributesCommandInput, diff --git a/clients/client-connect/commands/UpdateContactFlowContentCommand.ts b/clients/client-connect/commands/UpdateContactFlowContentCommand.ts index 1d5cbd5cbad5..7a016ed2e7e9 100644 --- a/clients/client-connect/commands/UpdateContactFlowContentCommand.ts +++ b/clients/client-connect/commands/UpdateContactFlowContentCommand.ts @@ -24,6 +24,20 @@ export interface UpdateContactFlowContentCommandOutput extends __MetadataBearer *

Updates the specified contact flow.

*

You can also create and update contact flows using the Amazon Connect * Flow language.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ConnectClient, UpdateContactFlowContentCommand } from "@aws-sdk/client-connect"; // ES Modules import + * // const { ConnectClient, UpdateContactFlowContentCommand } = require("@aws-sdk/client-connect"); // CommonJS import + * const client = new ConnectClient(config); + * const command = new UpdateContactFlowContentCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link UpdateContactFlowContentCommandInput} for command's `input` shape. + * @see {@link UpdateContactFlowContentCommandOutput} for command's `response` shape. + * @see {@link ConnectClientResolvedConfig | config} for command's `input` shape. + * */ export class UpdateContactFlowContentCommand extends $Command< UpdateContactFlowContentCommandInput, diff --git a/clients/client-connect/commands/UpdateContactFlowNameCommand.ts b/clients/client-connect/commands/UpdateContactFlowNameCommand.ts index 21d30ac16e9d..6a87b6fffb97 100644 --- a/clients/client-connect/commands/UpdateContactFlowNameCommand.ts +++ b/clients/client-connect/commands/UpdateContactFlowNameCommand.ts @@ -24,6 +24,20 @@ export interface UpdateContactFlowNameCommandOutput extends __MetadataBearer {} *

The name of the contact flow.

*

You can also create and update contact flows using the Amazon Connect * Flow language.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ConnectClient, UpdateContactFlowNameCommand } from "@aws-sdk/client-connect"; // ES Modules import + * // const { ConnectClient, UpdateContactFlowNameCommand } = require("@aws-sdk/client-connect"); // CommonJS import + * const client = new ConnectClient(config); + * const command = new UpdateContactFlowNameCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link UpdateContactFlowNameCommandInput} for command's `input` shape. + * @see {@link UpdateContactFlowNameCommandOutput} for command's `response` shape. + * @see {@link ConnectClientResolvedConfig | config} for command's `input` shape. + * */ export class UpdateContactFlowNameCommand extends $Command< UpdateContactFlowNameCommandInput, diff --git a/clients/client-connect/commands/UpdateInstanceAttributeCommand.ts b/clients/client-connect/commands/UpdateInstanceAttributeCommand.ts index 84dba316b749..a31e281a7730 100644 --- a/clients/client-connect/commands/UpdateInstanceAttributeCommand.ts +++ b/clients/client-connect/commands/UpdateInstanceAttributeCommand.ts @@ -23,6 +23,20 @@ export interface UpdateInstanceAttributeCommandOutput extends __MetadataBearer { /** *

This API is in preview release for Amazon Connect and is subject to change.

*

Updates the value for the specified attribute type.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ConnectClient, UpdateInstanceAttributeCommand } from "@aws-sdk/client-connect"; // ES Modules import + * // const { ConnectClient, UpdateInstanceAttributeCommand } = require("@aws-sdk/client-connect"); // CommonJS import + * const client = new ConnectClient(config); + * const command = new UpdateInstanceAttributeCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link UpdateInstanceAttributeCommandInput} for command's `input` shape. + * @see {@link UpdateInstanceAttributeCommandOutput} for command's `response` shape. + * @see {@link ConnectClientResolvedConfig | config} for command's `input` shape. + * */ export class UpdateInstanceAttributeCommand extends $Command< UpdateInstanceAttributeCommandInput, diff --git a/clients/client-connect/commands/UpdateInstanceStorageConfigCommand.ts b/clients/client-connect/commands/UpdateInstanceStorageConfigCommand.ts index cc6a477a62c9..fec5da5cc724 100644 --- a/clients/client-connect/commands/UpdateInstanceStorageConfigCommand.ts +++ b/clients/client-connect/commands/UpdateInstanceStorageConfigCommand.ts @@ -23,6 +23,20 @@ export interface UpdateInstanceStorageConfigCommandOutput extends __MetadataBear /** *

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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ConnectClient, UpdateInstanceStorageConfigCommand } from "@aws-sdk/client-connect"; // ES Modules import + * // const { ConnectClient, UpdateInstanceStorageConfigCommand } = require("@aws-sdk/client-connect"); // CommonJS import + * const client = new ConnectClient(config); + * const command = new UpdateInstanceStorageConfigCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link UpdateInstanceStorageConfigCommandInput} for command's `input` shape. + * @see {@link UpdateInstanceStorageConfigCommandOutput} for command's `response` shape. + * @see {@link ConnectClientResolvedConfig | config} for command's `input` shape. + * */ export class UpdateInstanceStorageConfigCommand extends $Command< UpdateInstanceStorageConfigCommandInput, diff --git a/clients/client-connect/commands/UpdateQueueHoursOfOperationCommand.ts b/clients/client-connect/commands/UpdateQueueHoursOfOperationCommand.ts index af78c6b2594a..72f6abd2a627 100644 --- a/clients/client-connect/commands/UpdateQueueHoursOfOperationCommand.ts +++ b/clients/client-connect/commands/UpdateQueueHoursOfOperationCommand.ts @@ -23,6 +23,20 @@ export interface UpdateQueueHoursOfOperationCommandOutput extends __MetadataBear /** *

This API is in preview release for Amazon Connect and is subject to change.

*

Updates the hours of operation for the specified queue.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ConnectClient, UpdateQueueHoursOfOperationCommand } from "@aws-sdk/client-connect"; // ES Modules import + * // const { ConnectClient, UpdateQueueHoursOfOperationCommand } = require("@aws-sdk/client-connect"); // CommonJS import + * const client = new ConnectClient(config); + * const command = new UpdateQueueHoursOfOperationCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link UpdateQueueHoursOfOperationCommandInput} for command's `input` shape. + * @see {@link UpdateQueueHoursOfOperationCommandOutput} for command's `response` shape. + * @see {@link ConnectClientResolvedConfig | config} for command's `input` shape. + * */ export class UpdateQueueHoursOfOperationCommand extends $Command< UpdateQueueHoursOfOperationCommandInput, diff --git a/clients/client-connect/commands/UpdateQueueMaxContactsCommand.ts b/clients/client-connect/commands/UpdateQueueMaxContactsCommand.ts index 8ba53e93ec7c..a6fff7e6da3d 100644 --- a/clients/client-connect/commands/UpdateQueueMaxContactsCommand.ts +++ b/clients/client-connect/commands/UpdateQueueMaxContactsCommand.ts @@ -24,6 +24,20 @@ export interface UpdateQueueMaxContactsCommandOutput extends __MetadataBearer {} *

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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ConnectClient, UpdateQueueMaxContactsCommand } from "@aws-sdk/client-connect"; // ES Modules import + * // const { ConnectClient, UpdateQueueMaxContactsCommand } = require("@aws-sdk/client-connect"); // CommonJS import + * const client = new ConnectClient(config); + * const command = new UpdateQueueMaxContactsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link UpdateQueueMaxContactsCommandInput} for command's `input` shape. + * @see {@link UpdateQueueMaxContactsCommandOutput} for command's `response` shape. + * @see {@link ConnectClientResolvedConfig | config} for command's `input` shape. + * */ export class UpdateQueueMaxContactsCommand extends $Command< UpdateQueueMaxContactsCommandInput, diff --git a/clients/client-connect/commands/UpdateQueueNameCommand.ts b/clients/client-connect/commands/UpdateQueueNameCommand.ts index 6f996b872ca3..c2b8b49ed319 100644 --- a/clients/client-connect/commands/UpdateQueueNameCommand.ts +++ b/clients/client-connect/commands/UpdateQueueNameCommand.ts @@ -23,6 +23,20 @@ export interface UpdateQueueNameCommandOutput extends __MetadataBearer {} /** *

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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ConnectClient, UpdateQueueNameCommand } from "@aws-sdk/client-connect"; // ES Modules import + * // const { ConnectClient, UpdateQueueNameCommand } = require("@aws-sdk/client-connect"); // CommonJS import + * const client = new ConnectClient(config); + * const command = new UpdateQueueNameCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link UpdateQueueNameCommandInput} for command's `input` shape. + * @see {@link UpdateQueueNameCommandOutput} for command's `response` shape. + * @see {@link ConnectClientResolvedConfig | config} for command's `input` shape. + * */ export class UpdateQueueNameCommand extends $Command< UpdateQueueNameCommandInput, diff --git a/clients/client-connect/commands/UpdateQueueOutboundCallerConfigCommand.ts b/clients/client-connect/commands/UpdateQueueOutboundCallerConfigCommand.ts index 2830e261930c..115fa17f97b6 100644 --- a/clients/client-connect/commands/UpdateQueueOutboundCallerConfigCommand.ts +++ b/clients/client-connect/commands/UpdateQueueOutboundCallerConfigCommand.ts @@ -24,6 +24,20 @@ export interface UpdateQueueOutboundCallerConfigCommandOutput extends __Metadata *

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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ConnectClient, UpdateQueueOutboundCallerConfigCommand } from "@aws-sdk/client-connect"; // ES Modules import + * // const { ConnectClient, UpdateQueueOutboundCallerConfigCommand } = require("@aws-sdk/client-connect"); // CommonJS import + * const client = new ConnectClient(config); + * const command = new UpdateQueueOutboundCallerConfigCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link UpdateQueueOutboundCallerConfigCommandInput} for command's `input` shape. + * @see {@link UpdateQueueOutboundCallerConfigCommandOutput} for command's `response` shape. + * @see {@link ConnectClientResolvedConfig | config} for command's `input` shape. + * */ export class UpdateQueueOutboundCallerConfigCommand extends $Command< UpdateQueueOutboundCallerConfigCommandInput, diff --git a/clients/client-connect/commands/UpdateQueueStatusCommand.ts b/clients/client-connect/commands/UpdateQueueStatusCommand.ts index 7fbfb984c307..f21d791adb19 100644 --- a/clients/client-connect/commands/UpdateQueueStatusCommand.ts +++ b/clients/client-connect/commands/UpdateQueueStatusCommand.ts @@ -23,6 +23,20 @@ export interface UpdateQueueStatusCommandOutput extends __MetadataBearer {} /** *

This API is in preview release for Amazon Connect and is subject to change.

*

Updates the status of the queue.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ConnectClient, UpdateQueueStatusCommand } from "@aws-sdk/client-connect"; // ES Modules import + * // const { ConnectClient, UpdateQueueStatusCommand } = require("@aws-sdk/client-connect"); // CommonJS import + * const client = new ConnectClient(config); + * const command = new UpdateQueueStatusCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link UpdateQueueStatusCommandInput} for command's `input` shape. + * @see {@link UpdateQueueStatusCommandOutput} for command's `response` shape. + * @see {@link ConnectClientResolvedConfig | config} for command's `input` shape. + * */ export class UpdateQueueStatusCommand extends $Command< UpdateQueueStatusCommandInput, diff --git a/clients/client-connect/commands/UpdateQuickConnectConfigCommand.ts b/clients/client-connect/commands/UpdateQuickConnectConfigCommand.ts index e0cbc0a2ca5b..bbea07986518 100644 --- a/clients/client-connect/commands/UpdateQuickConnectConfigCommand.ts +++ b/clients/client-connect/commands/UpdateQuickConnectConfigCommand.ts @@ -23,6 +23,20 @@ export interface UpdateQuickConnectConfigCommandOutput extends __MetadataBearer /** *

This API is in preview release for Amazon Connect and is subject to change.

*

Updates the configuration settings for the specified quick connect.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ConnectClient, UpdateQuickConnectConfigCommand } from "@aws-sdk/client-connect"; // ES Modules import + * // const { ConnectClient, UpdateQuickConnectConfigCommand } = require("@aws-sdk/client-connect"); // CommonJS import + * const client = new ConnectClient(config); + * const command = new UpdateQuickConnectConfigCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link UpdateQuickConnectConfigCommandInput} for command's `input` shape. + * @see {@link UpdateQuickConnectConfigCommandOutput} for command's `response` shape. + * @see {@link ConnectClientResolvedConfig | config} for command's `input` shape. + * */ export class UpdateQuickConnectConfigCommand extends $Command< UpdateQuickConnectConfigCommandInput, diff --git a/clients/client-connect/commands/UpdateQuickConnectNameCommand.ts b/clients/client-connect/commands/UpdateQuickConnectNameCommand.ts index b91f0ca63a4e..40aae3e553ee 100644 --- a/clients/client-connect/commands/UpdateQuickConnectNameCommand.ts +++ b/clients/client-connect/commands/UpdateQuickConnectNameCommand.ts @@ -23,6 +23,20 @@ export interface UpdateQuickConnectNameCommandOutput extends __MetadataBearer {} /** *

This API is in preview release for Amazon Connect and is subject to change.

*

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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ConnectClient, UpdateQuickConnectNameCommand } from "@aws-sdk/client-connect"; // ES Modules import + * // const { ConnectClient, UpdateQuickConnectNameCommand } = require("@aws-sdk/client-connect"); // CommonJS import + * const client = new ConnectClient(config); + * const command = new UpdateQuickConnectNameCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link UpdateQuickConnectNameCommandInput} for command's `input` shape. + * @see {@link UpdateQuickConnectNameCommandOutput} for command's `response` shape. + * @see {@link ConnectClientResolvedConfig | config} for command's `input` shape. + * */ export class UpdateQuickConnectNameCommand extends $Command< UpdateQuickConnectNameCommandInput, diff --git a/clients/client-connect/commands/UpdateRoutingProfileConcurrencyCommand.ts b/clients/client-connect/commands/UpdateRoutingProfileConcurrencyCommand.ts index ad56b91196ec..7d3c71ada7d3 100644 --- a/clients/client-connect/commands/UpdateRoutingProfileConcurrencyCommand.ts +++ b/clients/client-connect/commands/UpdateRoutingProfileConcurrencyCommand.ts @@ -23,6 +23,20 @@ export interface UpdateRoutingProfileConcurrencyCommandOutput extends __Metadata /** *

Updates the channels that agents can handle in the Contact Control Panel (CCP) for a routing * profile.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ConnectClient, UpdateRoutingProfileConcurrencyCommand } from "@aws-sdk/client-connect"; // ES Modules import + * // const { ConnectClient, UpdateRoutingProfileConcurrencyCommand } = require("@aws-sdk/client-connect"); // CommonJS import + * const client = new ConnectClient(config); + * const command = new UpdateRoutingProfileConcurrencyCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link UpdateRoutingProfileConcurrencyCommandInput} for command's `input` shape. + * @see {@link UpdateRoutingProfileConcurrencyCommandOutput} for command's `response` shape. + * @see {@link ConnectClientResolvedConfig | config} for command's `input` shape. + * */ export class UpdateRoutingProfileConcurrencyCommand extends $Command< UpdateRoutingProfileConcurrencyCommandInput, diff --git a/clients/client-connect/commands/UpdateRoutingProfileDefaultOutboundQueueCommand.ts b/clients/client-connect/commands/UpdateRoutingProfileDefaultOutboundQueueCommand.ts index 8a9818b00843..f6b067c73cbe 100644 --- a/clients/client-connect/commands/UpdateRoutingProfileDefaultOutboundQueueCommand.ts +++ b/clients/client-connect/commands/UpdateRoutingProfileDefaultOutboundQueueCommand.ts @@ -23,6 +23,20 @@ export interface UpdateRoutingProfileDefaultOutboundQueueCommandOutput extends _ /** *

Updates the default outbound queue of a routing profile.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ConnectClient, UpdateRoutingProfileDefaultOutboundQueueCommand } from "@aws-sdk/client-connect"; // ES Modules import + * // const { ConnectClient, UpdateRoutingProfileDefaultOutboundQueueCommand } = require("@aws-sdk/client-connect"); // CommonJS import + * const client = new ConnectClient(config); + * const command = new UpdateRoutingProfileDefaultOutboundQueueCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link UpdateRoutingProfileDefaultOutboundQueueCommandInput} for command's `input` shape. + * @see {@link UpdateRoutingProfileDefaultOutboundQueueCommandOutput} for command's `response` shape. + * @see {@link ConnectClientResolvedConfig | config} for command's `input` shape. + * */ export class UpdateRoutingProfileDefaultOutboundQueueCommand extends $Command< UpdateRoutingProfileDefaultOutboundQueueCommandInput, diff --git a/clients/client-connect/commands/UpdateRoutingProfileNameCommand.ts b/clients/client-connect/commands/UpdateRoutingProfileNameCommand.ts index f1bbddd576bf..05ca762358cb 100644 --- a/clients/client-connect/commands/UpdateRoutingProfileNameCommand.ts +++ b/clients/client-connect/commands/UpdateRoutingProfileNameCommand.ts @@ -22,6 +22,20 @@ export interface UpdateRoutingProfileNameCommandOutput extends __MetadataBearer /** *

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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ConnectClient, UpdateRoutingProfileNameCommand } from "@aws-sdk/client-connect"; // ES Modules import + * // const { ConnectClient, UpdateRoutingProfileNameCommand } = require("@aws-sdk/client-connect"); // CommonJS import + * const client = new ConnectClient(config); + * const command = new UpdateRoutingProfileNameCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link UpdateRoutingProfileNameCommandInput} for command's `input` shape. + * @see {@link UpdateRoutingProfileNameCommandOutput} for command's `response` shape. + * @see {@link ConnectClientResolvedConfig | config} for command's `input` shape. + * */ export class UpdateRoutingProfileNameCommand extends $Command< UpdateRoutingProfileNameCommandInput, diff --git a/clients/client-connect/commands/UpdateRoutingProfileQueuesCommand.ts b/clients/client-connect/commands/UpdateRoutingProfileQueuesCommand.ts index 9152e7f6dba5..5a10c6e4610d 100644 --- a/clients/client-connect/commands/UpdateRoutingProfileQueuesCommand.ts +++ b/clients/client-connect/commands/UpdateRoutingProfileQueuesCommand.ts @@ -22,6 +22,20 @@ export interface UpdateRoutingProfileQueuesCommandOutput extends __MetadataBeare /** *

Updates the properties associated with a set of queues for a routing profile.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ConnectClient, UpdateRoutingProfileQueuesCommand } from "@aws-sdk/client-connect"; // ES Modules import + * // const { ConnectClient, UpdateRoutingProfileQueuesCommand } = require("@aws-sdk/client-connect"); // CommonJS import + * const client = new ConnectClient(config); + * const command = new UpdateRoutingProfileQueuesCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link UpdateRoutingProfileQueuesCommandInput} for command's `input` shape. + * @see {@link UpdateRoutingProfileQueuesCommandOutput} for command's `response` shape. + * @see {@link ConnectClientResolvedConfig | config} for command's `input` shape. + * */ export class UpdateRoutingProfileQueuesCommand extends $Command< UpdateRoutingProfileQueuesCommandInput, diff --git a/clients/client-connect/commands/UpdateUserHierarchyCommand.ts b/clients/client-connect/commands/UpdateUserHierarchyCommand.ts index de2908a7c7b6..f89c9f8d4391 100644 --- a/clients/client-connect/commands/UpdateUserHierarchyCommand.ts +++ b/clients/client-connect/commands/UpdateUserHierarchyCommand.ts @@ -22,6 +22,20 @@ export interface UpdateUserHierarchyCommandOutput extends __MetadataBearer {} /** *

Assigns the specified hierarchy group to the specified user.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ConnectClient, UpdateUserHierarchyCommand } from "@aws-sdk/client-connect"; // ES Modules import + * // const { ConnectClient, UpdateUserHierarchyCommand } = require("@aws-sdk/client-connect"); // CommonJS import + * const client = new ConnectClient(config); + * const command = new UpdateUserHierarchyCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link UpdateUserHierarchyCommandInput} for command's `input` shape. + * @see {@link UpdateUserHierarchyCommandOutput} for command's `response` shape. + * @see {@link ConnectClientResolvedConfig | config} for command's `input` shape. + * */ export class UpdateUserHierarchyCommand extends $Command< UpdateUserHierarchyCommandInput, diff --git a/clients/client-connect/commands/UpdateUserHierarchyGroupNameCommand.ts b/clients/client-connect/commands/UpdateUserHierarchyGroupNameCommand.ts index 54888c2b0a86..0c04aa5c024c 100644 --- a/clients/client-connect/commands/UpdateUserHierarchyGroupNameCommand.ts +++ b/clients/client-connect/commands/UpdateUserHierarchyGroupNameCommand.ts @@ -22,6 +22,20 @@ export interface UpdateUserHierarchyGroupNameCommandOutput extends __MetadataBea /** *

Updates the name of the user hierarchy group.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ConnectClient, UpdateUserHierarchyGroupNameCommand } from "@aws-sdk/client-connect"; // ES Modules import + * // const { ConnectClient, UpdateUserHierarchyGroupNameCommand } = require("@aws-sdk/client-connect"); // CommonJS import + * const client = new ConnectClient(config); + * const command = new UpdateUserHierarchyGroupNameCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link UpdateUserHierarchyGroupNameCommandInput} for command's `input` shape. + * @see {@link UpdateUserHierarchyGroupNameCommandOutput} for command's `response` shape. + * @see {@link ConnectClientResolvedConfig | config} for command's `input` shape. + * */ export class UpdateUserHierarchyGroupNameCommand extends $Command< UpdateUserHierarchyGroupNameCommandInput, diff --git a/clients/client-connect/commands/UpdateUserHierarchyStructureCommand.ts b/clients/client-connect/commands/UpdateUserHierarchyStructureCommand.ts index 432fee555a27..b89fd933281e 100644 --- a/clients/client-connect/commands/UpdateUserHierarchyStructureCommand.ts +++ b/clients/client-connect/commands/UpdateUserHierarchyStructureCommand.ts @@ -22,6 +22,20 @@ export interface UpdateUserHierarchyStructureCommandOutput extends __MetadataBea /** *

Updates the user hierarchy structure: add, remove, and rename user hierarchy levels.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ConnectClient, UpdateUserHierarchyStructureCommand } from "@aws-sdk/client-connect"; // ES Modules import + * // const { ConnectClient, UpdateUserHierarchyStructureCommand } = require("@aws-sdk/client-connect"); // CommonJS import + * const client = new ConnectClient(config); + * const command = new UpdateUserHierarchyStructureCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link UpdateUserHierarchyStructureCommandInput} for command's `input` shape. + * @see {@link UpdateUserHierarchyStructureCommandOutput} for command's `response` shape. + * @see {@link ConnectClientResolvedConfig | config} for command's `input` shape. + * */ export class UpdateUserHierarchyStructureCommand extends $Command< UpdateUserHierarchyStructureCommandInput, diff --git a/clients/client-connect/commands/UpdateUserIdentityInfoCommand.ts b/clients/client-connect/commands/UpdateUserIdentityInfoCommand.ts index 21c89bdc5e3c..b4505a3fd152 100644 --- a/clients/client-connect/commands/UpdateUserIdentityInfoCommand.ts +++ b/clients/client-connect/commands/UpdateUserIdentityInfoCommand.ts @@ -30,6 +30,20 @@ export interface UpdateUserIdentityInfoCommandOutput extends __MetadataBearer {} * password through email. For more information, see Best Practices for * Security Profiles in the Amazon Connect Administrator Guide.

* + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ConnectClient, UpdateUserIdentityInfoCommand } from "@aws-sdk/client-connect"; // ES Modules import + * // const { ConnectClient, UpdateUserIdentityInfoCommand } = require("@aws-sdk/client-connect"); // CommonJS import + * const client = new ConnectClient(config); + * const command = new UpdateUserIdentityInfoCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link UpdateUserIdentityInfoCommandInput} for command's `input` shape. + * @see {@link UpdateUserIdentityInfoCommandOutput} for command's `response` shape. + * @see {@link ConnectClientResolvedConfig | config} for command's `input` shape. + * */ export class UpdateUserIdentityInfoCommand extends $Command< UpdateUserIdentityInfoCommandInput, diff --git a/clients/client-connect/commands/UpdateUserPhoneConfigCommand.ts b/clients/client-connect/commands/UpdateUserPhoneConfigCommand.ts index b97dd3973fb6..275df4bc194a 100644 --- a/clients/client-connect/commands/UpdateUserPhoneConfigCommand.ts +++ b/clients/client-connect/commands/UpdateUserPhoneConfigCommand.ts @@ -22,6 +22,20 @@ export interface UpdateUserPhoneConfigCommandOutput extends __MetadataBearer {} /** *

Updates the phone configuration settings for the specified user.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ConnectClient, UpdateUserPhoneConfigCommand } from "@aws-sdk/client-connect"; // ES Modules import + * // const { ConnectClient, UpdateUserPhoneConfigCommand } = require("@aws-sdk/client-connect"); // CommonJS import + * const client = new ConnectClient(config); + * const command = new UpdateUserPhoneConfigCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link UpdateUserPhoneConfigCommandInput} for command's `input` shape. + * @see {@link UpdateUserPhoneConfigCommandOutput} for command's `response` shape. + * @see {@link ConnectClientResolvedConfig | config} for command's `input` shape. + * */ export class UpdateUserPhoneConfigCommand extends $Command< UpdateUserPhoneConfigCommandInput, diff --git a/clients/client-connect/commands/UpdateUserRoutingProfileCommand.ts b/clients/client-connect/commands/UpdateUserRoutingProfileCommand.ts index 5b707b2dfb9a..8f193051bbf3 100644 --- a/clients/client-connect/commands/UpdateUserRoutingProfileCommand.ts +++ b/clients/client-connect/commands/UpdateUserRoutingProfileCommand.ts @@ -22,6 +22,20 @@ export interface UpdateUserRoutingProfileCommandOutput extends __MetadataBearer /** *

Assigns the specified routing profile to the specified user.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ConnectClient, UpdateUserRoutingProfileCommand } from "@aws-sdk/client-connect"; // ES Modules import + * // const { ConnectClient, UpdateUserRoutingProfileCommand } = require("@aws-sdk/client-connect"); // CommonJS import + * const client = new ConnectClient(config); + * const command = new UpdateUserRoutingProfileCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link UpdateUserRoutingProfileCommandInput} for command's `input` shape. + * @see {@link UpdateUserRoutingProfileCommandOutput} for command's `response` shape. + * @see {@link ConnectClientResolvedConfig | config} for command's `input` shape. + * */ export class UpdateUserRoutingProfileCommand extends $Command< UpdateUserRoutingProfileCommandInput, diff --git a/clients/client-connect/commands/UpdateUserSecurityProfilesCommand.ts b/clients/client-connect/commands/UpdateUserSecurityProfilesCommand.ts index 07f25f660c2a..414c96e91ade 100644 --- a/clients/client-connect/commands/UpdateUserSecurityProfilesCommand.ts +++ b/clients/client-connect/commands/UpdateUserSecurityProfilesCommand.ts @@ -22,6 +22,20 @@ export interface UpdateUserSecurityProfilesCommandOutput extends __MetadataBeare /** *

Assigns the specified security profiles to the specified user.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ConnectClient, UpdateUserSecurityProfilesCommand } from "@aws-sdk/client-connect"; // ES Modules import + * // const { ConnectClient, UpdateUserSecurityProfilesCommand } = require("@aws-sdk/client-connect"); // CommonJS import + * const client = new ConnectClient(config); + * const command = new UpdateUserSecurityProfilesCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link UpdateUserSecurityProfilesCommandInput} for command's `input` shape. + * @see {@link UpdateUserSecurityProfilesCommandOutput} for command's `response` shape. + * @see {@link ConnectClientResolvedConfig | config} for command's `input` shape. + * */ export class UpdateUserSecurityProfilesCommand extends $Command< UpdateUserSecurityProfilesCommandInput, diff --git a/clients/client-connect/models/models_0.ts b/clients/client-connect/models/models_0.ts index 7fb655edeb9d..27ef44fa187c 100644 --- a/clients/client-connect/models/models_0.ts +++ b/clients/client-connect/models/models_0.ts @@ -14,6 +14,9 @@ export interface AssociateApprovedOriginRequest { } export namespace AssociateApprovedOriginRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: AssociateApprovedOriginRequest): any => ({ ...obj, }); @@ -32,6 +35,9 @@ export interface InternalServiceException extends __SmithyException, $MetadataBe } export namespace InternalServiceException { + /** + * @internal + */ export const filterSensitiveLog = (obj: InternalServiceException): any => ({ ...obj, }); @@ -50,6 +56,9 @@ export interface InvalidParameterException extends __SmithyException, $MetadataB } export namespace InvalidParameterException { + /** + * @internal + */ export const filterSensitiveLog = (obj: InvalidParameterException): any => ({ ...obj, }); @@ -68,6 +77,9 @@ export interface InvalidRequestException extends __SmithyException, $MetadataBea } export namespace InvalidRequestException { + /** + * @internal + */ export const filterSensitiveLog = (obj: InvalidRequestException): any => ({ ...obj, }); @@ -83,6 +95,9 @@ export interface ResourceConflictException extends __SmithyException, $MetadataB } export namespace ResourceConflictException { + /** + * @internal + */ export const filterSensitiveLog = (obj: ResourceConflictException): any => ({ ...obj, }); @@ -101,6 +116,9 @@ export interface ResourceNotFoundException extends __SmithyException, $MetadataB } export namespace ResourceNotFoundException { + /** + * @internal + */ export const filterSensitiveLog = (obj: ResourceNotFoundException): any => ({ ...obj, }); @@ -116,6 +134,9 @@ export interface ServiceQuotaExceededException extends __SmithyException, $Metad } export namespace ServiceQuotaExceededException { + /** + * @internal + */ export const filterSensitiveLog = (obj: ServiceQuotaExceededException): any => ({ ...obj, }); @@ -131,6 +152,9 @@ export interface ThrottlingException extends __SmithyException, $MetadataBearer } export namespace ThrottlingException { + /** + * @internal + */ export const filterSensitiveLog = (obj: ThrottlingException): any => ({ ...obj, }); @@ -156,6 +180,9 @@ export interface KinesisFirehoseConfig { } export namespace KinesisFirehoseConfig { + /** + * @internal + */ export const filterSensitiveLog = (obj: KinesisFirehoseConfig): any => ({ ...obj, }); @@ -172,6 +199,9 @@ export interface KinesisStreamConfig { } export namespace KinesisStreamConfig { + /** + * @internal + */ export const filterSensitiveLog = (obj: KinesisStreamConfig): any => ({ ...obj, }); @@ -197,6 +227,9 @@ export interface EncryptionConfig { } export namespace EncryptionConfig { + /** + * @internal + */ export const filterSensitiveLog = (obj: EncryptionConfig): any => ({ ...obj, }); @@ -225,6 +258,9 @@ export interface KinesisVideoStreamConfig { } export namespace KinesisVideoStreamConfig { + /** + * @internal + */ export const filterSensitiveLog = (obj: KinesisVideoStreamConfig): any => ({ ...obj, }); @@ -251,6 +287,9 @@ export interface S3Config { } export namespace S3Config { + /** + * @internal + */ export const filterSensitiveLog = (obj: S3Config): any => ({ ...obj, }); @@ -300,6 +339,9 @@ export interface InstanceStorageConfig { } export namespace InstanceStorageConfig { + /** + * @internal + */ export const filterSensitiveLog = (obj: InstanceStorageConfig): any => ({ ...obj, }); @@ -323,6 +365,9 @@ export interface AssociateInstanceStorageConfigRequest { } export namespace AssociateInstanceStorageConfigRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: AssociateInstanceStorageConfigRequest): any => ({ ...obj, }); @@ -336,6 +381,9 @@ export interface AssociateInstanceStorageConfigResponse { } export namespace AssociateInstanceStorageConfigResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: AssociateInstanceStorageConfigResponse): any => ({ ...obj, }); @@ -355,6 +403,9 @@ export interface AssociateLambdaFunctionRequest { } export namespace AssociateLambdaFunctionRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: AssociateLambdaFunctionRequest): any => ({ ...obj, }); @@ -376,6 +427,9 @@ export interface LexBot { } export namespace LexBot { + /** + * @internal + */ export const filterSensitiveLog = (obj: LexBot): any => ({ ...obj, }); @@ -394,6 +448,9 @@ export interface AssociateLexBotRequest { } export namespace AssociateLexBotRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: AssociateLexBotRequest): any => ({ ...obj, }); @@ -417,6 +474,9 @@ export interface AssociateQueueQuickConnectsRequest { } export namespace AssociateQueueQuickConnectsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: AssociateQueueQuickConnectsRequest): any => ({ ...obj, }); @@ -435,6 +495,9 @@ export interface LimitExceededException extends __SmithyException, $MetadataBear } export namespace LimitExceededException { + /** + * @internal + */ export const filterSensitiveLog = (obj: LimitExceededException): any => ({ ...obj, }); @@ -463,6 +526,9 @@ export interface RoutingProfileQueueReference { } export namespace RoutingProfileQueueReference { + /** + * @internal + */ export const filterSensitiveLog = (obj: RoutingProfileQueueReference): any => ({ ...obj, }); @@ -494,6 +560,9 @@ export interface RoutingProfileQueueConfig { } export namespace RoutingProfileQueueConfig { + /** + * @internal + */ export const filterSensitiveLog = (obj: RoutingProfileQueueConfig): any => ({ ...obj, }); @@ -517,6 +586,9 @@ export interface AssociateRoutingProfileQueuesRequest { } export namespace AssociateRoutingProfileQueuesRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: AssociateRoutingProfileQueuesRequest): any => ({ ...obj, }); @@ -535,6 +607,9 @@ export interface AssociateSecurityKeyRequest { } export namespace AssociateSecurityKeyRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: AssociateSecurityKeyRequest): any => ({ ...obj, }); @@ -548,6 +623,9 @@ export interface AssociateSecurityKeyResponse { } export namespace AssociateSecurityKeyResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: AssociateSecurityKeyResponse): any => ({ ...obj, }); @@ -599,6 +677,9 @@ export interface CreateContactFlowRequest { } export namespace CreateContactFlowRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateContactFlowRequest): any => ({ ...obj, }); @@ -617,6 +698,9 @@ export interface CreateContactFlowResponse { } export namespace CreateContactFlowResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateContactFlowResponse): any => ({ ...obj, }); @@ -632,6 +716,9 @@ export interface DuplicateResourceException extends __SmithyException, $Metadata } export namespace DuplicateResourceException { + /** + * @internal + */ export const filterSensitiveLog = (obj: DuplicateResourceException): any => ({ ...obj, }); @@ -648,6 +735,9 @@ export interface ProblemDetail { } export namespace ProblemDetail { + /** + * @internal + */ export const filterSensitiveLog = (obj: ProblemDetail): any => ({ ...obj, }); @@ -666,6 +756,9 @@ export interface InvalidContactFlowException extends __SmithyException, $Metadat } export namespace InvalidContactFlowException { + /** + * @internal + */ export const filterSensitiveLog = (obj: InvalidContactFlowException): any => ({ ...obj, }); @@ -710,6 +803,9 @@ export interface CreateInstanceRequest { } export namespace CreateInstanceRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateInstanceRequest): any => ({ ...obj, ...(obj.InstanceAlias && { InstanceAlias: SENSITIVE_STRING }), @@ -729,6 +825,9 @@ export interface CreateInstanceResponse { } export namespace CreateInstanceResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateInstanceResponse): any => ({ ...obj, }); @@ -776,6 +875,9 @@ export interface CreateIntegrationAssociationRequest { } export namespace CreateIntegrationAssociationRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateIntegrationAssociationRequest): any => ({ ...obj, }); @@ -794,6 +896,9 @@ export interface CreateIntegrationAssociationResponse { } export namespace CreateIntegrationAssociationResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateIntegrationAssociationResponse): any => ({ ...obj, }); @@ -820,6 +925,9 @@ export interface OutboundCallerConfig { } export namespace OutboundCallerConfig { + /** + * @internal + */ export const filterSensitiveLog = (obj: OutboundCallerConfig): any => ({ ...obj, }); @@ -868,6 +976,9 @@ export interface CreateQueueRequest { } export namespace CreateQueueRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateQueueRequest): any => ({ ...obj, }); @@ -886,6 +997,9 @@ export interface CreateQueueResponse { } export namespace CreateQueueResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateQueueResponse): any => ({ ...obj, }); @@ -902,6 +1016,9 @@ export interface PhoneNumberQuickConnectConfig { } export namespace PhoneNumberQuickConnectConfig { + /** + * @internal + */ export const filterSensitiveLog = (obj: PhoneNumberQuickConnectConfig): any => ({ ...obj, }); @@ -924,6 +1041,9 @@ export interface QueueQuickConnectConfig { } export namespace QueueQuickConnectConfig { + /** + * @internal + */ export const filterSensitiveLog = (obj: QueueQuickConnectConfig): any => ({ ...obj, }); @@ -952,6 +1072,9 @@ export interface UserQuickConnectConfig { } export namespace UserQuickConnectConfig { + /** + * @internal + */ export const filterSensitiveLog = (obj: UserQuickConnectConfig): any => ({ ...obj, }); @@ -984,6 +1107,9 @@ export interface QuickConnectConfig { } export namespace QuickConnectConfig { + /** + * @internal + */ export const filterSensitiveLog = (obj: QuickConnectConfig): any => ({ ...obj, }); @@ -1017,6 +1143,9 @@ export interface CreateQuickConnectRequest { } export namespace CreateQuickConnectRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateQuickConnectRequest): any => ({ ...obj, }); @@ -1035,6 +1164,9 @@ export interface CreateQuickConnectResponse { } export namespace CreateQuickConnectResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateQuickConnectResponse): any => ({ ...obj, }); @@ -1057,6 +1189,9 @@ export interface MediaConcurrency { } export namespace MediaConcurrency { + /** + * @internal + */ export const filterSensitiveLog = (obj: MediaConcurrency): any => ({ ...obj, }); @@ -1102,6 +1237,9 @@ export interface CreateRoutingProfileRequest { } export namespace CreateRoutingProfileRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateRoutingProfileRequest): any => ({ ...obj, }); @@ -1120,6 +1258,9 @@ export interface CreateRoutingProfileResponse { } export namespace CreateRoutingProfileResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateRoutingProfileResponse): any => ({ ...obj, }); @@ -1148,6 +1289,9 @@ export interface CreateUseCaseRequest { } export namespace CreateUseCaseRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateUseCaseRequest): any => ({ ...obj, }); @@ -1166,6 +1310,9 @@ export interface CreateUseCaseResponse { } export namespace CreateUseCaseResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateUseCaseResponse): any => ({ ...obj, }); @@ -1195,6 +1342,9 @@ export interface UserIdentityInfo { } export namespace UserIdentityInfo { + /** + * @internal + */ export const filterSensitiveLog = (obj: UserIdentityInfo): any => ({ ...obj, }); @@ -1231,6 +1381,9 @@ export interface UserPhoneConfig { } export namespace UserPhoneConfig { + /** + * @internal + */ export const filterSensitiveLog = (obj: UserPhoneConfig): any => ({ ...obj, }); @@ -1298,6 +1451,9 @@ export interface CreateUserRequest { } export namespace CreateUserRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateUserRequest): any => ({ ...obj, }); @@ -1316,6 +1472,9 @@ export interface CreateUserResponse { } export namespace CreateUserResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateUserResponse): any => ({ ...obj, }); @@ -1340,6 +1499,9 @@ export interface CreateUserHierarchyGroupRequest { } export namespace CreateUserHierarchyGroupRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateUserHierarchyGroupRequest): any => ({ ...obj, }); @@ -1358,6 +1520,9 @@ export interface CreateUserHierarchyGroupResponse { } export namespace CreateUserHierarchyGroupResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateUserHierarchyGroupResponse): any => ({ ...obj, }); @@ -1371,6 +1536,9 @@ export interface DeleteInstanceRequest { } export namespace DeleteInstanceRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteInstanceRequest): any => ({ ...obj, }); @@ -1389,6 +1557,9 @@ export interface DeleteIntegrationAssociationRequest { } export namespace DeleteIntegrationAssociationRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteIntegrationAssociationRequest): any => ({ ...obj, }); @@ -1407,6 +1578,9 @@ export interface DeleteQuickConnectRequest { } export namespace DeleteQuickConnectRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteQuickConnectRequest): any => ({ ...obj, }); @@ -1430,6 +1604,9 @@ export interface DeleteUseCaseRequest { } export namespace DeleteUseCaseRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteUseCaseRequest): any => ({ ...obj, }); @@ -1448,6 +1625,9 @@ export interface DeleteUserRequest { } export namespace DeleteUserRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteUserRequest): any => ({ ...obj, }); @@ -1466,6 +1646,9 @@ export interface DeleteUserHierarchyGroupRequest { } export namespace DeleteUserHierarchyGroupRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteUserHierarchyGroupRequest): any => ({ ...obj, }); @@ -1500,6 +1683,9 @@ export interface ResourceInUseException extends __SmithyException, $MetadataBear } export namespace ResourceInUseException { + /** + * @internal + */ export const filterSensitiveLog = (obj: ResourceInUseException): any => ({ ...obj, }); @@ -1515,6 +1701,9 @@ export interface ContactFlowNotPublishedException extends __SmithyException, $Me } export namespace ContactFlowNotPublishedException { + /** + * @internal + */ export const filterSensitiveLog = (obj: ContactFlowNotPublishedException): any => ({ ...obj, }); @@ -1533,6 +1722,9 @@ export interface DescribeContactFlowRequest { } export namespace DescribeContactFlowRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeContactFlowRequest): any => ({ ...obj, }); @@ -1580,6 +1772,9 @@ export interface ContactFlow { } export namespace ContactFlow { + /** + * @internal + */ export const filterSensitiveLog = (obj: ContactFlow): any => ({ ...obj, }); @@ -1593,6 +1788,9 @@ export interface DescribeContactFlowResponse { } export namespace DescribeContactFlowResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeContactFlowResponse): any => ({ ...obj, }); @@ -1611,6 +1809,9 @@ export interface DescribeHoursOfOperationRequest { } export namespace DescribeHoursOfOperationRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeHoursOfOperationRequest): any => ({ ...obj, }); @@ -1642,6 +1843,9 @@ export interface HoursOfOperationTimeSlice { } export namespace HoursOfOperationTimeSlice { + /** + * @internal + */ export const filterSensitiveLog = (obj: HoursOfOperationTimeSlice): any => ({ ...obj, }); @@ -1669,6 +1873,9 @@ export interface HoursOfOperationConfig { } export namespace HoursOfOperationConfig { + /** + * @internal + */ export const filterSensitiveLog = (obj: HoursOfOperationConfig): any => ({ ...obj, }); @@ -1715,6 +1922,9 @@ export interface HoursOfOperation { } export namespace HoursOfOperation { + /** + * @internal + */ export const filterSensitiveLog = (obj: HoursOfOperation): any => ({ ...obj, }); @@ -1728,6 +1938,9 @@ export interface DescribeHoursOfOperationResponse { } export namespace DescribeHoursOfOperationResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeHoursOfOperationResponse): any => ({ ...obj, }); @@ -1741,6 +1954,9 @@ export interface DescribeInstanceRequest { } export namespace DescribeInstanceRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeInstanceRequest): any => ({ ...obj, }); @@ -1764,6 +1980,9 @@ export interface InstanceStatusReason { } export namespace InstanceStatusReason { + /** + * @internal + */ export const filterSensitiveLog = (obj: InstanceStatusReason): any => ({ ...obj, }); @@ -1825,6 +2044,9 @@ export interface Instance { } export namespace Instance { + /** + * @internal + */ export const filterSensitiveLog = (obj: Instance): any => ({ ...obj, ...(obj.InstanceAlias && { InstanceAlias: SENSITIVE_STRING }), @@ -1839,6 +2061,9 @@ export interface DescribeInstanceResponse { } export namespace DescribeInstanceResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeInstanceResponse): any => ({ ...obj, ...(obj.Instance && { Instance: Instance.filterSensitiveLog(obj.Instance) }), @@ -1868,6 +2093,9 @@ export interface DescribeInstanceAttributeRequest { } export namespace DescribeInstanceAttributeRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeInstanceAttributeRequest): any => ({ ...obj, }); @@ -1889,6 +2117,9 @@ export interface Attribute { } export namespace Attribute { + /** + * @internal + */ export const filterSensitiveLog = (obj: Attribute): any => ({ ...obj, }); @@ -1904,6 +2135,9 @@ export interface DescribeInstanceAttributeResponse { } export namespace DescribeInstanceAttributeResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeInstanceAttributeResponse): any => ({ ...obj, }); @@ -1927,6 +2161,9 @@ export interface DescribeInstanceStorageConfigRequest { } export namespace DescribeInstanceStorageConfigRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeInstanceStorageConfigRequest): any => ({ ...obj, }); @@ -1940,6 +2177,9 @@ export interface DescribeInstanceStorageConfigResponse { } export namespace DescribeInstanceStorageConfigResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeInstanceStorageConfigResponse): any => ({ ...obj, }); @@ -1958,6 +2198,9 @@ export interface DescribeQueueRequest { } export namespace DescribeQueueRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeQueueRequest): any => ({ ...obj, }); @@ -2019,6 +2262,9 @@ export interface Queue { } export namespace Queue { + /** + * @internal + */ export const filterSensitiveLog = (obj: Queue): any => ({ ...obj, }); @@ -2032,6 +2278,9 @@ export interface DescribeQueueResponse { } export namespace DescribeQueueResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeQueueResponse): any => ({ ...obj, }); @@ -2050,6 +2299,9 @@ export interface DescribeQuickConnectRequest { } export namespace DescribeQuickConnectRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeQuickConnectRequest): any => ({ ...obj, }); @@ -2091,6 +2343,9 @@ export interface QuickConnect { } export namespace QuickConnect { + /** + * @internal + */ export const filterSensitiveLog = (obj: QuickConnect): any => ({ ...obj, }); @@ -2104,6 +2359,9 @@ export interface DescribeQuickConnectResponse { } export namespace DescribeQuickConnectResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeQuickConnectResponse): any => ({ ...obj, }); @@ -2122,6 +2380,9 @@ export interface DescribeRoutingProfileRequest { } export namespace DescribeRoutingProfileRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeRoutingProfileRequest): any => ({ ...obj, }); @@ -2174,6 +2435,9 @@ export interface RoutingProfile { } export namespace RoutingProfile { + /** + * @internal + */ export const filterSensitiveLog = (obj: RoutingProfile): any => ({ ...obj, }); @@ -2187,6 +2451,9 @@ export interface DescribeRoutingProfileResponse { } export namespace DescribeRoutingProfileResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeRoutingProfileResponse): any => ({ ...obj, }); @@ -2205,6 +2472,9 @@ export interface DescribeUserRequest { } export namespace DescribeUserRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeUserRequest): any => ({ ...obj, }); @@ -2267,6 +2537,9 @@ export interface User { } export namespace User { + /** + * @internal + */ export const filterSensitiveLog = (obj: User): any => ({ ...obj, }); @@ -2280,6 +2553,9 @@ export interface DescribeUserResponse { } export namespace DescribeUserResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeUserResponse): any => ({ ...obj, }); @@ -2298,6 +2574,9 @@ export interface DescribeUserHierarchyGroupRequest { } export namespace DescribeUserHierarchyGroupRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeUserHierarchyGroupRequest): any => ({ ...obj, }); @@ -2324,6 +2603,9 @@ export interface HierarchyGroupSummary { } export namespace HierarchyGroupSummary { + /** + * @internal + */ export const filterSensitiveLog = (obj: HierarchyGroupSummary): any => ({ ...obj, }); @@ -2360,6 +2642,9 @@ export interface HierarchyPath { } export namespace HierarchyPath { + /** + * @internal + */ export const filterSensitiveLog = (obj: HierarchyPath): any => ({ ...obj, }); @@ -2396,6 +2681,9 @@ export interface HierarchyGroup { } export namespace HierarchyGroup { + /** + * @internal + */ export const filterSensitiveLog = (obj: HierarchyGroup): any => ({ ...obj, }); @@ -2409,6 +2697,9 @@ export interface DescribeUserHierarchyGroupResponse { } export namespace DescribeUserHierarchyGroupResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeUserHierarchyGroupResponse): any => ({ ...obj, }); @@ -2422,6 +2713,9 @@ export interface DescribeUserHierarchyStructureRequest { } export namespace DescribeUserHierarchyStructureRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeUserHierarchyStructureRequest): any => ({ ...obj, }); @@ -2448,6 +2742,9 @@ export interface HierarchyLevel { } export namespace HierarchyLevel { + /** + * @internal + */ export const filterSensitiveLog = (obj: HierarchyLevel): any => ({ ...obj, }); @@ -2484,6 +2781,9 @@ export interface HierarchyStructure { } export namespace HierarchyStructure { + /** + * @internal + */ export const filterSensitiveLog = (obj: HierarchyStructure): any => ({ ...obj, }); @@ -2497,6 +2797,9 @@ export interface DescribeUserHierarchyStructureResponse { } export namespace DescribeUserHierarchyStructureResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeUserHierarchyStructureResponse): any => ({ ...obj, }); @@ -2515,6 +2818,9 @@ export interface DisassociateApprovedOriginRequest { } export namespace DisassociateApprovedOriginRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DisassociateApprovedOriginRequest): any => ({ ...obj, }); @@ -2538,6 +2844,9 @@ export interface DisassociateInstanceStorageConfigRequest { } export namespace DisassociateInstanceStorageConfigRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DisassociateInstanceStorageConfigRequest): any => ({ ...obj, }); @@ -2556,6 +2865,9 @@ export interface DisassociateLambdaFunctionRequest { } export namespace DisassociateLambdaFunctionRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DisassociateLambdaFunctionRequest): any => ({ ...obj, }); @@ -2579,6 +2891,9 @@ export interface DisassociateLexBotRequest { } export namespace DisassociateLexBotRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DisassociateLexBotRequest): any => ({ ...obj, }); @@ -2602,6 +2917,9 @@ export interface DisassociateQueueQuickConnectsRequest { } export namespace DisassociateQueueQuickConnectsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DisassociateQueueQuickConnectsRequest): any => ({ ...obj, }); @@ -2625,6 +2943,9 @@ export interface DisassociateRoutingProfileQueuesRequest { } export namespace DisassociateRoutingProfileQueuesRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DisassociateRoutingProfileQueuesRequest): any => ({ ...obj, }); @@ -2643,6 +2964,9 @@ export interface DisassociateSecurityKeyRequest { } export namespace DisassociateSecurityKeyRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DisassociateSecurityKeyRequest): any => ({ ...obj, }); @@ -2661,6 +2985,9 @@ export interface GetContactAttributesRequest { } export namespace GetContactAttributesRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetContactAttributesRequest): any => ({ ...obj, }); @@ -2674,6 +3001,9 @@ export interface GetContactAttributesResponse { } export namespace GetContactAttributesResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetContactAttributesResponse): any => ({ ...obj, }); @@ -2718,6 +3048,9 @@ export interface CurrentMetric { } export namespace CurrentMetric { + /** + * @internal + */ export const filterSensitiveLog = (obj: CurrentMetric): any => ({ ...obj, }); @@ -2740,6 +3073,9 @@ export interface Filters { } export namespace Filters { + /** + * @internal + */ export const filterSensitiveLog = (obj: Filters): any => ({ ...obj, }); @@ -2886,6 +3222,9 @@ export interface GetCurrentMetricDataRequest { } export namespace GetCurrentMetricDataRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetCurrentMetricDataRequest): any => ({ ...obj, }); @@ -2907,6 +3246,9 @@ export interface CurrentMetricData { } export namespace CurrentMetricData { + /** + * @internal + */ export const filterSensitiveLog = (obj: CurrentMetricData): any => ({ ...obj, }); @@ -2928,6 +3270,9 @@ export interface QueueReference { } export namespace QueueReference { + /** + * @internal + */ export const filterSensitiveLog = (obj: QueueReference): any => ({ ...obj, }); @@ -2949,6 +3294,9 @@ export interface Dimensions { } export namespace Dimensions { + /** + * @internal + */ export const filterSensitiveLog = (obj: Dimensions): any => ({ ...obj, }); @@ -2970,6 +3318,9 @@ export interface CurrentMetricResult { } export namespace CurrentMetricResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: CurrentMetricResult): any => ({ ...obj, }); @@ -2995,6 +3346,9 @@ export interface GetCurrentMetricDataResponse { } export namespace GetCurrentMetricDataResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetCurrentMetricDataResponse): any => ({ ...obj, }); @@ -3008,6 +3362,9 @@ export interface GetFederationTokenRequest { } export namespace GetFederationTokenRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetFederationTokenRequest): any => ({ ...obj, }); @@ -3040,6 +3397,9 @@ export interface Credentials { } export namespace Credentials { + /** + * @internal + */ export const filterSensitiveLog = (obj: Credentials): any => ({ ...obj, ...(obj.AccessToken && { AccessToken: SENSITIVE_STRING }), @@ -3055,6 +3415,9 @@ export interface GetFederationTokenResponse { } export namespace GetFederationTokenResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetFederationTokenResponse): any => ({ ...obj, ...(obj.Credentials && { Credentials: Credentials.filterSensitiveLog(obj.Credentials) }), @@ -3071,6 +3434,9 @@ export interface UserNotFoundException extends __SmithyException, $MetadataBeare } export namespace UserNotFoundException { + /** + * @internal + */ export const filterSensitiveLog = (obj: UserNotFoundException): any => ({ ...obj, }); @@ -3130,6 +3496,9 @@ export interface Threshold { } export namespace Threshold { + /** + * @internal + */ export const filterSensitiveLog = (obj: Threshold): any => ({ ...obj, }); @@ -3162,6 +3531,9 @@ export interface HistoricalMetric { } export namespace HistoricalMetric { + /** + * @internal + */ export const filterSensitiveLog = (obj: HistoricalMetric): any => ({ ...obj, }); @@ -3355,6 +3727,9 @@ export interface GetMetricDataRequest { } export namespace GetMetricDataRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetMetricDataRequest): any => ({ ...obj, }); @@ -3376,6 +3751,9 @@ export interface HistoricalMetricData { } export namespace HistoricalMetricData { + /** + * @internal + */ export const filterSensitiveLog = (obj: HistoricalMetricData): any => ({ ...obj, }); @@ -3397,6 +3775,9 @@ export interface HistoricalMetricResult { } export namespace HistoricalMetricResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: HistoricalMetricResult): any => ({ ...obj, }); @@ -3418,6 +3799,9 @@ export interface GetMetricDataResponse { } export namespace GetMetricDataResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetMetricDataResponse): any => ({ ...obj, }); @@ -3442,6 +3826,9 @@ export interface ListApprovedOriginsRequest { } export namespace ListApprovedOriginsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListApprovedOriginsRequest): any => ({ ...obj, }); @@ -3460,6 +3847,9 @@ export interface ListApprovedOriginsResponse { } export namespace ListApprovedOriginsResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListApprovedOriginsResponse): any => ({ ...obj, }); @@ -3489,6 +3879,9 @@ export interface ListContactFlowsRequest { } export namespace ListContactFlowsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListContactFlowsRequest): any => ({ ...obj, }); @@ -3522,6 +3915,9 @@ export interface ContactFlowSummary { } export namespace ContactFlowSummary { + /** + * @internal + */ export const filterSensitiveLog = (obj: ContactFlowSummary): any => ({ ...obj, }); @@ -3540,6 +3936,9 @@ export interface ListContactFlowsResponse { } export namespace ListContactFlowsResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListContactFlowsResponse): any => ({ ...obj, }); @@ -3564,6 +3963,9 @@ export interface ListHoursOfOperationsRequest { } export namespace ListHoursOfOperationsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListHoursOfOperationsRequest): any => ({ ...obj, }); @@ -3590,6 +3992,9 @@ export interface HoursOfOperationSummary { } export namespace HoursOfOperationSummary { + /** + * @internal + */ export const filterSensitiveLog = (obj: HoursOfOperationSummary): any => ({ ...obj, }); @@ -3608,6 +4013,9 @@ export interface ListHoursOfOperationsResponse { } export namespace ListHoursOfOperationsResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListHoursOfOperationsResponse): any => ({ ...obj, }); @@ -3632,6 +4040,9 @@ export interface ListInstanceAttributesRequest { } export namespace ListInstanceAttributesRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListInstanceAttributesRequest): any => ({ ...obj, }); @@ -3650,6 +4061,9 @@ export interface ListInstanceAttributesResponse { } export namespace ListInstanceAttributesResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListInstanceAttributesResponse): any => ({ ...obj, }); @@ -3669,6 +4083,9 @@ export interface ListInstancesRequest { } export namespace ListInstancesRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListInstancesRequest): any => ({ ...obj, }); @@ -3725,6 +4142,9 @@ export interface InstanceSummary { } export namespace InstanceSummary { + /** + * @internal + */ export const filterSensitiveLog = (obj: InstanceSummary): any => ({ ...obj, ...(obj.InstanceAlias && { InstanceAlias: SENSITIVE_STRING }), @@ -3744,6 +4164,9 @@ export interface ListInstancesResponse { } export namespace ListInstancesResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListInstancesResponse): any => ({ ...obj, ...(obj.InstanceSummaryList && { @@ -3776,6 +4199,9 @@ export interface ListInstanceStorageConfigsRequest { } export namespace ListInstanceStorageConfigsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListInstanceStorageConfigsRequest): any => ({ ...obj, }); @@ -3794,6 +4220,9 @@ export interface ListInstanceStorageConfigsResponse { } export namespace ListInstanceStorageConfigsResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListInstanceStorageConfigsResponse): any => ({ ...obj, }); @@ -3818,6 +4247,9 @@ export interface ListIntegrationAssociationsRequest { } export namespace ListIntegrationAssociationsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListIntegrationAssociationsRequest): any => ({ ...obj, }); @@ -3869,6 +4301,9 @@ export interface IntegrationAssociationSummary { } export namespace IntegrationAssociationSummary { + /** + * @internal + */ export const filterSensitiveLog = (obj: IntegrationAssociationSummary): any => ({ ...obj, }); @@ -3887,6 +4322,9 @@ export interface ListIntegrationAssociationsResponse { } export namespace ListIntegrationAssociationsResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListIntegrationAssociationsResponse): any => ({ ...obj, }); @@ -3911,6 +4349,9 @@ export interface ListLambdaFunctionsRequest { } export namespace ListLambdaFunctionsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListLambdaFunctionsRequest): any => ({ ...obj, }); @@ -3929,6 +4370,9 @@ export interface ListLambdaFunctionsResponse { } export namespace ListLambdaFunctionsResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListLambdaFunctionsResponse): any => ({ ...obj, }); @@ -3953,6 +4397,9 @@ export interface ListLexBotsRequest { } export namespace ListLexBotsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListLexBotsRequest): any => ({ ...obj, }); @@ -3971,6 +4418,9 @@ export interface ListLexBotsResponse { } export namespace ListLexBotsResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListLexBotsResponse): any => ({ ...obj, }); @@ -4250,6 +4700,9 @@ export interface ListPhoneNumbersRequest { } export namespace ListPhoneNumbersRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListPhoneNumbersRequest): any => ({ ...obj, }); @@ -4286,6 +4739,9 @@ export interface PhoneNumberSummary { } export namespace PhoneNumberSummary { + /** + * @internal + */ export const filterSensitiveLog = (obj: PhoneNumberSummary): any => ({ ...obj, }); @@ -4304,6 +4760,9 @@ export interface ListPhoneNumbersResponse { } export namespace ListPhoneNumbersResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListPhoneNumbersResponse): any => ({ ...obj, }); @@ -4328,6 +4787,9 @@ export interface ListPromptsRequest { } export namespace ListPromptsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListPromptsRequest): any => ({ ...obj, }); @@ -4354,6 +4816,9 @@ export interface PromptSummary { } export namespace PromptSummary { + /** + * @internal + */ export const filterSensitiveLog = (obj: PromptSummary): any => ({ ...obj, }); @@ -4372,6 +4837,9 @@ export interface ListPromptsResponse { } export namespace ListPromptsResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListPromptsResponse): any => ({ ...obj, }); @@ -4401,6 +4869,9 @@ export interface ListQueueQuickConnectsRequest { } export namespace ListQueueQuickConnectsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListQueueQuickConnectsRequest): any => ({ ...obj, }); @@ -4433,6 +4904,9 @@ export interface QuickConnectSummary { } export namespace QuickConnectSummary { + /** + * @internal + */ export const filterSensitiveLog = (obj: QuickConnectSummary): any => ({ ...obj, }); @@ -4451,6 +4925,9 @@ export interface ListQueueQuickConnectsResponse { } export namespace ListQueueQuickConnectsResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListQueueQuickConnectsResponse): any => ({ ...obj, }); @@ -4485,6 +4962,9 @@ export interface ListQueuesRequest { } export namespace ListQueuesRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListQueuesRequest): any => ({ ...obj, }); @@ -4516,6 +4996,9 @@ export interface QueueSummary { } export namespace QueueSummary { + /** + * @internal + */ export const filterSensitiveLog = (obj: QueueSummary): any => ({ ...obj, }); @@ -4534,6 +5017,9 @@ export interface ListQueuesResponse { } export namespace ListQueuesResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListQueuesResponse): any => ({ ...obj, }); @@ -4564,6 +5050,9 @@ export interface ListQuickConnectsRequest { } export namespace ListQuickConnectsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListQuickConnectsRequest): any => ({ ...obj, }); @@ -4582,6 +5071,9 @@ export interface ListQuickConnectsResponse { } export namespace ListQuickConnectsResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListQuickConnectsResponse): any => ({ ...obj, }); @@ -4611,6 +5103,9 @@ export interface ListRoutingProfileQueuesRequest { } export namespace ListRoutingProfileQueuesRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListRoutingProfileQueuesRequest): any => ({ ...obj, }); @@ -4656,6 +5151,9 @@ export interface RoutingProfileQueueConfigSummary { } export namespace RoutingProfileQueueConfigSummary { + /** + * @internal + */ export const filterSensitiveLog = (obj: RoutingProfileQueueConfigSummary): any => ({ ...obj, }); @@ -4674,6 +5172,9 @@ export interface ListRoutingProfileQueuesResponse { } export namespace ListRoutingProfileQueuesResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListRoutingProfileQueuesResponse): any => ({ ...obj, }); @@ -4698,6 +5199,9 @@ export interface ListRoutingProfilesRequest { } export namespace ListRoutingProfilesRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListRoutingProfilesRequest): any => ({ ...obj, }); @@ -4724,6 +5228,9 @@ export interface RoutingProfileSummary { } export namespace RoutingProfileSummary { + /** + * @internal + */ export const filterSensitiveLog = (obj: RoutingProfileSummary): any => ({ ...obj, }); @@ -4742,6 +5249,9 @@ export interface ListRoutingProfilesResponse { } export namespace ListRoutingProfilesResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListRoutingProfilesResponse): any => ({ ...obj, }); @@ -4766,6 +5276,9 @@ export interface ListSecurityKeysRequest { } export namespace ListSecurityKeysRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListSecurityKeysRequest): any => ({ ...obj, }); @@ -4792,6 +5305,9 @@ export interface SecurityKey { } export namespace SecurityKey { + /** + * @internal + */ export const filterSensitiveLog = (obj: SecurityKey): any => ({ ...obj, }); @@ -4810,6 +5326,9 @@ export interface ListSecurityKeysResponse { } export namespace ListSecurityKeysResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListSecurityKeysResponse): any => ({ ...obj, }); @@ -4834,6 +5353,9 @@ export interface ListSecurityProfilesRequest { } export namespace ListSecurityProfilesRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListSecurityProfilesRequest): any => ({ ...obj, }); @@ -4860,6 +5382,9 @@ export interface SecurityProfileSummary { } export namespace SecurityProfileSummary { + /** + * @internal + */ export const filterSensitiveLog = (obj: SecurityProfileSummary): any => ({ ...obj, }); @@ -4878,6 +5403,9 @@ export interface ListSecurityProfilesResponse { } export namespace ListSecurityProfilesResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListSecurityProfilesResponse): any => ({ ...obj, }); @@ -4891,6 +5419,9 @@ export interface ListTagsForResourceRequest { } export namespace ListTagsForResourceRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListTagsForResourceRequest): any => ({ ...obj, }); @@ -4904,6 +5435,9 @@ export interface ListTagsForResourceResponse { } export namespace ListTagsForResourceResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListTagsForResourceResponse): any => ({ ...obj, }); @@ -4937,6 +5471,9 @@ export interface ListUseCasesRequest { } export namespace ListUseCasesRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListUseCasesRequest): any => ({ ...obj, }); @@ -4966,6 +5503,9 @@ export interface UseCase { } export namespace UseCase { + /** + * @internal + */ export const filterSensitiveLog = (obj: UseCase): any => ({ ...obj, }); @@ -4984,6 +5524,9 @@ export interface ListUseCasesResponse { } export namespace ListUseCasesResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListUseCasesResponse): any => ({ ...obj, }); @@ -5008,6 +5551,9 @@ export interface ListUserHierarchyGroupsRequest { } export namespace ListUserHierarchyGroupsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListUserHierarchyGroupsRequest): any => ({ ...obj, }); @@ -5026,6 +5572,9 @@ export interface ListUserHierarchyGroupsResponse { } export namespace ListUserHierarchyGroupsResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListUserHierarchyGroupsResponse): any => ({ ...obj, }); @@ -5050,6 +5599,9 @@ export interface ListUsersRequest { } export namespace ListUsersRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListUsersRequest): any => ({ ...obj, }); @@ -5076,6 +5628,9 @@ export interface UserSummary { } export namespace UserSummary { + /** + * @internal + */ export const filterSensitiveLog = (obj: UserSummary): any => ({ ...obj, }); @@ -5094,6 +5649,9 @@ export interface ListUsersResponse { } export namespace ListUsersResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListUsersResponse): any => ({ ...obj, }); @@ -5118,6 +5676,9 @@ export interface ResumeContactRecordingRequest { } export namespace ResumeContactRecordingRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ResumeContactRecordingRequest): any => ({ ...obj, }); @@ -5126,6 +5687,9 @@ export namespace ResumeContactRecordingRequest { export interface ResumeContactRecordingResponse {} export namespace ResumeContactRecordingResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ResumeContactRecordingResponse): any => ({ ...obj, }); @@ -5147,6 +5711,9 @@ export interface ChatMessage { } export namespace ChatMessage { + /** + * @internal + */ export const filterSensitiveLog = (obj: ChatMessage): any => ({ ...obj, }); @@ -5163,6 +5730,9 @@ export interface ParticipantDetails { } export namespace ParticipantDetails { + /** + * @internal + */ export const filterSensitiveLog = (obj: ParticipantDetails): any => ({ ...obj, }); @@ -5212,6 +5782,9 @@ export interface StartChatContactRequest { } export namespace StartChatContactRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: StartChatContactRequest): any => ({ ...obj, }); @@ -5237,6 +5810,9 @@ export interface StartChatContactResponse { } export namespace StartChatContactResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: StartChatContactResponse): any => ({ ...obj, }); @@ -5259,6 +5835,9 @@ export interface VoiceRecordingConfiguration { } export namespace VoiceRecordingConfiguration { + /** + * @internal + */ export const filterSensitiveLog = (obj: VoiceRecordingConfiguration): any => ({ ...obj, }); @@ -5288,6 +5867,9 @@ export interface StartContactRecordingRequest { } export namespace StartContactRecordingRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: StartContactRecordingRequest): any => ({ ...obj, }); @@ -5296,6 +5878,9 @@ export namespace StartContactRecordingRequest { export interface StartContactRecordingResponse {} export namespace StartContactRecordingResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: StartContactRecordingResponse): any => ({ ...obj, }); @@ -5314,6 +5899,9 @@ export interface DestinationNotAllowedException extends __SmithyException, $Meta } export namespace DestinationNotAllowedException { + /** + * @internal + */ export const filterSensitiveLog = (obj: DestinationNotAllowedException): any => ({ ...obj, }); @@ -5332,6 +5920,9 @@ export interface OutboundContactNotPermittedException extends __SmithyException, } export namespace OutboundContactNotPermittedException { + /** + * @internal + */ export const filterSensitiveLog = (obj: OutboundContactNotPermittedException): any => ({ ...obj, }); @@ -5390,6 +5981,9 @@ export interface StartOutboundVoiceContactRequest { } export namespace StartOutboundVoiceContactRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: StartOutboundVoiceContactRequest): any => ({ ...obj, }); @@ -5403,6 +5997,9 @@ export interface StartOutboundVoiceContactResponse { } export namespace StartOutboundVoiceContactResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: StartOutboundVoiceContactResponse): any => ({ ...obj, }); @@ -5430,6 +6027,9 @@ export interface Reference { } export namespace Reference { + /** + * @internal + */ export const filterSensitiveLog = (obj: Reference): any => ({ ...obj, }); @@ -5489,6 +6089,9 @@ export interface StartTaskContactRequest { } export namespace StartTaskContactRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: StartTaskContactRequest): any => ({ ...obj, }); @@ -5502,6 +6105,9 @@ export interface StartTaskContactResponse { } export namespace StartTaskContactResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: StartTaskContactResponse): any => ({ ...obj, }); @@ -5520,6 +6126,9 @@ export interface ContactNotFoundException extends __SmithyException, $MetadataBe } export namespace ContactNotFoundException { + /** + * @internal + */ export const filterSensitiveLog = (obj: ContactNotFoundException): any => ({ ...obj, }); @@ -5538,6 +6147,9 @@ export interface StopContactRequest { } export namespace StopContactRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: StopContactRequest): any => ({ ...obj, }); @@ -5546,6 +6158,9 @@ export namespace StopContactRequest { export interface StopContactResponse {} export namespace StopContactResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: StopContactResponse): any => ({ ...obj, }); @@ -5570,6 +6185,9 @@ export interface StopContactRecordingRequest { } export namespace StopContactRecordingRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: StopContactRecordingRequest): any => ({ ...obj, }); @@ -5578,6 +6196,9 @@ export namespace StopContactRecordingRequest { export interface StopContactRecordingResponse {} export namespace StopContactRecordingResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: StopContactRecordingResponse): any => ({ ...obj, }); @@ -5602,6 +6223,9 @@ export interface SuspendContactRecordingRequest { } export namespace SuspendContactRecordingRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: SuspendContactRecordingRequest): any => ({ ...obj, }); @@ -5610,6 +6234,9 @@ export namespace SuspendContactRecordingRequest { export interface SuspendContactRecordingResponse {} export namespace SuspendContactRecordingResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: SuspendContactRecordingResponse): any => ({ ...obj, }); @@ -5628,6 +6255,9 @@ export interface TagResourceRequest { } export namespace TagResourceRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: TagResourceRequest): any => ({ ...obj, }); @@ -5646,6 +6276,9 @@ export interface UntagResourceRequest { } export namespace UntagResourceRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: UntagResourceRequest): any => ({ ...obj, }); @@ -5673,6 +6306,9 @@ export interface UpdateContactAttributesRequest { } export namespace UpdateContactAttributesRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateContactAttributesRequest): any => ({ ...obj, }); @@ -5681,6 +6317,9 @@ export namespace UpdateContactAttributesRequest { export interface UpdateContactAttributesResponse {} export namespace UpdateContactAttributesResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateContactAttributesResponse): any => ({ ...obj, }); @@ -5706,6 +6345,9 @@ export interface UpdateContactFlowContentRequest { } export namespace UpdateContactFlowContentRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateContactFlowContentRequest): any => ({ ...obj, }); @@ -5734,6 +6376,9 @@ export interface UpdateContactFlowNameRequest { } export namespace UpdateContactFlowNameRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateContactFlowNameRequest): any => ({ ...obj, }); @@ -5757,6 +6402,9 @@ export interface UpdateInstanceAttributeRequest { } export namespace UpdateInstanceAttributeRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateInstanceAttributeRequest): any => ({ ...obj, }); @@ -5785,6 +6433,9 @@ export interface UpdateInstanceStorageConfigRequest { } export namespace UpdateInstanceStorageConfigRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateInstanceStorageConfigRequest): any => ({ ...obj, }); @@ -5808,6 +6459,9 @@ export interface UpdateQueueHoursOfOperationRequest { } export namespace UpdateQueueHoursOfOperationRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateQueueHoursOfOperationRequest): any => ({ ...obj, }); @@ -5831,6 +6485,9 @@ export interface UpdateQueueMaxContactsRequest { } export namespace UpdateQueueMaxContactsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateQueueMaxContactsRequest): any => ({ ...obj, }); @@ -5859,6 +6516,9 @@ export interface UpdateQueueNameRequest { } export namespace UpdateQueueNameRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateQueueNameRequest): any => ({ ...obj, }); @@ -5882,6 +6542,9 @@ export interface UpdateQueueOutboundCallerConfigRequest { } export namespace UpdateQueueOutboundCallerConfigRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateQueueOutboundCallerConfigRequest): any => ({ ...obj, }); @@ -5905,6 +6568,9 @@ export interface UpdateQueueStatusRequest { } export namespace UpdateQueueStatusRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateQueueStatusRequest): any => ({ ...obj, }); @@ -5928,6 +6594,9 @@ export interface UpdateQuickConnectConfigRequest { } export namespace UpdateQuickConnectConfigRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateQuickConnectConfigRequest): any => ({ ...obj, }); @@ -5956,6 +6625,9 @@ export interface UpdateQuickConnectNameRequest { } export namespace UpdateQuickConnectNameRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateQuickConnectNameRequest): any => ({ ...obj, }); @@ -5979,6 +6651,9 @@ export interface UpdateRoutingProfileConcurrencyRequest { } export namespace UpdateRoutingProfileConcurrencyRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateRoutingProfileConcurrencyRequest): any => ({ ...obj, }); @@ -6002,6 +6677,9 @@ export interface UpdateRoutingProfileDefaultOutboundQueueRequest { } export namespace UpdateRoutingProfileDefaultOutboundQueueRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateRoutingProfileDefaultOutboundQueueRequest): any => ({ ...obj, }); @@ -6030,6 +6708,9 @@ export interface UpdateRoutingProfileNameRequest { } export namespace UpdateRoutingProfileNameRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateRoutingProfileNameRequest): any => ({ ...obj, }); @@ -6054,6 +6735,9 @@ export interface UpdateRoutingProfileQueuesRequest { } export namespace UpdateRoutingProfileQueuesRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateRoutingProfileQueuesRequest): any => ({ ...obj, }); @@ -6077,6 +6761,9 @@ export interface UpdateUserHierarchyRequest { } export namespace UpdateUserHierarchyRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateUserHierarchyRequest): any => ({ ...obj, }); @@ -6100,6 +6787,9 @@ export interface UpdateUserHierarchyGroupNameRequest { } export namespace UpdateUserHierarchyGroupNameRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateUserHierarchyGroupNameRequest): any => ({ ...obj, }); @@ -6116,6 +6806,9 @@ export interface HierarchyLevelUpdate { } export namespace HierarchyLevelUpdate { + /** + * @internal + */ export const filterSensitiveLog = (obj: HierarchyLevelUpdate): any => ({ ...obj, }); @@ -6154,6 +6847,9 @@ export interface HierarchyStructureUpdate { } export namespace HierarchyStructureUpdate { + /** + * @internal + */ export const filterSensitiveLog = (obj: HierarchyStructureUpdate): any => ({ ...obj, }); @@ -6172,6 +6868,9 @@ export interface UpdateUserHierarchyStructureRequest { } export namespace UpdateUserHierarchyStructureRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateUserHierarchyStructureRequest): any => ({ ...obj, }); @@ -6195,6 +6894,9 @@ export interface UpdateUserIdentityInfoRequest { } export namespace UpdateUserIdentityInfoRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateUserIdentityInfoRequest): any => ({ ...obj, }); @@ -6218,6 +6920,9 @@ export interface UpdateUserPhoneConfigRequest { } export namespace UpdateUserPhoneConfigRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateUserPhoneConfigRequest): any => ({ ...obj, }); @@ -6241,6 +6946,9 @@ export interface UpdateUserRoutingProfileRequest { } export namespace UpdateUserRoutingProfileRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateUserRoutingProfileRequest): any => ({ ...obj, }); @@ -6264,6 +6972,9 @@ export interface UpdateUserSecurityProfilesRequest { } export namespace UpdateUserSecurityProfilesRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateUserSecurityProfilesRequest): any => ({ ...obj, }); diff --git a/clients/client-connectparticipant/commands/CompleteAttachmentUploadCommand.ts b/clients/client-connectparticipant/commands/CompleteAttachmentUploadCommand.ts index b9891ba54907..144de581535f 100644 --- a/clients/client-connectparticipant/commands/CompleteAttachmentUploadCommand.ts +++ b/clients/client-connectparticipant/commands/CompleteAttachmentUploadCommand.ts @@ -27,6 +27,20 @@ export interface CompleteAttachmentUploadCommandOutput extends CompleteAttachmen /** *

Allows you to confirm that the attachment has been uploaded using the pre-signed URL * provided in StartAttachmentUpload API.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ConnectParticipantClient, CompleteAttachmentUploadCommand } from "@aws-sdk/client-connectparticipant"; // ES Modules import + * // const { ConnectParticipantClient, CompleteAttachmentUploadCommand } = require("@aws-sdk/client-connectparticipant"); // CommonJS import + * const client = new ConnectParticipantClient(config); + * const command = new CompleteAttachmentUploadCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CompleteAttachmentUploadCommandInput} for command's `input` shape. + * @see {@link CompleteAttachmentUploadCommandOutput} for command's `response` shape. + * @see {@link ConnectParticipantClientResolvedConfig | config} for command's `input` shape. + * */ export class CompleteAttachmentUploadCommand extends $Command< CompleteAttachmentUploadCommandInput, diff --git a/clients/client-connectparticipant/commands/CreateParticipantConnectionCommand.ts b/clients/client-connectparticipant/commands/CreateParticipantConnectionCommand.ts index c274324d1a7d..a19bb661616a 100644 --- a/clients/client-connectparticipant/commands/CreateParticipantConnectionCommand.ts +++ b/clients/client-connectparticipant/commands/CreateParticipantConnectionCommand.ts @@ -50,6 +50,20 @@ export interface CreateParticipantConnectionCommandOutput *

The Amazon Connect Participant Service APIs do not use Signature Version 4 * authentication.

* + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ConnectParticipantClient, CreateParticipantConnectionCommand } from "@aws-sdk/client-connectparticipant"; // ES Modules import + * // const { ConnectParticipantClient, CreateParticipantConnectionCommand } = require("@aws-sdk/client-connectparticipant"); // CommonJS import + * const client = new ConnectParticipantClient(config); + * const command = new CreateParticipantConnectionCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreateParticipantConnectionCommandInput} for command's `input` shape. + * @see {@link CreateParticipantConnectionCommandOutput} for command's `response` shape. + * @see {@link ConnectParticipantClientResolvedConfig | config} for command's `input` shape. + * */ export class CreateParticipantConnectionCommand extends $Command< CreateParticipantConnectionCommandInput, diff --git a/clients/client-connectparticipant/commands/DisconnectParticipantCommand.ts b/clients/client-connectparticipant/commands/DisconnectParticipantCommand.ts index 0954f55b94a3..caf77636c795 100644 --- a/clients/client-connectparticipant/commands/DisconnectParticipantCommand.ts +++ b/clients/client-connectparticipant/commands/DisconnectParticipantCommand.ts @@ -29,6 +29,20 @@ export interface DisconnectParticipantCommandOutput extends DisconnectParticipan * instead of ParticipantToken.

*

The Amazon Connect Participant Service APIs do not use Signature Version 4 * authentication.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ConnectParticipantClient, DisconnectParticipantCommand } from "@aws-sdk/client-connectparticipant"; // ES Modules import + * // const { ConnectParticipantClient, DisconnectParticipantCommand } = require("@aws-sdk/client-connectparticipant"); // CommonJS import + * const client = new ConnectParticipantClient(config); + * const command = new DisconnectParticipantCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DisconnectParticipantCommandInput} for command's `input` shape. + * @see {@link DisconnectParticipantCommandOutput} for command's `response` shape. + * @see {@link ConnectParticipantClientResolvedConfig | config} for command's `input` shape. + * */ export class DisconnectParticipantCommand extends $Command< DisconnectParticipantCommandInput, diff --git a/clients/client-connectparticipant/commands/GetAttachmentCommand.ts b/clients/client-connectparticipant/commands/GetAttachmentCommand.ts index 505fa23c7acf..108360f58692 100644 --- a/clients/client-connectparticipant/commands/GetAttachmentCommand.ts +++ b/clients/client-connectparticipant/commands/GetAttachmentCommand.ts @@ -27,6 +27,20 @@ export interface GetAttachmentCommandOutput extends GetAttachmentResponse, __Met /** *

Provides a pre-signed URL for download of a completed attachment. This is an * asynchronous API for use with active contacts.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ConnectParticipantClient, GetAttachmentCommand } from "@aws-sdk/client-connectparticipant"; // ES Modules import + * // const { ConnectParticipantClient, GetAttachmentCommand } = require("@aws-sdk/client-connectparticipant"); // CommonJS import + * const client = new ConnectParticipantClient(config); + * const command = new GetAttachmentCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetAttachmentCommandInput} for command's `input` shape. + * @see {@link GetAttachmentCommandOutput} for command's `response` shape. + * @see {@link ConnectParticipantClientResolvedConfig | config} for command's `input` shape. + * */ export class GetAttachmentCommand extends $Command< GetAttachmentCommandInput, diff --git a/clients/client-connectparticipant/commands/GetTranscriptCommand.ts b/clients/client-connectparticipant/commands/GetTranscriptCommand.ts index f3484b765350..eefc8dbadd91 100644 --- a/clients/client-connectparticipant/commands/GetTranscriptCommand.ts +++ b/clients/client-connectparticipant/commands/GetTranscriptCommand.ts @@ -29,6 +29,20 @@ export interface GetTranscriptCommandOutput extends GetTranscriptResponse, __Met * that ConnectionToken is used for invoking this API instead of ParticipantToken.

*

The Amazon Connect Participant Service APIs do not use Signature Version 4 * authentication.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ConnectParticipantClient, GetTranscriptCommand } from "@aws-sdk/client-connectparticipant"; // ES Modules import + * // const { ConnectParticipantClient, GetTranscriptCommand } = require("@aws-sdk/client-connectparticipant"); // CommonJS import + * const client = new ConnectParticipantClient(config); + * const command = new GetTranscriptCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetTranscriptCommandInput} for command's `input` shape. + * @see {@link GetTranscriptCommandOutput} for command's `response` shape. + * @see {@link ConnectParticipantClientResolvedConfig | config} for command's `input` shape. + * */ export class GetTranscriptCommand extends $Command< GetTranscriptCommandInput, diff --git a/clients/client-connectparticipant/commands/SendEventCommand.ts b/clients/client-connectparticipant/commands/SendEventCommand.ts index 16af6daa4f74..3fbf72de8d3c 100644 --- a/clients/client-connectparticipant/commands/SendEventCommand.ts +++ b/clients/client-connectparticipant/commands/SendEventCommand.ts @@ -29,6 +29,20 @@ export interface SendEventCommandOutput extends SendEventResponse, __MetadataBea * ParticipantToken.

*

The Amazon Connect Participant Service APIs do not use Signature Version 4 * authentication.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ConnectParticipantClient, SendEventCommand } from "@aws-sdk/client-connectparticipant"; // ES Modules import + * // const { ConnectParticipantClient, SendEventCommand } = require("@aws-sdk/client-connectparticipant"); // CommonJS import + * const client = new ConnectParticipantClient(config); + * const command = new SendEventCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link SendEventCommandInput} for command's `input` shape. + * @see {@link SendEventCommandOutput} for command's `response` shape. + * @see {@link ConnectParticipantClientResolvedConfig | config} for command's `input` shape. + * */ export class SendEventCommand extends $Command< SendEventCommandInput, diff --git a/clients/client-connectparticipant/commands/SendMessageCommand.ts b/clients/client-connectparticipant/commands/SendMessageCommand.ts index 442dedbee0be..f06827905cd5 100644 --- a/clients/client-connectparticipant/commands/SendMessageCommand.ts +++ b/clients/client-connectparticipant/commands/SendMessageCommand.ts @@ -31,6 +31,20 @@ export interface SendMessageCommandOutput extends SendMessageResponse, __Metadat *

The Amazon Connect Participant Service APIs do not use Signature Version 4 * authentication.

* + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ConnectParticipantClient, SendMessageCommand } from "@aws-sdk/client-connectparticipant"; // ES Modules import + * // const { ConnectParticipantClient, SendMessageCommand } = require("@aws-sdk/client-connectparticipant"); // CommonJS import + * const client = new ConnectParticipantClient(config); + * const command = new SendMessageCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link SendMessageCommandInput} for command's `input` shape. + * @see {@link SendMessageCommandOutput} for command's `response` shape. + * @see {@link ConnectParticipantClientResolvedConfig | config} for command's `input` shape. + * */ export class SendMessageCommand extends $Command< SendMessageCommandInput, diff --git a/clients/client-connectparticipant/commands/StartAttachmentUploadCommand.ts b/clients/client-connectparticipant/commands/StartAttachmentUploadCommand.ts index df6514ddb56b..0116a9b39c40 100644 --- a/clients/client-connectparticipant/commands/StartAttachmentUploadCommand.ts +++ b/clients/client-connectparticipant/commands/StartAttachmentUploadCommand.ts @@ -27,6 +27,20 @@ export interface StartAttachmentUploadCommandOutput extends StartAttachmentUploa /** *

Provides a pre-signed Amazon S3 URL in response for uploading the file directly to * S3.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ConnectParticipantClient, StartAttachmentUploadCommand } from "@aws-sdk/client-connectparticipant"; // ES Modules import + * // const { ConnectParticipantClient, StartAttachmentUploadCommand } = require("@aws-sdk/client-connectparticipant"); // CommonJS import + * const client = new ConnectParticipantClient(config); + * const command = new StartAttachmentUploadCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link StartAttachmentUploadCommandInput} for command's `input` shape. + * @see {@link StartAttachmentUploadCommandOutput} for command's `response` shape. + * @see {@link ConnectParticipantClientResolvedConfig | config} for command's `input` shape. + * */ export class StartAttachmentUploadCommand extends $Command< StartAttachmentUploadCommandInput, diff --git a/clients/client-connectparticipant/models/models_0.ts b/clients/client-connectparticipant/models/models_0.ts index d0dcceb6884c..84e263ac7647 100644 --- a/clients/client-connectparticipant/models/models_0.ts +++ b/clients/client-connectparticipant/models/models_0.ts @@ -11,6 +11,9 @@ export interface AccessDeniedException extends __SmithyException, $MetadataBeare } export namespace AccessDeniedException { + /** + * @internal + */ export const filterSensitiveLog = (obj: AccessDeniedException): any => ({ ...obj, }); @@ -35,6 +38,9 @@ export interface CompleteAttachmentUploadRequest { } export namespace CompleteAttachmentUploadRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: CompleteAttachmentUploadRequest): any => ({ ...obj, }); @@ -43,6 +49,9 @@ export namespace CompleteAttachmentUploadRequest { export interface CompleteAttachmentUploadResponse {} export namespace CompleteAttachmentUploadResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: CompleteAttachmentUploadResponse): any => ({ ...obj, }); @@ -58,6 +67,9 @@ export interface ConflictException extends __SmithyException, $MetadataBearer { } export namespace ConflictException { + /** + * @internal + */ export const filterSensitiveLog = (obj: ConflictException): any => ({ ...obj, }); @@ -73,6 +85,9 @@ export interface InternalServerException extends __SmithyException, $MetadataBea } export namespace InternalServerException { + /** + * @internal + */ export const filterSensitiveLog = (obj: InternalServerException): any => ({ ...obj, }); @@ -88,6 +103,9 @@ export interface ServiceQuotaExceededException extends __SmithyException, $Metad } export namespace ServiceQuotaExceededException { + /** + * @internal + */ export const filterSensitiveLog = (obj: ServiceQuotaExceededException): any => ({ ...obj, }); @@ -103,6 +121,9 @@ export interface ThrottlingException extends __SmithyException, $MetadataBearer } export namespace ThrottlingException { + /** + * @internal + */ export const filterSensitiveLog = (obj: ThrottlingException): any => ({ ...obj, }); @@ -118,6 +139,9 @@ export interface ValidationException extends __SmithyException, $MetadataBearer } export namespace ValidationException { + /** + * @internal + */ export const filterSensitiveLog = (obj: ValidationException): any => ({ ...obj, }); @@ -143,6 +167,9 @@ export interface CreateParticipantConnectionRequest { } export namespace CreateParticipantConnectionRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateParticipantConnectionRequest): any => ({ ...obj, }); @@ -166,6 +193,9 @@ export interface ConnectionCredentials { } export namespace ConnectionCredentials { + /** + * @internal + */ export const filterSensitiveLog = (obj: ConnectionCredentials): any => ({ ...obj, }); @@ -189,6 +219,9 @@ export interface Websocket { } export namespace Websocket { + /** + * @internal + */ export const filterSensitiveLog = (obj: Websocket): any => ({ ...obj, }); @@ -208,6 +241,9 @@ export interface CreateParticipantConnectionResponse { } export namespace CreateParticipantConnectionResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateParticipantConnectionResponse): any => ({ ...obj, }); @@ -227,6 +263,9 @@ export interface DisconnectParticipantRequest { } export namespace DisconnectParticipantRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DisconnectParticipantRequest): any => ({ ...obj, }); @@ -235,6 +274,9 @@ export namespace DisconnectParticipantRequest { export interface DisconnectParticipantResponse {} export namespace DisconnectParticipantResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DisconnectParticipantResponse): any => ({ ...obj, }); @@ -253,6 +295,9 @@ export interface GetAttachmentRequest { } export namespace GetAttachmentRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetAttachmentRequest): any => ({ ...obj, }); @@ -271,6 +316,9 @@ export interface GetAttachmentResponse { } export namespace GetAttachmentResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetAttachmentResponse): any => ({ ...obj, }); @@ -310,6 +358,9 @@ export interface StartPosition { } export namespace StartPosition { + /** + * @internal + */ export const filterSensitiveLog = (obj: StartPosition): any => ({ ...obj, }); @@ -355,6 +406,9 @@ export interface GetTranscriptRequest { } export namespace GetTranscriptRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetTranscriptRequest): any => ({ ...obj, }); @@ -393,6 +447,9 @@ export interface AttachmentItem { } export namespace AttachmentItem { + /** + * @internal + */ export const filterSensitiveLog = (obj: AttachmentItem): any => ({ ...obj, }); @@ -470,6 +527,9 @@ export interface Item { } export namespace Item { + /** + * @internal + */ export const filterSensitiveLog = (obj: Item): any => ({ ...obj, }); @@ -494,6 +554,9 @@ export interface GetTranscriptResponse { } export namespace GetTranscriptResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetTranscriptResponse): any => ({ ...obj, }); @@ -533,6 +596,9 @@ export interface SendEventRequest { } export namespace SendEventRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: SendEventRequest): any => ({ ...obj, }); @@ -553,6 +619,9 @@ export interface SendEventResponse { } export namespace SendEventResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: SendEventResponse): any => ({ ...obj, }); @@ -582,6 +651,9 @@ export interface SendMessageRequest { } export namespace SendMessageRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: SendMessageRequest): any => ({ ...obj, }); @@ -602,6 +674,9 @@ export interface SendMessageResponse { } export namespace SendMessageResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: SendMessageResponse): any => ({ ...obj, }); @@ -635,6 +710,9 @@ export interface StartAttachmentUploadRequest { } export namespace StartAttachmentUploadRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: StartAttachmentUploadRequest): any => ({ ...obj, }); @@ -661,6 +739,9 @@ export interface UploadMetadata { } export namespace UploadMetadata { + /** + * @internal + */ export const filterSensitiveLog = (obj: UploadMetadata): any => ({ ...obj, }); @@ -679,6 +760,9 @@ export interface StartAttachmentUploadResponse { } export namespace StartAttachmentUploadResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: StartAttachmentUploadResponse): any => ({ ...obj, }); diff --git a/clients/client-cost-and-usage-report-service/commands/DeleteReportDefinitionCommand.ts b/clients/client-cost-and-usage-report-service/commands/DeleteReportDefinitionCommand.ts index a268bd1ab9c1..a88cf826c252 100644 --- a/clients/client-cost-and-usage-report-service/commands/DeleteReportDefinitionCommand.ts +++ b/clients/client-cost-and-usage-report-service/commands/DeleteReportDefinitionCommand.ts @@ -26,6 +26,20 @@ export interface DeleteReportDefinitionCommandOutput extends DeleteReportDefinit /** *

Deletes the specified report.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { CostAndUsageReportServiceClient, DeleteReportDefinitionCommand } from "@aws-sdk/client-cost-and-usage-report-service"; // ES Modules import + * // const { CostAndUsageReportServiceClient, DeleteReportDefinitionCommand } = require("@aws-sdk/client-cost-and-usage-report-service"); // CommonJS import + * const client = new CostAndUsageReportServiceClient(config); + * const command = new DeleteReportDefinitionCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteReportDefinitionCommandInput} for command's `input` shape. + * @see {@link DeleteReportDefinitionCommandOutput} for command's `response` shape. + * @see {@link CostAndUsageReportServiceClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteReportDefinitionCommand extends $Command< DeleteReportDefinitionCommandInput, diff --git a/clients/client-cost-and-usage-report-service/commands/DescribeReportDefinitionsCommand.ts b/clients/client-cost-and-usage-report-service/commands/DescribeReportDefinitionsCommand.ts index 7f332269db11..687b005ac6ba 100644 --- a/clients/client-cost-and-usage-report-service/commands/DescribeReportDefinitionsCommand.ts +++ b/clients/client-cost-and-usage-report-service/commands/DescribeReportDefinitionsCommand.ts @@ -26,6 +26,20 @@ export interface DescribeReportDefinitionsCommandOutput extends DescribeReportDe /** *

Lists the AWS Cost and Usage reports available to this account.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { CostAndUsageReportServiceClient, DescribeReportDefinitionsCommand } from "@aws-sdk/client-cost-and-usage-report-service"; // ES Modules import + * // const { CostAndUsageReportServiceClient, DescribeReportDefinitionsCommand } = require("@aws-sdk/client-cost-and-usage-report-service"); // CommonJS import + * const client = new CostAndUsageReportServiceClient(config); + * const command = new DescribeReportDefinitionsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeReportDefinitionsCommandInput} for command's `input` shape. + * @see {@link DescribeReportDefinitionsCommandOutput} for command's `response` shape. + * @see {@link CostAndUsageReportServiceClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeReportDefinitionsCommand extends $Command< DescribeReportDefinitionsCommandInput, diff --git a/clients/client-cost-and-usage-report-service/commands/ModifyReportDefinitionCommand.ts b/clients/client-cost-and-usage-report-service/commands/ModifyReportDefinitionCommand.ts index 84cab50d8014..c0027c884707 100644 --- a/clients/client-cost-and-usage-report-service/commands/ModifyReportDefinitionCommand.ts +++ b/clients/client-cost-and-usage-report-service/commands/ModifyReportDefinitionCommand.ts @@ -26,6 +26,20 @@ export interface ModifyReportDefinitionCommandOutput extends ModifyReportDefinit /** *

Allows you to programatically update your report preferences.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { CostAndUsageReportServiceClient, ModifyReportDefinitionCommand } from "@aws-sdk/client-cost-and-usage-report-service"; // ES Modules import + * // const { CostAndUsageReportServiceClient, ModifyReportDefinitionCommand } = require("@aws-sdk/client-cost-and-usage-report-service"); // CommonJS import + * const client = new CostAndUsageReportServiceClient(config); + * const command = new ModifyReportDefinitionCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ModifyReportDefinitionCommandInput} for command's `input` shape. + * @see {@link ModifyReportDefinitionCommandOutput} for command's `response` shape. + * @see {@link CostAndUsageReportServiceClientResolvedConfig | config} for command's `input` shape. + * */ export class ModifyReportDefinitionCommand extends $Command< ModifyReportDefinitionCommandInput, diff --git a/clients/client-cost-and-usage-report-service/commands/PutReportDefinitionCommand.ts b/clients/client-cost-and-usage-report-service/commands/PutReportDefinitionCommand.ts index 691eff78ad3d..d2a263e1c3ef 100644 --- a/clients/client-cost-and-usage-report-service/commands/PutReportDefinitionCommand.ts +++ b/clients/client-cost-and-usage-report-service/commands/PutReportDefinitionCommand.ts @@ -26,6 +26,20 @@ export interface PutReportDefinitionCommandOutput extends PutReportDefinitionRes /** *

Creates a new report using the description that you provide.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { CostAndUsageReportServiceClient, PutReportDefinitionCommand } from "@aws-sdk/client-cost-and-usage-report-service"; // ES Modules import + * // const { CostAndUsageReportServiceClient, PutReportDefinitionCommand } = require("@aws-sdk/client-cost-and-usage-report-service"); // CommonJS import + * const client = new CostAndUsageReportServiceClient(config); + * const command = new PutReportDefinitionCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link PutReportDefinitionCommandInput} for command's `input` shape. + * @see {@link PutReportDefinitionCommandOutput} for command's `response` shape. + * @see {@link CostAndUsageReportServiceClientResolvedConfig | config} for command's `input` shape. + * */ export class PutReportDefinitionCommand extends $Command< PutReportDefinitionCommandInput, diff --git a/clients/client-cost-and-usage-report-service/models/models_0.ts b/clients/client-cost-and-usage-report-service/models/models_0.ts index 55b7ba420540..98cba86dd7e7 100644 --- a/clients/client-cost-and-usage-report-service/models/models_0.ts +++ b/clients/client-cost-and-usage-report-service/models/models_0.ts @@ -18,6 +18,9 @@ export interface DeleteReportDefinitionRequest { } export namespace DeleteReportDefinitionRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteReportDefinitionRequest): any => ({ ...obj, }); @@ -34,6 +37,9 @@ export interface DeleteReportDefinitionResponse { } export namespace DeleteReportDefinitionResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteReportDefinitionResponse): any => ({ ...obj, }); @@ -52,6 +58,9 @@ export interface InternalErrorException extends __SmithyException, $MetadataBear } export namespace InternalErrorException { + /** + * @internal + */ export const filterSensitiveLog = (obj: InternalErrorException): any => ({ ...obj, }); @@ -70,6 +79,9 @@ export interface ValidationException extends __SmithyException, $MetadataBearer } export namespace ValidationException { + /** + * @internal + */ export const filterSensitiveLog = (obj: ValidationException): any => ({ ...obj, }); @@ -91,6 +103,9 @@ export interface DescribeReportDefinitionsRequest { } export namespace DescribeReportDefinitionsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeReportDefinitionsRequest): any => ({ ...obj, }); @@ -223,6 +238,9 @@ export interface ReportDefinition { } export namespace ReportDefinition { + /** + * @internal + */ export const filterSensitiveLog = (obj: ReportDefinition): any => ({ ...obj, }); @@ -244,6 +262,9 @@ export interface DescribeReportDefinitionsResponse { } export namespace DescribeReportDefinitionsResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeReportDefinitionsResponse): any => ({ ...obj, }); @@ -266,6 +287,9 @@ export interface ModifyReportDefinitionRequest { } export namespace ModifyReportDefinitionRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ModifyReportDefinitionRequest): any => ({ ...obj, }); @@ -274,6 +298,9 @@ export namespace ModifyReportDefinitionRequest { export interface ModifyReportDefinitionResponse {} export namespace ModifyReportDefinitionResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ModifyReportDefinitionResponse): any => ({ ...obj, }); @@ -292,6 +319,9 @@ export interface DuplicateReportNameException extends __SmithyException, $Metada } export namespace DuplicateReportNameException { + /** + * @internal + */ export const filterSensitiveLog = (obj: DuplicateReportNameException): any => ({ ...obj, }); @@ -309,6 +339,9 @@ export interface PutReportDefinitionRequest { } export namespace PutReportDefinitionRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: PutReportDefinitionRequest): any => ({ ...obj, }); @@ -320,6 +353,9 @@ export namespace PutReportDefinitionRequest { export interface PutReportDefinitionResponse {} export namespace PutReportDefinitionResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: PutReportDefinitionResponse): any => ({ ...obj, }); @@ -338,6 +374,9 @@ export interface ReportLimitReachedException extends __SmithyException, $Metadat } export namespace ReportLimitReachedException { + /** + * @internal + */ export const filterSensitiveLog = (obj: ReportLimitReachedException): any => ({ ...obj, }); diff --git a/clients/client-cost-explorer/commands/CreateAnomalyMonitorCommand.ts b/clients/client-cost-explorer/commands/CreateAnomalyMonitorCommand.ts index f0ec543ea615..20bb5fe4f206 100644 --- a/clients/client-cost-explorer/commands/CreateAnomalyMonitorCommand.ts +++ b/clients/client-cost-explorer/commands/CreateAnomalyMonitorCommand.ts @@ -23,6 +23,20 @@ export interface CreateAnomalyMonitorCommandOutput extends CreateAnomalyMonitorR /** *

Creates a new cost anomaly detection monitor with the requested type and monitor * specification.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { CostExplorerClient, CreateAnomalyMonitorCommand } from "@aws-sdk/client-cost-explorer"; // ES Modules import + * // const { CostExplorerClient, CreateAnomalyMonitorCommand } = require("@aws-sdk/client-cost-explorer"); // CommonJS import + * const client = new CostExplorerClient(config); + * const command = new CreateAnomalyMonitorCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreateAnomalyMonitorCommandInput} for command's `input` shape. + * @see {@link CreateAnomalyMonitorCommandOutput} for command's `response` shape. + * @see {@link CostExplorerClientResolvedConfig | config} for command's `input` shape. + * */ export class CreateAnomalyMonitorCommand extends $Command< CreateAnomalyMonitorCommandInput, diff --git a/clients/client-cost-explorer/commands/CreateAnomalySubscriptionCommand.ts b/clients/client-cost-explorer/commands/CreateAnomalySubscriptionCommand.ts index 53c8560893ea..a99af1265fc6 100644 --- a/clients/client-cost-explorer/commands/CreateAnomalySubscriptionCommand.ts +++ b/clients/client-cost-explorer/commands/CreateAnomalySubscriptionCommand.ts @@ -24,6 +24,20 @@ export interface CreateAnomalySubscriptionCommandOutput extends CreateAnomalySub *

Adds a subscription to a cost anomaly detection monitor. You can use each subscription to * define subscribers with email or SNS notifications. Email subscribers can set a dollar * threshold and a time frequency for receiving notifications.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { CostExplorerClient, CreateAnomalySubscriptionCommand } from "@aws-sdk/client-cost-explorer"; // ES Modules import + * // const { CostExplorerClient, CreateAnomalySubscriptionCommand } = require("@aws-sdk/client-cost-explorer"); // CommonJS import + * const client = new CostExplorerClient(config); + * const command = new CreateAnomalySubscriptionCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreateAnomalySubscriptionCommandInput} for command's `input` shape. + * @see {@link CreateAnomalySubscriptionCommandOutput} for command's `response` shape. + * @see {@link CostExplorerClientResolvedConfig | config} for command's `input` shape. + * */ export class CreateAnomalySubscriptionCommand extends $Command< CreateAnomalySubscriptionCommandInput, diff --git a/clients/client-cost-explorer/commands/CreateCostCategoryDefinitionCommand.ts b/clients/client-cost-explorer/commands/CreateCostCategoryDefinitionCommand.ts index faef35621bb4..df63c130cdab 100644 --- a/clients/client-cost-explorer/commands/CreateCostCategoryDefinitionCommand.ts +++ b/clients/client-cost-explorer/commands/CreateCostCategoryDefinitionCommand.ts @@ -24,6 +24,20 @@ export interface CreateCostCategoryDefinitionCommandOutput /** *

Creates a new Cost Category with the requested name and rules.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { CostExplorerClient, CreateCostCategoryDefinitionCommand } from "@aws-sdk/client-cost-explorer"; // ES Modules import + * // const { CostExplorerClient, CreateCostCategoryDefinitionCommand } = require("@aws-sdk/client-cost-explorer"); // CommonJS import + * const client = new CostExplorerClient(config); + * const command = new CreateCostCategoryDefinitionCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreateCostCategoryDefinitionCommandInput} for command's `input` shape. + * @see {@link CreateCostCategoryDefinitionCommandOutput} for command's `response` shape. + * @see {@link CostExplorerClientResolvedConfig | config} for command's `input` shape. + * */ export class CreateCostCategoryDefinitionCommand extends $Command< CreateCostCategoryDefinitionCommandInput, diff --git a/clients/client-cost-explorer/commands/DeleteAnomalyMonitorCommand.ts b/clients/client-cost-explorer/commands/DeleteAnomalyMonitorCommand.ts index 1ff5b2174814..247167955954 100644 --- a/clients/client-cost-explorer/commands/DeleteAnomalyMonitorCommand.ts +++ b/clients/client-cost-explorer/commands/DeleteAnomalyMonitorCommand.ts @@ -22,6 +22,20 @@ export interface DeleteAnomalyMonitorCommandOutput extends DeleteAnomalyMonitorR /** *

Deletes a cost anomaly monitor.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { CostExplorerClient, DeleteAnomalyMonitorCommand } from "@aws-sdk/client-cost-explorer"; // ES Modules import + * // const { CostExplorerClient, DeleteAnomalyMonitorCommand } = require("@aws-sdk/client-cost-explorer"); // CommonJS import + * const client = new CostExplorerClient(config); + * const command = new DeleteAnomalyMonitorCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteAnomalyMonitorCommandInput} for command's `input` shape. + * @see {@link DeleteAnomalyMonitorCommandOutput} for command's `response` shape. + * @see {@link CostExplorerClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteAnomalyMonitorCommand extends $Command< DeleteAnomalyMonitorCommandInput, diff --git a/clients/client-cost-explorer/commands/DeleteAnomalySubscriptionCommand.ts b/clients/client-cost-explorer/commands/DeleteAnomalySubscriptionCommand.ts index 174de8c2a852..5e1ea235f80d 100644 --- a/clients/client-cost-explorer/commands/DeleteAnomalySubscriptionCommand.ts +++ b/clients/client-cost-explorer/commands/DeleteAnomalySubscriptionCommand.ts @@ -22,6 +22,20 @@ export interface DeleteAnomalySubscriptionCommandOutput extends DeleteAnomalySub /** *

Deletes a cost anomaly subscription.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { CostExplorerClient, DeleteAnomalySubscriptionCommand } from "@aws-sdk/client-cost-explorer"; // ES Modules import + * // const { CostExplorerClient, DeleteAnomalySubscriptionCommand } = require("@aws-sdk/client-cost-explorer"); // CommonJS import + * const client = new CostExplorerClient(config); + * const command = new DeleteAnomalySubscriptionCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteAnomalySubscriptionCommandInput} for command's `input` shape. + * @see {@link DeleteAnomalySubscriptionCommandOutput} for command's `response` shape. + * @see {@link CostExplorerClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteAnomalySubscriptionCommand extends $Command< DeleteAnomalySubscriptionCommandInput, diff --git a/clients/client-cost-explorer/commands/DeleteCostCategoryDefinitionCommand.ts b/clients/client-cost-explorer/commands/DeleteCostCategoryDefinitionCommand.ts index 6706a5cff888..97691ad79b79 100644 --- a/clients/client-cost-explorer/commands/DeleteCostCategoryDefinitionCommand.ts +++ b/clients/client-cost-explorer/commands/DeleteCostCategoryDefinitionCommand.ts @@ -24,6 +24,20 @@ export interface DeleteCostCategoryDefinitionCommandOutput /** *

Deletes a Cost Category. Expenses from this month going forward will no longer be categorized with this Cost Category.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { CostExplorerClient, DeleteCostCategoryDefinitionCommand } from "@aws-sdk/client-cost-explorer"; // ES Modules import + * // const { CostExplorerClient, DeleteCostCategoryDefinitionCommand } = require("@aws-sdk/client-cost-explorer"); // CommonJS import + * const client = new CostExplorerClient(config); + * const command = new DeleteCostCategoryDefinitionCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteCostCategoryDefinitionCommandInput} for command's `input` shape. + * @see {@link DeleteCostCategoryDefinitionCommandOutput} for command's `response` shape. + * @see {@link CostExplorerClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteCostCategoryDefinitionCommand extends $Command< DeleteCostCategoryDefinitionCommandInput, diff --git a/clients/client-cost-explorer/commands/DescribeCostCategoryDefinitionCommand.ts b/clients/client-cost-explorer/commands/DescribeCostCategoryDefinitionCommand.ts index ab386ee096eb..dd9d3e8cc5be 100644 --- a/clients/client-cost-explorer/commands/DescribeCostCategoryDefinitionCommand.ts +++ b/clients/client-cost-explorer/commands/DescribeCostCategoryDefinitionCommand.ts @@ -25,6 +25,20 @@ export interface DescribeCostCategoryDefinitionCommandOutput /** *

Returns the 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 is active on a specific date. If there is no EffectiveOn specified, you’ll see a Cost Category that is effective on the current date. If Cost Category is still effective, EffectiveEnd is omitted in the response.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { CostExplorerClient, DescribeCostCategoryDefinitionCommand } from "@aws-sdk/client-cost-explorer"; // ES Modules import + * // const { CostExplorerClient, DescribeCostCategoryDefinitionCommand } = require("@aws-sdk/client-cost-explorer"); // CommonJS import + * const client = new CostExplorerClient(config); + * const command = new DescribeCostCategoryDefinitionCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeCostCategoryDefinitionCommandInput} for command's `input` shape. + * @see {@link DescribeCostCategoryDefinitionCommandOutput} for command's `response` shape. + * @see {@link CostExplorerClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeCostCategoryDefinitionCommand extends $Command< DescribeCostCategoryDefinitionCommandInput, diff --git a/clients/client-cost-explorer/commands/GetAnomaliesCommand.ts b/clients/client-cost-explorer/commands/GetAnomaliesCommand.ts index 31542a84a065..daae1668de19 100644 --- a/clients/client-cost-explorer/commands/GetAnomaliesCommand.ts +++ b/clients/client-cost-explorer/commands/GetAnomaliesCommand.ts @@ -23,6 +23,20 @@ export interface GetAnomaliesCommandOutput extends GetAnomaliesResponse, __Metad /** *

Retrieves all of the cost anomalies detected on your account, during the time period * specified by the DateInterval object.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { CostExplorerClient, GetAnomaliesCommand } from "@aws-sdk/client-cost-explorer"; // ES Modules import + * // const { CostExplorerClient, GetAnomaliesCommand } = require("@aws-sdk/client-cost-explorer"); // CommonJS import + * const client = new CostExplorerClient(config); + * const command = new GetAnomaliesCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetAnomaliesCommandInput} for command's `input` shape. + * @see {@link GetAnomaliesCommandOutput} for command's `response` shape. + * @see {@link CostExplorerClientResolvedConfig | config} for command's `input` shape. + * */ export class GetAnomaliesCommand extends $Command< GetAnomaliesCommandInput, diff --git a/clients/client-cost-explorer/commands/GetAnomalyMonitorsCommand.ts b/clients/client-cost-explorer/commands/GetAnomalyMonitorsCommand.ts index 804bfc76dc4d..a8a8cde87918 100644 --- a/clients/client-cost-explorer/commands/GetAnomalyMonitorsCommand.ts +++ b/clients/client-cost-explorer/commands/GetAnomalyMonitorsCommand.ts @@ -23,6 +23,20 @@ export interface GetAnomalyMonitorsCommandOutput extends GetAnomalyMonitorsRespo /** *

Retrieves the cost anomaly monitor definitions for your account. You can filter using a * list of cost anomaly monitor Amazon Resource Names (ARNs).

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { CostExplorerClient, GetAnomalyMonitorsCommand } from "@aws-sdk/client-cost-explorer"; // ES Modules import + * // const { CostExplorerClient, GetAnomalyMonitorsCommand } = require("@aws-sdk/client-cost-explorer"); // CommonJS import + * const client = new CostExplorerClient(config); + * const command = new GetAnomalyMonitorsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetAnomalyMonitorsCommandInput} for command's `input` shape. + * @see {@link GetAnomalyMonitorsCommandOutput} for command's `response` shape. + * @see {@link CostExplorerClientResolvedConfig | config} for command's `input` shape. + * */ export class GetAnomalyMonitorsCommand extends $Command< GetAnomalyMonitorsCommandInput, diff --git a/clients/client-cost-explorer/commands/GetAnomalySubscriptionsCommand.ts b/clients/client-cost-explorer/commands/GetAnomalySubscriptionsCommand.ts index 96ddb0973fda..8a157665b906 100644 --- a/clients/client-cost-explorer/commands/GetAnomalySubscriptionsCommand.ts +++ b/clients/client-cost-explorer/commands/GetAnomalySubscriptionsCommand.ts @@ -23,6 +23,20 @@ export interface GetAnomalySubscriptionsCommandOutput extends GetAnomalySubscrip /** *

Retrieves the cost anomaly subscription objects for your account. You can filter using a * list of cost anomaly monitor Amazon Resource Names (ARNs).

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { CostExplorerClient, GetAnomalySubscriptionsCommand } from "@aws-sdk/client-cost-explorer"; // ES Modules import + * // const { CostExplorerClient, GetAnomalySubscriptionsCommand } = require("@aws-sdk/client-cost-explorer"); // CommonJS import + * const client = new CostExplorerClient(config); + * const command = new GetAnomalySubscriptionsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetAnomalySubscriptionsCommandInput} for command's `input` shape. + * @see {@link GetAnomalySubscriptionsCommandOutput} for command's `response` shape. + * @see {@link CostExplorerClientResolvedConfig | config} for command's `input` shape. + * */ export class GetAnomalySubscriptionsCommand extends $Command< GetAnomalySubscriptionsCommandInput, diff --git a/clients/client-cost-explorer/commands/GetCostAndUsageCommand.ts b/clients/client-cost-explorer/commands/GetCostAndUsageCommand.ts index 4f3bdcc87b9e..675af5093524 100644 --- a/clients/client-cost-explorer/commands/GetCostAndUsageCommand.ts +++ b/clients/client-cost-explorer/commands/GetCostAndUsageCommand.ts @@ -28,6 +28,20 @@ export interface GetCostAndUsageCommandOutput extends GetCostAndUsageResponse, _ * GetDimensionValues * operation. Management account in an organization in AWS Organizations have access to all member accounts.

*

For information about filter limitations, see Quotas and restrictions in the Billing and Cost Management User Guide.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { CostExplorerClient, GetCostAndUsageCommand } from "@aws-sdk/client-cost-explorer"; // ES Modules import + * // const { CostExplorerClient, GetCostAndUsageCommand } = require("@aws-sdk/client-cost-explorer"); // CommonJS import + * const client = new CostExplorerClient(config); + * const command = new GetCostAndUsageCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetCostAndUsageCommandInput} for command's `input` shape. + * @see {@link GetCostAndUsageCommandOutput} for command's `response` shape. + * @see {@link CostExplorerClientResolvedConfig | config} for command's `input` shape. + * */ export class GetCostAndUsageCommand extends $Command< GetCostAndUsageCommandInput, diff --git a/clients/client-cost-explorer/commands/GetCostAndUsageWithResourcesCommand.ts b/clients/client-cost-explorer/commands/GetCostAndUsageWithResourcesCommand.ts index cbfc6fe0093a..6665ed42b8db 100644 --- a/clients/client-cost-explorer/commands/GetCostAndUsageWithResourcesCommand.ts +++ b/clients/client-cost-explorer/commands/GetCostAndUsageWithResourcesCommand.ts @@ -32,6 +32,20 @@ export interface GetCostAndUsageWithResourcesCommandOutput * *

This is an opt-in only feature. You can enable this feature from the Cost Explorer Settings page. For information on how to access the Settings page, see Controlling Access for Cost Explorer in the AWS Billing and Cost Management User Guide.

* + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { CostExplorerClient, GetCostAndUsageWithResourcesCommand } from "@aws-sdk/client-cost-explorer"; // ES Modules import + * // const { CostExplorerClient, GetCostAndUsageWithResourcesCommand } = require("@aws-sdk/client-cost-explorer"); // CommonJS import + * const client = new CostExplorerClient(config); + * const command = new GetCostAndUsageWithResourcesCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetCostAndUsageWithResourcesCommandInput} for command's `input` shape. + * @see {@link GetCostAndUsageWithResourcesCommandOutput} for command's `response` shape. + * @see {@link CostExplorerClientResolvedConfig | config} for command's `input` shape. + * */ export class GetCostAndUsageWithResourcesCommand extends $Command< GetCostAndUsageWithResourcesCommandInput, diff --git a/clients/client-cost-explorer/commands/GetCostCategoriesCommand.ts b/clients/client-cost-explorer/commands/GetCostCategoriesCommand.ts index 34577499b458..d6adfbc55c6c 100644 --- a/clients/client-cost-explorer/commands/GetCostCategoriesCommand.ts +++ b/clients/client-cost-explorer/commands/GetCostCategoriesCommand.ts @@ -25,6 +25,20 @@ export interface GetCostCategoriesCommandOutput extends GetCostCategoriesRespons * *

If some Cost Category names and values are not associated with any cost, they will not be returned by this API.

* + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { CostExplorerClient, GetCostCategoriesCommand } from "@aws-sdk/client-cost-explorer"; // ES Modules import + * // const { CostExplorerClient, GetCostCategoriesCommand } = require("@aws-sdk/client-cost-explorer"); // CommonJS import + * const client = new CostExplorerClient(config); + * const command = new GetCostCategoriesCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetCostCategoriesCommandInput} for command's `input` shape. + * @see {@link GetCostCategoriesCommandOutput} for command's `response` shape. + * @see {@link CostExplorerClientResolvedConfig | config} for command's `input` shape. + * */ export class GetCostCategoriesCommand extends $Command< GetCostCategoriesCommandInput, diff --git a/clients/client-cost-explorer/commands/GetCostForecastCommand.ts b/clients/client-cost-explorer/commands/GetCostForecastCommand.ts index cecff2f3a12e..894eb51cf8b6 100644 --- a/clients/client-cost-explorer/commands/GetCostForecastCommand.ts +++ b/clients/client-cost-explorer/commands/GetCostForecastCommand.ts @@ -22,6 +22,20 @@ export interface GetCostForecastCommandOutput extends GetCostForecastResponse, _ /** *

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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { CostExplorerClient, GetCostForecastCommand } from "@aws-sdk/client-cost-explorer"; // ES Modules import + * // const { CostExplorerClient, GetCostForecastCommand } = require("@aws-sdk/client-cost-explorer"); // CommonJS import + * const client = new CostExplorerClient(config); + * const command = new GetCostForecastCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetCostForecastCommandInput} for command's `input` shape. + * @see {@link GetCostForecastCommandOutput} for command's `response` shape. + * @see {@link CostExplorerClientResolvedConfig | config} for command's `input` shape. + * */ export class GetCostForecastCommand extends $Command< GetCostForecastCommandInput, diff --git a/clients/client-cost-explorer/commands/GetDimensionValuesCommand.ts b/clients/client-cost-explorer/commands/GetDimensionValuesCommand.ts index 7500604d1612..6095d2d71703 100644 --- a/clients/client-cost-explorer/commands/GetDimensionValuesCommand.ts +++ b/clients/client-cost-explorer/commands/GetDimensionValuesCommand.ts @@ -22,6 +22,20 @@ export interface GetDimensionValuesCommandOutput extends GetDimensionValuesRespo /** *

Retrieves all available filter values for a specified filter over a period of time. You can search the dimension values for an arbitrary string.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { CostExplorerClient, GetDimensionValuesCommand } from "@aws-sdk/client-cost-explorer"; // ES Modules import + * // const { CostExplorerClient, GetDimensionValuesCommand } = require("@aws-sdk/client-cost-explorer"); // CommonJS import + * const client = new CostExplorerClient(config); + * const command = new GetDimensionValuesCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetDimensionValuesCommandInput} for command's `input` shape. + * @see {@link GetDimensionValuesCommandOutput} for command's `response` shape. + * @see {@link CostExplorerClientResolvedConfig | config} for command's `input` shape. + * */ export class GetDimensionValuesCommand extends $Command< GetDimensionValuesCommandInput, diff --git a/clients/client-cost-explorer/commands/GetReservationCoverageCommand.ts b/clients/client-cost-explorer/commands/GetReservationCoverageCommand.ts index 42739aa70f1f..6c9fd5065475 100644 --- a/clients/client-cost-explorer/commands/GetReservationCoverageCommand.ts +++ b/clients/client-cost-explorer/commands/GetReservationCoverageCommand.ts @@ -63,6 +63,20 @@ export interface GetReservationCoverageCommandOutput extends GetReservationCover * * *

To determine valid values for a dimension, use the GetDimensionValues operation.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { CostExplorerClient, GetReservationCoverageCommand } from "@aws-sdk/client-cost-explorer"; // ES Modules import + * // const { CostExplorerClient, GetReservationCoverageCommand } = require("@aws-sdk/client-cost-explorer"); // CommonJS import + * const client = new CostExplorerClient(config); + * const command = new GetReservationCoverageCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetReservationCoverageCommandInput} for command's `input` shape. + * @see {@link GetReservationCoverageCommandOutput} for command's `response` shape. + * @see {@link CostExplorerClientResolvedConfig | config} for command's `input` shape. + * */ export class GetReservationCoverageCommand extends $Command< GetReservationCoverageCommandInput, diff --git a/clients/client-cost-explorer/commands/GetReservationPurchaseRecommendationCommand.ts b/clients/client-cost-explorer/commands/GetReservationPurchaseRecommendationCommand.ts index 797f4a485e3b..5fd220596453 100644 --- a/clients/client-cost-explorer/commands/GetReservationPurchaseRecommendationCommand.ts +++ b/clients/client-cost-explorer/commands/GetReservationPurchaseRecommendationCommand.ts @@ -36,6 +36,20 @@ export interface GetReservationPurchaseRecommendationCommandOutput * in an instance family. This makes it easier to purchase a size-flexible RI. AWS also shows the equal number of normalized units * so that you can purchase any instance size that you want. For this example, your RI recommendation would be for c4.large * because that is the smallest size instance in the c4 instance family.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { CostExplorerClient, GetReservationPurchaseRecommendationCommand } from "@aws-sdk/client-cost-explorer"; // ES Modules import + * // const { CostExplorerClient, GetReservationPurchaseRecommendationCommand } = require("@aws-sdk/client-cost-explorer"); // CommonJS import + * const client = new CostExplorerClient(config); + * const command = new GetReservationPurchaseRecommendationCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetReservationPurchaseRecommendationCommandInput} for command's `input` shape. + * @see {@link GetReservationPurchaseRecommendationCommandOutput} for command's `response` shape. + * @see {@link CostExplorerClientResolvedConfig | config} for command's `input` shape. + * */ export class GetReservationPurchaseRecommendationCommand extends $Command< GetReservationPurchaseRecommendationCommandInput, diff --git a/clients/client-cost-explorer/commands/GetReservationUtilizationCommand.ts b/clients/client-cost-explorer/commands/GetReservationUtilizationCommand.ts index e964914666d3..df0fd6b8a270 100644 --- a/clients/client-cost-explorer/commands/GetReservationUtilizationCommand.ts +++ b/clients/client-cost-explorer/commands/GetReservationUtilizationCommand.ts @@ -24,6 +24,20 @@ export interface GetReservationUtilizationCommandOutput extends GetReservationUt *

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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { CostExplorerClient, GetReservationUtilizationCommand } from "@aws-sdk/client-cost-explorer"; // ES Modules import + * // const { CostExplorerClient, GetReservationUtilizationCommand } = require("@aws-sdk/client-cost-explorer"); // CommonJS import + * const client = new CostExplorerClient(config); + * const command = new GetReservationUtilizationCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetReservationUtilizationCommandInput} for command's `input` shape. + * @see {@link GetReservationUtilizationCommandOutput} for command's `response` shape. + * @see {@link CostExplorerClientResolvedConfig | config} for command's `input` shape. + * */ export class GetReservationUtilizationCommand extends $Command< GetReservationUtilizationCommandInput, diff --git a/clients/client-cost-explorer/commands/GetRightsizingRecommendationCommand.ts b/clients/client-cost-explorer/commands/GetRightsizingRecommendationCommand.ts index da35e23892ae..e56b97ccdbea 100644 --- a/clients/client-cost-explorer/commands/GetRightsizingRecommendationCommand.ts +++ b/clients/client-cost-explorer/commands/GetRightsizingRecommendationCommand.ts @@ -33,6 +33,20 @@ export interface GetRightsizingRecommendationCommandOutput * Recommendations * in the AWS Billing and Cost Management User * Guide.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { CostExplorerClient, GetRightsizingRecommendationCommand } from "@aws-sdk/client-cost-explorer"; // ES Modules import + * // const { CostExplorerClient, GetRightsizingRecommendationCommand } = require("@aws-sdk/client-cost-explorer"); // CommonJS import + * const client = new CostExplorerClient(config); + * const command = new GetRightsizingRecommendationCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetRightsizingRecommendationCommandInput} for command's `input` shape. + * @see {@link GetRightsizingRecommendationCommandOutput} for command's `response` shape. + * @see {@link CostExplorerClientResolvedConfig | config} for command's `input` shape. + * */ export class GetRightsizingRecommendationCommand extends $Command< GetRightsizingRecommendationCommandInput, diff --git a/clients/client-cost-explorer/commands/GetSavingsPlansCoverageCommand.ts b/clients/client-cost-explorer/commands/GetSavingsPlansCoverageCommand.ts index 36a1c3da7e2d..5a7676c28d46 100644 --- a/clients/client-cost-explorer/commands/GetSavingsPlansCoverageCommand.ts +++ b/clients/client-cost-explorer/commands/GetSavingsPlansCoverageCommand.ts @@ -45,6 +45,20 @@ export interface GetSavingsPlansCoverageCommandOutput extends GetSavingsPlansCov * * *

To determine valid values for a dimension, use the GetDimensionValues operation.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { CostExplorerClient, GetSavingsPlansCoverageCommand } from "@aws-sdk/client-cost-explorer"; // ES Modules import + * // const { CostExplorerClient, GetSavingsPlansCoverageCommand } = require("@aws-sdk/client-cost-explorer"); // CommonJS import + * const client = new CostExplorerClient(config); + * const command = new GetSavingsPlansCoverageCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetSavingsPlansCoverageCommandInput} for command's `input` shape. + * @see {@link GetSavingsPlansCoverageCommandOutput} for command's `response` shape. + * @see {@link CostExplorerClientResolvedConfig | config} for command's `input` shape. + * */ export class GetSavingsPlansCoverageCommand extends $Command< GetSavingsPlansCoverageCommandInput, diff --git a/clients/client-cost-explorer/commands/GetSavingsPlansPurchaseRecommendationCommand.ts b/clients/client-cost-explorer/commands/GetSavingsPlansPurchaseRecommendationCommand.ts index 694841808f10..a4186ccde607 100644 --- a/clients/client-cost-explorer/commands/GetSavingsPlansPurchaseRecommendationCommand.ts +++ b/clients/client-cost-explorer/commands/GetSavingsPlansPurchaseRecommendationCommand.ts @@ -28,6 +28,20 @@ export interface GetSavingsPlansPurchaseRecommendationCommandOutput /** *

Retrieves your request parameters, Savings Plan Recommendations Summary and Details.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { CostExplorerClient, GetSavingsPlansPurchaseRecommendationCommand } from "@aws-sdk/client-cost-explorer"; // ES Modules import + * // const { CostExplorerClient, GetSavingsPlansPurchaseRecommendationCommand } = require("@aws-sdk/client-cost-explorer"); // CommonJS import + * const client = new CostExplorerClient(config); + * const command = new GetSavingsPlansPurchaseRecommendationCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetSavingsPlansPurchaseRecommendationCommandInput} for command's `input` shape. + * @see {@link GetSavingsPlansPurchaseRecommendationCommandOutput} for command's `response` shape. + * @see {@link CostExplorerClientResolvedConfig | config} for command's `input` shape. + * */ export class GetSavingsPlansPurchaseRecommendationCommand extends $Command< GetSavingsPlansPurchaseRecommendationCommandInput, diff --git a/clients/client-cost-explorer/commands/GetSavingsPlansUtilizationCommand.ts b/clients/client-cost-explorer/commands/GetSavingsPlansUtilizationCommand.ts index f853c9195922..0138d2b83f98 100644 --- a/clients/client-cost-explorer/commands/GetSavingsPlansUtilizationCommand.ts +++ b/clients/client-cost-explorer/commands/GetSavingsPlansUtilizationCommand.ts @@ -25,6 +25,20 @@ export interface GetSavingsPlansUtilizationCommandOutput extends GetSavingsPlans * *

You cannot group by any dimension values for GetSavingsPlansUtilization.

* + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { CostExplorerClient, GetSavingsPlansUtilizationCommand } from "@aws-sdk/client-cost-explorer"; // ES Modules import + * // const { CostExplorerClient, GetSavingsPlansUtilizationCommand } = require("@aws-sdk/client-cost-explorer"); // CommonJS import + * const client = new CostExplorerClient(config); + * const command = new GetSavingsPlansUtilizationCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetSavingsPlansUtilizationCommandInput} for command's `input` shape. + * @see {@link GetSavingsPlansUtilizationCommandOutput} for command's `response` shape. + * @see {@link CostExplorerClientResolvedConfig | config} for command's `input` shape. + * */ export class GetSavingsPlansUtilizationCommand extends $Command< GetSavingsPlansUtilizationCommandInput, diff --git a/clients/client-cost-explorer/commands/GetSavingsPlansUtilizationDetailsCommand.ts b/clients/client-cost-explorer/commands/GetSavingsPlansUtilizationDetailsCommand.ts index 6cc4068f304c..de15c370a565 100644 --- a/clients/client-cost-explorer/commands/GetSavingsPlansUtilizationDetailsCommand.ts +++ b/clients/client-cost-explorer/commands/GetSavingsPlansUtilizationDetailsCommand.ts @@ -31,6 +31,20 @@ export interface GetSavingsPlansUtilizationDetailsCommandOutput *

* GetSavingsPlanUtilizationDetails internally groups data by SavingsPlansArn.

* + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { CostExplorerClient, GetSavingsPlansUtilizationDetailsCommand } from "@aws-sdk/client-cost-explorer"; // ES Modules import + * // const { CostExplorerClient, GetSavingsPlansUtilizationDetailsCommand } = require("@aws-sdk/client-cost-explorer"); // CommonJS import + * const client = new CostExplorerClient(config); + * const command = new GetSavingsPlansUtilizationDetailsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetSavingsPlansUtilizationDetailsCommandInput} for command's `input` shape. + * @see {@link GetSavingsPlansUtilizationDetailsCommandOutput} for command's `response` shape. + * @see {@link CostExplorerClientResolvedConfig | config} for command's `input` shape. + * */ export class GetSavingsPlansUtilizationDetailsCommand extends $Command< GetSavingsPlansUtilizationDetailsCommandInput, diff --git a/clients/client-cost-explorer/commands/GetTagsCommand.ts b/clients/client-cost-explorer/commands/GetTagsCommand.ts index 5ee136b70a96..bfdeac939c4b 100644 --- a/clients/client-cost-explorer/commands/GetTagsCommand.ts +++ b/clients/client-cost-explorer/commands/GetTagsCommand.ts @@ -19,6 +19,20 @@ export interface GetTagsCommandOutput extends GetTagsResponse, __MetadataBearer /** *

Queries for available tag keys and tag values for a specified period. You can search the tag values for an arbitrary string.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { CostExplorerClient, GetTagsCommand } from "@aws-sdk/client-cost-explorer"; // ES Modules import + * // const { CostExplorerClient, GetTagsCommand } = require("@aws-sdk/client-cost-explorer"); // CommonJS import + * const client = new CostExplorerClient(config); + * const command = new GetTagsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetTagsCommandInput} for command's `input` shape. + * @see {@link GetTagsCommandOutput} for command's `response` shape. + * @see {@link CostExplorerClientResolvedConfig | config} for command's `input` shape. + * */ export class GetTagsCommand extends $Command< GetTagsCommandInput, diff --git a/clients/client-cost-explorer/commands/GetUsageForecastCommand.ts b/clients/client-cost-explorer/commands/GetUsageForecastCommand.ts index c1f6e699b7ba..cdbe6b37d400 100644 --- a/clients/client-cost-explorer/commands/GetUsageForecastCommand.ts +++ b/clients/client-cost-explorer/commands/GetUsageForecastCommand.ts @@ -22,6 +22,20 @@ export interface GetUsageForecastCommandOutput extends GetUsageForecastResponse, /** *

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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { CostExplorerClient, GetUsageForecastCommand } from "@aws-sdk/client-cost-explorer"; // ES Modules import + * // const { CostExplorerClient, GetUsageForecastCommand } = require("@aws-sdk/client-cost-explorer"); // CommonJS import + * const client = new CostExplorerClient(config); + * const command = new GetUsageForecastCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetUsageForecastCommandInput} for command's `input` shape. + * @see {@link GetUsageForecastCommandOutput} for command's `response` shape. + * @see {@link CostExplorerClientResolvedConfig | config} for command's `input` shape. + * */ export class GetUsageForecastCommand extends $Command< GetUsageForecastCommandInput, diff --git a/clients/client-cost-explorer/commands/ListCostCategoryDefinitionsCommand.ts b/clients/client-cost-explorer/commands/ListCostCategoryDefinitionsCommand.ts index 4ffbb10bfd22..ef5407d34329 100644 --- a/clients/client-cost-explorer/commands/ListCostCategoryDefinitionsCommand.ts +++ b/clients/client-cost-explorer/commands/ListCostCategoryDefinitionsCommand.ts @@ -24,6 +24,20 @@ export interface ListCostCategoryDefinitionsCommandOutput /** *

Returns the 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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { CostExplorerClient, ListCostCategoryDefinitionsCommand } from "@aws-sdk/client-cost-explorer"; // ES Modules import + * // const { CostExplorerClient, ListCostCategoryDefinitionsCommand } = require("@aws-sdk/client-cost-explorer"); // CommonJS import + * const client = new CostExplorerClient(config); + * const command = new ListCostCategoryDefinitionsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListCostCategoryDefinitionsCommandInput} for command's `input` shape. + * @see {@link ListCostCategoryDefinitionsCommandOutput} for command's `response` shape. + * @see {@link CostExplorerClientResolvedConfig | config} for command's `input` shape. + * */ export class ListCostCategoryDefinitionsCommand extends $Command< ListCostCategoryDefinitionsCommandInput, diff --git a/clients/client-cost-explorer/commands/ProvideAnomalyFeedbackCommand.ts b/clients/client-cost-explorer/commands/ProvideAnomalyFeedbackCommand.ts index 907319813bef..7fb4d973aaa6 100644 --- a/clients/client-cost-explorer/commands/ProvideAnomalyFeedbackCommand.ts +++ b/clients/client-cost-explorer/commands/ProvideAnomalyFeedbackCommand.ts @@ -22,6 +22,20 @@ export interface ProvideAnomalyFeedbackCommandOutput extends ProvideAnomalyFeedb /** *

Modifies the feedback property of a given cost anomaly.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { CostExplorerClient, ProvideAnomalyFeedbackCommand } from "@aws-sdk/client-cost-explorer"; // ES Modules import + * // const { CostExplorerClient, ProvideAnomalyFeedbackCommand } = require("@aws-sdk/client-cost-explorer"); // CommonJS import + * const client = new CostExplorerClient(config); + * const command = new ProvideAnomalyFeedbackCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ProvideAnomalyFeedbackCommandInput} for command's `input` shape. + * @see {@link ProvideAnomalyFeedbackCommandOutput} for command's `response` shape. + * @see {@link CostExplorerClientResolvedConfig | config} for command's `input` shape. + * */ export class ProvideAnomalyFeedbackCommand extends $Command< ProvideAnomalyFeedbackCommandInput, diff --git a/clients/client-cost-explorer/commands/UpdateAnomalyMonitorCommand.ts b/clients/client-cost-explorer/commands/UpdateAnomalyMonitorCommand.ts index c201160ad13b..56501dbb1809 100644 --- a/clients/client-cost-explorer/commands/UpdateAnomalyMonitorCommand.ts +++ b/clients/client-cost-explorer/commands/UpdateAnomalyMonitorCommand.ts @@ -23,6 +23,20 @@ export interface UpdateAnomalyMonitorCommandOutput extends UpdateAnomalyMonitorR /** *

Updates an existing cost anomaly monitor. The changes made are applied going forward, and * does not change anomalies detected in the past.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { CostExplorerClient, UpdateAnomalyMonitorCommand } from "@aws-sdk/client-cost-explorer"; // ES Modules import + * // const { CostExplorerClient, UpdateAnomalyMonitorCommand } = require("@aws-sdk/client-cost-explorer"); // CommonJS import + * const client = new CostExplorerClient(config); + * const command = new UpdateAnomalyMonitorCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link UpdateAnomalyMonitorCommandInput} for command's `input` shape. + * @see {@link UpdateAnomalyMonitorCommandOutput} for command's `response` shape. + * @see {@link CostExplorerClientResolvedConfig | config} for command's `input` shape. + * */ export class UpdateAnomalyMonitorCommand extends $Command< UpdateAnomalyMonitorCommandInput, diff --git a/clients/client-cost-explorer/commands/UpdateAnomalySubscriptionCommand.ts b/clients/client-cost-explorer/commands/UpdateAnomalySubscriptionCommand.ts index 331b8b757451..e4b67d2f351f 100644 --- a/clients/client-cost-explorer/commands/UpdateAnomalySubscriptionCommand.ts +++ b/clients/client-cost-explorer/commands/UpdateAnomalySubscriptionCommand.ts @@ -22,6 +22,20 @@ export interface UpdateAnomalySubscriptionCommandOutput extends UpdateAnomalySub /** *

Updates an existing cost anomaly monitor subscription.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { CostExplorerClient, UpdateAnomalySubscriptionCommand } from "@aws-sdk/client-cost-explorer"; // ES Modules import + * // const { CostExplorerClient, UpdateAnomalySubscriptionCommand } = require("@aws-sdk/client-cost-explorer"); // CommonJS import + * const client = new CostExplorerClient(config); + * const command = new UpdateAnomalySubscriptionCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link UpdateAnomalySubscriptionCommandInput} for command's `input` shape. + * @see {@link UpdateAnomalySubscriptionCommandOutput} for command's `response` shape. + * @see {@link CostExplorerClientResolvedConfig | config} for command's `input` shape. + * */ export class UpdateAnomalySubscriptionCommand extends $Command< UpdateAnomalySubscriptionCommandInput, diff --git a/clients/client-cost-explorer/commands/UpdateCostCategoryDefinitionCommand.ts b/clients/client-cost-explorer/commands/UpdateCostCategoryDefinitionCommand.ts index 2135d98183db..6cfa9cfcefd0 100644 --- a/clients/client-cost-explorer/commands/UpdateCostCategoryDefinitionCommand.ts +++ b/clients/client-cost-explorer/commands/UpdateCostCategoryDefinitionCommand.ts @@ -24,6 +24,20 @@ export interface UpdateCostCategoryDefinitionCommandOutput /** *

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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { CostExplorerClient, UpdateCostCategoryDefinitionCommand } from "@aws-sdk/client-cost-explorer"; // ES Modules import + * // const { CostExplorerClient, UpdateCostCategoryDefinitionCommand } = require("@aws-sdk/client-cost-explorer"); // CommonJS import + * const client = new CostExplorerClient(config); + * const command = new UpdateCostCategoryDefinitionCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link UpdateCostCategoryDefinitionCommandInput} for command's `input` shape. + * @see {@link UpdateCostCategoryDefinitionCommandOutput} for command's `response` shape. + * @see {@link CostExplorerClientResolvedConfig | config} for command's `input` shape. + * */ export class UpdateCostCategoryDefinitionCommand extends $Command< UpdateCostCategoryDefinitionCommandInput, diff --git a/clients/client-cost-explorer/models/models_0.ts b/clients/client-cost-explorer/models/models_0.ts index 3c448bb26071..24cf8e431f0b 100644 --- a/clients/client-cost-explorer/models/models_0.ts +++ b/clients/client-cost-explorer/models/models_0.ts @@ -26,6 +26,9 @@ export interface AnomalyScore { } export namespace AnomalyScore { + /** + * @internal + */ export const filterSensitiveLog = (obj: AnomalyScore): any => ({ ...obj, }); @@ -59,6 +62,9 @@ export interface Impact { } export namespace Impact { + /** + * @internal + */ export const filterSensitiveLog = (obj: Impact): any => ({ ...obj, }); @@ -100,6 +106,9 @@ export interface RootCause { } export namespace RootCause { + /** + * @internal + */ export const filterSensitiveLog = (obj: RootCause): any => ({ ...obj, }); @@ -174,6 +183,9 @@ export interface Anomaly { } export namespace Anomaly { + /** + * @internal + */ export const filterSensitiveLog = (obj: Anomaly): any => ({ ...obj, }); @@ -201,6 +213,9 @@ export interface AnomalyDateInterval { } export namespace AnomalyDateInterval { + /** + * @internal + */ export const filterSensitiveLog = (obj: AnomalyDateInterval): any => ({ ...obj, }); @@ -247,6 +262,9 @@ export interface CostCategoryValues { } export namespace CostCategoryValues { + /** + * @internal + */ export const filterSensitiveLog = (obj: CostCategoryValues): any => ({ ...obj, }); @@ -313,6 +331,9 @@ export interface DimensionValues { } export namespace DimensionValues { + /** + * @internal + */ export const filterSensitiveLog = (obj: DimensionValues): any => ({ ...obj, }); @@ -346,6 +367,9 @@ export interface TagValues { } export namespace TagValues { + /** + * @internal + */ export const filterSensitiveLog = (obj: TagValues): any => ({ ...obj, }); @@ -397,6 +421,9 @@ export interface Subscriber { } export namespace Subscriber { + /** + * @internal + */ export const filterSensitiveLog = (obj: Subscriber): any => ({ ...obj, }); @@ -457,6 +484,9 @@ export interface AnomalySubscription { } export namespace AnomalySubscription { + /** + * @internal + */ export const filterSensitiveLog = (obj: AnomalySubscription): any => ({ ...obj, }); @@ -470,6 +500,9 @@ export interface CreateAnomalyMonitorResponse { } export namespace CreateAnomalyMonitorResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateAnomalyMonitorResponse): any => ({ ...obj, }); @@ -485,6 +518,9 @@ export interface LimitExceededException extends __SmithyException, $MetadataBear } export namespace LimitExceededException { + /** + * @internal + */ export const filterSensitiveLog = (obj: LimitExceededException): any => ({ ...obj, }); @@ -500,6 +536,9 @@ export interface CreateAnomalySubscriptionRequest { } export namespace CreateAnomalySubscriptionRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateAnomalySubscriptionRequest): any => ({ ...obj, }); @@ -515,6 +554,9 @@ export interface CreateAnomalySubscriptionResponse { } export namespace CreateAnomalySubscriptionResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateAnomalySubscriptionResponse): any => ({ ...obj, }); @@ -531,6 +573,9 @@ export interface UnknownMonitorException extends __SmithyException, $MetadataBea } export namespace UnknownMonitorException { + /** + * @internal + */ export const filterSensitiveLog = (obj: UnknownMonitorException): any => ({ ...obj, }); @@ -558,6 +603,9 @@ export interface CostCategoryInheritedValueDimension { } export namespace CostCategoryInheritedValueDimension { + /** + * @internal + */ export const filterSensitiveLog = (obj: CostCategoryInheritedValueDimension): any => ({ ...obj, }); @@ -589,6 +637,9 @@ export interface CreateCostCategoryDefinitionResponse { } export namespace CreateCostCategoryDefinitionResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateCostCategoryDefinitionResponse): any => ({ ...obj, }); @@ -605,6 +656,9 @@ export interface ServiceQuotaExceededException extends __SmithyException, $Metad } export namespace ServiceQuotaExceededException { + /** + * @internal + */ export const filterSensitiveLog = (obj: ServiceQuotaExceededException): any => ({ ...obj, }); @@ -618,6 +672,9 @@ export interface DeleteAnomalyMonitorRequest { } export namespace DeleteAnomalyMonitorRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteAnomalyMonitorRequest): any => ({ ...obj, }); @@ -626,6 +683,9 @@ export namespace DeleteAnomalyMonitorRequest { export interface DeleteAnomalyMonitorResponse {} export namespace DeleteAnomalyMonitorResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteAnomalyMonitorResponse): any => ({ ...obj, }); @@ -639,6 +699,9 @@ export interface DeleteAnomalySubscriptionRequest { } export namespace DeleteAnomalySubscriptionRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteAnomalySubscriptionRequest): any => ({ ...obj, }); @@ -647,6 +710,9 @@ export namespace DeleteAnomalySubscriptionRequest { export interface DeleteAnomalySubscriptionResponse {} export namespace DeleteAnomalySubscriptionResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteAnomalySubscriptionResponse): any => ({ ...obj, }); @@ -663,6 +729,9 @@ export interface UnknownSubscriptionException extends __SmithyException, $Metada } export namespace UnknownSubscriptionException { + /** + * @internal + */ export const filterSensitiveLog = (obj: UnknownSubscriptionException): any => ({ ...obj, }); @@ -678,6 +747,9 @@ export interface DeleteCostCategoryDefinitionRequest { } export namespace DeleteCostCategoryDefinitionRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteCostCategoryDefinitionRequest): any => ({ ...obj, }); @@ -700,6 +772,9 @@ export interface DeleteCostCategoryDefinitionResponse { } export namespace DeleteCostCategoryDefinitionResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteCostCategoryDefinitionResponse): any => ({ ...obj, }); @@ -717,6 +792,9 @@ export interface ResourceNotFoundException extends __SmithyException, $MetadataB } export namespace ResourceNotFoundException { + /** + * @internal + */ export const filterSensitiveLog = (obj: ResourceNotFoundException): any => ({ ...obj, }); @@ -739,6 +817,9 @@ export interface DescribeCostCategoryDefinitionRequest { } export namespace DescribeCostCategoryDefinitionRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeCostCategoryDefinitionRequest): any => ({ ...obj, }); @@ -775,6 +856,9 @@ export interface CostCategoryProcessingStatus { } export namespace CostCategoryProcessingStatus { + /** + * @internal + */ export const filterSensitiveLog = (obj: CostCategoryProcessingStatus): any => ({ ...obj, }); @@ -814,6 +898,9 @@ export interface TotalImpactFilter { } export namespace TotalImpactFilter { + /** + * @internal + */ export const filterSensitiveLog = (obj: TotalImpactFilter): any => ({ ...obj, }); @@ -860,6 +947,9 @@ export interface GetAnomaliesRequest { } export namespace GetAnomaliesRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetAnomaliesRequest): any => ({ ...obj, }); @@ -882,6 +972,9 @@ export interface GetAnomaliesResponse { } export namespace GetAnomaliesResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetAnomaliesResponse): any => ({ ...obj, }); @@ -897,6 +990,9 @@ export interface InvalidNextTokenException extends __SmithyException, $MetadataB } export namespace InvalidNextTokenException { + /** + * @internal + */ export const filterSensitiveLog = (obj: InvalidNextTokenException): any => ({ ...obj, }); @@ -926,6 +1022,9 @@ export interface GetAnomalyMonitorsRequest { } export namespace GetAnomalyMonitorsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetAnomalyMonitorsRequest): any => ({ ...obj, }); @@ -962,6 +1061,9 @@ export interface GetAnomalySubscriptionsRequest { } export namespace GetAnomalySubscriptionsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetAnomalySubscriptionsRequest): any => ({ ...obj, }); @@ -984,6 +1086,9 @@ export interface GetAnomalySubscriptionsResponse { } export namespace GetAnomalySubscriptionsResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetAnomalySubscriptionsResponse): any => ({ ...obj, }); @@ -999,6 +1104,9 @@ export interface BillExpirationException extends __SmithyException, $MetadataBea } export namespace BillExpirationException { + /** + * @internal + */ export const filterSensitiveLog = (obj: BillExpirationException): any => ({ ...obj, }); @@ -1014,6 +1122,9 @@ export interface DataUnavailableException extends __SmithyException, $MetadataBe } export namespace DataUnavailableException { + /** + * @internal + */ export const filterSensitiveLog = (obj: DataUnavailableException): any => ({ ...obj, }); @@ -1048,6 +1159,9 @@ export interface GroupDefinition { } export namespace GroupDefinition { + /** + * @internal + */ export const filterSensitiveLog = (obj: GroupDefinition): any => ({ ...obj, }); @@ -1076,6 +1190,9 @@ export interface DateInterval { } export namespace DateInterval { + /** + * @internal + */ export const filterSensitiveLog = (obj: DateInterval): any => ({ ...obj, }); @@ -1098,6 +1215,9 @@ export interface DimensionValuesWithAttributes { } export namespace DimensionValuesWithAttributes { + /** + * @internal + */ export const filterSensitiveLog = (obj: DimensionValuesWithAttributes): any => ({ ...obj, }); @@ -1119,6 +1239,9 @@ export interface MetricValue { } export namespace MetricValue { + /** + * @internal + */ export const filterSensitiveLog = (obj: MetricValue): any => ({ ...obj, }); @@ -1140,6 +1263,9 @@ export interface Group { } export namespace Group { + /** + * @internal + */ export const filterSensitiveLog = (obj: Group): any => ({ ...obj, }); @@ -1172,6 +1298,9 @@ export interface ResultByTime { } export namespace ResultByTime { + /** + * @internal + */ export const filterSensitiveLog = (obj: ResultByTime): any => ({ ...obj, }); @@ -1200,6 +1329,9 @@ export interface GetCostAndUsageResponse { } export namespace GetCostAndUsageResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetCostAndUsageResponse): any => ({ ...obj, }); @@ -1216,6 +1348,9 @@ export interface RequestChangedException extends __SmithyException, $MetadataBea } export namespace RequestChangedException { + /** + * @internal + */ export const filterSensitiveLog = (obj: RequestChangedException): any => ({ ...obj, }); @@ -1245,6 +1380,9 @@ export interface GetCostAndUsageWithResourcesResponse { } export namespace GetCostAndUsageWithResourcesResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetCostAndUsageWithResourcesResponse): any => ({ ...obj, }); @@ -1271,6 +1409,9 @@ export interface SortDefinition { } export namespace SortDefinition { + /** + * @internal + */ export const filterSensitiveLog = (obj: SortDefinition): any => ({ ...obj, }); @@ -1306,6 +1447,9 @@ export interface GetCostCategoriesResponse { } export namespace GetCostCategoriesResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetCostCategoriesResponse): any => ({ ...obj, }); @@ -1347,6 +1491,9 @@ export interface ForecastResult { } export namespace ForecastResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: ForecastResult): any => ({ ...obj, }); @@ -1366,6 +1513,9 @@ export interface GetCostForecastResponse { } export namespace GetCostForecastResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetCostForecastResponse): any => ({ ...obj, }); @@ -1507,6 +1657,9 @@ export interface GetDimensionValuesResponse { } export namespace GetDimensionValuesResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetDimensionValuesResponse): any => ({ ...obj, }); @@ -1523,6 +1676,9 @@ export interface CoverageCost { } export namespace CoverageCost { + /** + * @internal + */ export const filterSensitiveLog = (obj: CoverageCost): any => ({ ...obj, }); @@ -1554,6 +1710,9 @@ export interface CoverageHours { } export namespace CoverageHours { + /** + * @internal + */ export const filterSensitiveLog = (obj: CoverageHours): any => ({ ...obj, }); @@ -1595,6 +1754,9 @@ export interface CoverageNormalizedUnits { } export namespace CoverageNormalizedUnits { + /** + * @internal + */ export const filterSensitiveLog = (obj: CoverageNormalizedUnits): any => ({ ...obj, }); @@ -1622,6 +1784,9 @@ export interface Coverage { } export namespace Coverage { + /** + * @internal + */ export const filterSensitiveLog = (obj: Coverage): any => ({ ...obj, }); @@ -1644,6 +1809,9 @@ export interface ReservationCoverageGroup { } export namespace ReservationCoverageGroup { + /** + * @internal + */ export const filterSensitiveLog = (obj: ReservationCoverageGroup): any => ({ ...obj, }); @@ -1672,6 +1840,9 @@ export interface CoverageByTime { } export namespace CoverageByTime { + /** + * @internal + */ export const filterSensitiveLog = (obj: CoverageByTime): any => ({ ...obj, }); @@ -1695,6 +1866,9 @@ export interface GetReservationCoverageResponse { } export namespace GetReservationCoverageResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetReservationCoverageResponse): any => ({ ...obj, }); @@ -1733,6 +1907,9 @@ export interface EC2Specification { } export namespace EC2Specification { + /** + * @internal + */ export const filterSensitiveLog = (obj: EC2Specification): any => ({ ...obj, }); @@ -1751,6 +1928,9 @@ export interface ServiceSpecification { } export namespace ServiceSpecification { + /** + * @internal + */ export const filterSensitiveLog = (obj: ServiceSpecification): any => ({ ...obj, }); @@ -1778,6 +1958,9 @@ export interface ReservationPurchaseRecommendationMetadata { } export namespace ReservationPurchaseRecommendationMetadata { + /** + * @internal + */ export const filterSensitiveLog = (obj: ReservationPurchaseRecommendationMetadata): any => ({ ...obj, }); @@ -1830,6 +2013,9 @@ export interface EC2InstanceDetails { } export namespace EC2InstanceDetails { + /** + * @internal + */ export const filterSensitiveLog = (obj: EC2InstanceDetails): any => ({ ...obj, }); @@ -1872,6 +2058,9 @@ export interface ElastiCacheInstanceDetails { } export namespace ElastiCacheInstanceDetails { + /** + * @internal + */ export const filterSensitiveLog = (obj: ElastiCacheInstanceDetails): any => ({ ...obj, }); @@ -1909,6 +2098,9 @@ export interface ESInstanceDetails { } export namespace ESInstanceDetails { + /** + * @internal + */ export const filterSensitiveLog = (obj: ESInstanceDetails): any => ({ ...obj, }); @@ -1967,6 +2159,9 @@ export interface RDSInstanceDetails { } export namespace RDSInstanceDetails { + /** + * @internal + */ export const filterSensitiveLog = (obj: RDSInstanceDetails): any => ({ ...obj, }); @@ -2004,6 +2199,9 @@ export interface RedshiftInstanceDetails { } export namespace RedshiftInstanceDetails { + /** + * @internal + */ export const filterSensitiveLog = (obj: RedshiftInstanceDetails): any => ({ ...obj, }); @@ -2040,6 +2238,9 @@ export interface InstanceDetails { } export namespace InstanceDetails { + /** + * @internal + */ export const filterSensitiveLog = (obj: InstanceDetails): any => ({ ...obj, }); @@ -2162,6 +2363,9 @@ export interface ReservationPurchaseRecommendationDetail { } export namespace ReservationPurchaseRecommendationDetail { + /** + * @internal + */ export const filterSensitiveLog = (obj: ReservationPurchaseRecommendationDetail): any => ({ ...obj, }); @@ -2192,6 +2396,9 @@ export interface ReservationPurchaseRecommendationSummary { } export namespace ReservationPurchaseRecommendationSummary { + /** + * @internal + */ export const filterSensitiveLog = (obj: ReservationPurchaseRecommendationSummary): any => ({ ...obj, }); @@ -2243,6 +2450,9 @@ export interface ReservationPurchaseRecommendation { } export namespace ReservationPurchaseRecommendation { + /** + * @internal + */ export const filterSensitiveLog = (obj: ReservationPurchaseRecommendation): any => ({ ...obj, }); @@ -2266,6 +2476,9 @@ export interface GetReservationPurchaseRecommendationResponse { } export namespace GetReservationPurchaseRecommendationResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetReservationPurchaseRecommendationResponse): any => ({ ...obj, }); @@ -2374,6 +2587,9 @@ export interface ReservationAggregates { } export namespace ReservationAggregates { + /** + * @internal + */ export const filterSensitiveLog = (obj: ReservationAggregates): any => ({ ...obj, }); @@ -2405,6 +2621,9 @@ export interface ReservationUtilizationGroup { } export namespace ReservationUtilizationGroup { + /** + * @internal + */ export const filterSensitiveLog = (obj: ReservationUtilizationGroup): any => ({ ...obj, }); @@ -2431,6 +2650,9 @@ export interface UtilizationByTime { } export namespace UtilizationByTime { + /** + * @internal + */ export const filterSensitiveLog = (obj: UtilizationByTime): any => ({ ...obj, }); @@ -2454,6 +2676,9 @@ export interface GetReservationUtilizationResponse { } export namespace GetReservationUtilizationResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetReservationUtilizationResponse): any => ({ ...obj, }); @@ -2488,6 +2713,9 @@ export interface RightsizingRecommendationConfiguration { } export namespace RightsizingRecommendationConfiguration { + /** + * @internal + */ export const filterSensitiveLog = (obj: RightsizingRecommendationConfiguration): any => ({ ...obj, }); @@ -2520,6 +2748,9 @@ export interface RightsizingRecommendationMetadata { } export namespace RightsizingRecommendationMetadata { + /** + * @internal + */ export const filterSensitiveLog = (obj: RightsizingRecommendationMetadata): any => ({ ...obj, }); @@ -2577,6 +2808,9 @@ export interface EC2ResourceDetails { } export namespace EC2ResourceDetails { + /** + * @internal + */ export const filterSensitiveLog = (obj: EC2ResourceDetails): any => ({ ...obj, }); @@ -2593,6 +2827,9 @@ export interface ResourceDetails { } export namespace ResourceDetails { + /** + * @internal + */ export const filterSensitiveLog = (obj: ResourceDetails): any => ({ ...obj, }); @@ -2634,6 +2871,9 @@ export interface EBSResourceUtilization { } export namespace EBSResourceUtilization { + /** + * @internal + */ export const filterSensitiveLog = (obj: EBSResourceUtilization): any => ({ ...obj, }); @@ -2667,6 +2907,9 @@ export interface EC2ResourceUtilization { } export namespace EC2ResourceUtilization { + /** + * @internal + */ export const filterSensitiveLog = (obj: EC2ResourceUtilization): any => ({ ...obj, }); @@ -2683,6 +2926,9 @@ export interface ResourceUtilization { } export namespace ResourceUtilization { + /** + * @internal + */ export const filterSensitiveLog = (obj: ResourceUtilization): any => ({ ...obj, }); @@ -2749,6 +2995,9 @@ export interface CurrentInstance { } export namespace CurrentInstance { + /** + * @internal + */ export const filterSensitiveLog = (obj: CurrentInstance): any => ({ ...obj, }); @@ -2790,6 +3039,9 @@ export interface TargetInstance { } export namespace TargetInstance { + /** + * @internal + */ export const filterSensitiveLog = (obj: TargetInstance): any => ({ ...obj, }); @@ -2806,6 +3058,9 @@ export interface ModifyRecommendationDetail { } export namespace ModifyRecommendationDetail { + /** + * @internal + */ export const filterSensitiveLog = (obj: ModifyRecommendationDetail): any => ({ ...obj, }); @@ -2832,6 +3087,9 @@ export interface TerminateRecommendationDetail { } export namespace TerminateRecommendationDetail { + /** + * @internal + */ export const filterSensitiveLog = (obj: TerminateRecommendationDetail): any => ({ ...obj, }); @@ -2868,6 +3126,9 @@ export interface RightsizingRecommendation { } export namespace RightsizingRecommendation { + /** + * @internal + */ export const filterSensitiveLog = (obj: RightsizingRecommendation): any => ({ ...obj, }); @@ -2901,6 +3162,9 @@ export interface RightsizingRecommendationSummary { } export namespace RightsizingRecommendationSummary { + /** + * @internal + */ export const filterSensitiveLog = (obj: RightsizingRecommendationSummary): any => ({ ...obj, }); @@ -2938,6 +3202,9 @@ export interface GetRightsizingRecommendationResponse { } export namespace GetRightsizingRecommendationResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetRightsizingRecommendationResponse): any => ({ ...obj, }); @@ -2970,6 +3237,9 @@ export interface SavingsPlansCoverageData { } export namespace SavingsPlansCoverageData { + /** + * @internal + */ export const filterSensitiveLog = (obj: SavingsPlansCoverageData): any => ({ ...obj, }); @@ -2997,6 +3267,9 @@ export interface SavingsPlansCoverage { } export namespace SavingsPlansCoverage { + /** + * @internal + */ export const filterSensitiveLog = (obj: SavingsPlansCoverage): any => ({ ...obj, }); @@ -3015,6 +3288,9 @@ export interface GetSavingsPlansCoverageResponse { } export namespace GetSavingsPlansCoverageResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetSavingsPlansCoverageResponse): any => ({ ...obj, }); @@ -3047,6 +3323,9 @@ export interface SavingsPlansPurchaseRecommendationMetadata { } export namespace SavingsPlansPurchaseRecommendationMetadata { + /** + * @internal + */ export const filterSensitiveLog = (obj: SavingsPlansPurchaseRecommendationMetadata): any => ({ ...obj, }); @@ -3073,6 +3352,9 @@ export interface SavingsPlansDetails { } export namespace SavingsPlansDetails { + /** + * @internal + */ export const filterSensitiveLog = (obj: SavingsPlansDetails): any => ({ ...obj, }); @@ -3167,6 +3449,9 @@ export interface SavingsPlansPurchaseRecommendationDetail { } export namespace SavingsPlansPurchaseRecommendationDetail { + /** + * @internal + */ export const filterSensitiveLog = (obj: SavingsPlansPurchaseRecommendationDetail): any => ({ ...obj, }); @@ -3236,6 +3521,9 @@ export interface SavingsPlansPurchaseRecommendationSummary { } export namespace SavingsPlansPurchaseRecommendationSummary { + /** + * @internal + */ export const filterSensitiveLog = (obj: SavingsPlansPurchaseRecommendationSummary): any => ({ ...obj, }); @@ -3283,6 +3571,9 @@ export interface SavingsPlansPurchaseRecommendation { } export namespace SavingsPlansPurchaseRecommendation { + /** + * @internal + */ export const filterSensitiveLog = (obj: SavingsPlansPurchaseRecommendation): any => ({ ...obj, }); @@ -3306,6 +3597,9 @@ export interface GetSavingsPlansPurchaseRecommendationResponse { } export namespace GetSavingsPlansPurchaseRecommendationResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetSavingsPlansPurchaseRecommendationResponse): any => ({ ...obj, }); @@ -3332,6 +3626,9 @@ export interface SavingsPlansAmortizedCommitment { } export namespace SavingsPlansAmortizedCommitment { + /** + * @internal + */ export const filterSensitiveLog = (obj: SavingsPlansAmortizedCommitment): any => ({ ...obj, }); @@ -3355,6 +3652,9 @@ export interface SavingsPlansSavings { } export namespace SavingsPlansSavings { + /** + * @internal + */ export const filterSensitiveLog = (obj: SavingsPlansSavings): any => ({ ...obj, }); @@ -3386,6 +3686,9 @@ export interface SavingsPlansUtilization { } export namespace SavingsPlansUtilization { + /** + * @internal + */ export const filterSensitiveLog = (obj: SavingsPlansUtilization): any => ({ ...obj, }); @@ -3418,6 +3721,9 @@ export interface SavingsPlansUtilizationByTime { } export namespace SavingsPlansUtilizationByTime { + /** + * @internal + */ export const filterSensitiveLog = (obj: SavingsPlansUtilizationByTime): any => ({ ...obj, }); @@ -3444,6 +3750,9 @@ export interface SavingsPlansUtilizationAggregates { } export namespace SavingsPlansUtilizationAggregates { + /** + * @internal + */ export const filterSensitiveLog = (obj: SavingsPlansUtilizationAggregates): any => ({ ...obj, }); @@ -3462,6 +3771,9 @@ export interface GetSavingsPlansUtilizationResponse { } export namespace GetSavingsPlansUtilizationResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetSavingsPlansUtilizationResponse): any => ({ ...obj, }); @@ -3505,6 +3817,9 @@ export interface SavingsPlansUtilizationDetail { } export namespace SavingsPlansUtilizationDetail { + /** + * @internal + */ export const filterSensitiveLog = (obj: SavingsPlansUtilizationDetail): any => ({ ...obj, }); @@ -3534,6 +3849,9 @@ export interface GetSavingsPlansUtilizationDetailsResponse { } export namespace GetSavingsPlansUtilizationDetailsResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetSavingsPlansUtilizationDetailsResponse): any => ({ ...obj, }); @@ -3562,6 +3880,9 @@ export interface GetTagsResponse { } export namespace GetTagsResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetTagsResponse): any => ({ ...obj, }); @@ -3581,6 +3902,9 @@ export interface GetUsageForecastResponse { } export namespace GetUsageForecastResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetUsageForecastResponse): any => ({ ...obj, }); @@ -3596,6 +3920,9 @@ export interface UnresolvableUsageUnitException extends __SmithyException, $Meta } export namespace UnresolvableUsageUnitException { + /** + * @internal + */ export const filterSensitiveLog = (obj: UnresolvableUsageUnitException): any => ({ ...obj, }); @@ -3623,6 +3950,9 @@ export interface ListCostCategoryDefinitionsRequest { } export namespace ListCostCategoryDefinitionsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListCostCategoryDefinitionsRequest): any => ({ ...obj, }); @@ -3685,6 +4015,9 @@ export interface CostCategoryReference { } export namespace CostCategoryReference { + /** + * @internal + */ export const filterSensitiveLog = (obj: CostCategoryReference): any => ({ ...obj, }); @@ -3707,6 +4040,9 @@ export interface ListCostCategoryDefinitionsResponse { } export namespace ListCostCategoryDefinitionsResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListCostCategoryDefinitionsResponse): any => ({ ...obj, }); @@ -3727,6 +4063,9 @@ export interface ProvideAnomalyFeedbackRequest { } export namespace ProvideAnomalyFeedbackRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ProvideAnomalyFeedbackRequest): any => ({ ...obj, }); @@ -3742,6 +4081,9 @@ export interface ProvideAnomalyFeedbackResponse { } export namespace ProvideAnomalyFeedbackResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ProvideAnomalyFeedbackResponse): any => ({ ...obj, }); @@ -3762,6 +4104,9 @@ export interface UpdateAnomalyMonitorRequest { } export namespace UpdateAnomalyMonitorRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateAnomalyMonitorRequest): any => ({ ...obj, }); @@ -3777,6 +4122,9 @@ export interface UpdateAnomalyMonitorResponse { } export namespace UpdateAnomalyMonitorResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateAnomalyMonitorResponse): any => ({ ...obj, }); @@ -3825,6 +4173,9 @@ export interface UpdateAnomalySubscriptionRequest { } export namespace UpdateAnomalySubscriptionRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateAnomalySubscriptionRequest): any => ({ ...obj, }); @@ -3840,6 +4191,9 @@ export interface UpdateAnomalySubscriptionResponse { } export namespace UpdateAnomalySubscriptionResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateAnomalySubscriptionResponse): any => ({ ...obj, }); @@ -3862,6 +4216,9 @@ export interface UpdateCostCategoryDefinitionResponse { } export namespace UpdateCostCategoryDefinitionResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateCostCategoryDefinitionResponse): any => ({ ...obj, }); @@ -3958,6 +4315,9 @@ export interface Expression { } export namespace Expression { + /** + * @internal + */ export const filterSensitiveLog = (obj: Expression): any => ({ ...obj, }); @@ -4085,6 +4445,9 @@ export interface AnomalyMonitor { } export namespace AnomalyMonitor { + /** + * @internal + */ export const filterSensitiveLog = (obj: AnomalyMonitor): any => ({ ...obj, }); @@ -4129,6 +4492,9 @@ export interface CostCategoryRule { } export namespace CostCategoryRule { + /** + * @internal + */ export const filterSensitiveLog = (obj: CostCategoryRule): any => ({ ...obj, }); @@ -4190,6 +4556,9 @@ export interface GetCostAndUsageRequest { } export namespace GetCostAndUsageRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetCostAndUsageRequest): any => ({ ...obj, }); @@ -4253,6 +4622,9 @@ export interface GetCostAndUsageWithResourcesRequest { } export namespace GetCostAndUsageWithResourcesRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetCostAndUsageWithResourcesRequest): any => ({ ...obj, }); @@ -4395,6 +4767,9 @@ export interface GetCostCategoriesRequest { } export namespace GetCostCategoriesRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetCostCategoriesRequest): any => ({ ...obj, }); @@ -4569,6 +4944,9 @@ export interface GetCostForecastRequest { } export namespace GetCostForecastRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetCostForecastRequest): any => ({ ...obj, }); @@ -4830,6 +5208,9 @@ export interface GetDimensionValuesRequest { } export namespace GetDimensionValuesRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetDimensionValuesRequest): any => ({ ...obj, }); @@ -5019,6 +5400,9 @@ export interface GetReservationCoverageRequest { } export namespace GetReservationCoverageRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetReservationCoverageRequest): any => ({ ...obj, }); @@ -5132,6 +5516,9 @@ export interface GetReservationPurchaseRecommendationRequest { } export namespace GetReservationPurchaseRecommendationRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetReservationPurchaseRecommendationRequest): any => ({ ...obj, }); @@ -5310,6 +5697,9 @@ export interface GetReservationUtilizationRequest { } export namespace GetReservationUtilizationRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetReservationUtilizationRequest): any => ({ ...obj, }); @@ -5403,6 +5793,9 @@ export interface GetRightsizingRecommendationRequest { } export namespace GetRightsizingRecommendationRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetRightsizingRecommendationRequest): any => ({ ...obj, }); @@ -5519,6 +5912,9 @@ export interface GetSavingsPlansCoverageRequest { } export namespace GetSavingsPlansCoverageRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetSavingsPlansCoverageRequest): any => ({ ...obj, }); @@ -5578,6 +5974,9 @@ export interface GetSavingsPlansPurchaseRecommendationRequest { } export namespace GetSavingsPlansPurchaseRecommendationRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetSavingsPlansPurchaseRecommendationRequest): any => ({ ...obj, }); @@ -5688,6 +6087,9 @@ export interface GetSavingsPlansUtilizationDetailsRequest { } export namespace GetSavingsPlansUtilizationDetailsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetSavingsPlansUtilizationDetailsRequest): any => ({ ...obj, }); @@ -5783,6 +6185,9 @@ export interface GetSavingsPlansUtilizationRequest { } export namespace GetSavingsPlansUtilizationRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetSavingsPlansUtilizationRequest): any => ({ ...obj, }); @@ -5923,6 +6328,9 @@ export interface GetTagsRequest { } export namespace GetTagsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetTagsRequest): any => ({ ...obj, }); @@ -6087,6 +6495,9 @@ export interface GetUsageForecastRequest { } export namespace GetUsageForecastRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetUsageForecastRequest): any => ({ ...obj, }); @@ -6100,6 +6511,9 @@ export interface CreateAnomalyMonitorRequest { } export namespace CreateAnomalyMonitorRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateAnomalyMonitorRequest): any => ({ ...obj, }); @@ -6159,6 +6573,9 @@ export interface CostCategory { } export namespace CostCategory { + /** + * @internal + */ export const filterSensitiveLog = (obj: CostCategory): any => ({ ...obj, }); @@ -6188,6 +6605,9 @@ export interface CreateCostCategoryDefinitionRequest { } export namespace CreateCostCategoryDefinitionRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateCostCategoryDefinitionRequest): any => ({ ...obj, }); @@ -6210,6 +6630,9 @@ export interface GetAnomalyMonitorsResponse { } export namespace GetAnomalyMonitorsResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetAnomalyMonitorsResponse): any => ({ ...obj, }); @@ -6239,6 +6662,9 @@ export interface UpdateCostCategoryDefinitionRequest { } export namespace UpdateCostCategoryDefinitionRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateCostCategoryDefinitionRequest): any => ({ ...obj, }); @@ -6252,6 +6678,9 @@ export interface DescribeCostCategoryDefinitionResponse { } export namespace DescribeCostCategoryDefinitionResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeCostCategoryDefinitionResponse): any => ({ ...obj, }); diff --git a/clients/client-customer-profiles/commands/AddProfileKeyCommand.ts b/clients/client-customer-profiles/commands/AddProfileKeyCommand.ts index 44fe8551f204..0ad3ae270ced 100644 --- a/clients/client-customer-profiles/commands/AddProfileKeyCommand.ts +++ b/clients/client-customer-profiles/commands/AddProfileKeyCommand.ts @@ -25,6 +25,20 @@ export interface AddProfileKeyCommandOutput extends AddProfileKeyResponse, __Met * 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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { CustomerProfilesClient, AddProfileKeyCommand } from "@aws-sdk/client-customer-profiles"; // ES Modules import + * // const { CustomerProfilesClient, AddProfileKeyCommand } = require("@aws-sdk/client-customer-profiles"); // CommonJS import + * const client = new CustomerProfilesClient(config); + * const command = new AddProfileKeyCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link AddProfileKeyCommandInput} for command's `input` shape. + * @see {@link AddProfileKeyCommandOutput} for command's `response` shape. + * @see {@link CustomerProfilesClientResolvedConfig | config} for command's `input` shape. + * */ export class AddProfileKeyCommand extends $Command< AddProfileKeyCommandInput, diff --git a/clients/client-customer-profiles/commands/CreateDomainCommand.ts b/clients/client-customer-profiles/commands/CreateDomainCommand.ts index e19c932557a2..27f7b2d72cac 100644 --- a/clients/client-customer-profiles/commands/CreateDomainCommand.ts +++ b/clients/client-customer-profiles/commands/CreateDomainCommand.ts @@ -26,6 +26,20 @@ export interface CreateDomainCommandOutput extends CreateDomainResponse, __Metad * 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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { CustomerProfilesClient, CreateDomainCommand } from "@aws-sdk/client-customer-profiles"; // ES Modules import + * // const { CustomerProfilesClient, CreateDomainCommand } = require("@aws-sdk/client-customer-profiles"); // CommonJS import + * const client = new CustomerProfilesClient(config); + * const command = new CreateDomainCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreateDomainCommandInput} for command's `input` shape. + * @see {@link CreateDomainCommandOutput} for command's `response` shape. + * @see {@link CustomerProfilesClientResolvedConfig | config} for command's `input` shape. + * */ export class CreateDomainCommand extends $Command< CreateDomainCommandInput, diff --git a/clients/client-customer-profiles/commands/CreateProfileCommand.ts b/clients/client-customer-profiles/commands/CreateProfileCommand.ts index a6ee6660c387..6dd99a2e0b78 100644 --- a/clients/client-customer-profiles/commands/CreateProfileCommand.ts +++ b/clients/client-customer-profiles/commands/CreateProfileCommand.ts @@ -24,6 +24,20 @@ export interface CreateProfileCommandOutput extends CreateProfileResponse, __Met *

Creates a standard profile.

*

A standard profile represents the following attributes for a customer profile in a * domain.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { CustomerProfilesClient, CreateProfileCommand } from "@aws-sdk/client-customer-profiles"; // ES Modules import + * // const { CustomerProfilesClient, CreateProfileCommand } = require("@aws-sdk/client-customer-profiles"); // CommonJS import + * const client = new CustomerProfilesClient(config); + * const command = new CreateProfileCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreateProfileCommandInput} for command's `input` shape. + * @see {@link CreateProfileCommandOutput} for command's `response` shape. + * @see {@link CustomerProfilesClientResolvedConfig | config} for command's `input` shape. + * */ export class CreateProfileCommand extends $Command< CreateProfileCommandInput, diff --git a/clients/client-customer-profiles/commands/DeleteDomainCommand.ts b/clients/client-customer-profiles/commands/DeleteDomainCommand.ts index 26d12a3a9860..a00cdf8cd5e8 100644 --- a/clients/client-customer-profiles/commands/DeleteDomainCommand.ts +++ b/clients/client-customer-profiles/commands/DeleteDomainCommand.ts @@ -23,6 +23,20 @@ export interface DeleteDomainCommandOutput extends DeleteDomainResponse, __Metad /** *

Deletes a specific domain and all of its customer data, such as customer profile * attributes and their related objects.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { CustomerProfilesClient, DeleteDomainCommand } from "@aws-sdk/client-customer-profiles"; // ES Modules import + * // const { CustomerProfilesClient, DeleteDomainCommand } = require("@aws-sdk/client-customer-profiles"); // CommonJS import + * const client = new CustomerProfilesClient(config); + * const command = new DeleteDomainCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteDomainCommandInput} for command's `input` shape. + * @see {@link DeleteDomainCommandOutput} for command's `response` shape. + * @see {@link CustomerProfilesClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteDomainCommand extends $Command< DeleteDomainCommandInput, diff --git a/clients/client-customer-profiles/commands/DeleteIntegrationCommand.ts b/clients/client-customer-profiles/commands/DeleteIntegrationCommand.ts index 1d6386104665..5747d3c60cf3 100644 --- a/clients/client-customer-profiles/commands/DeleteIntegrationCommand.ts +++ b/clients/client-customer-profiles/commands/DeleteIntegrationCommand.ts @@ -22,6 +22,20 @@ export interface DeleteIntegrationCommandOutput extends DeleteIntegrationRespons /** *

Removes an integration from a specific domain.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { CustomerProfilesClient, DeleteIntegrationCommand } from "@aws-sdk/client-customer-profiles"; // ES Modules import + * // const { CustomerProfilesClient, DeleteIntegrationCommand } = require("@aws-sdk/client-customer-profiles"); // CommonJS import + * const client = new CustomerProfilesClient(config); + * const command = new DeleteIntegrationCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteIntegrationCommandInput} for command's `input` shape. + * @see {@link DeleteIntegrationCommandOutput} for command's `response` shape. + * @see {@link CustomerProfilesClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteIntegrationCommand extends $Command< DeleteIntegrationCommandInput, diff --git a/clients/client-customer-profiles/commands/DeleteProfileCommand.ts b/clients/client-customer-profiles/commands/DeleteProfileCommand.ts index 798b61716bc4..0a6c461d4d66 100644 --- a/clients/client-customer-profiles/commands/DeleteProfileCommand.ts +++ b/clients/client-customer-profiles/commands/DeleteProfileCommand.ts @@ -22,6 +22,20 @@ export interface DeleteProfileCommandOutput extends DeleteProfileResponse, __Met /** *

Deletes the standard customer profile and all data pertaining to the profile.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { CustomerProfilesClient, DeleteProfileCommand } from "@aws-sdk/client-customer-profiles"; // ES Modules import + * // const { CustomerProfilesClient, DeleteProfileCommand } = require("@aws-sdk/client-customer-profiles"); // CommonJS import + * const client = new CustomerProfilesClient(config); + * const command = new DeleteProfileCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteProfileCommandInput} for command's `input` shape. + * @see {@link DeleteProfileCommandOutput} for command's `response` shape. + * @see {@link CustomerProfilesClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteProfileCommand extends $Command< DeleteProfileCommandInput, diff --git a/clients/client-customer-profiles/commands/DeleteProfileKeyCommand.ts b/clients/client-customer-profiles/commands/DeleteProfileKeyCommand.ts index 34c52e019d72..374811bea5ca 100644 --- a/clients/client-customer-profiles/commands/DeleteProfileKeyCommand.ts +++ b/clients/client-customer-profiles/commands/DeleteProfileKeyCommand.ts @@ -22,6 +22,20 @@ export interface DeleteProfileKeyCommandOutput extends DeleteProfileKeyResponse, /** *

Removes a searchable key from a customer profile.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { CustomerProfilesClient, DeleteProfileKeyCommand } from "@aws-sdk/client-customer-profiles"; // ES Modules import + * // const { CustomerProfilesClient, DeleteProfileKeyCommand } = require("@aws-sdk/client-customer-profiles"); // CommonJS import + * const client = new CustomerProfilesClient(config); + * const command = new DeleteProfileKeyCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteProfileKeyCommandInput} for command's `input` shape. + * @see {@link DeleteProfileKeyCommandOutput} for command's `response` shape. + * @see {@link CustomerProfilesClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteProfileKeyCommand extends $Command< DeleteProfileKeyCommandInput, diff --git a/clients/client-customer-profiles/commands/DeleteProfileObjectCommand.ts b/clients/client-customer-profiles/commands/DeleteProfileObjectCommand.ts index 89f7ed3266bd..cfed66488450 100644 --- a/clients/client-customer-profiles/commands/DeleteProfileObjectCommand.ts +++ b/clients/client-customer-profiles/commands/DeleteProfileObjectCommand.ts @@ -22,6 +22,20 @@ export interface DeleteProfileObjectCommandOutput extends DeleteProfileObjectRes /** *

Removes an object associated with a profile of a given ProfileObjectType.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { CustomerProfilesClient, DeleteProfileObjectCommand } from "@aws-sdk/client-customer-profiles"; // ES Modules import + * // const { CustomerProfilesClient, DeleteProfileObjectCommand } = require("@aws-sdk/client-customer-profiles"); // CommonJS import + * const client = new CustomerProfilesClient(config); + * const command = new DeleteProfileObjectCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteProfileObjectCommandInput} for command's `input` shape. + * @see {@link DeleteProfileObjectCommandOutput} for command's `response` shape. + * @see {@link CustomerProfilesClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteProfileObjectCommand extends $Command< DeleteProfileObjectCommandInput, diff --git a/clients/client-customer-profiles/commands/DeleteProfileObjectTypeCommand.ts b/clients/client-customer-profiles/commands/DeleteProfileObjectTypeCommand.ts index 90b31db9af24..27a3710cedfb 100644 --- a/clients/client-customer-profiles/commands/DeleteProfileObjectTypeCommand.ts +++ b/clients/client-customer-profiles/commands/DeleteProfileObjectTypeCommand.ts @@ -25,6 +25,20 @@ export interface DeleteProfileObjectTypeCommandOutput extends DeleteProfileObjec * 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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { CustomerProfilesClient, DeleteProfileObjectTypeCommand } from "@aws-sdk/client-customer-profiles"; // ES Modules import + * // const { CustomerProfilesClient, DeleteProfileObjectTypeCommand } = require("@aws-sdk/client-customer-profiles"); // CommonJS import + * const client = new CustomerProfilesClient(config); + * const command = new DeleteProfileObjectTypeCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteProfileObjectTypeCommandInput} for command's `input` shape. + * @see {@link DeleteProfileObjectTypeCommandOutput} for command's `response` shape. + * @see {@link CustomerProfilesClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteProfileObjectTypeCommand extends $Command< DeleteProfileObjectTypeCommandInput, diff --git a/clients/client-customer-profiles/commands/GetDomainCommand.ts b/clients/client-customer-profiles/commands/GetDomainCommand.ts index 44295a4ab4ba..21c491aeee14 100644 --- a/clients/client-customer-profiles/commands/GetDomainCommand.ts +++ b/clients/client-customer-profiles/commands/GetDomainCommand.ts @@ -22,6 +22,20 @@ export interface GetDomainCommandOutput extends GetDomainResponse, __MetadataBea /** *

Returns information about a specific domain.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { CustomerProfilesClient, GetDomainCommand } from "@aws-sdk/client-customer-profiles"; // ES Modules import + * // const { CustomerProfilesClient, GetDomainCommand } = require("@aws-sdk/client-customer-profiles"); // CommonJS import + * const client = new CustomerProfilesClient(config); + * const command = new GetDomainCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetDomainCommandInput} for command's `input` shape. + * @see {@link GetDomainCommandOutput} for command's `response` shape. + * @see {@link CustomerProfilesClientResolvedConfig | config} for command's `input` shape. + * */ export class GetDomainCommand extends $Command< GetDomainCommandInput, diff --git a/clients/client-customer-profiles/commands/GetIntegrationCommand.ts b/clients/client-customer-profiles/commands/GetIntegrationCommand.ts index 12e49015843b..0c8a0743d6c7 100644 --- a/clients/client-customer-profiles/commands/GetIntegrationCommand.ts +++ b/clients/client-customer-profiles/commands/GetIntegrationCommand.ts @@ -22,6 +22,20 @@ export interface GetIntegrationCommandOutput extends GetIntegrationResponse, __M /** *

Returns an integration for a domain.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { CustomerProfilesClient, GetIntegrationCommand } from "@aws-sdk/client-customer-profiles"; // ES Modules import + * // const { CustomerProfilesClient, GetIntegrationCommand } = require("@aws-sdk/client-customer-profiles"); // CommonJS import + * const client = new CustomerProfilesClient(config); + * const command = new GetIntegrationCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetIntegrationCommandInput} for command's `input` shape. + * @see {@link GetIntegrationCommandOutput} for command's `response` shape. + * @see {@link CustomerProfilesClientResolvedConfig | config} for command's `input` shape. + * */ export class GetIntegrationCommand extends $Command< GetIntegrationCommandInput, diff --git a/clients/client-customer-profiles/commands/GetProfileObjectTypeCommand.ts b/clients/client-customer-profiles/commands/GetProfileObjectTypeCommand.ts index bb6c55308402..58e96de131e8 100644 --- a/clients/client-customer-profiles/commands/GetProfileObjectTypeCommand.ts +++ b/clients/client-customer-profiles/commands/GetProfileObjectTypeCommand.ts @@ -22,6 +22,20 @@ export interface GetProfileObjectTypeCommandOutput extends GetProfileObjectTypeR /** *

Returns the object types for a specific domain.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { CustomerProfilesClient, GetProfileObjectTypeCommand } from "@aws-sdk/client-customer-profiles"; // ES Modules import + * // const { CustomerProfilesClient, GetProfileObjectTypeCommand } = require("@aws-sdk/client-customer-profiles"); // CommonJS import + * const client = new CustomerProfilesClient(config); + * const command = new GetProfileObjectTypeCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetProfileObjectTypeCommandInput} for command's `input` shape. + * @see {@link GetProfileObjectTypeCommandOutput} for command's `response` shape. + * @see {@link CustomerProfilesClientResolvedConfig | config} for command's `input` shape. + * */ export class GetProfileObjectTypeCommand extends $Command< GetProfileObjectTypeCommandInput, diff --git a/clients/client-customer-profiles/commands/GetProfileObjectTypeTemplateCommand.ts b/clients/client-customer-profiles/commands/GetProfileObjectTypeTemplateCommand.ts index 4947f45462be..c4c1b7f41db4 100644 --- a/clients/client-customer-profiles/commands/GetProfileObjectTypeTemplateCommand.ts +++ b/clients/client-customer-profiles/commands/GetProfileObjectTypeTemplateCommand.ts @@ -28,6 +28,20 @@ export interface GetProfileObjectTypeTemplateCommandOutput * “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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { CustomerProfilesClient, GetProfileObjectTypeTemplateCommand } from "@aws-sdk/client-customer-profiles"; // ES Modules import + * // const { CustomerProfilesClient, GetProfileObjectTypeTemplateCommand } = require("@aws-sdk/client-customer-profiles"); // CommonJS import + * const client = new CustomerProfilesClient(config); + * const command = new GetProfileObjectTypeTemplateCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetProfileObjectTypeTemplateCommandInput} for command's `input` shape. + * @see {@link GetProfileObjectTypeTemplateCommandOutput} for command's `response` shape. + * @see {@link CustomerProfilesClientResolvedConfig | config} for command's `input` shape. + * */ export class GetProfileObjectTypeTemplateCommand extends $Command< GetProfileObjectTypeTemplateCommandInput, diff --git a/clients/client-customer-profiles/commands/ListAccountIntegrationsCommand.ts b/clients/client-customer-profiles/commands/ListAccountIntegrationsCommand.ts index db909904b44e..1af3165bccc1 100644 --- a/clients/client-customer-profiles/commands/ListAccountIntegrationsCommand.ts +++ b/clients/client-customer-profiles/commands/ListAccountIntegrationsCommand.ts @@ -22,6 +22,20 @@ export interface ListAccountIntegrationsCommandOutput extends ListAccountIntegra /** *

Lists all of the integrations associated to a specific URI in the AWS account.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { CustomerProfilesClient, ListAccountIntegrationsCommand } from "@aws-sdk/client-customer-profiles"; // ES Modules import + * // const { CustomerProfilesClient, ListAccountIntegrationsCommand } = require("@aws-sdk/client-customer-profiles"); // CommonJS import + * const client = new CustomerProfilesClient(config); + * const command = new ListAccountIntegrationsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListAccountIntegrationsCommandInput} for command's `input` shape. + * @see {@link ListAccountIntegrationsCommandOutput} for command's `response` shape. + * @see {@link CustomerProfilesClientResolvedConfig | config} for command's `input` shape. + * */ export class ListAccountIntegrationsCommand extends $Command< ListAccountIntegrationsCommandInput, diff --git a/clients/client-customer-profiles/commands/ListDomainsCommand.ts b/clients/client-customer-profiles/commands/ListDomainsCommand.ts index efa54cba2873..b8058f474696 100644 --- a/clients/client-customer-profiles/commands/ListDomainsCommand.ts +++ b/clients/client-customer-profiles/commands/ListDomainsCommand.ts @@ -22,6 +22,20 @@ export interface ListDomainsCommandOutput extends ListDomainsResponse, __Metadat /** *

Returns a list of all the domains for an AWS account that have been created.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { CustomerProfilesClient, ListDomainsCommand } from "@aws-sdk/client-customer-profiles"; // ES Modules import + * // const { CustomerProfilesClient, ListDomainsCommand } = require("@aws-sdk/client-customer-profiles"); // CommonJS import + * const client = new CustomerProfilesClient(config); + * const command = new ListDomainsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListDomainsCommandInput} for command's `input` shape. + * @see {@link ListDomainsCommandOutput} for command's `response` shape. + * @see {@link CustomerProfilesClientResolvedConfig | config} for command's `input` shape. + * */ export class ListDomainsCommand extends $Command< ListDomainsCommandInput, diff --git a/clients/client-customer-profiles/commands/ListIntegrationsCommand.ts b/clients/client-customer-profiles/commands/ListIntegrationsCommand.ts index 2c5e7fd4469a..179c7a8c5c58 100644 --- a/clients/client-customer-profiles/commands/ListIntegrationsCommand.ts +++ b/clients/client-customer-profiles/commands/ListIntegrationsCommand.ts @@ -22,6 +22,20 @@ export interface ListIntegrationsCommandOutput extends ListIntegrationsResponse, /** *

Lists all of the integrations in your domain.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { CustomerProfilesClient, ListIntegrationsCommand } from "@aws-sdk/client-customer-profiles"; // ES Modules import + * // const { CustomerProfilesClient, ListIntegrationsCommand } = require("@aws-sdk/client-customer-profiles"); // CommonJS import + * const client = new CustomerProfilesClient(config); + * const command = new ListIntegrationsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListIntegrationsCommandInput} for command's `input` shape. + * @see {@link ListIntegrationsCommandOutput} for command's `response` shape. + * @see {@link CustomerProfilesClientResolvedConfig | config} for command's `input` shape. + * */ export class ListIntegrationsCommand extends $Command< ListIntegrationsCommandInput, diff --git a/clients/client-customer-profiles/commands/ListProfileObjectTypeTemplatesCommand.ts b/clients/client-customer-profiles/commands/ListProfileObjectTypeTemplatesCommand.ts index 582c54461e7b..4c0aa50dd7a0 100644 --- a/clients/client-customer-profiles/commands/ListProfileObjectTypeTemplatesCommand.ts +++ b/clients/client-customer-profiles/commands/ListProfileObjectTypeTemplatesCommand.ts @@ -24,6 +24,20 @@ export interface ListProfileObjectTypeTemplatesCommandOutput /** *

Lists all of the template information for object types.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { CustomerProfilesClient, ListProfileObjectTypeTemplatesCommand } from "@aws-sdk/client-customer-profiles"; // ES Modules import + * // const { CustomerProfilesClient, ListProfileObjectTypeTemplatesCommand } = require("@aws-sdk/client-customer-profiles"); // CommonJS import + * const client = new CustomerProfilesClient(config); + * const command = new ListProfileObjectTypeTemplatesCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListProfileObjectTypeTemplatesCommandInput} for command's `input` shape. + * @see {@link ListProfileObjectTypeTemplatesCommandOutput} for command's `response` shape. + * @see {@link CustomerProfilesClientResolvedConfig | config} for command's `input` shape. + * */ export class ListProfileObjectTypeTemplatesCommand extends $Command< ListProfileObjectTypeTemplatesCommandInput, diff --git a/clients/client-customer-profiles/commands/ListProfileObjectTypesCommand.ts b/clients/client-customer-profiles/commands/ListProfileObjectTypesCommand.ts index b0810a27b24b..a3e2180b11e8 100644 --- a/clients/client-customer-profiles/commands/ListProfileObjectTypesCommand.ts +++ b/clients/client-customer-profiles/commands/ListProfileObjectTypesCommand.ts @@ -22,6 +22,20 @@ export interface ListProfileObjectTypesCommandOutput extends ListProfileObjectTy /** *

Lists all of the templates available within the service.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { CustomerProfilesClient, ListProfileObjectTypesCommand } from "@aws-sdk/client-customer-profiles"; // ES Modules import + * // const { CustomerProfilesClient, ListProfileObjectTypesCommand } = require("@aws-sdk/client-customer-profiles"); // CommonJS import + * const client = new CustomerProfilesClient(config); + * const command = new ListProfileObjectTypesCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListProfileObjectTypesCommandInput} for command's `input` shape. + * @see {@link ListProfileObjectTypesCommandOutput} for command's `response` shape. + * @see {@link CustomerProfilesClientResolvedConfig | config} for command's `input` shape. + * */ export class ListProfileObjectTypesCommand extends $Command< ListProfileObjectTypesCommandInput, diff --git a/clients/client-customer-profiles/commands/ListProfileObjectsCommand.ts b/clients/client-customer-profiles/commands/ListProfileObjectsCommand.ts index 9cf9ef283ecc..4d97e23ac4c2 100644 --- a/clients/client-customer-profiles/commands/ListProfileObjectsCommand.ts +++ b/clients/client-customer-profiles/commands/ListProfileObjectsCommand.ts @@ -22,6 +22,20 @@ export interface ListProfileObjectsCommandOutput extends ListProfileObjectsRespo /** *

Returns a list of objects associated with a profile of a given ProfileObjectType.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { CustomerProfilesClient, ListProfileObjectsCommand } from "@aws-sdk/client-customer-profiles"; // ES Modules import + * // const { CustomerProfilesClient, ListProfileObjectsCommand } = require("@aws-sdk/client-customer-profiles"); // CommonJS import + * const client = new CustomerProfilesClient(config); + * const command = new ListProfileObjectsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListProfileObjectsCommandInput} for command's `input` shape. + * @see {@link ListProfileObjectsCommandOutput} for command's `response` shape. + * @see {@link CustomerProfilesClientResolvedConfig | config} for command's `input` shape. + * */ export class ListProfileObjectsCommand extends $Command< ListProfileObjectsCommandInput, diff --git a/clients/client-customer-profiles/commands/ListTagsForResourceCommand.ts b/clients/client-customer-profiles/commands/ListTagsForResourceCommand.ts index 60bdc42f1477..f761f7ed9e27 100644 --- a/clients/client-customer-profiles/commands/ListTagsForResourceCommand.ts +++ b/clients/client-customer-profiles/commands/ListTagsForResourceCommand.ts @@ -23,6 +23,20 @@ export interface ListTagsForResourceCommandOutput extends ListTagsForResourceRes /** *

Displays the tags associated with an Amazon Connect Customer Profiles resource. In Connect * Customer Profiles, domains, profile object types, and integrations can be tagged.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { CustomerProfilesClient, ListTagsForResourceCommand } from "@aws-sdk/client-customer-profiles"; // ES Modules import + * // const { CustomerProfilesClient, ListTagsForResourceCommand } = require("@aws-sdk/client-customer-profiles"); // CommonJS import + * const client = new CustomerProfilesClient(config); + * const command = new ListTagsForResourceCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListTagsForResourceCommandInput} for command's `input` shape. + * @see {@link ListTagsForResourceCommandOutput} for command's `response` shape. + * @see {@link CustomerProfilesClientResolvedConfig | config} for command's `input` shape. + * */ export class ListTagsForResourceCommand extends $Command< ListTagsForResourceCommandInput, diff --git a/clients/client-customer-profiles/commands/PutIntegrationCommand.ts b/clients/client-customer-profiles/commands/PutIntegrationCommand.ts index c944989dd159..70ce18a07234 100644 --- a/clients/client-customer-profiles/commands/PutIntegrationCommand.ts +++ b/clients/client-customer-profiles/commands/PutIntegrationCommand.ts @@ -24,6 +24,20 @@ export interface PutIntegrationCommandOutput extends PutIntegrationResponse, __M *

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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { CustomerProfilesClient, PutIntegrationCommand } from "@aws-sdk/client-customer-profiles"; // ES Modules import + * // const { CustomerProfilesClient, PutIntegrationCommand } = require("@aws-sdk/client-customer-profiles"); // CommonJS import + * const client = new CustomerProfilesClient(config); + * const command = new PutIntegrationCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link PutIntegrationCommandInput} for command's `input` shape. + * @see {@link PutIntegrationCommandOutput} for command's `response` shape. + * @see {@link CustomerProfilesClientResolvedConfig | config} for command's `input` shape. + * */ export class PutIntegrationCommand extends $Command< PutIntegrationCommandInput, diff --git a/clients/client-customer-profiles/commands/PutProfileObjectCommand.ts b/clients/client-customer-profiles/commands/PutProfileObjectCommand.ts index 088a125100a9..2f05780bc5b9 100644 --- a/clients/client-customer-profiles/commands/PutProfileObjectCommand.ts +++ b/clients/client-customer-profiles/commands/PutProfileObjectCommand.ts @@ -31,6 +31,20 @@ export interface PutProfileObjectCommandOutput extends PutProfileObjectResponse, * ProfileObjectType definition.

*

PutProfileObject needs an ObjectType, which can be created using * PutProfileObjectType.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { CustomerProfilesClient, PutProfileObjectCommand } from "@aws-sdk/client-customer-profiles"; // ES Modules import + * // const { CustomerProfilesClient, PutProfileObjectCommand } = require("@aws-sdk/client-customer-profiles"); // CommonJS import + * const client = new CustomerProfilesClient(config); + * const command = new PutProfileObjectCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link PutProfileObjectCommandInput} for command's `input` shape. + * @see {@link PutProfileObjectCommandOutput} for command's `response` shape. + * @see {@link CustomerProfilesClientResolvedConfig | config} for command's `input` shape. + * */ export class PutProfileObjectCommand extends $Command< PutProfileObjectCommandInput, diff --git a/clients/client-customer-profiles/commands/PutProfileObjectTypeCommand.ts b/clients/client-customer-profiles/commands/PutProfileObjectTypeCommand.ts index 9ab0c089b700..c03a44fb6329 100644 --- a/clients/client-customer-profiles/commands/PutProfileObjectTypeCommand.ts +++ b/clients/client-customer-profiles/commands/PutProfileObjectTypeCommand.ts @@ -22,6 +22,20 @@ export interface PutProfileObjectTypeCommandOutput extends PutProfileObjectTypeR /** *

Defines a ProfileObjectType.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { CustomerProfilesClient, PutProfileObjectTypeCommand } from "@aws-sdk/client-customer-profiles"; // ES Modules import + * // const { CustomerProfilesClient, PutProfileObjectTypeCommand } = require("@aws-sdk/client-customer-profiles"); // CommonJS import + * const client = new CustomerProfilesClient(config); + * const command = new PutProfileObjectTypeCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link PutProfileObjectTypeCommandInput} for command's `input` shape. + * @see {@link PutProfileObjectTypeCommandOutput} for command's `response` shape. + * @see {@link CustomerProfilesClientResolvedConfig | config} for command's `input` shape. + * */ export class PutProfileObjectTypeCommand extends $Command< PutProfileObjectTypeCommandInput, diff --git a/clients/client-customer-profiles/commands/SearchProfilesCommand.ts b/clients/client-customer-profiles/commands/SearchProfilesCommand.ts index 902ee5d3de51..625385392b1c 100644 --- a/clients/client-customer-profiles/commands/SearchProfilesCommand.ts +++ b/clients/client-customer-profiles/commands/SearchProfilesCommand.ts @@ -23,6 +23,20 @@ export interface SearchProfilesCommandOutput extends SearchProfilesResponse, __M /** *

Searches for profiles within a specific domain name using name, phone number, email * address, account number, or a custom defined index.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { CustomerProfilesClient, SearchProfilesCommand } from "@aws-sdk/client-customer-profiles"; // ES Modules import + * // const { CustomerProfilesClient, SearchProfilesCommand } = require("@aws-sdk/client-customer-profiles"); // CommonJS import + * const client = new CustomerProfilesClient(config); + * const command = new SearchProfilesCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link SearchProfilesCommandInput} for command's `input` shape. + * @see {@link SearchProfilesCommandOutput} for command's `response` shape. + * @see {@link CustomerProfilesClientResolvedConfig | config} for command's `input` shape. + * */ export class SearchProfilesCommand extends $Command< SearchProfilesCommandInput, diff --git a/clients/client-customer-profiles/commands/TagResourceCommand.ts b/clients/client-customer-profiles/commands/TagResourceCommand.ts index c6f704ce0f4b..2667e5054af3 100644 --- a/clients/client-customer-profiles/commands/TagResourceCommand.ts +++ b/clients/client-customer-profiles/commands/TagResourceCommand.ts @@ -33,6 +33,20 @@ export interface TagResourceCommandOutput extends TagResourceResponse, __Metadat * 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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { CustomerProfilesClient, TagResourceCommand } from "@aws-sdk/client-customer-profiles"; // ES Modules import + * // const { CustomerProfilesClient, TagResourceCommand } = require("@aws-sdk/client-customer-profiles"); // CommonJS import + * const client = new CustomerProfilesClient(config); + * const command = new TagResourceCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link TagResourceCommandInput} for command's `input` shape. + * @see {@link TagResourceCommandOutput} for command's `response` shape. + * @see {@link CustomerProfilesClientResolvedConfig | config} for command's `input` shape. + * */ export class TagResourceCommand extends $Command< TagResourceCommandInput, diff --git a/clients/client-customer-profiles/commands/UntagResourceCommand.ts b/clients/client-customer-profiles/commands/UntagResourceCommand.ts index b500fb4e94a7..a1750eda0c1e 100644 --- a/clients/client-customer-profiles/commands/UntagResourceCommand.ts +++ b/clients/client-customer-profiles/commands/UntagResourceCommand.ts @@ -23,6 +23,20 @@ export interface UntagResourceCommandOutput extends UntagResourceResponse, __Met /** *

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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { CustomerProfilesClient, UntagResourceCommand } from "@aws-sdk/client-customer-profiles"; // ES Modules import + * // const { CustomerProfilesClient, UntagResourceCommand } = require("@aws-sdk/client-customer-profiles"); // CommonJS import + * const client = new CustomerProfilesClient(config); + * const command = new UntagResourceCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link UntagResourceCommandInput} for command's `input` shape. + * @see {@link UntagResourceCommandOutput} for command's `response` shape. + * @see {@link CustomerProfilesClientResolvedConfig | config} for command's `input` shape. + * */ export class UntagResourceCommand extends $Command< UntagResourceCommandInput, diff --git a/clients/client-customer-profiles/commands/UpdateDomainCommand.ts b/clients/client-customer-profiles/commands/UpdateDomainCommand.ts index 0db96191e93f..9744b7793bdb 100644 --- a/clients/client-customer-profiles/commands/UpdateDomainCommand.ts +++ b/clients/client-customer-profiles/commands/UpdateDomainCommand.ts @@ -24,6 +24,20 @@ export interface UpdateDomainCommandOutput extends UpdateDomainResponse, __Metad *

Updates the properties of a domain, including creating or selecting a dead letter queue * or an encryption key.

*

Once a domain is created, the name can’t be changed.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { CustomerProfilesClient, UpdateDomainCommand } from "@aws-sdk/client-customer-profiles"; // ES Modules import + * // const { CustomerProfilesClient, UpdateDomainCommand } = require("@aws-sdk/client-customer-profiles"); // CommonJS import + * const client = new CustomerProfilesClient(config); + * const command = new UpdateDomainCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link UpdateDomainCommandInput} for command's `input` shape. + * @see {@link UpdateDomainCommandOutput} for command's `response` shape. + * @see {@link CustomerProfilesClientResolvedConfig | config} for command's `input` shape. + * */ export class UpdateDomainCommand extends $Command< UpdateDomainCommandInput, diff --git a/clients/client-customer-profiles/commands/UpdateProfileCommand.ts b/clients/client-customer-profiles/commands/UpdateProfileCommand.ts index 4cd1033dce9d..2e8f29abc1b3 100644 --- a/clients/client-customer-profiles/commands/UpdateProfileCommand.ts +++ b/clients/client-customer-profiles/commands/UpdateProfileCommand.ts @@ -26,6 +26,20 @@ export interface UpdateProfileCommandOutput extends UpdateProfileResponse, __Met *

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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { CustomerProfilesClient, UpdateProfileCommand } from "@aws-sdk/client-customer-profiles"; // ES Modules import + * // const { CustomerProfilesClient, UpdateProfileCommand } = require("@aws-sdk/client-customer-profiles"); // CommonJS import + * const client = new CustomerProfilesClient(config); + * const command = new UpdateProfileCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link UpdateProfileCommandInput} for command's `input` shape. + * @see {@link UpdateProfileCommandOutput} for command's `response` shape. + * @see {@link CustomerProfilesClientResolvedConfig | config} for command's `input` shape. + * */ export class UpdateProfileCommand extends $Command< UpdateProfileCommandInput, diff --git a/clients/client-customer-profiles/models/models_0.ts b/clients/client-customer-profiles/models/models_0.ts index 492802be3c84..b69c62e765a7 100644 --- a/clients/client-customer-profiles/models/models_0.ts +++ b/clients/client-customer-profiles/models/models_0.ts @@ -11,6 +11,9 @@ export interface AccessDeniedException extends __SmithyException, $MetadataBeare } export namespace AccessDeniedException { + /** + * @internal + */ export const filterSensitiveLog = (obj: AccessDeniedException): any => ({ ...obj, }); @@ -39,6 +42,9 @@ export interface AddProfileKeyRequest { } export namespace AddProfileKeyRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: AddProfileKeyRequest): any => ({ ...obj, }); @@ -57,6 +63,9 @@ export interface AddProfileKeyResponse { } export namespace AddProfileKeyResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: AddProfileKeyResponse): any => ({ ...obj, }); @@ -72,6 +81,9 @@ export interface BadRequestException extends __SmithyException, $MetadataBearer } export namespace BadRequestException { + /** + * @internal + */ export const filterSensitiveLog = (obj: BadRequestException): any => ({ ...obj, }); @@ -87,6 +99,9 @@ export interface InternalServerException extends __SmithyException, $MetadataBea } export namespace InternalServerException { + /** + * @internal + */ export const filterSensitiveLog = (obj: InternalServerException): any => ({ ...obj, }); @@ -102,6 +117,9 @@ export interface ResourceNotFoundException extends __SmithyException, $MetadataB } export namespace ResourceNotFoundException { + /** + * @internal + */ export const filterSensitiveLog = (obj: ResourceNotFoundException): any => ({ ...obj, }); @@ -117,6 +135,9 @@ export interface ThrottlingException extends __SmithyException, $MetadataBearer } export namespace ThrottlingException { + /** + * @internal + */ export const filterSensitiveLog = (obj: ThrottlingException): any => ({ ...obj, }); @@ -179,6 +200,9 @@ export interface Address { } export namespace Address { + /** + * @internal + */ export const filterSensitiveLog = (obj: Address): any => ({ ...obj, }); @@ -322,6 +346,9 @@ export interface ConnectorOperator { } export namespace ConnectorOperator { + /** + * @internal + */ export const filterSensitiveLog = (obj: ConnectorOperator): any => ({ ...obj, }); @@ -360,6 +387,9 @@ export interface CreateDomainRequest { } export namespace CreateDomainRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateDomainRequest): any => ({ ...obj, }); @@ -406,6 +436,9 @@ export interface CreateDomainResponse { } export namespace CreateDomainResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateDomainResponse): any => ({ ...obj, }); @@ -539,6 +572,9 @@ export interface CreateProfileRequest { } export namespace CreateProfileRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateProfileRequest): any => ({ ...obj, }); @@ -552,6 +588,9 @@ export interface CreateProfileResponse { } export namespace CreateProfileResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateProfileResponse): any => ({ ...obj, }); @@ -565,6 +604,9 @@ export interface DeleteDomainRequest { } export namespace DeleteDomainRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteDomainRequest): any => ({ ...obj, }); @@ -578,6 +620,9 @@ export interface DeleteDomainResponse { } export namespace DeleteDomainResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteDomainResponse): any => ({ ...obj, }); @@ -596,6 +641,9 @@ export interface DeleteIntegrationRequest { } export namespace DeleteIntegrationRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteIntegrationRequest): any => ({ ...obj, }); @@ -609,6 +657,9 @@ export interface DeleteIntegrationResponse { } export namespace DeleteIntegrationResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteIntegrationResponse): any => ({ ...obj, }); @@ -627,6 +678,9 @@ export interface DeleteProfileRequest { } export namespace DeleteProfileRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteProfileRequest): any => ({ ...obj, }); @@ -640,6 +694,9 @@ export interface DeleteProfileResponse { } export namespace DeleteProfileResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteProfileResponse): any => ({ ...obj, }); @@ -668,6 +725,9 @@ export interface DeleteProfileKeyRequest { } export namespace DeleteProfileKeyRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteProfileKeyRequest): any => ({ ...obj, }); @@ -681,6 +741,9 @@ export interface DeleteProfileKeyResponse { } export namespace DeleteProfileKeyResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteProfileKeyResponse): any => ({ ...obj, }); @@ -709,6 +772,9 @@ export interface DeleteProfileObjectRequest { } export namespace DeleteProfileObjectRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteProfileObjectRequest): any => ({ ...obj, }); @@ -722,6 +788,9 @@ export interface DeleteProfileObjectResponse { } export namespace DeleteProfileObjectResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteProfileObjectResponse): any => ({ ...obj, }); @@ -740,6 +809,9 @@ export interface DeleteProfileObjectTypeRequest { } export namespace DeleteProfileObjectTypeRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteProfileObjectTypeRequest): any => ({ ...obj, }); @@ -753,6 +825,9 @@ export interface DeleteProfileObjectTypeResponse { } export namespace DeleteProfileObjectTypeResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteProfileObjectTypeResponse): any => ({ ...obj, }); @@ -766,6 +841,9 @@ export interface GetDomainRequest { } export namespace GetDomainRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetDomainRequest): any => ({ ...obj, }); @@ -799,6 +877,9 @@ export interface DomainStats { } export namespace DomainStats { + /** + * @internal + */ export const filterSensitiveLog = (obj: DomainStats): any => ({ ...obj, }); @@ -850,6 +931,9 @@ export interface GetDomainResponse { } export namespace GetDomainResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetDomainResponse): any => ({ ...obj, }); @@ -868,6 +952,9 @@ export interface GetIntegrationRequest { } export namespace GetIntegrationRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetIntegrationRequest): any => ({ ...obj, }); @@ -906,6 +993,9 @@ export interface GetIntegrationResponse { } export namespace GetIntegrationResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetIntegrationResponse): any => ({ ...obj, }); @@ -924,6 +1014,9 @@ export interface GetProfileObjectTypeRequest { } export namespace GetProfileObjectTypeRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetProfileObjectTypeRequest): any => ({ ...obj, }); @@ -960,6 +1053,9 @@ export interface ObjectTypeField { } export namespace ObjectTypeField { + /** + * @internal + */ export const filterSensitiveLog = (obj: ObjectTypeField): any => ({ ...obj, }); @@ -997,6 +1093,9 @@ export interface ObjectTypeKey { } export namespace ObjectTypeKey { + /** + * @internal + */ export const filterSensitiveLog = (obj: ObjectTypeKey): any => ({ ...obj, }); @@ -1065,6 +1164,9 @@ export interface GetProfileObjectTypeResponse { } export namespace GetProfileObjectTypeResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetProfileObjectTypeResponse): any => ({ ...obj, }); @@ -1078,6 +1180,9 @@ export interface GetProfileObjectTypeTemplateRequest { } export namespace GetProfileObjectTypeTemplateRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetProfileObjectTypeTemplateRequest): any => ({ ...obj, }); @@ -1120,6 +1225,9 @@ export interface GetProfileObjectTypeTemplateResponse { } export namespace GetProfileObjectTypeTemplateResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetProfileObjectTypeTemplateResponse): any => ({ ...obj, }); @@ -1143,6 +1251,9 @@ export interface ListAccountIntegrationsRequest { } export namespace ListAccountIntegrationsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListAccountIntegrationsRequest): any => ({ ...obj, }); @@ -1184,6 +1295,9 @@ export interface ListIntegrationItem { } export namespace ListIntegrationItem { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListIntegrationItem): any => ({ ...obj, }); @@ -1202,6 +1316,9 @@ export interface ListAccountIntegrationsResponse { } export namespace ListAccountIntegrationsResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListAccountIntegrationsResponse): any => ({ ...obj, }); @@ -1220,6 +1337,9 @@ export interface ListDomainsRequest { } export namespace ListDomainsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListDomainsRequest): any => ({ ...obj, }); @@ -1251,6 +1371,9 @@ export interface ListDomainItem { } export namespace ListDomainItem { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListDomainItem): any => ({ ...obj, }); @@ -1269,6 +1392,9 @@ export interface ListDomainsResponse { } export namespace ListDomainsResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListDomainsResponse): any => ({ ...obj, }); @@ -1292,6 +1418,9 @@ export interface ListIntegrationsRequest { } export namespace ListIntegrationsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListIntegrationsRequest): any => ({ ...obj, }); @@ -1310,6 +1439,9 @@ export interface ListIntegrationsResponse { } export namespace ListIntegrationsResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListIntegrationsResponse): any => ({ ...obj, }); @@ -1343,6 +1475,9 @@ export interface ListProfileObjectsRequest { } export namespace ListProfileObjectsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListProfileObjectsRequest): any => ({ ...obj, }); @@ -1370,6 +1505,9 @@ export interface ListProfileObjectsItem { } export namespace ListProfileObjectsItem { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListProfileObjectsItem): any => ({ ...obj, }); @@ -1388,6 +1526,9 @@ export interface ListProfileObjectsResponse { } export namespace ListProfileObjectsResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListProfileObjectsResponse): any => ({ ...obj, }); @@ -1411,6 +1552,9 @@ export interface ListProfileObjectTypesRequest { } export namespace ListProfileObjectTypesRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListProfileObjectTypesRequest): any => ({ ...obj, }); @@ -1447,6 +1591,9 @@ export interface ListProfileObjectTypeItem { } export namespace ListProfileObjectTypeItem { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListProfileObjectTypeItem): any => ({ ...obj, }); @@ -1465,6 +1612,9 @@ export interface ListProfileObjectTypesResponse { } export namespace ListProfileObjectTypesResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListProfileObjectTypesResponse): any => ({ ...obj, }); @@ -1483,6 +1633,9 @@ export interface ListProfileObjectTypeTemplatesRequest { } export namespace ListProfileObjectTypeTemplatesRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListProfileObjectTypeTemplatesRequest): any => ({ ...obj, }); @@ -1509,6 +1662,9 @@ export interface ListProfileObjectTypeTemplateItem { } export namespace ListProfileObjectTypeTemplateItem { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListProfileObjectTypeTemplateItem): any => ({ ...obj, }); @@ -1527,6 +1683,9 @@ export interface ListProfileObjectTypeTemplatesResponse { } export namespace ListProfileObjectTypeTemplatesResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListProfileObjectTypeTemplatesResponse): any => ({ ...obj, }); @@ -1540,6 +1699,9 @@ export interface ListTagsForResourceRequest { } export namespace ListTagsForResourceRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListTagsForResourceRequest): any => ({ ...obj, }); @@ -1553,6 +1715,9 @@ export interface ListTagsForResourceResponse { } export namespace ListTagsForResourceResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListTagsForResourceResponse): any => ({ ...obj, }); @@ -1579,6 +1744,9 @@ export interface IncrementalPullConfig { } export namespace IncrementalPullConfig { + /** + * @internal + */ export const filterSensitiveLog = (obj: IncrementalPullConfig): any => ({ ...obj, }); @@ -1595,6 +1763,9 @@ export interface MarketoSourceProperties { } export namespace MarketoSourceProperties { + /** + * @internal + */ export const filterSensitiveLog = (obj: MarketoSourceProperties): any => ({ ...obj, }); @@ -1616,6 +1787,9 @@ export interface S3SourceProperties { } export namespace S3SourceProperties { + /** + * @internal + */ export const filterSensitiveLog = (obj: S3SourceProperties): any => ({ ...obj, }); @@ -1643,6 +1817,9 @@ export interface SalesforceSourceProperties { } export namespace SalesforceSourceProperties { + /** + * @internal + */ export const filterSensitiveLog = (obj: SalesforceSourceProperties): any => ({ ...obj, }); @@ -1659,6 +1836,9 @@ export interface ServiceNowSourceProperties { } export namespace ServiceNowSourceProperties { + /** + * @internal + */ export const filterSensitiveLog = (obj: ServiceNowSourceProperties): any => ({ ...obj, }); @@ -1675,6 +1855,9 @@ export interface ZendeskSourceProperties { } export namespace ZendeskSourceProperties { + /** + * @internal + */ export const filterSensitiveLog = (obj: ZendeskSourceProperties): any => ({ ...obj, }); @@ -1712,6 +1895,9 @@ export interface SourceConnectorProperties { } export namespace SourceConnectorProperties { + /** + * @internal + */ export const filterSensitiveLog = (obj: SourceConnectorProperties): any => ({ ...obj, }); @@ -1748,6 +1934,9 @@ export interface SourceFlowConfig { } export namespace SourceFlowConfig { + /** + * @internal + */ export const filterSensitiveLog = (obj: SourceFlowConfig): any => ({ ...obj, }); @@ -1814,6 +2003,9 @@ export interface Task { } export namespace Task { + /** + * @internal + */ export const filterSensitiveLog = (obj: Task): any => ({ ...obj, }); @@ -1871,6 +2063,9 @@ export interface ScheduledTriggerProperties { } export namespace ScheduledTriggerProperties { + /** + * @internal + */ export const filterSensitiveLog = (obj: ScheduledTriggerProperties): any => ({ ...obj, }); @@ -1888,6 +2083,9 @@ export interface TriggerProperties { } export namespace TriggerProperties { + /** + * @internal + */ export const filterSensitiveLog = (obj: TriggerProperties): any => ({ ...obj, }); @@ -1917,6 +2115,9 @@ export interface TriggerConfig { } export namespace TriggerConfig { + /** + * @internal + */ export const filterSensitiveLog = (obj: TriggerConfig): any => ({ ...obj, }); @@ -1963,6 +2164,9 @@ export interface FlowDefinition { } export namespace FlowDefinition { + /** + * @internal + */ export const filterSensitiveLog = (obj: FlowDefinition): any => ({ ...obj, }); @@ -1997,6 +2201,9 @@ export interface PutIntegrationRequest { } export namespace PutIntegrationRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: PutIntegrationRequest): any => ({ ...obj, }); @@ -2035,6 +2242,9 @@ export interface PutIntegrationResponse { } export namespace PutIntegrationResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: PutIntegrationResponse): any => ({ ...obj, }); @@ -2058,6 +2268,9 @@ export interface PutProfileObjectRequest { } export namespace PutProfileObjectRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: PutProfileObjectRequest): any => ({ ...obj, }); @@ -2071,6 +2284,9 @@ export interface PutProfileObjectResponse { } export namespace PutProfileObjectResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: PutProfileObjectResponse): any => ({ ...obj, }); @@ -2134,6 +2350,9 @@ export interface PutProfileObjectTypeRequest { } export namespace PutProfileObjectTypeRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: PutProfileObjectTypeRequest): any => ({ ...obj, }); @@ -2202,6 +2421,9 @@ export interface PutProfileObjectTypeResponse { } export namespace PutProfileObjectTypeResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: PutProfileObjectTypeResponse): any => ({ ...obj, }); @@ -2238,6 +2460,9 @@ export interface SearchProfilesRequest { } export namespace SearchProfilesRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: SearchProfilesRequest): any => ({ ...obj, }); @@ -2362,6 +2587,9 @@ export interface Profile { } export namespace Profile { + /** + * @internal + */ export const filterSensitiveLog = (obj: Profile): any => ({ ...obj, }); @@ -2380,6 +2608,9 @@ export interface SearchProfilesResponse { } export namespace SearchProfilesResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: SearchProfilesResponse): any => ({ ...obj, }); @@ -2398,6 +2629,9 @@ export interface TagResourceRequest { } export namespace TagResourceRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: TagResourceRequest): any => ({ ...obj, }); @@ -2406,6 +2640,9 @@ export namespace TagResourceRequest { export interface TagResourceResponse {} export namespace TagResourceResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: TagResourceResponse): any => ({ ...obj, }); @@ -2424,6 +2661,9 @@ export interface UntagResourceRequest { } export namespace UntagResourceRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: UntagResourceRequest): any => ({ ...obj, }); @@ -2432,6 +2672,9 @@ export namespace UntagResourceRequest { export interface UntagResourceResponse {} export namespace UntagResourceResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: UntagResourceResponse): any => ({ ...obj, }); @@ -2472,6 +2715,9 @@ export interface UpdateDomainRequest { } export namespace UpdateDomainRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateDomainRequest): any => ({ ...obj, }); @@ -2518,6 +2764,9 @@ export interface UpdateDomainResponse { } export namespace UpdateDomainResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateDomainResponse): any => ({ ...obj, }); @@ -2579,6 +2828,9 @@ export interface UpdateAddress { } export namespace UpdateAddress { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateAddress): any => ({ ...obj, }); @@ -2705,6 +2957,9 @@ export interface UpdateProfileRequest { } export namespace UpdateProfileRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateProfileRequest): any => ({ ...obj, }); @@ -2718,6 +2973,9 @@ export interface UpdateProfileResponse { } export namespace UpdateProfileResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateProfileResponse): any => ({ ...obj, }); diff --git a/clients/client-data-pipeline/commands/ActivatePipelineCommand.ts b/clients/client-data-pipeline/commands/ActivatePipelineCommand.ts index 3dbde7b4888a..1219eae986fe 100644 --- a/clients/client-data-pipeline/commands/ActivatePipelineCommand.ts +++ b/clients/client-data-pipeline/commands/ActivatePipelineCommand.ts @@ -52,6 +52,20 @@ export interface ActivatePipelineCommandOutput extends ActivatePipelineOutput, _ * * * + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { DataPipelineClient, ActivatePipelineCommand } from "@aws-sdk/client-data-pipeline"; // ES Modules import + * // const { DataPipelineClient, ActivatePipelineCommand } = require("@aws-sdk/client-data-pipeline"); // CommonJS import + * const client = new DataPipelineClient(config); + * const command = new ActivatePipelineCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ActivatePipelineCommandInput} for command's `input` shape. + * @see {@link ActivatePipelineCommandOutput} for command's `response` shape. + * @see {@link DataPipelineClientResolvedConfig | config} for command's `input` shape. + * */ export class ActivatePipelineCommand extends $Command< ActivatePipelineCommandInput, diff --git a/clients/client-data-pipeline/commands/AddTagsCommand.ts b/clients/client-data-pipeline/commands/AddTagsCommand.ts index e77eb4109bb4..fb8bf7562ce7 100644 --- a/clients/client-data-pipeline/commands/AddTagsCommand.ts +++ b/clients/client-data-pipeline/commands/AddTagsCommand.ts @@ -19,6 +19,20 @@ export interface AddTagsCommandOutput extends AddTagsOutput, __MetadataBearer {} /** *

Adds or modifies tags for the specified pipeline.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { DataPipelineClient, AddTagsCommand } from "@aws-sdk/client-data-pipeline"; // ES Modules import + * // const { DataPipelineClient, AddTagsCommand } = require("@aws-sdk/client-data-pipeline"); // CommonJS import + * const client = new DataPipelineClient(config); + * const command = new AddTagsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link AddTagsCommandInput} for command's `input` shape. + * @see {@link AddTagsCommandOutput} for command's `response` shape. + * @see {@link DataPipelineClientResolvedConfig | config} for command's `input` shape. + * */ export class AddTagsCommand extends $Command< AddTagsCommandInput, diff --git a/clients/client-data-pipeline/commands/CreatePipelineCommand.ts b/clients/client-data-pipeline/commands/CreatePipelineCommand.ts index fe94f630c36b..13acb23207ad 100644 --- a/clients/client-data-pipeline/commands/CreatePipelineCommand.ts +++ b/clients/client-data-pipeline/commands/CreatePipelineCommand.ts @@ -52,6 +52,20 @@ export interface CreatePipelineCommandOutput extends CreatePipelineOutput, __Met * * * + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { DataPipelineClient, CreatePipelineCommand } from "@aws-sdk/client-data-pipeline"; // ES Modules import + * // const { DataPipelineClient, CreatePipelineCommand } = require("@aws-sdk/client-data-pipeline"); // CommonJS import + * const client = new DataPipelineClient(config); + * const command = new CreatePipelineCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreatePipelineCommandInput} for command's `input` shape. + * @see {@link CreatePipelineCommandOutput} for command's `response` shape. + * @see {@link DataPipelineClientResolvedConfig | config} for command's `input` shape. + * */ export class CreatePipelineCommand extends $Command< CreatePipelineCommandInput, diff --git a/clients/client-data-pipeline/commands/DeactivatePipelineCommand.ts b/clients/client-data-pipeline/commands/DeactivatePipelineCommand.ts index 02be0ce1da4a..c4bae765c422 100644 --- a/clients/client-data-pipeline/commands/DeactivatePipelineCommand.ts +++ b/clients/client-data-pipeline/commands/DeactivatePipelineCommand.ts @@ -25,6 +25,20 @@ export interface DeactivatePipelineCommandOutput extends DeactivatePipelineOutpu * 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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { DataPipelineClient, DeactivatePipelineCommand } from "@aws-sdk/client-data-pipeline"; // ES Modules import + * // const { DataPipelineClient, DeactivatePipelineCommand } = require("@aws-sdk/client-data-pipeline"); // CommonJS import + * const client = new DataPipelineClient(config); + * const command = new DeactivatePipelineCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeactivatePipelineCommandInput} for command's `input` shape. + * @see {@link DeactivatePipelineCommandOutput} for command's `response` shape. + * @see {@link DataPipelineClientResolvedConfig | config} for command's `input` shape. + * */ export class DeactivatePipelineCommand extends $Command< DeactivatePipelineCommandInput, diff --git a/clients/client-data-pipeline/commands/DeletePipelineCommand.ts b/clients/client-data-pipeline/commands/DeletePipelineCommand.ts index 72ca16cc8b54..b1e60d2e0539 100644 --- a/clients/client-data-pipeline/commands/DeletePipelineCommand.ts +++ b/clients/client-data-pipeline/commands/DeletePipelineCommand.ts @@ -53,6 +53,20 @@ export interface DeletePipelineCommandOutput extends __MetadataBearer {} * * * + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { DataPipelineClient, DeletePipelineCommand } from "@aws-sdk/client-data-pipeline"; // ES Modules import + * // const { DataPipelineClient, DeletePipelineCommand } = require("@aws-sdk/client-data-pipeline"); // CommonJS import + * const client = new DataPipelineClient(config); + * const command = new DeletePipelineCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeletePipelineCommandInput} for command's `input` shape. + * @see {@link DeletePipelineCommandOutput} for command's `response` shape. + * @see {@link DataPipelineClientResolvedConfig | config} for command's `input` shape. + * */ export class DeletePipelineCommand extends $Command< DeletePipelineCommandInput, diff --git a/clients/client-data-pipeline/commands/DescribeObjectsCommand.ts b/clients/client-data-pipeline/commands/DescribeObjectsCommand.ts index aae8310b9d9a..a5c670e06e33 100644 --- a/clients/client-data-pipeline/commands/DescribeObjectsCommand.ts +++ b/clients/client-data-pipeline/commands/DescribeObjectsCommand.ts @@ -80,6 +80,20 @@ export interface DescribeObjectsCommandOutput extends DescribeObjectsOutput, __M * * * + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { DataPipelineClient, DescribeObjectsCommand } from "@aws-sdk/client-data-pipeline"; // ES Modules import + * // const { DataPipelineClient, DescribeObjectsCommand } = require("@aws-sdk/client-data-pipeline"); // CommonJS import + * const client = new DataPipelineClient(config); + * const command = new DescribeObjectsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeObjectsCommandInput} for command's `input` shape. + * @see {@link DescribeObjectsCommandOutput} for command's `response` shape. + * @see {@link DataPipelineClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeObjectsCommand extends $Command< DescribeObjectsCommandInput, diff --git a/clients/client-data-pipeline/commands/DescribePipelinesCommand.ts b/clients/client-data-pipeline/commands/DescribePipelinesCommand.ts index 0e73ecab0c9a..4a9dba8058e6 100644 --- a/clients/client-data-pipeline/commands/DescribePipelinesCommand.ts +++ b/clients/client-data-pipeline/commands/DescribePipelinesCommand.ts @@ -83,6 +83,20 @@ export interface DescribePipelinesCommandOutput extends DescribePipelinesOutput, * } * * + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { DataPipelineClient, DescribePipelinesCommand } from "@aws-sdk/client-data-pipeline"; // ES Modules import + * // const { DataPipelineClient, DescribePipelinesCommand } = require("@aws-sdk/client-data-pipeline"); // CommonJS import + * const client = new DataPipelineClient(config); + * const command = new DescribePipelinesCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribePipelinesCommandInput} for command's `input` shape. + * @see {@link DescribePipelinesCommandOutput} for command's `response` shape. + * @see {@link DataPipelineClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribePipelinesCommand extends $Command< DescribePipelinesCommandInput, diff --git a/clients/client-data-pipeline/commands/EvaluateExpressionCommand.ts b/clients/client-data-pipeline/commands/EvaluateExpressionCommand.ts index 3bae964c4442..dc3319ef6cf6 100644 --- a/clients/client-data-pipeline/commands/EvaluateExpressionCommand.ts +++ b/clients/client-data-pipeline/commands/EvaluateExpressionCommand.ts @@ -52,6 +52,20 @@ export interface EvaluateExpressionCommandOutput extends EvaluateExpressionOutpu * {"evaluatedExpression": "Transform started at 2012-12-12T00:00:00 and finished at 2012-12-21T18:00:00"} * * + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { DataPipelineClient, EvaluateExpressionCommand } from "@aws-sdk/client-data-pipeline"; // ES Modules import + * // const { DataPipelineClient, EvaluateExpressionCommand } = require("@aws-sdk/client-data-pipeline"); // CommonJS import + * const client = new DataPipelineClient(config); + * const command = new EvaluateExpressionCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link EvaluateExpressionCommandInput} for command's `input` shape. + * @see {@link EvaluateExpressionCommandOutput} for command's `response` shape. + * @see {@link DataPipelineClientResolvedConfig | config} for command's `input` shape. + * */ export class EvaluateExpressionCommand extends $Command< EvaluateExpressionCommandInput, diff --git a/clients/client-data-pipeline/commands/GetPipelineDefinitionCommand.ts b/clients/client-data-pipeline/commands/GetPipelineDefinitionCommand.ts index a4cce1385df4..3b1b85e8eaf4 100644 --- a/clients/client-data-pipeline/commands/GetPipelineDefinitionCommand.ts +++ b/clients/client-data-pipeline/commands/GetPipelineDefinitionCommand.ts @@ -86,6 +86,20 @@ export interface GetPipelineDefinitionCommandOutput extends GetPipelineDefinitio * * * + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { DataPipelineClient, GetPipelineDefinitionCommand } from "@aws-sdk/client-data-pipeline"; // ES Modules import + * // const { DataPipelineClient, GetPipelineDefinitionCommand } = require("@aws-sdk/client-data-pipeline"); // CommonJS import + * const client = new DataPipelineClient(config); + * const command = new GetPipelineDefinitionCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetPipelineDefinitionCommandInput} for command's `input` shape. + * @see {@link GetPipelineDefinitionCommandOutput} for command's `response` shape. + * @see {@link DataPipelineClientResolvedConfig | config} for command's `input` shape. + * */ export class GetPipelineDefinitionCommand extends $Command< GetPipelineDefinitionCommandInput, diff --git a/clients/client-data-pipeline/commands/ListPipelinesCommand.ts b/clients/client-data-pipeline/commands/ListPipelinesCommand.ts index a098c31dea00..03ab049cebd9 100644 --- a/clients/client-data-pipeline/commands/ListPipelinesCommand.ts +++ b/clients/client-data-pipeline/commands/ListPipelinesCommand.ts @@ -53,6 +53,20 @@ export interface ListPipelinesCommandOutput extends ListPipelinesOutput, __Metad * ] * } * + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { DataPipelineClient, ListPipelinesCommand } from "@aws-sdk/client-data-pipeline"; // ES Modules import + * // const { DataPipelineClient, ListPipelinesCommand } = require("@aws-sdk/client-data-pipeline"); // CommonJS import + * const client = new DataPipelineClient(config); + * const command = new ListPipelinesCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListPipelinesCommandInput} for command's `input` shape. + * @see {@link ListPipelinesCommandOutput} for command's `response` shape. + * @see {@link DataPipelineClientResolvedConfig | config} for command's `input` shape. + * */ export class ListPipelinesCommand extends $Command< ListPipelinesCommandInput, diff --git a/clients/client-data-pipeline/commands/PollForTaskCommand.ts b/clients/client-data-pipeline/commands/PollForTaskCommand.ts index 42cc1526edb2..b64bb01ae236 100644 --- a/clients/client-data-pipeline/commands/PollForTaskCommand.ts +++ b/clients/client-data-pipeline/commands/PollForTaskCommand.ts @@ -100,6 +100,20 @@ export interface PollForTaskCommandOutput extends PollForTaskOutput, __MetadataB * * * + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { DataPipelineClient, PollForTaskCommand } from "@aws-sdk/client-data-pipeline"; // ES Modules import + * // const { DataPipelineClient, PollForTaskCommand } = require("@aws-sdk/client-data-pipeline"); // CommonJS import + * const client = new DataPipelineClient(config); + * const command = new PollForTaskCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link PollForTaskCommandInput} for command's `input` shape. + * @see {@link PollForTaskCommandOutput} for command's `response` shape. + * @see {@link DataPipelineClientResolvedConfig | config} for command's `input` shape. + * */ export class PollForTaskCommand extends $Command< PollForTaskCommandInput, diff --git a/clients/client-data-pipeline/commands/PutPipelineDefinitionCommand.ts b/clients/client-data-pipeline/commands/PutPipelineDefinitionCommand.ts index 3e773dc3a673..0776f5b1c5a4 100644 --- a/clients/client-data-pipeline/commands/PutPipelineDefinitionCommand.ts +++ b/clients/client-data-pipeline/commands/PutPipelineDefinitionCommand.ts @@ -181,6 +181,20 @@ export interface PutPipelineDefinitionCommandOutput extends PutPipelineDefinitio * * * + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { DataPipelineClient, PutPipelineDefinitionCommand } from "@aws-sdk/client-data-pipeline"; // ES Modules import + * // const { DataPipelineClient, PutPipelineDefinitionCommand } = require("@aws-sdk/client-data-pipeline"); // CommonJS import + * const client = new DataPipelineClient(config); + * const command = new PutPipelineDefinitionCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link PutPipelineDefinitionCommandInput} for command's `input` shape. + * @see {@link PutPipelineDefinitionCommandOutput} for command's `response` shape. + * @see {@link DataPipelineClientResolvedConfig | config} for command's `input` shape. + * */ export class PutPipelineDefinitionCommand extends $Command< PutPipelineDefinitionCommandInput, diff --git a/clients/client-data-pipeline/commands/QueryObjectsCommand.ts b/clients/client-data-pipeline/commands/QueryObjectsCommand.ts index 925333c6744a..dc811be76d10 100644 --- a/clients/client-data-pipeline/commands/QueryObjectsCommand.ts +++ b/clients/client-data-pipeline/commands/QueryObjectsCommand.ts @@ -60,6 +60,20 @@ export interface QueryObjectsCommandOutput extends QueryObjectsOutput, __Metadat * } * * + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { DataPipelineClient, QueryObjectsCommand } from "@aws-sdk/client-data-pipeline"; // ES Modules import + * // const { DataPipelineClient, QueryObjectsCommand } = require("@aws-sdk/client-data-pipeline"); // CommonJS import + * const client = new DataPipelineClient(config); + * const command = new QueryObjectsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link QueryObjectsCommandInput} for command's `input` shape. + * @see {@link QueryObjectsCommandOutput} for command's `response` shape. + * @see {@link DataPipelineClientResolvedConfig | config} for command's `input` shape. + * */ export class QueryObjectsCommand extends $Command< QueryObjectsCommandInput, diff --git a/clients/client-data-pipeline/commands/RemoveTagsCommand.ts b/clients/client-data-pipeline/commands/RemoveTagsCommand.ts index a73516b13724..92b205adcf2e 100644 --- a/clients/client-data-pipeline/commands/RemoveTagsCommand.ts +++ b/clients/client-data-pipeline/commands/RemoveTagsCommand.ts @@ -22,6 +22,20 @@ export interface RemoveTagsCommandOutput extends RemoveTagsOutput, __MetadataBea /** *

Removes existing tags from the specified pipeline.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { DataPipelineClient, RemoveTagsCommand } from "@aws-sdk/client-data-pipeline"; // ES Modules import + * // const { DataPipelineClient, RemoveTagsCommand } = require("@aws-sdk/client-data-pipeline"); // CommonJS import + * const client = new DataPipelineClient(config); + * const command = new RemoveTagsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link RemoveTagsCommandInput} for command's `input` shape. + * @see {@link RemoveTagsCommandOutput} for command's `response` shape. + * @see {@link DataPipelineClientResolvedConfig | config} for command's `input` shape. + * */ export class RemoveTagsCommand extends $Command< RemoveTagsCommandInput, diff --git a/clients/client-data-pipeline/commands/ReportTaskProgressCommand.ts b/clients/client-data-pipeline/commands/ReportTaskProgressCommand.ts index b4076a3f6ac3..a45f6d79c1bc 100644 --- a/clients/client-data-pipeline/commands/ReportTaskProgressCommand.ts +++ b/clients/client-data-pipeline/commands/ReportTaskProgressCommand.ts @@ -59,6 +59,20 @@ export interface ReportTaskProgressCommandOutput extends ReportTaskProgressOutpu * * * + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { DataPipelineClient, ReportTaskProgressCommand } from "@aws-sdk/client-data-pipeline"; // ES Modules import + * // const { DataPipelineClient, ReportTaskProgressCommand } = require("@aws-sdk/client-data-pipeline"); // CommonJS import + * const client = new DataPipelineClient(config); + * const command = new ReportTaskProgressCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ReportTaskProgressCommandInput} for command's `input` shape. + * @see {@link ReportTaskProgressCommandOutput} for command's `response` shape. + * @see {@link DataPipelineClientResolvedConfig | config} for command's `input` shape. + * */ export class ReportTaskProgressCommand extends $Command< ReportTaskProgressCommandInput, diff --git a/clients/client-data-pipeline/commands/ReportTaskRunnerHeartbeatCommand.ts b/clients/client-data-pipeline/commands/ReportTaskRunnerHeartbeatCommand.ts index 2602721ff809..e8855743e151 100644 --- a/clients/client-data-pipeline/commands/ReportTaskRunnerHeartbeatCommand.ts +++ b/clients/client-data-pipeline/commands/ReportTaskRunnerHeartbeatCommand.ts @@ -54,6 +54,20 @@ export interface ReportTaskRunnerHeartbeatCommandOutput extends ReportTaskRunner * * * + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { DataPipelineClient, ReportTaskRunnerHeartbeatCommand } from "@aws-sdk/client-data-pipeline"; // ES Modules import + * // const { DataPipelineClient, ReportTaskRunnerHeartbeatCommand } = require("@aws-sdk/client-data-pipeline"); // CommonJS import + * const client = new DataPipelineClient(config); + * const command = new ReportTaskRunnerHeartbeatCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ReportTaskRunnerHeartbeatCommandInput} for command's `input` shape. + * @see {@link ReportTaskRunnerHeartbeatCommandOutput} for command's `response` shape. + * @see {@link DataPipelineClientResolvedConfig | config} for command's `input` shape. + * */ export class ReportTaskRunnerHeartbeatCommand extends $Command< ReportTaskRunnerHeartbeatCommandInput, diff --git a/clients/client-data-pipeline/commands/SetStatusCommand.ts b/clients/client-data-pipeline/commands/SetStatusCommand.ts index 63c13018655c..fc47df600227 100644 --- a/clients/client-data-pipeline/commands/SetStatusCommand.ts +++ b/clients/client-data-pipeline/commands/SetStatusCommand.ts @@ -51,6 +51,20 @@ export interface SetStatusCommandOutput extends __MetadataBearer {} * * * + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { DataPipelineClient, SetStatusCommand } from "@aws-sdk/client-data-pipeline"; // ES Modules import + * // const { DataPipelineClient, SetStatusCommand } = require("@aws-sdk/client-data-pipeline"); // CommonJS import + * const client = new DataPipelineClient(config); + * const command = new SetStatusCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link SetStatusCommandInput} for command's `input` shape. + * @see {@link SetStatusCommandOutput} for command's `response` shape. + * @see {@link DataPipelineClientResolvedConfig | config} for command's `input` shape. + * */ export class SetStatusCommand extends $Command< SetStatusCommandInput, diff --git a/clients/client-data-pipeline/commands/SetTaskStatusCommand.ts b/clients/client-data-pipeline/commands/SetTaskStatusCommand.ts index dba550220db1..cb0731f3e08c 100644 --- a/clients/client-data-pipeline/commands/SetTaskStatusCommand.ts +++ b/clients/client-data-pipeline/commands/SetTaskStatusCommand.ts @@ -52,6 +52,20 @@ export interface SetTaskStatusCommandOutput extends SetTaskStatusOutput, __Metad * * * + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { DataPipelineClient, SetTaskStatusCommand } from "@aws-sdk/client-data-pipeline"; // ES Modules import + * // const { DataPipelineClient, SetTaskStatusCommand } = require("@aws-sdk/client-data-pipeline"); // CommonJS import + * const client = new DataPipelineClient(config); + * const command = new SetTaskStatusCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link SetTaskStatusCommandInput} for command's `input` shape. + * @see {@link SetTaskStatusCommandOutput} for command's `response` shape. + * @see {@link DataPipelineClientResolvedConfig | config} for command's `input` shape. + * */ export class SetTaskStatusCommand extends $Command< SetTaskStatusCommandInput, diff --git a/clients/client-data-pipeline/commands/ValidatePipelineDefinitionCommand.ts b/clients/client-data-pipeline/commands/ValidatePipelineDefinitionCommand.ts index ac0fff586d0b..aa63d1aeb5b6 100644 --- a/clients/client-data-pipeline/commands/ValidatePipelineDefinitionCommand.ts +++ b/clients/client-data-pipeline/commands/ValidatePipelineDefinitionCommand.ts @@ -173,6 +173,20 @@ export interface ValidatePipelineDefinitionCommandOutput extends ValidatePipelin * * * + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { DataPipelineClient, ValidatePipelineDefinitionCommand } from "@aws-sdk/client-data-pipeline"; // ES Modules import + * // const { DataPipelineClient, ValidatePipelineDefinitionCommand } = require("@aws-sdk/client-data-pipeline"); // CommonJS import + * const client = new DataPipelineClient(config); + * const command = new ValidatePipelineDefinitionCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ValidatePipelineDefinitionCommandInput} for command's `input` shape. + * @see {@link ValidatePipelineDefinitionCommandOutput} for command's `response` shape. + * @see {@link DataPipelineClientResolvedConfig | config} for command's `input` shape. + * */ export class ValidatePipelineDefinitionCommand extends $Command< ValidatePipelineDefinitionCommandInput, diff --git a/clients/client-data-pipeline/models/models_0.ts b/clients/client-data-pipeline/models/models_0.ts index c0369815112c..d33e34683dd2 100644 --- a/clients/client-data-pipeline/models/models_0.ts +++ b/clients/client-data-pipeline/models/models_0.ts @@ -17,6 +17,9 @@ export interface ParameterValue { } export namespace ParameterValue { + /** + * @internal + */ export const filterSensitiveLog = (obj: ParameterValue): any => ({ ...obj, }); @@ -43,6 +46,9 @@ export interface ActivatePipelineInput { } export namespace ActivatePipelineInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: ActivatePipelineInput): any => ({ ...obj, }); @@ -54,6 +60,9 @@ export namespace ActivatePipelineInput { export interface ActivatePipelineOutput {} export namespace ActivatePipelineOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: ActivatePipelineOutput): any => ({ ...obj, }); @@ -72,6 +81,9 @@ export interface InternalServiceError extends __SmithyException, $MetadataBearer } export namespace InternalServiceError { + /** + * @internal + */ export const filterSensitiveLog = (obj: InternalServiceError): any => ({ ...obj, }); @@ -90,6 +102,9 @@ export interface InvalidRequestException extends __SmithyException, $MetadataBea } export namespace InvalidRequestException { + /** + * @internal + */ export const filterSensitiveLog = (obj: InvalidRequestException): any => ({ ...obj, }); @@ -108,6 +123,9 @@ export interface PipelineDeletedException extends __SmithyException, $MetadataBe } export namespace PipelineDeletedException { + /** + * @internal + */ export const filterSensitiveLog = (obj: PipelineDeletedException): any => ({ ...obj, }); @@ -126,6 +144,9 @@ export interface PipelineNotFoundException extends __SmithyException, $MetadataB } export namespace PipelineNotFoundException { + /** + * @internal + */ export const filterSensitiveLog = (obj: PipelineNotFoundException): any => ({ ...obj, }); @@ -150,6 +171,9 @@ export interface Tag { } export namespace Tag { + /** + * @internal + */ export const filterSensitiveLog = (obj: Tag): any => ({ ...obj, }); @@ -171,6 +195,9 @@ export interface AddTagsInput { } export namespace AddTagsInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: AddTagsInput): any => ({ ...obj, }); @@ -182,6 +209,9 @@ export namespace AddTagsInput { export interface AddTagsOutput {} export namespace AddTagsOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: AddTagsOutput): any => ({ ...obj, }); @@ -223,6 +253,9 @@ export interface CreatePipelineInput { } export namespace CreatePipelineInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreatePipelineInput): any => ({ ...obj, }); @@ -239,6 +272,9 @@ export interface CreatePipelineOutput { } export namespace CreatePipelineOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreatePipelineOutput): any => ({ ...obj, }); @@ -263,6 +299,9 @@ export interface DeactivatePipelineInput { } export namespace DeactivatePipelineInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeactivatePipelineInput): any => ({ ...obj, }); @@ -274,6 +313,9 @@ export namespace DeactivatePipelineInput { export interface DeactivatePipelineOutput {} export namespace DeactivatePipelineOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeactivatePipelineOutput): any => ({ ...obj, }); @@ -290,6 +332,9 @@ export interface DeletePipelineInput { } export namespace DeletePipelineInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeletePipelineInput): any => ({ ...obj, }); @@ -323,6 +368,9 @@ export interface DescribeObjectsInput { } export namespace DescribeObjectsInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeObjectsInput): any => ({ ...obj, }); @@ -349,6 +397,9 @@ export interface Field { } export namespace Field { + /** + * @internal + */ export const filterSensitiveLog = (obj: Field): any => ({ ...obj, }); @@ -375,6 +426,9 @@ export interface PipelineObject { } export namespace PipelineObject { + /** + * @internal + */ export const filterSensitiveLog = (obj: PipelineObject): any => ({ ...obj, }); @@ -402,6 +456,9 @@ export interface DescribeObjectsOutput { } export namespace DescribeObjectsOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeObjectsOutput): any => ({ ...obj, }); @@ -419,6 +476,9 @@ export interface DescribePipelinesInput { } export namespace DescribePipelinesInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribePipelinesInput): any => ({ ...obj, }); @@ -456,6 +516,9 @@ export interface PipelineDescription { } export namespace PipelineDescription { + /** + * @internal + */ export const filterSensitiveLog = (obj: PipelineDescription): any => ({ ...obj, }); @@ -472,6 +535,9 @@ export interface DescribePipelinesOutput { } export namespace DescribePipelinesOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribePipelinesOutput): any => ({ ...obj, }); @@ -498,6 +564,9 @@ export interface EvaluateExpressionInput { } export namespace EvaluateExpressionInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: EvaluateExpressionInput): any => ({ ...obj, }); @@ -514,6 +583,9 @@ export interface EvaluateExpressionOutput { } export namespace EvaluateExpressionOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: EvaluateExpressionOutput): any => ({ ...obj, }); @@ -532,6 +604,9 @@ export interface TaskNotFoundException extends __SmithyException, $MetadataBeare } export namespace TaskNotFoundException { + /** + * @internal + */ export const filterSensitiveLog = (obj: TaskNotFoundException): any => ({ ...obj, }); @@ -555,6 +630,9 @@ export interface GetPipelineDefinitionInput { } export namespace GetPipelineDefinitionInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetPipelineDefinitionInput): any => ({ ...obj, }); @@ -576,6 +654,9 @@ export interface ParameterAttribute { } export namespace ParameterAttribute { + /** + * @internal + */ export const filterSensitiveLog = (obj: ParameterAttribute): any => ({ ...obj, }); @@ -597,6 +678,9 @@ export interface ParameterObject { } export namespace ParameterObject { + /** + * @internal + */ export const filterSensitiveLog = (obj: ParameterObject): any => ({ ...obj, }); @@ -623,6 +707,9 @@ export interface GetPipelineDefinitionOutput { } export namespace GetPipelineDefinitionOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetPipelineDefinitionOutput): any => ({ ...obj, }); @@ -641,6 +728,9 @@ export interface ListPipelinesInput { } export namespace ListPipelinesInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListPipelinesInput): any => ({ ...obj, }); @@ -662,6 +752,9 @@ export interface PipelineIdName { } export namespace PipelineIdName { + /** + * @internal + */ export const filterSensitiveLog = (obj: PipelineIdName): any => ({ ...obj, }); @@ -690,6 +783,9 @@ export interface ListPipelinesOutput { } export namespace ListPipelinesOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListPipelinesOutput): any => ({ ...obj, }); @@ -713,6 +809,9 @@ export interface InstanceIdentity { } export namespace InstanceIdentity { + /** + * @internal + */ export const filterSensitiveLog = (obj: InstanceIdentity): any => ({ ...obj, }); @@ -741,6 +840,9 @@ export interface PollForTaskInput { } export namespace PollForTaskInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: PollForTaskInput): any => ({ ...obj, }); @@ -772,6 +874,9 @@ export interface TaskObject { } export namespace TaskObject { + /** + * @internal + */ export const filterSensitiveLog = (obj: TaskObject): any => ({ ...obj, }); @@ -790,6 +895,9 @@ export interface PollForTaskOutput { } export namespace PollForTaskOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: PollForTaskOutput): any => ({ ...obj, }); @@ -821,6 +929,9 @@ export interface PutPipelineDefinitionInput { } export namespace PutPipelineDefinitionInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: PutPipelineDefinitionInput): any => ({ ...obj, }); @@ -842,6 +953,9 @@ export interface ValidationError { } export namespace ValidationError { + /** + * @internal + */ export const filterSensitiveLog = (obj: ValidationError): any => ({ ...obj, }); @@ -863,6 +977,9 @@ export interface ValidationWarning { } export namespace ValidationWarning { + /** + * @internal + */ export const filterSensitiveLog = (obj: ValidationWarning): any => ({ ...obj, }); @@ -890,6 +1007,9 @@ export interface PutPipelineDefinitionOutput { } export namespace PutPipelineDefinitionOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: PutPipelineDefinitionOutput): any => ({ ...obj, }); @@ -947,6 +1067,9 @@ export interface Operator { } export namespace Operator { + /** + * @internal + */ export const filterSensitiveLog = (obj: Operator): any => ({ ...obj, }); @@ -968,6 +1091,9 @@ export interface Selector { } export namespace Selector { + /** + * @internal + */ export const filterSensitiveLog = (obj: Selector): any => ({ ...obj, }); @@ -984,6 +1110,9 @@ export interface Query { } export namespace Query { + /** + * @internal + */ export const filterSensitiveLog = (obj: Query): any => ({ ...obj, }); @@ -1025,6 +1154,9 @@ export interface QueryObjectsInput { } export namespace QueryObjectsInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: QueryObjectsInput): any => ({ ...obj, }); @@ -1052,6 +1184,9 @@ export interface QueryObjectsOutput { } export namespace QueryObjectsOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: QueryObjectsOutput): any => ({ ...obj, }); @@ -1073,6 +1208,9 @@ export interface RemoveTagsInput { } export namespace RemoveTagsInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: RemoveTagsInput): any => ({ ...obj, }); @@ -1084,6 +1222,9 @@ export namespace RemoveTagsInput { export interface RemoveTagsOutput {} export namespace RemoveTagsOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: RemoveTagsOutput): any => ({ ...obj, }); @@ -1105,6 +1246,9 @@ export interface ReportTaskProgressInput { } export namespace ReportTaskProgressInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: ReportTaskProgressInput): any => ({ ...obj, }); @@ -1121,6 +1265,9 @@ export interface ReportTaskProgressOutput { } export namespace ReportTaskProgressOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: ReportTaskProgressOutput): any => ({ ...obj, }); @@ -1151,6 +1298,9 @@ export interface ReportTaskRunnerHeartbeatInput { } export namespace ReportTaskRunnerHeartbeatInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: ReportTaskRunnerHeartbeatInput): any => ({ ...obj, }); @@ -1167,6 +1317,9 @@ export interface ReportTaskRunnerHeartbeatOutput { } export namespace ReportTaskRunnerHeartbeatOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: ReportTaskRunnerHeartbeatOutput): any => ({ ...obj, }); @@ -1194,6 +1347,9 @@ export interface SetStatusInput { } export namespace SetStatusInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: SetStatusInput): any => ({ ...obj, }); @@ -1239,6 +1395,9 @@ export interface SetTaskStatusInput { } export namespace SetTaskStatusInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: SetTaskStatusInput): any => ({ ...obj, }); @@ -1250,6 +1409,9 @@ export namespace SetTaskStatusInput { export interface SetTaskStatusOutput {} export namespace SetTaskStatusOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: SetTaskStatusOutput): any => ({ ...obj, }); @@ -1281,6 +1443,9 @@ export interface ValidatePipelineDefinitionInput { } export namespace ValidatePipelineDefinitionInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: ValidatePipelineDefinitionInput): any => ({ ...obj, }); @@ -1307,6 +1472,9 @@ export interface ValidatePipelineDefinitionOutput { } export namespace ValidatePipelineDefinitionOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: ValidatePipelineDefinitionOutput): any => ({ ...obj, }); diff --git a/clients/client-database-migration-service/commands/AddTagsToResourceCommand.ts b/clients/client-database-migration-service/commands/AddTagsToResourceCommand.ts index d9623498dc9d..9427251e0da4 100644 --- a/clients/client-database-migration-service/commands/AddTagsToResourceCommand.ts +++ b/clients/client-database-migration-service/commands/AddTagsToResourceCommand.ts @@ -31,6 +31,20 @@ export interface AddTagsToResourceCommandOutput extends AddTagsToResourceRespons * an IAM policy for DMS. For more information, see * Tag * data type description.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { DatabaseMigrationServiceClient, AddTagsToResourceCommand } from "@aws-sdk/client-database-migration-service"; // ES Modules import + * // const { DatabaseMigrationServiceClient, AddTagsToResourceCommand } = require("@aws-sdk/client-database-migration-service"); // CommonJS import + * const client = new DatabaseMigrationServiceClient(config); + * const command = new AddTagsToResourceCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link AddTagsToResourceCommandInput} for command's `input` shape. + * @see {@link AddTagsToResourceCommandOutput} for command's `response` shape. + * @see {@link DatabaseMigrationServiceClientResolvedConfig | config} for command's `input` shape. + * */ export class AddTagsToResourceCommand extends $Command< AddTagsToResourceCommandInput, diff --git a/clients/client-database-migration-service/commands/ApplyPendingMaintenanceActionCommand.ts b/clients/client-database-migration-service/commands/ApplyPendingMaintenanceActionCommand.ts index 713cd6f8dba1..d5fdff64cbcb 100644 --- a/clients/client-database-migration-service/commands/ApplyPendingMaintenanceActionCommand.ts +++ b/clients/client-database-migration-service/commands/ApplyPendingMaintenanceActionCommand.ts @@ -28,6 +28,20 @@ export interface ApplyPendingMaintenanceActionCommandOutput /** *

Applies a pending maintenance action to a resource (for example, to a replication instance).

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { DatabaseMigrationServiceClient, ApplyPendingMaintenanceActionCommand } from "@aws-sdk/client-database-migration-service"; // ES Modules import + * // const { DatabaseMigrationServiceClient, ApplyPendingMaintenanceActionCommand } = require("@aws-sdk/client-database-migration-service"); // CommonJS import + * const client = new DatabaseMigrationServiceClient(config); + * const command = new ApplyPendingMaintenanceActionCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ApplyPendingMaintenanceActionCommandInput} for command's `input` shape. + * @see {@link ApplyPendingMaintenanceActionCommandOutput} for command's `response` shape. + * @see {@link DatabaseMigrationServiceClientResolvedConfig | config} for command's `input` shape. + * */ export class ApplyPendingMaintenanceActionCommand extends $Command< ApplyPendingMaintenanceActionCommandInput, diff --git a/clients/client-database-migration-service/commands/CancelReplicationTaskAssessmentRunCommand.ts b/clients/client-database-migration-service/commands/CancelReplicationTaskAssessmentRunCommand.ts index 2de3aab95731..087e1dc7a1fd 100644 --- a/clients/client-database-migration-service/commands/CancelReplicationTaskAssessmentRunCommand.ts +++ b/clients/client-database-migration-service/commands/CancelReplicationTaskAssessmentRunCommand.ts @@ -34,6 +34,20 @@ export interface CancelReplicationTaskAssessmentRunCommandOutput *

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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { DatabaseMigrationServiceClient, CancelReplicationTaskAssessmentRunCommand } from "@aws-sdk/client-database-migration-service"; // ES Modules import + * // const { DatabaseMigrationServiceClient, CancelReplicationTaskAssessmentRunCommand } = require("@aws-sdk/client-database-migration-service"); // CommonJS import + * const client = new DatabaseMigrationServiceClient(config); + * const command = new CancelReplicationTaskAssessmentRunCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CancelReplicationTaskAssessmentRunCommandInput} for command's `input` shape. + * @see {@link CancelReplicationTaskAssessmentRunCommandOutput} for command's `response` shape. + * @see {@link DatabaseMigrationServiceClientResolvedConfig | config} for command's `input` shape. + * */ export class CancelReplicationTaskAssessmentRunCommand extends $Command< CancelReplicationTaskAssessmentRunCommandInput, diff --git a/clients/client-database-migration-service/commands/CreateEndpointCommand.ts b/clients/client-database-migration-service/commands/CreateEndpointCommand.ts index 2f3ea2d458bf..1e4f4d7f9039 100644 --- a/clients/client-database-migration-service/commands/CreateEndpointCommand.ts +++ b/clients/client-database-migration-service/commands/CreateEndpointCommand.ts @@ -26,6 +26,20 @@ export interface CreateEndpointCommandOutput extends CreateEndpointResponse, __M /** *

Creates an endpoint using the provided settings.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { DatabaseMigrationServiceClient, CreateEndpointCommand } from "@aws-sdk/client-database-migration-service"; // ES Modules import + * // const { DatabaseMigrationServiceClient, CreateEndpointCommand } = require("@aws-sdk/client-database-migration-service"); // CommonJS import + * const client = new DatabaseMigrationServiceClient(config); + * const command = new CreateEndpointCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreateEndpointCommandInput} for command's `input` shape. + * @see {@link CreateEndpointCommandOutput} for command's `response` shape. + * @see {@link DatabaseMigrationServiceClientResolvedConfig | config} for command's `input` shape. + * */ export class CreateEndpointCommand extends $Command< CreateEndpointCommandInput, diff --git a/clients/client-database-migration-service/commands/CreateEventSubscriptionCommand.ts b/clients/client-database-migration-service/commands/CreateEventSubscriptionCommand.ts index 4ca211d81262..e1000f83b6cd 100644 --- a/clients/client-database-migration-service/commands/CreateEventSubscriptionCommand.ts +++ b/clients/client-database-migration-service/commands/CreateEventSubscriptionCommand.ts @@ -41,6 +41,20 @@ export interface CreateEventSubscriptionCommandOutput extends CreateEventSubscri * Notifications in the AWS Database Migration Service User * Guide. *

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { DatabaseMigrationServiceClient, CreateEventSubscriptionCommand } from "@aws-sdk/client-database-migration-service"; // ES Modules import + * // const { DatabaseMigrationServiceClient, CreateEventSubscriptionCommand } = require("@aws-sdk/client-database-migration-service"); // CommonJS import + * const client = new DatabaseMigrationServiceClient(config); + * const command = new CreateEventSubscriptionCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreateEventSubscriptionCommandInput} for command's `input` shape. + * @see {@link CreateEventSubscriptionCommandOutput} for command's `response` shape. + * @see {@link DatabaseMigrationServiceClientResolvedConfig | config} for command's `input` shape. + * */ export class CreateEventSubscriptionCommand extends $Command< CreateEventSubscriptionCommandInput, diff --git a/clients/client-database-migration-service/commands/CreateReplicationInstanceCommand.ts b/clients/client-database-migration-service/commands/CreateReplicationInstanceCommand.ts index d003b113a39b..112afe7d73f3 100644 --- a/clients/client-database-migration-service/commands/CreateReplicationInstanceCommand.ts +++ b/clients/client-database-migration-service/commands/CreateReplicationInstanceCommand.ts @@ -31,6 +31,20 @@ export interface CreateReplicationInstanceCommandOutput extends CreateReplicatio * Creating the IAM Roles to Use With the AWS CLI and AWS DMS API. For * information on the required permissions, see * IAM Permissions Needed to Use AWS DMS.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { DatabaseMigrationServiceClient, CreateReplicationInstanceCommand } from "@aws-sdk/client-database-migration-service"; // ES Modules import + * // const { DatabaseMigrationServiceClient, CreateReplicationInstanceCommand } = require("@aws-sdk/client-database-migration-service"); // CommonJS import + * const client = new DatabaseMigrationServiceClient(config); + * const command = new CreateReplicationInstanceCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreateReplicationInstanceCommandInput} for command's `input` shape. + * @see {@link CreateReplicationInstanceCommandOutput} for command's `response` shape. + * @see {@link DatabaseMigrationServiceClientResolvedConfig | config} for command's `input` shape. + * */ export class CreateReplicationInstanceCommand extends $Command< CreateReplicationInstanceCommandInput, diff --git a/clients/client-database-migration-service/commands/CreateReplicationSubnetGroupCommand.ts b/clients/client-database-migration-service/commands/CreateReplicationSubnetGroupCommand.ts index 648c4d48b283..2ba41eb03f6c 100644 --- a/clients/client-database-migration-service/commands/CreateReplicationSubnetGroupCommand.ts +++ b/clients/client-database-migration-service/commands/CreateReplicationSubnetGroupCommand.ts @@ -28,6 +28,20 @@ export interface CreateReplicationSubnetGroupCommandOutput /** *

Creates a replication subnet group given a list of the subnet IDs in a VPC.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { DatabaseMigrationServiceClient, CreateReplicationSubnetGroupCommand } from "@aws-sdk/client-database-migration-service"; // ES Modules import + * // const { DatabaseMigrationServiceClient, CreateReplicationSubnetGroupCommand } = require("@aws-sdk/client-database-migration-service"); // CommonJS import + * const client = new DatabaseMigrationServiceClient(config); + * const command = new CreateReplicationSubnetGroupCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreateReplicationSubnetGroupCommandInput} for command's `input` shape. + * @see {@link CreateReplicationSubnetGroupCommandOutput} for command's `response` shape. + * @see {@link DatabaseMigrationServiceClientResolvedConfig | config} for command's `input` shape. + * */ export class CreateReplicationSubnetGroupCommand extends $Command< CreateReplicationSubnetGroupCommandInput, diff --git a/clients/client-database-migration-service/commands/CreateReplicationTaskCommand.ts b/clients/client-database-migration-service/commands/CreateReplicationTaskCommand.ts index cbe3136cee75..fd3107ab3b5b 100644 --- a/clients/client-database-migration-service/commands/CreateReplicationTaskCommand.ts +++ b/clients/client-database-migration-service/commands/CreateReplicationTaskCommand.ts @@ -26,6 +26,20 @@ export interface CreateReplicationTaskCommandOutput extends CreateReplicationTas /** *

Creates a replication task using the specified parameters.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { DatabaseMigrationServiceClient, CreateReplicationTaskCommand } from "@aws-sdk/client-database-migration-service"; // ES Modules import + * // const { DatabaseMigrationServiceClient, CreateReplicationTaskCommand } = require("@aws-sdk/client-database-migration-service"); // CommonJS import + * const client = new DatabaseMigrationServiceClient(config); + * const command = new CreateReplicationTaskCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreateReplicationTaskCommandInput} for command's `input` shape. + * @see {@link CreateReplicationTaskCommandOutput} for command's `response` shape. + * @see {@link DatabaseMigrationServiceClientResolvedConfig | config} for command's `input` shape. + * */ export class CreateReplicationTaskCommand extends $Command< CreateReplicationTaskCommandInput, diff --git a/clients/client-database-migration-service/commands/DeleteCertificateCommand.ts b/clients/client-database-migration-service/commands/DeleteCertificateCommand.ts index 42aded673afd..6d442ab23c89 100644 --- a/clients/client-database-migration-service/commands/DeleteCertificateCommand.ts +++ b/clients/client-database-migration-service/commands/DeleteCertificateCommand.ts @@ -26,6 +26,20 @@ export interface DeleteCertificateCommandOutput extends DeleteCertificateRespons /** *

Deletes the specified certificate.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { DatabaseMigrationServiceClient, DeleteCertificateCommand } from "@aws-sdk/client-database-migration-service"; // ES Modules import + * // const { DatabaseMigrationServiceClient, DeleteCertificateCommand } = require("@aws-sdk/client-database-migration-service"); // CommonJS import + * const client = new DatabaseMigrationServiceClient(config); + * const command = new DeleteCertificateCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteCertificateCommandInput} for command's `input` shape. + * @see {@link DeleteCertificateCommandOutput} for command's `response` shape. + * @see {@link DatabaseMigrationServiceClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteCertificateCommand extends $Command< DeleteCertificateCommandInput, diff --git a/clients/client-database-migration-service/commands/DeleteConnectionCommand.ts b/clients/client-database-migration-service/commands/DeleteConnectionCommand.ts index 540aee31ce56..6e84a3df501a 100644 --- a/clients/client-database-migration-service/commands/DeleteConnectionCommand.ts +++ b/clients/client-database-migration-service/commands/DeleteConnectionCommand.ts @@ -26,6 +26,20 @@ export interface DeleteConnectionCommandOutput extends DeleteConnectionResponse, /** *

Deletes the connection between a replication instance and an endpoint.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { DatabaseMigrationServiceClient, DeleteConnectionCommand } from "@aws-sdk/client-database-migration-service"; // ES Modules import + * // const { DatabaseMigrationServiceClient, DeleteConnectionCommand } = require("@aws-sdk/client-database-migration-service"); // CommonJS import + * const client = new DatabaseMigrationServiceClient(config); + * const command = new DeleteConnectionCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteConnectionCommandInput} for command's `input` shape. + * @see {@link DeleteConnectionCommandOutput} for command's `response` shape. + * @see {@link DatabaseMigrationServiceClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteConnectionCommand extends $Command< DeleteConnectionCommandInput, diff --git a/clients/client-database-migration-service/commands/DeleteEndpointCommand.ts b/clients/client-database-migration-service/commands/DeleteEndpointCommand.ts index 0b0c621511c1..ee2d12263e03 100644 --- a/clients/client-database-migration-service/commands/DeleteEndpointCommand.ts +++ b/clients/client-database-migration-service/commands/DeleteEndpointCommand.ts @@ -31,6 +31,20 @@ export interface DeleteEndpointCommandOutput extends DeleteEndpointResponse, __M * endpoint.

* *

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { DatabaseMigrationServiceClient, DeleteEndpointCommand } from "@aws-sdk/client-database-migration-service"; // ES Modules import + * // const { DatabaseMigrationServiceClient, DeleteEndpointCommand } = require("@aws-sdk/client-database-migration-service"); // CommonJS import + * const client = new DatabaseMigrationServiceClient(config); + * const command = new DeleteEndpointCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteEndpointCommandInput} for command's `input` shape. + * @see {@link DeleteEndpointCommandOutput} for command's `response` shape. + * @see {@link DatabaseMigrationServiceClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteEndpointCommand extends $Command< DeleteEndpointCommandInput, diff --git a/clients/client-database-migration-service/commands/DeleteEventSubscriptionCommand.ts b/clients/client-database-migration-service/commands/DeleteEventSubscriptionCommand.ts index e6d306f6430b..f124d0350dec 100644 --- a/clients/client-database-migration-service/commands/DeleteEventSubscriptionCommand.ts +++ b/clients/client-database-migration-service/commands/DeleteEventSubscriptionCommand.ts @@ -26,6 +26,20 @@ export interface DeleteEventSubscriptionCommandOutput extends DeleteEventSubscri /** *

Deletes an AWS DMS event subscription.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { DatabaseMigrationServiceClient, DeleteEventSubscriptionCommand } from "@aws-sdk/client-database-migration-service"; // ES Modules import + * // const { DatabaseMigrationServiceClient, DeleteEventSubscriptionCommand } = require("@aws-sdk/client-database-migration-service"); // CommonJS import + * const client = new DatabaseMigrationServiceClient(config); + * const command = new DeleteEventSubscriptionCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteEventSubscriptionCommandInput} for command's `input` shape. + * @see {@link DeleteEventSubscriptionCommandOutput} for command's `response` shape. + * @see {@link DatabaseMigrationServiceClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteEventSubscriptionCommand extends $Command< DeleteEventSubscriptionCommandInput, diff --git a/clients/client-database-migration-service/commands/DeleteReplicationInstanceCommand.ts b/clients/client-database-migration-service/commands/DeleteReplicationInstanceCommand.ts index cc50e9d31d9b..0720f9805fd5 100644 --- a/clients/client-database-migration-service/commands/DeleteReplicationInstanceCommand.ts +++ b/clients/client-database-migration-service/commands/DeleteReplicationInstanceCommand.ts @@ -31,6 +31,20 @@ export interface DeleteReplicationInstanceCommandOutput extends DeleteReplicatio * before you can delete it.

* *

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { DatabaseMigrationServiceClient, DeleteReplicationInstanceCommand } from "@aws-sdk/client-database-migration-service"; // ES Modules import + * // const { DatabaseMigrationServiceClient, DeleteReplicationInstanceCommand } = require("@aws-sdk/client-database-migration-service"); // CommonJS import + * const client = new DatabaseMigrationServiceClient(config); + * const command = new DeleteReplicationInstanceCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteReplicationInstanceCommandInput} for command's `input` shape. + * @see {@link DeleteReplicationInstanceCommandOutput} for command's `response` shape. + * @see {@link DatabaseMigrationServiceClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteReplicationInstanceCommand extends $Command< DeleteReplicationInstanceCommandInput, diff --git a/clients/client-database-migration-service/commands/DeleteReplicationSubnetGroupCommand.ts b/clients/client-database-migration-service/commands/DeleteReplicationSubnetGroupCommand.ts index dd56d37b437e..47b23ae2f765 100644 --- a/clients/client-database-migration-service/commands/DeleteReplicationSubnetGroupCommand.ts +++ b/clients/client-database-migration-service/commands/DeleteReplicationSubnetGroupCommand.ts @@ -28,6 +28,20 @@ export interface DeleteReplicationSubnetGroupCommandOutput /** *

Deletes a subnet group.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { DatabaseMigrationServiceClient, DeleteReplicationSubnetGroupCommand } from "@aws-sdk/client-database-migration-service"; // ES Modules import + * // const { DatabaseMigrationServiceClient, DeleteReplicationSubnetGroupCommand } = require("@aws-sdk/client-database-migration-service"); // CommonJS import + * const client = new DatabaseMigrationServiceClient(config); + * const command = new DeleteReplicationSubnetGroupCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteReplicationSubnetGroupCommandInput} for command's `input` shape. + * @see {@link DeleteReplicationSubnetGroupCommandOutput} for command's `response` shape. + * @see {@link DatabaseMigrationServiceClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteReplicationSubnetGroupCommand extends $Command< DeleteReplicationSubnetGroupCommandInput, diff --git a/clients/client-database-migration-service/commands/DeleteReplicationTaskAssessmentRunCommand.ts b/clients/client-database-migration-service/commands/DeleteReplicationTaskAssessmentRunCommand.ts index 8b854ace0770..85ace3a93cc7 100644 --- a/clients/client-database-migration-service/commands/DeleteReplicationTaskAssessmentRunCommand.ts +++ b/clients/client-database-migration-service/commands/DeleteReplicationTaskAssessmentRunCommand.ts @@ -34,6 +34,20 @@ export interface DeleteReplicationTaskAssessmentRunCommandOutput *

This operation removes all metadata that AWS 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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { DatabaseMigrationServiceClient, DeleteReplicationTaskAssessmentRunCommand } from "@aws-sdk/client-database-migration-service"; // ES Modules import + * // const { DatabaseMigrationServiceClient, DeleteReplicationTaskAssessmentRunCommand } = require("@aws-sdk/client-database-migration-service"); // CommonJS import + * const client = new DatabaseMigrationServiceClient(config); + * const command = new DeleteReplicationTaskAssessmentRunCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteReplicationTaskAssessmentRunCommandInput} for command's `input` shape. + * @see {@link DeleteReplicationTaskAssessmentRunCommandOutput} for command's `response` shape. + * @see {@link DatabaseMigrationServiceClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteReplicationTaskAssessmentRunCommand extends $Command< DeleteReplicationTaskAssessmentRunCommandInput, diff --git a/clients/client-database-migration-service/commands/DeleteReplicationTaskCommand.ts b/clients/client-database-migration-service/commands/DeleteReplicationTaskCommand.ts index bf4d151a0c31..f2c3d04931f2 100644 --- a/clients/client-database-migration-service/commands/DeleteReplicationTaskCommand.ts +++ b/clients/client-database-migration-service/commands/DeleteReplicationTaskCommand.ts @@ -26,6 +26,20 @@ export interface DeleteReplicationTaskCommandOutput extends DeleteReplicationTas /** *

Deletes the specified replication task.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { DatabaseMigrationServiceClient, DeleteReplicationTaskCommand } from "@aws-sdk/client-database-migration-service"; // ES Modules import + * // const { DatabaseMigrationServiceClient, DeleteReplicationTaskCommand } = require("@aws-sdk/client-database-migration-service"); // CommonJS import + * const client = new DatabaseMigrationServiceClient(config); + * const command = new DeleteReplicationTaskCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteReplicationTaskCommandInput} for command's `input` shape. + * @see {@link DeleteReplicationTaskCommandOutput} for command's `response` shape. + * @see {@link DatabaseMigrationServiceClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteReplicationTaskCommand extends $Command< DeleteReplicationTaskCommandInput, diff --git a/clients/client-database-migration-service/commands/DescribeAccountAttributesCommand.ts b/clients/client-database-migration-service/commands/DescribeAccountAttributesCommand.ts index ef26063ca41f..7fd84f88b46c 100644 --- a/clients/client-database-migration-service/commands/DescribeAccountAttributesCommand.ts +++ b/clients/client-database-migration-service/commands/DescribeAccountAttributesCommand.ts @@ -32,6 +32,20 @@ export interface DescribeAccountAttributesCommandOutput extends DescribeAccountA * 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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { DatabaseMigrationServiceClient, DescribeAccountAttributesCommand } from "@aws-sdk/client-database-migration-service"; // ES Modules import + * // const { DatabaseMigrationServiceClient, DescribeAccountAttributesCommand } = require("@aws-sdk/client-database-migration-service"); // CommonJS import + * const client = new DatabaseMigrationServiceClient(config); + * const command = new DescribeAccountAttributesCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeAccountAttributesCommandInput} for command's `input` shape. + * @see {@link DescribeAccountAttributesCommandOutput} for command's `response` shape. + * @see {@link DatabaseMigrationServiceClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeAccountAttributesCommand extends $Command< DescribeAccountAttributesCommandInput, diff --git a/clients/client-database-migration-service/commands/DescribeApplicableIndividualAssessmentsCommand.ts b/clients/client-database-migration-service/commands/DescribeApplicableIndividualAssessmentsCommand.ts index 06e7d921096f..d0d30b3f85ee 100644 --- a/clients/client-database-migration-service/commands/DescribeApplicableIndividualAssessmentsCommand.ts +++ b/clients/client-database-migration-service/commands/DescribeApplicableIndividualAssessmentsCommand.ts @@ -46,6 +46,20 @@ export interface DescribeApplicableIndividualAssessmentsCommandOutput * 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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { DatabaseMigrationServiceClient, DescribeApplicableIndividualAssessmentsCommand } from "@aws-sdk/client-database-migration-service"; // ES Modules import + * // const { DatabaseMigrationServiceClient, DescribeApplicableIndividualAssessmentsCommand } = require("@aws-sdk/client-database-migration-service"); // CommonJS import + * const client = new DatabaseMigrationServiceClient(config); + * const command = new DescribeApplicableIndividualAssessmentsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeApplicableIndividualAssessmentsCommandInput} for command's `input` shape. + * @see {@link DescribeApplicableIndividualAssessmentsCommandOutput} for command's `response` shape. + * @see {@link DatabaseMigrationServiceClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeApplicableIndividualAssessmentsCommand extends $Command< DescribeApplicableIndividualAssessmentsCommandInput, diff --git a/clients/client-database-migration-service/commands/DescribeCertificatesCommand.ts b/clients/client-database-migration-service/commands/DescribeCertificatesCommand.ts index 0ef420d557b5..6f15fd2ed8b2 100644 --- a/clients/client-database-migration-service/commands/DescribeCertificatesCommand.ts +++ b/clients/client-database-migration-service/commands/DescribeCertificatesCommand.ts @@ -26,6 +26,20 @@ export interface DescribeCertificatesCommandOutput extends DescribeCertificatesR /** *

Provides a description of the certificate.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { DatabaseMigrationServiceClient, DescribeCertificatesCommand } from "@aws-sdk/client-database-migration-service"; // ES Modules import + * // const { DatabaseMigrationServiceClient, DescribeCertificatesCommand } = require("@aws-sdk/client-database-migration-service"); // CommonJS import + * const client = new DatabaseMigrationServiceClient(config); + * const command = new DescribeCertificatesCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeCertificatesCommandInput} for command's `input` shape. + * @see {@link DescribeCertificatesCommandOutput} for command's `response` shape. + * @see {@link DatabaseMigrationServiceClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeCertificatesCommand extends $Command< DescribeCertificatesCommandInput, diff --git a/clients/client-database-migration-service/commands/DescribeConnectionsCommand.ts b/clients/client-database-migration-service/commands/DescribeConnectionsCommand.ts index 7213e5be5ffc..048b92070207 100644 --- a/clients/client-database-migration-service/commands/DescribeConnectionsCommand.ts +++ b/clients/client-database-migration-service/commands/DescribeConnectionsCommand.ts @@ -27,6 +27,20 @@ export interface DescribeConnectionsCommandOutput extends DescribeConnectionsRes /** *

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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { DatabaseMigrationServiceClient, DescribeConnectionsCommand } from "@aws-sdk/client-database-migration-service"; // ES Modules import + * // const { DatabaseMigrationServiceClient, DescribeConnectionsCommand } = require("@aws-sdk/client-database-migration-service"); // CommonJS import + * const client = new DatabaseMigrationServiceClient(config); + * const command = new DescribeConnectionsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeConnectionsCommandInput} for command's `input` shape. + * @see {@link DescribeConnectionsCommandOutput} for command's `response` shape. + * @see {@link DatabaseMigrationServiceClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeConnectionsCommand extends $Command< DescribeConnectionsCommandInput, diff --git a/clients/client-database-migration-service/commands/DescribeEndpointSettingsCommand.ts b/clients/client-database-migration-service/commands/DescribeEndpointSettingsCommand.ts index 7163f558bae3..18010c69c758 100644 --- a/clients/client-database-migration-service/commands/DescribeEndpointSettingsCommand.ts +++ b/clients/client-database-migration-service/commands/DescribeEndpointSettingsCommand.ts @@ -27,6 +27,20 @@ export interface DescribeEndpointSettingsCommandOutput extends DescribeEndpointS /** *

Returns information about the possible endpoint settings available * when you create an endpoint for a specific database engine.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { DatabaseMigrationServiceClient, DescribeEndpointSettingsCommand } from "@aws-sdk/client-database-migration-service"; // ES Modules import + * // const { DatabaseMigrationServiceClient, DescribeEndpointSettingsCommand } = require("@aws-sdk/client-database-migration-service"); // CommonJS import + * const client = new DatabaseMigrationServiceClient(config); + * const command = new DescribeEndpointSettingsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeEndpointSettingsCommandInput} for command's `input` shape. + * @see {@link DescribeEndpointSettingsCommandOutput} for command's `response` shape. + * @see {@link DatabaseMigrationServiceClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeEndpointSettingsCommand extends $Command< DescribeEndpointSettingsCommandInput, diff --git a/clients/client-database-migration-service/commands/DescribeEndpointTypesCommand.ts b/clients/client-database-migration-service/commands/DescribeEndpointTypesCommand.ts index c311c80b2a9d..dd47fedfbf5f 100644 --- a/clients/client-database-migration-service/commands/DescribeEndpointTypesCommand.ts +++ b/clients/client-database-migration-service/commands/DescribeEndpointTypesCommand.ts @@ -26,6 +26,20 @@ export interface DescribeEndpointTypesCommandOutput extends DescribeEndpointType /** *

Returns information about the type of endpoints available.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { DatabaseMigrationServiceClient, DescribeEndpointTypesCommand } from "@aws-sdk/client-database-migration-service"; // ES Modules import + * // const { DatabaseMigrationServiceClient, DescribeEndpointTypesCommand } = require("@aws-sdk/client-database-migration-service"); // CommonJS import + * const client = new DatabaseMigrationServiceClient(config); + * const command = new DescribeEndpointTypesCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeEndpointTypesCommandInput} for command's `input` shape. + * @see {@link DescribeEndpointTypesCommandOutput} for command's `response` shape. + * @see {@link DatabaseMigrationServiceClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeEndpointTypesCommand extends $Command< DescribeEndpointTypesCommandInput, diff --git a/clients/client-database-migration-service/commands/DescribeEndpointsCommand.ts b/clients/client-database-migration-service/commands/DescribeEndpointsCommand.ts index 302e2b315052..b8aa816fa484 100644 --- a/clients/client-database-migration-service/commands/DescribeEndpointsCommand.ts +++ b/clients/client-database-migration-service/commands/DescribeEndpointsCommand.ts @@ -26,6 +26,20 @@ export interface DescribeEndpointsCommandOutput extends DescribeEndpointsRespons /** *

Returns information about the endpoints for your account in the current region.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { DatabaseMigrationServiceClient, DescribeEndpointsCommand } from "@aws-sdk/client-database-migration-service"; // ES Modules import + * // const { DatabaseMigrationServiceClient, DescribeEndpointsCommand } = require("@aws-sdk/client-database-migration-service"); // CommonJS import + * const client = new DatabaseMigrationServiceClient(config); + * const command = new DescribeEndpointsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeEndpointsCommandInput} for command's `input` shape. + * @see {@link DescribeEndpointsCommandOutput} for command's `response` shape. + * @see {@link DatabaseMigrationServiceClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeEndpointsCommand extends $Command< DescribeEndpointsCommandInput, diff --git a/clients/client-database-migration-service/commands/DescribeEventCategoriesCommand.ts b/clients/client-database-migration-service/commands/DescribeEventCategoriesCommand.ts index c94a3e7793d8..6a461ae5f74c 100644 --- a/clients/client-database-migration-service/commands/DescribeEventCategoriesCommand.ts +++ b/clients/client-database-migration-service/commands/DescribeEventCategoriesCommand.ts @@ -30,6 +30,20 @@ export interface DescribeEventCategoriesCommandOutput extends DescribeEventCateg * and Notifications in the AWS Database Migration Service User * Guide. *

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { DatabaseMigrationServiceClient, DescribeEventCategoriesCommand } from "@aws-sdk/client-database-migration-service"; // ES Modules import + * // const { DatabaseMigrationServiceClient, DescribeEventCategoriesCommand } = require("@aws-sdk/client-database-migration-service"); // CommonJS import + * const client = new DatabaseMigrationServiceClient(config); + * const command = new DescribeEventCategoriesCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeEventCategoriesCommandInput} for command's `input` shape. + * @see {@link DescribeEventCategoriesCommandOutput} for command's `response` shape. + * @see {@link DatabaseMigrationServiceClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeEventCategoriesCommand extends $Command< DescribeEventCategoriesCommandInput, diff --git a/clients/client-database-migration-service/commands/DescribeEventSubscriptionsCommand.ts b/clients/client-database-migration-service/commands/DescribeEventSubscriptionsCommand.ts index 40da48edf08a..30ec8fa8ff92 100644 --- a/clients/client-database-migration-service/commands/DescribeEventSubscriptionsCommand.ts +++ b/clients/client-database-migration-service/commands/DescribeEventSubscriptionsCommand.ts @@ -31,6 +31,20 @@ export interface DescribeEventSubscriptionsCommandOutput extends DescribeEventSu * CreationTime, and Status.

*

If you specify SubscriptionName, this action lists the description for that * subscription.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { DatabaseMigrationServiceClient, DescribeEventSubscriptionsCommand } from "@aws-sdk/client-database-migration-service"; // ES Modules import + * // const { DatabaseMigrationServiceClient, DescribeEventSubscriptionsCommand } = require("@aws-sdk/client-database-migration-service"); // CommonJS import + * const client = new DatabaseMigrationServiceClient(config); + * const command = new DescribeEventSubscriptionsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeEventSubscriptionsCommandInput} for command's `input` shape. + * @see {@link DescribeEventSubscriptionsCommandOutput} for command's `response` shape. + * @see {@link DatabaseMigrationServiceClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeEventSubscriptionsCommand extends $Command< DescribeEventSubscriptionsCommandInput, diff --git a/clients/client-database-migration-service/commands/DescribeEventsCommand.ts b/clients/client-database-migration-service/commands/DescribeEventsCommand.ts index f9b58f3e2499..2d5679b8c5e9 100644 --- a/clients/client-database-migration-service/commands/DescribeEventsCommand.ts +++ b/clients/client-database-migration-service/commands/DescribeEventsCommand.ts @@ -30,6 +30,20 @@ export interface DescribeEventsCommandOutput extends DescribeEventsResponse, __M * Notifications in the AWS Database Migration User * Guide. *

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { DatabaseMigrationServiceClient, DescribeEventsCommand } from "@aws-sdk/client-database-migration-service"; // ES Modules import + * // const { DatabaseMigrationServiceClient, DescribeEventsCommand } = require("@aws-sdk/client-database-migration-service"); // CommonJS import + * const client = new DatabaseMigrationServiceClient(config); + * const command = new DescribeEventsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeEventsCommandInput} for command's `input` shape. + * @see {@link DescribeEventsCommandOutput} for command's `response` shape. + * @see {@link DatabaseMigrationServiceClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeEventsCommand extends $Command< DescribeEventsCommandInput, diff --git a/clients/client-database-migration-service/commands/DescribeOrderableReplicationInstancesCommand.ts b/clients/client-database-migration-service/commands/DescribeOrderableReplicationInstancesCommand.ts index 405aaf4b73b4..4ae2f8721548 100644 --- a/clients/client-database-migration-service/commands/DescribeOrderableReplicationInstancesCommand.ts +++ b/clients/client-database-migration-service/commands/DescribeOrderableReplicationInstancesCommand.ts @@ -33,6 +33,20 @@ export interface DescribeOrderableReplicationInstancesCommandOutput /** *

Returns information about the replication instance types that can be created in the * specified region.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { DatabaseMigrationServiceClient, DescribeOrderableReplicationInstancesCommand } from "@aws-sdk/client-database-migration-service"; // ES Modules import + * // const { DatabaseMigrationServiceClient, DescribeOrderableReplicationInstancesCommand } = require("@aws-sdk/client-database-migration-service"); // CommonJS import + * const client = new DatabaseMigrationServiceClient(config); + * const command = new DescribeOrderableReplicationInstancesCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeOrderableReplicationInstancesCommandInput} for command's `input` shape. + * @see {@link DescribeOrderableReplicationInstancesCommandOutput} for command's `response` shape. + * @see {@link DatabaseMigrationServiceClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeOrderableReplicationInstancesCommand extends $Command< DescribeOrderableReplicationInstancesCommandInput, diff --git a/clients/client-database-migration-service/commands/DescribePendingMaintenanceActionsCommand.ts b/clients/client-database-migration-service/commands/DescribePendingMaintenanceActionsCommand.ts index 9c2dadfefc1f..e797ac7c6270 100644 --- a/clients/client-database-migration-service/commands/DescribePendingMaintenanceActionsCommand.ts +++ b/clients/client-database-migration-service/commands/DescribePendingMaintenanceActionsCommand.ts @@ -31,6 +31,20 @@ export interface DescribePendingMaintenanceActionsCommandOutput /** *

For internal use only

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { DatabaseMigrationServiceClient, DescribePendingMaintenanceActionsCommand } from "@aws-sdk/client-database-migration-service"; // ES Modules import + * // const { DatabaseMigrationServiceClient, DescribePendingMaintenanceActionsCommand } = require("@aws-sdk/client-database-migration-service"); // CommonJS import + * const client = new DatabaseMigrationServiceClient(config); + * const command = new DescribePendingMaintenanceActionsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribePendingMaintenanceActionsCommandInput} for command's `input` shape. + * @see {@link DescribePendingMaintenanceActionsCommandOutput} for command's `response` shape. + * @see {@link DatabaseMigrationServiceClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribePendingMaintenanceActionsCommand extends $Command< DescribePendingMaintenanceActionsCommandInput, diff --git a/clients/client-database-migration-service/commands/DescribeRefreshSchemasStatusCommand.ts b/clients/client-database-migration-service/commands/DescribeRefreshSchemasStatusCommand.ts index 7bfdd1365974..e4ade54be7bf 100644 --- a/clients/client-database-migration-service/commands/DescribeRefreshSchemasStatusCommand.ts +++ b/clients/client-database-migration-service/commands/DescribeRefreshSchemasStatusCommand.ts @@ -28,6 +28,20 @@ export interface DescribeRefreshSchemasStatusCommandOutput /** *

Returns the status of the RefreshSchemas operation.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { DatabaseMigrationServiceClient, DescribeRefreshSchemasStatusCommand } from "@aws-sdk/client-database-migration-service"; // ES Modules import + * // const { DatabaseMigrationServiceClient, DescribeRefreshSchemasStatusCommand } = require("@aws-sdk/client-database-migration-service"); // CommonJS import + * const client = new DatabaseMigrationServiceClient(config); + * const command = new DescribeRefreshSchemasStatusCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeRefreshSchemasStatusCommandInput} for command's `input` shape. + * @see {@link DescribeRefreshSchemasStatusCommandOutput} for command's `response` shape. + * @see {@link DatabaseMigrationServiceClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeRefreshSchemasStatusCommand extends $Command< DescribeRefreshSchemasStatusCommandInput, diff --git a/clients/client-database-migration-service/commands/DescribeReplicationInstanceTaskLogsCommand.ts b/clients/client-database-migration-service/commands/DescribeReplicationInstanceTaskLogsCommand.ts index 55edc59eef6f..f244697286fd 100644 --- a/clients/client-database-migration-service/commands/DescribeReplicationInstanceTaskLogsCommand.ts +++ b/clients/client-database-migration-service/commands/DescribeReplicationInstanceTaskLogsCommand.ts @@ -31,6 +31,20 @@ export interface DescribeReplicationInstanceTaskLogsCommandOutput /** *

Returns information about the task logs for the specified task.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { DatabaseMigrationServiceClient, DescribeReplicationInstanceTaskLogsCommand } from "@aws-sdk/client-database-migration-service"; // ES Modules import + * // const { DatabaseMigrationServiceClient, DescribeReplicationInstanceTaskLogsCommand } = require("@aws-sdk/client-database-migration-service"); // CommonJS import + * const client = new DatabaseMigrationServiceClient(config); + * const command = new DescribeReplicationInstanceTaskLogsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeReplicationInstanceTaskLogsCommandInput} for command's `input` shape. + * @see {@link DescribeReplicationInstanceTaskLogsCommandOutput} for command's `response` shape. + * @see {@link DatabaseMigrationServiceClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeReplicationInstanceTaskLogsCommand extends $Command< DescribeReplicationInstanceTaskLogsCommandInput, diff --git a/clients/client-database-migration-service/commands/DescribeReplicationInstancesCommand.ts b/clients/client-database-migration-service/commands/DescribeReplicationInstancesCommand.ts index 9ee7090544d9..15433aefc26d 100644 --- a/clients/client-database-migration-service/commands/DescribeReplicationInstancesCommand.ts +++ b/clients/client-database-migration-service/commands/DescribeReplicationInstancesCommand.ts @@ -29,6 +29,20 @@ export interface DescribeReplicationInstancesCommandOutput /** *

Returns information about replication instances for your account in the current * region.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { DatabaseMigrationServiceClient, DescribeReplicationInstancesCommand } from "@aws-sdk/client-database-migration-service"; // ES Modules import + * // const { DatabaseMigrationServiceClient, DescribeReplicationInstancesCommand } = require("@aws-sdk/client-database-migration-service"); // CommonJS import + * const client = new DatabaseMigrationServiceClient(config); + * const command = new DescribeReplicationInstancesCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeReplicationInstancesCommandInput} for command's `input` shape. + * @see {@link DescribeReplicationInstancesCommandOutput} for command's `response` shape. + * @see {@link DatabaseMigrationServiceClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeReplicationInstancesCommand extends $Command< DescribeReplicationInstancesCommandInput, diff --git a/clients/client-database-migration-service/commands/DescribeReplicationSubnetGroupsCommand.ts b/clients/client-database-migration-service/commands/DescribeReplicationSubnetGroupsCommand.ts index ad773da366d5..f66627c15e15 100644 --- a/clients/client-database-migration-service/commands/DescribeReplicationSubnetGroupsCommand.ts +++ b/clients/client-database-migration-service/commands/DescribeReplicationSubnetGroupsCommand.ts @@ -28,6 +28,20 @@ export interface DescribeReplicationSubnetGroupsCommandOutput /** *

Returns information about the replication subnet groups.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { DatabaseMigrationServiceClient, DescribeReplicationSubnetGroupsCommand } from "@aws-sdk/client-database-migration-service"; // ES Modules import + * // const { DatabaseMigrationServiceClient, DescribeReplicationSubnetGroupsCommand } = require("@aws-sdk/client-database-migration-service"); // CommonJS import + * const client = new DatabaseMigrationServiceClient(config); + * const command = new DescribeReplicationSubnetGroupsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeReplicationSubnetGroupsCommandInput} for command's `input` shape. + * @see {@link DescribeReplicationSubnetGroupsCommandOutput} for command's `response` shape. + * @see {@link DatabaseMigrationServiceClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeReplicationSubnetGroupsCommand extends $Command< DescribeReplicationSubnetGroupsCommandInput, diff --git a/clients/client-database-migration-service/commands/DescribeReplicationTaskAssessmentResultsCommand.ts b/clients/client-database-migration-service/commands/DescribeReplicationTaskAssessmentResultsCommand.ts index 76bf80c17f3a..f85cf48f3162 100644 --- a/clients/client-database-migration-service/commands/DescribeReplicationTaskAssessmentResultsCommand.ts +++ b/clients/client-database-migration-service/commands/DescribeReplicationTaskAssessmentResultsCommand.ts @@ -33,6 +33,20 @@ export interface DescribeReplicationTaskAssessmentResultsCommandOutput /** *

Returns the task assessment results from Amazon S3. This action always returns the * latest results.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { DatabaseMigrationServiceClient, DescribeReplicationTaskAssessmentResultsCommand } from "@aws-sdk/client-database-migration-service"; // ES Modules import + * // const { DatabaseMigrationServiceClient, DescribeReplicationTaskAssessmentResultsCommand } = require("@aws-sdk/client-database-migration-service"); // CommonJS import + * const client = new DatabaseMigrationServiceClient(config); + * const command = new DescribeReplicationTaskAssessmentResultsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeReplicationTaskAssessmentResultsCommandInput} for command's `input` shape. + * @see {@link DescribeReplicationTaskAssessmentResultsCommandOutput} for command's `response` shape. + * @see {@link DatabaseMigrationServiceClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeReplicationTaskAssessmentResultsCommand extends $Command< DescribeReplicationTaskAssessmentResultsCommandInput, diff --git a/clients/client-database-migration-service/commands/DescribeReplicationTaskAssessmentRunsCommand.ts b/clients/client-database-migration-service/commands/DescribeReplicationTaskAssessmentRunsCommand.ts index 746f6fedd6dd..07f9863bf1af 100644 --- a/clients/client-database-migration-service/commands/DescribeReplicationTaskAssessmentRunsCommand.ts +++ b/clients/client-database-migration-service/commands/DescribeReplicationTaskAssessmentRunsCommand.ts @@ -40,6 +40,20 @@ export interface DescribeReplicationTaskAssessmentRunsCommandOutput * information, see the DescribeReplicationTaskIndividualAssessments * operation.

* + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { DatabaseMigrationServiceClient, DescribeReplicationTaskAssessmentRunsCommand } from "@aws-sdk/client-database-migration-service"; // ES Modules import + * // const { DatabaseMigrationServiceClient, DescribeReplicationTaskAssessmentRunsCommand } = require("@aws-sdk/client-database-migration-service"); // CommonJS import + * const client = new DatabaseMigrationServiceClient(config); + * const command = new DescribeReplicationTaskAssessmentRunsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeReplicationTaskAssessmentRunsCommandInput} for command's `input` shape. + * @see {@link DescribeReplicationTaskAssessmentRunsCommandOutput} for command's `response` shape. + * @see {@link DatabaseMigrationServiceClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeReplicationTaskAssessmentRunsCommand extends $Command< DescribeReplicationTaskAssessmentRunsCommandInput, diff --git a/clients/client-database-migration-service/commands/DescribeReplicationTaskIndividualAssessmentsCommand.ts b/clients/client-database-migration-service/commands/DescribeReplicationTaskIndividualAssessmentsCommand.ts index da04ca862f2c..7224ddc7a079 100644 --- a/clients/client-database-migration-service/commands/DescribeReplicationTaskIndividualAssessmentsCommand.ts +++ b/clients/client-database-migration-service/commands/DescribeReplicationTaskIndividualAssessmentsCommand.ts @@ -34,6 +34,20 @@ export interface DescribeReplicationTaskIndividualAssessmentsCommandOutput *

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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { DatabaseMigrationServiceClient, DescribeReplicationTaskIndividualAssessmentsCommand } from "@aws-sdk/client-database-migration-service"; // ES Modules import + * // const { DatabaseMigrationServiceClient, DescribeReplicationTaskIndividualAssessmentsCommand } = require("@aws-sdk/client-database-migration-service"); // CommonJS import + * const client = new DatabaseMigrationServiceClient(config); + * const command = new DescribeReplicationTaskIndividualAssessmentsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeReplicationTaskIndividualAssessmentsCommandInput} for command's `input` shape. + * @see {@link DescribeReplicationTaskIndividualAssessmentsCommandOutput} for command's `response` shape. + * @see {@link DatabaseMigrationServiceClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeReplicationTaskIndividualAssessmentsCommand extends $Command< DescribeReplicationTaskIndividualAssessmentsCommandInput, diff --git a/clients/client-database-migration-service/commands/DescribeReplicationTasksCommand.ts b/clients/client-database-migration-service/commands/DescribeReplicationTasksCommand.ts index b63afcfc4918..ff54f735e0fc 100644 --- a/clients/client-database-migration-service/commands/DescribeReplicationTasksCommand.ts +++ b/clients/client-database-migration-service/commands/DescribeReplicationTasksCommand.ts @@ -27,6 +27,20 @@ export interface DescribeReplicationTasksCommandOutput extends DescribeReplicati /** *

Returns information about replication tasks for your account in the current * region.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { DatabaseMigrationServiceClient, DescribeReplicationTasksCommand } from "@aws-sdk/client-database-migration-service"; // ES Modules import + * // const { DatabaseMigrationServiceClient, DescribeReplicationTasksCommand } = require("@aws-sdk/client-database-migration-service"); // CommonJS import + * const client = new DatabaseMigrationServiceClient(config); + * const command = new DescribeReplicationTasksCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeReplicationTasksCommandInput} for command's `input` shape. + * @see {@link DescribeReplicationTasksCommandOutput} for command's `response` shape. + * @see {@link DatabaseMigrationServiceClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeReplicationTasksCommand extends $Command< DescribeReplicationTasksCommandInput, diff --git a/clients/client-database-migration-service/commands/DescribeSchemasCommand.ts b/clients/client-database-migration-service/commands/DescribeSchemasCommand.ts index b61037dce747..e39323c53cae 100644 --- a/clients/client-database-migration-service/commands/DescribeSchemasCommand.ts +++ b/clients/client-database-migration-service/commands/DescribeSchemasCommand.ts @@ -28,6 +28,20 @@ export interface DescribeSchemasCommandOutput extends DescribeSchemasResponse, _ *

Returns information about the schema for the specified endpoint.

* *

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { DatabaseMigrationServiceClient, DescribeSchemasCommand } from "@aws-sdk/client-database-migration-service"; // ES Modules import + * // const { DatabaseMigrationServiceClient, DescribeSchemasCommand } = require("@aws-sdk/client-database-migration-service"); // CommonJS import + * const client = new DatabaseMigrationServiceClient(config); + * const command = new DescribeSchemasCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeSchemasCommandInput} for command's `input` shape. + * @see {@link DescribeSchemasCommandOutput} for command's `response` shape. + * @see {@link DatabaseMigrationServiceClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeSchemasCommand extends $Command< DescribeSchemasCommandInput, diff --git a/clients/client-database-migration-service/commands/DescribeTableStatisticsCommand.ts b/clients/client-database-migration-service/commands/DescribeTableStatisticsCommand.ts index 6f9afa13527f..aee5452f4340 100644 --- a/clients/client-database-migration-service/commands/DescribeTableStatisticsCommand.ts +++ b/clients/client-database-migration-service/commands/DescribeTableStatisticsCommand.ts @@ -30,6 +30,20 @@ export interface DescribeTableStatisticsCommandOutput extends DescribeTableStati *

Note that the "last updated" column the DMS console only indicates the time that AWS DMS * last updated the table statistics record for a table. It does not indicate the time of the * last update to the table.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { DatabaseMigrationServiceClient, DescribeTableStatisticsCommand } from "@aws-sdk/client-database-migration-service"; // ES Modules import + * // const { DatabaseMigrationServiceClient, DescribeTableStatisticsCommand } = require("@aws-sdk/client-database-migration-service"); // CommonJS import + * const client = new DatabaseMigrationServiceClient(config); + * const command = new DescribeTableStatisticsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeTableStatisticsCommandInput} for command's `input` shape. + * @see {@link DescribeTableStatisticsCommandOutput} for command's `response` shape. + * @see {@link DatabaseMigrationServiceClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeTableStatisticsCommand extends $Command< DescribeTableStatisticsCommandInput, diff --git a/clients/client-database-migration-service/commands/ImportCertificateCommand.ts b/clients/client-database-migration-service/commands/ImportCertificateCommand.ts index d14e03c61fe0..9d8081cc09d3 100644 --- a/clients/client-database-migration-service/commands/ImportCertificateCommand.ts +++ b/clients/client-database-migration-service/commands/ImportCertificateCommand.ts @@ -26,6 +26,20 @@ export interface ImportCertificateCommandOutput extends ImportCertificateRespons /** *

Uploads the specified certificate.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { DatabaseMigrationServiceClient, ImportCertificateCommand } from "@aws-sdk/client-database-migration-service"; // ES Modules import + * // const { DatabaseMigrationServiceClient, ImportCertificateCommand } = require("@aws-sdk/client-database-migration-service"); // CommonJS import + * const client = new DatabaseMigrationServiceClient(config); + * const command = new ImportCertificateCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ImportCertificateCommandInput} for command's `input` shape. + * @see {@link ImportCertificateCommandOutput} for command's `response` shape. + * @see {@link DatabaseMigrationServiceClientResolvedConfig | config} for command's `input` shape. + * */ export class ImportCertificateCommand extends $Command< ImportCertificateCommandInput, diff --git a/clients/client-database-migration-service/commands/ListTagsForResourceCommand.ts b/clients/client-database-migration-service/commands/ListTagsForResourceCommand.ts index efd9df6a5aa0..de0bdb7672c9 100644 --- a/clients/client-database-migration-service/commands/ListTagsForResourceCommand.ts +++ b/clients/client-database-migration-service/commands/ListTagsForResourceCommand.ts @@ -30,6 +30,20 @@ export interface ListTagsForResourceCommandOutput extends ListTagsForResourceRes * For more information, see * Tag * data type description.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { DatabaseMigrationServiceClient, ListTagsForResourceCommand } from "@aws-sdk/client-database-migration-service"; // ES Modules import + * // const { DatabaseMigrationServiceClient, ListTagsForResourceCommand } = require("@aws-sdk/client-database-migration-service"); // CommonJS import + * const client = new DatabaseMigrationServiceClient(config); + * const command = new ListTagsForResourceCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListTagsForResourceCommandInput} for command's `input` shape. + * @see {@link ListTagsForResourceCommandOutput} for command's `response` shape. + * @see {@link DatabaseMigrationServiceClientResolvedConfig | config} for command's `input` shape. + * */ export class ListTagsForResourceCommand extends $Command< ListTagsForResourceCommandInput, diff --git a/clients/client-database-migration-service/commands/ModifyEndpointCommand.ts b/clients/client-database-migration-service/commands/ModifyEndpointCommand.ts index bba49bec2462..797eda779630 100644 --- a/clients/client-database-migration-service/commands/ModifyEndpointCommand.ts +++ b/clients/client-database-migration-service/commands/ModifyEndpointCommand.ts @@ -26,6 +26,20 @@ export interface ModifyEndpointCommandOutput extends ModifyEndpointResponse, __M /** *

Modifies the specified endpoint.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { DatabaseMigrationServiceClient, ModifyEndpointCommand } from "@aws-sdk/client-database-migration-service"; // ES Modules import + * // const { DatabaseMigrationServiceClient, ModifyEndpointCommand } = require("@aws-sdk/client-database-migration-service"); // CommonJS import + * const client = new DatabaseMigrationServiceClient(config); + * const command = new ModifyEndpointCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ModifyEndpointCommandInput} for command's `input` shape. + * @see {@link ModifyEndpointCommandOutput} for command's `response` shape. + * @see {@link DatabaseMigrationServiceClientResolvedConfig | config} for command's `input` shape. + * */ export class ModifyEndpointCommand extends $Command< ModifyEndpointCommandInput, diff --git a/clients/client-database-migration-service/commands/ModifyEventSubscriptionCommand.ts b/clients/client-database-migration-service/commands/ModifyEventSubscriptionCommand.ts index fc58a75b575d..6df99f748f37 100644 --- a/clients/client-database-migration-service/commands/ModifyEventSubscriptionCommand.ts +++ b/clients/client-database-migration-service/commands/ModifyEventSubscriptionCommand.ts @@ -26,6 +26,20 @@ export interface ModifyEventSubscriptionCommandOutput extends ModifyEventSubscri /** *

Modifies an existing AWS DMS event notification subscription.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { DatabaseMigrationServiceClient, ModifyEventSubscriptionCommand } from "@aws-sdk/client-database-migration-service"; // ES Modules import + * // const { DatabaseMigrationServiceClient, ModifyEventSubscriptionCommand } = require("@aws-sdk/client-database-migration-service"); // CommonJS import + * const client = new DatabaseMigrationServiceClient(config); + * const command = new ModifyEventSubscriptionCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ModifyEventSubscriptionCommandInput} for command's `input` shape. + * @see {@link ModifyEventSubscriptionCommandOutput} for command's `response` shape. + * @see {@link DatabaseMigrationServiceClientResolvedConfig | config} for command's `input` shape. + * */ export class ModifyEventSubscriptionCommand extends $Command< ModifyEventSubscriptionCommandInput, diff --git a/clients/client-database-migration-service/commands/ModifyReplicationInstanceCommand.ts b/clients/client-database-migration-service/commands/ModifyReplicationInstanceCommand.ts index 2c54c0795967..688393df11d3 100644 --- a/clients/client-database-migration-service/commands/ModifyReplicationInstanceCommand.ts +++ b/clients/client-database-migration-service/commands/ModifyReplicationInstanceCommand.ts @@ -30,6 +30,20 @@ export interface ModifyReplicationInstanceCommandOutput extends ModifyReplicatio *

Some settings are applied during the maintenance window.

* *

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { DatabaseMigrationServiceClient, ModifyReplicationInstanceCommand } from "@aws-sdk/client-database-migration-service"; // ES Modules import + * // const { DatabaseMigrationServiceClient, ModifyReplicationInstanceCommand } = require("@aws-sdk/client-database-migration-service"); // CommonJS import + * const client = new DatabaseMigrationServiceClient(config); + * const command = new ModifyReplicationInstanceCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ModifyReplicationInstanceCommandInput} for command's `input` shape. + * @see {@link ModifyReplicationInstanceCommandOutput} for command's `response` shape. + * @see {@link DatabaseMigrationServiceClientResolvedConfig | config} for command's `input` shape. + * */ export class ModifyReplicationInstanceCommand extends $Command< ModifyReplicationInstanceCommandInput, diff --git a/clients/client-database-migration-service/commands/ModifyReplicationSubnetGroupCommand.ts b/clients/client-database-migration-service/commands/ModifyReplicationSubnetGroupCommand.ts index bd9c3cb3ddc0..d82bdd28045c 100644 --- a/clients/client-database-migration-service/commands/ModifyReplicationSubnetGroupCommand.ts +++ b/clients/client-database-migration-service/commands/ModifyReplicationSubnetGroupCommand.ts @@ -28,6 +28,20 @@ export interface ModifyReplicationSubnetGroupCommandOutput /** *

Modifies the settings for the specified replication subnet group.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { DatabaseMigrationServiceClient, ModifyReplicationSubnetGroupCommand } from "@aws-sdk/client-database-migration-service"; // ES Modules import + * // const { DatabaseMigrationServiceClient, ModifyReplicationSubnetGroupCommand } = require("@aws-sdk/client-database-migration-service"); // CommonJS import + * const client = new DatabaseMigrationServiceClient(config); + * const command = new ModifyReplicationSubnetGroupCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ModifyReplicationSubnetGroupCommandInput} for command's `input` shape. + * @see {@link ModifyReplicationSubnetGroupCommandOutput} for command's `response` shape. + * @see {@link DatabaseMigrationServiceClientResolvedConfig | config} for command's `input` shape. + * */ export class ModifyReplicationSubnetGroupCommand extends $Command< ModifyReplicationSubnetGroupCommandInput, diff --git a/clients/client-database-migration-service/commands/ModifyReplicationTaskCommand.ts b/clients/client-database-migration-service/commands/ModifyReplicationTaskCommand.ts index fc51a16d6d67..55b0e4399696 100644 --- a/clients/client-database-migration-service/commands/ModifyReplicationTaskCommand.ts +++ b/clients/client-database-migration-service/commands/ModifyReplicationTaskCommand.ts @@ -29,6 +29,20 @@ export interface ModifyReplicationTaskCommandOutput extends ModifyReplicationTas *

You can't modify the task endpoints. The task must be stopped before you can modify it.

*

For more information about AWS DMS tasks, see Working with Migration Tasks in the * AWS Database Migration Service User Guide.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { DatabaseMigrationServiceClient, ModifyReplicationTaskCommand } from "@aws-sdk/client-database-migration-service"; // ES Modules import + * // const { DatabaseMigrationServiceClient, ModifyReplicationTaskCommand } = require("@aws-sdk/client-database-migration-service"); // CommonJS import + * const client = new DatabaseMigrationServiceClient(config); + * const command = new ModifyReplicationTaskCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ModifyReplicationTaskCommandInput} for command's `input` shape. + * @see {@link ModifyReplicationTaskCommandOutput} for command's `response` shape. + * @see {@link DatabaseMigrationServiceClientResolvedConfig | config} for command's `input` shape. + * */ export class ModifyReplicationTaskCommand extends $Command< ModifyReplicationTaskCommandInput, diff --git a/clients/client-database-migration-service/commands/MoveReplicationTaskCommand.ts b/clients/client-database-migration-service/commands/MoveReplicationTaskCommand.ts index 240b6226a50c..bdce75078145 100644 --- a/clients/client-database-migration-service/commands/MoveReplicationTaskCommand.ts +++ b/clients/client-database-migration-service/commands/MoveReplicationTaskCommand.ts @@ -29,6 +29,20 @@ export interface MoveReplicationTaskCommandOutput extends MoveReplicationTaskRes * replication instance using the specified parameters. The target replication instance must * be created with the same or later AWS DMS version as the current replication * instance.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { DatabaseMigrationServiceClient, MoveReplicationTaskCommand } from "@aws-sdk/client-database-migration-service"; // ES Modules import + * // const { DatabaseMigrationServiceClient, MoveReplicationTaskCommand } = require("@aws-sdk/client-database-migration-service"); // CommonJS import + * const client = new DatabaseMigrationServiceClient(config); + * const command = new MoveReplicationTaskCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link MoveReplicationTaskCommandInput} for command's `input` shape. + * @see {@link MoveReplicationTaskCommandOutput} for command's `response` shape. + * @see {@link DatabaseMigrationServiceClientResolvedConfig | config} for command's `input` shape. + * */ export class MoveReplicationTaskCommand extends $Command< MoveReplicationTaskCommandInput, diff --git a/clients/client-database-migration-service/commands/RebootReplicationInstanceCommand.ts b/clients/client-database-migration-service/commands/RebootReplicationInstanceCommand.ts index b07900e08578..df67f175073d 100644 --- a/clients/client-database-migration-service/commands/RebootReplicationInstanceCommand.ts +++ b/clients/client-database-migration-service/commands/RebootReplicationInstanceCommand.ts @@ -27,6 +27,20 @@ export interface RebootReplicationInstanceCommandOutput extends RebootReplicatio /** *

Reboots a replication instance. Rebooting results in a momentary outage, until the * replication instance becomes available again.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { DatabaseMigrationServiceClient, RebootReplicationInstanceCommand } from "@aws-sdk/client-database-migration-service"; // ES Modules import + * // const { DatabaseMigrationServiceClient, RebootReplicationInstanceCommand } = require("@aws-sdk/client-database-migration-service"); // CommonJS import + * const client = new DatabaseMigrationServiceClient(config); + * const command = new RebootReplicationInstanceCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link RebootReplicationInstanceCommandInput} for command's `input` shape. + * @see {@link RebootReplicationInstanceCommandOutput} for command's `response` shape. + * @see {@link DatabaseMigrationServiceClientResolvedConfig | config} for command's `input` shape. + * */ export class RebootReplicationInstanceCommand extends $Command< RebootReplicationInstanceCommandInput, diff --git a/clients/client-database-migration-service/commands/RefreshSchemasCommand.ts b/clients/client-database-migration-service/commands/RefreshSchemasCommand.ts index f7794875350e..b119ee8087bd 100644 --- a/clients/client-database-migration-service/commands/RefreshSchemasCommand.ts +++ b/clients/client-database-migration-service/commands/RefreshSchemasCommand.ts @@ -28,6 +28,20 @@ export interface RefreshSchemasCommandOutput extends RefreshSchemasResponse, __M *

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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { DatabaseMigrationServiceClient, RefreshSchemasCommand } from "@aws-sdk/client-database-migration-service"; // ES Modules import + * // const { DatabaseMigrationServiceClient, RefreshSchemasCommand } = require("@aws-sdk/client-database-migration-service"); // CommonJS import + * const client = new DatabaseMigrationServiceClient(config); + * const command = new RefreshSchemasCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link RefreshSchemasCommandInput} for command's `input` shape. + * @see {@link RefreshSchemasCommandOutput} for command's `response` shape. + * @see {@link DatabaseMigrationServiceClientResolvedConfig | config} for command's `input` shape. + * */ export class RefreshSchemasCommand extends $Command< RefreshSchemasCommandInput, diff --git a/clients/client-database-migration-service/commands/ReloadTablesCommand.ts b/clients/client-database-migration-service/commands/ReloadTablesCommand.ts index 162719d4ccb2..dd4b123c2850 100644 --- a/clients/client-database-migration-service/commands/ReloadTablesCommand.ts +++ b/clients/client-database-migration-service/commands/ReloadTablesCommand.ts @@ -26,6 +26,20 @@ export interface ReloadTablesCommandOutput extends ReloadTablesResponse, __Metad /** *

Reloads the target database table with the source data.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { DatabaseMigrationServiceClient, ReloadTablesCommand } from "@aws-sdk/client-database-migration-service"; // ES Modules import + * // const { DatabaseMigrationServiceClient, ReloadTablesCommand } = require("@aws-sdk/client-database-migration-service"); // CommonJS import + * const client = new DatabaseMigrationServiceClient(config); + * const command = new ReloadTablesCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ReloadTablesCommandInput} for command's `input` shape. + * @see {@link ReloadTablesCommandOutput} for command's `response` shape. + * @see {@link DatabaseMigrationServiceClientResolvedConfig | config} for command's `input` shape. + * */ export class ReloadTablesCommand extends $Command< ReloadTablesCommandInput, diff --git a/clients/client-database-migration-service/commands/RemoveTagsFromResourceCommand.ts b/clients/client-database-migration-service/commands/RemoveTagsFromResourceCommand.ts index d0f43ef3a43f..b493d3bb0790 100644 --- a/clients/client-database-migration-service/commands/RemoveTagsFromResourceCommand.ts +++ b/clients/client-database-migration-service/commands/RemoveTagsFromResourceCommand.ts @@ -31,6 +31,20 @@ export interface RemoveTagsFromResourceCommandOutput extends RemoveTagsFromResou * Tag * * data type description.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { DatabaseMigrationServiceClient, RemoveTagsFromResourceCommand } from "@aws-sdk/client-database-migration-service"; // ES Modules import + * // const { DatabaseMigrationServiceClient, RemoveTagsFromResourceCommand } = require("@aws-sdk/client-database-migration-service"); // CommonJS import + * const client = new DatabaseMigrationServiceClient(config); + * const command = new RemoveTagsFromResourceCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link RemoveTagsFromResourceCommandInput} for command's `input` shape. + * @see {@link RemoveTagsFromResourceCommandOutput} for command's `response` shape. + * @see {@link DatabaseMigrationServiceClientResolvedConfig | config} for command's `input` shape. + * */ export class RemoveTagsFromResourceCommand extends $Command< RemoveTagsFromResourceCommandInput, diff --git a/clients/client-database-migration-service/commands/StartReplicationTaskAssessmentCommand.ts b/clients/client-database-migration-service/commands/StartReplicationTaskAssessmentCommand.ts index 6c72109f720c..b840f2c65712 100644 --- a/clients/client-database-migration-service/commands/StartReplicationTaskAssessmentCommand.ts +++ b/clients/client-database-migration-service/commands/StartReplicationTaskAssessmentCommand.ts @@ -29,6 +29,20 @@ export interface StartReplicationTaskAssessmentCommandOutput /** *

Starts the replication task assessment for unsupported data types in the source * database.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { DatabaseMigrationServiceClient, StartReplicationTaskAssessmentCommand } from "@aws-sdk/client-database-migration-service"; // ES Modules import + * // const { DatabaseMigrationServiceClient, StartReplicationTaskAssessmentCommand } = require("@aws-sdk/client-database-migration-service"); // CommonJS import + * const client = new DatabaseMigrationServiceClient(config); + * const command = new StartReplicationTaskAssessmentCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link StartReplicationTaskAssessmentCommandInput} for command's `input` shape. + * @see {@link StartReplicationTaskAssessmentCommandOutput} for command's `response` shape. + * @see {@link DatabaseMigrationServiceClientResolvedConfig | config} for command's `input` shape. + * */ export class StartReplicationTaskAssessmentCommand extends $Command< StartReplicationTaskAssessmentCommandInput, diff --git a/clients/client-database-migration-service/commands/StartReplicationTaskAssessmentRunCommand.ts b/clients/client-database-migration-service/commands/StartReplicationTaskAssessmentRunCommand.ts index 6b905183cfc9..0a196e399bea 100644 --- a/clients/client-database-migration-service/commands/StartReplicationTaskAssessmentRunCommand.ts +++ b/clients/client-database-migration-service/commands/StartReplicationTaskAssessmentRunCommand.ts @@ -37,6 +37,20 @@ export interface StartReplicationTaskAssessmentRunCommandOutput * 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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { DatabaseMigrationServiceClient, StartReplicationTaskAssessmentRunCommand } from "@aws-sdk/client-database-migration-service"; // ES Modules import + * // const { DatabaseMigrationServiceClient, StartReplicationTaskAssessmentRunCommand } = require("@aws-sdk/client-database-migration-service"); // CommonJS import + * const client = new DatabaseMigrationServiceClient(config); + * const command = new StartReplicationTaskAssessmentRunCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link StartReplicationTaskAssessmentRunCommandInput} for command's `input` shape. + * @see {@link StartReplicationTaskAssessmentRunCommandOutput} for command's `response` shape. + * @see {@link DatabaseMigrationServiceClientResolvedConfig | config} for command's `input` shape. + * */ export class StartReplicationTaskAssessmentRunCommand extends $Command< StartReplicationTaskAssessmentRunCommandInput, diff --git a/clients/client-database-migration-service/commands/StartReplicationTaskCommand.ts b/clients/client-database-migration-service/commands/StartReplicationTaskCommand.ts index 1fcc16441366..d1cf43d68878 100644 --- a/clients/client-database-migration-service/commands/StartReplicationTaskCommand.ts +++ b/clients/client-database-migration-service/commands/StartReplicationTaskCommand.ts @@ -29,6 +29,20 @@ export interface StartReplicationTaskCommandOutput extends StartReplicationTaskR *

For more information about AWS DMS tasks, see Working with Migration Tasks in the * AWS Database Migration Service User Guide. *

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { DatabaseMigrationServiceClient, StartReplicationTaskCommand } from "@aws-sdk/client-database-migration-service"; // ES Modules import + * // const { DatabaseMigrationServiceClient, StartReplicationTaskCommand } = require("@aws-sdk/client-database-migration-service"); // CommonJS import + * const client = new DatabaseMigrationServiceClient(config); + * const command = new StartReplicationTaskCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link StartReplicationTaskCommandInput} for command's `input` shape. + * @see {@link StartReplicationTaskCommandOutput} for command's `response` shape. + * @see {@link DatabaseMigrationServiceClientResolvedConfig | config} for command's `input` shape. + * */ export class StartReplicationTaskCommand extends $Command< StartReplicationTaskCommandInput, diff --git a/clients/client-database-migration-service/commands/StopReplicationTaskCommand.ts b/clients/client-database-migration-service/commands/StopReplicationTaskCommand.ts index 014db4ddcdb5..61f78e663379 100644 --- a/clients/client-database-migration-service/commands/StopReplicationTaskCommand.ts +++ b/clients/client-database-migration-service/commands/StopReplicationTaskCommand.ts @@ -26,6 +26,20 @@ export interface StopReplicationTaskCommandOutput extends StopReplicationTaskRes /** *

Stops the replication task.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { DatabaseMigrationServiceClient, StopReplicationTaskCommand } from "@aws-sdk/client-database-migration-service"; // ES Modules import + * // const { DatabaseMigrationServiceClient, StopReplicationTaskCommand } = require("@aws-sdk/client-database-migration-service"); // CommonJS import + * const client = new DatabaseMigrationServiceClient(config); + * const command = new StopReplicationTaskCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link StopReplicationTaskCommandInput} for command's `input` shape. + * @see {@link StopReplicationTaskCommandOutput} for command's `response` shape. + * @see {@link DatabaseMigrationServiceClientResolvedConfig | config} for command's `input` shape. + * */ export class StopReplicationTaskCommand extends $Command< StopReplicationTaskCommandInput, diff --git a/clients/client-database-migration-service/commands/TestConnectionCommand.ts b/clients/client-database-migration-service/commands/TestConnectionCommand.ts index 93ab1293743f..150f447cff5e 100644 --- a/clients/client-database-migration-service/commands/TestConnectionCommand.ts +++ b/clients/client-database-migration-service/commands/TestConnectionCommand.ts @@ -26,6 +26,20 @@ export interface TestConnectionCommandOutput extends TestConnectionResponse, __M /** *

Tests the connection between the replication instance and the endpoint.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { DatabaseMigrationServiceClient, TestConnectionCommand } from "@aws-sdk/client-database-migration-service"; // ES Modules import + * // const { DatabaseMigrationServiceClient, TestConnectionCommand } = require("@aws-sdk/client-database-migration-service"); // CommonJS import + * const client = new DatabaseMigrationServiceClient(config); + * const command = new TestConnectionCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link TestConnectionCommandInput} for command's `input` shape. + * @see {@link TestConnectionCommandOutput} for command's `response` shape. + * @see {@link DatabaseMigrationServiceClientResolvedConfig | config} for command's `input` shape. + * */ export class TestConnectionCommand extends $Command< TestConnectionCommandInput, diff --git a/clients/client-database-migration-service/models/models_0.ts b/clients/client-database-migration-service/models/models_0.ts index 7790bc801b89..6e5b305834b5 100644 --- a/clients/client-database-migration-service/models/models_0.ts +++ b/clients/client-database-migration-service/models/models_0.ts @@ -15,6 +15,9 @@ export interface AccessDeniedFault extends __SmithyException, $MetadataBearer { } export namespace AccessDeniedFault { + /** + * @internal + */ export const filterSensitiveLog = (obj: AccessDeniedFault): any => ({ ...obj, }); @@ -42,6 +45,9 @@ export interface AccountQuota { } export namespace AccountQuota { + /** + * @internal + */ export const filterSensitiveLog = (obj: AccountQuota): any => ({ ...obj, }); @@ -87,6 +93,9 @@ export interface Tag { } export namespace Tag { + /** + * @internal + */ export const filterSensitiveLog = (obj: Tag): any => ({ ...obj, }); @@ -109,6 +118,9 @@ export interface AddTagsToResourceMessage { } export namespace AddTagsToResourceMessage { + /** + * @internal + */ export const filterSensitiveLog = (obj: AddTagsToResourceMessage): any => ({ ...obj, }); @@ -120,6 +132,9 @@ export namespace AddTagsToResourceMessage { export interface AddTagsToResourceResponse {} export namespace AddTagsToResourceResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: AddTagsToResourceResponse): any => ({ ...obj, }); @@ -138,6 +153,9 @@ export interface ResourceNotFoundFault extends __SmithyException, $MetadataBeare } export namespace ResourceNotFoundFault { + /** + * @internal + */ export const filterSensitiveLog = (obj: ResourceNotFoundFault): any => ({ ...obj, }); @@ -183,6 +201,9 @@ export interface ApplyPendingMaintenanceActionMessage { } export namespace ApplyPendingMaintenanceActionMessage { + /** + * @internal + */ export const filterSensitiveLog = (obj: ApplyPendingMaintenanceActionMessage): any => ({ ...obj, }); @@ -237,6 +258,9 @@ export interface PendingMaintenanceAction { } export namespace PendingMaintenanceAction { + /** + * @internal + */ export const filterSensitiveLog = (obj: PendingMaintenanceAction): any => ({ ...obj, }); @@ -260,6 +284,9 @@ export interface ResourcePendingMaintenanceActions { } export namespace ResourcePendingMaintenanceActions { + /** + * @internal + */ export const filterSensitiveLog = (obj: ResourcePendingMaintenanceActions): any => ({ ...obj, }); @@ -276,6 +303,9 @@ export interface ApplyPendingMaintenanceActionResponse { } export namespace ApplyPendingMaintenanceActionResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ApplyPendingMaintenanceActionResponse): any => ({ ...obj, }); @@ -292,6 +322,9 @@ export interface CancelReplicationTaskAssessmentRunMessage { } export namespace CancelReplicationTaskAssessmentRunMessage { + /** + * @internal + */ export const filterSensitiveLog = (obj: CancelReplicationTaskAssessmentRunMessage): any => ({ ...obj, }); @@ -314,6 +347,9 @@ export interface ReplicationTaskAssessmentRunProgress { } export namespace ReplicationTaskAssessmentRunProgress { + /** + * @internal + */ export const filterSensitiveLog = (obj: ReplicationTaskAssessmentRunProgress): any => ({ ...obj, }); @@ -444,6 +480,9 @@ export interface ReplicationTaskAssessmentRun { } export namespace ReplicationTaskAssessmentRun { + /** + * @internal + */ export const filterSensitiveLog = (obj: ReplicationTaskAssessmentRun): any => ({ ...obj, }); @@ -461,6 +500,9 @@ export interface CancelReplicationTaskAssessmentRunResponse { } export namespace CancelReplicationTaskAssessmentRunResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: CancelReplicationTaskAssessmentRunResponse): any => ({ ...obj, }); @@ -479,6 +521,9 @@ export interface InvalidResourceStateFault extends __SmithyException, $MetadataB } export namespace InvalidResourceStateFault { + /** + * @internal + */ export const filterSensitiveLog = (obj: InvalidResourceStateFault): any => ({ ...obj, }); @@ -500,6 +545,9 @@ export interface DmsTransferSettings { } export namespace DmsTransferSettings { + /** + * @internal + */ export const filterSensitiveLog = (obj: DmsTransferSettings): any => ({ ...obj, }); @@ -598,6 +646,9 @@ export interface DocDbSettings { } export namespace DocDbSettings { + /** + * @internal + */ export const filterSensitiveLog = (obj: DocDbSettings): any => ({ ...obj, ...(obj.Password && { Password: SENSITIVE_STRING }), @@ -616,6 +667,9 @@ export interface DynamoDbSettings { } export namespace DynamoDbSettings { + /** + * @internal + */ export const filterSensitiveLog = (obj: DynamoDbSettings): any => ({ ...obj, }); @@ -654,6 +708,9 @@ export interface ElasticsearchSettings { } export namespace ElasticsearchSettings { + /** + * @internal + */ export const filterSensitiveLog = (obj: ElasticsearchSettings): any => ({ ...obj, }); @@ -738,6 +795,9 @@ export interface IBMDb2Settings { } export namespace IBMDb2Settings { + /** + * @internal + */ export const filterSensitiveLog = (obj: IBMDb2Settings): any => ({ ...obj, ...(obj.Password && { Password: SENSITIVE_STRING }), @@ -877,6 +937,9 @@ export interface KafkaSettings { } export namespace KafkaSettings { + /** + * @internal + */ export const filterSensitiveLog = (obj: KafkaSettings): any => ({ ...obj, ...(obj.SslClientKeyPassword && { SslClientKeyPassword: SENSITIVE_STRING }), @@ -951,6 +1014,9 @@ export interface KinesisSettings { } export namespace KinesisSettings { + /** + * @internal + */ export const filterSensitiveLog = (obj: KinesisSettings): any => ({ ...obj, }); @@ -1088,6 +1154,9 @@ export interface MicrosoftSQLServerSettings { } export namespace MicrosoftSQLServerSettings { + /** + * @internal + */ export const filterSensitiveLog = (obj: MicrosoftSQLServerSettings): any => ({ ...obj, ...(obj.Password && { Password: SENSITIVE_STRING }), @@ -1215,6 +1284,9 @@ export interface MongoDbSettings { } export namespace MongoDbSettings { + /** + * @internal + */ export const filterSensitiveLog = (obj: MongoDbSettings): any => ({ ...obj, ...(obj.Password && { Password: SENSITIVE_STRING }), @@ -1340,6 +1412,9 @@ export interface MySQLSettings { } export namespace MySQLSettings { + /** + * @internal + */ export const filterSensitiveLog = (obj: MySQLSettings): any => ({ ...obj, ...(obj.Password && { Password: SENSITIVE_STRING }), @@ -1403,6 +1478,9 @@ export interface NeptuneSettings { } export namespace NeptuneSettings { + /** + * @internal + */ export const filterSensitiveLog = (obj: NeptuneSettings): any => ({ ...obj, }); @@ -1732,6 +1810,9 @@ export interface OracleSettings { } export namespace OracleSettings { + /** + * @internal + */ export const filterSensitiveLog = (obj: OracleSettings): any => ({ ...obj, ...(obj.AsmPassword && { AsmPassword: SENSITIVE_STRING }), @@ -1856,6 +1937,9 @@ export interface PostgreSQLSettings { } export namespace PostgreSQLSettings { + /** + * @internal + */ export const filterSensitiveLog = (obj: PostgreSQLSettings): any => ({ ...obj, ...(obj.Password && { Password: SENSITIVE_STRING }), @@ -2112,6 +2196,9 @@ export interface RedshiftSettings { } export namespace RedshiftSettings { + /** + * @internal + */ export const filterSensitiveLog = (obj: RedshiftSettings): any => ({ ...obj, ...(obj.Password && { Password: SENSITIVE_STRING }), @@ -2599,6 +2686,9 @@ export interface S3Settings { } export namespace S3Settings { + /** + * @internal + */ export const filterSensitiveLog = (obj: S3Settings): any => ({ ...obj, }); @@ -2666,6 +2756,9 @@ export interface SybaseSettings { } export namespace SybaseSettings { + /** + * @internal + */ export const filterSensitiveLog = (obj: SybaseSettings): any => ({ ...obj, ...(obj.Password && { Password: SENSITIVE_STRING }), @@ -2944,6 +3037,9 @@ export interface CreateEndpointMessage { } export namespace CreateEndpointMessage { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateEndpointMessage): any => ({ ...obj, ...(obj.Password && { Password: SENSITIVE_STRING }), @@ -3211,6 +3307,9 @@ export interface Endpoint { } export namespace Endpoint { + /** + * @internal + */ export const filterSensitiveLog = (obj: Endpoint): any => ({ ...obj, ...(obj.MongoDbSettings && { MongoDbSettings: MongoDbSettings.filterSensitiveLog(obj.MongoDbSettings) }), @@ -3241,6 +3340,9 @@ export interface CreateEndpointResponse { } export namespace CreateEndpointResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateEndpointResponse): any => ({ ...obj, ...(obj.Endpoint && { Endpoint: Endpoint.filterSensitiveLog(obj.Endpoint) }), @@ -3260,6 +3362,9 @@ export interface KMSKeyNotAccessibleFault extends __SmithyException, $MetadataBe } export namespace KMSKeyNotAccessibleFault { + /** + * @internal + */ export const filterSensitiveLog = (obj: KMSKeyNotAccessibleFault): any => ({ ...obj, }); @@ -3280,6 +3385,9 @@ export interface ResourceAlreadyExistsFault extends __SmithyException, $Metadata } export namespace ResourceAlreadyExistsFault { + /** + * @internal + */ export const filterSensitiveLog = (obj: ResourceAlreadyExistsFault): any => ({ ...obj, }); @@ -3298,6 +3406,9 @@ export interface ResourceQuotaExceededFault extends __SmithyException, $Metadata } export namespace ResourceQuotaExceededFault { + /** + * @internal + */ export const filterSensitiveLog = (obj: ResourceQuotaExceededFault): any => ({ ...obj, }); @@ -3313,6 +3424,9 @@ export interface S3AccessDeniedFault extends __SmithyException, $MetadataBearer } export namespace S3AccessDeniedFault { + /** + * @internal + */ export const filterSensitiveLog = (obj: S3AccessDeniedFault): any => ({ ...obj, }); @@ -3374,6 +3488,9 @@ export interface CreateEventSubscriptionMessage { } export namespace CreateEventSubscriptionMessage { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateEventSubscriptionMessage): any => ({ ...obj, }); @@ -3440,6 +3557,9 @@ export interface EventSubscription { } export namespace EventSubscription { + /** + * @internal + */ export const filterSensitiveLog = (obj: EventSubscription): any => ({ ...obj, }); @@ -3456,6 +3576,9 @@ export interface CreateEventSubscriptionResponse { } export namespace CreateEventSubscriptionResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateEventSubscriptionResponse): any => ({ ...obj, }); @@ -3471,6 +3594,9 @@ export interface KMSAccessDeniedFault extends __SmithyException, $MetadataBearer } export namespace KMSAccessDeniedFault { + /** + * @internal + */ export const filterSensitiveLog = (obj: KMSAccessDeniedFault): any => ({ ...obj, }); @@ -3486,6 +3612,9 @@ export interface KMSDisabledFault extends __SmithyException, $MetadataBearer { } export namespace KMSDisabledFault { + /** + * @internal + */ export const filterSensitiveLog = (obj: KMSDisabledFault): any => ({ ...obj, }); @@ -3501,6 +3630,9 @@ export interface KMSInvalidStateFault extends __SmithyException, $MetadataBearer } export namespace KMSInvalidStateFault { + /** + * @internal + */ export const filterSensitiveLog = (obj: KMSInvalidStateFault): any => ({ ...obj, }); @@ -3516,6 +3648,9 @@ export interface KMSNotFoundFault extends __SmithyException, $MetadataBearer { } export namespace KMSNotFoundFault { + /** + * @internal + */ export const filterSensitiveLog = (obj: KMSNotFoundFault): any => ({ ...obj, }); @@ -3531,6 +3666,9 @@ export interface KMSThrottlingFault extends __SmithyException, $MetadataBearer { } export namespace KMSThrottlingFault { + /** + * @internal + */ export const filterSensitiveLog = (obj: KMSThrottlingFault): any => ({ ...obj, }); @@ -3549,6 +3687,9 @@ export interface SNSInvalidTopicFault extends __SmithyException, $MetadataBearer } export namespace SNSInvalidTopicFault { + /** + * @internal + */ export const filterSensitiveLog = (obj: SNSInvalidTopicFault): any => ({ ...obj, }); @@ -3567,6 +3708,9 @@ export interface SNSNoAuthorizationFault extends __SmithyException, $MetadataBea } export namespace SNSNoAuthorizationFault { + /** + * @internal + */ export const filterSensitiveLog = (obj: SNSNoAuthorizationFault): any => ({ ...obj, }); @@ -3714,6 +3858,9 @@ export interface CreateReplicationInstanceMessage { } export namespace CreateReplicationInstanceMessage { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateReplicationInstanceMessage): any => ({ ...obj, }); @@ -3758,6 +3905,9 @@ export interface ReplicationPendingModifiedValues { } export namespace ReplicationPendingModifiedValues { + /** + * @internal + */ export const filterSensitiveLog = (obj: ReplicationPendingModifiedValues): any => ({ ...obj, }); @@ -3779,6 +3929,9 @@ export interface AvailabilityZone { } export namespace AvailabilityZone { + /** + * @internal + */ export const filterSensitiveLog = (obj: AvailabilityZone): any => ({ ...obj, }); @@ -3807,6 +3960,9 @@ export interface Subnet { } export namespace Subnet { + /** + * @internal + */ export const filterSensitiveLog = (obj: Subnet): any => ({ ...obj, }); @@ -3844,6 +4000,9 @@ export interface ReplicationSubnetGroup { } export namespace ReplicationSubnetGroup { + /** + * @internal + */ export const filterSensitiveLog = (obj: ReplicationSubnetGroup): any => ({ ...obj, }); @@ -3866,6 +4025,9 @@ export interface VpcSecurityGroupMembership { } export namespace VpcSecurityGroupMembership { + /** + * @internal + */ export const filterSensitiveLog = (obj: VpcSecurityGroupMembership): any => ({ ...obj, }); @@ -4104,6 +4266,9 @@ export interface ReplicationInstance { } export namespace ReplicationInstance { + /** + * @internal + */ export const filterSensitiveLog = (obj: ReplicationInstance): any => ({ ...obj, }); @@ -4120,6 +4285,9 @@ export interface CreateReplicationInstanceResponse { } export namespace CreateReplicationInstanceResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateReplicationInstanceResponse): any => ({ ...obj, }); @@ -4138,6 +4306,9 @@ export interface InsufficientResourceCapacityFault extends __SmithyException, $M } export namespace InsufficientResourceCapacityFault { + /** + * @internal + */ export const filterSensitiveLog = (obj: InsufficientResourceCapacityFault): any => ({ ...obj, }); @@ -4156,6 +4327,9 @@ export interface InvalidSubnet extends __SmithyException, $MetadataBearer { } export namespace InvalidSubnet { + /** + * @internal + */ export const filterSensitiveLog = (obj: InvalidSubnet): any => ({ ...obj, }); @@ -4174,6 +4348,9 @@ export interface ReplicationSubnetGroupDoesNotCoverEnoughAZs extends __SmithyExc } export namespace ReplicationSubnetGroupDoesNotCoverEnoughAZs { + /** + * @internal + */ export const filterSensitiveLog = (obj: ReplicationSubnetGroupDoesNotCoverEnoughAZs): any => ({ ...obj, }); @@ -4192,6 +4369,9 @@ export interface StorageQuotaExceededFault extends __SmithyException, $MetadataB } export namespace StorageQuotaExceededFault { + /** + * @internal + */ export const filterSensitiveLog = (obj: StorageQuotaExceededFault): any => ({ ...obj, }); @@ -4228,6 +4408,9 @@ export interface CreateReplicationSubnetGroupMessage { } export namespace CreateReplicationSubnetGroupMessage { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateReplicationSubnetGroupMessage): any => ({ ...obj, }); @@ -4244,6 +4427,9 @@ export interface CreateReplicationSubnetGroupResponse { } export namespace CreateReplicationSubnetGroupResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateReplicationSubnetGroupResponse): any => ({ ...obj, }); @@ -4376,6 +4562,9 @@ export interface CreateReplicationTaskMessage { } export namespace CreateReplicationTaskMessage { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateReplicationTaskMessage): any => ({ ...obj, }); @@ -4444,6 +4633,9 @@ export interface ReplicationTaskStats { } export namespace ReplicationTaskStats { + /** + * @internal + */ export const filterSensitiveLog = (obj: ReplicationTaskStats): any => ({ ...obj, }); @@ -4716,6 +4908,9 @@ export interface ReplicationTask { } export namespace ReplicationTask { + /** + * @internal + */ export const filterSensitiveLog = (obj: ReplicationTask): any => ({ ...obj, }); @@ -4732,6 +4927,9 @@ export interface CreateReplicationTaskResponse { } export namespace CreateReplicationTaskResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateReplicationTaskResponse): any => ({ ...obj, }); @@ -4745,6 +4943,9 @@ export interface DeleteCertificateMessage { } export namespace DeleteCertificateMessage { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteCertificateMessage): any => ({ ...obj, }); @@ -4809,6 +5010,9 @@ export interface Certificate { } export namespace Certificate { + /** + * @internal + */ export const filterSensitiveLog = (obj: Certificate): any => ({ ...obj, }); @@ -4822,6 +5026,9 @@ export interface DeleteCertificateResponse { } export namespace DeleteCertificateResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteCertificateResponse): any => ({ ...obj, }); @@ -4843,6 +5050,9 @@ export interface DeleteConnectionMessage { } export namespace DeleteConnectionMessage { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteConnectionMessage): any => ({ ...obj, }); @@ -4910,6 +5120,9 @@ export interface Connection { } export namespace Connection { + /** + * @internal + */ export const filterSensitiveLog = (obj: Connection): any => ({ ...obj, }); @@ -4926,6 +5139,9 @@ export interface DeleteConnectionResponse { } export namespace DeleteConnectionResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteConnectionResponse): any => ({ ...obj, }); @@ -4942,6 +5158,9 @@ export interface DeleteEndpointMessage { } export namespace DeleteEndpointMessage { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteEndpointMessage): any => ({ ...obj, }); @@ -4958,6 +5177,9 @@ export interface DeleteEndpointResponse { } export namespace DeleteEndpointResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteEndpointResponse): any => ({ ...obj, ...(obj.Endpoint && { Endpoint: Endpoint.filterSensitiveLog(obj.Endpoint) }), @@ -4975,6 +5197,9 @@ export interface DeleteEventSubscriptionMessage { } export namespace DeleteEventSubscriptionMessage { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteEventSubscriptionMessage): any => ({ ...obj, }); @@ -4991,6 +5216,9 @@ export interface DeleteEventSubscriptionResponse { } export namespace DeleteEventSubscriptionResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteEventSubscriptionResponse): any => ({ ...obj, }); @@ -5007,6 +5235,9 @@ export interface DeleteReplicationInstanceMessage { } export namespace DeleteReplicationInstanceMessage { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteReplicationInstanceMessage): any => ({ ...obj, }); @@ -5023,6 +5254,9 @@ export interface DeleteReplicationInstanceResponse { } export namespace DeleteReplicationInstanceResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteReplicationInstanceResponse): any => ({ ...obj, }); @@ -5039,6 +5273,9 @@ export interface DeleteReplicationSubnetGroupMessage { } export namespace DeleteReplicationSubnetGroupMessage { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteReplicationSubnetGroupMessage): any => ({ ...obj, }); @@ -5050,6 +5287,9 @@ export namespace DeleteReplicationSubnetGroupMessage { export interface DeleteReplicationSubnetGroupResponse {} export namespace DeleteReplicationSubnetGroupResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteReplicationSubnetGroupResponse): any => ({ ...obj, }); @@ -5066,6 +5306,9 @@ export interface DeleteReplicationTaskMessage { } export namespace DeleteReplicationTaskMessage { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteReplicationTaskMessage): any => ({ ...obj, }); @@ -5082,6 +5325,9 @@ export interface DeleteReplicationTaskResponse { } export namespace DeleteReplicationTaskResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteReplicationTaskResponse): any => ({ ...obj, }); @@ -5098,6 +5344,9 @@ export interface DeleteReplicationTaskAssessmentRunMessage { } export namespace DeleteReplicationTaskAssessmentRunMessage { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteReplicationTaskAssessmentRunMessage): any => ({ ...obj, }); @@ -5115,6 +5364,9 @@ export interface DeleteReplicationTaskAssessmentRunResponse { } export namespace DeleteReplicationTaskAssessmentRunResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteReplicationTaskAssessmentRunResponse): any => ({ ...obj, }); @@ -5126,6 +5378,9 @@ export namespace DeleteReplicationTaskAssessmentRunResponse { export interface DescribeAccountAttributesMessage {} export namespace DescribeAccountAttributesMessage { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeAccountAttributesMessage): any => ({ ...obj, }); @@ -5158,6 +5413,9 @@ export interface DescribeAccountAttributesResponse { } export namespace DescribeAccountAttributesResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeAccountAttributesResponse): any => ({ ...obj, }); @@ -5210,6 +5468,9 @@ export interface DescribeApplicableIndividualAssessmentsMessage { } export namespace DescribeApplicableIndividualAssessmentsMessage { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeApplicableIndividualAssessmentsMessage): any => ({ ...obj, }); @@ -5239,6 +5500,9 @@ export interface DescribeApplicableIndividualAssessmentsResponse { } export namespace DescribeApplicableIndividualAssessmentsResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeApplicableIndividualAssessmentsResponse): any => ({ ...obj, }); @@ -5264,6 +5528,9 @@ export interface Filter { } export namespace Filter { + /** + * @internal + */ export const filterSensitiveLog = (obj: Filter): any => ({ ...obj, }); @@ -5292,6 +5559,9 @@ export interface DescribeCertificatesMessage { } export namespace DescribeCertificatesMessage { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeCertificatesMessage): any => ({ ...obj, }); @@ -5311,6 +5581,9 @@ export interface DescribeCertificatesResponse { } export namespace DescribeCertificatesResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeCertificatesResponse): any => ({ ...obj, }); @@ -5344,6 +5617,9 @@ export interface DescribeConnectionsMessage { } export namespace DescribeConnectionsMessage { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeConnectionsMessage): any => ({ ...obj, }); @@ -5367,6 +5643,9 @@ export interface DescribeConnectionsResponse { } export namespace DescribeConnectionsResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeConnectionsResponse): any => ({ ...obj, }); @@ -5400,6 +5679,9 @@ export interface DescribeEndpointsMessage { } export namespace DescribeEndpointsMessage { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeEndpointsMessage): any => ({ ...obj, }); @@ -5423,6 +5705,9 @@ export interface DescribeEndpointsResponse { } export namespace DescribeEndpointsResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeEndpointsResponse): any => ({ ...obj, ...(obj.Endpoints && { Endpoints: obj.Endpoints.map((item) => Endpoint.filterSensitiveLog(item)) }), @@ -5450,6 +5735,9 @@ export interface DescribeEndpointSettingsMessage { } export namespace DescribeEndpointSettingsMessage { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeEndpointSettingsMessage): any => ({ ...obj, }); @@ -5508,6 +5796,9 @@ export interface EndpointSetting { } export namespace EndpointSetting { + /** + * @internal + */ export const filterSensitiveLog = (obj: EndpointSetting): any => ({ ...obj, }); @@ -5527,6 +5818,9 @@ export interface DescribeEndpointSettingsResponse { } export namespace DescribeEndpointSettingsResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeEndpointSettingsResponse): any => ({ ...obj, }); @@ -5560,6 +5854,9 @@ export interface DescribeEndpointTypesMessage { } export namespace DescribeEndpointTypesMessage { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeEndpointTypesMessage): any => ({ ...obj, }); @@ -5606,6 +5903,9 @@ export interface SupportedEndpointType { } export namespace SupportedEndpointType { + /** + * @internal + */ export const filterSensitiveLog = (obj: SupportedEndpointType): any => ({ ...obj, }); @@ -5629,6 +5929,9 @@ export interface DescribeEndpointTypesResponse { } export namespace DescribeEndpointTypesResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeEndpointTypesResponse): any => ({ ...obj, }); @@ -5651,6 +5954,9 @@ export interface DescribeEventCategoriesMessage { } export namespace DescribeEventCategoriesMessage { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeEventCategoriesMessage): any => ({ ...obj, }); @@ -5679,6 +5985,9 @@ export interface EventCategoryGroup { } export namespace EventCategoryGroup { + /** + * @internal + */ export const filterSensitiveLog = (obj: EventCategoryGroup): any => ({ ...obj, }); @@ -5695,6 +6004,9 @@ export interface DescribeEventCategoriesResponse { } export namespace DescribeEventCategoriesResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeEventCategoriesResponse): any => ({ ...obj, }); @@ -5760,6 +6072,9 @@ export interface DescribeEventsMessage { } export namespace DescribeEventsMessage { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeEventsMessage): any => ({ ...obj, }); @@ -5799,6 +6114,9 @@ export interface Event { } export namespace Event { + /** + * @internal + */ export const filterSensitiveLog = (obj: Event): any => ({ ...obj, }); @@ -5822,6 +6140,9 @@ export interface DescribeEventsResponse { } export namespace DescribeEventsResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeEventsResponse): any => ({ ...obj, }); @@ -5859,6 +6180,9 @@ export interface DescribeEventSubscriptionsMessage { } export namespace DescribeEventSubscriptionsMessage { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeEventSubscriptionsMessage): any => ({ ...obj, }); @@ -5882,6 +6206,9 @@ export interface DescribeEventSubscriptionsResponse { } export namespace DescribeEventSubscriptionsResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeEventSubscriptionsResponse): any => ({ ...obj, }); @@ -5909,6 +6236,9 @@ export interface DescribeOrderableReplicationInstancesMessage { } export namespace DescribeOrderableReplicationInstancesMessage { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeOrderableReplicationInstancesMessage): any => ({ ...obj, }); @@ -5984,6 +6314,9 @@ export interface OrderableReplicationInstance { } export namespace OrderableReplicationInstance { + /** + * @internal + */ export const filterSensitiveLog = (obj: OrderableReplicationInstance): any => ({ ...obj, }); @@ -6007,6 +6340,9 @@ export interface DescribeOrderableReplicationInstancesResponse { } export namespace DescribeOrderableReplicationInstancesResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeOrderableReplicationInstancesResponse): any => ({ ...obj, }); @@ -6044,6 +6380,9 @@ export interface DescribePendingMaintenanceActionsMessage { } export namespace DescribePendingMaintenanceActionsMessage { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribePendingMaintenanceActionsMessage): any => ({ ...obj, }); @@ -6067,6 +6406,9 @@ export interface DescribePendingMaintenanceActionsResponse { } export namespace DescribePendingMaintenanceActionsResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribePendingMaintenanceActionsResponse): any => ({ ...obj, }); @@ -6083,6 +6425,9 @@ export interface DescribeRefreshSchemasStatusMessage { } export namespace DescribeRefreshSchemasStatusMessage { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeRefreshSchemasStatusMessage): any => ({ ...obj, }); @@ -6126,6 +6471,9 @@ export interface RefreshSchemasStatus { } export namespace RefreshSchemasStatus { + /** + * @internal + */ export const filterSensitiveLog = (obj: RefreshSchemasStatus): any => ({ ...obj, }); @@ -6142,6 +6490,9 @@ export interface DescribeRefreshSchemasStatusResponse { } export namespace DescribeRefreshSchemasStatusResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeRefreshSchemasStatusResponse): any => ({ ...obj, }); @@ -6176,6 +6527,9 @@ export interface DescribeReplicationInstancesMessage { } export namespace DescribeReplicationInstancesMessage { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeReplicationInstancesMessage): any => ({ ...obj, }); @@ -6199,6 +6553,9 @@ export interface DescribeReplicationInstancesResponse { } export namespace DescribeReplicationInstancesResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeReplicationInstancesResponse): any => ({ ...obj, }); @@ -6228,6 +6585,9 @@ export interface DescribeReplicationInstanceTaskLogsMessage { } export namespace DescribeReplicationInstanceTaskLogsMessage { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeReplicationInstanceTaskLogsMessage): any => ({ ...obj, }); @@ -6254,6 +6614,9 @@ export interface ReplicationInstanceTaskLog { } export namespace ReplicationInstanceTaskLog { + /** + * @internal + */ export const filterSensitiveLog = (obj: ReplicationInstanceTaskLog): any => ({ ...obj, }); @@ -6280,6 +6643,9 @@ export interface DescribeReplicationInstanceTaskLogsResponse { } export namespace DescribeReplicationInstanceTaskLogsResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeReplicationInstanceTaskLogsResponse): any => ({ ...obj, }); @@ -6313,6 +6679,9 @@ export interface DescribeReplicationSubnetGroupsMessage { } export namespace DescribeReplicationSubnetGroupsMessage { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeReplicationSubnetGroupsMessage): any => ({ ...obj, }); @@ -6336,6 +6705,9 @@ export interface DescribeReplicationSubnetGroupsResponse { } export namespace DescribeReplicationSubnetGroupsResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeReplicationSubnetGroupsResponse): any => ({ ...obj, }); @@ -6370,6 +6742,9 @@ export interface DescribeReplicationTaskAssessmentResultsMessage { } export namespace DescribeReplicationTaskAssessmentResultsMessage { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeReplicationTaskAssessmentResultsMessage): any => ({ ...obj, }); @@ -6417,6 +6792,9 @@ export interface ReplicationTaskAssessmentResult { } export namespace ReplicationTaskAssessmentResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: ReplicationTaskAssessmentResult): any => ({ ...obj, }); @@ -6445,6 +6823,9 @@ export interface DescribeReplicationTaskAssessmentResultsResponse { } export namespace DescribeReplicationTaskAssessmentResultsResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeReplicationTaskAssessmentResultsResponse): any => ({ ...obj, }); @@ -6478,6 +6859,9 @@ export interface DescribeReplicationTaskAssessmentRunsMessage { } export namespace DescribeReplicationTaskAssessmentRunsMessage { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeReplicationTaskAssessmentRunsMessage): any => ({ ...obj, }); @@ -6502,6 +6886,9 @@ export interface DescribeReplicationTaskAssessmentRunsResponse { } export namespace DescribeReplicationTaskAssessmentRunsResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeReplicationTaskAssessmentRunsResponse): any => ({ ...obj, }); @@ -6536,6 +6923,9 @@ export interface DescribeReplicationTaskIndividualAssessmentsMessage { } export namespace DescribeReplicationTaskIndividualAssessmentsMessage { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeReplicationTaskIndividualAssessmentsMessage): any => ({ ...obj, }); @@ -6608,6 +6998,9 @@ export interface ReplicationTaskIndividualAssessment { } export namespace ReplicationTaskIndividualAssessment { + /** + * @internal + */ export const filterSensitiveLog = (obj: ReplicationTaskIndividualAssessment): any => ({ ...obj, }); @@ -6632,6 +7025,9 @@ export interface DescribeReplicationTaskIndividualAssessmentsResponse { } export namespace DescribeReplicationTaskIndividualAssessmentsResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeReplicationTaskIndividualAssessmentsResponse): any => ({ ...obj, }); @@ -6673,6 +7069,9 @@ export interface DescribeReplicationTasksMessage { } export namespace DescribeReplicationTasksMessage { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeReplicationTasksMessage): any => ({ ...obj, }); @@ -6696,6 +7095,9 @@ export interface DescribeReplicationTasksResponse { } export namespace DescribeReplicationTasksResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeReplicationTasksResponse): any => ({ ...obj, }); @@ -6728,6 +7130,9 @@ export interface DescribeSchemasMessage { } export namespace DescribeSchemasMessage { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeSchemasMessage): any => ({ ...obj, }); @@ -6751,6 +7156,9 @@ export interface DescribeSchemasResponse { } export namespace DescribeSchemasResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeSchemasResponse): any => ({ ...obj, }); @@ -6791,6 +7199,9 @@ export interface DescribeTableStatisticsMessage { } export namespace DescribeTableStatisticsMessage { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeTableStatisticsMessage): any => ({ ...obj, }); @@ -6945,6 +7356,9 @@ export interface TableStatistics { } export namespace TableStatistics { + /** + * @internal + */ export const filterSensitiveLog = (obj: TableStatistics): any => ({ ...obj, }); @@ -6973,6 +7387,9 @@ export interface DescribeTableStatisticsResponse { } export namespace DescribeTableStatisticsResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeTableStatisticsResponse): any => ({ ...obj, }); @@ -7003,6 +7420,9 @@ export interface ImportCertificateMessage { } export namespace ImportCertificateMessage { + /** + * @internal + */ export const filterSensitiveLog = (obj: ImportCertificateMessage): any => ({ ...obj, ...(obj.CertificatePem && { CertificatePem: SENSITIVE_STRING }), @@ -7017,6 +7437,9 @@ export interface ImportCertificateResponse { } export namespace ImportCertificateResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ImportCertificateResponse): any => ({ ...obj, }); @@ -7032,6 +7455,9 @@ export interface InvalidCertificateFault extends __SmithyException, $MetadataBea } export namespace InvalidCertificateFault { + /** + * @internal + */ export const filterSensitiveLog = (obj: InvalidCertificateFault): any => ({ ...obj, }); @@ -7049,6 +7475,9 @@ export interface ListTagsForResourceMessage { } export namespace ListTagsForResourceMessage { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListTagsForResourceMessage): any => ({ ...obj, }); @@ -7065,6 +7494,9 @@ export interface ListTagsForResourceResponse { } export namespace ListTagsForResourceResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListTagsForResourceResponse): any => ({ ...obj, }); @@ -7318,6 +7750,9 @@ export interface ModifyEndpointMessage { } export namespace ModifyEndpointMessage { + /** + * @internal + */ export const filterSensitiveLog = (obj: ModifyEndpointMessage): any => ({ ...obj, ...(obj.Password && { Password: SENSITIVE_STRING }), @@ -7349,6 +7784,9 @@ export interface ModifyEndpointResponse { } export namespace ModifyEndpointResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ModifyEndpointResponse): any => ({ ...obj, ...(obj.Endpoint && { Endpoint: Endpoint.filterSensitiveLog(obj.Endpoint) }), @@ -7390,6 +7828,9 @@ export interface ModifyEventSubscriptionMessage { } export namespace ModifyEventSubscriptionMessage { + /** + * @internal + */ export const filterSensitiveLog = (obj: ModifyEventSubscriptionMessage): any => ({ ...obj, }); @@ -7406,6 +7847,9 @@ export interface ModifyEventSubscriptionResponse { } export namespace ModifyEventSubscriptionResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ModifyEventSubscriptionResponse): any => ({ ...obj, }); @@ -7512,6 +7956,9 @@ export interface ModifyReplicationInstanceMessage { } export namespace ModifyReplicationInstanceMessage { + /** + * @internal + */ export const filterSensitiveLog = (obj: ModifyReplicationInstanceMessage): any => ({ ...obj, }); @@ -7528,6 +7975,9 @@ export interface ModifyReplicationInstanceResponse { } export namespace ModifyReplicationInstanceResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ModifyReplicationInstanceResponse): any => ({ ...obj, }); @@ -7546,6 +7996,9 @@ export interface UpgradeDependencyFailureFault extends __SmithyException, $Metad } export namespace UpgradeDependencyFailureFault { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpgradeDependencyFailureFault): any => ({ ...obj, }); @@ -7572,6 +8025,9 @@ export interface ModifyReplicationSubnetGroupMessage { } export namespace ModifyReplicationSubnetGroupMessage { + /** + * @internal + */ export const filterSensitiveLog = (obj: ModifyReplicationSubnetGroupMessage): any => ({ ...obj, }); @@ -7588,6 +8044,9 @@ export interface ModifyReplicationSubnetGroupResponse { } export namespace ModifyReplicationSubnetGroupResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ModifyReplicationSubnetGroupResponse): any => ({ ...obj, }); @@ -7606,6 +8065,9 @@ export interface SubnetAlreadyInUse extends __SmithyException, $MetadataBearer { } export namespace SubnetAlreadyInUse { + /** + * @internal + */ export const filterSensitiveLog = (obj: SubnetAlreadyInUse): any => ({ ...obj, }); @@ -7702,6 +8164,9 @@ export interface ModifyReplicationTaskMessage { } export namespace ModifyReplicationTaskMessage { + /** + * @internal + */ export const filterSensitiveLog = (obj: ModifyReplicationTaskMessage): any => ({ ...obj, }); @@ -7718,6 +8183,9 @@ export interface ModifyReplicationTaskResponse { } export namespace ModifyReplicationTaskResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ModifyReplicationTaskResponse): any => ({ ...obj, }); @@ -7739,6 +8207,9 @@ export interface MoveReplicationTaskMessage { } export namespace MoveReplicationTaskMessage { + /** + * @internal + */ export const filterSensitiveLog = (obj: MoveReplicationTaskMessage): any => ({ ...obj, }); @@ -7755,6 +8226,9 @@ export interface MoveReplicationTaskResponse { } export namespace MoveReplicationTaskResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: MoveReplicationTaskResponse): any => ({ ...obj, }); @@ -7775,6 +8249,9 @@ export interface RebootReplicationInstanceMessage { } export namespace RebootReplicationInstanceMessage { + /** + * @internal + */ export const filterSensitiveLog = (obj: RebootReplicationInstanceMessage): any => ({ ...obj, }); @@ -7788,6 +8265,9 @@ export interface RebootReplicationInstanceResponse { } export namespace RebootReplicationInstanceResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: RebootReplicationInstanceResponse): any => ({ ...obj, }); @@ -7809,6 +8289,9 @@ export interface RefreshSchemasMessage { } export namespace RefreshSchemasMessage { + /** + * @internal + */ export const filterSensitiveLog = (obj: RefreshSchemasMessage): any => ({ ...obj, }); @@ -7825,6 +8308,9 @@ export interface RefreshSchemasResponse { } export namespace RefreshSchemasResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: RefreshSchemasResponse): any => ({ ...obj, }); @@ -7851,6 +8337,9 @@ export interface TableToReload { } export namespace TableToReload { + /** + * @internal + */ export const filterSensitiveLog = (obj: TableToReload): any => ({ ...obj, }); @@ -7878,6 +8367,9 @@ export interface ReloadTablesMessage { } export namespace ReloadTablesMessage { + /** + * @internal + */ export const filterSensitiveLog = (obj: ReloadTablesMessage): any => ({ ...obj, }); @@ -7891,6 +8383,9 @@ export interface ReloadTablesResponse { } export namespace ReloadTablesResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ReloadTablesResponse): any => ({ ...obj, }); @@ -7912,6 +8407,9 @@ export interface RemoveTagsFromResourceMessage { } export namespace RemoveTagsFromResourceMessage { + /** + * @internal + */ export const filterSensitiveLog = (obj: RemoveTagsFromResourceMessage): any => ({ ...obj, }); @@ -7923,6 +8421,9 @@ export namespace RemoveTagsFromResourceMessage { export interface RemoveTagsFromResourceResponse {} export namespace RemoveTagsFromResourceResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: RemoveTagsFromResourceResponse): any => ({ ...obj, }); @@ -7985,6 +8486,9 @@ export interface StartReplicationTaskMessage { } export namespace StartReplicationTaskMessage { + /** + * @internal + */ export const filterSensitiveLog = (obj: StartReplicationTaskMessage): any => ({ ...obj, }); @@ -8001,6 +8505,9 @@ export interface StartReplicationTaskResponse { } export namespace StartReplicationTaskResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: StartReplicationTaskResponse): any => ({ ...obj, }); @@ -8017,6 +8524,9 @@ export interface StartReplicationTaskAssessmentMessage { } export namespace StartReplicationTaskAssessmentMessage { + /** + * @internal + */ export const filterSensitiveLog = (obj: StartReplicationTaskAssessmentMessage): any => ({ ...obj, }); @@ -8033,6 +8543,9 @@ export interface StartReplicationTaskAssessmentResponse { } export namespace StartReplicationTaskAssessmentResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: StartReplicationTaskAssessmentResponse): any => ({ ...obj, }); @@ -8048,6 +8561,9 @@ export interface KMSFault extends __SmithyException, $MetadataBearer { } export namespace KMSFault { + /** + * @internal + */ export const filterSensitiveLog = (obj: KMSFault): any => ({ ...obj, }); @@ -8064,6 +8580,9 @@ export interface S3ResourceNotFoundFault extends __SmithyException, $MetadataBea } export namespace S3ResourceNotFoundFault { + /** + * @internal + */ export const filterSensitiveLog = (obj: S3ResourceNotFoundFault): any => ({ ...obj, }); @@ -8161,6 +8680,9 @@ export interface StartReplicationTaskAssessmentRunMessage { } export namespace StartReplicationTaskAssessmentRunMessage { + /** + * @internal + */ export const filterSensitiveLog = (obj: StartReplicationTaskAssessmentRunMessage): any => ({ ...obj, }); @@ -8177,6 +8699,9 @@ export interface StartReplicationTaskAssessmentRunResponse { } export namespace StartReplicationTaskAssessmentRunResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: StartReplicationTaskAssessmentRunResponse): any => ({ ...obj, }); @@ -8193,6 +8718,9 @@ export interface StopReplicationTaskMessage { } export namespace StopReplicationTaskMessage { + /** + * @internal + */ export const filterSensitiveLog = (obj: StopReplicationTaskMessage): any => ({ ...obj, }); @@ -8209,6 +8737,9 @@ export interface StopReplicationTaskResponse { } export namespace StopReplicationTaskResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: StopReplicationTaskResponse): any => ({ ...obj, }); @@ -8230,6 +8761,9 @@ export interface TestConnectionMessage { } export namespace TestConnectionMessage { + /** + * @internal + */ export const filterSensitiveLog = (obj: TestConnectionMessage): any => ({ ...obj, }); @@ -8246,6 +8780,9 @@ export interface TestConnectionResponse { } export namespace TestConnectionResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: TestConnectionResponse): any => ({ ...obj, }); diff --git a/clients/client-databrew/commands/BatchDeleteRecipeVersionCommand.ts b/clients/client-databrew/commands/BatchDeleteRecipeVersionCommand.ts index e1d1ddec62f6..51ff29712b54 100644 --- a/clients/client-databrew/commands/BatchDeleteRecipeVersionCommand.ts +++ b/clients/client-databrew/commands/BatchDeleteRecipeVersionCommand.ts @@ -62,6 +62,20 @@ export interface BatchDeleteRecipeVersionCommandOutput extends BatchDeleteRecipe * 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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { DataBrewClient, BatchDeleteRecipeVersionCommand } from "@aws-sdk/client-databrew"; // ES Modules import + * // const { DataBrewClient, BatchDeleteRecipeVersionCommand } = require("@aws-sdk/client-databrew"); // CommonJS import + * const client = new DataBrewClient(config); + * const command = new BatchDeleteRecipeVersionCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link BatchDeleteRecipeVersionCommandInput} for command's `input` shape. + * @see {@link BatchDeleteRecipeVersionCommandOutput} for command's `response` shape. + * @see {@link DataBrewClientResolvedConfig | config} for command's `input` shape. + * */ export class BatchDeleteRecipeVersionCommand extends $Command< BatchDeleteRecipeVersionCommandInput, diff --git a/clients/client-databrew/commands/CreateDatasetCommand.ts b/clients/client-databrew/commands/CreateDatasetCommand.ts index 91264360eb91..8d835091d721 100644 --- a/clients/client-databrew/commands/CreateDatasetCommand.ts +++ b/clients/client-databrew/commands/CreateDatasetCommand.ts @@ -22,6 +22,20 @@ export interface CreateDatasetCommandOutput extends CreateDatasetResponse, __Met /** *

Creates a new DataBrew dataset.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { DataBrewClient, CreateDatasetCommand } from "@aws-sdk/client-databrew"; // ES Modules import + * // const { DataBrewClient, CreateDatasetCommand } = require("@aws-sdk/client-databrew"); // CommonJS import + * const client = new DataBrewClient(config); + * const command = new CreateDatasetCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreateDatasetCommandInput} for command's `input` shape. + * @see {@link CreateDatasetCommandOutput} for command's `response` shape. + * @see {@link DataBrewClientResolvedConfig | config} for command's `input` shape. + * */ export class CreateDatasetCommand extends $Command< CreateDatasetCommandInput, diff --git a/clients/client-databrew/commands/CreateProfileJobCommand.ts b/clients/client-databrew/commands/CreateProfileJobCommand.ts index ede254c973d7..99f2127f2654 100644 --- a/clients/client-databrew/commands/CreateProfileJobCommand.ts +++ b/clients/client-databrew/commands/CreateProfileJobCommand.ts @@ -22,6 +22,20 @@ export interface CreateProfileJobCommandOutput extends CreateProfileJobResponse, /** *

Creates a new job to analyze a dataset and create its data profile.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { DataBrewClient, CreateProfileJobCommand } from "@aws-sdk/client-databrew"; // ES Modules import + * // const { DataBrewClient, CreateProfileJobCommand } = require("@aws-sdk/client-databrew"); // CommonJS import + * const client = new DataBrewClient(config); + * const command = new CreateProfileJobCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreateProfileJobCommandInput} for command's `input` shape. + * @see {@link CreateProfileJobCommandOutput} for command's `response` shape. + * @see {@link DataBrewClientResolvedConfig | config} for command's `input` shape. + * */ export class CreateProfileJobCommand extends $Command< CreateProfileJobCommandInput, diff --git a/clients/client-databrew/commands/CreateProjectCommand.ts b/clients/client-databrew/commands/CreateProjectCommand.ts index 0b4fa1d31fbe..e08a2c428088 100644 --- a/clients/client-databrew/commands/CreateProjectCommand.ts +++ b/clients/client-databrew/commands/CreateProjectCommand.ts @@ -22,6 +22,20 @@ export interface CreateProjectCommandOutput extends CreateProjectResponse, __Met /** *

Creates a new DataBrew project.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { DataBrewClient, CreateProjectCommand } from "@aws-sdk/client-databrew"; // ES Modules import + * // const { DataBrewClient, CreateProjectCommand } = require("@aws-sdk/client-databrew"); // CommonJS import + * const client = new DataBrewClient(config); + * const command = new CreateProjectCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreateProjectCommandInput} for command's `input` shape. + * @see {@link CreateProjectCommandOutput} for command's `response` shape. + * @see {@link DataBrewClientResolvedConfig | config} for command's `input` shape. + * */ export class CreateProjectCommand extends $Command< CreateProjectCommandInput, diff --git a/clients/client-databrew/commands/CreateRecipeCommand.ts b/clients/client-databrew/commands/CreateRecipeCommand.ts index 8c21320c98fe..2f95a5fe914b 100644 --- a/clients/client-databrew/commands/CreateRecipeCommand.ts +++ b/clients/client-databrew/commands/CreateRecipeCommand.ts @@ -22,6 +22,20 @@ export interface CreateRecipeCommandOutput extends CreateRecipeResponse, __Metad /** *

Creates a new DataBrew recipe.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { DataBrewClient, CreateRecipeCommand } from "@aws-sdk/client-databrew"; // ES Modules import + * // const { DataBrewClient, CreateRecipeCommand } = require("@aws-sdk/client-databrew"); // CommonJS import + * const client = new DataBrewClient(config); + * const command = new CreateRecipeCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreateRecipeCommandInput} for command's `input` shape. + * @see {@link CreateRecipeCommandOutput} for command's `response` shape. + * @see {@link DataBrewClientResolvedConfig | config} for command's `input` shape. + * */ export class CreateRecipeCommand extends $Command< CreateRecipeCommandInput, diff --git a/clients/client-databrew/commands/CreateRecipeJobCommand.ts b/clients/client-databrew/commands/CreateRecipeJobCommand.ts index 9b1d44a77371..24dfff87925e 100644 --- a/clients/client-databrew/commands/CreateRecipeJobCommand.ts +++ b/clients/client-databrew/commands/CreateRecipeJobCommand.ts @@ -23,6 +23,20 @@ export interface CreateRecipeJobCommandOutput extends CreateRecipeJobResponse, _ /** *

Creates a new job to transform input data, using steps defined in an existing AWS Glue * DataBrew recipe

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { DataBrewClient, CreateRecipeJobCommand } from "@aws-sdk/client-databrew"; // ES Modules import + * // const { DataBrewClient, CreateRecipeJobCommand } = require("@aws-sdk/client-databrew"); // CommonJS import + * const client = new DataBrewClient(config); + * const command = new CreateRecipeJobCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreateRecipeJobCommandInput} for command's `input` shape. + * @see {@link CreateRecipeJobCommandOutput} for command's `response` shape. + * @see {@link DataBrewClientResolvedConfig | config} for command's `input` shape. + * */ export class CreateRecipeJobCommand extends $Command< CreateRecipeJobCommandInput, diff --git a/clients/client-databrew/commands/CreateScheduleCommand.ts b/clients/client-databrew/commands/CreateScheduleCommand.ts index 5e6c49605faf..33217a242e68 100644 --- a/clients/client-databrew/commands/CreateScheduleCommand.ts +++ b/clients/client-databrew/commands/CreateScheduleCommand.ts @@ -23,6 +23,20 @@ export interface CreateScheduleCommandOutput extends CreateScheduleResponse, __M /** *

Creates a new schedule for one or more DataBrew jobs. Jobs can be run at a specific * date and time, or at regular intervals.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { DataBrewClient, CreateScheduleCommand } from "@aws-sdk/client-databrew"; // ES Modules import + * // const { DataBrewClient, CreateScheduleCommand } = require("@aws-sdk/client-databrew"); // CommonJS import + * const client = new DataBrewClient(config); + * const command = new CreateScheduleCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreateScheduleCommandInput} for command's `input` shape. + * @see {@link CreateScheduleCommandOutput} for command's `response` shape. + * @see {@link DataBrewClientResolvedConfig | config} for command's `input` shape. + * */ export class CreateScheduleCommand extends $Command< CreateScheduleCommandInput, diff --git a/clients/client-databrew/commands/DeleteDatasetCommand.ts b/clients/client-databrew/commands/DeleteDatasetCommand.ts index 6f08865bad89..11788805c226 100644 --- a/clients/client-databrew/commands/DeleteDatasetCommand.ts +++ b/clients/client-databrew/commands/DeleteDatasetCommand.ts @@ -22,6 +22,20 @@ export interface DeleteDatasetCommandOutput extends DeleteDatasetResponse, __Met /** *

Deletes a dataset from DataBrew.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { DataBrewClient, DeleteDatasetCommand } from "@aws-sdk/client-databrew"; // ES Modules import + * // const { DataBrewClient, DeleteDatasetCommand } = require("@aws-sdk/client-databrew"); // CommonJS import + * const client = new DataBrewClient(config); + * const command = new DeleteDatasetCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteDatasetCommandInput} for command's `input` shape. + * @see {@link DeleteDatasetCommandOutput} for command's `response` shape. + * @see {@link DataBrewClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteDatasetCommand extends $Command< DeleteDatasetCommandInput, diff --git a/clients/client-databrew/commands/DeleteJobCommand.ts b/clients/client-databrew/commands/DeleteJobCommand.ts index e12a489afb37..0f6ae9d76436 100644 --- a/clients/client-databrew/commands/DeleteJobCommand.ts +++ b/clients/client-databrew/commands/DeleteJobCommand.ts @@ -22,6 +22,20 @@ export interface DeleteJobCommandOutput extends DeleteJobResponse, __MetadataBea /** *

Deletes the specified DataBrew job.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { DataBrewClient, DeleteJobCommand } from "@aws-sdk/client-databrew"; // ES Modules import + * // const { DataBrewClient, DeleteJobCommand } = require("@aws-sdk/client-databrew"); // CommonJS import + * const client = new DataBrewClient(config); + * const command = new DeleteJobCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteJobCommandInput} for command's `input` shape. + * @see {@link DeleteJobCommandOutput} for command's `response` shape. + * @see {@link DataBrewClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteJobCommand extends $Command< DeleteJobCommandInput, diff --git a/clients/client-databrew/commands/DeleteProjectCommand.ts b/clients/client-databrew/commands/DeleteProjectCommand.ts index c64f06288eda..3a79b3e67d8b 100644 --- a/clients/client-databrew/commands/DeleteProjectCommand.ts +++ b/clients/client-databrew/commands/DeleteProjectCommand.ts @@ -22,6 +22,20 @@ export interface DeleteProjectCommandOutput extends DeleteProjectResponse, __Met /** *

Deletes an existing DataBrew project.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { DataBrewClient, DeleteProjectCommand } from "@aws-sdk/client-databrew"; // ES Modules import + * // const { DataBrewClient, DeleteProjectCommand } = require("@aws-sdk/client-databrew"); // CommonJS import + * const client = new DataBrewClient(config); + * const command = new DeleteProjectCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteProjectCommandInput} for command's `input` shape. + * @see {@link DeleteProjectCommandOutput} for command's `response` shape. + * @see {@link DataBrewClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteProjectCommand extends $Command< DeleteProjectCommandInput, diff --git a/clients/client-databrew/commands/DeleteRecipeVersionCommand.ts b/clients/client-databrew/commands/DeleteRecipeVersionCommand.ts index e884a5e1db33..c06f3aab4f57 100644 --- a/clients/client-databrew/commands/DeleteRecipeVersionCommand.ts +++ b/clients/client-databrew/commands/DeleteRecipeVersionCommand.ts @@ -22,6 +22,20 @@ export interface DeleteRecipeVersionCommandOutput extends DeleteRecipeVersionRes /** *

Deletes a single version of a DataBrew recipe.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { DataBrewClient, DeleteRecipeVersionCommand } from "@aws-sdk/client-databrew"; // ES Modules import + * // const { DataBrewClient, DeleteRecipeVersionCommand } = require("@aws-sdk/client-databrew"); // CommonJS import + * const client = new DataBrewClient(config); + * const command = new DeleteRecipeVersionCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteRecipeVersionCommandInput} for command's `input` shape. + * @see {@link DeleteRecipeVersionCommandOutput} for command's `response` shape. + * @see {@link DataBrewClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteRecipeVersionCommand extends $Command< DeleteRecipeVersionCommandInput, diff --git a/clients/client-databrew/commands/DeleteScheduleCommand.ts b/clients/client-databrew/commands/DeleteScheduleCommand.ts index 63f4e12246aa..502b70a55d4e 100644 --- a/clients/client-databrew/commands/DeleteScheduleCommand.ts +++ b/clients/client-databrew/commands/DeleteScheduleCommand.ts @@ -22,6 +22,20 @@ export interface DeleteScheduleCommandOutput extends DeleteScheduleResponse, __M /** *

Deletes the specified DataBrew schedule.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { DataBrewClient, DeleteScheduleCommand } from "@aws-sdk/client-databrew"; // ES Modules import + * // const { DataBrewClient, DeleteScheduleCommand } = require("@aws-sdk/client-databrew"); // CommonJS import + * const client = new DataBrewClient(config); + * const command = new DeleteScheduleCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteScheduleCommandInput} for command's `input` shape. + * @see {@link DeleteScheduleCommandOutput} for command's `response` shape. + * @see {@link DataBrewClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteScheduleCommand extends $Command< DeleteScheduleCommandInput, diff --git a/clients/client-databrew/commands/DescribeDatasetCommand.ts b/clients/client-databrew/commands/DescribeDatasetCommand.ts index c6b26d7f281d..b0b9afb32c07 100644 --- a/clients/client-databrew/commands/DescribeDatasetCommand.ts +++ b/clients/client-databrew/commands/DescribeDatasetCommand.ts @@ -22,6 +22,20 @@ export interface DescribeDatasetCommandOutput extends DescribeDatasetResponse, _ /** *

Returns the definition of a specific DataBrew dataset.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { DataBrewClient, DescribeDatasetCommand } from "@aws-sdk/client-databrew"; // ES Modules import + * // const { DataBrewClient, DescribeDatasetCommand } = require("@aws-sdk/client-databrew"); // CommonJS import + * const client = new DataBrewClient(config); + * const command = new DescribeDatasetCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeDatasetCommandInput} for command's `input` shape. + * @see {@link DescribeDatasetCommandOutput} for command's `response` shape. + * @see {@link DataBrewClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeDatasetCommand extends $Command< DescribeDatasetCommandInput, diff --git a/clients/client-databrew/commands/DescribeJobCommand.ts b/clients/client-databrew/commands/DescribeJobCommand.ts index edb328ce982e..3dad3cfca5de 100644 --- a/clients/client-databrew/commands/DescribeJobCommand.ts +++ b/clients/client-databrew/commands/DescribeJobCommand.ts @@ -22,6 +22,20 @@ export interface DescribeJobCommandOutput extends DescribeJobResponse, __Metadat /** *

Returns the definition of a specific DataBrew job.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { DataBrewClient, DescribeJobCommand } from "@aws-sdk/client-databrew"; // ES Modules import + * // const { DataBrewClient, DescribeJobCommand } = require("@aws-sdk/client-databrew"); // CommonJS import + * const client = new DataBrewClient(config); + * const command = new DescribeJobCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeJobCommandInput} for command's `input` shape. + * @see {@link DescribeJobCommandOutput} for command's `response` shape. + * @see {@link DataBrewClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeJobCommand extends $Command< DescribeJobCommandInput, diff --git a/clients/client-databrew/commands/DescribeJobRunCommand.ts b/clients/client-databrew/commands/DescribeJobRunCommand.ts index cef68fbcedd8..c947ec554954 100644 --- a/clients/client-databrew/commands/DescribeJobRunCommand.ts +++ b/clients/client-databrew/commands/DescribeJobRunCommand.ts @@ -22,6 +22,20 @@ export interface DescribeJobRunCommandOutput extends DescribeJobRunResponse, __M /** *

Represents one run of a DataBrew job.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { DataBrewClient, DescribeJobRunCommand } from "@aws-sdk/client-databrew"; // ES Modules import + * // const { DataBrewClient, DescribeJobRunCommand } = require("@aws-sdk/client-databrew"); // CommonJS import + * const client = new DataBrewClient(config); + * const command = new DescribeJobRunCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeJobRunCommandInput} for command's `input` shape. + * @see {@link DescribeJobRunCommandOutput} for command's `response` shape. + * @see {@link DataBrewClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeJobRunCommand extends $Command< DescribeJobRunCommandInput, diff --git a/clients/client-databrew/commands/DescribeProjectCommand.ts b/clients/client-databrew/commands/DescribeProjectCommand.ts index 1fef296d5fc5..a680b9664b38 100644 --- a/clients/client-databrew/commands/DescribeProjectCommand.ts +++ b/clients/client-databrew/commands/DescribeProjectCommand.ts @@ -22,6 +22,20 @@ export interface DescribeProjectCommandOutput extends DescribeProjectResponse, _ /** *

Returns the definition of a specific DataBrew project.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { DataBrewClient, DescribeProjectCommand } from "@aws-sdk/client-databrew"; // ES Modules import + * // const { DataBrewClient, DescribeProjectCommand } = require("@aws-sdk/client-databrew"); // CommonJS import + * const client = new DataBrewClient(config); + * const command = new DescribeProjectCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeProjectCommandInput} for command's `input` shape. + * @see {@link DescribeProjectCommandOutput} for command's `response` shape. + * @see {@link DataBrewClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeProjectCommand extends $Command< DescribeProjectCommandInput, diff --git a/clients/client-databrew/commands/DescribeRecipeCommand.ts b/clients/client-databrew/commands/DescribeRecipeCommand.ts index 7a799360f0c9..019a595e0545 100644 --- a/clients/client-databrew/commands/DescribeRecipeCommand.ts +++ b/clients/client-databrew/commands/DescribeRecipeCommand.ts @@ -23,6 +23,20 @@ export interface DescribeRecipeCommandOutput extends DescribeRecipeResponse, __M /** *

Returns the definition of a specific DataBrew recipe corresponding to a particular * version.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { DataBrewClient, DescribeRecipeCommand } from "@aws-sdk/client-databrew"; // ES Modules import + * // const { DataBrewClient, DescribeRecipeCommand } = require("@aws-sdk/client-databrew"); // CommonJS import + * const client = new DataBrewClient(config); + * const command = new DescribeRecipeCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeRecipeCommandInput} for command's `input` shape. + * @see {@link DescribeRecipeCommandOutput} for command's `response` shape. + * @see {@link DataBrewClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeRecipeCommand extends $Command< DescribeRecipeCommandInput, diff --git a/clients/client-databrew/commands/DescribeScheduleCommand.ts b/clients/client-databrew/commands/DescribeScheduleCommand.ts index 34cc7f38b57e..94c2eaea7aa4 100644 --- a/clients/client-databrew/commands/DescribeScheduleCommand.ts +++ b/clients/client-databrew/commands/DescribeScheduleCommand.ts @@ -22,6 +22,20 @@ export interface DescribeScheduleCommandOutput extends DescribeScheduleResponse, /** *

Returns the definition of a specific DataBrew schedule.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { DataBrewClient, DescribeScheduleCommand } from "@aws-sdk/client-databrew"; // ES Modules import + * // const { DataBrewClient, DescribeScheduleCommand } = require("@aws-sdk/client-databrew"); // CommonJS import + * const client = new DataBrewClient(config); + * const command = new DescribeScheduleCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeScheduleCommandInput} for command's `input` shape. + * @see {@link DescribeScheduleCommandOutput} for command's `response` shape. + * @see {@link DataBrewClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeScheduleCommand extends $Command< DescribeScheduleCommandInput, diff --git a/clients/client-databrew/commands/ListDatasetsCommand.ts b/clients/client-databrew/commands/ListDatasetsCommand.ts index a754d1416334..d9f72d5c0b10 100644 --- a/clients/client-databrew/commands/ListDatasetsCommand.ts +++ b/clients/client-databrew/commands/ListDatasetsCommand.ts @@ -22,6 +22,20 @@ export interface ListDatasetsCommandOutput extends ListDatasetsResponse, __Metad /** *

Lists all of the DataBrew datasets.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { DataBrewClient, ListDatasetsCommand } from "@aws-sdk/client-databrew"; // ES Modules import + * // const { DataBrewClient, ListDatasetsCommand } = require("@aws-sdk/client-databrew"); // CommonJS import + * const client = new DataBrewClient(config); + * const command = new ListDatasetsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListDatasetsCommandInput} for command's `input` shape. + * @see {@link ListDatasetsCommandOutput} for command's `response` shape. + * @see {@link DataBrewClientResolvedConfig | config} for command's `input` shape. + * */ export class ListDatasetsCommand extends $Command< ListDatasetsCommandInput, diff --git a/clients/client-databrew/commands/ListJobRunsCommand.ts b/clients/client-databrew/commands/ListJobRunsCommand.ts index 6a2884d31004..f80874ce2172 100644 --- a/clients/client-databrew/commands/ListJobRunsCommand.ts +++ b/clients/client-databrew/commands/ListJobRunsCommand.ts @@ -22,6 +22,20 @@ export interface ListJobRunsCommandOutput extends ListJobRunsResponse, __Metadat /** *

Lists all of the previous runs of a particular DataBrew job.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { DataBrewClient, ListJobRunsCommand } from "@aws-sdk/client-databrew"; // ES Modules import + * // const { DataBrewClient, ListJobRunsCommand } = require("@aws-sdk/client-databrew"); // CommonJS import + * const client = new DataBrewClient(config); + * const command = new ListJobRunsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListJobRunsCommandInput} for command's `input` shape. + * @see {@link ListJobRunsCommandOutput} for command's `response` shape. + * @see {@link DataBrewClientResolvedConfig | config} for command's `input` shape. + * */ export class ListJobRunsCommand extends $Command< ListJobRunsCommandInput, diff --git a/clients/client-databrew/commands/ListJobsCommand.ts b/clients/client-databrew/commands/ListJobsCommand.ts index 2a2391fa4b04..af3b53a67089 100644 --- a/clients/client-databrew/commands/ListJobsCommand.ts +++ b/clients/client-databrew/commands/ListJobsCommand.ts @@ -22,6 +22,20 @@ export interface ListJobsCommandOutput extends ListJobsResponse, __MetadataBeare /** *

Lists all of the DataBrew jobs that are defined.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { DataBrewClient, ListJobsCommand } from "@aws-sdk/client-databrew"; // ES Modules import + * // const { DataBrewClient, ListJobsCommand } = require("@aws-sdk/client-databrew"); // CommonJS import + * const client = new DataBrewClient(config); + * const command = new ListJobsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListJobsCommandInput} for command's `input` shape. + * @see {@link ListJobsCommandOutput} for command's `response` shape. + * @see {@link DataBrewClientResolvedConfig | config} for command's `input` shape. + * */ export class ListJobsCommand extends $Command< ListJobsCommandInput, diff --git a/clients/client-databrew/commands/ListProjectsCommand.ts b/clients/client-databrew/commands/ListProjectsCommand.ts index 518c4b32f92b..923c667db1a3 100644 --- a/clients/client-databrew/commands/ListProjectsCommand.ts +++ b/clients/client-databrew/commands/ListProjectsCommand.ts @@ -22,6 +22,20 @@ export interface ListProjectsCommandOutput extends ListProjectsResponse, __Metad /** *

Lists all of the DataBrew projects that are defined.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { DataBrewClient, ListProjectsCommand } from "@aws-sdk/client-databrew"; // ES Modules import + * // const { DataBrewClient, ListProjectsCommand } = require("@aws-sdk/client-databrew"); // CommonJS import + * const client = new DataBrewClient(config); + * const command = new ListProjectsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListProjectsCommandInput} for command's `input` shape. + * @see {@link ListProjectsCommandOutput} for command's `response` shape. + * @see {@link DataBrewClientResolvedConfig | config} for command's `input` shape. + * */ export class ListProjectsCommand extends $Command< ListProjectsCommandInput, diff --git a/clients/client-databrew/commands/ListRecipeVersionsCommand.ts b/clients/client-databrew/commands/ListRecipeVersionsCommand.ts index 20497d8e42b2..43b7992309a9 100644 --- a/clients/client-databrew/commands/ListRecipeVersionsCommand.ts +++ b/clients/client-databrew/commands/ListRecipeVersionsCommand.ts @@ -23,6 +23,20 @@ export interface ListRecipeVersionsCommandOutput extends ListRecipeVersionsRespo /** *

Lists the versions of a particular DataBrew recipe, except for * LATEST_WORKING.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { DataBrewClient, ListRecipeVersionsCommand } from "@aws-sdk/client-databrew"; // ES Modules import + * // const { DataBrewClient, ListRecipeVersionsCommand } = require("@aws-sdk/client-databrew"); // CommonJS import + * const client = new DataBrewClient(config); + * const command = new ListRecipeVersionsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListRecipeVersionsCommandInput} for command's `input` shape. + * @see {@link ListRecipeVersionsCommandOutput} for command's `response` shape. + * @see {@link DataBrewClientResolvedConfig | config} for command's `input` shape. + * */ export class ListRecipeVersionsCommand extends $Command< ListRecipeVersionsCommandInput, diff --git a/clients/client-databrew/commands/ListRecipesCommand.ts b/clients/client-databrew/commands/ListRecipesCommand.ts index e201e0322772..70834a3546e6 100644 --- a/clients/client-databrew/commands/ListRecipesCommand.ts +++ b/clients/client-databrew/commands/ListRecipesCommand.ts @@ -22,6 +22,20 @@ export interface ListRecipesCommandOutput extends ListRecipesResponse, __Metadat /** *

Lists all of the DataBrew recipes that are defined.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { DataBrewClient, ListRecipesCommand } from "@aws-sdk/client-databrew"; // ES Modules import + * // const { DataBrewClient, ListRecipesCommand } = require("@aws-sdk/client-databrew"); // CommonJS import + * const client = new DataBrewClient(config); + * const command = new ListRecipesCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListRecipesCommandInput} for command's `input` shape. + * @see {@link ListRecipesCommandOutput} for command's `response` shape. + * @see {@link DataBrewClientResolvedConfig | config} for command's `input` shape. + * */ export class ListRecipesCommand extends $Command< ListRecipesCommandInput, diff --git a/clients/client-databrew/commands/ListSchedulesCommand.ts b/clients/client-databrew/commands/ListSchedulesCommand.ts index 54a13768bb4d..4f90772b7dbd 100644 --- a/clients/client-databrew/commands/ListSchedulesCommand.ts +++ b/clients/client-databrew/commands/ListSchedulesCommand.ts @@ -22,6 +22,20 @@ export interface ListSchedulesCommandOutput extends ListSchedulesResponse, __Met /** *

Lists the DataBrew schedules that are defined.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { DataBrewClient, ListSchedulesCommand } from "@aws-sdk/client-databrew"; // ES Modules import + * // const { DataBrewClient, ListSchedulesCommand } = require("@aws-sdk/client-databrew"); // CommonJS import + * const client = new DataBrewClient(config); + * const command = new ListSchedulesCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListSchedulesCommandInput} for command's `input` shape. + * @see {@link ListSchedulesCommandOutput} for command's `response` shape. + * @see {@link DataBrewClientResolvedConfig | config} for command's `input` shape. + * */ export class ListSchedulesCommand extends $Command< ListSchedulesCommandInput, diff --git a/clients/client-databrew/commands/ListTagsForResourceCommand.ts b/clients/client-databrew/commands/ListTagsForResourceCommand.ts index cb9f77776ace..eeb0f41b74a7 100644 --- a/clients/client-databrew/commands/ListTagsForResourceCommand.ts +++ b/clients/client-databrew/commands/ListTagsForResourceCommand.ts @@ -22,6 +22,20 @@ export interface ListTagsForResourceCommandOutput extends ListTagsForResourceRes /** *

Lists all the tags for a DataBrew resource.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { DataBrewClient, ListTagsForResourceCommand } from "@aws-sdk/client-databrew"; // ES Modules import + * // const { DataBrewClient, ListTagsForResourceCommand } = require("@aws-sdk/client-databrew"); // CommonJS import + * const client = new DataBrewClient(config); + * const command = new ListTagsForResourceCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListTagsForResourceCommandInput} for command's `input` shape. + * @see {@link ListTagsForResourceCommandOutput} for command's `response` shape. + * @see {@link DataBrewClientResolvedConfig | config} for command's `input` shape. + * */ export class ListTagsForResourceCommand extends $Command< ListTagsForResourceCommandInput, diff --git a/clients/client-databrew/commands/PublishRecipeCommand.ts b/clients/client-databrew/commands/PublishRecipeCommand.ts index ff45dd287dcf..dd31edc800f1 100644 --- a/clients/client-databrew/commands/PublishRecipeCommand.ts +++ b/clients/client-databrew/commands/PublishRecipeCommand.ts @@ -22,6 +22,20 @@ export interface PublishRecipeCommandOutput extends PublishRecipeResponse, __Met /** *

Publishes a new version of a DataBrew recipe.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { DataBrewClient, PublishRecipeCommand } from "@aws-sdk/client-databrew"; // ES Modules import + * // const { DataBrewClient, PublishRecipeCommand } = require("@aws-sdk/client-databrew"); // CommonJS import + * const client = new DataBrewClient(config); + * const command = new PublishRecipeCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link PublishRecipeCommandInput} for command's `input` shape. + * @see {@link PublishRecipeCommandOutput} for command's `response` shape. + * @see {@link DataBrewClientResolvedConfig | config} for command's `input` shape. + * */ export class PublishRecipeCommand extends $Command< PublishRecipeCommandInput, diff --git a/clients/client-databrew/commands/SendProjectSessionActionCommand.ts b/clients/client-databrew/commands/SendProjectSessionActionCommand.ts index 9122152daa78..7de7fffb8355 100644 --- a/clients/client-databrew/commands/SendProjectSessionActionCommand.ts +++ b/clients/client-databrew/commands/SendProjectSessionActionCommand.ts @@ -23,6 +23,20 @@ export interface SendProjectSessionActionCommandOutput extends SendProjectSessio /** *

Performs a recipe step within an interactive DataBrew session that's currently * open.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { DataBrewClient, SendProjectSessionActionCommand } from "@aws-sdk/client-databrew"; // ES Modules import + * // const { DataBrewClient, SendProjectSessionActionCommand } = require("@aws-sdk/client-databrew"); // CommonJS import + * const client = new DataBrewClient(config); + * const command = new SendProjectSessionActionCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link SendProjectSessionActionCommandInput} for command's `input` shape. + * @see {@link SendProjectSessionActionCommandOutput} for command's `response` shape. + * @see {@link DataBrewClientResolvedConfig | config} for command's `input` shape. + * */ export class SendProjectSessionActionCommand extends $Command< SendProjectSessionActionCommandInput, diff --git a/clients/client-databrew/commands/StartJobRunCommand.ts b/clients/client-databrew/commands/StartJobRunCommand.ts index e3da68a749fd..b7b1d4ddc322 100644 --- a/clients/client-databrew/commands/StartJobRunCommand.ts +++ b/clients/client-databrew/commands/StartJobRunCommand.ts @@ -22,6 +22,20 @@ export interface StartJobRunCommandOutput extends StartJobRunResponse, __Metadat /** *

Runs a DataBrew job.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { DataBrewClient, StartJobRunCommand } from "@aws-sdk/client-databrew"; // ES Modules import + * // const { DataBrewClient, StartJobRunCommand } = require("@aws-sdk/client-databrew"); // CommonJS import + * const client = new DataBrewClient(config); + * const command = new StartJobRunCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link StartJobRunCommandInput} for command's `input` shape. + * @see {@link StartJobRunCommandOutput} for command's `response` shape. + * @see {@link DataBrewClientResolvedConfig | config} for command's `input` shape. + * */ export class StartJobRunCommand extends $Command< StartJobRunCommandInput, diff --git a/clients/client-databrew/commands/StartProjectSessionCommand.ts b/clients/client-databrew/commands/StartProjectSessionCommand.ts index ecd161efb6b9..a5d8c26294e2 100644 --- a/clients/client-databrew/commands/StartProjectSessionCommand.ts +++ b/clients/client-databrew/commands/StartProjectSessionCommand.ts @@ -23,6 +23,20 @@ export interface StartProjectSessionCommandOutput extends StartProjectSessionRes /** *

Creates an interactive session, enabling you to manipulate data in a DataBrew * project.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { DataBrewClient, StartProjectSessionCommand } from "@aws-sdk/client-databrew"; // ES Modules import + * // const { DataBrewClient, StartProjectSessionCommand } = require("@aws-sdk/client-databrew"); // CommonJS import + * const client = new DataBrewClient(config); + * const command = new StartProjectSessionCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link StartProjectSessionCommandInput} for command's `input` shape. + * @see {@link StartProjectSessionCommandOutput} for command's `response` shape. + * @see {@link DataBrewClientResolvedConfig | config} for command's `input` shape. + * */ export class StartProjectSessionCommand extends $Command< StartProjectSessionCommandInput, diff --git a/clients/client-databrew/commands/StopJobRunCommand.ts b/clients/client-databrew/commands/StopJobRunCommand.ts index 282599ccbbf3..cd4dc9444aa8 100644 --- a/clients/client-databrew/commands/StopJobRunCommand.ts +++ b/clients/client-databrew/commands/StopJobRunCommand.ts @@ -22,6 +22,20 @@ export interface StopJobRunCommandOutput extends StopJobRunResponse, __MetadataB /** *

Stops a particular run of a job.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { DataBrewClient, StopJobRunCommand } from "@aws-sdk/client-databrew"; // ES Modules import + * // const { DataBrewClient, StopJobRunCommand } = require("@aws-sdk/client-databrew"); // CommonJS import + * const client = new DataBrewClient(config); + * const command = new StopJobRunCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link StopJobRunCommandInput} for command's `input` shape. + * @see {@link StopJobRunCommandOutput} for command's `response` shape. + * @see {@link DataBrewClientResolvedConfig | config} for command's `input` shape. + * */ export class StopJobRunCommand extends $Command< StopJobRunCommandInput, diff --git a/clients/client-databrew/commands/TagResourceCommand.ts b/clients/client-databrew/commands/TagResourceCommand.ts index ba694842fbb8..395fe734c010 100644 --- a/clients/client-databrew/commands/TagResourceCommand.ts +++ b/clients/client-databrew/commands/TagResourceCommand.ts @@ -23,6 +23,20 @@ export interface TagResourceCommandOutput extends TagResourceResponse, __Metadat /** *

Adds metadata tags to a DataBrew resource, such as a dataset, project, recipe, job, or * schedule.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { DataBrewClient, TagResourceCommand } from "@aws-sdk/client-databrew"; // ES Modules import + * // const { DataBrewClient, TagResourceCommand } = require("@aws-sdk/client-databrew"); // CommonJS import + * const client = new DataBrewClient(config); + * const command = new TagResourceCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link TagResourceCommandInput} for command's `input` shape. + * @see {@link TagResourceCommandOutput} for command's `response` shape. + * @see {@link DataBrewClientResolvedConfig | config} for command's `input` shape. + * */ export class TagResourceCommand extends $Command< TagResourceCommandInput, diff --git a/clients/client-databrew/commands/UntagResourceCommand.ts b/clients/client-databrew/commands/UntagResourceCommand.ts index 573fb903314d..846c7e2425a7 100644 --- a/clients/client-databrew/commands/UntagResourceCommand.ts +++ b/clients/client-databrew/commands/UntagResourceCommand.ts @@ -22,6 +22,20 @@ export interface UntagResourceCommandOutput extends UntagResourceResponse, __Met /** *

Removes metadata tags from a DataBrew resource.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { DataBrewClient, UntagResourceCommand } from "@aws-sdk/client-databrew"; // ES Modules import + * // const { DataBrewClient, UntagResourceCommand } = require("@aws-sdk/client-databrew"); // CommonJS import + * const client = new DataBrewClient(config); + * const command = new UntagResourceCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link UntagResourceCommandInput} for command's `input` shape. + * @see {@link UntagResourceCommandOutput} for command's `response` shape. + * @see {@link DataBrewClientResolvedConfig | config} for command's `input` shape. + * */ export class UntagResourceCommand extends $Command< UntagResourceCommandInput, diff --git a/clients/client-databrew/commands/UpdateDatasetCommand.ts b/clients/client-databrew/commands/UpdateDatasetCommand.ts index 0441ef7e83a3..62207b901342 100644 --- a/clients/client-databrew/commands/UpdateDatasetCommand.ts +++ b/clients/client-databrew/commands/UpdateDatasetCommand.ts @@ -22,6 +22,20 @@ export interface UpdateDatasetCommandOutput extends UpdateDatasetResponse, __Met /** *

Modifies the definition of an existing DataBrew dataset.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { DataBrewClient, UpdateDatasetCommand } from "@aws-sdk/client-databrew"; // ES Modules import + * // const { DataBrewClient, UpdateDatasetCommand } = require("@aws-sdk/client-databrew"); // CommonJS import + * const client = new DataBrewClient(config); + * const command = new UpdateDatasetCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link UpdateDatasetCommandInput} for command's `input` shape. + * @see {@link UpdateDatasetCommandOutput} for command's `response` shape. + * @see {@link DataBrewClientResolvedConfig | config} for command's `input` shape. + * */ export class UpdateDatasetCommand extends $Command< UpdateDatasetCommandInput, diff --git a/clients/client-databrew/commands/UpdateProfileJobCommand.ts b/clients/client-databrew/commands/UpdateProfileJobCommand.ts index 32f991ead725..21563f023e76 100644 --- a/clients/client-databrew/commands/UpdateProfileJobCommand.ts +++ b/clients/client-databrew/commands/UpdateProfileJobCommand.ts @@ -22,6 +22,20 @@ export interface UpdateProfileJobCommandOutput extends UpdateProfileJobResponse, /** *

Modifies the definition of an existing profile job.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { DataBrewClient, UpdateProfileJobCommand } from "@aws-sdk/client-databrew"; // ES Modules import + * // const { DataBrewClient, UpdateProfileJobCommand } = require("@aws-sdk/client-databrew"); // CommonJS import + * const client = new DataBrewClient(config); + * const command = new UpdateProfileJobCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link UpdateProfileJobCommandInput} for command's `input` shape. + * @see {@link UpdateProfileJobCommandOutput} for command's `response` shape. + * @see {@link DataBrewClientResolvedConfig | config} for command's `input` shape. + * */ export class UpdateProfileJobCommand extends $Command< UpdateProfileJobCommandInput, diff --git a/clients/client-databrew/commands/UpdateProjectCommand.ts b/clients/client-databrew/commands/UpdateProjectCommand.ts index 46e1e6e2d840..95de518d495c 100644 --- a/clients/client-databrew/commands/UpdateProjectCommand.ts +++ b/clients/client-databrew/commands/UpdateProjectCommand.ts @@ -22,6 +22,20 @@ export interface UpdateProjectCommandOutput extends UpdateProjectResponse, __Met /** *

Modifies the definition of an existing DataBrew project.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { DataBrewClient, UpdateProjectCommand } from "@aws-sdk/client-databrew"; // ES Modules import + * // const { DataBrewClient, UpdateProjectCommand } = require("@aws-sdk/client-databrew"); // CommonJS import + * const client = new DataBrewClient(config); + * const command = new UpdateProjectCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link UpdateProjectCommandInput} for command's `input` shape. + * @see {@link UpdateProjectCommandOutput} for command's `response` shape. + * @see {@link DataBrewClientResolvedConfig | config} for command's `input` shape. + * */ export class UpdateProjectCommand extends $Command< UpdateProjectCommandInput, diff --git a/clients/client-databrew/commands/UpdateRecipeCommand.ts b/clients/client-databrew/commands/UpdateRecipeCommand.ts index ec1a91cd9749..549995108fba 100644 --- a/clients/client-databrew/commands/UpdateRecipeCommand.ts +++ b/clients/client-databrew/commands/UpdateRecipeCommand.ts @@ -23,6 +23,20 @@ export interface UpdateRecipeCommandOutput extends UpdateRecipeResponse, __Metad /** *

Modifies the definition of the LATEST_WORKING version of a DataBrew * recipe.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { DataBrewClient, UpdateRecipeCommand } from "@aws-sdk/client-databrew"; // ES Modules import + * // const { DataBrewClient, UpdateRecipeCommand } = require("@aws-sdk/client-databrew"); // CommonJS import + * const client = new DataBrewClient(config); + * const command = new UpdateRecipeCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link UpdateRecipeCommandInput} for command's `input` shape. + * @see {@link UpdateRecipeCommandOutput} for command's `response` shape. + * @see {@link DataBrewClientResolvedConfig | config} for command's `input` shape. + * */ export class UpdateRecipeCommand extends $Command< UpdateRecipeCommandInput, diff --git a/clients/client-databrew/commands/UpdateRecipeJobCommand.ts b/clients/client-databrew/commands/UpdateRecipeJobCommand.ts index 8bcb06769ee6..b34e18f32cf6 100644 --- a/clients/client-databrew/commands/UpdateRecipeJobCommand.ts +++ b/clients/client-databrew/commands/UpdateRecipeJobCommand.ts @@ -22,6 +22,20 @@ export interface UpdateRecipeJobCommandOutput extends UpdateRecipeJobResponse, _ /** *

Modifies the definition of an existing DataBrew recipe job.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { DataBrewClient, UpdateRecipeJobCommand } from "@aws-sdk/client-databrew"; // ES Modules import + * // const { DataBrewClient, UpdateRecipeJobCommand } = require("@aws-sdk/client-databrew"); // CommonJS import + * const client = new DataBrewClient(config); + * const command = new UpdateRecipeJobCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link UpdateRecipeJobCommandInput} for command's `input` shape. + * @see {@link UpdateRecipeJobCommandOutput} for command's `response` shape. + * @see {@link DataBrewClientResolvedConfig | config} for command's `input` shape. + * */ export class UpdateRecipeJobCommand extends $Command< UpdateRecipeJobCommandInput, diff --git a/clients/client-databrew/commands/UpdateScheduleCommand.ts b/clients/client-databrew/commands/UpdateScheduleCommand.ts index e6666429d2ec..cb21e7e3692f 100644 --- a/clients/client-databrew/commands/UpdateScheduleCommand.ts +++ b/clients/client-databrew/commands/UpdateScheduleCommand.ts @@ -22,6 +22,20 @@ export interface UpdateScheduleCommandOutput extends UpdateScheduleResponse, __M /** *

Modifies the definition of an existing DataBrew schedule.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { DataBrewClient, UpdateScheduleCommand } from "@aws-sdk/client-databrew"; // ES Modules import + * // const { DataBrewClient, UpdateScheduleCommand } = require("@aws-sdk/client-databrew"); // CommonJS import + * const client = new DataBrewClient(config); + * const command = new UpdateScheduleCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link UpdateScheduleCommandInput} for command's `input` shape. + * @see {@link UpdateScheduleCommandOutput} for command's `response` shape. + * @see {@link DataBrewClientResolvedConfig | config} for command's `input` shape. + * */ export class UpdateScheduleCommand extends $Command< UpdateScheduleCommandInput, diff --git a/clients/client-databrew/models/models_0.ts b/clients/client-databrew/models/models_0.ts index 5099a82663d4..59dc151e81bf 100644 --- a/clients/client-databrew/models/models_0.ts +++ b/clients/client-databrew/models/models_0.ts @@ -11,6 +11,9 @@ export interface AccessDeniedException extends __SmithyException, $MetadataBeare } export namespace AccessDeniedException { + /** + * @internal + */ export const filterSensitiveLog = (obj: AccessDeniedException): any => ({ ...obj, }); @@ -31,6 +34,9 @@ export interface BatchDeleteRecipeVersionRequest { } export namespace BatchDeleteRecipeVersionRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: BatchDeleteRecipeVersionRequest): any => ({ ...obj, }); @@ -58,6 +64,9 @@ export interface RecipeVersionErrorDetail { } export namespace RecipeVersionErrorDetail { + /** + * @internal + */ export const filterSensitiveLog = (obj: RecipeVersionErrorDetail): any => ({ ...obj, }); @@ -76,6 +85,9 @@ export interface BatchDeleteRecipeVersionResponse { } export namespace BatchDeleteRecipeVersionResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: BatchDeleteRecipeVersionResponse): any => ({ ...obj, }); @@ -91,6 +103,9 @@ export interface ConflictException extends __SmithyException, $MetadataBearer { } export namespace ConflictException { + /** + * @internal + */ export const filterSensitiveLog = (obj: ConflictException): any => ({ ...obj, }); @@ -106,6 +121,9 @@ export interface ResourceNotFoundException extends __SmithyException, $MetadataB } export namespace ResourceNotFoundException { + /** + * @internal + */ export const filterSensitiveLog = (obj: ResourceNotFoundException): any => ({ ...obj, }); @@ -121,6 +139,9 @@ export interface ValidationException extends __SmithyException, $MetadataBearer } export namespace ValidationException { + /** + * @internal + */ export const filterSensitiveLog = (obj: ValidationException): any => ({ ...obj, }); @@ -150,6 +171,9 @@ export interface CsvOptions { } export namespace CsvOptions { + /** + * @internal + */ export const filterSensitiveLog = (obj: CsvOptions): any => ({ ...obj, }); @@ -179,6 +203,9 @@ export interface ExcelOptions { } export namespace ExcelOptions { + /** + * @internal + */ export const filterSensitiveLog = (obj: ExcelOptions): any => ({ ...obj, }); @@ -197,6 +224,9 @@ export interface JsonOptions { } export namespace JsonOptions { + /** + * @internal + */ export const filterSensitiveLog = (obj: JsonOptions): any => ({ ...obj, }); @@ -223,6 +253,9 @@ export interface FormatOptions { } export namespace FormatOptions { + /** + * @internal + */ export const filterSensitiveLog = (obj: FormatOptions): any => ({ ...obj, }); @@ -245,6 +278,9 @@ export interface S3Location { } export namespace S3Location { + /** + * @internal + */ export const filterSensitiveLog = (obj: S3Location): any => ({ ...obj, }); @@ -273,6 +309,9 @@ export interface DatabaseInputDefinition { } export namespace DatabaseInputDefinition { + /** + * @internal + */ export const filterSensitiveLog = (obj: DatabaseInputDefinition): any => ({ ...obj, }); @@ -307,6 +346,9 @@ export interface DataCatalogInputDefinition { } export namespace DataCatalogInputDefinition { + /** + * @internal + */ export const filterSensitiveLog = (obj: DataCatalogInputDefinition): any => ({ ...obj, }); @@ -334,6 +376,9 @@ export interface Input { } export namespace Input { + /** + * @internal + */ export const filterSensitiveLog = (obj: Input): any => ({ ...obj, }); @@ -372,6 +417,9 @@ export interface FilesLimit { } export namespace FilesLimit { + /** + * @internal + */ export const filterSensitiveLog = (obj: FilesLimit): any => ({ ...obj, }); @@ -395,6 +443,9 @@ export interface FilterExpression { } export namespace FilterExpression { + /** + * @internal + */ export const filterSensitiveLog = (obj: FilterExpression): any => ({ ...obj, }); @@ -423,6 +474,9 @@ export interface DatetimeOptions { } export namespace DatetimeOptions { + /** + * @internal + */ export const filterSensitiveLog = (obj: DatetimeOptions): any => ({ ...obj, }); @@ -465,6 +519,9 @@ export interface DatasetParameter { } export namespace DatasetParameter { + /** + * @internal + */ export const filterSensitiveLog = (obj: DatasetParameter): any => ({ ...obj, }); @@ -491,6 +548,9 @@ export interface PathOptions { } export namespace PathOptions { + /** + * @internal + */ export const filterSensitiveLog = (obj: PathOptions): any => ({ ...obj, }); @@ -531,6 +591,9 @@ export interface CreateDatasetRequest { } export namespace CreateDatasetRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateDatasetRequest): any => ({ ...obj, }); @@ -544,6 +607,9 @@ export interface CreateDatasetResponse { } export namespace CreateDatasetResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateDatasetResponse): any => ({ ...obj, }); @@ -559,6 +625,9 @@ export interface ServiceQuotaExceededException extends __SmithyException, $Metad } export namespace ServiceQuotaExceededException { + /** + * @internal + */ export const filterSensitiveLog = (obj: ServiceQuotaExceededException): any => ({ ...obj, }); @@ -606,6 +675,9 @@ export interface JobSample { } export namespace JobSample { + /** + * @internal + */ export const filterSensitiveLog = (obj: JobSample): any => ({ ...obj, }); @@ -700,6 +772,9 @@ export interface CreateProfileJobRequest { } export namespace CreateProfileJobRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateProfileJobRequest): any => ({ ...obj, }); @@ -713,6 +788,9 @@ export interface CreateProfileJobResponse { } export namespace CreateProfileJobResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateProfileJobResponse): any => ({ ...obj, }); @@ -741,6 +819,9 @@ export interface Sample { } export namespace Sample { + /** + * @internal + */ export const filterSensitiveLog = (obj: Sample): any => ({ ...obj, }); @@ -782,6 +863,9 @@ export interface CreateProjectRequest { } export namespace CreateProjectRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateProjectRequest): any => ({ ...obj, }); @@ -795,6 +879,9 @@ export interface CreateProjectResponse { } export namespace CreateProjectResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateProjectResponse): any => ({ ...obj, }); @@ -810,6 +897,9 @@ export interface InternalServerException extends __SmithyException, $MetadataBea } export namespace InternalServerException { + /** + * @internal + */ export const filterSensitiveLog = (obj: InternalServerException): any => ({ ...obj, }); @@ -833,6 +923,9 @@ export interface RecipeAction { } export namespace RecipeAction { + /** + * @internal + */ export const filterSensitiveLog = (obj: RecipeAction): any => ({ ...obj, }); @@ -863,6 +956,9 @@ export interface ConditionExpression { } export namespace ConditionExpression { + /** + * @internal + */ export const filterSensitiveLog = (obj: ConditionExpression): any => ({ ...obj, }); @@ -888,6 +984,9 @@ export interface RecipeStep { } export namespace RecipeStep { + /** + * @internal + */ export const filterSensitiveLog = (obj: RecipeStep): any => ({ ...obj, }); @@ -918,6 +1017,9 @@ export interface CreateRecipeRequest { } export namespace CreateRecipeRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateRecipeRequest): any => ({ ...obj, }); @@ -931,6 +1033,9 @@ export interface CreateRecipeResponse { } export namespace CreateRecipeResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateRecipeResponse): any => ({ ...obj, }); @@ -969,6 +1074,9 @@ export interface CsvOutputOptions { } export namespace CsvOutputOptions { + /** + * @internal + */ export const filterSensitiveLog = (obj: CsvOutputOptions): any => ({ ...obj, }); @@ -986,6 +1094,9 @@ export interface OutputFormatOptions { } export namespace OutputFormatOptions { + /** + * @internal + */ export const filterSensitiveLog = (obj: OutputFormatOptions): any => ({ ...obj, }); @@ -1029,6 +1140,9 @@ export interface Output { } export namespace Output { + /** + * @internal + */ export const filterSensitiveLog = (obj: Output): any => ({ ...obj, }); @@ -1050,6 +1164,9 @@ export interface RecipeReference { } export namespace RecipeReference { + /** + * @internal + */ export const filterSensitiveLog = (obj: RecipeReference): any => ({ ...obj, }); @@ -1142,6 +1259,9 @@ export interface CreateRecipeJobRequest { } export namespace CreateRecipeJobRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateRecipeJobRequest): any => ({ ...obj, }); @@ -1155,6 +1275,9 @@ export interface CreateRecipeJobResponse { } export namespace CreateRecipeJobResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateRecipeJobResponse): any => ({ ...obj, }); @@ -1187,6 +1310,9 @@ export interface CreateScheduleRequest { } export namespace CreateScheduleRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateScheduleRequest): any => ({ ...obj, }); @@ -1200,6 +1326,9 @@ export interface CreateScheduleResponse { } export namespace CreateScheduleResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateScheduleResponse): any => ({ ...obj, }); @@ -1213,6 +1342,9 @@ export interface DeleteDatasetRequest { } export namespace DeleteDatasetRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteDatasetRequest): any => ({ ...obj, }); @@ -1226,6 +1358,9 @@ export interface DeleteDatasetResponse { } export namespace DeleteDatasetResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteDatasetResponse): any => ({ ...obj, }); @@ -1239,6 +1374,9 @@ export interface DeleteJobRequest { } export namespace DeleteJobRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteJobRequest): any => ({ ...obj, }); @@ -1252,6 +1390,9 @@ export interface DeleteJobResponse { } export namespace DeleteJobResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteJobResponse): any => ({ ...obj, }); @@ -1265,6 +1406,9 @@ export interface DeleteProjectRequest { } export namespace DeleteProjectRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteProjectRequest): any => ({ ...obj, }); @@ -1278,6 +1422,9 @@ export interface DeleteProjectResponse { } export namespace DeleteProjectResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteProjectResponse): any => ({ ...obj, }); @@ -1298,6 +1445,9 @@ export interface DeleteRecipeVersionRequest { } export namespace DeleteRecipeVersionRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteRecipeVersionRequest): any => ({ ...obj, }); @@ -1316,6 +1466,9 @@ export interface DeleteRecipeVersionResponse { } export namespace DeleteRecipeVersionResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteRecipeVersionResponse): any => ({ ...obj, }); @@ -1329,6 +1482,9 @@ export interface DeleteScheduleRequest { } export namespace DeleteScheduleRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteScheduleRequest): any => ({ ...obj, }); @@ -1342,6 +1498,9 @@ export interface DeleteScheduleResponse { } export namespace DeleteScheduleResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteScheduleResponse): any => ({ ...obj, }); @@ -1355,6 +1514,9 @@ export interface DescribeDatasetRequest { } export namespace DescribeDatasetRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeDatasetRequest): any => ({ ...obj, }); @@ -1431,6 +1593,9 @@ export interface DescribeDatasetResponse { } export namespace DescribeDatasetResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeDatasetResponse): any => ({ ...obj, }); @@ -1444,6 +1609,9 @@ export interface DescribeJobRequest { } export namespace DescribeJobRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeJobRequest): any => ({ ...obj, }); @@ -1586,6 +1754,9 @@ export interface DescribeJobResponse { } export namespace DescribeJobResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeJobResponse): any => ({ ...obj, }); @@ -1604,6 +1775,9 @@ export interface DescribeJobRunRequest { } export namespace DescribeJobRunRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeJobRunRequest): any => ({ ...obj, }); @@ -1701,6 +1875,9 @@ export interface DescribeJobRunResponse { } export namespace DescribeJobRunResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeJobRunResponse): any => ({ ...obj, }); @@ -1714,6 +1891,9 @@ export interface DescribeProjectRequest { } export namespace DescribeProjectRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeProjectRequest): any => ({ ...obj, }); @@ -1821,6 +2001,9 @@ export interface DescribeProjectResponse { } export namespace DescribeProjectResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeProjectResponse): any => ({ ...obj, }); @@ -1840,6 +2023,9 @@ export interface DescribeRecipeRequest { } export namespace DescribeRecipeRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeRecipeRequest): any => ({ ...obj, }); @@ -1914,6 +2100,9 @@ export interface DescribeRecipeResponse { } export namespace DescribeRecipeResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeRecipeResponse): any => ({ ...obj, }); @@ -1927,6 +2116,9 @@ export interface DescribeScheduleRequest { } export namespace DescribeScheduleRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeScheduleRequest): any => ({ ...obj, }); @@ -1982,6 +2174,9 @@ export interface DescribeScheduleResponse { } export namespace DescribeScheduleResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeScheduleResponse): any => ({ ...obj, }); @@ -2000,6 +2195,9 @@ export interface ListDatasetsRequest { } export namespace ListDatasetsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListDatasetsRequest): any => ({ ...obj, }); @@ -2078,6 +2276,9 @@ export interface Dataset { } export namespace Dataset { + /** + * @internal + */ export const filterSensitiveLog = (obj: Dataset): any => ({ ...obj, }); @@ -2097,6 +2298,9 @@ export interface ListDatasetsResponse { } export namespace ListDatasetsResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListDatasetsResponse): any => ({ ...obj, }); @@ -2120,6 +2324,9 @@ export interface ListJobRunsRequest { } export namespace ListJobRunsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListJobRunsRequest): any => ({ ...obj, }); @@ -2210,6 +2417,9 @@ export interface JobRun { } export namespace JobRun { + /** + * @internal + */ export const filterSensitiveLog = (obj: JobRun): any => ({ ...obj, }); @@ -2229,6 +2439,9 @@ export interface ListJobRunsResponse { } export namespace ListJobRunsResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListJobRunsResponse): any => ({ ...obj, }); @@ -2261,6 +2474,9 @@ export interface ListJobsRequest { } export namespace ListJobsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListJobsRequest): any => ({ ...obj, }); @@ -2407,6 +2623,9 @@ export interface Job { } export namespace Job { + /** + * @internal + */ export const filterSensitiveLog = (obj: Job): any => ({ ...obj, }); @@ -2426,6 +2645,9 @@ export interface ListJobsResponse { } export namespace ListJobsResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListJobsResponse): any => ({ ...obj, }); @@ -2444,6 +2666,9 @@ export interface ListProjectsRequest { } export namespace ListProjectsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListProjectsRequest): any => ({ ...obj, }); @@ -2527,6 +2752,9 @@ export interface Project { } export namespace Project { + /** + * @internal + */ export const filterSensitiveLog = (obj: Project): any => ({ ...obj, }); @@ -2546,6 +2774,9 @@ export interface ListProjectsResponse { } export namespace ListProjectsResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListProjectsResponse): any => ({ ...obj, }); @@ -2574,6 +2805,9 @@ export interface ListRecipesRequest { } export namespace ListRecipesRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListRecipesRequest): any => ({ ...obj, }); @@ -2667,6 +2901,9 @@ export interface Recipe { } export namespace Recipe { + /** + * @internal + */ export const filterSensitiveLog = (obj: Recipe): any => ({ ...obj, }); @@ -2686,6 +2923,9 @@ export interface ListRecipesResponse { } export namespace ListRecipesResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListRecipesResponse): any => ({ ...obj, }); @@ -2709,6 +2949,9 @@ export interface ListRecipeVersionsRequest { } export namespace ListRecipeVersionsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListRecipeVersionsRequest): any => ({ ...obj, }); @@ -2728,6 +2971,9 @@ export interface ListRecipeVersionsResponse { } export namespace ListRecipeVersionsResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListRecipeVersionsResponse): any => ({ ...obj, }); @@ -2751,6 +2997,9 @@ export interface ListSchedulesRequest { } export namespace ListSchedulesRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListSchedulesRequest): any => ({ ...obj, }); @@ -2814,6 +3063,9 @@ export interface Schedule { } export namespace Schedule { + /** + * @internal + */ export const filterSensitiveLog = (obj: Schedule): any => ({ ...obj, }); @@ -2833,6 +3085,9 @@ export interface ListSchedulesResponse { } export namespace ListSchedulesResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListSchedulesResponse): any => ({ ...obj, }); @@ -2847,6 +3102,9 @@ export interface ListTagsForResourceRequest { } export namespace ListTagsForResourceRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListTagsForResourceRequest): any => ({ ...obj, }); @@ -2860,6 +3118,9 @@ export interface ListTagsForResourceResponse { } export namespace ListTagsForResourceResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListTagsForResourceResponse): any => ({ ...obj, }); @@ -2878,6 +3139,9 @@ export interface PublishRecipeRequest { } export namespace PublishRecipeRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: PublishRecipeRequest): any => ({ ...obj, }); @@ -2891,6 +3155,9 @@ export interface PublishRecipeResponse { } export namespace PublishRecipeResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: PublishRecipeResponse): any => ({ ...obj, }); @@ -2919,6 +3186,9 @@ export interface ViewFrame { } export namespace ViewFrame { + /** + * @internal + */ export const filterSensitiveLog = (obj: ViewFrame): any => ({ ...obj, }); @@ -2960,6 +3230,9 @@ export interface SendProjectSessionActionRequest { } export namespace SendProjectSessionActionRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: SendProjectSessionActionRequest): any => ({ ...obj, }); @@ -2983,6 +3256,9 @@ export interface SendProjectSessionActionResponse { } export namespace SendProjectSessionActionResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: SendProjectSessionActionResponse): any => ({ ...obj, }); @@ -2996,6 +3272,9 @@ export interface StartJobRunRequest { } export namespace StartJobRunRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: StartJobRunRequest): any => ({ ...obj, }); @@ -3009,6 +3288,9 @@ export interface StartJobRunResponse { } export namespace StartJobRunResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: StartJobRunResponse): any => ({ ...obj, }); @@ -3028,6 +3310,9 @@ export interface StartProjectSessionRequest { } export namespace StartProjectSessionRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: StartProjectSessionRequest): any => ({ ...obj, }); @@ -3046,6 +3331,9 @@ export interface StartProjectSessionResponse { } export namespace StartProjectSessionResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: StartProjectSessionResponse): any => ({ ...obj, }); @@ -3064,6 +3352,9 @@ export interface StopJobRunRequest { } export namespace StopJobRunRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: StopJobRunRequest): any => ({ ...obj, }); @@ -3077,6 +3368,9 @@ export interface StopJobRunResponse { } export namespace StopJobRunResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: StopJobRunResponse): any => ({ ...obj, }); @@ -3097,6 +3391,9 @@ export interface TagResourceRequest { } export namespace TagResourceRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: TagResourceRequest): any => ({ ...obj, }); @@ -3105,6 +3402,9 @@ export namespace TagResourceRequest { export interface TagResourceResponse {} export namespace TagResourceResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: TagResourceResponse): any => ({ ...obj, }); @@ -3124,6 +3424,9 @@ export interface UntagResourceRequest { } export namespace UntagResourceRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: UntagResourceRequest): any => ({ ...obj, }); @@ -3132,6 +3435,9 @@ export namespace UntagResourceRequest { export interface UntagResourceResponse {} export namespace UntagResourceResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: UntagResourceResponse): any => ({ ...obj, }); @@ -3166,6 +3472,9 @@ export interface UpdateDatasetRequest { } export namespace UpdateDatasetRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateDatasetRequest): any => ({ ...obj, }); @@ -3179,6 +3488,9 @@ export interface UpdateDatasetResponse { } export namespace UpdateDatasetResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateDatasetResponse): any => ({ ...obj, }); @@ -3258,6 +3570,9 @@ export interface UpdateProfileJobRequest { } export namespace UpdateProfileJobRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateProfileJobRequest): any => ({ ...obj, }); @@ -3271,6 +3586,9 @@ export interface UpdateProfileJobResponse { } export namespace UpdateProfileJobResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateProfileJobResponse): any => ({ ...obj, }); @@ -3295,6 +3613,9 @@ export interface UpdateProjectRequest { } export namespace UpdateProjectRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateProjectRequest): any => ({ ...obj, }); @@ -3313,6 +3634,9 @@ export interface UpdateProjectResponse { } export namespace UpdateProjectResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateProjectResponse): any => ({ ...obj, }); @@ -3337,6 +3661,9 @@ export interface UpdateRecipeRequest { } export namespace UpdateRecipeRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateRecipeRequest): any => ({ ...obj, }); @@ -3350,6 +3677,9 @@ export interface UpdateRecipeResponse { } export namespace UpdateRecipeResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateRecipeResponse): any => ({ ...obj, }); @@ -3420,6 +3750,9 @@ export interface UpdateRecipeJobRequest { } export namespace UpdateRecipeJobRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateRecipeJobRequest): any => ({ ...obj, }); @@ -3433,6 +3766,9 @@ export interface UpdateRecipeJobResponse { } export namespace UpdateRecipeJobResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateRecipeJobResponse): any => ({ ...obj, }); @@ -3459,6 +3795,9 @@ export interface UpdateScheduleRequest { } export namespace UpdateScheduleRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateScheduleRequest): any => ({ ...obj, }); @@ -3472,6 +3811,9 @@ export interface UpdateScheduleResponse { } export namespace UpdateScheduleResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateScheduleResponse): any => ({ ...obj, }); diff --git a/clients/client-dataexchange/commands/CancelJobCommand.ts b/clients/client-dataexchange/commands/CancelJobCommand.ts index ebc501ae8bc3..028b67c4803e 100644 --- a/clients/client-dataexchange/commands/CancelJobCommand.ts +++ b/clients/client-dataexchange/commands/CancelJobCommand.ts @@ -22,6 +22,20 @@ export interface CancelJobCommandOutput extends __MetadataBearer {} /** *

This operation cancels a job. Jobs can be cancelled only when they are in the WAITING state.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { DataExchangeClient, CancelJobCommand } from "@aws-sdk/client-dataexchange"; // ES Modules import + * // const { DataExchangeClient, CancelJobCommand } = require("@aws-sdk/client-dataexchange"); // CommonJS import + * const client = new DataExchangeClient(config); + * const command = new CancelJobCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CancelJobCommandInput} for command's `input` shape. + * @see {@link CancelJobCommandOutput} for command's `response` shape. + * @see {@link DataExchangeClientResolvedConfig | config} for command's `input` shape. + * */ export class CancelJobCommand extends $Command< CancelJobCommandInput, diff --git a/clients/client-dataexchange/commands/CreateDataSetCommand.ts b/clients/client-dataexchange/commands/CreateDataSetCommand.ts index aa60790579e6..c860a5db76ac 100644 --- a/clients/client-dataexchange/commands/CreateDataSetCommand.ts +++ b/clients/client-dataexchange/commands/CreateDataSetCommand.ts @@ -22,6 +22,20 @@ export interface CreateDataSetCommandOutput extends CreateDataSetResponse, __Met /** *

This operation creates a data set.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { DataExchangeClient, CreateDataSetCommand } from "@aws-sdk/client-dataexchange"; // ES Modules import + * // const { DataExchangeClient, CreateDataSetCommand } = require("@aws-sdk/client-dataexchange"); // CommonJS import + * const client = new DataExchangeClient(config); + * const command = new CreateDataSetCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreateDataSetCommandInput} for command's `input` shape. + * @see {@link CreateDataSetCommandOutput} for command's `response` shape. + * @see {@link DataExchangeClientResolvedConfig | config} for command's `input` shape. + * */ export class CreateDataSetCommand extends $Command< CreateDataSetCommandInput, diff --git a/clients/client-dataexchange/commands/CreateJobCommand.ts b/clients/client-dataexchange/commands/CreateJobCommand.ts index bcddd592b184..cddd81e62cd8 100644 --- a/clients/client-dataexchange/commands/CreateJobCommand.ts +++ b/clients/client-dataexchange/commands/CreateJobCommand.ts @@ -22,6 +22,20 @@ export interface CreateJobCommandOutput extends CreateJobResponse, __MetadataBea /** *

This operation creates a job.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { DataExchangeClient, CreateJobCommand } from "@aws-sdk/client-dataexchange"; // ES Modules import + * // const { DataExchangeClient, CreateJobCommand } = require("@aws-sdk/client-dataexchange"); // CommonJS import + * const client = new DataExchangeClient(config); + * const command = new CreateJobCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreateJobCommandInput} for command's `input` shape. + * @see {@link CreateJobCommandOutput} for command's `response` shape. + * @see {@link DataExchangeClientResolvedConfig | config} for command's `input` shape. + * */ export class CreateJobCommand extends $Command< CreateJobCommandInput, diff --git a/clients/client-dataexchange/commands/CreateRevisionCommand.ts b/clients/client-dataexchange/commands/CreateRevisionCommand.ts index 0f5387567054..8f2daae466f6 100644 --- a/clients/client-dataexchange/commands/CreateRevisionCommand.ts +++ b/clients/client-dataexchange/commands/CreateRevisionCommand.ts @@ -22,6 +22,20 @@ export interface CreateRevisionCommandOutput extends CreateRevisionResponse, __M /** *

This operation creates a revision for a data set.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { DataExchangeClient, CreateRevisionCommand } from "@aws-sdk/client-dataexchange"; // ES Modules import + * // const { DataExchangeClient, CreateRevisionCommand } = require("@aws-sdk/client-dataexchange"); // CommonJS import + * const client = new DataExchangeClient(config); + * const command = new CreateRevisionCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreateRevisionCommandInput} for command's `input` shape. + * @see {@link CreateRevisionCommandOutput} for command's `response` shape. + * @see {@link DataExchangeClientResolvedConfig | config} for command's `input` shape. + * */ export class CreateRevisionCommand extends $Command< CreateRevisionCommandInput, diff --git a/clients/client-dataexchange/commands/DeleteAssetCommand.ts b/clients/client-dataexchange/commands/DeleteAssetCommand.ts index 8c94a0f44018..9b766e5dbe36 100644 --- a/clients/client-dataexchange/commands/DeleteAssetCommand.ts +++ b/clients/client-dataexchange/commands/DeleteAssetCommand.ts @@ -22,6 +22,20 @@ export interface DeleteAssetCommandOutput extends __MetadataBearer {} /** *

This operation deletes an asset.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { DataExchangeClient, DeleteAssetCommand } from "@aws-sdk/client-dataexchange"; // ES Modules import + * // const { DataExchangeClient, DeleteAssetCommand } = require("@aws-sdk/client-dataexchange"); // CommonJS import + * const client = new DataExchangeClient(config); + * const command = new DeleteAssetCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteAssetCommandInput} for command's `input` shape. + * @see {@link DeleteAssetCommandOutput} for command's `response` shape. + * @see {@link DataExchangeClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteAssetCommand extends $Command< DeleteAssetCommandInput, diff --git a/clients/client-dataexchange/commands/DeleteDataSetCommand.ts b/clients/client-dataexchange/commands/DeleteDataSetCommand.ts index 890fb29b8da3..ec5a5df13376 100644 --- a/clients/client-dataexchange/commands/DeleteDataSetCommand.ts +++ b/clients/client-dataexchange/commands/DeleteDataSetCommand.ts @@ -22,6 +22,20 @@ export interface DeleteDataSetCommandOutput extends __MetadataBearer {} /** *

This operation deletes a data set.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { DataExchangeClient, DeleteDataSetCommand } from "@aws-sdk/client-dataexchange"; // ES Modules import + * // const { DataExchangeClient, DeleteDataSetCommand } = require("@aws-sdk/client-dataexchange"); // CommonJS import + * const client = new DataExchangeClient(config); + * const command = new DeleteDataSetCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteDataSetCommandInput} for command's `input` shape. + * @see {@link DeleteDataSetCommandOutput} for command's `response` shape. + * @see {@link DataExchangeClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteDataSetCommand extends $Command< DeleteDataSetCommandInput, diff --git a/clients/client-dataexchange/commands/DeleteRevisionCommand.ts b/clients/client-dataexchange/commands/DeleteRevisionCommand.ts index 54231bbe62a3..9010a614250f 100644 --- a/clients/client-dataexchange/commands/DeleteRevisionCommand.ts +++ b/clients/client-dataexchange/commands/DeleteRevisionCommand.ts @@ -22,6 +22,20 @@ export interface DeleteRevisionCommandOutput extends __MetadataBearer {} /** *

This operation deletes a revision.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { DataExchangeClient, DeleteRevisionCommand } from "@aws-sdk/client-dataexchange"; // ES Modules import + * // const { DataExchangeClient, DeleteRevisionCommand } = require("@aws-sdk/client-dataexchange"); // CommonJS import + * const client = new DataExchangeClient(config); + * const command = new DeleteRevisionCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteRevisionCommandInput} for command's `input` shape. + * @see {@link DeleteRevisionCommandOutput} for command's `response` shape. + * @see {@link DataExchangeClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteRevisionCommand extends $Command< DeleteRevisionCommandInput, diff --git a/clients/client-dataexchange/commands/GetAssetCommand.ts b/clients/client-dataexchange/commands/GetAssetCommand.ts index 193452356469..dcdf80baa039 100644 --- a/clients/client-dataexchange/commands/GetAssetCommand.ts +++ b/clients/client-dataexchange/commands/GetAssetCommand.ts @@ -22,6 +22,20 @@ export interface GetAssetCommandOutput extends GetAssetResponse, __MetadataBeare /** *

This operation returns information about an asset.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { DataExchangeClient, GetAssetCommand } from "@aws-sdk/client-dataexchange"; // ES Modules import + * // const { DataExchangeClient, GetAssetCommand } = require("@aws-sdk/client-dataexchange"); // CommonJS import + * const client = new DataExchangeClient(config); + * const command = new GetAssetCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetAssetCommandInput} for command's `input` shape. + * @see {@link GetAssetCommandOutput} for command's `response` shape. + * @see {@link DataExchangeClientResolvedConfig | config} for command's `input` shape. + * */ export class GetAssetCommand extends $Command< GetAssetCommandInput, diff --git a/clients/client-dataexchange/commands/GetDataSetCommand.ts b/clients/client-dataexchange/commands/GetDataSetCommand.ts index 006309cb6450..82867e84c058 100644 --- a/clients/client-dataexchange/commands/GetDataSetCommand.ts +++ b/clients/client-dataexchange/commands/GetDataSetCommand.ts @@ -22,6 +22,20 @@ export interface GetDataSetCommandOutput extends GetDataSetResponse, __MetadataB /** *

This operation returns information about a data set.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { DataExchangeClient, GetDataSetCommand } from "@aws-sdk/client-dataexchange"; // ES Modules import + * // const { DataExchangeClient, GetDataSetCommand } = require("@aws-sdk/client-dataexchange"); // CommonJS import + * const client = new DataExchangeClient(config); + * const command = new GetDataSetCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetDataSetCommandInput} for command's `input` shape. + * @see {@link GetDataSetCommandOutput} for command's `response` shape. + * @see {@link DataExchangeClientResolvedConfig | config} for command's `input` shape. + * */ export class GetDataSetCommand extends $Command< GetDataSetCommandInput, diff --git a/clients/client-dataexchange/commands/GetJobCommand.ts b/clients/client-dataexchange/commands/GetJobCommand.ts index 37d6b885ff1c..1a071c6e86ed 100644 --- a/clients/client-dataexchange/commands/GetJobCommand.ts +++ b/clients/client-dataexchange/commands/GetJobCommand.ts @@ -19,6 +19,20 @@ export interface GetJobCommandOutput extends GetJobResponse, __MetadataBearer {} /** *

This operation returns information about a job.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { DataExchangeClient, GetJobCommand } from "@aws-sdk/client-dataexchange"; // ES Modules import + * // const { DataExchangeClient, GetJobCommand } = require("@aws-sdk/client-dataexchange"); // CommonJS import + * const client = new DataExchangeClient(config); + * const command = new GetJobCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetJobCommandInput} for command's `input` shape. + * @see {@link GetJobCommandOutput} for command's `response` shape. + * @see {@link DataExchangeClientResolvedConfig | config} for command's `input` shape. + * */ export class GetJobCommand extends $Command { // Start section: command_properties diff --git a/clients/client-dataexchange/commands/GetRevisionCommand.ts b/clients/client-dataexchange/commands/GetRevisionCommand.ts index c75292de1860..ec4951292663 100644 --- a/clients/client-dataexchange/commands/GetRevisionCommand.ts +++ b/clients/client-dataexchange/commands/GetRevisionCommand.ts @@ -22,6 +22,20 @@ export interface GetRevisionCommandOutput extends GetRevisionResponse, __Metadat /** *

This operation returns information about a revision.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { DataExchangeClient, GetRevisionCommand } from "@aws-sdk/client-dataexchange"; // ES Modules import + * // const { DataExchangeClient, GetRevisionCommand } = require("@aws-sdk/client-dataexchange"); // CommonJS import + * const client = new DataExchangeClient(config); + * const command = new GetRevisionCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetRevisionCommandInput} for command's `input` shape. + * @see {@link GetRevisionCommandOutput} for command's `response` shape. + * @see {@link DataExchangeClientResolvedConfig | config} for command's `input` shape. + * */ export class GetRevisionCommand extends $Command< GetRevisionCommandInput, diff --git a/clients/client-dataexchange/commands/ListDataSetRevisionsCommand.ts b/clients/client-dataexchange/commands/ListDataSetRevisionsCommand.ts index 39bbbc0dc69f..65a876a8eb1c 100644 --- a/clients/client-dataexchange/commands/ListDataSetRevisionsCommand.ts +++ b/clients/client-dataexchange/commands/ListDataSetRevisionsCommand.ts @@ -22,6 +22,20 @@ export interface ListDataSetRevisionsCommandOutput extends ListDataSetRevisionsR /** *

This operation lists a data set's revisions sorted by CreatedAt in descending order.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { DataExchangeClient, ListDataSetRevisionsCommand } from "@aws-sdk/client-dataexchange"; // ES Modules import + * // const { DataExchangeClient, ListDataSetRevisionsCommand } = require("@aws-sdk/client-dataexchange"); // CommonJS import + * const client = new DataExchangeClient(config); + * const command = new ListDataSetRevisionsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListDataSetRevisionsCommandInput} for command's `input` shape. + * @see {@link ListDataSetRevisionsCommandOutput} for command's `response` shape. + * @see {@link DataExchangeClientResolvedConfig | config} for command's `input` shape. + * */ export class ListDataSetRevisionsCommand extends $Command< ListDataSetRevisionsCommandInput, diff --git a/clients/client-dataexchange/commands/ListDataSetsCommand.ts b/clients/client-dataexchange/commands/ListDataSetsCommand.ts index 9e28af3f8e64..a23cc548e630 100644 --- a/clients/client-dataexchange/commands/ListDataSetsCommand.ts +++ b/clients/client-dataexchange/commands/ListDataSetsCommand.ts @@ -22,6 +22,20 @@ export interface ListDataSetsCommandOutput extends ListDataSetsResponse, __Metad /** *

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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { DataExchangeClient, ListDataSetsCommand } from "@aws-sdk/client-dataexchange"; // ES Modules import + * // const { DataExchangeClient, ListDataSetsCommand } = require("@aws-sdk/client-dataexchange"); // CommonJS import + * const client = new DataExchangeClient(config); + * const command = new ListDataSetsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListDataSetsCommandInput} for command's `input` shape. + * @see {@link ListDataSetsCommandOutput} for command's `response` shape. + * @see {@link DataExchangeClientResolvedConfig | config} for command's `input` shape. + * */ export class ListDataSetsCommand extends $Command< ListDataSetsCommandInput, diff --git a/clients/client-dataexchange/commands/ListJobsCommand.ts b/clients/client-dataexchange/commands/ListJobsCommand.ts index e670d4ccc1db..e73f6c35c18c 100644 --- a/clients/client-dataexchange/commands/ListJobsCommand.ts +++ b/clients/client-dataexchange/commands/ListJobsCommand.ts @@ -22,6 +22,20 @@ export interface ListJobsCommandOutput extends ListJobsResponse, __MetadataBeare /** *

This operation lists your jobs sorted by CreatedAt in descending order.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { DataExchangeClient, ListJobsCommand } from "@aws-sdk/client-dataexchange"; // ES Modules import + * // const { DataExchangeClient, ListJobsCommand } = require("@aws-sdk/client-dataexchange"); // CommonJS import + * const client = new DataExchangeClient(config); + * const command = new ListJobsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListJobsCommandInput} for command's `input` shape. + * @see {@link ListJobsCommandOutput} for command's `response` shape. + * @see {@link DataExchangeClientResolvedConfig | config} for command's `input` shape. + * */ export class ListJobsCommand extends $Command< ListJobsCommandInput, diff --git a/clients/client-dataexchange/commands/ListRevisionAssetsCommand.ts b/clients/client-dataexchange/commands/ListRevisionAssetsCommand.ts index 787ec4a8128c..a3931c7adf2c 100644 --- a/clients/client-dataexchange/commands/ListRevisionAssetsCommand.ts +++ b/clients/client-dataexchange/commands/ListRevisionAssetsCommand.ts @@ -22,6 +22,20 @@ export interface ListRevisionAssetsCommandOutput extends ListRevisionAssetsRespo /** *

This operation lists a revision's assets sorted alphabetically in descending order.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { DataExchangeClient, ListRevisionAssetsCommand } from "@aws-sdk/client-dataexchange"; // ES Modules import + * // const { DataExchangeClient, ListRevisionAssetsCommand } = require("@aws-sdk/client-dataexchange"); // CommonJS import + * const client = new DataExchangeClient(config); + * const command = new ListRevisionAssetsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListRevisionAssetsCommandInput} for command's `input` shape. + * @see {@link ListRevisionAssetsCommandOutput} for command's `response` shape. + * @see {@link DataExchangeClientResolvedConfig | config} for command's `input` shape. + * */ export class ListRevisionAssetsCommand extends $Command< ListRevisionAssetsCommandInput, diff --git a/clients/client-dataexchange/commands/ListTagsForResourceCommand.ts b/clients/client-dataexchange/commands/ListTagsForResourceCommand.ts index b2db999ccac8..70a9dcdc747d 100644 --- a/clients/client-dataexchange/commands/ListTagsForResourceCommand.ts +++ b/clients/client-dataexchange/commands/ListTagsForResourceCommand.ts @@ -22,6 +22,20 @@ export interface ListTagsForResourceCommandOutput extends ListTagsForResourceRes /** *

This operation lists the tags on the resource.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { DataExchangeClient, ListTagsForResourceCommand } from "@aws-sdk/client-dataexchange"; // ES Modules import + * // const { DataExchangeClient, ListTagsForResourceCommand } = require("@aws-sdk/client-dataexchange"); // CommonJS import + * const client = new DataExchangeClient(config); + * const command = new ListTagsForResourceCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListTagsForResourceCommandInput} for command's `input` shape. + * @see {@link ListTagsForResourceCommandOutput} for command's `response` shape. + * @see {@link DataExchangeClientResolvedConfig | config} for command's `input` shape. + * */ export class ListTagsForResourceCommand extends $Command< ListTagsForResourceCommandInput, diff --git a/clients/client-dataexchange/commands/StartJobCommand.ts b/clients/client-dataexchange/commands/StartJobCommand.ts index 3fb5da7d9fc2..63bde0b57783 100644 --- a/clients/client-dataexchange/commands/StartJobCommand.ts +++ b/clients/client-dataexchange/commands/StartJobCommand.ts @@ -22,6 +22,20 @@ export interface StartJobCommandOutput extends StartJobResponse, __MetadataBeare /** *

This operation starts a job.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { DataExchangeClient, StartJobCommand } from "@aws-sdk/client-dataexchange"; // ES Modules import + * // const { DataExchangeClient, StartJobCommand } = require("@aws-sdk/client-dataexchange"); // CommonJS import + * const client = new DataExchangeClient(config); + * const command = new StartJobCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link StartJobCommandInput} for command's `input` shape. + * @see {@link StartJobCommandOutput} for command's `response` shape. + * @see {@link DataExchangeClientResolvedConfig | config} for command's `input` shape. + * */ export class StartJobCommand extends $Command< StartJobCommandInput, diff --git a/clients/client-dataexchange/commands/TagResourceCommand.ts b/clients/client-dataexchange/commands/TagResourceCommand.ts index 382139de18f0..376e8c1fd587 100644 --- a/clients/client-dataexchange/commands/TagResourceCommand.ts +++ b/clients/client-dataexchange/commands/TagResourceCommand.ts @@ -22,6 +22,20 @@ export interface TagResourceCommandOutput extends __MetadataBearer {} /** *

This operation tags a resource.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { DataExchangeClient, TagResourceCommand } from "@aws-sdk/client-dataexchange"; // ES Modules import + * // const { DataExchangeClient, TagResourceCommand } = require("@aws-sdk/client-dataexchange"); // CommonJS import + * const client = new DataExchangeClient(config); + * const command = new TagResourceCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link TagResourceCommandInput} for command's `input` shape. + * @see {@link TagResourceCommandOutput} for command's `response` shape. + * @see {@link DataExchangeClientResolvedConfig | config} for command's `input` shape. + * */ export class TagResourceCommand extends $Command< TagResourceCommandInput, diff --git a/clients/client-dataexchange/commands/UntagResourceCommand.ts b/clients/client-dataexchange/commands/UntagResourceCommand.ts index 0f28181f0cb8..2d51c26ba6ba 100644 --- a/clients/client-dataexchange/commands/UntagResourceCommand.ts +++ b/clients/client-dataexchange/commands/UntagResourceCommand.ts @@ -22,6 +22,20 @@ export interface UntagResourceCommandOutput extends __MetadataBearer {} /** *

This operation removes one or more tags from a resource.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { DataExchangeClient, UntagResourceCommand } from "@aws-sdk/client-dataexchange"; // ES Modules import + * // const { DataExchangeClient, UntagResourceCommand } = require("@aws-sdk/client-dataexchange"); // CommonJS import + * const client = new DataExchangeClient(config); + * const command = new UntagResourceCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link UntagResourceCommandInput} for command's `input` shape. + * @see {@link UntagResourceCommandOutput} for command's `response` shape. + * @see {@link DataExchangeClientResolvedConfig | config} for command's `input` shape. + * */ export class UntagResourceCommand extends $Command< UntagResourceCommandInput, diff --git a/clients/client-dataexchange/commands/UpdateAssetCommand.ts b/clients/client-dataexchange/commands/UpdateAssetCommand.ts index 96d45454f347..a71767e9bf0e 100644 --- a/clients/client-dataexchange/commands/UpdateAssetCommand.ts +++ b/clients/client-dataexchange/commands/UpdateAssetCommand.ts @@ -22,6 +22,20 @@ export interface UpdateAssetCommandOutput extends UpdateAssetResponse, __Metadat /** *

This operation updates an asset.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { DataExchangeClient, UpdateAssetCommand } from "@aws-sdk/client-dataexchange"; // ES Modules import + * // const { DataExchangeClient, UpdateAssetCommand } = require("@aws-sdk/client-dataexchange"); // CommonJS import + * const client = new DataExchangeClient(config); + * const command = new UpdateAssetCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link UpdateAssetCommandInput} for command's `input` shape. + * @see {@link UpdateAssetCommandOutput} for command's `response` shape. + * @see {@link DataExchangeClientResolvedConfig | config} for command's `input` shape. + * */ export class UpdateAssetCommand extends $Command< UpdateAssetCommandInput, diff --git a/clients/client-dataexchange/commands/UpdateDataSetCommand.ts b/clients/client-dataexchange/commands/UpdateDataSetCommand.ts index 0eee8776d1ee..53c5af9108d6 100644 --- a/clients/client-dataexchange/commands/UpdateDataSetCommand.ts +++ b/clients/client-dataexchange/commands/UpdateDataSetCommand.ts @@ -22,6 +22,20 @@ export interface UpdateDataSetCommandOutput extends UpdateDataSetResponse, __Met /** *

This operation updates a data set.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { DataExchangeClient, UpdateDataSetCommand } from "@aws-sdk/client-dataexchange"; // ES Modules import + * // const { DataExchangeClient, UpdateDataSetCommand } = require("@aws-sdk/client-dataexchange"); // CommonJS import + * const client = new DataExchangeClient(config); + * const command = new UpdateDataSetCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link UpdateDataSetCommandInput} for command's `input` shape. + * @see {@link UpdateDataSetCommandOutput} for command's `response` shape. + * @see {@link DataExchangeClientResolvedConfig | config} for command's `input` shape. + * */ export class UpdateDataSetCommand extends $Command< UpdateDataSetCommandInput, diff --git a/clients/client-dataexchange/commands/UpdateRevisionCommand.ts b/clients/client-dataexchange/commands/UpdateRevisionCommand.ts index 18194f82ce74..f12fca5f6125 100644 --- a/clients/client-dataexchange/commands/UpdateRevisionCommand.ts +++ b/clients/client-dataexchange/commands/UpdateRevisionCommand.ts @@ -22,6 +22,20 @@ export interface UpdateRevisionCommandOutput extends UpdateRevisionResponse, __M /** *

This operation updates a revision.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { DataExchangeClient, UpdateRevisionCommand } from "@aws-sdk/client-dataexchange"; // ES Modules import + * // const { DataExchangeClient, UpdateRevisionCommand } = require("@aws-sdk/client-dataexchange"); // CommonJS import + * const client = new DataExchangeClient(config); + * const command = new UpdateRevisionCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link UpdateRevisionCommandInput} for command's `input` shape. + * @see {@link UpdateRevisionCommandOutput} for command's `response` shape. + * @see {@link DataExchangeClientResolvedConfig | config} for command's `input` shape. + * */ export class UpdateRevisionCommand extends $Command< UpdateRevisionCommandInput, diff --git a/clients/client-dataexchange/models/models_0.ts b/clients/client-dataexchange/models/models_0.ts index 95925ebd8726..7e5e1bf873d8 100644 --- a/clients/client-dataexchange/models/models_0.ts +++ b/clients/client-dataexchange/models/models_0.ts @@ -14,6 +14,9 @@ export interface AccessDeniedException extends __SmithyException, $MetadataBeare } export namespace AccessDeniedException { + /** + * @internal + */ export const filterSensitiveLog = (obj: AccessDeniedException): any => ({ ...obj, }); @@ -40,6 +43,9 @@ export interface AssetDestinationEntry { } export namespace AssetDestinationEntry { + /** + * @internal + */ export const filterSensitiveLog = (obj: AssetDestinationEntry): any => ({ ...obj, }); @@ -56,6 +62,9 @@ export interface S3SnapshotAsset { } export namespace S3SnapshotAsset { + /** + * @internal + */ export const filterSensitiveLog = (obj: S3SnapshotAsset): any => ({ ...obj, }); @@ -69,6 +78,9 @@ export interface AssetDetails { } export namespace AssetDetails { + /** + * @internal + */ export const filterSensitiveLog = (obj: AssetDetails): any => ({ ...obj, }); @@ -134,6 +146,9 @@ export interface AssetEntry { } export namespace AssetEntry { + /** + * @internal + */ export const filterSensitiveLog = (obj: AssetEntry): any => ({ ...obj, }); @@ -155,6 +170,9 @@ export interface AssetSourceEntry { } export namespace AssetSourceEntry { + /** + * @internal + */ export const filterSensitiveLog = (obj: AssetSourceEntry): any => ({ ...obj, }); @@ -168,6 +186,9 @@ export interface CancelJobRequest { } export namespace CancelJobRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: CancelJobRequest): any => ({ ...obj, }); @@ -203,6 +224,9 @@ export interface ConflictException extends __SmithyException, $MetadataBearer { } export namespace ConflictException { + /** + * @internal + */ export const filterSensitiveLog = (obj: ConflictException): any => ({ ...obj, }); @@ -221,6 +245,9 @@ export interface InternalServerException extends __SmithyException, $MetadataBea } export namespace InternalServerException { + /** + * @internal + */ export const filterSensitiveLog = (obj: InternalServerException): any => ({ ...obj, }); @@ -249,6 +276,9 @@ export interface ResourceNotFoundException extends __SmithyException, $MetadataB } export namespace ResourceNotFoundException { + /** + * @internal + */ export const filterSensitiveLog = (obj: ResourceNotFoundException): any => ({ ...obj, }); @@ -267,6 +297,9 @@ export interface ThrottlingException extends __SmithyException, $MetadataBearer } export namespace ThrottlingException { + /** + * @internal + */ export const filterSensitiveLog = (obj: ThrottlingException): any => ({ ...obj, }); @@ -285,6 +318,9 @@ export interface ValidationException extends __SmithyException, $MetadataBearer } export namespace ValidationException { + /** + * @internal + */ export const filterSensitiveLog = (obj: ValidationException): any => ({ ...obj, }); @@ -326,6 +362,9 @@ export interface CreateDataSetRequest { } export namespace CreateDataSetRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateDataSetRequest): any => ({ ...obj, }); @@ -341,6 +380,9 @@ export interface OriginDetails { } export namespace OriginDetails { + /** + * @internal + */ export const filterSensitiveLog = (obj: OriginDetails): any => ({ ...obj, }); @@ -404,6 +446,9 @@ export interface CreateDataSetResponse { } export namespace CreateDataSetResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateDataSetResponse): any => ({ ...obj, }); @@ -447,6 +492,9 @@ export interface ServiceLimitExceededException extends __SmithyException, $Metad } export namespace ServiceLimitExceededException { + /** + * @internal + */ export const filterSensitiveLog = (obj: ServiceLimitExceededException): any => ({ ...obj, }); @@ -473,6 +521,9 @@ export interface ExportServerSideEncryption { } export namespace ExportServerSideEncryption { + /** + * @internal + */ export const filterSensitiveLog = (obj: ExportServerSideEncryption): any => ({ ...obj, }); @@ -504,6 +555,9 @@ export interface ExportAssetsToS3RequestDetails { } export namespace ExportAssetsToS3RequestDetails { + /** + * @internal + */ export const filterSensitiveLog = (obj: ExportAssetsToS3RequestDetails): any => ({ ...obj, }); @@ -530,6 +584,9 @@ export interface ExportAssetToSignedUrlRequestDetails { } export namespace ExportAssetToSignedUrlRequestDetails { + /** + * @internal + */ export const filterSensitiveLog = (obj: ExportAssetToSignedUrlRequestDetails): any => ({ ...obj, }); @@ -556,6 +613,9 @@ export interface RevisionDestinationEntry { } export namespace RevisionDestinationEntry { + /** + * @internal + */ export const filterSensitiveLog = (obj: RevisionDestinationEntry): any => ({ ...obj, }); @@ -582,6 +642,9 @@ export interface ExportRevisionsToS3RequestDetails { } export namespace ExportRevisionsToS3RequestDetails { + /** + * @internal + */ export const filterSensitiveLog = (obj: ExportRevisionsToS3RequestDetails): any => ({ ...obj, }); @@ -613,6 +676,9 @@ export interface ImportAssetFromSignedUrlRequestDetails { } export namespace ImportAssetFromSignedUrlRequestDetails { + /** + * @internal + */ export const filterSensitiveLog = (obj: ImportAssetFromSignedUrlRequestDetails): any => ({ ...obj, }); @@ -639,6 +705,9 @@ export interface ImportAssetsFromS3RequestDetails { } export namespace ImportAssetsFromS3RequestDetails { + /** + * @internal + */ export const filterSensitiveLog = (obj: ImportAssetsFromS3RequestDetails): any => ({ ...obj, }); @@ -675,6 +744,9 @@ export interface RequestDetails { } export namespace RequestDetails { + /** + * @internal + */ export const filterSensitiveLog = (obj: RequestDetails): any => ({ ...obj, }); @@ -704,6 +776,9 @@ export interface CreateJobRequest { } export namespace CreateJobRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateJobRequest): any => ({ ...obj, }); @@ -735,6 +810,9 @@ export interface ExportAssetsToS3ResponseDetails { } export namespace ExportAssetsToS3ResponseDetails { + /** + * @internal + */ export const filterSensitiveLog = (obj: ExportAssetsToS3ResponseDetails): any => ({ ...obj, }); @@ -771,6 +849,9 @@ export interface ExportAssetToSignedUrlResponseDetails { } export namespace ExportAssetToSignedUrlResponseDetails { + /** + * @internal + */ export const filterSensitiveLog = (obj: ExportAssetToSignedUrlResponseDetails): any => ({ ...obj, }); @@ -797,6 +878,9 @@ export interface ExportRevisionsToS3ResponseDetails { } export namespace ExportRevisionsToS3ResponseDetails { + /** + * @internal + */ export const filterSensitiveLog = (obj: ExportRevisionsToS3ResponseDetails): any => ({ ...obj, }); @@ -838,6 +922,9 @@ export interface ImportAssetFromSignedUrlResponseDetails { } export namespace ImportAssetFromSignedUrlResponseDetails { + /** + * @internal + */ export const filterSensitiveLog = (obj: ImportAssetFromSignedUrlResponseDetails): any => ({ ...obj, }); @@ -864,6 +951,9 @@ export interface ImportAssetsFromS3ResponseDetails { } export namespace ImportAssetsFromS3ResponseDetails { + /** + * @internal + */ export const filterSensitiveLog = (obj: ImportAssetsFromS3ResponseDetails): any => ({ ...obj, }); @@ -900,6 +990,9 @@ export interface ResponseDetails { } export namespace ResponseDetails { + /** + * @internal + */ export const filterSensitiveLog = (obj: ResponseDetails): any => ({ ...obj, }); @@ -913,6 +1006,9 @@ export interface ImportAssetFromSignedUrlJobErrorDetails { } export namespace ImportAssetFromSignedUrlJobErrorDetails { + /** + * @internal + */ export const filterSensitiveLog = (obj: ImportAssetFromSignedUrlJobErrorDetails): any => ({ ...obj, }); @@ -927,6 +1023,9 @@ export interface Details { } export namespace Details { + /** + * @internal + */ export const filterSensitiveLog = (obj: Details): any => ({ ...obj, }); @@ -979,6 +1078,9 @@ export interface JobError { } export namespace JobError { + /** + * @internal + */ export const filterSensitiveLog = (obj: JobError): any => ({ ...obj, }); @@ -1036,6 +1138,9 @@ export interface CreateJobResponse { } export namespace CreateJobResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateJobResponse): any => ({ ...obj, }); @@ -1062,6 +1167,9 @@ export interface CreateRevisionRequest { } export namespace CreateRevisionRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateRevisionRequest): any => ({ ...obj, }); @@ -1115,6 +1223,9 @@ export interface CreateRevisionResponse { } export namespace CreateRevisionResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateRevisionResponse): any => ({ ...obj, }); @@ -1138,6 +1249,9 @@ export interface DeleteAssetRequest { } export namespace DeleteAssetRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteAssetRequest): any => ({ ...obj, }); @@ -1151,6 +1265,9 @@ export interface DeleteDataSetRequest { } export namespace DeleteDataSetRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteDataSetRequest): any => ({ ...obj, }); @@ -1169,6 +1286,9 @@ export interface DeleteRevisionRequest { } export namespace DeleteRevisionRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteRevisionRequest): any => ({ ...obj, }); @@ -1192,6 +1312,9 @@ export interface GetAssetRequest { } export namespace GetAssetRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetAssetRequest): any => ({ ...obj, }); @@ -1250,6 +1373,9 @@ export interface GetAssetResponse { } export namespace GetAssetResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetAssetResponse): any => ({ ...obj, }); @@ -1263,6 +1389,9 @@ export interface GetDataSetRequest { } export namespace GetDataSetRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetDataSetRequest): any => ({ ...obj, }); @@ -1326,6 +1455,9 @@ export interface GetDataSetResponse { } export namespace GetDataSetResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetDataSetResponse): any => ({ ...obj, }); @@ -1339,6 +1471,9 @@ export interface GetJobRequest { } export namespace GetJobRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetJobRequest): any => ({ ...obj, }); @@ -1387,6 +1522,9 @@ export interface GetJobResponse { } export namespace GetJobResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetJobResponse): any => ({ ...obj, }); @@ -1405,6 +1543,9 @@ export interface GetRevisionRequest { } export namespace GetRevisionRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetRevisionRequest): any => ({ ...obj, }); @@ -1458,6 +1599,9 @@ export interface GetRevisionResponse { } export namespace GetRevisionResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetRevisionResponse): any => ({ ...obj, }); @@ -1481,6 +1625,9 @@ export interface ListDataSetRevisionsRequest { } export namespace ListDataSetRevisionsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListDataSetRevisionsRequest): any => ({ ...obj, }); @@ -1532,6 +1679,9 @@ export interface RevisionEntry { } export namespace RevisionEntry { + /** + * @internal + */ export const filterSensitiveLog = (obj: RevisionEntry): any => ({ ...obj, }); @@ -1550,6 +1700,9 @@ export interface ListDataSetRevisionsResponse { } export namespace ListDataSetRevisionsResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListDataSetRevisionsResponse): any => ({ ...obj, }); @@ -1573,6 +1726,9 @@ export interface ListDataSetsRequest { } export namespace ListDataSetsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListDataSetsRequest): any => ({ ...obj, }); @@ -1634,6 +1790,9 @@ export interface DataSetEntry { } export namespace DataSetEntry { + /** + * @internal + */ export const filterSensitiveLog = (obj: DataSetEntry): any => ({ ...obj, }); @@ -1652,6 +1811,9 @@ export interface ListDataSetsResponse { } export namespace ListDataSetsResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListDataSetsResponse): any => ({ ...obj, }); @@ -1680,6 +1842,9 @@ export interface ListJobsRequest { } export namespace ListJobsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListJobsRequest): any => ({ ...obj, }); @@ -1731,6 +1896,9 @@ export interface JobEntry { } export namespace JobEntry { + /** + * @internal + */ export const filterSensitiveLog = (obj: JobEntry): any => ({ ...obj, }); @@ -1749,6 +1917,9 @@ export interface ListJobsResponse { } export namespace ListJobsResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListJobsResponse): any => ({ ...obj, }); @@ -1777,6 +1948,9 @@ export interface ListRevisionAssetsRequest { } export namespace ListRevisionAssetsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListRevisionAssetsRequest): any => ({ ...obj, }); @@ -1795,6 +1969,9 @@ export interface ListRevisionAssetsResponse { } export namespace ListRevisionAssetsResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListRevisionAssetsResponse): any => ({ ...obj, }); @@ -1808,6 +1985,9 @@ export interface ListTagsForResourceRequest { } export namespace ListTagsForResourceRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListTagsForResourceRequest): any => ({ ...obj, }); @@ -1821,6 +2001,9 @@ export interface ListTagsForResourceResponse { } export namespace ListTagsForResourceResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListTagsForResourceResponse): any => ({ ...obj, }); @@ -1834,6 +2017,9 @@ export interface StartJobRequest { } export namespace StartJobRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: StartJobRequest): any => ({ ...obj, }); @@ -1842,6 +2028,9 @@ export namespace StartJobRequest { export interface StartJobResponse {} export namespace StartJobResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: StartJobResponse): any => ({ ...obj, }); @@ -1863,6 +2052,9 @@ export interface TagResourceRequest { } export namespace TagResourceRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: TagResourceRequest): any => ({ ...obj, }); @@ -1881,6 +2073,9 @@ export interface UntagResourceRequest { } export namespace UntagResourceRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: UntagResourceRequest): any => ({ ...obj, }); @@ -1912,6 +2107,9 @@ export interface UpdateAssetRequest { } export namespace UpdateAssetRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateAssetRequest): any => ({ ...obj, }); @@ -1970,6 +2168,9 @@ export interface UpdateAssetResponse { } export namespace UpdateAssetResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateAssetResponse): any => ({ ...obj, }); @@ -1996,6 +2197,9 @@ export interface UpdateDataSetRequest { } export namespace UpdateDataSetRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateDataSetRequest): any => ({ ...obj, }); @@ -2054,6 +2258,9 @@ export interface UpdateDataSetResponse { } export namespace UpdateDataSetResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateDataSetResponse): any => ({ ...obj, }); @@ -2085,6 +2292,9 @@ export interface UpdateRevisionRequest { } export namespace UpdateRevisionRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateRevisionRequest): any => ({ ...obj, }); @@ -2133,6 +2343,9 @@ export interface UpdateRevisionResponse { } export namespace UpdateRevisionResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateRevisionResponse): any => ({ ...obj, }); diff --git a/clients/client-datasync/commands/CancelTaskExecutionCommand.ts b/clients/client-datasync/commands/CancelTaskExecutionCommand.ts index 664d5103554b..65c2511f0039 100644 --- a/clients/client-datasync/commands/CancelTaskExecutionCommand.ts +++ b/clients/client-datasync/commands/CancelTaskExecutionCommand.ts @@ -29,6 +29,20 @@ export interface CancelTaskExecutionCommandOutput extends CancelTaskExecutionRes * and consistent. This applies to other unexpected failures that interrupt a task execution. In * all of these cases, AWS DataSync successfully complete the transfer when you start the next * task execution.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { DataSyncClient, CancelTaskExecutionCommand } from "@aws-sdk/client-datasync"; // ES Modules import + * // const { DataSyncClient, CancelTaskExecutionCommand } = require("@aws-sdk/client-datasync"); // CommonJS import + * const client = new DataSyncClient(config); + * const command = new CancelTaskExecutionCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CancelTaskExecutionCommandInput} for command's `input` shape. + * @see {@link CancelTaskExecutionCommandOutput} for command's `response` shape. + * @see {@link DataSyncClientResolvedConfig | config} for command's `input` shape. + * */ export class CancelTaskExecutionCommand extends $Command< CancelTaskExecutionCommandInput, diff --git a/clients/client-datasync/commands/CreateAgentCommand.ts b/clients/client-datasync/commands/CreateAgentCommand.ts index 69d4cfbd479f..83d51a1bbe14 100644 --- a/clients/client-datasync/commands/CreateAgentCommand.ts +++ b/clients/client-datasync/commands/CreateAgentCommand.ts @@ -36,6 +36,20 @@ export interface CreateAgentCommandOutput extends CreateAgentResponse, __Metadat *

Agents are automatically updated by AWS on a regular basis, using a mechanism that * ensures minimal interruption to your tasks.

*

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { DataSyncClient, CreateAgentCommand } from "@aws-sdk/client-datasync"; // ES Modules import + * // const { DataSyncClient, CreateAgentCommand } = require("@aws-sdk/client-datasync"); // CommonJS import + * const client = new DataSyncClient(config); + * const command = new CreateAgentCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreateAgentCommandInput} for command's `input` shape. + * @see {@link CreateAgentCommandOutput} for command's `response` shape. + * @see {@link DataSyncClientResolvedConfig | config} for command's `input` shape. + * */ export class CreateAgentCommand extends $Command< CreateAgentCommandInput, diff --git a/clients/client-datasync/commands/CreateLocationEfsCommand.ts b/clients/client-datasync/commands/CreateLocationEfsCommand.ts index b78d21770b87..740d3f2f9c9a 100644 --- a/clients/client-datasync/commands/CreateLocationEfsCommand.ts +++ b/clients/client-datasync/commands/CreateLocationEfsCommand.ts @@ -22,6 +22,20 @@ export interface CreateLocationEfsCommandOutput extends CreateLocationEfsRespons /** *

Creates an endpoint for an Amazon EFS file system.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { DataSyncClient, CreateLocationEfsCommand } from "@aws-sdk/client-datasync"; // ES Modules import + * // const { DataSyncClient, CreateLocationEfsCommand } = require("@aws-sdk/client-datasync"); // CommonJS import + * const client = new DataSyncClient(config); + * const command = new CreateLocationEfsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreateLocationEfsCommandInput} for command's `input` shape. + * @see {@link CreateLocationEfsCommandOutput} for command's `response` shape. + * @see {@link DataSyncClientResolvedConfig | config} for command's `input` shape. + * */ export class CreateLocationEfsCommand extends $Command< CreateLocationEfsCommandInput, diff --git a/clients/client-datasync/commands/CreateLocationFsxWindowsCommand.ts b/clients/client-datasync/commands/CreateLocationFsxWindowsCommand.ts index 901c10ea60b8..52367bd4f45b 100644 --- a/clients/client-datasync/commands/CreateLocationFsxWindowsCommand.ts +++ b/clients/client-datasync/commands/CreateLocationFsxWindowsCommand.ts @@ -22,6 +22,20 @@ export interface CreateLocationFsxWindowsCommandOutput extends CreateLocationFsx /** *

Creates an endpoint for an Amazon FSx for Windows File Server file system.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { DataSyncClient, CreateLocationFsxWindowsCommand } from "@aws-sdk/client-datasync"; // ES Modules import + * // const { DataSyncClient, CreateLocationFsxWindowsCommand } = require("@aws-sdk/client-datasync"); // CommonJS import + * const client = new DataSyncClient(config); + * const command = new CreateLocationFsxWindowsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreateLocationFsxWindowsCommandInput} for command's `input` shape. + * @see {@link CreateLocationFsxWindowsCommandOutput} for command's `response` shape. + * @see {@link DataSyncClientResolvedConfig | config} for command's `input` shape. + * */ export class CreateLocationFsxWindowsCommand extends $Command< CreateLocationFsxWindowsCommandInput, diff --git a/clients/client-datasync/commands/CreateLocationNfsCommand.ts b/clients/client-datasync/commands/CreateLocationNfsCommand.ts index 013344ad40ed..46b84908ab1c 100644 --- a/clients/client-datasync/commands/CreateLocationNfsCommand.ts +++ b/clients/client-datasync/commands/CreateLocationNfsCommand.ts @@ -23,6 +23,20 @@ export interface CreateLocationNfsCommandOutput extends CreateLocationNfsRespons /** *

Defines a file system on a Network File System (NFS) server that can be read from or * written to.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { DataSyncClient, CreateLocationNfsCommand } from "@aws-sdk/client-datasync"; // ES Modules import + * // const { DataSyncClient, CreateLocationNfsCommand } = require("@aws-sdk/client-datasync"); // CommonJS import + * const client = new DataSyncClient(config); + * const command = new CreateLocationNfsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreateLocationNfsCommandInput} for command's `input` shape. + * @see {@link CreateLocationNfsCommandOutput} for command's `response` shape. + * @see {@link DataSyncClientResolvedConfig | config} for command's `input` shape. + * */ export class CreateLocationNfsCommand extends $Command< CreateLocationNfsCommandInput, diff --git a/clients/client-datasync/commands/CreateLocationObjectStorageCommand.ts b/clients/client-datasync/commands/CreateLocationObjectStorageCommand.ts index 1946096c8e46..e5a40298500f 100644 --- a/clients/client-datasync/commands/CreateLocationObjectStorageCommand.ts +++ b/clients/client-datasync/commands/CreateLocationObjectStorageCommand.ts @@ -25,6 +25,20 @@ export interface CreateLocationObjectStorageCommandOutput /** *

Creates an endpoint for a self-managed object storage bucket. For more information * about self-managed object storage locations, see create-object-location.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { DataSyncClient, CreateLocationObjectStorageCommand } from "@aws-sdk/client-datasync"; // ES Modules import + * // const { DataSyncClient, CreateLocationObjectStorageCommand } = require("@aws-sdk/client-datasync"); // CommonJS import + * const client = new DataSyncClient(config); + * const command = new CreateLocationObjectStorageCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreateLocationObjectStorageCommandInput} for command's `input` shape. + * @see {@link CreateLocationObjectStorageCommandOutput} for command's `response` shape. + * @see {@link DataSyncClientResolvedConfig | config} for command's `input` shape. + * */ export class CreateLocationObjectStorageCommand extends $Command< CreateLocationObjectStorageCommandInput, diff --git a/clients/client-datasync/commands/CreateLocationS3Command.ts b/clients/client-datasync/commands/CreateLocationS3Command.ts index 526018b1687a..f8f02ba76c22 100644 --- a/clients/client-datasync/commands/CreateLocationS3Command.ts +++ b/clients/client-datasync/commands/CreateLocationS3Command.ts @@ -28,6 +28,20 @@ export interface CreateLocationS3CommandOutput extends CreateLocationS3Response, * more information, see * https://docs.aws.amazon.com/datasync/latest/userguide/create-locations-cli.html#create-location-s3-cli * in the AWS DataSync User Guide.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { DataSyncClient, CreateLocationS3Command } from "@aws-sdk/client-datasync"; // ES Modules import + * // const { DataSyncClient, CreateLocationS3Command } = require("@aws-sdk/client-datasync"); // CommonJS import + * const client = new DataSyncClient(config); + * const command = new CreateLocationS3Command(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreateLocationS3CommandInput} for command's `input` shape. + * @see {@link CreateLocationS3CommandOutput} for command's `response` shape. + * @see {@link DataSyncClientResolvedConfig | config} for command's `input` shape. + * */ export class CreateLocationS3Command extends $Command< CreateLocationS3CommandInput, diff --git a/clients/client-datasync/commands/CreateLocationSmbCommand.ts b/clients/client-datasync/commands/CreateLocationSmbCommand.ts index 1557bf5d647c..00fe360f5f5a 100644 --- a/clients/client-datasync/commands/CreateLocationSmbCommand.ts +++ b/clients/client-datasync/commands/CreateLocationSmbCommand.ts @@ -23,6 +23,20 @@ export interface CreateLocationSmbCommandOutput extends CreateLocationSmbRespons /** *

Defines a file system on a Server Message Block (SMB) server that can be read from or * written to.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { DataSyncClient, CreateLocationSmbCommand } from "@aws-sdk/client-datasync"; // ES Modules import + * // const { DataSyncClient, CreateLocationSmbCommand } = require("@aws-sdk/client-datasync"); // CommonJS import + * const client = new DataSyncClient(config); + * const command = new CreateLocationSmbCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreateLocationSmbCommandInput} for command's `input` shape. + * @see {@link CreateLocationSmbCommandOutput} for command's `response` shape. + * @see {@link DataSyncClientResolvedConfig | config} for command's `input` shape. + * */ export class CreateLocationSmbCommand extends $Command< CreateLocationSmbCommandInput, diff --git a/clients/client-datasync/commands/CreateTaskCommand.ts b/clients/client-datasync/commands/CreateTaskCommand.ts index 2c828a49a36f..016d149b8b84 100644 --- a/clients/client-datasync/commands/CreateTaskCommand.ts +++ b/clients/client-datasync/commands/CreateTaskCommand.ts @@ -40,6 +40,20 @@ export interface CreateTaskCommandOutput extends CreateTaskResponse, __MetadataB * see Data Transfer pricing. *

* + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { DataSyncClient, CreateTaskCommand } from "@aws-sdk/client-datasync"; // ES Modules import + * // const { DataSyncClient, CreateTaskCommand } = require("@aws-sdk/client-datasync"); // CommonJS import + * const client = new DataSyncClient(config); + * const command = new CreateTaskCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreateTaskCommandInput} for command's `input` shape. + * @see {@link CreateTaskCommandOutput} for command's `response` shape. + * @see {@link DataSyncClientResolvedConfig | config} for command's `input` shape. + * */ export class CreateTaskCommand extends $Command< CreateTaskCommandInput, diff --git a/clients/client-datasync/commands/DeleteAgentCommand.ts b/clients/client-datasync/commands/DeleteAgentCommand.ts index af56bad17cf0..b83a071a33cc 100644 --- a/clients/client-datasync/commands/DeleteAgentCommand.ts +++ b/clients/client-datasync/commands/DeleteAgentCommand.ts @@ -25,6 +25,20 @@ export interface DeleteAgentCommandOutput extends DeleteAgentResponse, __Metadat * of the agent in your request. The operation disassociates the agent from your AWS account. * However, it doesn't delete the agent virtual machine (VM) from your on-premises * environment.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { DataSyncClient, DeleteAgentCommand } from "@aws-sdk/client-datasync"; // ES Modules import + * // const { DataSyncClient, DeleteAgentCommand } = require("@aws-sdk/client-datasync"); // CommonJS import + * const client = new DataSyncClient(config); + * const command = new DeleteAgentCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteAgentCommandInput} for command's `input` shape. + * @see {@link DeleteAgentCommandOutput} for command's `response` shape. + * @see {@link DataSyncClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteAgentCommand extends $Command< DeleteAgentCommandInput, diff --git a/clients/client-datasync/commands/DeleteLocationCommand.ts b/clients/client-datasync/commands/DeleteLocationCommand.ts index 9cc21392e7f7..dee9be7631ef 100644 --- a/clients/client-datasync/commands/DeleteLocationCommand.ts +++ b/clients/client-datasync/commands/DeleteLocationCommand.ts @@ -22,6 +22,20 @@ export interface DeleteLocationCommandOutput extends DeleteLocationResponse, __M /** *

Deletes the configuration of a location used by AWS DataSync.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { DataSyncClient, DeleteLocationCommand } from "@aws-sdk/client-datasync"; // ES Modules import + * // const { DataSyncClient, DeleteLocationCommand } = require("@aws-sdk/client-datasync"); // CommonJS import + * const client = new DataSyncClient(config); + * const command = new DeleteLocationCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteLocationCommandInput} for command's `input` shape. + * @see {@link DeleteLocationCommandOutput} for command's `response` shape. + * @see {@link DataSyncClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteLocationCommand extends $Command< DeleteLocationCommandInput, diff --git a/clients/client-datasync/commands/DeleteTaskCommand.ts b/clients/client-datasync/commands/DeleteTaskCommand.ts index 0a15649eccf2..6f64179e2b55 100644 --- a/clients/client-datasync/commands/DeleteTaskCommand.ts +++ b/clients/client-datasync/commands/DeleteTaskCommand.ts @@ -22,6 +22,20 @@ export interface DeleteTaskCommandOutput extends DeleteTaskResponse, __MetadataB /** *

Deletes a task.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { DataSyncClient, DeleteTaskCommand } from "@aws-sdk/client-datasync"; // ES Modules import + * // const { DataSyncClient, DeleteTaskCommand } = require("@aws-sdk/client-datasync"); // CommonJS import + * const client = new DataSyncClient(config); + * const command = new DeleteTaskCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteTaskCommandInput} for command's `input` shape. + * @see {@link DeleteTaskCommandOutput} for command's `response` shape. + * @see {@link DataSyncClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteTaskCommand extends $Command< DeleteTaskCommandInput, diff --git a/clients/client-datasync/commands/DescribeAgentCommand.ts b/clients/client-datasync/commands/DescribeAgentCommand.ts index c65e1ac9c4e8..47969fabe71e 100644 --- a/clients/client-datasync/commands/DescribeAgentCommand.ts +++ b/clients/client-datasync/commands/DescribeAgentCommand.ts @@ -24,6 +24,20 @@ export interface DescribeAgentCommandOutput extends DescribeAgentResponse, __Met *

Returns metadata such as the name, the network interfaces, and the status (that is, * whether the agent is running or not) for an agent. To specify which agent to describe, use the * Amazon Resource Name (ARN) of the agent in your request.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { DataSyncClient, DescribeAgentCommand } from "@aws-sdk/client-datasync"; // ES Modules import + * // const { DataSyncClient, DescribeAgentCommand } = require("@aws-sdk/client-datasync"); // CommonJS import + * const client = new DataSyncClient(config); + * const command = new DescribeAgentCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeAgentCommandInput} for command's `input` shape. + * @see {@link DescribeAgentCommandOutput} for command's `response` shape. + * @see {@link DataSyncClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeAgentCommand extends $Command< DescribeAgentCommandInput, diff --git a/clients/client-datasync/commands/DescribeLocationEfsCommand.ts b/clients/client-datasync/commands/DescribeLocationEfsCommand.ts index be4f56b63a22..74d88d7fa7d5 100644 --- a/clients/client-datasync/commands/DescribeLocationEfsCommand.ts +++ b/clients/client-datasync/commands/DescribeLocationEfsCommand.ts @@ -22,6 +22,20 @@ export interface DescribeLocationEfsCommandOutput extends DescribeLocationEfsRes /** *

Returns metadata, such as the path information about an Amazon EFS location.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { DataSyncClient, DescribeLocationEfsCommand } from "@aws-sdk/client-datasync"; // ES Modules import + * // const { DataSyncClient, DescribeLocationEfsCommand } = require("@aws-sdk/client-datasync"); // CommonJS import + * const client = new DataSyncClient(config); + * const command = new DescribeLocationEfsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeLocationEfsCommandInput} for command's `input` shape. + * @see {@link DescribeLocationEfsCommandOutput} for command's `response` shape. + * @see {@link DataSyncClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeLocationEfsCommand extends $Command< DescribeLocationEfsCommandInput, diff --git a/clients/client-datasync/commands/DescribeLocationFsxWindowsCommand.ts b/clients/client-datasync/commands/DescribeLocationFsxWindowsCommand.ts index 8db10d0f9d82..7eacd3a9bb2f 100644 --- a/clients/client-datasync/commands/DescribeLocationFsxWindowsCommand.ts +++ b/clients/client-datasync/commands/DescribeLocationFsxWindowsCommand.ts @@ -23,6 +23,20 @@ export interface DescribeLocationFsxWindowsCommandOutput extends DescribeLocatio /** *

Returns metadata, such as the path information about an Amazon FSx for Windows File Server * location.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { DataSyncClient, DescribeLocationFsxWindowsCommand } from "@aws-sdk/client-datasync"; // ES Modules import + * // const { DataSyncClient, DescribeLocationFsxWindowsCommand } = require("@aws-sdk/client-datasync"); // CommonJS import + * const client = new DataSyncClient(config); + * const command = new DescribeLocationFsxWindowsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeLocationFsxWindowsCommandInput} for command's `input` shape. + * @see {@link DescribeLocationFsxWindowsCommandOutput} for command's `response` shape. + * @see {@link DataSyncClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeLocationFsxWindowsCommand extends $Command< DescribeLocationFsxWindowsCommandInput, diff --git a/clients/client-datasync/commands/DescribeLocationNfsCommand.ts b/clients/client-datasync/commands/DescribeLocationNfsCommand.ts index 4b2c666c30df..8fc06ccbbe81 100644 --- a/clients/client-datasync/commands/DescribeLocationNfsCommand.ts +++ b/clients/client-datasync/commands/DescribeLocationNfsCommand.ts @@ -22,6 +22,20 @@ export interface DescribeLocationNfsCommandOutput extends DescribeLocationNfsRes /** *

Returns metadata, such as the path information, about an NFS location.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { DataSyncClient, DescribeLocationNfsCommand } from "@aws-sdk/client-datasync"; // ES Modules import + * // const { DataSyncClient, DescribeLocationNfsCommand } = require("@aws-sdk/client-datasync"); // CommonJS import + * const client = new DataSyncClient(config); + * const command = new DescribeLocationNfsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeLocationNfsCommandInput} for command's `input` shape. + * @see {@link DescribeLocationNfsCommandOutput} for command's `response` shape. + * @see {@link DataSyncClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeLocationNfsCommand extends $Command< DescribeLocationNfsCommandInput, diff --git a/clients/client-datasync/commands/DescribeLocationObjectStorageCommand.ts b/clients/client-datasync/commands/DescribeLocationObjectStorageCommand.ts index 755544510c8c..d0bc58f52f3e 100644 --- a/clients/client-datasync/commands/DescribeLocationObjectStorageCommand.ts +++ b/clients/client-datasync/commands/DescribeLocationObjectStorageCommand.ts @@ -25,6 +25,20 @@ export interface DescribeLocationObjectStorageCommandOutput /** *

Returns metadata about a self-managed object storage server location. For more information * about self-managed object storage locations, see create-object-location.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { DataSyncClient, DescribeLocationObjectStorageCommand } from "@aws-sdk/client-datasync"; // ES Modules import + * // const { DataSyncClient, DescribeLocationObjectStorageCommand } = require("@aws-sdk/client-datasync"); // CommonJS import + * const client = new DataSyncClient(config); + * const command = new DescribeLocationObjectStorageCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeLocationObjectStorageCommandInput} for command's `input` shape. + * @see {@link DescribeLocationObjectStorageCommandOutput} for command's `response` shape. + * @see {@link DataSyncClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeLocationObjectStorageCommand extends $Command< DescribeLocationObjectStorageCommandInput, diff --git a/clients/client-datasync/commands/DescribeLocationS3Command.ts b/clients/client-datasync/commands/DescribeLocationS3Command.ts index 729e9639419f..c34a3b8863e7 100644 --- a/clients/client-datasync/commands/DescribeLocationS3Command.ts +++ b/clients/client-datasync/commands/DescribeLocationS3Command.ts @@ -22,6 +22,20 @@ export interface DescribeLocationS3CommandOutput extends DescribeLocationS3Respo /** *

Returns metadata, such as bucket name, about an Amazon S3 bucket location.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { DataSyncClient, DescribeLocationS3Command } from "@aws-sdk/client-datasync"; // ES Modules import + * // const { DataSyncClient, DescribeLocationS3Command } = require("@aws-sdk/client-datasync"); // CommonJS import + * const client = new DataSyncClient(config); + * const command = new DescribeLocationS3Command(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeLocationS3CommandInput} for command's `input` shape. + * @see {@link DescribeLocationS3CommandOutput} for command's `response` shape. + * @see {@link DataSyncClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeLocationS3Command extends $Command< DescribeLocationS3CommandInput, diff --git a/clients/client-datasync/commands/DescribeLocationSmbCommand.ts b/clients/client-datasync/commands/DescribeLocationSmbCommand.ts index 4bb82be6d161..2dc098a3747d 100644 --- a/clients/client-datasync/commands/DescribeLocationSmbCommand.ts +++ b/clients/client-datasync/commands/DescribeLocationSmbCommand.ts @@ -22,6 +22,20 @@ export interface DescribeLocationSmbCommandOutput extends DescribeLocationSmbRes /** *

Returns metadata, such as the path and user information about an SMB location.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { DataSyncClient, DescribeLocationSmbCommand } from "@aws-sdk/client-datasync"; // ES Modules import + * // const { DataSyncClient, DescribeLocationSmbCommand } = require("@aws-sdk/client-datasync"); // CommonJS import + * const client = new DataSyncClient(config); + * const command = new DescribeLocationSmbCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeLocationSmbCommandInput} for command's `input` shape. + * @see {@link DescribeLocationSmbCommandOutput} for command's `response` shape. + * @see {@link DataSyncClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeLocationSmbCommand extends $Command< DescribeLocationSmbCommandInput, diff --git a/clients/client-datasync/commands/DescribeTaskCommand.ts b/clients/client-datasync/commands/DescribeTaskCommand.ts index c796884275ca..a290396d6be4 100644 --- a/clients/client-datasync/commands/DescribeTaskCommand.ts +++ b/clients/client-datasync/commands/DescribeTaskCommand.ts @@ -22,6 +22,20 @@ export interface DescribeTaskCommandOutput extends DescribeTaskResponse, __Metad /** *

Returns metadata about a task.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { DataSyncClient, DescribeTaskCommand } from "@aws-sdk/client-datasync"; // ES Modules import + * // const { DataSyncClient, DescribeTaskCommand } = require("@aws-sdk/client-datasync"); // CommonJS import + * const client = new DataSyncClient(config); + * const command = new DescribeTaskCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeTaskCommandInput} for command's `input` shape. + * @see {@link DescribeTaskCommandOutput} for command's `response` shape. + * @see {@link DataSyncClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeTaskCommand extends $Command< DescribeTaskCommandInput, diff --git a/clients/client-datasync/commands/DescribeTaskExecutionCommand.ts b/clients/client-datasync/commands/DescribeTaskExecutionCommand.ts index 2bba3d525575..4c43c5bfb224 100644 --- a/clients/client-datasync/commands/DescribeTaskExecutionCommand.ts +++ b/clients/client-datasync/commands/DescribeTaskExecutionCommand.ts @@ -22,6 +22,20 @@ export interface DescribeTaskExecutionCommandOutput extends DescribeTaskExecutio /** *

Returns detailed metadata about a task that is being executed.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { DataSyncClient, DescribeTaskExecutionCommand } from "@aws-sdk/client-datasync"; // ES Modules import + * // const { DataSyncClient, DescribeTaskExecutionCommand } = require("@aws-sdk/client-datasync"); // CommonJS import + * const client = new DataSyncClient(config); + * const command = new DescribeTaskExecutionCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeTaskExecutionCommandInput} for command's `input` shape. + * @see {@link DescribeTaskExecutionCommandOutput} for command's `response` shape. + * @see {@link DataSyncClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeTaskExecutionCommand extends $Command< DescribeTaskExecutionCommandInput, diff --git a/clients/client-datasync/commands/ListAgentsCommand.ts b/clients/client-datasync/commands/ListAgentsCommand.ts index cc036e6857e7..2ff4db5f5610 100644 --- a/clients/client-datasync/commands/ListAgentsCommand.ts +++ b/clients/client-datasync/commands/ListAgentsCommand.ts @@ -29,6 +29,20 @@ export interface ListAgentsCommandOutput extends ListAgentsResponse, __MetadataB *

If you have more agents than are returned in a response (that is, the response returns * only a truncated list of your agents), the response contains a marker that you can specify in * your next request to fetch the next page of agents.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { DataSyncClient, ListAgentsCommand } from "@aws-sdk/client-datasync"; // ES Modules import + * // const { DataSyncClient, ListAgentsCommand } = require("@aws-sdk/client-datasync"); // CommonJS import + * const client = new DataSyncClient(config); + * const command = new ListAgentsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListAgentsCommandInput} for command's `input` shape. + * @see {@link ListAgentsCommandOutput} for command's `response` shape. + * @see {@link DataSyncClientResolvedConfig | config} for command's `input` shape. + * */ export class ListAgentsCommand extends $Command< ListAgentsCommandInput, diff --git a/clients/client-datasync/commands/ListLocationsCommand.ts b/clients/client-datasync/commands/ListLocationsCommand.ts index f9701c675164..bb4058fde7cb 100644 --- a/clients/client-datasync/commands/ListLocationsCommand.ts +++ b/clients/client-datasync/commands/ListLocationsCommand.ts @@ -25,6 +25,20 @@ export interface ListLocationsCommandOutput extends ListLocationsResponse, __Met *

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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { DataSyncClient, ListLocationsCommand } from "@aws-sdk/client-datasync"; // ES Modules import + * // const { DataSyncClient, ListLocationsCommand } = require("@aws-sdk/client-datasync"); // CommonJS import + * const client = new DataSyncClient(config); + * const command = new ListLocationsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListLocationsCommandInput} for command's `input` shape. + * @see {@link ListLocationsCommandOutput} for command's `response` shape. + * @see {@link DataSyncClientResolvedConfig | config} for command's `input` shape. + * */ export class ListLocationsCommand extends $Command< ListLocationsCommandInput, diff --git a/clients/client-datasync/commands/ListTagsForResourceCommand.ts b/clients/client-datasync/commands/ListTagsForResourceCommand.ts index e4f837d59938..51b2557873b0 100644 --- a/clients/client-datasync/commands/ListTagsForResourceCommand.ts +++ b/clients/client-datasync/commands/ListTagsForResourceCommand.ts @@ -22,6 +22,20 @@ export interface ListTagsForResourceCommandOutput extends ListTagsForResourceRes /** *

Returns all the tags associated with a specified resource.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { DataSyncClient, ListTagsForResourceCommand } from "@aws-sdk/client-datasync"; // ES Modules import + * // const { DataSyncClient, ListTagsForResourceCommand } = require("@aws-sdk/client-datasync"); // CommonJS import + * const client = new DataSyncClient(config); + * const command = new ListTagsForResourceCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListTagsForResourceCommandInput} for command's `input` shape. + * @see {@link ListTagsForResourceCommandOutput} for command's `response` shape. + * @see {@link DataSyncClientResolvedConfig | config} for command's `input` shape. + * */ export class ListTagsForResourceCommand extends $Command< ListTagsForResourceCommandInput, diff --git a/clients/client-datasync/commands/ListTaskExecutionsCommand.ts b/clients/client-datasync/commands/ListTaskExecutionsCommand.ts index 32caf43a4bf4..20216088f68f 100644 --- a/clients/client-datasync/commands/ListTaskExecutionsCommand.ts +++ b/clients/client-datasync/commands/ListTaskExecutionsCommand.ts @@ -22,6 +22,20 @@ export interface ListTaskExecutionsCommandOutput extends ListTaskExecutionsRespo /** *

Returns a list of executed tasks.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { DataSyncClient, ListTaskExecutionsCommand } from "@aws-sdk/client-datasync"; // ES Modules import + * // const { DataSyncClient, ListTaskExecutionsCommand } = require("@aws-sdk/client-datasync"); // CommonJS import + * const client = new DataSyncClient(config); + * const command = new ListTaskExecutionsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListTaskExecutionsCommandInput} for command's `input` shape. + * @see {@link ListTaskExecutionsCommandOutput} for command's `response` shape. + * @see {@link DataSyncClientResolvedConfig | config} for command's `input` shape. + * */ export class ListTaskExecutionsCommand extends $Command< ListTaskExecutionsCommandInput, diff --git a/clients/client-datasync/commands/ListTasksCommand.ts b/clients/client-datasync/commands/ListTasksCommand.ts index 79c16692f412..65dc67ab9be0 100644 --- a/clients/client-datasync/commands/ListTasksCommand.ts +++ b/clients/client-datasync/commands/ListTasksCommand.ts @@ -19,6 +19,20 @@ export interface ListTasksCommandOutput extends ListTasksResponse, __MetadataBea /** *

Returns a list of all the tasks.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { DataSyncClient, ListTasksCommand } from "@aws-sdk/client-datasync"; // ES Modules import + * // const { DataSyncClient, ListTasksCommand } = require("@aws-sdk/client-datasync"); // CommonJS import + * const client = new DataSyncClient(config); + * const command = new ListTasksCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListTasksCommandInput} for command's `input` shape. + * @see {@link ListTasksCommandOutput} for command's `response` shape. + * @see {@link DataSyncClientResolvedConfig | config} for command's `input` shape. + * */ export class ListTasksCommand extends $Command< ListTasksCommandInput, diff --git a/clients/client-datasync/commands/StartTaskExecutionCommand.ts b/clients/client-datasync/commands/StartTaskExecutionCommand.ts index 22dcd1efeeaa..60b61bd0f362 100644 --- a/clients/client-datasync/commands/StartTaskExecutionCommand.ts +++ b/clients/client-datasync/commands/StartTaskExecutionCommand.ts @@ -30,6 +30,20 @@ export interface StartTaskExecutionCommandOutput extends StartTaskExecutionRespo * *

For detailed information, see the Task Execution section in the Components and * Terminology topic in the AWS DataSync User Guide.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { DataSyncClient, StartTaskExecutionCommand } from "@aws-sdk/client-datasync"; // ES Modules import + * // const { DataSyncClient, StartTaskExecutionCommand } = require("@aws-sdk/client-datasync"); // CommonJS import + * const client = new DataSyncClient(config); + * const command = new StartTaskExecutionCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link StartTaskExecutionCommandInput} for command's `input` shape. + * @see {@link StartTaskExecutionCommandOutput} for command's `response` shape. + * @see {@link DataSyncClientResolvedConfig | config} for command's `input` shape. + * */ export class StartTaskExecutionCommand extends $Command< StartTaskExecutionCommandInput, diff --git a/clients/client-datasync/commands/TagResourceCommand.ts b/clients/client-datasync/commands/TagResourceCommand.ts index d28191ffe606..95aae04f6ff1 100644 --- a/clients/client-datasync/commands/TagResourceCommand.ts +++ b/clients/client-datasync/commands/TagResourceCommand.ts @@ -22,6 +22,20 @@ export interface TagResourceCommandOutput extends TagResourceResponse, __Metadat /** *

Applies a key-value pair to an AWS resource.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { DataSyncClient, TagResourceCommand } from "@aws-sdk/client-datasync"; // ES Modules import + * // const { DataSyncClient, TagResourceCommand } = require("@aws-sdk/client-datasync"); // CommonJS import + * const client = new DataSyncClient(config); + * const command = new TagResourceCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link TagResourceCommandInput} for command's `input` shape. + * @see {@link TagResourceCommandOutput} for command's `response` shape. + * @see {@link DataSyncClientResolvedConfig | config} for command's `input` shape. + * */ export class TagResourceCommand extends $Command< TagResourceCommandInput, diff --git a/clients/client-datasync/commands/UntagResourceCommand.ts b/clients/client-datasync/commands/UntagResourceCommand.ts index 9767fcb6d741..44b99e027ec7 100644 --- a/clients/client-datasync/commands/UntagResourceCommand.ts +++ b/clients/client-datasync/commands/UntagResourceCommand.ts @@ -22,6 +22,20 @@ export interface UntagResourceCommandOutput extends UntagResourceResponse, __Met /** *

Removes a tag from an AWS resource.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { DataSyncClient, UntagResourceCommand } from "@aws-sdk/client-datasync"; // ES Modules import + * // const { DataSyncClient, UntagResourceCommand } = require("@aws-sdk/client-datasync"); // CommonJS import + * const client = new DataSyncClient(config); + * const command = new UntagResourceCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link UntagResourceCommandInput} for command's `input` shape. + * @see {@link UntagResourceCommandOutput} for command's `response` shape. + * @see {@link DataSyncClientResolvedConfig | config} for command's `input` shape. + * */ export class UntagResourceCommand extends $Command< UntagResourceCommandInput, diff --git a/clients/client-datasync/commands/UpdateAgentCommand.ts b/clients/client-datasync/commands/UpdateAgentCommand.ts index 1cd3908c272b..6214472aabf3 100644 --- a/clients/client-datasync/commands/UpdateAgentCommand.ts +++ b/clients/client-datasync/commands/UpdateAgentCommand.ts @@ -22,6 +22,20 @@ export interface UpdateAgentCommandOutput extends UpdateAgentResponse, __Metadat /** *

Updates the name of an agent.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { DataSyncClient, UpdateAgentCommand } from "@aws-sdk/client-datasync"; // ES Modules import + * // const { DataSyncClient, UpdateAgentCommand } = require("@aws-sdk/client-datasync"); // CommonJS import + * const client = new DataSyncClient(config); + * const command = new UpdateAgentCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link UpdateAgentCommandInput} for command's `input` shape. + * @see {@link UpdateAgentCommandOutput} for command's `response` shape. + * @see {@link DataSyncClientResolvedConfig | config} for command's `input` shape. + * */ export class UpdateAgentCommand extends $Command< UpdateAgentCommandInput, diff --git a/clients/client-datasync/commands/UpdateLocationNfsCommand.ts b/clients/client-datasync/commands/UpdateLocationNfsCommand.ts index ce1352935f0d..3072d87a8732 100644 --- a/clients/client-datasync/commands/UpdateLocationNfsCommand.ts +++ b/clients/client-datasync/commands/UpdateLocationNfsCommand.ts @@ -23,6 +23,20 @@ export interface UpdateLocationNfsCommandOutput extends UpdateLocationNfsRespons /** *

Updates some of the parameters of a previously created location for Network File System (NFS) access. * For information about creating an NFS location, see create-nfs-location.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { DataSyncClient, UpdateLocationNfsCommand } from "@aws-sdk/client-datasync"; // ES Modules import + * // const { DataSyncClient, UpdateLocationNfsCommand } = require("@aws-sdk/client-datasync"); // CommonJS import + * const client = new DataSyncClient(config); + * const command = new UpdateLocationNfsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link UpdateLocationNfsCommandInput} for command's `input` shape. + * @see {@link UpdateLocationNfsCommandOutput} for command's `response` shape. + * @see {@link DataSyncClientResolvedConfig | config} for command's `input` shape. + * */ export class UpdateLocationNfsCommand extends $Command< UpdateLocationNfsCommandInput, diff --git a/clients/client-datasync/commands/UpdateLocationObjectStorageCommand.ts b/clients/client-datasync/commands/UpdateLocationObjectStorageCommand.ts index e3796bb9eea3..b1e550ad7cc1 100644 --- a/clients/client-datasync/commands/UpdateLocationObjectStorageCommand.ts +++ b/clients/client-datasync/commands/UpdateLocationObjectStorageCommand.ts @@ -26,6 +26,20 @@ export interface UpdateLocationObjectStorageCommandOutput *

Updates some of the parameters of a previously created location for self-managed object * storage server access. For information about creating a self-managed object storage location, * see create-object-location.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { DataSyncClient, UpdateLocationObjectStorageCommand } from "@aws-sdk/client-datasync"; // ES Modules import + * // const { DataSyncClient, UpdateLocationObjectStorageCommand } = require("@aws-sdk/client-datasync"); // CommonJS import + * const client = new DataSyncClient(config); + * const command = new UpdateLocationObjectStorageCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link UpdateLocationObjectStorageCommandInput} for command's `input` shape. + * @see {@link UpdateLocationObjectStorageCommandOutput} for command's `response` shape. + * @see {@link DataSyncClientResolvedConfig | config} for command's `input` shape. + * */ export class UpdateLocationObjectStorageCommand extends $Command< UpdateLocationObjectStorageCommandInput, diff --git a/clients/client-datasync/commands/UpdateLocationSmbCommand.ts b/clients/client-datasync/commands/UpdateLocationSmbCommand.ts index 6cd498c440cd..8f8e5f4af292 100644 --- a/clients/client-datasync/commands/UpdateLocationSmbCommand.ts +++ b/clients/client-datasync/commands/UpdateLocationSmbCommand.ts @@ -23,6 +23,20 @@ export interface UpdateLocationSmbCommandOutput extends UpdateLocationSmbRespons /** *

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 create-smb-location.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { DataSyncClient, UpdateLocationSmbCommand } from "@aws-sdk/client-datasync"; // ES Modules import + * // const { DataSyncClient, UpdateLocationSmbCommand } = require("@aws-sdk/client-datasync"); // CommonJS import + * const client = new DataSyncClient(config); + * const command = new UpdateLocationSmbCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link UpdateLocationSmbCommandInput} for command's `input` shape. + * @see {@link UpdateLocationSmbCommandOutput} for command's `response` shape. + * @see {@link DataSyncClientResolvedConfig | config} for command's `input` shape. + * */ export class UpdateLocationSmbCommand extends $Command< UpdateLocationSmbCommandInput, diff --git a/clients/client-datasync/commands/UpdateTaskCommand.ts b/clients/client-datasync/commands/UpdateTaskCommand.ts index d9535e0c1849..71a5d27371f2 100644 --- a/clients/client-datasync/commands/UpdateTaskCommand.ts +++ b/clients/client-datasync/commands/UpdateTaskCommand.ts @@ -22,6 +22,20 @@ export interface UpdateTaskCommandOutput extends UpdateTaskResponse, __MetadataB /** *

Updates the metadata associated with a task.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { DataSyncClient, UpdateTaskCommand } from "@aws-sdk/client-datasync"; // ES Modules import + * // const { DataSyncClient, UpdateTaskCommand } = require("@aws-sdk/client-datasync"); // CommonJS import + * const client = new DataSyncClient(config); + * const command = new UpdateTaskCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link UpdateTaskCommandInput} for command's `input` shape. + * @see {@link UpdateTaskCommandOutput} for command's `response` shape. + * @see {@link DataSyncClientResolvedConfig | config} for command's `input` shape. + * */ export class UpdateTaskCommand extends $Command< UpdateTaskCommandInput, diff --git a/clients/client-datasync/commands/UpdateTaskExecutionCommand.ts b/clients/client-datasync/commands/UpdateTaskExecutionCommand.ts index 79db28f460d2..596a636b4d1c 100644 --- a/clients/client-datasync/commands/UpdateTaskExecutionCommand.ts +++ b/clients/client-datasync/commands/UpdateTaskExecutionCommand.ts @@ -31,6 +31,20 @@ export interface UpdateTaskExecutionCommandOutput extends UpdateTaskExecutionRes * BytesPerSecond * .

* + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { DataSyncClient, UpdateTaskExecutionCommand } from "@aws-sdk/client-datasync"; // ES Modules import + * // const { DataSyncClient, UpdateTaskExecutionCommand } = require("@aws-sdk/client-datasync"); // CommonJS import + * const client = new DataSyncClient(config); + * const command = new UpdateTaskExecutionCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link UpdateTaskExecutionCommandInput} for command's `input` shape. + * @see {@link UpdateTaskExecutionCommandOutput} for command's `response` shape. + * @see {@link DataSyncClientResolvedConfig | config} for command's `input` shape. + * */ export class UpdateTaskExecutionCommand extends $Command< UpdateTaskExecutionCommandInput, diff --git a/clients/client-datasync/models/models_0.ts b/clients/client-datasync/models/models_0.ts index 024066a80717..c0221805c5ff 100644 --- a/clients/client-datasync/models/models_0.ts +++ b/clients/client-datasync/models/models_0.ts @@ -29,6 +29,9 @@ export interface AgentListEntry { } export namespace AgentListEntry { + /** + * @internal + */ export const filterSensitiveLog = (obj: AgentListEntry): any => ({ ...obj, }); @@ -50,6 +53,9 @@ export interface CancelTaskExecutionRequest { } export namespace CancelTaskExecutionRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: CancelTaskExecutionRequest): any => ({ ...obj, }); @@ -58,6 +64,9 @@ export namespace CancelTaskExecutionRequest { export interface CancelTaskExecutionResponse {} export namespace CancelTaskExecutionResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: CancelTaskExecutionResponse): any => ({ ...obj, }); @@ -74,6 +83,9 @@ export interface InternalException extends __SmithyException, $MetadataBearer { } export namespace InternalException { + /** + * @internal + */ export const filterSensitiveLog = (obj: InternalException): any => ({ ...obj, }); @@ -90,6 +102,9 @@ export interface InvalidRequestException extends __SmithyException, $MetadataBea } export namespace InvalidRequestException { + /** + * @internal + */ export const filterSensitiveLog = (obj: InvalidRequestException): any => ({ ...obj, }); @@ -113,6 +128,9 @@ export interface TagListEntry { } export namespace TagListEntry { + /** + * @internal + */ export const filterSensitiveLog = (obj: TagListEntry): any => ({ ...obj, }); @@ -180,6 +198,9 @@ export interface CreateAgentRequest { } export namespace CreateAgentRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateAgentRequest): any => ({ ...obj, }); @@ -197,6 +218,9 @@ export interface CreateAgentResponse { } export namespace CreateAgentResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateAgentResponse): any => ({ ...obj, }); @@ -223,6 +247,9 @@ export interface Ec2Config { } export namespace Ec2Config { + /** + * @internal + */ export const filterSensitiveLog = (obj: Ec2Config): any => ({ ...obj, }); @@ -286,6 +313,9 @@ export interface CreateLocationEfsRequest { } export namespace CreateLocationEfsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateLocationEfsRequest): any => ({ ...obj, }); @@ -303,6 +333,9 @@ export interface CreateLocationEfsResponse { } export namespace CreateLocationEfsResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateLocationEfsResponse): any => ({ ...obj, }); @@ -353,6 +386,9 @@ export interface CreateLocationFsxWindowsRequest { } export namespace CreateLocationFsxWindowsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateLocationFsxWindowsRequest): any => ({ ...obj, ...(obj.Password && { Password: SENSITIVE_STRING }), @@ -368,6 +404,9 @@ export interface CreateLocationFsxWindowsResponse { } export namespace CreateLocationFsxWindowsResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateLocationFsxWindowsResponse): any => ({ ...obj, }); @@ -421,6 +460,9 @@ export interface NfsMountOptions { } export namespace NfsMountOptions { + /** + * @internal + */ export const filterSensitiveLog = (obj: NfsMountOptions): any => ({ ...obj, }); @@ -438,6 +480,9 @@ export interface OnPremConfig { } export namespace OnPremConfig { + /** + * @internal + */ export const filterSensitiveLog = (obj: OnPremConfig): any => ({ ...obj, }); @@ -501,6 +546,9 @@ export interface CreateLocationNfsRequest { } export namespace CreateLocationNfsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateLocationNfsRequest): any => ({ ...obj, }); @@ -518,6 +566,9 @@ export interface CreateLocationNfsResponse { } export namespace CreateLocationNfsResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateLocationNfsResponse): any => ({ ...obj, }); @@ -594,6 +645,9 @@ export interface CreateLocationObjectStorageRequest { } export namespace CreateLocationObjectStorageRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateLocationObjectStorageRequest): any => ({ ...obj, ...(obj.SecretKey && { SecretKey: SENSITIVE_STRING }), @@ -612,6 +666,9 @@ export interface CreateLocationObjectStorageResponse { } export namespace CreateLocationObjectStorageResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateLocationObjectStorageResponse): any => ({ ...obj, }); @@ -632,6 +689,9 @@ export interface S3Config { } export namespace S3Config { + /** + * @internal + */ export const filterSensitiveLog = (obj: S3Config): any => ({ ...obj, }); @@ -697,6 +757,9 @@ export interface CreateLocationS3Request { } export namespace CreateLocationS3Request { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateLocationS3Request): any => ({ ...obj, }); @@ -714,6 +777,9 @@ export interface CreateLocationS3Response { } export namespace CreateLocationS3Response { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateLocationS3Response): any => ({ ...obj, }); @@ -739,6 +805,9 @@ export interface SmbMountOptions { } export namespace SmbMountOptions { + /** + * @internal + */ export const filterSensitiveLog = (obj: SmbMountOptions): any => ({ ...obj, }); @@ -815,6 +884,9 @@ export interface CreateLocationSmbRequest { } export namespace CreateLocationSmbRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateLocationSmbRequest): any => ({ ...obj, ...(obj.Password && { Password: SENSITIVE_STRING }), @@ -833,6 +905,9 @@ export interface CreateLocationSmbResponse { } export namespace CreateLocationSmbResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateLocationSmbResponse): any => ({ ...obj, }); @@ -864,6 +939,9 @@ export interface FilterRule { } export namespace FilterRule { + /** + * @internal + */ export const filterSensitiveLog = (obj: FilterRule): any => ({ ...obj, }); @@ -1097,6 +1175,9 @@ export interface Options { } export namespace Options { + /** + * @internal + */ export const filterSensitiveLog = (obj: Options): any => ({ ...obj, }); @@ -1115,6 +1196,9 @@ export interface TaskSchedule { } export namespace TaskSchedule { + /** + * @internal + */ export const filterSensitiveLog = (obj: TaskSchedule): any => ({ ...obj, }); @@ -1180,6 +1264,9 @@ export interface CreateTaskRequest { } export namespace CreateTaskRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateTaskRequest): any => ({ ...obj, }); @@ -1196,6 +1283,9 @@ export interface CreateTaskResponse { } export namespace CreateTaskResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateTaskResponse): any => ({ ...obj, }); @@ -1213,6 +1303,9 @@ export interface DeleteAgentRequest { } export namespace DeleteAgentRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteAgentRequest): any => ({ ...obj, }); @@ -1221,6 +1314,9 @@ export namespace DeleteAgentRequest { export interface DeleteAgentResponse {} export namespace DeleteAgentResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteAgentResponse): any => ({ ...obj, }); @@ -1237,6 +1333,9 @@ export interface DeleteLocationRequest { } export namespace DeleteLocationRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteLocationRequest): any => ({ ...obj, }); @@ -1245,6 +1344,9 @@ export namespace DeleteLocationRequest { export interface DeleteLocationResponse {} export namespace DeleteLocationResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteLocationResponse): any => ({ ...obj, }); @@ -1261,6 +1363,9 @@ export interface DeleteTaskRequest { } export namespace DeleteTaskRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteTaskRequest): any => ({ ...obj, }); @@ -1269,6 +1374,9 @@ export namespace DeleteTaskRequest { export interface DeleteTaskResponse {} export namespace DeleteTaskResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteTaskResponse): any => ({ ...obj, }); @@ -1285,6 +1393,9 @@ export interface DescribeAgentRequest { } export namespace DescribeAgentRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeAgentRequest): any => ({ ...obj, }); @@ -1329,6 +1440,9 @@ export interface PrivateLinkConfig { } export namespace PrivateLinkConfig { + /** + * @internal + */ export const filterSensitiveLog = (obj: PrivateLinkConfig): any => ({ ...obj, }); @@ -1380,6 +1494,9 @@ export interface DescribeAgentResponse { } export namespace DescribeAgentResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeAgentResponse): any => ({ ...obj, }); @@ -1396,6 +1513,9 @@ export interface DescribeLocationEfsRequest { } export namespace DescribeLocationEfsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeLocationEfsRequest): any => ({ ...obj, }); @@ -1430,6 +1550,9 @@ export interface DescribeLocationEfsResponse { } export namespace DescribeLocationEfsResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeLocationEfsResponse): any => ({ ...obj, }); @@ -1444,6 +1567,9 @@ export interface DescribeLocationFsxWindowsRequest { } export namespace DescribeLocationFsxWindowsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeLocationFsxWindowsRequest): any => ({ ...obj, }); @@ -1485,6 +1611,9 @@ export interface DescribeLocationFsxWindowsResponse { } export namespace DescribeLocationFsxWindowsResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeLocationFsxWindowsResponse): any => ({ ...obj, }); @@ -1501,6 +1630,9 @@ export interface DescribeLocationNfsRequest { } export namespace DescribeLocationNfsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeLocationNfsRequest): any => ({ ...obj, }); @@ -1538,6 +1670,9 @@ export interface DescribeLocationNfsResponse { } export namespace DescribeLocationNfsResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeLocationNfsResponse): any => ({ ...obj, }); @@ -1554,6 +1689,9 @@ export interface DescribeLocationObjectStorageRequest { } export namespace DescribeLocationObjectStorageRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeLocationObjectStorageRequest): any => ({ ...obj, }); @@ -1606,6 +1744,9 @@ export interface DescribeLocationObjectStorageResponse { } export namespace DescribeLocationObjectStorageResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeLocationObjectStorageResponse): any => ({ ...obj, }); @@ -1622,6 +1763,9 @@ export interface DescribeLocationS3Request { } export namespace DescribeLocationS3Request { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeLocationS3Request): any => ({ ...obj, }); @@ -1672,6 +1816,9 @@ export interface DescribeLocationS3Response { } export namespace DescribeLocationS3Response { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeLocationS3Response): any => ({ ...obj, }); @@ -1688,6 +1835,9 @@ export interface DescribeLocationSmbRequest { } export namespace DescribeLocationSmbRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeLocationSmbRequest): any => ({ ...obj, }); @@ -1736,6 +1886,9 @@ export interface DescribeLocationSmbResponse { } export namespace DescribeLocationSmbResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeLocationSmbResponse): any => ({ ...obj, }); @@ -1752,6 +1905,9 @@ export interface DescribeTaskRequest { } export namespace DescribeTaskRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeTaskRequest): any => ({ ...obj, }); @@ -1870,6 +2026,9 @@ export interface DescribeTaskResponse { } export namespace DescribeTaskResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeTaskResponse): any => ({ ...obj, }); @@ -1886,6 +2045,9 @@ export interface DescribeTaskExecutionRequest { } export namespace DescribeTaskExecutionRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeTaskExecutionRequest): any => ({ ...obj, }); @@ -1955,6 +2117,9 @@ export interface TaskExecutionResultDetail { } export namespace TaskExecutionResultDetail { + /** + * @internal + */ export const filterSensitiveLog = (obj: TaskExecutionResultDetail): any => ({ ...obj, }); @@ -2075,6 +2240,9 @@ export interface DescribeTaskExecutionResponse { } export namespace DescribeTaskExecutionResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeTaskExecutionResponse): any => ({ ...obj, }); @@ -2097,6 +2265,9 @@ export interface ListAgentsRequest { } export namespace ListAgentsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListAgentsRequest): any => ({ ...obj, }); @@ -2119,6 +2290,9 @@ export interface ListAgentsResponse { } export namespace ListAgentsResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListAgentsResponse): any => ({ ...obj, }); @@ -2169,6 +2343,9 @@ export interface LocationFilter { } export namespace LocationFilter { + /** + * @internal + */ export const filterSensitiveLog = (obj: LocationFilter): any => ({ ...obj, }); @@ -2198,6 +2375,9 @@ export interface ListLocationsRequest { } export namespace ListLocationsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListLocationsRequest): any => ({ ...obj, }); @@ -2236,6 +2416,9 @@ export interface LocationListEntry { } export namespace LocationListEntry { + /** + * @internal + */ export const filterSensitiveLog = (obj: LocationListEntry): any => ({ ...obj, }); @@ -2258,6 +2441,9 @@ export interface ListLocationsResponse { } export namespace ListLocationsResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListLocationsResponse): any => ({ ...obj, }); @@ -2285,6 +2471,9 @@ export interface ListTagsForResourceRequest { } export namespace ListTagsForResourceRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListTagsForResourceRequest): any => ({ ...obj, }); @@ -2307,6 +2496,9 @@ export interface ListTagsForResourceResponse { } export namespace ListTagsForResourceResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListTagsForResourceResponse): any => ({ ...obj, }); @@ -2334,6 +2526,9 @@ export interface ListTaskExecutionsRequest { } export namespace ListTaskExecutionsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListTaskExecutionsRequest): any => ({ ...obj, }); @@ -2357,6 +2552,9 @@ export interface TaskExecutionListEntry { } export namespace TaskExecutionListEntry { + /** + * @internal + */ export const filterSensitiveLog = (obj: TaskExecutionListEntry): any => ({ ...obj, }); @@ -2379,6 +2577,9 @@ export interface ListTaskExecutionsResponse { } export namespace ListTaskExecutionsResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListTaskExecutionsResponse): any => ({ ...obj, }); @@ -2416,6 +2617,9 @@ export interface TaskFilter { } export namespace TaskFilter { + /** + * @internal + */ export const filterSensitiveLog = (obj: TaskFilter): any => ({ ...obj, }); @@ -2446,6 +2650,9 @@ export interface ListTasksRequest { } export namespace ListTasksRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListTasksRequest): any => ({ ...obj, }); @@ -2475,6 +2682,9 @@ export interface TaskListEntry { } export namespace TaskListEntry { + /** + * @internal + */ export const filterSensitiveLog = (obj: TaskListEntry): any => ({ ...obj, }); @@ -2497,6 +2707,9 @@ export interface ListTasksResponse { } export namespace ListTasksResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListTasksResponse): any => ({ ...obj, }); @@ -2535,6 +2748,9 @@ export interface StartTaskExecutionRequest { } export namespace StartTaskExecutionRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: StartTaskExecutionRequest): any => ({ ...obj, }); @@ -2552,6 +2768,9 @@ export interface StartTaskExecutionResponse { } export namespace StartTaskExecutionResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: StartTaskExecutionResponse): any => ({ ...obj, }); @@ -2573,6 +2792,9 @@ export interface TagResourceRequest { } export namespace TagResourceRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: TagResourceRequest): any => ({ ...obj, }); @@ -2581,6 +2803,9 @@ export namespace TagResourceRequest { export interface TagResourceResponse {} export namespace TagResourceResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: TagResourceResponse): any => ({ ...obj, }); @@ -2602,6 +2827,9 @@ export interface UntagResourceRequest { } export namespace UntagResourceRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: UntagResourceRequest): any => ({ ...obj, }); @@ -2610,6 +2838,9 @@ export namespace UntagResourceRequest { export interface UntagResourceResponse {} export namespace UntagResourceResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: UntagResourceResponse): any => ({ ...obj, }); @@ -2631,6 +2862,9 @@ export interface UpdateAgentRequest { } export namespace UpdateAgentRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateAgentRequest): any => ({ ...obj, }); @@ -2639,6 +2873,9 @@ export namespace UpdateAgentRequest { export interface UpdateAgentResponse {} export namespace UpdateAgentResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateAgentResponse): any => ({ ...obj, }); @@ -2687,6 +2924,9 @@ export interface UpdateLocationNfsRequest { } export namespace UpdateLocationNfsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateLocationNfsRequest): any => ({ ...obj, }); @@ -2695,6 +2935,9 @@ export namespace UpdateLocationNfsRequest { export interface UpdateLocationNfsResponse {} export namespace UpdateLocationNfsResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateLocationNfsResponse): any => ({ ...obj, }); @@ -2749,6 +2992,9 @@ export interface UpdateLocationObjectStorageRequest { } export namespace UpdateLocationObjectStorageRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateLocationObjectStorageRequest): any => ({ ...obj, ...(obj.SecretKey && { SecretKey: SENSITIVE_STRING }), @@ -2758,6 +3004,9 @@ export namespace UpdateLocationObjectStorageRequest { export interface UpdateLocationObjectStorageResponse {} export namespace UpdateLocationObjectStorageResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateLocationObjectStorageResponse): any => ({ ...obj, }); @@ -2829,6 +3078,9 @@ export interface UpdateLocationSmbRequest { } export namespace UpdateLocationSmbRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateLocationSmbRequest): any => ({ ...obj, ...(obj.Password && { Password: SENSITIVE_STRING }), @@ -2838,6 +3090,9 @@ export namespace UpdateLocationSmbRequest { export interface UpdateLocationSmbResponse {} export namespace UpdateLocationSmbResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateLocationSmbResponse): any => ({ ...obj, }); @@ -2894,6 +3149,9 @@ export interface UpdateTaskRequest { } export namespace UpdateTaskRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateTaskRequest): any => ({ ...obj, }); @@ -2902,6 +3160,9 @@ export namespace UpdateTaskRequest { export interface UpdateTaskResponse {} export namespace UpdateTaskResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateTaskResponse): any => ({ ...obj, }); @@ -2926,6 +3187,9 @@ export interface UpdateTaskExecutionRequest { } export namespace UpdateTaskExecutionRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateTaskExecutionRequest): any => ({ ...obj, }); @@ -2934,6 +3198,9 @@ export namespace UpdateTaskExecutionRequest { export interface UpdateTaskExecutionResponse {} export namespace UpdateTaskExecutionResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateTaskExecutionResponse): any => ({ ...obj, }); diff --git a/clients/client-dax/commands/CreateClusterCommand.ts b/clients/client-dax/commands/CreateClusterCommand.ts index 58a954080d1b..dbec6dda8935 100644 --- a/clients/client-dax/commands/CreateClusterCommand.ts +++ b/clients/client-dax/commands/CreateClusterCommand.ts @@ -22,6 +22,20 @@ export interface CreateClusterCommandOutput extends CreateClusterResponse, __Met /** *

Creates a DAX cluster. All nodes in the cluster run the same DAX caching software.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { DAXClient, CreateClusterCommand } from "@aws-sdk/client-dax"; // ES Modules import + * // const { DAXClient, CreateClusterCommand } = require("@aws-sdk/client-dax"); // CommonJS import + * const client = new DAXClient(config); + * const command = new CreateClusterCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreateClusterCommandInput} for command's `input` shape. + * @see {@link CreateClusterCommandOutput} for command's `response` shape. + * @see {@link DAXClientResolvedConfig | config} for command's `input` shape. + * */ export class CreateClusterCommand extends $Command< CreateClusterCommandInput, diff --git a/clients/client-dax/commands/CreateParameterGroupCommand.ts b/clients/client-dax/commands/CreateParameterGroupCommand.ts index 2668c24d5821..ef6841626dd8 100644 --- a/clients/client-dax/commands/CreateParameterGroupCommand.ts +++ b/clients/client-dax/commands/CreateParameterGroupCommand.ts @@ -23,6 +23,20 @@ export interface CreateParameterGroupCommandOutput extends CreateParameterGroupR /** *

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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { DAXClient, CreateParameterGroupCommand } from "@aws-sdk/client-dax"; // ES Modules import + * // const { DAXClient, CreateParameterGroupCommand } = require("@aws-sdk/client-dax"); // CommonJS import + * const client = new DAXClient(config); + * const command = new CreateParameterGroupCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreateParameterGroupCommandInput} for command's `input` shape. + * @see {@link CreateParameterGroupCommandOutput} for command's `response` shape. + * @see {@link DAXClientResolvedConfig | config} for command's `input` shape. + * */ export class CreateParameterGroupCommand extends $Command< CreateParameterGroupCommandInput, diff --git a/clients/client-dax/commands/CreateSubnetGroupCommand.ts b/clients/client-dax/commands/CreateSubnetGroupCommand.ts index 6f0bbd76a7fa..d9a87c519c94 100644 --- a/clients/client-dax/commands/CreateSubnetGroupCommand.ts +++ b/clients/client-dax/commands/CreateSubnetGroupCommand.ts @@ -22,6 +22,20 @@ export interface CreateSubnetGroupCommandOutput extends CreateSubnetGroupRespons /** *

Creates a new subnet group.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { DAXClient, CreateSubnetGroupCommand } from "@aws-sdk/client-dax"; // ES Modules import + * // const { DAXClient, CreateSubnetGroupCommand } = require("@aws-sdk/client-dax"); // CommonJS import + * const client = new DAXClient(config); + * const command = new CreateSubnetGroupCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreateSubnetGroupCommandInput} for command's `input` shape. + * @see {@link CreateSubnetGroupCommandOutput} for command's `response` shape. + * @see {@link DAXClientResolvedConfig | config} for command's `input` shape. + * */ export class CreateSubnetGroupCommand extends $Command< CreateSubnetGroupCommandInput, diff --git a/clients/client-dax/commands/DecreaseReplicationFactorCommand.ts b/clients/client-dax/commands/DecreaseReplicationFactorCommand.ts index f131e430edd2..dd54ed9fcee4 100644 --- a/clients/client-dax/commands/DecreaseReplicationFactorCommand.ts +++ b/clients/client-dax/commands/DecreaseReplicationFactorCommand.ts @@ -25,6 +25,20 @@ export interface DecreaseReplicationFactorCommandOutput extends DecreaseReplicat * *

You cannot use DecreaseReplicationFactor to remove the last node in a DAX cluster. If you need to do this, use DeleteCluster instead.

* + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { DAXClient, DecreaseReplicationFactorCommand } from "@aws-sdk/client-dax"; // ES Modules import + * // const { DAXClient, DecreaseReplicationFactorCommand } = require("@aws-sdk/client-dax"); // CommonJS import + * const client = new DAXClient(config); + * const command = new DecreaseReplicationFactorCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DecreaseReplicationFactorCommandInput} for command's `input` shape. + * @see {@link DecreaseReplicationFactorCommandOutput} for command's `response` shape. + * @see {@link DAXClientResolvedConfig | config} for command's `input` shape. + * */ export class DecreaseReplicationFactorCommand extends $Command< DecreaseReplicationFactorCommandInput, diff --git a/clients/client-dax/commands/DeleteClusterCommand.ts b/clients/client-dax/commands/DeleteClusterCommand.ts index ff3d81f476f6..560d32702088 100644 --- a/clients/client-dax/commands/DeleteClusterCommand.ts +++ b/clients/client-dax/commands/DeleteClusterCommand.ts @@ -26,6 +26,20 @@ export interface DeleteClusterCommandOutput extends DeleteClusterResponse, __Met * 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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { DAXClient, DeleteClusterCommand } from "@aws-sdk/client-dax"; // ES Modules import + * // const { DAXClient, DeleteClusterCommand } = require("@aws-sdk/client-dax"); // CommonJS import + * const client = new DAXClient(config); + * const command = new DeleteClusterCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteClusterCommandInput} for command's `input` shape. + * @see {@link DeleteClusterCommandOutput} for command's `response` shape. + * @see {@link DAXClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteClusterCommand extends $Command< DeleteClusterCommandInput, diff --git a/clients/client-dax/commands/DeleteParameterGroupCommand.ts b/clients/client-dax/commands/DeleteParameterGroupCommand.ts index 4c5046d0a176..d9485ce96303 100644 --- a/clients/client-dax/commands/DeleteParameterGroupCommand.ts +++ b/clients/client-dax/commands/DeleteParameterGroupCommand.ts @@ -23,6 +23,20 @@ export interface DeleteParameterGroupCommandOutput extends DeleteParameterGroupR /** *

Deletes the specified parameter group. You cannot delete a parameter group if it is * associated with any DAX clusters.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { DAXClient, DeleteParameterGroupCommand } from "@aws-sdk/client-dax"; // ES Modules import + * // const { DAXClient, DeleteParameterGroupCommand } = require("@aws-sdk/client-dax"); // CommonJS import + * const client = new DAXClient(config); + * const command = new DeleteParameterGroupCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteParameterGroupCommandInput} for command's `input` shape. + * @see {@link DeleteParameterGroupCommandOutput} for command's `response` shape. + * @see {@link DAXClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteParameterGroupCommand extends $Command< DeleteParameterGroupCommandInput, diff --git a/clients/client-dax/commands/DeleteSubnetGroupCommand.ts b/clients/client-dax/commands/DeleteSubnetGroupCommand.ts index e60d1fa1e6b5..ecc1817c1e64 100644 --- a/clients/client-dax/commands/DeleteSubnetGroupCommand.ts +++ b/clients/client-dax/commands/DeleteSubnetGroupCommand.ts @@ -26,6 +26,20 @@ export interface DeleteSubnetGroupCommandOutput extends DeleteSubnetGroupRespons *

You cannot delete a subnet group if it is associated with any DAX * clusters.

* + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { DAXClient, DeleteSubnetGroupCommand } from "@aws-sdk/client-dax"; // ES Modules import + * // const { DAXClient, DeleteSubnetGroupCommand } = require("@aws-sdk/client-dax"); // CommonJS import + * const client = new DAXClient(config); + * const command = new DeleteSubnetGroupCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteSubnetGroupCommandInput} for command's `input` shape. + * @see {@link DeleteSubnetGroupCommandOutput} for command's `response` shape. + * @see {@link DAXClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteSubnetGroupCommand extends $Command< DeleteSubnetGroupCommandInput, diff --git a/clients/client-dax/commands/DescribeClustersCommand.ts b/clients/client-dax/commands/DescribeClustersCommand.ts index 64d51a7fe55a..cda49defe656 100644 --- a/clients/client-dax/commands/DescribeClustersCommand.ts +++ b/clients/client-dax/commands/DescribeClustersCommand.ts @@ -34,6 +34,20 @@ export interface DescribeClustersCommandOutput extends DescribeClustersResponse, * 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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { DAXClient, DescribeClustersCommand } from "@aws-sdk/client-dax"; // ES Modules import + * // const { DAXClient, DescribeClustersCommand } = require("@aws-sdk/client-dax"); // CommonJS import + * const client = new DAXClient(config); + * const command = new DescribeClustersCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeClustersCommandInput} for command's `input` shape. + * @see {@link DescribeClustersCommandOutput} for command's `response` shape. + * @see {@link DAXClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeClustersCommand extends $Command< DescribeClustersCommandInput, diff --git a/clients/client-dax/commands/DescribeDefaultParametersCommand.ts b/clients/client-dax/commands/DescribeDefaultParametersCommand.ts index deb0ab6ad5f5..786491a1bc0e 100644 --- a/clients/client-dax/commands/DescribeDefaultParametersCommand.ts +++ b/clients/client-dax/commands/DescribeDefaultParametersCommand.ts @@ -23,6 +23,20 @@ export interface DescribeDefaultParametersCommandOutput extends DescribeDefaultP /** *

Returns the default system parameter information for the DAX caching * software.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { DAXClient, DescribeDefaultParametersCommand } from "@aws-sdk/client-dax"; // ES Modules import + * // const { DAXClient, DescribeDefaultParametersCommand } = require("@aws-sdk/client-dax"); // CommonJS import + * const client = new DAXClient(config); + * const command = new DescribeDefaultParametersCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeDefaultParametersCommandInput} for command's `input` shape. + * @see {@link DescribeDefaultParametersCommandOutput} for command's `response` shape. + * @see {@link DAXClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeDefaultParametersCommand extends $Command< DescribeDefaultParametersCommandInput, diff --git a/clients/client-dax/commands/DescribeEventsCommand.ts b/clients/client-dax/commands/DescribeEventsCommand.ts index bc4db428911b..ee2269d9a808 100644 --- a/clients/client-dax/commands/DescribeEventsCommand.ts +++ b/clients/client-dax/commands/DescribeEventsCommand.ts @@ -26,6 +26,20 @@ export interface DescribeEventsCommandOutput extends DescribeEventsResponse, __M * 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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { DAXClient, DescribeEventsCommand } from "@aws-sdk/client-dax"; // ES Modules import + * // const { DAXClient, DescribeEventsCommand } = require("@aws-sdk/client-dax"); // CommonJS import + * const client = new DAXClient(config); + * const command = new DescribeEventsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeEventsCommandInput} for command's `input` shape. + * @see {@link DescribeEventsCommandOutput} for command's `response` shape. + * @see {@link DAXClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeEventsCommand extends $Command< DescribeEventsCommandInput, diff --git a/clients/client-dax/commands/DescribeParameterGroupsCommand.ts b/clients/client-dax/commands/DescribeParameterGroupsCommand.ts index aebda9a996be..e68fc4ca549d 100644 --- a/clients/client-dax/commands/DescribeParameterGroupsCommand.ts +++ b/clients/client-dax/commands/DescribeParameterGroupsCommand.ts @@ -23,6 +23,20 @@ export interface DescribeParameterGroupsCommandOutput extends DescribeParameterG /** *

Returns a list of parameter group descriptions. If a parameter group name is * specified, the list will contain only the descriptions for that group.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { DAXClient, DescribeParameterGroupsCommand } from "@aws-sdk/client-dax"; // ES Modules import + * // const { DAXClient, DescribeParameterGroupsCommand } = require("@aws-sdk/client-dax"); // CommonJS import + * const client = new DAXClient(config); + * const command = new DescribeParameterGroupsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeParameterGroupsCommandInput} for command's `input` shape. + * @see {@link DescribeParameterGroupsCommandOutput} for command's `response` shape. + * @see {@link DAXClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeParameterGroupsCommand extends $Command< DescribeParameterGroupsCommandInput, diff --git a/clients/client-dax/commands/DescribeParametersCommand.ts b/clients/client-dax/commands/DescribeParametersCommand.ts index 8193ca5b5eb3..127a38087a4d 100644 --- a/clients/client-dax/commands/DescribeParametersCommand.ts +++ b/clients/client-dax/commands/DescribeParametersCommand.ts @@ -22,6 +22,20 @@ export interface DescribeParametersCommandOutput extends DescribeParametersRespo /** *

Returns the detailed parameter list for a particular parameter group.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { DAXClient, DescribeParametersCommand } from "@aws-sdk/client-dax"; // ES Modules import + * // const { DAXClient, DescribeParametersCommand } = require("@aws-sdk/client-dax"); // CommonJS import + * const client = new DAXClient(config); + * const command = new DescribeParametersCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeParametersCommandInput} for command's `input` shape. + * @see {@link DescribeParametersCommandOutput} for command's `response` shape. + * @see {@link DAXClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeParametersCommand extends $Command< DescribeParametersCommandInput, diff --git a/clients/client-dax/commands/DescribeSubnetGroupsCommand.ts b/clients/client-dax/commands/DescribeSubnetGroupsCommand.ts index ad659b687c0a..4621c054781b 100644 --- a/clients/client-dax/commands/DescribeSubnetGroupsCommand.ts +++ b/clients/client-dax/commands/DescribeSubnetGroupsCommand.ts @@ -23,6 +23,20 @@ export interface DescribeSubnetGroupsCommandOutput extends DescribeSubnetGroupsR /** *

Returns a list of subnet group descriptions. If a subnet group name is specified, * the list will contain only the description of that group.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { DAXClient, DescribeSubnetGroupsCommand } from "@aws-sdk/client-dax"; // ES Modules import + * // const { DAXClient, DescribeSubnetGroupsCommand } = require("@aws-sdk/client-dax"); // CommonJS import + * const client = new DAXClient(config); + * const command = new DescribeSubnetGroupsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeSubnetGroupsCommandInput} for command's `input` shape. + * @see {@link DescribeSubnetGroupsCommandOutput} for command's `response` shape. + * @see {@link DAXClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeSubnetGroupsCommand extends $Command< DescribeSubnetGroupsCommandInput, diff --git a/clients/client-dax/commands/IncreaseReplicationFactorCommand.ts b/clients/client-dax/commands/IncreaseReplicationFactorCommand.ts index e54110bd3c9a..82431edfc8b7 100644 --- a/clients/client-dax/commands/IncreaseReplicationFactorCommand.ts +++ b/clients/client-dax/commands/IncreaseReplicationFactorCommand.ts @@ -22,6 +22,20 @@ export interface IncreaseReplicationFactorCommandOutput extends IncreaseReplicat /** *

Adds one or more nodes to a DAX cluster.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { DAXClient, IncreaseReplicationFactorCommand } from "@aws-sdk/client-dax"; // ES Modules import + * // const { DAXClient, IncreaseReplicationFactorCommand } = require("@aws-sdk/client-dax"); // CommonJS import + * const client = new DAXClient(config); + * const command = new IncreaseReplicationFactorCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link IncreaseReplicationFactorCommandInput} for command's `input` shape. + * @see {@link IncreaseReplicationFactorCommandOutput} for command's `response` shape. + * @see {@link DAXClientResolvedConfig | config} for command's `input` shape. + * */ export class IncreaseReplicationFactorCommand extends $Command< IncreaseReplicationFactorCommandInput, diff --git a/clients/client-dax/commands/ListTagsCommand.ts b/clients/client-dax/commands/ListTagsCommand.ts index ee4c1656ee59..845b0137f746 100644 --- a/clients/client-dax/commands/ListTagsCommand.ts +++ b/clients/client-dax/commands/ListTagsCommand.ts @@ -20,6 +20,20 @@ export interface ListTagsCommandOutput extends ListTagsResponse, __MetadataBeare /** *

List all of the tags for a DAX cluster. You can call ListTags up to * 10 times per second, per account.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { DAXClient, ListTagsCommand } from "@aws-sdk/client-dax"; // ES Modules import + * // const { DAXClient, ListTagsCommand } = require("@aws-sdk/client-dax"); // CommonJS import + * const client = new DAXClient(config); + * const command = new ListTagsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListTagsCommandInput} for command's `input` shape. + * @see {@link ListTagsCommandOutput} for command's `response` shape. + * @see {@link DAXClientResolvedConfig | config} for command's `input` shape. + * */ export class ListTagsCommand extends $Command { // Start section: command_properties diff --git a/clients/client-dax/commands/RebootNodeCommand.ts b/clients/client-dax/commands/RebootNodeCommand.ts index a32741dbc673..53405cfcade3 100644 --- a/clients/client-dax/commands/RebootNodeCommand.ts +++ b/clients/client-dax/commands/RebootNodeCommand.ts @@ -28,6 +28,20 @@ export interface RebootNodeCommandOutput extends RebootNodeResponse, __MetadataB *

* RebootNode restarts the DAX engine process and does not remove the contents of the cache.

* + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { DAXClient, RebootNodeCommand } from "@aws-sdk/client-dax"; // ES Modules import + * // const { DAXClient, RebootNodeCommand } = require("@aws-sdk/client-dax"); // CommonJS import + * const client = new DAXClient(config); + * const command = new RebootNodeCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link RebootNodeCommandInput} for command's `input` shape. + * @see {@link RebootNodeCommandOutput} for command's `response` shape. + * @see {@link DAXClientResolvedConfig | config} for command's `input` shape. + * */ export class RebootNodeCommand extends $Command< RebootNodeCommandInput, diff --git a/clients/client-dax/commands/TagResourceCommand.ts b/clients/client-dax/commands/TagResourceCommand.ts index 843323024de7..81930c23b3b7 100644 --- a/clients/client-dax/commands/TagResourceCommand.ts +++ b/clients/client-dax/commands/TagResourceCommand.ts @@ -23,6 +23,20 @@ export interface TagResourceCommandOutput extends TagResourceResponse, __Metadat /** *

Associates a set of tags with a DAX resource. You can call TagResource up to 5 times per second, per * account.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { DAXClient, TagResourceCommand } from "@aws-sdk/client-dax"; // ES Modules import + * // const { DAXClient, TagResourceCommand } = require("@aws-sdk/client-dax"); // CommonJS import + * const client = new DAXClient(config); + * const command = new TagResourceCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link TagResourceCommandInput} for command's `input` shape. + * @see {@link TagResourceCommandOutput} for command's `response` shape. + * @see {@link DAXClientResolvedConfig | config} for command's `input` shape. + * */ export class TagResourceCommand extends $Command< TagResourceCommandInput, diff --git a/clients/client-dax/commands/UntagResourceCommand.ts b/clients/client-dax/commands/UntagResourceCommand.ts index 38f0c1231a52..2d0280203623 100644 --- a/clients/client-dax/commands/UntagResourceCommand.ts +++ b/clients/client-dax/commands/UntagResourceCommand.ts @@ -23,6 +23,20 @@ export interface UntagResourceCommandOutput extends UntagResourceResponse, __Met /** *

Removes the association of tags from a DAX resource. You can call * UntagResource up to 5 times per second, per account.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { DAXClient, UntagResourceCommand } from "@aws-sdk/client-dax"; // ES Modules import + * // const { DAXClient, UntagResourceCommand } = require("@aws-sdk/client-dax"); // CommonJS import + * const client = new DAXClient(config); + * const command = new UntagResourceCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link UntagResourceCommandInput} for command's `input` shape. + * @see {@link UntagResourceCommandOutput} for command's `response` shape. + * @see {@link DAXClientResolvedConfig | config} for command's `input` shape. + * */ export class UntagResourceCommand extends $Command< UntagResourceCommandInput, diff --git a/clients/client-dax/commands/UpdateClusterCommand.ts b/clients/client-dax/commands/UpdateClusterCommand.ts index 2ce08cb46390..1e99cd962c20 100644 --- a/clients/client-dax/commands/UpdateClusterCommand.ts +++ b/clients/client-dax/commands/UpdateClusterCommand.ts @@ -24,6 +24,20 @@ export interface UpdateClusterCommandOutput extends UpdateClusterResponse, __Met *

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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { DAXClient, UpdateClusterCommand } from "@aws-sdk/client-dax"; // ES Modules import + * // const { DAXClient, UpdateClusterCommand } = require("@aws-sdk/client-dax"); // CommonJS import + * const client = new DAXClient(config); + * const command = new UpdateClusterCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link UpdateClusterCommandInput} for command's `input` shape. + * @see {@link UpdateClusterCommandOutput} for command's `response` shape. + * @see {@link DAXClientResolvedConfig | config} for command's `input` shape. + * */ export class UpdateClusterCommand extends $Command< UpdateClusterCommandInput, diff --git a/clients/client-dax/commands/UpdateParameterGroupCommand.ts b/clients/client-dax/commands/UpdateParameterGroupCommand.ts index c22d41542d2d..d872f1b2babc 100644 --- a/clients/client-dax/commands/UpdateParameterGroupCommand.ts +++ b/clients/client-dax/commands/UpdateParameterGroupCommand.ts @@ -24,6 +24,20 @@ export interface UpdateParameterGroupCommandOutput extends UpdateParameterGroupR *

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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { DAXClient, UpdateParameterGroupCommand } from "@aws-sdk/client-dax"; // ES Modules import + * // const { DAXClient, UpdateParameterGroupCommand } = require("@aws-sdk/client-dax"); // CommonJS import + * const client = new DAXClient(config); + * const command = new UpdateParameterGroupCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link UpdateParameterGroupCommandInput} for command's `input` shape. + * @see {@link UpdateParameterGroupCommandOutput} for command's `response` shape. + * @see {@link DAXClientResolvedConfig | config} for command's `input` shape. + * */ export class UpdateParameterGroupCommand extends $Command< UpdateParameterGroupCommandInput, diff --git a/clients/client-dax/commands/UpdateSubnetGroupCommand.ts b/clients/client-dax/commands/UpdateSubnetGroupCommand.ts index f56702e865a7..95bc1d1c953f 100644 --- a/clients/client-dax/commands/UpdateSubnetGroupCommand.ts +++ b/clients/client-dax/commands/UpdateSubnetGroupCommand.ts @@ -22,6 +22,20 @@ export interface UpdateSubnetGroupCommandOutput extends UpdateSubnetGroupRespons /** *

Modifies an existing subnet group.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { DAXClient, UpdateSubnetGroupCommand } from "@aws-sdk/client-dax"; // ES Modules import + * // const { DAXClient, UpdateSubnetGroupCommand } = require("@aws-sdk/client-dax"); // CommonJS import + * const client = new DAXClient(config); + * const command = new UpdateSubnetGroupCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link UpdateSubnetGroupCommandInput} for command's `input` shape. + * @see {@link UpdateSubnetGroupCommandOutput} for command's `response` shape. + * @see {@link DAXClientResolvedConfig | config} for command's `input` shape. + * */ export class UpdateSubnetGroupCommand extends $Command< UpdateSubnetGroupCommandInput, diff --git a/clients/client-dax/models/models_0.ts b/clients/client-dax/models/models_0.ts index 29f861fb2070..2660373070fc 100644 --- a/clients/client-dax/models/models_0.ts +++ b/clients/client-dax/models/models_0.ts @@ -11,6 +11,9 @@ export interface ClusterAlreadyExistsFault extends __SmithyException, $MetadataB } export namespace ClusterAlreadyExistsFault { + /** + * @internal + */ export const filterSensitiveLog = (obj: ClusterAlreadyExistsFault): any => ({ ...obj, }); @@ -27,6 +30,9 @@ export interface ClusterQuotaForCustomerExceededFault extends __SmithyException, } export namespace ClusterQuotaForCustomerExceededFault { + /** + * @internal + */ export const filterSensitiveLog = (obj: ClusterQuotaForCustomerExceededFault): any => ({ ...obj, }); @@ -43,6 +49,9 @@ export interface SSESpecification { } export namespace SSESpecification { + /** + * @internal + */ export const filterSensitiveLog = (obj: SSESpecification): any => ({ ...obj, }); @@ -71,6 +80,9 @@ export interface Tag { } export namespace Tag { + /** + * @internal + */ export const filterSensitiveLog = (obj: Tag): any => ({ ...obj, }); @@ -230,6 +242,9 @@ export interface CreateClusterRequest { } export namespace CreateClusterRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateClusterRequest): any => ({ ...obj, }); @@ -253,6 +268,9 @@ export interface Endpoint { } export namespace Endpoint { + /** + * @internal + */ export const filterSensitiveLog = (obj: Endpoint): any => ({ ...obj, }); @@ -298,6 +316,9 @@ export interface Node { } export namespace Node { + /** + * @internal + */ export const filterSensitiveLog = (obj: Node): any => ({ ...obj, }); @@ -321,6 +342,9 @@ export interface NotificationConfiguration { } export namespace NotificationConfiguration { + /** + * @internal + */ export const filterSensitiveLog = (obj: NotificationConfiguration): any => ({ ...obj, }); @@ -347,6 +371,9 @@ export interface ParameterGroupStatus { } export namespace ParameterGroupStatus { + /** + * @internal + */ export const filterSensitiveLog = (obj: ParameterGroupStatus): any => ({ ...obj, }); @@ -368,6 +395,9 @@ export interface SecurityGroupMembership { } export namespace SecurityGroupMembership { + /** + * @internal + */ export const filterSensitiveLog = (obj: SecurityGroupMembership): any => ({ ...obj, }); @@ -404,6 +434,9 @@ export interface SSEDescription { } export namespace SSEDescription { + /** + * @internal + */ export const filterSensitiveLog = (obj: SSEDescription): any => ({ ...obj, }); @@ -512,6 +545,9 @@ export interface Cluster { } export namespace Cluster { + /** + * @internal + */ export const filterSensitiveLog = (obj: Cluster): any => ({ ...obj, }); @@ -525,6 +561,9 @@ export interface CreateClusterResponse { } export namespace CreateClusterResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateClusterResponse): any => ({ ...obj, }); @@ -541,6 +580,9 @@ export interface InsufficientClusterCapacityFault extends __SmithyException, $Me } export namespace InsufficientClusterCapacityFault { + /** + * @internal + */ export const filterSensitiveLog = (obj: InsufficientClusterCapacityFault): any => ({ ...obj, }); @@ -557,6 +599,9 @@ export interface InvalidClusterStateFault extends __SmithyException, $MetadataBe } export namespace InvalidClusterStateFault { + /** + * @internal + */ export const filterSensitiveLog = (obj: InvalidClusterStateFault): any => ({ ...obj, }); @@ -572,6 +617,9 @@ export interface InvalidParameterCombinationException extends __SmithyException, } export namespace InvalidParameterCombinationException { + /** + * @internal + */ export const filterSensitiveLog = (obj: InvalidParameterCombinationException): any => ({ ...obj, }); @@ -587,6 +635,9 @@ export interface InvalidParameterGroupStateFault extends __SmithyException, $Met } export namespace InvalidParameterGroupStateFault { + /** + * @internal + */ export const filterSensitiveLog = (obj: InvalidParameterGroupStateFault): any => ({ ...obj, }); @@ -602,6 +653,9 @@ export interface InvalidParameterValueException extends __SmithyException, $Meta } export namespace InvalidParameterValueException { + /** + * @internal + */ export const filterSensitiveLog = (obj: InvalidParameterValueException): any => ({ ...obj, }); @@ -617,6 +671,9 @@ export interface InvalidVPCNetworkStateFault extends __SmithyException, $Metadat } export namespace InvalidVPCNetworkStateFault { + /** + * @internal + */ export const filterSensitiveLog = (obj: InvalidVPCNetworkStateFault): any => ({ ...obj, }); @@ -633,6 +690,9 @@ export interface NodeQuotaForClusterExceededFault extends __SmithyException, $Me } export namespace NodeQuotaForClusterExceededFault { + /** + * @internal + */ export const filterSensitiveLog = (obj: NodeQuotaForClusterExceededFault): any => ({ ...obj, }); @@ -649,6 +709,9 @@ export interface NodeQuotaForCustomerExceededFault extends __SmithyException, $M } export namespace NodeQuotaForCustomerExceededFault { + /** + * @internal + */ export const filterSensitiveLog = (obj: NodeQuotaForCustomerExceededFault): any => ({ ...obj, }); @@ -664,6 +727,9 @@ export interface ParameterGroupNotFoundFault extends __SmithyException, $Metadat } export namespace ParameterGroupNotFoundFault { + /** + * @internal + */ export const filterSensitiveLog = (obj: ParameterGroupNotFoundFault): any => ({ ...obj, }); @@ -679,6 +745,9 @@ export interface ServiceLinkedRoleNotFoundFault extends __SmithyException, $Meta } export namespace ServiceLinkedRoleNotFoundFault { + /** + * @internal + */ export const filterSensitiveLog = (obj: ServiceLinkedRoleNotFoundFault): any => ({ ...obj, }); @@ -695,6 +764,9 @@ export interface SubnetGroupNotFoundFault extends __SmithyException, $MetadataBe } export namespace SubnetGroupNotFoundFault { + /** + * @internal + */ export const filterSensitiveLog = (obj: SubnetGroupNotFoundFault): any => ({ ...obj, }); @@ -710,6 +782,9 @@ export interface TagQuotaPerResourceExceeded extends __SmithyException, $Metadat } export namespace TagQuotaPerResourceExceeded { + /** + * @internal + */ export const filterSensitiveLog = (obj: TagQuotaPerResourceExceeded): any => ({ ...obj, }); @@ -729,6 +804,9 @@ export interface CreateParameterGroupRequest { } export namespace CreateParameterGroupRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateParameterGroupRequest): any => ({ ...obj, }); @@ -751,6 +829,9 @@ export interface ParameterGroup { } export namespace ParameterGroup { + /** + * @internal + */ export const filterSensitiveLog = (obj: ParameterGroup): any => ({ ...obj, }); @@ -765,6 +846,9 @@ export interface CreateParameterGroupResponse { } export namespace CreateParameterGroupResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateParameterGroupResponse): any => ({ ...obj, }); @@ -780,6 +864,9 @@ export interface ParameterGroupAlreadyExistsFault extends __SmithyException, $Me } export namespace ParameterGroupAlreadyExistsFault { + /** + * @internal + */ export const filterSensitiveLog = (obj: ParameterGroupAlreadyExistsFault): any => ({ ...obj, }); @@ -795,6 +882,9 @@ export interface ParameterGroupQuotaExceededFault extends __SmithyException, $Me } export namespace ParameterGroupQuotaExceededFault { + /** + * @internal + */ export const filterSensitiveLog = (obj: ParameterGroupQuotaExceededFault): any => ({ ...obj, }); @@ -818,6 +908,9 @@ export interface CreateSubnetGroupRequest { } export namespace CreateSubnetGroupRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateSubnetGroupRequest): any => ({ ...obj, }); @@ -841,6 +934,9 @@ export interface Subnet { } export namespace Subnet { + /** + * @internal + */ export const filterSensitiveLog = (obj: Subnet): any => ({ ...obj, }); @@ -884,6 +980,9 @@ export interface SubnetGroup { } export namespace SubnetGroup { + /** + * @internal + */ export const filterSensitiveLog = (obj: SubnetGroup): any => ({ ...obj, }); @@ -898,6 +997,9 @@ export interface CreateSubnetGroupResponse { } export namespace CreateSubnetGroupResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateSubnetGroupResponse): any => ({ ...obj, }); @@ -913,6 +1015,9 @@ export interface InvalidSubnet extends __SmithyException, $MetadataBearer { } export namespace InvalidSubnet { + /** + * @internal + */ export const filterSensitiveLog = (obj: InvalidSubnet): any => ({ ...obj, }); @@ -928,6 +1033,9 @@ export interface SubnetGroupAlreadyExistsFault extends __SmithyException, $Metad } export namespace SubnetGroupAlreadyExistsFault { + /** + * @internal + */ export const filterSensitiveLog = (obj: SubnetGroupAlreadyExistsFault): any => ({ ...obj, }); @@ -944,6 +1052,9 @@ export interface SubnetGroupQuotaExceededFault extends __SmithyException, $Metad } export namespace SubnetGroupQuotaExceededFault { + /** + * @internal + */ export const filterSensitiveLog = (obj: SubnetGroupQuotaExceededFault): any => ({ ...obj, }); @@ -960,6 +1071,9 @@ export interface SubnetQuotaExceededFault extends __SmithyException, $MetadataBe } export namespace SubnetQuotaExceededFault { + /** + * @internal + */ export const filterSensitiveLog = (obj: SubnetQuotaExceededFault): any => ({ ...obj, }); @@ -975,6 +1089,9 @@ export interface ClusterNotFoundFault extends __SmithyException, $MetadataBearer } export namespace ClusterNotFoundFault { + /** + * @internal + */ export const filterSensitiveLog = (obj: ClusterNotFoundFault): any => ({ ...obj, }); @@ -1003,6 +1120,9 @@ export interface DecreaseReplicationFactorRequest { } export namespace DecreaseReplicationFactorRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DecreaseReplicationFactorRequest): any => ({ ...obj, }); @@ -1017,6 +1137,9 @@ export interface DecreaseReplicationFactorResponse { } export namespace DecreaseReplicationFactorResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DecreaseReplicationFactorResponse): any => ({ ...obj, }); @@ -1032,6 +1155,9 @@ export interface NodeNotFoundFault extends __SmithyException, $MetadataBearer { } export namespace NodeNotFoundFault { + /** + * @internal + */ export const filterSensitiveLog = (obj: NodeNotFoundFault): any => ({ ...obj, }); @@ -1045,6 +1171,9 @@ export interface DeleteClusterRequest { } export namespace DeleteClusterRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteClusterRequest): any => ({ ...obj, }); @@ -1058,6 +1187,9 @@ export interface DeleteClusterResponse { } export namespace DeleteClusterResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteClusterResponse): any => ({ ...obj, }); @@ -1071,6 +1203,9 @@ export interface DeleteParameterGroupRequest { } export namespace DeleteParameterGroupRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteParameterGroupRequest): any => ({ ...obj, }); @@ -1085,6 +1220,9 @@ export interface DeleteParameterGroupResponse { } export namespace DeleteParameterGroupResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteParameterGroupResponse): any => ({ ...obj, }); @@ -1098,6 +1236,9 @@ export interface DeleteSubnetGroupRequest { } export namespace DeleteSubnetGroupRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteSubnetGroupRequest): any => ({ ...obj, }); @@ -1112,6 +1253,9 @@ export interface DeleteSubnetGroupResponse { } export namespace DeleteSubnetGroupResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteSubnetGroupResponse): any => ({ ...obj, }); @@ -1127,6 +1271,9 @@ export interface SubnetGroupInUseFault extends __SmithyException, $MetadataBeare } export namespace SubnetGroupInUseFault { + /** + * @internal + */ export const filterSensitiveLog = (obj: SubnetGroupInUseFault): any => ({ ...obj, }); @@ -1156,6 +1303,9 @@ export interface DescribeClustersRequest { } export namespace DescribeClustersRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeClustersRequest): any => ({ ...obj, }); @@ -1175,6 +1325,9 @@ export interface DescribeClustersResponse { } export namespace DescribeClustersResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeClustersResponse): any => ({ ...obj, }); @@ -1199,6 +1352,9 @@ export interface DescribeDefaultParametersRequest { } export namespace DescribeDefaultParametersRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeDefaultParametersRequest): any => ({ ...obj, }); @@ -1225,6 +1381,9 @@ export interface NodeTypeSpecificValue { } export namespace NodeTypeSpecificValue { + /** + * @internal + */ export const filterSensitiveLog = (obj: NodeTypeSpecificValue): any => ({ ...obj, }); @@ -1293,6 +1452,9 @@ export interface Parameter { } export namespace Parameter { + /** + * @internal + */ export const filterSensitiveLog = (obj: Parameter): any => ({ ...obj, }); @@ -1311,6 +1473,9 @@ export interface DescribeDefaultParametersResponse { } export namespace DescribeDefaultParametersResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeDefaultParametersResponse): any => ({ ...obj, }); @@ -1366,6 +1531,9 @@ export interface DescribeEventsRequest { } export namespace DescribeEventsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeEventsRequest): any => ({ ...obj, }); @@ -1401,6 +1569,9 @@ export interface Event { } export namespace Event { + /** + * @internal + */ export const filterSensitiveLog = (obj: Event): any => ({ ...obj, }); @@ -1419,6 +1590,9 @@ export interface DescribeEventsResponse { } export namespace DescribeEventsResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeEventsResponse): any => ({ ...obj, }); @@ -1448,6 +1622,9 @@ export interface DescribeParameterGroupsRequest { } export namespace DescribeParameterGroupsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeParameterGroupsRequest): any => ({ ...obj, }); @@ -1466,6 +1643,9 @@ export interface DescribeParameterGroupsResponse { } export namespace DescribeParameterGroupsResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeParameterGroupsResponse): any => ({ ...obj, }); @@ -1501,6 +1681,9 @@ export interface DescribeParametersRequest { } export namespace DescribeParametersRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeParametersRequest): any => ({ ...obj, }); @@ -1519,6 +1702,9 @@ export interface DescribeParametersResponse { } export namespace DescribeParametersResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeParametersResponse): any => ({ ...obj, }); @@ -1548,6 +1734,9 @@ export interface DescribeSubnetGroupsRequest { } export namespace DescribeSubnetGroupsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeSubnetGroupsRequest): any => ({ ...obj, }); @@ -1566,6 +1755,9 @@ export interface DescribeSubnetGroupsResponse { } export namespace DescribeSubnetGroupsResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeSubnetGroupsResponse): any => ({ ...obj, }); @@ -1591,6 +1783,9 @@ export interface IncreaseReplicationFactorRequest { } export namespace IncreaseReplicationFactorRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: IncreaseReplicationFactorRequest): any => ({ ...obj, }); @@ -1604,6 +1799,9 @@ export interface IncreaseReplicationFactorResponse { } export namespace IncreaseReplicationFactorResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: IncreaseReplicationFactorResponse): any => ({ ...obj, }); @@ -1619,6 +1817,9 @@ export interface InvalidARNFault extends __SmithyException, $MetadataBearer { } export namespace InvalidARNFault { + /** + * @internal + */ export const filterSensitiveLog = (obj: InvalidARNFault): any => ({ ...obj, }); @@ -1639,6 +1840,9 @@ export interface ListTagsRequest { } export namespace ListTagsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListTagsRequest): any => ({ ...obj, }); @@ -1658,6 +1862,9 @@ export interface ListTagsResponse { } export namespace ListTagsResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListTagsResponse): any => ({ ...obj, }); @@ -1676,6 +1883,9 @@ export interface RebootNodeRequest { } export namespace RebootNodeRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: RebootNodeRequest): any => ({ ...obj, }); @@ -1689,6 +1899,9 @@ export interface RebootNodeResponse { } export namespace RebootNodeResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: RebootNodeResponse): any => ({ ...obj, }); @@ -1707,6 +1920,9 @@ export interface TagResourceRequest { } export namespace TagResourceRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: TagResourceRequest): any => ({ ...obj, }); @@ -1720,6 +1936,9 @@ export interface TagResourceResponse { } export namespace TagResourceResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: TagResourceResponse): any => ({ ...obj, }); @@ -1735,6 +1954,9 @@ export interface TagNotFoundFault extends __SmithyException, $MetadataBearer { } export namespace TagNotFoundFault { + /** + * @internal + */ export const filterSensitiveLog = (obj: TagNotFoundFault): any => ({ ...obj, }); @@ -1753,6 +1975,9 @@ export interface UntagResourceRequest { } export namespace UntagResourceRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: UntagResourceRequest): any => ({ ...obj, }); @@ -1766,6 +1991,9 @@ export interface UntagResourceResponse { } export namespace UntagResourceResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: UntagResourceResponse): any => ({ ...obj, }); @@ -1812,6 +2040,9 @@ export interface UpdateClusterRequest { } export namespace UpdateClusterRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateClusterRequest): any => ({ ...obj, }); @@ -1825,6 +2056,9 @@ export interface UpdateClusterResponse { } export namespace UpdateClusterResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateClusterResponse): any => ({ ...obj, }); @@ -1846,6 +2080,9 @@ export interface ParameterNameValue { } export namespace ParameterNameValue { + /** + * @internal + */ export const filterSensitiveLog = (obj: ParameterNameValue): any => ({ ...obj, }); @@ -1865,6 +2102,9 @@ export interface UpdateParameterGroupRequest { } export namespace UpdateParameterGroupRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateParameterGroupRequest): any => ({ ...obj, }); @@ -1878,6 +2118,9 @@ export interface UpdateParameterGroupResponse { } export namespace UpdateParameterGroupResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateParameterGroupResponse): any => ({ ...obj, }); @@ -1893,6 +2136,9 @@ export interface SubnetInUse extends __SmithyException, $MetadataBearer { } export namespace SubnetInUse { + /** + * @internal + */ export const filterSensitiveLog = (obj: SubnetInUse): any => ({ ...obj, }); @@ -1916,6 +2162,9 @@ export interface UpdateSubnetGroupRequest { } export namespace UpdateSubnetGroupRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateSubnetGroupRequest): any => ({ ...obj, }); @@ -1929,6 +2178,9 @@ export interface UpdateSubnetGroupResponse { } export namespace UpdateSubnetGroupResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateSubnetGroupResponse): any => ({ ...obj, }); diff --git a/clients/client-detective/commands/AcceptInvitationCommand.ts b/clients/client-detective/commands/AcceptInvitationCommand.ts index ae384b2bc50a..4b43630e8b0e 100644 --- a/clients/client-detective/commands/AcceptInvitationCommand.ts +++ b/clients/client-detective/commands/AcceptInvitationCommand.ts @@ -25,6 +25,20 @@ export interface AcceptInvitationCommandOutput extends __MetadataBearer {} * 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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { DetectiveClient, AcceptInvitationCommand } from "@aws-sdk/client-detective"; // ES Modules import + * // const { DetectiveClient, AcceptInvitationCommand } = require("@aws-sdk/client-detective"); // CommonJS import + * const client = new DetectiveClient(config); + * const command = new AcceptInvitationCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link AcceptInvitationCommandInput} for command's `input` shape. + * @see {@link AcceptInvitationCommandOutput} for command's `response` shape. + * @see {@link DetectiveClientResolvedConfig | config} for command's `input` shape. + * */ export class AcceptInvitationCommand extends $Command< AcceptInvitationCommandInput, diff --git a/clients/client-detective/commands/CreateGraphCommand.ts b/clients/client-detective/commands/CreateGraphCommand.ts index 0264567e1399..9e7a150d4e7f 100644 --- a/clients/client-detective/commands/CreateGraphCommand.ts +++ b/clients/client-detective/commands/CreateGraphCommand.ts @@ -37,6 +37,20 @@ export interface CreateGraphCommandOutput extends CreateGraphResponse, __Metadat *

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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { DetectiveClient, CreateGraphCommand } from "@aws-sdk/client-detective"; // ES Modules import + * // const { DetectiveClient, CreateGraphCommand } = require("@aws-sdk/client-detective"); // CommonJS import + * const client = new DetectiveClient(config); + * const command = new CreateGraphCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreateGraphCommandInput} for command's `input` shape. + * @see {@link CreateGraphCommandOutput} for command's `response` shape. + * @see {@link DetectiveClientResolvedConfig | config} for command's `input` shape. + * */ export class CreateGraphCommand extends $Command< CreateGraphCommandInput, diff --git a/clients/client-detective/commands/CreateMembersCommand.ts b/clients/client-detective/commands/CreateMembersCommand.ts index 4bc851f0c5cf..2cb9fb0d184f 100644 --- a/clients/client-detective/commands/CreateMembersCommand.ts +++ b/clients/client-detective/commands/CreateMembersCommand.ts @@ -43,6 +43,20 @@ export interface CreateMembersCommandOutput extends CreateMembersResponse, __Met * graph.

* * + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { DetectiveClient, CreateMembersCommand } from "@aws-sdk/client-detective"; // ES Modules import + * // const { DetectiveClient, CreateMembersCommand } = require("@aws-sdk/client-detective"); // CommonJS import + * const client = new DetectiveClient(config); + * const command = new CreateMembersCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreateMembersCommandInput} for command's `input` shape. + * @see {@link CreateMembersCommandOutput} for command's `response` shape. + * @see {@link DetectiveClientResolvedConfig | config} for command's `input` shape. + * */ export class CreateMembersCommand extends $Command< CreateMembersCommandInput, diff --git a/clients/client-detective/commands/DeleteGraphCommand.ts b/clients/client-detective/commands/DeleteGraphCommand.ts index 43f4861eaed7..127213ff353e 100644 --- a/clients/client-detective/commands/DeleteGraphCommand.ts +++ b/clients/client-detective/commands/DeleteGraphCommand.ts @@ -26,6 +26,20 @@ export interface DeleteGraphCommandOutput extends __MetadataBearer {} *

* DeleteGraph can only be called by the administrator account for a behavior * graph.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { DetectiveClient, DeleteGraphCommand } from "@aws-sdk/client-detective"; // ES Modules import + * // const { DetectiveClient, DeleteGraphCommand } = require("@aws-sdk/client-detective"); // CommonJS import + * const client = new DetectiveClient(config); + * const command = new DeleteGraphCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteGraphCommandInput} for command's `input` shape. + * @see {@link DeleteGraphCommandOutput} for command's `response` shape. + * @see {@link DetectiveClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteGraphCommand extends $Command< DeleteGraphCommandInput, diff --git a/clients/client-detective/commands/DeleteMembersCommand.ts b/clients/client-detective/commands/DeleteMembersCommand.ts index a49b132be608..d2b1d9c1b208 100644 --- a/clients/client-detective/commands/DeleteMembersCommand.ts +++ b/clients/client-detective/commands/DeleteMembersCommand.ts @@ -26,6 +26,20 @@ export interface DeleteMembersCommandOutput extends DeleteMembersResponse, __Met * DeleteMembers to delete their own account from the behavior graph. To * disable a behavior graph, the administrator account uses the DeleteGraph API * method.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { DetectiveClient, DeleteMembersCommand } from "@aws-sdk/client-detective"; // ES Modules import + * // const { DetectiveClient, DeleteMembersCommand } = require("@aws-sdk/client-detective"); // CommonJS import + * const client = new DetectiveClient(config); + * const command = new DeleteMembersCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteMembersCommandInput} for command's `input` shape. + * @see {@link DeleteMembersCommandOutput} for command's `response` shape. + * @see {@link DetectiveClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteMembersCommand extends $Command< DeleteMembersCommandInput, diff --git a/clients/client-detective/commands/DisassociateMembershipCommand.ts b/clients/client-detective/commands/DisassociateMembershipCommand.ts index 6953c220e937..237189af6e4e 100644 --- a/clients/client-detective/commands/DisassociateMembershipCommand.ts +++ b/clients/client-detective/commands/DisassociateMembershipCommand.ts @@ -23,6 +23,20 @@ export interface DisassociateMembershipCommandOutput extends __MetadataBearer {} /** *

Removes the member account from the specified behavior graph. This operation can only be * called by a member account that has the ENABLED status.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { DetectiveClient, DisassociateMembershipCommand } from "@aws-sdk/client-detective"; // ES Modules import + * // const { DetectiveClient, DisassociateMembershipCommand } = require("@aws-sdk/client-detective"); // CommonJS import + * const client = new DetectiveClient(config); + * const command = new DisassociateMembershipCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DisassociateMembershipCommandInput} for command's `input` shape. + * @see {@link DisassociateMembershipCommandOutput} for command's `response` shape. + * @see {@link DetectiveClientResolvedConfig | config} for command's `input` shape. + * */ export class DisassociateMembershipCommand extends $Command< DisassociateMembershipCommandInput, diff --git a/clients/client-detective/commands/GetMembersCommand.ts b/clients/client-detective/commands/GetMembersCommand.ts index 3ed5d0dc27bd..80c1e3952711 100644 --- a/clients/client-detective/commands/GetMembersCommand.ts +++ b/clients/client-detective/commands/GetMembersCommand.ts @@ -23,6 +23,20 @@ export interface GetMembersCommandOutput extends GetMembersResponse, __MetadataB /** *

Returns the membership details for specified member accounts for a behavior * graph.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { DetectiveClient, GetMembersCommand } from "@aws-sdk/client-detective"; // ES Modules import + * // const { DetectiveClient, GetMembersCommand } = require("@aws-sdk/client-detective"); // CommonJS import + * const client = new DetectiveClient(config); + * const command = new GetMembersCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetMembersCommandInput} for command's `input` shape. + * @see {@link GetMembersCommandOutput} for command's `response` shape. + * @see {@link DetectiveClientResolvedConfig | config} for command's `input` shape. + * */ export class GetMembersCommand extends $Command< GetMembersCommandInput, diff --git a/clients/client-detective/commands/ListGraphsCommand.ts b/clients/client-detective/commands/ListGraphsCommand.ts index a3fc03154ffa..06fd0e6472e9 100644 --- a/clients/client-detective/commands/ListGraphsCommand.ts +++ b/clients/client-detective/commands/ListGraphsCommand.ts @@ -25,6 +25,20 @@ export interface ListGraphsCommandOutput extends ListGraphsResponse, __MetadataB * 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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { DetectiveClient, ListGraphsCommand } from "@aws-sdk/client-detective"; // ES Modules import + * // const { DetectiveClient, ListGraphsCommand } = require("@aws-sdk/client-detective"); // CommonJS import + * const client = new DetectiveClient(config); + * const command = new ListGraphsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListGraphsCommandInput} for command's `input` shape. + * @see {@link ListGraphsCommandOutput} for command's `response` shape. + * @see {@link DetectiveClientResolvedConfig | config} for command's `input` shape. + * */ export class ListGraphsCommand extends $Command< ListGraphsCommandInput, diff --git a/clients/client-detective/commands/ListInvitationsCommand.ts b/clients/client-detective/commands/ListInvitationsCommand.ts index 329e2782d15a..be79853af1be 100644 --- a/clients/client-detective/commands/ListInvitationsCommand.ts +++ b/clients/client-detective/commands/ListInvitationsCommand.ts @@ -27,6 +27,20 @@ export interface ListInvitationsCommandOutput extends ListInvitationsResponse, _ *

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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { DetectiveClient, ListInvitationsCommand } from "@aws-sdk/client-detective"; // ES Modules import + * // const { DetectiveClient, ListInvitationsCommand } = require("@aws-sdk/client-detective"); // CommonJS import + * const client = new DetectiveClient(config); + * const command = new ListInvitationsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListInvitationsCommandInput} for command's `input` shape. + * @see {@link ListInvitationsCommandOutput} for command's `response` shape. + * @see {@link DetectiveClientResolvedConfig | config} for command's `input` shape. + * */ export class ListInvitationsCommand extends $Command< ListInvitationsCommandInput, diff --git a/clients/client-detective/commands/ListMembersCommand.ts b/clients/client-detective/commands/ListMembersCommand.ts index 9b8e6546456a..86df908a2d4e 100644 --- a/clients/client-detective/commands/ListMembersCommand.ts +++ b/clients/client-detective/commands/ListMembersCommand.ts @@ -23,6 +23,20 @@ export interface ListMembersCommandOutput extends ListMembersResponse, __Metadat /** *

Retrieves the list of member accounts for a behavior graph. Does not return member * accounts that were removed from the behavior graph.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { DetectiveClient, ListMembersCommand } from "@aws-sdk/client-detective"; // ES Modules import + * // const { DetectiveClient, ListMembersCommand } = require("@aws-sdk/client-detective"); // CommonJS import + * const client = new DetectiveClient(config); + * const command = new ListMembersCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListMembersCommandInput} for command's `input` shape. + * @see {@link ListMembersCommandOutput} for command's `response` shape. + * @see {@link DetectiveClientResolvedConfig | config} for command's `input` shape. + * */ export class ListMembersCommand extends $Command< ListMembersCommandInput, diff --git a/clients/client-detective/commands/ListTagsForResourceCommand.ts b/clients/client-detective/commands/ListTagsForResourceCommand.ts index 2c4cf52358eb..d9da119a1f51 100644 --- a/clients/client-detective/commands/ListTagsForResourceCommand.ts +++ b/clients/client-detective/commands/ListTagsForResourceCommand.ts @@ -22,6 +22,20 @@ export interface ListTagsForResourceCommandOutput extends ListTagsForResourceRes /** *

Returns the tag values that are assigned to a behavior graph.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { DetectiveClient, ListTagsForResourceCommand } from "@aws-sdk/client-detective"; // ES Modules import + * // const { DetectiveClient, ListTagsForResourceCommand } = require("@aws-sdk/client-detective"); // CommonJS import + * const client = new DetectiveClient(config); + * const command = new ListTagsForResourceCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListTagsForResourceCommandInput} for command's `input` shape. + * @see {@link ListTagsForResourceCommandOutput} for command's `response` shape. + * @see {@link DetectiveClientResolvedConfig | config} for command's `input` shape. + * */ export class ListTagsForResourceCommand extends $Command< ListTagsForResourceCommandInput, diff --git a/clients/client-detective/commands/RejectInvitationCommand.ts b/clients/client-detective/commands/RejectInvitationCommand.ts index 26b3a531ac32..7e1730be4ba9 100644 --- a/clients/client-detective/commands/RejectInvitationCommand.ts +++ b/clients/client-detective/commands/RejectInvitationCommand.ts @@ -23,6 +23,20 @@ export interface RejectInvitationCommandOutput extends __MetadataBearer {} /** *

Rejects an invitation to contribute the account data to a behavior graph. This operation * must be called by a member account that has the INVITED status.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { DetectiveClient, RejectInvitationCommand } from "@aws-sdk/client-detective"; // ES Modules import + * // const { DetectiveClient, RejectInvitationCommand } = require("@aws-sdk/client-detective"); // CommonJS import + * const client = new DetectiveClient(config); + * const command = new RejectInvitationCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link RejectInvitationCommandInput} for command's `input` shape. + * @see {@link RejectInvitationCommandOutput} for command's `response` shape. + * @see {@link DetectiveClientResolvedConfig | config} for command's `input` shape. + * */ export class RejectInvitationCommand extends $Command< RejectInvitationCommandInput, diff --git a/clients/client-detective/commands/StartMonitoringMemberCommand.ts b/clients/client-detective/commands/StartMonitoringMemberCommand.ts index dc9d0934f3af..05c0669e77e2 100644 --- a/clients/client-detective/commands/StartMonitoringMemberCommand.ts +++ b/clients/client-detective/commands/StartMonitoringMemberCommand.ts @@ -34,6 +34,20 @@ export interface StartMonitoringMemberCommandOutput extends __MetadataBearer {} * ACCEPTED_BUT_DISABLED.

* * + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { DetectiveClient, StartMonitoringMemberCommand } from "@aws-sdk/client-detective"; // ES Modules import + * // const { DetectiveClient, StartMonitoringMemberCommand } = require("@aws-sdk/client-detective"); // CommonJS import + * const client = new DetectiveClient(config); + * const command = new StartMonitoringMemberCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link StartMonitoringMemberCommandInput} for command's `input` shape. + * @see {@link StartMonitoringMemberCommandOutput} for command's `response` shape. + * @see {@link DetectiveClientResolvedConfig | config} for command's `input` shape. + * */ export class StartMonitoringMemberCommand extends $Command< StartMonitoringMemberCommandInput, diff --git a/clients/client-detective/commands/TagResourceCommand.ts b/clients/client-detective/commands/TagResourceCommand.ts index ca4d5d7a847b..e99599e1de08 100644 --- a/clients/client-detective/commands/TagResourceCommand.ts +++ b/clients/client-detective/commands/TagResourceCommand.ts @@ -22,6 +22,20 @@ export interface TagResourceCommandOutput extends TagResourceResponse, __Metadat /** *

Applies tag values to a behavior graph.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { DetectiveClient, TagResourceCommand } from "@aws-sdk/client-detective"; // ES Modules import + * // const { DetectiveClient, TagResourceCommand } = require("@aws-sdk/client-detective"); // CommonJS import + * const client = new DetectiveClient(config); + * const command = new TagResourceCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link TagResourceCommandInput} for command's `input` shape. + * @see {@link TagResourceCommandOutput} for command's `response` shape. + * @see {@link DetectiveClientResolvedConfig | config} for command's `input` shape. + * */ export class TagResourceCommand extends $Command< TagResourceCommandInput, diff --git a/clients/client-detective/commands/UntagResourceCommand.ts b/clients/client-detective/commands/UntagResourceCommand.ts index f93fe180a258..5dcd14298ea1 100644 --- a/clients/client-detective/commands/UntagResourceCommand.ts +++ b/clients/client-detective/commands/UntagResourceCommand.ts @@ -22,6 +22,20 @@ export interface UntagResourceCommandOutput extends UntagResourceResponse, __Met /** *

Removes tags from a behavior graph.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { DetectiveClient, UntagResourceCommand } from "@aws-sdk/client-detective"; // ES Modules import + * // const { DetectiveClient, UntagResourceCommand } = require("@aws-sdk/client-detective"); // CommonJS import + * const client = new DetectiveClient(config); + * const command = new UntagResourceCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link UntagResourceCommandInput} for command's `input` shape. + * @see {@link UntagResourceCommandOutput} for command's `response` shape. + * @see {@link DetectiveClientResolvedConfig | config} for command's `input` shape. + * */ export class UntagResourceCommand extends $Command< UntagResourceCommandInput, diff --git a/clients/client-detective/models/models_0.ts b/clients/client-detective/models/models_0.ts index 93c6733ec188..7c4a3de6f908 100644 --- a/clients/client-detective/models/models_0.ts +++ b/clients/client-detective/models/models_0.ts @@ -11,6 +11,9 @@ export interface AcceptInvitationRequest { } export namespace AcceptInvitationRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: AcceptInvitationRequest): any => ({ ...obj, }); @@ -26,6 +29,9 @@ export interface ConflictException extends __SmithyException, $MetadataBearer { } export namespace ConflictException { + /** + * @internal + */ export const filterSensitiveLog = (obj: ConflictException): any => ({ ...obj, }); @@ -41,6 +47,9 @@ export interface InternalServerException extends __SmithyException, $MetadataBea } export namespace InternalServerException { + /** + * @internal + */ export const filterSensitiveLog = (obj: InternalServerException): any => ({ ...obj, }); @@ -56,6 +65,9 @@ export interface ResourceNotFoundException extends __SmithyException, $MetadataB } export namespace ResourceNotFoundException { + /** + * @internal + */ export const filterSensitiveLog = (obj: ResourceNotFoundException): any => ({ ...obj, }); @@ -71,6 +83,9 @@ export interface ValidationException extends __SmithyException, $MetadataBearer } export namespace ValidationException { + /** + * @internal + */ export const filterSensitiveLog = (obj: ValidationException): any => ({ ...obj, }); @@ -93,6 +108,9 @@ export interface Account { } export namespace Account { + /** + * @internal + */ export const filterSensitiveLog = (obj: Account): any => ({ ...obj, }); @@ -107,6 +125,9 @@ export interface CreateGraphRequest { } export namespace CreateGraphRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateGraphRequest): any => ({ ...obj, }); @@ -120,6 +141,9 @@ export interface CreateGraphResponse { } export namespace CreateGraphResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateGraphResponse): any => ({ ...obj, }); @@ -150,6 +174,9 @@ export interface ServiceQuotaExceededException extends __SmithyException, $Metad } export namespace ServiceQuotaExceededException { + /** + * @internal + */ export const filterSensitiveLog = (obj: ServiceQuotaExceededException): any => ({ ...obj, }); @@ -184,6 +211,9 @@ export interface CreateMembersRequest { } export namespace CreateMembersRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateMembersRequest): any => ({ ...obj, }); @@ -338,6 +368,9 @@ export interface MemberDetail { } export namespace MemberDetail { + /** + * @internal + */ export const filterSensitiveLog = (obj: MemberDetail): any => ({ ...obj, }); @@ -360,6 +393,9 @@ export interface UnprocessedAccount { } export namespace UnprocessedAccount { + /** + * @internal + */ export const filterSensitiveLog = (obj: UnprocessedAccount): any => ({ ...obj, }); @@ -382,6 +418,9 @@ export interface CreateMembersResponse { } export namespace CreateMembersResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateMembersResponse): any => ({ ...obj, }); @@ -395,6 +434,9 @@ export interface DeleteGraphRequest { } export namespace DeleteGraphRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteGraphRequest): any => ({ ...obj, }); @@ -414,6 +456,9 @@ export interface DeleteMembersRequest { } export namespace DeleteMembersRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteMembersRequest): any => ({ ...obj, }); @@ -435,6 +480,9 @@ export interface DeleteMembersResponse { } export namespace DeleteMembersResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteMembersResponse): any => ({ ...obj, }); @@ -450,6 +498,9 @@ export interface DisassociateMembershipRequest { } export namespace DisassociateMembershipRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DisassociateMembershipRequest): any => ({ ...obj, }); @@ -471,6 +522,9 @@ export interface GetMembersRequest { } export namespace GetMembersRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetMembersRequest): any => ({ ...obj, }); @@ -491,6 +545,9 @@ export interface GetMembersResponse { } export namespace GetMembersResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetMembersResponse): any => ({ ...obj, }); @@ -512,6 +569,9 @@ export interface ListGraphsRequest { } export namespace ListGraphsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListGraphsRequest): any => ({ ...obj, }); @@ -534,6 +594,9 @@ export interface Graph { } export namespace Graph { + /** + * @internal + */ export const filterSensitiveLog = (obj: Graph): any => ({ ...obj, }); @@ -553,6 +616,9 @@ export interface ListGraphsResponse { } export namespace ListGraphsResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListGraphsResponse): any => ({ ...obj, }); @@ -575,6 +641,9 @@ export interface ListInvitationsRequest { } export namespace ListInvitationsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListInvitationsRequest): any => ({ ...obj, }); @@ -595,6 +664,9 @@ export interface ListInvitationsResponse { } export namespace ListInvitationsResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListInvitationsResponse): any => ({ ...obj, }); @@ -621,6 +693,9 @@ export interface ListMembersRequest { } export namespace ListMembersRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListMembersRequest): any => ({ ...obj, }); @@ -643,6 +718,9 @@ export interface ListMembersResponse { } export namespace ListMembersResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListMembersResponse): any => ({ ...obj, }); @@ -656,6 +734,9 @@ export interface ListTagsForResourceRequest { } export namespace ListTagsForResourceRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListTagsForResourceRequest): any => ({ ...obj, }); @@ -669,6 +750,9 @@ export interface ListTagsForResourceResponse { } export namespace ListTagsForResourceResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListTagsForResourceResponse): any => ({ ...obj, }); @@ -684,6 +768,9 @@ export interface RejectInvitationRequest { } export namespace RejectInvitationRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: RejectInvitationRequest): any => ({ ...obj, }); @@ -704,6 +791,9 @@ export interface StartMonitoringMemberRequest { } export namespace StartMonitoringMemberRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: StartMonitoringMemberRequest): any => ({ ...obj, }); @@ -722,6 +812,9 @@ export interface TagResourceRequest { } export namespace TagResourceRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: TagResourceRequest): any => ({ ...obj, }); @@ -730,6 +823,9 @@ export namespace TagResourceRequest { export interface TagResourceResponse {} export namespace TagResourceResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: TagResourceResponse): any => ({ ...obj, }); @@ -748,6 +844,9 @@ export interface UntagResourceRequest { } export namespace UntagResourceRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: UntagResourceRequest): any => ({ ...obj, }); @@ -756,6 +855,9 @@ export namespace UntagResourceRequest { export interface UntagResourceResponse {} export namespace UntagResourceResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: UntagResourceResponse): any => ({ ...obj, }); diff --git a/clients/client-device-farm/commands/CreateDevicePoolCommand.ts b/clients/client-device-farm/commands/CreateDevicePoolCommand.ts index f02977a5c5d1..3d9687f7d2dc 100644 --- a/clients/client-device-farm/commands/CreateDevicePoolCommand.ts +++ b/clients/client-device-farm/commands/CreateDevicePoolCommand.ts @@ -22,6 +22,20 @@ export interface CreateDevicePoolCommandOutput extends CreateDevicePoolResult, _ /** *

Creates a device pool.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { DeviceFarmClient, CreateDevicePoolCommand } from "@aws-sdk/client-device-farm"; // ES Modules import + * // const { DeviceFarmClient, CreateDevicePoolCommand } = require("@aws-sdk/client-device-farm"); // CommonJS import + * const client = new DeviceFarmClient(config); + * const command = new CreateDevicePoolCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreateDevicePoolCommandInput} for command's `input` shape. + * @see {@link CreateDevicePoolCommandOutput} for command's `response` shape. + * @see {@link DeviceFarmClientResolvedConfig | config} for command's `input` shape. + * */ export class CreateDevicePoolCommand extends $Command< CreateDevicePoolCommandInput, diff --git a/clients/client-device-farm/commands/CreateInstanceProfileCommand.ts b/clients/client-device-farm/commands/CreateInstanceProfileCommand.ts index c9d257abf2fc..eabc368e43ce 100644 --- a/clients/client-device-farm/commands/CreateInstanceProfileCommand.ts +++ b/clients/client-device-farm/commands/CreateInstanceProfileCommand.ts @@ -23,6 +23,20 @@ export interface CreateInstanceProfileCommandOutput extends CreateInstanceProfil /** *

Creates a profile that can be applied to one or more private fleet device * instances.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { DeviceFarmClient, CreateInstanceProfileCommand } from "@aws-sdk/client-device-farm"; // ES Modules import + * // const { DeviceFarmClient, CreateInstanceProfileCommand } = require("@aws-sdk/client-device-farm"); // CommonJS import + * const client = new DeviceFarmClient(config); + * const command = new CreateInstanceProfileCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreateInstanceProfileCommandInput} for command's `input` shape. + * @see {@link CreateInstanceProfileCommandOutput} for command's `response` shape. + * @see {@link DeviceFarmClientResolvedConfig | config} for command's `input` shape. + * */ export class CreateInstanceProfileCommand extends $Command< CreateInstanceProfileCommandInput, diff --git a/clients/client-device-farm/commands/CreateNetworkProfileCommand.ts b/clients/client-device-farm/commands/CreateNetworkProfileCommand.ts index 33935b37c87b..4c9be6adfeb1 100644 --- a/clients/client-device-farm/commands/CreateNetworkProfileCommand.ts +++ b/clients/client-device-farm/commands/CreateNetworkProfileCommand.ts @@ -22,6 +22,20 @@ export interface CreateNetworkProfileCommandOutput extends CreateNetworkProfileR /** *

Creates a network profile.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { DeviceFarmClient, CreateNetworkProfileCommand } from "@aws-sdk/client-device-farm"; // ES Modules import + * // const { DeviceFarmClient, CreateNetworkProfileCommand } = require("@aws-sdk/client-device-farm"); // CommonJS import + * const client = new DeviceFarmClient(config); + * const command = new CreateNetworkProfileCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreateNetworkProfileCommandInput} for command's `input` shape. + * @see {@link CreateNetworkProfileCommandOutput} for command's `response` shape. + * @see {@link DeviceFarmClientResolvedConfig | config} for command's `input` shape. + * */ export class CreateNetworkProfileCommand extends $Command< CreateNetworkProfileCommandInput, diff --git a/clients/client-device-farm/commands/CreateProjectCommand.ts b/clients/client-device-farm/commands/CreateProjectCommand.ts index 133b1cf78c27..ed8847d02750 100644 --- a/clients/client-device-farm/commands/CreateProjectCommand.ts +++ b/clients/client-device-farm/commands/CreateProjectCommand.ts @@ -22,6 +22,20 @@ export interface CreateProjectCommandOutput extends CreateProjectResult, __Metad /** *

Creates a project.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { DeviceFarmClient, CreateProjectCommand } from "@aws-sdk/client-device-farm"; // ES Modules import + * // const { DeviceFarmClient, CreateProjectCommand } = require("@aws-sdk/client-device-farm"); // CommonJS import + * const client = new DeviceFarmClient(config); + * const command = new CreateProjectCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreateProjectCommandInput} for command's `input` shape. + * @see {@link CreateProjectCommandOutput} for command's `response` shape. + * @see {@link DeviceFarmClientResolvedConfig | config} for command's `input` shape. + * */ export class CreateProjectCommand extends $Command< CreateProjectCommandInput, diff --git a/clients/client-device-farm/commands/CreateRemoteAccessSessionCommand.ts b/clients/client-device-farm/commands/CreateRemoteAccessSessionCommand.ts index 65f3d2f85e5d..37c1ea330635 100644 --- a/clients/client-device-farm/commands/CreateRemoteAccessSessionCommand.ts +++ b/clients/client-device-farm/commands/CreateRemoteAccessSessionCommand.ts @@ -22,6 +22,20 @@ export interface CreateRemoteAccessSessionCommandOutput extends CreateRemoteAcce /** *

Specifies and starts a remote access session.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { DeviceFarmClient, CreateRemoteAccessSessionCommand } from "@aws-sdk/client-device-farm"; // ES Modules import + * // const { DeviceFarmClient, CreateRemoteAccessSessionCommand } = require("@aws-sdk/client-device-farm"); // CommonJS import + * const client = new DeviceFarmClient(config); + * const command = new CreateRemoteAccessSessionCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreateRemoteAccessSessionCommandInput} for command's `input` shape. + * @see {@link CreateRemoteAccessSessionCommandOutput} for command's `response` shape. + * @see {@link DeviceFarmClientResolvedConfig | config} for command's `input` shape. + * */ export class CreateRemoteAccessSessionCommand extends $Command< CreateRemoteAccessSessionCommandInput, diff --git a/clients/client-device-farm/commands/CreateTestGridProjectCommand.ts b/clients/client-device-farm/commands/CreateTestGridProjectCommand.ts index be9a56419cb1..05727057b98a 100644 --- a/clients/client-device-farm/commands/CreateTestGridProjectCommand.ts +++ b/clients/client-device-farm/commands/CreateTestGridProjectCommand.ts @@ -23,6 +23,20 @@ export interface CreateTestGridProjectCommandOutput extends CreateTestGridProjec /** *

Creates a Selenium testing project. Projects are used to track TestGridSession * instances.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { DeviceFarmClient, CreateTestGridProjectCommand } from "@aws-sdk/client-device-farm"; // ES Modules import + * // const { DeviceFarmClient, CreateTestGridProjectCommand } = require("@aws-sdk/client-device-farm"); // CommonJS import + * const client = new DeviceFarmClient(config); + * const command = new CreateTestGridProjectCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreateTestGridProjectCommandInput} for command's `input` shape. + * @see {@link CreateTestGridProjectCommandOutput} for command's `response` shape. + * @see {@link DeviceFarmClientResolvedConfig | config} for command's `input` shape. + * */ export class CreateTestGridProjectCommand extends $Command< CreateTestGridProjectCommandInput, diff --git a/clients/client-device-farm/commands/CreateTestGridUrlCommand.ts b/clients/client-device-farm/commands/CreateTestGridUrlCommand.ts index 07e426668acd..16c1963ee0af 100644 --- a/clients/client-device-farm/commands/CreateTestGridUrlCommand.ts +++ b/clients/client-device-farm/commands/CreateTestGridUrlCommand.ts @@ -23,6 +23,20 @@ export interface CreateTestGridUrlCommandOutput extends CreateTestGridUrlResult, /** *

Creates a signed, short-term URL that can be passed to a Selenium RemoteWebDriver * constructor.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { DeviceFarmClient, CreateTestGridUrlCommand } from "@aws-sdk/client-device-farm"; // ES Modules import + * // const { DeviceFarmClient, CreateTestGridUrlCommand } = require("@aws-sdk/client-device-farm"); // CommonJS import + * const client = new DeviceFarmClient(config); + * const command = new CreateTestGridUrlCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreateTestGridUrlCommandInput} for command's `input` shape. + * @see {@link CreateTestGridUrlCommandOutput} for command's `response` shape. + * @see {@link DeviceFarmClientResolvedConfig | config} for command's `input` shape. + * */ export class CreateTestGridUrlCommand extends $Command< CreateTestGridUrlCommandInput, diff --git a/clients/client-device-farm/commands/CreateUploadCommand.ts b/clients/client-device-farm/commands/CreateUploadCommand.ts index a5c681fa3cc3..31b9c8eb76d6 100644 --- a/clients/client-device-farm/commands/CreateUploadCommand.ts +++ b/clients/client-device-farm/commands/CreateUploadCommand.ts @@ -22,6 +22,20 @@ export interface CreateUploadCommandOutput extends CreateUploadResult, __Metadat /** *

Uploads an app or test scripts.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { DeviceFarmClient, CreateUploadCommand } from "@aws-sdk/client-device-farm"; // ES Modules import + * // const { DeviceFarmClient, CreateUploadCommand } = require("@aws-sdk/client-device-farm"); // CommonJS import + * const client = new DeviceFarmClient(config); + * const command = new CreateUploadCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreateUploadCommandInput} for command's `input` shape. + * @see {@link CreateUploadCommandOutput} for command's `response` shape. + * @see {@link DeviceFarmClientResolvedConfig | config} for command's `input` shape. + * */ export class CreateUploadCommand extends $Command< CreateUploadCommandInput, diff --git a/clients/client-device-farm/commands/CreateVPCEConfigurationCommand.ts b/clients/client-device-farm/commands/CreateVPCEConfigurationCommand.ts index 3ba5b9287eaa..ca57af6fd759 100644 --- a/clients/client-device-farm/commands/CreateVPCEConfigurationCommand.ts +++ b/clients/client-device-farm/commands/CreateVPCEConfigurationCommand.ts @@ -23,6 +23,20 @@ export interface CreateVPCEConfigurationCommandOutput extends CreateVPCEConfigur /** *

Creates a configuration record in Device Farm for your Amazon Virtual Private Cloud * (VPC) endpoint.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { DeviceFarmClient, CreateVPCEConfigurationCommand } from "@aws-sdk/client-device-farm"; // ES Modules import + * // const { DeviceFarmClient, CreateVPCEConfigurationCommand } = require("@aws-sdk/client-device-farm"); // CommonJS import + * const client = new DeviceFarmClient(config); + * const command = new CreateVPCEConfigurationCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreateVPCEConfigurationCommandInput} for command's `input` shape. + * @see {@link CreateVPCEConfigurationCommandOutput} for command's `response` shape. + * @see {@link DeviceFarmClientResolvedConfig | config} for command's `input` shape. + * */ export class CreateVPCEConfigurationCommand extends $Command< CreateVPCEConfigurationCommandInput, diff --git a/clients/client-device-farm/commands/DeleteDevicePoolCommand.ts b/clients/client-device-farm/commands/DeleteDevicePoolCommand.ts index c0e6c428f44b..07b6aee1de58 100644 --- a/clients/client-device-farm/commands/DeleteDevicePoolCommand.ts +++ b/clients/client-device-farm/commands/DeleteDevicePoolCommand.ts @@ -23,6 +23,20 @@ export interface DeleteDevicePoolCommandOutput extends DeleteDevicePoolResult, _ /** *

Deletes a device pool given the pool ARN. Does not allow deletion of curated pools * owned by the system.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { DeviceFarmClient, DeleteDevicePoolCommand } from "@aws-sdk/client-device-farm"; // ES Modules import + * // const { DeviceFarmClient, DeleteDevicePoolCommand } = require("@aws-sdk/client-device-farm"); // CommonJS import + * const client = new DeviceFarmClient(config); + * const command = new DeleteDevicePoolCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteDevicePoolCommandInput} for command's `input` shape. + * @see {@link DeleteDevicePoolCommandOutput} for command's `response` shape. + * @see {@link DeviceFarmClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteDevicePoolCommand extends $Command< DeleteDevicePoolCommandInput, diff --git a/clients/client-device-farm/commands/DeleteInstanceProfileCommand.ts b/clients/client-device-farm/commands/DeleteInstanceProfileCommand.ts index 317b0df2f1c4..2834c2ad7f8a 100644 --- a/clients/client-device-farm/commands/DeleteInstanceProfileCommand.ts +++ b/clients/client-device-farm/commands/DeleteInstanceProfileCommand.ts @@ -22,6 +22,20 @@ export interface DeleteInstanceProfileCommandOutput extends DeleteInstanceProfil /** *

Deletes a profile that can be applied to one or more private device instances.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { DeviceFarmClient, DeleteInstanceProfileCommand } from "@aws-sdk/client-device-farm"; // ES Modules import + * // const { DeviceFarmClient, DeleteInstanceProfileCommand } = require("@aws-sdk/client-device-farm"); // CommonJS import + * const client = new DeviceFarmClient(config); + * const command = new DeleteInstanceProfileCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteInstanceProfileCommandInput} for command's `input` shape. + * @see {@link DeleteInstanceProfileCommandOutput} for command's `response` shape. + * @see {@link DeviceFarmClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteInstanceProfileCommand extends $Command< DeleteInstanceProfileCommandInput, diff --git a/clients/client-device-farm/commands/DeleteNetworkProfileCommand.ts b/clients/client-device-farm/commands/DeleteNetworkProfileCommand.ts index 505808231c5e..67e6318bb674 100644 --- a/clients/client-device-farm/commands/DeleteNetworkProfileCommand.ts +++ b/clients/client-device-farm/commands/DeleteNetworkProfileCommand.ts @@ -22,6 +22,20 @@ export interface DeleteNetworkProfileCommandOutput extends DeleteNetworkProfileR /** *

Deletes a network profile.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { DeviceFarmClient, DeleteNetworkProfileCommand } from "@aws-sdk/client-device-farm"; // ES Modules import + * // const { DeviceFarmClient, DeleteNetworkProfileCommand } = require("@aws-sdk/client-device-farm"); // CommonJS import + * const client = new DeviceFarmClient(config); + * const command = new DeleteNetworkProfileCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteNetworkProfileCommandInput} for command's `input` shape. + * @see {@link DeleteNetworkProfileCommandOutput} for command's `response` shape. + * @see {@link DeviceFarmClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteNetworkProfileCommand extends $Command< DeleteNetworkProfileCommandInput, diff --git a/clients/client-device-farm/commands/DeleteProjectCommand.ts b/clients/client-device-farm/commands/DeleteProjectCommand.ts index 2e52513ec0b4..90077393cc37 100644 --- a/clients/client-device-farm/commands/DeleteProjectCommand.ts +++ b/clients/client-device-farm/commands/DeleteProjectCommand.ts @@ -23,6 +23,20 @@ export interface DeleteProjectCommandOutput extends DeleteProjectResult, __Metad /** *

Deletes an AWS Device Farm project, given the project ARN.

*

Deleting this resource does not stop an in-progress run.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { DeviceFarmClient, DeleteProjectCommand } from "@aws-sdk/client-device-farm"; // ES Modules import + * // const { DeviceFarmClient, DeleteProjectCommand } = require("@aws-sdk/client-device-farm"); // CommonJS import + * const client = new DeviceFarmClient(config); + * const command = new DeleteProjectCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteProjectCommandInput} for command's `input` shape. + * @see {@link DeleteProjectCommandOutput} for command's `response` shape. + * @see {@link DeviceFarmClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteProjectCommand extends $Command< DeleteProjectCommandInput, diff --git a/clients/client-device-farm/commands/DeleteRemoteAccessSessionCommand.ts b/clients/client-device-farm/commands/DeleteRemoteAccessSessionCommand.ts index 37c973983fca..97dd0663f5e4 100644 --- a/clients/client-device-farm/commands/DeleteRemoteAccessSessionCommand.ts +++ b/clients/client-device-farm/commands/DeleteRemoteAccessSessionCommand.ts @@ -22,6 +22,20 @@ export interface DeleteRemoteAccessSessionCommandOutput extends DeleteRemoteAcce /** *

Deletes a completed remote access session and its results.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { DeviceFarmClient, DeleteRemoteAccessSessionCommand } from "@aws-sdk/client-device-farm"; // ES Modules import + * // const { DeviceFarmClient, DeleteRemoteAccessSessionCommand } = require("@aws-sdk/client-device-farm"); // CommonJS import + * const client = new DeviceFarmClient(config); + * const command = new DeleteRemoteAccessSessionCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteRemoteAccessSessionCommandInput} for command's `input` shape. + * @see {@link DeleteRemoteAccessSessionCommandOutput} for command's `response` shape. + * @see {@link DeviceFarmClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteRemoteAccessSessionCommand extends $Command< DeleteRemoteAccessSessionCommandInput, diff --git a/clients/client-device-farm/commands/DeleteRunCommand.ts b/clients/client-device-farm/commands/DeleteRunCommand.ts index d82fbf06f547..4485ce0aae60 100644 --- a/clients/client-device-farm/commands/DeleteRunCommand.ts +++ b/clients/client-device-farm/commands/DeleteRunCommand.ts @@ -20,6 +20,20 @@ export interface DeleteRunCommandOutput extends DeleteRunResult, __MetadataBeare /** *

Deletes the run, given the run ARN.

*

Deleting this resource does not stop an in-progress run.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { DeviceFarmClient, DeleteRunCommand } from "@aws-sdk/client-device-farm"; // ES Modules import + * // const { DeviceFarmClient, DeleteRunCommand } = require("@aws-sdk/client-device-farm"); // CommonJS import + * const client = new DeviceFarmClient(config); + * const command = new DeleteRunCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteRunCommandInput} for command's `input` shape. + * @see {@link DeleteRunCommandOutput} for command's `response` shape. + * @see {@link DeviceFarmClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteRunCommand extends $Command< DeleteRunCommandInput, diff --git a/clients/client-device-farm/commands/DeleteTestGridProjectCommand.ts b/clients/client-device-farm/commands/DeleteTestGridProjectCommand.ts index e12ce3fe0cad..ea9e0dd9ab4c 100644 --- a/clients/client-device-farm/commands/DeleteTestGridProjectCommand.ts +++ b/clients/client-device-farm/commands/DeleteTestGridProjectCommand.ts @@ -28,6 +28,20 @@ export interface DeleteTestGridProjectCommandOutput extends DeleteTestGridProjec * *

You cannot delete a project if it has active sessions.

* + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { DeviceFarmClient, DeleteTestGridProjectCommand } from "@aws-sdk/client-device-farm"; // ES Modules import + * // const { DeviceFarmClient, DeleteTestGridProjectCommand } = require("@aws-sdk/client-device-farm"); // CommonJS import + * const client = new DeviceFarmClient(config); + * const command = new DeleteTestGridProjectCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteTestGridProjectCommandInput} for command's `input` shape. + * @see {@link DeleteTestGridProjectCommandOutput} for command's `response` shape. + * @see {@link DeviceFarmClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteTestGridProjectCommand extends $Command< DeleteTestGridProjectCommandInput, diff --git a/clients/client-device-farm/commands/DeleteUploadCommand.ts b/clients/client-device-farm/commands/DeleteUploadCommand.ts index a8cded5cf9b4..c8ecf5d9fcd2 100644 --- a/clients/client-device-farm/commands/DeleteUploadCommand.ts +++ b/clients/client-device-farm/commands/DeleteUploadCommand.ts @@ -22,6 +22,20 @@ export interface DeleteUploadCommandOutput extends DeleteUploadResult, __Metadat /** *

Deletes an upload given the upload ARN.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { DeviceFarmClient, DeleteUploadCommand } from "@aws-sdk/client-device-farm"; // ES Modules import + * // const { DeviceFarmClient, DeleteUploadCommand } = require("@aws-sdk/client-device-farm"); // CommonJS import + * const client = new DeviceFarmClient(config); + * const command = new DeleteUploadCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteUploadCommandInput} for command's `input` shape. + * @see {@link DeleteUploadCommandOutput} for command's `response` shape. + * @see {@link DeviceFarmClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteUploadCommand extends $Command< DeleteUploadCommandInput, diff --git a/clients/client-device-farm/commands/DeleteVPCEConfigurationCommand.ts b/clients/client-device-farm/commands/DeleteVPCEConfigurationCommand.ts index 5d8bed46e5f1..610ab5820a6f 100644 --- a/clients/client-device-farm/commands/DeleteVPCEConfigurationCommand.ts +++ b/clients/client-device-farm/commands/DeleteVPCEConfigurationCommand.ts @@ -22,6 +22,20 @@ export interface DeleteVPCEConfigurationCommandOutput extends DeleteVPCEConfigur /** *

Deletes a configuration for your Amazon Virtual Private Cloud (VPC) endpoint.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { DeviceFarmClient, DeleteVPCEConfigurationCommand } from "@aws-sdk/client-device-farm"; // ES Modules import + * // const { DeviceFarmClient, DeleteVPCEConfigurationCommand } = require("@aws-sdk/client-device-farm"); // CommonJS import + * const client = new DeviceFarmClient(config); + * const command = new DeleteVPCEConfigurationCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteVPCEConfigurationCommandInput} for command's `input` shape. + * @see {@link DeleteVPCEConfigurationCommandOutput} for command's `response` shape. + * @see {@link DeviceFarmClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteVPCEConfigurationCommand extends $Command< DeleteVPCEConfigurationCommandInput, diff --git a/clients/client-device-farm/commands/GetAccountSettingsCommand.ts b/clients/client-device-farm/commands/GetAccountSettingsCommand.ts index 2b704366eb6b..3cdfade3894c 100644 --- a/clients/client-device-farm/commands/GetAccountSettingsCommand.ts +++ b/clients/client-device-farm/commands/GetAccountSettingsCommand.ts @@ -23,6 +23,20 @@ export interface GetAccountSettingsCommandOutput extends GetAccountSettingsResul /** *

Returns the number of unmetered iOS or unmetered Android devices that have been purchased by the * account.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { DeviceFarmClient, GetAccountSettingsCommand } from "@aws-sdk/client-device-farm"; // ES Modules import + * // const { DeviceFarmClient, GetAccountSettingsCommand } = require("@aws-sdk/client-device-farm"); // CommonJS import + * const client = new DeviceFarmClient(config); + * const command = new GetAccountSettingsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetAccountSettingsCommandInput} for command's `input` shape. + * @see {@link GetAccountSettingsCommandOutput} for command's `response` shape. + * @see {@link DeviceFarmClientResolvedConfig | config} for command's `input` shape. + * */ export class GetAccountSettingsCommand extends $Command< GetAccountSettingsCommandInput, diff --git a/clients/client-device-farm/commands/GetDeviceCommand.ts b/clients/client-device-farm/commands/GetDeviceCommand.ts index 99d1d044eeff..7666a75b0ad5 100644 --- a/clients/client-device-farm/commands/GetDeviceCommand.ts +++ b/clients/client-device-farm/commands/GetDeviceCommand.ts @@ -19,6 +19,20 @@ export interface GetDeviceCommandOutput extends GetDeviceResult, __MetadataBeare /** *

Gets information about a unique device type.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { DeviceFarmClient, GetDeviceCommand } from "@aws-sdk/client-device-farm"; // ES Modules import + * // const { DeviceFarmClient, GetDeviceCommand } = require("@aws-sdk/client-device-farm"); // CommonJS import + * const client = new DeviceFarmClient(config); + * const command = new GetDeviceCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetDeviceCommandInput} for command's `input` shape. + * @see {@link GetDeviceCommandOutput} for command's `response` shape. + * @see {@link DeviceFarmClientResolvedConfig | config} for command's `input` shape. + * */ export class GetDeviceCommand extends $Command< GetDeviceCommandInput, diff --git a/clients/client-device-farm/commands/GetDeviceInstanceCommand.ts b/clients/client-device-farm/commands/GetDeviceInstanceCommand.ts index 7010eee7c76a..c5f45842d24c 100644 --- a/clients/client-device-farm/commands/GetDeviceInstanceCommand.ts +++ b/clients/client-device-farm/commands/GetDeviceInstanceCommand.ts @@ -22,6 +22,20 @@ export interface GetDeviceInstanceCommandOutput extends GetDeviceInstanceResult, /** *

Returns information about a device instance that belongs to a private device fleet.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { DeviceFarmClient, GetDeviceInstanceCommand } from "@aws-sdk/client-device-farm"; // ES Modules import + * // const { DeviceFarmClient, GetDeviceInstanceCommand } = require("@aws-sdk/client-device-farm"); // CommonJS import + * const client = new DeviceFarmClient(config); + * const command = new GetDeviceInstanceCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetDeviceInstanceCommandInput} for command's `input` shape. + * @see {@link GetDeviceInstanceCommandOutput} for command's `response` shape. + * @see {@link DeviceFarmClientResolvedConfig | config} for command's `input` shape. + * */ export class GetDeviceInstanceCommand extends $Command< GetDeviceInstanceCommandInput, diff --git a/clients/client-device-farm/commands/GetDevicePoolCommand.ts b/clients/client-device-farm/commands/GetDevicePoolCommand.ts index 14b618510df0..0b0b129c5591 100644 --- a/clients/client-device-farm/commands/GetDevicePoolCommand.ts +++ b/clients/client-device-farm/commands/GetDevicePoolCommand.ts @@ -22,6 +22,20 @@ export interface GetDevicePoolCommandOutput extends GetDevicePoolResult, __Metad /** *

Gets information about a device pool.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { DeviceFarmClient, GetDevicePoolCommand } from "@aws-sdk/client-device-farm"; // ES Modules import + * // const { DeviceFarmClient, GetDevicePoolCommand } = require("@aws-sdk/client-device-farm"); // CommonJS import + * const client = new DeviceFarmClient(config); + * const command = new GetDevicePoolCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetDevicePoolCommandInput} for command's `input` shape. + * @see {@link GetDevicePoolCommandOutput} for command's `response` shape. + * @see {@link DeviceFarmClientResolvedConfig | config} for command's `input` shape. + * */ export class GetDevicePoolCommand extends $Command< GetDevicePoolCommandInput, diff --git a/clients/client-device-farm/commands/GetDevicePoolCompatibilityCommand.ts b/clients/client-device-farm/commands/GetDevicePoolCompatibilityCommand.ts index ddf87086608f..687a86faab72 100644 --- a/clients/client-device-farm/commands/GetDevicePoolCompatibilityCommand.ts +++ b/clients/client-device-farm/commands/GetDevicePoolCompatibilityCommand.ts @@ -22,6 +22,20 @@ export interface GetDevicePoolCompatibilityCommandOutput extends GetDevicePoolCo /** *

Gets information about compatibility with a device pool.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { DeviceFarmClient, GetDevicePoolCompatibilityCommand } from "@aws-sdk/client-device-farm"; // ES Modules import + * // const { DeviceFarmClient, GetDevicePoolCompatibilityCommand } = require("@aws-sdk/client-device-farm"); // CommonJS import + * const client = new DeviceFarmClient(config); + * const command = new GetDevicePoolCompatibilityCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetDevicePoolCompatibilityCommandInput} for command's `input` shape. + * @see {@link GetDevicePoolCompatibilityCommandOutput} for command's `response` shape. + * @see {@link DeviceFarmClientResolvedConfig | config} for command's `input` shape. + * */ export class GetDevicePoolCompatibilityCommand extends $Command< GetDevicePoolCompatibilityCommandInput, diff --git a/clients/client-device-farm/commands/GetInstanceProfileCommand.ts b/clients/client-device-farm/commands/GetInstanceProfileCommand.ts index 893964e3d8a7..e4c42e15edc9 100644 --- a/clients/client-device-farm/commands/GetInstanceProfileCommand.ts +++ b/clients/client-device-farm/commands/GetInstanceProfileCommand.ts @@ -22,6 +22,20 @@ export interface GetInstanceProfileCommandOutput extends GetInstanceProfileResul /** *

Returns information about the specified instance profile.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { DeviceFarmClient, GetInstanceProfileCommand } from "@aws-sdk/client-device-farm"; // ES Modules import + * // const { DeviceFarmClient, GetInstanceProfileCommand } = require("@aws-sdk/client-device-farm"); // CommonJS import + * const client = new DeviceFarmClient(config); + * const command = new GetInstanceProfileCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetInstanceProfileCommandInput} for command's `input` shape. + * @see {@link GetInstanceProfileCommandOutput} for command's `response` shape. + * @see {@link DeviceFarmClientResolvedConfig | config} for command's `input` shape. + * */ export class GetInstanceProfileCommand extends $Command< GetInstanceProfileCommandInput, diff --git a/clients/client-device-farm/commands/GetJobCommand.ts b/clients/client-device-farm/commands/GetJobCommand.ts index be41e8578da4..5e0381868126 100644 --- a/clients/client-device-farm/commands/GetJobCommand.ts +++ b/clients/client-device-farm/commands/GetJobCommand.ts @@ -19,6 +19,20 @@ export interface GetJobCommandOutput extends GetJobResult, __MetadataBearer {} /** *

Gets information about a job.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { DeviceFarmClient, GetJobCommand } from "@aws-sdk/client-device-farm"; // ES Modules import + * // const { DeviceFarmClient, GetJobCommand } = require("@aws-sdk/client-device-farm"); // CommonJS import + * const client = new DeviceFarmClient(config); + * const command = new GetJobCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetJobCommandInput} for command's `input` shape. + * @see {@link GetJobCommandOutput} for command's `response` shape. + * @see {@link DeviceFarmClientResolvedConfig | config} for command's `input` shape. + * */ export class GetJobCommand extends $Command { // Start section: command_properties diff --git a/clients/client-device-farm/commands/GetNetworkProfileCommand.ts b/clients/client-device-farm/commands/GetNetworkProfileCommand.ts index 5db3f52f7fc0..4501184df597 100644 --- a/clients/client-device-farm/commands/GetNetworkProfileCommand.ts +++ b/clients/client-device-farm/commands/GetNetworkProfileCommand.ts @@ -22,6 +22,20 @@ export interface GetNetworkProfileCommandOutput extends GetNetworkProfileResult, /** *

Returns information about a network profile.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { DeviceFarmClient, GetNetworkProfileCommand } from "@aws-sdk/client-device-farm"; // ES Modules import + * // const { DeviceFarmClient, GetNetworkProfileCommand } = require("@aws-sdk/client-device-farm"); // CommonJS import + * const client = new DeviceFarmClient(config); + * const command = new GetNetworkProfileCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetNetworkProfileCommandInput} for command's `input` shape. + * @see {@link GetNetworkProfileCommandOutput} for command's `response` shape. + * @see {@link DeviceFarmClientResolvedConfig | config} for command's `input` shape. + * */ export class GetNetworkProfileCommand extends $Command< GetNetworkProfileCommandInput, diff --git a/clients/client-device-farm/commands/GetOfferingStatusCommand.ts b/clients/client-device-farm/commands/GetOfferingStatusCommand.ts index 7330c5b79479..80b5611336d9 100644 --- a/clients/client-device-farm/commands/GetOfferingStatusCommand.ts +++ b/clients/client-device-farm/commands/GetOfferingStatusCommand.ts @@ -25,6 +25,20 @@ export interface GetOfferingStatusCommandOutput extends GetOfferingStatusResult, * 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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { DeviceFarmClient, GetOfferingStatusCommand } from "@aws-sdk/client-device-farm"; // ES Modules import + * // const { DeviceFarmClient, GetOfferingStatusCommand } = require("@aws-sdk/client-device-farm"); // CommonJS import + * const client = new DeviceFarmClient(config); + * const command = new GetOfferingStatusCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetOfferingStatusCommandInput} for command's `input` shape. + * @see {@link GetOfferingStatusCommandOutput} for command's `response` shape. + * @see {@link DeviceFarmClientResolvedConfig | config} for command's `input` shape. + * */ export class GetOfferingStatusCommand extends $Command< GetOfferingStatusCommandInput, diff --git a/clients/client-device-farm/commands/GetProjectCommand.ts b/clients/client-device-farm/commands/GetProjectCommand.ts index de9c4578407c..b7f743a7c754 100644 --- a/clients/client-device-farm/commands/GetProjectCommand.ts +++ b/clients/client-device-farm/commands/GetProjectCommand.ts @@ -22,6 +22,20 @@ export interface GetProjectCommandOutput extends GetProjectResult, __MetadataBea /** *

Gets information about a project.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { DeviceFarmClient, GetProjectCommand } from "@aws-sdk/client-device-farm"; // ES Modules import + * // const { DeviceFarmClient, GetProjectCommand } = require("@aws-sdk/client-device-farm"); // CommonJS import + * const client = new DeviceFarmClient(config); + * const command = new GetProjectCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetProjectCommandInput} for command's `input` shape. + * @see {@link GetProjectCommandOutput} for command's `response` shape. + * @see {@link DeviceFarmClientResolvedConfig | config} for command's `input` shape. + * */ export class GetProjectCommand extends $Command< GetProjectCommandInput, diff --git a/clients/client-device-farm/commands/GetRemoteAccessSessionCommand.ts b/clients/client-device-farm/commands/GetRemoteAccessSessionCommand.ts index f47fa1b286c7..c2aa0d2973d1 100644 --- a/clients/client-device-farm/commands/GetRemoteAccessSessionCommand.ts +++ b/clients/client-device-farm/commands/GetRemoteAccessSessionCommand.ts @@ -22,6 +22,20 @@ export interface GetRemoteAccessSessionCommandOutput extends GetRemoteAccessSess /** *

Returns a link to a currently running remote access session.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { DeviceFarmClient, GetRemoteAccessSessionCommand } from "@aws-sdk/client-device-farm"; // ES Modules import + * // const { DeviceFarmClient, GetRemoteAccessSessionCommand } = require("@aws-sdk/client-device-farm"); // CommonJS import + * const client = new DeviceFarmClient(config); + * const command = new GetRemoteAccessSessionCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetRemoteAccessSessionCommandInput} for command's `input` shape. + * @see {@link GetRemoteAccessSessionCommandOutput} for command's `response` shape. + * @see {@link DeviceFarmClientResolvedConfig | config} for command's `input` shape. + * */ export class GetRemoteAccessSessionCommand extends $Command< GetRemoteAccessSessionCommandInput, diff --git a/clients/client-device-farm/commands/GetRunCommand.ts b/clients/client-device-farm/commands/GetRunCommand.ts index b307dff5fc61..aeef6f722b71 100644 --- a/clients/client-device-farm/commands/GetRunCommand.ts +++ b/clients/client-device-farm/commands/GetRunCommand.ts @@ -19,6 +19,20 @@ export interface GetRunCommandOutput extends GetRunResult, __MetadataBearer {} /** *

Gets information about a run.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { DeviceFarmClient, GetRunCommand } from "@aws-sdk/client-device-farm"; // ES Modules import + * // const { DeviceFarmClient, GetRunCommand } = require("@aws-sdk/client-device-farm"); // CommonJS import + * const client = new DeviceFarmClient(config); + * const command = new GetRunCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetRunCommandInput} for command's `input` shape. + * @see {@link GetRunCommandOutput} for command's `response` shape. + * @see {@link DeviceFarmClientResolvedConfig | config} for command's `input` shape. + * */ export class GetRunCommand extends $Command { // Start section: command_properties diff --git a/clients/client-device-farm/commands/GetSuiteCommand.ts b/clients/client-device-farm/commands/GetSuiteCommand.ts index 0ab52e64ff0f..41757d98fef0 100644 --- a/clients/client-device-farm/commands/GetSuiteCommand.ts +++ b/clients/client-device-farm/commands/GetSuiteCommand.ts @@ -19,6 +19,20 @@ export interface GetSuiteCommandOutput extends GetSuiteResult, __MetadataBearer /** *

Gets information about a suite.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { DeviceFarmClient, GetSuiteCommand } from "@aws-sdk/client-device-farm"; // ES Modules import + * // const { DeviceFarmClient, GetSuiteCommand } = require("@aws-sdk/client-device-farm"); // CommonJS import + * const client = new DeviceFarmClient(config); + * const command = new GetSuiteCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetSuiteCommandInput} for command's `input` shape. + * @see {@link GetSuiteCommandOutput} for command's `response` shape. + * @see {@link DeviceFarmClientResolvedConfig | config} for command's `input` shape. + * */ export class GetSuiteCommand extends $Command< GetSuiteCommandInput, diff --git a/clients/client-device-farm/commands/GetTestCommand.ts b/clients/client-device-farm/commands/GetTestCommand.ts index dc9a066f7693..7e15f38440dc 100644 --- a/clients/client-device-farm/commands/GetTestCommand.ts +++ b/clients/client-device-farm/commands/GetTestCommand.ts @@ -19,6 +19,20 @@ export interface GetTestCommandOutput extends GetTestResult, __MetadataBearer {} /** *

Gets information about a test.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { DeviceFarmClient, GetTestCommand } from "@aws-sdk/client-device-farm"; // ES Modules import + * // const { DeviceFarmClient, GetTestCommand } = require("@aws-sdk/client-device-farm"); // CommonJS import + * const client = new DeviceFarmClient(config); + * const command = new GetTestCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetTestCommandInput} for command's `input` shape. + * @see {@link GetTestCommandOutput} for command's `response` shape. + * @see {@link DeviceFarmClientResolvedConfig | config} for command's `input` shape. + * */ export class GetTestCommand extends $Command< GetTestCommandInput, diff --git a/clients/client-device-farm/commands/GetTestGridProjectCommand.ts b/clients/client-device-farm/commands/GetTestGridProjectCommand.ts index 62d35c997736..8d333abd86af 100644 --- a/clients/client-device-farm/commands/GetTestGridProjectCommand.ts +++ b/clients/client-device-farm/commands/GetTestGridProjectCommand.ts @@ -22,6 +22,20 @@ export interface GetTestGridProjectCommandOutput extends GetTestGridProjectResul /** *

Retrieves information about a Selenium testing project.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { DeviceFarmClient, GetTestGridProjectCommand } from "@aws-sdk/client-device-farm"; // ES Modules import + * // const { DeviceFarmClient, GetTestGridProjectCommand } = require("@aws-sdk/client-device-farm"); // CommonJS import + * const client = new DeviceFarmClient(config); + * const command = new GetTestGridProjectCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetTestGridProjectCommandInput} for command's `input` shape. + * @see {@link GetTestGridProjectCommandOutput} for command's `response` shape. + * @see {@link DeviceFarmClientResolvedConfig | config} for command's `input` shape. + * */ export class GetTestGridProjectCommand extends $Command< GetTestGridProjectCommandInput, diff --git a/clients/client-device-farm/commands/GetTestGridSessionCommand.ts b/clients/client-device-farm/commands/GetTestGridSessionCommand.ts index 471e5bd68838..35898814a966 100644 --- a/clients/client-device-farm/commands/GetTestGridSessionCommand.ts +++ b/clients/client-device-farm/commands/GetTestGridSessionCommand.ts @@ -31,6 +31,20 @@ export interface GetTestGridSessionCommandOutput extends GetTestGridSessionResul * * *

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { DeviceFarmClient, GetTestGridSessionCommand } from "@aws-sdk/client-device-farm"; // ES Modules import + * // const { DeviceFarmClient, GetTestGridSessionCommand } = require("@aws-sdk/client-device-farm"); // CommonJS import + * const client = new DeviceFarmClient(config); + * const command = new GetTestGridSessionCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetTestGridSessionCommandInput} for command's `input` shape. + * @see {@link GetTestGridSessionCommandOutput} for command's `response` shape. + * @see {@link DeviceFarmClientResolvedConfig | config} for command's `input` shape. + * */ export class GetTestGridSessionCommand extends $Command< GetTestGridSessionCommandInput, diff --git a/clients/client-device-farm/commands/GetUploadCommand.ts b/clients/client-device-farm/commands/GetUploadCommand.ts index df25813d03ed..237efa9d102f 100644 --- a/clients/client-device-farm/commands/GetUploadCommand.ts +++ b/clients/client-device-farm/commands/GetUploadCommand.ts @@ -19,6 +19,20 @@ export interface GetUploadCommandOutput extends GetUploadResult, __MetadataBeare /** *

Gets information about an upload.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { DeviceFarmClient, GetUploadCommand } from "@aws-sdk/client-device-farm"; // ES Modules import + * // const { DeviceFarmClient, GetUploadCommand } = require("@aws-sdk/client-device-farm"); // CommonJS import + * const client = new DeviceFarmClient(config); + * const command = new GetUploadCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetUploadCommandInput} for command's `input` shape. + * @see {@link GetUploadCommandOutput} for command's `response` shape. + * @see {@link DeviceFarmClientResolvedConfig | config} for command's `input` shape. + * */ export class GetUploadCommand extends $Command< GetUploadCommandInput, diff --git a/clients/client-device-farm/commands/GetVPCEConfigurationCommand.ts b/clients/client-device-farm/commands/GetVPCEConfigurationCommand.ts index 2742a97fe688..57b4a4c856f2 100644 --- a/clients/client-device-farm/commands/GetVPCEConfigurationCommand.ts +++ b/clients/client-device-farm/commands/GetVPCEConfigurationCommand.ts @@ -23,6 +23,20 @@ export interface GetVPCEConfigurationCommandOutput extends GetVPCEConfigurationR /** *

Returns information about the configuration settings for your Amazon Virtual Private * Cloud (VPC) endpoint.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { DeviceFarmClient, GetVPCEConfigurationCommand } from "@aws-sdk/client-device-farm"; // ES Modules import + * // const { DeviceFarmClient, GetVPCEConfigurationCommand } = require("@aws-sdk/client-device-farm"); // CommonJS import + * const client = new DeviceFarmClient(config); + * const command = new GetVPCEConfigurationCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetVPCEConfigurationCommandInput} for command's `input` shape. + * @see {@link GetVPCEConfigurationCommandOutput} for command's `response` shape. + * @see {@link DeviceFarmClientResolvedConfig | config} for command's `input` shape. + * */ export class GetVPCEConfigurationCommand extends $Command< GetVPCEConfigurationCommandInput, diff --git a/clients/client-device-farm/commands/InstallToRemoteAccessSessionCommand.ts b/clients/client-device-farm/commands/InstallToRemoteAccessSessionCommand.ts index a1461eacd31b..b53cd02a6e38 100644 --- a/clients/client-device-farm/commands/InstallToRemoteAccessSessionCommand.ts +++ b/clients/client-device-farm/commands/InstallToRemoteAccessSessionCommand.ts @@ -26,6 +26,20 @@ export interface InstallToRemoteAccessSessionCommandOutput *

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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { DeviceFarmClient, InstallToRemoteAccessSessionCommand } from "@aws-sdk/client-device-farm"; // ES Modules import + * // const { DeviceFarmClient, InstallToRemoteAccessSessionCommand } = require("@aws-sdk/client-device-farm"); // CommonJS import + * const client = new DeviceFarmClient(config); + * const command = new InstallToRemoteAccessSessionCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link InstallToRemoteAccessSessionCommandInput} for command's `input` shape. + * @see {@link InstallToRemoteAccessSessionCommandOutput} for command's `response` shape. + * @see {@link DeviceFarmClientResolvedConfig | config} for command's `input` shape. + * */ export class InstallToRemoteAccessSessionCommand extends $Command< InstallToRemoteAccessSessionCommandInput, diff --git a/clients/client-device-farm/commands/ListArtifactsCommand.ts b/clients/client-device-farm/commands/ListArtifactsCommand.ts index 5330e6daa85f..d2722f5141ea 100644 --- a/clients/client-device-farm/commands/ListArtifactsCommand.ts +++ b/clients/client-device-farm/commands/ListArtifactsCommand.ts @@ -22,6 +22,20 @@ export interface ListArtifactsCommandOutput extends ListArtifactsResult, __Metad /** *

Gets information about artifacts.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { DeviceFarmClient, ListArtifactsCommand } from "@aws-sdk/client-device-farm"; // ES Modules import + * // const { DeviceFarmClient, ListArtifactsCommand } = require("@aws-sdk/client-device-farm"); // CommonJS import + * const client = new DeviceFarmClient(config); + * const command = new ListArtifactsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListArtifactsCommandInput} for command's `input` shape. + * @see {@link ListArtifactsCommandOutput} for command's `response` shape. + * @see {@link DeviceFarmClientResolvedConfig | config} for command's `input` shape. + * */ export class ListArtifactsCommand extends $Command< ListArtifactsCommandInput, diff --git a/clients/client-device-farm/commands/ListDeviceInstancesCommand.ts b/clients/client-device-farm/commands/ListDeviceInstancesCommand.ts index b996b2844f85..f2770ce7f5da 100644 --- a/clients/client-device-farm/commands/ListDeviceInstancesCommand.ts +++ b/clients/client-device-farm/commands/ListDeviceInstancesCommand.ts @@ -23,6 +23,20 @@ export interface ListDeviceInstancesCommandOutput extends ListDeviceInstancesRes /** *

Returns information about the private device instances associated with one or more AWS * accounts.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { DeviceFarmClient, ListDeviceInstancesCommand } from "@aws-sdk/client-device-farm"; // ES Modules import + * // const { DeviceFarmClient, ListDeviceInstancesCommand } = require("@aws-sdk/client-device-farm"); // CommonJS import + * const client = new DeviceFarmClient(config); + * const command = new ListDeviceInstancesCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListDeviceInstancesCommandInput} for command's `input` shape. + * @see {@link ListDeviceInstancesCommandOutput} for command's `response` shape. + * @see {@link DeviceFarmClientResolvedConfig | config} for command's `input` shape. + * */ export class ListDeviceInstancesCommand extends $Command< ListDeviceInstancesCommandInput, diff --git a/clients/client-device-farm/commands/ListDevicePoolsCommand.ts b/clients/client-device-farm/commands/ListDevicePoolsCommand.ts index 4a7a33deb20d..6a8ffda5583e 100644 --- a/clients/client-device-farm/commands/ListDevicePoolsCommand.ts +++ b/clients/client-device-farm/commands/ListDevicePoolsCommand.ts @@ -22,6 +22,20 @@ export interface ListDevicePoolsCommandOutput extends ListDevicePoolsResult, __M /** *

Gets information about device pools.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { DeviceFarmClient, ListDevicePoolsCommand } from "@aws-sdk/client-device-farm"; // ES Modules import + * // const { DeviceFarmClient, ListDevicePoolsCommand } = require("@aws-sdk/client-device-farm"); // CommonJS import + * const client = new DeviceFarmClient(config); + * const command = new ListDevicePoolsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListDevicePoolsCommandInput} for command's `input` shape. + * @see {@link ListDevicePoolsCommandOutput} for command's `response` shape. + * @see {@link DeviceFarmClientResolvedConfig | config} for command's `input` shape. + * */ export class ListDevicePoolsCommand extends $Command< ListDevicePoolsCommandInput, diff --git a/clients/client-device-farm/commands/ListDevicesCommand.ts b/clients/client-device-farm/commands/ListDevicesCommand.ts index a4146c162b8d..ed250e68f358 100644 --- a/clients/client-device-farm/commands/ListDevicesCommand.ts +++ b/clients/client-device-farm/commands/ListDevicesCommand.ts @@ -22,6 +22,20 @@ export interface ListDevicesCommandOutput extends ListDevicesResult, __MetadataB /** *

Gets information about unique device types.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { DeviceFarmClient, ListDevicesCommand } from "@aws-sdk/client-device-farm"; // ES Modules import + * // const { DeviceFarmClient, ListDevicesCommand } = require("@aws-sdk/client-device-farm"); // CommonJS import + * const client = new DeviceFarmClient(config); + * const command = new ListDevicesCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListDevicesCommandInput} for command's `input` shape. + * @see {@link ListDevicesCommandOutput} for command's `response` shape. + * @see {@link DeviceFarmClientResolvedConfig | config} for command's `input` shape. + * */ export class ListDevicesCommand extends $Command< ListDevicesCommandInput, diff --git a/clients/client-device-farm/commands/ListInstanceProfilesCommand.ts b/clients/client-device-farm/commands/ListInstanceProfilesCommand.ts index 664d7532a84c..032ffef81e7e 100644 --- a/clients/client-device-farm/commands/ListInstanceProfilesCommand.ts +++ b/clients/client-device-farm/commands/ListInstanceProfilesCommand.ts @@ -22,6 +22,20 @@ export interface ListInstanceProfilesCommandOutput extends ListInstanceProfilesR /** *

Returns information about all the instance profiles in an AWS account.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { DeviceFarmClient, ListInstanceProfilesCommand } from "@aws-sdk/client-device-farm"; // ES Modules import + * // const { DeviceFarmClient, ListInstanceProfilesCommand } = require("@aws-sdk/client-device-farm"); // CommonJS import + * const client = new DeviceFarmClient(config); + * const command = new ListInstanceProfilesCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListInstanceProfilesCommandInput} for command's `input` shape. + * @see {@link ListInstanceProfilesCommandOutput} for command's `response` shape. + * @see {@link DeviceFarmClientResolvedConfig | config} for command's `input` shape. + * */ export class ListInstanceProfilesCommand extends $Command< ListInstanceProfilesCommandInput, diff --git a/clients/client-device-farm/commands/ListJobsCommand.ts b/clients/client-device-farm/commands/ListJobsCommand.ts index 83fe4d4940b0..0f3276f68a7b 100644 --- a/clients/client-device-farm/commands/ListJobsCommand.ts +++ b/clients/client-device-farm/commands/ListJobsCommand.ts @@ -19,6 +19,20 @@ export interface ListJobsCommandOutput extends ListJobsResult, __MetadataBearer /** *

Gets information about jobs for a given test run.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { DeviceFarmClient, ListJobsCommand } from "@aws-sdk/client-device-farm"; // ES Modules import + * // const { DeviceFarmClient, ListJobsCommand } = require("@aws-sdk/client-device-farm"); // CommonJS import + * const client = new DeviceFarmClient(config); + * const command = new ListJobsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListJobsCommandInput} for command's `input` shape. + * @see {@link ListJobsCommandOutput} for command's `response` shape. + * @see {@link DeviceFarmClientResolvedConfig | config} for command's `input` shape. + * */ export class ListJobsCommand extends $Command< ListJobsCommandInput, diff --git a/clients/client-device-farm/commands/ListNetworkProfilesCommand.ts b/clients/client-device-farm/commands/ListNetworkProfilesCommand.ts index 99787975012c..2694d5e5140a 100644 --- a/clients/client-device-farm/commands/ListNetworkProfilesCommand.ts +++ b/clients/client-device-farm/commands/ListNetworkProfilesCommand.ts @@ -22,6 +22,20 @@ export interface ListNetworkProfilesCommandOutput extends ListNetworkProfilesRes /** *

Returns the list of available network profiles.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { DeviceFarmClient, ListNetworkProfilesCommand } from "@aws-sdk/client-device-farm"; // ES Modules import + * // const { DeviceFarmClient, ListNetworkProfilesCommand } = require("@aws-sdk/client-device-farm"); // CommonJS import + * const client = new DeviceFarmClient(config); + * const command = new ListNetworkProfilesCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListNetworkProfilesCommandInput} for command's `input` shape. + * @see {@link ListNetworkProfilesCommandOutput} for command's `response` shape. + * @see {@link DeviceFarmClientResolvedConfig | config} for command's `input` shape. + * */ export class ListNetworkProfilesCommand extends $Command< ListNetworkProfilesCommandInput, diff --git a/clients/client-device-farm/commands/ListOfferingPromotionsCommand.ts b/clients/client-device-farm/commands/ListOfferingPromotionsCommand.ts index a4fcba4cffcd..3174de93383b 100644 --- a/clients/client-device-farm/commands/ListOfferingPromotionsCommand.ts +++ b/clients/client-device-farm/commands/ListOfferingPromotionsCommand.ts @@ -24,6 +24,20 @@ export interface ListOfferingPromotionsCommandOutput extends ListOfferingPromoti *

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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { DeviceFarmClient, ListOfferingPromotionsCommand } from "@aws-sdk/client-device-farm"; // ES Modules import + * // const { DeviceFarmClient, ListOfferingPromotionsCommand } = require("@aws-sdk/client-device-farm"); // CommonJS import + * const client = new DeviceFarmClient(config); + * const command = new ListOfferingPromotionsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListOfferingPromotionsCommandInput} for command's `input` shape. + * @see {@link ListOfferingPromotionsCommandOutput} for command's `response` shape. + * @see {@link DeviceFarmClientResolvedConfig | config} for command's `input` shape. + * */ export class ListOfferingPromotionsCommand extends $Command< ListOfferingPromotionsCommandInput, diff --git a/clients/client-device-farm/commands/ListOfferingTransactionsCommand.ts b/clients/client-device-farm/commands/ListOfferingTransactionsCommand.ts index c0caf55a54ab..a1943f0f04b9 100644 --- a/clients/client-device-farm/commands/ListOfferingTransactionsCommand.ts +++ b/clients/client-device-farm/commands/ListOfferingTransactionsCommand.ts @@ -25,6 +25,20 @@ export interface ListOfferingTransactionsCommandOutput extends ListOfferingTrans * 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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { DeviceFarmClient, ListOfferingTransactionsCommand } from "@aws-sdk/client-device-farm"; // ES Modules import + * // const { DeviceFarmClient, ListOfferingTransactionsCommand } = require("@aws-sdk/client-device-farm"); // CommonJS import + * const client = new DeviceFarmClient(config); + * const command = new ListOfferingTransactionsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListOfferingTransactionsCommandInput} for command's `input` shape. + * @see {@link ListOfferingTransactionsCommandOutput} for command's `response` shape. + * @see {@link DeviceFarmClientResolvedConfig | config} for command's `input` shape. + * */ export class ListOfferingTransactionsCommand extends $Command< ListOfferingTransactionsCommandInput, diff --git a/clients/client-device-farm/commands/ListOfferingsCommand.ts b/clients/client-device-farm/commands/ListOfferingsCommand.ts index 808f47e05520..8e8789e57553 100644 --- a/clients/client-device-farm/commands/ListOfferingsCommand.ts +++ b/clients/client-device-farm/commands/ListOfferingsCommand.ts @@ -25,6 +25,20 @@ export interface ListOfferingsCommandOutput extends ListOfferingsResult, __Metad * 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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { DeviceFarmClient, ListOfferingsCommand } from "@aws-sdk/client-device-farm"; // ES Modules import + * // const { DeviceFarmClient, ListOfferingsCommand } = require("@aws-sdk/client-device-farm"); // CommonJS import + * const client = new DeviceFarmClient(config); + * const command = new ListOfferingsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListOfferingsCommandInput} for command's `input` shape. + * @see {@link ListOfferingsCommandOutput} for command's `response` shape. + * @see {@link DeviceFarmClientResolvedConfig | config} for command's `input` shape. + * */ export class ListOfferingsCommand extends $Command< ListOfferingsCommandInput, diff --git a/clients/client-device-farm/commands/ListProjectsCommand.ts b/clients/client-device-farm/commands/ListProjectsCommand.ts index 32757b217352..cbf0855a7a7d 100644 --- a/clients/client-device-farm/commands/ListProjectsCommand.ts +++ b/clients/client-device-farm/commands/ListProjectsCommand.ts @@ -22,6 +22,20 @@ export interface ListProjectsCommandOutput extends ListProjectsResult, __Metadat /** *

Gets information about projects.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { DeviceFarmClient, ListProjectsCommand } from "@aws-sdk/client-device-farm"; // ES Modules import + * // const { DeviceFarmClient, ListProjectsCommand } = require("@aws-sdk/client-device-farm"); // CommonJS import + * const client = new DeviceFarmClient(config); + * const command = new ListProjectsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListProjectsCommandInput} for command's `input` shape. + * @see {@link ListProjectsCommandOutput} for command's `response` shape. + * @see {@link DeviceFarmClientResolvedConfig | config} for command's `input` shape. + * */ export class ListProjectsCommand extends $Command< ListProjectsCommandInput, diff --git a/clients/client-device-farm/commands/ListRemoteAccessSessionsCommand.ts b/clients/client-device-farm/commands/ListRemoteAccessSessionsCommand.ts index a45b0b77f530..b566692df4b2 100644 --- a/clients/client-device-farm/commands/ListRemoteAccessSessionsCommand.ts +++ b/clients/client-device-farm/commands/ListRemoteAccessSessionsCommand.ts @@ -22,6 +22,20 @@ export interface ListRemoteAccessSessionsCommandOutput extends ListRemoteAccessS /** *

Returns a list of all currently running remote access sessions.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { DeviceFarmClient, ListRemoteAccessSessionsCommand } from "@aws-sdk/client-device-farm"; // ES Modules import + * // const { DeviceFarmClient, ListRemoteAccessSessionsCommand } = require("@aws-sdk/client-device-farm"); // CommonJS import + * const client = new DeviceFarmClient(config); + * const command = new ListRemoteAccessSessionsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListRemoteAccessSessionsCommandInput} for command's `input` shape. + * @see {@link ListRemoteAccessSessionsCommandOutput} for command's `response` shape. + * @see {@link DeviceFarmClientResolvedConfig | config} for command's `input` shape. + * */ export class ListRemoteAccessSessionsCommand extends $Command< ListRemoteAccessSessionsCommandInput, diff --git a/clients/client-device-farm/commands/ListRunsCommand.ts b/clients/client-device-farm/commands/ListRunsCommand.ts index 3679234259b3..c868c5d42f5f 100644 --- a/clients/client-device-farm/commands/ListRunsCommand.ts +++ b/clients/client-device-farm/commands/ListRunsCommand.ts @@ -19,6 +19,20 @@ export interface ListRunsCommandOutput extends ListRunsResult, __MetadataBearer /** *

Gets information about runs, given an AWS Device Farm project ARN.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { DeviceFarmClient, ListRunsCommand } from "@aws-sdk/client-device-farm"; // ES Modules import + * // const { DeviceFarmClient, ListRunsCommand } = require("@aws-sdk/client-device-farm"); // CommonJS import + * const client = new DeviceFarmClient(config); + * const command = new ListRunsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListRunsCommandInput} for command's `input` shape. + * @see {@link ListRunsCommandOutput} for command's `response` shape. + * @see {@link DeviceFarmClientResolvedConfig | config} for command's `input` shape. + * */ export class ListRunsCommand extends $Command< ListRunsCommandInput, diff --git a/clients/client-device-farm/commands/ListSamplesCommand.ts b/clients/client-device-farm/commands/ListSamplesCommand.ts index 1fba35fd7d36..9db42765f9f1 100644 --- a/clients/client-device-farm/commands/ListSamplesCommand.ts +++ b/clients/client-device-farm/commands/ListSamplesCommand.ts @@ -22,6 +22,20 @@ export interface ListSamplesCommandOutput extends ListSamplesResult, __MetadataB /** *

Gets information about samples, given an AWS Device Farm job ARN.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { DeviceFarmClient, ListSamplesCommand } from "@aws-sdk/client-device-farm"; // ES Modules import + * // const { DeviceFarmClient, ListSamplesCommand } = require("@aws-sdk/client-device-farm"); // CommonJS import + * const client = new DeviceFarmClient(config); + * const command = new ListSamplesCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListSamplesCommandInput} for command's `input` shape. + * @see {@link ListSamplesCommandOutput} for command's `response` shape. + * @see {@link DeviceFarmClientResolvedConfig | config} for command's `input` shape. + * */ export class ListSamplesCommand extends $Command< ListSamplesCommandInput, diff --git a/clients/client-device-farm/commands/ListSuitesCommand.ts b/clients/client-device-farm/commands/ListSuitesCommand.ts index 2328232ae1ad..8ec34a044486 100644 --- a/clients/client-device-farm/commands/ListSuitesCommand.ts +++ b/clients/client-device-farm/commands/ListSuitesCommand.ts @@ -22,6 +22,20 @@ export interface ListSuitesCommandOutput extends ListSuitesResult, __MetadataBea /** *

Gets information about test suites for a given job.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { DeviceFarmClient, ListSuitesCommand } from "@aws-sdk/client-device-farm"; // ES Modules import + * // const { DeviceFarmClient, ListSuitesCommand } = require("@aws-sdk/client-device-farm"); // CommonJS import + * const client = new DeviceFarmClient(config); + * const command = new ListSuitesCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListSuitesCommandInput} for command's `input` shape. + * @see {@link ListSuitesCommandOutput} for command's `response` shape. + * @see {@link DeviceFarmClientResolvedConfig | config} for command's `input` shape. + * */ export class ListSuitesCommand extends $Command< ListSuitesCommandInput, diff --git a/clients/client-device-farm/commands/ListTagsForResourceCommand.ts b/clients/client-device-farm/commands/ListTagsForResourceCommand.ts index 868095cbd839..e82a2e6bb740 100644 --- a/clients/client-device-farm/commands/ListTagsForResourceCommand.ts +++ b/clients/client-device-farm/commands/ListTagsForResourceCommand.ts @@ -22,6 +22,20 @@ export interface ListTagsForResourceCommandOutput extends ListTagsForResourceRes /** *

List the tags for an AWS Device Farm resource.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { DeviceFarmClient, ListTagsForResourceCommand } from "@aws-sdk/client-device-farm"; // ES Modules import + * // const { DeviceFarmClient, ListTagsForResourceCommand } = require("@aws-sdk/client-device-farm"); // CommonJS import + * const client = new DeviceFarmClient(config); + * const command = new ListTagsForResourceCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListTagsForResourceCommandInput} for command's `input` shape. + * @see {@link ListTagsForResourceCommandOutput} for command's `response` shape. + * @see {@link DeviceFarmClientResolvedConfig | config} for command's `input` shape. + * */ export class ListTagsForResourceCommand extends $Command< ListTagsForResourceCommandInput, diff --git a/clients/client-device-farm/commands/ListTestGridProjectsCommand.ts b/clients/client-device-farm/commands/ListTestGridProjectsCommand.ts index fc5b55bf10fa..5c93a97e8a3e 100644 --- a/clients/client-device-farm/commands/ListTestGridProjectsCommand.ts +++ b/clients/client-device-farm/commands/ListTestGridProjectsCommand.ts @@ -22,6 +22,20 @@ export interface ListTestGridProjectsCommandOutput extends ListTestGridProjectsR /** *

Gets a list of all Selenium testing projects in your account.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { DeviceFarmClient, ListTestGridProjectsCommand } from "@aws-sdk/client-device-farm"; // ES Modules import + * // const { DeviceFarmClient, ListTestGridProjectsCommand } = require("@aws-sdk/client-device-farm"); // CommonJS import + * const client = new DeviceFarmClient(config); + * const command = new ListTestGridProjectsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListTestGridProjectsCommandInput} for command's `input` shape. + * @see {@link ListTestGridProjectsCommandOutput} for command's `response` shape. + * @see {@link DeviceFarmClientResolvedConfig | config} for command's `input` shape. + * */ export class ListTestGridProjectsCommand extends $Command< ListTestGridProjectsCommandInput, diff --git a/clients/client-device-farm/commands/ListTestGridSessionActionsCommand.ts b/clients/client-device-farm/commands/ListTestGridSessionActionsCommand.ts index 4c0127818d8c..feff51d0bcd6 100644 --- a/clients/client-device-farm/commands/ListTestGridSessionActionsCommand.ts +++ b/clients/client-device-farm/commands/ListTestGridSessionActionsCommand.ts @@ -22,6 +22,20 @@ export interface ListTestGridSessionActionsCommandOutput extends ListTestGridSes /** *

Returns a list of the actions taken in a TestGridSession.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { DeviceFarmClient, ListTestGridSessionActionsCommand } from "@aws-sdk/client-device-farm"; // ES Modules import + * // const { DeviceFarmClient, ListTestGridSessionActionsCommand } = require("@aws-sdk/client-device-farm"); // CommonJS import + * const client = new DeviceFarmClient(config); + * const command = new ListTestGridSessionActionsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListTestGridSessionActionsCommandInput} for command's `input` shape. + * @see {@link ListTestGridSessionActionsCommandOutput} for command's `response` shape. + * @see {@link DeviceFarmClientResolvedConfig | config} for command's `input` shape. + * */ export class ListTestGridSessionActionsCommand extends $Command< ListTestGridSessionActionsCommandInput, diff --git a/clients/client-device-farm/commands/ListTestGridSessionArtifactsCommand.ts b/clients/client-device-farm/commands/ListTestGridSessionArtifactsCommand.ts index 724654b45257..e05d45cbc971 100644 --- a/clients/client-device-farm/commands/ListTestGridSessionArtifactsCommand.ts +++ b/clients/client-device-farm/commands/ListTestGridSessionArtifactsCommand.ts @@ -24,6 +24,20 @@ export interface ListTestGridSessionArtifactsCommandOutput /** *

Retrieves a list of artifacts created during the session.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { DeviceFarmClient, ListTestGridSessionArtifactsCommand } from "@aws-sdk/client-device-farm"; // ES Modules import + * // const { DeviceFarmClient, ListTestGridSessionArtifactsCommand } = require("@aws-sdk/client-device-farm"); // CommonJS import + * const client = new DeviceFarmClient(config); + * const command = new ListTestGridSessionArtifactsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListTestGridSessionArtifactsCommandInput} for command's `input` shape. + * @see {@link ListTestGridSessionArtifactsCommandOutput} for command's `response` shape. + * @see {@link DeviceFarmClientResolvedConfig | config} for command's `input` shape. + * */ export class ListTestGridSessionArtifactsCommand extends $Command< ListTestGridSessionArtifactsCommandInput, diff --git a/clients/client-device-farm/commands/ListTestGridSessionsCommand.ts b/clients/client-device-farm/commands/ListTestGridSessionsCommand.ts index 331880f6f244..e695be561a23 100644 --- a/clients/client-device-farm/commands/ListTestGridSessionsCommand.ts +++ b/clients/client-device-farm/commands/ListTestGridSessionsCommand.ts @@ -22,6 +22,20 @@ export interface ListTestGridSessionsCommandOutput extends ListTestGridSessionsR /** *

Retrieves a list of sessions for a TestGridProject.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { DeviceFarmClient, ListTestGridSessionsCommand } from "@aws-sdk/client-device-farm"; // ES Modules import + * // const { DeviceFarmClient, ListTestGridSessionsCommand } = require("@aws-sdk/client-device-farm"); // CommonJS import + * const client = new DeviceFarmClient(config); + * const command = new ListTestGridSessionsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListTestGridSessionsCommandInput} for command's `input` shape. + * @see {@link ListTestGridSessionsCommandOutput} for command's `response` shape. + * @see {@link DeviceFarmClientResolvedConfig | config} for command's `input` shape. + * */ export class ListTestGridSessionsCommand extends $Command< ListTestGridSessionsCommandInput, diff --git a/clients/client-device-farm/commands/ListTestsCommand.ts b/clients/client-device-farm/commands/ListTestsCommand.ts index 72f511798f2c..16506286b82c 100644 --- a/clients/client-device-farm/commands/ListTestsCommand.ts +++ b/clients/client-device-farm/commands/ListTestsCommand.ts @@ -19,6 +19,20 @@ export interface ListTestsCommandOutput extends ListTestsResult, __MetadataBeare /** *

Gets information about tests in a given test suite.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { DeviceFarmClient, ListTestsCommand } from "@aws-sdk/client-device-farm"; // ES Modules import + * // const { DeviceFarmClient, ListTestsCommand } = require("@aws-sdk/client-device-farm"); // CommonJS import + * const client = new DeviceFarmClient(config); + * const command = new ListTestsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListTestsCommandInput} for command's `input` shape. + * @see {@link ListTestsCommandOutput} for command's `response` shape. + * @see {@link DeviceFarmClientResolvedConfig | config} for command's `input` shape. + * */ export class ListTestsCommand extends $Command< ListTestsCommandInput, diff --git a/clients/client-device-farm/commands/ListUniqueProblemsCommand.ts b/clients/client-device-farm/commands/ListUniqueProblemsCommand.ts index 7952772bdc0a..ed180a72bdbf 100644 --- a/clients/client-device-farm/commands/ListUniqueProblemsCommand.ts +++ b/clients/client-device-farm/commands/ListUniqueProblemsCommand.ts @@ -26,6 +26,20 @@ export interface ListUniqueProblemsCommandOutput extends ListUniqueProblemsResul * 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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { DeviceFarmClient, ListUniqueProblemsCommand } from "@aws-sdk/client-device-farm"; // ES Modules import + * // const { DeviceFarmClient, ListUniqueProblemsCommand } = require("@aws-sdk/client-device-farm"); // CommonJS import + * const client = new DeviceFarmClient(config); + * const command = new ListUniqueProblemsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListUniqueProblemsCommandInput} for command's `input` shape. + * @see {@link ListUniqueProblemsCommandOutput} for command's `response` shape. + * @see {@link DeviceFarmClientResolvedConfig | config} for command's `input` shape. + * */ export class ListUniqueProblemsCommand extends $Command< ListUniqueProblemsCommandInput, diff --git a/clients/client-device-farm/commands/ListUploadsCommand.ts b/clients/client-device-farm/commands/ListUploadsCommand.ts index 64fa6120af3d..86bbeb57fd74 100644 --- a/clients/client-device-farm/commands/ListUploadsCommand.ts +++ b/clients/client-device-farm/commands/ListUploadsCommand.ts @@ -22,6 +22,20 @@ export interface ListUploadsCommandOutput extends ListUploadsResult, __MetadataB /** *

Gets information about uploads, given an AWS Device Farm project ARN.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { DeviceFarmClient, ListUploadsCommand } from "@aws-sdk/client-device-farm"; // ES Modules import + * // const { DeviceFarmClient, ListUploadsCommand } = require("@aws-sdk/client-device-farm"); // CommonJS import + * const client = new DeviceFarmClient(config); + * const command = new ListUploadsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListUploadsCommandInput} for command's `input` shape. + * @see {@link ListUploadsCommandOutput} for command's `response` shape. + * @see {@link DeviceFarmClientResolvedConfig | config} for command's `input` shape. + * */ export class ListUploadsCommand extends $Command< ListUploadsCommandInput, diff --git a/clients/client-device-farm/commands/ListVPCEConfigurationsCommand.ts b/clients/client-device-farm/commands/ListVPCEConfigurationsCommand.ts index 1f9818d9f267..0a0701259316 100644 --- a/clients/client-device-farm/commands/ListVPCEConfigurationsCommand.ts +++ b/clients/client-device-farm/commands/ListVPCEConfigurationsCommand.ts @@ -23,6 +23,20 @@ export interface ListVPCEConfigurationsCommandOutput extends ListVPCEConfigurati /** *

Returns information about all Amazon Virtual Private Cloud (VPC) endpoint * configurations in the AWS account.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { DeviceFarmClient, ListVPCEConfigurationsCommand } from "@aws-sdk/client-device-farm"; // ES Modules import + * // const { DeviceFarmClient, ListVPCEConfigurationsCommand } = require("@aws-sdk/client-device-farm"); // CommonJS import + * const client = new DeviceFarmClient(config); + * const command = new ListVPCEConfigurationsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListVPCEConfigurationsCommandInput} for command's `input` shape. + * @see {@link ListVPCEConfigurationsCommandOutput} for command's `response` shape. + * @see {@link DeviceFarmClientResolvedConfig | config} for command's `input` shape. + * */ export class ListVPCEConfigurationsCommand extends $Command< ListVPCEConfigurationsCommandInput, diff --git a/clients/client-device-farm/commands/PurchaseOfferingCommand.ts b/clients/client-device-farm/commands/PurchaseOfferingCommand.ts index 5bc62f336a09..a7a3e26bd33c 100644 --- a/clients/client-device-farm/commands/PurchaseOfferingCommand.ts +++ b/clients/client-device-farm/commands/PurchaseOfferingCommand.ts @@ -25,6 +25,20 @@ export interface PurchaseOfferingCommandOutput extends PurchaseOfferingResult, _ * 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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { DeviceFarmClient, PurchaseOfferingCommand } from "@aws-sdk/client-device-farm"; // ES Modules import + * // const { DeviceFarmClient, PurchaseOfferingCommand } = require("@aws-sdk/client-device-farm"); // CommonJS import + * const client = new DeviceFarmClient(config); + * const command = new PurchaseOfferingCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link PurchaseOfferingCommandInput} for command's `input` shape. + * @see {@link PurchaseOfferingCommandOutput} for command's `response` shape. + * @see {@link DeviceFarmClientResolvedConfig | config} for command's `input` shape. + * */ export class PurchaseOfferingCommand extends $Command< PurchaseOfferingCommandInput, diff --git a/clients/client-device-farm/commands/RenewOfferingCommand.ts b/clients/client-device-farm/commands/RenewOfferingCommand.ts index b9fac1fb395f..c4f137b8fb55 100644 --- a/clients/client-device-farm/commands/RenewOfferingCommand.ts +++ b/clients/client-device-farm/commands/RenewOfferingCommand.ts @@ -24,6 +24,20 @@ export interface RenewOfferingCommandOutput extends RenewOfferingResult, __Metad *

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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { DeviceFarmClient, RenewOfferingCommand } from "@aws-sdk/client-device-farm"; // ES Modules import + * // const { DeviceFarmClient, RenewOfferingCommand } = require("@aws-sdk/client-device-farm"); // CommonJS import + * const client = new DeviceFarmClient(config); + * const command = new RenewOfferingCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link RenewOfferingCommandInput} for command's `input` shape. + * @see {@link RenewOfferingCommandOutput} for command's `response` shape. + * @see {@link DeviceFarmClientResolvedConfig | config} for command's `input` shape. + * */ export class RenewOfferingCommand extends $Command< RenewOfferingCommandInput, diff --git a/clients/client-device-farm/commands/ScheduleRunCommand.ts b/clients/client-device-farm/commands/ScheduleRunCommand.ts index edfeb39c00e5..e3a011e8018e 100644 --- a/clients/client-device-farm/commands/ScheduleRunCommand.ts +++ b/clients/client-device-farm/commands/ScheduleRunCommand.ts @@ -22,6 +22,20 @@ export interface ScheduleRunCommandOutput extends ScheduleRunResult, __MetadataB /** *

Schedules a run.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { DeviceFarmClient, ScheduleRunCommand } from "@aws-sdk/client-device-farm"; // ES Modules import + * // const { DeviceFarmClient, ScheduleRunCommand } = require("@aws-sdk/client-device-farm"); // CommonJS import + * const client = new DeviceFarmClient(config); + * const command = new ScheduleRunCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ScheduleRunCommandInput} for command's `input` shape. + * @see {@link ScheduleRunCommandOutput} for command's `response` shape. + * @see {@link DeviceFarmClientResolvedConfig | config} for command's `input` shape. + * */ export class ScheduleRunCommand extends $Command< ScheduleRunCommandInput, diff --git a/clients/client-device-farm/commands/StopJobCommand.ts b/clients/client-device-farm/commands/StopJobCommand.ts index 9789ecd3a71d..f6b4bb0ffdad 100644 --- a/clients/client-device-farm/commands/StopJobCommand.ts +++ b/clients/client-device-farm/commands/StopJobCommand.ts @@ -22,6 +22,20 @@ export interface StopJobCommandOutput extends StopJobResult, __MetadataBearer {} * 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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { DeviceFarmClient, StopJobCommand } from "@aws-sdk/client-device-farm"; // ES Modules import + * // const { DeviceFarmClient, StopJobCommand } = require("@aws-sdk/client-device-farm"); // CommonJS import + * const client = new DeviceFarmClient(config); + * const command = new StopJobCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link StopJobCommandInput} for command's `input` shape. + * @see {@link StopJobCommandOutput} for command's `response` shape. + * @see {@link DeviceFarmClientResolvedConfig | config} for command's `input` shape. + * */ export class StopJobCommand extends $Command< StopJobCommandInput, diff --git a/clients/client-device-farm/commands/StopRemoteAccessSessionCommand.ts b/clients/client-device-farm/commands/StopRemoteAccessSessionCommand.ts index 14e7f102d169..5495f5962bbf 100644 --- a/clients/client-device-farm/commands/StopRemoteAccessSessionCommand.ts +++ b/clients/client-device-farm/commands/StopRemoteAccessSessionCommand.ts @@ -22,6 +22,20 @@ export interface StopRemoteAccessSessionCommandOutput extends StopRemoteAccessSe /** *

Ends a specified remote access session.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { DeviceFarmClient, StopRemoteAccessSessionCommand } from "@aws-sdk/client-device-farm"; // ES Modules import + * // const { DeviceFarmClient, StopRemoteAccessSessionCommand } = require("@aws-sdk/client-device-farm"); // CommonJS import + * const client = new DeviceFarmClient(config); + * const command = new StopRemoteAccessSessionCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link StopRemoteAccessSessionCommandInput} for command's `input` shape. + * @see {@link StopRemoteAccessSessionCommandOutput} for command's `response` shape. + * @see {@link DeviceFarmClientResolvedConfig | config} for command's `input` shape. + * */ export class StopRemoteAccessSessionCommand extends $Command< StopRemoteAccessSessionCommandInput, diff --git a/clients/client-device-farm/commands/StopRunCommand.ts b/clients/client-device-farm/commands/StopRunCommand.ts index 626d7bfe8238..04e8203040ec 100644 --- a/clients/client-device-farm/commands/StopRunCommand.ts +++ b/clients/client-device-farm/commands/StopRunCommand.ts @@ -22,6 +22,20 @@ export interface StopRunCommandOutput extends StopRunResult, __MetadataBearer {} * 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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { DeviceFarmClient, StopRunCommand } from "@aws-sdk/client-device-farm"; // ES Modules import + * // const { DeviceFarmClient, StopRunCommand } = require("@aws-sdk/client-device-farm"); // CommonJS import + * const client = new DeviceFarmClient(config); + * const command = new StopRunCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link StopRunCommandInput} for command's `input` shape. + * @see {@link StopRunCommandOutput} for command's `response` shape. + * @see {@link DeviceFarmClientResolvedConfig | config} for command's `input` shape. + * */ export class StopRunCommand extends $Command< StopRunCommandInput, diff --git a/clients/client-device-farm/commands/TagResourceCommand.ts b/clients/client-device-farm/commands/TagResourceCommand.ts index 820f4be37cbf..796d1450782b 100644 --- a/clients/client-device-farm/commands/TagResourceCommand.ts +++ b/clients/client-device-farm/commands/TagResourceCommand.ts @@ -24,6 +24,20 @@ export interface TagResourceCommandOutput extends TagResourceResponse, __Metadat *

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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { DeviceFarmClient, TagResourceCommand } from "@aws-sdk/client-device-farm"; // ES Modules import + * // const { DeviceFarmClient, TagResourceCommand } = require("@aws-sdk/client-device-farm"); // CommonJS import + * const client = new DeviceFarmClient(config); + * const command = new TagResourceCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link TagResourceCommandInput} for command's `input` shape. + * @see {@link TagResourceCommandOutput} for command's `response` shape. + * @see {@link DeviceFarmClientResolvedConfig | config} for command's `input` shape. + * */ export class TagResourceCommand extends $Command< TagResourceCommandInput, diff --git a/clients/client-device-farm/commands/UntagResourceCommand.ts b/clients/client-device-farm/commands/UntagResourceCommand.ts index 397ca8786739..90ca4c132541 100644 --- a/clients/client-device-farm/commands/UntagResourceCommand.ts +++ b/clients/client-device-farm/commands/UntagResourceCommand.ts @@ -22,6 +22,20 @@ export interface UntagResourceCommandOutput extends UntagResourceResponse, __Met /** *

Deletes the specified tags from a resource.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { DeviceFarmClient, UntagResourceCommand } from "@aws-sdk/client-device-farm"; // ES Modules import + * // const { DeviceFarmClient, UntagResourceCommand } = require("@aws-sdk/client-device-farm"); // CommonJS import + * const client = new DeviceFarmClient(config); + * const command = new UntagResourceCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link UntagResourceCommandInput} for command's `input` shape. + * @see {@link UntagResourceCommandOutput} for command's `response` shape. + * @see {@link DeviceFarmClientResolvedConfig | config} for command's `input` shape. + * */ export class UntagResourceCommand extends $Command< UntagResourceCommandInput, diff --git a/clients/client-device-farm/commands/UpdateDeviceInstanceCommand.ts b/clients/client-device-farm/commands/UpdateDeviceInstanceCommand.ts index 34f67eb2a16e..1d983ef43dc4 100644 --- a/clients/client-device-farm/commands/UpdateDeviceInstanceCommand.ts +++ b/clients/client-device-farm/commands/UpdateDeviceInstanceCommand.ts @@ -22,6 +22,20 @@ export interface UpdateDeviceInstanceCommandOutput extends UpdateDeviceInstanceR /** *

Updates information about a private device instance.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { DeviceFarmClient, UpdateDeviceInstanceCommand } from "@aws-sdk/client-device-farm"; // ES Modules import + * // const { DeviceFarmClient, UpdateDeviceInstanceCommand } = require("@aws-sdk/client-device-farm"); // CommonJS import + * const client = new DeviceFarmClient(config); + * const command = new UpdateDeviceInstanceCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link UpdateDeviceInstanceCommandInput} for command's `input` shape. + * @see {@link UpdateDeviceInstanceCommandOutput} for command's `response` shape. + * @see {@link DeviceFarmClientResolvedConfig | config} for command's `input` shape. + * */ export class UpdateDeviceInstanceCommand extends $Command< UpdateDeviceInstanceCommandInput, diff --git a/clients/client-device-farm/commands/UpdateDevicePoolCommand.ts b/clients/client-device-farm/commands/UpdateDevicePoolCommand.ts index abcf03dff740..493ddff08e32 100644 --- a/clients/client-device-farm/commands/UpdateDevicePoolCommand.ts +++ b/clients/client-device-farm/commands/UpdateDevicePoolCommand.ts @@ -24,6 +24,20 @@ export interface UpdateDevicePoolCommandOutput extends UpdateDevicePoolResult, _ *

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).

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { DeviceFarmClient, UpdateDevicePoolCommand } from "@aws-sdk/client-device-farm"; // ES Modules import + * // const { DeviceFarmClient, UpdateDevicePoolCommand } = require("@aws-sdk/client-device-farm"); // CommonJS import + * const client = new DeviceFarmClient(config); + * const command = new UpdateDevicePoolCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link UpdateDevicePoolCommandInput} for command's `input` shape. + * @see {@link UpdateDevicePoolCommandOutput} for command's `response` shape. + * @see {@link DeviceFarmClientResolvedConfig | config} for command's `input` shape. + * */ export class UpdateDevicePoolCommand extends $Command< UpdateDevicePoolCommandInput, diff --git a/clients/client-device-farm/commands/UpdateInstanceProfileCommand.ts b/clients/client-device-farm/commands/UpdateInstanceProfileCommand.ts index e20e73b489ba..4e3587f58812 100644 --- a/clients/client-device-farm/commands/UpdateInstanceProfileCommand.ts +++ b/clients/client-device-farm/commands/UpdateInstanceProfileCommand.ts @@ -22,6 +22,20 @@ export interface UpdateInstanceProfileCommandOutput extends UpdateInstanceProfil /** *

Updates information about an existing private device instance profile.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { DeviceFarmClient, UpdateInstanceProfileCommand } from "@aws-sdk/client-device-farm"; // ES Modules import + * // const { DeviceFarmClient, UpdateInstanceProfileCommand } = require("@aws-sdk/client-device-farm"); // CommonJS import + * const client = new DeviceFarmClient(config); + * const command = new UpdateInstanceProfileCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link UpdateInstanceProfileCommandInput} for command's `input` shape. + * @see {@link UpdateInstanceProfileCommandOutput} for command's `response` shape. + * @see {@link DeviceFarmClientResolvedConfig | config} for command's `input` shape. + * */ export class UpdateInstanceProfileCommand extends $Command< UpdateInstanceProfileCommandInput, diff --git a/clients/client-device-farm/commands/UpdateNetworkProfileCommand.ts b/clients/client-device-farm/commands/UpdateNetworkProfileCommand.ts index f794f211f558..c12e823044c3 100644 --- a/clients/client-device-farm/commands/UpdateNetworkProfileCommand.ts +++ b/clients/client-device-farm/commands/UpdateNetworkProfileCommand.ts @@ -22,6 +22,20 @@ export interface UpdateNetworkProfileCommandOutput extends UpdateNetworkProfileR /** *

Updates the network profile.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { DeviceFarmClient, UpdateNetworkProfileCommand } from "@aws-sdk/client-device-farm"; // ES Modules import + * // const { DeviceFarmClient, UpdateNetworkProfileCommand } = require("@aws-sdk/client-device-farm"); // CommonJS import + * const client = new DeviceFarmClient(config); + * const command = new UpdateNetworkProfileCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link UpdateNetworkProfileCommandInput} for command's `input` shape. + * @see {@link UpdateNetworkProfileCommandOutput} for command's `response` shape. + * @see {@link DeviceFarmClientResolvedConfig | config} for command's `input` shape. + * */ export class UpdateNetworkProfileCommand extends $Command< UpdateNetworkProfileCommandInput, diff --git a/clients/client-device-farm/commands/UpdateProjectCommand.ts b/clients/client-device-farm/commands/UpdateProjectCommand.ts index 078127ef56c4..0ce8e0e1bdb6 100644 --- a/clients/client-device-farm/commands/UpdateProjectCommand.ts +++ b/clients/client-device-farm/commands/UpdateProjectCommand.ts @@ -23,6 +23,20 @@ export interface UpdateProjectCommandOutput extends UpdateProjectResult, __Metad /** *

Modifies the specified project name, given the project ARN and a new * name.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { DeviceFarmClient, UpdateProjectCommand } from "@aws-sdk/client-device-farm"; // ES Modules import + * // const { DeviceFarmClient, UpdateProjectCommand } = require("@aws-sdk/client-device-farm"); // CommonJS import + * const client = new DeviceFarmClient(config); + * const command = new UpdateProjectCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link UpdateProjectCommandInput} for command's `input` shape. + * @see {@link UpdateProjectCommandOutput} for command's `response` shape. + * @see {@link DeviceFarmClientResolvedConfig | config} for command's `input` shape. + * */ export class UpdateProjectCommand extends $Command< UpdateProjectCommandInput, diff --git a/clients/client-device-farm/commands/UpdateTestGridProjectCommand.ts b/clients/client-device-farm/commands/UpdateTestGridProjectCommand.ts index 756fa0c1ff33..93ffa2fef0ef 100644 --- a/clients/client-device-farm/commands/UpdateTestGridProjectCommand.ts +++ b/clients/client-device-farm/commands/UpdateTestGridProjectCommand.ts @@ -22,6 +22,20 @@ export interface UpdateTestGridProjectCommandOutput extends UpdateTestGridProjec /** *

Change details of a project.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { DeviceFarmClient, UpdateTestGridProjectCommand } from "@aws-sdk/client-device-farm"; // ES Modules import + * // const { DeviceFarmClient, UpdateTestGridProjectCommand } = require("@aws-sdk/client-device-farm"); // CommonJS import + * const client = new DeviceFarmClient(config); + * const command = new UpdateTestGridProjectCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link UpdateTestGridProjectCommandInput} for command's `input` shape. + * @see {@link UpdateTestGridProjectCommandOutput} for command's `response` shape. + * @see {@link DeviceFarmClientResolvedConfig | config} for command's `input` shape. + * */ export class UpdateTestGridProjectCommand extends $Command< UpdateTestGridProjectCommandInput, diff --git a/clients/client-device-farm/commands/UpdateUploadCommand.ts b/clients/client-device-farm/commands/UpdateUploadCommand.ts index 0f882dbda564..be7332cb7092 100644 --- a/clients/client-device-farm/commands/UpdateUploadCommand.ts +++ b/clients/client-device-farm/commands/UpdateUploadCommand.ts @@ -22,6 +22,20 @@ export interface UpdateUploadCommandOutput extends UpdateUploadResult, __Metadat /** *

Updates an uploaded test spec.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { DeviceFarmClient, UpdateUploadCommand } from "@aws-sdk/client-device-farm"; // ES Modules import + * // const { DeviceFarmClient, UpdateUploadCommand } = require("@aws-sdk/client-device-farm"); // CommonJS import + * const client = new DeviceFarmClient(config); + * const command = new UpdateUploadCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link UpdateUploadCommandInput} for command's `input` shape. + * @see {@link UpdateUploadCommandOutput} for command's `response` shape. + * @see {@link DeviceFarmClientResolvedConfig | config} for command's `input` shape. + * */ export class UpdateUploadCommand extends $Command< UpdateUploadCommandInput, diff --git a/clients/client-device-farm/commands/UpdateVPCEConfigurationCommand.ts b/clients/client-device-farm/commands/UpdateVPCEConfigurationCommand.ts index 945e85d641e8..306b030037ed 100644 --- a/clients/client-device-farm/commands/UpdateVPCEConfigurationCommand.ts +++ b/clients/client-device-farm/commands/UpdateVPCEConfigurationCommand.ts @@ -22,6 +22,20 @@ export interface UpdateVPCEConfigurationCommandOutput extends UpdateVPCEConfigur /** *

Updates information about an Amazon Virtual Private Cloud (VPC) endpoint configuration.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { DeviceFarmClient, UpdateVPCEConfigurationCommand } from "@aws-sdk/client-device-farm"; // ES Modules import + * // const { DeviceFarmClient, UpdateVPCEConfigurationCommand } = require("@aws-sdk/client-device-farm"); // CommonJS import + * const client = new DeviceFarmClient(config); + * const command = new UpdateVPCEConfigurationCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link UpdateVPCEConfigurationCommandInput} for command's `input` shape. + * @see {@link UpdateVPCEConfigurationCommandOutput} for command's `response` shape. + * @see {@link DeviceFarmClientResolvedConfig | config} for command's `input` shape. + * */ export class UpdateVPCEConfigurationCommand extends $Command< UpdateVPCEConfigurationCommandInput, diff --git a/clients/client-device-farm/models/models_0.ts b/clients/client-device-farm/models/models_0.ts index 4f25b179bf8c..4a89d520fdb6 100644 --- a/clients/client-device-farm/models/models_0.ts +++ b/clients/client-device-farm/models/models_0.ts @@ -18,6 +18,9 @@ export interface TrialMinutes { } export namespace TrialMinutes { + /** + * @internal + */ export const filterSensitiveLog = (obj: TrialMinutes): any => ({ ...obj, }); @@ -83,6 +86,9 @@ export interface AccountSettings { } export namespace AccountSettings { + /** + * @internal + */ export const filterSensitiveLog = (obj: AccountSettings): any => ({ ...obj, }); @@ -101,6 +107,9 @@ export interface ArgumentException extends __SmithyException, $MetadataBearer { } export namespace ArgumentException { + /** + * @internal + */ export const filterSensitiveLog = (obj: ArgumentException): any => ({ ...obj, }); @@ -257,6 +266,9 @@ export interface Artifact { } export namespace Artifact { + /** + * @internal + */ export const filterSensitiveLog = (obj: Artifact): any => ({ ...obj, }); @@ -283,6 +295,9 @@ export interface CannotDeleteException extends __SmithyException, $MetadataBeare } export namespace CannotDeleteException { + /** + * @internal + */ export const filterSensitiveLog = (obj: CannotDeleteException): any => ({ ...obj, }); @@ -329,6 +344,9 @@ export interface Counters { } export namespace Counters { + /** + * @internal + */ export const filterSensitiveLog = (obj: Counters): any => ({ ...obj, }); @@ -357,6 +375,9 @@ export interface CPU { } export namespace CPU { + /** + * @internal + */ export const filterSensitiveLog = (obj: CPU): any => ({ ...obj, }); @@ -510,6 +531,9 @@ export interface Rule { } export namespace Rule { + /** + * @internal + */ export const filterSensitiveLog = (obj: Rule): any => ({ ...obj, }); @@ -551,6 +575,9 @@ export interface CreateDevicePoolRequest { } export namespace CreateDevicePoolRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateDevicePoolRequest): any => ({ ...obj, }); @@ -613,6 +640,9 @@ export interface DevicePool { } export namespace DevicePool { + /** + * @internal + */ export const filterSensitiveLog = (obj: DevicePool): any => ({ ...obj, }); @@ -629,6 +659,9 @@ export interface CreateDevicePoolResult { } export namespace CreateDevicePoolResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateDevicePoolResult): any => ({ ...obj, }); @@ -647,6 +680,9 @@ export interface LimitExceededException extends __SmithyException, $MetadataBear } export namespace LimitExceededException { + /** + * @internal + */ export const filterSensitiveLog = (obj: LimitExceededException): any => ({ ...obj, }); @@ -665,6 +701,9 @@ export interface NotFoundException extends __SmithyException, $MetadataBearer { } export namespace NotFoundException { + /** + * @internal + */ export const filterSensitiveLog = (obj: NotFoundException): any => ({ ...obj, }); @@ -683,6 +722,9 @@ export interface ServiceAccountException extends __SmithyException, $MetadataBea } export namespace ServiceAccountException { + /** + * @internal + */ export const filterSensitiveLog = (obj: ServiceAccountException): any => ({ ...obj, }); @@ -721,6 +763,9 @@ export interface CreateInstanceProfileRequest { } export namespace CreateInstanceProfileRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateInstanceProfileRequest): any => ({ ...obj, }); @@ -767,6 +812,9 @@ export interface InstanceProfile { } export namespace InstanceProfile { + /** + * @internal + */ export const filterSensitiveLog = (obj: InstanceProfile): any => ({ ...obj, }); @@ -780,6 +828,9 @@ export interface CreateInstanceProfileResult { } export namespace CreateInstanceProfileResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateInstanceProfileResult): any => ({ ...obj, }); @@ -861,6 +912,9 @@ export interface CreateNetworkProfileRequest { } export namespace CreateNetworkProfileRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateNetworkProfileRequest): any => ({ ...obj, }); @@ -939,6 +993,9 @@ export interface NetworkProfile { } export namespace NetworkProfile { + /** + * @internal + */ export const filterSensitiveLog = (obj: NetworkProfile): any => ({ ...obj, }); @@ -953,6 +1010,9 @@ export interface CreateNetworkProfileResult { } export namespace CreateNetworkProfileResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateNetworkProfileResult): any => ({ ...obj, }); @@ -975,6 +1035,9 @@ export interface CreateProjectRequest { } export namespace CreateProjectRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateProjectRequest): any => ({ ...obj, }); @@ -1008,6 +1071,9 @@ export interface Project { } export namespace Project { + /** + * @internal + */ export const filterSensitiveLog = (obj: Project): any => ({ ...obj, }); @@ -1024,6 +1090,9 @@ export interface CreateProjectResult { } export namespace CreateProjectResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateProjectResult): any => ({ ...obj, }); @@ -1040,6 +1109,9 @@ export interface TagOperationException extends __SmithyException, $MetadataBeare } export namespace TagOperationException { + /** + * @internal + */ export const filterSensitiveLog = (obj: TagOperationException): any => ({ ...obj, }); @@ -1062,6 +1134,9 @@ export interface CreateRemoteAccessSessionConfiguration { } export namespace CreateRemoteAccessSessionConfiguration { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateRemoteAccessSessionConfiguration): any => ({ ...obj, }); @@ -1173,6 +1248,9 @@ export interface CreateRemoteAccessSessionRequest { } export namespace CreateRemoteAccessSessionRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateRemoteAccessSessionRequest): any => ({ ...obj, }); @@ -1233,6 +1311,9 @@ export interface DeviceInstance { } export namespace DeviceInstance { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeviceInstance): any => ({ ...obj, }); @@ -1255,6 +1336,9 @@ export interface Resolution { } export namespace Resolution { + /** + * @internal + */ export const filterSensitiveLog = (obj: Resolution): any => ({ ...obj, }); @@ -1393,6 +1477,9 @@ export interface Device { } export namespace Device { + /** + * @internal + */ export const filterSensitiveLog = (obj: Device): any => ({ ...obj, }); @@ -1423,6 +1510,9 @@ export interface DeviceMinutes { } export namespace DeviceMinutes { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeviceMinutes): any => ({ ...obj, }); @@ -1648,6 +1738,9 @@ export interface RemoteAccessSession { } export namespace RemoteAccessSession { + /** + * @internal + */ export const filterSensitiveLog = (obj: RemoteAccessSession): any => ({ ...obj, }); @@ -1666,6 +1759,9 @@ export interface CreateRemoteAccessSessionResult { } export namespace CreateRemoteAccessSessionResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateRemoteAccessSessionResult): any => ({ ...obj, }); @@ -1684,6 +1780,9 @@ export interface CreateTestGridProjectRequest { } export namespace CreateTestGridProjectRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateTestGridProjectRequest): any => ({ ...obj, }); @@ -1715,6 +1814,9 @@ export interface TestGridProject { } export namespace TestGridProject { + /** + * @internal + */ export const filterSensitiveLog = (obj: TestGridProject): any => ({ ...obj, }); @@ -1728,6 +1830,9 @@ export interface CreateTestGridProjectResult { } export namespace CreateTestGridProjectResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateTestGridProjectResult): any => ({ ...obj, }); @@ -1744,6 +1849,9 @@ export interface InternalServiceException extends __SmithyException, $MetadataBe } export namespace InternalServiceException { + /** + * @internal + */ export const filterSensitiveLog = (obj: InternalServiceException): any => ({ ...obj, }); @@ -1763,6 +1871,9 @@ export interface CreateTestGridUrlRequest { } export namespace CreateTestGridUrlRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateTestGridUrlRequest): any => ({ ...obj, }); @@ -1782,6 +1893,9 @@ export interface CreateTestGridUrlResult { } export namespace CreateTestGridUrlResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateTestGridUrlResult): any => ({ ...obj, }); @@ -1952,6 +2066,9 @@ export interface CreateUploadRequest { } export namespace CreateUploadRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateUploadRequest): any => ({ ...obj, }); @@ -2150,6 +2267,9 @@ export interface Upload { } export namespace Upload { + /** + * @internal + */ export const filterSensitiveLog = (obj: Upload): any => ({ ...obj, }); @@ -2166,6 +2286,9 @@ export interface CreateUploadResult { } export namespace CreateUploadResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateUploadResult): any => ({ ...obj, }); @@ -2196,6 +2319,9 @@ export interface CreateVPCEConfigurationRequest { } export namespace CreateVPCEConfigurationRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateVPCEConfigurationRequest): any => ({ ...obj, }); @@ -2234,6 +2360,9 @@ export interface VPCEConfiguration { } export namespace VPCEConfiguration { + /** + * @internal + */ export const filterSensitiveLog = (obj: VPCEConfiguration): any => ({ ...obj, }); @@ -2247,6 +2376,9 @@ export interface CreateVPCEConfigurationResult { } export namespace CreateVPCEConfigurationResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateVPCEConfigurationResult): any => ({ ...obj, }); @@ -2285,6 +2417,9 @@ export interface CustomerArtifactPaths { } export namespace CustomerArtifactPaths { + /** + * @internal + */ export const filterSensitiveLog = (obj: CustomerArtifactPaths): any => ({ ...obj, }); @@ -2301,6 +2436,9 @@ export interface DeleteDevicePoolRequest { } export namespace DeleteDevicePoolRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteDevicePoolRequest): any => ({ ...obj, }); @@ -2312,6 +2450,9 @@ export namespace DeleteDevicePoolRequest { export interface DeleteDevicePoolResult {} export namespace DeleteDevicePoolResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteDevicePoolResult): any => ({ ...obj, }); @@ -2326,6 +2467,9 @@ export interface DeleteInstanceProfileRequest { } export namespace DeleteInstanceProfileRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteInstanceProfileRequest): any => ({ ...obj, }); @@ -2334,6 +2478,9 @@ export namespace DeleteInstanceProfileRequest { export interface DeleteInstanceProfileResult {} export namespace DeleteInstanceProfileResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteInstanceProfileResult): any => ({ ...obj, }); @@ -2347,6 +2494,9 @@ export interface DeleteNetworkProfileRequest { } export namespace DeleteNetworkProfileRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteNetworkProfileRequest): any => ({ ...obj, }); @@ -2355,6 +2505,9 @@ export namespace DeleteNetworkProfileRequest { export interface DeleteNetworkProfileResult {} export namespace DeleteNetworkProfileResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteNetworkProfileResult): any => ({ ...obj, }); @@ -2371,6 +2524,9 @@ export interface DeleteProjectRequest { } export namespace DeleteProjectRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteProjectRequest): any => ({ ...obj, }); @@ -2382,6 +2538,9 @@ export namespace DeleteProjectRequest { export interface DeleteProjectResult {} export namespace DeleteProjectResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteProjectResult): any => ({ ...obj, }); @@ -2399,6 +2558,9 @@ export interface DeleteRemoteAccessSessionRequest { } export namespace DeleteRemoteAccessSessionRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteRemoteAccessSessionRequest): any => ({ ...obj, }); @@ -2411,6 +2573,9 @@ export namespace DeleteRemoteAccessSessionRequest { export interface DeleteRemoteAccessSessionResult {} export namespace DeleteRemoteAccessSessionResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteRemoteAccessSessionResult): any => ({ ...obj, }); @@ -2427,6 +2592,9 @@ export interface DeleteRunRequest { } export namespace DeleteRunRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteRunRequest): any => ({ ...obj, }); @@ -2438,6 +2606,9 @@ export namespace DeleteRunRequest { export interface DeleteRunResult {} export namespace DeleteRunResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteRunResult): any => ({ ...obj, }); @@ -2451,6 +2622,9 @@ export interface DeleteTestGridProjectRequest { } export namespace DeleteTestGridProjectRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteTestGridProjectRequest): any => ({ ...obj, }); @@ -2459,6 +2633,9 @@ export namespace DeleteTestGridProjectRequest { export interface DeleteTestGridProjectResult {} export namespace DeleteTestGridProjectResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteTestGridProjectResult): any => ({ ...obj, }); @@ -2475,6 +2652,9 @@ export interface DeleteUploadRequest { } export namespace DeleteUploadRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteUploadRequest): any => ({ ...obj, }); @@ -2486,6 +2666,9 @@ export namespace DeleteUploadRequest { export interface DeleteUploadResult {} export namespace DeleteUploadResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteUploadResult): any => ({ ...obj, }); @@ -2500,6 +2683,9 @@ export interface DeleteVPCEConfigurationRequest { } export namespace DeleteVPCEConfigurationRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteVPCEConfigurationRequest): any => ({ ...obj, }); @@ -2508,6 +2694,9 @@ export namespace DeleteVPCEConfigurationRequest { export interface DeleteVPCEConfigurationResult {} export namespace DeleteVPCEConfigurationResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteVPCEConfigurationResult): any => ({ ...obj, }); @@ -2524,6 +2713,9 @@ export interface InvalidOperationException extends __SmithyException, $MetadataB } export namespace InvalidOperationException { + /** + * @internal + */ export const filterSensitiveLog = (obj: InvalidOperationException): any => ({ ...obj, }); @@ -2535,6 +2727,9 @@ export namespace InvalidOperationException { export interface GetAccountSettingsRequest {} export namespace GetAccountSettingsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetAccountSettingsRequest): any => ({ ...obj, }); @@ -2552,6 +2747,9 @@ export interface GetAccountSettingsResult { } export namespace GetAccountSettingsResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetAccountSettingsResult): any => ({ ...obj, }); @@ -2568,6 +2766,9 @@ export interface GetDeviceRequest { } export namespace GetDeviceRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetDeviceRequest): any => ({ ...obj, }); @@ -2584,6 +2785,9 @@ export interface GetDeviceResult { } export namespace GetDeviceResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetDeviceResult): any => ({ ...obj, }); @@ -2598,6 +2802,9 @@ export interface GetDeviceInstanceRequest { } export namespace GetDeviceInstanceRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetDeviceInstanceRequest): any => ({ ...obj, }); @@ -2611,6 +2818,9 @@ export interface GetDeviceInstanceResult { } export namespace GetDeviceInstanceResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetDeviceInstanceResult): any => ({ ...obj, }); @@ -2627,6 +2837,9 @@ export interface GetDevicePoolRequest { } export namespace GetDevicePoolRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetDevicePoolRequest): any => ({ ...obj, }); @@ -2643,6 +2856,9 @@ export interface GetDevicePoolResult { } export namespace GetDevicePoolResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetDevicePoolResult): any => ({ ...obj, }); @@ -2666,6 +2882,9 @@ export interface Location { } export namespace Location { + /** + * @internal + */ export const filterSensitiveLog = (obj: Location): any => ({ ...obj, }); @@ -2698,6 +2917,9 @@ export interface Radios { } export namespace Radios { + /** + * @internal + */ export const filterSensitiveLog = (obj: Radios): any => ({ ...obj, }); @@ -2763,6 +2985,9 @@ export interface ScheduleRunConfiguration { } export namespace ScheduleRunConfiguration { + /** + * @internal + */ export const filterSensitiveLog = (obj: ScheduleRunConfiguration): any => ({ ...obj, }); @@ -3017,6 +3242,9 @@ export interface ScheduleRunTest { } export namespace ScheduleRunTest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ScheduleRunTest): any => ({ ...obj, }); @@ -3111,6 +3339,9 @@ export interface GetDevicePoolCompatibilityRequest { } export namespace GetDevicePoolCompatibilityRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetDevicePoolCompatibilityRequest): any => ({ ...obj, }); @@ -3153,6 +3384,9 @@ export interface IncompatibilityMessage { } export namespace IncompatibilityMessage { + /** + * @internal + */ export const filterSensitiveLog = (obj: IncompatibilityMessage): any => ({ ...obj, }); @@ -3179,6 +3413,9 @@ export interface DevicePoolCompatibilityResult { } export namespace DevicePoolCompatibilityResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: DevicePoolCompatibilityResult): any => ({ ...obj, }); @@ -3200,6 +3437,9 @@ export interface GetDevicePoolCompatibilityResult { } export namespace GetDevicePoolCompatibilityResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetDevicePoolCompatibilityResult): any => ({ ...obj, }); @@ -3213,6 +3453,9 @@ export interface GetInstanceProfileRequest { } export namespace GetInstanceProfileRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetInstanceProfileRequest): any => ({ ...obj, }); @@ -3226,6 +3469,9 @@ export interface GetInstanceProfileResult { } export namespace GetInstanceProfileResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetInstanceProfileResult): any => ({ ...obj, }); @@ -3242,6 +3488,9 @@ export interface GetJobRequest { } export namespace GetJobRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetJobRequest): any => ({ ...obj, }); @@ -3440,6 +3689,9 @@ export interface Job { } export namespace Job { + /** + * @internal + */ export const filterSensitiveLog = (obj: Job): any => ({ ...obj, }); @@ -3456,6 +3708,9 @@ export interface GetJobResult { } export namespace GetJobResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetJobResult): any => ({ ...obj, }); @@ -3469,6 +3724,9 @@ export interface GetNetworkProfileRequest { } export namespace GetNetworkProfileRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetNetworkProfileRequest): any => ({ ...obj, }); @@ -3482,6 +3740,9 @@ export interface GetNetworkProfileResult { } export namespace GetNetworkProfileResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetNetworkProfileResult): any => ({ ...obj, }); @@ -3500,6 +3761,9 @@ export interface GetOfferingStatusRequest { } export namespace GetOfferingStatusRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetOfferingStatusRequest): any => ({ ...obj, }); @@ -3521,6 +3785,9 @@ export interface MonetaryAmount { } export namespace MonetaryAmount { + /** + * @internal + */ export const filterSensitiveLog = (obj: MonetaryAmount): any => ({ ...obj, }); @@ -3546,6 +3813,9 @@ export interface RecurringCharge { } export namespace RecurringCharge { + /** + * @internal + */ export const filterSensitiveLog = (obj: RecurringCharge): any => ({ ...obj, }); @@ -3586,6 +3856,9 @@ export interface Offering { } export namespace Offering { + /** + * @internal + */ export const filterSensitiveLog = (obj: Offering): any => ({ ...obj, }); @@ -3623,6 +3896,9 @@ export interface OfferingStatus { } export namespace OfferingStatus { + /** + * @internal + */ export const filterSensitiveLog = (obj: OfferingStatus): any => ({ ...obj, }); @@ -3650,6 +3926,9 @@ export interface GetOfferingStatusResult { } export namespace GetOfferingStatusResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetOfferingStatusResult): any => ({ ...obj, }); @@ -3669,6 +3948,9 @@ export interface NotEligibleException extends __SmithyException, $MetadataBearer } export namespace NotEligibleException { + /** + * @internal + */ export const filterSensitiveLog = (obj: NotEligibleException): any => ({ ...obj, }); @@ -3685,6 +3967,9 @@ export interface GetProjectRequest { } export namespace GetProjectRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetProjectRequest): any => ({ ...obj, }); @@ -3701,6 +3986,9 @@ export interface GetProjectResult { } export namespace GetProjectResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetProjectResult): any => ({ ...obj, }); @@ -3719,6 +4007,9 @@ export interface GetRemoteAccessSessionRequest { } export namespace GetRemoteAccessSessionRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetRemoteAccessSessionRequest): any => ({ ...obj, }); @@ -3737,6 +4028,9 @@ export interface GetRemoteAccessSessionResult { } export namespace GetRemoteAccessSessionResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetRemoteAccessSessionResult): any => ({ ...obj, }); @@ -3753,6 +4047,9 @@ export interface GetRunRequest { } export namespace GetRunRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetRunRequest): any => ({ ...obj, }); @@ -3917,6 +4214,9 @@ export interface DeviceFilter { } export namespace DeviceFilter { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeviceFilter): any => ({ ...obj, }); @@ -3945,6 +4245,9 @@ export interface DeviceSelectionResult { } export namespace DeviceSelectionResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeviceSelectionResult): any => ({ ...obj, }); @@ -4255,6 +4558,9 @@ export interface Run { } export namespace Run { + /** + * @internal + */ export const filterSensitiveLog = (obj: Run): any => ({ ...obj, }); @@ -4271,6 +4577,9 @@ export interface GetRunResult { } export namespace GetRunResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetRunResult): any => ({ ...obj, }); @@ -4287,6 +4596,9 @@ export interface GetSuiteRequest { } export namespace GetSuiteRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetSuiteRequest): any => ({ ...obj, }); @@ -4469,6 +4781,9 @@ export interface Suite { } export namespace Suite { + /** + * @internal + */ export const filterSensitiveLog = (obj: Suite): any => ({ ...obj, }); @@ -4485,6 +4800,9 @@ export interface GetSuiteResult { } export namespace GetSuiteResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetSuiteResult): any => ({ ...obj, }); @@ -4501,6 +4819,9 @@ export interface GetTestRequest { } export namespace GetTestRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetTestRequest): any => ({ ...obj, }); @@ -4682,6 +5003,9 @@ export interface Test { } export namespace Test { + /** + * @internal + */ export const filterSensitiveLog = (obj: Test): any => ({ ...obj, }); @@ -4698,6 +5022,9 @@ export interface GetTestResult { } export namespace GetTestResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetTestResult): any => ({ ...obj, }); @@ -4711,6 +5038,9 @@ export interface GetTestGridProjectRequest { } export namespace GetTestGridProjectRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetTestGridProjectRequest): any => ({ ...obj, }); @@ -4724,6 +5054,9 @@ export interface GetTestGridProjectResult { } export namespace GetTestGridProjectResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetTestGridProjectResult): any => ({ ...obj, }); @@ -4747,6 +5080,9 @@ export interface GetTestGridSessionRequest { } export namespace GetTestGridSessionRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetTestGridSessionRequest): any => ({ ...obj, }); @@ -4795,6 +5131,9 @@ export interface TestGridSession { } export namespace TestGridSession { + /** + * @internal + */ export const filterSensitiveLog = (obj: TestGridSession): any => ({ ...obj, }); @@ -4808,6 +5147,9 @@ export interface GetTestGridSessionResult { } export namespace GetTestGridSessionResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetTestGridSessionResult): any => ({ ...obj, }); @@ -4824,6 +5166,9 @@ export interface GetUploadRequest { } export namespace GetUploadRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetUploadRequest): any => ({ ...obj, }); @@ -4841,6 +5186,9 @@ export interface GetUploadResult { } export namespace GetUploadResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetUploadResult): any => ({ ...obj, }); @@ -4855,6 +5203,9 @@ export interface GetVPCEConfigurationRequest { } export namespace GetVPCEConfigurationRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetVPCEConfigurationRequest): any => ({ ...obj, }); @@ -4868,6 +5219,9 @@ export interface GetVPCEConfigurationResult { } export namespace GetVPCEConfigurationResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetVPCEConfigurationResult): any => ({ ...obj, }); @@ -4891,6 +5245,9 @@ export interface InstallToRemoteAccessSessionRequest { } export namespace InstallToRemoteAccessSessionRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: InstallToRemoteAccessSessionRequest): any => ({ ...obj, }); @@ -4908,6 +5265,9 @@ export interface InstallToRemoteAccessSessionResult { } export namespace InstallToRemoteAccessSessionResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: InstallToRemoteAccessSessionResult): any => ({ ...obj, }); @@ -4947,6 +5307,9 @@ export interface ListArtifactsRequest { } export namespace ListArtifactsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListArtifactsRequest): any => ({ ...obj, }); @@ -4970,6 +5333,9 @@ export interface ListArtifactsResult { } export namespace ListArtifactsResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListArtifactsResult): any => ({ ...obj, }); @@ -4989,6 +5355,9 @@ export interface ListDeviceInstancesRequest { } export namespace ListDeviceInstancesRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListDeviceInstancesRequest): any => ({ ...obj, }); @@ -5008,6 +5377,9 @@ export interface ListDeviceInstancesResult { } export namespace ListDeviceInstancesResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListDeviceInstancesResult): any => ({ ...obj, }); @@ -5046,6 +5418,9 @@ export interface ListDevicePoolsRequest { } export namespace ListDevicePoolsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListDevicePoolsRequest): any => ({ ...obj, }); @@ -5069,6 +5444,9 @@ export interface ListDevicePoolsResult { } export namespace ListDevicePoolsResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListDevicePoolsResult): any => ({ ...obj, }); @@ -5186,6 +5564,9 @@ export interface ListDevicesRequest { } export namespace ListDevicesRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListDevicesRequest): any => ({ ...obj, }); @@ -5209,6 +5590,9 @@ export interface ListDevicesResult { } export namespace ListDevicesResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListDevicesResult): any => ({ ...obj, }); @@ -5228,6 +5612,9 @@ export interface ListInstanceProfilesRequest { } export namespace ListInstanceProfilesRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListInstanceProfilesRequest): any => ({ ...obj, }); @@ -5247,6 +5634,9 @@ export interface ListInstanceProfilesResult { } export namespace ListInstanceProfilesResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListInstanceProfilesResult): any => ({ ...obj, }); @@ -5269,6 +5659,9 @@ export interface ListJobsRequest { } export namespace ListJobsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListJobsRequest): any => ({ ...obj, }); @@ -5292,6 +5685,9 @@ export interface ListJobsResult { } export namespace ListJobsResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListJobsResult): any => ({ ...obj, }); @@ -5317,6 +5713,9 @@ export interface ListNetworkProfilesRequest { } export namespace ListNetworkProfilesRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListNetworkProfilesRequest): any => ({ ...obj, }); @@ -5336,6 +5735,9 @@ export interface ListNetworkProfilesResult { } export namespace ListNetworkProfilesResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListNetworkProfilesResult): any => ({ ...obj, }); @@ -5350,6 +5752,9 @@ export interface ListOfferingPromotionsRequest { } export namespace ListOfferingPromotionsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListOfferingPromotionsRequest): any => ({ ...obj, }); @@ -5371,6 +5776,9 @@ export interface OfferingPromotion { } export namespace OfferingPromotion { + /** + * @internal + */ export const filterSensitiveLog = (obj: OfferingPromotion): any => ({ ...obj, }); @@ -5390,6 +5798,9 @@ export interface ListOfferingPromotionsResult { } export namespace ListOfferingPromotionsResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListOfferingPromotionsResult): any => ({ ...obj, }); @@ -5407,6 +5818,9 @@ export interface ListOfferingsRequest { } export namespace ListOfferingsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListOfferingsRequest): any => ({ ...obj, }); @@ -5429,6 +5843,9 @@ export interface ListOfferingsResult { } export namespace ListOfferingsResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListOfferingsResult): any => ({ ...obj, }); @@ -5446,6 +5863,9 @@ export interface ListOfferingTransactionsRequest { } export namespace ListOfferingTransactionsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListOfferingTransactionsRequest): any => ({ ...obj, }); @@ -5482,6 +5902,9 @@ export interface OfferingTransaction { } export namespace OfferingTransaction { + /** + * @internal + */ export const filterSensitiveLog = (obj: OfferingTransaction): any => ({ ...obj, }); @@ -5505,6 +5928,9 @@ export interface ListOfferingTransactionsResult { } export namespace ListOfferingTransactionsResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListOfferingTransactionsResult): any => ({ ...obj, }); @@ -5529,6 +5955,9 @@ export interface ListProjectsRequest { } export namespace ListProjectsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListProjectsRequest): any => ({ ...obj, }); @@ -5552,6 +5981,9 @@ export interface ListProjectsResult { } export namespace ListProjectsResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListProjectsResult): any => ({ ...obj, }); @@ -5576,6 +6008,9 @@ export interface ListRemoteAccessSessionsRequest { } export namespace ListRemoteAccessSessionsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListRemoteAccessSessionsRequest): any => ({ ...obj, }); @@ -5600,6 +6035,9 @@ export interface ListRemoteAccessSessionsResult { } export namespace ListRemoteAccessSessionsResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListRemoteAccessSessionsResult): any => ({ ...obj, }); @@ -5623,6 +6061,9 @@ export interface ListRunsRequest { } export namespace ListRunsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListRunsRequest): any => ({ ...obj, }); @@ -5646,6 +6087,9 @@ export interface ListRunsResult { } export namespace ListRunsResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListRunsResult): any => ({ ...obj, }); @@ -5668,6 +6112,9 @@ export interface ListSamplesRequest { } export namespace ListSamplesRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListSamplesRequest): any => ({ ...obj, }); @@ -5774,6 +6221,9 @@ export interface Sample { } export namespace Sample { + /** + * @internal + */ export const filterSensitiveLog = (obj: Sample): any => ({ ...obj, }); @@ -5797,6 +6247,9 @@ export interface ListSamplesResult { } export namespace ListSamplesResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListSamplesResult): any => ({ ...obj, }); @@ -5819,6 +6272,9 @@ export interface ListSuitesRequest { } export namespace ListSuitesRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListSuitesRequest): any => ({ ...obj, }); @@ -5842,6 +6298,9 @@ export interface ListSuitesResult { } export namespace ListSuitesResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListSuitesResult): any => ({ ...obj, }); @@ -5859,6 +6318,9 @@ export interface ListTagsForResourceRequest { } export namespace ListTagsForResourceRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListTagsForResourceRequest): any => ({ ...obj, }); @@ -5884,6 +6346,9 @@ export interface Tag { } export namespace Tag { + /** + * @internal + */ export const filterSensitiveLog = (obj: Tag): any => ({ ...obj, }); @@ -5898,6 +6363,9 @@ export interface ListTagsForResourceResponse { } export namespace ListTagsForResourceResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListTagsForResourceResponse): any => ({ ...obj, }); @@ -5916,6 +6384,9 @@ export interface ListTestGridProjectsRequest { } export namespace ListTestGridProjectsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListTestGridProjectsRequest): any => ({ ...obj, }); @@ -5935,6 +6406,9 @@ export interface ListTestGridProjectsResult { } export namespace ListTestGridProjectsResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListTestGridProjectsResult): any => ({ ...obj, }); @@ -5958,6 +6432,9 @@ export interface ListTestGridSessionActionsRequest { } export namespace ListTestGridSessionActionsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListTestGridSessionActionsRequest): any => ({ ...obj, }); @@ -5994,6 +6471,9 @@ export interface TestGridSessionAction { } export namespace TestGridSessionAction { + /** + * @internal + */ export const filterSensitiveLog = (obj: TestGridSessionAction): any => ({ ...obj, }); @@ -6012,6 +6492,9 @@ export interface ListTestGridSessionActionsResult { } export namespace ListTestGridSessionActionsResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListTestGridSessionActionsResult): any => ({ ...obj, }); @@ -6045,6 +6528,9 @@ export interface ListTestGridSessionArtifactsRequest { } export namespace ListTestGridSessionArtifactsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListTestGridSessionArtifactsRequest): any => ({ ...obj, }); @@ -6081,6 +6567,9 @@ export interface TestGridSessionArtifact { } export namespace TestGridSessionArtifact { + /** + * @internal + */ export const filterSensitiveLog = (obj: TestGridSessionArtifact): any => ({ ...obj, }); @@ -6099,6 +6588,9 @@ export interface ListTestGridSessionArtifactsResult { } export namespace ListTestGridSessionArtifactsResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListTestGridSessionArtifactsResult): any => ({ ...obj, }); @@ -6147,6 +6639,9 @@ export interface ListTestGridSessionsRequest { } export namespace ListTestGridSessionsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListTestGridSessionsRequest): any => ({ ...obj, }); @@ -6165,6 +6660,9 @@ export interface ListTestGridSessionsResult { } export namespace ListTestGridSessionsResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListTestGridSessionsResult): any => ({ ...obj, }); @@ -6187,6 +6685,9 @@ export interface ListTestsRequest { } export namespace ListTestsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListTestsRequest): any => ({ ...obj, }); @@ -6210,6 +6711,9 @@ export interface ListTestsResult { } export namespace ListTestsResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListTestsResult): any => ({ ...obj, }); @@ -6232,6 +6736,9 @@ export interface ListUniqueProblemsRequest { } export namespace ListUniqueProblemsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListUniqueProblemsRequest): any => ({ ...obj, }); @@ -6253,6 +6760,9 @@ export interface ProblemDetail { } export namespace ProblemDetail { + /** + * @internal + */ export const filterSensitiveLog = (obj: ProblemDetail): any => ({ ...obj, }); @@ -6323,6 +6833,9 @@ export interface Problem { } export namespace Problem { + /** + * @internal + */ export const filterSensitiveLog = (obj: Problem): any => ({ ...obj, }); @@ -6344,6 +6857,9 @@ export interface UniqueProblem { } export namespace UniqueProblem { + /** + * @internal + */ export const filterSensitiveLog = (obj: UniqueProblem): any => ({ ...obj, }); @@ -6391,6 +6907,9 @@ export interface ListUniqueProblemsResult { } export namespace ListUniqueProblemsResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListUniqueProblemsResult): any => ({ ...obj, }); @@ -6518,6 +7037,9 @@ export interface ListUploadsRequest { } export namespace ListUploadsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListUploadsRequest): any => ({ ...obj, }); @@ -6541,6 +7063,9 @@ export interface ListUploadsResult { } export namespace ListUploadsResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListUploadsResult): any => ({ ...obj, }); @@ -6560,6 +7085,9 @@ export interface ListVPCEConfigurationsRequest { } export namespace ListVPCEConfigurationsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListVPCEConfigurationsRequest): any => ({ ...obj, }); @@ -6580,6 +7108,9 @@ export interface ListVPCEConfigurationsResult { } export namespace ListVPCEConfigurationsResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListVPCEConfigurationsResult): any => ({ ...obj, }); @@ -6606,6 +7137,9 @@ export interface PurchaseOfferingRequest { } export namespace PurchaseOfferingRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: PurchaseOfferingRequest): any => ({ ...obj, }); @@ -6622,6 +7156,9 @@ export interface PurchaseOfferingResult { } export namespace PurchaseOfferingResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: PurchaseOfferingResult): any => ({ ...obj, }); @@ -6643,6 +7180,9 @@ export interface RenewOfferingRequest { } export namespace RenewOfferingRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: RenewOfferingRequest): any => ({ ...obj, }); @@ -6659,6 +7199,9 @@ export interface RenewOfferingResult { } export namespace RenewOfferingResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: RenewOfferingResult): any => ({ ...obj, }); @@ -6677,6 +7220,9 @@ export interface IdempotencyException extends __SmithyException, $MetadataBearer } export namespace IdempotencyException { + /** + * @internal + */ export const filterSensitiveLog = (obj: IdempotencyException): any => ({ ...obj, }); @@ -6820,6 +7366,9 @@ export interface DeviceSelectionConfiguration { } export namespace DeviceSelectionConfiguration { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeviceSelectionConfiguration): any => ({ ...obj, }); @@ -6860,6 +7409,9 @@ export interface ExecutionConfiguration { } export namespace ExecutionConfiguration { + /** + * @internal + */ export const filterSensitiveLog = (obj: ExecutionConfiguration): any => ({ ...obj, }); @@ -6920,6 +7472,9 @@ export interface ScheduleRunRequest { } export namespace ScheduleRunRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ScheduleRunRequest): any => ({ ...obj, }); @@ -6936,6 +7491,9 @@ export interface ScheduleRunResult { } export namespace ScheduleRunResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: ScheduleRunResult): any => ({ ...obj, }); @@ -6949,6 +7507,9 @@ export interface StopJobRequest { } export namespace StopJobRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: StopJobRequest): any => ({ ...obj, }); @@ -6962,6 +7523,9 @@ export interface StopJobResult { } export namespace StopJobResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: StopJobResult): any => ({ ...obj, }); @@ -6978,6 +7542,9 @@ export interface StopRemoteAccessSessionRequest { } export namespace StopRemoteAccessSessionRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: StopRemoteAccessSessionRequest): any => ({ ...obj, }); @@ -6996,6 +7563,9 @@ export interface StopRemoteAccessSessionResult { } export namespace StopRemoteAccessSessionResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: StopRemoteAccessSessionResult): any => ({ ...obj, }); @@ -7012,6 +7582,9 @@ export interface StopRunRequest { } export namespace StopRunRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: StopRunRequest): any => ({ ...obj, }); @@ -7028,6 +7601,9 @@ export interface StopRunResult { } export namespace StopRunResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: StopRunResult): any => ({ ...obj, }); @@ -7045,6 +7621,9 @@ export interface TagPolicyException extends __SmithyException, $MetadataBearer { } export namespace TagPolicyException { + /** + * @internal + */ export const filterSensitiveLog = (obj: TagPolicyException): any => ({ ...obj, }); @@ -7068,6 +7647,9 @@ export interface TagResourceRequest { } export namespace TagResourceRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: TagResourceRequest): any => ({ ...obj, }); @@ -7076,6 +7658,9 @@ export namespace TagResourceRequest { export interface TagResourceResponse {} export namespace TagResourceResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: TagResourceResponse): any => ({ ...obj, }); @@ -7093,6 +7678,9 @@ export interface TooManyTagsException extends __SmithyException, $MetadataBearer } export namespace TooManyTagsException { + /** + * @internal + */ export const filterSensitiveLog = (obj: TooManyTagsException): any => ({ ...obj, }); @@ -7115,6 +7703,9 @@ export interface UntagResourceRequest { } export namespace UntagResourceRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: UntagResourceRequest): any => ({ ...obj, }); @@ -7123,6 +7714,9 @@ export namespace UntagResourceRequest { export interface UntagResourceResponse {} export namespace UntagResourceResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: UntagResourceResponse): any => ({ ...obj, }); @@ -7146,6 +7740,9 @@ export interface UpdateDeviceInstanceRequest { } export namespace UpdateDeviceInstanceRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateDeviceInstanceRequest): any => ({ ...obj, }); @@ -7159,6 +7756,9 @@ export interface UpdateDeviceInstanceResult { } export namespace UpdateDeviceInstanceResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateDeviceInstanceResult): any => ({ ...obj, }); @@ -7213,6 +7813,9 @@ export interface UpdateDevicePoolRequest { } export namespace UpdateDevicePoolRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateDevicePoolRequest): any => ({ ...obj, }); @@ -7229,6 +7832,9 @@ export interface UpdateDevicePoolResult { } export namespace UpdateDevicePoolResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateDevicePoolResult): any => ({ ...obj, }); @@ -7272,6 +7878,9 @@ export interface UpdateInstanceProfileRequest { } export namespace UpdateInstanceProfileRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateInstanceProfileRequest): any => ({ ...obj, }); @@ -7285,6 +7894,9 @@ export interface UpdateInstanceProfileResult { } export namespace UpdateInstanceProfileResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateInstanceProfileResult): any => ({ ...obj, }); @@ -7363,6 +7975,9 @@ export interface UpdateNetworkProfileRequest { } export namespace UpdateNetworkProfileRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateNetworkProfileRequest): any => ({ ...obj, }); @@ -7376,6 +7991,9 @@ export interface UpdateNetworkProfileResult { } export namespace UpdateNetworkProfileResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateNetworkProfileResult): any => ({ ...obj, }); @@ -7402,6 +8020,9 @@ export interface UpdateProjectRequest { } export namespace UpdateProjectRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateProjectRequest): any => ({ ...obj, }); @@ -7418,6 +8039,9 @@ export interface UpdateProjectResult { } export namespace UpdateProjectResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateProjectResult): any => ({ ...obj, }); @@ -7441,6 +8065,9 @@ export interface UpdateTestGridProjectRequest { } export namespace UpdateTestGridProjectRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateTestGridProjectRequest): any => ({ ...obj, }); @@ -7454,6 +8081,9 @@ export interface UpdateTestGridProjectResult { } export namespace UpdateTestGridProjectResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateTestGridProjectResult): any => ({ ...obj, }); @@ -7483,6 +8113,9 @@ export interface UpdateUploadRequest { } export namespace UpdateUploadRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateUploadRequest): any => ({ ...obj, }); @@ -7496,6 +8129,9 @@ export interface UpdateUploadResult { } export namespace UpdateUploadResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateUploadResult): any => ({ ...obj, }); @@ -7532,6 +8168,9 @@ export interface UpdateVPCEConfigurationRequest { } export namespace UpdateVPCEConfigurationRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateVPCEConfigurationRequest): any => ({ ...obj, }); @@ -7545,6 +8184,9 @@ export interface UpdateVPCEConfigurationResult { } export namespace UpdateVPCEConfigurationResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateVPCEConfigurationResult): any => ({ ...obj, }); diff --git a/clients/client-devops-guru/commands/AddNotificationChannelCommand.ts b/clients/client-devops-guru/commands/AddNotificationChannelCommand.ts index e2e512eaef91..186a84e040e1 100644 --- a/clients/client-devops-guru/commands/AddNotificationChannelCommand.ts +++ b/clients/client-devops-guru/commands/AddNotificationChannelCommand.ts @@ -32,6 +32,20 @@ export interface AddNotificationChannelCommandOutput extends AddNotificationChan *

If you use an Amazon SNS topic that is encrypted by an AWS Key Management Service customer-managed key (CMK), then you must add permissions * to the CMK. For more information, see Permissions for * AWS KMS–encrypted Amazon SNS topics.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { DevOpsGuruClient, AddNotificationChannelCommand } from "@aws-sdk/client-devops-guru"; // ES Modules import + * // const { DevOpsGuruClient, AddNotificationChannelCommand } = require("@aws-sdk/client-devops-guru"); // CommonJS import + * const client = new DevOpsGuruClient(config); + * const command = new AddNotificationChannelCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link AddNotificationChannelCommandInput} for command's `input` shape. + * @see {@link AddNotificationChannelCommandOutput} for command's `response` shape. + * @see {@link DevOpsGuruClientResolvedConfig | config} for command's `input` shape. + * */ export class AddNotificationChannelCommand extends $Command< AddNotificationChannelCommandInput, diff --git a/clients/client-devops-guru/commands/DescribeAccountHealthCommand.ts b/clients/client-devops-guru/commands/DescribeAccountHealthCommand.ts index e1e65a6adfc8..04bfecae17b2 100644 --- a/clients/client-devops-guru/commands/DescribeAccountHealthCommand.ts +++ b/clients/client-devops-guru/commands/DescribeAccountHealthCommand.ts @@ -25,6 +25,20 @@ export interface DescribeAccountHealthCommandOutput extends DescribeAccountHealt * Returns the number of open reactive insights, the number of open proactive insights, and the number of metrics analyzed in your AWS account. * Use these numbers to gauge the health of operations in your AWS account. *

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { DevOpsGuruClient, DescribeAccountHealthCommand } from "@aws-sdk/client-devops-guru"; // ES Modules import + * // const { DevOpsGuruClient, DescribeAccountHealthCommand } = require("@aws-sdk/client-devops-guru"); // CommonJS import + * const client = new DevOpsGuruClient(config); + * const command = new DescribeAccountHealthCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeAccountHealthCommandInput} for command's `input` shape. + * @see {@link DescribeAccountHealthCommandOutput} for command's `response` shape. + * @see {@link DevOpsGuruClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeAccountHealthCommand extends $Command< DescribeAccountHealthCommandInput, diff --git a/clients/client-devops-guru/commands/DescribeAccountOverviewCommand.ts b/clients/client-devops-guru/commands/DescribeAccountOverviewCommand.ts index bbae165a97f5..f95ac0bbd0c8 100644 --- a/clients/client-devops-guru/commands/DescribeAccountOverviewCommand.ts +++ b/clients/client-devops-guru/commands/DescribeAccountOverviewCommand.ts @@ -25,6 +25,20 @@ export interface DescribeAccountOverviewCommandOutput extends DescribeAccountOve * 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. *

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { DevOpsGuruClient, DescribeAccountOverviewCommand } from "@aws-sdk/client-devops-guru"; // ES Modules import + * // const { DevOpsGuruClient, DescribeAccountOverviewCommand } = require("@aws-sdk/client-devops-guru"); // CommonJS import + * const client = new DevOpsGuruClient(config); + * const command = new DescribeAccountOverviewCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeAccountOverviewCommandInput} for command's `input` shape. + * @see {@link DescribeAccountOverviewCommandOutput} for command's `response` shape. + * @see {@link DevOpsGuruClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeAccountOverviewCommand extends $Command< DescribeAccountOverviewCommandInput, diff --git a/clients/client-devops-guru/commands/DescribeAnomalyCommand.ts b/clients/client-devops-guru/commands/DescribeAnomalyCommand.ts index 59b971957876..97c7da8ede01 100644 --- a/clients/client-devops-guru/commands/DescribeAnomalyCommand.ts +++ b/clients/client-devops-guru/commands/DescribeAnomalyCommand.ts @@ -24,6 +24,20 @@ export interface DescribeAnomalyCommandOutput extends DescribeAnomalyResponse, _ *

* Returns details about an anomaly that you specify using its ID. *

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { DevOpsGuruClient, DescribeAnomalyCommand } from "@aws-sdk/client-devops-guru"; // ES Modules import + * // const { DevOpsGuruClient, DescribeAnomalyCommand } = require("@aws-sdk/client-devops-guru"); // CommonJS import + * const client = new DevOpsGuruClient(config); + * const command = new DescribeAnomalyCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeAnomalyCommandInput} for command's `input` shape. + * @see {@link DescribeAnomalyCommandOutput} for command's `response` shape. + * @see {@link DevOpsGuruClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeAnomalyCommand extends $Command< DescribeAnomalyCommandInput, diff --git a/clients/client-devops-guru/commands/DescribeFeedbackCommand.ts b/clients/client-devops-guru/commands/DescribeFeedbackCommand.ts index c8358ffb5500..ccb82de64da4 100644 --- a/clients/client-devops-guru/commands/DescribeFeedbackCommand.ts +++ b/clients/client-devops-guru/commands/DescribeFeedbackCommand.ts @@ -24,6 +24,20 @@ export interface DescribeFeedbackCommandOutput extends DescribeFeedbackResponse, *

* Returns the most recent feedback submitted in the current AWS account and Region. *

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { DevOpsGuruClient, DescribeFeedbackCommand } from "@aws-sdk/client-devops-guru"; // ES Modules import + * // const { DevOpsGuruClient, DescribeFeedbackCommand } = require("@aws-sdk/client-devops-guru"); // CommonJS import + * const client = new DevOpsGuruClient(config); + * const command = new DescribeFeedbackCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeFeedbackCommandInput} for command's `input` shape. + * @see {@link DescribeFeedbackCommandOutput} for command's `response` shape. + * @see {@link DevOpsGuruClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeFeedbackCommand extends $Command< DescribeFeedbackCommandInput, diff --git a/clients/client-devops-guru/commands/DescribeInsightCommand.ts b/clients/client-devops-guru/commands/DescribeInsightCommand.ts index 52aacf79dc24..a5f531012c3f 100644 --- a/clients/client-devops-guru/commands/DescribeInsightCommand.ts +++ b/clients/client-devops-guru/commands/DescribeInsightCommand.ts @@ -24,6 +24,20 @@ export interface DescribeInsightCommandOutput extends DescribeInsightResponse, _ *

* Returns details about an insight that you specify using its ID. *

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { DevOpsGuruClient, DescribeInsightCommand } from "@aws-sdk/client-devops-guru"; // ES Modules import + * // const { DevOpsGuruClient, DescribeInsightCommand } = require("@aws-sdk/client-devops-guru"); // CommonJS import + * const client = new DevOpsGuruClient(config); + * const command = new DescribeInsightCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeInsightCommandInput} for command's `input` shape. + * @see {@link DescribeInsightCommandOutput} for command's `response` shape. + * @see {@link DevOpsGuruClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeInsightCommand extends $Command< DescribeInsightCommandInput, diff --git a/clients/client-devops-guru/commands/DescribeResourceCollectionHealthCommand.ts b/clients/client-devops-guru/commands/DescribeResourceCollectionHealthCommand.ts index c01dda30750f..f016191efc76 100644 --- a/clients/client-devops-guru/commands/DescribeResourceCollectionHealthCommand.ts +++ b/clients/client-devops-guru/commands/DescribeResourceCollectionHealthCommand.ts @@ -28,6 +28,20 @@ export interface DescribeResourceCollectionHealthCommandOutput * resource collections in your account. You specify the type of AWS resources collection. The one type of AWS resource collection supported is AWS CloudFormation stacks. DevOps Guru can be configured to analyze * only the AWS resources that are defined in the stacks. *

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { DevOpsGuruClient, DescribeResourceCollectionHealthCommand } from "@aws-sdk/client-devops-guru"; // ES Modules import + * // const { DevOpsGuruClient, DescribeResourceCollectionHealthCommand } = require("@aws-sdk/client-devops-guru"); // CommonJS import + * const client = new DevOpsGuruClient(config); + * const command = new DescribeResourceCollectionHealthCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeResourceCollectionHealthCommandInput} for command's `input` shape. + * @see {@link DescribeResourceCollectionHealthCommandOutput} for command's `response` shape. + * @see {@link DevOpsGuruClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeResourceCollectionHealthCommand extends $Command< DescribeResourceCollectionHealthCommandInput, diff --git a/clients/client-devops-guru/commands/DescribeServiceIntegrationCommand.ts b/clients/client-devops-guru/commands/DescribeServiceIntegrationCommand.ts index ffd8406ece81..a50022318002 100644 --- a/clients/client-devops-guru/commands/DescribeServiceIntegrationCommand.ts +++ b/clients/client-devops-guru/commands/DescribeServiceIntegrationCommand.ts @@ -26,6 +26,20 @@ export interface DescribeServiceIntegrationCommandOutput extends DescribeService * The one service that can be integrated with DevOps Guru * is AWS Systems Manager, which can be used to create an OpsItem for each generated insight. *

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { DevOpsGuruClient, DescribeServiceIntegrationCommand } from "@aws-sdk/client-devops-guru"; // ES Modules import + * // const { DevOpsGuruClient, DescribeServiceIntegrationCommand } = require("@aws-sdk/client-devops-guru"); // CommonJS import + * const client = new DevOpsGuruClient(config); + * const command = new DescribeServiceIntegrationCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeServiceIntegrationCommandInput} for command's `input` shape. + * @see {@link DescribeServiceIntegrationCommandOutput} for command's `response` shape. + * @see {@link DevOpsGuruClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeServiceIntegrationCommand extends $Command< DescribeServiceIntegrationCommandInput, diff --git a/clients/client-devops-guru/commands/GetResourceCollectionCommand.ts b/clients/client-devops-guru/commands/GetResourceCollectionCommand.ts index 8acf3a984cdd..06bb389360e7 100644 --- a/clients/client-devops-guru/commands/GetResourceCollectionCommand.ts +++ b/clients/client-devops-guru/commands/GetResourceCollectionCommand.ts @@ -25,6 +25,20 @@ export interface GetResourceCollectionCommandOutput extends GetResourceCollectio * Returns lists AWS resources that are of the specified resource collection type. The one type of AWS resource collection supported is AWS CloudFormation stacks. DevOps Guru can be configured to analyze * only the AWS resources that are defined in the stacks. *

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { DevOpsGuruClient, GetResourceCollectionCommand } from "@aws-sdk/client-devops-guru"; // ES Modules import + * // const { DevOpsGuruClient, GetResourceCollectionCommand } = require("@aws-sdk/client-devops-guru"); // CommonJS import + * const client = new DevOpsGuruClient(config); + * const command = new GetResourceCollectionCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetResourceCollectionCommandInput} for command's `input` shape. + * @see {@link GetResourceCollectionCommandOutput} for command's `response` shape. + * @see {@link DevOpsGuruClientResolvedConfig | config} for command's `input` shape. + * */ export class GetResourceCollectionCommand extends $Command< GetResourceCollectionCommandInput, diff --git a/clients/client-devops-guru/commands/ListAnomaliesForInsightCommand.ts b/clients/client-devops-guru/commands/ListAnomaliesForInsightCommand.ts index d91015ed258c..9217144c8762 100644 --- a/clients/client-devops-guru/commands/ListAnomaliesForInsightCommand.ts +++ b/clients/client-devops-guru/commands/ListAnomaliesForInsightCommand.ts @@ -24,6 +24,20 @@ export interface ListAnomaliesForInsightCommandOutput extends ListAnomaliesForIn *

* Returns a list of the anomalies that belong to an insight that you specify using its ID. *

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { DevOpsGuruClient, ListAnomaliesForInsightCommand } from "@aws-sdk/client-devops-guru"; // ES Modules import + * // const { DevOpsGuruClient, ListAnomaliesForInsightCommand } = require("@aws-sdk/client-devops-guru"); // CommonJS import + * const client = new DevOpsGuruClient(config); + * const command = new ListAnomaliesForInsightCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListAnomaliesForInsightCommandInput} for command's `input` shape. + * @see {@link ListAnomaliesForInsightCommandOutput} for command's `response` shape. + * @see {@link DevOpsGuruClientResolvedConfig | config} for command's `input` shape. + * */ export class ListAnomaliesForInsightCommand extends $Command< ListAnomaliesForInsightCommandInput, diff --git a/clients/client-devops-guru/commands/ListEventsCommand.ts b/clients/client-devops-guru/commands/ListEventsCommand.ts index abb65aefeb87..87220bc9bb95 100644 --- a/clients/client-devops-guru/commands/ListEventsCommand.ts +++ b/clients/client-devops-guru/commands/ListEventsCommand.ts @@ -24,6 +24,20 @@ export interface ListEventsCommandOutput extends ListEventsResponse, __MetadataB *

* 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. *

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { DevOpsGuruClient, ListEventsCommand } from "@aws-sdk/client-devops-guru"; // ES Modules import + * // const { DevOpsGuruClient, ListEventsCommand } = require("@aws-sdk/client-devops-guru"); // CommonJS import + * const client = new DevOpsGuruClient(config); + * const command = new ListEventsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListEventsCommandInput} for command's `input` shape. + * @see {@link ListEventsCommandOutput} for command's `response` shape. + * @see {@link DevOpsGuruClientResolvedConfig | config} for command's `input` shape. + * */ export class ListEventsCommand extends $Command< ListEventsCommandInput, diff --git a/clients/client-devops-guru/commands/ListInsightsCommand.ts b/clients/client-devops-guru/commands/ListInsightsCommand.ts index 20317e69debf..346a174377ff 100644 --- a/clients/client-devops-guru/commands/ListInsightsCommand.ts +++ b/clients/client-devops-guru/commands/ListInsightsCommand.ts @@ -25,6 +25,20 @@ export interface ListInsightsCommandOutput extends ListInsightsResponse, __Metad * Returns a list of insights in your AWS account. You can specify which insights are returned by their start time and * status (ONGOING, CLOSED, or ANY). *

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { DevOpsGuruClient, ListInsightsCommand } from "@aws-sdk/client-devops-guru"; // ES Modules import + * // const { DevOpsGuruClient, ListInsightsCommand } = require("@aws-sdk/client-devops-guru"); // CommonJS import + * const client = new DevOpsGuruClient(config); + * const command = new ListInsightsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListInsightsCommandInput} for command's `input` shape. + * @see {@link ListInsightsCommandOutput} for command's `response` shape. + * @see {@link DevOpsGuruClientResolvedConfig | config} for command's `input` shape. + * */ export class ListInsightsCommand extends $Command< ListInsightsCommandInput, diff --git a/clients/client-devops-guru/commands/ListNotificationChannelsCommand.ts b/clients/client-devops-guru/commands/ListNotificationChannelsCommand.ts index a2f790db57da..87a63435859f 100644 --- a/clients/client-devops-guru/commands/ListNotificationChannelsCommand.ts +++ b/clients/client-devops-guru/commands/ListNotificationChannelsCommand.ts @@ -26,6 +26,20 @@ export interface ListNotificationChannelsCommandOutput extends ListNotificationC * 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). *

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { DevOpsGuruClient, ListNotificationChannelsCommand } from "@aws-sdk/client-devops-guru"; // ES Modules import + * // const { DevOpsGuruClient, ListNotificationChannelsCommand } = require("@aws-sdk/client-devops-guru"); // CommonJS import + * const client = new DevOpsGuruClient(config); + * const command = new ListNotificationChannelsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListNotificationChannelsCommandInput} for command's `input` shape. + * @see {@link ListNotificationChannelsCommandOutput} for command's `response` shape. + * @see {@link DevOpsGuruClientResolvedConfig | config} for command's `input` shape. + * */ export class ListNotificationChannelsCommand extends $Command< ListNotificationChannelsCommandInput, diff --git a/clients/client-devops-guru/commands/ListRecommendationsCommand.ts b/clients/client-devops-guru/commands/ListRecommendationsCommand.ts index b3d39907c03f..e1bc6a1002e6 100644 --- a/clients/client-devops-guru/commands/ListRecommendationsCommand.ts +++ b/clients/client-devops-guru/commands/ListRecommendationsCommand.ts @@ -24,6 +24,20 @@ export interface ListRecommendationsCommandOutput extends ListRecommendationsRes *

* Returns a list of a specified insight's recommendations. Each recommendation includes a list of related metrics and a list of related events. *

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { DevOpsGuruClient, ListRecommendationsCommand } from "@aws-sdk/client-devops-guru"; // ES Modules import + * // const { DevOpsGuruClient, ListRecommendationsCommand } = require("@aws-sdk/client-devops-guru"); // CommonJS import + * const client = new DevOpsGuruClient(config); + * const command = new ListRecommendationsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListRecommendationsCommandInput} for command's `input` shape. + * @see {@link ListRecommendationsCommandOutput} for command's `response` shape. + * @see {@link DevOpsGuruClientResolvedConfig | config} for command's `input` shape. + * */ export class ListRecommendationsCommand extends $Command< ListRecommendationsCommandInput, diff --git a/clients/client-devops-guru/commands/PutFeedbackCommand.ts b/clients/client-devops-guru/commands/PutFeedbackCommand.ts index e0fcd15b3fdf..3c07739eca3c 100644 --- a/clients/client-devops-guru/commands/PutFeedbackCommand.ts +++ b/clients/client-devops-guru/commands/PutFeedbackCommand.ts @@ -24,6 +24,20 @@ export interface PutFeedbackCommandOutput extends PutFeedbackResponse, __Metadat *

* Collects customer feedback about the specified insight. *

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { DevOpsGuruClient, PutFeedbackCommand } from "@aws-sdk/client-devops-guru"; // ES Modules import + * // const { DevOpsGuruClient, PutFeedbackCommand } = require("@aws-sdk/client-devops-guru"); // CommonJS import + * const client = new DevOpsGuruClient(config); + * const command = new PutFeedbackCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link PutFeedbackCommandInput} for command's `input` shape. + * @see {@link PutFeedbackCommandOutput} for command's `response` shape. + * @see {@link DevOpsGuruClientResolvedConfig | config} for command's `input` shape. + * */ export class PutFeedbackCommand extends $Command< PutFeedbackCommandInput, diff --git a/clients/client-devops-guru/commands/RemoveNotificationChannelCommand.ts b/clients/client-devops-guru/commands/RemoveNotificationChannelCommand.ts index 7ad18fcbfff2..af14ecb57238 100644 --- a/clients/client-devops-guru/commands/RemoveNotificationChannelCommand.ts +++ b/clients/client-devops-guru/commands/RemoveNotificationChannelCommand.ts @@ -25,6 +25,20 @@ export interface RemoveNotificationChannelCommandOutput extends RemoveNotificati * 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. *

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { DevOpsGuruClient, RemoveNotificationChannelCommand } from "@aws-sdk/client-devops-guru"; // ES Modules import + * // const { DevOpsGuruClient, RemoveNotificationChannelCommand } = require("@aws-sdk/client-devops-guru"); // CommonJS import + * const client = new DevOpsGuruClient(config); + * const command = new RemoveNotificationChannelCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link RemoveNotificationChannelCommandInput} for command's `input` shape. + * @see {@link RemoveNotificationChannelCommandOutput} for command's `response` shape. + * @see {@link DevOpsGuruClientResolvedConfig | config} for command's `input` shape. + * */ export class RemoveNotificationChannelCommand extends $Command< RemoveNotificationChannelCommandInput, diff --git a/clients/client-devops-guru/commands/SearchInsightsCommand.ts b/clients/client-devops-guru/commands/SearchInsightsCommand.ts index 5c7693dafb4a..ee956662e067 100644 --- a/clients/client-devops-guru/commands/SearchInsightsCommand.ts +++ b/clients/client-devops-guru/commands/SearchInsightsCommand.ts @@ -30,6 +30,20 @@ export interface SearchInsightsCommandOutput extends SearchInsightsResponse, __M * Use the Filters parameter to specify status and severity * search parameters. Use the Type parameter to specify REACTIVE or PROACTIVE in your search. *

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { DevOpsGuruClient, SearchInsightsCommand } from "@aws-sdk/client-devops-guru"; // ES Modules import + * // const { DevOpsGuruClient, SearchInsightsCommand } = require("@aws-sdk/client-devops-guru"); // CommonJS import + * const client = new DevOpsGuruClient(config); + * const command = new SearchInsightsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link SearchInsightsCommandInput} for command's `input` shape. + * @see {@link SearchInsightsCommandOutput} for command's `response` shape. + * @see {@link DevOpsGuruClientResolvedConfig | config} for command's `input` shape. + * */ export class SearchInsightsCommand extends $Command< SearchInsightsCommandInput, diff --git a/clients/client-devops-guru/commands/UpdateResourceCollectionCommand.ts b/clients/client-devops-guru/commands/UpdateResourceCollectionCommand.ts index 90161058cfeb..339f897f0d56 100644 --- a/clients/client-devops-guru/commands/UpdateResourceCollectionCommand.ts +++ b/clients/client-devops-guru/commands/UpdateResourceCollectionCommand.ts @@ -25,6 +25,20 @@ export interface UpdateResourceCollectionCommandOutput extends UpdateResourceCol * The one type of AWS resource collection supported is AWS CloudFormation stacks. DevOps Guru can be configured to analyze * only the AWS resources that are defined in the stacks. This method also creates the IAM role required for you * to use DevOps Guru.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { DevOpsGuruClient, UpdateResourceCollectionCommand } from "@aws-sdk/client-devops-guru"; // ES Modules import + * // const { DevOpsGuruClient, UpdateResourceCollectionCommand } = require("@aws-sdk/client-devops-guru"); // CommonJS import + * const client = new DevOpsGuruClient(config); + * const command = new UpdateResourceCollectionCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link UpdateResourceCollectionCommandInput} for command's `input` shape. + * @see {@link UpdateResourceCollectionCommandOutput} for command's `response` shape. + * @see {@link DevOpsGuruClientResolvedConfig | config} for command's `input` shape. + * */ export class UpdateResourceCollectionCommand extends $Command< UpdateResourceCollectionCommandInput, diff --git a/clients/client-devops-guru/commands/UpdateServiceIntegrationCommand.ts b/clients/client-devops-guru/commands/UpdateServiceIntegrationCommand.ts index 3a322731cbbd..d61b96c9b188 100644 --- a/clients/client-devops-guru/commands/UpdateServiceIntegrationCommand.ts +++ b/clients/client-devops-guru/commands/UpdateServiceIntegrationCommand.ts @@ -25,6 +25,20 @@ export interface UpdateServiceIntegrationCommandOutput extends UpdateServiceInte * 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 AWS Systems Manager, which can be used to create an OpsItem for each generated insight. *

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { DevOpsGuruClient, UpdateServiceIntegrationCommand } from "@aws-sdk/client-devops-guru"; // ES Modules import + * // const { DevOpsGuruClient, UpdateServiceIntegrationCommand } = require("@aws-sdk/client-devops-guru"); // CommonJS import + * const client = new DevOpsGuruClient(config); + * const command = new UpdateServiceIntegrationCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link UpdateServiceIntegrationCommandInput} for command's `input` shape. + * @see {@link UpdateServiceIntegrationCommandOutput} for command's `response` shape. + * @see {@link DevOpsGuruClientResolvedConfig | config} for command's `input` shape. + * */ export class UpdateServiceIntegrationCommand extends $Command< UpdateServiceIntegrationCommandInput, diff --git a/clients/client-devops-guru/models/models_0.ts b/clients/client-devops-guru/models/models_0.ts index 013a9bfb0b80..263dd1278e9a 100644 --- a/clients/client-devops-guru/models/models_0.ts +++ b/clients/client-devops-guru/models/models_0.ts @@ -13,6 +13,9 @@ export interface AccessDeniedException extends __SmithyException, $MetadataBeare } export namespace AccessDeniedException { + /** + * @internal + */ export const filterSensitiveLog = (obj: AccessDeniedException): any => ({ ...obj, }); @@ -37,6 +40,9 @@ export interface SnsChannelConfig { } export namespace SnsChannelConfig { + /** + * @internal + */ export const filterSensitiveLog = (obj: SnsChannelConfig): any => ({ ...obj, }); @@ -65,6 +71,9 @@ export interface NotificationChannelConfig { } export namespace NotificationChannelConfig { + /** + * @internal + */ export const filterSensitiveLog = (obj: NotificationChannelConfig): any => ({ ...obj, }); @@ -80,6 +89,9 @@ export interface AddNotificationChannelRequest { } export namespace AddNotificationChannelRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: AddNotificationChannelRequest): any => ({ ...obj, }); @@ -95,6 +107,9 @@ export interface AddNotificationChannelResponse { } export namespace AddNotificationChannelResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: AddNotificationChannelResponse): any => ({ ...obj, }); @@ -125,6 +140,9 @@ export interface ConflictException extends __SmithyException, $MetadataBearer { } export namespace ConflictException { + /** + * @internal + */ export const filterSensitiveLog = (obj: ConflictException): any => ({ ...obj, }); @@ -147,6 +165,9 @@ export interface InternalServerException extends __SmithyException, $MetadataBea } export namespace InternalServerException { + /** + * @internal + */ export const filterSensitiveLog = (obj: InternalServerException): any => ({ ...obj, }); @@ -175,6 +196,9 @@ export interface ResourceNotFoundException extends __SmithyException, $MetadataB } export namespace ResourceNotFoundException { + /** + * @internal + */ export const filterSensitiveLog = (obj: ResourceNotFoundException): any => ({ ...obj, }); @@ -190,6 +214,9 @@ export interface ServiceQuotaExceededException extends __SmithyException, $Metad } export namespace ServiceQuotaExceededException { + /** + * @internal + */ export const filterSensitiveLog = (obj: ServiceQuotaExceededException): any => ({ ...obj, }); @@ -226,6 +253,9 @@ export interface ThrottlingException extends __SmithyException, $MetadataBearer } export namespace ThrottlingException { + /** + * @internal + */ export const filterSensitiveLog = (obj: ThrottlingException): any => ({ ...obj, }); @@ -254,6 +284,9 @@ export interface ValidationExceptionField { } export namespace ValidationExceptionField { + /** + * @internal + */ export const filterSensitiveLog = (obj: ValidationExceptionField): any => ({ ...obj, }); @@ -297,6 +330,9 @@ export interface ValidationException extends __SmithyException, $MetadataBearer } export namespace ValidationException { + /** + * @internal + */ export const filterSensitiveLog = (obj: ValidationException): any => ({ ...obj, }); @@ -331,6 +367,9 @@ export interface CloudWatchMetricsDimension { } export namespace CloudWatchMetricsDimension { + /** + * @internal + */ export const filterSensitiveLog = (obj: CloudWatchMetricsDimension): any => ({ ...obj, }); @@ -400,6 +439,9 @@ export interface CloudWatchMetricsDetail { } export namespace CloudWatchMetricsDetail { + /** + * @internal + */ export const filterSensitiveLog = (obj: CloudWatchMetricsDetail): any => ({ ...obj, }); @@ -418,6 +460,9 @@ export interface AnomalySourceDetails { } export namespace AnomalySourceDetails { + /** + * @internal + */ export const filterSensitiveLog = (obj: AnomalySourceDetails): any => ({ ...obj, }); @@ -448,6 +493,9 @@ export interface AnomalyTimeRange { } export namespace AnomalyTimeRange { + /** + * @internal + */ export const filterSensitiveLog = (obj: AnomalyTimeRange): any => ({ ...obj, }); @@ -456,6 +504,9 @@ export namespace AnomalyTimeRange { export interface DescribeAccountHealthRequest {} export namespace DescribeAccountHealthRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeAccountHealthRequest): any => ({ ...obj, }); @@ -491,6 +542,9 @@ export interface DescribeAccountHealthResponse { } export namespace DescribeAccountHealthResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeAccountHealthResponse): any => ({ ...obj, }); @@ -515,6 +569,9 @@ export interface DescribeAccountOverviewRequest { } export namespace DescribeAccountOverviewRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeAccountOverviewRequest): any => ({ ...obj, }); @@ -547,6 +604,9 @@ export interface DescribeAccountOverviewResponse { } export namespace DescribeAccountOverviewResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeAccountOverviewResponse): any => ({ ...obj, }); @@ -562,6 +622,9 @@ export interface DescribeAnomalyRequest { } export namespace DescribeAnomalyRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeAnomalyRequest): any => ({ ...obj, }); @@ -589,6 +652,9 @@ export interface PredictionTimeRange { } export namespace PredictionTimeRange { + /** + * @internal + */ export const filterSensitiveLog = (obj: PredictionTimeRange): any => ({ ...obj, }); @@ -611,6 +677,9 @@ export interface CloudFormationCollection { } export namespace CloudFormationCollection { + /** + * @internal + */ export const filterSensitiveLog = (obj: CloudFormationCollection): any => ({ ...obj, }); @@ -632,6 +701,9 @@ export interface ResourceCollection { } export namespace ResourceCollection { + /** + * @internal + */ export const filterSensitiveLog = (obj: ResourceCollection): any => ({ ...obj, }); @@ -715,6 +787,9 @@ export interface ProactiveAnomaly { } export namespace ProactiveAnomaly { + /** + * @internal + */ export const filterSensitiveLog = (obj: ProactiveAnomaly): any => ({ ...obj, }); @@ -772,6 +847,9 @@ export interface ReactiveAnomaly { } export namespace ReactiveAnomaly { + /** + * @internal + */ export const filterSensitiveLog = (obj: ReactiveAnomaly): any => ({ ...obj, }); @@ -794,6 +872,9 @@ export interface DescribeAnomalyResponse { } export namespace DescribeAnomalyResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeAnomalyResponse): any => ({ ...obj, }); @@ -809,6 +890,9 @@ export interface DescribeFeedbackRequest { } export namespace DescribeFeedbackRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeFeedbackRequest): any => ({ ...obj, }); @@ -844,6 +928,9 @@ export interface InsightFeedback { } export namespace InsightFeedback { + /** + * @internal + */ export const filterSensitiveLog = (obj: InsightFeedback): any => ({ ...obj, }); @@ -859,6 +946,9 @@ export interface DescribeFeedbackResponse { } export namespace DescribeFeedbackResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeFeedbackResponse): any => ({ ...obj, }); @@ -874,6 +964,9 @@ export interface DescribeInsightRequest { } export namespace DescribeInsightRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeInsightRequest): any => ({ ...obj, }); @@ -900,6 +993,9 @@ export interface InsightTimeRange { } export namespace InsightTimeRange { + /** + * @internal + */ export const filterSensitiveLog = (obj: InsightTimeRange): any => ({ ...obj, }); @@ -971,6 +1067,9 @@ export interface ProactiveInsight { } export namespace ProactiveInsight { + /** + * @internal + */ export const filterSensitiveLog = (obj: ProactiveInsight): any => ({ ...obj, }); @@ -1034,6 +1133,9 @@ export interface ReactiveInsight { } export namespace ReactiveInsight { + /** + * @internal + */ export const filterSensitiveLog = (obj: ReactiveInsight): any => ({ ...obj, }); @@ -1056,6 +1158,9 @@ export interface DescribeInsightResponse { } export namespace DescribeInsightResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeInsightResponse): any => ({ ...obj, }); @@ -1082,6 +1187,9 @@ export interface DescribeResourceCollectionHealthRequest { } export namespace DescribeResourceCollectionHealthRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeResourceCollectionHealthRequest): any => ({ ...obj, }); @@ -1117,6 +1225,9 @@ export interface InsightHealth { } export namespace InsightHealth { + /** + * @internal + */ export const filterSensitiveLog = (obj: InsightHealth): any => ({ ...obj, }); @@ -1145,6 +1256,9 @@ export interface CloudFormationHealth { } export namespace CloudFormationHealth { + /** + * @internal + */ export const filterSensitiveLog = (obj: CloudFormationHealth): any => ({ ...obj, }); @@ -1167,6 +1281,9 @@ export interface DescribeResourceCollectionHealthResponse { } export namespace DescribeResourceCollectionHealthResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeResourceCollectionHealthResponse): any => ({ ...obj, }); @@ -1175,6 +1292,9 @@ export namespace DescribeResourceCollectionHealthResponse { export interface DescribeServiceIntegrationRequest {} export namespace DescribeServiceIntegrationRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeServiceIntegrationRequest): any => ({ ...obj, }); @@ -1200,6 +1320,9 @@ export interface OpsCenterIntegration { } export namespace OpsCenterIntegration { + /** + * @internal + */ export const filterSensitiveLog = (obj: OpsCenterIntegration): any => ({ ...obj, }); @@ -1220,6 +1343,9 @@ export interface ServiceIntegrationConfig { } export namespace ServiceIntegrationConfig { + /** + * @internal + */ export const filterSensitiveLog = (obj: ServiceIntegrationConfig): any => ({ ...obj, }); @@ -1235,6 +1361,9 @@ export interface DescribeServiceIntegrationResponse { } export namespace DescribeServiceIntegrationResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeServiceIntegrationResponse): any => ({ ...obj, }); @@ -1257,6 +1386,9 @@ export interface GetResourceCollectionRequest { } export namespace GetResourceCollectionRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetResourceCollectionRequest): any => ({ ...obj, }); @@ -1279,6 +1411,9 @@ export interface CloudFormationCollectionFilter { } export namespace CloudFormationCollectionFilter { + /** + * @internal + */ export const filterSensitiveLog = (obj: CloudFormationCollectionFilter): any => ({ ...obj, }); @@ -1301,6 +1436,9 @@ export interface ResourceCollectionFilter { } export namespace ResourceCollectionFilter { + /** + * @internal + */ export const filterSensitiveLog = (obj: ResourceCollectionFilter): any => ({ ...obj, }); @@ -1323,6 +1461,9 @@ export interface GetResourceCollectionResponse { } export namespace GetResourceCollectionResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetResourceCollectionResponse): any => ({ ...obj, }); @@ -1350,6 +1491,9 @@ export interface StartTimeRange { } export namespace StartTimeRange { + /** + * @internal + */ export const filterSensitiveLog = (obj: StartTimeRange): any => ({ ...obj, }); @@ -1385,6 +1529,9 @@ export interface ListAnomaliesForInsightRequest { } export namespace ListAnomaliesForInsightRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListAnomaliesForInsightRequest): any => ({ ...obj, }); @@ -1464,6 +1611,9 @@ export interface ProactiveAnomalySummary { } export namespace ProactiveAnomalySummary { + /** + * @internal + */ export const filterSensitiveLog = (obj: ProactiveAnomalySummary): any => ({ ...obj, }); @@ -1527,6 +1677,9 @@ export interface ReactiveAnomalySummary { } export namespace ReactiveAnomalySummary { + /** + * @internal + */ export const filterSensitiveLog = (obj: ReactiveAnomalySummary): any => ({ ...obj, }); @@ -1555,6 +1708,9 @@ export interface ListAnomaliesForInsightResponse { } export namespace ListAnomaliesForInsightResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListAnomaliesForInsightResponse): any => ({ ...obj, }); @@ -1596,6 +1752,9 @@ export interface EventTimeRange { } export namespace EventTimeRange { + /** + * @internal + */ export const filterSensitiveLog = (obj: EventTimeRange): any => ({ ...obj, }); @@ -1650,6 +1809,9 @@ export interface ListEventsFilters { } export namespace ListEventsFilters { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListEventsFilters): any => ({ ...obj, }); @@ -1677,6 +1839,9 @@ export interface ListEventsRequest { } export namespace ListEventsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListEventsRequest): any => ({ ...obj, }); @@ -1712,6 +1877,9 @@ export interface EventResource { } export namespace EventResource { + /** + * @internal + */ export const filterSensitiveLog = (obj: EventResource): any => ({ ...obj, }); @@ -1781,6 +1949,9 @@ export interface Event { } export namespace Event { + /** + * @internal + */ export const filterSensitiveLog = (obj: Event): any => ({ ...obj, }); @@ -1802,6 +1973,9 @@ export interface ListEventsResponse { } export namespace ListEventsResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListEventsResponse): any => ({ ...obj, }); @@ -1834,6 +2008,9 @@ export interface ListInsightsAnyStatusFilter { } export namespace ListInsightsAnyStatusFilter { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListInsightsAnyStatusFilter): any => ({ ...obj, }); @@ -1861,6 +2038,9 @@ export interface EndTimeRange { } export namespace EndTimeRange { + /** + * @internal + */ export const filterSensitiveLog = (obj: EndTimeRange): any => ({ ...obj, }); @@ -1888,6 +2068,9 @@ export interface ListInsightsClosedStatusFilter { } export namespace ListInsightsClosedStatusFilter { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListInsightsClosedStatusFilter): any => ({ ...obj, }); @@ -1908,6 +2091,9 @@ export interface ListInsightsOngoingStatusFilter { } export namespace ListInsightsOngoingStatusFilter { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListInsightsOngoingStatusFilter): any => ({ ...obj, }); @@ -1945,6 +2131,9 @@ export interface ListInsightsStatusFilter { } export namespace ListInsightsStatusFilter { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListInsightsStatusFilter): any => ({ ...obj, }); @@ -1972,6 +2161,9 @@ export interface ListInsightsRequest { } export namespace ListInsightsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListInsightsRequest): any => ({ ...obj, }); @@ -2026,6 +2218,9 @@ export interface ProactiveInsightSummary { } export namespace ProactiveInsightSummary { + /** + * @internal + */ export const filterSensitiveLog = (obj: ProactiveInsightSummary): any => ({ ...obj, }); @@ -2081,6 +2276,9 @@ export interface ReactiveInsightSummary { } export namespace ReactiveInsightSummary { + /** + * @internal + */ export const filterSensitiveLog = (obj: ReactiveInsightSummary): any => ({ ...obj, }); @@ -2109,6 +2307,9 @@ export interface ListInsightsResponse { } export namespace ListInsightsResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListInsightsResponse): any => ({ ...obj, }); @@ -2123,6 +2324,9 @@ export interface ListNotificationChannelsRequest { } export namespace ListNotificationChannelsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListNotificationChannelsRequest): any => ({ ...obj, }); @@ -2160,6 +2364,9 @@ export interface NotificationChannel { } export namespace NotificationChannel { + /** + * @internal + */ export const filterSensitiveLog = (obj: NotificationChannel): any => ({ ...obj, }); @@ -2181,6 +2388,9 @@ export interface ListNotificationChannelsResponse { } export namespace ListNotificationChannelsResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListNotificationChannelsResponse): any => ({ ...obj, }); @@ -2202,6 +2412,9 @@ export interface ListRecommendationsRequest { } export namespace ListRecommendationsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListRecommendationsRequest): any => ({ ...obj, }); @@ -2229,6 +2442,9 @@ export interface RecommendationRelatedAnomalyResource { } export namespace RecommendationRelatedAnomalyResource { + /** + * @internal + */ export const filterSensitiveLog = (obj: RecommendationRelatedAnomalyResource): any => ({ ...obj, }); @@ -2253,6 +2469,9 @@ export interface RecommendationRelatedCloudWatchMetricsSourceDetail { } export namespace RecommendationRelatedCloudWatchMetricsSourceDetail { + /** + * @internal + */ export const filterSensitiveLog = (obj: RecommendationRelatedCloudWatchMetricsSourceDetail): any => ({ ...obj, }); @@ -2273,6 +2492,9 @@ export interface RecommendationRelatedAnomalySourceDetail { } export namespace RecommendationRelatedAnomalySourceDetail { + /** + * @internal + */ export const filterSensitiveLog = (obj: RecommendationRelatedAnomalySourceDetail): any => ({ ...obj, }); @@ -2301,6 +2523,9 @@ export interface RecommendationRelatedAnomaly { } export namespace RecommendationRelatedAnomaly { + /** + * @internal + */ export const filterSensitiveLog = (obj: RecommendationRelatedAnomaly): any => ({ ...obj, }); @@ -2330,6 +2555,9 @@ export interface RecommendationRelatedEventResource { } export namespace RecommendationRelatedEventResource { + /** + * @internal + */ export const filterSensitiveLog = (obj: RecommendationRelatedEventResource): any => ({ ...obj, }); @@ -2359,6 +2587,9 @@ export interface RecommendationRelatedEvent { } export namespace RecommendationRelatedEvent { + /** + * @internal + */ export const filterSensitiveLog = (obj: RecommendationRelatedEvent): any => ({ ...obj, }); @@ -2413,6 +2644,9 @@ export interface Recommendation { } export namespace Recommendation { + /** + * @internal + */ export const filterSensitiveLog = (obj: Recommendation): any => ({ ...obj, }); @@ -2434,6 +2668,9 @@ export interface ListRecommendationsResponse { } export namespace ListRecommendationsResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListRecommendationsResponse): any => ({ ...obj, }); @@ -2449,6 +2686,9 @@ export interface PutFeedbackRequest { } export namespace PutFeedbackRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: PutFeedbackRequest): any => ({ ...obj, }); @@ -2457,6 +2697,9 @@ export namespace PutFeedbackRequest { export interface PutFeedbackResponse {} export namespace PutFeedbackResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: PutFeedbackResponse): any => ({ ...obj, }); @@ -2472,6 +2715,9 @@ export interface RemoveNotificationChannelRequest { } export namespace RemoveNotificationChannelRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: RemoveNotificationChannelRequest): any => ({ ...obj, }); @@ -2480,6 +2726,9 @@ export namespace RemoveNotificationChannelRequest { export interface RemoveNotificationChannelResponse {} export namespace RemoveNotificationChannelResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: RemoveNotificationChannelResponse): any => ({ ...obj, }); @@ -2516,6 +2765,9 @@ export interface SearchInsightsFilters { } export namespace SearchInsightsFilters { + /** + * @internal + */ export const filterSensitiveLog = (obj: SearchInsightsFilters): any => ({ ...obj, }); @@ -2557,6 +2809,9 @@ export interface SearchInsightsRequest { } export namespace SearchInsightsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: SearchInsightsRequest): any => ({ ...obj, }); @@ -2585,6 +2840,9 @@ export interface SearchInsightsResponse { } export namespace SearchInsightsResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: SearchInsightsResponse): any => ({ ...obj, }); @@ -2608,6 +2866,9 @@ export interface UpdateCloudFormationCollectionFilter { } export namespace UpdateCloudFormationCollectionFilter { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateCloudFormationCollectionFilter): any => ({ ...obj, }); @@ -2628,6 +2889,9 @@ export interface UpdateResourceCollectionFilter { } export namespace UpdateResourceCollectionFilter { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateResourceCollectionFilter): any => ({ ...obj, }); @@ -2650,6 +2914,9 @@ export interface UpdateResourceCollectionRequest { } export namespace UpdateResourceCollectionRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateResourceCollectionRequest): any => ({ ...obj, }); @@ -2658,6 +2925,9 @@ export namespace UpdateResourceCollectionRequest { export interface UpdateResourceCollectionResponse {} export namespace UpdateResourceCollectionResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateResourceCollectionResponse): any => ({ ...obj, }); @@ -2678,6 +2948,9 @@ export interface OpsCenterIntegrationConfig { } export namespace OpsCenterIntegrationConfig { + /** + * @internal + */ export const filterSensitiveLog = (obj: OpsCenterIntegrationConfig): any => ({ ...obj, }); @@ -2698,6 +2971,9 @@ export interface UpdateServiceIntegrationConfig { } export namespace UpdateServiceIntegrationConfig { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateServiceIntegrationConfig): any => ({ ...obj, }); @@ -2714,6 +2990,9 @@ export interface UpdateServiceIntegrationRequest { } export namespace UpdateServiceIntegrationRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateServiceIntegrationRequest): any => ({ ...obj, }); @@ -2722,6 +3001,9 @@ export namespace UpdateServiceIntegrationRequest { export interface UpdateServiceIntegrationResponse {} export namespace UpdateServiceIntegrationResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateServiceIntegrationResponse): any => ({ ...obj, }); diff --git a/clients/client-direct-connect/commands/AcceptDirectConnectGatewayAssociationProposalCommand.ts b/clients/client-direct-connect/commands/AcceptDirectConnectGatewayAssociationProposalCommand.ts index aa78b6dc73c3..39b63b5d0ba0 100644 --- a/clients/client-direct-connect/commands/AcceptDirectConnectGatewayAssociationProposalCommand.ts +++ b/clients/client-direct-connect/commands/AcceptDirectConnectGatewayAssociationProposalCommand.ts @@ -28,6 +28,20 @@ export interface AcceptDirectConnectGatewayAssociationProposalCommandOutput /** *

Accepts a proposal request to attach a virtual private gateway or transit gateway to a Direct Connect gateway.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { DirectConnectClient, AcceptDirectConnectGatewayAssociationProposalCommand } from "@aws-sdk/client-direct-connect"; // ES Modules import + * // const { DirectConnectClient, AcceptDirectConnectGatewayAssociationProposalCommand } = require("@aws-sdk/client-direct-connect"); // CommonJS import + * const client = new DirectConnectClient(config); + * const command = new AcceptDirectConnectGatewayAssociationProposalCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link AcceptDirectConnectGatewayAssociationProposalCommandInput} for command's `input` shape. + * @see {@link AcceptDirectConnectGatewayAssociationProposalCommandOutput} for command's `response` shape. + * @see {@link DirectConnectClientResolvedConfig | config} for command's `input` shape. + * */ export class AcceptDirectConnectGatewayAssociationProposalCommand extends $Command< AcceptDirectConnectGatewayAssociationProposalCommandInput, diff --git a/clients/client-direct-connect/commands/AllocateConnectionOnInterconnectCommand.ts b/clients/client-direct-connect/commands/AllocateConnectionOnInterconnectCommand.ts index cde1cd13c0d6..edb719d0de22 100644 --- a/clients/client-direct-connect/commands/AllocateConnectionOnInterconnectCommand.ts +++ b/clients/client-direct-connect/commands/AllocateConnectionOnInterconnectCommand.ts @@ -29,6 +29,20 @@ export interface AllocateConnectionOnInterconnectCommandOutput extends Connectio * *

Intended for use by AWS Direct Connect Partners only.

* + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { DirectConnectClient, AllocateConnectionOnInterconnectCommand } from "@aws-sdk/client-direct-connect"; // ES Modules import + * // const { DirectConnectClient, AllocateConnectionOnInterconnectCommand } = require("@aws-sdk/client-direct-connect"); // CommonJS import + * const client = new DirectConnectClient(config); + * const command = new AllocateConnectionOnInterconnectCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link AllocateConnectionOnInterconnectCommandInput} for command's `input` shape. + * @see {@link AllocateConnectionOnInterconnectCommandOutput} for command's `response` shape. + * @see {@link DirectConnectClientResolvedConfig | config} for command's `input` shape. + * */ export class AllocateConnectionOnInterconnectCommand extends $Command< AllocateConnectionOnInterconnectCommandInput, diff --git a/clients/client-direct-connect/commands/AllocateHostedConnectionCommand.ts b/clients/client-direct-connect/commands/AllocateHostedConnectionCommand.ts index 14a6746d994e..327e26817111 100644 --- a/clients/client-direct-connect/commands/AllocateHostedConnectionCommand.ts +++ b/clients/client-direct-connect/commands/AllocateHostedConnectionCommand.ts @@ -26,6 +26,20 @@ export interface AllocateHostedConnectionCommandOutput extends Connection, __Met * *

Intended for use by AWS Direct Connect Partners only.

* + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { DirectConnectClient, AllocateHostedConnectionCommand } from "@aws-sdk/client-direct-connect"; // ES Modules import + * // const { DirectConnectClient, AllocateHostedConnectionCommand } = require("@aws-sdk/client-direct-connect"); // CommonJS import + * const client = new DirectConnectClient(config); + * const command = new AllocateHostedConnectionCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link AllocateHostedConnectionCommandInput} for command's `input` shape. + * @see {@link AllocateHostedConnectionCommandOutput} for command's `response` shape. + * @see {@link DirectConnectClientResolvedConfig | config} for command's `input` shape. + * */ export class AllocateHostedConnectionCommand extends $Command< AllocateHostedConnectionCommandInput, diff --git a/clients/client-direct-connect/commands/AllocatePrivateVirtualInterfaceCommand.ts b/clients/client-direct-connect/commands/AllocatePrivateVirtualInterfaceCommand.ts index 3b08791fc3a5..8514c1b06738 100644 --- a/clients/client-direct-connect/commands/AllocatePrivateVirtualInterfaceCommand.ts +++ b/clients/client-direct-connect/commands/AllocatePrivateVirtualInterfaceCommand.ts @@ -24,6 +24,20 @@ export interface AllocatePrivateVirtualInterfaceCommandOutput extends VirtualInt *

Provisions a private virtual interface to be owned by the specified AWS 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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { DirectConnectClient, AllocatePrivateVirtualInterfaceCommand } from "@aws-sdk/client-direct-connect"; // ES Modules import + * // const { DirectConnectClient, AllocatePrivateVirtualInterfaceCommand } = require("@aws-sdk/client-direct-connect"); // CommonJS import + * const client = new DirectConnectClient(config); + * const command = new AllocatePrivateVirtualInterfaceCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link AllocatePrivateVirtualInterfaceCommandInput} for command's `input` shape. + * @see {@link AllocatePrivateVirtualInterfaceCommandOutput} for command's `response` shape. + * @see {@link DirectConnectClientResolvedConfig | config} for command's `input` shape. + * */ export class AllocatePrivateVirtualInterfaceCommand extends $Command< AllocatePrivateVirtualInterfaceCommandInput, diff --git a/clients/client-direct-connect/commands/AllocatePublicVirtualInterfaceCommand.ts b/clients/client-direct-connect/commands/AllocatePublicVirtualInterfaceCommand.ts index 55c813fa1ac8..33b147359a0d 100644 --- a/clients/client-direct-connect/commands/AllocatePublicVirtualInterfaceCommand.ts +++ b/clients/client-direct-connect/commands/AllocatePublicVirtualInterfaceCommand.ts @@ -27,6 +27,20 @@ export interface AllocatePublicVirtualInterfaceCommandOutput extends VirtualInte * 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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { DirectConnectClient, AllocatePublicVirtualInterfaceCommand } from "@aws-sdk/client-direct-connect"; // ES Modules import + * // const { DirectConnectClient, AllocatePublicVirtualInterfaceCommand } = require("@aws-sdk/client-direct-connect"); // CommonJS import + * const client = new DirectConnectClient(config); + * const command = new AllocatePublicVirtualInterfaceCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link AllocatePublicVirtualInterfaceCommandInput} for command's `input` shape. + * @see {@link AllocatePublicVirtualInterfaceCommandOutput} for command's `response` shape. + * @see {@link DirectConnectClientResolvedConfig | config} for command's `input` shape. + * */ export class AllocatePublicVirtualInterfaceCommand extends $Command< AllocatePublicVirtualInterfaceCommandInput, diff --git a/clients/client-direct-connect/commands/AllocateTransitVirtualInterfaceCommand.ts b/clients/client-direct-connect/commands/AllocateTransitVirtualInterfaceCommand.ts index b4ed0fc3d624..b455e03f4e45 100644 --- a/clients/client-direct-connect/commands/AllocateTransitVirtualInterfaceCommand.ts +++ b/clients/client-direct-connect/commands/AllocateTransitVirtualInterfaceCommand.ts @@ -26,6 +26,20 @@ export interface AllocateTransitVirtualInterfaceCommandOutput *

Provisions a transit virtual interface to be owned by the specified AWS 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 AWS 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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { DirectConnectClient, AllocateTransitVirtualInterfaceCommand } from "@aws-sdk/client-direct-connect"; // ES Modules import + * // const { DirectConnectClient, AllocateTransitVirtualInterfaceCommand } = require("@aws-sdk/client-direct-connect"); // CommonJS import + * const client = new DirectConnectClient(config); + * const command = new AllocateTransitVirtualInterfaceCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link AllocateTransitVirtualInterfaceCommandInput} for command's `input` shape. + * @see {@link AllocateTransitVirtualInterfaceCommandOutput} for command's `response` shape. + * @see {@link DirectConnectClientResolvedConfig | config} for command's `input` shape. + * */ export class AllocateTransitVirtualInterfaceCommand extends $Command< AllocateTransitVirtualInterfaceCommandInput, diff --git a/clients/client-direct-connect/commands/AssociateConnectionWithLagCommand.ts b/clients/client-direct-connect/commands/AssociateConnectionWithLagCommand.ts index f24c4cdc40ab..625c477eac94 100644 --- a/clients/client-direct-connect/commands/AssociateConnectionWithLagCommand.ts +++ b/clients/client-direct-connect/commands/AssociateConnectionWithLagCommand.ts @@ -35,6 +35,20 @@ export interface AssociateConnectionWithLagCommandOutput extends Connection, __M *

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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { DirectConnectClient, AssociateConnectionWithLagCommand } from "@aws-sdk/client-direct-connect"; // ES Modules import + * // const { DirectConnectClient, AssociateConnectionWithLagCommand } = require("@aws-sdk/client-direct-connect"); // CommonJS import + * const client = new DirectConnectClient(config); + * const command = new AssociateConnectionWithLagCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link AssociateConnectionWithLagCommandInput} for command's `input` shape. + * @see {@link AssociateConnectionWithLagCommandOutput} for command's `response` shape. + * @see {@link DirectConnectClientResolvedConfig | config} for command's `input` shape. + * */ export class AssociateConnectionWithLagCommand extends $Command< AssociateConnectionWithLagCommandInput, diff --git a/clients/client-direct-connect/commands/AssociateHostedConnectionCommand.ts b/clients/client-direct-connect/commands/AssociateHostedConnectionCommand.ts index 6a95ba6477cb..9b389c86b317 100644 --- a/clients/client-direct-connect/commands/AssociateHostedConnectionCommand.ts +++ b/clients/client-direct-connect/commands/AssociateHostedConnectionCommand.ts @@ -29,6 +29,20 @@ export interface AssociateHostedConnectionCommandOutput extends Connection, __Me * *

Intended for use by AWS Direct Connect Partners only.

* + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { DirectConnectClient, AssociateHostedConnectionCommand } from "@aws-sdk/client-direct-connect"; // ES Modules import + * // const { DirectConnectClient, AssociateHostedConnectionCommand } = require("@aws-sdk/client-direct-connect"); // CommonJS import + * const client = new DirectConnectClient(config); + * const command = new AssociateHostedConnectionCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link AssociateHostedConnectionCommandInput} for command's `input` shape. + * @see {@link AssociateHostedConnectionCommandOutput} for command's `response` shape. + * @see {@link DirectConnectClientResolvedConfig | config} for command's `input` shape. + * */ export class AssociateHostedConnectionCommand extends $Command< AssociateHostedConnectionCommandInput, diff --git a/clients/client-direct-connect/commands/AssociateMacSecKeyCommand.ts b/clients/client-direct-connect/commands/AssociateMacSecKeyCommand.ts index c14fc669b49a..dc3946b46de5 100644 --- a/clients/client-direct-connect/commands/AssociateMacSecKeyCommand.ts +++ b/clients/client-direct-connect/commands/AssociateMacSecKeyCommand.ts @@ -24,6 +24,20 @@ export interface AssociateMacSecKeyCommandOutput extends AssociateMacSecKeyRespo *

Associates a MAC Security (MACsec) Connection Key Name (CKN)/ Connectivity Association Key (CAK) pair with an AWS 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 AWS Direct Connect User Guide.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { DirectConnectClient, AssociateMacSecKeyCommand } from "@aws-sdk/client-direct-connect"; // ES Modules import + * // const { DirectConnectClient, AssociateMacSecKeyCommand } = require("@aws-sdk/client-direct-connect"); // CommonJS import + * const client = new DirectConnectClient(config); + * const command = new AssociateMacSecKeyCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link AssociateMacSecKeyCommandInput} for command's `input` shape. + * @see {@link AssociateMacSecKeyCommandOutput} for command's `response` shape. + * @see {@link DirectConnectClientResolvedConfig | config} for command's `input` shape. + * */ export class AssociateMacSecKeyCommand extends $Command< AssociateMacSecKeyCommandInput, diff --git a/clients/client-direct-connect/commands/AssociateVirtualInterfaceCommand.ts b/clients/client-direct-connect/commands/AssociateVirtualInterfaceCommand.ts index da7ef6445b58..f794da159e0d 100644 --- a/clients/client-direct-connect/commands/AssociateVirtualInterfaceCommand.ts +++ b/clients/client-direct-connect/commands/AssociateVirtualInterfaceCommand.ts @@ -31,6 +31,20 @@ export interface AssociateVirtualInterfaceCommandOutput extends VirtualInterface * 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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { DirectConnectClient, AssociateVirtualInterfaceCommand } from "@aws-sdk/client-direct-connect"; // ES Modules import + * // const { DirectConnectClient, AssociateVirtualInterfaceCommand } = require("@aws-sdk/client-direct-connect"); // CommonJS import + * const client = new DirectConnectClient(config); + * const command = new AssociateVirtualInterfaceCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link AssociateVirtualInterfaceCommandInput} for command's `input` shape. + * @see {@link AssociateVirtualInterfaceCommandOutput} for command's `response` shape. + * @see {@link DirectConnectClientResolvedConfig | config} for command's `input` shape. + * */ export class AssociateVirtualInterfaceCommand extends $Command< AssociateVirtualInterfaceCommandInput, diff --git a/clients/client-direct-connect/commands/ConfirmConnectionCommand.ts b/clients/client-direct-connect/commands/ConfirmConnectionCommand.ts index 39cb1edb3f9c..455bf99b352f 100644 --- a/clients/client-direct-connect/commands/ConfirmConnectionCommand.ts +++ b/clients/client-direct-connect/commands/ConfirmConnectionCommand.ts @@ -24,6 +24,20 @@ export interface ConfirmConnectionCommandOutput extends ConfirmConnectionRespons *

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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { DirectConnectClient, ConfirmConnectionCommand } from "@aws-sdk/client-direct-connect"; // ES Modules import + * // const { DirectConnectClient, ConfirmConnectionCommand } = require("@aws-sdk/client-direct-connect"); // CommonJS import + * const client = new DirectConnectClient(config); + * const command = new ConfirmConnectionCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ConfirmConnectionCommandInput} for command's `input` shape. + * @see {@link ConfirmConnectionCommandOutput} for command's `response` shape. + * @see {@link DirectConnectClientResolvedConfig | config} for command's `input` shape. + * */ export class ConfirmConnectionCommand extends $Command< ConfirmConnectionCommandInput, diff --git a/clients/client-direct-connect/commands/ConfirmPrivateVirtualInterfaceCommand.ts b/clients/client-direct-connect/commands/ConfirmPrivateVirtualInterfaceCommand.ts index 5edbf920013f..8814ed4c628d 100644 --- a/clients/client-direct-connect/commands/ConfirmPrivateVirtualInterfaceCommand.ts +++ b/clients/client-direct-connect/commands/ConfirmPrivateVirtualInterfaceCommand.ts @@ -27,6 +27,20 @@ export interface ConfirmPrivateVirtualInterfaceCommandOutput *

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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { DirectConnectClient, ConfirmPrivateVirtualInterfaceCommand } from "@aws-sdk/client-direct-connect"; // ES Modules import + * // const { DirectConnectClient, ConfirmPrivateVirtualInterfaceCommand } = require("@aws-sdk/client-direct-connect"); // CommonJS import + * const client = new DirectConnectClient(config); + * const command = new ConfirmPrivateVirtualInterfaceCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ConfirmPrivateVirtualInterfaceCommandInput} for command's `input` shape. + * @see {@link ConfirmPrivateVirtualInterfaceCommandOutput} for command's `response` shape. + * @see {@link DirectConnectClientResolvedConfig | config} for command's `input` shape. + * */ export class ConfirmPrivateVirtualInterfaceCommand extends $Command< ConfirmPrivateVirtualInterfaceCommandInput, diff --git a/clients/client-direct-connect/commands/ConfirmPublicVirtualInterfaceCommand.ts b/clients/client-direct-connect/commands/ConfirmPublicVirtualInterfaceCommand.ts index 36036af8eab6..49e507bbca16 100644 --- a/clients/client-direct-connect/commands/ConfirmPublicVirtualInterfaceCommand.ts +++ b/clients/client-direct-connect/commands/ConfirmPublicVirtualInterfaceCommand.ts @@ -26,6 +26,20 @@ export interface ConfirmPublicVirtualInterfaceCommandOutput *

Accepts ownership of a public virtual interface created by another AWS account.

*

After the virtual interface owner makes this call, the specified virtual interface is * created and made available to handle traffic.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { DirectConnectClient, ConfirmPublicVirtualInterfaceCommand } from "@aws-sdk/client-direct-connect"; // ES Modules import + * // const { DirectConnectClient, ConfirmPublicVirtualInterfaceCommand } = require("@aws-sdk/client-direct-connect"); // CommonJS import + * const client = new DirectConnectClient(config); + * const command = new ConfirmPublicVirtualInterfaceCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ConfirmPublicVirtualInterfaceCommandInput} for command's `input` shape. + * @see {@link ConfirmPublicVirtualInterfaceCommandOutput} for command's `response` shape. + * @see {@link DirectConnectClientResolvedConfig | config} for command's `input` shape. + * */ export class ConfirmPublicVirtualInterfaceCommand extends $Command< ConfirmPublicVirtualInterfaceCommandInput, diff --git a/clients/client-direct-connect/commands/ConfirmTransitVirtualInterfaceCommand.ts b/clients/client-direct-connect/commands/ConfirmTransitVirtualInterfaceCommand.ts index 203fcaa961f2..b9474397fc1e 100644 --- a/clients/client-direct-connect/commands/ConfirmTransitVirtualInterfaceCommand.ts +++ b/clients/client-direct-connect/commands/ConfirmTransitVirtualInterfaceCommand.ts @@ -26,6 +26,20 @@ export interface ConfirmTransitVirtualInterfaceCommandOutput *

Accepts ownership of a transit virtual interface created by another AWS 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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { DirectConnectClient, ConfirmTransitVirtualInterfaceCommand } from "@aws-sdk/client-direct-connect"; // ES Modules import + * // const { DirectConnectClient, ConfirmTransitVirtualInterfaceCommand } = require("@aws-sdk/client-direct-connect"); // CommonJS import + * const client = new DirectConnectClient(config); + * const command = new ConfirmTransitVirtualInterfaceCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ConfirmTransitVirtualInterfaceCommandInput} for command's `input` shape. + * @see {@link ConfirmTransitVirtualInterfaceCommandOutput} for command's `response` shape. + * @see {@link DirectConnectClientResolvedConfig | config} for command's `input` shape. + * */ export class ConfirmTransitVirtualInterfaceCommand extends $Command< ConfirmTransitVirtualInterfaceCommandInput, diff --git a/clients/client-direct-connect/commands/CreateBGPPeerCommand.ts b/clients/client-direct-connect/commands/CreateBGPPeerCommand.ts index 07305361ffbb..0d1ac6eaaa48 100644 --- a/clients/client-direct-connect/commands/CreateBGPPeerCommand.ts +++ b/clients/client-direct-connect/commands/CreateBGPPeerCommand.ts @@ -28,6 +28,20 @@ export interface CreateBGPPeerCommandOutput extends CreateBGPPeerResponse, __Met *

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.

*

For a public virtual interface, the Autonomous System Number (ASN) must be private or already on the allow list for the virtual interface.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { DirectConnectClient, CreateBGPPeerCommand } from "@aws-sdk/client-direct-connect"; // ES Modules import + * // const { DirectConnectClient, CreateBGPPeerCommand } = require("@aws-sdk/client-direct-connect"); // CommonJS import + * const client = new DirectConnectClient(config); + * const command = new CreateBGPPeerCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreateBGPPeerCommandInput} for command's `input` shape. + * @see {@link CreateBGPPeerCommandOutput} for command's `response` shape. + * @see {@link DirectConnectClientResolvedConfig | config} for command's `input` shape. + * */ export class CreateBGPPeerCommand extends $Command< CreateBGPPeerCommandInput, diff --git a/clients/client-direct-connect/commands/CreateConnectionCommand.ts b/clients/client-direct-connect/commands/CreateConnectionCommand.ts index f3b84a76a2b1..40775e024a80 100644 --- a/clients/client-direct-connect/commands/CreateConnectionCommand.ts +++ b/clients/client-direct-connect/commands/CreateConnectionCommand.ts @@ -30,6 +30,20 @@ export interface CreateConnectionCommandOutput extends Connection, __MetadataBea * specifying a LAG ID in the request. This ensures that the new connection is allocated on the * same AWS 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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { DirectConnectClient, CreateConnectionCommand } from "@aws-sdk/client-direct-connect"; // ES Modules import + * // const { DirectConnectClient, CreateConnectionCommand } = require("@aws-sdk/client-direct-connect"); // CommonJS import + * const client = new DirectConnectClient(config); + * const command = new CreateConnectionCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreateConnectionCommandInput} for command's `input` shape. + * @see {@link CreateConnectionCommandOutput} for command's `response` shape. + * @see {@link DirectConnectClientResolvedConfig | config} for command's `input` shape. + * */ export class CreateConnectionCommand extends $Command< CreateConnectionCommandInput, diff --git a/clients/client-direct-connect/commands/CreateDirectConnectGatewayAssociationCommand.ts b/clients/client-direct-connect/commands/CreateDirectConnectGatewayAssociationCommand.ts index 23eaec63bdc1..902e3f1a666a 100644 --- a/clients/client-direct-connect/commands/CreateDirectConnectGatewayAssociationCommand.ts +++ b/clients/client-direct-connect/commands/CreateDirectConnectGatewayAssociationCommand.ts @@ -29,6 +29,20 @@ export interface CreateDirectConnectGatewayAssociationCommandOutput /** *

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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { DirectConnectClient, CreateDirectConnectGatewayAssociationCommand } from "@aws-sdk/client-direct-connect"; // ES Modules import + * // const { DirectConnectClient, CreateDirectConnectGatewayAssociationCommand } = require("@aws-sdk/client-direct-connect"); // CommonJS import + * const client = new DirectConnectClient(config); + * const command = new CreateDirectConnectGatewayAssociationCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreateDirectConnectGatewayAssociationCommandInput} for command's `input` shape. + * @see {@link CreateDirectConnectGatewayAssociationCommandOutput} for command's `response` shape. + * @see {@link DirectConnectClientResolvedConfig | config} for command's `input` shape. + * */ export class CreateDirectConnectGatewayAssociationCommand extends $Command< CreateDirectConnectGatewayAssociationCommandInput, diff --git a/clients/client-direct-connect/commands/CreateDirectConnectGatewayAssociationProposalCommand.ts b/clients/client-direct-connect/commands/CreateDirectConnectGatewayAssociationProposalCommand.ts index e1b95fa954f2..d42743f89290 100644 --- a/clients/client-direct-connect/commands/CreateDirectConnectGatewayAssociationProposalCommand.ts +++ b/clients/client-direct-connect/commands/CreateDirectConnectGatewayAssociationProposalCommand.ts @@ -29,6 +29,20 @@ export interface CreateDirectConnectGatewayAssociationProposalCommandOutput /** *

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 AWS account.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { DirectConnectClient, CreateDirectConnectGatewayAssociationProposalCommand } from "@aws-sdk/client-direct-connect"; // ES Modules import + * // const { DirectConnectClient, CreateDirectConnectGatewayAssociationProposalCommand } = require("@aws-sdk/client-direct-connect"); // CommonJS import + * const client = new DirectConnectClient(config); + * const command = new CreateDirectConnectGatewayAssociationProposalCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreateDirectConnectGatewayAssociationProposalCommandInput} for command's `input` shape. + * @see {@link CreateDirectConnectGatewayAssociationProposalCommandOutput} for command's `response` shape. + * @see {@link DirectConnectClientResolvedConfig | config} for command's `input` shape. + * */ export class CreateDirectConnectGatewayAssociationProposalCommand extends $Command< CreateDirectConnectGatewayAssociationProposalCommandInput, diff --git a/clients/client-direct-connect/commands/CreateDirectConnectGatewayCommand.ts b/clients/client-direct-connect/commands/CreateDirectConnectGatewayCommand.ts index 1d73df0a0d15..70c5d4d45c2d 100644 --- a/clients/client-direct-connect/commands/CreateDirectConnectGatewayCommand.ts +++ b/clients/client-direct-connect/commands/CreateDirectConnectGatewayCommand.ts @@ -27,6 +27,20 @@ export interface CreateDirectConnectGatewayCommandOutput extends CreateDirectCon * are connected through a Direct Connect gateway can be in different AWS 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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { DirectConnectClient, CreateDirectConnectGatewayCommand } from "@aws-sdk/client-direct-connect"; // ES Modules import + * // const { DirectConnectClient, CreateDirectConnectGatewayCommand } = require("@aws-sdk/client-direct-connect"); // CommonJS import + * const client = new DirectConnectClient(config); + * const command = new CreateDirectConnectGatewayCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreateDirectConnectGatewayCommandInput} for command's `input` shape. + * @see {@link CreateDirectConnectGatewayCommandOutput} for command's `response` shape. + * @see {@link DirectConnectClientResolvedConfig | config} for command's `input` shape. + * */ export class CreateDirectConnectGatewayCommand extends $Command< CreateDirectConnectGatewayCommandInput, diff --git a/clients/client-direct-connect/commands/CreateInterconnectCommand.ts b/clients/client-direct-connect/commands/CreateInterconnectCommand.ts index ac4f80f5364b..d0f2630a6353 100644 --- a/clients/client-direct-connect/commands/CreateInterconnectCommand.ts +++ b/clients/client-direct-connect/commands/CreateInterconnectCommand.ts @@ -37,6 +37,20 @@ export interface CreateInterconnectCommandOutput extends Interconnect, __Metadat * *

Intended for use by AWS Direct Connect Partners only.

* + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { DirectConnectClient, CreateInterconnectCommand } from "@aws-sdk/client-direct-connect"; // ES Modules import + * // const { DirectConnectClient, CreateInterconnectCommand } = require("@aws-sdk/client-direct-connect"); // CommonJS import + * const client = new DirectConnectClient(config); + * const command = new CreateInterconnectCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreateInterconnectCommandInput} for command's `input` shape. + * @see {@link CreateInterconnectCommandOutput} for command's `response` shape. + * @see {@link DirectConnectClientResolvedConfig | config} for command's `input` shape. + * */ export class CreateInterconnectCommand extends $Command< CreateInterconnectCommandInput, diff --git a/clients/client-direct-connect/commands/CreateLagCommand.ts b/clients/client-direct-connect/commands/CreateLagCommand.ts index c561f4486222..96e57c23f00d 100644 --- a/clients/client-direct-connect/commands/CreateLagCommand.ts +++ b/clients/client-direct-connect/commands/CreateLagCommand.ts @@ -36,6 +36,20 @@ export interface CreateLagCommandOutput extends Lag, __MetadataBearer {} *

If the AWS account used to create a LAG is a registered AWS 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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { DirectConnectClient, CreateLagCommand } from "@aws-sdk/client-direct-connect"; // ES Modules import + * // const { DirectConnectClient, CreateLagCommand } = require("@aws-sdk/client-direct-connect"); // CommonJS import + * const client = new DirectConnectClient(config); + * const command = new CreateLagCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreateLagCommandInput} for command's `input` shape. + * @see {@link CreateLagCommandOutput} for command's `response` shape. + * @see {@link DirectConnectClientResolvedConfig | config} for command's `input` shape. + * */ export class CreateLagCommand extends $Command< CreateLagCommandInput, diff --git a/clients/client-direct-connect/commands/CreatePrivateVirtualInterfaceCommand.ts b/clients/client-direct-connect/commands/CreatePrivateVirtualInterfaceCommand.ts index b12d5a3a16ed..091d8f21dcb9 100644 --- a/clients/client-direct-connect/commands/CreatePrivateVirtualInterfaceCommand.ts +++ b/clients/client-direct-connect/commands/CreatePrivateVirtualInterfaceCommand.ts @@ -32,6 +32,20 @@ export interface CreatePrivateVirtualInterfaceCommandOutput extends VirtualInter * 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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { DirectConnectClient, CreatePrivateVirtualInterfaceCommand } from "@aws-sdk/client-direct-connect"; // ES Modules import + * // const { DirectConnectClient, CreatePrivateVirtualInterfaceCommand } = require("@aws-sdk/client-direct-connect"); // CommonJS import + * const client = new DirectConnectClient(config); + * const command = new CreatePrivateVirtualInterfaceCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreatePrivateVirtualInterfaceCommandInput} for command's `input` shape. + * @see {@link CreatePrivateVirtualInterfaceCommandOutput} for command's `response` shape. + * @see {@link DirectConnectClientResolvedConfig | config} for command's `input` shape. + * */ export class CreatePrivateVirtualInterfaceCommand extends $Command< CreatePrivateVirtualInterfaceCommandInput, diff --git a/clients/client-direct-connect/commands/CreatePublicVirtualInterfaceCommand.ts b/clients/client-direct-connect/commands/CreatePublicVirtualInterfaceCommand.ts index 14ef3c1cdb22..f93790339dba 100644 --- a/clients/client-direct-connect/commands/CreatePublicVirtualInterfaceCommand.ts +++ b/clients/client-direct-connect/commands/CreatePublicVirtualInterfaceCommand.ts @@ -25,6 +25,20 @@ export interface CreatePublicVirtualInterfaceCommandOutput extends VirtualInterf * A public virtual interface supports sending traffic to public services of AWS 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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { DirectConnectClient, CreatePublicVirtualInterfaceCommand } from "@aws-sdk/client-direct-connect"; // ES Modules import + * // const { DirectConnectClient, CreatePublicVirtualInterfaceCommand } = require("@aws-sdk/client-direct-connect"); // CommonJS import + * const client = new DirectConnectClient(config); + * const command = new CreatePublicVirtualInterfaceCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreatePublicVirtualInterfaceCommandInput} for command's `input` shape. + * @see {@link CreatePublicVirtualInterfaceCommandOutput} for command's `response` shape. + * @see {@link DirectConnectClientResolvedConfig | config} for command's `input` shape. + * */ export class CreatePublicVirtualInterfaceCommand extends $Command< CreatePublicVirtualInterfaceCommandInput, diff --git a/clients/client-direct-connect/commands/CreateTransitVirtualInterfaceCommand.ts b/clients/client-direct-connect/commands/CreateTransitVirtualInterfaceCommand.ts index 6bb8ba0d2998..eb76ed3f49aa 100644 --- a/clients/client-direct-connect/commands/CreateTransitVirtualInterfaceCommand.ts +++ b/clients/client-direct-connect/commands/CreateTransitVirtualInterfaceCommand.ts @@ -33,6 +33,20 @@ export interface CreateTransitVirtualInterfaceCommandOutput * 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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { DirectConnectClient, CreateTransitVirtualInterfaceCommand } from "@aws-sdk/client-direct-connect"; // ES Modules import + * // const { DirectConnectClient, CreateTransitVirtualInterfaceCommand } = require("@aws-sdk/client-direct-connect"); // CommonJS import + * const client = new DirectConnectClient(config); + * const command = new CreateTransitVirtualInterfaceCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreateTransitVirtualInterfaceCommandInput} for command's `input` shape. + * @see {@link CreateTransitVirtualInterfaceCommandOutput} for command's `response` shape. + * @see {@link DirectConnectClientResolvedConfig | config} for command's `input` shape. + * */ export class CreateTransitVirtualInterfaceCommand extends $Command< CreateTransitVirtualInterfaceCommandInput, diff --git a/clients/client-direct-connect/commands/DeleteBGPPeerCommand.ts b/clients/client-direct-connect/commands/DeleteBGPPeerCommand.ts index 09da79db8dac..984aaf6dccce 100644 --- a/clients/client-direct-connect/commands/DeleteBGPPeerCommand.ts +++ b/clients/client-direct-connect/commands/DeleteBGPPeerCommand.ts @@ -23,6 +23,20 @@ export interface DeleteBGPPeerCommandOutput extends DeleteBGPPeerResponse, __Met /** *

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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { DirectConnectClient, DeleteBGPPeerCommand } from "@aws-sdk/client-direct-connect"; // ES Modules import + * // const { DirectConnectClient, DeleteBGPPeerCommand } = require("@aws-sdk/client-direct-connect"); // CommonJS import + * const client = new DirectConnectClient(config); + * const command = new DeleteBGPPeerCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteBGPPeerCommandInput} for command's `input` shape. + * @see {@link DeleteBGPPeerCommandOutput} for command's `response` shape. + * @see {@link DirectConnectClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteBGPPeerCommand extends $Command< DeleteBGPPeerCommandInput, diff --git a/clients/client-direct-connect/commands/DeleteConnectionCommand.ts b/clients/client-direct-connect/commands/DeleteConnectionCommand.ts index 599645883eb4..fbda372ccba4 100644 --- a/clients/client-direct-connect/commands/DeleteConnectionCommand.ts +++ b/clients/client-direct-connect/commands/DeleteConnectionCommand.ts @@ -25,6 +25,20 @@ export interface DeleteConnectionCommandOutput extends Connection, __MetadataBea *

Deleting a connection only stops the AWS Direct Connect port hour and data transfer charges. * If you are partnering with any third parties to connect with the AWS Direct Connect location, * you must cancel your service with them separately.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { DirectConnectClient, DeleteConnectionCommand } from "@aws-sdk/client-direct-connect"; // ES Modules import + * // const { DirectConnectClient, DeleteConnectionCommand } = require("@aws-sdk/client-direct-connect"); // CommonJS import + * const client = new DirectConnectClient(config); + * const command = new DeleteConnectionCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteConnectionCommandInput} for command's `input` shape. + * @see {@link DeleteConnectionCommandOutput} for command's `response` shape. + * @see {@link DirectConnectClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteConnectionCommand extends $Command< DeleteConnectionCommandInput, diff --git a/clients/client-direct-connect/commands/DeleteDirectConnectGatewayAssociationCommand.ts b/clients/client-direct-connect/commands/DeleteDirectConnectGatewayAssociationCommand.ts index 27d3d3c7f015..fa2091ee8b36 100644 --- a/clients/client-direct-connect/commands/DeleteDirectConnectGatewayAssociationCommand.ts +++ b/clients/client-direct-connect/commands/DeleteDirectConnectGatewayAssociationCommand.ts @@ -29,6 +29,20 @@ export interface DeleteDirectConnectGatewayAssociationCommandOutput /** *

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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { DirectConnectClient, DeleteDirectConnectGatewayAssociationCommand } from "@aws-sdk/client-direct-connect"; // ES Modules import + * // const { DirectConnectClient, DeleteDirectConnectGatewayAssociationCommand } = require("@aws-sdk/client-direct-connect"); // CommonJS import + * const client = new DirectConnectClient(config); + * const command = new DeleteDirectConnectGatewayAssociationCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteDirectConnectGatewayAssociationCommandInput} for command's `input` shape. + * @see {@link DeleteDirectConnectGatewayAssociationCommandOutput} for command's `response` shape. + * @see {@link DirectConnectClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteDirectConnectGatewayAssociationCommand extends $Command< DeleteDirectConnectGatewayAssociationCommandInput, diff --git a/clients/client-direct-connect/commands/DeleteDirectConnectGatewayAssociationProposalCommand.ts b/clients/client-direct-connect/commands/DeleteDirectConnectGatewayAssociationProposalCommand.ts index 9c3bdaa74c02..29e5d0966ce7 100644 --- a/clients/client-direct-connect/commands/DeleteDirectConnectGatewayAssociationProposalCommand.ts +++ b/clients/client-direct-connect/commands/DeleteDirectConnectGatewayAssociationProposalCommand.ts @@ -28,6 +28,20 @@ export interface DeleteDirectConnectGatewayAssociationProposalCommandOutput /** *

Deletes the association proposal request between the specified Direct Connect gateway and virtual private gateway or transit gateway.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { DirectConnectClient, DeleteDirectConnectGatewayAssociationProposalCommand } from "@aws-sdk/client-direct-connect"; // ES Modules import + * // const { DirectConnectClient, DeleteDirectConnectGatewayAssociationProposalCommand } = require("@aws-sdk/client-direct-connect"); // CommonJS import + * const client = new DirectConnectClient(config); + * const command = new DeleteDirectConnectGatewayAssociationProposalCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteDirectConnectGatewayAssociationProposalCommandInput} for command's `input` shape. + * @see {@link DeleteDirectConnectGatewayAssociationProposalCommandOutput} for command's `response` shape. + * @see {@link DirectConnectClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteDirectConnectGatewayAssociationProposalCommand extends $Command< DeleteDirectConnectGatewayAssociationProposalCommandInput, diff --git a/clients/client-direct-connect/commands/DeleteDirectConnectGatewayCommand.ts b/clients/client-direct-connect/commands/DeleteDirectConnectGatewayCommand.ts index 83c965612d0a..afcd2df2f31b 100644 --- a/clients/client-direct-connect/commands/DeleteDirectConnectGatewayCommand.ts +++ b/clients/client-direct-connect/commands/DeleteDirectConnectGatewayCommand.ts @@ -24,6 +24,20 @@ export interface DeleteDirectConnectGatewayCommandOutput extends DeleteDirectCon *

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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { DirectConnectClient, DeleteDirectConnectGatewayCommand } from "@aws-sdk/client-direct-connect"; // ES Modules import + * // const { DirectConnectClient, DeleteDirectConnectGatewayCommand } = require("@aws-sdk/client-direct-connect"); // CommonJS import + * const client = new DirectConnectClient(config); + * const command = new DeleteDirectConnectGatewayCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteDirectConnectGatewayCommandInput} for command's `input` shape. + * @see {@link DeleteDirectConnectGatewayCommandOutput} for command's `response` shape. + * @see {@link DirectConnectClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteDirectConnectGatewayCommand extends $Command< DeleteDirectConnectGatewayCommandInput, diff --git a/clients/client-direct-connect/commands/DeleteInterconnectCommand.ts b/clients/client-direct-connect/commands/DeleteInterconnectCommand.ts index 90bc2f8f4cd6..d159a08af564 100644 --- a/clients/client-direct-connect/commands/DeleteInterconnectCommand.ts +++ b/clients/client-direct-connect/commands/DeleteInterconnectCommand.ts @@ -26,6 +26,20 @@ export interface DeleteInterconnectCommandOutput extends DeleteInterconnectRespo *

Intended for use * by AWS Direct Connect Partners only.

* + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { DirectConnectClient, DeleteInterconnectCommand } from "@aws-sdk/client-direct-connect"; // ES Modules import + * // const { DirectConnectClient, DeleteInterconnectCommand } = require("@aws-sdk/client-direct-connect"); // CommonJS import + * const client = new DirectConnectClient(config); + * const command = new DeleteInterconnectCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteInterconnectCommandInput} for command's `input` shape. + * @see {@link DeleteInterconnectCommandOutput} for command's `response` shape. + * @see {@link DirectConnectClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteInterconnectCommand extends $Command< DeleteInterconnectCommandInput, diff --git a/clients/client-direct-connect/commands/DeleteLagCommand.ts b/clients/client-direct-connect/commands/DeleteLagCommand.ts index b7755c03c481..1b9d3040fdb6 100644 --- a/clients/client-direct-connect/commands/DeleteLagCommand.ts +++ b/clients/client-direct-connect/commands/DeleteLagCommand.ts @@ -20,6 +20,20 @@ export interface DeleteLagCommandOutput extends Lag, __MetadataBearer {} /** *

Deletes the specified link aggregation group (LAG). You cannot delete a LAG if it has active * virtual interfaces or hosted connections.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { DirectConnectClient, DeleteLagCommand } from "@aws-sdk/client-direct-connect"; // ES Modules import + * // const { DirectConnectClient, DeleteLagCommand } = require("@aws-sdk/client-direct-connect"); // CommonJS import + * const client = new DirectConnectClient(config); + * const command = new DeleteLagCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteLagCommandInput} for command's `input` shape. + * @see {@link DeleteLagCommandOutput} for command's `response` shape. + * @see {@link DirectConnectClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteLagCommand extends $Command< DeleteLagCommandInput, diff --git a/clients/client-direct-connect/commands/DeleteVirtualInterfaceCommand.ts b/clients/client-direct-connect/commands/DeleteVirtualInterfaceCommand.ts index 3dfa8c6171e5..cdf067358698 100644 --- a/clients/client-direct-connect/commands/DeleteVirtualInterfaceCommand.ts +++ b/clients/client-direct-connect/commands/DeleteVirtualInterfaceCommand.ts @@ -22,6 +22,20 @@ export interface DeleteVirtualInterfaceCommandOutput extends DeleteVirtualInterf /** *

Deletes a virtual interface.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { DirectConnectClient, DeleteVirtualInterfaceCommand } from "@aws-sdk/client-direct-connect"; // ES Modules import + * // const { DirectConnectClient, DeleteVirtualInterfaceCommand } = require("@aws-sdk/client-direct-connect"); // CommonJS import + * const client = new DirectConnectClient(config); + * const command = new DeleteVirtualInterfaceCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteVirtualInterfaceCommandInput} for command's `input` shape. + * @see {@link DeleteVirtualInterfaceCommandOutput} for command's `response` shape. + * @see {@link DirectConnectClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteVirtualInterfaceCommand extends $Command< DeleteVirtualInterfaceCommandInput, diff --git a/clients/client-direct-connect/commands/DescribeConnectionLoaCommand.ts b/clients/client-direct-connect/commands/DescribeConnectionLoaCommand.ts index 0e2936b23623..658ece30c875 100644 --- a/clients/client-direct-connect/commands/DescribeConnectionLoaCommand.ts +++ b/clients/client-direct-connect/commands/DescribeConnectionLoaCommand.ts @@ -29,6 +29,20 @@ export interface DescribeConnectionLoaCommandOutput extends DescribeConnectionLo * service provider uses when establishing your cross connect to AWS at the colocation facility. For more information, * see Requesting Cross Connects * at AWS Direct Connect Locations in the AWS Direct Connect User Guide.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { DirectConnectClient, DescribeConnectionLoaCommand } from "@aws-sdk/client-direct-connect"; // ES Modules import + * // const { DirectConnectClient, DescribeConnectionLoaCommand } = require("@aws-sdk/client-direct-connect"); // CommonJS import + * const client = new DirectConnectClient(config); + * const command = new DescribeConnectionLoaCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeConnectionLoaCommandInput} for command's `input` shape. + * @see {@link DescribeConnectionLoaCommandOutput} for command's `response` shape. + * @see {@link DirectConnectClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeConnectionLoaCommand extends $Command< DescribeConnectionLoaCommandInput, diff --git a/clients/client-direct-connect/commands/DescribeConnectionsCommand.ts b/clients/client-direct-connect/commands/DescribeConnectionsCommand.ts index 1d46f3b453a7..2c5565913c41 100644 --- a/clients/client-direct-connect/commands/DescribeConnectionsCommand.ts +++ b/clients/client-direct-connect/commands/DescribeConnectionsCommand.ts @@ -22,6 +22,20 @@ export interface DescribeConnectionsCommandOutput extends Connections, __Metadat /** *

Displays the specified connection or all connections in this Region.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { DirectConnectClient, DescribeConnectionsCommand } from "@aws-sdk/client-direct-connect"; // ES Modules import + * // const { DirectConnectClient, DescribeConnectionsCommand } = require("@aws-sdk/client-direct-connect"); // CommonJS import + * const client = new DirectConnectClient(config); + * const command = new DescribeConnectionsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeConnectionsCommandInput} for command's `input` shape. + * @see {@link DescribeConnectionsCommandOutput} for command's `response` shape. + * @see {@link DirectConnectClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeConnectionsCommand extends $Command< DescribeConnectionsCommandInput, diff --git a/clients/client-direct-connect/commands/DescribeConnectionsOnInterconnectCommand.ts b/clients/client-direct-connect/commands/DescribeConnectionsOnInterconnectCommand.ts index 3265cd7ac3a3..4ce1606a5745 100644 --- a/clients/client-direct-connect/commands/DescribeConnectionsOnInterconnectCommand.ts +++ b/clients/client-direct-connect/commands/DescribeConnectionsOnInterconnectCommand.ts @@ -28,6 +28,20 @@ export interface DescribeConnectionsOnInterconnectCommandOutput extends Connecti * *

Intended for use by AWS Direct Connect Partners only.

* + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { DirectConnectClient, DescribeConnectionsOnInterconnectCommand } from "@aws-sdk/client-direct-connect"; // ES Modules import + * // const { DirectConnectClient, DescribeConnectionsOnInterconnectCommand } = require("@aws-sdk/client-direct-connect"); // CommonJS import + * const client = new DirectConnectClient(config); + * const command = new DescribeConnectionsOnInterconnectCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeConnectionsOnInterconnectCommandInput} for command's `input` shape. + * @see {@link DescribeConnectionsOnInterconnectCommandOutput} for command's `response` shape. + * @see {@link DirectConnectClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeConnectionsOnInterconnectCommand extends $Command< DescribeConnectionsOnInterconnectCommandInput, diff --git a/clients/client-direct-connect/commands/DescribeDirectConnectGatewayAssociationProposalsCommand.ts b/clients/client-direct-connect/commands/DescribeDirectConnectGatewayAssociationProposalsCommand.ts index fb598585c6a2..968e51771892 100644 --- a/clients/client-direct-connect/commands/DescribeDirectConnectGatewayAssociationProposalsCommand.ts +++ b/clients/client-direct-connect/commands/DescribeDirectConnectGatewayAssociationProposalsCommand.ts @@ -28,6 +28,20 @@ export interface DescribeDirectConnectGatewayAssociationProposalsCommandOutput /** *

Describes one or more association proposals for connection between a virtual private gateway or transit gateway and a Direct Connect gateway.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { DirectConnectClient, DescribeDirectConnectGatewayAssociationProposalsCommand } from "@aws-sdk/client-direct-connect"; // ES Modules import + * // const { DirectConnectClient, DescribeDirectConnectGatewayAssociationProposalsCommand } = require("@aws-sdk/client-direct-connect"); // CommonJS import + * const client = new DirectConnectClient(config); + * const command = new DescribeDirectConnectGatewayAssociationProposalsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeDirectConnectGatewayAssociationProposalsCommandInput} for command's `input` shape. + * @see {@link DescribeDirectConnectGatewayAssociationProposalsCommandOutput} for command's `response` shape. + * @see {@link DirectConnectClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeDirectConnectGatewayAssociationProposalsCommand extends $Command< DescribeDirectConnectGatewayAssociationProposalsCommandInput, diff --git a/clients/client-direct-connect/commands/DescribeDirectConnectGatewayAssociationsCommand.ts b/clients/client-direct-connect/commands/DescribeDirectConnectGatewayAssociationsCommand.ts index cead98601ce9..0e40d6cd4130 100644 --- a/clients/client-direct-connect/commands/DescribeDirectConnectGatewayAssociationsCommand.ts +++ b/clients/client-direct-connect/commands/DescribeDirectConnectGatewayAssociationsCommand.ts @@ -50,6 +50,20 @@ export interface DescribeDirectConnectGatewayAssociationsCommandOutput *

The response contains the association between the Direct Connect gateway and transit gateway.

* * + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { DirectConnectClient, DescribeDirectConnectGatewayAssociationsCommand } from "@aws-sdk/client-direct-connect"; // ES Modules import + * // const { DirectConnectClient, DescribeDirectConnectGatewayAssociationsCommand } = require("@aws-sdk/client-direct-connect"); // CommonJS import + * const client = new DirectConnectClient(config); + * const command = new DescribeDirectConnectGatewayAssociationsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeDirectConnectGatewayAssociationsCommandInput} for command's `input` shape. + * @see {@link DescribeDirectConnectGatewayAssociationsCommandOutput} for command's `response` shape. + * @see {@link DirectConnectClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeDirectConnectGatewayAssociationsCommand extends $Command< DescribeDirectConnectGatewayAssociationsCommandInput, diff --git a/clients/client-direct-connect/commands/DescribeDirectConnectGatewayAttachmentsCommand.ts b/clients/client-direct-connect/commands/DescribeDirectConnectGatewayAttachmentsCommand.ts index b380e472ff55..b44d65c2afc8 100644 --- a/clients/client-direct-connect/commands/DescribeDirectConnectGatewayAttachmentsCommand.ts +++ b/clients/client-direct-connect/commands/DescribeDirectConnectGatewayAttachmentsCommand.ts @@ -32,6 +32,20 @@ export interface DescribeDirectConnectGatewayAttachmentsCommandOutput * 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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { DirectConnectClient, DescribeDirectConnectGatewayAttachmentsCommand } from "@aws-sdk/client-direct-connect"; // ES Modules import + * // const { DirectConnectClient, DescribeDirectConnectGatewayAttachmentsCommand } = require("@aws-sdk/client-direct-connect"); // CommonJS import + * const client = new DirectConnectClient(config); + * const command = new DescribeDirectConnectGatewayAttachmentsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeDirectConnectGatewayAttachmentsCommandInput} for command's `input` shape. + * @see {@link DescribeDirectConnectGatewayAttachmentsCommandOutput} for command's `response` shape. + * @see {@link DirectConnectClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeDirectConnectGatewayAttachmentsCommand extends $Command< DescribeDirectConnectGatewayAttachmentsCommandInput, diff --git a/clients/client-direct-connect/commands/DescribeDirectConnectGatewaysCommand.ts b/clients/client-direct-connect/commands/DescribeDirectConnectGatewaysCommand.ts index 4b07bbe0f247..71ad2cae0000 100644 --- a/clients/client-direct-connect/commands/DescribeDirectConnectGatewaysCommand.ts +++ b/clients/client-direct-connect/commands/DescribeDirectConnectGatewaysCommand.ts @@ -24,6 +24,20 @@ export interface DescribeDirectConnectGatewaysCommandOutput /** *

Lists all your Direct Connect gateways or only the specified Direct Connect gateway. Deleted Direct Connect gateways are not returned.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { DirectConnectClient, DescribeDirectConnectGatewaysCommand } from "@aws-sdk/client-direct-connect"; // ES Modules import + * // const { DirectConnectClient, DescribeDirectConnectGatewaysCommand } = require("@aws-sdk/client-direct-connect"); // CommonJS import + * const client = new DirectConnectClient(config); + * const command = new DescribeDirectConnectGatewaysCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeDirectConnectGatewaysCommandInput} for command's `input` shape. + * @see {@link DescribeDirectConnectGatewaysCommandOutput} for command's `response` shape. + * @see {@link DirectConnectClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeDirectConnectGatewaysCommand extends $Command< DescribeDirectConnectGatewaysCommandInput, diff --git a/clients/client-direct-connect/commands/DescribeHostedConnectionsCommand.ts b/clients/client-direct-connect/commands/DescribeHostedConnectionsCommand.ts index 9c42812a3532..07fda1df1951 100644 --- a/clients/client-direct-connect/commands/DescribeHostedConnectionsCommand.ts +++ b/clients/client-direct-connect/commands/DescribeHostedConnectionsCommand.ts @@ -26,6 +26,20 @@ export interface DescribeHostedConnectionsCommandOutput extends Connections, __M * *

Intended for use by AWS Direct Connect Partners only.

* + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { DirectConnectClient, DescribeHostedConnectionsCommand } from "@aws-sdk/client-direct-connect"; // ES Modules import + * // const { DirectConnectClient, DescribeHostedConnectionsCommand } = require("@aws-sdk/client-direct-connect"); // CommonJS import + * const client = new DirectConnectClient(config); + * const command = new DescribeHostedConnectionsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeHostedConnectionsCommandInput} for command's `input` shape. + * @see {@link DescribeHostedConnectionsCommandOutput} for command's `response` shape. + * @see {@link DirectConnectClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeHostedConnectionsCommand extends $Command< DescribeHostedConnectionsCommandInput, diff --git a/clients/client-direct-connect/commands/DescribeInterconnectLoaCommand.ts b/clients/client-direct-connect/commands/DescribeInterconnectLoaCommand.ts index d3bc8678d57a..f1305e4b7555 100644 --- a/clients/client-direct-connect/commands/DescribeInterconnectLoaCommand.ts +++ b/clients/client-direct-connect/commands/DescribeInterconnectLoaCommand.ts @@ -28,6 +28,20 @@ export interface DescribeInterconnectLoaCommandOutput extends DescribeInterconne *

The Letter of Authorization - Connecting Facility Assignment (LOA-CFA) is a document that is used when establishing your cross connect to AWS at the colocation facility. * For more information, see Requesting Cross Connects at AWS Direct Connect Locations * in the AWS Direct Connect User Guide.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { DirectConnectClient, DescribeInterconnectLoaCommand } from "@aws-sdk/client-direct-connect"; // ES Modules import + * // const { DirectConnectClient, DescribeInterconnectLoaCommand } = require("@aws-sdk/client-direct-connect"); // CommonJS import + * const client = new DirectConnectClient(config); + * const command = new DescribeInterconnectLoaCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeInterconnectLoaCommandInput} for command's `input` shape. + * @see {@link DescribeInterconnectLoaCommandOutput} for command's `response` shape. + * @see {@link DirectConnectClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeInterconnectLoaCommand extends $Command< DescribeInterconnectLoaCommandInput, diff --git a/clients/client-direct-connect/commands/DescribeInterconnectsCommand.ts b/clients/client-direct-connect/commands/DescribeInterconnectsCommand.ts index fecfa46662ab..7ac0cfccf389 100644 --- a/clients/client-direct-connect/commands/DescribeInterconnectsCommand.ts +++ b/clients/client-direct-connect/commands/DescribeInterconnectsCommand.ts @@ -22,6 +22,20 @@ export interface DescribeInterconnectsCommandOutput extends Interconnects, __Met /** *

Lists the interconnects owned by the AWS account or only the specified interconnect.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { DirectConnectClient, DescribeInterconnectsCommand } from "@aws-sdk/client-direct-connect"; // ES Modules import + * // const { DirectConnectClient, DescribeInterconnectsCommand } = require("@aws-sdk/client-direct-connect"); // CommonJS import + * const client = new DirectConnectClient(config); + * const command = new DescribeInterconnectsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeInterconnectsCommandInput} for command's `input` shape. + * @see {@link DescribeInterconnectsCommandOutput} for command's `response` shape. + * @see {@link DirectConnectClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeInterconnectsCommand extends $Command< DescribeInterconnectsCommandInput, diff --git a/clients/client-direct-connect/commands/DescribeLagsCommand.ts b/clients/client-direct-connect/commands/DescribeLagsCommand.ts index 960f42cdc41c..6bb77dc4bd8c 100644 --- a/clients/client-direct-connect/commands/DescribeLagsCommand.ts +++ b/clients/client-direct-connect/commands/DescribeLagsCommand.ts @@ -22,6 +22,20 @@ export interface DescribeLagsCommandOutput extends Lags, __MetadataBearer {} /** *

Describes all your link aggregation groups (LAG) or the specified LAG.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { DirectConnectClient, DescribeLagsCommand } from "@aws-sdk/client-direct-connect"; // ES Modules import + * // const { DirectConnectClient, DescribeLagsCommand } = require("@aws-sdk/client-direct-connect"); // CommonJS import + * const client = new DirectConnectClient(config); + * const command = new DescribeLagsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeLagsCommandInput} for command's `input` shape. + * @see {@link DescribeLagsCommandOutput} for command's `response` shape. + * @see {@link DirectConnectClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeLagsCommand extends $Command< DescribeLagsCommandInput, diff --git a/clients/client-direct-connect/commands/DescribeLoaCommand.ts b/clients/client-direct-connect/commands/DescribeLoaCommand.ts index ed0123aafcfc..49e8a674db98 100644 --- a/clients/client-direct-connect/commands/DescribeLoaCommand.ts +++ b/clients/client-direct-connect/commands/DescribeLoaCommand.ts @@ -25,6 +25,20 @@ export interface DescribeLoaCommandOutput extends Loa, __MetadataBearer {} *

The Letter of Authorization - Connecting Facility Assignment (LOA-CFA) is a document that is used when establishing * your cross connect to AWS at the colocation facility. For more information, see Requesting Cross Connects at AWS Direct Connect Locations * in the AWS Direct Connect User Guide.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { DirectConnectClient, DescribeLoaCommand } from "@aws-sdk/client-direct-connect"; // ES Modules import + * // const { DirectConnectClient, DescribeLoaCommand } = require("@aws-sdk/client-direct-connect"); // CommonJS import + * const client = new DirectConnectClient(config); + * const command = new DescribeLoaCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeLoaCommandInput} for command's `input` shape. + * @see {@link DescribeLoaCommandOutput} for command's `response` shape. + * @see {@link DirectConnectClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeLoaCommand extends $Command< DescribeLoaCommandInput, diff --git a/clients/client-direct-connect/commands/DescribeLocationsCommand.ts b/clients/client-direct-connect/commands/DescribeLocationsCommand.ts index 2cb8079b71cb..680b2d8d64b9 100644 --- a/clients/client-direct-connect/commands/DescribeLocationsCommand.ts +++ b/clients/client-direct-connect/commands/DescribeLocationsCommand.ts @@ -23,6 +23,20 @@ export interface DescribeLocationsCommandOutput extends Locations, __MetadataBea /** *

Lists the AWS Direct Connect locations in the current AWS Region. These are the locations that can be selected when calling * CreateConnection or CreateInterconnect.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { DirectConnectClient, DescribeLocationsCommand } from "@aws-sdk/client-direct-connect"; // ES Modules import + * // const { DirectConnectClient, DescribeLocationsCommand } = require("@aws-sdk/client-direct-connect"); // CommonJS import + * const client = new DirectConnectClient(config); + * const command = new DescribeLocationsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeLocationsCommandInput} for command's `input` shape. + * @see {@link DescribeLocationsCommandOutput} for command's `response` shape. + * @see {@link DirectConnectClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeLocationsCommand extends $Command< DescribeLocationsCommandInput, diff --git a/clients/client-direct-connect/commands/DescribeTagsCommand.ts b/clients/client-direct-connect/commands/DescribeTagsCommand.ts index b8ac62d152a3..e2a66c155ff5 100644 --- a/clients/client-direct-connect/commands/DescribeTagsCommand.ts +++ b/clients/client-direct-connect/commands/DescribeTagsCommand.ts @@ -22,6 +22,20 @@ export interface DescribeTagsCommandOutput extends DescribeTagsResponse, __Metad /** *

Describes the tags associated with the specified AWS Direct Connect resources.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { DirectConnectClient, DescribeTagsCommand } from "@aws-sdk/client-direct-connect"; // ES Modules import + * // const { DirectConnectClient, DescribeTagsCommand } = require("@aws-sdk/client-direct-connect"); // CommonJS import + * const client = new DirectConnectClient(config); + * const command = new DescribeTagsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeTagsCommandInput} for command's `input` shape. + * @see {@link DescribeTagsCommandOutput} for command's `response` shape. + * @see {@link DirectConnectClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeTagsCommand extends $Command< DescribeTagsCommandInput, diff --git a/clients/client-direct-connect/commands/DescribeVirtualGatewaysCommand.ts b/clients/client-direct-connect/commands/DescribeVirtualGatewaysCommand.ts index 006a0b3cb7d1..031f5ecf2010 100644 --- a/clients/client-direct-connect/commands/DescribeVirtualGatewaysCommand.ts +++ b/clients/client-direct-connect/commands/DescribeVirtualGatewaysCommand.ts @@ -23,6 +23,20 @@ export interface DescribeVirtualGatewaysCommandOutput extends VirtualGateways, _ /** *

Lists the virtual private gateways owned by the AWS account.

*

You can create one or more AWS Direct Connect private virtual interfaces linked to a virtual private gateway.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { DirectConnectClient, DescribeVirtualGatewaysCommand } from "@aws-sdk/client-direct-connect"; // ES Modules import + * // const { DirectConnectClient, DescribeVirtualGatewaysCommand } = require("@aws-sdk/client-direct-connect"); // CommonJS import + * const client = new DirectConnectClient(config); + * const command = new DescribeVirtualGatewaysCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeVirtualGatewaysCommandInput} for command's `input` shape. + * @see {@link DescribeVirtualGatewaysCommandOutput} for command's `response` shape. + * @see {@link DirectConnectClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeVirtualGatewaysCommand extends $Command< DescribeVirtualGatewaysCommandInput, diff --git a/clients/client-direct-connect/commands/DescribeVirtualInterfacesCommand.ts b/clients/client-direct-connect/commands/DescribeVirtualInterfacesCommand.ts index fdc16eec61cb..90c44c5805e5 100644 --- a/clients/client-direct-connect/commands/DescribeVirtualInterfacesCommand.ts +++ b/clients/client-direct-connect/commands/DescribeVirtualInterfacesCommand.ts @@ -26,6 +26,20 @@ export interface DescribeVirtualInterfacesCommandOutput extends VirtualInterface * 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 AWS Direct Connect location and the customer network.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { DirectConnectClient, DescribeVirtualInterfacesCommand } from "@aws-sdk/client-direct-connect"; // ES Modules import + * // const { DirectConnectClient, DescribeVirtualInterfacesCommand } = require("@aws-sdk/client-direct-connect"); // CommonJS import + * const client = new DirectConnectClient(config); + * const command = new DescribeVirtualInterfacesCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeVirtualInterfacesCommandInput} for command's `input` shape. + * @see {@link DescribeVirtualInterfacesCommandOutput} for command's `response` shape. + * @see {@link DirectConnectClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeVirtualInterfacesCommand extends $Command< DescribeVirtualInterfacesCommandInput, diff --git a/clients/client-direct-connect/commands/DisassociateConnectionFromLagCommand.ts b/clients/client-direct-connect/commands/DisassociateConnectionFromLagCommand.ts index 1b0c56e2dd4a..525ea014e550 100644 --- a/clients/client-direct-connect/commands/DisassociateConnectionFromLagCommand.ts +++ b/clients/client-direct-connect/commands/DisassociateConnectionFromLagCommand.ts @@ -31,6 +31,20 @@ export interface DisassociateConnectionFromLagCommandOutput extends Connection, * 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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { DirectConnectClient, DisassociateConnectionFromLagCommand } from "@aws-sdk/client-direct-connect"; // ES Modules import + * // const { DirectConnectClient, DisassociateConnectionFromLagCommand } = require("@aws-sdk/client-direct-connect"); // CommonJS import + * const client = new DirectConnectClient(config); + * const command = new DisassociateConnectionFromLagCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DisassociateConnectionFromLagCommandInput} for command's `input` shape. + * @see {@link DisassociateConnectionFromLagCommandOutput} for command's `response` shape. + * @see {@link DirectConnectClientResolvedConfig | config} for command's `input` shape. + * */ export class DisassociateConnectionFromLagCommand extends $Command< DisassociateConnectionFromLagCommandInput, diff --git a/clients/client-direct-connect/commands/DisassociateMacSecKeyCommand.ts b/clients/client-direct-connect/commands/DisassociateMacSecKeyCommand.ts index 185f10dea236..f699a293953b 100644 --- a/clients/client-direct-connect/commands/DisassociateMacSecKeyCommand.ts +++ b/clients/client-direct-connect/commands/DisassociateMacSecKeyCommand.ts @@ -22,6 +22,20 @@ export interface DisassociateMacSecKeyCommandOutput extends DisassociateMacSecKe /** *

Removes the association between a MAC Security (MACsec) security key and an AWS Direct Connect dedicated connection.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { DirectConnectClient, DisassociateMacSecKeyCommand } from "@aws-sdk/client-direct-connect"; // ES Modules import + * // const { DirectConnectClient, DisassociateMacSecKeyCommand } = require("@aws-sdk/client-direct-connect"); // CommonJS import + * const client = new DirectConnectClient(config); + * const command = new DisassociateMacSecKeyCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DisassociateMacSecKeyCommandInput} for command's `input` shape. + * @see {@link DisassociateMacSecKeyCommandOutput} for command's `response` shape. + * @see {@link DirectConnectClientResolvedConfig | config} for command's `input` shape. + * */ export class DisassociateMacSecKeyCommand extends $Command< DisassociateMacSecKeyCommandInput, diff --git a/clients/client-direct-connect/commands/ListVirtualInterfaceTestHistoryCommand.ts b/clients/client-direct-connect/commands/ListVirtualInterfaceTestHistoryCommand.ts index fa27c121270a..6a060ec9798e 100644 --- a/clients/client-direct-connect/commands/ListVirtualInterfaceTestHistoryCommand.ts +++ b/clients/client-direct-connect/commands/ListVirtualInterfaceTestHistoryCommand.ts @@ -24,6 +24,20 @@ export interface ListVirtualInterfaceTestHistoryCommandOutput /** *

Lists the virtual interface failover test history.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { DirectConnectClient, ListVirtualInterfaceTestHistoryCommand } from "@aws-sdk/client-direct-connect"; // ES Modules import + * // const { DirectConnectClient, ListVirtualInterfaceTestHistoryCommand } = require("@aws-sdk/client-direct-connect"); // CommonJS import + * const client = new DirectConnectClient(config); + * const command = new ListVirtualInterfaceTestHistoryCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListVirtualInterfaceTestHistoryCommandInput} for command's `input` shape. + * @see {@link ListVirtualInterfaceTestHistoryCommandOutput} for command's `response` shape. + * @see {@link DirectConnectClientResolvedConfig | config} for command's `input` shape. + * */ export class ListVirtualInterfaceTestHistoryCommand extends $Command< ListVirtualInterfaceTestHistoryCommandInput, diff --git a/clients/client-direct-connect/commands/StartBgpFailoverTestCommand.ts b/clients/client-direct-connect/commands/StartBgpFailoverTestCommand.ts index 9dd2ed4f3721..18540a64aa0d 100644 --- a/clients/client-direct-connect/commands/StartBgpFailoverTestCommand.ts +++ b/clients/client-direct-connect/commands/StartBgpFailoverTestCommand.ts @@ -25,6 +25,20 @@ export interface StartBgpFailoverTestCommandOutput extends StartBgpFailoverTestR *

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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { DirectConnectClient, StartBgpFailoverTestCommand } from "@aws-sdk/client-direct-connect"; // ES Modules import + * // const { DirectConnectClient, StartBgpFailoverTestCommand } = require("@aws-sdk/client-direct-connect"); // CommonJS import + * const client = new DirectConnectClient(config); + * const command = new StartBgpFailoverTestCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link StartBgpFailoverTestCommandInput} for command's `input` shape. + * @see {@link StartBgpFailoverTestCommandOutput} for command's `response` shape. + * @see {@link DirectConnectClientResolvedConfig | config} for command's `input` shape. + * */ export class StartBgpFailoverTestCommand extends $Command< StartBgpFailoverTestCommandInput, diff --git a/clients/client-direct-connect/commands/StopBgpFailoverTestCommand.ts b/clients/client-direct-connect/commands/StopBgpFailoverTestCommand.ts index 30894a8f4621..7da89419685b 100644 --- a/clients/client-direct-connect/commands/StopBgpFailoverTestCommand.ts +++ b/clients/client-direct-connect/commands/StopBgpFailoverTestCommand.ts @@ -22,6 +22,20 @@ export interface StopBgpFailoverTestCommandOutput extends StopBgpFailoverTestRes /** *

Stops the virtual interface failover test.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { DirectConnectClient, StopBgpFailoverTestCommand } from "@aws-sdk/client-direct-connect"; // ES Modules import + * // const { DirectConnectClient, StopBgpFailoverTestCommand } = require("@aws-sdk/client-direct-connect"); // CommonJS import + * const client = new DirectConnectClient(config); + * const command = new StopBgpFailoverTestCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link StopBgpFailoverTestCommandInput} for command's `input` shape. + * @see {@link StopBgpFailoverTestCommandOutput} for command's `response` shape. + * @see {@link DirectConnectClientResolvedConfig | config} for command's `input` shape. + * */ export class StopBgpFailoverTestCommand extends $Command< StopBgpFailoverTestCommandInput, diff --git a/clients/client-direct-connect/commands/TagResourceCommand.ts b/clients/client-direct-connect/commands/TagResourceCommand.ts index 65989fc71ec0..bd7fbf87f66f 100644 --- a/clients/client-direct-connect/commands/TagResourceCommand.ts +++ b/clients/client-direct-connect/commands/TagResourceCommand.ts @@ -23,6 +23,20 @@ export interface TagResourceCommandOutput extends TagResourceResponse, __Metadat /** *

Adds the specified tags to the specified AWS 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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { DirectConnectClient, TagResourceCommand } from "@aws-sdk/client-direct-connect"; // ES Modules import + * // const { DirectConnectClient, TagResourceCommand } = require("@aws-sdk/client-direct-connect"); // CommonJS import + * const client = new DirectConnectClient(config); + * const command = new TagResourceCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link TagResourceCommandInput} for command's `input` shape. + * @see {@link TagResourceCommandOutput} for command's `response` shape. + * @see {@link DirectConnectClientResolvedConfig | config} for command's `input` shape. + * */ export class TagResourceCommand extends $Command< TagResourceCommandInput, diff --git a/clients/client-direct-connect/commands/UntagResourceCommand.ts b/clients/client-direct-connect/commands/UntagResourceCommand.ts index 2358dd4023e5..710b7dcbe9bf 100644 --- a/clients/client-direct-connect/commands/UntagResourceCommand.ts +++ b/clients/client-direct-connect/commands/UntagResourceCommand.ts @@ -22,6 +22,20 @@ export interface UntagResourceCommandOutput extends UntagResourceResponse, __Met /** *

Removes one or more tags from the specified AWS Direct Connect resource.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { DirectConnectClient, UntagResourceCommand } from "@aws-sdk/client-direct-connect"; // ES Modules import + * // const { DirectConnectClient, UntagResourceCommand } = require("@aws-sdk/client-direct-connect"); // CommonJS import + * const client = new DirectConnectClient(config); + * const command = new UntagResourceCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link UntagResourceCommandInput} for command's `input` shape. + * @see {@link UntagResourceCommandOutput} for command's `response` shape. + * @see {@link DirectConnectClientResolvedConfig | config} for command's `input` shape. + * */ export class UntagResourceCommand extends $Command< UntagResourceCommandInput, diff --git a/clients/client-direct-connect/commands/UpdateConnectionCommand.ts b/clients/client-direct-connect/commands/UpdateConnectionCommand.ts index 4b77178c0cf3..95b835355be5 100644 --- a/clients/client-direct-connect/commands/UpdateConnectionCommand.ts +++ b/clients/client-direct-connect/commands/UpdateConnectionCommand.ts @@ -31,6 +31,20 @@ export interface UpdateConnectionCommandOutput extends Connection, __MetadataBea *

The connection's MAC Security (MACsec) encryption mode.

* * + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { DirectConnectClient, UpdateConnectionCommand } from "@aws-sdk/client-direct-connect"; // ES Modules import + * // const { DirectConnectClient, UpdateConnectionCommand } = require("@aws-sdk/client-direct-connect"); // CommonJS import + * const client = new DirectConnectClient(config); + * const command = new UpdateConnectionCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link UpdateConnectionCommandInput} for command's `input` shape. + * @see {@link UpdateConnectionCommandOutput} for command's `response` shape. + * @see {@link DirectConnectClientResolvedConfig | config} for command's `input` shape. + * */ export class UpdateConnectionCommand extends $Command< UpdateConnectionCommandInput, diff --git a/clients/client-direct-connect/commands/UpdateDirectConnectGatewayAssociationCommand.ts b/clients/client-direct-connect/commands/UpdateDirectConnectGatewayAssociationCommand.ts index 98b9101c224e..45b6d02db4ec 100644 --- a/clients/client-direct-connect/commands/UpdateDirectConnectGatewayAssociationCommand.ts +++ b/clients/client-direct-connect/commands/UpdateDirectConnectGatewayAssociationCommand.ts @@ -29,6 +29,20 @@ export interface UpdateDirectConnectGatewayAssociationCommandOutput /** *

Updates the specified attributes of the Direct Connect gateway association.

*

Add or remove prefixes from the association.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { DirectConnectClient, UpdateDirectConnectGatewayAssociationCommand } from "@aws-sdk/client-direct-connect"; // ES Modules import + * // const { DirectConnectClient, UpdateDirectConnectGatewayAssociationCommand } = require("@aws-sdk/client-direct-connect"); // CommonJS import + * const client = new DirectConnectClient(config); + * const command = new UpdateDirectConnectGatewayAssociationCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link UpdateDirectConnectGatewayAssociationCommandInput} for command's `input` shape. + * @see {@link UpdateDirectConnectGatewayAssociationCommandOutput} for command's `response` shape. + * @see {@link DirectConnectClientResolvedConfig | config} for command's `input` shape. + * */ export class UpdateDirectConnectGatewayAssociationCommand extends $Command< UpdateDirectConnectGatewayAssociationCommandInput, diff --git a/clients/client-direct-connect/commands/UpdateLagCommand.ts b/clients/client-direct-connect/commands/UpdateLagCommand.ts index 4b03d110d232..50e3cf0b241a 100644 --- a/clients/client-direct-connect/commands/UpdateLagCommand.ts +++ b/clients/client-direct-connect/commands/UpdateLagCommand.ts @@ -41,6 +41,20 @@ export interface UpdateLagCommandOutput extends Lag, __MetadataBearer {} * that the new value does not cause the LAG to fall below the threshold and become * non-operational.

* + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { DirectConnectClient, UpdateLagCommand } from "@aws-sdk/client-direct-connect"; // ES Modules import + * // const { DirectConnectClient, UpdateLagCommand } = require("@aws-sdk/client-direct-connect"); // CommonJS import + * const client = new DirectConnectClient(config); + * const command = new UpdateLagCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link UpdateLagCommandInput} for command's `input` shape. + * @see {@link UpdateLagCommandOutput} for command's `response` shape. + * @see {@link DirectConnectClientResolvedConfig | config} for command's `input` shape. + * */ export class UpdateLagCommand extends $Command< UpdateLagCommandInput, diff --git a/clients/client-direct-connect/commands/UpdateVirtualInterfaceAttributesCommand.ts b/clients/client-direct-connect/commands/UpdateVirtualInterfaceAttributesCommand.ts index e887932a4cc4..959825dcad3f 100644 --- a/clients/client-direct-connect/commands/UpdateVirtualInterfaceAttributesCommand.ts +++ b/clients/client-direct-connect/commands/UpdateVirtualInterfaceAttributesCommand.ts @@ -28,6 +28,20 @@ export interface UpdateVirtualInterfaceAttributesCommandOutput extends VirtualIn * 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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { DirectConnectClient, UpdateVirtualInterfaceAttributesCommand } from "@aws-sdk/client-direct-connect"; // ES Modules import + * // const { DirectConnectClient, UpdateVirtualInterfaceAttributesCommand } = require("@aws-sdk/client-direct-connect"); // CommonJS import + * const client = new DirectConnectClient(config); + * const command = new UpdateVirtualInterfaceAttributesCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link UpdateVirtualInterfaceAttributesCommandInput} for command's `input` shape. + * @see {@link UpdateVirtualInterfaceAttributesCommandOutput} for command's `response` shape. + * @see {@link DirectConnectClientResolvedConfig | config} for command's `input` shape. + * */ export class UpdateVirtualInterfaceAttributesCommand extends $Command< UpdateVirtualInterfaceAttributesCommandInput, diff --git a/clients/client-direct-connect/models/models_0.ts b/clients/client-direct-connect/models/models_0.ts index 914668b5d88d..f07227f227ee 100644 --- a/clients/client-direct-connect/models/models_0.ts +++ b/clients/client-direct-connect/models/models_0.ts @@ -13,6 +13,9 @@ export interface RouteFilterPrefix { } export namespace RouteFilterPrefix { + /** + * @internal + */ export const filterSensitiveLog = (obj: RouteFilterPrefix): any => ({ ...obj, }); @@ -42,6 +45,9 @@ export interface AcceptDirectConnectGatewayAssociationProposalRequest { } export namespace AcceptDirectConnectGatewayAssociationProposalRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: AcceptDirectConnectGatewayAssociationProposalRequest): any => ({ ...obj, }); @@ -78,6 +84,9 @@ export interface AssociatedGateway { } export namespace AssociatedGateway { + /** + * @internal + */ export const filterSensitiveLog = (obj: AssociatedGateway): any => ({ ...obj, }); @@ -166,6 +175,9 @@ export interface DirectConnectGatewayAssociation { } export namespace DirectConnectGatewayAssociation { + /** + * @internal + */ export const filterSensitiveLog = (obj: DirectConnectGatewayAssociation): any => ({ ...obj, }); @@ -179,6 +191,9 @@ export interface AcceptDirectConnectGatewayAssociationProposalResult { } export namespace AcceptDirectConnectGatewayAssociationProposalResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: AcceptDirectConnectGatewayAssociationProposalResult): any => ({ ...obj, }); @@ -194,6 +209,9 @@ export interface DirectConnectClientException extends __SmithyException, $Metada } export namespace DirectConnectClientException { + /** + * @internal + */ export const filterSensitiveLog = (obj: DirectConnectClientException): any => ({ ...obj, }); @@ -209,6 +227,9 @@ export interface DirectConnectServerException extends __SmithyException, $Metada } export namespace DirectConnectServerException { + /** + * @internal + */ export const filterSensitiveLog = (obj: DirectConnectServerException): any => ({ ...obj, }); @@ -250,6 +271,9 @@ export interface AllocateConnectionOnInterconnectRequest { } export namespace AllocateConnectionOnInterconnectRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: AllocateConnectionOnInterconnectRequest): any => ({ ...obj, }); @@ -317,6 +341,9 @@ export interface MacSecKey { } export namespace MacSecKey { + /** + * @internal + */ export const filterSensitiveLog = (obj: MacSecKey): any => ({ ...obj, }); @@ -338,6 +365,9 @@ export interface Tag { } export namespace Tag { + /** + * @internal + */ export const filterSensitiveLog = (obj: Tag): any => ({ ...obj, }); @@ -496,6 +526,9 @@ export interface Connection { } export namespace Connection { + /** + * @internal + */ export const filterSensitiveLog = (obj: Connection): any => ({ ...obj, }); @@ -534,6 +567,9 @@ export interface AllocateHostedConnectionRequest { } export namespace AllocateHostedConnectionRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: AllocateHostedConnectionRequest): any => ({ ...obj, }); @@ -549,6 +585,9 @@ export interface DuplicateTagKeysException extends __SmithyException, $MetadataB } export namespace DuplicateTagKeysException { + /** + * @internal + */ export const filterSensitiveLog = (obj: DuplicateTagKeysException): any => ({ ...obj, }); @@ -564,6 +603,9 @@ export interface TooManyTagsException extends __SmithyException, $MetadataBearer } export namespace TooManyTagsException { + /** + * @internal + */ export const filterSensitiveLog = (obj: TooManyTagsException): any => ({ ...obj, }); @@ -621,6 +663,9 @@ export interface NewPrivateVirtualInterfaceAllocation { } export namespace NewPrivateVirtualInterfaceAllocation { + /** + * @internal + */ export const filterSensitiveLog = (obj: NewPrivateVirtualInterfaceAllocation): any => ({ ...obj, }); @@ -644,6 +689,9 @@ export interface AllocatePrivateVirtualInterfaceRequest { } export namespace AllocatePrivateVirtualInterfaceRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: AllocatePrivateVirtualInterfaceRequest): any => ({ ...obj, }); @@ -751,6 +799,9 @@ export interface BGPPeer { } export namespace BGPPeer { + /** + * @internal + */ export const filterSensitiveLog = (obj: BGPPeer): any => ({ ...obj, }); @@ -933,6 +984,9 @@ export interface VirtualInterface { } export namespace VirtualInterface { + /** + * @internal + */ export const filterSensitiveLog = (obj: VirtualInterface): any => ({ ...obj, }); @@ -990,6 +1044,9 @@ export interface NewPublicVirtualInterfaceAllocation { } export namespace NewPublicVirtualInterfaceAllocation { + /** + * @internal + */ export const filterSensitiveLog = (obj: NewPublicVirtualInterfaceAllocation): any => ({ ...obj, }); @@ -1013,6 +1070,9 @@ export interface AllocatePublicVirtualInterfaceRequest { } export namespace AllocatePublicVirtualInterfaceRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: AllocatePublicVirtualInterfaceRequest): any => ({ ...obj, }); @@ -1070,6 +1130,9 @@ export interface NewTransitVirtualInterfaceAllocation { } export namespace NewTransitVirtualInterfaceAllocation { + /** + * @internal + */ export const filterSensitiveLog = (obj: NewTransitVirtualInterfaceAllocation): any => ({ ...obj, }); @@ -1093,6 +1156,9 @@ export interface AllocateTransitVirtualInterfaceRequest { } export namespace AllocateTransitVirtualInterfaceRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: AllocateTransitVirtualInterfaceRequest): any => ({ ...obj, }); @@ -1106,6 +1172,9 @@ export interface AllocateTransitVirtualInterfaceResult { } export namespace AllocateTransitVirtualInterfaceResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: AllocateTransitVirtualInterfaceResult): any => ({ ...obj, }); @@ -1124,6 +1193,9 @@ export interface AssociateConnectionWithLagRequest { } export namespace AssociateConnectionWithLagRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: AssociateConnectionWithLagRequest): any => ({ ...obj, }); @@ -1142,6 +1214,9 @@ export interface AssociateHostedConnectionRequest { } export namespace AssociateHostedConnectionRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: AssociateHostedConnectionRequest): any => ({ ...obj, }); @@ -1179,6 +1254,9 @@ export interface AssociateMacSecKeyRequest { } export namespace AssociateMacSecKeyRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: AssociateMacSecKeyRequest): any => ({ ...obj, }); @@ -1197,6 +1275,9 @@ export interface AssociateMacSecKeyResponse { } export namespace AssociateMacSecKeyResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: AssociateMacSecKeyResponse): any => ({ ...obj, }); @@ -1215,6 +1296,9 @@ export interface AssociateVirtualInterfaceRequest { } export namespace AssociateVirtualInterfaceRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: AssociateVirtualInterfaceRequest): any => ({ ...obj, }); @@ -1228,6 +1312,9 @@ export interface ConfirmConnectionRequest { } export namespace ConfirmConnectionRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ConfirmConnectionRequest): any => ({ ...obj, }); @@ -1279,6 +1366,9 @@ export interface ConfirmConnectionResponse { } export namespace ConfirmConnectionResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ConfirmConnectionResponse): any => ({ ...obj, }); @@ -1302,6 +1392,9 @@ export interface ConfirmPrivateVirtualInterfaceRequest { } export namespace ConfirmPrivateVirtualInterfaceRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ConfirmPrivateVirtualInterfaceRequest): any => ({ ...obj, }); @@ -1353,6 +1446,9 @@ export interface ConfirmPrivateVirtualInterfaceResponse { } export namespace ConfirmPrivateVirtualInterfaceResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ConfirmPrivateVirtualInterfaceResponse): any => ({ ...obj, }); @@ -1366,6 +1462,9 @@ export interface ConfirmPublicVirtualInterfaceRequest { } export namespace ConfirmPublicVirtualInterfaceRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ConfirmPublicVirtualInterfaceRequest): any => ({ ...obj, }); @@ -1417,6 +1516,9 @@ export interface ConfirmPublicVirtualInterfaceResponse { } export namespace ConfirmPublicVirtualInterfaceResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ConfirmPublicVirtualInterfaceResponse): any => ({ ...obj, }); @@ -1435,6 +1537,9 @@ export interface ConfirmTransitVirtualInterfaceRequest { } export namespace ConfirmTransitVirtualInterfaceRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ConfirmTransitVirtualInterfaceRequest): any => ({ ...obj, }); @@ -1486,6 +1591,9 @@ export interface ConfirmTransitVirtualInterfaceResponse { } export namespace ConfirmTransitVirtualInterfaceResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ConfirmTransitVirtualInterfaceResponse): any => ({ ...obj, }); @@ -1499,6 +1607,9 @@ export interface Connections { } export namespace Connections { + /** + * @internal + */ export const filterSensitiveLog = (obj: Connections): any => ({ ...obj, }); @@ -1535,6 +1646,9 @@ export interface NewBGPPeer { } export namespace NewBGPPeer { + /** + * @internal + */ export const filterSensitiveLog = (obj: NewBGPPeer): any => ({ ...obj, }); @@ -1553,6 +1667,9 @@ export interface CreateBGPPeerRequest { } export namespace CreateBGPPeerRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateBGPPeerRequest): any => ({ ...obj, }); @@ -1566,6 +1683,9 @@ export interface CreateBGPPeerResponse { } export namespace CreateBGPPeerResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateBGPPeerResponse): any => ({ ...obj, }); @@ -1610,6 +1730,9 @@ export interface CreateConnectionRequest { } export namespace CreateConnectionRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateConnectionRequest): any => ({ ...obj, }); @@ -1630,6 +1753,9 @@ export interface CreateDirectConnectGatewayRequest { } export namespace CreateDirectConnectGatewayRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateDirectConnectGatewayRequest): any => ({ ...obj, }); @@ -1691,6 +1817,9 @@ export interface DirectConnectGateway { } export namespace DirectConnectGateway { + /** + * @internal + */ export const filterSensitiveLog = (obj: DirectConnectGateway): any => ({ ...obj, }); @@ -1704,6 +1833,9 @@ export interface CreateDirectConnectGatewayResult { } export namespace CreateDirectConnectGatewayResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateDirectConnectGatewayResult): any => ({ ...obj, }); @@ -1734,6 +1866,9 @@ export interface CreateDirectConnectGatewayAssociationRequest { } export namespace CreateDirectConnectGatewayAssociationRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateDirectConnectGatewayAssociationRequest): any => ({ ...obj, }); @@ -1747,6 +1882,9 @@ export interface CreateDirectConnectGatewayAssociationResult { } export namespace CreateDirectConnectGatewayAssociationResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateDirectConnectGatewayAssociationResult): any => ({ ...obj, }); @@ -1780,6 +1918,9 @@ export interface CreateDirectConnectGatewayAssociationProposalRequest { } export namespace CreateDirectConnectGatewayAssociationProposalRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateDirectConnectGatewayAssociationProposalRequest): any => ({ ...obj, }); @@ -1842,6 +1983,9 @@ export interface DirectConnectGatewayAssociationProposal { } export namespace DirectConnectGatewayAssociationProposal { + /** + * @internal + */ export const filterSensitiveLog = (obj: DirectConnectGatewayAssociationProposal): any => ({ ...obj, }); @@ -1855,6 +1999,9 @@ export interface CreateDirectConnectGatewayAssociationProposalResult { } export namespace CreateDirectConnectGatewayAssociationProposalResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateDirectConnectGatewayAssociationProposalResult): any => ({ ...obj, }); @@ -1893,6 +2040,9 @@ export interface CreateInterconnectRequest { } export namespace CreateInterconnectRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateInterconnectRequest): any => ({ ...obj, }); @@ -2009,6 +2159,9 @@ export interface Interconnect { } export namespace Interconnect { + /** + * @internal + */ export const filterSensitiveLog = (obj: Interconnect): any => ({ ...obj, }); @@ -2067,6 +2220,9 @@ export interface CreateLagRequest { } export namespace CreateLagRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateLagRequest): any => ({ ...obj, }); @@ -2215,6 +2371,9 @@ export interface Lag { } export namespace Lag { + /** + * @internal + */ export const filterSensitiveLog = (obj: Lag): any => ({ ...obj, }); @@ -2282,6 +2441,9 @@ export interface NewPrivateVirtualInterface { } export namespace NewPrivateVirtualInterface { + /** + * @internal + */ export const filterSensitiveLog = (obj: NewPrivateVirtualInterface): any => ({ ...obj, }); @@ -2300,6 +2462,9 @@ export interface CreatePrivateVirtualInterfaceRequest { } export namespace CreatePrivateVirtualInterfaceRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreatePrivateVirtualInterfaceRequest): any => ({ ...obj, }); @@ -2357,6 +2522,9 @@ export interface NewPublicVirtualInterface { } export namespace NewPublicVirtualInterface { + /** + * @internal + */ export const filterSensitiveLog = (obj: NewPublicVirtualInterface): any => ({ ...obj, }); @@ -2375,6 +2543,9 @@ export interface CreatePublicVirtualInterfaceRequest { } export namespace CreatePublicVirtualInterfaceRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreatePublicVirtualInterfaceRequest): any => ({ ...obj, }); @@ -2437,6 +2608,9 @@ export interface NewTransitVirtualInterface { } export namespace NewTransitVirtualInterface { + /** + * @internal + */ export const filterSensitiveLog = (obj: NewTransitVirtualInterface): any => ({ ...obj, }); @@ -2455,6 +2629,9 @@ export interface CreateTransitVirtualInterfaceRequest { } export namespace CreateTransitVirtualInterfaceRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateTransitVirtualInterfaceRequest): any => ({ ...obj, }); @@ -2468,6 +2645,9 @@ export interface CreateTransitVirtualInterfaceResult { } export namespace CreateTransitVirtualInterfaceResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateTransitVirtualInterfaceResult): any => ({ ...obj, }); @@ -2496,6 +2676,9 @@ export interface DeleteBGPPeerRequest { } export namespace DeleteBGPPeerRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteBGPPeerRequest): any => ({ ...obj, }); @@ -2509,6 +2692,9 @@ export interface DeleteBGPPeerResponse { } export namespace DeleteBGPPeerResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteBGPPeerResponse): any => ({ ...obj, }); @@ -2522,6 +2708,9 @@ export interface DeleteConnectionRequest { } export namespace DeleteConnectionRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteConnectionRequest): any => ({ ...obj, }); @@ -2535,6 +2724,9 @@ export interface DeleteDirectConnectGatewayRequest { } export namespace DeleteDirectConnectGatewayRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteDirectConnectGatewayRequest): any => ({ ...obj, }); @@ -2548,6 +2740,9 @@ export interface DeleteDirectConnectGatewayResult { } export namespace DeleteDirectConnectGatewayResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteDirectConnectGatewayResult): any => ({ ...obj, }); @@ -2571,6 +2766,9 @@ export interface DeleteDirectConnectGatewayAssociationRequest { } export namespace DeleteDirectConnectGatewayAssociationRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteDirectConnectGatewayAssociationRequest): any => ({ ...obj, }); @@ -2584,6 +2782,9 @@ export interface DeleteDirectConnectGatewayAssociationResult { } export namespace DeleteDirectConnectGatewayAssociationResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteDirectConnectGatewayAssociationResult): any => ({ ...obj, }); @@ -2597,6 +2798,9 @@ export interface DeleteDirectConnectGatewayAssociationProposalRequest { } export namespace DeleteDirectConnectGatewayAssociationProposalRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteDirectConnectGatewayAssociationProposalRequest): any => ({ ...obj, }); @@ -2610,6 +2814,9 @@ export interface DeleteDirectConnectGatewayAssociationProposalResult { } export namespace DeleteDirectConnectGatewayAssociationProposalResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteDirectConnectGatewayAssociationProposalResult): any => ({ ...obj, }); @@ -2623,6 +2830,9 @@ export interface DeleteInterconnectRequest { } export namespace DeleteInterconnectRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteInterconnectRequest): any => ({ ...obj, }); @@ -2667,6 +2877,9 @@ export interface DeleteInterconnectResponse { } export namespace DeleteInterconnectResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteInterconnectResponse): any => ({ ...obj, }); @@ -2680,6 +2893,9 @@ export interface DeleteLagRequest { } export namespace DeleteLagRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteLagRequest): any => ({ ...obj, }); @@ -2693,6 +2909,9 @@ export interface DeleteVirtualInterfaceRequest { } export namespace DeleteVirtualInterfaceRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteVirtualInterfaceRequest): any => ({ ...obj, }); @@ -2744,6 +2963,9 @@ export interface DeleteVirtualInterfaceResponse { } export namespace DeleteVirtualInterfaceResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteVirtualInterfaceResponse): any => ({ ...obj, }); @@ -2772,6 +2994,9 @@ export interface DescribeConnectionLoaRequest { } export namespace DescribeConnectionLoaRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeConnectionLoaRequest): any => ({ ...obj, }); @@ -2793,6 +3018,9 @@ export interface Loa { } export namespace Loa { + /** + * @internal + */ export const filterSensitiveLog = (obj: Loa): any => ({ ...obj, }); @@ -2806,6 +3034,9 @@ export interface DescribeConnectionLoaResponse { } export namespace DescribeConnectionLoaResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeConnectionLoaResponse): any => ({ ...obj, }); @@ -2819,6 +3050,9 @@ export interface DescribeConnectionsRequest { } export namespace DescribeConnectionsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeConnectionsRequest): any => ({ ...obj, }); @@ -2832,6 +3066,9 @@ export interface DescribeConnectionsOnInterconnectRequest { } export namespace DescribeConnectionsOnInterconnectRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeConnectionsOnInterconnectRequest): any => ({ ...obj, }); @@ -2868,6 +3105,9 @@ export interface DescribeDirectConnectGatewayAssociationProposalsRequest { } export namespace DescribeDirectConnectGatewayAssociationProposalsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeDirectConnectGatewayAssociationProposalsRequest): any => ({ ...obj, }); @@ -2886,6 +3126,9 @@ export interface DescribeDirectConnectGatewayAssociationProposalsResult { } export namespace DescribeDirectConnectGatewayAssociationProposalsResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeDirectConnectGatewayAssociationProposalsResult): any => ({ ...obj, }); @@ -2927,6 +3170,9 @@ export interface DescribeDirectConnectGatewayAssociationsRequest { } export namespace DescribeDirectConnectGatewayAssociationsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeDirectConnectGatewayAssociationsRequest): any => ({ ...obj, }); @@ -2945,6 +3191,9 @@ export interface DescribeDirectConnectGatewayAssociationsResult { } export namespace DescribeDirectConnectGatewayAssociationsResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeDirectConnectGatewayAssociationsResult): any => ({ ...obj, }); @@ -2976,6 +3225,9 @@ export interface DescribeDirectConnectGatewayAttachmentsRequest { } export namespace DescribeDirectConnectGatewayAttachmentsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeDirectConnectGatewayAttachmentsRequest): any => ({ ...obj, }); @@ -3044,6 +3296,9 @@ export interface DirectConnectGatewayAttachment { } export namespace DirectConnectGatewayAttachment { + /** + * @internal + */ export const filterSensitiveLog = (obj: DirectConnectGatewayAttachment): any => ({ ...obj, }); @@ -3062,6 +3317,9 @@ export interface DescribeDirectConnectGatewayAttachmentsResult { } export namespace DescribeDirectConnectGatewayAttachmentsResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeDirectConnectGatewayAttachmentsResult): any => ({ ...obj, }); @@ -3088,6 +3346,9 @@ export interface DescribeDirectConnectGatewaysRequest { } export namespace DescribeDirectConnectGatewaysRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeDirectConnectGatewaysRequest): any => ({ ...obj, }); @@ -3106,6 +3367,9 @@ export interface DescribeDirectConnectGatewaysResult { } export namespace DescribeDirectConnectGatewaysResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeDirectConnectGatewaysResult): any => ({ ...obj, }); @@ -3119,6 +3383,9 @@ export interface DescribeHostedConnectionsRequest { } export namespace DescribeHostedConnectionsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeHostedConnectionsRequest): any => ({ ...obj, }); @@ -3142,6 +3409,9 @@ export interface DescribeInterconnectLoaRequest { } export namespace DescribeInterconnectLoaRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeInterconnectLoaRequest): any => ({ ...obj, }); @@ -3155,6 +3425,9 @@ export interface DescribeInterconnectLoaResponse { } export namespace DescribeInterconnectLoaResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeInterconnectLoaResponse): any => ({ ...obj, }); @@ -3168,6 +3441,9 @@ export interface DescribeInterconnectsRequest { } export namespace DescribeInterconnectsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeInterconnectsRequest): any => ({ ...obj, }); @@ -3181,6 +3457,9 @@ export interface Interconnects { } export namespace Interconnects { + /** + * @internal + */ export const filterSensitiveLog = (obj: Interconnects): any => ({ ...obj, }); @@ -3194,6 +3473,9 @@ export interface DescribeLagsRequest { } export namespace DescribeLagsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeLagsRequest): any => ({ ...obj, }); @@ -3207,6 +3489,9 @@ export interface Lags { } export namespace Lags { + /** + * @internal + */ export const filterSensitiveLog = (obj: Lags): any => ({ ...obj, }); @@ -3231,6 +3516,9 @@ export interface DescribeLoaRequest { } export namespace DescribeLoaRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeLoaRequest): any => ({ ...obj, }); @@ -3272,6 +3560,9 @@ export interface Location { } export namespace Location { + /** + * @internal + */ export const filterSensitiveLog = (obj: Location): any => ({ ...obj, }); @@ -3285,6 +3576,9 @@ export interface Locations { } export namespace Locations { + /** + * @internal + */ export const filterSensitiveLog = (obj: Locations): any => ({ ...obj, }); @@ -3298,6 +3592,9 @@ export interface DescribeTagsRequest { } export namespace DescribeTagsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeTagsRequest): any => ({ ...obj, }); @@ -3319,6 +3616,9 @@ export interface ResourceTag { } export namespace ResourceTag { + /** + * @internal + */ export const filterSensitiveLog = (obj: ResourceTag): any => ({ ...obj, }); @@ -3332,6 +3632,9 @@ export interface DescribeTagsResponse { } export namespace DescribeTagsResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeTagsResponse): any => ({ ...obj, }); @@ -3371,6 +3674,9 @@ export interface VirtualGateway { } export namespace VirtualGateway { + /** + * @internal + */ export const filterSensitiveLog = (obj: VirtualGateway): any => ({ ...obj, }); @@ -3384,6 +3690,9 @@ export interface VirtualGateways { } export namespace VirtualGateways { + /** + * @internal + */ export const filterSensitiveLog = (obj: VirtualGateways): any => ({ ...obj, }); @@ -3402,6 +3711,9 @@ export interface DescribeVirtualInterfacesRequest { } export namespace DescribeVirtualInterfacesRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeVirtualInterfacesRequest): any => ({ ...obj, }); @@ -3415,6 +3727,9 @@ export interface VirtualInterfaces { } export namespace VirtualInterfaces { + /** + * @internal + */ export const filterSensitiveLog = (obj: VirtualInterfaces): any => ({ ...obj, }); @@ -3433,6 +3748,9 @@ export interface DisassociateConnectionFromLagRequest { } export namespace DisassociateConnectionFromLagRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DisassociateConnectionFromLagRequest): any => ({ ...obj, }); @@ -3453,6 +3771,9 @@ export interface DisassociateMacSecKeyRequest { } export namespace DisassociateMacSecKeyRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DisassociateMacSecKeyRequest): any => ({ ...obj, }); @@ -3471,6 +3792,9 @@ export interface DisassociateMacSecKeyResponse { } export namespace DisassociateMacSecKeyResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DisassociateMacSecKeyResponse): any => ({ ...obj, }); @@ -3512,6 +3836,9 @@ export interface ListVirtualInterfaceTestHistoryRequest { } export namespace ListVirtualInterfaceTestHistoryRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListVirtualInterfaceTestHistoryRequest): any => ({ ...obj, }); @@ -3563,6 +3890,9 @@ export interface VirtualInterfaceTestHistory { } export namespace VirtualInterfaceTestHistory { + /** + * @internal + */ export const filterSensitiveLog = (obj: VirtualInterfaceTestHistory): any => ({ ...obj, }); @@ -3581,6 +3911,9 @@ export interface ListVirtualInterfaceTestHistoryResponse { } export namespace ListVirtualInterfaceTestHistoryResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListVirtualInterfaceTestHistoryResponse): any => ({ ...obj, }); @@ -3606,6 +3939,9 @@ export interface StartBgpFailoverTestRequest { } export namespace StartBgpFailoverTestRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: StartBgpFailoverTestRequest): any => ({ ...obj, }); @@ -3619,6 +3955,9 @@ export interface StartBgpFailoverTestResponse { } export namespace StartBgpFailoverTestResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: StartBgpFailoverTestResponse): any => ({ ...obj, }); @@ -3632,6 +3971,9 @@ export interface StopBgpFailoverTestRequest { } export namespace StopBgpFailoverTestRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: StopBgpFailoverTestRequest): any => ({ ...obj, }); @@ -3645,6 +3987,9 @@ export interface StopBgpFailoverTestResponse { } export namespace StopBgpFailoverTestResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: StopBgpFailoverTestResponse): any => ({ ...obj, }); @@ -3663,6 +4008,9 @@ export interface TagResourceRequest { } export namespace TagResourceRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: TagResourceRequest): any => ({ ...obj, }); @@ -3671,6 +4019,9 @@ export namespace TagResourceRequest { export interface TagResourceResponse {} export namespace TagResourceResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: TagResourceResponse): any => ({ ...obj, }); @@ -3689,6 +4040,9 @@ export interface UntagResourceRequest { } export namespace UntagResourceRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: UntagResourceRequest): any => ({ ...obj, }); @@ -3697,6 +4051,9 @@ export namespace UntagResourceRequest { export interface UntagResourceResponse {} export namespace UntagResourceResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: UntagResourceResponse): any => ({ ...obj, }); @@ -3722,6 +4079,9 @@ export interface UpdateConnectionRequest { } export namespace UpdateConnectionRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateConnectionRequest): any => ({ ...obj, }); @@ -3745,6 +4105,9 @@ export interface UpdateDirectConnectGatewayAssociationRequest { } export namespace UpdateDirectConnectGatewayAssociationRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateDirectConnectGatewayAssociationRequest): any => ({ ...obj, }); @@ -3758,6 +4121,9 @@ export interface UpdateDirectConnectGatewayAssociationResult { } export namespace UpdateDirectConnectGatewayAssociationResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateDirectConnectGatewayAssociationResult): any => ({ ...obj, }); @@ -3787,6 +4153,9 @@ export interface UpdateLagRequest { } export namespace UpdateLagRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateLagRequest): any => ({ ...obj, }); @@ -3805,6 +4174,9 @@ export interface UpdateVirtualInterfaceAttributesRequest { } export namespace UpdateVirtualInterfaceAttributesRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateVirtualInterfaceAttributesRequest): any => ({ ...obj, }); diff --git a/clients/client-directory-service/commands/AcceptSharedDirectoryCommand.ts b/clients/client-directory-service/commands/AcceptSharedDirectoryCommand.ts index 9642f39a8254..a86625167f4d 100644 --- a/clients/client-directory-service/commands/AcceptSharedDirectoryCommand.ts +++ b/clients/client-directory-service/commands/AcceptSharedDirectoryCommand.ts @@ -22,6 +22,20 @@ export interface AcceptSharedDirectoryCommandOutput extends AcceptSharedDirector /** *

Accepts a directory sharing request that was sent from the directory owner account.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { DirectoryServiceClient, AcceptSharedDirectoryCommand } from "@aws-sdk/client-directory-service"; // ES Modules import + * // const { DirectoryServiceClient, AcceptSharedDirectoryCommand } = require("@aws-sdk/client-directory-service"); // CommonJS import + * const client = new DirectoryServiceClient(config); + * const command = new AcceptSharedDirectoryCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link AcceptSharedDirectoryCommandInput} for command's `input` shape. + * @see {@link AcceptSharedDirectoryCommandOutput} for command's `response` shape. + * @see {@link DirectoryServiceClientResolvedConfig | config} for command's `input` shape. + * */ export class AcceptSharedDirectoryCommand extends $Command< AcceptSharedDirectoryCommandInput, diff --git a/clients/client-directory-service/commands/AddIpRoutesCommand.ts b/clients/client-directory-service/commands/AddIpRoutesCommand.ts index 4abe5d7d1087..4b57d21ac84e 100644 --- a/clients/client-directory-service/commands/AddIpRoutesCommand.ts +++ b/clients/client-directory-service/commands/AddIpRoutesCommand.ts @@ -23,6 +23,20 @@ export interface AddIpRoutesCommandOutput extends AddIpRoutesResult, __MetadataB /** *

If the DNS server for your on-premises 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 AWS 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 AWS Directory Service API Permissions: Actions, Resources, and Conditions Reference.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { DirectoryServiceClient, AddIpRoutesCommand } from "@aws-sdk/client-directory-service"; // ES Modules import + * // const { DirectoryServiceClient, AddIpRoutesCommand } = require("@aws-sdk/client-directory-service"); // CommonJS import + * const client = new DirectoryServiceClient(config); + * const command = new AddIpRoutesCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link AddIpRoutesCommandInput} for command's `input` shape. + * @see {@link AddIpRoutesCommandOutput} for command's `response` shape. + * @see {@link DirectoryServiceClientResolvedConfig | config} for command's `input` shape. + * */ export class AddIpRoutesCommand extends $Command< AddIpRoutesCommandInput, diff --git a/clients/client-directory-service/commands/AddRegionCommand.ts b/clients/client-directory-service/commands/AddRegionCommand.ts index 5433fb04661e..20295fbfca30 100644 --- a/clients/client-directory-service/commands/AddRegionCommand.ts +++ b/clients/client-directory-service/commands/AddRegionCommand.ts @@ -19,6 +19,20 @@ export interface AddRegionCommandOutput extends AddRegionResult, __MetadataBeare /** *

Adds two domain controllers in the specified Region for the specified directory.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { DirectoryServiceClient, AddRegionCommand } from "@aws-sdk/client-directory-service"; // ES Modules import + * // const { DirectoryServiceClient, AddRegionCommand } = require("@aws-sdk/client-directory-service"); // CommonJS import + * const client = new DirectoryServiceClient(config); + * const command = new AddRegionCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link AddRegionCommandInput} for command's `input` shape. + * @see {@link AddRegionCommandOutput} for command's `response` shape. + * @see {@link DirectoryServiceClientResolvedConfig | config} for command's `input` shape. + * */ export class AddRegionCommand extends $Command< AddRegionCommandInput, diff --git a/clients/client-directory-service/commands/AddTagsToResourceCommand.ts b/clients/client-directory-service/commands/AddTagsToResourceCommand.ts index 708620ae0344..874d34db87f8 100644 --- a/clients/client-directory-service/commands/AddTagsToResourceCommand.ts +++ b/clients/client-directory-service/commands/AddTagsToResourceCommand.ts @@ -22,6 +22,20 @@ export interface AddTagsToResourceCommandOutput extends AddTagsToResourceResult, /** *

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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { DirectoryServiceClient, AddTagsToResourceCommand } from "@aws-sdk/client-directory-service"; // ES Modules import + * // const { DirectoryServiceClient, AddTagsToResourceCommand } = require("@aws-sdk/client-directory-service"); // CommonJS import + * const client = new DirectoryServiceClient(config); + * const command = new AddTagsToResourceCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link AddTagsToResourceCommandInput} for command's `input` shape. + * @see {@link AddTagsToResourceCommandOutput} for command's `response` shape. + * @see {@link DirectoryServiceClientResolvedConfig | config} for command's `input` shape. + * */ export class AddTagsToResourceCommand extends $Command< AddTagsToResourceCommandInput, diff --git a/clients/client-directory-service/commands/CancelSchemaExtensionCommand.ts b/clients/client-directory-service/commands/CancelSchemaExtensionCommand.ts index acf8fe007356..f520183bd4f6 100644 --- a/clients/client-directory-service/commands/CancelSchemaExtensionCommand.ts +++ b/clients/client-directory-service/commands/CancelSchemaExtensionCommand.ts @@ -22,6 +22,20 @@ export interface CancelSchemaExtensionCommandOutput extends CancelSchemaExtensio /** *

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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { DirectoryServiceClient, CancelSchemaExtensionCommand } from "@aws-sdk/client-directory-service"; // ES Modules import + * // const { DirectoryServiceClient, CancelSchemaExtensionCommand } = require("@aws-sdk/client-directory-service"); // CommonJS import + * const client = new DirectoryServiceClient(config); + * const command = new CancelSchemaExtensionCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CancelSchemaExtensionCommandInput} for command's `input` shape. + * @see {@link CancelSchemaExtensionCommandOutput} for command's `response` shape. + * @see {@link DirectoryServiceClientResolvedConfig | config} for command's `input` shape. + * */ export class CancelSchemaExtensionCommand extends $Command< CancelSchemaExtensionCommandInput, diff --git a/clients/client-directory-service/commands/ConnectDirectoryCommand.ts b/clients/client-directory-service/commands/ConnectDirectoryCommand.ts index 1aa404e33751..00d91e1db834 100644 --- a/clients/client-directory-service/commands/ConnectDirectoryCommand.ts +++ b/clients/client-directory-service/commands/ConnectDirectoryCommand.ts @@ -26,6 +26,20 @@ export interface ConnectDirectoryCommandOutput extends ConnectDirectoryResult, _ * have been explicitly granted through a policy. For details about what permissions are required * to run the ConnectDirectory operation, see AWS Directory Service API Permissions: Actions, Resources, and Conditions * Reference.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { DirectoryServiceClient, ConnectDirectoryCommand } from "@aws-sdk/client-directory-service"; // ES Modules import + * // const { DirectoryServiceClient, ConnectDirectoryCommand } = require("@aws-sdk/client-directory-service"); // CommonJS import + * const client = new DirectoryServiceClient(config); + * const command = new ConnectDirectoryCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ConnectDirectoryCommandInput} for command's `input` shape. + * @see {@link ConnectDirectoryCommandOutput} for command's `response` shape. + * @see {@link DirectoryServiceClientResolvedConfig | config} for command's `input` shape. + * */ export class ConnectDirectoryCommand extends $Command< ConnectDirectoryCommandInput, diff --git a/clients/client-directory-service/commands/CreateAliasCommand.ts b/clients/client-directory-service/commands/CreateAliasCommand.ts index 936b6374185e..aec79fdbc7a7 100644 --- a/clients/client-directory-service/commands/CreateAliasCommand.ts +++ b/clients/client-directory-service/commands/CreateAliasCommand.ts @@ -27,6 +27,20 @@ export interface CreateAliasCommandOutput extends CreateAliasResult, __MetadataB * *

After an alias has been created, it cannot be deleted or reused, so this operation should only be used when absolutely necessary.

* + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { DirectoryServiceClient, CreateAliasCommand } from "@aws-sdk/client-directory-service"; // ES Modules import + * // const { DirectoryServiceClient, CreateAliasCommand } = require("@aws-sdk/client-directory-service"); // CommonJS import + * const client = new DirectoryServiceClient(config); + * const command = new CreateAliasCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreateAliasCommandInput} for command's `input` shape. + * @see {@link CreateAliasCommandOutput} for command's `response` shape. + * @see {@link DirectoryServiceClientResolvedConfig | config} for command's `input` shape. + * */ export class CreateAliasCommand extends $Command< CreateAliasCommandInput, diff --git a/clients/client-directory-service/commands/CreateComputerCommand.ts b/clients/client-directory-service/commands/CreateComputerCommand.ts index 1d36209d8597..9355f684fe6c 100644 --- a/clients/client-directory-service/commands/CreateComputerCommand.ts +++ b/clients/client-directory-service/commands/CreateComputerCommand.ts @@ -22,6 +22,20 @@ export interface CreateComputerCommandOutput extends CreateComputerResult, __Met /** *

Creates an Active Directory computer object in the specified directory.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { DirectoryServiceClient, CreateComputerCommand } from "@aws-sdk/client-directory-service"; // ES Modules import + * // const { DirectoryServiceClient, CreateComputerCommand } = require("@aws-sdk/client-directory-service"); // CommonJS import + * const client = new DirectoryServiceClient(config); + * const command = new CreateComputerCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreateComputerCommandInput} for command's `input` shape. + * @see {@link CreateComputerCommandOutput} for command's `response` shape. + * @see {@link DirectoryServiceClientResolvedConfig | config} for command's `input` shape. + * */ export class CreateComputerCommand extends $Command< CreateComputerCommandInput, diff --git a/clients/client-directory-service/commands/CreateConditionalForwarderCommand.ts b/clients/client-directory-service/commands/CreateConditionalForwarderCommand.ts index cafb485eb353..d3b3d9b61d83 100644 --- a/clients/client-directory-service/commands/CreateConditionalForwarderCommand.ts +++ b/clients/client-directory-service/commands/CreateConditionalForwarderCommand.ts @@ -22,6 +22,20 @@ export interface CreateConditionalForwarderCommandOutput extends CreateCondition /** *

Creates a conditional forwarder associated with your AWS directory. Conditional forwarders are required in order to set up a trust relationship with another domain. The conditional forwarder points to the trusted domain.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { DirectoryServiceClient, CreateConditionalForwarderCommand } from "@aws-sdk/client-directory-service"; // ES Modules import + * // const { DirectoryServiceClient, CreateConditionalForwarderCommand } = require("@aws-sdk/client-directory-service"); // CommonJS import + * const client = new DirectoryServiceClient(config); + * const command = new CreateConditionalForwarderCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreateConditionalForwarderCommandInput} for command's `input` shape. + * @see {@link CreateConditionalForwarderCommandOutput} for command's `response` shape. + * @see {@link DirectoryServiceClientResolvedConfig | config} for command's `input` shape. + * */ export class CreateConditionalForwarderCommand extends $Command< CreateConditionalForwarderCommandInput, diff --git a/clients/client-directory-service/commands/CreateDirectoryCommand.ts b/clients/client-directory-service/commands/CreateDirectoryCommand.ts index d37afd86a86f..46bd73a4e82e 100644 --- a/clients/client-directory-service/commands/CreateDirectoryCommand.ts +++ b/clients/client-directory-service/commands/CreateDirectoryCommand.ts @@ -27,6 +27,20 @@ export interface CreateDirectoryCommandOutput extends CreateDirectoryResult, __M * have been explicitly granted through a policy. For details about what permissions are required * to run the CreateDirectory operation, see AWS Directory Service API Permissions: Actions, Resources, and Conditions * Reference.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { DirectoryServiceClient, CreateDirectoryCommand } from "@aws-sdk/client-directory-service"; // ES Modules import + * // const { DirectoryServiceClient, CreateDirectoryCommand } = require("@aws-sdk/client-directory-service"); // CommonJS import + * const client = new DirectoryServiceClient(config); + * const command = new CreateDirectoryCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreateDirectoryCommandInput} for command's `input` shape. + * @see {@link CreateDirectoryCommandOutput} for command's `response` shape. + * @see {@link DirectoryServiceClientResolvedConfig | config} for command's `input` shape. + * */ export class CreateDirectoryCommand extends $Command< CreateDirectoryCommandInput, diff --git a/clients/client-directory-service/commands/CreateLogSubscriptionCommand.ts b/clients/client-directory-service/commands/CreateLogSubscriptionCommand.ts index edf7a229123a..8c14e1e22be4 100644 --- a/clients/client-directory-service/commands/CreateLogSubscriptionCommand.ts +++ b/clients/client-directory-service/commands/CreateLogSubscriptionCommand.ts @@ -23,6 +23,20 @@ export interface CreateLogSubscriptionCommandOutput extends CreateLogSubscriptio /** *

Creates a subscription to forward real-time Directory Service domain controller security * logs to the specified Amazon CloudWatch log group in your AWS account.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { DirectoryServiceClient, CreateLogSubscriptionCommand } from "@aws-sdk/client-directory-service"; // ES Modules import + * // const { DirectoryServiceClient, CreateLogSubscriptionCommand } = require("@aws-sdk/client-directory-service"); // CommonJS import + * const client = new DirectoryServiceClient(config); + * const command = new CreateLogSubscriptionCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreateLogSubscriptionCommandInput} for command's `input` shape. + * @see {@link CreateLogSubscriptionCommandOutput} for command's `response` shape. + * @see {@link DirectoryServiceClientResolvedConfig | config} for command's `input` shape. + * */ export class CreateLogSubscriptionCommand extends $Command< CreateLogSubscriptionCommandInput, diff --git a/clients/client-directory-service/commands/CreateMicrosoftADCommand.ts b/clients/client-directory-service/commands/CreateMicrosoftADCommand.ts index 8dfc97c98ae0..78a4a6221819 100644 --- a/clients/client-directory-service/commands/CreateMicrosoftADCommand.ts +++ b/clients/client-directory-service/commands/CreateMicrosoftADCommand.ts @@ -23,6 +23,20 @@ export interface CreateMicrosoftADCommandOutput extends CreateMicrosoftADResult, /** *

Creates a Microsoft AD directory in the AWS Cloud. For more information, see AWS Managed Microsoft AD in the AWS 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 AWS Directory Service API Permissions: Actions, Resources, and Conditions Reference.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { DirectoryServiceClient, CreateMicrosoftADCommand } from "@aws-sdk/client-directory-service"; // ES Modules import + * // const { DirectoryServiceClient, CreateMicrosoftADCommand } = require("@aws-sdk/client-directory-service"); // CommonJS import + * const client = new DirectoryServiceClient(config); + * const command = new CreateMicrosoftADCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreateMicrosoftADCommandInput} for command's `input` shape. + * @see {@link CreateMicrosoftADCommandOutput} for command's `response` shape. + * @see {@link DirectoryServiceClientResolvedConfig | config} for command's `input` shape. + * */ export class CreateMicrosoftADCommand extends $Command< CreateMicrosoftADCommandInput, diff --git a/clients/client-directory-service/commands/CreateSnapshotCommand.ts b/clients/client-directory-service/commands/CreateSnapshotCommand.ts index 16529c44b49a..73ccb42f6a1c 100644 --- a/clients/client-directory-service/commands/CreateSnapshotCommand.ts +++ b/clients/client-directory-service/commands/CreateSnapshotCommand.ts @@ -25,6 +25,20 @@ export interface CreateSnapshotCommandOutput extends CreateSnapshotResult, __Met * *

You cannot take snapshots of AD Connector directories.

* + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { DirectoryServiceClient, CreateSnapshotCommand } from "@aws-sdk/client-directory-service"; // ES Modules import + * // const { DirectoryServiceClient, CreateSnapshotCommand } = require("@aws-sdk/client-directory-service"); // CommonJS import + * const client = new DirectoryServiceClient(config); + * const command = new CreateSnapshotCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreateSnapshotCommandInput} for command's `input` shape. + * @see {@link CreateSnapshotCommandOutput} for command's `response` shape. + * @see {@link DirectoryServiceClientResolvedConfig | config} for command's `input` shape. + * */ export class CreateSnapshotCommand extends $Command< CreateSnapshotCommandInput, diff --git a/clients/client-directory-service/commands/CreateTrustCommand.ts b/clients/client-directory-service/commands/CreateTrustCommand.ts index f6e5e0667058..82e83975caf4 100644 --- a/clients/client-directory-service/commands/CreateTrustCommand.ts +++ b/clients/client-directory-service/commands/CreateTrustCommand.ts @@ -23,6 +23,20 @@ export interface CreateTrustCommandOutput extends CreateTrustResult, __MetadataB /** *

AWS Directory Service for Microsoft Active Directory allows you to configure trust relationships. For example, you can establish a trust between your AWS Managed Microsoft AD directory, and your existing on-premises 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 AWS side of a trust relationship between an AWS Managed Microsoft AD directory and an external domain. You can create either a forest trust or an external trust.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { DirectoryServiceClient, CreateTrustCommand } from "@aws-sdk/client-directory-service"; // ES Modules import + * // const { DirectoryServiceClient, CreateTrustCommand } = require("@aws-sdk/client-directory-service"); // CommonJS import + * const client = new DirectoryServiceClient(config); + * const command = new CreateTrustCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreateTrustCommandInput} for command's `input` shape. + * @see {@link CreateTrustCommandOutput} for command's `response` shape. + * @see {@link DirectoryServiceClientResolvedConfig | config} for command's `input` shape. + * */ export class CreateTrustCommand extends $Command< CreateTrustCommandInput, diff --git a/clients/client-directory-service/commands/DeleteConditionalForwarderCommand.ts b/clients/client-directory-service/commands/DeleteConditionalForwarderCommand.ts index 6d81e6520ae0..300ffadf60da 100644 --- a/clients/client-directory-service/commands/DeleteConditionalForwarderCommand.ts +++ b/clients/client-directory-service/commands/DeleteConditionalForwarderCommand.ts @@ -22,6 +22,20 @@ export interface DeleteConditionalForwarderCommandOutput extends DeleteCondition /** *

Deletes a conditional forwarder that has been set up for your AWS directory.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { DirectoryServiceClient, DeleteConditionalForwarderCommand } from "@aws-sdk/client-directory-service"; // ES Modules import + * // const { DirectoryServiceClient, DeleteConditionalForwarderCommand } = require("@aws-sdk/client-directory-service"); // CommonJS import + * const client = new DirectoryServiceClient(config); + * const command = new DeleteConditionalForwarderCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteConditionalForwarderCommandInput} for command's `input` shape. + * @see {@link DeleteConditionalForwarderCommandOutput} for command's `response` shape. + * @see {@link DirectoryServiceClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteConditionalForwarderCommand extends $Command< DeleteConditionalForwarderCommandInput, diff --git a/clients/client-directory-service/commands/DeleteDirectoryCommand.ts b/clients/client-directory-service/commands/DeleteDirectoryCommand.ts index 6149658e6bc3..0de1ffcb827f 100644 --- a/clients/client-directory-service/commands/DeleteDirectoryCommand.ts +++ b/clients/client-directory-service/commands/DeleteDirectoryCommand.ts @@ -26,6 +26,20 @@ export interface DeleteDirectoryCommandOutput extends DeleteDirectoryResult, __M * have been explicitly granted through a policy. For details about what permissions are required * to run the DeleteDirectory operation, see AWS Directory Service API Permissions: Actions, Resources, and Conditions * Reference.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { DirectoryServiceClient, DeleteDirectoryCommand } from "@aws-sdk/client-directory-service"; // ES Modules import + * // const { DirectoryServiceClient, DeleteDirectoryCommand } = require("@aws-sdk/client-directory-service"); // CommonJS import + * const client = new DirectoryServiceClient(config); + * const command = new DeleteDirectoryCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteDirectoryCommandInput} for command's `input` shape. + * @see {@link DeleteDirectoryCommandOutput} for command's `response` shape. + * @see {@link DirectoryServiceClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteDirectoryCommand extends $Command< DeleteDirectoryCommandInput, diff --git a/clients/client-directory-service/commands/DeleteLogSubscriptionCommand.ts b/clients/client-directory-service/commands/DeleteLogSubscriptionCommand.ts index b8f7d71cfed0..5dde818119aa 100644 --- a/clients/client-directory-service/commands/DeleteLogSubscriptionCommand.ts +++ b/clients/client-directory-service/commands/DeleteLogSubscriptionCommand.ts @@ -22,6 +22,20 @@ export interface DeleteLogSubscriptionCommandOutput extends DeleteLogSubscriptio /** *

Deletes the specified log subscription.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { DirectoryServiceClient, DeleteLogSubscriptionCommand } from "@aws-sdk/client-directory-service"; // ES Modules import + * // const { DirectoryServiceClient, DeleteLogSubscriptionCommand } = require("@aws-sdk/client-directory-service"); // CommonJS import + * const client = new DirectoryServiceClient(config); + * const command = new DeleteLogSubscriptionCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteLogSubscriptionCommandInput} for command's `input` shape. + * @see {@link DeleteLogSubscriptionCommandOutput} for command's `response` shape. + * @see {@link DirectoryServiceClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteLogSubscriptionCommand extends $Command< DeleteLogSubscriptionCommandInput, diff --git a/clients/client-directory-service/commands/DeleteSnapshotCommand.ts b/clients/client-directory-service/commands/DeleteSnapshotCommand.ts index e18517a75b28..d703fdba7a73 100644 --- a/clients/client-directory-service/commands/DeleteSnapshotCommand.ts +++ b/clients/client-directory-service/commands/DeleteSnapshotCommand.ts @@ -22,6 +22,20 @@ export interface DeleteSnapshotCommandOutput extends DeleteSnapshotResult, __Met /** *

Deletes a directory snapshot.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { DirectoryServiceClient, DeleteSnapshotCommand } from "@aws-sdk/client-directory-service"; // ES Modules import + * // const { DirectoryServiceClient, DeleteSnapshotCommand } = require("@aws-sdk/client-directory-service"); // CommonJS import + * const client = new DirectoryServiceClient(config); + * const command = new DeleteSnapshotCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteSnapshotCommandInput} for command's `input` shape. + * @see {@link DeleteSnapshotCommandOutput} for command's `response` shape. + * @see {@link DirectoryServiceClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteSnapshotCommand extends $Command< DeleteSnapshotCommandInput, diff --git a/clients/client-directory-service/commands/DeleteTrustCommand.ts b/clients/client-directory-service/commands/DeleteTrustCommand.ts index 5b56e77937c1..a02bde439390 100644 --- a/clients/client-directory-service/commands/DeleteTrustCommand.ts +++ b/clients/client-directory-service/commands/DeleteTrustCommand.ts @@ -22,6 +22,20 @@ export interface DeleteTrustCommandOutput extends DeleteTrustResult, __MetadataB /** *

Deletes an existing trust relationship between your AWS Managed Microsoft AD directory and an external domain.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { DirectoryServiceClient, DeleteTrustCommand } from "@aws-sdk/client-directory-service"; // ES Modules import + * // const { DirectoryServiceClient, DeleteTrustCommand } = require("@aws-sdk/client-directory-service"); // CommonJS import + * const client = new DirectoryServiceClient(config); + * const command = new DeleteTrustCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteTrustCommandInput} for command's `input` shape. + * @see {@link DeleteTrustCommandOutput} for command's `response` shape. + * @see {@link DirectoryServiceClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteTrustCommand extends $Command< DeleteTrustCommandInput, diff --git a/clients/client-directory-service/commands/DeregisterCertificateCommand.ts b/clients/client-directory-service/commands/DeregisterCertificateCommand.ts index 8d0b0d498b59..d271ffd2740e 100644 --- a/clients/client-directory-service/commands/DeregisterCertificateCommand.ts +++ b/clients/client-directory-service/commands/DeregisterCertificateCommand.ts @@ -22,6 +22,20 @@ export interface DeregisterCertificateCommandOutput extends DeregisterCertificat /** *

Deletes from the system the certificate that was registered for secure LDAP or client certificate authentication.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { DirectoryServiceClient, DeregisterCertificateCommand } from "@aws-sdk/client-directory-service"; // ES Modules import + * // const { DirectoryServiceClient, DeregisterCertificateCommand } = require("@aws-sdk/client-directory-service"); // CommonJS import + * const client = new DirectoryServiceClient(config); + * const command = new DeregisterCertificateCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeregisterCertificateCommandInput} for command's `input` shape. + * @see {@link DeregisterCertificateCommandOutput} for command's `response` shape. + * @see {@link DirectoryServiceClientResolvedConfig | config} for command's `input` shape. + * */ export class DeregisterCertificateCommand extends $Command< DeregisterCertificateCommandInput, diff --git a/clients/client-directory-service/commands/DeregisterEventTopicCommand.ts b/clients/client-directory-service/commands/DeregisterEventTopicCommand.ts index ed20b07f5424..2ebe363e10ce 100644 --- a/clients/client-directory-service/commands/DeregisterEventTopicCommand.ts +++ b/clients/client-directory-service/commands/DeregisterEventTopicCommand.ts @@ -22,6 +22,20 @@ export interface DeregisterEventTopicCommandOutput extends DeregisterEventTopicR /** *

Removes the specified directory as a publisher to the specified SNS topic.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { DirectoryServiceClient, DeregisterEventTopicCommand } from "@aws-sdk/client-directory-service"; // ES Modules import + * // const { DirectoryServiceClient, DeregisterEventTopicCommand } = require("@aws-sdk/client-directory-service"); // CommonJS import + * const client = new DirectoryServiceClient(config); + * const command = new DeregisterEventTopicCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeregisterEventTopicCommandInput} for command's `input` shape. + * @see {@link DeregisterEventTopicCommandOutput} for command's `response` shape. + * @see {@link DirectoryServiceClientResolvedConfig | config} for command's `input` shape. + * */ export class DeregisterEventTopicCommand extends $Command< DeregisterEventTopicCommandInput, diff --git a/clients/client-directory-service/commands/DescribeCertificateCommand.ts b/clients/client-directory-service/commands/DescribeCertificateCommand.ts index 8ae339f06b7f..b687d612082c 100644 --- a/clients/client-directory-service/commands/DescribeCertificateCommand.ts +++ b/clients/client-directory-service/commands/DescribeCertificateCommand.ts @@ -22,6 +22,20 @@ export interface DescribeCertificateCommandOutput extends DescribeCertificateRes /** *

Displays information about the certificate registered for secure LDAP or client certificate authentication.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { DirectoryServiceClient, DescribeCertificateCommand } from "@aws-sdk/client-directory-service"; // ES Modules import + * // const { DirectoryServiceClient, DescribeCertificateCommand } = require("@aws-sdk/client-directory-service"); // CommonJS import + * const client = new DirectoryServiceClient(config); + * const command = new DescribeCertificateCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeCertificateCommandInput} for command's `input` shape. + * @see {@link DescribeCertificateCommandOutput} for command's `response` shape. + * @see {@link DirectoryServiceClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeCertificateCommand extends $Command< DescribeCertificateCommandInput, diff --git a/clients/client-directory-service/commands/DescribeConditionalForwardersCommand.ts b/clients/client-directory-service/commands/DescribeConditionalForwardersCommand.ts index e0c526df5fa1..a257eaf45ea7 100644 --- a/clients/client-directory-service/commands/DescribeConditionalForwardersCommand.ts +++ b/clients/client-directory-service/commands/DescribeConditionalForwardersCommand.ts @@ -25,6 +25,20 @@ export interface DescribeConditionalForwardersCommandOutput /** *

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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { DirectoryServiceClient, DescribeConditionalForwardersCommand } from "@aws-sdk/client-directory-service"; // ES Modules import + * // const { DirectoryServiceClient, DescribeConditionalForwardersCommand } = require("@aws-sdk/client-directory-service"); // CommonJS import + * const client = new DirectoryServiceClient(config); + * const command = new DescribeConditionalForwardersCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeConditionalForwardersCommandInput} for command's `input` shape. + * @see {@link DescribeConditionalForwardersCommandOutput} for command's `response` shape. + * @see {@link DirectoryServiceClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeConditionalForwardersCommand extends $Command< DescribeConditionalForwardersCommandInput, diff --git a/clients/client-directory-service/commands/DescribeDirectoriesCommand.ts b/clients/client-directory-service/commands/DescribeDirectoriesCommand.ts index 69ca30d7aa99..7b5406021fce 100644 --- a/clients/client-directory-service/commands/DescribeDirectoriesCommand.ts +++ b/clients/client-directory-service/commands/DescribeDirectoriesCommand.ts @@ -32,6 +32,20 @@ export interface DescribeDirectoriesCommandOutput extends DescribeDirectoriesRes * items.

*

You can also specify a maximum number of return results with the Limit * parameter.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { DirectoryServiceClient, DescribeDirectoriesCommand } from "@aws-sdk/client-directory-service"; // ES Modules import + * // const { DirectoryServiceClient, DescribeDirectoriesCommand } = require("@aws-sdk/client-directory-service"); // CommonJS import + * const client = new DirectoryServiceClient(config); + * const command = new DescribeDirectoriesCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeDirectoriesCommandInput} for command's `input` shape. + * @see {@link DescribeDirectoriesCommandOutput} for command's `response` shape. + * @see {@link DirectoryServiceClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeDirectoriesCommand extends $Command< DescribeDirectoriesCommandInput, diff --git a/clients/client-directory-service/commands/DescribeDomainControllersCommand.ts b/clients/client-directory-service/commands/DescribeDomainControllersCommand.ts index a1c64b155848..e2ca7e8ef637 100644 --- a/clients/client-directory-service/commands/DescribeDomainControllersCommand.ts +++ b/clients/client-directory-service/commands/DescribeDomainControllersCommand.ts @@ -22,6 +22,20 @@ export interface DescribeDomainControllersCommandOutput extends DescribeDomainCo /** *

Provides information about any domain controllers in your directory.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { DirectoryServiceClient, DescribeDomainControllersCommand } from "@aws-sdk/client-directory-service"; // ES Modules import + * // const { DirectoryServiceClient, DescribeDomainControllersCommand } = require("@aws-sdk/client-directory-service"); // CommonJS import + * const client = new DirectoryServiceClient(config); + * const command = new DescribeDomainControllersCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeDomainControllersCommandInput} for command's `input` shape. + * @see {@link DescribeDomainControllersCommandOutput} for command's `response` shape. + * @see {@link DirectoryServiceClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeDomainControllersCommand extends $Command< DescribeDomainControllersCommandInput, diff --git a/clients/client-directory-service/commands/DescribeEventTopicsCommand.ts b/clients/client-directory-service/commands/DescribeEventTopicsCommand.ts index 507b201e8ccf..e7ed8d396232 100644 --- a/clients/client-directory-service/commands/DescribeEventTopicsCommand.ts +++ b/clients/client-directory-service/commands/DescribeEventTopicsCommand.ts @@ -23,6 +23,20 @@ export interface DescribeEventTopicsCommandOutput extends DescribeEventTopicsRes /** *

Obtains information about which 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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { DirectoryServiceClient, DescribeEventTopicsCommand } from "@aws-sdk/client-directory-service"; // ES Modules import + * // const { DirectoryServiceClient, DescribeEventTopicsCommand } = require("@aws-sdk/client-directory-service"); // CommonJS import + * const client = new DirectoryServiceClient(config); + * const command = new DescribeEventTopicsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeEventTopicsCommandInput} for command's `input` shape. + * @see {@link DescribeEventTopicsCommandOutput} for command's `response` shape. + * @see {@link DirectoryServiceClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeEventTopicsCommand extends $Command< DescribeEventTopicsCommandInput, diff --git a/clients/client-directory-service/commands/DescribeLDAPSSettingsCommand.ts b/clients/client-directory-service/commands/DescribeLDAPSSettingsCommand.ts index a2eae875f160..bd6d68e52413 100644 --- a/clients/client-directory-service/commands/DescribeLDAPSSettingsCommand.ts +++ b/clients/client-directory-service/commands/DescribeLDAPSSettingsCommand.ts @@ -22,6 +22,20 @@ export interface DescribeLDAPSSettingsCommandOutput extends DescribeLDAPSSetting /** *

Describes the status of LDAP security for the specified directory.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { DirectoryServiceClient, DescribeLDAPSSettingsCommand } from "@aws-sdk/client-directory-service"; // ES Modules import + * // const { DirectoryServiceClient, DescribeLDAPSSettingsCommand } = require("@aws-sdk/client-directory-service"); // CommonJS import + * const client = new DirectoryServiceClient(config); + * const command = new DescribeLDAPSSettingsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeLDAPSSettingsCommandInput} for command's `input` shape. + * @see {@link DescribeLDAPSSettingsCommandOutput} for command's `response` shape. + * @see {@link DirectoryServiceClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeLDAPSSettingsCommand extends $Command< DescribeLDAPSSettingsCommandInput, diff --git a/clients/client-directory-service/commands/DescribeRegionsCommand.ts b/clients/client-directory-service/commands/DescribeRegionsCommand.ts index 79871554af0e..b0d238597070 100644 --- a/clients/client-directory-service/commands/DescribeRegionsCommand.ts +++ b/clients/client-directory-service/commands/DescribeRegionsCommand.ts @@ -23,6 +23,20 @@ export interface DescribeRegionsCommandOutput extends DescribeRegionsResult, __M /** *

Provides information about the Regions that are configured for multi-Region * replication.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { DirectoryServiceClient, DescribeRegionsCommand } from "@aws-sdk/client-directory-service"; // ES Modules import + * // const { DirectoryServiceClient, DescribeRegionsCommand } = require("@aws-sdk/client-directory-service"); // CommonJS import + * const client = new DirectoryServiceClient(config); + * const command = new DescribeRegionsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeRegionsCommandInput} for command's `input` shape. + * @see {@link DescribeRegionsCommandOutput} for command's `response` shape. + * @see {@link DirectoryServiceClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeRegionsCommand extends $Command< DescribeRegionsCommandInput, diff --git a/clients/client-directory-service/commands/DescribeSharedDirectoriesCommand.ts b/clients/client-directory-service/commands/DescribeSharedDirectoriesCommand.ts index ae8e84865642..1b7a0dfa406a 100644 --- a/clients/client-directory-service/commands/DescribeSharedDirectoriesCommand.ts +++ b/clients/client-directory-service/commands/DescribeSharedDirectoriesCommand.ts @@ -22,6 +22,20 @@ export interface DescribeSharedDirectoriesCommandOutput extends DescribeSharedDi /** *

Returns the shared directories in your account.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { DirectoryServiceClient, DescribeSharedDirectoriesCommand } from "@aws-sdk/client-directory-service"; // ES Modules import + * // const { DirectoryServiceClient, DescribeSharedDirectoriesCommand } = require("@aws-sdk/client-directory-service"); // CommonJS import + * const client = new DirectoryServiceClient(config); + * const command = new DescribeSharedDirectoriesCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeSharedDirectoriesCommandInput} for command's `input` shape. + * @see {@link DescribeSharedDirectoriesCommandOutput} for command's `response` shape. + * @see {@link DirectoryServiceClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeSharedDirectoriesCommand extends $Command< DescribeSharedDirectoriesCommandInput, diff --git a/clients/client-directory-service/commands/DescribeSnapshotsCommand.ts b/clients/client-directory-service/commands/DescribeSnapshotsCommand.ts index 1af33ab43c3b..630b1a3e3b19 100644 --- a/clients/client-directory-service/commands/DescribeSnapshotsCommand.ts +++ b/clients/client-directory-service/commands/DescribeSnapshotsCommand.ts @@ -28,6 +28,20 @@ export interface DescribeSnapshotsCommandOutput extends DescribeSnapshotsResult, * retrieve the next set of items.

*

You can also specify a maximum number of return results with the Limit * parameter.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { DirectoryServiceClient, DescribeSnapshotsCommand } from "@aws-sdk/client-directory-service"; // ES Modules import + * // const { DirectoryServiceClient, DescribeSnapshotsCommand } = require("@aws-sdk/client-directory-service"); // CommonJS import + * const client = new DirectoryServiceClient(config); + * const command = new DescribeSnapshotsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeSnapshotsCommandInput} for command's `input` shape. + * @see {@link DescribeSnapshotsCommandOutput} for command's `response` shape. + * @see {@link DirectoryServiceClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeSnapshotsCommand extends $Command< DescribeSnapshotsCommandInput, diff --git a/clients/client-directory-service/commands/DescribeTrustsCommand.ts b/clients/client-directory-service/commands/DescribeTrustsCommand.ts index effcff0974ce..264088c05b7d 100644 --- a/clients/client-directory-service/commands/DescribeTrustsCommand.ts +++ b/clients/client-directory-service/commands/DescribeTrustsCommand.ts @@ -23,6 +23,20 @@ export interface DescribeTrustsCommandOutput extends DescribeTrustsResult, __Met /** *

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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { DirectoryServiceClient, DescribeTrustsCommand } from "@aws-sdk/client-directory-service"; // ES Modules import + * // const { DirectoryServiceClient, DescribeTrustsCommand } = require("@aws-sdk/client-directory-service"); // CommonJS import + * const client = new DirectoryServiceClient(config); + * const command = new DescribeTrustsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeTrustsCommandInput} for command's `input` shape. + * @see {@link DescribeTrustsCommandOutput} for command's `response` shape. + * @see {@link DirectoryServiceClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeTrustsCommand extends $Command< DescribeTrustsCommandInput, diff --git a/clients/client-directory-service/commands/DisableClientAuthenticationCommand.ts b/clients/client-directory-service/commands/DisableClientAuthenticationCommand.ts index 60b6533dd46e..7e01a1997e87 100644 --- a/clients/client-directory-service/commands/DisableClientAuthenticationCommand.ts +++ b/clients/client-directory-service/commands/DisableClientAuthenticationCommand.ts @@ -22,6 +22,20 @@ export interface DisableClientAuthenticationCommandOutput extends DisableClientA /** *

Disables alternative client authentication methods for the specified directory.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { DirectoryServiceClient, DisableClientAuthenticationCommand } from "@aws-sdk/client-directory-service"; // ES Modules import + * // const { DirectoryServiceClient, DisableClientAuthenticationCommand } = require("@aws-sdk/client-directory-service"); // CommonJS import + * const client = new DirectoryServiceClient(config); + * const command = new DisableClientAuthenticationCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DisableClientAuthenticationCommandInput} for command's `input` shape. + * @see {@link DisableClientAuthenticationCommandOutput} for command's `response` shape. + * @see {@link DirectoryServiceClientResolvedConfig | config} for command's `input` shape. + * */ export class DisableClientAuthenticationCommand extends $Command< DisableClientAuthenticationCommandInput, diff --git a/clients/client-directory-service/commands/DisableLDAPSCommand.ts b/clients/client-directory-service/commands/DisableLDAPSCommand.ts index dbbbe8fdbc61..6b037421fb00 100644 --- a/clients/client-directory-service/commands/DisableLDAPSCommand.ts +++ b/clients/client-directory-service/commands/DisableLDAPSCommand.ts @@ -22,6 +22,20 @@ export interface DisableLDAPSCommandOutput extends DisableLDAPSResult, __Metadat /** *

Deactivates LDAP secure calls for the specified directory.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { DirectoryServiceClient, DisableLDAPSCommand } from "@aws-sdk/client-directory-service"; // ES Modules import + * // const { DirectoryServiceClient, DisableLDAPSCommand } = require("@aws-sdk/client-directory-service"); // CommonJS import + * const client = new DirectoryServiceClient(config); + * const command = new DisableLDAPSCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DisableLDAPSCommandInput} for command's `input` shape. + * @see {@link DisableLDAPSCommandOutput} for command's `response` shape. + * @see {@link DirectoryServiceClientResolvedConfig | config} for command's `input` shape. + * */ export class DisableLDAPSCommand extends $Command< DisableLDAPSCommandInput, diff --git a/clients/client-directory-service/commands/DisableRadiusCommand.ts b/clients/client-directory-service/commands/DisableRadiusCommand.ts index 19da07da4675..daded2f5ae01 100644 --- a/clients/client-directory-service/commands/DisableRadiusCommand.ts +++ b/clients/client-directory-service/commands/DisableRadiusCommand.ts @@ -22,6 +22,20 @@ export interface DisableRadiusCommandOutput extends DisableRadiusResult, __Metad /** *

Disables multi-factor authentication (MFA) with the Remote Authentication Dial In User Service (RADIUS) server for an AD Connector or Microsoft AD directory.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { DirectoryServiceClient, DisableRadiusCommand } from "@aws-sdk/client-directory-service"; // ES Modules import + * // const { DirectoryServiceClient, DisableRadiusCommand } = require("@aws-sdk/client-directory-service"); // CommonJS import + * const client = new DirectoryServiceClient(config); + * const command = new DisableRadiusCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DisableRadiusCommandInput} for command's `input` shape. + * @see {@link DisableRadiusCommandOutput} for command's `response` shape. + * @see {@link DirectoryServiceClientResolvedConfig | config} for command's `input` shape. + * */ export class DisableRadiusCommand extends $Command< DisableRadiusCommandInput, diff --git a/clients/client-directory-service/commands/DisableSsoCommand.ts b/clients/client-directory-service/commands/DisableSsoCommand.ts index 79e7ea21ba5d..c70f9f04e4ea 100644 --- a/clients/client-directory-service/commands/DisableSsoCommand.ts +++ b/clients/client-directory-service/commands/DisableSsoCommand.ts @@ -22,6 +22,20 @@ export interface DisableSsoCommandOutput extends DisableSsoResult, __MetadataBea /** *

Disables single-sign on for a directory.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { DirectoryServiceClient, DisableSsoCommand } from "@aws-sdk/client-directory-service"; // ES Modules import + * // const { DirectoryServiceClient, DisableSsoCommand } = require("@aws-sdk/client-directory-service"); // CommonJS import + * const client = new DirectoryServiceClient(config); + * const command = new DisableSsoCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DisableSsoCommandInput} for command's `input` shape. + * @see {@link DisableSsoCommandOutput} for command's `response` shape. + * @see {@link DirectoryServiceClientResolvedConfig | config} for command's `input` shape. + * */ export class DisableSsoCommand extends $Command< DisableSsoCommandInput, diff --git a/clients/client-directory-service/commands/EnableClientAuthenticationCommand.ts b/clients/client-directory-service/commands/EnableClientAuthenticationCommand.ts index 298d02977354..e57310b09c82 100644 --- a/clients/client-directory-service/commands/EnableClientAuthenticationCommand.ts +++ b/clients/client-directory-service/commands/EnableClientAuthenticationCommand.ts @@ -22,6 +22,20 @@ export interface EnableClientAuthenticationCommandOutput extends EnableClientAut /** *

Enables alternative client authentication methods for the specified directory.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { DirectoryServiceClient, EnableClientAuthenticationCommand } from "@aws-sdk/client-directory-service"; // ES Modules import + * // const { DirectoryServiceClient, EnableClientAuthenticationCommand } = require("@aws-sdk/client-directory-service"); // CommonJS import + * const client = new DirectoryServiceClient(config); + * const command = new EnableClientAuthenticationCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link EnableClientAuthenticationCommandInput} for command's `input` shape. + * @see {@link EnableClientAuthenticationCommandOutput} for command's `response` shape. + * @see {@link DirectoryServiceClientResolvedConfig | config} for command's `input` shape. + * */ export class EnableClientAuthenticationCommand extends $Command< EnableClientAuthenticationCommandInput, diff --git a/clients/client-directory-service/commands/EnableLDAPSCommand.ts b/clients/client-directory-service/commands/EnableLDAPSCommand.ts index 9191d7c83079..071d497d4a77 100644 --- a/clients/client-directory-service/commands/EnableLDAPSCommand.ts +++ b/clients/client-directory-service/commands/EnableLDAPSCommand.ts @@ -22,6 +22,20 @@ export interface EnableLDAPSCommandOutput extends EnableLDAPSResult, __MetadataB /** *

Activates the switch for the specific directory to always use LDAP secure calls.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { DirectoryServiceClient, EnableLDAPSCommand } from "@aws-sdk/client-directory-service"; // ES Modules import + * // const { DirectoryServiceClient, EnableLDAPSCommand } = require("@aws-sdk/client-directory-service"); // CommonJS import + * const client = new DirectoryServiceClient(config); + * const command = new EnableLDAPSCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link EnableLDAPSCommandInput} for command's `input` shape. + * @see {@link EnableLDAPSCommandOutput} for command's `response` shape. + * @see {@link DirectoryServiceClientResolvedConfig | config} for command's `input` shape. + * */ export class EnableLDAPSCommand extends $Command< EnableLDAPSCommandInput, diff --git a/clients/client-directory-service/commands/EnableRadiusCommand.ts b/clients/client-directory-service/commands/EnableRadiusCommand.ts index 5039a2d66391..6fca17af0b65 100644 --- a/clients/client-directory-service/commands/EnableRadiusCommand.ts +++ b/clients/client-directory-service/commands/EnableRadiusCommand.ts @@ -22,6 +22,20 @@ export interface EnableRadiusCommandOutput extends EnableRadiusResult, __Metadat /** *

Enables multi-factor authentication (MFA) with the Remote Authentication Dial In User Service (RADIUS) server for an AD Connector or Microsoft AD directory.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { DirectoryServiceClient, EnableRadiusCommand } from "@aws-sdk/client-directory-service"; // ES Modules import + * // const { DirectoryServiceClient, EnableRadiusCommand } = require("@aws-sdk/client-directory-service"); // CommonJS import + * const client = new DirectoryServiceClient(config); + * const command = new EnableRadiusCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link EnableRadiusCommandInput} for command's `input` shape. + * @see {@link EnableRadiusCommandOutput} for command's `response` shape. + * @see {@link DirectoryServiceClientResolvedConfig | config} for command's `input` shape. + * */ export class EnableRadiusCommand extends $Command< EnableRadiusCommandInput, diff --git a/clients/client-directory-service/commands/EnableSsoCommand.ts b/clients/client-directory-service/commands/EnableSsoCommand.ts index 1ff8198261a7..15947dfc4a02 100644 --- a/clients/client-directory-service/commands/EnableSsoCommand.ts +++ b/clients/client-directory-service/commands/EnableSsoCommand.ts @@ -19,6 +19,20 @@ export interface EnableSsoCommandOutput extends EnableSsoResult, __MetadataBeare /** *

Enables single sign-on for a directory. Single sign-on allows users in your directory to access certain AWS services from a computer joined to the directory without having to enter their credentials separately.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { DirectoryServiceClient, EnableSsoCommand } from "@aws-sdk/client-directory-service"; // ES Modules import + * // const { DirectoryServiceClient, EnableSsoCommand } = require("@aws-sdk/client-directory-service"); // CommonJS import + * const client = new DirectoryServiceClient(config); + * const command = new EnableSsoCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link EnableSsoCommandInput} for command's `input` shape. + * @see {@link EnableSsoCommandOutput} for command's `response` shape. + * @see {@link DirectoryServiceClientResolvedConfig | config} for command's `input` shape. + * */ export class EnableSsoCommand extends $Command< EnableSsoCommandInput, diff --git a/clients/client-directory-service/commands/GetDirectoryLimitsCommand.ts b/clients/client-directory-service/commands/GetDirectoryLimitsCommand.ts index d5a36a77011d..0f19585b766a 100644 --- a/clients/client-directory-service/commands/GetDirectoryLimitsCommand.ts +++ b/clients/client-directory-service/commands/GetDirectoryLimitsCommand.ts @@ -22,6 +22,20 @@ export interface GetDirectoryLimitsCommandOutput extends GetDirectoryLimitsResul /** *

Obtains directory limit information for the current Region.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { DirectoryServiceClient, GetDirectoryLimitsCommand } from "@aws-sdk/client-directory-service"; // ES Modules import + * // const { DirectoryServiceClient, GetDirectoryLimitsCommand } = require("@aws-sdk/client-directory-service"); // CommonJS import + * const client = new DirectoryServiceClient(config); + * const command = new GetDirectoryLimitsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetDirectoryLimitsCommandInput} for command's `input` shape. + * @see {@link GetDirectoryLimitsCommandOutput} for command's `response` shape. + * @see {@link DirectoryServiceClientResolvedConfig | config} for command's `input` shape. + * */ export class GetDirectoryLimitsCommand extends $Command< GetDirectoryLimitsCommandInput, diff --git a/clients/client-directory-service/commands/GetSnapshotLimitsCommand.ts b/clients/client-directory-service/commands/GetSnapshotLimitsCommand.ts index 3ea4333bbf73..56a3aa0e8dd5 100644 --- a/clients/client-directory-service/commands/GetSnapshotLimitsCommand.ts +++ b/clients/client-directory-service/commands/GetSnapshotLimitsCommand.ts @@ -22,6 +22,20 @@ export interface GetSnapshotLimitsCommandOutput extends GetSnapshotLimitsResult, /** *

Obtains the manual snapshot limits for a directory.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { DirectoryServiceClient, GetSnapshotLimitsCommand } from "@aws-sdk/client-directory-service"; // ES Modules import + * // const { DirectoryServiceClient, GetSnapshotLimitsCommand } = require("@aws-sdk/client-directory-service"); // CommonJS import + * const client = new DirectoryServiceClient(config); + * const command = new GetSnapshotLimitsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetSnapshotLimitsCommandInput} for command's `input` shape. + * @see {@link GetSnapshotLimitsCommandOutput} for command's `response` shape. + * @see {@link DirectoryServiceClientResolvedConfig | config} for command's `input` shape. + * */ export class GetSnapshotLimitsCommand extends $Command< GetSnapshotLimitsCommandInput, diff --git a/clients/client-directory-service/commands/ListCertificatesCommand.ts b/clients/client-directory-service/commands/ListCertificatesCommand.ts index e017a6768df0..948f703e7d32 100644 --- a/clients/client-directory-service/commands/ListCertificatesCommand.ts +++ b/clients/client-directory-service/commands/ListCertificatesCommand.ts @@ -22,6 +22,20 @@ export interface ListCertificatesCommandOutput extends ListCertificatesResult, _ /** *

For the specified directory, lists all the certificates registered for a secure LDAP or client certificate authentication.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { DirectoryServiceClient, ListCertificatesCommand } from "@aws-sdk/client-directory-service"; // ES Modules import + * // const { DirectoryServiceClient, ListCertificatesCommand } = require("@aws-sdk/client-directory-service"); // CommonJS import + * const client = new DirectoryServiceClient(config); + * const command = new ListCertificatesCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListCertificatesCommandInput} for command's `input` shape. + * @see {@link ListCertificatesCommandOutput} for command's `response` shape. + * @see {@link DirectoryServiceClientResolvedConfig | config} for command's `input` shape. + * */ export class ListCertificatesCommand extends $Command< ListCertificatesCommandInput, diff --git a/clients/client-directory-service/commands/ListIpRoutesCommand.ts b/clients/client-directory-service/commands/ListIpRoutesCommand.ts index b10efeb41527..01c6f0518b32 100644 --- a/clients/client-directory-service/commands/ListIpRoutesCommand.ts +++ b/clients/client-directory-service/commands/ListIpRoutesCommand.ts @@ -22,6 +22,20 @@ export interface ListIpRoutesCommandOutput extends ListIpRoutesResult, __Metadat /** *

Lists the address blocks that you have added to a directory.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { DirectoryServiceClient, ListIpRoutesCommand } from "@aws-sdk/client-directory-service"; // ES Modules import + * // const { DirectoryServiceClient, ListIpRoutesCommand } = require("@aws-sdk/client-directory-service"); // CommonJS import + * const client = new DirectoryServiceClient(config); + * const command = new ListIpRoutesCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListIpRoutesCommandInput} for command's `input` shape. + * @see {@link ListIpRoutesCommandOutput} for command's `response` shape. + * @see {@link DirectoryServiceClientResolvedConfig | config} for command's `input` shape. + * */ export class ListIpRoutesCommand extends $Command< ListIpRoutesCommandInput, diff --git a/clients/client-directory-service/commands/ListLogSubscriptionsCommand.ts b/clients/client-directory-service/commands/ListLogSubscriptionsCommand.ts index 1abbd8350348..4fd88e2bf6eb 100644 --- a/clients/client-directory-service/commands/ListLogSubscriptionsCommand.ts +++ b/clients/client-directory-service/commands/ListLogSubscriptionsCommand.ts @@ -22,6 +22,20 @@ export interface ListLogSubscriptionsCommandOutput extends ListLogSubscriptionsR /** *

Lists the active log subscriptions for the AWS account.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { DirectoryServiceClient, ListLogSubscriptionsCommand } from "@aws-sdk/client-directory-service"; // ES Modules import + * // const { DirectoryServiceClient, ListLogSubscriptionsCommand } = require("@aws-sdk/client-directory-service"); // CommonJS import + * const client = new DirectoryServiceClient(config); + * const command = new ListLogSubscriptionsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListLogSubscriptionsCommandInput} for command's `input` shape. + * @see {@link ListLogSubscriptionsCommandOutput} for command's `response` shape. + * @see {@link DirectoryServiceClientResolvedConfig | config} for command's `input` shape. + * */ export class ListLogSubscriptionsCommand extends $Command< ListLogSubscriptionsCommandInput, diff --git a/clients/client-directory-service/commands/ListSchemaExtensionsCommand.ts b/clients/client-directory-service/commands/ListSchemaExtensionsCommand.ts index c851f14d480a..c99016828816 100644 --- a/clients/client-directory-service/commands/ListSchemaExtensionsCommand.ts +++ b/clients/client-directory-service/commands/ListSchemaExtensionsCommand.ts @@ -22,6 +22,20 @@ export interface ListSchemaExtensionsCommandOutput extends ListSchemaExtensionsR /** *

Lists all schema extensions applied to a Microsoft AD Directory.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { DirectoryServiceClient, ListSchemaExtensionsCommand } from "@aws-sdk/client-directory-service"; // ES Modules import + * // const { DirectoryServiceClient, ListSchemaExtensionsCommand } = require("@aws-sdk/client-directory-service"); // CommonJS import + * const client = new DirectoryServiceClient(config); + * const command = new ListSchemaExtensionsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListSchemaExtensionsCommandInput} for command's `input` shape. + * @see {@link ListSchemaExtensionsCommandOutput} for command's `response` shape. + * @see {@link DirectoryServiceClientResolvedConfig | config} for command's `input` shape. + * */ export class ListSchemaExtensionsCommand extends $Command< ListSchemaExtensionsCommandInput, diff --git a/clients/client-directory-service/commands/ListTagsForResourceCommand.ts b/clients/client-directory-service/commands/ListTagsForResourceCommand.ts index 73bc7733b8f7..5223b0623b35 100644 --- a/clients/client-directory-service/commands/ListTagsForResourceCommand.ts +++ b/clients/client-directory-service/commands/ListTagsForResourceCommand.ts @@ -22,6 +22,20 @@ export interface ListTagsForResourceCommandOutput extends ListTagsForResourceRes /** *

Lists all tags on a directory.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { DirectoryServiceClient, ListTagsForResourceCommand } from "@aws-sdk/client-directory-service"; // ES Modules import + * // const { DirectoryServiceClient, ListTagsForResourceCommand } = require("@aws-sdk/client-directory-service"); // CommonJS import + * const client = new DirectoryServiceClient(config); + * const command = new ListTagsForResourceCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListTagsForResourceCommandInput} for command's `input` shape. + * @see {@link ListTagsForResourceCommandOutput} for command's `response` shape. + * @see {@link DirectoryServiceClientResolvedConfig | config} for command's `input` shape. + * */ export class ListTagsForResourceCommand extends $Command< ListTagsForResourceCommandInput, diff --git a/clients/client-directory-service/commands/RegisterCertificateCommand.ts b/clients/client-directory-service/commands/RegisterCertificateCommand.ts index bbeeccb1793e..3f3f014775cb 100644 --- a/clients/client-directory-service/commands/RegisterCertificateCommand.ts +++ b/clients/client-directory-service/commands/RegisterCertificateCommand.ts @@ -22,6 +22,20 @@ export interface RegisterCertificateCommandOutput extends RegisterCertificateRes /** *

Registers a certificate for a secure LDAP or client certificate authentication.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { DirectoryServiceClient, RegisterCertificateCommand } from "@aws-sdk/client-directory-service"; // ES Modules import + * // const { DirectoryServiceClient, RegisterCertificateCommand } = require("@aws-sdk/client-directory-service"); // CommonJS import + * const client = new DirectoryServiceClient(config); + * const command = new RegisterCertificateCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link RegisterCertificateCommandInput} for command's `input` shape. + * @see {@link RegisterCertificateCommandOutput} for command's `response` shape. + * @see {@link DirectoryServiceClientResolvedConfig | config} for command's `input` shape. + * */ export class RegisterCertificateCommand extends $Command< RegisterCertificateCommandInput, diff --git a/clients/client-directory-service/commands/RegisterEventTopicCommand.ts b/clients/client-directory-service/commands/RegisterEventTopicCommand.ts index 8e843e67d603..2684a1690eeb 100644 --- a/clients/client-directory-service/commands/RegisterEventTopicCommand.ts +++ b/clients/client-directory-service/commands/RegisterEventTopicCommand.ts @@ -22,6 +22,20 @@ export interface RegisterEventTopicCommandOutput extends RegisterEventTopicResul /** *

Associates a directory with an SNS topic. This establishes the directory as a publisher to the specified 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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { DirectoryServiceClient, RegisterEventTopicCommand } from "@aws-sdk/client-directory-service"; // ES Modules import + * // const { DirectoryServiceClient, RegisterEventTopicCommand } = require("@aws-sdk/client-directory-service"); // CommonJS import + * const client = new DirectoryServiceClient(config); + * const command = new RegisterEventTopicCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link RegisterEventTopicCommandInput} for command's `input` shape. + * @see {@link RegisterEventTopicCommandOutput} for command's `response` shape. + * @see {@link DirectoryServiceClientResolvedConfig | config} for command's `input` shape. + * */ export class RegisterEventTopicCommand extends $Command< RegisterEventTopicCommandInput, diff --git a/clients/client-directory-service/commands/RejectSharedDirectoryCommand.ts b/clients/client-directory-service/commands/RejectSharedDirectoryCommand.ts index cb0039a12664..c5b0cd413d30 100644 --- a/clients/client-directory-service/commands/RejectSharedDirectoryCommand.ts +++ b/clients/client-directory-service/commands/RejectSharedDirectoryCommand.ts @@ -22,6 +22,20 @@ export interface RejectSharedDirectoryCommandOutput extends RejectSharedDirector /** *

Rejects a directory sharing request that was sent from the directory owner account.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { DirectoryServiceClient, RejectSharedDirectoryCommand } from "@aws-sdk/client-directory-service"; // ES Modules import + * // const { DirectoryServiceClient, RejectSharedDirectoryCommand } = require("@aws-sdk/client-directory-service"); // CommonJS import + * const client = new DirectoryServiceClient(config); + * const command = new RejectSharedDirectoryCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link RejectSharedDirectoryCommandInput} for command's `input` shape. + * @see {@link RejectSharedDirectoryCommandOutput} for command's `response` shape. + * @see {@link DirectoryServiceClientResolvedConfig | config} for command's `input` shape. + * */ export class RejectSharedDirectoryCommand extends $Command< RejectSharedDirectoryCommandInput, diff --git a/clients/client-directory-service/commands/RemoveIpRoutesCommand.ts b/clients/client-directory-service/commands/RemoveIpRoutesCommand.ts index 3db01ad9557b..c1dc49263fc8 100644 --- a/clients/client-directory-service/commands/RemoveIpRoutesCommand.ts +++ b/clients/client-directory-service/commands/RemoveIpRoutesCommand.ts @@ -22,6 +22,20 @@ export interface RemoveIpRoutesCommandOutput extends RemoveIpRoutesResult, __Met /** *

Removes IP address blocks from a directory.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { DirectoryServiceClient, RemoveIpRoutesCommand } from "@aws-sdk/client-directory-service"; // ES Modules import + * // const { DirectoryServiceClient, RemoveIpRoutesCommand } = require("@aws-sdk/client-directory-service"); // CommonJS import + * const client = new DirectoryServiceClient(config); + * const command = new RemoveIpRoutesCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link RemoveIpRoutesCommandInput} for command's `input` shape. + * @see {@link RemoveIpRoutesCommandOutput} for command's `response` shape. + * @see {@link DirectoryServiceClientResolvedConfig | config} for command's `input` shape. + * */ export class RemoveIpRoutesCommand extends $Command< RemoveIpRoutesCommandInput, diff --git a/clients/client-directory-service/commands/RemoveRegionCommand.ts b/clients/client-directory-service/commands/RemoveRegionCommand.ts index b852af875da2..3ee4bd0e7a93 100644 --- a/clients/client-directory-service/commands/RemoveRegionCommand.ts +++ b/clients/client-directory-service/commands/RemoveRegionCommand.ts @@ -24,6 +24,20 @@ export interface RemoveRegionCommandOutput extends RemoveRegionResult, __Metadat *

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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { DirectoryServiceClient, RemoveRegionCommand } from "@aws-sdk/client-directory-service"; // ES Modules import + * // const { DirectoryServiceClient, RemoveRegionCommand } = require("@aws-sdk/client-directory-service"); // CommonJS import + * const client = new DirectoryServiceClient(config); + * const command = new RemoveRegionCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link RemoveRegionCommandInput} for command's `input` shape. + * @see {@link RemoveRegionCommandOutput} for command's `response` shape. + * @see {@link DirectoryServiceClientResolvedConfig | config} for command's `input` shape. + * */ export class RemoveRegionCommand extends $Command< RemoveRegionCommandInput, diff --git a/clients/client-directory-service/commands/RemoveTagsFromResourceCommand.ts b/clients/client-directory-service/commands/RemoveTagsFromResourceCommand.ts index b523092d3a11..3a641f985bdb 100644 --- a/clients/client-directory-service/commands/RemoveTagsFromResourceCommand.ts +++ b/clients/client-directory-service/commands/RemoveTagsFromResourceCommand.ts @@ -22,6 +22,20 @@ export interface RemoveTagsFromResourceCommandOutput extends RemoveTagsFromResou /** *

Removes tags from a directory.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { DirectoryServiceClient, RemoveTagsFromResourceCommand } from "@aws-sdk/client-directory-service"; // ES Modules import + * // const { DirectoryServiceClient, RemoveTagsFromResourceCommand } = require("@aws-sdk/client-directory-service"); // CommonJS import + * const client = new DirectoryServiceClient(config); + * const command = new RemoveTagsFromResourceCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link RemoveTagsFromResourceCommandInput} for command's `input` shape. + * @see {@link RemoveTagsFromResourceCommandOutput} for command's `response` shape. + * @see {@link DirectoryServiceClientResolvedConfig | config} for command's `input` shape. + * */ export class RemoveTagsFromResourceCommand extends $Command< RemoveTagsFromResourceCommandInput, diff --git a/clients/client-directory-service/commands/ResetUserPasswordCommand.ts b/clients/client-directory-service/commands/ResetUserPasswordCommand.ts index 23ee29b87634..d211935b57c3 100644 --- a/clients/client-directory-service/commands/ResetUserPasswordCommand.ts +++ b/clients/client-directory-service/commands/ResetUserPasswordCommand.ts @@ -40,6 +40,20 @@ export interface ResetUserPasswordCommandOutput extends ResetUserPasswordResult, * Guide.

* * + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { DirectoryServiceClient, ResetUserPasswordCommand } from "@aws-sdk/client-directory-service"; // ES Modules import + * // const { DirectoryServiceClient, ResetUserPasswordCommand } = require("@aws-sdk/client-directory-service"); // CommonJS import + * const client = new DirectoryServiceClient(config); + * const command = new ResetUserPasswordCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ResetUserPasswordCommandInput} for command's `input` shape. + * @see {@link ResetUserPasswordCommandOutput} for command's `response` shape. + * @see {@link DirectoryServiceClientResolvedConfig | config} for command's `input` shape. + * */ export class ResetUserPasswordCommand extends $Command< ResetUserPasswordCommandInput, diff --git a/clients/client-directory-service/commands/RestoreFromSnapshotCommand.ts b/clients/client-directory-service/commands/RestoreFromSnapshotCommand.ts index 5693900a123b..46042a410247 100644 --- a/clients/client-directory-service/commands/RestoreFromSnapshotCommand.ts +++ b/clients/client-directory-service/commands/RestoreFromSnapshotCommand.ts @@ -27,6 +27,20 @@ export interface RestoreFromSnapshotCommandOutput extends RestoreFromSnapshotRes * 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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { DirectoryServiceClient, RestoreFromSnapshotCommand } from "@aws-sdk/client-directory-service"; // ES Modules import + * // const { DirectoryServiceClient, RestoreFromSnapshotCommand } = require("@aws-sdk/client-directory-service"); // CommonJS import + * const client = new DirectoryServiceClient(config); + * const command = new RestoreFromSnapshotCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link RestoreFromSnapshotCommandInput} for command's `input` shape. + * @see {@link RestoreFromSnapshotCommandOutput} for command's `response` shape. + * @see {@link DirectoryServiceClientResolvedConfig | config} for command's `input` shape. + * */ export class RestoreFromSnapshotCommand extends $Command< RestoreFromSnapshotCommandInput, diff --git a/clients/client-directory-service/commands/ShareDirectoryCommand.ts b/clients/client-directory-service/commands/ShareDirectoryCommand.ts index 6b98910ec80e..d96fb45731e3 100644 --- a/clients/client-directory-service/commands/ShareDirectoryCommand.ts +++ b/clients/client-directory-service/commands/ShareDirectoryCommand.ts @@ -34,6 +34,20 @@ export interface ShareDirectoryCommandOutput extends ShareDirectoryResult, __Met * 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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { DirectoryServiceClient, ShareDirectoryCommand } from "@aws-sdk/client-directory-service"; // ES Modules import + * // const { DirectoryServiceClient, ShareDirectoryCommand } = require("@aws-sdk/client-directory-service"); // CommonJS import + * const client = new DirectoryServiceClient(config); + * const command = new ShareDirectoryCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ShareDirectoryCommandInput} for command's `input` shape. + * @see {@link ShareDirectoryCommandOutput} for command's `response` shape. + * @see {@link DirectoryServiceClientResolvedConfig | config} for command's `input` shape. + * */ export class ShareDirectoryCommand extends $Command< ShareDirectoryCommandInput, diff --git a/clients/client-directory-service/commands/StartSchemaExtensionCommand.ts b/clients/client-directory-service/commands/StartSchemaExtensionCommand.ts index 272d0185c229..a9aa86186048 100644 --- a/clients/client-directory-service/commands/StartSchemaExtensionCommand.ts +++ b/clients/client-directory-service/commands/StartSchemaExtensionCommand.ts @@ -22,6 +22,20 @@ export interface StartSchemaExtensionCommandOutput extends StartSchemaExtensionR /** *

Applies a schema extension to a Microsoft AD directory.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { DirectoryServiceClient, StartSchemaExtensionCommand } from "@aws-sdk/client-directory-service"; // ES Modules import + * // const { DirectoryServiceClient, StartSchemaExtensionCommand } = require("@aws-sdk/client-directory-service"); // CommonJS import + * const client = new DirectoryServiceClient(config); + * const command = new StartSchemaExtensionCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link StartSchemaExtensionCommandInput} for command's `input` shape. + * @see {@link StartSchemaExtensionCommandOutput} for command's `response` shape. + * @see {@link DirectoryServiceClientResolvedConfig | config} for command's `input` shape. + * */ export class StartSchemaExtensionCommand extends $Command< StartSchemaExtensionCommandInput, diff --git a/clients/client-directory-service/commands/UnshareDirectoryCommand.ts b/clients/client-directory-service/commands/UnshareDirectoryCommand.ts index a31878cc6726..864200f4b227 100644 --- a/clients/client-directory-service/commands/UnshareDirectoryCommand.ts +++ b/clients/client-directory-service/commands/UnshareDirectoryCommand.ts @@ -22,6 +22,20 @@ export interface UnshareDirectoryCommandOutput extends UnshareDirectoryResult, _ /** *

Stops the directory sharing between the directory owner and consumer accounts.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { DirectoryServiceClient, UnshareDirectoryCommand } from "@aws-sdk/client-directory-service"; // ES Modules import + * // const { DirectoryServiceClient, UnshareDirectoryCommand } = require("@aws-sdk/client-directory-service"); // CommonJS import + * const client = new DirectoryServiceClient(config); + * const command = new UnshareDirectoryCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link UnshareDirectoryCommandInput} for command's `input` shape. + * @see {@link UnshareDirectoryCommandOutput} for command's `response` shape. + * @see {@link DirectoryServiceClientResolvedConfig | config} for command's `input` shape. + * */ export class UnshareDirectoryCommand extends $Command< UnshareDirectoryCommandInput, diff --git a/clients/client-directory-service/commands/UpdateConditionalForwarderCommand.ts b/clients/client-directory-service/commands/UpdateConditionalForwarderCommand.ts index 04a3e3ca68dc..99461175bac0 100644 --- a/clients/client-directory-service/commands/UpdateConditionalForwarderCommand.ts +++ b/clients/client-directory-service/commands/UpdateConditionalForwarderCommand.ts @@ -22,6 +22,20 @@ export interface UpdateConditionalForwarderCommandOutput extends UpdateCondition /** *

Updates a conditional forwarder that has been set up for your AWS directory.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { DirectoryServiceClient, UpdateConditionalForwarderCommand } from "@aws-sdk/client-directory-service"; // ES Modules import + * // const { DirectoryServiceClient, UpdateConditionalForwarderCommand } = require("@aws-sdk/client-directory-service"); // CommonJS import + * const client = new DirectoryServiceClient(config); + * const command = new UpdateConditionalForwarderCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link UpdateConditionalForwarderCommandInput} for command's `input` shape. + * @see {@link UpdateConditionalForwarderCommandOutput} for command's `response` shape. + * @see {@link DirectoryServiceClientResolvedConfig | config} for command's `input` shape. + * */ export class UpdateConditionalForwarderCommand extends $Command< UpdateConditionalForwarderCommandInput, diff --git a/clients/client-directory-service/commands/UpdateNumberOfDomainControllersCommand.ts b/clients/client-directory-service/commands/UpdateNumberOfDomainControllersCommand.ts index 56009b4487c5..ae8db5bb8d4f 100644 --- a/clients/client-directory-service/commands/UpdateNumberOfDomainControllersCommand.ts +++ b/clients/client-directory-service/commands/UpdateNumberOfDomainControllersCommand.ts @@ -24,6 +24,20 @@ export interface UpdateNumberOfDomainControllersCommandOutput /** *

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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { DirectoryServiceClient, UpdateNumberOfDomainControllersCommand } from "@aws-sdk/client-directory-service"; // ES Modules import + * // const { DirectoryServiceClient, UpdateNumberOfDomainControllersCommand } = require("@aws-sdk/client-directory-service"); // CommonJS import + * const client = new DirectoryServiceClient(config); + * const command = new UpdateNumberOfDomainControllersCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link UpdateNumberOfDomainControllersCommandInput} for command's `input` shape. + * @see {@link UpdateNumberOfDomainControllersCommandOutput} for command's `response` shape. + * @see {@link DirectoryServiceClientResolvedConfig | config} for command's `input` shape. + * */ export class UpdateNumberOfDomainControllersCommand extends $Command< UpdateNumberOfDomainControllersCommandInput, diff --git a/clients/client-directory-service/commands/UpdateRadiusCommand.ts b/clients/client-directory-service/commands/UpdateRadiusCommand.ts index f3f090ecb16b..66f8874d2e3a 100644 --- a/clients/client-directory-service/commands/UpdateRadiusCommand.ts +++ b/clients/client-directory-service/commands/UpdateRadiusCommand.ts @@ -22,6 +22,20 @@ export interface UpdateRadiusCommandOutput extends UpdateRadiusResult, __Metadat /** *

Updates the Remote Authentication Dial In User Service (RADIUS) server information for an AD Connector or Microsoft AD directory.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { DirectoryServiceClient, UpdateRadiusCommand } from "@aws-sdk/client-directory-service"; // ES Modules import + * // const { DirectoryServiceClient, UpdateRadiusCommand } = require("@aws-sdk/client-directory-service"); // CommonJS import + * const client = new DirectoryServiceClient(config); + * const command = new UpdateRadiusCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link UpdateRadiusCommandInput} for command's `input` shape. + * @see {@link UpdateRadiusCommandOutput} for command's `response` shape. + * @see {@link DirectoryServiceClientResolvedConfig | config} for command's `input` shape. + * */ export class UpdateRadiusCommand extends $Command< UpdateRadiusCommandInput, diff --git a/clients/client-directory-service/commands/UpdateTrustCommand.ts b/clients/client-directory-service/commands/UpdateTrustCommand.ts index edf27a06b069..8fed9554c3e6 100644 --- a/clients/client-directory-service/commands/UpdateTrustCommand.ts +++ b/clients/client-directory-service/commands/UpdateTrustCommand.ts @@ -22,6 +22,20 @@ export interface UpdateTrustCommandOutput extends UpdateTrustResult, __MetadataB /** *

Updates the trust that has been set up between your AWS Managed Microsoft AD directory and an on-premises Active Directory.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { DirectoryServiceClient, UpdateTrustCommand } from "@aws-sdk/client-directory-service"; // ES Modules import + * // const { DirectoryServiceClient, UpdateTrustCommand } = require("@aws-sdk/client-directory-service"); // CommonJS import + * const client = new DirectoryServiceClient(config); + * const command = new UpdateTrustCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link UpdateTrustCommandInput} for command's `input` shape. + * @see {@link UpdateTrustCommandOutput} for command's `response` shape. + * @see {@link DirectoryServiceClientResolvedConfig | config} for command's `input` shape. + * */ export class UpdateTrustCommand extends $Command< UpdateTrustCommandInput, diff --git a/clients/client-directory-service/commands/VerifyTrustCommand.ts b/clients/client-directory-service/commands/VerifyTrustCommand.ts index d9d1f2546ef8..e85d1cda814c 100644 --- a/clients/client-directory-service/commands/VerifyTrustCommand.ts +++ b/clients/client-directory-service/commands/VerifyTrustCommand.ts @@ -23,6 +23,20 @@ export interface VerifyTrustCommandOutput extends VerifyTrustResult, __MetadataB /** *

AWS Directory Service for Microsoft Active Directory allows you to configure and verify trust relationships.

*

This action verifies a trust relationship between your AWS Managed Microsoft AD directory and an external domain.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { DirectoryServiceClient, VerifyTrustCommand } from "@aws-sdk/client-directory-service"; // ES Modules import + * // const { DirectoryServiceClient, VerifyTrustCommand } = require("@aws-sdk/client-directory-service"); // CommonJS import + * const client = new DirectoryServiceClient(config); + * const command = new VerifyTrustCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link VerifyTrustCommandInput} for command's `input` shape. + * @see {@link VerifyTrustCommandOutput} for command's `response` shape. + * @see {@link DirectoryServiceClientResolvedConfig | config} for command's `input` shape. + * */ export class VerifyTrustCommand extends $Command< VerifyTrustCommandInput, diff --git a/clients/client-directory-service/models/models_0.ts b/clients/client-directory-service/models/models_0.ts index cb98ac3d2048..560747269c77 100644 --- a/clients/client-directory-service/models/models_0.ts +++ b/clients/client-directory-service/models/models_0.ts @@ -10,6 +10,9 @@ export interface AcceptSharedDirectoryRequest { } export namespace AcceptSharedDirectoryRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: AcceptSharedDirectoryRequest): any => ({ ...obj, }); @@ -91,6 +94,9 @@ export interface SharedDirectory { } export namespace SharedDirectory { + /** + * @internal + */ export const filterSensitiveLog = (obj: SharedDirectory): any => ({ ...obj, ...(obj.ShareNotes && { ShareNotes: SENSITIVE_STRING }), @@ -105,6 +111,9 @@ export interface AcceptSharedDirectoryResult { } export namespace AcceptSharedDirectoryResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: AcceptSharedDirectoryResult): any => ({ ...obj, ...(obj.SharedDirectory && { SharedDirectory: SharedDirectory.filterSensitiveLog(obj.SharedDirectory) }), @@ -129,6 +138,9 @@ export interface ClientException extends __SmithyException, $MetadataBearer { } export namespace ClientException { + /** + * @internal + */ export const filterSensitiveLog = (obj: ClientException): any => ({ ...obj, }); @@ -152,6 +164,9 @@ export interface DirectoryAlreadySharedException extends __SmithyException, $Met } export namespace DirectoryAlreadySharedException { + /** + * @internal + */ export const filterSensitiveLog = (obj: DirectoryAlreadySharedException): any => ({ ...obj, }); @@ -175,6 +190,9 @@ export interface EntityDoesNotExistException extends __SmithyException, $Metadat } export namespace EntityDoesNotExistException { + /** + * @internal + */ export const filterSensitiveLog = (obj: EntityDoesNotExistException): any => ({ ...obj, }); @@ -198,6 +216,9 @@ export interface InvalidParameterException extends __SmithyException, $MetadataB } export namespace InvalidParameterException { + /** + * @internal + */ export const filterSensitiveLog = (obj: InvalidParameterException): any => ({ ...obj, }); @@ -221,6 +242,9 @@ export interface ServiceException extends __SmithyException, $MetadataBearer { } export namespace ServiceException { + /** + * @internal + */ export const filterSensitiveLog = (obj: ServiceException): any => ({ ...obj, }); @@ -244,6 +268,9 @@ export interface AccessDeniedException extends __SmithyException, $MetadataBeare } export namespace AccessDeniedException { + /** + * @internal + */ export const filterSensitiveLog = (obj: AccessDeniedException): any => ({ ...obj, }); @@ -265,6 +292,9 @@ export interface IpRoute { } export namespace IpRoute { + /** + * @internal + */ export const filterSensitiveLog = (obj: IpRoute): any => ({ ...obj, }); @@ -353,6 +383,9 @@ export interface AddIpRoutesRequest { } export namespace AddIpRoutesRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: AddIpRoutesRequest): any => ({ ...obj, }); @@ -361,6 +394,9 @@ export namespace AddIpRoutesRequest { export interface AddIpRoutesResult {} export namespace AddIpRoutesResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: AddIpRoutesResult): any => ({ ...obj, }); @@ -384,6 +420,9 @@ export interface DirectoryUnavailableException extends __SmithyException, $Metad } export namespace DirectoryUnavailableException { + /** + * @internal + */ export const filterSensitiveLog = (obj: DirectoryUnavailableException): any => ({ ...obj, }); @@ -407,6 +446,9 @@ export interface EntityAlreadyExistsException extends __SmithyException, $Metada } export namespace EntityAlreadyExistsException { + /** + * @internal + */ export const filterSensitiveLog = (obj: EntityAlreadyExistsException): any => ({ ...obj, }); @@ -430,6 +472,9 @@ export interface IpRouteLimitExceededException extends __SmithyException, $Metad } export namespace IpRouteLimitExceededException { + /** + * @internal + */ export const filterSensitiveLog = (obj: IpRouteLimitExceededException): any => ({ ...obj, }); @@ -453,6 +498,9 @@ export interface DirectoryVpcSettings { } export namespace DirectoryVpcSettings { + /** + * @internal + */ export const filterSensitiveLog = (obj: DirectoryVpcSettings): any => ({ ...obj, }); @@ -477,6 +525,9 @@ export interface AddRegionRequest { } export namespace AddRegionRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: AddRegionRequest): any => ({ ...obj, }); @@ -485,6 +536,9 @@ export namespace AddRegionRequest { export interface AddRegionResult {} export namespace AddRegionResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: AddRegionResult): any => ({ ...obj, }); @@ -509,6 +563,9 @@ export interface DirectoryAlreadyInRegionException extends __SmithyException, $M } export namespace DirectoryAlreadyInRegionException { + /** + * @internal + */ export const filterSensitiveLog = (obj: DirectoryAlreadyInRegionException): any => ({ ...obj, }); @@ -532,6 +589,9 @@ export interface DirectoryDoesNotExistException extends __SmithyException, $Meta } export namespace DirectoryDoesNotExistException { + /** + * @internal + */ export const filterSensitiveLog = (obj: DirectoryDoesNotExistException): any => ({ ...obj, }); @@ -556,6 +616,9 @@ export interface RegionLimitExceededException extends __SmithyException, $Metada } export namespace RegionLimitExceededException { + /** + * @internal + */ export const filterSensitiveLog = (obj: RegionLimitExceededException): any => ({ ...obj, }); @@ -579,6 +642,9 @@ export interface UnsupportedOperationException extends __SmithyException, $Metad } export namespace UnsupportedOperationException { + /** + * @internal + */ export const filterSensitiveLog = (obj: UnsupportedOperationException): any => ({ ...obj, }); @@ -600,6 +666,9 @@ export interface Tag { } export namespace Tag { + /** + * @internal + */ export const filterSensitiveLog = (obj: Tag): any => ({ ...obj, }); @@ -618,6 +687,9 @@ export interface AddTagsToResourceRequest { } export namespace AddTagsToResourceRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: AddTagsToResourceRequest): any => ({ ...obj, }); @@ -626,6 +698,9 @@ export namespace AddTagsToResourceRequest { export interface AddTagsToResourceResult {} export namespace AddTagsToResourceResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: AddTagsToResourceResult): any => ({ ...obj, }); @@ -649,6 +724,9 @@ export interface TagLimitExceededException extends __SmithyException, $MetadataB } export namespace TagLimitExceededException { + /** + * @internal + */ export const filterSensitiveLog = (obj: TagLimitExceededException): any => ({ ...obj, }); @@ -670,6 +748,9 @@ export interface Attribute { } export namespace Attribute { + /** + * @internal + */ export const filterSensitiveLog = (obj: Attribute): any => ({ ...obj, }); @@ -693,6 +774,9 @@ export interface AuthenticationFailedException extends __SmithyException, $Metad } export namespace AuthenticationFailedException { + /** + * @internal + */ export const filterSensitiveLog = (obj: AuthenticationFailedException): any => ({ ...obj, }); @@ -711,6 +795,9 @@ export interface CancelSchemaExtensionRequest { } export namespace CancelSchemaExtensionRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: CancelSchemaExtensionRequest): any => ({ ...obj, }); @@ -719,6 +806,9 @@ export namespace CancelSchemaExtensionRequest { export interface CancelSchemaExtensionResult {} export namespace CancelSchemaExtensionResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: CancelSchemaExtensionResult): any => ({ ...obj, }); @@ -735,6 +825,9 @@ export interface ClientCertAuthSettings { } export namespace ClientCertAuthSettings { + /** + * @internal + */ export const filterSensitiveLog = (obj: ClientCertAuthSettings): any => ({ ...obj, }); @@ -800,6 +893,9 @@ export interface Certificate { } export namespace Certificate { + /** + * @internal + */ export const filterSensitiveLog = (obj: Certificate): any => ({ ...obj, }); @@ -823,6 +919,9 @@ export interface CertificateAlreadyExistsException extends __SmithyException, $M } export namespace CertificateAlreadyExistsException { + /** + * @internal + */ export const filterSensitiveLog = (obj: CertificateAlreadyExistsException): any => ({ ...obj, }); @@ -846,6 +945,9 @@ export interface CertificateDoesNotExistException extends __SmithyException, $Me } export namespace CertificateDoesNotExistException { + /** + * @internal + */ export const filterSensitiveLog = (obj: CertificateDoesNotExistException): any => ({ ...obj, }); @@ -882,6 +984,9 @@ export interface CertificateInfo { } export namespace CertificateInfo { + /** + * @internal + */ export const filterSensitiveLog = (obj: CertificateInfo): any => ({ ...obj, }); @@ -906,6 +1011,9 @@ export interface CertificateInUseException extends __SmithyException, $MetadataB } export namespace CertificateInUseException { + /** + * @internal + */ export const filterSensitiveLog = (obj: CertificateInUseException): any => ({ ...obj, }); @@ -929,6 +1037,9 @@ export interface CertificateLimitExceededException extends __SmithyException, $M } export namespace CertificateLimitExceededException { + /** + * @internal + */ export const filterSensitiveLog = (obj: CertificateLimitExceededException): any => ({ ...obj, }); @@ -960,6 +1071,9 @@ export interface Computer { } export namespace Computer { + /** + * @internal + */ export const filterSensitiveLog = (obj: Computer): any => ({ ...obj, }); @@ -992,6 +1106,9 @@ export interface ConditionalForwarder { } export namespace ConditionalForwarder { + /** + * @internal + */ export const filterSensitiveLog = (obj: ConditionalForwarder): any => ({ ...obj, }); @@ -1037,6 +1154,9 @@ export interface DirectoryConnectSettings { } export namespace DirectoryConnectSettings { + /** + * @internal + */ export const filterSensitiveLog = (obj: DirectoryConnectSettings): any => ({ ...obj, }); @@ -1090,6 +1210,9 @@ export interface ConnectDirectoryRequest { } export namespace ConnectDirectoryRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ConnectDirectoryRequest): any => ({ ...obj, ...(obj.Password && { Password: SENSITIVE_STRING }), @@ -1107,6 +1230,9 @@ export interface ConnectDirectoryResult { } export namespace ConnectDirectoryResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: ConnectDirectoryResult): any => ({ ...obj, }); @@ -1132,6 +1258,9 @@ export interface DirectoryLimitExceededException extends __SmithyException, $Met } export namespace DirectoryLimitExceededException { + /** + * @internal + */ export const filterSensitiveLog = (obj: DirectoryLimitExceededException): any => ({ ...obj, }); @@ -1155,6 +1284,9 @@ export interface CreateAliasRequest { } export namespace CreateAliasRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateAliasRequest): any => ({ ...obj, }); @@ -1176,6 +1308,9 @@ export interface CreateAliasResult { } export namespace CreateAliasResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateAliasResult): any => ({ ...obj, }); @@ -1213,6 +1348,9 @@ export interface CreateComputerRequest { } export namespace CreateComputerRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateComputerRequest): any => ({ ...obj, ...(obj.Password && { Password: SENSITIVE_STRING }), @@ -1230,6 +1368,9 @@ export interface CreateComputerResult { } export namespace CreateComputerResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateComputerResult): any => ({ ...obj, }); @@ -1256,6 +1397,9 @@ export interface CreateConditionalForwarderRequest { } export namespace CreateConditionalForwarderRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateConditionalForwarderRequest): any => ({ ...obj, }); @@ -1267,6 +1411,9 @@ export namespace CreateConditionalForwarderRequest { export interface CreateConditionalForwarderResult {} export namespace CreateConditionalForwarderResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateConditionalForwarderResult): any => ({ ...obj, }); @@ -1342,6 +1489,9 @@ export interface CreateDirectoryRequest { } export namespace CreateDirectoryRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateDirectoryRequest): any => ({ ...obj, ...(obj.Password && { Password: SENSITIVE_STRING }), @@ -1359,6 +1509,9 @@ export interface CreateDirectoryResult { } export namespace CreateDirectoryResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateDirectoryResult): any => ({ ...obj, }); @@ -1379,6 +1532,9 @@ export interface CreateLogSubscriptionRequest { } export namespace CreateLogSubscriptionRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateLogSubscriptionRequest): any => ({ ...obj, }); @@ -1387,6 +1543,9 @@ export namespace CreateLogSubscriptionRequest { export interface CreateLogSubscriptionResult {} export namespace CreateLogSubscriptionResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateLogSubscriptionResult): any => ({ ...obj, }); @@ -1410,6 +1569,9 @@ export interface InsufficientPermissionsException extends __SmithyException, $Me } export namespace InsufficientPermissionsException { + /** + * @internal + */ export const filterSensitiveLog = (obj: InsufficientPermissionsException): any => ({ ...obj, }); @@ -1464,6 +1626,9 @@ export interface CreateMicrosoftADRequest { } export namespace CreateMicrosoftADRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateMicrosoftADRequest): any => ({ ...obj, ...(obj.Password && { Password: SENSITIVE_STRING }), @@ -1481,6 +1646,9 @@ export interface CreateMicrosoftADResult { } export namespace CreateMicrosoftADResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateMicrosoftADResult): any => ({ ...obj, }); @@ -1502,6 +1670,9 @@ export interface CreateSnapshotRequest { } export namespace CreateSnapshotRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateSnapshotRequest): any => ({ ...obj, }); @@ -1518,6 +1689,9 @@ export interface CreateSnapshotResult { } export namespace CreateSnapshotResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateSnapshotResult): any => ({ ...obj, }); @@ -1543,6 +1717,9 @@ export interface SnapshotLimitExceededException extends __SmithyException, $Meta } export namespace SnapshotLimitExceededException { + /** + * @internal + */ export const filterSensitiveLog = (obj: SnapshotLimitExceededException): any => ({ ...obj, }); @@ -1606,6 +1783,9 @@ export interface CreateTrustRequest { } export namespace CreateTrustRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateTrustRequest): any => ({ ...obj, ...(obj.TrustPassword && { TrustPassword: SENSITIVE_STRING }), @@ -1623,6 +1803,9 @@ export interface CreateTrustResult { } export namespace CreateTrustResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateTrustResult): any => ({ ...obj, }); @@ -1644,6 +1827,9 @@ export interface DeleteConditionalForwarderRequest { } export namespace DeleteConditionalForwarderRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteConditionalForwarderRequest): any => ({ ...obj, }); @@ -1655,6 +1841,9 @@ export namespace DeleteConditionalForwarderRequest { export interface DeleteConditionalForwarderResult {} export namespace DeleteConditionalForwarderResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteConditionalForwarderResult): any => ({ ...obj, }); @@ -1671,6 +1860,9 @@ export interface DeleteDirectoryRequest { } export namespace DeleteDirectoryRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteDirectoryRequest): any => ({ ...obj, }); @@ -1687,6 +1879,9 @@ export interface DeleteDirectoryResult { } export namespace DeleteDirectoryResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteDirectoryResult): any => ({ ...obj, }); @@ -1700,6 +1895,9 @@ export interface DeleteLogSubscriptionRequest { } export namespace DeleteLogSubscriptionRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteLogSubscriptionRequest): any => ({ ...obj, }); @@ -1708,6 +1906,9 @@ export namespace DeleteLogSubscriptionRequest { export interface DeleteLogSubscriptionResult {} export namespace DeleteLogSubscriptionResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteLogSubscriptionResult): any => ({ ...obj, }); @@ -1724,6 +1925,9 @@ export interface DeleteSnapshotRequest { } export namespace DeleteSnapshotRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteSnapshotRequest): any => ({ ...obj, }); @@ -1740,6 +1944,9 @@ export interface DeleteSnapshotResult { } export namespace DeleteSnapshotResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteSnapshotResult): any => ({ ...obj, }); @@ -1761,6 +1968,9 @@ export interface DeleteTrustRequest { } export namespace DeleteTrustRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteTrustRequest): any => ({ ...obj, }); @@ -1777,6 +1987,9 @@ export interface DeleteTrustResult { } export namespace DeleteTrustResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteTrustResult): any => ({ ...obj, }); @@ -1795,6 +2008,9 @@ export interface DeregisterCertificateRequest { } export namespace DeregisterCertificateRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeregisterCertificateRequest): any => ({ ...obj, }); @@ -1803,6 +2019,9 @@ export namespace DeregisterCertificateRequest { export interface DeregisterCertificateResult {} export namespace DeregisterCertificateResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeregisterCertificateResult): any => ({ ...obj, }); @@ -1824,6 +2043,9 @@ export interface DeregisterEventTopicRequest { } export namespace DeregisterEventTopicRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeregisterEventTopicRequest): any => ({ ...obj, }); @@ -1835,6 +2057,9 @@ export namespace DeregisterEventTopicRequest { export interface DeregisterEventTopicResult {} export namespace DeregisterEventTopicResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeregisterEventTopicResult): any => ({ ...obj, }); @@ -1853,6 +2078,9 @@ export interface DescribeCertificateRequest { } export namespace DescribeCertificateRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeCertificateRequest): any => ({ ...obj, }); @@ -1867,6 +2095,9 @@ export interface DescribeCertificateResult { } export namespace DescribeCertificateResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeCertificateResult): any => ({ ...obj, }); @@ -1888,6 +2119,9 @@ export interface DescribeConditionalForwardersRequest { } export namespace DescribeConditionalForwardersRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeConditionalForwardersRequest): any => ({ ...obj, }); @@ -1904,6 +2138,9 @@ export interface DescribeConditionalForwardersResult { } export namespace DescribeConditionalForwardersResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeConditionalForwardersResult): any => ({ ...obj, }); @@ -1933,6 +2170,9 @@ export interface DescribeDirectoriesRequest { } export namespace DescribeDirectoriesRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeDirectoriesRequest): any => ({ ...obj, }); @@ -1974,6 +2214,9 @@ export interface DirectoryConnectSettingsDescription { } export namespace DirectoryConnectSettingsDescription { + /** + * @internal + */ export const filterSensitiveLog = (obj: DirectoryConnectSettingsDescription): any => ({ ...obj, }); @@ -2032,6 +2275,9 @@ export interface RadiusSettings { } export namespace RadiusSettings { + /** + * @internal + */ export const filterSensitiveLog = (obj: RadiusSettings): any => ({ ...obj, ...(obj.SharedSecret && { SharedSecret: SENSITIVE_STRING }), @@ -2070,6 +2316,9 @@ export interface DirectoryVpcSettingsDescription { } export namespace DirectoryVpcSettingsDescription { + /** + * @internal + */ export const filterSensitiveLog = (obj: DirectoryVpcSettingsDescription): any => ({ ...obj, }); @@ -2114,6 +2363,9 @@ export interface OwnerDirectoryDescription { } export namespace OwnerDirectoryDescription { + /** + * @internal + */ export const filterSensitiveLog = (obj: OwnerDirectoryDescription): any => ({ ...obj, ...(obj.RadiusSettings && { RadiusSettings: RadiusSettings.filterSensitiveLog(obj.RadiusSettings) }), @@ -2138,6 +2390,9 @@ export interface RegionsInfo { } export namespace RegionsInfo { + /** + * @internal + */ export const filterSensitiveLog = (obj: RegionsInfo): any => ({ ...obj, }); @@ -2311,6 +2566,9 @@ export interface DirectoryDescription { } export namespace DirectoryDescription { + /** + * @internal + */ export const filterSensitiveLog = (obj: DirectoryDescription): any => ({ ...obj, ...(obj.ShareNotes && { ShareNotes: SENSITIVE_STRING }), @@ -2343,6 +2601,9 @@ export interface DescribeDirectoriesResult { } export namespace DescribeDirectoriesResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeDirectoriesResult): any => ({ ...obj, ...(obj.DirectoryDescriptions && { @@ -2369,6 +2630,9 @@ export interface InvalidNextTokenException extends __SmithyException, $MetadataB } export namespace InvalidNextTokenException { + /** + * @internal + */ export const filterSensitiveLog = (obj: InvalidNextTokenException): any => ({ ...obj, }); @@ -2397,6 +2661,9 @@ export interface DescribeDomainControllersRequest { } export namespace DescribeDomainControllersRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeDomainControllersRequest): any => ({ ...obj, }); @@ -2468,6 +2735,9 @@ export interface DomainController { } export namespace DomainController { + /** + * @internal + */ export const filterSensitiveLog = (obj: DomainController): any => ({ ...obj, }); @@ -2486,6 +2756,9 @@ export interface DescribeDomainControllersResult { } export namespace DescribeDomainControllersResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeDomainControllersResult): any => ({ ...obj, }); @@ -2508,6 +2781,9 @@ export interface DescribeEventTopicsRequest { } export namespace DescribeEventTopicsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeEventTopicsRequest): any => ({ ...obj, }); @@ -2551,6 +2827,9 @@ export interface EventTopic { } export namespace EventTopic { + /** + * @internal + */ export const filterSensitiveLog = (obj: EventTopic): any => ({ ...obj, }); @@ -2567,6 +2846,9 @@ export interface DescribeEventTopicsResult { } export namespace DescribeEventTopicsResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeEventTopicsResult): any => ({ ...obj, }); @@ -2600,6 +2882,9 @@ export interface DescribeLDAPSSettingsRequest { } export namespace DescribeLDAPSSettingsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeLDAPSSettingsRequest): any => ({ ...obj, }); @@ -2633,6 +2918,9 @@ export interface LDAPSSettingInfo { } export namespace LDAPSSettingInfo { + /** + * @internal + */ export const filterSensitiveLog = (obj: LDAPSSettingInfo): any => ({ ...obj, }); @@ -2653,6 +2941,9 @@ export interface DescribeLDAPSSettingsResult { } export namespace DescribeLDAPSSettingsResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeLDAPSSettingsResult): any => ({ ...obj, }); @@ -2676,6 +2967,9 @@ export interface DescribeRegionsRequest { } export namespace DescribeRegionsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeRegionsRequest): any => ({ ...obj, }); @@ -2738,6 +3032,9 @@ export interface RegionDescription { } export namespace RegionDescription { + /** + * @internal + */ export const filterSensitiveLog = (obj: RegionDescription): any => ({ ...obj, }); @@ -2758,6 +3055,9 @@ export interface DescribeRegionsResult { } export namespace DescribeRegionsResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeRegionsResult): any => ({ ...obj, }); @@ -2787,6 +3087,9 @@ export interface DescribeSharedDirectoriesRequest { } export namespace DescribeSharedDirectoriesRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeSharedDirectoriesRequest): any => ({ ...obj, }); @@ -2806,6 +3109,9 @@ export interface DescribeSharedDirectoriesResult { } export namespace DescribeSharedDirectoriesResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeSharedDirectoriesResult): any => ({ ...obj, ...(obj.SharedDirectories && { @@ -2843,6 +3149,9 @@ export interface DescribeSnapshotsRequest { } export namespace DescribeSnapshotsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeSnapshotsRequest): any => ({ ...obj, }); @@ -2895,6 +3204,9 @@ export interface Snapshot { } export namespace Snapshot { + /** + * @internal + */ export const filterSensitiveLog = (obj: Snapshot): any => ({ ...obj, }); @@ -2921,6 +3233,9 @@ export interface DescribeSnapshotsResult { } export namespace DescribeSnapshotsResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeSnapshotsResult): any => ({ ...obj, }); @@ -2954,6 +3269,9 @@ export interface DescribeTrustsRequest { } export namespace DescribeTrustsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeTrustsRequest): any => ({ ...obj, }); @@ -3034,6 +3352,9 @@ export interface Trust { } export namespace Trust { + /** + * @internal + */ export const filterSensitiveLog = (obj: Trust): any => ({ ...obj, }); @@ -3060,6 +3381,9 @@ export interface DescribeTrustsResult { } export namespace DescribeTrustsResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeTrustsResult): any => ({ ...obj, }); @@ -3116,6 +3440,9 @@ export interface DirectoryLimits { } export namespace DirectoryLimits { + /** + * @internal + */ export const filterSensitiveLog = (obj: DirectoryLimits): any => ({ ...obj, }); @@ -3139,6 +3466,9 @@ export interface DirectoryNotSharedException extends __SmithyException, $Metadat } export namespace DirectoryNotSharedException { + /** + * @internal + */ export const filterSensitiveLog = (obj: DirectoryNotSharedException): any => ({ ...obj, }); @@ -3157,6 +3487,9 @@ export interface DisableClientAuthenticationRequest { } export namespace DisableClientAuthenticationRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DisableClientAuthenticationRequest): any => ({ ...obj, }); @@ -3165,6 +3498,9 @@ export namespace DisableClientAuthenticationRequest { export interface DisableClientAuthenticationResult {} export namespace DisableClientAuthenticationResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: DisableClientAuthenticationResult): any => ({ ...obj, }); @@ -3188,6 +3524,9 @@ export interface InvalidClientAuthStatusException extends __SmithyException, $Me } export namespace InvalidClientAuthStatusException { + /** + * @internal + */ export const filterSensitiveLog = (obj: InvalidClientAuthStatusException): any => ({ ...obj, }); @@ -3207,6 +3546,9 @@ export interface DisableLDAPSRequest { } export namespace DisableLDAPSRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DisableLDAPSRequest): any => ({ ...obj, }); @@ -3215,6 +3557,9 @@ export namespace DisableLDAPSRequest { export interface DisableLDAPSResult {} export namespace DisableLDAPSResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: DisableLDAPSResult): any => ({ ...obj, }); @@ -3239,6 +3584,9 @@ export interface InvalidLDAPSStatusException extends __SmithyException, $Metadat } export namespace InvalidLDAPSStatusException { + /** + * @internal + */ export const filterSensitiveLog = (obj: InvalidLDAPSStatusException): any => ({ ...obj, }); @@ -3255,6 +3603,9 @@ export interface DisableRadiusRequest { } export namespace DisableRadiusRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DisableRadiusRequest): any => ({ ...obj, }); @@ -3266,6 +3617,9 @@ export namespace DisableRadiusRequest { export interface DisableRadiusResult {} export namespace DisableRadiusResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: DisableRadiusResult): any => ({ ...obj, }); @@ -3297,6 +3651,9 @@ export interface DisableSsoRequest { } export namespace DisableSsoRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DisableSsoRequest): any => ({ ...obj, ...(obj.Password && { Password: SENSITIVE_STRING }), @@ -3309,6 +3666,9 @@ export namespace DisableSsoRequest { export interface DisableSsoResult {} export namespace DisableSsoResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: DisableSsoResult): any => ({ ...obj, }); @@ -3330,6 +3690,9 @@ export interface EnableClientAuthenticationRequest { } export namespace EnableClientAuthenticationRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: EnableClientAuthenticationRequest): any => ({ ...obj, }); @@ -3338,6 +3701,9 @@ export namespace EnableClientAuthenticationRequest { export interface EnableClientAuthenticationResult {} export namespace EnableClientAuthenticationResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: EnableClientAuthenticationResult): any => ({ ...obj, }); @@ -3362,6 +3728,9 @@ export interface NoAvailableCertificateException extends __SmithyException, $Met } export namespace NoAvailableCertificateException { + /** + * @internal + */ export const filterSensitiveLog = (obj: NoAvailableCertificateException): any => ({ ...obj, }); @@ -3381,6 +3750,9 @@ export interface EnableLDAPSRequest { } export namespace EnableLDAPSRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: EnableLDAPSRequest): any => ({ ...obj, }); @@ -3389,6 +3761,9 @@ export namespace EnableLDAPSRequest { export interface EnableLDAPSResult {} export namespace EnableLDAPSResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: EnableLDAPSResult): any => ({ ...obj, }); @@ -3410,6 +3785,9 @@ export interface EnableRadiusRequest { } export namespace EnableRadiusRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: EnableRadiusRequest): any => ({ ...obj, ...(obj.RadiusSettings && { RadiusSettings: RadiusSettings.filterSensitiveLog(obj.RadiusSettings) }), @@ -3422,6 +3800,9 @@ export namespace EnableRadiusRequest { export interface EnableRadiusResult {} export namespace EnableRadiusResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: EnableRadiusResult): any => ({ ...obj, }); @@ -3453,6 +3834,9 @@ export interface EnableSsoRequest { } export namespace EnableSsoRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: EnableSsoRequest): any => ({ ...obj, ...(obj.Password && { Password: SENSITIVE_STRING }), @@ -3465,6 +3849,9 @@ export namespace EnableSsoRequest { export interface EnableSsoResult {} export namespace EnableSsoResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: EnableSsoResult): any => ({ ...obj, }); @@ -3476,6 +3863,9 @@ export namespace EnableSsoResult { export interface GetDirectoryLimitsRequest {} export namespace GetDirectoryLimitsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetDirectoryLimitsRequest): any => ({ ...obj, }); @@ -3493,6 +3883,9 @@ export interface GetDirectoryLimitsResult { } export namespace GetDirectoryLimitsResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetDirectoryLimitsResult): any => ({ ...obj, }); @@ -3509,6 +3902,9 @@ export interface GetSnapshotLimitsRequest { } export namespace GetSnapshotLimitsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetSnapshotLimitsRequest): any => ({ ...obj, }); @@ -3535,6 +3931,9 @@ export interface SnapshotLimits { } export namespace SnapshotLimits { + /** + * @internal + */ export const filterSensitiveLog = (obj: SnapshotLimits): any => ({ ...obj, }); @@ -3552,6 +3951,9 @@ export interface GetSnapshotLimitsResult { } export namespace GetSnapshotLimitsResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetSnapshotLimitsResult): any => ({ ...obj, }); @@ -3578,6 +3980,9 @@ export interface ListCertificatesRequest { } export namespace ListCertificatesRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListCertificatesRequest): any => ({ ...obj, }); @@ -3598,6 +4003,9 @@ export interface ListCertificatesResult { } export namespace ListCertificatesResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListCertificatesResult): any => ({ ...obj, }); @@ -3622,6 +4030,9 @@ export interface ListIpRoutesRequest { } export namespace ListIpRoutesRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListIpRoutesRequest): any => ({ ...obj, }); @@ -3672,6 +4083,9 @@ export interface IpRouteInfo { } export namespace IpRouteInfo { + /** + * @internal + */ export const filterSensitiveLog = (obj: IpRouteInfo): any => ({ ...obj, }); @@ -3691,6 +4105,9 @@ export interface ListIpRoutesResult { } export namespace ListIpRoutesResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListIpRoutesResult): any => ({ ...obj, }); @@ -3717,6 +4134,9 @@ export interface ListLogSubscriptionsRequest { } export namespace ListLogSubscriptionsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListLogSubscriptionsRequest): any => ({ ...obj, }); @@ -3745,6 +4165,9 @@ export interface LogSubscription { } export namespace LogSubscription { + /** + * @internal + */ export const filterSensitiveLog = (obj: LogSubscription): any => ({ ...obj, }); @@ -3764,6 +4187,9 @@ export interface ListLogSubscriptionsResult { } export namespace ListLogSubscriptionsResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListLogSubscriptionsResult): any => ({ ...obj, }); @@ -3787,6 +4213,9 @@ export interface ListSchemaExtensionsRequest { } export namespace ListSchemaExtensionsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListSchemaExtensionsRequest): any => ({ ...obj, }); @@ -3845,6 +4274,9 @@ export interface SchemaExtensionInfo { } export namespace SchemaExtensionInfo { + /** + * @internal + */ export const filterSensitiveLog = (obj: SchemaExtensionInfo): any => ({ ...obj, }); @@ -3863,6 +4295,9 @@ export interface ListSchemaExtensionsResult { } export namespace ListSchemaExtensionsResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListSchemaExtensionsResult): any => ({ ...obj, }); @@ -3886,6 +4321,9 @@ export interface ListTagsForResourceRequest { } export namespace ListTagsForResourceRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListTagsForResourceRequest): any => ({ ...obj, }); @@ -3904,6 +4342,9 @@ export interface ListTagsForResourceResult { } export namespace ListTagsForResourceResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListTagsForResourceResult): any => ({ ...obj, }); @@ -3927,6 +4368,9 @@ export interface InvalidCertificateException extends __SmithyException, $Metadat } export namespace InvalidCertificateException { + /** + * @internal + */ export const filterSensitiveLog = (obj: InvalidCertificateException): any => ({ ...obj, }); @@ -3955,6 +4399,9 @@ export interface RegisterCertificateRequest { } export namespace RegisterCertificateRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: RegisterCertificateRequest): any => ({ ...obj, }); @@ -3968,6 +4415,9 @@ export interface RegisterCertificateResult { } export namespace RegisterCertificateResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: RegisterCertificateResult): any => ({ ...obj, }); @@ -3989,6 +4439,9 @@ export interface RegisterEventTopicRequest { } export namespace RegisterEventTopicRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: RegisterEventTopicRequest): any => ({ ...obj, }); @@ -4000,6 +4453,9 @@ export namespace RegisterEventTopicRequest { export interface RegisterEventTopicResult {} export namespace RegisterEventTopicResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: RegisterEventTopicResult): any => ({ ...obj, }); @@ -4014,6 +4470,9 @@ export interface RejectSharedDirectoryRequest { } export namespace RejectSharedDirectoryRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: RejectSharedDirectoryRequest): any => ({ ...obj, }); @@ -4027,6 +4486,9 @@ export interface RejectSharedDirectoryResult { } export namespace RejectSharedDirectoryResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: RejectSharedDirectoryResult): any => ({ ...obj, }); @@ -4045,6 +4507,9 @@ export interface RemoveIpRoutesRequest { } export namespace RemoveIpRoutesRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: RemoveIpRoutesRequest): any => ({ ...obj, }); @@ -4053,6 +4518,9 @@ export namespace RemoveIpRoutesRequest { export interface RemoveIpRoutesResult {} export namespace RemoveIpRoutesResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: RemoveIpRoutesResult): any => ({ ...obj, }); @@ -4066,6 +4534,9 @@ export interface RemoveRegionRequest { } export namespace RemoveRegionRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: RemoveRegionRequest): any => ({ ...obj, }); @@ -4074,6 +4545,9 @@ export namespace RemoveRegionRequest { export interface RemoveRegionResult {} export namespace RemoveRegionResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: RemoveRegionResult): any => ({ ...obj, }); @@ -4092,6 +4566,9 @@ export interface RemoveTagsFromResourceRequest { } export namespace RemoveTagsFromResourceRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: RemoveTagsFromResourceRequest): any => ({ ...obj, }); @@ -4100,6 +4577,9 @@ export namespace RemoveTagsFromResourceRequest { export interface RemoveTagsFromResourceResult {} export namespace RemoveTagsFromResourceResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: RemoveTagsFromResourceResult): any => ({ ...obj, }); @@ -4123,6 +4603,9 @@ export interface InvalidPasswordException extends __SmithyException, $MetadataBe } export namespace InvalidPasswordException { + /** + * @internal + */ export const filterSensitiveLog = (obj: InvalidPasswordException): any => ({ ...obj, }); @@ -4147,6 +4630,9 @@ export interface ResetUserPasswordRequest { } export namespace ResetUserPasswordRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ResetUserPasswordRequest): any => ({ ...obj, ...(obj.NewPassword && { NewPassword: SENSITIVE_STRING }), @@ -4156,6 +4642,9 @@ export namespace ResetUserPasswordRequest { export interface ResetUserPasswordResult {} export namespace ResetUserPasswordResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: ResetUserPasswordResult): any => ({ ...obj, }); @@ -4179,6 +4668,9 @@ export interface UserDoesNotExistException extends __SmithyException, $MetadataB } export namespace UserDoesNotExistException { + /** + * @internal + */ export const filterSensitiveLog = (obj: UserDoesNotExistException): any => ({ ...obj, }); @@ -4195,6 +4687,9 @@ export interface RestoreFromSnapshotRequest { } export namespace RestoreFromSnapshotRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: RestoreFromSnapshotRequest): any => ({ ...obj, }); @@ -4206,6 +4701,9 @@ export namespace RestoreFromSnapshotRequest { export interface RestoreFromSnapshotResult {} export namespace RestoreFromSnapshotResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: RestoreFromSnapshotResult): any => ({ ...obj, }); @@ -4229,6 +4727,9 @@ export interface InvalidTargetException extends __SmithyException, $MetadataBear } export namespace InvalidTargetException { + /** + * @internal + */ export const filterSensitiveLog = (obj: InvalidTargetException): any => ({ ...obj, }); @@ -4252,6 +4753,9 @@ export interface OrganizationsException extends __SmithyException, $MetadataBear } export namespace OrganizationsException { + /** + * @internal + */ export const filterSensitiveLog = (obj: OrganizationsException): any => ({ ...obj, }); @@ -4277,6 +4781,9 @@ export interface ShareTarget { } export namespace ShareTarget { + /** + * @internal + */ export const filterSensitiveLog = (obj: ShareTarget): any => ({ ...obj, }); @@ -4311,6 +4818,9 @@ export interface ShareDirectoryRequest { } export namespace ShareDirectoryRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ShareDirectoryRequest): any => ({ ...obj, ...(obj.ShareNotes && { ShareNotes: SENSITIVE_STRING }), @@ -4326,6 +4836,9 @@ export interface ShareDirectoryResult { } export namespace ShareDirectoryResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: ShareDirectoryResult): any => ({ ...obj, }); @@ -4349,6 +4862,9 @@ export interface ShareLimitExceededException extends __SmithyException, $Metadat } export namespace ShareLimitExceededException { + /** + * @internal + */ export const filterSensitiveLog = (obj: ShareLimitExceededException): any => ({ ...obj, }); @@ -4377,6 +4893,9 @@ export interface StartSchemaExtensionRequest { } export namespace StartSchemaExtensionRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: StartSchemaExtensionRequest): any => ({ ...obj, }); @@ -4390,6 +4909,9 @@ export interface StartSchemaExtensionResult { } export namespace StartSchemaExtensionResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: StartSchemaExtensionResult): any => ({ ...obj, }); @@ -4412,6 +4934,9 @@ export interface UnshareTarget { } export namespace UnshareTarget { + /** + * @internal + */ export const filterSensitiveLog = (obj: UnshareTarget): any => ({ ...obj, }); @@ -4432,6 +4957,9 @@ export interface UnshareDirectoryRequest { } export namespace UnshareDirectoryRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: UnshareDirectoryRequest): any => ({ ...obj, }); @@ -4446,6 +4974,9 @@ export interface UnshareDirectoryResult { } export namespace UnshareDirectoryResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: UnshareDirectoryResult): any => ({ ...obj, }); @@ -4472,6 +5003,9 @@ export interface UpdateConditionalForwarderRequest { } export namespace UpdateConditionalForwarderRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateConditionalForwarderRequest): any => ({ ...obj, }); @@ -4483,6 +5017,9 @@ export namespace UpdateConditionalForwarderRequest { export interface UpdateConditionalForwarderResult {} export namespace UpdateConditionalForwarderResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateConditionalForwarderResult): any => ({ ...obj, }); @@ -4506,6 +5043,9 @@ export interface DomainControllerLimitExceededException extends __SmithyExceptio } export namespace DomainControllerLimitExceededException { + /** + * @internal + */ export const filterSensitiveLog = (obj: DomainControllerLimitExceededException): any => ({ ...obj, }); @@ -4524,6 +5064,9 @@ export interface UpdateNumberOfDomainControllersRequest { } export namespace UpdateNumberOfDomainControllersRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateNumberOfDomainControllersRequest): any => ({ ...obj, }); @@ -4532,6 +5075,9 @@ export namespace UpdateNumberOfDomainControllersRequest { export interface UpdateNumberOfDomainControllersResult {} export namespace UpdateNumberOfDomainControllersResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateNumberOfDomainControllersResult): any => ({ ...obj, }); @@ -4553,6 +5099,9 @@ export interface UpdateRadiusRequest { } export namespace UpdateRadiusRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateRadiusRequest): any => ({ ...obj, ...(obj.RadiusSettings && { RadiusSettings: RadiusSettings.filterSensitiveLog(obj.RadiusSettings) }), @@ -4565,6 +5114,9 @@ export namespace UpdateRadiusRequest { export interface UpdateRadiusResult {} export namespace UpdateRadiusResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateRadiusResult): any => ({ ...obj, }); @@ -4583,6 +5135,9 @@ export interface UpdateTrustRequest { } export namespace UpdateTrustRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateTrustRequest): any => ({ ...obj, }); @@ -4601,6 +5156,9 @@ export interface UpdateTrustResult { } export namespace UpdateTrustResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateTrustResult): any => ({ ...obj, }); @@ -4617,6 +5175,9 @@ export interface VerifyTrustRequest { } export namespace VerifyTrustRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: VerifyTrustRequest): any => ({ ...obj, }); @@ -4633,6 +5194,9 @@ export interface VerifyTrustResult { } export namespace VerifyTrustResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: VerifyTrustResult): any => ({ ...obj, }); diff --git a/clients/client-dlm/commands/CreateLifecyclePolicyCommand.ts b/clients/client-dlm/commands/CreateLifecyclePolicyCommand.ts index 87dfe976dde9..ea9a8b48e88c 100644 --- a/clients/client-dlm/commands/CreateLifecyclePolicyCommand.ts +++ b/clients/client-dlm/commands/CreateLifecyclePolicyCommand.ts @@ -23,6 +23,20 @@ export interface CreateLifecyclePolicyCommandOutput extends CreateLifecyclePolic /** *

Creates a policy to manage the lifecycle of the specified AWS resources. You can * create up to 100 lifecycle policies.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { DLMClient, CreateLifecyclePolicyCommand } from "@aws-sdk/client-dlm"; // ES Modules import + * // const { DLMClient, CreateLifecyclePolicyCommand } = require("@aws-sdk/client-dlm"); // CommonJS import + * const client = new DLMClient(config); + * const command = new CreateLifecyclePolicyCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreateLifecyclePolicyCommandInput} for command's `input` shape. + * @see {@link CreateLifecyclePolicyCommandOutput} for command's `response` shape. + * @see {@link DLMClientResolvedConfig | config} for command's `input` shape. + * */ export class CreateLifecyclePolicyCommand extends $Command< CreateLifecyclePolicyCommandInput, diff --git a/clients/client-dlm/commands/DeleteLifecyclePolicyCommand.ts b/clients/client-dlm/commands/DeleteLifecyclePolicyCommand.ts index f8f0373d91d5..0ecf6d18842d 100644 --- a/clients/client-dlm/commands/DeleteLifecyclePolicyCommand.ts +++ b/clients/client-dlm/commands/DeleteLifecyclePolicyCommand.ts @@ -23,6 +23,20 @@ export interface DeleteLifecyclePolicyCommandOutput extends DeleteLifecyclePolic /** *

Deletes the specified lifecycle policy and halts the automated operations that the * policy specified.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { DLMClient, DeleteLifecyclePolicyCommand } from "@aws-sdk/client-dlm"; // ES Modules import + * // const { DLMClient, DeleteLifecyclePolicyCommand } = require("@aws-sdk/client-dlm"); // CommonJS import + * const client = new DLMClient(config); + * const command = new DeleteLifecyclePolicyCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteLifecyclePolicyCommandInput} for command's `input` shape. + * @see {@link DeleteLifecyclePolicyCommandOutput} for command's `response` shape. + * @see {@link DLMClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteLifecyclePolicyCommand extends $Command< DeleteLifecyclePolicyCommandInput, diff --git a/clients/client-dlm/commands/GetLifecyclePoliciesCommand.ts b/clients/client-dlm/commands/GetLifecyclePoliciesCommand.ts index aef4be8a2c40..f3c1439053cf 100644 --- a/clients/client-dlm/commands/GetLifecyclePoliciesCommand.ts +++ b/clients/client-dlm/commands/GetLifecyclePoliciesCommand.ts @@ -23,6 +23,20 @@ export interface GetLifecyclePoliciesCommandOutput extends GetLifecyclePoliciesR /** *

Gets summary information about all or the specified data lifecycle policies.

*

To get complete information about a policy, use GetLifecyclePolicy.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { DLMClient, GetLifecyclePoliciesCommand } from "@aws-sdk/client-dlm"; // ES Modules import + * // const { DLMClient, GetLifecyclePoliciesCommand } = require("@aws-sdk/client-dlm"); // CommonJS import + * const client = new DLMClient(config); + * const command = new GetLifecyclePoliciesCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetLifecyclePoliciesCommandInput} for command's `input` shape. + * @see {@link GetLifecyclePoliciesCommandOutput} for command's `response` shape. + * @see {@link DLMClientResolvedConfig | config} for command's `input` shape. + * */ export class GetLifecyclePoliciesCommand extends $Command< GetLifecyclePoliciesCommandInput, diff --git a/clients/client-dlm/commands/GetLifecyclePolicyCommand.ts b/clients/client-dlm/commands/GetLifecyclePolicyCommand.ts index 16ce5c42bc18..0ad60bb5c601 100644 --- a/clients/client-dlm/commands/GetLifecyclePolicyCommand.ts +++ b/clients/client-dlm/commands/GetLifecyclePolicyCommand.ts @@ -22,6 +22,20 @@ export interface GetLifecyclePolicyCommandOutput extends GetLifecyclePolicyRespo /** *

Gets detailed information about the specified lifecycle policy.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { DLMClient, GetLifecyclePolicyCommand } from "@aws-sdk/client-dlm"; // ES Modules import + * // const { DLMClient, GetLifecyclePolicyCommand } = require("@aws-sdk/client-dlm"); // CommonJS import + * const client = new DLMClient(config); + * const command = new GetLifecyclePolicyCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetLifecyclePolicyCommandInput} for command's `input` shape. + * @see {@link GetLifecyclePolicyCommandOutput} for command's `response` shape. + * @see {@link DLMClientResolvedConfig | config} for command's `input` shape. + * */ export class GetLifecyclePolicyCommand extends $Command< GetLifecyclePolicyCommandInput, diff --git a/clients/client-dlm/commands/ListTagsForResourceCommand.ts b/clients/client-dlm/commands/ListTagsForResourceCommand.ts index 0e67ad3f02cf..83a0aae7de8c 100644 --- a/clients/client-dlm/commands/ListTagsForResourceCommand.ts +++ b/clients/client-dlm/commands/ListTagsForResourceCommand.ts @@ -22,6 +22,20 @@ export interface ListTagsForResourceCommandOutput extends ListTagsForResourceRes /** *

Lists the tags for the specified resource.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { DLMClient, ListTagsForResourceCommand } from "@aws-sdk/client-dlm"; // ES Modules import + * // const { DLMClient, ListTagsForResourceCommand } = require("@aws-sdk/client-dlm"); // CommonJS import + * const client = new DLMClient(config); + * const command = new ListTagsForResourceCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListTagsForResourceCommandInput} for command's `input` shape. + * @see {@link ListTagsForResourceCommandOutput} for command's `response` shape. + * @see {@link DLMClientResolvedConfig | config} for command's `input` shape. + * */ export class ListTagsForResourceCommand extends $Command< ListTagsForResourceCommandInput, diff --git a/clients/client-dlm/commands/TagResourceCommand.ts b/clients/client-dlm/commands/TagResourceCommand.ts index 7fa56b2cffc2..38f90dad782b 100644 --- a/clients/client-dlm/commands/TagResourceCommand.ts +++ b/clients/client-dlm/commands/TagResourceCommand.ts @@ -22,6 +22,20 @@ export interface TagResourceCommandOutput extends TagResourceResponse, __Metadat /** *

Adds the specified tags to the specified resource.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { DLMClient, TagResourceCommand } from "@aws-sdk/client-dlm"; // ES Modules import + * // const { DLMClient, TagResourceCommand } = require("@aws-sdk/client-dlm"); // CommonJS import + * const client = new DLMClient(config); + * const command = new TagResourceCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link TagResourceCommandInput} for command's `input` shape. + * @see {@link TagResourceCommandOutput} for command's `response` shape. + * @see {@link DLMClientResolvedConfig | config} for command's `input` shape. + * */ export class TagResourceCommand extends $Command< TagResourceCommandInput, diff --git a/clients/client-dlm/commands/UntagResourceCommand.ts b/clients/client-dlm/commands/UntagResourceCommand.ts index 2e32beab3d1e..7c8ae9975759 100644 --- a/clients/client-dlm/commands/UntagResourceCommand.ts +++ b/clients/client-dlm/commands/UntagResourceCommand.ts @@ -22,6 +22,20 @@ export interface UntagResourceCommandOutput extends UntagResourceResponse, __Met /** *

Removes the specified tags from the specified resource.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { DLMClient, UntagResourceCommand } from "@aws-sdk/client-dlm"; // ES Modules import + * // const { DLMClient, UntagResourceCommand } = require("@aws-sdk/client-dlm"); // CommonJS import + * const client = new DLMClient(config); + * const command = new UntagResourceCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link UntagResourceCommandInput} for command's `input` shape. + * @see {@link UntagResourceCommandOutput} for command's `response` shape. + * @see {@link DLMClientResolvedConfig | config} for command's `input` shape. + * */ export class UntagResourceCommand extends $Command< UntagResourceCommandInput, diff --git a/clients/client-dlm/commands/UpdateLifecyclePolicyCommand.ts b/clients/client-dlm/commands/UpdateLifecyclePolicyCommand.ts index 5a145265eb59..65eaf5e30777 100644 --- a/clients/client-dlm/commands/UpdateLifecyclePolicyCommand.ts +++ b/clients/client-dlm/commands/UpdateLifecyclePolicyCommand.ts @@ -22,6 +22,20 @@ export interface UpdateLifecyclePolicyCommandOutput extends UpdateLifecyclePolic /** *

Updates the specified lifecycle policy.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { DLMClient, UpdateLifecyclePolicyCommand } from "@aws-sdk/client-dlm"; // ES Modules import + * // const { DLMClient, UpdateLifecyclePolicyCommand } = require("@aws-sdk/client-dlm"); // CommonJS import + * const client = new DLMClient(config); + * const command = new UpdateLifecyclePolicyCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link UpdateLifecyclePolicyCommandInput} for command's `input` shape. + * @see {@link UpdateLifecyclePolicyCommandOutput} for command's `response` shape. + * @see {@link DLMClientResolvedConfig | config} for command's `input` shape. + * */ export class UpdateLifecyclePolicyCommand extends $Command< UpdateLifecyclePolicyCommandInput, diff --git a/clients/client-dlm/models/models_0.ts b/clients/client-dlm/models/models_0.ts index 5fd78edaecf6..5eda6ec77cce 100644 --- a/clients/client-dlm/models/models_0.ts +++ b/clients/client-dlm/models/models_0.ts @@ -20,6 +20,9 @@ export interface EncryptionConfiguration { } export namespace EncryptionConfiguration { + /** + * @internal + */ export const filterSensitiveLog = (obj: EncryptionConfiguration): any => ({ ...obj, }); @@ -49,6 +52,9 @@ export interface CrossRegionCopyRetainRule { } export namespace CrossRegionCopyRetainRule { + /** + * @internal + */ export const filterSensitiveLog = (obj: CrossRegionCopyRetainRule): any => ({ ...obj, }); @@ -75,6 +81,9 @@ export interface CrossRegionCopyAction { } export namespace CrossRegionCopyAction { + /** + * @internal + */ export const filterSensitiveLog = (obj: CrossRegionCopyAction): any => ({ ...obj, }); @@ -96,6 +105,9 @@ export interface Action { } export namespace Action { + /** + * @internal + */ export const filterSensitiveLog = (obj: Action): any => ({ ...obj, }); @@ -132,6 +144,9 @@ export interface EventParameters { } export namespace EventParameters { + /** + * @internal + */ export const filterSensitiveLog = (obj: EventParameters): any => ({ ...obj, }); @@ -157,6 +172,9 @@ export interface EventSource { } export namespace EventSource { + /** + * @internal + */ export const filterSensitiveLog = (obj: EventSource): any => ({ ...obj, }); @@ -184,6 +202,9 @@ export interface _Parameters { } export namespace _Parameters { + /** + * @internal + */ export const filterSensitiveLog = (obj: _Parameters): any => ({ ...obj, }); @@ -259,6 +280,9 @@ export interface CreateRule { } export namespace CreateRule { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateRule): any => ({ ...obj, }); @@ -308,6 +332,9 @@ export interface CrossRegionCopyRule { } export namespace CrossRegionCopyRule { + /** + * @internal + */ export const filterSensitiveLog = (obj: CrossRegionCopyRule): any => ({ ...obj, }); @@ -341,6 +368,9 @@ export interface FastRestoreRule { } export namespace FastRestoreRule { + /** + * @internal + */ export const filterSensitiveLog = (obj: FastRestoreRule): any => ({ ...obj, }); @@ -369,6 +399,9 @@ export interface RetainRule { } export namespace RetainRule { + /** + * @internal + */ export const filterSensitiveLog = (obj: RetainRule): any => ({ ...obj, }); @@ -395,6 +428,9 @@ export interface ShareRule { } export namespace ShareRule { + /** + * @internal + */ export const filterSensitiveLog = (obj: ShareRule): any => ({ ...obj, }); @@ -416,6 +452,9 @@ export interface Tag { } export namespace Tag { + /** + * @internal + */ export const filterSensitiveLog = (obj: Tag): any => ({ ...obj, }); @@ -481,6 +520,9 @@ export interface Schedule { } export namespace Schedule { + /** + * @internal + */ export const filterSensitiveLog = (obj: Schedule): any => ({ ...obj, }); @@ -550,6 +592,9 @@ export interface PolicyDetails { } export namespace PolicyDetails { + /** + * @internal + */ export const filterSensitiveLog = (obj: PolicyDetails): any => ({ ...obj, }); @@ -590,6 +635,9 @@ export interface CreateLifecyclePolicyRequest { } export namespace CreateLifecyclePolicyRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateLifecyclePolicyRequest): any => ({ ...obj, }); @@ -603,6 +651,9 @@ export interface CreateLifecyclePolicyResponse { } export namespace CreateLifecyclePolicyResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateLifecyclePolicyResponse): any => ({ ...obj, }); @@ -619,6 +670,9 @@ export interface InternalServerException extends __SmithyException, $MetadataBea } export namespace InternalServerException { + /** + * @internal + */ export const filterSensitiveLog = (obj: InternalServerException): any => ({ ...obj, }); @@ -645,6 +699,9 @@ export interface InvalidRequestException extends __SmithyException, $MetadataBea } export namespace InvalidRequestException { + /** + * @internal + */ export const filterSensitiveLog = (obj: InvalidRequestException): any => ({ ...obj, }); @@ -665,6 +722,9 @@ export interface LimitExceededException extends __SmithyException, $MetadataBear } export namespace LimitExceededException { + /** + * @internal + */ export const filterSensitiveLog = (obj: LimitExceededException): any => ({ ...obj, }); @@ -678,6 +738,9 @@ export interface DeleteLifecyclePolicyRequest { } export namespace DeleteLifecyclePolicyRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteLifecyclePolicyRequest): any => ({ ...obj, }); @@ -686,6 +749,9 @@ export namespace DeleteLifecyclePolicyRequest { export interface DeleteLifecyclePolicyResponse {} export namespace DeleteLifecyclePolicyResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteLifecyclePolicyResponse): any => ({ ...obj, }); @@ -711,6 +777,9 @@ export interface ResourceNotFoundException extends __SmithyException, $MetadataB } export namespace ResourceNotFoundException { + /** + * @internal + */ export const filterSensitiveLog = (obj: ResourceNotFoundException): any => ({ ...obj, }); @@ -753,6 +822,9 @@ export interface GetLifecyclePoliciesRequest { } export namespace GetLifecyclePoliciesRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetLifecyclePoliciesRequest): any => ({ ...obj, }); @@ -791,6 +863,9 @@ export interface LifecyclePolicySummary { } export namespace LifecyclePolicySummary { + /** + * @internal + */ export const filterSensitiveLog = (obj: LifecyclePolicySummary): any => ({ ...obj, }); @@ -804,6 +879,9 @@ export interface GetLifecyclePoliciesResponse { } export namespace GetLifecyclePoliciesResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetLifecyclePoliciesResponse): any => ({ ...obj, }); @@ -817,6 +895,9 @@ export interface GetLifecyclePolicyRequest { } export namespace GetLifecyclePolicyRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetLifecyclePolicyRequest): any => ({ ...obj, }); @@ -879,6 +960,9 @@ export interface LifecyclePolicy { } export namespace LifecyclePolicy { + /** + * @internal + */ export const filterSensitiveLog = (obj: LifecyclePolicy): any => ({ ...obj, }); @@ -892,6 +976,9 @@ export interface GetLifecyclePolicyResponse { } export namespace GetLifecyclePolicyResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetLifecyclePolicyResponse): any => ({ ...obj, }); @@ -905,6 +992,9 @@ export interface ListTagsForResourceRequest { } export namespace ListTagsForResourceRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListTagsForResourceRequest): any => ({ ...obj, }); @@ -918,6 +1008,9 @@ export interface ListTagsForResourceResponse { } export namespace ListTagsForResourceResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListTagsForResourceResponse): any => ({ ...obj, }); @@ -936,6 +1029,9 @@ export interface TagResourceRequest { } export namespace TagResourceRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: TagResourceRequest): any => ({ ...obj, }); @@ -944,6 +1040,9 @@ export namespace TagResourceRequest { export interface TagResourceResponse {} export namespace TagResourceResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: TagResourceResponse): any => ({ ...obj, }); @@ -962,6 +1061,9 @@ export interface UntagResourceRequest { } export namespace UntagResourceRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: UntagResourceRequest): any => ({ ...obj, }); @@ -970,6 +1072,9 @@ export namespace UntagResourceRequest { export interface UntagResourceResponse {} export namespace UntagResourceResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: UntagResourceResponse): any => ({ ...obj, }); @@ -1005,6 +1110,9 @@ export interface UpdateLifecyclePolicyRequest { } export namespace UpdateLifecyclePolicyRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateLifecyclePolicyRequest): any => ({ ...obj, }); @@ -1013,6 +1121,9 @@ export namespace UpdateLifecyclePolicyRequest { export interface UpdateLifecyclePolicyResponse {} export namespace UpdateLifecyclePolicyResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateLifecyclePolicyResponse): any => ({ ...obj, }); diff --git a/clients/client-docdb/commands/AddTagsToResourceCommand.ts b/clients/client-docdb/commands/AddTagsToResourceCommand.ts index 271aefa06912..050db40abfa1 100644 --- a/clients/client-docdb/commands/AddTagsToResourceCommand.ts +++ b/clients/client-docdb/commands/AddTagsToResourceCommand.ts @@ -25,6 +25,20 @@ export interface AddTagsToResourceCommandOutput extends __MetadataBearer {} * with cost allocation reporting to track costs that are associated * with Amazon DocumentDB resources. or in a Condition statement in * an AWS Identity and Access Management (IAM) policy for Amazon DocumentDB.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { DocDBClient, AddTagsToResourceCommand } from "@aws-sdk/client-docdb"; // ES Modules import + * // const { DocDBClient, AddTagsToResourceCommand } = require("@aws-sdk/client-docdb"); // CommonJS import + * const client = new DocDBClient(config); + * const command = new AddTagsToResourceCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link AddTagsToResourceCommandInput} for command's `input` shape. + * @see {@link AddTagsToResourceCommandOutput} for command's `response` shape. + * @see {@link DocDBClientResolvedConfig | config} for command's `input` shape. + * */ export class AddTagsToResourceCommand extends $Command< AddTagsToResourceCommandInput, diff --git a/clients/client-docdb/commands/ApplyPendingMaintenanceActionCommand.ts b/clients/client-docdb/commands/ApplyPendingMaintenanceActionCommand.ts index 0caa651dda9e..c0c9475ab924 100644 --- a/clients/client-docdb/commands/ApplyPendingMaintenanceActionCommand.ts +++ b/clients/client-docdb/commands/ApplyPendingMaintenanceActionCommand.ts @@ -25,6 +25,20 @@ export interface ApplyPendingMaintenanceActionCommandOutput /** *

Applies a pending maintenance action to a resource (for example, * to an Amazon DocumentDB instance).

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { DocDBClient, ApplyPendingMaintenanceActionCommand } from "@aws-sdk/client-docdb"; // ES Modules import + * // const { DocDBClient, ApplyPendingMaintenanceActionCommand } = require("@aws-sdk/client-docdb"); // CommonJS import + * const client = new DocDBClient(config); + * const command = new ApplyPendingMaintenanceActionCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ApplyPendingMaintenanceActionCommandInput} for command's `input` shape. + * @see {@link ApplyPendingMaintenanceActionCommandOutput} for command's `response` shape. + * @see {@link DocDBClientResolvedConfig | config} for command's `input` shape. + * */ export class ApplyPendingMaintenanceActionCommand extends $Command< ApplyPendingMaintenanceActionCommandInput, diff --git a/clients/client-docdb/commands/CopyDBClusterParameterGroupCommand.ts b/clients/client-docdb/commands/CopyDBClusterParameterGroupCommand.ts index 3d2bc218a8bb..f0cc84ff239a 100644 --- a/clients/client-docdb/commands/CopyDBClusterParameterGroupCommand.ts +++ b/clients/client-docdb/commands/CopyDBClusterParameterGroupCommand.ts @@ -22,6 +22,20 @@ export interface CopyDBClusterParameterGroupCommandOutput extends CopyDBClusterP /** *

Copies the specified cluster parameter group.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { DocDBClient, CopyDBClusterParameterGroupCommand } from "@aws-sdk/client-docdb"; // ES Modules import + * // const { DocDBClient, CopyDBClusterParameterGroupCommand } = require("@aws-sdk/client-docdb"); // CommonJS import + * const client = new DocDBClient(config); + * const command = new CopyDBClusterParameterGroupCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CopyDBClusterParameterGroupCommandInput} for command's `input` shape. + * @see {@link CopyDBClusterParameterGroupCommandOutput} for command's `response` shape. + * @see {@link DocDBClientResolvedConfig | config} for command's `input` shape. + * */ export class CopyDBClusterParameterGroupCommand extends $Command< CopyDBClusterParameterGroupCommandInput, diff --git a/clients/client-docdb/commands/CopyDBClusterSnapshotCommand.ts b/clients/client-docdb/commands/CopyDBClusterSnapshotCommand.ts index 442c4fff22bf..0b82bbe50498 100644 --- a/clients/client-docdb/commands/CopyDBClusterSnapshotCommand.ts +++ b/clients/client-docdb/commands/CopyDBClusterSnapshotCommand.ts @@ -34,6 +34,20 @@ export interface CopyDBClusterSnapshotCommandOutput extends CopyDBClusterSnapsho * target cluster snapshot identified by * TargetDBClusterSnapshotIdentifier while that cluster * snapshot is in the copying status.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { DocDBClient, CopyDBClusterSnapshotCommand } from "@aws-sdk/client-docdb"; // ES Modules import + * // const { DocDBClient, CopyDBClusterSnapshotCommand } = require("@aws-sdk/client-docdb"); // CommonJS import + * const client = new DocDBClient(config); + * const command = new CopyDBClusterSnapshotCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CopyDBClusterSnapshotCommandInput} for command's `input` shape. + * @see {@link CopyDBClusterSnapshotCommandOutput} for command's `response` shape. + * @see {@link DocDBClientResolvedConfig | config} for command's `input` shape. + * */ export class CopyDBClusterSnapshotCommand extends $Command< CopyDBClusterSnapshotCommandInput, diff --git a/clients/client-docdb/commands/CreateDBClusterCommand.ts b/clients/client-docdb/commands/CreateDBClusterCommand.ts index da94aa1e1d33..cf214458dfa5 100644 --- a/clients/client-docdb/commands/CreateDBClusterCommand.ts +++ b/clients/client-docdb/commands/CreateDBClusterCommand.ts @@ -23,6 +23,20 @@ export interface CreateDBClusterCommandOutput extends CreateDBClusterResult, __M /** *

Creates a new Amazon DocumentDB cluster.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { DocDBClient, CreateDBClusterCommand } from "@aws-sdk/client-docdb"; // ES Modules import + * // const { DocDBClient, CreateDBClusterCommand } = require("@aws-sdk/client-docdb"); // CommonJS import + * const client = new DocDBClient(config); + * const command = new CreateDBClusterCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreateDBClusterCommandInput} for command's `input` shape. + * @see {@link CreateDBClusterCommandOutput} for command's `response` shape. + * @see {@link DocDBClientResolvedConfig | config} for command's `input` shape. + * */ export class CreateDBClusterCommand extends $Command< CreateDBClusterCommandInput, diff --git a/clients/client-docdb/commands/CreateDBClusterParameterGroupCommand.ts b/clients/client-docdb/commands/CreateDBClusterParameterGroupCommand.ts index d3782bce4881..b3538ab8f49c 100644 --- a/clients/client-docdb/commands/CreateDBClusterParameterGroupCommand.ts +++ b/clients/client-docdb/commands/CreateDBClusterParameterGroupCommand.ts @@ -42,6 +42,20 @@ export interface CreateDBClusterParameterGroupCommandOutput * see * Modifying Amazon DocumentDB Cluster Parameter Groups. *

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { DocDBClient, CreateDBClusterParameterGroupCommand } from "@aws-sdk/client-docdb"; // ES Modules import + * // const { DocDBClient, CreateDBClusterParameterGroupCommand } = require("@aws-sdk/client-docdb"); // CommonJS import + * const client = new DocDBClient(config); + * const command = new CreateDBClusterParameterGroupCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreateDBClusterParameterGroupCommandInput} for command's `input` shape. + * @see {@link CreateDBClusterParameterGroupCommandOutput} for command's `response` shape. + * @see {@link DocDBClientResolvedConfig | config} for command's `input` shape. + * */ export class CreateDBClusterParameterGroupCommand extends $Command< CreateDBClusterParameterGroupCommandInput, diff --git a/clients/client-docdb/commands/CreateDBClusterSnapshotCommand.ts b/clients/client-docdb/commands/CreateDBClusterSnapshotCommand.ts index c3af29e26247..473232c482f6 100644 --- a/clients/client-docdb/commands/CreateDBClusterSnapshotCommand.ts +++ b/clients/client-docdb/commands/CreateDBClusterSnapshotCommand.ts @@ -22,6 +22,20 @@ export interface CreateDBClusterSnapshotCommandOutput extends CreateDBClusterSna /** *

Creates a snapshot of a cluster.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { DocDBClient, CreateDBClusterSnapshotCommand } from "@aws-sdk/client-docdb"; // ES Modules import + * // const { DocDBClient, CreateDBClusterSnapshotCommand } = require("@aws-sdk/client-docdb"); // CommonJS import + * const client = new DocDBClient(config); + * const command = new CreateDBClusterSnapshotCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreateDBClusterSnapshotCommandInput} for command's `input` shape. + * @see {@link CreateDBClusterSnapshotCommandOutput} for command's `response` shape. + * @see {@link DocDBClientResolvedConfig | config} for command's `input` shape. + * */ export class CreateDBClusterSnapshotCommand extends $Command< CreateDBClusterSnapshotCommandInput, diff --git a/clients/client-docdb/commands/CreateDBInstanceCommand.ts b/clients/client-docdb/commands/CreateDBInstanceCommand.ts index dbbabec35bd1..3d477f7bbdfc 100644 --- a/clients/client-docdb/commands/CreateDBInstanceCommand.ts +++ b/clients/client-docdb/commands/CreateDBInstanceCommand.ts @@ -22,6 +22,20 @@ export interface CreateDBInstanceCommandOutput extends CreateDBInstanceResult, _ /** *

Creates a new instance.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { DocDBClient, CreateDBInstanceCommand } from "@aws-sdk/client-docdb"; // ES Modules import + * // const { DocDBClient, CreateDBInstanceCommand } = require("@aws-sdk/client-docdb"); // CommonJS import + * const client = new DocDBClient(config); + * const command = new CreateDBInstanceCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreateDBInstanceCommandInput} for command's `input` shape. + * @see {@link CreateDBInstanceCommandOutput} for command's `response` shape. + * @see {@link DocDBClientResolvedConfig | config} for command's `input` shape. + * */ export class CreateDBInstanceCommand extends $Command< CreateDBInstanceCommandInput, diff --git a/clients/client-docdb/commands/CreateDBSubnetGroupCommand.ts b/clients/client-docdb/commands/CreateDBSubnetGroupCommand.ts index 9a583d4ba896..3fa2bf714dac 100644 --- a/clients/client-docdb/commands/CreateDBSubnetGroupCommand.ts +++ b/clients/client-docdb/commands/CreateDBSubnetGroupCommand.ts @@ -23,6 +23,20 @@ export interface CreateDBSubnetGroupCommandOutput extends CreateDBSubnetGroupRes /** *

Creates a new subnet group. subnet groups must contain at least one subnet in at * least two Availability Zones in the AWS Region.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { DocDBClient, CreateDBSubnetGroupCommand } from "@aws-sdk/client-docdb"; // ES Modules import + * // const { DocDBClient, CreateDBSubnetGroupCommand } = require("@aws-sdk/client-docdb"); // CommonJS import + * const client = new DocDBClient(config); + * const command = new CreateDBSubnetGroupCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreateDBSubnetGroupCommandInput} for command's `input` shape. + * @see {@link CreateDBSubnetGroupCommandOutput} for command's `response` shape. + * @see {@link DocDBClientResolvedConfig | config} for command's `input` shape. + * */ export class CreateDBSubnetGroupCommand extends $Command< CreateDBSubnetGroupCommandInput, diff --git a/clients/client-docdb/commands/DeleteDBClusterCommand.ts b/clients/client-docdb/commands/DeleteDBClusterCommand.ts index 9771dc8f3ad9..8fc654ad15a2 100644 --- a/clients/client-docdb/commands/DeleteDBClusterCommand.ts +++ b/clients/client-docdb/commands/DeleteDBClusterCommand.ts @@ -25,6 +25,20 @@ export interface DeleteDBClusterCommandOutput extends DeleteDBClusterResult, __M * automated backups for that cluster are deleted and can't be recovered. Manual DB * cluster snapshots of the specified cluster are not deleted.

*

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { DocDBClient, DeleteDBClusterCommand } from "@aws-sdk/client-docdb"; // ES Modules import + * // const { DocDBClient, DeleteDBClusterCommand } = require("@aws-sdk/client-docdb"); // CommonJS import + * const client = new DocDBClient(config); + * const command = new DeleteDBClusterCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteDBClusterCommandInput} for command's `input` shape. + * @see {@link DeleteDBClusterCommandOutput} for command's `response` shape. + * @see {@link DocDBClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteDBClusterCommand extends $Command< DeleteDBClusterCommandInput, diff --git a/clients/client-docdb/commands/DeleteDBClusterParameterGroupCommand.ts b/clients/client-docdb/commands/DeleteDBClusterParameterGroupCommand.ts index 890faff23b6c..6b54671a1085 100644 --- a/clients/client-docdb/commands/DeleteDBClusterParameterGroupCommand.ts +++ b/clients/client-docdb/commands/DeleteDBClusterParameterGroupCommand.ts @@ -23,6 +23,20 @@ export interface DeleteDBClusterParameterGroupCommandOutput extends __MetadataBe /** *

Deletes a specified cluster parameter group. The cluster parameter group to be * deleted can't be associated with any clusters.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { DocDBClient, DeleteDBClusterParameterGroupCommand } from "@aws-sdk/client-docdb"; // ES Modules import + * // const { DocDBClient, DeleteDBClusterParameterGroupCommand } = require("@aws-sdk/client-docdb"); // CommonJS import + * const client = new DocDBClient(config); + * const command = new DeleteDBClusterParameterGroupCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteDBClusterParameterGroupCommandInput} for command's `input` shape. + * @see {@link DeleteDBClusterParameterGroupCommandOutput} for command's `response` shape. + * @see {@link DocDBClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteDBClusterParameterGroupCommand extends $Command< DeleteDBClusterParameterGroupCommandInput, diff --git a/clients/client-docdb/commands/DeleteDBClusterSnapshotCommand.ts b/clients/client-docdb/commands/DeleteDBClusterSnapshotCommand.ts index b94113c1f508..4c84dc0ae33a 100644 --- a/clients/client-docdb/commands/DeleteDBClusterSnapshotCommand.ts +++ b/clients/client-docdb/commands/DeleteDBClusterSnapshotCommand.ts @@ -27,6 +27,20 @@ export interface DeleteDBClusterSnapshotCommandOutput extends DeleteDBClusterSna *

The cluster snapshot must be in the available state to be * deleted.

* + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { DocDBClient, DeleteDBClusterSnapshotCommand } from "@aws-sdk/client-docdb"; // ES Modules import + * // const { DocDBClient, DeleteDBClusterSnapshotCommand } = require("@aws-sdk/client-docdb"); // CommonJS import + * const client = new DocDBClient(config); + * const command = new DeleteDBClusterSnapshotCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteDBClusterSnapshotCommandInput} for command's `input` shape. + * @see {@link DeleteDBClusterSnapshotCommandOutput} for command's `response` shape. + * @see {@link DocDBClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteDBClusterSnapshotCommand extends $Command< DeleteDBClusterSnapshotCommandInput, diff --git a/clients/client-docdb/commands/DeleteDBInstanceCommand.ts b/clients/client-docdb/commands/DeleteDBInstanceCommand.ts index 3758339ce6b7..de6186ac730e 100644 --- a/clients/client-docdb/commands/DeleteDBInstanceCommand.ts +++ b/clients/client-docdb/commands/DeleteDBInstanceCommand.ts @@ -23,6 +23,20 @@ export interface DeleteDBInstanceCommandOutput extends DeleteDBInstanceResult, _ /** *

Deletes a previously provisioned instance. *

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { DocDBClient, DeleteDBInstanceCommand } from "@aws-sdk/client-docdb"; // ES Modules import + * // const { DocDBClient, DeleteDBInstanceCommand } = require("@aws-sdk/client-docdb"); // CommonJS import + * const client = new DocDBClient(config); + * const command = new DeleteDBInstanceCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteDBInstanceCommandInput} for command's `input` shape. + * @see {@link DeleteDBInstanceCommandOutput} for command's `response` shape. + * @see {@link DocDBClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteDBInstanceCommand extends $Command< DeleteDBInstanceCommandInput, diff --git a/clients/client-docdb/commands/DeleteDBSubnetGroupCommand.ts b/clients/client-docdb/commands/DeleteDBSubnetGroupCommand.ts index 6b6b3c6eb17a..46ed61ef81fc 100644 --- a/clients/client-docdb/commands/DeleteDBSubnetGroupCommand.ts +++ b/clients/client-docdb/commands/DeleteDBSubnetGroupCommand.ts @@ -26,6 +26,20 @@ export interface DeleteDBSubnetGroupCommandOutput extends __MetadataBearer {} *

The specified database subnet group must not be associated with any DB * instances.

* + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { DocDBClient, DeleteDBSubnetGroupCommand } from "@aws-sdk/client-docdb"; // ES Modules import + * // const { DocDBClient, DeleteDBSubnetGroupCommand } = require("@aws-sdk/client-docdb"); // CommonJS import + * const client = new DocDBClient(config); + * const command = new DeleteDBSubnetGroupCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteDBSubnetGroupCommandInput} for command's `input` shape. + * @see {@link DeleteDBSubnetGroupCommandOutput} for command's `response` shape. + * @see {@link DocDBClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteDBSubnetGroupCommand extends $Command< DeleteDBSubnetGroupCommandInput, diff --git a/clients/client-docdb/commands/DescribeCertificatesCommand.ts b/clients/client-docdb/commands/DescribeCertificatesCommand.ts index 1d3fb942e2fe..e7d56322f0b4 100644 --- a/clients/client-docdb/commands/DescribeCertificatesCommand.ts +++ b/clients/client-docdb/commands/DescribeCertificatesCommand.ts @@ -23,6 +23,20 @@ export interface DescribeCertificatesCommandOutput extends CertificateMessage, _ /** *

Returns a list of certificate authority (CA) certificates provided by Amazon DocumentDB for * this AWS account.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { DocDBClient, DescribeCertificatesCommand } from "@aws-sdk/client-docdb"; // ES Modules import + * // const { DocDBClient, DescribeCertificatesCommand } = require("@aws-sdk/client-docdb"); // CommonJS import + * const client = new DocDBClient(config); + * const command = new DescribeCertificatesCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeCertificatesCommandInput} for command's `input` shape. + * @see {@link DescribeCertificatesCommandOutput} for command's `response` shape. + * @see {@link DocDBClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeCertificatesCommand extends $Command< DescribeCertificatesCommandInput, diff --git a/clients/client-docdb/commands/DescribeDBClusterParameterGroupsCommand.ts b/clients/client-docdb/commands/DescribeDBClusterParameterGroupsCommand.ts index 24bd6e4c59b0..381ca890fe9d 100644 --- a/clients/client-docdb/commands/DescribeDBClusterParameterGroupsCommand.ts +++ b/clients/client-docdb/commands/DescribeDBClusterParameterGroupsCommand.ts @@ -26,6 +26,20 @@ export interface DescribeDBClusterParameterGroupsCommandOutput *

Returns a list of DBClusterParameterGroup descriptions. If a * DBClusterParameterGroupName parameter is specified, the list contains * only the description of the specified cluster parameter group.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { DocDBClient, DescribeDBClusterParameterGroupsCommand } from "@aws-sdk/client-docdb"; // ES Modules import + * // const { DocDBClient, DescribeDBClusterParameterGroupsCommand } = require("@aws-sdk/client-docdb"); // CommonJS import + * const client = new DocDBClient(config); + * const command = new DescribeDBClusterParameterGroupsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeDBClusterParameterGroupsCommandInput} for command's `input` shape. + * @see {@link DescribeDBClusterParameterGroupsCommandOutput} for command's `response` shape. + * @see {@link DocDBClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeDBClusterParameterGroupsCommand extends $Command< DescribeDBClusterParameterGroupsCommandInput, diff --git a/clients/client-docdb/commands/DescribeDBClusterParametersCommand.ts b/clients/client-docdb/commands/DescribeDBClusterParametersCommand.ts index 6edbe21ae921..bfe4c0468ec7 100644 --- a/clients/client-docdb/commands/DescribeDBClusterParametersCommand.ts +++ b/clients/client-docdb/commands/DescribeDBClusterParametersCommand.ts @@ -23,6 +23,20 @@ export interface DescribeDBClusterParametersCommandOutput extends DBClusterParam /** *

Returns the detailed parameter list for a particular cluster parameter * group.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { DocDBClient, DescribeDBClusterParametersCommand } from "@aws-sdk/client-docdb"; // ES Modules import + * // const { DocDBClient, DescribeDBClusterParametersCommand } = require("@aws-sdk/client-docdb"); // CommonJS import + * const client = new DocDBClient(config); + * const command = new DescribeDBClusterParametersCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeDBClusterParametersCommandInput} for command's `input` shape. + * @see {@link DescribeDBClusterParametersCommandOutput} for command's `response` shape. + * @see {@link DocDBClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeDBClusterParametersCommand extends $Command< DescribeDBClusterParametersCommandInput, diff --git a/clients/client-docdb/commands/DescribeDBClusterSnapshotAttributesCommand.ts b/clients/client-docdb/commands/DescribeDBClusterSnapshotAttributesCommand.ts index 92deec963900..5f7147d8741e 100644 --- a/clients/client-docdb/commands/DescribeDBClusterSnapshotAttributesCommand.ts +++ b/clients/client-docdb/commands/DescribeDBClusterSnapshotAttributesCommand.ts @@ -34,6 +34,20 @@ export interface DescribeDBClusterSnapshotAttributesCommandOutput * 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 AWS accounts.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { DocDBClient, DescribeDBClusterSnapshotAttributesCommand } from "@aws-sdk/client-docdb"; // ES Modules import + * // const { DocDBClient, DescribeDBClusterSnapshotAttributesCommand } = require("@aws-sdk/client-docdb"); // CommonJS import + * const client = new DocDBClient(config); + * const command = new DescribeDBClusterSnapshotAttributesCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeDBClusterSnapshotAttributesCommandInput} for command's `input` shape. + * @see {@link DescribeDBClusterSnapshotAttributesCommandOutput} for command's `response` shape. + * @see {@link DocDBClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeDBClusterSnapshotAttributesCommand extends $Command< DescribeDBClusterSnapshotAttributesCommandInput, diff --git a/clients/client-docdb/commands/DescribeDBClusterSnapshotsCommand.ts b/clients/client-docdb/commands/DescribeDBClusterSnapshotsCommand.ts index aca0ca885a99..25eeaee301b9 100644 --- a/clients/client-docdb/commands/DescribeDBClusterSnapshotsCommand.ts +++ b/clients/client-docdb/commands/DescribeDBClusterSnapshotsCommand.ts @@ -23,6 +23,20 @@ export interface DescribeDBClusterSnapshotsCommandOutput extends DBClusterSnapsh /** *

Returns information about cluster snapshots. This API operation supports * pagination.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { DocDBClient, DescribeDBClusterSnapshotsCommand } from "@aws-sdk/client-docdb"; // ES Modules import + * // const { DocDBClient, DescribeDBClusterSnapshotsCommand } = require("@aws-sdk/client-docdb"); // CommonJS import + * const client = new DocDBClient(config); + * const command = new DescribeDBClusterSnapshotsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeDBClusterSnapshotsCommandInput} for command's `input` shape. + * @see {@link DescribeDBClusterSnapshotsCommandOutput} for command's `response` shape. + * @see {@link DocDBClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeDBClusterSnapshotsCommand extends $Command< DescribeDBClusterSnapshotsCommandInput, diff --git a/clients/client-docdb/commands/DescribeDBClustersCommand.ts b/clients/client-docdb/commands/DescribeDBClustersCommand.ts index b7e60ba50ca9..da79e7e234b9 100644 --- a/clients/client-docdb/commands/DescribeDBClustersCommand.ts +++ b/clients/client-docdb/commands/DescribeDBClustersCommand.ts @@ -27,6 +27,20 @@ export interface DescribeDBClustersCommandOutput extends DBClusterMessage, __Met * 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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { DocDBClient, DescribeDBClustersCommand } from "@aws-sdk/client-docdb"; // ES Modules import + * // const { DocDBClient, DescribeDBClustersCommand } = require("@aws-sdk/client-docdb"); // CommonJS import + * const client = new DocDBClient(config); + * const command = new DescribeDBClustersCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeDBClustersCommandInput} for command's `input` shape. + * @see {@link DescribeDBClustersCommandOutput} for command's `response` shape. + * @see {@link DocDBClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeDBClustersCommand extends $Command< DescribeDBClustersCommandInput, diff --git a/clients/client-docdb/commands/DescribeDBEngineVersionsCommand.ts b/clients/client-docdb/commands/DescribeDBEngineVersionsCommand.ts index 6c110f5af0b5..892ce5daa6fb 100644 --- a/clients/client-docdb/commands/DescribeDBEngineVersionsCommand.ts +++ b/clients/client-docdb/commands/DescribeDBEngineVersionsCommand.ts @@ -22,6 +22,20 @@ export interface DescribeDBEngineVersionsCommandOutput extends DBEngineVersionMe /** *

Returns a list of the available engines.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { DocDBClient, DescribeDBEngineVersionsCommand } from "@aws-sdk/client-docdb"; // ES Modules import + * // const { DocDBClient, DescribeDBEngineVersionsCommand } = require("@aws-sdk/client-docdb"); // CommonJS import + * const client = new DocDBClient(config); + * const command = new DescribeDBEngineVersionsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeDBEngineVersionsCommandInput} for command's `input` shape. + * @see {@link DescribeDBEngineVersionsCommandOutput} for command's `response` shape. + * @see {@link DocDBClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeDBEngineVersionsCommand extends $Command< DescribeDBEngineVersionsCommandInput, diff --git a/clients/client-docdb/commands/DescribeDBInstancesCommand.ts b/clients/client-docdb/commands/DescribeDBInstancesCommand.ts index a1e672717062..ad47354974e2 100644 --- a/clients/client-docdb/commands/DescribeDBInstancesCommand.ts +++ b/clients/client-docdb/commands/DescribeDBInstancesCommand.ts @@ -23,6 +23,20 @@ export interface DescribeDBInstancesCommandOutput extends DBInstanceMessage, __M /** *

Returns information about provisioned Amazon DocumentDB instances. This API supports * pagination.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { DocDBClient, DescribeDBInstancesCommand } from "@aws-sdk/client-docdb"; // ES Modules import + * // const { DocDBClient, DescribeDBInstancesCommand } = require("@aws-sdk/client-docdb"); // CommonJS import + * const client = new DocDBClient(config); + * const command = new DescribeDBInstancesCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeDBInstancesCommandInput} for command's `input` shape. + * @see {@link DescribeDBInstancesCommandOutput} for command's `response` shape. + * @see {@link DocDBClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeDBInstancesCommand extends $Command< DescribeDBInstancesCommandInput, diff --git a/clients/client-docdb/commands/DescribeDBSubnetGroupsCommand.ts b/clients/client-docdb/commands/DescribeDBSubnetGroupsCommand.ts index 18459a3f4e41..8dc4ccd533f5 100644 --- a/clients/client-docdb/commands/DescribeDBSubnetGroupsCommand.ts +++ b/clients/client-docdb/commands/DescribeDBSubnetGroupsCommand.ts @@ -24,6 +24,20 @@ export interface DescribeDBSubnetGroupsCommandOutput extends DBSubnetGroupMessag *

Returns a list of DBSubnetGroup descriptions. If a * DBSubnetGroupName is specified, the list will contain only the * descriptions of the specified DBSubnetGroup.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { DocDBClient, DescribeDBSubnetGroupsCommand } from "@aws-sdk/client-docdb"; // ES Modules import + * // const { DocDBClient, DescribeDBSubnetGroupsCommand } = require("@aws-sdk/client-docdb"); // CommonJS import + * const client = new DocDBClient(config); + * const command = new DescribeDBSubnetGroupsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeDBSubnetGroupsCommandInput} for command's `input` shape. + * @see {@link DescribeDBSubnetGroupsCommandOutput} for command's `response` shape. + * @see {@link DocDBClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeDBSubnetGroupsCommand extends $Command< DescribeDBSubnetGroupsCommandInput, diff --git a/clients/client-docdb/commands/DescribeEngineDefaultClusterParametersCommand.ts b/clients/client-docdb/commands/DescribeEngineDefaultClusterParametersCommand.ts index 1f52ca4ef0c2..6e39d2479bc5 100644 --- a/clients/client-docdb/commands/DescribeEngineDefaultClusterParametersCommand.ts +++ b/clients/client-docdb/commands/DescribeEngineDefaultClusterParametersCommand.ts @@ -29,6 +29,20 @@ export interface DescribeEngineDefaultClusterParametersCommandOutput /** *

Returns the default engine and system parameter information for the cluster database * engine.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { DocDBClient, DescribeEngineDefaultClusterParametersCommand } from "@aws-sdk/client-docdb"; // ES Modules import + * // const { DocDBClient, DescribeEngineDefaultClusterParametersCommand } = require("@aws-sdk/client-docdb"); // CommonJS import + * const client = new DocDBClient(config); + * const command = new DescribeEngineDefaultClusterParametersCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeEngineDefaultClusterParametersCommandInput} for command's `input` shape. + * @see {@link DescribeEngineDefaultClusterParametersCommandOutput} for command's `response` shape. + * @see {@link DocDBClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeEngineDefaultClusterParametersCommand extends $Command< DescribeEngineDefaultClusterParametersCommandInput, diff --git a/clients/client-docdb/commands/DescribeEventCategoriesCommand.ts b/clients/client-docdb/commands/DescribeEventCategoriesCommand.ts index 53ccde098f4e..9f706f4a7a18 100644 --- a/clients/client-docdb/commands/DescribeEventCategoriesCommand.ts +++ b/clients/client-docdb/commands/DescribeEventCategoriesCommand.ts @@ -23,6 +23,20 @@ export interface DescribeEventCategoriesCommandOutput extends EventCategoriesMes /** *

Displays a list of categories for all event source types, or, if specified, for a * specified source type.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { DocDBClient, DescribeEventCategoriesCommand } from "@aws-sdk/client-docdb"; // ES Modules import + * // const { DocDBClient, DescribeEventCategoriesCommand } = require("@aws-sdk/client-docdb"); // CommonJS import + * const client = new DocDBClient(config); + * const command = new DescribeEventCategoriesCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeEventCategoriesCommandInput} for command's `input` shape. + * @see {@link DescribeEventCategoriesCommandOutput} for command's `response` shape. + * @see {@link DocDBClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeEventCategoriesCommand extends $Command< DescribeEventCategoriesCommandInput, diff --git a/clients/client-docdb/commands/DescribeEventsCommand.ts b/clients/client-docdb/commands/DescribeEventsCommand.ts index 810fdd3726ec..1549929b6ea8 100644 --- a/clients/client-docdb/commands/DescribeEventsCommand.ts +++ b/clients/client-docdb/commands/DescribeEventsCommand.ts @@ -25,6 +25,20 @@ export interface DescribeEventsCommandOutput extends EventsMessage, __MetadataBe * 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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { DocDBClient, DescribeEventsCommand } from "@aws-sdk/client-docdb"; // ES Modules import + * // const { DocDBClient, DescribeEventsCommand } = require("@aws-sdk/client-docdb"); // CommonJS import + * const client = new DocDBClient(config); + * const command = new DescribeEventsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeEventsCommandInput} for command's `input` shape. + * @see {@link DescribeEventsCommandOutput} for command's `response` shape. + * @see {@link DocDBClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeEventsCommand extends $Command< DescribeEventsCommandInput, diff --git a/clients/client-docdb/commands/DescribeOrderableDBInstanceOptionsCommand.ts b/clients/client-docdb/commands/DescribeOrderableDBInstanceOptionsCommand.ts index 316587516a16..4781a116b864 100644 --- a/clients/client-docdb/commands/DescribeOrderableDBInstanceOptionsCommand.ts +++ b/clients/client-docdb/commands/DescribeOrderableDBInstanceOptionsCommand.ts @@ -24,6 +24,20 @@ export interface DescribeOrderableDBInstanceOptionsCommandOutput /** *

Returns a list of orderable instance options for the specified engine.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { DocDBClient, DescribeOrderableDBInstanceOptionsCommand } from "@aws-sdk/client-docdb"; // ES Modules import + * // const { DocDBClient, DescribeOrderableDBInstanceOptionsCommand } = require("@aws-sdk/client-docdb"); // CommonJS import + * const client = new DocDBClient(config); + * const command = new DescribeOrderableDBInstanceOptionsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeOrderableDBInstanceOptionsCommandInput} for command's `input` shape. + * @see {@link DescribeOrderableDBInstanceOptionsCommandOutput} for command's `response` shape. + * @see {@link DocDBClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeOrderableDBInstanceOptionsCommand extends $Command< DescribeOrderableDBInstanceOptionsCommandInput, diff --git a/clients/client-docdb/commands/DescribePendingMaintenanceActionsCommand.ts b/clients/client-docdb/commands/DescribePendingMaintenanceActionsCommand.ts index f8bed499cf61..723d5feae981 100644 --- a/clients/client-docdb/commands/DescribePendingMaintenanceActionsCommand.ts +++ b/clients/client-docdb/commands/DescribePendingMaintenanceActionsCommand.ts @@ -25,6 +25,20 @@ export interface DescribePendingMaintenanceActionsCommandOutput /** *

Returns a list of resources (for example, instances) that have at least one pending * maintenance action.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { DocDBClient, DescribePendingMaintenanceActionsCommand } from "@aws-sdk/client-docdb"; // ES Modules import + * // const { DocDBClient, DescribePendingMaintenanceActionsCommand } = require("@aws-sdk/client-docdb"); // CommonJS import + * const client = new DocDBClient(config); + * const command = new DescribePendingMaintenanceActionsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribePendingMaintenanceActionsCommandInput} for command's `input` shape. + * @see {@link DescribePendingMaintenanceActionsCommandOutput} for command's `response` shape. + * @see {@link DocDBClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribePendingMaintenanceActionsCommand extends $Command< DescribePendingMaintenanceActionsCommandInput, diff --git a/clients/client-docdb/commands/FailoverDBClusterCommand.ts b/clients/client-docdb/commands/FailoverDBClusterCommand.ts index 9384af4ee871..c631edfdba49 100644 --- a/clients/client-docdb/commands/FailoverDBClusterCommand.ts +++ b/clients/client-docdb/commands/FailoverDBClusterCommand.ts @@ -28,6 +28,20 @@ export interface FailoverDBClusterCommandOutput extends FailoverDBClusterResult, * if one exists. You can force a failover when you want to simulate a failure of a primary * instance for * testing.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { DocDBClient, FailoverDBClusterCommand } from "@aws-sdk/client-docdb"; // ES Modules import + * // const { DocDBClient, FailoverDBClusterCommand } = require("@aws-sdk/client-docdb"); // CommonJS import + * const client = new DocDBClient(config); + * const command = new FailoverDBClusterCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link FailoverDBClusterCommandInput} for command's `input` shape. + * @see {@link FailoverDBClusterCommandOutput} for command's `response` shape. + * @see {@link DocDBClientResolvedConfig | config} for command's `input` shape. + * */ export class FailoverDBClusterCommand extends $Command< FailoverDBClusterCommandInput, diff --git a/clients/client-docdb/commands/ListTagsForResourceCommand.ts b/clients/client-docdb/commands/ListTagsForResourceCommand.ts index 9463a8312cd0..7b8536180e8d 100644 --- a/clients/client-docdb/commands/ListTagsForResourceCommand.ts +++ b/clients/client-docdb/commands/ListTagsForResourceCommand.ts @@ -22,6 +22,20 @@ export interface ListTagsForResourceCommandOutput extends TagListMessage, __Meta /** *

Lists all tags on an Amazon DocumentDB resource.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { DocDBClient, ListTagsForResourceCommand } from "@aws-sdk/client-docdb"; // ES Modules import + * // const { DocDBClient, ListTagsForResourceCommand } = require("@aws-sdk/client-docdb"); // CommonJS import + * const client = new DocDBClient(config); + * const command = new ListTagsForResourceCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListTagsForResourceCommandInput} for command's `input` shape. + * @see {@link ListTagsForResourceCommandOutput} for command's `response` shape. + * @see {@link DocDBClientResolvedConfig | config} for command's `input` shape. + * */ export class ListTagsForResourceCommand extends $Command< ListTagsForResourceCommandInput, diff --git a/clients/client-docdb/commands/ModifyDBClusterCommand.ts b/clients/client-docdb/commands/ModifyDBClusterCommand.ts index d86f080949dc..b09b277ff845 100644 --- a/clients/client-docdb/commands/ModifyDBClusterCommand.ts +++ b/clients/client-docdb/commands/ModifyDBClusterCommand.ts @@ -24,6 +24,20 @@ export interface ModifyDBClusterCommandOutput extends ModifyDBClusterResult, __M *

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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { DocDBClient, ModifyDBClusterCommand } from "@aws-sdk/client-docdb"; // ES Modules import + * // const { DocDBClient, ModifyDBClusterCommand } = require("@aws-sdk/client-docdb"); // CommonJS import + * const client = new DocDBClient(config); + * const command = new ModifyDBClusterCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ModifyDBClusterCommandInput} for command's `input` shape. + * @see {@link ModifyDBClusterCommandOutput} for command's `response` shape. + * @see {@link DocDBClientResolvedConfig | config} for command's `input` shape. + * */ export class ModifyDBClusterCommand extends $Command< ModifyDBClusterCommandInput, diff --git a/clients/client-docdb/commands/ModifyDBClusterParameterGroupCommand.ts b/clients/client-docdb/commands/ModifyDBClusterParameterGroupCommand.ts index 149d4a8061ce..5ec8083bee70 100644 --- a/clients/client-docdb/commands/ModifyDBClusterParameterGroupCommand.ts +++ b/clients/client-docdb/commands/ModifyDBClusterParameterGroupCommand.ts @@ -42,6 +42,20 @@ export interface ModifyDBClusterParameterGroupCommandOutput * database for a cluster, such as the character set for the default database * defined by the character_set_database parameter.

* + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { DocDBClient, ModifyDBClusterParameterGroupCommand } from "@aws-sdk/client-docdb"; // ES Modules import + * // const { DocDBClient, ModifyDBClusterParameterGroupCommand } = require("@aws-sdk/client-docdb"); // CommonJS import + * const client = new DocDBClient(config); + * const command = new ModifyDBClusterParameterGroupCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ModifyDBClusterParameterGroupCommandInput} for command's `input` shape. + * @see {@link ModifyDBClusterParameterGroupCommandOutput} for command's `response` shape. + * @see {@link DocDBClientResolvedConfig | config} for command's `input` shape. + * */ export class ModifyDBClusterParameterGroupCommand extends $Command< ModifyDBClusterParameterGroupCommandInput, diff --git a/clients/client-docdb/commands/ModifyDBClusterSnapshotAttributeCommand.ts b/clients/client-docdb/commands/ModifyDBClusterSnapshotAttributeCommand.ts index 7b25c8fbf068..7c6516f24e7f 100644 --- a/clients/client-docdb/commands/ModifyDBClusterSnapshotAttributeCommand.ts +++ b/clients/client-docdb/commands/ModifyDBClusterSnapshotAttributeCommand.ts @@ -36,6 +36,20 @@ export interface ModifyDBClusterSnapshotAttributeCommandOutput * by specifying a list of authorized AWS account IDs for the ValuesToAdd * parameter. You can't use all as a value for that parameter in this * case.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { DocDBClient, ModifyDBClusterSnapshotAttributeCommand } from "@aws-sdk/client-docdb"; // ES Modules import + * // const { DocDBClient, ModifyDBClusterSnapshotAttributeCommand } = require("@aws-sdk/client-docdb"); // CommonJS import + * const client = new DocDBClient(config); + * const command = new ModifyDBClusterSnapshotAttributeCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ModifyDBClusterSnapshotAttributeCommandInput} for command's `input` shape. + * @see {@link ModifyDBClusterSnapshotAttributeCommandOutput} for command's `response` shape. + * @see {@link DocDBClientResolvedConfig | config} for command's `input` shape. + * */ export class ModifyDBClusterSnapshotAttributeCommand extends $Command< ModifyDBClusterSnapshotAttributeCommandInput, diff --git a/clients/client-docdb/commands/ModifyDBInstanceCommand.ts b/clients/client-docdb/commands/ModifyDBInstanceCommand.ts index 4f1510758ab8..1f24104927a8 100644 --- a/clients/client-docdb/commands/ModifyDBInstanceCommand.ts +++ b/clients/client-docdb/commands/ModifyDBInstanceCommand.ts @@ -23,6 +23,20 @@ export interface ModifyDBInstanceCommandOutput extends ModifyDBInstanceResult, _ /** *

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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { DocDBClient, ModifyDBInstanceCommand } from "@aws-sdk/client-docdb"; // ES Modules import + * // const { DocDBClient, ModifyDBInstanceCommand } = require("@aws-sdk/client-docdb"); // CommonJS import + * const client = new DocDBClient(config); + * const command = new ModifyDBInstanceCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ModifyDBInstanceCommandInput} for command's `input` shape. + * @see {@link ModifyDBInstanceCommandOutput} for command's `response` shape. + * @see {@link DocDBClientResolvedConfig | config} for command's `input` shape. + * */ export class ModifyDBInstanceCommand extends $Command< ModifyDBInstanceCommandInput, diff --git a/clients/client-docdb/commands/ModifyDBSubnetGroupCommand.ts b/clients/client-docdb/commands/ModifyDBSubnetGroupCommand.ts index 6ae44bc06609..22b238666142 100644 --- a/clients/client-docdb/commands/ModifyDBSubnetGroupCommand.ts +++ b/clients/client-docdb/commands/ModifyDBSubnetGroupCommand.ts @@ -23,6 +23,20 @@ export interface ModifyDBSubnetGroupCommandOutput extends ModifyDBSubnetGroupRes /** *

Modifies an existing subnet group. subnet groups must contain at least one * subnet in at least two Availability Zones in the AWS Region.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { DocDBClient, ModifyDBSubnetGroupCommand } from "@aws-sdk/client-docdb"; // ES Modules import + * // const { DocDBClient, ModifyDBSubnetGroupCommand } = require("@aws-sdk/client-docdb"); // CommonJS import + * const client = new DocDBClient(config); + * const command = new ModifyDBSubnetGroupCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ModifyDBSubnetGroupCommandInput} for command's `input` shape. + * @see {@link ModifyDBSubnetGroupCommandOutput} for command's `response` shape. + * @see {@link DocDBClientResolvedConfig | config} for command's `input` shape. + * */ export class ModifyDBSubnetGroupCommand extends $Command< ModifyDBSubnetGroupCommandInput, diff --git a/clients/client-docdb/commands/RebootDBInstanceCommand.ts b/clients/client-docdb/commands/RebootDBInstanceCommand.ts index 6fb23d01c53b..309f81596807 100644 --- a/clients/client-docdb/commands/RebootDBInstanceCommand.ts +++ b/clients/client-docdb/commands/RebootDBInstanceCommand.ts @@ -28,6 +28,20 @@ export interface RebootDBInstanceCommandOutput extends RebootDBInstanceResult, _ *

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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { DocDBClient, RebootDBInstanceCommand } from "@aws-sdk/client-docdb"; // ES Modules import + * // const { DocDBClient, RebootDBInstanceCommand } = require("@aws-sdk/client-docdb"); // CommonJS import + * const client = new DocDBClient(config); + * const command = new RebootDBInstanceCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link RebootDBInstanceCommandInput} for command's `input` shape. + * @see {@link RebootDBInstanceCommandOutput} for command's `response` shape. + * @see {@link DocDBClientResolvedConfig | config} for command's `input` shape. + * */ export class RebootDBInstanceCommand extends $Command< RebootDBInstanceCommandInput, diff --git a/clients/client-docdb/commands/RemoveTagsFromResourceCommand.ts b/clients/client-docdb/commands/RemoveTagsFromResourceCommand.ts index aadf08229bee..3a70b6e426ba 100644 --- a/clients/client-docdb/commands/RemoveTagsFromResourceCommand.ts +++ b/clients/client-docdb/commands/RemoveTagsFromResourceCommand.ts @@ -22,6 +22,20 @@ export interface RemoveTagsFromResourceCommandOutput extends __MetadataBearer {} /** *

Removes metadata tags from an Amazon DocumentDB resource.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { DocDBClient, RemoveTagsFromResourceCommand } from "@aws-sdk/client-docdb"; // ES Modules import + * // const { DocDBClient, RemoveTagsFromResourceCommand } = require("@aws-sdk/client-docdb"); // CommonJS import + * const client = new DocDBClient(config); + * const command = new RemoveTagsFromResourceCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link RemoveTagsFromResourceCommandInput} for command's `input` shape. + * @see {@link RemoveTagsFromResourceCommandOutput} for command's `response` shape. + * @see {@link DocDBClientResolvedConfig | config} for command's `input` shape. + * */ export class RemoveTagsFromResourceCommand extends $Command< RemoveTagsFromResourceCommandInput, diff --git a/clients/client-docdb/commands/ResetDBClusterParameterGroupCommand.ts b/clients/client-docdb/commands/ResetDBClusterParameterGroupCommand.ts index a60a9419a8c4..b5b4a36ccaae 100644 --- a/clients/client-docdb/commands/ResetDBClusterParameterGroupCommand.ts +++ b/clients/client-docdb/commands/ResetDBClusterParameterGroupCommand.ts @@ -31,6 +31,20 @@ export interface ResetDBClusterParameterGroupCommandOutput *

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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { DocDBClient, ResetDBClusterParameterGroupCommand } from "@aws-sdk/client-docdb"; // ES Modules import + * // const { DocDBClient, ResetDBClusterParameterGroupCommand } = require("@aws-sdk/client-docdb"); // CommonJS import + * const client = new DocDBClient(config); + * const command = new ResetDBClusterParameterGroupCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ResetDBClusterParameterGroupCommandInput} for command's `input` shape. + * @see {@link ResetDBClusterParameterGroupCommandOutput} for command's `response` shape. + * @see {@link DocDBClientResolvedConfig | config} for command's `input` shape. + * */ export class ResetDBClusterParameterGroupCommand extends $Command< ResetDBClusterParameterGroupCommandInput, diff --git a/clients/client-docdb/commands/RestoreDBClusterFromSnapshotCommand.ts b/clients/client-docdb/commands/RestoreDBClusterFromSnapshotCommand.ts index 058e1e50cb73..7b3981f2cbf6 100644 --- a/clients/client-docdb/commands/RestoreDBClusterFromSnapshotCommand.ts +++ b/clients/client-docdb/commands/RestoreDBClusterFromSnapshotCommand.ts @@ -30,6 +30,20 @@ export interface RestoreDBClusterFromSnapshotCommandOutput * 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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { DocDBClient, RestoreDBClusterFromSnapshotCommand } from "@aws-sdk/client-docdb"; // ES Modules import + * // const { DocDBClient, RestoreDBClusterFromSnapshotCommand } = require("@aws-sdk/client-docdb"); // CommonJS import + * const client = new DocDBClient(config); + * const command = new RestoreDBClusterFromSnapshotCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link RestoreDBClusterFromSnapshotCommandInput} for command's `input` shape. + * @see {@link RestoreDBClusterFromSnapshotCommandOutput} for command's `response` shape. + * @see {@link DocDBClientResolvedConfig | config} for command's `input` shape. + * */ export class RestoreDBClusterFromSnapshotCommand extends $Command< RestoreDBClusterFromSnapshotCommandInput, diff --git a/clients/client-docdb/commands/RestoreDBClusterToPointInTimeCommand.ts b/clients/client-docdb/commands/RestoreDBClusterToPointInTimeCommand.ts index 6e47eaf250c2..d24e27c91208 100644 --- a/clients/client-docdb/commands/RestoreDBClusterToPointInTimeCommand.ts +++ b/clients/client-docdb/commands/RestoreDBClusterToPointInTimeCommand.ts @@ -28,6 +28,20 @@ export interface RestoreDBClusterToPointInTimeCommandOutput * 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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { DocDBClient, RestoreDBClusterToPointInTimeCommand } from "@aws-sdk/client-docdb"; // ES Modules import + * // const { DocDBClient, RestoreDBClusterToPointInTimeCommand } = require("@aws-sdk/client-docdb"); // CommonJS import + * const client = new DocDBClient(config); + * const command = new RestoreDBClusterToPointInTimeCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link RestoreDBClusterToPointInTimeCommandInput} for command's `input` shape. + * @see {@link RestoreDBClusterToPointInTimeCommandOutput} for command's `response` shape. + * @see {@link DocDBClientResolvedConfig | config} for command's `input` shape. + * */ export class RestoreDBClusterToPointInTimeCommand extends $Command< RestoreDBClusterToPointInTimeCommandInput, diff --git a/clients/client-docdb/commands/StartDBClusterCommand.ts b/clients/client-docdb/commands/StartDBClusterCommand.ts index 1365d3ff72a8..08fe66b2f7d9 100644 --- a/clients/client-docdb/commands/StartDBClusterCommand.ts +++ b/clients/client-docdb/commands/StartDBClusterCommand.ts @@ -24,6 +24,20 @@ export interface StartDBClusterCommandOutput extends StartDBClusterResult, __Met *

Restarts the stopped cluster that is specified by DBClusterIdentifier. * For more information, see Stopping and * Starting an Amazon DocumentDB Cluster.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { DocDBClient, StartDBClusterCommand } from "@aws-sdk/client-docdb"; // ES Modules import + * // const { DocDBClient, StartDBClusterCommand } = require("@aws-sdk/client-docdb"); // CommonJS import + * const client = new DocDBClient(config); + * const command = new StartDBClusterCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link StartDBClusterCommandInput} for command's `input` shape. + * @see {@link StartDBClusterCommandOutput} for command's `response` shape. + * @see {@link DocDBClientResolvedConfig | config} for command's `input` shape. + * */ export class StartDBClusterCommand extends $Command< StartDBClusterCommandInput, diff --git a/clients/client-docdb/commands/StopDBClusterCommand.ts b/clients/client-docdb/commands/StopDBClusterCommand.ts index da52bca13f6b..9191cd058d72 100644 --- a/clients/client-docdb/commands/StopDBClusterCommand.ts +++ b/clients/client-docdb/commands/StopDBClusterCommand.ts @@ -25,6 +25,20 @@ export interface StopDBClusterCommandOutput extends StopDBClusterResult, __Metad * cluster must be in the available state. For more information, see * Stopping and * Starting an Amazon DocumentDB Cluster.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { DocDBClient, StopDBClusterCommand } from "@aws-sdk/client-docdb"; // ES Modules import + * // const { DocDBClient, StopDBClusterCommand } = require("@aws-sdk/client-docdb"); // CommonJS import + * const client = new DocDBClient(config); + * const command = new StopDBClusterCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link StopDBClusterCommandInput} for command's `input` shape. + * @see {@link StopDBClusterCommandOutput} for command's `response` shape. + * @see {@link DocDBClientResolvedConfig | config} for command's `input` shape. + * */ export class StopDBClusterCommand extends $Command< StopDBClusterCommandInput, diff --git a/clients/client-docdb/models/models_0.ts b/clients/client-docdb/models/models_0.ts index 29acc4afe07c..b073b6ce8f13 100644 --- a/clients/client-docdb/models/models_0.ts +++ b/clients/client-docdb/models/models_0.ts @@ -23,6 +23,9 @@ export interface Tag { } export namespace Tag { + /** + * @internal + */ export const filterSensitiveLog = (obj: Tag): any => ({ ...obj, }); @@ -46,6 +49,9 @@ export interface AddTagsToResourceMessage { } export namespace AddTagsToResourceMessage { + /** + * @internal + */ export const filterSensitiveLog = (obj: AddTagsToResourceMessage): any => ({ ...obj, }); @@ -62,6 +68,9 @@ export interface DBClusterNotFoundFault extends __SmithyException, $MetadataBear } export namespace DBClusterNotFoundFault { + /** + * @internal + */ export const filterSensitiveLog = (obj: DBClusterNotFoundFault): any => ({ ...obj, }); @@ -78,6 +87,9 @@ export interface DBInstanceNotFoundFault extends __SmithyException, $MetadataBea } export namespace DBInstanceNotFoundFault { + /** + * @internal + */ export const filterSensitiveLog = (obj: DBInstanceNotFoundFault): any => ({ ...obj, }); @@ -94,6 +106,9 @@ export interface DBSnapshotNotFoundFault extends __SmithyException, $MetadataBea } export namespace DBSnapshotNotFoundFault { + /** + * @internal + */ export const filterSensitiveLog = (obj: DBSnapshotNotFoundFault): any => ({ ...obj, }); @@ -145,6 +160,9 @@ export interface ApplyPendingMaintenanceActionMessage { } export namespace ApplyPendingMaintenanceActionMessage { + /** + * @internal + */ export const filterSensitiveLog = (obj: ApplyPendingMaintenanceActionMessage): any => ({ ...obj, }); @@ -192,6 +210,9 @@ export interface PendingMaintenanceAction { } export namespace PendingMaintenanceAction { + /** + * @internal + */ export const filterSensitiveLog = (obj: PendingMaintenanceAction): any => ({ ...obj, }); @@ -216,6 +237,9 @@ export interface ResourcePendingMaintenanceActions { } export namespace ResourcePendingMaintenanceActions { + /** + * @internal + */ export const filterSensitiveLog = (obj: ResourcePendingMaintenanceActions): any => ({ ...obj, }); @@ -230,6 +254,9 @@ export interface ApplyPendingMaintenanceActionResult { } export namespace ApplyPendingMaintenanceActionResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: ApplyPendingMaintenanceActionResult): any => ({ ...obj, }); @@ -245,6 +272,9 @@ export interface InvalidDBClusterStateFault extends __SmithyException, $Metadata } export namespace InvalidDBClusterStateFault { + /** + * @internal + */ export const filterSensitiveLog = (obj: InvalidDBClusterStateFault): any => ({ ...obj, }); @@ -261,6 +291,9 @@ export interface InvalidDBInstanceStateFault extends __SmithyException, $Metadat } export namespace InvalidDBInstanceStateFault { + /** + * @internal + */ export const filterSensitiveLog = (obj: InvalidDBInstanceStateFault): any => ({ ...obj, }); @@ -276,6 +309,9 @@ export interface ResourceNotFoundFault extends __SmithyException, $MetadataBeare } export namespace ResourceNotFoundFault { + /** + * @internal + */ export const filterSensitiveLog = (obj: ResourceNotFoundFault): any => ({ ...obj, }); @@ -346,6 +382,9 @@ export interface CopyDBClusterParameterGroupMessage { } export namespace CopyDBClusterParameterGroupMessage { + /** + * @internal + */ export const filterSensitiveLog = (obj: CopyDBClusterParameterGroupMessage): any => ({ ...obj, }); @@ -379,6 +418,9 @@ export interface DBClusterParameterGroup { } export namespace DBClusterParameterGroup { + /** + * @internal + */ export const filterSensitiveLog = (obj: DBClusterParameterGroup): any => ({ ...obj, }); @@ -392,6 +434,9 @@ export interface CopyDBClusterParameterGroupResult { } export namespace CopyDBClusterParameterGroupResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: CopyDBClusterParameterGroupResult): any => ({ ...obj, }); @@ -407,6 +452,9 @@ export interface DBParameterGroupAlreadyExistsFault extends __SmithyException, $ } export namespace DBParameterGroupAlreadyExistsFault { + /** + * @internal + */ export const filterSensitiveLog = (obj: DBParameterGroupAlreadyExistsFault): any => ({ ...obj, }); @@ -424,6 +472,9 @@ export interface DBParameterGroupNotFoundFault extends __SmithyException, $Metad } export namespace DBParameterGroupNotFoundFault { + /** + * @internal + */ export const filterSensitiveLog = (obj: DBParameterGroupNotFoundFault): any => ({ ...obj, }); @@ -440,6 +491,9 @@ export interface DBParameterGroupQuotaExceededFault extends __SmithyException, $ } export namespace DBParameterGroupQuotaExceededFault { + /** + * @internal + */ export const filterSensitiveLog = (obj: DBParameterGroupQuotaExceededFault): any => ({ ...obj, }); @@ -587,6 +641,9 @@ export interface CopyDBClusterSnapshotMessage { } export namespace CopyDBClusterSnapshotMessage { + /** + * @internal + */ export const filterSensitiveLog = (obj: CopyDBClusterSnapshotMessage): any => ({ ...obj, }); @@ -690,6 +747,9 @@ export interface DBClusterSnapshot { } export namespace DBClusterSnapshot { + /** + * @internal + */ export const filterSensitiveLog = (obj: DBClusterSnapshot): any => ({ ...obj, }); @@ -703,6 +763,9 @@ export interface CopyDBClusterSnapshotResult { } export namespace CopyDBClusterSnapshotResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: CopyDBClusterSnapshotResult): any => ({ ...obj, }); @@ -718,6 +781,9 @@ export interface DBClusterSnapshotAlreadyExistsFault extends __SmithyException, } export namespace DBClusterSnapshotAlreadyExistsFault { + /** + * @internal + */ export const filterSensitiveLog = (obj: DBClusterSnapshotAlreadyExistsFault): any => ({ ...obj, }); @@ -735,6 +801,9 @@ export interface DBClusterSnapshotNotFoundFault extends __SmithyException, $Meta } export namespace DBClusterSnapshotNotFoundFault { + /** + * @internal + */ export const filterSensitiveLog = (obj: DBClusterSnapshotNotFoundFault): any => ({ ...obj, }); @@ -750,6 +819,9 @@ export interface InvalidDBClusterSnapshotStateFault extends __SmithyException, $ } export namespace InvalidDBClusterSnapshotStateFault { + /** + * @internal + */ export const filterSensitiveLog = (obj: InvalidDBClusterSnapshotStateFault): any => ({ ...obj, }); @@ -765,6 +837,9 @@ export interface KMSKeyNotAccessibleFault extends __SmithyException, $MetadataBe } export namespace KMSKeyNotAccessibleFault { + /** + * @internal + */ export const filterSensitiveLog = (obj: KMSKeyNotAccessibleFault): any => ({ ...obj, }); @@ -780,6 +855,9 @@ export interface SnapshotQuotaExceededFault extends __SmithyException, $Metadata } export namespace SnapshotQuotaExceededFault { + /** + * @internal + */ export const filterSensitiveLog = (obj: SnapshotQuotaExceededFault): any => ({ ...obj, }); @@ -994,6 +1072,9 @@ export interface CreateDBClusterMessage { } export namespace CreateDBClusterMessage { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateDBClusterMessage): any => ({ ...obj, }); @@ -1036,6 +1117,9 @@ export interface DBClusterRole { } export namespace DBClusterRole { + /** + * @internal + */ export const filterSensitiveLog = (obj: DBClusterRole): any => ({ ...obj, }); @@ -1070,6 +1154,9 @@ export interface DBClusterMember { } export namespace DBClusterMember { + /** + * @internal + */ export const filterSensitiveLog = (obj: DBClusterMember): any => ({ ...obj, }); @@ -1092,6 +1179,9 @@ export interface VpcSecurityGroupMembership { } export namespace VpcSecurityGroupMembership { + /** + * @internal + */ export const filterSensitiveLog = (obj: VpcSecurityGroupMembership): any => ({ ...obj, }); @@ -1274,6 +1364,9 @@ export interface DBCluster { } export namespace DBCluster { + /** + * @internal + */ export const filterSensitiveLog = (obj: DBCluster): any => ({ ...obj, }); @@ -1287,6 +1380,9 @@ export interface CreateDBClusterResult { } export namespace CreateDBClusterResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateDBClusterResult): any => ({ ...obj, }); @@ -1302,6 +1398,9 @@ export interface DBClusterAlreadyExistsFault extends __SmithyException, $Metadat } export namespace DBClusterAlreadyExistsFault { + /** + * @internal + */ export const filterSensitiveLog = (obj: DBClusterAlreadyExistsFault): any => ({ ...obj, }); @@ -1319,6 +1418,9 @@ export interface DBClusterParameterGroupNotFoundFault extends __SmithyException, } export namespace DBClusterParameterGroupNotFoundFault { + /** + * @internal + */ export const filterSensitiveLog = (obj: DBClusterParameterGroupNotFoundFault): any => ({ ...obj, }); @@ -1335,6 +1437,9 @@ export interface DBClusterQuotaExceededFault extends __SmithyException, $Metadat } export namespace DBClusterQuotaExceededFault { + /** + * @internal + */ export const filterSensitiveLog = (obj: DBClusterQuotaExceededFault): any => ({ ...obj, }); @@ -1351,6 +1456,9 @@ export interface DBSubnetGroupDoesNotCoverEnoughAZs extends __SmithyException, $ } export namespace DBSubnetGroupDoesNotCoverEnoughAZs { + /** + * @internal + */ export const filterSensitiveLog = (obj: DBSubnetGroupDoesNotCoverEnoughAZs): any => ({ ...obj, }); @@ -1367,6 +1475,9 @@ export interface DBSubnetGroupNotFoundFault extends __SmithyException, $Metadata } export namespace DBSubnetGroupNotFoundFault { + /** + * @internal + */ export const filterSensitiveLog = (obj: DBSubnetGroupNotFoundFault): any => ({ ...obj, }); @@ -1384,6 +1495,9 @@ export interface InsufficientStorageClusterCapacityFault extends __SmithyExcepti } export namespace InsufficientStorageClusterCapacityFault { + /** + * @internal + */ export const filterSensitiveLog = (obj: InsufficientStorageClusterCapacityFault): any => ({ ...obj, }); @@ -1399,6 +1513,9 @@ export interface InvalidDBSubnetGroupStateFault extends __SmithyException, $Meta } export namespace InvalidDBSubnetGroupStateFault { + /** + * @internal + */ export const filterSensitiveLog = (obj: InvalidDBSubnetGroupStateFault): any => ({ ...obj, }); @@ -1415,6 +1532,9 @@ export interface InvalidSubnet extends __SmithyException, $MetadataBearer { } export namespace InvalidSubnet { + /** + * @internal + */ export const filterSensitiveLog = (obj: InvalidSubnet): any => ({ ...obj, }); @@ -1431,6 +1551,9 @@ export interface InvalidVPCNetworkStateFault extends __SmithyException, $Metadat } export namespace InvalidVPCNetworkStateFault { + /** + * @internal + */ export const filterSensitiveLog = (obj: InvalidVPCNetworkStateFault): any => ({ ...obj, }); @@ -1447,6 +1570,9 @@ export interface StorageQuotaExceededFault extends __SmithyException, $MetadataB } export namespace StorageQuotaExceededFault { + /** + * @internal + */ export const filterSensitiveLog = (obj: StorageQuotaExceededFault): any => ({ ...obj, }); @@ -1488,6 +1614,9 @@ export interface CreateDBClusterParameterGroupMessage { } export namespace CreateDBClusterParameterGroupMessage { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateDBClusterParameterGroupMessage): any => ({ ...obj, }); @@ -1501,6 +1630,9 @@ export interface CreateDBClusterParameterGroupResult { } export namespace CreateDBClusterParameterGroupResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateDBClusterParameterGroupResult): any => ({ ...obj, }); @@ -1553,6 +1685,9 @@ export interface CreateDBClusterSnapshotMessage { } export namespace CreateDBClusterSnapshotMessage { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateDBClusterSnapshotMessage): any => ({ ...obj, }); @@ -1566,6 +1701,9 @@ export interface CreateDBClusterSnapshotResult { } export namespace CreateDBClusterSnapshotResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateDBClusterSnapshotResult): any => ({ ...obj, }); @@ -1584,6 +1722,9 @@ export interface AuthorizationNotFoundFault extends __SmithyException, $Metadata } export namespace AuthorizationNotFoundFault { + /** + * @internal + */ export const filterSensitiveLog = (obj: AuthorizationNotFoundFault): any => ({ ...obj, }); @@ -1674,6 +1815,9 @@ export interface CreateDBInstanceMessage { } export namespace CreateDBInstanceMessage { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateDBInstanceMessage): any => ({ ...obj, }); @@ -1690,6 +1834,9 @@ export interface AvailabilityZone { } export namespace AvailabilityZone { + /** + * @internal + */ export const filterSensitiveLog = (obj: AvailabilityZone): any => ({ ...obj, }); @@ -1716,6 +1863,9 @@ export interface Subnet { } export namespace Subnet { + /** + * @internal + */ export const filterSensitiveLog = (obj: Subnet): any => ({ ...obj, }); @@ -1757,6 +1907,9 @@ export interface DBSubnetGroup { } export namespace DBSubnetGroup { + /** + * @internal + */ export const filterSensitiveLog = (obj: DBSubnetGroup): any => ({ ...obj, }); @@ -1784,6 +1937,9 @@ export interface Endpoint { } export namespace Endpoint { + /** + * @internal + */ export const filterSensitiveLog = (obj: Endpoint): any => ({ ...obj, }); @@ -1808,6 +1964,9 @@ export interface PendingCloudwatchLogsExports { } export namespace PendingCloudwatchLogsExports { + /** + * @internal + */ export const filterSensitiveLog = (obj: PendingCloudwatchLogsExports): any => ({ ...obj, }); @@ -1900,6 +2059,9 @@ export interface PendingModifiedValues { } export namespace PendingModifiedValues { + /** + * @internal + */ export const filterSensitiveLog = (obj: PendingModifiedValues): any => ({ ...obj, }); @@ -1935,6 +2097,9 @@ export interface DBInstanceStatusInfo { } export namespace DBInstanceStatusInfo { + /** + * @internal + */ export const filterSensitiveLog = (obj: DBInstanceStatusInfo): any => ({ ...obj, }); @@ -2091,6 +2256,9 @@ export interface DBInstance { } export namespace DBInstance { + /** + * @internal + */ export const filterSensitiveLog = (obj: DBInstance): any => ({ ...obj, }); @@ -2104,6 +2272,9 @@ export interface CreateDBInstanceResult { } export namespace CreateDBInstanceResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateDBInstanceResult): any => ({ ...obj, }); @@ -2119,6 +2290,9 @@ export interface DBInstanceAlreadyExistsFault extends __SmithyException, $Metada } export namespace DBInstanceAlreadyExistsFault { + /** + * @internal + */ export const filterSensitiveLog = (obj: DBInstanceAlreadyExistsFault): any => ({ ...obj, }); @@ -2135,6 +2309,9 @@ export interface DBSecurityGroupNotFoundFault extends __SmithyException, $Metada } export namespace DBSecurityGroupNotFoundFault { + /** + * @internal + */ export const filterSensitiveLog = (obj: DBSecurityGroupNotFoundFault): any => ({ ...obj, }); @@ -2150,6 +2327,9 @@ export interface InstanceQuotaExceededFault extends __SmithyException, $Metadata } export namespace InstanceQuotaExceededFault { + /** + * @internal + */ export const filterSensitiveLog = (obj: InstanceQuotaExceededFault): any => ({ ...obj, }); @@ -2166,6 +2346,9 @@ export interface InsufficientDBInstanceCapacityFault extends __SmithyException, } export namespace InsufficientDBInstanceCapacityFault { + /** + * @internal + */ export const filterSensitiveLog = (obj: InsufficientDBInstanceCapacityFault): any => ({ ...obj, }); @@ -2182,6 +2365,9 @@ export interface StorageTypeNotSupportedFault extends __SmithyException, $Metada } export namespace StorageTypeNotSupportedFault { + /** + * @internal + */ export const filterSensitiveLog = (obj: StorageTypeNotSupportedFault): any => ({ ...obj, }); @@ -2217,6 +2403,9 @@ export interface CreateDBSubnetGroupMessage { } export namespace CreateDBSubnetGroupMessage { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateDBSubnetGroupMessage): any => ({ ...obj, }); @@ -2230,6 +2419,9 @@ export interface CreateDBSubnetGroupResult { } export namespace CreateDBSubnetGroupResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateDBSubnetGroupResult): any => ({ ...obj, }); @@ -2246,6 +2438,9 @@ export interface DBSubnetGroupAlreadyExistsFault extends __SmithyException, $Met } export namespace DBSubnetGroupAlreadyExistsFault { + /** + * @internal + */ export const filterSensitiveLog = (obj: DBSubnetGroupAlreadyExistsFault): any => ({ ...obj, }); @@ -2261,6 +2456,9 @@ export interface DBSubnetGroupQuotaExceededFault extends __SmithyException, $Met } export namespace DBSubnetGroupQuotaExceededFault { + /** + * @internal + */ export const filterSensitiveLog = (obj: DBSubnetGroupQuotaExceededFault): any => ({ ...obj, }); @@ -2277,6 +2475,9 @@ export interface DBSubnetQuotaExceededFault extends __SmithyException, $Metadata } export namespace DBSubnetQuotaExceededFault { + /** + * @internal + */ export const filterSensitiveLog = (obj: DBSubnetQuotaExceededFault): any => ({ ...obj, }); @@ -2336,6 +2537,9 @@ export interface DeleteDBClusterMessage { } export namespace DeleteDBClusterMessage { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteDBClusterMessage): any => ({ ...obj, }); @@ -2349,6 +2553,9 @@ export interface DeleteDBClusterResult { } export namespace DeleteDBClusterResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteDBClusterResult): any => ({ ...obj, }); @@ -2377,6 +2584,9 @@ export interface DeleteDBClusterParameterGroupMessage { } export namespace DeleteDBClusterParameterGroupMessage { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteDBClusterParameterGroupMessage): any => ({ ...obj, }); @@ -2394,6 +2604,9 @@ export interface InvalidDBParameterGroupStateFault extends __SmithyException, $M } export namespace InvalidDBParameterGroupStateFault { + /** + * @internal + */ export const filterSensitiveLog = (obj: InvalidDBParameterGroupStateFault): any => ({ ...obj, }); @@ -2412,6 +2625,9 @@ export interface DeleteDBClusterSnapshotMessage { } export namespace DeleteDBClusterSnapshotMessage { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteDBClusterSnapshotMessage): any => ({ ...obj, }); @@ -2425,6 +2641,9 @@ export interface DeleteDBClusterSnapshotResult { } export namespace DeleteDBClusterSnapshotResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteDBClusterSnapshotResult): any => ({ ...obj, }); @@ -2441,6 +2660,9 @@ export interface DBSnapshotAlreadyExistsFault extends __SmithyException, $Metada } export namespace DBSnapshotAlreadyExistsFault { + /** + * @internal + */ export const filterSensitiveLog = (obj: DBSnapshotAlreadyExistsFault): any => ({ ...obj, }); @@ -2464,6 +2686,9 @@ export interface DeleteDBInstanceMessage { } export namespace DeleteDBInstanceMessage { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteDBInstanceMessage): any => ({ ...obj, }); @@ -2477,6 +2702,9 @@ export interface DeleteDBInstanceResult { } export namespace DeleteDBInstanceResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteDBInstanceResult): any => ({ ...obj, }); @@ -2501,6 +2729,9 @@ export interface DeleteDBSubnetGroupMessage { } export namespace DeleteDBSubnetGroupMessage { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteDBSubnetGroupMessage): any => ({ ...obj, }); @@ -2516,6 +2747,9 @@ export interface InvalidDBSubnetStateFault extends __SmithyException, $MetadataB } export namespace InvalidDBSubnetStateFault { + /** + * @internal + */ export const filterSensitiveLog = (obj: InvalidDBSubnetStateFault): any => ({ ...obj, }); @@ -2567,6 +2801,9 @@ export interface Certificate { } export namespace Certificate { + /** + * @internal + */ export const filterSensitiveLog = (obj: Certificate): any => ({ ...obj, }); @@ -2588,6 +2825,9 @@ export interface CertificateMessage { } export namespace CertificateMessage { + /** + * @internal + */ export const filterSensitiveLog = (obj: CertificateMessage): any => ({ ...obj, }); @@ -2604,6 +2844,9 @@ export interface CertificateNotFoundFault extends __SmithyException, $MetadataBe } export namespace CertificateNotFoundFault { + /** + * @internal + */ export const filterSensitiveLog = (obj: CertificateNotFoundFault): any => ({ ...obj, }); @@ -2627,6 +2870,9 @@ export interface Filter { } export namespace Filter { + /** + * @internal + */ export const filterSensitiveLog = (obj: Filter): any => ({ ...obj, }); @@ -2679,6 +2925,9 @@ export interface DescribeCertificatesMessage { } export namespace DescribeCertificatesMessage { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeCertificatesMessage): any => ({ ...obj, }); @@ -2702,6 +2951,9 @@ export interface DBClusterParameterGroupsMessage { } export namespace DBClusterParameterGroupsMessage { + /** + * @internal + */ export const filterSensitiveLog = (obj: DBClusterParameterGroupsMessage): any => ({ ...obj, }); @@ -2746,6 +2998,9 @@ export interface DescribeDBClusterParameterGroupsMessage { } export namespace DescribeDBClusterParameterGroupsMessage { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeDBClusterParameterGroupsMessage): any => ({ ...obj, }); @@ -2811,6 +3066,9 @@ export interface Parameter { } export namespace Parameter { + /** + * @internal + */ export const filterSensitiveLog = (obj: Parameter): any => ({ ...obj, }); @@ -2834,6 +3092,9 @@ export interface DBClusterParameterGroupDetails { } export namespace DBClusterParameterGroupDetails { + /** + * @internal + */ export const filterSensitiveLog = (obj: DBClusterParameterGroupDetails): any => ({ ...obj, }); @@ -2886,6 +3147,9 @@ export interface DescribeDBClusterParametersMessage { } export namespace DescribeDBClusterParametersMessage { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeDBClusterParametersMessage): any => ({ ...obj, }); @@ -2909,6 +3173,9 @@ export interface DBClusterMessage { } export namespace DBClusterMessage { + /** + * @internal + */ export const filterSensitiveLog = (obj: DBClusterMessage): any => ({ ...obj, }); @@ -2963,6 +3230,9 @@ export interface DescribeDBClustersMessage { } export namespace DescribeDBClustersMessage { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeDBClustersMessage): any => ({ ...obj, }); @@ -2979,6 +3249,9 @@ export interface DescribeDBClusterSnapshotAttributesMessage { } export namespace DescribeDBClusterSnapshotAttributesMessage { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeDBClusterSnapshotAttributesMessage): any => ({ ...obj, }); @@ -3009,6 +3282,9 @@ export interface DBClusterSnapshotAttribute { } export namespace DBClusterSnapshotAttribute { + /** + * @internal + */ export const filterSensitiveLog = (obj: DBClusterSnapshotAttribute): any => ({ ...obj, }); @@ -3031,6 +3307,9 @@ export interface DBClusterSnapshotAttributesResult { } export namespace DBClusterSnapshotAttributesResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: DBClusterSnapshotAttributesResult): any => ({ ...obj, }); @@ -3045,6 +3324,9 @@ export interface DescribeDBClusterSnapshotAttributesResult { } export namespace DescribeDBClusterSnapshotAttributesResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeDBClusterSnapshotAttributesResult): any => ({ ...obj, }); @@ -3068,6 +3350,9 @@ export interface DBClusterSnapshotMessage { } export namespace DBClusterSnapshotMessage { + /** + * @internal + */ export const filterSensitiveLog = (obj: DBClusterSnapshotMessage): any => ({ ...obj, }); @@ -3184,6 +3469,9 @@ export interface DescribeDBClusterSnapshotsMessage { } export namespace DescribeDBClusterSnapshotsMessage { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeDBClusterSnapshotsMessage): any => ({ ...obj, }); @@ -3223,6 +3511,9 @@ export interface UpgradeTarget { } export namespace UpgradeTarget { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpgradeTarget): any => ({ ...obj, }); @@ -3276,6 +3567,9 @@ export interface DBEngineVersion { } export namespace DBEngineVersion { + /** + * @internal + */ export const filterSensitiveLog = (obj: DBEngineVersion): any => ({ ...obj, }); @@ -3299,6 +3593,9 @@ export interface DBEngineVersionMessage { } export namespace DBEngineVersionMessage { + /** + * @internal + */ export const filterSensitiveLog = (obj: DBEngineVersionMessage): any => ({ ...obj, }); @@ -3375,6 +3672,9 @@ export interface DescribeDBEngineVersionsMessage { } export namespace DescribeDBEngineVersionsMessage { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeDBEngineVersionsMessage): any => ({ ...obj, }); @@ -3398,6 +3698,9 @@ export interface DBInstanceMessage { } export namespace DBInstanceMessage { + /** + * @internal + */ export const filterSensitiveLog = (obj: DBInstanceMessage): any => ({ ...obj, }); @@ -3460,6 +3763,9 @@ export interface DescribeDBInstancesMessage { } export namespace DescribeDBInstancesMessage { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeDBInstancesMessage): any => ({ ...obj, }); @@ -3483,6 +3789,9 @@ export interface DBSubnetGroupMessage { } export namespace DBSubnetGroupMessage { + /** + * @internal + */ export const filterSensitiveLog = (obj: DBSubnetGroupMessage): any => ({ ...obj, }); @@ -3520,6 +3829,9 @@ export interface DescribeDBSubnetGroupsMessage { } export namespace DescribeDBSubnetGroupsMessage { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeDBSubnetGroupsMessage): any => ({ ...obj, }); @@ -3558,6 +3870,9 @@ export interface DescribeEngineDefaultClusterParametersMessage { } export namespace DescribeEngineDefaultClusterParametersMessage { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeEngineDefaultClusterParametersMessage): any => ({ ...obj, }); @@ -3588,6 +3903,9 @@ export interface EngineDefaults { } export namespace EngineDefaults { + /** + * @internal + */ export const filterSensitiveLog = (obj: EngineDefaults): any => ({ ...obj, }); @@ -3602,6 +3920,9 @@ export interface DescribeEngineDefaultClusterParametersResult { } export namespace DescribeEngineDefaultClusterParametersResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeEngineDefaultClusterParametersResult): any => ({ ...obj, }); @@ -3626,6 +3947,9 @@ export interface DescribeEventCategoriesMessage { } export namespace DescribeEventCategoriesMessage { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeEventCategoriesMessage): any => ({ ...obj, }); @@ -3647,6 +3971,9 @@ export interface EventCategoriesMap { } export namespace EventCategoriesMap { + /** + * @internal + */ export const filterSensitiveLog = (obj: EventCategoriesMap): any => ({ ...obj, }); @@ -3663,6 +3990,9 @@ export interface EventCategoriesMessage { } export namespace EventCategoriesMessage { + /** + * @internal + */ export const filterSensitiveLog = (obj: EventCategoriesMessage): any => ({ ...obj, }); @@ -3767,6 +4097,9 @@ export interface DescribeEventsMessage { } export namespace DescribeEventsMessage { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeEventsMessage): any => ({ ...obj, }); @@ -3808,6 +4141,9 @@ export interface Event { } export namespace Event { + /** + * @internal + */ export const filterSensitiveLog = (obj: Event): any => ({ ...obj, }); @@ -3831,6 +4167,9 @@ export interface EventsMessage { } export namespace EventsMessage { + /** + * @internal + */ export const filterSensitiveLog = (obj: EventsMessage): any => ({ ...obj, }); @@ -3892,6 +4231,9 @@ export interface DescribeOrderableDBInstanceOptionsMessage { } export namespace DescribeOrderableDBInstanceOptionsMessage { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeOrderableDBInstanceOptionsMessage): any => ({ ...obj, }); @@ -3933,6 +4275,9 @@ export interface OrderableDBInstanceOption { } export namespace OrderableDBInstanceOption { + /** + * @internal + */ export const filterSensitiveLog = (obj: OrderableDBInstanceOption): any => ({ ...obj, }); @@ -3956,6 +4301,9 @@ export interface OrderableDBInstanceOptionsMessage { } export namespace OrderableDBInstanceOptionsMessage { + /** + * @internal + */ export const filterSensitiveLog = (obj: OrderableDBInstanceOptionsMessage): any => ({ ...obj, }); @@ -4009,6 +4357,9 @@ export interface DescribePendingMaintenanceActionsMessage { } export namespace DescribePendingMaintenanceActionsMessage { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribePendingMaintenanceActionsMessage): any => ({ ...obj, }); @@ -4032,6 +4383,9 @@ export interface PendingMaintenanceActionsMessage { } export namespace PendingMaintenanceActionsMessage { + /** + * @internal + */ export const filterSensitiveLog = (obj: PendingMaintenanceActionsMessage): any => ({ ...obj, }); @@ -4062,6 +4416,9 @@ export interface FailoverDBClusterMessage { } export namespace FailoverDBClusterMessage { + /** + * @internal + */ export const filterSensitiveLog = (obj: FailoverDBClusterMessage): any => ({ ...obj, }); @@ -4075,6 +4432,9 @@ export interface FailoverDBClusterResult { } export namespace FailoverDBClusterResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: FailoverDBClusterResult): any => ({ ...obj, }); @@ -4097,6 +4457,9 @@ export interface ListTagsForResourceMessage { } export namespace ListTagsForResourceMessage { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListTagsForResourceMessage): any => ({ ...obj, }); @@ -4113,6 +4476,9 @@ export interface TagListMessage { } export namespace TagListMessage { + /** + * @internal + */ export const filterSensitiveLog = (obj: TagListMessage): any => ({ ...obj, }); @@ -4128,6 +4494,9 @@ export interface InvalidDBSecurityGroupStateFault extends __SmithyException, $Me } export namespace InvalidDBSecurityGroupStateFault { + /** + * @internal + */ export const filterSensitiveLog = (obj: InvalidDBSecurityGroupStateFault): any => ({ ...obj, }); @@ -4153,6 +4522,9 @@ export interface CloudwatchLogsExportConfiguration { } export namespace CloudwatchLogsExportConfiguration { + /** + * @internal + */ export const filterSensitiveLog = (obj: CloudwatchLogsExportConfiguration): any => ({ ...obj, }); @@ -4310,6 +4682,9 @@ export interface ModifyDBClusterMessage { } export namespace ModifyDBClusterMessage { + /** + * @internal + */ export const filterSensitiveLog = (obj: ModifyDBClusterMessage): any => ({ ...obj, }); @@ -4323,6 +4698,9 @@ export interface ModifyDBClusterResult { } export namespace ModifyDBClusterResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: ModifyDBClusterResult): any => ({ ...obj, }); @@ -4354,6 +4732,9 @@ export interface DBClusterParameterGroupNameMessage { } export namespace DBClusterParameterGroupNameMessage { + /** + * @internal + */ export const filterSensitiveLog = (obj: DBClusterParameterGroupNameMessage): any => ({ ...obj, }); @@ -4375,6 +4756,9 @@ export interface ModifyDBClusterParameterGroupMessage { } export namespace ModifyDBClusterParameterGroupMessage { + /** + * @internal + */ export const filterSensitiveLog = (obj: ModifyDBClusterParameterGroupMessage): any => ({ ...obj, }); @@ -4421,6 +4805,9 @@ export interface ModifyDBClusterSnapshotAttributeMessage { } export namespace ModifyDBClusterSnapshotAttributeMessage { + /** + * @internal + */ export const filterSensitiveLog = (obj: ModifyDBClusterSnapshotAttributeMessage): any => ({ ...obj, }); @@ -4435,6 +4822,9 @@ export interface ModifyDBClusterSnapshotAttributeResult { } export namespace ModifyDBClusterSnapshotAttributeResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: ModifyDBClusterSnapshotAttributeResult): any => ({ ...obj, }); @@ -4451,6 +4841,9 @@ export interface SharedSnapshotQuotaExceededFault extends __SmithyException, $Me } export namespace SharedSnapshotQuotaExceededFault { + /** + * @internal + */ export const filterSensitiveLog = (obj: SharedSnapshotQuotaExceededFault): any => ({ ...obj, }); @@ -4467,6 +4860,9 @@ export interface DBUpgradeDependencyFailureFault extends __SmithyException, $Met } export namespace DBUpgradeDependencyFailureFault { + /** + * @internal + */ export const filterSensitiveLog = (obj: DBUpgradeDependencyFailureFault): any => ({ ...obj, }); @@ -4575,6 +4971,9 @@ export interface ModifyDBInstanceMessage { } export namespace ModifyDBInstanceMessage { + /** + * @internal + */ export const filterSensitiveLog = (obj: ModifyDBInstanceMessage): any => ({ ...obj, }); @@ -4588,6 +4987,9 @@ export interface ModifyDBInstanceResult { } export namespace ModifyDBInstanceResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: ModifyDBInstanceResult): any => ({ ...obj, }); @@ -4619,6 +5021,9 @@ export interface ModifyDBSubnetGroupMessage { } export namespace ModifyDBSubnetGroupMessage { + /** + * @internal + */ export const filterSensitiveLog = (obj: ModifyDBSubnetGroupMessage): any => ({ ...obj, }); @@ -4632,6 +5037,9 @@ export interface ModifyDBSubnetGroupResult { } export namespace ModifyDBSubnetGroupResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: ModifyDBSubnetGroupResult): any => ({ ...obj, }); @@ -4647,6 +5055,9 @@ export interface SubnetAlreadyInUse extends __SmithyException, $MetadataBearer { } export namespace SubnetAlreadyInUse { + /** + * @internal + */ export const filterSensitiveLog = (obj: SubnetAlreadyInUse): any => ({ ...obj, }); @@ -4676,6 +5087,9 @@ export interface RebootDBInstanceMessage { } export namespace RebootDBInstanceMessage { + /** + * @internal + */ export const filterSensitiveLog = (obj: RebootDBInstanceMessage): any => ({ ...obj, }); @@ -4689,6 +5103,9 @@ export interface RebootDBInstanceResult { } export namespace RebootDBInstanceResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: RebootDBInstanceResult): any => ({ ...obj, }); @@ -4711,6 +5128,9 @@ export interface RemoveTagsFromResourceMessage { } export namespace RemoveTagsFromResourceMessage { + /** + * @internal + */ export const filterSensitiveLog = (obj: RemoveTagsFromResourceMessage): any => ({ ...obj, }); @@ -4742,6 +5162,9 @@ export interface ResetDBClusterParameterGroupMessage { } export namespace ResetDBClusterParameterGroupMessage { + /** + * @internal + */ export const filterSensitiveLog = (obj: ResetDBClusterParameterGroupMessage): any => ({ ...obj, }); @@ -4757,6 +5180,9 @@ export interface InsufficientDBClusterCapacityFault extends __SmithyException, $ } export namespace InsufficientDBClusterCapacityFault { + /** + * @internal + */ export const filterSensitiveLog = (obj: InsufficientDBClusterCapacityFault): any => ({ ...obj, }); @@ -4772,6 +5198,9 @@ export interface InvalidDBSnapshotStateFault extends __SmithyException, $Metadat } export namespace InvalidDBSnapshotStateFault { + /** + * @internal + */ export const filterSensitiveLog = (obj: InvalidDBSnapshotStateFault): any => ({ ...obj, }); @@ -4788,6 +5217,9 @@ export interface InvalidRestoreFault extends __SmithyException, $MetadataBearer } export namespace InvalidRestoreFault { + /** + * @internal + */ export const filterSensitiveLog = (obj: InvalidRestoreFault): any => ({ ...obj, }); @@ -4915,6 +5347,9 @@ export interface RestoreDBClusterFromSnapshotMessage { } export namespace RestoreDBClusterFromSnapshotMessage { + /** + * @internal + */ export const filterSensitiveLog = (obj: RestoreDBClusterFromSnapshotMessage): any => ({ ...obj, }); @@ -4928,6 +5363,9 @@ export interface RestoreDBClusterFromSnapshotResult { } export namespace RestoreDBClusterFromSnapshotResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: RestoreDBClusterFromSnapshotResult): any => ({ ...obj, }); @@ -5071,6 +5509,9 @@ export interface RestoreDBClusterToPointInTimeMessage { } export namespace RestoreDBClusterToPointInTimeMessage { + /** + * @internal + */ export const filterSensitiveLog = (obj: RestoreDBClusterToPointInTimeMessage): any => ({ ...obj, }); @@ -5084,6 +5525,9 @@ export interface RestoreDBClusterToPointInTimeResult { } export namespace RestoreDBClusterToPointInTimeResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: RestoreDBClusterToPointInTimeResult): any => ({ ...obj, }); @@ -5099,6 +5543,9 @@ export interface StartDBClusterMessage { } export namespace StartDBClusterMessage { + /** + * @internal + */ export const filterSensitiveLog = (obj: StartDBClusterMessage): any => ({ ...obj, }); @@ -5112,6 +5559,9 @@ export interface StartDBClusterResult { } export namespace StartDBClusterResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: StartDBClusterResult): any => ({ ...obj, }); @@ -5127,6 +5577,9 @@ export interface StopDBClusterMessage { } export namespace StopDBClusterMessage { + /** + * @internal + */ export const filterSensitiveLog = (obj: StopDBClusterMessage): any => ({ ...obj, }); @@ -5140,6 +5593,9 @@ export interface StopDBClusterResult { } export namespace StopDBClusterResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: StopDBClusterResult): any => ({ ...obj, }); diff --git a/clients/client-dynamodb-streams/commands/DescribeStreamCommand.ts b/clients/client-dynamodb-streams/commands/DescribeStreamCommand.ts index 88587ae460c1..4f2e3760bb6c 100644 --- a/clients/client-dynamodb-streams/commands/DescribeStreamCommand.ts +++ b/clients/client-dynamodb-streams/commands/DescribeStreamCommand.ts @@ -30,6 +30,20 @@ export interface DescribeStreamCommandOutput extends DescribeStreamOutput, __Met * 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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { DynamoDBStreamsClient, DescribeStreamCommand } from "@aws-sdk/client-dynamodb-streams"; // ES Modules import + * // const { DynamoDBStreamsClient, DescribeStreamCommand } = require("@aws-sdk/client-dynamodb-streams"); // CommonJS import + * const client = new DynamoDBStreamsClient(config); + * const command = new DescribeStreamCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeStreamCommandInput} for command's `input` shape. + * @see {@link DescribeStreamCommandOutput} for command's `response` shape. + * @see {@link DynamoDBStreamsClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeStreamCommand extends $Command< DescribeStreamCommandInput, diff --git a/clients/client-dynamodb-streams/commands/GetRecordsCommand.ts b/clients/client-dynamodb-streams/commands/GetRecordsCommand.ts index bf2e75f502ee..d2a1270b79ef 100644 --- a/clients/client-dynamodb-streams/commands/GetRecordsCommand.ts +++ b/clients/client-dynamodb-streams/commands/GetRecordsCommand.ts @@ -32,6 +32,20 @@ export interface GetRecordsCommandOutput extends GetRecordsOutput, __MetadataBea * GetRecords can retrieve a maximum of 1 MB of data or 1000 stream records, * whichever comes first.

* + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { DynamoDBStreamsClient, GetRecordsCommand } from "@aws-sdk/client-dynamodb-streams"; // ES Modules import + * // const { DynamoDBStreamsClient, GetRecordsCommand } = require("@aws-sdk/client-dynamodb-streams"); // CommonJS import + * const client = new DynamoDBStreamsClient(config); + * const command = new GetRecordsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetRecordsCommandInput} for command's `input` shape. + * @see {@link GetRecordsCommandOutput} for command's `response` shape. + * @see {@link DynamoDBStreamsClientResolvedConfig | config} for command's `input` shape. + * */ export class GetRecordsCommand extends $Command< GetRecordsCommandInput, diff --git a/clients/client-dynamodb-streams/commands/GetShardIteratorCommand.ts b/clients/client-dynamodb-streams/commands/GetShardIteratorCommand.ts index deb375763681..65a4f7e5fec0 100644 --- a/clients/client-dynamodb-streams/commands/GetShardIteratorCommand.ts +++ b/clients/client-dynamodb-streams/commands/GetShardIteratorCommand.ts @@ -29,6 +29,20 @@ export interface GetShardIteratorCommandOutput extends GetShardIteratorOutput, _ * *

A shard iterator expires 15 minutes after it is returned to the requester.

* + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { DynamoDBStreamsClient, GetShardIteratorCommand } from "@aws-sdk/client-dynamodb-streams"; // ES Modules import + * // const { DynamoDBStreamsClient, GetShardIteratorCommand } = require("@aws-sdk/client-dynamodb-streams"); // CommonJS import + * const client = new DynamoDBStreamsClient(config); + * const command = new GetShardIteratorCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetShardIteratorCommandInput} for command's `input` shape. + * @see {@link GetShardIteratorCommandOutput} for command's `response` shape. + * @see {@link DynamoDBStreamsClientResolvedConfig | config} for command's `input` shape. + * */ export class GetShardIteratorCommand extends $Command< GetShardIteratorCommandInput, diff --git a/clients/client-dynamodb-streams/commands/ListStreamsCommand.ts b/clients/client-dynamodb-streams/commands/ListStreamsCommand.ts index 7ec1ce09b252..56475fd82bd6 100644 --- a/clients/client-dynamodb-streams/commands/ListStreamsCommand.ts +++ b/clients/client-dynamodb-streams/commands/ListStreamsCommand.ts @@ -27,6 +27,20 @@ export interface ListStreamsCommandOutput extends ListStreamsOutput, __MetadataB * *

You can call ListStreams at a maximum rate of 5 times per second.

* + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { DynamoDBStreamsClient, ListStreamsCommand } from "@aws-sdk/client-dynamodb-streams"; // ES Modules import + * // const { DynamoDBStreamsClient, ListStreamsCommand } = require("@aws-sdk/client-dynamodb-streams"); // CommonJS import + * const client = new DynamoDBStreamsClient(config); + * const command = new ListStreamsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListStreamsCommandInput} for command's `input` shape. + * @see {@link ListStreamsCommandOutput} for command's `response` shape. + * @see {@link DynamoDBStreamsClientResolvedConfig | config} for command's `input` shape. + * */ export class ListStreamsCommand extends $Command< ListStreamsCommandInput, diff --git a/clients/client-dynamodb-streams/models/models_0.ts b/clients/client-dynamodb-streams/models/models_0.ts index c993371afc47..9c844e94908d 100644 --- a/clients/client-dynamodb-streams/models/models_0.ts +++ b/clients/client-dynamodb-streams/models/models_0.ts @@ -23,6 +23,9 @@ export interface DescribeStreamInput { } export namespace DescribeStreamInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeStreamInput): any => ({ ...obj, }); @@ -76,6 +79,9 @@ export interface KeySchemaElement { } export namespace KeySchemaElement { + /** + * @internal + */ export const filterSensitiveLog = (obj: KeySchemaElement): any => ({ ...obj, }); @@ -97,6 +103,9 @@ export interface SequenceNumberRange { } export namespace SequenceNumberRange { + /** + * @internal + */ export const filterSensitiveLog = (obj: SequenceNumberRange): any => ({ ...obj, }); @@ -123,6 +132,9 @@ export interface Shard { } export namespace Shard { + /** + * @internal + */ export const filterSensitiveLog = (obj: Shard): any => ({ ...obj, }); @@ -239,6 +251,9 @@ export interface StreamDescription { } export namespace StreamDescription { + /** + * @internal + */ export const filterSensitiveLog = (obj: StreamDescription): any => ({ ...obj, }); @@ -255,6 +270,9 @@ export interface DescribeStreamOutput { } export namespace DescribeStreamOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeStreamOutput): any => ({ ...obj, }); @@ -273,6 +291,9 @@ export interface InternalServerError extends __SmithyException, $MetadataBearer } export namespace InternalServerError { + /** + * @internal + */ export const filterSensitiveLog = (obj: InternalServerError): any => ({ ...obj, }); @@ -293,6 +314,9 @@ export interface ResourceNotFoundException extends __SmithyException, $MetadataB } export namespace ResourceNotFoundException { + /** + * @internal + */ export const filterSensitiveLog = (obj: ResourceNotFoundException): any => ({ ...obj, }); @@ -313,6 +337,9 @@ export interface ExpiredIteratorException extends __SmithyException, $MetadataBe } export namespace ExpiredIteratorException { + /** + * @internal + */ export const filterSensitiveLog = (obj: ExpiredIteratorException): any => ({ ...obj, }); @@ -334,6 +361,9 @@ export interface GetRecordsInput { } export namespace GetRecordsInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetRecordsInput): any => ({ ...obj, }); @@ -358,6 +388,9 @@ export interface Identity { } export namespace Identity { + /** + * @internal + */ export const filterSensitiveLog = (obj: Identity): any => ({ ...obj, }); @@ -387,6 +420,9 @@ export interface LimitExceededException extends __SmithyException, $MetadataBear } export namespace LimitExceededException { + /** + * @internal + */ export const filterSensitiveLog = (obj: LimitExceededException): any => ({ ...obj, }); @@ -416,6 +452,9 @@ export interface TrimmedDataAccessException extends __SmithyException, $Metadata } export namespace TrimmedDataAccessException { + /** + * @internal + */ export const filterSensitiveLog = (obj: TrimmedDataAccessException): any => ({ ...obj, }); @@ -473,6 +512,9 @@ export interface GetShardIteratorInput { } export namespace GetShardIteratorInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetShardIteratorInput): any => ({ ...obj, }); @@ -489,6 +531,9 @@ export interface GetShardIteratorOutput { } export namespace GetShardIteratorOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetShardIteratorOutput): any => ({ ...obj, }); @@ -517,6 +562,9 @@ export interface ListStreamsInput { } export namespace ListStreamsInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListStreamsInput): any => ({ ...obj, }); @@ -558,6 +606,9 @@ export interface _Stream { } export namespace _Stream { + /** + * @internal + */ export const filterSensitiveLog = (obj: _Stream): any => ({ ...obj, }); @@ -584,6 +635,9 @@ export interface ListStreamsOutput { } export namespace ListStreamsOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListStreamsOutput): any => ({ ...obj, }); @@ -853,6 +907,9 @@ export namespace AttributeValue { return visitor._(value.$unknown[0], value.$unknown[1]); }; + /** + * @internal + */ export const filterSensitiveLog = (obj: AttributeValue): any => { if (obj.S !== undefined) return { S: obj.S }; if (obj.N !== undefined) return { N: obj.N }; @@ -936,6 +993,9 @@ export interface StreamRecord { } export namespace StreamRecord { + /** + * @internal + */ export const filterSensitiveLog = (obj: StreamRecord): any => ({ ...obj, ...(obj.Keys && { @@ -1036,6 +1096,9 @@ export interface _Record { } export namespace _Record { + /** + * @internal + */ export const filterSensitiveLog = (obj: _Record): any => ({ ...obj, ...(obj.dynamodb && { dynamodb: StreamRecord.filterSensitiveLog(obj.dynamodb) }), @@ -1060,6 +1123,9 @@ export interface GetRecordsOutput { } export namespace GetRecordsOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetRecordsOutput): any => ({ ...obj, ...(obj.Records && { Records: obj.Records.map((item) => _Record.filterSensitiveLog(item)) }), diff --git a/clients/client-dynamodb/commands/BatchExecuteStatementCommand.ts b/clients/client-dynamodb/commands/BatchExecuteStatementCommand.ts index bfa13d08eebf..3a1f6299f602 100644 --- a/clients/client-dynamodb/commands/BatchExecuteStatementCommand.ts +++ b/clients/client-dynamodb/commands/BatchExecuteStatementCommand.ts @@ -24,6 +24,20 @@ export interface BatchExecuteStatementCommandOutput extends BatchExecuteStatemen *

* This operation allows you to perform batch reads and writes on data stored in DynamoDB, using PartiQL. *

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { DynamoDBClient, BatchExecuteStatementCommand } from "@aws-sdk/client-dynamodb"; // ES Modules import + * // const { DynamoDBClient, BatchExecuteStatementCommand } = require("@aws-sdk/client-dynamodb"); // CommonJS import + * const client = new DynamoDBClient(config); + * const command = new BatchExecuteStatementCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link BatchExecuteStatementCommandInput} for command's `input` shape. + * @see {@link BatchExecuteStatementCommandOutput} for command's `response` shape. + * @see {@link DynamoDBClientResolvedConfig | config} for command's `input` shape. + * */ export class BatchExecuteStatementCommand extends $Command< BatchExecuteStatementCommandInput, diff --git a/clients/client-dynamodb/commands/BatchGetItemCommand.ts b/clients/client-dynamodb/commands/BatchGetItemCommand.ts index 1362daed4694..be1e6bba5d24 100644 --- a/clients/client-dynamodb/commands/BatchGetItemCommand.ts +++ b/clients/client-dynamodb/commands/BatchGetItemCommand.ts @@ -67,6 +67,20 @@ export interface BatchGetItemCommandOutput extends BatchGetItemOutput, __Metadat * 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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { DynamoDBClient, BatchGetItemCommand } from "@aws-sdk/client-dynamodb"; // ES Modules import + * // const { DynamoDBClient, BatchGetItemCommand } = require("@aws-sdk/client-dynamodb"); // CommonJS import + * const client = new DynamoDBClient(config); + * const command = new BatchGetItemCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link BatchGetItemCommandInput} for command's `input` shape. + * @see {@link BatchGetItemCommandOutput} for command's `response` shape. + * @see {@link DynamoDBClientResolvedConfig | config} for command's `input` shape. + * */ export class BatchGetItemCommand extends $Command< BatchGetItemCommandInput, diff --git a/clients/client-dynamodb/commands/BatchWriteItemCommand.ts b/clients/client-dynamodb/commands/BatchWriteItemCommand.ts index f9584a3f7988..4c740a748f36 100644 --- a/clients/client-dynamodb/commands/BatchWriteItemCommand.ts +++ b/clients/client-dynamodb/commands/BatchWriteItemCommand.ts @@ -96,6 +96,20 @@ export interface BatchWriteItemCommandOutput extends BatchWriteItemOutput, __Met *

The total request size exceeds 16 MB.

* * + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { DynamoDBClient, BatchWriteItemCommand } from "@aws-sdk/client-dynamodb"; // ES Modules import + * // const { DynamoDBClient, BatchWriteItemCommand } = require("@aws-sdk/client-dynamodb"); // CommonJS import + * const client = new DynamoDBClient(config); + * const command = new BatchWriteItemCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link BatchWriteItemCommandInput} for command's `input` shape. + * @see {@link BatchWriteItemCommandOutput} for command's `response` shape. + * @see {@link DynamoDBClientResolvedConfig | config} for command's `input` shape. + * */ export class BatchWriteItemCommand extends $Command< BatchWriteItemCommandInput, diff --git a/clients/client-dynamodb/commands/CreateBackupCommand.ts b/clients/client-dynamodb/commands/CreateBackupCommand.ts index aebe1ecaf981..6ca8d821efb0 100644 --- a/clients/client-dynamodb/commands/CreateBackupCommand.ts +++ b/clients/client-dynamodb/commands/CreateBackupCommand.ts @@ -51,6 +51,20 @@ export interface CreateBackupCommandOutput extends CreateBackupOutput, __Metadat *

Provisioned read and write capacity

* * + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { DynamoDBClient, CreateBackupCommand } from "@aws-sdk/client-dynamodb"; // ES Modules import + * // const { DynamoDBClient, CreateBackupCommand } = require("@aws-sdk/client-dynamodb"); // CommonJS import + * const client = new DynamoDBClient(config); + * const command = new CreateBackupCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreateBackupCommandInput} for command's `input` shape. + * @see {@link CreateBackupCommandOutput} for command's `response` shape. + * @see {@link DynamoDBClientResolvedConfig | config} for command's `input` shape. + * */ export class CreateBackupCommand extends $Command< CreateBackupCommandInput, diff --git a/clients/client-dynamodb/commands/CreateGlobalTableCommand.ts b/clients/client-dynamodb/commands/CreateGlobalTableCommand.ts index 0b1f5fa71d5d..6efb3abcfb4f 100644 --- a/clients/client-dynamodb/commands/CreateGlobalTableCommand.ts +++ b/clients/client-dynamodb/commands/CreateGlobalTableCommand.ts @@ -89,6 +89,20 @@ export interface CreateGlobalTableCommandOutput extends CreateGlobalTableOutput, * your global table. *

* + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { DynamoDBClient, CreateGlobalTableCommand } from "@aws-sdk/client-dynamodb"; // ES Modules import + * // const { DynamoDBClient, CreateGlobalTableCommand } = require("@aws-sdk/client-dynamodb"); // CommonJS import + * const client = new DynamoDBClient(config); + * const command = new CreateGlobalTableCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreateGlobalTableCommandInput} for command's `input` shape. + * @see {@link CreateGlobalTableCommandOutput} for command's `response` shape. + * @see {@link DynamoDBClientResolvedConfig | config} for command's `input` shape. + * */ export class CreateGlobalTableCommand extends $Command< CreateGlobalTableCommandInput, diff --git a/clients/client-dynamodb/commands/CreateTableCommand.ts b/clients/client-dynamodb/commands/CreateTableCommand.ts index f8f5b5387e3c..2e28ad6a1a7a 100644 --- a/clients/client-dynamodb/commands/CreateTableCommand.ts +++ b/clients/client-dynamodb/commands/CreateTableCommand.ts @@ -34,6 +34,20 @@ export interface CreateTableCommandOutput extends CreateTableOutput, __MetadataB * 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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { DynamoDBClient, CreateTableCommand } from "@aws-sdk/client-dynamodb"; // ES Modules import + * // const { DynamoDBClient, CreateTableCommand } = require("@aws-sdk/client-dynamodb"); // CommonJS import + * const client = new DynamoDBClient(config); + * const command = new CreateTableCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreateTableCommandInput} for command's `input` shape. + * @see {@link CreateTableCommandOutput} for command's `response` shape. + * @see {@link DynamoDBClientResolvedConfig | config} for command's `input` shape. + * */ export class CreateTableCommand extends $Command< CreateTableCommandInput, diff --git a/clients/client-dynamodb/commands/DeleteBackupCommand.ts b/clients/client-dynamodb/commands/DeleteBackupCommand.ts index 68b6f79178f4..e1172220f6fd 100644 --- a/clients/client-dynamodb/commands/DeleteBackupCommand.ts +++ b/clients/client-dynamodb/commands/DeleteBackupCommand.ts @@ -23,6 +23,20 @@ export interface DeleteBackupCommandOutput extends DeleteBackupOutput, __Metadat /** *

Deletes an existing backup of a table.

*

You can call DeleteBackup at a maximum rate of 10 times per second.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { DynamoDBClient, DeleteBackupCommand } from "@aws-sdk/client-dynamodb"; // ES Modules import + * // const { DynamoDBClient, DeleteBackupCommand } = require("@aws-sdk/client-dynamodb"); // CommonJS import + * const client = new DynamoDBClient(config); + * const command = new DeleteBackupCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteBackupCommandInput} for command's `input` shape. + * @see {@link DeleteBackupCommandOutput} for command's `response` shape. + * @see {@link DynamoDBClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteBackupCommand extends $Command< DeleteBackupCommandInput, diff --git a/clients/client-dynamodb/commands/DeleteItemCommand.ts b/clients/client-dynamodb/commands/DeleteItemCommand.ts index 9ff46bbf19ca..3b6b3a242c8e 100644 --- a/clients/client-dynamodb/commands/DeleteItemCommand.ts +++ b/clients/client-dynamodb/commands/DeleteItemCommand.ts @@ -27,6 +27,20 @@ export interface DeleteItemCommandOutput extends DeleteItemOutput, __MetadataBea *

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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { DynamoDBClient, DeleteItemCommand } from "@aws-sdk/client-dynamodb"; // ES Modules import + * // const { DynamoDBClient, DeleteItemCommand } = require("@aws-sdk/client-dynamodb"); // CommonJS import + * const client = new DynamoDBClient(config); + * const command = new DeleteItemCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteItemCommandInput} for command's `input` shape. + * @see {@link DeleteItemCommandOutput} for command's `response` shape. + * @see {@link DynamoDBClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteItemCommand extends $Command< DeleteItemCommandInput, diff --git a/clients/client-dynamodb/commands/DeleteTableCommand.ts b/clients/client-dynamodb/commands/DeleteTableCommand.ts index ba85ee6c46b7..c4516ae77018 100644 --- a/clients/client-dynamodb/commands/DeleteTableCommand.ts +++ b/clients/client-dynamodb/commands/DeleteTableCommand.ts @@ -38,6 +38,20 @@ export interface DeleteTableCommandOutput extends DeleteTableOutput, __MetadataB * into the DISABLED state, and the stream is automatically deleted after 24 hours.

* *

Use the DescribeTable action to check the status of the table.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { DynamoDBClient, DeleteTableCommand } from "@aws-sdk/client-dynamodb"; // ES Modules import + * // const { DynamoDBClient, DeleteTableCommand } = require("@aws-sdk/client-dynamodb"); // CommonJS import + * const client = new DynamoDBClient(config); + * const command = new DeleteTableCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteTableCommandInput} for command's `input` shape. + * @see {@link DeleteTableCommandOutput} for command's `response` shape. + * @see {@link DynamoDBClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteTableCommand extends $Command< DeleteTableCommandInput, diff --git a/clients/client-dynamodb/commands/DescribeBackupCommand.ts b/clients/client-dynamodb/commands/DescribeBackupCommand.ts index 6b0b07eef667..29be34bedf84 100644 --- a/clients/client-dynamodb/commands/DescribeBackupCommand.ts +++ b/clients/client-dynamodb/commands/DescribeBackupCommand.ts @@ -23,6 +23,20 @@ export interface DescribeBackupCommandOutput extends DescribeBackupOutput, __Met /** *

Describes an existing backup of a table.

*

You can call DescribeBackup at a maximum rate of 10 times per second.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { DynamoDBClient, DescribeBackupCommand } from "@aws-sdk/client-dynamodb"; // ES Modules import + * // const { DynamoDBClient, DescribeBackupCommand } = require("@aws-sdk/client-dynamodb"); // CommonJS import + * const client = new DynamoDBClient(config); + * const command = new DescribeBackupCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeBackupCommandInput} for command's `input` shape. + * @see {@link DescribeBackupCommandOutput} for command's `response` shape. + * @see {@link DynamoDBClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeBackupCommand extends $Command< DescribeBackupCommandInput, diff --git a/clients/client-dynamodb/commands/DescribeContinuousBackupsCommand.ts b/clients/client-dynamodb/commands/DescribeContinuousBackupsCommand.ts index 0970ac4d0710..6d48296fd1bc 100644 --- a/clients/client-dynamodb/commands/DescribeContinuousBackupsCommand.ts +++ b/clients/client-dynamodb/commands/DescribeContinuousBackupsCommand.ts @@ -32,6 +32,20 @@ export interface DescribeContinuousBackupsCommandOutput extends DescribeContinuo * in time during the last 35 days. *

*

You can call DescribeContinuousBackups at a maximum rate of 10 times per second.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { DynamoDBClient, DescribeContinuousBackupsCommand } from "@aws-sdk/client-dynamodb"; // ES Modules import + * // const { DynamoDBClient, DescribeContinuousBackupsCommand } = require("@aws-sdk/client-dynamodb"); // CommonJS import + * const client = new DynamoDBClient(config); + * const command = new DescribeContinuousBackupsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeContinuousBackupsCommandInput} for command's `input` shape. + * @see {@link DescribeContinuousBackupsCommandOutput} for command's `response` shape. + * @see {@link DynamoDBClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeContinuousBackupsCommand extends $Command< DescribeContinuousBackupsCommandInput, diff --git a/clients/client-dynamodb/commands/DescribeContributorInsightsCommand.ts b/clients/client-dynamodb/commands/DescribeContributorInsightsCommand.ts index 72d79ae948eb..4a56ca585a79 100644 --- a/clients/client-dynamodb/commands/DescribeContributorInsightsCommand.ts +++ b/clients/client-dynamodb/commands/DescribeContributorInsightsCommand.ts @@ -22,6 +22,20 @@ export interface DescribeContributorInsightsCommandOutput extends DescribeContri /** *

Returns information about contributor insights, for a given table or global secondary index.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { DynamoDBClient, DescribeContributorInsightsCommand } from "@aws-sdk/client-dynamodb"; // ES Modules import + * // const { DynamoDBClient, DescribeContributorInsightsCommand } = require("@aws-sdk/client-dynamodb"); // CommonJS import + * const client = new DynamoDBClient(config); + * const command = new DescribeContributorInsightsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeContributorInsightsCommandInput} for command's `input` shape. + * @see {@link DescribeContributorInsightsCommandOutput} for command's `response` shape. + * @see {@link DynamoDBClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeContributorInsightsCommand extends $Command< DescribeContributorInsightsCommandInput, diff --git a/clients/client-dynamodb/commands/DescribeEndpointsCommand.ts b/clients/client-dynamodb/commands/DescribeEndpointsCommand.ts index aabd61467e98..faad8652c5ce 100644 --- a/clients/client-dynamodb/commands/DescribeEndpointsCommand.ts +++ b/clients/client-dynamodb/commands/DescribeEndpointsCommand.ts @@ -22,6 +22,20 @@ export interface DescribeEndpointsCommandOutput extends DescribeEndpointsRespons /** *

Returns the regional endpoint information.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { DynamoDBClient, DescribeEndpointsCommand } from "@aws-sdk/client-dynamodb"; // ES Modules import + * // const { DynamoDBClient, DescribeEndpointsCommand } = require("@aws-sdk/client-dynamodb"); // CommonJS import + * const client = new DynamoDBClient(config); + * const command = new DescribeEndpointsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeEndpointsCommandInput} for command's `input` shape. + * @see {@link DescribeEndpointsCommandOutput} for command's `response` shape. + * @see {@link DynamoDBClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeEndpointsCommand extends $Command< DescribeEndpointsCommandInput, diff --git a/clients/client-dynamodb/commands/DescribeExportCommand.ts b/clients/client-dynamodb/commands/DescribeExportCommand.ts index 3ee963157f25..23a52bd2a95f 100644 --- a/clients/client-dynamodb/commands/DescribeExportCommand.ts +++ b/clients/client-dynamodb/commands/DescribeExportCommand.ts @@ -22,6 +22,20 @@ export interface DescribeExportCommandOutput extends DescribeExportOutput, __Met /** *

Describes an existing table export.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { DynamoDBClient, DescribeExportCommand } from "@aws-sdk/client-dynamodb"; // ES Modules import + * // const { DynamoDBClient, DescribeExportCommand } = require("@aws-sdk/client-dynamodb"); // CommonJS import + * const client = new DynamoDBClient(config); + * const command = new DescribeExportCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeExportCommandInput} for command's `input` shape. + * @see {@link DescribeExportCommandOutput} for command's `response` shape. + * @see {@link DynamoDBClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeExportCommand extends $Command< DescribeExportCommandInput, diff --git a/clients/client-dynamodb/commands/DescribeGlobalTableCommand.ts b/clients/client-dynamodb/commands/DescribeGlobalTableCommand.ts index 19ebadb67cdf..b2499f294e32 100644 --- a/clients/client-dynamodb/commands/DescribeGlobalTableCommand.ts +++ b/clients/client-dynamodb/commands/DescribeGlobalTableCommand.ts @@ -26,6 +26,20 @@ export interface DescribeGlobalTableCommandOutput extends DescribeGlobalTableOut *

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.

* + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { DynamoDBClient, DescribeGlobalTableCommand } from "@aws-sdk/client-dynamodb"; // ES Modules import + * // const { DynamoDBClient, DescribeGlobalTableCommand } = require("@aws-sdk/client-dynamodb"); // CommonJS import + * const client = new DynamoDBClient(config); + * const command = new DescribeGlobalTableCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeGlobalTableCommandInput} for command's `input` shape. + * @see {@link DescribeGlobalTableCommandOutput} for command's `response` shape. + * @see {@link DynamoDBClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeGlobalTableCommand extends $Command< DescribeGlobalTableCommandInput, diff --git a/clients/client-dynamodb/commands/DescribeGlobalTableSettingsCommand.ts b/clients/client-dynamodb/commands/DescribeGlobalTableSettingsCommand.ts index cf882237980f..5cb77d96a23f 100644 --- a/clients/client-dynamodb/commands/DescribeGlobalTableSettingsCommand.ts +++ b/clients/client-dynamodb/commands/DescribeGlobalTableSettingsCommand.ts @@ -25,6 +25,20 @@ export interface DescribeGlobalTableSettingsCommandOutput extends DescribeGlobal * *

This operation only applies to Version 2017.11.29 of global tables.

* + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { DynamoDBClient, DescribeGlobalTableSettingsCommand } from "@aws-sdk/client-dynamodb"; // ES Modules import + * // const { DynamoDBClient, DescribeGlobalTableSettingsCommand } = require("@aws-sdk/client-dynamodb"); // CommonJS import + * const client = new DynamoDBClient(config); + * const command = new DescribeGlobalTableSettingsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeGlobalTableSettingsCommandInput} for command's `input` shape. + * @see {@link DescribeGlobalTableSettingsCommandOutput} for command's `response` shape. + * @see {@link DynamoDBClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeGlobalTableSettingsCommand extends $Command< DescribeGlobalTableSettingsCommandInput, diff --git a/clients/client-dynamodb/commands/DescribeKinesisStreamingDestinationCommand.ts b/clients/client-dynamodb/commands/DescribeKinesisStreamingDestinationCommand.ts index 0c873dcf0d33..6571f734f709 100644 --- a/clients/client-dynamodb/commands/DescribeKinesisStreamingDestinationCommand.ts +++ b/clients/client-dynamodb/commands/DescribeKinesisStreamingDestinationCommand.ts @@ -27,6 +27,20 @@ export interface DescribeKinesisStreamingDestinationCommandOutput /** *

Returns information about the status of Kinesis streaming.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { DynamoDBClient, DescribeKinesisStreamingDestinationCommand } from "@aws-sdk/client-dynamodb"; // ES Modules import + * // const { DynamoDBClient, DescribeKinesisStreamingDestinationCommand } = require("@aws-sdk/client-dynamodb"); // CommonJS import + * const client = new DynamoDBClient(config); + * const command = new DescribeKinesisStreamingDestinationCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeKinesisStreamingDestinationCommandInput} for command's `input` shape. + * @see {@link DescribeKinesisStreamingDestinationCommandOutput} for command's `response` shape. + * @see {@link DynamoDBClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeKinesisStreamingDestinationCommand extends $Command< DescribeKinesisStreamingDestinationCommandInput, diff --git a/clients/client-dynamodb/commands/DescribeLimitsCommand.ts b/clients/client-dynamodb/commands/DescribeLimitsCommand.ts index c23b6f423b18..d281abe3363b 100644 --- a/clients/client-dynamodb/commands/DescribeLimitsCommand.ts +++ b/clients/client-dynamodb/commands/DescribeLimitsCommand.ts @@ -85,6 +85,20 @@ export interface DescribeLimitsCommandOutput extends DescribeLimitsOutput, __Met * errors if you call it more than once in a minute.

* *

The DescribeLimits Request element has no content.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { DynamoDBClient, DescribeLimitsCommand } from "@aws-sdk/client-dynamodb"; // ES Modules import + * // const { DynamoDBClient, DescribeLimitsCommand } = require("@aws-sdk/client-dynamodb"); // CommonJS import + * const client = new DynamoDBClient(config); + * const command = new DescribeLimitsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeLimitsCommandInput} for command's `input` shape. + * @see {@link DescribeLimitsCommandOutput} for command's `response` shape. + * @see {@link DynamoDBClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeLimitsCommand extends $Command< DescribeLimitsCommandInput, diff --git a/clients/client-dynamodb/commands/DescribeTableCommand.ts b/clients/client-dynamodb/commands/DescribeTableCommand.ts index 4207983590b4..d9a0a7d533d6 100644 --- a/clients/client-dynamodb/commands/DescribeTableCommand.ts +++ b/clients/client-dynamodb/commands/DescribeTableCommand.ts @@ -28,6 +28,20 @@ export interface DescribeTableCommandOutput extends DescribeTableOutput, __Metad * 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.

* + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { DynamoDBClient, DescribeTableCommand } from "@aws-sdk/client-dynamodb"; // ES Modules import + * // const { DynamoDBClient, DescribeTableCommand } = require("@aws-sdk/client-dynamodb"); // CommonJS import + * const client = new DynamoDBClient(config); + * const command = new DescribeTableCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeTableCommandInput} for command's `input` shape. + * @see {@link DescribeTableCommandOutput} for command's `response` shape. + * @see {@link DynamoDBClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeTableCommand extends $Command< DescribeTableCommandInput, diff --git a/clients/client-dynamodb/commands/DescribeTableReplicaAutoScalingCommand.ts b/clients/client-dynamodb/commands/DescribeTableReplicaAutoScalingCommand.ts index cdeac3d477de..1cb4f059a3fd 100644 --- a/clients/client-dynamodb/commands/DescribeTableReplicaAutoScalingCommand.ts +++ b/clients/client-dynamodb/commands/DescribeTableReplicaAutoScalingCommand.ts @@ -27,6 +27,20 @@ export interface DescribeTableReplicaAutoScalingCommandOutput * *

This operation only applies to Version 2019.11.21 of global tables.

* + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { DynamoDBClient, DescribeTableReplicaAutoScalingCommand } from "@aws-sdk/client-dynamodb"; // ES Modules import + * // const { DynamoDBClient, DescribeTableReplicaAutoScalingCommand } = require("@aws-sdk/client-dynamodb"); // CommonJS import + * const client = new DynamoDBClient(config); + * const command = new DescribeTableReplicaAutoScalingCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeTableReplicaAutoScalingCommandInput} for command's `input` shape. + * @see {@link DescribeTableReplicaAutoScalingCommandOutput} for command's `response` shape. + * @see {@link DynamoDBClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeTableReplicaAutoScalingCommand extends $Command< DescribeTableReplicaAutoScalingCommandInput, diff --git a/clients/client-dynamodb/commands/DescribeTimeToLiveCommand.ts b/clients/client-dynamodb/commands/DescribeTimeToLiveCommand.ts index c834bdaf4a4e..94efac3455b6 100644 --- a/clients/client-dynamodb/commands/DescribeTimeToLiveCommand.ts +++ b/clients/client-dynamodb/commands/DescribeTimeToLiveCommand.ts @@ -22,6 +22,20 @@ export interface DescribeTimeToLiveCommandOutput extends DescribeTimeToLiveOutpu /** *

Gives a description of the Time to Live (TTL) status on the specified table.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { DynamoDBClient, DescribeTimeToLiveCommand } from "@aws-sdk/client-dynamodb"; // ES Modules import + * // const { DynamoDBClient, DescribeTimeToLiveCommand } = require("@aws-sdk/client-dynamodb"); // CommonJS import + * const client = new DynamoDBClient(config); + * const command = new DescribeTimeToLiveCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeTimeToLiveCommandInput} for command's `input` shape. + * @see {@link DescribeTimeToLiveCommandOutput} for command's `response` shape. + * @see {@link DynamoDBClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeTimeToLiveCommand extends $Command< DescribeTimeToLiveCommandInput, diff --git a/clients/client-dynamodb/commands/DisableKinesisStreamingDestinationCommand.ts b/clients/client-dynamodb/commands/DisableKinesisStreamingDestinationCommand.ts index 0a47ecaf16d6..936805f48e09 100644 --- a/clients/client-dynamodb/commands/DisableKinesisStreamingDestinationCommand.ts +++ b/clients/client-dynamodb/commands/DisableKinesisStreamingDestinationCommand.ts @@ -25,6 +25,20 @@ export interface DisableKinesisStreamingDestinationCommandOutput /** *

Stops replication from the DynamoDB table to the Kinesis data stream. This is done * without deleting either of the resources.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { DynamoDBClient, DisableKinesisStreamingDestinationCommand } from "@aws-sdk/client-dynamodb"; // ES Modules import + * // const { DynamoDBClient, DisableKinesisStreamingDestinationCommand } = require("@aws-sdk/client-dynamodb"); // CommonJS import + * const client = new DynamoDBClient(config); + * const command = new DisableKinesisStreamingDestinationCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DisableKinesisStreamingDestinationCommandInput} for command's `input` shape. + * @see {@link DisableKinesisStreamingDestinationCommandOutput} for command's `response` shape. + * @see {@link DynamoDBClientResolvedConfig | config} for command's `input` shape. + * */ export class DisableKinesisStreamingDestinationCommand extends $Command< DisableKinesisStreamingDestinationCommandInput, diff --git a/clients/client-dynamodb/commands/EnableKinesisStreamingDestinationCommand.ts b/clients/client-dynamodb/commands/EnableKinesisStreamingDestinationCommand.ts index 904135a3cc91..b8a855f73eb0 100644 --- a/clients/client-dynamodb/commands/EnableKinesisStreamingDestinationCommand.ts +++ b/clients/client-dynamodb/commands/EnableKinesisStreamingDestinationCommand.ts @@ -27,6 +27,20 @@ export interface EnableKinesisStreamingDestinationCommandOutput * 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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { DynamoDBClient, EnableKinesisStreamingDestinationCommand } from "@aws-sdk/client-dynamodb"; // ES Modules import + * // const { DynamoDBClient, EnableKinesisStreamingDestinationCommand } = require("@aws-sdk/client-dynamodb"); // CommonJS import + * const client = new DynamoDBClient(config); + * const command = new EnableKinesisStreamingDestinationCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link EnableKinesisStreamingDestinationCommandInput} for command's `input` shape. + * @see {@link EnableKinesisStreamingDestinationCommandOutput} for command's `response` shape. + * @see {@link DynamoDBClientResolvedConfig | config} for command's `input` shape. + * */ export class EnableKinesisStreamingDestinationCommand extends $Command< EnableKinesisStreamingDestinationCommandInput, diff --git a/clients/client-dynamodb/commands/ExecuteStatementCommand.ts b/clients/client-dynamodb/commands/ExecuteStatementCommand.ts index 9b2152b4b162..f86cd40b5438 100644 --- a/clients/client-dynamodb/commands/ExecuteStatementCommand.ts +++ b/clients/client-dynamodb/commands/ExecuteStatementCommand.ts @@ -24,6 +24,20 @@ export interface ExecuteStatementCommandOutput extends ExecuteStatementOutput, _ *

* This operation allows you to perform reads and singleton writes on data stored in DynamoDB, using PartiQL. *

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { DynamoDBClient, ExecuteStatementCommand } from "@aws-sdk/client-dynamodb"; // ES Modules import + * // const { DynamoDBClient, ExecuteStatementCommand } = require("@aws-sdk/client-dynamodb"); // CommonJS import + * const client = new DynamoDBClient(config); + * const command = new ExecuteStatementCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ExecuteStatementCommandInput} for command's `input` shape. + * @see {@link ExecuteStatementCommandOutput} for command's `response` shape. + * @see {@link DynamoDBClientResolvedConfig | config} for command's `input` shape. + * */ export class ExecuteStatementCommand extends $Command< ExecuteStatementCommandInput, diff --git a/clients/client-dynamodb/commands/ExecuteTransactionCommand.ts b/clients/client-dynamodb/commands/ExecuteTransactionCommand.ts index 4ae6b186a312..dace5a384e55 100644 --- a/clients/client-dynamodb/commands/ExecuteTransactionCommand.ts +++ b/clients/client-dynamodb/commands/ExecuteTransactionCommand.ts @@ -24,6 +24,20 @@ export interface ExecuteTransactionCommandOutput extends ExecuteTransactionOutpu *

* This operation allows you to perform transactional reads or writes on data stored in DynamoDB, using PartiQL. *

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { DynamoDBClient, ExecuteTransactionCommand } from "@aws-sdk/client-dynamodb"; // ES Modules import + * // const { DynamoDBClient, ExecuteTransactionCommand } = require("@aws-sdk/client-dynamodb"); // CommonJS import + * const client = new DynamoDBClient(config); + * const command = new ExecuteTransactionCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ExecuteTransactionCommandInput} for command's `input` shape. + * @see {@link ExecuteTransactionCommandOutput} for command's `response` shape. + * @see {@link DynamoDBClientResolvedConfig | config} for command's `input` shape. + * */ export class ExecuteTransactionCommand extends $Command< ExecuteTransactionCommandInput, diff --git a/clients/client-dynamodb/commands/ExportTableToPointInTimeCommand.ts b/clients/client-dynamodb/commands/ExportTableToPointInTimeCommand.ts index 0fa76bb6b56a..a7a82f934665 100644 --- a/clients/client-dynamodb/commands/ExportTableToPointInTimeCommand.ts +++ b/clients/client-dynamodb/commands/ExportTableToPointInTimeCommand.ts @@ -24,6 +24,20 @@ export interface ExportTableToPointInTimeCommandOutput extends ExportTableToPoin *

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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { DynamoDBClient, ExportTableToPointInTimeCommand } from "@aws-sdk/client-dynamodb"; // ES Modules import + * // const { DynamoDBClient, ExportTableToPointInTimeCommand } = require("@aws-sdk/client-dynamodb"); // CommonJS import + * const client = new DynamoDBClient(config); + * const command = new ExportTableToPointInTimeCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ExportTableToPointInTimeCommandInput} for command's `input` shape. + * @see {@link ExportTableToPointInTimeCommandOutput} for command's `response` shape. + * @see {@link DynamoDBClientResolvedConfig | config} for command's `input` shape. + * */ export class ExportTableToPointInTimeCommand extends $Command< ExportTableToPointInTimeCommandInput, diff --git a/clients/client-dynamodb/commands/GetItemCommand.ts b/clients/client-dynamodb/commands/GetItemCommand.ts index 04a7849f980b..ea3fac256840 100644 --- a/clients/client-dynamodb/commands/GetItemCommand.ts +++ b/clients/client-dynamodb/commands/GetItemCommand.ts @@ -25,6 +25,20 @@ export interface GetItemCommandOutput extends GetItemOutput, __MetadataBearer {} * 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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { DynamoDBClient, GetItemCommand } from "@aws-sdk/client-dynamodb"; // ES Modules import + * // const { DynamoDBClient, GetItemCommand } = require("@aws-sdk/client-dynamodb"); // CommonJS import + * const client = new DynamoDBClient(config); + * const command = new GetItemCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetItemCommandInput} for command's `input` shape. + * @see {@link GetItemCommandOutput} for command's `response` shape. + * @see {@link DynamoDBClientResolvedConfig | config} for command's `input` shape. + * */ export class GetItemCommand extends $Command { // Start section: command_properties diff --git a/clients/client-dynamodb/commands/ListBackupsCommand.ts b/clients/client-dynamodb/commands/ListBackupsCommand.ts index c67c62587478..a0fa3ca758c0 100644 --- a/clients/client-dynamodb/commands/ListBackupsCommand.ts +++ b/clients/client-dynamodb/commands/ListBackupsCommand.ts @@ -28,6 +28,20 @@ export interface ListBackupsCommandOutput extends ListBackupsOutput, __MetadataB *

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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { DynamoDBClient, ListBackupsCommand } from "@aws-sdk/client-dynamodb"; // ES Modules import + * // const { DynamoDBClient, ListBackupsCommand } = require("@aws-sdk/client-dynamodb"); // CommonJS import + * const client = new DynamoDBClient(config); + * const command = new ListBackupsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListBackupsCommandInput} for command's `input` shape. + * @see {@link ListBackupsCommandOutput} for command's `response` shape. + * @see {@link DynamoDBClientResolvedConfig | config} for command's `input` shape. + * */ export class ListBackupsCommand extends $Command< ListBackupsCommandInput, diff --git a/clients/client-dynamodb/commands/ListContributorInsightsCommand.ts b/clients/client-dynamodb/commands/ListContributorInsightsCommand.ts index 6ed88f7210c1..9e008454e0bf 100644 --- a/clients/client-dynamodb/commands/ListContributorInsightsCommand.ts +++ b/clients/client-dynamodb/commands/ListContributorInsightsCommand.ts @@ -22,6 +22,20 @@ export interface ListContributorInsightsCommandOutput extends ListContributorIns /** *

Returns a list of ContributorInsightsSummary for a table and all its global secondary indexes.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { DynamoDBClient, ListContributorInsightsCommand } from "@aws-sdk/client-dynamodb"; // ES Modules import + * // const { DynamoDBClient, ListContributorInsightsCommand } = require("@aws-sdk/client-dynamodb"); // CommonJS import + * const client = new DynamoDBClient(config); + * const command = new ListContributorInsightsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListContributorInsightsCommandInput} for command's `input` shape. + * @see {@link ListContributorInsightsCommandOutput} for command's `response` shape. + * @see {@link DynamoDBClientResolvedConfig | config} for command's `input` shape. + * */ export class ListContributorInsightsCommand extends $Command< ListContributorInsightsCommandInput, diff --git a/clients/client-dynamodb/commands/ListExportsCommand.ts b/clients/client-dynamodb/commands/ListExportsCommand.ts index 07af5490a233..876a9744ee85 100644 --- a/clients/client-dynamodb/commands/ListExportsCommand.ts +++ b/clients/client-dynamodb/commands/ListExportsCommand.ts @@ -22,6 +22,20 @@ export interface ListExportsCommandOutput extends ListExportsOutput, __MetadataB /** *

Lists completed exports within the past 90 days.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { DynamoDBClient, ListExportsCommand } from "@aws-sdk/client-dynamodb"; // ES Modules import + * // const { DynamoDBClient, ListExportsCommand } = require("@aws-sdk/client-dynamodb"); // CommonJS import + * const client = new DynamoDBClient(config); + * const command = new ListExportsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListExportsCommandInput} for command's `input` shape. + * @see {@link ListExportsCommandOutput} for command's `response` shape. + * @see {@link DynamoDBClientResolvedConfig | config} for command's `input` shape. + * */ export class ListExportsCommand extends $Command< ListExportsCommandInput, diff --git a/clients/client-dynamodb/commands/ListGlobalTablesCommand.ts b/clients/client-dynamodb/commands/ListGlobalTablesCommand.ts index 9ddb72b5f602..9f18540a30e7 100644 --- a/clients/client-dynamodb/commands/ListGlobalTablesCommand.ts +++ b/clients/client-dynamodb/commands/ListGlobalTablesCommand.ts @@ -25,6 +25,20 @@ export interface ListGlobalTablesCommandOutput extends ListGlobalTablesOutput, _ * *

This operation only applies to Version 2017.11.29 of global tables.

* + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { DynamoDBClient, ListGlobalTablesCommand } from "@aws-sdk/client-dynamodb"; // ES Modules import + * // const { DynamoDBClient, ListGlobalTablesCommand } = require("@aws-sdk/client-dynamodb"); // CommonJS import + * const client = new DynamoDBClient(config); + * const command = new ListGlobalTablesCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListGlobalTablesCommandInput} for command's `input` shape. + * @see {@link ListGlobalTablesCommandOutput} for command's `response` shape. + * @see {@link DynamoDBClientResolvedConfig | config} for command's `input` shape. + * */ export class ListGlobalTablesCommand extends $Command< ListGlobalTablesCommandInput, diff --git a/clients/client-dynamodb/commands/ListTablesCommand.ts b/clients/client-dynamodb/commands/ListTablesCommand.ts index 6da3200dcf25..4d659f0966df 100644 --- a/clients/client-dynamodb/commands/ListTablesCommand.ts +++ b/clients/client-dynamodb/commands/ListTablesCommand.ts @@ -24,6 +24,20 @@ export interface ListTablesCommandOutput extends ListTablesOutput, __MetadataBea *

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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { DynamoDBClient, ListTablesCommand } from "@aws-sdk/client-dynamodb"; // ES Modules import + * // const { DynamoDBClient, ListTablesCommand } = require("@aws-sdk/client-dynamodb"); // CommonJS import + * const client = new DynamoDBClient(config); + * const command = new ListTablesCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListTablesCommandInput} for command's `input` shape. + * @see {@link ListTablesCommandOutput} for command's `response` shape. + * @see {@link DynamoDBClientResolvedConfig | config} for command's `input` shape. + * */ export class ListTablesCommand extends $Command< ListTablesCommandInput, diff --git a/clients/client-dynamodb/commands/ListTagsOfResourceCommand.ts b/clients/client-dynamodb/commands/ListTagsOfResourceCommand.ts index d860d7e516fb..0c238d6ce438 100644 --- a/clients/client-dynamodb/commands/ListTagsOfResourceCommand.ts +++ b/clients/client-dynamodb/commands/ListTagsOfResourceCommand.ts @@ -25,6 +25,20 @@ export interface ListTagsOfResourceCommandOutput extends ListTagsOfResourceOutpu *

For an overview on tagging DynamoDB resources, see * Tagging for DynamoDB * in the Amazon DynamoDB Developer Guide.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { DynamoDBClient, ListTagsOfResourceCommand } from "@aws-sdk/client-dynamodb"; // ES Modules import + * // const { DynamoDBClient, ListTagsOfResourceCommand } = require("@aws-sdk/client-dynamodb"); // CommonJS import + * const client = new DynamoDBClient(config); + * const command = new ListTagsOfResourceCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListTagsOfResourceCommandInput} for command's `input` shape. + * @see {@link ListTagsOfResourceCommandOutput} for command's `response` shape. + * @see {@link DynamoDBClientResolvedConfig | config} for command's `input` shape. + * */ export class ListTagsOfResourceCommand extends $Command< ListTagsOfResourceCommandInput, diff --git a/clients/client-dynamodb/commands/PutItemCommand.ts b/clients/client-dynamodb/commands/PutItemCommand.ts index edf954516ff8..d66017152d50 100644 --- a/clients/client-dynamodb/commands/PutItemCommand.ts +++ b/clients/client-dynamodb/commands/PutItemCommand.ts @@ -86,6 +86,20 @@ export interface PutItemCommandOutput extends PutItemOutput, __MetadataBearer {} * no matching item exists.

* *

For more information about PutItem, see Working with Items in the Amazon DynamoDB Developer Guide.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { DynamoDBClient, PutItemCommand } from "@aws-sdk/client-dynamodb"; // ES Modules import + * // const { DynamoDBClient, PutItemCommand } = require("@aws-sdk/client-dynamodb"); // CommonJS import + * const client = new DynamoDBClient(config); + * const command = new PutItemCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link PutItemCommandInput} for command's `input` shape. + * @see {@link PutItemCommandOutput} for command's `response` shape. + * @see {@link DynamoDBClientResolvedConfig | config} for command's `input` shape. + * */ export class PutItemCommand extends $Command { // Start section: command_properties diff --git a/clients/client-dynamodb/commands/QueryCommand.ts b/clients/client-dynamodb/commands/QueryCommand.ts index fb048ad93ec2..d171bb87ed8b 100644 --- a/clients/client-dynamodb/commands/QueryCommand.ts +++ b/clients/client-dynamodb/commands/QueryCommand.ts @@ -74,6 +74,20 @@ export interface QueryCommandOutput extends QueryOutput, __MetadataBearer {} * strongly consistent result. Global secondary indexes support eventually consistent reads * only, so do not specify ConsistentRead when querying a global * secondary index.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { DynamoDBClient, QueryCommand } from "@aws-sdk/client-dynamodb"; // ES Modules import + * // const { DynamoDBClient, QueryCommand } = require("@aws-sdk/client-dynamodb"); // CommonJS import + * const client = new DynamoDBClient(config); + * const command = new QueryCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link QueryCommandInput} for command's `input` shape. + * @see {@link QueryCommandOutput} for command's `response` shape. + * @see {@link DynamoDBClientResolvedConfig | config} for command's `input` shape. + * */ export class QueryCommand extends $Command { // Start section: command_properties diff --git a/clients/client-dynamodb/commands/RestoreTableFromBackupCommand.ts b/clients/client-dynamodb/commands/RestoreTableFromBackupCommand.ts index 0cbc723a31e3..066270d5c0b1 100644 --- a/clients/client-dynamodb/commands/RestoreTableFromBackupCommand.ts +++ b/clients/client-dynamodb/commands/RestoreTableFromBackupCommand.ts @@ -46,6 +46,20 @@ export interface RestoreTableFromBackupCommandOutput extends RestoreTableFromBac *

Time to Live (TTL) settings

* * + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { DynamoDBClient, RestoreTableFromBackupCommand } from "@aws-sdk/client-dynamodb"; // ES Modules import + * // const { DynamoDBClient, RestoreTableFromBackupCommand } = require("@aws-sdk/client-dynamodb"); // CommonJS import + * const client = new DynamoDBClient(config); + * const command = new RestoreTableFromBackupCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link RestoreTableFromBackupCommandInput} for command's `input` shape. + * @see {@link RestoreTableFromBackupCommandOutput} for command's `response` shape. + * @see {@link DynamoDBClientResolvedConfig | config} for command's `input` shape. + * */ export class RestoreTableFromBackupCommand extends $Command< RestoreTableFromBackupCommandInput, diff --git a/clients/client-dynamodb/commands/RestoreTableToPointInTimeCommand.ts b/clients/client-dynamodb/commands/RestoreTableToPointInTimeCommand.ts index a689c79ecc1e..7aaa06066db1 100644 --- a/clients/client-dynamodb/commands/RestoreTableToPointInTimeCommand.ts +++ b/clients/client-dynamodb/commands/RestoreTableToPointInTimeCommand.ts @@ -77,6 +77,20 @@ export interface RestoreTableToPointInTimeCommandOutput extends RestoreTableToPo *

Point in time recovery settings

* * + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { DynamoDBClient, RestoreTableToPointInTimeCommand } from "@aws-sdk/client-dynamodb"; // ES Modules import + * // const { DynamoDBClient, RestoreTableToPointInTimeCommand } = require("@aws-sdk/client-dynamodb"); // CommonJS import + * const client = new DynamoDBClient(config); + * const command = new RestoreTableToPointInTimeCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link RestoreTableToPointInTimeCommandInput} for command's `input` shape. + * @see {@link RestoreTableToPointInTimeCommandOutput} for command's `response` shape. + * @see {@link DynamoDBClientResolvedConfig | config} for command's `input` shape. + * */ export class RestoreTableToPointInTimeCommand extends $Command< RestoreTableToPointInTimeCommandInput, diff --git a/clients/client-dynamodb/commands/ScanCommand.ts b/clients/client-dynamodb/commands/ScanCommand.ts index a0bc737d1cf3..5334eb5f4c7c 100644 --- a/clients/client-dynamodb/commands/ScanCommand.ts +++ b/clients/client-dynamodb/commands/ScanCommand.ts @@ -43,6 +43,20 @@ export interface ScanCommandOutput extends ScanOutput, __MetadataBearer {} * 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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { DynamoDBClient, ScanCommand } from "@aws-sdk/client-dynamodb"; // ES Modules import + * // const { DynamoDBClient, ScanCommand } = require("@aws-sdk/client-dynamodb"); // CommonJS import + * const client = new DynamoDBClient(config); + * const command = new ScanCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ScanCommandInput} for command's `input` shape. + * @see {@link ScanCommandOutput} for command's `response` shape. + * @see {@link DynamoDBClientResolvedConfig | config} for command's `input` shape. + * */ export class ScanCommand extends $Command { // Start section: command_properties diff --git a/clients/client-dynamodb/commands/TagResourceCommand.ts b/clients/client-dynamodb/commands/TagResourceCommand.ts index dbecb87bd208..df42aa502a0f 100644 --- a/clients/client-dynamodb/commands/TagResourceCommand.ts +++ b/clients/client-dynamodb/commands/TagResourceCommand.ts @@ -28,6 +28,20 @@ export interface TagResourceCommandOutput extends __MetadataBearer {} *

For an overview on tagging DynamoDB resources, see * Tagging for DynamoDB * in the Amazon DynamoDB Developer Guide.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { DynamoDBClient, TagResourceCommand } from "@aws-sdk/client-dynamodb"; // ES Modules import + * // const { DynamoDBClient, TagResourceCommand } = require("@aws-sdk/client-dynamodb"); // CommonJS import + * const client = new DynamoDBClient(config); + * const command = new TagResourceCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link TagResourceCommandInput} for command's `input` shape. + * @see {@link TagResourceCommandOutput} for command's `response` shape. + * @see {@link DynamoDBClientResolvedConfig | config} for command's `input` shape. + * */ export class TagResourceCommand extends $Command< TagResourceCommandInput, diff --git a/clients/client-dynamodb/commands/TransactGetItemsCommand.ts b/clients/client-dynamodb/commands/TransactGetItemsCommand.ts index 98787da62819..aac3e93af195 100644 --- a/clients/client-dynamodb/commands/TransactGetItemsCommand.ts +++ b/clients/client-dynamodb/commands/TransactGetItemsCommand.ts @@ -47,6 +47,20 @@ export interface TransactGetItemsCommandOutput extends TransactGetItemsOutput, _ *

The aggregate size of the items in the transaction cannot exceed 4 MB.

* * + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { DynamoDBClient, TransactGetItemsCommand } from "@aws-sdk/client-dynamodb"; // ES Modules import + * // const { DynamoDBClient, TransactGetItemsCommand } = require("@aws-sdk/client-dynamodb"); // CommonJS import + * const client = new DynamoDBClient(config); + * const command = new TransactGetItemsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link TransactGetItemsCommandInput} for command's `input` shape. + * @see {@link TransactGetItemsCommandOutput} for command's `response` shape. + * @see {@link DynamoDBClientResolvedConfig | config} for command's `input` shape. + * */ export class TransactGetItemsCommand extends $Command< TransactGetItemsCommandInput, diff --git a/clients/client-dynamodb/commands/TransactWriteItemsCommand.ts b/clients/client-dynamodb/commands/TransactWriteItemsCommand.ts index 9a538cd1456c..3353a6eee19c 100644 --- a/clients/client-dynamodb/commands/TransactWriteItemsCommand.ts +++ b/clients/client-dynamodb/commands/TransactWriteItemsCommand.ts @@ -95,6 +95,20 @@ export interface TransactWriteItemsCommandOutput extends TransactWriteItemsOutpu *

There is a user error, such as an invalid data format.

* * + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { DynamoDBClient, TransactWriteItemsCommand } from "@aws-sdk/client-dynamodb"; // ES Modules import + * // const { DynamoDBClient, TransactWriteItemsCommand } = require("@aws-sdk/client-dynamodb"); // CommonJS import + * const client = new DynamoDBClient(config); + * const command = new TransactWriteItemsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link TransactWriteItemsCommandInput} for command's `input` shape. + * @see {@link TransactWriteItemsCommandOutput} for command's `response` shape. + * @see {@link DynamoDBClientResolvedConfig | config} for command's `input` shape. + * */ export class TransactWriteItemsCommand extends $Command< TransactWriteItemsCommandInput, diff --git a/clients/client-dynamodb/commands/UntagResourceCommand.ts b/clients/client-dynamodb/commands/UntagResourceCommand.ts index 385dcf39f967..479f99e33a59 100644 --- a/clients/client-dynamodb/commands/UntagResourceCommand.ts +++ b/clients/client-dynamodb/commands/UntagResourceCommand.ts @@ -26,6 +26,20 @@ export interface UntagResourceCommandOutput extends __MetadataBearer {} *

For an overview on tagging DynamoDB resources, see * Tagging for DynamoDB * in the Amazon DynamoDB Developer Guide.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { DynamoDBClient, UntagResourceCommand } from "@aws-sdk/client-dynamodb"; // ES Modules import + * // const { DynamoDBClient, UntagResourceCommand } = require("@aws-sdk/client-dynamodb"); // CommonJS import + * const client = new DynamoDBClient(config); + * const command = new UntagResourceCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link UntagResourceCommandInput} for command's `input` shape. + * @see {@link UntagResourceCommandOutput} for command's `response` shape. + * @see {@link DynamoDBClientResolvedConfig | config} for command's `input` shape. + * */ export class UntagResourceCommand extends $Command< UntagResourceCommandInput, diff --git a/clients/client-dynamodb/commands/UpdateContinuousBackupsCommand.ts b/clients/client-dynamodb/commands/UpdateContinuousBackupsCommand.ts index a25d0066d844..948ec01e8cd0 100644 --- a/clients/client-dynamodb/commands/UpdateContinuousBackupsCommand.ts +++ b/clients/client-dynamodb/commands/UpdateContinuousBackupsCommand.ts @@ -33,6 +33,20 @@ export interface UpdateContinuousBackupsCommandOutput extends UpdateContinuousBa *

* LatestRestorableDateTime is typically 5 minutes before the current time. * You can restore your table to any point in time during the last 35 days.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { DynamoDBClient, UpdateContinuousBackupsCommand } from "@aws-sdk/client-dynamodb"; // ES Modules import + * // const { DynamoDBClient, UpdateContinuousBackupsCommand } = require("@aws-sdk/client-dynamodb"); // CommonJS import + * const client = new DynamoDBClient(config); + * const command = new UpdateContinuousBackupsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link UpdateContinuousBackupsCommandInput} for command's `input` shape. + * @see {@link UpdateContinuousBackupsCommandOutput} for command's `response` shape. + * @see {@link DynamoDBClientResolvedConfig | config} for command's `input` shape. + * */ export class UpdateContinuousBackupsCommand extends $Command< UpdateContinuousBackupsCommandInput, diff --git a/clients/client-dynamodb/commands/UpdateContributorInsightsCommand.ts b/clients/client-dynamodb/commands/UpdateContributorInsightsCommand.ts index 3742b54c07c9..e1809f7aa889 100644 --- a/clients/client-dynamodb/commands/UpdateContributorInsightsCommand.ts +++ b/clients/client-dynamodb/commands/UpdateContributorInsightsCommand.ts @@ -22,6 +22,20 @@ export interface UpdateContributorInsightsCommandOutput extends UpdateContributo /** *

Updates the status for contributor insights for a specific table or index.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { DynamoDBClient, UpdateContributorInsightsCommand } from "@aws-sdk/client-dynamodb"; // ES Modules import + * // const { DynamoDBClient, UpdateContributorInsightsCommand } = require("@aws-sdk/client-dynamodb"); // CommonJS import + * const client = new DynamoDBClient(config); + * const command = new UpdateContributorInsightsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link UpdateContributorInsightsCommandInput} for command's `input` shape. + * @see {@link UpdateContributorInsightsCommandOutput} for command's `response` shape. + * @see {@link DynamoDBClientResolvedConfig | config} for command's `input` shape. + * */ export class UpdateContributorInsightsCommand extends $Command< UpdateContributorInsightsCommandInput, diff --git a/clients/client-dynamodb/commands/UpdateGlobalTableCommand.ts b/clients/client-dynamodb/commands/UpdateGlobalTableCommand.ts index d1782224f550..f014f37dc3b7 100644 --- a/clients/client-dynamodb/commands/UpdateGlobalTableCommand.ts +++ b/clients/client-dynamodb/commands/UpdateGlobalTableCommand.ts @@ -50,6 +50,20 @@ export interface UpdateGlobalTableCommandOutput extends UpdateGlobalTableOutput, *

* * + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { DynamoDBClient, UpdateGlobalTableCommand } from "@aws-sdk/client-dynamodb"; // ES Modules import + * // const { DynamoDBClient, UpdateGlobalTableCommand } = require("@aws-sdk/client-dynamodb"); // CommonJS import + * const client = new DynamoDBClient(config); + * const command = new UpdateGlobalTableCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link UpdateGlobalTableCommandInput} for command's `input` shape. + * @see {@link UpdateGlobalTableCommandOutput} for command's `response` shape. + * @see {@link DynamoDBClientResolvedConfig | config} for command's `input` shape. + * */ export class UpdateGlobalTableCommand extends $Command< UpdateGlobalTableCommandInput, diff --git a/clients/client-dynamodb/commands/UpdateGlobalTableSettingsCommand.ts b/clients/client-dynamodb/commands/UpdateGlobalTableSettingsCommand.ts index 44e38ed1ce4e..ecb2d34d1663 100644 --- a/clients/client-dynamodb/commands/UpdateGlobalTableSettingsCommand.ts +++ b/clients/client-dynamodb/commands/UpdateGlobalTableSettingsCommand.ts @@ -22,6 +22,20 @@ export interface UpdateGlobalTableSettingsCommandOutput extends UpdateGlobalTabl /** *

Updates settings for a global table.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { DynamoDBClient, UpdateGlobalTableSettingsCommand } from "@aws-sdk/client-dynamodb"; // ES Modules import + * // const { DynamoDBClient, UpdateGlobalTableSettingsCommand } = require("@aws-sdk/client-dynamodb"); // CommonJS import + * const client = new DynamoDBClient(config); + * const command = new UpdateGlobalTableSettingsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link UpdateGlobalTableSettingsCommandInput} for command's `input` shape. + * @see {@link UpdateGlobalTableSettingsCommandOutput} for command's `response` shape. + * @see {@link DynamoDBClientResolvedConfig | config} for command's `input` shape. + * */ export class UpdateGlobalTableSettingsCommand extends $Command< UpdateGlobalTableSettingsCommandInput, diff --git a/clients/client-dynamodb/commands/UpdateItemCommand.ts b/clients/client-dynamodb/commands/UpdateItemCommand.ts index fab557eea4b8..58af80910f95 100644 --- a/clients/client-dynamodb/commands/UpdateItemCommand.ts +++ b/clients/client-dynamodb/commands/UpdateItemCommand.ts @@ -24,6 +24,20 @@ export interface UpdateItemCommandOutput extends UpdateItemOutput, __MetadataBea *

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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { DynamoDBClient, UpdateItemCommand } from "@aws-sdk/client-dynamodb"; // ES Modules import + * // const { DynamoDBClient, UpdateItemCommand } = require("@aws-sdk/client-dynamodb"); // CommonJS import + * const client = new DynamoDBClient(config); + * const command = new UpdateItemCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link UpdateItemCommandInput} for command's `input` shape. + * @see {@link UpdateItemCommandOutput} for command's `response` shape. + * @see {@link DynamoDBClientResolvedConfig | config} for command's `input` shape. + * */ export class UpdateItemCommand extends $Command< UpdateItemCommandInput, diff --git a/clients/client-dynamodb/commands/UpdateTableCommand.ts b/clients/client-dynamodb/commands/UpdateTableCommand.ts index a54e69fcde33..0e6eac0ea8dc 100644 --- a/clients/client-dynamodb/commands/UpdateTableCommand.ts +++ b/clients/client-dynamodb/commands/UpdateTableCommand.ts @@ -44,6 +44,20 @@ export interface UpdateTableCommandOutput extends UpdateTableOutput, __MetadataB * 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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { DynamoDBClient, UpdateTableCommand } from "@aws-sdk/client-dynamodb"; // ES Modules import + * // const { DynamoDBClient, UpdateTableCommand } = require("@aws-sdk/client-dynamodb"); // CommonJS import + * const client = new DynamoDBClient(config); + * const command = new UpdateTableCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link UpdateTableCommandInput} for command's `input` shape. + * @see {@link UpdateTableCommandOutput} for command's `response` shape. + * @see {@link DynamoDBClientResolvedConfig | config} for command's `input` shape. + * */ export class UpdateTableCommand extends $Command< UpdateTableCommandInput, diff --git a/clients/client-dynamodb/commands/UpdateTableReplicaAutoScalingCommand.ts b/clients/client-dynamodb/commands/UpdateTableReplicaAutoScalingCommand.ts index a998320d3d3c..3be34b145574 100644 --- a/clients/client-dynamodb/commands/UpdateTableReplicaAutoScalingCommand.ts +++ b/clients/client-dynamodb/commands/UpdateTableReplicaAutoScalingCommand.ts @@ -27,6 +27,20 @@ export interface UpdateTableReplicaAutoScalingCommandOutput * *

This operation only applies to Version 2019.11.21 of global tables.

* + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { DynamoDBClient, UpdateTableReplicaAutoScalingCommand } from "@aws-sdk/client-dynamodb"; // ES Modules import + * // const { DynamoDBClient, UpdateTableReplicaAutoScalingCommand } = require("@aws-sdk/client-dynamodb"); // CommonJS import + * const client = new DynamoDBClient(config); + * const command = new UpdateTableReplicaAutoScalingCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link UpdateTableReplicaAutoScalingCommandInput} for command's `input` shape. + * @see {@link UpdateTableReplicaAutoScalingCommandOutput} for command's `response` shape. + * @see {@link DynamoDBClientResolvedConfig | config} for command's `input` shape. + * */ export class UpdateTableReplicaAutoScalingCommand extends $Command< UpdateTableReplicaAutoScalingCommandInput, diff --git a/clients/client-dynamodb/commands/UpdateTimeToLiveCommand.ts b/clients/client-dynamodb/commands/UpdateTimeToLiveCommand.ts index 11d7b796d0bf..1de1f5d80303 100644 --- a/clients/client-dynamodb/commands/UpdateTimeToLiveCommand.ts +++ b/clients/client-dynamodb/commands/UpdateTimeToLiveCommand.ts @@ -46,6 +46,20 @@ export interface UpdateTimeToLiveCommandOutput extends UpdateTimeToLiveOutput, _ * 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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { DynamoDBClient, UpdateTimeToLiveCommand } from "@aws-sdk/client-dynamodb"; // ES Modules import + * // const { DynamoDBClient, UpdateTimeToLiveCommand } = require("@aws-sdk/client-dynamodb"); // CommonJS import + * const client = new DynamoDBClient(config); + * const command = new UpdateTimeToLiveCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link UpdateTimeToLiveCommandInput} for command's `input` shape. + * @see {@link UpdateTimeToLiveCommandOutput} for command's `response` shape. + * @see {@link DynamoDBClientResolvedConfig | config} for command's `input` shape. + * */ export class UpdateTimeToLiveCommand extends $Command< UpdateTimeToLiveCommandInput, diff --git a/clients/client-dynamodb/models/models_0.ts b/clients/client-dynamodb/models/models_0.ts index 72845da36cab..c889c27d6c54 100644 --- a/clients/client-dynamodb/models/models_0.ts +++ b/clients/client-dynamodb/models/models_0.ts @@ -37,6 +37,9 @@ export interface ArchivalSummary { } export namespace ArchivalSummary { + /** + * @internal + */ export const filterSensitiveLog = (obj: ArchivalSummary): any => ({ ...obj, }); @@ -76,6 +79,9 @@ export interface AttributeDefinition { } export namespace AttributeDefinition { + /** + * @internal + */ export const filterSensitiveLog = (obj: AttributeDefinition): any => ({ ...obj, }); @@ -119,6 +125,9 @@ export interface AutoScalingTargetTrackingScalingPolicyConfigurationDescription } export namespace AutoScalingTargetTrackingScalingPolicyConfigurationDescription { + /** + * @internal + */ export const filterSensitiveLog = (obj: AutoScalingTargetTrackingScalingPolicyConfigurationDescription): any => ({ ...obj, }); @@ -140,6 +149,9 @@ export interface AutoScalingPolicyDescription { } export namespace AutoScalingPolicyDescription { + /** + * @internal + */ export const filterSensitiveLog = (obj: AutoScalingPolicyDescription): any => ({ ...obj, }); @@ -183,6 +195,9 @@ export interface AutoScalingTargetTrackingScalingPolicyConfigurationUpdate { } export namespace AutoScalingTargetTrackingScalingPolicyConfigurationUpdate { + /** + * @internal + */ export const filterSensitiveLog = (obj: AutoScalingTargetTrackingScalingPolicyConfigurationUpdate): any => ({ ...obj, }); @@ -204,6 +219,9 @@ export interface AutoScalingPolicyUpdate { } export namespace AutoScalingPolicyUpdate { + /** + * @internal + */ export const filterSensitiveLog = (obj: AutoScalingPolicyUpdate): any => ({ ...obj, }); @@ -241,6 +259,9 @@ export interface AutoScalingSettingsDescription { } export namespace AutoScalingSettingsDescription { + /** + * @internal + */ export const filterSensitiveLog = (obj: AutoScalingSettingsDescription): any => ({ ...obj, }); @@ -278,6 +299,9 @@ export interface AutoScalingSettingsUpdate { } export namespace AutoScalingSettingsUpdate { + /** + * @internal + */ export const filterSensitiveLog = (obj: AutoScalingSettingsUpdate): any => ({ ...obj, }); @@ -350,6 +374,9 @@ export interface BackupDetails { } export namespace BackupDetails { + /** + * @internal + */ export const filterSensitiveLog = (obj: BackupDetails): any => ({ ...obj, }); @@ -399,6 +426,9 @@ export interface KeySchemaElement { } export namespace KeySchemaElement { + /** + * @internal + */ export const filterSensitiveLog = (obj: KeySchemaElement): any => ({ ...obj, }); @@ -428,6 +458,9 @@ export interface ProvisionedThroughput { } export namespace ProvisionedThroughput { + /** + * @internal + */ export const filterSensitiveLog = (obj: ProvisionedThroughput): any => ({ ...obj, }); @@ -495,6 +528,9 @@ export interface SourceTableDetails { } export namespace SourceTableDetails { + /** + * @internal + */ export const filterSensitiveLog = (obj: SourceTableDetails): any => ({ ...obj, }); @@ -536,6 +572,9 @@ export interface Projection { } export namespace Projection { + /** + * @internal + */ export const filterSensitiveLog = (obj: Projection): any => ({ ...obj, }); @@ -589,6 +628,9 @@ export interface GlobalSecondaryIndexInfo { } export namespace GlobalSecondaryIndexInfo { + /** + * @internal + */ export const filterSensitiveLog = (obj: GlobalSecondaryIndexInfo): any => ({ ...obj, }); @@ -634,6 +676,9 @@ export interface LocalSecondaryIndexInfo { } export namespace LocalSecondaryIndexInfo { + /** + * @internal + */ export const filterSensitiveLog = (obj: LocalSecondaryIndexInfo): any => ({ ...obj, }); @@ -691,6 +736,9 @@ export interface SSEDescription { } export namespace SSEDescription { + /** + * @internal + */ export const filterSensitiveLog = (obj: SSEDescription): any => ({ ...obj, }); @@ -738,6 +786,9 @@ export interface StreamSpecification { } export namespace StreamSpecification { + /** + * @internal + */ export const filterSensitiveLog = (obj: StreamSpecification): any => ({ ...obj, }); @@ -761,6 +812,9 @@ export interface TimeToLiveDescription { } export namespace TimeToLiveDescription { + /** + * @internal + */ export const filterSensitiveLog = (obj: TimeToLiveDescription): any => ({ ...obj, }); @@ -799,6 +853,9 @@ export interface SourceTableFeatureDetails { } export namespace SourceTableFeatureDetails { + /** + * @internal + */ export const filterSensitiveLog = (obj: SourceTableFeatureDetails): any => ({ ...obj, }); @@ -825,6 +882,9 @@ export interface BackupDescription { } export namespace BackupDescription { + /** + * @internal + */ export const filterSensitiveLog = (obj: BackupDescription): any => ({ ...obj, }); @@ -840,6 +900,9 @@ export interface BackupInUseException extends __SmithyException, $MetadataBearer } export namespace BackupInUseException { + /** + * @internal + */ export const filterSensitiveLog = (obj: BackupInUseException): any => ({ ...obj, }); @@ -855,6 +918,9 @@ export interface BackupNotFoundException extends __SmithyException, $MetadataBea } export namespace BackupNotFoundException { + /** + * @internal + */ export const filterSensitiveLog = (obj: BackupNotFoundException): any => ({ ...obj, }); @@ -935,6 +1001,9 @@ export interface BackupSummary { } export namespace BackupSummary { + /** + * @internal + */ export const filterSensitiveLog = (obj: BackupSummary): any => ({ ...obj, }); @@ -983,6 +1052,9 @@ export interface BatchStatementError { } export namespace BatchStatementError { + /** + * @internal + */ export const filterSensitiveLog = (obj: BatchStatementError): any => ({ ...obj, }); @@ -1001,6 +1073,9 @@ export interface InternalServerError extends __SmithyException, $MetadataBearer } export namespace InternalServerError { + /** + * @internal + */ export const filterSensitiveLog = (obj: InternalServerError): any => ({ ...obj, }); @@ -1016,6 +1091,9 @@ export interface RequestLimitExceeded extends __SmithyException, $MetadataBearer } export namespace RequestLimitExceeded { + /** + * @internal + */ export const filterSensitiveLog = (obj: RequestLimitExceeded): any => ({ ...obj, }); @@ -1044,6 +1122,9 @@ export interface Capacity { } export namespace Capacity { + /** + * @internal + */ export const filterSensitiveLog = (obj: Capacity): any => ({ ...obj, }); @@ -1094,6 +1175,9 @@ export interface ConsumedCapacity { } export namespace ConsumedCapacity { + /** + * @internal + */ export const filterSensitiveLog = (obj: ConsumedCapacity): any => ({ ...obj, }); @@ -1106,6 +1190,9 @@ export interface InvalidEndpointException extends __SmithyException, $MetadataBe } export namespace InvalidEndpointException { + /** + * @internal + */ export const filterSensitiveLog = (obj: InvalidEndpointException): any => ({ ...obj, }); @@ -1128,6 +1215,9 @@ export interface ProvisionedThroughputExceededException extends __SmithyExceptio } export namespace ProvisionedThroughputExceededException { + /** + * @internal + */ export const filterSensitiveLog = (obj: ProvisionedThroughputExceededException): any => ({ ...obj, }); @@ -1147,6 +1237,9 @@ export interface ResourceNotFoundException extends __SmithyException, $MetadataB } export namespace ResourceNotFoundException { + /** + * @internal + */ export const filterSensitiveLog = (obj: ResourceNotFoundException): any => ({ ...obj, }); @@ -1167,6 +1260,9 @@ export interface ItemCollectionSizeLimitExceededException extends __SmithyExcept } export namespace ItemCollectionSizeLimitExceededException { + /** + * @internal + */ export const filterSensitiveLog = (obj: ItemCollectionSizeLimitExceededException): any => ({ ...obj, }); @@ -1199,6 +1295,9 @@ export interface BillingModeSummary { } export namespace BillingModeSummary { + /** + * @internal + */ export const filterSensitiveLog = (obj: BillingModeSummary): any => ({ ...obj, }); @@ -1232,6 +1331,9 @@ export interface ConditionalCheckFailedException extends __SmithyException, $Met } export namespace ConditionalCheckFailedException { + /** + * @internal + */ export const filterSensitiveLog = (obj: ConditionalCheckFailedException): any => ({ ...obj, }); @@ -1283,6 +1385,9 @@ export interface PointInTimeRecoveryDescription { } export namespace PointInTimeRecoveryDescription { + /** + * @internal + */ export const filterSensitiveLog = (obj: PointInTimeRecoveryDescription): any => ({ ...obj, }); @@ -1306,6 +1411,9 @@ export interface ContinuousBackupsDescription { } export namespace ContinuousBackupsDescription { + /** + * @internal + */ export const filterSensitiveLog = (obj: ContinuousBackupsDescription): any => ({ ...obj, }); @@ -1321,6 +1429,9 @@ export interface ContinuousBackupsUnavailableException extends __SmithyException } export namespace ContinuousBackupsUnavailableException { + /** + * @internal + */ export const filterSensitiveLog = (obj: ContinuousBackupsUnavailableException): any => ({ ...obj, }); @@ -1351,6 +1462,9 @@ export interface ContributorInsightsSummary { } export namespace ContributorInsightsSummary { + /** + * @internal + */ export const filterSensitiveLog = (obj: ContributorInsightsSummary): any => ({ ...obj, }); @@ -1369,6 +1483,9 @@ export interface CreateBackupInput { } export namespace CreateBackupInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateBackupInput): any => ({ ...obj, }); @@ -1382,6 +1499,9 @@ export interface CreateBackupOutput { } export namespace CreateBackupOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateBackupOutput): any => ({ ...obj, }); @@ -1408,6 +1528,9 @@ export interface LimitExceededException extends __SmithyException, $MetadataBear } export namespace LimitExceededException { + /** + * @internal + */ export const filterSensitiveLog = (obj: LimitExceededException): any => ({ ...obj, }); @@ -1423,6 +1546,9 @@ export interface TableInUseException extends __SmithyException, $MetadataBearer } export namespace TableInUseException { + /** + * @internal + */ export const filterSensitiveLog = (obj: TableInUseException): any => ({ ...obj, }); @@ -1438,6 +1564,9 @@ export interface TableNotFoundException extends __SmithyException, $MetadataBear } export namespace TableNotFoundException { + /** + * @internal + */ export const filterSensitiveLog = (obj: TableNotFoundException): any => ({ ...obj, }); @@ -1472,6 +1601,9 @@ export interface CreateGlobalSecondaryIndexAction { } export namespace CreateGlobalSecondaryIndexAction { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateGlobalSecondaryIndexAction): any => ({ ...obj, }); @@ -1488,6 +1620,9 @@ export interface Replica { } export namespace Replica { + /** + * @internal + */ export const filterSensitiveLog = (obj: Replica): any => ({ ...obj, }); @@ -1506,6 +1641,9 @@ export interface CreateGlobalTableInput { } export namespace CreateGlobalTableInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateGlobalTableInput): any => ({ ...obj, }); @@ -1526,6 +1664,9 @@ export interface ProvisionedThroughputOverride { } export namespace ProvisionedThroughputOverride { + /** + * @internal + */ export const filterSensitiveLog = (obj: ProvisionedThroughputOverride): any => ({ ...obj, }); @@ -1547,6 +1688,9 @@ export interface ReplicaGlobalSecondaryIndexDescription { } export namespace ReplicaGlobalSecondaryIndexDescription { + /** + * @internal + */ export const filterSensitiveLog = (obj: ReplicaGlobalSecondaryIndexDescription): any => ({ ...obj, }); @@ -1642,6 +1786,9 @@ export interface ReplicaDescription { } export namespace ReplicaDescription { + /** + * @internal + */ export const filterSensitiveLog = (obj: ReplicaDescription): any => ({ ...obj, }); @@ -1696,6 +1843,9 @@ export interface GlobalTableDescription { } export namespace GlobalTableDescription { + /** + * @internal + */ export const filterSensitiveLog = (obj: GlobalTableDescription): any => ({ ...obj, }); @@ -1709,6 +1859,9 @@ export interface CreateGlobalTableOutput { } export namespace CreateGlobalTableOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateGlobalTableOutput): any => ({ ...obj, }); @@ -1724,6 +1877,9 @@ export interface GlobalTableAlreadyExistsException extends __SmithyException, $M } export namespace GlobalTableAlreadyExistsException { + /** + * @internal + */ export const filterSensitiveLog = (obj: GlobalTableAlreadyExistsException): any => ({ ...obj, }); @@ -1740,6 +1896,9 @@ export interface CreateReplicaAction { } export namespace CreateReplicaAction { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateReplicaAction): any => ({ ...obj, }); @@ -1762,6 +1921,9 @@ export interface ReplicaGlobalSecondaryIndex { } export namespace ReplicaGlobalSecondaryIndex { + /** + * @internal + */ export const filterSensitiveLog = (obj: ReplicaGlobalSecondaryIndex): any => ({ ...obj, }); @@ -1797,6 +1959,9 @@ export interface CreateReplicationGroupMemberAction { } export namespace CreateReplicationGroupMemberAction { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateReplicationGroupMemberAction): any => ({ ...obj, }); @@ -1849,6 +2014,9 @@ export interface GlobalSecondaryIndex { } export namespace GlobalSecondaryIndex { + /** + * @internal + */ export const filterSensitiveLog = (obj: GlobalSecondaryIndex): any => ({ ...obj, }); @@ -1895,6 +2063,9 @@ export interface LocalSecondaryIndex { } export namespace LocalSecondaryIndex { + /** + * @internal + */ export const filterSensitiveLog = (obj: LocalSecondaryIndex): any => ({ ...obj, }); @@ -1934,6 +2105,9 @@ export interface SSESpecification { } export namespace SSESpecification { + /** + * @internal + */ export const filterSensitiveLog = (obj: SSESpecification): any => ({ ...obj, }); @@ -1965,6 +2139,9 @@ export interface Tag { } export namespace Tag { + /** + * @internal + */ export const filterSensitiveLog = (obj: Tag): any => ({ ...obj, }); @@ -2229,6 +2406,9 @@ export interface CreateTableInput { } export namespace CreateTableInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateTableInput): any => ({ ...obj, }); @@ -2272,6 +2452,9 @@ export interface ProvisionedThroughputDescription { } export namespace ProvisionedThroughputDescription { + /** + * @internal + */ export const filterSensitiveLog = (obj: ProvisionedThroughputDescription): any => ({ ...obj, }); @@ -2377,6 +2560,9 @@ export interface GlobalSecondaryIndexDescription { } export namespace GlobalSecondaryIndexDescription { + /** + * @internal + */ export const filterSensitiveLog = (obj: GlobalSecondaryIndexDescription): any => ({ ...obj, }); @@ -2438,6 +2624,9 @@ export interface LocalSecondaryIndexDescription { } export namespace LocalSecondaryIndexDescription { + /** + * @internal + */ export const filterSensitiveLog = (obj: LocalSecondaryIndexDescription): any => ({ ...obj, }); @@ -2469,6 +2658,9 @@ export interface RestoreSummary { } export namespace RestoreSummary { + /** + * @internal + */ export const filterSensitiveLog = (obj: RestoreSummary): any => ({ ...obj, }); @@ -2858,6 +3050,9 @@ export interface TableDescription { } export namespace TableDescription { + /** + * @internal + */ export const filterSensitiveLog = (obj: TableDescription): any => ({ ...obj, }); @@ -2874,6 +3069,9 @@ export interface CreateTableOutput { } export namespace CreateTableOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateTableOutput): any => ({ ...obj, }); @@ -2894,6 +3092,9 @@ export interface ResourceInUseException extends __SmithyException, $MetadataBear } export namespace ResourceInUseException { + /** + * @internal + */ export const filterSensitiveLog = (obj: ResourceInUseException): any => ({ ...obj, }); @@ -2907,6 +3108,9 @@ export interface DeleteBackupInput { } export namespace DeleteBackupInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteBackupInput): any => ({ ...obj, }); @@ -2920,6 +3124,9 @@ export interface DeleteBackupOutput { } export namespace DeleteBackupOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteBackupOutput): any => ({ ...obj, }); @@ -2936,6 +3143,9 @@ export interface DeleteGlobalSecondaryIndexAction { } export namespace DeleteGlobalSecondaryIndexAction { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteGlobalSecondaryIndexAction): any => ({ ...obj, }); @@ -2953,6 +3163,9 @@ export interface TransactionConflictException extends __SmithyException, $Metada } export namespace TransactionConflictException { + /** + * @internal + */ export const filterSensitiveLog = (obj: TransactionConflictException): any => ({ ...obj, }); @@ -2969,6 +3182,9 @@ export interface DeleteReplicaAction { } export namespace DeleteReplicaAction { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteReplicaAction): any => ({ ...obj, }); @@ -2985,6 +3201,9 @@ export interface DeleteReplicationGroupMemberAction { } export namespace DeleteReplicationGroupMemberAction { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteReplicationGroupMemberAction): any => ({ ...obj, }); @@ -3001,6 +3220,9 @@ export interface DeleteTableInput { } export namespace DeleteTableInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteTableInput): any => ({ ...obj, }); @@ -3017,6 +3239,9 @@ export interface DeleteTableOutput { } export namespace DeleteTableOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteTableOutput): any => ({ ...obj, }); @@ -3030,6 +3255,9 @@ export interface DescribeBackupInput { } export namespace DescribeBackupInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeBackupInput): any => ({ ...obj, }); @@ -3043,6 +3271,9 @@ export interface DescribeBackupOutput { } export namespace DescribeBackupOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeBackupOutput): any => ({ ...obj, }); @@ -3056,6 +3287,9 @@ export interface DescribeContinuousBackupsInput { } export namespace DescribeContinuousBackupsInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeContinuousBackupsInput): any => ({ ...obj, }); @@ -3069,6 +3303,9 @@ export interface DescribeContinuousBackupsOutput { } export namespace DescribeContinuousBackupsOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeContinuousBackupsOutput): any => ({ ...obj, }); @@ -3087,6 +3324,9 @@ export interface DescribeContributorInsightsInput { } export namespace DescribeContributorInsightsInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeContributorInsightsInput): any => ({ ...obj, }); @@ -3108,6 +3348,9 @@ export interface FailureException { } export namespace FailureException { + /** + * @internal + */ export const filterSensitiveLog = (obj: FailureException): any => ({ ...obj, }); @@ -3162,6 +3405,9 @@ export interface DescribeContributorInsightsOutput { } export namespace DescribeContributorInsightsOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeContributorInsightsOutput): any => ({ ...obj, }); @@ -3170,6 +3416,9 @@ export namespace DescribeContributorInsightsOutput { export interface DescribeEndpointsRequest {} export namespace DescribeEndpointsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeEndpointsRequest): any => ({ ...obj, }); @@ -3191,6 +3440,9 @@ export interface Endpoint { } export namespace Endpoint { + /** + * @internal + */ export const filterSensitiveLog = (obj: Endpoint): any => ({ ...obj, }); @@ -3204,6 +3456,9 @@ export interface DescribeEndpointsResponse { } export namespace DescribeEndpointsResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeEndpointsResponse): any => ({ ...obj, }); @@ -3217,6 +3472,9 @@ export interface DescribeExportInput { } export namespace DescribeExportInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeExportInput): any => ({ ...obj, }); @@ -3352,6 +3610,9 @@ export interface ExportDescription { } export namespace ExportDescription { + /** + * @internal + */ export const filterSensitiveLog = (obj: ExportDescription): any => ({ ...obj, }); @@ -3365,6 +3626,9 @@ export interface DescribeExportOutput { } export namespace DescribeExportOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeExportOutput): any => ({ ...obj, }); @@ -3380,6 +3644,9 @@ export interface ExportNotFoundException extends __SmithyException, $MetadataBea } export namespace ExportNotFoundException { + /** + * @internal + */ export const filterSensitiveLog = (obj: ExportNotFoundException): any => ({ ...obj, }); @@ -3393,6 +3660,9 @@ export interface DescribeGlobalTableInput { } export namespace DescribeGlobalTableInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeGlobalTableInput): any => ({ ...obj, }); @@ -3406,6 +3676,9 @@ export interface DescribeGlobalTableOutput { } export namespace DescribeGlobalTableOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeGlobalTableOutput): any => ({ ...obj, }); @@ -3421,6 +3694,9 @@ export interface GlobalTableNotFoundException extends __SmithyException, $Metada } export namespace GlobalTableNotFoundException { + /** + * @internal + */ export const filterSensitiveLog = (obj: GlobalTableNotFoundException): any => ({ ...obj, }); @@ -3434,6 +3710,9 @@ export interface DescribeGlobalTableSettingsInput { } export namespace DescribeGlobalTableSettingsInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeGlobalTableSettingsInput): any => ({ ...obj, }); @@ -3495,6 +3774,9 @@ export interface ReplicaGlobalSecondaryIndexSettingsDescription { } export namespace ReplicaGlobalSecondaryIndexSettingsDescription { + /** + * @internal + */ export const filterSensitiveLog = (obj: ReplicaGlobalSecondaryIndexSettingsDescription): any => ({ ...obj, }); @@ -3569,6 +3851,9 @@ export interface ReplicaSettingsDescription { } export namespace ReplicaSettingsDescription { + /** + * @internal + */ export const filterSensitiveLog = (obj: ReplicaSettingsDescription): any => ({ ...obj, }); @@ -3587,6 +3872,9 @@ export interface DescribeGlobalTableSettingsOutput { } export namespace DescribeGlobalTableSettingsOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeGlobalTableSettingsOutput): any => ({ ...obj, }); @@ -3600,6 +3888,9 @@ export interface DescribeKinesisStreamingDestinationInput { } export namespace DescribeKinesisStreamingDestinationInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeKinesisStreamingDestinationInput): any => ({ ...obj, }); @@ -3628,6 +3919,9 @@ export interface KinesisDataStreamDestination { } export namespace KinesisDataStreamDestination { + /** + * @internal + */ export const filterSensitiveLog = (obj: KinesisDataStreamDestination): any => ({ ...obj, }); @@ -3646,6 +3940,9 @@ export interface DescribeKinesisStreamingDestinationOutput { } export namespace DescribeKinesisStreamingDestinationOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeKinesisStreamingDestinationOutput): any => ({ ...obj, }); @@ -3657,6 +3954,9 @@ export namespace DescribeKinesisStreamingDestinationOutput { export interface DescribeLimitsInput {} export namespace DescribeLimitsInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeLimitsInput): any => ({ ...obj, }); @@ -3694,6 +3994,9 @@ export interface DescribeLimitsOutput { } export namespace DescribeLimitsOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeLimitsOutput): any => ({ ...obj, }); @@ -3710,6 +4013,9 @@ export interface DescribeTableInput { } export namespace DescribeTableInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeTableInput): any => ({ ...obj, }); @@ -3726,6 +4032,9 @@ export interface DescribeTableOutput { } export namespace DescribeTableOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeTableOutput): any => ({ ...obj, }); @@ -3739,6 +4048,9 @@ export interface DescribeTableReplicaAutoScalingInput { } export namespace DescribeTableReplicaAutoScalingInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeTableReplicaAutoScalingInput): any => ({ ...obj, }); @@ -3790,6 +4102,9 @@ export interface ReplicaGlobalSecondaryIndexAutoScalingDescription { } export namespace ReplicaGlobalSecondaryIndexAutoScalingDescription { + /** + * @internal + */ export const filterSensitiveLog = (obj: ReplicaGlobalSecondaryIndexAutoScalingDescription): any => ({ ...obj, }); @@ -3846,6 +4161,9 @@ export interface ReplicaAutoScalingDescription { } export namespace ReplicaAutoScalingDescription { + /** + * @internal + */ export const filterSensitiveLog = (obj: ReplicaAutoScalingDescription): any => ({ ...obj, }); @@ -3890,6 +4208,9 @@ export interface TableAutoScalingDescription { } export namespace TableAutoScalingDescription { + /** + * @internal + */ export const filterSensitiveLog = (obj: TableAutoScalingDescription): any => ({ ...obj, }); @@ -3903,6 +4224,9 @@ export interface DescribeTableReplicaAutoScalingOutput { } export namespace DescribeTableReplicaAutoScalingOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeTableReplicaAutoScalingOutput): any => ({ ...obj, }); @@ -3916,6 +4240,9 @@ export interface DescribeTimeToLiveInput { } export namespace DescribeTimeToLiveInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeTimeToLiveInput): any => ({ ...obj, }); @@ -3929,6 +4256,9 @@ export interface DescribeTimeToLiveOutput { } export namespace DescribeTimeToLiveOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeTimeToLiveOutput): any => ({ ...obj, }); @@ -3947,6 +4277,9 @@ export interface KinesisStreamingDestinationInput { } export namespace KinesisStreamingDestinationInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: KinesisStreamingDestinationInput): any => ({ ...obj, }); @@ -3970,6 +4303,9 @@ export interface KinesisStreamingDestinationOutput { } export namespace KinesisStreamingDestinationOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: KinesisStreamingDestinationOutput): any => ({ ...obj, }); @@ -3987,6 +4323,9 @@ export interface DuplicateItemException extends __SmithyException, $MetadataBear } export namespace DuplicateItemException { + /** + * @internal + */ export const filterSensitiveLog = (obj: DuplicateItemException): any => ({ ...obj, }); @@ -4003,6 +4342,9 @@ export interface IdempotentParameterMismatchException extends __SmithyException, } export namespace IdempotentParameterMismatchException { + /** + * @internal + */ export const filterSensitiveLog = (obj: IdempotentParameterMismatchException): any => ({ ...obj, }); @@ -4018,6 +4360,9 @@ export interface TransactionInProgressException extends __SmithyException, $Meta } export namespace TransactionInProgressException { + /** + * @internal + */ export const filterSensitiveLog = (obj: TransactionInProgressException): any => ({ ...obj, }); @@ -4033,6 +4378,9 @@ export interface ExportConflictException extends __SmithyException, $MetadataBea } export namespace ExportConflictException { + /** + * @internal + */ export const filterSensitiveLog = (obj: ExportConflictException): any => ({ ...obj, }); @@ -4110,6 +4458,9 @@ export interface ExportTableToPointInTimeInput { } export namespace ExportTableToPointInTimeInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: ExportTableToPointInTimeInput): any => ({ ...obj, }); @@ -4123,6 +4474,9 @@ export interface ExportTableToPointInTimeOutput { } export namespace ExportTableToPointInTimeOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: ExportTableToPointInTimeOutput): any => ({ ...obj, }); @@ -4139,6 +4493,9 @@ export interface InvalidExportTimeException extends __SmithyException, $Metadata } export namespace InvalidExportTimeException { + /** + * @internal + */ export const filterSensitiveLog = (obj: InvalidExportTimeException): any => ({ ...obj, }); @@ -4154,6 +4511,9 @@ export interface PointInTimeRecoveryUnavailableException extends __SmithyExcepti } export namespace PointInTimeRecoveryUnavailableException { + /** + * @internal + */ export const filterSensitiveLog = (obj: PointInTimeRecoveryUnavailableException): any => ({ ...obj, }); @@ -4212,6 +4572,9 @@ export interface ListBackupsInput { } export namespace ListBackupsInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListBackupsInput): any => ({ ...obj, }); @@ -4241,6 +4604,9 @@ export interface ListBackupsOutput { } export namespace ListBackupsOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListBackupsOutput): any => ({ ...obj, }); @@ -4264,6 +4630,9 @@ export interface ListContributorInsightsInput { } export namespace ListContributorInsightsInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListContributorInsightsInput): any => ({ ...obj, }); @@ -4282,6 +4651,9 @@ export interface ListContributorInsightsOutput { } export namespace ListContributorInsightsOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListContributorInsightsOutput): any => ({ ...obj, }); @@ -4307,6 +4679,9 @@ export interface ListExportsInput { } export namespace ListExportsInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListExportsInput): any => ({ ...obj, }); @@ -4328,6 +4703,9 @@ export interface ExportSummary { } export namespace ExportSummary { + /** + * @internal + */ export const filterSensitiveLog = (obj: ExportSummary): any => ({ ...obj, }); @@ -4348,6 +4726,9 @@ export interface ListExportsOutput { } export namespace ListExportsOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListExportsOutput): any => ({ ...obj, }); @@ -4373,6 +4754,9 @@ export interface ListGlobalTablesInput { } export namespace ListGlobalTablesInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListGlobalTablesInput): any => ({ ...obj, }); @@ -4394,6 +4778,9 @@ export interface GlobalTable { } export namespace GlobalTable { + /** + * @internal + */ export const filterSensitiveLog = (obj: GlobalTable): any => ({ ...obj, }); @@ -4412,6 +4799,9 @@ export interface ListGlobalTablesOutput { } export namespace ListGlobalTablesOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListGlobalTablesOutput): any => ({ ...obj, }); @@ -4435,6 +4825,9 @@ export interface ListTablesInput { } export namespace ListTablesInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListTablesInput): any => ({ ...obj, }); @@ -4463,6 +4856,9 @@ export interface ListTablesOutput { } export namespace ListTablesOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListTablesOutput): any => ({ ...obj, }); @@ -4482,6 +4878,9 @@ export interface ListTagsOfResourceInput { } export namespace ListTagsOfResourceInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListTagsOfResourceInput): any => ({ ...obj, }); @@ -4501,6 +4900,9 @@ export interface ListTagsOfResourceOutput { } export namespace ListTagsOfResourceOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListTagsOfResourceOutput): any => ({ ...obj, }); @@ -4550,6 +4952,9 @@ export interface RestoreTableFromBackupInput { } export namespace RestoreTableFromBackupInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: RestoreTableFromBackupInput): any => ({ ...obj, }); @@ -4563,6 +4968,9 @@ export interface RestoreTableFromBackupOutput { } export namespace RestoreTableFromBackupOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: RestoreTableFromBackupOutput): any => ({ ...obj, }); @@ -4578,6 +4986,9 @@ export interface TableAlreadyExistsException extends __SmithyException, $Metadat } export namespace TableAlreadyExistsException { + /** + * @internal + */ export const filterSensitiveLog = (obj: TableAlreadyExistsException): any => ({ ...obj, }); @@ -4593,6 +5004,9 @@ export interface InvalidRestoreTimeException extends __SmithyException, $Metadat } export namespace InvalidRestoreTimeException { + /** + * @internal + */ export const filterSensitiveLog = (obj: InvalidRestoreTimeException): any => ({ ...obj, }); @@ -4657,6 +5071,9 @@ export interface RestoreTableToPointInTimeInput { } export namespace RestoreTableToPointInTimeInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: RestoreTableToPointInTimeInput): any => ({ ...obj, }); @@ -4670,6 +5087,9 @@ export interface RestoreTableToPointInTimeOutput { } export namespace RestoreTableToPointInTimeOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: RestoreTableToPointInTimeOutput): any => ({ ...obj, }); @@ -4688,6 +5108,9 @@ export interface TagResourceInput { } export namespace TagResourceInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: TagResourceInput): any => ({ ...obj, }); @@ -4708,6 +5131,9 @@ export interface UntagResourceInput { } export namespace UntagResourceInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: UntagResourceInput): any => ({ ...obj, }); @@ -4724,6 +5150,9 @@ export interface PointInTimeRecoverySpecification { } export namespace PointInTimeRecoverySpecification { + /** + * @internal + */ export const filterSensitiveLog = (obj: PointInTimeRecoverySpecification): any => ({ ...obj, }); @@ -4742,6 +5171,9 @@ export interface UpdateContinuousBackupsInput { } export namespace UpdateContinuousBackupsInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateContinuousBackupsInput): any => ({ ...obj, }); @@ -4755,6 +5187,9 @@ export interface UpdateContinuousBackupsOutput { } export namespace UpdateContinuousBackupsOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateContinuousBackupsOutput): any => ({ ...obj, }); @@ -4778,6 +5213,9 @@ export interface UpdateContributorInsightsInput { } export namespace UpdateContributorInsightsInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateContributorInsightsInput): any => ({ ...obj, }); @@ -4801,6 +5239,9 @@ export interface UpdateContributorInsightsOutput { } export namespace UpdateContributorInsightsOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateContributorInsightsOutput): any => ({ ...obj, }); @@ -4816,6 +5257,9 @@ export interface ReplicaAlreadyExistsException extends __SmithyException, $Metad } export namespace ReplicaAlreadyExistsException { + /** + * @internal + */ export const filterSensitiveLog = (obj: ReplicaAlreadyExistsException): any => ({ ...obj, }); @@ -4831,6 +5275,9 @@ export interface ReplicaNotFoundException extends __SmithyException, $MetadataBe } export namespace ReplicaNotFoundException { + /** + * @internal + */ export const filterSensitiveLog = (obj: ReplicaNotFoundException): any => ({ ...obj, }); @@ -4863,6 +5310,9 @@ export interface ReplicaUpdate { } export namespace ReplicaUpdate { + /** + * @internal + */ export const filterSensitiveLog = (obj: ReplicaUpdate): any => ({ ...obj, }); @@ -4881,6 +5331,9 @@ export interface UpdateGlobalTableInput { } export namespace UpdateGlobalTableInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateGlobalTableInput): any => ({ ...obj, }); @@ -4894,6 +5347,9 @@ export interface UpdateGlobalTableOutput { } export namespace UpdateGlobalTableOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateGlobalTableOutput): any => ({ ...obj, }); @@ -4909,6 +5365,9 @@ export interface IndexNotFoundException extends __SmithyException, $MetadataBear } export namespace IndexNotFoundException { + /** + * @internal + */ export const filterSensitiveLog = (obj: IndexNotFoundException): any => ({ ...obj, }); @@ -4937,6 +5396,9 @@ export interface GlobalTableGlobalSecondaryIndexSettingsUpdate { } export namespace GlobalTableGlobalSecondaryIndexSettingsUpdate { + /** + * @internal + */ export const filterSensitiveLog = (obj: GlobalTableGlobalSecondaryIndexSettingsUpdate): any => ({ ...obj, }); @@ -4964,6 +5426,9 @@ export interface ReplicaGlobalSecondaryIndexSettingsUpdate { } export namespace ReplicaGlobalSecondaryIndexSettingsUpdate { + /** + * @internal + */ export const filterSensitiveLog = (obj: ReplicaGlobalSecondaryIndexSettingsUpdate): any => ({ ...obj, }); @@ -4998,6 +5463,9 @@ export interface ReplicaSettingsUpdate { } export namespace ReplicaSettingsUpdate { + /** + * @internal + */ export const filterSensitiveLog = (obj: ReplicaSettingsUpdate): any => ({ ...obj, }); @@ -5049,6 +5517,9 @@ export interface UpdateGlobalTableSettingsInput { } export namespace UpdateGlobalTableSettingsInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateGlobalTableSettingsInput): any => ({ ...obj, }); @@ -5067,6 +5538,9 @@ export interface UpdateGlobalTableSettingsOutput { } export namespace UpdateGlobalTableSettingsOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateGlobalTableSettingsOutput): any => ({ ...obj, }); @@ -5089,6 +5563,9 @@ export interface UpdateGlobalSecondaryIndexAction { } export namespace UpdateGlobalSecondaryIndexAction { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateGlobalSecondaryIndexAction): any => ({ ...obj, }); @@ -5153,6 +5630,9 @@ export interface GlobalSecondaryIndexUpdate { } export namespace GlobalSecondaryIndexUpdate { + /** + * @internal + */ export const filterSensitiveLog = (obj: GlobalSecondaryIndexUpdate): any => ({ ...obj, }); @@ -5188,6 +5668,9 @@ export interface UpdateReplicationGroupMemberAction { } export namespace UpdateReplicationGroupMemberAction { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateReplicationGroupMemberAction): any => ({ ...obj, }); @@ -5230,6 +5713,9 @@ export interface ReplicationGroupUpdate { } export namespace ReplicationGroupUpdate { + /** + * @internal + */ export const filterSensitiveLog = (obj: ReplicationGroupUpdate): any => ({ ...obj, }); @@ -5320,6 +5806,9 @@ export interface UpdateTableInput { } export namespace UpdateTableInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateTableInput): any => ({ ...obj, }); @@ -5336,6 +5825,9 @@ export interface UpdateTableOutput { } export namespace UpdateTableOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateTableOutput): any => ({ ...obj, }); @@ -5359,6 +5851,9 @@ export interface GlobalSecondaryIndexAutoScalingUpdate { } export namespace GlobalSecondaryIndexAutoScalingUpdate { + /** + * @internal + */ export const filterSensitiveLog = (obj: GlobalSecondaryIndexAutoScalingUpdate): any => ({ ...obj, }); @@ -5382,6 +5877,9 @@ export interface ReplicaGlobalSecondaryIndexAutoScalingUpdate { } export namespace ReplicaGlobalSecondaryIndexAutoScalingUpdate { + /** + * @internal + */ export const filterSensitiveLog = (obj: ReplicaGlobalSecondaryIndexAutoScalingUpdate): any => ({ ...obj, }); @@ -5410,6 +5908,9 @@ export interface ReplicaAutoScalingUpdate { } export namespace ReplicaAutoScalingUpdate { + /** + * @internal + */ export const filterSensitiveLog = (obj: ReplicaAutoScalingUpdate): any => ({ ...obj, }); @@ -5441,6 +5942,9 @@ export interface UpdateTableReplicaAutoScalingInput { } export namespace UpdateTableReplicaAutoScalingInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateTableReplicaAutoScalingInput): any => ({ ...obj, }); @@ -5454,6 +5958,9 @@ export interface UpdateTableReplicaAutoScalingOutput { } export namespace UpdateTableReplicaAutoScalingOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateTableReplicaAutoScalingOutput): any => ({ ...obj, }); @@ -5477,6 +5984,9 @@ export interface TimeToLiveSpecification { } export namespace TimeToLiveSpecification { + /** + * @internal + */ export const filterSensitiveLog = (obj: TimeToLiveSpecification): any => ({ ...obj, }); @@ -5498,6 +6008,9 @@ export interface UpdateTimeToLiveInput { } export namespace UpdateTimeToLiveInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateTimeToLiveInput): any => ({ ...obj, }); @@ -5511,6 +6024,9 @@ export interface UpdateTimeToLiveOutput { } export namespace UpdateTimeToLiveOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateTimeToLiveOutput): any => ({ ...obj, }); @@ -5780,6 +6296,9 @@ export namespace AttributeValue { return visitor._(value.$unknown[0], value.$unknown[1]); }; + /** + * @internal + */ export const filterSensitiveLog = (obj: AttributeValue): any => { if (obj.S !== undefined) return { S: obj.S }; if (obj.N !== undefined) return { N: obj.N }; @@ -5918,6 +6437,9 @@ export interface AttributeValueUpdate { } export namespace AttributeValueUpdate { + /** + * @internal + */ export const filterSensitiveLog = (obj: AttributeValueUpdate): any => ({ ...obj, ...(obj.Value && { Value: AttributeValue.filterSensitiveLog(obj.Value) }), @@ -5953,6 +6475,9 @@ export interface BatchStatementRequest { } export namespace BatchStatementRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: BatchStatementRequest): any => ({ ...obj, ...(obj.Parameters && { Parameters: obj.Parameters.map((item) => AttributeValue.filterSensitiveLog(item)) }), @@ -5988,6 +6513,9 @@ export interface BatchStatementResponse { } export namespace BatchStatementResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: BatchStatementResponse): any => ({ ...obj, ...(obj.Item && { @@ -6027,6 +6555,9 @@ export interface CancellationReason { } export namespace CancellationReason { + /** + * @internal + */ export const filterSensitiveLog = (obj: CancellationReason): any => ({ ...obj, ...(obj.Item && { @@ -6227,6 +6758,9 @@ export interface Condition { } export namespace Condition { + /** + * @internal + */ export const filterSensitiveLog = (obj: Condition): any => ({ ...obj, ...(obj.AttributeValueList && { @@ -6246,6 +6780,9 @@ export interface DeleteRequest { } export namespace DeleteRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteRequest): any => ({ ...obj, ...(obj.Key && { @@ -6291,6 +6828,9 @@ export interface ExecuteStatementInput { } export namespace ExecuteStatementInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: ExecuteStatementInput): any => ({ ...obj, ...(obj.Parameters && { Parameters: obj.Parameters.map((item) => AttributeValue.filterSensitiveLog(item)) }), @@ -6330,6 +6870,9 @@ export interface Get { } export namespace Get { + /** + * @internal + */ export const filterSensitiveLog = (obj: Get): any => ({ ...obj, ...(obj.Key && { @@ -6447,6 +6990,9 @@ export interface GetItemInput { } export namespace GetItemInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetItemInput): any => ({ ...obj, ...(obj.Key && { @@ -6483,6 +7029,9 @@ export interface GetItemOutput { } export namespace GetItemOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetItemOutput): any => ({ ...obj, ...(obj.Item && { @@ -6516,6 +7065,9 @@ export interface ItemCollectionMetrics { } export namespace ItemCollectionMetrics { + /** + * @internal + */ export const filterSensitiveLog = (obj: ItemCollectionMetrics): any => ({ ...obj, ...(obj.ItemCollectionKey && { @@ -6541,6 +7093,9 @@ export interface ItemResponse { } export namespace ItemResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ItemResponse): any => ({ ...obj, ...(obj.Item && { @@ -6577,6 +7132,9 @@ export interface ParameterizedStatement { } export namespace ParameterizedStatement { + /** + * @internal + */ export const filterSensitiveLog = (obj: ParameterizedStatement): any => ({ ...obj, ...(obj.Parameters && { Parameters: obj.Parameters.map((item) => AttributeValue.filterSensitiveLog(item)) }), @@ -6598,6 +7156,9 @@ export interface PutRequest { } export namespace PutRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: PutRequest): any => ({ ...obj, ...(obj.Item && { @@ -6629,6 +7190,9 @@ export interface ExecuteStatementOutput { } export namespace ExecuteStatementOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: ExecuteStatementOutput): any => ({ ...obj, ...(obj.Items && { @@ -6724,6 +7288,9 @@ export interface KeysAndAttributes { } export namespace KeysAndAttributes { + /** + * @internal + */ export const filterSensitiveLog = (obj: KeysAndAttributes): any => ({ ...obj, ...(obj.Keys && { @@ -6753,6 +7320,9 @@ export interface TransactGetItem { } export namespace TransactGetItem { + /** + * @internal + */ export const filterSensitiveLog = (obj: TransactGetItem): any => ({ ...obj, ...(obj.Get && { Get: Get.filterSensitiveLog(obj.Get) }), @@ -6769,6 +7339,9 @@ export interface BatchExecuteStatementInput { } export namespace BatchExecuteStatementInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: BatchExecuteStatementInput): any => ({ ...obj, ...(obj.Statements && { Statements: obj.Statements.map((item) => BatchStatementRequest.filterSensitiveLog(item)) }), @@ -6785,6 +7358,9 @@ export interface BatchExecuteStatementOutput { } export namespace BatchExecuteStatementOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: BatchExecuteStatementOutput): any => ({ ...obj, ...(obj.Responses && { Responses: obj.Responses.map((item) => BatchStatementResponse.filterSensitiveLog(item)) }), @@ -6808,6 +7384,9 @@ export interface ExecuteTransactionInput { } export namespace ExecuteTransactionInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: ExecuteTransactionInput): any => ({ ...obj, ...(obj.TransactStatements && { @@ -6826,6 +7405,9 @@ export interface ExecuteTransactionOutput { } export namespace ExecuteTransactionOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: ExecuteTransactionOutput): any => ({ ...obj, ...(obj.Responses && { Responses: obj.Responses.map((item) => ItemResponse.filterSensitiveLog(item)) }), @@ -6856,6 +7438,9 @@ export interface TransactGetItemsOutput { } export namespace TransactGetItemsOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: TransactGetItemsOutput): any => ({ ...obj, ...(obj.Responses && { Responses: obj.Responses.map((item) => ItemResponse.filterSensitiveLog(item)) }), @@ -7078,6 +7663,9 @@ export interface TransactionCanceledException extends __SmithyException, $Metada } export namespace TransactionCanceledException { + /** + * @internal + */ export const filterSensitiveLog = (obj: TransactionCanceledException): any => ({ ...obj, ...(obj.CancellationReasons && { @@ -7196,6 +7784,9 @@ export interface BatchGetItemInput { } export namespace BatchGetItemInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: BatchGetItemInput): any => ({ ...obj, ...(obj.RequestItems && { @@ -7443,6 +8034,9 @@ export interface ExpectedAttributeValue { } export namespace ExpectedAttributeValue { + /** + * @internal + */ export const filterSensitiveLog = (obj: ExpectedAttributeValue): any => ({ ...obj, ...(obj.Value && { Value: AttributeValue.filterSensitiveLog(obj.Value) }), @@ -7468,6 +8062,9 @@ export interface TransactGetItemsInput { } export namespace TransactGetItemsInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: TransactGetItemsInput): any => ({ ...obj, ...(obj.TransactItems && { @@ -7495,6 +8092,9 @@ export interface TransactWriteItemsOutput { } export namespace TransactWriteItemsOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: TransactWriteItemsOutput): any => ({ ...obj, ...(obj.ItemCollectionMetrics && { @@ -7550,6 +8150,9 @@ export interface ConditionCheck { } export namespace ConditionCheck { + /** + * @internal + */ export const filterSensitiveLog = (obj: ConditionCheck): any => ({ ...obj, ...(obj.Key && { @@ -7613,6 +8216,9 @@ export interface Delete { } export namespace Delete { + /** + * @internal + */ export const filterSensitiveLog = (obj: Delete): any => ({ ...obj, ...(obj.Key && { @@ -7679,6 +8285,9 @@ export interface Put { } export namespace Put { + /** + * @internal + */ export const filterSensitiveLog = (obj: Put): any => ({ ...obj, ...(obj.Item && { @@ -7749,6 +8358,9 @@ export interface Update { } export namespace Update { + /** + * @internal + */ export const filterSensitiveLog = (obj: Update): any => ({ ...obj, ...(obj.Key && { @@ -7825,6 +8437,9 @@ export interface DeleteItemOutput { } export namespace DeleteItemOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteItemOutput): any => ({ ...obj, ...(obj.Attributes && { @@ -7893,6 +8508,9 @@ export interface PutItemOutput { } export namespace PutItemOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: PutItemOutput): any => ({ ...obj, ...(obj.Attributes && { @@ -7958,6 +8576,9 @@ export interface QueryOutput { } export namespace QueryOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: QueryOutput): any => ({ ...obj, ...(obj.Items && { @@ -8036,6 +8657,9 @@ export interface ScanOutput { } export namespace ScanOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: ScanOutput): any => ({ ...obj, ...(obj.Items && { @@ -8114,6 +8738,9 @@ export interface UpdateItemOutput { } export namespace UpdateItemOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateItemOutput): any => ({ ...obj, ...(obj.Attributes && { @@ -8150,6 +8777,9 @@ export interface WriteRequest { } export namespace WriteRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: WriteRequest): any => ({ ...obj, ...(obj.PutRequest && { PutRequest: PutRequest.filterSensitiveLog(obj.PutRequest) }), @@ -8215,6 +8845,9 @@ export interface BatchGetItemOutput { } export namespace BatchGetItemOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: BatchGetItemOutput): any => ({ ...obj, ...(obj.Responses && { @@ -8516,6 +9149,9 @@ export interface ScanInput { } export namespace ScanInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: ScanInput): any => ({ ...obj, ...(obj.ScanFilter && { @@ -8621,6 +9257,9 @@ export interface BatchWriteItemInput { } export namespace BatchWriteItemInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: BatchWriteItemInput): any => ({ ...obj, ...(obj.RequestItems && { @@ -8804,6 +9443,9 @@ export interface DeleteItemInput { } export namespace DeleteItemInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteItemInput): any => ({ ...obj, ...(obj.Key && { @@ -9011,6 +9653,9 @@ export interface PutItemInput { } export namespace PutItemInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: PutItemInput): any => ({ ...obj, ...(obj.Item && { @@ -9404,6 +10049,9 @@ export interface QueryInput { } export namespace QueryInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: QueryInput): any => ({ ...obj, ...(obj.KeyConditions && { @@ -9533,6 +10181,9 @@ export interface BatchWriteItemOutput { } export namespace BatchWriteItemOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: BatchWriteItemOutput): any => ({ ...obj, ...(obj.UnprocessedItems && { @@ -9839,6 +10490,9 @@ export interface UpdateItemInput { } export namespace UpdateItemInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateItemInput): any => ({ ...obj, ...(obj.Key && { @@ -9906,6 +10560,9 @@ export interface TransactWriteItem { } export namespace TransactWriteItem { + /** + * @internal + */ export const filterSensitiveLog = (obj: TransactWriteItem): any => ({ ...obj, ...(obj.ConditionCheck && { ConditionCheck: ConditionCheck.filterSensitiveLog(obj.ConditionCheck) }), @@ -9976,6 +10633,9 @@ export interface TransactWriteItemsInput { } export namespace TransactWriteItemsInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: TransactWriteItemsInput): any => ({ ...obj, ...(obj.TransactItems && { diff --git a/clients/client-ebs/commands/CompleteSnapshotCommand.ts b/clients/client-ebs/commands/CompleteSnapshotCommand.ts index af012f38f6b9..2fb90a302f4a 100644 --- a/clients/client-ebs/commands/CompleteSnapshotCommand.ts +++ b/clients/client-ebs/commands/CompleteSnapshotCommand.ts @@ -24,6 +24,20 @@ export interface CompleteSnapshotCommandOutput extends CompleteSnapshotResponse, *

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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { EBSClient, CompleteSnapshotCommand } from "@aws-sdk/client-ebs"; // ES Modules import + * // const { EBSClient, CompleteSnapshotCommand } = require("@aws-sdk/client-ebs"); // CommonJS import + * const client = new EBSClient(config); + * const command = new CompleteSnapshotCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CompleteSnapshotCommandInput} for command's `input` shape. + * @see {@link CompleteSnapshotCommandOutput} for command's `response` shape. + * @see {@link EBSClientResolvedConfig | config} for command's `input` shape. + * */ export class CompleteSnapshotCommand extends $Command< CompleteSnapshotCommandInput, diff --git a/clients/client-ebs/commands/GetSnapshotBlockCommand.ts b/clients/client-ebs/commands/GetSnapshotBlockCommand.ts index 5f7450af04a0..06c3bacbadb9 100644 --- a/clients/client-ebs/commands/GetSnapshotBlockCommand.ts +++ b/clients/client-ebs/commands/GetSnapshotBlockCommand.ts @@ -22,6 +22,20 @@ export interface GetSnapshotBlockCommandOutput extends GetSnapshotBlockResponse, /** *

Returns the data in a block in an Amazon Elastic Block Store snapshot.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { EBSClient, GetSnapshotBlockCommand } from "@aws-sdk/client-ebs"; // ES Modules import + * // const { EBSClient, GetSnapshotBlockCommand } = require("@aws-sdk/client-ebs"); // CommonJS import + * const client = new EBSClient(config); + * const command = new GetSnapshotBlockCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetSnapshotBlockCommandInput} for command's `input` shape. + * @see {@link GetSnapshotBlockCommandOutput} for command's `response` shape. + * @see {@link EBSClientResolvedConfig | config} for command's `input` shape. + * */ export class GetSnapshotBlockCommand extends $Command< GetSnapshotBlockCommandInput, diff --git a/clients/client-ebs/commands/ListChangedBlocksCommand.ts b/clients/client-ebs/commands/ListChangedBlocksCommand.ts index 5de4ceb1f4d9..6aa1dd1206a7 100644 --- a/clients/client-ebs/commands/ListChangedBlocksCommand.ts +++ b/clients/client-ebs/commands/ListChangedBlocksCommand.ts @@ -23,6 +23,20 @@ export interface ListChangedBlocksCommandOutput extends ListChangedBlocksRespons /** *

Returns information about the blocks that are different between two * Amazon Elastic Block Store snapshots of the same volume/snapshot lineage.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { EBSClient, ListChangedBlocksCommand } from "@aws-sdk/client-ebs"; // ES Modules import + * // const { EBSClient, ListChangedBlocksCommand } = require("@aws-sdk/client-ebs"); // CommonJS import + * const client = new EBSClient(config); + * const command = new ListChangedBlocksCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListChangedBlocksCommandInput} for command's `input` shape. + * @see {@link ListChangedBlocksCommandOutput} for command's `response` shape. + * @see {@link EBSClientResolvedConfig | config} for command's `input` shape. + * */ export class ListChangedBlocksCommand extends $Command< ListChangedBlocksCommandInput, diff --git a/clients/client-ebs/commands/ListSnapshotBlocksCommand.ts b/clients/client-ebs/commands/ListSnapshotBlocksCommand.ts index c86eb84395b3..8cb28f5bca57 100644 --- a/clients/client-ebs/commands/ListSnapshotBlocksCommand.ts +++ b/clients/client-ebs/commands/ListSnapshotBlocksCommand.ts @@ -22,6 +22,20 @@ export interface ListSnapshotBlocksCommandOutput extends ListSnapshotBlocksRespo /** *

Returns information about the blocks in an Amazon Elastic Block Store snapshot.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { EBSClient, ListSnapshotBlocksCommand } from "@aws-sdk/client-ebs"; // ES Modules import + * // const { EBSClient, ListSnapshotBlocksCommand } = require("@aws-sdk/client-ebs"); // CommonJS import + * const client = new EBSClient(config); + * const command = new ListSnapshotBlocksCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListSnapshotBlocksCommandInput} for command's `input` shape. + * @see {@link ListSnapshotBlocksCommandOutput} for command's `response` shape. + * @see {@link EBSClientResolvedConfig | config} for command's `input` shape. + * */ export class ListSnapshotBlocksCommand extends $Command< ListSnapshotBlocksCommandInput, diff --git a/clients/client-ebs/commands/PutSnapshotBlockCommand.ts b/clients/client-ebs/commands/PutSnapshotBlockCommand.ts index 8a2816f2fa75..23a8c080d97f 100644 --- a/clients/client-ebs/commands/PutSnapshotBlockCommand.ts +++ b/clients/client-ebs/commands/PutSnapshotBlockCommand.ts @@ -34,6 +34,20 @@ export interface PutSnapshotBlockCommandOutput extends PutSnapshotBlockResponse, * 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-byte sectors.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { EBSClient, PutSnapshotBlockCommand } from "@aws-sdk/client-ebs"; // ES Modules import + * // const { EBSClient, PutSnapshotBlockCommand } = require("@aws-sdk/client-ebs"); // CommonJS import + * const client = new EBSClient(config); + * const command = new PutSnapshotBlockCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link PutSnapshotBlockCommandInput} for command's `input` shape. + * @see {@link PutSnapshotBlockCommandOutput} for command's `response` shape. + * @see {@link EBSClientResolvedConfig | config} for command's `input` shape. + * */ export class PutSnapshotBlockCommand extends $Command< PutSnapshotBlockCommandInput, diff --git a/clients/client-ebs/commands/StartSnapshotCommand.ts b/clients/client-ebs/commands/StartSnapshotCommand.ts index 98feb0544302..fa2f9df8a3b2 100644 --- a/clients/client-ebs/commands/StartSnapshotCommand.ts +++ b/clients/client-ebs/commands/StartSnapshotCommand.ts @@ -25,6 +25,20 @@ export interface StartSnapshotCommandOutput extends StartSnapshotResponse, __Met * after the request completes.

*

After creating the snapshot, use PutSnapshotBlock to * write blocks of data to the snapshot.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { EBSClient, StartSnapshotCommand } from "@aws-sdk/client-ebs"; // ES Modules import + * // const { EBSClient, StartSnapshotCommand } = require("@aws-sdk/client-ebs"); // CommonJS import + * const client = new EBSClient(config); + * const command = new StartSnapshotCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link StartSnapshotCommandInput} for command's `input` shape. + * @see {@link StartSnapshotCommandOutput} for command's `response` shape. + * @see {@link EBSClientResolvedConfig | config} for command's `input` shape. + * */ export class StartSnapshotCommand extends $Command< StartSnapshotCommandInput, diff --git a/clients/client-ebs/models/models_0.ts b/clients/client-ebs/models/models_0.ts index f970c1eb245e..81ffbe02d16e 100644 --- a/clients/client-ebs/models/models_0.ts +++ b/clients/client-ebs/models/models_0.ts @@ -21,6 +21,9 @@ export interface AccessDeniedException extends __SmithyException, $MetadataBeare } export namespace AccessDeniedException { + /** + * @internal + */ export const filterSensitiveLog = (obj: AccessDeniedException): any => ({ ...obj, }); @@ -42,6 +45,9 @@ export interface Block { } export namespace Block { + /** + * @internal + */ export const filterSensitiveLog = (obj: Block): any => ({ ...obj, }); @@ -72,6 +78,9 @@ export interface ChangedBlock { } export namespace ChangedBlock { + /** + * @internal + */ export const filterSensitiveLog = (obj: ChangedBlock): any => ({ ...obj, }); @@ -120,6 +129,9 @@ export interface CompleteSnapshotRequest { } export namespace CompleteSnapshotRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: CompleteSnapshotRequest): any => ({ ...obj, }); @@ -139,6 +151,9 @@ export interface CompleteSnapshotResponse { } export namespace CompleteSnapshotResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: CompleteSnapshotResponse): any => ({ ...obj, }); @@ -154,6 +169,9 @@ export interface InternalServerException extends __SmithyException, $MetadataBea } export namespace InternalServerException { + /** + * @internal + */ export const filterSensitiveLog = (obj: InternalServerException): any => ({ ...obj, }); @@ -179,6 +197,9 @@ export interface RequestThrottledException extends __SmithyException, $MetadataB } export namespace RequestThrottledException { + /** + * @internal + */ export const filterSensitiveLog = (obj: RequestThrottledException): any => ({ ...obj, }); @@ -203,6 +224,9 @@ export interface ResourceNotFoundException extends __SmithyException, $MetadataB } export namespace ResourceNotFoundException { + /** + * @internal + */ export const filterSensitiveLog = (obj: ResourceNotFoundException): any => ({ ...obj, }); @@ -226,6 +250,9 @@ export interface ServiceQuotaExceededException extends __SmithyException, $Metad } export namespace ServiceQuotaExceededException { + /** + * @internal + */ export const filterSensitiveLog = (obj: ServiceQuotaExceededException): any => ({ ...obj, }); @@ -259,6 +286,9 @@ export interface ValidationException extends __SmithyException, $MetadataBearer } export namespace ValidationException { + /** + * @internal + */ export const filterSensitiveLog = (obj: ValidationException): any => ({ ...obj, }); @@ -276,6 +306,9 @@ export interface ConcurrentLimitExceededException extends __SmithyException, $Me } export namespace ConcurrentLimitExceededException { + /** + * @internal + */ export const filterSensitiveLog = (obj: ConcurrentLimitExceededException): any => ({ ...obj, }); @@ -292,6 +325,9 @@ export interface ConflictException extends __SmithyException, $MetadataBearer { } export namespace ConflictException { + /** + * @internal + */ export const filterSensitiveLog = (obj: ConflictException): any => ({ ...obj, }); @@ -323,6 +359,9 @@ export interface GetSnapshotBlockRequest { } export namespace GetSnapshotBlockRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetSnapshotBlockRequest): any => ({ ...obj, }); @@ -351,6 +390,9 @@ export interface GetSnapshotBlockResponse { } export namespace GetSnapshotBlockResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetSnapshotBlockResponse): any => ({ ...obj, ...(obj.BlockData && { BlockData: SENSITIVE_STRING }), @@ -395,6 +437,9 @@ export interface ListChangedBlocksRequest { } export namespace ListChangedBlocksRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListChangedBlocksRequest): any => ({ ...obj, }); @@ -429,6 +474,9 @@ export interface ListChangedBlocksResponse { } export namespace ListChangedBlocksResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListChangedBlocksResponse): any => ({ ...obj, ...(obj.ChangedBlocks && { ChangedBlocks: SENSITIVE_STRING }), @@ -459,6 +507,9 @@ export interface ListSnapshotBlocksRequest { } export namespace ListSnapshotBlocksRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListSnapshotBlocksRequest): any => ({ ...obj, }); @@ -493,6 +544,9 @@ export interface ListSnapshotBlocksResponse { } export namespace ListSnapshotBlocksResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListSnapshotBlocksResponse): any => ({ ...obj, ...(obj.Blocks && { Blocks: SENSITIVE_STRING }), @@ -556,6 +610,9 @@ export interface PutSnapshotBlockRequest { } export namespace PutSnapshotBlockRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: PutSnapshotBlockRequest): any => ({ ...obj, ...(obj.BlockData && { BlockData: SENSITIVE_STRING }), @@ -575,6 +632,9 @@ export interface PutSnapshotBlockResponse { } export namespace PutSnapshotBlockResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: PutSnapshotBlockResponse): any => ({ ...obj, }); @@ -596,6 +656,9 @@ export interface Tag { } export namespace Tag { + /** + * @internal + */ export const filterSensitiveLog = (obj: Tag): any => ({ ...obj, }); @@ -687,6 +750,9 @@ export interface StartSnapshotRequest { } export namespace StartSnapshotRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: StartSnapshotRequest): any => ({ ...obj, ...(obj.KmsKeyArn && { KmsKeyArn: SENSITIVE_STRING }), @@ -749,6 +815,9 @@ export interface StartSnapshotResponse { } export namespace StartSnapshotResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: StartSnapshotResponse): any => ({ ...obj, ...(obj.KmsKeyArn && { KmsKeyArn: SENSITIVE_STRING }), diff --git a/clients/client-ec2-instance-connect/commands/SendSSHPublicKeyCommand.ts b/clients/client-ec2-instance-connect/commands/SendSSHPublicKeyCommand.ts index bb79d6c5f7da..0d5c20c1b7c1 100644 --- a/clients/client-ec2-instance-connect/commands/SendSSHPublicKeyCommand.ts +++ b/clients/client-ec2-instance-connect/commands/SendSSHPublicKeyCommand.ts @@ -29,6 +29,20 @@ export interface SendSSHPublicKeyCommandOutput extends SendSSHPublicKeyResponse, * 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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { EC2InstanceConnectClient, SendSSHPublicKeyCommand } from "@aws-sdk/client-ec2-instance-connect"; // ES Modules import + * // const { EC2InstanceConnectClient, SendSSHPublicKeyCommand } = require("@aws-sdk/client-ec2-instance-connect"); // CommonJS import + * const client = new EC2InstanceConnectClient(config); + * const command = new SendSSHPublicKeyCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link SendSSHPublicKeyCommandInput} for command's `input` shape. + * @see {@link SendSSHPublicKeyCommandOutput} for command's `response` shape. + * @see {@link EC2InstanceConnectClientResolvedConfig | config} for command's `input` shape. + * */ export class SendSSHPublicKeyCommand extends $Command< SendSSHPublicKeyCommandInput, diff --git a/clients/client-ec2-instance-connect/commands/SendSerialConsoleSSHPublicKeyCommand.ts b/clients/client-ec2-instance-connect/commands/SendSerialConsoleSSHPublicKeyCommand.ts index 5ee9412015f5..5094ee926a77 100644 --- a/clients/client-ec2-instance-connect/commands/SendSerialConsoleSSHPublicKeyCommand.ts +++ b/clients/client-ec2-instance-connect/commands/SendSerialConsoleSSHPublicKeyCommand.ts @@ -31,6 +31,20 @@ export interface SendSerialConsoleSSHPublicKeyCommandOutput * 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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { EC2InstanceConnectClient, SendSerialConsoleSSHPublicKeyCommand } from "@aws-sdk/client-ec2-instance-connect"; // ES Modules import + * // const { EC2InstanceConnectClient, SendSerialConsoleSSHPublicKeyCommand } = require("@aws-sdk/client-ec2-instance-connect"); // CommonJS import + * const client = new EC2InstanceConnectClient(config); + * const command = new SendSerialConsoleSSHPublicKeyCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link SendSerialConsoleSSHPublicKeyCommandInput} for command's `input` shape. + * @see {@link SendSerialConsoleSSHPublicKeyCommandOutput} for command's `response` shape. + * @see {@link EC2InstanceConnectClientResolvedConfig | config} for command's `input` shape. + * */ export class SendSerialConsoleSSHPublicKeyCommand extends $Command< SendSerialConsoleSSHPublicKeyCommandInput, diff --git a/clients/client-ec2-instance-connect/models/models_0.ts b/clients/client-ec2-instance-connect/models/models_0.ts index a33a5d731663..c444be498fb1 100644 --- a/clients/client-ec2-instance-connect/models/models_0.ts +++ b/clients/client-ec2-instance-connect/models/models_0.ts @@ -11,6 +11,9 @@ export interface AuthException extends __SmithyException, $MetadataBearer { } export namespace AuthException { + /** + * @internal + */ export const filterSensitiveLog = (obj: AuthException): any => ({ ...obj, }); @@ -26,6 +29,9 @@ export interface EC2InstanceNotFoundException extends __SmithyException, $Metada } export namespace EC2InstanceNotFoundException { + /** + * @internal + */ export const filterSensitiveLog = (obj: EC2InstanceNotFoundException): any => ({ ...obj, }); @@ -42,6 +48,9 @@ export interface EC2InstanceTypeInvalidException extends __SmithyException, $Met } export namespace EC2InstanceTypeInvalidException { + /** + * @internal + */ export const filterSensitiveLog = (obj: EC2InstanceTypeInvalidException): any => ({ ...obj, }); @@ -57,6 +66,9 @@ export interface InvalidArgsException extends __SmithyException, $MetadataBearer } export namespace InvalidArgsException { + /** + * @internal + */ export const filterSensitiveLog = (obj: InvalidArgsException): any => ({ ...obj, }); @@ -83,6 +95,9 @@ export interface SendSerialConsoleSSHPublicKeyRequest { } export namespace SendSerialConsoleSSHPublicKeyRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: SendSerialConsoleSSHPublicKeyRequest): any => ({ ...obj, }); @@ -101,6 +116,9 @@ export interface SendSerialConsoleSSHPublicKeyResponse { } export namespace SendSerialConsoleSSHPublicKeyResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: SendSerialConsoleSSHPublicKeyResponse): any => ({ ...obj, }); @@ -118,6 +136,9 @@ export interface SerialConsoleAccessDisabledException extends __SmithyException, } export namespace SerialConsoleAccessDisabledException { + /** + * @internal + */ export const filterSensitiveLog = (obj: SerialConsoleAccessDisabledException): any => ({ ...obj, }); @@ -133,6 +154,9 @@ export interface SerialConsoleSessionLimitExceededException extends __SmithyExce } export namespace SerialConsoleSessionLimitExceededException { + /** + * @internal + */ export const filterSensitiveLog = (obj: SerialConsoleSessionLimitExceededException): any => ({ ...obj, }); @@ -148,6 +172,9 @@ export interface SerialConsoleSessionUnavailableException extends __SmithyExcept } export namespace SerialConsoleSessionUnavailableException { + /** + * @internal + */ export const filterSensitiveLog = (obj: SerialConsoleSessionUnavailableException): any => ({ ...obj, }); @@ -163,6 +190,9 @@ export interface ServiceException extends __SmithyException, $MetadataBearer { } export namespace ServiceException { + /** + * @internal + */ export const filterSensitiveLog = (obj: ServiceException): any => ({ ...obj, }); @@ -179,6 +209,9 @@ export interface ThrottlingException extends __SmithyException, $MetadataBearer } export namespace ThrottlingException { + /** + * @internal + */ export const filterSensitiveLog = (obj: ThrottlingException): any => ({ ...obj, }); @@ -207,6 +240,9 @@ export interface SendSSHPublicKeyRequest { } export namespace SendSSHPublicKeyRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: SendSSHPublicKeyRequest): any => ({ ...obj, }); @@ -225,6 +261,9 @@ export interface SendSSHPublicKeyResponse { } export namespace SendSSHPublicKeyResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: SendSSHPublicKeyResponse): any => ({ ...obj, }); diff --git a/clients/client-ec2/commands/AcceptReservedInstancesExchangeQuoteCommand.ts b/clients/client-ec2/commands/AcceptReservedInstancesExchangeQuoteCommand.ts index b88885cf0edf..515e31d0744c 100644 --- a/clients/client-ec2/commands/AcceptReservedInstancesExchangeQuoteCommand.ts +++ b/clients/client-ec2/commands/AcceptReservedInstancesExchangeQuoteCommand.ts @@ -27,6 +27,20 @@ export interface AcceptReservedInstancesExchangeQuoteCommandOutput /** *

Accepts the Convertible Reserved Instance exchange quote described in the GetReservedInstancesExchangeQuote call.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { EC2Client, AcceptReservedInstancesExchangeQuoteCommand } from "@aws-sdk/client-ec2"; // ES Modules import + * // const { EC2Client, AcceptReservedInstancesExchangeQuoteCommand } = require("@aws-sdk/client-ec2"); // CommonJS import + * const client = new EC2Client(config); + * const command = new AcceptReservedInstancesExchangeQuoteCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link AcceptReservedInstancesExchangeQuoteCommandInput} for command's `input` shape. + * @see {@link AcceptReservedInstancesExchangeQuoteCommandOutput} for command's `response` shape. + * @see {@link EC2ClientResolvedConfig | config} for command's `input` shape. + * */ export class AcceptReservedInstancesExchangeQuoteCommand extends $Command< AcceptReservedInstancesExchangeQuoteCommandInput, diff --git a/clients/client-ec2/commands/AcceptTransitGatewayMulticastDomainAssociationsCommand.ts b/clients/client-ec2/commands/AcceptTransitGatewayMulticastDomainAssociationsCommand.ts index e2bebeccd761..669a5ad861da 100644 --- a/clients/client-ec2/commands/AcceptTransitGatewayMulticastDomainAssociationsCommand.ts +++ b/clients/client-ec2/commands/AcceptTransitGatewayMulticastDomainAssociationsCommand.ts @@ -28,6 +28,20 @@ export interface AcceptTransitGatewayMulticastDomainAssociationsCommandOutput /** *

Accepts a request to associate subnets with a transit gateway multicast domain.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { EC2Client, AcceptTransitGatewayMulticastDomainAssociationsCommand } from "@aws-sdk/client-ec2"; // ES Modules import + * // const { EC2Client, AcceptTransitGatewayMulticastDomainAssociationsCommand } = require("@aws-sdk/client-ec2"); // CommonJS import + * const client = new EC2Client(config); + * const command = new AcceptTransitGatewayMulticastDomainAssociationsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link AcceptTransitGatewayMulticastDomainAssociationsCommandInput} for command's `input` shape. + * @see {@link AcceptTransitGatewayMulticastDomainAssociationsCommandOutput} for command's `response` shape. + * @see {@link EC2ClientResolvedConfig | config} for command's `input` shape. + * */ export class AcceptTransitGatewayMulticastDomainAssociationsCommand extends $Command< AcceptTransitGatewayMulticastDomainAssociationsCommandInput, diff --git a/clients/client-ec2/commands/AcceptTransitGatewayPeeringAttachmentCommand.ts b/clients/client-ec2/commands/AcceptTransitGatewayPeeringAttachmentCommand.ts index c26f06a5f4d4..a6e84412ef51 100644 --- a/clients/client-ec2/commands/AcceptTransitGatewayPeeringAttachmentCommand.ts +++ b/clients/client-ec2/commands/AcceptTransitGatewayPeeringAttachmentCommand.ts @@ -29,6 +29,20 @@ export interface AcceptTransitGatewayPeeringAttachmentCommandOutput /** *

Accepts a transit gateway peering attachment request. The peering attachment must be * in the pendingAcceptance state.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { EC2Client, AcceptTransitGatewayPeeringAttachmentCommand } from "@aws-sdk/client-ec2"; // ES Modules import + * // const { EC2Client, AcceptTransitGatewayPeeringAttachmentCommand } = require("@aws-sdk/client-ec2"); // CommonJS import + * const client = new EC2Client(config); + * const command = new AcceptTransitGatewayPeeringAttachmentCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link AcceptTransitGatewayPeeringAttachmentCommandInput} for command's `input` shape. + * @see {@link AcceptTransitGatewayPeeringAttachmentCommandOutput} for command's `response` shape. + * @see {@link EC2ClientResolvedConfig | config} for command's `input` shape. + * */ export class AcceptTransitGatewayPeeringAttachmentCommand extends $Command< AcceptTransitGatewayPeeringAttachmentCommandInput, diff --git a/clients/client-ec2/commands/AcceptTransitGatewayVpcAttachmentCommand.ts b/clients/client-ec2/commands/AcceptTransitGatewayVpcAttachmentCommand.ts index af76d3eaa0ae..dca89dc053ca 100644 --- a/clients/client-ec2/commands/AcceptTransitGatewayVpcAttachmentCommand.ts +++ b/clients/client-ec2/commands/AcceptTransitGatewayVpcAttachmentCommand.ts @@ -27,6 +27,20 @@ export interface AcceptTransitGatewayVpcAttachmentCommandOutput *

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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { EC2Client, AcceptTransitGatewayVpcAttachmentCommand } from "@aws-sdk/client-ec2"; // ES Modules import + * // const { EC2Client, AcceptTransitGatewayVpcAttachmentCommand } = require("@aws-sdk/client-ec2"); // CommonJS import + * const client = new EC2Client(config); + * const command = new AcceptTransitGatewayVpcAttachmentCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link AcceptTransitGatewayVpcAttachmentCommandInput} for command's `input` shape. + * @see {@link AcceptTransitGatewayVpcAttachmentCommandOutput} for command's `response` shape. + * @see {@link EC2ClientResolvedConfig | config} for command's `input` shape. + * */ export class AcceptTransitGatewayVpcAttachmentCommand extends $Command< AcceptTransitGatewayVpcAttachmentCommandInput, diff --git a/clients/client-ec2/commands/AcceptVpcEndpointConnectionsCommand.ts b/clients/client-ec2/commands/AcceptVpcEndpointConnectionsCommand.ts index 70567b27d94b..ff4235a5845d 100644 --- a/clients/client-ec2/commands/AcceptVpcEndpointConnectionsCommand.ts +++ b/clients/client-ec2/commands/AcceptVpcEndpointConnectionsCommand.ts @@ -25,6 +25,20 @@ export interface AcceptVpcEndpointConnectionsCommandOutput /** *

Accepts one or more interface VPC endpoint connection requests to your VPC endpoint * service.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { EC2Client, AcceptVpcEndpointConnectionsCommand } from "@aws-sdk/client-ec2"; // ES Modules import + * // const { EC2Client, AcceptVpcEndpointConnectionsCommand } = require("@aws-sdk/client-ec2"); // CommonJS import + * const client = new EC2Client(config); + * const command = new AcceptVpcEndpointConnectionsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link AcceptVpcEndpointConnectionsCommandInput} for command's `input` shape. + * @see {@link AcceptVpcEndpointConnectionsCommandOutput} for command's `response` shape. + * @see {@link EC2ClientResolvedConfig | config} for command's `input` shape. + * */ export class AcceptVpcEndpointConnectionsCommand extends $Command< AcceptVpcEndpointConnectionsCommandInput, diff --git a/clients/client-ec2/commands/AcceptVpcPeeringConnectionCommand.ts b/clients/client-ec2/commands/AcceptVpcPeeringConnectionCommand.ts index 7c1e1a1c5bec..1fe0661da074 100644 --- a/clients/client-ec2/commands/AcceptVpcPeeringConnectionCommand.ts +++ b/clients/client-ec2/commands/AcceptVpcPeeringConnectionCommand.ts @@ -27,6 +27,20 @@ export interface AcceptVpcPeeringConnectionCommandOutput extends AcceptVpcPeerin * 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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { EC2Client, AcceptVpcPeeringConnectionCommand } from "@aws-sdk/client-ec2"; // ES Modules import + * // const { EC2Client, AcceptVpcPeeringConnectionCommand } = require("@aws-sdk/client-ec2"); // CommonJS import + * const client = new EC2Client(config); + * const command = new AcceptVpcPeeringConnectionCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link AcceptVpcPeeringConnectionCommandInput} for command's `input` shape. + * @see {@link AcceptVpcPeeringConnectionCommandOutput} for command's `response` shape. + * @see {@link EC2ClientResolvedConfig | config} for command's `input` shape. + * */ export class AcceptVpcPeeringConnectionCommand extends $Command< AcceptVpcPeeringConnectionCommandInput, diff --git a/clients/client-ec2/commands/AdvertiseByoipCidrCommand.ts b/clients/client-ec2/commands/AdvertiseByoipCidrCommand.ts index bd4f6dbbcbbc..4f79a70eff83 100644 --- a/clients/client-ec2/commands/AdvertiseByoipCidrCommand.ts +++ b/clients/client-ec2/commands/AdvertiseByoipCidrCommand.ts @@ -32,6 +32,20 @@ export interface AdvertiseByoipCidrCommandOutput extends AdvertiseByoipCidrResul *

It can take a few minutes before traffic to the specified addresses starts routing to AWS * because of BGP propagation delays.

*

To stop advertising the BYOIP CIDR, use WithdrawByoipCidr.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { EC2Client, AdvertiseByoipCidrCommand } from "@aws-sdk/client-ec2"; // ES Modules import + * // const { EC2Client, AdvertiseByoipCidrCommand } = require("@aws-sdk/client-ec2"); // CommonJS import + * const client = new EC2Client(config); + * const command = new AdvertiseByoipCidrCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link AdvertiseByoipCidrCommandInput} for command's `input` shape. + * @see {@link AdvertiseByoipCidrCommandOutput} for command's `response` shape. + * @see {@link EC2ClientResolvedConfig | config} for command's `input` shape. + * */ export class AdvertiseByoipCidrCommand extends $Command< AdvertiseByoipCidrCommandInput, diff --git a/clients/client-ec2/commands/AllocateAddressCommand.ts b/clients/client-ec2/commands/AllocateAddressCommand.ts index 64ec5bf6a596..7bb78a973682 100644 --- a/clients/client-ec2/commands/AllocateAddressCommand.ts +++ b/clients/client-ec2/commands/AllocateAddressCommand.ts @@ -31,6 +31,20 @@ export interface AllocateAddressCommandOutput extends AllocateAddressResult, __M * 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).

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { EC2Client, AllocateAddressCommand } from "@aws-sdk/client-ec2"; // ES Modules import + * // const { EC2Client, AllocateAddressCommand } = require("@aws-sdk/client-ec2"); // CommonJS import + * const client = new EC2Client(config); + * const command = new AllocateAddressCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link AllocateAddressCommandInput} for command's `input` shape. + * @see {@link AllocateAddressCommandOutput} for command's `response` shape. + * @see {@link EC2ClientResolvedConfig | config} for command's `input` shape. + * */ export class AllocateAddressCommand extends $Command< AllocateAddressCommandInput, diff --git a/clients/client-ec2/commands/AllocateHostsCommand.ts b/clients/client-ec2/commands/AllocateHostsCommand.ts index 05deafef0b24..359f4d13f71b 100644 --- a/clients/client-ec2/commands/AllocateHostsCommand.ts +++ b/clients/client-ec2/commands/AllocateHostsCommand.ts @@ -21,6 +21,20 @@ export interface AllocateHostsCommandOutput extends AllocateHostsResult, __Metad *

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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { EC2Client, AllocateHostsCommand } from "@aws-sdk/client-ec2"; // ES Modules import + * // const { EC2Client, AllocateHostsCommand } = require("@aws-sdk/client-ec2"); // CommonJS import + * const client = new EC2Client(config); + * const command = new AllocateHostsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link AllocateHostsCommandInput} for command's `input` shape. + * @see {@link AllocateHostsCommandOutput} for command's `response` shape. + * @see {@link EC2ClientResolvedConfig | config} for command's `input` shape. + * */ export class AllocateHostsCommand extends $Command< AllocateHostsCommandInput, diff --git a/clients/client-ec2/commands/ApplySecurityGroupsToClientVpnTargetNetworkCommand.ts b/clients/client-ec2/commands/ApplySecurityGroupsToClientVpnTargetNetworkCommand.ts index 6825ddc2b98f..8b9d41994183 100644 --- a/clients/client-ec2/commands/ApplySecurityGroupsToClientVpnTargetNetworkCommand.ts +++ b/clients/client-ec2/commands/ApplySecurityGroupsToClientVpnTargetNetworkCommand.ts @@ -29,6 +29,20 @@ export interface ApplySecurityGroupsToClientVpnTargetNetworkCommandOutput /** *

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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { EC2Client, ApplySecurityGroupsToClientVpnTargetNetworkCommand } from "@aws-sdk/client-ec2"; // ES Modules import + * // const { EC2Client, ApplySecurityGroupsToClientVpnTargetNetworkCommand } = require("@aws-sdk/client-ec2"); // CommonJS import + * const client = new EC2Client(config); + * const command = new ApplySecurityGroupsToClientVpnTargetNetworkCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ApplySecurityGroupsToClientVpnTargetNetworkCommandInput} for command's `input` shape. + * @see {@link ApplySecurityGroupsToClientVpnTargetNetworkCommandOutput} for command's `response` shape. + * @see {@link EC2ClientResolvedConfig | config} for command's `input` shape. + * */ export class ApplySecurityGroupsToClientVpnTargetNetworkCommand extends $Command< ApplySecurityGroupsToClientVpnTargetNetworkCommandInput, diff --git a/clients/client-ec2/commands/AssignIpv6AddressesCommand.ts b/clients/client-ec2/commands/AssignIpv6AddressesCommand.ts index 62c825238b76..e2e7d677a1c1 100644 --- a/clients/client-ec2/commands/AssignIpv6AddressesCommand.ts +++ b/clients/client-ec2/commands/AssignIpv6AddressesCommand.ts @@ -28,6 +28,20 @@ export interface AssignIpv6AddressesCommandOutput extends AssignIpv6AddressesRes * 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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { EC2Client, AssignIpv6AddressesCommand } from "@aws-sdk/client-ec2"; // ES Modules import + * // const { EC2Client, AssignIpv6AddressesCommand } = require("@aws-sdk/client-ec2"); // CommonJS import + * const client = new EC2Client(config); + * const command = new AssignIpv6AddressesCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link AssignIpv6AddressesCommandInput} for command's `input` shape. + * @see {@link AssignIpv6AddressesCommandOutput} for command's `response` shape. + * @see {@link EC2ClientResolvedConfig | config} for command's `input` shape. + * */ export class AssignIpv6AddressesCommand extends $Command< AssignIpv6AddressesCommandInput, diff --git a/clients/client-ec2/commands/AssignPrivateIpAddressesCommand.ts b/clients/client-ec2/commands/AssignPrivateIpAddressesCommand.ts index dd4a24b336bc..13f4abffa764 100644 --- a/clients/client-ec2/commands/AssignPrivateIpAddressesCommand.ts +++ b/clients/client-ec2/commands/AssignPrivateIpAddressesCommand.ts @@ -33,6 +33,20 @@ export interface AssignPrivateIpAddressesCommandOutput extends AssignPrivateIpAd * 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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { EC2Client, AssignPrivateIpAddressesCommand } from "@aws-sdk/client-ec2"; // ES Modules import + * // const { EC2Client, AssignPrivateIpAddressesCommand } = require("@aws-sdk/client-ec2"); // CommonJS import + * const client = new EC2Client(config); + * const command = new AssignPrivateIpAddressesCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link AssignPrivateIpAddressesCommandInput} for command's `input` shape. + * @see {@link AssignPrivateIpAddressesCommandOutput} for command's `response` shape. + * @see {@link EC2ClientResolvedConfig | config} for command's `input` shape. + * */ export class AssignPrivateIpAddressesCommand extends $Command< AssignPrivateIpAddressesCommandInput, diff --git a/clients/client-ec2/commands/AssociateAddressCommand.ts b/clients/client-ec2/commands/AssociateAddressCommand.ts index f94c3d072d0f..f3e4c7c088f6 100644 --- a/clients/client-ec2/commands/AssociateAddressCommand.ts +++ b/clients/client-ec2/commands/AssociateAddressCommand.ts @@ -46,6 +46,20 @@ export interface AssociateAddressCommandOutput extends AssociateAddressResult, _ * Addresses section of Amazon EC2 * Pricing.

* + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { EC2Client, AssociateAddressCommand } from "@aws-sdk/client-ec2"; // ES Modules import + * // const { EC2Client, AssociateAddressCommand } = require("@aws-sdk/client-ec2"); // CommonJS import + * const client = new EC2Client(config); + * const command = new AssociateAddressCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link AssociateAddressCommandInput} for command's `input` shape. + * @see {@link AssociateAddressCommandOutput} for command's `response` shape. + * @see {@link EC2ClientResolvedConfig | config} for command's `input` shape. + * */ export class AssociateAddressCommand extends $Command< AssociateAddressCommandInput, diff --git a/clients/client-ec2/commands/AssociateClientVpnTargetNetworkCommand.ts b/clients/client-ec2/commands/AssociateClientVpnTargetNetworkCommand.ts index bd0f411f94a7..dc52c008d85f 100644 --- a/clients/client-ec2/commands/AssociateClientVpnTargetNetworkCommand.ts +++ b/clients/client-ec2/commands/AssociateClientVpnTargetNetworkCommand.ts @@ -25,6 +25,20 @@ export interface AssociateClientVpnTargetNetworkCommandOutput /** *

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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { EC2Client, AssociateClientVpnTargetNetworkCommand } from "@aws-sdk/client-ec2"; // ES Modules import + * // const { EC2Client, AssociateClientVpnTargetNetworkCommand } = require("@aws-sdk/client-ec2"); // CommonJS import + * const client = new EC2Client(config); + * const command = new AssociateClientVpnTargetNetworkCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link AssociateClientVpnTargetNetworkCommandInput} for command's `input` shape. + * @see {@link AssociateClientVpnTargetNetworkCommandOutput} for command's `response` shape. + * @see {@link EC2ClientResolvedConfig | config} for command's `input` shape. + * */ export class AssociateClientVpnTargetNetworkCommand extends $Command< AssociateClientVpnTargetNetworkCommandInput, diff --git a/clients/client-ec2/commands/AssociateDhcpOptionsCommand.ts b/clients/client-ec2/commands/AssociateDhcpOptionsCommand.ts index dd7fc3b52b46..5a6233d888d0 100644 --- a/clients/client-ec2/commands/AssociateDhcpOptionsCommand.ts +++ b/clients/client-ec2/commands/AssociateDhcpOptionsCommand.ts @@ -25,6 +25,20 @@ export interface AssociateDhcpOptionsCommandOutput extends __MetadataBearer {} *

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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { EC2Client, AssociateDhcpOptionsCommand } from "@aws-sdk/client-ec2"; // ES Modules import + * // const { EC2Client, AssociateDhcpOptionsCommand } = require("@aws-sdk/client-ec2"); // CommonJS import + * const client = new EC2Client(config); + * const command = new AssociateDhcpOptionsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link AssociateDhcpOptionsCommandInput} for command's `input` shape. + * @see {@link AssociateDhcpOptionsCommandOutput} for command's `response` shape. + * @see {@link EC2ClientResolvedConfig | config} for command's `input` shape. + * */ export class AssociateDhcpOptionsCommand extends $Command< AssociateDhcpOptionsCommandInput, diff --git a/clients/client-ec2/commands/AssociateEnclaveCertificateIamRoleCommand.ts b/clients/client-ec2/commands/AssociateEnclaveCertificateIamRoleCommand.ts index d2290ea0c613..512703bb09ac 100644 --- a/clients/client-ec2/commands/AssociateEnclaveCertificateIamRoleCommand.ts +++ b/clients/client-ec2/commands/AssociateEnclaveCertificateIamRoleCommand.ts @@ -41,6 +41,20 @@ export interface AssociateEnclaveCertificateIamRoleCommandOutput * information, see * Grant the role permission to access the certificate and encryption key in the * AWS Nitro Enclaves User Guide.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { EC2Client, AssociateEnclaveCertificateIamRoleCommand } from "@aws-sdk/client-ec2"; // ES Modules import + * // const { EC2Client, AssociateEnclaveCertificateIamRoleCommand } = require("@aws-sdk/client-ec2"); // CommonJS import + * const client = new EC2Client(config); + * const command = new AssociateEnclaveCertificateIamRoleCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link AssociateEnclaveCertificateIamRoleCommandInput} for command's `input` shape. + * @see {@link AssociateEnclaveCertificateIamRoleCommandOutput} for command's `response` shape. + * @see {@link EC2ClientResolvedConfig | config} for command's `input` shape. + * */ export class AssociateEnclaveCertificateIamRoleCommand extends $Command< AssociateEnclaveCertificateIamRoleCommandInput, diff --git a/clients/client-ec2/commands/AssociateIamInstanceProfileCommand.ts b/clients/client-ec2/commands/AssociateIamInstanceProfileCommand.ts index 175da28de591..66cff921880e 100644 --- a/clients/client-ec2/commands/AssociateIamInstanceProfileCommand.ts +++ b/clients/client-ec2/commands/AssociateIamInstanceProfileCommand.ts @@ -23,6 +23,20 @@ export interface AssociateIamInstanceProfileCommandOutput extends AssociateIamIn /** *

Associates an IAM instance profile with a running or stopped instance. You cannot * associate more than one IAM instance profile with an instance.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { EC2Client, AssociateIamInstanceProfileCommand } from "@aws-sdk/client-ec2"; // ES Modules import + * // const { EC2Client, AssociateIamInstanceProfileCommand } = require("@aws-sdk/client-ec2"); // CommonJS import + * const client = new EC2Client(config); + * const command = new AssociateIamInstanceProfileCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link AssociateIamInstanceProfileCommandInput} for command's `input` shape. + * @see {@link AssociateIamInstanceProfileCommandOutput} for command's `response` shape. + * @see {@link EC2ClientResolvedConfig | config} for command's `input` shape. + * */ export class AssociateIamInstanceProfileCommand extends $Command< AssociateIamInstanceProfileCommandInput, diff --git a/clients/client-ec2/commands/AssociateRouteTableCommand.ts b/clients/client-ec2/commands/AssociateRouteTableCommand.ts index 055d2eac531a..1372e39c64b0 100644 --- a/clients/client-ec2/commands/AssociateRouteTableCommand.ts +++ b/clients/client-ec2/commands/AssociateRouteTableCommand.ts @@ -28,6 +28,20 @@ export interface AssociateRouteTableCommandOutput extends AssociateRouteTableRes * 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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { EC2Client, AssociateRouteTableCommand } from "@aws-sdk/client-ec2"; // ES Modules import + * // const { EC2Client, AssociateRouteTableCommand } = require("@aws-sdk/client-ec2"); // CommonJS import + * const client = new EC2Client(config); + * const command = new AssociateRouteTableCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link AssociateRouteTableCommandInput} for command's `input` shape. + * @see {@link AssociateRouteTableCommandOutput} for command's `response` shape. + * @see {@link EC2ClientResolvedConfig | config} for command's `input` shape. + * */ export class AssociateRouteTableCommand extends $Command< AssociateRouteTableCommandInput, diff --git a/clients/client-ec2/commands/AssociateSubnetCidrBlockCommand.ts b/clients/client-ec2/commands/AssociateSubnetCidrBlockCommand.ts index 0998b22ac413..19267295ba24 100644 --- a/clients/client-ec2/commands/AssociateSubnetCidrBlockCommand.ts +++ b/clients/client-ec2/commands/AssociateSubnetCidrBlockCommand.ts @@ -23,6 +23,20 @@ export interface AssociateSubnetCidrBlockCommandOutput extends AssociateSubnetCi /** *

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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { EC2Client, AssociateSubnetCidrBlockCommand } from "@aws-sdk/client-ec2"; // ES Modules import + * // const { EC2Client, AssociateSubnetCidrBlockCommand } = require("@aws-sdk/client-ec2"); // CommonJS import + * const client = new EC2Client(config); + * const command = new AssociateSubnetCidrBlockCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link AssociateSubnetCidrBlockCommandInput} for command's `input` shape. + * @see {@link AssociateSubnetCidrBlockCommandOutput} for command's `response` shape. + * @see {@link EC2ClientResolvedConfig | config} for command's `input` shape. + * */ export class AssociateSubnetCidrBlockCommand extends $Command< AssociateSubnetCidrBlockCommandInput, diff --git a/clients/client-ec2/commands/AssociateTransitGatewayMulticastDomainCommand.ts b/clients/client-ec2/commands/AssociateTransitGatewayMulticastDomainCommand.ts index 55e0fd6380b7..6759e2e411ad 100644 --- a/clients/client-ec2/commands/AssociateTransitGatewayMulticastDomainCommand.ts +++ b/clients/client-ec2/commands/AssociateTransitGatewayMulticastDomainCommand.ts @@ -29,6 +29,20 @@ export interface AssociateTransitGatewayMulticastDomainCommandOutput /** *

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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { EC2Client, AssociateTransitGatewayMulticastDomainCommand } from "@aws-sdk/client-ec2"; // ES Modules import + * // const { EC2Client, AssociateTransitGatewayMulticastDomainCommand } = require("@aws-sdk/client-ec2"); // CommonJS import + * const client = new EC2Client(config); + * const command = new AssociateTransitGatewayMulticastDomainCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link AssociateTransitGatewayMulticastDomainCommandInput} for command's `input` shape. + * @see {@link AssociateTransitGatewayMulticastDomainCommandOutput} for command's `response` shape. + * @see {@link EC2ClientResolvedConfig | config} for command's `input` shape. + * */ export class AssociateTransitGatewayMulticastDomainCommand extends $Command< AssociateTransitGatewayMulticastDomainCommandInput, diff --git a/clients/client-ec2/commands/AssociateTransitGatewayRouteTableCommand.ts b/clients/client-ec2/commands/AssociateTransitGatewayRouteTableCommand.ts index 7b1f6e2e566a..0fb2abbf468f 100644 --- a/clients/client-ec2/commands/AssociateTransitGatewayRouteTableCommand.ts +++ b/clients/client-ec2/commands/AssociateTransitGatewayRouteTableCommand.ts @@ -25,6 +25,20 @@ export interface AssociateTransitGatewayRouteTableCommandOutput /** *

Associates the specified attachment with the specified transit gateway route table. You can * associate only one route table with an attachment.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { EC2Client, AssociateTransitGatewayRouteTableCommand } from "@aws-sdk/client-ec2"; // ES Modules import + * // const { EC2Client, AssociateTransitGatewayRouteTableCommand } = require("@aws-sdk/client-ec2"); // CommonJS import + * const client = new EC2Client(config); + * const command = new AssociateTransitGatewayRouteTableCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link AssociateTransitGatewayRouteTableCommandInput} for command's `input` shape. + * @see {@link AssociateTransitGatewayRouteTableCommandOutput} for command's `response` shape. + * @see {@link EC2ClientResolvedConfig | config} for command's `input` shape. + * */ export class AssociateTransitGatewayRouteTableCommand extends $Command< AssociateTransitGatewayRouteTableCommandInput, diff --git a/clients/client-ec2/commands/AssociateVpcCidrBlockCommand.ts b/clients/client-ec2/commands/AssociateVpcCidrBlockCommand.ts index c962855d3246..a3a485b0f7dc 100644 --- a/clients/client-ec2/commands/AssociateVpcCidrBlockCommand.ts +++ b/clients/client-ec2/commands/AssociateVpcCidrBlockCommand.ts @@ -30,6 +30,20 @@ export interface AssociateVpcCidrBlockCommandOutput extends AssociateVpcCidrBloc *

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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { EC2Client, AssociateVpcCidrBlockCommand } from "@aws-sdk/client-ec2"; // ES Modules import + * // const { EC2Client, AssociateVpcCidrBlockCommand } = require("@aws-sdk/client-ec2"); // CommonJS import + * const client = new EC2Client(config); + * const command = new AssociateVpcCidrBlockCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link AssociateVpcCidrBlockCommandInput} for command's `input` shape. + * @see {@link AssociateVpcCidrBlockCommandOutput} for command's `response` shape. + * @see {@link EC2ClientResolvedConfig | config} for command's `input` shape. + * */ export class AssociateVpcCidrBlockCommand extends $Command< AssociateVpcCidrBlockCommandInput, diff --git a/clients/client-ec2/commands/AttachClassicLinkVpcCommand.ts b/clients/client-ec2/commands/AttachClassicLinkVpcCommand.ts index 45974375074c..18ba5e134caa 100644 --- a/clients/client-ec2/commands/AttachClassicLinkVpcCommand.ts +++ b/clients/client-ec2/commands/AttachClassicLinkVpcCommand.ts @@ -28,6 +28,20 @@ export interface AttachClassicLinkVpcCommandOutput extends AttachClassicLinkVpcR * 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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { EC2Client, AttachClassicLinkVpcCommand } from "@aws-sdk/client-ec2"; // ES Modules import + * // const { EC2Client, AttachClassicLinkVpcCommand } = require("@aws-sdk/client-ec2"); // CommonJS import + * const client = new EC2Client(config); + * const command = new AttachClassicLinkVpcCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link AttachClassicLinkVpcCommandInput} for command's `input` shape. + * @see {@link AttachClassicLinkVpcCommandOutput} for command's `response` shape. + * @see {@link EC2ClientResolvedConfig | config} for command's `input` shape. + * */ export class AttachClassicLinkVpcCommand extends $Command< AttachClassicLinkVpcCommandInput, diff --git a/clients/client-ec2/commands/AttachInternetGatewayCommand.ts b/clients/client-ec2/commands/AttachInternetGatewayCommand.ts index 798e415703d9..0c4016266793 100644 --- a/clients/client-ec2/commands/AttachInternetGatewayCommand.ts +++ b/clients/client-ec2/commands/AttachInternetGatewayCommand.ts @@ -23,6 +23,20 @@ export interface AttachInternetGatewayCommandOutput extends __MetadataBearer {} /** *

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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { EC2Client, AttachInternetGatewayCommand } from "@aws-sdk/client-ec2"; // ES Modules import + * // const { EC2Client, AttachInternetGatewayCommand } = require("@aws-sdk/client-ec2"); // CommonJS import + * const client = new EC2Client(config); + * const command = new AttachInternetGatewayCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link AttachInternetGatewayCommandInput} for command's `input` shape. + * @see {@link AttachInternetGatewayCommandOutput} for command's `response` shape. + * @see {@link EC2ClientResolvedConfig | config} for command's `input` shape. + * */ export class AttachInternetGatewayCommand extends $Command< AttachInternetGatewayCommandInput, diff --git a/clients/client-ec2/commands/AttachNetworkInterfaceCommand.ts b/clients/client-ec2/commands/AttachNetworkInterfaceCommand.ts index d1f07409d615..50d9cc363299 100644 --- a/clients/client-ec2/commands/AttachNetworkInterfaceCommand.ts +++ b/clients/client-ec2/commands/AttachNetworkInterfaceCommand.ts @@ -22,6 +22,20 @@ export interface AttachNetworkInterfaceCommandOutput extends AttachNetworkInterf /** *

Attaches a network interface to an instance.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { EC2Client, AttachNetworkInterfaceCommand } from "@aws-sdk/client-ec2"; // ES Modules import + * // const { EC2Client, AttachNetworkInterfaceCommand } = require("@aws-sdk/client-ec2"); // CommonJS import + * const client = new EC2Client(config); + * const command = new AttachNetworkInterfaceCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link AttachNetworkInterfaceCommandInput} for command's `input` shape. + * @see {@link AttachNetworkInterfaceCommandOutput} for command's `response` shape. + * @see {@link EC2ClientResolvedConfig | config} for command's `input` shape. + * */ export class AttachNetworkInterfaceCommand extends $Command< AttachNetworkInterfaceCommandInput, diff --git a/clients/client-ec2/commands/AttachVolumeCommand.ts b/clients/client-ec2/commands/AttachVolumeCommand.ts index 1f0ac4fc3ac3..16cb3dc0e0f5 100644 --- a/clients/client-ec2/commands/AttachVolumeCommand.ts +++ b/clients/client-ec2/commands/AttachVolumeCommand.ts @@ -43,6 +43,20 @@ export interface AttachVolumeCommandOutput extends VolumeAttachment, __MetadataB * *

For more information, see Attaching Amazon EBS volumes in the * Amazon Elastic Compute Cloud User Guide.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { EC2Client, AttachVolumeCommand } from "@aws-sdk/client-ec2"; // ES Modules import + * // const { EC2Client, AttachVolumeCommand } = require("@aws-sdk/client-ec2"); // CommonJS import + * const client = new EC2Client(config); + * const command = new AttachVolumeCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link AttachVolumeCommandInput} for command's `input` shape. + * @see {@link AttachVolumeCommandOutput} for command's `response` shape. + * @see {@link EC2ClientResolvedConfig | config} for command's `input` shape. + * */ export class AttachVolumeCommand extends $Command< AttachVolumeCommandInput, diff --git a/clients/client-ec2/commands/AttachVpnGatewayCommand.ts b/clients/client-ec2/commands/AttachVpnGatewayCommand.ts index 42fc9b6fb862..f694fe88dfd9 100644 --- a/clients/client-ec2/commands/AttachVpnGatewayCommand.ts +++ b/clients/client-ec2/commands/AttachVpnGatewayCommand.ts @@ -24,6 +24,20 @@ export interface AttachVpnGatewayCommandOutput extends AttachVpnGatewayResult, _ *

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 AWS Site-to-Site VPN in the AWS Site-to-Site VPN User Guide.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { EC2Client, AttachVpnGatewayCommand } from "@aws-sdk/client-ec2"; // ES Modules import + * // const { EC2Client, AttachVpnGatewayCommand } = require("@aws-sdk/client-ec2"); // CommonJS import + * const client = new EC2Client(config); + * const command = new AttachVpnGatewayCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link AttachVpnGatewayCommandInput} for command's `input` shape. + * @see {@link AttachVpnGatewayCommandOutput} for command's `response` shape. + * @see {@link EC2ClientResolvedConfig | config} for command's `input` shape. + * */ export class AttachVpnGatewayCommand extends $Command< AttachVpnGatewayCommandInput, diff --git a/clients/client-ec2/commands/AuthorizeClientVpnIngressCommand.ts b/clients/client-ec2/commands/AuthorizeClientVpnIngressCommand.ts index b3c2a9411fb4..5edc15513522 100644 --- a/clients/client-ec2/commands/AuthorizeClientVpnIngressCommand.ts +++ b/clients/client-ec2/commands/AuthorizeClientVpnIngressCommand.ts @@ -24,6 +24,20 @@ export interface AuthorizeClientVpnIngressCommandOutput extends AuthorizeClientV *

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 AWS or on-premises networks.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { EC2Client, AuthorizeClientVpnIngressCommand } from "@aws-sdk/client-ec2"; // ES Modules import + * // const { EC2Client, AuthorizeClientVpnIngressCommand } = require("@aws-sdk/client-ec2"); // CommonJS import + * const client = new EC2Client(config); + * const command = new AuthorizeClientVpnIngressCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link AuthorizeClientVpnIngressCommandInput} for command's `input` shape. + * @see {@link AuthorizeClientVpnIngressCommandOutput} for command's `response` shape. + * @see {@link EC2ClientResolvedConfig | config} for command's `input` shape. + * */ export class AuthorizeClientVpnIngressCommand extends $Command< AuthorizeClientVpnIngressCommandInput, diff --git a/clients/client-ec2/commands/AuthorizeSecurityGroupEgressCommand.ts b/clients/client-ec2/commands/AuthorizeSecurityGroupEgressCommand.ts index 806ced736ffa..d771b2564a85 100644 --- a/clients/client-ec2/commands/AuthorizeSecurityGroupEgressCommand.ts +++ b/clients/client-ec2/commands/AuthorizeSecurityGroupEgressCommand.ts @@ -30,6 +30,20 @@ export interface AuthorizeSecurityGroupEgressCommandOutput extends __MetadataBea * 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 more information about VPC security group limits, see Amazon VPC Limits.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { EC2Client, AuthorizeSecurityGroupEgressCommand } from "@aws-sdk/client-ec2"; // ES Modules import + * // const { EC2Client, AuthorizeSecurityGroupEgressCommand } = require("@aws-sdk/client-ec2"); // CommonJS import + * const client = new EC2Client(config); + * const command = new AuthorizeSecurityGroupEgressCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link AuthorizeSecurityGroupEgressCommandInput} for command's `input` shape. + * @see {@link AuthorizeSecurityGroupEgressCommandOutput} for command's `response` shape. + * @see {@link EC2ClientResolvedConfig | config} for command's `input` shape. + * */ export class AuthorizeSecurityGroupEgressCommand extends $Command< AuthorizeSecurityGroupEgressCommandInput, diff --git a/clients/client-ec2/commands/AuthorizeSecurityGroupIngressCommand.ts b/clients/client-ec2/commands/AuthorizeSecurityGroupIngressCommand.ts index 9a34019e2971..148eecd226b3 100644 --- a/clients/client-ec2/commands/AuthorizeSecurityGroupIngressCommand.ts +++ b/clients/client-ec2/commands/AuthorizeSecurityGroupIngressCommand.ts @@ -31,6 +31,20 @@ export interface AuthorizeSecurityGroupIngressCommandOutput extends __MetadataBe *

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 limits, see Amazon VPC Limits.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { EC2Client, AuthorizeSecurityGroupIngressCommand } from "@aws-sdk/client-ec2"; // ES Modules import + * // const { EC2Client, AuthorizeSecurityGroupIngressCommand } = require("@aws-sdk/client-ec2"); // CommonJS import + * const client = new EC2Client(config); + * const command = new AuthorizeSecurityGroupIngressCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link AuthorizeSecurityGroupIngressCommandInput} for command's `input` shape. + * @see {@link AuthorizeSecurityGroupIngressCommandOutput} for command's `response` shape. + * @see {@link EC2ClientResolvedConfig | config} for command's `input` shape. + * */ export class AuthorizeSecurityGroupIngressCommand extends $Command< AuthorizeSecurityGroupIngressCommandInput, diff --git a/clients/client-ec2/commands/BundleInstanceCommand.ts b/clients/client-ec2/commands/BundleInstanceCommand.ts index bd4f56a8cc59..fa93ff3a5626 100644 --- a/clients/client-ec2/commands/BundleInstanceCommand.ts +++ b/clients/client-ec2/commands/BundleInstanceCommand.ts @@ -23,6 +23,20 @@ export interface BundleInstanceCommandOutput extends BundleInstanceResult, __Met * *

This action is not applicable for Linux/Unix instances or Windows instances that are backed by Amazon EBS.

* + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { EC2Client, BundleInstanceCommand } from "@aws-sdk/client-ec2"; // ES Modules import + * // const { EC2Client, BundleInstanceCommand } = require("@aws-sdk/client-ec2"); // CommonJS import + * const client = new EC2Client(config); + * const command = new BundleInstanceCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link BundleInstanceCommandInput} for command's `input` shape. + * @see {@link BundleInstanceCommandOutput} for command's `response` shape. + * @see {@link EC2ClientResolvedConfig | config} for command's `input` shape. + * */ export class BundleInstanceCommand extends $Command< BundleInstanceCommandInput, diff --git a/clients/client-ec2/commands/CancelBundleTaskCommand.ts b/clients/client-ec2/commands/CancelBundleTaskCommand.ts index 58e84f2fe287..6fb6e681b7b2 100644 --- a/clients/client-ec2/commands/CancelBundleTaskCommand.ts +++ b/clients/client-ec2/commands/CancelBundleTaskCommand.ts @@ -22,6 +22,20 @@ export interface CancelBundleTaskCommandOutput extends CancelBundleTaskResult, _ /** *

Cancels a bundling operation for an instance store-backed Windows instance.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { EC2Client, CancelBundleTaskCommand } from "@aws-sdk/client-ec2"; // ES Modules import + * // const { EC2Client, CancelBundleTaskCommand } = require("@aws-sdk/client-ec2"); // CommonJS import + * const client = new EC2Client(config); + * const command = new CancelBundleTaskCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CancelBundleTaskCommandInput} for command's `input` shape. + * @see {@link CancelBundleTaskCommandOutput} for command's `response` shape. + * @see {@link EC2ClientResolvedConfig | config} for command's `input` shape. + * */ export class CancelBundleTaskCommand extends $Command< CancelBundleTaskCommandInput, diff --git a/clients/client-ec2/commands/CancelCapacityReservationCommand.ts b/clients/client-ec2/commands/CancelCapacityReservationCommand.ts index d147680ce909..e074e01e590d 100644 --- a/clients/client-ec2/commands/CancelCapacityReservationCommand.ts +++ b/clients/client-ec2/commands/CancelCapacityReservationCommand.ts @@ -27,6 +27,20 @@ export interface CancelCapacityReservationCommandOutput extends CancelCapacityRe * 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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { EC2Client, CancelCapacityReservationCommand } from "@aws-sdk/client-ec2"; // ES Modules import + * // const { EC2Client, CancelCapacityReservationCommand } = require("@aws-sdk/client-ec2"); // CommonJS import + * const client = new EC2Client(config); + * const command = new CancelCapacityReservationCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CancelCapacityReservationCommandInput} for command's `input` shape. + * @see {@link CancelCapacityReservationCommandOutput} for command's `response` shape. + * @see {@link EC2ClientResolvedConfig | config} for command's `input` shape. + * */ export class CancelCapacityReservationCommand extends $Command< CancelCapacityReservationCommandInput, diff --git a/clients/client-ec2/commands/CancelConversionTaskCommand.ts b/clients/client-ec2/commands/CancelConversionTaskCommand.ts index 6625457495df..ac22fcf4b0ee 100644 --- a/clients/client-ec2/commands/CancelConversionTaskCommand.ts +++ b/clients/client-ec2/commands/CancelConversionTaskCommand.ts @@ -26,6 +26,20 @@ export interface CancelConversionTaskCommandOutput extends __MetadataBearer {} * 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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { EC2Client, CancelConversionTaskCommand } from "@aws-sdk/client-ec2"; // ES Modules import + * // const { EC2Client, CancelConversionTaskCommand } = require("@aws-sdk/client-ec2"); // CommonJS import + * const client = new EC2Client(config); + * const command = new CancelConversionTaskCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CancelConversionTaskCommandInput} for command's `input` shape. + * @see {@link CancelConversionTaskCommandOutput} for command's `response` shape. + * @see {@link EC2ClientResolvedConfig | config} for command's `input` shape. + * */ export class CancelConversionTaskCommand extends $Command< CancelConversionTaskCommandInput, diff --git a/clients/client-ec2/commands/CancelExportTaskCommand.ts b/clients/client-ec2/commands/CancelExportTaskCommand.ts index 0fcf5f02aae7..37f3fada3dd2 100644 --- a/clients/client-ec2/commands/CancelExportTaskCommand.ts +++ b/clients/client-ec2/commands/CancelExportTaskCommand.ts @@ -24,6 +24,20 @@ export interface CancelExportTaskCommandOutput extends __MetadataBearer {} *

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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { EC2Client, CancelExportTaskCommand } from "@aws-sdk/client-ec2"; // ES Modules import + * // const { EC2Client, CancelExportTaskCommand } = require("@aws-sdk/client-ec2"); // CommonJS import + * const client = new EC2Client(config); + * const command = new CancelExportTaskCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CancelExportTaskCommandInput} for command's `input` shape. + * @see {@link CancelExportTaskCommandOutput} for command's `response` shape. + * @see {@link EC2ClientResolvedConfig | config} for command's `input` shape. + * */ export class CancelExportTaskCommand extends $Command< CancelExportTaskCommandInput, diff --git a/clients/client-ec2/commands/CancelImportTaskCommand.ts b/clients/client-ec2/commands/CancelImportTaskCommand.ts index 1a60e3fec70c..96c1d09da036 100644 --- a/clients/client-ec2/commands/CancelImportTaskCommand.ts +++ b/clients/client-ec2/commands/CancelImportTaskCommand.ts @@ -22,6 +22,20 @@ export interface CancelImportTaskCommandOutput extends CancelImportTaskResult, _ /** *

Cancels an in-process import virtual machine or import snapshot task.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { EC2Client, CancelImportTaskCommand } from "@aws-sdk/client-ec2"; // ES Modules import + * // const { EC2Client, CancelImportTaskCommand } = require("@aws-sdk/client-ec2"); // CommonJS import + * const client = new EC2Client(config); + * const command = new CancelImportTaskCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CancelImportTaskCommandInput} for command's `input` shape. + * @see {@link CancelImportTaskCommandOutput} for command's `response` shape. + * @see {@link EC2ClientResolvedConfig | config} for command's `input` shape. + * */ export class CancelImportTaskCommand extends $Command< CancelImportTaskCommandInput, diff --git a/clients/client-ec2/commands/CancelReservedInstancesListingCommand.ts b/clients/client-ec2/commands/CancelReservedInstancesListingCommand.ts index b30d1548abf3..1cdfc645bf9c 100644 --- a/clients/client-ec2/commands/CancelReservedInstancesListingCommand.ts +++ b/clients/client-ec2/commands/CancelReservedInstancesListingCommand.ts @@ -27,6 +27,20 @@ export interface CancelReservedInstancesListingCommandOutput *

For more information, see * Reserved Instance Marketplace * in the Amazon EC2 User Guide.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { EC2Client, CancelReservedInstancesListingCommand } from "@aws-sdk/client-ec2"; // ES Modules import + * // const { EC2Client, CancelReservedInstancesListingCommand } = require("@aws-sdk/client-ec2"); // CommonJS import + * const client = new EC2Client(config); + * const command = new CancelReservedInstancesListingCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CancelReservedInstancesListingCommandInput} for command's `input` shape. + * @see {@link CancelReservedInstancesListingCommandOutput} for command's `response` shape. + * @see {@link EC2ClientResolvedConfig | config} for command's `input` shape. + * */ export class CancelReservedInstancesListingCommand extends $Command< CancelReservedInstancesListingCommandInput, diff --git a/clients/client-ec2/commands/CancelSpotFleetRequestsCommand.ts b/clients/client-ec2/commands/CancelSpotFleetRequestsCommand.ts index 41440ec8b02a..7eb0fe28c8f0 100644 --- a/clients/client-ec2/commands/CancelSpotFleetRequestsCommand.ts +++ b/clients/client-ec2/commands/CancelSpotFleetRequestsCommand.ts @@ -27,6 +27,20 @@ export interface CancelSpotFleetRequestsCommandOutput extends CancelSpotFleetReq * If you 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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { EC2Client, CancelSpotFleetRequestsCommand } from "@aws-sdk/client-ec2"; // ES Modules import + * // const { EC2Client, CancelSpotFleetRequestsCommand } = require("@aws-sdk/client-ec2"); // CommonJS import + * const client = new EC2Client(config); + * const command = new CancelSpotFleetRequestsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CancelSpotFleetRequestsCommandInput} for command's `input` shape. + * @see {@link CancelSpotFleetRequestsCommandOutput} for command's `response` shape. + * @see {@link EC2ClientResolvedConfig | config} for command's `input` shape. + * */ export class CancelSpotFleetRequestsCommand extends $Command< CancelSpotFleetRequestsCommandInput, diff --git a/clients/client-ec2/commands/CancelSpotInstanceRequestsCommand.ts b/clients/client-ec2/commands/CancelSpotInstanceRequestsCommand.ts index 1e54ce412169..62569a143b35 100644 --- a/clients/client-ec2/commands/CancelSpotInstanceRequestsCommand.ts +++ b/clients/client-ec2/commands/CancelSpotInstanceRequestsCommand.ts @@ -25,6 +25,20 @@ export interface CancelSpotInstanceRequestsCommandOutput extends CancelSpotInsta * *

Canceling a Spot Instance request does not terminate running Spot Instances associated with the request.

* + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { EC2Client, CancelSpotInstanceRequestsCommand } from "@aws-sdk/client-ec2"; // ES Modules import + * // const { EC2Client, CancelSpotInstanceRequestsCommand } = require("@aws-sdk/client-ec2"); // CommonJS import + * const client = new EC2Client(config); + * const command = new CancelSpotInstanceRequestsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CancelSpotInstanceRequestsCommandInput} for command's `input` shape. + * @see {@link CancelSpotInstanceRequestsCommandOutput} for command's `response` shape. + * @see {@link EC2ClientResolvedConfig | config} for command's `input` shape. + * */ export class CancelSpotInstanceRequestsCommand extends $Command< CancelSpotInstanceRequestsCommandInput, diff --git a/clients/client-ec2/commands/ConfirmProductInstanceCommand.ts b/clients/client-ec2/commands/ConfirmProductInstanceCommand.ts index 1581881660e9..43d450575730 100644 --- a/clients/client-ec2/commands/ConfirmProductInstanceCommand.ts +++ b/clients/client-ec2/commands/ConfirmProductInstanceCommand.ts @@ -24,6 +24,20 @@ export interface ConfirmProductInstanceCommandOutput extends ConfirmProductInsta *

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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { EC2Client, ConfirmProductInstanceCommand } from "@aws-sdk/client-ec2"; // ES Modules import + * // const { EC2Client, ConfirmProductInstanceCommand } = require("@aws-sdk/client-ec2"); // CommonJS import + * const client = new EC2Client(config); + * const command = new ConfirmProductInstanceCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ConfirmProductInstanceCommandInput} for command's `input` shape. + * @see {@link ConfirmProductInstanceCommandOutput} for command's `response` shape. + * @see {@link EC2ClientResolvedConfig | config} for command's `input` shape. + * */ export class ConfirmProductInstanceCommand extends $Command< ConfirmProductInstanceCommandInput, diff --git a/clients/client-ec2/commands/CopyFpgaImageCommand.ts b/clients/client-ec2/commands/CopyFpgaImageCommand.ts index f77b99fa4e77..b32a40d1fcc6 100644 --- a/clients/client-ec2/commands/CopyFpgaImageCommand.ts +++ b/clients/client-ec2/commands/CopyFpgaImageCommand.ts @@ -19,6 +19,20 @@ export interface CopyFpgaImageCommandOutput extends CopyFpgaImageResult, __Metad /** *

Copies the specified Amazon FPGA Image (AFI) to the current Region.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { EC2Client, CopyFpgaImageCommand } from "@aws-sdk/client-ec2"; // ES Modules import + * // const { EC2Client, CopyFpgaImageCommand } = require("@aws-sdk/client-ec2"); // CommonJS import + * const client = new EC2Client(config); + * const command = new CopyFpgaImageCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CopyFpgaImageCommandInput} for command's `input` shape. + * @see {@link CopyFpgaImageCommandOutput} for command's `response` shape. + * @see {@link EC2ClientResolvedConfig | config} for command's `input` shape. + * */ export class CopyFpgaImageCommand extends $Command< CopyFpgaImageCommandInput, diff --git a/clients/client-ec2/commands/CopyImageCommand.ts b/clients/client-ec2/commands/CopyImageCommand.ts index 8f7013c72697..bb5e611871ed 100644 --- a/clients/client-ec2/commands/CopyImageCommand.ts +++ b/clients/client-ec2/commands/CopyImageCommand.ts @@ -40,6 +40,20 @@ export interface CopyImageCommandOutput extends CopyImageResult, __MetadataBeare * *

For more information about the prerequisites and limits when copying an AMI, see Copying an AMI * in the Amazon Elastic Compute Cloud User Guide.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { EC2Client, CopyImageCommand } from "@aws-sdk/client-ec2"; // ES Modules import + * // const { EC2Client, CopyImageCommand } = require("@aws-sdk/client-ec2"); // CommonJS import + * const client = new EC2Client(config); + * const command = new CopyImageCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CopyImageCommandInput} for command's `input` shape. + * @see {@link CopyImageCommandOutput} for command's `response` shape. + * @see {@link EC2ClientResolvedConfig | config} for command's `input` shape. + * */ export class CopyImageCommand extends $Command { // Start section: command_properties diff --git a/clients/client-ec2/commands/CopySnapshotCommand.ts b/clients/client-ec2/commands/CopySnapshotCommand.ts index 388468b22393..3647c018d0bf 100644 --- a/clients/client-ec2/commands/CopySnapshotCommand.ts +++ b/clients/client-ec2/commands/CopySnapshotCommand.ts @@ -42,6 +42,20 @@ export interface CopySnapshotCommandOutput extends CopySnapshotResult, __Metadat * be used for any purpose.

*

For more information, see Copying an Amazon EBS snapshot in the * Amazon Elastic Compute Cloud User Guide.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { EC2Client, CopySnapshotCommand } from "@aws-sdk/client-ec2"; // ES Modules import + * // const { EC2Client, CopySnapshotCommand } = require("@aws-sdk/client-ec2"); // CommonJS import + * const client = new EC2Client(config); + * const command = new CopySnapshotCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CopySnapshotCommandInput} for command's `input` shape. + * @see {@link CopySnapshotCommandOutput} for command's `response` shape. + * @see {@link EC2ClientResolvedConfig | config} for command's `input` shape. + * */ export class CopySnapshotCommand extends $Command< CopySnapshotCommandInput, diff --git a/clients/client-ec2/commands/CreateCapacityReservationCommand.ts b/clients/client-ec2/commands/CreateCapacityReservationCommand.ts index 9d8620eac916..068a0f9b9193 100644 --- a/clients/client-ec2/commands/CreateCapacityReservationCommand.ts +++ b/clients/client-ec2/commands/CreateCapacityReservationCommand.ts @@ -38,6 +38,20 @@ export interface CreateCapacityReservationCommandOutput extends CreateCapacityRe * 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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { EC2Client, CreateCapacityReservationCommand } from "@aws-sdk/client-ec2"; // ES Modules import + * // const { EC2Client, CreateCapacityReservationCommand } = require("@aws-sdk/client-ec2"); // CommonJS import + * const client = new EC2Client(config); + * const command = new CreateCapacityReservationCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreateCapacityReservationCommandInput} for command's `input` shape. + * @see {@link CreateCapacityReservationCommandOutput} for command's `response` shape. + * @see {@link EC2ClientResolvedConfig | config} for command's `input` shape. + * */ export class CreateCapacityReservationCommand extends $Command< CreateCapacityReservationCommandInput, diff --git a/clients/client-ec2/commands/CreateCarrierGatewayCommand.ts b/clients/client-ec2/commands/CreateCarrierGatewayCommand.ts index 769e8a4940b6..fc760e6c87c1 100644 --- a/clients/client-ec2/commands/CreateCarrierGatewayCommand.ts +++ b/clients/client-ec2/commands/CreateCarrierGatewayCommand.ts @@ -23,6 +23,20 @@ export interface CreateCarrierGatewayCommandOutput extends CreateCarrierGatewayR /** *

Creates a carrier gateway. For more information about carrier gateways, see Carrier gateways in the AWS Wavelength Developer * Guide.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { EC2Client, CreateCarrierGatewayCommand } from "@aws-sdk/client-ec2"; // ES Modules import + * // const { EC2Client, CreateCarrierGatewayCommand } = require("@aws-sdk/client-ec2"); // CommonJS import + * const client = new EC2Client(config); + * const command = new CreateCarrierGatewayCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreateCarrierGatewayCommandInput} for command's `input` shape. + * @see {@link CreateCarrierGatewayCommandOutput} for command's `response` shape. + * @see {@link EC2ClientResolvedConfig | config} for command's `input` shape. + * */ export class CreateCarrierGatewayCommand extends $Command< CreateCarrierGatewayCommandInput, diff --git a/clients/client-ec2/commands/CreateClientVpnEndpointCommand.ts b/clients/client-ec2/commands/CreateClientVpnEndpointCommand.ts index 7aabef055b11..61f5a7ca5431 100644 --- a/clients/client-ec2/commands/CreateClientVpnEndpointCommand.ts +++ b/clients/client-ec2/commands/CreateClientVpnEndpointCommand.ts @@ -24,6 +24,20 @@ export interface CreateClientVpnEndpointCommandOutput extends CreateClientVpnEnd *

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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { EC2Client, CreateClientVpnEndpointCommand } from "@aws-sdk/client-ec2"; // ES Modules import + * // const { EC2Client, CreateClientVpnEndpointCommand } = require("@aws-sdk/client-ec2"); // CommonJS import + * const client = new EC2Client(config); + * const command = new CreateClientVpnEndpointCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreateClientVpnEndpointCommandInput} for command's `input` shape. + * @see {@link CreateClientVpnEndpointCommandOutput} for command's `response` shape. + * @see {@link EC2ClientResolvedConfig | config} for command's `input` shape. + * */ export class CreateClientVpnEndpointCommand extends $Command< CreateClientVpnEndpointCommandInput, diff --git a/clients/client-ec2/commands/CreateClientVpnRouteCommand.ts b/clients/client-ec2/commands/CreateClientVpnRouteCommand.ts index 9022777fe79f..9937f247d91d 100644 --- a/clients/client-ec2/commands/CreateClientVpnRouteCommand.ts +++ b/clients/client-ec2/commands/CreateClientVpnRouteCommand.ts @@ -23,6 +23,20 @@ export interface CreateClientVpnRouteCommandOutput extends CreateClientVpnRouteR /** *

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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { EC2Client, CreateClientVpnRouteCommand } from "@aws-sdk/client-ec2"; // ES Modules import + * // const { EC2Client, CreateClientVpnRouteCommand } = require("@aws-sdk/client-ec2"); // CommonJS import + * const client = new EC2Client(config); + * const command = new CreateClientVpnRouteCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreateClientVpnRouteCommandInput} for command's `input` shape. + * @see {@link CreateClientVpnRouteCommandOutput} for command's `response` shape. + * @see {@link EC2ClientResolvedConfig | config} for command's `input` shape. + * */ export class CreateClientVpnRouteCommand extends $Command< CreateClientVpnRouteCommandInput, diff --git a/clients/client-ec2/commands/CreateCustomerGatewayCommand.ts b/clients/client-ec2/commands/CreateCustomerGatewayCommand.ts index d0aafdccf23d..e4d482097838 100644 --- a/clients/client-ec2/commands/CreateCustomerGatewayCommand.ts +++ b/clients/client-ec2/commands/CreateCustomerGatewayCommand.ts @@ -57,6 +57,20 @@ export interface CreateCustomerGatewayCommandOutput extends CreateCustomerGatewa * return information about the existing customer gateway and do not create new * customer gateways.

* + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { EC2Client, CreateCustomerGatewayCommand } from "@aws-sdk/client-ec2"; // ES Modules import + * // const { EC2Client, CreateCustomerGatewayCommand } = require("@aws-sdk/client-ec2"); // CommonJS import + * const client = new EC2Client(config); + * const command = new CreateCustomerGatewayCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreateCustomerGatewayCommandInput} for command's `input` shape. + * @see {@link CreateCustomerGatewayCommandOutput} for command's `response` shape. + * @see {@link EC2ClientResolvedConfig | config} for command's `input` shape. + * */ export class CreateCustomerGatewayCommand extends $Command< CreateCustomerGatewayCommandInput, diff --git a/clients/client-ec2/commands/CreateDefaultSubnetCommand.ts b/clients/client-ec2/commands/CreateDefaultSubnetCommand.ts index f2f9fe04303a..806421946a86 100644 --- a/clients/client-ec2/commands/CreateDefaultSubnetCommand.ts +++ b/clients/client-ec2/commands/CreateDefaultSubnetCommand.ts @@ -25,6 +25,20 @@ export interface CreateDefaultSubnetCommandOutput extends CreateDefaultSubnetRes * 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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { EC2Client, CreateDefaultSubnetCommand } from "@aws-sdk/client-ec2"; // ES Modules import + * // const { EC2Client, CreateDefaultSubnetCommand } = require("@aws-sdk/client-ec2"); // CommonJS import + * const client = new EC2Client(config); + * const command = new CreateDefaultSubnetCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreateDefaultSubnetCommandInput} for command's `input` shape. + * @see {@link CreateDefaultSubnetCommandOutput} for command's `response` shape. + * @see {@link EC2ClientResolvedConfig | config} for command's `input` shape. + * */ export class CreateDefaultSubnetCommand extends $Command< CreateDefaultSubnetCommandInput, diff --git a/clients/client-ec2/commands/CreateDefaultVpcCommand.ts b/clients/client-ec2/commands/CreateDefaultVpcCommand.ts index d10d592f5da9..008eddd4b6ea 100644 --- a/clients/client-ec2/commands/CreateDefaultVpcCommand.ts +++ b/clients/client-ec2/commands/CreateDefaultVpcCommand.ts @@ -33,6 +33,20 @@ export interface CreateDefaultVpcCommandOutput extends CreateDefaultVpcResult, _ * supports EC2-Classic, see "I really want a default VPC for my existing EC2 account. Is * that possible?" in the Default VPCs * FAQ.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { EC2Client, CreateDefaultVpcCommand } from "@aws-sdk/client-ec2"; // ES Modules import + * // const { EC2Client, CreateDefaultVpcCommand } = require("@aws-sdk/client-ec2"); // CommonJS import + * const client = new EC2Client(config); + * const command = new CreateDefaultVpcCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreateDefaultVpcCommandInput} for command's `input` shape. + * @see {@link CreateDefaultVpcCommandOutput} for command's `response` shape. + * @see {@link EC2ClientResolvedConfig | config} for command's `input` shape. + * */ export class CreateDefaultVpcCommand extends $Command< CreateDefaultVpcCommandInput, diff --git a/clients/client-ec2/commands/CreateDhcpOptionsCommand.ts b/clients/client-ec2/commands/CreateDhcpOptionsCommand.ts index e2369ce5b9de..155529fd48e0 100644 --- a/clients/client-ec2/commands/CreateDhcpOptionsCommand.ts +++ b/clients/client-ec2/commands/CreateDhcpOptionsCommand.ts @@ -74,6 +74,20 @@ export interface CreateDhcpOptionsCommandOutput extends CreateDhcpOptionsResult, * 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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { EC2Client, CreateDhcpOptionsCommand } from "@aws-sdk/client-ec2"; // ES Modules import + * // const { EC2Client, CreateDhcpOptionsCommand } = require("@aws-sdk/client-ec2"); // CommonJS import + * const client = new EC2Client(config); + * const command = new CreateDhcpOptionsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreateDhcpOptionsCommandInput} for command's `input` shape. + * @see {@link CreateDhcpOptionsCommandOutput} for command's `response` shape. + * @see {@link EC2ClientResolvedConfig | config} for command's `input` shape. + * */ export class CreateDhcpOptionsCommand extends $Command< CreateDhcpOptionsCommandInput, diff --git a/clients/client-ec2/commands/CreateEgressOnlyInternetGatewayCommand.ts b/clients/client-ec2/commands/CreateEgressOnlyInternetGatewayCommand.ts index 9104e36f32ce..5d02c3cf0a49 100644 --- a/clients/client-ec2/commands/CreateEgressOnlyInternetGatewayCommand.ts +++ b/clients/client-ec2/commands/CreateEgressOnlyInternetGatewayCommand.ts @@ -27,6 +27,20 @@ export interface CreateEgressOnlyInternetGatewayCommandOutput * 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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { EC2Client, CreateEgressOnlyInternetGatewayCommand } from "@aws-sdk/client-ec2"; // ES Modules import + * // const { EC2Client, CreateEgressOnlyInternetGatewayCommand } = require("@aws-sdk/client-ec2"); // CommonJS import + * const client = new EC2Client(config); + * const command = new CreateEgressOnlyInternetGatewayCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreateEgressOnlyInternetGatewayCommandInput} for command's `input` shape. + * @see {@link CreateEgressOnlyInternetGatewayCommandOutput} for command's `response` shape. + * @see {@link EC2ClientResolvedConfig | config} for command's `input` shape. + * */ export class CreateEgressOnlyInternetGatewayCommand extends $Command< CreateEgressOnlyInternetGatewayCommandInput, diff --git a/clients/client-ec2/commands/CreateFleetCommand.ts b/clients/client-ec2/commands/CreateFleetCommand.ts index 266bf8786d3d..fe46404aabf4 100644 --- a/clients/client-ec2/commands/CreateFleetCommand.ts +++ b/clients/client-ec2/commands/CreateFleetCommand.ts @@ -22,6 +22,20 @@ export interface CreateFleetCommandOutput extends CreateFleetResult, __MetadataB *

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 Launching an EC2 Fleet in the Amazon EC2 User Guide.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { EC2Client, CreateFleetCommand } from "@aws-sdk/client-ec2"; // ES Modules import + * // const { EC2Client, CreateFleetCommand } = require("@aws-sdk/client-ec2"); // CommonJS import + * const client = new EC2Client(config); + * const command = new CreateFleetCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreateFleetCommandInput} for command's `input` shape. + * @see {@link CreateFleetCommandOutput} for command's `response` shape. + * @see {@link EC2ClientResolvedConfig | config} for command's `input` shape. + * */ export class CreateFleetCommand extends $Command< CreateFleetCommandInput, diff --git a/clients/client-ec2/commands/CreateFlowLogsCommand.ts b/clients/client-ec2/commands/CreateFlowLogsCommand.ts index 9019c6861f96..599ed954c555 100644 --- a/clients/client-ec2/commands/CreateFlowLogsCommand.ts +++ b/clients/client-ec2/commands/CreateFlowLogsCommand.ts @@ -32,6 +32,20 @@ export interface CreateFlowLogsCommandOutput extends CreateFlowLogsResult, __Met * bucket.

* *

For more information, see VPC Flow Logs in the Amazon Virtual Private Cloud User Guide.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { EC2Client, CreateFlowLogsCommand } from "@aws-sdk/client-ec2"; // ES Modules import + * // const { EC2Client, CreateFlowLogsCommand } = require("@aws-sdk/client-ec2"); // CommonJS import + * const client = new EC2Client(config); + * const command = new CreateFlowLogsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreateFlowLogsCommandInput} for command's `input` shape. + * @see {@link CreateFlowLogsCommandOutput} for command's `response` shape. + * @see {@link EC2ClientResolvedConfig | config} for command's `input` shape. + * */ export class CreateFlowLogsCommand extends $Command< CreateFlowLogsCommandInput, diff --git a/clients/client-ec2/commands/CreateFpgaImageCommand.ts b/clients/client-ec2/commands/CreateFpgaImageCommand.ts index be3605812136..a5dbc8abeabf 100644 --- a/clients/client-ec2/commands/CreateFpgaImageCommand.ts +++ b/clients/client-ec2/commands/CreateFpgaImageCommand.ts @@ -24,6 +24,20 @@ export interface CreateFpgaImageCommandOutput extends CreateFpgaImageResult, __M *

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 AWS FPGA Hardware Development Kit.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { EC2Client, CreateFpgaImageCommand } from "@aws-sdk/client-ec2"; // ES Modules import + * // const { EC2Client, CreateFpgaImageCommand } = require("@aws-sdk/client-ec2"); // CommonJS import + * const client = new EC2Client(config); + * const command = new CreateFpgaImageCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreateFpgaImageCommandInput} for command's `input` shape. + * @see {@link CreateFpgaImageCommandOutput} for command's `response` shape. + * @see {@link EC2ClientResolvedConfig | config} for command's `input` shape. + * */ export class CreateFpgaImageCommand extends $Command< CreateFpgaImageCommandInput, diff --git a/clients/client-ec2/commands/CreateImageCommand.ts b/clients/client-ec2/commands/CreateImageCommand.ts index 6fea7839b827..9c6cfd083f6e 100644 --- a/clients/client-ec2/commands/CreateImageCommand.ts +++ b/clients/client-ec2/commands/CreateImageCommand.ts @@ -29,6 +29,20 @@ export interface CreateImageCommandOutput extends CreateImageResult, __MetadataB * the instance automatically launches with those additional volumes.

*

For more information, see Creating Amazon EBS-Backed Linux AMIs * in the Amazon Elastic Compute Cloud User Guide.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { EC2Client, CreateImageCommand } from "@aws-sdk/client-ec2"; // ES Modules import + * // const { EC2Client, CreateImageCommand } = require("@aws-sdk/client-ec2"); // CommonJS import + * const client = new EC2Client(config); + * const command = new CreateImageCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreateImageCommandInput} for command's `input` shape. + * @see {@link CreateImageCommandOutput} for command's `response` shape. + * @see {@link EC2ClientResolvedConfig | config} for command's `input` shape. + * */ export class CreateImageCommand extends $Command< CreateImageCommandInput, diff --git a/clients/client-ec2/commands/CreateInstanceExportTaskCommand.ts b/clients/client-ec2/commands/CreateInstanceExportTaskCommand.ts index 6844034b2553..756a6e93017b 100644 --- a/clients/client-ec2/commands/CreateInstanceExportTaskCommand.ts +++ b/clients/client-ec2/commands/CreateInstanceExportTaskCommand.ts @@ -25,6 +25,20 @@ export interface CreateInstanceExportTaskCommandOutput extends CreateInstanceExp *

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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { EC2Client, CreateInstanceExportTaskCommand } from "@aws-sdk/client-ec2"; // ES Modules import + * // const { EC2Client, CreateInstanceExportTaskCommand } = require("@aws-sdk/client-ec2"); // CommonJS import + * const client = new EC2Client(config); + * const command = new CreateInstanceExportTaskCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreateInstanceExportTaskCommandInput} for command's `input` shape. + * @see {@link CreateInstanceExportTaskCommandOutput} for command's `response` shape. + * @see {@link EC2ClientResolvedConfig | config} for command's `input` shape. + * */ export class CreateInstanceExportTaskCommand extends $Command< CreateInstanceExportTaskCommandInput, diff --git a/clients/client-ec2/commands/CreateInternetGatewayCommand.ts b/clients/client-ec2/commands/CreateInternetGatewayCommand.ts index eb8275a8e737..d05456c579e9 100644 --- a/clients/client-ec2/commands/CreateInternetGatewayCommand.ts +++ b/clients/client-ec2/commands/CreateInternetGatewayCommand.ts @@ -24,6 +24,20 @@ export interface CreateInternetGatewayCommandOutput extends CreateInternetGatewa *

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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { EC2Client, CreateInternetGatewayCommand } from "@aws-sdk/client-ec2"; // ES Modules import + * // const { EC2Client, CreateInternetGatewayCommand } = require("@aws-sdk/client-ec2"); // CommonJS import + * const client = new EC2Client(config); + * const command = new CreateInternetGatewayCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreateInternetGatewayCommandInput} for command's `input` shape. + * @see {@link CreateInternetGatewayCommandOutput} for command's `response` shape. + * @see {@link EC2ClientResolvedConfig | config} for command's `input` shape. + * */ export class CreateInternetGatewayCommand extends $Command< CreateInternetGatewayCommandInput, diff --git a/clients/client-ec2/commands/CreateKeyPairCommand.ts b/clients/client-ec2/commands/CreateKeyPairCommand.ts index 84f524949ef8..2625885ca528 100644 --- a/clients/client-ec2/commands/CreateKeyPairCommand.ts +++ b/clients/client-ec2/commands/CreateKeyPairCommand.ts @@ -28,6 +28,20 @@ export interface CreateKeyPairCommandOutput extends KeyPair, __MetadataBearer {} * to any Region using ImportKeyPair.

*

For more information, see Key Pairs in the * Amazon Elastic Compute Cloud User Guide.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { EC2Client, CreateKeyPairCommand } from "@aws-sdk/client-ec2"; // ES Modules import + * // const { EC2Client, CreateKeyPairCommand } = require("@aws-sdk/client-ec2"); // CommonJS import + * const client = new EC2Client(config); + * const command = new CreateKeyPairCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreateKeyPairCommandInput} for command's `input` shape. + * @see {@link CreateKeyPairCommandOutput} for command's `response` shape. + * @see {@link EC2ClientResolvedConfig | config} for command's `input` shape. + * */ export class CreateKeyPairCommand extends $Command< CreateKeyPairCommandInput, diff --git a/clients/client-ec2/commands/CreateLaunchTemplateCommand.ts b/clients/client-ec2/commands/CreateLaunchTemplateCommand.ts index d34e42415e1a..c6abc63c20b9 100644 --- a/clients/client-ec2/commands/CreateLaunchTemplateCommand.ts +++ b/clients/client-ec2/commands/CreateLaunchTemplateCommand.ts @@ -26,6 +26,20 @@ export interface CreateLaunchTemplateCommandOutput extends CreateLaunchTemplateR * specify a launch template instead of providing the launch parameters in the request. For * more information, see Launching an instance from a * launch templatein the Amazon Elastic Compute Cloud User Guide.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { EC2Client, CreateLaunchTemplateCommand } from "@aws-sdk/client-ec2"; // ES Modules import + * // const { EC2Client, CreateLaunchTemplateCommand } = require("@aws-sdk/client-ec2"); // CommonJS import + * const client = new EC2Client(config); + * const command = new CreateLaunchTemplateCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreateLaunchTemplateCommandInput} for command's `input` shape. + * @see {@link CreateLaunchTemplateCommandOutput} for command's `response` shape. + * @see {@link EC2ClientResolvedConfig | config} for command's `input` shape. + * */ export class CreateLaunchTemplateCommand extends $Command< CreateLaunchTemplateCommandInput, diff --git a/clients/client-ec2/commands/CreateLaunchTemplateVersionCommand.ts b/clients/client-ec2/commands/CreateLaunchTemplateVersionCommand.ts index 24fea1a2f9b0..99b6c361886f 100644 --- a/clients/client-ec2/commands/CreateLaunchTemplateVersionCommand.ts +++ b/clients/client-ec2/commands/CreateLaunchTemplateVersionCommand.ts @@ -27,6 +27,20 @@ export interface CreateLaunchTemplateVersionCommandOutput extends CreateLaunchTe * cannot specify, change, or replace the numbering of launch template versions.

*

For * more information, see Managing launch template versionsin the Amazon Elastic Compute Cloud User Guide.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { EC2Client, CreateLaunchTemplateVersionCommand } from "@aws-sdk/client-ec2"; // ES Modules import + * // const { EC2Client, CreateLaunchTemplateVersionCommand } = require("@aws-sdk/client-ec2"); // CommonJS import + * const client = new EC2Client(config); + * const command = new CreateLaunchTemplateVersionCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreateLaunchTemplateVersionCommandInput} for command's `input` shape. + * @see {@link CreateLaunchTemplateVersionCommandOutput} for command's `response` shape. + * @see {@link EC2ClientResolvedConfig | config} for command's `input` shape. + * */ export class CreateLaunchTemplateVersionCommand extends $Command< CreateLaunchTemplateVersionCommandInput, diff --git a/clients/client-ec2/commands/CreateLocalGatewayRouteCommand.ts b/clients/client-ec2/commands/CreateLocalGatewayRouteCommand.ts index 548a66e6af55..999cbeede423 100644 --- a/clients/client-ec2/commands/CreateLocalGatewayRouteCommand.ts +++ b/clients/client-ec2/commands/CreateLocalGatewayRouteCommand.ts @@ -22,6 +22,20 @@ export interface CreateLocalGatewayRouteCommandOutput extends CreateLocalGateway /** *

Creates a static route for the specified local gateway route table.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { EC2Client, CreateLocalGatewayRouteCommand } from "@aws-sdk/client-ec2"; // ES Modules import + * // const { EC2Client, CreateLocalGatewayRouteCommand } = require("@aws-sdk/client-ec2"); // CommonJS import + * const client = new EC2Client(config); + * const command = new CreateLocalGatewayRouteCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreateLocalGatewayRouteCommandInput} for command's `input` shape. + * @see {@link CreateLocalGatewayRouteCommandOutput} for command's `response` shape. + * @see {@link EC2ClientResolvedConfig | config} for command's `input` shape. + * */ export class CreateLocalGatewayRouteCommand extends $Command< CreateLocalGatewayRouteCommandInput, diff --git a/clients/client-ec2/commands/CreateLocalGatewayRouteTableVpcAssociationCommand.ts b/clients/client-ec2/commands/CreateLocalGatewayRouteTableVpcAssociationCommand.ts index 8d9559e5480b..f61a7e853019 100644 --- a/clients/client-ec2/commands/CreateLocalGatewayRouteTableVpcAssociationCommand.ts +++ b/clients/client-ec2/commands/CreateLocalGatewayRouteTableVpcAssociationCommand.ts @@ -28,6 +28,20 @@ export interface CreateLocalGatewayRouteTableVpcAssociationCommandOutput /** *

Associates the specified VPC with the specified local gateway route table.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { EC2Client, CreateLocalGatewayRouteTableVpcAssociationCommand } from "@aws-sdk/client-ec2"; // ES Modules import + * // const { EC2Client, CreateLocalGatewayRouteTableVpcAssociationCommand } = require("@aws-sdk/client-ec2"); // CommonJS import + * const client = new EC2Client(config); + * const command = new CreateLocalGatewayRouteTableVpcAssociationCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreateLocalGatewayRouteTableVpcAssociationCommandInput} for command's `input` shape. + * @see {@link CreateLocalGatewayRouteTableVpcAssociationCommandOutput} for command's `response` shape. + * @see {@link EC2ClientResolvedConfig | config} for command's `input` shape. + * */ export class CreateLocalGatewayRouteTableVpcAssociationCommand extends $Command< CreateLocalGatewayRouteTableVpcAssociationCommandInput, diff --git a/clients/client-ec2/commands/CreateManagedPrefixListCommand.ts b/clients/client-ec2/commands/CreateManagedPrefixListCommand.ts index 7f087271afb7..de1f245df909 100644 --- a/clients/client-ec2/commands/CreateManagedPrefixListCommand.ts +++ b/clients/client-ec2/commands/CreateManagedPrefixListCommand.ts @@ -23,6 +23,20 @@ export interface CreateManagedPrefixListCommandOutput extends CreateManagedPrefi /** *

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.

*

You must specify the maximum number of entries for the prefix list. The maximum number of entries cannot be changed later.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { EC2Client, CreateManagedPrefixListCommand } from "@aws-sdk/client-ec2"; // ES Modules import + * // const { EC2Client, CreateManagedPrefixListCommand } = require("@aws-sdk/client-ec2"); // CommonJS import + * const client = new EC2Client(config); + * const command = new CreateManagedPrefixListCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreateManagedPrefixListCommandInput} for command's `input` shape. + * @see {@link CreateManagedPrefixListCommandOutput} for command's `response` shape. + * @see {@link EC2ClientResolvedConfig | config} for command's `input` shape. + * */ export class CreateManagedPrefixListCommand extends $Command< CreateManagedPrefixListCommandInput, diff --git a/clients/client-ec2/commands/CreateNatGatewayCommand.ts b/clients/client-ec2/commands/CreateNatGatewayCommand.ts index d485b4598f3b..a17c90d4d7ed 100644 --- a/clients/client-ec2/commands/CreateNatGatewayCommand.ts +++ b/clients/client-ec2/commands/CreateNatGatewayCommand.ts @@ -27,6 +27,20 @@ export interface CreateNatGatewayCommandOutput extends CreateNatGatewayResult, _ * gateway, therefore enabling instances in the private subnet to connect to the internet. * For more information, see NAT Gateways in the * Amazon Virtual Private Cloud User Guide.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { EC2Client, CreateNatGatewayCommand } from "@aws-sdk/client-ec2"; // ES Modules import + * // const { EC2Client, CreateNatGatewayCommand } = require("@aws-sdk/client-ec2"); // CommonJS import + * const client = new EC2Client(config); + * const command = new CreateNatGatewayCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreateNatGatewayCommandInput} for command's `input` shape. + * @see {@link CreateNatGatewayCommandOutput} for command's `response` shape. + * @see {@link EC2ClientResolvedConfig | config} for command's `input` shape. + * */ export class CreateNatGatewayCommand extends $Command< CreateNatGatewayCommandInput, diff --git a/clients/client-ec2/commands/CreateNetworkAclCommand.ts b/clients/client-ec2/commands/CreateNetworkAclCommand.ts index a98f39858a8d..536bea10ee8c 100644 --- a/clients/client-ec2/commands/CreateNetworkAclCommand.ts +++ b/clients/client-ec2/commands/CreateNetworkAclCommand.ts @@ -24,6 +24,20 @@ export interface CreateNetworkAclCommandOutput extends CreateNetworkAclResult, _ *

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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { EC2Client, CreateNetworkAclCommand } from "@aws-sdk/client-ec2"; // ES Modules import + * // const { EC2Client, CreateNetworkAclCommand } = require("@aws-sdk/client-ec2"); // CommonJS import + * const client = new EC2Client(config); + * const command = new CreateNetworkAclCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreateNetworkAclCommandInput} for command's `input` shape. + * @see {@link CreateNetworkAclCommandOutput} for command's `response` shape. + * @see {@link EC2ClientResolvedConfig | config} for command's `input` shape. + * */ export class CreateNetworkAclCommand extends $Command< CreateNetworkAclCommandInput, diff --git a/clients/client-ec2/commands/CreateNetworkAclEntryCommand.ts b/clients/client-ec2/commands/CreateNetworkAclEntryCommand.ts index 982083118071..15f5e55481ea 100644 --- a/clients/client-ec2/commands/CreateNetworkAclEntryCommand.ts +++ b/clients/client-ec2/commands/CreateNetworkAclEntryCommand.ts @@ -29,6 +29,20 @@ export interface CreateNetworkAclEntryCommandOutput extends __MetadataBearer {} * 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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { EC2Client, CreateNetworkAclEntryCommand } from "@aws-sdk/client-ec2"; // ES Modules import + * // const { EC2Client, CreateNetworkAclEntryCommand } = require("@aws-sdk/client-ec2"); // CommonJS import + * const client = new EC2Client(config); + * const command = new CreateNetworkAclEntryCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreateNetworkAclEntryCommandInput} for command's `input` shape. + * @see {@link CreateNetworkAclEntryCommandOutput} for command's `response` shape. + * @see {@link EC2ClientResolvedConfig | config} for command's `input` shape. + * */ export class CreateNetworkAclEntryCommand extends $Command< CreateNetworkAclEntryCommandInput, diff --git a/clients/client-ec2/commands/CreateNetworkInsightsPathCommand.ts b/clients/client-ec2/commands/CreateNetworkInsightsPathCommand.ts index fb7d1aea2ca0..da4a569d8f4e 100644 --- a/clients/client-ec2/commands/CreateNetworkInsightsPathCommand.ts +++ b/clients/client-ec2/commands/CreateNetworkInsightsPathCommand.ts @@ -25,6 +25,20 @@ export interface CreateNetworkInsightsPathCommandOutput extends CreateNetworkIns *

Reachability Analyzer enables you to analyze and debug network reachability between * two resources in your virtual private cloud (VPC). For more information, see * What is Reachability Analyzer.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { EC2Client, CreateNetworkInsightsPathCommand } from "@aws-sdk/client-ec2"; // ES Modules import + * // const { EC2Client, CreateNetworkInsightsPathCommand } = require("@aws-sdk/client-ec2"); // CommonJS import + * const client = new EC2Client(config); + * const command = new CreateNetworkInsightsPathCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreateNetworkInsightsPathCommandInput} for command's `input` shape. + * @see {@link CreateNetworkInsightsPathCommandOutput} for command's `response` shape. + * @see {@link EC2ClientResolvedConfig | config} for command's `input` shape. + * */ export class CreateNetworkInsightsPathCommand extends $Command< CreateNetworkInsightsPathCommandInput, diff --git a/clients/client-ec2/commands/CreateNetworkInterfaceCommand.ts b/clients/client-ec2/commands/CreateNetworkInterfaceCommand.ts index 919f8775510d..159e3c91e74f 100644 --- a/clients/client-ec2/commands/CreateNetworkInterfaceCommand.ts +++ b/clients/client-ec2/commands/CreateNetworkInterfaceCommand.ts @@ -24,6 +24,20 @@ export interface CreateNetworkInterfaceCommandOutput extends CreateNetworkInterf *

Creates a network interface in the specified subnet.

*

For more information about network interfaces, see Elastic Network Interfaces * in the Amazon Virtual Private Cloud User Guide.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { EC2Client, CreateNetworkInterfaceCommand } from "@aws-sdk/client-ec2"; // ES Modules import + * // const { EC2Client, CreateNetworkInterfaceCommand } = require("@aws-sdk/client-ec2"); // CommonJS import + * const client = new EC2Client(config); + * const command = new CreateNetworkInterfaceCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreateNetworkInterfaceCommandInput} for command's `input` shape. + * @see {@link CreateNetworkInterfaceCommandOutput} for command's `response` shape. + * @see {@link EC2ClientResolvedConfig | config} for command's `input` shape. + * */ export class CreateNetworkInterfaceCommand extends $Command< CreateNetworkInterfaceCommandInput, diff --git a/clients/client-ec2/commands/CreateNetworkInterfacePermissionCommand.ts b/clients/client-ec2/commands/CreateNetworkInterfacePermissionCommand.ts index 7b4f20f6fe62..08a8a8680b4b 100644 --- a/clients/client-ec2/commands/CreateNetworkInterfacePermissionCommand.ts +++ b/clients/client-ec2/commands/CreateNetworkInterfacePermissionCommand.ts @@ -26,6 +26,20 @@ export interface CreateNetworkInterfacePermissionCommandOutput *

Grants an AWS-authorized account permission to attach the specified network interface to * an instance in their account.

*

You can grant permission to a single AWS account only, and only one account at a time.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { EC2Client, CreateNetworkInterfacePermissionCommand } from "@aws-sdk/client-ec2"; // ES Modules import + * // const { EC2Client, CreateNetworkInterfacePermissionCommand } = require("@aws-sdk/client-ec2"); // CommonJS import + * const client = new EC2Client(config); + * const command = new CreateNetworkInterfacePermissionCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreateNetworkInterfacePermissionCommandInput} for command's `input` shape. + * @see {@link CreateNetworkInterfacePermissionCommandOutput} for command's `response` shape. + * @see {@link EC2ClientResolvedConfig | config} for command's `input` shape. + * */ export class CreateNetworkInterfacePermissionCommand extends $Command< CreateNetworkInterfacePermissionCommandInput, diff --git a/clients/client-ec2/commands/CreatePlacementGroupCommand.ts b/clients/client-ec2/commands/CreatePlacementGroupCommand.ts index e5d2985635b2..e3947cc81a60 100644 --- a/clients/client-ec2/commands/CreatePlacementGroupCommand.ts +++ b/clients/client-ec2/commands/CreatePlacementGroupCommand.ts @@ -31,6 +31,20 @@ export interface CreatePlacementGroupCommandOutput extends CreatePlacementGroupR * instances in another partition.

*

For more information, see Placement groups in the * Amazon EC2 User Guide.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { EC2Client, CreatePlacementGroupCommand } from "@aws-sdk/client-ec2"; // ES Modules import + * // const { EC2Client, CreatePlacementGroupCommand } = require("@aws-sdk/client-ec2"); // CommonJS import + * const client = new EC2Client(config); + * const command = new CreatePlacementGroupCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreatePlacementGroupCommandInput} for command's `input` shape. + * @see {@link CreatePlacementGroupCommandOutput} for command's `response` shape. + * @see {@link EC2ClientResolvedConfig | config} for command's `input` shape. + * */ export class CreatePlacementGroupCommand extends $Command< CreatePlacementGroupCommandInput, diff --git a/clients/client-ec2/commands/CreateReplaceRootVolumeTaskCommand.ts b/clients/client-ec2/commands/CreateReplaceRootVolumeTaskCommand.ts index 936be9cd817e..357047a91573 100644 --- a/clients/client-ec2/commands/CreateReplaceRootVolumeTaskCommand.ts +++ b/clients/client-ec2/commands/CreateReplaceRootVolumeTaskCommand.ts @@ -27,6 +27,20 @@ export interface CreateReplaceRootVolumeTaskCommandOutput extends CreateReplaceR * *

For more information, see Replace a root volume * in the Amazon Elastic Compute Cloud User Guide.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { EC2Client, CreateReplaceRootVolumeTaskCommand } from "@aws-sdk/client-ec2"; // ES Modules import + * // const { EC2Client, CreateReplaceRootVolumeTaskCommand } = require("@aws-sdk/client-ec2"); // CommonJS import + * const client = new EC2Client(config); + * const command = new CreateReplaceRootVolumeTaskCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreateReplaceRootVolumeTaskCommandInput} for command's `input` shape. + * @see {@link CreateReplaceRootVolumeTaskCommandOutput} for command's `response` shape. + * @see {@link EC2ClientResolvedConfig | config} for command's `input` shape. + * */ export class CreateReplaceRootVolumeTaskCommand extends $Command< CreateReplaceRootVolumeTaskCommandInput, diff --git a/clients/client-ec2/commands/CreateReservedInstancesListingCommand.ts b/clients/client-ec2/commands/CreateReservedInstancesListingCommand.ts index 77c332acd267..b0eef2ca5644 100644 --- a/clients/client-ec2/commands/CreateReservedInstancesListingCommand.ts +++ b/clients/client-ec2/commands/CreateReservedInstancesListingCommand.ts @@ -39,6 +39,20 @@ export interface CreateReservedInstancesListingCommandOutput * DescribeReservedInstancesListings operation.

*

For more information, see Reserved Instance Marketplace in the * Amazon EC2 User Guide.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { EC2Client, CreateReservedInstancesListingCommand } from "@aws-sdk/client-ec2"; // ES Modules import + * // const { EC2Client, CreateReservedInstancesListingCommand } = require("@aws-sdk/client-ec2"); // CommonJS import + * const client = new EC2Client(config); + * const command = new CreateReservedInstancesListingCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreateReservedInstancesListingCommandInput} for command's `input` shape. + * @see {@link CreateReservedInstancesListingCommandOutput} for command's `response` shape. + * @see {@link EC2ClientResolvedConfig | config} for command's `input` shape. + * */ export class CreateReservedInstancesListingCommand extends $Command< CreateReservedInstancesListingCommandInput, diff --git a/clients/client-ec2/commands/CreateRestoreImageTaskCommand.ts b/clients/client-ec2/commands/CreateRestoreImageTaskCommand.ts index bde764caca67..6e59b5e7816d 100644 --- a/clients/client-ec2/commands/CreateRestoreImageTaskCommand.ts +++ b/clients/client-ec2/commands/CreateRestoreImageTaskCommand.ts @@ -27,6 +27,20 @@ export interface CreateRestoreImageTaskCommandOutput extends CreateRestoreImageT * Amazon Elastic Compute Cloud User Guide.

*

For more information, see Store and restore an AMI using * S3 in the Amazon Elastic Compute Cloud User Guide.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { EC2Client, CreateRestoreImageTaskCommand } from "@aws-sdk/client-ec2"; // ES Modules import + * // const { EC2Client, CreateRestoreImageTaskCommand } = require("@aws-sdk/client-ec2"); // CommonJS import + * const client = new EC2Client(config); + * const command = new CreateRestoreImageTaskCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreateRestoreImageTaskCommandInput} for command's `input` shape. + * @see {@link CreateRestoreImageTaskCommandOutput} for command's `response` shape. + * @see {@link EC2ClientResolvedConfig | config} for command's `input` shape. + * */ export class CreateRestoreImageTaskCommand extends $Command< CreateRestoreImageTaskCommandInput, diff --git a/clients/client-ec2/commands/CreateRouteCommand.ts b/clients/client-ec2/commands/CreateRouteCommand.ts index 8a7ce44daba3..57a2dad6b5f2 100644 --- a/clients/client-ec2/commands/CreateRouteCommand.ts +++ b/clients/client-ec2/commands/CreateRouteCommand.ts @@ -39,6 +39,20 @@ export interface CreateRouteCommandOutput extends CreateRouteResult, __MetadataB * 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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { EC2Client, CreateRouteCommand } from "@aws-sdk/client-ec2"; // ES Modules import + * // const { EC2Client, CreateRouteCommand } = require("@aws-sdk/client-ec2"); // CommonJS import + * const client = new EC2Client(config); + * const command = new CreateRouteCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreateRouteCommandInput} for command's `input` shape. + * @see {@link CreateRouteCommandOutput} for command's `response` shape. + * @see {@link EC2ClientResolvedConfig | config} for command's `input` shape. + * */ export class CreateRouteCommand extends $Command< CreateRouteCommandInput, diff --git a/clients/client-ec2/commands/CreateRouteTableCommand.ts b/clients/client-ec2/commands/CreateRouteTableCommand.ts index 8060f7d638d5..96d4a1fe2b2f 100644 --- a/clients/client-ec2/commands/CreateRouteTableCommand.ts +++ b/clients/client-ec2/commands/CreateRouteTableCommand.ts @@ -24,6 +24,20 @@ export interface CreateRouteTableCommandOutput extends CreateRouteTableResult, _ *

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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { EC2Client, CreateRouteTableCommand } from "@aws-sdk/client-ec2"; // ES Modules import + * // const { EC2Client, CreateRouteTableCommand } = require("@aws-sdk/client-ec2"); // CommonJS import + * const client = new EC2Client(config); + * const command = new CreateRouteTableCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreateRouteTableCommandInput} for command's `input` shape. + * @see {@link CreateRouteTableCommandOutput} for command's `response` shape. + * @see {@link EC2ClientResolvedConfig | config} for command's `input` shape. + * */ export class CreateRouteTableCommand extends $Command< CreateRouteTableCommandInput, diff --git a/clients/client-ec2/commands/CreateSecurityGroupCommand.ts b/clients/client-ec2/commands/CreateSecurityGroupCommand.ts index 47a6eb9fc5c8..b0b4d98474d7 100644 --- a/clients/client-ec2/commands/CreateSecurityGroupCommand.ts +++ b/clients/client-ec2/commands/CreateSecurityGroupCommand.ts @@ -36,6 +36,20 @@ export interface CreateSecurityGroupCommandOutput extends CreateSecurityGroupRes * RevokeSecurityGroupIngress, and * RevokeSecurityGroupEgress.

*

For more information about VPC security group limits, see Amazon VPC Limits.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { EC2Client, CreateSecurityGroupCommand } from "@aws-sdk/client-ec2"; // ES Modules import + * // const { EC2Client, CreateSecurityGroupCommand } = require("@aws-sdk/client-ec2"); // CommonJS import + * const client = new EC2Client(config); + * const command = new CreateSecurityGroupCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreateSecurityGroupCommandInput} for command's `input` shape. + * @see {@link CreateSecurityGroupCommandOutput} for command's `response` shape. + * @see {@link EC2ClientResolvedConfig | config} for command's `input` shape. + * */ export class CreateSecurityGroupCommand extends $Command< CreateSecurityGroupCommandInput, diff --git a/clients/client-ec2/commands/CreateSnapshotCommand.ts b/clients/client-ec2/commands/CreateSnapshotCommand.ts index f48f6baff28c..f58fe6750894 100644 --- a/clients/client-ec2/commands/CreateSnapshotCommand.ts +++ b/clients/client-ec2/commands/CreateSnapshotCommand.ts @@ -46,6 +46,20 @@ export interface CreateSnapshotCommandOutput extends Snapshot, __MetadataBearer *

You can tag your snapshots during creation. For more information, see Tagging 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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { EC2Client, CreateSnapshotCommand } from "@aws-sdk/client-ec2"; // ES Modules import + * // const { EC2Client, CreateSnapshotCommand } = require("@aws-sdk/client-ec2"); // CommonJS import + * const client = new EC2Client(config); + * const command = new CreateSnapshotCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreateSnapshotCommandInput} for command's `input` shape. + * @see {@link CreateSnapshotCommandOutput} for command's `response` shape. + * @see {@link EC2ClientResolvedConfig | config} for command's `input` shape. + * */ export class CreateSnapshotCommand extends $Command< CreateSnapshotCommandInput, diff --git a/clients/client-ec2/commands/CreateSnapshotsCommand.ts b/clients/client-ec2/commands/CreateSnapshotsCommand.ts index f4c567815bc2..d2de729acfb9 100644 --- a/clients/client-ec2/commands/CreateSnapshotsCommand.ts +++ b/clients/client-ec2/commands/CreateSnapshotsCommand.ts @@ -28,6 +28,20 @@ export interface CreateSnapshotsCommandOutput extends CreateSnapshotsResult, __M * 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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { EC2Client, CreateSnapshotsCommand } from "@aws-sdk/client-ec2"; // ES Modules import + * // const { EC2Client, CreateSnapshotsCommand } = require("@aws-sdk/client-ec2"); // CommonJS import + * const client = new EC2Client(config); + * const command = new CreateSnapshotsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreateSnapshotsCommandInput} for command's `input` shape. + * @see {@link CreateSnapshotsCommandOutput} for command's `response` shape. + * @see {@link EC2ClientResolvedConfig | config} for command's `input` shape. + * */ export class CreateSnapshotsCommand extends $Command< CreateSnapshotsCommandInput, diff --git a/clients/client-ec2/commands/CreateSpotDatafeedSubscriptionCommand.ts b/clients/client-ec2/commands/CreateSpotDatafeedSubscriptionCommand.ts index ba0a61f5bdad..0ff7714ab399 100644 --- a/clients/client-ec2/commands/CreateSpotDatafeedSubscriptionCommand.ts +++ b/clients/client-ec2/commands/CreateSpotDatafeedSubscriptionCommand.ts @@ -27,6 +27,20 @@ export interface CreateSpotDatafeedSubscriptionCommandOutput * You can create one data feed per AWS account. For more information, see * Spot Instance data feed * in the Amazon EC2 User Guide for Linux Instances.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { EC2Client, CreateSpotDatafeedSubscriptionCommand } from "@aws-sdk/client-ec2"; // ES Modules import + * // const { EC2Client, CreateSpotDatafeedSubscriptionCommand } = require("@aws-sdk/client-ec2"); // CommonJS import + * const client = new EC2Client(config); + * const command = new CreateSpotDatafeedSubscriptionCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreateSpotDatafeedSubscriptionCommandInput} for command's `input` shape. + * @see {@link CreateSpotDatafeedSubscriptionCommandOutput} for command's `response` shape. + * @see {@link EC2ClientResolvedConfig | config} for command's `input` shape. + * */ export class CreateSpotDatafeedSubscriptionCommand extends $Command< CreateSpotDatafeedSubscriptionCommandInput, diff --git a/clients/client-ec2/commands/CreateStoreImageTaskCommand.ts b/clients/client-ec2/commands/CreateStoreImageTaskCommand.ts index 91c2c77af2f5..5c458664f6a9 100644 --- a/clients/client-ec2/commands/CreateStoreImageTaskCommand.ts +++ b/clients/client-ec2/commands/CreateStoreImageTaskCommand.ts @@ -26,6 +26,20 @@ export interface CreateStoreImageTaskCommandOutput extends CreateStoreImageTaskR * Amazon Elastic Compute Cloud User Guide.

*

For more information, see Store and restore an AMI using * S3 in the Amazon Elastic Compute Cloud User Guide.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { EC2Client, CreateStoreImageTaskCommand } from "@aws-sdk/client-ec2"; // ES Modules import + * // const { EC2Client, CreateStoreImageTaskCommand } = require("@aws-sdk/client-ec2"); // CommonJS import + * const client = new EC2Client(config); + * const command = new CreateStoreImageTaskCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreateStoreImageTaskCommandInput} for command's `input` shape. + * @see {@link CreateStoreImageTaskCommandOutput} for command's `response` shape. + * @see {@link EC2ClientResolvedConfig | config} for command's `input` shape. + * */ export class CreateStoreImageTaskCommand extends $Command< CreateStoreImageTaskCommandInput, diff --git a/clients/client-ec2/commands/CreateSubnetCommand.ts b/clients/client-ec2/commands/CreateSubnetCommand.ts index fe4d70090801..2a63523c0d65 100644 --- a/clients/client-ec2/commands/CreateSubnetCommand.ts +++ b/clients/client-ec2/commands/CreateSubnetCommand.ts @@ -36,6 +36,20 @@ export interface CreateSubnetCommandOutput extends CreateSubnetResult, __Metadat * no remaining IP addresses available.

*

For more information about subnets, see Your VPC and Subnets in the * Amazon Virtual Private Cloud User Guide.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { EC2Client, CreateSubnetCommand } from "@aws-sdk/client-ec2"; // ES Modules import + * // const { EC2Client, CreateSubnetCommand } = require("@aws-sdk/client-ec2"); // CommonJS import + * const client = new EC2Client(config); + * const command = new CreateSubnetCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreateSubnetCommandInput} for command's `input` shape. + * @see {@link CreateSubnetCommandOutput} for command's `response` shape. + * @see {@link EC2ClientResolvedConfig | config} for command's `input` shape. + * */ export class CreateSubnetCommand extends $Command< CreateSubnetCommandInput, diff --git a/clients/client-ec2/commands/CreateTagsCommand.ts b/clients/client-ec2/commands/CreateTagsCommand.ts index 9493d0851e78..7f26f1d02a6b 100644 --- a/clients/client-ec2/commands/CreateTagsCommand.ts +++ b/clients/client-ec2/commands/CreateTagsCommand.ts @@ -28,6 +28,20 @@ export interface CreateTagsCommandOutput extends __MetadataBearer {} * 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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { EC2Client, CreateTagsCommand } from "@aws-sdk/client-ec2"; // ES Modules import + * // const { EC2Client, CreateTagsCommand } = require("@aws-sdk/client-ec2"); // CommonJS import + * const client = new EC2Client(config); + * const command = new CreateTagsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreateTagsCommandInput} for command's `input` shape. + * @see {@link CreateTagsCommandOutput} for command's `response` shape. + * @see {@link EC2ClientResolvedConfig | config} for command's `input` shape. + * */ export class CreateTagsCommand extends $Command< CreateTagsCommandInput, diff --git a/clients/client-ec2/commands/CreateTrafficMirrorFilterCommand.ts b/clients/client-ec2/commands/CreateTrafficMirrorFilterCommand.ts index fad0be4f42cf..d9cff5a389de 100644 --- a/clients/client-ec2/commands/CreateTrafficMirrorFilterCommand.ts +++ b/clients/client-ec2/commands/CreateTrafficMirrorFilterCommand.ts @@ -25,6 +25,20 @@ export interface CreateTrafficMirrorFilterCommandOutput extends CreateTrafficMir *

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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { EC2Client, CreateTrafficMirrorFilterCommand } from "@aws-sdk/client-ec2"; // ES Modules import + * // const { EC2Client, CreateTrafficMirrorFilterCommand } = require("@aws-sdk/client-ec2"); // CommonJS import + * const client = new EC2Client(config); + * const command = new CreateTrafficMirrorFilterCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreateTrafficMirrorFilterCommandInput} for command's `input` shape. + * @see {@link CreateTrafficMirrorFilterCommandOutput} for command's `response` shape. + * @see {@link EC2ClientResolvedConfig | config} for command's `input` shape. + * */ export class CreateTrafficMirrorFilterCommand extends $Command< CreateTrafficMirrorFilterCommandInput, diff --git a/clients/client-ec2/commands/CreateTrafficMirrorFilterRuleCommand.ts b/clients/client-ec2/commands/CreateTrafficMirrorFilterRuleCommand.ts index 02271092dc70..b229c725aae3 100644 --- a/clients/client-ec2/commands/CreateTrafficMirrorFilterRuleCommand.ts +++ b/clients/client-ec2/commands/CreateTrafficMirrorFilterRuleCommand.ts @@ -26,6 +26,20 @@ export interface CreateTrafficMirrorFilterRuleCommandOutput *

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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { EC2Client, CreateTrafficMirrorFilterRuleCommand } from "@aws-sdk/client-ec2"; // ES Modules import + * // const { EC2Client, CreateTrafficMirrorFilterRuleCommand } = require("@aws-sdk/client-ec2"); // CommonJS import + * const client = new EC2Client(config); + * const command = new CreateTrafficMirrorFilterRuleCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreateTrafficMirrorFilterRuleCommandInput} for command's `input` shape. + * @see {@link CreateTrafficMirrorFilterRuleCommandOutput} for command's `response` shape. + * @see {@link EC2ClientResolvedConfig | config} for command's `input` shape. + * */ export class CreateTrafficMirrorFilterRuleCommand extends $Command< CreateTrafficMirrorFilterRuleCommandInput, diff --git a/clients/client-ec2/commands/CreateTrafficMirrorSessionCommand.ts b/clients/client-ec2/commands/CreateTrafficMirrorSessionCommand.ts index 788bf50834e8..ae3aa99176b4 100644 --- a/clients/client-ec2/commands/CreateTrafficMirrorSessionCommand.ts +++ b/clients/client-ec2/commands/CreateTrafficMirrorSessionCommand.ts @@ -28,6 +28,20 @@ export interface CreateTrafficMirrorSessionCommandOutput extends CreateTrafficMi *

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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { EC2Client, CreateTrafficMirrorSessionCommand } from "@aws-sdk/client-ec2"; // ES Modules import + * // const { EC2Client, CreateTrafficMirrorSessionCommand } = require("@aws-sdk/client-ec2"); // CommonJS import + * const client = new EC2Client(config); + * const command = new CreateTrafficMirrorSessionCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreateTrafficMirrorSessionCommandInput} for command's `input` shape. + * @see {@link CreateTrafficMirrorSessionCommandOutput} for command's `response` shape. + * @see {@link EC2ClientResolvedConfig | config} for command's `input` shape. + * */ export class CreateTrafficMirrorSessionCommand extends $Command< CreateTrafficMirrorSessionCommandInput, diff --git a/clients/client-ec2/commands/CreateTrafficMirrorTargetCommand.ts b/clients/client-ec2/commands/CreateTrafficMirrorTargetCommand.ts index dd6ea120e1d7..1d37b9cfcd91 100644 --- a/clients/client-ec2/commands/CreateTrafficMirrorTargetCommand.ts +++ b/clients/client-ec2/commands/CreateTrafficMirrorTargetCommand.ts @@ -27,6 +27,20 @@ export interface CreateTrafficMirrorTargetCommandOutput extends CreateTrafficMir * different VPCs connected via VPC peering or a transit gateway.

*

A Traffic Mirror target can be a network interface, or a Network Load Balancer.

*

To use the target in a Traffic Mirror session, use CreateTrafficMirrorSession.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { EC2Client, CreateTrafficMirrorTargetCommand } from "@aws-sdk/client-ec2"; // ES Modules import + * // const { EC2Client, CreateTrafficMirrorTargetCommand } = require("@aws-sdk/client-ec2"); // CommonJS import + * const client = new EC2Client(config); + * const command = new CreateTrafficMirrorTargetCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreateTrafficMirrorTargetCommandInput} for command's `input` shape. + * @see {@link CreateTrafficMirrorTargetCommandOutput} for command's `response` shape. + * @see {@link EC2ClientResolvedConfig | config} for command's `input` shape. + * */ export class CreateTrafficMirrorTargetCommand extends $Command< CreateTrafficMirrorTargetCommandInput, diff --git a/clients/client-ec2/commands/CreateTransitGatewayCommand.ts b/clients/client-ec2/commands/CreateTransitGatewayCommand.ts index 14b03df9c655..9990b9e74449 100644 --- a/clients/client-ec2/commands/CreateTransitGatewayCommand.ts +++ b/clients/client-ec2/commands/CreateTransitGatewayCommand.ts @@ -34,6 +34,20 @@ export interface CreateTransitGatewayCommandOutput extends CreateTransitGatewayR * 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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { EC2Client, CreateTransitGatewayCommand } from "@aws-sdk/client-ec2"; // ES Modules import + * // const { EC2Client, CreateTransitGatewayCommand } = require("@aws-sdk/client-ec2"); // CommonJS import + * const client = new EC2Client(config); + * const command = new CreateTransitGatewayCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreateTransitGatewayCommandInput} for command's `input` shape. + * @see {@link CreateTransitGatewayCommandOutput} for command's `response` shape. + * @see {@link EC2ClientResolvedConfig | config} for command's `input` shape. + * */ export class CreateTransitGatewayCommand extends $Command< CreateTransitGatewayCommandInput, diff --git a/clients/client-ec2/commands/CreateTransitGatewayConnectCommand.ts b/clients/client-ec2/commands/CreateTransitGatewayConnectCommand.ts index 20caff647d70..ba5c5a2427be 100644 --- a/clients/client-ec2/commands/CreateTransitGatewayConnectCommand.ts +++ b/clients/client-ec2/commands/CreateTransitGatewayConnectCommand.ts @@ -23,6 +23,20 @@ export interface CreateTransitGatewayConnectCommandOutput extends CreateTransitG /** *

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 AWS Direct Connect attachment as the underlying transport mechanism.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { EC2Client, CreateTransitGatewayConnectCommand } from "@aws-sdk/client-ec2"; // ES Modules import + * // const { EC2Client, CreateTransitGatewayConnectCommand } = require("@aws-sdk/client-ec2"); // CommonJS import + * const client = new EC2Client(config); + * const command = new CreateTransitGatewayConnectCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreateTransitGatewayConnectCommandInput} for command's `input` shape. + * @see {@link CreateTransitGatewayConnectCommandOutput} for command's `response` shape. + * @see {@link EC2ClientResolvedConfig | config} for command's `input` shape. + * */ export class CreateTransitGatewayConnectCommand extends $Command< CreateTransitGatewayConnectCommandInput, diff --git a/clients/client-ec2/commands/CreateTransitGatewayConnectPeerCommand.ts b/clients/client-ec2/commands/CreateTransitGatewayConnectPeerCommand.ts index 2990fcfc66b2..3de1ecf83f48 100644 --- a/clients/client-ec2/commands/CreateTransitGatewayConnectPeerCommand.ts +++ b/clients/client-ec2/commands/CreateTransitGatewayConnectPeerCommand.ts @@ -27,6 +27,20 @@ export interface CreateTransitGatewayConnectPeerCommandOutput * 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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { EC2Client, CreateTransitGatewayConnectPeerCommand } from "@aws-sdk/client-ec2"; // ES Modules import + * // const { EC2Client, CreateTransitGatewayConnectPeerCommand } = require("@aws-sdk/client-ec2"); // CommonJS import + * const client = new EC2Client(config); + * const command = new CreateTransitGatewayConnectPeerCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreateTransitGatewayConnectPeerCommandInput} for command's `input` shape. + * @see {@link CreateTransitGatewayConnectPeerCommandOutput} for command's `response` shape. + * @see {@link EC2ClientResolvedConfig | config} for command's `input` shape. + * */ export class CreateTransitGatewayConnectPeerCommand extends $Command< CreateTransitGatewayConnectPeerCommandInput, diff --git a/clients/client-ec2/commands/CreateTransitGatewayMulticastDomainCommand.ts b/clients/client-ec2/commands/CreateTransitGatewayMulticastDomainCommand.ts index c0732fb154e1..4cc7f8c87ab1 100644 --- a/clients/client-ec2/commands/CreateTransitGatewayMulticastDomainCommand.ts +++ b/clients/client-ec2/commands/CreateTransitGatewayMulticastDomainCommand.ts @@ -28,6 +28,20 @@ export interface CreateTransitGatewayMulticastDomainCommandOutput /** *

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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { EC2Client, CreateTransitGatewayMulticastDomainCommand } from "@aws-sdk/client-ec2"; // ES Modules import + * // const { EC2Client, CreateTransitGatewayMulticastDomainCommand } = require("@aws-sdk/client-ec2"); // CommonJS import + * const client = new EC2Client(config); + * const command = new CreateTransitGatewayMulticastDomainCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreateTransitGatewayMulticastDomainCommandInput} for command's `input` shape. + * @see {@link CreateTransitGatewayMulticastDomainCommandOutput} for command's `response` shape. + * @see {@link EC2ClientResolvedConfig | config} for command's `input` shape. + * */ export class CreateTransitGatewayMulticastDomainCommand extends $Command< CreateTransitGatewayMulticastDomainCommandInput, diff --git a/clients/client-ec2/commands/CreateTransitGatewayPeeringAttachmentCommand.ts b/clients/client-ec2/commands/CreateTransitGatewayPeeringAttachmentCommand.ts index 33237cc8f50b..3daf56d596ba 100644 --- a/clients/client-ec2/commands/CreateTransitGatewayPeeringAttachmentCommand.ts +++ b/clients/client-ec2/commands/CreateTransitGatewayPeeringAttachmentCommand.ts @@ -33,6 +33,20 @@ export interface CreateTransitGatewayPeeringAttachmentCommandOutput * account.

*

After you create the peering attachment, the owner of the accepter * transit gateway must accept the attachment request.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { EC2Client, CreateTransitGatewayPeeringAttachmentCommand } from "@aws-sdk/client-ec2"; // ES Modules import + * // const { EC2Client, CreateTransitGatewayPeeringAttachmentCommand } = require("@aws-sdk/client-ec2"); // CommonJS import + * const client = new EC2Client(config); + * const command = new CreateTransitGatewayPeeringAttachmentCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreateTransitGatewayPeeringAttachmentCommandInput} for command's `input` shape. + * @see {@link CreateTransitGatewayPeeringAttachmentCommandOutput} for command's `response` shape. + * @see {@link EC2ClientResolvedConfig | config} for command's `input` shape. + * */ export class CreateTransitGatewayPeeringAttachmentCommand extends $Command< CreateTransitGatewayPeeringAttachmentCommandInput, diff --git a/clients/client-ec2/commands/CreateTransitGatewayPrefixListReferenceCommand.ts b/clients/client-ec2/commands/CreateTransitGatewayPrefixListReferenceCommand.ts index 32c660109ed8..3d27440815ea 100644 --- a/clients/client-ec2/commands/CreateTransitGatewayPrefixListReferenceCommand.ts +++ b/clients/client-ec2/commands/CreateTransitGatewayPrefixListReferenceCommand.ts @@ -28,6 +28,20 @@ export interface CreateTransitGatewayPrefixListReferenceCommandOutput /** *

Creates a reference (route) to a prefix list in a specified transit gateway route table.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { EC2Client, CreateTransitGatewayPrefixListReferenceCommand } from "@aws-sdk/client-ec2"; // ES Modules import + * // const { EC2Client, CreateTransitGatewayPrefixListReferenceCommand } = require("@aws-sdk/client-ec2"); // CommonJS import + * const client = new EC2Client(config); + * const command = new CreateTransitGatewayPrefixListReferenceCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreateTransitGatewayPrefixListReferenceCommandInput} for command's `input` shape. + * @see {@link CreateTransitGatewayPrefixListReferenceCommandOutput} for command's `response` shape. + * @see {@link EC2ClientResolvedConfig | config} for command's `input` shape. + * */ export class CreateTransitGatewayPrefixListReferenceCommand extends $Command< CreateTransitGatewayPrefixListReferenceCommandInput, diff --git a/clients/client-ec2/commands/CreateTransitGatewayRouteCommand.ts b/clients/client-ec2/commands/CreateTransitGatewayRouteCommand.ts index 5ca9c897aa09..204bbcf8f061 100644 --- a/clients/client-ec2/commands/CreateTransitGatewayRouteCommand.ts +++ b/clients/client-ec2/commands/CreateTransitGatewayRouteCommand.ts @@ -22,6 +22,20 @@ export interface CreateTransitGatewayRouteCommandOutput extends CreateTransitGat /** *

Creates a static route for the specified transit gateway route table.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { EC2Client, CreateTransitGatewayRouteCommand } from "@aws-sdk/client-ec2"; // ES Modules import + * // const { EC2Client, CreateTransitGatewayRouteCommand } = require("@aws-sdk/client-ec2"); // CommonJS import + * const client = new EC2Client(config); + * const command = new CreateTransitGatewayRouteCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreateTransitGatewayRouteCommandInput} for command's `input` shape. + * @see {@link CreateTransitGatewayRouteCommandOutput} for command's `response` shape. + * @see {@link EC2ClientResolvedConfig | config} for command's `input` shape. + * */ export class CreateTransitGatewayRouteCommand extends $Command< CreateTransitGatewayRouteCommandInput, diff --git a/clients/client-ec2/commands/CreateTransitGatewayRouteTableCommand.ts b/clients/client-ec2/commands/CreateTransitGatewayRouteTableCommand.ts index ed4ad4b24a27..d2ed8bd5faae 100644 --- a/clients/client-ec2/commands/CreateTransitGatewayRouteTableCommand.ts +++ b/clients/client-ec2/commands/CreateTransitGatewayRouteTableCommand.ts @@ -24,6 +24,20 @@ export interface CreateTransitGatewayRouteTableCommandOutput /** *

Creates a route table for the specified transit gateway.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { EC2Client, CreateTransitGatewayRouteTableCommand } from "@aws-sdk/client-ec2"; // ES Modules import + * // const { EC2Client, CreateTransitGatewayRouteTableCommand } = require("@aws-sdk/client-ec2"); // CommonJS import + * const client = new EC2Client(config); + * const command = new CreateTransitGatewayRouteTableCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreateTransitGatewayRouteTableCommandInput} for command's `input` shape. + * @see {@link CreateTransitGatewayRouteTableCommandOutput} for command's `response` shape. + * @see {@link EC2ClientResolvedConfig | config} for command's `input` shape. + * */ export class CreateTransitGatewayRouteTableCommand extends $Command< CreateTransitGatewayRouteTableCommandInput, diff --git a/clients/client-ec2/commands/CreateTransitGatewayVpcAttachmentCommand.ts b/clients/client-ec2/commands/CreateTransitGatewayVpcAttachmentCommand.ts index 63eeef3cceb1..9872d8fb6e7f 100644 --- a/clients/client-ec2/commands/CreateTransitGatewayVpcAttachmentCommand.ts +++ b/clients/client-ec2/commands/CreateTransitGatewayVpcAttachmentCommand.ts @@ -27,6 +27,20 @@ export interface CreateTransitGatewayVpcAttachmentCommandOutput *

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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { EC2Client, CreateTransitGatewayVpcAttachmentCommand } from "@aws-sdk/client-ec2"; // ES Modules import + * // const { EC2Client, CreateTransitGatewayVpcAttachmentCommand } = require("@aws-sdk/client-ec2"); // CommonJS import + * const client = new EC2Client(config); + * const command = new CreateTransitGatewayVpcAttachmentCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreateTransitGatewayVpcAttachmentCommandInput} for command's `input` shape. + * @see {@link CreateTransitGatewayVpcAttachmentCommandOutput} for command's `response` shape. + * @see {@link EC2ClientResolvedConfig | config} for command's `input` shape. + * */ export class CreateTransitGatewayVpcAttachmentCommand extends $Command< CreateTransitGatewayVpcAttachmentCommandInput, diff --git a/clients/client-ec2/commands/CreateVolumeCommand.ts b/clients/client-ec2/commands/CreateVolumeCommand.ts index 406e3a8ee851..3c716e8bb412 100644 --- a/clients/client-ec2/commands/CreateVolumeCommand.ts +++ b/clients/client-ec2/commands/CreateVolumeCommand.ts @@ -29,6 +29,20 @@ export interface CreateVolumeCommandOutput extends Volume, __MetadataBearer {} * resources in the Amazon Elastic Compute Cloud User Guide.

*

For more information, see Creating an Amazon EBS volume in the * Amazon Elastic Compute Cloud User Guide.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { EC2Client, CreateVolumeCommand } from "@aws-sdk/client-ec2"; // ES Modules import + * // const { EC2Client, CreateVolumeCommand } = require("@aws-sdk/client-ec2"); // CommonJS import + * const client = new EC2Client(config); + * const command = new CreateVolumeCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreateVolumeCommandInput} for command's `input` shape. + * @see {@link CreateVolumeCommandOutput} for command's `response` shape. + * @see {@link EC2ClientResolvedConfig | config} for command's `input` shape. + * */ export class CreateVolumeCommand extends $Command< CreateVolumeCommandInput, diff --git a/clients/client-ec2/commands/CreateVpcCommand.ts b/clients/client-ec2/commands/CreateVpcCommand.ts index b200360bd9f0..2c84b2c3ca22 100644 --- a/clients/client-ec2/commands/CreateVpcCommand.ts +++ b/clients/client-ec2/commands/CreateVpcCommand.ts @@ -29,6 +29,20 @@ export interface CreateVpcCommandOutput extends CreateVpcResult, __MetadataBeare *

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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { EC2Client, CreateVpcCommand } from "@aws-sdk/client-ec2"; // ES Modules import + * // const { EC2Client, CreateVpcCommand } = require("@aws-sdk/client-ec2"); // CommonJS import + * const client = new EC2Client(config); + * const command = new CreateVpcCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreateVpcCommandInput} for command's `input` shape. + * @see {@link CreateVpcCommandOutput} for command's `response` shape. + * @see {@link EC2ClientResolvedConfig | config} for command's `input` shape. + * */ export class CreateVpcCommand extends $Command { // Start section: command_properties diff --git a/clients/client-ec2/commands/CreateVpcEndpointCommand.ts b/clients/client-ec2/commands/CreateVpcEndpointCommand.ts index 4933248fb5c6..cab910b17608 100644 --- a/clients/client-ec2/commands/CreateVpcEndpointCommand.ts +++ b/clients/client-ec2/commands/CreateVpcEndpointCommand.ts @@ -36,6 +36,20 @@ export interface CreateVpcEndpointCommandOutput extends CreateVpcEndpointResult, *

A GatewayLoadBalancer endpoint is a network interface in your subnet that serves an endpoint for communicating with a Gateway Load Balancer that you've configured as a VPC endpoint service.

*

Use DescribeVpcEndpointServices to get a list of supported * services.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { EC2Client, CreateVpcEndpointCommand } from "@aws-sdk/client-ec2"; // ES Modules import + * // const { EC2Client, CreateVpcEndpointCommand } = require("@aws-sdk/client-ec2"); // CommonJS import + * const client = new EC2Client(config); + * const command = new CreateVpcEndpointCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreateVpcEndpointCommandInput} for command's `input` shape. + * @see {@link CreateVpcEndpointCommandOutput} for command's `response` shape. + * @see {@link EC2ClientResolvedConfig | config} for command's `input` shape. + * */ export class CreateVpcEndpointCommand extends $Command< CreateVpcEndpointCommandInput, diff --git a/clients/client-ec2/commands/CreateVpcEndpointConnectionNotificationCommand.ts b/clients/client-ec2/commands/CreateVpcEndpointConnectionNotificationCommand.ts index e7eac6f3f97b..8914c13b871b 100644 --- a/clients/client-ec2/commands/CreateVpcEndpointConnectionNotificationCommand.ts +++ b/clients/client-ec2/commands/CreateVpcEndpointConnectionNotificationCommand.ts @@ -32,6 +32,20 @@ export interface CreateVpcEndpointConnectionNotificationCommandOutput * 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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { EC2Client, CreateVpcEndpointConnectionNotificationCommand } from "@aws-sdk/client-ec2"; // ES Modules import + * // const { EC2Client, CreateVpcEndpointConnectionNotificationCommand } = require("@aws-sdk/client-ec2"); // CommonJS import + * const client = new EC2Client(config); + * const command = new CreateVpcEndpointConnectionNotificationCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreateVpcEndpointConnectionNotificationCommandInput} for command's `input` shape. + * @see {@link CreateVpcEndpointConnectionNotificationCommandOutput} for command's `response` shape. + * @see {@link EC2ClientResolvedConfig | config} for command's `input` shape. + * */ export class CreateVpcEndpointConnectionNotificationCommand extends $Command< CreateVpcEndpointConnectionNotificationCommandInput, diff --git a/clients/client-ec2/commands/CreateVpcEndpointServiceConfigurationCommand.ts b/clients/client-ec2/commands/CreateVpcEndpointServiceConfigurationCommand.ts index a2935fbdbcb7..a2fe2c14fb01 100644 --- a/clients/client-ec2/commands/CreateVpcEndpointServiceConfigurationCommand.ts +++ b/clients/client-ec2/commands/CreateVpcEndpointServiceConfigurationCommand.ts @@ -47,6 +47,20 @@ export interface CreateVpcEndpointServiceConfigurationCommandOutput * name. For more information, see VPC Endpoint Service * Private DNS Name Verification in the * Amazon Virtual Private Cloud User Guide.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { EC2Client, CreateVpcEndpointServiceConfigurationCommand } from "@aws-sdk/client-ec2"; // ES Modules import + * // const { EC2Client, CreateVpcEndpointServiceConfigurationCommand } = require("@aws-sdk/client-ec2"); // CommonJS import + * const client = new EC2Client(config); + * const command = new CreateVpcEndpointServiceConfigurationCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreateVpcEndpointServiceConfigurationCommandInput} for command's `input` shape. + * @see {@link CreateVpcEndpointServiceConfigurationCommandOutput} for command's `response` shape. + * @see {@link EC2ClientResolvedConfig | config} for command's `input` shape. + * */ export class CreateVpcEndpointServiceConfigurationCommand extends $Command< CreateVpcEndpointServiceConfigurationCommandInput, diff --git a/clients/client-ec2/commands/CreateVpcPeeringConnectionCommand.ts b/clients/client-ec2/commands/CreateVpcPeeringConnectionCommand.ts index 8411d2ac8136..79b3d1bfd981 100644 --- a/clients/client-ec2/commands/CreateVpcPeeringConnectionCommand.ts +++ b/clients/client-ec2/commands/CreateVpcPeeringConnectionCommand.ts @@ -33,6 +33,20 @@ export interface CreateVpcPeeringConnectionCommandOutput extends CreateVpcPeerin * 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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { EC2Client, CreateVpcPeeringConnectionCommand } from "@aws-sdk/client-ec2"; // ES Modules import + * // const { EC2Client, CreateVpcPeeringConnectionCommand } = require("@aws-sdk/client-ec2"); // CommonJS import + * const client = new EC2Client(config); + * const command = new CreateVpcPeeringConnectionCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreateVpcPeeringConnectionCommandInput} for command's `input` shape. + * @see {@link CreateVpcPeeringConnectionCommandOutput} for command's `response` shape. + * @see {@link EC2ClientResolvedConfig | config} for command's `input` shape. + * */ export class CreateVpcPeeringConnectionCommand extends $Command< CreateVpcPeeringConnectionCommandInput, diff --git a/clients/client-ec2/commands/CreateVpnConnectionCommand.ts b/clients/client-ec2/commands/CreateVpnConnectionCommand.ts index d55f44221abc..2d545381bef2 100644 --- a/clients/client-ec2/commands/CreateVpnConnectionCommand.ts +++ b/clients/client-ec2/commands/CreateVpnConnectionCommand.ts @@ -37,6 +37,20 @@ export interface CreateVpnConnectionCommandOutput extends CreateVpnConnectionRes * EC2 doesn't return an error.

*

For more information, see AWS Site-to-Site VPN in the AWS Site-to-Site VPN * User Guide.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { EC2Client, CreateVpnConnectionCommand } from "@aws-sdk/client-ec2"; // ES Modules import + * // const { EC2Client, CreateVpnConnectionCommand } = require("@aws-sdk/client-ec2"); // CommonJS import + * const client = new EC2Client(config); + * const command = new CreateVpnConnectionCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreateVpnConnectionCommandInput} for command's `input` shape. + * @see {@link CreateVpnConnectionCommandOutput} for command's `response` shape. + * @see {@link EC2ClientResolvedConfig | config} for command's `input` shape. + * */ export class CreateVpnConnectionCommand extends $Command< CreateVpnConnectionCommandInput, diff --git a/clients/client-ec2/commands/CreateVpnConnectionRouteCommand.ts b/clients/client-ec2/commands/CreateVpnConnectionRouteCommand.ts index af4a253ab60e..7e1a6ddb12f9 100644 --- a/clients/client-ec2/commands/CreateVpnConnectionRouteCommand.ts +++ b/clients/client-ec2/commands/CreateVpnConnectionRouteCommand.ts @@ -23,6 +23,20 @@ export interface CreateVpnConnectionRouteCommandOutput extends __MetadataBearer /** *

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 AWS Site-to-Site VPN in the AWS Site-to-Site VPN User Guide.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { EC2Client, CreateVpnConnectionRouteCommand } from "@aws-sdk/client-ec2"; // ES Modules import + * // const { EC2Client, CreateVpnConnectionRouteCommand } = require("@aws-sdk/client-ec2"); // CommonJS import + * const client = new EC2Client(config); + * const command = new CreateVpnConnectionRouteCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreateVpnConnectionRouteCommandInput} for command's `input` shape. + * @see {@link CreateVpnConnectionRouteCommandOutput} for command's `response` shape. + * @see {@link EC2ClientResolvedConfig | config} for command's `input` shape. + * */ export class CreateVpnConnectionRouteCommand extends $Command< CreateVpnConnectionRouteCommandInput, diff --git a/clients/client-ec2/commands/CreateVpnGatewayCommand.ts b/clients/client-ec2/commands/CreateVpnGatewayCommand.ts index 714fb6926620..f065670b3e31 100644 --- a/clients/client-ec2/commands/CreateVpnGatewayCommand.ts +++ b/clients/client-ec2/commands/CreateVpnGatewayCommand.ts @@ -23,6 +23,20 @@ export interface CreateVpnGatewayCommandOutput extends CreateVpnGatewayResult, _ /** *

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 AWS Site-to-Site VPN in the AWS Site-to-Site VPN User Guide.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { EC2Client, CreateVpnGatewayCommand } from "@aws-sdk/client-ec2"; // ES Modules import + * // const { EC2Client, CreateVpnGatewayCommand } = require("@aws-sdk/client-ec2"); // CommonJS import + * const client = new EC2Client(config); + * const command = new CreateVpnGatewayCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreateVpnGatewayCommandInput} for command's `input` shape. + * @see {@link CreateVpnGatewayCommandOutput} for command's `response` shape. + * @see {@link EC2ClientResolvedConfig | config} for command's `input` shape. + * */ export class CreateVpnGatewayCommand extends $Command< CreateVpnGatewayCommandInput, diff --git a/clients/client-ec2/commands/DeleteCarrierGatewayCommand.ts b/clients/client-ec2/commands/DeleteCarrierGatewayCommand.ts index 5fb4644c2651..a7d6d58141e5 100644 --- a/clients/client-ec2/commands/DeleteCarrierGatewayCommand.ts +++ b/clients/client-ec2/commands/DeleteCarrierGatewayCommand.ts @@ -27,6 +27,20 @@ export interface DeleteCarrierGatewayCommandOutput extends DeleteCarrierGatewayR * Target, the route is a blackhole route. For information about how to delete a route, see * DeleteRoute.

* + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { EC2Client, DeleteCarrierGatewayCommand } from "@aws-sdk/client-ec2"; // ES Modules import + * // const { EC2Client, DeleteCarrierGatewayCommand } = require("@aws-sdk/client-ec2"); // CommonJS import + * const client = new EC2Client(config); + * const command = new DeleteCarrierGatewayCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteCarrierGatewayCommandInput} for command's `input` shape. + * @see {@link DeleteCarrierGatewayCommandOutput} for command's `response` shape. + * @see {@link EC2ClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteCarrierGatewayCommand extends $Command< DeleteCarrierGatewayCommandInput, diff --git a/clients/client-ec2/commands/DeleteClientVpnEndpointCommand.ts b/clients/client-ec2/commands/DeleteClientVpnEndpointCommand.ts index 3427986b39da..712b4603f921 100644 --- a/clients/client-ec2/commands/DeleteClientVpnEndpointCommand.ts +++ b/clients/client-ec2/commands/DeleteClientVpnEndpointCommand.ts @@ -23,6 +23,20 @@ export interface DeleteClientVpnEndpointCommandOutput extends DeleteClientVpnEnd /** *

Deletes the specified Client VPN endpoint. You must disassociate all target networks before you * can delete a Client VPN endpoint.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { EC2Client, DeleteClientVpnEndpointCommand } from "@aws-sdk/client-ec2"; // ES Modules import + * // const { EC2Client, DeleteClientVpnEndpointCommand } = require("@aws-sdk/client-ec2"); // CommonJS import + * const client = new EC2Client(config); + * const command = new DeleteClientVpnEndpointCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteClientVpnEndpointCommandInput} for command's `input` shape. + * @see {@link DeleteClientVpnEndpointCommandOutput} for command's `response` shape. + * @see {@link EC2ClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteClientVpnEndpointCommand extends $Command< DeleteClientVpnEndpointCommandInput, diff --git a/clients/client-ec2/commands/DeleteClientVpnRouteCommand.ts b/clients/client-ec2/commands/DeleteClientVpnRouteCommand.ts index 1640acae3579..beab77a69616 100644 --- a/clients/client-ec2/commands/DeleteClientVpnRouteCommand.ts +++ b/clients/client-ec2/commands/DeleteClientVpnRouteCommand.ts @@ -25,6 +25,20 @@ export interface DeleteClientVpnRouteCommandOutput extends DeleteClientVpnRouteR * 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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { EC2Client, DeleteClientVpnRouteCommand } from "@aws-sdk/client-ec2"; // ES Modules import + * // const { EC2Client, DeleteClientVpnRouteCommand } = require("@aws-sdk/client-ec2"); // CommonJS import + * const client = new EC2Client(config); + * const command = new DeleteClientVpnRouteCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteClientVpnRouteCommandInput} for command's `input` shape. + * @see {@link DeleteClientVpnRouteCommandOutput} for command's `response` shape. + * @see {@link EC2ClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteClientVpnRouteCommand extends $Command< DeleteClientVpnRouteCommandInput, diff --git a/clients/client-ec2/commands/DeleteCustomerGatewayCommand.ts b/clients/client-ec2/commands/DeleteCustomerGatewayCommand.ts index e2155692662d..07b7dc6da2d2 100644 --- a/clients/client-ec2/commands/DeleteCustomerGatewayCommand.ts +++ b/clients/client-ec2/commands/DeleteCustomerGatewayCommand.ts @@ -22,6 +22,20 @@ export interface DeleteCustomerGatewayCommandOutput extends __MetadataBearer {} /** *

Deletes the specified customer gateway. You must delete the VPN connection before you can delete the customer gateway.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { EC2Client, DeleteCustomerGatewayCommand } from "@aws-sdk/client-ec2"; // ES Modules import + * // const { EC2Client, DeleteCustomerGatewayCommand } = require("@aws-sdk/client-ec2"); // CommonJS import + * const client = new EC2Client(config); + * const command = new DeleteCustomerGatewayCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteCustomerGatewayCommandInput} for command's `input` shape. + * @see {@link DeleteCustomerGatewayCommandOutput} for command's `response` shape. + * @see {@link EC2ClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteCustomerGatewayCommand extends $Command< DeleteCustomerGatewayCommandInput, diff --git a/clients/client-ec2/commands/DeleteDhcpOptionsCommand.ts b/clients/client-ec2/commands/DeleteDhcpOptionsCommand.ts index 33960e768e89..cce83e6f41f2 100644 --- a/clients/client-ec2/commands/DeleteDhcpOptionsCommand.ts +++ b/clients/client-ec2/commands/DeleteDhcpOptionsCommand.ts @@ -22,6 +22,20 @@ export interface DeleteDhcpOptionsCommandOutput extends __MetadataBearer {} /** *

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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { EC2Client, DeleteDhcpOptionsCommand } from "@aws-sdk/client-ec2"; // ES Modules import + * // const { EC2Client, DeleteDhcpOptionsCommand } = require("@aws-sdk/client-ec2"); // CommonJS import + * const client = new EC2Client(config); + * const command = new DeleteDhcpOptionsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteDhcpOptionsCommandInput} for command's `input` shape. + * @see {@link DeleteDhcpOptionsCommandOutput} for command's `response` shape. + * @see {@link EC2ClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteDhcpOptionsCommand extends $Command< DeleteDhcpOptionsCommandInput, diff --git a/clients/client-ec2/commands/DeleteEgressOnlyInternetGatewayCommand.ts b/clients/client-ec2/commands/DeleteEgressOnlyInternetGatewayCommand.ts index 26a068d9eabc..7be965af9240 100644 --- a/clients/client-ec2/commands/DeleteEgressOnlyInternetGatewayCommand.ts +++ b/clients/client-ec2/commands/DeleteEgressOnlyInternetGatewayCommand.ts @@ -24,6 +24,20 @@ export interface DeleteEgressOnlyInternetGatewayCommandOutput /** *

Deletes an egress-only internet gateway.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { EC2Client, DeleteEgressOnlyInternetGatewayCommand } from "@aws-sdk/client-ec2"; // ES Modules import + * // const { EC2Client, DeleteEgressOnlyInternetGatewayCommand } = require("@aws-sdk/client-ec2"); // CommonJS import + * const client = new EC2Client(config); + * const command = new DeleteEgressOnlyInternetGatewayCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteEgressOnlyInternetGatewayCommandInput} for command's `input` shape. + * @see {@link DeleteEgressOnlyInternetGatewayCommandOutput} for command's `response` shape. + * @see {@link EC2ClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteEgressOnlyInternetGatewayCommand extends $Command< DeleteEgressOnlyInternetGatewayCommandInput, diff --git a/clients/client-ec2/commands/DeleteFleetsCommand.ts b/clients/client-ec2/commands/DeleteFleetsCommand.ts index 5f093065bba4..e55eccea41c5 100644 --- a/clients/client-ec2/commands/DeleteFleetsCommand.ts +++ b/clients/client-ec2/commands/DeleteFleetsCommand.ts @@ -45,6 +45,20 @@ export interface DeleteFleetsCommandOutput extends DeleteFleetsResult, __Metadat * *

For more information, see Deleting an EC2 * Fleet in the Amazon EC2 User Guide.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { EC2Client, DeleteFleetsCommand } from "@aws-sdk/client-ec2"; // ES Modules import + * // const { EC2Client, DeleteFleetsCommand } = require("@aws-sdk/client-ec2"); // CommonJS import + * const client = new EC2Client(config); + * const command = new DeleteFleetsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteFleetsCommandInput} for command's `input` shape. + * @see {@link DeleteFleetsCommandOutput} for command's `response` shape. + * @see {@link EC2ClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteFleetsCommand extends $Command< DeleteFleetsCommandInput, diff --git a/clients/client-ec2/commands/DeleteFlowLogsCommand.ts b/clients/client-ec2/commands/DeleteFlowLogsCommand.ts index 99daab0f8dd5..3605d46a65cc 100644 --- a/clients/client-ec2/commands/DeleteFlowLogsCommand.ts +++ b/clients/client-ec2/commands/DeleteFlowLogsCommand.ts @@ -19,6 +19,20 @@ export interface DeleteFlowLogsCommandOutput extends DeleteFlowLogsResult, __Met /** *

Deletes one or more flow logs.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { EC2Client, DeleteFlowLogsCommand } from "@aws-sdk/client-ec2"; // ES Modules import + * // const { EC2Client, DeleteFlowLogsCommand } = require("@aws-sdk/client-ec2"); // CommonJS import + * const client = new EC2Client(config); + * const command = new DeleteFlowLogsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteFlowLogsCommandInput} for command's `input` shape. + * @see {@link DeleteFlowLogsCommandOutput} for command's `response` shape. + * @see {@link EC2ClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteFlowLogsCommand extends $Command< DeleteFlowLogsCommandInput, diff --git a/clients/client-ec2/commands/DeleteFpgaImageCommand.ts b/clients/client-ec2/commands/DeleteFpgaImageCommand.ts index 96b980dfbb4d..3704f74d3565 100644 --- a/clients/client-ec2/commands/DeleteFpgaImageCommand.ts +++ b/clients/client-ec2/commands/DeleteFpgaImageCommand.ts @@ -19,6 +19,20 @@ export interface DeleteFpgaImageCommandOutput extends DeleteFpgaImageResult, __M /** *

Deletes the specified Amazon FPGA Image (AFI).

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { EC2Client, DeleteFpgaImageCommand } from "@aws-sdk/client-ec2"; // ES Modules import + * // const { EC2Client, DeleteFpgaImageCommand } = require("@aws-sdk/client-ec2"); // CommonJS import + * const client = new EC2Client(config); + * const command = new DeleteFpgaImageCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteFpgaImageCommandInput} for command's `input` shape. + * @see {@link DeleteFpgaImageCommandOutput} for command's `response` shape. + * @see {@link EC2ClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteFpgaImageCommand extends $Command< DeleteFpgaImageCommandInput, diff --git a/clients/client-ec2/commands/DeleteInternetGatewayCommand.ts b/clients/client-ec2/commands/DeleteInternetGatewayCommand.ts index 985a7534bc77..184c7b8ea804 100644 --- a/clients/client-ec2/commands/DeleteInternetGatewayCommand.ts +++ b/clients/client-ec2/commands/DeleteInternetGatewayCommand.ts @@ -23,6 +23,20 @@ export interface DeleteInternetGatewayCommandOutput extends __MetadataBearer {} /** *

Deletes the specified internet gateway. You must detach the internet gateway from the * VPC before you can delete it.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { EC2Client, DeleteInternetGatewayCommand } from "@aws-sdk/client-ec2"; // ES Modules import + * // const { EC2Client, DeleteInternetGatewayCommand } = require("@aws-sdk/client-ec2"); // CommonJS import + * const client = new EC2Client(config); + * const command = new DeleteInternetGatewayCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteInternetGatewayCommandInput} for command's `input` shape. + * @see {@link DeleteInternetGatewayCommandOutput} for command's `response` shape. + * @see {@link EC2ClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteInternetGatewayCommand extends $Command< DeleteInternetGatewayCommandInput, diff --git a/clients/client-ec2/commands/DeleteKeyPairCommand.ts b/clients/client-ec2/commands/DeleteKeyPairCommand.ts index a988176cf4ed..2b8ddb348870 100644 --- a/clients/client-ec2/commands/DeleteKeyPairCommand.ts +++ b/clients/client-ec2/commands/DeleteKeyPairCommand.ts @@ -19,6 +19,20 @@ export interface DeleteKeyPairCommandOutput extends __MetadataBearer {} /** *

Deletes the specified key pair, by removing the public key from Amazon EC2.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { EC2Client, DeleteKeyPairCommand } from "@aws-sdk/client-ec2"; // ES Modules import + * // const { EC2Client, DeleteKeyPairCommand } = require("@aws-sdk/client-ec2"); // CommonJS import + * const client = new EC2Client(config); + * const command = new DeleteKeyPairCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteKeyPairCommandInput} for command's `input` shape. + * @see {@link DeleteKeyPairCommandOutput} for command's `response` shape. + * @see {@link EC2ClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteKeyPairCommand extends $Command< DeleteKeyPairCommandInput, diff --git a/clients/client-ec2/commands/DeleteLaunchTemplateCommand.ts b/clients/client-ec2/commands/DeleteLaunchTemplateCommand.ts index 192655d8f8f7..1403abad2578 100644 --- a/clients/client-ec2/commands/DeleteLaunchTemplateCommand.ts +++ b/clients/client-ec2/commands/DeleteLaunchTemplateCommand.ts @@ -22,6 +22,20 @@ export interface DeleteLaunchTemplateCommandOutput extends DeleteLaunchTemplateR /** *

Deletes a launch template. Deleting a launch template deletes all of its versions.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { EC2Client, DeleteLaunchTemplateCommand } from "@aws-sdk/client-ec2"; // ES Modules import + * // const { EC2Client, DeleteLaunchTemplateCommand } = require("@aws-sdk/client-ec2"); // CommonJS import + * const client = new EC2Client(config); + * const command = new DeleteLaunchTemplateCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteLaunchTemplateCommandInput} for command's `input` shape. + * @see {@link DeleteLaunchTemplateCommandOutput} for command's `response` shape. + * @see {@link EC2ClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteLaunchTemplateCommand extends $Command< DeleteLaunchTemplateCommandInput, diff --git a/clients/client-ec2/commands/DeleteLaunchTemplateVersionsCommand.ts b/clients/client-ec2/commands/DeleteLaunchTemplateVersionsCommand.ts index 8fefbe5aeb77..5770fc3a0e8e 100644 --- a/clients/client-ec2/commands/DeleteLaunchTemplateVersionsCommand.ts +++ b/clients/client-ec2/commands/DeleteLaunchTemplateVersionsCommand.ts @@ -27,6 +27,20 @@ export interface DeleteLaunchTemplateVersionsCommandOutput * 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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { EC2Client, DeleteLaunchTemplateVersionsCommand } from "@aws-sdk/client-ec2"; // ES Modules import + * // const { EC2Client, DeleteLaunchTemplateVersionsCommand } = require("@aws-sdk/client-ec2"); // CommonJS import + * const client = new EC2Client(config); + * const command = new DeleteLaunchTemplateVersionsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteLaunchTemplateVersionsCommandInput} for command's `input` shape. + * @see {@link DeleteLaunchTemplateVersionsCommandOutput} for command's `response` shape. + * @see {@link EC2ClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteLaunchTemplateVersionsCommand extends $Command< DeleteLaunchTemplateVersionsCommandInput, diff --git a/clients/client-ec2/commands/DeleteLocalGatewayRouteCommand.ts b/clients/client-ec2/commands/DeleteLocalGatewayRouteCommand.ts index d5904c69b518..4ce407c45d2f 100644 --- a/clients/client-ec2/commands/DeleteLocalGatewayRouteCommand.ts +++ b/clients/client-ec2/commands/DeleteLocalGatewayRouteCommand.ts @@ -22,6 +22,20 @@ export interface DeleteLocalGatewayRouteCommandOutput extends DeleteLocalGateway /** *

Deletes the specified route from the specified local gateway route table.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { EC2Client, DeleteLocalGatewayRouteCommand } from "@aws-sdk/client-ec2"; // ES Modules import + * // const { EC2Client, DeleteLocalGatewayRouteCommand } = require("@aws-sdk/client-ec2"); // CommonJS import + * const client = new EC2Client(config); + * const command = new DeleteLocalGatewayRouteCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteLocalGatewayRouteCommandInput} for command's `input` shape. + * @see {@link DeleteLocalGatewayRouteCommandOutput} for command's `response` shape. + * @see {@link EC2ClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteLocalGatewayRouteCommand extends $Command< DeleteLocalGatewayRouteCommandInput, diff --git a/clients/client-ec2/commands/DeleteLocalGatewayRouteTableVpcAssociationCommand.ts b/clients/client-ec2/commands/DeleteLocalGatewayRouteTableVpcAssociationCommand.ts index 0e087b5a715e..72454efd33ab 100644 --- a/clients/client-ec2/commands/DeleteLocalGatewayRouteTableVpcAssociationCommand.ts +++ b/clients/client-ec2/commands/DeleteLocalGatewayRouteTableVpcAssociationCommand.ts @@ -28,6 +28,20 @@ export interface DeleteLocalGatewayRouteTableVpcAssociationCommandOutput /** *

Deletes the specified association between a VPC and local gateway route table.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { EC2Client, DeleteLocalGatewayRouteTableVpcAssociationCommand } from "@aws-sdk/client-ec2"; // ES Modules import + * // const { EC2Client, DeleteLocalGatewayRouteTableVpcAssociationCommand } = require("@aws-sdk/client-ec2"); // CommonJS import + * const client = new EC2Client(config); + * const command = new DeleteLocalGatewayRouteTableVpcAssociationCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteLocalGatewayRouteTableVpcAssociationCommandInput} for command's `input` shape. + * @see {@link DeleteLocalGatewayRouteTableVpcAssociationCommandOutput} for command's `response` shape. + * @see {@link EC2ClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteLocalGatewayRouteTableVpcAssociationCommand extends $Command< DeleteLocalGatewayRouteTableVpcAssociationCommandInput, diff --git a/clients/client-ec2/commands/DeleteManagedPrefixListCommand.ts b/clients/client-ec2/commands/DeleteManagedPrefixListCommand.ts index f3aaf51c9d0d..24bf115cc75a 100644 --- a/clients/client-ec2/commands/DeleteManagedPrefixListCommand.ts +++ b/clients/client-ec2/commands/DeleteManagedPrefixListCommand.ts @@ -22,6 +22,20 @@ export interface DeleteManagedPrefixListCommandOutput extends DeleteManagedPrefi /** *

Deletes the specified managed prefix list. You must first remove all references to the prefix list in your resources.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { EC2Client, DeleteManagedPrefixListCommand } from "@aws-sdk/client-ec2"; // ES Modules import + * // const { EC2Client, DeleteManagedPrefixListCommand } = require("@aws-sdk/client-ec2"); // CommonJS import + * const client = new EC2Client(config); + * const command = new DeleteManagedPrefixListCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteManagedPrefixListCommandInput} for command's `input` shape. + * @see {@link DeleteManagedPrefixListCommandOutput} for command's `response` shape. + * @see {@link EC2ClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteManagedPrefixListCommand extends $Command< DeleteManagedPrefixListCommandInput, diff --git a/clients/client-ec2/commands/DeleteNatGatewayCommand.ts b/clients/client-ec2/commands/DeleteNatGatewayCommand.ts index 521af408335d..8825f9b3cd6e 100644 --- a/clients/client-ec2/commands/DeleteNatGatewayCommand.ts +++ b/clients/client-ec2/commands/DeleteNatGatewayCommand.ts @@ -22,6 +22,20 @@ export interface DeleteNatGatewayCommandOutput extends DeleteNatGatewayResult, _ /** *

Deletes the specified NAT gateway. Deleting a 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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { EC2Client, DeleteNatGatewayCommand } from "@aws-sdk/client-ec2"; // ES Modules import + * // const { EC2Client, DeleteNatGatewayCommand } = require("@aws-sdk/client-ec2"); // CommonJS import + * const client = new EC2Client(config); + * const command = new DeleteNatGatewayCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteNatGatewayCommandInput} for command's `input` shape. + * @see {@link DeleteNatGatewayCommandOutput} for command's `response` shape. + * @see {@link EC2ClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteNatGatewayCommand extends $Command< DeleteNatGatewayCommandInput, diff --git a/clients/client-ec2/commands/DeleteNetworkAclCommand.ts b/clients/client-ec2/commands/DeleteNetworkAclCommand.ts index 21914cd32799..ea8f86832a41 100644 --- a/clients/client-ec2/commands/DeleteNetworkAclCommand.ts +++ b/clients/client-ec2/commands/DeleteNetworkAclCommand.ts @@ -22,6 +22,20 @@ export interface DeleteNetworkAclCommandOutput extends __MetadataBearer {} /** *

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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { EC2Client, DeleteNetworkAclCommand } from "@aws-sdk/client-ec2"; // ES Modules import + * // const { EC2Client, DeleteNetworkAclCommand } = require("@aws-sdk/client-ec2"); // CommonJS import + * const client = new EC2Client(config); + * const command = new DeleteNetworkAclCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteNetworkAclCommandInput} for command's `input` shape. + * @see {@link DeleteNetworkAclCommandOutput} for command's `response` shape. + * @see {@link EC2ClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteNetworkAclCommand extends $Command< DeleteNetworkAclCommandInput, diff --git a/clients/client-ec2/commands/DeleteNetworkAclEntryCommand.ts b/clients/client-ec2/commands/DeleteNetworkAclEntryCommand.ts index 9b1c3cefa52a..e530963e73b8 100644 --- a/clients/client-ec2/commands/DeleteNetworkAclEntryCommand.ts +++ b/clients/client-ec2/commands/DeleteNetworkAclEntryCommand.ts @@ -22,6 +22,20 @@ export interface DeleteNetworkAclEntryCommandOutput extends __MetadataBearer {} /** *

Deletes the specified ingress or egress entry (rule) from the specified network ACL.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { EC2Client, DeleteNetworkAclEntryCommand } from "@aws-sdk/client-ec2"; // ES Modules import + * // const { EC2Client, DeleteNetworkAclEntryCommand } = require("@aws-sdk/client-ec2"); // CommonJS import + * const client = new EC2Client(config); + * const command = new DeleteNetworkAclEntryCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteNetworkAclEntryCommandInput} for command's `input` shape. + * @see {@link DeleteNetworkAclEntryCommandOutput} for command's `response` shape. + * @see {@link EC2ClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteNetworkAclEntryCommand extends $Command< DeleteNetworkAclEntryCommandInput, diff --git a/clients/client-ec2/commands/DeleteNetworkInsightsAnalysisCommand.ts b/clients/client-ec2/commands/DeleteNetworkInsightsAnalysisCommand.ts index 14368e26bb39..5fc45e2be67b 100644 --- a/clients/client-ec2/commands/DeleteNetworkInsightsAnalysisCommand.ts +++ b/clients/client-ec2/commands/DeleteNetworkInsightsAnalysisCommand.ts @@ -24,6 +24,20 @@ export interface DeleteNetworkInsightsAnalysisCommandOutput /** *

Deletes the specified network insights analysis.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { EC2Client, DeleteNetworkInsightsAnalysisCommand } from "@aws-sdk/client-ec2"; // ES Modules import + * // const { EC2Client, DeleteNetworkInsightsAnalysisCommand } = require("@aws-sdk/client-ec2"); // CommonJS import + * const client = new EC2Client(config); + * const command = new DeleteNetworkInsightsAnalysisCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteNetworkInsightsAnalysisCommandInput} for command's `input` shape. + * @see {@link DeleteNetworkInsightsAnalysisCommandOutput} for command's `response` shape. + * @see {@link EC2ClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteNetworkInsightsAnalysisCommand extends $Command< DeleteNetworkInsightsAnalysisCommandInput, diff --git a/clients/client-ec2/commands/DeleteNetworkInsightsPathCommand.ts b/clients/client-ec2/commands/DeleteNetworkInsightsPathCommand.ts index 028c8509e3ae..4a8fb1b0839e 100644 --- a/clients/client-ec2/commands/DeleteNetworkInsightsPathCommand.ts +++ b/clients/client-ec2/commands/DeleteNetworkInsightsPathCommand.ts @@ -22,6 +22,20 @@ export interface DeleteNetworkInsightsPathCommandOutput extends DeleteNetworkIns /** *

Deletes the specified path.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { EC2Client, DeleteNetworkInsightsPathCommand } from "@aws-sdk/client-ec2"; // ES Modules import + * // const { EC2Client, DeleteNetworkInsightsPathCommand } = require("@aws-sdk/client-ec2"); // CommonJS import + * const client = new EC2Client(config); + * const command = new DeleteNetworkInsightsPathCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteNetworkInsightsPathCommandInput} for command's `input` shape. + * @see {@link DeleteNetworkInsightsPathCommandOutput} for command's `response` shape. + * @see {@link EC2ClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteNetworkInsightsPathCommand extends $Command< DeleteNetworkInsightsPathCommandInput, diff --git a/clients/client-ec2/commands/DeleteNetworkInterfaceCommand.ts b/clients/client-ec2/commands/DeleteNetworkInterfaceCommand.ts index 3bb0a071af00..dd18486d627e 100644 --- a/clients/client-ec2/commands/DeleteNetworkInterfaceCommand.ts +++ b/clients/client-ec2/commands/DeleteNetworkInterfaceCommand.ts @@ -22,6 +22,20 @@ export interface DeleteNetworkInterfaceCommandOutput extends __MetadataBearer {} /** *

Deletes the specified network interface. You must detach the network interface before you can delete it.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { EC2Client, DeleteNetworkInterfaceCommand } from "@aws-sdk/client-ec2"; // ES Modules import + * // const { EC2Client, DeleteNetworkInterfaceCommand } = require("@aws-sdk/client-ec2"); // CommonJS import + * const client = new EC2Client(config); + * const command = new DeleteNetworkInterfaceCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteNetworkInterfaceCommandInput} for command's `input` shape. + * @see {@link DeleteNetworkInterfaceCommandOutput} for command's `response` shape. + * @see {@link EC2ClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteNetworkInterfaceCommand extends $Command< DeleteNetworkInterfaceCommandInput, diff --git a/clients/client-ec2/commands/DeleteNetworkInterfacePermissionCommand.ts b/clients/client-ec2/commands/DeleteNetworkInterfacePermissionCommand.ts index 272dcf07e770..05962ba0192d 100644 --- a/clients/client-ec2/commands/DeleteNetworkInterfacePermissionCommand.ts +++ b/clients/client-ec2/commands/DeleteNetworkInterfacePermissionCommand.ts @@ -27,6 +27,20 @@ export interface DeleteNetworkInterfacePermissionCommandOutput * 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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { EC2Client, DeleteNetworkInterfacePermissionCommand } from "@aws-sdk/client-ec2"; // ES Modules import + * // const { EC2Client, DeleteNetworkInterfacePermissionCommand } = require("@aws-sdk/client-ec2"); // CommonJS import + * const client = new EC2Client(config); + * const command = new DeleteNetworkInterfacePermissionCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteNetworkInterfacePermissionCommandInput} for command's `input` shape. + * @see {@link DeleteNetworkInterfacePermissionCommandOutput} for command's `response` shape. + * @see {@link EC2ClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteNetworkInterfacePermissionCommand extends $Command< DeleteNetworkInterfacePermissionCommandInput, diff --git a/clients/client-ec2/commands/DeletePlacementGroupCommand.ts b/clients/client-ec2/commands/DeletePlacementGroupCommand.ts index 763707010f0a..bb611cf4aec9 100644 --- a/clients/client-ec2/commands/DeletePlacementGroupCommand.ts +++ b/clients/client-ec2/commands/DeletePlacementGroupCommand.ts @@ -24,6 +24,20 @@ export interface DeletePlacementGroupCommandOutput extends __MetadataBearer {} *

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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { EC2Client, DeletePlacementGroupCommand } from "@aws-sdk/client-ec2"; // ES Modules import + * // const { EC2Client, DeletePlacementGroupCommand } = require("@aws-sdk/client-ec2"); // CommonJS import + * const client = new EC2Client(config); + * const command = new DeletePlacementGroupCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeletePlacementGroupCommandInput} for command's `input` shape. + * @see {@link DeletePlacementGroupCommandOutput} for command's `response` shape. + * @see {@link EC2ClientResolvedConfig | config} for command's `input` shape. + * */ export class DeletePlacementGroupCommand extends $Command< DeletePlacementGroupCommandInput, diff --git a/clients/client-ec2/commands/DeleteQueuedReservedInstancesCommand.ts b/clients/client-ec2/commands/DeleteQueuedReservedInstancesCommand.ts index 166734cb7213..24c3694bd297 100644 --- a/clients/client-ec2/commands/DeleteQueuedReservedInstancesCommand.ts +++ b/clients/client-ec2/commands/DeleteQueuedReservedInstancesCommand.ts @@ -24,6 +24,20 @@ export interface DeleteQueuedReservedInstancesCommandOutput /** *

Deletes the queued purchases for the specified Reserved Instances.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { EC2Client, DeleteQueuedReservedInstancesCommand } from "@aws-sdk/client-ec2"; // ES Modules import + * // const { EC2Client, DeleteQueuedReservedInstancesCommand } = require("@aws-sdk/client-ec2"); // CommonJS import + * const client = new EC2Client(config); + * const command = new DeleteQueuedReservedInstancesCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteQueuedReservedInstancesCommandInput} for command's `input` shape. + * @see {@link DeleteQueuedReservedInstancesCommandOutput} for command's `response` shape. + * @see {@link EC2ClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteQueuedReservedInstancesCommand extends $Command< DeleteQueuedReservedInstancesCommandInput, diff --git a/clients/client-ec2/commands/DeleteRouteCommand.ts b/clients/client-ec2/commands/DeleteRouteCommand.ts index 987a3741fb3b..0353f197b488 100644 --- a/clients/client-ec2/commands/DeleteRouteCommand.ts +++ b/clients/client-ec2/commands/DeleteRouteCommand.ts @@ -19,6 +19,20 @@ export interface DeleteRouteCommandOutput extends __MetadataBearer {} /** *

Deletes the specified route from the specified route table.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { EC2Client, DeleteRouteCommand } from "@aws-sdk/client-ec2"; // ES Modules import + * // const { EC2Client, DeleteRouteCommand } = require("@aws-sdk/client-ec2"); // CommonJS import + * const client = new EC2Client(config); + * const command = new DeleteRouteCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteRouteCommandInput} for command's `input` shape. + * @see {@link DeleteRouteCommandOutput} for command's `response` shape. + * @see {@link EC2ClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteRouteCommand extends $Command< DeleteRouteCommandInput, diff --git a/clients/client-ec2/commands/DeleteRouteTableCommand.ts b/clients/client-ec2/commands/DeleteRouteTableCommand.ts index 5262a067a74e..77cd889413b9 100644 --- a/clients/client-ec2/commands/DeleteRouteTableCommand.ts +++ b/clients/client-ec2/commands/DeleteRouteTableCommand.ts @@ -22,6 +22,20 @@ export interface DeleteRouteTableCommandOutput extends __MetadataBearer {} /** *

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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { EC2Client, DeleteRouteTableCommand } from "@aws-sdk/client-ec2"; // ES Modules import + * // const { EC2Client, DeleteRouteTableCommand } = require("@aws-sdk/client-ec2"); // CommonJS import + * const client = new EC2Client(config); + * const command = new DeleteRouteTableCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteRouteTableCommandInput} for command's `input` shape. + * @see {@link DeleteRouteTableCommandOutput} for command's `response` shape. + * @see {@link EC2ClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteRouteTableCommand extends $Command< DeleteRouteTableCommandInput, diff --git a/clients/client-ec2/commands/DeleteSecurityGroupCommand.ts b/clients/client-ec2/commands/DeleteSecurityGroupCommand.ts index 7666baa99a75..796a59f32210 100644 --- a/clients/client-ec2/commands/DeleteSecurityGroupCommand.ts +++ b/clients/client-ec2/commands/DeleteSecurityGroupCommand.ts @@ -26,6 +26,20 @@ export interface DeleteSecurityGroupCommandOutput extends __MetadataBearer {} * referenced by another security group, the operation fails with * InvalidGroup.InUse in EC2-Classic or * DependencyViolation in EC2-VPC.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { EC2Client, DeleteSecurityGroupCommand } from "@aws-sdk/client-ec2"; // ES Modules import + * // const { EC2Client, DeleteSecurityGroupCommand } = require("@aws-sdk/client-ec2"); // CommonJS import + * const client = new EC2Client(config); + * const command = new DeleteSecurityGroupCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteSecurityGroupCommandInput} for command's `input` shape. + * @see {@link DeleteSecurityGroupCommandOutput} for command's `response` shape. + * @see {@link EC2ClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteSecurityGroupCommand extends $Command< DeleteSecurityGroupCommandInput, diff --git a/clients/client-ec2/commands/DeleteSnapshotCommand.ts b/clients/client-ec2/commands/DeleteSnapshotCommand.ts index 886206a71541..8ed78d0059bd 100644 --- a/clients/client-ec2/commands/DeleteSnapshotCommand.ts +++ b/clients/client-ec2/commands/DeleteSnapshotCommand.ts @@ -28,6 +28,20 @@ export interface DeleteSnapshotCommandOutput extends __MetadataBearer {} * You must first de-register the AMI before you can delete the snapshot.

*

For more information, see Deleting an Amazon EBS snapshot in the * Amazon Elastic Compute Cloud User Guide.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { EC2Client, DeleteSnapshotCommand } from "@aws-sdk/client-ec2"; // ES Modules import + * // const { EC2Client, DeleteSnapshotCommand } = require("@aws-sdk/client-ec2"); // CommonJS import + * const client = new EC2Client(config); + * const command = new DeleteSnapshotCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteSnapshotCommandInput} for command's `input` shape. + * @see {@link DeleteSnapshotCommandOutput} for command's `response` shape. + * @see {@link EC2ClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteSnapshotCommand extends $Command< DeleteSnapshotCommandInput, diff --git a/clients/client-ec2/commands/DeleteSpotDatafeedSubscriptionCommand.ts b/clients/client-ec2/commands/DeleteSpotDatafeedSubscriptionCommand.ts index 37b60cc6cf90..49e8f50309f0 100644 --- a/clients/client-ec2/commands/DeleteSpotDatafeedSubscriptionCommand.ts +++ b/clients/client-ec2/commands/DeleteSpotDatafeedSubscriptionCommand.ts @@ -22,6 +22,20 @@ export interface DeleteSpotDatafeedSubscriptionCommandOutput extends __MetadataB /** *

Deletes the data feed for Spot Instances.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { EC2Client, DeleteSpotDatafeedSubscriptionCommand } from "@aws-sdk/client-ec2"; // ES Modules import + * // const { EC2Client, DeleteSpotDatafeedSubscriptionCommand } = require("@aws-sdk/client-ec2"); // CommonJS import + * const client = new EC2Client(config); + * const command = new DeleteSpotDatafeedSubscriptionCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteSpotDatafeedSubscriptionCommandInput} for command's `input` shape. + * @see {@link DeleteSpotDatafeedSubscriptionCommandOutput} for command's `response` shape. + * @see {@link EC2ClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteSpotDatafeedSubscriptionCommand extends $Command< DeleteSpotDatafeedSubscriptionCommandInput, diff --git a/clients/client-ec2/commands/DeleteSubnetCommand.ts b/clients/client-ec2/commands/DeleteSubnetCommand.ts index f8803b9559d0..82f93c2c54f9 100644 --- a/clients/client-ec2/commands/DeleteSubnetCommand.ts +++ b/clients/client-ec2/commands/DeleteSubnetCommand.ts @@ -19,6 +19,20 @@ export interface DeleteSubnetCommandOutput extends __MetadataBearer {} /** *

Deletes the specified subnet. You must terminate all running instances in the subnet before you can delete the subnet.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { EC2Client, DeleteSubnetCommand } from "@aws-sdk/client-ec2"; // ES Modules import + * // const { EC2Client, DeleteSubnetCommand } = require("@aws-sdk/client-ec2"); // CommonJS import + * const client = new EC2Client(config); + * const command = new DeleteSubnetCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteSubnetCommandInput} for command's `input` shape. + * @see {@link DeleteSubnetCommandOutput} for command's `response` shape. + * @see {@link EC2ClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteSubnetCommand extends $Command< DeleteSubnetCommandInput, diff --git a/clients/client-ec2/commands/DeleteTagsCommand.ts b/clients/client-ec2/commands/DeleteTagsCommand.ts index a56bd5e6f380..4156ac65005b 100644 --- a/clients/client-ec2/commands/DeleteTagsCommand.ts +++ b/clients/client-ec2/commands/DeleteTagsCommand.ts @@ -22,6 +22,20 @@ export interface DeleteTagsCommandOutput extends __MetadataBearer {} *

To list the current tags, use DescribeTags. For more information about tags, see * Tagging Your Resources * in the Amazon Elastic Compute Cloud User Guide.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { EC2Client, DeleteTagsCommand } from "@aws-sdk/client-ec2"; // ES Modules import + * // const { EC2Client, DeleteTagsCommand } = require("@aws-sdk/client-ec2"); // CommonJS import + * const client = new EC2Client(config); + * const command = new DeleteTagsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteTagsCommandInput} for command's `input` shape. + * @see {@link DeleteTagsCommandOutput} for command's `response` shape. + * @see {@link EC2ClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteTagsCommand extends $Command< DeleteTagsCommandInput, diff --git a/clients/client-ec2/commands/DeleteTrafficMirrorFilterCommand.ts b/clients/client-ec2/commands/DeleteTrafficMirrorFilterCommand.ts index ca36c9190939..9be7950a7538 100644 --- a/clients/client-ec2/commands/DeleteTrafficMirrorFilterCommand.ts +++ b/clients/client-ec2/commands/DeleteTrafficMirrorFilterCommand.ts @@ -23,6 +23,20 @@ export interface DeleteTrafficMirrorFilterCommandOutput extends DeleteTrafficMir /** *

Deletes the specified Traffic Mirror filter.

*

You cannot delete a Traffic Mirror filter that is in use by a Traffic Mirror session.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { EC2Client, DeleteTrafficMirrorFilterCommand } from "@aws-sdk/client-ec2"; // ES Modules import + * // const { EC2Client, DeleteTrafficMirrorFilterCommand } = require("@aws-sdk/client-ec2"); // CommonJS import + * const client = new EC2Client(config); + * const command = new DeleteTrafficMirrorFilterCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteTrafficMirrorFilterCommandInput} for command's `input` shape. + * @see {@link DeleteTrafficMirrorFilterCommandOutput} for command's `response` shape. + * @see {@link EC2ClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteTrafficMirrorFilterCommand extends $Command< DeleteTrafficMirrorFilterCommandInput, diff --git a/clients/client-ec2/commands/DeleteTrafficMirrorFilterRuleCommand.ts b/clients/client-ec2/commands/DeleteTrafficMirrorFilterRuleCommand.ts index aac5acdecabf..63b9b8f7854a 100644 --- a/clients/client-ec2/commands/DeleteTrafficMirrorFilterRuleCommand.ts +++ b/clients/client-ec2/commands/DeleteTrafficMirrorFilterRuleCommand.ts @@ -24,6 +24,20 @@ export interface DeleteTrafficMirrorFilterRuleCommandOutput /** *

Deletes the specified Traffic Mirror rule.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { EC2Client, DeleteTrafficMirrorFilterRuleCommand } from "@aws-sdk/client-ec2"; // ES Modules import + * // const { EC2Client, DeleteTrafficMirrorFilterRuleCommand } = require("@aws-sdk/client-ec2"); // CommonJS import + * const client = new EC2Client(config); + * const command = new DeleteTrafficMirrorFilterRuleCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteTrafficMirrorFilterRuleCommandInput} for command's `input` shape. + * @see {@link DeleteTrafficMirrorFilterRuleCommandOutput} for command's `response` shape. + * @see {@link EC2ClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteTrafficMirrorFilterRuleCommand extends $Command< DeleteTrafficMirrorFilterRuleCommandInput, diff --git a/clients/client-ec2/commands/DeleteTrafficMirrorSessionCommand.ts b/clients/client-ec2/commands/DeleteTrafficMirrorSessionCommand.ts index 6d40b2ca6a50..3c2c52ec9910 100644 --- a/clients/client-ec2/commands/DeleteTrafficMirrorSessionCommand.ts +++ b/clients/client-ec2/commands/DeleteTrafficMirrorSessionCommand.ts @@ -22,6 +22,20 @@ export interface DeleteTrafficMirrorSessionCommandOutput extends DeleteTrafficMi /** *

Deletes the specified Traffic Mirror session.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { EC2Client, DeleteTrafficMirrorSessionCommand } from "@aws-sdk/client-ec2"; // ES Modules import + * // const { EC2Client, DeleteTrafficMirrorSessionCommand } = require("@aws-sdk/client-ec2"); // CommonJS import + * const client = new EC2Client(config); + * const command = new DeleteTrafficMirrorSessionCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteTrafficMirrorSessionCommandInput} for command's `input` shape. + * @see {@link DeleteTrafficMirrorSessionCommandOutput} for command's `response` shape. + * @see {@link EC2ClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteTrafficMirrorSessionCommand extends $Command< DeleteTrafficMirrorSessionCommandInput, diff --git a/clients/client-ec2/commands/DeleteTrafficMirrorTargetCommand.ts b/clients/client-ec2/commands/DeleteTrafficMirrorTargetCommand.ts index 4c95f1e379ff..6020b7aaade5 100644 --- a/clients/client-ec2/commands/DeleteTrafficMirrorTargetCommand.ts +++ b/clients/client-ec2/commands/DeleteTrafficMirrorTargetCommand.ts @@ -23,6 +23,20 @@ export interface DeleteTrafficMirrorTargetCommandOutput extends DeleteTrafficMir /** *

Deletes the specified Traffic Mirror target.

*

You cannot delete a Traffic Mirror target that is in use by a Traffic Mirror session.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { EC2Client, DeleteTrafficMirrorTargetCommand } from "@aws-sdk/client-ec2"; // ES Modules import + * // const { EC2Client, DeleteTrafficMirrorTargetCommand } = require("@aws-sdk/client-ec2"); // CommonJS import + * const client = new EC2Client(config); + * const command = new DeleteTrafficMirrorTargetCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteTrafficMirrorTargetCommandInput} for command's `input` shape. + * @see {@link DeleteTrafficMirrorTargetCommandOutput} for command's `response` shape. + * @see {@link EC2ClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteTrafficMirrorTargetCommand extends $Command< DeleteTrafficMirrorTargetCommandInput, diff --git a/clients/client-ec2/commands/DeleteTransitGatewayCommand.ts b/clients/client-ec2/commands/DeleteTransitGatewayCommand.ts index f75097ada601..d341cf18150f 100644 --- a/clients/client-ec2/commands/DeleteTransitGatewayCommand.ts +++ b/clients/client-ec2/commands/DeleteTransitGatewayCommand.ts @@ -22,6 +22,20 @@ export interface DeleteTransitGatewayCommandOutput extends DeleteTransitGatewayR /** *

Deletes the specified transit gateway.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { EC2Client, DeleteTransitGatewayCommand } from "@aws-sdk/client-ec2"; // ES Modules import + * // const { EC2Client, DeleteTransitGatewayCommand } = require("@aws-sdk/client-ec2"); // CommonJS import + * const client = new EC2Client(config); + * const command = new DeleteTransitGatewayCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteTransitGatewayCommandInput} for command's `input` shape. + * @see {@link DeleteTransitGatewayCommandOutput} for command's `response` shape. + * @see {@link EC2ClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteTransitGatewayCommand extends $Command< DeleteTransitGatewayCommandInput, diff --git a/clients/client-ec2/commands/DeleteTransitGatewayConnectCommand.ts b/clients/client-ec2/commands/DeleteTransitGatewayConnectCommand.ts index 14fa4b81ce9e..5d451db8b294 100644 --- a/clients/client-ec2/commands/DeleteTransitGatewayConnectCommand.ts +++ b/clients/client-ec2/commands/DeleteTransitGatewayConnectCommand.ts @@ -23,6 +23,20 @@ export interface DeleteTransitGatewayConnectCommandOutput extends DeleteTransitG /** *

Deletes the specified Connect attachment. You must first delete any Connect peers for * the attachment.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { EC2Client, DeleteTransitGatewayConnectCommand } from "@aws-sdk/client-ec2"; // ES Modules import + * // const { EC2Client, DeleteTransitGatewayConnectCommand } = require("@aws-sdk/client-ec2"); // CommonJS import + * const client = new EC2Client(config); + * const command = new DeleteTransitGatewayConnectCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteTransitGatewayConnectCommandInput} for command's `input` shape. + * @see {@link DeleteTransitGatewayConnectCommandOutput} for command's `response` shape. + * @see {@link EC2ClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteTransitGatewayConnectCommand extends $Command< DeleteTransitGatewayConnectCommandInput, diff --git a/clients/client-ec2/commands/DeleteTransitGatewayConnectPeerCommand.ts b/clients/client-ec2/commands/DeleteTransitGatewayConnectPeerCommand.ts index 0925da5a19fc..82a7a4ca7079 100644 --- a/clients/client-ec2/commands/DeleteTransitGatewayConnectPeerCommand.ts +++ b/clients/client-ec2/commands/DeleteTransitGatewayConnectPeerCommand.ts @@ -24,6 +24,20 @@ export interface DeleteTransitGatewayConnectPeerCommandOutput /** *

Deletes the specified Connect peer.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { EC2Client, DeleteTransitGatewayConnectPeerCommand } from "@aws-sdk/client-ec2"; // ES Modules import + * // const { EC2Client, DeleteTransitGatewayConnectPeerCommand } = require("@aws-sdk/client-ec2"); // CommonJS import + * const client = new EC2Client(config); + * const command = new DeleteTransitGatewayConnectPeerCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteTransitGatewayConnectPeerCommandInput} for command's `input` shape. + * @see {@link DeleteTransitGatewayConnectPeerCommandOutput} for command's `response` shape. + * @see {@link EC2ClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteTransitGatewayConnectPeerCommand extends $Command< DeleteTransitGatewayConnectPeerCommandInput, diff --git a/clients/client-ec2/commands/DeleteTransitGatewayMulticastDomainCommand.ts b/clients/client-ec2/commands/DeleteTransitGatewayMulticastDomainCommand.ts index baf02589f371..6b5043eee1e8 100644 --- a/clients/client-ec2/commands/DeleteTransitGatewayMulticastDomainCommand.ts +++ b/clients/client-ec2/commands/DeleteTransitGatewayMulticastDomainCommand.ts @@ -27,6 +27,20 @@ export interface DeleteTransitGatewayMulticastDomainCommandOutput /** *

Deletes the specified transit gateway multicast domain.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { EC2Client, DeleteTransitGatewayMulticastDomainCommand } from "@aws-sdk/client-ec2"; // ES Modules import + * // const { EC2Client, DeleteTransitGatewayMulticastDomainCommand } = require("@aws-sdk/client-ec2"); // CommonJS import + * const client = new EC2Client(config); + * const command = new DeleteTransitGatewayMulticastDomainCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteTransitGatewayMulticastDomainCommandInput} for command's `input` shape. + * @see {@link DeleteTransitGatewayMulticastDomainCommandOutput} for command's `response` shape. + * @see {@link EC2ClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteTransitGatewayMulticastDomainCommand extends $Command< DeleteTransitGatewayMulticastDomainCommandInput, diff --git a/clients/client-ec2/commands/DeleteTransitGatewayPeeringAttachmentCommand.ts b/clients/client-ec2/commands/DeleteTransitGatewayPeeringAttachmentCommand.ts index db54289b5362..64085e3c5f05 100644 --- a/clients/client-ec2/commands/DeleteTransitGatewayPeeringAttachmentCommand.ts +++ b/clients/client-ec2/commands/DeleteTransitGatewayPeeringAttachmentCommand.ts @@ -28,6 +28,20 @@ export interface DeleteTransitGatewayPeeringAttachmentCommandOutput /** *

Deletes a transit gateway peering attachment.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { EC2Client, DeleteTransitGatewayPeeringAttachmentCommand } from "@aws-sdk/client-ec2"; // ES Modules import + * // const { EC2Client, DeleteTransitGatewayPeeringAttachmentCommand } = require("@aws-sdk/client-ec2"); // CommonJS import + * const client = new EC2Client(config); + * const command = new DeleteTransitGatewayPeeringAttachmentCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteTransitGatewayPeeringAttachmentCommandInput} for command's `input` shape. + * @see {@link DeleteTransitGatewayPeeringAttachmentCommandOutput} for command's `response` shape. + * @see {@link EC2ClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteTransitGatewayPeeringAttachmentCommand extends $Command< DeleteTransitGatewayPeeringAttachmentCommandInput, diff --git a/clients/client-ec2/commands/DeleteTransitGatewayPrefixListReferenceCommand.ts b/clients/client-ec2/commands/DeleteTransitGatewayPrefixListReferenceCommand.ts index 16ea1f6717ed..893c70f20bb7 100644 --- a/clients/client-ec2/commands/DeleteTransitGatewayPrefixListReferenceCommand.ts +++ b/clients/client-ec2/commands/DeleteTransitGatewayPrefixListReferenceCommand.ts @@ -28,6 +28,20 @@ export interface DeleteTransitGatewayPrefixListReferenceCommandOutput /** *

Deletes a reference (route) to a prefix list in a specified transit gateway route table.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { EC2Client, DeleteTransitGatewayPrefixListReferenceCommand } from "@aws-sdk/client-ec2"; // ES Modules import + * // const { EC2Client, DeleteTransitGatewayPrefixListReferenceCommand } = require("@aws-sdk/client-ec2"); // CommonJS import + * const client = new EC2Client(config); + * const command = new DeleteTransitGatewayPrefixListReferenceCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteTransitGatewayPrefixListReferenceCommandInput} for command's `input` shape. + * @see {@link DeleteTransitGatewayPrefixListReferenceCommandOutput} for command's `response` shape. + * @see {@link EC2ClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteTransitGatewayPrefixListReferenceCommand extends $Command< DeleteTransitGatewayPrefixListReferenceCommandInput, diff --git a/clients/client-ec2/commands/DeleteTransitGatewayRouteCommand.ts b/clients/client-ec2/commands/DeleteTransitGatewayRouteCommand.ts index 798babf53012..d18ccb819307 100644 --- a/clients/client-ec2/commands/DeleteTransitGatewayRouteCommand.ts +++ b/clients/client-ec2/commands/DeleteTransitGatewayRouteCommand.ts @@ -22,6 +22,20 @@ export interface DeleteTransitGatewayRouteCommandOutput extends DeleteTransitGat /** *

Deletes the specified route from the specified transit gateway route table.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { EC2Client, DeleteTransitGatewayRouteCommand } from "@aws-sdk/client-ec2"; // ES Modules import + * // const { EC2Client, DeleteTransitGatewayRouteCommand } = require("@aws-sdk/client-ec2"); // CommonJS import + * const client = new EC2Client(config); + * const command = new DeleteTransitGatewayRouteCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteTransitGatewayRouteCommandInput} for command's `input` shape. + * @see {@link DeleteTransitGatewayRouteCommandOutput} for command's `response` shape. + * @see {@link EC2ClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteTransitGatewayRouteCommand extends $Command< DeleteTransitGatewayRouteCommandInput, diff --git a/clients/client-ec2/commands/DeleteTransitGatewayRouteTableCommand.ts b/clients/client-ec2/commands/DeleteTransitGatewayRouteTableCommand.ts index aa38318e45a4..f328d8952590 100644 --- a/clients/client-ec2/commands/DeleteTransitGatewayRouteTableCommand.ts +++ b/clients/client-ec2/commands/DeleteTransitGatewayRouteTableCommand.ts @@ -25,6 +25,20 @@ export interface DeleteTransitGatewayRouteTableCommandOutput /** *

Deletes the specified transit gateway route table. You must disassociate the route table from any * transit gateway route tables before you can delete it.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { EC2Client, DeleteTransitGatewayRouteTableCommand } from "@aws-sdk/client-ec2"; // ES Modules import + * // const { EC2Client, DeleteTransitGatewayRouteTableCommand } = require("@aws-sdk/client-ec2"); // CommonJS import + * const client = new EC2Client(config); + * const command = new DeleteTransitGatewayRouteTableCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteTransitGatewayRouteTableCommandInput} for command's `input` shape. + * @see {@link DeleteTransitGatewayRouteTableCommandOutput} for command's `response` shape. + * @see {@link EC2ClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteTransitGatewayRouteTableCommand extends $Command< DeleteTransitGatewayRouteTableCommandInput, diff --git a/clients/client-ec2/commands/DeleteTransitGatewayVpcAttachmentCommand.ts b/clients/client-ec2/commands/DeleteTransitGatewayVpcAttachmentCommand.ts index 87fdb565d0b9..ad88ec1d7757 100644 --- a/clients/client-ec2/commands/DeleteTransitGatewayVpcAttachmentCommand.ts +++ b/clients/client-ec2/commands/DeleteTransitGatewayVpcAttachmentCommand.ts @@ -24,6 +24,20 @@ export interface DeleteTransitGatewayVpcAttachmentCommandOutput /** *

Deletes the specified VPC attachment.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { EC2Client, DeleteTransitGatewayVpcAttachmentCommand } from "@aws-sdk/client-ec2"; // ES Modules import + * // const { EC2Client, DeleteTransitGatewayVpcAttachmentCommand } = require("@aws-sdk/client-ec2"); // CommonJS import + * const client = new EC2Client(config); + * const command = new DeleteTransitGatewayVpcAttachmentCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteTransitGatewayVpcAttachmentCommandInput} for command's `input` shape. + * @see {@link DeleteTransitGatewayVpcAttachmentCommandOutput} for command's `response` shape. + * @see {@link EC2ClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteTransitGatewayVpcAttachmentCommand extends $Command< DeleteTransitGatewayVpcAttachmentCommandInput, diff --git a/clients/client-ec2/commands/DeleteVolumeCommand.ts b/clients/client-ec2/commands/DeleteVolumeCommand.ts index d5fcacd9c22e..11a81dd85d9b 100644 --- a/clients/client-ec2/commands/DeleteVolumeCommand.ts +++ b/clients/client-ec2/commands/DeleteVolumeCommand.ts @@ -23,6 +23,20 @@ export interface DeleteVolumeCommandOutput extends __MetadataBearer {} *

The volume can remain in the deleting state for several minutes.

*

For more information, see Deleting an Amazon EBS volume in the * Amazon Elastic Compute Cloud User Guide.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { EC2Client, DeleteVolumeCommand } from "@aws-sdk/client-ec2"; // ES Modules import + * // const { EC2Client, DeleteVolumeCommand } = require("@aws-sdk/client-ec2"); // CommonJS import + * const client = new EC2Client(config); + * const command = new DeleteVolumeCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteVolumeCommandInput} for command's `input` shape. + * @see {@link DeleteVolumeCommandOutput} for command's `response` shape. + * @see {@link EC2ClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteVolumeCommand extends $Command< DeleteVolumeCommandInput, diff --git a/clients/client-ec2/commands/DeleteVpcCommand.ts b/clients/client-ec2/commands/DeleteVpcCommand.ts index fdb5ed8c15b8..accd842441c2 100644 --- a/clients/client-ec2/commands/DeleteVpcCommand.ts +++ b/clients/client-ec2/commands/DeleteVpcCommand.ts @@ -19,6 +19,20 @@ export interface DeleteVpcCommandOutput extends __MetadataBearer {} /** *

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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { EC2Client, DeleteVpcCommand } from "@aws-sdk/client-ec2"; // ES Modules import + * // const { EC2Client, DeleteVpcCommand } = require("@aws-sdk/client-ec2"); // CommonJS import + * const client = new EC2Client(config); + * const command = new DeleteVpcCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteVpcCommandInput} for command's `input` shape. + * @see {@link DeleteVpcCommandOutput} for command's `response` shape. + * @see {@link EC2ClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteVpcCommand extends $Command { // Start section: command_properties diff --git a/clients/client-ec2/commands/DeleteVpcEndpointConnectionNotificationsCommand.ts b/clients/client-ec2/commands/DeleteVpcEndpointConnectionNotificationsCommand.ts index a723236f78d9..b5dcb4dbbd2a 100644 --- a/clients/client-ec2/commands/DeleteVpcEndpointConnectionNotificationsCommand.ts +++ b/clients/client-ec2/commands/DeleteVpcEndpointConnectionNotificationsCommand.ts @@ -28,6 +28,20 @@ export interface DeleteVpcEndpointConnectionNotificationsCommandOutput /** *

Deletes one or more VPC endpoint connection notifications.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { EC2Client, DeleteVpcEndpointConnectionNotificationsCommand } from "@aws-sdk/client-ec2"; // ES Modules import + * // const { EC2Client, DeleteVpcEndpointConnectionNotificationsCommand } = require("@aws-sdk/client-ec2"); // CommonJS import + * const client = new EC2Client(config); + * const command = new DeleteVpcEndpointConnectionNotificationsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteVpcEndpointConnectionNotificationsCommandInput} for command's `input` shape. + * @see {@link DeleteVpcEndpointConnectionNotificationsCommandOutput} for command's `response` shape. + * @see {@link EC2ClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteVpcEndpointConnectionNotificationsCommand extends $Command< DeleteVpcEndpointConnectionNotificationsCommandInput, diff --git a/clients/client-ec2/commands/DeleteVpcEndpointServiceConfigurationsCommand.ts b/clients/client-ec2/commands/DeleteVpcEndpointServiceConfigurationsCommand.ts index 0c88ccb9464a..d7027d4d249b 100644 --- a/clients/client-ec2/commands/DeleteVpcEndpointServiceConfigurationsCommand.ts +++ b/clients/client-ec2/commands/DeleteVpcEndpointServiceConfigurationsCommand.ts @@ -31,6 +31,20 @@ export interface DeleteVpcEndpointServiceConfigurationsCommandOutput * delete the endpoint service configuration, you must reject any Available or * PendingAcceptance interface endpoint connections that are attached to * the service.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { EC2Client, DeleteVpcEndpointServiceConfigurationsCommand } from "@aws-sdk/client-ec2"; // ES Modules import + * // const { EC2Client, DeleteVpcEndpointServiceConfigurationsCommand } = require("@aws-sdk/client-ec2"); // CommonJS import + * const client = new EC2Client(config); + * const command = new DeleteVpcEndpointServiceConfigurationsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteVpcEndpointServiceConfigurationsCommandInput} for command's `input` shape. + * @see {@link DeleteVpcEndpointServiceConfigurationsCommandOutput} for command's `response` shape. + * @see {@link EC2ClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteVpcEndpointServiceConfigurationsCommand extends $Command< DeleteVpcEndpointServiceConfigurationsCommandInput, diff --git a/clients/client-ec2/commands/DeleteVpcEndpointsCommand.ts b/clients/client-ec2/commands/DeleteVpcEndpointsCommand.ts index 3851f7b005e6..77aebf0c179d 100644 --- a/clients/client-ec2/commands/DeleteVpcEndpointsCommand.ts +++ b/clients/client-ec2/commands/DeleteVpcEndpointsCommand.ts @@ -46,6 +46,20 @@ export interface DeleteVpcEndpointsCommandOutput extends DeleteVpcEndpointsResul *

When you delete an interface endpoint, we delete the endpoint network interfaces.

* * + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { EC2Client, DeleteVpcEndpointsCommand } from "@aws-sdk/client-ec2"; // ES Modules import + * // const { EC2Client, DeleteVpcEndpointsCommand } = require("@aws-sdk/client-ec2"); // CommonJS import + * const client = new EC2Client(config); + * const command = new DeleteVpcEndpointsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteVpcEndpointsCommandInput} for command's `input` shape. + * @see {@link DeleteVpcEndpointsCommandOutput} for command's `response` shape. + * @see {@link EC2ClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteVpcEndpointsCommand extends $Command< DeleteVpcEndpointsCommandInput, diff --git a/clients/client-ec2/commands/DeleteVpcPeeringConnectionCommand.ts b/clients/client-ec2/commands/DeleteVpcPeeringConnectionCommand.ts index ef9ec2f30984..e7e3709ad263 100644 --- a/clients/client-ec2/commands/DeleteVpcPeeringConnectionCommand.ts +++ b/clients/client-ec2/commands/DeleteVpcPeeringConnectionCommand.ts @@ -26,6 +26,20 @@ export interface DeleteVpcPeeringConnectionCommandOutput extends DeleteVpcPeerin * 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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { EC2Client, DeleteVpcPeeringConnectionCommand } from "@aws-sdk/client-ec2"; // ES Modules import + * // const { EC2Client, DeleteVpcPeeringConnectionCommand } = require("@aws-sdk/client-ec2"); // CommonJS import + * const client = new EC2Client(config); + * const command = new DeleteVpcPeeringConnectionCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteVpcPeeringConnectionCommandInput} for command's `input` shape. + * @see {@link DeleteVpcPeeringConnectionCommandOutput} for command's `response` shape. + * @see {@link EC2ClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteVpcPeeringConnectionCommand extends $Command< DeleteVpcPeeringConnectionCommandInput, diff --git a/clients/client-ec2/commands/DeleteVpnConnectionCommand.ts b/clients/client-ec2/commands/DeleteVpnConnectionCommand.ts index d1c732108e95..5d94e4ce9249 100644 --- a/clients/client-ec2/commands/DeleteVpnConnectionCommand.ts +++ b/clients/client-ec2/commands/DeleteVpnConnectionCommand.ts @@ -24,6 +24,20 @@ export interface DeleteVpnConnectionCommandOutput extends __MetadataBearer {} *

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 AWS Certificate Manager (ACM) private certificates used for the AWS-side tunnel endpoints for the VPN connection before deleting the VPN connection.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { EC2Client, DeleteVpnConnectionCommand } from "@aws-sdk/client-ec2"; // ES Modules import + * // const { EC2Client, DeleteVpnConnectionCommand } = require("@aws-sdk/client-ec2"); // CommonJS import + * const client = new EC2Client(config); + * const command = new DeleteVpnConnectionCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteVpnConnectionCommandInput} for command's `input` shape. + * @see {@link DeleteVpnConnectionCommandOutput} for command's `response` shape. + * @see {@link EC2ClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteVpnConnectionCommand extends $Command< DeleteVpnConnectionCommandInput, diff --git a/clients/client-ec2/commands/DeleteVpnConnectionRouteCommand.ts b/clients/client-ec2/commands/DeleteVpnConnectionRouteCommand.ts index 0a92d24809f2..35ffa199e275 100644 --- a/clients/client-ec2/commands/DeleteVpnConnectionRouteCommand.ts +++ b/clients/client-ec2/commands/DeleteVpnConnectionRouteCommand.ts @@ -22,6 +22,20 @@ export interface DeleteVpnConnectionRouteCommandOutput extends __MetadataBearer /** *

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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { EC2Client, DeleteVpnConnectionRouteCommand } from "@aws-sdk/client-ec2"; // ES Modules import + * // const { EC2Client, DeleteVpnConnectionRouteCommand } = require("@aws-sdk/client-ec2"); // CommonJS import + * const client = new EC2Client(config); + * const command = new DeleteVpnConnectionRouteCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteVpnConnectionRouteCommandInput} for command's `input` shape. + * @see {@link DeleteVpnConnectionRouteCommandOutput} for command's `response` shape. + * @see {@link EC2ClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteVpnConnectionRouteCommand extends $Command< DeleteVpnConnectionRouteCommandInput, diff --git a/clients/client-ec2/commands/DeleteVpnGatewayCommand.ts b/clients/client-ec2/commands/DeleteVpnGatewayCommand.ts index aef15900ee35..7c96b1fc7191 100644 --- a/clients/client-ec2/commands/DeleteVpnGatewayCommand.ts +++ b/clients/client-ec2/commands/DeleteVpnGatewayCommand.ts @@ -22,6 +22,20 @@ export interface DeleteVpnGatewayCommandOutput extends __MetadataBearer {} /** *

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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { EC2Client, DeleteVpnGatewayCommand } from "@aws-sdk/client-ec2"; // ES Modules import + * // const { EC2Client, DeleteVpnGatewayCommand } = require("@aws-sdk/client-ec2"); // CommonJS import + * const client = new EC2Client(config); + * const command = new DeleteVpnGatewayCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteVpnGatewayCommandInput} for command's `input` shape. + * @see {@link DeleteVpnGatewayCommandOutput} for command's `response` shape. + * @see {@link EC2ClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteVpnGatewayCommand extends $Command< DeleteVpnGatewayCommandInput, diff --git a/clients/client-ec2/commands/DeprovisionByoipCidrCommand.ts b/clients/client-ec2/commands/DeprovisionByoipCidrCommand.ts index de79b927d4fb..0ec5fd6c399b 100644 --- a/clients/client-ec2/commands/DeprovisionByoipCidrCommand.ts +++ b/clients/client-ec2/commands/DeprovisionByoipCidrCommand.ts @@ -25,6 +25,20 @@ export interface DeprovisionByoipCidrCommandOutput extends DeprovisionByoipCidrR * 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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { EC2Client, DeprovisionByoipCidrCommand } from "@aws-sdk/client-ec2"; // ES Modules import + * // const { EC2Client, DeprovisionByoipCidrCommand } = require("@aws-sdk/client-ec2"); // CommonJS import + * const client = new EC2Client(config); + * const command = new DeprovisionByoipCidrCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeprovisionByoipCidrCommandInput} for command's `input` shape. + * @see {@link DeprovisionByoipCidrCommandOutput} for command's `response` shape. + * @see {@link EC2ClientResolvedConfig | config} for command's `input` shape. + * */ export class DeprovisionByoipCidrCommand extends $Command< DeprovisionByoipCidrCommandInput, diff --git a/clients/client-ec2/commands/DeregisterImageCommand.ts b/clients/client-ec2/commands/DeregisterImageCommand.ts index 03cdb0b30e3b..f9d2caf281ea 100644 --- a/clients/client-ec2/commands/DeregisterImageCommand.ts +++ b/clients/client-ec2/commands/DeregisterImageCommand.ts @@ -26,6 +26,20 @@ export interface DeregisterImageCommandOutput extends __MetadataBearer {} * 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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { EC2Client, DeregisterImageCommand } from "@aws-sdk/client-ec2"; // ES Modules import + * // const { EC2Client, DeregisterImageCommand } = require("@aws-sdk/client-ec2"); // CommonJS import + * const client = new EC2Client(config); + * const command = new DeregisterImageCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeregisterImageCommandInput} for command's `input` shape. + * @see {@link DeregisterImageCommandOutput} for command's `response` shape. + * @see {@link EC2ClientResolvedConfig | config} for command's `input` shape. + * */ export class DeregisterImageCommand extends $Command< DeregisterImageCommandInput, diff --git a/clients/client-ec2/commands/DeregisterInstanceEventNotificationAttributesCommand.ts b/clients/client-ec2/commands/DeregisterInstanceEventNotificationAttributesCommand.ts index eb031bec2e5c..760eee4f287f 100644 --- a/clients/client-ec2/commands/DeregisterInstanceEventNotificationAttributesCommand.ts +++ b/clients/client-ec2/commands/DeregisterInstanceEventNotificationAttributesCommand.ts @@ -29,6 +29,20 @@ export interface DeregisterInstanceEventNotificationAttributesCommandOutput /** *

Deregisters tag keys to prevent tags that have the specified tag keys from being included * in scheduled event notifications for resources in the Region.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { EC2Client, DeregisterInstanceEventNotificationAttributesCommand } from "@aws-sdk/client-ec2"; // ES Modules import + * // const { EC2Client, DeregisterInstanceEventNotificationAttributesCommand } = require("@aws-sdk/client-ec2"); // CommonJS import + * const client = new EC2Client(config); + * const command = new DeregisterInstanceEventNotificationAttributesCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeregisterInstanceEventNotificationAttributesCommandInput} for command's `input` shape. + * @see {@link DeregisterInstanceEventNotificationAttributesCommandOutput} for command's `response` shape. + * @see {@link EC2ClientResolvedConfig | config} for command's `input` shape. + * */ export class DeregisterInstanceEventNotificationAttributesCommand extends $Command< DeregisterInstanceEventNotificationAttributesCommandInput, diff --git a/clients/client-ec2/commands/DeregisterTransitGatewayMulticastGroupMembersCommand.ts b/clients/client-ec2/commands/DeregisterTransitGatewayMulticastGroupMembersCommand.ts index 9e9b7940d9dd..067f8cb45b77 100644 --- a/clients/client-ec2/commands/DeregisterTransitGatewayMulticastGroupMembersCommand.ts +++ b/clients/client-ec2/commands/DeregisterTransitGatewayMulticastGroupMembersCommand.ts @@ -28,6 +28,20 @@ export interface DeregisterTransitGatewayMulticastGroupMembersCommandOutput /** *

Deregisters the specified members (network interfaces) from the transit gateway multicast group.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { EC2Client, DeregisterTransitGatewayMulticastGroupMembersCommand } from "@aws-sdk/client-ec2"; // ES Modules import + * // const { EC2Client, DeregisterTransitGatewayMulticastGroupMembersCommand } = require("@aws-sdk/client-ec2"); // CommonJS import + * const client = new EC2Client(config); + * const command = new DeregisterTransitGatewayMulticastGroupMembersCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeregisterTransitGatewayMulticastGroupMembersCommandInput} for command's `input` shape. + * @see {@link DeregisterTransitGatewayMulticastGroupMembersCommandOutput} for command's `response` shape. + * @see {@link EC2ClientResolvedConfig | config} for command's `input` shape. + * */ export class DeregisterTransitGatewayMulticastGroupMembersCommand extends $Command< DeregisterTransitGatewayMulticastGroupMembersCommandInput, diff --git a/clients/client-ec2/commands/DeregisterTransitGatewayMulticastGroupSourcesCommand.ts b/clients/client-ec2/commands/DeregisterTransitGatewayMulticastGroupSourcesCommand.ts index bfd36cef157d..b3cb687f4195 100644 --- a/clients/client-ec2/commands/DeregisterTransitGatewayMulticastGroupSourcesCommand.ts +++ b/clients/client-ec2/commands/DeregisterTransitGatewayMulticastGroupSourcesCommand.ts @@ -28,6 +28,20 @@ export interface DeregisterTransitGatewayMulticastGroupSourcesCommandOutput /** *

Deregisters the specified sources (network interfaces) from the transit gateway multicast group.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { EC2Client, DeregisterTransitGatewayMulticastGroupSourcesCommand } from "@aws-sdk/client-ec2"; // ES Modules import + * // const { EC2Client, DeregisterTransitGatewayMulticastGroupSourcesCommand } = require("@aws-sdk/client-ec2"); // CommonJS import + * const client = new EC2Client(config); + * const command = new DeregisterTransitGatewayMulticastGroupSourcesCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeregisterTransitGatewayMulticastGroupSourcesCommandInput} for command's `input` shape. + * @see {@link DeregisterTransitGatewayMulticastGroupSourcesCommandOutput} for command's `response` shape. + * @see {@link EC2ClientResolvedConfig | config} for command's `input` shape. + * */ export class DeregisterTransitGatewayMulticastGroupSourcesCommand extends $Command< DeregisterTransitGatewayMulticastGroupSourcesCommandInput, diff --git a/clients/client-ec2/commands/DescribeAccountAttributesCommand.ts b/clients/client-ec2/commands/DescribeAccountAttributesCommand.ts index a9314dc68dba..851272424f06 100644 --- a/clients/client-ec2/commands/DescribeAccountAttributesCommand.ts +++ b/clients/client-ec2/commands/DescribeAccountAttributesCommand.ts @@ -56,6 +56,20 @@ export interface DescribeAccountAttributesCommandOutput extends DescribeAccountA * allocate for use with EC2-VPC.

* * + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { EC2Client, DescribeAccountAttributesCommand } from "@aws-sdk/client-ec2"; // ES Modules import + * // const { EC2Client, DescribeAccountAttributesCommand } = require("@aws-sdk/client-ec2"); // CommonJS import + * const client = new EC2Client(config); + * const command = new DescribeAccountAttributesCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeAccountAttributesCommandInput} for command's `input` shape. + * @see {@link DescribeAccountAttributesCommandOutput} for command's `response` shape. + * @see {@link EC2ClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeAccountAttributesCommand extends $Command< DescribeAccountAttributesCommandInput, diff --git a/clients/client-ec2/commands/DescribeAddressesAttributeCommand.ts b/clients/client-ec2/commands/DescribeAddressesAttributeCommand.ts index 9c59d3a31490..801d349d98c3 100644 --- a/clients/client-ec2/commands/DescribeAddressesAttributeCommand.ts +++ b/clients/client-ec2/commands/DescribeAddressesAttributeCommand.ts @@ -22,6 +22,20 @@ export interface DescribeAddressesAttributeCommandOutput extends DescribeAddress /** *

Describes the attributes of the specified Elastic IP addresses. For requirements, see Using reverse DNS for email applications.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { EC2Client, DescribeAddressesAttributeCommand } from "@aws-sdk/client-ec2"; // ES Modules import + * // const { EC2Client, DescribeAddressesAttributeCommand } = require("@aws-sdk/client-ec2"); // CommonJS import + * const client = new EC2Client(config); + * const command = new DescribeAddressesAttributeCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeAddressesAttributeCommandInput} for command's `input` shape. + * @see {@link DescribeAddressesAttributeCommandOutput} for command's `response` shape. + * @see {@link EC2ClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeAddressesAttributeCommand extends $Command< DescribeAddressesAttributeCommandInput, diff --git a/clients/client-ec2/commands/DescribeAddressesCommand.ts b/clients/client-ec2/commands/DescribeAddressesCommand.ts index 7213bc06cfe4..3d5778b8e9fb 100644 --- a/clients/client-ec2/commands/DescribeAddressesCommand.ts +++ b/clients/client-ec2/commands/DescribeAddressesCommand.ts @@ -24,6 +24,20 @@ export interface DescribeAddressesCommandOutput extends DescribeAddressesResult, *

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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { EC2Client, DescribeAddressesCommand } from "@aws-sdk/client-ec2"; // ES Modules import + * // const { EC2Client, DescribeAddressesCommand } = require("@aws-sdk/client-ec2"); // CommonJS import + * const client = new EC2Client(config); + * const command = new DescribeAddressesCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeAddressesCommandInput} for command's `input` shape. + * @see {@link DescribeAddressesCommandOutput} for command's `response` shape. + * @see {@link EC2ClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeAddressesCommand extends $Command< DescribeAddressesCommandInput, diff --git a/clients/client-ec2/commands/DescribeAggregateIdFormatCommand.ts b/clients/client-ec2/commands/DescribeAggregateIdFormatCommand.ts index 06699b22626e..5fc426d9341e 100644 --- a/clients/client-ec2/commands/DescribeAggregateIdFormatCommand.ts +++ b/clients/client-ec2/commands/DescribeAggregateIdFormatCommand.ts @@ -39,6 +39,20 @@ export interface DescribeAggregateIdFormatCommandOutput extends DescribeAggregat * subnet-cidr-block-association | volume | vpc | * vpc-cidr-block-association | vpc-endpoint | * vpc-peering-connection | vpn-connection | vpn-gateway.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { EC2Client, DescribeAggregateIdFormatCommand } from "@aws-sdk/client-ec2"; // ES Modules import + * // const { EC2Client, DescribeAggregateIdFormatCommand } = require("@aws-sdk/client-ec2"); // CommonJS import + * const client = new EC2Client(config); + * const command = new DescribeAggregateIdFormatCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeAggregateIdFormatCommandInput} for command's `input` shape. + * @see {@link DescribeAggregateIdFormatCommandOutput} for command's `response` shape. + * @see {@link EC2ClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeAggregateIdFormatCommand extends $Command< DescribeAggregateIdFormatCommandInput, diff --git a/clients/client-ec2/commands/DescribeAvailabilityZonesCommand.ts b/clients/client-ec2/commands/DescribeAvailabilityZonesCommand.ts index 4fcc5de43c17..b8f70d26f540 100644 --- a/clients/client-ec2/commands/DescribeAvailabilityZonesCommand.ts +++ b/clients/client-ec2/commands/DescribeAvailabilityZonesCommand.ts @@ -27,6 +27,20 @@ export interface DescribeAvailabilityZonesCommandOutput extends DescribeAvailabi *

For more information about Availability Zones, Local Zones, and Wavelength Zones, see * Regions, Zones and * Outposts in the Amazon Elastic Compute Cloud User Guide.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { EC2Client, DescribeAvailabilityZonesCommand } from "@aws-sdk/client-ec2"; // ES Modules import + * // const { EC2Client, DescribeAvailabilityZonesCommand } = require("@aws-sdk/client-ec2"); // CommonJS import + * const client = new EC2Client(config); + * const command = new DescribeAvailabilityZonesCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeAvailabilityZonesCommandInput} for command's `input` shape. + * @see {@link DescribeAvailabilityZonesCommandOutput} for command's `response` shape. + * @see {@link EC2ClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeAvailabilityZonesCommand extends $Command< DescribeAvailabilityZonesCommandInput, diff --git a/clients/client-ec2/commands/DescribeBundleTasksCommand.ts b/clients/client-ec2/commands/DescribeBundleTasksCommand.ts index e04d61ff78de..9867be339e89 100644 --- a/clients/client-ec2/commands/DescribeBundleTasksCommand.ts +++ b/clients/client-ec2/commands/DescribeBundleTasksCommand.ts @@ -25,6 +25,20 @@ export interface DescribeBundleTasksCommandOutput extends DescribeBundleTasksRes * *

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.

* + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { EC2Client, DescribeBundleTasksCommand } from "@aws-sdk/client-ec2"; // ES Modules import + * // const { EC2Client, DescribeBundleTasksCommand } = require("@aws-sdk/client-ec2"); // CommonJS import + * const client = new EC2Client(config); + * const command = new DescribeBundleTasksCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeBundleTasksCommandInput} for command's `input` shape. + * @see {@link DescribeBundleTasksCommandOutput} for command's `response` shape. + * @see {@link EC2ClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeBundleTasksCommand extends $Command< DescribeBundleTasksCommandInput, diff --git a/clients/client-ec2/commands/DescribeByoipCidrsCommand.ts b/clients/client-ec2/commands/DescribeByoipCidrsCommand.ts index f94b11d7aea3..975fb2bcee68 100644 --- a/clients/client-ec2/commands/DescribeByoipCidrsCommand.ts +++ b/clients/client-ec2/commands/DescribeByoipCidrsCommand.ts @@ -24,6 +24,20 @@ export interface DescribeByoipCidrsCommandOutput extends DescribeByoipCidrsResul *

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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { EC2Client, DescribeByoipCidrsCommand } from "@aws-sdk/client-ec2"; // ES Modules import + * // const { EC2Client, DescribeByoipCidrsCommand } = require("@aws-sdk/client-ec2"); // CommonJS import + * const client = new EC2Client(config); + * const command = new DescribeByoipCidrsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeByoipCidrsCommandInput} for command's `input` shape. + * @see {@link DescribeByoipCidrsCommandOutput} for command's `response` shape. + * @see {@link EC2ClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeByoipCidrsCommand extends $Command< DescribeByoipCidrsCommandInput, diff --git a/clients/client-ec2/commands/DescribeCapacityReservationsCommand.ts b/clients/client-ec2/commands/DescribeCapacityReservationsCommand.ts index 5c3206656ce5..5a5da30eb783 100644 --- a/clients/client-ec2/commands/DescribeCapacityReservationsCommand.ts +++ b/clients/client-ec2/commands/DescribeCapacityReservationsCommand.ts @@ -25,6 +25,20 @@ export interface DescribeCapacityReservationsCommandOutput /** *

Describes one or more of your Capacity Reservations. The results describe only the Capacity Reservations in the AWS * Region that you're currently using.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { EC2Client, DescribeCapacityReservationsCommand } from "@aws-sdk/client-ec2"; // ES Modules import + * // const { EC2Client, DescribeCapacityReservationsCommand } = require("@aws-sdk/client-ec2"); // CommonJS import + * const client = new EC2Client(config); + * const command = new DescribeCapacityReservationsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeCapacityReservationsCommandInput} for command's `input` shape. + * @see {@link DescribeCapacityReservationsCommandOutput} for command's `response` shape. + * @see {@link EC2ClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeCapacityReservationsCommand extends $Command< DescribeCapacityReservationsCommandInput, diff --git a/clients/client-ec2/commands/DescribeCarrierGatewaysCommand.ts b/clients/client-ec2/commands/DescribeCarrierGatewaysCommand.ts index 1edff11e6a51..fe94b22dfa1e 100644 --- a/clients/client-ec2/commands/DescribeCarrierGatewaysCommand.ts +++ b/clients/client-ec2/commands/DescribeCarrierGatewaysCommand.ts @@ -22,6 +22,20 @@ export interface DescribeCarrierGatewaysCommandOutput extends DescribeCarrierGat /** *

Describes one or more of your carrier gateways.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { EC2Client, DescribeCarrierGatewaysCommand } from "@aws-sdk/client-ec2"; // ES Modules import + * // const { EC2Client, DescribeCarrierGatewaysCommand } = require("@aws-sdk/client-ec2"); // CommonJS import + * const client = new EC2Client(config); + * const command = new DescribeCarrierGatewaysCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeCarrierGatewaysCommandInput} for command's `input` shape. + * @see {@link DescribeCarrierGatewaysCommandOutput} for command's `response` shape. + * @see {@link EC2ClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeCarrierGatewaysCommand extends $Command< DescribeCarrierGatewaysCommandInput, diff --git a/clients/client-ec2/commands/DescribeClassicLinkInstancesCommand.ts b/clients/client-ec2/commands/DescribeClassicLinkInstancesCommand.ts index 8e9ca1ccdbdd..7ee418d26086 100644 --- a/clients/client-ec2/commands/DescribeClassicLinkInstancesCommand.ts +++ b/clients/client-ec2/commands/DescribeClassicLinkInstancesCommand.ts @@ -26,6 +26,20 @@ export interface DescribeClassicLinkInstancesCommandOutput *

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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { EC2Client, DescribeClassicLinkInstancesCommand } from "@aws-sdk/client-ec2"; // ES Modules import + * // const { EC2Client, DescribeClassicLinkInstancesCommand } = require("@aws-sdk/client-ec2"); // CommonJS import + * const client = new EC2Client(config); + * const command = new DescribeClassicLinkInstancesCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeClassicLinkInstancesCommandInput} for command's `input` shape. + * @see {@link DescribeClassicLinkInstancesCommandOutput} for command's `response` shape. + * @see {@link EC2ClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeClassicLinkInstancesCommand extends $Command< DescribeClassicLinkInstancesCommandInput, diff --git a/clients/client-ec2/commands/DescribeClientVpnAuthorizationRulesCommand.ts b/clients/client-ec2/commands/DescribeClientVpnAuthorizationRulesCommand.ts index e0bab500723b..669cbbc2ee38 100644 --- a/clients/client-ec2/commands/DescribeClientVpnAuthorizationRulesCommand.ts +++ b/clients/client-ec2/commands/DescribeClientVpnAuthorizationRulesCommand.ts @@ -27,6 +27,20 @@ export interface DescribeClientVpnAuthorizationRulesCommandOutput /** *

Describes the authorization rules for a specified Client VPN endpoint.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { EC2Client, DescribeClientVpnAuthorizationRulesCommand } from "@aws-sdk/client-ec2"; // ES Modules import + * // const { EC2Client, DescribeClientVpnAuthorizationRulesCommand } = require("@aws-sdk/client-ec2"); // CommonJS import + * const client = new EC2Client(config); + * const command = new DescribeClientVpnAuthorizationRulesCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeClientVpnAuthorizationRulesCommandInput} for command's `input` shape. + * @see {@link DescribeClientVpnAuthorizationRulesCommandOutput} for command's `response` shape. + * @see {@link EC2ClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeClientVpnAuthorizationRulesCommand extends $Command< DescribeClientVpnAuthorizationRulesCommandInput, diff --git a/clients/client-ec2/commands/DescribeClientVpnConnectionsCommand.ts b/clients/client-ec2/commands/DescribeClientVpnConnectionsCommand.ts index a3d64030b837..4076950be25c 100644 --- a/clients/client-ec2/commands/DescribeClientVpnConnectionsCommand.ts +++ b/clients/client-ec2/commands/DescribeClientVpnConnectionsCommand.ts @@ -25,6 +25,20 @@ export interface DescribeClientVpnConnectionsCommandOutput /** *

Describes active client connections and connections that have been terminated within the last 60 * minutes for the specified Client VPN endpoint.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { EC2Client, DescribeClientVpnConnectionsCommand } from "@aws-sdk/client-ec2"; // ES Modules import + * // const { EC2Client, DescribeClientVpnConnectionsCommand } = require("@aws-sdk/client-ec2"); // CommonJS import + * const client = new EC2Client(config); + * const command = new DescribeClientVpnConnectionsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeClientVpnConnectionsCommandInput} for command's `input` shape. + * @see {@link DescribeClientVpnConnectionsCommandOutput} for command's `response` shape. + * @see {@link EC2ClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeClientVpnConnectionsCommand extends $Command< DescribeClientVpnConnectionsCommandInput, diff --git a/clients/client-ec2/commands/DescribeClientVpnEndpointsCommand.ts b/clients/client-ec2/commands/DescribeClientVpnEndpointsCommand.ts index 9209256b72a2..22ce6a50664e 100644 --- a/clients/client-ec2/commands/DescribeClientVpnEndpointsCommand.ts +++ b/clients/client-ec2/commands/DescribeClientVpnEndpointsCommand.ts @@ -22,6 +22,20 @@ export interface DescribeClientVpnEndpointsCommandOutput extends DescribeClientV /** *

Describes one or more Client VPN endpoints in the account.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { EC2Client, DescribeClientVpnEndpointsCommand } from "@aws-sdk/client-ec2"; // ES Modules import + * // const { EC2Client, DescribeClientVpnEndpointsCommand } = require("@aws-sdk/client-ec2"); // CommonJS import + * const client = new EC2Client(config); + * const command = new DescribeClientVpnEndpointsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeClientVpnEndpointsCommandInput} for command's `input` shape. + * @see {@link DescribeClientVpnEndpointsCommandOutput} for command's `response` shape. + * @see {@link EC2ClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeClientVpnEndpointsCommand extends $Command< DescribeClientVpnEndpointsCommandInput, diff --git a/clients/client-ec2/commands/DescribeClientVpnRoutesCommand.ts b/clients/client-ec2/commands/DescribeClientVpnRoutesCommand.ts index ccd7f4641c6d..8da77656ceae 100644 --- a/clients/client-ec2/commands/DescribeClientVpnRoutesCommand.ts +++ b/clients/client-ec2/commands/DescribeClientVpnRoutesCommand.ts @@ -22,6 +22,20 @@ export interface DescribeClientVpnRoutesCommandOutput extends DescribeClientVpnR /** *

Describes the routes for the specified Client VPN endpoint.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { EC2Client, DescribeClientVpnRoutesCommand } from "@aws-sdk/client-ec2"; // ES Modules import + * // const { EC2Client, DescribeClientVpnRoutesCommand } = require("@aws-sdk/client-ec2"); // CommonJS import + * const client = new EC2Client(config); + * const command = new DescribeClientVpnRoutesCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeClientVpnRoutesCommandInput} for command's `input` shape. + * @see {@link DescribeClientVpnRoutesCommandOutput} for command's `response` shape. + * @see {@link EC2ClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeClientVpnRoutesCommand extends $Command< DescribeClientVpnRoutesCommandInput, diff --git a/clients/client-ec2/commands/DescribeClientVpnTargetNetworksCommand.ts b/clients/client-ec2/commands/DescribeClientVpnTargetNetworksCommand.ts index d22e5925b09e..b1f0f944406d 100644 --- a/clients/client-ec2/commands/DescribeClientVpnTargetNetworksCommand.ts +++ b/clients/client-ec2/commands/DescribeClientVpnTargetNetworksCommand.ts @@ -24,6 +24,20 @@ export interface DescribeClientVpnTargetNetworksCommandOutput /** *

Describes the target networks associated with the specified Client VPN endpoint.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { EC2Client, DescribeClientVpnTargetNetworksCommand } from "@aws-sdk/client-ec2"; // ES Modules import + * // const { EC2Client, DescribeClientVpnTargetNetworksCommand } = require("@aws-sdk/client-ec2"); // CommonJS import + * const client = new EC2Client(config); + * const command = new DescribeClientVpnTargetNetworksCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeClientVpnTargetNetworksCommandInput} for command's `input` shape. + * @see {@link DescribeClientVpnTargetNetworksCommandOutput} for command's `response` shape. + * @see {@link EC2ClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeClientVpnTargetNetworksCommand extends $Command< DescribeClientVpnTargetNetworksCommandInput, diff --git a/clients/client-ec2/commands/DescribeCoipPoolsCommand.ts b/clients/client-ec2/commands/DescribeCoipPoolsCommand.ts index ce014b56f43a..4c4be282bed1 100644 --- a/clients/client-ec2/commands/DescribeCoipPoolsCommand.ts +++ b/clients/client-ec2/commands/DescribeCoipPoolsCommand.ts @@ -22,6 +22,20 @@ export interface DescribeCoipPoolsCommandOutput extends DescribeCoipPoolsResult, /** *

Describes the specified customer-owned address pools or all of your customer-owned address pools.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { EC2Client, DescribeCoipPoolsCommand } from "@aws-sdk/client-ec2"; // ES Modules import + * // const { EC2Client, DescribeCoipPoolsCommand } = require("@aws-sdk/client-ec2"); // CommonJS import + * const client = new EC2Client(config); + * const command = new DescribeCoipPoolsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeCoipPoolsCommandInput} for command's `input` shape. + * @see {@link DescribeCoipPoolsCommandOutput} for command's `response` shape. + * @see {@link EC2ClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeCoipPoolsCommand extends $Command< DescribeCoipPoolsCommandInput, diff --git a/clients/client-ec2/commands/DescribeConversionTasksCommand.ts b/clients/client-ec2/commands/DescribeConversionTasksCommand.ts index 6e4da6a2f5e9..6337e68fcd56 100644 --- a/clients/client-ec2/commands/DescribeConversionTasksCommand.ts +++ b/clients/client-ec2/commands/DescribeConversionTasksCommand.ts @@ -24,6 +24,20 @@ export interface DescribeConversionTasksCommandOutput extends DescribeConversion *

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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { EC2Client, DescribeConversionTasksCommand } from "@aws-sdk/client-ec2"; // ES Modules import + * // const { EC2Client, DescribeConversionTasksCommand } = require("@aws-sdk/client-ec2"); // CommonJS import + * const client = new EC2Client(config); + * const command = new DescribeConversionTasksCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeConversionTasksCommandInput} for command's `input` shape. + * @see {@link DescribeConversionTasksCommandOutput} for command's `response` shape. + * @see {@link EC2ClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeConversionTasksCommand extends $Command< DescribeConversionTasksCommandInput, diff --git a/clients/client-ec2/commands/DescribeCustomerGatewaysCommand.ts b/clients/client-ec2/commands/DescribeCustomerGatewaysCommand.ts index eca61fba0df4..c23bd9b0cdcd 100644 --- a/clients/client-ec2/commands/DescribeCustomerGatewaysCommand.ts +++ b/clients/client-ec2/commands/DescribeCustomerGatewaysCommand.ts @@ -23,6 +23,20 @@ export interface DescribeCustomerGatewaysCommandOutput extends DescribeCustomerG /** *

Describes one or more of your VPN customer gateways.

*

For more information, see AWS Site-to-Site VPN in the AWS Site-to-Site VPN User Guide.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { EC2Client, DescribeCustomerGatewaysCommand } from "@aws-sdk/client-ec2"; // ES Modules import + * // const { EC2Client, DescribeCustomerGatewaysCommand } = require("@aws-sdk/client-ec2"); // CommonJS import + * const client = new EC2Client(config); + * const command = new DescribeCustomerGatewaysCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeCustomerGatewaysCommandInput} for command's `input` shape. + * @see {@link DescribeCustomerGatewaysCommandOutput} for command's `response` shape. + * @see {@link EC2ClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeCustomerGatewaysCommand extends $Command< DescribeCustomerGatewaysCommandInput, diff --git a/clients/client-ec2/commands/DescribeDhcpOptionsCommand.ts b/clients/client-ec2/commands/DescribeDhcpOptionsCommand.ts index 8f8be190bd46..c94874c3655e 100644 --- a/clients/client-ec2/commands/DescribeDhcpOptionsCommand.ts +++ b/clients/client-ec2/commands/DescribeDhcpOptionsCommand.ts @@ -24,6 +24,20 @@ export interface DescribeDhcpOptionsCommandOutput extends DescribeDhcpOptionsRes *

Describes one or more of your DHCP options sets.

*

For more information, see DHCP Options Sets in the * Amazon Virtual Private Cloud User Guide.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { EC2Client, DescribeDhcpOptionsCommand } from "@aws-sdk/client-ec2"; // ES Modules import + * // const { EC2Client, DescribeDhcpOptionsCommand } = require("@aws-sdk/client-ec2"); // CommonJS import + * const client = new EC2Client(config); + * const command = new DescribeDhcpOptionsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeDhcpOptionsCommandInput} for command's `input` shape. + * @see {@link DescribeDhcpOptionsCommandOutput} for command's `response` shape. + * @see {@link EC2ClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeDhcpOptionsCommand extends $Command< DescribeDhcpOptionsCommandInput, diff --git a/clients/client-ec2/commands/DescribeEgressOnlyInternetGatewaysCommand.ts b/clients/client-ec2/commands/DescribeEgressOnlyInternetGatewaysCommand.ts index 37d7ea34d8fe..719bd04e0dc4 100644 --- a/clients/client-ec2/commands/DescribeEgressOnlyInternetGatewaysCommand.ts +++ b/clients/client-ec2/commands/DescribeEgressOnlyInternetGatewaysCommand.ts @@ -27,6 +27,20 @@ export interface DescribeEgressOnlyInternetGatewaysCommandOutput /** *

Describes one or more of your egress-only internet gateways.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { EC2Client, DescribeEgressOnlyInternetGatewaysCommand } from "@aws-sdk/client-ec2"; // ES Modules import + * // const { EC2Client, DescribeEgressOnlyInternetGatewaysCommand } = require("@aws-sdk/client-ec2"); // CommonJS import + * const client = new EC2Client(config); + * const command = new DescribeEgressOnlyInternetGatewaysCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeEgressOnlyInternetGatewaysCommandInput} for command's `input` shape. + * @see {@link DescribeEgressOnlyInternetGatewaysCommandOutput} for command's `response` shape. + * @see {@link EC2ClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeEgressOnlyInternetGatewaysCommand extends $Command< DescribeEgressOnlyInternetGatewaysCommandInput, diff --git a/clients/client-ec2/commands/DescribeElasticGpusCommand.ts b/clients/client-ec2/commands/DescribeElasticGpusCommand.ts index e9e0e12b8ab2..202911ab5336 100644 --- a/clients/client-ec2/commands/DescribeElasticGpusCommand.ts +++ b/clients/client-ec2/commands/DescribeElasticGpusCommand.ts @@ -23,6 +23,20 @@ export interface DescribeElasticGpusCommandOutput extends DescribeElasticGpusRes /** *

Describes the Elastic Graphics accelerator associated with your instances. For more information * about Elastic Graphics, see Amazon Elastic Graphics.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { EC2Client, DescribeElasticGpusCommand } from "@aws-sdk/client-ec2"; // ES Modules import + * // const { EC2Client, DescribeElasticGpusCommand } = require("@aws-sdk/client-ec2"); // CommonJS import + * const client = new EC2Client(config); + * const command = new DescribeElasticGpusCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeElasticGpusCommandInput} for command's `input` shape. + * @see {@link DescribeElasticGpusCommandOutput} for command's `response` shape. + * @see {@link EC2ClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeElasticGpusCommand extends $Command< DescribeElasticGpusCommandInput, diff --git a/clients/client-ec2/commands/DescribeExportImageTasksCommand.ts b/clients/client-ec2/commands/DescribeExportImageTasksCommand.ts index 4e1811e051aa..3cc8f395080c 100644 --- a/clients/client-ec2/commands/DescribeExportImageTasksCommand.ts +++ b/clients/client-ec2/commands/DescribeExportImageTasksCommand.ts @@ -22,6 +22,20 @@ export interface DescribeExportImageTasksCommandOutput extends DescribeExportIma /** *

Describes the specified export image tasks or all of your export image tasks.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { EC2Client, DescribeExportImageTasksCommand } from "@aws-sdk/client-ec2"; // ES Modules import + * // const { EC2Client, DescribeExportImageTasksCommand } = require("@aws-sdk/client-ec2"); // CommonJS import + * const client = new EC2Client(config); + * const command = new DescribeExportImageTasksCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeExportImageTasksCommandInput} for command's `input` shape. + * @see {@link DescribeExportImageTasksCommandOutput} for command's `response` shape. + * @see {@link EC2ClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeExportImageTasksCommand extends $Command< DescribeExportImageTasksCommandInput, diff --git a/clients/client-ec2/commands/DescribeExportTasksCommand.ts b/clients/client-ec2/commands/DescribeExportTasksCommand.ts index aeda6f12ce62..5a6a52155b0b 100644 --- a/clients/client-ec2/commands/DescribeExportTasksCommand.ts +++ b/clients/client-ec2/commands/DescribeExportTasksCommand.ts @@ -22,6 +22,20 @@ export interface DescribeExportTasksCommandOutput extends DescribeExportTasksRes /** *

Describes the specified export instance tasks or all of your export instance tasks.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { EC2Client, DescribeExportTasksCommand } from "@aws-sdk/client-ec2"; // ES Modules import + * // const { EC2Client, DescribeExportTasksCommand } = require("@aws-sdk/client-ec2"); // CommonJS import + * const client = new EC2Client(config); + * const command = new DescribeExportTasksCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeExportTasksCommandInput} for command's `input` shape. + * @see {@link DescribeExportTasksCommandOutput} for command's `response` shape. + * @see {@link EC2ClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeExportTasksCommand extends $Command< DescribeExportTasksCommandInput, diff --git a/clients/client-ec2/commands/DescribeFastSnapshotRestoresCommand.ts b/clients/client-ec2/commands/DescribeFastSnapshotRestoresCommand.ts index 4ff0229e527d..26343fa624d9 100644 --- a/clients/client-ec2/commands/DescribeFastSnapshotRestoresCommand.ts +++ b/clients/client-ec2/commands/DescribeFastSnapshotRestoresCommand.ts @@ -24,6 +24,20 @@ export interface DescribeFastSnapshotRestoresCommandOutput /** *

Describes the state of fast snapshot restores for your snapshots.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { EC2Client, DescribeFastSnapshotRestoresCommand } from "@aws-sdk/client-ec2"; // ES Modules import + * // const { EC2Client, DescribeFastSnapshotRestoresCommand } = require("@aws-sdk/client-ec2"); // CommonJS import + * const client = new EC2Client(config); + * const command = new DescribeFastSnapshotRestoresCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeFastSnapshotRestoresCommandInput} for command's `input` shape. + * @see {@link DescribeFastSnapshotRestoresCommandOutput} for command's `response` shape. + * @see {@link EC2ClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeFastSnapshotRestoresCommand extends $Command< DescribeFastSnapshotRestoresCommandInput, diff --git a/clients/client-ec2/commands/DescribeFleetHistoryCommand.ts b/clients/client-ec2/commands/DescribeFleetHistoryCommand.ts index c88b229b61c5..3eebaa0962d7 100644 --- a/clients/client-ec2/commands/DescribeFleetHistoryCommand.ts +++ b/clients/client-ec2/commands/DescribeFleetHistoryCommand.ts @@ -26,6 +26,20 @@ export interface DescribeFleetHistoryCommandOutput extends DescribeFleetHistoryR * 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 Monitoring your EC2 Fleet in the Amazon EC2 User Guide.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { EC2Client, DescribeFleetHistoryCommand } from "@aws-sdk/client-ec2"; // ES Modules import + * // const { EC2Client, DescribeFleetHistoryCommand } = require("@aws-sdk/client-ec2"); // CommonJS import + * const client = new EC2Client(config); + * const command = new DescribeFleetHistoryCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeFleetHistoryCommandInput} for command's `input` shape. + * @see {@link DescribeFleetHistoryCommandOutput} for command's `response` shape. + * @see {@link EC2ClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeFleetHistoryCommand extends $Command< DescribeFleetHistoryCommandInput, diff --git a/clients/client-ec2/commands/DescribeFleetInstancesCommand.ts b/clients/client-ec2/commands/DescribeFleetInstancesCommand.ts index 6784d9d1876b..c04469610e6d 100644 --- a/clients/client-ec2/commands/DescribeFleetInstancesCommand.ts +++ b/clients/client-ec2/commands/DescribeFleetInstancesCommand.ts @@ -23,6 +23,20 @@ export interface DescribeFleetInstancesCommandOutput extends DescribeFleetInstan /** *

Describes the running instances for the specified EC2 Fleet.

*

For more information, see Monitoring your EC2 Fleet in the Amazon EC2 User Guide.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { EC2Client, DescribeFleetInstancesCommand } from "@aws-sdk/client-ec2"; // ES Modules import + * // const { EC2Client, DescribeFleetInstancesCommand } = require("@aws-sdk/client-ec2"); // CommonJS import + * const client = new EC2Client(config); + * const command = new DescribeFleetInstancesCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeFleetInstancesCommandInput} for command's `input` shape. + * @see {@link DescribeFleetInstancesCommandOutput} for command's `response` shape. + * @see {@link EC2ClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeFleetInstancesCommand extends $Command< DescribeFleetInstancesCommandInput, diff --git a/clients/client-ec2/commands/DescribeFleetsCommand.ts b/clients/client-ec2/commands/DescribeFleetsCommand.ts index 807283e003fe..77fa3fb59d94 100644 --- a/clients/client-ec2/commands/DescribeFleetsCommand.ts +++ b/clients/client-ec2/commands/DescribeFleetsCommand.ts @@ -20,6 +20,20 @@ export interface DescribeFleetsCommandOutput extends DescribeFleetsResult, __Met /** *

Describes the specified EC2 Fleets or all of your EC2 Fleets.

*

For more information, see Monitoring your EC2 Fleet in the Amazon EC2 User Guide.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { EC2Client, DescribeFleetsCommand } from "@aws-sdk/client-ec2"; // ES Modules import + * // const { EC2Client, DescribeFleetsCommand } = require("@aws-sdk/client-ec2"); // CommonJS import + * const client = new EC2Client(config); + * const command = new DescribeFleetsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeFleetsCommandInput} for command's `input` shape. + * @see {@link DescribeFleetsCommandOutput} for command's `response` shape. + * @see {@link EC2ClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeFleetsCommand extends $Command< DescribeFleetsCommandInput, diff --git a/clients/client-ec2/commands/DescribeFlowLogsCommand.ts b/clients/client-ec2/commands/DescribeFlowLogsCommand.ts index dad111c71a4e..fde3297a5511 100644 --- a/clients/client-ec2/commands/DescribeFlowLogsCommand.ts +++ b/clients/client-ec2/commands/DescribeFlowLogsCommand.ts @@ -24,6 +24,20 @@ export interface DescribeFlowLogsCommandOutput extends DescribeFlowLogsResult, _ *

Describes one or more flow logs. To view the information in your flow logs (the log * streams for the network interfaces), you must use the CloudWatch Logs console or the CloudWatch Logs * API.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { EC2Client, DescribeFlowLogsCommand } from "@aws-sdk/client-ec2"; // ES Modules import + * // const { EC2Client, DescribeFlowLogsCommand } = require("@aws-sdk/client-ec2"); // CommonJS import + * const client = new EC2Client(config); + * const command = new DescribeFlowLogsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeFlowLogsCommandInput} for command's `input` shape. + * @see {@link DescribeFlowLogsCommandOutput} for command's `response` shape. + * @see {@link EC2ClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeFlowLogsCommand extends $Command< DescribeFlowLogsCommandInput, diff --git a/clients/client-ec2/commands/DescribeFpgaImageAttributeCommand.ts b/clients/client-ec2/commands/DescribeFpgaImageAttributeCommand.ts index 9cc59ebded44..4e39996d8478 100644 --- a/clients/client-ec2/commands/DescribeFpgaImageAttributeCommand.ts +++ b/clients/client-ec2/commands/DescribeFpgaImageAttributeCommand.ts @@ -22,6 +22,20 @@ export interface DescribeFpgaImageAttributeCommandOutput extends DescribeFpgaIma /** *

Describes the specified attribute of the specified Amazon FPGA Image (AFI).

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { EC2Client, DescribeFpgaImageAttributeCommand } from "@aws-sdk/client-ec2"; // ES Modules import + * // const { EC2Client, DescribeFpgaImageAttributeCommand } = require("@aws-sdk/client-ec2"); // CommonJS import + * const client = new EC2Client(config); + * const command = new DescribeFpgaImageAttributeCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeFpgaImageAttributeCommandInput} for command's `input` shape. + * @see {@link DescribeFpgaImageAttributeCommandOutput} for command's `response` shape. + * @see {@link EC2ClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeFpgaImageAttributeCommand extends $Command< DescribeFpgaImageAttributeCommandInput, diff --git a/clients/client-ec2/commands/DescribeFpgaImagesCommand.ts b/clients/client-ec2/commands/DescribeFpgaImagesCommand.ts index 3a2ae460d6d9..7fc10efb533a 100644 --- a/clients/client-ec2/commands/DescribeFpgaImagesCommand.ts +++ b/clients/client-ec2/commands/DescribeFpgaImagesCommand.ts @@ -24,6 +24,20 @@ export interface DescribeFpgaImagesCommandOutput extends DescribeFpgaImagesResul *

Describes the Amazon FPGA Images (AFIs) available to you. These include public AFIs, * private AFIs that you own, and AFIs owned by other AWS accounts for which you have load * permissions.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { EC2Client, DescribeFpgaImagesCommand } from "@aws-sdk/client-ec2"; // ES Modules import + * // const { EC2Client, DescribeFpgaImagesCommand } = require("@aws-sdk/client-ec2"); // CommonJS import + * const client = new EC2Client(config); + * const command = new DescribeFpgaImagesCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeFpgaImagesCommandInput} for command's `input` shape. + * @see {@link DescribeFpgaImagesCommandOutput} for command's `response` shape. + * @see {@link EC2ClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeFpgaImagesCommand extends $Command< DescribeFpgaImagesCommandInput, diff --git a/clients/client-ec2/commands/DescribeHostReservationOfferingsCommand.ts b/clients/client-ec2/commands/DescribeHostReservationOfferingsCommand.ts index 8fd53f25bbb6..47c3e049cf83 100644 --- a/clients/client-ec2/commands/DescribeHostReservationOfferingsCommand.ts +++ b/clients/client-ec2/commands/DescribeHostReservationOfferingsCommand.ts @@ -30,6 +30,20 @@ export interface DescribeHostReservationOfferingsCommandOutput * 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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { EC2Client, DescribeHostReservationOfferingsCommand } from "@aws-sdk/client-ec2"; // ES Modules import + * // const { EC2Client, DescribeHostReservationOfferingsCommand } = require("@aws-sdk/client-ec2"); // CommonJS import + * const client = new EC2Client(config); + * const command = new DescribeHostReservationOfferingsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeHostReservationOfferingsCommandInput} for command's `input` shape. + * @see {@link DescribeHostReservationOfferingsCommandOutput} for command's `response` shape. + * @see {@link EC2ClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeHostReservationOfferingsCommand extends $Command< DescribeHostReservationOfferingsCommandInput, diff --git a/clients/client-ec2/commands/DescribeHostReservationsCommand.ts b/clients/client-ec2/commands/DescribeHostReservationsCommand.ts index 70f2e1ca4054..3c88ec3d586e 100644 --- a/clients/client-ec2/commands/DescribeHostReservationsCommand.ts +++ b/clients/client-ec2/commands/DescribeHostReservationsCommand.ts @@ -23,6 +23,20 @@ export interface DescribeHostReservationsCommandOutput extends DescribeHostReser /** *

Describes reservations that are associated with Dedicated Hosts in your * account.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { EC2Client, DescribeHostReservationsCommand } from "@aws-sdk/client-ec2"; // ES Modules import + * // const { EC2Client, DescribeHostReservationsCommand } = require("@aws-sdk/client-ec2"); // CommonJS import + * const client = new EC2Client(config); + * const command = new DescribeHostReservationsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeHostReservationsCommandInput} for command's `input` shape. + * @see {@link DescribeHostReservationsCommandOutput} for command's `response` shape. + * @see {@link EC2ClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeHostReservationsCommand extends $Command< DescribeHostReservationsCommandInput, diff --git a/clients/client-ec2/commands/DescribeHostsCommand.ts b/clients/client-ec2/commands/DescribeHostsCommand.ts index 625f17accd39..f76ccb015438 100644 --- a/clients/client-ec2/commands/DescribeHostsCommand.ts +++ b/clients/client-ec2/commands/DescribeHostsCommand.ts @@ -22,6 +22,20 @@ export interface DescribeHostsCommandOutput extends DescribeHostsResult, __Metad *

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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { EC2Client, DescribeHostsCommand } from "@aws-sdk/client-ec2"; // ES Modules import + * // const { EC2Client, DescribeHostsCommand } = require("@aws-sdk/client-ec2"); // CommonJS import + * const client = new EC2Client(config); + * const command = new DescribeHostsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeHostsCommandInput} for command's `input` shape. + * @see {@link DescribeHostsCommandOutput} for command's `response` shape. + * @see {@link EC2ClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeHostsCommand extends $Command< DescribeHostsCommandInput, diff --git a/clients/client-ec2/commands/DescribeIamInstanceProfileAssociationsCommand.ts b/clients/client-ec2/commands/DescribeIamInstanceProfileAssociationsCommand.ts index 7f96f2ba5e36..4091bb78e33c 100644 --- a/clients/client-ec2/commands/DescribeIamInstanceProfileAssociationsCommand.ts +++ b/clients/client-ec2/commands/DescribeIamInstanceProfileAssociationsCommand.ts @@ -28,6 +28,20 @@ export interface DescribeIamInstanceProfileAssociationsCommandOutput /** *

Describes your IAM instance profile associations.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { EC2Client, DescribeIamInstanceProfileAssociationsCommand } from "@aws-sdk/client-ec2"; // ES Modules import + * // const { EC2Client, DescribeIamInstanceProfileAssociationsCommand } = require("@aws-sdk/client-ec2"); // CommonJS import + * const client = new EC2Client(config); + * const command = new DescribeIamInstanceProfileAssociationsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeIamInstanceProfileAssociationsCommandInput} for command's `input` shape. + * @see {@link DescribeIamInstanceProfileAssociationsCommandOutput} for command's `response` shape. + * @see {@link EC2ClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeIamInstanceProfileAssociationsCommand extends $Command< DescribeIamInstanceProfileAssociationsCommandInput, diff --git a/clients/client-ec2/commands/DescribeIdFormatCommand.ts b/clients/client-ec2/commands/DescribeIdFormatCommand.ts index d99dc11fbf93..bddeee89c743 100644 --- a/clients/client-ec2/commands/DescribeIdFormatCommand.ts +++ b/clients/client-ec2/commands/DescribeIdFormatCommand.ts @@ -41,6 +41,20 @@ export interface DescribeIdFormatCommandOutput extends DescribeIdFormatResult, _ * 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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { EC2Client, DescribeIdFormatCommand } from "@aws-sdk/client-ec2"; // ES Modules import + * // const { EC2Client, DescribeIdFormatCommand } = require("@aws-sdk/client-ec2"); // CommonJS import + * const client = new EC2Client(config); + * const command = new DescribeIdFormatCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeIdFormatCommandInput} for command's `input` shape. + * @see {@link DescribeIdFormatCommandOutput} for command's `response` shape. + * @see {@link EC2ClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeIdFormatCommand extends $Command< DescribeIdFormatCommandInput, diff --git a/clients/client-ec2/commands/DescribeIdentityIdFormatCommand.ts b/clients/client-ec2/commands/DescribeIdentityIdFormatCommand.ts index 33ed6054b245..562ae7d1e514 100644 --- a/clients/client-ec2/commands/DescribeIdentityIdFormatCommand.ts +++ b/clients/client-ec2/commands/DescribeIdentityIdFormatCommand.ts @@ -40,6 +40,20 @@ export interface DescribeIdentityIdFormatCommandOutput extends DescribeIdentityI * 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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { EC2Client, DescribeIdentityIdFormatCommand } from "@aws-sdk/client-ec2"; // ES Modules import + * // const { EC2Client, DescribeIdentityIdFormatCommand } = require("@aws-sdk/client-ec2"); // CommonJS import + * const client = new EC2Client(config); + * const command = new DescribeIdentityIdFormatCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeIdentityIdFormatCommandInput} for command's `input` shape. + * @see {@link DescribeIdentityIdFormatCommandOutput} for command's `response` shape. + * @see {@link EC2ClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeIdentityIdFormatCommand extends $Command< DescribeIdentityIdFormatCommandInput, diff --git a/clients/client-ec2/commands/DescribeImageAttributeCommand.ts b/clients/client-ec2/commands/DescribeImageAttributeCommand.ts index e0079c02bea6..ed28b49d7577 100644 --- a/clients/client-ec2/commands/DescribeImageAttributeCommand.ts +++ b/clients/client-ec2/commands/DescribeImageAttributeCommand.ts @@ -22,6 +22,20 @@ export interface DescribeImageAttributeCommandOutput extends ImageAttribute, __M /** *

Describes the specified attribute of the specified AMI. You can specify only one attribute at a time.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { EC2Client, DescribeImageAttributeCommand } from "@aws-sdk/client-ec2"; // ES Modules import + * // const { EC2Client, DescribeImageAttributeCommand } = require("@aws-sdk/client-ec2"); // CommonJS import + * const client = new EC2Client(config); + * const command = new DescribeImageAttributeCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeImageAttributeCommandInput} for command's `input` shape. + * @see {@link DescribeImageAttributeCommandOutput} for command's `response` shape. + * @see {@link EC2ClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeImageAttributeCommand extends $Command< DescribeImageAttributeCommandInput, diff --git a/clients/client-ec2/commands/DescribeImagesCommand.ts b/clients/client-ec2/commands/DescribeImagesCommand.ts index 7816d92107e9..9503b80e3e94 100644 --- a/clients/client-ec2/commands/DescribeImagesCommand.ts +++ b/clients/client-ec2/commands/DescribeImagesCommand.ts @@ -23,6 +23,20 @@ export interface DescribeImagesCommandOutput extends DescribeImagesResult, __Met *

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 results * in an error indicating that the AMI ID cannot be found.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { EC2Client, DescribeImagesCommand } from "@aws-sdk/client-ec2"; // ES Modules import + * // const { EC2Client, DescribeImagesCommand } = require("@aws-sdk/client-ec2"); // CommonJS import + * const client = new EC2Client(config); + * const command = new DescribeImagesCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeImagesCommandInput} for command's `input` shape. + * @see {@link DescribeImagesCommandOutput} for command's `response` shape. + * @see {@link EC2ClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeImagesCommand extends $Command< DescribeImagesCommandInput, diff --git a/clients/client-ec2/commands/DescribeImportImageTasksCommand.ts b/clients/client-ec2/commands/DescribeImportImageTasksCommand.ts index 5009a435b0d4..f7740310558d 100644 --- a/clients/client-ec2/commands/DescribeImportImageTasksCommand.ts +++ b/clients/client-ec2/commands/DescribeImportImageTasksCommand.ts @@ -22,6 +22,20 @@ export interface DescribeImportImageTasksCommandOutput extends DescribeImportIma /** *

Displays details about an import virtual machine or import snapshot tasks that are already created.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { EC2Client, DescribeImportImageTasksCommand } from "@aws-sdk/client-ec2"; // ES Modules import + * // const { EC2Client, DescribeImportImageTasksCommand } = require("@aws-sdk/client-ec2"); // CommonJS import + * const client = new EC2Client(config); + * const command = new DescribeImportImageTasksCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeImportImageTasksCommandInput} for command's `input` shape. + * @see {@link DescribeImportImageTasksCommandOutput} for command's `response` shape. + * @see {@link EC2ClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeImportImageTasksCommand extends $Command< DescribeImportImageTasksCommandInput, diff --git a/clients/client-ec2/commands/DescribeImportSnapshotTasksCommand.ts b/clients/client-ec2/commands/DescribeImportSnapshotTasksCommand.ts index 86ac9660426e..64f0985cd6b8 100644 --- a/clients/client-ec2/commands/DescribeImportSnapshotTasksCommand.ts +++ b/clients/client-ec2/commands/DescribeImportSnapshotTasksCommand.ts @@ -22,6 +22,20 @@ export interface DescribeImportSnapshotTasksCommandOutput extends DescribeImport /** *

Describes your import snapshot tasks.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { EC2Client, DescribeImportSnapshotTasksCommand } from "@aws-sdk/client-ec2"; // ES Modules import + * // const { EC2Client, DescribeImportSnapshotTasksCommand } = require("@aws-sdk/client-ec2"); // CommonJS import + * const client = new EC2Client(config); + * const command = new DescribeImportSnapshotTasksCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeImportSnapshotTasksCommandInput} for command's `input` shape. + * @see {@link DescribeImportSnapshotTasksCommandOutput} for command's `response` shape. + * @see {@link EC2ClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeImportSnapshotTasksCommand extends $Command< DescribeImportSnapshotTasksCommandInput, diff --git a/clients/client-ec2/commands/DescribeInstanceAttributeCommand.ts b/clients/client-ec2/commands/DescribeInstanceAttributeCommand.ts index a565d8b01231..3a3bdc0002ce 100644 --- a/clients/client-ec2/commands/DescribeInstanceAttributeCommand.ts +++ b/clients/client-ec2/commands/DescribeInstanceAttributeCommand.ts @@ -29,6 +29,20 @@ export interface DescribeInstanceAttributeCommandOutput extends InstanceAttribut * productCodes | sourceDestCheck | groupSet | * ebsOptimized | sriovNetSupport *

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { EC2Client, DescribeInstanceAttributeCommand } from "@aws-sdk/client-ec2"; // ES Modules import + * // const { EC2Client, DescribeInstanceAttributeCommand } = require("@aws-sdk/client-ec2"); // CommonJS import + * const client = new EC2Client(config); + * const command = new DescribeInstanceAttributeCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeInstanceAttributeCommandInput} for command's `input` shape. + * @see {@link DescribeInstanceAttributeCommandOutput} for command's `response` shape. + * @see {@link EC2ClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeInstanceAttributeCommand extends $Command< DescribeInstanceAttributeCommandInput, diff --git a/clients/client-ec2/commands/DescribeInstanceCreditSpecificationsCommand.ts b/clients/client-ec2/commands/DescribeInstanceCreditSpecificationsCommand.ts index d64aff171abc..9fe2bb3384d3 100644 --- a/clients/client-ec2/commands/DescribeInstanceCreditSpecificationsCommand.ts +++ b/clients/client-ec2/commands/DescribeInstanceCreditSpecificationsCommand.ts @@ -46,6 +46,20 @@ export interface DescribeInstanceCreditSpecificationsCommandOutput * 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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { EC2Client, DescribeInstanceCreditSpecificationsCommand } from "@aws-sdk/client-ec2"; // ES Modules import + * // const { EC2Client, DescribeInstanceCreditSpecificationsCommand } = require("@aws-sdk/client-ec2"); // CommonJS import + * const client = new EC2Client(config); + * const command = new DescribeInstanceCreditSpecificationsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeInstanceCreditSpecificationsCommandInput} for command's `input` shape. + * @see {@link DescribeInstanceCreditSpecificationsCommandOutput} for command's `response` shape. + * @see {@link EC2ClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeInstanceCreditSpecificationsCommand extends $Command< DescribeInstanceCreditSpecificationsCommandInput, diff --git a/clients/client-ec2/commands/DescribeInstanceEventNotificationAttributesCommand.ts b/clients/client-ec2/commands/DescribeInstanceEventNotificationAttributesCommand.ts index 738421348d77..dd40368bbfb8 100644 --- a/clients/client-ec2/commands/DescribeInstanceEventNotificationAttributesCommand.ts +++ b/clients/client-ec2/commands/DescribeInstanceEventNotificationAttributesCommand.ts @@ -29,6 +29,20 @@ export interface DescribeInstanceEventNotificationAttributesCommandOutput /** *

Describes the tag keys that are registered to appear in scheduled event notifications for * resources in the current Region.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { EC2Client, DescribeInstanceEventNotificationAttributesCommand } from "@aws-sdk/client-ec2"; // ES Modules import + * // const { EC2Client, DescribeInstanceEventNotificationAttributesCommand } = require("@aws-sdk/client-ec2"); // CommonJS import + * const client = new EC2Client(config); + * const command = new DescribeInstanceEventNotificationAttributesCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeInstanceEventNotificationAttributesCommandInput} for command's `input` shape. + * @see {@link DescribeInstanceEventNotificationAttributesCommandOutput} for command's `response` shape. + * @see {@link EC2ClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeInstanceEventNotificationAttributesCommand extends $Command< DescribeInstanceEventNotificationAttributesCommandInput, diff --git a/clients/client-ec2/commands/DescribeInstanceStatusCommand.ts b/clients/client-ec2/commands/DescribeInstanceStatusCommand.ts index f9a27d984f25..b8d77da0b7e2 100644 --- a/clients/client-ec2/commands/DescribeInstanceStatusCommand.ts +++ b/clients/client-ec2/commands/DescribeInstanceStatusCommand.ts @@ -48,6 +48,20 @@ export interface DescribeInstanceStatusCommandOutput extends DescribeInstanceSta * lifecycle in the Amazon EC2 User Guide.

* * + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { EC2Client, DescribeInstanceStatusCommand } from "@aws-sdk/client-ec2"; // ES Modules import + * // const { EC2Client, DescribeInstanceStatusCommand } = require("@aws-sdk/client-ec2"); // CommonJS import + * const client = new EC2Client(config); + * const command = new DescribeInstanceStatusCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeInstanceStatusCommandInput} for command's `input` shape. + * @see {@link DescribeInstanceStatusCommandOutput} for command's `response` shape. + * @see {@link EC2ClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeInstanceStatusCommand extends $Command< DescribeInstanceStatusCommandInput, diff --git a/clients/client-ec2/commands/DescribeInstanceTypeOfferingsCommand.ts b/clients/client-ec2/commands/DescribeInstanceTypeOfferingsCommand.ts index fe51550c80e7..dcaa2eb2d7c2 100644 --- a/clients/client-ec2/commands/DescribeInstanceTypeOfferingsCommand.ts +++ b/clients/client-ec2/commands/DescribeInstanceTypeOfferingsCommand.ts @@ -26,6 +26,20 @@ export interface DescribeInstanceTypeOfferingsCommandOutput /** *

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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { EC2Client, DescribeInstanceTypeOfferingsCommand } from "@aws-sdk/client-ec2"; // ES Modules import + * // const { EC2Client, DescribeInstanceTypeOfferingsCommand } = require("@aws-sdk/client-ec2"); // CommonJS import + * const client = new EC2Client(config); + * const command = new DescribeInstanceTypeOfferingsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeInstanceTypeOfferingsCommandInput} for command's `input` shape. + * @see {@link DescribeInstanceTypeOfferingsCommandOutput} for command's `response` shape. + * @see {@link EC2ClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeInstanceTypeOfferingsCommand extends $Command< DescribeInstanceTypeOfferingsCommandInput, diff --git a/clients/client-ec2/commands/DescribeInstanceTypesCommand.ts b/clients/client-ec2/commands/DescribeInstanceTypesCommand.ts index 46bd5742bf3c..149726206633 100644 --- a/clients/client-ec2/commands/DescribeInstanceTypesCommand.ts +++ b/clients/client-ec2/commands/DescribeInstanceTypesCommand.ts @@ -23,6 +23,20 @@ export interface DescribeInstanceTypesCommandOutput extends DescribeInstanceType /** *

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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { EC2Client, DescribeInstanceTypesCommand } from "@aws-sdk/client-ec2"; // ES Modules import + * // const { EC2Client, DescribeInstanceTypesCommand } = require("@aws-sdk/client-ec2"); // CommonJS import + * const client = new EC2Client(config); + * const command = new DescribeInstanceTypesCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeInstanceTypesCommandInput} for command's `input` shape. + * @see {@link DescribeInstanceTypesCommandOutput} for command's `response` shape. + * @see {@link EC2ClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeInstanceTypesCommand extends $Command< DescribeInstanceTypesCommandInput, diff --git a/clients/client-ec2/commands/DescribeInstancesCommand.ts b/clients/client-ec2/commands/DescribeInstancesCommand.ts index 531899cb57aa..84a5896006ef 100644 --- a/clients/client-ec2/commands/DescribeInstancesCommand.ts +++ b/clients/client-ec2/commands/DescribeInstancesCommand.ts @@ -36,6 +36,20 @@ export interface DescribeInstancesCommandOutput extends DescribeInstancesResult, * 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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { EC2Client, DescribeInstancesCommand } from "@aws-sdk/client-ec2"; // ES Modules import + * // const { EC2Client, DescribeInstancesCommand } = require("@aws-sdk/client-ec2"); // CommonJS import + * const client = new EC2Client(config); + * const command = new DescribeInstancesCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeInstancesCommandInput} for command's `input` shape. + * @see {@link DescribeInstancesCommandOutput} for command's `response` shape. + * @see {@link EC2ClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeInstancesCommand extends $Command< DescribeInstancesCommandInput, diff --git a/clients/client-ec2/commands/DescribeInternetGatewaysCommand.ts b/clients/client-ec2/commands/DescribeInternetGatewaysCommand.ts index 9ccee7e26093..bf46da68747d 100644 --- a/clients/client-ec2/commands/DescribeInternetGatewaysCommand.ts +++ b/clients/client-ec2/commands/DescribeInternetGatewaysCommand.ts @@ -22,6 +22,20 @@ export interface DescribeInternetGatewaysCommandOutput extends DescribeInternetG /** *

Describes one or more of your internet gateways.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { EC2Client, DescribeInternetGatewaysCommand } from "@aws-sdk/client-ec2"; // ES Modules import + * // const { EC2Client, DescribeInternetGatewaysCommand } = require("@aws-sdk/client-ec2"); // CommonJS import + * const client = new EC2Client(config); + * const command = new DescribeInternetGatewaysCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeInternetGatewaysCommandInput} for command's `input` shape. + * @see {@link DescribeInternetGatewaysCommandOutput} for command's `response` shape. + * @see {@link EC2ClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeInternetGatewaysCommand extends $Command< DescribeInternetGatewaysCommandInput, diff --git a/clients/client-ec2/commands/DescribeIpv6PoolsCommand.ts b/clients/client-ec2/commands/DescribeIpv6PoolsCommand.ts index 9521319e1117..e0a547e9c20e 100644 --- a/clients/client-ec2/commands/DescribeIpv6PoolsCommand.ts +++ b/clients/client-ec2/commands/DescribeIpv6PoolsCommand.ts @@ -22,6 +22,20 @@ export interface DescribeIpv6PoolsCommandOutput extends DescribeIpv6PoolsResult, /** *

Describes your IPv6 address pools.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { EC2Client, DescribeIpv6PoolsCommand } from "@aws-sdk/client-ec2"; // ES Modules import + * // const { EC2Client, DescribeIpv6PoolsCommand } = require("@aws-sdk/client-ec2"); // CommonJS import + * const client = new EC2Client(config); + * const command = new DescribeIpv6PoolsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeIpv6PoolsCommandInput} for command's `input` shape. + * @see {@link DescribeIpv6PoolsCommandOutput} for command's `response` shape. + * @see {@link EC2ClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeIpv6PoolsCommand extends $Command< DescribeIpv6PoolsCommandInput, diff --git a/clients/client-ec2/commands/DescribeKeyPairsCommand.ts b/clients/client-ec2/commands/DescribeKeyPairsCommand.ts index 587af456f663..f78a63d540d2 100644 --- a/clients/client-ec2/commands/DescribeKeyPairsCommand.ts +++ b/clients/client-ec2/commands/DescribeKeyPairsCommand.ts @@ -24,6 +24,20 @@ export interface DescribeKeyPairsCommandOutput extends DescribeKeyPairsResult, _ *

Describes the specified key pairs or all of your key pairs.

*

For more information about key pairs, see Key Pairs * in the Amazon Elastic Compute Cloud User Guide.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { EC2Client, DescribeKeyPairsCommand } from "@aws-sdk/client-ec2"; // ES Modules import + * // const { EC2Client, DescribeKeyPairsCommand } = require("@aws-sdk/client-ec2"); // CommonJS import + * const client = new EC2Client(config); + * const command = new DescribeKeyPairsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeKeyPairsCommandInput} for command's `input` shape. + * @see {@link DescribeKeyPairsCommandOutput} for command's `response` shape. + * @see {@link EC2ClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeKeyPairsCommand extends $Command< DescribeKeyPairsCommandInput, diff --git a/clients/client-ec2/commands/DescribeLaunchTemplateVersionsCommand.ts b/clients/client-ec2/commands/DescribeLaunchTemplateVersionsCommand.ts index a0c8f90bdebf..922df6c1b62c 100644 --- a/clients/client-ec2/commands/DescribeLaunchTemplateVersionsCommand.ts +++ b/clients/client-ec2/commands/DescribeLaunchTemplateVersionsCommand.ts @@ -27,6 +27,20 @@ export interface DescribeLaunchTemplateVersionsCommandOutput * 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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { EC2Client, DescribeLaunchTemplateVersionsCommand } from "@aws-sdk/client-ec2"; // ES Modules import + * // const { EC2Client, DescribeLaunchTemplateVersionsCommand } = require("@aws-sdk/client-ec2"); // CommonJS import + * const client = new EC2Client(config); + * const command = new DescribeLaunchTemplateVersionsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeLaunchTemplateVersionsCommandInput} for command's `input` shape. + * @see {@link DescribeLaunchTemplateVersionsCommandOutput} for command's `response` shape. + * @see {@link EC2ClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeLaunchTemplateVersionsCommand extends $Command< DescribeLaunchTemplateVersionsCommandInput, diff --git a/clients/client-ec2/commands/DescribeLaunchTemplatesCommand.ts b/clients/client-ec2/commands/DescribeLaunchTemplatesCommand.ts index 867ef79f2339..9cb127710fed 100644 --- a/clients/client-ec2/commands/DescribeLaunchTemplatesCommand.ts +++ b/clients/client-ec2/commands/DescribeLaunchTemplatesCommand.ts @@ -22,6 +22,20 @@ export interface DescribeLaunchTemplatesCommandOutput extends DescribeLaunchTemp /** *

Describes one or more launch templates.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { EC2Client, DescribeLaunchTemplatesCommand } from "@aws-sdk/client-ec2"; // ES Modules import + * // const { EC2Client, DescribeLaunchTemplatesCommand } = require("@aws-sdk/client-ec2"); // CommonJS import + * const client = new EC2Client(config); + * const command = new DescribeLaunchTemplatesCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeLaunchTemplatesCommandInput} for command's `input` shape. + * @see {@link DescribeLaunchTemplatesCommandOutput} for command's `response` shape. + * @see {@link EC2ClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeLaunchTemplatesCommand extends $Command< DescribeLaunchTemplatesCommandInput, diff --git a/clients/client-ec2/commands/DescribeLocalGatewayRouteTableVirtualInterfaceGroupAssociationsCommand.ts b/clients/client-ec2/commands/DescribeLocalGatewayRouteTableVirtualInterfaceGroupAssociationsCommand.ts index f9ee18f6669e..90bf5a906aeb 100644 --- a/clients/client-ec2/commands/DescribeLocalGatewayRouteTableVirtualInterfaceGroupAssociationsCommand.ts +++ b/clients/client-ec2/commands/DescribeLocalGatewayRouteTableVirtualInterfaceGroupAssociationsCommand.ts @@ -28,6 +28,20 @@ export interface DescribeLocalGatewayRouteTableVirtualInterfaceGroupAssociations /** *

Describes the associations between virtual interface groups and local gateway route tables.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { EC2Client, DescribeLocalGatewayRouteTableVirtualInterfaceGroupAssociationsCommand } from "@aws-sdk/client-ec2"; // ES Modules import + * // const { EC2Client, DescribeLocalGatewayRouteTableVirtualInterfaceGroupAssociationsCommand } = require("@aws-sdk/client-ec2"); // CommonJS import + * const client = new EC2Client(config); + * const command = new DescribeLocalGatewayRouteTableVirtualInterfaceGroupAssociationsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeLocalGatewayRouteTableVirtualInterfaceGroupAssociationsCommandInput} for command's `input` shape. + * @see {@link DescribeLocalGatewayRouteTableVirtualInterfaceGroupAssociationsCommandOutput} for command's `response` shape. + * @see {@link EC2ClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeLocalGatewayRouteTableVirtualInterfaceGroupAssociationsCommand extends $Command< DescribeLocalGatewayRouteTableVirtualInterfaceGroupAssociationsCommandInput, diff --git a/clients/client-ec2/commands/DescribeLocalGatewayRouteTableVpcAssociationsCommand.ts b/clients/client-ec2/commands/DescribeLocalGatewayRouteTableVpcAssociationsCommand.ts index b025aa9fd8b3..8e93eb65080b 100644 --- a/clients/client-ec2/commands/DescribeLocalGatewayRouteTableVpcAssociationsCommand.ts +++ b/clients/client-ec2/commands/DescribeLocalGatewayRouteTableVpcAssociationsCommand.ts @@ -28,6 +28,20 @@ export interface DescribeLocalGatewayRouteTableVpcAssociationsCommandOutput /** *

Describes the specified associations between VPCs and local gateway route tables.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { EC2Client, DescribeLocalGatewayRouteTableVpcAssociationsCommand } from "@aws-sdk/client-ec2"; // ES Modules import + * // const { EC2Client, DescribeLocalGatewayRouteTableVpcAssociationsCommand } = require("@aws-sdk/client-ec2"); // CommonJS import + * const client = new EC2Client(config); + * const command = new DescribeLocalGatewayRouteTableVpcAssociationsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeLocalGatewayRouteTableVpcAssociationsCommandInput} for command's `input` shape. + * @see {@link DescribeLocalGatewayRouteTableVpcAssociationsCommandOutput} for command's `response` shape. + * @see {@link EC2ClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeLocalGatewayRouteTableVpcAssociationsCommand extends $Command< DescribeLocalGatewayRouteTableVpcAssociationsCommandInput, diff --git a/clients/client-ec2/commands/DescribeLocalGatewayRouteTablesCommand.ts b/clients/client-ec2/commands/DescribeLocalGatewayRouteTablesCommand.ts index dc7ee67a3244..441b73ae0ee4 100644 --- a/clients/client-ec2/commands/DescribeLocalGatewayRouteTablesCommand.ts +++ b/clients/client-ec2/commands/DescribeLocalGatewayRouteTablesCommand.ts @@ -25,6 +25,20 @@ export interface DescribeLocalGatewayRouteTablesCommandOutput /** *

Describes one or more local gateway route tables. By default, all local gateway route tables are described. * Alternatively, you can filter the results.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { EC2Client, DescribeLocalGatewayRouteTablesCommand } from "@aws-sdk/client-ec2"; // ES Modules import + * // const { EC2Client, DescribeLocalGatewayRouteTablesCommand } = require("@aws-sdk/client-ec2"); // CommonJS import + * const client = new EC2Client(config); + * const command = new DescribeLocalGatewayRouteTablesCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeLocalGatewayRouteTablesCommandInput} for command's `input` shape. + * @see {@link DescribeLocalGatewayRouteTablesCommandOutput} for command's `response` shape. + * @see {@link EC2ClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeLocalGatewayRouteTablesCommand extends $Command< DescribeLocalGatewayRouteTablesCommandInput, diff --git a/clients/client-ec2/commands/DescribeLocalGatewayVirtualInterfaceGroupsCommand.ts b/clients/client-ec2/commands/DescribeLocalGatewayVirtualInterfaceGroupsCommand.ts index cbdf36055711..319dc79890ee 100644 --- a/clients/client-ec2/commands/DescribeLocalGatewayVirtualInterfaceGroupsCommand.ts +++ b/clients/client-ec2/commands/DescribeLocalGatewayVirtualInterfaceGroupsCommand.ts @@ -28,6 +28,20 @@ export interface DescribeLocalGatewayVirtualInterfaceGroupsCommandOutput /** *

Describes the specified local gateway virtual interface groups.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { EC2Client, DescribeLocalGatewayVirtualInterfaceGroupsCommand } from "@aws-sdk/client-ec2"; // ES Modules import + * // const { EC2Client, DescribeLocalGatewayVirtualInterfaceGroupsCommand } = require("@aws-sdk/client-ec2"); // CommonJS import + * const client = new EC2Client(config); + * const command = new DescribeLocalGatewayVirtualInterfaceGroupsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeLocalGatewayVirtualInterfaceGroupsCommandInput} for command's `input` shape. + * @see {@link DescribeLocalGatewayVirtualInterfaceGroupsCommandOutput} for command's `response` shape. + * @see {@link EC2ClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeLocalGatewayVirtualInterfaceGroupsCommand extends $Command< DescribeLocalGatewayVirtualInterfaceGroupsCommandInput, diff --git a/clients/client-ec2/commands/DescribeLocalGatewayVirtualInterfacesCommand.ts b/clients/client-ec2/commands/DescribeLocalGatewayVirtualInterfacesCommand.ts index e1d45617295c..7e88dc1aa3d4 100644 --- a/clients/client-ec2/commands/DescribeLocalGatewayVirtualInterfacesCommand.ts +++ b/clients/client-ec2/commands/DescribeLocalGatewayVirtualInterfacesCommand.ts @@ -28,6 +28,20 @@ export interface DescribeLocalGatewayVirtualInterfacesCommandOutput /** *

Describes the specified local gateway virtual interfaces.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { EC2Client, DescribeLocalGatewayVirtualInterfacesCommand } from "@aws-sdk/client-ec2"; // ES Modules import + * // const { EC2Client, DescribeLocalGatewayVirtualInterfacesCommand } = require("@aws-sdk/client-ec2"); // CommonJS import + * const client = new EC2Client(config); + * const command = new DescribeLocalGatewayVirtualInterfacesCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeLocalGatewayVirtualInterfacesCommandInput} for command's `input` shape. + * @see {@link DescribeLocalGatewayVirtualInterfacesCommandOutput} for command's `response` shape. + * @see {@link EC2ClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeLocalGatewayVirtualInterfacesCommand extends $Command< DescribeLocalGatewayVirtualInterfacesCommandInput, diff --git a/clients/client-ec2/commands/DescribeLocalGatewaysCommand.ts b/clients/client-ec2/commands/DescribeLocalGatewaysCommand.ts index 431aea1e63b6..faedb5cc964e 100644 --- a/clients/client-ec2/commands/DescribeLocalGatewaysCommand.ts +++ b/clients/client-ec2/commands/DescribeLocalGatewaysCommand.ts @@ -23,6 +23,20 @@ export interface DescribeLocalGatewaysCommandOutput extends DescribeLocalGateway /** *

Describes one or more local gateways. By default, all local gateways are described. * Alternatively, you can filter the results.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { EC2Client, DescribeLocalGatewaysCommand } from "@aws-sdk/client-ec2"; // ES Modules import + * // const { EC2Client, DescribeLocalGatewaysCommand } = require("@aws-sdk/client-ec2"); // CommonJS import + * const client = new EC2Client(config); + * const command = new DescribeLocalGatewaysCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeLocalGatewaysCommandInput} for command's `input` shape. + * @see {@link DescribeLocalGatewaysCommandOutput} for command's `response` shape. + * @see {@link EC2ClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeLocalGatewaysCommand extends $Command< DescribeLocalGatewaysCommandInput, diff --git a/clients/client-ec2/commands/DescribeManagedPrefixListsCommand.ts b/clients/client-ec2/commands/DescribeManagedPrefixListsCommand.ts index 368be4d59497..804e0fb75b5b 100644 --- a/clients/client-ec2/commands/DescribeManagedPrefixListsCommand.ts +++ b/clients/client-ec2/commands/DescribeManagedPrefixListsCommand.ts @@ -23,6 +23,20 @@ export interface DescribeManagedPrefixListsCommandOutput extends DescribeManaged /** *

Describes your managed prefix lists and any AWS-managed prefix lists.

*

To view the entries for your prefix list, use GetManagedPrefixListEntries.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { EC2Client, DescribeManagedPrefixListsCommand } from "@aws-sdk/client-ec2"; // ES Modules import + * // const { EC2Client, DescribeManagedPrefixListsCommand } = require("@aws-sdk/client-ec2"); // CommonJS import + * const client = new EC2Client(config); + * const command = new DescribeManagedPrefixListsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeManagedPrefixListsCommandInput} for command's `input` shape. + * @see {@link DescribeManagedPrefixListsCommandOutput} for command's `response` shape. + * @see {@link EC2ClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeManagedPrefixListsCommand extends $Command< DescribeManagedPrefixListsCommandInput, diff --git a/clients/client-ec2/commands/DescribeMovingAddressesCommand.ts b/clients/client-ec2/commands/DescribeMovingAddressesCommand.ts index f9ecb6251ed1..ebe917e05e39 100644 --- a/clients/client-ec2/commands/DescribeMovingAddressesCommand.ts +++ b/clients/client-ec2/commands/DescribeMovingAddressesCommand.ts @@ -22,6 +22,20 @@ export interface DescribeMovingAddressesCommandOutput extends DescribeMovingAddr /** *

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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { EC2Client, DescribeMovingAddressesCommand } from "@aws-sdk/client-ec2"; // ES Modules import + * // const { EC2Client, DescribeMovingAddressesCommand } = require("@aws-sdk/client-ec2"); // CommonJS import + * const client = new EC2Client(config); + * const command = new DescribeMovingAddressesCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeMovingAddressesCommandInput} for command's `input` shape. + * @see {@link DescribeMovingAddressesCommandOutput} for command's `response` shape. + * @see {@link EC2ClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeMovingAddressesCommand extends $Command< DescribeMovingAddressesCommandInput, diff --git a/clients/client-ec2/commands/DescribeNatGatewaysCommand.ts b/clients/client-ec2/commands/DescribeNatGatewaysCommand.ts index 5c119ff60156..b2e469d7b844 100644 --- a/clients/client-ec2/commands/DescribeNatGatewaysCommand.ts +++ b/clients/client-ec2/commands/DescribeNatGatewaysCommand.ts @@ -22,6 +22,20 @@ export interface DescribeNatGatewaysCommandOutput extends DescribeNatGatewaysRes /** *

Describes one or more of your NAT gateways.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { EC2Client, DescribeNatGatewaysCommand } from "@aws-sdk/client-ec2"; // ES Modules import + * // const { EC2Client, DescribeNatGatewaysCommand } = require("@aws-sdk/client-ec2"); // CommonJS import + * const client = new EC2Client(config); + * const command = new DescribeNatGatewaysCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeNatGatewaysCommandInput} for command's `input` shape. + * @see {@link DescribeNatGatewaysCommandOutput} for command's `response` shape. + * @see {@link EC2ClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeNatGatewaysCommand extends $Command< DescribeNatGatewaysCommandInput, diff --git a/clients/client-ec2/commands/DescribeNetworkAclsCommand.ts b/clients/client-ec2/commands/DescribeNetworkAclsCommand.ts index bb67a5fe724e..6f31aafd0893 100644 --- a/clients/client-ec2/commands/DescribeNetworkAclsCommand.ts +++ b/clients/client-ec2/commands/DescribeNetworkAclsCommand.ts @@ -24,6 +24,20 @@ export interface DescribeNetworkAclsCommandOutput extends DescribeNetworkAclsRes *

Describes one or more of your network ACLs.

*

For more information, see Network ACLs in the * Amazon Virtual Private Cloud User Guide.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { EC2Client, DescribeNetworkAclsCommand } from "@aws-sdk/client-ec2"; // ES Modules import + * // const { EC2Client, DescribeNetworkAclsCommand } = require("@aws-sdk/client-ec2"); // CommonJS import + * const client = new EC2Client(config); + * const command = new DescribeNetworkAclsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeNetworkAclsCommandInput} for command's `input` shape. + * @see {@link DescribeNetworkAclsCommandOutput} for command's `response` shape. + * @see {@link EC2ClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeNetworkAclsCommand extends $Command< DescribeNetworkAclsCommandInput, diff --git a/clients/client-ec2/commands/DescribeNetworkInsightsAnalysesCommand.ts b/clients/client-ec2/commands/DescribeNetworkInsightsAnalysesCommand.ts index fb073ffa3c41..375394f2db94 100644 --- a/clients/client-ec2/commands/DescribeNetworkInsightsAnalysesCommand.ts +++ b/clients/client-ec2/commands/DescribeNetworkInsightsAnalysesCommand.ts @@ -24,6 +24,20 @@ export interface DescribeNetworkInsightsAnalysesCommandOutput /** *

Describes one or more of your network insights analyses.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { EC2Client, DescribeNetworkInsightsAnalysesCommand } from "@aws-sdk/client-ec2"; // ES Modules import + * // const { EC2Client, DescribeNetworkInsightsAnalysesCommand } = require("@aws-sdk/client-ec2"); // CommonJS import + * const client = new EC2Client(config); + * const command = new DescribeNetworkInsightsAnalysesCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeNetworkInsightsAnalysesCommandInput} for command's `input` shape. + * @see {@link DescribeNetworkInsightsAnalysesCommandOutput} for command's `response` shape. + * @see {@link EC2ClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeNetworkInsightsAnalysesCommand extends $Command< DescribeNetworkInsightsAnalysesCommandInput, diff --git a/clients/client-ec2/commands/DescribeNetworkInsightsPathsCommand.ts b/clients/client-ec2/commands/DescribeNetworkInsightsPathsCommand.ts index 9eaae8e98f24..492f53daf9dd 100644 --- a/clients/client-ec2/commands/DescribeNetworkInsightsPathsCommand.ts +++ b/clients/client-ec2/commands/DescribeNetworkInsightsPathsCommand.ts @@ -24,6 +24,20 @@ export interface DescribeNetworkInsightsPathsCommandOutput /** *

Describes one or more of your paths.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { EC2Client, DescribeNetworkInsightsPathsCommand } from "@aws-sdk/client-ec2"; // ES Modules import + * // const { EC2Client, DescribeNetworkInsightsPathsCommand } = require("@aws-sdk/client-ec2"); // CommonJS import + * const client = new EC2Client(config); + * const command = new DescribeNetworkInsightsPathsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeNetworkInsightsPathsCommandInput} for command's `input` shape. + * @see {@link DescribeNetworkInsightsPathsCommandOutput} for command's `response` shape. + * @see {@link EC2ClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeNetworkInsightsPathsCommand extends $Command< DescribeNetworkInsightsPathsCommandInput, diff --git a/clients/client-ec2/commands/DescribeNetworkInterfaceAttributeCommand.ts b/clients/client-ec2/commands/DescribeNetworkInterfaceAttributeCommand.ts index 0b868deaf0d5..770ff3d15c71 100644 --- a/clients/client-ec2/commands/DescribeNetworkInterfaceAttributeCommand.ts +++ b/clients/client-ec2/commands/DescribeNetworkInterfaceAttributeCommand.ts @@ -24,6 +24,20 @@ export interface DescribeNetworkInterfaceAttributeCommandOutput /** *

Describes a network interface attribute. You can specify only one attribute at a time.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { EC2Client, DescribeNetworkInterfaceAttributeCommand } from "@aws-sdk/client-ec2"; // ES Modules import + * // const { EC2Client, DescribeNetworkInterfaceAttributeCommand } = require("@aws-sdk/client-ec2"); // CommonJS import + * const client = new EC2Client(config); + * const command = new DescribeNetworkInterfaceAttributeCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeNetworkInterfaceAttributeCommandInput} for command's `input` shape. + * @see {@link DescribeNetworkInterfaceAttributeCommandOutput} for command's `response` shape. + * @see {@link EC2ClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeNetworkInterfaceAttributeCommand extends $Command< DescribeNetworkInterfaceAttributeCommandInput, diff --git a/clients/client-ec2/commands/DescribeNetworkInterfacePermissionsCommand.ts b/clients/client-ec2/commands/DescribeNetworkInterfacePermissionsCommand.ts index 34c882753d1e..336ebd4db689 100644 --- a/clients/client-ec2/commands/DescribeNetworkInterfacePermissionsCommand.ts +++ b/clients/client-ec2/commands/DescribeNetworkInterfacePermissionsCommand.ts @@ -27,6 +27,20 @@ export interface DescribeNetworkInterfacePermissionsCommandOutput /** *

Describes the permissions for your network interfaces.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { EC2Client, DescribeNetworkInterfacePermissionsCommand } from "@aws-sdk/client-ec2"; // ES Modules import + * // const { EC2Client, DescribeNetworkInterfacePermissionsCommand } = require("@aws-sdk/client-ec2"); // CommonJS import + * const client = new EC2Client(config); + * const command = new DescribeNetworkInterfacePermissionsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeNetworkInterfacePermissionsCommandInput} for command's `input` shape. + * @see {@link DescribeNetworkInterfacePermissionsCommandOutput} for command's `response` shape. + * @see {@link EC2ClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeNetworkInterfacePermissionsCommand extends $Command< DescribeNetworkInterfacePermissionsCommandInput, diff --git a/clients/client-ec2/commands/DescribeNetworkInterfacesCommand.ts b/clients/client-ec2/commands/DescribeNetworkInterfacesCommand.ts index 002211f0417a..827ed23cf517 100644 --- a/clients/client-ec2/commands/DescribeNetworkInterfacesCommand.ts +++ b/clients/client-ec2/commands/DescribeNetworkInterfacesCommand.ts @@ -22,6 +22,20 @@ export interface DescribeNetworkInterfacesCommandOutput extends DescribeNetworkI /** *

Describes one or more of your network interfaces.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { EC2Client, DescribeNetworkInterfacesCommand } from "@aws-sdk/client-ec2"; // ES Modules import + * // const { EC2Client, DescribeNetworkInterfacesCommand } = require("@aws-sdk/client-ec2"); // CommonJS import + * const client = new EC2Client(config); + * const command = new DescribeNetworkInterfacesCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeNetworkInterfacesCommandInput} for command's `input` shape. + * @see {@link DescribeNetworkInterfacesCommandOutput} for command's `response` shape. + * @see {@link EC2ClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeNetworkInterfacesCommand extends $Command< DescribeNetworkInterfacesCommandInput, diff --git a/clients/client-ec2/commands/DescribePlacementGroupsCommand.ts b/clients/client-ec2/commands/DescribePlacementGroupsCommand.ts index f05f58d89300..c0e863dea6bf 100644 --- a/clients/client-ec2/commands/DescribePlacementGroupsCommand.ts +++ b/clients/client-ec2/commands/DescribePlacementGroupsCommand.ts @@ -24,6 +24,20 @@ export interface DescribePlacementGroupsCommandOutput extends DescribePlacementG *

Describes the specified placement groups or all of your placement groups. For more * information, see Placement groups in the * Amazon EC2 User Guide.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { EC2Client, DescribePlacementGroupsCommand } from "@aws-sdk/client-ec2"; // ES Modules import + * // const { EC2Client, DescribePlacementGroupsCommand } = require("@aws-sdk/client-ec2"); // CommonJS import + * const client = new EC2Client(config); + * const command = new DescribePlacementGroupsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribePlacementGroupsCommandInput} for command's `input` shape. + * @see {@link DescribePlacementGroupsCommandOutput} for command's `response` shape. + * @see {@link EC2ClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribePlacementGroupsCommand extends $Command< DescribePlacementGroupsCommandInput, diff --git a/clients/client-ec2/commands/DescribePrefixListsCommand.ts b/clients/client-ec2/commands/DescribePrefixListsCommand.ts index f2e068777c08..c4593d47c85a 100644 --- a/clients/client-ec2/commands/DescribePrefixListsCommand.ts +++ b/clients/client-ec2/commands/DescribePrefixListsCommand.ts @@ -24,6 +24,20 @@ export interface DescribePrefixListsCommandOutput extends DescribePrefixListsRes *

Describes available AWS 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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { EC2Client, DescribePrefixListsCommand } from "@aws-sdk/client-ec2"; // ES Modules import + * // const { EC2Client, DescribePrefixListsCommand } = require("@aws-sdk/client-ec2"); // CommonJS import + * const client = new EC2Client(config); + * const command = new DescribePrefixListsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribePrefixListsCommandInput} for command's `input` shape. + * @see {@link DescribePrefixListsCommandOutput} for command's `response` shape. + * @see {@link EC2ClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribePrefixListsCommand extends $Command< DescribePrefixListsCommandInput, diff --git a/clients/client-ec2/commands/DescribePrincipalIdFormatCommand.ts b/clients/client-ec2/commands/DescribePrincipalIdFormatCommand.ts index 5603bfe29f8f..6b0828938acd 100644 --- a/clients/client-ec2/commands/DescribePrincipalIdFormatCommand.ts +++ b/clients/client-ec2/commands/DescribePrincipalIdFormatCommand.ts @@ -39,6 +39,20 @@ export interface DescribePrincipalIdFormatCommandOutput extends DescribePrincipa * subnet-cidr-block-association | volume | vpc * | vpc-cidr-block-association | vpc-endpoint | * vpc-peering-connection | vpn-connection | vpn-gateway.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { EC2Client, DescribePrincipalIdFormatCommand } from "@aws-sdk/client-ec2"; // ES Modules import + * // const { EC2Client, DescribePrincipalIdFormatCommand } = require("@aws-sdk/client-ec2"); // CommonJS import + * const client = new EC2Client(config); + * const command = new DescribePrincipalIdFormatCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribePrincipalIdFormatCommandInput} for command's `input` shape. + * @see {@link DescribePrincipalIdFormatCommandOutput} for command's `response` shape. + * @see {@link EC2ClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribePrincipalIdFormatCommand extends $Command< DescribePrincipalIdFormatCommandInput, diff --git a/clients/client-ec2/commands/DescribePublicIpv4PoolsCommand.ts b/clients/client-ec2/commands/DescribePublicIpv4PoolsCommand.ts index ac78fe3333a2..1fc09eef3e75 100644 --- a/clients/client-ec2/commands/DescribePublicIpv4PoolsCommand.ts +++ b/clients/client-ec2/commands/DescribePublicIpv4PoolsCommand.ts @@ -22,6 +22,20 @@ export interface DescribePublicIpv4PoolsCommandOutput extends DescribePublicIpv4 /** *

Describes the specified IPv4 address pools.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { EC2Client, DescribePublicIpv4PoolsCommand } from "@aws-sdk/client-ec2"; // ES Modules import + * // const { EC2Client, DescribePublicIpv4PoolsCommand } = require("@aws-sdk/client-ec2"); // CommonJS import + * const client = new EC2Client(config); + * const command = new DescribePublicIpv4PoolsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribePublicIpv4PoolsCommandInput} for command's `input` shape. + * @see {@link DescribePublicIpv4PoolsCommandOutput} for command's `response` shape. + * @see {@link EC2ClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribePublicIpv4PoolsCommand extends $Command< DescribePublicIpv4PoolsCommandInput, diff --git a/clients/client-ec2/commands/DescribeRegionsCommand.ts b/clients/client-ec2/commands/DescribeRegionsCommand.ts index c9018a7b2d7f..925c8e4204c0 100644 --- a/clients/client-ec2/commands/DescribeRegionsCommand.ts +++ b/clients/client-ec2/commands/DescribeRegionsCommand.ts @@ -22,6 +22,20 @@ export interface DescribeRegionsCommandOutput extends DescribeRegionsResult, __M *

For a list of the Regions supported by Amazon EC2, see * Regions and Endpoints.

*

For information about enabling and disabling Regions for your account, see Managing AWS Regions in the AWS General Reference.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { EC2Client, DescribeRegionsCommand } from "@aws-sdk/client-ec2"; // ES Modules import + * // const { EC2Client, DescribeRegionsCommand } = require("@aws-sdk/client-ec2"); // CommonJS import + * const client = new EC2Client(config); + * const command = new DescribeRegionsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeRegionsCommandInput} for command's `input` shape. + * @see {@link DescribeRegionsCommandOutput} for command's `response` shape. + * @see {@link EC2ClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeRegionsCommand extends $Command< DescribeRegionsCommandInput, diff --git a/clients/client-ec2/commands/DescribeReplaceRootVolumeTasksCommand.ts b/clients/client-ec2/commands/DescribeReplaceRootVolumeTasksCommand.ts index 4dcc4882b2b0..549758bf915c 100644 --- a/clients/client-ec2/commands/DescribeReplaceRootVolumeTasksCommand.ts +++ b/clients/client-ec2/commands/DescribeReplaceRootVolumeTasksCommand.ts @@ -26,6 +26,20 @@ export interface DescribeReplaceRootVolumeTasksCommandOutput *

Describes a root volume replacement task. For more information, see * Replace a root volume in the * Amazon Elastic Compute Cloud User Guide.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { EC2Client, DescribeReplaceRootVolumeTasksCommand } from "@aws-sdk/client-ec2"; // ES Modules import + * // const { EC2Client, DescribeReplaceRootVolumeTasksCommand } = require("@aws-sdk/client-ec2"); // CommonJS import + * const client = new EC2Client(config); + * const command = new DescribeReplaceRootVolumeTasksCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeReplaceRootVolumeTasksCommandInput} for command's `input` shape. + * @see {@link DescribeReplaceRootVolumeTasksCommandOutput} for command's `response` shape. + * @see {@link EC2ClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeReplaceRootVolumeTasksCommand extends $Command< DescribeReplaceRootVolumeTasksCommandInput, diff --git a/clients/client-ec2/commands/DescribeReservedInstancesCommand.ts b/clients/client-ec2/commands/DescribeReservedInstancesCommand.ts index 37ac35ba9569..f6627de43d3d 100644 --- a/clients/client-ec2/commands/DescribeReservedInstancesCommand.ts +++ b/clients/client-ec2/commands/DescribeReservedInstancesCommand.ts @@ -24,6 +24,20 @@ export interface DescribeReservedInstancesCommandOutput extends DescribeReserved *

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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { EC2Client, DescribeReservedInstancesCommand } from "@aws-sdk/client-ec2"; // ES Modules import + * // const { EC2Client, DescribeReservedInstancesCommand } = require("@aws-sdk/client-ec2"); // CommonJS import + * const client = new EC2Client(config); + * const command = new DescribeReservedInstancesCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeReservedInstancesCommandInput} for command's `input` shape. + * @see {@link DescribeReservedInstancesCommandOutput} for command's `response` shape. + * @see {@link EC2ClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeReservedInstancesCommand extends $Command< DescribeReservedInstancesCommandInput, diff --git a/clients/client-ec2/commands/DescribeReservedInstancesListingsCommand.ts b/clients/client-ec2/commands/DescribeReservedInstancesListingsCommand.ts index 1491ffb56baa..acd9792c715b 100644 --- a/clients/client-ec2/commands/DescribeReservedInstancesListingsCommand.ts +++ b/clients/client-ec2/commands/DescribeReservedInstancesListingsCommand.ts @@ -29,6 +29,20 @@ export interface DescribeReservedInstancesListingsCommandOutput *

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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { EC2Client, DescribeReservedInstancesListingsCommand } from "@aws-sdk/client-ec2"; // ES Modules import + * // const { EC2Client, DescribeReservedInstancesListingsCommand } = require("@aws-sdk/client-ec2"); // CommonJS import + * const client = new EC2Client(config); + * const command = new DescribeReservedInstancesListingsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeReservedInstancesListingsCommandInput} for command's `input` shape. + * @see {@link DescribeReservedInstancesListingsCommandOutput} for command's `response` shape. + * @see {@link EC2ClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeReservedInstancesListingsCommand extends $Command< DescribeReservedInstancesListingsCommandInput, diff --git a/clients/client-ec2/commands/DescribeReservedInstancesModificationsCommand.ts b/clients/client-ec2/commands/DescribeReservedInstancesModificationsCommand.ts index 671fdfac3463..c87a25e86cb0 100644 --- a/clients/client-ec2/commands/DescribeReservedInstancesModificationsCommand.ts +++ b/clients/client-ec2/commands/DescribeReservedInstancesModificationsCommand.ts @@ -29,6 +29,20 @@ export interface DescribeReservedInstancesModificationsCommandOutput /** *

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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { EC2Client, DescribeReservedInstancesModificationsCommand } from "@aws-sdk/client-ec2"; // ES Modules import + * // const { EC2Client, DescribeReservedInstancesModificationsCommand } = require("@aws-sdk/client-ec2"); // CommonJS import + * const client = new EC2Client(config); + * const command = new DescribeReservedInstancesModificationsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeReservedInstancesModificationsCommandInput} for command's `input` shape. + * @see {@link DescribeReservedInstancesModificationsCommandOutput} for command's `response` shape. + * @see {@link EC2ClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeReservedInstancesModificationsCommand extends $Command< DescribeReservedInstancesModificationsCommandInput, diff --git a/clients/client-ec2/commands/DescribeReservedInstancesOfferingsCommand.ts b/clients/client-ec2/commands/DescribeReservedInstancesOfferingsCommand.ts index a358440ecac0..a6ab76ad5c43 100644 --- a/clients/client-ec2/commands/DescribeReservedInstancesOfferingsCommand.ts +++ b/clients/client-ec2/commands/DescribeReservedInstancesOfferingsCommand.ts @@ -30,6 +30,20 @@ export interface DescribeReservedInstancesOfferingsCommandOutput *

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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { EC2Client, DescribeReservedInstancesOfferingsCommand } from "@aws-sdk/client-ec2"; // ES Modules import + * // const { EC2Client, DescribeReservedInstancesOfferingsCommand } = require("@aws-sdk/client-ec2"); // CommonJS import + * const client = new EC2Client(config); + * const command = new DescribeReservedInstancesOfferingsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeReservedInstancesOfferingsCommandInput} for command's `input` shape. + * @see {@link DescribeReservedInstancesOfferingsCommandOutput} for command's `response` shape. + * @see {@link EC2ClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeReservedInstancesOfferingsCommand extends $Command< DescribeReservedInstancesOfferingsCommandInput, diff --git a/clients/client-ec2/commands/DescribeRouteTablesCommand.ts b/clients/client-ec2/commands/DescribeRouteTablesCommand.ts index d24c69d69b09..b97d579fce13 100644 --- a/clients/client-ec2/commands/DescribeRouteTablesCommand.ts +++ b/clients/client-ec2/commands/DescribeRouteTablesCommand.ts @@ -25,6 +25,20 @@ export interface DescribeRouteTablesCommandOutput extends DescribeRouteTablesRes *

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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { EC2Client, DescribeRouteTablesCommand } from "@aws-sdk/client-ec2"; // ES Modules import + * // const { EC2Client, DescribeRouteTablesCommand } = require("@aws-sdk/client-ec2"); // CommonJS import + * const client = new EC2Client(config); + * const command = new DescribeRouteTablesCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeRouteTablesCommandInput} for command's `input` shape. + * @see {@link DescribeRouteTablesCommandOutput} for command's `response` shape. + * @see {@link EC2ClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeRouteTablesCommand extends $Command< DescribeRouteTablesCommandInput, diff --git a/clients/client-ec2/commands/DescribeScheduledInstanceAvailabilityCommand.ts b/clients/client-ec2/commands/DescribeScheduledInstanceAvailabilityCommand.ts index 82e863aaf679..eb150d0ae485 100644 --- a/clients/client-ec2/commands/DescribeScheduledInstanceAvailabilityCommand.ts +++ b/clients/client-ec2/commands/DescribeScheduledInstanceAvailabilityCommand.ts @@ -31,6 +31,20 @@ export interface DescribeScheduledInstanceAvailabilityCommandOutput *

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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { EC2Client, DescribeScheduledInstanceAvailabilityCommand } from "@aws-sdk/client-ec2"; // ES Modules import + * // const { EC2Client, DescribeScheduledInstanceAvailabilityCommand } = require("@aws-sdk/client-ec2"); // CommonJS import + * const client = new EC2Client(config); + * const command = new DescribeScheduledInstanceAvailabilityCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeScheduledInstanceAvailabilityCommandInput} for command's `input` shape. + * @see {@link DescribeScheduledInstanceAvailabilityCommandOutput} for command's `response` shape. + * @see {@link EC2ClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeScheduledInstanceAvailabilityCommand extends $Command< DescribeScheduledInstanceAvailabilityCommandInput, diff --git a/clients/client-ec2/commands/DescribeScheduledInstancesCommand.ts b/clients/client-ec2/commands/DescribeScheduledInstancesCommand.ts index 66e85fd94155..19538ca9f7cd 100644 --- a/clients/client-ec2/commands/DescribeScheduledInstancesCommand.ts +++ b/clients/client-ec2/commands/DescribeScheduledInstancesCommand.ts @@ -22,6 +22,20 @@ export interface DescribeScheduledInstancesCommandOutput extends DescribeSchedul /** *

Describes the specified Scheduled Instances or all your Scheduled Instances.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { EC2Client, DescribeScheduledInstancesCommand } from "@aws-sdk/client-ec2"; // ES Modules import + * // const { EC2Client, DescribeScheduledInstancesCommand } = require("@aws-sdk/client-ec2"); // CommonJS import + * const client = new EC2Client(config); + * const command = new DescribeScheduledInstancesCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeScheduledInstancesCommandInput} for command's `input` shape. + * @see {@link DescribeScheduledInstancesCommandOutput} for command's `response` shape. + * @see {@link EC2ClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeScheduledInstancesCommand extends $Command< DescribeScheduledInstancesCommandInput, diff --git a/clients/client-ec2/commands/DescribeSecurityGroupReferencesCommand.ts b/clients/client-ec2/commands/DescribeSecurityGroupReferencesCommand.ts index 77c69ecdcbdc..e6005a138386 100644 --- a/clients/client-ec2/commands/DescribeSecurityGroupReferencesCommand.ts +++ b/clients/client-ec2/commands/DescribeSecurityGroupReferencesCommand.ts @@ -24,6 +24,20 @@ export interface DescribeSecurityGroupReferencesCommandOutput /** *

[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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { EC2Client, DescribeSecurityGroupReferencesCommand } from "@aws-sdk/client-ec2"; // ES Modules import + * // const { EC2Client, DescribeSecurityGroupReferencesCommand } = require("@aws-sdk/client-ec2"); // CommonJS import + * const client = new EC2Client(config); + * const command = new DescribeSecurityGroupReferencesCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeSecurityGroupReferencesCommandInput} for command's `input` shape. + * @see {@link DescribeSecurityGroupReferencesCommandOutput} for command's `response` shape. + * @see {@link EC2ClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeSecurityGroupReferencesCommand extends $Command< DescribeSecurityGroupReferencesCommandInput, diff --git a/clients/client-ec2/commands/DescribeSecurityGroupsCommand.ts b/clients/client-ec2/commands/DescribeSecurityGroupsCommand.ts index cde79772f494..511b48103af9 100644 --- a/clients/client-ec2/commands/DescribeSecurityGroupsCommand.ts +++ b/clients/client-ec2/commands/DescribeSecurityGroupsCommand.ts @@ -28,6 +28,20 @@ export interface DescribeSecurityGroupsCommandOutput extends DescribeSecurityGro * the Amazon Elastic Compute Cloud User Guide and * Security Groups for Your VPC in the * Amazon Virtual Private Cloud User Guide.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { EC2Client, DescribeSecurityGroupsCommand } from "@aws-sdk/client-ec2"; // ES Modules import + * // const { EC2Client, DescribeSecurityGroupsCommand } = require("@aws-sdk/client-ec2"); // CommonJS import + * const client = new EC2Client(config); + * const command = new DescribeSecurityGroupsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeSecurityGroupsCommandInput} for command's `input` shape. + * @see {@link DescribeSecurityGroupsCommandOutput} for command's `response` shape. + * @see {@link EC2ClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeSecurityGroupsCommand extends $Command< DescribeSecurityGroupsCommandInput, diff --git a/clients/client-ec2/commands/DescribeSnapshotAttributeCommand.ts b/clients/client-ec2/commands/DescribeSnapshotAttributeCommand.ts index b31222036cd6..38e4bdc6009f 100644 --- a/clients/client-ec2/commands/DescribeSnapshotAttributeCommand.ts +++ b/clients/client-ec2/commands/DescribeSnapshotAttributeCommand.ts @@ -24,6 +24,20 @@ export interface DescribeSnapshotAttributeCommandOutput extends DescribeSnapshot *

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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { EC2Client, DescribeSnapshotAttributeCommand } from "@aws-sdk/client-ec2"; // ES Modules import + * // const { EC2Client, DescribeSnapshotAttributeCommand } = require("@aws-sdk/client-ec2"); // CommonJS import + * const client = new EC2Client(config); + * const command = new DescribeSnapshotAttributeCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeSnapshotAttributeCommandInput} for command's `input` shape. + * @see {@link DescribeSnapshotAttributeCommandOutput} for command's `response` shape. + * @see {@link EC2ClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeSnapshotAttributeCommand extends $Command< DescribeSnapshotAttributeCommandInput, diff --git a/clients/client-ec2/commands/DescribeSnapshotsCommand.ts b/clients/client-ec2/commands/DescribeSnapshotsCommand.ts index 60c1a4d65e63..d2461c7ace35 100644 --- a/clients/client-ec2/commands/DescribeSnapshotsCommand.ts +++ b/clients/client-ec2/commands/DescribeSnapshotsCommand.ts @@ -68,6 +68,20 @@ export interface DescribeSnapshotsCommandOutput extends DescribeSnapshotsResult, * results.

*

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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { EC2Client, DescribeSnapshotsCommand } from "@aws-sdk/client-ec2"; // ES Modules import + * // const { EC2Client, DescribeSnapshotsCommand } = require("@aws-sdk/client-ec2"); // CommonJS import + * const client = new EC2Client(config); + * const command = new DescribeSnapshotsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeSnapshotsCommandInput} for command's `input` shape. + * @see {@link DescribeSnapshotsCommandOutput} for command's `response` shape. + * @see {@link EC2ClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeSnapshotsCommand extends $Command< DescribeSnapshotsCommandInput, diff --git a/clients/client-ec2/commands/DescribeSpotDatafeedSubscriptionCommand.ts b/clients/client-ec2/commands/DescribeSpotDatafeedSubscriptionCommand.ts index fbdf66add39f..75d85f56dd11 100644 --- a/clients/client-ec2/commands/DescribeSpotDatafeedSubscriptionCommand.ts +++ b/clients/client-ec2/commands/DescribeSpotDatafeedSubscriptionCommand.ts @@ -25,6 +25,20 @@ export interface DescribeSpotDatafeedSubscriptionCommandOutput /** *

Describes the data feed for Spot Instances. For more information, see Spot * Instance data feed in the Amazon EC2 User Guide for Linux Instances.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { EC2Client, DescribeSpotDatafeedSubscriptionCommand } from "@aws-sdk/client-ec2"; // ES Modules import + * // const { EC2Client, DescribeSpotDatafeedSubscriptionCommand } = require("@aws-sdk/client-ec2"); // CommonJS import + * const client = new EC2Client(config); + * const command = new DescribeSpotDatafeedSubscriptionCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeSpotDatafeedSubscriptionCommandInput} for command's `input` shape. + * @see {@link DescribeSpotDatafeedSubscriptionCommandOutput} for command's `response` shape. + * @see {@link EC2ClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeSpotDatafeedSubscriptionCommand extends $Command< DescribeSpotDatafeedSubscriptionCommandInput, diff --git a/clients/client-ec2/commands/DescribeSpotFleetInstancesCommand.ts b/clients/client-ec2/commands/DescribeSpotFleetInstancesCommand.ts index 19d252957d1c..2b440c2d065d 100644 --- a/clients/client-ec2/commands/DescribeSpotFleetInstancesCommand.ts +++ b/clients/client-ec2/commands/DescribeSpotFleetInstancesCommand.ts @@ -22,6 +22,20 @@ export interface DescribeSpotFleetInstancesCommandOutput extends DescribeSpotFle /** *

Describes the running instances for the specified Spot Fleet.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { EC2Client, DescribeSpotFleetInstancesCommand } from "@aws-sdk/client-ec2"; // ES Modules import + * // const { EC2Client, DescribeSpotFleetInstancesCommand } = require("@aws-sdk/client-ec2"); // CommonJS import + * const client = new EC2Client(config); + * const command = new DescribeSpotFleetInstancesCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeSpotFleetInstancesCommandInput} for command's `input` shape. + * @see {@link DescribeSpotFleetInstancesCommandOutput} for command's `response` shape. + * @see {@link EC2ClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeSpotFleetInstancesCommand extends $Command< DescribeSpotFleetInstancesCommandInput, diff --git a/clients/client-ec2/commands/DescribeSpotFleetRequestHistoryCommand.ts b/clients/client-ec2/commands/DescribeSpotFleetRequestHistoryCommand.ts index ccf0aaba59c1..6d9e1630efb9 100644 --- a/clients/client-ec2/commands/DescribeSpotFleetRequestHistoryCommand.ts +++ b/clients/client-ec2/commands/DescribeSpotFleetRequestHistoryCommand.ts @@ -26,6 +26,20 @@ export interface DescribeSpotFleetRequestHistoryCommandOutput *

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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { EC2Client, DescribeSpotFleetRequestHistoryCommand } from "@aws-sdk/client-ec2"; // ES Modules import + * // const { EC2Client, DescribeSpotFleetRequestHistoryCommand } = require("@aws-sdk/client-ec2"); // CommonJS import + * const client = new EC2Client(config); + * const command = new DescribeSpotFleetRequestHistoryCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeSpotFleetRequestHistoryCommandInput} for command's `input` shape. + * @see {@link DescribeSpotFleetRequestHistoryCommandOutput} for command's `response` shape. + * @see {@link EC2ClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeSpotFleetRequestHistoryCommand extends $Command< DescribeSpotFleetRequestHistoryCommandInput, diff --git a/clients/client-ec2/commands/DescribeSpotFleetRequestsCommand.ts b/clients/client-ec2/commands/DescribeSpotFleetRequestsCommand.ts index ec3102349c87..27c5393d8077 100644 --- a/clients/client-ec2/commands/DescribeSpotFleetRequestsCommand.ts +++ b/clients/client-ec2/commands/DescribeSpotFleetRequestsCommand.ts @@ -23,6 +23,20 @@ export interface DescribeSpotFleetRequestsCommandOutput extends DescribeSpotFlee /** *

Describes your Spot Fleet requests.

*

Spot Fleet requests are deleted 48 hours after they are canceled and their instances are terminated.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { EC2Client, DescribeSpotFleetRequestsCommand } from "@aws-sdk/client-ec2"; // ES Modules import + * // const { EC2Client, DescribeSpotFleetRequestsCommand } = require("@aws-sdk/client-ec2"); // CommonJS import + * const client = new EC2Client(config); + * const command = new DescribeSpotFleetRequestsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeSpotFleetRequestsCommandInput} for command's `input` shape. + * @see {@link DescribeSpotFleetRequestsCommandOutput} for command's `response` shape. + * @see {@link EC2ClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeSpotFleetRequestsCommand extends $Command< DescribeSpotFleetRequestsCommandInput, diff --git a/clients/client-ec2/commands/DescribeSpotInstanceRequestsCommand.ts b/clients/client-ec2/commands/DescribeSpotInstanceRequestsCommand.ts index 3bd23b02544e..b6a765a4e3e7 100644 --- a/clients/client-ec2/commands/DescribeSpotInstanceRequestsCommand.ts +++ b/clients/client-ec2/commands/DescribeSpotInstanceRequestsCommand.ts @@ -39,6 +39,20 @@ export interface DescribeSpotInstanceRequestsCommandOutput * results.

*

Spot Instance requests are deleted four hours after they are canceled and their instances * are terminated.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { EC2Client, DescribeSpotInstanceRequestsCommand } from "@aws-sdk/client-ec2"; // ES Modules import + * // const { EC2Client, DescribeSpotInstanceRequestsCommand } = require("@aws-sdk/client-ec2"); // CommonJS import + * const client = new EC2Client(config); + * const command = new DescribeSpotInstanceRequestsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeSpotInstanceRequestsCommandInput} for command's `input` shape. + * @see {@link DescribeSpotInstanceRequestsCommandOutput} for command's `response` shape. + * @see {@link EC2ClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeSpotInstanceRequestsCommand extends $Command< DescribeSpotInstanceRequestsCommandInput, diff --git a/clients/client-ec2/commands/DescribeSpotPriceHistoryCommand.ts b/clients/client-ec2/commands/DescribeSpotPriceHistoryCommand.ts index a3613d39c76a..be75cf941881 100644 --- a/clients/client-ec2/commands/DescribeSpotPriceHistoryCommand.ts +++ b/clients/client-ec2/commands/DescribeSpotPriceHistoryCommand.ts @@ -27,6 +27,20 @@ export interface DescribeSpotPriceHistoryCommandOutput extends DescribeSpotPrice *

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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { EC2Client, DescribeSpotPriceHistoryCommand } from "@aws-sdk/client-ec2"; // ES Modules import + * // const { EC2Client, DescribeSpotPriceHistoryCommand } = require("@aws-sdk/client-ec2"); // CommonJS import + * const client = new EC2Client(config); + * const command = new DescribeSpotPriceHistoryCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeSpotPriceHistoryCommandInput} for command's `input` shape. + * @see {@link DescribeSpotPriceHistoryCommandOutput} for command's `response` shape. + * @see {@link EC2ClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeSpotPriceHistoryCommand extends $Command< DescribeSpotPriceHistoryCommandInput, diff --git a/clients/client-ec2/commands/DescribeStaleSecurityGroupsCommand.ts b/clients/client-ec2/commands/DescribeStaleSecurityGroupsCommand.ts index 739dc2e37731..e1bbb378187f 100644 --- a/clients/client-ec2/commands/DescribeStaleSecurityGroupsCommand.ts +++ b/clients/client-ec2/commands/DescribeStaleSecurityGroupsCommand.ts @@ -22,6 +22,20 @@ export interface DescribeStaleSecurityGroupsCommandOutput extends DescribeStaleS /** *

[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 a peer VPC, or a security group in a peer VPC for which the VPC peering connection has been deleted.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { EC2Client, DescribeStaleSecurityGroupsCommand } from "@aws-sdk/client-ec2"; // ES Modules import + * // const { EC2Client, DescribeStaleSecurityGroupsCommand } = require("@aws-sdk/client-ec2"); // CommonJS import + * const client = new EC2Client(config); + * const command = new DescribeStaleSecurityGroupsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeStaleSecurityGroupsCommandInput} for command's `input` shape. + * @see {@link DescribeStaleSecurityGroupsCommandOutput} for command's `response` shape. + * @see {@link EC2ClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeStaleSecurityGroupsCommand extends $Command< DescribeStaleSecurityGroupsCommandInput, diff --git a/clients/client-ec2/commands/DescribeStoreImageTasksCommand.ts b/clients/client-ec2/commands/DescribeStoreImageTasksCommand.ts index b653feaddf00..519e16a21b9f 100644 --- a/clients/client-ec2/commands/DescribeStoreImageTasksCommand.ts +++ b/clients/client-ec2/commands/DescribeStoreImageTasksCommand.ts @@ -33,6 +33,20 @@ export interface DescribeStoreImageTasksCommandOutput extends DescribeStoreImage * Amazon Elastic Compute Cloud User Guide.

*

For more information, see Store and restore an AMI using * S3 in the Amazon Elastic Compute Cloud User Guide.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { EC2Client, DescribeStoreImageTasksCommand } from "@aws-sdk/client-ec2"; // ES Modules import + * // const { EC2Client, DescribeStoreImageTasksCommand } = require("@aws-sdk/client-ec2"); // CommonJS import + * const client = new EC2Client(config); + * const command = new DescribeStoreImageTasksCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeStoreImageTasksCommandInput} for command's `input` shape. + * @see {@link DescribeStoreImageTasksCommandOutput} for command's `response` shape. + * @see {@link EC2ClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeStoreImageTasksCommand extends $Command< DescribeStoreImageTasksCommandInput, diff --git a/clients/client-ec2/commands/DescribeSubnetsCommand.ts b/clients/client-ec2/commands/DescribeSubnetsCommand.ts index 30114305f6ae..0358df727b42 100644 --- a/clients/client-ec2/commands/DescribeSubnetsCommand.ts +++ b/clients/client-ec2/commands/DescribeSubnetsCommand.ts @@ -21,6 +21,20 @@ export interface DescribeSubnetsCommandOutput extends DescribeSubnetsResult, __M *

Describes one or more of your subnets.

*

For more information, see Your VPC and Subnets in the * Amazon Virtual Private Cloud User Guide.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { EC2Client, DescribeSubnetsCommand } from "@aws-sdk/client-ec2"; // ES Modules import + * // const { EC2Client, DescribeSubnetsCommand } = require("@aws-sdk/client-ec2"); // CommonJS import + * const client = new EC2Client(config); + * const command = new DescribeSubnetsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeSubnetsCommandInput} for command's `input` shape. + * @see {@link DescribeSubnetsCommandOutput} for command's `response` shape. + * @see {@link EC2ClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeSubnetsCommand extends $Command< DescribeSubnetsCommandInput, diff --git a/clients/client-ec2/commands/DescribeTagsCommand.ts b/clients/client-ec2/commands/DescribeTagsCommand.ts index 8ec4a86f231f..683b655f2e8c 100644 --- a/clients/client-ec2/commands/DescribeTagsCommand.ts +++ b/clients/client-ec2/commands/DescribeTagsCommand.ts @@ -21,6 +21,20 @@ export interface DescribeTagsCommandOutput extends DescribeTagsResult, __Metadat *

Describes the specified tags for your EC2 resources.

*

For more information about tags, see Tagging Your Resources in the * Amazon Elastic Compute Cloud User Guide.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { EC2Client, DescribeTagsCommand } from "@aws-sdk/client-ec2"; // ES Modules import + * // const { EC2Client, DescribeTagsCommand } = require("@aws-sdk/client-ec2"); // CommonJS import + * const client = new EC2Client(config); + * const command = new DescribeTagsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeTagsCommandInput} for command's `input` shape. + * @see {@link DescribeTagsCommandOutput} for command's `response` shape. + * @see {@link EC2ClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeTagsCommand extends $Command< DescribeTagsCommandInput, diff --git a/clients/client-ec2/commands/DescribeTrafficMirrorFiltersCommand.ts b/clients/client-ec2/commands/DescribeTrafficMirrorFiltersCommand.ts index a7d17894bbb6..54a0a65f5fb2 100644 --- a/clients/client-ec2/commands/DescribeTrafficMirrorFiltersCommand.ts +++ b/clients/client-ec2/commands/DescribeTrafficMirrorFiltersCommand.ts @@ -24,6 +24,20 @@ export interface DescribeTrafficMirrorFiltersCommandOutput /** *

Describes one or more Traffic Mirror filters.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { EC2Client, DescribeTrafficMirrorFiltersCommand } from "@aws-sdk/client-ec2"; // ES Modules import + * // const { EC2Client, DescribeTrafficMirrorFiltersCommand } = require("@aws-sdk/client-ec2"); // CommonJS import + * const client = new EC2Client(config); + * const command = new DescribeTrafficMirrorFiltersCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeTrafficMirrorFiltersCommandInput} for command's `input` shape. + * @see {@link DescribeTrafficMirrorFiltersCommandOutput} for command's `response` shape. + * @see {@link EC2ClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeTrafficMirrorFiltersCommand extends $Command< DescribeTrafficMirrorFiltersCommandInput, diff --git a/clients/client-ec2/commands/DescribeTrafficMirrorSessionsCommand.ts b/clients/client-ec2/commands/DescribeTrafficMirrorSessionsCommand.ts index 883bbf831fd1..af6a8eb038ba 100644 --- a/clients/client-ec2/commands/DescribeTrafficMirrorSessionsCommand.ts +++ b/clients/client-ec2/commands/DescribeTrafficMirrorSessionsCommand.ts @@ -24,6 +24,20 @@ export interface DescribeTrafficMirrorSessionsCommandOutput /** *

Describes one or more Traffic Mirror sessions. By default, all Traffic Mirror sessions are described. Alternatively, you can filter the results.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { EC2Client, DescribeTrafficMirrorSessionsCommand } from "@aws-sdk/client-ec2"; // ES Modules import + * // const { EC2Client, DescribeTrafficMirrorSessionsCommand } = require("@aws-sdk/client-ec2"); // CommonJS import + * const client = new EC2Client(config); + * const command = new DescribeTrafficMirrorSessionsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeTrafficMirrorSessionsCommandInput} for command's `input` shape. + * @see {@link DescribeTrafficMirrorSessionsCommandOutput} for command's `response` shape. + * @see {@link EC2ClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeTrafficMirrorSessionsCommand extends $Command< DescribeTrafficMirrorSessionsCommandInput, diff --git a/clients/client-ec2/commands/DescribeTrafficMirrorTargetsCommand.ts b/clients/client-ec2/commands/DescribeTrafficMirrorTargetsCommand.ts index dedd6ff8a45f..06f5fa4e8df3 100644 --- a/clients/client-ec2/commands/DescribeTrafficMirrorTargetsCommand.ts +++ b/clients/client-ec2/commands/DescribeTrafficMirrorTargetsCommand.ts @@ -24,6 +24,20 @@ export interface DescribeTrafficMirrorTargetsCommandOutput /** *

Information about one or more Traffic Mirror targets.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { EC2Client, DescribeTrafficMirrorTargetsCommand } from "@aws-sdk/client-ec2"; // ES Modules import + * // const { EC2Client, DescribeTrafficMirrorTargetsCommand } = require("@aws-sdk/client-ec2"); // CommonJS import + * const client = new EC2Client(config); + * const command = new DescribeTrafficMirrorTargetsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeTrafficMirrorTargetsCommandInput} for command's `input` shape. + * @see {@link DescribeTrafficMirrorTargetsCommandOutput} for command's `response` shape. + * @see {@link EC2ClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeTrafficMirrorTargetsCommand extends $Command< DescribeTrafficMirrorTargetsCommandInput, diff --git a/clients/client-ec2/commands/DescribeTransitGatewayAttachmentsCommand.ts b/clients/client-ec2/commands/DescribeTransitGatewayAttachmentsCommand.ts index d916b7ad67f7..544b6ba23253 100644 --- a/clients/client-ec2/commands/DescribeTransitGatewayAttachmentsCommand.ts +++ b/clients/client-ec2/commands/DescribeTransitGatewayAttachmentsCommand.ts @@ -25,6 +25,20 @@ export interface DescribeTransitGatewayAttachmentsCommandOutput /** *

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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { EC2Client, DescribeTransitGatewayAttachmentsCommand } from "@aws-sdk/client-ec2"; // ES Modules import + * // const { EC2Client, DescribeTransitGatewayAttachmentsCommand } = require("@aws-sdk/client-ec2"); // CommonJS import + * const client = new EC2Client(config); + * const command = new DescribeTransitGatewayAttachmentsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeTransitGatewayAttachmentsCommandInput} for command's `input` shape. + * @see {@link DescribeTransitGatewayAttachmentsCommandOutput} for command's `response` shape. + * @see {@link EC2ClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeTransitGatewayAttachmentsCommand extends $Command< DescribeTransitGatewayAttachmentsCommandInput, diff --git a/clients/client-ec2/commands/DescribeTransitGatewayConnectPeersCommand.ts b/clients/client-ec2/commands/DescribeTransitGatewayConnectPeersCommand.ts index be5f97d83106..4188586dd894 100644 --- a/clients/client-ec2/commands/DescribeTransitGatewayConnectPeersCommand.ts +++ b/clients/client-ec2/commands/DescribeTransitGatewayConnectPeersCommand.ts @@ -27,6 +27,20 @@ export interface DescribeTransitGatewayConnectPeersCommandOutput /** *

Describes one or more Connect peers.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { EC2Client, DescribeTransitGatewayConnectPeersCommand } from "@aws-sdk/client-ec2"; // ES Modules import + * // const { EC2Client, DescribeTransitGatewayConnectPeersCommand } = require("@aws-sdk/client-ec2"); // CommonJS import + * const client = new EC2Client(config); + * const command = new DescribeTransitGatewayConnectPeersCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeTransitGatewayConnectPeersCommandInput} for command's `input` shape. + * @see {@link DescribeTransitGatewayConnectPeersCommandOutput} for command's `response` shape. + * @see {@link EC2ClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeTransitGatewayConnectPeersCommand extends $Command< DescribeTransitGatewayConnectPeersCommandInput, diff --git a/clients/client-ec2/commands/DescribeTransitGatewayConnectsCommand.ts b/clients/client-ec2/commands/DescribeTransitGatewayConnectsCommand.ts index e4431074b477..7402312073b7 100644 --- a/clients/client-ec2/commands/DescribeTransitGatewayConnectsCommand.ts +++ b/clients/client-ec2/commands/DescribeTransitGatewayConnectsCommand.ts @@ -24,6 +24,20 @@ export interface DescribeTransitGatewayConnectsCommandOutput /** *

Describes one or more Connect attachments.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { EC2Client, DescribeTransitGatewayConnectsCommand } from "@aws-sdk/client-ec2"; // ES Modules import + * // const { EC2Client, DescribeTransitGatewayConnectsCommand } = require("@aws-sdk/client-ec2"); // CommonJS import + * const client = new EC2Client(config); + * const command = new DescribeTransitGatewayConnectsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeTransitGatewayConnectsCommandInput} for command's `input` shape. + * @see {@link DescribeTransitGatewayConnectsCommandOutput} for command's `response` shape. + * @see {@link EC2ClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeTransitGatewayConnectsCommand extends $Command< DescribeTransitGatewayConnectsCommandInput, diff --git a/clients/client-ec2/commands/DescribeTransitGatewayMulticastDomainsCommand.ts b/clients/client-ec2/commands/DescribeTransitGatewayMulticastDomainsCommand.ts index 7fb816d64dbd..6b842d770cc9 100644 --- a/clients/client-ec2/commands/DescribeTransitGatewayMulticastDomainsCommand.ts +++ b/clients/client-ec2/commands/DescribeTransitGatewayMulticastDomainsCommand.ts @@ -28,6 +28,20 @@ export interface DescribeTransitGatewayMulticastDomainsCommandOutput /** *

Describes one or more transit gateway multicast domains.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { EC2Client, DescribeTransitGatewayMulticastDomainsCommand } from "@aws-sdk/client-ec2"; // ES Modules import + * // const { EC2Client, DescribeTransitGatewayMulticastDomainsCommand } = require("@aws-sdk/client-ec2"); // CommonJS import + * const client = new EC2Client(config); + * const command = new DescribeTransitGatewayMulticastDomainsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeTransitGatewayMulticastDomainsCommandInput} for command's `input` shape. + * @see {@link DescribeTransitGatewayMulticastDomainsCommandOutput} for command's `response` shape. + * @see {@link EC2ClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeTransitGatewayMulticastDomainsCommand extends $Command< DescribeTransitGatewayMulticastDomainsCommandInput, diff --git a/clients/client-ec2/commands/DescribeTransitGatewayPeeringAttachmentsCommand.ts b/clients/client-ec2/commands/DescribeTransitGatewayPeeringAttachmentsCommand.ts index 6b35dab8952b..dbd8f2ec3e1c 100644 --- a/clients/client-ec2/commands/DescribeTransitGatewayPeeringAttachmentsCommand.ts +++ b/clients/client-ec2/commands/DescribeTransitGatewayPeeringAttachmentsCommand.ts @@ -28,6 +28,20 @@ export interface DescribeTransitGatewayPeeringAttachmentsCommandOutput /** *

Describes your transit gateway peering attachments.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { EC2Client, DescribeTransitGatewayPeeringAttachmentsCommand } from "@aws-sdk/client-ec2"; // ES Modules import + * // const { EC2Client, DescribeTransitGatewayPeeringAttachmentsCommand } = require("@aws-sdk/client-ec2"); // CommonJS import + * const client = new EC2Client(config); + * const command = new DescribeTransitGatewayPeeringAttachmentsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeTransitGatewayPeeringAttachmentsCommandInput} for command's `input` shape. + * @see {@link DescribeTransitGatewayPeeringAttachmentsCommandOutput} for command's `response` shape. + * @see {@link EC2ClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeTransitGatewayPeeringAttachmentsCommand extends $Command< DescribeTransitGatewayPeeringAttachmentsCommandInput, diff --git a/clients/client-ec2/commands/DescribeTransitGatewayRouteTablesCommand.ts b/clients/client-ec2/commands/DescribeTransitGatewayRouteTablesCommand.ts index c8a28442beed..f137c15d4cbb 100644 --- a/clients/client-ec2/commands/DescribeTransitGatewayRouteTablesCommand.ts +++ b/clients/client-ec2/commands/DescribeTransitGatewayRouteTablesCommand.ts @@ -25,6 +25,20 @@ export interface DescribeTransitGatewayRouteTablesCommandOutput /** *

Describes one or more transit gateway route tables. By default, all transit gateway route tables are described. * Alternatively, you can filter the results.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { EC2Client, DescribeTransitGatewayRouteTablesCommand } from "@aws-sdk/client-ec2"; // ES Modules import + * // const { EC2Client, DescribeTransitGatewayRouteTablesCommand } = require("@aws-sdk/client-ec2"); // CommonJS import + * const client = new EC2Client(config); + * const command = new DescribeTransitGatewayRouteTablesCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeTransitGatewayRouteTablesCommandInput} for command's `input` shape. + * @see {@link DescribeTransitGatewayRouteTablesCommandOutput} for command's `response` shape. + * @see {@link EC2ClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeTransitGatewayRouteTablesCommand extends $Command< DescribeTransitGatewayRouteTablesCommandInput, diff --git a/clients/client-ec2/commands/DescribeTransitGatewayVpcAttachmentsCommand.ts b/clients/client-ec2/commands/DescribeTransitGatewayVpcAttachmentsCommand.ts index 48118f71c9c6..165445615416 100644 --- a/clients/client-ec2/commands/DescribeTransitGatewayVpcAttachmentsCommand.ts +++ b/clients/client-ec2/commands/DescribeTransitGatewayVpcAttachmentsCommand.ts @@ -28,6 +28,20 @@ export interface DescribeTransitGatewayVpcAttachmentsCommandOutput /** *

Describes one or more VPC attachments. By default, all VPC attachments are described. * Alternatively, you can filter the results.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { EC2Client, DescribeTransitGatewayVpcAttachmentsCommand } from "@aws-sdk/client-ec2"; // ES Modules import + * // const { EC2Client, DescribeTransitGatewayVpcAttachmentsCommand } = require("@aws-sdk/client-ec2"); // CommonJS import + * const client = new EC2Client(config); + * const command = new DescribeTransitGatewayVpcAttachmentsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeTransitGatewayVpcAttachmentsCommandInput} for command's `input` shape. + * @see {@link DescribeTransitGatewayVpcAttachmentsCommandOutput} for command's `response` shape. + * @see {@link EC2ClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeTransitGatewayVpcAttachmentsCommand extends $Command< DescribeTransitGatewayVpcAttachmentsCommandInput, diff --git a/clients/client-ec2/commands/DescribeTransitGatewaysCommand.ts b/clients/client-ec2/commands/DescribeTransitGatewaysCommand.ts index dca7063fd28a..61fa99fb2673 100644 --- a/clients/client-ec2/commands/DescribeTransitGatewaysCommand.ts +++ b/clients/client-ec2/commands/DescribeTransitGatewaysCommand.ts @@ -23,6 +23,20 @@ export interface DescribeTransitGatewaysCommandOutput extends DescribeTransitGat /** *

Describes one or more transit gateways. By default, all transit gateways are described. Alternatively, you can * filter the results.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { EC2Client, DescribeTransitGatewaysCommand } from "@aws-sdk/client-ec2"; // ES Modules import + * // const { EC2Client, DescribeTransitGatewaysCommand } = require("@aws-sdk/client-ec2"); // CommonJS import + * const client = new EC2Client(config); + * const command = new DescribeTransitGatewaysCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeTransitGatewaysCommandInput} for command's `input` shape. + * @see {@link DescribeTransitGatewaysCommandOutput} for command's `response` shape. + * @see {@link EC2ClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeTransitGatewaysCommand extends $Command< DescribeTransitGatewaysCommandInput, diff --git a/clients/client-ec2/commands/DescribeVolumeAttributeCommand.ts b/clients/client-ec2/commands/DescribeVolumeAttributeCommand.ts index b9f8ddffb874..998964e4eef2 100644 --- a/clients/client-ec2/commands/DescribeVolumeAttributeCommand.ts +++ b/clients/client-ec2/commands/DescribeVolumeAttributeCommand.ts @@ -24,6 +24,20 @@ export interface DescribeVolumeAttributeCommandOutput extends DescribeVolumeAttr *

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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { EC2Client, DescribeVolumeAttributeCommand } from "@aws-sdk/client-ec2"; // ES Modules import + * // const { EC2Client, DescribeVolumeAttributeCommand } = require("@aws-sdk/client-ec2"); // CommonJS import + * const client = new EC2Client(config); + * const command = new DescribeVolumeAttributeCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeVolumeAttributeCommandInput} for command's `input` shape. + * @see {@link DescribeVolumeAttributeCommandOutput} for command's `response` shape. + * @see {@link EC2ClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeVolumeAttributeCommand extends $Command< DescribeVolumeAttributeCommandInput, diff --git a/clients/client-ec2/commands/DescribeVolumeStatusCommand.ts b/clients/client-ec2/commands/DescribeVolumeStatusCommand.ts index 108ecd0421bd..9eb271e7078a 100644 --- a/clients/client-ec2/commands/DescribeVolumeStatusCommand.ts +++ b/clients/client-ec2/commands/DescribeVolumeStatusCommand.ts @@ -55,6 +55,20 @@ export interface DescribeVolumeStatusCommandOutput extends DescribeVolumeStatusR *

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.)

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { EC2Client, DescribeVolumeStatusCommand } from "@aws-sdk/client-ec2"; // ES Modules import + * // const { EC2Client, DescribeVolumeStatusCommand } = require("@aws-sdk/client-ec2"); // CommonJS import + * const client = new EC2Client(config); + * const command = new DescribeVolumeStatusCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeVolumeStatusCommandInput} for command's `input` shape. + * @see {@link DescribeVolumeStatusCommandOutput} for command's `response` shape. + * @see {@link EC2ClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeVolumeStatusCommand extends $Command< DescribeVolumeStatusCommandInput, diff --git a/clients/client-ec2/commands/DescribeVolumesCommand.ts b/clients/client-ec2/commands/DescribeVolumesCommand.ts index e4d12c9b2d5e..7ddc269230bb 100644 --- a/clients/client-ec2/commands/DescribeVolumesCommand.ts +++ b/clients/client-ec2/commands/DescribeVolumesCommand.ts @@ -26,6 +26,20 @@ export interface DescribeVolumesCommandOutput extends DescribeVolumesResult, __M * passed to a subsequent DescribeVolumes request to retrieve the remaining * results.

*

For more information about EBS volumes, see Amazon EBS volumes in the Amazon Elastic Compute Cloud User Guide.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { EC2Client, DescribeVolumesCommand } from "@aws-sdk/client-ec2"; // ES Modules import + * // const { EC2Client, DescribeVolumesCommand } = require("@aws-sdk/client-ec2"); // CommonJS import + * const client = new EC2Client(config); + * const command = new DescribeVolumesCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeVolumesCommandInput} for command's `input` shape. + * @see {@link DescribeVolumesCommandOutput} for command's `response` shape. + * @see {@link EC2ClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeVolumesCommand extends $Command< DescribeVolumesCommandInput, diff --git a/clients/client-ec2/commands/DescribeVolumesModificationsCommand.ts b/clients/client-ec2/commands/DescribeVolumesModificationsCommand.ts index a85c597e3300..2efb7d545e27 100644 --- a/clients/client-ec2/commands/DescribeVolumesModificationsCommand.ts +++ b/clients/client-ec2/commands/DescribeVolumesModificationsCommand.ts @@ -31,6 +31,20 @@ export interface DescribeVolumesModificationsCommandOutput * volume. For information about CloudWatch Events, see the Amazon CloudWatch Events User Guide. For more information, see * Monitoring volume modifications in the * Amazon Elastic Compute Cloud User Guide.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { EC2Client, DescribeVolumesModificationsCommand } from "@aws-sdk/client-ec2"; // ES Modules import + * // const { EC2Client, DescribeVolumesModificationsCommand } = require("@aws-sdk/client-ec2"); // CommonJS import + * const client = new EC2Client(config); + * const command = new DescribeVolumesModificationsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeVolumesModificationsCommandInput} for command's `input` shape. + * @see {@link DescribeVolumesModificationsCommandOutput} for command's `response` shape. + * @see {@link EC2ClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeVolumesModificationsCommand extends $Command< DescribeVolumesModificationsCommandInput, diff --git a/clients/client-ec2/commands/DescribeVpcAttributeCommand.ts b/clients/client-ec2/commands/DescribeVpcAttributeCommand.ts index 83f66f53009a..3097d19859ab 100644 --- a/clients/client-ec2/commands/DescribeVpcAttributeCommand.ts +++ b/clients/client-ec2/commands/DescribeVpcAttributeCommand.ts @@ -22,6 +22,20 @@ export interface DescribeVpcAttributeCommandOutput extends DescribeVpcAttributeR /** *

Describes the specified attribute of the specified VPC. You can specify only one attribute at a time.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { EC2Client, DescribeVpcAttributeCommand } from "@aws-sdk/client-ec2"; // ES Modules import + * // const { EC2Client, DescribeVpcAttributeCommand } = require("@aws-sdk/client-ec2"); // CommonJS import + * const client = new EC2Client(config); + * const command = new DescribeVpcAttributeCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeVpcAttributeCommandInput} for command's `input` shape. + * @see {@link DescribeVpcAttributeCommandOutput} for command's `response` shape. + * @see {@link EC2ClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeVpcAttributeCommand extends $Command< DescribeVpcAttributeCommandInput, diff --git a/clients/client-ec2/commands/DescribeVpcClassicLinkCommand.ts b/clients/client-ec2/commands/DescribeVpcClassicLinkCommand.ts index da8333f9edc5..6e0c9ac8a145 100644 --- a/clients/client-ec2/commands/DescribeVpcClassicLinkCommand.ts +++ b/clients/client-ec2/commands/DescribeVpcClassicLinkCommand.ts @@ -22,6 +22,20 @@ export interface DescribeVpcClassicLinkCommandOutput extends DescribeVpcClassicL /** *

Describes the ClassicLink status of one or more VPCs.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { EC2Client, DescribeVpcClassicLinkCommand } from "@aws-sdk/client-ec2"; // ES Modules import + * // const { EC2Client, DescribeVpcClassicLinkCommand } = require("@aws-sdk/client-ec2"); // CommonJS import + * const client = new EC2Client(config); + * const command = new DescribeVpcClassicLinkCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeVpcClassicLinkCommandInput} for command's `input` shape. + * @see {@link DescribeVpcClassicLinkCommandOutput} for command's `response` shape. + * @see {@link EC2ClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeVpcClassicLinkCommand extends $Command< DescribeVpcClassicLinkCommandInput, diff --git a/clients/client-ec2/commands/DescribeVpcClassicLinkDnsSupportCommand.ts b/clients/client-ec2/commands/DescribeVpcClassicLinkDnsSupportCommand.ts index bc64cd553af6..01998be3b632 100644 --- a/clients/client-ec2/commands/DescribeVpcClassicLinkDnsSupportCommand.ts +++ b/clients/client-ec2/commands/DescribeVpcClassicLinkDnsSupportCommand.ts @@ -28,6 +28,20 @@ export interface DescribeVpcClassicLinkDnsSupportCommandOutput * 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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { EC2Client, DescribeVpcClassicLinkDnsSupportCommand } from "@aws-sdk/client-ec2"; // ES Modules import + * // const { EC2Client, DescribeVpcClassicLinkDnsSupportCommand } = require("@aws-sdk/client-ec2"); // CommonJS import + * const client = new EC2Client(config); + * const command = new DescribeVpcClassicLinkDnsSupportCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeVpcClassicLinkDnsSupportCommandInput} for command's `input` shape. + * @see {@link DescribeVpcClassicLinkDnsSupportCommandOutput} for command's `response` shape. + * @see {@link EC2ClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeVpcClassicLinkDnsSupportCommand extends $Command< DescribeVpcClassicLinkDnsSupportCommandInput, diff --git a/clients/client-ec2/commands/DescribeVpcEndpointConnectionNotificationsCommand.ts b/clients/client-ec2/commands/DescribeVpcEndpointConnectionNotificationsCommand.ts index c047b26c8f8b..8e5c7e9ad6ac 100644 --- a/clients/client-ec2/commands/DescribeVpcEndpointConnectionNotificationsCommand.ts +++ b/clients/client-ec2/commands/DescribeVpcEndpointConnectionNotificationsCommand.ts @@ -29,6 +29,20 @@ export interface DescribeVpcEndpointConnectionNotificationsCommandOutput /** *

Describes the connection notifications for VPC endpoints and VPC endpoint * services.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { EC2Client, DescribeVpcEndpointConnectionNotificationsCommand } from "@aws-sdk/client-ec2"; // ES Modules import + * // const { EC2Client, DescribeVpcEndpointConnectionNotificationsCommand } = require("@aws-sdk/client-ec2"); // CommonJS import + * const client = new EC2Client(config); + * const command = new DescribeVpcEndpointConnectionNotificationsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeVpcEndpointConnectionNotificationsCommandInput} for command's `input` shape. + * @see {@link DescribeVpcEndpointConnectionNotificationsCommandOutput} for command's `response` shape. + * @see {@link EC2ClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeVpcEndpointConnectionNotificationsCommand extends $Command< DescribeVpcEndpointConnectionNotificationsCommandInput, diff --git a/clients/client-ec2/commands/DescribeVpcEndpointConnectionsCommand.ts b/clients/client-ec2/commands/DescribeVpcEndpointConnectionsCommand.ts index f95d91743682..db0eeb5d8040 100644 --- a/clients/client-ec2/commands/DescribeVpcEndpointConnectionsCommand.ts +++ b/clients/client-ec2/commands/DescribeVpcEndpointConnectionsCommand.ts @@ -25,6 +25,20 @@ export interface DescribeVpcEndpointConnectionsCommandOutput /** *

Describes the VPC endpoint connections to your VPC endpoint services, including any * endpoints that are pending your acceptance.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { EC2Client, DescribeVpcEndpointConnectionsCommand } from "@aws-sdk/client-ec2"; // ES Modules import + * // const { EC2Client, DescribeVpcEndpointConnectionsCommand } = require("@aws-sdk/client-ec2"); // CommonJS import + * const client = new EC2Client(config); + * const command = new DescribeVpcEndpointConnectionsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeVpcEndpointConnectionsCommandInput} for command's `input` shape. + * @see {@link DescribeVpcEndpointConnectionsCommandOutput} for command's `response` shape. + * @see {@link EC2ClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeVpcEndpointConnectionsCommand extends $Command< DescribeVpcEndpointConnectionsCommandInput, diff --git a/clients/client-ec2/commands/DescribeVpcEndpointServiceConfigurationsCommand.ts b/clients/client-ec2/commands/DescribeVpcEndpointServiceConfigurationsCommand.ts index 7ada9579f475..340a4247ab47 100644 --- a/clients/client-ec2/commands/DescribeVpcEndpointServiceConfigurationsCommand.ts +++ b/clients/client-ec2/commands/DescribeVpcEndpointServiceConfigurationsCommand.ts @@ -28,6 +28,20 @@ export interface DescribeVpcEndpointServiceConfigurationsCommandOutput /** *

Describes the VPC endpoint service configurations in your account (your services).

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { EC2Client, DescribeVpcEndpointServiceConfigurationsCommand } from "@aws-sdk/client-ec2"; // ES Modules import + * // const { EC2Client, DescribeVpcEndpointServiceConfigurationsCommand } = require("@aws-sdk/client-ec2"); // CommonJS import + * const client = new EC2Client(config); + * const command = new DescribeVpcEndpointServiceConfigurationsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeVpcEndpointServiceConfigurationsCommandInput} for command's `input` shape. + * @see {@link DescribeVpcEndpointServiceConfigurationsCommandOutput} for command's `response` shape. + * @see {@link EC2ClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeVpcEndpointServiceConfigurationsCommand extends $Command< DescribeVpcEndpointServiceConfigurationsCommandInput, diff --git a/clients/client-ec2/commands/DescribeVpcEndpointServicePermissionsCommand.ts b/clients/client-ec2/commands/DescribeVpcEndpointServicePermissionsCommand.ts index 1c9dfb4eab51..ecff61b47f1e 100644 --- a/clients/client-ec2/commands/DescribeVpcEndpointServicePermissionsCommand.ts +++ b/clients/client-ec2/commands/DescribeVpcEndpointServicePermissionsCommand.ts @@ -29,6 +29,20 @@ export interface DescribeVpcEndpointServicePermissionsCommandOutput /** *

Describes the principals (service consumers) that are permitted to discover your VPC * endpoint service.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { EC2Client, DescribeVpcEndpointServicePermissionsCommand } from "@aws-sdk/client-ec2"; // ES Modules import + * // const { EC2Client, DescribeVpcEndpointServicePermissionsCommand } = require("@aws-sdk/client-ec2"); // CommonJS import + * const client = new EC2Client(config); + * const command = new DescribeVpcEndpointServicePermissionsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeVpcEndpointServicePermissionsCommandInput} for command's `input` shape. + * @see {@link DescribeVpcEndpointServicePermissionsCommandOutput} for command's `response` shape. + * @see {@link EC2ClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeVpcEndpointServicePermissionsCommand extends $Command< DescribeVpcEndpointServicePermissionsCommandInput, diff --git a/clients/client-ec2/commands/DescribeVpcEndpointServicesCommand.ts b/clients/client-ec2/commands/DescribeVpcEndpointServicesCommand.ts index a7d671567082..2bef68a757e5 100644 --- a/clients/client-ec2/commands/DescribeVpcEndpointServicesCommand.ts +++ b/clients/client-ec2/commands/DescribeVpcEndpointServicesCommand.ts @@ -29,6 +29,20 @@ export interface DescribeVpcEndpointServicesCommandOutput extends DescribeVpcEnd * consumer uses us-east-1a and us-east-1b, the response includes * the VPC endpoint services in the common Availability Zone, * us-east-1a.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { EC2Client, DescribeVpcEndpointServicesCommand } from "@aws-sdk/client-ec2"; // ES Modules import + * // const { EC2Client, DescribeVpcEndpointServicesCommand } = require("@aws-sdk/client-ec2"); // CommonJS import + * const client = new EC2Client(config); + * const command = new DescribeVpcEndpointServicesCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeVpcEndpointServicesCommandInput} for command's `input` shape. + * @see {@link DescribeVpcEndpointServicesCommandOutput} for command's `response` shape. + * @see {@link EC2ClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeVpcEndpointServicesCommand extends $Command< DescribeVpcEndpointServicesCommandInput, diff --git a/clients/client-ec2/commands/DescribeVpcEndpointsCommand.ts b/clients/client-ec2/commands/DescribeVpcEndpointsCommand.ts index c587998aaacb..ecd761e32ccd 100644 --- a/clients/client-ec2/commands/DescribeVpcEndpointsCommand.ts +++ b/clients/client-ec2/commands/DescribeVpcEndpointsCommand.ts @@ -22,6 +22,20 @@ export interface DescribeVpcEndpointsCommandOutput extends DescribeVpcEndpointsR /** *

Describes one or more of your VPC endpoints.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { EC2Client, DescribeVpcEndpointsCommand } from "@aws-sdk/client-ec2"; // ES Modules import + * // const { EC2Client, DescribeVpcEndpointsCommand } = require("@aws-sdk/client-ec2"); // CommonJS import + * const client = new EC2Client(config); + * const command = new DescribeVpcEndpointsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeVpcEndpointsCommandInput} for command's `input` shape. + * @see {@link DescribeVpcEndpointsCommandOutput} for command's `response` shape. + * @see {@link EC2ClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeVpcEndpointsCommand extends $Command< DescribeVpcEndpointsCommandInput, diff --git a/clients/client-ec2/commands/DescribeVpcPeeringConnectionsCommand.ts b/clients/client-ec2/commands/DescribeVpcPeeringConnectionsCommand.ts index 054d8fa6ffb3..d176b789950d 100644 --- a/clients/client-ec2/commands/DescribeVpcPeeringConnectionsCommand.ts +++ b/clients/client-ec2/commands/DescribeVpcPeeringConnectionsCommand.ts @@ -24,6 +24,20 @@ export interface DescribeVpcPeeringConnectionsCommandOutput /** *

Describes one or more of your VPC peering connections.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { EC2Client, DescribeVpcPeeringConnectionsCommand } from "@aws-sdk/client-ec2"; // ES Modules import + * // const { EC2Client, DescribeVpcPeeringConnectionsCommand } = require("@aws-sdk/client-ec2"); // CommonJS import + * const client = new EC2Client(config); + * const command = new DescribeVpcPeeringConnectionsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeVpcPeeringConnectionsCommandInput} for command's `input` shape. + * @see {@link DescribeVpcPeeringConnectionsCommandOutput} for command's `response` shape. + * @see {@link EC2ClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeVpcPeeringConnectionsCommand extends $Command< DescribeVpcPeeringConnectionsCommandInput, diff --git a/clients/client-ec2/commands/DescribeVpcsCommand.ts b/clients/client-ec2/commands/DescribeVpcsCommand.ts index 597fd4bf3afa..25bde396add4 100644 --- a/clients/client-ec2/commands/DescribeVpcsCommand.ts +++ b/clients/client-ec2/commands/DescribeVpcsCommand.ts @@ -19,6 +19,20 @@ export interface DescribeVpcsCommandOutput extends DescribeVpcsResult, __Metadat /** *

Describes one or more of your VPCs.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { EC2Client, DescribeVpcsCommand } from "@aws-sdk/client-ec2"; // ES Modules import + * // const { EC2Client, DescribeVpcsCommand } = require("@aws-sdk/client-ec2"); // CommonJS import + * const client = new EC2Client(config); + * const command = new DescribeVpcsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeVpcsCommandInput} for command's `input` shape. + * @see {@link DescribeVpcsCommandOutput} for command's `response` shape. + * @see {@link EC2ClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeVpcsCommand extends $Command< DescribeVpcsCommandInput, diff --git a/clients/client-ec2/commands/DescribeVpnConnectionsCommand.ts b/clients/client-ec2/commands/DescribeVpnConnectionsCommand.ts index fc8e80ce25f5..ad156b662a67 100644 --- a/clients/client-ec2/commands/DescribeVpnConnectionsCommand.ts +++ b/clients/client-ec2/commands/DescribeVpnConnectionsCommand.ts @@ -23,6 +23,20 @@ export interface DescribeVpnConnectionsCommandOutput extends DescribeVpnConnecti /** *

Describes one or more of your VPN connections.

*

For more information, see AWS Site-to-Site VPN in the AWS Site-to-Site VPN User Guide.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { EC2Client, DescribeVpnConnectionsCommand } from "@aws-sdk/client-ec2"; // ES Modules import + * // const { EC2Client, DescribeVpnConnectionsCommand } = require("@aws-sdk/client-ec2"); // CommonJS import + * const client = new EC2Client(config); + * const command = new DescribeVpnConnectionsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeVpnConnectionsCommandInput} for command's `input` shape. + * @see {@link DescribeVpnConnectionsCommandOutput} for command's `response` shape. + * @see {@link EC2ClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeVpnConnectionsCommand extends $Command< DescribeVpnConnectionsCommandInput, diff --git a/clients/client-ec2/commands/DescribeVpnGatewaysCommand.ts b/clients/client-ec2/commands/DescribeVpnGatewaysCommand.ts index c7cbc3ae8713..bcf91e882aed 100644 --- a/clients/client-ec2/commands/DescribeVpnGatewaysCommand.ts +++ b/clients/client-ec2/commands/DescribeVpnGatewaysCommand.ts @@ -23,6 +23,20 @@ export interface DescribeVpnGatewaysCommandOutput extends DescribeVpnGatewaysRes /** *

Describes one or more of your virtual private gateways.

*

For more information, see AWS Site-to-Site VPN in the AWS Site-to-Site VPN User Guide.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { EC2Client, DescribeVpnGatewaysCommand } from "@aws-sdk/client-ec2"; // ES Modules import + * // const { EC2Client, DescribeVpnGatewaysCommand } = require("@aws-sdk/client-ec2"); // CommonJS import + * const client = new EC2Client(config); + * const command = new DescribeVpnGatewaysCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeVpnGatewaysCommandInput} for command's `input` shape. + * @see {@link DescribeVpnGatewaysCommandOutput} for command's `response` shape. + * @see {@link EC2ClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeVpnGatewaysCommand extends $Command< DescribeVpnGatewaysCommandInput, diff --git a/clients/client-ec2/commands/DetachClassicLinkVpcCommand.ts b/clients/client-ec2/commands/DetachClassicLinkVpcCommand.ts index f85a1f59d825..9bfe74e70f6b 100644 --- a/clients/client-ec2/commands/DetachClassicLinkVpcCommand.ts +++ b/clients/client-ec2/commands/DetachClassicLinkVpcCommand.ts @@ -22,6 +22,20 @@ export interface DetachClassicLinkVpcCommandOutput extends DetachClassicLinkVpcR /** *

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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { EC2Client, DetachClassicLinkVpcCommand } from "@aws-sdk/client-ec2"; // ES Modules import + * // const { EC2Client, DetachClassicLinkVpcCommand } = require("@aws-sdk/client-ec2"); // CommonJS import + * const client = new EC2Client(config); + * const command = new DetachClassicLinkVpcCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DetachClassicLinkVpcCommandInput} for command's `input` shape. + * @see {@link DetachClassicLinkVpcCommandOutput} for command's `response` shape. + * @see {@link EC2ClientResolvedConfig | config} for command's `input` shape. + * */ export class DetachClassicLinkVpcCommand extends $Command< DetachClassicLinkVpcCommandInput, diff --git a/clients/client-ec2/commands/DetachInternetGatewayCommand.ts b/clients/client-ec2/commands/DetachInternetGatewayCommand.ts index fac32fafea84..f7423c5a7906 100644 --- a/clients/client-ec2/commands/DetachInternetGatewayCommand.ts +++ b/clients/client-ec2/commands/DetachInternetGatewayCommand.ts @@ -24,6 +24,20 @@ export interface DetachInternetGatewayCommandOutput extends __MetadataBearer {} *

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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { EC2Client, DetachInternetGatewayCommand } from "@aws-sdk/client-ec2"; // ES Modules import + * // const { EC2Client, DetachInternetGatewayCommand } = require("@aws-sdk/client-ec2"); // CommonJS import + * const client = new EC2Client(config); + * const command = new DetachInternetGatewayCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DetachInternetGatewayCommandInput} for command's `input` shape. + * @see {@link DetachInternetGatewayCommandOutput} for command's `response` shape. + * @see {@link EC2ClientResolvedConfig | config} for command's `input` shape. + * */ export class DetachInternetGatewayCommand extends $Command< DetachInternetGatewayCommandInput, diff --git a/clients/client-ec2/commands/DetachNetworkInterfaceCommand.ts b/clients/client-ec2/commands/DetachNetworkInterfaceCommand.ts index 35efbe561a23..df51d4d91fdc 100644 --- a/clients/client-ec2/commands/DetachNetworkInterfaceCommand.ts +++ b/clients/client-ec2/commands/DetachNetworkInterfaceCommand.ts @@ -22,6 +22,20 @@ export interface DetachNetworkInterfaceCommandOutput extends __MetadataBearer {} /** *

Detaches a network interface from an instance.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { EC2Client, DetachNetworkInterfaceCommand } from "@aws-sdk/client-ec2"; // ES Modules import + * // const { EC2Client, DetachNetworkInterfaceCommand } = require("@aws-sdk/client-ec2"); // CommonJS import + * const client = new EC2Client(config); + * const command = new DetachNetworkInterfaceCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DetachNetworkInterfaceCommandInput} for command's `input` shape. + * @see {@link DetachNetworkInterfaceCommandOutput} for command's `response` shape. + * @see {@link EC2ClientResolvedConfig | config} for command's `input` shape. + * */ export class DetachNetworkInterfaceCommand extends $Command< DetachNetworkInterfaceCommandInput, diff --git a/clients/client-ec2/commands/DetachVolumeCommand.ts b/clients/client-ec2/commands/DetachVolumeCommand.ts index b310a9d57e56..7f654097f798 100644 --- a/clients/client-ec2/commands/DetachVolumeCommand.ts +++ b/clients/client-ec2/commands/DetachVolumeCommand.ts @@ -30,6 +30,20 @@ export interface DetachVolumeCommandOutput extends VolumeAttachment, __MetadataB * product code is no longer associated with the instance.

*

For more information, see Detaching an Amazon EBS volume in the * Amazon Elastic Compute Cloud User Guide.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { EC2Client, DetachVolumeCommand } from "@aws-sdk/client-ec2"; // ES Modules import + * // const { EC2Client, DetachVolumeCommand } = require("@aws-sdk/client-ec2"); // CommonJS import + * const client = new EC2Client(config); + * const command = new DetachVolumeCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DetachVolumeCommandInput} for command's `input` shape. + * @see {@link DetachVolumeCommandOutput} for command's `response` shape. + * @see {@link EC2ClientResolvedConfig | config} for command's `input` shape. + * */ export class DetachVolumeCommand extends $Command< DetachVolumeCommandInput, diff --git a/clients/client-ec2/commands/DetachVpnGatewayCommand.ts b/clients/client-ec2/commands/DetachVpnGatewayCommand.ts index e5d648b2e1d0..6bab0450203a 100644 --- a/clients/client-ec2/commands/DetachVpnGatewayCommand.ts +++ b/clients/client-ec2/commands/DetachVpnGatewayCommand.ts @@ -24,6 +24,20 @@ export interface DetachVpnGatewayCommandOutput extends __MetadataBearer {} *

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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { EC2Client, DetachVpnGatewayCommand } from "@aws-sdk/client-ec2"; // ES Modules import + * // const { EC2Client, DetachVpnGatewayCommand } = require("@aws-sdk/client-ec2"); // CommonJS import + * const client = new EC2Client(config); + * const command = new DetachVpnGatewayCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DetachVpnGatewayCommandInput} for command's `input` shape. + * @see {@link DetachVpnGatewayCommandOutput} for command's `response` shape. + * @see {@link EC2ClientResolvedConfig | config} for command's `input` shape. + * */ export class DetachVpnGatewayCommand extends $Command< DetachVpnGatewayCommandInput, diff --git a/clients/client-ec2/commands/DisableEbsEncryptionByDefaultCommand.ts b/clients/client-ec2/commands/DisableEbsEncryptionByDefaultCommand.ts index 751a12478bc0..e471c9f67101 100644 --- a/clients/client-ec2/commands/DisableEbsEncryptionByDefaultCommand.ts +++ b/clients/client-ec2/commands/DisableEbsEncryptionByDefaultCommand.ts @@ -30,6 +30,20 @@ export interface DisableEbsEncryptionByDefaultCommandOutput * existing volumes.

*

For more information, see Amazon EBS encryption in the * Amazon Elastic Compute Cloud User Guide.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { EC2Client, DisableEbsEncryptionByDefaultCommand } from "@aws-sdk/client-ec2"; // ES Modules import + * // const { EC2Client, DisableEbsEncryptionByDefaultCommand } = require("@aws-sdk/client-ec2"); // CommonJS import + * const client = new EC2Client(config); + * const command = new DisableEbsEncryptionByDefaultCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DisableEbsEncryptionByDefaultCommandInput} for command's `input` shape. + * @see {@link DisableEbsEncryptionByDefaultCommandOutput} for command's `response` shape. + * @see {@link EC2ClientResolvedConfig | config} for command's `input` shape. + * */ export class DisableEbsEncryptionByDefaultCommand extends $Command< DisableEbsEncryptionByDefaultCommandInput, diff --git a/clients/client-ec2/commands/DisableFastSnapshotRestoresCommand.ts b/clients/client-ec2/commands/DisableFastSnapshotRestoresCommand.ts index d18161319333..b0199979f115 100644 --- a/clients/client-ec2/commands/DisableFastSnapshotRestoresCommand.ts +++ b/clients/client-ec2/commands/DisableFastSnapshotRestoresCommand.ts @@ -23,6 +23,20 @@ export interface DisableFastSnapshotRestoresCommandOutput extends DisableFastSna /** *

Disables fast snapshot restores for the specified snapshots in the specified Availability Zones.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { EC2Client, DisableFastSnapshotRestoresCommand } from "@aws-sdk/client-ec2"; // ES Modules import + * // const { EC2Client, DisableFastSnapshotRestoresCommand } = require("@aws-sdk/client-ec2"); // CommonJS import + * const client = new EC2Client(config); + * const command = new DisableFastSnapshotRestoresCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DisableFastSnapshotRestoresCommandInput} for command's `input` shape. + * @see {@link DisableFastSnapshotRestoresCommandOutput} for command's `response` shape. + * @see {@link EC2ClientResolvedConfig | config} for command's `input` shape. + * */ export class DisableFastSnapshotRestoresCommand extends $Command< DisableFastSnapshotRestoresCommandInput, diff --git a/clients/client-ec2/commands/DisableSerialConsoleAccessCommand.ts b/clients/client-ec2/commands/DisableSerialConsoleAccessCommand.ts index 5750892ae19f..2b89de503237 100644 --- a/clients/client-ec2/commands/DisableSerialConsoleAccessCommand.ts +++ b/clients/client-ec2/commands/DisableSerialConsoleAccessCommand.ts @@ -25,6 +25,20 @@ export interface DisableSerialConsoleAccessCommandOutput extends DisableSerialCo * 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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { EC2Client, DisableSerialConsoleAccessCommand } from "@aws-sdk/client-ec2"; // ES Modules import + * // const { EC2Client, DisableSerialConsoleAccessCommand } = require("@aws-sdk/client-ec2"); // CommonJS import + * const client = new EC2Client(config); + * const command = new DisableSerialConsoleAccessCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DisableSerialConsoleAccessCommandInput} for command's `input` shape. + * @see {@link DisableSerialConsoleAccessCommandOutput} for command's `response` shape. + * @see {@link EC2ClientResolvedConfig | config} for command's `input` shape. + * */ export class DisableSerialConsoleAccessCommand extends $Command< DisableSerialConsoleAccessCommandInput, diff --git a/clients/client-ec2/commands/DisableTransitGatewayRouteTablePropagationCommand.ts b/clients/client-ec2/commands/DisableTransitGatewayRouteTablePropagationCommand.ts index cf6e3cdba996..c7454fe288ff 100644 --- a/clients/client-ec2/commands/DisableTransitGatewayRouteTablePropagationCommand.ts +++ b/clients/client-ec2/commands/DisableTransitGatewayRouteTablePropagationCommand.ts @@ -29,6 +29,20 @@ export interface DisableTransitGatewayRouteTablePropagationCommandOutput /** *

Disables the specified resource attachment from propagating routes to the specified * propagation route table.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { EC2Client, DisableTransitGatewayRouteTablePropagationCommand } from "@aws-sdk/client-ec2"; // ES Modules import + * // const { EC2Client, DisableTransitGatewayRouteTablePropagationCommand } = require("@aws-sdk/client-ec2"); // CommonJS import + * const client = new EC2Client(config); + * const command = new DisableTransitGatewayRouteTablePropagationCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DisableTransitGatewayRouteTablePropagationCommandInput} for command's `input` shape. + * @see {@link DisableTransitGatewayRouteTablePropagationCommandOutput} for command's `response` shape. + * @see {@link EC2ClientResolvedConfig | config} for command's `input` shape. + * */ export class DisableTransitGatewayRouteTablePropagationCommand extends $Command< DisableTransitGatewayRouteTablePropagationCommandInput, diff --git a/clients/client-ec2/commands/DisableVgwRoutePropagationCommand.ts b/clients/client-ec2/commands/DisableVgwRoutePropagationCommand.ts index 66c4957f889b..49272bbd0db1 100644 --- a/clients/client-ec2/commands/DisableVgwRoutePropagationCommand.ts +++ b/clients/client-ec2/commands/DisableVgwRoutePropagationCommand.ts @@ -22,6 +22,20 @@ export interface DisableVgwRoutePropagationCommandOutput extends __MetadataBeare /** *

Disables a virtual private gateway (VGW) from propagating routes to a specified route table of a VPC.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { EC2Client, DisableVgwRoutePropagationCommand } from "@aws-sdk/client-ec2"; // ES Modules import + * // const { EC2Client, DisableVgwRoutePropagationCommand } = require("@aws-sdk/client-ec2"); // CommonJS import + * const client = new EC2Client(config); + * const command = new DisableVgwRoutePropagationCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DisableVgwRoutePropagationCommandInput} for command's `input` shape. + * @see {@link DisableVgwRoutePropagationCommandOutput} for command's `response` shape. + * @see {@link EC2ClientResolvedConfig | config} for command's `input` shape. + * */ export class DisableVgwRoutePropagationCommand extends $Command< DisableVgwRoutePropagationCommandInput, diff --git a/clients/client-ec2/commands/DisableVpcClassicLinkCommand.ts b/clients/client-ec2/commands/DisableVpcClassicLinkCommand.ts index 15103b900290..2a2e6e6b91e4 100644 --- a/clients/client-ec2/commands/DisableVpcClassicLinkCommand.ts +++ b/clients/client-ec2/commands/DisableVpcClassicLinkCommand.ts @@ -22,6 +22,20 @@ export interface DisableVpcClassicLinkCommandOutput extends DisableVpcClassicLin /** *

Disables ClassicLink for a VPC. You cannot disable ClassicLink for a VPC that has EC2-Classic instances linked to it.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { EC2Client, DisableVpcClassicLinkCommand } from "@aws-sdk/client-ec2"; // ES Modules import + * // const { EC2Client, DisableVpcClassicLinkCommand } = require("@aws-sdk/client-ec2"); // CommonJS import + * const client = new EC2Client(config); + * const command = new DisableVpcClassicLinkCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DisableVpcClassicLinkCommandInput} for command's `input` shape. + * @see {@link DisableVpcClassicLinkCommandOutput} for command's `response` shape. + * @see {@link EC2ClientResolvedConfig | config} for command's `input` shape. + * */ export class DisableVpcClassicLinkCommand extends $Command< DisableVpcClassicLinkCommandInput, diff --git a/clients/client-ec2/commands/DisableVpcClassicLinkDnsSupportCommand.ts b/clients/client-ec2/commands/DisableVpcClassicLinkDnsSupportCommand.ts index f8450b218143..69e2ca24d168 100644 --- a/clients/client-ec2/commands/DisableVpcClassicLinkDnsSupportCommand.ts +++ b/clients/client-ec2/commands/DisableVpcClassicLinkDnsSupportCommand.ts @@ -28,6 +28,20 @@ export interface DisableVpcClassicLinkDnsSupportCommandOutput * 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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { EC2Client, DisableVpcClassicLinkDnsSupportCommand } from "@aws-sdk/client-ec2"; // ES Modules import + * // const { EC2Client, DisableVpcClassicLinkDnsSupportCommand } = require("@aws-sdk/client-ec2"); // CommonJS import + * const client = new EC2Client(config); + * const command = new DisableVpcClassicLinkDnsSupportCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DisableVpcClassicLinkDnsSupportCommandInput} for command's `input` shape. + * @see {@link DisableVpcClassicLinkDnsSupportCommandOutput} for command's `response` shape. + * @see {@link EC2ClientResolvedConfig | config} for command's `input` shape. + * */ export class DisableVpcClassicLinkDnsSupportCommand extends $Command< DisableVpcClassicLinkDnsSupportCommandInput, diff --git a/clients/client-ec2/commands/DisassociateAddressCommand.ts b/clients/client-ec2/commands/DisassociateAddressCommand.ts index 3bb6595a2ad2..3c8f4ca5423f 100644 --- a/clients/client-ec2/commands/DisassociateAddressCommand.ts +++ b/clients/client-ec2/commands/DisassociateAddressCommand.ts @@ -26,6 +26,20 @@ export interface DisassociateAddressCommandOutput extends __MetadataBearer {} * information, see Elastic IP * Addresses 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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { EC2Client, DisassociateAddressCommand } from "@aws-sdk/client-ec2"; // ES Modules import + * // const { EC2Client, DisassociateAddressCommand } = require("@aws-sdk/client-ec2"); // CommonJS import + * const client = new EC2Client(config); + * const command = new DisassociateAddressCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DisassociateAddressCommandInput} for command's `input` shape. + * @see {@link DisassociateAddressCommandOutput} for command's `response` shape. + * @see {@link EC2ClientResolvedConfig | config} for command's `input` shape. + * */ export class DisassociateAddressCommand extends $Command< DisassociateAddressCommandInput, diff --git a/clients/client-ec2/commands/DisassociateClientVpnTargetNetworkCommand.ts b/clients/client-ec2/commands/DisassociateClientVpnTargetNetworkCommand.ts index f612c0f08e88..f7aac079bb63 100644 --- a/clients/client-ec2/commands/DisassociateClientVpnTargetNetworkCommand.ts +++ b/clients/client-ec2/commands/DisassociateClientVpnTargetNetworkCommand.ts @@ -43,6 +43,20 @@ export interface DisassociateClientVpnTargetNetworkCommandOutput *

* * + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { EC2Client, DisassociateClientVpnTargetNetworkCommand } from "@aws-sdk/client-ec2"; // ES Modules import + * // const { EC2Client, DisassociateClientVpnTargetNetworkCommand } = require("@aws-sdk/client-ec2"); // CommonJS import + * const client = new EC2Client(config); + * const command = new DisassociateClientVpnTargetNetworkCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DisassociateClientVpnTargetNetworkCommandInput} for command's `input` shape. + * @see {@link DisassociateClientVpnTargetNetworkCommandOutput} for command's `response` shape. + * @see {@link EC2ClientResolvedConfig | config} for command's `input` shape. + * */ export class DisassociateClientVpnTargetNetworkCommand extends $Command< DisassociateClientVpnTargetNetworkCommandInput, diff --git a/clients/client-ec2/commands/DisassociateEnclaveCertificateIamRoleCommand.ts b/clients/client-ec2/commands/DisassociateEnclaveCertificateIamRoleCommand.ts index c423030314b5..8ea2f3f41b47 100644 --- a/clients/client-ec2/commands/DisassociateEnclaveCertificateIamRoleCommand.ts +++ b/clients/client-ec2/commands/DisassociateEnclaveCertificateIamRoleCommand.ts @@ -32,6 +32,20 @@ export interface DisassociateEnclaveCertificateIamRoleCommandOutput * encrypted private key from the Amazon S3 bucket. It also revokes the IAM role's permission to use the * AWS Key Management Service (KMS) customer master key (CMK) used to encrypt the private key. This effectively revokes the role's * permission to use the certificate.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { EC2Client, DisassociateEnclaveCertificateIamRoleCommand } from "@aws-sdk/client-ec2"; // ES Modules import + * // const { EC2Client, DisassociateEnclaveCertificateIamRoleCommand } = require("@aws-sdk/client-ec2"); // CommonJS import + * const client = new EC2Client(config); + * const command = new DisassociateEnclaveCertificateIamRoleCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DisassociateEnclaveCertificateIamRoleCommandInput} for command's `input` shape. + * @see {@link DisassociateEnclaveCertificateIamRoleCommandOutput} for command's `response` shape. + * @see {@link EC2ClientResolvedConfig | config} for command's `input` shape. + * */ export class DisassociateEnclaveCertificateIamRoleCommand extends $Command< DisassociateEnclaveCertificateIamRoleCommandInput, diff --git a/clients/client-ec2/commands/DisassociateIamInstanceProfileCommand.ts b/clients/client-ec2/commands/DisassociateIamInstanceProfileCommand.ts index 577b377d8f5b..716ffbe7603f 100644 --- a/clients/client-ec2/commands/DisassociateIamInstanceProfileCommand.ts +++ b/clients/client-ec2/commands/DisassociateIamInstanceProfileCommand.ts @@ -26,6 +26,20 @@ export interface DisassociateIamInstanceProfileCommandOutput *

Disassociates an IAM instance profile from a running or stopped instance.

*

Use DescribeIamInstanceProfileAssociations to get the association * ID.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { EC2Client, DisassociateIamInstanceProfileCommand } from "@aws-sdk/client-ec2"; // ES Modules import + * // const { EC2Client, DisassociateIamInstanceProfileCommand } = require("@aws-sdk/client-ec2"); // CommonJS import + * const client = new EC2Client(config); + * const command = new DisassociateIamInstanceProfileCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DisassociateIamInstanceProfileCommandInput} for command's `input` shape. + * @see {@link DisassociateIamInstanceProfileCommandOutput} for command's `response` shape. + * @see {@link EC2ClientResolvedConfig | config} for command's `input` shape. + * */ export class DisassociateIamInstanceProfileCommand extends $Command< DisassociateIamInstanceProfileCommandInput, diff --git a/clients/client-ec2/commands/DisassociateRouteTableCommand.ts b/clients/client-ec2/commands/DisassociateRouteTableCommand.ts index 1fcdb1c368d0..5641f951986f 100644 --- a/clients/client-ec2/commands/DisassociateRouteTableCommand.ts +++ b/clients/client-ec2/commands/DisassociateRouteTableCommand.ts @@ -26,6 +26,20 @@ export interface DisassociateRouteTableCommandOutput extends __MetadataBearer {} * 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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { EC2Client, DisassociateRouteTableCommand } from "@aws-sdk/client-ec2"; // ES Modules import + * // const { EC2Client, DisassociateRouteTableCommand } = require("@aws-sdk/client-ec2"); // CommonJS import + * const client = new EC2Client(config); + * const command = new DisassociateRouteTableCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DisassociateRouteTableCommandInput} for command's `input` shape. + * @see {@link DisassociateRouteTableCommandOutput} for command's `response` shape. + * @see {@link EC2ClientResolvedConfig | config} for command's `input` shape. + * */ export class DisassociateRouteTableCommand extends $Command< DisassociateRouteTableCommandInput, diff --git a/clients/client-ec2/commands/DisassociateSubnetCidrBlockCommand.ts b/clients/client-ec2/commands/DisassociateSubnetCidrBlockCommand.ts index 8733b53bd4e8..64b566264687 100644 --- a/clients/client-ec2/commands/DisassociateSubnetCidrBlockCommand.ts +++ b/clients/client-ec2/commands/DisassociateSubnetCidrBlockCommand.ts @@ -22,6 +22,20 @@ export interface DisassociateSubnetCidrBlockCommandOutput extends DisassociateSu /** *

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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { EC2Client, DisassociateSubnetCidrBlockCommand } from "@aws-sdk/client-ec2"; // ES Modules import + * // const { EC2Client, DisassociateSubnetCidrBlockCommand } = require("@aws-sdk/client-ec2"); // CommonJS import + * const client = new EC2Client(config); + * const command = new DisassociateSubnetCidrBlockCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DisassociateSubnetCidrBlockCommandInput} for command's `input` shape. + * @see {@link DisassociateSubnetCidrBlockCommandOutput} for command's `response` shape. + * @see {@link EC2ClientResolvedConfig | config} for command's `input` shape. + * */ export class DisassociateSubnetCidrBlockCommand extends $Command< DisassociateSubnetCidrBlockCommandInput, diff --git a/clients/client-ec2/commands/DisassociateTransitGatewayMulticastDomainCommand.ts b/clients/client-ec2/commands/DisassociateTransitGatewayMulticastDomainCommand.ts index e7b8d58fd627..b82dec3d05de 100644 --- a/clients/client-ec2/commands/DisassociateTransitGatewayMulticastDomainCommand.ts +++ b/clients/client-ec2/commands/DisassociateTransitGatewayMulticastDomainCommand.ts @@ -28,6 +28,20 @@ export interface DisassociateTransitGatewayMulticastDomainCommandOutput /** *

Disassociates the specified subnets from the transit gateway multicast domain.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { EC2Client, DisassociateTransitGatewayMulticastDomainCommand } from "@aws-sdk/client-ec2"; // ES Modules import + * // const { EC2Client, DisassociateTransitGatewayMulticastDomainCommand } = require("@aws-sdk/client-ec2"); // CommonJS import + * const client = new EC2Client(config); + * const command = new DisassociateTransitGatewayMulticastDomainCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DisassociateTransitGatewayMulticastDomainCommandInput} for command's `input` shape. + * @see {@link DisassociateTransitGatewayMulticastDomainCommandOutput} for command's `response` shape. + * @see {@link EC2ClientResolvedConfig | config} for command's `input` shape. + * */ export class DisassociateTransitGatewayMulticastDomainCommand extends $Command< DisassociateTransitGatewayMulticastDomainCommandInput, diff --git a/clients/client-ec2/commands/DisassociateTransitGatewayRouteTableCommand.ts b/clients/client-ec2/commands/DisassociateTransitGatewayRouteTableCommand.ts index aded9d16c76e..e5ad0b54d241 100644 --- a/clients/client-ec2/commands/DisassociateTransitGatewayRouteTableCommand.ts +++ b/clients/client-ec2/commands/DisassociateTransitGatewayRouteTableCommand.ts @@ -27,6 +27,20 @@ export interface DisassociateTransitGatewayRouteTableCommandOutput /** *

Disassociates a resource attachment from a transit gateway route table.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { EC2Client, DisassociateTransitGatewayRouteTableCommand } from "@aws-sdk/client-ec2"; // ES Modules import + * // const { EC2Client, DisassociateTransitGatewayRouteTableCommand } = require("@aws-sdk/client-ec2"); // CommonJS import + * const client = new EC2Client(config); + * const command = new DisassociateTransitGatewayRouteTableCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DisassociateTransitGatewayRouteTableCommandInput} for command's `input` shape. + * @see {@link DisassociateTransitGatewayRouteTableCommandOutput} for command's `response` shape. + * @see {@link EC2ClientResolvedConfig | config} for command's `input` shape. + * */ export class DisassociateTransitGatewayRouteTableCommand extends $Command< DisassociateTransitGatewayRouteTableCommandInput, diff --git a/clients/client-ec2/commands/DisassociateVpcCidrBlockCommand.ts b/clients/client-ec2/commands/DisassociateVpcCidrBlockCommand.ts index 83795ca28fcd..f36b80fca9ea 100644 --- a/clients/client-ec2/commands/DisassociateVpcCidrBlockCommand.ts +++ b/clients/client-ec2/commands/DisassociateVpcCidrBlockCommand.ts @@ -27,6 +27,20 @@ export interface DisassociateVpcCidrBlockCommandOutput extends DisassociateVpcCi * 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).

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { EC2Client, DisassociateVpcCidrBlockCommand } from "@aws-sdk/client-ec2"; // ES Modules import + * // const { EC2Client, DisassociateVpcCidrBlockCommand } = require("@aws-sdk/client-ec2"); // CommonJS import + * const client = new EC2Client(config); + * const command = new DisassociateVpcCidrBlockCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DisassociateVpcCidrBlockCommandInput} for command's `input` shape. + * @see {@link DisassociateVpcCidrBlockCommandOutput} for command's `response` shape. + * @see {@link EC2ClientResolvedConfig | config} for command's `input` shape. + * */ export class DisassociateVpcCidrBlockCommand extends $Command< DisassociateVpcCidrBlockCommandInput, diff --git a/clients/client-ec2/commands/EnableEbsEncryptionByDefaultCommand.ts b/clients/client-ec2/commands/EnableEbsEncryptionByDefaultCommand.ts index 87d9b7bfd4ba..d073352d22c7 100644 --- a/clients/client-ec2/commands/EnableEbsEncryptionByDefaultCommand.ts +++ b/clients/client-ec2/commands/EnableEbsEncryptionByDefaultCommand.ts @@ -35,6 +35,20 @@ export interface EnableEbsEncryptionByDefaultCommandOutput *

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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { EC2Client, EnableEbsEncryptionByDefaultCommand } from "@aws-sdk/client-ec2"; // ES Modules import + * // const { EC2Client, EnableEbsEncryptionByDefaultCommand } = require("@aws-sdk/client-ec2"); // CommonJS import + * const client = new EC2Client(config); + * const command = new EnableEbsEncryptionByDefaultCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link EnableEbsEncryptionByDefaultCommandInput} for command's `input` shape. + * @see {@link EnableEbsEncryptionByDefaultCommandOutput} for command's `response` shape. + * @see {@link EC2ClientResolvedConfig | config} for command's `input` shape. + * */ export class EnableEbsEncryptionByDefaultCommand extends $Command< EnableEbsEncryptionByDefaultCommandInput, diff --git a/clients/client-ec2/commands/EnableFastSnapshotRestoresCommand.ts b/clients/client-ec2/commands/EnableFastSnapshotRestoresCommand.ts index 2bb02de4a197..19bfcb087cf3 100644 --- a/clients/client-ec2/commands/EnableFastSnapshotRestoresCommand.ts +++ b/clients/client-ec2/commands/EnableFastSnapshotRestoresCommand.ts @@ -27,6 +27,20 @@ export interface EnableFastSnapshotRestoresCommandOutput extends EnableFastSnaps * To disable fast snapshot restores, use DisableFastSnapshotRestores.

*

For more information, see Amazon EBS fast snapshot * restore in the Amazon Elastic Compute Cloud User Guide.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { EC2Client, EnableFastSnapshotRestoresCommand } from "@aws-sdk/client-ec2"; // ES Modules import + * // const { EC2Client, EnableFastSnapshotRestoresCommand } = require("@aws-sdk/client-ec2"); // CommonJS import + * const client = new EC2Client(config); + * const command = new EnableFastSnapshotRestoresCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link EnableFastSnapshotRestoresCommandInput} for command's `input` shape. + * @see {@link EnableFastSnapshotRestoresCommandOutput} for command's `response` shape. + * @see {@link EC2ClientResolvedConfig | config} for command's `input` shape. + * */ export class EnableFastSnapshotRestoresCommand extends $Command< EnableFastSnapshotRestoresCommandInput, diff --git a/clients/client-ec2/commands/EnableSerialConsoleAccessCommand.ts b/clients/client-ec2/commands/EnableSerialConsoleAccessCommand.ts index cbfde208fe7f..eda38f627396 100644 --- a/clients/client-ec2/commands/EnableSerialConsoleAccessCommand.ts +++ b/clients/client-ec2/commands/EnableSerialConsoleAccessCommand.ts @@ -24,6 +24,20 @@ export interface EnableSerialConsoleAccessCommandOutput extends EnableSerialCons *

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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { EC2Client, EnableSerialConsoleAccessCommand } from "@aws-sdk/client-ec2"; // ES Modules import + * // const { EC2Client, EnableSerialConsoleAccessCommand } = require("@aws-sdk/client-ec2"); // CommonJS import + * const client = new EC2Client(config); + * const command = new EnableSerialConsoleAccessCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link EnableSerialConsoleAccessCommandInput} for command's `input` shape. + * @see {@link EnableSerialConsoleAccessCommandOutput} for command's `response` shape. + * @see {@link EC2ClientResolvedConfig | config} for command's `input` shape. + * */ export class EnableSerialConsoleAccessCommand extends $Command< EnableSerialConsoleAccessCommandInput, diff --git a/clients/client-ec2/commands/EnableTransitGatewayRouteTablePropagationCommand.ts b/clients/client-ec2/commands/EnableTransitGatewayRouteTablePropagationCommand.ts index 492cce5c08ea..5e045714d55f 100644 --- a/clients/client-ec2/commands/EnableTransitGatewayRouteTablePropagationCommand.ts +++ b/clients/client-ec2/commands/EnableTransitGatewayRouteTablePropagationCommand.ts @@ -29,6 +29,20 @@ export interface EnableTransitGatewayRouteTablePropagationCommandOutput /** *

Enables the specified attachment to propagate routes to the specified * propagation route table.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { EC2Client, EnableTransitGatewayRouteTablePropagationCommand } from "@aws-sdk/client-ec2"; // ES Modules import + * // const { EC2Client, EnableTransitGatewayRouteTablePropagationCommand } = require("@aws-sdk/client-ec2"); // CommonJS import + * const client = new EC2Client(config); + * const command = new EnableTransitGatewayRouteTablePropagationCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link EnableTransitGatewayRouteTablePropagationCommandInput} for command's `input` shape. + * @see {@link EnableTransitGatewayRouteTablePropagationCommandOutput} for command's `response` shape. + * @see {@link EC2ClientResolvedConfig | config} for command's `input` shape. + * */ export class EnableTransitGatewayRouteTablePropagationCommand extends $Command< EnableTransitGatewayRouteTablePropagationCommandInput, diff --git a/clients/client-ec2/commands/EnableVgwRoutePropagationCommand.ts b/clients/client-ec2/commands/EnableVgwRoutePropagationCommand.ts index c129cd0c1510..fc60e5b4e47b 100644 --- a/clients/client-ec2/commands/EnableVgwRoutePropagationCommand.ts +++ b/clients/client-ec2/commands/EnableVgwRoutePropagationCommand.ts @@ -22,6 +22,20 @@ export interface EnableVgwRoutePropagationCommandOutput extends __MetadataBearer /** *

Enables a virtual private gateway (VGW) to propagate routes to the specified route table of a VPC.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { EC2Client, EnableVgwRoutePropagationCommand } from "@aws-sdk/client-ec2"; // ES Modules import + * // const { EC2Client, EnableVgwRoutePropagationCommand } = require("@aws-sdk/client-ec2"); // CommonJS import + * const client = new EC2Client(config); + * const command = new EnableVgwRoutePropagationCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link EnableVgwRoutePropagationCommandInput} for command's `input` shape. + * @see {@link EnableVgwRoutePropagationCommandOutput} for command's `response` shape. + * @see {@link EC2ClientResolvedConfig | config} for command's `input` shape. + * */ export class EnableVgwRoutePropagationCommand extends $Command< EnableVgwRoutePropagationCommandInput, diff --git a/clients/client-ec2/commands/EnableVolumeIOCommand.ts b/clients/client-ec2/commands/EnableVolumeIOCommand.ts index 8c1fe2f5128c..34a111837140 100644 --- a/clients/client-ec2/commands/EnableVolumeIOCommand.ts +++ b/clients/client-ec2/commands/EnableVolumeIOCommand.ts @@ -20,6 +20,20 @@ export interface EnableVolumeIOCommandOutput extends __MetadataBearer {} /** *

Enables I/O operations for a volume that had I/O operations disabled because the data on * the volume was potentially inconsistent.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { EC2Client, EnableVolumeIOCommand } from "@aws-sdk/client-ec2"; // ES Modules import + * // const { EC2Client, EnableVolumeIOCommand } = require("@aws-sdk/client-ec2"); // CommonJS import + * const client = new EC2Client(config); + * const command = new EnableVolumeIOCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link EnableVolumeIOCommandInput} for command's `input` shape. + * @see {@link EnableVolumeIOCommandOutput} for command's `response` shape. + * @see {@link EC2ClientResolvedConfig | config} for command's `input` shape. + * */ export class EnableVolumeIOCommand extends $Command< EnableVolumeIOCommandInput, diff --git a/clients/client-ec2/commands/EnableVpcClassicLinkCommand.ts b/clients/client-ec2/commands/EnableVpcClassicLinkCommand.ts index da25b41a7c45..fc2c181eb5de 100644 --- a/clients/client-ec2/commands/EnableVpcClassicLinkCommand.ts +++ b/clients/client-ec2/commands/EnableVpcClassicLinkCommand.ts @@ -28,6 +28,20 @@ export interface EnableVpcClassicLinkCommandOutput extends EnableVpcClassicLinkR * 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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { EC2Client, EnableVpcClassicLinkCommand } from "@aws-sdk/client-ec2"; // ES Modules import + * // const { EC2Client, EnableVpcClassicLinkCommand } = require("@aws-sdk/client-ec2"); // CommonJS import + * const client = new EC2Client(config); + * const command = new EnableVpcClassicLinkCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link EnableVpcClassicLinkCommandInput} for command's `input` shape. + * @see {@link EnableVpcClassicLinkCommandOutput} for command's `response` shape. + * @see {@link EC2ClientResolvedConfig | config} for command's `input` shape. + * */ export class EnableVpcClassicLinkCommand extends $Command< EnableVpcClassicLinkCommandInput, diff --git a/clients/client-ec2/commands/EnableVpcClassicLinkDnsSupportCommand.ts b/clients/client-ec2/commands/EnableVpcClassicLinkDnsSupportCommand.ts index df8b9bfadf2e..d3d678bcbe90 100644 --- a/clients/client-ec2/commands/EnableVpcClassicLinkDnsSupportCommand.ts +++ b/clients/client-ec2/commands/EnableVpcClassicLinkDnsSupportCommand.ts @@ -30,6 +30,20 @@ export interface EnableVpcClassicLinkDnsSupportCommandOutput * 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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { EC2Client, EnableVpcClassicLinkDnsSupportCommand } from "@aws-sdk/client-ec2"; // ES Modules import + * // const { EC2Client, EnableVpcClassicLinkDnsSupportCommand } = require("@aws-sdk/client-ec2"); // CommonJS import + * const client = new EC2Client(config); + * const command = new EnableVpcClassicLinkDnsSupportCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link EnableVpcClassicLinkDnsSupportCommandInput} for command's `input` shape. + * @see {@link EnableVpcClassicLinkDnsSupportCommandOutput} for command's `response` shape. + * @see {@link EC2ClientResolvedConfig | config} for command's `input` shape. + * */ export class EnableVpcClassicLinkDnsSupportCommand extends $Command< EnableVpcClassicLinkDnsSupportCommandInput, diff --git a/clients/client-ec2/commands/ExportClientVpnClientCertificateRevocationListCommand.ts b/clients/client-ec2/commands/ExportClientVpnClientCertificateRevocationListCommand.ts index f271deab7aa8..5f410776de3a 100644 --- a/clients/client-ec2/commands/ExportClientVpnClientCertificateRevocationListCommand.ts +++ b/clients/client-ec2/commands/ExportClientVpnClientCertificateRevocationListCommand.ts @@ -28,6 +28,20 @@ export interface ExportClientVpnClientCertificateRevocationListCommandOutput /** *

Downloads the client certificate revocation list for the specified Client VPN endpoint.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { EC2Client, ExportClientVpnClientCertificateRevocationListCommand } from "@aws-sdk/client-ec2"; // ES Modules import + * // const { EC2Client, ExportClientVpnClientCertificateRevocationListCommand } = require("@aws-sdk/client-ec2"); // CommonJS import + * const client = new EC2Client(config); + * const command = new ExportClientVpnClientCertificateRevocationListCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ExportClientVpnClientCertificateRevocationListCommandInput} for command's `input` shape. + * @see {@link ExportClientVpnClientCertificateRevocationListCommandOutput} for command's `response` shape. + * @see {@link EC2ClientResolvedConfig | config} for command's `input` shape. + * */ export class ExportClientVpnClientCertificateRevocationListCommand extends $Command< ExportClientVpnClientCertificateRevocationListCommandInput, diff --git a/clients/client-ec2/commands/ExportClientVpnClientConfigurationCommand.ts b/clients/client-ec2/commands/ExportClientVpnClientConfigurationCommand.ts index 77d85b228743..d3a44bb7080d 100644 --- a/clients/client-ec2/commands/ExportClientVpnClientConfigurationCommand.ts +++ b/clients/client-ec2/commands/ExportClientVpnClientConfigurationCommand.ts @@ -29,6 +29,20 @@ export interface ExportClientVpnClientConfigurationCommandOutput *

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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { EC2Client, ExportClientVpnClientConfigurationCommand } from "@aws-sdk/client-ec2"; // ES Modules import + * // const { EC2Client, ExportClientVpnClientConfigurationCommand } = require("@aws-sdk/client-ec2"); // CommonJS import + * const client = new EC2Client(config); + * const command = new ExportClientVpnClientConfigurationCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ExportClientVpnClientConfigurationCommandInput} for command's `input` shape. + * @see {@link ExportClientVpnClientConfigurationCommandOutput} for command's `response` shape. + * @see {@link EC2ClientResolvedConfig | config} for command's `input` shape. + * */ export class ExportClientVpnClientConfigurationCommand extends $Command< ExportClientVpnClientConfigurationCommandInput, diff --git a/clients/client-ec2/commands/ExportImageCommand.ts b/clients/client-ec2/commands/ExportImageCommand.ts index b29d090970fa..47b131add709 100644 --- a/clients/client-ec2/commands/ExportImageCommand.ts +++ b/clients/client-ec2/commands/ExportImageCommand.ts @@ -21,6 +21,20 @@ export interface ExportImageCommandOutput extends ExportImageResult, __MetadataB *

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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { EC2Client, ExportImageCommand } from "@aws-sdk/client-ec2"; // ES Modules import + * // const { EC2Client, ExportImageCommand } = require("@aws-sdk/client-ec2"); // CommonJS import + * const client = new EC2Client(config); + * const command = new ExportImageCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ExportImageCommandInput} for command's `input` shape. + * @see {@link ExportImageCommandOutput} for command's `response` shape. + * @see {@link EC2ClientResolvedConfig | config} for command's `input` shape. + * */ export class ExportImageCommand extends $Command< ExportImageCommandInput, diff --git a/clients/client-ec2/commands/ExportTransitGatewayRoutesCommand.ts b/clients/client-ec2/commands/ExportTransitGatewayRoutesCommand.ts index e2902eead89f..c0b07f8453f0 100644 --- a/clients/client-ec2/commands/ExportTransitGatewayRoutesCommand.ts +++ b/clients/client-ec2/commands/ExportTransitGatewayRoutesCommand.ts @@ -26,6 +26,20 @@ export interface ExportTransitGatewayRoutesCommandOutput extends ExportTransitGa *

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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { EC2Client, ExportTransitGatewayRoutesCommand } from "@aws-sdk/client-ec2"; // ES Modules import + * // const { EC2Client, ExportTransitGatewayRoutesCommand } = require("@aws-sdk/client-ec2"); // CommonJS import + * const client = new EC2Client(config); + * const command = new ExportTransitGatewayRoutesCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ExportTransitGatewayRoutesCommandInput} for command's `input` shape. + * @see {@link ExportTransitGatewayRoutesCommandOutput} for command's `response` shape. + * @see {@link EC2ClientResolvedConfig | config} for command's `input` shape. + * */ export class ExportTransitGatewayRoutesCommand extends $Command< ExportTransitGatewayRoutesCommandInput, diff --git a/clients/client-ec2/commands/GetAssociatedEnclaveCertificateIamRolesCommand.ts b/clients/client-ec2/commands/GetAssociatedEnclaveCertificateIamRolesCommand.ts index ff403a2c66a3..8f58dc83ff9a 100644 --- a/clients/client-ec2/commands/GetAssociatedEnclaveCertificateIamRolesCommand.ts +++ b/clients/client-ec2/commands/GetAssociatedEnclaveCertificateIamRolesCommand.ts @@ -31,6 +31,20 @@ export interface GetAssociatedEnclaveCertificateIamRolesCommandOutput * 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 AWS Key Management Service (KMS) customer master key (CMK) * that's used to encrypt the private key.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { EC2Client, GetAssociatedEnclaveCertificateIamRolesCommand } from "@aws-sdk/client-ec2"; // ES Modules import + * // const { EC2Client, GetAssociatedEnclaveCertificateIamRolesCommand } = require("@aws-sdk/client-ec2"); // CommonJS import + * const client = new EC2Client(config); + * const command = new GetAssociatedEnclaveCertificateIamRolesCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetAssociatedEnclaveCertificateIamRolesCommandInput} for command's `input` shape. + * @see {@link GetAssociatedEnclaveCertificateIamRolesCommandOutput} for command's `response` shape. + * @see {@link EC2ClientResolvedConfig | config} for command's `input` shape. + * */ export class GetAssociatedEnclaveCertificateIamRolesCommand extends $Command< GetAssociatedEnclaveCertificateIamRolesCommandInput, diff --git a/clients/client-ec2/commands/GetAssociatedIpv6PoolCidrsCommand.ts b/clients/client-ec2/commands/GetAssociatedIpv6PoolCidrsCommand.ts index dc82532e5449..f6027d783456 100644 --- a/clients/client-ec2/commands/GetAssociatedIpv6PoolCidrsCommand.ts +++ b/clients/client-ec2/commands/GetAssociatedIpv6PoolCidrsCommand.ts @@ -22,6 +22,20 @@ export interface GetAssociatedIpv6PoolCidrsCommandOutput extends GetAssociatedIp /** *

Gets information about the IPv6 CIDR block associations for a specified IPv6 address pool.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { EC2Client, GetAssociatedIpv6PoolCidrsCommand } from "@aws-sdk/client-ec2"; // ES Modules import + * // const { EC2Client, GetAssociatedIpv6PoolCidrsCommand } = require("@aws-sdk/client-ec2"); // CommonJS import + * const client = new EC2Client(config); + * const command = new GetAssociatedIpv6PoolCidrsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetAssociatedIpv6PoolCidrsCommandInput} for command's `input` shape. + * @see {@link GetAssociatedIpv6PoolCidrsCommandOutput} for command's `response` shape. + * @see {@link EC2ClientResolvedConfig | config} for command's `input` shape. + * */ export class GetAssociatedIpv6PoolCidrsCommand extends $Command< GetAssociatedIpv6PoolCidrsCommandInput, diff --git a/clients/client-ec2/commands/GetCapacityReservationUsageCommand.ts b/clients/client-ec2/commands/GetCapacityReservationUsageCommand.ts index 64610bf476d5..73281bdb6f4e 100644 --- a/clients/client-ec2/commands/GetCapacityReservationUsageCommand.ts +++ b/clients/client-ec2/commands/GetCapacityReservationUsageCommand.ts @@ -24,6 +24,20 @@ export interface GetCapacityReservationUsageCommandOutput extends GetCapacityRes *

Gets usage information about a Capacity Reservation. If the Capacity Reservation is shared, it shows usage information for the Capacity Reservation owner * and each AWS account that is currently using the shared capacity. If the Capacity Reservation is not shared, it shows only * the Capacity Reservation owner's usage.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { EC2Client, GetCapacityReservationUsageCommand } from "@aws-sdk/client-ec2"; // ES Modules import + * // const { EC2Client, GetCapacityReservationUsageCommand } = require("@aws-sdk/client-ec2"); // CommonJS import + * const client = new EC2Client(config); + * const command = new GetCapacityReservationUsageCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetCapacityReservationUsageCommandInput} for command's `input` shape. + * @see {@link GetCapacityReservationUsageCommandOutput} for command's `response` shape. + * @see {@link EC2ClientResolvedConfig | config} for command's `input` shape. + * */ export class GetCapacityReservationUsageCommand extends $Command< GetCapacityReservationUsageCommandInput, diff --git a/clients/client-ec2/commands/GetCoipPoolUsageCommand.ts b/clients/client-ec2/commands/GetCoipPoolUsageCommand.ts index 2ece387f07c9..9697a5193a94 100644 --- a/clients/client-ec2/commands/GetCoipPoolUsageCommand.ts +++ b/clients/client-ec2/commands/GetCoipPoolUsageCommand.ts @@ -22,6 +22,20 @@ export interface GetCoipPoolUsageCommandOutput extends GetCoipPoolUsageResult, _ /** *

Describes the allocations from the specified customer-owned address pool.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { EC2Client, GetCoipPoolUsageCommand } from "@aws-sdk/client-ec2"; // ES Modules import + * // const { EC2Client, GetCoipPoolUsageCommand } = require("@aws-sdk/client-ec2"); // CommonJS import + * const client = new EC2Client(config); + * const command = new GetCoipPoolUsageCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetCoipPoolUsageCommandInput} for command's `input` shape. + * @see {@link GetCoipPoolUsageCommandOutput} for command's `response` shape. + * @see {@link EC2ClientResolvedConfig | config} for command's `input` shape. + * */ export class GetCoipPoolUsageCommand extends $Command< GetCoipPoolUsageCommandInput, diff --git a/clients/client-ec2/commands/GetConsoleOutputCommand.ts b/clients/client-ec2/commands/GetConsoleOutputCommand.ts index 334aac0ecaf9..8347f22783ee 100644 --- a/clients/client-ec2/commands/GetConsoleOutputCommand.ts +++ b/clients/client-ec2/commands/GetConsoleOutputCommand.ts @@ -34,6 +34,20 @@ export interface GetConsoleOutputCommandOutput extends GetConsoleOutputResult, _ * hypervisor.

*

For more information, see Instance * console output in the Amazon EC2 User Guide.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { EC2Client, GetConsoleOutputCommand } from "@aws-sdk/client-ec2"; // ES Modules import + * // const { EC2Client, GetConsoleOutputCommand } = require("@aws-sdk/client-ec2"); // CommonJS import + * const client = new EC2Client(config); + * const command = new GetConsoleOutputCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetConsoleOutputCommandInput} for command's `input` shape. + * @see {@link GetConsoleOutputCommandOutput} for command's `response` shape. + * @see {@link EC2ClientResolvedConfig | config} for command's `input` shape. + * */ export class GetConsoleOutputCommand extends $Command< GetConsoleOutputCommandInput, diff --git a/clients/client-ec2/commands/GetConsoleScreenshotCommand.ts b/clients/client-ec2/commands/GetConsoleScreenshotCommand.ts index e3a37f9d6ee3..af0c746618e4 100644 --- a/clients/client-ec2/commands/GetConsoleScreenshotCommand.ts +++ b/clients/client-ec2/commands/GetConsoleScreenshotCommand.ts @@ -24,6 +24,20 @@ export interface GetConsoleScreenshotCommandOutput extends GetConsoleScreenshotR *

Retrieve a JPG-format screenshot of a running instance to help with * troubleshooting.

*

The returned content is Base64-encoded.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { EC2Client, GetConsoleScreenshotCommand } from "@aws-sdk/client-ec2"; // ES Modules import + * // const { EC2Client, GetConsoleScreenshotCommand } = require("@aws-sdk/client-ec2"); // CommonJS import + * const client = new EC2Client(config); + * const command = new GetConsoleScreenshotCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetConsoleScreenshotCommandInput} for command's `input` shape. + * @see {@link GetConsoleScreenshotCommandOutput} for command's `response` shape. + * @see {@link EC2ClientResolvedConfig | config} for command's `input` shape. + * */ export class GetConsoleScreenshotCommand extends $Command< GetConsoleScreenshotCommandInput, diff --git a/clients/client-ec2/commands/GetDefaultCreditSpecificationCommand.ts b/clients/client-ec2/commands/GetDefaultCreditSpecificationCommand.ts index ae60f7eaebbd..5f9e150bf0eb 100644 --- a/clients/client-ec2/commands/GetDefaultCreditSpecificationCommand.ts +++ b/clients/client-ec2/commands/GetDefaultCreditSpecificationCommand.ts @@ -26,6 +26,20 @@ export interface GetDefaultCreditSpecificationCommandOutput *

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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { EC2Client, GetDefaultCreditSpecificationCommand } from "@aws-sdk/client-ec2"; // ES Modules import + * // const { EC2Client, GetDefaultCreditSpecificationCommand } = require("@aws-sdk/client-ec2"); // CommonJS import + * const client = new EC2Client(config); + * const command = new GetDefaultCreditSpecificationCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetDefaultCreditSpecificationCommandInput} for command's `input` shape. + * @see {@link GetDefaultCreditSpecificationCommandOutput} for command's `response` shape. + * @see {@link EC2ClientResolvedConfig | config} for command's `input` shape. + * */ export class GetDefaultCreditSpecificationCommand extends $Command< GetDefaultCreditSpecificationCommandInput, diff --git a/clients/client-ec2/commands/GetEbsDefaultKmsKeyIdCommand.ts b/clients/client-ec2/commands/GetEbsDefaultKmsKeyIdCommand.ts index 90bcdf64b7ba..7263b3f8cae9 100644 --- a/clients/client-ec2/commands/GetEbsDefaultKmsKeyIdCommand.ts +++ b/clients/client-ec2/commands/GetEbsDefaultKmsKeyIdCommand.ts @@ -26,6 +26,20 @@ export interface GetEbsDefaultKmsKeyIdCommandOutput extends GetEbsDefaultKmsKeyI * ResetEbsDefaultKmsKeyId.

*

For more information, see Amazon EBS encryption * in the Amazon Elastic Compute Cloud User Guide.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { EC2Client, GetEbsDefaultKmsKeyIdCommand } from "@aws-sdk/client-ec2"; // ES Modules import + * // const { EC2Client, GetEbsDefaultKmsKeyIdCommand } = require("@aws-sdk/client-ec2"); // CommonJS import + * const client = new EC2Client(config); + * const command = new GetEbsDefaultKmsKeyIdCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetEbsDefaultKmsKeyIdCommandInput} for command's `input` shape. + * @see {@link GetEbsDefaultKmsKeyIdCommandOutput} for command's `response` shape. + * @see {@link EC2ClientResolvedConfig | config} for command's `input` shape. + * */ export class GetEbsDefaultKmsKeyIdCommand extends $Command< GetEbsDefaultKmsKeyIdCommandInput, diff --git a/clients/client-ec2/commands/GetEbsEncryptionByDefaultCommand.ts b/clients/client-ec2/commands/GetEbsEncryptionByDefaultCommand.ts index 383388c419fb..fa888e2f274e 100644 --- a/clients/client-ec2/commands/GetEbsEncryptionByDefaultCommand.ts +++ b/clients/client-ec2/commands/GetEbsEncryptionByDefaultCommand.ts @@ -25,6 +25,20 @@ export interface GetEbsEncryptionByDefaultCommandOutput extends GetEbsEncryption * Region.

*

For more information, see Amazon EBS encryption * in the Amazon Elastic Compute Cloud User Guide.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { EC2Client, GetEbsEncryptionByDefaultCommand } from "@aws-sdk/client-ec2"; // ES Modules import + * // const { EC2Client, GetEbsEncryptionByDefaultCommand } = require("@aws-sdk/client-ec2"); // CommonJS import + * const client = new EC2Client(config); + * const command = new GetEbsEncryptionByDefaultCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetEbsEncryptionByDefaultCommandInput} for command's `input` shape. + * @see {@link GetEbsEncryptionByDefaultCommandOutput} for command's `response` shape. + * @see {@link EC2ClientResolvedConfig | config} for command's `input` shape. + * */ export class GetEbsEncryptionByDefaultCommand extends $Command< GetEbsEncryptionByDefaultCommandInput, diff --git a/clients/client-ec2/commands/GetFlowLogsIntegrationTemplateCommand.ts b/clients/client-ec2/commands/GetFlowLogsIntegrationTemplateCommand.ts index 7a36a2c9904a..b78078521658 100644 --- a/clients/client-ec2/commands/GetFlowLogsIntegrationTemplateCommand.ts +++ b/clients/client-ec2/commands/GetFlowLogsIntegrationTemplateCommand.ts @@ -41,6 +41,20 @@ export interface GetFlowLogsIntegrationTemplateCommandOutput *

Create a set of named queries in Athena that you can use to get started quickly

* * + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { EC2Client, GetFlowLogsIntegrationTemplateCommand } from "@aws-sdk/client-ec2"; // ES Modules import + * // const { EC2Client, GetFlowLogsIntegrationTemplateCommand } = require("@aws-sdk/client-ec2"); // CommonJS import + * const client = new EC2Client(config); + * const command = new GetFlowLogsIntegrationTemplateCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetFlowLogsIntegrationTemplateCommandInput} for command's `input` shape. + * @see {@link GetFlowLogsIntegrationTemplateCommandOutput} for command's `response` shape. + * @see {@link EC2ClientResolvedConfig | config} for command's `input` shape. + * */ export class GetFlowLogsIntegrationTemplateCommand extends $Command< GetFlowLogsIntegrationTemplateCommandInput, diff --git a/clients/client-ec2/commands/GetGroupsForCapacityReservationCommand.ts b/clients/client-ec2/commands/GetGroupsForCapacityReservationCommand.ts index 897063954722..e467829d2a7a 100644 --- a/clients/client-ec2/commands/GetGroupsForCapacityReservationCommand.ts +++ b/clients/client-ec2/commands/GetGroupsForCapacityReservationCommand.ts @@ -24,6 +24,20 @@ export interface GetGroupsForCapacityReservationCommandOutput /** *

Lists the resource groups to which a Capacity Reservation has been added.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { EC2Client, GetGroupsForCapacityReservationCommand } from "@aws-sdk/client-ec2"; // ES Modules import + * // const { EC2Client, GetGroupsForCapacityReservationCommand } = require("@aws-sdk/client-ec2"); // CommonJS import + * const client = new EC2Client(config); + * const command = new GetGroupsForCapacityReservationCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetGroupsForCapacityReservationCommandInput} for command's `input` shape. + * @see {@link GetGroupsForCapacityReservationCommandOutput} for command's `response` shape. + * @see {@link EC2ClientResolvedConfig | config} for command's `input` shape. + * */ export class GetGroupsForCapacityReservationCommand extends $Command< GetGroupsForCapacityReservationCommandInput, diff --git a/clients/client-ec2/commands/GetHostReservationPurchasePreviewCommand.ts b/clients/client-ec2/commands/GetHostReservationPurchasePreviewCommand.ts index d1911447d2e9..45a311447807 100644 --- a/clients/client-ec2/commands/GetHostReservationPurchasePreviewCommand.ts +++ b/clients/client-ec2/commands/GetHostReservationPurchasePreviewCommand.ts @@ -28,6 +28,20 @@ export interface GetHostReservationPurchasePreviewCommandOutput * a reservation.

*

This is a preview of the PurchaseHostReservation action and does * not result in the offering being purchased.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { EC2Client, GetHostReservationPurchasePreviewCommand } from "@aws-sdk/client-ec2"; // ES Modules import + * // const { EC2Client, GetHostReservationPurchasePreviewCommand } = require("@aws-sdk/client-ec2"); // CommonJS import + * const client = new EC2Client(config); + * const command = new GetHostReservationPurchasePreviewCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetHostReservationPurchasePreviewCommandInput} for command's `input` shape. + * @see {@link GetHostReservationPurchasePreviewCommandOutput} for command's `response` shape. + * @see {@link EC2ClientResolvedConfig | config} for command's `input` shape. + * */ export class GetHostReservationPurchasePreviewCommand extends $Command< GetHostReservationPurchasePreviewCommandInput, diff --git a/clients/client-ec2/commands/GetLaunchTemplateDataCommand.ts b/clients/client-ec2/commands/GetLaunchTemplateDataCommand.ts index 21172ffde1ba..a8da30e4dd81 100644 --- a/clients/client-ec2/commands/GetLaunchTemplateDataCommand.ts +++ b/clients/client-ec2/commands/GetLaunchTemplateDataCommand.ts @@ -26,6 +26,20 @@ export interface GetLaunchTemplateDataCommandOutput extends GetLaunchTemplateDat *

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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { EC2Client, GetLaunchTemplateDataCommand } from "@aws-sdk/client-ec2"; // ES Modules import + * // const { EC2Client, GetLaunchTemplateDataCommand } = require("@aws-sdk/client-ec2"); // CommonJS import + * const client = new EC2Client(config); + * const command = new GetLaunchTemplateDataCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetLaunchTemplateDataCommandInput} for command's `input` shape. + * @see {@link GetLaunchTemplateDataCommandOutput} for command's `response` shape. + * @see {@link EC2ClientResolvedConfig | config} for command's `input` shape. + * */ export class GetLaunchTemplateDataCommand extends $Command< GetLaunchTemplateDataCommandInput, diff --git a/clients/client-ec2/commands/GetManagedPrefixListAssociationsCommand.ts b/clients/client-ec2/commands/GetManagedPrefixListAssociationsCommand.ts index 339a65514c7c..e7a07a0e4122 100644 --- a/clients/client-ec2/commands/GetManagedPrefixListAssociationsCommand.ts +++ b/clients/client-ec2/commands/GetManagedPrefixListAssociationsCommand.ts @@ -24,6 +24,20 @@ export interface GetManagedPrefixListAssociationsCommandOutput /** *

Gets information about the resources that are associated with the specified managed prefix list.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { EC2Client, GetManagedPrefixListAssociationsCommand } from "@aws-sdk/client-ec2"; // ES Modules import + * // const { EC2Client, GetManagedPrefixListAssociationsCommand } = require("@aws-sdk/client-ec2"); // CommonJS import + * const client = new EC2Client(config); + * const command = new GetManagedPrefixListAssociationsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetManagedPrefixListAssociationsCommandInput} for command's `input` shape. + * @see {@link GetManagedPrefixListAssociationsCommandOutput} for command's `response` shape. + * @see {@link EC2ClientResolvedConfig | config} for command's `input` shape. + * */ export class GetManagedPrefixListAssociationsCommand extends $Command< GetManagedPrefixListAssociationsCommandInput, diff --git a/clients/client-ec2/commands/GetManagedPrefixListEntriesCommand.ts b/clients/client-ec2/commands/GetManagedPrefixListEntriesCommand.ts index 06a1132be07c..978fd58f3457 100644 --- a/clients/client-ec2/commands/GetManagedPrefixListEntriesCommand.ts +++ b/clients/client-ec2/commands/GetManagedPrefixListEntriesCommand.ts @@ -22,6 +22,20 @@ export interface GetManagedPrefixListEntriesCommandOutput extends GetManagedPref /** *

Gets information about the entries for a specified managed prefix list.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { EC2Client, GetManagedPrefixListEntriesCommand } from "@aws-sdk/client-ec2"; // ES Modules import + * // const { EC2Client, GetManagedPrefixListEntriesCommand } = require("@aws-sdk/client-ec2"); // CommonJS import + * const client = new EC2Client(config); + * const command = new GetManagedPrefixListEntriesCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetManagedPrefixListEntriesCommandInput} for command's `input` shape. + * @see {@link GetManagedPrefixListEntriesCommandOutput} for command's `response` shape. + * @see {@link EC2ClientResolvedConfig | config} for command's `input` shape. + * */ export class GetManagedPrefixListEntriesCommand extends $Command< GetManagedPrefixListEntriesCommandInput, diff --git a/clients/client-ec2/commands/GetPasswordDataCommand.ts b/clients/client-ec2/commands/GetPasswordDataCommand.ts index 566a830420e0..c86b6cd24ccc 100644 --- a/clients/client-ec2/commands/GetPasswordDataCommand.ts +++ b/clients/client-ec2/commands/GetPasswordDataCommand.ts @@ -31,6 +31,20 @@ export interface GetPasswordDataCommandOutput extends GetPasswordDataResult, __M * 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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { EC2Client, GetPasswordDataCommand } from "@aws-sdk/client-ec2"; // ES Modules import + * // const { EC2Client, GetPasswordDataCommand } = require("@aws-sdk/client-ec2"); // CommonJS import + * const client = new EC2Client(config); + * const command = new GetPasswordDataCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetPasswordDataCommandInput} for command's `input` shape. + * @see {@link GetPasswordDataCommandOutput} for command's `response` shape. + * @see {@link EC2ClientResolvedConfig | config} for command's `input` shape. + * */ export class GetPasswordDataCommand extends $Command< GetPasswordDataCommandInput, diff --git a/clients/client-ec2/commands/GetReservedInstancesExchangeQuoteCommand.ts b/clients/client-ec2/commands/GetReservedInstancesExchangeQuoteCommand.ts index c2737f7aefee..23826788fdf9 100644 --- a/clients/client-ec2/commands/GetReservedInstancesExchangeQuoteCommand.ts +++ b/clients/client-ec2/commands/GetReservedInstancesExchangeQuoteCommand.ts @@ -26,6 +26,20 @@ export interface GetReservedInstancesExchangeQuoteCommandOutput *

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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { EC2Client, GetReservedInstancesExchangeQuoteCommand } from "@aws-sdk/client-ec2"; // ES Modules import + * // const { EC2Client, GetReservedInstancesExchangeQuoteCommand } = require("@aws-sdk/client-ec2"); // CommonJS import + * const client = new EC2Client(config); + * const command = new GetReservedInstancesExchangeQuoteCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetReservedInstancesExchangeQuoteCommandInput} for command's `input` shape. + * @see {@link GetReservedInstancesExchangeQuoteCommandOutput} for command's `response` shape. + * @see {@link EC2ClientResolvedConfig | config} for command's `input` shape. + * */ export class GetReservedInstancesExchangeQuoteCommand extends $Command< GetReservedInstancesExchangeQuoteCommandInput, diff --git a/clients/client-ec2/commands/GetSerialConsoleAccessStatusCommand.ts b/clients/client-ec2/commands/GetSerialConsoleAccessStatusCommand.ts index a20d3c17c97a..3d7d9c35df6b 100644 --- a/clients/client-ec2/commands/GetSerialConsoleAccessStatusCommand.ts +++ b/clients/client-ec2/commands/GetSerialConsoleAccessStatusCommand.ts @@ -27,6 +27,20 @@ export interface GetSerialConsoleAccessStatusCommandOutput * 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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { EC2Client, GetSerialConsoleAccessStatusCommand } from "@aws-sdk/client-ec2"; // ES Modules import + * // const { EC2Client, GetSerialConsoleAccessStatusCommand } = require("@aws-sdk/client-ec2"); // CommonJS import + * const client = new EC2Client(config); + * const command = new GetSerialConsoleAccessStatusCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetSerialConsoleAccessStatusCommandInput} for command's `input` shape. + * @see {@link GetSerialConsoleAccessStatusCommandOutput} for command's `response` shape. + * @see {@link EC2ClientResolvedConfig | config} for command's `input` shape. + * */ export class GetSerialConsoleAccessStatusCommand extends $Command< GetSerialConsoleAccessStatusCommandInput, diff --git a/clients/client-ec2/commands/GetTransitGatewayAttachmentPropagationsCommand.ts b/clients/client-ec2/commands/GetTransitGatewayAttachmentPropagationsCommand.ts index 208c73a544f5..96bb13d05854 100644 --- a/clients/client-ec2/commands/GetTransitGatewayAttachmentPropagationsCommand.ts +++ b/clients/client-ec2/commands/GetTransitGatewayAttachmentPropagationsCommand.ts @@ -28,6 +28,20 @@ export interface GetTransitGatewayAttachmentPropagationsCommandOutput /** *

Lists the route tables to which the specified resource attachment propagates routes.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { EC2Client, GetTransitGatewayAttachmentPropagationsCommand } from "@aws-sdk/client-ec2"; // ES Modules import + * // const { EC2Client, GetTransitGatewayAttachmentPropagationsCommand } = require("@aws-sdk/client-ec2"); // CommonJS import + * const client = new EC2Client(config); + * const command = new GetTransitGatewayAttachmentPropagationsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetTransitGatewayAttachmentPropagationsCommandInput} for command's `input` shape. + * @see {@link GetTransitGatewayAttachmentPropagationsCommandOutput} for command's `response` shape. + * @see {@link EC2ClientResolvedConfig | config} for command's `input` shape. + * */ export class GetTransitGatewayAttachmentPropagationsCommand extends $Command< GetTransitGatewayAttachmentPropagationsCommandInput, diff --git a/clients/client-ec2/commands/GetTransitGatewayMulticastDomainAssociationsCommand.ts b/clients/client-ec2/commands/GetTransitGatewayMulticastDomainAssociationsCommand.ts index 637ecb99c844..12857bb74fbf 100644 --- a/clients/client-ec2/commands/GetTransitGatewayMulticastDomainAssociationsCommand.ts +++ b/clients/client-ec2/commands/GetTransitGatewayMulticastDomainAssociationsCommand.ts @@ -28,6 +28,20 @@ export interface GetTransitGatewayMulticastDomainAssociationsCommandOutput /** *

Gets information about the associations for the transit gateway multicast domain.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { EC2Client, GetTransitGatewayMulticastDomainAssociationsCommand } from "@aws-sdk/client-ec2"; // ES Modules import + * // const { EC2Client, GetTransitGatewayMulticastDomainAssociationsCommand } = require("@aws-sdk/client-ec2"); // CommonJS import + * const client = new EC2Client(config); + * const command = new GetTransitGatewayMulticastDomainAssociationsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetTransitGatewayMulticastDomainAssociationsCommandInput} for command's `input` shape. + * @see {@link GetTransitGatewayMulticastDomainAssociationsCommandOutput} for command's `response` shape. + * @see {@link EC2ClientResolvedConfig | config} for command's `input` shape. + * */ export class GetTransitGatewayMulticastDomainAssociationsCommand extends $Command< GetTransitGatewayMulticastDomainAssociationsCommandInput, diff --git a/clients/client-ec2/commands/GetTransitGatewayPrefixListReferencesCommand.ts b/clients/client-ec2/commands/GetTransitGatewayPrefixListReferencesCommand.ts index 8c1d4e4b7f47..eb9ddb063465 100644 --- a/clients/client-ec2/commands/GetTransitGatewayPrefixListReferencesCommand.ts +++ b/clients/client-ec2/commands/GetTransitGatewayPrefixListReferencesCommand.ts @@ -28,6 +28,20 @@ export interface GetTransitGatewayPrefixListReferencesCommandOutput /** *

Gets information about the prefix list references in a specified transit gateway route table.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { EC2Client, GetTransitGatewayPrefixListReferencesCommand } from "@aws-sdk/client-ec2"; // ES Modules import + * // const { EC2Client, GetTransitGatewayPrefixListReferencesCommand } = require("@aws-sdk/client-ec2"); // CommonJS import + * const client = new EC2Client(config); + * const command = new GetTransitGatewayPrefixListReferencesCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetTransitGatewayPrefixListReferencesCommandInput} for command's `input` shape. + * @see {@link GetTransitGatewayPrefixListReferencesCommandOutput} for command's `response` shape. + * @see {@link EC2ClientResolvedConfig | config} for command's `input` shape. + * */ export class GetTransitGatewayPrefixListReferencesCommand extends $Command< GetTransitGatewayPrefixListReferencesCommandInput, diff --git a/clients/client-ec2/commands/GetTransitGatewayRouteTableAssociationsCommand.ts b/clients/client-ec2/commands/GetTransitGatewayRouteTableAssociationsCommand.ts index cda81357b9bc..ba77de8dab22 100644 --- a/clients/client-ec2/commands/GetTransitGatewayRouteTableAssociationsCommand.ts +++ b/clients/client-ec2/commands/GetTransitGatewayRouteTableAssociationsCommand.ts @@ -28,6 +28,20 @@ export interface GetTransitGatewayRouteTableAssociationsCommandOutput /** *

Gets information about the associations for the specified transit gateway route table.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { EC2Client, GetTransitGatewayRouteTableAssociationsCommand } from "@aws-sdk/client-ec2"; // ES Modules import + * // const { EC2Client, GetTransitGatewayRouteTableAssociationsCommand } = require("@aws-sdk/client-ec2"); // CommonJS import + * const client = new EC2Client(config); + * const command = new GetTransitGatewayRouteTableAssociationsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetTransitGatewayRouteTableAssociationsCommandInput} for command's `input` shape. + * @see {@link GetTransitGatewayRouteTableAssociationsCommandOutput} for command's `response` shape. + * @see {@link EC2ClientResolvedConfig | config} for command's `input` shape. + * */ export class GetTransitGatewayRouteTableAssociationsCommand extends $Command< GetTransitGatewayRouteTableAssociationsCommandInput, diff --git a/clients/client-ec2/commands/GetTransitGatewayRouteTablePropagationsCommand.ts b/clients/client-ec2/commands/GetTransitGatewayRouteTablePropagationsCommand.ts index cb1a38529333..7b6ca771f453 100644 --- a/clients/client-ec2/commands/GetTransitGatewayRouteTablePropagationsCommand.ts +++ b/clients/client-ec2/commands/GetTransitGatewayRouteTablePropagationsCommand.ts @@ -28,6 +28,20 @@ export interface GetTransitGatewayRouteTablePropagationsCommandOutput /** *

Gets information about the route table propagations for the specified transit gateway route table.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { EC2Client, GetTransitGatewayRouteTablePropagationsCommand } from "@aws-sdk/client-ec2"; // ES Modules import + * // const { EC2Client, GetTransitGatewayRouteTablePropagationsCommand } = require("@aws-sdk/client-ec2"); // CommonJS import + * const client = new EC2Client(config); + * const command = new GetTransitGatewayRouteTablePropagationsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetTransitGatewayRouteTablePropagationsCommandInput} for command's `input` shape. + * @see {@link GetTransitGatewayRouteTablePropagationsCommandOutput} for command's `response` shape. + * @see {@link EC2ClientResolvedConfig | config} for command's `input` shape. + * */ export class GetTransitGatewayRouteTablePropagationsCommand extends $Command< GetTransitGatewayRouteTablePropagationsCommandInput, diff --git a/clients/client-ec2/commands/ImportClientVpnClientCertificateRevocationListCommand.ts b/clients/client-ec2/commands/ImportClientVpnClientCertificateRevocationListCommand.ts index db310db763f4..ea55d219a5fd 100644 --- a/clients/client-ec2/commands/ImportClientVpnClientCertificateRevocationListCommand.ts +++ b/clients/client-ec2/commands/ImportClientVpnClientCertificateRevocationListCommand.ts @@ -29,6 +29,20 @@ export interface ImportClientVpnClientCertificateRevocationListCommandOutput /** *

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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { EC2Client, ImportClientVpnClientCertificateRevocationListCommand } from "@aws-sdk/client-ec2"; // ES Modules import + * // const { EC2Client, ImportClientVpnClientCertificateRevocationListCommand } = require("@aws-sdk/client-ec2"); // CommonJS import + * const client = new EC2Client(config); + * const command = new ImportClientVpnClientCertificateRevocationListCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ImportClientVpnClientCertificateRevocationListCommandInput} for command's `input` shape. + * @see {@link ImportClientVpnClientCertificateRevocationListCommandOutput} for command's `response` shape. + * @see {@link EC2ClientResolvedConfig | config} for command's `input` shape. + * */ export class ImportClientVpnClientCertificateRevocationListCommand extends $Command< ImportClientVpnClientCertificateRevocationListCommandInput, diff --git a/clients/client-ec2/commands/ImportImageCommand.ts b/clients/client-ec2/commands/ImportImageCommand.ts index f2c888bde486..22ca236f938e 100644 --- a/clients/client-ec2/commands/ImportImageCommand.ts +++ b/clients/client-ec2/commands/ImportImageCommand.ts @@ -21,6 +21,20 @@ export interface ImportImageCommandOutput extends ImportImageResult, __MetadataB *

Import single or multi-volume disk images or EBS snapshots into an Amazon Machine Image (AMI).

*

For more information, see Importing a * VM as an image using VM Import/Export in the VM Import/Export User Guide.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { EC2Client, ImportImageCommand } from "@aws-sdk/client-ec2"; // ES Modules import + * // const { EC2Client, ImportImageCommand } = require("@aws-sdk/client-ec2"); // CommonJS import + * const client = new EC2Client(config); + * const command = new ImportImageCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ImportImageCommandInput} for command's `input` shape. + * @see {@link ImportImageCommandOutput} for command's `response` shape. + * @see {@link EC2ClientResolvedConfig | config} for command's `input` shape. + * */ export class ImportImageCommand extends $Command< ImportImageCommandInput, diff --git a/clients/client-ec2/commands/ImportInstanceCommand.ts b/clients/client-ec2/commands/ImportInstanceCommand.ts index e3cad60de75c..5f9d55cefe45 100644 --- a/clients/client-ec2/commands/ImportInstanceCommand.ts +++ b/clients/client-ec2/commands/ImportInstanceCommand.ts @@ -25,6 +25,20 @@ export interface ImportInstanceCommandOutput extends ImportInstanceResult, __Met * 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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { EC2Client, ImportInstanceCommand } from "@aws-sdk/client-ec2"; // ES Modules import + * // const { EC2Client, ImportInstanceCommand } = require("@aws-sdk/client-ec2"); // CommonJS import + * const client = new EC2Client(config); + * const command = new ImportInstanceCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ImportInstanceCommandInput} for command's `input` shape. + * @see {@link ImportInstanceCommandOutput} for command's `response` shape. + * @see {@link EC2ClientResolvedConfig | config} for command's `input` shape. + * */ export class ImportInstanceCommand extends $Command< ImportInstanceCommandInput, diff --git a/clients/client-ec2/commands/ImportKeyPairCommand.ts b/clients/client-ec2/commands/ImportKeyPairCommand.ts index eb5032ec31f0..31cc6681d488 100644 --- a/clients/client-ec2/commands/ImportKeyPairCommand.ts +++ b/clients/client-ec2/commands/ImportKeyPairCommand.ts @@ -24,6 +24,20 @@ export interface ImportKeyPairCommandOutput extends ImportKeyPairResult, __Metad * The private key is never transferred between you and AWS.

*

For more information about key pairs, see Key Pairs * in the Amazon Elastic Compute Cloud User Guide.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { EC2Client, ImportKeyPairCommand } from "@aws-sdk/client-ec2"; // ES Modules import + * // const { EC2Client, ImportKeyPairCommand } = require("@aws-sdk/client-ec2"); // CommonJS import + * const client = new EC2Client(config); + * const command = new ImportKeyPairCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ImportKeyPairCommandInput} for command's `input` shape. + * @see {@link ImportKeyPairCommandOutput} for command's `response` shape. + * @see {@link EC2ClientResolvedConfig | config} for command's `input` shape. + * */ export class ImportKeyPairCommand extends $Command< ImportKeyPairCommandInput, diff --git a/clients/client-ec2/commands/ImportSnapshotCommand.ts b/clients/client-ec2/commands/ImportSnapshotCommand.ts index c96b2121cbb8..f552b0a8bc36 100644 --- a/clients/client-ec2/commands/ImportSnapshotCommand.ts +++ b/clients/client-ec2/commands/ImportSnapshotCommand.ts @@ -21,6 +21,20 @@ export interface ImportSnapshotCommandOutput extends ImportSnapshotResult, __Met *

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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { EC2Client, ImportSnapshotCommand } from "@aws-sdk/client-ec2"; // ES Modules import + * // const { EC2Client, ImportSnapshotCommand } = require("@aws-sdk/client-ec2"); // CommonJS import + * const client = new EC2Client(config); + * const command = new ImportSnapshotCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ImportSnapshotCommandInput} for command's `input` shape. + * @see {@link ImportSnapshotCommandOutput} for command's `response` shape. + * @see {@link EC2ClientResolvedConfig | config} for command's `input` shape. + * */ export class ImportSnapshotCommand extends $Command< ImportSnapshotCommandInput, diff --git a/clients/client-ec2/commands/ImportVolumeCommand.ts b/clients/client-ec2/commands/ImportVolumeCommand.ts index f610dcd7c3b0..a2c62ec56148 100644 --- a/clients/client-ec2/commands/ImportVolumeCommand.ts +++ b/clients/client-ec2/commands/ImportVolumeCommand.ts @@ -25,6 +25,20 @@ export interface ImportVolumeCommandOutput extends ImportVolumeResult, __Metadat *

This API action is not supported by the AWS Command Line Interface (AWS 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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { EC2Client, ImportVolumeCommand } from "@aws-sdk/client-ec2"; // ES Modules import + * // const { EC2Client, ImportVolumeCommand } = require("@aws-sdk/client-ec2"); // CommonJS import + * const client = new EC2Client(config); + * const command = new ImportVolumeCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ImportVolumeCommandInput} for command's `input` shape. + * @see {@link ImportVolumeCommandOutput} for command's `response` shape. + * @see {@link EC2ClientResolvedConfig | config} for command's `input` shape. + * */ export class ImportVolumeCommand extends $Command< ImportVolumeCommandInput, diff --git a/clients/client-ec2/commands/ModifyAddressAttributeCommand.ts b/clients/client-ec2/commands/ModifyAddressAttributeCommand.ts index 41937fd7f1c0..e1118b5c8945 100644 --- a/clients/client-ec2/commands/ModifyAddressAttributeCommand.ts +++ b/clients/client-ec2/commands/ModifyAddressAttributeCommand.ts @@ -22,6 +22,20 @@ export interface ModifyAddressAttributeCommandOutput extends ModifyAddressAttrib /** *

Modifies an attribute of the specified Elastic IP address. For requirements, see Using reverse DNS for email applications.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { EC2Client, ModifyAddressAttributeCommand } from "@aws-sdk/client-ec2"; // ES Modules import + * // const { EC2Client, ModifyAddressAttributeCommand } = require("@aws-sdk/client-ec2"); // CommonJS import + * const client = new EC2Client(config); + * const command = new ModifyAddressAttributeCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ModifyAddressAttributeCommandInput} for command's `input` shape. + * @see {@link ModifyAddressAttributeCommandOutput} for command's `response` shape. + * @see {@link EC2ClientResolvedConfig | config} for command's `input` shape. + * */ export class ModifyAddressAttributeCommand extends $Command< ModifyAddressAttributeCommandInput, diff --git a/clients/client-ec2/commands/ModifyAvailabilityZoneGroupCommand.ts b/clients/client-ec2/commands/ModifyAvailabilityZoneGroupCommand.ts index 6d370d4c68bb..ff00a09f7bb6 100644 --- a/clients/client-ec2/commands/ModifyAvailabilityZoneGroupCommand.ts +++ b/clients/client-ec2/commands/ModifyAvailabilityZoneGroupCommand.ts @@ -25,6 +25,20 @@ export interface ModifyAvailabilityZoneGroupCommandOutput extends ModifyAvailabi * account.

*

Use * DescribeAvailabilityZones to view the value for GroupName.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { EC2Client, ModifyAvailabilityZoneGroupCommand } from "@aws-sdk/client-ec2"; // ES Modules import + * // const { EC2Client, ModifyAvailabilityZoneGroupCommand } = require("@aws-sdk/client-ec2"); // CommonJS import + * const client = new EC2Client(config); + * const command = new ModifyAvailabilityZoneGroupCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ModifyAvailabilityZoneGroupCommandInput} for command's `input` shape. + * @see {@link ModifyAvailabilityZoneGroupCommandOutput} for command's `response` shape. + * @see {@link EC2ClientResolvedConfig | config} for command's `input` shape. + * */ export class ModifyAvailabilityZoneGroupCommand extends $Command< ModifyAvailabilityZoneGroupCommandInput, diff --git a/clients/client-ec2/commands/ModifyCapacityReservationCommand.ts b/clients/client-ec2/commands/ModifyCapacityReservationCommand.ts index 61d3279bee61..e7ae246a0105 100644 --- a/clients/client-ec2/commands/ModifyCapacityReservationCommand.ts +++ b/clients/client-ec2/commands/ModifyCapacityReservationCommand.ts @@ -26,6 +26,20 @@ export interface ModifyCapacityReservationCommandOutput extends ModifyCapacityRe * 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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { EC2Client, ModifyCapacityReservationCommand } from "@aws-sdk/client-ec2"; // ES Modules import + * // const { EC2Client, ModifyCapacityReservationCommand } = require("@aws-sdk/client-ec2"); // CommonJS import + * const client = new EC2Client(config); + * const command = new ModifyCapacityReservationCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ModifyCapacityReservationCommandInput} for command's `input` shape. + * @see {@link ModifyCapacityReservationCommandOutput} for command's `response` shape. + * @see {@link EC2ClientResolvedConfig | config} for command's `input` shape. + * */ export class ModifyCapacityReservationCommand extends $Command< ModifyCapacityReservationCommandInput, diff --git a/clients/client-ec2/commands/ModifyClientVpnEndpointCommand.ts b/clients/client-ec2/commands/ModifyClientVpnEndpointCommand.ts index 352657bf68e5..928462fe318b 100644 --- a/clients/client-ec2/commands/ModifyClientVpnEndpointCommand.ts +++ b/clients/client-ec2/commands/ModifyClientVpnEndpointCommand.ts @@ -22,6 +22,20 @@ export interface ModifyClientVpnEndpointCommandOutput extends ModifyClientVpnEnd /** *

Modifies the specified Client VPN endpoint. Modifying the DNS server resets existing client connections.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { EC2Client, ModifyClientVpnEndpointCommand } from "@aws-sdk/client-ec2"; // ES Modules import + * // const { EC2Client, ModifyClientVpnEndpointCommand } = require("@aws-sdk/client-ec2"); // CommonJS import + * const client = new EC2Client(config); + * const command = new ModifyClientVpnEndpointCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ModifyClientVpnEndpointCommandInput} for command's `input` shape. + * @see {@link ModifyClientVpnEndpointCommandOutput} for command's `response` shape. + * @see {@link EC2ClientResolvedConfig | config} for command's `input` shape. + * */ export class ModifyClientVpnEndpointCommand extends $Command< ModifyClientVpnEndpointCommandInput, diff --git a/clients/client-ec2/commands/ModifyDefaultCreditSpecificationCommand.ts b/clients/client-ec2/commands/ModifyDefaultCreditSpecificationCommand.ts index 8ba01ed3b170..ce1cb52dbbe9 100644 --- a/clients/client-ec2/commands/ModifyDefaultCreditSpecificationCommand.ts +++ b/clients/client-ec2/commands/ModifyDefaultCreditSpecificationCommand.ts @@ -36,6 +36,20 @@ export interface ModifyDefaultCreditSpecificationCommandOutput * DefaultCreditSpecification for updates.

*

For more information, see Burstable * performance instances in the Amazon EC2 User Guide.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { EC2Client, ModifyDefaultCreditSpecificationCommand } from "@aws-sdk/client-ec2"; // ES Modules import + * // const { EC2Client, ModifyDefaultCreditSpecificationCommand } = require("@aws-sdk/client-ec2"); // CommonJS import + * const client = new EC2Client(config); + * const command = new ModifyDefaultCreditSpecificationCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ModifyDefaultCreditSpecificationCommandInput} for command's `input` shape. + * @see {@link ModifyDefaultCreditSpecificationCommandOutput} for command's `response` shape. + * @see {@link EC2ClientResolvedConfig | config} for command's `input` shape. + * */ export class ModifyDefaultCreditSpecificationCommand extends $Command< ModifyDefaultCreditSpecificationCommandInput, diff --git a/clients/client-ec2/commands/ModifyEbsDefaultKmsKeyIdCommand.ts b/clients/client-ec2/commands/ModifyEbsDefaultKmsKeyIdCommand.ts index ce86616544cc..d8185fed9547 100644 --- a/clients/client-ec2/commands/ModifyEbsDefaultKmsKeyIdCommand.ts +++ b/clients/client-ec2/commands/ModifyEbsDefaultKmsKeyIdCommand.ts @@ -29,6 +29,20 @@ export interface ModifyEbsDefaultKmsKeyIdCommandOutput extends ModifyEbsDefaultK * encryption by default, your instances will fail to launch.

*

For more information, see Amazon EBS encryption * in the Amazon Elastic Compute Cloud User Guide.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { EC2Client, ModifyEbsDefaultKmsKeyIdCommand } from "@aws-sdk/client-ec2"; // ES Modules import + * // const { EC2Client, ModifyEbsDefaultKmsKeyIdCommand } = require("@aws-sdk/client-ec2"); // CommonJS import + * const client = new EC2Client(config); + * const command = new ModifyEbsDefaultKmsKeyIdCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ModifyEbsDefaultKmsKeyIdCommandInput} for command's `input` shape. + * @see {@link ModifyEbsDefaultKmsKeyIdCommandOutput} for command's `response` shape. + * @see {@link EC2ClientResolvedConfig | config} for command's `input` shape. + * */ export class ModifyEbsDefaultKmsKeyIdCommand extends $Command< ModifyEbsDefaultKmsKeyIdCommandInput, diff --git a/clients/client-ec2/commands/ModifyFleetCommand.ts b/clients/client-ec2/commands/ModifyFleetCommand.ts index 90f215045966..80387b8fe000 100644 --- a/clients/client-ec2/commands/ModifyFleetCommand.ts +++ b/clients/client-ec2/commands/ModifyFleetCommand.ts @@ -40,6 +40,20 @@ export interface ModifyFleetCommandOutput extends ModifyFleetResult, __MetadataB * 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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { EC2Client, ModifyFleetCommand } from "@aws-sdk/client-ec2"; // ES Modules import + * // const { EC2Client, ModifyFleetCommand } = require("@aws-sdk/client-ec2"); // CommonJS import + * const client = new EC2Client(config); + * const command = new ModifyFleetCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ModifyFleetCommandInput} for command's `input` shape. + * @see {@link ModifyFleetCommandOutput} for command's `response` shape. + * @see {@link EC2ClientResolvedConfig | config} for command's `input` shape. + * */ export class ModifyFleetCommand extends $Command< ModifyFleetCommandInput, diff --git a/clients/client-ec2/commands/ModifyFpgaImageAttributeCommand.ts b/clients/client-ec2/commands/ModifyFpgaImageAttributeCommand.ts index 7e6a39eeea4f..30e0a727d949 100644 --- a/clients/client-ec2/commands/ModifyFpgaImageAttributeCommand.ts +++ b/clients/client-ec2/commands/ModifyFpgaImageAttributeCommand.ts @@ -22,6 +22,20 @@ export interface ModifyFpgaImageAttributeCommandOutput extends ModifyFpgaImageAt /** *

Modifies the specified attribute of the specified Amazon FPGA Image (AFI).

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { EC2Client, ModifyFpgaImageAttributeCommand } from "@aws-sdk/client-ec2"; // ES Modules import + * // const { EC2Client, ModifyFpgaImageAttributeCommand } = require("@aws-sdk/client-ec2"); // CommonJS import + * const client = new EC2Client(config); + * const command = new ModifyFpgaImageAttributeCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ModifyFpgaImageAttributeCommandInput} for command's `input` shape. + * @see {@link ModifyFpgaImageAttributeCommandOutput} for command's `response` shape. + * @see {@link EC2ClientResolvedConfig | config} for command's `input` shape. + * */ export class ModifyFpgaImageAttributeCommand extends $Command< ModifyFpgaImageAttributeCommandInput, diff --git a/clients/client-ec2/commands/ModifyHostsCommand.ts b/clients/client-ec2/commands/ModifyHostsCommand.ts index 7456fe0920fd..9dbd9ff27bb5 100644 --- a/clients/client-ec2/commands/ModifyHostsCommand.ts +++ b/clients/client-ec2/commands/ModifyHostsCommand.ts @@ -26,6 +26,20 @@ export interface ModifyHostsCommandOutput extends ModifyHostsResult, __MetadataB * 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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { EC2Client, ModifyHostsCommand } from "@aws-sdk/client-ec2"; // ES Modules import + * // const { EC2Client, ModifyHostsCommand } = require("@aws-sdk/client-ec2"); // CommonJS import + * const client = new EC2Client(config); + * const command = new ModifyHostsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ModifyHostsCommandInput} for command's `input` shape. + * @see {@link ModifyHostsCommandOutput} for command's `response` shape. + * @see {@link EC2ClientResolvedConfig | config} for command's `input` shape. + * */ export class ModifyHostsCommand extends $Command< ModifyHostsCommandInput, diff --git a/clients/client-ec2/commands/ModifyIdFormatCommand.ts b/clients/client-ec2/commands/ModifyIdFormatCommand.ts index 6d96f8931125..d38c6fe24aa5 100644 --- a/clients/client-ec2/commands/ModifyIdFormatCommand.ts +++ b/clients/client-ec2/commands/ModifyIdFormatCommand.ts @@ -42,6 +42,20 @@ export interface ModifyIdFormatCommandOutput extends __MetadataBearer {} *

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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { EC2Client, ModifyIdFormatCommand } from "@aws-sdk/client-ec2"; // ES Modules import + * // const { EC2Client, ModifyIdFormatCommand } = require("@aws-sdk/client-ec2"); // CommonJS import + * const client = new EC2Client(config); + * const command = new ModifyIdFormatCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ModifyIdFormatCommandInput} for command's `input` shape. + * @see {@link ModifyIdFormatCommandOutput} for command's `response` shape. + * @see {@link EC2ClientResolvedConfig | config} for command's `input` shape. + * */ export class ModifyIdFormatCommand extends $Command< ModifyIdFormatCommandInput, diff --git a/clients/client-ec2/commands/ModifyIdentityIdFormatCommand.ts b/clients/client-ec2/commands/ModifyIdentityIdFormatCommand.ts index 9ffbea2639a2..5bacb9417d20 100644 --- a/clients/client-ec2/commands/ModifyIdentityIdFormatCommand.ts +++ b/clients/client-ec2/commands/ModifyIdentityIdFormatCommand.ts @@ -43,6 +43,20 @@ export interface ModifyIdentityIdFormatCommandOutput extends __MetadataBearer {} *

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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { EC2Client, ModifyIdentityIdFormatCommand } from "@aws-sdk/client-ec2"; // ES Modules import + * // const { EC2Client, ModifyIdentityIdFormatCommand } = require("@aws-sdk/client-ec2"); // CommonJS import + * const client = new EC2Client(config); + * const command = new ModifyIdentityIdFormatCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ModifyIdentityIdFormatCommandInput} for command's `input` shape. + * @see {@link ModifyIdentityIdFormatCommandOutput} for command's `response` shape. + * @see {@link EC2ClientResolvedConfig | config} for command's `input` shape. + * */ export class ModifyIdentityIdFormatCommand extends $Command< ModifyIdentityIdFormatCommandInput, diff --git a/clients/client-ec2/commands/ModifyImageAttributeCommand.ts b/clients/client-ec2/commands/ModifyImageAttributeCommand.ts index 88274ea0c517..aad35d4813e5 100644 --- a/clients/client-ec2/commands/ModifyImageAttributeCommand.ts +++ b/clients/client-ec2/commands/ModifyImageAttributeCommand.ts @@ -27,6 +27,20 @@ export interface ModifyImageAttributeCommandOutput extends __MetadataBearer {} *

AWS Marketplace product codes cannot be modified. Images with an AWS 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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { EC2Client, ModifyImageAttributeCommand } from "@aws-sdk/client-ec2"; // ES Modules import + * // const { EC2Client, ModifyImageAttributeCommand } = require("@aws-sdk/client-ec2"); // CommonJS import + * const client = new EC2Client(config); + * const command = new ModifyImageAttributeCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ModifyImageAttributeCommandInput} for command's `input` shape. + * @see {@link ModifyImageAttributeCommandOutput} for command's `response` shape. + * @see {@link EC2ClientResolvedConfig | config} for command's `input` shape. + * */ export class ModifyImageAttributeCommand extends $Command< ModifyImageAttributeCommandInput, diff --git a/clients/client-ec2/commands/ModifyInstanceAttributeCommand.ts b/clients/client-ec2/commands/ModifyInstanceAttributeCommand.ts index 96b405c5e094..f7b465d857a2 100644 --- a/clients/client-ec2/commands/ModifyInstanceAttributeCommand.ts +++ b/clients/client-ec2/commands/ModifyInstanceAttributeCommand.ts @@ -31,6 +31,20 @@ export interface ModifyInstanceAttributeCommandOutput extends __MetadataBearer { * you use the ModifyNetworkInterfaceAttribute action.

*

To modify some attributes, the instance must be stopped. For more information, see * Modifying attributes of a stopped instance in the Amazon EC2 User Guide.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { EC2Client, ModifyInstanceAttributeCommand } from "@aws-sdk/client-ec2"; // ES Modules import + * // const { EC2Client, ModifyInstanceAttributeCommand } = require("@aws-sdk/client-ec2"); // CommonJS import + * const client = new EC2Client(config); + * const command = new ModifyInstanceAttributeCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ModifyInstanceAttributeCommandInput} for command's `input` shape. + * @see {@link ModifyInstanceAttributeCommandOutput} for command's `response` shape. + * @see {@link EC2ClientResolvedConfig | config} for command's `input` shape. + * */ export class ModifyInstanceAttributeCommand extends $Command< ModifyInstanceAttributeCommandInput, diff --git a/clients/client-ec2/commands/ModifyInstanceCapacityReservationAttributesCommand.ts b/clients/client-ec2/commands/ModifyInstanceCapacityReservationAttributesCommand.ts index cbeb2a43f97f..ffb2faa80de9 100644 --- a/clients/client-ec2/commands/ModifyInstanceCapacityReservationAttributesCommand.ts +++ b/clients/client-ec2/commands/ModifyInstanceCapacityReservationAttributesCommand.ts @@ -30,6 +30,20 @@ export interface ModifyInstanceCapacityReservationAttributesCommandOutput *

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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { EC2Client, ModifyInstanceCapacityReservationAttributesCommand } from "@aws-sdk/client-ec2"; // ES Modules import + * // const { EC2Client, ModifyInstanceCapacityReservationAttributesCommand } = require("@aws-sdk/client-ec2"); // CommonJS import + * const client = new EC2Client(config); + * const command = new ModifyInstanceCapacityReservationAttributesCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ModifyInstanceCapacityReservationAttributesCommandInput} for command's `input` shape. + * @see {@link ModifyInstanceCapacityReservationAttributesCommandOutput} for command's `response` shape. + * @see {@link EC2ClientResolvedConfig | config} for command's `input` shape. + * */ export class ModifyInstanceCapacityReservationAttributesCommand extends $Command< ModifyInstanceCapacityReservationAttributesCommandInput, diff --git a/clients/client-ec2/commands/ModifyInstanceCreditSpecificationCommand.ts b/clients/client-ec2/commands/ModifyInstanceCreditSpecificationCommand.ts index e6c02f1c66e3..5ebbf43009ef 100644 --- a/clients/client-ec2/commands/ModifyInstanceCreditSpecificationCommand.ts +++ b/clients/client-ec2/commands/ModifyInstanceCreditSpecificationCommand.ts @@ -28,6 +28,20 @@ export interface ModifyInstanceCreditSpecificationCommandOutput * unlimited.

*

For more information, see Burstable * performance instances in the Amazon EC2 User Guide.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { EC2Client, ModifyInstanceCreditSpecificationCommand } from "@aws-sdk/client-ec2"; // ES Modules import + * // const { EC2Client, ModifyInstanceCreditSpecificationCommand } = require("@aws-sdk/client-ec2"); // CommonJS import + * const client = new EC2Client(config); + * const command = new ModifyInstanceCreditSpecificationCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ModifyInstanceCreditSpecificationCommandInput} for command's `input` shape. + * @see {@link ModifyInstanceCreditSpecificationCommandOutput} for command's `response` shape. + * @see {@link EC2ClientResolvedConfig | config} for command's `input` shape. + * */ export class ModifyInstanceCreditSpecificationCommand extends $Command< ModifyInstanceCreditSpecificationCommandInput, diff --git a/clients/client-ec2/commands/ModifyInstanceEventStartTimeCommand.ts b/clients/client-ec2/commands/ModifyInstanceEventStartTimeCommand.ts index f9246fc0d458..58510a9fac6b 100644 --- a/clients/client-ec2/commands/ModifyInstanceEventStartTimeCommand.ts +++ b/clients/client-ec2/commands/ModifyInstanceEventStartTimeCommand.ts @@ -24,6 +24,20 @@ export interface ModifyInstanceEventStartTimeCommandOutput /** *

Modifies the start time for a scheduled Amazon EC2 instance event.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { EC2Client, ModifyInstanceEventStartTimeCommand } from "@aws-sdk/client-ec2"; // ES Modules import + * // const { EC2Client, ModifyInstanceEventStartTimeCommand } = require("@aws-sdk/client-ec2"); // CommonJS import + * const client = new EC2Client(config); + * const command = new ModifyInstanceEventStartTimeCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ModifyInstanceEventStartTimeCommandInput} for command's `input` shape. + * @see {@link ModifyInstanceEventStartTimeCommandOutput} for command's `response` shape. + * @see {@link EC2ClientResolvedConfig | config} for command's `input` shape. + * */ export class ModifyInstanceEventStartTimeCommand extends $Command< ModifyInstanceEventStartTimeCommandInput, diff --git a/clients/client-ec2/commands/ModifyInstanceMetadataOptionsCommand.ts b/clients/client-ec2/commands/ModifyInstanceMetadataOptionsCommand.ts index 5d4a1b3b9cb2..1cfa34626756 100644 --- a/clients/client-ec2/commands/ModifyInstanceMetadataOptionsCommand.ts +++ b/clients/client-ec2/commands/ModifyInstanceMetadataOptionsCommand.ts @@ -30,6 +30,20 @@ export interface ModifyInstanceMetadataOptionsCommandOutput * 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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { EC2Client, ModifyInstanceMetadataOptionsCommand } from "@aws-sdk/client-ec2"; // ES Modules import + * // const { EC2Client, ModifyInstanceMetadataOptionsCommand } = require("@aws-sdk/client-ec2"); // CommonJS import + * const client = new EC2Client(config); + * const command = new ModifyInstanceMetadataOptionsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ModifyInstanceMetadataOptionsCommandInput} for command's `input` shape. + * @see {@link ModifyInstanceMetadataOptionsCommandOutput} for command's `response` shape. + * @see {@link EC2ClientResolvedConfig | config} for command's `input` shape. + * */ export class ModifyInstanceMetadataOptionsCommand extends $Command< ModifyInstanceMetadataOptionsCommandInput, diff --git a/clients/client-ec2/commands/ModifyInstancePlacementCommand.ts b/clients/client-ec2/commands/ModifyInstancePlacementCommand.ts index c6c7650ebee2..283c08787dbe 100644 --- a/clients/client-ec2/commands/ModifyInstancePlacementCommand.ts +++ b/clients/client-ec2/commands/ModifyInstancePlacementCommand.ts @@ -49,6 +49,20 @@ export interface ModifyInstancePlacementCommandOutput extends ModifyInstancePlac * request.

*

To modify the host ID, tenancy, placement group, or partition for an instance, the * instance must be in the stopped state.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { EC2Client, ModifyInstancePlacementCommand } from "@aws-sdk/client-ec2"; // ES Modules import + * // const { EC2Client, ModifyInstancePlacementCommand } = require("@aws-sdk/client-ec2"); // CommonJS import + * const client = new EC2Client(config); + * const command = new ModifyInstancePlacementCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ModifyInstancePlacementCommandInput} for command's `input` shape. + * @see {@link ModifyInstancePlacementCommandOutput} for command's `response` shape. + * @see {@link EC2ClientResolvedConfig | config} for command's `input` shape. + * */ export class ModifyInstancePlacementCommand extends $Command< ModifyInstancePlacementCommandInput, diff --git a/clients/client-ec2/commands/ModifyLaunchTemplateCommand.ts b/clients/client-ec2/commands/ModifyLaunchTemplateCommand.ts index 0b9b99b2384a..a337b873f987 100644 --- a/clients/client-ec2/commands/ModifyLaunchTemplateCommand.ts +++ b/clients/client-ec2/commands/ModifyLaunchTemplateCommand.ts @@ -24,6 +24,20 @@ export interface ModifyLaunchTemplateCommandOutput extends ModifyLaunchTemplateR *

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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { EC2Client, ModifyLaunchTemplateCommand } from "@aws-sdk/client-ec2"; // ES Modules import + * // const { EC2Client, ModifyLaunchTemplateCommand } = require("@aws-sdk/client-ec2"); // CommonJS import + * const client = new EC2Client(config); + * const command = new ModifyLaunchTemplateCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ModifyLaunchTemplateCommandInput} for command's `input` shape. + * @see {@link ModifyLaunchTemplateCommandOutput} for command's `response` shape. + * @see {@link EC2ClientResolvedConfig | config} for command's `input` shape. + * */ export class ModifyLaunchTemplateCommand extends $Command< ModifyLaunchTemplateCommandInput, diff --git a/clients/client-ec2/commands/ModifyManagedPrefixListCommand.ts b/clients/client-ec2/commands/ModifyManagedPrefixListCommand.ts index e794c917892d..8fd06d6b4309 100644 --- a/clients/client-ec2/commands/ModifyManagedPrefixListCommand.ts +++ b/clients/client-ec2/commands/ModifyManagedPrefixListCommand.ts @@ -26,6 +26,20 @@ export interface ModifyManagedPrefixListCommandOutput extends ModifyManagedPrefi * 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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { EC2Client, ModifyManagedPrefixListCommand } from "@aws-sdk/client-ec2"; // ES Modules import + * // const { EC2Client, ModifyManagedPrefixListCommand } = require("@aws-sdk/client-ec2"); // CommonJS import + * const client = new EC2Client(config); + * const command = new ModifyManagedPrefixListCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ModifyManagedPrefixListCommandInput} for command's `input` shape. + * @see {@link ModifyManagedPrefixListCommandOutput} for command's `response` shape. + * @see {@link EC2ClientResolvedConfig | config} for command's `input` shape. + * */ export class ModifyManagedPrefixListCommand extends $Command< ModifyManagedPrefixListCommandInput, diff --git a/clients/client-ec2/commands/ModifyNetworkInterfaceAttributeCommand.ts b/clients/client-ec2/commands/ModifyNetworkInterfaceAttributeCommand.ts index 61567dbf4e7b..954df1bd813b 100644 --- a/clients/client-ec2/commands/ModifyNetworkInterfaceAttributeCommand.ts +++ b/clients/client-ec2/commands/ModifyNetworkInterfaceAttributeCommand.ts @@ -24,6 +24,20 @@ export interface ModifyNetworkInterfaceAttributeCommandOutput extends __Metadata *

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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { EC2Client, ModifyNetworkInterfaceAttributeCommand } from "@aws-sdk/client-ec2"; // ES Modules import + * // const { EC2Client, ModifyNetworkInterfaceAttributeCommand } = require("@aws-sdk/client-ec2"); // CommonJS import + * const client = new EC2Client(config); + * const command = new ModifyNetworkInterfaceAttributeCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ModifyNetworkInterfaceAttributeCommandInput} for command's `input` shape. + * @see {@link ModifyNetworkInterfaceAttributeCommandOutput} for command's `response` shape. + * @see {@link EC2ClientResolvedConfig | config} for command's `input` shape. + * */ export class ModifyNetworkInterfaceAttributeCommand extends $Command< ModifyNetworkInterfaceAttributeCommandInput, diff --git a/clients/client-ec2/commands/ModifyReservedInstancesCommand.ts b/clients/client-ec2/commands/ModifyReservedInstancesCommand.ts index 9cce420fffed..1eb4e2a493b0 100644 --- a/clients/client-ec2/commands/ModifyReservedInstancesCommand.ts +++ b/clients/client-ec2/commands/ModifyReservedInstancesCommand.ts @@ -27,6 +27,20 @@ export interface ModifyReservedInstancesCommandOutput extends ModifyReservedInst * type.

*

For more information, see Modifying Reserved * Instances in the Amazon EC2 User Guide.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { EC2Client, ModifyReservedInstancesCommand } from "@aws-sdk/client-ec2"; // ES Modules import + * // const { EC2Client, ModifyReservedInstancesCommand } = require("@aws-sdk/client-ec2"); // CommonJS import + * const client = new EC2Client(config); + * const command = new ModifyReservedInstancesCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ModifyReservedInstancesCommandInput} for command's `input` shape. + * @see {@link ModifyReservedInstancesCommandOutput} for command's `response` shape. + * @see {@link EC2ClientResolvedConfig | config} for command's `input` shape. + * */ export class ModifyReservedInstancesCommand extends $Command< ModifyReservedInstancesCommandInput, diff --git a/clients/client-ec2/commands/ModifySnapshotAttributeCommand.ts b/clients/client-ec2/commands/ModifySnapshotAttributeCommand.ts index 17d30f5f02df..603830bc8a7e 100644 --- a/clients/client-ec2/commands/ModifySnapshotAttributeCommand.ts +++ b/clients/client-ec2/commands/ModifySnapshotAttributeCommand.ts @@ -29,6 +29,20 @@ export interface ModifySnapshotAttributeCommandOutput extends __MetadataBearer { * public. Snapshots encrypted with your default CMK cannot be shared with other accounts.

*

For more information about modifying snapshot permissions, see Sharing snapshots in the * Amazon Elastic Compute Cloud User Guide.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { EC2Client, ModifySnapshotAttributeCommand } from "@aws-sdk/client-ec2"; // ES Modules import + * // const { EC2Client, ModifySnapshotAttributeCommand } = require("@aws-sdk/client-ec2"); // CommonJS import + * const client = new EC2Client(config); + * const command = new ModifySnapshotAttributeCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ModifySnapshotAttributeCommandInput} for command's `input` shape. + * @see {@link ModifySnapshotAttributeCommandOutput} for command's `response` shape. + * @see {@link EC2ClientResolvedConfig | config} for command's `input` shape. + * */ export class ModifySnapshotAttributeCommand extends $Command< ModifySnapshotAttributeCommandInput, diff --git a/clients/client-ec2/commands/ModifySpotFleetRequestCommand.ts b/clients/client-ec2/commands/ModifySpotFleetRequestCommand.ts index 2451502d273f..94b11b8e88b8 100644 --- a/clients/client-ec2/commands/ModifySpotFleetRequestCommand.ts +++ b/clients/client-ec2/commands/ModifySpotFleetRequestCommand.ts @@ -45,6 +45,20 @@ export interface ModifySpotFleetRequestCommandOutput extends ModifySpotFleetRequ * 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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { EC2Client, ModifySpotFleetRequestCommand } from "@aws-sdk/client-ec2"; // ES Modules import + * // const { EC2Client, ModifySpotFleetRequestCommand } = require("@aws-sdk/client-ec2"); // CommonJS import + * const client = new EC2Client(config); + * const command = new ModifySpotFleetRequestCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ModifySpotFleetRequestCommandInput} for command's `input` shape. + * @see {@link ModifySpotFleetRequestCommandOutput} for command's `response` shape. + * @see {@link EC2ClientResolvedConfig | config} for command's `input` shape. + * */ export class ModifySpotFleetRequestCommand extends $Command< ModifySpotFleetRequestCommandInput, diff --git a/clients/client-ec2/commands/ModifySubnetAttributeCommand.ts b/clients/client-ec2/commands/ModifySubnetAttributeCommand.ts index bd99d6e78273..5d3609a3b757 100644 --- a/clients/client-ec2/commands/ModifySubnetAttributeCommand.ts +++ b/clients/client-ec2/commands/ModifySubnetAttributeCommand.ts @@ -22,6 +22,20 @@ export interface ModifySubnetAttributeCommandOutput extends __MetadataBearer {} /** *

Modifies a subnet attribute. You can only modify one attribute at a time.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { EC2Client, ModifySubnetAttributeCommand } from "@aws-sdk/client-ec2"; // ES Modules import + * // const { EC2Client, ModifySubnetAttributeCommand } = require("@aws-sdk/client-ec2"); // CommonJS import + * const client = new EC2Client(config); + * const command = new ModifySubnetAttributeCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ModifySubnetAttributeCommandInput} for command's `input` shape. + * @see {@link ModifySubnetAttributeCommandOutput} for command's `response` shape. + * @see {@link EC2ClientResolvedConfig | config} for command's `input` shape. + * */ export class ModifySubnetAttributeCommand extends $Command< ModifySubnetAttributeCommandInput, diff --git a/clients/client-ec2/commands/ModifyTrafficMirrorFilterNetworkServicesCommand.ts b/clients/client-ec2/commands/ModifyTrafficMirrorFilterNetworkServicesCommand.ts index 93242fb37369..1b7c3239c147 100644 --- a/clients/client-ec2/commands/ModifyTrafficMirrorFilterNetworkServicesCommand.ts +++ b/clients/client-ec2/commands/ModifyTrafficMirrorFilterNetworkServicesCommand.ts @@ -33,6 +33,20 @@ export interface ModifyTrafficMirrorFilterNetworkServicesCommandOutput *

*

For information about filter rule properties, see * Network Services in the Traffic Mirroring User Guide .

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { EC2Client, ModifyTrafficMirrorFilterNetworkServicesCommand } from "@aws-sdk/client-ec2"; // ES Modules import + * // const { EC2Client, ModifyTrafficMirrorFilterNetworkServicesCommand } = require("@aws-sdk/client-ec2"); // CommonJS import + * const client = new EC2Client(config); + * const command = new ModifyTrafficMirrorFilterNetworkServicesCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ModifyTrafficMirrorFilterNetworkServicesCommandInput} for command's `input` shape. + * @see {@link ModifyTrafficMirrorFilterNetworkServicesCommandOutput} for command's `response` shape. + * @see {@link EC2ClientResolvedConfig | config} for command's `input` shape. + * */ export class ModifyTrafficMirrorFilterNetworkServicesCommand extends $Command< ModifyTrafficMirrorFilterNetworkServicesCommandInput, diff --git a/clients/client-ec2/commands/ModifyTrafficMirrorFilterRuleCommand.ts b/clients/client-ec2/commands/ModifyTrafficMirrorFilterRuleCommand.ts index a77dea17cd81..4e67a713613f 100644 --- a/clients/client-ec2/commands/ModifyTrafficMirrorFilterRuleCommand.ts +++ b/clients/client-ec2/commands/ModifyTrafficMirrorFilterRuleCommand.ts @@ -27,6 +27,20 @@ export interface ModifyTrafficMirrorFilterRuleCommandOutput *

* DestinationCidrBlock and SourceCidrBlock must both be an IPv4 * range or an IPv6 range.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { EC2Client, ModifyTrafficMirrorFilterRuleCommand } from "@aws-sdk/client-ec2"; // ES Modules import + * // const { EC2Client, ModifyTrafficMirrorFilterRuleCommand } = require("@aws-sdk/client-ec2"); // CommonJS import + * const client = new EC2Client(config); + * const command = new ModifyTrafficMirrorFilterRuleCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ModifyTrafficMirrorFilterRuleCommandInput} for command's `input` shape. + * @see {@link ModifyTrafficMirrorFilterRuleCommandOutput} for command's `response` shape. + * @see {@link EC2ClientResolvedConfig | config} for command's `input` shape. + * */ export class ModifyTrafficMirrorFilterRuleCommand extends $Command< ModifyTrafficMirrorFilterRuleCommandInput, diff --git a/clients/client-ec2/commands/ModifyTrafficMirrorSessionCommand.ts b/clients/client-ec2/commands/ModifyTrafficMirrorSessionCommand.ts index 11f56ecd6cf9..2f19f7a31084 100644 --- a/clients/client-ec2/commands/ModifyTrafficMirrorSessionCommand.ts +++ b/clients/client-ec2/commands/ModifyTrafficMirrorSessionCommand.ts @@ -22,6 +22,20 @@ export interface ModifyTrafficMirrorSessionCommandOutput extends ModifyTrafficMi /** *

Modifies a Traffic Mirror session.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { EC2Client, ModifyTrafficMirrorSessionCommand } from "@aws-sdk/client-ec2"; // ES Modules import + * // const { EC2Client, ModifyTrafficMirrorSessionCommand } = require("@aws-sdk/client-ec2"); // CommonJS import + * const client = new EC2Client(config); + * const command = new ModifyTrafficMirrorSessionCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ModifyTrafficMirrorSessionCommandInput} for command's `input` shape. + * @see {@link ModifyTrafficMirrorSessionCommandOutput} for command's `response` shape. + * @see {@link EC2ClientResolvedConfig | config} for command's `input` shape. + * */ export class ModifyTrafficMirrorSessionCommand extends $Command< ModifyTrafficMirrorSessionCommandInput, diff --git a/clients/client-ec2/commands/ModifyTransitGatewayCommand.ts b/clients/client-ec2/commands/ModifyTransitGatewayCommand.ts index eb6491665b1c..3536ff7204f2 100644 --- a/clients/client-ec2/commands/ModifyTransitGatewayCommand.ts +++ b/clients/client-ec2/commands/ModifyTransitGatewayCommand.ts @@ -22,6 +22,20 @@ export interface ModifyTransitGatewayCommandOutput extends ModifyTransitGatewayR /** *

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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { EC2Client, ModifyTransitGatewayCommand } from "@aws-sdk/client-ec2"; // ES Modules import + * // const { EC2Client, ModifyTransitGatewayCommand } = require("@aws-sdk/client-ec2"); // CommonJS import + * const client = new EC2Client(config); + * const command = new ModifyTransitGatewayCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ModifyTransitGatewayCommandInput} for command's `input` shape. + * @see {@link ModifyTransitGatewayCommandOutput} for command's `response` shape. + * @see {@link EC2ClientResolvedConfig | config} for command's `input` shape. + * */ export class ModifyTransitGatewayCommand extends $Command< ModifyTransitGatewayCommandInput, diff --git a/clients/client-ec2/commands/ModifyTransitGatewayPrefixListReferenceCommand.ts b/clients/client-ec2/commands/ModifyTransitGatewayPrefixListReferenceCommand.ts index 23995cfadbfd..2f7fb3393432 100644 --- a/clients/client-ec2/commands/ModifyTransitGatewayPrefixListReferenceCommand.ts +++ b/clients/client-ec2/commands/ModifyTransitGatewayPrefixListReferenceCommand.ts @@ -28,6 +28,20 @@ export interface ModifyTransitGatewayPrefixListReferenceCommandOutput /** *

Modifies a reference (route) to a prefix list in a specified transit gateway route table.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { EC2Client, ModifyTransitGatewayPrefixListReferenceCommand } from "@aws-sdk/client-ec2"; // ES Modules import + * // const { EC2Client, ModifyTransitGatewayPrefixListReferenceCommand } = require("@aws-sdk/client-ec2"); // CommonJS import + * const client = new EC2Client(config); + * const command = new ModifyTransitGatewayPrefixListReferenceCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ModifyTransitGatewayPrefixListReferenceCommandInput} for command's `input` shape. + * @see {@link ModifyTransitGatewayPrefixListReferenceCommandOutput} for command's `response` shape. + * @see {@link EC2ClientResolvedConfig | config} for command's `input` shape. + * */ export class ModifyTransitGatewayPrefixListReferenceCommand extends $Command< ModifyTransitGatewayPrefixListReferenceCommandInput, diff --git a/clients/client-ec2/commands/ModifyTransitGatewayVpcAttachmentCommand.ts b/clients/client-ec2/commands/ModifyTransitGatewayVpcAttachmentCommand.ts index a3ee93ac2977..7b4192190ed5 100644 --- a/clients/client-ec2/commands/ModifyTransitGatewayVpcAttachmentCommand.ts +++ b/clients/client-ec2/commands/ModifyTransitGatewayVpcAttachmentCommand.ts @@ -24,6 +24,20 @@ export interface ModifyTransitGatewayVpcAttachmentCommandOutput /** *

Modifies the specified VPC attachment.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { EC2Client, ModifyTransitGatewayVpcAttachmentCommand } from "@aws-sdk/client-ec2"; // ES Modules import + * // const { EC2Client, ModifyTransitGatewayVpcAttachmentCommand } = require("@aws-sdk/client-ec2"); // CommonJS import + * const client = new EC2Client(config); + * const command = new ModifyTransitGatewayVpcAttachmentCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ModifyTransitGatewayVpcAttachmentCommandInput} for command's `input` shape. + * @see {@link ModifyTransitGatewayVpcAttachmentCommandOutput} for command's `response` shape. + * @see {@link EC2ClientResolvedConfig | config} for command's `input` shape. + * */ export class ModifyTransitGatewayVpcAttachmentCommand extends $Command< ModifyTransitGatewayVpcAttachmentCommandInput, diff --git a/clients/client-ec2/commands/ModifyVolumeAttributeCommand.ts b/clients/client-ec2/commands/ModifyVolumeAttributeCommand.ts index 489b8e0f9030..97af1c30ff23 100644 --- a/clients/client-ec2/commands/ModifyVolumeAttributeCommand.ts +++ b/clients/client-ec2/commands/ModifyVolumeAttributeCommand.ts @@ -28,6 +28,20 @@ export interface ModifyVolumeAttributeCommandOutput extends __MetadataBearer {} * 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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { EC2Client, ModifyVolumeAttributeCommand } from "@aws-sdk/client-ec2"; // ES Modules import + * // const { EC2Client, ModifyVolumeAttributeCommand } = require("@aws-sdk/client-ec2"); // CommonJS import + * const client = new EC2Client(config); + * const command = new ModifyVolumeAttributeCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ModifyVolumeAttributeCommandInput} for command's `input` shape. + * @see {@link ModifyVolumeAttributeCommandOutput} for command's `response` shape. + * @see {@link EC2ClientResolvedConfig | config} for command's `input` shape. + * */ export class ModifyVolumeAttributeCommand extends $Command< ModifyVolumeAttributeCommandInput, diff --git a/clients/client-ec2/commands/ModifyVolumeCommand.ts b/clients/client-ec2/commands/ModifyVolumeCommand.ts index 7b2f928c1b5f..04a5a9cc2c08 100644 --- a/clients/client-ec2/commands/ModifyVolumeCommand.ts +++ b/clients/client-ec2/commands/ModifyVolumeCommand.ts @@ -40,6 +40,20 @@ export interface ModifyVolumeCommandOutput extends ModifyVolumeResult, __Metadat * Volumes (Linux) or Amazon EBS Elastic Volumes (Windows).

*

If you reach the maximum volume modification rate per volume limit, you will need to wait * at least six hours before applying further modifications to the affected EBS volume.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { EC2Client, ModifyVolumeCommand } from "@aws-sdk/client-ec2"; // ES Modules import + * // const { EC2Client, ModifyVolumeCommand } = require("@aws-sdk/client-ec2"); // CommonJS import + * const client = new EC2Client(config); + * const command = new ModifyVolumeCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ModifyVolumeCommandInput} for command's `input` shape. + * @see {@link ModifyVolumeCommandOutput} for command's `response` shape. + * @see {@link EC2ClientResolvedConfig | config} for command's `input` shape. + * */ export class ModifyVolumeCommand extends $Command< ModifyVolumeCommandInput, diff --git a/clients/client-ec2/commands/ModifyVpcAttributeCommand.ts b/clients/client-ec2/commands/ModifyVpcAttributeCommand.ts index 470741d710a7..423fc96f7a0f 100644 --- a/clients/client-ec2/commands/ModifyVpcAttributeCommand.ts +++ b/clients/client-ec2/commands/ModifyVpcAttributeCommand.ts @@ -22,6 +22,20 @@ export interface ModifyVpcAttributeCommandOutput extends __MetadataBearer {} /** *

Modifies the specified attribute of the specified VPC.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { EC2Client, ModifyVpcAttributeCommand } from "@aws-sdk/client-ec2"; // ES Modules import + * // const { EC2Client, ModifyVpcAttributeCommand } = require("@aws-sdk/client-ec2"); // CommonJS import + * const client = new EC2Client(config); + * const command = new ModifyVpcAttributeCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ModifyVpcAttributeCommandInput} for command's `input` shape. + * @see {@link ModifyVpcAttributeCommandOutput} for command's `response` shape. + * @see {@link EC2ClientResolvedConfig | config} for command's `input` shape. + * */ export class ModifyVpcAttributeCommand extends $Command< ModifyVpcAttributeCommandInput, diff --git a/clients/client-ec2/commands/ModifyVpcEndpointCommand.ts b/clients/client-ec2/commands/ModifyVpcEndpointCommand.ts index a2d1a7bbcd5a..b4098dc303f2 100644 --- a/clients/client-ec2/commands/ModifyVpcEndpointCommand.ts +++ b/clients/client-ec2/commands/ModifyVpcEndpointCommand.ts @@ -25,6 +25,20 @@ export interface ModifyVpcEndpointCommandOutput extends ModifyVpcEndpointResult, * depend on the type of VPC endpoint (interface, gateway, or Gateway Load Balancer). For more information, see * VPC * Endpoints in the Amazon Virtual Private Cloud User Guide.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { EC2Client, ModifyVpcEndpointCommand } from "@aws-sdk/client-ec2"; // ES Modules import + * // const { EC2Client, ModifyVpcEndpointCommand } = require("@aws-sdk/client-ec2"); // CommonJS import + * const client = new EC2Client(config); + * const command = new ModifyVpcEndpointCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ModifyVpcEndpointCommandInput} for command's `input` shape. + * @see {@link ModifyVpcEndpointCommandOutput} for command's `response` shape. + * @see {@link EC2ClientResolvedConfig | config} for command's `input` shape. + * */ export class ModifyVpcEndpointCommand extends $Command< ModifyVpcEndpointCommandInput, diff --git a/clients/client-ec2/commands/ModifyVpcEndpointConnectionNotificationCommand.ts b/clients/client-ec2/commands/ModifyVpcEndpointConnectionNotificationCommand.ts index 62e8e2b3574a..87a802970dfb 100644 --- a/clients/client-ec2/commands/ModifyVpcEndpointConnectionNotificationCommand.ts +++ b/clients/client-ec2/commands/ModifyVpcEndpointConnectionNotificationCommand.ts @@ -29,6 +29,20 @@ export interface ModifyVpcEndpointConnectionNotificationCommandOutput /** *

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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { EC2Client, ModifyVpcEndpointConnectionNotificationCommand } from "@aws-sdk/client-ec2"; // ES Modules import + * // const { EC2Client, ModifyVpcEndpointConnectionNotificationCommand } = require("@aws-sdk/client-ec2"); // CommonJS import + * const client = new EC2Client(config); + * const command = new ModifyVpcEndpointConnectionNotificationCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ModifyVpcEndpointConnectionNotificationCommandInput} for command's `input` shape. + * @see {@link ModifyVpcEndpointConnectionNotificationCommandOutput} for command's `response` shape. + * @see {@link EC2ClientResolvedConfig | config} for command's `input` shape. + * */ export class ModifyVpcEndpointConnectionNotificationCommand extends $Command< ModifyVpcEndpointConnectionNotificationCommandInput, diff --git a/clients/client-ec2/commands/ModifyVpcEndpointServiceConfigurationCommand.ts b/clients/client-ec2/commands/ModifyVpcEndpointServiceConfigurationCommand.ts index e82180a6e42e..2bf22ecc4767 100644 --- a/clients/client-ec2/commands/ModifyVpcEndpointServiceConfigurationCommand.ts +++ b/clients/client-ec2/commands/ModifyVpcEndpointServiceConfigurationCommand.ts @@ -35,6 +35,20 @@ export interface ModifyVpcEndpointServiceConfigurationCommandOutput * domain name. For more information, see VPC Endpoint Service * Private DNS Name Verification in the * Amazon Virtual Private Cloud User Guide.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { EC2Client, ModifyVpcEndpointServiceConfigurationCommand } from "@aws-sdk/client-ec2"; // ES Modules import + * // const { EC2Client, ModifyVpcEndpointServiceConfigurationCommand } = require("@aws-sdk/client-ec2"); // CommonJS import + * const client = new EC2Client(config); + * const command = new ModifyVpcEndpointServiceConfigurationCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ModifyVpcEndpointServiceConfigurationCommandInput} for command's `input` shape. + * @see {@link ModifyVpcEndpointServiceConfigurationCommandOutput} for command's `response` shape. + * @see {@link EC2ClientResolvedConfig | config} for command's `input` shape. + * */ export class ModifyVpcEndpointServiceConfigurationCommand extends $Command< ModifyVpcEndpointServiceConfigurationCommandInput, diff --git a/clients/client-ec2/commands/ModifyVpcEndpointServicePermissionsCommand.ts b/clients/client-ec2/commands/ModifyVpcEndpointServicePermissionsCommand.ts index fdd962602715..60b70f9163de 100644 --- a/clients/client-ec2/commands/ModifyVpcEndpointServicePermissionsCommand.ts +++ b/clients/client-ec2/commands/ModifyVpcEndpointServicePermissionsCommand.ts @@ -31,6 +31,20 @@ export interface ModifyVpcEndpointServicePermissionsCommandOutput *

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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { EC2Client, ModifyVpcEndpointServicePermissionsCommand } from "@aws-sdk/client-ec2"; // ES Modules import + * // const { EC2Client, ModifyVpcEndpointServicePermissionsCommand } = require("@aws-sdk/client-ec2"); // CommonJS import + * const client = new EC2Client(config); + * const command = new ModifyVpcEndpointServicePermissionsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ModifyVpcEndpointServicePermissionsCommandInput} for command's `input` shape. + * @see {@link ModifyVpcEndpointServicePermissionsCommandOutput} for command's `response` shape. + * @see {@link EC2ClientResolvedConfig | config} for command's `input` shape. + * */ export class ModifyVpcEndpointServicePermissionsCommand extends $Command< ModifyVpcEndpointServicePermissionsCommandInput, diff --git a/clients/client-ec2/commands/ModifyVpcPeeringConnectionOptionsCommand.ts b/clients/client-ec2/commands/ModifyVpcPeeringConnectionOptionsCommand.ts index 5129a72ed8f3..c38403ab6623 100644 --- a/clients/client-ec2/commands/ModifyVpcPeeringConnectionOptionsCommand.ts +++ b/clients/client-ec2/commands/ModifyVpcPeeringConnectionOptionsCommand.ts @@ -45,6 +45,20 @@ export interface ModifyVpcPeeringConnectionOptionsCommandOutput * 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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { EC2Client, ModifyVpcPeeringConnectionOptionsCommand } from "@aws-sdk/client-ec2"; // ES Modules import + * // const { EC2Client, ModifyVpcPeeringConnectionOptionsCommand } = require("@aws-sdk/client-ec2"); // CommonJS import + * const client = new EC2Client(config); + * const command = new ModifyVpcPeeringConnectionOptionsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ModifyVpcPeeringConnectionOptionsCommandInput} for command's `input` shape. + * @see {@link ModifyVpcPeeringConnectionOptionsCommandOutput} for command's `response` shape. + * @see {@link EC2ClientResolvedConfig | config} for command's `input` shape. + * */ export class ModifyVpcPeeringConnectionOptionsCommand extends $Command< ModifyVpcPeeringConnectionOptionsCommandInput, diff --git a/clients/client-ec2/commands/ModifyVpcTenancyCommand.ts b/clients/client-ec2/commands/ModifyVpcTenancyCommand.ts index c5053458dddc..cf9ad4ddc50b 100644 --- a/clients/client-ec2/commands/ModifyVpcTenancyCommand.ts +++ b/clients/client-ec2/commands/ModifyVpcTenancyCommand.ts @@ -29,6 +29,20 @@ export interface ModifyVpcTenancyCommandOutput extends ModifyVpcTenancyResult, _ * 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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { EC2Client, ModifyVpcTenancyCommand } from "@aws-sdk/client-ec2"; // ES Modules import + * // const { EC2Client, ModifyVpcTenancyCommand } = require("@aws-sdk/client-ec2"); // CommonJS import + * const client = new EC2Client(config); + * const command = new ModifyVpcTenancyCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ModifyVpcTenancyCommandInput} for command's `input` shape. + * @see {@link ModifyVpcTenancyCommandOutput} for command's `response` shape. + * @see {@link EC2ClientResolvedConfig | config} for command's `input` shape. + * */ export class ModifyVpcTenancyCommand extends $Command< ModifyVpcTenancyCommandInput, diff --git a/clients/client-ec2/commands/ModifyVpnConnectionCommand.ts b/clients/client-ec2/commands/ModifyVpnConnectionCommand.ts index 925426bec83b..5e4f9f49357f 100644 --- a/clients/client-ec2/commands/ModifyVpnConnectionCommand.ts +++ b/clients/client-ec2/commands/ModifyVpnConnectionCommand.ts @@ -54,6 +54,20 @@ export interface ModifyVpnConnectionCommandOutput extends ModifyVpnConnectionRes *

After you perform this operation, the AWS VPN endpoint's IP addresses on the AWS side and * the tunnel options remain intact. Your AWS Site-to-Site VPN connection will be temporarily unavailable * for a brief period while we provision the new endpoints.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { EC2Client, ModifyVpnConnectionCommand } from "@aws-sdk/client-ec2"; // ES Modules import + * // const { EC2Client, ModifyVpnConnectionCommand } = require("@aws-sdk/client-ec2"); // CommonJS import + * const client = new EC2Client(config); + * const command = new ModifyVpnConnectionCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ModifyVpnConnectionCommandInput} for command's `input` shape. + * @see {@link ModifyVpnConnectionCommandOutput} for command's `response` shape. + * @see {@link EC2ClientResolvedConfig | config} for command's `input` shape. + * */ export class ModifyVpnConnectionCommand extends $Command< ModifyVpnConnectionCommandInput, diff --git a/clients/client-ec2/commands/ModifyVpnConnectionOptionsCommand.ts b/clients/client-ec2/commands/ModifyVpnConnectionOptionsCommand.ts index c08561e0c455..1d8b4479d5f3 100644 --- a/clients/client-ec2/commands/ModifyVpnConnectionOptionsCommand.ts +++ b/clients/client-ec2/commands/ModifyVpnConnectionOptionsCommand.ts @@ -23,6 +23,20 @@ export interface ModifyVpnConnectionOptionsCommandOutput extends ModifyVpnConnec /** *

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 AWS 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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { EC2Client, ModifyVpnConnectionOptionsCommand } from "@aws-sdk/client-ec2"; // ES Modules import + * // const { EC2Client, ModifyVpnConnectionOptionsCommand } = require("@aws-sdk/client-ec2"); // CommonJS import + * const client = new EC2Client(config); + * const command = new ModifyVpnConnectionOptionsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ModifyVpnConnectionOptionsCommandInput} for command's `input` shape. + * @see {@link ModifyVpnConnectionOptionsCommandOutput} for command's `response` shape. + * @see {@link EC2ClientResolvedConfig | config} for command's `input` shape. + * */ export class ModifyVpnConnectionOptionsCommand extends $Command< ModifyVpnConnectionOptionsCommandInput, diff --git a/clients/client-ec2/commands/ModifyVpnTunnelCertificateCommand.ts b/clients/client-ec2/commands/ModifyVpnTunnelCertificateCommand.ts index 57befa6f347b..00bc0c6188ce 100644 --- a/clients/client-ec2/commands/ModifyVpnTunnelCertificateCommand.ts +++ b/clients/client-ec2/commands/ModifyVpnTunnelCertificateCommand.ts @@ -22,6 +22,20 @@ export interface ModifyVpnTunnelCertificateCommandOutput extends ModifyVpnTunnel /** *

Modifies the VPN tunnel endpoint certificate.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { EC2Client, ModifyVpnTunnelCertificateCommand } from "@aws-sdk/client-ec2"; // ES Modules import + * // const { EC2Client, ModifyVpnTunnelCertificateCommand } = require("@aws-sdk/client-ec2"); // CommonJS import + * const client = new EC2Client(config); + * const command = new ModifyVpnTunnelCertificateCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ModifyVpnTunnelCertificateCommandInput} for command's `input` shape. + * @see {@link ModifyVpnTunnelCertificateCommandOutput} for command's `response` shape. + * @see {@link EC2ClientResolvedConfig | config} for command's `input` shape. + * */ export class ModifyVpnTunnelCertificateCommand extends $Command< ModifyVpnTunnelCertificateCommandInput, diff --git a/clients/client-ec2/commands/ModifyVpnTunnelOptionsCommand.ts b/clients/client-ec2/commands/ModifyVpnTunnelOptionsCommand.ts index 5020b05d8f6c..c4128e4776f4 100644 --- a/clients/client-ec2/commands/ModifyVpnTunnelOptionsCommand.ts +++ b/clients/client-ec2/commands/ModifyVpnTunnelOptionsCommand.ts @@ -25,6 +25,20 @@ export interface ModifyVpnTunnelOptionsCommandOutput extends ModifyVpnTunnelOpti * 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 AWS Site-to-Site VPN User Guide.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { EC2Client, ModifyVpnTunnelOptionsCommand } from "@aws-sdk/client-ec2"; // ES Modules import + * // const { EC2Client, ModifyVpnTunnelOptionsCommand } = require("@aws-sdk/client-ec2"); // CommonJS import + * const client = new EC2Client(config); + * const command = new ModifyVpnTunnelOptionsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ModifyVpnTunnelOptionsCommandInput} for command's `input` shape. + * @see {@link ModifyVpnTunnelOptionsCommandOutput} for command's `response` shape. + * @see {@link EC2ClientResolvedConfig | config} for command's `input` shape. + * */ export class ModifyVpnTunnelOptionsCommand extends $Command< ModifyVpnTunnelOptionsCommandInput, diff --git a/clients/client-ec2/commands/MonitorInstancesCommand.ts b/clients/client-ec2/commands/MonitorInstancesCommand.ts index b72357d8ca8c..6814fe675184 100644 --- a/clients/client-ec2/commands/MonitorInstancesCommand.ts +++ b/clients/client-ec2/commands/MonitorInstancesCommand.ts @@ -25,6 +25,20 @@ export interface MonitorInstancesCommandOutput extends MonitorInstancesResult, _ * enabled. For more information, see Monitoring your instances and * volumes in the Amazon EC2 User Guide.

*

To disable detailed monitoring, see .

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { EC2Client, MonitorInstancesCommand } from "@aws-sdk/client-ec2"; // ES Modules import + * // const { EC2Client, MonitorInstancesCommand } = require("@aws-sdk/client-ec2"); // CommonJS import + * const client = new EC2Client(config); + * const command = new MonitorInstancesCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link MonitorInstancesCommandInput} for command's `input` shape. + * @see {@link MonitorInstancesCommandOutput} for command's `response` shape. + * @see {@link EC2ClientResolvedConfig | config} for command's `input` shape. + * */ export class MonitorInstancesCommand extends $Command< MonitorInstancesCommandInput, diff --git a/clients/client-ec2/commands/MoveAddressToVpcCommand.ts b/clients/client-ec2/commands/MoveAddressToVpcCommand.ts index ac568bde7757..6eee4bf736b5 100644 --- a/clients/client-ec2/commands/MoveAddressToVpcCommand.ts +++ b/clients/client-ec2/commands/MoveAddressToVpcCommand.ts @@ -27,6 +27,20 @@ export interface MoveAddressToVpcCommandOutput extends MoveAddressToVpcResult, _ * 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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { EC2Client, MoveAddressToVpcCommand } from "@aws-sdk/client-ec2"; // ES Modules import + * // const { EC2Client, MoveAddressToVpcCommand } = require("@aws-sdk/client-ec2"); // CommonJS import + * const client = new EC2Client(config); + * const command = new MoveAddressToVpcCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link MoveAddressToVpcCommandInput} for command's `input` shape. + * @see {@link MoveAddressToVpcCommandOutput} for command's `response` shape. + * @see {@link EC2ClientResolvedConfig | config} for command's `input` shape. + * */ export class MoveAddressToVpcCommand extends $Command< MoveAddressToVpcCommandInput, diff --git a/clients/client-ec2/commands/ProvisionByoipCidrCommand.ts b/clients/client-ec2/commands/ProvisionByoipCidrCommand.ts index babbe30809b6..f3f67613ace6 100644 --- a/clients/client-ec2/commands/ProvisionByoipCidrCommand.ts +++ b/clients/client-ec2/commands/ProvisionByoipCidrCommand.ts @@ -33,6 +33,20 @@ export interface ProvisionByoipCidrCommandOutput extends ProvisionByoipCidrResul * 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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { EC2Client, ProvisionByoipCidrCommand } from "@aws-sdk/client-ec2"; // ES Modules import + * // const { EC2Client, ProvisionByoipCidrCommand } = require("@aws-sdk/client-ec2"); // CommonJS import + * const client = new EC2Client(config); + * const command = new ProvisionByoipCidrCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ProvisionByoipCidrCommandInput} for command's `input` shape. + * @see {@link ProvisionByoipCidrCommandOutput} for command's `response` shape. + * @see {@link EC2ClientResolvedConfig | config} for command's `input` shape. + * */ export class ProvisionByoipCidrCommand extends $Command< ProvisionByoipCidrCommandInput, diff --git a/clients/client-ec2/commands/PurchaseHostReservationCommand.ts b/clients/client-ec2/commands/PurchaseHostReservationCommand.ts index f6684ed474f7..44159b504134 100644 --- a/clients/client-ec2/commands/PurchaseHostReservationCommand.ts +++ b/clients/client-ec2/commands/PurchaseHostReservationCommand.ts @@ -25,6 +25,20 @@ export interface PurchaseHostReservationCommandOutput extends PurchaseHostReserv * 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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { EC2Client, PurchaseHostReservationCommand } from "@aws-sdk/client-ec2"; // ES Modules import + * // const { EC2Client, PurchaseHostReservationCommand } = require("@aws-sdk/client-ec2"); // CommonJS import + * const client = new EC2Client(config); + * const command = new PurchaseHostReservationCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link PurchaseHostReservationCommandInput} for command's `input` shape. + * @see {@link PurchaseHostReservationCommandOutput} for command's `response` shape. + * @see {@link EC2ClientResolvedConfig | config} for command's `input` shape. + * */ export class PurchaseHostReservationCommand extends $Command< PurchaseHostReservationCommandInput, diff --git a/clients/client-ec2/commands/PurchaseReservedInstancesOfferingCommand.ts b/clients/client-ec2/commands/PurchaseReservedInstancesOfferingCommand.ts index b70221d7b831..504ec809676e 100644 --- a/clients/client-ec2/commands/PurchaseReservedInstancesOfferingCommand.ts +++ b/clients/client-ec2/commands/PurchaseReservedInstancesOfferingCommand.ts @@ -33,6 +33,20 @@ export interface PurchaseReservedInstancesOfferingCommandOutput *

For more information, see Reserved Instances and * Reserved Instance Marketplace * in the Amazon EC2 User Guide.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { EC2Client, PurchaseReservedInstancesOfferingCommand } from "@aws-sdk/client-ec2"; // ES Modules import + * // const { EC2Client, PurchaseReservedInstancesOfferingCommand } = require("@aws-sdk/client-ec2"); // CommonJS import + * const client = new EC2Client(config); + * const command = new PurchaseReservedInstancesOfferingCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link PurchaseReservedInstancesOfferingCommandInput} for command's `input` shape. + * @see {@link PurchaseReservedInstancesOfferingCommandOutput} for command's `response` shape. + * @see {@link EC2ClientResolvedConfig | config} for command's `input` shape. + * */ export class PurchaseReservedInstancesOfferingCommand extends $Command< PurchaseReservedInstancesOfferingCommandInput, diff --git a/clients/client-ec2/commands/PurchaseScheduledInstancesCommand.ts b/clients/client-ec2/commands/PurchaseScheduledInstancesCommand.ts index fb6d1e2f9669..98519f4b612a 100644 --- a/clients/client-ec2/commands/PurchaseScheduledInstancesCommand.ts +++ b/clients/client-ec2/commands/PurchaseScheduledInstancesCommand.ts @@ -27,6 +27,20 @@ export interface PurchaseScheduledInstancesCommandOutput extends PurchaseSchedul * 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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { EC2Client, PurchaseScheduledInstancesCommand } from "@aws-sdk/client-ec2"; // ES Modules import + * // const { EC2Client, PurchaseScheduledInstancesCommand } = require("@aws-sdk/client-ec2"); // CommonJS import + * const client = new EC2Client(config); + * const command = new PurchaseScheduledInstancesCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link PurchaseScheduledInstancesCommandInput} for command's `input` shape. + * @see {@link PurchaseScheduledInstancesCommandOutput} for command's `response` shape. + * @see {@link EC2ClientResolvedConfig | config} for command's `input` shape. + * */ export class PurchaseScheduledInstancesCommand extends $Command< PurchaseScheduledInstancesCommandInput, diff --git a/clients/client-ec2/commands/RebootInstancesCommand.ts b/clients/client-ec2/commands/RebootInstancesCommand.ts index 9fdccfb51680..df14ec4e831a 100644 --- a/clients/client-ec2/commands/RebootInstancesCommand.ts +++ b/clients/client-ec2/commands/RebootInstancesCommand.ts @@ -26,6 +26,20 @@ export interface RebootInstancesCommandOutput extends __MetadataBearer {} * hard reboot.

*

For more information about troubleshooting, see Getting console output and * rebooting instances in the Amazon EC2 User Guide.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { EC2Client, RebootInstancesCommand } from "@aws-sdk/client-ec2"; // ES Modules import + * // const { EC2Client, RebootInstancesCommand } = require("@aws-sdk/client-ec2"); // CommonJS import + * const client = new EC2Client(config); + * const command = new RebootInstancesCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link RebootInstancesCommandInput} for command's `input` shape. + * @see {@link RebootInstancesCommandOutput} for command's `response` shape. + * @see {@link EC2ClientResolvedConfig | config} for command's `input` shape. + * */ export class RebootInstancesCommand extends $Command< RebootInstancesCommandInput, diff --git a/clients/client-ec2/commands/RegisterImageCommand.ts b/clients/client-ec2/commands/RegisterImageCommand.ts index 2b30d4b8cc95..e09c1f5686c9 100644 --- a/clients/client-ec2/commands/RegisterImageCommand.ts +++ b/clients/client-ec2/commands/RegisterImageCommand.ts @@ -68,6 +68,20 @@ export interface RegisterImageCommandOutput extends RegisterImageResult, __Metad * 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 Obtaining billing * information in the Amazon Elastic Compute Cloud User Guide.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { EC2Client, RegisterImageCommand } from "@aws-sdk/client-ec2"; // ES Modules import + * // const { EC2Client, RegisterImageCommand } = require("@aws-sdk/client-ec2"); // CommonJS import + * const client = new EC2Client(config); + * const command = new RegisterImageCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link RegisterImageCommandInput} for command's `input` shape. + * @see {@link RegisterImageCommandOutput} for command's `response` shape. + * @see {@link EC2ClientResolvedConfig | config} for command's `input` shape. + * */ export class RegisterImageCommand extends $Command< RegisterImageCommandInput, diff --git a/clients/client-ec2/commands/RegisterInstanceEventNotificationAttributesCommand.ts b/clients/client-ec2/commands/RegisterInstanceEventNotificationAttributesCommand.ts index e8efd5dcacb1..6770401fa67e 100644 --- a/clients/client-ec2/commands/RegisterInstanceEventNotificationAttributesCommand.ts +++ b/clients/client-ec2/commands/RegisterInstanceEventNotificationAttributesCommand.ts @@ -30,6 +30,20 @@ export interface RegisterInstanceEventNotificationAttributesCommandOutput *

Registers a set of tag keys to include in scheduled event notifications for your resources. *

*

To remove tags, use .

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { EC2Client, RegisterInstanceEventNotificationAttributesCommand } from "@aws-sdk/client-ec2"; // ES Modules import + * // const { EC2Client, RegisterInstanceEventNotificationAttributesCommand } = require("@aws-sdk/client-ec2"); // CommonJS import + * const client = new EC2Client(config); + * const command = new RegisterInstanceEventNotificationAttributesCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link RegisterInstanceEventNotificationAttributesCommandInput} for command's `input` shape. + * @see {@link RegisterInstanceEventNotificationAttributesCommandOutput} for command's `response` shape. + * @see {@link EC2ClientResolvedConfig | config} for command's `input` shape. + * */ export class RegisterInstanceEventNotificationAttributesCommand extends $Command< RegisterInstanceEventNotificationAttributesCommandInput, diff --git a/clients/client-ec2/commands/RegisterTransitGatewayMulticastGroupMembersCommand.ts b/clients/client-ec2/commands/RegisterTransitGatewayMulticastGroupMembersCommand.ts index c5b3c8c88a42..4a07609de34f 100644 --- a/clients/client-ec2/commands/RegisterTransitGatewayMulticastGroupMembersCommand.ts +++ b/clients/client-ec2/commands/RegisterTransitGatewayMulticastGroupMembersCommand.ts @@ -33,6 +33,20 @@ export interface RegisterTransitGatewayMulticastGroupMembersCommandOutput * 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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { EC2Client, RegisterTransitGatewayMulticastGroupMembersCommand } from "@aws-sdk/client-ec2"; // ES Modules import + * // const { EC2Client, RegisterTransitGatewayMulticastGroupMembersCommand } = require("@aws-sdk/client-ec2"); // CommonJS import + * const client = new EC2Client(config); + * const command = new RegisterTransitGatewayMulticastGroupMembersCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link RegisterTransitGatewayMulticastGroupMembersCommandInput} for command's `input` shape. + * @see {@link RegisterTransitGatewayMulticastGroupMembersCommandOutput} for command's `response` shape. + * @see {@link EC2ClientResolvedConfig | config} for command's `input` shape. + * */ export class RegisterTransitGatewayMulticastGroupMembersCommand extends $Command< RegisterTransitGatewayMulticastGroupMembersCommandInput, diff --git a/clients/client-ec2/commands/RegisterTransitGatewayMulticastGroupSourcesCommand.ts b/clients/client-ec2/commands/RegisterTransitGatewayMulticastGroupSourcesCommand.ts index 3ce94e937573..78f356f27276 100644 --- a/clients/client-ec2/commands/RegisterTransitGatewayMulticastGroupSourcesCommand.ts +++ b/clients/client-ec2/commands/RegisterTransitGatewayMulticastGroupSourcesCommand.ts @@ -33,6 +33,20 @@ export interface RegisterTransitGatewayMulticastGroupSourcesCommandOutput * Considerations in Amazon VPC Transit Gateways.

*

After you add the source, use SearchTransitGatewayMulticastGroups to verify that the source was added to the multicast * group.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { EC2Client, RegisterTransitGatewayMulticastGroupSourcesCommand } from "@aws-sdk/client-ec2"; // ES Modules import + * // const { EC2Client, RegisterTransitGatewayMulticastGroupSourcesCommand } = require("@aws-sdk/client-ec2"); // CommonJS import + * const client = new EC2Client(config); + * const command = new RegisterTransitGatewayMulticastGroupSourcesCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link RegisterTransitGatewayMulticastGroupSourcesCommandInput} for command's `input` shape. + * @see {@link RegisterTransitGatewayMulticastGroupSourcesCommandOutput} for command's `response` shape. + * @see {@link EC2ClientResolvedConfig | config} for command's `input` shape. + * */ export class RegisterTransitGatewayMulticastGroupSourcesCommand extends $Command< RegisterTransitGatewayMulticastGroupSourcesCommandInput, diff --git a/clients/client-ec2/commands/RejectTransitGatewayMulticastDomainAssociationsCommand.ts b/clients/client-ec2/commands/RejectTransitGatewayMulticastDomainAssociationsCommand.ts index 3804cd2f887b..08a1d9c4eefd 100644 --- a/clients/client-ec2/commands/RejectTransitGatewayMulticastDomainAssociationsCommand.ts +++ b/clients/client-ec2/commands/RejectTransitGatewayMulticastDomainAssociationsCommand.ts @@ -28,6 +28,20 @@ export interface RejectTransitGatewayMulticastDomainAssociationsCommandOutput /** *

Rejects a request to associate cross-account subnets with a transit gateway multicast domain.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { EC2Client, RejectTransitGatewayMulticastDomainAssociationsCommand } from "@aws-sdk/client-ec2"; // ES Modules import + * // const { EC2Client, RejectTransitGatewayMulticastDomainAssociationsCommand } = require("@aws-sdk/client-ec2"); // CommonJS import + * const client = new EC2Client(config); + * const command = new RejectTransitGatewayMulticastDomainAssociationsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link RejectTransitGatewayMulticastDomainAssociationsCommandInput} for command's `input` shape. + * @see {@link RejectTransitGatewayMulticastDomainAssociationsCommandOutput} for command's `response` shape. + * @see {@link EC2ClientResolvedConfig | config} for command's `input` shape. + * */ export class RejectTransitGatewayMulticastDomainAssociationsCommand extends $Command< RejectTransitGatewayMulticastDomainAssociationsCommandInput, diff --git a/clients/client-ec2/commands/RejectTransitGatewayPeeringAttachmentCommand.ts b/clients/client-ec2/commands/RejectTransitGatewayPeeringAttachmentCommand.ts index 88a959b7e5b4..64c9ff90769a 100644 --- a/clients/client-ec2/commands/RejectTransitGatewayPeeringAttachmentCommand.ts +++ b/clients/client-ec2/commands/RejectTransitGatewayPeeringAttachmentCommand.ts @@ -28,6 +28,20 @@ export interface RejectTransitGatewayPeeringAttachmentCommandOutput /** *

Rejects a transit gateway peering attachment request.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { EC2Client, RejectTransitGatewayPeeringAttachmentCommand } from "@aws-sdk/client-ec2"; // ES Modules import + * // const { EC2Client, RejectTransitGatewayPeeringAttachmentCommand } = require("@aws-sdk/client-ec2"); // CommonJS import + * const client = new EC2Client(config); + * const command = new RejectTransitGatewayPeeringAttachmentCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link RejectTransitGatewayPeeringAttachmentCommandInput} for command's `input` shape. + * @see {@link RejectTransitGatewayPeeringAttachmentCommandOutput} for command's `response` shape. + * @see {@link EC2ClientResolvedConfig | config} for command's `input` shape. + * */ export class RejectTransitGatewayPeeringAttachmentCommand extends $Command< RejectTransitGatewayPeeringAttachmentCommandInput, diff --git a/clients/client-ec2/commands/RejectTransitGatewayVpcAttachmentCommand.ts b/clients/client-ec2/commands/RejectTransitGatewayVpcAttachmentCommand.ts index 963f74bbf73d..fd63f4b394f9 100644 --- a/clients/client-ec2/commands/RejectTransitGatewayVpcAttachmentCommand.ts +++ b/clients/client-ec2/commands/RejectTransitGatewayVpcAttachmentCommand.ts @@ -27,6 +27,20 @@ export interface RejectTransitGatewayVpcAttachmentCommandOutput *

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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { EC2Client, RejectTransitGatewayVpcAttachmentCommand } from "@aws-sdk/client-ec2"; // ES Modules import + * // const { EC2Client, RejectTransitGatewayVpcAttachmentCommand } = require("@aws-sdk/client-ec2"); // CommonJS import + * const client = new EC2Client(config); + * const command = new RejectTransitGatewayVpcAttachmentCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link RejectTransitGatewayVpcAttachmentCommandInput} for command's `input` shape. + * @see {@link RejectTransitGatewayVpcAttachmentCommandOutput} for command's `response` shape. + * @see {@link EC2ClientResolvedConfig | config} for command's `input` shape. + * */ export class RejectTransitGatewayVpcAttachmentCommand extends $Command< RejectTransitGatewayVpcAttachmentCommandInput, diff --git a/clients/client-ec2/commands/RejectVpcEndpointConnectionsCommand.ts b/clients/client-ec2/commands/RejectVpcEndpointConnectionsCommand.ts index 507c89e9fe3a..cbd8de0d29e8 100644 --- a/clients/client-ec2/commands/RejectVpcEndpointConnectionsCommand.ts +++ b/clients/client-ec2/commands/RejectVpcEndpointConnectionsCommand.ts @@ -25,6 +25,20 @@ export interface RejectVpcEndpointConnectionsCommandOutput /** *

Rejects one or more VPC endpoint connection requests to your VPC endpoint * service.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { EC2Client, RejectVpcEndpointConnectionsCommand } from "@aws-sdk/client-ec2"; // ES Modules import + * // const { EC2Client, RejectVpcEndpointConnectionsCommand } = require("@aws-sdk/client-ec2"); // CommonJS import + * const client = new EC2Client(config); + * const command = new RejectVpcEndpointConnectionsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link RejectVpcEndpointConnectionsCommandInput} for command's `input` shape. + * @see {@link RejectVpcEndpointConnectionsCommandOutput} for command's `response` shape. + * @see {@link EC2ClientResolvedConfig | config} for command's `input` shape. + * */ export class RejectVpcEndpointConnectionsCommand extends $Command< RejectVpcEndpointConnectionsCommandInput, diff --git a/clients/client-ec2/commands/RejectVpcPeeringConnectionCommand.ts b/clients/client-ec2/commands/RejectVpcPeeringConnectionCommand.ts index 1c1db112e77f..9ced94da79f4 100644 --- a/clients/client-ec2/commands/RejectVpcPeeringConnectionCommand.ts +++ b/clients/client-ec2/commands/RejectVpcPeeringConnectionCommand.ts @@ -25,6 +25,20 @@ export interface RejectVpcPeeringConnectionCommandOutput extends RejectVpcPeerin * 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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { EC2Client, RejectVpcPeeringConnectionCommand } from "@aws-sdk/client-ec2"; // ES Modules import + * // const { EC2Client, RejectVpcPeeringConnectionCommand } = require("@aws-sdk/client-ec2"); // CommonJS import + * const client = new EC2Client(config); + * const command = new RejectVpcPeeringConnectionCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link RejectVpcPeeringConnectionCommandInput} for command's `input` shape. + * @see {@link RejectVpcPeeringConnectionCommandOutput} for command's `response` shape. + * @see {@link EC2ClientResolvedConfig | config} for command's `input` shape. + * */ export class RejectVpcPeeringConnectionCommand extends $Command< RejectVpcPeeringConnectionCommandInput, diff --git a/clients/client-ec2/commands/ReleaseAddressCommand.ts b/clients/client-ec2/commands/ReleaseAddressCommand.ts index ed184d11eade..a151a5a0aa26 100644 --- a/clients/client-ec2/commands/ReleaseAddressCommand.ts +++ b/clients/client-ec2/commands/ReleaseAddressCommand.ts @@ -30,6 +30,20 @@ export interface ReleaseAddressCommandOutput extends __MetadataBearer {} * AuthFailure error if the address is already allocated to another AWS 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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { EC2Client, ReleaseAddressCommand } from "@aws-sdk/client-ec2"; // ES Modules import + * // const { EC2Client, ReleaseAddressCommand } = require("@aws-sdk/client-ec2"); // CommonJS import + * const client = new EC2Client(config); + * const command = new ReleaseAddressCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ReleaseAddressCommandInput} for command's `input` shape. + * @see {@link ReleaseAddressCommandOutput} for command's `response` shape. + * @see {@link EC2ClientResolvedConfig | config} for command's `input` shape. + * */ export class ReleaseAddressCommand extends $Command< ReleaseAddressCommandInput, diff --git a/clients/client-ec2/commands/ReleaseHostsCommand.ts b/clients/client-ec2/commands/ReleaseHostsCommand.ts index 7597cd677c36..7a14615017ab 100644 --- a/clients/client-ec2/commands/ReleaseHostsCommand.ts +++ b/clients/client-ec2/commands/ReleaseHostsCommand.ts @@ -27,6 +27,20 @@ export interface ReleaseHostsCommandOutput extends ReleaseHostsResult, __Metadat * 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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { EC2Client, ReleaseHostsCommand } from "@aws-sdk/client-ec2"; // ES Modules import + * // const { EC2Client, ReleaseHostsCommand } = require("@aws-sdk/client-ec2"); // CommonJS import + * const client = new EC2Client(config); + * const command = new ReleaseHostsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ReleaseHostsCommandInput} for command's `input` shape. + * @see {@link ReleaseHostsCommandOutput} for command's `response` shape. + * @see {@link EC2ClientResolvedConfig | config} for command's `input` shape. + * */ export class ReleaseHostsCommand extends $Command< ReleaseHostsCommandInput, diff --git a/clients/client-ec2/commands/ReplaceIamInstanceProfileAssociationCommand.ts b/clients/client-ec2/commands/ReplaceIamInstanceProfileAssociationCommand.ts index afc023d0575c..368f0cf11416 100644 --- a/clients/client-ec2/commands/ReplaceIamInstanceProfileAssociationCommand.ts +++ b/clients/client-ec2/commands/ReplaceIamInstanceProfileAssociationCommand.ts @@ -31,6 +31,20 @@ export interface ReplaceIamInstanceProfileAssociationCommandOutput * without having to disassociate the existing IAM instance profile first.

*

Use DescribeIamInstanceProfileAssociations to get the association * ID.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { EC2Client, ReplaceIamInstanceProfileAssociationCommand } from "@aws-sdk/client-ec2"; // ES Modules import + * // const { EC2Client, ReplaceIamInstanceProfileAssociationCommand } = require("@aws-sdk/client-ec2"); // CommonJS import + * const client = new EC2Client(config); + * const command = new ReplaceIamInstanceProfileAssociationCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ReplaceIamInstanceProfileAssociationCommandInput} for command's `input` shape. + * @see {@link ReplaceIamInstanceProfileAssociationCommandOutput} for command's `response` shape. + * @see {@link EC2ClientResolvedConfig | config} for command's `input` shape. + * */ export class ReplaceIamInstanceProfileAssociationCommand extends $Command< ReplaceIamInstanceProfileAssociationCommandInput, diff --git a/clients/client-ec2/commands/ReplaceNetworkAclAssociationCommand.ts b/clients/client-ec2/commands/ReplaceNetworkAclAssociationCommand.ts index 5611ddebbb81..ba551f91bf25 100644 --- a/clients/client-ec2/commands/ReplaceNetworkAclAssociationCommand.ts +++ b/clients/client-ec2/commands/ReplaceNetworkAclAssociationCommand.ts @@ -28,6 +28,20 @@ export interface ReplaceNetworkAclAssociationCommandOutput * information, see Network * ACLs in the Amazon Virtual Private Cloud User Guide.

*

This is an idempotent operation.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { EC2Client, ReplaceNetworkAclAssociationCommand } from "@aws-sdk/client-ec2"; // ES Modules import + * // const { EC2Client, ReplaceNetworkAclAssociationCommand } = require("@aws-sdk/client-ec2"); // CommonJS import + * const client = new EC2Client(config); + * const command = new ReplaceNetworkAclAssociationCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ReplaceNetworkAclAssociationCommandInput} for command's `input` shape. + * @see {@link ReplaceNetworkAclAssociationCommandOutput} for command's `response` shape. + * @see {@link EC2ClientResolvedConfig | config} for command's `input` shape. + * */ export class ReplaceNetworkAclAssociationCommand extends $Command< ReplaceNetworkAclAssociationCommandInput, diff --git a/clients/client-ec2/commands/ReplaceNetworkAclEntryCommand.ts b/clients/client-ec2/commands/ReplaceNetworkAclEntryCommand.ts index b6e3d8ff842e..f48c371cf04c 100644 --- a/clients/client-ec2/commands/ReplaceNetworkAclEntryCommand.ts +++ b/clients/client-ec2/commands/ReplaceNetworkAclEntryCommand.ts @@ -23,6 +23,20 @@ export interface ReplaceNetworkAclEntryCommandOutput extends __MetadataBearer {} /** *

Replaces an entry (rule) in a network ACL. For more information, see Network ACLs in the * Amazon Virtual Private Cloud User Guide.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { EC2Client, ReplaceNetworkAclEntryCommand } from "@aws-sdk/client-ec2"; // ES Modules import + * // const { EC2Client, ReplaceNetworkAclEntryCommand } = require("@aws-sdk/client-ec2"); // CommonJS import + * const client = new EC2Client(config); + * const command = new ReplaceNetworkAclEntryCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ReplaceNetworkAclEntryCommandInput} for command's `input` shape. + * @see {@link ReplaceNetworkAclEntryCommandOutput} for command's `response` shape. + * @see {@link EC2ClientResolvedConfig | config} for command's `input` shape. + * */ export class ReplaceNetworkAclEntryCommand extends $Command< ReplaceNetworkAclEntryCommandInput, diff --git a/clients/client-ec2/commands/ReplaceRouteCommand.ts b/clients/client-ec2/commands/ReplaceRouteCommand.ts index 3372e66545f5..9297e89bdf41 100644 --- a/clients/client-ec2/commands/ReplaceRouteCommand.ts +++ b/clients/client-ec2/commands/ReplaceRouteCommand.ts @@ -24,6 +24,20 @@ export interface ReplaceRouteCommandOutput extends __MetadataBearer {} * gateway.

*

For more information, see Route Tables in the * Amazon Virtual Private Cloud User Guide.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { EC2Client, ReplaceRouteCommand } from "@aws-sdk/client-ec2"; // ES Modules import + * // const { EC2Client, ReplaceRouteCommand } = require("@aws-sdk/client-ec2"); // CommonJS import + * const client = new EC2Client(config); + * const command = new ReplaceRouteCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ReplaceRouteCommandInput} for command's `input` shape. + * @see {@link ReplaceRouteCommandOutput} for command's `response` shape. + * @see {@link EC2ClientResolvedConfig | config} for command's `input` shape. + * */ export class ReplaceRouteCommand extends $Command< ReplaceRouteCommandInput, diff --git a/clients/client-ec2/commands/ReplaceRouteTableAssociationCommand.ts b/clients/client-ec2/commands/ReplaceRouteTableAssociationCommand.ts index 6fd840f558b0..8742cc84bd24 100644 --- a/clients/client-ec2/commands/ReplaceRouteTableAssociationCommand.ts +++ b/clients/client-ec2/commands/ReplaceRouteTableAssociationCommand.ts @@ -28,6 +28,20 @@ export interface ReplaceRouteTableAssociationCommandOutput * 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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { EC2Client, ReplaceRouteTableAssociationCommand } from "@aws-sdk/client-ec2"; // ES Modules import + * // const { EC2Client, ReplaceRouteTableAssociationCommand } = require("@aws-sdk/client-ec2"); // CommonJS import + * const client = new EC2Client(config); + * const command = new ReplaceRouteTableAssociationCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ReplaceRouteTableAssociationCommandInput} for command's `input` shape. + * @see {@link ReplaceRouteTableAssociationCommandOutput} for command's `response` shape. + * @see {@link EC2ClientResolvedConfig | config} for command's `input` shape. + * */ export class ReplaceRouteTableAssociationCommand extends $Command< ReplaceRouteTableAssociationCommandInput, diff --git a/clients/client-ec2/commands/ReplaceTransitGatewayRouteCommand.ts b/clients/client-ec2/commands/ReplaceTransitGatewayRouteCommand.ts index 296b86a20661..96d433f3f709 100644 --- a/clients/client-ec2/commands/ReplaceTransitGatewayRouteCommand.ts +++ b/clients/client-ec2/commands/ReplaceTransitGatewayRouteCommand.ts @@ -22,6 +22,20 @@ export interface ReplaceTransitGatewayRouteCommandOutput extends ReplaceTransitG /** *

Replaces the specified route in the specified transit gateway route table.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { EC2Client, ReplaceTransitGatewayRouteCommand } from "@aws-sdk/client-ec2"; // ES Modules import + * // const { EC2Client, ReplaceTransitGatewayRouteCommand } = require("@aws-sdk/client-ec2"); // CommonJS import + * const client = new EC2Client(config); + * const command = new ReplaceTransitGatewayRouteCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ReplaceTransitGatewayRouteCommandInput} for command's `input` shape. + * @see {@link ReplaceTransitGatewayRouteCommandOutput} for command's `response` shape. + * @see {@link EC2ClientResolvedConfig | config} for command's `input` shape. + * */ export class ReplaceTransitGatewayRouteCommand extends $Command< ReplaceTransitGatewayRouteCommandInput, diff --git a/clients/client-ec2/commands/ReportInstanceStatusCommand.ts b/clients/client-ec2/commands/ReportInstanceStatusCommand.ts index ec4bf27ab1a1..b21b23e0c022 100644 --- a/clients/client-ec2/commands/ReportInstanceStatusCommand.ts +++ b/clients/client-ec2/commands/ReportInstanceStatusCommand.ts @@ -26,6 +26,20 @@ export interface ReportInstanceStatusCommandOutput extends __MetadataBearer {} * 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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { EC2Client, ReportInstanceStatusCommand } from "@aws-sdk/client-ec2"; // ES Modules import + * // const { EC2Client, ReportInstanceStatusCommand } = require("@aws-sdk/client-ec2"); // CommonJS import + * const client = new EC2Client(config); + * const command = new ReportInstanceStatusCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ReportInstanceStatusCommandInput} for command's `input` shape. + * @see {@link ReportInstanceStatusCommandOutput} for command's `response` shape. + * @see {@link EC2ClientResolvedConfig | config} for command's `input` shape. + * */ export class ReportInstanceStatusCommand extends $Command< ReportInstanceStatusCommandInput, diff --git a/clients/client-ec2/commands/RequestSpotFleetCommand.ts b/clients/client-ec2/commands/RequestSpotFleetCommand.ts index af97c8b8ddbe..3c861288e9fb 100644 --- a/clients/client-ec2/commands/RequestSpotFleetCommand.ts +++ b/clients/client-ec2/commands/RequestSpotFleetCommand.ts @@ -37,6 +37,20 @@ export interface RequestSpotFleetCommandOutput extends RequestSpotFleetResponse, * supported.

*

For more information, see Spot Fleet requests * in the Amazon EC2 User Guide for Linux Instances.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { EC2Client, RequestSpotFleetCommand } from "@aws-sdk/client-ec2"; // ES Modules import + * // const { EC2Client, RequestSpotFleetCommand } = require("@aws-sdk/client-ec2"); // CommonJS import + * const client = new EC2Client(config); + * const command = new RequestSpotFleetCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link RequestSpotFleetCommandInput} for command's `input` shape. + * @see {@link RequestSpotFleetCommandOutput} for command's `response` shape. + * @see {@link EC2ClientResolvedConfig | config} for command's `input` shape. + * */ export class RequestSpotFleetCommand extends $Command< RequestSpotFleetCommandInput, diff --git a/clients/client-ec2/commands/RequestSpotInstancesCommand.ts b/clients/client-ec2/commands/RequestSpotInstancesCommand.ts index 2be139995abe..05032f30d2ae 100644 --- a/clients/client-ec2/commands/RequestSpotInstancesCommand.ts +++ b/clients/client-ec2/commands/RequestSpotInstancesCommand.ts @@ -23,6 +23,20 @@ export interface RequestSpotInstancesCommandOutput extends RequestSpotInstancesR /** *

Creates a Spot Instance request.

*

For more information, see Spot Instance requests in the Amazon EC2 User Guide for Linux Instances.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { EC2Client, RequestSpotInstancesCommand } from "@aws-sdk/client-ec2"; // ES Modules import + * // const { EC2Client, RequestSpotInstancesCommand } = require("@aws-sdk/client-ec2"); // CommonJS import + * const client = new EC2Client(config); + * const command = new RequestSpotInstancesCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link RequestSpotInstancesCommandInput} for command's `input` shape. + * @see {@link RequestSpotInstancesCommandOutput} for command's `response` shape. + * @see {@link EC2ClientResolvedConfig | config} for command's `input` shape. + * */ export class RequestSpotInstancesCommand extends $Command< RequestSpotInstancesCommandInput, diff --git a/clients/client-ec2/commands/ResetAddressAttributeCommand.ts b/clients/client-ec2/commands/ResetAddressAttributeCommand.ts index 7c78e3fd76b0..705ef1d8c4c9 100644 --- a/clients/client-ec2/commands/ResetAddressAttributeCommand.ts +++ b/clients/client-ec2/commands/ResetAddressAttributeCommand.ts @@ -22,6 +22,20 @@ export interface ResetAddressAttributeCommandOutput extends ResetAddressAttribut /** *

Resets the attribute of the specified IP address. For requirements, see Using reverse DNS for email applications.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { EC2Client, ResetAddressAttributeCommand } from "@aws-sdk/client-ec2"; // ES Modules import + * // const { EC2Client, ResetAddressAttributeCommand } = require("@aws-sdk/client-ec2"); // CommonJS import + * const client = new EC2Client(config); + * const command = new ResetAddressAttributeCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ResetAddressAttributeCommandInput} for command's `input` shape. + * @see {@link ResetAddressAttributeCommandOutput} for command's `response` shape. + * @see {@link EC2ClientResolvedConfig | config} for command's `input` shape. + * */ export class ResetAddressAttributeCommand extends $Command< ResetAddressAttributeCommandInput, diff --git a/clients/client-ec2/commands/ResetEbsDefaultKmsKeyIdCommand.ts b/clients/client-ec2/commands/ResetEbsDefaultKmsKeyIdCommand.ts index 8a2ca59cc933..f44bc56ca68b 100644 --- a/clients/client-ec2/commands/ResetEbsDefaultKmsKeyIdCommand.ts +++ b/clients/client-ec2/commands/ResetEbsDefaultKmsKeyIdCommand.ts @@ -27,6 +27,20 @@ export interface ResetEbsDefaultKmsKeyIdCommandOutput extends ResetEbsDefaultKms * customer managed CMK by specifying it when you create the volume. For more information, see * Amazon EBS encryption * in the Amazon Elastic Compute Cloud User Guide.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { EC2Client, ResetEbsDefaultKmsKeyIdCommand } from "@aws-sdk/client-ec2"; // ES Modules import + * // const { EC2Client, ResetEbsDefaultKmsKeyIdCommand } = require("@aws-sdk/client-ec2"); // CommonJS import + * const client = new EC2Client(config); + * const command = new ResetEbsDefaultKmsKeyIdCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ResetEbsDefaultKmsKeyIdCommandInput} for command's `input` shape. + * @see {@link ResetEbsDefaultKmsKeyIdCommandOutput} for command's `response` shape. + * @see {@link EC2ClientResolvedConfig | config} for command's `input` shape. + * */ export class ResetEbsDefaultKmsKeyIdCommand extends $Command< ResetEbsDefaultKmsKeyIdCommandInput, diff --git a/clients/client-ec2/commands/ResetFpgaImageAttributeCommand.ts b/clients/client-ec2/commands/ResetFpgaImageAttributeCommand.ts index 852a29889dca..2718e7d37712 100644 --- a/clients/client-ec2/commands/ResetFpgaImageAttributeCommand.ts +++ b/clients/client-ec2/commands/ResetFpgaImageAttributeCommand.ts @@ -23,6 +23,20 @@ export interface ResetFpgaImageAttributeCommandOutput extends ResetFpgaImageAttr /** *

Resets the specified attribute of the specified Amazon FPGA Image (AFI) to its default value. * You can only reset the load permission attribute.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { EC2Client, ResetFpgaImageAttributeCommand } from "@aws-sdk/client-ec2"; // ES Modules import + * // const { EC2Client, ResetFpgaImageAttributeCommand } = require("@aws-sdk/client-ec2"); // CommonJS import + * const client = new EC2Client(config); + * const command = new ResetFpgaImageAttributeCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ResetFpgaImageAttributeCommandInput} for command's `input` shape. + * @see {@link ResetFpgaImageAttributeCommandOutput} for command's `response` shape. + * @see {@link EC2ClientResolvedConfig | config} for command's `input` shape. + * */ export class ResetFpgaImageAttributeCommand extends $Command< ResetFpgaImageAttributeCommandInput, diff --git a/clients/client-ec2/commands/ResetImageAttributeCommand.ts b/clients/client-ec2/commands/ResetImageAttributeCommand.ts index 6659d07a2d45..7ba51665a909 100644 --- a/clients/client-ec2/commands/ResetImageAttributeCommand.ts +++ b/clients/client-ec2/commands/ResetImageAttributeCommand.ts @@ -25,6 +25,20 @@ export interface ResetImageAttributeCommandOutput extends __MetadataBearer {} * *

The productCodes attribute can't be reset.

* + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { EC2Client, ResetImageAttributeCommand } from "@aws-sdk/client-ec2"; // ES Modules import + * // const { EC2Client, ResetImageAttributeCommand } = require("@aws-sdk/client-ec2"); // CommonJS import + * const client = new EC2Client(config); + * const command = new ResetImageAttributeCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ResetImageAttributeCommandInput} for command's `input` shape. + * @see {@link ResetImageAttributeCommandOutput} for command's `response` shape. + * @see {@link EC2ClientResolvedConfig | config} for command's `input` shape. + * */ export class ResetImageAttributeCommand extends $Command< ResetImageAttributeCommandInput, diff --git a/clients/client-ec2/commands/ResetInstanceAttributeCommand.ts b/clients/client-ec2/commands/ResetInstanceAttributeCommand.ts index 2cbf96a6886b..5aae6002b664 100644 --- a/clients/client-ec2/commands/ResetInstanceAttributeCommand.ts +++ b/clients/client-ec2/commands/ResetInstanceAttributeCommand.ts @@ -30,6 +30,20 @@ export interface ResetInstanceAttributeCommandOutput extends __MetadataBearer {} * 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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { EC2Client, ResetInstanceAttributeCommand } from "@aws-sdk/client-ec2"; // ES Modules import + * // const { EC2Client, ResetInstanceAttributeCommand } = require("@aws-sdk/client-ec2"); // CommonJS import + * const client = new EC2Client(config); + * const command = new ResetInstanceAttributeCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ResetInstanceAttributeCommandInput} for command's `input` shape. + * @see {@link ResetInstanceAttributeCommandOutput} for command's `response` shape. + * @see {@link EC2ClientResolvedConfig | config} for command's `input` shape. + * */ export class ResetInstanceAttributeCommand extends $Command< ResetInstanceAttributeCommandInput, diff --git a/clients/client-ec2/commands/ResetNetworkInterfaceAttributeCommand.ts b/clients/client-ec2/commands/ResetNetworkInterfaceAttributeCommand.ts index 4625ff6d81e0..a7bc20cb7366 100644 --- a/clients/client-ec2/commands/ResetNetworkInterfaceAttributeCommand.ts +++ b/clients/client-ec2/commands/ResetNetworkInterfaceAttributeCommand.ts @@ -22,6 +22,20 @@ export interface ResetNetworkInterfaceAttributeCommandOutput extends __MetadataB /** *

Resets a network interface attribute. You can specify only one attribute at a time.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { EC2Client, ResetNetworkInterfaceAttributeCommand } from "@aws-sdk/client-ec2"; // ES Modules import + * // const { EC2Client, ResetNetworkInterfaceAttributeCommand } = require("@aws-sdk/client-ec2"); // CommonJS import + * const client = new EC2Client(config); + * const command = new ResetNetworkInterfaceAttributeCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ResetNetworkInterfaceAttributeCommandInput} for command's `input` shape. + * @see {@link ResetNetworkInterfaceAttributeCommandOutput} for command's `response` shape. + * @see {@link EC2ClientResolvedConfig | config} for command's `input` shape. + * */ export class ResetNetworkInterfaceAttributeCommand extends $Command< ResetNetworkInterfaceAttributeCommandInput, diff --git a/clients/client-ec2/commands/ResetSnapshotAttributeCommand.ts b/clients/client-ec2/commands/ResetSnapshotAttributeCommand.ts index fb9ccafa1b12..f81b2558edcc 100644 --- a/clients/client-ec2/commands/ResetSnapshotAttributeCommand.ts +++ b/clients/client-ec2/commands/ResetSnapshotAttributeCommand.ts @@ -24,6 +24,20 @@ export interface ResetSnapshotAttributeCommandOutput extends __MetadataBearer {} *

Resets permission settings for the specified snapshot.

*

For more information about modifying snapshot permissions, see Sharing snapshots in the * Amazon Elastic Compute Cloud User Guide.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { EC2Client, ResetSnapshotAttributeCommand } from "@aws-sdk/client-ec2"; // ES Modules import + * // const { EC2Client, ResetSnapshotAttributeCommand } = require("@aws-sdk/client-ec2"); // CommonJS import + * const client = new EC2Client(config); + * const command = new ResetSnapshotAttributeCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ResetSnapshotAttributeCommandInput} for command's `input` shape. + * @see {@link ResetSnapshotAttributeCommandOutput} for command's `response` shape. + * @see {@link EC2ClientResolvedConfig | config} for command's `input` shape. + * */ export class ResetSnapshotAttributeCommand extends $Command< ResetSnapshotAttributeCommandInput, diff --git a/clients/client-ec2/commands/RestoreAddressToClassicCommand.ts b/clients/client-ec2/commands/RestoreAddressToClassicCommand.ts index 65c69c914971..7fcd5bad2a42 100644 --- a/clients/client-ec2/commands/RestoreAddressToClassicCommand.ts +++ b/clients/client-ec2/commands/RestoreAddressToClassicCommand.ts @@ -22,6 +22,20 @@ export interface RestoreAddressToClassicCommandOutput extends RestoreAddressToCl /** *

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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { EC2Client, RestoreAddressToClassicCommand } from "@aws-sdk/client-ec2"; // ES Modules import + * // const { EC2Client, RestoreAddressToClassicCommand } = require("@aws-sdk/client-ec2"); // CommonJS import + * const client = new EC2Client(config); + * const command = new RestoreAddressToClassicCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link RestoreAddressToClassicCommandInput} for command's `input` shape. + * @see {@link RestoreAddressToClassicCommandOutput} for command's `response` shape. + * @see {@link EC2ClientResolvedConfig | config} for command's `input` shape. + * */ export class RestoreAddressToClassicCommand extends $Command< RestoreAddressToClassicCommandInput, diff --git a/clients/client-ec2/commands/RestoreManagedPrefixListVersionCommand.ts b/clients/client-ec2/commands/RestoreManagedPrefixListVersionCommand.ts index dc57756a0bb6..5d3661e67adb 100644 --- a/clients/client-ec2/commands/RestoreManagedPrefixListVersionCommand.ts +++ b/clients/client-ec2/commands/RestoreManagedPrefixListVersionCommand.ts @@ -24,6 +24,20 @@ export interface RestoreManagedPrefixListVersionCommandOutput /** *

Restores the entries from a previous version of a managed prefix list to a new version of the prefix list.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { EC2Client, RestoreManagedPrefixListVersionCommand } from "@aws-sdk/client-ec2"; // ES Modules import + * // const { EC2Client, RestoreManagedPrefixListVersionCommand } = require("@aws-sdk/client-ec2"); // CommonJS import + * const client = new EC2Client(config); + * const command = new RestoreManagedPrefixListVersionCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link RestoreManagedPrefixListVersionCommandInput} for command's `input` shape. + * @see {@link RestoreManagedPrefixListVersionCommandOutput} for command's `response` shape. + * @see {@link EC2ClientResolvedConfig | config} for command's `input` shape. + * */ export class RestoreManagedPrefixListVersionCommand extends $Command< RestoreManagedPrefixListVersionCommandInput, diff --git a/clients/client-ec2/commands/RevokeClientVpnIngressCommand.ts b/clients/client-ec2/commands/RevokeClientVpnIngressCommand.ts index 2ba6eb58b4e4..c2cd08022870 100644 --- a/clients/client-ec2/commands/RevokeClientVpnIngressCommand.ts +++ b/clients/client-ec2/commands/RevokeClientVpnIngressCommand.ts @@ -22,6 +22,20 @@ export interface RevokeClientVpnIngressCommandOutput extends RevokeClientVpnIngr /** *

Removes an ingress authorization rule from a Client VPN endpoint.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { EC2Client, RevokeClientVpnIngressCommand } from "@aws-sdk/client-ec2"; // ES Modules import + * // const { EC2Client, RevokeClientVpnIngressCommand } = require("@aws-sdk/client-ec2"); // CommonJS import + * const client = new EC2Client(config); + * const command = new RevokeClientVpnIngressCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link RevokeClientVpnIngressCommandInput} for command's `input` shape. + * @see {@link RevokeClientVpnIngressCommandOutput} for command's `response` shape. + * @see {@link EC2ClientResolvedConfig | config} for command's `input` shape. + * */ export class RevokeClientVpnIngressCommand extends $Command< RevokeClientVpnIngressCommandInput, diff --git a/clients/client-ec2/commands/RevokeSecurityGroupEgressCommand.ts b/clients/client-ec2/commands/RevokeSecurityGroupEgressCommand.ts index b81c0cc881f0..d71db78fc56b 100644 --- a/clients/client-ec2/commands/RevokeSecurityGroupEgressCommand.ts +++ b/clients/client-ec2/commands/RevokeSecurityGroupEgressCommand.ts @@ -36,6 +36,20 @@ export interface RevokeSecurityGroupEgressCommandOutput extends RevokeSecurityGr * 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 have to specify the description to revoke the rule.

*

Rule changes are propagated to instances within the security group as quickly as possible. However, a small delay might occur.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { EC2Client, RevokeSecurityGroupEgressCommand } from "@aws-sdk/client-ec2"; // ES Modules import + * // const { EC2Client, RevokeSecurityGroupEgressCommand } = require("@aws-sdk/client-ec2"); // CommonJS import + * const client = new EC2Client(config); + * const command = new RevokeSecurityGroupEgressCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link RevokeSecurityGroupEgressCommandInput} for command's `input` shape. + * @see {@link RevokeSecurityGroupEgressCommandOutput} for command's `response` shape. + * @see {@link EC2ClientResolvedConfig | config} for command's `input` shape. + * */ export class RevokeSecurityGroupEgressCommand extends $Command< RevokeSecurityGroupEgressCommandInput, diff --git a/clients/client-ec2/commands/RevokeSecurityGroupIngressCommand.ts b/clients/client-ec2/commands/RevokeSecurityGroupIngressCommand.ts index 92281b7d43f0..d2e486ee88ac 100644 --- a/clients/client-ec2/commands/RevokeSecurityGroupIngressCommand.ts +++ b/clients/client-ec2/commands/RevokeSecurityGroupIngressCommand.ts @@ -34,6 +34,20 @@ export interface RevokeSecurityGroupIngressCommandOutput extends RevokeSecurityG * *

Each rule consists of the protocol and the CIDR range or source security group. 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 have to specify the description to revoke the rule.

*

Rule changes are propagated to instances within the security group as quickly as possible. However, a small delay might occur.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { EC2Client, RevokeSecurityGroupIngressCommand } from "@aws-sdk/client-ec2"; // ES Modules import + * // const { EC2Client, RevokeSecurityGroupIngressCommand } = require("@aws-sdk/client-ec2"); // CommonJS import + * const client = new EC2Client(config); + * const command = new RevokeSecurityGroupIngressCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link RevokeSecurityGroupIngressCommandInput} for command's `input` shape. + * @see {@link RevokeSecurityGroupIngressCommandOutput} for command's `response` shape. + * @see {@link EC2ClientResolvedConfig | config} for command's `input` shape. + * */ export class RevokeSecurityGroupIngressCommand extends $Command< RevokeSecurityGroupIngressCommandInput, diff --git a/clients/client-ec2/commands/RunInstancesCommand.ts b/clients/client-ec2/commands/RunInstancesCommand.ts index 37ff017a35a1..0edbe1d0f241 100644 --- a/clients/client-ec2/commands/RunInstancesCommand.ts +++ b/clients/client-ec2/commands/RunInstancesCommand.ts @@ -76,6 +76,20 @@ export interface RunInstancesCommandOutput extends Reservation, __MetadataBearer * pairs.

*

For troubleshooting, see What to do if * an instance immediately terminates, and Troubleshooting connecting to your instance.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { EC2Client, RunInstancesCommand } from "@aws-sdk/client-ec2"; // ES Modules import + * // const { EC2Client, RunInstancesCommand } = require("@aws-sdk/client-ec2"); // CommonJS import + * const client = new EC2Client(config); + * const command = new RunInstancesCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link RunInstancesCommandInput} for command's `input` shape. + * @see {@link RunInstancesCommandOutput} for command's `response` shape. + * @see {@link EC2ClientResolvedConfig | config} for command's `input` shape. + * */ export class RunInstancesCommand extends $Command< RunInstancesCommandInput, diff --git a/clients/client-ec2/commands/RunScheduledInstancesCommand.ts b/clients/client-ec2/commands/RunScheduledInstancesCommand.ts index e5f9d42f66dc..643a4552630c 100644 --- a/clients/client-ec2/commands/RunScheduledInstancesCommand.ts +++ b/clients/client-ec2/commands/RunScheduledInstancesCommand.ts @@ -27,6 +27,20 @@ export interface RunScheduledInstancesCommandOutput extends RunScheduledInstance * 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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { EC2Client, RunScheduledInstancesCommand } from "@aws-sdk/client-ec2"; // ES Modules import + * // const { EC2Client, RunScheduledInstancesCommand } = require("@aws-sdk/client-ec2"); // CommonJS import + * const client = new EC2Client(config); + * const command = new RunScheduledInstancesCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link RunScheduledInstancesCommandInput} for command's `input` shape. + * @see {@link RunScheduledInstancesCommandOutput} for command's `response` shape. + * @see {@link EC2ClientResolvedConfig | config} for command's `input` shape. + * */ export class RunScheduledInstancesCommand extends $Command< RunScheduledInstancesCommandInput, diff --git a/clients/client-ec2/commands/SearchLocalGatewayRoutesCommand.ts b/clients/client-ec2/commands/SearchLocalGatewayRoutesCommand.ts index 896ed610df87..833120efeb2a 100644 --- a/clients/client-ec2/commands/SearchLocalGatewayRoutesCommand.ts +++ b/clients/client-ec2/commands/SearchLocalGatewayRoutesCommand.ts @@ -22,6 +22,20 @@ export interface SearchLocalGatewayRoutesCommandOutput extends SearchLocalGatewa /** *

Searches for routes in the specified local gateway route table.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { EC2Client, SearchLocalGatewayRoutesCommand } from "@aws-sdk/client-ec2"; // ES Modules import + * // const { EC2Client, SearchLocalGatewayRoutesCommand } = require("@aws-sdk/client-ec2"); // CommonJS import + * const client = new EC2Client(config); + * const command = new SearchLocalGatewayRoutesCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link SearchLocalGatewayRoutesCommandInput} for command's `input` shape. + * @see {@link SearchLocalGatewayRoutesCommandOutput} for command's `response` shape. + * @see {@link EC2ClientResolvedConfig | config} for command's `input` shape. + * */ export class SearchLocalGatewayRoutesCommand extends $Command< SearchLocalGatewayRoutesCommandInput, diff --git a/clients/client-ec2/commands/SearchTransitGatewayMulticastGroupsCommand.ts b/clients/client-ec2/commands/SearchTransitGatewayMulticastGroupsCommand.ts index 5cf64fc698dc..7ab4aeadd7be 100644 --- a/clients/client-ec2/commands/SearchTransitGatewayMulticastGroupsCommand.ts +++ b/clients/client-ec2/commands/SearchTransitGatewayMulticastGroupsCommand.ts @@ -27,6 +27,20 @@ export interface SearchTransitGatewayMulticastGroupsCommandOutput /** *

Searches one or more transit gateway multicast groups and returns the group membership information.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { EC2Client, SearchTransitGatewayMulticastGroupsCommand } from "@aws-sdk/client-ec2"; // ES Modules import + * // const { EC2Client, SearchTransitGatewayMulticastGroupsCommand } = require("@aws-sdk/client-ec2"); // CommonJS import + * const client = new EC2Client(config); + * const command = new SearchTransitGatewayMulticastGroupsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link SearchTransitGatewayMulticastGroupsCommandInput} for command's `input` shape. + * @see {@link SearchTransitGatewayMulticastGroupsCommandOutput} for command's `response` shape. + * @see {@link EC2ClientResolvedConfig | config} for command's `input` shape. + * */ export class SearchTransitGatewayMulticastGroupsCommand extends $Command< SearchTransitGatewayMulticastGroupsCommandInput, diff --git a/clients/client-ec2/commands/SearchTransitGatewayRoutesCommand.ts b/clients/client-ec2/commands/SearchTransitGatewayRoutesCommand.ts index c72efbc770e8..86719e17ebd4 100644 --- a/clients/client-ec2/commands/SearchTransitGatewayRoutesCommand.ts +++ b/clients/client-ec2/commands/SearchTransitGatewayRoutesCommand.ts @@ -22,6 +22,20 @@ export interface SearchTransitGatewayRoutesCommandOutput extends SearchTransitGa /** *

Searches for routes in the specified transit gateway route table.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { EC2Client, SearchTransitGatewayRoutesCommand } from "@aws-sdk/client-ec2"; // ES Modules import + * // const { EC2Client, SearchTransitGatewayRoutesCommand } = require("@aws-sdk/client-ec2"); // CommonJS import + * const client = new EC2Client(config); + * const command = new SearchTransitGatewayRoutesCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link SearchTransitGatewayRoutesCommandInput} for command's `input` shape. + * @see {@link SearchTransitGatewayRoutesCommandOutput} for command's `response` shape. + * @see {@link EC2ClientResolvedConfig | config} for command's `input` shape. + * */ export class SearchTransitGatewayRoutesCommand extends $Command< SearchTransitGatewayRoutesCommandInput, diff --git a/clients/client-ec2/commands/SendDiagnosticInterruptCommand.ts b/clients/client-ec2/commands/SendDiagnosticInterruptCommand.ts index 6f506ed39118..5e2f6dece369 100644 --- a/clients/client-ec2/commands/SendDiagnosticInterruptCommand.ts +++ b/clients/client-ec2/commands/SendDiagnosticInterruptCommand.ts @@ -37,6 +37,20 @@ export interface SendDiagnosticInterruptCommandOutput extends __MetadataBearer { * *

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 (Linux instances) or Send a Diagnostic Interrupt (Windows instances).

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { EC2Client, SendDiagnosticInterruptCommand } from "@aws-sdk/client-ec2"; // ES Modules import + * // const { EC2Client, SendDiagnosticInterruptCommand } = require("@aws-sdk/client-ec2"); // CommonJS import + * const client = new EC2Client(config); + * const command = new SendDiagnosticInterruptCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link SendDiagnosticInterruptCommandInput} for command's `input` shape. + * @see {@link SendDiagnosticInterruptCommandOutput} for command's `response` shape. + * @see {@link EC2ClientResolvedConfig | config} for command's `input` shape. + * */ export class SendDiagnosticInterruptCommand extends $Command< SendDiagnosticInterruptCommandInput, diff --git a/clients/client-ec2/commands/StartInstancesCommand.ts b/clients/client-ec2/commands/StartInstancesCommand.ts index 2e383092a8a7..8ed4647f2ead 100644 --- a/clients/client-ec2/commands/StartInstancesCommand.ts +++ b/clients/client-ec2/commands/StartInstancesCommand.ts @@ -35,6 +35,20 @@ export interface StartInstancesCommandOutput extends StartInstancesResult, __Met * device returns an error.

*

For more information, see Stopping instances in the * Amazon EC2 User Guide.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { EC2Client, StartInstancesCommand } from "@aws-sdk/client-ec2"; // ES Modules import + * // const { EC2Client, StartInstancesCommand } = require("@aws-sdk/client-ec2"); // CommonJS import + * const client = new EC2Client(config); + * const command = new StartInstancesCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link StartInstancesCommandInput} for command's `input` shape. + * @see {@link StartInstancesCommandOutput} for command's `response` shape. + * @see {@link EC2ClientResolvedConfig | config} for command's `input` shape. + * */ export class StartInstancesCommand extends $Command< StartInstancesCommandInput, diff --git a/clients/client-ec2/commands/StartNetworkInsightsAnalysisCommand.ts b/clients/client-ec2/commands/StartNetworkInsightsAnalysisCommand.ts index 213b2d8ca79f..25f3262dfb79 100644 --- a/clients/client-ec2/commands/StartNetworkInsightsAnalysisCommand.ts +++ b/clients/client-ec2/commands/StartNetworkInsightsAnalysisCommand.ts @@ -25,6 +25,20 @@ export interface StartNetworkInsightsAnalysisCommandOutput /** *

Starts analyzing the specified path. If the path is reachable, the * operation returns the shortest feasible path.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { EC2Client, StartNetworkInsightsAnalysisCommand } from "@aws-sdk/client-ec2"; // ES Modules import + * // const { EC2Client, StartNetworkInsightsAnalysisCommand } = require("@aws-sdk/client-ec2"); // CommonJS import + * const client = new EC2Client(config); + * const command = new StartNetworkInsightsAnalysisCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link StartNetworkInsightsAnalysisCommandInput} for command's `input` shape. + * @see {@link StartNetworkInsightsAnalysisCommandOutput} for command's `response` shape. + * @see {@link EC2ClientResolvedConfig | config} for command's `input` shape. + * */ export class StartNetworkInsightsAnalysisCommand extends $Command< StartNetworkInsightsAnalysisCommandInput, diff --git a/clients/client-ec2/commands/StartVpcEndpointServicePrivateDnsVerificationCommand.ts b/clients/client-ec2/commands/StartVpcEndpointServicePrivateDnsVerificationCommand.ts index 4d7091002ffa..e441588bf03a 100644 --- a/clients/client-ec2/commands/StartVpcEndpointServicePrivateDnsVerificationCommand.ts +++ b/clients/client-ec2/commands/StartVpcEndpointServicePrivateDnsVerificationCommand.ts @@ -31,6 +31,20 @@ export interface StartVpcEndpointServicePrivateDnsVerificationCommandOutput * 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. For more information, see Adding a TXT Record to Your Domain's DNS Server in the Amazon VPC User Guide.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { EC2Client, StartVpcEndpointServicePrivateDnsVerificationCommand } from "@aws-sdk/client-ec2"; // ES Modules import + * // const { EC2Client, StartVpcEndpointServicePrivateDnsVerificationCommand } = require("@aws-sdk/client-ec2"); // CommonJS import + * const client = new EC2Client(config); + * const command = new StartVpcEndpointServicePrivateDnsVerificationCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link StartVpcEndpointServicePrivateDnsVerificationCommandInput} for command's `input` shape. + * @see {@link StartVpcEndpointServicePrivateDnsVerificationCommandOutput} for command's `response` shape. + * @see {@link EC2ClientResolvedConfig | config} for command's `input` shape. + * */ export class StartVpcEndpointServicePrivateDnsVerificationCommand extends $Command< StartVpcEndpointServicePrivateDnsVerificationCommandInput, diff --git a/clients/client-ec2/commands/StopInstancesCommand.ts b/clients/client-ec2/commands/StopInstancesCommand.ts index b0b897b01cfa..0075f3726ce0 100644 --- a/clients/client-ec2/commands/StopInstancesCommand.ts +++ b/clients/client-ec2/commands/StopInstancesCommand.ts @@ -50,6 +50,20 @@ export interface StopInstancesCommandOutput extends StopInstancesResult, __Metad * 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 Troubleshooting * stopping your instance in the Amazon EC2 User Guide.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { EC2Client, StopInstancesCommand } from "@aws-sdk/client-ec2"; // ES Modules import + * // const { EC2Client, StopInstancesCommand } = require("@aws-sdk/client-ec2"); // CommonJS import + * const client = new EC2Client(config); + * const command = new StopInstancesCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link StopInstancesCommandInput} for command's `input` shape. + * @see {@link StopInstancesCommandOutput} for command's `response` shape. + * @see {@link EC2ClientResolvedConfig | config} for command's `input` shape. + * */ export class StopInstancesCommand extends $Command< StopInstancesCommandInput, diff --git a/clients/client-ec2/commands/TerminateClientVpnConnectionsCommand.ts b/clients/client-ec2/commands/TerminateClientVpnConnectionsCommand.ts index fc2818976990..e03281e9ceb0 100644 --- a/clients/client-ec2/commands/TerminateClientVpnConnectionsCommand.ts +++ b/clients/client-ec2/commands/TerminateClientVpnConnectionsCommand.ts @@ -24,6 +24,20 @@ export interface TerminateClientVpnConnectionsCommandOutput /** *

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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { EC2Client, TerminateClientVpnConnectionsCommand } from "@aws-sdk/client-ec2"; // ES Modules import + * // const { EC2Client, TerminateClientVpnConnectionsCommand } = require("@aws-sdk/client-ec2"); // CommonJS import + * const client = new EC2Client(config); + * const command = new TerminateClientVpnConnectionsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link TerminateClientVpnConnectionsCommandInput} for command's `input` shape. + * @see {@link TerminateClientVpnConnectionsCommandOutput} for command's `response` shape. + * @see {@link EC2ClientResolvedConfig | config} for command's `input` shape. + * */ export class TerminateClientVpnConnectionsCommand extends $Command< TerminateClientVpnConnectionsCommandInput, diff --git a/clients/client-ec2/commands/TerminateInstancesCommand.ts b/clients/client-ec2/commands/TerminateInstancesCommand.ts index ead0622a62e8..79285812d526 100644 --- a/clients/client-ec2/commands/TerminateInstancesCommand.ts +++ b/clients/client-ec2/commands/TerminateInstancesCommand.ts @@ -38,6 +38,20 @@ export interface TerminateInstancesCommandOutput extends TerminateInstancesResul * 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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { EC2Client, TerminateInstancesCommand } from "@aws-sdk/client-ec2"; // ES Modules import + * // const { EC2Client, TerminateInstancesCommand } = require("@aws-sdk/client-ec2"); // CommonJS import + * const client = new EC2Client(config); + * const command = new TerminateInstancesCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link TerminateInstancesCommandInput} for command's `input` shape. + * @see {@link TerminateInstancesCommandOutput} for command's `response` shape. + * @see {@link EC2ClientResolvedConfig | config} for command's `input` shape. + * */ export class TerminateInstancesCommand extends $Command< TerminateInstancesCommandInput, diff --git a/clients/client-ec2/commands/UnassignIpv6AddressesCommand.ts b/clients/client-ec2/commands/UnassignIpv6AddressesCommand.ts index c4066221c6f2..3bc6120e0b49 100644 --- a/clients/client-ec2/commands/UnassignIpv6AddressesCommand.ts +++ b/clients/client-ec2/commands/UnassignIpv6AddressesCommand.ts @@ -22,6 +22,20 @@ export interface UnassignIpv6AddressesCommandOutput extends UnassignIpv6Addresse /** *

Unassigns one or more IPv6 addresses from a network interface.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { EC2Client, UnassignIpv6AddressesCommand } from "@aws-sdk/client-ec2"; // ES Modules import + * // const { EC2Client, UnassignIpv6AddressesCommand } = require("@aws-sdk/client-ec2"); // CommonJS import + * const client = new EC2Client(config); + * const command = new UnassignIpv6AddressesCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link UnassignIpv6AddressesCommandInput} for command's `input` shape. + * @see {@link UnassignIpv6AddressesCommandOutput} for command's `response` shape. + * @see {@link EC2ClientResolvedConfig | config} for command's `input` shape. + * */ export class UnassignIpv6AddressesCommand extends $Command< UnassignIpv6AddressesCommandInput, diff --git a/clients/client-ec2/commands/UnassignPrivateIpAddressesCommand.ts b/clients/client-ec2/commands/UnassignPrivateIpAddressesCommand.ts index 04ff80a551a3..08b06393f2da 100644 --- a/clients/client-ec2/commands/UnassignPrivateIpAddressesCommand.ts +++ b/clients/client-ec2/commands/UnassignPrivateIpAddressesCommand.ts @@ -22,6 +22,20 @@ export interface UnassignPrivateIpAddressesCommandOutput extends __MetadataBeare /** *

Unassigns one or more secondary private IP addresses from a network interface.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { EC2Client, UnassignPrivateIpAddressesCommand } from "@aws-sdk/client-ec2"; // ES Modules import + * // const { EC2Client, UnassignPrivateIpAddressesCommand } = require("@aws-sdk/client-ec2"); // CommonJS import + * const client = new EC2Client(config); + * const command = new UnassignPrivateIpAddressesCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link UnassignPrivateIpAddressesCommandInput} for command's `input` shape. + * @see {@link UnassignPrivateIpAddressesCommandOutput} for command's `response` shape. + * @see {@link EC2ClientResolvedConfig | config} for command's `input` shape. + * */ export class UnassignPrivateIpAddressesCommand extends $Command< UnassignPrivateIpAddressesCommandInput, diff --git a/clients/client-ec2/commands/UnmonitorInstancesCommand.ts b/clients/client-ec2/commands/UnmonitorInstancesCommand.ts index 483bb88b1c1d..58c34e0b64ca 100644 --- a/clients/client-ec2/commands/UnmonitorInstancesCommand.ts +++ b/clients/client-ec2/commands/UnmonitorInstancesCommand.ts @@ -23,6 +23,20 @@ export interface UnmonitorInstancesCommandOutput extends UnmonitorInstancesResul /** *

Disables detailed monitoring for a running instance. For more information, see Monitoring * your instances and volumes in the Amazon EC2 User Guide.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { EC2Client, UnmonitorInstancesCommand } from "@aws-sdk/client-ec2"; // ES Modules import + * // const { EC2Client, UnmonitorInstancesCommand } = require("@aws-sdk/client-ec2"); // CommonJS import + * const client = new EC2Client(config); + * const command = new UnmonitorInstancesCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link UnmonitorInstancesCommandInput} for command's `input` shape. + * @see {@link UnmonitorInstancesCommandOutput} for command's `response` shape. + * @see {@link EC2ClientResolvedConfig | config} for command's `input` shape. + * */ export class UnmonitorInstancesCommand extends $Command< UnmonitorInstancesCommandInput, diff --git a/clients/client-ec2/commands/UpdateSecurityGroupRuleDescriptionsEgressCommand.ts b/clients/client-ec2/commands/UpdateSecurityGroupRuleDescriptionsEgressCommand.ts index c0b526f50570..0ae22fbdd100 100644 --- a/clients/client-ec2/commands/UpdateSecurityGroupRuleDescriptionsEgressCommand.ts +++ b/clients/client-ec2/commands/UpdateSecurityGroupRuleDescriptionsEgressCommand.ts @@ -33,6 +33,20 @@ export interface UpdateSecurityGroupRuleDescriptionsEgressCommandOutput *

You specify the description as part of the IP permissions structure. You can remove a * description for a security group rule by omitting the description parameter in the * request.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { EC2Client, UpdateSecurityGroupRuleDescriptionsEgressCommand } from "@aws-sdk/client-ec2"; // ES Modules import + * // const { EC2Client, UpdateSecurityGroupRuleDescriptionsEgressCommand } = require("@aws-sdk/client-ec2"); // CommonJS import + * const client = new EC2Client(config); + * const command = new UpdateSecurityGroupRuleDescriptionsEgressCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link UpdateSecurityGroupRuleDescriptionsEgressCommandInput} for command's `input` shape. + * @see {@link UpdateSecurityGroupRuleDescriptionsEgressCommandOutput} for command's `response` shape. + * @see {@link EC2ClientResolvedConfig | config} for command's `input` shape. + * */ export class UpdateSecurityGroupRuleDescriptionsEgressCommand extends $Command< UpdateSecurityGroupRuleDescriptionsEgressCommandInput, diff --git a/clients/client-ec2/commands/UpdateSecurityGroupRuleDescriptionsIngressCommand.ts b/clients/client-ec2/commands/UpdateSecurityGroupRuleDescriptionsIngressCommand.ts index a43a5dd3abd8..a4d30a346e28 100644 --- a/clients/client-ec2/commands/UpdateSecurityGroupRuleDescriptionsIngressCommand.ts +++ b/clients/client-ec2/commands/UpdateSecurityGroupRuleDescriptionsIngressCommand.ts @@ -33,6 +33,20 @@ export interface UpdateSecurityGroupRuleDescriptionsIngressCommandOutput *

You specify the description as part of the IP permissions structure. You can remove a * description for a security group rule by omitting the description parameter in the * request.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { EC2Client, UpdateSecurityGroupRuleDescriptionsIngressCommand } from "@aws-sdk/client-ec2"; // ES Modules import + * // const { EC2Client, UpdateSecurityGroupRuleDescriptionsIngressCommand } = require("@aws-sdk/client-ec2"); // CommonJS import + * const client = new EC2Client(config); + * const command = new UpdateSecurityGroupRuleDescriptionsIngressCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link UpdateSecurityGroupRuleDescriptionsIngressCommandInput} for command's `input` shape. + * @see {@link UpdateSecurityGroupRuleDescriptionsIngressCommandOutput} for command's `response` shape. + * @see {@link EC2ClientResolvedConfig | config} for command's `input` shape. + * */ export class UpdateSecurityGroupRuleDescriptionsIngressCommand extends $Command< UpdateSecurityGroupRuleDescriptionsIngressCommandInput, diff --git a/clients/client-ec2/commands/WithdrawByoipCidrCommand.ts b/clients/client-ec2/commands/WithdrawByoipCidrCommand.ts index 3cbe16851dec..79589349225f 100644 --- a/clients/client-ec2/commands/WithdrawByoipCidrCommand.ts +++ b/clients/client-ec2/commands/WithdrawByoipCidrCommand.ts @@ -26,6 +26,20 @@ export interface WithdrawByoipCidrCommandOutput extends WithdrawByoipCidrResult, * address ranges each time.

*

It can take a few minutes before traffic to the specified addresses stops routing to AWS * because of BGP propagation delays.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { EC2Client, WithdrawByoipCidrCommand } from "@aws-sdk/client-ec2"; // ES Modules import + * // const { EC2Client, WithdrawByoipCidrCommand } = require("@aws-sdk/client-ec2"); // CommonJS import + * const client = new EC2Client(config); + * const command = new WithdrawByoipCidrCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link WithdrawByoipCidrCommandInput} for command's `input` shape. + * @see {@link WithdrawByoipCidrCommandOutput} for command's `response` shape. + * @see {@link EC2ClientResolvedConfig | config} for command's `input` shape. + * */ export class WithdrawByoipCidrCommand extends $Command< WithdrawByoipCidrCommandInput, diff --git a/clients/client-ec2/models/models_0.ts b/clients/client-ec2/models/models_0.ts index e91a29b33b9a..7cec1dffe371 100644 --- a/clients/client-ec2/models/models_0.ts +++ b/clients/client-ec2/models/models_0.ts @@ -17,6 +17,9 @@ export interface TargetConfigurationRequest { } export namespace TargetConfigurationRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: TargetConfigurationRequest): any => ({ ...obj, }); @@ -47,6 +50,9 @@ export interface AcceptReservedInstancesExchangeQuoteRequest { } export namespace AcceptReservedInstancesExchangeQuoteRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: AcceptReservedInstancesExchangeQuoteRequest): any => ({ ...obj, }); @@ -63,6 +69,9 @@ export interface AcceptReservedInstancesExchangeQuoteResult { } export namespace AcceptReservedInstancesExchangeQuoteResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: AcceptReservedInstancesExchangeQuoteResult): any => ({ ...obj, }); @@ -93,6 +102,9 @@ export interface AcceptTransitGatewayMulticastDomainAssociationsRequest { } export namespace AcceptTransitGatewayMulticastDomainAssociationsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: AcceptTransitGatewayMulticastDomainAssociationsRequest): any => ({ ...obj, }); @@ -131,6 +143,9 @@ export interface SubnetAssociation { } export namespace SubnetAssociation { + /** + * @internal + */ export const filterSensitiveLog = (obj: SubnetAssociation): any => ({ ...obj, }); @@ -172,6 +187,9 @@ export interface TransitGatewayMulticastDomainAssociations { } export namespace TransitGatewayMulticastDomainAssociations { + /** + * @internal + */ export const filterSensitiveLog = (obj: TransitGatewayMulticastDomainAssociations): any => ({ ...obj, }); @@ -185,6 +203,9 @@ export interface AcceptTransitGatewayMulticastDomainAssociationsResult { } export namespace AcceptTransitGatewayMulticastDomainAssociationsResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: AcceptTransitGatewayMulticastDomainAssociationsResult): any => ({ ...obj, }); @@ -205,6 +226,9 @@ export interface AcceptTransitGatewayPeeringAttachmentRequest { } export namespace AcceptTransitGatewayPeeringAttachmentRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: AcceptTransitGatewayPeeringAttachmentRequest): any => ({ ...obj, }); @@ -231,6 +255,9 @@ export interface PeeringTgwInfo { } export namespace PeeringTgwInfo { + /** + * @internal + */ export const filterSensitiveLog = (obj: PeeringTgwInfo): any => ({ ...obj, }); @@ -267,6 +294,9 @@ export interface PeeringAttachmentStatus { } export namespace PeeringAttachmentStatus { + /** + * @internal + */ export const filterSensitiveLog = (obj: PeeringAttachmentStatus): any => ({ ...obj, }); @@ -291,6 +321,9 @@ export interface Tag { } export namespace Tag { + /** + * @internal + */ export const filterSensitiveLog = (obj: Tag): any => ({ ...obj, }); @@ -337,6 +370,9 @@ export interface TransitGatewayPeeringAttachment { } export namespace TransitGatewayPeeringAttachment { + /** + * @internal + */ export const filterSensitiveLog = (obj: TransitGatewayPeeringAttachment): any => ({ ...obj, }); @@ -350,6 +386,9 @@ export interface AcceptTransitGatewayPeeringAttachmentResult { } export namespace AcceptTransitGatewayPeeringAttachmentResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: AcceptTransitGatewayPeeringAttachmentResult): any => ({ ...obj, }); @@ -370,6 +409,9 @@ export interface AcceptTransitGatewayVpcAttachmentRequest { } export namespace AcceptTransitGatewayVpcAttachmentRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: AcceptTransitGatewayVpcAttachmentRequest): any => ({ ...obj, }); @@ -402,6 +444,9 @@ export interface TransitGatewayVpcAttachmentOptions { } export namespace TransitGatewayVpcAttachmentOptions { + /** + * @internal + */ export const filterSensitiveLog = (obj: TransitGatewayVpcAttachmentOptions): any => ({ ...obj, }); @@ -458,6 +503,9 @@ export interface TransitGatewayVpcAttachment { } export namespace TransitGatewayVpcAttachment { + /** + * @internal + */ export const filterSensitiveLog = (obj: TransitGatewayVpcAttachment): any => ({ ...obj, }); @@ -471,6 +519,9 @@ export interface AcceptTransitGatewayVpcAttachmentResult { } export namespace AcceptTransitGatewayVpcAttachmentResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: AcceptTransitGatewayVpcAttachmentResult): any => ({ ...obj, }); @@ -496,6 +547,9 @@ export interface AcceptVpcEndpointConnectionsRequest { } export namespace AcceptVpcEndpointConnectionsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: AcceptVpcEndpointConnectionsRequest): any => ({ ...obj, }); @@ -517,6 +571,9 @@ export interface UnsuccessfulItemError { } export namespace UnsuccessfulItemError { + /** + * @internal + */ export const filterSensitiveLog = (obj: UnsuccessfulItemError): any => ({ ...obj, }); @@ -538,6 +595,9 @@ export interface UnsuccessfulItem { } export namespace UnsuccessfulItem { + /** + * @internal + */ export const filterSensitiveLog = (obj: UnsuccessfulItem): any => ({ ...obj, }); @@ -552,6 +612,9 @@ export interface AcceptVpcEndpointConnectionsResult { } export namespace AcceptVpcEndpointConnectionsResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: AcceptVpcEndpointConnectionsResult): any => ({ ...obj, }); @@ -573,6 +636,9 @@ export interface AcceptVpcPeeringConnectionRequest { } export namespace AcceptVpcPeeringConnectionRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: AcceptVpcPeeringConnectionRequest): any => ({ ...obj, }); @@ -589,6 +655,9 @@ export interface CidrBlock { } export namespace CidrBlock { + /** + * @internal + */ export const filterSensitiveLog = (obj: CidrBlock): any => ({ ...obj, }); @@ -605,6 +674,9 @@ export interface Ipv6CidrBlock { } export namespace Ipv6CidrBlock { + /** + * @internal + */ export const filterSensitiveLog = (obj: Ipv6CidrBlock): any => ({ ...obj, }); @@ -631,6 +703,9 @@ export interface VpcPeeringConnectionOptionsDescription { } export namespace VpcPeeringConnectionOptionsDescription { + /** + * @internal + */ export const filterSensitiveLog = (obj: VpcPeeringConnectionOptionsDescription): any => ({ ...obj, }); @@ -677,6 +752,9 @@ export interface VpcPeeringConnectionVpcInfo { } export namespace VpcPeeringConnectionVpcInfo { + /** + * @internal + */ export const filterSensitiveLog = (obj: VpcPeeringConnectionVpcInfo): any => ({ ...obj, }); @@ -709,6 +787,9 @@ export interface VpcPeeringConnectionStateReason { } export namespace VpcPeeringConnectionStateReason { + /** + * @internal + */ export const filterSensitiveLog = (obj: VpcPeeringConnectionStateReason): any => ({ ...obj, }); @@ -750,6 +831,9 @@ export interface VpcPeeringConnection { } export namespace VpcPeeringConnection { + /** + * @internal + */ export const filterSensitiveLog = (obj: VpcPeeringConnection): any => ({ ...obj, }); @@ -763,6 +847,9 @@ export interface AcceptVpcPeeringConnectionResult { } export namespace AcceptVpcPeeringConnectionResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: AcceptVpcPeeringConnectionResult): any => ({ ...obj, }); @@ -779,6 +866,9 @@ export interface AccountAttributeValue { } export namespace AccountAttributeValue { + /** + * @internal + */ export const filterSensitiveLog = (obj: AccountAttributeValue): any => ({ ...obj, }); @@ -800,6 +890,9 @@ export interface AccountAttribute { } export namespace AccountAttribute { + /** + * @internal + */ export const filterSensitiveLog = (obj: AccountAttribute): any => ({ ...obj, }); @@ -840,6 +933,9 @@ export interface ActiveInstance { } export namespace ActiveInstance { + /** + * @internal + */ export const filterSensitiveLog = (obj: ActiveInstance): any => ({ ...obj, }); @@ -869,6 +965,9 @@ export interface AddPrefixListEntry { } export namespace AddPrefixListEntry { + /** + * @internal + */ export const filterSensitiveLog = (obj: AddPrefixListEntry): any => ({ ...obj, }); @@ -955,6 +1054,9 @@ export interface Address { } export namespace Address { + /** + * @internal + */ export const filterSensitiveLog = (obj: Address): any => ({ ...obj, }); @@ -981,6 +1083,9 @@ export interface PtrUpdateStatus { } export namespace PtrUpdateStatus { + /** + * @internal + */ export const filterSensitiveLog = (obj: PtrUpdateStatus): any => ({ ...obj, }); @@ -1012,6 +1117,9 @@ export interface AddressAttribute { } export namespace AddressAttribute { + /** + * @internal + */ export const filterSensitiveLog = (obj: AddressAttribute): any => ({ ...obj, }); @@ -1035,6 +1143,9 @@ export interface AdvertiseByoipCidrRequest { } export namespace AdvertiseByoipCidrRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: AdvertiseByoipCidrRequest): any => ({ ...obj, }); @@ -1077,6 +1188,9 @@ export interface ByoipCidr { } export namespace ByoipCidr { + /** + * @internal + */ export const filterSensitiveLog = (obj: ByoipCidr): any => ({ ...obj, }); @@ -1090,6 +1204,9 @@ export interface AdvertiseByoipCidrResult { } export namespace AdvertiseByoipCidrResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: AdvertiseByoipCidrResult): any => ({ ...obj, }); @@ -1182,6 +1299,9 @@ export interface TagSpecification { } export namespace TagSpecification { + /** + * @internal + */ export const filterSensitiveLog = (obj: TagSpecification): any => ({ ...obj, }); @@ -1239,6 +1359,9 @@ export interface AllocateAddressRequest { } export namespace AllocateAddressRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: AllocateAddressRequest): any => ({ ...obj, }); @@ -1290,6 +1413,9 @@ export interface AllocateAddressResult { } export namespace AllocateAddressResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: AllocateAddressResult): any => ({ ...obj, }); @@ -1368,6 +1494,9 @@ export interface AllocateHostsRequest { } export namespace AllocateHostsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: AllocateHostsRequest): any => ({ ...obj, }); @@ -1385,6 +1514,9 @@ export interface AllocateHostsResult { } export namespace AllocateHostsResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: AllocateHostsResult): any => ({ ...obj, }); @@ -1430,6 +1562,9 @@ export interface AllowedPrincipal { } export namespace AllowedPrincipal { + /** + * @internal + */ export const filterSensitiveLog = (obj: AllowedPrincipal): any => ({ ...obj, }); @@ -1453,6 +1588,9 @@ export interface AlternatePathHint { } export namespace AlternatePathHint { + /** + * @internal + */ export const filterSensitiveLog = (obj: AlternatePathHint): any => ({ ...obj, }); @@ -1482,6 +1620,9 @@ export interface ApplySecurityGroupsToClientVpnTargetNetworkRequest { } export namespace ApplySecurityGroupsToClientVpnTargetNetworkRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ApplySecurityGroupsToClientVpnTargetNetworkRequest): any => ({ ...obj, }); @@ -1495,6 +1636,9 @@ export interface ApplySecurityGroupsToClientVpnTargetNetworkResult { } export namespace ApplySecurityGroupsToClientVpnTargetNetworkResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: ApplySecurityGroupsToClientVpnTargetNetworkResult): any => ({ ...obj, }); @@ -1522,6 +1666,9 @@ export interface AssignIpv6AddressesRequest { } export namespace AssignIpv6AddressesRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: AssignIpv6AddressesRequest): any => ({ ...obj, }); @@ -1541,6 +1688,9 @@ export interface AssignIpv6AddressesResult { } export namespace AssignIpv6AddressesResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: AssignIpv6AddressesResult): any => ({ ...obj, }); @@ -1573,6 +1723,9 @@ export interface AssignPrivateIpAddressesRequest { } export namespace AssignPrivateIpAddressesRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: AssignPrivateIpAddressesRequest): any => ({ ...obj, }); @@ -1589,6 +1742,9 @@ export interface AssignedPrivateIpAddress { } export namespace AssignedPrivateIpAddress { + /** + * @internal + */ export const filterSensitiveLog = (obj: AssignedPrivateIpAddress): any => ({ ...obj, }); @@ -1607,6 +1763,9 @@ export interface AssignPrivateIpAddressesResult { } export namespace AssignPrivateIpAddressesResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: AssignPrivateIpAddressesResult): any => ({ ...obj, }); @@ -1657,6 +1816,9 @@ export interface AssociateAddressRequest { } export namespace AssociateAddressRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: AssociateAddressRequest): any => ({ ...obj, }); @@ -1670,6 +1832,9 @@ export interface AssociateAddressResult { } export namespace AssociateAddressResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: AssociateAddressResult): any => ({ ...obj, }); @@ -1698,6 +1863,9 @@ export interface AssociateClientVpnTargetNetworkRequest { } export namespace AssociateClientVpnTargetNetworkRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: AssociateClientVpnTargetNetworkRequest): any => ({ ...obj, }); @@ -1726,6 +1894,9 @@ export interface AssociationStatus { } export namespace AssociationStatus { + /** + * @internal + */ export const filterSensitiveLog = (obj: AssociationStatus): any => ({ ...obj, }); @@ -1744,6 +1915,9 @@ export interface AssociateClientVpnTargetNetworkResult { } export namespace AssociateClientVpnTargetNetworkResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: AssociateClientVpnTargetNetworkResult): any => ({ ...obj, }); @@ -1770,6 +1944,9 @@ export interface AssociateDhcpOptionsRequest { } export namespace AssociateDhcpOptionsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: AssociateDhcpOptionsRequest): any => ({ ...obj, }); @@ -1794,6 +1971,9 @@ export interface AssociateEnclaveCertificateIamRoleRequest { } export namespace AssociateEnclaveCertificateIamRoleRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: AssociateEnclaveCertificateIamRoleRequest): any => ({ ...obj, }); @@ -1818,6 +1998,9 @@ export interface AssociateEnclaveCertificateIamRoleResult { } export namespace AssociateEnclaveCertificateIamRoleResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: AssociateEnclaveCertificateIamRoleResult): any => ({ ...obj, }); @@ -1839,6 +2022,9 @@ export interface IamInstanceProfileSpecification { } export namespace IamInstanceProfileSpecification { + /** + * @internal + */ export const filterSensitiveLog = (obj: IamInstanceProfileSpecification): any => ({ ...obj, }); @@ -1857,6 +2043,9 @@ export interface AssociateIamInstanceProfileRequest { } export namespace AssociateIamInstanceProfileRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: AssociateIamInstanceProfileRequest): any => ({ ...obj, }); @@ -1878,6 +2067,9 @@ export interface IamInstanceProfile { } export namespace IamInstanceProfile { + /** + * @internal + */ export const filterSensitiveLog = (obj: IamInstanceProfile): any => ({ ...obj, }); @@ -1921,6 +2113,9 @@ export interface IamInstanceProfileAssociation { } export namespace IamInstanceProfileAssociation { + /** + * @internal + */ export const filterSensitiveLog = (obj: IamInstanceProfileAssociation): any => ({ ...obj, }); @@ -1934,6 +2129,9 @@ export interface AssociateIamInstanceProfileResult { } export namespace AssociateIamInstanceProfileResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: AssociateIamInstanceProfileResult): any => ({ ...obj, }); @@ -1964,6 +2162,9 @@ export interface AssociateRouteTableRequest { } export namespace AssociateRouteTableRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: AssociateRouteTableRequest): any => ({ ...obj, }); @@ -1992,6 +2193,9 @@ export interface RouteTableAssociationState { } export namespace RouteTableAssociationState { + /** + * @internal + */ export const filterSensitiveLog = (obj: RouteTableAssociationState): any => ({ ...obj, }); @@ -2011,6 +2215,9 @@ export interface AssociateRouteTableResult { } export namespace AssociateRouteTableResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: AssociateRouteTableResult): any => ({ ...obj, }); @@ -2030,6 +2237,9 @@ export interface AssociateSubnetCidrBlockRequest { } export namespace AssociateSubnetCidrBlockRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: AssociateSubnetCidrBlockRequest): any => ({ ...obj, }); @@ -2059,6 +2269,9 @@ export interface SubnetCidrBlockState { } export namespace SubnetCidrBlockState { + /** + * @internal + */ export const filterSensitiveLog = (obj: SubnetCidrBlockState): any => ({ ...obj, }); @@ -2085,6 +2298,9 @@ export interface SubnetIpv6CidrBlockAssociation { } export namespace SubnetIpv6CidrBlockAssociation { + /** + * @internal + */ export const filterSensitiveLog = (obj: SubnetIpv6CidrBlockAssociation): any => ({ ...obj, }); @@ -2103,6 +2319,9 @@ export interface AssociateSubnetCidrBlockResult { } export namespace AssociateSubnetCidrBlockResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: AssociateSubnetCidrBlockResult): any => ({ ...obj, }); @@ -2133,6 +2352,9 @@ export interface AssociateTransitGatewayMulticastDomainRequest { } export namespace AssociateTransitGatewayMulticastDomainRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: AssociateTransitGatewayMulticastDomainRequest): any => ({ ...obj, }); @@ -2146,6 +2368,9 @@ export interface AssociateTransitGatewayMulticastDomainResult { } export namespace AssociateTransitGatewayMulticastDomainResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: AssociateTransitGatewayMulticastDomainResult): any => ({ ...obj, }); @@ -2171,6 +2396,9 @@ export interface AssociateTransitGatewayRouteTableRequest { } export namespace AssociateTransitGatewayRouteTableRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: AssociateTransitGatewayRouteTableRequest): any => ({ ...obj, }); @@ -2209,6 +2437,9 @@ export interface TransitGatewayAssociation { } export namespace TransitGatewayAssociation { + /** + * @internal + */ export const filterSensitiveLog = (obj: TransitGatewayAssociation): any => ({ ...obj, }); @@ -2222,6 +2453,9 @@ export interface AssociateTransitGatewayRouteTableResult { } export namespace AssociateTransitGatewayRouteTableResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: AssociateTransitGatewayRouteTableResult): any => ({ ...obj, }); @@ -2264,6 +2498,9 @@ export interface AssociateVpcCidrBlockRequest { } export namespace AssociateVpcCidrBlockRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: AssociateVpcCidrBlockRequest): any => ({ ...obj, }); @@ -2293,6 +2530,9 @@ export interface VpcCidrBlockState { } export namespace VpcCidrBlockState { + /** + * @internal + */ export const filterSensitiveLog = (obj: VpcCidrBlockState): any => ({ ...obj, }); @@ -2319,6 +2559,9 @@ export interface VpcCidrBlockAssociation { } export namespace VpcCidrBlockAssociation { + /** + * @internal + */ export const filterSensitiveLog = (obj: VpcCidrBlockAssociation): any => ({ ...obj, }); @@ -2356,6 +2599,9 @@ export interface VpcIpv6CidrBlockAssociation { } export namespace VpcIpv6CidrBlockAssociation { + /** + * @internal + */ export const filterSensitiveLog = (obj: VpcIpv6CidrBlockAssociation): any => ({ ...obj, }); @@ -2379,6 +2625,9 @@ export interface AssociateVpcCidrBlockResult { } export namespace AssociateVpcCidrBlockResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: AssociateVpcCidrBlockResult): any => ({ ...obj, }); @@ -2409,6 +2658,9 @@ export interface AttachClassicLinkVpcRequest { } export namespace AttachClassicLinkVpcRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: AttachClassicLinkVpcRequest): any => ({ ...obj, }); @@ -2422,6 +2674,9 @@ export interface AttachClassicLinkVpcResult { } export namespace AttachClassicLinkVpcResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: AttachClassicLinkVpcResult): any => ({ ...obj, }); @@ -2447,6 +2702,9 @@ export interface AttachInternetGatewayRequest { } export namespace AttachInternetGatewayRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: AttachInternetGatewayRequest): any => ({ ...obj, }); @@ -2487,6 +2745,9 @@ export interface AttachNetworkInterfaceRequest { } export namespace AttachNetworkInterfaceRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: AttachNetworkInterfaceRequest): any => ({ ...obj, }); @@ -2508,6 +2769,9 @@ export interface AttachNetworkInterfaceResult { } export namespace AttachNetworkInterfaceResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: AttachNetworkInterfaceResult): any => ({ ...obj, }); @@ -2539,6 +2803,9 @@ export interface AttachVolumeRequest { } export namespace AttachVolumeRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: AttachVolumeRequest): any => ({ ...obj, }); @@ -2582,6 +2849,9 @@ export interface VolumeAttachment { } export namespace VolumeAttachment { + /** + * @internal + */ export const filterSensitiveLog = (obj: VolumeAttachment): any => ({ ...obj, }); @@ -2610,6 +2880,9 @@ export interface AttachVpnGatewayRequest { } export namespace AttachVpnGatewayRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: AttachVpnGatewayRequest): any => ({ ...obj, }); @@ -2633,6 +2906,9 @@ export interface VpcAttachment { } export namespace VpcAttachment { + /** + * @internal + */ export const filterSensitiveLog = (obj: VpcAttachment): any => ({ ...obj, }); @@ -2649,6 +2925,9 @@ export interface AttachVpnGatewayResult { } export namespace AttachVpnGatewayResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: AttachVpnGatewayResult): any => ({ ...obj, }); @@ -2694,6 +2973,9 @@ export interface AuthorizeClientVpnIngressRequest { } export namespace AuthorizeClientVpnIngressRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: AuthorizeClientVpnIngressRequest): any => ({ ...obj, }); @@ -2717,6 +2999,9 @@ export interface ClientVpnAuthorizationRuleStatus { } export namespace ClientVpnAuthorizationRuleStatus { + /** + * @internal + */ export const filterSensitiveLog = (obj: ClientVpnAuthorizationRuleStatus): any => ({ ...obj, }); @@ -2730,6 +3015,9 @@ export interface AuthorizeClientVpnIngressResult { } export namespace AuthorizeClientVpnIngressResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: AuthorizeClientVpnIngressResult): any => ({ ...obj, }); @@ -2754,6 +3042,9 @@ export interface IpRange { } export namespace IpRange { + /** + * @internal + */ export const filterSensitiveLog = (obj: IpRange): any => ({ ...obj, }); @@ -2778,6 +3069,9 @@ export interface Ipv6Range { } export namespace Ipv6Range { + /** + * @internal + */ export const filterSensitiveLog = (obj: Ipv6Range): any => ({ ...obj, }); @@ -2801,6 +3095,9 @@ export interface PrefixListId { } export namespace PrefixListId { + /** + * @internal + */ export const filterSensitiveLog = (obj: PrefixListId): any => ({ ...obj, }); @@ -2859,6 +3156,9 @@ export interface UserIdGroupPair { } export namespace UserIdGroupPair { + /** + * @internal + */ export const filterSensitiveLog = (obj: UserIdGroupPair): any => ({ ...obj, }); @@ -2916,6 +3216,9 @@ export interface IpPermission { } export namespace IpPermission { + /** + * @internal + */ export const filterSensitiveLog = (obj: IpPermission): any => ({ ...obj, }); @@ -2975,6 +3278,9 @@ export interface AuthorizeSecurityGroupEgressRequest { } export namespace AuthorizeSecurityGroupEgressRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: AuthorizeSecurityGroupEgressRequest): any => ({ ...obj, }); @@ -3059,6 +3365,9 @@ export interface AuthorizeSecurityGroupIngressRequest { } export namespace AuthorizeSecurityGroupIngressRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: AuthorizeSecurityGroupIngressRequest): any => ({ ...obj, }); @@ -3096,6 +3405,9 @@ export interface S3Storage { } export namespace S3Storage { + /** + * @internal + */ export const filterSensitiveLog = (obj: S3Storage): any => ({ ...obj, }); @@ -3112,6 +3424,9 @@ export interface Storage { } export namespace Storage { + /** + * @internal + */ export const filterSensitiveLog = (obj: Storage): any => ({ ...obj, }); @@ -3143,6 +3458,9 @@ export interface BundleInstanceRequest { } export namespace BundleInstanceRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: BundleInstanceRequest): any => ({ ...obj, }); @@ -3164,6 +3482,9 @@ export interface BundleTaskError { } export namespace BundleTaskError { + /** + * @internal + */ export const filterSensitiveLog = (obj: BundleTaskError): any => ({ ...obj, }); @@ -3224,6 +3545,9 @@ export interface BundleTask { } export namespace BundleTask { + /** + * @internal + */ export const filterSensitiveLog = (obj: BundleTask): any => ({ ...obj, }); @@ -3240,6 +3564,9 @@ export interface BundleInstanceResult { } export namespace BundleInstanceResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: BundleInstanceResult): any => ({ ...obj, }); @@ -3263,6 +3590,9 @@ export interface CancelBundleTaskRequest { } export namespace CancelBundleTaskRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: CancelBundleTaskRequest): any => ({ ...obj, }); @@ -3279,6 +3609,9 @@ export interface CancelBundleTaskResult { } export namespace CancelBundleTaskResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: CancelBundleTaskResult): any => ({ ...obj, }); @@ -3297,6 +3630,9 @@ export interface CancelCapacityReservationRequest { } export namespace CancelCapacityReservationRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: CancelCapacityReservationRequest): any => ({ ...obj, }); @@ -3310,6 +3646,9 @@ export interface CancelCapacityReservationResult { } export namespace CancelCapacityReservationResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: CancelCapacityReservationResult): any => ({ ...obj, }); @@ -3335,6 +3674,9 @@ export interface CancelConversionRequest { } export namespace CancelConversionRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: CancelConversionRequest): any => ({ ...obj, }); @@ -3348,6 +3690,9 @@ export interface CancelExportTaskRequest { } export namespace CancelExportTaskRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: CancelExportTaskRequest): any => ({ ...obj, }); @@ -3373,6 +3718,9 @@ export interface CancelImportTaskRequest { } export namespace CancelImportTaskRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: CancelImportTaskRequest): any => ({ ...obj, }); @@ -3396,6 +3744,9 @@ export interface CancelImportTaskResult { } export namespace CancelImportTaskResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: CancelImportTaskResult): any => ({ ...obj, }); @@ -3412,6 +3763,9 @@ export interface CancelReservedInstancesListingRequest { } export namespace CancelReservedInstancesListingRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: CancelReservedInstancesListingRequest): any => ({ ...obj, }); @@ -3435,6 +3789,9 @@ export interface InstanceCount { } export namespace InstanceCount { + /** + * @internal + */ export const filterSensitiveLog = (obj: InstanceCount): any => ({ ...obj, }); @@ -3470,6 +3827,9 @@ export interface PriceSchedule { } export namespace PriceSchedule { + /** + * @internal + */ export const filterSensitiveLog = (obj: PriceSchedule): any => ({ ...obj, }); @@ -3534,6 +3894,9 @@ export interface ReservedInstancesListing { } export namespace ReservedInstancesListing { + /** + * @internal + */ export const filterSensitiveLog = (obj: ReservedInstancesListing): any => ({ ...obj, }); @@ -3550,6 +3913,9 @@ export interface CancelReservedInstancesListingResult { } export namespace CancelReservedInstancesListingResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: CancelReservedInstancesListingResult): any => ({ ...obj, }); @@ -3578,6 +3944,9 @@ export interface CancelSpotFleetRequestsRequest { } export namespace CancelSpotFleetRequestsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: CancelSpotFleetRequestsRequest): any => ({ ...obj, }); @@ -3614,6 +3983,9 @@ export interface CancelSpotFleetRequestsSuccessItem { } export namespace CancelSpotFleetRequestsSuccessItem { + /** + * @internal + */ export const filterSensitiveLog = (obj: CancelSpotFleetRequestsSuccessItem): any => ({ ...obj, }); @@ -3642,6 +4014,9 @@ export interface CancelSpotFleetRequestsError { } export namespace CancelSpotFleetRequestsError { + /** + * @internal + */ export const filterSensitiveLog = (obj: CancelSpotFleetRequestsError): any => ({ ...obj, }); @@ -3663,6 +4038,9 @@ export interface CancelSpotFleetRequestsErrorItem { } export namespace CancelSpotFleetRequestsErrorItem { + /** + * @internal + */ export const filterSensitiveLog = (obj: CancelSpotFleetRequestsErrorItem): any => ({ ...obj, }); @@ -3684,6 +4062,9 @@ export interface CancelSpotFleetRequestsResponse { } export namespace CancelSpotFleetRequestsResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: CancelSpotFleetRequestsResponse): any => ({ ...obj, }); @@ -3707,6 +4088,9 @@ export interface CancelSpotInstanceRequestsRequest { } export namespace CancelSpotInstanceRequestsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: CancelSpotInstanceRequestsRequest): any => ({ ...obj, }); @@ -3730,6 +4114,9 @@ export interface CancelledSpotInstanceRequest { } export namespace CancelledSpotInstanceRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: CancelledSpotInstanceRequest): any => ({ ...obj, }); @@ -3746,6 +4133,9 @@ export interface CancelSpotInstanceRequestsResult { } export namespace CancelSpotInstanceRequestsResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: CancelSpotInstanceRequestsResult): any => ({ ...obj, }); @@ -3771,6 +4161,9 @@ export interface ConfirmProductInstanceRequest { } export namespace ConfirmProductInstanceRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ConfirmProductInstanceRequest): any => ({ ...obj, }); @@ -3791,6 +4184,9 @@ export interface ConfirmProductInstanceResult { } export namespace ConfirmProductInstanceResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: ConfirmProductInstanceResult): any => ({ ...obj, }); @@ -3832,6 +4228,9 @@ export interface CopyFpgaImageRequest { } export namespace CopyFpgaImageRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: CopyFpgaImageRequest): any => ({ ...obj, }); @@ -3845,6 +4244,9 @@ export interface CopyFpgaImageResult { } export namespace CopyFpgaImageResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: CopyFpgaImageResult): any => ({ ...obj, }); @@ -3937,6 +4339,9 @@ export interface CopyImageRequest { } export namespace CopyImageRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: CopyImageRequest): any => ({ ...obj, }); @@ -3953,6 +4358,9 @@ export interface CopyImageResult { } export namespace CopyImageResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: CopyImageResult): any => ({ ...obj, }); @@ -4062,6 +4470,9 @@ export interface CopySnapshotRequest { } export namespace CopySnapshotRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: CopySnapshotRequest): any => ({ ...obj, }); @@ -4080,6 +4491,9 @@ export interface CopySnapshotResult { } export namespace CopySnapshotResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: CopySnapshotResult): any => ({ ...obj, }); @@ -4232,6 +4646,9 @@ export interface CreateCapacityReservationRequest { } export namespace CreateCapacityReservationRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateCapacityReservationRequest): any => ({ ...obj, }); @@ -4409,6 +4826,9 @@ export interface CapacityReservation { } export namespace CapacityReservation { + /** + * @internal + */ export const filterSensitiveLog = (obj: CapacityReservation): any => ({ ...obj, }); @@ -4422,6 +4842,9 @@ export interface CreateCapacityReservationResult { } export namespace CreateCapacityReservationResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateCapacityReservationResult): any => ({ ...obj, }); @@ -4454,6 +4877,9 @@ export interface CreateCarrierGatewayRequest { } export namespace CreateCarrierGatewayRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateCarrierGatewayRequest): any => ({ ...obj, }); @@ -4492,6 +4918,9 @@ export interface CarrierGateway { } export namespace CarrierGateway { + /** + * @internal + */ export const filterSensitiveLog = (obj: CarrierGateway): any => ({ ...obj, }); @@ -4505,6 +4934,9 @@ export interface CreateCarrierGatewayResult { } export namespace CreateCarrierGatewayResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateCarrierGatewayResult): any => ({ ...obj, }); @@ -4521,6 +4953,9 @@ export interface DirectoryServiceAuthenticationRequest { } export namespace DirectoryServiceAuthenticationRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DirectoryServiceAuthenticationRequest): any => ({ ...obj, }); @@ -4542,6 +4977,9 @@ export interface FederatedAuthenticationRequest { } export namespace FederatedAuthenticationRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: FederatedAuthenticationRequest): any => ({ ...obj, }); @@ -4559,6 +4997,9 @@ export interface CertificateAuthenticationRequest { } export namespace CertificateAuthenticationRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: CertificateAuthenticationRequest): any => ({ ...obj, }); @@ -4596,6 +5037,9 @@ export interface ClientVpnAuthenticationRequest { } export namespace ClientVpnAuthenticationRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ClientVpnAuthenticationRequest): any => ({ ...obj, }); @@ -4617,6 +5061,9 @@ export interface ClientConnectOptions { } export namespace ClientConnectOptions { + /** + * @internal + */ export const filterSensitiveLog = (obj: ClientConnectOptions): any => ({ ...obj, }); @@ -4643,6 +5090,9 @@ export interface ConnectionLogOptions { } export namespace ConnectionLogOptions { + /** + * @internal + */ export const filterSensitiveLog = (obj: ConnectionLogOptions): any => ({ ...obj, }); @@ -4764,6 +5214,9 @@ export interface CreateClientVpnEndpointRequest { } export namespace CreateClientVpnEndpointRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateClientVpnEndpointRequest): any => ({ ...obj, }); @@ -4809,6 +5262,9 @@ export interface ClientVpnEndpointStatus { } export namespace ClientVpnEndpointStatus { + /** + * @internal + */ export const filterSensitiveLog = (obj: ClientVpnEndpointStatus): any => ({ ...obj, }); @@ -4832,6 +5288,9 @@ export interface CreateClientVpnEndpointResult { } export namespace CreateClientVpnEndpointResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateClientVpnEndpointResult): any => ({ ...obj, }); @@ -4887,6 +5346,9 @@ export interface CreateClientVpnRouteRequest { } export namespace CreateClientVpnRouteRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateClientVpnRouteRequest): any => ({ ...obj, }); @@ -4910,6 +5372,9 @@ export interface ClientVpnRouteStatus { } export namespace ClientVpnRouteStatus { + /** + * @internal + */ export const filterSensitiveLog = (obj: ClientVpnRouteStatus): any => ({ ...obj, }); @@ -4923,6 +5388,9 @@ export interface CreateClientVpnRouteResult { } export namespace CreateClientVpnRouteResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateClientVpnRouteResult): any => ({ ...obj, }); @@ -4975,6 +5443,9 @@ export interface CreateCustomerGatewayRequest { } export namespace CreateCustomerGatewayRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateCustomerGatewayRequest): any => ({ ...obj, }); @@ -5027,6 +5498,9 @@ export interface CustomerGateway { } export namespace CustomerGateway { + /** + * @internal + */ export const filterSensitiveLog = (obj: CustomerGateway): any => ({ ...obj, }); @@ -5043,6 +5517,9 @@ export interface CreateCustomerGatewayResult { } export namespace CreateCustomerGatewayResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateCustomerGatewayResult): any => ({ ...obj, }); @@ -5063,6 +5540,9 @@ export interface CreateDefaultSubnetRequest { } export namespace CreateDefaultSubnetRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateDefaultSubnetRequest): any => ({ ...obj, }); @@ -5164,6 +5644,9 @@ export interface Subnet { } export namespace Subnet { + /** + * @internal + */ export const filterSensitiveLog = (obj: Subnet): any => ({ ...obj, }); @@ -5177,6 +5660,9 @@ export interface CreateDefaultSubnetResult { } export namespace CreateDefaultSubnetResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateDefaultSubnetResult): any => ({ ...obj, }); @@ -5192,6 +5678,9 @@ export interface CreateDefaultVpcRequest { } export namespace CreateDefaultVpcRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateDefaultVpcRequest): any => ({ ...obj, }); @@ -5257,6 +5746,9 @@ export interface Vpc { } export namespace Vpc { + /** + * @internal + */ export const filterSensitiveLog = (obj: Vpc): any => ({ ...obj, }); @@ -5270,6 +5762,9 @@ export interface CreateDefaultVpcResult { } export namespace CreateDefaultVpcResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateDefaultVpcResult): any => ({ ...obj, }); @@ -5291,6 +5786,9 @@ export interface NewDhcpConfiguration { } export namespace NewDhcpConfiguration { + /** + * @internal + */ export const filterSensitiveLog = (obj: NewDhcpConfiguration): any => ({ ...obj, }); @@ -5316,6 +5814,9 @@ export interface CreateDhcpOptionsRequest { } export namespace CreateDhcpOptionsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateDhcpOptionsRequest): any => ({ ...obj, }); @@ -5332,6 +5833,9 @@ export interface AttributeValue { } export namespace AttributeValue { + /** + * @internal + */ export const filterSensitiveLog = (obj: AttributeValue): any => ({ ...obj, }); @@ -5353,6 +5857,9 @@ export interface DhcpConfiguration { } export namespace DhcpConfiguration { + /** + * @internal + */ export const filterSensitiveLog = (obj: DhcpConfiguration): any => ({ ...obj, }); @@ -5384,6 +5891,9 @@ export interface DhcpOptions { } export namespace DhcpOptions { + /** + * @internal + */ export const filterSensitiveLog = (obj: DhcpOptions): any => ({ ...obj, }); @@ -5397,6 +5907,9 @@ export interface CreateDhcpOptionsResult { } export namespace CreateDhcpOptionsResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateDhcpOptionsResult): any => ({ ...obj, }); @@ -5429,6 +5942,9 @@ export interface CreateEgressOnlyInternetGatewayRequest { } export namespace CreateEgressOnlyInternetGatewayRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateEgressOnlyInternetGatewayRequest): any => ({ ...obj, }); @@ -5453,6 +5969,9 @@ export interface InternetGatewayAttachment { } export namespace InternetGatewayAttachment { + /** + * @internal + */ export const filterSensitiveLog = (obj: InternetGatewayAttachment): any => ({ ...obj, }); @@ -5479,6 +5998,9 @@ export interface EgressOnlyInternetGateway { } export namespace EgressOnlyInternetGateway { + /** + * @internal + */ export const filterSensitiveLog = (obj: EgressOnlyInternetGateway): any => ({ ...obj, }); @@ -5498,6 +6020,9 @@ export interface CreateEgressOnlyInternetGatewayResult { } export namespace CreateEgressOnlyInternetGatewayResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateEgressOnlyInternetGatewayResult): any => ({ ...obj, }); @@ -5534,6 +6059,9 @@ export interface FleetLaunchTemplateSpecificationRequest { } export namespace FleetLaunchTemplateSpecificationRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: FleetLaunchTemplateSpecificationRequest): any => ({ ...obj, }); @@ -6001,6 +6529,9 @@ export interface Placement { } export namespace Placement { + /** + * @internal + */ export const filterSensitiveLog = (obj: Placement): any => ({ ...obj, }); @@ -6058,6 +6589,9 @@ export interface FleetLaunchTemplateOverridesRequest { } export namespace FleetLaunchTemplateOverridesRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: FleetLaunchTemplateOverridesRequest): any => ({ ...obj, }); @@ -6083,6 +6617,9 @@ export interface FleetLaunchTemplateConfigRequest { } export namespace FleetLaunchTemplateConfigRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: FleetLaunchTemplateConfigRequest): any => ({ ...obj, }); @@ -6125,6 +6662,9 @@ export interface CapacityReservationOptionsRequest { } export namespace CapacityReservationOptionsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: CapacityReservationOptionsRequest): any => ({ ...obj, }); @@ -6174,6 +6714,9 @@ export interface OnDemandOptionsRequest { } export namespace OnDemandOptionsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: OnDemandOptionsRequest): any => ({ ...obj, }); @@ -6213,6 +6756,9 @@ export interface FleetSpotCapacityRebalanceRequest { } export namespace FleetSpotCapacityRebalanceRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: FleetSpotCapacityRebalanceRequest): any => ({ ...obj, }); @@ -6230,6 +6776,9 @@ export interface FleetSpotMaintenanceStrategiesRequest { } export namespace FleetSpotMaintenanceStrategiesRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: FleetSpotMaintenanceStrategiesRequest): any => ({ ...obj, }); @@ -6304,6 +6853,9 @@ export interface SpotOptionsRequest { } export namespace SpotOptionsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: SpotOptionsRequest): any => ({ ...obj, }); @@ -6353,6 +6905,9 @@ export interface TargetCapacitySpecificationRequest { } export namespace TargetCapacitySpecificationRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: TargetCapacitySpecificationRequest): any => ({ ...obj, }); @@ -6470,6 +7025,9 @@ export interface CreateFleetRequest { } export namespace CreateFleetRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateFleetRequest): any => ({ ...obj, }); @@ -6501,6 +7059,9 @@ export interface FleetLaunchTemplateSpecification { } export namespace FleetLaunchTemplateSpecification { + /** + * @internal + */ export const filterSensitiveLog = (obj: FleetLaunchTemplateSpecification): any => ({ ...obj, }); @@ -6517,6 +7078,9 @@ export interface PlacementResponse { } export namespace PlacementResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: PlacementResponse): any => ({ ...obj, }); @@ -6574,6 +7138,9 @@ export interface FleetLaunchTemplateOverrides { } export namespace FleetLaunchTemplateOverrides { + /** + * @internal + */ export const filterSensitiveLog = (obj: FleetLaunchTemplateOverrides): any => ({ ...obj, }); @@ -6596,6 +7163,9 @@ export interface LaunchTemplateAndOverridesResponse { } export namespace LaunchTemplateAndOverridesResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: LaunchTemplateAndOverridesResponse): any => ({ ...obj, }); @@ -6635,6 +7205,9 @@ export interface CreateFleetError { } export namespace CreateFleetError { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateFleetError): any => ({ ...obj, }); @@ -6675,6 +7248,9 @@ export interface CreateFleetInstance { } export namespace CreateFleetInstance { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateFleetInstance): any => ({ ...obj, }); @@ -6700,6 +7276,9 @@ export interface CreateFleetResult { } export namespace CreateFleetResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateFleetResult): any => ({ ...obj, }); @@ -6811,6 +7390,9 @@ export interface CreateFlowLogsRequest { } export namespace CreateFlowLogsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateFlowLogsRequest): any => ({ ...obj, }); @@ -6835,6 +7417,9 @@ export interface CreateFlowLogsResult { } export namespace CreateFlowLogsResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateFlowLogsResult): any => ({ ...obj, }); @@ -6856,6 +7441,9 @@ export interface StorageLocation { } export namespace StorageLocation { + /** + * @internal + */ export const filterSensitiveLog = (obj: StorageLocation): any => ({ ...obj, }); @@ -6902,6 +7490,9 @@ export interface CreateFpgaImageRequest { } export namespace CreateFpgaImageRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateFpgaImageRequest): any => ({ ...obj, }); @@ -6920,6 +7511,9 @@ export interface CreateFpgaImageResult { } export namespace CreateFpgaImageResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateFpgaImageResult): any => ({ ...obj, }); @@ -7042,6 +7636,9 @@ export interface EbsBlockDevice { } export namespace EbsBlockDevice { + /** + * @internal + */ export const filterSensitiveLog = (obj: EbsBlockDevice): any => ({ ...obj, }); @@ -7083,6 +7680,9 @@ export interface BlockDeviceMapping { } export namespace BlockDeviceMapping { + /** + * @internal + */ export const filterSensitiveLog = (obj: BlockDeviceMapping): any => ({ ...obj, }); @@ -7146,6 +7746,9 @@ export interface CreateImageRequest { } export namespace CreateImageRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateImageRequest): any => ({ ...obj, }); @@ -7159,6 +7762,9 @@ export interface CreateImageResult { } export namespace CreateImageResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateImageResult): any => ({ ...obj, }); @@ -7198,6 +7804,9 @@ export interface ExportToS3TaskSpecification { } export namespace ExportToS3TaskSpecification { + /** + * @internal + */ export const filterSensitiveLog = (obj: ExportToS3TaskSpecification): any => ({ ...obj, }); @@ -7233,6 +7842,9 @@ export interface CreateInstanceExportTaskRequest { } export namespace CreateInstanceExportTaskRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateInstanceExportTaskRequest): any => ({ ...obj, }); @@ -7267,6 +7879,9 @@ export interface ExportToS3Task { } export namespace ExportToS3Task { + /** + * @internal + */ export const filterSensitiveLog = (obj: ExportToS3Task): any => ({ ...obj, }); @@ -7288,6 +7903,9 @@ export interface InstanceExportDetails { } export namespace InstanceExportDetails { + /** + * @internal + */ export const filterSensitiveLog = (obj: InstanceExportDetails): any => ({ ...obj, }); @@ -7336,6 +7954,9 @@ export interface ExportTask { } export namespace ExportTask { + /** + * @internal + */ export const filterSensitiveLog = (obj: ExportTask): any => ({ ...obj, }); @@ -7349,6 +7970,9 @@ export interface CreateInstanceExportTaskResult { } export namespace CreateInstanceExportTaskResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateInstanceExportTaskResult): any => ({ ...obj, }); @@ -7369,6 +7993,9 @@ export interface CreateInternetGatewayRequest { } export namespace CreateInternetGatewayRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateInternetGatewayRequest): any => ({ ...obj, }); @@ -7400,6 +8027,9 @@ export interface InternetGateway { } export namespace InternetGateway { + /** + * @internal + */ export const filterSensitiveLog = (obj: InternetGateway): any => ({ ...obj, }); @@ -7413,6 +8043,9 @@ export interface CreateInternetGatewayResult { } export namespace CreateInternetGatewayResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateInternetGatewayResult): any => ({ ...obj, }); @@ -7439,6 +8072,9 @@ export interface CreateKeyPairRequest { } export namespace CreateKeyPairRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateKeyPairRequest): any => ({ ...obj, }); @@ -7475,6 +8111,9 @@ export interface KeyPair { } export namespace KeyPair { + /** + * @internal + */ export const filterSensitiveLog = (obj: KeyPair): any => ({ ...obj, ...(obj.KeyMaterial && { KeyMaterial: SENSITIVE_STRING }), @@ -7573,6 +8212,9 @@ export interface LaunchTemplateEbsBlockDeviceRequest { } export namespace LaunchTemplateEbsBlockDeviceRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: LaunchTemplateEbsBlockDeviceRequest): any => ({ ...obj, }); @@ -7607,6 +8249,9 @@ export interface LaunchTemplateBlockDeviceMappingRequest { } export namespace LaunchTemplateBlockDeviceMappingRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: LaunchTemplateBlockDeviceMappingRequest): any => ({ ...obj, }); @@ -7630,6 +8275,9 @@ export interface CapacityReservationTarget { } export namespace CapacityReservationTarget { + /** + * @internal + */ export const filterSensitiveLog = (obj: CapacityReservationTarget): any => ({ ...obj, }); @@ -7667,6 +8315,9 @@ export interface LaunchTemplateCapacityReservationSpecificationRequest { } export namespace LaunchTemplateCapacityReservationSpecificationRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: LaunchTemplateCapacityReservationSpecificationRequest): any => ({ ...obj, }); @@ -7690,6 +8341,9 @@ export interface LaunchTemplateCpuOptionsRequest { } export namespace LaunchTemplateCpuOptionsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: LaunchTemplateCpuOptionsRequest): any => ({ ...obj, }); @@ -7707,6 +8361,9 @@ export interface CreditSpecificationRequest { } export namespace CreditSpecificationRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreditSpecificationRequest): any => ({ ...obj, }); @@ -7725,6 +8382,9 @@ export interface ElasticGpuSpecification { } export namespace ElasticGpuSpecification { + /** + * @internal + */ export const filterSensitiveLog = (obj: ElasticGpuSpecification): any => ({ ...obj, }); @@ -7753,6 +8413,9 @@ export interface LaunchTemplateElasticInferenceAccelerator { } export namespace LaunchTemplateElasticInferenceAccelerator { + /** + * @internal + */ export const filterSensitiveLog = (obj: LaunchTemplateElasticInferenceAccelerator): any => ({ ...obj, }); @@ -7771,6 +8434,9 @@ export interface LaunchTemplateEnclaveOptionsRequest { } export namespace LaunchTemplateEnclaveOptionsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: LaunchTemplateEnclaveOptionsRequest): any => ({ ...obj, }); @@ -7791,6 +8457,9 @@ export interface LaunchTemplateHibernationOptionsRequest { } export namespace LaunchTemplateHibernationOptionsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: LaunchTemplateHibernationOptionsRequest): any => ({ ...obj, }); @@ -7812,6 +8481,9 @@ export interface LaunchTemplateIamInstanceProfileSpecificationRequest { } export namespace LaunchTemplateIamInstanceProfileSpecificationRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: LaunchTemplateIamInstanceProfileSpecificationRequest): any => ({ ...obj, }); diff --git a/clients/client-ec2/models/models_1.ts b/clients/client-ec2/models/models_1.ts index a464f83a4978..e37278a4bdc1 100644 --- a/clients/client-ec2/models/models_1.ts +++ b/clients/client-ec2/models/models_1.ts @@ -77,6 +77,9 @@ export interface LaunchTemplateSpotMarketOptionsRequest { } export namespace LaunchTemplateSpotMarketOptionsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: LaunchTemplateSpotMarketOptionsRequest): any => ({ ...obj, }); @@ -98,6 +101,9 @@ export interface LaunchTemplateInstanceMarketOptionsRequest { } export namespace LaunchTemplateInstanceMarketOptionsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: LaunchTemplateInstanceMarketOptionsRequest): any => ({ ...obj, }); @@ -114,6 +120,9 @@ export interface LaunchTemplateLicenseConfigurationRequest { } export namespace LaunchTemplateLicenseConfigurationRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: LaunchTemplateLicenseConfigurationRequest): any => ({ ...obj, }); @@ -156,6 +165,9 @@ export interface LaunchTemplateInstanceMetadataOptionsRequest { } export namespace LaunchTemplateInstanceMetadataOptionsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: LaunchTemplateInstanceMetadataOptionsRequest): any => ({ ...obj, }); @@ -172,6 +184,9 @@ export interface LaunchTemplatesMonitoringRequest { } export namespace LaunchTemplatesMonitoringRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: LaunchTemplatesMonitoringRequest): any => ({ ...obj, }); @@ -188,6 +203,9 @@ export interface InstanceIpv6AddressRequest { } export namespace InstanceIpv6AddressRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: InstanceIpv6AddressRequest): any => ({ ...obj, }); @@ -210,6 +228,9 @@ export interface PrivateIpAddressSpecification { } export namespace PrivateIpAddressSpecification { + /** + * @internal + */ export const filterSensitiveLog = (obj: PrivateIpAddressSpecification): any => ({ ...obj, }); @@ -307,6 +328,9 @@ export interface LaunchTemplateInstanceNetworkInterfaceSpecificationRequest { } export namespace LaunchTemplateInstanceNetworkInterfaceSpecificationRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: LaunchTemplateInstanceNetworkInterfaceSpecificationRequest): any => ({ ...obj, }); @@ -361,6 +385,9 @@ export interface LaunchTemplatePlacementRequest { } export namespace LaunchTemplatePlacementRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: LaunchTemplatePlacementRequest): any => ({ ...obj, }); @@ -384,6 +411,9 @@ export interface LaunchTemplateTagSpecificationRequest { } export namespace LaunchTemplateTagSpecificationRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: LaunchTemplateTagSpecificationRequest): any => ({ ...obj, }); @@ -582,6 +612,9 @@ export interface RequestLaunchTemplateData { } export namespace RequestLaunchTemplateData { + /** + * @internal + */ export const filterSensitiveLog = (obj: RequestLaunchTemplateData): any => ({ ...obj, }); @@ -626,6 +659,9 @@ export interface CreateLaunchTemplateRequest { } export namespace CreateLaunchTemplateRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateLaunchTemplateRequest): any => ({ ...obj, }); @@ -672,6 +708,9 @@ export interface LaunchTemplate { } export namespace LaunchTemplate { + /** + * @internal + */ export const filterSensitiveLog = (obj: LaunchTemplate): any => ({ ...obj, }); @@ -694,6 +733,9 @@ export interface ValidationError { } export namespace ValidationError { + /** + * @internal + */ export const filterSensitiveLog = (obj: ValidationError): any => ({ ...obj, }); @@ -710,6 +752,9 @@ export interface ValidationWarning { } export namespace ValidationWarning { + /** + * @internal + */ export const filterSensitiveLog = (obj: ValidationWarning): any => ({ ...obj, }); @@ -728,6 +773,9 @@ export interface CreateLaunchTemplateResult { } export namespace CreateLaunchTemplateResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateLaunchTemplateResult): any => ({ ...obj, }); @@ -783,6 +831,9 @@ export interface CreateLaunchTemplateVersionRequest { } export namespace CreateLaunchTemplateVersionRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateLaunchTemplateVersionRequest): any => ({ ...obj, }); @@ -834,6 +885,9 @@ export interface LaunchTemplateEbsBlockDevice { } export namespace LaunchTemplateEbsBlockDevice { + /** + * @internal + */ export const filterSensitiveLog = (obj: LaunchTemplateEbsBlockDevice): any => ({ ...obj, }); @@ -865,6 +919,9 @@ export interface LaunchTemplateBlockDeviceMapping { } export namespace LaunchTemplateBlockDeviceMapping { + /** + * @internal + */ export const filterSensitiveLog = (obj: LaunchTemplateBlockDeviceMapping): any => ({ ...obj, }); @@ -886,6 +943,9 @@ export interface CapacityReservationTargetResponse { } export namespace CapacityReservationTargetResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: CapacityReservationTargetResponse): any => ({ ...obj, }); @@ -919,6 +979,9 @@ export interface LaunchTemplateCapacityReservationSpecificationResponse { } export namespace LaunchTemplateCapacityReservationSpecificationResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: LaunchTemplateCapacityReservationSpecificationResponse): any => ({ ...obj, }); @@ -940,6 +1003,9 @@ export interface LaunchTemplateCpuOptions { } export namespace LaunchTemplateCpuOptions { + /** + * @internal + */ export const filterSensitiveLog = (obj: LaunchTemplateCpuOptions): any => ({ ...obj, }); @@ -957,6 +1023,9 @@ export interface CreditSpecification { } export namespace CreditSpecification { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreditSpecification): any => ({ ...obj, }); @@ -973,6 +1042,9 @@ export interface ElasticGpuSpecificationResponse { } export namespace ElasticGpuSpecificationResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ElasticGpuSpecificationResponse): any => ({ ...obj, }); @@ -1001,6 +1073,9 @@ export interface LaunchTemplateElasticInferenceAcceleratorResponse { } export namespace LaunchTemplateElasticInferenceAcceleratorResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: LaunchTemplateElasticInferenceAcceleratorResponse): any => ({ ...obj, }); @@ -1018,6 +1093,9 @@ export interface LaunchTemplateEnclaveOptions { } export namespace LaunchTemplateEnclaveOptions { + /** + * @internal + */ export const filterSensitiveLog = (obj: LaunchTemplateEnclaveOptions): any => ({ ...obj, }); @@ -1034,6 +1112,9 @@ export interface LaunchTemplateHibernationOptions { } export namespace LaunchTemplateHibernationOptions { + /** + * @internal + */ export const filterSensitiveLog = (obj: LaunchTemplateHibernationOptions): any => ({ ...obj, }); @@ -1055,6 +1136,9 @@ export interface LaunchTemplateIamInstanceProfileSpecification { } export namespace LaunchTemplateIamInstanceProfileSpecification { + /** + * @internal + */ export const filterSensitiveLog = (obj: LaunchTemplateIamInstanceProfileSpecification): any => ({ ...obj, }); @@ -1091,6 +1175,9 @@ export interface LaunchTemplateSpotMarketOptions { } export namespace LaunchTemplateSpotMarketOptions { + /** + * @internal + */ export const filterSensitiveLog = (obj: LaunchTemplateSpotMarketOptions): any => ({ ...obj, }); @@ -1112,6 +1199,9 @@ export interface LaunchTemplateInstanceMarketOptions { } export namespace LaunchTemplateInstanceMarketOptions { + /** + * @internal + */ export const filterSensitiveLog = (obj: LaunchTemplateInstanceMarketOptions): any => ({ ...obj, }); @@ -1128,6 +1218,9 @@ export interface LaunchTemplateLicenseConfiguration { } export namespace LaunchTemplateLicenseConfiguration { + /** + * @internal + */ export const filterSensitiveLog = (obj: LaunchTemplateLicenseConfiguration): any => ({ ...obj, }); @@ -1174,6 +1267,9 @@ export interface LaunchTemplateInstanceMetadataOptions { } export namespace LaunchTemplateInstanceMetadataOptions { + /** + * @internal + */ export const filterSensitiveLog = (obj: LaunchTemplateInstanceMetadataOptions): any => ({ ...obj, }); @@ -1191,6 +1287,9 @@ export interface LaunchTemplatesMonitoring { } export namespace LaunchTemplatesMonitoring { + /** + * @internal + */ export const filterSensitiveLog = (obj: LaunchTemplatesMonitoring): any => ({ ...obj, }); @@ -1207,6 +1306,9 @@ export interface InstanceIpv6Address { } export namespace InstanceIpv6Address { + /** + * @internal + */ export const filterSensitiveLog = (obj: InstanceIpv6Address): any => ({ ...obj, }); @@ -1297,6 +1399,9 @@ export interface LaunchTemplateInstanceNetworkInterfaceSpecification { } export namespace LaunchTemplateInstanceNetworkInterfaceSpecification { + /** + * @internal + */ export const filterSensitiveLog = (obj: LaunchTemplateInstanceNetworkInterfaceSpecification): any => ({ ...obj, }); @@ -1349,6 +1454,9 @@ export interface LaunchTemplatePlacement { } export namespace LaunchTemplatePlacement { + /** + * @internal + */ export const filterSensitiveLog = (obj: LaunchTemplatePlacement): any => ({ ...obj, }); @@ -1370,6 +1478,9 @@ export interface LaunchTemplateTagSpecification { } export namespace LaunchTemplateTagSpecification { + /** + * @internal + */ export const filterSensitiveLog = (obj: LaunchTemplateTagSpecification): any => ({ ...obj, }); @@ -1524,6 +1635,9 @@ export interface ResponseLaunchTemplateData { } export namespace ResponseLaunchTemplateData { + /** + * @internal + */ export const filterSensitiveLog = (obj: ResponseLaunchTemplateData): any => ({ ...obj, }); @@ -1575,6 +1689,9 @@ export interface LaunchTemplateVersion { } export namespace LaunchTemplateVersion { + /** + * @internal + */ export const filterSensitiveLog = (obj: LaunchTemplateVersion): any => ({ ...obj, }); @@ -1593,6 +1710,9 @@ export interface CreateLaunchTemplateVersionResult { } export namespace CreateLaunchTemplateVersionResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateLaunchTemplateVersionResult): any => ({ ...obj, }); @@ -1624,6 +1744,9 @@ export interface CreateLocalGatewayRouteRequest { } export namespace CreateLocalGatewayRouteRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateLocalGatewayRouteRequest): any => ({ ...obj, }); @@ -1674,6 +1797,9 @@ export interface LocalGatewayRoute { } export namespace LocalGatewayRoute { + /** + * @internal + */ export const filterSensitiveLog = (obj: LocalGatewayRoute): any => ({ ...obj, }); @@ -1687,6 +1813,9 @@ export interface CreateLocalGatewayRouteResult { } export namespace CreateLocalGatewayRouteResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateLocalGatewayRouteResult): any => ({ ...obj, }); @@ -1717,6 +1846,9 @@ export interface CreateLocalGatewayRouteTableVpcAssociationRequest { } export namespace CreateLocalGatewayRouteTableVpcAssociationRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateLocalGatewayRouteTableVpcAssociationRequest): any => ({ ...obj, }); @@ -1768,6 +1900,9 @@ export interface LocalGatewayRouteTableVpcAssociation { } export namespace LocalGatewayRouteTableVpcAssociation { + /** + * @internal + */ export const filterSensitiveLog = (obj: LocalGatewayRouteTableVpcAssociation): any => ({ ...obj, }); @@ -1781,6 +1916,9 @@ export interface CreateLocalGatewayRouteTableVpcAssociationResult { } export namespace CreateLocalGatewayRouteTableVpcAssociationResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateLocalGatewayRouteTableVpcAssociationResult): any => ({ ...obj, }); @@ -1832,6 +1970,9 @@ export interface CreateManagedPrefixListRequest { } export namespace CreateManagedPrefixListRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateManagedPrefixListRequest): any => ({ ...obj, }); @@ -1907,6 +2048,9 @@ export interface ManagedPrefixList { } export namespace ManagedPrefixList { + /** + * @internal + */ export const filterSensitiveLog = (obj: ManagedPrefixList): any => ({ ...obj, }); @@ -1920,6 +2064,9 @@ export interface CreateManagedPrefixListResult { } export namespace CreateManagedPrefixListResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateManagedPrefixListResult): any => ({ ...obj, }); @@ -1958,6 +2105,9 @@ export interface CreateNatGatewayRequest { } export namespace CreateNatGatewayRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateNatGatewayRequest): any => ({ ...obj, }); @@ -1989,6 +2139,9 @@ export interface NatGatewayAddress { } export namespace NatGatewayAddress { + /** + * @internal + */ export const filterSensitiveLog = (obj: NatGatewayAddress): any => ({ ...obj, }); @@ -2025,6 +2178,9 @@ export interface ProvisionedBandwidth { } export namespace ProvisionedBandwidth { + /** + * @internal + */ export const filterSensitiveLog = (obj: ProvisionedBandwidth): any => ({ ...obj, }); @@ -2149,6 +2305,9 @@ export interface NatGateway { } export namespace NatGateway { + /** + * @internal + */ export const filterSensitiveLog = (obj: NatGateway): any => ({ ...obj, }); @@ -2167,6 +2326,9 @@ export interface CreateNatGatewayResult { } export namespace CreateNatGatewayResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateNatGatewayResult): any => ({ ...obj, }); @@ -2192,6 +2354,9 @@ export interface CreateNetworkAclRequest { } export namespace CreateNetworkAclRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateNetworkAclRequest): any => ({ ...obj, }); @@ -2218,6 +2383,9 @@ export interface NetworkAclAssociation { } export namespace NetworkAclAssociation { + /** + * @internal + */ export const filterSensitiveLog = (obj: NetworkAclAssociation): any => ({ ...obj, }); @@ -2239,6 +2407,9 @@ export interface IcmpTypeCode { } export namespace IcmpTypeCode { + /** + * @internal + */ export const filterSensitiveLog = (obj: IcmpTypeCode): any => ({ ...obj, }); @@ -2260,6 +2431,9 @@ export interface PortRange { } export namespace PortRange { + /** + * @internal + */ export const filterSensitiveLog = (obj: PortRange): any => ({ ...obj, }); @@ -2313,6 +2487,9 @@ export interface NetworkAclEntry { } export namespace NetworkAclEntry { + /** + * @internal + */ export const filterSensitiveLog = (obj: NetworkAclEntry): any => ({ ...obj, }); @@ -2359,6 +2536,9 @@ export interface NetworkAcl { } export namespace NetworkAcl { + /** + * @internal + */ export const filterSensitiveLog = (obj: NetworkAcl): any => ({ ...obj, }); @@ -2372,6 +2552,9 @@ export interface CreateNetworkAclResult { } export namespace CreateNetworkAclResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateNetworkAclResult): any => ({ ...obj, }); @@ -2442,6 +2625,9 @@ export interface CreateNetworkAclEntryRequest { } export namespace CreateNetworkAclEntryRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateNetworkAclEntryRequest): any => ({ ...obj, }); @@ -2500,6 +2686,9 @@ export interface CreateNetworkInsightsPathRequest { } export namespace CreateNetworkInsightsPathRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateNetworkInsightsPathRequest): any => ({ ...obj, }); @@ -2561,6 +2750,9 @@ export interface NetworkInsightsPath { } export namespace NetworkInsightsPath { + /** + * @internal + */ export const filterSensitiveLog = (obj: NetworkInsightsPath): any => ({ ...obj, }); @@ -2574,6 +2766,9 @@ export interface CreateNetworkInsightsPathResult { } export namespace CreateNetworkInsightsPathResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateNetworkInsightsPathResult): any => ({ ...obj, }); @@ -2660,6 +2855,9 @@ export interface CreateNetworkInterfaceRequest { } export namespace CreateNetworkInterfaceRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateNetworkInterfaceRequest): any => ({ ...obj, }); @@ -2710,6 +2908,9 @@ export interface NetworkInterfaceAssociation { } export namespace NetworkInterfaceAssociation { + /** + * @internal + */ export const filterSensitiveLog = (obj: NetworkInterfaceAssociation): any => ({ ...obj, }); @@ -2761,6 +2962,9 @@ export interface NetworkInterfaceAttachment { } export namespace NetworkInterfaceAttachment { + /** + * @internal + */ export const filterSensitiveLog = (obj: NetworkInterfaceAttachment): any => ({ ...obj, }); @@ -2782,6 +2986,9 @@ export interface GroupIdentifier { } export namespace GroupIdentifier { + /** + * @internal + */ export const filterSensitiveLog = (obj: GroupIdentifier): any => ({ ...obj, }); @@ -2800,6 +3007,9 @@ export interface NetworkInterfaceIpv6Address { } export namespace NetworkInterfaceIpv6Address { + /** + * @internal + */ export const filterSensitiveLog = (obj: NetworkInterfaceIpv6Address): any => ({ ...obj, }); @@ -2831,6 +3041,9 @@ export interface NetworkInterfacePrivateIpAddress { } export namespace NetworkInterfacePrivateIpAddress { + /** + * @internal + */ export const filterSensitiveLog = (obj: NetworkInterfacePrivateIpAddress): any => ({ ...obj, }); @@ -2949,6 +3162,9 @@ export interface NetworkInterface { } export namespace NetworkInterface { + /** + * @internal + */ export const filterSensitiveLog = (obj: NetworkInterface): any => ({ ...obj, }); @@ -2965,6 +3181,9 @@ export interface CreateNetworkInterfaceResult { } export namespace CreateNetworkInterfaceResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateNetworkInterfaceResult): any => ({ ...obj, }); @@ -3005,6 +3224,9 @@ export interface CreateNetworkInterfacePermissionRequest { } export namespace CreateNetworkInterfacePermissionRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateNetworkInterfacePermissionRequest): any => ({ ...obj, }); @@ -3028,6 +3250,9 @@ export interface NetworkInterfacePermissionState { } export namespace NetworkInterfacePermissionState { + /** + * @internal + */ export const filterSensitiveLog = (obj: NetworkInterfacePermissionState): any => ({ ...obj, }); @@ -3069,6 +3294,9 @@ export interface NetworkInterfacePermission { } export namespace NetworkInterfacePermission { + /** + * @internal + */ export const filterSensitiveLog = (obj: NetworkInterfacePermission): any => ({ ...obj, }); @@ -3085,6 +3313,9 @@ export interface CreateNetworkInterfacePermissionResult { } export namespace CreateNetworkInterfacePermissionResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateNetworkInterfacePermissionResult): any => ({ ...obj, }); @@ -3125,6 +3356,9 @@ export interface CreatePlacementGroupRequest { } export namespace CreatePlacementGroupRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreatePlacementGroupRequest): any => ({ ...obj, }); @@ -3169,6 +3403,9 @@ export interface PlacementGroup { } export namespace PlacementGroup { + /** + * @internal + */ export const filterSensitiveLog = (obj: PlacementGroup): any => ({ ...obj, }); @@ -3182,6 +3419,9 @@ export interface CreatePlacementGroupResult { } export namespace CreatePlacementGroupResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreatePlacementGroupResult): any => ({ ...obj, }); @@ -3220,6 +3460,9 @@ export interface CreateReplaceRootVolumeTaskRequest { } export namespace CreateReplaceRootVolumeTaskRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateReplaceRootVolumeTaskRequest): any => ({ ...obj, }); @@ -3305,6 +3548,9 @@ export interface ReplaceRootVolumeTask { } export namespace ReplaceRootVolumeTask { + /** + * @internal + */ export const filterSensitiveLog = (obj: ReplaceRootVolumeTask): any => ({ ...obj, }); @@ -3318,6 +3564,9 @@ export interface CreateReplaceRootVolumeTaskResult { } export namespace CreateReplaceRootVolumeTaskResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateReplaceRootVolumeTaskResult): any => ({ ...obj, }); @@ -3345,6 +3594,9 @@ export interface PriceScheduleSpecification { } export namespace PriceScheduleSpecification { + /** + * @internal + */ export const filterSensitiveLog = (obj: PriceScheduleSpecification): any => ({ ...obj, }); @@ -3378,6 +3630,9 @@ export interface CreateReservedInstancesListingRequest { } export namespace CreateReservedInstancesListingRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateReservedInstancesListingRequest): any => ({ ...obj, }); @@ -3394,6 +3649,9 @@ export interface CreateReservedInstancesListingResult { } export namespace CreateReservedInstancesListingResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateReservedInstancesListingResult): any => ({ ...obj, }); @@ -3442,6 +3700,9 @@ export interface CreateRestoreImageTaskRequest { } export namespace CreateRestoreImageTaskRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateRestoreImageTaskRequest): any => ({ ...obj, }); @@ -3455,6 +3716,9 @@ export interface CreateRestoreImageTaskResult { } export namespace CreateRestoreImageTaskResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateRestoreImageTaskResult): any => ({ ...obj, }); @@ -3542,6 +3806,9 @@ export interface CreateRouteRequest { } export namespace CreateRouteRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateRouteRequest): any => ({ ...obj, }); @@ -3555,6 +3822,9 @@ export interface CreateRouteResult { } export namespace CreateRouteResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateRouteResult): any => ({ ...obj, }); @@ -3580,6 +3850,9 @@ export interface CreateRouteTableRequest { } export namespace CreateRouteTableRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateRouteTableRequest): any => ({ ...obj, }); @@ -3621,6 +3894,9 @@ export interface RouteTableAssociation { } export namespace RouteTableAssociation { + /** + * @internal + */ export const filterSensitiveLog = (obj: RouteTableAssociation): any => ({ ...obj, }); @@ -3637,6 +3913,9 @@ export interface PropagatingVgw { } export namespace PropagatingVgw { + /** + * @internal + */ export const filterSensitiveLog = (obj: PropagatingVgw): any => ({ ...obj, }); @@ -3743,6 +4022,9 @@ export interface Route { } export namespace Route { + /** + * @internal + */ export const filterSensitiveLog = (obj: Route): any => ({ ...obj, }); @@ -3789,6 +4071,9 @@ export interface RouteTable { } export namespace RouteTable { + /** + * @internal + */ export const filterSensitiveLog = (obj: RouteTable): any => ({ ...obj, }); @@ -3802,6 +4087,9 @@ export interface CreateRouteTableResult { } export namespace CreateRouteTableResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateRouteTableResult): any => ({ ...obj, }); @@ -3844,6 +4132,9 @@ export interface CreateSecurityGroupRequest { } export namespace CreateSecurityGroupRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateSecurityGroupRequest): any => ({ ...obj, }); @@ -3862,6 +4153,9 @@ export interface CreateSecurityGroupResult { } export namespace CreateSecurityGroupResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateSecurityGroupResult): any => ({ ...obj, }); @@ -3917,6 +4211,9 @@ export interface CreateSnapshotRequest { } export namespace CreateSnapshotRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateSnapshotRequest): any => ({ ...obj, }); @@ -4017,6 +4314,9 @@ export interface Snapshot { } export namespace Snapshot { + /** + * @internal + */ export const filterSensitiveLog = (obj: Snapshot): any => ({ ...obj, }); @@ -4040,6 +4340,9 @@ export interface InstanceSpecification { } export namespace InstanceSpecification { + /** + * @internal + */ export const filterSensitiveLog = (obj: InstanceSpecification): any => ({ ...obj, }); @@ -4100,6 +4403,9 @@ export interface CreateSnapshotsRequest { } export namespace CreateSnapshotsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateSnapshotsRequest): any => ({ ...obj, }); @@ -4169,6 +4475,9 @@ export interface SnapshotInfo { } export namespace SnapshotInfo { + /** + * @internal + */ export const filterSensitiveLog = (obj: SnapshotInfo): any => ({ ...obj, }); @@ -4182,6 +4491,9 @@ export interface CreateSnapshotsResult { } export namespace CreateSnapshotsResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateSnapshotsResult): any => ({ ...obj, }); @@ -4211,6 +4523,9 @@ export interface CreateSpotDatafeedSubscriptionRequest { } export namespace CreateSpotDatafeedSubscriptionRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateSpotDatafeedSubscriptionRequest): any => ({ ...obj, }); @@ -4232,6 +4547,9 @@ export interface SpotInstanceStateFault { } export namespace SpotInstanceStateFault { + /** + * @internal + */ export const filterSensitiveLog = (obj: SpotInstanceStateFault): any => ({ ...obj, }); @@ -4270,6 +4588,9 @@ export interface SpotDatafeedSubscription { } export namespace SpotDatafeedSubscription { + /** + * @internal + */ export const filterSensitiveLog = (obj: SpotDatafeedSubscription): any => ({ ...obj, }); @@ -4286,6 +4607,9 @@ export interface CreateSpotDatafeedSubscriptionResult { } export namespace CreateSpotDatafeedSubscriptionResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateSpotDatafeedSubscriptionResult): any => ({ ...obj, }); @@ -4313,6 +4637,9 @@ export interface S3ObjectTag { } export namespace S3ObjectTag { + /** + * @internal + */ export const filterSensitiveLog = (obj: S3ObjectTag): any => ({ ...obj, }); @@ -4345,6 +4672,9 @@ export interface CreateStoreImageTaskRequest { } export namespace CreateStoreImageTaskRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateStoreImageTaskRequest): any => ({ ...obj, }); @@ -4358,6 +4688,9 @@ export interface CreateStoreImageTaskResult { } export namespace CreateStoreImageTaskResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateStoreImageTaskResult): any => ({ ...obj, }); @@ -4417,6 +4750,9 @@ export interface CreateSubnetRequest { } export namespace CreateSubnetRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateSubnetRequest): any => ({ ...obj, }); @@ -4430,6 +4766,9 @@ export interface CreateSubnetResult { } export namespace CreateSubnetResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateSubnetResult): any => ({ ...obj, }); @@ -4457,6 +4796,9 @@ export interface CreateTagsRequest { } export namespace CreateTagsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateTagsRequest): any => ({ ...obj, }); @@ -4487,6 +4829,9 @@ export interface CreateTrafficMirrorFilterRequest { } export namespace CreateTrafficMirrorFilterRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateTrafficMirrorFilterRequest): any => ({ ...obj, }); @@ -4508,6 +4853,9 @@ export interface TrafficMirrorPortRange { } export namespace TrafficMirrorPortRange { + /** + * @internal + */ export const filterSensitiveLog = (obj: TrafficMirrorPortRange): any => ({ ...obj, }); @@ -4578,6 +4926,9 @@ export interface TrafficMirrorFilterRule { } export namespace TrafficMirrorFilterRule { + /** + * @internal + */ export const filterSensitiveLog = (obj: TrafficMirrorFilterRule): any => ({ ...obj, }); @@ -4621,6 +4972,9 @@ export interface TrafficMirrorFilter { } export namespace TrafficMirrorFilter { + /** + * @internal + */ export const filterSensitiveLog = (obj: TrafficMirrorFilter): any => ({ ...obj, }); @@ -4639,6 +4993,9 @@ export interface CreateTrafficMirrorFilterResult { } export namespace CreateTrafficMirrorFilterResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateTrafficMirrorFilterResult): any => ({ ...obj, }); @@ -4660,6 +5017,9 @@ export interface TrafficMirrorPortRangeRequest { } export namespace TrafficMirrorPortRangeRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: TrafficMirrorPortRangeRequest): any => ({ ...obj, }); @@ -4732,6 +5092,9 @@ export interface CreateTrafficMirrorFilterRuleRequest { } export namespace CreateTrafficMirrorFilterRuleRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateTrafficMirrorFilterRuleRequest): any => ({ ...obj, }); @@ -4750,6 +5113,9 @@ export interface CreateTrafficMirrorFilterRuleResult { } export namespace CreateTrafficMirrorFilterRuleResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateTrafficMirrorFilterRuleResult): any => ({ ...obj, }); @@ -4819,6 +5185,9 @@ export interface CreateTrafficMirrorSessionRequest { } export namespace CreateTrafficMirrorSessionRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateTrafficMirrorSessionRequest): any => ({ ...obj, }); @@ -4881,6 +5250,9 @@ export interface TrafficMirrorSession { } export namespace TrafficMirrorSession { + /** + * @internal + */ export const filterSensitiveLog = (obj: TrafficMirrorSession): any => ({ ...obj, }); @@ -4899,6 +5271,9 @@ export interface CreateTrafficMirrorSessionResult { } export namespace CreateTrafficMirrorSessionResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateTrafficMirrorSessionResult): any => ({ ...obj, }); @@ -4939,6 +5314,9 @@ export interface CreateTrafficMirrorTargetRequest { } export namespace CreateTrafficMirrorTargetRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateTrafficMirrorTargetRequest): any => ({ ...obj, }); @@ -4987,6 +5365,9 @@ export interface TrafficMirrorTarget { } export namespace TrafficMirrorTarget { + /** + * @internal + */ export const filterSensitiveLog = (obj: TrafficMirrorTarget): any => ({ ...obj, }); @@ -5005,6 +5386,9 @@ export interface CreateTrafficMirrorTargetResult { } export namespace CreateTrafficMirrorTargetResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateTrafficMirrorTargetResult): any => ({ ...obj, }); @@ -5067,6 +5451,9 @@ export interface TransitGatewayRequestOptions { } export namespace TransitGatewayRequestOptions { + /** + * @internal + */ export const filterSensitiveLog = (obj: TransitGatewayRequestOptions): any => ({ ...obj, }); @@ -5097,6 +5484,9 @@ export interface CreateTransitGatewayRequest { } export namespace CreateTransitGatewayRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateTransitGatewayRequest): any => ({ ...obj, }); @@ -5159,6 +5549,9 @@ export interface TransitGatewayOptions { } export namespace TransitGatewayOptions { + /** + * @internal + */ export const filterSensitiveLog = (obj: TransitGatewayOptions): any => ({ ...obj, }); @@ -5212,6 +5605,9 @@ export interface TransitGateway { } export namespace TransitGateway { + /** + * @internal + */ export const filterSensitiveLog = (obj: TransitGateway): any => ({ ...obj, }); @@ -5225,6 +5621,9 @@ export interface CreateTransitGatewayResult { } export namespace CreateTransitGatewayResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateTransitGatewayResult): any => ({ ...obj, }); @@ -5243,6 +5642,9 @@ export interface CreateTransitGatewayConnectRequestOptions { } export namespace CreateTransitGatewayConnectRequestOptions { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateTransitGatewayConnectRequestOptions): any => ({ ...obj, }); @@ -5273,6 +5675,9 @@ export interface CreateTransitGatewayConnectRequest { } export namespace CreateTransitGatewayConnectRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateTransitGatewayConnectRequest): any => ({ ...obj, }); @@ -5289,6 +5694,9 @@ export interface TransitGatewayConnectOptions { } export namespace TransitGatewayConnectOptions { + /** + * @internal + */ export const filterSensitiveLog = (obj: TransitGatewayConnectOptions): any => ({ ...obj, }); @@ -5335,6 +5743,9 @@ export interface TransitGatewayConnect { } export namespace TransitGatewayConnect { + /** + * @internal + */ export const filterSensitiveLog = (obj: TransitGatewayConnect): any => ({ ...obj, }); @@ -5348,6 +5759,9 @@ export interface CreateTransitGatewayConnectResult { } export namespace CreateTransitGatewayConnectResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateTransitGatewayConnectResult): any => ({ ...obj, }); @@ -5364,6 +5778,9 @@ export interface TransitGatewayConnectRequestBgpOptions { } export namespace TransitGatewayConnectRequestBgpOptions { + /** + * @internal + */ export const filterSensitiveLog = (obj: TransitGatewayConnectRequestBgpOptions): any => ({ ...obj, }); @@ -5415,6 +5832,9 @@ export interface CreateTransitGatewayConnectPeerRequest { } export namespace CreateTransitGatewayConnectPeerRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateTransitGatewayConnectPeerRequest): any => ({ ...obj, }); @@ -5453,6 +5873,9 @@ export interface TransitGatewayAttachmentBgpConfiguration { } export namespace TransitGatewayAttachmentBgpConfiguration { + /** + * @internal + */ export const filterSensitiveLog = (obj: TransitGatewayAttachmentBgpConfiguration): any => ({ ...obj, }); @@ -5489,6 +5912,9 @@ export interface TransitGatewayConnectPeerConfiguration { } export namespace TransitGatewayConnectPeerConfiguration { + /** + * @internal + */ export const filterSensitiveLog = (obj: TransitGatewayConnectPeerConfiguration): any => ({ ...obj, }); @@ -5532,6 +5958,9 @@ export interface TransitGatewayConnectPeer { } export namespace TransitGatewayConnectPeer { + /** + * @internal + */ export const filterSensitiveLog = (obj: TransitGatewayConnectPeer): any => ({ ...obj, }); @@ -5545,6 +5974,9 @@ export interface CreateTransitGatewayConnectPeerResult { } export namespace CreateTransitGatewayConnectPeerResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateTransitGatewayConnectPeerResult): any => ({ ...obj, }); @@ -5577,6 +6009,9 @@ export interface CreateTransitGatewayMulticastDomainRequestOptions { } export namespace CreateTransitGatewayMulticastDomainRequestOptions { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateTransitGatewayMulticastDomainRequestOptions): any => ({ ...obj, }); @@ -5607,6 +6042,9 @@ export interface CreateTransitGatewayMulticastDomainRequest { } export namespace CreateTransitGatewayMulticastDomainRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateTransitGatewayMulticastDomainRequest): any => ({ ...obj, }); @@ -5633,6 +6071,9 @@ export interface TransitGatewayMulticastDomainOptions { } export namespace TransitGatewayMulticastDomainOptions { + /** + * @internal + */ export const filterSensitiveLog = (obj: TransitGatewayMulticastDomainOptions): any => ({ ...obj, }); @@ -5686,6 +6127,9 @@ export interface TransitGatewayMulticastDomain { } export namespace TransitGatewayMulticastDomain { + /** + * @internal + */ export const filterSensitiveLog = (obj: TransitGatewayMulticastDomain): any => ({ ...obj, }); @@ -5699,6 +6143,9 @@ export interface CreateTransitGatewayMulticastDomainResult { } export namespace CreateTransitGatewayMulticastDomainResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateTransitGatewayMulticastDomainResult): any => ({ ...obj, }); @@ -5739,6 +6186,9 @@ export interface CreateTransitGatewayPeeringAttachmentRequest { } export namespace CreateTransitGatewayPeeringAttachmentRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateTransitGatewayPeeringAttachmentRequest): any => ({ ...obj, }); @@ -5752,6 +6202,9 @@ export interface CreateTransitGatewayPeeringAttachmentResult { } export namespace CreateTransitGatewayPeeringAttachmentResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateTransitGatewayPeeringAttachmentResult): any => ({ ...obj, }); @@ -5787,6 +6240,9 @@ export interface CreateTransitGatewayPrefixListReferenceRequest { } export namespace CreateTransitGatewayPrefixListReferenceRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateTransitGatewayPrefixListReferenceRequest): any => ({ ...obj, }); @@ -5815,6 +6271,9 @@ export interface TransitGatewayPrefixListAttachment { } export namespace TransitGatewayPrefixListAttachment { + /** + * @internal + */ export const filterSensitiveLog = (obj: TransitGatewayPrefixListAttachment): any => ({ ...obj, }); @@ -5856,6 +6315,9 @@ export interface TransitGatewayPrefixListReference { } export namespace TransitGatewayPrefixListReference { + /** + * @internal + */ export const filterSensitiveLog = (obj: TransitGatewayPrefixListReference): any => ({ ...obj, }); @@ -5869,6 +6331,9 @@ export interface CreateTransitGatewayPrefixListReferenceResult { } export namespace CreateTransitGatewayPrefixListReferenceResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateTransitGatewayPrefixListReferenceResult): any => ({ ...obj, }); @@ -5905,6 +6370,9 @@ export interface CreateTransitGatewayRouteRequest { } export namespace CreateTransitGatewayRouteRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateTransitGatewayRouteRequest): any => ({ ...obj, }); @@ -5933,6 +6401,9 @@ export interface TransitGatewayRouteAttachment { } export namespace TransitGatewayRouteAttachment { + /** + * @internal + */ export const filterSensitiveLog = (obj: TransitGatewayRouteAttachment): any => ({ ...obj, }); @@ -5971,6 +6442,9 @@ export interface TransitGatewayRoute { } export namespace TransitGatewayRoute { + /** + * @internal + */ export const filterSensitiveLog = (obj: TransitGatewayRoute): any => ({ ...obj, }); @@ -5984,6 +6458,9 @@ export interface CreateTransitGatewayRouteResult { } export namespace CreateTransitGatewayRouteResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateTransitGatewayRouteResult): any => ({ ...obj, }); @@ -6009,6 +6486,9 @@ export interface CreateTransitGatewayRouteTableRequest { } export namespace CreateTransitGatewayRouteTableRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateTransitGatewayRouteTableRequest): any => ({ ...obj, }); @@ -6057,6 +6537,9 @@ export interface TransitGatewayRouteTable { } export namespace TransitGatewayRouteTable { + /** + * @internal + */ export const filterSensitiveLog = (obj: TransitGatewayRouteTable): any => ({ ...obj, }); @@ -6070,6 +6553,9 @@ export interface CreateTransitGatewayRouteTableResult { } export namespace CreateTransitGatewayRouteTableResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateTransitGatewayRouteTableResult): any => ({ ...obj, }); @@ -6096,6 +6582,9 @@ export interface CreateTransitGatewayVpcAttachmentRequestOptions { } export namespace CreateTransitGatewayVpcAttachmentRequestOptions { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateTransitGatewayVpcAttachmentRequestOptions): any => ({ ...obj, }); @@ -6138,6 +6627,9 @@ export interface CreateTransitGatewayVpcAttachmentRequest { } export namespace CreateTransitGatewayVpcAttachmentRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateTransitGatewayVpcAttachmentRequest): any => ({ ...obj, }); @@ -6151,6 +6643,9 @@ export interface CreateTransitGatewayVpcAttachmentResult { } export namespace CreateTransitGatewayVpcAttachmentResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateTransitGatewayVpcAttachmentResult): any => ({ ...obj, }); @@ -6323,6 +6818,9 @@ export interface CreateVolumeRequest { } export namespace CreateVolumeRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateVolumeRequest): any => ({ ...obj, }); @@ -6419,6 +6917,9 @@ export interface Volume { } export namespace Volume { + /** + * @internal + */ export const filterSensitiveLog = (obj: Volume): any => ({ ...obj, }); @@ -6481,6 +6982,9 @@ export interface CreateVpcRequest { } export namespace CreateVpcRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateVpcRequest): any => ({ ...obj, }); @@ -6494,6 +6998,9 @@ export interface CreateVpcResult { } export namespace CreateVpcResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateVpcResult): any => ({ ...obj, }); @@ -6588,6 +7095,9 @@ export interface CreateVpcEndpointRequest { } export namespace CreateVpcEndpointRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateVpcEndpointRequest): any => ({ ...obj, }); @@ -6609,6 +7119,9 @@ export interface DnsEntry { } export namespace DnsEntry { + /** + * @internal + */ export const filterSensitiveLog = (obj: DnsEntry): any => ({ ...obj, }); @@ -6630,6 +7143,9 @@ export interface SecurityGroupIdentifier { } export namespace SecurityGroupIdentifier { + /** + * @internal + */ export const filterSensitiveLog = (obj: SecurityGroupIdentifier): any => ({ ...obj, }); @@ -6651,6 +7167,9 @@ export interface LastError { } export namespace LastError { + /** + * @internal + */ export const filterSensitiveLog = (obj: LastError): any => ({ ...obj, }); @@ -6759,6 +7278,9 @@ export interface VpcEndpoint { } export namespace VpcEndpoint { + /** + * @internal + */ export const filterSensitiveLog = (obj: VpcEndpoint): any => ({ ...obj, }); @@ -6781,6 +7303,9 @@ export interface CreateVpcEndpointResult { } export namespace CreateVpcEndpointResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateVpcEndpointResult): any => ({ ...obj, }); @@ -6825,6 +7350,9 @@ export interface CreateVpcEndpointConnectionNotificationRequest { } export namespace CreateVpcEndpointConnectionNotificationRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateVpcEndpointConnectionNotificationRequest): any => ({ ...obj, }); @@ -6882,6 +7410,9 @@ export interface ConnectionNotification { } export namespace ConnectionNotification { + /** + * @internal + */ export const filterSensitiveLog = (obj: ConnectionNotification): any => ({ ...obj, }); @@ -6901,6 +7432,9 @@ export interface CreateVpcEndpointConnectionNotificationResult { } export namespace CreateVpcEndpointConnectionNotificationResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateVpcEndpointConnectionNotificationResult): any => ({ ...obj, }); @@ -6950,6 +7484,9 @@ export interface CreateVpcEndpointServiceConfigurationRequest { } export namespace CreateVpcEndpointServiceConfigurationRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateVpcEndpointServiceConfigurationRequest): any => ({ ...obj, }); @@ -6993,6 +7530,9 @@ export interface PrivateDnsNameConfiguration { } export namespace PrivateDnsNameConfiguration { + /** + * @internal + */ export const filterSensitiveLog = (obj: PrivateDnsNameConfiguration): any => ({ ...obj, }); @@ -7023,6 +7563,9 @@ export interface ServiceTypeDetail { } export namespace ServiceTypeDetail { + /** + * @internal + */ export const filterSensitiveLog = (obj: ServiceTypeDetail): any => ({ ...obj, }); @@ -7100,6 +7643,9 @@ export interface ServiceConfiguration { } export namespace ServiceConfiguration { + /** + * @internal + */ export const filterSensitiveLog = (obj: ServiceConfiguration): any => ({ ...obj, }); @@ -7119,6 +7665,9 @@ export interface CreateVpcEndpointServiceConfigurationResult { } export namespace CreateVpcEndpointServiceConfigurationResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateVpcEndpointServiceConfigurationResult): any => ({ ...obj, }); @@ -7164,6 +7713,9 @@ export interface CreateVpcPeeringConnectionRequest { } export namespace CreateVpcPeeringConnectionRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateVpcPeeringConnectionRequest): any => ({ ...obj, }); @@ -7177,6 +7729,9 @@ export interface CreateVpcPeeringConnectionResult { } export namespace CreateVpcPeeringConnectionResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateVpcPeeringConnectionResult): any => ({ ...obj, }); @@ -7195,6 +7750,9 @@ export interface IKEVersionsRequestListValue { } export namespace IKEVersionsRequestListValue { + /** + * @internal + */ export const filterSensitiveLog = (obj: IKEVersionsRequestListValue): any => ({ ...obj, }); @@ -7211,6 +7769,9 @@ export interface Phase1DHGroupNumbersRequestListValue { } export namespace Phase1DHGroupNumbersRequestListValue { + /** + * @internal + */ export const filterSensitiveLog = (obj: Phase1DHGroupNumbersRequestListValue): any => ({ ...obj, }); @@ -7227,6 +7788,9 @@ export interface Phase1EncryptionAlgorithmsRequestListValue { } export namespace Phase1EncryptionAlgorithmsRequestListValue { + /** + * @internal + */ export const filterSensitiveLog = (obj: Phase1EncryptionAlgorithmsRequestListValue): any => ({ ...obj, }); @@ -7243,6 +7807,9 @@ export interface Phase1IntegrityAlgorithmsRequestListValue { } export namespace Phase1IntegrityAlgorithmsRequestListValue { + /** + * @internal + */ export const filterSensitiveLog = (obj: Phase1IntegrityAlgorithmsRequestListValue): any => ({ ...obj, }); @@ -7259,6 +7826,9 @@ export interface Phase2DHGroupNumbersRequestListValue { } export namespace Phase2DHGroupNumbersRequestListValue { + /** + * @internal + */ export const filterSensitiveLog = (obj: Phase2DHGroupNumbersRequestListValue): any => ({ ...obj, }); @@ -7275,6 +7845,9 @@ export interface Phase2EncryptionAlgorithmsRequestListValue { } export namespace Phase2EncryptionAlgorithmsRequestListValue { + /** + * @internal + */ export const filterSensitiveLog = (obj: Phase2EncryptionAlgorithmsRequestListValue): any => ({ ...obj, }); @@ -7291,6 +7864,9 @@ export interface Phase2IntegrityAlgorithmsRequestListValue { } export namespace Phase2IntegrityAlgorithmsRequestListValue { + /** + * @internal + */ export const filterSensitiveLog = (obj: Phase2IntegrityAlgorithmsRequestListValue): any => ({ ...obj, }); @@ -7477,6 +8053,9 @@ export interface VpnTunnelOptionsSpecification { } export namespace VpnTunnelOptionsSpecification { + /** + * @internal + */ export const filterSensitiveLog = (obj: VpnTunnelOptionsSpecification): any => ({ ...obj, }); @@ -7544,6 +8123,9 @@ export interface VpnConnectionOptionsSpecification { } export namespace VpnConnectionOptionsSpecification { + /** + * @internal + */ export const filterSensitiveLog = (obj: VpnConnectionOptionsSpecification): any => ({ ...obj, }); @@ -7592,6 +8174,9 @@ export interface CreateVpnConnectionRequest { } export namespace CreateVpnConnectionRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateVpnConnectionRequest): any => ({ ...obj, }); @@ -7608,6 +8193,9 @@ export interface IKEVersionsListValue { } export namespace IKEVersionsListValue { + /** + * @internal + */ export const filterSensitiveLog = (obj: IKEVersionsListValue): any => ({ ...obj, }); @@ -7624,6 +8212,9 @@ export interface Phase1DHGroupNumbersListValue { } export namespace Phase1DHGroupNumbersListValue { + /** + * @internal + */ export const filterSensitiveLog = (obj: Phase1DHGroupNumbersListValue): any => ({ ...obj, }); @@ -7640,6 +8231,9 @@ export interface Phase1EncryptionAlgorithmsListValue { } export namespace Phase1EncryptionAlgorithmsListValue { + /** + * @internal + */ export const filterSensitiveLog = (obj: Phase1EncryptionAlgorithmsListValue): any => ({ ...obj, }); @@ -7656,6 +8250,9 @@ export interface Phase1IntegrityAlgorithmsListValue { } export namespace Phase1IntegrityAlgorithmsListValue { + /** + * @internal + */ export const filterSensitiveLog = (obj: Phase1IntegrityAlgorithmsListValue): any => ({ ...obj, }); @@ -7672,6 +8269,9 @@ export interface Phase2DHGroupNumbersListValue { } export namespace Phase2DHGroupNumbersListValue { + /** + * @internal + */ export const filterSensitiveLog = (obj: Phase2DHGroupNumbersListValue): any => ({ ...obj, }); @@ -7688,6 +8288,9 @@ export interface Phase2EncryptionAlgorithmsListValue { } export namespace Phase2EncryptionAlgorithmsListValue { + /** + * @internal + */ export const filterSensitiveLog = (obj: Phase2EncryptionAlgorithmsListValue): any => ({ ...obj, }); @@ -7704,6 +8307,9 @@ export interface Phase2IntegrityAlgorithmsListValue { } export namespace Phase2IntegrityAlgorithmsListValue { + /** + * @internal + */ export const filterSensitiveLog = (obj: Phase2IntegrityAlgorithmsListValue): any => ({ ...obj, }); @@ -7811,6 +8417,9 @@ export interface TunnelOption { } export namespace TunnelOption { + /** + * @internal + */ export const filterSensitiveLog = (obj: TunnelOption): any => ({ ...obj, }); @@ -7862,6 +8471,9 @@ export interface VpnConnectionOptions { } export namespace VpnConnectionOptions { + /** + * @internal + */ export const filterSensitiveLog = (obj: VpnConnectionOptions): any => ({ ...obj, }); @@ -7892,6 +8504,9 @@ export interface VpnStaticRoute { } export namespace VpnStaticRoute { + /** + * @internal + */ export const filterSensitiveLog = (obj: VpnStaticRoute): any => ({ ...obj, }); @@ -7935,6 +8550,9 @@ export interface VgwTelemetry { } export namespace VgwTelemetry { + /** + * @internal + */ export const filterSensitiveLog = (obj: VgwTelemetry): any => ({ ...obj, }); @@ -8010,6 +8628,9 @@ export interface VpnConnection { } export namespace VpnConnection { + /** + * @internal + */ export const filterSensitiveLog = (obj: VpnConnection): any => ({ ...obj, }); @@ -8026,6 +8647,9 @@ export interface CreateVpnConnectionResult { } export namespace CreateVpnConnectionResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateVpnConnectionResult): any => ({ ...obj, }); @@ -8047,6 +8671,9 @@ export interface CreateVpnConnectionRouteRequest { } export namespace CreateVpnConnectionRouteRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateVpnConnectionRouteRequest): any => ({ ...obj, }); @@ -8086,6 +8713,9 @@ export interface CreateVpnGatewayRequest { } export namespace CreateVpnGatewayRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateVpnGatewayRequest): any => ({ ...obj, }); @@ -8132,6 +8762,9 @@ export interface VpnGateway { } export namespace VpnGateway { + /** + * @internal + */ export const filterSensitiveLog = (obj: VpnGateway): any => ({ ...obj, }); @@ -8148,6 +8781,9 @@ export interface CreateVpnGatewayResult { } export namespace CreateVpnGatewayResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateVpnGatewayResult): any => ({ ...obj, }); @@ -8168,6 +8804,9 @@ export interface DeleteCarrierGatewayRequest { } export namespace DeleteCarrierGatewayRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteCarrierGatewayRequest): any => ({ ...obj, }); @@ -8181,6 +8820,9 @@ export interface DeleteCarrierGatewayResult { } export namespace DeleteCarrierGatewayResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteCarrierGatewayResult): any => ({ ...obj, }); @@ -8199,6 +8841,9 @@ export interface DeleteClientVpnEndpointRequest { } export namespace DeleteClientVpnEndpointRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteClientVpnEndpointRequest): any => ({ ...obj, }); @@ -8212,6 +8857,9 @@ export interface DeleteClientVpnEndpointResult { } export namespace DeleteClientVpnEndpointResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteClientVpnEndpointResult): any => ({ ...obj, }); @@ -8240,6 +8888,9 @@ export interface DeleteClientVpnRouteRequest { } export namespace DeleteClientVpnRouteRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteClientVpnRouteRequest): any => ({ ...obj, }); @@ -8253,6 +8904,9 @@ export interface DeleteClientVpnRouteResult { } export namespace DeleteClientVpnRouteResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteClientVpnRouteResult): any => ({ ...obj, }); @@ -8276,6 +8930,9 @@ export interface DeleteCustomerGatewayRequest { } export namespace DeleteCustomerGatewayRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteCustomerGatewayRequest): any => ({ ...obj, }); @@ -8296,6 +8953,9 @@ export interface DeleteDhcpOptionsRequest { } export namespace DeleteDhcpOptionsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteDhcpOptionsRequest): any => ({ ...obj, }); @@ -8316,6 +8976,9 @@ export interface DeleteEgressOnlyInternetGatewayRequest { } export namespace DeleteEgressOnlyInternetGatewayRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteEgressOnlyInternetGatewayRequest): any => ({ ...obj, }); @@ -8329,6 +8992,9 @@ export interface DeleteEgressOnlyInternetGatewayResult { } export namespace DeleteEgressOnlyInternetGatewayResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteEgressOnlyInternetGatewayResult): any => ({ ...obj, }); @@ -8360,6 +9026,9 @@ export interface DeleteFleetsRequest { } export namespace DeleteFleetsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteFleetsRequest): any => ({ ...obj, }); @@ -8396,6 +9065,9 @@ export interface DeleteFleetSuccessItem { } export namespace DeleteFleetSuccessItem { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteFleetSuccessItem): any => ({ ...obj, }); @@ -8424,6 +9096,9 @@ export interface DeleteFleetError { } export namespace DeleteFleetError { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteFleetError): any => ({ ...obj, }); @@ -8445,6 +9120,9 @@ export interface DeleteFleetErrorItem { } export namespace DeleteFleetErrorItem { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteFleetErrorItem): any => ({ ...obj, }); @@ -8463,6 +9141,9 @@ export interface DeleteFleetsResult { } export namespace DeleteFleetsResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteFleetsResult): any => ({ ...obj, }); @@ -8484,6 +9165,9 @@ export interface DeleteFlowLogsRequest { } export namespace DeleteFlowLogsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteFlowLogsRequest): any => ({ ...obj, }); @@ -8497,6 +9181,9 @@ export interface DeleteFlowLogsResult { } export namespace DeleteFlowLogsResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteFlowLogsResult): any => ({ ...obj, }); @@ -8517,6 +9204,9 @@ export interface DeleteFpgaImageRequest { } export namespace DeleteFpgaImageRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteFpgaImageRequest): any => ({ ...obj, }); @@ -8530,6 +9220,9 @@ export interface DeleteFpgaImageResult { } export namespace DeleteFpgaImageResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteFpgaImageResult): any => ({ ...obj, }); @@ -8550,6 +9243,9 @@ export interface DeleteInternetGatewayRequest { } export namespace DeleteInternetGatewayRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteInternetGatewayRequest): any => ({ ...obj, }); @@ -8575,6 +9271,9 @@ export interface DeleteKeyPairRequest { } export namespace DeleteKeyPairRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteKeyPairRequest): any => ({ ...obj, }); @@ -8603,6 +9302,9 @@ export interface DeleteLaunchTemplateRequest { } export namespace DeleteLaunchTemplateRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteLaunchTemplateRequest): any => ({ ...obj, }); @@ -8616,6 +9318,9 @@ export interface DeleteLaunchTemplateResult { } export namespace DeleteLaunchTemplateResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteLaunchTemplateResult): any => ({ ...obj, }); @@ -8649,6 +9354,9 @@ export interface DeleteLaunchTemplateVersionsRequest { } export namespace DeleteLaunchTemplateVersionsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteLaunchTemplateVersionsRequest): any => ({ ...obj, }); @@ -8675,6 +9383,9 @@ export interface DeleteLaunchTemplateVersionsResponseSuccessItem { } export namespace DeleteLaunchTemplateVersionsResponseSuccessItem { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteLaunchTemplateVersionsResponseSuccessItem): any => ({ ...obj, }); @@ -8706,6 +9417,9 @@ export interface ResponseError { } export namespace ResponseError { + /** + * @internal + */ export const filterSensitiveLog = (obj: ResponseError): any => ({ ...obj, }); @@ -8737,6 +9451,9 @@ export interface DeleteLaunchTemplateVersionsResponseErrorItem { } export namespace DeleteLaunchTemplateVersionsResponseErrorItem { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteLaunchTemplateVersionsResponseErrorItem): any => ({ ...obj, }); @@ -8756,6 +9473,9 @@ export interface DeleteLaunchTemplateVersionsResult { } export namespace DeleteLaunchTemplateVersionsResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteLaunchTemplateVersionsResult): any => ({ ...obj, }); @@ -8781,6 +9501,9 @@ export interface DeleteLocalGatewayRouteRequest { } export namespace DeleteLocalGatewayRouteRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteLocalGatewayRouteRequest): any => ({ ...obj, }); @@ -8794,6 +9517,9 @@ export interface DeleteLocalGatewayRouteResult { } export namespace DeleteLocalGatewayRouteResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteLocalGatewayRouteResult): any => ({ ...obj, }); diff --git a/clients/client-ec2/models/models_2.ts b/clients/client-ec2/models/models_2.ts index a5452c859c0f..524448babf38 100644 --- a/clients/client-ec2/models/models_2.ts +++ b/clients/client-ec2/models/models_2.ts @@ -85,6 +85,9 @@ export interface DeleteLocalGatewayRouteTableVpcAssociationRequest { } export namespace DeleteLocalGatewayRouteTableVpcAssociationRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteLocalGatewayRouteTableVpcAssociationRequest): any => ({ ...obj, }); @@ -98,6 +101,9 @@ export interface DeleteLocalGatewayRouteTableVpcAssociationResult { } export namespace DeleteLocalGatewayRouteTableVpcAssociationResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteLocalGatewayRouteTableVpcAssociationResult): any => ({ ...obj, }); @@ -118,6 +124,9 @@ export interface DeleteManagedPrefixListRequest { } export namespace DeleteManagedPrefixListRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteManagedPrefixListRequest): any => ({ ...obj, }); @@ -131,6 +140,9 @@ export interface DeleteManagedPrefixListResult { } export namespace DeleteManagedPrefixListResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteManagedPrefixListResult): any => ({ ...obj, }); @@ -151,6 +163,9 @@ export interface DeleteNatGatewayRequest { } export namespace DeleteNatGatewayRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteNatGatewayRequest): any => ({ ...obj, }); @@ -164,6 +179,9 @@ export interface DeleteNatGatewayResult { } export namespace DeleteNatGatewayResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteNatGatewayResult): any => ({ ...obj, }); @@ -184,6 +202,9 @@ export interface DeleteNetworkAclRequest { } export namespace DeleteNetworkAclRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteNetworkAclRequest): any => ({ ...obj, }); @@ -214,6 +235,9 @@ export interface DeleteNetworkAclEntryRequest { } export namespace DeleteNetworkAclEntryRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteNetworkAclEntryRequest): any => ({ ...obj, }); @@ -234,6 +258,9 @@ export interface DeleteNetworkInsightsAnalysisRequest { } export namespace DeleteNetworkInsightsAnalysisRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteNetworkInsightsAnalysisRequest): any => ({ ...obj, }); @@ -247,6 +274,9 @@ export interface DeleteNetworkInsightsAnalysisResult { } export namespace DeleteNetworkInsightsAnalysisResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteNetworkInsightsAnalysisResult): any => ({ ...obj, }); @@ -267,6 +297,9 @@ export interface DeleteNetworkInsightsPathRequest { } export namespace DeleteNetworkInsightsPathRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteNetworkInsightsPathRequest): any => ({ ...obj, }); @@ -280,6 +313,9 @@ export interface DeleteNetworkInsightsPathResult { } export namespace DeleteNetworkInsightsPathResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteNetworkInsightsPathResult): any => ({ ...obj, }); @@ -303,6 +339,9 @@ export interface DeleteNetworkInterfaceRequest { } export namespace DeleteNetworkInterfaceRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteNetworkInterfaceRequest): any => ({ ...obj, }); @@ -332,6 +371,9 @@ export interface DeleteNetworkInterfacePermissionRequest { } export namespace DeleteNetworkInterfacePermissionRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteNetworkInterfacePermissionRequest): any => ({ ...obj, }); @@ -348,6 +390,9 @@ export interface DeleteNetworkInterfacePermissionResult { } export namespace DeleteNetworkInterfacePermissionResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteNetworkInterfacePermissionResult): any => ({ ...obj, }); @@ -368,6 +413,9 @@ export interface DeletePlacementGroupRequest { } export namespace DeletePlacementGroupRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeletePlacementGroupRequest): any => ({ ...obj, }); @@ -388,6 +436,9 @@ export interface DeleteQueuedReservedInstancesRequest { } export namespace DeleteQueuedReservedInstancesRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteQueuedReservedInstancesRequest): any => ({ ...obj, }); @@ -415,6 +466,9 @@ export interface DeleteQueuedReservedInstancesError { } export namespace DeleteQueuedReservedInstancesError { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteQueuedReservedInstancesError): any => ({ ...obj, }); @@ -436,6 +490,9 @@ export interface FailedQueuedPurchaseDeletion { } export namespace FailedQueuedPurchaseDeletion { + /** + * @internal + */ export const filterSensitiveLog = (obj: FailedQueuedPurchaseDeletion): any => ({ ...obj, }); @@ -452,6 +509,9 @@ export interface SuccessfulQueuedPurchaseDeletion { } export namespace SuccessfulQueuedPurchaseDeletion { + /** + * @internal + */ export const filterSensitiveLog = (obj: SuccessfulQueuedPurchaseDeletion): any => ({ ...obj, }); @@ -470,6 +530,9 @@ export interface DeleteQueuedReservedInstancesResult { } export namespace DeleteQueuedReservedInstancesResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteQueuedReservedInstancesResult): any => ({ ...obj, }); @@ -505,6 +568,9 @@ export interface DeleteRouteRequest { } export namespace DeleteRouteRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteRouteRequest): any => ({ ...obj, }); @@ -525,6 +591,9 @@ export interface DeleteRouteTableRequest { } export namespace DeleteRouteTableRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteRouteTableRequest): any => ({ ...obj, }); @@ -550,6 +619,9 @@ export interface DeleteSecurityGroupRequest { } export namespace DeleteSecurityGroupRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteSecurityGroupRequest): any => ({ ...obj, }); @@ -570,6 +642,9 @@ export interface DeleteSnapshotRequest { } export namespace DeleteSnapshotRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteSnapshotRequest): any => ({ ...obj, }); @@ -588,6 +663,9 @@ export interface DeleteSpotDatafeedSubscriptionRequest { } export namespace DeleteSpotDatafeedSubscriptionRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteSpotDatafeedSubscriptionRequest): any => ({ ...obj, }); @@ -608,6 +686,9 @@ export interface DeleteSubnetRequest { } export namespace DeleteSubnetRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteSubnetRequest): any => ({ ...obj, }); @@ -640,6 +721,9 @@ export interface DeleteTagsRequest { } export namespace DeleteTagsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteTagsRequest): any => ({ ...obj, }); @@ -660,6 +744,9 @@ export interface DeleteTrafficMirrorFilterRequest { } export namespace DeleteTrafficMirrorFilterRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteTrafficMirrorFilterRequest): any => ({ ...obj, }); @@ -673,6 +760,9 @@ export interface DeleteTrafficMirrorFilterResult { } export namespace DeleteTrafficMirrorFilterResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteTrafficMirrorFilterResult): any => ({ ...obj, }); @@ -693,6 +783,9 @@ export interface DeleteTrafficMirrorFilterRuleRequest { } export namespace DeleteTrafficMirrorFilterRuleRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteTrafficMirrorFilterRuleRequest): any => ({ ...obj, }); @@ -706,6 +799,9 @@ export interface DeleteTrafficMirrorFilterRuleResult { } export namespace DeleteTrafficMirrorFilterRuleResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteTrafficMirrorFilterRuleResult): any => ({ ...obj, }); @@ -726,6 +822,9 @@ export interface DeleteTrafficMirrorSessionRequest { } export namespace DeleteTrafficMirrorSessionRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteTrafficMirrorSessionRequest): any => ({ ...obj, }); @@ -739,6 +838,9 @@ export interface DeleteTrafficMirrorSessionResult { } export namespace DeleteTrafficMirrorSessionResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteTrafficMirrorSessionResult): any => ({ ...obj, }); @@ -759,6 +861,9 @@ export interface DeleteTrafficMirrorTargetRequest { } export namespace DeleteTrafficMirrorTargetRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteTrafficMirrorTargetRequest): any => ({ ...obj, }); @@ -772,6 +877,9 @@ export interface DeleteTrafficMirrorTargetResult { } export namespace DeleteTrafficMirrorTargetResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteTrafficMirrorTargetResult): any => ({ ...obj, }); @@ -792,6 +900,9 @@ export interface DeleteTransitGatewayRequest { } export namespace DeleteTransitGatewayRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteTransitGatewayRequest): any => ({ ...obj, }); @@ -805,6 +916,9 @@ export interface DeleteTransitGatewayResult { } export namespace DeleteTransitGatewayResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteTransitGatewayResult): any => ({ ...obj, }); @@ -825,6 +939,9 @@ export interface DeleteTransitGatewayConnectRequest { } export namespace DeleteTransitGatewayConnectRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteTransitGatewayConnectRequest): any => ({ ...obj, }); @@ -838,6 +955,9 @@ export interface DeleteTransitGatewayConnectResult { } export namespace DeleteTransitGatewayConnectResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteTransitGatewayConnectResult): any => ({ ...obj, }); @@ -858,6 +978,9 @@ export interface DeleteTransitGatewayConnectPeerRequest { } export namespace DeleteTransitGatewayConnectPeerRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteTransitGatewayConnectPeerRequest): any => ({ ...obj, }); @@ -871,6 +994,9 @@ export interface DeleteTransitGatewayConnectPeerResult { } export namespace DeleteTransitGatewayConnectPeerResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteTransitGatewayConnectPeerResult): any => ({ ...obj, }); @@ -891,6 +1017,9 @@ export interface DeleteTransitGatewayMulticastDomainRequest { } export namespace DeleteTransitGatewayMulticastDomainRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteTransitGatewayMulticastDomainRequest): any => ({ ...obj, }); @@ -904,6 +1033,9 @@ export interface DeleteTransitGatewayMulticastDomainResult { } export namespace DeleteTransitGatewayMulticastDomainResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteTransitGatewayMulticastDomainResult): any => ({ ...obj, }); @@ -924,6 +1056,9 @@ export interface DeleteTransitGatewayPeeringAttachmentRequest { } export namespace DeleteTransitGatewayPeeringAttachmentRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteTransitGatewayPeeringAttachmentRequest): any => ({ ...obj, }); @@ -937,6 +1072,9 @@ export interface DeleteTransitGatewayPeeringAttachmentResult { } export namespace DeleteTransitGatewayPeeringAttachmentResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteTransitGatewayPeeringAttachmentResult): any => ({ ...obj, }); @@ -962,6 +1100,9 @@ export interface DeleteTransitGatewayPrefixListReferenceRequest { } export namespace DeleteTransitGatewayPrefixListReferenceRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteTransitGatewayPrefixListReferenceRequest): any => ({ ...obj, }); @@ -975,6 +1116,9 @@ export interface DeleteTransitGatewayPrefixListReferenceResult { } export namespace DeleteTransitGatewayPrefixListReferenceResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteTransitGatewayPrefixListReferenceResult): any => ({ ...obj, }); @@ -1000,6 +1144,9 @@ export interface DeleteTransitGatewayRouteRequest { } export namespace DeleteTransitGatewayRouteRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteTransitGatewayRouteRequest): any => ({ ...obj, }); @@ -1013,6 +1160,9 @@ export interface DeleteTransitGatewayRouteResult { } export namespace DeleteTransitGatewayRouteResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteTransitGatewayRouteResult): any => ({ ...obj, }); @@ -1033,6 +1183,9 @@ export interface DeleteTransitGatewayRouteTableRequest { } export namespace DeleteTransitGatewayRouteTableRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteTransitGatewayRouteTableRequest): any => ({ ...obj, }); @@ -1046,6 +1199,9 @@ export interface DeleteTransitGatewayRouteTableResult { } export namespace DeleteTransitGatewayRouteTableResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteTransitGatewayRouteTableResult): any => ({ ...obj, }); @@ -1066,6 +1222,9 @@ export interface DeleteTransitGatewayVpcAttachmentRequest { } export namespace DeleteTransitGatewayVpcAttachmentRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteTransitGatewayVpcAttachmentRequest): any => ({ ...obj, }); @@ -1079,6 +1238,9 @@ export interface DeleteTransitGatewayVpcAttachmentResult { } export namespace DeleteTransitGatewayVpcAttachmentResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteTransitGatewayVpcAttachmentResult): any => ({ ...obj, }); @@ -1099,6 +1261,9 @@ export interface DeleteVolumeRequest { } export namespace DeleteVolumeRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteVolumeRequest): any => ({ ...obj, }); @@ -1119,6 +1284,9 @@ export interface DeleteVpcRequest { } export namespace DeleteVpcRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteVpcRequest): any => ({ ...obj, }); @@ -1139,6 +1307,9 @@ export interface DeleteVpcEndpointConnectionNotificationsRequest { } export namespace DeleteVpcEndpointConnectionNotificationsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteVpcEndpointConnectionNotificationsRequest): any => ({ ...obj, }); @@ -1153,6 +1324,9 @@ export interface DeleteVpcEndpointConnectionNotificationsResult { } export namespace DeleteVpcEndpointConnectionNotificationsResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteVpcEndpointConnectionNotificationsResult): any => ({ ...obj, }); @@ -1176,6 +1350,9 @@ export interface DeleteVpcEndpointsRequest { } export namespace DeleteVpcEndpointsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteVpcEndpointsRequest): any => ({ ...obj, }); @@ -1192,6 +1369,9 @@ export interface DeleteVpcEndpointsResult { } export namespace DeleteVpcEndpointsResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteVpcEndpointsResult): any => ({ ...obj, }); @@ -1212,6 +1392,9 @@ export interface DeleteVpcEndpointServiceConfigurationsRequest { } export namespace DeleteVpcEndpointServiceConfigurationsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteVpcEndpointServiceConfigurationsRequest): any => ({ ...obj, }); @@ -1226,6 +1409,9 @@ export interface DeleteVpcEndpointServiceConfigurationsResult { } export namespace DeleteVpcEndpointServiceConfigurationsResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteVpcEndpointServiceConfigurationsResult): any => ({ ...obj, }); @@ -1246,6 +1432,9 @@ export interface DeleteVpcPeeringConnectionRequest { } export namespace DeleteVpcPeeringConnectionRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteVpcPeeringConnectionRequest): any => ({ ...obj, }); @@ -1259,6 +1448,9 @@ export interface DeleteVpcPeeringConnectionResult { } export namespace DeleteVpcPeeringConnectionResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteVpcPeeringConnectionResult): any => ({ ...obj, }); @@ -1282,6 +1474,9 @@ export interface DeleteVpnConnectionRequest { } export namespace DeleteVpnConnectionRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteVpnConnectionRequest): any => ({ ...obj, }); @@ -1303,6 +1498,9 @@ export interface DeleteVpnConnectionRouteRequest { } export namespace DeleteVpnConnectionRouteRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteVpnConnectionRouteRequest): any => ({ ...obj, }); @@ -1326,6 +1524,9 @@ export interface DeleteVpnGatewayRequest { } export namespace DeleteVpnGatewayRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteVpnGatewayRequest): any => ({ ...obj, }); @@ -1347,6 +1548,9 @@ export interface DeprovisionByoipCidrRequest { } export namespace DeprovisionByoipCidrRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeprovisionByoipCidrRequest): any => ({ ...obj, }); @@ -1360,6 +1564,9 @@ export interface DeprovisionByoipCidrResult { } export namespace DeprovisionByoipCidrResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeprovisionByoipCidrResult): any => ({ ...obj, }); @@ -1383,6 +1590,9 @@ export interface DeregisterImageRequest { } export namespace DeregisterImageRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeregisterImageRequest): any => ({ ...obj, }); @@ -1407,6 +1617,9 @@ export interface DeregisterInstanceTagAttributeRequest { } export namespace DeregisterInstanceTagAttributeRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeregisterInstanceTagAttributeRequest): any => ({ ...obj, }); @@ -1427,6 +1640,9 @@ export interface DeregisterInstanceEventNotificationAttributesRequest { } export namespace DeregisterInstanceEventNotificationAttributesRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeregisterInstanceEventNotificationAttributesRequest): any => ({ ...obj, }); @@ -1449,6 +1665,9 @@ export interface InstanceTagNotificationAttribute { } export namespace InstanceTagNotificationAttribute { + /** + * @internal + */ export const filterSensitiveLog = (obj: InstanceTagNotificationAttribute): any => ({ ...obj, }); @@ -1462,6 +1681,9 @@ export interface DeregisterInstanceEventNotificationAttributesResult { } export namespace DeregisterInstanceEventNotificationAttributesResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeregisterInstanceEventNotificationAttributesResult): any => ({ ...obj, }); @@ -1492,6 +1714,9 @@ export interface DeregisterTransitGatewayMulticastGroupMembersRequest { } export namespace DeregisterTransitGatewayMulticastGroupMembersRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeregisterTransitGatewayMulticastGroupMembersRequest): any => ({ ...obj, }); @@ -1518,6 +1743,9 @@ export interface TransitGatewayMulticastDeregisteredGroupMembers { } export namespace TransitGatewayMulticastDeregisteredGroupMembers { + /** + * @internal + */ export const filterSensitiveLog = (obj: TransitGatewayMulticastDeregisteredGroupMembers): any => ({ ...obj, }); @@ -1531,6 +1759,9 @@ export interface DeregisterTransitGatewayMulticastGroupMembersResult { } export namespace DeregisterTransitGatewayMulticastGroupMembersResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeregisterTransitGatewayMulticastGroupMembersResult): any => ({ ...obj, }); @@ -1561,6 +1792,9 @@ export interface DeregisterTransitGatewayMulticastGroupSourcesRequest { } export namespace DeregisterTransitGatewayMulticastGroupSourcesRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeregisterTransitGatewayMulticastGroupSourcesRequest): any => ({ ...obj, }); @@ -1587,6 +1821,9 @@ export interface TransitGatewayMulticastDeregisteredGroupSources { } export namespace TransitGatewayMulticastDeregisteredGroupSources { + /** + * @internal + */ export const filterSensitiveLog = (obj: TransitGatewayMulticastDeregisteredGroupSources): any => ({ ...obj, }); @@ -1600,6 +1837,9 @@ export interface DeregisterTransitGatewayMulticastGroupSourcesResult { } export namespace DeregisterTransitGatewayMulticastGroupSourcesResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeregisterTransitGatewayMulticastGroupSourcesResult): any => ({ ...obj, }); @@ -1620,6 +1860,9 @@ export interface DescribeAccountAttributesRequest { } export namespace DescribeAccountAttributesRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeAccountAttributesRequest): any => ({ ...obj, }); @@ -1633,6 +1876,9 @@ export interface DescribeAccountAttributesResult { } export namespace DescribeAccountAttributesResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeAccountAttributesResult): any => ({ ...obj, }); @@ -1655,6 +1901,9 @@ export interface Filter { } export namespace Filter { + /** + * @internal + */ export const filterSensitiveLog = (obj: Filter): any => ({ ...obj, }); @@ -1735,6 +1984,9 @@ export interface DescribeAddressesRequest { } export namespace DescribeAddressesRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeAddressesRequest): any => ({ ...obj, }); @@ -1748,6 +2000,9 @@ export interface DescribeAddressesResult { } export namespace DescribeAddressesResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeAddressesResult): any => ({ ...obj, }); @@ -1783,6 +2038,9 @@ export interface DescribeAddressesAttributeRequest { } export namespace DescribeAddressesAttributeRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeAddressesAttributeRequest): any => ({ ...obj, }); @@ -1801,6 +2059,9 @@ export interface DescribeAddressesAttributeResult { } export namespace DescribeAddressesAttributeResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeAddressesAttributeResult): any => ({ ...obj, }); @@ -1816,6 +2077,9 @@ export interface DescribeAggregateIdFormatRequest { } export namespace DescribeAggregateIdFormatRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeAggregateIdFormatRequest): any => ({ ...obj, }); @@ -1842,6 +2106,9 @@ export interface IdFormat { } export namespace IdFormat { + /** + * @internal + */ export const filterSensitiveLog = (obj: IdFormat): any => ({ ...obj, }); @@ -1862,6 +2129,9 @@ export interface DescribeAggregateIdFormatResult { } export namespace DescribeAggregateIdFormatResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeAggregateIdFormatResult): any => ({ ...obj, }); @@ -1958,6 +2228,9 @@ export interface DescribeAvailabilityZonesRequest { } export namespace DescribeAvailabilityZonesRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeAvailabilityZonesRequest): any => ({ ...obj, }); @@ -1974,6 +2247,9 @@ export interface AvailabilityZoneMessage { } export namespace AvailabilityZoneMessage { + /** + * @internal + */ export const filterSensitiveLog = (obj: AvailabilityZoneMessage): any => ({ ...obj, }); @@ -2054,6 +2330,9 @@ export interface AvailabilityZone { } export namespace AvailabilityZone { + /** + * @internal + */ export const filterSensitiveLog = (obj: AvailabilityZone): any => ({ ...obj, }); @@ -2067,6 +2346,9 @@ export interface DescribeAvailabilityZonesResult { } export namespace DescribeAvailabilityZonesResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeAvailabilityZonesResult): any => ({ ...obj, }); @@ -2136,6 +2418,9 @@ export interface DescribeBundleTasksRequest { } export namespace DescribeBundleTasksRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeBundleTasksRequest): any => ({ ...obj, }); @@ -2149,6 +2434,9 @@ export interface DescribeBundleTasksResult { } export namespace DescribeBundleTasksResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeBundleTasksResult): any => ({ ...obj, }); @@ -2175,6 +2463,9 @@ export interface DescribeByoipCidrsRequest { } export namespace DescribeByoipCidrsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeByoipCidrsRequest): any => ({ ...obj, }); @@ -2193,6 +2484,9 @@ export interface DescribeByoipCidrsResult { } export namespace DescribeByoipCidrsResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeByoipCidrsResult): any => ({ ...obj, }); @@ -2334,6 +2628,9 @@ export interface DescribeCapacityReservationsRequest { } export namespace DescribeCapacityReservationsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeCapacityReservationsRequest): any => ({ ...obj, }); @@ -2352,6 +2649,9 @@ export interface DescribeCapacityReservationsResult { } export namespace DescribeCapacityReservationsResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeCapacityReservationsResult): any => ({ ...obj, }); @@ -2416,6 +2716,9 @@ export interface DescribeCarrierGatewaysRequest { } export namespace DescribeCarrierGatewaysRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeCarrierGatewaysRequest): any => ({ ...obj, }); @@ -2434,6 +2737,9 @@ export interface DescribeCarrierGatewaysResult { } export namespace DescribeCarrierGatewaysResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeCarrierGatewaysResult): any => ({ ...obj, }); @@ -2500,6 +2806,9 @@ export interface DescribeClassicLinkInstancesRequest { } export namespace DescribeClassicLinkInstancesRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeClassicLinkInstancesRequest): any => ({ ...obj, }); @@ -2531,6 +2840,9 @@ export interface ClassicLinkInstance { } export namespace ClassicLinkInstance { + /** + * @internal + */ export const filterSensitiveLog = (obj: ClassicLinkInstance): any => ({ ...obj, }); @@ -2549,6 +2861,9 @@ export interface DescribeClassicLinkInstancesResult { } export namespace DescribeClassicLinkInstancesResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeClassicLinkInstancesResult): any => ({ ...obj, }); @@ -2597,6 +2912,9 @@ export interface DescribeClientVpnAuthorizationRulesRequest { } export namespace DescribeClientVpnAuthorizationRulesRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeClientVpnAuthorizationRulesRequest): any => ({ ...obj, }); @@ -2638,6 +2956,9 @@ export interface AuthorizationRule { } export namespace AuthorizationRule { + /** + * @internal + */ export const filterSensitiveLog = (obj: AuthorizationRule): any => ({ ...obj, }); @@ -2656,6 +2977,9 @@ export interface DescribeClientVpnAuthorizationRulesResult { } export namespace DescribeClientVpnAuthorizationRulesResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeClientVpnAuthorizationRulesResult): any => ({ ...obj, }); @@ -2700,6 +3024,9 @@ export interface DescribeClientVpnConnectionsRequest { } export namespace DescribeClientVpnConnectionsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeClientVpnConnectionsRequest): any => ({ ...obj, }); @@ -2723,6 +3050,9 @@ export interface ClientVpnConnectionStatus { } export namespace ClientVpnConnectionStatus { + /** + * @internal + */ export const filterSensitiveLog = (obj: ClientVpnConnectionStatus): any => ({ ...obj, }); @@ -2806,6 +3136,9 @@ export interface ClientVpnConnection { } export namespace ClientVpnConnection { + /** + * @internal + */ export const filterSensitiveLog = (obj: ClientVpnConnection): any => ({ ...obj, }); @@ -2824,6 +3157,9 @@ export interface DescribeClientVpnConnectionsResult { } export namespace DescribeClientVpnConnectionsResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeClientVpnConnectionsResult): any => ({ ...obj, }); @@ -2868,6 +3204,9 @@ export interface DescribeClientVpnEndpointsRequest { } export namespace DescribeClientVpnEndpointsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeClientVpnEndpointsRequest): any => ({ ...obj, }); @@ -2891,6 +3230,9 @@ export interface AssociatedTargetNetwork { } export namespace AssociatedTargetNetwork { + /** + * @internal + */ export const filterSensitiveLog = (obj: AssociatedTargetNetwork): any => ({ ...obj, }); @@ -2907,6 +3249,9 @@ export interface DirectoryServiceAuthentication { } export namespace DirectoryServiceAuthentication { + /** + * @internal + */ export const filterSensitiveLog = (obj: DirectoryServiceAuthentication): any => ({ ...obj, }); @@ -2928,6 +3273,9 @@ export interface FederatedAuthentication { } export namespace FederatedAuthentication { + /** + * @internal + */ export const filterSensitiveLog = (obj: FederatedAuthentication): any => ({ ...obj, }); @@ -2944,6 +3292,9 @@ export interface CertificateAuthentication { } export namespace CertificateAuthentication { + /** + * @internal + */ export const filterSensitiveLog = (obj: CertificateAuthentication): any => ({ ...obj, }); @@ -2976,6 +3327,9 @@ export interface ClientVpnAuthentication { } export namespace ClientVpnAuthentication { + /** + * @internal + */ export const filterSensitiveLog = (obj: ClientVpnAuthentication): any => ({ ...obj, }); @@ -2999,6 +3353,9 @@ export interface ClientVpnEndpointAttributeStatus { } export namespace ClientVpnEndpointAttributeStatus { + /** + * @internal + */ export const filterSensitiveLog = (obj: ClientVpnEndpointAttributeStatus): any => ({ ...obj, }); @@ -3025,6 +3382,9 @@ export interface ClientConnectResponseOptions { } export namespace ClientConnectResponseOptions { + /** + * @internal + */ export const filterSensitiveLog = (obj: ClientConnectResponseOptions): any => ({ ...obj, }); @@ -3051,6 +3411,9 @@ export interface ConnectionLogResponseOptions { } export namespace ConnectionLogResponseOptions { + /** + * @internal + */ export const filterSensitiveLog = (obj: ConnectionLogResponseOptions): any => ({ ...obj, }); @@ -3173,6 +3536,9 @@ export interface ClientVpnEndpoint { } export namespace ClientVpnEndpoint { + /** + * @internal + */ export const filterSensitiveLog = (obj: ClientVpnEndpoint): any => ({ ...obj, }); @@ -3191,6 +3557,9 @@ export interface DescribeClientVpnEndpointsResult { } export namespace DescribeClientVpnEndpointsResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeClientVpnEndpointsResult): any => ({ ...obj, }); @@ -3238,6 +3607,9 @@ export interface DescribeClientVpnRoutesRequest { } export namespace DescribeClientVpnRoutesRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeClientVpnRoutesRequest): any => ({ ...obj, }); @@ -3287,6 +3659,9 @@ export interface ClientVpnRoute { } export namespace ClientVpnRoute { + /** + * @internal + */ export const filterSensitiveLog = (obj: ClientVpnRoute): any => ({ ...obj, }); @@ -3305,6 +3680,9 @@ export interface DescribeClientVpnRoutesResult { } export namespace DescribeClientVpnRoutesResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeClientVpnRoutesResult): any => ({ ...obj, }); @@ -3357,6 +3735,9 @@ export interface DescribeClientVpnTargetNetworksRequest { } export namespace DescribeClientVpnTargetNetworksRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeClientVpnTargetNetworksRequest): any => ({ ...obj, }); @@ -3398,6 +3779,9 @@ export interface TargetNetwork { } export namespace TargetNetwork { + /** + * @internal + */ export const filterSensitiveLog = (obj: TargetNetwork): any => ({ ...obj, }); @@ -3416,6 +3800,9 @@ export interface DescribeClientVpnTargetNetworksResult { } export namespace DescribeClientVpnTargetNetworksResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeClientVpnTargetNetworksResult): any => ({ ...obj, }); @@ -3466,6 +3853,9 @@ export interface DescribeCoipPoolsRequest { } export namespace DescribeCoipPoolsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeCoipPoolsRequest): any => ({ ...obj, }); @@ -3502,6 +3892,9 @@ export interface CoipPool { } export namespace CoipPool { + /** + * @internal + */ export const filterSensitiveLog = (obj: CoipPool): any => ({ ...obj, }); @@ -3520,6 +3913,9 @@ export interface DescribeCoipPoolsResult { } export namespace DescribeCoipPoolsResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeCoipPoolsResult): any => ({ ...obj, }); @@ -3540,6 +3936,9 @@ export interface DescribeConversionTasksRequest { } export namespace DescribeConversionTasksRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeConversionTasksRequest): any => ({ ...obj, }); @@ -3574,6 +3973,9 @@ export interface DiskImageDescription { } export namespace DiskImageDescription { + /** + * @internal + */ export const filterSensitiveLog = (obj: DiskImageDescription): any => ({ ...obj, }); @@ -3595,6 +3997,9 @@ export interface DiskImageVolumeDescription { } export namespace DiskImageVolumeDescription { + /** + * @internal + */ export const filterSensitiveLog = (obj: DiskImageVolumeDescription): any => ({ ...obj, }); @@ -3641,6 +4046,9 @@ export interface ImportInstanceVolumeDetailItem { } export namespace ImportInstanceVolumeDetailItem { + /** + * @internal + */ export const filterSensitiveLog = (obj: ImportInstanceVolumeDetailItem): any => ({ ...obj, }); @@ -3672,6 +4080,9 @@ export interface ImportInstanceTaskDetails { } export namespace ImportInstanceTaskDetails { + /** + * @internal + */ export const filterSensitiveLog = (obj: ImportInstanceTaskDetails): any => ({ ...obj, }); @@ -3708,6 +4119,9 @@ export interface ImportVolumeTaskDetails { } export namespace ImportVolumeTaskDetails { + /** + * @internal + */ export const filterSensitiveLog = (obj: ImportVolumeTaskDetails): any => ({ ...obj, }); @@ -3757,6 +4171,9 @@ export interface ConversionTask { } export namespace ConversionTask { + /** + * @internal + */ export const filterSensitiveLog = (obj: ConversionTask): any => ({ ...obj, }); @@ -3770,6 +4187,9 @@ export interface DescribeConversionTasksResult { } export namespace DescribeConversionTasksResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeConversionTasksResult): any => ({ ...obj, }); @@ -3830,6 +4250,9 @@ export interface DescribeCustomerGatewaysRequest { } export namespace DescribeCustomerGatewaysRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeCustomerGatewaysRequest): any => ({ ...obj, }); @@ -3846,6 +4269,9 @@ export interface DescribeCustomerGatewaysResult { } export namespace DescribeCustomerGatewaysResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeCustomerGatewaysResult): any => ({ ...obj, }); @@ -3910,6 +4336,9 @@ export interface DescribeDhcpOptionsRequest { } export namespace DescribeDhcpOptionsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeDhcpOptionsRequest): any => ({ ...obj, }); @@ -3928,6 +4357,9 @@ export interface DescribeDhcpOptionsResult { } export namespace DescribeDhcpOptionsResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeDhcpOptionsResult): any => ({ ...obj, }); @@ -3975,6 +4407,9 @@ export interface DescribeEgressOnlyInternetGatewaysRequest { } export namespace DescribeEgressOnlyInternetGatewaysRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeEgressOnlyInternetGatewaysRequest): any => ({ ...obj, }); @@ -3993,6 +4428,9 @@ export interface DescribeEgressOnlyInternetGatewaysResult { } export namespace DescribeEgressOnlyInternetGatewaysResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeEgressOnlyInternetGatewaysResult): any => ({ ...obj, }); @@ -4057,6 +4495,9 @@ export interface DescribeElasticGpusRequest { } export namespace DescribeElasticGpusRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeElasticGpusRequest): any => ({ ...obj, }); @@ -4078,6 +4519,9 @@ export interface ElasticGpuHealth { } export namespace ElasticGpuHealth { + /** + * @internal + */ export const filterSensitiveLog = (obj: ElasticGpuHealth): any => ({ ...obj, }); @@ -4128,6 +4572,9 @@ export interface ElasticGpus { } export namespace ElasticGpus { + /** + * @internal + */ export const filterSensitiveLog = (obj: ElasticGpus): any => ({ ...obj, }); @@ -4154,6 +4601,9 @@ export interface DescribeElasticGpusResult { } export namespace DescribeElasticGpusResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeElasticGpusResult): any => ({ ...obj, }); @@ -4190,6 +4640,9 @@ export interface DescribeExportImageTasksRequest { } export namespace DescribeExportImageTasksRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeExportImageTasksRequest): any => ({ ...obj, }); @@ -4211,6 +4664,9 @@ export interface ExportTaskS3Location { } export namespace ExportTaskS3Location { + /** + * @internal + */ export const filterSensitiveLog = (obj: ExportTaskS3Location): any => ({ ...obj, }); @@ -4263,6 +4719,9 @@ export interface ExportImageTask { } export namespace ExportImageTask { + /** + * @internal + */ export const filterSensitiveLog = (obj: ExportImageTask): any => ({ ...obj, }); @@ -4282,6 +4741,9 @@ export interface DescribeExportImageTasksResult { } export namespace DescribeExportImageTasksResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeExportImageTasksResult): any => ({ ...obj, }); @@ -4300,6 +4762,9 @@ export interface DescribeExportTasksRequest { } export namespace DescribeExportTasksRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeExportTasksRequest): any => ({ ...obj, }); @@ -4313,6 +4778,9 @@ export interface DescribeExportTasksResult { } export namespace DescribeExportTasksResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeExportTasksResult): any => ({ ...obj, }); @@ -4367,6 +4835,9 @@ export interface DescribeFastSnapshotRestoresRequest { } export namespace DescribeFastSnapshotRestoresRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeFastSnapshotRestoresRequest): any => ({ ...obj, }); @@ -4447,6 +4918,9 @@ export interface DescribeFastSnapshotRestoreSuccessItem { } export namespace DescribeFastSnapshotRestoreSuccessItem { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeFastSnapshotRestoreSuccessItem): any => ({ ...obj, }); @@ -4465,6 +4939,9 @@ export interface DescribeFastSnapshotRestoresResult { } export namespace DescribeFastSnapshotRestoresResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeFastSnapshotRestoresResult): any => ({ ...obj, }); @@ -4514,6 +4991,9 @@ export interface DescribeFleetHistoryRequest { } export namespace DescribeFleetHistoryRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeFleetHistoryRequest): any => ({ ...obj, }); @@ -4642,6 +5122,9 @@ export interface EventInformation { } export namespace EventInformation { + /** + * @internal + */ export const filterSensitiveLog = (obj: EventInformation): any => ({ ...obj, }); @@ -4669,6 +5152,9 @@ export interface HistoryRecordEntry { } export namespace HistoryRecordEntry { + /** + * @internal + */ export const filterSensitiveLog = (obj: HistoryRecordEntry): any => ({ ...obj, }); @@ -4707,6 +5193,9 @@ export interface DescribeFleetHistoryResult { } export namespace DescribeFleetHistoryResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeFleetHistoryResult): any => ({ ...obj, }); @@ -4750,6 +5239,9 @@ export interface DescribeFleetInstancesRequest { } export namespace DescribeFleetInstancesRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeFleetInstancesRequest): any => ({ ...obj, }); @@ -4774,6 +5266,9 @@ export interface DescribeFleetInstancesResult { } export namespace DescribeFleetInstancesResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeFleetInstancesResult): any => ({ ...obj, }); @@ -4842,6 +5337,9 @@ export interface DescribeFleetsRequest { } export namespace DescribeFleetsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeFleetsRequest): any => ({ ...obj, }); @@ -4883,6 +5381,9 @@ export interface DescribeFleetError { } export namespace DescribeFleetError { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeFleetError): any => ({ ...obj, }); @@ -4921,6 +5422,9 @@ export interface DescribeFleetsInstances { } export namespace DescribeFleetsInstances { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeFleetsInstances): any => ({ ...obj, }); @@ -4943,6 +5447,9 @@ export interface FleetLaunchTemplateConfig { } export namespace FleetLaunchTemplateConfig { + /** + * @internal + */ export const filterSensitiveLog = (obj: FleetLaunchTemplateConfig): any => ({ ...obj, }); @@ -4977,6 +5484,9 @@ export interface CapacityReservationOptions { } export namespace CapacityReservationOptions { + /** + * @internal + */ export const filterSensitiveLog = (obj: CapacityReservationOptions): any => ({ ...obj, }); @@ -5026,6 +5536,9 @@ export interface OnDemandOptions { } export namespace OnDemandOptions { + /** + * @internal + */ export const filterSensitiveLog = (obj: OnDemandOptions): any => ({ ...obj, }); @@ -5049,6 +5562,9 @@ export interface FleetSpotCapacityRebalance { } export namespace FleetSpotCapacityRebalance { + /** + * @internal + */ export const filterSensitiveLog = (obj: FleetSpotCapacityRebalance): any => ({ ...obj, }); @@ -5067,6 +5583,9 @@ export interface FleetSpotMaintenanceStrategies { } export namespace FleetSpotMaintenanceStrategies { + /** + * @internal + */ export const filterSensitiveLog = (obj: FleetSpotMaintenanceStrategies): any => ({ ...obj, }); @@ -5141,6 +5660,9 @@ export interface SpotOptions { } export namespace SpotOptions { + /** + * @internal + */ export const filterSensitiveLog = (obj: SpotOptions): any => ({ ...obj, }); @@ -5185,6 +5707,9 @@ export interface TargetCapacitySpecification { } export namespace TargetCapacitySpecification { + /** + * @internal + */ export const filterSensitiveLog = (obj: TargetCapacitySpecification): any => ({ ...obj, }); @@ -5324,6 +5849,9 @@ export interface FleetData { } export namespace FleetData { + /** + * @internal + */ export const filterSensitiveLog = (obj: FleetData): any => ({ ...obj, }); @@ -5342,6 +5870,9 @@ export interface DescribeFleetsResult { } export namespace DescribeFleetsResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeFleetsResult): any => ({ ...obj, }); @@ -5418,6 +5949,9 @@ export interface DescribeFlowLogsRequest { } export namespace DescribeFlowLogsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeFlowLogsRequest): any => ({ ...obj, }); @@ -5514,6 +6048,9 @@ export interface FlowLog { } export namespace FlowLog { + /** + * @internal + */ export const filterSensitiveLog = (obj: FlowLog): any => ({ ...obj, }); @@ -5532,6 +6069,9 @@ export interface DescribeFlowLogsResult { } export namespace DescribeFlowLogsResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeFlowLogsResult): any => ({ ...obj, }); @@ -5559,6 +6099,9 @@ export interface DescribeFpgaImageAttributeRequest { } export namespace DescribeFpgaImageAttributeRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeFpgaImageAttributeRequest): any => ({ ...obj, }); @@ -5582,6 +6125,9 @@ export interface LoadPermission { } export namespace LoadPermission { + /** + * @internal + */ export const filterSensitiveLog = (obj: LoadPermission): any => ({ ...obj, }); @@ -5605,6 +6151,9 @@ export interface ProductCode { } export namespace ProductCode { + /** + * @internal + */ export const filterSensitiveLog = (obj: ProductCode): any => ({ ...obj, }); @@ -5641,6 +6190,9 @@ export interface FpgaImageAttribute { } export namespace FpgaImageAttribute { + /** + * @internal + */ export const filterSensitiveLog = (obj: FpgaImageAttribute): any => ({ ...obj, }); @@ -5654,6 +6206,9 @@ export interface DescribeFpgaImageAttributeResult { } export namespace DescribeFpgaImageAttributeResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeFpgaImageAttributeResult): any => ({ ...obj, }); @@ -5741,6 +6296,9 @@ export interface DescribeFpgaImagesRequest { } export namespace DescribeFpgaImagesRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeFpgaImagesRequest): any => ({ ...obj, }); @@ -5772,6 +6330,9 @@ export interface PciId { } export namespace PciId { + /** + * @internal + */ export const filterSensitiveLog = (obj: PciId): any => ({ ...obj, }); @@ -5813,6 +6374,9 @@ export interface FpgaImageState { } export namespace FpgaImageState { + /** + * @internal + */ export const filterSensitiveLog = (obj: FpgaImageState): any => ({ ...obj, }); @@ -5899,6 +6463,9 @@ export interface FpgaImage { } export namespace FpgaImage { + /** + * @internal + */ export const filterSensitiveLog = (obj: FpgaImage): any => ({ ...obj, }); @@ -5917,6 +6484,9 @@ export interface DescribeFpgaImagesResult { } export namespace DescribeFpgaImagesResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeFpgaImagesResult): any => ({ ...obj, }); @@ -5973,6 +6543,9 @@ export interface DescribeHostReservationOfferingsRequest { } export namespace DescribeHostReservationOfferingsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeHostReservationOfferingsRequest): any => ({ ...obj, }); @@ -6026,6 +6599,9 @@ export interface HostOffering { } export namespace HostOffering { + /** + * @internal + */ export const filterSensitiveLog = (obj: HostOffering): any => ({ ...obj, }); @@ -6044,6 +6620,9 @@ export interface DescribeHostReservationOfferingsResult { } export namespace DescribeHostReservationOfferingsResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeHostReservationOfferingsResult): any => ({ ...obj, }); @@ -6099,6 +6678,9 @@ export interface DescribeHostReservationsRequest { } export namespace DescribeHostReservationsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeHostReservationsRequest): any => ({ ...obj, }); @@ -6194,6 +6776,9 @@ export interface HostReservation { } export namespace HostReservation { + /** + * @internal + */ export const filterSensitiveLog = (obj: HostReservation): any => ({ ...obj, }); @@ -6212,6 +6797,9 @@ export interface DescribeHostReservationsResult { } export namespace DescribeHostReservationsResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeHostReservationsResult): any => ({ ...obj, }); @@ -6280,6 +6868,9 @@ export interface DescribeHostsRequest { } export namespace DescribeHostsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeHostsRequest): any => ({ ...obj, }); @@ -6309,6 +6900,9 @@ export interface InstanceCapacity { } export namespace InstanceCapacity { + /** + * @internal + */ export const filterSensitiveLog = (obj: InstanceCapacity): any => ({ ...obj, }); @@ -6333,6 +6927,9 @@ export interface AvailableCapacity { } export namespace AvailableCapacity { + /** + * @internal + */ export const filterSensitiveLog = (obj: AvailableCapacity): any => ({ ...obj, }); @@ -6371,6 +6968,9 @@ export interface HostProperties { } export namespace HostProperties { + /** + * @internal + */ export const filterSensitiveLog = (obj: HostProperties): any => ({ ...obj, }); @@ -6397,6 +6997,9 @@ export interface HostInstance { } export namespace HostInstance { + /** + * @internal + */ export const filterSensitiveLog = (obj: HostInstance): any => ({ ...obj, }); @@ -6499,6 +7102,9 @@ export interface Host { } export namespace Host { + /** + * @internal + */ export const filterSensitiveLog = (obj: Host): any => ({ ...obj, }); @@ -6517,6 +7123,9 @@ export interface DescribeHostsResult { } export namespace DescribeHostsResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeHostsResult): any => ({ ...obj, }); @@ -6557,6 +7166,9 @@ export interface DescribeIamInstanceProfileAssociationsRequest { } export namespace DescribeIamInstanceProfileAssociationsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeIamInstanceProfileAssociationsRequest): any => ({ ...obj, }); @@ -6575,6 +7187,9 @@ export interface DescribeIamInstanceProfileAssociationsResult { } export namespace DescribeIamInstanceProfileAssociationsResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeIamInstanceProfileAssociationsResult): any => ({ ...obj, }); @@ -6606,6 +7221,9 @@ export interface DescribeIdentityIdFormatRequest { } export namespace DescribeIdentityIdFormatRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeIdentityIdFormatRequest): any => ({ ...obj, }); @@ -6619,6 +7237,9 @@ export interface DescribeIdentityIdFormatResult { } export namespace DescribeIdentityIdFormatResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeIdentityIdFormatResult): any => ({ ...obj, }); @@ -6645,6 +7266,9 @@ export interface DescribeIdFormatRequest { } export namespace DescribeIdFormatRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeIdFormatRequest): any => ({ ...obj, }); @@ -6658,6 +7282,9 @@ export interface DescribeIdFormatResult { } export namespace DescribeIdFormatResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeIdFormatResult): any => ({ ...obj, }); @@ -6700,6 +7327,9 @@ export interface DescribeImageAttributeRequest { } export namespace DescribeImageAttributeRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeImageAttributeRequest): any => ({ ...obj, }); @@ -6722,6 +7352,9 @@ export interface LaunchPermission { } export namespace LaunchPermission { + /** + * @internal + */ export const filterSensitiveLog = (obj: LaunchPermission): any => ({ ...obj, }); @@ -6778,6 +7411,9 @@ export interface ImageAttribute { } export namespace ImageAttribute { + /** + * @internal + */ export const filterSensitiveLog = (obj: ImageAttribute): any => ({ ...obj, }); @@ -6966,6 +7602,9 @@ export interface DescribeImagesRequest { } export namespace DescribeImagesRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeImagesRequest): any => ({ ...obj, }); @@ -7066,6 +7705,9 @@ export interface StateReason { } export namespace StateReason { + /** + * @internal + */ export const filterSensitiveLog = (obj: StateReason): any => ({ ...obj, }); @@ -7223,6 +7865,9 @@ export interface Image { } export namespace Image { + /** + * @internal + */ export const filterSensitiveLog = (obj: Image): any => ({ ...obj, }); @@ -7236,6 +7881,9 @@ export interface DescribeImagesResult { } export namespace DescribeImagesResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeImagesResult): any => ({ ...obj, }); @@ -7272,6 +7920,9 @@ export interface DescribeImportImageTasksRequest { } export namespace DescribeImportImageTasksRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeImportImageTasksRequest): any => ({ ...obj, }); @@ -7288,6 +7939,9 @@ export interface ImportImageLicenseConfigurationResponse { } export namespace ImportImageLicenseConfigurationResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ImportImageLicenseConfigurationResponse): any => ({ ...obj, }); @@ -7309,6 +7963,9 @@ export interface UserBucketDetails { } export namespace UserBucketDetails { + /** + * @internal + */ export const filterSensitiveLog = (obj: UserBucketDetails): any => ({ ...obj, }); @@ -7370,6 +8027,9 @@ export interface SnapshotDetail { } export namespace SnapshotDetail { + /** + * @internal + */ export const filterSensitiveLog = (obj: SnapshotDetail): any => ({ ...obj, }); @@ -7461,6 +8121,9 @@ export interface ImportImageTask { } export namespace ImportImageTask { + /** + * @internal + */ export const filterSensitiveLog = (obj: ImportImageTask): any => ({ ...obj, }); @@ -7481,6 +8144,9 @@ export interface DescribeImportImageTasksResult { } export namespace DescribeImportImageTasksResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeImportImageTasksResult): any => ({ ...obj, }); @@ -7517,6 +8183,9 @@ export interface DescribeImportSnapshotTasksRequest { } export namespace DescribeImportSnapshotTasksRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeImportSnapshotTasksRequest): any => ({ ...obj, }); @@ -7584,6 +8253,9 @@ export interface SnapshotTaskDetail { } export namespace SnapshotTaskDetail { + /** + * @internal + */ export const filterSensitiveLog = (obj: SnapshotTaskDetail): any => ({ ...obj, }); @@ -7615,6 +8287,9 @@ export interface ImportSnapshotTask { } export namespace ImportSnapshotTask { + /** + * @internal + */ export const filterSensitiveLog = (obj: ImportSnapshotTask): any => ({ ...obj, }); @@ -7635,6 +8310,9 @@ export interface DescribeImportSnapshotTasksResult { } export namespace DescribeImportSnapshotTasksResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeImportSnapshotTasksResult): any => ({ ...obj, }); @@ -7678,6 +8356,9 @@ export interface DescribeInstanceAttributeRequest { } export namespace DescribeInstanceAttributeRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeInstanceAttributeRequest): any => ({ ...obj, }); @@ -7709,6 +8390,9 @@ export interface EbsInstanceBlockDevice { } export namespace EbsInstanceBlockDevice { + /** + * @internal + */ export const filterSensitiveLog = (obj: EbsInstanceBlockDevice): any => ({ ...obj, }); @@ -7731,6 +8415,9 @@ export interface InstanceBlockDeviceMapping { } export namespace InstanceBlockDeviceMapping { + /** + * @internal + */ export const filterSensitiveLog = (obj: InstanceBlockDeviceMapping): any => ({ ...obj, }); @@ -7747,6 +8434,9 @@ export interface AttributeBooleanValue { } export namespace AttributeBooleanValue { + /** + * @internal + */ export const filterSensitiveLog = (obj: AttributeBooleanValue): any => ({ ...obj, }); @@ -7764,6 +8454,9 @@ export interface EnclaveOptions { } export namespace EnclaveOptions { + /** + * @internal + */ export const filterSensitiveLog = (obj: EnclaveOptions): any => ({ ...obj, }); @@ -7865,6 +8558,9 @@ export interface InstanceAttribute { } export namespace InstanceAttribute { + /** + * @internal + */ export const filterSensitiveLog = (obj: InstanceAttribute): any => ({ ...obj, }); @@ -7911,6 +8607,9 @@ export interface DescribeInstanceCreditSpecificationsRequest { } export namespace DescribeInstanceCreditSpecificationsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeInstanceCreditSpecificationsRequest): any => ({ ...obj, }); @@ -7933,6 +8632,9 @@ export interface InstanceCreditSpecification { } export namespace InstanceCreditSpecification { + /** + * @internal + */ export const filterSensitiveLog = (obj: InstanceCreditSpecification): any => ({ ...obj, }); @@ -7952,6 +8654,9 @@ export interface DescribeInstanceCreditSpecificationsResult { } export namespace DescribeInstanceCreditSpecificationsResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeInstanceCreditSpecificationsResult): any => ({ ...obj, }); @@ -7967,6 +8672,9 @@ export interface DescribeInstanceEventNotificationAttributesRequest { } export namespace DescribeInstanceEventNotificationAttributesRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeInstanceEventNotificationAttributesRequest): any => ({ ...obj, }); @@ -7980,6 +8688,9 @@ export interface DescribeInstanceEventNotificationAttributesResult { } export namespace DescribeInstanceEventNotificationAttributesResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeInstanceEventNotificationAttributesResult): any => ({ ...obj, }); @@ -8474,6 +9185,9 @@ export interface DescribeInstancesRequest { } export namespace DescribeInstancesRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeInstancesRequest): any => ({ ...obj, }); @@ -8512,6 +9226,9 @@ export interface CapacityReservationSpecificationResponse { } export namespace CapacityReservationSpecificationResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: CapacityReservationSpecificationResponse): any => ({ ...obj, }); @@ -8533,6 +9250,9 @@ export interface CpuOptions { } export namespace CpuOptions { + /** + * @internal + */ export const filterSensitiveLog = (obj: CpuOptions): any => ({ ...obj, }); @@ -8565,6 +9285,9 @@ export interface ElasticGpuAssociation { } export namespace ElasticGpuAssociation { + /** + * @internal + */ export const filterSensitiveLog = (obj: ElasticGpuAssociation): any => ({ ...obj, }); @@ -8606,6 +9329,9 @@ export interface ElasticInferenceAcceleratorAssociation { } export namespace ElasticInferenceAcceleratorAssociation { + /** + * @internal + */ export const filterSensitiveLog = (obj: ElasticInferenceAcceleratorAssociation): any => ({ ...obj, }); @@ -8627,6 +9353,9 @@ export interface HibernationOptions { } export namespace HibernationOptions { + /** + * @internal + */ export const filterSensitiveLog = (obj: HibernationOptions): any => ({ ...obj, }); @@ -8645,6 +9374,9 @@ export interface LicenseConfiguration { } export namespace LicenseConfiguration { + /** + * @internal + */ export const filterSensitiveLog = (obj: LicenseConfiguration): any => ({ ...obj, }); @@ -8709,6 +9441,9 @@ export interface InstanceMetadataOptionsResponse { } export namespace InstanceMetadataOptionsResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: InstanceMetadataOptionsResponse): any => ({ ...obj, }); @@ -8728,6 +9463,9 @@ export interface Monitoring { } export namespace Monitoring { + /** + * @internal + */ export const filterSensitiveLog = (obj: Monitoring): any => ({ ...obj, }); @@ -8759,6 +9497,9 @@ export interface InstanceNetworkInterfaceAssociation { } export namespace InstanceNetworkInterfaceAssociation { + /** + * @internal + */ export const filterSensitiveLog = (obj: InstanceNetworkInterfaceAssociation): any => ({ ...obj, }); @@ -8800,6 +9541,9 @@ export interface InstanceNetworkInterfaceAttachment { } export namespace InstanceNetworkInterfaceAttachment { + /** + * @internal + */ export const filterSensitiveLog = (obj: InstanceNetworkInterfaceAttachment): any => ({ ...obj, }); @@ -8831,6 +9575,9 @@ export interface InstancePrivateIpAddress { } export namespace InstancePrivateIpAddress { + /** + * @internal + */ export const filterSensitiveLog = (obj: InstancePrivateIpAddress): any => ({ ...obj, }); @@ -8925,6 +9672,9 @@ export interface InstanceNetworkInterface { } export namespace InstanceNetworkInterface { + /** + * @internal + */ export const filterSensitiveLog = (obj: InstanceNetworkInterface): any => ({ ...obj, }); @@ -8989,6 +9739,9 @@ export interface InstanceState { } export namespace InstanceState { + /** + * @internal + */ export const filterSensitiveLog = (obj: InstanceState): any => ({ ...obj, }); @@ -9267,6 +10020,9 @@ export interface Instance { } export namespace Instance { + /** + * @internal + */ export const filterSensitiveLog = (obj: Instance): any => ({ ...obj, }); @@ -9306,6 +10062,9 @@ export interface Reservation { } export namespace Reservation { + /** + * @internal + */ export const filterSensitiveLog = (obj: Reservation): any => ({ ...obj, }); @@ -9325,6 +10084,9 @@ export interface DescribeInstancesResult { } export namespace DescribeInstancesResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeInstancesResult): any => ({ ...obj, }); @@ -9449,6 +10211,9 @@ export interface DescribeInstanceStatusRequest { } export namespace DescribeInstanceStatusRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeInstanceStatusRequest): any => ({ ...obj, }); @@ -9500,6 +10265,9 @@ export interface InstanceStatusEvent { } export namespace InstanceStatusEvent { + /** + * @internal + */ export const filterSensitiveLog = (obj: InstanceStatusEvent): any => ({ ...obj, }); @@ -9531,6 +10299,9 @@ export interface InstanceStatusDetails { } export namespace InstanceStatusDetails { + /** + * @internal + */ export const filterSensitiveLog = (obj: InstanceStatusDetails): any => ({ ...obj, }); @@ -9554,6 +10325,9 @@ export interface InstanceStatusSummary { } export namespace InstanceStatusSummary { + /** + * @internal + */ export const filterSensitiveLog = (obj: InstanceStatusSummary): any => ({ ...obj, }); @@ -9603,6 +10377,9 @@ export interface InstanceStatus { } export namespace InstanceStatus { + /** + * @internal + */ export const filterSensitiveLog = (obj: InstanceStatus): any => ({ ...obj, }); @@ -9622,6 +10399,9 @@ export interface DescribeInstanceStatusResult { } export namespace DescribeInstanceStatusResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeInstanceStatusResult): any => ({ ...obj, }); @@ -9672,6 +10452,9 @@ export interface DescribeInstanceTypeOfferingsRequest { } export namespace DescribeInstanceTypeOfferingsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeInstanceTypeOfferingsRequest): any => ({ ...obj, }); diff --git a/clients/client-ec2/models/models_3.ts b/clients/client-ec2/models/models_3.ts index 35db31ef9392..bbeda0126607 100644 --- a/clients/client-ec2/models/models_3.ts +++ b/clients/client-ec2/models/models_3.ts @@ -106,6 +106,9 @@ export interface InstanceTypeOffering { } export namespace InstanceTypeOffering { + /** + * @internal + */ export const filterSensitiveLog = (obj: InstanceTypeOffering): any => ({ ...obj, }); @@ -125,6 +128,9 @@ export interface DescribeInstanceTypeOfferingsResult { } export namespace DescribeInstanceTypeOfferingsResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeInstanceTypeOfferingsResult): any => ({ ...obj, }); @@ -374,6 +380,9 @@ export interface DescribeInstanceTypesRequest { } export namespace DescribeInstanceTypesRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeInstanceTypesRequest): any => ({ ...obj, }); @@ -415,6 +424,9 @@ export interface EbsOptimizedInfo { } export namespace EbsOptimizedInfo { + /** + * @internal + */ export const filterSensitiveLog = (obj: EbsOptimizedInfo): any => ({ ...obj, }); @@ -457,6 +469,9 @@ export interface EbsInfo { } export namespace EbsInfo { + /** + * @internal + */ export const filterSensitiveLog = (obj: EbsInfo): any => ({ ...obj, }); @@ -473,6 +488,9 @@ export interface FpgaDeviceMemoryInfo { } export namespace FpgaDeviceMemoryInfo { + /** + * @internal + */ export const filterSensitiveLog = (obj: FpgaDeviceMemoryInfo): any => ({ ...obj, }); @@ -504,6 +522,9 @@ export interface FpgaDeviceInfo { } export namespace FpgaDeviceInfo { + /** + * @internal + */ export const filterSensitiveLog = (obj: FpgaDeviceInfo): any => ({ ...obj, }); @@ -525,6 +546,9 @@ export interface FpgaInfo { } export namespace FpgaInfo { + /** + * @internal + */ export const filterSensitiveLog = (obj: FpgaInfo): any => ({ ...obj, }); @@ -541,6 +565,9 @@ export interface GpuDeviceMemoryInfo { } export namespace GpuDeviceMemoryInfo { + /** + * @internal + */ export const filterSensitiveLog = (obj: GpuDeviceMemoryInfo): any => ({ ...obj, }); @@ -572,6 +599,9 @@ export interface GpuDeviceInfo { } export namespace GpuDeviceInfo { + /** + * @internal + */ export const filterSensitiveLog = (obj: GpuDeviceInfo): any => ({ ...obj, }); @@ -593,6 +623,9 @@ export interface GpuInfo { } export namespace GpuInfo { + /** + * @internal + */ export const filterSensitiveLog = (obj: GpuInfo): any => ({ ...obj, }); @@ -624,6 +657,9 @@ export interface InferenceDeviceInfo { } export namespace InferenceDeviceInfo { + /** + * @internal + */ export const filterSensitiveLog = (obj: InferenceDeviceInfo): any => ({ ...obj, }); @@ -640,6 +676,9 @@ export interface InferenceAcceleratorInfo { } export namespace InferenceAcceleratorInfo { + /** + * @internal + */ export const filterSensitiveLog = (obj: InferenceAcceleratorInfo): any => ({ ...obj, }); @@ -668,6 +707,9 @@ export interface DiskInfo { } export namespace DiskInfo { + /** + * @internal + */ export const filterSensitiveLog = (obj: DiskInfo): any => ({ ...obj, }); @@ -700,6 +742,9 @@ export interface InstanceStorageInfo { } export namespace InstanceStorageInfo { + /** + * @internal + */ export const filterSensitiveLog = (obj: InstanceStorageInfo): any => ({ ...obj, }); @@ -716,6 +761,9 @@ export interface MemoryInfo { } export namespace MemoryInfo { + /** + * @internal + */ export const filterSensitiveLog = (obj: MemoryInfo): any => ({ ...obj, }); @@ -732,6 +780,9 @@ export interface EfaInfo { } export namespace EfaInfo { + /** + * @internal + */ export const filterSensitiveLog = (obj: EfaInfo): any => ({ ...obj, }); @@ -760,6 +811,9 @@ export interface NetworkCardInfo { } export namespace NetworkCardInfo { + /** + * @internal + */ export const filterSensitiveLog = (obj: NetworkCardInfo): any => ({ ...obj, }); @@ -826,6 +880,9 @@ export interface NetworkInfo { } export namespace NetworkInfo { + /** + * @internal + */ export const filterSensitiveLog = (obj: NetworkInfo): any => ({ ...obj, }); @@ -844,6 +901,9 @@ export interface PlacementGroupInfo { } export namespace PlacementGroupInfo { + /** + * @internal + */ export const filterSensitiveLog = (obj: PlacementGroupInfo): any => ({ ...obj, }); @@ -867,6 +927,9 @@ export interface ProcessorInfo { } export namespace ProcessorInfo { + /** + * @internal + */ export const filterSensitiveLog = (obj: ProcessorInfo): any => ({ ...obj, }); @@ -909,6 +972,9 @@ export interface VCpuInfo { } export namespace VCpuInfo { + /** + * @internal + */ export const filterSensitiveLog = (obj: VCpuInfo): any => ({ ...obj, }); @@ -1041,6 +1107,9 @@ export interface InstanceTypeInfo { } export namespace InstanceTypeInfo { + /** + * @internal + */ export const filterSensitiveLog = (obj: InstanceTypeInfo): any => ({ ...obj, }); @@ -1060,6 +1129,9 @@ export interface DescribeInstanceTypesResult { } export namespace DescribeInstanceTypesResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeInstanceTypesResult): any => ({ ...obj, }); @@ -1125,6 +1197,9 @@ export interface DescribeInternetGatewaysRequest { } export namespace DescribeInternetGatewaysRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeInternetGatewaysRequest): any => ({ ...obj, }); @@ -1143,6 +1218,9 @@ export interface DescribeInternetGatewaysResult { } export namespace DescribeInternetGatewaysResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeInternetGatewaysResult): any => ({ ...obj, }); @@ -1190,6 +1268,9 @@ export interface DescribeIpv6PoolsRequest { } export namespace DescribeIpv6PoolsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeIpv6PoolsRequest): any => ({ ...obj, }); @@ -1206,6 +1287,9 @@ export interface PoolCidrBlock { } export namespace PoolCidrBlock { + /** + * @internal + */ export const filterSensitiveLog = (obj: PoolCidrBlock): any => ({ ...obj, }); @@ -1237,6 +1321,9 @@ export interface Ipv6Pool { } export namespace Ipv6Pool { + /** + * @internal + */ export const filterSensitiveLog = (obj: Ipv6Pool): any => ({ ...obj, }); @@ -1255,6 +1342,9 @@ export interface DescribeIpv6PoolsResult { } export namespace DescribeIpv6PoolsResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeIpv6PoolsResult): any => ({ ...obj, }); @@ -1309,6 +1399,9 @@ export interface DescribeKeyPairsRequest { } export namespace DescribeKeyPairsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeKeyPairsRequest): any => ({ ...obj, }); @@ -1341,6 +1434,9 @@ export interface KeyPairInfo { } export namespace KeyPairInfo { + /** + * @internal + */ export const filterSensitiveLog = (obj: KeyPairInfo): any => ({ ...obj, }); @@ -1354,6 +1450,9 @@ export interface DescribeKeyPairsResult { } export namespace DescribeKeyPairsResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeKeyPairsResult): any => ({ ...obj, }); @@ -1416,6 +1515,9 @@ export interface DescribeLaunchTemplatesRequest { } export namespace DescribeLaunchTemplatesRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeLaunchTemplatesRequest): any => ({ ...obj, }); @@ -1435,6 +1537,9 @@ export interface DescribeLaunchTemplatesResult { } export namespace DescribeLaunchTemplatesResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeLaunchTemplatesResult): any => ({ ...obj, }); @@ -1542,6 +1647,9 @@ export interface DescribeLaunchTemplateVersionsRequest { } export namespace DescribeLaunchTemplateVersionsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeLaunchTemplateVersionsRequest): any => ({ ...obj, }); @@ -1561,6 +1669,9 @@ export interface DescribeLaunchTemplateVersionsResult { } export namespace DescribeLaunchTemplateVersionsResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeLaunchTemplateVersionsResult): any => ({ ...obj, }); @@ -1615,6 +1726,9 @@ export interface DescribeLocalGatewayRouteTablesRequest { } export namespace DescribeLocalGatewayRouteTablesRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeLocalGatewayRouteTablesRequest): any => ({ ...obj, }); @@ -1661,6 +1775,9 @@ export interface LocalGatewayRouteTable { } export namespace LocalGatewayRouteTable { + /** + * @internal + */ export const filterSensitiveLog = (obj: LocalGatewayRouteTable): any => ({ ...obj, }); @@ -1679,6 +1796,9 @@ export interface DescribeLocalGatewayRouteTablesResult { } export namespace DescribeLocalGatewayRouteTablesResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeLocalGatewayRouteTablesResult): any => ({ ...obj, }); @@ -1737,6 +1857,9 @@ export interface DescribeLocalGatewayRouteTableVirtualInterfaceGroupAssociations } export namespace DescribeLocalGatewayRouteTableVirtualInterfaceGroupAssociationsRequest { + /** + * @internal + */ export const filterSensitiveLog = ( obj: DescribeLocalGatewayRouteTableVirtualInterfaceGroupAssociationsRequest ): any => ({ @@ -1790,6 +1913,9 @@ export interface LocalGatewayRouteTableVirtualInterfaceGroupAssociation { } export namespace LocalGatewayRouteTableVirtualInterfaceGroupAssociation { + /** + * @internal + */ export const filterSensitiveLog = (obj: LocalGatewayRouteTableVirtualInterfaceGroupAssociation): any => ({ ...obj, }); @@ -1808,6 +1934,9 @@ export interface DescribeLocalGatewayRouteTableVirtualInterfaceGroupAssociations } export namespace DescribeLocalGatewayRouteTableVirtualInterfaceGroupAssociationsResult { + /** + * @internal + */ export const filterSensitiveLog = ( obj: DescribeLocalGatewayRouteTableVirtualInterfaceGroupAssociationsResult ): any => ({ @@ -1868,6 +1997,9 @@ export interface DescribeLocalGatewayRouteTableVpcAssociationsRequest { } export namespace DescribeLocalGatewayRouteTableVpcAssociationsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeLocalGatewayRouteTableVpcAssociationsRequest): any => ({ ...obj, }); @@ -1886,6 +2018,9 @@ export interface DescribeLocalGatewayRouteTableVpcAssociationsResult { } export namespace DescribeLocalGatewayRouteTableVpcAssociationsResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeLocalGatewayRouteTableVpcAssociationsResult): any => ({ ...obj, }); @@ -1948,6 +2083,9 @@ export interface DescribeLocalGatewaysRequest { } export namespace DescribeLocalGatewaysRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeLocalGatewaysRequest): any => ({ ...obj, }); @@ -1984,6 +2122,9 @@ export interface LocalGateway { } export namespace LocalGateway { + /** + * @internal + */ export const filterSensitiveLog = (obj: LocalGateway): any => ({ ...obj, }); @@ -2002,6 +2143,9 @@ export interface DescribeLocalGatewaysResult { } export namespace DescribeLocalGatewaysResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeLocalGatewaysResult): any => ({ ...obj, }); @@ -2052,6 +2196,9 @@ export interface DescribeLocalGatewayVirtualInterfaceGroupsRequest { } export namespace DescribeLocalGatewayVirtualInterfaceGroupsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeLocalGatewayVirtualInterfaceGroupsRequest): any => ({ ...obj, }); @@ -2088,6 +2235,9 @@ export interface LocalGatewayVirtualInterfaceGroup { } export namespace LocalGatewayVirtualInterfaceGroup { + /** + * @internal + */ export const filterSensitiveLog = (obj: LocalGatewayVirtualInterfaceGroup): any => ({ ...obj, }); @@ -2106,6 +2256,9 @@ export interface DescribeLocalGatewayVirtualInterfaceGroupsResult { } export namespace DescribeLocalGatewayVirtualInterfaceGroupsResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeLocalGatewayVirtualInterfaceGroupsResult): any => ({ ...obj, }); @@ -2142,6 +2295,9 @@ export interface DescribeLocalGatewayVirtualInterfacesRequest { } export namespace DescribeLocalGatewayVirtualInterfacesRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeLocalGatewayVirtualInterfacesRequest): any => ({ ...obj, }); @@ -2198,6 +2354,9 @@ export interface LocalGatewayVirtualInterface { } export namespace LocalGatewayVirtualInterface { + /** + * @internal + */ export const filterSensitiveLog = (obj: LocalGatewayVirtualInterface): any => ({ ...obj, }); @@ -2216,6 +2375,9 @@ export interface DescribeLocalGatewayVirtualInterfacesResult { } export namespace DescribeLocalGatewayVirtualInterfacesResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeLocalGatewayVirtualInterfacesResult): any => ({ ...obj, }); @@ -2266,6 +2428,9 @@ export interface DescribeManagedPrefixListsRequest { } export namespace DescribeManagedPrefixListsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeManagedPrefixListsRequest): any => ({ ...obj, }); @@ -2284,6 +2449,9 @@ export interface DescribeManagedPrefixListsResult { } export namespace DescribeManagedPrefixListsResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeManagedPrefixListsResult): any => ({ ...obj, }); @@ -2330,6 +2498,9 @@ export interface DescribeMovingAddressesRequest { } export namespace DescribeMovingAddressesRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeMovingAddressesRequest): any => ({ ...obj, }); @@ -2353,6 +2524,9 @@ export interface MovingAddressStatus { } export namespace MovingAddressStatus { + /** + * @internal + */ export const filterSensitiveLog = (obj: MovingAddressStatus): any => ({ ...obj, }); @@ -2371,6 +2545,9 @@ export interface DescribeMovingAddressesResult { } export namespace DescribeMovingAddressesResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeMovingAddressesResult): any => ({ ...obj, }); @@ -2435,6 +2612,9 @@ export interface DescribeNatGatewaysRequest { } export namespace DescribeNatGatewaysRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeNatGatewaysRequest): any => ({ ...obj, }); @@ -2453,6 +2633,9 @@ export interface DescribeNatGatewaysResult { } export namespace DescribeNatGatewaysResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeNatGatewaysResult): any => ({ ...obj, }); @@ -2566,6 +2749,9 @@ export interface DescribeNetworkAclsRequest { } export namespace DescribeNetworkAclsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeNetworkAclsRequest): any => ({ ...obj, }); @@ -2584,6 +2770,9 @@ export interface DescribeNetworkAclsResult { } export namespace DescribeNetworkAclsResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeNetworkAclsResult): any => ({ ...obj, }); @@ -2643,6 +2832,9 @@ export interface DescribeNetworkInsightsAnalysesRequest { } export namespace DescribeNetworkInsightsAnalysesRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeNetworkInsightsAnalysesRequest): any => ({ ...obj, }); @@ -2664,6 +2856,9 @@ export interface AnalysisComponent { } export namespace AnalysisComponent { + /** + * @internal + */ export const filterSensitiveLog = (obj: AnalysisComponent): any => ({ ...obj, }); @@ -2705,6 +2900,9 @@ export interface AnalysisAclRule { } export namespace AnalysisAclRule { + /** + * @internal + */ export const filterSensitiveLog = (obj: AnalysisAclRule): any => ({ ...obj, }); @@ -2726,6 +2924,9 @@ export interface AnalysisLoadBalancerListener { } export namespace AnalysisLoadBalancerListener { + /** + * @internal + */ export const filterSensitiveLog = (obj: AnalysisLoadBalancerListener): any => ({ ...obj, }); @@ -2757,6 +2958,9 @@ export interface AnalysisLoadBalancerTarget { } export namespace AnalysisLoadBalancerTarget { + /** + * @internal + */ export const filterSensitiveLog = (obj: AnalysisLoadBalancerTarget): any => ({ ...obj, }); @@ -2832,6 +3036,9 @@ export interface AnalysisRouteTableRoute { } export namespace AnalysisRouteTableRoute { + /** + * @internal + */ export const filterSensitiveLog = (obj: AnalysisRouteTableRoute): any => ({ ...obj, }); @@ -2881,6 +3088,9 @@ export interface AnalysisSecurityGroupRule { } export namespace AnalysisSecurityGroupRule { + /** + * @internal + */ export const filterSensitiveLog = (obj: AnalysisSecurityGroupRule): any => ({ ...obj, }); @@ -3125,6 +3335,9 @@ export interface Explanation { } export namespace Explanation { + /** + * @internal + */ export const filterSensitiveLog = (obj: Explanation): any => ({ ...obj, }); @@ -3162,6 +3375,9 @@ export interface AnalysisPacketHeader { } export namespace AnalysisPacketHeader { + /** + * @internal + */ export const filterSensitiveLog = (obj: AnalysisPacketHeader): any => ({ ...obj, }); @@ -3228,6 +3444,9 @@ export interface PathComponent { } export namespace PathComponent { + /** + * @internal + */ export const filterSensitiveLog = (obj: PathComponent): any => ({ ...obj, }); @@ -3306,6 +3525,9 @@ export interface NetworkInsightsAnalysis { } export namespace NetworkInsightsAnalysis { + /** + * @internal + */ export const filterSensitiveLog = (obj: NetworkInsightsAnalysis): any => ({ ...obj, }); @@ -3324,6 +3546,9 @@ export interface DescribeNetworkInsightsAnalysesResult { } export namespace DescribeNetworkInsightsAnalysesResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeNetworkInsightsAnalysesResult): any => ({ ...obj, }); @@ -3377,6 +3602,9 @@ export interface DescribeNetworkInsightsPathsRequest { } export namespace DescribeNetworkInsightsPathsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeNetworkInsightsPathsRequest): any => ({ ...obj, }); @@ -3395,6 +3623,9 @@ export interface DescribeNetworkInsightsPathsResult { } export namespace DescribeNetworkInsightsPathsResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeNetworkInsightsPathsResult): any => ({ ...obj, }); @@ -3425,6 +3656,9 @@ export interface DescribeNetworkInterfaceAttributeRequest { } export namespace DescribeNetworkInterfaceAttributeRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeNetworkInterfaceAttributeRequest): any => ({ ...obj, }); @@ -3461,6 +3695,9 @@ export interface DescribeNetworkInterfaceAttributeResult { } export namespace DescribeNetworkInterfaceAttributeResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeNetworkInterfaceAttributeResult): any => ({ ...obj, }); @@ -3521,6 +3758,9 @@ export interface DescribeNetworkInterfacePermissionsRequest { } export namespace DescribeNetworkInterfacePermissionsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeNetworkInterfacePermissionsRequest): any => ({ ...obj, }); @@ -3542,6 +3782,9 @@ export interface DescribeNetworkInterfacePermissionsResult { } export namespace DescribeNetworkInterfacePermissionsResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeNetworkInterfacePermissionsResult): any => ({ ...obj, }); @@ -3736,6 +3979,9 @@ export interface DescribeNetworkInterfacesRequest { } export namespace DescribeNetworkInterfacesRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeNetworkInterfacesRequest): any => ({ ...obj, }); @@ -3757,6 +4003,9 @@ export interface DescribeNetworkInterfacesResult { } export namespace DescribeNetworkInterfacesResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeNetworkInterfacesResult): any => ({ ...obj, }); @@ -3816,6 +4065,9 @@ export interface DescribePlacementGroupsRequest { } export namespace DescribePlacementGroupsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribePlacementGroupsRequest): any => ({ ...obj, }); @@ -3829,6 +4081,9 @@ export interface DescribePlacementGroupsResult { } export namespace DescribePlacementGroupsResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribePlacementGroupsResult): any => ({ ...obj, }); @@ -3875,6 +4130,9 @@ export interface DescribePrefixListsRequest { } export namespace DescribePrefixListsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribePrefixListsRequest): any => ({ ...obj, }); @@ -3901,6 +4159,9 @@ export interface PrefixList { } export namespace PrefixList { + /** + * @internal + */ export const filterSensitiveLog = (obj: PrefixList): any => ({ ...obj, }); @@ -3919,6 +4180,9 @@ export interface DescribePrefixListsResult { } export namespace DescribePrefixListsResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribePrefixListsResult): any => ({ ...obj, }); @@ -3963,6 +4227,9 @@ export interface DescribePrincipalIdFormatRequest { } export namespace DescribePrincipalIdFormatRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribePrincipalIdFormatRequest): any => ({ ...obj, }); @@ -3984,6 +4251,9 @@ export interface PrincipalIdFormat { } export namespace PrincipalIdFormat { + /** + * @internal + */ export const filterSensitiveLog = (obj: PrincipalIdFormat): any => ({ ...obj, }); @@ -4002,6 +4272,9 @@ export interface DescribePrincipalIdFormatResult { } export namespace DescribePrincipalIdFormatResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribePrincipalIdFormatResult): any => ({ ...obj, }); @@ -4042,6 +4315,9 @@ export interface DescribePublicIpv4PoolsRequest { } export namespace DescribePublicIpv4PoolsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribePublicIpv4PoolsRequest): any => ({ ...obj, }); @@ -4073,6 +4349,9 @@ export interface PublicIpv4PoolRange { } export namespace PublicIpv4PoolRange { + /** + * @internal + */ export const filterSensitiveLog = (obj: PublicIpv4PoolRange): any => ({ ...obj, }); @@ -4119,6 +4398,9 @@ export interface PublicIpv4Pool { } export namespace PublicIpv4Pool { + /** + * @internal + */ export const filterSensitiveLog = (obj: PublicIpv4Pool): any => ({ ...obj, }); @@ -4137,6 +4419,9 @@ export interface DescribePublicIpv4PoolsResult { } export namespace DescribePublicIpv4PoolsResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribePublicIpv4PoolsResult): any => ({ ...obj, }); @@ -4182,6 +4467,9 @@ export interface DescribeRegionsRequest { } export namespace DescribeRegionsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeRegionsRequest): any => ({ ...obj, }); @@ -4209,6 +4497,9 @@ export interface Region { } export namespace Region { + /** + * @internal + */ export const filterSensitiveLog = (obj: Region): any => ({ ...obj, }); @@ -4222,6 +4513,9 @@ export interface DescribeRegionsResult { } export namespace DescribeRegionsResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeRegionsResult): any => ({ ...obj, }); @@ -4264,6 +4558,9 @@ export interface DescribeReplaceRootVolumeTasksRequest { } export namespace DescribeReplaceRootVolumeTasksRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeReplaceRootVolumeTasksRequest): any => ({ ...obj, }); @@ -4283,6 +4580,9 @@ export interface DescribeReplaceRootVolumeTasksResult { } export namespace DescribeReplaceRootVolumeTasksResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeReplaceRootVolumeTasksResult): any => ({ ...obj, }); @@ -4403,6 +4703,9 @@ export interface DescribeReservedInstancesRequest { } export namespace DescribeReservedInstancesRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeReservedInstancesRequest): any => ({ ...obj, }); @@ -4428,6 +4731,9 @@ export interface RecurringCharge { } export namespace RecurringCharge { + /** + * @internal + */ export const filterSensitiveLog = (obj: RecurringCharge): any => ({ ...obj, }); @@ -4543,6 +4849,9 @@ export interface ReservedInstances { } export namespace ReservedInstances { + /** + * @internal + */ export const filterSensitiveLog = (obj: ReservedInstances): any => ({ ...obj, }); @@ -4559,6 +4868,9 @@ export interface DescribeReservedInstancesResult { } export namespace DescribeReservedInstancesResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeReservedInstancesResult): any => ({ ...obj, }); @@ -4604,6 +4916,9 @@ export interface DescribeReservedInstancesListingsRequest { } export namespace DescribeReservedInstancesListingsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeReservedInstancesListingsRequest): any => ({ ...obj, }); @@ -4620,6 +4935,9 @@ export interface DescribeReservedInstancesListingsResult { } export namespace DescribeReservedInstancesListingsResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeReservedInstancesListingsResult): any => ({ ...obj, }); @@ -4701,6 +5019,9 @@ export interface DescribeReservedInstancesModificationsRequest { } export namespace DescribeReservedInstancesModificationsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeReservedInstancesModificationsRequest): any => ({ ...obj, }); @@ -4740,6 +5061,9 @@ export interface ReservedInstancesConfiguration { } export namespace ReservedInstancesConfiguration { + /** + * @internal + */ export const filterSensitiveLog = (obj: ReservedInstancesConfiguration): any => ({ ...obj, }); @@ -4761,6 +5085,9 @@ export interface ReservedInstancesModificationResult { } export namespace ReservedInstancesModificationResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: ReservedInstancesModificationResult): any => ({ ...obj, }); @@ -4777,6 +5104,9 @@ export interface ReservedInstancesId { } export namespace ReservedInstancesId { + /** + * @internal + */ export const filterSensitiveLog = (obj: ReservedInstancesId): any => ({ ...obj, }); @@ -4835,6 +5165,9 @@ export interface ReservedInstancesModification { } export namespace ReservedInstancesModification { + /** + * @internal + */ export const filterSensitiveLog = (obj: ReservedInstancesModification): any => ({ ...obj, }); @@ -4857,6 +5190,9 @@ export interface DescribeReservedInstancesModificationsResult { } export namespace DescribeReservedInstancesModificationsResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeReservedInstancesModificationsResult): any => ({ ...obj, }); @@ -5019,6 +5355,9 @@ export interface DescribeReservedInstancesOfferingsRequest { } export namespace DescribeReservedInstancesOfferingsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeReservedInstancesOfferingsRequest): any => ({ ...obj, }); @@ -5040,6 +5379,9 @@ export interface PricingDetail { } export namespace PricingDetail { + /** + * @internal + */ export const filterSensitiveLog = (obj: PricingDetail): any => ({ ...obj, }); @@ -5132,6 +5474,9 @@ export interface ReservedInstancesOffering { } export namespace ReservedInstancesOffering { + /** + * @internal + */ export const filterSensitiveLog = (obj: ReservedInstancesOffering): any => ({ ...obj, }); @@ -5154,6 +5499,9 @@ export interface DescribeReservedInstancesOfferingsResult { } export namespace DescribeReservedInstancesOfferingsResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeReservedInstancesOfferingsResult): any => ({ ...obj, }); @@ -5292,6 +5640,9 @@ export interface DescribeRouteTablesRequest { } export namespace DescribeRouteTablesRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeRouteTablesRequest): any => ({ ...obj, }); @@ -5313,6 +5664,9 @@ export interface DescribeRouteTablesResult { } export namespace DescribeRouteTablesResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeRouteTablesResult): any => ({ ...obj, }); @@ -5334,6 +5688,9 @@ export interface SlotDateTimeRangeRequest { } export namespace SlotDateTimeRangeRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: SlotDateTimeRangeRequest): any => ({ ...obj, }); @@ -5374,6 +5731,9 @@ export interface ScheduledInstanceRecurrenceRequest { } export namespace ScheduledInstanceRecurrenceRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ScheduledInstanceRecurrenceRequest): any => ({ ...obj, }); @@ -5449,6 +5809,9 @@ export interface DescribeScheduledInstanceAvailabilityRequest { } export namespace DescribeScheduledInstanceAvailabilityRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeScheduledInstanceAvailabilityRequest): any => ({ ...obj, }); @@ -5486,6 +5849,9 @@ export interface ScheduledInstanceRecurrence { } export namespace ScheduledInstanceRecurrence { + /** + * @internal + */ export const filterSensitiveLog = (obj: ScheduledInstanceRecurrence): any => ({ ...obj, }); @@ -5562,6 +5928,9 @@ export interface ScheduledInstanceAvailability { } export namespace ScheduledInstanceAvailability { + /** + * @internal + */ export const filterSensitiveLog = (obj: ScheduledInstanceAvailability): any => ({ ...obj, }); @@ -5583,6 +5952,9 @@ export interface DescribeScheduledInstanceAvailabilityResult { } export namespace DescribeScheduledInstanceAvailabilityResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeScheduledInstanceAvailabilityResult): any => ({ ...obj, }); @@ -5604,6 +5976,9 @@ export interface SlotStartTimeRangeRequest { } export namespace SlotStartTimeRangeRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: SlotStartTimeRangeRequest): any => ({ ...obj, }); @@ -5668,6 +6043,9 @@ export interface DescribeScheduledInstancesRequest { } export namespace DescribeScheduledInstancesRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeScheduledInstancesRequest): any => ({ ...obj, }); @@ -5754,6 +6132,9 @@ export interface ScheduledInstance { } export namespace ScheduledInstance { + /** + * @internal + */ export const filterSensitiveLog = (obj: ScheduledInstance): any => ({ ...obj, }); @@ -5775,6 +6156,9 @@ export interface DescribeScheduledInstancesResult { } export namespace DescribeScheduledInstancesResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeScheduledInstancesResult): any => ({ ...obj, }); @@ -5795,6 +6179,9 @@ export interface DescribeSecurityGroupReferencesRequest { } export namespace DescribeSecurityGroupReferencesRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeSecurityGroupReferencesRequest): any => ({ ...obj, }); @@ -5821,6 +6208,9 @@ export interface SecurityGroupReference { } export namespace SecurityGroupReference { + /** + * @internal + */ export const filterSensitiveLog = (obj: SecurityGroupReference): any => ({ ...obj, }); @@ -5834,6 +6224,9 @@ export interface DescribeSecurityGroupReferencesResult { } export namespace DescribeSecurityGroupReferencesResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeSecurityGroupReferencesResult): any => ({ ...obj, }); @@ -6003,6 +6396,9 @@ export interface DescribeSecurityGroupsRequest { } export namespace DescribeSecurityGroupsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeSecurityGroupsRequest): any => ({ ...obj, }); @@ -6054,6 +6450,9 @@ export interface SecurityGroup { } export namespace SecurityGroup { + /** + * @internal + */ export const filterSensitiveLog = (obj: SecurityGroup): any => ({ ...obj, }); @@ -6072,6 +6471,9 @@ export interface DescribeSecurityGroupsResult { } export namespace DescribeSecurityGroupsResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeSecurityGroupsResult): any => ({ ...obj, }); @@ -6099,6 +6501,9 @@ export interface DescribeSnapshotAttributeRequest { } export namespace DescribeSnapshotAttributeRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeSnapshotAttributeRequest): any => ({ ...obj, }); @@ -6121,6 +6526,9 @@ export interface CreateVolumePermission { } export namespace CreateVolumePermission { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateVolumePermission): any => ({ ...obj, }); @@ -6145,6 +6553,9 @@ export interface DescribeSnapshotAttributeResult { } export namespace DescribeSnapshotAttributeResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeSnapshotAttributeResult): any => ({ ...obj, }); @@ -6262,6 +6673,9 @@ export interface DescribeSnapshotsRequest { } export namespace DescribeSnapshotsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeSnapshotsRequest): any => ({ ...obj, }); @@ -6283,6 +6697,9 @@ export interface DescribeSnapshotsResult { } export namespace DescribeSnapshotsResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeSnapshotsResult): any => ({ ...obj, }); @@ -6301,6 +6718,9 @@ export interface DescribeSpotDatafeedSubscriptionRequest { } export namespace DescribeSpotDatafeedSubscriptionRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeSpotDatafeedSubscriptionRequest): any => ({ ...obj, }); @@ -6317,6 +6737,9 @@ export interface DescribeSpotDatafeedSubscriptionResult { } export namespace DescribeSpotDatafeedSubscriptionResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeSpotDatafeedSubscriptionResult): any => ({ ...obj, }); @@ -6353,6 +6776,9 @@ export interface DescribeSpotFleetInstancesRequest { } export namespace DescribeSpotFleetInstancesRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeSpotFleetInstancesRequest): any => ({ ...obj, }); @@ -6380,6 +6806,9 @@ export interface DescribeSpotFleetInstancesResponse { } export namespace DescribeSpotFleetInstancesResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeSpotFleetInstancesResponse): any => ({ ...obj, }); @@ -6433,6 +6862,9 @@ export interface DescribeSpotFleetRequestHistoryRequest { } export namespace DescribeSpotFleetRequestHistoryRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeSpotFleetRequestHistoryRequest): any => ({ ...obj, }); @@ -6477,6 +6909,9 @@ export interface HistoryRecord { } export namespace HistoryRecord { + /** + * @internal + */ export const filterSensitiveLog = (obj: HistoryRecord): any => ({ ...obj, }); @@ -6515,6 +6950,9 @@ export interface DescribeSpotFleetRequestHistoryResponse { } export namespace DescribeSpotFleetRequestHistoryResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeSpotFleetRequestHistoryResponse): any => ({ ...obj, }); @@ -6551,6 +6989,9 @@ export interface DescribeSpotFleetRequestsRequest { } export namespace DescribeSpotFleetRequestsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeSpotFleetRequestsRequest): any => ({ ...obj, }); @@ -6574,6 +7015,9 @@ export interface SpotFleetMonitoring { } export namespace SpotFleetMonitoring { + /** + * @internal + */ export const filterSensitiveLog = (obj: SpotFleetMonitoring): any => ({ ...obj, }); @@ -6688,6 +7132,9 @@ export interface InstanceNetworkInterfaceSpecification { } export namespace InstanceNetworkInterfaceSpecification { + /** + * @internal + */ export const filterSensitiveLog = (obj: InstanceNetworkInterfaceSpecification): any => ({ ...obj, }); @@ -6717,6 +7164,9 @@ export interface SpotPlacement { } export namespace SpotPlacement { + /** + * @internal + */ export const filterSensitiveLog = (obj: SpotPlacement): any => ({ ...obj, }); @@ -6742,6 +7192,9 @@ export interface SpotFleetTagSpecification { } export namespace SpotFleetTagSpecification { + /** + * @internal + */ export const filterSensitiveLog = (obj: SpotFleetTagSpecification): any => ({ ...obj, }); @@ -6860,6 +7313,9 @@ export interface SpotFleetLaunchSpecification { } export namespace SpotFleetLaunchSpecification { + /** + * @internal + */ export const filterSensitiveLog = (obj: SpotFleetLaunchSpecification): any => ({ ...obj, }); @@ -6912,6 +7368,9 @@ export interface LaunchTemplateOverrides { } export namespace LaunchTemplateOverrides { + /** + * @internal + */ export const filterSensitiveLog = (obj: LaunchTemplateOverrides): any => ({ ...obj, }); @@ -6933,6 +7392,9 @@ export interface LaunchTemplateConfig { } export namespace LaunchTemplateConfig { + /** + * @internal + */ export const filterSensitiveLog = (obj: LaunchTemplateConfig): any => ({ ...obj, }); @@ -6949,6 +7411,9 @@ export interface ClassicLoadBalancer { } export namespace ClassicLoadBalancer { + /** + * @internal + */ export const filterSensitiveLog = (obj: ClassicLoadBalancer): any => ({ ...obj, }); @@ -6966,6 +7431,9 @@ export interface ClassicLoadBalancersConfig { } export namespace ClassicLoadBalancersConfig { + /** + * @internal + */ export const filterSensitiveLog = (obj: ClassicLoadBalancersConfig): any => ({ ...obj, }); @@ -6982,6 +7450,9 @@ export interface TargetGroup { } export namespace TargetGroup { + /** + * @internal + */ export const filterSensitiveLog = (obj: TargetGroup): any => ({ ...obj, }); @@ -6999,6 +7470,9 @@ export interface TargetGroupsConfig { } export namespace TargetGroupsConfig { + /** + * @internal + */ export const filterSensitiveLog = (obj: TargetGroupsConfig): any => ({ ...obj, }); @@ -7020,6 +7494,9 @@ export interface LoadBalancersConfig { } export namespace LoadBalancersConfig { + /** + * @internal + */ export const filterSensitiveLog = (obj: LoadBalancersConfig): any => ({ ...obj, }); @@ -7056,6 +7533,9 @@ export interface SpotCapacityRebalance { } export namespace SpotCapacityRebalance { + /** + * @internal + */ export const filterSensitiveLog = (obj: SpotCapacityRebalance): any => ({ ...obj, }); @@ -7074,6 +7554,9 @@ export interface SpotMaintenanceStrategies { } export namespace SpotMaintenanceStrategies { + /** + * @internal + */ export const filterSensitiveLog = (obj: SpotMaintenanceStrategies): any => ({ ...obj, }); @@ -7289,6 +7772,9 @@ export interface SpotFleetRequestConfigData { } export namespace SpotFleetRequestConfigData { + /** + * @internal + */ export const filterSensitiveLog = (obj: SpotFleetRequestConfigData): any => ({ ...obj, }); @@ -7335,6 +7821,9 @@ export interface SpotFleetRequestConfig { } export namespace SpotFleetRequestConfig { + /** + * @internal + */ export const filterSensitiveLog = (obj: SpotFleetRequestConfig): any => ({ ...obj, }); @@ -7356,6 +7845,9 @@ export interface DescribeSpotFleetRequestsResponse { } export namespace DescribeSpotFleetRequestsResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeSpotFleetRequestsResponse): any => ({ ...obj, }); @@ -7567,6 +8059,9 @@ export interface DescribeSpotInstanceRequestsRequest { } export namespace DescribeSpotInstanceRequestsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeSpotInstanceRequestsRequest): any => ({ ...obj, }); @@ -7584,6 +8079,9 @@ export interface RunInstancesMonitoringEnabled { } export namespace RunInstancesMonitoringEnabled { + /** + * @internal + */ export const filterSensitiveLog = (obj: RunInstancesMonitoringEnabled): any => ({ ...obj, }); @@ -7673,6 +8171,9 @@ export interface LaunchSpecification { } export namespace LaunchSpecification { + /** + * @internal + */ export const filterSensitiveLog = (obj: LaunchSpecification): any => ({ ...obj, }); @@ -7702,6 +8203,9 @@ export interface SpotInstanceStatus { } export namespace SpotInstanceStatus { + /** + * @internal + */ export const filterSensitiveLog = (obj: SpotInstanceStatus): any => ({ ...obj, }); @@ -7824,6 +8328,9 @@ export interface SpotInstanceRequest { } export namespace SpotInstanceRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: SpotInstanceRequest): any => ({ ...obj, }); @@ -7846,6 +8353,9 @@ export interface DescribeSpotInstanceRequestsResult { } export namespace DescribeSpotInstanceRequestsResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeSpotInstanceRequestsResult): any => ({ ...obj, }); @@ -7940,6 +8450,9 @@ export interface DescribeSpotPriceHistoryRequest { } export namespace DescribeSpotPriceHistoryRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeSpotPriceHistoryRequest): any => ({ ...obj, }); @@ -7976,6 +8489,9 @@ export interface SpotPrice { } export namespace SpotPrice { + /** + * @internal + */ export const filterSensitiveLog = (obj: SpotPrice): any => ({ ...obj, }); @@ -7998,6 +8514,9 @@ export interface DescribeSpotPriceHistoryResult { } export namespace DescribeSpotPriceHistoryResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeSpotPriceHistoryResult): any => ({ ...obj, }); @@ -8028,6 +8547,9 @@ export interface DescribeStaleSecurityGroupsRequest { } export namespace DescribeStaleSecurityGroupsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeStaleSecurityGroupsRequest): any => ({ ...obj, }); @@ -8071,6 +8593,9 @@ export interface StaleIpPermission { } export namespace StaleIpPermission { + /** + * @internal + */ export const filterSensitiveLog = (obj: StaleIpPermission): any => ({ ...obj, }); @@ -8112,6 +8637,9 @@ export interface StaleSecurityGroup { } export namespace StaleSecurityGroup { + /** + * @internal + */ export const filterSensitiveLog = (obj: StaleSecurityGroup): any => ({ ...obj, }); @@ -8130,6 +8658,9 @@ export interface DescribeStaleSecurityGroupsResult { } export namespace DescribeStaleSecurityGroupsResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeStaleSecurityGroupsResult): any => ({ ...obj, }); @@ -8180,6 +8711,9 @@ export interface DescribeStoreImageTasksRequest { } export namespace DescribeStoreImageTasksRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeStoreImageTasksRequest): any => ({ ...obj, }); @@ -8228,6 +8762,9 @@ export interface StoreImageTaskResult { } export namespace StoreImageTaskResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: StoreImageTaskResult): any => ({ ...obj, }); @@ -8247,6 +8784,9 @@ export interface DescribeStoreImageTasksResult { } export namespace DescribeStoreImageTasksResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeStoreImageTasksResult): any => ({ ...obj, }); @@ -8361,6 +8901,9 @@ export interface DescribeSubnetsRequest { } export namespace DescribeSubnetsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeSubnetsRequest): any => ({ ...obj, }); @@ -8379,6 +8922,9 @@ export interface DescribeSubnetsResult { } export namespace DescribeSubnetsResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeSubnetsResult): any => ({ ...obj, }); @@ -8435,6 +8981,9 @@ export interface DescribeTagsRequest { } export namespace DescribeTagsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeTagsRequest): any => ({ ...obj, }); @@ -8466,6 +9015,9 @@ export interface TagDescription { } export namespace TagDescription { + /** + * @internal + */ export const filterSensitiveLog = (obj: TagDescription): any => ({ ...obj, }); @@ -8485,6 +9037,9 @@ export interface DescribeTagsResult { } export namespace DescribeTagsResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeTagsResult): any => ({ ...obj, }); @@ -8531,6 +9086,9 @@ export interface DescribeTrafficMirrorFiltersRequest { } export namespace DescribeTrafficMirrorFiltersRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeTrafficMirrorFiltersRequest): any => ({ ...obj, }); @@ -8549,6 +9107,9 @@ export interface DescribeTrafficMirrorFiltersResult { } export namespace DescribeTrafficMirrorFiltersResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeTrafficMirrorFiltersResult): any => ({ ...obj, }); @@ -8623,6 +9184,9 @@ export interface DescribeTrafficMirrorSessionsRequest { } export namespace DescribeTrafficMirrorSessionsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeTrafficMirrorSessionsRequest): any => ({ ...obj, }); @@ -8641,6 +9205,9 @@ export interface DescribeTrafficMirrorSessionsResult { } export namespace DescribeTrafficMirrorSessionsResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeTrafficMirrorSessionsResult): any => ({ ...obj, }); @@ -8699,6 +9266,9 @@ export interface DescribeTrafficMirrorTargetsRequest { } export namespace DescribeTrafficMirrorTargetsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeTrafficMirrorTargetsRequest): any => ({ ...obj, }); @@ -8717,6 +9287,9 @@ export interface DescribeTrafficMirrorTargetsResult { } export namespace DescribeTrafficMirrorTargetsResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeTrafficMirrorTargetsResult): any => ({ ...obj, }); @@ -8794,6 +9367,9 @@ export interface DescribeTransitGatewayAttachmentsRequest { } export namespace DescribeTransitGatewayAttachmentsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeTransitGatewayAttachmentsRequest): any => ({ ...obj, }); @@ -8815,6 +9391,9 @@ export interface TransitGatewayAttachmentAssociation { } export namespace TransitGatewayAttachmentAssociation { + /** + * @internal + */ export const filterSensitiveLog = (obj: TransitGatewayAttachmentAssociation): any => ({ ...obj, }); @@ -8876,6 +9455,9 @@ export interface TransitGatewayAttachment { } export namespace TransitGatewayAttachment { + /** + * @internal + */ export const filterSensitiveLog = (obj: TransitGatewayAttachment): any => ({ ...obj, }); @@ -8894,6 +9476,9 @@ export interface DescribeTransitGatewayAttachmentsResult { } export namespace DescribeTransitGatewayAttachmentsResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeTransitGatewayAttachmentsResult): any => ({ ...obj, }); @@ -8946,6 +9531,9 @@ export interface DescribeTransitGatewayConnectPeersRequest { } export namespace DescribeTransitGatewayConnectPeersRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeTransitGatewayConnectPeersRequest): any => ({ ...obj, }); @@ -8964,6 +9552,9 @@ export interface DescribeTransitGatewayConnectPeersResult { } export namespace DescribeTransitGatewayConnectPeersResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeTransitGatewayConnectPeersResult): any => ({ ...obj, }); @@ -9028,6 +9619,9 @@ export interface DescribeTransitGatewayConnectsRequest { } export namespace DescribeTransitGatewayConnectsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeTransitGatewayConnectsRequest): any => ({ ...obj, }); @@ -9046,6 +9640,9 @@ export interface DescribeTransitGatewayConnectsResult { } export namespace DescribeTransitGatewayConnectsResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeTransitGatewayConnectsResult): any => ({ ...obj, }); @@ -9096,6 +9693,9 @@ export interface DescribeTransitGatewayMulticastDomainsRequest { } export namespace DescribeTransitGatewayMulticastDomainsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeTransitGatewayMulticastDomainsRequest): any => ({ ...obj, }); @@ -9114,6 +9714,9 @@ export interface DescribeTransitGatewayMulticastDomainsResult { } export namespace DescribeTransitGatewayMulticastDomainsResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeTransitGatewayMulticastDomainsResult): any => ({ ...obj, }); @@ -9181,6 +9784,9 @@ export interface DescribeTransitGatewayPeeringAttachmentsRequest { } export namespace DescribeTransitGatewayPeeringAttachmentsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeTransitGatewayPeeringAttachmentsRequest): any => ({ ...obj, }); @@ -9199,6 +9805,9 @@ export interface DescribeTransitGatewayPeeringAttachmentsResult { } export namespace DescribeTransitGatewayPeeringAttachmentsResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeTransitGatewayPeeringAttachmentsResult): any => ({ ...obj, }); @@ -9259,6 +9868,9 @@ export interface DescribeTransitGatewayRouteTablesRequest { } export namespace DescribeTransitGatewayRouteTablesRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeTransitGatewayRouteTablesRequest): any => ({ ...obj, }); @@ -9277,6 +9889,9 @@ export interface DescribeTransitGatewayRouteTablesResult { } export namespace DescribeTransitGatewayRouteTablesResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeTransitGatewayRouteTablesResult): any => ({ ...obj, }); @@ -9361,6 +9976,9 @@ export interface DescribeTransitGatewaysRequest { } export namespace DescribeTransitGatewaysRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeTransitGatewaysRequest): any => ({ ...obj, }); @@ -9379,6 +9997,9 @@ export interface DescribeTransitGatewaysResult { } export namespace DescribeTransitGatewaysResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeTransitGatewaysResult): any => ({ ...obj, }); @@ -9433,6 +10054,9 @@ export interface DescribeTransitGatewayVpcAttachmentsRequest { } export namespace DescribeTransitGatewayVpcAttachmentsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeTransitGatewayVpcAttachmentsRequest): any => ({ ...obj, }); @@ -9451,6 +10075,9 @@ export interface DescribeTransitGatewayVpcAttachmentsResult { } export namespace DescribeTransitGatewayVpcAttachmentsResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeTransitGatewayVpcAttachmentsResult): any => ({ ...obj, }); @@ -9478,6 +10105,9 @@ export interface DescribeVolumeAttributeRequest { } export namespace DescribeVolumeAttributeRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeVolumeAttributeRequest): any => ({ ...obj, }); @@ -9501,6 +10131,9 @@ export interface DescribeVolumeAttributeResult { } export namespace DescribeVolumeAttributeResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeVolumeAttributeResult): any => ({ ...obj, }); @@ -9632,6 +10265,9 @@ export interface DescribeVolumesRequest { } export namespace DescribeVolumesRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeVolumesRequest): any => ({ ...obj, }); @@ -9653,6 +10289,9 @@ export interface DescribeVolumesResult { } export namespace DescribeVolumesResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeVolumesResult): any => ({ ...obj, }); @@ -9738,6 +10377,9 @@ export interface DescribeVolumesModificationsRequest { } export namespace DescribeVolumesModificationsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeVolumesModificationsRequest): any => ({ ...obj, }); @@ -9833,6 +10475,9 @@ export interface VolumeModification { } export namespace VolumeModification { + /** + * @internal + */ export const filterSensitiveLog = (obj: VolumeModification): any => ({ ...obj, }); @@ -9851,6 +10496,9 @@ export interface DescribeVolumesModificationsResult { } export namespace DescribeVolumesModificationsResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeVolumesModificationsResult): any => ({ ...obj, }); @@ -9958,6 +10606,9 @@ export interface DescribeVolumeStatusRequest { } export namespace DescribeVolumeStatusRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeVolumeStatusRequest): any => ({ ...obj, }); @@ -9989,6 +10640,9 @@ export interface VolumeStatusAction { } export namespace VolumeStatusAction { + /** + * @internal + */ export const filterSensitiveLog = (obj: VolumeStatusAction): any => ({ ...obj, }); @@ -10010,6 +10664,9 @@ export interface VolumeStatusAttachmentStatus { } export namespace VolumeStatusAttachmentStatus { + /** + * @internal + */ export const filterSensitiveLog = (obj: VolumeStatusAttachmentStatus): any => ({ ...obj, }); @@ -10051,6 +10708,9 @@ export interface VolumeStatusEvent { } export namespace VolumeStatusEvent { + /** + * @internal + */ export const filterSensitiveLog = (obj: VolumeStatusEvent): any => ({ ...obj, }); @@ -10074,6 +10734,9 @@ export interface VolumeStatusDetails { } export namespace VolumeStatusDetails { + /** + * @internal + */ export const filterSensitiveLog = (obj: VolumeStatusDetails): any => ({ ...obj, }); @@ -10097,6 +10760,9 @@ export interface VolumeStatusInfo { } export namespace VolumeStatusInfo { + /** + * @internal + */ export const filterSensitiveLog = (obj: VolumeStatusInfo): any => ({ ...obj, }); @@ -10143,6 +10809,9 @@ export interface VolumeStatusItem { } export namespace VolumeStatusItem { + /** + * @internal + */ export const filterSensitiveLog = (obj: VolumeStatusItem): any => ({ ...obj, }); @@ -10162,6 +10831,9 @@ export interface DescribeVolumeStatusResult { } export namespace DescribeVolumeStatusResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeVolumeStatusResult): any => ({ ...obj, }); @@ -10189,6 +10861,9 @@ export interface DescribeVpcAttributeRequest { } export namespace DescribeVpcAttributeRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeVpcAttributeRequest): any => ({ ...obj, }); @@ -10217,6 +10892,9 @@ export interface DescribeVpcAttributeResult { } export namespace DescribeVpcAttributeResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeVpcAttributeResult): any => ({ ...obj, }); @@ -10258,6 +10936,9 @@ export interface DescribeVpcClassicLinkRequest { } export namespace DescribeVpcClassicLinkRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeVpcClassicLinkRequest): any => ({ ...obj, }); @@ -10284,6 +10965,9 @@ export interface VpcClassicLink { } export namespace VpcClassicLink { + /** + * @internal + */ export const filterSensitiveLog = (obj: VpcClassicLink): any => ({ ...obj, }); @@ -10297,6 +10981,9 @@ export interface DescribeVpcClassicLinkResult { } export namespace DescribeVpcClassicLinkResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeVpcClassicLinkResult): any => ({ ...obj, }); @@ -10321,6 +11008,9 @@ export interface DescribeVpcClassicLinkDnsSupportRequest { } export namespace DescribeVpcClassicLinkDnsSupportRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeVpcClassicLinkDnsSupportRequest): any => ({ ...obj, }); @@ -10342,6 +11032,9 @@ export interface ClassicLinkDnsSupport { } export namespace ClassicLinkDnsSupport { + /** + * @internal + */ export const filterSensitiveLog = (obj: ClassicLinkDnsSupport): any => ({ ...obj, }); @@ -10360,6 +11053,9 @@ export interface DescribeVpcClassicLinkDnsSupportResult { } export namespace DescribeVpcClassicLinkDnsSupportResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeVpcClassicLinkDnsSupportResult): any => ({ ...obj, }); @@ -10426,6 +11122,9 @@ export interface DescribeVpcEndpointConnectionNotificationsRequest { } export namespace DescribeVpcEndpointConnectionNotificationsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeVpcEndpointConnectionNotificationsRequest): any => ({ ...obj, }); @@ -10445,6 +11144,9 @@ export interface DescribeVpcEndpointConnectionNotificationsResult { } export namespace DescribeVpcEndpointConnectionNotificationsResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeVpcEndpointConnectionNotificationsResult): any => ({ ...obj, }); @@ -10501,6 +11203,9 @@ export interface DescribeVpcEndpointConnectionsRequest { } export namespace DescribeVpcEndpointConnectionsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeVpcEndpointConnectionsRequest): any => ({ ...obj, }); @@ -10552,6 +11257,9 @@ export interface VpcEndpointConnection { } export namespace VpcEndpointConnection { + /** + * @internal + */ export const filterSensitiveLog = (obj: VpcEndpointConnection): any => ({ ...obj, }); @@ -10570,6 +11278,9 @@ export interface DescribeVpcEndpointConnectionsResult { } export namespace DescribeVpcEndpointConnectionsResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeVpcEndpointConnectionsResult): any => ({ ...obj, }); @@ -10642,6 +11353,9 @@ export interface DescribeVpcEndpointsRequest { } export namespace DescribeVpcEndpointsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeVpcEndpointsRequest): any => ({ ...obj, }); @@ -10663,6 +11377,9 @@ export interface DescribeVpcEndpointsResult { } export namespace DescribeVpcEndpointsResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeVpcEndpointsResult): any => ({ ...obj, }); @@ -10726,6 +11443,9 @@ export interface DescribeVpcEndpointServiceConfigurationsRequest { } export namespace DescribeVpcEndpointServiceConfigurationsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeVpcEndpointServiceConfigurationsRequest): any => ({ ...obj, }); @@ -10744,6 +11464,9 @@ export interface DescribeVpcEndpointServiceConfigurationsResult { } export namespace DescribeVpcEndpointServiceConfigurationsResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeVpcEndpointServiceConfigurationsResult): any => ({ ...obj, }); @@ -10795,6 +11518,9 @@ export interface DescribeVpcEndpointServicePermissionsRequest { } export namespace DescribeVpcEndpointServicePermissionsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeVpcEndpointServicePermissionsRequest): any => ({ ...obj, }); @@ -10813,6 +11539,9 @@ export interface DescribeVpcEndpointServicePermissionsResult { } export namespace DescribeVpcEndpointServicePermissionsResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeVpcEndpointServicePermissionsResult): any => ({ ...obj, }); @@ -10871,6 +11600,9 @@ export interface DescribeVpcEndpointServicesRequest { } export namespace DescribeVpcEndpointServicesRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeVpcEndpointServicesRequest): any => ({ ...obj, }); @@ -10887,6 +11619,9 @@ export interface PrivateDnsDetails { } export namespace PrivateDnsDetails { + /** + * @internal + */ export const filterSensitiveLog = (obj: PrivateDnsDetails): any => ({ ...obj, }); @@ -10965,6 +11700,9 @@ export interface ServiceDetail { } export namespace ServiceDetail { + /** + * @internal + */ export const filterSensitiveLog = (obj: ServiceDetail): any => ({ ...obj, }); @@ -10991,6 +11729,9 @@ export interface DescribeVpcEndpointServicesResult { } export namespace DescribeVpcEndpointServicesResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeVpcEndpointServicesResult): any => ({ ...obj, }); @@ -11089,6 +11830,9 @@ export interface DescribeVpcPeeringConnectionsRequest { } export namespace DescribeVpcPeeringConnectionsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeVpcPeeringConnectionsRequest): any => ({ ...obj, }); @@ -11107,6 +11851,9 @@ export interface DescribeVpcPeeringConnectionsResult { } export namespace DescribeVpcPeeringConnectionsResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeVpcPeeringConnectionsResult): any => ({ ...obj, }); @@ -11216,6 +11963,9 @@ export interface DescribeVpcsRequest { } export namespace DescribeVpcsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeVpcsRequest): any => ({ ...obj, }); @@ -11234,6 +11984,9 @@ export interface DescribeVpcsResult { } export namespace DescribeVpcsResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeVpcsResult): any => ({ ...obj, }); @@ -11314,6 +12067,9 @@ export interface DescribeVpnConnectionsRequest { } export namespace DescribeVpnConnectionsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeVpnConnectionsRequest): any => ({ ...obj, }); @@ -11330,6 +12086,9 @@ export interface DescribeVpnConnectionsResult { } export namespace DescribeVpnConnectionsResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeVpnConnectionsResult): any => ({ ...obj, }); @@ -11398,6 +12157,9 @@ export interface DescribeVpnGatewaysRequest { } export namespace DescribeVpnGatewaysRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeVpnGatewaysRequest): any => ({ ...obj, }); @@ -11414,6 +12176,9 @@ export interface DescribeVpnGatewaysResult { } export namespace DescribeVpnGatewaysResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeVpnGatewaysResult): any => ({ ...obj, }); @@ -11439,6 +12204,9 @@ export interface DetachClassicLinkVpcRequest { } export namespace DetachClassicLinkVpcRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DetachClassicLinkVpcRequest): any => ({ ...obj, }); @@ -11452,6 +12220,9 @@ export interface DetachClassicLinkVpcResult { } export namespace DetachClassicLinkVpcResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: DetachClassicLinkVpcResult): any => ({ ...obj, }); @@ -11477,6 +12248,9 @@ export interface DetachInternetGatewayRequest { } export namespace DetachInternetGatewayRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DetachInternetGatewayRequest): any => ({ ...obj, }); @@ -11522,6 +12296,9 @@ export interface DetachNetworkInterfaceRequest { } export namespace DetachNetworkInterfaceRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DetachNetworkInterfaceRequest): any => ({ ...obj, }); @@ -11562,6 +12339,9 @@ export interface DetachVolumeRequest { } export namespace DetachVolumeRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DetachVolumeRequest): any => ({ ...obj, }); @@ -11590,6 +12370,9 @@ export interface DetachVpnGatewayRequest { } export namespace DetachVpnGatewayRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DetachVpnGatewayRequest): any => ({ ...obj, }); @@ -11605,6 +12388,9 @@ export interface DisableEbsEncryptionByDefaultRequest { } export namespace DisableEbsEncryptionByDefaultRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DisableEbsEncryptionByDefaultRequest): any => ({ ...obj, }); @@ -11618,6 +12404,9 @@ export interface DisableEbsEncryptionByDefaultResult { } export namespace DisableEbsEncryptionByDefaultResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: DisableEbsEncryptionByDefaultResult): any => ({ ...obj, }); @@ -11643,6 +12432,9 @@ export interface DisableFastSnapshotRestoresRequest { } export namespace DisableFastSnapshotRestoresRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DisableFastSnapshotRestoresRequest): any => ({ ...obj, }); @@ -11721,6 +12513,9 @@ export interface DisableFastSnapshotRestoreSuccessItem { } export namespace DisableFastSnapshotRestoreSuccessItem { + /** + * @internal + */ export const filterSensitiveLog = (obj: DisableFastSnapshotRestoreSuccessItem): any => ({ ...obj, }); @@ -11742,6 +12537,9 @@ export interface DisableFastSnapshotRestoreStateError { } export namespace DisableFastSnapshotRestoreStateError { + /** + * @internal + */ export const filterSensitiveLog = (obj: DisableFastSnapshotRestoreStateError): any => ({ ...obj, }); @@ -11763,6 +12561,9 @@ export interface DisableFastSnapshotRestoreStateErrorItem { } export namespace DisableFastSnapshotRestoreStateErrorItem { + /** + * @internal + */ export const filterSensitiveLog = (obj: DisableFastSnapshotRestoreStateErrorItem): any => ({ ...obj, }); @@ -11784,6 +12585,9 @@ export interface DisableFastSnapshotRestoreErrorItem { } export namespace DisableFastSnapshotRestoreErrorItem { + /** + * @internal + */ export const filterSensitiveLog = (obj: DisableFastSnapshotRestoreErrorItem): any => ({ ...obj, }); diff --git a/clients/client-ec2/models/models_4.ts b/clients/client-ec2/models/models_4.ts index e472192f7170..c7c050c65d58 100644 --- a/clients/client-ec2/models/models_4.ts +++ b/clients/client-ec2/models/models_4.ts @@ -124,6 +124,9 @@ export interface DisableFastSnapshotRestoresResult { } export namespace DisableFastSnapshotRestoresResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: DisableFastSnapshotRestoresResult): any => ({ ...obj, }); @@ -137,6 +140,9 @@ export interface DisableSerialConsoleAccessRequest { } export namespace DisableSerialConsoleAccessRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DisableSerialConsoleAccessRequest): any => ({ ...obj, }); @@ -152,6 +158,9 @@ export interface DisableSerialConsoleAccessResult { } export namespace DisableSerialConsoleAccessResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: DisableSerialConsoleAccessResult): any => ({ ...obj, }); @@ -177,6 +186,9 @@ export interface DisableTransitGatewayRouteTablePropagationRequest { } export namespace DisableTransitGatewayRouteTablePropagationRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DisableTransitGatewayRouteTablePropagationRequest): any => ({ ...obj, }); @@ -215,6 +227,9 @@ export interface TransitGatewayPropagation { } export namespace TransitGatewayPropagation { + /** + * @internal + */ export const filterSensitiveLog = (obj: TransitGatewayPropagation): any => ({ ...obj, }); @@ -228,6 +243,9 @@ export interface DisableTransitGatewayRouteTablePropagationResult { } export namespace DisableTransitGatewayRouteTablePropagationResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: DisableTransitGatewayRouteTablePropagationResult): any => ({ ...obj, }); @@ -256,6 +274,9 @@ export interface DisableVgwRoutePropagationRequest { } export namespace DisableVgwRoutePropagationRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DisableVgwRoutePropagationRequest): any => ({ ...obj, }); @@ -276,6 +297,9 @@ export interface DisableVpcClassicLinkRequest { } export namespace DisableVpcClassicLinkRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DisableVpcClassicLinkRequest): any => ({ ...obj, }); @@ -289,6 +313,9 @@ export interface DisableVpcClassicLinkResult { } export namespace DisableVpcClassicLinkResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: DisableVpcClassicLinkResult): any => ({ ...obj, }); @@ -302,6 +329,9 @@ export interface DisableVpcClassicLinkDnsSupportRequest { } export namespace DisableVpcClassicLinkDnsSupportRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DisableVpcClassicLinkDnsSupportRequest): any => ({ ...obj, }); @@ -315,6 +345,9 @@ export interface DisableVpcClassicLinkDnsSupportResult { } export namespace DisableVpcClassicLinkDnsSupportResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: DisableVpcClassicLinkDnsSupportResult): any => ({ ...obj, }); @@ -340,6 +373,9 @@ export interface DisassociateAddressRequest { } export namespace DisassociateAddressRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DisassociateAddressRequest): any => ({ ...obj, }); @@ -363,6 +399,9 @@ export interface DisassociateClientVpnTargetNetworkRequest { } export namespace DisassociateClientVpnTargetNetworkRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DisassociateClientVpnTargetNetworkRequest): any => ({ ...obj, }); @@ -381,6 +420,9 @@ export interface DisassociateClientVpnTargetNetworkResult { } export namespace DisassociateClientVpnTargetNetworkResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: DisassociateClientVpnTargetNetworkResult): any => ({ ...obj, }); @@ -404,6 +446,9 @@ export interface DisassociateEnclaveCertificateIamRoleRequest { } export namespace DisassociateEnclaveCertificateIamRoleRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DisassociateEnclaveCertificateIamRoleRequest): any => ({ ...obj, }); @@ -417,6 +462,9 @@ export interface DisassociateEnclaveCertificateIamRoleResult { } export namespace DisassociateEnclaveCertificateIamRoleResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: DisassociateEnclaveCertificateIamRoleResult): any => ({ ...obj, }); @@ -430,6 +478,9 @@ export interface DisassociateIamInstanceProfileRequest { } export namespace DisassociateIamInstanceProfileRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DisassociateIamInstanceProfileRequest): any => ({ ...obj, }); @@ -443,6 +494,9 @@ export interface DisassociateIamInstanceProfileResult { } export namespace DisassociateIamInstanceProfileResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: DisassociateIamInstanceProfileResult): any => ({ ...obj, }); @@ -463,6 +517,9 @@ export interface DisassociateRouteTableRequest { } export namespace DisassociateRouteTableRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DisassociateRouteTableRequest): any => ({ ...obj, }); @@ -476,6 +533,9 @@ export interface DisassociateSubnetCidrBlockRequest { } export namespace DisassociateSubnetCidrBlockRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DisassociateSubnetCidrBlockRequest): any => ({ ...obj, }); @@ -494,6 +554,9 @@ export interface DisassociateSubnetCidrBlockResult { } export namespace DisassociateSubnetCidrBlockResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: DisassociateSubnetCidrBlockResult): any => ({ ...obj, }); @@ -524,6 +587,9 @@ export interface DisassociateTransitGatewayMulticastDomainRequest { } export namespace DisassociateTransitGatewayMulticastDomainRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DisassociateTransitGatewayMulticastDomainRequest): any => ({ ...obj, }); @@ -537,6 +603,9 @@ export interface DisassociateTransitGatewayMulticastDomainResult { } export namespace DisassociateTransitGatewayMulticastDomainResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: DisassociateTransitGatewayMulticastDomainResult): any => ({ ...obj, }); @@ -562,6 +631,9 @@ export interface DisassociateTransitGatewayRouteTableRequest { } export namespace DisassociateTransitGatewayRouteTableRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DisassociateTransitGatewayRouteTableRequest): any => ({ ...obj, }); @@ -575,6 +647,9 @@ export interface DisassociateTransitGatewayRouteTableResult { } export namespace DisassociateTransitGatewayRouteTableResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: DisassociateTransitGatewayRouteTableResult): any => ({ ...obj, }); @@ -588,6 +663,9 @@ export interface DisassociateVpcCidrBlockRequest { } export namespace DisassociateVpcCidrBlockRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DisassociateVpcCidrBlockRequest): any => ({ ...obj, }); @@ -611,6 +689,9 @@ export interface DisassociateVpcCidrBlockResult { } export namespace DisassociateVpcCidrBlockResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: DisassociateVpcCidrBlockResult): any => ({ ...obj, }); @@ -626,6 +707,9 @@ export interface EnableEbsEncryptionByDefaultRequest { } export namespace EnableEbsEncryptionByDefaultRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: EnableEbsEncryptionByDefaultRequest): any => ({ ...obj, }); @@ -639,6 +723,9 @@ export interface EnableEbsEncryptionByDefaultResult { } export namespace EnableEbsEncryptionByDefaultResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: EnableEbsEncryptionByDefaultResult): any => ({ ...obj, }); @@ -665,6 +752,9 @@ export interface EnableFastSnapshotRestoresRequest { } export namespace EnableFastSnapshotRestoresRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: EnableFastSnapshotRestoresRequest): any => ({ ...obj, }); @@ -743,6 +833,9 @@ export interface EnableFastSnapshotRestoreSuccessItem { } export namespace EnableFastSnapshotRestoreSuccessItem { + /** + * @internal + */ export const filterSensitiveLog = (obj: EnableFastSnapshotRestoreSuccessItem): any => ({ ...obj, }); @@ -764,6 +857,9 @@ export interface EnableFastSnapshotRestoreStateError { } export namespace EnableFastSnapshotRestoreStateError { + /** + * @internal + */ export const filterSensitiveLog = (obj: EnableFastSnapshotRestoreStateError): any => ({ ...obj, }); @@ -785,6 +881,9 @@ export interface EnableFastSnapshotRestoreStateErrorItem { } export namespace EnableFastSnapshotRestoreStateErrorItem { + /** + * @internal + */ export const filterSensitiveLog = (obj: EnableFastSnapshotRestoreStateErrorItem): any => ({ ...obj, }); @@ -806,6 +905,9 @@ export interface EnableFastSnapshotRestoreErrorItem { } export namespace EnableFastSnapshotRestoreErrorItem { + /** + * @internal + */ export const filterSensitiveLog = (obj: EnableFastSnapshotRestoreErrorItem): any => ({ ...obj, }); @@ -824,6 +926,9 @@ export interface EnableFastSnapshotRestoresResult { } export namespace EnableFastSnapshotRestoresResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: EnableFastSnapshotRestoresResult): any => ({ ...obj, }); @@ -837,6 +942,9 @@ export interface EnableSerialConsoleAccessRequest { } export namespace EnableSerialConsoleAccessRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: EnableSerialConsoleAccessRequest): any => ({ ...obj, }); @@ -852,6 +960,9 @@ export interface EnableSerialConsoleAccessResult { } export namespace EnableSerialConsoleAccessResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: EnableSerialConsoleAccessResult): any => ({ ...obj, }); @@ -877,6 +988,9 @@ export interface EnableTransitGatewayRouteTablePropagationRequest { } export namespace EnableTransitGatewayRouteTablePropagationRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: EnableTransitGatewayRouteTablePropagationRequest): any => ({ ...obj, }); @@ -890,6 +1004,9 @@ export interface EnableTransitGatewayRouteTablePropagationResult { } export namespace EnableTransitGatewayRouteTablePropagationResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: EnableTransitGatewayRouteTablePropagationResult): any => ({ ...obj, }); @@ -918,6 +1035,9 @@ export interface EnableVgwRoutePropagationRequest { } export namespace EnableVgwRoutePropagationRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: EnableVgwRoutePropagationRequest): any => ({ ...obj, }); @@ -938,6 +1058,9 @@ export interface EnableVolumeIORequest { } export namespace EnableVolumeIORequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: EnableVolumeIORequest): any => ({ ...obj, }); @@ -958,6 +1081,9 @@ export interface EnableVpcClassicLinkRequest { } export namespace EnableVpcClassicLinkRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: EnableVpcClassicLinkRequest): any => ({ ...obj, }); @@ -971,6 +1097,9 @@ export interface EnableVpcClassicLinkResult { } export namespace EnableVpcClassicLinkResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: EnableVpcClassicLinkResult): any => ({ ...obj, }); @@ -984,6 +1113,9 @@ export interface EnableVpcClassicLinkDnsSupportRequest { } export namespace EnableVpcClassicLinkDnsSupportRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: EnableVpcClassicLinkDnsSupportRequest): any => ({ ...obj, }); @@ -997,6 +1129,9 @@ export interface EnableVpcClassicLinkDnsSupportResult { } export namespace EnableVpcClassicLinkDnsSupportResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: EnableVpcClassicLinkDnsSupportResult): any => ({ ...obj, }); @@ -1015,6 +1150,9 @@ export interface ExportClientVpnClientCertificateRevocationListRequest { } export namespace ExportClientVpnClientCertificateRevocationListRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ExportClientVpnClientCertificateRevocationListRequest): any => ({ ...obj, }); @@ -1038,6 +1176,9 @@ export interface ClientCertificateRevocationListStatus { } export namespace ClientCertificateRevocationListStatus { + /** + * @internal + */ export const filterSensitiveLog = (obj: ClientCertificateRevocationListStatus): any => ({ ...obj, }); @@ -1056,6 +1197,9 @@ export interface ExportClientVpnClientCertificateRevocationListResult { } export namespace ExportClientVpnClientCertificateRevocationListResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: ExportClientVpnClientCertificateRevocationListResult): any => ({ ...obj, }); @@ -1074,6 +1218,9 @@ export interface ExportClientVpnClientConfigurationRequest { } export namespace ExportClientVpnClientConfigurationRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ExportClientVpnClientConfigurationRequest): any => ({ ...obj, }); @@ -1087,6 +1234,9 @@ export interface ExportClientVpnClientConfigurationResult { } export namespace ExportClientVpnClientConfigurationResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: ExportClientVpnClientConfigurationResult): any => ({ ...obj, }); @@ -1108,6 +1258,9 @@ export interface ExportTaskS3LocationRequest { } export namespace ExportTaskS3LocationRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ExportTaskS3LocationRequest): any => ({ ...obj, }); @@ -1160,6 +1313,9 @@ export interface ExportImageRequest { } export namespace ExportImageRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ExportImageRequest): any => ({ ...obj, }); @@ -1220,6 +1376,9 @@ export interface ExportImageResult { } export namespace ExportImageResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: ExportImageResult): any => ({ ...obj, }); @@ -1289,6 +1448,9 @@ export interface ExportTransitGatewayRoutesRequest { } export namespace ExportTransitGatewayRoutesRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ExportTransitGatewayRoutesRequest): any => ({ ...obj, }); @@ -1303,6 +1465,9 @@ export interface ExportTransitGatewayRoutesResult { } export namespace ExportTransitGatewayRoutesResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: ExportTransitGatewayRoutesResult): any => ({ ...obj, }); @@ -1322,6 +1487,9 @@ export interface GetAssociatedEnclaveCertificateIamRolesRequest { } export namespace GetAssociatedEnclaveCertificateIamRolesRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetAssociatedEnclaveCertificateIamRolesRequest): any => ({ ...obj, }); @@ -1355,6 +1523,9 @@ export interface AssociatedRole { } export namespace AssociatedRole { + /** + * @internal + */ export const filterSensitiveLog = (obj: AssociatedRole): any => ({ ...obj, }); @@ -1368,6 +1539,9 @@ export interface GetAssociatedEnclaveCertificateIamRolesResult { } export namespace GetAssociatedEnclaveCertificateIamRolesResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetAssociatedEnclaveCertificateIamRolesResult): any => ({ ...obj, }); @@ -1399,6 +1573,9 @@ export interface GetAssociatedIpv6PoolCidrsRequest { } export namespace GetAssociatedIpv6PoolCidrsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetAssociatedIpv6PoolCidrsRequest): any => ({ ...obj, }); @@ -1420,6 +1597,9 @@ export interface Ipv6CidrAssociation { } export namespace Ipv6CidrAssociation { + /** + * @internal + */ export const filterSensitiveLog = (obj: Ipv6CidrAssociation): any => ({ ...obj, }); @@ -1438,6 +1618,9 @@ export interface GetAssociatedIpv6PoolCidrsResult { } export namespace GetAssociatedIpv6PoolCidrsResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetAssociatedIpv6PoolCidrsResult): any => ({ ...obj, }); @@ -1467,6 +1650,9 @@ export interface GetCapacityReservationUsageRequest { } export namespace GetCapacityReservationUsageRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetCapacityReservationUsageRequest): any => ({ ...obj, }); @@ -1488,6 +1674,9 @@ export interface InstanceUsage { } export namespace InstanceUsage { + /** + * @internal + */ export const filterSensitiveLog = (obj: InstanceUsage): any => ({ ...obj, }); @@ -1558,6 +1747,9 @@ export interface GetCapacityReservationUsageResult { } export namespace GetCapacityReservationUsageResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetCapacityReservationUsageResult): any => ({ ...obj, }); @@ -1622,6 +1814,9 @@ export interface GetCoipPoolUsageRequest { } export namespace GetCoipPoolUsageRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetCoipPoolUsageRequest): any => ({ ...obj, }); @@ -1653,6 +1848,9 @@ export interface CoipAddressUsage { } export namespace CoipAddressUsage { + /** + * @internal + */ export const filterSensitiveLog = (obj: CoipAddressUsage): any => ({ ...obj, }); @@ -1676,6 +1874,9 @@ export interface GetCoipPoolUsageResult { } export namespace GetCoipPoolUsageResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetCoipPoolUsageResult): any => ({ ...obj, }); @@ -1702,6 +1903,9 @@ export interface GetConsoleOutputRequest { } export namespace GetConsoleOutputRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetConsoleOutputRequest): any => ({ ...obj, }); @@ -1726,6 +1930,9 @@ export interface GetConsoleOutputResult { } export namespace GetConsoleOutputResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetConsoleOutputResult): any => ({ ...obj, }); @@ -1752,6 +1959,9 @@ export interface GetConsoleScreenshotRequest { } export namespace GetConsoleScreenshotRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetConsoleScreenshotRequest): any => ({ ...obj, }); @@ -1770,6 +1980,9 @@ export interface GetConsoleScreenshotResult { } export namespace GetConsoleScreenshotResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetConsoleScreenshotResult): any => ({ ...obj, }); @@ -1792,6 +2005,9 @@ export interface GetDefaultCreditSpecificationRequest { } export namespace GetDefaultCreditSpecificationRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetDefaultCreditSpecificationRequest): any => ({ ...obj, }); @@ -1813,6 +2029,9 @@ export interface InstanceFamilyCreditSpecification { } export namespace InstanceFamilyCreditSpecification { + /** + * @internal + */ export const filterSensitiveLog = (obj: InstanceFamilyCreditSpecification): any => ({ ...obj, }); @@ -1826,6 +2045,9 @@ export interface GetDefaultCreditSpecificationResult { } export namespace GetDefaultCreditSpecificationResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetDefaultCreditSpecificationResult): any => ({ ...obj, }); @@ -1841,6 +2063,9 @@ export interface GetEbsDefaultKmsKeyIdRequest { } export namespace GetEbsDefaultKmsKeyIdRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetEbsDefaultKmsKeyIdRequest): any => ({ ...obj, }); @@ -1854,6 +2079,9 @@ export interface GetEbsDefaultKmsKeyIdResult { } export namespace GetEbsDefaultKmsKeyIdResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetEbsDefaultKmsKeyIdResult): any => ({ ...obj, }); @@ -1869,6 +2097,9 @@ export interface GetEbsEncryptionByDefaultRequest { } export namespace GetEbsEncryptionByDefaultRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetEbsEncryptionByDefaultRequest): any => ({ ...obj, }); @@ -1882,6 +2113,9 @@ export interface GetEbsEncryptionByDefaultResult { } export namespace GetEbsEncryptionByDefaultResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetEbsEncryptionByDefaultResult): any => ({ ...obj, }); @@ -1920,6 +2154,9 @@ export interface AthenaIntegration { } export namespace AthenaIntegration { + /** + * @internal + */ export const filterSensitiveLog = (obj: AthenaIntegration): any => ({ ...obj, }); @@ -1936,6 +2173,9 @@ export interface IntegrateServices { } export namespace IntegrateServices { + /** + * @internal + */ export const filterSensitiveLog = (obj: IntegrateServices): any => ({ ...obj, }); @@ -1966,6 +2206,9 @@ export interface GetFlowLogsIntegrationTemplateRequest { } export namespace GetFlowLogsIntegrationTemplateRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetFlowLogsIntegrationTemplateRequest): any => ({ ...obj, }); @@ -1979,6 +2222,9 @@ export interface GetFlowLogsIntegrationTemplateResult { } export namespace GetFlowLogsIntegrationTemplateResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetFlowLogsIntegrationTemplateResult): any => ({ ...obj, }); @@ -2007,6 +2253,9 @@ export interface GetGroupsForCapacityReservationRequest { } export namespace GetGroupsForCapacityReservationRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetGroupsForCapacityReservationRequest): any => ({ ...obj, }); @@ -2028,6 +2277,9 @@ export interface CapacityReservationGroup { } export namespace CapacityReservationGroup { + /** + * @internal + */ export const filterSensitiveLog = (obj: CapacityReservationGroup): any => ({ ...obj, }); @@ -2046,6 +2298,9 @@ export interface GetGroupsForCapacityReservationResult { } export namespace GetGroupsForCapacityReservationResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetGroupsForCapacityReservationResult): any => ({ ...obj, }); @@ -2064,6 +2319,9 @@ export interface GetHostReservationPurchasePreviewRequest { } export namespace GetHostReservationPurchasePreviewRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetHostReservationPurchasePreviewRequest): any => ({ ...obj, }); @@ -2118,6 +2376,9 @@ export interface Purchase { } export namespace Purchase { + /** + * @internal + */ export const filterSensitiveLog = (obj: Purchase): any => ({ ...obj, }); @@ -2149,6 +2410,9 @@ export interface GetHostReservationPurchasePreviewResult { } export namespace GetHostReservationPurchasePreviewResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetHostReservationPurchasePreviewResult): any => ({ ...obj, }); @@ -2170,6 +2434,9 @@ export interface GetLaunchTemplateDataRequest { } export namespace GetLaunchTemplateDataRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetLaunchTemplateDataRequest): any => ({ ...obj, }); @@ -2183,6 +2450,9 @@ export interface GetLaunchTemplateDataResult { } export namespace GetLaunchTemplateDataResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetLaunchTemplateDataResult): any => ({ ...obj, }); @@ -2214,6 +2484,9 @@ export interface GetManagedPrefixListAssociationsRequest { } export namespace GetManagedPrefixListAssociationsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetManagedPrefixListAssociationsRequest): any => ({ ...obj, }); @@ -2235,6 +2508,9 @@ export interface PrefixListAssociation { } export namespace PrefixListAssociation { + /** + * @internal + */ export const filterSensitiveLog = (obj: PrefixListAssociation): any => ({ ...obj, }); @@ -2253,6 +2529,9 @@ export interface GetManagedPrefixListAssociationsResult { } export namespace GetManagedPrefixListAssociationsResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetManagedPrefixListAssociationsResult): any => ({ ...obj, }); @@ -2289,6 +2568,9 @@ export interface GetManagedPrefixListEntriesRequest { } export namespace GetManagedPrefixListEntriesRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetManagedPrefixListEntriesRequest): any => ({ ...obj, }); @@ -2310,6 +2592,9 @@ export interface PrefixListEntry { } export namespace PrefixListEntry { + /** + * @internal + */ export const filterSensitiveLog = (obj: PrefixListEntry): any => ({ ...obj, }); @@ -2328,6 +2613,9 @@ export interface GetManagedPrefixListEntriesResult { } export namespace GetManagedPrefixListEntriesResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetManagedPrefixListEntriesResult): any => ({ ...obj, }); @@ -2348,6 +2636,9 @@ export interface GetPasswordDataRequest { } export namespace GetPasswordDataRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetPasswordDataRequest): any => ({ ...obj, }); @@ -2372,6 +2663,9 @@ export interface GetPasswordDataResult { } export namespace GetPasswordDataResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetPasswordDataResult): any => ({ ...obj, }); @@ -2401,6 +2695,9 @@ export interface GetReservedInstancesExchangeQuoteRequest { } export namespace GetReservedInstancesExchangeQuoteRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetReservedInstancesExchangeQuoteRequest): any => ({ ...obj, }); @@ -2427,6 +2724,9 @@ export interface ReservationValue { } export namespace ReservationValue { + /** + * @internal + */ export const filterSensitiveLog = (obj: ReservationValue): any => ({ ...obj, }); @@ -2448,6 +2748,9 @@ export interface ReservedInstanceReservationValue { } export namespace ReservedInstanceReservationValue { + /** + * @internal + */ export const filterSensitiveLog = (obj: ReservedInstanceReservationValue): any => ({ ...obj, }); @@ -2470,6 +2773,9 @@ export interface TargetConfiguration { } export namespace TargetConfiguration { + /** + * @internal + */ export const filterSensitiveLog = (obj: TargetConfiguration): any => ({ ...obj, }); @@ -2492,6 +2798,9 @@ export interface TargetReservationValue { } export namespace TargetReservationValue { + /** + * @internal + */ export const filterSensitiveLog = (obj: TargetReservationValue): any => ({ ...obj, }); @@ -2548,6 +2857,9 @@ export interface GetReservedInstancesExchangeQuoteResult { } export namespace GetReservedInstancesExchangeQuoteResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetReservedInstancesExchangeQuoteResult): any => ({ ...obj, }); @@ -2561,6 +2873,9 @@ export interface GetSerialConsoleAccessStatusRequest { } export namespace GetSerialConsoleAccessStatusRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetSerialConsoleAccessStatusRequest): any => ({ ...obj, }); @@ -2576,6 +2891,9 @@ export interface GetSerialConsoleAccessStatusResult { } export namespace GetSerialConsoleAccessStatusResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetSerialConsoleAccessStatusResult): any => ({ ...obj, }); @@ -2618,6 +2936,9 @@ export interface GetTransitGatewayAttachmentPropagationsRequest { } export namespace GetTransitGatewayAttachmentPropagationsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetTransitGatewayAttachmentPropagationsRequest): any => ({ ...obj, }); @@ -2639,6 +2960,9 @@ export interface TransitGatewayAttachmentPropagation { } export namespace TransitGatewayAttachmentPropagation { + /** + * @internal + */ export const filterSensitiveLog = (obj: TransitGatewayAttachmentPropagation): any => ({ ...obj, }); @@ -2657,6 +2981,9 @@ export interface GetTransitGatewayAttachmentPropagationsResult { } export namespace GetTransitGatewayAttachmentPropagationsResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetTransitGatewayAttachmentPropagationsResult): any => ({ ...obj, }); @@ -2719,6 +3046,9 @@ export interface GetTransitGatewayMulticastDomainAssociationsRequest { } export namespace GetTransitGatewayMulticastDomainAssociationsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetTransitGatewayMulticastDomainAssociationsRequest): any => ({ ...obj, }); @@ -2755,6 +3085,9 @@ export interface TransitGatewayMulticastDomainAssociation { } export namespace TransitGatewayMulticastDomainAssociation { + /** + * @internal + */ export const filterSensitiveLog = (obj: TransitGatewayMulticastDomainAssociation): any => ({ ...obj, }); @@ -2773,6 +3106,9 @@ export interface GetTransitGatewayMulticastDomainAssociationsResult { } export namespace GetTransitGatewayMulticastDomainAssociationsResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetTransitGatewayMulticastDomainAssociationsResult): any => ({ ...obj, }); @@ -2841,6 +3177,9 @@ export interface GetTransitGatewayPrefixListReferencesRequest { } export namespace GetTransitGatewayPrefixListReferencesRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetTransitGatewayPrefixListReferencesRequest): any => ({ ...obj, }); @@ -2859,6 +3198,9 @@ export interface GetTransitGatewayPrefixListReferencesResult { } export namespace GetTransitGatewayPrefixListReferencesResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetTransitGatewayPrefixListReferencesResult): any => ({ ...obj, }); @@ -2911,6 +3253,9 @@ export interface GetTransitGatewayRouteTableAssociationsRequest { } export namespace GetTransitGatewayRouteTableAssociationsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetTransitGatewayRouteTableAssociationsRequest): any => ({ ...obj, }); @@ -2942,6 +3287,9 @@ export interface TransitGatewayRouteTableAssociation { } export namespace TransitGatewayRouteTableAssociation { + /** + * @internal + */ export const filterSensitiveLog = (obj: TransitGatewayRouteTableAssociation): any => ({ ...obj, }); @@ -2960,6 +3308,9 @@ export interface GetTransitGatewayRouteTableAssociationsResult { } export namespace GetTransitGatewayRouteTableAssociationsResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetTransitGatewayRouteTableAssociationsResult): any => ({ ...obj, }); @@ -3012,6 +3363,9 @@ export interface GetTransitGatewayRouteTablePropagationsRequest { } export namespace GetTransitGatewayRouteTablePropagationsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetTransitGatewayRouteTablePropagationsRequest): any => ({ ...obj, }); @@ -3043,6 +3397,9 @@ export interface TransitGatewayRouteTablePropagation { } export namespace TransitGatewayRouteTablePropagation { + /** + * @internal + */ export const filterSensitiveLog = (obj: TransitGatewayRouteTablePropagation): any => ({ ...obj, }); @@ -3061,6 +3418,9 @@ export interface GetTransitGatewayRouteTablePropagationsResult { } export namespace GetTransitGatewayRouteTablePropagationsResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetTransitGatewayRouteTablePropagationsResult): any => ({ ...obj, }); @@ -3085,6 +3445,9 @@ export interface ImportClientVpnClientCertificateRevocationListRequest { } export namespace ImportClientVpnClientCertificateRevocationListRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ImportClientVpnClientCertificateRevocationListRequest): any => ({ ...obj, }); @@ -3098,6 +3461,9 @@ export interface ImportClientVpnClientCertificateRevocationListResult { } export namespace ImportClientVpnClientCertificateRevocationListResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: ImportClientVpnClientCertificateRevocationListResult): any => ({ ...obj, }); @@ -3129,6 +3495,9 @@ export interface ClientData { } export namespace ClientData { + /** + * @internal + */ export const filterSensitiveLog = (obj: ClientData): any => ({ ...obj, }); @@ -3150,6 +3519,9 @@ export interface UserBucket { } export namespace UserBucket { + /** + * @internal + */ export const filterSensitiveLog = (obj: UserBucket): any => ({ ...obj, }); @@ -3194,6 +3566,9 @@ export interface ImageDiskContainer { } export namespace ImageDiskContainer { + /** + * @internal + */ export const filterSensitiveLog = (obj: ImageDiskContainer): any => ({ ...obj, }); @@ -3210,6 +3585,9 @@ export interface ImportImageLicenseConfigurationRequest { } export namespace ImportImageLicenseConfigurationRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ImportImageLicenseConfigurationRequest): any => ({ ...obj, }); @@ -3326,6 +3704,9 @@ export interface ImportImageRequest { } export namespace ImportImageRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ImportImageRequest): any => ({ ...obj, }); @@ -3410,6 +3791,9 @@ export interface ImportImageResult { } export namespace ImportImageResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: ImportImageResult): any => ({ ...obj, }); @@ -3440,6 +3824,9 @@ export interface DiskImageDetail { } export namespace DiskImageDetail { + /** + * @internal + */ export const filterSensitiveLog = (obj: DiskImageDetail): any => ({ ...obj, }); @@ -3456,6 +3843,9 @@ export interface VolumeDetail { } export namespace VolumeDetail { + /** + * @internal + */ export const filterSensitiveLog = (obj: VolumeDetail): any => ({ ...obj, }); @@ -3482,6 +3872,9 @@ export interface DiskImage { } export namespace DiskImage { + /** + * @internal + */ export const filterSensitiveLog = (obj: DiskImage): any => ({ ...obj, }); @@ -3499,6 +3892,9 @@ export interface UserData { } export namespace UserData { + /** + * @internal + */ export const filterSensitiveLog = (obj: UserData): any => ({ ...obj, }); @@ -3567,6 +3963,9 @@ export interface ImportInstanceLaunchSpecification { } export namespace ImportInstanceLaunchSpecification { + /** + * @internal + */ export const filterSensitiveLog = (obj: ImportInstanceLaunchSpecification): any => ({ ...obj, ...(obj.UserData && { UserData: SENSITIVE_STRING }), @@ -3603,6 +4002,9 @@ export interface ImportInstanceRequest { } export namespace ImportInstanceRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ImportInstanceRequest): any => ({ ...obj, ...(obj.LaunchSpecification && { @@ -3619,6 +4021,9 @@ export interface ImportInstanceResult { } export namespace ImportInstanceResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: ImportInstanceResult): any => ({ ...obj, }); @@ -3649,6 +4054,9 @@ export interface ImportKeyPairRequest { } export namespace ImportKeyPairRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ImportKeyPairRequest): any => ({ ...obj, }); @@ -3677,6 +4085,9 @@ export interface ImportKeyPairResult { } export namespace ImportKeyPairResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: ImportKeyPairResult): any => ({ ...obj, }); @@ -3711,6 +4122,9 @@ export interface SnapshotDiskContainer { } export namespace SnapshotDiskContainer { + /** + * @internal + */ export const filterSensitiveLog = (obj: SnapshotDiskContainer): any => ({ ...obj, }); @@ -3790,6 +4204,9 @@ export interface ImportSnapshotRequest { } export namespace ImportSnapshotRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ImportSnapshotRequest): any => ({ ...obj, }); @@ -3818,6 +4235,9 @@ export interface ImportSnapshotResult { } export namespace ImportSnapshotResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: ImportSnapshotResult): any => ({ ...obj, }); @@ -3853,6 +4273,9 @@ export interface ImportVolumeRequest { } export namespace ImportVolumeRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ImportVolumeRequest): any => ({ ...obj, }); @@ -3866,6 +4289,9 @@ export interface ImportVolumeResult { } export namespace ImportVolumeResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: ImportVolumeResult): any => ({ ...obj, }); @@ -3891,6 +4317,9 @@ export interface ModifyAddressAttributeRequest { } export namespace ModifyAddressAttributeRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ModifyAddressAttributeRequest): any => ({ ...obj, }); @@ -3904,6 +4333,9 @@ export interface ModifyAddressAttributeResult { } export namespace ModifyAddressAttributeResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: ModifyAddressAttributeResult): any => ({ ...obj, }); @@ -3933,6 +4365,9 @@ export interface ModifyAvailabilityZoneGroupRequest { } export namespace ModifyAvailabilityZoneGroupRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ModifyAvailabilityZoneGroupRequest): any => ({ ...obj, }); @@ -3946,6 +4381,9 @@ export interface ModifyAvailabilityZoneGroupResult { } export namespace ModifyAvailabilityZoneGroupResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: ModifyAvailabilityZoneGroupResult): any => ({ ...obj, }); @@ -4006,6 +4444,9 @@ export interface ModifyCapacityReservationRequest { } export namespace ModifyCapacityReservationRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ModifyCapacityReservationRequest): any => ({ ...obj, }); @@ -4019,6 +4460,9 @@ export interface ModifyCapacityReservationResult { } export namespace ModifyCapacityReservationResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: ModifyCapacityReservationResult): any => ({ ...obj, }); @@ -4043,6 +4487,9 @@ export interface DnsServersOptionsModifyStructure { } export namespace DnsServersOptionsModifyStructure { + /** + * @internal + */ export const filterSensitiveLog = (obj: DnsServersOptionsModifyStructure): any => ({ ...obj, }); @@ -4134,6 +4581,9 @@ export interface ModifyClientVpnEndpointRequest { } export namespace ModifyClientVpnEndpointRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ModifyClientVpnEndpointRequest): any => ({ ...obj, }); @@ -4147,6 +4597,9 @@ export interface ModifyClientVpnEndpointResult { } export namespace ModifyClientVpnEndpointResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: ModifyClientVpnEndpointResult): any => ({ ...obj, }); @@ -4174,6 +4627,9 @@ export interface ModifyDefaultCreditSpecificationRequest { } export namespace ModifyDefaultCreditSpecificationRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ModifyDefaultCreditSpecificationRequest): any => ({ ...obj, }); @@ -4187,6 +4643,9 @@ export interface ModifyDefaultCreditSpecificationResult { } export namespace ModifyDefaultCreditSpecificationResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: ModifyDefaultCreditSpecificationResult): any => ({ ...obj, }); @@ -4227,6 +4686,9 @@ export interface ModifyEbsDefaultKmsKeyIdRequest { } export namespace ModifyEbsDefaultKmsKeyIdRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ModifyEbsDefaultKmsKeyIdRequest): any => ({ ...obj, }); @@ -4240,6 +4702,9 @@ export interface ModifyEbsDefaultKmsKeyIdResult { } export namespace ModifyEbsDefaultKmsKeyIdResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: ModifyEbsDefaultKmsKeyIdResult): any => ({ ...obj, }); @@ -4276,6 +4741,9 @@ export interface ModifyFleetRequest { } export namespace ModifyFleetRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ModifyFleetRequest): any => ({ ...obj, }); @@ -4289,6 +4757,9 @@ export interface ModifyFleetResult { } export namespace ModifyFleetResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: ModifyFleetResult): any => ({ ...obj, }); @@ -4310,6 +4781,9 @@ export interface LoadPermissionRequest { } export namespace LoadPermissionRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: LoadPermissionRequest): any => ({ ...obj, }); @@ -4331,6 +4805,9 @@ export interface LoadPermissionModifications { } export namespace LoadPermissionModifications { + /** + * @internal + */ export const filterSensitiveLog = (obj: LoadPermissionModifications): any => ({ ...obj, }); @@ -4394,6 +4871,9 @@ export interface ModifyFpgaImageAttributeRequest { } export namespace ModifyFpgaImageAttributeRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ModifyFpgaImageAttributeRequest): any => ({ ...obj, }); @@ -4407,6 +4887,9 @@ export interface ModifyFpgaImageAttributeResult { } export namespace ModifyFpgaImageAttributeResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: ModifyFpgaImageAttributeResult): any => ({ ...obj, }); @@ -4455,6 +4938,9 @@ export interface ModifyHostsRequest { } export namespace ModifyHostsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ModifyHostsRequest): any => ({ ...obj, }); @@ -4474,6 +4960,9 @@ export interface ModifyHostsResult { } export namespace ModifyHostsResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: ModifyHostsResult): any => ({ ...obj, }); @@ -4510,6 +4999,9 @@ export interface ModifyIdentityIdFormatRequest { } export namespace ModifyIdentityIdFormatRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ModifyIdentityIdFormatRequest): any => ({ ...obj, }); @@ -4539,6 +5031,9 @@ export interface ModifyIdFormatRequest { } export namespace ModifyIdFormatRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ModifyIdFormatRequest): any => ({ ...obj, }); @@ -4560,6 +5055,9 @@ export interface LaunchPermissionModifications { } export namespace LaunchPermissionModifications { + /** + * @internal + */ export const filterSensitiveLog = (obj: LaunchPermissionModifications): any => ({ ...obj, }); @@ -4628,6 +5126,9 @@ export interface ModifyImageAttributeRequest { } export namespace ModifyImageAttributeRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ModifyImageAttributeRequest): any => ({ ...obj, }); @@ -4650,6 +5151,9 @@ export interface EbsInstanceBlockDeviceSpecification { } export namespace EbsInstanceBlockDeviceSpecification { + /** + * @internal + */ export const filterSensitiveLog = (obj: EbsInstanceBlockDeviceSpecification): any => ({ ...obj, }); @@ -4682,6 +5186,9 @@ export interface InstanceBlockDeviceMappingSpecification { } export namespace InstanceBlockDeviceMappingSpecification { + /** + * @internal + */ export const filterSensitiveLog = (obj: InstanceBlockDeviceMappingSpecification): any => ({ ...obj, }); @@ -4692,6 +5199,9 @@ export interface BlobAttributeValue { } export namespace BlobAttributeValue { + /** + * @internal + */ export const filterSensitiveLog = (obj: BlobAttributeValue): any => ({ ...obj, }); @@ -4817,6 +5327,9 @@ export interface ModifyInstanceAttributeRequest { } export namespace ModifyInstanceAttributeRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ModifyInstanceAttributeRequest): any => ({ ...obj, }); @@ -4857,6 +5370,9 @@ export interface CapacityReservationSpecification { } export namespace CapacityReservationSpecification { + /** + * @internal + */ export const filterSensitiveLog = (obj: CapacityReservationSpecification): any => ({ ...obj, }); @@ -4880,6 +5396,9 @@ export interface ModifyInstanceCapacityReservationAttributesRequest { } export namespace ModifyInstanceCapacityReservationAttributesRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ModifyInstanceCapacityReservationAttributesRequest): any => ({ ...obj, }); @@ -4893,6 +5412,9 @@ export interface ModifyInstanceCapacityReservationAttributesResult { } export namespace ModifyInstanceCapacityReservationAttributesResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: ModifyInstanceCapacityReservationAttributesResult): any => ({ ...obj, }); @@ -4915,6 +5437,9 @@ export interface InstanceCreditSpecificationRequest { } export namespace InstanceCreditSpecificationRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: InstanceCreditSpecificationRequest): any => ({ ...obj, }); @@ -4942,6 +5467,9 @@ export interface ModifyInstanceCreditSpecificationRequest { } export namespace ModifyInstanceCreditSpecificationRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ModifyInstanceCreditSpecificationRequest): any => ({ ...obj, }); @@ -4959,6 +5487,9 @@ export interface SuccessfulInstanceCreditSpecificationItem { } export namespace SuccessfulInstanceCreditSpecificationItem { + /** + * @internal + */ export const filterSensitiveLog = (obj: SuccessfulInstanceCreditSpecificationItem): any => ({ ...obj, }); @@ -4988,6 +5519,9 @@ export interface UnsuccessfulInstanceCreditSpecificationItemError { } export namespace UnsuccessfulInstanceCreditSpecificationItemError { + /** + * @internal + */ export const filterSensitiveLog = (obj: UnsuccessfulInstanceCreditSpecificationItemError): any => ({ ...obj, }); @@ -5011,6 +5545,9 @@ export interface UnsuccessfulInstanceCreditSpecificationItem { } export namespace UnsuccessfulInstanceCreditSpecificationItem { + /** + * @internal + */ export const filterSensitiveLog = (obj: UnsuccessfulInstanceCreditSpecificationItem): any => ({ ...obj, }); @@ -5031,6 +5568,9 @@ export interface ModifyInstanceCreditSpecificationResult { } export namespace ModifyInstanceCreditSpecificationResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: ModifyInstanceCreditSpecificationResult): any => ({ ...obj, }); @@ -5061,6 +5601,9 @@ export interface ModifyInstanceEventStartTimeRequest { } export namespace ModifyInstanceEventStartTimeRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ModifyInstanceEventStartTimeRequest): any => ({ ...obj, }); @@ -5074,6 +5617,9 @@ export interface ModifyInstanceEventStartTimeResult { } export namespace ModifyInstanceEventStartTimeResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: ModifyInstanceEventStartTimeResult): any => ({ ...obj, }); @@ -5124,6 +5670,9 @@ export interface ModifyInstanceMetadataOptionsRequest { } export namespace ModifyInstanceMetadataOptionsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ModifyInstanceMetadataOptionsRequest): any => ({ ...obj, }); @@ -5142,6 +5691,9 @@ export interface ModifyInstanceMetadataOptionsResult { } export namespace ModifyInstanceMetadataOptionsResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: ModifyInstanceMetadataOptionsResult): any => ({ ...obj, }); @@ -5192,6 +5744,9 @@ export interface ModifyInstancePlacementRequest { } export namespace ModifyInstancePlacementRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ModifyInstancePlacementRequest): any => ({ ...obj, }); @@ -5205,6 +5760,9 @@ export interface ModifyInstancePlacementResult { } export namespace ModifyInstancePlacementResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: ModifyInstancePlacementResult): any => ({ ...obj, }); @@ -5246,6 +5804,9 @@ export interface ModifyLaunchTemplateRequest { } export namespace ModifyLaunchTemplateRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ModifyLaunchTemplateRequest): any => ({ ...obj, }); @@ -5259,6 +5820,9 @@ export interface ModifyLaunchTemplateResult { } export namespace ModifyLaunchTemplateResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: ModifyLaunchTemplateResult): any => ({ ...obj, }); @@ -5275,6 +5839,9 @@ export interface RemovePrefixListEntry { } export namespace RemovePrefixListEntry { + /** + * @internal + */ export const filterSensitiveLog = (obj: RemovePrefixListEntry): any => ({ ...obj, }); @@ -5315,6 +5882,9 @@ export interface ModifyManagedPrefixListRequest { } export namespace ModifyManagedPrefixListRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ModifyManagedPrefixListRequest): any => ({ ...obj, }); @@ -5328,6 +5898,9 @@ export interface ModifyManagedPrefixListResult { } export namespace ModifyManagedPrefixListResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: ModifyManagedPrefixListResult): any => ({ ...obj, }); @@ -5349,6 +5922,9 @@ export interface NetworkInterfaceAttachmentChanges { } export namespace NetworkInterfaceAttachmentChanges { + /** + * @internal + */ export const filterSensitiveLog = (obj: NetworkInterfaceAttachmentChanges): any => ({ ...obj, }); @@ -5397,6 +5973,9 @@ export interface ModifyNetworkInterfaceAttributeRequest { } export namespace ModifyNetworkInterfaceAttributeRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ModifyNetworkInterfaceAttributeRequest): any => ({ ...obj, }); @@ -5424,6 +6003,9 @@ export interface ModifyReservedInstancesRequest { } export namespace ModifyReservedInstancesRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ModifyReservedInstancesRequest): any => ({ ...obj, }); @@ -5440,6 +6022,9 @@ export interface ModifyReservedInstancesResult { } export namespace ModifyReservedInstancesResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: ModifyReservedInstancesResult): any => ({ ...obj, }); @@ -5461,6 +6046,9 @@ export interface CreateVolumePermissionModifications { } export namespace CreateVolumePermissionModifications { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateVolumePermissionModifications): any => ({ ...obj, }); @@ -5506,6 +6094,9 @@ export interface ModifySnapshotAttributeRequest { } export namespace ModifySnapshotAttributeRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ModifySnapshotAttributeRequest): any => ({ ...obj, }); @@ -5542,6 +6133,9 @@ export interface ModifySpotFleetRequestRequest { } export namespace ModifySpotFleetRequestRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ModifySpotFleetRequestRequest): any => ({ ...obj, }); @@ -5558,6 +6152,9 @@ export interface ModifySpotFleetRequestResponse { } export namespace ModifySpotFleetRequestResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ModifySpotFleetRequestResponse): any => ({ ...obj, }); @@ -5601,6 +6198,9 @@ export interface ModifySubnetAttributeRequest { } export namespace ModifySubnetAttributeRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ModifySubnetAttributeRequest): any => ({ ...obj, }); @@ -5631,6 +6231,9 @@ export interface ModifyTrafficMirrorFilterNetworkServicesRequest { } export namespace ModifyTrafficMirrorFilterNetworkServicesRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ModifyTrafficMirrorFilterNetworkServicesRequest): any => ({ ...obj, }); @@ -5644,6 +6247,9 @@ export interface ModifyTrafficMirrorFilterNetworkServicesResult { } export namespace ModifyTrafficMirrorFilterNetworkServicesResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: ModifyTrafficMirrorFilterNetworkServicesResult): any => ({ ...obj, }); @@ -5718,6 +6324,9 @@ export interface ModifyTrafficMirrorFilterRuleRequest { } export namespace ModifyTrafficMirrorFilterRuleRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ModifyTrafficMirrorFilterRuleRequest): any => ({ ...obj, }); @@ -5731,6 +6340,9 @@ export interface ModifyTrafficMirrorFilterRuleResult { } export namespace ModifyTrafficMirrorFilterRuleResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: ModifyTrafficMirrorFilterRuleResult): any => ({ ...obj, }); @@ -5790,6 +6402,9 @@ export interface ModifyTrafficMirrorSessionRequest { } export namespace ModifyTrafficMirrorSessionRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ModifyTrafficMirrorSessionRequest): any => ({ ...obj, }); @@ -5803,6 +6418,9 @@ export interface ModifyTrafficMirrorSessionResult { } export namespace ModifyTrafficMirrorSessionResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: ModifyTrafficMirrorSessionResult): any => ({ ...obj, }); @@ -5859,6 +6477,9 @@ export interface ModifyTransitGatewayOptions { } export namespace ModifyTransitGatewayOptions { + /** + * @internal + */ export const filterSensitiveLog = (obj: ModifyTransitGatewayOptions): any => ({ ...obj, }); @@ -5889,6 +6510,9 @@ export interface ModifyTransitGatewayRequest { } export namespace ModifyTransitGatewayRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ModifyTransitGatewayRequest): any => ({ ...obj, }); @@ -5902,6 +6526,9 @@ export interface ModifyTransitGatewayResult { } export namespace ModifyTransitGatewayResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: ModifyTransitGatewayResult): any => ({ ...obj, }); @@ -5937,6 +6564,9 @@ export interface ModifyTransitGatewayPrefixListReferenceRequest { } export namespace ModifyTransitGatewayPrefixListReferenceRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ModifyTransitGatewayPrefixListReferenceRequest): any => ({ ...obj, }); @@ -5950,6 +6580,9 @@ export interface ModifyTransitGatewayPrefixListReferenceResult { } export namespace ModifyTransitGatewayPrefixListReferenceResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: ModifyTransitGatewayPrefixListReferenceResult): any => ({ ...obj, }); @@ -5976,6 +6609,9 @@ export interface ModifyTransitGatewayVpcAttachmentRequestOptions { } export namespace ModifyTransitGatewayVpcAttachmentRequestOptions { + /** + * @internal + */ export const filterSensitiveLog = (obj: ModifyTransitGatewayVpcAttachmentRequestOptions): any => ({ ...obj, }); @@ -6014,6 +6650,9 @@ export interface ModifyTransitGatewayVpcAttachmentRequest { } export namespace ModifyTransitGatewayVpcAttachmentRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ModifyTransitGatewayVpcAttachmentRequest): any => ({ ...obj, }); @@ -6027,6 +6666,9 @@ export interface ModifyTransitGatewayVpcAttachmentResult { } export namespace ModifyTransitGatewayVpcAttachmentResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: ModifyTransitGatewayVpcAttachmentResult): any => ({ ...obj, }); @@ -6118,6 +6760,9 @@ export interface ModifyVolumeRequest { } export namespace ModifyVolumeRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ModifyVolumeRequest): any => ({ ...obj, }); @@ -6131,6 +6776,9 @@ export interface ModifyVolumeResult { } export namespace ModifyVolumeResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: ModifyVolumeResult): any => ({ ...obj, }); @@ -6156,6 +6804,9 @@ export interface ModifyVolumeAttributeRequest { } export namespace ModifyVolumeAttributeRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ModifyVolumeAttributeRequest): any => ({ ...obj, }); @@ -6185,6 +6836,9 @@ export interface ModifyVpcAttributeRequest { } export namespace ModifyVpcAttributeRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ModifyVpcAttributeRequest): any => ({ ...obj, }); @@ -6256,6 +6910,9 @@ export interface ModifyVpcEndpointRequest { } export namespace ModifyVpcEndpointRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ModifyVpcEndpointRequest): any => ({ ...obj, }); @@ -6269,6 +6926,9 @@ export interface ModifyVpcEndpointResult { } export namespace ModifyVpcEndpointResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: ModifyVpcEndpointResult): any => ({ ...obj, }); @@ -6300,6 +6960,9 @@ export interface ModifyVpcEndpointConnectionNotificationRequest { } export namespace ModifyVpcEndpointConnectionNotificationRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ModifyVpcEndpointConnectionNotificationRequest): any => ({ ...obj, }); @@ -6313,6 +6976,9 @@ export interface ModifyVpcEndpointConnectionNotificationResult { } export namespace ModifyVpcEndpointConnectionNotificationResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: ModifyVpcEndpointConnectionNotificationResult): any => ({ ...obj, }); @@ -6372,6 +7038,9 @@ export interface ModifyVpcEndpointServiceConfigurationRequest { } export namespace ModifyVpcEndpointServiceConfigurationRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ModifyVpcEndpointServiceConfigurationRequest): any => ({ ...obj, }); @@ -6385,6 +7054,9 @@ export interface ModifyVpcEndpointServiceConfigurationResult { } export namespace ModifyVpcEndpointServiceConfigurationResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: ModifyVpcEndpointServiceConfigurationResult): any => ({ ...obj, }); @@ -6418,6 +7090,9 @@ export interface ModifyVpcEndpointServicePermissionsRequest { } export namespace ModifyVpcEndpointServicePermissionsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ModifyVpcEndpointServicePermissionsRequest): any => ({ ...obj, }); @@ -6431,6 +7106,9 @@ export interface ModifyVpcEndpointServicePermissionsResult { } export namespace ModifyVpcEndpointServicePermissionsResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: ModifyVpcEndpointServicePermissionsResult): any => ({ ...obj, }); @@ -6459,6 +7137,9 @@ export interface PeeringConnectionOptionsRequest { } export namespace PeeringConnectionOptionsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: PeeringConnectionOptionsRequest): any => ({ ...obj, }); @@ -6489,6 +7170,9 @@ export interface ModifyVpcPeeringConnectionOptionsRequest { } export namespace ModifyVpcPeeringConnectionOptionsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ModifyVpcPeeringConnectionOptionsRequest): any => ({ ...obj, }); @@ -6518,6 +7202,9 @@ export interface PeeringConnectionOptions { } export namespace PeeringConnectionOptions { + /** + * @internal + */ export const filterSensitiveLog = (obj: PeeringConnectionOptions): any => ({ ...obj, }); @@ -6536,6 +7223,9 @@ export interface ModifyVpcPeeringConnectionOptionsResult { } export namespace ModifyVpcPeeringConnectionOptionsResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: ModifyVpcPeeringConnectionOptionsResult): any => ({ ...obj, }); @@ -6563,6 +7253,9 @@ export interface ModifyVpcTenancyRequest { } export namespace ModifyVpcTenancyRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ModifyVpcTenancyRequest): any => ({ ...obj, }); @@ -6577,6 +7270,9 @@ export interface ModifyVpcTenancyResult { } export namespace ModifyVpcTenancyResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: ModifyVpcTenancyResult): any => ({ ...obj, }); @@ -6612,6 +7308,9 @@ export interface ModifyVpnConnectionRequest { } export namespace ModifyVpnConnectionRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ModifyVpnConnectionRequest): any => ({ ...obj, }); @@ -6625,6 +7324,9 @@ export interface ModifyVpnConnectionResult { } export namespace ModifyVpnConnectionResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: ModifyVpnConnectionResult): any => ({ ...obj, }); @@ -6672,6 +7374,9 @@ export interface ModifyVpnConnectionOptionsRequest { } export namespace ModifyVpnConnectionOptionsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ModifyVpnConnectionOptionsRequest): any => ({ ...obj, }); @@ -6685,6 +7390,9 @@ export interface ModifyVpnConnectionOptionsResult { } export namespace ModifyVpnConnectionOptionsResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: ModifyVpnConnectionOptionsResult): any => ({ ...obj, }); @@ -6710,6 +7418,9 @@ export interface ModifyVpnTunnelCertificateRequest { } export namespace ModifyVpnTunnelCertificateRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ModifyVpnTunnelCertificateRequest): any => ({ ...obj, }); @@ -6723,6 +7434,9 @@ export interface ModifyVpnTunnelCertificateResult { } export namespace ModifyVpnTunnelCertificateResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: ModifyVpnTunnelCertificateResult): any => ({ ...obj, }); @@ -6909,6 +7623,9 @@ export interface ModifyVpnTunnelOptionsSpecification { } export namespace ModifyVpnTunnelOptionsSpecification { + /** + * @internal + */ export const filterSensitiveLog = (obj: ModifyVpnTunnelOptionsSpecification): any => ({ ...obj, }); @@ -6939,6 +7656,9 @@ export interface ModifyVpnTunnelOptionsRequest { } export namespace ModifyVpnTunnelOptionsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ModifyVpnTunnelOptionsRequest): any => ({ ...obj, }); @@ -6952,6 +7672,9 @@ export interface ModifyVpnTunnelOptionsResult { } export namespace ModifyVpnTunnelOptionsResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: ModifyVpnTunnelOptionsResult): any => ({ ...obj, }); @@ -6972,6 +7695,9 @@ export interface MonitorInstancesRequest { } export namespace MonitorInstancesRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: MonitorInstancesRequest): any => ({ ...obj, }); @@ -6993,6 +7719,9 @@ export interface InstanceMonitoring { } export namespace InstanceMonitoring { + /** + * @internal + */ export const filterSensitiveLog = (obj: InstanceMonitoring): any => ({ ...obj, }); @@ -7006,6 +7735,9 @@ export interface MonitorInstancesResult { } export namespace MonitorInstancesResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: MonitorInstancesResult): any => ({ ...obj, }); @@ -7026,6 +7758,9 @@ export interface MoveAddressToVpcRequest { } export namespace MoveAddressToVpcRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: MoveAddressToVpcRequest): any => ({ ...obj, }); @@ -7050,6 +7785,9 @@ export interface MoveAddressToVpcResult { } export namespace MoveAddressToVpcResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: MoveAddressToVpcResult): any => ({ ...obj, }); @@ -7072,6 +7810,9 @@ export interface CidrAuthorizationContext { } export namespace CidrAuthorizationContext { + /** + * @internal + */ export const filterSensitiveLog = (obj: CidrAuthorizationContext): any => ({ ...obj, }); @@ -7117,6 +7858,9 @@ export interface ProvisionByoipCidrRequest { } export namespace ProvisionByoipCidrRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ProvisionByoipCidrRequest): any => ({ ...obj, }); @@ -7130,6 +7874,9 @@ export interface ProvisionByoipCidrResult { } export namespace ProvisionByoipCidrResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: ProvisionByoipCidrResult): any => ({ ...obj, }); @@ -7175,6 +7922,9 @@ export interface PurchaseHostReservationRequest { } export namespace PurchaseHostReservationRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: PurchaseHostReservationRequest): any => ({ ...obj, }); @@ -7210,6 +7960,9 @@ export interface PurchaseHostReservationResult { } export namespace PurchaseHostReservationResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: PurchaseHostReservationResult): any => ({ ...obj, }); @@ -7232,6 +7985,9 @@ export interface ReservedInstanceLimitPrice { } export namespace ReservedInstanceLimitPrice { + /** + * @internal + */ export const filterSensitiveLog = (obj: ReservedInstanceLimitPrice): any => ({ ...obj, }); @@ -7270,6 +8026,9 @@ export interface PurchaseReservedInstancesOfferingRequest { } export namespace PurchaseReservedInstancesOfferingRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: PurchaseReservedInstancesOfferingRequest): any => ({ ...obj, }); @@ -7286,6 +8045,9 @@ export interface PurchaseReservedInstancesOfferingResult { } export namespace PurchaseReservedInstancesOfferingResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: PurchaseReservedInstancesOfferingResult): any => ({ ...obj, }); @@ -7307,6 +8069,9 @@ export interface PurchaseRequest { } export namespace PurchaseRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: PurchaseRequest): any => ({ ...obj, }); @@ -7336,6 +8101,9 @@ export interface PurchaseScheduledInstancesRequest { } export namespace PurchaseScheduledInstancesRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: PurchaseScheduledInstancesRequest): any => ({ ...obj, }); @@ -7352,6 +8120,9 @@ export interface PurchaseScheduledInstancesResult { } export namespace PurchaseScheduledInstancesResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: PurchaseScheduledInstancesResult): any => ({ ...obj, }); @@ -7372,6 +8143,9 @@ export interface RebootInstancesRequest { } export namespace RebootInstancesRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: RebootInstancesRequest): any => ({ ...obj, }); @@ -7473,6 +8247,9 @@ export interface RegisterImageRequest { } export namespace RegisterImageRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: RegisterImageRequest): any => ({ ...obj, }); @@ -7489,6 +8266,9 @@ export interface RegisterImageResult { } export namespace RegisterImageResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: RegisterImageResult): any => ({ ...obj, }); @@ -7513,6 +8293,9 @@ export interface RegisterInstanceTagAttributeRequest { } export namespace RegisterInstanceTagAttributeRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: RegisterInstanceTagAttributeRequest): any => ({ ...obj, }); @@ -7533,6 +8316,9 @@ export interface RegisterInstanceEventNotificationAttributesRequest { } export namespace RegisterInstanceEventNotificationAttributesRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: RegisterInstanceEventNotificationAttributesRequest): any => ({ ...obj, }); @@ -7546,6 +8332,9 @@ export interface RegisterInstanceEventNotificationAttributesResult { } export namespace RegisterInstanceEventNotificationAttributesResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: RegisterInstanceEventNotificationAttributesResult): any => ({ ...obj, }); @@ -7576,6 +8365,9 @@ export interface RegisterTransitGatewayMulticastGroupMembersRequest { } export namespace RegisterTransitGatewayMulticastGroupMembersRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: RegisterTransitGatewayMulticastGroupMembersRequest): any => ({ ...obj, }); @@ -7602,6 +8394,9 @@ export interface TransitGatewayMulticastRegisteredGroupMembers { } export namespace TransitGatewayMulticastRegisteredGroupMembers { + /** + * @internal + */ export const filterSensitiveLog = (obj: TransitGatewayMulticastRegisteredGroupMembers): any => ({ ...obj, }); @@ -7615,6 +8410,9 @@ export interface RegisterTransitGatewayMulticastGroupMembersResult { } export namespace RegisterTransitGatewayMulticastGroupMembersResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: RegisterTransitGatewayMulticastGroupMembersResult): any => ({ ...obj, }); @@ -7645,6 +8443,9 @@ export interface RegisterTransitGatewayMulticastGroupSourcesRequest { } export namespace RegisterTransitGatewayMulticastGroupSourcesRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: RegisterTransitGatewayMulticastGroupSourcesRequest): any => ({ ...obj, }); @@ -7671,6 +8472,9 @@ export interface TransitGatewayMulticastRegisteredGroupSources { } export namespace TransitGatewayMulticastRegisteredGroupSources { + /** + * @internal + */ export const filterSensitiveLog = (obj: TransitGatewayMulticastRegisteredGroupSources): any => ({ ...obj, }); @@ -7684,6 +8488,9 @@ export interface RegisterTransitGatewayMulticastGroupSourcesResult { } export namespace RegisterTransitGatewayMulticastGroupSourcesResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: RegisterTransitGatewayMulticastGroupSourcesResult): any => ({ ...obj, }); @@ -7714,6 +8521,9 @@ export interface RejectTransitGatewayMulticastDomainAssociationsRequest { } export namespace RejectTransitGatewayMulticastDomainAssociationsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: RejectTransitGatewayMulticastDomainAssociationsRequest): any => ({ ...obj, }); @@ -7727,6 +8537,9 @@ export interface RejectTransitGatewayMulticastDomainAssociationsResult { } export namespace RejectTransitGatewayMulticastDomainAssociationsResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: RejectTransitGatewayMulticastDomainAssociationsResult): any => ({ ...obj, }); @@ -7747,6 +8560,9 @@ export interface RejectTransitGatewayPeeringAttachmentRequest { } export namespace RejectTransitGatewayPeeringAttachmentRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: RejectTransitGatewayPeeringAttachmentRequest): any => ({ ...obj, }); @@ -7760,6 +8576,9 @@ export interface RejectTransitGatewayPeeringAttachmentResult { } export namespace RejectTransitGatewayPeeringAttachmentResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: RejectTransitGatewayPeeringAttachmentResult): any => ({ ...obj, }); @@ -7780,6 +8599,9 @@ export interface RejectTransitGatewayVpcAttachmentRequest { } export namespace RejectTransitGatewayVpcAttachmentRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: RejectTransitGatewayVpcAttachmentRequest): any => ({ ...obj, }); @@ -7793,6 +8615,9 @@ export interface RejectTransitGatewayVpcAttachmentResult { } export namespace RejectTransitGatewayVpcAttachmentResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: RejectTransitGatewayVpcAttachmentResult): any => ({ ...obj, }); @@ -7818,6 +8643,9 @@ export interface RejectVpcEndpointConnectionsRequest { } export namespace RejectVpcEndpointConnectionsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: RejectVpcEndpointConnectionsRequest): any => ({ ...obj, }); @@ -7831,6 +8659,9 @@ export interface RejectVpcEndpointConnectionsResult { } export namespace RejectVpcEndpointConnectionsResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: RejectVpcEndpointConnectionsResult): any => ({ ...obj, }); @@ -7851,6 +8682,9 @@ export interface RejectVpcPeeringConnectionRequest { } export namespace RejectVpcPeeringConnectionRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: RejectVpcPeeringConnectionRequest): any => ({ ...obj, }); @@ -7864,6 +8698,9 @@ export interface RejectVpcPeeringConnectionResult { } export namespace RejectVpcPeeringConnectionResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: RejectVpcPeeringConnectionResult): any => ({ ...obj, }); @@ -7899,6 +8736,9 @@ export interface ReleaseAddressRequest { } export namespace ReleaseAddressRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ReleaseAddressRequest): any => ({ ...obj, }); @@ -7912,6 +8752,9 @@ export interface ReleaseHostsRequest { } export namespace ReleaseHostsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ReleaseHostsRequest): any => ({ ...obj, }); @@ -7931,6 +8774,9 @@ export interface ReleaseHostsResult { } export namespace ReleaseHostsResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: ReleaseHostsResult): any => ({ ...obj, }); @@ -7949,6 +8795,9 @@ export interface ReplaceIamInstanceProfileAssociationRequest { } export namespace ReplaceIamInstanceProfileAssociationRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ReplaceIamInstanceProfileAssociationRequest): any => ({ ...obj, }); @@ -7962,6 +8811,9 @@ export interface ReplaceIamInstanceProfileAssociationResult { } export namespace ReplaceIamInstanceProfileAssociationResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: ReplaceIamInstanceProfileAssociationResult): any => ({ ...obj, }); @@ -7987,6 +8839,9 @@ export interface ReplaceNetworkAclAssociationRequest { } export namespace ReplaceNetworkAclAssociationRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ReplaceNetworkAclAssociationRequest): any => ({ ...obj, }); @@ -8000,6 +8855,9 @@ export interface ReplaceNetworkAclAssociationResult { } export namespace ReplaceNetworkAclAssociationResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: ReplaceNetworkAclAssociationResult): any => ({ ...obj, }); @@ -8070,6 +8928,9 @@ export interface ReplaceNetworkAclEntryRequest { } export namespace ReplaceNetworkAclEntryRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ReplaceNetworkAclEntryRequest): any => ({ ...obj, }); @@ -8162,6 +9023,9 @@ export interface ReplaceRouteRequest { } export namespace ReplaceRouteRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ReplaceRouteRequest): any => ({ ...obj, }); diff --git a/clients/client-ec2/models/models_5.ts b/clients/client-ec2/models/models_5.ts index 02224270371c..2d11d43563d0 100644 --- a/clients/client-ec2/models/models_5.ts +++ b/clients/client-ec2/models/models_5.ts @@ -58,6 +58,9 @@ export interface ReplaceRouteTableAssociationRequest { } export namespace ReplaceRouteTableAssociationRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ReplaceRouteTableAssociationRequest): any => ({ ...obj, }); @@ -76,6 +79,9 @@ export interface ReplaceRouteTableAssociationResult { } export namespace ReplaceRouteTableAssociationResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: ReplaceRouteTableAssociationResult): any => ({ ...obj, }); @@ -111,6 +117,9 @@ export interface ReplaceTransitGatewayRouteRequest { } export namespace ReplaceTransitGatewayRouteRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ReplaceTransitGatewayRouteRequest): any => ({ ...obj, }); @@ -124,6 +133,9 @@ export interface ReplaceTransitGatewayRouteResult { } export namespace ReplaceTransitGatewayRouteResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: ReplaceTransitGatewayRouteResult): any => ({ ...obj, }); @@ -226,6 +238,9 @@ export interface ReportInstanceStatusRequest { } export namespace ReportInstanceStatusRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ReportInstanceStatusRequest): any => ({ ...obj, }); @@ -249,6 +264,9 @@ export interface RequestSpotFleetRequest { } export namespace RequestSpotFleetRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: RequestSpotFleetRequest): any => ({ ...obj, }); @@ -265,6 +283,9 @@ export interface RequestSpotFleetResponse { } export namespace RequestSpotFleetResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: RequestSpotFleetResponse): any => ({ ...obj, }); @@ -362,6 +383,9 @@ export interface RequestSpotLaunchSpecification { } export namespace RequestSpotLaunchSpecification { + /** + * @internal + */ export const filterSensitiveLog = (obj: RequestSpotLaunchSpecification): any => ({ ...obj, }); @@ -473,6 +497,9 @@ export interface RequestSpotInstancesRequest { } export namespace RequestSpotInstancesRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: RequestSpotInstancesRequest): any => ({ ...obj, }); @@ -489,6 +516,9 @@ export interface RequestSpotInstancesResult { } export namespace RequestSpotInstancesResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: RequestSpotInstancesResult): any => ({ ...obj, }); @@ -514,6 +544,9 @@ export interface ResetAddressAttributeRequest { } export namespace ResetAddressAttributeRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ResetAddressAttributeRequest): any => ({ ...obj, }); @@ -527,6 +560,9 @@ export interface ResetAddressAttributeResult { } export namespace ResetAddressAttributeResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: ResetAddressAttributeResult): any => ({ ...obj, }); @@ -542,6 +578,9 @@ export interface ResetEbsDefaultKmsKeyIdRequest { } export namespace ResetEbsDefaultKmsKeyIdRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ResetEbsDefaultKmsKeyIdRequest): any => ({ ...obj, }); @@ -555,6 +594,9 @@ export interface ResetEbsDefaultKmsKeyIdResult { } export namespace ResetEbsDefaultKmsKeyIdResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: ResetEbsDefaultKmsKeyIdResult): any => ({ ...obj, }); @@ -582,6 +624,9 @@ export interface ResetFpgaImageAttributeRequest { } export namespace ResetFpgaImageAttributeRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ResetFpgaImageAttributeRequest): any => ({ ...obj, }); @@ -595,6 +640,9 @@ export interface ResetFpgaImageAttributeResult { } export namespace ResetFpgaImageAttributeResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: ResetFpgaImageAttributeResult): any => ({ ...obj, }); @@ -625,6 +673,9 @@ export interface ResetImageAttributeRequest { } export namespace ResetImageAttributeRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ResetImageAttributeRequest): any => ({ ...obj, }); @@ -655,6 +706,9 @@ export interface ResetInstanceAttributeRequest { } export namespace ResetInstanceAttributeRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ResetInstanceAttributeRequest): any => ({ ...obj, }); @@ -683,6 +737,9 @@ export interface ResetNetworkInterfaceAttributeRequest { } export namespace ResetNetworkInterfaceAttributeRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ResetNetworkInterfaceAttributeRequest): any => ({ ...obj, }); @@ -709,6 +766,9 @@ export interface ResetSnapshotAttributeRequest { } export namespace ResetSnapshotAttributeRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ResetSnapshotAttributeRequest): any => ({ ...obj, }); @@ -729,6 +789,9 @@ export interface RestoreAddressToClassicRequest { } export namespace RestoreAddressToClassicRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: RestoreAddressToClassicRequest): any => ({ ...obj, }); @@ -747,6 +810,9 @@ export interface RestoreAddressToClassicResult { } export namespace RestoreAddressToClassicResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: RestoreAddressToClassicResult): any => ({ ...obj, }); @@ -777,6 +843,9 @@ export interface RestoreManagedPrefixListVersionRequest { } export namespace RestoreManagedPrefixListVersionRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: RestoreManagedPrefixListVersionRequest): any => ({ ...obj, }); @@ -790,6 +859,9 @@ export interface RestoreManagedPrefixListVersionResult { } export namespace RestoreManagedPrefixListVersionResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: RestoreManagedPrefixListVersionResult): any => ({ ...obj, }); @@ -823,6 +895,9 @@ export interface RevokeClientVpnIngressRequest { } export namespace RevokeClientVpnIngressRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: RevokeClientVpnIngressRequest): any => ({ ...obj, }); @@ -836,6 +911,9 @@ export interface RevokeClientVpnIngressResult { } export namespace RevokeClientVpnIngressResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: RevokeClientVpnIngressResult): any => ({ ...obj, }); @@ -894,6 +972,9 @@ export interface RevokeSecurityGroupEgressRequest { } export namespace RevokeSecurityGroupEgressRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: RevokeSecurityGroupEgressRequest): any => ({ ...obj, }); @@ -914,6 +995,9 @@ export interface RevokeSecurityGroupEgressResult { } export namespace RevokeSecurityGroupEgressResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: RevokeSecurityGroupEgressResult): any => ({ ...obj, }); @@ -981,6 +1065,9 @@ export interface RevokeSecurityGroupIngressRequest { } export namespace RevokeSecurityGroupIngressRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: RevokeSecurityGroupIngressRequest): any => ({ ...obj, }); @@ -1001,6 +1088,9 @@ export interface RevokeSecurityGroupIngressResult { } export namespace RevokeSecurityGroupIngressResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: RevokeSecurityGroupIngressResult): any => ({ ...obj, }); @@ -1025,6 +1115,9 @@ export interface CpuOptionsRequest { } export namespace CpuOptionsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: CpuOptionsRequest): any => ({ ...obj, }); @@ -1053,6 +1146,9 @@ export interface ElasticInferenceAccelerator { } export namespace ElasticInferenceAccelerator { + /** + * @internal + */ export const filterSensitiveLog = (obj: ElasticInferenceAccelerator): any => ({ ...obj, }); @@ -1071,6 +1167,9 @@ export interface EnclaveOptionsRequest { } export namespace EnclaveOptionsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: EnclaveOptionsRequest): any => ({ ...obj, }); @@ -1094,6 +1193,9 @@ export interface HibernationOptionsRequest { } export namespace HibernationOptionsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: HibernationOptionsRequest): any => ({ ...obj, }); @@ -1156,6 +1258,9 @@ export interface SpotMarketOptions { } export namespace SpotMarketOptions { + /** + * @internal + */ export const filterSensitiveLog = (obj: SpotMarketOptions): any => ({ ...obj, }); @@ -1177,6 +1282,9 @@ export interface InstanceMarketOptionsRequest { } export namespace InstanceMarketOptionsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: InstanceMarketOptionsRequest): any => ({ ...obj, }); @@ -1205,6 +1313,9 @@ export interface LaunchTemplateSpecification { } export namespace LaunchTemplateSpecification { + /** + * @internal + */ export const filterSensitiveLog = (obj: LaunchTemplateSpecification): any => ({ ...obj, }); @@ -1221,6 +1332,9 @@ export interface LicenseConfigurationRequest { } export namespace LicenseConfigurationRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: LicenseConfigurationRequest): any => ({ ...obj, }); @@ -1265,6 +1379,9 @@ export interface InstanceMetadataOptionsRequest { } export namespace InstanceMetadataOptionsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: InstanceMetadataOptionsRequest): any => ({ ...obj, }); @@ -1573,6 +1690,9 @@ export interface RunInstancesRequest { } export namespace RunInstancesRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: RunInstancesRequest): any => ({ ...obj, }); @@ -1625,6 +1745,9 @@ export interface ScheduledInstancesEbs { } export namespace ScheduledInstancesEbs { + /** + * @internal + */ export const filterSensitiveLog = (obj: ScheduledInstancesEbs): any => ({ ...obj, }); @@ -1663,6 +1786,9 @@ export interface ScheduledInstancesBlockDeviceMapping { } export namespace ScheduledInstancesBlockDeviceMapping { + /** + * @internal + */ export const filterSensitiveLog = (obj: ScheduledInstancesBlockDeviceMapping): any => ({ ...obj, }); @@ -1684,6 +1810,9 @@ export interface ScheduledInstancesIamInstanceProfile { } export namespace ScheduledInstancesIamInstanceProfile { + /** + * @internal + */ export const filterSensitiveLog = (obj: ScheduledInstancesIamInstanceProfile): any => ({ ...obj, }); @@ -1700,6 +1829,9 @@ export interface ScheduledInstancesMonitoring { } export namespace ScheduledInstancesMonitoring { + /** + * @internal + */ export const filterSensitiveLog = (obj: ScheduledInstancesMonitoring): any => ({ ...obj, }); @@ -1716,6 +1848,9 @@ export interface ScheduledInstancesIpv6Address { } export namespace ScheduledInstancesIpv6Address { + /** + * @internal + */ export const filterSensitiveLog = (obj: ScheduledInstancesIpv6Address): any => ({ ...obj, }); @@ -1737,6 +1872,9 @@ export interface ScheduledInstancesPrivateIpAddressConfig { } export namespace ScheduledInstancesPrivateIpAddressConfig { + /** + * @internal + */ export const filterSensitiveLog = (obj: ScheduledInstancesPrivateIpAddressConfig): any => ({ ...obj, }); @@ -1812,6 +1950,9 @@ export interface ScheduledInstancesNetworkInterface { } export namespace ScheduledInstancesNetworkInterface { + /** + * @internal + */ export const filterSensitiveLog = (obj: ScheduledInstancesNetworkInterface): any => ({ ...obj, }); @@ -1833,6 +1974,9 @@ export interface ScheduledInstancesPlacement { } export namespace ScheduledInstancesPlacement { + /** + * @internal + */ export const filterSensitiveLog = (obj: ScheduledInstancesPlacement): any => ({ ...obj, }); @@ -1918,6 +2062,9 @@ export interface ScheduledInstancesLaunchSpecification { } export namespace ScheduledInstancesLaunchSpecification { + /** + * @internal + */ export const filterSensitiveLog = (obj: ScheduledInstancesLaunchSpecification): any => ({ ...obj, }); @@ -1959,6 +2106,9 @@ export interface RunScheduledInstancesRequest { } export namespace RunScheduledInstancesRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: RunScheduledInstancesRequest): any => ({ ...obj, }); @@ -1975,6 +2125,9 @@ export interface RunScheduledInstancesResult { } export namespace RunScheduledInstancesResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: RunScheduledInstancesResult): any => ({ ...obj, }); @@ -2011,6 +2164,9 @@ export interface SearchLocalGatewayRoutesRequest { } export namespace SearchLocalGatewayRoutesRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: SearchLocalGatewayRoutesRequest): any => ({ ...obj, }); @@ -2029,6 +2185,9 @@ export interface SearchLocalGatewayRoutesResult { } export namespace SearchLocalGatewayRoutesResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: SearchLocalGatewayRoutesResult): any => ({ ...obj, }); @@ -2107,6 +2266,9 @@ export interface SearchTransitGatewayMulticastGroupsRequest { } export namespace SearchTransitGatewayMulticastGroupsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: SearchTransitGatewayMulticastGroupsRequest): any => ({ ...obj, }); @@ -2175,6 +2337,9 @@ export interface TransitGatewayMulticastGroup { } export namespace TransitGatewayMulticastGroup { + /** + * @internal + */ export const filterSensitiveLog = (obj: TransitGatewayMulticastGroup): any => ({ ...obj, }); @@ -2193,6 +2358,9 @@ export interface SearchTransitGatewayMulticastGroupsResult { } export namespace SearchTransitGatewayMulticastGroupsResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: SearchTransitGatewayMulticastGroupsResult): any => ({ ...obj, }); @@ -2268,6 +2436,9 @@ export interface SearchTransitGatewayRoutesRequest { } export namespace SearchTransitGatewayRoutesRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: SearchTransitGatewayRoutesRequest): any => ({ ...obj, }); @@ -2286,6 +2457,9 @@ export interface SearchTransitGatewayRoutesResult { } export namespace SearchTransitGatewayRoutesResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: SearchTransitGatewayRoutesResult): any => ({ ...obj, }); @@ -2306,6 +2480,9 @@ export interface SendDiagnosticInterruptRequest { } export namespace SendDiagnosticInterruptRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: SendDiagnosticInterruptRequest): any => ({ ...obj, }); @@ -2331,6 +2508,9 @@ export interface StartInstancesRequest { } export namespace StartInstancesRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: StartInstancesRequest): any => ({ ...obj, }); @@ -2357,6 +2537,9 @@ export interface InstanceStateChange { } export namespace InstanceStateChange { + /** + * @internal + */ export const filterSensitiveLog = (obj: InstanceStateChange): any => ({ ...obj, }); @@ -2370,6 +2553,9 @@ export interface StartInstancesResult { } export namespace StartInstancesResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: StartInstancesResult): any => ({ ...obj, }); @@ -2406,6 +2592,9 @@ export interface StartNetworkInsightsAnalysisRequest { } export namespace StartNetworkInsightsAnalysisRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: StartNetworkInsightsAnalysisRequest): any => ({ ...obj, }); @@ -2419,6 +2608,9 @@ export interface StartNetworkInsightsAnalysisResult { } export namespace StartNetworkInsightsAnalysisResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: StartNetworkInsightsAnalysisResult): any => ({ ...obj, }); @@ -2439,6 +2631,9 @@ export interface StartVpcEndpointServicePrivateDnsVerificationRequest { } export namespace StartVpcEndpointServicePrivateDnsVerificationRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: StartVpcEndpointServicePrivateDnsVerificationRequest): any => ({ ...obj, }); @@ -2452,6 +2647,9 @@ export interface StartVpcEndpointServicePrivateDnsVerificationResult { } export namespace StartVpcEndpointServicePrivateDnsVerificationResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: StartVpcEndpointServicePrivateDnsVerificationResult): any => ({ ...obj, }); @@ -2492,6 +2690,9 @@ export interface StopInstancesRequest { } export namespace StopInstancesRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: StopInstancesRequest): any => ({ ...obj, }); @@ -2505,6 +2706,9 @@ export interface StopInstancesResult { } export namespace StopInstancesResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: StopInstancesResult): any => ({ ...obj, }); @@ -2534,6 +2738,9 @@ export interface TerminateClientVpnConnectionsRequest { } export namespace TerminateClientVpnConnectionsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: TerminateClientVpnConnectionsRequest): any => ({ ...obj, }); @@ -2560,6 +2767,9 @@ export interface TerminateConnectionStatus { } export namespace TerminateConnectionStatus { + /** + * @internal + */ export const filterSensitiveLog = (obj: TerminateConnectionStatus): any => ({ ...obj, }); @@ -2583,6 +2793,9 @@ export interface TerminateClientVpnConnectionsResult { } export namespace TerminateClientVpnConnectionsResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: TerminateClientVpnConnectionsResult): any => ({ ...obj, }); @@ -2605,6 +2818,9 @@ export interface TerminateInstancesRequest { } export namespace TerminateInstancesRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: TerminateInstancesRequest): any => ({ ...obj, }); @@ -2618,6 +2834,9 @@ export interface TerminateInstancesResult { } export namespace TerminateInstancesResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: TerminateInstancesResult): any => ({ ...obj, }); @@ -2636,6 +2855,9 @@ export interface UnassignIpv6AddressesRequest { } export namespace UnassignIpv6AddressesRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: UnassignIpv6AddressesRequest): any => ({ ...obj, }); @@ -2654,6 +2876,9 @@ export interface UnassignIpv6AddressesResult { } export namespace UnassignIpv6AddressesResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: UnassignIpv6AddressesResult): any => ({ ...obj, }); @@ -2675,6 +2900,9 @@ export interface UnassignPrivateIpAddressesRequest { } export namespace UnassignPrivateIpAddressesRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: UnassignPrivateIpAddressesRequest): any => ({ ...obj, }); @@ -2695,6 +2923,9 @@ export interface UnmonitorInstancesRequest { } export namespace UnmonitorInstancesRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: UnmonitorInstancesRequest): any => ({ ...obj, }); @@ -2708,6 +2939,9 @@ export interface UnmonitorInstancesResult { } export namespace UnmonitorInstancesResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: UnmonitorInstancesResult): any => ({ ...obj, }); @@ -2741,6 +2975,9 @@ export interface UpdateSecurityGroupRuleDescriptionsEgressRequest { } export namespace UpdateSecurityGroupRuleDescriptionsEgressRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateSecurityGroupRuleDescriptionsEgressRequest): any => ({ ...obj, }); @@ -2754,6 +2991,9 @@ export interface UpdateSecurityGroupRuleDescriptionsEgressResult { } export namespace UpdateSecurityGroupRuleDescriptionsEgressResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateSecurityGroupRuleDescriptionsEgressResult): any => ({ ...obj, }); @@ -2787,6 +3027,9 @@ export interface UpdateSecurityGroupRuleDescriptionsIngressRequest { } export namespace UpdateSecurityGroupRuleDescriptionsIngressRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateSecurityGroupRuleDescriptionsIngressRequest): any => ({ ...obj, }); @@ -2800,6 +3043,9 @@ export interface UpdateSecurityGroupRuleDescriptionsIngressResult { } export namespace UpdateSecurityGroupRuleDescriptionsIngressResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateSecurityGroupRuleDescriptionsIngressResult): any => ({ ...obj, }); @@ -2820,6 +3066,9 @@ export interface WithdrawByoipCidrRequest { } export namespace WithdrawByoipCidrRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: WithdrawByoipCidrRequest): any => ({ ...obj, }); @@ -2833,6 +3082,9 @@ export interface WithdrawByoipCidrResult { } export namespace WithdrawByoipCidrResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: WithdrawByoipCidrResult): any => ({ ...obj, }); diff --git a/clients/client-ecr-public/commands/BatchCheckLayerAvailabilityCommand.ts b/clients/client-ecr-public/commands/BatchCheckLayerAvailabilityCommand.ts index 403d86bde6e4..d95d8576b83f 100644 --- a/clients/client-ecr-public/commands/BatchCheckLayerAvailabilityCommand.ts +++ b/clients/client-ecr-public/commands/BatchCheckLayerAvailabilityCommand.ts @@ -30,6 +30,20 @@ export interface BatchCheckLayerAvailabilityCommandOutput * *

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.

* + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ECRPUBLICClient, BatchCheckLayerAvailabilityCommand } from "@aws-sdk/client-ecr-public"; // ES Modules import + * // const { ECRPUBLICClient, BatchCheckLayerAvailabilityCommand } = require("@aws-sdk/client-ecr-public"); // CommonJS import + * const client = new ECRPUBLICClient(config); + * const command = new BatchCheckLayerAvailabilityCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link BatchCheckLayerAvailabilityCommandInput} for command's `input` shape. + * @see {@link BatchCheckLayerAvailabilityCommandOutput} for command's `response` shape. + * @see {@link ECRPUBLICClientResolvedConfig | config} for command's `input` shape. + * */ export class BatchCheckLayerAvailabilityCommand extends $Command< BatchCheckLayerAvailabilityCommandInput, diff --git a/clients/client-ecr-public/commands/BatchDeleteImageCommand.ts b/clients/client-ecr-public/commands/BatchDeleteImageCommand.ts index 38459341c4fd..fd81ed41b227 100644 --- a/clients/client-ecr-public/commands/BatchDeleteImageCommand.ts +++ b/clients/client-ecr-public/commands/BatchDeleteImageCommand.ts @@ -27,6 +27,20 @@ export interface BatchDeleteImageCommandOutput extends BatchDeleteImageResponse, * 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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ECRPUBLICClient, BatchDeleteImageCommand } from "@aws-sdk/client-ecr-public"; // ES Modules import + * // const { ECRPUBLICClient, BatchDeleteImageCommand } = require("@aws-sdk/client-ecr-public"); // CommonJS import + * const client = new ECRPUBLICClient(config); + * const command = new BatchDeleteImageCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link BatchDeleteImageCommandInput} for command's `input` shape. + * @see {@link BatchDeleteImageCommandOutput} for command's `response` shape. + * @see {@link ECRPUBLICClientResolvedConfig | config} for command's `input` shape. + * */ export class BatchDeleteImageCommand extends $Command< BatchDeleteImageCommandInput, diff --git a/clients/client-ecr-public/commands/CompleteLayerUploadCommand.ts b/clients/client-ecr-public/commands/CompleteLayerUploadCommand.ts index b5a1fd492b2b..90abf285e3ed 100644 --- a/clients/client-ecr-public/commands/CompleteLayerUploadCommand.ts +++ b/clients/client-ecr-public/commands/CompleteLayerUploadCommand.ts @@ -29,6 +29,20 @@ export interface CompleteLayerUploadCommandOutput extends CompleteLayerUploadRes * *

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.

* + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ECRPUBLICClient, CompleteLayerUploadCommand } from "@aws-sdk/client-ecr-public"; // ES Modules import + * // const { ECRPUBLICClient, CompleteLayerUploadCommand } = require("@aws-sdk/client-ecr-public"); // CommonJS import + * const client = new ECRPUBLICClient(config); + * const command = new CompleteLayerUploadCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CompleteLayerUploadCommandInput} for command's `input` shape. + * @see {@link CompleteLayerUploadCommandOutput} for command's `response` shape. + * @see {@link ECRPUBLICClientResolvedConfig | config} for command's `input` shape. + * */ export class CompleteLayerUploadCommand extends $Command< CompleteLayerUploadCommandInput, diff --git a/clients/client-ecr-public/commands/CreateRepositoryCommand.ts b/clients/client-ecr-public/commands/CreateRepositoryCommand.ts index 2724d7ba0ec4..8577a1ba9fa0 100644 --- a/clients/client-ecr-public/commands/CreateRepositoryCommand.ts +++ b/clients/client-ecr-public/commands/CreateRepositoryCommand.ts @@ -23,6 +23,20 @@ export interface CreateRepositoryCommandOutput extends CreateRepositoryResponse, /** *

Creates a repository in a public registry. For more information, see Amazon ECR * repositories in the Amazon Elastic Container Registry User Guide.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ECRPUBLICClient, CreateRepositoryCommand } from "@aws-sdk/client-ecr-public"; // ES Modules import + * // const { ECRPUBLICClient, CreateRepositoryCommand } = require("@aws-sdk/client-ecr-public"); // CommonJS import + * const client = new ECRPUBLICClient(config); + * const command = new CreateRepositoryCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreateRepositoryCommandInput} for command's `input` shape. + * @see {@link CreateRepositoryCommandOutput} for command's `response` shape. + * @see {@link ECRPUBLICClientResolvedConfig | config} for command's `input` shape. + * */ export class CreateRepositoryCommand extends $Command< CreateRepositoryCommandInput, diff --git a/clients/client-ecr-public/commands/DeleteRepositoryCommand.ts b/clients/client-ecr-public/commands/DeleteRepositoryCommand.ts index 4965d7c395a4..c9c4dcc2e309 100644 --- a/clients/client-ecr-public/commands/DeleteRepositoryCommand.ts +++ b/clients/client-ecr-public/commands/DeleteRepositoryCommand.ts @@ -24,6 +24,20 @@ export interface DeleteRepositoryCommandOutput extends DeleteRepositoryResponse, *

Deletes a repository in a public registry. If the repository contains images, you must * either delete all images in the repository or use the force option which * deletes all images on your behalf before deleting the repository.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ECRPUBLICClient, DeleteRepositoryCommand } from "@aws-sdk/client-ecr-public"; // ES Modules import + * // const { ECRPUBLICClient, DeleteRepositoryCommand } = require("@aws-sdk/client-ecr-public"); // CommonJS import + * const client = new ECRPUBLICClient(config); + * const command = new DeleteRepositoryCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteRepositoryCommandInput} for command's `input` shape. + * @see {@link DeleteRepositoryCommandOutput} for command's `response` shape. + * @see {@link ECRPUBLICClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteRepositoryCommand extends $Command< DeleteRepositoryCommandInput, diff --git a/clients/client-ecr-public/commands/DeleteRepositoryPolicyCommand.ts b/clients/client-ecr-public/commands/DeleteRepositoryPolicyCommand.ts index 4e76b8756e55..81e1f35afa6d 100644 --- a/clients/client-ecr-public/commands/DeleteRepositoryPolicyCommand.ts +++ b/clients/client-ecr-public/commands/DeleteRepositoryPolicyCommand.ts @@ -22,6 +22,20 @@ export interface DeleteRepositoryPolicyCommandOutput extends DeleteRepositoryPol /** *

Deletes the repository policy associated with the specified repository.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ECRPUBLICClient, DeleteRepositoryPolicyCommand } from "@aws-sdk/client-ecr-public"; // ES Modules import + * // const { ECRPUBLICClient, DeleteRepositoryPolicyCommand } = require("@aws-sdk/client-ecr-public"); // CommonJS import + * const client = new ECRPUBLICClient(config); + * const command = new DeleteRepositoryPolicyCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteRepositoryPolicyCommandInput} for command's `input` shape. + * @see {@link DeleteRepositoryPolicyCommandOutput} for command's `response` shape. + * @see {@link ECRPUBLICClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteRepositoryPolicyCommand extends $Command< DeleteRepositoryPolicyCommandInput, diff --git a/clients/client-ecr-public/commands/DescribeImageTagsCommand.ts b/clients/client-ecr-public/commands/DescribeImageTagsCommand.ts index 52716f1d3f48..63f8a086b87b 100644 --- a/clients/client-ecr-public/commands/DescribeImageTagsCommand.ts +++ b/clients/client-ecr-public/commands/DescribeImageTagsCommand.ts @@ -22,6 +22,20 @@ export interface DescribeImageTagsCommandOutput extends DescribeImageTagsRespons /** *

Returns the image tag details for a repository in a public registry.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ECRPUBLICClient, DescribeImageTagsCommand } from "@aws-sdk/client-ecr-public"; // ES Modules import + * // const { ECRPUBLICClient, DescribeImageTagsCommand } = require("@aws-sdk/client-ecr-public"); // CommonJS import + * const client = new ECRPUBLICClient(config); + * const command = new DescribeImageTagsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeImageTagsCommandInput} for command's `input` shape. + * @see {@link DescribeImageTagsCommandOutput} for command's `response` shape. + * @see {@link ECRPUBLICClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeImageTagsCommand extends $Command< DescribeImageTagsCommandInput, diff --git a/clients/client-ecr-public/commands/DescribeImagesCommand.ts b/clients/client-ecr-public/commands/DescribeImagesCommand.ts index f36ac2f20d7d..30e9a1792bf6 100644 --- a/clients/client-ecr-public/commands/DescribeImagesCommand.ts +++ b/clients/client-ecr-public/commands/DescribeImagesCommand.ts @@ -28,6 +28,20 @@ export interface DescribeImagesCommandOutput extends DescribeImagesResponse, __M * command shows the uncompressed image size, so it may return a larger image size than the * image sizes returned by DescribeImages.

* + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ECRPUBLICClient, DescribeImagesCommand } from "@aws-sdk/client-ecr-public"; // ES Modules import + * // const { ECRPUBLICClient, DescribeImagesCommand } = require("@aws-sdk/client-ecr-public"); // CommonJS import + * const client = new ECRPUBLICClient(config); + * const command = new DescribeImagesCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeImagesCommandInput} for command's `input` shape. + * @see {@link DescribeImagesCommandOutput} for command's `response` shape. + * @see {@link ECRPUBLICClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeImagesCommand extends $Command< DescribeImagesCommandInput, diff --git a/clients/client-ecr-public/commands/DescribeRegistriesCommand.ts b/clients/client-ecr-public/commands/DescribeRegistriesCommand.ts index b819a6166e6e..41e721817967 100644 --- a/clients/client-ecr-public/commands/DescribeRegistriesCommand.ts +++ b/clients/client-ecr-public/commands/DescribeRegistriesCommand.ts @@ -22,6 +22,20 @@ export interface DescribeRegistriesCommandOutput extends DescribeRegistriesRespo /** *

Returns details for a public registry.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ECRPUBLICClient, DescribeRegistriesCommand } from "@aws-sdk/client-ecr-public"; // ES Modules import + * // const { ECRPUBLICClient, DescribeRegistriesCommand } = require("@aws-sdk/client-ecr-public"); // CommonJS import + * const client = new ECRPUBLICClient(config); + * const command = new DescribeRegistriesCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeRegistriesCommandInput} for command's `input` shape. + * @see {@link DescribeRegistriesCommandOutput} for command's `response` shape. + * @see {@link ECRPUBLICClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeRegistriesCommand extends $Command< DescribeRegistriesCommandInput, diff --git a/clients/client-ecr-public/commands/DescribeRepositoriesCommand.ts b/clients/client-ecr-public/commands/DescribeRepositoriesCommand.ts index 1d6c4169a86b..e2a9e5ff71f9 100644 --- a/clients/client-ecr-public/commands/DescribeRepositoriesCommand.ts +++ b/clients/client-ecr-public/commands/DescribeRepositoriesCommand.ts @@ -22,6 +22,20 @@ export interface DescribeRepositoriesCommandOutput extends DescribeRepositoriesR /** *

Describes repositories in a public registry.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ECRPUBLICClient, DescribeRepositoriesCommand } from "@aws-sdk/client-ecr-public"; // ES Modules import + * // const { ECRPUBLICClient, DescribeRepositoriesCommand } = require("@aws-sdk/client-ecr-public"); // CommonJS import + * const client = new ECRPUBLICClient(config); + * const command = new DescribeRepositoriesCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeRepositoriesCommandInput} for command's `input` shape. + * @see {@link DescribeRepositoriesCommandOutput} for command's `response` shape. + * @see {@link ECRPUBLICClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeRepositoriesCommand extends $Command< DescribeRepositoriesCommandInput, diff --git a/clients/client-ecr-public/commands/GetAuthorizationTokenCommand.ts b/clients/client-ecr-public/commands/GetAuthorizationTokenCommand.ts index 72d2b8854879..85c620390ec0 100644 --- a/clients/client-ecr-public/commands/GetAuthorizationTokenCommand.ts +++ b/clients/client-ecr-public/commands/GetAuthorizationTokenCommand.ts @@ -26,6 +26,20 @@ export interface GetAuthorizationTokenCommandOutput extends GetAuthorizationToke * principal has access to. The authorization token is valid for 12 hours. This API requires * the ecr-public:GetAuthorizationToken and * sts:GetServiceBearerToken permissions.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ECRPUBLICClient, GetAuthorizationTokenCommand } from "@aws-sdk/client-ecr-public"; // ES Modules import + * // const { ECRPUBLICClient, GetAuthorizationTokenCommand } = require("@aws-sdk/client-ecr-public"); // CommonJS import + * const client = new ECRPUBLICClient(config); + * const command = new GetAuthorizationTokenCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetAuthorizationTokenCommandInput} for command's `input` shape. + * @see {@link GetAuthorizationTokenCommandOutput} for command's `response` shape. + * @see {@link ECRPUBLICClientResolvedConfig | config} for command's `input` shape. + * */ export class GetAuthorizationTokenCommand extends $Command< GetAuthorizationTokenCommandInput, diff --git a/clients/client-ecr-public/commands/GetRegistryCatalogDataCommand.ts b/clients/client-ecr-public/commands/GetRegistryCatalogDataCommand.ts index de18c9bc3feb..13f9f6da6761 100644 --- a/clients/client-ecr-public/commands/GetRegistryCatalogDataCommand.ts +++ b/clients/client-ecr-public/commands/GetRegistryCatalogDataCommand.ts @@ -22,6 +22,20 @@ export interface GetRegistryCatalogDataCommandOutput extends GetRegistryCatalogD /** *

Retrieves catalog metadata for a public registry.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ECRPUBLICClient, GetRegistryCatalogDataCommand } from "@aws-sdk/client-ecr-public"; // ES Modules import + * // const { ECRPUBLICClient, GetRegistryCatalogDataCommand } = require("@aws-sdk/client-ecr-public"); // CommonJS import + * const client = new ECRPUBLICClient(config); + * const command = new GetRegistryCatalogDataCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetRegistryCatalogDataCommandInput} for command's `input` shape. + * @see {@link GetRegistryCatalogDataCommandOutput} for command's `response` shape. + * @see {@link ECRPUBLICClientResolvedConfig | config} for command's `input` shape. + * */ export class GetRegistryCatalogDataCommand extends $Command< GetRegistryCatalogDataCommandInput, diff --git a/clients/client-ecr-public/commands/GetRepositoryCatalogDataCommand.ts b/clients/client-ecr-public/commands/GetRepositoryCatalogDataCommand.ts index 7969f7e5ae92..dd3213df38a0 100644 --- a/clients/client-ecr-public/commands/GetRepositoryCatalogDataCommand.ts +++ b/clients/client-ecr-public/commands/GetRepositoryCatalogDataCommand.ts @@ -23,6 +23,20 @@ export interface GetRepositoryCatalogDataCommandOutput extends GetRepositoryCata /** *

Retrieve catalog metadata for a repository in a public registry. This metadata is * displayed publicly in the Amazon ECR Public Gallery.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ECRPUBLICClient, GetRepositoryCatalogDataCommand } from "@aws-sdk/client-ecr-public"; // ES Modules import + * // const { ECRPUBLICClient, GetRepositoryCatalogDataCommand } = require("@aws-sdk/client-ecr-public"); // CommonJS import + * const client = new ECRPUBLICClient(config); + * const command = new GetRepositoryCatalogDataCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetRepositoryCatalogDataCommandInput} for command's `input` shape. + * @see {@link GetRepositoryCatalogDataCommandOutput} for command's `response` shape. + * @see {@link ECRPUBLICClientResolvedConfig | config} for command's `input` shape. + * */ export class GetRepositoryCatalogDataCommand extends $Command< GetRepositoryCatalogDataCommandInput, diff --git a/clients/client-ecr-public/commands/GetRepositoryPolicyCommand.ts b/clients/client-ecr-public/commands/GetRepositoryPolicyCommand.ts index 5420046c1966..2126240ff749 100644 --- a/clients/client-ecr-public/commands/GetRepositoryPolicyCommand.ts +++ b/clients/client-ecr-public/commands/GetRepositoryPolicyCommand.ts @@ -22,6 +22,20 @@ export interface GetRepositoryPolicyCommandOutput extends GetRepositoryPolicyRes /** *

Retrieves the repository policy for the specified repository.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ECRPUBLICClient, GetRepositoryPolicyCommand } from "@aws-sdk/client-ecr-public"; // ES Modules import + * // const { ECRPUBLICClient, GetRepositoryPolicyCommand } = require("@aws-sdk/client-ecr-public"); // CommonJS import + * const client = new ECRPUBLICClient(config); + * const command = new GetRepositoryPolicyCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetRepositoryPolicyCommandInput} for command's `input` shape. + * @see {@link GetRepositoryPolicyCommandOutput} for command's `response` shape. + * @see {@link ECRPUBLICClientResolvedConfig | config} for command's `input` shape. + * */ export class GetRepositoryPolicyCommand extends $Command< GetRepositoryPolicyCommandInput, diff --git a/clients/client-ecr-public/commands/InitiateLayerUploadCommand.ts b/clients/client-ecr-public/commands/InitiateLayerUploadCommand.ts index b0200742b066..f04bc7139108 100644 --- a/clients/client-ecr-public/commands/InitiateLayerUploadCommand.ts +++ b/clients/client-ecr-public/commands/InitiateLayerUploadCommand.ts @@ -28,6 +28,20 @@ export interface InitiateLayerUploadCommandOutput extends InitiateLayerUploadRes * *

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.

* + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ECRPUBLICClient, InitiateLayerUploadCommand } from "@aws-sdk/client-ecr-public"; // ES Modules import + * // const { ECRPUBLICClient, InitiateLayerUploadCommand } = require("@aws-sdk/client-ecr-public"); // CommonJS import + * const client = new ECRPUBLICClient(config); + * const command = new InitiateLayerUploadCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link InitiateLayerUploadCommandInput} for command's `input` shape. + * @see {@link InitiateLayerUploadCommandOutput} for command's `response` shape. + * @see {@link ECRPUBLICClientResolvedConfig | config} for command's `input` shape. + * */ export class InitiateLayerUploadCommand extends $Command< InitiateLayerUploadCommandInput, diff --git a/clients/client-ecr-public/commands/ListTagsForResourceCommand.ts b/clients/client-ecr-public/commands/ListTagsForResourceCommand.ts index 884513934566..9247a588132e 100644 --- a/clients/client-ecr-public/commands/ListTagsForResourceCommand.ts +++ b/clients/client-ecr-public/commands/ListTagsForResourceCommand.ts @@ -22,6 +22,20 @@ export interface ListTagsForResourceCommandOutput extends ListTagsForResourceRes /** *

List the tags for an Amazon ECR Public resource.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ECRPUBLICClient, ListTagsForResourceCommand } from "@aws-sdk/client-ecr-public"; // ES Modules import + * // const { ECRPUBLICClient, ListTagsForResourceCommand } = require("@aws-sdk/client-ecr-public"); // CommonJS import + * const client = new ECRPUBLICClient(config); + * const command = new ListTagsForResourceCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListTagsForResourceCommandInput} for command's `input` shape. + * @see {@link ListTagsForResourceCommandOutput} for command's `response` shape. + * @see {@link ECRPUBLICClientResolvedConfig | config} for command's `input` shape. + * */ export class ListTagsForResourceCommand extends $Command< ListTagsForResourceCommandInput, diff --git a/clients/client-ecr-public/commands/PutImageCommand.ts b/clients/client-ecr-public/commands/PutImageCommand.ts index 2f0cd3c2f27b..e4d59637c1e5 100644 --- a/clients/client-ecr-public/commands/PutImageCommand.ts +++ b/clients/client-ecr-public/commands/PutImageCommand.ts @@ -26,6 +26,20 @@ export interface PutImageCommandOutput extends PutImageResponse, __MetadataBeare * *

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.

* + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ECRPUBLICClient, PutImageCommand } from "@aws-sdk/client-ecr-public"; // ES Modules import + * // const { ECRPUBLICClient, PutImageCommand } = require("@aws-sdk/client-ecr-public"); // CommonJS import + * const client = new ECRPUBLICClient(config); + * const command = new PutImageCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link PutImageCommandInput} for command's `input` shape. + * @see {@link PutImageCommandOutput} for command's `response` shape. + * @see {@link ECRPUBLICClientResolvedConfig | config} for command's `input` shape. + * */ export class PutImageCommand extends $Command< PutImageCommandInput, diff --git a/clients/client-ecr-public/commands/PutRegistryCatalogDataCommand.ts b/clients/client-ecr-public/commands/PutRegistryCatalogDataCommand.ts index 94026172b0c8..f194e4c3870c 100644 --- a/clients/client-ecr-public/commands/PutRegistryCatalogDataCommand.ts +++ b/clients/client-ecr-public/commands/PutRegistryCatalogDataCommand.ts @@ -22,6 +22,20 @@ export interface PutRegistryCatalogDataCommandOutput extends PutRegistryCatalogD /** *

Create or updates the catalog data for a public registry.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ECRPUBLICClient, PutRegistryCatalogDataCommand } from "@aws-sdk/client-ecr-public"; // ES Modules import + * // const { ECRPUBLICClient, PutRegistryCatalogDataCommand } = require("@aws-sdk/client-ecr-public"); // CommonJS import + * const client = new ECRPUBLICClient(config); + * const command = new PutRegistryCatalogDataCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link PutRegistryCatalogDataCommandInput} for command's `input` shape. + * @see {@link PutRegistryCatalogDataCommandOutput} for command's `response` shape. + * @see {@link ECRPUBLICClientResolvedConfig | config} for command's `input` shape. + * */ export class PutRegistryCatalogDataCommand extends $Command< PutRegistryCatalogDataCommandInput, diff --git a/clients/client-ecr-public/commands/PutRepositoryCatalogDataCommand.ts b/clients/client-ecr-public/commands/PutRepositoryCatalogDataCommand.ts index fbc99d72be64..5a9cc7b26e62 100644 --- a/clients/client-ecr-public/commands/PutRepositoryCatalogDataCommand.ts +++ b/clients/client-ecr-public/commands/PutRepositoryCatalogDataCommand.ts @@ -22,6 +22,20 @@ export interface PutRepositoryCatalogDataCommandOutput extends PutRepositoryCata /** *

Creates or updates the catalog data for a repository in a public registry.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ECRPUBLICClient, PutRepositoryCatalogDataCommand } from "@aws-sdk/client-ecr-public"; // ES Modules import + * // const { ECRPUBLICClient, PutRepositoryCatalogDataCommand } = require("@aws-sdk/client-ecr-public"); // CommonJS import + * const client = new ECRPUBLICClient(config); + * const command = new PutRepositoryCatalogDataCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link PutRepositoryCatalogDataCommandInput} for command's `input` shape. + * @see {@link PutRepositoryCatalogDataCommandOutput} for command's `response` shape. + * @see {@link ECRPUBLICClientResolvedConfig | config} for command's `input` shape. + * */ export class PutRepositoryCatalogDataCommand extends $Command< PutRepositoryCatalogDataCommandInput, diff --git a/clients/client-ecr-public/commands/SetRepositoryPolicyCommand.ts b/clients/client-ecr-public/commands/SetRepositoryPolicyCommand.ts index 3357c39349ad..8a0fe3791f7b 100644 --- a/clients/client-ecr-public/commands/SetRepositoryPolicyCommand.ts +++ b/clients/client-ecr-public/commands/SetRepositoryPolicyCommand.ts @@ -24,6 +24,20 @@ export interface SetRepositoryPolicyCommandOutput extends SetRepositoryPolicyRes *

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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ECRPUBLICClient, SetRepositoryPolicyCommand } from "@aws-sdk/client-ecr-public"; // ES Modules import + * // const { ECRPUBLICClient, SetRepositoryPolicyCommand } = require("@aws-sdk/client-ecr-public"); // CommonJS import + * const client = new ECRPUBLICClient(config); + * const command = new SetRepositoryPolicyCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link SetRepositoryPolicyCommandInput} for command's `input` shape. + * @see {@link SetRepositoryPolicyCommandOutput} for command's `response` shape. + * @see {@link ECRPUBLICClientResolvedConfig | config} for command's `input` shape. + * */ export class SetRepositoryPolicyCommand extends $Command< SetRepositoryPolicyCommandInput, diff --git a/clients/client-ecr-public/commands/TagResourceCommand.ts b/clients/client-ecr-public/commands/TagResourceCommand.ts index b8d7557f9cc4..bc87dec4c74c 100644 --- a/clients/client-ecr-public/commands/TagResourceCommand.ts +++ b/clients/client-ecr-public/commands/TagResourceCommand.ts @@ -25,6 +25,20 @@ export interface TagResourceCommandOutput extends TagResourceResponse, __Metadat * 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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ECRPUBLICClient, TagResourceCommand } from "@aws-sdk/client-ecr-public"; // ES Modules import + * // const { ECRPUBLICClient, TagResourceCommand } = require("@aws-sdk/client-ecr-public"); // CommonJS import + * const client = new ECRPUBLICClient(config); + * const command = new TagResourceCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link TagResourceCommandInput} for command's `input` shape. + * @see {@link TagResourceCommandOutput} for command's `response` shape. + * @see {@link ECRPUBLICClientResolvedConfig | config} for command's `input` shape. + * */ export class TagResourceCommand extends $Command< TagResourceCommandInput, diff --git a/clients/client-ecr-public/commands/UntagResourceCommand.ts b/clients/client-ecr-public/commands/UntagResourceCommand.ts index 4c8d6b974f4b..c9817a68ec2f 100644 --- a/clients/client-ecr-public/commands/UntagResourceCommand.ts +++ b/clients/client-ecr-public/commands/UntagResourceCommand.ts @@ -22,6 +22,20 @@ export interface UntagResourceCommandOutput extends UntagResourceResponse, __Met /** *

Deletes specified tags from a resource.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ECRPUBLICClient, UntagResourceCommand } from "@aws-sdk/client-ecr-public"; // ES Modules import + * // const { ECRPUBLICClient, UntagResourceCommand } = require("@aws-sdk/client-ecr-public"); // CommonJS import + * const client = new ECRPUBLICClient(config); + * const command = new UntagResourceCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link UntagResourceCommandInput} for command's `input` shape. + * @see {@link UntagResourceCommandOutput} for command's `response` shape. + * @see {@link ECRPUBLICClientResolvedConfig | config} for command's `input` shape. + * */ export class UntagResourceCommand extends $Command< UntagResourceCommandInput, diff --git a/clients/client-ecr-public/commands/UploadLayerPartCommand.ts b/clients/client-ecr-public/commands/UploadLayerPartCommand.ts index 1034ab0b8255..57e48eda0c15 100644 --- a/clients/client-ecr-public/commands/UploadLayerPartCommand.ts +++ b/clients/client-ecr-public/commands/UploadLayerPartCommand.ts @@ -28,6 +28,20 @@ export interface UploadLayerPartCommandOutput extends UploadLayerPartResponse, _ * *

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.

* + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ECRPUBLICClient, UploadLayerPartCommand } from "@aws-sdk/client-ecr-public"; // ES Modules import + * // const { ECRPUBLICClient, UploadLayerPartCommand } = require("@aws-sdk/client-ecr-public"); // CommonJS import + * const client = new ECRPUBLICClient(config); + * const command = new UploadLayerPartCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link UploadLayerPartCommandInput} for command's `input` shape. + * @see {@link UploadLayerPartCommandOutput} for command's `response` shape. + * @see {@link ECRPUBLICClientResolvedConfig | config} for command's `input` shape. + * */ export class UploadLayerPartCommand extends $Command< UploadLayerPartCommandInput, diff --git a/clients/client-ecr-public/models/models_0.ts b/clients/client-ecr-public/models/models_0.ts index ab67e6b56249..05f5b945e11f 100644 --- a/clients/client-ecr-public/models/models_0.ts +++ b/clients/client-ecr-public/models/models_0.ts @@ -20,6 +20,9 @@ export interface AuthorizationData { } export namespace AuthorizationData { + /** + * @internal + */ export const filterSensitiveLog = (obj: AuthorizationData): any => ({ ...obj, }); @@ -44,6 +47,9 @@ export interface BatchCheckLayerAvailabilityRequest { } export namespace BatchCheckLayerAvailabilityRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: BatchCheckLayerAvailabilityRequest): any => ({ ...obj, }); @@ -75,6 +81,9 @@ export interface LayerFailure { } export namespace LayerFailure { + /** + * @internal + */ export const filterSensitiveLog = (obj: LayerFailure): any => ({ ...obj, }); @@ -113,6 +122,9 @@ export interface Layer { } export namespace Layer { + /** + * @internal + */ export const filterSensitiveLog = (obj: Layer): any => ({ ...obj, }); @@ -132,6 +144,9 @@ export interface BatchCheckLayerAvailabilityResponse { } export namespace BatchCheckLayerAvailabilityResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: BatchCheckLayerAvailabilityResponse): any => ({ ...obj, }); @@ -148,6 +163,9 @@ export interface InvalidParameterException extends __SmithyException, $MetadataB } export namespace InvalidParameterException { + /** + * @internal + */ export const filterSensitiveLog = (obj: InvalidParameterException): any => ({ ...obj, }); @@ -163,6 +181,9 @@ export interface RegistryNotFoundException extends __SmithyException, $MetadataB } export namespace RegistryNotFoundException { + /** + * @internal + */ export const filterSensitiveLog = (obj: RegistryNotFoundException): any => ({ ...obj, }); @@ -179,6 +200,9 @@ export interface RepositoryNotFoundException extends __SmithyException, $Metadat } export namespace RepositoryNotFoundException { + /** + * @internal + */ export const filterSensitiveLog = (obj: RepositoryNotFoundException): any => ({ ...obj, }); @@ -194,6 +218,9 @@ export interface ServerException extends __SmithyException, $MetadataBearer { } export namespace ServerException { + /** + * @internal + */ export const filterSensitiveLog = (obj: ServerException): any => ({ ...obj, }); @@ -215,6 +242,9 @@ export interface ImageIdentifier { } export namespace ImageIdentifier { + /** + * @internal + */ export const filterSensitiveLog = (obj: ImageIdentifier): any => ({ ...obj, }); @@ -241,6 +271,9 @@ export interface BatchDeleteImageRequest { } export namespace BatchDeleteImageRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: BatchDeleteImageRequest): any => ({ ...obj, }); @@ -277,6 +310,9 @@ export interface ImageFailure { } export namespace ImageFailure { + /** + * @internal + */ export const filterSensitiveLog = (obj: ImageFailure): any => ({ ...obj, }); @@ -295,6 +331,9 @@ export interface BatchDeleteImageResponse { } export namespace BatchDeleteImageResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: BatchDeleteImageResponse): any => ({ ...obj, }); @@ -326,6 +365,9 @@ export interface CompleteLayerUploadRequest { } export namespace CompleteLayerUploadRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: CompleteLayerUploadRequest): any => ({ ...obj, }); @@ -354,6 +396,9 @@ export interface CompleteLayerUploadResponse { } export namespace CompleteLayerUploadResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: CompleteLayerUploadResponse): any => ({ ...obj, }); @@ -369,6 +414,9 @@ export interface EmptyUploadException extends __SmithyException, $MetadataBearer } export namespace EmptyUploadException { + /** + * @internal + */ export const filterSensitiveLog = (obj: EmptyUploadException): any => ({ ...obj, }); @@ -385,6 +433,9 @@ export interface InvalidLayerException extends __SmithyException, $MetadataBeare } export namespace InvalidLayerException { + /** + * @internal + */ export const filterSensitiveLog = (obj: InvalidLayerException): any => ({ ...obj, }); @@ -400,6 +451,9 @@ export interface LayerAlreadyExistsException extends __SmithyException, $Metadat } export namespace LayerAlreadyExistsException { + /** + * @internal + */ export const filterSensitiveLog = (obj: LayerAlreadyExistsException): any => ({ ...obj, }); @@ -415,6 +469,9 @@ export interface LayerPartTooSmallException extends __SmithyException, $Metadata } export namespace LayerPartTooSmallException { + /** + * @internal + */ export const filterSensitiveLog = (obj: LayerPartTooSmallException): any => ({ ...obj, }); @@ -430,6 +487,9 @@ export interface UnsupportedCommandException extends __SmithyException, $Metadat } export namespace UnsupportedCommandException { + /** + * @internal + */ export const filterSensitiveLog = (obj: UnsupportedCommandException): any => ({ ...obj, }); @@ -446,6 +506,9 @@ export interface UploadNotFoundException extends __SmithyException, $MetadataBea } export namespace UploadNotFoundException { + /** + * @internal + */ export const filterSensitiveLog = (obj: UploadNotFoundException): any => ({ ...obj, }); @@ -545,6 +608,9 @@ export interface RepositoryCatalogDataInput { } export namespace RepositoryCatalogDataInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: RepositoryCatalogDataInput): any => ({ ...obj, }); @@ -569,6 +635,9 @@ export interface Tag { } export namespace Tag { + /** + * @internal + */ export const filterSensitiveLog = (obj: Tag): any => ({ ...obj, }); @@ -598,6 +667,9 @@ export interface CreateRepositoryRequest { } export namespace CreateRepositoryRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateRepositoryRequest): any => ({ ...obj, }); @@ -655,6 +727,9 @@ export interface RepositoryCatalogData { } export namespace RepositoryCatalogData { + /** + * @internal + */ export const filterSensitiveLog = (obj: RepositoryCatalogData): any => ({ ...obj, }); @@ -693,6 +768,9 @@ export interface Repository { } export namespace Repository { + /** + * @internal + */ export const filterSensitiveLog = (obj: Repository): any => ({ ...obj, }); @@ -712,6 +790,9 @@ export interface CreateRepositoryResponse { } export namespace CreateRepositoryResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateRepositoryResponse): any => ({ ...obj, }); @@ -727,6 +808,9 @@ export interface InvalidTagParameterException extends __SmithyException, $Metada } export namespace InvalidTagParameterException { + /** + * @internal + */ export const filterSensitiveLog = (obj: InvalidTagParameterException): any => ({ ...obj, }); @@ -744,6 +828,9 @@ export interface LimitExceededException extends __SmithyException, $MetadataBear } export namespace LimitExceededException { + /** + * @internal + */ export const filterSensitiveLog = (obj: LimitExceededException): any => ({ ...obj, }); @@ -759,6 +846,9 @@ export interface RepositoryAlreadyExistsException extends __SmithyException, $Me } export namespace RepositoryAlreadyExistsException { + /** + * @internal + */ export const filterSensitiveLog = (obj: RepositoryAlreadyExistsException): any => ({ ...obj, }); @@ -775,6 +865,9 @@ export interface TooManyTagsException extends __SmithyException, $MetadataBearer } export namespace TooManyTagsException { + /** + * @internal + */ export const filterSensitiveLog = (obj: TooManyTagsException): any => ({ ...obj, }); @@ -799,6 +892,9 @@ export interface DeleteRepositoryRequest { } export namespace DeleteRepositoryRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteRepositoryRequest): any => ({ ...obj, }); @@ -812,6 +908,9 @@ export interface DeleteRepositoryResponse { } export namespace DeleteRepositoryResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteRepositoryResponse): any => ({ ...obj, }); @@ -828,6 +927,9 @@ export interface RepositoryNotEmptyException extends __SmithyException, $Metadat } export namespace RepositoryNotEmptyException { + /** + * @internal + */ export const filterSensitiveLog = (obj: RepositoryNotEmptyException): any => ({ ...obj, }); @@ -848,6 +950,9 @@ export interface DeleteRepositoryPolicyRequest { } export namespace DeleteRepositoryPolicyRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteRepositoryPolicyRequest): any => ({ ...obj, }); @@ -871,6 +976,9 @@ export interface DeleteRepositoryPolicyResponse { } export namespace DeleteRepositoryPolicyResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteRepositoryPolicyResponse): any => ({ ...obj, }); @@ -887,6 +995,9 @@ export interface RepositoryPolicyNotFoundException extends __SmithyException, $M } export namespace RepositoryPolicyNotFoundException { + /** + * @internal + */ export const filterSensitiveLog = (obj: RepositoryPolicyNotFoundException): any => ({ ...obj, }); @@ -934,6 +1045,9 @@ export interface DescribeImagesRequest { } export namespace DescribeImagesRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeImagesRequest): any => ({ ...obj, }); @@ -996,6 +1110,9 @@ export interface ImageDetail { } export namespace ImageDetail { + /** + * @internal + */ export const filterSensitiveLog = (obj: ImageDetail): any => ({ ...obj, }); @@ -1018,6 +1135,9 @@ export interface DescribeImagesResponse { } export namespace DescribeImagesResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeImagesResponse): any => ({ ...obj, }); @@ -1033,6 +1153,9 @@ export interface ImageNotFoundException extends __SmithyException, $MetadataBear } export namespace ImageNotFoundException { + /** + * @internal + */ export const filterSensitiveLog = (obj: ImageNotFoundException): any => ({ ...obj, }); @@ -1075,6 +1198,9 @@ export interface DescribeImageTagsRequest { } export namespace DescribeImageTagsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeImageTagsRequest): any => ({ ...obj, }); @@ -1120,6 +1246,9 @@ export interface ReferencedImageDetail { } export namespace ReferencedImageDetail { + /** + * @internal + */ export const filterSensitiveLog = (obj: ReferencedImageDetail): any => ({ ...obj, }); @@ -1146,6 +1275,9 @@ export interface ImageTagDetail { } export namespace ImageTagDetail { + /** + * @internal + */ export const filterSensitiveLog = (obj: ImageTagDetail): any => ({ ...obj, }); @@ -1167,6 +1299,9 @@ export interface DescribeImageTagsResponse { } export namespace DescribeImageTagsResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeImageTagsResponse): any => ({ ...obj, }); @@ -1199,6 +1334,9 @@ export interface DescribeRegistriesRequest { } export namespace DescribeRegistriesRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeRegistriesRequest): any => ({ ...obj, }); @@ -1247,6 +1385,9 @@ export interface RegistryAlias { } export namespace RegistryAlias { + /** + * @internal + */ export const filterSensitiveLog = (obj: RegistryAlias): any => ({ ...obj, }); @@ -1286,6 +1427,9 @@ export interface Registry { } export namespace Registry { + /** + * @internal + */ export const filterSensitiveLog = (obj: Registry): any => ({ ...obj, }); @@ -1308,6 +1452,9 @@ export interface DescribeRegistriesResponse { } export namespace DescribeRegistriesResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeRegistriesResponse): any => ({ ...obj, }); @@ -1355,6 +1502,9 @@ export interface DescribeRepositoriesRequest { } export namespace DescribeRepositoriesRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeRepositoriesRequest): any => ({ ...obj, }); @@ -1377,6 +1527,9 @@ export interface DescribeRepositoriesResponse { } export namespace DescribeRepositoriesResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeRepositoriesResponse): any => ({ ...obj, }); @@ -1385,6 +1538,9 @@ export namespace DescribeRepositoriesResponse { export interface GetAuthorizationTokenRequest {} export namespace GetAuthorizationTokenRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetAuthorizationTokenRequest): any => ({ ...obj, }); @@ -1398,6 +1554,9 @@ export interface GetAuthorizationTokenResponse { } export namespace GetAuthorizationTokenResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetAuthorizationTokenResponse): any => ({ ...obj, }); @@ -1406,6 +1565,9 @@ export namespace GetAuthorizationTokenResponse { export interface GetRegistryCatalogDataRequest {} export namespace GetRegistryCatalogDataRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetRegistryCatalogDataRequest): any => ({ ...obj, }); @@ -1426,6 +1588,9 @@ export interface RegistryCatalogData { } export namespace RegistryCatalogData { + /** + * @internal + */ export const filterSensitiveLog = (obj: RegistryCatalogData): any => ({ ...obj, }); @@ -1439,6 +1604,9 @@ export interface GetRegistryCatalogDataResponse { } export namespace GetRegistryCatalogDataResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetRegistryCatalogDataResponse): any => ({ ...obj, }); @@ -1458,6 +1626,9 @@ export interface GetRepositoryCatalogDataRequest { } export namespace GetRepositoryCatalogDataRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetRepositoryCatalogDataRequest): any => ({ ...obj, }); @@ -1471,6 +1642,9 @@ export interface GetRepositoryCatalogDataResponse { } export namespace GetRepositoryCatalogDataResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetRepositoryCatalogDataResponse): any => ({ ...obj, }); @@ -1490,6 +1664,9 @@ export interface GetRepositoryPolicyRequest { } export namespace GetRepositoryPolicyRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetRepositoryPolicyRequest): any => ({ ...obj, }); @@ -1514,6 +1691,9 @@ export interface GetRepositoryPolicyResponse { } export namespace GetRepositoryPolicyResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetRepositoryPolicyResponse): any => ({ ...obj, }); @@ -1550,6 +1730,9 @@ export interface Image { } export namespace Image { + /** + * @internal + */ export const filterSensitiveLog = (obj: Image): any => ({ ...obj, }); @@ -1566,6 +1749,9 @@ export interface ImageAlreadyExistsException extends __SmithyException, $Metadat } export namespace ImageAlreadyExistsException { + /** + * @internal + */ export const filterSensitiveLog = (obj: ImageAlreadyExistsException): any => ({ ...obj, }); @@ -1582,6 +1768,9 @@ export interface ImageDigestDoesNotMatchException extends __SmithyException, $Me } export namespace ImageDigestDoesNotMatchException { + /** + * @internal + */ export const filterSensitiveLog = (obj: ImageDigestDoesNotMatchException): any => ({ ...obj, }); @@ -1598,6 +1787,9 @@ export interface ImageTagAlreadyExistsException extends __SmithyException, $Meta } export namespace ImageTagAlreadyExistsException { + /** + * @internal + */ export const filterSensitiveLog = (obj: ImageTagAlreadyExistsException): any => ({ ...obj, }); @@ -1617,6 +1809,9 @@ export interface InitiateLayerUploadRequest { } export namespace InitiateLayerUploadRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: InitiateLayerUploadRequest): any => ({ ...obj, }); @@ -1635,6 +1830,9 @@ export interface InitiateLayerUploadResponse { } export namespace InitiateLayerUploadResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: InitiateLayerUploadResponse): any => ({ ...obj, }); @@ -1671,6 +1869,9 @@ export interface InvalidLayerPartException extends __SmithyException, $MetadataB } export namespace InvalidLayerPartException { + /** + * @internal + */ export const filterSensitiveLog = (obj: InvalidLayerPartException): any => ({ ...obj, }); @@ -1687,6 +1888,9 @@ export interface LayersNotFoundException extends __SmithyException, $MetadataBea } export namespace LayersNotFoundException { + /** + * @internal + */ export const filterSensitiveLog = (obj: LayersNotFoundException): any => ({ ...obj, }); @@ -1701,6 +1905,9 @@ export interface ListTagsForResourceRequest { } export namespace ListTagsForResourceRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListTagsForResourceRequest): any => ({ ...obj, }); @@ -1714,6 +1921,9 @@ export interface ListTagsForResourceResponse { } export namespace ListTagsForResourceResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListTagsForResourceResponse): any => ({ ...obj, }); @@ -1756,6 +1966,9 @@ export interface PutImageRequest { } export namespace PutImageRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: PutImageRequest): any => ({ ...obj, }); @@ -1769,6 +1982,9 @@ export interface PutImageResponse { } export namespace PutImageResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: PutImageResponse): any => ({ ...obj, }); @@ -1784,6 +2000,9 @@ export interface ReferencedImagesNotFoundException extends __SmithyException, $M } export namespace ReferencedImagesNotFoundException { + /** + * @internal + */ export const filterSensitiveLog = (obj: ReferencedImagesNotFoundException): any => ({ ...obj, }); @@ -1802,6 +2021,9 @@ export interface PutRegistryCatalogDataRequest { } export namespace PutRegistryCatalogDataRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: PutRegistryCatalogDataRequest): any => ({ ...obj, }); @@ -1815,6 +2037,9 @@ export interface PutRegistryCatalogDataResponse { } export namespace PutRegistryCatalogDataResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: PutRegistryCatalogDataResponse): any => ({ ...obj, }); @@ -1840,6 +2065,9 @@ export interface PutRepositoryCatalogDataRequest { } export namespace PutRepositoryCatalogDataRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: PutRepositoryCatalogDataRequest): any => ({ ...obj, }); @@ -1853,6 +2081,9 @@ export interface PutRepositoryCatalogDataResponse { } export namespace PutRepositoryCatalogDataResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: PutRepositoryCatalogDataResponse): any => ({ ...obj, }); @@ -1886,6 +2117,9 @@ export interface SetRepositoryPolicyRequest { } export namespace SetRepositoryPolicyRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: SetRepositoryPolicyRequest): any => ({ ...obj, }); @@ -1909,6 +2143,9 @@ export interface SetRepositoryPolicyResponse { } export namespace SetRepositoryPolicyResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: SetRepositoryPolicyResponse): any => ({ ...obj, }); @@ -1929,6 +2166,9 @@ export interface TagResourceRequest { } export namespace TagResourceRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: TagResourceRequest): any => ({ ...obj, }); @@ -1937,6 +2177,9 @@ export namespace TagResourceRequest { export interface TagResourceResponse {} export namespace TagResourceResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: TagResourceResponse): any => ({ ...obj, }); @@ -1956,6 +2199,9 @@ export interface UntagResourceRequest { } export namespace UntagResourceRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: UntagResourceRequest): any => ({ ...obj, }); @@ -1964,6 +2210,9 @@ export namespace UntagResourceRequest { export interface UntagResourceResponse {} export namespace UntagResourceResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: UntagResourceResponse): any => ({ ...obj, }); @@ -2004,6 +2253,9 @@ export interface UploadLayerPartRequest { } export namespace UploadLayerPartRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: UploadLayerPartRequest): any => ({ ...obj, }); @@ -2032,6 +2284,9 @@ export interface UploadLayerPartResponse { } export namespace UploadLayerPartResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: UploadLayerPartResponse): any => ({ ...obj, }); diff --git a/clients/client-ecr/commands/BatchCheckLayerAvailabilityCommand.ts b/clients/client-ecr/commands/BatchCheckLayerAvailabilityCommand.ts index 5302eba2e4f3..4fbf950d512b 100644 --- a/clients/client-ecr/commands/BatchCheckLayerAvailabilityCommand.ts +++ b/clients/client-ecr/commands/BatchCheckLayerAvailabilityCommand.ts @@ -31,6 +31,20 @@ export interface BatchCheckLayerAvailabilityCommandOutput *

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.

* + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ECRClient, BatchCheckLayerAvailabilityCommand } from "@aws-sdk/client-ecr"; // ES Modules import + * // const { ECRClient, BatchCheckLayerAvailabilityCommand } = require("@aws-sdk/client-ecr"); // CommonJS import + * const client = new ECRClient(config); + * const command = new BatchCheckLayerAvailabilityCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link BatchCheckLayerAvailabilityCommandInput} for command's `input` shape. + * @see {@link BatchCheckLayerAvailabilityCommandOutput} for command's `response` shape. + * @see {@link ECRClientResolvedConfig | config} for command's `input` shape. + * */ export class BatchCheckLayerAvailabilityCommand extends $Command< BatchCheckLayerAvailabilityCommandInput, diff --git a/clients/client-ecr/commands/BatchDeleteImageCommand.ts b/clients/client-ecr/commands/BatchDeleteImageCommand.ts index e083277c5c7a..150d1237056a 100644 --- a/clients/client-ecr/commands/BatchDeleteImageCommand.ts +++ b/clients/client-ecr/commands/BatchDeleteImageCommand.ts @@ -27,6 +27,20 @@ export interface BatchDeleteImageCommandOutput extends BatchDeleteImageResponse, * 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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ECRClient, BatchDeleteImageCommand } from "@aws-sdk/client-ecr"; // ES Modules import + * // const { ECRClient, BatchDeleteImageCommand } = require("@aws-sdk/client-ecr"); // CommonJS import + * const client = new ECRClient(config); + * const command = new BatchDeleteImageCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link BatchDeleteImageCommandInput} for command's `input` shape. + * @see {@link BatchDeleteImageCommandOutput} for command's `response` shape. + * @see {@link ECRClientResolvedConfig | config} for command's `input` shape. + * */ export class BatchDeleteImageCommand extends $Command< BatchDeleteImageCommandInput, diff --git a/clients/client-ecr/commands/BatchGetImageCommand.ts b/clients/client-ecr/commands/BatchGetImageCommand.ts index baf0de700783..2b4063806f7d 100644 --- a/clients/client-ecr/commands/BatchGetImageCommand.ts +++ b/clients/client-ecr/commands/BatchGetImageCommand.ts @@ -25,6 +25,20 @@ export interface BatchGetImageCommandOutput extends BatchGetImageResponse, __Met * imageTag or imageDigest.

*

When an image is pulled, the BatchGetImage API is called once to retrieve the image * manifest.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ECRClient, BatchGetImageCommand } from "@aws-sdk/client-ecr"; // ES Modules import + * // const { ECRClient, BatchGetImageCommand } = require("@aws-sdk/client-ecr"); // CommonJS import + * const client = new ECRClient(config); + * const command = new BatchGetImageCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link BatchGetImageCommandInput} for command's `input` shape. + * @see {@link BatchGetImageCommandOutput} for command's `response` shape. + * @see {@link ECRClientResolvedConfig | config} for command's `input` shape. + * */ export class BatchGetImageCommand extends $Command< BatchGetImageCommandInput, diff --git a/clients/client-ecr/commands/CompleteLayerUploadCommand.ts b/clients/client-ecr/commands/CompleteLayerUploadCommand.ts index 5dfdc817ac53..4a4d323c59f3 100644 --- a/clients/client-ecr/commands/CompleteLayerUploadCommand.ts +++ b/clients/client-ecr/commands/CompleteLayerUploadCommand.ts @@ -30,6 +30,20 @@ export interface CompleteLayerUploadCommandOutput extends CompleteLayerUploadRes *

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.

* + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ECRClient, CompleteLayerUploadCommand } from "@aws-sdk/client-ecr"; // ES Modules import + * // const { ECRClient, CompleteLayerUploadCommand } = require("@aws-sdk/client-ecr"); // CommonJS import + * const client = new ECRClient(config); + * const command = new CompleteLayerUploadCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CompleteLayerUploadCommandInput} for command's `input` shape. + * @see {@link CompleteLayerUploadCommandOutput} for command's `response` shape. + * @see {@link ECRClientResolvedConfig | config} for command's `input` shape. + * */ export class CompleteLayerUploadCommand extends $Command< CompleteLayerUploadCommandInput, diff --git a/clients/client-ecr/commands/CreateRepositoryCommand.ts b/clients/client-ecr/commands/CreateRepositoryCommand.ts index 10d33966d744..4cb09efdd3ff 100644 --- a/clients/client-ecr/commands/CreateRepositoryCommand.ts +++ b/clients/client-ecr/commands/CreateRepositoryCommand.ts @@ -23,6 +23,20 @@ export interface CreateRepositoryCommandOutput extends CreateRepositoryResponse, /** *

Creates a repository. For more information, see Amazon ECR Repositories in the * Amazon Elastic Container Registry User Guide.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ECRClient, CreateRepositoryCommand } from "@aws-sdk/client-ecr"; // ES Modules import + * // const { ECRClient, CreateRepositoryCommand } = require("@aws-sdk/client-ecr"); // CommonJS import + * const client = new ECRClient(config); + * const command = new CreateRepositoryCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreateRepositoryCommandInput} for command's `input` shape. + * @see {@link CreateRepositoryCommandOutput} for command's `response` shape. + * @see {@link ECRClientResolvedConfig | config} for command's `input` shape. + * */ export class CreateRepositoryCommand extends $Command< CreateRepositoryCommandInput, diff --git a/clients/client-ecr/commands/DeleteLifecyclePolicyCommand.ts b/clients/client-ecr/commands/DeleteLifecyclePolicyCommand.ts index 94e9920cf2ab..e94239cd2518 100644 --- a/clients/client-ecr/commands/DeleteLifecyclePolicyCommand.ts +++ b/clients/client-ecr/commands/DeleteLifecyclePolicyCommand.ts @@ -22,6 +22,20 @@ export interface DeleteLifecyclePolicyCommandOutput extends DeleteLifecyclePolic /** *

Deletes the lifecycle policy associated with the specified repository.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ECRClient, DeleteLifecyclePolicyCommand } from "@aws-sdk/client-ecr"; // ES Modules import + * // const { ECRClient, DeleteLifecyclePolicyCommand } = require("@aws-sdk/client-ecr"); // CommonJS import + * const client = new ECRClient(config); + * const command = new DeleteLifecyclePolicyCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteLifecyclePolicyCommandInput} for command's `input` shape. + * @see {@link DeleteLifecyclePolicyCommandOutput} for command's `response` shape. + * @see {@link ECRClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteLifecyclePolicyCommand extends $Command< DeleteLifecyclePolicyCommandInput, diff --git a/clients/client-ecr/commands/DeleteRegistryPolicyCommand.ts b/clients/client-ecr/commands/DeleteRegistryPolicyCommand.ts index af45ee2cb410..21676b792100 100644 --- a/clients/client-ecr/commands/DeleteRegistryPolicyCommand.ts +++ b/clients/client-ecr/commands/DeleteRegistryPolicyCommand.ts @@ -22,6 +22,20 @@ export interface DeleteRegistryPolicyCommandOutput extends DeleteRegistryPolicyR /** *

Deletes the registry permissions policy.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ECRClient, DeleteRegistryPolicyCommand } from "@aws-sdk/client-ecr"; // ES Modules import + * // const { ECRClient, DeleteRegistryPolicyCommand } = require("@aws-sdk/client-ecr"); // CommonJS import + * const client = new ECRClient(config); + * const command = new DeleteRegistryPolicyCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteRegistryPolicyCommandInput} for command's `input` shape. + * @see {@link DeleteRegistryPolicyCommandOutput} for command's `response` shape. + * @see {@link ECRClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteRegistryPolicyCommand extends $Command< DeleteRegistryPolicyCommandInput, diff --git a/clients/client-ecr/commands/DeleteRepositoryCommand.ts b/clients/client-ecr/commands/DeleteRepositoryCommand.ts index 5d74073a630a..08b24a1144b1 100644 --- a/clients/client-ecr/commands/DeleteRepositoryCommand.ts +++ b/clients/client-ecr/commands/DeleteRepositoryCommand.ts @@ -24,6 +24,20 @@ export interface DeleteRepositoryCommandOutput extends DeleteRepositoryResponse, *

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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ECRClient, DeleteRepositoryCommand } from "@aws-sdk/client-ecr"; // ES Modules import + * // const { ECRClient, DeleteRepositoryCommand } = require("@aws-sdk/client-ecr"); // CommonJS import + * const client = new ECRClient(config); + * const command = new DeleteRepositoryCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteRepositoryCommandInput} for command's `input` shape. + * @see {@link DeleteRepositoryCommandOutput} for command's `response` shape. + * @see {@link ECRClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteRepositoryCommand extends $Command< DeleteRepositoryCommandInput, diff --git a/clients/client-ecr/commands/DeleteRepositoryPolicyCommand.ts b/clients/client-ecr/commands/DeleteRepositoryPolicyCommand.ts index 76a79fde2b01..188c09524fe0 100644 --- a/clients/client-ecr/commands/DeleteRepositoryPolicyCommand.ts +++ b/clients/client-ecr/commands/DeleteRepositoryPolicyCommand.ts @@ -22,6 +22,20 @@ export interface DeleteRepositoryPolicyCommandOutput extends DeleteRepositoryPol /** *

Deletes the repository policy associated with the specified repository.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ECRClient, DeleteRepositoryPolicyCommand } from "@aws-sdk/client-ecr"; // ES Modules import + * // const { ECRClient, DeleteRepositoryPolicyCommand } = require("@aws-sdk/client-ecr"); // CommonJS import + * const client = new ECRClient(config); + * const command = new DeleteRepositoryPolicyCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteRepositoryPolicyCommandInput} for command's `input` shape. + * @see {@link DeleteRepositoryPolicyCommandOutput} for command's `response` shape. + * @see {@link ECRClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteRepositoryPolicyCommand extends $Command< DeleteRepositoryPolicyCommandInput, diff --git a/clients/client-ecr/commands/DescribeImageScanFindingsCommand.ts b/clients/client-ecr/commands/DescribeImageScanFindingsCommand.ts index 639df8e7e899..b97a4842c2bb 100644 --- a/clients/client-ecr/commands/DescribeImageScanFindingsCommand.ts +++ b/clients/client-ecr/commands/DescribeImageScanFindingsCommand.ts @@ -22,6 +22,20 @@ export interface DescribeImageScanFindingsCommandOutput extends DescribeImageSca /** *

Returns the scan findings for the specified image.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ECRClient, DescribeImageScanFindingsCommand } from "@aws-sdk/client-ecr"; // ES Modules import + * // const { ECRClient, DescribeImageScanFindingsCommand } = require("@aws-sdk/client-ecr"); // CommonJS import + * const client = new ECRClient(config); + * const command = new DescribeImageScanFindingsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeImageScanFindingsCommandInput} for command's `input` shape. + * @see {@link DescribeImageScanFindingsCommandOutput} for command's `response` shape. + * @see {@link ECRClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeImageScanFindingsCommand extends $Command< DescribeImageScanFindingsCommandInput, diff --git a/clients/client-ecr/commands/DescribeImagesCommand.ts b/clients/client-ecr/commands/DescribeImagesCommand.ts index b739bcd6a403..d4e9ad1b736f 100644 --- a/clients/client-ecr/commands/DescribeImagesCommand.ts +++ b/clients/client-ecr/commands/DescribeImagesCommand.ts @@ -28,6 +28,20 @@ export interface DescribeImagesCommandOutput extends DescribeImagesResponse, __M * images command shows the uncompressed image size, so it may return a * larger image size than the image sizes returned by DescribeImages.

* + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ECRClient, DescribeImagesCommand } from "@aws-sdk/client-ecr"; // ES Modules import + * // const { ECRClient, DescribeImagesCommand } = require("@aws-sdk/client-ecr"); // CommonJS import + * const client = new ECRClient(config); + * const command = new DescribeImagesCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeImagesCommandInput} for command's `input` shape. + * @see {@link DescribeImagesCommandOutput} for command's `response` shape. + * @see {@link ECRClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeImagesCommand extends $Command< DescribeImagesCommandInput, diff --git a/clients/client-ecr/commands/DescribeRegistryCommand.ts b/clients/client-ecr/commands/DescribeRegistryCommand.ts index 2ec6f14a4ea9..0f0051901231 100644 --- a/clients/client-ecr/commands/DescribeRegistryCommand.ts +++ b/clients/client-ecr/commands/DescribeRegistryCommand.ts @@ -24,6 +24,20 @@ export interface DescribeRegistryCommandOutput extends DescribeRegistryResponse, *

Describes the settings for a registry. The replication configuration for a repository * can be created or updated with the PutReplicationConfiguration API * action.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ECRClient, DescribeRegistryCommand } from "@aws-sdk/client-ecr"; // ES Modules import + * // const { ECRClient, DescribeRegistryCommand } = require("@aws-sdk/client-ecr"); // CommonJS import + * const client = new ECRClient(config); + * const command = new DescribeRegistryCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeRegistryCommandInput} for command's `input` shape. + * @see {@link DescribeRegistryCommandOutput} for command's `response` shape. + * @see {@link ECRClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeRegistryCommand extends $Command< DescribeRegistryCommandInput, diff --git a/clients/client-ecr/commands/DescribeRepositoriesCommand.ts b/clients/client-ecr/commands/DescribeRepositoriesCommand.ts index 0d983ba68f66..dc78ccca0244 100644 --- a/clients/client-ecr/commands/DescribeRepositoriesCommand.ts +++ b/clients/client-ecr/commands/DescribeRepositoriesCommand.ts @@ -22,6 +22,20 @@ export interface DescribeRepositoriesCommandOutput extends DescribeRepositoriesR /** *

Describes image repositories in a registry.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ECRClient, DescribeRepositoriesCommand } from "@aws-sdk/client-ecr"; // ES Modules import + * // const { ECRClient, DescribeRepositoriesCommand } = require("@aws-sdk/client-ecr"); // CommonJS import + * const client = new ECRClient(config); + * const command = new DescribeRepositoriesCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeRepositoriesCommandInput} for command's `input` shape. + * @see {@link DescribeRepositoriesCommandOutput} for command's `response` shape. + * @see {@link ECRClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeRepositoriesCommand extends $Command< DescribeRepositoriesCommandInput, diff --git a/clients/client-ecr/commands/GetAuthorizationTokenCommand.ts b/clients/client-ecr/commands/GetAuthorizationTokenCommand.ts index a100ea7eabf7..0ed562c2ac07 100644 --- a/clients/client-ecr/commands/GetAuthorizationTokenCommand.ts +++ b/clients/client-ecr/commands/GetAuthorizationTokenCommand.ts @@ -29,6 +29,20 @@ export interface GetAuthorizationTokenCommandOutput extends GetAuthorizationToke * The AWS 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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ECRClient, GetAuthorizationTokenCommand } from "@aws-sdk/client-ecr"; // ES Modules import + * // const { ECRClient, GetAuthorizationTokenCommand } = require("@aws-sdk/client-ecr"); // CommonJS import + * const client = new ECRClient(config); + * const command = new GetAuthorizationTokenCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetAuthorizationTokenCommandInput} for command's `input` shape. + * @see {@link GetAuthorizationTokenCommandOutput} for command's `response` shape. + * @see {@link ECRClientResolvedConfig | config} for command's `input` shape. + * */ export class GetAuthorizationTokenCommand extends $Command< GetAuthorizationTokenCommandInput, diff --git a/clients/client-ecr/commands/GetDownloadUrlForLayerCommand.ts b/clients/client-ecr/commands/GetDownloadUrlForLayerCommand.ts index ebc01ff80298..e722d0325c92 100644 --- a/clients/client-ecr/commands/GetDownloadUrlForLayerCommand.ts +++ b/clients/client-ecr/commands/GetDownloadUrlForLayerCommand.ts @@ -29,6 +29,20 @@ export interface GetDownloadUrlForLayerCommandOutput extends GetDownloadUrlForLa *

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.

* + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ECRClient, GetDownloadUrlForLayerCommand } from "@aws-sdk/client-ecr"; // ES Modules import + * // const { ECRClient, GetDownloadUrlForLayerCommand } = require("@aws-sdk/client-ecr"); // CommonJS import + * const client = new ECRClient(config); + * const command = new GetDownloadUrlForLayerCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetDownloadUrlForLayerCommandInput} for command's `input` shape. + * @see {@link GetDownloadUrlForLayerCommandOutput} for command's `response` shape. + * @see {@link ECRClientResolvedConfig | config} for command's `input` shape. + * */ export class GetDownloadUrlForLayerCommand extends $Command< GetDownloadUrlForLayerCommandInput, diff --git a/clients/client-ecr/commands/GetLifecyclePolicyCommand.ts b/clients/client-ecr/commands/GetLifecyclePolicyCommand.ts index e0af0fd47132..a27218004c92 100644 --- a/clients/client-ecr/commands/GetLifecyclePolicyCommand.ts +++ b/clients/client-ecr/commands/GetLifecyclePolicyCommand.ts @@ -22,6 +22,20 @@ export interface GetLifecyclePolicyCommandOutput extends GetLifecyclePolicyRespo /** *

Retrieves the lifecycle policy for the specified repository.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ECRClient, GetLifecyclePolicyCommand } from "@aws-sdk/client-ecr"; // ES Modules import + * // const { ECRClient, GetLifecyclePolicyCommand } = require("@aws-sdk/client-ecr"); // CommonJS import + * const client = new ECRClient(config); + * const command = new GetLifecyclePolicyCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetLifecyclePolicyCommandInput} for command's `input` shape. + * @see {@link GetLifecyclePolicyCommandOutput} for command's `response` shape. + * @see {@link ECRClientResolvedConfig | config} for command's `input` shape. + * */ export class GetLifecyclePolicyCommand extends $Command< GetLifecyclePolicyCommandInput, diff --git a/clients/client-ecr/commands/GetLifecyclePolicyPreviewCommand.ts b/clients/client-ecr/commands/GetLifecyclePolicyPreviewCommand.ts index 368d5bbd5d3c..fecdabc3add7 100644 --- a/clients/client-ecr/commands/GetLifecyclePolicyPreviewCommand.ts +++ b/clients/client-ecr/commands/GetLifecyclePolicyPreviewCommand.ts @@ -23,6 +23,20 @@ export interface GetLifecyclePolicyPreviewCommandOutput extends GetLifecyclePoli /** *

Retrieves the results of the lifecycle policy preview request for the specified * repository.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ECRClient, GetLifecyclePolicyPreviewCommand } from "@aws-sdk/client-ecr"; // ES Modules import + * // const { ECRClient, GetLifecyclePolicyPreviewCommand } = require("@aws-sdk/client-ecr"); // CommonJS import + * const client = new ECRClient(config); + * const command = new GetLifecyclePolicyPreviewCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetLifecyclePolicyPreviewCommandInput} for command's `input` shape. + * @see {@link GetLifecyclePolicyPreviewCommandOutput} for command's `response` shape. + * @see {@link ECRClientResolvedConfig | config} for command's `input` shape. + * */ export class GetLifecyclePolicyPreviewCommand extends $Command< GetLifecyclePolicyPreviewCommandInput, diff --git a/clients/client-ecr/commands/GetRegistryPolicyCommand.ts b/clients/client-ecr/commands/GetRegistryPolicyCommand.ts index 0ba464b6f11c..55ffcb52c134 100644 --- a/clients/client-ecr/commands/GetRegistryPolicyCommand.ts +++ b/clients/client-ecr/commands/GetRegistryPolicyCommand.ts @@ -22,6 +22,20 @@ export interface GetRegistryPolicyCommandOutput extends GetRegistryPolicyRespons /** *

Retrieves the permissions policy for a registry.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ECRClient, GetRegistryPolicyCommand } from "@aws-sdk/client-ecr"; // ES Modules import + * // const { ECRClient, GetRegistryPolicyCommand } = require("@aws-sdk/client-ecr"); // CommonJS import + * const client = new ECRClient(config); + * const command = new GetRegistryPolicyCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetRegistryPolicyCommandInput} for command's `input` shape. + * @see {@link GetRegistryPolicyCommandOutput} for command's `response` shape. + * @see {@link ECRClientResolvedConfig | config} for command's `input` shape. + * */ export class GetRegistryPolicyCommand extends $Command< GetRegistryPolicyCommandInput, diff --git a/clients/client-ecr/commands/GetRepositoryPolicyCommand.ts b/clients/client-ecr/commands/GetRepositoryPolicyCommand.ts index fdc2425d4cf0..3f98144e5e9a 100644 --- a/clients/client-ecr/commands/GetRepositoryPolicyCommand.ts +++ b/clients/client-ecr/commands/GetRepositoryPolicyCommand.ts @@ -22,6 +22,20 @@ export interface GetRepositoryPolicyCommandOutput extends GetRepositoryPolicyRes /** *

Retrieves the repository policy for the specified repository.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ECRClient, GetRepositoryPolicyCommand } from "@aws-sdk/client-ecr"; // ES Modules import + * // const { ECRClient, GetRepositoryPolicyCommand } = require("@aws-sdk/client-ecr"); // CommonJS import + * const client = new ECRClient(config); + * const command = new GetRepositoryPolicyCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetRepositoryPolicyCommandInput} for command's `input` shape. + * @see {@link GetRepositoryPolicyCommandOutput} for command's `response` shape. + * @see {@link ECRClientResolvedConfig | config} for command's `input` shape. + * */ export class GetRepositoryPolicyCommand extends $Command< GetRepositoryPolicyCommandInput, diff --git a/clients/client-ecr/commands/InitiateLayerUploadCommand.ts b/clients/client-ecr/commands/InitiateLayerUploadCommand.ts index d331a71194f9..3f0a41f889ad 100644 --- a/clients/client-ecr/commands/InitiateLayerUploadCommand.ts +++ b/clients/client-ecr/commands/InitiateLayerUploadCommand.ts @@ -29,6 +29,20 @@ export interface InitiateLayerUploadCommandOutput extends InitiateLayerUploadRes *

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.

* + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ECRClient, InitiateLayerUploadCommand } from "@aws-sdk/client-ecr"; // ES Modules import + * // const { ECRClient, InitiateLayerUploadCommand } = require("@aws-sdk/client-ecr"); // CommonJS import + * const client = new ECRClient(config); + * const command = new InitiateLayerUploadCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link InitiateLayerUploadCommandInput} for command's `input` shape. + * @see {@link InitiateLayerUploadCommandOutput} for command's `response` shape. + * @see {@link ECRClientResolvedConfig | config} for command's `input` shape. + * */ export class InitiateLayerUploadCommand extends $Command< InitiateLayerUploadCommandInput, diff --git a/clients/client-ecr/commands/ListImagesCommand.ts b/clients/client-ecr/commands/ListImagesCommand.ts index 38ad04667f65..21d9e48f6f85 100644 --- a/clients/client-ecr/commands/ListImagesCommand.ts +++ b/clients/client-ecr/commands/ListImagesCommand.ts @@ -28,6 +28,20 @@ export interface ListImagesCommandOutput extends ListImagesResponse, __MetadataB * 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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ECRClient, ListImagesCommand } from "@aws-sdk/client-ecr"; // ES Modules import + * // const { ECRClient, ListImagesCommand } = require("@aws-sdk/client-ecr"); // CommonJS import + * const client = new ECRClient(config); + * const command = new ListImagesCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListImagesCommandInput} for command's `input` shape. + * @see {@link ListImagesCommandOutput} for command's `response` shape. + * @see {@link ECRClientResolvedConfig | config} for command's `input` shape. + * */ export class ListImagesCommand extends $Command< ListImagesCommandInput, diff --git a/clients/client-ecr/commands/ListTagsForResourceCommand.ts b/clients/client-ecr/commands/ListTagsForResourceCommand.ts index d8d9765fa9bf..e4d54ba1c605 100644 --- a/clients/client-ecr/commands/ListTagsForResourceCommand.ts +++ b/clients/client-ecr/commands/ListTagsForResourceCommand.ts @@ -22,6 +22,20 @@ export interface ListTagsForResourceCommandOutput extends ListTagsForResourceRes /** *

List the tags for an Amazon ECR resource.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ECRClient, ListTagsForResourceCommand } from "@aws-sdk/client-ecr"; // ES Modules import + * // const { ECRClient, ListTagsForResourceCommand } = require("@aws-sdk/client-ecr"); // CommonJS import + * const client = new ECRClient(config); + * const command = new ListTagsForResourceCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListTagsForResourceCommandInput} for command's `input` shape. + * @see {@link ListTagsForResourceCommandOutput} for command's `response` shape. + * @see {@link ECRClientResolvedConfig | config} for command's `input` shape. + * */ export class ListTagsForResourceCommand extends $Command< ListTagsForResourceCommandInput, diff --git a/clients/client-ecr/commands/PutImageCommand.ts b/clients/client-ecr/commands/PutImageCommand.ts index d7241081c99e..1b320e862aea 100644 --- a/clients/client-ecr/commands/PutImageCommand.ts +++ b/clients/client-ecr/commands/PutImageCommand.ts @@ -27,6 +27,20 @@ export interface PutImageCommandOutput extends PutImageResponse, __MetadataBeare *

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.

* + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ECRClient, PutImageCommand } from "@aws-sdk/client-ecr"; // ES Modules import + * // const { ECRClient, PutImageCommand } = require("@aws-sdk/client-ecr"); // CommonJS import + * const client = new ECRClient(config); + * const command = new PutImageCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link PutImageCommandInput} for command's `input` shape. + * @see {@link PutImageCommandOutput} for command's `response` shape. + * @see {@link ECRClientResolvedConfig | config} for command's `input` shape. + * */ export class PutImageCommand extends $Command { // Start section: command_properties diff --git a/clients/client-ecr/commands/PutImageScanningConfigurationCommand.ts b/clients/client-ecr/commands/PutImageScanningConfigurationCommand.ts index be6a1c09852f..a6596b419a05 100644 --- a/clients/client-ecr/commands/PutImageScanningConfigurationCommand.ts +++ b/clients/client-ecr/commands/PutImageScanningConfigurationCommand.ts @@ -24,6 +24,20 @@ export interface PutImageScanningConfigurationCommandOutput /** *

Updates the image scanning configuration for the specified repository.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ECRClient, PutImageScanningConfigurationCommand } from "@aws-sdk/client-ecr"; // ES Modules import + * // const { ECRClient, PutImageScanningConfigurationCommand } = require("@aws-sdk/client-ecr"); // CommonJS import + * const client = new ECRClient(config); + * const command = new PutImageScanningConfigurationCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link PutImageScanningConfigurationCommandInput} for command's `input` shape. + * @see {@link PutImageScanningConfigurationCommandOutput} for command's `response` shape. + * @see {@link ECRClientResolvedConfig | config} for command's `input` shape. + * */ export class PutImageScanningConfigurationCommand extends $Command< PutImageScanningConfigurationCommandInput, diff --git a/clients/client-ecr/commands/PutImageTagMutabilityCommand.ts b/clients/client-ecr/commands/PutImageTagMutabilityCommand.ts index 2ffe4c7b29f6..16aa529017d4 100644 --- a/clients/client-ecr/commands/PutImageTagMutabilityCommand.ts +++ b/clients/client-ecr/commands/PutImageTagMutabilityCommand.ts @@ -24,6 +24,20 @@ export interface PutImageTagMutabilityCommandOutput extends PutImageTagMutabilit *

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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ECRClient, PutImageTagMutabilityCommand } from "@aws-sdk/client-ecr"; // ES Modules import + * // const { ECRClient, PutImageTagMutabilityCommand } = require("@aws-sdk/client-ecr"); // CommonJS import + * const client = new ECRClient(config); + * const command = new PutImageTagMutabilityCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link PutImageTagMutabilityCommandInput} for command's `input` shape. + * @see {@link PutImageTagMutabilityCommandOutput} for command's `response` shape. + * @see {@link ECRClientResolvedConfig | config} for command's `input` shape. + * */ export class PutImageTagMutabilityCommand extends $Command< PutImageTagMutabilityCommandInput, diff --git a/clients/client-ecr/commands/PutLifecyclePolicyCommand.ts b/clients/client-ecr/commands/PutLifecyclePolicyCommand.ts index 82dabb52a0db..bb0cabf2d9a7 100644 --- a/clients/client-ecr/commands/PutLifecyclePolicyCommand.ts +++ b/clients/client-ecr/commands/PutLifecyclePolicyCommand.ts @@ -24,6 +24,20 @@ export interface PutLifecyclePolicyCommandOutput extends PutLifecyclePolicyRespo *

Creates or updates the lifecycle policy for the specified repository. For more * information, see Lifecycle Policy * Template.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ECRClient, PutLifecyclePolicyCommand } from "@aws-sdk/client-ecr"; // ES Modules import + * // const { ECRClient, PutLifecyclePolicyCommand } = require("@aws-sdk/client-ecr"); // CommonJS import + * const client = new ECRClient(config); + * const command = new PutLifecyclePolicyCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link PutLifecyclePolicyCommandInput} for command's `input` shape. + * @see {@link PutLifecyclePolicyCommandOutput} for command's `response` shape. + * @see {@link ECRClientResolvedConfig | config} for command's `input` shape. + * */ export class PutLifecyclePolicyCommand extends $Command< PutLifecyclePolicyCommandInput, diff --git a/clients/client-ecr/commands/PutRegistryPolicyCommand.ts b/clients/client-ecr/commands/PutRegistryPolicyCommand.ts index ea0d2c7d8e2f..45bbd3686832 100644 --- a/clients/client-ecr/commands/PutRegistryPolicyCommand.ts +++ b/clients/client-ecr/commands/PutRegistryPolicyCommand.ts @@ -24,6 +24,20 @@ export interface PutRegistryPolicyCommandOutput extends PutRegistryPolicyRespons *

Creates or updates the permissions policy for your registry.

*

A registry policy is used to specify permissions for another AWS account and is used * when configuring cross-account replication. For more information, see Registry permissions in the Amazon Elastic Container Registry User Guide.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ECRClient, PutRegistryPolicyCommand } from "@aws-sdk/client-ecr"; // ES Modules import + * // const { ECRClient, PutRegistryPolicyCommand } = require("@aws-sdk/client-ecr"); // CommonJS import + * const client = new ECRClient(config); + * const command = new PutRegistryPolicyCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link PutRegistryPolicyCommandInput} for command's `input` shape. + * @see {@link PutRegistryPolicyCommandOutput} for command's `response` shape. + * @see {@link ECRClientResolvedConfig | config} for command's `input` shape. + * */ export class PutRegistryPolicyCommand extends $Command< PutRegistryPolicyCommandInput, diff --git a/clients/client-ecr/commands/PutReplicationConfigurationCommand.ts b/clients/client-ecr/commands/PutReplicationConfigurationCommand.ts index d62e44784ae5..2ac7912d24a6 100644 --- a/clients/client-ecr/commands/PutReplicationConfigurationCommand.ts +++ b/clients/client-ecr/commands/PutReplicationConfigurationCommand.ts @@ -34,6 +34,20 @@ export interface PutReplicationConfigurationCommandOutput * source account permission to replicate. This permission is controlled using a * registry permissions policy. For more information, see PutRegistryPolicy.

* + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ECRClient, PutReplicationConfigurationCommand } from "@aws-sdk/client-ecr"; // ES Modules import + * // const { ECRClient, PutReplicationConfigurationCommand } = require("@aws-sdk/client-ecr"); // CommonJS import + * const client = new ECRClient(config); + * const command = new PutReplicationConfigurationCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link PutReplicationConfigurationCommandInput} for command's `input` shape. + * @see {@link PutReplicationConfigurationCommandOutput} for command's `response` shape. + * @see {@link ECRClientResolvedConfig | config} for command's `input` shape. + * */ export class PutReplicationConfigurationCommand extends $Command< PutReplicationConfigurationCommandInput, diff --git a/clients/client-ecr/commands/SetRepositoryPolicyCommand.ts b/clients/client-ecr/commands/SetRepositoryPolicyCommand.ts index f76393579cb7..b11a76bfe464 100644 --- a/clients/client-ecr/commands/SetRepositoryPolicyCommand.ts +++ b/clients/client-ecr/commands/SetRepositoryPolicyCommand.ts @@ -24,6 +24,20 @@ export interface SetRepositoryPolicyCommandOutput extends SetRepositoryPolicyRes *

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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ECRClient, SetRepositoryPolicyCommand } from "@aws-sdk/client-ecr"; // ES Modules import + * // const { ECRClient, SetRepositoryPolicyCommand } = require("@aws-sdk/client-ecr"); // CommonJS import + * const client = new ECRClient(config); + * const command = new SetRepositoryPolicyCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link SetRepositoryPolicyCommandInput} for command's `input` shape. + * @see {@link SetRepositoryPolicyCommandOutput} for command's `response` shape. + * @see {@link ECRClientResolvedConfig | config} for command's `input` shape. + * */ export class SetRepositoryPolicyCommand extends $Command< SetRepositoryPolicyCommandInput, diff --git a/clients/client-ecr/commands/StartImageScanCommand.ts b/clients/client-ecr/commands/StartImageScanCommand.ts index a48775bed52f..ed79eb8bd5ad 100644 --- a/clients/client-ecr/commands/StartImageScanCommand.ts +++ b/clients/client-ecr/commands/StartImageScanCommand.ts @@ -25,6 +25,20 @@ export interface StartImageScanCommandOutput extends StartImageScanResponse, __M * 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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ECRClient, StartImageScanCommand } from "@aws-sdk/client-ecr"; // ES Modules import + * // const { ECRClient, StartImageScanCommand } = require("@aws-sdk/client-ecr"); // CommonJS import + * const client = new ECRClient(config); + * const command = new StartImageScanCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link StartImageScanCommandInput} for command's `input` shape. + * @see {@link StartImageScanCommandOutput} for command's `response` shape. + * @see {@link ECRClientResolvedConfig | config} for command's `input` shape. + * */ export class StartImageScanCommand extends $Command< StartImageScanCommandInput, diff --git a/clients/client-ecr/commands/StartLifecyclePolicyPreviewCommand.ts b/clients/client-ecr/commands/StartLifecyclePolicyPreviewCommand.ts index 50868f26b692..b367246930ef 100644 --- a/clients/client-ecr/commands/StartLifecyclePolicyPreviewCommand.ts +++ b/clients/client-ecr/commands/StartLifecyclePolicyPreviewCommand.ts @@ -25,6 +25,20 @@ export interface StartLifecyclePolicyPreviewCommandOutput /** *

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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ECRClient, StartLifecyclePolicyPreviewCommand } from "@aws-sdk/client-ecr"; // ES Modules import + * // const { ECRClient, StartLifecyclePolicyPreviewCommand } = require("@aws-sdk/client-ecr"); // CommonJS import + * const client = new ECRClient(config); + * const command = new StartLifecyclePolicyPreviewCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link StartLifecyclePolicyPreviewCommandInput} for command's `input` shape. + * @see {@link StartLifecyclePolicyPreviewCommandOutput} for command's `response` shape. + * @see {@link ECRClientResolvedConfig | config} for command's `input` shape. + * */ export class StartLifecyclePolicyPreviewCommand extends $Command< StartLifecyclePolicyPreviewCommandInput, diff --git a/clients/client-ecr/commands/TagResourceCommand.ts b/clients/client-ecr/commands/TagResourceCommand.ts index 2038a59a0b21..3a1daa93ab6c 100644 --- a/clients/client-ecr/commands/TagResourceCommand.ts +++ b/clients/client-ecr/commands/TagResourceCommand.ts @@ -23,6 +23,20 @@ export interface TagResourceCommandOutput extends TagResourceResponse, __Metadat /** *

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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ECRClient, TagResourceCommand } from "@aws-sdk/client-ecr"; // ES Modules import + * // const { ECRClient, TagResourceCommand } = require("@aws-sdk/client-ecr"); // CommonJS import + * const client = new ECRClient(config); + * const command = new TagResourceCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link TagResourceCommandInput} for command's `input` shape. + * @see {@link TagResourceCommandOutput} for command's `response` shape. + * @see {@link ECRClientResolvedConfig | config} for command's `input` shape. + * */ export class TagResourceCommand extends $Command< TagResourceCommandInput, diff --git a/clients/client-ecr/commands/UntagResourceCommand.ts b/clients/client-ecr/commands/UntagResourceCommand.ts index 1cd13abcfeff..bf523e020a29 100644 --- a/clients/client-ecr/commands/UntagResourceCommand.ts +++ b/clients/client-ecr/commands/UntagResourceCommand.ts @@ -22,6 +22,20 @@ export interface UntagResourceCommandOutput extends UntagResourceResponse, __Met /** *

Deletes specified tags from a resource.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ECRClient, UntagResourceCommand } from "@aws-sdk/client-ecr"; // ES Modules import + * // const { ECRClient, UntagResourceCommand } = require("@aws-sdk/client-ecr"); // CommonJS import + * const client = new ECRClient(config); + * const command = new UntagResourceCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link UntagResourceCommandInput} for command's `input` shape. + * @see {@link UntagResourceCommandOutput} for command's `response` shape. + * @see {@link ECRClientResolvedConfig | config} for command's `input` shape. + * */ export class UntagResourceCommand extends $Command< UntagResourceCommandInput, diff --git a/clients/client-ecr/commands/UploadLayerPartCommand.ts b/clients/client-ecr/commands/UploadLayerPartCommand.ts index 6236bbe3e0b7..f4b69c9f9b73 100644 --- a/clients/client-ecr/commands/UploadLayerPartCommand.ts +++ b/clients/client-ecr/commands/UploadLayerPartCommand.ts @@ -29,6 +29,20 @@ export interface UploadLayerPartCommandOutput extends UploadLayerPartResponse, _ *

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.

* + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ECRClient, UploadLayerPartCommand } from "@aws-sdk/client-ecr"; // ES Modules import + * // const { ECRClient, UploadLayerPartCommand } = require("@aws-sdk/client-ecr"); // CommonJS import + * const client = new ECRClient(config); + * const command = new UploadLayerPartCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link UploadLayerPartCommandInput} for command's `input` shape. + * @see {@link UploadLayerPartCommandOutput} for command's `response` shape. + * @see {@link ECRClientResolvedConfig | config} for command's `input` shape. + * */ export class UploadLayerPartCommand extends $Command< UploadLayerPartCommandInput, diff --git a/clients/client-ecr/models/models_0.ts b/clients/client-ecr/models/models_0.ts index 8a3b86f0a017..fb45399b138a 100644 --- a/clients/client-ecr/models/models_0.ts +++ b/clients/client-ecr/models/models_0.ts @@ -20,6 +20,9 @@ export interface BatchCheckLayerAvailabilityRequest { } export namespace BatchCheckLayerAvailabilityRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: BatchCheckLayerAvailabilityRequest): any => ({ ...obj, }); @@ -51,6 +54,9 @@ export interface LayerFailure { } export namespace LayerFailure { + /** + * @internal + */ export const filterSensitiveLog = (obj: LayerFailure): any => ({ ...obj, }); @@ -89,6 +95,9 @@ export interface Layer { } export namespace Layer { + /** + * @internal + */ export const filterSensitiveLog = (obj: Layer): any => ({ ...obj, }); @@ -108,6 +117,9 @@ export interface BatchCheckLayerAvailabilityResponse { } export namespace BatchCheckLayerAvailabilityResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: BatchCheckLayerAvailabilityResponse): any => ({ ...obj, }); @@ -127,6 +139,9 @@ export interface InvalidParameterException extends __SmithyException, $MetadataB } export namespace InvalidParameterException { + /** + * @internal + */ export const filterSensitiveLog = (obj: InvalidParameterException): any => ({ ...obj, }); @@ -146,6 +161,9 @@ export interface RepositoryNotFoundException extends __SmithyException, $Metadat } export namespace RepositoryNotFoundException { + /** + * @internal + */ export const filterSensitiveLog = (obj: RepositoryNotFoundException): any => ({ ...obj, }); @@ -164,6 +182,9 @@ export interface ServerException extends __SmithyException, $MetadataBearer { } export namespace ServerException { + /** + * @internal + */ export const filterSensitiveLog = (obj: ServerException): any => ({ ...obj, }); @@ -185,6 +206,9 @@ export interface ImageIdentifier { } export namespace ImageIdentifier { + /** + * @internal + */ export const filterSensitiveLog = (obj: ImageIdentifier): any => ({ ...obj, }); @@ -215,6 +239,9 @@ export interface BatchDeleteImageRequest { } export namespace BatchDeleteImageRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: BatchDeleteImageRequest): any => ({ ...obj, }); @@ -251,6 +278,9 @@ export interface ImageFailure { } export namespace ImageFailure { + /** + * @internal + */ export const filterSensitiveLog = (obj: ImageFailure): any => ({ ...obj, }); @@ -269,6 +299,9 @@ export interface BatchDeleteImageResponse { } export namespace BatchDeleteImageResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: BatchDeleteImageResponse): any => ({ ...obj, }); @@ -304,6 +337,9 @@ export interface BatchGetImageRequest { } export namespace BatchGetImageRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: BatchGetImageRequest): any => ({ ...obj, }); @@ -340,6 +376,9 @@ export interface Image { } export namespace Image { + /** + * @internal + */ export const filterSensitiveLog = (obj: Image): any => ({ ...obj, }); @@ -358,6 +397,9 @@ export interface BatchGetImageResponse { } export namespace BatchGetImageResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: BatchGetImageResponse): any => ({ ...obj, }); @@ -388,6 +430,9 @@ export interface CompleteLayerUploadRequest { } export namespace CompleteLayerUploadRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: CompleteLayerUploadRequest): any => ({ ...obj, }); @@ -416,6 +461,9 @@ export interface CompleteLayerUploadResponse { } export namespace CompleteLayerUploadResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: CompleteLayerUploadResponse): any => ({ ...obj, }); @@ -434,6 +482,9 @@ export interface EmptyUploadException extends __SmithyException, $MetadataBearer } export namespace EmptyUploadException { + /** + * @internal + */ export const filterSensitiveLog = (obj: EmptyUploadException): any => ({ ...obj, }); @@ -453,6 +504,9 @@ export interface InvalidLayerException extends __SmithyException, $MetadataBeare } export namespace InvalidLayerException { + /** + * @internal + */ export const filterSensitiveLog = (obj: InvalidLayerException): any => ({ ...obj, }); @@ -472,6 +526,9 @@ export interface KmsException extends __SmithyException, $MetadataBearer { } export namespace KmsException { + /** + * @internal + */ export const filterSensitiveLog = (obj: KmsException): any => ({ ...obj, }); @@ -490,6 +547,9 @@ export interface LayerAlreadyExistsException extends __SmithyException, $Metadat } export namespace LayerAlreadyExistsException { + /** + * @internal + */ export const filterSensitiveLog = (obj: LayerAlreadyExistsException): any => ({ ...obj, }); @@ -508,6 +568,9 @@ export interface LayerPartTooSmallException extends __SmithyException, $Metadata } export namespace LayerPartTooSmallException { + /** + * @internal + */ export const filterSensitiveLog = (obj: LayerPartTooSmallException): any => ({ ...obj, }); @@ -527,6 +590,9 @@ export interface UploadNotFoundException extends __SmithyException, $MetadataBea } export namespace UploadNotFoundException { + /** + * @internal + */ export const filterSensitiveLog = (obj: UploadNotFoundException): any => ({ ...obj, }); @@ -577,6 +643,9 @@ export interface EncryptionConfiguration { } export namespace EncryptionConfiguration { + /** + * @internal + */ export const filterSensitiveLog = (obj: EncryptionConfiguration): any => ({ ...obj, }); @@ -596,6 +665,9 @@ export interface ImageScanningConfiguration { } export namespace ImageScanningConfiguration { + /** + * @internal + */ export const filterSensitiveLog = (obj: ImageScanningConfiguration): any => ({ ...obj, }); @@ -627,6 +699,9 @@ export interface Tag { } export namespace Tag { + /** + * @internal + */ export const filterSensitiveLog = (obj: Tag): any => ({ ...obj, }); @@ -670,6 +745,9 @@ export interface CreateRepositoryRequest { } export namespace CreateRepositoryRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateRepositoryRequest): any => ({ ...obj, }); @@ -725,6 +803,9 @@ export interface Repository { } export namespace Repository { + /** + * @internal + */ export const filterSensitiveLog = (obj: Repository): any => ({ ...obj, }); @@ -738,6 +819,9 @@ export interface CreateRepositoryResponse { } export namespace CreateRepositoryResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateRepositoryResponse): any => ({ ...obj, }); @@ -754,6 +838,9 @@ export interface InvalidTagParameterException extends __SmithyException, $Metada } export namespace InvalidTagParameterException { + /** + * @internal + */ export const filterSensitiveLog = (obj: InvalidTagParameterException): any => ({ ...obj, }); @@ -774,6 +861,9 @@ export interface LimitExceededException extends __SmithyException, $MetadataBear } export namespace LimitExceededException { + /** + * @internal + */ export const filterSensitiveLog = (obj: LimitExceededException): any => ({ ...obj, }); @@ -792,6 +882,9 @@ export interface RepositoryAlreadyExistsException extends __SmithyException, $Me } export namespace RepositoryAlreadyExistsException { + /** + * @internal + */ export const filterSensitiveLog = (obj: RepositoryAlreadyExistsException): any => ({ ...obj, }); @@ -808,6 +901,9 @@ export interface TooManyTagsException extends __SmithyException, $MetadataBearer } export namespace TooManyTagsException { + /** + * @internal + */ export const filterSensitiveLog = (obj: TooManyTagsException): any => ({ ...obj, }); @@ -827,6 +923,9 @@ export interface DeleteLifecyclePolicyRequest { } export namespace DeleteLifecyclePolicyRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteLifecyclePolicyRequest): any => ({ ...obj, }); @@ -855,6 +954,9 @@ export interface DeleteLifecyclePolicyResponse { } export namespace DeleteLifecyclePolicyResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteLifecyclePolicyResponse): any => ({ ...obj, }); @@ -871,6 +973,9 @@ export interface LifecyclePolicyNotFoundException extends __SmithyException, $Me } export namespace LifecyclePolicyNotFoundException { + /** + * @internal + */ export const filterSensitiveLog = (obj: LifecyclePolicyNotFoundException): any => ({ ...obj, }); @@ -879,6 +984,9 @@ export namespace LifecyclePolicyNotFoundException { export interface DeleteRegistryPolicyRequest {} export namespace DeleteRegistryPolicyRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteRegistryPolicyRequest): any => ({ ...obj, }); @@ -897,6 +1005,9 @@ export interface DeleteRegistryPolicyResponse { } export namespace DeleteRegistryPolicyResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteRegistryPolicyResponse): any => ({ ...obj, }); @@ -912,6 +1023,9 @@ export interface RegistryPolicyNotFoundException extends __SmithyException, $Met } export namespace RegistryPolicyNotFoundException { + /** + * @internal + */ export const filterSensitiveLog = (obj: RegistryPolicyNotFoundException): any => ({ ...obj, }); @@ -936,6 +1050,9 @@ export interface DeleteRepositoryRequest { } export namespace DeleteRepositoryRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteRepositoryRequest): any => ({ ...obj, }); @@ -949,6 +1066,9 @@ export interface DeleteRepositoryResponse { } export namespace DeleteRepositoryResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteRepositoryResponse): any => ({ ...obj, }); @@ -968,6 +1088,9 @@ export interface RepositoryNotEmptyException extends __SmithyException, $Metadat } export namespace RepositoryNotEmptyException { + /** + * @internal + */ export const filterSensitiveLog = (obj: RepositoryNotEmptyException): any => ({ ...obj, }); @@ -988,6 +1111,9 @@ export interface DeleteRepositoryPolicyRequest { } export namespace DeleteRepositoryPolicyRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteRepositoryPolicyRequest): any => ({ ...obj, }); @@ -1011,6 +1137,9 @@ export interface DeleteRepositoryPolicyResponse { } export namespace DeleteRepositoryPolicyResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteRepositoryPolicyResponse): any => ({ ...obj, }); @@ -1030,6 +1159,9 @@ export interface RepositoryPolicyNotFoundException extends __SmithyException, $M } export namespace RepositoryPolicyNotFoundException { + /** + * @internal + */ export const filterSensitiveLog = (obj: RepositoryPolicyNotFoundException): any => ({ ...obj, }); @@ -1055,6 +1187,9 @@ export interface DescribeImagesFilter { } export namespace DescribeImagesFilter { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeImagesFilter): any => ({ ...obj, }); @@ -1108,6 +1243,9 @@ export interface DescribeImagesRequest { } export namespace DescribeImagesRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeImagesRequest): any => ({ ...obj, }); @@ -1143,6 +1281,9 @@ export interface ImageScanFindingsSummary { } export namespace ImageScanFindingsSummary { + /** + * @internal + */ export const filterSensitiveLog = (obj: ImageScanFindingsSummary): any => ({ ...obj, }); @@ -1170,6 +1311,9 @@ export interface ImageScanStatus { } export namespace ImageScanStatus { + /** + * @internal + */ export const filterSensitiveLog = (obj: ImageScanStatus): any => ({ ...obj, }); @@ -1241,6 +1385,9 @@ export interface ImageDetail { } export namespace ImageDetail { + /** + * @internal + */ export const filterSensitiveLog = (obj: ImageDetail): any => ({ ...obj, }); @@ -1264,6 +1411,9 @@ export interface DescribeImagesResponse { } export namespace DescribeImagesResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeImagesResponse): any => ({ ...obj, }); @@ -1279,6 +1429,9 @@ export interface ImageNotFoundException extends __SmithyException, $MetadataBear } export namespace ImageNotFoundException { + /** + * @internal + */ export const filterSensitiveLog = (obj: ImageNotFoundException): any => ({ ...obj, }); @@ -1326,6 +1479,9 @@ export interface DescribeImageScanFindingsRequest { } export namespace DescribeImageScanFindingsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeImageScanFindingsRequest): any => ({ ...obj, }); @@ -1347,6 +1503,9 @@ export interface Attribute { } export namespace Attribute { + /** + * @internal + */ export const filterSensitiveLog = (obj: Attribute): any => ({ ...obj, }); @@ -1383,6 +1542,9 @@ export interface ImageScanFinding { } export namespace ImageScanFinding { + /** + * @internal + */ export const filterSensitiveLog = (obj: ImageScanFinding): any => ({ ...obj, }); @@ -1414,6 +1576,9 @@ export interface ImageScanFindings { } export namespace ImageScanFindings { + /** + * @internal + */ export const filterSensitiveLog = (obj: ImageScanFindings): any => ({ ...obj, }); @@ -1456,6 +1621,9 @@ export interface DescribeImageScanFindingsResponse { } export namespace DescribeImageScanFindingsResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeImageScanFindingsResponse): any => ({ ...obj, }); @@ -1472,6 +1640,9 @@ export interface ScanNotFoundException extends __SmithyException, $MetadataBeare } export namespace ScanNotFoundException { + /** + * @internal + */ export const filterSensitiveLog = (obj: ScanNotFoundException): any => ({ ...obj, }); @@ -1480,6 +1651,9 @@ export namespace ScanNotFoundException { export interface DescribeRegistryRequest {} export namespace DescribeRegistryRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeRegistryRequest): any => ({ ...obj, }); @@ -1501,6 +1675,9 @@ export interface ReplicationDestination { } export namespace ReplicationDestination { + /** + * @internal + */ export const filterSensitiveLog = (obj: ReplicationDestination): any => ({ ...obj, }); @@ -1519,6 +1696,9 @@ export interface ReplicationRule { } export namespace ReplicationRule { + /** + * @internal + */ export const filterSensitiveLog = (obj: ReplicationRule): any => ({ ...obj, }); @@ -1537,6 +1717,9 @@ export interface ReplicationConfiguration { } export namespace ReplicationConfiguration { + /** + * @internal + */ export const filterSensitiveLog = (obj: ReplicationConfiguration): any => ({ ...obj, }); @@ -1555,6 +1738,9 @@ export interface DescribeRegistryResponse { } export namespace DescribeRegistryResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeRegistryResponse): any => ({ ...obj, }); @@ -1570,6 +1756,9 @@ export interface ValidationException extends __SmithyException, $MetadataBearer } export namespace ValidationException { + /** + * @internal + */ export const filterSensitiveLog = (obj: ValidationException): any => ({ ...obj, }); @@ -1618,6 +1807,9 @@ export interface DescribeRepositoriesRequest { } export namespace DescribeRepositoriesRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeRepositoriesRequest): any => ({ ...obj, }); @@ -1640,6 +1832,9 @@ export interface DescribeRepositoriesResponse { } export namespace DescribeRepositoriesResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeRepositoriesResponse): any => ({ ...obj, }); @@ -1656,6 +1851,9 @@ export interface GetAuthorizationTokenRequest { } export namespace GetAuthorizationTokenRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetAuthorizationTokenRequest): any => ({ ...obj, }); @@ -1689,6 +1887,9 @@ export interface AuthorizationData { } export namespace AuthorizationData { + /** + * @internal + */ export const filterSensitiveLog = (obj: AuthorizationData): any => ({ ...obj, }); @@ -1703,6 +1904,9 @@ export interface GetAuthorizationTokenResponse { } export namespace GetAuthorizationTokenResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetAuthorizationTokenResponse): any => ({ ...obj, }); @@ -1727,6 +1931,9 @@ export interface GetDownloadUrlForLayerRequest { } export namespace GetDownloadUrlForLayerRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetDownloadUrlForLayerRequest): any => ({ ...obj, }); @@ -1745,6 +1952,9 @@ export interface GetDownloadUrlForLayerResponse { } export namespace GetDownloadUrlForLayerResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetDownloadUrlForLayerResponse): any => ({ ...obj, }); @@ -1764,6 +1974,9 @@ export interface LayerInaccessibleException extends __SmithyException, $Metadata } export namespace LayerInaccessibleException { + /** + * @internal + */ export const filterSensitiveLog = (obj: LayerInaccessibleException): any => ({ ...obj, }); @@ -1783,6 +1996,9 @@ export interface LayersNotFoundException extends __SmithyException, $MetadataBea } export namespace LayersNotFoundException { + /** + * @internal + */ export const filterSensitiveLog = (obj: LayersNotFoundException): any => ({ ...obj, }); @@ -1802,6 +2018,9 @@ export interface GetLifecyclePolicyRequest { } export namespace GetLifecyclePolicyRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetLifecyclePolicyRequest): any => ({ ...obj, }); @@ -1830,6 +2049,9 @@ export interface GetLifecyclePolicyResponse { } export namespace GetLifecyclePolicyResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetLifecyclePolicyResponse): any => ({ ...obj, }); @@ -1846,6 +2068,9 @@ export interface LifecyclePolicyPreviewFilter { } export namespace LifecyclePolicyPreviewFilter { + /** + * @internal + */ export const filterSensitiveLog = (obj: LifecyclePolicyPreviewFilter): any => ({ ...obj, }); @@ -1901,6 +2126,9 @@ export interface GetLifecyclePolicyPreviewRequest { } export namespace GetLifecyclePolicyPreviewRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetLifecyclePolicyPreviewRequest): any => ({ ...obj, }); @@ -1921,6 +2149,9 @@ export interface LifecyclePolicyRuleAction { } export namespace LifecyclePolicyRuleAction { + /** + * @internal + */ export const filterSensitiveLog = (obj: LifecyclePolicyRuleAction): any => ({ ...obj, }); @@ -1958,6 +2189,9 @@ export interface LifecyclePolicyPreviewResult { } export namespace LifecyclePolicyPreviewResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: LifecyclePolicyPreviewResult): any => ({ ...obj, }); @@ -1981,6 +2215,9 @@ export interface LifecyclePolicyPreviewSummary { } export namespace LifecyclePolicyPreviewSummary { + /** + * @internal + */ export const filterSensitiveLog = (obj: LifecyclePolicyPreviewSummary): any => ({ ...obj, }); @@ -2028,6 +2265,9 @@ export interface GetLifecyclePolicyPreviewResponse { } export namespace GetLifecyclePolicyPreviewResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetLifecyclePolicyPreviewResponse): any => ({ ...obj, }); @@ -2043,6 +2283,9 @@ export interface LifecyclePolicyPreviewNotFoundException extends __SmithyExcepti } export namespace LifecyclePolicyPreviewNotFoundException { + /** + * @internal + */ export const filterSensitiveLog = (obj: LifecyclePolicyPreviewNotFoundException): any => ({ ...obj, }); @@ -2051,6 +2294,9 @@ export namespace LifecyclePolicyPreviewNotFoundException { export interface GetRegistryPolicyRequest {} export namespace GetRegistryPolicyRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetRegistryPolicyRequest): any => ({ ...obj, }); @@ -2069,6 +2315,9 @@ export interface GetRegistryPolicyResponse { } export namespace GetRegistryPolicyResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetRegistryPolicyResponse): any => ({ ...obj, }); @@ -2088,6 +2337,9 @@ export interface GetRepositoryPolicyRequest { } export namespace GetRepositoryPolicyRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetRepositoryPolicyRequest): any => ({ ...obj, }); @@ -2111,6 +2363,9 @@ export interface GetRepositoryPolicyResponse { } export namespace GetRepositoryPolicyResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetRepositoryPolicyResponse): any => ({ ...obj, }); @@ -2130,6 +2385,9 @@ export interface InitiateLayerUploadRequest { } export namespace InitiateLayerUploadRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: InitiateLayerUploadRequest): any => ({ ...obj, }); @@ -2149,6 +2407,9 @@ export interface InitiateLayerUploadResponse { } export namespace InitiateLayerUploadResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: InitiateLayerUploadResponse): any => ({ ...obj, }); @@ -2167,6 +2428,9 @@ export interface ListImagesFilter { } export namespace ListImagesFilter { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListImagesFilter): any => ({ ...obj, }); @@ -2217,6 +2481,9 @@ export interface ListImagesRequest { } export namespace ListImagesRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListImagesRequest): any => ({ ...obj, }); @@ -2239,6 +2506,9 @@ export interface ListImagesResponse { } export namespace ListImagesResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListImagesResponse): any => ({ ...obj, }); @@ -2253,6 +2523,9 @@ export interface ListTagsForResourceRequest { } export namespace ListTagsForResourceRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListTagsForResourceRequest): any => ({ ...obj, }); @@ -2266,6 +2539,9 @@ export interface ListTagsForResourceResponse { } export namespace ListTagsForResourceResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListTagsForResourceResponse): any => ({ ...obj, }); @@ -2285,6 +2561,9 @@ export interface ImageAlreadyExistsException extends __SmithyException, $Metadat } export namespace ImageAlreadyExistsException { + /** + * @internal + */ export const filterSensitiveLog = (obj: ImageAlreadyExistsException): any => ({ ...obj, }); @@ -2301,6 +2580,9 @@ export interface ImageDigestDoesNotMatchException extends __SmithyException, $Me } export namespace ImageDigestDoesNotMatchException { + /** + * @internal + */ export const filterSensitiveLog = (obj: ImageDigestDoesNotMatchException): any => ({ ...obj, }); @@ -2317,6 +2599,9 @@ export interface ImageTagAlreadyExistsException extends __SmithyException, $Meta } export namespace ImageTagAlreadyExistsException { + /** + * @internal + */ export const filterSensitiveLog = (obj: ImageTagAlreadyExistsException): any => ({ ...obj, }); @@ -2359,6 +2644,9 @@ export interface PutImageRequest { } export namespace PutImageRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: PutImageRequest): any => ({ ...obj, }); @@ -2372,6 +2660,9 @@ export interface PutImageResponse { } export namespace PutImageResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: PutImageResponse): any => ({ ...obj, }); @@ -2387,6 +2678,9 @@ export interface ReferencedImagesNotFoundException extends __SmithyException, $M } export namespace ReferencedImagesNotFoundException { + /** + * @internal + */ export const filterSensitiveLog = (obj: ReferencedImagesNotFoundException): any => ({ ...obj, }); @@ -2415,6 +2709,9 @@ export interface PutImageScanningConfigurationRequest { } export namespace PutImageScanningConfigurationRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: PutImageScanningConfigurationRequest): any => ({ ...obj, }); @@ -2438,6 +2735,9 @@ export interface PutImageScanningConfigurationResponse { } export namespace PutImageScanningConfigurationResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: PutImageScanningConfigurationResponse): any => ({ ...obj, }); @@ -2466,6 +2766,9 @@ export interface PutImageTagMutabilityRequest { } export namespace PutImageTagMutabilityRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: PutImageTagMutabilityRequest): any => ({ ...obj, }); @@ -2489,6 +2792,9 @@ export interface PutImageTagMutabilityResponse { } export namespace PutImageTagMutabilityResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: PutImageTagMutabilityResponse): any => ({ ...obj, }); @@ -2513,6 +2819,9 @@ export interface PutLifecyclePolicyRequest { } export namespace PutLifecyclePolicyRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: PutLifecyclePolicyRequest): any => ({ ...obj, }); @@ -2536,6 +2845,9 @@ export interface PutLifecyclePolicyResponse { } export namespace PutLifecyclePolicyResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: PutLifecyclePolicyResponse): any => ({ ...obj, }); @@ -2551,6 +2863,9 @@ export interface PutRegistryPolicyRequest { } export namespace PutRegistryPolicyRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: PutRegistryPolicyRequest): any => ({ ...obj, }); @@ -2569,6 +2884,9 @@ export interface PutRegistryPolicyResponse { } export namespace PutRegistryPolicyResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: PutRegistryPolicyResponse): any => ({ ...obj, }); @@ -2582,6 +2900,9 @@ export interface PutReplicationConfigurationRequest { } export namespace PutReplicationConfigurationRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: PutReplicationConfigurationRequest): any => ({ ...obj, }); @@ -2595,6 +2916,9 @@ export interface PutReplicationConfigurationResponse { } export namespace PutReplicationConfigurationResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: PutReplicationConfigurationResponse): any => ({ ...obj, }); @@ -2628,6 +2952,9 @@ export interface SetRepositoryPolicyRequest { } export namespace SetRepositoryPolicyRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: SetRepositoryPolicyRequest): any => ({ ...obj, }); @@ -2651,6 +2978,9 @@ export interface SetRepositoryPolicyResponse { } export namespace SetRepositoryPolicyResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: SetRepositoryPolicyResponse): any => ({ ...obj, }); @@ -2675,6 +3005,9 @@ export interface StartImageScanRequest { } export namespace StartImageScanRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: StartImageScanRequest): any => ({ ...obj, }); @@ -2703,6 +3036,9 @@ export interface StartImageScanResponse { } export namespace StartImageScanResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: StartImageScanResponse): any => ({ ...obj, }); @@ -2718,6 +3054,9 @@ export interface UnsupportedImageTypeException extends __SmithyException, $Metad } export namespace UnsupportedImageTypeException { + /** + * @internal + */ export const filterSensitiveLog = (obj: UnsupportedImageTypeException): any => ({ ...obj, }); @@ -2734,6 +3073,9 @@ export interface LifecyclePolicyPreviewInProgressException extends __SmithyExcep } export namespace LifecyclePolicyPreviewInProgressException { + /** + * @internal + */ export const filterSensitiveLog = (obj: LifecyclePolicyPreviewInProgressException): any => ({ ...obj, }); @@ -2759,6 +3101,9 @@ export interface StartLifecyclePolicyPreviewRequest { } export namespace StartLifecyclePolicyPreviewRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: StartLifecyclePolicyPreviewRequest): any => ({ ...obj, }); @@ -2787,6 +3132,9 @@ export interface StartLifecyclePolicyPreviewResponse { } export namespace StartLifecyclePolicyPreviewResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: StartLifecyclePolicyPreviewResponse): any => ({ ...obj, }); @@ -2808,6 +3156,9 @@ export interface TagResourceRequest { } export namespace TagResourceRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: TagResourceRequest): any => ({ ...obj, }); @@ -2816,6 +3167,9 @@ export namespace TagResourceRequest { export interface TagResourceResponse {} export namespace TagResourceResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: TagResourceResponse): any => ({ ...obj, }); @@ -2835,6 +3189,9 @@ export interface UntagResourceRequest { } export namespace UntagResourceRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: UntagResourceRequest): any => ({ ...obj, }); @@ -2843,6 +3200,9 @@ export namespace UntagResourceRequest { export interface UntagResourceResponse {} export namespace UntagResourceResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: UntagResourceResponse): any => ({ ...obj, }); @@ -2883,6 +3243,9 @@ export interface InvalidLayerPartException extends __SmithyException, $MetadataB } export namespace InvalidLayerPartException { + /** + * @internal + */ export const filterSensitiveLog = (obj: InvalidLayerPartException): any => ({ ...obj, }); @@ -2923,6 +3286,9 @@ export interface UploadLayerPartRequest { } export namespace UploadLayerPartRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: UploadLayerPartRequest): any => ({ ...obj, }); @@ -2951,6 +3317,9 @@ export interface UploadLayerPartResponse { } export namespace UploadLayerPartResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: UploadLayerPartResponse): any => ({ ...obj, }); diff --git a/clients/client-ecs/commands/CreateCapacityProviderCommand.ts b/clients/client-ecs/commands/CreateCapacityProviderCommand.ts index 8d9562659401..b42a0aee6ac2 100644 --- a/clients/client-ecs/commands/CreateCapacityProviderCommand.ts +++ b/clients/client-ecs/commands/CreateCapacityProviderCommand.ts @@ -28,6 +28,20 @@ export interface CreateCapacityProviderCommandOutput extends CreateCapacityProvi * AWS Fargate use the FARGATE and FARGATE_SPOT capacity providers * which are already created and available to all accounts in Regions supported by * AWS Fargate.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ECSClient, CreateCapacityProviderCommand } from "@aws-sdk/client-ecs"; // ES Modules import + * // const { ECSClient, CreateCapacityProviderCommand } = require("@aws-sdk/client-ecs"); // CommonJS import + * const client = new ECSClient(config); + * const command = new CreateCapacityProviderCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreateCapacityProviderCommandInput} for command's `input` shape. + * @see {@link CreateCapacityProviderCommandOutput} for command's `response` shape. + * @see {@link ECSClientResolvedConfig | config} for command's `input` shape. + * */ export class CreateCapacityProviderCommand extends $Command< CreateCapacityProviderCommandInput, diff --git a/clients/client-ecs/commands/CreateClusterCommand.ts b/clients/client-ecs/commands/CreateClusterCommand.ts index 75478439aa3e..902ebe8d523f 100644 --- a/clients/client-ecs/commands/CreateClusterCommand.ts +++ b/clients/client-ecs/commands/CreateClusterCommand.ts @@ -33,6 +33,20 @@ export interface CreateClusterCommandOutput extends CreateClusterResponse, __Met * Service-Linked Roles for Amazon ECS in the * Amazon Elastic Container Service Developer Guide.

* + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ECSClient, CreateClusterCommand } from "@aws-sdk/client-ecs"; // ES Modules import + * // const { ECSClient, CreateClusterCommand } = require("@aws-sdk/client-ecs"); // CommonJS import + * const client = new ECSClient(config); + * const command = new CreateClusterCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreateClusterCommandInput} for command's `input` shape. + * @see {@link CreateClusterCommandOutput} for command's `response` shape. + * @see {@link ECSClientResolvedConfig | config} for command's `input` shape. + * */ export class CreateClusterCommand extends $Command< CreateClusterCommandInput, diff --git a/clients/client-ecs/commands/CreateServiceCommand.ts b/clients/client-ecs/commands/CreateServiceCommand.ts index 6f8eac7c5965..9ef4692fe888 100644 --- a/clients/client-ecs/commands/CreateServiceCommand.ts +++ b/clients/client-ecs/commands/CreateServiceCommand.ts @@ -127,6 +127,20 @@ export interface CreateServiceCommandOutput extends CreateServiceResponse, __Met * * * + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ECSClient, CreateServiceCommand } from "@aws-sdk/client-ecs"; // ES Modules import + * // const { ECSClient, CreateServiceCommand } = require("@aws-sdk/client-ecs"); // CommonJS import + * const client = new ECSClient(config); + * const command = new CreateServiceCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreateServiceCommandInput} for command's `input` shape. + * @see {@link CreateServiceCommandOutput} for command's `response` shape. + * @see {@link ECSClientResolvedConfig | config} for command's `input` shape. + * */ export class CreateServiceCommand extends $Command< CreateServiceCommandInput, diff --git a/clients/client-ecs/commands/CreateTaskSetCommand.ts b/clients/client-ecs/commands/CreateTaskSetCommand.ts index cddf2d4b1f85..599df493babe 100644 --- a/clients/client-ecs/commands/CreateTaskSetCommand.ts +++ b/clients/client-ecs/commands/CreateTaskSetCommand.ts @@ -25,6 +25,20 @@ export interface CreateTaskSetCommandOutput extends CreateTaskSetResponse, __Met * uses the EXTERNAL deployment controller type. For more information, see * Amazon ECS Deployment * Types in the Amazon Elastic Container Service Developer Guide.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ECSClient, CreateTaskSetCommand } from "@aws-sdk/client-ecs"; // ES Modules import + * // const { ECSClient, CreateTaskSetCommand } = require("@aws-sdk/client-ecs"); // CommonJS import + * const client = new ECSClient(config); + * const command = new CreateTaskSetCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreateTaskSetCommandInput} for command's `input` shape. + * @see {@link CreateTaskSetCommandOutput} for command's `response` shape. + * @see {@link ECSClientResolvedConfig | config} for command's `input` shape. + * */ export class CreateTaskSetCommand extends $Command< CreateTaskSetCommandInput, diff --git a/clients/client-ecs/commands/DeleteAccountSettingCommand.ts b/clients/client-ecs/commands/DeleteAccountSettingCommand.ts index 7eb9e3eb5397..1cb31953a5af 100644 --- a/clients/client-ecs/commands/DeleteAccountSettingCommand.ts +++ b/clients/client-ecs/commands/DeleteAccountSettingCommand.ts @@ -23,6 +23,20 @@ export interface DeleteAccountSettingCommandOutput extends DeleteAccountSettingR /** *

Disables an account setting for a specified IAM user, IAM role, or the root user for * an account.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ECSClient, DeleteAccountSettingCommand } from "@aws-sdk/client-ecs"; // ES Modules import + * // const { ECSClient, DeleteAccountSettingCommand } = require("@aws-sdk/client-ecs"); // CommonJS import + * const client = new ECSClient(config); + * const command = new DeleteAccountSettingCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteAccountSettingCommandInput} for command's `input` shape. + * @see {@link DeleteAccountSettingCommandOutput} for command's `response` shape. + * @see {@link ECSClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteAccountSettingCommand extends $Command< DeleteAccountSettingCommandInput, diff --git a/clients/client-ecs/commands/DeleteAttributesCommand.ts b/clients/client-ecs/commands/DeleteAttributesCommand.ts index b61f6fca049c..cfb5ad075d00 100644 --- a/clients/client-ecs/commands/DeleteAttributesCommand.ts +++ b/clients/client-ecs/commands/DeleteAttributesCommand.ts @@ -22,6 +22,20 @@ export interface DeleteAttributesCommandOutput extends DeleteAttributesResponse, /** *

Deletes one or more custom attributes from an Amazon ECS resource.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ECSClient, DeleteAttributesCommand } from "@aws-sdk/client-ecs"; // ES Modules import + * // const { ECSClient, DeleteAttributesCommand } = require("@aws-sdk/client-ecs"); // CommonJS import + * const client = new ECSClient(config); + * const command = new DeleteAttributesCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteAttributesCommandInput} for command's `input` shape. + * @see {@link DeleteAttributesCommandOutput} for command's `response` shape. + * @see {@link ECSClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteAttributesCommand extends $Command< DeleteAttributesCommandInput, diff --git a/clients/client-ecs/commands/DeleteCapacityProviderCommand.ts b/clients/client-ecs/commands/DeleteCapacityProviderCommand.ts index d58365b3422b..a3525766c20c 100644 --- a/clients/client-ecs/commands/DeleteCapacityProviderCommand.ts +++ b/clients/client-ecs/commands/DeleteCapacityProviderCommand.ts @@ -36,6 +36,20 @@ export interface DeleteCapacityProviderCommandOutput extends DeleteCapacityProvi * provider are transitioned to use the capacity from the remaining capacity providers. * Only capacity providers that are not associated with a cluster can be deleted. To remove * a capacity provider from a cluster, you can either use PutClusterCapacityProviders or delete the cluster.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ECSClient, DeleteCapacityProviderCommand } from "@aws-sdk/client-ecs"; // ES Modules import + * // const { ECSClient, DeleteCapacityProviderCommand } = require("@aws-sdk/client-ecs"); // CommonJS import + * const client = new ECSClient(config); + * const command = new DeleteCapacityProviderCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteCapacityProviderCommandInput} for command's `input` shape. + * @see {@link DeleteCapacityProviderCommandOutput} for command's `response` shape. + * @see {@link ECSClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteCapacityProviderCommand extends $Command< DeleteCapacityProviderCommandInput, diff --git a/clients/client-ecs/commands/DeleteClusterCommand.ts b/clients/client-ecs/commands/DeleteClusterCommand.ts index b5c201104a41..6bd3f2a2e442 100644 --- a/clients/client-ecs/commands/DeleteClusterCommand.ts +++ b/clients/client-ecs/commands/DeleteClusterCommand.ts @@ -28,6 +28,20 @@ export interface DeleteClusterCommandOutput extends DeleteClusterResponse, __Met * 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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ECSClient, DeleteClusterCommand } from "@aws-sdk/client-ecs"; // ES Modules import + * // const { ECSClient, DeleteClusterCommand } = require("@aws-sdk/client-ecs"); // CommonJS import + * const client = new ECSClient(config); + * const command = new DeleteClusterCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteClusterCommandInput} for command's `input` shape. + * @see {@link DeleteClusterCommandOutput} for command's `response` shape. + * @see {@link ECSClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteClusterCommand extends $Command< DeleteClusterCommandInput, diff --git a/clients/client-ecs/commands/DeleteServiceCommand.ts b/clients/client-ecs/commands/DeleteServiceCommand.ts index fa7c0940e36b..0e01f176ed9c 100644 --- a/clients/client-ecs/commands/DeleteServiceCommand.ts +++ b/clients/client-ecs/commands/DeleteServiceCommand.ts @@ -42,6 +42,20 @@ export interface DeleteServiceCommandOutput extends DeleteServiceResponse, __Met * in either ACTIVE or DRAINING status, you receive an * error.

* + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ECSClient, DeleteServiceCommand } from "@aws-sdk/client-ecs"; // ES Modules import + * // const { ECSClient, DeleteServiceCommand } = require("@aws-sdk/client-ecs"); // CommonJS import + * const client = new ECSClient(config); + * const command = new DeleteServiceCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteServiceCommandInput} for command's `input` shape. + * @see {@link DeleteServiceCommandOutput} for command's `response` shape. + * @see {@link ECSClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteServiceCommand extends $Command< DeleteServiceCommandInput, diff --git a/clients/client-ecs/commands/DeleteTaskSetCommand.ts b/clients/client-ecs/commands/DeleteTaskSetCommand.ts index 2ab0066b66b0..396aa3e1379a 100644 --- a/clients/client-ecs/commands/DeleteTaskSetCommand.ts +++ b/clients/client-ecs/commands/DeleteTaskSetCommand.ts @@ -23,6 +23,20 @@ export interface DeleteTaskSetCommandOutput extends DeleteTaskSetResponse, __Met /** *

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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ECSClient, DeleteTaskSetCommand } from "@aws-sdk/client-ecs"; // ES Modules import + * // const { ECSClient, DeleteTaskSetCommand } = require("@aws-sdk/client-ecs"); // CommonJS import + * const client = new ECSClient(config); + * const command = new DeleteTaskSetCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteTaskSetCommandInput} for command's `input` shape. + * @see {@link DeleteTaskSetCommandOutput} for command's `response` shape. + * @see {@link ECSClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteTaskSetCommand extends $Command< DeleteTaskSetCommandInput, diff --git a/clients/client-ecs/commands/DeregisterContainerInstanceCommand.ts b/clients/client-ecs/commands/DeregisterContainerInstanceCommand.ts index 5a1fe3bcff74..7dbec6878b6f 100644 --- a/clients/client-ecs/commands/DeregisterContainerInstanceCommand.ts +++ b/clients/client-ecs/commands/DeregisterContainerInstanceCommand.ts @@ -36,6 +36,20 @@ export interface DeregisterContainerInstanceCommandOutput * instance from your cluster (stopped container instances or instances with * disconnected agents are not automatically deregistered when terminated).

* + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ECSClient, DeregisterContainerInstanceCommand } from "@aws-sdk/client-ecs"; // ES Modules import + * // const { ECSClient, DeregisterContainerInstanceCommand } = require("@aws-sdk/client-ecs"); // CommonJS import + * const client = new ECSClient(config); + * const command = new DeregisterContainerInstanceCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeregisterContainerInstanceCommandInput} for command's `input` shape. + * @see {@link DeregisterContainerInstanceCommandOutput} for command's `response` shape. + * @see {@link ECSClientResolvedConfig | config} for command's `input` shape. + * */ export class DeregisterContainerInstanceCommand extends $Command< DeregisterContainerInstanceCommandInput, diff --git a/clients/client-ecs/commands/DeregisterTaskDefinitionCommand.ts b/clients/client-ecs/commands/DeregisterTaskDefinitionCommand.ts index 220d03ff9e40..7c081eef060d 100644 --- a/clients/client-ecs/commands/DeregisterTaskDefinitionCommand.ts +++ b/clients/client-ecs/commands/DeregisterTaskDefinitionCommand.ts @@ -37,6 +37,20 @@ export interface DeregisterTaskDefinitionCommandOutput extends DeregisterTaskDef * you should not rely on INACTIVE task definitions persisting beyond the * lifecycle of any associated tasks and services.

* + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ECSClient, DeregisterTaskDefinitionCommand } from "@aws-sdk/client-ecs"; // ES Modules import + * // const { ECSClient, DeregisterTaskDefinitionCommand } = require("@aws-sdk/client-ecs"); // CommonJS import + * const client = new ECSClient(config); + * const command = new DeregisterTaskDefinitionCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeregisterTaskDefinitionCommandInput} for command's `input` shape. + * @see {@link DeregisterTaskDefinitionCommandOutput} for command's `response` shape. + * @see {@link ECSClientResolvedConfig | config} for command's `input` shape. + * */ export class DeregisterTaskDefinitionCommand extends $Command< DeregisterTaskDefinitionCommandInput, diff --git a/clients/client-ecs/commands/DescribeCapacityProvidersCommand.ts b/clients/client-ecs/commands/DescribeCapacityProvidersCommand.ts index d218079815b7..22aa31dea511 100644 --- a/clients/client-ecs/commands/DescribeCapacityProvidersCommand.ts +++ b/clients/client-ecs/commands/DescribeCapacityProvidersCommand.ts @@ -22,6 +22,20 @@ export interface DescribeCapacityProvidersCommandOutput extends DescribeCapacity /** *

Describes one or more of your capacity providers.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ECSClient, DescribeCapacityProvidersCommand } from "@aws-sdk/client-ecs"; // ES Modules import + * // const { ECSClient, DescribeCapacityProvidersCommand } = require("@aws-sdk/client-ecs"); // CommonJS import + * const client = new ECSClient(config); + * const command = new DescribeCapacityProvidersCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeCapacityProvidersCommandInput} for command's `input` shape. + * @see {@link DescribeCapacityProvidersCommandOutput} for command's `response` shape. + * @see {@link ECSClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeCapacityProvidersCommand extends $Command< DescribeCapacityProvidersCommandInput, diff --git a/clients/client-ecs/commands/DescribeClustersCommand.ts b/clients/client-ecs/commands/DescribeClustersCommand.ts index e05e6206d218..4fc07b1ade36 100644 --- a/clients/client-ecs/commands/DescribeClustersCommand.ts +++ b/clients/client-ecs/commands/DescribeClustersCommand.ts @@ -22,6 +22,20 @@ export interface DescribeClustersCommandOutput extends DescribeClustersResponse, /** *

Describes one or more of your clusters.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ECSClient, DescribeClustersCommand } from "@aws-sdk/client-ecs"; // ES Modules import + * // const { ECSClient, DescribeClustersCommand } = require("@aws-sdk/client-ecs"); // CommonJS import + * const client = new ECSClient(config); + * const command = new DescribeClustersCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeClustersCommandInput} for command's `input` shape. + * @see {@link DescribeClustersCommandOutput} for command's `response` shape. + * @see {@link ECSClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeClustersCommand extends $Command< DescribeClustersCommandInput, diff --git a/clients/client-ecs/commands/DescribeContainerInstancesCommand.ts b/clients/client-ecs/commands/DescribeContainerInstancesCommand.ts index 7e4f496c64b7..786549be63b5 100644 --- a/clients/client-ecs/commands/DescribeContainerInstancesCommand.ts +++ b/clients/client-ecs/commands/DescribeContainerInstancesCommand.ts @@ -23,6 +23,20 @@ export interface DescribeContainerInstancesCommandOutput extends DescribeContain /** *

Describes Amazon Elastic Container Service container instances. Returns metadata about registered and * remaining resources on each container instance requested.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ECSClient, DescribeContainerInstancesCommand } from "@aws-sdk/client-ecs"; // ES Modules import + * // const { ECSClient, DescribeContainerInstancesCommand } = require("@aws-sdk/client-ecs"); // CommonJS import + * const client = new ECSClient(config); + * const command = new DescribeContainerInstancesCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeContainerInstancesCommandInput} for command's `input` shape. + * @see {@link DescribeContainerInstancesCommandOutput} for command's `response` shape. + * @see {@link ECSClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeContainerInstancesCommand extends $Command< DescribeContainerInstancesCommandInput, diff --git a/clients/client-ecs/commands/DescribeServicesCommand.ts b/clients/client-ecs/commands/DescribeServicesCommand.ts index 082936383cfe..d8da6e9eb04d 100644 --- a/clients/client-ecs/commands/DescribeServicesCommand.ts +++ b/clients/client-ecs/commands/DescribeServicesCommand.ts @@ -22,6 +22,20 @@ export interface DescribeServicesCommandOutput extends DescribeServicesResponse, /** *

Describes the specified services running in your cluster.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ECSClient, DescribeServicesCommand } from "@aws-sdk/client-ecs"; // ES Modules import + * // const { ECSClient, DescribeServicesCommand } = require("@aws-sdk/client-ecs"); // CommonJS import + * const client = new ECSClient(config); + * const command = new DescribeServicesCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeServicesCommandInput} for command's `input` shape. + * @see {@link DescribeServicesCommandOutput} for command's `response` shape. + * @see {@link ECSClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeServicesCommand extends $Command< DescribeServicesCommandInput, diff --git a/clients/client-ecs/commands/DescribeTaskDefinitionCommand.ts b/clients/client-ecs/commands/DescribeTaskDefinitionCommand.ts index 1e35c1a2cdd6..4f9de38b0fa5 100644 --- a/clients/client-ecs/commands/DescribeTaskDefinitionCommand.ts +++ b/clients/client-ecs/commands/DescribeTaskDefinitionCommand.ts @@ -29,6 +29,20 @@ export interface DescribeTaskDefinitionCommandOutput extends DescribeTaskDefinit *

You can only describe INACTIVE task definitions while an active task * or service references them.

* + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ECSClient, DescribeTaskDefinitionCommand } from "@aws-sdk/client-ecs"; // ES Modules import + * // const { ECSClient, DescribeTaskDefinitionCommand } = require("@aws-sdk/client-ecs"); // CommonJS import + * const client = new ECSClient(config); + * const command = new DescribeTaskDefinitionCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeTaskDefinitionCommandInput} for command's `input` shape. + * @see {@link DescribeTaskDefinitionCommandOutput} for command's `response` shape. + * @see {@link ECSClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeTaskDefinitionCommand extends $Command< DescribeTaskDefinitionCommandInput, diff --git a/clients/client-ecs/commands/DescribeTaskSetsCommand.ts b/clients/client-ecs/commands/DescribeTaskSetsCommand.ts index b3a58537672c..264d351f397f 100644 --- a/clients/client-ecs/commands/DescribeTaskSetsCommand.ts +++ b/clients/client-ecs/commands/DescribeTaskSetsCommand.ts @@ -25,6 +25,20 @@ export interface DescribeTaskSetsCommandOutput extends DescribeTaskSetsResponse, * service uses the EXTERNAL deployment controller type. For more information, * see Amazon ECS Deployment * Types in the Amazon Elastic Container Service Developer Guide.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ECSClient, DescribeTaskSetsCommand } from "@aws-sdk/client-ecs"; // ES Modules import + * // const { ECSClient, DescribeTaskSetsCommand } = require("@aws-sdk/client-ecs"); // CommonJS import + * const client = new ECSClient(config); + * const command = new DescribeTaskSetsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeTaskSetsCommandInput} for command's `input` shape. + * @see {@link DescribeTaskSetsCommandOutput} for command's `response` shape. + * @see {@link ECSClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeTaskSetsCommand extends $Command< DescribeTaskSetsCommandInput, diff --git a/clients/client-ecs/commands/DescribeTasksCommand.ts b/clients/client-ecs/commands/DescribeTasksCommand.ts index d465e52afeea..8845f7077387 100644 --- a/clients/client-ecs/commands/DescribeTasksCommand.ts +++ b/clients/client-ecs/commands/DescribeTasksCommand.ts @@ -22,6 +22,20 @@ export interface DescribeTasksCommandOutput extends DescribeTasksResponse, __Met /** *

Describes a specified task or tasks.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ECSClient, DescribeTasksCommand } from "@aws-sdk/client-ecs"; // ES Modules import + * // const { ECSClient, DescribeTasksCommand } = require("@aws-sdk/client-ecs"); // CommonJS import + * const client = new ECSClient(config); + * const command = new DescribeTasksCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeTasksCommandInput} for command's `input` shape. + * @see {@link DescribeTasksCommandOutput} for command's `response` shape. + * @see {@link ECSClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeTasksCommand extends $Command< DescribeTasksCommandInput, diff --git a/clients/client-ecs/commands/DiscoverPollEndpointCommand.ts b/clients/client-ecs/commands/DiscoverPollEndpointCommand.ts index bbaaf5e4b699..aaa0fc7a2213 100644 --- a/clients/client-ecs/commands/DiscoverPollEndpointCommand.ts +++ b/clients/client-ecs/commands/DiscoverPollEndpointCommand.ts @@ -26,6 +26,20 @@ export interface DiscoverPollEndpointCommandOutput extends DiscoverPollEndpointR * *

Returns an endpoint for * the Amazon ECS agent to poll for updates.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ECSClient, DiscoverPollEndpointCommand } from "@aws-sdk/client-ecs"; // ES Modules import + * // const { ECSClient, DiscoverPollEndpointCommand } = require("@aws-sdk/client-ecs"); // CommonJS import + * const client = new ECSClient(config); + * const command = new DiscoverPollEndpointCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DiscoverPollEndpointCommandInput} for command's `input` shape. + * @see {@link DiscoverPollEndpointCommandOutput} for command's `response` shape. + * @see {@link ECSClientResolvedConfig | config} for command's `input` shape. + * */ export class DiscoverPollEndpointCommand extends $Command< DiscoverPollEndpointCommandInput, diff --git a/clients/client-ecs/commands/ExecuteCommandCommand.ts b/clients/client-ecs/commands/ExecuteCommandCommand.ts index 6220f84f78ab..de45f3f51e25 100644 --- a/clients/client-ecs/commands/ExecuteCommandCommand.ts +++ b/clients/client-ecs/commands/ExecuteCommandCommand.ts @@ -22,6 +22,20 @@ export interface ExecuteCommandCommandOutput extends ExecuteCommandResponse, __M /** *

Runs a command remotely on a container within a task.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ECSClient, ExecuteCommandCommand } from "@aws-sdk/client-ecs"; // ES Modules import + * // const { ECSClient, ExecuteCommandCommand } = require("@aws-sdk/client-ecs"); // CommonJS import + * const client = new ECSClient(config); + * const command = new ExecuteCommandCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ExecuteCommandCommandInput} for command's `input` shape. + * @see {@link ExecuteCommandCommandOutput} for command's `response` shape. + * @see {@link ECSClientResolvedConfig | config} for command's `input` shape. + * */ export class ExecuteCommandCommand extends $Command< ExecuteCommandCommandInput, diff --git a/clients/client-ecs/commands/ListAccountSettingsCommand.ts b/clients/client-ecs/commands/ListAccountSettingsCommand.ts index 934ee3553b4c..d9a5529baa83 100644 --- a/clients/client-ecs/commands/ListAccountSettingsCommand.ts +++ b/clients/client-ecs/commands/ListAccountSettingsCommand.ts @@ -22,6 +22,20 @@ export interface ListAccountSettingsCommandOutput extends ListAccountSettingsRes /** *

Lists the account settings for a specified principal.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ECSClient, ListAccountSettingsCommand } from "@aws-sdk/client-ecs"; // ES Modules import + * // const { ECSClient, ListAccountSettingsCommand } = require("@aws-sdk/client-ecs"); // CommonJS import + * const client = new ECSClient(config); + * const command = new ListAccountSettingsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListAccountSettingsCommandInput} for command's `input` shape. + * @see {@link ListAccountSettingsCommandOutput} for command's `response` shape. + * @see {@link ECSClientResolvedConfig | config} for command's `input` shape. + * */ export class ListAccountSettingsCommand extends $Command< ListAccountSettingsCommandInput, diff --git a/clients/client-ecs/commands/ListAttributesCommand.ts b/clients/client-ecs/commands/ListAttributesCommand.ts index 55cf92218203..8d3051b9505b 100644 --- a/clients/client-ecs/commands/ListAttributesCommand.ts +++ b/clients/client-ecs/commands/ListAttributesCommand.ts @@ -28,6 +28,20 @@ export interface ListAttributesCommandOutput extends ListAttributesResponse, __M * can also filter the results by attribute name and value, for example, to see which * container instances in a cluster are running a Linux AMI * (ecs.os-type=linux).

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ECSClient, ListAttributesCommand } from "@aws-sdk/client-ecs"; // ES Modules import + * // const { ECSClient, ListAttributesCommand } = require("@aws-sdk/client-ecs"); // CommonJS import + * const client = new ECSClient(config); + * const command = new ListAttributesCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListAttributesCommandInput} for command's `input` shape. + * @see {@link ListAttributesCommandOutput} for command's `response` shape. + * @see {@link ECSClientResolvedConfig | config} for command's `input` shape. + * */ export class ListAttributesCommand extends $Command< ListAttributesCommandInput, diff --git a/clients/client-ecs/commands/ListClustersCommand.ts b/clients/client-ecs/commands/ListClustersCommand.ts index 675a56c59202..8bf8ec476d7f 100644 --- a/clients/client-ecs/commands/ListClustersCommand.ts +++ b/clients/client-ecs/commands/ListClustersCommand.ts @@ -22,6 +22,20 @@ export interface ListClustersCommandOutput extends ListClustersResponse, __Metad /** *

Returns a list of existing clusters.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ECSClient, ListClustersCommand } from "@aws-sdk/client-ecs"; // ES Modules import + * // const { ECSClient, ListClustersCommand } = require("@aws-sdk/client-ecs"); // CommonJS import + * const client = new ECSClient(config); + * const command = new ListClustersCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListClustersCommandInput} for command's `input` shape. + * @see {@link ListClustersCommandOutput} for command's `response` shape. + * @see {@link ECSClientResolvedConfig | config} for command's `input` shape. + * */ export class ListClustersCommand extends $Command< ListClustersCommandInput, diff --git a/clients/client-ecs/commands/ListContainerInstancesCommand.ts b/clients/client-ecs/commands/ListContainerInstancesCommand.ts index 1e2b8f4a6114..83eb877c1f84 100644 --- a/clients/client-ecs/commands/ListContainerInstancesCommand.ts +++ b/clients/client-ecs/commands/ListContainerInstancesCommand.ts @@ -25,6 +25,20 @@ export interface ListContainerInstancesCommandOutput extends ListContainerInstan * 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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ECSClient, ListContainerInstancesCommand } from "@aws-sdk/client-ecs"; // ES Modules import + * // const { ECSClient, ListContainerInstancesCommand } = require("@aws-sdk/client-ecs"); // CommonJS import + * const client = new ECSClient(config); + * const command = new ListContainerInstancesCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListContainerInstancesCommandInput} for command's `input` shape. + * @see {@link ListContainerInstancesCommandOutput} for command's `response` shape. + * @see {@link ECSClientResolvedConfig | config} for command's `input` shape. + * */ export class ListContainerInstancesCommand extends $Command< ListContainerInstancesCommandInput, diff --git a/clients/client-ecs/commands/ListServicesCommand.ts b/clients/client-ecs/commands/ListServicesCommand.ts index a1e5edc0609d..737ec57b3824 100644 --- a/clients/client-ecs/commands/ListServicesCommand.ts +++ b/clients/client-ecs/commands/ListServicesCommand.ts @@ -22,6 +22,20 @@ export interface ListServicesCommandOutput extends ListServicesResponse, __Metad /** *

Lists the services that are running in a specified cluster.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ECSClient, ListServicesCommand } from "@aws-sdk/client-ecs"; // ES Modules import + * // const { ECSClient, ListServicesCommand } = require("@aws-sdk/client-ecs"); // CommonJS import + * const client = new ECSClient(config); + * const command = new ListServicesCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListServicesCommandInput} for command's `input` shape. + * @see {@link ListServicesCommandOutput} for command's `response` shape. + * @see {@link ECSClientResolvedConfig | config} for command's `input` shape. + * */ export class ListServicesCommand extends $Command< ListServicesCommandInput, diff --git a/clients/client-ecs/commands/ListTagsForResourceCommand.ts b/clients/client-ecs/commands/ListTagsForResourceCommand.ts index c2fe2d9c889f..d604cf7a0264 100644 --- a/clients/client-ecs/commands/ListTagsForResourceCommand.ts +++ b/clients/client-ecs/commands/ListTagsForResourceCommand.ts @@ -22,6 +22,20 @@ export interface ListTagsForResourceCommandOutput extends ListTagsForResourceRes /** *

List the tags for an Amazon ECS resource.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ECSClient, ListTagsForResourceCommand } from "@aws-sdk/client-ecs"; // ES Modules import + * // const { ECSClient, ListTagsForResourceCommand } = require("@aws-sdk/client-ecs"); // CommonJS import + * const client = new ECSClient(config); + * const command = new ListTagsForResourceCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListTagsForResourceCommandInput} for command's `input` shape. + * @see {@link ListTagsForResourceCommandOutput} for command's `response` shape. + * @see {@link ECSClientResolvedConfig | config} for command's `input` shape. + * */ export class ListTagsForResourceCommand extends $Command< ListTagsForResourceCommandInput, diff --git a/clients/client-ecs/commands/ListTaskDefinitionFamiliesCommand.ts b/clients/client-ecs/commands/ListTaskDefinitionFamiliesCommand.ts index bb3312ff6f55..9a6c61dfb48b 100644 --- a/clients/client-ecs/commands/ListTaskDefinitionFamiliesCommand.ts +++ b/clients/client-ecs/commands/ListTaskDefinitionFamiliesCommand.ts @@ -28,6 +28,20 @@ export interface ListTaskDefinitionFamiliesCommandOutput extends ListTaskDefinit * ACTIVE task definition revisions by setting the status * parameter to ACTIVE. You can also filter the results with the * familyPrefix parameter.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ECSClient, ListTaskDefinitionFamiliesCommand } from "@aws-sdk/client-ecs"; // ES Modules import + * // const { ECSClient, ListTaskDefinitionFamiliesCommand } = require("@aws-sdk/client-ecs"); // CommonJS import + * const client = new ECSClient(config); + * const command = new ListTaskDefinitionFamiliesCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListTaskDefinitionFamiliesCommandInput} for command's `input` shape. + * @see {@link ListTaskDefinitionFamiliesCommandOutput} for command's `response` shape. + * @see {@link ECSClientResolvedConfig | config} for command's `input` shape. + * */ export class ListTaskDefinitionFamiliesCommand extends $Command< ListTaskDefinitionFamiliesCommandInput, diff --git a/clients/client-ecs/commands/ListTaskDefinitionsCommand.ts b/clients/client-ecs/commands/ListTaskDefinitionsCommand.ts index a35701954fb3..130dd2cc9107 100644 --- a/clients/client-ecs/commands/ListTaskDefinitionsCommand.ts +++ b/clients/client-ecs/commands/ListTaskDefinitionsCommand.ts @@ -24,6 +24,20 @@ export interface ListTaskDefinitionsCommandOutput extends ListTaskDefinitionsRes *

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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ECSClient, ListTaskDefinitionsCommand } from "@aws-sdk/client-ecs"; // ES Modules import + * // const { ECSClient, ListTaskDefinitionsCommand } = require("@aws-sdk/client-ecs"); // CommonJS import + * const client = new ECSClient(config); + * const command = new ListTaskDefinitionsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListTaskDefinitionsCommandInput} for command's `input` shape. + * @see {@link ListTaskDefinitionsCommandOutput} for command's `response` shape. + * @see {@link ECSClientResolvedConfig | config} for command's `input` shape. + * */ export class ListTaskDefinitionsCommand extends $Command< ListTaskDefinitionsCommandInput, diff --git a/clients/client-ecs/commands/ListTasksCommand.ts b/clients/client-ecs/commands/ListTasksCommand.ts index 7c21fce759de..94ff01ec19e7 100644 --- a/clients/client-ecs/commands/ListTasksCommand.ts +++ b/clients/client-ecs/commands/ListTasksCommand.ts @@ -24,6 +24,20 @@ export interface ListTasksCommandOutput extends ListTasksResponse, __MetadataBea * parameters.

*

Recently stopped tasks might appear in the returned results. Currently, stopped tasks * appear in the returned results for at least one hour.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ECSClient, ListTasksCommand } from "@aws-sdk/client-ecs"; // ES Modules import + * // const { ECSClient, ListTasksCommand } = require("@aws-sdk/client-ecs"); // CommonJS import + * const client = new ECSClient(config); + * const command = new ListTasksCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListTasksCommandInput} for command's `input` shape. + * @see {@link ListTasksCommandOutput} for command's `response` shape. + * @see {@link ECSClientResolvedConfig | config} for command's `input` shape. + * */ export class ListTasksCommand extends $Command { // Start section: command_properties diff --git a/clients/client-ecs/commands/PutAccountSettingCommand.ts b/clients/client-ecs/commands/PutAccountSettingCommand.ts index be1146331190..9d32978e80cb 100644 --- a/clients/client-ecs/commands/PutAccountSettingCommand.ts +++ b/clients/client-ecs/commands/PutAccountSettingCommand.ts @@ -45,6 +45,20 @@ export interface PutAccountSettingCommandOutput extends PutAccountSettingRespons * have Container Insights enabled unless you disable it during cluster creation. For more * information, see CloudWatch * Container Insights in the Amazon Elastic Container Service Developer Guide.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ECSClient, PutAccountSettingCommand } from "@aws-sdk/client-ecs"; // ES Modules import + * // const { ECSClient, PutAccountSettingCommand } = require("@aws-sdk/client-ecs"); // CommonJS import + * const client = new ECSClient(config); + * const command = new PutAccountSettingCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link PutAccountSettingCommandInput} for command's `input` shape. + * @see {@link PutAccountSettingCommandOutput} for command's `response` shape. + * @see {@link ECSClientResolvedConfig | config} for command's `input` shape. + * */ export class PutAccountSettingCommand extends $Command< PutAccountSettingCommandInput, diff --git a/clients/client-ecs/commands/PutAccountSettingDefaultCommand.ts b/clients/client-ecs/commands/PutAccountSettingDefaultCommand.ts index 7e9090379211..4e3c82ba124d 100644 --- a/clients/client-ecs/commands/PutAccountSettingDefaultCommand.ts +++ b/clients/client-ecs/commands/PutAccountSettingDefaultCommand.ts @@ -24,6 +24,20 @@ export interface PutAccountSettingDefaultCommandOutput extends PutAccountSetting *

Modifies an account setting for all IAM users on an account for whom no individual * account setting has been specified. Account settings are set on a per-Region * basis.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ECSClient, PutAccountSettingDefaultCommand } from "@aws-sdk/client-ecs"; // ES Modules import + * // const { ECSClient, PutAccountSettingDefaultCommand } = require("@aws-sdk/client-ecs"); // CommonJS import + * const client = new ECSClient(config); + * const command = new PutAccountSettingDefaultCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link PutAccountSettingDefaultCommandInput} for command's `input` shape. + * @see {@link PutAccountSettingDefaultCommandOutput} for command's `response` shape. + * @see {@link ECSClientResolvedConfig | config} for command's `input` shape. + * */ export class PutAccountSettingDefaultCommand extends $Command< PutAccountSettingDefaultCommandInput, diff --git a/clients/client-ecs/commands/PutAttributesCommand.ts b/clients/client-ecs/commands/PutAttributesCommand.ts index a48035304a06..317bdb90d087 100644 --- a/clients/client-ecs/commands/PutAttributesCommand.ts +++ b/clients/client-ecs/commands/PutAttributesCommand.ts @@ -26,6 +26,20 @@ export interface PutAttributesCommandOutput extends PutAttributesResponse, __Met * To delete an attribute, use DeleteAttributes. For more information, * see Attributes in the * Amazon Elastic Container Service Developer Guide.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ECSClient, PutAttributesCommand } from "@aws-sdk/client-ecs"; // ES Modules import + * // const { ECSClient, PutAttributesCommand } = require("@aws-sdk/client-ecs"); // CommonJS import + * const client = new ECSClient(config); + * const command = new PutAttributesCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link PutAttributesCommandInput} for command's `input` shape. + * @see {@link PutAttributesCommandOutput} for command's `response` shape. + * @see {@link ECSClientResolvedConfig | config} for command's `input` shape. + * */ export class PutAttributesCommand extends $Command< PutAttributesCommandInput, diff --git a/clients/client-ecs/commands/PutClusterCapacityProvidersCommand.ts b/clients/client-ecs/commands/PutClusterCapacityProvidersCommand.ts index 3a7c2f0f56fd..268ef1ef7b83 100644 --- a/clients/client-ecs/commands/PutClusterCapacityProvidersCommand.ts +++ b/clients/client-ecs/commands/PutClusterCapacityProvidersCommand.ts @@ -37,6 +37,20 @@ export interface PutClusterCapacityProvidersCommandOutput * It is recommended to define a default capacity provider strategy for your cluster, * however you may specify an empty array ([]) to bypass defining a default * strategy.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ECSClient, PutClusterCapacityProvidersCommand } from "@aws-sdk/client-ecs"; // ES Modules import + * // const { ECSClient, PutClusterCapacityProvidersCommand } = require("@aws-sdk/client-ecs"); // CommonJS import + * const client = new ECSClient(config); + * const command = new PutClusterCapacityProvidersCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link PutClusterCapacityProvidersCommandInput} for command's `input` shape. + * @see {@link PutClusterCapacityProvidersCommandOutput} for command's `response` shape. + * @see {@link ECSClientResolvedConfig | config} for command's `input` shape. + * */ export class PutClusterCapacityProvidersCommand extends $Command< PutClusterCapacityProvidersCommandInput, diff --git a/clients/client-ecs/commands/RegisterContainerInstanceCommand.ts b/clients/client-ecs/commands/RegisterContainerInstanceCommand.ts index f156a9ea67d0..c9dad7d8b35b 100644 --- a/clients/client-ecs/commands/RegisterContainerInstanceCommand.ts +++ b/clients/client-ecs/commands/RegisterContainerInstanceCommand.ts @@ -27,6 +27,20 @@ export interface RegisterContainerInstanceCommandOutput extends RegisterContaine *

Registers an EC2 * instance into the specified cluster. This instance becomes available to place containers * on.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ECSClient, RegisterContainerInstanceCommand } from "@aws-sdk/client-ecs"; // ES Modules import + * // const { ECSClient, RegisterContainerInstanceCommand } = require("@aws-sdk/client-ecs"); // CommonJS import + * const client = new ECSClient(config); + * const command = new RegisterContainerInstanceCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link RegisterContainerInstanceCommandInput} for command's `input` shape. + * @see {@link RegisterContainerInstanceCommandOutput} for command's `response` shape. + * @see {@link ECSClientResolvedConfig | config} for command's `input` shape. + * */ export class RegisterContainerInstanceCommand extends $Command< RegisterContainerInstanceCommandInput, diff --git a/clients/client-ecs/commands/RegisterTaskDefinitionCommand.ts b/clients/client-ecs/commands/RegisterTaskDefinitionCommand.ts index e59be363bce3..c9aa7637cb80 100644 --- a/clients/client-ecs/commands/RegisterTaskDefinitionCommand.ts +++ b/clients/client-ecs/commands/RegisterTaskDefinitionCommand.ts @@ -39,6 +39,20 @@ export interface RegisterTaskDefinitionCommandOutput extends RegisterTaskDefinit * 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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ECSClient, RegisterTaskDefinitionCommand } from "@aws-sdk/client-ecs"; // ES Modules import + * // const { ECSClient, RegisterTaskDefinitionCommand } = require("@aws-sdk/client-ecs"); // CommonJS import + * const client = new ECSClient(config); + * const command = new RegisterTaskDefinitionCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link RegisterTaskDefinitionCommandInput} for command's `input` shape. + * @see {@link RegisterTaskDefinitionCommandOutput} for command's `response` shape. + * @see {@link ECSClientResolvedConfig | config} for command's `input` shape. + * */ export class RegisterTaskDefinitionCommand extends $Command< RegisterTaskDefinitionCommandInput, diff --git a/clients/client-ecs/commands/RunTaskCommand.ts b/clients/client-ecs/commands/RunTaskCommand.ts index 6a3f851fa41f..514838f85062 100644 --- a/clients/client-ecs/commands/RunTaskCommand.ts +++ b/clients/client-ecs/commands/RunTaskCommand.ts @@ -47,6 +47,20 @@ export interface RunTaskCommandOutput extends RunTaskResponse, __MetadataBearer * minutes of wait time.

* * + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ECSClient, RunTaskCommand } from "@aws-sdk/client-ecs"; // ES Modules import + * // const { ECSClient, RunTaskCommand } = require("@aws-sdk/client-ecs"); // CommonJS import + * const client = new ECSClient(config); + * const command = new RunTaskCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link RunTaskCommandInput} for command's `input` shape. + * @see {@link RunTaskCommandOutput} for command's `response` shape. + * @see {@link ECSClientResolvedConfig | config} for command's `input` shape. + * */ export class RunTaskCommand extends $Command { // Start section: command_properties diff --git a/clients/client-ecs/commands/StartTaskCommand.ts b/clients/client-ecs/commands/StartTaskCommand.ts index 9cc26052c2d3..948548a7fafb 100644 --- a/clients/client-ecs/commands/StartTaskCommand.ts +++ b/clients/client-ecs/commands/StartTaskCommand.ts @@ -23,6 +23,20 @@ export interface StartTaskCommandOutput extends StartTaskResponse, __MetadataBea *

Alternatively, you can use RunTask to place tasks for you. For more * information, see Scheduling Tasks in the * Amazon Elastic Container Service Developer Guide.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ECSClient, StartTaskCommand } from "@aws-sdk/client-ecs"; // ES Modules import + * // const { ECSClient, StartTaskCommand } = require("@aws-sdk/client-ecs"); // CommonJS import + * const client = new ECSClient(config); + * const command = new StartTaskCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link StartTaskCommandInput} for command's `input` shape. + * @see {@link StartTaskCommandOutput} for command's `response` shape. + * @see {@link ECSClientResolvedConfig | config} for command's `input` shape. + * */ export class StartTaskCommand extends $Command { // Start section: command_properties diff --git a/clients/client-ecs/commands/StopTaskCommand.ts b/clients/client-ecs/commands/StopTaskCommand.ts index 054e0939b1be..89b516bf81bb 100644 --- a/clients/client-ecs/commands/StopTaskCommand.ts +++ b/clients/client-ecs/commands/StopTaskCommand.ts @@ -31,6 +31,20 @@ export interface StopTaskCommandOutput extends StopTaskResponse, __MetadataBeare * Amazon ECS Container Agent Configuration in the * Amazon Elastic Container Service Developer Guide.

* + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ECSClient, StopTaskCommand } from "@aws-sdk/client-ecs"; // ES Modules import + * // const { ECSClient, StopTaskCommand } = require("@aws-sdk/client-ecs"); // CommonJS import + * const client = new ECSClient(config); + * const command = new StopTaskCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link StopTaskCommandInput} for command's `input` shape. + * @see {@link StopTaskCommandOutput} for command's `response` shape. + * @see {@link ECSClientResolvedConfig | config} for command's `input` shape. + * */ export class StopTaskCommand extends $Command { // Start section: command_properties diff --git a/clients/client-ecs/commands/SubmitAttachmentStateChangesCommand.ts b/clients/client-ecs/commands/SubmitAttachmentStateChangesCommand.ts index 82b57465e35c..577f6e554517 100644 --- a/clients/client-ecs/commands/SubmitAttachmentStateChangesCommand.ts +++ b/clients/client-ecs/commands/SubmitAttachmentStateChangesCommand.ts @@ -28,6 +28,20 @@ export interface SubmitAttachmentStateChangesCommandOutput * *

Sent to * acknowledge that an attachment changed states.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ECSClient, SubmitAttachmentStateChangesCommand } from "@aws-sdk/client-ecs"; // ES Modules import + * // const { ECSClient, SubmitAttachmentStateChangesCommand } = require("@aws-sdk/client-ecs"); // CommonJS import + * const client = new ECSClient(config); + * const command = new SubmitAttachmentStateChangesCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link SubmitAttachmentStateChangesCommandInput} for command's `input` shape. + * @see {@link SubmitAttachmentStateChangesCommandOutput} for command's `response` shape. + * @see {@link ECSClientResolvedConfig | config} for command's `input` shape. + * */ export class SubmitAttachmentStateChangesCommand extends $Command< SubmitAttachmentStateChangesCommandInput, diff --git a/clients/client-ecs/commands/SubmitContainerStateChangeCommand.ts b/clients/client-ecs/commands/SubmitContainerStateChangeCommand.ts index bc30e906f568..483511010ef0 100644 --- a/clients/client-ecs/commands/SubmitContainerStateChangeCommand.ts +++ b/clients/client-ecs/commands/SubmitContainerStateChangeCommand.ts @@ -26,6 +26,20 @@ export interface SubmitContainerStateChangeCommandOutput extends SubmitContainer * *

Sent to * acknowledge that a container changed states.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ECSClient, SubmitContainerStateChangeCommand } from "@aws-sdk/client-ecs"; // ES Modules import + * // const { ECSClient, SubmitContainerStateChangeCommand } = require("@aws-sdk/client-ecs"); // CommonJS import + * const client = new ECSClient(config); + * const command = new SubmitContainerStateChangeCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link SubmitContainerStateChangeCommandInput} for command's `input` shape. + * @see {@link SubmitContainerStateChangeCommandOutput} for command's `response` shape. + * @see {@link ECSClientResolvedConfig | config} for command's `input` shape. + * */ export class SubmitContainerStateChangeCommand extends $Command< SubmitContainerStateChangeCommandInput, diff --git a/clients/client-ecs/commands/SubmitTaskStateChangeCommand.ts b/clients/client-ecs/commands/SubmitTaskStateChangeCommand.ts index 6de0027d3bd2..7dc1b31f4b87 100644 --- a/clients/client-ecs/commands/SubmitTaskStateChangeCommand.ts +++ b/clients/client-ecs/commands/SubmitTaskStateChangeCommand.ts @@ -26,6 +26,20 @@ export interface SubmitTaskStateChangeCommandOutput extends SubmitTaskStateChang * *

Sent to acknowledge * that a task changed states.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ECSClient, SubmitTaskStateChangeCommand } from "@aws-sdk/client-ecs"; // ES Modules import + * // const { ECSClient, SubmitTaskStateChangeCommand } = require("@aws-sdk/client-ecs"); // CommonJS import + * const client = new ECSClient(config); + * const command = new SubmitTaskStateChangeCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link SubmitTaskStateChangeCommandInput} for command's `input` shape. + * @see {@link SubmitTaskStateChangeCommandOutput} for command's `response` shape. + * @see {@link ECSClientResolvedConfig | config} for command's `input` shape. + * */ export class SubmitTaskStateChangeCommand extends $Command< SubmitTaskStateChangeCommandInput, diff --git a/clients/client-ecs/commands/TagResourceCommand.ts b/clients/client-ecs/commands/TagResourceCommand.ts index 8db9ea03423b..4ed5fafd8ddf 100644 --- a/clients/client-ecs/commands/TagResourceCommand.ts +++ b/clients/client-ecs/commands/TagResourceCommand.ts @@ -25,6 +25,20 @@ export interface TagResourceCommandOutput extends TagResourceResponse, __Metadat * 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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ECSClient, TagResourceCommand } from "@aws-sdk/client-ecs"; // ES Modules import + * // const { ECSClient, TagResourceCommand } = require("@aws-sdk/client-ecs"); // CommonJS import + * const client = new ECSClient(config); + * const command = new TagResourceCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link TagResourceCommandInput} for command's `input` shape. + * @see {@link TagResourceCommandOutput} for command's `response` shape. + * @see {@link ECSClientResolvedConfig | config} for command's `input` shape. + * */ export class TagResourceCommand extends $Command< TagResourceCommandInput, diff --git a/clients/client-ecs/commands/UntagResourceCommand.ts b/clients/client-ecs/commands/UntagResourceCommand.ts index 7e4af8494fd9..176c2df45495 100644 --- a/clients/client-ecs/commands/UntagResourceCommand.ts +++ b/clients/client-ecs/commands/UntagResourceCommand.ts @@ -22,6 +22,20 @@ export interface UntagResourceCommandOutput extends UntagResourceResponse, __Met /** *

Deletes specified tags from a resource.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ECSClient, UntagResourceCommand } from "@aws-sdk/client-ecs"; // ES Modules import + * // const { ECSClient, UntagResourceCommand } = require("@aws-sdk/client-ecs"); // CommonJS import + * const client = new ECSClient(config); + * const command = new UntagResourceCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link UntagResourceCommandInput} for command's `input` shape. + * @see {@link UntagResourceCommandOutput} for command's `response` shape. + * @see {@link ECSClientResolvedConfig | config} for command's `input` shape. + * */ export class UntagResourceCommand extends $Command< UntagResourceCommandInput, diff --git a/clients/client-ecs/commands/UpdateCapacityProviderCommand.ts b/clients/client-ecs/commands/UpdateCapacityProviderCommand.ts index 88c05c3aa950..50f99038a8e0 100644 --- a/clients/client-ecs/commands/UpdateCapacityProviderCommand.ts +++ b/clients/client-ecs/commands/UpdateCapacityProviderCommand.ts @@ -22,6 +22,20 @@ export interface UpdateCapacityProviderCommandOutput extends UpdateCapacityProvi /** *

Modifies the parameters for a capacity provider.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ECSClient, UpdateCapacityProviderCommand } from "@aws-sdk/client-ecs"; // ES Modules import + * // const { ECSClient, UpdateCapacityProviderCommand } = require("@aws-sdk/client-ecs"); // CommonJS import + * const client = new ECSClient(config); + * const command = new UpdateCapacityProviderCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link UpdateCapacityProviderCommandInput} for command's `input` shape. + * @see {@link UpdateCapacityProviderCommandOutput} for command's `response` shape. + * @see {@link ECSClientResolvedConfig | config} for command's `input` shape. + * */ export class UpdateCapacityProviderCommand extends $Command< UpdateCapacityProviderCommandInput, diff --git a/clients/client-ecs/commands/UpdateClusterCommand.ts b/clients/client-ecs/commands/UpdateClusterCommand.ts index 874920e50246..825c26b6aa80 100644 --- a/clients/client-ecs/commands/UpdateClusterCommand.ts +++ b/clients/client-ecs/commands/UpdateClusterCommand.ts @@ -22,6 +22,20 @@ export interface UpdateClusterCommandOutput extends UpdateClusterResponse, __Met /** *

Updates the cluster.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ECSClient, UpdateClusterCommand } from "@aws-sdk/client-ecs"; // ES Modules import + * // const { ECSClient, UpdateClusterCommand } = require("@aws-sdk/client-ecs"); // CommonJS import + * const client = new ECSClient(config); + * const command = new UpdateClusterCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link UpdateClusterCommandInput} for command's `input` shape. + * @see {@link UpdateClusterCommandOutput} for command's `response` shape. + * @see {@link ECSClientResolvedConfig | config} for command's `input` shape. + * */ export class UpdateClusterCommand extends $Command< UpdateClusterCommandInput, diff --git a/clients/client-ecs/commands/UpdateClusterSettingsCommand.ts b/clients/client-ecs/commands/UpdateClusterSettingsCommand.ts index dc442acf9ece..512754440fb7 100644 --- a/clients/client-ecs/commands/UpdateClusterSettingsCommand.ts +++ b/clients/client-ecs/commands/UpdateClusterSettingsCommand.ts @@ -22,6 +22,20 @@ export interface UpdateClusterSettingsCommandOutput extends UpdateClusterSetting /** *

Modifies the settings to use for a cluster.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ECSClient, UpdateClusterSettingsCommand } from "@aws-sdk/client-ecs"; // ES Modules import + * // const { ECSClient, UpdateClusterSettingsCommand } = require("@aws-sdk/client-ecs"); // CommonJS import + * const client = new ECSClient(config); + * const command = new UpdateClusterSettingsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link UpdateClusterSettingsCommandInput} for command's `input` shape. + * @see {@link UpdateClusterSettingsCommandOutput} for command's `response` shape. + * @see {@link ECSClientResolvedConfig | config} for command's `input` shape. + * */ export class UpdateClusterSettingsCommand extends $Command< UpdateClusterSettingsCommandInput, diff --git a/clients/client-ecs/commands/UpdateContainerAgentCommand.ts b/clients/client-ecs/commands/UpdateContainerAgentCommand.ts index 42c45a73dfa2..1a5f091d94fb 100644 --- a/clients/client-ecs/commands/UpdateContainerAgentCommand.ts +++ b/clients/client-ecs/commands/UpdateContainerAgentCommand.ts @@ -37,6 +37,20 @@ export interface UpdateContainerAgentCommandOutput extends UpdateContainerAgentR * 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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ECSClient, UpdateContainerAgentCommand } from "@aws-sdk/client-ecs"; // ES Modules import + * // const { ECSClient, UpdateContainerAgentCommand } = require("@aws-sdk/client-ecs"); // CommonJS import + * const client = new ECSClient(config); + * const command = new UpdateContainerAgentCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link UpdateContainerAgentCommandInput} for command's `input` shape. + * @see {@link UpdateContainerAgentCommandOutput} for command's `response` shape. + * @see {@link ECSClientResolvedConfig | config} for command's `input` shape. + * */ export class UpdateContainerAgentCommand extends $Command< UpdateContainerAgentCommandInput, diff --git a/clients/client-ecs/commands/UpdateContainerInstancesStateCommand.ts b/clients/client-ecs/commands/UpdateContainerInstancesStateCommand.ts index 5bf129b13f03..c4d6b5b8ced9 100644 --- a/clients/client-ecs/commands/UpdateContainerInstancesStateCommand.ts +++ b/clients/client-ecs/commands/UpdateContainerInstancesStateCommand.ts @@ -72,6 +72,20 @@ export interface UpdateContainerInstancesStateCommandOutput *

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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ECSClient, UpdateContainerInstancesStateCommand } from "@aws-sdk/client-ecs"; // ES Modules import + * // const { ECSClient, UpdateContainerInstancesStateCommand } = require("@aws-sdk/client-ecs"); // CommonJS import + * const client = new ECSClient(config); + * const command = new UpdateContainerInstancesStateCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link UpdateContainerInstancesStateCommandInput} for command's `input` shape. + * @see {@link UpdateContainerInstancesStateCommandOutput} for command's `response` shape. + * @see {@link ECSClientResolvedConfig | config} for command's `input` shape. + * */ export class UpdateContainerInstancesStateCommand extends $Command< UpdateContainerInstancesStateCommandInput, diff --git a/clients/client-ecs/commands/UpdateServiceCommand.ts b/clients/client-ecs/commands/UpdateServiceCommand.ts index df67fc23bd84..8c42ec0fe63a 100644 --- a/clients/client-ecs/commands/UpdateServiceCommand.ts +++ b/clients/client-ecs/commands/UpdateServiceCommand.ts @@ -130,6 +130,20 @@ export interface UpdateServiceCommandOutput extends UpdateServiceResponse, __Met * running tasks for this service.

* * + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ECSClient, UpdateServiceCommand } from "@aws-sdk/client-ecs"; // ES Modules import + * // const { ECSClient, UpdateServiceCommand } = require("@aws-sdk/client-ecs"); // CommonJS import + * const client = new ECSClient(config); + * const command = new UpdateServiceCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link UpdateServiceCommandInput} for command's `input` shape. + * @see {@link UpdateServiceCommandOutput} for command's `response` shape. + * @see {@link ECSClientResolvedConfig | config} for command's `input` shape. + * */ export class UpdateServiceCommand extends $Command< UpdateServiceCommandInput, diff --git a/clients/client-ecs/commands/UpdateServicePrimaryTaskSetCommand.ts b/clients/client-ecs/commands/UpdateServicePrimaryTaskSetCommand.ts index 3679810fda4b..043431d98a88 100644 --- a/clients/client-ecs/commands/UpdateServicePrimaryTaskSetCommand.ts +++ b/clients/client-ecs/commands/UpdateServicePrimaryTaskSetCommand.ts @@ -28,6 +28,20 @@ export interface UpdateServicePrimaryTaskSetCommandOutput * 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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ECSClient, UpdateServicePrimaryTaskSetCommand } from "@aws-sdk/client-ecs"; // ES Modules import + * // const { ECSClient, UpdateServicePrimaryTaskSetCommand } = require("@aws-sdk/client-ecs"); // CommonJS import + * const client = new ECSClient(config); + * const command = new UpdateServicePrimaryTaskSetCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link UpdateServicePrimaryTaskSetCommandInput} for command's `input` shape. + * @see {@link UpdateServicePrimaryTaskSetCommandOutput} for command's `response` shape. + * @see {@link ECSClientResolvedConfig | config} for command's `input` shape. + * */ export class UpdateServicePrimaryTaskSetCommand extends $Command< UpdateServicePrimaryTaskSetCommandInput, diff --git a/clients/client-ecs/commands/UpdateTaskSetCommand.ts b/clients/client-ecs/commands/UpdateTaskSetCommand.ts index 54bba48db776..27b8a9726c20 100644 --- a/clients/client-ecs/commands/UpdateTaskSetCommand.ts +++ b/clients/client-ecs/commands/UpdateTaskSetCommand.ts @@ -24,6 +24,20 @@ export interface UpdateTaskSetCommandOutput extends UpdateTaskSetResponse, __Met *

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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ECSClient, UpdateTaskSetCommand } from "@aws-sdk/client-ecs"; // ES Modules import + * // const { ECSClient, UpdateTaskSetCommand } = require("@aws-sdk/client-ecs"); // CommonJS import + * const client = new ECSClient(config); + * const command = new UpdateTaskSetCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link UpdateTaskSetCommandInput} for command's `input` shape. + * @see {@link UpdateTaskSetCommandOutput} for command's `response` shape. + * @see {@link ECSClientResolvedConfig | config} for command's `input` shape. + * */ export class UpdateTaskSetCommand extends $Command< UpdateTaskSetCommandInput, diff --git a/clients/client-ecs/models/models_0.ts b/clients/client-ecs/models/models_0.ts index cc9fbc5e5230..1118b0870a97 100644 --- a/clients/client-ecs/models/models_0.ts +++ b/clients/client-ecs/models/models_0.ts @@ -11,6 +11,9 @@ export interface AccessDeniedException extends __SmithyException, $MetadataBeare } export namespace AccessDeniedException { + /** + * @internal + */ export const filterSensitiveLog = (obj: AccessDeniedException): any => ({ ...obj, }); @@ -37,6 +40,9 @@ export interface ClientException extends __SmithyException, $MetadataBearer { } export namespace ClientException { + /** + * @internal + */ export const filterSensitiveLog = (obj: ClientException): any => ({ ...obj, }); @@ -92,6 +98,9 @@ export interface ManagedScaling { } export namespace ManagedScaling { + /** + * @internal + */ export const filterSensitiveLog = (obj: ManagedScaling): any => ({ ...obj, }); @@ -135,6 +144,9 @@ export interface AutoScalingGroupProvider { } export namespace AutoScalingGroupProvider { + /** + * @internal + */ export const filterSensitiveLog = (obj: AutoScalingGroupProvider): any => ({ ...obj, }); @@ -190,6 +202,9 @@ export interface Tag { } export namespace Tag { + /** + * @internal + */ export const filterSensitiveLog = (obj: Tag): any => ({ ...obj, }); @@ -248,6 +263,9 @@ export interface CreateCapacityProviderRequest { } export namespace CreateCapacityProviderRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateCapacityProviderRequest): any => ({ ...obj, }); @@ -361,6 +379,9 @@ export interface CapacityProvider { } export namespace CapacityProvider { + /** + * @internal + */ export const filterSensitiveLog = (obj: CapacityProvider): any => ({ ...obj, }); @@ -374,6 +395,9 @@ export interface CreateCapacityProviderResponse { } export namespace CreateCapacityProviderResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateCapacityProviderResponse): any => ({ ...obj, }); @@ -390,6 +414,9 @@ export interface InvalidParameterException extends __SmithyException, $MetadataB } export namespace InvalidParameterException { + /** + * @internal + */ export const filterSensitiveLog = (obj: InvalidParameterException): any => ({ ...obj, }); @@ -405,6 +432,9 @@ export interface LimitExceededException extends __SmithyException, $MetadataBear } export namespace LimitExceededException { + /** + * @internal + */ export const filterSensitiveLog = (obj: LimitExceededException): any => ({ ...obj, }); @@ -420,6 +450,9 @@ export interface ServerException extends __SmithyException, $MetadataBearer { } export namespace ServerException { + /** + * @internal + */ export const filterSensitiveLog = (obj: ServerException): any => ({ ...obj, }); @@ -439,6 +472,9 @@ export interface UpdateInProgressException extends __SmithyException, $MetadataB } export namespace UpdateInProgressException { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateInProgressException): any => ({ ...obj, }); @@ -484,6 +520,9 @@ export interface ExecuteCommandLogConfiguration { } export namespace ExecuteCommandLogConfiguration { + /** + * @internal + */ export const filterSensitiveLog = (obj: ExecuteCommandLogConfiguration): any => ({ ...obj, }); @@ -539,6 +578,9 @@ export interface ExecuteCommandConfiguration { } export namespace ExecuteCommandConfiguration { + /** + * @internal + */ export const filterSensitiveLog = (obj: ExecuteCommandConfiguration): any => ({ ...obj, }); @@ -555,6 +597,9 @@ export interface ClusterConfiguration { } export namespace ClusterConfiguration { + /** + * @internal + */ export const filterSensitiveLog = (obj: ClusterConfiguration): any => ({ ...obj, }); @@ -615,6 +660,9 @@ export interface CapacityProviderStrategyItem { } export namespace CapacityProviderStrategyItem { + /** + * @internal + */ export const filterSensitiveLog = (obj: CapacityProviderStrategyItem): any => ({ ...obj, }); @@ -647,6 +695,9 @@ export interface ClusterSetting { } export namespace ClusterSetting { + /** + * @internal + */ export const filterSensitiveLog = (obj: ClusterSetting): any => ({ ...obj, }); @@ -740,6 +791,9 @@ export interface CreateClusterRequest { } export namespace CreateClusterRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateClusterRequest): any => ({ ...obj, }); @@ -763,6 +817,9 @@ export interface KeyValuePair { } export namespace KeyValuePair { + /** + * @internal + */ export const filterSensitiveLog = (obj: KeyValuePair): any => ({ ...obj, }); @@ -797,6 +854,9 @@ export interface Attachment { } export namespace Attachment { + /** + * @internal + */ export const filterSensitiveLog = (obj: Attachment): any => ({ ...obj, }); @@ -997,6 +1057,9 @@ export interface Cluster { } export namespace Cluster { + /** + * @internal + */ export const filterSensitiveLog = (obj: Cluster): any => ({ ...obj, }); @@ -1010,6 +1073,9 @@ export interface CreateClusterResponse { } export namespace CreateClusterResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateClusterResponse): any => ({ ...obj, }); @@ -1026,6 +1092,9 @@ export interface ClusterNotFoundException extends __SmithyException, $MetadataBe } export namespace ClusterNotFoundException { + /** + * @internal + */ export const filterSensitiveLog = (obj: ClusterNotFoundException): any => ({ ...obj, }); @@ -1058,6 +1127,9 @@ export interface DeploymentCircuitBreaker { } export namespace DeploymentCircuitBreaker { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeploymentCircuitBreaker): any => ({ ...obj, }); @@ -1132,6 +1204,9 @@ export interface DeploymentConfiguration { } export namespace DeploymentConfiguration { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeploymentConfiguration): any => ({ ...obj, }); @@ -1177,6 +1252,9 @@ export interface DeploymentController { } export namespace DeploymentController { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeploymentController): any => ({ ...obj, }); @@ -1239,6 +1317,9 @@ export interface LoadBalancer { } export namespace LoadBalancer { + /** + * @internal + */ export const filterSensitiveLog = (obj: LoadBalancer): any => ({ ...obj, }); @@ -1283,6 +1364,9 @@ export interface AwsVpcConfiguration { } export namespace AwsVpcConfiguration { + /** + * @internal + */ export const filterSensitiveLog = (obj: AwsVpcConfiguration): any => ({ ...obj, }); @@ -1302,6 +1386,9 @@ export interface NetworkConfiguration { } export namespace NetworkConfiguration { + /** + * @internal + */ export const filterSensitiveLog = (obj: NetworkConfiguration): any => ({ ...obj, }); @@ -1340,6 +1427,9 @@ export interface PlacementConstraint { } export namespace PlacementConstraint { + /** + * @internal + */ export const filterSensitiveLog = (obj: PlacementConstraint): any => ({ ...obj, }); @@ -1380,6 +1470,9 @@ export interface PlacementStrategy { } export namespace PlacementStrategy { + /** + * @internal + */ export const filterSensitiveLog = (obj: PlacementStrategy): any => ({ ...obj, }); @@ -1438,6 +1531,9 @@ export interface ServiceRegistry { } export namespace ServiceRegistry { + /** + * @internal + */ export const filterSensitiveLog = (obj: ServiceRegistry): any => ({ ...obj, }); @@ -1733,6 +1829,9 @@ export interface CreateServiceRequest { } export namespace CreateServiceRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateServiceRequest): any => ({ ...obj, }); @@ -1868,6 +1967,9 @@ export interface Deployment { } export namespace Deployment { + /** + * @internal + */ export const filterSensitiveLog = (obj: Deployment): any => ({ ...obj, }); @@ -1894,6 +1996,9 @@ export interface ServiceEvent { } export namespace ServiceEvent { + /** + * @internal + */ export const filterSensitiveLog = (obj: ServiceEvent): any => ({ ...obj, }); @@ -1921,6 +2026,9 @@ export interface Scale { } export namespace Scale { + /** + * @internal + */ export const filterSensitiveLog = (obj: Scale): any => ({ ...obj, }); @@ -2146,6 +2254,9 @@ export interface TaskSet { } export namespace TaskSet { + /** + * @internal + */ export const filterSensitiveLog = (obj: TaskSet): any => ({ ...obj, }); @@ -2393,6 +2504,9 @@ export interface Service { } export namespace Service { + /** + * @internal + */ export const filterSensitiveLog = (obj: Service): any => ({ ...obj, }); @@ -2413,6 +2527,9 @@ export interface CreateServiceResponse { } export namespace CreateServiceResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateServiceResponse): any => ({ ...obj, }); @@ -2429,6 +2546,9 @@ export interface PlatformTaskDefinitionIncompatibilityException extends __Smithy } export namespace PlatformTaskDefinitionIncompatibilityException { + /** + * @internal + */ export const filterSensitiveLog = (obj: PlatformTaskDefinitionIncompatibilityException): any => ({ ...obj, }); @@ -2444,6 +2564,9 @@ export interface PlatformUnknownException extends __SmithyException, $MetadataBe } export namespace PlatformUnknownException { + /** + * @internal + */ export const filterSensitiveLog = (obj: PlatformUnknownException): any => ({ ...obj, }); @@ -2459,6 +2582,9 @@ export interface UnsupportedFeatureException extends __SmithyException, $Metadat } export namespace UnsupportedFeatureException { + /** + * @internal + */ export const filterSensitiveLog = (obj: UnsupportedFeatureException): any => ({ ...obj, }); @@ -2597,6 +2723,9 @@ export interface CreateTaskSetRequest { } export namespace CreateTaskSetRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateTaskSetRequest): any => ({ ...obj, }); @@ -2613,6 +2742,9 @@ export interface CreateTaskSetResponse { } export namespace CreateTaskSetResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateTaskSetResponse): any => ({ ...obj, }); @@ -2629,6 +2761,9 @@ export interface ServiceNotActiveException extends __SmithyException, $MetadataB } export namespace ServiceNotActiveException { + /** + * @internal + */ export const filterSensitiveLog = (obj: ServiceNotActiveException): any => ({ ...obj, }); @@ -2646,6 +2781,9 @@ export interface ServiceNotFoundException extends __SmithyException, $MetadataBe } export namespace ServiceNotFoundException { + /** + * @internal + */ export const filterSensitiveLog = (obj: ServiceNotFoundException): any => ({ ...obj, }); @@ -2682,6 +2820,9 @@ export interface DeleteAccountSettingRequest { } export namespace DeleteAccountSettingRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteAccountSettingRequest): any => ({ ...obj, }); @@ -2709,6 +2850,9 @@ export interface Setting { } export namespace Setting { + /** + * @internal + */ export const filterSensitiveLog = (obj: Setting): any => ({ ...obj, }); @@ -2722,6 +2866,9 @@ export interface DeleteAccountSettingResponse { } export namespace DeleteAccountSettingResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteAccountSettingResponse): any => ({ ...obj, }); @@ -2766,6 +2913,9 @@ export interface Attribute { } export namespace Attribute { + /** + * @internal + */ export const filterSensitiveLog = (obj: Attribute): any => ({ ...obj, }); @@ -2788,6 +2938,9 @@ export interface DeleteAttributesRequest { } export namespace DeleteAttributesRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteAttributesRequest): any => ({ ...obj, }); @@ -2801,6 +2954,9 @@ export interface DeleteAttributesResponse { } export namespace DeleteAttributesResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteAttributesResponse): any => ({ ...obj, }); @@ -2818,6 +2974,9 @@ export interface TargetNotFoundException extends __SmithyException, $MetadataBea } export namespace TargetNotFoundException { + /** + * @internal + */ export const filterSensitiveLog = (obj: TargetNotFoundException): any => ({ ...obj, }); @@ -2831,6 +2990,9 @@ export interface DeleteCapacityProviderRequest { } export namespace DeleteCapacityProviderRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteCapacityProviderRequest): any => ({ ...obj, }); @@ -2844,6 +3006,9 @@ export interface DeleteCapacityProviderResponse { } export namespace DeleteCapacityProviderResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteCapacityProviderResponse): any => ({ ...obj, }); @@ -2861,6 +3026,9 @@ export interface ClusterContainsContainerInstancesException extends __SmithyExce } export namespace ClusterContainsContainerInstancesException { + /** + * @internal + */ export const filterSensitiveLog = (obj: ClusterContainsContainerInstancesException): any => ({ ...obj, }); @@ -2878,6 +3046,9 @@ export interface ClusterContainsServicesException extends __SmithyException, $Me } export namespace ClusterContainsServicesException { + /** + * @internal + */ export const filterSensitiveLog = (obj: ClusterContainsServicesException): any => ({ ...obj, }); @@ -2893,6 +3064,9 @@ export interface ClusterContainsTasksException extends __SmithyException, $Metad } export namespace ClusterContainsTasksException { + /** + * @internal + */ export const filterSensitiveLog = (obj: ClusterContainsTasksException): any => ({ ...obj, }); @@ -2906,6 +3080,9 @@ export interface DeleteClusterRequest { } export namespace DeleteClusterRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteClusterRequest): any => ({ ...obj, }); @@ -2919,6 +3096,9 @@ export interface DeleteClusterResponse { } export namespace DeleteClusterResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteClusterResponse): any => ({ ...obj, }); @@ -2945,6 +3125,9 @@ export interface DeleteServiceRequest { } export namespace DeleteServiceRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteServiceRequest): any => ({ ...obj, }); @@ -2958,6 +3141,9 @@ export interface DeleteServiceResponse { } export namespace DeleteServiceResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteServiceResponse): any => ({ ...obj, }); @@ -2989,6 +3175,9 @@ export interface DeleteTaskSetRequest { } export namespace DeleteTaskSetRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteTaskSetRequest): any => ({ ...obj, }); @@ -3002,6 +3191,9 @@ export interface DeleteTaskSetResponse { } export namespace DeleteTaskSetResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteTaskSetResponse): any => ({ ...obj, }); @@ -3019,6 +3211,9 @@ export interface TaskSetNotFoundException extends __SmithyException, $MetadataBe } export namespace TaskSetNotFoundException { + /** + * @internal + */ export const filterSensitiveLog = (obj: TaskSetNotFoundException): any => ({ ...obj, }); @@ -3053,6 +3248,9 @@ export interface DeregisterContainerInstanceRequest { } export namespace DeregisterContainerInstanceRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeregisterContainerInstanceRequest): any => ({ ...obj, }); @@ -3100,6 +3298,9 @@ export interface Resource { } export namespace Resource { + /** + * @internal + */ export const filterSensitiveLog = (obj: Resource): any => ({ ...obj, }); @@ -3128,6 +3329,9 @@ export interface VersionInfo { } export namespace VersionInfo { + /** + * @internal + */ export const filterSensitiveLog = (obj: VersionInfo): any => ({ ...obj, }); @@ -3301,6 +3505,9 @@ export interface ContainerInstance { } export namespace ContainerInstance { + /** + * @internal + */ export const filterSensitiveLog = (obj: ContainerInstance): any => ({ ...obj, }); @@ -3314,6 +3521,9 @@ export interface DeregisterContainerInstanceResponse { } export namespace DeregisterContainerInstanceResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeregisterContainerInstanceResponse): any => ({ ...obj, }); @@ -3329,6 +3539,9 @@ export interface DeregisterTaskDefinitionRequest { } export namespace DeregisterTaskDefinitionRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeregisterTaskDefinitionRequest): any => ({ ...obj, }); @@ -3407,6 +3620,9 @@ export interface ContainerDependency { } export namespace ContainerDependency { + /** + * @internal + */ export const filterSensitiveLog = (obj: ContainerDependency): any => ({ ...obj, }); @@ -3447,6 +3663,9 @@ export interface EnvironmentFile { } export namespace EnvironmentFile { + /** + * @internal + */ export const filterSensitiveLog = (obj: EnvironmentFile): any => ({ ...obj, }); @@ -3469,6 +3688,9 @@ export interface HostEntry { } export namespace HostEntry { + /** + * @internal + */ export const filterSensitiveLog = (obj: HostEntry): any => ({ ...obj, }); @@ -3509,6 +3731,9 @@ export interface FirelensConfiguration { } export namespace FirelensConfiguration { + /** + * @internal + */ export const filterSensitiveLog = (obj: FirelensConfiguration): any => ({ ...obj, }); @@ -3630,6 +3855,9 @@ export interface HealthCheck { } export namespace HealthCheck { + /** + * @internal + */ export const filterSensitiveLog = (obj: HealthCheck): any => ({ ...obj, }); @@ -3685,6 +3913,9 @@ export interface KernelCapabilities { } export namespace KernelCapabilities { + /** + * @internal + */ export const filterSensitiveLog = (obj: KernelCapabilities): any => ({ ...obj, }); @@ -3719,6 +3950,9 @@ export interface Device { } export namespace Device { + /** + * @internal + */ export const filterSensitiveLog = (obj: Device): any => ({ ...obj, }); @@ -3752,6 +3986,9 @@ export interface Tmpfs { } export namespace Tmpfs { + /** + * @internal + */ export const filterSensitiveLog = (obj: Tmpfs): any => ({ ...obj, }); @@ -3846,6 +4083,9 @@ export interface LinuxParameters { } export namespace LinuxParameters { + /** + * @internal + */ export const filterSensitiveLog = (obj: LinuxParameters): any => ({ ...obj, }); @@ -3897,6 +4137,9 @@ export interface Secret { } export namespace Secret { + /** + * @internal + */ export const filterSensitiveLog = (obj: Secret): any => ({ ...obj, }); @@ -3980,6 +4223,9 @@ export interface LogConfiguration { } export namespace LogConfiguration { + /** + * @internal + */ export const filterSensitiveLog = (obj: LogConfiguration): any => ({ ...obj, }); @@ -4009,6 +4255,9 @@ export interface MountPoint { } export namespace MountPoint { + /** + * @internal + */ export const filterSensitiveLog = (obj: MountPoint): any => ({ ...obj, }); @@ -4090,6 +4339,9 @@ export interface PortMapping { } export namespace PortMapping { + /** + * @internal + */ export const filterSensitiveLog = (obj: PortMapping): any => ({ ...obj, }); @@ -4113,6 +4365,9 @@ export interface RepositoryCredentials { } export namespace RepositoryCredentials { + /** + * @internal + */ export const filterSensitiveLog = (obj: RepositoryCredentials): any => ({ ...obj, }); @@ -4151,6 +4406,9 @@ export interface ResourceRequirement { } export namespace ResourceRequirement { + /** + * @internal + */ export const filterSensitiveLog = (obj: ResourceRequirement): any => ({ ...obj, }); @@ -4194,6 +4452,9 @@ export interface SystemControl { } export namespace SystemControl { + /** + * @internal + */ export const filterSensitiveLog = (obj: SystemControl): any => ({ ...obj, }); @@ -4245,6 +4506,9 @@ export interface Ulimit { } export namespace Ulimit { + /** + * @internal + */ export const filterSensitiveLog = (obj: Ulimit): any => ({ ...obj, }); @@ -4269,6 +4533,9 @@ export interface VolumeFrom { } export namespace VolumeFrom { + /** + * @internal + */ export const filterSensitiveLog = (obj: VolumeFrom): any => ({ ...obj, }); @@ -4926,6 +5193,9 @@ export interface ContainerDefinition { } export namespace ContainerDefinition { + /** + * @internal + */ export const filterSensitiveLog = (obj: ContainerDefinition): any => ({ ...obj, }); @@ -4951,6 +5221,9 @@ export interface EphemeralStorage { } export namespace EphemeralStorage { + /** + * @internal + */ export const filterSensitiveLog = (obj: EphemeralStorage): any => ({ ...obj, }); @@ -4975,6 +5248,9 @@ export interface InferenceAccelerator { } export namespace InferenceAccelerator { + /** + * @internal + */ export const filterSensitiveLog = (obj: InferenceAccelerator): any => ({ ...obj, }); @@ -5026,6 +5302,9 @@ export interface TaskDefinitionPlacementConstraint { } export namespace TaskDefinitionPlacementConstraint { + /** + * @internal + */ export const filterSensitiveLog = (obj: TaskDefinitionPlacementConstraint): any => ({ ...obj, }); @@ -5108,6 +5387,9 @@ export interface ProxyConfiguration { } export namespace ProxyConfiguration { + /** + * @internal + */ export const filterSensitiveLog = (obj: ProxyConfiguration): any => ({ ...obj, }); @@ -5178,6 +5460,9 @@ export interface DockerVolumeConfiguration { } export namespace DockerVolumeConfiguration { + /** + * @internal + */ export const filterSensitiveLog = (obj: DockerVolumeConfiguration): any => ({ ...obj, }); @@ -5213,6 +5498,9 @@ export interface EFSAuthorizationConfig { } export namespace EFSAuthorizationConfig { + /** + * @internal + */ export const filterSensitiveLog = (obj: EFSAuthorizationConfig): any => ({ ...obj, }); @@ -5270,6 +5558,9 @@ export interface EFSVolumeConfiguration { } export namespace EFSVolumeConfiguration { + /** + * @internal + */ export const filterSensitiveLog = (obj: EFSVolumeConfiguration): any => ({ ...obj, }); @@ -5297,6 +5588,9 @@ export interface FSxWindowsFileServerAuthorizationConfig { } export namespace FSxWindowsFileServerAuthorizationConfig { + /** + * @internal + */ export const filterSensitiveLog = (obj: FSxWindowsFileServerAuthorizationConfig): any => ({ ...obj, }); @@ -5327,6 +5621,9 @@ export interface FSxWindowsFileServerVolumeConfiguration { } export namespace FSxWindowsFileServerVolumeConfiguration { + /** + * @internal + */ export const filterSensitiveLog = (obj: FSxWindowsFileServerVolumeConfiguration): any => ({ ...obj, }); @@ -5352,6 +5649,9 @@ export interface HostVolumeProperties { } export namespace HostVolumeProperties { + /** + * @internal + */ export const filterSensitiveLog = (obj: HostVolumeProperties): any => ({ ...obj, }); @@ -5414,6 +5714,9 @@ export interface Volume { } export namespace Volume { + /** + * @internal + */ export const filterSensitiveLog = (obj: Volume): any => ({ ...obj, }); @@ -5715,6 +6018,9 @@ export interface TaskDefinition { } export namespace TaskDefinition { + /** + * @internal + */ export const filterSensitiveLog = (obj: TaskDefinition): any => ({ ...obj, }); @@ -5728,6 +6034,9 @@ export interface DeregisterTaskDefinitionResponse { } export namespace DeregisterTaskDefinitionResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeregisterTaskDefinitionResponse): any => ({ ...obj, }); @@ -5780,6 +6089,9 @@ export interface DescribeCapacityProvidersRequest { } export namespace DescribeCapacityProvidersRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeCapacityProvidersRequest): any => ({ ...obj, }); @@ -5807,6 +6119,9 @@ export interface Failure { } export namespace Failure { + /** + * @internal + */ export const filterSensitiveLog = (obj: Failure): any => ({ ...obj, }); @@ -5834,6 +6149,9 @@ export interface DescribeCapacityProvidersResponse { } export namespace DescribeCapacityProvidersResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeCapacityProvidersResponse): any => ({ ...obj, }); @@ -5896,6 +6214,9 @@ export interface DescribeClustersRequest { } export namespace DescribeClustersRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeClustersRequest): any => ({ ...obj, }); @@ -5914,6 +6235,9 @@ export interface DescribeClustersResponse { } export namespace DescribeClustersResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeClustersResponse): any => ({ ...obj, }); @@ -5946,6 +6270,9 @@ export interface DescribeContainerInstancesRequest { } export namespace DescribeContainerInstancesRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeContainerInstancesRequest): any => ({ ...obj, }); @@ -5964,6 +6291,9 @@ export interface DescribeContainerInstancesResponse { } export namespace DescribeContainerInstancesResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeContainerInstancesResponse): any => ({ ...obj, }); @@ -5996,6 +6326,9 @@ export interface DescribeServicesRequest { } export namespace DescribeServicesRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeServicesRequest): any => ({ ...obj, }); @@ -6014,6 +6347,9 @@ export interface DescribeServicesResponse { } export namespace DescribeServicesResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeServicesResponse): any => ({ ...obj, }); @@ -6041,6 +6377,9 @@ export interface DescribeTaskDefinitionRequest { } export namespace DescribeTaskDefinitionRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeTaskDefinitionRequest): any => ({ ...obj, }); @@ -6092,6 +6431,9 @@ export interface DescribeTaskDefinitionResponse { } export namespace DescribeTaskDefinitionResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeTaskDefinitionResponse): any => ({ ...obj, }); @@ -6123,6 +6465,9 @@ export interface DescribeTasksRequest { } export namespace DescribeTasksRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeTasksRequest): any => ({ ...obj, }); @@ -6170,6 +6515,9 @@ export interface ManagedAgent { } export namespace ManagedAgent { + /** + * @internal + */ export const filterSensitiveLog = (obj: ManagedAgent): any => ({ ...obj, }); @@ -6204,6 +6552,9 @@ export interface NetworkBinding { } export namespace NetworkBinding { + /** + * @internal + */ export const filterSensitiveLog = (obj: NetworkBinding): any => ({ ...obj, }); @@ -6231,6 +6582,9 @@ export interface NetworkInterface { } export namespace NetworkInterface { + /** + * @internal + */ export const filterSensitiveLog = (obj: NetworkInterface): any => ({ ...obj, }); @@ -6336,6 +6690,9 @@ export interface Container { } export namespace Container { + /** + * @internal + */ export const filterSensitiveLog = (obj: Container): any => ({ ...obj, }); @@ -6401,6 +6758,9 @@ export interface ContainerOverride { } export namespace ContainerOverride { + /** + * @internal + */ export const filterSensitiveLog = (obj: ContainerOverride): any => ({ ...obj, }); @@ -6426,6 +6786,9 @@ export interface InferenceAcceleratorOverride { } export namespace InferenceAcceleratorOverride { + /** + * @internal + */ export const filterSensitiveLog = (obj: InferenceAcceleratorOverride): any => ({ ...obj, }); @@ -6477,6 +6840,9 @@ export interface TaskOverride { } export namespace TaskOverride { + /** + * @internal + */ export const filterSensitiveLog = (obj: TaskOverride): any => ({ ...obj, }); @@ -6788,6 +7154,9 @@ export interface Task { } export namespace Task { + /** + * @internal + */ export const filterSensitiveLog = (obj: Task): any => ({ ...obj, }); @@ -6806,6 +7175,9 @@ export interface DescribeTasksResponse { } export namespace DescribeTasksResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeTasksResponse): any => ({ ...obj, }); @@ -6842,6 +7214,9 @@ export interface DescribeTaskSetsRequest { } export namespace DescribeTaskSetsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeTaskSetsRequest): any => ({ ...obj, }); @@ -6860,6 +7235,9 @@ export interface DescribeTaskSetsResponse { } export namespace DescribeTaskSetsResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeTaskSetsResponse): any => ({ ...obj, }); @@ -6880,6 +7258,9 @@ export interface DiscoverPollEndpointRequest { } export namespace DiscoverPollEndpointRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DiscoverPollEndpointRequest): any => ({ ...obj, }); @@ -6898,6 +7279,9 @@ export interface DiscoverPollEndpointResponse { } export namespace DiscoverPollEndpointResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DiscoverPollEndpointResponse): any => ({ ...obj, }); @@ -6933,6 +7317,9 @@ export interface ExecuteCommandRequest { } export namespace ExecuteCommandRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ExecuteCommandRequest): any => ({ ...obj, }); @@ -6961,6 +7348,9 @@ export interface Session { } export namespace Session { + /** + * @internal + */ export const filterSensitiveLog = (obj: Session): any => ({ ...obj, ...(obj.tokenValue && { tokenValue: SENSITIVE_STRING }), @@ -7001,6 +7391,9 @@ export interface ExecuteCommandResponse { } export namespace ExecuteCommandResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ExecuteCommandResponse): any => ({ ...obj, ...(obj.session && { session: Session.filterSensitiveLog(obj.session) }), @@ -7018,6 +7411,9 @@ export interface TargetNotConnectedException extends __SmithyException, $Metadat } export namespace TargetNotConnectedException { + /** + * @internal + */ export const filterSensitiveLog = (obj: TargetNotConnectedException): any => ({ ...obj, }); @@ -7082,6 +7478,9 @@ export interface ListAccountSettingsRequest { } export namespace ListAccountSettingsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListAccountSettingsRequest): any => ({ ...obj, }); @@ -7104,6 +7503,9 @@ export interface ListAccountSettingsResponse { } export namespace ListAccountSettingsResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListAccountSettingsResponse): any => ({ ...obj, }); @@ -7158,6 +7560,9 @@ export interface ListAttributesRequest { } export namespace ListAttributesRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListAttributesRequest): any => ({ ...obj, }); @@ -7180,6 +7585,9 @@ export interface ListAttributesResponse { } export namespace ListAttributesResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListAttributesResponse): any => ({ ...obj, }); @@ -7212,6 +7620,9 @@ export interface ListClustersRequest { } export namespace ListClustersRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListClustersRequest): any => ({ ...obj, }); @@ -7235,6 +7646,9 @@ export interface ListClustersResponse { } export namespace ListClustersResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListClustersResponse): any => ({ ...obj, }); @@ -7298,6 +7712,9 @@ export interface ListContainerInstancesRequest { } export namespace ListContainerInstancesRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListContainerInstancesRequest): any => ({ ...obj, }); @@ -7321,6 +7738,9 @@ export interface ListContainerInstancesResponse { } export namespace ListContainerInstancesResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListContainerInstancesResponse): any => ({ ...obj, }); @@ -7370,6 +7790,9 @@ export interface ListServicesRequest { } export namespace ListServicesRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListServicesRequest): any => ({ ...obj, }); @@ -7393,6 +7816,9 @@ export interface ListServicesResponse { } export namespace ListServicesResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListServicesResponse): any => ({ ...obj, }); @@ -7408,6 +7834,9 @@ export interface ListTagsForResourceRequest { } export namespace ListTagsForResourceRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListTagsForResourceRequest): any => ({ ...obj, }); @@ -7421,6 +7850,9 @@ export interface ListTagsForResourceResponse { } export namespace ListTagsForResourceResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListTagsForResourceResponse): any => ({ ...obj, }); @@ -7483,6 +7915,9 @@ export interface ListTaskDefinitionFamiliesRequest { } export namespace ListTaskDefinitionFamiliesRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListTaskDefinitionFamiliesRequest): any => ({ ...obj, }); @@ -7506,6 +7941,9 @@ export interface ListTaskDefinitionFamiliesResponse { } export namespace ListTaskDefinitionFamiliesResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListTaskDefinitionFamiliesResponse): any => ({ ...obj, }); @@ -7571,6 +8009,9 @@ export interface ListTaskDefinitionsRequest { } export namespace ListTaskDefinitionsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListTaskDefinitionsRequest): any => ({ ...obj, }); @@ -7594,6 +8035,9 @@ export interface ListTaskDefinitionsResponse { } export namespace ListTaskDefinitionsResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListTaskDefinitionsResponse): any => ({ ...obj, }); @@ -7687,6 +8131,9 @@ export interface ListTasksRequest { } export namespace ListTasksRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListTasksRequest): any => ({ ...obj, }); @@ -7709,6 +8156,9 @@ export interface ListTasksResponse { } export namespace ListTasksResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListTasksResponse): any => ({ ...obj, }); @@ -7749,6 +8199,9 @@ export interface PutAccountSettingRequest { } export namespace PutAccountSettingRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: PutAccountSettingRequest): any => ({ ...obj, }); @@ -7762,6 +8215,9 @@ export interface PutAccountSettingResponse { } export namespace PutAccountSettingResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: PutAccountSettingResponse): any => ({ ...obj, }); @@ -7788,6 +8244,9 @@ export interface PutAccountSettingDefaultRequest { } export namespace PutAccountSettingDefaultRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: PutAccountSettingDefaultRequest): any => ({ ...obj, }); @@ -7801,6 +8260,9 @@ export interface PutAccountSettingDefaultResponse { } export namespace PutAccountSettingDefaultResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: PutAccountSettingDefaultResponse): any => ({ ...obj, }); @@ -7818,6 +8280,9 @@ export interface AttributeLimitExceededException extends __SmithyException, $Met } export namespace AttributeLimitExceededException { + /** + * @internal + */ export const filterSensitiveLog = (obj: AttributeLimitExceededException): any => ({ ...obj, }); @@ -7838,6 +8303,9 @@ export interface PutAttributesRequest { } export namespace PutAttributesRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: PutAttributesRequest): any => ({ ...obj, }); @@ -7851,6 +8319,9 @@ export interface PutAttributesResponse { } export namespace PutAttributesResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: PutAttributesResponse): any => ({ ...obj, }); @@ -7896,6 +8367,9 @@ export interface PutClusterCapacityProvidersRequest { } export namespace PutClusterCapacityProvidersRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: PutClusterCapacityProvidersRequest): any => ({ ...obj, }); @@ -7909,6 +8383,9 @@ export interface PutClusterCapacityProvidersResponse { } export namespace PutClusterCapacityProvidersResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: PutClusterCapacityProvidersResponse): any => ({ ...obj, }); @@ -7924,6 +8401,9 @@ export interface ResourceInUseException extends __SmithyException, $MetadataBear } export namespace ResourceInUseException { + /** + * @internal + */ export const filterSensitiveLog = (obj: ResourceInUseException): any => ({ ...obj, }); @@ -7953,6 +8433,9 @@ export interface PlatformDevice { } export namespace PlatformDevice { + /** + * @internal + */ export const filterSensitiveLog = (obj: PlatformDevice): any => ({ ...obj, }); @@ -8048,6 +8531,9 @@ export interface RegisterContainerInstanceRequest { } export namespace RegisterContainerInstanceRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: RegisterContainerInstanceRequest): any => ({ ...obj, }); @@ -8061,6 +8547,9 @@ export interface RegisterContainerInstanceResponse { } export namespace RegisterContainerInstanceResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: RegisterContainerInstanceResponse): any => ({ ...obj, }); @@ -8352,6 +8841,9 @@ export interface RegisterTaskDefinitionRequest { } export namespace RegisterTaskDefinitionRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: RegisterTaskDefinitionRequest): any => ({ ...obj, }); @@ -8370,6 +8862,9 @@ export interface RegisterTaskDefinitionResponse { } export namespace RegisterTaskDefinitionResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: RegisterTaskDefinitionResponse): any => ({ ...obj, }); @@ -8385,6 +8880,9 @@ export interface BlockedException extends __SmithyException, $MetadataBearer { } export namespace BlockedException { + /** + * @internal + */ export const filterSensitiveLog = (obj: BlockedException): any => ({ ...obj, }); @@ -8565,6 +9063,9 @@ export interface RunTaskRequest { } export namespace RunTaskRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: RunTaskRequest): any => ({ ...obj, }); @@ -8584,6 +9085,9 @@ export interface RunTaskResponse { } export namespace RunTaskResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: RunTaskResponse): any => ({ ...obj, }); @@ -8711,6 +9215,9 @@ export interface StartTaskRequest { } export namespace StartTaskRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: StartTaskRequest): any => ({ ...obj, }); @@ -8730,6 +9237,9 @@ export interface StartTaskResponse { } export namespace StartTaskResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: StartTaskResponse): any => ({ ...obj, }); @@ -8757,6 +9267,9 @@ export interface StopTaskRequest { } export namespace StopTaskRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: StopTaskRequest): any => ({ ...obj, }); @@ -8770,6 +9283,9 @@ export interface StopTaskResponse { } export namespace StopTaskResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: StopTaskResponse): any => ({ ...obj, }); @@ -8791,6 +9307,9 @@ export interface AttachmentStateChange { } export namespace AttachmentStateChange { + /** + * @internal + */ export const filterSensitiveLog = (obj: AttachmentStateChange): any => ({ ...obj, }); @@ -8810,6 +9329,9 @@ export interface SubmitAttachmentStateChangesRequest { } export namespace SubmitAttachmentStateChangesRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: SubmitAttachmentStateChangesRequest): any => ({ ...obj, }); @@ -8823,6 +9345,9 @@ export interface SubmitAttachmentStateChangesResponse { } export namespace SubmitAttachmentStateChangesResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: SubmitAttachmentStateChangesResponse): any => ({ ...obj, }); @@ -8871,6 +9396,9 @@ export interface SubmitContainerStateChangeRequest { } export namespace SubmitContainerStateChangeRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: SubmitContainerStateChangeRequest): any => ({ ...obj, }); @@ -8884,6 +9412,9 @@ export interface SubmitContainerStateChangeResponse { } export namespace SubmitContainerStateChangeResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: SubmitContainerStateChangeResponse): any => ({ ...obj, }); @@ -8931,6 +9462,9 @@ export interface ContainerStateChange { } export namespace ContainerStateChange { + /** + * @internal + */ export const filterSensitiveLog = (obj: ContainerStateChange): any => ({ ...obj, }); @@ -8962,6 +9496,9 @@ export interface ManagedAgentStateChange { } export namespace ManagedAgentStateChange { + /** + * @internal + */ export const filterSensitiveLog = (obj: ManagedAgentStateChange): any => ({ ...obj, }); @@ -9020,6 +9557,9 @@ export interface SubmitTaskStateChangeRequest { } export namespace SubmitTaskStateChangeRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: SubmitTaskStateChangeRequest): any => ({ ...obj, }); @@ -9033,6 +9573,9 @@ export interface SubmitTaskStateChangeResponse { } export namespace SubmitTaskStateChangeResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: SubmitTaskStateChangeResponse): any => ({ ...obj, }); @@ -9048,6 +9591,9 @@ export interface ResourceNotFoundException extends __SmithyException, $MetadataB } export namespace ResourceNotFoundException { + /** + * @internal + */ export const filterSensitiveLog = (obj: ResourceNotFoundException): any => ({ ...obj, }); @@ -9099,6 +9645,9 @@ export interface TagResourceRequest { } export namespace TagResourceRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: TagResourceRequest): any => ({ ...obj, }); @@ -9107,6 +9656,9 @@ export namespace TagResourceRequest { export interface TagResourceResponse {} export namespace TagResourceResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: TagResourceResponse): any => ({ ...obj, }); @@ -9127,6 +9679,9 @@ export interface UntagResourceRequest { } export namespace UntagResourceRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: UntagResourceRequest): any => ({ ...obj, }); @@ -9135,6 +9690,9 @@ export namespace UntagResourceRequest { export interface UntagResourceResponse {} export namespace UntagResourceResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: UntagResourceResponse): any => ({ ...obj, }); @@ -9168,6 +9726,9 @@ export interface AutoScalingGroupProviderUpdate { } export namespace AutoScalingGroupProviderUpdate { + /** + * @internal + */ export const filterSensitiveLog = (obj: AutoScalingGroupProviderUpdate): any => ({ ...obj, }); @@ -9187,6 +9748,9 @@ export interface UpdateCapacityProviderRequest { } export namespace UpdateCapacityProviderRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateCapacityProviderRequest): any => ({ ...obj, }); @@ -9200,6 +9764,9 @@ export interface UpdateCapacityProviderResponse { } export namespace UpdateCapacityProviderResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateCapacityProviderResponse): any => ({ ...obj, }); @@ -9223,6 +9790,9 @@ export interface UpdateClusterRequest { } export namespace UpdateClusterRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateClusterRequest): any => ({ ...obj, }); @@ -9236,6 +9806,9 @@ export interface UpdateClusterResponse { } export namespace UpdateClusterResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateClusterResponse): any => ({ ...obj, }); @@ -9257,6 +9830,9 @@ export interface UpdateClusterSettingsRequest { } export namespace UpdateClusterSettingsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateClusterSettingsRequest): any => ({ ...obj, }); @@ -9270,6 +9846,9 @@ export interface UpdateClusterSettingsResponse { } export namespace UpdateClusterSettingsResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateClusterSettingsResponse): any => ({ ...obj, }); @@ -9288,6 +9867,9 @@ export interface MissingVersionException extends __SmithyException, $MetadataBea } export namespace MissingVersionException { + /** + * @internal + */ export const filterSensitiveLog = (obj: MissingVersionException): any => ({ ...obj, }); @@ -9305,6 +9887,9 @@ export interface NoUpdateAvailableException extends __SmithyException, $Metadata } export namespace NoUpdateAvailableException { + /** + * @internal + */ export const filterSensitiveLog = (obj: NoUpdateAvailableException): any => ({ ...obj, }); @@ -9325,6 +9910,9 @@ export interface UpdateContainerAgentRequest { } export namespace UpdateContainerAgentRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateContainerAgentRequest): any => ({ ...obj, }); @@ -9338,6 +9926,9 @@ export interface UpdateContainerAgentResponse { } export namespace UpdateContainerAgentResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateContainerAgentResponse): any => ({ ...obj, }); @@ -9368,6 +9959,9 @@ export interface UpdateContainerInstancesStateRequest { } export namespace UpdateContainerInstancesStateRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateContainerInstancesStateRequest): any => ({ ...obj, }); @@ -9386,6 +9980,9 @@ export interface UpdateContainerInstancesStateResponse { } export namespace UpdateContainerInstancesStateResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateContainerInstancesStateResponse): any => ({ ...obj, }); @@ -9514,6 +10111,9 @@ export interface UpdateServiceRequest { } export namespace UpdateServiceRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateServiceRequest): any => ({ ...obj, }); @@ -9527,6 +10127,9 @@ export interface UpdateServiceResponse { } export namespace UpdateServiceResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateServiceResponse): any => ({ ...obj, }); @@ -9552,6 +10155,9 @@ export interface UpdateServicePrimaryTaskSetRequest { } export namespace UpdateServicePrimaryTaskSetRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateServicePrimaryTaskSetRequest): any => ({ ...obj, }); @@ -9565,6 +10171,9 @@ export interface UpdateServicePrimaryTaskSetResponse { } export namespace UpdateServicePrimaryTaskSetResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateServicePrimaryTaskSetResponse): any => ({ ...obj, }); @@ -9595,6 +10204,9 @@ export interface UpdateTaskSetRequest { } export namespace UpdateTaskSetRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateTaskSetRequest): any => ({ ...obj, }); @@ -9608,6 +10220,9 @@ export interface UpdateTaskSetResponse { } export namespace UpdateTaskSetResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateTaskSetResponse): any => ({ ...obj, }); diff --git a/clients/client-efs/commands/CreateAccessPointCommand.ts b/clients/client-efs/commands/CreateAccessPointCommand.ts index 04b8caf72e12..409459b8cfd2 100644 --- a/clients/client-efs/commands/CreateAccessPointCommand.ts +++ b/clients/client-efs/commands/CreateAccessPointCommand.ts @@ -29,6 +29,20 @@ export interface CreateAccessPointCommandOutput extends AccessPointDescription, * in its own directory and below. To learn more, see Mounting a file system using EFS access * points.

*

This operation requires permissions for the elasticfilesystem:CreateAccessPoint action.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { EFSClient, CreateAccessPointCommand } from "@aws-sdk/client-efs"; // ES Modules import + * // const { EFSClient, CreateAccessPointCommand } = require("@aws-sdk/client-efs"); // CommonJS import + * const client = new EFSClient(config); + * const command = new CreateAccessPointCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreateAccessPointCommandInput} for command's `input` shape. + * @see {@link CreateAccessPointCommandOutput} for command's `response` shape. + * @see {@link EFSClientResolvedConfig | config} for command's `input` shape. + * */ export class CreateAccessPointCommand extends $Command< CreateAccessPointCommandInput, diff --git a/clients/client-efs/commands/CreateFileSystemCommand.ts b/clients/client-efs/commands/CreateFileSystemCommand.ts index fca5b053bb82..359751138c76 100644 --- a/clients/client-efs/commands/CreateFileSystemCommand.ts +++ b/clients/client-efs/commands/CreateFileSystemCommand.ts @@ -75,6 +75,20 @@ export interface CreateFileSystemCommandOutput extends FileSystemDescription, __ * *

This operation requires permissions for the * elasticfilesystem:CreateFileSystem action.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { EFSClient, CreateFileSystemCommand } from "@aws-sdk/client-efs"; // ES Modules import + * // const { EFSClient, CreateFileSystemCommand } = require("@aws-sdk/client-efs"); // CommonJS import + * const client = new EFSClient(config); + * const command = new CreateFileSystemCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreateFileSystemCommandInput} for command's `input` shape. + * @see {@link CreateFileSystemCommandOutput} for command's `response` shape. + * @see {@link EFSClientResolvedConfig | config} for command's `input` shape. + * */ export class CreateFileSystemCommand extends $Command< CreateFileSystemCommandInput, diff --git a/clients/client-efs/commands/CreateMountTargetCommand.ts b/clients/client-efs/commands/CreateMountTargetCommand.ts index 19f87fdd04f5..ee647864896b 100644 --- a/clients/client-efs/commands/CreateMountTargetCommand.ts +++ b/clients/client-efs/commands/CreateMountTargetCommand.ts @@ -163,6 +163,20 @@ export interface CreateMountTargetCommandOutput extends MountTargetDescription, *

* * + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { EFSClient, CreateMountTargetCommand } from "@aws-sdk/client-efs"; // ES Modules import + * // const { EFSClient, CreateMountTargetCommand } = require("@aws-sdk/client-efs"); // CommonJS import + * const client = new EFSClient(config); + * const command = new CreateMountTargetCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreateMountTargetCommandInput} for command's `input` shape. + * @see {@link CreateMountTargetCommandOutput} for command's `response` shape. + * @see {@link EFSClientResolvedConfig | config} for command's `input` shape. + * */ export class CreateMountTargetCommand extends $Command< CreateMountTargetCommandInput, diff --git a/clients/client-efs/commands/CreateTagsCommand.ts b/clients/client-efs/commands/CreateTagsCommand.ts index dfc640fb3bcb..b7c47e925b94 100644 --- a/clients/client-efs/commands/CreateTagsCommand.ts +++ b/clients/client-efs/commands/CreateTagsCommand.ts @@ -29,6 +29,20 @@ export interface CreateTagsCommandOutput extends __MetadataBearer {} * 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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { EFSClient, CreateTagsCommand } from "@aws-sdk/client-efs"; // ES Modules import + * // const { EFSClient, CreateTagsCommand } = require("@aws-sdk/client-efs"); // CommonJS import + * const client = new EFSClient(config); + * const command = new CreateTagsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreateTagsCommandInput} for command's `input` shape. + * @see {@link CreateTagsCommandOutput} for command's `response` shape. + * @see {@link EFSClientResolvedConfig | config} for command's `input` shape. + * */ export class CreateTagsCommand extends $Command< CreateTagsCommandInput, diff --git a/clients/client-efs/commands/DeleteAccessPointCommand.ts b/clients/client-efs/commands/DeleteAccessPointCommand.ts index 2ce13962ab4c..4edb5ca55863 100644 --- a/clients/client-efs/commands/DeleteAccessPointCommand.ts +++ b/clients/client-efs/commands/DeleteAccessPointCommand.ts @@ -25,6 +25,20 @@ export interface DeleteAccessPointCommandOutput extends __MetadataBearer {} * 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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { EFSClient, DeleteAccessPointCommand } from "@aws-sdk/client-efs"; // ES Modules import + * // const { EFSClient, DeleteAccessPointCommand } = require("@aws-sdk/client-efs"); // CommonJS import + * const client = new EFSClient(config); + * const command = new DeleteAccessPointCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteAccessPointCommandInput} for command's `input` shape. + * @see {@link DeleteAccessPointCommandOutput} for command's `response` shape. + * @see {@link EFSClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteAccessPointCommand extends $Command< DeleteAccessPointCommandInput, diff --git a/clients/client-efs/commands/DeleteFileSystemCommand.ts b/clients/client-efs/commands/DeleteFileSystemCommand.ts index 5b8ab1e69650..82a393e2671f 100644 --- a/clients/client-efs/commands/DeleteFileSystemCommand.ts +++ b/clients/client-efs/commands/DeleteFileSystemCommand.ts @@ -36,6 +36,20 @@ export interface DeleteFileSystemCommandOutput extends __MetadataBearer {} * *

This operation requires permissions for the * elasticfilesystem:DeleteFileSystem action.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { EFSClient, DeleteFileSystemCommand } from "@aws-sdk/client-efs"; // ES Modules import + * // const { EFSClient, DeleteFileSystemCommand } = require("@aws-sdk/client-efs"); // CommonJS import + * const client = new EFSClient(config); + * const command = new DeleteFileSystemCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteFileSystemCommandInput} for command's `input` shape. + * @see {@link DeleteFileSystemCommandOutput} for command's `response` shape. + * @see {@link EFSClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteFileSystemCommand extends $Command< DeleteFileSystemCommandInput, diff --git a/clients/client-efs/commands/DeleteFileSystemPolicyCommand.ts b/clients/client-efs/commands/DeleteFileSystemPolicyCommand.ts index 015486d4e309..1cacabc64351 100644 --- a/clients/client-efs/commands/DeleteFileSystemPolicyCommand.ts +++ b/clients/client-efs/commands/DeleteFileSystemPolicyCommand.ts @@ -25,6 +25,20 @@ export interface DeleteFileSystemPolicyCommandOutput extends __MetadataBearer {} * 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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { EFSClient, DeleteFileSystemPolicyCommand } from "@aws-sdk/client-efs"; // ES Modules import + * // const { EFSClient, DeleteFileSystemPolicyCommand } = require("@aws-sdk/client-efs"); // CommonJS import + * const client = new EFSClient(config); + * const command = new DeleteFileSystemPolicyCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteFileSystemPolicyCommandInput} for command's `input` shape. + * @see {@link DeleteFileSystemPolicyCommandOutput} for command's `response` shape. + * @see {@link EFSClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteFileSystemPolicyCommand extends $Command< DeleteFileSystemPolicyCommandInput, diff --git a/clients/client-efs/commands/DeleteMountTargetCommand.ts b/clients/client-efs/commands/DeleteMountTargetCommand.ts index dacc8ddc2426..a624a4ab7337 100644 --- a/clients/client-efs/commands/DeleteMountTargetCommand.ts +++ b/clients/client-efs/commands/DeleteMountTargetCommand.ts @@ -55,6 +55,20 @@ export interface DeleteMountTargetCommandOutput extends __MetadataBearer {} *

* * + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { EFSClient, DeleteMountTargetCommand } from "@aws-sdk/client-efs"; // ES Modules import + * // const { EFSClient, DeleteMountTargetCommand } = require("@aws-sdk/client-efs"); // CommonJS import + * const client = new EFSClient(config); + * const command = new DeleteMountTargetCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteMountTargetCommandInput} for command's `input` shape. + * @see {@link DeleteMountTargetCommandOutput} for command's `response` shape. + * @see {@link EFSClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteMountTargetCommand extends $Command< DeleteMountTargetCommandInput, diff --git a/clients/client-efs/commands/DeleteTagsCommand.ts b/clients/client-efs/commands/DeleteTagsCommand.ts index 7cdded8124fd..8a971372913f 100644 --- a/clients/client-efs/commands/DeleteTagsCommand.ts +++ b/clients/client-efs/commands/DeleteTagsCommand.ts @@ -30,6 +30,20 @@ export interface DeleteTagsCommandOutput extends __MetadataBearer {} * *

This operation requires permissions for the elasticfilesystem:DeleteTags * action.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { EFSClient, DeleteTagsCommand } from "@aws-sdk/client-efs"; // ES Modules import + * // const { EFSClient, DeleteTagsCommand } = require("@aws-sdk/client-efs"); // CommonJS import + * const client = new EFSClient(config); + * const command = new DeleteTagsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteTagsCommandInput} for command's `input` shape. + * @see {@link DeleteTagsCommandOutput} for command's `response` shape. + * @see {@link EFSClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteTagsCommand extends $Command< DeleteTagsCommandInput, diff --git a/clients/client-efs/commands/DescribeAccessPointsCommand.ts b/clients/client-efs/commands/DescribeAccessPointsCommand.ts index d3dcc8e6c2d0..ea370d8fed95 100644 --- a/clients/client-efs/commands/DescribeAccessPointsCommand.ts +++ b/clients/client-efs/commands/DescribeAccessPointsCommand.ts @@ -25,6 +25,20 @@ export interface DescribeAccessPointsCommandOutput extends DescribeAccessPointsR * 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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { EFSClient, DescribeAccessPointsCommand } from "@aws-sdk/client-efs"; // ES Modules import + * // const { EFSClient, DescribeAccessPointsCommand } = require("@aws-sdk/client-efs"); // CommonJS import + * const client = new EFSClient(config); + * const command = new DescribeAccessPointsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeAccessPointsCommandInput} for command's `input` shape. + * @see {@link DescribeAccessPointsCommandOutput} for command's `response` shape. + * @see {@link EFSClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeAccessPointsCommand extends $Command< DescribeAccessPointsCommandInput, diff --git a/clients/client-efs/commands/DescribeBackupPolicyCommand.ts b/clients/client-efs/commands/DescribeBackupPolicyCommand.ts index b62016b9bd33..ec29a00a49b1 100644 --- a/clients/client-efs/commands/DescribeBackupPolicyCommand.ts +++ b/clients/client-efs/commands/DescribeBackupPolicyCommand.ts @@ -22,6 +22,20 @@ export interface DescribeBackupPolicyCommandOutput extends BackupPolicyDescripti /** *

Returns the backup policy for the specified EFS file system.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { EFSClient, DescribeBackupPolicyCommand } from "@aws-sdk/client-efs"; // ES Modules import + * // const { EFSClient, DescribeBackupPolicyCommand } = require("@aws-sdk/client-efs"); // CommonJS import + * const client = new EFSClient(config); + * const command = new DescribeBackupPolicyCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeBackupPolicyCommandInput} for command's `input` shape. + * @see {@link DescribeBackupPolicyCommandOutput} for command's `response` shape. + * @see {@link EFSClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeBackupPolicyCommand extends $Command< DescribeBackupPolicyCommandInput, diff --git a/clients/client-efs/commands/DescribeFileSystemPolicyCommand.ts b/clients/client-efs/commands/DescribeFileSystemPolicyCommand.ts index fdc55085e207..f009dce4bba5 100644 --- a/clients/client-efs/commands/DescribeFileSystemPolicyCommand.ts +++ b/clients/client-efs/commands/DescribeFileSystemPolicyCommand.ts @@ -23,6 +23,20 @@ export interface DescribeFileSystemPolicyCommandOutput extends FileSystemPolicyD /** *

Returns the FileSystemPolicy for the specified EFS file system.

*

This operation requires permissions for the elasticfilesystem:DescribeFileSystemPolicy action.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { EFSClient, DescribeFileSystemPolicyCommand } from "@aws-sdk/client-efs"; // ES Modules import + * // const { EFSClient, DescribeFileSystemPolicyCommand } = require("@aws-sdk/client-efs"); // CommonJS import + * const client = new EFSClient(config); + * const command = new DescribeFileSystemPolicyCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeFileSystemPolicyCommandInput} for command's `input` shape. + * @see {@link DescribeFileSystemPolicyCommandOutput} for command's `response` shape. + * @see {@link EFSClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeFileSystemPolicyCommand extends $Command< DescribeFileSystemPolicyCommandInput, diff --git a/clients/client-efs/commands/DescribeFileSystemsCommand.ts b/clients/client-efs/commands/DescribeFileSystemsCommand.ts index cf29dd2b4d53..6d36687db7b2 100644 --- a/clients/client-efs/commands/DescribeFileSystemsCommand.ts +++ b/clients/client-efs/commands/DescribeFileSystemsCommand.ts @@ -44,6 +44,20 @@ export interface DescribeFileSystemsCommandOutput extends DescribeFileSystemsRes * responses of a multi-call iteration is unspecified.

*

This operation requires permissions for the * elasticfilesystem:DescribeFileSystems action.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { EFSClient, DescribeFileSystemsCommand } from "@aws-sdk/client-efs"; // ES Modules import + * // const { EFSClient, DescribeFileSystemsCommand } = require("@aws-sdk/client-efs"); // CommonJS import + * const client = new EFSClient(config); + * const command = new DescribeFileSystemsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeFileSystemsCommandInput} for command's `input` shape. + * @see {@link DescribeFileSystemsCommandOutput} for command's `response` shape. + * @see {@link EFSClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeFileSystemsCommand extends $Command< DescribeFileSystemsCommandInput, diff --git a/clients/client-efs/commands/DescribeLifecycleConfigurationCommand.ts b/clients/client-efs/commands/DescribeLifecycleConfigurationCommand.ts index 8e464bec029b..7b4f8a6a46b5 100644 --- a/clients/client-efs/commands/DescribeLifecycleConfigurationCommand.ts +++ b/clients/client-efs/commands/DescribeLifecycleConfigurationCommand.ts @@ -30,6 +30,20 @@ export interface DescribeLifecycleConfigurationCommandOutput * response.

*

This operation requires permissions for the * elasticfilesystem:DescribeLifecycleConfiguration operation.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { EFSClient, DescribeLifecycleConfigurationCommand } from "@aws-sdk/client-efs"; // ES Modules import + * // const { EFSClient, DescribeLifecycleConfigurationCommand } = require("@aws-sdk/client-efs"); // CommonJS import + * const client = new EFSClient(config); + * const command = new DescribeLifecycleConfigurationCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeLifecycleConfigurationCommandInput} for command's `input` shape. + * @see {@link DescribeLifecycleConfigurationCommandOutput} for command's `response` shape. + * @see {@link EFSClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeLifecycleConfigurationCommand extends $Command< DescribeLifecycleConfigurationCommandInput, diff --git a/clients/client-efs/commands/DescribeMountTargetSecurityGroupsCommand.ts b/clients/client-efs/commands/DescribeMountTargetSecurityGroupsCommand.ts index 5e81f3665aaf..8e1543b4d0cd 100644 --- a/clients/client-efs/commands/DescribeMountTargetSecurityGroupsCommand.ts +++ b/clients/client-efs/commands/DescribeMountTargetSecurityGroupsCommand.ts @@ -42,6 +42,20 @@ export interface DescribeMountTargetSecurityGroupsCommandOutput * network interface.

* * + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { EFSClient, DescribeMountTargetSecurityGroupsCommand } from "@aws-sdk/client-efs"; // ES Modules import + * // const { EFSClient, DescribeMountTargetSecurityGroupsCommand } = require("@aws-sdk/client-efs"); // CommonJS import + * const client = new EFSClient(config); + * const command = new DescribeMountTargetSecurityGroupsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeMountTargetSecurityGroupsCommandInput} for command's `input` shape. + * @see {@link DescribeMountTargetSecurityGroupsCommandOutput} for command's `response` shape. + * @see {@link EFSClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeMountTargetSecurityGroupsCommand extends $Command< DescribeMountTargetSecurityGroupsCommandInput, diff --git a/clients/client-efs/commands/DescribeMountTargetsCommand.ts b/clients/client-efs/commands/DescribeMountTargetsCommand.ts index 3f18df51331c..f51796d05a5b 100644 --- a/clients/client-efs/commands/DescribeMountTargetsCommand.ts +++ b/clients/client-efs/commands/DescribeMountTargetsCommand.ts @@ -29,6 +29,20 @@ export interface DescribeMountTargetsCommandOutput extends DescribeMountTargetsR * 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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { EFSClient, DescribeMountTargetsCommand } from "@aws-sdk/client-efs"; // ES Modules import + * // const { EFSClient, DescribeMountTargetsCommand } = require("@aws-sdk/client-efs"); // CommonJS import + * const client = new EFSClient(config); + * const command = new DescribeMountTargetsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeMountTargetsCommandInput} for command's `input` shape. + * @see {@link DescribeMountTargetsCommandOutput} for command's `response` shape. + * @see {@link EFSClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeMountTargetsCommand extends $Command< DescribeMountTargetsCommandInput, diff --git a/clients/client-efs/commands/DescribeTagsCommand.ts b/clients/client-efs/commands/DescribeTagsCommand.ts index d717c56f8c10..7c0a1fe54cc7 100644 --- a/clients/client-efs/commands/DescribeTagsCommand.ts +++ b/clients/client-efs/commands/DescribeTagsCommand.ts @@ -28,6 +28,20 @@ export interface DescribeTagsCommandOutput extends DescribeTagsResponse, __Metad * responses of a multiple-call iteration (when using pagination) is unspecified.

*

This operation requires permissions for the * elasticfilesystem:DescribeTags action.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { EFSClient, DescribeTagsCommand } from "@aws-sdk/client-efs"; // ES Modules import + * // const { EFSClient, DescribeTagsCommand } = require("@aws-sdk/client-efs"); // CommonJS import + * const client = new EFSClient(config); + * const command = new DescribeTagsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeTagsCommandInput} for command's `input` shape. + * @see {@link DescribeTagsCommandOutput} for command's `response` shape. + * @see {@link EFSClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeTagsCommand extends $Command< DescribeTagsCommandInput, diff --git a/clients/client-efs/commands/ListTagsForResourceCommand.ts b/clients/client-efs/commands/ListTagsForResourceCommand.ts index 78fcf8b8fc21..d4ec00607644 100644 --- a/clients/client-efs/commands/ListTagsForResourceCommand.ts +++ b/clients/client-efs/commands/ListTagsForResourceCommand.ts @@ -23,6 +23,20 @@ export interface ListTagsForResourceCommandOutput extends ListTagsForResourceRes /** *

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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { EFSClient, ListTagsForResourceCommand } from "@aws-sdk/client-efs"; // ES Modules import + * // const { EFSClient, ListTagsForResourceCommand } = require("@aws-sdk/client-efs"); // CommonJS import + * const client = new EFSClient(config); + * const command = new ListTagsForResourceCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListTagsForResourceCommandInput} for command's `input` shape. + * @see {@link ListTagsForResourceCommandOutput} for command's `response` shape. + * @see {@link EFSClientResolvedConfig | config} for command's `input` shape. + * */ export class ListTagsForResourceCommand extends $Command< ListTagsForResourceCommandInput, diff --git a/clients/client-efs/commands/ModifyMountTargetSecurityGroupsCommand.ts b/clients/client-efs/commands/ModifyMountTargetSecurityGroupsCommand.ts index 13c1fa181c3a..3e15cb0cd354 100644 --- a/clients/client-efs/commands/ModifyMountTargetSecurityGroupsCommand.ts +++ b/clients/client-efs/commands/ModifyMountTargetSecurityGroupsCommand.ts @@ -41,6 +41,20 @@ export interface ModifyMountTargetSecurityGroupsCommandOutput extends __Metadata * interface.

* * + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { EFSClient, ModifyMountTargetSecurityGroupsCommand } from "@aws-sdk/client-efs"; // ES Modules import + * // const { EFSClient, ModifyMountTargetSecurityGroupsCommand } = require("@aws-sdk/client-efs"); // CommonJS import + * const client = new EFSClient(config); + * const command = new ModifyMountTargetSecurityGroupsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ModifyMountTargetSecurityGroupsCommandInput} for command's `input` shape. + * @see {@link ModifyMountTargetSecurityGroupsCommandOutput} for command's `response` shape. + * @see {@link EFSClientResolvedConfig | config} for command's `input` shape. + * */ export class ModifyMountTargetSecurityGroupsCommand extends $Command< ModifyMountTargetSecurityGroupsCommandInput, diff --git a/clients/client-efs/commands/PutBackupPolicyCommand.ts b/clients/client-efs/commands/PutBackupPolicyCommand.ts index bd33b44ab413..dc8c36d8485e 100644 --- a/clients/client-efs/commands/PutBackupPolicyCommand.ts +++ b/clients/client-efs/commands/PutBackupPolicyCommand.ts @@ -22,6 +22,20 @@ export interface PutBackupPolicyCommandOutput extends BackupPolicyDescription, _ /** *

Updates the file system's backup policy. Use this action to start or stop automatic backups of the file system.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { EFSClient, PutBackupPolicyCommand } from "@aws-sdk/client-efs"; // ES Modules import + * // const { EFSClient, PutBackupPolicyCommand } = require("@aws-sdk/client-efs"); // CommonJS import + * const client = new EFSClient(config); + * const command = new PutBackupPolicyCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link PutBackupPolicyCommandInput} for command's `input` shape. + * @see {@link PutBackupPolicyCommandOutput} for command's `response` shape. + * @see {@link EFSClientResolvedConfig | config} for command's `input` shape. + * */ export class PutBackupPolicyCommand extends $Command< PutBackupPolicyCommandInput, diff --git a/clients/client-efs/commands/PutFileSystemPolicyCommand.ts b/clients/client-efs/commands/PutFileSystemPolicyCommand.ts index 8a7de1d1e684..8fe3a9c144e3 100644 --- a/clients/client-efs/commands/PutFileSystemPolicyCommand.ts +++ b/clients/client-efs/commands/PutFileSystemPolicyCommand.ts @@ -31,6 +31,20 @@ export interface PutFileSystemPolicyCommandOutput extends FileSystemPolicyDescri *

*

EFS file system policies have a 20,000 character limit.

*

This operation requires permissions for the elasticfilesystem:PutFileSystemPolicy action.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { EFSClient, PutFileSystemPolicyCommand } from "@aws-sdk/client-efs"; // ES Modules import + * // const { EFSClient, PutFileSystemPolicyCommand } = require("@aws-sdk/client-efs"); // CommonJS import + * const client = new EFSClient(config); + * const command = new PutFileSystemPolicyCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link PutFileSystemPolicyCommandInput} for command's `input` shape. + * @see {@link PutFileSystemPolicyCommandOutput} for command's `response` shape. + * @see {@link EFSClientResolvedConfig | config} for command's `input` shape. + * */ export class PutFileSystemPolicyCommand extends $Command< PutFileSystemPolicyCommandInput, diff --git a/clients/client-efs/commands/PutLifecycleConfigurationCommand.ts b/clients/client-efs/commands/PutLifecycleConfigurationCommand.ts index 82b4816c0c1d..2512bd2d60cf 100644 --- a/clients/client-efs/commands/PutLifecycleConfigurationCommand.ts +++ b/clients/client-efs/commands/PutLifecycleConfigurationCommand.ts @@ -50,6 +50,20 @@ export interface PutLifecycleConfigurationCommandOutput extends LifecycleConfigu *

To apply a LifecycleConfiguration object to an encrypted file system, you * need the same AWS Key Management Service (AWS KMS) permissions as when you created the encrypted * file system.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { EFSClient, PutLifecycleConfigurationCommand } from "@aws-sdk/client-efs"; // ES Modules import + * // const { EFSClient, PutLifecycleConfigurationCommand } = require("@aws-sdk/client-efs"); // CommonJS import + * const client = new EFSClient(config); + * const command = new PutLifecycleConfigurationCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link PutLifecycleConfigurationCommandInput} for command's `input` shape. + * @see {@link PutLifecycleConfigurationCommandOutput} for command's `response` shape. + * @see {@link EFSClientResolvedConfig | config} for command's `input` shape. + * */ export class PutLifecycleConfigurationCommand extends $Command< PutLifecycleConfigurationCommandInput, diff --git a/clients/client-efs/commands/TagResourceCommand.ts b/clients/client-efs/commands/TagResourceCommand.ts index 123afa6b54a7..805482ff5c61 100644 --- a/clients/client-efs/commands/TagResourceCommand.ts +++ b/clients/client-efs/commands/TagResourceCommand.ts @@ -23,6 +23,20 @@ export interface TagResourceCommandOutput extends __MetadataBearer {} /** *

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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { EFSClient, TagResourceCommand } from "@aws-sdk/client-efs"; // ES Modules import + * // const { EFSClient, TagResourceCommand } = require("@aws-sdk/client-efs"); // CommonJS import + * const client = new EFSClient(config); + * const command = new TagResourceCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link TagResourceCommandInput} for command's `input` shape. + * @see {@link TagResourceCommandOutput} for command's `response` shape. + * @see {@link EFSClientResolvedConfig | config} for command's `input` shape. + * */ export class TagResourceCommand extends $Command< TagResourceCommandInput, diff --git a/clients/client-efs/commands/UntagResourceCommand.ts b/clients/client-efs/commands/UntagResourceCommand.ts index d7ddb6f9e6f4..7cd8abd68b08 100644 --- a/clients/client-efs/commands/UntagResourceCommand.ts +++ b/clients/client-efs/commands/UntagResourceCommand.ts @@ -23,6 +23,20 @@ export interface UntagResourceCommandOutput extends __MetadataBearer {} /** *

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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { EFSClient, UntagResourceCommand } from "@aws-sdk/client-efs"; // ES Modules import + * // const { EFSClient, UntagResourceCommand } = require("@aws-sdk/client-efs"); // CommonJS import + * const client = new EFSClient(config); + * const command = new UntagResourceCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link UntagResourceCommandInput} for command's `input` shape. + * @see {@link UntagResourceCommandOutput} for command's `response` shape. + * @see {@link EFSClientResolvedConfig | config} for command's `input` shape. + * */ export class UntagResourceCommand extends $Command< UntagResourceCommandInput, diff --git a/clients/client-efs/commands/UpdateFileSystemCommand.ts b/clients/client-efs/commands/UpdateFileSystemCommand.ts index 38b98fcade15..ca23dcfcef18 100644 --- a/clients/client-efs/commands/UpdateFileSystemCommand.ts +++ b/clients/client-efs/commands/UpdateFileSystemCommand.ts @@ -23,6 +23,20 @@ export interface UpdateFileSystemCommandOutput extends FileSystemDescription, __ /** *

Updates the throughput mode or the amount of provisioned throughput of an existing file * system.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { EFSClient, UpdateFileSystemCommand } from "@aws-sdk/client-efs"; // ES Modules import + * // const { EFSClient, UpdateFileSystemCommand } = require("@aws-sdk/client-efs"); // CommonJS import + * const client = new EFSClient(config); + * const command = new UpdateFileSystemCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link UpdateFileSystemCommandInput} for command's `input` shape. + * @see {@link UpdateFileSystemCommandOutput} for command's `response` shape. + * @see {@link EFSClientResolvedConfig | config} for command's `input` shape. + * */ export class UpdateFileSystemCommand extends $Command< UpdateFileSystemCommandInput, diff --git a/clients/client-efs/models/models_0.ts b/clients/client-efs/models/models_0.ts index 695b0ffaa71c..3716b2853db9 100644 --- a/clients/client-efs/models/models_0.ts +++ b/clients/client-efs/models/models_0.ts @@ -14,6 +14,9 @@ export interface AccessPointAlreadyExists extends __SmithyException, $MetadataBe } export namespace AccessPointAlreadyExists { + /** + * @internal + */ export const filterSensitiveLog = (obj: AccessPointAlreadyExists): any => ({ ...obj, }); @@ -50,6 +53,9 @@ export interface PosixUser { } export namespace PosixUser { + /** + * @internal + */ export const filterSensitiveLog = (obj: PosixUser): any => ({ ...obj, }); @@ -87,6 +93,9 @@ export interface CreationInfo { } export namespace CreationInfo { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreationInfo): any => ({ ...obj, }); @@ -121,6 +130,9 @@ export interface RootDirectory { } export namespace RootDirectory { + /** + * @internal + */ export const filterSensitiveLog = (obj: RootDirectory): any => ({ ...obj, }); @@ -144,6 +156,9 @@ export interface Tag { } export namespace Tag { + /** + * @internal + */ export const filterSensitiveLog = (obj: Tag): any => ({ ...obj, }); @@ -206,6 +221,9 @@ export interface AccessPointDescription { } export namespace AccessPointDescription { + /** + * @internal + */ export const filterSensitiveLog = (obj: AccessPointDescription): any => ({ ...obj, }); @@ -223,6 +241,9 @@ export interface AccessPointLimitExceeded extends __SmithyException, $MetadataBe } export namespace AccessPointLimitExceeded { + /** + * @internal + */ export const filterSensitiveLog = (obj: AccessPointLimitExceeded): any => ({ ...obj, }); @@ -240,6 +261,9 @@ export interface AccessPointNotFound extends __SmithyException, $MetadataBearer } export namespace AccessPointNotFound { + /** + * @internal + */ export const filterSensitiveLog = (obj: AccessPointNotFound): any => ({ ...obj, }); @@ -257,6 +281,9 @@ export interface AvailabilityZonesMismatch extends __SmithyException, $MetadataB } export namespace AvailabilityZonesMismatch { + /** + * @internal + */ export const filterSensitiveLog = (obj: AvailabilityZonesMismatch): any => ({ ...obj, }); @@ -307,6 +334,9 @@ export interface BackupPolicy { } export namespace BackupPolicy { + /** + * @internal + */ export const filterSensitiveLog = (obj: BackupPolicy): any => ({ ...obj, }); @@ -320,6 +350,9 @@ export interface BackupPolicyDescription { } export namespace BackupPolicyDescription { + /** + * @internal + */ export const filterSensitiveLog = (obj: BackupPolicyDescription): any => ({ ...obj, }); @@ -337,6 +370,9 @@ export interface BadRequest extends __SmithyException, $MetadataBearer { } export namespace BadRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: BadRequest): any => ({ ...obj, }); @@ -380,6 +416,9 @@ export interface CreateAccessPointRequest { } export namespace CreateAccessPointRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateAccessPointRequest): any => ({ ...obj, }); @@ -397,6 +436,9 @@ export interface FileSystemNotFound extends __SmithyException, $MetadataBearer { } export namespace FileSystemNotFound { + /** + * @internal + */ export const filterSensitiveLog = (obj: FileSystemNotFound): any => ({ ...obj, }); @@ -413,6 +455,9 @@ export interface IncorrectFileSystemLifeCycleState extends __SmithyException, $M } export namespace IncorrectFileSystemLifeCycleState { + /** + * @internal + */ export const filterSensitiveLog = (obj: IncorrectFileSystemLifeCycleState): any => ({ ...obj, }); @@ -429,6 +474,9 @@ export interface InternalServerError extends __SmithyException, $MetadataBearer } export namespace InternalServerError { + /** + * @internal + */ export const filterSensitiveLog = (obj: InternalServerError): any => ({ ...obj, }); @@ -559,6 +607,9 @@ export interface CreateFileSystemRequest { } export namespace CreateFileSystemRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateFileSystemRequest): any => ({ ...obj, }); @@ -577,6 +628,9 @@ export interface FileSystemAlreadyExists extends __SmithyException, $MetadataBea } export namespace FileSystemAlreadyExists { + /** + * @internal + */ export const filterSensitiveLog = (obj: FileSystemAlreadyExists): any => ({ ...obj, }); @@ -617,6 +671,9 @@ export interface FileSystemSize { } export namespace FileSystemSize { + /** + * @internal + */ export const filterSensitiveLog = (obj: FileSystemSize): any => ({ ...obj, }); @@ -739,6 +796,9 @@ export interface FileSystemDescription { } export namespace FileSystemDescription { + /** + * @internal + */ export const filterSensitiveLog = (obj: FileSystemDescription): any => ({ ...obj, }); @@ -756,6 +816,9 @@ export interface FileSystemLimitExceeded extends __SmithyException, $MetadataBea } export namespace FileSystemLimitExceeded { + /** + * @internal + */ export const filterSensitiveLog = (obj: FileSystemLimitExceeded): any => ({ ...obj, }); @@ -776,6 +839,9 @@ export interface InsufficientThroughputCapacity extends __SmithyException, $Meta } export namespace InsufficientThroughputCapacity { + /** + * @internal + */ export const filterSensitiveLog = (obj: InsufficientThroughputCapacity): any => ({ ...obj, }); @@ -793,6 +859,9 @@ export interface ThroughputLimitExceeded extends __SmithyException, $MetadataBea } export namespace ThroughputLimitExceeded { + /** + * @internal + */ export const filterSensitiveLog = (obj: ThroughputLimitExceeded): any => ({ ...obj, }); @@ -809,6 +878,9 @@ export interface UnsupportedAvailabilityZone extends __SmithyException, $Metadat } export namespace UnsupportedAvailabilityZone { + /** + * @internal + */ export const filterSensitiveLog = (obj: UnsupportedAvailabilityZone): any => ({ ...obj, }); @@ -842,6 +914,9 @@ export interface CreateMountTargetRequest { } export namespace CreateMountTargetRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateMountTargetRequest): any => ({ ...obj, }); @@ -859,6 +934,9 @@ export interface IpAddressInUse extends __SmithyException, $MetadataBearer { } export namespace IpAddressInUse { + /** + * @internal + */ export const filterSensitiveLog = (obj: IpAddressInUse): any => ({ ...obj, }); @@ -876,6 +954,9 @@ export interface MountTargetConflict extends __SmithyException, $MetadataBearer } export namespace MountTargetConflict { + /** + * @internal + */ export const filterSensitiveLog = (obj: MountTargetConflict): any => ({ ...obj, }); @@ -941,6 +1022,9 @@ export interface MountTargetDescription { } export namespace MountTargetDescription { + /** + * @internal + */ export const filterSensitiveLog = (obj: MountTargetDescription): any => ({ ...obj, }); @@ -961,6 +1045,9 @@ export interface NetworkInterfaceLimitExceeded extends __SmithyException, $Metad } export namespace NetworkInterfaceLimitExceeded { + /** + * @internal + */ export const filterSensitiveLog = (obj: NetworkInterfaceLimitExceeded): any => ({ ...obj, }); @@ -978,6 +1065,9 @@ export interface NoFreeAddressesInSubnet extends __SmithyException, $MetadataBea } export namespace NoFreeAddressesInSubnet { + /** + * @internal + */ export const filterSensitiveLog = (obj: NoFreeAddressesInSubnet): any => ({ ...obj, }); @@ -995,6 +1085,9 @@ export interface SecurityGroupLimitExceeded extends __SmithyException, $Metadata } export namespace SecurityGroupLimitExceeded { + /** + * @internal + */ export const filterSensitiveLog = (obj: SecurityGroupLimitExceeded): any => ({ ...obj, }); @@ -1012,6 +1105,9 @@ export interface SecurityGroupNotFound extends __SmithyException, $MetadataBeare } export namespace SecurityGroupNotFound { + /** + * @internal + */ export const filterSensitiveLog = (obj: SecurityGroupNotFound): any => ({ ...obj, }); @@ -1029,6 +1125,9 @@ export interface SubnetNotFound extends __SmithyException, $MetadataBearer { } export namespace SubnetNotFound { + /** + * @internal + */ export const filterSensitiveLog = (obj: SubnetNotFound): any => ({ ...obj, }); @@ -1052,6 +1151,9 @@ export interface CreateTagsRequest { } export namespace CreateTagsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateTagsRequest): any => ({ ...obj, }); @@ -1065,6 +1167,9 @@ export interface DeleteAccessPointRequest { } export namespace DeleteAccessPointRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteAccessPointRequest): any => ({ ...obj, }); @@ -1081,6 +1186,9 @@ export interface DeleteFileSystemRequest { } export namespace DeleteFileSystemRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteFileSystemRequest): any => ({ ...obj, }); @@ -1097,6 +1205,9 @@ export interface FileSystemInUse extends __SmithyException, $MetadataBearer { } export namespace FileSystemInUse { + /** + * @internal + */ export const filterSensitiveLog = (obj: FileSystemInUse): any => ({ ...obj, }); @@ -1110,6 +1221,9 @@ export interface DeleteFileSystemPolicyRequest { } export namespace DeleteFileSystemPolicyRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteFileSystemPolicyRequest): any => ({ ...obj, }); @@ -1126,6 +1240,9 @@ export interface DeleteMountTargetRequest { } export namespace DeleteMountTargetRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteMountTargetRequest): any => ({ ...obj, }); @@ -1143,6 +1260,9 @@ export interface DependencyTimeout extends __SmithyException, $MetadataBearer { } export namespace DependencyTimeout { + /** + * @internal + */ export const filterSensitiveLog = (obj: DependencyTimeout): any => ({ ...obj, }); @@ -1160,6 +1280,9 @@ export interface MountTargetNotFound extends __SmithyException, $MetadataBearer } export namespace MountTargetNotFound { + /** + * @internal + */ export const filterSensitiveLog = (obj: MountTargetNotFound): any => ({ ...obj, }); @@ -1181,6 +1304,9 @@ export interface DeleteTagsRequest { } export namespace DeleteTagsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteTagsRequest): any => ({ ...obj, }); @@ -1212,6 +1338,9 @@ export interface DescribeAccessPointsRequest { } export namespace DescribeAccessPointsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeAccessPointsRequest): any => ({ ...obj, }); @@ -1231,6 +1360,9 @@ export interface DescribeAccessPointsResponse { } export namespace DescribeAccessPointsResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeAccessPointsResponse): any => ({ ...obj, }); @@ -1244,6 +1376,9 @@ export interface DescribeBackupPolicyRequest { } export namespace DescribeBackupPolicyRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeBackupPolicyRequest): any => ({ ...obj, }); @@ -1260,6 +1395,9 @@ export interface PolicyNotFound extends __SmithyException, $MetadataBearer { } export namespace PolicyNotFound { + /** + * @internal + */ export const filterSensitiveLog = (obj: PolicyNotFound): any => ({ ...obj, }); @@ -1276,6 +1414,9 @@ export interface ValidationException extends __SmithyException, $MetadataBearer } export namespace ValidationException { + /** + * @internal + */ export const filterSensitiveLog = (obj: ValidationException): any => ({ ...obj, }); @@ -1289,6 +1430,9 @@ export interface DescribeFileSystemPolicyRequest { } export namespace DescribeFileSystemPolicyRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeFileSystemPolicyRequest): any => ({ ...obj, }); @@ -1307,6 +1451,9 @@ export interface FileSystemPolicyDescription { } export namespace FileSystemPolicyDescription { + /** + * @internal + */ export const filterSensitiveLog = (obj: FileSystemPolicyDescription): any => ({ ...obj, }); @@ -1344,6 +1491,9 @@ export interface DescribeFileSystemsRequest { } export namespace DescribeFileSystemsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeFileSystemsRequest): any => ({ ...obj, }); @@ -1368,6 +1518,9 @@ export interface DescribeFileSystemsResponse { } export namespace DescribeFileSystemsResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeFileSystemsResponse): any => ({ ...obj, }); @@ -1382,6 +1535,9 @@ export interface DescribeLifecycleConfigurationRequest { } export namespace DescribeLifecycleConfigurationRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeLifecycleConfigurationRequest): any => ({ ...obj, }); @@ -1410,6 +1566,9 @@ export interface LifecyclePolicy { } export namespace LifecyclePolicy { + /** + * @internal + */ export const filterSensitiveLog = (obj: LifecyclePolicy): any => ({ ...obj, }); @@ -1424,6 +1583,9 @@ export interface LifecycleConfigurationDescription { } export namespace LifecycleConfigurationDescription { + /** + * @internal + */ export const filterSensitiveLog = (obj: LifecycleConfigurationDescription): any => ({ ...obj, }); @@ -1467,6 +1629,9 @@ export interface DescribeMountTargetsRequest { } export namespace DescribeMountTargetsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeMountTargetsRequest): any => ({ ...obj, }); @@ -1497,6 +1662,9 @@ export interface DescribeMountTargetsResponse { } export namespace DescribeMountTargetsResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeMountTargetsResponse): any => ({ ...obj, }); @@ -1513,6 +1681,9 @@ export interface DescribeMountTargetSecurityGroupsRequest { } export namespace DescribeMountTargetSecurityGroupsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeMountTargetSecurityGroupsRequest): any => ({ ...obj, }); @@ -1526,6 +1697,9 @@ export interface DescribeMountTargetSecurityGroupsResponse { } export namespace DescribeMountTargetSecurityGroupsResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeMountTargetSecurityGroupsResponse): any => ({ ...obj, }); @@ -1543,6 +1717,9 @@ export interface IncorrectMountTargetState extends __SmithyException, $MetadataB } export namespace IncorrectMountTargetState { + /** + * @internal + */ export const filterSensitiveLog = (obj: IncorrectMountTargetState): any => ({ ...obj, }); @@ -1573,6 +1750,9 @@ export interface DescribeTagsRequest { } export namespace DescribeTagsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeTagsRequest): any => ({ ...obj, }); @@ -1603,6 +1783,9 @@ export interface DescribeTagsResponse { } export namespace DescribeTagsResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeTagsResponse): any => ({ ...obj, }); @@ -1620,6 +1803,9 @@ export interface InvalidPolicyException extends __SmithyException, $MetadataBear } export namespace InvalidPolicyException { + /** + * @internal + */ export const filterSensitiveLog = (obj: InvalidPolicyException): any => ({ ...obj, }); @@ -1643,6 +1829,9 @@ export interface ListTagsForResourceRequest { } export namespace ListTagsForResourceRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListTagsForResourceRequest): any => ({ ...obj, }); @@ -1662,6 +1851,9 @@ export interface ListTagsForResourceResponse { } export namespace ListTagsForResourceResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListTagsForResourceResponse): any => ({ ...obj, }); @@ -1683,6 +1875,9 @@ export interface ModifyMountTargetSecurityGroupsRequest { } export namespace ModifyMountTargetSecurityGroupsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ModifyMountTargetSecurityGroupsRequest): any => ({ ...obj, }); @@ -1701,6 +1896,9 @@ export interface PutBackupPolicyRequest { } export namespace PutBackupPolicyRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: PutBackupPolicyRequest): any => ({ ...obj, }); @@ -1733,6 +1931,9 @@ export interface PutFileSystemPolicyRequest { } export namespace PutFileSystemPolicyRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: PutFileSystemPolicyRequest): any => ({ ...obj, }); @@ -1755,6 +1956,9 @@ export interface PutLifecycleConfigurationRequest { } export namespace PutLifecycleConfigurationRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: PutLifecycleConfigurationRequest): any => ({ ...obj, }); @@ -1773,6 +1977,9 @@ export interface TagResourceRequest { } export namespace TagResourceRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: TagResourceRequest): any => ({ ...obj, }); @@ -1792,6 +1999,9 @@ export interface UntagResourceRequest { } export namespace UntagResourceRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: UntagResourceRequest): any => ({ ...obj, }); @@ -1809,6 +2019,9 @@ export interface TooManyRequests extends __SmithyException, $MetadataBearer { } export namespace TooManyRequests { + /** + * @internal + */ export const filterSensitiveLog = (obj: TooManyRequests): any => ({ ...obj, }); @@ -1838,6 +2051,9 @@ export interface UpdateFileSystemRequest { } export namespace UpdateFileSystemRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateFileSystemRequest): any => ({ ...obj, }); diff --git a/clients/client-eks/commands/AssociateEncryptionConfigCommand.ts b/clients/client-eks/commands/AssociateEncryptionConfigCommand.ts index 860e0740add6..9a80469321ce 100644 --- a/clients/client-eks/commands/AssociateEncryptionConfigCommand.ts +++ b/clients/client-eks/commands/AssociateEncryptionConfigCommand.ts @@ -25,6 +25,20 @@ export interface AssociateEncryptionConfigCommandOutput extends AssociateEncrypt *

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 EKS clusters.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { EKSClient, AssociateEncryptionConfigCommand } from "@aws-sdk/client-eks"; // ES Modules import + * // const { EKSClient, AssociateEncryptionConfigCommand } = require("@aws-sdk/client-eks"); // CommonJS import + * const client = new EKSClient(config); + * const command = new AssociateEncryptionConfigCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link AssociateEncryptionConfigCommandInput} for command's `input` shape. + * @see {@link AssociateEncryptionConfigCommandOutput} for command's `response` shape. + * @see {@link EKSClientResolvedConfig | config} for command's `input` shape. + * */ export class AssociateEncryptionConfigCommand extends $Command< AssociateEncryptionConfigCommandInput, diff --git a/clients/client-eks/commands/AssociateIdentityProviderConfigCommand.ts b/clients/client-eks/commands/AssociateIdentityProviderConfigCommand.ts index 0a0be545c18d..caf2c2c15da4 100644 --- a/clients/client-eks/commands/AssociateIdentityProviderConfigCommand.ts +++ b/clients/client-eks/commands/AssociateIdentityProviderConfigCommand.ts @@ -31,6 +31,20 @@ export interface AssociateIdentityProviderConfigCommandOutput * roles to the identities using Kubernetes rolebindings and * clusterrolebindings. For more information see Using RBAC * Authorization in the Kubernetes documentation.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { EKSClient, AssociateIdentityProviderConfigCommand } from "@aws-sdk/client-eks"; // ES Modules import + * // const { EKSClient, AssociateIdentityProviderConfigCommand } = require("@aws-sdk/client-eks"); // CommonJS import + * const client = new EKSClient(config); + * const command = new AssociateIdentityProviderConfigCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link AssociateIdentityProviderConfigCommandInput} for command's `input` shape. + * @see {@link AssociateIdentityProviderConfigCommandOutput} for command's `response` shape. + * @see {@link EKSClientResolvedConfig | config} for command's `input` shape. + * */ export class AssociateIdentityProviderConfigCommand extends $Command< AssociateIdentityProviderConfigCommandInput, diff --git a/clients/client-eks/commands/CreateAddonCommand.ts b/clients/client-eks/commands/CreateAddonCommand.ts index 3c6049135f75..d3c571e5a0e1 100644 --- a/clients/client-eks/commands/CreateAddonCommand.ts +++ b/clients/client-eks/commands/CreateAddonCommand.ts @@ -27,6 +27,20 @@ export interface CreateAddonCommandOutput extends CreateAddonResponse, __Metadat * clusters running version 1.18 with platform version eks.3 or later because * add-ons rely on the Server-side Apply Kubernetes feature, which is only available in * Kubernetes 1.18 and later.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { EKSClient, CreateAddonCommand } from "@aws-sdk/client-eks"; // ES Modules import + * // const { EKSClient, CreateAddonCommand } = require("@aws-sdk/client-eks"); // CommonJS import + * const client = new EKSClient(config); + * const command = new CreateAddonCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreateAddonCommandInput} for command's `input` shape. + * @see {@link CreateAddonCommandOutput} for command's `response` shape. + * @see {@link EKSClientResolvedConfig | config} for command's `input` shape. + * */ export class CreateAddonCommand extends $Command< CreateAddonCommandInput, diff --git a/clients/client-eks/commands/CreateClusterCommand.ts b/clients/client-eks/commands/CreateClusterCommand.ts index e011d14a7242..0a5f39701180 100644 --- a/clients/client-eks/commands/CreateClusterCommand.ts +++ b/clients/client-eks/commands/CreateClusterCommand.ts @@ -40,6 +40,20 @@ export interface CreateClusterCommandOutput extends CreateClusterResponse, __Met * 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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { EKSClient, CreateClusterCommand } from "@aws-sdk/client-eks"; // ES Modules import + * // const { EKSClient, CreateClusterCommand } = require("@aws-sdk/client-eks"); // CommonJS import + * const client = new EKSClient(config); + * const command = new CreateClusterCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreateClusterCommandInput} for command's `input` shape. + * @see {@link CreateClusterCommandOutput} for command's `response` shape. + * @see {@link EKSClientResolvedConfig | config} for command's `input` shape. + * */ export class CreateClusterCommand extends $Command< CreateClusterCommandInput, diff --git a/clients/client-eks/commands/CreateFargateProfileCommand.ts b/clients/client-eks/commands/CreateFargateProfileCommand.ts index 7c379962335f..e3974eb0e3a0 100644 --- a/clients/client-eks/commands/CreateFargateProfileCommand.ts +++ b/clients/client-eks/commands/CreateFargateProfileCommand.ts @@ -45,6 +45,20 @@ export interface CreateFargateProfileCommandOutput extends CreateFargateProfileR * wait for that Fargate profile to finish deleting before you can create any other profiles * in that cluster.

*

For more information, see AWS Fargate Profile in the Amazon EKS User Guide.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { EKSClient, CreateFargateProfileCommand } from "@aws-sdk/client-eks"; // ES Modules import + * // const { EKSClient, CreateFargateProfileCommand } = require("@aws-sdk/client-eks"); // CommonJS import + * const client = new EKSClient(config); + * const command = new CreateFargateProfileCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreateFargateProfileCommandInput} for command's `input` shape. + * @see {@link CreateFargateProfileCommandOutput} for command's `response` shape. + * @see {@link EKSClientResolvedConfig | config} for command's `input` shape. + * */ export class CreateFargateProfileCommand extends $Command< CreateFargateProfileCommandInput, diff --git a/clients/client-eks/commands/CreateNodegroupCommand.ts b/clients/client-eks/commands/CreateNodegroupCommand.ts index 24bfa39e2646..d71a48992bcd 100644 --- a/clients/client-eks/commands/CreateNodegroupCommand.ts +++ b/clients/client-eks/commands/CreateNodegroupCommand.ts @@ -31,6 +31,20 @@ export interface CreateNodegroupCommandOutput extends CreateNodegroupResponse, _ * are managed by AWS for an Amazon EKS cluster. Each node group uses a version of the Amazon EKS * optimized Amazon Linux 2 AMI. For more information, see Managed * Node Groups in the Amazon EKS User Guide.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { EKSClient, CreateNodegroupCommand } from "@aws-sdk/client-eks"; // ES Modules import + * // const { EKSClient, CreateNodegroupCommand } = require("@aws-sdk/client-eks"); // CommonJS import + * const client = new EKSClient(config); + * const command = new CreateNodegroupCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreateNodegroupCommandInput} for command's `input` shape. + * @see {@link CreateNodegroupCommandOutput} for command's `response` shape. + * @see {@link EKSClientResolvedConfig | config} for command's `input` shape. + * */ export class CreateNodegroupCommand extends $Command< CreateNodegroupCommandInput, diff --git a/clients/client-eks/commands/DeleteAddonCommand.ts b/clients/client-eks/commands/DeleteAddonCommand.ts index e2696f1dcec6..62c8334bc40b 100644 --- a/clients/client-eks/commands/DeleteAddonCommand.ts +++ b/clients/client-eks/commands/DeleteAddonCommand.ts @@ -24,6 +24,20 @@ export interface DeleteAddonCommandOutput extends DeleteAddonResponse, __Metadat *

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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { EKSClient, DeleteAddonCommand } from "@aws-sdk/client-eks"; // ES Modules import + * // const { EKSClient, DeleteAddonCommand } = require("@aws-sdk/client-eks"); // CommonJS import + * const client = new EKSClient(config); + * const command = new DeleteAddonCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteAddonCommandInput} for command's `input` shape. + * @see {@link DeleteAddonCommandOutput} for command's `response` shape. + * @see {@link EKSClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteAddonCommand extends $Command< DeleteAddonCommandInput, diff --git a/clients/client-eks/commands/DeleteClusterCommand.ts b/clients/client-eks/commands/DeleteClusterCommand.ts index 94b3fff5f47a..8ba9b4a415db 100644 --- a/clients/client-eks/commands/DeleteClusterCommand.ts +++ b/clients/client-eks/commands/DeleteClusterCommand.ts @@ -29,6 +29,20 @@ export interface DeleteClusterCommandOutput extends DeleteClusterResponse, __Met * 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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { EKSClient, DeleteClusterCommand } from "@aws-sdk/client-eks"; // ES Modules import + * // const { EKSClient, DeleteClusterCommand } = require("@aws-sdk/client-eks"); // CommonJS import + * const client = new EKSClient(config); + * const command = new DeleteClusterCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteClusterCommandInput} for command's `input` shape. + * @see {@link DeleteClusterCommandOutput} for command's `response` shape. + * @see {@link EKSClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteClusterCommand extends $Command< DeleteClusterCommandInput, diff --git a/clients/client-eks/commands/DeleteFargateProfileCommand.ts b/clients/client-eks/commands/DeleteFargateProfileCommand.ts index 12dc62bd1f6e..094706719a20 100644 --- a/clients/client-eks/commands/DeleteFargateProfileCommand.ts +++ b/clients/client-eks/commands/DeleteFargateProfileCommand.ts @@ -29,6 +29,20 @@ export interface DeleteFargateProfileCommandOutput extends DeleteFargateProfileR *

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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { EKSClient, DeleteFargateProfileCommand } from "@aws-sdk/client-eks"; // ES Modules import + * // const { EKSClient, DeleteFargateProfileCommand } = require("@aws-sdk/client-eks"); // CommonJS import + * const client = new EKSClient(config); + * const command = new DeleteFargateProfileCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteFargateProfileCommandInput} for command's `input` shape. + * @see {@link DeleteFargateProfileCommandOutput} for command's `response` shape. + * @see {@link EKSClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteFargateProfileCommand extends $Command< DeleteFargateProfileCommandInput, diff --git a/clients/client-eks/commands/DeleteNodegroupCommand.ts b/clients/client-eks/commands/DeleteNodegroupCommand.ts index b41f3a7f214d..119b82c64f9c 100644 --- a/clients/client-eks/commands/DeleteNodegroupCommand.ts +++ b/clients/client-eks/commands/DeleteNodegroupCommand.ts @@ -22,6 +22,20 @@ export interface DeleteNodegroupCommandOutput extends DeleteNodegroupResponse, _ /** *

Deletes an Amazon EKS node group for a cluster.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { EKSClient, DeleteNodegroupCommand } from "@aws-sdk/client-eks"; // ES Modules import + * // const { EKSClient, DeleteNodegroupCommand } = require("@aws-sdk/client-eks"); // CommonJS import + * const client = new EKSClient(config); + * const command = new DeleteNodegroupCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteNodegroupCommandInput} for command's `input` shape. + * @see {@link DeleteNodegroupCommandOutput} for command's `response` shape. + * @see {@link EKSClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteNodegroupCommand extends $Command< DeleteNodegroupCommandInput, diff --git a/clients/client-eks/commands/DescribeAddonCommand.ts b/clients/client-eks/commands/DescribeAddonCommand.ts index 101a3ffc4338..2b02dc13cf54 100644 --- a/clients/client-eks/commands/DescribeAddonCommand.ts +++ b/clients/client-eks/commands/DescribeAddonCommand.ts @@ -22,6 +22,20 @@ export interface DescribeAddonCommandOutput extends DescribeAddonResponse, __Met /** *

Describes an Amazon EKS add-on.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { EKSClient, DescribeAddonCommand } from "@aws-sdk/client-eks"; // ES Modules import + * // const { EKSClient, DescribeAddonCommand } = require("@aws-sdk/client-eks"); // CommonJS import + * const client = new EKSClient(config); + * const command = new DescribeAddonCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeAddonCommandInput} for command's `input` shape. + * @see {@link DescribeAddonCommandOutput} for command's `response` shape. + * @see {@link EKSClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeAddonCommand extends $Command< DescribeAddonCommandInput, diff --git a/clients/client-eks/commands/DescribeAddonVersionsCommand.ts b/clients/client-eks/commands/DescribeAddonVersionsCommand.ts index ca2034f9a62b..840c876c6112 100644 --- a/clients/client-eks/commands/DescribeAddonVersionsCommand.ts +++ b/clients/client-eks/commands/DescribeAddonVersionsCommand.ts @@ -22,6 +22,20 @@ export interface DescribeAddonVersionsCommandOutput extends DescribeAddonVersion /** *

Describes the Kubernetes versions that the add-on can be used with.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { EKSClient, DescribeAddonVersionsCommand } from "@aws-sdk/client-eks"; // ES Modules import + * // const { EKSClient, DescribeAddonVersionsCommand } = require("@aws-sdk/client-eks"); // CommonJS import + * const client = new EKSClient(config); + * const command = new DescribeAddonVersionsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeAddonVersionsCommandInput} for command's `input` shape. + * @see {@link DescribeAddonVersionsCommandOutput} for command's `response` shape. + * @see {@link EKSClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeAddonVersionsCommand extends $Command< DescribeAddonVersionsCommandInput, diff --git a/clients/client-eks/commands/DescribeClusterCommand.ts b/clients/client-eks/commands/DescribeClusterCommand.ts index 07c64859a9c0..e9474288a9ee 100644 --- a/clients/client-eks/commands/DescribeClusterCommand.ts +++ b/clients/client-eks/commands/DescribeClusterCommand.ts @@ -30,6 +30,20 @@ export interface DescribeClusterCommandOutput extends DescribeClusterResponse, _ *

The API server endpoint and certificate authority data aren't available until the * cluster reaches the ACTIVE state.

* + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { EKSClient, DescribeClusterCommand } from "@aws-sdk/client-eks"; // ES Modules import + * // const { EKSClient, DescribeClusterCommand } = require("@aws-sdk/client-eks"); // CommonJS import + * const client = new EKSClient(config); + * const command = new DescribeClusterCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeClusterCommandInput} for command's `input` shape. + * @see {@link DescribeClusterCommandOutput} for command's `response` shape. + * @see {@link EKSClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeClusterCommand extends $Command< DescribeClusterCommandInput, diff --git a/clients/client-eks/commands/DescribeFargateProfileCommand.ts b/clients/client-eks/commands/DescribeFargateProfileCommand.ts index a849656fc7ff..d280f6b2423c 100644 --- a/clients/client-eks/commands/DescribeFargateProfileCommand.ts +++ b/clients/client-eks/commands/DescribeFargateProfileCommand.ts @@ -22,6 +22,20 @@ export interface DescribeFargateProfileCommandOutput extends DescribeFargateProf /** *

Returns descriptive information about an AWS Fargate profile.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { EKSClient, DescribeFargateProfileCommand } from "@aws-sdk/client-eks"; // ES Modules import + * // const { EKSClient, DescribeFargateProfileCommand } = require("@aws-sdk/client-eks"); // CommonJS import + * const client = new EKSClient(config); + * const command = new DescribeFargateProfileCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeFargateProfileCommandInput} for command's `input` shape. + * @see {@link DescribeFargateProfileCommandOutput} for command's `response` shape. + * @see {@link EKSClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeFargateProfileCommand extends $Command< DescribeFargateProfileCommandInput, diff --git a/clients/client-eks/commands/DescribeIdentityProviderConfigCommand.ts b/clients/client-eks/commands/DescribeIdentityProviderConfigCommand.ts index 075a85d5c966..0522987d5edf 100644 --- a/clients/client-eks/commands/DescribeIdentityProviderConfigCommand.ts +++ b/clients/client-eks/commands/DescribeIdentityProviderConfigCommand.ts @@ -24,6 +24,20 @@ export interface DescribeIdentityProviderConfigCommandOutput /** *

Returns descriptive information about an identity provider configuration.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { EKSClient, DescribeIdentityProviderConfigCommand } from "@aws-sdk/client-eks"; // ES Modules import + * // const { EKSClient, DescribeIdentityProviderConfigCommand } = require("@aws-sdk/client-eks"); // CommonJS import + * const client = new EKSClient(config); + * const command = new DescribeIdentityProviderConfigCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeIdentityProviderConfigCommandInput} for command's `input` shape. + * @see {@link DescribeIdentityProviderConfigCommandOutput} for command's `response` shape. + * @see {@link EKSClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeIdentityProviderConfigCommand extends $Command< DescribeIdentityProviderConfigCommandInput, diff --git a/clients/client-eks/commands/DescribeNodegroupCommand.ts b/clients/client-eks/commands/DescribeNodegroupCommand.ts index 0c65544c4db1..ad16733117d4 100644 --- a/clients/client-eks/commands/DescribeNodegroupCommand.ts +++ b/clients/client-eks/commands/DescribeNodegroupCommand.ts @@ -22,6 +22,20 @@ export interface DescribeNodegroupCommandOutput extends DescribeNodegroupRespons /** *

Returns descriptive information about an Amazon EKS node group.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { EKSClient, DescribeNodegroupCommand } from "@aws-sdk/client-eks"; // ES Modules import + * // const { EKSClient, DescribeNodegroupCommand } = require("@aws-sdk/client-eks"); // CommonJS import + * const client = new EKSClient(config); + * const command = new DescribeNodegroupCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeNodegroupCommandInput} for command's `input` shape. + * @see {@link DescribeNodegroupCommandOutput} for command's `response` shape. + * @see {@link EKSClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeNodegroupCommand extends $Command< DescribeNodegroupCommandInput, diff --git a/clients/client-eks/commands/DescribeUpdateCommand.ts b/clients/client-eks/commands/DescribeUpdateCommand.ts index 6d6bf5d5f3c2..eb56bc0da125 100644 --- a/clients/client-eks/commands/DescribeUpdateCommand.ts +++ b/clients/client-eks/commands/DescribeUpdateCommand.ts @@ -26,6 +26,20 @@ export interface DescribeUpdateCommandOutput extends DescribeUpdateResponse, __M *

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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { EKSClient, DescribeUpdateCommand } from "@aws-sdk/client-eks"; // ES Modules import + * // const { EKSClient, DescribeUpdateCommand } = require("@aws-sdk/client-eks"); // CommonJS import + * const client = new EKSClient(config); + * const command = new DescribeUpdateCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeUpdateCommandInput} for command's `input` shape. + * @see {@link DescribeUpdateCommandOutput} for command's `response` shape. + * @see {@link EKSClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeUpdateCommand extends $Command< DescribeUpdateCommandInput, diff --git a/clients/client-eks/commands/DisassociateIdentityProviderConfigCommand.ts b/clients/client-eks/commands/DisassociateIdentityProviderConfigCommand.ts index 278563204e6a..aeed8dced7d4 100644 --- a/clients/client-eks/commands/DisassociateIdentityProviderConfigCommand.ts +++ b/clients/client-eks/commands/DisassociateIdentityProviderConfigCommand.ts @@ -30,6 +30,20 @@ export interface DisassociateIdentityProviderConfigCommandOutput * 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 AWS IAM * users.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { EKSClient, DisassociateIdentityProviderConfigCommand } from "@aws-sdk/client-eks"; // ES Modules import + * // const { EKSClient, DisassociateIdentityProviderConfigCommand } = require("@aws-sdk/client-eks"); // CommonJS import + * const client = new EKSClient(config); + * const command = new DisassociateIdentityProviderConfigCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DisassociateIdentityProviderConfigCommandInput} for command's `input` shape. + * @see {@link DisassociateIdentityProviderConfigCommandOutput} for command's `response` shape. + * @see {@link EKSClientResolvedConfig | config} for command's `input` shape. + * */ export class DisassociateIdentityProviderConfigCommand extends $Command< DisassociateIdentityProviderConfigCommandInput, diff --git a/clients/client-eks/commands/ListAddonsCommand.ts b/clients/client-eks/commands/ListAddonsCommand.ts index d1e5935945e0..cfa094eb8dda 100644 --- a/clients/client-eks/commands/ListAddonsCommand.ts +++ b/clients/client-eks/commands/ListAddonsCommand.ts @@ -22,6 +22,20 @@ export interface ListAddonsCommandOutput extends ListAddonsResponse, __MetadataB /** *

Lists the available add-ons.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { EKSClient, ListAddonsCommand } from "@aws-sdk/client-eks"; // ES Modules import + * // const { EKSClient, ListAddonsCommand } = require("@aws-sdk/client-eks"); // CommonJS import + * const client = new EKSClient(config); + * const command = new ListAddonsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListAddonsCommandInput} for command's `input` shape. + * @see {@link ListAddonsCommandOutput} for command's `response` shape. + * @see {@link EKSClientResolvedConfig | config} for command's `input` shape. + * */ export class ListAddonsCommand extends $Command< ListAddonsCommandInput, diff --git a/clients/client-eks/commands/ListClustersCommand.ts b/clients/client-eks/commands/ListClustersCommand.ts index 297c0651baca..05da26693c58 100644 --- a/clients/client-eks/commands/ListClustersCommand.ts +++ b/clients/client-eks/commands/ListClustersCommand.ts @@ -22,6 +22,20 @@ export interface ListClustersCommandOutput extends ListClustersResponse, __Metad /** *

Lists the Amazon EKS clusters in your AWS account in the specified Region.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { EKSClient, ListClustersCommand } from "@aws-sdk/client-eks"; // ES Modules import + * // const { EKSClient, ListClustersCommand } = require("@aws-sdk/client-eks"); // CommonJS import + * const client = new EKSClient(config); + * const command = new ListClustersCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListClustersCommandInput} for command's `input` shape. + * @see {@link ListClustersCommandOutput} for command's `response` shape. + * @see {@link EKSClientResolvedConfig | config} for command's `input` shape. + * */ export class ListClustersCommand extends $Command< ListClustersCommandInput, diff --git a/clients/client-eks/commands/ListFargateProfilesCommand.ts b/clients/client-eks/commands/ListFargateProfilesCommand.ts index ecff2810f190..f5e38d8bea70 100644 --- a/clients/client-eks/commands/ListFargateProfilesCommand.ts +++ b/clients/client-eks/commands/ListFargateProfilesCommand.ts @@ -23,6 +23,20 @@ export interface ListFargateProfilesCommandOutput extends ListFargateProfilesRes /** *

Lists the AWS Fargate profiles associated with the specified cluster in your AWS * account in the specified Region.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { EKSClient, ListFargateProfilesCommand } from "@aws-sdk/client-eks"; // ES Modules import + * // const { EKSClient, ListFargateProfilesCommand } = require("@aws-sdk/client-eks"); // CommonJS import + * const client = new EKSClient(config); + * const command = new ListFargateProfilesCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListFargateProfilesCommandInput} for command's `input` shape. + * @see {@link ListFargateProfilesCommandOutput} for command's `response` shape. + * @see {@link EKSClientResolvedConfig | config} for command's `input` shape. + * */ export class ListFargateProfilesCommand extends $Command< ListFargateProfilesCommandInput, diff --git a/clients/client-eks/commands/ListIdentityProviderConfigsCommand.ts b/clients/client-eks/commands/ListIdentityProviderConfigsCommand.ts index 86d099d543e1..7bfe0833cca5 100644 --- a/clients/client-eks/commands/ListIdentityProviderConfigsCommand.ts +++ b/clients/client-eks/commands/ListIdentityProviderConfigsCommand.ts @@ -24,6 +24,20 @@ export interface ListIdentityProviderConfigsCommandOutput /** *

A list of identity provider configurations.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { EKSClient, ListIdentityProviderConfigsCommand } from "@aws-sdk/client-eks"; // ES Modules import + * // const { EKSClient, ListIdentityProviderConfigsCommand } = require("@aws-sdk/client-eks"); // CommonJS import + * const client = new EKSClient(config); + * const command = new ListIdentityProviderConfigsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListIdentityProviderConfigsCommandInput} for command's `input` shape. + * @see {@link ListIdentityProviderConfigsCommandOutput} for command's `response` shape. + * @see {@link EKSClientResolvedConfig | config} for command's `input` shape. + * */ export class ListIdentityProviderConfigsCommand extends $Command< ListIdentityProviderConfigsCommandInput, diff --git a/clients/client-eks/commands/ListNodegroupsCommand.ts b/clients/client-eks/commands/ListNodegroupsCommand.ts index 1a86b3de9eca..29f5c2bae2ba 100644 --- a/clients/client-eks/commands/ListNodegroupsCommand.ts +++ b/clients/client-eks/commands/ListNodegroupsCommand.ts @@ -23,6 +23,20 @@ export interface ListNodegroupsCommandOutput extends ListNodegroupsResponse, __M /** *

Lists the Amazon EKS managed node groups associated with the specified cluster in your * AWS account in the specified Region. Self-managed node groups are not listed.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { EKSClient, ListNodegroupsCommand } from "@aws-sdk/client-eks"; // ES Modules import + * // const { EKSClient, ListNodegroupsCommand } = require("@aws-sdk/client-eks"); // CommonJS import + * const client = new EKSClient(config); + * const command = new ListNodegroupsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListNodegroupsCommandInput} for command's `input` shape. + * @see {@link ListNodegroupsCommandOutput} for command's `response` shape. + * @see {@link EKSClientResolvedConfig | config} for command's `input` shape. + * */ export class ListNodegroupsCommand extends $Command< ListNodegroupsCommandInput, diff --git a/clients/client-eks/commands/ListTagsForResourceCommand.ts b/clients/client-eks/commands/ListTagsForResourceCommand.ts index a14da4922316..06b1423714bd 100644 --- a/clients/client-eks/commands/ListTagsForResourceCommand.ts +++ b/clients/client-eks/commands/ListTagsForResourceCommand.ts @@ -22,6 +22,20 @@ export interface ListTagsForResourceCommandOutput extends ListTagsForResourceRes /** *

List the tags for an Amazon EKS resource.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { EKSClient, ListTagsForResourceCommand } from "@aws-sdk/client-eks"; // ES Modules import + * // const { EKSClient, ListTagsForResourceCommand } = require("@aws-sdk/client-eks"); // CommonJS import + * const client = new EKSClient(config); + * const command = new ListTagsForResourceCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListTagsForResourceCommandInput} for command's `input` shape. + * @see {@link ListTagsForResourceCommandOutput} for command's `response` shape. + * @see {@link EKSClientResolvedConfig | config} for command's `input` shape. + * */ export class ListTagsForResourceCommand extends $Command< ListTagsForResourceCommandInput, diff --git a/clients/client-eks/commands/ListUpdatesCommand.ts b/clients/client-eks/commands/ListUpdatesCommand.ts index a2c7640a9286..1e476d20717a 100644 --- a/clients/client-eks/commands/ListUpdatesCommand.ts +++ b/clients/client-eks/commands/ListUpdatesCommand.ts @@ -23,6 +23,20 @@ export interface ListUpdatesCommandOutput extends ListUpdatesResponse, __Metadat /** *

Lists the updates associated with an Amazon EKS cluster or managed node group in your AWS * account, in the specified Region.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { EKSClient, ListUpdatesCommand } from "@aws-sdk/client-eks"; // ES Modules import + * // const { EKSClient, ListUpdatesCommand } = require("@aws-sdk/client-eks"); // CommonJS import + * const client = new EKSClient(config); + * const command = new ListUpdatesCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListUpdatesCommandInput} for command's `input` shape. + * @see {@link ListUpdatesCommandOutput} for command's `response` shape. + * @see {@link EKSClientResolvedConfig | config} for command's `input` shape. + * */ export class ListUpdatesCommand extends $Command< ListUpdatesCommandInput, diff --git a/clients/client-eks/commands/TagResourceCommand.ts b/clients/client-eks/commands/TagResourceCommand.ts index 40ca722c43e5..3dd45894b189 100644 --- a/clients/client-eks/commands/TagResourceCommand.ts +++ b/clients/client-eks/commands/TagResourceCommand.ts @@ -28,6 +28,20 @@ export interface TagResourceCommandOutput extends TagResourceResponse, __Metadat * 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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { EKSClient, TagResourceCommand } from "@aws-sdk/client-eks"; // ES Modules import + * // const { EKSClient, TagResourceCommand } = require("@aws-sdk/client-eks"); // CommonJS import + * const client = new EKSClient(config); + * const command = new TagResourceCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link TagResourceCommandInput} for command's `input` shape. + * @see {@link TagResourceCommandOutput} for command's `response` shape. + * @see {@link EKSClientResolvedConfig | config} for command's `input` shape. + * */ export class TagResourceCommand extends $Command< TagResourceCommandInput, diff --git a/clients/client-eks/commands/UntagResourceCommand.ts b/clients/client-eks/commands/UntagResourceCommand.ts index 8053311d3a59..992d8048749b 100644 --- a/clients/client-eks/commands/UntagResourceCommand.ts +++ b/clients/client-eks/commands/UntagResourceCommand.ts @@ -22,6 +22,20 @@ export interface UntagResourceCommandOutput extends UntagResourceResponse, __Met /** *

Deletes specified tags from a resource.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { EKSClient, UntagResourceCommand } from "@aws-sdk/client-eks"; // ES Modules import + * // const { EKSClient, UntagResourceCommand } = require("@aws-sdk/client-eks"); // CommonJS import + * const client = new EKSClient(config); + * const command = new UntagResourceCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link UntagResourceCommandInput} for command's `input` shape. + * @see {@link UntagResourceCommandOutput} for command's `response` shape. + * @see {@link EKSClientResolvedConfig | config} for command's `input` shape. + * */ export class UntagResourceCommand extends $Command< UntagResourceCommandInput, diff --git a/clients/client-eks/commands/UpdateAddonCommand.ts b/clients/client-eks/commands/UpdateAddonCommand.ts index ed19cb2fd771..247989874812 100644 --- a/clients/client-eks/commands/UpdateAddonCommand.ts +++ b/clients/client-eks/commands/UpdateAddonCommand.ts @@ -22,6 +22,20 @@ export interface UpdateAddonCommandOutput extends UpdateAddonResponse, __Metadat /** *

Updates an Amazon EKS add-on.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { EKSClient, UpdateAddonCommand } from "@aws-sdk/client-eks"; // ES Modules import + * // const { EKSClient, UpdateAddonCommand } = require("@aws-sdk/client-eks"); // CommonJS import + * const client = new EKSClient(config); + * const command = new UpdateAddonCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link UpdateAddonCommandInput} for command's `input` shape. + * @see {@link UpdateAddonCommandOutput} for command's `response` shape. + * @see {@link EKSClientResolvedConfig | config} for command's `input` shape. + * */ export class UpdateAddonCommand extends $Command< UpdateAddonCommandInput, diff --git a/clients/client-eks/commands/UpdateClusterConfigCommand.ts b/clients/client-eks/commands/UpdateClusterConfigCommand.ts index d50822fe3771..8a9e193326f7 100644 --- a/clients/client-eks/commands/UpdateClusterConfigCommand.ts +++ b/clients/client-eks/commands/UpdateClusterConfigCommand.ts @@ -49,6 +49,20 @@ export interface UpdateClusterConfigCommandOutput extends UpdateClusterConfigRes * 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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { EKSClient, UpdateClusterConfigCommand } from "@aws-sdk/client-eks"; // ES Modules import + * // const { EKSClient, UpdateClusterConfigCommand } = require("@aws-sdk/client-eks"); // CommonJS import + * const client = new EKSClient(config); + * const command = new UpdateClusterConfigCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link UpdateClusterConfigCommandInput} for command's `input` shape. + * @see {@link UpdateClusterConfigCommandOutput} for command's `response` shape. + * @see {@link EKSClientResolvedConfig | config} for command's `input` shape. + * */ export class UpdateClusterConfigCommand extends $Command< UpdateClusterConfigCommandInput, diff --git a/clients/client-eks/commands/UpdateClusterVersionCommand.ts b/clients/client-eks/commands/UpdateClusterVersionCommand.ts index ed6393779392..177aee62505c 100644 --- a/clients/client-eks/commands/UpdateClusterVersionCommand.ts +++ b/clients/client-eks/commands/UpdateClusterVersionCommand.ts @@ -32,6 +32,20 @@ export interface UpdateClusterVersionCommandOutput extends UpdateClusterVersionR *

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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { EKSClient, UpdateClusterVersionCommand } from "@aws-sdk/client-eks"; // ES Modules import + * // const { EKSClient, UpdateClusterVersionCommand } = require("@aws-sdk/client-eks"); // CommonJS import + * const client = new EKSClient(config); + * const command = new UpdateClusterVersionCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link UpdateClusterVersionCommandInput} for command's `input` shape. + * @see {@link UpdateClusterVersionCommandOutput} for command's `response` shape. + * @see {@link EKSClientResolvedConfig | config} for command's `input` shape. + * */ export class UpdateClusterVersionCommand extends $Command< UpdateClusterVersionCommandInput, diff --git a/clients/client-eks/commands/UpdateNodegroupConfigCommand.ts b/clients/client-eks/commands/UpdateNodegroupConfigCommand.ts index ab101a6953c0..fcc76e3f3ba8 100644 --- a/clients/client-eks/commands/UpdateNodegroupConfigCommand.ts +++ b/clients/client-eks/commands/UpdateNodegroupConfigCommand.ts @@ -26,6 +26,20 @@ export interface UpdateNodegroupConfigCommandOutput extends UpdateNodegroupConfi * 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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { EKSClient, UpdateNodegroupConfigCommand } from "@aws-sdk/client-eks"; // ES Modules import + * // const { EKSClient, UpdateNodegroupConfigCommand } = require("@aws-sdk/client-eks"); // CommonJS import + * const client = new EKSClient(config); + * const command = new UpdateNodegroupConfigCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link UpdateNodegroupConfigCommandInput} for command's `input` shape. + * @see {@link UpdateNodegroupConfigCommandOutput} for command's `response` shape. + * @see {@link EKSClientResolvedConfig | config} for command's `input` shape. + * */ export class UpdateNodegroupConfigCommand extends $Command< UpdateNodegroupConfigCommandInput, diff --git a/clients/client-eks/commands/UpdateNodegroupVersionCommand.ts b/clients/client-eks/commands/UpdateNodegroupVersionCommand.ts index 1ea646b7c137..07dd5dff6d62 100644 --- a/clients/client-eks/commands/UpdateNodegroupVersionCommand.ts +++ b/clients/client-eks/commands/UpdateNodegroupVersionCommand.ts @@ -39,6 +39,20 @@ export interface UpdateNodegroupVersionCommandOutput extends UpdateNodegroupVers * 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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { EKSClient, UpdateNodegroupVersionCommand } from "@aws-sdk/client-eks"; // ES Modules import + * // const { EKSClient, UpdateNodegroupVersionCommand } = require("@aws-sdk/client-eks"); // CommonJS import + * const client = new EKSClient(config); + * const command = new UpdateNodegroupVersionCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link UpdateNodegroupVersionCommandInput} for command's `input` shape. + * @see {@link UpdateNodegroupVersionCommandOutput} for command's `response` shape. + * @see {@link EKSClientResolvedConfig | config} for command's `input` shape. + * */ export class UpdateNodegroupVersionCommand extends $Command< UpdateNodegroupVersionCommandInput, diff --git a/clients/client-eks/models/models_0.ts b/clients/client-eks/models/models_0.ts index 89419863fabc..1b3c601d86c0 100644 --- a/clients/client-eks/models/models_0.ts +++ b/clients/client-eks/models/models_0.ts @@ -31,6 +31,9 @@ export interface AddonIssue { } export namespace AddonIssue { + /** + * @internal + */ export const filterSensitiveLog = (obj: AddonIssue): any => ({ ...obj, }); @@ -47,6 +50,9 @@ export interface AddonHealth { } export namespace AddonHealth { + /** + * @internal + */ export const filterSensitiveLog = (obj: AddonHealth): any => ({ ...obj, }); @@ -121,6 +127,9 @@ export interface Addon { } export namespace Addon { + /** + * @internal + */ export const filterSensitiveLog = (obj: Addon): any => ({ ...obj, }); @@ -147,6 +156,9 @@ export interface Compatibility { } export namespace Compatibility { + /** + * @internal + */ export const filterSensitiveLog = (obj: Compatibility): any => ({ ...obj, }); @@ -173,6 +185,9 @@ export interface AddonVersionInfo { } export namespace AddonVersionInfo { + /** + * @internal + */ export const filterSensitiveLog = (obj: AddonVersionInfo): any => ({ ...obj, }); @@ -200,6 +215,9 @@ export interface AddonInfo { } export namespace AddonInfo { + /** + * @internal + */ export const filterSensitiveLog = (obj: AddonInfo): any => ({ ...obj, }); @@ -223,6 +241,9 @@ export interface Provider { } export namespace Provider { + /** + * @internal + */ export const filterSensitiveLog = (obj: Provider): any => ({ ...obj, }); @@ -245,6 +266,9 @@ export interface EncryptionConfig { } export namespace EncryptionConfig { + /** + * @internal + */ export const filterSensitiveLog = (obj: EncryptionConfig): any => ({ ...obj, }); @@ -268,6 +292,9 @@ export interface AssociateEncryptionConfigRequest { } export namespace AssociateEncryptionConfigRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: AssociateEncryptionConfigRequest): any => ({ ...obj, }); @@ -350,6 +377,9 @@ export interface ErrorDetail { } export namespace ErrorDetail { + /** + * @internal + */ export const filterSensitiveLog = (obj: ErrorDetail): any => ({ ...obj, }); @@ -393,6 +423,9 @@ export interface UpdateParam { } export namespace UpdateParam { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateParam): any => ({ ...obj, }); @@ -452,6 +485,9 @@ export interface Update { } export namespace Update { + /** + * @internal + */ export const filterSensitiveLog = (obj: Update): any => ({ ...obj, }); @@ -465,6 +501,9 @@ export interface AssociateEncryptionConfigResponse { } export namespace AssociateEncryptionConfigResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: AssociateEncryptionConfigResponse): any => ({ ...obj, }); @@ -493,6 +532,9 @@ export interface ClientException extends __SmithyException, $MetadataBearer { } export namespace ClientException { + /** + * @internal + */ export const filterSensitiveLog = (obj: ClientException): any => ({ ...obj, }); @@ -525,6 +567,9 @@ export interface InvalidParameterException extends __SmithyException, $MetadataB } export namespace InvalidParameterException { + /** + * @internal + */ export const filterSensitiveLog = (obj: InvalidParameterException): any => ({ ...obj, }); @@ -552,6 +597,9 @@ export interface InvalidRequestException extends __SmithyException, $MetadataBea } export namespace InvalidRequestException { + /** + * @internal + */ export const filterSensitiveLog = (obj: InvalidRequestException): any => ({ ...obj, }); @@ -578,6 +626,9 @@ export interface ResourceInUseException extends __SmithyException, $MetadataBear } export namespace ResourceInUseException { + /** + * @internal + */ export const filterSensitiveLog = (obj: ResourceInUseException): any => ({ ...obj, }); @@ -612,6 +663,9 @@ export interface ResourceNotFoundException extends __SmithyException, $MetadataB } export namespace ResourceNotFoundException { + /** + * @internal + */ export const filterSensitiveLog = (obj: ResourceNotFoundException): any => ({ ...obj, }); @@ -638,6 +692,9 @@ export interface ServerException extends __SmithyException, $MetadataBearer { } export namespace ServerException { + /** + * @internal + */ export const filterSensitiveLog = (obj: ServerException): any => ({ ...obj, }); @@ -713,6 +770,9 @@ export interface OidcIdentityProviderConfigRequest { } export namespace OidcIdentityProviderConfigRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: OidcIdentityProviderConfigRequest): any => ({ ...obj, }); @@ -745,6 +805,9 @@ export interface AssociateIdentityProviderConfigRequest { } export namespace AssociateIdentityProviderConfigRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: AssociateIdentityProviderConfigRequest): any => ({ ...obj, }); @@ -763,6 +826,9 @@ export interface AssociateIdentityProviderConfigResponse { } export namespace AssociateIdentityProviderConfigResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: AssociateIdentityProviderConfigResponse): any => ({ ...obj, }); @@ -779,6 +845,9 @@ export interface AutoScalingGroup { } export namespace AutoScalingGroup { + /** + * @internal + */ export const filterSensitiveLog = (obj: AutoScalingGroup): any => ({ ...obj, }); @@ -838,6 +907,9 @@ export interface CreateAddonRequest { } export namespace CreateAddonRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateAddonRequest): any => ({ ...obj, }); @@ -851,6 +923,9 @@ export interface CreateAddonResponse { } export namespace CreateAddonResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateAddonResponse): any => ({ ...obj, }); @@ -888,6 +963,9 @@ export interface KubernetesNetworkConfigRequest { } export namespace KubernetesNetworkConfigRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: KubernetesNetworkConfigRequest): any => ({ ...obj, }); @@ -920,6 +998,9 @@ export interface LogSetup { } export namespace LogSetup { + /** + * @internal + */ export const filterSensitiveLog = (obj: LogSetup): any => ({ ...obj, }); @@ -936,6 +1017,9 @@ export interface Logging { } export namespace Logging { + /** + * @internal + */ export const filterSensitiveLog = (obj: Logging): any => ({ ...obj, }); @@ -1012,6 +1096,9 @@ export interface VpcConfigRequest { } export namespace VpcConfigRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: VpcConfigRequest): any => ({ ...obj, }); @@ -1087,6 +1174,9 @@ export interface CreateClusterRequest { } export namespace CreateClusterRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateClusterRequest): any => ({ ...obj, }); @@ -1106,6 +1196,9 @@ export interface Certificate { } export namespace Certificate { + /** + * @internal + */ export const filterSensitiveLog = (obj: Certificate): any => ({ ...obj, }); @@ -1123,6 +1216,9 @@ export interface OIDC { } export namespace OIDC { + /** + * @internal + */ export const filterSensitiveLog = (obj: OIDC): any => ({ ...obj, }); @@ -1140,6 +1236,9 @@ export interface Identity { } export namespace Identity { + /** + * @internal + */ export const filterSensitiveLog = (obj: Identity): any => ({ ...obj, }); @@ -1159,6 +1258,9 @@ export interface KubernetesNetworkConfigResponse { } export namespace KubernetesNetworkConfigResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: KubernetesNetworkConfigResponse): any => ({ ...obj, }); @@ -1225,6 +1327,9 @@ export interface VpcConfigResponse { } export namespace VpcConfigResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: VpcConfigResponse): any => ({ ...obj, }); @@ -1329,6 +1434,9 @@ export interface Cluster { } export namespace Cluster { + /** + * @internal + */ export const filterSensitiveLog = (obj: Cluster): any => ({ ...obj, }); @@ -1342,6 +1450,9 @@ export interface CreateClusterResponse { } export namespace CreateClusterResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateClusterResponse): any => ({ ...obj, }); @@ -1367,6 +1478,9 @@ export interface ResourceLimitExceededException extends __SmithyException, $Meta } export namespace ResourceLimitExceededException { + /** + * @internal + */ export const filterSensitiveLog = (obj: ResourceLimitExceededException): any => ({ ...obj, }); @@ -1382,6 +1496,9 @@ export interface ServiceUnavailableException extends __SmithyException, $Metadat } export namespace ServiceUnavailableException { + /** + * @internal + */ export const filterSensitiveLog = (obj: ServiceUnavailableException): any => ({ ...obj, }); @@ -1414,6 +1531,9 @@ export interface UnsupportedAvailabilityZoneException extends __SmithyException, } export namespace UnsupportedAvailabilityZoneException { + /** + * @internal + */ export const filterSensitiveLog = (obj: UnsupportedAvailabilityZoneException): any => ({ ...obj, }); @@ -1436,6 +1556,9 @@ export interface FargateProfileSelector { } export namespace FargateProfileSelector { + /** + * @internal + */ export const filterSensitiveLog = (obj: FargateProfileSelector): any => ({ ...obj, }); @@ -1491,6 +1614,9 @@ export interface CreateFargateProfileRequest { } export namespace CreateFargateProfileRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateFargateProfileRequest): any => ({ ...obj, }); @@ -1554,6 +1680,9 @@ export interface FargateProfile { } export namespace FargateProfile { + /** + * @internal + */ export const filterSensitiveLog = (obj: FargateProfile): any => ({ ...obj, }); @@ -1567,6 +1696,9 @@ export interface CreateFargateProfileResponse { } export namespace CreateFargateProfileResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateFargateProfileResponse): any => ({ ...obj, }); @@ -1612,6 +1744,9 @@ export interface LaunchTemplateSpecification { } export namespace LaunchTemplateSpecification { + /** + * @internal + */ export const filterSensitiveLog = (obj: LaunchTemplateSpecification): any => ({ ...obj, }); @@ -1640,6 +1775,9 @@ export interface RemoteAccessConfig { } export namespace RemoteAccessConfig { + /** + * @internal + */ export const filterSensitiveLog = (obj: RemoteAccessConfig): any => ({ ...obj, }); @@ -1671,6 +1809,9 @@ export interface NodegroupScalingConfig { } export namespace NodegroupScalingConfig { + /** + * @internal + */ export const filterSensitiveLog = (obj: NodegroupScalingConfig): any => ({ ...obj, }); @@ -1812,6 +1953,9 @@ export interface CreateNodegroupRequest { } export namespace CreateNodegroupRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateNodegroupRequest): any => ({ ...obj, }); @@ -1956,6 +2100,9 @@ export interface Issue { } export namespace Issue { + /** + * @internal + */ export const filterSensitiveLog = (obj: Issue): any => ({ ...obj, }); @@ -1972,6 +2119,9 @@ export interface NodegroupHealth { } export namespace NodegroupHealth { + /** + * @internal + */ export const filterSensitiveLog = (obj: NodegroupHealth): any => ({ ...obj, }); @@ -1995,6 +2145,9 @@ export interface NodegroupResources { } export namespace NodegroupResources { + /** + * @internal + */ export const filterSensitiveLog = (obj: NodegroupResources): any => ({ ...obj, }); @@ -2147,6 +2300,9 @@ export interface Nodegroup { } export namespace Nodegroup { + /** + * @internal + */ export const filterSensitiveLog = (obj: Nodegroup): any => ({ ...obj, }); @@ -2160,6 +2316,9 @@ export interface CreateNodegroupResponse { } export namespace CreateNodegroupResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateNodegroupResponse): any => ({ ...obj, }); @@ -2180,6 +2339,9 @@ export interface DeleteAddonRequest { } export namespace DeleteAddonRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteAddonRequest): any => ({ ...obj, }); @@ -2193,6 +2355,9 @@ export interface DeleteAddonResponse { } export namespace DeleteAddonResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteAddonResponse): any => ({ ...obj, }); @@ -2206,6 +2371,9 @@ export interface DeleteClusterRequest { } export namespace DeleteClusterRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteClusterRequest): any => ({ ...obj, }); @@ -2219,6 +2387,9 @@ export interface DeleteClusterResponse { } export namespace DeleteClusterResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteClusterResponse): any => ({ ...obj, }); @@ -2237,6 +2408,9 @@ export interface DeleteFargateProfileRequest { } export namespace DeleteFargateProfileRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteFargateProfileRequest): any => ({ ...obj, }); @@ -2250,6 +2424,9 @@ export interface DeleteFargateProfileResponse { } export namespace DeleteFargateProfileResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteFargateProfileResponse): any => ({ ...obj, }); @@ -2268,6 +2445,9 @@ export interface DeleteNodegroupRequest { } export namespace DeleteNodegroupRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteNodegroupRequest): any => ({ ...obj, }); @@ -2281,6 +2461,9 @@ export interface DeleteNodegroupResponse { } export namespace DeleteNodegroupResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteNodegroupResponse): any => ({ ...obj, }); @@ -2301,6 +2484,9 @@ export interface DescribeAddonRequest { } export namespace DescribeAddonRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeAddonRequest): any => ({ ...obj, }); @@ -2314,6 +2500,9 @@ export interface DescribeAddonResponse { } export namespace DescribeAddonResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeAddonResponse): any => ({ ...obj, }); @@ -2351,6 +2540,9 @@ export interface DescribeAddonVersionsRequest { } export namespace DescribeAddonVersionsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeAddonVersionsRequest): any => ({ ...obj, }); @@ -2376,6 +2568,9 @@ export interface DescribeAddonVersionsResponse { } export namespace DescribeAddonVersionsResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeAddonVersionsResponse): any => ({ ...obj, }); @@ -2389,6 +2584,9 @@ export interface DescribeClusterRequest { } export namespace DescribeClusterRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeClusterRequest): any => ({ ...obj, }); @@ -2402,6 +2600,9 @@ export interface DescribeClusterResponse { } export namespace DescribeClusterResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeClusterResponse): any => ({ ...obj, }); @@ -2420,6 +2621,9 @@ export interface DescribeFargateProfileRequest { } export namespace DescribeFargateProfileRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeFargateProfileRequest): any => ({ ...obj, }); @@ -2433,6 +2637,9 @@ export interface DescribeFargateProfileResponse { } export namespace DescribeFargateProfileResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeFargateProfileResponse): any => ({ ...obj, }); @@ -2454,6 +2661,9 @@ export interface IdentityProviderConfig { } export namespace IdentityProviderConfig { + /** + * @internal + */ export const filterSensitiveLog = (obj: IdentityProviderConfig): any => ({ ...obj, }); @@ -2472,6 +2682,9 @@ export interface DescribeIdentityProviderConfigRequest { } export namespace DescribeIdentityProviderConfigRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeIdentityProviderConfigRequest): any => ({ ...obj, }); @@ -2561,6 +2774,9 @@ export interface OidcIdentityProviderConfig { } export namespace OidcIdentityProviderConfig { + /** + * @internal + */ export const filterSensitiveLog = (obj: OidcIdentityProviderConfig): any => ({ ...obj, }); @@ -2578,6 +2794,9 @@ export interface IdentityProviderConfigResponse { } export namespace IdentityProviderConfigResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: IdentityProviderConfigResponse): any => ({ ...obj, }); @@ -2592,6 +2811,9 @@ export interface DescribeIdentityProviderConfigResponse { } export namespace DescribeIdentityProviderConfigResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeIdentityProviderConfigResponse): any => ({ ...obj, }); @@ -2610,6 +2832,9 @@ export interface DescribeNodegroupRequest { } export namespace DescribeNodegroupRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeNodegroupRequest): any => ({ ...obj, }); @@ -2623,6 +2848,9 @@ export interface DescribeNodegroupResponse { } export namespace DescribeNodegroupResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeNodegroupResponse): any => ({ ...obj, }); @@ -2653,6 +2881,9 @@ export interface DescribeUpdateRequest { } export namespace DescribeUpdateRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeUpdateRequest): any => ({ ...obj, }); @@ -2666,6 +2897,9 @@ export interface DescribeUpdateResponse { } export namespace DescribeUpdateResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeUpdateResponse): any => ({ ...obj, }); @@ -2690,6 +2924,9 @@ export interface DisassociateIdentityProviderConfigRequest { } export namespace DisassociateIdentityProviderConfigRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DisassociateIdentityProviderConfigRequest): any => ({ ...obj, }); @@ -2703,6 +2940,9 @@ export interface DisassociateIdentityProviderConfigResponse { } export namespace DisassociateIdentityProviderConfigResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DisassociateIdentityProviderConfigResponse): any => ({ ...obj, }); @@ -2741,6 +2981,9 @@ export interface ListAddonsRequest { } export namespace ListAddonsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListAddonsRequest): any => ({ ...obj, }); @@ -2766,6 +3009,9 @@ export interface ListAddonsResponse { } export namespace ListAddonsResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListAddonsResponse): any => ({ ...obj, }); @@ -2798,6 +3044,9 @@ export interface ListClustersRequest { } export namespace ListClustersRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListClustersRequest): any => ({ ...obj, }); @@ -2820,6 +3069,9 @@ export interface ListClustersResponse { } export namespace ListClustersResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListClustersResponse): any => ({ ...obj, }); @@ -2854,6 +3106,9 @@ export interface ListFargateProfilesRequest { } export namespace ListFargateProfilesRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListFargateProfilesRequest): any => ({ ...obj, }); @@ -2876,6 +3131,9 @@ export interface ListFargateProfilesResponse { } export namespace ListFargateProfilesResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListFargateProfilesResponse): any => ({ ...obj, }); @@ -2911,6 +3169,9 @@ export interface ListIdentityProviderConfigsRequest { } export namespace ListIdentityProviderConfigsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListIdentityProviderConfigsRequest): any => ({ ...obj, }); @@ -2932,6 +3193,9 @@ export interface ListIdentityProviderConfigsResponse { } export namespace ListIdentityProviderConfigsResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListIdentityProviderConfigsResponse): any => ({ ...obj, }); @@ -2965,6 +3229,9 @@ export interface ListNodegroupsRequest { } export namespace ListNodegroupsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListNodegroupsRequest): any => ({ ...obj, }); @@ -2987,6 +3254,9 @@ export interface ListNodegroupsResponse { } export namespace ListNodegroupsResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListNodegroupsResponse): any => ({ ...obj, }); @@ -3003,6 +3273,9 @@ export interface BadRequestException extends __SmithyException, $MetadataBearer } export namespace BadRequestException { + /** + * @internal + */ export const filterSensitiveLog = (obj: BadRequestException): any => ({ ...obj, }); @@ -3017,6 +3290,9 @@ export interface ListTagsForResourceRequest { } export namespace ListTagsForResourceRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListTagsForResourceRequest): any => ({ ...obj, }); @@ -3030,6 +3306,9 @@ export interface ListTagsForResourceResponse { } export namespace ListTagsForResourceResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListTagsForResourceResponse): any => ({ ...obj, }); @@ -3046,6 +3325,9 @@ export interface NotFoundException extends __SmithyException, $MetadataBearer { } export namespace NotFoundException { + /** + * @internal + */ export const filterSensitiveLog = (obj: NotFoundException): any => ({ ...obj, }); @@ -3089,6 +3371,9 @@ export interface ListUpdatesRequest { } export namespace ListUpdatesRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListUpdatesRequest): any => ({ ...obj, }); @@ -3111,6 +3396,9 @@ export interface ListUpdatesResponse { } export namespace ListUpdatesResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListUpdatesResponse): any => ({ ...obj, }); @@ -3130,6 +3418,9 @@ export interface TagResourceRequest { } export namespace TagResourceRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: TagResourceRequest): any => ({ ...obj, }); @@ -3138,6 +3429,9 @@ export namespace TagResourceRequest { export interface TagResourceResponse {} export namespace TagResourceResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: TagResourceResponse): any => ({ ...obj, }); @@ -3157,6 +3451,9 @@ export interface UntagResourceRequest { } export namespace UntagResourceRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: UntagResourceRequest): any => ({ ...obj, }); @@ -3165,6 +3462,9 @@ export namespace UntagResourceRequest { export interface UntagResourceResponse {} export namespace UntagResourceResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: UntagResourceResponse): any => ({ ...obj, }); @@ -3216,6 +3516,9 @@ export interface UpdateAddonRequest { } export namespace UpdateAddonRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateAddonRequest): any => ({ ...obj, }); @@ -3229,6 +3532,9 @@ export interface UpdateAddonResponse { } export namespace UpdateAddonResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateAddonResponse): any => ({ ...obj, }); @@ -3267,6 +3573,9 @@ export interface UpdateClusterConfigRequest { } export namespace UpdateClusterConfigRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateClusterConfigRequest): any => ({ ...obj, }); @@ -3280,6 +3589,9 @@ export interface UpdateClusterConfigResponse { } export namespace UpdateClusterConfigResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateClusterConfigResponse): any => ({ ...obj, }); @@ -3304,6 +3616,9 @@ export interface UpdateClusterVersionRequest { } export namespace UpdateClusterVersionRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateClusterVersionRequest): any => ({ ...obj, }); @@ -3317,6 +3632,9 @@ export interface UpdateClusterVersionResponse { } export namespace UpdateClusterVersionResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateClusterVersionResponse): any => ({ ...obj, }); @@ -3338,6 +3656,9 @@ export interface UpdateLabelsPayload { } export namespace UpdateLabelsPayload { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateLabelsPayload): any => ({ ...obj, }); @@ -3373,6 +3694,9 @@ export interface UpdateNodegroupConfigRequest { } export namespace UpdateNodegroupConfigRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateNodegroupConfigRequest): any => ({ ...obj, }); @@ -3386,6 +3710,9 @@ export interface UpdateNodegroupConfigResponse { } export namespace UpdateNodegroupConfigResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateNodegroupConfigResponse): any => ({ ...obj, }); @@ -3446,6 +3773,9 @@ export interface UpdateNodegroupVersionRequest { } export namespace UpdateNodegroupVersionRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateNodegroupVersionRequest): any => ({ ...obj, }); @@ -3459,6 +3789,9 @@ export interface UpdateNodegroupVersionResponse { } export namespace UpdateNodegroupVersionResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateNodegroupVersionResponse): any => ({ ...obj, }); diff --git a/clients/client-elastic-beanstalk/commands/AbortEnvironmentUpdateCommand.ts b/clients/client-elastic-beanstalk/commands/AbortEnvironmentUpdateCommand.ts index 453a66922f1e..d6b9fcc8c92c 100644 --- a/clients/client-elastic-beanstalk/commands/AbortEnvironmentUpdateCommand.ts +++ b/clients/client-elastic-beanstalk/commands/AbortEnvironmentUpdateCommand.ts @@ -23,6 +23,20 @@ export interface AbortEnvironmentUpdateCommandOutput extends __MetadataBearer {} /** *

Cancels in-progress environment configuration update or application version * deployment.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ElasticBeanstalkClient, AbortEnvironmentUpdateCommand } from "@aws-sdk/client-elastic-beanstalk"; // ES Modules import + * // const { ElasticBeanstalkClient, AbortEnvironmentUpdateCommand } = require("@aws-sdk/client-elastic-beanstalk"); // CommonJS import + * const client = new ElasticBeanstalkClient(config); + * const command = new AbortEnvironmentUpdateCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link AbortEnvironmentUpdateCommandInput} for command's `input` shape. + * @see {@link AbortEnvironmentUpdateCommandOutput} for command's `response` shape. + * @see {@link ElasticBeanstalkClientResolvedConfig | config} for command's `input` shape. + * */ export class AbortEnvironmentUpdateCommand extends $Command< AbortEnvironmentUpdateCommandInput, diff --git a/clients/client-elastic-beanstalk/commands/ApplyEnvironmentManagedActionCommand.ts b/clients/client-elastic-beanstalk/commands/ApplyEnvironmentManagedActionCommand.ts index 061afb2923d7..5e0ceb1f3911 100644 --- a/clients/client-elastic-beanstalk/commands/ApplyEnvironmentManagedActionCommand.ts +++ b/clients/client-elastic-beanstalk/commands/ApplyEnvironmentManagedActionCommand.ts @@ -26,6 +26,20 @@ export interface ApplyEnvironmentManagedActionCommandOutput *

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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ElasticBeanstalkClient, ApplyEnvironmentManagedActionCommand } from "@aws-sdk/client-elastic-beanstalk"; // ES Modules import + * // const { ElasticBeanstalkClient, ApplyEnvironmentManagedActionCommand } = require("@aws-sdk/client-elastic-beanstalk"); // CommonJS import + * const client = new ElasticBeanstalkClient(config); + * const command = new ApplyEnvironmentManagedActionCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ApplyEnvironmentManagedActionCommandInput} for command's `input` shape. + * @see {@link ApplyEnvironmentManagedActionCommandOutput} for command's `response` shape. + * @see {@link ElasticBeanstalkClientResolvedConfig | config} for command's `input` shape. + * */ export class ApplyEnvironmentManagedActionCommand extends $Command< ApplyEnvironmentManagedActionCommandInput, diff --git a/clients/client-elastic-beanstalk/commands/AssociateEnvironmentOperationsRoleCommand.ts b/clients/client-elastic-beanstalk/commands/AssociateEnvironmentOperationsRoleCommand.ts index 619c43a8a018..f1e55b60f3af 100644 --- a/clients/client-elastic-beanstalk/commands/AssociateEnvironmentOperationsRoleCommand.ts +++ b/clients/client-elastic-beanstalk/commands/AssociateEnvironmentOperationsRoleCommand.ts @@ -25,6 +25,20 @@ export interface AssociateEnvironmentOperationsRoleCommandOutput extends __Metad * 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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ElasticBeanstalkClient, AssociateEnvironmentOperationsRoleCommand } from "@aws-sdk/client-elastic-beanstalk"; // ES Modules import + * // const { ElasticBeanstalkClient, AssociateEnvironmentOperationsRoleCommand } = require("@aws-sdk/client-elastic-beanstalk"); // CommonJS import + * const client = new ElasticBeanstalkClient(config); + * const command = new AssociateEnvironmentOperationsRoleCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link AssociateEnvironmentOperationsRoleCommandInput} for command's `input` shape. + * @see {@link AssociateEnvironmentOperationsRoleCommandOutput} for command's `response` shape. + * @see {@link ElasticBeanstalkClientResolvedConfig | config} for command's `input` shape. + * */ export class AssociateEnvironmentOperationsRoleCommand extends $Command< AssociateEnvironmentOperationsRoleCommandInput, diff --git a/clients/client-elastic-beanstalk/commands/CheckDNSAvailabilityCommand.ts b/clients/client-elastic-beanstalk/commands/CheckDNSAvailabilityCommand.ts index 473d33e7435b..7695f96faafc 100644 --- a/clients/client-elastic-beanstalk/commands/CheckDNSAvailabilityCommand.ts +++ b/clients/client-elastic-beanstalk/commands/CheckDNSAvailabilityCommand.ts @@ -22,6 +22,20 @@ export interface CheckDNSAvailabilityCommandOutput extends CheckDNSAvailabilityR /** *

Checks if the specified CNAME is available.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ElasticBeanstalkClient, CheckDNSAvailabilityCommand } from "@aws-sdk/client-elastic-beanstalk"; // ES Modules import + * // const { ElasticBeanstalkClient, CheckDNSAvailabilityCommand } = require("@aws-sdk/client-elastic-beanstalk"); // CommonJS import + * const client = new ElasticBeanstalkClient(config); + * const command = new CheckDNSAvailabilityCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CheckDNSAvailabilityCommandInput} for command's `input` shape. + * @see {@link CheckDNSAvailabilityCommandOutput} for command's `response` shape. + * @see {@link ElasticBeanstalkClientResolvedConfig | config} for command's `input` shape. + * */ export class CheckDNSAvailabilityCommand extends $Command< CheckDNSAvailabilityCommandInput, diff --git a/clients/client-elastic-beanstalk/commands/ComposeEnvironmentsCommand.ts b/clients/client-elastic-beanstalk/commands/ComposeEnvironmentsCommand.ts index dbaf5b64489a..5e27e35ec4f2 100644 --- a/clients/client-elastic-beanstalk/commands/ComposeEnvironmentsCommand.ts +++ b/clients/client-elastic-beanstalk/commands/ComposeEnvironmentsCommand.ts @@ -27,6 +27,20 @@ export interface ComposeEnvironmentsCommandOutput extends EnvironmentDescription * information must be included in the source bundles in an environment manifest named * env.yaml. See Compose Environments * for details.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ElasticBeanstalkClient, ComposeEnvironmentsCommand } from "@aws-sdk/client-elastic-beanstalk"; // ES Modules import + * // const { ElasticBeanstalkClient, ComposeEnvironmentsCommand } = require("@aws-sdk/client-elastic-beanstalk"); // CommonJS import + * const client = new ElasticBeanstalkClient(config); + * const command = new ComposeEnvironmentsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ComposeEnvironmentsCommandInput} for command's `input` shape. + * @see {@link ComposeEnvironmentsCommandOutput} for command's `response` shape. + * @see {@link ElasticBeanstalkClientResolvedConfig | config} for command's `input` shape. + * */ export class ComposeEnvironmentsCommand extends $Command< ComposeEnvironmentsCommandInput, diff --git a/clients/client-elastic-beanstalk/commands/CreateApplicationCommand.ts b/clients/client-elastic-beanstalk/commands/CreateApplicationCommand.ts index 3f6af7e8c2e1..ddc3086777b5 100644 --- a/clients/client-elastic-beanstalk/commands/CreateApplicationCommand.ts +++ b/clients/client-elastic-beanstalk/commands/CreateApplicationCommand.ts @@ -23,6 +23,20 @@ export interface CreateApplicationCommandOutput extends ApplicationDescriptionMe /** *

Creates an application that has one configuration template named default * and no application versions.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ElasticBeanstalkClient, CreateApplicationCommand } from "@aws-sdk/client-elastic-beanstalk"; // ES Modules import + * // const { ElasticBeanstalkClient, CreateApplicationCommand } = require("@aws-sdk/client-elastic-beanstalk"); // CommonJS import + * const client = new ElasticBeanstalkClient(config); + * const command = new CreateApplicationCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreateApplicationCommandInput} for command's `input` shape. + * @see {@link CreateApplicationCommandOutput} for command's `response` shape. + * @see {@link ElasticBeanstalkClientResolvedConfig | config} for command's `input` shape. + * */ export class CreateApplicationCommand extends $Command< CreateApplicationCommandInput, diff --git a/clients/client-elastic-beanstalk/commands/CreateApplicationVersionCommand.ts b/clients/client-elastic-beanstalk/commands/CreateApplicationVersionCommand.ts index 15e54f324b77..a1f4ae5be432 100644 --- a/clients/client-elastic-beanstalk/commands/CreateApplicationVersionCommand.ts +++ b/clients/client-elastic-beanstalk/commands/CreateApplicationVersionCommand.ts @@ -38,6 +38,20 @@ export interface CreateApplicationVersionCommandOutput extends ApplicationVersio * you receive an exception when you attempt to launch an environment from the application * version.

* + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ElasticBeanstalkClient, CreateApplicationVersionCommand } from "@aws-sdk/client-elastic-beanstalk"; // ES Modules import + * // const { ElasticBeanstalkClient, CreateApplicationVersionCommand } = require("@aws-sdk/client-elastic-beanstalk"); // CommonJS import + * const client = new ElasticBeanstalkClient(config); + * const command = new CreateApplicationVersionCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreateApplicationVersionCommandInput} for command's `input` shape. + * @see {@link CreateApplicationVersionCommandOutput} for command's `response` shape. + * @see {@link ElasticBeanstalkClientResolvedConfig | config} for command's `input` shape. + * */ export class CreateApplicationVersionCommand extends $Command< CreateApplicationVersionCommandInput, diff --git a/clients/client-elastic-beanstalk/commands/CreateConfigurationTemplateCommand.ts b/clients/client-elastic-beanstalk/commands/CreateConfigurationTemplateCommand.ts index 8c2ede205b4b..9f4ab8b2239b 100644 --- a/clients/client-elastic-beanstalk/commands/CreateConfigurationTemplateCommand.ts +++ b/clients/client-elastic-beanstalk/commands/CreateConfigurationTemplateCommand.ts @@ -45,6 +45,20 @@ export interface CreateConfigurationTemplateCommandOutput extends ConfigurationS *

* * + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ElasticBeanstalkClient, CreateConfigurationTemplateCommand } from "@aws-sdk/client-elastic-beanstalk"; // ES Modules import + * // const { ElasticBeanstalkClient, CreateConfigurationTemplateCommand } = require("@aws-sdk/client-elastic-beanstalk"); // CommonJS import + * const client = new ElasticBeanstalkClient(config); + * const command = new CreateConfigurationTemplateCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreateConfigurationTemplateCommandInput} for command's `input` shape. + * @see {@link CreateConfigurationTemplateCommandOutput} for command's `response` shape. + * @see {@link ElasticBeanstalkClientResolvedConfig | config} for command's `input` shape. + * */ export class CreateConfigurationTemplateCommand extends $Command< CreateConfigurationTemplateCommandInput, diff --git a/clients/client-elastic-beanstalk/commands/CreateEnvironmentCommand.ts b/clients/client-elastic-beanstalk/commands/CreateEnvironmentCommand.ts index c75357a9a8c8..1f25c3f9c087 100644 --- a/clients/client-elastic-beanstalk/commands/CreateEnvironmentCommand.ts +++ b/clients/client-elastic-beanstalk/commands/CreateEnvironmentCommand.ts @@ -23,6 +23,20 @@ export interface CreateEnvironmentCommandOutput extends EnvironmentDescription, /** *

Launches an AWS Elastic Beanstalk environment for the specified application using the specified * configuration.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ElasticBeanstalkClient, CreateEnvironmentCommand } from "@aws-sdk/client-elastic-beanstalk"; // ES Modules import + * // const { ElasticBeanstalkClient, CreateEnvironmentCommand } = require("@aws-sdk/client-elastic-beanstalk"); // CommonJS import + * const client = new ElasticBeanstalkClient(config); + * const command = new CreateEnvironmentCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreateEnvironmentCommandInput} for command's `input` shape. + * @see {@link CreateEnvironmentCommandOutput} for command's `response` shape. + * @see {@link ElasticBeanstalkClientResolvedConfig | config} for command's `input` shape. + * */ export class CreateEnvironmentCommand extends $Command< CreateEnvironmentCommandInput, diff --git a/clients/client-elastic-beanstalk/commands/CreatePlatformVersionCommand.ts b/clients/client-elastic-beanstalk/commands/CreatePlatformVersionCommand.ts index 58f961bc049b..3e068dc8de94 100644 --- a/clients/client-elastic-beanstalk/commands/CreatePlatformVersionCommand.ts +++ b/clients/client-elastic-beanstalk/commands/CreatePlatformVersionCommand.ts @@ -22,6 +22,20 @@ export interface CreatePlatformVersionCommandOutput extends CreatePlatformVersio /** *

Create a new version of your custom platform.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ElasticBeanstalkClient, CreatePlatformVersionCommand } from "@aws-sdk/client-elastic-beanstalk"; // ES Modules import + * // const { ElasticBeanstalkClient, CreatePlatformVersionCommand } = require("@aws-sdk/client-elastic-beanstalk"); // CommonJS import + * const client = new ElasticBeanstalkClient(config); + * const command = new CreatePlatformVersionCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreatePlatformVersionCommandInput} for command's `input` shape. + * @see {@link CreatePlatformVersionCommandOutput} for command's `response` shape. + * @see {@link ElasticBeanstalkClientResolvedConfig | config} for command's `input` shape. + * */ export class CreatePlatformVersionCommand extends $Command< CreatePlatformVersionCommandInput, diff --git a/clients/client-elastic-beanstalk/commands/CreateStorageLocationCommand.ts b/clients/client-elastic-beanstalk/commands/CreateStorageLocationCommand.ts index 049c7d919fe5..79f1c9728be5 100644 --- a/clients/client-elastic-beanstalk/commands/CreateStorageLocationCommand.ts +++ b/clients/client-elastic-beanstalk/commands/CreateStorageLocationCommand.ts @@ -26,6 +26,20 @@ export interface CreateStorageLocationCommandOutput extends CreateStorageLocatio * 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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ElasticBeanstalkClient, CreateStorageLocationCommand } from "@aws-sdk/client-elastic-beanstalk"; // ES Modules import + * // const { ElasticBeanstalkClient, CreateStorageLocationCommand } = require("@aws-sdk/client-elastic-beanstalk"); // CommonJS import + * const client = new ElasticBeanstalkClient(config); + * const command = new CreateStorageLocationCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreateStorageLocationCommandInput} for command's `input` shape. + * @see {@link CreateStorageLocationCommandOutput} for command's `response` shape. + * @see {@link ElasticBeanstalkClientResolvedConfig | config} for command's `input` shape. + * */ export class CreateStorageLocationCommand extends $Command< CreateStorageLocationCommandInput, diff --git a/clients/client-elastic-beanstalk/commands/DeleteApplicationCommand.ts b/clients/client-elastic-beanstalk/commands/DeleteApplicationCommand.ts index ea7e2ef1de43..a1802703b65c 100644 --- a/clients/client-elastic-beanstalk/commands/DeleteApplicationCommand.ts +++ b/clients/client-elastic-beanstalk/commands/DeleteApplicationCommand.ts @@ -27,6 +27,20 @@ export interface DeleteApplicationCommandOutput extends __MetadataBearer {} * *

You cannot delete an application that has a running environment.

* + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ElasticBeanstalkClient, DeleteApplicationCommand } from "@aws-sdk/client-elastic-beanstalk"; // ES Modules import + * // const { ElasticBeanstalkClient, DeleteApplicationCommand } = require("@aws-sdk/client-elastic-beanstalk"); // CommonJS import + * const client = new ElasticBeanstalkClient(config); + * const command = new DeleteApplicationCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteApplicationCommandInput} for command's `input` shape. + * @see {@link DeleteApplicationCommandOutput} for command's `response` shape. + * @see {@link ElasticBeanstalkClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteApplicationCommand extends $Command< DeleteApplicationCommandInput, diff --git a/clients/client-elastic-beanstalk/commands/DeleteApplicationVersionCommand.ts b/clients/client-elastic-beanstalk/commands/DeleteApplicationVersionCommand.ts index 6cb04708fb6e..703d1552a968 100644 --- a/clients/client-elastic-beanstalk/commands/DeleteApplicationVersionCommand.ts +++ b/clients/client-elastic-beanstalk/commands/DeleteApplicationVersionCommand.ts @@ -26,6 +26,20 @@ export interface DeleteApplicationVersionCommandOutput extends __MetadataBearer *

You cannot delete an application version that is associated with a running * environment.

* + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ElasticBeanstalkClient, DeleteApplicationVersionCommand } from "@aws-sdk/client-elastic-beanstalk"; // ES Modules import + * // const { ElasticBeanstalkClient, DeleteApplicationVersionCommand } = require("@aws-sdk/client-elastic-beanstalk"); // CommonJS import + * const client = new ElasticBeanstalkClient(config); + * const command = new DeleteApplicationVersionCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteApplicationVersionCommandInput} for command's `input` shape. + * @see {@link DeleteApplicationVersionCommandOutput} for command's `response` shape. + * @see {@link ElasticBeanstalkClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteApplicationVersionCommand extends $Command< DeleteApplicationVersionCommandInput, diff --git a/clients/client-elastic-beanstalk/commands/DeleteConfigurationTemplateCommand.ts b/clients/client-elastic-beanstalk/commands/DeleteConfigurationTemplateCommand.ts index 8c10955b55ac..da9ce75b8cef 100644 --- a/clients/client-elastic-beanstalk/commands/DeleteConfigurationTemplateCommand.ts +++ b/clients/client-elastic-beanstalk/commands/DeleteConfigurationTemplateCommand.ts @@ -27,6 +27,20 @@ export interface DeleteConfigurationTemplateCommandOutput extends __MetadataBear * copy of the template. You can delete or modify the environment's copy of the template * without affecting the running environment.

* + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ElasticBeanstalkClient, DeleteConfigurationTemplateCommand } from "@aws-sdk/client-elastic-beanstalk"; // ES Modules import + * // const { ElasticBeanstalkClient, DeleteConfigurationTemplateCommand } = require("@aws-sdk/client-elastic-beanstalk"); // CommonJS import + * const client = new ElasticBeanstalkClient(config); + * const command = new DeleteConfigurationTemplateCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteConfigurationTemplateCommandInput} for command's `input` shape. + * @see {@link DeleteConfigurationTemplateCommandOutput} for command's `response` shape. + * @see {@link ElasticBeanstalkClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteConfigurationTemplateCommand extends $Command< DeleteConfigurationTemplateCommandInput, diff --git a/clients/client-elastic-beanstalk/commands/DeleteEnvironmentConfigurationCommand.ts b/clients/client-elastic-beanstalk/commands/DeleteEnvironmentConfigurationCommand.ts index 6c2c5c116fda..06f7822c1194 100644 --- a/clients/client-elastic-beanstalk/commands/DeleteEnvironmentConfigurationCommand.ts +++ b/clients/client-elastic-beanstalk/commands/DeleteEnvironmentConfigurationCommand.ts @@ -27,6 +27,20 @@ export interface DeleteEnvironmentConfigurationCommandOutput extends __MetadataB * 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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ElasticBeanstalkClient, DeleteEnvironmentConfigurationCommand } from "@aws-sdk/client-elastic-beanstalk"; // ES Modules import + * // const { ElasticBeanstalkClient, DeleteEnvironmentConfigurationCommand } = require("@aws-sdk/client-elastic-beanstalk"); // CommonJS import + * const client = new ElasticBeanstalkClient(config); + * const command = new DeleteEnvironmentConfigurationCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteEnvironmentConfigurationCommandInput} for command's `input` shape. + * @see {@link DeleteEnvironmentConfigurationCommandOutput} for command's `response` shape. + * @see {@link ElasticBeanstalkClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteEnvironmentConfigurationCommand extends $Command< DeleteEnvironmentConfigurationCommandInput, diff --git a/clients/client-elastic-beanstalk/commands/DeletePlatformVersionCommand.ts b/clients/client-elastic-beanstalk/commands/DeletePlatformVersionCommand.ts index 071bd02dbe02..25f80209a9c5 100644 --- a/clients/client-elastic-beanstalk/commands/DeletePlatformVersionCommand.ts +++ b/clients/client-elastic-beanstalk/commands/DeletePlatformVersionCommand.ts @@ -22,6 +22,20 @@ export interface DeletePlatformVersionCommandOutput extends DeletePlatformVersio /** *

Deletes the specified version of a custom platform.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ElasticBeanstalkClient, DeletePlatformVersionCommand } from "@aws-sdk/client-elastic-beanstalk"; // ES Modules import + * // const { ElasticBeanstalkClient, DeletePlatformVersionCommand } = require("@aws-sdk/client-elastic-beanstalk"); // CommonJS import + * const client = new ElasticBeanstalkClient(config); + * const command = new DeletePlatformVersionCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeletePlatformVersionCommandInput} for command's `input` shape. + * @see {@link DeletePlatformVersionCommandOutput} for command's `response` shape. + * @see {@link ElasticBeanstalkClientResolvedConfig | config} for command's `input` shape. + * */ export class DeletePlatformVersionCommand extends $Command< DeletePlatformVersionCommandInput, diff --git a/clients/client-elastic-beanstalk/commands/DescribeAccountAttributesCommand.ts b/clients/client-elastic-beanstalk/commands/DescribeAccountAttributesCommand.ts index 575fc7c50db4..87d10a31cb3b 100644 --- a/clients/client-elastic-beanstalk/commands/DescribeAccountAttributesCommand.ts +++ b/clients/client-elastic-beanstalk/commands/DescribeAccountAttributesCommand.ts @@ -24,6 +24,20 @@ export interface DescribeAccountAttributesCommandOutput extends DescribeAccountA *

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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ElasticBeanstalkClient, DescribeAccountAttributesCommand } from "@aws-sdk/client-elastic-beanstalk"; // ES Modules import + * // const { ElasticBeanstalkClient, DescribeAccountAttributesCommand } = require("@aws-sdk/client-elastic-beanstalk"); // CommonJS import + * const client = new ElasticBeanstalkClient(config); + * const command = new DescribeAccountAttributesCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeAccountAttributesCommandInput} for command's `input` shape. + * @see {@link DescribeAccountAttributesCommandOutput} for command's `response` shape. + * @see {@link ElasticBeanstalkClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeAccountAttributesCommand extends $Command< DescribeAccountAttributesCommandInput, diff --git a/clients/client-elastic-beanstalk/commands/DescribeApplicationVersionsCommand.ts b/clients/client-elastic-beanstalk/commands/DescribeApplicationVersionsCommand.ts index f6ae3654efd0..d20aab807baa 100644 --- a/clients/client-elastic-beanstalk/commands/DescribeApplicationVersionsCommand.ts +++ b/clients/client-elastic-beanstalk/commands/DescribeApplicationVersionsCommand.ts @@ -24,6 +24,20 @@ export interface DescribeApplicationVersionsCommandOutput /** *

Retrieve a list of application versions.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ElasticBeanstalkClient, DescribeApplicationVersionsCommand } from "@aws-sdk/client-elastic-beanstalk"; // ES Modules import + * // const { ElasticBeanstalkClient, DescribeApplicationVersionsCommand } = require("@aws-sdk/client-elastic-beanstalk"); // CommonJS import + * const client = new ElasticBeanstalkClient(config); + * const command = new DescribeApplicationVersionsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeApplicationVersionsCommandInput} for command's `input` shape. + * @see {@link DescribeApplicationVersionsCommandOutput} for command's `response` shape. + * @see {@link ElasticBeanstalkClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeApplicationVersionsCommand extends $Command< DescribeApplicationVersionsCommandInput, diff --git a/clients/client-elastic-beanstalk/commands/DescribeApplicationsCommand.ts b/clients/client-elastic-beanstalk/commands/DescribeApplicationsCommand.ts index 75059007bbcb..524308baa209 100644 --- a/clients/client-elastic-beanstalk/commands/DescribeApplicationsCommand.ts +++ b/clients/client-elastic-beanstalk/commands/DescribeApplicationsCommand.ts @@ -22,6 +22,20 @@ export interface DescribeApplicationsCommandOutput extends ApplicationDescriptio /** *

Returns the descriptions of existing applications.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ElasticBeanstalkClient, DescribeApplicationsCommand } from "@aws-sdk/client-elastic-beanstalk"; // ES Modules import + * // const { ElasticBeanstalkClient, DescribeApplicationsCommand } = require("@aws-sdk/client-elastic-beanstalk"); // CommonJS import + * const client = new ElasticBeanstalkClient(config); + * const command = new DescribeApplicationsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeApplicationsCommandInput} for command's `input` shape. + * @see {@link DescribeApplicationsCommandOutput} for command's `response` shape. + * @see {@link ElasticBeanstalkClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeApplicationsCommand extends $Command< DescribeApplicationsCommandInput, diff --git a/clients/client-elastic-beanstalk/commands/DescribeConfigurationOptionsCommand.ts b/clients/client-elastic-beanstalk/commands/DescribeConfigurationOptionsCommand.ts index 7b16062cc961..8579327866ae 100644 --- a/clients/client-elastic-beanstalk/commands/DescribeConfigurationOptionsCommand.ts +++ b/clients/client-elastic-beanstalk/commands/DescribeConfigurationOptionsCommand.ts @@ -25,6 +25,20 @@ export interface DescribeConfigurationOptionsCommandOutput extends 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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ElasticBeanstalkClient, DescribeConfigurationOptionsCommand } from "@aws-sdk/client-elastic-beanstalk"; // ES Modules import + * // const { ElasticBeanstalkClient, DescribeConfigurationOptionsCommand } = require("@aws-sdk/client-elastic-beanstalk"); // CommonJS import + * const client = new ElasticBeanstalkClient(config); + * const command = new DescribeConfigurationOptionsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeConfigurationOptionsCommandInput} for command's `input` shape. + * @see {@link DescribeConfigurationOptionsCommandOutput} for command's `response` shape. + * @see {@link ElasticBeanstalkClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeConfigurationOptionsCommand extends $Command< DescribeConfigurationOptionsCommandInput, diff --git a/clients/client-elastic-beanstalk/commands/DescribeConfigurationSettingsCommand.ts b/clients/client-elastic-beanstalk/commands/DescribeConfigurationSettingsCommand.ts index 1b1bff243ad4..b9f34fac9f82 100644 --- a/clients/client-elastic-beanstalk/commands/DescribeConfigurationSettingsCommand.ts +++ b/clients/client-elastic-beanstalk/commands/DescribeConfigurationSettingsCommand.ts @@ -38,6 +38,20 @@ export interface DescribeConfigurationSettingsCommandOutput *

* * + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ElasticBeanstalkClient, DescribeConfigurationSettingsCommand } from "@aws-sdk/client-elastic-beanstalk"; // ES Modules import + * // const { ElasticBeanstalkClient, DescribeConfigurationSettingsCommand } = require("@aws-sdk/client-elastic-beanstalk"); // CommonJS import + * const client = new ElasticBeanstalkClient(config); + * const command = new DescribeConfigurationSettingsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeConfigurationSettingsCommandInput} for command's `input` shape. + * @see {@link DescribeConfigurationSettingsCommandOutput} for command's `response` shape. + * @see {@link ElasticBeanstalkClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeConfigurationSettingsCommand extends $Command< DescribeConfigurationSettingsCommandInput, diff --git a/clients/client-elastic-beanstalk/commands/DescribeEnvironmentHealthCommand.ts b/clients/client-elastic-beanstalk/commands/DescribeEnvironmentHealthCommand.ts index 70b39c69d10b..d2356524b970 100644 --- a/clients/client-elastic-beanstalk/commands/DescribeEnvironmentHealthCommand.ts +++ b/clients/client-elastic-beanstalk/commands/DescribeEnvironmentHealthCommand.ts @@ -24,6 +24,20 @@ export interface DescribeEnvironmentHealthCommandOutput extends DescribeEnvironm *

Returns information about the overall health of the specified environment. The * DescribeEnvironmentHealth operation is only available with * AWS Elastic Beanstalk Enhanced Health.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ElasticBeanstalkClient, DescribeEnvironmentHealthCommand } from "@aws-sdk/client-elastic-beanstalk"; // ES Modules import + * // const { ElasticBeanstalkClient, DescribeEnvironmentHealthCommand } = require("@aws-sdk/client-elastic-beanstalk"); // CommonJS import + * const client = new ElasticBeanstalkClient(config); + * const command = new DescribeEnvironmentHealthCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeEnvironmentHealthCommandInput} for command's `input` shape. + * @see {@link DescribeEnvironmentHealthCommandOutput} for command's `response` shape. + * @see {@link ElasticBeanstalkClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeEnvironmentHealthCommand extends $Command< DescribeEnvironmentHealthCommandInput, diff --git a/clients/client-elastic-beanstalk/commands/DescribeEnvironmentManagedActionHistoryCommand.ts b/clients/client-elastic-beanstalk/commands/DescribeEnvironmentManagedActionHistoryCommand.ts index 538f92f7b685..de8a467c186c 100644 --- a/clients/client-elastic-beanstalk/commands/DescribeEnvironmentManagedActionHistoryCommand.ts +++ b/clients/client-elastic-beanstalk/commands/DescribeEnvironmentManagedActionHistoryCommand.ts @@ -28,6 +28,20 @@ export interface DescribeEnvironmentManagedActionHistoryCommandOutput /** *

Lists an environment's completed and failed managed actions.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ElasticBeanstalkClient, DescribeEnvironmentManagedActionHistoryCommand } from "@aws-sdk/client-elastic-beanstalk"; // ES Modules import + * // const { ElasticBeanstalkClient, DescribeEnvironmentManagedActionHistoryCommand } = require("@aws-sdk/client-elastic-beanstalk"); // CommonJS import + * const client = new ElasticBeanstalkClient(config); + * const command = new DescribeEnvironmentManagedActionHistoryCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeEnvironmentManagedActionHistoryCommandInput} for command's `input` shape. + * @see {@link DescribeEnvironmentManagedActionHistoryCommandOutput} for command's `response` shape. + * @see {@link ElasticBeanstalkClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeEnvironmentManagedActionHistoryCommand extends $Command< DescribeEnvironmentManagedActionHistoryCommandInput, diff --git a/clients/client-elastic-beanstalk/commands/DescribeEnvironmentManagedActionsCommand.ts b/clients/client-elastic-beanstalk/commands/DescribeEnvironmentManagedActionsCommand.ts index 3d9522d2ec5f..a351a77a512b 100644 --- a/clients/client-elastic-beanstalk/commands/DescribeEnvironmentManagedActionsCommand.ts +++ b/clients/client-elastic-beanstalk/commands/DescribeEnvironmentManagedActionsCommand.ts @@ -24,6 +24,20 @@ export interface DescribeEnvironmentManagedActionsCommandOutput /** *

Lists an environment's upcoming and in-progress managed actions.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ElasticBeanstalkClient, DescribeEnvironmentManagedActionsCommand } from "@aws-sdk/client-elastic-beanstalk"; // ES Modules import + * // const { ElasticBeanstalkClient, DescribeEnvironmentManagedActionsCommand } = require("@aws-sdk/client-elastic-beanstalk"); // CommonJS import + * const client = new ElasticBeanstalkClient(config); + * const command = new DescribeEnvironmentManagedActionsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeEnvironmentManagedActionsCommandInput} for command's `input` shape. + * @see {@link DescribeEnvironmentManagedActionsCommandOutput} for command's `response` shape. + * @see {@link ElasticBeanstalkClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeEnvironmentManagedActionsCommand extends $Command< DescribeEnvironmentManagedActionsCommandInput, diff --git a/clients/client-elastic-beanstalk/commands/DescribeEnvironmentResourcesCommand.ts b/clients/client-elastic-beanstalk/commands/DescribeEnvironmentResourcesCommand.ts index f31da0aba28b..02f1b7e45938 100644 --- a/clients/client-elastic-beanstalk/commands/DescribeEnvironmentResourcesCommand.ts +++ b/clients/client-elastic-beanstalk/commands/DescribeEnvironmentResourcesCommand.ts @@ -24,6 +24,20 @@ export interface DescribeEnvironmentResourcesCommandOutput /** *

Returns AWS resources for this environment.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ElasticBeanstalkClient, DescribeEnvironmentResourcesCommand } from "@aws-sdk/client-elastic-beanstalk"; // ES Modules import + * // const { ElasticBeanstalkClient, DescribeEnvironmentResourcesCommand } = require("@aws-sdk/client-elastic-beanstalk"); // CommonJS import + * const client = new ElasticBeanstalkClient(config); + * const command = new DescribeEnvironmentResourcesCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeEnvironmentResourcesCommandInput} for command's `input` shape. + * @see {@link DescribeEnvironmentResourcesCommandOutput} for command's `response` shape. + * @see {@link ElasticBeanstalkClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeEnvironmentResourcesCommand extends $Command< DescribeEnvironmentResourcesCommandInput, diff --git a/clients/client-elastic-beanstalk/commands/DescribeEnvironmentsCommand.ts b/clients/client-elastic-beanstalk/commands/DescribeEnvironmentsCommand.ts index 2cbd8a38797f..58be3bc1c2a4 100644 --- a/clients/client-elastic-beanstalk/commands/DescribeEnvironmentsCommand.ts +++ b/clients/client-elastic-beanstalk/commands/DescribeEnvironmentsCommand.ts @@ -22,6 +22,20 @@ export interface DescribeEnvironmentsCommandOutput extends EnvironmentDescriptio /** *

Returns descriptions for existing environments.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ElasticBeanstalkClient, DescribeEnvironmentsCommand } from "@aws-sdk/client-elastic-beanstalk"; // ES Modules import + * // const { ElasticBeanstalkClient, DescribeEnvironmentsCommand } = require("@aws-sdk/client-elastic-beanstalk"); // CommonJS import + * const client = new ElasticBeanstalkClient(config); + * const command = new DescribeEnvironmentsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeEnvironmentsCommandInput} for command's `input` shape. + * @see {@link DescribeEnvironmentsCommandOutput} for command's `response` shape. + * @see {@link ElasticBeanstalkClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeEnvironmentsCommand extends $Command< DescribeEnvironmentsCommandInput, diff --git a/clients/client-elastic-beanstalk/commands/DescribeEventsCommand.ts b/clients/client-elastic-beanstalk/commands/DescribeEventsCommand.ts index 3682b326ce2c..8ede50ebb312 100644 --- a/clients/client-elastic-beanstalk/commands/DescribeEventsCommand.ts +++ b/clients/client-elastic-beanstalk/commands/DescribeEventsCommand.ts @@ -26,6 +26,20 @@ export interface DescribeEventsCommandOutput extends EventDescriptionsMessage, _ *

This action returns the most recent 1,000 events from the specified * NextToken.

* + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ElasticBeanstalkClient, DescribeEventsCommand } from "@aws-sdk/client-elastic-beanstalk"; // ES Modules import + * // const { ElasticBeanstalkClient, DescribeEventsCommand } = require("@aws-sdk/client-elastic-beanstalk"); // CommonJS import + * const client = new ElasticBeanstalkClient(config); + * const command = new DescribeEventsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeEventsCommandInput} for command's `input` shape. + * @see {@link DescribeEventsCommandOutput} for command's `response` shape. + * @see {@link ElasticBeanstalkClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeEventsCommand extends $Command< DescribeEventsCommandInput, diff --git a/clients/client-elastic-beanstalk/commands/DescribeInstancesHealthCommand.ts b/clients/client-elastic-beanstalk/commands/DescribeInstancesHealthCommand.ts index 775911522875..0eaed852d359 100644 --- a/clients/client-elastic-beanstalk/commands/DescribeInstancesHealthCommand.ts +++ b/clients/client-elastic-beanstalk/commands/DescribeInstancesHealthCommand.ts @@ -24,6 +24,20 @@ export interface DescribeInstancesHealthCommandOutput extends DescribeInstancesH *

Retrieves detailed information about the health of instances in your AWS Elastic * Beanstalk. This operation requires enhanced health * reporting.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ElasticBeanstalkClient, DescribeInstancesHealthCommand } from "@aws-sdk/client-elastic-beanstalk"; // ES Modules import + * // const { ElasticBeanstalkClient, DescribeInstancesHealthCommand } = require("@aws-sdk/client-elastic-beanstalk"); // CommonJS import + * const client = new ElasticBeanstalkClient(config); + * const command = new DescribeInstancesHealthCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeInstancesHealthCommandInput} for command's `input` shape. + * @see {@link DescribeInstancesHealthCommandOutput} for command's `response` shape. + * @see {@link ElasticBeanstalkClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeInstancesHealthCommand extends $Command< DescribeInstancesHealthCommandInput, diff --git a/clients/client-elastic-beanstalk/commands/DescribePlatformVersionCommand.ts b/clients/client-elastic-beanstalk/commands/DescribePlatformVersionCommand.ts index c09b506e2bee..9e367fa7358b 100644 --- a/clients/client-elastic-beanstalk/commands/DescribePlatformVersionCommand.ts +++ b/clients/client-elastic-beanstalk/commands/DescribePlatformVersionCommand.ts @@ -25,6 +25,20 @@ export interface DescribePlatformVersionCommandOutput extends DescribePlatformVe * platform versions.

*

For definitions of platform version and other platform-related terms, see AWS Elastic Beanstalk * Platforms Glossary.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ElasticBeanstalkClient, DescribePlatformVersionCommand } from "@aws-sdk/client-elastic-beanstalk"; // ES Modules import + * // const { ElasticBeanstalkClient, DescribePlatformVersionCommand } = require("@aws-sdk/client-elastic-beanstalk"); // CommonJS import + * const client = new ElasticBeanstalkClient(config); + * const command = new DescribePlatformVersionCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribePlatformVersionCommandInput} for command's `input` shape. + * @see {@link DescribePlatformVersionCommandOutput} for command's `response` shape. + * @see {@link ElasticBeanstalkClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribePlatformVersionCommand extends $Command< DescribePlatformVersionCommandInput, diff --git a/clients/client-elastic-beanstalk/commands/DisassociateEnvironmentOperationsRoleCommand.ts b/clients/client-elastic-beanstalk/commands/DisassociateEnvironmentOperationsRoleCommand.ts index 4e6922788551..4e8563c9fea0 100644 --- a/clients/client-elastic-beanstalk/commands/DisassociateEnvironmentOperationsRoleCommand.ts +++ b/clients/client-elastic-beanstalk/commands/DisassociateEnvironmentOperationsRoleCommand.ts @@ -26,6 +26,20 @@ export interface DisassociateEnvironmentOperationsRoleCommandOutput extends __Me * 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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ElasticBeanstalkClient, DisassociateEnvironmentOperationsRoleCommand } from "@aws-sdk/client-elastic-beanstalk"; // ES Modules import + * // const { ElasticBeanstalkClient, DisassociateEnvironmentOperationsRoleCommand } = require("@aws-sdk/client-elastic-beanstalk"); // CommonJS import + * const client = new ElasticBeanstalkClient(config); + * const command = new DisassociateEnvironmentOperationsRoleCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DisassociateEnvironmentOperationsRoleCommandInput} for command's `input` shape. + * @see {@link DisassociateEnvironmentOperationsRoleCommandOutput} for command's `response` shape. + * @see {@link ElasticBeanstalkClientResolvedConfig | config} for command's `input` shape. + * */ export class DisassociateEnvironmentOperationsRoleCommand extends $Command< DisassociateEnvironmentOperationsRoleCommandInput, diff --git a/clients/client-elastic-beanstalk/commands/ListAvailableSolutionStacksCommand.ts b/clients/client-elastic-beanstalk/commands/ListAvailableSolutionStacksCommand.ts index 288b556bf079..bbcf48ba6811 100644 --- a/clients/client-elastic-beanstalk/commands/ListAvailableSolutionStacksCommand.ts +++ b/clients/client-elastic-beanstalk/commands/ListAvailableSolutionStacksCommand.ts @@ -25,6 +25,20 @@ export interface ListAvailableSolutionStacksCommandOutput /** *

Returns a list of the available solution stack names, with the public version first and * then in reverse chronological order.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ElasticBeanstalkClient, ListAvailableSolutionStacksCommand } from "@aws-sdk/client-elastic-beanstalk"; // ES Modules import + * // const { ElasticBeanstalkClient, ListAvailableSolutionStacksCommand } = require("@aws-sdk/client-elastic-beanstalk"); // CommonJS import + * const client = new ElasticBeanstalkClient(config); + * const command = new ListAvailableSolutionStacksCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListAvailableSolutionStacksCommandInput} for command's `input` shape. + * @see {@link ListAvailableSolutionStacksCommandOutput} for command's `response` shape. + * @see {@link ElasticBeanstalkClientResolvedConfig | config} for command's `input` shape. + * */ export class ListAvailableSolutionStacksCommand extends $Command< ListAvailableSolutionStacksCommandInput, diff --git a/clients/client-elastic-beanstalk/commands/ListPlatformBranchesCommand.ts b/clients/client-elastic-beanstalk/commands/ListPlatformBranchesCommand.ts index d59bb9fe254f..6f21e1528e30 100644 --- a/clients/client-elastic-beanstalk/commands/ListPlatformBranchesCommand.ts +++ b/clients/client-elastic-beanstalk/commands/ListPlatformBranchesCommand.ts @@ -25,6 +25,20 @@ export interface ListPlatformBranchesCommandOutput extends ListPlatformBranchesR * summary information about each platform branch.

*

For definitions of platform branch and other platform-related terms, see AWS Elastic Beanstalk * Platforms Glossary.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ElasticBeanstalkClient, ListPlatformBranchesCommand } from "@aws-sdk/client-elastic-beanstalk"; // ES Modules import + * // const { ElasticBeanstalkClient, ListPlatformBranchesCommand } = require("@aws-sdk/client-elastic-beanstalk"); // CommonJS import + * const client = new ElasticBeanstalkClient(config); + * const command = new ListPlatformBranchesCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListPlatformBranchesCommandInput} for command's `input` shape. + * @see {@link ListPlatformBranchesCommandOutput} for command's `response` shape. + * @see {@link ElasticBeanstalkClientResolvedConfig | config} for command's `input` shape. + * */ export class ListPlatformBranchesCommand extends $Command< ListPlatformBranchesCommandInput, diff --git a/clients/client-elastic-beanstalk/commands/ListPlatformVersionsCommand.ts b/clients/client-elastic-beanstalk/commands/ListPlatformVersionsCommand.ts index 389496d57a82..e47473926378 100644 --- a/clients/client-elastic-beanstalk/commands/ListPlatformVersionsCommand.ts +++ b/clients/client-elastic-beanstalk/commands/ListPlatformVersionsCommand.ts @@ -26,6 +26,20 @@ export interface ListPlatformVersionsCommandOutput extends ListPlatformVersionsR * version.

*

For definitions of platform version and other platform-related terms, see AWS Elastic Beanstalk * Platforms Glossary.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ElasticBeanstalkClient, ListPlatformVersionsCommand } from "@aws-sdk/client-elastic-beanstalk"; // ES Modules import + * // const { ElasticBeanstalkClient, ListPlatformVersionsCommand } = require("@aws-sdk/client-elastic-beanstalk"); // CommonJS import + * const client = new ElasticBeanstalkClient(config); + * const command = new ListPlatformVersionsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListPlatformVersionsCommandInput} for command's `input` shape. + * @see {@link ListPlatformVersionsCommandOutput} for command's `response` shape. + * @see {@link ElasticBeanstalkClientResolvedConfig | config} for command's `input` shape. + * */ export class ListPlatformVersionsCommand extends $Command< ListPlatformVersionsCommandInput, diff --git a/clients/client-elastic-beanstalk/commands/ListTagsForResourceCommand.ts b/clients/client-elastic-beanstalk/commands/ListTagsForResourceCommand.ts index f21a82914e3d..ab42c518deee 100644 --- a/clients/client-elastic-beanstalk/commands/ListTagsForResourceCommand.ts +++ b/clients/client-elastic-beanstalk/commands/ListTagsForResourceCommand.ts @@ -25,6 +25,20 @@ export interface ListTagsForResourceCommandOutput extends ResourceTagsDescriptio *

Elastic Beanstalk supports tagging of all of its resources. For details about resource tagging, see * Tagging Application * Resources.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ElasticBeanstalkClient, ListTagsForResourceCommand } from "@aws-sdk/client-elastic-beanstalk"; // ES Modules import + * // const { ElasticBeanstalkClient, ListTagsForResourceCommand } = require("@aws-sdk/client-elastic-beanstalk"); // CommonJS import + * const client = new ElasticBeanstalkClient(config); + * const command = new ListTagsForResourceCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListTagsForResourceCommandInput} for command's `input` shape. + * @see {@link ListTagsForResourceCommandOutput} for command's `response` shape. + * @see {@link ElasticBeanstalkClientResolvedConfig | config} for command's `input` shape. + * */ export class ListTagsForResourceCommand extends $Command< ListTagsForResourceCommandInput, diff --git a/clients/client-elastic-beanstalk/commands/RebuildEnvironmentCommand.ts b/clients/client-elastic-beanstalk/commands/RebuildEnvironmentCommand.ts index 930dc8892fd5..a6627aaf0f3e 100644 --- a/clients/client-elastic-beanstalk/commands/RebuildEnvironmentCommand.ts +++ b/clients/client-elastic-beanstalk/commands/RebuildEnvironmentCommand.ts @@ -23,6 +23,20 @@ export interface RebuildEnvironmentCommandOutput extends __MetadataBearer {} /** *

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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ElasticBeanstalkClient, RebuildEnvironmentCommand } from "@aws-sdk/client-elastic-beanstalk"; // ES Modules import + * // const { ElasticBeanstalkClient, RebuildEnvironmentCommand } = require("@aws-sdk/client-elastic-beanstalk"); // CommonJS import + * const client = new ElasticBeanstalkClient(config); + * const command = new RebuildEnvironmentCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link RebuildEnvironmentCommandInput} for command's `input` shape. + * @see {@link RebuildEnvironmentCommandOutput} for command's `response` shape. + * @see {@link ElasticBeanstalkClientResolvedConfig | config} for command's `input` shape. + * */ export class RebuildEnvironmentCommand extends $Command< RebuildEnvironmentCommandInput, diff --git a/clients/client-elastic-beanstalk/commands/RequestEnvironmentInfoCommand.ts b/clients/client-elastic-beanstalk/commands/RequestEnvironmentInfoCommand.ts index 5dd5c0a5545e..04ee9c729821 100644 --- a/clients/client-elastic-beanstalk/commands/RequestEnvironmentInfoCommand.ts +++ b/clients/client-elastic-beanstalk/commands/RequestEnvironmentInfoCommand.ts @@ -37,6 +37,20 @@ export interface RequestEnvironmentInfoCommandOutput extends __MetadataBearer {} *

* * + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ElasticBeanstalkClient, RequestEnvironmentInfoCommand } from "@aws-sdk/client-elastic-beanstalk"; // ES Modules import + * // const { ElasticBeanstalkClient, RequestEnvironmentInfoCommand } = require("@aws-sdk/client-elastic-beanstalk"); // CommonJS import + * const client = new ElasticBeanstalkClient(config); + * const command = new RequestEnvironmentInfoCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link RequestEnvironmentInfoCommandInput} for command's `input` shape. + * @see {@link RequestEnvironmentInfoCommandOutput} for command's `response` shape. + * @see {@link ElasticBeanstalkClientResolvedConfig | config} for command's `input` shape. + * */ export class RequestEnvironmentInfoCommand extends $Command< RequestEnvironmentInfoCommandInput, diff --git a/clients/client-elastic-beanstalk/commands/RestartAppServerCommand.ts b/clients/client-elastic-beanstalk/commands/RestartAppServerCommand.ts index 59d935c056c3..5b0a596782ca 100644 --- a/clients/client-elastic-beanstalk/commands/RestartAppServerCommand.ts +++ b/clients/client-elastic-beanstalk/commands/RestartAppServerCommand.ts @@ -23,6 +23,20 @@ export interface RestartAppServerCommandOutput extends __MetadataBearer {} /** *

Causes the environment to restart the application container server running on each * Amazon EC2 instance.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ElasticBeanstalkClient, RestartAppServerCommand } from "@aws-sdk/client-elastic-beanstalk"; // ES Modules import + * // const { ElasticBeanstalkClient, RestartAppServerCommand } = require("@aws-sdk/client-elastic-beanstalk"); // CommonJS import + * const client = new ElasticBeanstalkClient(config); + * const command = new RestartAppServerCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link RestartAppServerCommandInput} for command's `input` shape. + * @see {@link RestartAppServerCommandOutput} for command's `response` shape. + * @see {@link ElasticBeanstalkClientResolvedConfig | config} for command's `input` shape. + * */ export class RestartAppServerCommand extends $Command< RestartAppServerCommandInput, diff --git a/clients/client-elastic-beanstalk/commands/RetrieveEnvironmentInfoCommand.ts b/clients/client-elastic-beanstalk/commands/RetrieveEnvironmentInfoCommand.ts index 57ddc9369577..930918a079f1 100644 --- a/clients/client-elastic-beanstalk/commands/RetrieveEnvironmentInfoCommand.ts +++ b/clients/client-elastic-beanstalk/commands/RetrieveEnvironmentInfoCommand.ts @@ -31,6 +31,20 @@ export interface RetrieveEnvironmentInfoCommandOutput extends RetrieveEnvironmen *

* * + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ElasticBeanstalkClient, RetrieveEnvironmentInfoCommand } from "@aws-sdk/client-elastic-beanstalk"; // ES Modules import + * // const { ElasticBeanstalkClient, RetrieveEnvironmentInfoCommand } = require("@aws-sdk/client-elastic-beanstalk"); // CommonJS import + * const client = new ElasticBeanstalkClient(config); + * const command = new RetrieveEnvironmentInfoCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link RetrieveEnvironmentInfoCommandInput} for command's `input` shape. + * @see {@link RetrieveEnvironmentInfoCommandOutput} for command's `response` shape. + * @see {@link ElasticBeanstalkClientResolvedConfig | config} for command's `input` shape. + * */ export class RetrieveEnvironmentInfoCommand extends $Command< RetrieveEnvironmentInfoCommandInput, diff --git a/clients/client-elastic-beanstalk/commands/SwapEnvironmentCNAMEsCommand.ts b/clients/client-elastic-beanstalk/commands/SwapEnvironmentCNAMEsCommand.ts index 95af81788015..85c828d5cd57 100644 --- a/clients/client-elastic-beanstalk/commands/SwapEnvironmentCNAMEsCommand.ts +++ b/clients/client-elastic-beanstalk/commands/SwapEnvironmentCNAMEsCommand.ts @@ -22,6 +22,20 @@ export interface SwapEnvironmentCNAMEsCommandOutput extends __MetadataBearer {} /** *

Swaps the CNAMEs of two environments.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ElasticBeanstalkClient, SwapEnvironmentCNAMEsCommand } from "@aws-sdk/client-elastic-beanstalk"; // ES Modules import + * // const { ElasticBeanstalkClient, SwapEnvironmentCNAMEsCommand } = require("@aws-sdk/client-elastic-beanstalk"); // CommonJS import + * const client = new ElasticBeanstalkClient(config); + * const command = new SwapEnvironmentCNAMEsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link SwapEnvironmentCNAMEsCommandInput} for command's `input` shape. + * @see {@link SwapEnvironmentCNAMEsCommandOutput} for command's `response` shape. + * @see {@link ElasticBeanstalkClientResolvedConfig | config} for command's `input` shape. + * */ export class SwapEnvironmentCNAMEsCommand extends $Command< SwapEnvironmentCNAMEsCommandInput, diff --git a/clients/client-elastic-beanstalk/commands/TerminateEnvironmentCommand.ts b/clients/client-elastic-beanstalk/commands/TerminateEnvironmentCommand.ts index 2fe30b57f94e..688be6060991 100644 --- a/clients/client-elastic-beanstalk/commands/TerminateEnvironmentCommand.ts +++ b/clients/client-elastic-beanstalk/commands/TerminateEnvironmentCommand.ts @@ -22,6 +22,20 @@ export interface TerminateEnvironmentCommandOutput extends EnvironmentDescriptio /** *

Terminates the specified environment.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ElasticBeanstalkClient, TerminateEnvironmentCommand } from "@aws-sdk/client-elastic-beanstalk"; // ES Modules import + * // const { ElasticBeanstalkClient, TerminateEnvironmentCommand } = require("@aws-sdk/client-elastic-beanstalk"); // CommonJS import + * const client = new ElasticBeanstalkClient(config); + * const command = new TerminateEnvironmentCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link TerminateEnvironmentCommandInput} for command's `input` shape. + * @see {@link TerminateEnvironmentCommandOutput} for command's `response` shape. + * @see {@link ElasticBeanstalkClientResolvedConfig | config} for command's `input` shape. + * */ export class TerminateEnvironmentCommand extends $Command< TerminateEnvironmentCommandInput, diff --git a/clients/client-elastic-beanstalk/commands/UpdateApplicationCommand.ts b/clients/client-elastic-beanstalk/commands/UpdateApplicationCommand.ts index ed3386099c64..f74f603530eb 100644 --- a/clients/client-elastic-beanstalk/commands/UpdateApplicationCommand.ts +++ b/clients/client-elastic-beanstalk/commands/UpdateApplicationCommand.ts @@ -26,6 +26,20 @@ export interface UpdateApplicationCommandOutput extends ApplicationDescriptionMe *

If a property (for example, description) is not provided, the value * remains unchanged. To clear these properties, specify an empty string.

* + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ElasticBeanstalkClient, UpdateApplicationCommand } from "@aws-sdk/client-elastic-beanstalk"; // ES Modules import + * // const { ElasticBeanstalkClient, UpdateApplicationCommand } = require("@aws-sdk/client-elastic-beanstalk"); // CommonJS import + * const client = new ElasticBeanstalkClient(config); + * const command = new UpdateApplicationCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link UpdateApplicationCommandInput} for command's `input` shape. + * @see {@link UpdateApplicationCommandOutput} for command's `response` shape. + * @see {@link ElasticBeanstalkClientResolvedConfig | config} for command's `input` shape. + * */ export class UpdateApplicationCommand extends $Command< UpdateApplicationCommandInput, diff --git a/clients/client-elastic-beanstalk/commands/UpdateApplicationResourceLifecycleCommand.ts b/clients/client-elastic-beanstalk/commands/UpdateApplicationResourceLifecycleCommand.ts index 6a2f96c7925d..c571627658e2 100644 --- a/clients/client-elastic-beanstalk/commands/UpdateApplicationResourceLifecycleCommand.ts +++ b/clients/client-elastic-beanstalk/commands/UpdateApplicationResourceLifecycleCommand.ts @@ -27,6 +27,20 @@ export interface UpdateApplicationResourceLifecycleCommandOutput /** *

Modifies lifecycle settings for an application.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ElasticBeanstalkClient, UpdateApplicationResourceLifecycleCommand } from "@aws-sdk/client-elastic-beanstalk"; // ES Modules import + * // const { ElasticBeanstalkClient, UpdateApplicationResourceLifecycleCommand } = require("@aws-sdk/client-elastic-beanstalk"); // CommonJS import + * const client = new ElasticBeanstalkClient(config); + * const command = new UpdateApplicationResourceLifecycleCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link UpdateApplicationResourceLifecycleCommandInput} for command's `input` shape. + * @see {@link UpdateApplicationResourceLifecycleCommandOutput} for command's `response` shape. + * @see {@link ElasticBeanstalkClientResolvedConfig | config} for command's `input` shape. + * */ export class UpdateApplicationResourceLifecycleCommand extends $Command< UpdateApplicationResourceLifecycleCommandInput, diff --git a/clients/client-elastic-beanstalk/commands/UpdateApplicationVersionCommand.ts b/clients/client-elastic-beanstalk/commands/UpdateApplicationVersionCommand.ts index 059a33152a1b..04c5402a0392 100644 --- a/clients/client-elastic-beanstalk/commands/UpdateApplicationVersionCommand.ts +++ b/clients/client-elastic-beanstalk/commands/UpdateApplicationVersionCommand.ts @@ -26,6 +26,20 @@ export interface UpdateApplicationVersionCommandOutput extends ApplicationVersio *

If a property (for example, description) is not provided, the value * remains unchanged. To clear properties, specify an empty string.

* + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ElasticBeanstalkClient, UpdateApplicationVersionCommand } from "@aws-sdk/client-elastic-beanstalk"; // ES Modules import + * // const { ElasticBeanstalkClient, UpdateApplicationVersionCommand } = require("@aws-sdk/client-elastic-beanstalk"); // CommonJS import + * const client = new ElasticBeanstalkClient(config); + * const command = new UpdateApplicationVersionCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link UpdateApplicationVersionCommandInput} for command's `input` shape. + * @see {@link UpdateApplicationVersionCommandOutput} for command's `response` shape. + * @see {@link ElasticBeanstalkClientResolvedConfig | config} for command's `input` shape. + * */ export class UpdateApplicationVersionCommand extends $Command< UpdateApplicationVersionCommandInput, diff --git a/clients/client-elastic-beanstalk/commands/UpdateConfigurationTemplateCommand.ts b/clients/client-elastic-beanstalk/commands/UpdateConfigurationTemplateCommand.ts index 0c7868d1d555..51a9f09dfd4a 100644 --- a/clients/client-elastic-beanstalk/commands/UpdateConfigurationTemplateCommand.ts +++ b/clients/client-elastic-beanstalk/commands/UpdateConfigurationTemplateCommand.ts @@ -35,6 +35,20 @@ export interface UpdateConfigurationTemplateCommandOutput extends ConfigurationS *

* * + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ElasticBeanstalkClient, UpdateConfigurationTemplateCommand } from "@aws-sdk/client-elastic-beanstalk"; // ES Modules import + * // const { ElasticBeanstalkClient, UpdateConfigurationTemplateCommand } = require("@aws-sdk/client-elastic-beanstalk"); // CommonJS import + * const client = new ElasticBeanstalkClient(config); + * const command = new UpdateConfigurationTemplateCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link UpdateConfigurationTemplateCommandInput} for command's `input` shape. + * @see {@link UpdateConfigurationTemplateCommandOutput} for command's `response` shape. + * @see {@link ElasticBeanstalkClientResolvedConfig | config} for command's `input` shape. + * */ export class UpdateConfigurationTemplateCommand extends $Command< UpdateConfigurationTemplateCommandInput, diff --git a/clients/client-elastic-beanstalk/commands/UpdateEnvironmentCommand.ts b/clients/client-elastic-beanstalk/commands/UpdateEnvironmentCommand.ts index 684b3ef63be5..005ebd8030d1 100644 --- a/clients/client-elastic-beanstalk/commands/UpdateEnvironmentCommand.ts +++ b/clients/client-elastic-beanstalk/commands/UpdateEnvironmentCommand.ts @@ -30,6 +30,20 @@ export interface UpdateEnvironmentCommandOutput extends EnvironmentDescription, * draft configuration is created and DescribeConfigurationSettings for this * environment returns two setting descriptions with different DeploymentStatus * values.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ElasticBeanstalkClient, UpdateEnvironmentCommand } from "@aws-sdk/client-elastic-beanstalk"; // ES Modules import + * // const { ElasticBeanstalkClient, UpdateEnvironmentCommand } = require("@aws-sdk/client-elastic-beanstalk"); // CommonJS import + * const client = new ElasticBeanstalkClient(config); + * const command = new UpdateEnvironmentCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link UpdateEnvironmentCommandInput} for command's `input` shape. + * @see {@link UpdateEnvironmentCommandOutput} for command's `response` shape. + * @see {@link ElasticBeanstalkClientResolvedConfig | config} for command's `input` shape. + * */ export class UpdateEnvironmentCommand extends $Command< UpdateEnvironmentCommandInput, diff --git a/clients/client-elastic-beanstalk/commands/UpdateTagsForResourceCommand.ts b/clients/client-elastic-beanstalk/commands/UpdateTagsForResourceCommand.ts index 5f703578aa6d..a8d214ec979d 100644 --- a/clients/client-elastic-beanstalk/commands/UpdateTagsForResourceCommand.ts +++ b/clients/client-elastic-beanstalk/commands/UpdateTagsForResourceCommand.ts @@ -41,6 +41,20 @@ export interface UpdateTagsForResourceCommandOutput extends __MetadataBearer {} * * *

For details about creating a custom user policy, see Creating a Custom User Policy.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ElasticBeanstalkClient, UpdateTagsForResourceCommand } from "@aws-sdk/client-elastic-beanstalk"; // ES Modules import + * // const { ElasticBeanstalkClient, UpdateTagsForResourceCommand } = require("@aws-sdk/client-elastic-beanstalk"); // CommonJS import + * const client = new ElasticBeanstalkClient(config); + * const command = new UpdateTagsForResourceCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link UpdateTagsForResourceCommandInput} for command's `input` shape. + * @see {@link UpdateTagsForResourceCommandOutput} for command's `response` shape. + * @see {@link ElasticBeanstalkClientResolvedConfig | config} for command's `input` shape. + * */ export class UpdateTagsForResourceCommand extends $Command< UpdateTagsForResourceCommandInput, diff --git a/clients/client-elastic-beanstalk/commands/ValidateConfigurationSettingsCommand.ts b/clients/client-elastic-beanstalk/commands/ValidateConfigurationSettingsCommand.ts index fc31382b1a2d..4a52cf7e64e3 100644 --- a/clients/client-elastic-beanstalk/commands/ValidateConfigurationSettingsCommand.ts +++ b/clients/client-elastic-beanstalk/commands/ValidateConfigurationSettingsCommand.ts @@ -27,6 +27,20 @@ export interface ValidateConfigurationSettingsCommandOutput * 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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ElasticBeanstalkClient, ValidateConfigurationSettingsCommand } from "@aws-sdk/client-elastic-beanstalk"; // ES Modules import + * // const { ElasticBeanstalkClient, ValidateConfigurationSettingsCommand } = require("@aws-sdk/client-elastic-beanstalk"); // CommonJS import + * const client = new ElasticBeanstalkClient(config); + * const command = new ValidateConfigurationSettingsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ValidateConfigurationSettingsCommandInput} for command's `input` shape. + * @see {@link ValidateConfigurationSettingsCommandOutput} for command's `response` shape. + * @see {@link ElasticBeanstalkClientResolvedConfig | config} for command's `input` shape. + * */ export class ValidateConfigurationSettingsCommand extends $Command< ValidateConfigurationSettingsCommandInput, diff --git a/clients/client-elastic-beanstalk/models/models_0.ts b/clients/client-elastic-beanstalk/models/models_0.ts index 46f1fe31e8b6..c442c26cca46 100644 --- a/clients/client-elastic-beanstalk/models/models_0.ts +++ b/clients/client-elastic-beanstalk/models/models_0.ts @@ -19,6 +19,9 @@ export interface AbortEnvironmentUpdateMessage { } export namespace AbortEnvironmentUpdateMessage { + /** + * @internal + */ export const filterSensitiveLog = (obj: AbortEnvironmentUpdateMessage): any => ({ ...obj, }); @@ -38,6 +41,9 @@ export interface InsufficientPrivilegesException extends __SmithyException, $Met } export namespace InsufficientPrivilegesException { + /** + * @internal + */ export const filterSensitiveLog = (obj: InsufficientPrivilegesException): any => ({ ...obj, }); @@ -73,6 +79,9 @@ export interface MaxAgeRule { } export namespace MaxAgeRule { + /** + * @internal + */ export const filterSensitiveLog = (obj: MaxAgeRule): any => ({ ...obj, }); @@ -102,6 +111,9 @@ export interface MaxCountRule { } export namespace MaxCountRule { + /** + * @internal + */ export const filterSensitiveLog = (obj: MaxCountRule): any => ({ ...obj, }); @@ -130,6 +142,9 @@ export interface ApplicationVersionLifecycleConfig { } export namespace ApplicationVersionLifecycleConfig { + /** + * @internal + */ export const filterSensitiveLog = (obj: ApplicationVersionLifecycleConfig): any => ({ ...obj, }); @@ -162,6 +177,9 @@ export interface ApplicationResourceLifecycleConfig { } export namespace ApplicationResourceLifecycleConfig { + /** + * @internal + */ export const filterSensitiveLog = (obj: ApplicationResourceLifecycleConfig): any => ({ ...obj, }); @@ -213,6 +231,9 @@ export interface ApplicationDescription { } export namespace ApplicationDescription { + /** + * @internal + */ export const filterSensitiveLog = (obj: ApplicationDescription): any => ({ ...obj, }); @@ -229,6 +250,9 @@ export interface ApplicationDescriptionMessage { } export namespace ApplicationDescriptionMessage { + /** + * @internal + */ export const filterSensitiveLog = (obj: ApplicationDescriptionMessage): any => ({ ...obj, }); @@ -245,6 +269,9 @@ export interface ApplicationDescriptionsMessage { } export namespace ApplicationDescriptionsMessage { + /** + * @internal + */ export const filterSensitiveLog = (obj: ApplicationDescriptionsMessage): any => ({ ...obj, }); @@ -305,6 +332,9 @@ export interface Latency { } export namespace Latency { + /** + * @internal + */ export const filterSensitiveLog = (obj: Latency): any => ({ ...obj, }); @@ -342,6 +372,9 @@ export interface StatusCodes { } export namespace StatusCodes { + /** + * @internal + */ export const filterSensitiveLog = (obj: StatusCodes): any => ({ ...obj, }); @@ -378,6 +411,9 @@ export interface ApplicationMetrics { } export namespace ApplicationMetrics { + /** + * @internal + */ export const filterSensitiveLog = (obj: ApplicationMetrics): any => ({ ...obj, }); @@ -396,6 +432,9 @@ export interface ApplicationResourceLifecycleDescriptionMessage { } export namespace ApplicationResourceLifecycleDescriptionMessage { + /** + * @internal + */ export const filterSensitiveLog = (obj: ApplicationResourceLifecycleDescriptionMessage): any => ({ ...obj, }); @@ -465,6 +504,9 @@ export interface SourceBuildInformation { } export namespace SourceBuildInformation { + /** + * @internal + */ export const filterSensitiveLog = (obj: SourceBuildInformation): any => ({ ...obj, }); @@ -486,6 +528,9 @@ export interface S3Location { } export namespace S3Location { + /** + * @internal + */ export const filterSensitiveLog = (obj: S3Location): any => ({ ...obj, }); @@ -579,6 +624,9 @@ export interface ApplicationVersionDescription { } export namespace ApplicationVersionDescription { + /** + * @internal + */ export const filterSensitiveLog = (obj: ApplicationVersionDescription): any => ({ ...obj, }); @@ -596,6 +644,9 @@ export interface ApplicationVersionDescriptionMessage { } export namespace ApplicationVersionDescriptionMessage { + /** + * @internal + */ export const filterSensitiveLog = (obj: ApplicationVersionDescriptionMessage): any => ({ ...obj, }); @@ -619,6 +670,9 @@ export interface ApplicationVersionDescriptionsMessage { } export namespace ApplicationVersionDescriptionsMessage { + /** + * @internal + */ export const filterSensitiveLog = (obj: ApplicationVersionDescriptionsMessage): any => ({ ...obj, }); @@ -645,6 +699,9 @@ export interface ApplyEnvironmentManagedActionRequest { } export namespace ApplyEnvironmentManagedActionRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ApplyEnvironmentManagedActionRequest): any => ({ ...obj, }); @@ -676,6 +733,9 @@ export interface ApplyEnvironmentManagedActionResult { } export namespace ApplyEnvironmentManagedActionResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: ApplyEnvironmentManagedActionResult): any => ({ ...obj, }); @@ -694,6 +754,9 @@ export interface ElasticBeanstalkServiceException extends __SmithyException, $Me } export namespace ElasticBeanstalkServiceException { + /** + * @internal + */ export const filterSensitiveLog = (obj: ElasticBeanstalkServiceException): any => ({ ...obj, }); @@ -712,6 +775,9 @@ export interface ManagedActionInvalidStateException extends __SmithyException, $ } export namespace ManagedActionInvalidStateException { + /** + * @internal + */ export const filterSensitiveLog = (obj: ManagedActionInvalidStateException): any => ({ ...obj, }); @@ -734,6 +800,9 @@ export interface AssociateEnvironmentOperationsRoleMessage { } export namespace AssociateEnvironmentOperationsRoleMessage { + /** + * @internal + */ export const filterSensitiveLog = (obj: AssociateEnvironmentOperationsRoleMessage): any => ({ ...obj, }); @@ -750,6 +819,9 @@ export interface AutoScalingGroup { } export namespace AutoScalingGroup { + /** + * @internal + */ export const filterSensitiveLog = (obj: AutoScalingGroup): any => ({ ...obj, }); @@ -771,6 +843,9 @@ export interface SolutionStackDescription { } export namespace SolutionStackDescription { + /** + * @internal + */ export const filterSensitiveLog = (obj: SolutionStackDescription): any => ({ ...obj, }); @@ -787,6 +862,9 @@ export interface CheckDNSAvailabilityMessage { } export namespace CheckDNSAvailabilityMessage { + /** + * @internal + */ export const filterSensitiveLog = (obj: CheckDNSAvailabilityMessage): any => ({ ...obj, }); @@ -819,6 +897,9 @@ export interface CheckDNSAvailabilityResultMessage { } export namespace CheckDNSAvailabilityResultMessage { + /** + * @internal + */ export const filterSensitiveLog = (obj: CheckDNSAvailabilityResultMessage): any => ({ ...obj, }); @@ -851,6 +932,9 @@ export interface ComposeEnvironmentsMessage { } export namespace ComposeEnvironmentsMessage { + /** + * @internal + */ export const filterSensitiveLog = (obj: ComposeEnvironmentsMessage): any => ({ ...obj, }); @@ -875,6 +959,9 @@ export interface EnvironmentLink { } export namespace EnvironmentLink { + /** + * @internal + */ export const filterSensitiveLog = (obj: EnvironmentLink): any => ({ ...obj, }); @@ -909,6 +996,9 @@ export interface Listener { } export namespace Listener { + /** + * @internal + */ export const filterSensitiveLog = (obj: Listener): any => ({ ...obj, }); @@ -935,6 +1025,9 @@ export interface LoadBalancerDescription { } export namespace LoadBalancerDescription { + /** + * @internal + */ export const filterSensitiveLog = (obj: LoadBalancerDescription): any => ({ ...obj, }); @@ -952,6 +1045,9 @@ export interface EnvironmentResourcesDescription { } export namespace EnvironmentResourcesDescription { + /** + * @internal + */ export const filterSensitiveLog = (obj: EnvironmentResourcesDescription): any => ({ ...obj, }); @@ -1015,6 +1111,9 @@ export interface EnvironmentTier { } export namespace EnvironmentTier { + /** + * @internal + */ export const filterSensitiveLog = (obj: EnvironmentTier): any => ({ ...obj, }); @@ -1191,6 +1290,9 @@ export interface EnvironmentDescription { } export namespace EnvironmentDescription { + /** + * @internal + */ export const filterSensitiveLog = (obj: EnvironmentDescription): any => ({ ...obj, }); @@ -1213,6 +1315,9 @@ export interface EnvironmentDescriptionsMessage { } export namespace EnvironmentDescriptionsMessage { + /** + * @internal + */ export const filterSensitiveLog = (obj: EnvironmentDescriptionsMessage): any => ({ ...obj, }); @@ -1231,6 +1336,9 @@ export interface TooManyEnvironmentsException extends __SmithyException, $Metada } export namespace TooManyEnvironmentsException { + /** + * @internal + */ export const filterSensitiveLog = (obj: TooManyEnvironmentsException): any => ({ ...obj, }); @@ -1252,6 +1360,9 @@ export interface Tag { } export namespace Tag { + /** + * @internal + */ export const filterSensitiveLog = (obj: Tag): any => ({ ...obj, }); @@ -1286,6 +1397,9 @@ export interface CreateApplicationMessage { } export namespace CreateApplicationMessage { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateApplicationMessage): any => ({ ...obj, }); @@ -1304,6 +1418,9 @@ export interface TooManyApplicationsException extends __SmithyException, $Metada } export namespace TooManyApplicationsException { + /** + * @internal + */ export const filterSensitiveLog = (obj: TooManyApplicationsException): any => ({ ...obj, }); @@ -1322,6 +1439,9 @@ export interface CodeBuildNotInServiceRegionException extends __SmithyException, } export namespace CodeBuildNotInServiceRegionException { + /** + * @internal + */ export const filterSensitiveLog = (obj: CodeBuildNotInServiceRegionException): any => ({ ...obj, }); @@ -1386,6 +1506,9 @@ export interface BuildConfiguration { } export namespace BuildConfiguration { + /** + * @internal + */ export const filterSensitiveLog = (obj: BuildConfiguration): any => ({ ...obj, }); @@ -1471,6 +1594,9 @@ export interface CreateApplicationVersionMessage { } export namespace CreateApplicationVersionMessage { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateApplicationVersionMessage): any => ({ ...obj, }); @@ -1501,6 +1627,9 @@ export interface S3LocationNotInServiceRegionException extends __SmithyException } export namespace S3LocationNotInServiceRegionException { + /** + * @internal + */ export const filterSensitiveLog = (obj: S3LocationNotInServiceRegionException): any => ({ ...obj, }); @@ -1519,6 +1648,9 @@ export interface TooManyApplicationVersionsException extends __SmithyException, } export namespace TooManyApplicationVersionsException { + /** + * @internal + */ export const filterSensitiveLog = (obj: TooManyApplicationVersionsException): any => ({ ...obj, }); @@ -1554,6 +1686,9 @@ export interface ConfigurationOptionSetting { } export namespace ConfigurationOptionSetting { + /** + * @internal + */ export const filterSensitiveLog = (obj: ConfigurationOptionSetting): any => ({ ...obj, }); @@ -1642,6 +1777,9 @@ export interface ConfigurationSettingsDescription { } export namespace ConfigurationSettingsDescription { + /** + * @internal + */ export const filterSensitiveLog = (obj: ConfigurationSettingsDescription): any => ({ ...obj, }); @@ -1663,6 +1801,9 @@ export interface SourceConfiguration { } export namespace SourceConfiguration { + /** + * @internal + */ export const filterSensitiveLog = (obj: SourceConfiguration): any => ({ ...obj, }); @@ -1754,6 +1895,9 @@ export interface CreateConfigurationTemplateMessage { } export namespace CreateConfigurationTemplateMessage { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateConfigurationTemplateMessage): any => ({ ...obj, }); @@ -1772,6 +1916,9 @@ export interface TooManyBucketsException extends __SmithyException, $MetadataBea } export namespace TooManyBucketsException { + /** + * @internal + */ export const filterSensitiveLog = (obj: TooManyBucketsException): any => ({ ...obj, }); @@ -1790,6 +1937,9 @@ export interface TooManyConfigurationTemplatesException extends __SmithyExceptio } export namespace TooManyConfigurationTemplatesException { + /** + * @internal + */ export const filterSensitiveLog = (obj: TooManyConfigurationTemplatesException): any => ({ ...obj, }); @@ -1816,6 +1966,9 @@ export interface OptionSpecification { } export namespace OptionSpecification { + /** + * @internal + */ export const filterSensitiveLog = (obj: OptionSpecification): any => ({ ...obj, }); @@ -1937,6 +2090,9 @@ export interface CreateEnvironmentMessage { } export namespace CreateEnvironmentMessage { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateEnvironmentMessage): any => ({ ...obj, }); @@ -1980,6 +2136,9 @@ export interface CreatePlatformVersionRequest { } export namespace CreatePlatformVersionRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreatePlatformVersionRequest): any => ({ ...obj, }); @@ -1996,6 +2155,9 @@ export interface Builder { } export namespace Builder { + /** + * @internal + */ export const filterSensitiveLog = (obj: Builder): any => ({ ...obj, }); @@ -2076,6 +2238,9 @@ export interface PlatformSummary { } export namespace PlatformSummary { + /** + * @internal + */ export const filterSensitiveLog = (obj: PlatformSummary): any => ({ ...obj, }); @@ -2094,6 +2259,9 @@ export interface CreatePlatformVersionResult { } export namespace CreatePlatformVersionResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreatePlatformVersionResult): any => ({ ...obj, }); @@ -2112,6 +2280,9 @@ export interface TooManyPlatformsException extends __SmithyException, $MetadataB } export namespace TooManyPlatformsException { + /** + * @internal + */ export const filterSensitiveLog = (obj: TooManyPlatformsException): any => ({ ...obj, }); @@ -2128,6 +2299,9 @@ export interface CreateStorageLocationResultMessage { } export namespace CreateStorageLocationResultMessage { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateStorageLocationResultMessage): any => ({ ...obj, }); @@ -2146,6 +2320,9 @@ export interface S3SubscriptionRequiredException extends __SmithyException, $Met } export namespace S3SubscriptionRequiredException { + /** + * @internal + */ export const filterSensitiveLog = (obj: S3SubscriptionRequiredException): any => ({ ...obj, }); @@ -2168,6 +2345,9 @@ export interface DeleteApplicationMessage { } export namespace DeleteApplicationMessage { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteApplicationMessage): any => ({ ...obj, }); @@ -2187,6 +2367,9 @@ export interface OperationInProgressException extends __SmithyException, $Metada } export namespace OperationInProgressException { + /** + * @internal + */ export const filterSensitiveLog = (obj: OperationInProgressException): any => ({ ...obj, }); @@ -2215,6 +2398,9 @@ export interface DeleteApplicationVersionMessage { } export namespace DeleteApplicationVersionMessage { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteApplicationVersionMessage): any => ({ ...obj, }); @@ -2234,6 +2420,9 @@ export interface SourceBundleDeletionException extends __SmithyException, $Metad } export namespace SourceBundleDeletionException { + /** + * @internal + */ export const filterSensitiveLog = (obj: SourceBundleDeletionException): any => ({ ...obj, }); @@ -2255,6 +2444,9 @@ export interface DeleteConfigurationTemplateMessage { } export namespace DeleteConfigurationTemplateMessage { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteConfigurationTemplateMessage): any => ({ ...obj, }); @@ -2276,6 +2468,9 @@ export interface DeleteEnvironmentConfigurationMessage { } export namespace DeleteEnvironmentConfigurationMessage { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteEnvironmentConfigurationMessage): any => ({ ...obj, }); @@ -2289,6 +2484,9 @@ export interface DeletePlatformVersionRequest { } export namespace DeletePlatformVersionRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeletePlatformVersionRequest): any => ({ ...obj, }); @@ -2302,6 +2500,9 @@ export interface DeletePlatformVersionResult { } export namespace DeletePlatformVersionResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeletePlatformVersionResult): any => ({ ...obj, }); @@ -2320,6 +2521,9 @@ export interface PlatformVersionStillReferencedException extends __SmithyExcepti } export namespace PlatformVersionStillReferencedException { + /** + * @internal + */ export const filterSensitiveLog = (obj: PlatformVersionStillReferencedException): any => ({ ...obj, }); @@ -2338,6 +2542,9 @@ export interface ResourceQuota { } export namespace ResourceQuota { + /** + * @internal + */ export const filterSensitiveLog = (obj: ResourceQuota): any => ({ ...obj, }); @@ -2375,6 +2582,9 @@ export interface ResourceQuotas { } export namespace ResourceQuotas { + /** + * @internal + */ export const filterSensitiveLog = (obj: ResourceQuotas): any => ({ ...obj, }); @@ -2388,6 +2598,9 @@ export interface DescribeAccountAttributesResult { } export namespace DescribeAccountAttributesResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeAccountAttributesResult): any => ({ ...obj, }); @@ -2405,6 +2618,9 @@ export interface DescribeApplicationsMessage { } export namespace DescribeApplicationsMessage { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeApplicationsMessage): any => ({ ...obj, }); @@ -2442,6 +2658,9 @@ export interface DescribeApplicationVersionsMessage { } export namespace DescribeApplicationVersionsMessage { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeApplicationVersionsMessage): any => ({ ...obj, }); @@ -2465,6 +2684,9 @@ export interface OptionRestrictionRegex { } export namespace OptionRestrictionRegex { + /** + * @internal + */ export const filterSensitiveLog = (obj: OptionRestrictionRegex): any => ({ ...obj, }); @@ -2597,6 +2819,9 @@ export interface ConfigurationOptionDescription { } export namespace ConfigurationOptionDescription { + /** + * @internal + */ export const filterSensitiveLog = (obj: ConfigurationOptionDescription): any => ({ ...obj, }); @@ -2623,6 +2848,9 @@ export interface ConfigurationOptionsDescription { } export namespace ConfigurationOptionsDescription { + /** + * @internal + */ export const filterSensitiveLog = (obj: ConfigurationOptionsDescription): any => ({ ...obj, }); @@ -2668,6 +2896,9 @@ export interface DescribeConfigurationOptionsMessage { } export namespace DescribeConfigurationOptionsMessage { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeConfigurationOptionsMessage): any => ({ ...obj, }); @@ -2685,6 +2916,9 @@ export interface ConfigurationSettingsDescriptions { } export namespace ConfigurationSettingsDescriptions { + /** + * @internal + */ export const filterSensitiveLog = (obj: ConfigurationSettingsDescriptions): any => ({ ...obj, }); @@ -2720,6 +2954,9 @@ export interface DescribeConfigurationSettingsMessage { } export namespace DescribeConfigurationSettingsMessage { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeConfigurationSettingsMessage): any => ({ ...obj, }); @@ -2761,6 +2998,9 @@ export interface DescribeEnvironmentHealthRequest { } export namespace DescribeEnvironmentHealthRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeEnvironmentHealthRequest): any => ({ ...obj, }); @@ -2828,6 +3068,9 @@ export interface InstanceHealthSummary { } export namespace InstanceHealthSummary { + /** + * @internal + */ export const filterSensitiveLog = (obj: InstanceHealthSummary): any => ({ ...obj, }); @@ -2883,6 +3126,9 @@ export interface DescribeEnvironmentHealthResult { } export namespace DescribeEnvironmentHealthResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeEnvironmentHealthResult): any => ({ ...obj, }); @@ -2902,6 +3148,9 @@ export interface InvalidRequestException extends __SmithyException, $MetadataBea } export namespace InvalidRequestException { + /** + * @internal + */ export const filterSensitiveLog = (obj: InvalidRequestException): any => ({ ...obj, }); @@ -2933,6 +3182,9 @@ export interface DescribeEnvironmentManagedActionHistoryRequest { } export namespace DescribeEnvironmentManagedActionHistoryRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeEnvironmentManagedActionHistoryRequest): any => ({ ...obj, }); @@ -2993,6 +3245,9 @@ export interface ManagedActionHistoryItem { } export namespace ManagedActionHistoryItem { + /** + * @internal + */ export const filterSensitiveLog = (obj: ManagedActionHistoryItem): any => ({ ...obj, }); @@ -3015,6 +3270,9 @@ export interface DescribeEnvironmentManagedActionHistoryResult { } export namespace DescribeEnvironmentManagedActionHistoryResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeEnvironmentManagedActionHistoryResult): any => ({ ...obj, }); @@ -3041,6 +3299,9 @@ export interface DescribeEnvironmentManagedActionsRequest { } export namespace DescribeEnvironmentManagedActionsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeEnvironmentManagedActionsRequest): any => ({ ...obj, }); @@ -3079,6 +3340,9 @@ export interface ManagedAction { } export namespace ManagedAction { + /** + * @internal + */ export const filterSensitiveLog = (obj: ManagedAction): any => ({ ...obj, }); @@ -3095,6 +3359,9 @@ export interface DescribeEnvironmentManagedActionsResult { } export namespace DescribeEnvironmentManagedActionsResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeEnvironmentManagedActionsResult): any => ({ ...obj, }); @@ -3122,6 +3389,9 @@ export interface DescribeEnvironmentResourcesMessage { } export namespace DescribeEnvironmentResourcesMessage { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeEnvironmentResourcesMessage): any => ({ ...obj, }); @@ -3138,6 +3408,9 @@ export interface Instance { } export namespace Instance { + /** + * @internal + */ export const filterSensitiveLog = (obj: Instance): any => ({ ...obj, }); @@ -3154,6 +3427,9 @@ export interface LaunchConfiguration { } export namespace LaunchConfiguration { + /** + * @internal + */ export const filterSensitiveLog = (obj: LaunchConfiguration): any => ({ ...obj, }); @@ -3170,6 +3446,9 @@ export interface LaunchTemplate { } export namespace LaunchTemplate { + /** + * @internal + */ export const filterSensitiveLog = (obj: LaunchTemplate): any => ({ ...obj, }); @@ -3186,6 +3465,9 @@ export interface LoadBalancer { } export namespace LoadBalancer { + /** + * @internal + */ export const filterSensitiveLog = (obj: LoadBalancer): any => ({ ...obj, }); @@ -3207,6 +3489,9 @@ export interface Queue { } export namespace Queue { + /** + * @internal + */ export const filterSensitiveLog = (obj: Queue): any => ({ ...obj, }); @@ -3223,6 +3508,9 @@ export interface Trigger { } export namespace Trigger { + /** + * @internal + */ export const filterSensitiveLog = (obj: Trigger): any => ({ ...obj, }); @@ -3274,6 +3562,9 @@ export interface EnvironmentResourceDescription { } export namespace EnvironmentResourceDescription { + /** + * @internal + */ export const filterSensitiveLog = (obj: EnvironmentResourceDescription): any => ({ ...obj, }); @@ -3290,6 +3581,9 @@ export interface EnvironmentResourceDescriptionsMessage { } export namespace EnvironmentResourceDescriptionsMessage { + /** + * @internal + */ export const filterSensitiveLog = (obj: EnvironmentResourceDescriptionsMessage): any => ({ ...obj, }); @@ -3356,6 +3650,9 @@ export interface DescribeEnvironmentsMessage { } export namespace DescribeEnvironmentsMessage { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeEnvironmentsMessage): any => ({ ...obj, }); @@ -3440,6 +3737,9 @@ export interface DescribeEventsMessage { } export namespace DescribeEventsMessage { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeEventsMessage): any => ({ ...obj, }); @@ -3496,6 +3796,9 @@ export interface EventDescription { } export namespace EventDescription { + /** + * @internal + */ export const filterSensitiveLog = (obj: EventDescription): any => ({ ...obj, }); @@ -3518,6 +3821,9 @@ export interface EventDescriptionsMessage { } export namespace EventDescriptionsMessage { + /** + * @internal + */ export const filterSensitiveLog = (obj: EventDescriptionsMessage): any => ({ ...obj, }); @@ -3565,6 +3871,9 @@ export interface DescribeInstancesHealthRequest { } export namespace DescribeInstancesHealthRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeInstancesHealthRequest): any => ({ ...obj, }); @@ -3612,6 +3921,9 @@ export interface Deployment { } export namespace Deployment { + /** + * @internal + */ export const filterSensitiveLog = (obj: Deployment): any => ({ ...obj, }); @@ -3677,6 +3989,9 @@ export interface CPUUtilization { } export namespace CPUUtilization { + /** + * @internal + */ export const filterSensitiveLog = (obj: CPUUtilization): any => ({ ...obj, }); @@ -3700,6 +4015,9 @@ export interface SystemStatus { } export namespace SystemStatus { + /** + * @internal + */ export const filterSensitiveLog = (obj: SystemStatus): any => ({ ...obj, }); @@ -3766,6 +4084,9 @@ export interface SingleInstanceHealth { } export namespace SingleInstanceHealth { + /** + * @internal + */ export const filterSensitiveLog = (obj: SingleInstanceHealth): any => ({ ...obj, }); @@ -3795,6 +4116,9 @@ export interface DescribeInstancesHealthResult { } export namespace DescribeInstancesHealthResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeInstancesHealthResult): any => ({ ...obj, }); @@ -3808,6 +4132,9 @@ export interface DescribePlatformVersionRequest { } export namespace DescribePlatformVersionRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribePlatformVersionRequest): any => ({ ...obj, }); @@ -3829,6 +4156,9 @@ export interface CustomAmi { } export namespace CustomAmi { + /** + * @internal + */ export const filterSensitiveLog = (obj: CustomAmi): any => ({ ...obj, }); @@ -3850,6 +4180,9 @@ export interface PlatformFramework { } export namespace PlatformFramework { + /** + * @internal + */ export const filterSensitiveLog = (obj: PlatformFramework): any => ({ ...obj, }); @@ -3871,6 +4204,9 @@ export interface PlatformProgrammingLanguage { } export namespace PlatformProgrammingLanguage { + /** + * @internal + */ export const filterSensitiveLog = (obj: PlatformProgrammingLanguage): any => ({ ...obj, }); @@ -3995,6 +4331,9 @@ export interface PlatformDescription { } export namespace PlatformDescription { + /** + * @internal + */ export const filterSensitiveLog = (obj: PlatformDescription): any => ({ ...obj, }); @@ -4008,6 +4347,9 @@ export interface DescribePlatformVersionResult { } export namespace DescribePlatformVersionResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribePlatformVersionResult): any => ({ ...obj, }); @@ -4024,6 +4366,9 @@ export interface DisassociateEnvironmentOperationsRoleMessage { } export namespace DisassociateEnvironmentOperationsRoleMessage { + /** + * @internal + */ export const filterSensitiveLog = (obj: DisassociateEnvironmentOperationsRoleMessage): any => ({ ...obj, }); @@ -4045,6 +4390,9 @@ export interface ListAvailableSolutionStacksResultMessage { } export namespace ListAvailableSolutionStacksResultMessage { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListAvailableSolutionStacksResultMessage): any => ({ ...obj, }); @@ -4085,6 +4433,9 @@ export interface SearchFilter { } export namespace SearchFilter { + /** + * @internal + */ export const filterSensitiveLog = (obj: SearchFilter): any => ({ ...obj, }); @@ -4180,6 +4531,9 @@ export interface ListPlatformBranchesRequest { } export namespace ListPlatformBranchesRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListPlatformBranchesRequest): any => ({ ...obj, }); @@ -4226,6 +4580,9 @@ export interface PlatformBranchSummary { } export namespace PlatformBranchSummary { + /** + * @internal + */ export const filterSensitiveLog = (obj: PlatformBranchSummary): any => ({ ...obj, }); @@ -4245,6 +4602,9 @@ export interface ListPlatformBranchesResult { } export namespace ListPlatformBranchesResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListPlatformBranchesResult): any => ({ ...obj, }); @@ -4312,6 +4672,9 @@ export interface PlatformFilter { } export namespace PlatformFilter { + /** + * @internal + */ export const filterSensitiveLog = (obj: PlatformFilter): any => ({ ...obj, }); @@ -4340,6 +4703,9 @@ export interface ListPlatformVersionsRequest { } export namespace ListPlatformVersionsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListPlatformVersionsRequest): any => ({ ...obj, }); @@ -4359,6 +4725,9 @@ export interface ListPlatformVersionsResult { } export namespace ListPlatformVersionsResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListPlatformVersionsResult): any => ({ ...obj, }); @@ -4373,6 +4742,9 @@ export interface ListTagsForResourceMessage { } export namespace ListTagsForResourceMessage { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListTagsForResourceMessage): any => ({ ...obj, }); @@ -4391,6 +4763,9 @@ export interface ResourceNotFoundException extends __SmithyException, $MetadataB } export namespace ResourceNotFoundException { + /** + * @internal + */ export const filterSensitiveLog = (obj: ResourceNotFoundException): any => ({ ...obj, }); @@ -4409,6 +4784,9 @@ export interface ResourceTagsDescriptionMessage { } export namespace ResourceTagsDescriptionMessage { + /** + * @internal + */ export const filterSensitiveLog = (obj: ResourceTagsDescriptionMessage): any => ({ ...obj, }); @@ -4427,6 +4805,9 @@ export interface ResourceTypeNotSupportedException extends __SmithyException, $M } export namespace ResourceTypeNotSupportedException { + /** + * @internal + */ export const filterSensitiveLog = (obj: ResourceTypeNotSupportedException): any => ({ ...obj, }); @@ -4454,6 +4835,9 @@ export interface RebuildEnvironmentMessage { } export namespace RebuildEnvironmentMessage { + /** + * @internal + */ export const filterSensitiveLog = (obj: RebuildEnvironmentMessage): any => ({ ...obj, }); @@ -4493,6 +4877,9 @@ export interface RequestEnvironmentInfoMessage { } export namespace RequestEnvironmentInfoMessage { + /** + * @internal + */ export const filterSensitiveLog = (obj: RequestEnvironmentInfoMessage): any => ({ ...obj, }); @@ -4520,6 +4907,9 @@ export interface RestartAppServerMessage { } export namespace RestartAppServerMessage { + /** + * @internal + */ export const filterSensitiveLog = (obj: RestartAppServerMessage): any => ({ ...obj, }); @@ -4555,6 +4945,9 @@ export interface RetrieveEnvironmentInfoMessage { } export namespace RetrieveEnvironmentInfoMessage { + /** + * @internal + */ export const filterSensitiveLog = (obj: RetrieveEnvironmentInfoMessage): any => ({ ...obj, }); @@ -4589,6 +4982,9 @@ export interface EnvironmentInfoDescription { } export namespace EnvironmentInfoDescription { + /** + * @internal + */ export const filterSensitiveLog = (obj: EnvironmentInfoDescription): any => ({ ...obj, }); @@ -4605,6 +5001,9 @@ export interface RetrieveEnvironmentInfoResultMessage { } export namespace RetrieveEnvironmentInfoResultMessage { + /** + * @internal + */ export const filterSensitiveLog = (obj: RetrieveEnvironmentInfoResultMessage): any => ({ ...obj, }); @@ -4651,6 +5050,9 @@ export interface SwapEnvironmentCNAMEsMessage { } export namespace SwapEnvironmentCNAMEsMessage { + /** + * @internal + */ export const filterSensitiveLog = (obj: SwapEnvironmentCNAMEsMessage): any => ({ ...obj, }); @@ -4708,6 +5110,9 @@ export interface TerminateEnvironmentMessage { } export namespace TerminateEnvironmentMessage { + /** + * @internal + */ export const filterSensitiveLog = (obj: TerminateEnvironmentMessage): any => ({ ...obj, }); @@ -4733,6 +5138,9 @@ export interface UpdateApplicationMessage { } export namespace UpdateApplicationMessage { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateApplicationMessage): any => ({ ...obj, }); @@ -4751,6 +5159,9 @@ export interface UpdateApplicationResourceLifecycleMessage { } export namespace UpdateApplicationResourceLifecycleMessage { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateApplicationResourceLifecycleMessage): any => ({ ...obj, }); @@ -4781,6 +5192,9 @@ export interface UpdateApplicationVersionMessage { } export namespace UpdateApplicationVersionMessage { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateApplicationVersionMessage): any => ({ ...obj, }); @@ -4826,6 +5240,9 @@ export interface UpdateConfigurationTemplateMessage { } export namespace UpdateConfigurationTemplateMessage { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateConfigurationTemplateMessage): any => ({ ...obj, }); @@ -4920,6 +5337,9 @@ export interface UpdateEnvironmentMessage { } export namespace UpdateEnvironmentMessage { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateEnvironmentMessage): any => ({ ...obj, }); @@ -4941,6 +5361,9 @@ export interface TooManyTagsException extends __SmithyException, $MetadataBearer } export namespace TooManyTagsException { + /** + * @internal + */ export const filterSensitiveLog = (obj: TooManyTagsException): any => ({ ...obj, }); @@ -4970,6 +5393,9 @@ export interface UpdateTagsForResourceMessage { } export namespace UpdateTagsForResourceMessage { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateTagsForResourceMessage): any => ({ ...obj, }); @@ -5015,6 +5441,9 @@ export interface ValidationMessage { } export namespace ValidationMessage { + /** + * @internal + */ export const filterSensitiveLog = (obj: ValidationMessage): any => ({ ...obj, }); @@ -5031,6 +5460,9 @@ export interface ConfigurationSettingsValidationMessages { } export namespace ConfigurationSettingsValidationMessages { + /** + * @internal + */ export const filterSensitiveLog = (obj: ConfigurationSettingsValidationMessages): any => ({ ...obj, }); @@ -5065,6 +5497,9 @@ export interface ValidateConfigurationSettingsMessage { } export namespace ValidateConfigurationSettingsMessage { + /** + * @internal + */ export const filterSensitiveLog = (obj: ValidateConfigurationSettingsMessage): any => ({ ...obj, }); diff --git a/clients/client-elastic-inference/commands/DescribeAcceleratorOfferingsCommand.ts b/clients/client-elastic-inference/commands/DescribeAcceleratorOfferingsCommand.ts index 0c9c8dcf12a8..aa66a26d37cd 100644 --- a/clients/client-elastic-inference/commands/DescribeAcceleratorOfferingsCommand.ts +++ b/clients/client-elastic-inference/commands/DescribeAcceleratorOfferingsCommand.ts @@ -26,6 +26,20 @@ export interface DescribeAcceleratorOfferingsCommandOutput *

* Describes the locations in which a given accelerator type or set of types is present in a given region. *

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ElasticInferenceClient, DescribeAcceleratorOfferingsCommand } from "@aws-sdk/client-elastic-inference"; // ES Modules import + * // const { ElasticInferenceClient, DescribeAcceleratorOfferingsCommand } = require("@aws-sdk/client-elastic-inference"); // CommonJS import + * const client = new ElasticInferenceClient(config); + * const command = new DescribeAcceleratorOfferingsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeAcceleratorOfferingsCommandInput} for command's `input` shape. + * @see {@link DescribeAcceleratorOfferingsCommandOutput} for command's `response` shape. + * @see {@link ElasticInferenceClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeAcceleratorOfferingsCommand extends $Command< DescribeAcceleratorOfferingsCommandInput, diff --git a/clients/client-elastic-inference/commands/DescribeAcceleratorTypesCommand.ts b/clients/client-elastic-inference/commands/DescribeAcceleratorTypesCommand.ts index eac85ad2a821..ac29f4e5dd01 100644 --- a/clients/client-elastic-inference/commands/DescribeAcceleratorTypesCommand.ts +++ b/clients/client-elastic-inference/commands/DescribeAcceleratorTypesCommand.ts @@ -24,6 +24,20 @@ export interface DescribeAcceleratorTypesCommandOutput extends DescribeAccelerat *

* Describes the accelerator types available in a given region, as well as their characteristics, such as memory and throughput. *

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ElasticInferenceClient, DescribeAcceleratorTypesCommand } from "@aws-sdk/client-elastic-inference"; // ES Modules import + * // const { ElasticInferenceClient, DescribeAcceleratorTypesCommand } = require("@aws-sdk/client-elastic-inference"); // CommonJS import + * const client = new ElasticInferenceClient(config); + * const command = new DescribeAcceleratorTypesCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeAcceleratorTypesCommandInput} for command's `input` shape. + * @see {@link DescribeAcceleratorTypesCommandOutput} for command's `response` shape. + * @see {@link ElasticInferenceClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeAcceleratorTypesCommand extends $Command< DescribeAcceleratorTypesCommandInput, diff --git a/clients/client-elastic-inference/commands/DescribeAcceleratorsCommand.ts b/clients/client-elastic-inference/commands/DescribeAcceleratorsCommand.ts index f8295ffcd0eb..390d5c2937e4 100644 --- a/clients/client-elastic-inference/commands/DescribeAcceleratorsCommand.ts +++ b/clients/client-elastic-inference/commands/DescribeAcceleratorsCommand.ts @@ -24,6 +24,20 @@ export interface DescribeAcceleratorsCommandOutput extends DescribeAcceleratorsR *

* Describes information over a provided set of accelerators belonging to an account. *

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ElasticInferenceClient, DescribeAcceleratorsCommand } from "@aws-sdk/client-elastic-inference"; // ES Modules import + * // const { ElasticInferenceClient, DescribeAcceleratorsCommand } = require("@aws-sdk/client-elastic-inference"); // CommonJS import + * const client = new ElasticInferenceClient(config); + * const command = new DescribeAcceleratorsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeAcceleratorsCommandInput} for command's `input` shape. + * @see {@link DescribeAcceleratorsCommandOutput} for command's `response` shape. + * @see {@link ElasticInferenceClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeAcceleratorsCommand extends $Command< DescribeAcceleratorsCommandInput, diff --git a/clients/client-elastic-inference/commands/ListTagsForResourceCommand.ts b/clients/client-elastic-inference/commands/ListTagsForResourceCommand.ts index 7269bbafbf3d..d09c61a4930e 100644 --- a/clients/client-elastic-inference/commands/ListTagsForResourceCommand.ts +++ b/clients/client-elastic-inference/commands/ListTagsForResourceCommand.ts @@ -24,6 +24,20 @@ export interface ListTagsForResourceCommandOutput extends ListTagsForResourceRes *

* Returns all tags of an Elastic Inference Accelerator. *

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ElasticInferenceClient, ListTagsForResourceCommand } from "@aws-sdk/client-elastic-inference"; // ES Modules import + * // const { ElasticInferenceClient, ListTagsForResourceCommand } = require("@aws-sdk/client-elastic-inference"); // CommonJS import + * const client = new ElasticInferenceClient(config); + * const command = new ListTagsForResourceCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListTagsForResourceCommandInput} for command's `input` shape. + * @see {@link ListTagsForResourceCommandOutput} for command's `response` shape. + * @see {@link ElasticInferenceClientResolvedConfig | config} for command's `input` shape. + * */ export class ListTagsForResourceCommand extends $Command< ListTagsForResourceCommandInput, diff --git a/clients/client-elastic-inference/commands/TagResourceCommand.ts b/clients/client-elastic-inference/commands/TagResourceCommand.ts index e55d59de6a28..71580581e90c 100644 --- a/clients/client-elastic-inference/commands/TagResourceCommand.ts +++ b/clients/client-elastic-inference/commands/TagResourceCommand.ts @@ -24,6 +24,20 @@ export interface TagResourceCommandOutput extends TagResourceResult, __MetadataB *

* Adds the specified tags to an Elastic Inference Accelerator. *

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ElasticInferenceClient, TagResourceCommand } from "@aws-sdk/client-elastic-inference"; // ES Modules import + * // const { ElasticInferenceClient, TagResourceCommand } = require("@aws-sdk/client-elastic-inference"); // CommonJS import + * const client = new ElasticInferenceClient(config); + * const command = new TagResourceCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link TagResourceCommandInput} for command's `input` shape. + * @see {@link TagResourceCommandOutput} for command's `response` shape. + * @see {@link ElasticInferenceClientResolvedConfig | config} for command's `input` shape. + * */ export class TagResourceCommand extends $Command< TagResourceCommandInput, diff --git a/clients/client-elastic-inference/commands/UntagResourceCommand.ts b/clients/client-elastic-inference/commands/UntagResourceCommand.ts index a66cca4e7bfe..4d3dbf14ba93 100644 --- a/clients/client-elastic-inference/commands/UntagResourceCommand.ts +++ b/clients/client-elastic-inference/commands/UntagResourceCommand.ts @@ -24,6 +24,20 @@ export interface UntagResourceCommandOutput extends UntagResourceResult, __Metad *

* Removes the specified tags from an Elastic Inference Accelerator. *

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ElasticInferenceClient, UntagResourceCommand } from "@aws-sdk/client-elastic-inference"; // ES Modules import + * // const { ElasticInferenceClient, UntagResourceCommand } = require("@aws-sdk/client-elastic-inference"); // CommonJS import + * const client = new ElasticInferenceClient(config); + * const command = new UntagResourceCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link UntagResourceCommandInput} for command's `input` shape. + * @see {@link UntagResourceCommandOutput} for command's `response` shape. + * @see {@link ElasticInferenceClientResolvedConfig | config} for command's `input` shape. + * */ export class UntagResourceCommand extends $Command< UntagResourceCommandInput, diff --git a/clients/client-elastic-inference/models/models_0.ts b/clients/client-elastic-inference/models/models_0.ts index fa3c6112a58c..20ad94a6b816 100644 --- a/clients/client-elastic-inference/models/models_0.ts +++ b/clients/client-elastic-inference/models/models_0.ts @@ -16,6 +16,9 @@ export interface MemoryInfo { } export namespace MemoryInfo { + /** + * @internal + */ export const filterSensitiveLog = (obj: MemoryInfo): any => ({ ...obj, }); @@ -45,6 +48,9 @@ export interface KeyValuePair { } export namespace KeyValuePair { + /** + * @internal + */ export const filterSensitiveLog = (obj: KeyValuePair): any => ({ ...obj, }); @@ -79,6 +85,9 @@ export interface AcceleratorType { } export namespace AcceleratorType { + /** + * @internal + */ export const filterSensitiveLog = (obj: AcceleratorType): any => ({ ...obj, }); @@ -119,6 +128,9 @@ export interface AcceleratorTypeOffering { } export namespace AcceleratorTypeOffering { + /** + * @internal + */ export const filterSensitiveLog = (obj: AcceleratorTypeOffering): any => ({ ...obj, }); @@ -136,6 +148,9 @@ export interface BadRequestException extends __SmithyException, $MetadataBearer } export namespace BadRequestException { + /** + * @internal + */ export const filterSensitiveLog = (obj: BadRequestException): any => ({ ...obj, }); @@ -161,6 +176,9 @@ export interface DescribeAcceleratorOfferingsRequest { } export namespace DescribeAcceleratorOfferingsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeAcceleratorOfferingsRequest): any => ({ ...obj, }); @@ -176,6 +194,9 @@ export interface DescribeAcceleratorOfferingsResponse { } export namespace DescribeAcceleratorOfferingsResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeAcceleratorOfferingsResponse): any => ({ ...obj, }); @@ -193,6 +214,9 @@ export interface InternalServerException extends __SmithyException, $MetadataBea } export namespace InternalServerException { + /** + * @internal + */ export const filterSensitiveLog = (obj: InternalServerException): any => ({ ...obj, }); @@ -210,6 +234,9 @@ export interface ResourceNotFoundException extends __SmithyException, $MetadataB } export namespace ResourceNotFoundException { + /** + * @internal + */ export const filterSensitiveLog = (obj: ResourceNotFoundException): any => ({ ...obj, }); @@ -239,6 +266,9 @@ export interface Filter { } export namespace Filter { + /** + * @internal + */ export const filterSensitiveLog = (obj: Filter): any => ({ ...obj, }); @@ -279,6 +309,9 @@ export interface DescribeAcceleratorsRequest { } export namespace DescribeAcceleratorsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeAcceleratorsRequest): any => ({ ...obj, }); @@ -299,6 +332,9 @@ export interface ElasticInferenceAcceleratorHealth { } export namespace ElasticInferenceAcceleratorHealth { + /** + * @internal + */ export const filterSensitiveLog = (obj: ElasticInferenceAcceleratorHealth): any => ({ ...obj, }); @@ -347,6 +383,9 @@ export interface ElasticInferenceAccelerator { } export namespace ElasticInferenceAccelerator { + /** + * @internal + */ export const filterSensitiveLog = (obj: ElasticInferenceAccelerator): any => ({ ...obj, }); @@ -369,6 +408,9 @@ export interface DescribeAcceleratorsResponse { } export namespace DescribeAcceleratorsResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeAcceleratorsResponse): any => ({ ...obj, }); @@ -377,6 +419,9 @@ export namespace DescribeAcceleratorsResponse { export interface DescribeAcceleratorTypesRequest {} export namespace DescribeAcceleratorTypesRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeAcceleratorTypesRequest): any => ({ ...obj, }); @@ -392,6 +437,9 @@ export interface DescribeAcceleratorTypesResponse { } export namespace DescribeAcceleratorTypesResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeAcceleratorTypesResponse): any => ({ ...obj, }); @@ -407,6 +455,9 @@ export interface ListTagsForResourceRequest { } export namespace ListTagsForResourceRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListTagsForResourceRequest): any => ({ ...obj, }); @@ -422,6 +473,9 @@ export interface ListTagsForResourceResult { } export namespace ListTagsForResourceResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListTagsForResourceResult): any => ({ ...obj, }); @@ -444,6 +498,9 @@ export interface TagResourceRequest { } export namespace TagResourceRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: TagResourceRequest): any => ({ ...obj, }); @@ -452,6 +509,9 @@ export namespace TagResourceRequest { export interface TagResourceResult {} export namespace TagResourceResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: TagResourceResult): any => ({ ...obj, }); @@ -474,6 +534,9 @@ export interface UntagResourceRequest { } export namespace UntagResourceRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: UntagResourceRequest): any => ({ ...obj, }); @@ -482,6 +545,9 @@ export namespace UntagResourceRequest { export interface UntagResourceResult {} export namespace UntagResourceResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: UntagResourceResult): any => ({ ...obj, }); diff --git a/clients/client-elastic-load-balancing-v2/commands/AddListenerCertificatesCommand.ts b/clients/client-elastic-load-balancing-v2/commands/AddListenerCertificatesCommand.ts index 3ce068785d32..b1f4bb98d82c 100644 --- a/clients/client-elastic-load-balancing-v2/commands/AddListenerCertificatesCommand.ts +++ b/clients/client-elastic-load-balancing-v2/commands/AddListenerCertificatesCommand.ts @@ -33,6 +33,20 @@ export interface AddListenerCertificatesCommandOutput extends AddListenerCertifi *

For more information, see HTTPS * listeners in the Application Load Balancers Guide or TLS * listeners in the Network Load Balancers Guide.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ElasticLoadBalancingV2Client, AddListenerCertificatesCommand } from "@aws-sdk/client-elastic-load-balancing-v2"; // ES Modules import + * // const { ElasticLoadBalancingV2Client, AddListenerCertificatesCommand } = require("@aws-sdk/client-elastic-load-balancing-v2"); // CommonJS import + * const client = new ElasticLoadBalancingV2Client(config); + * const command = new AddListenerCertificatesCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link AddListenerCertificatesCommandInput} for command's `input` shape. + * @see {@link AddListenerCertificatesCommandOutput} for command's `response` shape. + * @see {@link ElasticLoadBalancingV2ClientResolvedConfig | config} for command's `input` shape. + * */ export class AddListenerCertificatesCommand extends $Command< AddListenerCertificatesCommandInput, diff --git a/clients/client-elastic-load-balancing-v2/commands/AddTagsCommand.ts b/clients/client-elastic-load-balancing-v2/commands/AddTagsCommand.ts index cd35c3eefba1..9bd2fa7d6a65 100644 --- a/clients/client-elastic-load-balancing-v2/commands/AddTagsCommand.ts +++ b/clients/client-elastic-load-balancing-v2/commands/AddTagsCommand.ts @@ -27,6 +27,20 @@ export interface AddTagsCommandOutput extends AddTagsOutput, __MetadataBearer {} * 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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ElasticLoadBalancingV2Client, AddTagsCommand } from "@aws-sdk/client-elastic-load-balancing-v2"; // ES Modules import + * // const { ElasticLoadBalancingV2Client, AddTagsCommand } = require("@aws-sdk/client-elastic-load-balancing-v2"); // CommonJS import + * const client = new ElasticLoadBalancingV2Client(config); + * const command = new AddTagsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link AddTagsCommandInput} for command's `input` shape. + * @see {@link AddTagsCommandOutput} for command's `response` shape. + * @see {@link ElasticLoadBalancingV2ClientResolvedConfig | config} for command's `input` shape. + * */ export class AddTagsCommand extends $Command< AddTagsCommandInput, diff --git a/clients/client-elastic-load-balancing-v2/commands/CreateListenerCommand.ts b/clients/client-elastic-load-balancing-v2/commands/CreateListenerCommand.ts index 1c4da3f5f092..705cde429f5b 100644 --- a/clients/client-elastic-load-balancing-v2/commands/CreateListenerCommand.ts +++ b/clients/client-elastic-load-balancing-v2/commands/CreateListenerCommand.ts @@ -53,6 +53,20 @@ export interface CreateListenerCommandOutput extends CreateListenerOutput, __Met * *

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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ElasticLoadBalancingV2Client, CreateListenerCommand } from "@aws-sdk/client-elastic-load-balancing-v2"; // ES Modules import + * // const { ElasticLoadBalancingV2Client, CreateListenerCommand } = require("@aws-sdk/client-elastic-load-balancing-v2"); // CommonJS import + * const client = new ElasticLoadBalancingV2Client(config); + * const command = new CreateListenerCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreateListenerCommandInput} for command's `input` shape. + * @see {@link CreateListenerCommandOutput} for command's `response` shape. + * @see {@link ElasticLoadBalancingV2ClientResolvedConfig | config} for command's `input` shape. + * */ export class CreateListenerCommand extends $Command< CreateListenerCommandInput, diff --git a/clients/client-elastic-load-balancing-v2/commands/CreateLoadBalancerCommand.ts b/clients/client-elastic-load-balancing-v2/commands/CreateLoadBalancerCommand.ts index 20a36273d799..e4346d53bb61 100644 --- a/clients/client-elastic-load-balancing-v2/commands/CreateLoadBalancerCommand.ts +++ b/clients/client-elastic-load-balancing-v2/commands/CreateLoadBalancerCommand.ts @@ -53,6 +53,20 @@ export interface CreateLoadBalancerCommandOutput extends CreateLoadBalancerOutpu * *

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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ElasticLoadBalancingV2Client, CreateLoadBalancerCommand } from "@aws-sdk/client-elastic-load-balancing-v2"; // ES Modules import + * // const { ElasticLoadBalancingV2Client, CreateLoadBalancerCommand } = require("@aws-sdk/client-elastic-load-balancing-v2"); // CommonJS import + * const client = new ElasticLoadBalancingV2Client(config); + * const command = new CreateLoadBalancerCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreateLoadBalancerCommandInput} for command's `input` shape. + * @see {@link CreateLoadBalancerCommandOutput} for command's `response` shape. + * @see {@link ElasticLoadBalancingV2ClientResolvedConfig | config} for command's `input` shape. + * */ export class CreateLoadBalancerCommand extends $Command< CreateLoadBalancerCommandInput, diff --git a/clients/client-elastic-load-balancing-v2/commands/CreateRuleCommand.ts b/clients/client-elastic-load-balancing-v2/commands/CreateRuleCommand.ts index a87f9bcbb072..b8d7fc70277f 100644 --- a/clients/client-elastic-load-balancing-v2/commands/CreateRuleCommand.ts +++ b/clients/client-elastic-load-balancing-v2/commands/CreateRuleCommand.ts @@ -28,6 +28,20 @@ export interface CreateRuleCommandOutput extends CreateRuleOutput, __MetadataBea * 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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ElasticLoadBalancingV2Client, CreateRuleCommand } from "@aws-sdk/client-elastic-load-balancing-v2"; // ES Modules import + * // const { ElasticLoadBalancingV2Client, CreateRuleCommand } = require("@aws-sdk/client-elastic-load-balancing-v2"); // CommonJS import + * const client = new ElasticLoadBalancingV2Client(config); + * const command = new CreateRuleCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreateRuleCommandInput} for command's `input` shape. + * @see {@link CreateRuleCommandOutput} for command's `response` shape. + * @see {@link ElasticLoadBalancingV2ClientResolvedConfig | config} for command's `input` shape. + * */ export class CreateRuleCommand extends $Command< CreateRuleCommandInput, diff --git a/clients/client-elastic-load-balancing-v2/commands/CreateTargetGroupCommand.ts b/clients/client-elastic-load-balancing-v2/commands/CreateTargetGroupCommand.ts index 181762ad8719..e75de1c17df3 100644 --- a/clients/client-elastic-load-balancing-v2/commands/CreateTargetGroupCommand.ts +++ b/clients/client-elastic-load-balancing-v2/commands/CreateTargetGroupCommand.ts @@ -53,6 +53,20 @@ export interface CreateTargetGroupCommandOutput extends CreateTargetGroupOutput, * *

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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ElasticLoadBalancingV2Client, CreateTargetGroupCommand } from "@aws-sdk/client-elastic-load-balancing-v2"; // ES Modules import + * // const { ElasticLoadBalancingV2Client, CreateTargetGroupCommand } = require("@aws-sdk/client-elastic-load-balancing-v2"); // CommonJS import + * const client = new ElasticLoadBalancingV2Client(config); + * const command = new CreateTargetGroupCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreateTargetGroupCommandInput} for command's `input` shape. + * @see {@link CreateTargetGroupCommandOutput} for command's `response` shape. + * @see {@link ElasticLoadBalancingV2ClientResolvedConfig | config} for command's `input` shape. + * */ export class CreateTargetGroupCommand extends $Command< CreateTargetGroupCommandInput, diff --git a/clients/client-elastic-load-balancing-v2/commands/DeleteListenerCommand.ts b/clients/client-elastic-load-balancing-v2/commands/DeleteListenerCommand.ts index ded84a609947..36b204abb876 100644 --- a/clients/client-elastic-load-balancing-v2/commands/DeleteListenerCommand.ts +++ b/clients/client-elastic-load-balancing-v2/commands/DeleteListenerCommand.ts @@ -28,6 +28,20 @@ export interface DeleteListenerCommandOutput extends DeleteListenerOutput, __Met *

Deletes the specified listener.

*

Alternatively, your listener is deleted when you delete the load balancer to which it is * attached.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ElasticLoadBalancingV2Client, DeleteListenerCommand } from "@aws-sdk/client-elastic-load-balancing-v2"; // ES Modules import + * // const { ElasticLoadBalancingV2Client, DeleteListenerCommand } = require("@aws-sdk/client-elastic-load-balancing-v2"); // CommonJS import + * const client = new ElasticLoadBalancingV2Client(config); + * const command = new DeleteListenerCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteListenerCommandInput} for command's `input` shape. + * @see {@link DeleteListenerCommandOutput} for command's `response` shape. + * @see {@link ElasticLoadBalancingV2ClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteListenerCommand extends $Command< DeleteListenerCommandInput, diff --git a/clients/client-elastic-load-balancing-v2/commands/DeleteLoadBalancerCommand.ts b/clients/client-elastic-load-balancing-v2/commands/DeleteLoadBalancerCommand.ts index 3fcb35b82d22..bbd662a220c4 100644 --- a/clients/client-elastic-load-balancing-v2/commands/DeleteLoadBalancerCommand.ts +++ b/clients/client-elastic-load-balancing-v2/commands/DeleteLoadBalancerCommand.ts @@ -32,6 +32,20 @@ export interface DeleteLoadBalancerCommandOutput extends DeleteLoadBalancerOutpu *

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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ElasticLoadBalancingV2Client, DeleteLoadBalancerCommand } from "@aws-sdk/client-elastic-load-balancing-v2"; // ES Modules import + * // const { ElasticLoadBalancingV2Client, DeleteLoadBalancerCommand } = require("@aws-sdk/client-elastic-load-balancing-v2"); // CommonJS import + * const client = new ElasticLoadBalancingV2Client(config); + * const command = new DeleteLoadBalancerCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteLoadBalancerCommandInput} for command's `input` shape. + * @see {@link DeleteLoadBalancerCommandOutput} for command's `response` shape. + * @see {@link ElasticLoadBalancingV2ClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteLoadBalancerCommand extends $Command< DeleteLoadBalancerCommandInput, diff --git a/clients/client-elastic-load-balancing-v2/commands/DeleteRuleCommand.ts b/clients/client-elastic-load-balancing-v2/commands/DeleteRuleCommand.ts index 5b6f34d96020..e8959546f6d3 100644 --- a/clients/client-elastic-load-balancing-v2/commands/DeleteRuleCommand.ts +++ b/clients/client-elastic-load-balancing-v2/commands/DeleteRuleCommand.ts @@ -24,6 +24,20 @@ export interface DeleteRuleCommandOutput extends DeleteRuleOutput, __MetadataBea /** *

Deletes the specified rule.

*

You can't delete the default rule.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ElasticLoadBalancingV2Client, DeleteRuleCommand } from "@aws-sdk/client-elastic-load-balancing-v2"; // ES Modules import + * // const { ElasticLoadBalancingV2Client, DeleteRuleCommand } = require("@aws-sdk/client-elastic-load-balancing-v2"); // CommonJS import + * const client = new ElasticLoadBalancingV2Client(config); + * const command = new DeleteRuleCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteRuleCommandInput} for command's `input` shape. + * @see {@link DeleteRuleCommandOutput} for command's `response` shape. + * @see {@link ElasticLoadBalancingV2ClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteRuleCommand extends $Command< DeleteRuleCommandInput, diff --git a/clients/client-elastic-load-balancing-v2/commands/DeleteTargetGroupCommand.ts b/clients/client-elastic-load-balancing-v2/commands/DeleteTargetGroupCommand.ts index 7eec67da10fe..144c45084186 100644 --- a/clients/client-elastic-load-balancing-v2/commands/DeleteTargetGroupCommand.ts +++ b/clients/client-elastic-load-balancing-v2/commands/DeleteTargetGroupCommand.ts @@ -30,6 +30,20 @@ export interface DeleteTargetGroupCommandOutput extends DeleteTargetGroupOutput, * 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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ElasticLoadBalancingV2Client, DeleteTargetGroupCommand } from "@aws-sdk/client-elastic-load-balancing-v2"; // ES Modules import + * // const { ElasticLoadBalancingV2Client, DeleteTargetGroupCommand } = require("@aws-sdk/client-elastic-load-balancing-v2"); // CommonJS import + * const client = new ElasticLoadBalancingV2Client(config); + * const command = new DeleteTargetGroupCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteTargetGroupCommandInput} for command's `input` shape. + * @see {@link DeleteTargetGroupCommandOutput} for command's `response` shape. + * @see {@link ElasticLoadBalancingV2ClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteTargetGroupCommand extends $Command< DeleteTargetGroupCommandInput, diff --git a/clients/client-elastic-load-balancing-v2/commands/DeregisterTargetsCommand.ts b/clients/client-elastic-load-balancing-v2/commands/DeregisterTargetsCommand.ts index 3ff764b02578..68ddbb599ed8 100644 --- a/clients/client-elastic-load-balancing-v2/commands/DeregisterTargetsCommand.ts +++ b/clients/client-elastic-load-balancing-v2/commands/DeregisterTargetsCommand.ts @@ -27,6 +27,20 @@ export interface DeregisterTargetsCommandOutput extends DeregisterTargetsOutput, /** *

Deregisters the specified targets from the specified target group. After the targets are * deregistered, they no longer receive traffic from the load balancer.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ElasticLoadBalancingV2Client, DeregisterTargetsCommand } from "@aws-sdk/client-elastic-load-balancing-v2"; // ES Modules import + * // const { ElasticLoadBalancingV2Client, DeregisterTargetsCommand } = require("@aws-sdk/client-elastic-load-balancing-v2"); // CommonJS import + * const client = new ElasticLoadBalancingV2Client(config); + * const command = new DeregisterTargetsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeregisterTargetsCommandInput} for command's `input` shape. + * @see {@link DeregisterTargetsCommandOutput} for command's `response` shape. + * @see {@link ElasticLoadBalancingV2ClientResolvedConfig | config} for command's `input` shape. + * */ export class DeregisterTargetsCommand extends $Command< DeregisterTargetsCommandInput, diff --git a/clients/client-elastic-load-balancing-v2/commands/DescribeAccountLimitsCommand.ts b/clients/client-elastic-load-balancing-v2/commands/DescribeAccountLimitsCommand.ts index 27d88e374d11..64f9277b3c0a 100644 --- a/clients/client-elastic-load-balancing-v2/commands/DescribeAccountLimitsCommand.ts +++ b/clients/client-elastic-load-balancing-v2/commands/DescribeAccountLimitsCommand.ts @@ -47,6 +47,20 @@ export interface DescribeAccountLimitsCommandOutput extends DescribeAccountLimit *

* * + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ElasticLoadBalancingV2Client, DescribeAccountLimitsCommand } from "@aws-sdk/client-elastic-load-balancing-v2"; // ES Modules import + * // const { ElasticLoadBalancingV2Client, DescribeAccountLimitsCommand } = require("@aws-sdk/client-elastic-load-balancing-v2"); // CommonJS import + * const client = new ElasticLoadBalancingV2Client(config); + * const command = new DescribeAccountLimitsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeAccountLimitsCommandInput} for command's `input` shape. + * @see {@link DescribeAccountLimitsCommandOutput} for command's `response` shape. + * @see {@link ElasticLoadBalancingV2ClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeAccountLimitsCommand extends $Command< DescribeAccountLimitsCommandInput, diff --git a/clients/client-elastic-load-balancing-v2/commands/DescribeListenerCertificatesCommand.ts b/clients/client-elastic-load-balancing-v2/commands/DescribeListenerCertificatesCommand.ts index 6af6368925cf..ea09b3525aa5 100644 --- a/clients/client-elastic-load-balancing-v2/commands/DescribeListenerCertificatesCommand.ts +++ b/clients/client-elastic-load-balancing-v2/commands/DescribeListenerCertificatesCommand.ts @@ -35,6 +35,20 @@ export interface DescribeListenerCertificatesCommandOutput *

For more information, see SSL certificates in the Application Load Balancers Guide or * Server certificates in the Network Load Balancers * Guide.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ElasticLoadBalancingV2Client, DescribeListenerCertificatesCommand } from "@aws-sdk/client-elastic-load-balancing-v2"; // ES Modules import + * // const { ElasticLoadBalancingV2Client, DescribeListenerCertificatesCommand } = require("@aws-sdk/client-elastic-load-balancing-v2"); // CommonJS import + * const client = new ElasticLoadBalancingV2Client(config); + * const command = new DescribeListenerCertificatesCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeListenerCertificatesCommandInput} for command's `input` shape. + * @see {@link DescribeListenerCertificatesCommandOutput} for command's `response` shape. + * @see {@link ElasticLoadBalancingV2ClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeListenerCertificatesCommand extends $Command< DescribeListenerCertificatesCommandInput, diff --git a/clients/client-elastic-load-balancing-v2/commands/DescribeListenersCommand.ts b/clients/client-elastic-load-balancing-v2/commands/DescribeListenersCommand.ts index 1600d171762f..be25d2624e26 100644 --- a/clients/client-elastic-load-balancing-v2/commands/DescribeListenersCommand.ts +++ b/clients/client-elastic-load-balancing-v2/commands/DescribeListenersCommand.ts @@ -28,6 +28,20 @@ export interface DescribeListenersCommandOutput extends DescribeListenersOutput, *

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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ElasticLoadBalancingV2Client, DescribeListenersCommand } from "@aws-sdk/client-elastic-load-balancing-v2"; // ES Modules import + * // const { ElasticLoadBalancingV2Client, DescribeListenersCommand } = require("@aws-sdk/client-elastic-load-balancing-v2"); // CommonJS import + * const client = new ElasticLoadBalancingV2Client(config); + * const command = new DescribeListenersCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeListenersCommandInput} for command's `input` shape. + * @see {@link DescribeListenersCommandOutput} for command's `response` shape. + * @see {@link ElasticLoadBalancingV2ClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeListenersCommand extends $Command< DescribeListenersCommandInput, diff --git a/clients/client-elastic-load-balancing-v2/commands/DescribeLoadBalancerAttributesCommand.ts b/clients/client-elastic-load-balancing-v2/commands/DescribeLoadBalancerAttributesCommand.ts index 259b73a63c0b..d31827abc1b1 100644 --- a/clients/client-elastic-load-balancing-v2/commands/DescribeLoadBalancerAttributesCommand.ts +++ b/clients/client-elastic-load-balancing-v2/commands/DescribeLoadBalancerAttributesCommand.ts @@ -51,6 +51,20 @@ export interface DescribeLoadBalancerAttributesCommandOutput *

* * + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ElasticLoadBalancingV2Client, DescribeLoadBalancerAttributesCommand } from "@aws-sdk/client-elastic-load-balancing-v2"; // ES Modules import + * // const { ElasticLoadBalancingV2Client, DescribeLoadBalancerAttributesCommand } = require("@aws-sdk/client-elastic-load-balancing-v2"); // CommonJS import + * const client = new ElasticLoadBalancingV2Client(config); + * const command = new DescribeLoadBalancerAttributesCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeLoadBalancerAttributesCommandInput} for command's `input` shape. + * @see {@link DescribeLoadBalancerAttributesCommandOutput} for command's `response` shape. + * @see {@link ElasticLoadBalancingV2ClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeLoadBalancerAttributesCommand extends $Command< DescribeLoadBalancerAttributesCommandInput, diff --git a/clients/client-elastic-load-balancing-v2/commands/DescribeLoadBalancersCommand.ts b/clients/client-elastic-load-balancing-v2/commands/DescribeLoadBalancersCommand.ts index 0fc844221005..c95284a45e09 100644 --- a/clients/client-elastic-load-balancing-v2/commands/DescribeLoadBalancersCommand.ts +++ b/clients/client-elastic-load-balancing-v2/commands/DescribeLoadBalancersCommand.ts @@ -26,6 +26,20 @@ export interface DescribeLoadBalancersCommandOutput extends DescribeLoadBalancer /** *

Describes the specified load balancers or all of your load balancers.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ElasticLoadBalancingV2Client, DescribeLoadBalancersCommand } from "@aws-sdk/client-elastic-load-balancing-v2"; // ES Modules import + * // const { ElasticLoadBalancingV2Client, DescribeLoadBalancersCommand } = require("@aws-sdk/client-elastic-load-balancing-v2"); // CommonJS import + * const client = new ElasticLoadBalancingV2Client(config); + * const command = new DescribeLoadBalancersCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeLoadBalancersCommandInput} for command's `input` shape. + * @see {@link DescribeLoadBalancersCommandOutput} for command's `response` shape. + * @see {@link ElasticLoadBalancingV2ClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeLoadBalancersCommand extends $Command< DescribeLoadBalancersCommandInput, diff --git a/clients/client-elastic-load-balancing-v2/commands/DescribeRulesCommand.ts b/clients/client-elastic-load-balancing-v2/commands/DescribeRulesCommand.ts index 0e451309e75d..7afb5816ad0a 100644 --- a/clients/client-elastic-load-balancing-v2/commands/DescribeRulesCommand.ts +++ b/clients/client-elastic-load-balancing-v2/commands/DescribeRulesCommand.ts @@ -27,6 +27,20 @@ export interface DescribeRulesCommandOutput extends DescribeRulesOutput, __Metad /** *

Describes the specified rules or the rules for the specified listener. You must specify * either a listener or one or more rules.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ElasticLoadBalancingV2Client, DescribeRulesCommand } from "@aws-sdk/client-elastic-load-balancing-v2"; // ES Modules import + * // const { ElasticLoadBalancingV2Client, DescribeRulesCommand } = require("@aws-sdk/client-elastic-load-balancing-v2"); // CommonJS import + * const client = new ElasticLoadBalancingV2Client(config); + * const command = new DescribeRulesCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeRulesCommandInput} for command's `input` shape. + * @see {@link DescribeRulesCommandOutput} for command's `response` shape. + * @see {@link ElasticLoadBalancingV2ClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeRulesCommand extends $Command< DescribeRulesCommandInput, diff --git a/clients/client-elastic-load-balancing-v2/commands/DescribeSSLPoliciesCommand.ts b/clients/client-elastic-load-balancing-v2/commands/DescribeSSLPoliciesCommand.ts index f7863b63272d..078caabc3314 100644 --- a/clients/client-elastic-load-balancing-v2/commands/DescribeSSLPoliciesCommand.ts +++ b/clients/client-elastic-load-balancing-v2/commands/DescribeSSLPoliciesCommand.ts @@ -28,6 +28,20 @@ export interface DescribeSSLPoliciesCommandOutput extends DescribeSSLPoliciesOut *

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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ElasticLoadBalancingV2Client, DescribeSSLPoliciesCommand } from "@aws-sdk/client-elastic-load-balancing-v2"; // ES Modules import + * // const { ElasticLoadBalancingV2Client, DescribeSSLPoliciesCommand } = require("@aws-sdk/client-elastic-load-balancing-v2"); // CommonJS import + * const client = new ElasticLoadBalancingV2Client(config); + * const command = new DescribeSSLPoliciesCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeSSLPoliciesCommandInput} for command's `input` shape. + * @see {@link DescribeSSLPoliciesCommandOutput} for command's `response` shape. + * @see {@link ElasticLoadBalancingV2ClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeSSLPoliciesCommand extends $Command< DescribeSSLPoliciesCommandInput, diff --git a/clients/client-elastic-load-balancing-v2/commands/DescribeTagsCommand.ts b/clients/client-elastic-load-balancing-v2/commands/DescribeTagsCommand.ts index 7525867ff5ab..9ad0a5f2a795 100644 --- a/clients/client-elastic-load-balancing-v2/commands/DescribeTagsCommand.ts +++ b/clients/client-elastic-load-balancing-v2/commands/DescribeTagsCommand.ts @@ -25,6 +25,20 @@ export interface DescribeTagsCommandOutput extends DescribeTagsOutput, __Metadat *

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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ElasticLoadBalancingV2Client, DescribeTagsCommand } from "@aws-sdk/client-elastic-load-balancing-v2"; // ES Modules import + * // const { ElasticLoadBalancingV2Client, DescribeTagsCommand } = require("@aws-sdk/client-elastic-load-balancing-v2"); // CommonJS import + * const client = new ElasticLoadBalancingV2Client(config); + * const command = new DescribeTagsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeTagsCommandInput} for command's `input` shape. + * @see {@link DescribeTagsCommandOutput} for command's `response` shape. + * @see {@link ElasticLoadBalancingV2ClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeTagsCommand extends $Command< DescribeTagsCommandInput, diff --git a/clients/client-elastic-load-balancing-v2/commands/DescribeTargetGroupAttributesCommand.ts b/clients/client-elastic-load-balancing-v2/commands/DescribeTargetGroupAttributesCommand.ts index fa6fda211445..f20d98b5385d 100644 --- a/clients/client-elastic-load-balancing-v2/commands/DescribeTargetGroupAttributesCommand.ts +++ b/clients/client-elastic-load-balancing-v2/commands/DescribeTargetGroupAttributesCommand.ts @@ -49,6 +49,20 @@ export interface DescribeTargetGroupAttributesCommandOutput *

* * + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ElasticLoadBalancingV2Client, DescribeTargetGroupAttributesCommand } from "@aws-sdk/client-elastic-load-balancing-v2"; // ES Modules import + * // const { ElasticLoadBalancingV2Client, DescribeTargetGroupAttributesCommand } = require("@aws-sdk/client-elastic-load-balancing-v2"); // CommonJS import + * const client = new ElasticLoadBalancingV2Client(config); + * const command = new DescribeTargetGroupAttributesCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeTargetGroupAttributesCommandInput} for command's `input` shape. + * @see {@link DescribeTargetGroupAttributesCommandOutput} for command's `response` shape. + * @see {@link ElasticLoadBalancingV2ClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeTargetGroupAttributesCommand extends $Command< DescribeTargetGroupAttributesCommandInput, diff --git a/clients/client-elastic-load-balancing-v2/commands/DescribeTargetGroupsCommand.ts b/clients/client-elastic-load-balancing-v2/commands/DescribeTargetGroupsCommand.ts index e19336d6c957..e7e219be4e57 100644 --- a/clients/client-elastic-load-balancing-v2/commands/DescribeTargetGroupsCommand.ts +++ b/clients/client-elastic-load-balancing-v2/commands/DescribeTargetGroupsCommand.ts @@ -29,6 +29,20 @@ export interface DescribeTargetGroupsCommandOutput extends DescribeTargetGroupsO * 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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ElasticLoadBalancingV2Client, DescribeTargetGroupsCommand } from "@aws-sdk/client-elastic-load-balancing-v2"; // ES Modules import + * // const { ElasticLoadBalancingV2Client, DescribeTargetGroupsCommand } = require("@aws-sdk/client-elastic-load-balancing-v2"); // CommonJS import + * const client = new ElasticLoadBalancingV2Client(config); + * const command = new DescribeTargetGroupsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeTargetGroupsCommandInput} for command's `input` shape. + * @see {@link DescribeTargetGroupsCommandOutput} for command's `response` shape. + * @see {@link ElasticLoadBalancingV2ClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeTargetGroupsCommand extends $Command< DescribeTargetGroupsCommandInput, diff --git a/clients/client-elastic-load-balancing-v2/commands/DescribeTargetHealthCommand.ts b/clients/client-elastic-load-balancing-v2/commands/DescribeTargetHealthCommand.ts index 39eba73d1db5..105a05a5ee63 100644 --- a/clients/client-elastic-load-balancing-v2/commands/DescribeTargetHealthCommand.ts +++ b/clients/client-elastic-load-balancing-v2/commands/DescribeTargetHealthCommand.ts @@ -26,6 +26,20 @@ export interface DescribeTargetHealthCommandOutput extends DescribeTargetHealthO /** *

Describes the health of the specified targets or all of your targets.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ElasticLoadBalancingV2Client, DescribeTargetHealthCommand } from "@aws-sdk/client-elastic-load-balancing-v2"; // ES Modules import + * // const { ElasticLoadBalancingV2Client, DescribeTargetHealthCommand } = require("@aws-sdk/client-elastic-load-balancing-v2"); // CommonJS import + * const client = new ElasticLoadBalancingV2Client(config); + * const command = new DescribeTargetHealthCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeTargetHealthCommandInput} for command's `input` shape. + * @see {@link DescribeTargetHealthCommandOutput} for command's `response` shape. + * @see {@link ElasticLoadBalancingV2ClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeTargetHealthCommand extends $Command< DescribeTargetHealthCommandInput, diff --git a/clients/client-elastic-load-balancing-v2/commands/ModifyListenerCommand.ts b/clients/client-elastic-load-balancing-v2/commands/ModifyListenerCommand.ts index 2836635972ae..38df94436c1d 100644 --- a/clients/client-elastic-load-balancing-v2/commands/ModifyListenerCommand.ts +++ b/clients/client-elastic-load-balancing-v2/commands/ModifyListenerCommand.ts @@ -33,6 +33,20 @@ export interface ModifyListenerCommandOutput extends ModifyListenerOutput, __Met *

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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ElasticLoadBalancingV2Client, ModifyListenerCommand } from "@aws-sdk/client-elastic-load-balancing-v2"; // ES Modules import + * // const { ElasticLoadBalancingV2Client, ModifyListenerCommand } = require("@aws-sdk/client-elastic-load-balancing-v2"); // CommonJS import + * const client = new ElasticLoadBalancingV2Client(config); + * const command = new ModifyListenerCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ModifyListenerCommandInput} for command's `input` shape. + * @see {@link ModifyListenerCommandOutput} for command's `response` shape. + * @see {@link ElasticLoadBalancingV2ClientResolvedConfig | config} for command's `input` shape. + * */ export class ModifyListenerCommand extends $Command< ModifyListenerCommandInput, diff --git a/clients/client-elastic-load-balancing-v2/commands/ModifyLoadBalancerAttributesCommand.ts b/clients/client-elastic-load-balancing-v2/commands/ModifyLoadBalancerAttributesCommand.ts index 78090f5dca80..f018ac978c40 100644 --- a/clients/client-elastic-load-balancing-v2/commands/ModifyLoadBalancerAttributesCommand.ts +++ b/clients/client-elastic-load-balancing-v2/commands/ModifyLoadBalancerAttributesCommand.ts @@ -31,6 +31,20 @@ export interface ModifyLoadBalancerAttributesCommandOutput * 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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ElasticLoadBalancingV2Client, ModifyLoadBalancerAttributesCommand } from "@aws-sdk/client-elastic-load-balancing-v2"; // ES Modules import + * // const { ElasticLoadBalancingV2Client, ModifyLoadBalancerAttributesCommand } = require("@aws-sdk/client-elastic-load-balancing-v2"); // CommonJS import + * const client = new ElasticLoadBalancingV2Client(config); + * const command = new ModifyLoadBalancerAttributesCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ModifyLoadBalancerAttributesCommandInput} for command's `input` shape. + * @see {@link ModifyLoadBalancerAttributesCommandOutput} for command's `response` shape. + * @see {@link ElasticLoadBalancingV2ClientResolvedConfig | config} for command's `input` shape. + * */ export class ModifyLoadBalancerAttributesCommand extends $Command< ModifyLoadBalancerAttributesCommandInput, diff --git a/clients/client-elastic-load-balancing-v2/commands/ModifyRuleCommand.ts b/clients/client-elastic-load-balancing-v2/commands/ModifyRuleCommand.ts index 1cdb8d989b96..823c1352ff7e 100644 --- a/clients/client-elastic-load-balancing-v2/commands/ModifyRuleCommand.ts +++ b/clients/client-elastic-load-balancing-v2/commands/ModifyRuleCommand.ts @@ -27,6 +27,20 @@ export interface ModifyRuleCommandOutput extends ModifyRuleOutput, __MetadataBea *

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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ElasticLoadBalancingV2Client, ModifyRuleCommand } from "@aws-sdk/client-elastic-load-balancing-v2"; // ES Modules import + * // const { ElasticLoadBalancingV2Client, ModifyRuleCommand } = require("@aws-sdk/client-elastic-load-balancing-v2"); // CommonJS import + * const client = new ElasticLoadBalancingV2Client(config); + * const command = new ModifyRuleCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ModifyRuleCommandInput} for command's `input` shape. + * @see {@link ModifyRuleCommandOutput} for command's `response` shape. + * @see {@link ElasticLoadBalancingV2ClientResolvedConfig | config} for command's `input` shape. + * */ export class ModifyRuleCommand extends $Command< ModifyRuleCommandInput, diff --git a/clients/client-elastic-load-balancing-v2/commands/ModifyTargetGroupAttributesCommand.ts b/clients/client-elastic-load-balancing-v2/commands/ModifyTargetGroupAttributesCommand.ts index 2f2b8fb54043..127a98082ac0 100644 --- a/clients/client-elastic-load-balancing-v2/commands/ModifyTargetGroupAttributesCommand.ts +++ b/clients/client-elastic-load-balancing-v2/commands/ModifyTargetGroupAttributesCommand.ts @@ -26,6 +26,20 @@ export interface ModifyTargetGroupAttributesCommandOutput extends ModifyTargetGr /** *

Modifies the specified attributes of the specified target group.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ElasticLoadBalancingV2Client, ModifyTargetGroupAttributesCommand } from "@aws-sdk/client-elastic-load-balancing-v2"; // ES Modules import + * // const { ElasticLoadBalancingV2Client, ModifyTargetGroupAttributesCommand } = require("@aws-sdk/client-elastic-load-balancing-v2"); // CommonJS import + * const client = new ElasticLoadBalancingV2Client(config); + * const command = new ModifyTargetGroupAttributesCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ModifyTargetGroupAttributesCommandInput} for command's `input` shape. + * @see {@link ModifyTargetGroupAttributesCommandOutput} for command's `response` shape. + * @see {@link ElasticLoadBalancingV2ClientResolvedConfig | config} for command's `input` shape. + * */ export class ModifyTargetGroupAttributesCommand extends $Command< ModifyTargetGroupAttributesCommandInput, diff --git a/clients/client-elastic-load-balancing-v2/commands/ModifyTargetGroupCommand.ts b/clients/client-elastic-load-balancing-v2/commands/ModifyTargetGroupCommand.ts index f797c31112fe..cb621a9e0aae 100644 --- a/clients/client-elastic-load-balancing-v2/commands/ModifyTargetGroupCommand.ts +++ b/clients/client-elastic-load-balancing-v2/commands/ModifyTargetGroupCommand.ts @@ -27,6 +27,20 @@ export interface ModifyTargetGroupCommandOutput extends ModifyTargetGroupOutput, /** *

Modifies the health checks used when evaluating the health state of the targets in the * specified target group.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ElasticLoadBalancingV2Client, ModifyTargetGroupCommand } from "@aws-sdk/client-elastic-load-balancing-v2"; // ES Modules import + * // const { ElasticLoadBalancingV2Client, ModifyTargetGroupCommand } = require("@aws-sdk/client-elastic-load-balancing-v2"); // CommonJS import + * const client = new ElasticLoadBalancingV2Client(config); + * const command = new ModifyTargetGroupCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ModifyTargetGroupCommandInput} for command's `input` shape. + * @see {@link ModifyTargetGroupCommandOutput} for command's `response` shape. + * @see {@link ElasticLoadBalancingV2ClientResolvedConfig | config} for command's `input` shape. + * */ export class ModifyTargetGroupCommand extends $Command< ModifyTargetGroupCommandInput, diff --git a/clients/client-elastic-load-balancing-v2/commands/RegisterTargetsCommand.ts b/clients/client-elastic-load-balancing-v2/commands/RegisterTargetsCommand.ts index 8f179257f073..87c0668fc624 100644 --- a/clients/client-elastic-load-balancing-v2/commands/RegisterTargetsCommand.ts +++ b/clients/client-elastic-load-balancing-v2/commands/RegisterTargetsCommand.ts @@ -38,6 +38,20 @@ export interface RegisterTargetsCommandOutput extends RegisterTargetsOutput, __M *

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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ElasticLoadBalancingV2Client, RegisterTargetsCommand } from "@aws-sdk/client-elastic-load-balancing-v2"; // ES Modules import + * // const { ElasticLoadBalancingV2Client, RegisterTargetsCommand } = require("@aws-sdk/client-elastic-load-balancing-v2"); // CommonJS import + * const client = new ElasticLoadBalancingV2Client(config); + * const command = new RegisterTargetsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link RegisterTargetsCommandInput} for command's `input` shape. + * @see {@link RegisterTargetsCommandOutput} for command's `response` shape. + * @see {@link ElasticLoadBalancingV2ClientResolvedConfig | config} for command's `input` shape. + * */ export class RegisterTargetsCommand extends $Command< RegisterTargetsCommandInput, diff --git a/clients/client-elastic-load-balancing-v2/commands/RemoveListenerCertificatesCommand.ts b/clients/client-elastic-load-balancing-v2/commands/RemoveListenerCertificatesCommand.ts index f0aab91b8257..4fc003ffbd20 100644 --- a/clients/client-elastic-load-balancing-v2/commands/RemoveListenerCertificatesCommand.ts +++ b/clients/client-elastic-load-balancing-v2/commands/RemoveListenerCertificatesCommand.ts @@ -27,6 +27,20 @@ export interface RemoveListenerCertificatesCommandOutput extends RemoveListenerC /** *

Removes the specified certificate from the certificate list for the specified HTTPS or TLS * listener.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ElasticLoadBalancingV2Client, RemoveListenerCertificatesCommand } from "@aws-sdk/client-elastic-load-balancing-v2"; // ES Modules import + * // const { ElasticLoadBalancingV2Client, RemoveListenerCertificatesCommand } = require("@aws-sdk/client-elastic-load-balancing-v2"); // CommonJS import + * const client = new ElasticLoadBalancingV2Client(config); + * const command = new RemoveListenerCertificatesCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link RemoveListenerCertificatesCommandInput} for command's `input` shape. + * @see {@link RemoveListenerCertificatesCommandOutput} for command's `response` shape. + * @see {@link ElasticLoadBalancingV2ClientResolvedConfig | config} for command's `input` shape. + * */ export class RemoveListenerCertificatesCommand extends $Command< RemoveListenerCertificatesCommandInput, diff --git a/clients/client-elastic-load-balancing-v2/commands/RemoveTagsCommand.ts b/clients/client-elastic-load-balancing-v2/commands/RemoveTagsCommand.ts index aba16a43e271..58d111a278d1 100644 --- a/clients/client-elastic-load-balancing-v2/commands/RemoveTagsCommand.ts +++ b/clients/client-elastic-load-balancing-v2/commands/RemoveTagsCommand.ts @@ -25,6 +25,20 @@ export interface RemoveTagsCommandOutput extends RemoveTagsOutput, __MetadataBea *

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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ElasticLoadBalancingV2Client, RemoveTagsCommand } from "@aws-sdk/client-elastic-load-balancing-v2"; // ES Modules import + * // const { ElasticLoadBalancingV2Client, RemoveTagsCommand } = require("@aws-sdk/client-elastic-load-balancing-v2"); // CommonJS import + * const client = new ElasticLoadBalancingV2Client(config); + * const command = new RemoveTagsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link RemoveTagsCommandInput} for command's `input` shape. + * @see {@link RemoveTagsCommandOutput} for command's `response` shape. + * @see {@link ElasticLoadBalancingV2ClientResolvedConfig | config} for command's `input` shape. + * */ export class RemoveTagsCommand extends $Command< RemoveTagsCommandInput, diff --git a/clients/client-elastic-load-balancing-v2/commands/SetIpAddressTypeCommand.ts b/clients/client-elastic-load-balancing-v2/commands/SetIpAddressTypeCommand.ts index d5baef6e8540..8278ef569c6c 100644 --- a/clients/client-elastic-load-balancing-v2/commands/SetIpAddressTypeCommand.ts +++ b/clients/client-elastic-load-balancing-v2/commands/SetIpAddressTypeCommand.ts @@ -27,6 +27,20 @@ export interface SetIpAddressTypeCommandOutput extends SetIpAddressTypeOutput, _ /** *

Sets the type of IP addresses used by the subnets of the specified Application Load * Balancer or Network Load Balancer.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ElasticLoadBalancingV2Client, SetIpAddressTypeCommand } from "@aws-sdk/client-elastic-load-balancing-v2"; // ES Modules import + * // const { ElasticLoadBalancingV2Client, SetIpAddressTypeCommand } = require("@aws-sdk/client-elastic-load-balancing-v2"); // CommonJS import + * const client = new ElasticLoadBalancingV2Client(config); + * const command = new SetIpAddressTypeCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link SetIpAddressTypeCommandInput} for command's `input` shape. + * @see {@link SetIpAddressTypeCommandOutput} for command's `response` shape. + * @see {@link ElasticLoadBalancingV2ClientResolvedConfig | config} for command's `input` shape. + * */ export class SetIpAddressTypeCommand extends $Command< SetIpAddressTypeCommandInput, diff --git a/clients/client-elastic-load-balancing-v2/commands/SetRulePrioritiesCommand.ts b/clients/client-elastic-load-balancing-v2/commands/SetRulePrioritiesCommand.ts index ad523f1c92a1..f6a68d24676d 100644 --- a/clients/client-elastic-load-balancing-v2/commands/SetRulePrioritiesCommand.ts +++ b/clients/client-elastic-load-balancing-v2/commands/SetRulePrioritiesCommand.ts @@ -28,6 +28,20 @@ export interface SetRulePrioritiesCommandOutput extends SetRulePrioritiesOutput, *

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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ElasticLoadBalancingV2Client, SetRulePrioritiesCommand } from "@aws-sdk/client-elastic-load-balancing-v2"; // ES Modules import + * // const { ElasticLoadBalancingV2Client, SetRulePrioritiesCommand } = require("@aws-sdk/client-elastic-load-balancing-v2"); // CommonJS import + * const client = new ElasticLoadBalancingV2Client(config); + * const command = new SetRulePrioritiesCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link SetRulePrioritiesCommandInput} for command's `input` shape. + * @see {@link SetRulePrioritiesCommandOutput} for command's `response` shape. + * @see {@link ElasticLoadBalancingV2ClientResolvedConfig | config} for command's `input` shape. + * */ export class SetRulePrioritiesCommand extends $Command< SetRulePrioritiesCommandInput, diff --git a/clients/client-elastic-load-balancing-v2/commands/SetSecurityGroupsCommand.ts b/clients/client-elastic-load-balancing-v2/commands/SetSecurityGroupsCommand.ts index 7e0d2ade3934..b1845e9757f7 100644 --- a/clients/client-elastic-load-balancing-v2/commands/SetSecurityGroupsCommand.ts +++ b/clients/client-elastic-load-balancing-v2/commands/SetSecurityGroupsCommand.ts @@ -29,6 +29,20 @@ export interface SetSecurityGroupsCommandOutput extends SetSecurityGroupsOutput, * 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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ElasticLoadBalancingV2Client, SetSecurityGroupsCommand } from "@aws-sdk/client-elastic-load-balancing-v2"; // ES Modules import + * // const { ElasticLoadBalancingV2Client, SetSecurityGroupsCommand } = require("@aws-sdk/client-elastic-load-balancing-v2"); // CommonJS import + * const client = new ElasticLoadBalancingV2Client(config); + * const command = new SetSecurityGroupsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link SetSecurityGroupsCommandInput} for command's `input` shape. + * @see {@link SetSecurityGroupsCommandOutput} for command's `response` shape. + * @see {@link ElasticLoadBalancingV2ClientResolvedConfig | config} for command's `input` shape. + * */ export class SetSecurityGroupsCommand extends $Command< SetSecurityGroupsCommandInput, diff --git a/clients/client-elastic-load-balancing-v2/commands/SetSubnetsCommand.ts b/clients/client-elastic-load-balancing-v2/commands/SetSubnetsCommand.ts index 406ed3dd0ae2..888f1d153894 100644 --- a/clients/client-elastic-load-balancing-v2/commands/SetSubnetsCommand.ts +++ b/clients/client-elastic-load-balancing-v2/commands/SetSubnetsCommand.ts @@ -28,6 +28,20 @@ export interface SetSubnetsCommandOutput extends SetSubnetsOutput, __MetadataBea *

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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ElasticLoadBalancingV2Client, SetSubnetsCommand } from "@aws-sdk/client-elastic-load-balancing-v2"; // ES Modules import + * // const { ElasticLoadBalancingV2Client, SetSubnetsCommand } = require("@aws-sdk/client-elastic-load-balancing-v2"); // CommonJS import + * const client = new ElasticLoadBalancingV2Client(config); + * const command = new SetSubnetsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link SetSubnetsCommandInput} for command's `input` shape. + * @see {@link SetSubnetsCommandOutput} for command's `response` shape. + * @see {@link ElasticLoadBalancingV2ClientResolvedConfig | config} for command's `input` shape. + * */ export class SetSubnetsCommand extends $Command< SetSubnetsCommandInput, diff --git a/clients/client-elastic-load-balancing-v2/models/models_0.ts b/clients/client-elastic-load-balancing-v2/models/models_0.ts index f51222892f86..8f0114c96532 100644 --- a/clients/client-elastic-load-balancing-v2/models/models_0.ts +++ b/clients/client-elastic-load-balancing-v2/models/models_0.ts @@ -72,6 +72,9 @@ export interface AuthenticateCognitoActionConfig { } export namespace AuthenticateCognitoActionConfig { + /** + * @internal + */ export const filterSensitiveLog = (obj: AuthenticateCognitoActionConfig): any => ({ ...obj, }); @@ -175,6 +178,9 @@ export interface AuthenticateOidcActionConfig { } export namespace AuthenticateOidcActionConfig { + /** + * @internal + */ export const filterSensitiveLog = (obj: AuthenticateOidcActionConfig): any => ({ ...obj, }); @@ -203,6 +209,9 @@ export interface FixedResponseActionConfig { } export namespace FixedResponseActionConfig { + /** + * @internal + */ export const filterSensitiveLog = (obj: FixedResponseActionConfig): any => ({ ...obj, }); @@ -225,6 +234,9 @@ export interface TargetGroupTuple { } export namespace TargetGroupTuple { + /** + * @internal + */ export const filterSensitiveLog = (obj: TargetGroupTuple): any => ({ ...obj, }); @@ -247,6 +259,9 @@ export interface TargetGroupStickinessConfig { } export namespace TargetGroupStickinessConfig { + /** + * @internal + */ export const filterSensitiveLog = (obj: TargetGroupStickinessConfig): any => ({ ...obj, }); @@ -269,6 +284,9 @@ export interface ForwardActionConfig { } export namespace ForwardActionConfig { + /** + * @internal + */ export const filterSensitiveLog = (obj: ForwardActionConfig): any => ({ ...obj, }); @@ -344,6 +362,9 @@ export interface RedirectActionConfig { } export namespace RedirectActionConfig { + /** + * @internal + */ export const filterSensitiveLog = (obj: RedirectActionConfig): any => ({ ...obj, }); @@ -418,6 +439,9 @@ export interface Action { } export namespace Action { + /** + * @internal + */ export const filterSensitiveLog = (obj: Action): any => ({ ...obj, }); @@ -441,6 +465,9 @@ export interface Certificate { } export namespace Certificate { + /** + * @internal + */ export const filterSensitiveLog = (obj: Certificate): any => ({ ...obj, }); @@ -461,6 +488,9 @@ export interface AddListenerCertificatesInput { } export namespace AddListenerCertificatesInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: AddListenerCertificatesInput): any => ({ ...obj, }); @@ -474,6 +504,9 @@ export interface AddListenerCertificatesOutput { } export namespace AddListenerCertificatesOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: AddListenerCertificatesOutput): any => ({ ...obj, }); @@ -489,6 +522,9 @@ export interface CertificateNotFoundException extends __SmithyException, $Metada } export namespace CertificateNotFoundException { + /** + * @internal + */ export const filterSensitiveLog = (obj: CertificateNotFoundException): any => ({ ...obj, }); @@ -504,6 +540,9 @@ export interface ListenerNotFoundException extends __SmithyException, $MetadataB } export namespace ListenerNotFoundException { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListenerNotFoundException): any => ({ ...obj, }); @@ -519,6 +558,9 @@ export interface TooManyCertificatesException extends __SmithyException, $Metada } export namespace TooManyCertificatesException { + /** + * @internal + */ export const filterSensitiveLog = (obj: TooManyCertificatesException): any => ({ ...obj, }); @@ -540,6 +582,9 @@ export interface Tag { } export namespace Tag { + /** + * @internal + */ export const filterSensitiveLog = (obj: Tag): any => ({ ...obj, }); @@ -558,6 +603,9 @@ export interface AddTagsInput { } export namespace AddTagsInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: AddTagsInput): any => ({ ...obj, }); @@ -566,6 +614,9 @@ export namespace AddTagsInput { export interface AddTagsOutput {} export namespace AddTagsOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: AddTagsOutput): any => ({ ...obj, }); @@ -581,6 +632,9 @@ export interface DuplicateTagKeysException extends __SmithyException, $MetadataB } export namespace DuplicateTagKeysException { + /** + * @internal + */ export const filterSensitiveLog = (obj: DuplicateTagKeysException): any => ({ ...obj, }); @@ -596,6 +650,9 @@ export interface LoadBalancerNotFoundException extends __SmithyException, $Metad } export namespace LoadBalancerNotFoundException { + /** + * @internal + */ export const filterSensitiveLog = (obj: LoadBalancerNotFoundException): any => ({ ...obj, }); @@ -611,6 +668,9 @@ export interface TargetGroupNotFoundException extends __SmithyException, $Metada } export namespace TargetGroupNotFoundException { + /** + * @internal + */ export const filterSensitiveLog = (obj: TargetGroupNotFoundException): any => ({ ...obj, }); @@ -626,6 +686,9 @@ export interface TooManyTagsException extends __SmithyException, $MetadataBearer } export namespace TooManyTagsException { + /** + * @internal + */ export const filterSensitiveLog = (obj: TooManyTagsException): any => ({ ...obj, }); @@ -641,6 +704,9 @@ export interface AllocationIdNotFoundException extends __SmithyException, $Metad } export namespace AllocationIdNotFoundException { + /** + * @internal + */ export const filterSensitiveLog = (obj: AllocationIdNotFoundException): any => ({ ...obj, }); @@ -656,6 +722,9 @@ export interface ALPNPolicyNotSupportedException extends __SmithyException, $Met } export namespace ALPNPolicyNotSupportedException { + /** + * @internal + */ export const filterSensitiveLog = (obj: ALPNPolicyNotSupportedException): any => ({ ...obj, }); @@ -688,6 +757,9 @@ export interface LoadBalancerAddress { } export namespace LoadBalancerAddress { + /** + * @internal + */ export const filterSensitiveLog = (obj: LoadBalancerAddress): any => ({ ...obj, }); @@ -722,6 +794,9 @@ export interface AvailabilityZone { } export namespace AvailabilityZone { + /** + * @internal + */ export const filterSensitiveLog = (obj: AvailabilityZone): any => ({ ...obj, }); @@ -737,6 +812,9 @@ export interface AvailabilityZoneNotSupportedException extends __SmithyException } export namespace AvailabilityZoneNotSupportedException { + /** + * @internal + */ export const filterSensitiveLog = (obj: AvailabilityZoneNotSupportedException): any => ({ ...obj, }); @@ -758,6 +836,9 @@ export interface Cipher { } export namespace Cipher { + /** + * @internal + */ export const filterSensitiveLog = (obj: Cipher): any => ({ ...obj, }); @@ -848,6 +929,9 @@ export interface CreateListenerInput { } export namespace CreateListenerInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateListenerInput): any => ({ ...obj, }); @@ -901,6 +985,9 @@ export interface Listener { } export namespace Listener { + /** + * @internal + */ export const filterSensitiveLog = (obj: Listener): any => ({ ...obj, }); @@ -914,6 +1001,9 @@ export interface CreateListenerOutput { } export namespace CreateListenerOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateListenerOutput): any => ({ ...obj, }); @@ -929,6 +1019,9 @@ export interface DuplicateListenerException extends __SmithyException, $Metadata } export namespace DuplicateListenerException { + /** + * @internal + */ export const filterSensitiveLog = (obj: DuplicateListenerException): any => ({ ...obj, }); @@ -944,6 +1037,9 @@ export interface IncompatibleProtocolsException extends __SmithyException, $Meta } export namespace IncompatibleProtocolsException { + /** + * @internal + */ export const filterSensitiveLog = (obj: IncompatibleProtocolsException): any => ({ ...obj, }); @@ -959,6 +1055,9 @@ export interface InvalidConfigurationRequestException extends __SmithyException, } export namespace InvalidConfigurationRequestException { + /** + * @internal + */ export const filterSensitiveLog = (obj: InvalidConfigurationRequestException): any => ({ ...obj, }); @@ -974,6 +1073,9 @@ export interface InvalidLoadBalancerActionException extends __SmithyException, $ } export namespace InvalidLoadBalancerActionException { + /** + * @internal + */ export const filterSensitiveLog = (obj: InvalidLoadBalancerActionException): any => ({ ...obj, }); @@ -989,6 +1091,9 @@ export interface SSLPolicyNotFoundException extends __SmithyException, $Metadata } export namespace SSLPolicyNotFoundException { + /** + * @internal + */ export const filterSensitiveLog = (obj: SSLPolicyNotFoundException): any => ({ ...obj, }); @@ -1004,6 +1109,9 @@ export interface TargetGroupAssociationLimitException extends __SmithyException, } export namespace TargetGroupAssociationLimitException { + /** + * @internal + */ export const filterSensitiveLog = (obj: TargetGroupAssociationLimitException): any => ({ ...obj, }); @@ -1019,6 +1127,9 @@ export interface TooManyActionsException extends __SmithyException, $MetadataBea } export namespace TooManyActionsException { + /** + * @internal + */ export const filterSensitiveLog = (obj: TooManyActionsException): any => ({ ...obj, }); @@ -1034,6 +1145,9 @@ export interface TooManyListenersException extends __SmithyException, $MetadataB } export namespace TooManyListenersException { + /** + * @internal + */ export const filterSensitiveLog = (obj: TooManyListenersException): any => ({ ...obj, }); @@ -1050,6 +1164,9 @@ export interface TooManyRegistrationsForTargetIdException extends __SmithyExcept } export namespace TooManyRegistrationsForTargetIdException { + /** + * @internal + */ export const filterSensitiveLog = (obj: TooManyRegistrationsForTargetIdException): any => ({ ...obj, }); @@ -1065,6 +1182,9 @@ export interface TooManyTargetsException extends __SmithyException, $MetadataBea } export namespace TooManyTargetsException { + /** + * @internal + */ export const filterSensitiveLog = (obj: TooManyTargetsException): any => ({ ...obj, }); @@ -1082,6 +1202,9 @@ export interface TooManyUniqueTargetGroupsPerLoadBalancerException extends __Smi } export namespace TooManyUniqueTargetGroupsPerLoadBalancerException { + /** + * @internal + */ export const filterSensitiveLog = (obj: TooManyUniqueTargetGroupsPerLoadBalancerException): any => ({ ...obj, }); @@ -1097,6 +1220,9 @@ export interface UnsupportedProtocolException extends __SmithyException, $Metada } export namespace UnsupportedProtocolException { + /** + * @internal + */ export const filterSensitiveLog = (obj: UnsupportedProtocolException): any => ({ ...obj, }); @@ -1139,6 +1265,9 @@ export interface SubnetMapping { } export namespace SubnetMapping { + /** + * @internal + */ export const filterSensitiveLog = (obj: SubnetMapping): any => ({ ...obj, }); @@ -1236,6 +1365,9 @@ export interface CreateLoadBalancerInput { } export namespace CreateLoadBalancerInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateLoadBalancerInput): any => ({ ...obj, }); @@ -1268,6 +1400,9 @@ export interface LoadBalancerState { } export namespace LoadBalancerState { + /** + * @internal + */ export const filterSensitiveLog = (obj: LoadBalancerState): any => ({ ...obj, }); @@ -1353,6 +1488,9 @@ export interface LoadBalancer { } export namespace LoadBalancer { + /** + * @internal + */ export const filterSensitiveLog = (obj: LoadBalancer): any => ({ ...obj, }); @@ -1366,6 +1504,9 @@ export interface CreateLoadBalancerOutput { } export namespace CreateLoadBalancerOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateLoadBalancerOutput): any => ({ ...obj, }); @@ -1381,6 +1522,9 @@ export interface DuplicateLoadBalancerNameException extends __SmithyException, $ } export namespace DuplicateLoadBalancerNameException { + /** + * @internal + */ export const filterSensitiveLog = (obj: DuplicateLoadBalancerNameException): any => ({ ...obj, }); @@ -1396,6 +1540,9 @@ export interface InvalidSchemeException extends __SmithyException, $MetadataBear } export namespace InvalidSchemeException { + /** + * @internal + */ export const filterSensitiveLog = (obj: InvalidSchemeException): any => ({ ...obj, }); @@ -1411,6 +1558,9 @@ export interface InvalidSecurityGroupException extends __SmithyException, $Metad } export namespace InvalidSecurityGroupException { + /** + * @internal + */ export const filterSensitiveLog = (obj: InvalidSecurityGroupException): any => ({ ...obj, }); @@ -1426,6 +1576,9 @@ export interface InvalidSubnetException extends __SmithyException, $MetadataBear } export namespace InvalidSubnetException { + /** + * @internal + */ export const filterSensitiveLog = (obj: InvalidSubnetException): any => ({ ...obj, }); @@ -1441,6 +1594,9 @@ export interface OperationNotPermittedException extends __SmithyException, $Meta } export namespace OperationNotPermittedException { + /** + * @internal + */ export const filterSensitiveLog = (obj: OperationNotPermittedException): any => ({ ...obj, }); @@ -1456,6 +1612,9 @@ export interface ResourceInUseException extends __SmithyException, $MetadataBear } export namespace ResourceInUseException { + /** + * @internal + */ export const filterSensitiveLog = (obj: ResourceInUseException): any => ({ ...obj, }); @@ -1471,6 +1630,9 @@ export interface SubnetNotFoundException extends __SmithyException, $MetadataBea } export namespace SubnetNotFoundException { + /** + * @internal + */ export const filterSensitiveLog = (obj: SubnetNotFoundException): any => ({ ...obj, }); @@ -1486,6 +1648,9 @@ export interface TooManyLoadBalancersException extends __SmithyException, $Metad } export namespace TooManyLoadBalancersException { + /** + * @internal + */ export const filterSensitiveLog = (obj: TooManyLoadBalancersException): any => ({ ...obj, }); @@ -1506,6 +1671,9 @@ export interface HostHeaderConditionConfig { } export namespace HostHeaderConditionConfig { + /** + * @internal + */ export const filterSensitiveLog = (obj: HostHeaderConditionConfig): any => ({ ...obj, }); @@ -1540,6 +1708,9 @@ export interface HttpHeaderConditionConfig { } export namespace HttpHeaderConditionConfig { + /** + * @internal + */ export const filterSensitiveLog = (obj: HttpHeaderConditionConfig): any => ({ ...obj, }); @@ -1564,6 +1735,9 @@ export interface HttpRequestMethodConditionConfig { } export namespace HttpRequestMethodConditionConfig { + /** + * @internal + */ export const filterSensitiveLog = (obj: HttpRequestMethodConditionConfig): any => ({ ...obj, }); @@ -1585,6 +1759,9 @@ export interface PathPatternConditionConfig { } export namespace PathPatternConditionConfig { + /** + * @internal + */ export const filterSensitiveLog = (obj: PathPatternConditionConfig): any => ({ ...obj, }); @@ -1606,6 +1783,9 @@ export interface QueryStringKeyValuePair { } export namespace QueryStringKeyValuePair { + /** + * @internal + */ export const filterSensitiveLog = (obj: QueryStringKeyValuePair): any => ({ ...obj, }); @@ -1632,6 +1812,9 @@ export interface QueryStringConditionConfig { } export namespace QueryStringConditionConfig { + /** + * @internal + */ export const filterSensitiveLog = (obj: QueryStringConditionConfig): any => ({ ...obj, }); @@ -1656,6 +1839,9 @@ export interface SourceIpConditionConfig { } export namespace SourceIpConditionConfig { + /** + * @internal + */ export const filterSensitiveLog = (obj: SourceIpConditionConfig): any => ({ ...obj, }); @@ -1790,6 +1976,9 @@ export interface RuleCondition { } export namespace RuleCondition { + /** + * @internal + */ export const filterSensitiveLog = (obj: RuleCondition): any => ({ ...obj, }); @@ -1823,6 +2012,9 @@ export interface CreateRuleInput { } export namespace CreateRuleInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateRuleInput): any => ({ ...obj, }); @@ -1864,6 +2056,9 @@ export interface Rule { } export namespace Rule { + /** + * @internal + */ export const filterSensitiveLog = (obj: Rule): any => ({ ...obj, }); @@ -1877,6 +2072,9 @@ export interface CreateRuleOutput { } export namespace CreateRuleOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateRuleOutput): any => ({ ...obj, }); @@ -1892,6 +2090,9 @@ export interface PriorityInUseException extends __SmithyException, $MetadataBear } export namespace PriorityInUseException { + /** + * @internal + */ export const filterSensitiveLog = (obj: PriorityInUseException): any => ({ ...obj, }); @@ -1907,6 +2108,9 @@ export interface TooManyRulesException extends __SmithyException, $MetadataBeare } export namespace TooManyRulesException { + /** + * @internal + */ export const filterSensitiveLog = (obj: TooManyRulesException): any => ({ ...obj, }); @@ -1922,6 +2126,9 @@ export interface TooManyTargetGroupsException extends __SmithyException, $Metada } export namespace TooManyTargetGroupsException { + /** + * @internal + */ export const filterSensitiveLog = (obj: TooManyTargetGroupsException): any => ({ ...obj, }); @@ -1948,6 +2155,9 @@ export interface Matcher { } export namespace Matcher { + /** + * @internal + */ export const filterSensitiveLog = (obj: Matcher): any => ({ ...obj, }); @@ -2102,6 +2312,9 @@ export interface CreateTargetGroupInput { } export namespace CreateTargetGroupInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateTargetGroupInput): any => ({ ...obj, }); @@ -2210,6 +2423,9 @@ export interface TargetGroup { } export namespace TargetGroup { + /** + * @internal + */ export const filterSensitiveLog = (obj: TargetGroup): any => ({ ...obj, }); @@ -2223,6 +2439,9 @@ export interface CreateTargetGroupOutput { } export namespace CreateTargetGroupOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateTargetGroupOutput): any => ({ ...obj, }); @@ -2238,6 +2457,9 @@ export interface DuplicateTargetGroupNameException extends __SmithyException, $M } export namespace DuplicateTargetGroupNameException { + /** + * @internal + */ export const filterSensitiveLog = (obj: DuplicateTargetGroupNameException): any => ({ ...obj, }); @@ -2251,6 +2473,9 @@ export interface DeleteListenerInput { } export namespace DeleteListenerInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteListenerInput): any => ({ ...obj, }); @@ -2259,6 +2484,9 @@ export namespace DeleteListenerInput { export interface DeleteListenerOutput {} export namespace DeleteListenerOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteListenerOutput): any => ({ ...obj, }); @@ -2272,6 +2500,9 @@ export interface DeleteLoadBalancerInput { } export namespace DeleteLoadBalancerInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteLoadBalancerInput): any => ({ ...obj, }); @@ -2280,6 +2511,9 @@ export namespace DeleteLoadBalancerInput { export interface DeleteLoadBalancerOutput {} export namespace DeleteLoadBalancerOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteLoadBalancerOutput): any => ({ ...obj, }); @@ -2293,6 +2527,9 @@ export interface DeleteRuleInput { } export namespace DeleteRuleInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteRuleInput): any => ({ ...obj, }); @@ -2301,6 +2538,9 @@ export namespace DeleteRuleInput { export interface DeleteRuleOutput {} export namespace DeleteRuleOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteRuleOutput): any => ({ ...obj, }); @@ -2316,6 +2556,9 @@ export interface RuleNotFoundException extends __SmithyException, $MetadataBeare } export namespace RuleNotFoundException { + /** + * @internal + */ export const filterSensitiveLog = (obj: RuleNotFoundException): any => ({ ...obj, }); @@ -2329,6 +2572,9 @@ export interface DeleteTargetGroupInput { } export namespace DeleteTargetGroupInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteTargetGroupInput): any => ({ ...obj, }); @@ -2337,6 +2583,9 @@ export namespace DeleteTargetGroupInput { export interface DeleteTargetGroupOutput {} export namespace DeleteTargetGroupOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteTargetGroupOutput): any => ({ ...obj, }); @@ -2378,6 +2627,9 @@ export interface TargetDescription { } export namespace TargetDescription { + /** + * @internal + */ export const filterSensitiveLog = (obj: TargetDescription): any => ({ ...obj, }); @@ -2397,6 +2649,9 @@ export interface DeregisterTargetsInput { } export namespace DeregisterTargetsInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeregisterTargetsInput): any => ({ ...obj, }); @@ -2405,6 +2660,9 @@ export namespace DeregisterTargetsInput { export interface DeregisterTargetsOutput {} export namespace DeregisterTargetsOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeregisterTargetsOutput): any => ({ ...obj, }); @@ -2421,6 +2679,9 @@ export interface InvalidTargetException extends __SmithyException, $MetadataBear } export namespace InvalidTargetException { + /** + * @internal + */ export const filterSensitiveLog = (obj: InvalidTargetException): any => ({ ...obj, }); @@ -2440,6 +2701,9 @@ export interface DescribeAccountLimitsInput { } export namespace DescribeAccountLimitsInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeAccountLimitsInput): any => ({ ...obj, }); @@ -2517,6 +2781,9 @@ export interface Limit { } export namespace Limit { + /** + * @internal + */ export const filterSensitiveLog = (obj: Limit): any => ({ ...obj, }); @@ -2536,6 +2803,9 @@ export interface DescribeAccountLimitsOutput { } export namespace DescribeAccountLimitsOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeAccountLimitsOutput): any => ({ ...obj, }); @@ -2560,6 +2830,9 @@ export interface DescribeListenerCertificatesInput { } export namespace DescribeListenerCertificatesInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeListenerCertificatesInput): any => ({ ...obj, }); @@ -2579,6 +2852,9 @@ export interface DescribeListenerCertificatesOutput { } export namespace DescribeListenerCertificatesOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeListenerCertificatesOutput): any => ({ ...obj, }); @@ -2608,6 +2884,9 @@ export interface DescribeListenersInput { } export namespace DescribeListenersInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeListenersInput): any => ({ ...obj, }); @@ -2627,6 +2906,9 @@ export interface DescribeListenersOutput { } export namespace DescribeListenersOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeListenersOutput): any => ({ ...obj, }); @@ -2640,6 +2922,9 @@ export interface DescribeLoadBalancerAttributesInput { } export namespace DescribeLoadBalancerAttributesInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeLoadBalancerAttributesInput): any => ({ ...obj, }); @@ -2741,6 +3026,9 @@ export interface LoadBalancerAttribute { } export namespace LoadBalancerAttribute { + /** + * @internal + */ export const filterSensitiveLog = (obj: LoadBalancerAttribute): any => ({ ...obj, }); @@ -2754,6 +3042,9 @@ export interface DescribeLoadBalancerAttributesOutput { } export namespace DescribeLoadBalancerAttributesOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeLoadBalancerAttributesOutput): any => ({ ...obj, }); @@ -2784,6 +3075,9 @@ export interface DescribeLoadBalancersInput { } export namespace DescribeLoadBalancersInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeLoadBalancersInput): any => ({ ...obj, }); @@ -2803,6 +3097,9 @@ export interface DescribeLoadBalancersOutput { } export namespace DescribeLoadBalancersOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeLoadBalancersOutput): any => ({ ...obj, }); @@ -2832,6 +3129,9 @@ export interface DescribeRulesInput { } export namespace DescribeRulesInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeRulesInput): any => ({ ...obj, }); @@ -2851,6 +3151,9 @@ export interface DescribeRulesOutput { } export namespace DescribeRulesOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeRulesOutput): any => ({ ...obj, }); @@ -2875,6 +3178,9 @@ export interface DescribeSSLPoliciesInput { } export namespace DescribeSSLPoliciesInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeSSLPoliciesInput): any => ({ ...obj, }); @@ -2901,6 +3207,9 @@ export interface SslPolicy { } export namespace SslPolicy { + /** + * @internal + */ export const filterSensitiveLog = (obj: SslPolicy): any => ({ ...obj, }); @@ -2920,6 +3229,9 @@ export interface DescribeSSLPoliciesOutput { } export namespace DescribeSSLPoliciesOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeSSLPoliciesOutput): any => ({ ...obj, }); @@ -2934,6 +3246,9 @@ export interface DescribeTagsInput { } export namespace DescribeTagsInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeTagsInput): any => ({ ...obj, }); @@ -2955,6 +3270,9 @@ export interface TagDescription { } export namespace TagDescription { + /** + * @internal + */ export const filterSensitiveLog = (obj: TagDescription): any => ({ ...obj, }); @@ -2968,6 +3286,9 @@ export interface DescribeTagsOutput { } export namespace DescribeTagsOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeTagsOutput): any => ({ ...obj, }); @@ -2981,6 +3302,9 @@ export interface DescribeTargetGroupAttributesInput { } export namespace DescribeTargetGroupAttributesInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeTargetGroupAttributesInput): any => ({ ...obj, }); @@ -3110,6 +3434,9 @@ export interface TargetGroupAttribute { } export namespace TargetGroupAttribute { + /** + * @internal + */ export const filterSensitiveLog = (obj: TargetGroupAttribute): any => ({ ...obj, }); @@ -3123,6 +3450,9 @@ export interface DescribeTargetGroupAttributesOutput { } export namespace DescribeTargetGroupAttributesOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeTargetGroupAttributesOutput): any => ({ ...obj, }); @@ -3157,6 +3487,9 @@ export interface DescribeTargetGroupsInput { } export namespace DescribeTargetGroupsInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeTargetGroupsInput): any => ({ ...obj, }); @@ -3176,6 +3509,9 @@ export interface DescribeTargetGroupsOutput { } export namespace DescribeTargetGroupsOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeTargetGroupsOutput): any => ({ ...obj, }); @@ -3194,6 +3530,9 @@ export interface DescribeTargetHealthInput { } export namespace DescribeTargetHealthInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeTargetHealthInput): any => ({ ...obj, }); @@ -3338,6 +3677,9 @@ export interface TargetHealth { } export namespace TargetHealth { + /** + * @internal + */ export const filterSensitiveLog = (obj: TargetHealth): any => ({ ...obj, }); @@ -3364,6 +3706,9 @@ export interface TargetHealthDescription { } export namespace TargetHealthDescription { + /** + * @internal + */ export const filterSensitiveLog = (obj: TargetHealthDescription): any => ({ ...obj, }); @@ -3377,6 +3722,9 @@ export interface DescribeTargetHealthOutput { } export namespace DescribeTargetHealthOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeTargetHealthOutput): any => ({ ...obj, }); @@ -3393,6 +3741,9 @@ export interface HealthUnavailableException extends __SmithyException, $Metadata } export namespace HealthUnavailableException { + /** + * @internal + */ export const filterSensitiveLog = (obj: HealthUnavailableException): any => ({ ...obj, }); @@ -3475,6 +3826,9 @@ export interface ModifyListenerInput { } export namespace ModifyListenerInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: ModifyListenerInput): any => ({ ...obj, }); @@ -3488,6 +3842,9 @@ export interface ModifyListenerOutput { } export namespace ModifyListenerOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: ModifyListenerOutput): any => ({ ...obj, }); @@ -3506,6 +3863,9 @@ export interface ModifyLoadBalancerAttributesInput { } export namespace ModifyLoadBalancerAttributesInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: ModifyLoadBalancerAttributesInput): any => ({ ...obj, }); @@ -3519,6 +3879,9 @@ export interface ModifyLoadBalancerAttributesOutput { } export namespace ModifyLoadBalancerAttributesOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: ModifyLoadBalancerAttributesOutput): any => ({ ...obj, }); @@ -3542,6 +3905,9 @@ export interface ModifyRuleInput { } export namespace ModifyRuleInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: ModifyRuleInput): any => ({ ...obj, }); @@ -3555,6 +3921,9 @@ export interface ModifyRuleOutput { } export namespace ModifyRuleOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: ModifyRuleOutput): any => ({ ...obj, }); @@ -3629,6 +3998,9 @@ export interface ModifyTargetGroupInput { } export namespace ModifyTargetGroupInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: ModifyTargetGroupInput): any => ({ ...obj, }); @@ -3642,6 +4014,9 @@ export interface ModifyTargetGroupOutput { } export namespace ModifyTargetGroupOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: ModifyTargetGroupOutput): any => ({ ...obj, }); @@ -3660,6 +4035,9 @@ export interface ModifyTargetGroupAttributesInput { } export namespace ModifyTargetGroupAttributesInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: ModifyTargetGroupAttributesInput): any => ({ ...obj, }); @@ -3673,6 +4051,9 @@ export interface ModifyTargetGroupAttributesOutput { } export namespace ModifyTargetGroupAttributesOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: ModifyTargetGroupAttributesOutput): any => ({ ...obj, }); @@ -3691,6 +4072,9 @@ export interface RegisterTargetsInput { } export namespace RegisterTargetsInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: RegisterTargetsInput): any => ({ ...obj, }); @@ -3699,6 +4083,9 @@ export namespace RegisterTargetsInput { export interface RegisterTargetsOutput {} export namespace RegisterTargetsOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: RegisterTargetsOutput): any => ({ ...obj, }); @@ -3719,6 +4106,9 @@ export interface RemoveListenerCertificatesInput { } export namespace RemoveListenerCertificatesInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: RemoveListenerCertificatesInput): any => ({ ...obj, }); @@ -3727,6 +4117,9 @@ export namespace RemoveListenerCertificatesInput { export interface RemoveListenerCertificatesOutput {} export namespace RemoveListenerCertificatesOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: RemoveListenerCertificatesOutput): any => ({ ...obj, }); @@ -3745,6 +4138,9 @@ export interface RemoveTagsInput { } export namespace RemoveTagsInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: RemoveTagsInput): any => ({ ...obj, }); @@ -3753,6 +4149,9 @@ export namespace RemoveTagsInput { export interface RemoveTagsOutput {} export namespace RemoveTagsOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: RemoveTagsOutput): any => ({ ...obj, }); @@ -3774,6 +4173,9 @@ export interface SetIpAddressTypeInput { } export namespace SetIpAddressTypeInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: SetIpAddressTypeInput): any => ({ ...obj, }); @@ -3787,6 +4189,9 @@ export interface SetIpAddressTypeOutput { } export namespace SetIpAddressTypeOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: SetIpAddressTypeOutput): any => ({ ...obj, }); @@ -3808,6 +4213,9 @@ export interface RulePriorityPair { } export namespace RulePriorityPair { + /** + * @internal + */ export const filterSensitiveLog = (obj: RulePriorityPair): any => ({ ...obj, }); @@ -3821,6 +4229,9 @@ export interface SetRulePrioritiesInput { } export namespace SetRulePrioritiesInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: SetRulePrioritiesInput): any => ({ ...obj, }); @@ -3834,6 +4245,9 @@ export interface SetRulePrioritiesOutput { } export namespace SetRulePrioritiesOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: SetRulePrioritiesOutput): any => ({ ...obj, }); @@ -3852,6 +4266,9 @@ export interface SetSecurityGroupsInput { } export namespace SetSecurityGroupsInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: SetSecurityGroupsInput): any => ({ ...obj, }); @@ -3865,6 +4282,9 @@ export interface SetSecurityGroupsOutput { } export namespace SetSecurityGroupsOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: SetSecurityGroupsOutput): any => ({ ...obj, }); @@ -3916,6 +4336,9 @@ export interface SetSubnetsInput { } export namespace SetSubnetsInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: SetSubnetsInput): any => ({ ...obj, }); @@ -3934,6 +4357,9 @@ export interface SetSubnetsOutput { } export namespace SetSubnetsOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: SetSubnetsOutput): any => ({ ...obj, }); diff --git a/clients/client-elastic-load-balancing/commands/AddTagsCommand.ts b/clients/client-elastic-load-balancing/commands/AddTagsCommand.ts index 049ef5cc78b0..be5da581dcc3 100644 --- a/clients/client-elastic-load-balancing/commands/AddTagsCommand.ts +++ b/clients/client-elastic-load-balancing/commands/AddTagsCommand.ts @@ -29,6 +29,20 @@ export interface AddTagsCommandOutput extends AddTagsOutput, __MetadataBearer {} * *

For more information, see Tag Your Classic Load Balancer * in the Classic Load Balancers Guide.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ElasticLoadBalancingClient, AddTagsCommand } from "@aws-sdk/client-elastic-load-balancing"; // ES Modules import + * // const { ElasticLoadBalancingClient, AddTagsCommand } = require("@aws-sdk/client-elastic-load-balancing"); // CommonJS import + * const client = new ElasticLoadBalancingClient(config); + * const command = new AddTagsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link AddTagsCommandInput} for command's `input` shape. + * @see {@link AddTagsCommandOutput} for command's `response` shape. + * @see {@link ElasticLoadBalancingClientResolvedConfig | config} for command's `input` shape. + * */ export class AddTagsCommand extends $Command< AddTagsCommandInput, diff --git a/clients/client-elastic-load-balancing/commands/ApplySecurityGroupsToLoadBalancerCommand.ts b/clients/client-elastic-load-balancing/commands/ApplySecurityGroupsToLoadBalancerCommand.ts index 4b94dd34e72f..e9d0b1240ace 100644 --- a/clients/client-elastic-load-balancing/commands/ApplySecurityGroupsToLoadBalancerCommand.ts +++ b/clients/client-elastic-load-balancing/commands/ApplySecurityGroupsToLoadBalancerCommand.ts @@ -30,6 +30,20 @@ export interface ApplySecurityGroupsToLoadBalancerCommandOutput *

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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ElasticLoadBalancingClient, ApplySecurityGroupsToLoadBalancerCommand } from "@aws-sdk/client-elastic-load-balancing"; // ES Modules import + * // const { ElasticLoadBalancingClient, ApplySecurityGroupsToLoadBalancerCommand } = require("@aws-sdk/client-elastic-load-balancing"); // CommonJS import + * const client = new ElasticLoadBalancingClient(config); + * const command = new ApplySecurityGroupsToLoadBalancerCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ApplySecurityGroupsToLoadBalancerCommandInput} for command's `input` shape. + * @see {@link ApplySecurityGroupsToLoadBalancerCommandOutput} for command's `response` shape. + * @see {@link ElasticLoadBalancingClientResolvedConfig | config} for command's `input` shape. + * */ export class ApplySecurityGroupsToLoadBalancerCommand extends $Command< ApplySecurityGroupsToLoadBalancerCommandInput, diff --git a/clients/client-elastic-load-balancing/commands/AttachLoadBalancerToSubnetsCommand.ts b/clients/client-elastic-load-balancing/commands/AttachLoadBalancerToSubnetsCommand.ts index 18e1792915c4..2923c780232b 100644 --- a/clients/client-elastic-load-balancing/commands/AttachLoadBalancerToSubnetsCommand.ts +++ b/clients/client-elastic-load-balancing/commands/AttachLoadBalancerToSubnetsCommand.ts @@ -29,6 +29,20 @@ export interface AttachLoadBalancerToSubnetsCommandOutput extends AttachLoadBala *

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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ElasticLoadBalancingClient, AttachLoadBalancerToSubnetsCommand } from "@aws-sdk/client-elastic-load-balancing"; // ES Modules import + * // const { ElasticLoadBalancingClient, AttachLoadBalancerToSubnetsCommand } = require("@aws-sdk/client-elastic-load-balancing"); // CommonJS import + * const client = new ElasticLoadBalancingClient(config); + * const command = new AttachLoadBalancerToSubnetsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link AttachLoadBalancerToSubnetsCommandInput} for command's `input` shape. + * @see {@link AttachLoadBalancerToSubnetsCommandOutput} for command's `response` shape. + * @see {@link ElasticLoadBalancingClientResolvedConfig | config} for command's `input` shape. + * */ export class AttachLoadBalancerToSubnetsCommand extends $Command< AttachLoadBalancerToSubnetsCommandInput, diff --git a/clients/client-elastic-load-balancing/commands/ConfigureHealthCheckCommand.ts b/clients/client-elastic-load-balancing/commands/ConfigureHealthCheckCommand.ts index 23eedbfcc190..fc48b53cb4b3 100644 --- a/clients/client-elastic-load-balancing/commands/ConfigureHealthCheckCommand.ts +++ b/clients/client-elastic-load-balancing/commands/ConfigureHealthCheckCommand.ts @@ -28,6 +28,20 @@ export interface ConfigureHealthCheckCommandOutput extends ConfigureHealthCheckO *

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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ElasticLoadBalancingClient, ConfigureHealthCheckCommand } from "@aws-sdk/client-elastic-load-balancing"; // ES Modules import + * // const { ElasticLoadBalancingClient, ConfigureHealthCheckCommand } = require("@aws-sdk/client-elastic-load-balancing"); // CommonJS import + * const client = new ElasticLoadBalancingClient(config); + * const command = new ConfigureHealthCheckCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ConfigureHealthCheckCommandInput} for command's `input` shape. + * @see {@link ConfigureHealthCheckCommandOutput} for command's `response` shape. + * @see {@link ElasticLoadBalancingClientResolvedConfig | config} for command's `input` shape. + * */ export class ConfigureHealthCheckCommand extends $Command< ConfigureHealthCheckCommandInput, diff --git a/clients/client-elastic-load-balancing/commands/CreateAppCookieStickinessPolicyCommand.ts b/clients/client-elastic-load-balancing/commands/CreateAppCookieStickinessPolicyCommand.ts index ff56ebb3b1d3..4cb2eef83b66 100644 --- a/clients/client-elastic-load-balancing/commands/CreateAppCookieStickinessPolicyCommand.ts +++ b/clients/client-elastic-load-balancing/commands/CreateAppCookieStickinessPolicyCommand.ts @@ -36,6 +36,20 @@ export interface CreateAppCookieStickinessPolicyCommandOutput *

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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ElasticLoadBalancingClient, CreateAppCookieStickinessPolicyCommand } from "@aws-sdk/client-elastic-load-balancing"; // ES Modules import + * // const { ElasticLoadBalancingClient, CreateAppCookieStickinessPolicyCommand } = require("@aws-sdk/client-elastic-load-balancing"); // CommonJS import + * const client = new ElasticLoadBalancingClient(config); + * const command = new CreateAppCookieStickinessPolicyCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreateAppCookieStickinessPolicyCommandInput} for command's `input` shape. + * @see {@link CreateAppCookieStickinessPolicyCommandOutput} for command's `response` shape. + * @see {@link ElasticLoadBalancingClientResolvedConfig | config} for command's `input` shape. + * */ export class CreateAppCookieStickinessPolicyCommand extends $Command< CreateAppCookieStickinessPolicyCommandInput, diff --git a/clients/client-elastic-load-balancing/commands/CreateLBCookieStickinessPolicyCommand.ts b/clients/client-elastic-load-balancing/commands/CreateLBCookieStickinessPolicyCommand.ts index 7555efd0fd42..65842e7bbb19 100644 --- a/clients/client-elastic-load-balancing/commands/CreateLBCookieStickinessPolicyCommand.ts +++ b/clients/client-elastic-load-balancing/commands/CreateLBCookieStickinessPolicyCommand.ts @@ -34,6 +34,20 @@ export interface CreateLBCookieStickinessPolicyCommandOutput * *

For more information, see Duration-Based Session Stickiness * in the Classic Load Balancers Guide.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ElasticLoadBalancingClient, CreateLBCookieStickinessPolicyCommand } from "@aws-sdk/client-elastic-load-balancing"; // ES Modules import + * // const { ElasticLoadBalancingClient, CreateLBCookieStickinessPolicyCommand } = require("@aws-sdk/client-elastic-load-balancing"); // CommonJS import + * const client = new ElasticLoadBalancingClient(config); + * const command = new CreateLBCookieStickinessPolicyCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreateLBCookieStickinessPolicyCommandInput} for command's `input` shape. + * @see {@link CreateLBCookieStickinessPolicyCommandOutput} for command's `response` shape. + * @see {@link ElasticLoadBalancingClientResolvedConfig | config} for command's `input` shape. + * */ export class CreateLBCookieStickinessPolicyCommand extends $Command< CreateLBCookieStickinessPolicyCommandInput, diff --git a/clients/client-elastic-load-balancing/commands/CreateLoadBalancerCommand.ts b/clients/client-elastic-load-balancing/commands/CreateLoadBalancerCommand.ts index 60f76581a27e..ccdaacb1d163 100644 --- a/clients/client-elastic-load-balancing/commands/CreateLoadBalancerCommand.ts +++ b/clients/client-elastic-load-balancing/commands/CreateLoadBalancerCommand.ts @@ -39,6 +39,20 @@ export interface CreateLoadBalancerCommandOutput extends CreateAccessPointOutput * 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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ElasticLoadBalancingClient, CreateLoadBalancerCommand } from "@aws-sdk/client-elastic-load-balancing"; // ES Modules import + * // const { ElasticLoadBalancingClient, CreateLoadBalancerCommand } = require("@aws-sdk/client-elastic-load-balancing"); // CommonJS import + * const client = new ElasticLoadBalancingClient(config); + * const command = new CreateLoadBalancerCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreateLoadBalancerCommandInput} for command's `input` shape. + * @see {@link CreateLoadBalancerCommandOutput} for command's `response` shape. + * @see {@link ElasticLoadBalancingClientResolvedConfig | config} for command's `input` shape. + * */ export class CreateLoadBalancerCommand extends $Command< CreateLoadBalancerCommandInput, diff --git a/clients/client-elastic-load-balancing/commands/CreateLoadBalancerListenersCommand.ts b/clients/client-elastic-load-balancing/commands/CreateLoadBalancerListenersCommand.ts index c9b224d6e469..5905a9768804 100644 --- a/clients/client-elastic-load-balancing/commands/CreateLoadBalancerListenersCommand.ts +++ b/clients/client-elastic-load-balancing/commands/CreateLoadBalancerListenersCommand.ts @@ -28,6 +28,20 @@ export interface CreateLoadBalancerListenersCommandOutput extends CreateLoadBala *

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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ElasticLoadBalancingClient, CreateLoadBalancerListenersCommand } from "@aws-sdk/client-elastic-load-balancing"; // ES Modules import + * // const { ElasticLoadBalancingClient, CreateLoadBalancerListenersCommand } = require("@aws-sdk/client-elastic-load-balancing"); // CommonJS import + * const client = new ElasticLoadBalancingClient(config); + * const command = new CreateLoadBalancerListenersCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreateLoadBalancerListenersCommandInput} for command's `input` shape. + * @see {@link CreateLoadBalancerListenersCommandOutput} for command's `response` shape. + * @see {@link ElasticLoadBalancingClientResolvedConfig | config} for command's `input` shape. + * */ export class CreateLoadBalancerListenersCommand extends $Command< CreateLoadBalancerListenersCommandInput, diff --git a/clients/client-elastic-load-balancing/commands/CreateLoadBalancerPolicyCommand.ts b/clients/client-elastic-load-balancing/commands/CreateLoadBalancerPolicyCommand.ts index 5ae3537f8bf2..916579d150b7 100644 --- a/clients/client-elastic-load-balancing/commands/CreateLoadBalancerPolicyCommand.ts +++ b/clients/client-elastic-load-balancing/commands/CreateLoadBalancerPolicyCommand.ts @@ -27,6 +27,20 @@ export interface CreateLoadBalancerPolicyCommandOutput extends CreateLoadBalance /** *

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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ElasticLoadBalancingClient, CreateLoadBalancerPolicyCommand } from "@aws-sdk/client-elastic-load-balancing"; // ES Modules import + * // const { ElasticLoadBalancingClient, CreateLoadBalancerPolicyCommand } = require("@aws-sdk/client-elastic-load-balancing"); // CommonJS import + * const client = new ElasticLoadBalancingClient(config); + * const command = new CreateLoadBalancerPolicyCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreateLoadBalancerPolicyCommandInput} for command's `input` shape. + * @see {@link CreateLoadBalancerPolicyCommandOutput} for command's `response` shape. + * @see {@link ElasticLoadBalancingClientResolvedConfig | config} for command's `input` shape. + * */ export class CreateLoadBalancerPolicyCommand extends $Command< CreateLoadBalancerPolicyCommandInput, diff --git a/clients/client-elastic-load-balancing/commands/DeleteLoadBalancerCommand.ts b/clients/client-elastic-load-balancing/commands/DeleteLoadBalancerCommand.ts index a0e62155246b..6dade6a9b2fe 100644 --- a/clients/client-elastic-load-balancing/commands/DeleteLoadBalancerCommand.ts +++ b/clients/client-elastic-load-balancing/commands/DeleteLoadBalancerCommand.ts @@ -29,6 +29,20 @@ export interface DeleteLoadBalancerCommandOutput extends DeleteAccessPointOutput *

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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ElasticLoadBalancingClient, DeleteLoadBalancerCommand } from "@aws-sdk/client-elastic-load-balancing"; // ES Modules import + * // const { ElasticLoadBalancingClient, DeleteLoadBalancerCommand } = require("@aws-sdk/client-elastic-load-balancing"); // CommonJS import + * const client = new ElasticLoadBalancingClient(config); + * const command = new DeleteLoadBalancerCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteLoadBalancerCommandInput} for command's `input` shape. + * @see {@link DeleteLoadBalancerCommandOutput} for command's `response` shape. + * @see {@link ElasticLoadBalancingClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteLoadBalancerCommand extends $Command< DeleteLoadBalancerCommandInput, diff --git a/clients/client-elastic-load-balancing/commands/DeleteLoadBalancerListenersCommand.ts b/clients/client-elastic-load-balancing/commands/DeleteLoadBalancerListenersCommand.ts index e2abf7d6a26a..976c81638c2b 100644 --- a/clients/client-elastic-load-balancing/commands/DeleteLoadBalancerListenersCommand.ts +++ b/clients/client-elastic-load-balancing/commands/DeleteLoadBalancerListenersCommand.ts @@ -26,6 +26,20 @@ export interface DeleteLoadBalancerListenersCommandOutput extends DeleteLoadBala /** *

Deletes the specified listeners from the specified load balancer.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ElasticLoadBalancingClient, DeleteLoadBalancerListenersCommand } from "@aws-sdk/client-elastic-load-balancing"; // ES Modules import + * // const { ElasticLoadBalancingClient, DeleteLoadBalancerListenersCommand } = require("@aws-sdk/client-elastic-load-balancing"); // CommonJS import + * const client = new ElasticLoadBalancingClient(config); + * const command = new DeleteLoadBalancerListenersCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteLoadBalancerListenersCommandInput} for command's `input` shape. + * @see {@link DeleteLoadBalancerListenersCommandOutput} for command's `response` shape. + * @see {@link ElasticLoadBalancingClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteLoadBalancerListenersCommand extends $Command< DeleteLoadBalancerListenersCommandInput, diff --git a/clients/client-elastic-load-balancing/commands/DeleteLoadBalancerPolicyCommand.ts b/clients/client-elastic-load-balancing/commands/DeleteLoadBalancerPolicyCommand.ts index 72d7c7cdb12f..374abc4bbe9b 100644 --- a/clients/client-elastic-load-balancing/commands/DeleteLoadBalancerPolicyCommand.ts +++ b/clients/client-elastic-load-balancing/commands/DeleteLoadBalancerPolicyCommand.ts @@ -26,6 +26,20 @@ export interface DeleteLoadBalancerPolicyCommandOutput extends DeleteLoadBalance /** *

Deletes the specified policy from the specified load balancer. This policy must not be enabled for any listeners.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ElasticLoadBalancingClient, DeleteLoadBalancerPolicyCommand } from "@aws-sdk/client-elastic-load-balancing"; // ES Modules import + * // const { ElasticLoadBalancingClient, DeleteLoadBalancerPolicyCommand } = require("@aws-sdk/client-elastic-load-balancing"); // CommonJS import + * const client = new ElasticLoadBalancingClient(config); + * const command = new DeleteLoadBalancerPolicyCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteLoadBalancerPolicyCommandInput} for command's `input` shape. + * @see {@link DeleteLoadBalancerPolicyCommandOutput} for command's `response` shape. + * @see {@link ElasticLoadBalancingClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteLoadBalancerPolicyCommand extends $Command< DeleteLoadBalancerPolicyCommandInput, diff --git a/clients/client-elastic-load-balancing/commands/DeregisterInstancesFromLoadBalancerCommand.ts b/clients/client-elastic-load-balancing/commands/DeregisterInstancesFromLoadBalancerCommand.ts index ddf3f923ee68..37d3704eeae6 100644 --- a/clients/client-elastic-load-balancing/commands/DeregisterInstancesFromLoadBalancerCommand.ts +++ b/clients/client-elastic-load-balancing/commands/DeregisterInstancesFromLoadBalancerCommand.ts @@ -31,6 +31,20 @@ export interface DeregisterInstancesFromLoadBalancerCommandOutput extends Deregi * *

For more information, see Register or De-Register EC2 Instances * in the Classic Load Balancers Guide.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ElasticLoadBalancingClient, DeregisterInstancesFromLoadBalancerCommand } from "@aws-sdk/client-elastic-load-balancing"; // ES Modules import + * // const { ElasticLoadBalancingClient, DeregisterInstancesFromLoadBalancerCommand } = require("@aws-sdk/client-elastic-load-balancing"); // CommonJS import + * const client = new ElasticLoadBalancingClient(config); + * const command = new DeregisterInstancesFromLoadBalancerCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeregisterInstancesFromLoadBalancerCommandInput} for command's `input` shape. + * @see {@link DeregisterInstancesFromLoadBalancerCommandOutput} for command's `response` shape. + * @see {@link ElasticLoadBalancingClientResolvedConfig | config} for command's `input` shape. + * */ export class DeregisterInstancesFromLoadBalancerCommand extends $Command< DeregisterInstancesFromLoadBalancerCommandInput, diff --git a/clients/client-elastic-load-balancing/commands/DescribeAccountLimitsCommand.ts b/clients/client-elastic-load-balancing/commands/DescribeAccountLimitsCommand.ts index 9e73124f213b..4cdcc6a3a411 100644 --- a/clients/client-elastic-load-balancing/commands/DescribeAccountLimitsCommand.ts +++ b/clients/client-elastic-load-balancing/commands/DescribeAccountLimitsCommand.ts @@ -28,6 +28,20 @@ export interface DescribeAccountLimitsCommandOutput extends DescribeAccountLimit *

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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ElasticLoadBalancingClient, DescribeAccountLimitsCommand } from "@aws-sdk/client-elastic-load-balancing"; // ES Modules import + * // const { ElasticLoadBalancingClient, DescribeAccountLimitsCommand } = require("@aws-sdk/client-elastic-load-balancing"); // CommonJS import + * const client = new ElasticLoadBalancingClient(config); + * const command = new DescribeAccountLimitsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeAccountLimitsCommandInput} for command's `input` shape. + * @see {@link DescribeAccountLimitsCommandOutput} for command's `response` shape. + * @see {@link ElasticLoadBalancingClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeAccountLimitsCommand extends $Command< DescribeAccountLimitsCommandInput, diff --git a/clients/client-elastic-load-balancing/commands/DescribeInstanceHealthCommand.ts b/clients/client-elastic-load-balancing/commands/DescribeInstanceHealthCommand.ts index 4b5db3d08d46..ebb4c5fe1dd8 100644 --- a/clients/client-elastic-load-balancing/commands/DescribeInstanceHealthCommand.ts +++ b/clients/client-elastic-load-balancing/commands/DescribeInstanceHealthCommand.ts @@ -26,6 +26,20 @@ export interface DescribeInstanceHealthCommandOutput extends DescribeEndPointSta /** *

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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ElasticLoadBalancingClient, DescribeInstanceHealthCommand } from "@aws-sdk/client-elastic-load-balancing"; // ES Modules import + * // const { ElasticLoadBalancingClient, DescribeInstanceHealthCommand } = require("@aws-sdk/client-elastic-load-balancing"); // CommonJS import + * const client = new ElasticLoadBalancingClient(config); + * const command = new DescribeInstanceHealthCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeInstanceHealthCommandInput} for command's `input` shape. + * @see {@link DescribeInstanceHealthCommandOutput} for command's `response` shape. + * @see {@link ElasticLoadBalancingClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeInstanceHealthCommand extends $Command< DescribeInstanceHealthCommandInput, diff --git a/clients/client-elastic-load-balancing/commands/DescribeLoadBalancerAttributesCommand.ts b/clients/client-elastic-load-balancing/commands/DescribeLoadBalancerAttributesCommand.ts index 828c173fe35d..39294c6d6aa6 100644 --- a/clients/client-elastic-load-balancing/commands/DescribeLoadBalancerAttributesCommand.ts +++ b/clients/client-elastic-load-balancing/commands/DescribeLoadBalancerAttributesCommand.ts @@ -28,6 +28,20 @@ export interface DescribeLoadBalancerAttributesCommandOutput /** *

Describes the attributes for the specified load balancer.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ElasticLoadBalancingClient, DescribeLoadBalancerAttributesCommand } from "@aws-sdk/client-elastic-load-balancing"; // ES Modules import + * // const { ElasticLoadBalancingClient, DescribeLoadBalancerAttributesCommand } = require("@aws-sdk/client-elastic-load-balancing"); // CommonJS import + * const client = new ElasticLoadBalancingClient(config); + * const command = new DescribeLoadBalancerAttributesCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeLoadBalancerAttributesCommandInput} for command's `input` shape. + * @see {@link DescribeLoadBalancerAttributesCommandOutput} for command's `response` shape. + * @see {@link ElasticLoadBalancingClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeLoadBalancerAttributesCommand extends $Command< DescribeLoadBalancerAttributesCommandInput, diff --git a/clients/client-elastic-load-balancing/commands/DescribeLoadBalancerPoliciesCommand.ts b/clients/client-elastic-load-balancing/commands/DescribeLoadBalancerPoliciesCommand.ts index b88cb829c1de..8cf7aabe431b 100644 --- a/clients/client-elastic-load-balancing/commands/DescribeLoadBalancerPoliciesCommand.ts +++ b/clients/client-elastic-load-balancing/commands/DescribeLoadBalancerPoliciesCommand.ts @@ -32,6 +32,20 @@ export interface DescribeLoadBalancerPoliciesCommandOutput * 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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ElasticLoadBalancingClient, DescribeLoadBalancerPoliciesCommand } from "@aws-sdk/client-elastic-load-balancing"; // ES Modules import + * // const { ElasticLoadBalancingClient, DescribeLoadBalancerPoliciesCommand } = require("@aws-sdk/client-elastic-load-balancing"); // CommonJS import + * const client = new ElasticLoadBalancingClient(config); + * const command = new DescribeLoadBalancerPoliciesCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeLoadBalancerPoliciesCommandInput} for command's `input` shape. + * @see {@link DescribeLoadBalancerPoliciesCommandOutput} for command's `response` shape. + * @see {@link ElasticLoadBalancingClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeLoadBalancerPoliciesCommand extends $Command< DescribeLoadBalancerPoliciesCommandInput, diff --git a/clients/client-elastic-load-balancing/commands/DescribeLoadBalancerPolicyTypesCommand.ts b/clients/client-elastic-load-balancing/commands/DescribeLoadBalancerPolicyTypesCommand.ts index c26ea3a439ab..8ef01cf4ac19 100644 --- a/clients/client-elastic-load-balancing/commands/DescribeLoadBalancerPolicyTypesCommand.ts +++ b/clients/client-elastic-load-balancing/commands/DescribeLoadBalancerPolicyTypesCommand.ts @@ -35,6 +35,20 @@ export interface DescribeLoadBalancerPolicyTypesCommandOutput *

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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ElasticLoadBalancingClient, DescribeLoadBalancerPolicyTypesCommand } from "@aws-sdk/client-elastic-load-balancing"; // ES Modules import + * // const { ElasticLoadBalancingClient, DescribeLoadBalancerPolicyTypesCommand } = require("@aws-sdk/client-elastic-load-balancing"); // CommonJS import + * const client = new ElasticLoadBalancingClient(config); + * const command = new DescribeLoadBalancerPolicyTypesCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeLoadBalancerPolicyTypesCommandInput} for command's `input` shape. + * @see {@link DescribeLoadBalancerPolicyTypesCommandOutput} for command's `response` shape. + * @see {@link ElasticLoadBalancingClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeLoadBalancerPolicyTypesCommand extends $Command< DescribeLoadBalancerPolicyTypesCommandInput, diff --git a/clients/client-elastic-load-balancing/commands/DescribeLoadBalancersCommand.ts b/clients/client-elastic-load-balancing/commands/DescribeLoadBalancersCommand.ts index e48a7536efd8..81f8cb5cbad1 100644 --- a/clients/client-elastic-load-balancing/commands/DescribeLoadBalancersCommand.ts +++ b/clients/client-elastic-load-balancing/commands/DescribeLoadBalancersCommand.ts @@ -26,6 +26,20 @@ export interface DescribeLoadBalancersCommandOutput extends DescribeAccessPoints /** *

Describes the specified the load balancers. If no load balancers are specified, the call describes all of your load balancers.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ElasticLoadBalancingClient, DescribeLoadBalancersCommand } from "@aws-sdk/client-elastic-load-balancing"; // ES Modules import + * // const { ElasticLoadBalancingClient, DescribeLoadBalancersCommand } = require("@aws-sdk/client-elastic-load-balancing"); // CommonJS import + * const client = new ElasticLoadBalancingClient(config); + * const command = new DescribeLoadBalancersCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeLoadBalancersCommandInput} for command's `input` shape. + * @see {@link DescribeLoadBalancersCommandOutput} for command's `response` shape. + * @see {@link ElasticLoadBalancingClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeLoadBalancersCommand extends $Command< DescribeLoadBalancersCommandInput, diff --git a/clients/client-elastic-load-balancing/commands/DescribeTagsCommand.ts b/clients/client-elastic-load-balancing/commands/DescribeTagsCommand.ts index f3b1e8c47208..756feff5685d 100644 --- a/clients/client-elastic-load-balancing/commands/DescribeTagsCommand.ts +++ b/clients/client-elastic-load-balancing/commands/DescribeTagsCommand.ts @@ -23,6 +23,20 @@ export interface DescribeTagsCommandOutput extends DescribeTagsOutput, __Metadat /** *

Describes the tags associated with the specified load balancers.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ElasticLoadBalancingClient, DescribeTagsCommand } from "@aws-sdk/client-elastic-load-balancing"; // ES Modules import + * // const { ElasticLoadBalancingClient, DescribeTagsCommand } = require("@aws-sdk/client-elastic-load-balancing"); // CommonJS import + * const client = new ElasticLoadBalancingClient(config); + * const command = new DescribeTagsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeTagsCommandInput} for command's `input` shape. + * @see {@link DescribeTagsCommandOutput} for command's `response` shape. + * @see {@link ElasticLoadBalancingClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeTagsCommand extends $Command< DescribeTagsCommandInput, diff --git a/clients/client-elastic-load-balancing/commands/DetachLoadBalancerFromSubnetsCommand.ts b/clients/client-elastic-load-balancing/commands/DetachLoadBalancerFromSubnetsCommand.ts index def8edb882c9..52da560835f3 100644 --- a/clients/client-elastic-load-balancing/commands/DetachLoadBalancerFromSubnetsCommand.ts +++ b/clients/client-elastic-load-balancing/commands/DetachLoadBalancerFromSubnetsCommand.ts @@ -31,6 +31,20 @@ export interface DetachLoadBalancerFromSubnetsCommandOutput *

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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ElasticLoadBalancingClient, DetachLoadBalancerFromSubnetsCommand } from "@aws-sdk/client-elastic-load-balancing"; // ES Modules import + * // const { ElasticLoadBalancingClient, DetachLoadBalancerFromSubnetsCommand } = require("@aws-sdk/client-elastic-load-balancing"); // CommonJS import + * const client = new ElasticLoadBalancingClient(config); + * const command = new DetachLoadBalancerFromSubnetsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DetachLoadBalancerFromSubnetsCommandInput} for command's `input` shape. + * @see {@link DetachLoadBalancerFromSubnetsCommandOutput} for command's `response` shape. + * @see {@link ElasticLoadBalancingClientResolvedConfig | config} for command's `input` shape. + * */ export class DetachLoadBalancerFromSubnetsCommand extends $Command< DetachLoadBalancerFromSubnetsCommandInput, diff --git a/clients/client-elastic-load-balancing/commands/DisableAvailabilityZonesForLoadBalancerCommand.ts b/clients/client-elastic-load-balancing/commands/DisableAvailabilityZonesForLoadBalancerCommand.ts index 064bb9cd6e7e..1acb7e6bd7a9 100644 --- a/clients/client-elastic-load-balancing/commands/DisableAvailabilityZonesForLoadBalancerCommand.ts +++ b/clients/client-elastic-load-balancing/commands/DisableAvailabilityZonesForLoadBalancerCommand.ts @@ -36,6 +36,20 @@ export interface DisableAvailabilityZonesForLoadBalancerCommandOutput * the traffic among its remaining Availability Zones.

*

For more information, see Add or Remove Availability Zones * in the Classic Load Balancers Guide.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ElasticLoadBalancingClient, DisableAvailabilityZonesForLoadBalancerCommand } from "@aws-sdk/client-elastic-load-balancing"; // ES Modules import + * // const { ElasticLoadBalancingClient, DisableAvailabilityZonesForLoadBalancerCommand } = require("@aws-sdk/client-elastic-load-balancing"); // CommonJS import + * const client = new ElasticLoadBalancingClient(config); + * const command = new DisableAvailabilityZonesForLoadBalancerCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DisableAvailabilityZonesForLoadBalancerCommandInput} for command's `input` shape. + * @see {@link DisableAvailabilityZonesForLoadBalancerCommandOutput} for command's `response` shape. + * @see {@link ElasticLoadBalancingClientResolvedConfig | config} for command's `input` shape. + * */ export class DisableAvailabilityZonesForLoadBalancerCommand extends $Command< DisableAvailabilityZonesForLoadBalancerCommandInput, diff --git a/clients/client-elastic-load-balancing/commands/EnableAvailabilityZonesForLoadBalancerCommand.ts b/clients/client-elastic-load-balancing/commands/EnableAvailabilityZonesForLoadBalancerCommand.ts index f3a086c3e70b..74d8261544e2 100644 --- a/clients/client-elastic-load-balancing/commands/EnableAvailabilityZonesForLoadBalancerCommand.ts +++ b/clients/client-elastic-load-balancing/commands/EnableAvailabilityZonesForLoadBalancerCommand.ts @@ -33,6 +33,20 @@ export interface EnableAvailabilityZonesForLoadBalancerCommandOutput *

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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ElasticLoadBalancingClient, EnableAvailabilityZonesForLoadBalancerCommand } from "@aws-sdk/client-elastic-load-balancing"; // ES Modules import + * // const { ElasticLoadBalancingClient, EnableAvailabilityZonesForLoadBalancerCommand } = require("@aws-sdk/client-elastic-load-balancing"); // CommonJS import + * const client = new ElasticLoadBalancingClient(config); + * const command = new EnableAvailabilityZonesForLoadBalancerCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link EnableAvailabilityZonesForLoadBalancerCommandInput} for command's `input` shape. + * @see {@link EnableAvailabilityZonesForLoadBalancerCommandOutput} for command's `response` shape. + * @see {@link ElasticLoadBalancingClientResolvedConfig | config} for command's `input` shape. + * */ export class EnableAvailabilityZonesForLoadBalancerCommand extends $Command< EnableAvailabilityZonesForLoadBalancerCommandInput, diff --git a/clients/client-elastic-load-balancing/commands/ModifyLoadBalancerAttributesCommand.ts b/clients/client-elastic-load-balancing/commands/ModifyLoadBalancerAttributesCommand.ts index 75ed43de095d..d81a467be687 100644 --- a/clients/client-elastic-load-balancing/commands/ModifyLoadBalancerAttributesCommand.ts +++ b/clients/client-elastic-load-balancing/commands/ModifyLoadBalancerAttributesCommand.ts @@ -54,6 +54,20 @@ export interface ModifyLoadBalancerAttributesCommandOutput *

* * + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ElasticLoadBalancingClient, ModifyLoadBalancerAttributesCommand } from "@aws-sdk/client-elastic-load-balancing"; // ES Modules import + * // const { ElasticLoadBalancingClient, ModifyLoadBalancerAttributesCommand } = require("@aws-sdk/client-elastic-load-balancing"); // CommonJS import + * const client = new ElasticLoadBalancingClient(config); + * const command = new ModifyLoadBalancerAttributesCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ModifyLoadBalancerAttributesCommandInput} for command's `input` shape. + * @see {@link ModifyLoadBalancerAttributesCommandOutput} for command's `response` shape. + * @see {@link ElasticLoadBalancingClientResolvedConfig | config} for command's `input` shape. + * */ export class ModifyLoadBalancerAttributesCommand extends $Command< ModifyLoadBalancerAttributesCommandInput, diff --git a/clients/client-elastic-load-balancing/commands/RegisterInstancesWithLoadBalancerCommand.ts b/clients/client-elastic-load-balancing/commands/RegisterInstancesWithLoadBalancerCommand.ts index 8396f0033f66..0a8fb65fbe3c 100644 --- a/clients/client-elastic-load-balancing/commands/RegisterInstancesWithLoadBalancerCommand.ts +++ b/clients/client-elastic-load-balancing/commands/RegisterInstancesWithLoadBalancerCommand.ts @@ -44,6 +44,20 @@ export interface RegisterInstancesWithLoadBalancerCommandOutput extends Register * *

For more information, see Register or De-Register EC2 Instances * in the Classic Load Balancers Guide.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ElasticLoadBalancingClient, RegisterInstancesWithLoadBalancerCommand } from "@aws-sdk/client-elastic-load-balancing"; // ES Modules import + * // const { ElasticLoadBalancingClient, RegisterInstancesWithLoadBalancerCommand } = require("@aws-sdk/client-elastic-load-balancing"); // CommonJS import + * const client = new ElasticLoadBalancingClient(config); + * const command = new RegisterInstancesWithLoadBalancerCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link RegisterInstancesWithLoadBalancerCommandInput} for command's `input` shape. + * @see {@link RegisterInstancesWithLoadBalancerCommandOutput} for command's `response` shape. + * @see {@link ElasticLoadBalancingClientResolvedConfig | config} for command's `input` shape. + * */ export class RegisterInstancesWithLoadBalancerCommand extends $Command< RegisterInstancesWithLoadBalancerCommandInput, diff --git a/clients/client-elastic-load-balancing/commands/RemoveTagsCommand.ts b/clients/client-elastic-load-balancing/commands/RemoveTagsCommand.ts index c5b2b2e1df2e..cc6c33a21375 100644 --- a/clients/client-elastic-load-balancing/commands/RemoveTagsCommand.ts +++ b/clients/client-elastic-load-balancing/commands/RemoveTagsCommand.ts @@ -23,6 +23,20 @@ export interface RemoveTagsCommandOutput extends RemoveTagsOutput, __MetadataBea /** *

Removes one or more tags from the specified load balancer.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ElasticLoadBalancingClient, RemoveTagsCommand } from "@aws-sdk/client-elastic-load-balancing"; // ES Modules import + * // const { ElasticLoadBalancingClient, RemoveTagsCommand } = require("@aws-sdk/client-elastic-load-balancing"); // CommonJS import + * const client = new ElasticLoadBalancingClient(config); + * const command = new RemoveTagsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link RemoveTagsCommandInput} for command's `input` shape. + * @see {@link RemoveTagsCommandOutput} for command's `response` shape. + * @see {@link ElasticLoadBalancingClientResolvedConfig | config} for command's `input` shape. + * */ export class RemoveTagsCommand extends $Command< RemoveTagsCommandInput, diff --git a/clients/client-elastic-load-balancing/commands/SetLoadBalancerListenerSSLCertificateCommand.ts b/clients/client-elastic-load-balancing/commands/SetLoadBalancerListenerSSLCertificateCommand.ts index 15bca5436d01..f265a50d078a 100644 --- a/clients/client-elastic-load-balancing/commands/SetLoadBalancerListenerSSLCertificateCommand.ts +++ b/clients/client-elastic-load-balancing/commands/SetLoadBalancerListenerSSLCertificateCommand.ts @@ -35,6 +35,20 @@ export interface SetLoadBalancerListenerSSLCertificateCommandOutput *

For more information about updating your SSL certificate, see * Replace the SSL Certificate for Your Load Balancer * in the Classic Load Balancers Guide.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ElasticLoadBalancingClient, SetLoadBalancerListenerSSLCertificateCommand } from "@aws-sdk/client-elastic-load-balancing"; // ES Modules import + * // const { ElasticLoadBalancingClient, SetLoadBalancerListenerSSLCertificateCommand } = require("@aws-sdk/client-elastic-load-balancing"); // CommonJS import + * const client = new ElasticLoadBalancingClient(config); + * const command = new SetLoadBalancerListenerSSLCertificateCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link SetLoadBalancerListenerSSLCertificateCommandInput} for command's `input` shape. + * @see {@link SetLoadBalancerListenerSSLCertificateCommandOutput} for command's `response` shape. + * @see {@link ElasticLoadBalancingClientResolvedConfig | config} for command's `input` shape. + * */ export class SetLoadBalancerListenerSSLCertificateCommand extends $Command< SetLoadBalancerListenerSSLCertificateCommandInput, diff --git a/clients/client-elastic-load-balancing/commands/SetLoadBalancerPoliciesForBackendServerCommand.ts b/clients/client-elastic-load-balancing/commands/SetLoadBalancerPoliciesForBackendServerCommand.ts index f361a1d81f78..f84f0f96ef06 100644 --- a/clients/client-elastic-load-balancing/commands/SetLoadBalancerPoliciesForBackendServerCommand.ts +++ b/clients/client-elastic-load-balancing/commands/SetLoadBalancerPoliciesForBackendServerCommand.ts @@ -42,6 +42,20 @@ export interface SetLoadBalancerPoliciesForBackendServerCommandOutput * in the Classic Load Balancers Guide. For more information about Proxy Protocol, see * Configure Proxy Protocol Support * in the Classic Load Balancers Guide.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ElasticLoadBalancingClient, SetLoadBalancerPoliciesForBackendServerCommand } from "@aws-sdk/client-elastic-load-balancing"; // ES Modules import + * // const { ElasticLoadBalancingClient, SetLoadBalancerPoliciesForBackendServerCommand } = require("@aws-sdk/client-elastic-load-balancing"); // CommonJS import + * const client = new ElasticLoadBalancingClient(config); + * const command = new SetLoadBalancerPoliciesForBackendServerCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link SetLoadBalancerPoliciesForBackendServerCommandInput} for command's `input` shape. + * @see {@link SetLoadBalancerPoliciesForBackendServerCommandOutput} for command's `response` shape. + * @see {@link ElasticLoadBalancingClientResolvedConfig | config} for command's `input` shape. + * */ export class SetLoadBalancerPoliciesForBackendServerCommand extends $Command< SetLoadBalancerPoliciesForBackendServerCommandInput, diff --git a/clients/client-elastic-load-balancing/commands/SetLoadBalancerPoliciesOfListenerCommand.ts b/clients/client-elastic-load-balancing/commands/SetLoadBalancerPoliciesOfListenerCommand.ts index 61a896bc7274..3a38441a684c 100644 --- a/clients/client-elastic-load-balancing/commands/SetLoadBalancerPoliciesOfListenerCommand.ts +++ b/clients/client-elastic-load-balancing/commands/SetLoadBalancerPoliciesOfListenerCommand.ts @@ -34,6 +34,20 @@ export interface SetLoadBalancerPoliciesOfListenerCommandOutput * Duration-Based Session Stickiness, and * Application-Controlled Session Stickiness * in the Classic Load Balancers Guide.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ElasticLoadBalancingClient, SetLoadBalancerPoliciesOfListenerCommand } from "@aws-sdk/client-elastic-load-balancing"; // ES Modules import + * // const { ElasticLoadBalancingClient, SetLoadBalancerPoliciesOfListenerCommand } = require("@aws-sdk/client-elastic-load-balancing"); // CommonJS import + * const client = new ElasticLoadBalancingClient(config); + * const command = new SetLoadBalancerPoliciesOfListenerCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link SetLoadBalancerPoliciesOfListenerCommandInput} for command's `input` shape. + * @see {@link SetLoadBalancerPoliciesOfListenerCommandOutput} for command's `response` shape. + * @see {@link ElasticLoadBalancingClientResolvedConfig | config} for command's `input` shape. + * */ export class SetLoadBalancerPoliciesOfListenerCommand extends $Command< SetLoadBalancerPoliciesOfListenerCommandInput, diff --git a/clients/client-elastic-load-balancing/models/models_0.ts b/clients/client-elastic-load-balancing/models/models_0.ts index 0bdefc4ebc72..ceaf10569fcc 100644 --- a/clients/client-elastic-load-balancing/models/models_0.ts +++ b/clients/client-elastic-load-balancing/models/models_0.ts @@ -29,6 +29,9 @@ export interface AccessLog { } export namespace AccessLog { + /** + * @internal + */ export const filterSensitiveLog = (obj: AccessLog): any => ({ ...obj, }); @@ -44,6 +47,9 @@ export interface AccessPointNotFoundException extends __SmithyException, $Metada } export namespace AccessPointNotFoundException { + /** + * @internal + */ export const filterSensitiveLog = (obj: AccessPointNotFoundException): any => ({ ...obj, }); @@ -65,6 +71,9 @@ export interface AddAvailabilityZonesInput { } export namespace AddAvailabilityZonesInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: AddAvailabilityZonesInput): any => ({ ...obj, }); @@ -81,6 +90,9 @@ export interface AddAvailabilityZonesOutput { } export namespace AddAvailabilityZonesOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: AddAvailabilityZonesOutput): any => ({ ...obj, }); @@ -111,6 +123,9 @@ export interface AdditionalAttribute { } export namespace AdditionalAttribute { + /** + * @internal + */ export const filterSensitiveLog = (obj: AdditionalAttribute): any => ({ ...obj, }); @@ -132,6 +147,9 @@ export interface Tag { } export namespace Tag { + /** + * @internal + */ export const filterSensitiveLog = (obj: Tag): any => ({ ...obj, }); @@ -153,6 +171,9 @@ export interface AddTagsInput { } export namespace AddTagsInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: AddTagsInput): any => ({ ...obj, }); @@ -164,6 +185,9 @@ export namespace AddTagsInput { export interface AddTagsOutput {} export namespace AddTagsOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: AddTagsOutput): any => ({ ...obj, }); @@ -179,6 +203,9 @@ export interface DuplicateTagKeysException extends __SmithyException, $MetadataB } export namespace DuplicateTagKeysException { + /** + * @internal + */ export const filterSensitiveLog = (obj: DuplicateTagKeysException): any => ({ ...obj, }); @@ -194,6 +221,9 @@ export interface TooManyTagsException extends __SmithyException, $MetadataBearer } export namespace TooManyTagsException { + /** + * @internal + */ export const filterSensitiveLog = (obj: TooManyTagsException): any => ({ ...obj, }); @@ -215,6 +245,9 @@ export interface AppCookieStickinessPolicy { } export namespace AppCookieStickinessPolicy { + /** + * @internal + */ export const filterSensitiveLog = (obj: AppCookieStickinessPolicy): any => ({ ...obj, }); @@ -236,6 +269,9 @@ export interface ApplySecurityGroupsToLoadBalancerInput { } export namespace ApplySecurityGroupsToLoadBalancerInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: ApplySecurityGroupsToLoadBalancerInput): any => ({ ...obj, }); @@ -252,6 +288,9 @@ export interface ApplySecurityGroupsToLoadBalancerOutput { } export namespace ApplySecurityGroupsToLoadBalancerOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: ApplySecurityGroupsToLoadBalancerOutput): any => ({ ...obj, }); @@ -267,6 +306,9 @@ export interface InvalidConfigurationRequestException extends __SmithyException, } export namespace InvalidConfigurationRequestException { + /** + * @internal + */ export const filterSensitiveLog = (obj: InvalidConfigurationRequestException): any => ({ ...obj, }); @@ -282,6 +324,9 @@ export interface InvalidSecurityGroupException extends __SmithyException, $Metad } export namespace InvalidSecurityGroupException { + /** + * @internal + */ export const filterSensitiveLog = (obj: InvalidSecurityGroupException): any => ({ ...obj, }); @@ -303,6 +348,9 @@ export interface AttachLoadBalancerToSubnetsInput { } export namespace AttachLoadBalancerToSubnetsInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: AttachLoadBalancerToSubnetsInput): any => ({ ...obj, }); @@ -319,6 +367,9 @@ export interface AttachLoadBalancerToSubnetsOutput { } export namespace AttachLoadBalancerToSubnetsOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: AttachLoadBalancerToSubnetsOutput): any => ({ ...obj, }); @@ -334,6 +385,9 @@ export interface InvalidSubnetException extends __SmithyException, $MetadataBear } export namespace InvalidSubnetException { + /** + * @internal + */ export const filterSensitiveLog = (obj: InvalidSubnetException): any => ({ ...obj, }); @@ -349,6 +403,9 @@ export interface SubnetNotFoundException extends __SmithyException, $MetadataBea } export namespace SubnetNotFoundException { + /** + * @internal + */ export const filterSensitiveLog = (obj: SubnetNotFoundException): any => ({ ...obj, }); @@ -370,6 +427,9 @@ export interface BackendServerDescription { } export namespace BackendServerDescription { + /** + * @internal + */ export const filterSensitiveLog = (obj: BackendServerDescription): any => ({ ...obj, }); @@ -387,6 +447,9 @@ export interface CertificateNotFoundException extends __SmithyException, $Metada } export namespace CertificateNotFoundException { + /** + * @internal + */ export const filterSensitiveLog = (obj: CertificateNotFoundException): any => ({ ...obj, }); @@ -428,6 +491,9 @@ export interface HealthCheck { } export namespace HealthCheck { + /** + * @internal + */ export const filterSensitiveLog = (obj: HealthCheck): any => ({ ...obj, }); @@ -449,6 +515,9 @@ export interface ConfigureHealthCheckInput { } export namespace ConfigureHealthCheckInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: ConfigureHealthCheckInput): any => ({ ...obj, }); @@ -465,6 +534,9 @@ export interface ConfigureHealthCheckOutput { } export namespace ConfigureHealthCheckOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: ConfigureHealthCheckOutput): any => ({ ...obj, }); @@ -486,6 +558,9 @@ export interface ConnectionDraining { } export namespace ConnectionDraining { + /** + * @internal + */ export const filterSensitiveLog = (obj: ConnectionDraining): any => ({ ...obj, }); @@ -502,6 +577,9 @@ export interface ConnectionSettings { } export namespace ConnectionSettings { + /** + * @internal + */ export const filterSensitiveLog = (obj: ConnectionSettings): any => ({ ...obj, }); @@ -546,6 +624,9 @@ export interface Listener { } export namespace Listener { + /** + * @internal + */ export const filterSensitiveLog = (obj: Listener): any => ({ ...obj, }); @@ -605,6 +686,9 @@ export interface CreateAccessPointInput { } export namespace CreateAccessPointInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateAccessPointInput): any => ({ ...obj, }); @@ -621,6 +705,9 @@ export interface CreateAccessPointOutput { } export namespace CreateAccessPointOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateAccessPointOutput): any => ({ ...obj, }); @@ -647,6 +734,9 @@ export interface CreateAppCookieStickinessPolicyInput { } export namespace CreateAppCookieStickinessPolicyInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateAppCookieStickinessPolicyInput): any => ({ ...obj, }); @@ -658,6 +748,9 @@ export namespace CreateAppCookieStickinessPolicyInput { export interface CreateAppCookieStickinessPolicyOutput {} export namespace CreateAppCookieStickinessPolicyOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateAppCookieStickinessPolicyOutput): any => ({ ...obj, }); @@ -673,6 +766,9 @@ export interface DuplicatePolicyNameException extends __SmithyException, $Metada } export namespace DuplicatePolicyNameException { + /** + * @internal + */ export const filterSensitiveLog = (obj: DuplicatePolicyNameException): any => ({ ...obj, }); @@ -688,6 +784,9 @@ export interface TooManyPoliciesException extends __SmithyException, $MetadataBe } export namespace TooManyPoliciesException { + /** + * @internal + */ export const filterSensitiveLog = (obj: TooManyPoliciesException): any => ({ ...obj, }); @@ -714,6 +813,9 @@ export interface CreateLBCookieStickinessPolicyInput { } export namespace CreateLBCookieStickinessPolicyInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateLBCookieStickinessPolicyInput): any => ({ ...obj, }); @@ -725,6 +827,9 @@ export namespace CreateLBCookieStickinessPolicyInput { export interface CreateLBCookieStickinessPolicyOutput {} export namespace CreateLBCookieStickinessPolicyOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateLBCookieStickinessPolicyOutput): any => ({ ...obj, }); @@ -740,6 +845,9 @@ export interface DuplicateAccessPointNameException extends __SmithyException, $M } export namespace DuplicateAccessPointNameException { + /** + * @internal + */ export const filterSensitiveLog = (obj: DuplicateAccessPointNameException): any => ({ ...obj, }); @@ -755,6 +863,9 @@ export interface InvalidSchemeException extends __SmithyException, $MetadataBear } export namespace InvalidSchemeException { + /** + * @internal + */ export const filterSensitiveLog = (obj: InvalidSchemeException): any => ({ ...obj, }); @@ -770,6 +881,9 @@ export interface OperationNotPermittedException extends __SmithyException, $Meta } export namespace OperationNotPermittedException { + /** + * @internal + */ export const filterSensitiveLog = (obj: OperationNotPermittedException): any => ({ ...obj, }); @@ -785,6 +899,9 @@ export interface TooManyAccessPointsException extends __SmithyException, $Metada } export namespace TooManyAccessPointsException { + /** + * @internal + */ export const filterSensitiveLog = (obj: TooManyAccessPointsException): any => ({ ...obj, }); @@ -800,6 +917,9 @@ export interface UnsupportedProtocolException extends __SmithyException, $Metada } export namespace UnsupportedProtocolException { + /** + * @internal + */ export const filterSensitiveLog = (obj: UnsupportedProtocolException): any => ({ ...obj, }); @@ -821,6 +941,9 @@ export interface CreateLoadBalancerListenerInput { } export namespace CreateLoadBalancerListenerInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateLoadBalancerListenerInput): any => ({ ...obj, }); @@ -832,6 +955,9 @@ export namespace CreateLoadBalancerListenerInput { export interface CreateLoadBalancerListenerOutput {} export namespace CreateLoadBalancerListenerOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateLoadBalancerListenerOutput): any => ({ ...obj, }); @@ -847,6 +973,9 @@ export interface DuplicateListenerException extends __SmithyException, $Metadata } export namespace DuplicateListenerException { + /** + * @internal + */ export const filterSensitiveLog = (obj: DuplicateListenerException): any => ({ ...obj, }); @@ -868,6 +997,9 @@ export interface PolicyAttribute { } export namespace PolicyAttribute { + /** + * @internal + */ export const filterSensitiveLog = (obj: PolicyAttribute): any => ({ ...obj, }); @@ -900,6 +1032,9 @@ export interface CreateLoadBalancerPolicyInput { } export namespace CreateLoadBalancerPolicyInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateLoadBalancerPolicyInput): any => ({ ...obj, }); @@ -911,6 +1046,9 @@ export namespace CreateLoadBalancerPolicyInput { export interface CreateLoadBalancerPolicyOutput {} export namespace CreateLoadBalancerPolicyOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateLoadBalancerPolicyOutput): any => ({ ...obj, }); @@ -926,6 +1064,9 @@ export interface PolicyTypeNotFoundException extends __SmithyException, $Metadat } export namespace PolicyTypeNotFoundException { + /** + * @internal + */ export const filterSensitiveLog = (obj: PolicyTypeNotFoundException): any => ({ ...obj, }); @@ -942,6 +1083,9 @@ export interface CrossZoneLoadBalancing { } export namespace CrossZoneLoadBalancing { + /** + * @internal + */ export const filterSensitiveLog = (obj: CrossZoneLoadBalancing): any => ({ ...obj, }); @@ -958,6 +1102,9 @@ export interface DeleteAccessPointInput { } export namespace DeleteAccessPointInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteAccessPointInput): any => ({ ...obj, }); @@ -969,6 +1116,9 @@ export namespace DeleteAccessPointInput { export interface DeleteAccessPointOutput {} export namespace DeleteAccessPointOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteAccessPointOutput): any => ({ ...obj, }); @@ -990,6 +1140,9 @@ export interface DeleteLoadBalancerListenerInput { } export namespace DeleteLoadBalancerListenerInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteLoadBalancerListenerInput): any => ({ ...obj, }); @@ -1001,6 +1154,9 @@ export namespace DeleteLoadBalancerListenerInput { export interface DeleteLoadBalancerListenerOutput {} export namespace DeleteLoadBalancerListenerOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteLoadBalancerListenerOutput): any => ({ ...obj, }); @@ -1022,6 +1178,9 @@ export interface DeleteLoadBalancerPolicyInput { } export namespace DeleteLoadBalancerPolicyInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteLoadBalancerPolicyInput): any => ({ ...obj, }); @@ -1033,6 +1192,9 @@ export namespace DeleteLoadBalancerPolicyInput { export interface DeleteLoadBalancerPolicyOutput {} export namespace DeleteLoadBalancerPolicyOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteLoadBalancerPolicyOutput): any => ({ ...obj, }); @@ -1048,6 +1210,9 @@ export interface DependencyThrottleException extends __SmithyException, $Metadat } export namespace DependencyThrottleException { + /** + * @internal + */ export const filterSensitiveLog = (obj: DependencyThrottleException): any => ({ ...obj, }); @@ -1064,6 +1229,9 @@ export interface Instance { } export namespace Instance { + /** + * @internal + */ export const filterSensitiveLog = (obj: Instance): any => ({ ...obj, }); @@ -1085,6 +1253,9 @@ export interface DeregisterEndPointsInput { } export namespace DeregisterEndPointsInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeregisterEndPointsInput): any => ({ ...obj, }); @@ -1101,6 +1272,9 @@ export interface DeregisterEndPointsOutput { } export namespace DeregisterEndPointsOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeregisterEndPointsOutput): any => ({ ...obj, }); @@ -1116,6 +1290,9 @@ export interface InvalidEndPointException extends __SmithyException, $MetadataBe } export namespace InvalidEndPointException { + /** + * @internal + */ export const filterSensitiveLog = (obj: InvalidEndPointException): any => ({ ...obj, }); @@ -1142,6 +1319,9 @@ export interface DescribeAccessPointsInput { } export namespace DescribeAccessPointsInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeAccessPointsInput): any => ({ ...obj, }); @@ -1163,6 +1343,9 @@ export interface ListenerDescription { } export namespace ListenerDescription { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListenerDescription): any => ({ ...obj, }); @@ -1184,6 +1367,9 @@ export interface LBCookieStickinessPolicy { } export namespace LBCookieStickinessPolicy { + /** + * @internal + */ export const filterSensitiveLog = (obj: LBCookieStickinessPolicy): any => ({ ...obj, }); @@ -1210,6 +1396,9 @@ export interface Policies { } export namespace Policies { + /** + * @internal + */ export const filterSensitiveLog = (obj: Policies): any => ({ ...obj, }); @@ -1231,6 +1420,9 @@ export interface SourceSecurityGroup { } export namespace SourceSecurityGroup { + /** + * @internal + */ export const filterSensitiveLog = (obj: SourceSecurityGroup): any => ({ ...obj, }); @@ -1329,6 +1521,9 @@ export interface LoadBalancerDescription { } export namespace LoadBalancerDescription { + /** + * @internal + */ export const filterSensitiveLog = (obj: LoadBalancerDescription): any => ({ ...obj, }); @@ -1350,6 +1545,9 @@ export interface DescribeAccessPointsOutput { } export namespace DescribeAccessPointsOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeAccessPointsOutput): any => ({ ...obj, }); @@ -1368,6 +1566,9 @@ export interface DescribeAccountLimitsInput { } export namespace DescribeAccountLimitsInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeAccountLimitsInput): any => ({ ...obj, }); @@ -1400,6 +1601,9 @@ export interface Limit { } export namespace Limit { + /** + * @internal + */ export const filterSensitiveLog = (obj: Limit): any => ({ ...obj, }); @@ -1418,6 +1622,9 @@ export interface DescribeAccountLimitsOutput { } export namespace DescribeAccountLimitsOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeAccountLimitsOutput): any => ({ ...obj, }); @@ -1439,6 +1646,9 @@ export interface DescribeEndPointStateInput { } export namespace DescribeEndPointStateInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeEndPointStateInput): any => ({ ...obj, }); @@ -1537,6 +1747,9 @@ export interface InstanceState { } export namespace InstanceState { + /** + * @internal + */ export const filterSensitiveLog = (obj: InstanceState): any => ({ ...obj, }); @@ -1553,6 +1766,9 @@ export interface DescribeEndPointStateOutput { } export namespace DescribeEndPointStateOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeEndPointStateOutput): any => ({ ...obj, }); @@ -1569,6 +1785,9 @@ export interface DescribeLoadBalancerAttributesInput { } export namespace DescribeLoadBalancerAttributesInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeLoadBalancerAttributesInput): any => ({ ...obj, }); @@ -1614,6 +1833,9 @@ export interface LoadBalancerAttributes { } export namespace LoadBalancerAttributes { + /** + * @internal + */ export const filterSensitiveLog = (obj: LoadBalancerAttributes): any => ({ ...obj, }); @@ -1630,6 +1852,9 @@ export interface DescribeLoadBalancerAttributesOutput { } export namespace DescribeLoadBalancerAttributesOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeLoadBalancerAttributesOutput): any => ({ ...obj, }); @@ -1645,6 +1870,9 @@ export interface LoadBalancerAttributeNotFoundException extends __SmithyExceptio } export namespace LoadBalancerAttributeNotFoundException { + /** + * @internal + */ export const filterSensitiveLog = (obj: LoadBalancerAttributeNotFoundException): any => ({ ...obj, }); @@ -1666,6 +1894,9 @@ export interface DescribeLoadBalancerPoliciesInput { } export namespace DescribeLoadBalancerPoliciesInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeLoadBalancerPoliciesInput): any => ({ ...obj, }); @@ -1687,6 +1918,9 @@ export interface PolicyAttributeDescription { } export namespace PolicyAttributeDescription { + /** + * @internal + */ export const filterSensitiveLog = (obj: PolicyAttributeDescription): any => ({ ...obj, }); @@ -1713,6 +1947,9 @@ export interface PolicyDescription { } export namespace PolicyDescription { + /** + * @internal + */ export const filterSensitiveLog = (obj: PolicyDescription): any => ({ ...obj, }); @@ -1729,6 +1966,9 @@ export interface DescribeLoadBalancerPoliciesOutput { } export namespace DescribeLoadBalancerPoliciesOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeLoadBalancerPoliciesOutput): any => ({ ...obj, }); @@ -1744,6 +1984,9 @@ export interface PolicyNotFoundException extends __SmithyException, $MetadataBea } export namespace PolicyNotFoundException { + /** + * @internal + */ export const filterSensitiveLog = (obj: PolicyNotFoundException): any => ({ ...obj, }); @@ -1760,6 +2003,9 @@ export interface DescribeLoadBalancerPolicyTypesInput { } export namespace DescribeLoadBalancerPolicyTypesInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeLoadBalancerPolicyTypesInput): any => ({ ...obj, }); @@ -1811,6 +2057,9 @@ export interface PolicyAttributeTypeDescription { } export namespace PolicyAttributeTypeDescription { + /** + * @internal + */ export const filterSensitiveLog = (obj: PolicyAttributeTypeDescription): any => ({ ...obj, }); @@ -1837,6 +2086,9 @@ export interface PolicyTypeDescription { } export namespace PolicyTypeDescription { + /** + * @internal + */ export const filterSensitiveLog = (obj: PolicyTypeDescription): any => ({ ...obj, }); @@ -1853,6 +2105,9 @@ export interface DescribeLoadBalancerPolicyTypesOutput { } export namespace DescribeLoadBalancerPolicyTypesOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeLoadBalancerPolicyTypesOutput): any => ({ ...obj, }); @@ -1869,6 +2124,9 @@ export interface DescribeTagsInput { } export namespace DescribeTagsInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeTagsInput): any => ({ ...obj, }); @@ -1890,6 +2148,9 @@ export interface TagDescription { } export namespace TagDescription { + /** + * @internal + */ export const filterSensitiveLog = (obj: TagDescription): any => ({ ...obj, }); @@ -1906,6 +2167,9 @@ export interface DescribeTagsOutput { } export namespace DescribeTagsOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeTagsOutput): any => ({ ...obj, }); @@ -1927,6 +2191,9 @@ export interface DetachLoadBalancerFromSubnetsInput { } export namespace DetachLoadBalancerFromSubnetsInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: DetachLoadBalancerFromSubnetsInput): any => ({ ...obj, }); @@ -1943,6 +2210,9 @@ export interface DetachLoadBalancerFromSubnetsOutput { } export namespace DetachLoadBalancerFromSubnetsOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: DetachLoadBalancerFromSubnetsOutput): any => ({ ...obj, }); @@ -1964,6 +2234,9 @@ export interface RemoveAvailabilityZonesInput { } export namespace RemoveAvailabilityZonesInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: RemoveAvailabilityZonesInput): any => ({ ...obj, }); @@ -1980,6 +2253,9 @@ export interface RemoveAvailabilityZonesOutput { } export namespace RemoveAvailabilityZonesOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: RemoveAvailabilityZonesOutput): any => ({ ...obj, }); @@ -2001,6 +2277,9 @@ export interface ModifyLoadBalancerAttributesInput { } export namespace ModifyLoadBalancerAttributesInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: ModifyLoadBalancerAttributesInput): any => ({ ...obj, }); @@ -2022,6 +2301,9 @@ export interface ModifyLoadBalancerAttributesOutput { } export namespace ModifyLoadBalancerAttributesOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: ModifyLoadBalancerAttributesOutput): any => ({ ...obj, }); @@ -2043,6 +2325,9 @@ export interface RegisterEndPointsInput { } export namespace RegisterEndPointsInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: RegisterEndPointsInput): any => ({ ...obj, }); @@ -2059,6 +2344,9 @@ export interface RegisterEndPointsOutput { } export namespace RegisterEndPointsOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: RegisterEndPointsOutput): any => ({ ...obj, }); @@ -2075,6 +2363,9 @@ export interface TagKeyOnly { } export namespace TagKeyOnly { + /** + * @internal + */ export const filterSensitiveLog = (obj: TagKeyOnly): any => ({ ...obj, }); @@ -2096,6 +2387,9 @@ export interface RemoveTagsInput { } export namespace RemoveTagsInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: RemoveTagsInput): any => ({ ...obj, }); @@ -2107,6 +2401,9 @@ export namespace RemoveTagsInput { export interface RemoveTagsOutput {} export namespace RemoveTagsOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: RemoveTagsOutput): any => ({ ...obj, }); @@ -2122,6 +2419,9 @@ export interface ListenerNotFoundException extends __SmithyException, $MetadataB } export namespace ListenerNotFoundException { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListenerNotFoundException): any => ({ ...obj, }); @@ -2148,6 +2448,9 @@ export interface SetLoadBalancerListenerSSLCertificateInput { } export namespace SetLoadBalancerListenerSSLCertificateInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: SetLoadBalancerListenerSSLCertificateInput): any => ({ ...obj, }); @@ -2159,6 +2462,9 @@ export namespace SetLoadBalancerListenerSSLCertificateInput { export interface SetLoadBalancerListenerSSLCertificateOutput {} export namespace SetLoadBalancerListenerSSLCertificateOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: SetLoadBalancerListenerSSLCertificateOutput): any => ({ ...obj, }); @@ -2185,6 +2491,9 @@ export interface SetLoadBalancerPoliciesForBackendServerInput { } export namespace SetLoadBalancerPoliciesForBackendServerInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: SetLoadBalancerPoliciesForBackendServerInput): any => ({ ...obj, }); @@ -2196,6 +2505,9 @@ export namespace SetLoadBalancerPoliciesForBackendServerInput { export interface SetLoadBalancerPoliciesForBackendServerOutput {} export namespace SetLoadBalancerPoliciesForBackendServerOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: SetLoadBalancerPoliciesForBackendServerOutput): any => ({ ...obj, }); @@ -2222,6 +2534,9 @@ export interface SetLoadBalancerPoliciesOfListenerInput { } export namespace SetLoadBalancerPoliciesOfListenerInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: SetLoadBalancerPoliciesOfListenerInput): any => ({ ...obj, }); @@ -2233,6 +2548,9 @@ export namespace SetLoadBalancerPoliciesOfListenerInput { export interface SetLoadBalancerPoliciesOfListenerOutput {} export namespace SetLoadBalancerPoliciesOfListenerOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: SetLoadBalancerPoliciesOfListenerOutput): any => ({ ...obj, }); diff --git a/clients/client-elastic-transcoder/commands/CancelJobCommand.ts b/clients/client-elastic-transcoder/commands/CancelJobCommand.ts index f4851dba5a13..b568369d1554 100644 --- a/clients/client-elastic-transcoder/commands/CancelJobCommand.ts +++ b/clients/client-elastic-transcoder/commands/CancelJobCommand.ts @@ -31,6 +31,20 @@ export interface CancelJobCommandOutput extends CancelJobResponse, __MetadataBea * pipeline from starting to process a job while you're getting the job identifier, use * UpdatePipelineStatus to temporarily pause the pipeline.

* + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ElasticTranscoderClient, CancelJobCommand } from "@aws-sdk/client-elastic-transcoder"; // ES Modules import + * // const { ElasticTranscoderClient, CancelJobCommand } = require("@aws-sdk/client-elastic-transcoder"); // CommonJS import + * const client = new ElasticTranscoderClient(config); + * const command = new CancelJobCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CancelJobCommandInput} for command's `input` shape. + * @see {@link CancelJobCommandOutput} for command's `response` shape. + * @see {@link ElasticTranscoderClientResolvedConfig | config} for command's `input` shape. + * */ export class CancelJobCommand extends $Command< CancelJobCommandInput, diff --git a/clients/client-elastic-transcoder/commands/CreateJobCommand.ts b/clients/client-elastic-transcoder/commands/CreateJobCommand.ts index 5bc90fe5f430..187ecc4d9bd6 100644 --- a/clients/client-elastic-transcoder/commands/CreateJobCommand.ts +++ b/clients/client-elastic-transcoder/commands/CreateJobCommand.ts @@ -30,6 +30,20 @@ export interface CreateJobCommandOutput extends CreateJobResponse, __MetadataBea *

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).

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ElasticTranscoderClient, CreateJobCommand } from "@aws-sdk/client-elastic-transcoder"; // ES Modules import + * // const { ElasticTranscoderClient, CreateJobCommand } = require("@aws-sdk/client-elastic-transcoder"); // CommonJS import + * const client = new ElasticTranscoderClient(config); + * const command = new CreateJobCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreateJobCommandInput} for command's `input` shape. + * @see {@link CreateJobCommandOutput} for command's `response` shape. + * @see {@link ElasticTranscoderClientResolvedConfig | config} for command's `input` shape. + * */ export class CreateJobCommand extends $Command< CreateJobCommandInput, diff --git a/clients/client-elastic-transcoder/commands/CreatePipelineCommand.ts b/clients/client-elastic-transcoder/commands/CreatePipelineCommand.ts index 0d3257967989..ea140cef1c0b 100644 --- a/clients/client-elastic-transcoder/commands/CreatePipelineCommand.ts +++ b/clients/client-elastic-transcoder/commands/CreatePipelineCommand.ts @@ -26,6 +26,20 @@ export interface CreatePipelineCommandOutput extends CreatePipelineResponse, __M /** *

The CreatePipeline operation creates a pipeline with settings that you specify.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ElasticTranscoderClient, CreatePipelineCommand } from "@aws-sdk/client-elastic-transcoder"; // ES Modules import + * // const { ElasticTranscoderClient, CreatePipelineCommand } = require("@aws-sdk/client-elastic-transcoder"); // CommonJS import + * const client = new ElasticTranscoderClient(config); + * const command = new CreatePipelineCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreatePipelineCommandInput} for command's `input` shape. + * @see {@link CreatePipelineCommandOutput} for command's `response` shape. + * @see {@link ElasticTranscoderClientResolvedConfig | config} for command's `input` shape. + * */ export class CreatePipelineCommand extends $Command< CreatePipelineCommandInput, diff --git a/clients/client-elastic-transcoder/commands/CreatePresetCommand.ts b/clients/client-elastic-transcoder/commands/CreatePresetCommand.ts index ccaa96ca8c98..7325b9dfa7ea 100644 --- a/clients/client-elastic-transcoder/commands/CreatePresetCommand.ts +++ b/clients/client-elastic-transcoder/commands/CreatePresetCommand.ts @@ -39,6 +39,20 @@ export interface CreatePresetCommandOutput extends CreatePresetResponse, __Metad *

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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ElasticTranscoderClient, CreatePresetCommand } from "@aws-sdk/client-elastic-transcoder"; // ES Modules import + * // const { ElasticTranscoderClient, CreatePresetCommand } = require("@aws-sdk/client-elastic-transcoder"); // CommonJS import + * const client = new ElasticTranscoderClient(config); + * const command = new CreatePresetCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreatePresetCommandInput} for command's `input` shape. + * @see {@link CreatePresetCommandOutput} for command's `response` shape. + * @see {@link ElasticTranscoderClientResolvedConfig | config} for command's `input` shape. + * */ export class CreatePresetCommand extends $Command< CreatePresetCommandInput, diff --git a/clients/client-elastic-transcoder/commands/DeletePipelineCommand.ts b/clients/client-elastic-transcoder/commands/DeletePipelineCommand.ts index f3b74ccab3e5..d1ed3daf52c5 100644 --- a/clients/client-elastic-transcoder/commands/DeletePipelineCommand.ts +++ b/clients/client-elastic-transcoder/commands/DeletePipelineCommand.ts @@ -29,6 +29,20 @@ export interface DeletePipelineCommandOutput extends DeletePipelineResponse, __M *

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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ElasticTranscoderClient, DeletePipelineCommand } from "@aws-sdk/client-elastic-transcoder"; // ES Modules import + * // const { ElasticTranscoderClient, DeletePipelineCommand } = require("@aws-sdk/client-elastic-transcoder"); // CommonJS import + * const client = new ElasticTranscoderClient(config); + * const command = new DeletePipelineCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeletePipelineCommandInput} for command's `input` shape. + * @see {@link DeletePipelineCommandOutput} for command's `response` shape. + * @see {@link ElasticTranscoderClientResolvedConfig | config} for command's `input` shape. + * */ export class DeletePipelineCommand extends $Command< DeletePipelineCommandInput, diff --git a/clients/client-elastic-transcoder/commands/DeletePresetCommand.ts b/clients/client-elastic-transcoder/commands/DeletePresetCommand.ts index 23c9361c011a..39ebba79732a 100644 --- a/clients/client-elastic-transcoder/commands/DeletePresetCommand.ts +++ b/clients/client-elastic-transcoder/commands/DeletePresetCommand.ts @@ -29,6 +29,20 @@ export interface DeletePresetCommandOutput extends DeletePresetResponse, __Metad * *

You can't delete the default presets that are included with Elastic Transcoder.

* + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ElasticTranscoderClient, DeletePresetCommand } from "@aws-sdk/client-elastic-transcoder"; // ES Modules import + * // const { ElasticTranscoderClient, DeletePresetCommand } = require("@aws-sdk/client-elastic-transcoder"); // CommonJS import + * const client = new ElasticTranscoderClient(config); + * const command = new DeletePresetCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeletePresetCommandInput} for command's `input` shape. + * @see {@link DeletePresetCommandOutput} for command's `response` shape. + * @see {@link ElasticTranscoderClientResolvedConfig | config} for command's `input` shape. + * */ export class DeletePresetCommand extends $Command< DeletePresetCommandInput, diff --git a/clients/client-elastic-transcoder/commands/ListJobsByPipelineCommand.ts b/clients/client-elastic-transcoder/commands/ListJobsByPipelineCommand.ts index ef6d0eda9509..51dfc116215d 100644 --- a/clients/client-elastic-transcoder/commands/ListJobsByPipelineCommand.ts +++ b/clients/client-elastic-transcoder/commands/ListJobsByPipelineCommand.ts @@ -28,6 +28,20 @@ export interface ListJobsByPipelineCommandOutput extends ListJobsByPipelineRespo *

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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ElasticTranscoderClient, ListJobsByPipelineCommand } from "@aws-sdk/client-elastic-transcoder"; // ES Modules import + * // const { ElasticTranscoderClient, ListJobsByPipelineCommand } = require("@aws-sdk/client-elastic-transcoder"); // CommonJS import + * const client = new ElasticTranscoderClient(config); + * const command = new ListJobsByPipelineCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListJobsByPipelineCommandInput} for command's `input` shape. + * @see {@link ListJobsByPipelineCommandOutput} for command's `response` shape. + * @see {@link ElasticTranscoderClientResolvedConfig | config} for command's `input` shape. + * */ export class ListJobsByPipelineCommand extends $Command< ListJobsByPipelineCommandInput, diff --git a/clients/client-elastic-transcoder/commands/ListJobsByStatusCommand.ts b/clients/client-elastic-transcoder/commands/ListJobsByStatusCommand.ts index b53b57ac3ce8..7a3d52a80217 100644 --- a/clients/client-elastic-transcoder/commands/ListJobsByStatusCommand.ts +++ b/clients/client-elastic-transcoder/commands/ListJobsByStatusCommand.ts @@ -27,6 +27,20 @@ export interface ListJobsByStatusCommandOutput extends ListJobsByStatusResponse, /** *

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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ElasticTranscoderClient, ListJobsByStatusCommand } from "@aws-sdk/client-elastic-transcoder"; // ES Modules import + * // const { ElasticTranscoderClient, ListJobsByStatusCommand } = require("@aws-sdk/client-elastic-transcoder"); // CommonJS import + * const client = new ElasticTranscoderClient(config); + * const command = new ListJobsByStatusCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListJobsByStatusCommandInput} for command's `input` shape. + * @see {@link ListJobsByStatusCommandOutput} for command's `response` shape. + * @see {@link ElasticTranscoderClientResolvedConfig | config} for command's `input` shape. + * */ export class ListJobsByStatusCommand extends $Command< ListJobsByStatusCommandInput, diff --git a/clients/client-elastic-transcoder/commands/ListPipelinesCommand.ts b/clients/client-elastic-transcoder/commands/ListPipelinesCommand.ts index 46d99f6f63f9..55d6aa99930b 100644 --- a/clients/client-elastic-transcoder/commands/ListPipelinesCommand.ts +++ b/clients/client-elastic-transcoder/commands/ListPipelinesCommand.ts @@ -26,6 +26,20 @@ export interface ListPipelinesCommandOutput extends ListPipelinesResponse, __Met /** *

The ListPipelines operation gets a list of the pipelines associated with the current AWS account.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ElasticTranscoderClient, ListPipelinesCommand } from "@aws-sdk/client-elastic-transcoder"; // ES Modules import + * // const { ElasticTranscoderClient, ListPipelinesCommand } = require("@aws-sdk/client-elastic-transcoder"); // CommonJS import + * const client = new ElasticTranscoderClient(config); + * const command = new ListPipelinesCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListPipelinesCommandInput} for command's `input` shape. + * @see {@link ListPipelinesCommandOutput} for command's `response` shape. + * @see {@link ElasticTranscoderClientResolvedConfig | config} for command's `input` shape. + * */ export class ListPipelinesCommand extends $Command< ListPipelinesCommandInput, diff --git a/clients/client-elastic-transcoder/commands/ListPresetsCommand.ts b/clients/client-elastic-transcoder/commands/ListPresetsCommand.ts index 35749d2ec0f4..31c7790226b7 100644 --- a/clients/client-elastic-transcoder/commands/ListPresetsCommand.ts +++ b/clients/client-elastic-transcoder/commands/ListPresetsCommand.ts @@ -27,6 +27,20 @@ export interface ListPresetsCommandOutput extends ListPresetsResponse, __Metadat /** *

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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ElasticTranscoderClient, ListPresetsCommand } from "@aws-sdk/client-elastic-transcoder"; // ES Modules import + * // const { ElasticTranscoderClient, ListPresetsCommand } = require("@aws-sdk/client-elastic-transcoder"); // CommonJS import + * const client = new ElasticTranscoderClient(config); + * const command = new ListPresetsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListPresetsCommandInput} for command's `input` shape. + * @see {@link ListPresetsCommandOutput} for command's `response` shape. + * @see {@link ElasticTranscoderClientResolvedConfig | config} for command's `input` shape. + * */ export class ListPresetsCommand extends $Command< ListPresetsCommandInput, diff --git a/clients/client-elastic-transcoder/commands/ReadJobCommand.ts b/clients/client-elastic-transcoder/commands/ReadJobCommand.ts index 8c5d455a1eb0..5709e854c9a2 100644 --- a/clients/client-elastic-transcoder/commands/ReadJobCommand.ts +++ b/clients/client-elastic-transcoder/commands/ReadJobCommand.ts @@ -26,6 +26,20 @@ export interface ReadJobCommandOutput extends ReadJobResponse, __MetadataBearer /** *

The ReadJob operation returns detailed information about a job.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ElasticTranscoderClient, ReadJobCommand } from "@aws-sdk/client-elastic-transcoder"; // ES Modules import + * // const { ElasticTranscoderClient, ReadJobCommand } = require("@aws-sdk/client-elastic-transcoder"); // CommonJS import + * const client = new ElasticTranscoderClient(config); + * const command = new ReadJobCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ReadJobCommandInput} for command's `input` shape. + * @see {@link ReadJobCommandOutput} for command's `response` shape. + * @see {@link ElasticTranscoderClientResolvedConfig | config} for command's `input` shape. + * */ export class ReadJobCommand extends $Command< ReadJobCommandInput, diff --git a/clients/client-elastic-transcoder/commands/ReadPipelineCommand.ts b/clients/client-elastic-transcoder/commands/ReadPipelineCommand.ts index 4eb3a8b0b922..8c878dcea09d 100644 --- a/clients/client-elastic-transcoder/commands/ReadPipelineCommand.ts +++ b/clients/client-elastic-transcoder/commands/ReadPipelineCommand.ts @@ -26,6 +26,20 @@ export interface ReadPipelineCommandOutput extends ReadPipelineResponse, __Metad /** *

The ReadPipeline operation gets detailed information about a pipeline.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ElasticTranscoderClient, ReadPipelineCommand } from "@aws-sdk/client-elastic-transcoder"; // ES Modules import + * // const { ElasticTranscoderClient, ReadPipelineCommand } = require("@aws-sdk/client-elastic-transcoder"); // CommonJS import + * const client = new ElasticTranscoderClient(config); + * const command = new ReadPipelineCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ReadPipelineCommandInput} for command's `input` shape. + * @see {@link ReadPipelineCommandOutput} for command's `response` shape. + * @see {@link ElasticTranscoderClientResolvedConfig | config} for command's `input` shape. + * */ export class ReadPipelineCommand extends $Command< ReadPipelineCommandInput, diff --git a/clients/client-elastic-transcoder/commands/ReadPresetCommand.ts b/clients/client-elastic-transcoder/commands/ReadPresetCommand.ts index 73b83bd11b90..df24f4399ae5 100644 --- a/clients/client-elastic-transcoder/commands/ReadPresetCommand.ts +++ b/clients/client-elastic-transcoder/commands/ReadPresetCommand.ts @@ -26,6 +26,20 @@ export interface ReadPresetCommandOutput extends ReadPresetResponse, __MetadataB /** *

The ReadPreset operation gets detailed information about a preset.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ElasticTranscoderClient, ReadPresetCommand } from "@aws-sdk/client-elastic-transcoder"; // ES Modules import + * // const { ElasticTranscoderClient, ReadPresetCommand } = require("@aws-sdk/client-elastic-transcoder"); // CommonJS import + * const client = new ElasticTranscoderClient(config); + * const command = new ReadPresetCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ReadPresetCommandInput} for command's `input` shape. + * @see {@link ReadPresetCommandOutput} for command's `response` shape. + * @see {@link ElasticTranscoderClientResolvedConfig | config} for command's `input` shape. + * */ export class ReadPresetCommand extends $Command< ReadPresetCommandInput, diff --git a/clients/client-elastic-transcoder/commands/TestRoleCommand.ts b/clients/client-elastic-transcoder/commands/TestRoleCommand.ts index f33c270a4996..5a58570256ee 100644 --- a/clients/client-elastic-transcoder/commands/TestRoleCommand.ts +++ b/clients/client-elastic-transcoder/commands/TestRoleCommand.ts @@ -33,6 +33,20 @@ export interface TestRoleCommandOutput extends TestRoleResponse, __MetadataBeare * 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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ElasticTranscoderClient, TestRoleCommand } from "@aws-sdk/client-elastic-transcoder"; // ES Modules import + * // const { ElasticTranscoderClient, TestRoleCommand } = require("@aws-sdk/client-elastic-transcoder"); // CommonJS import + * const client = new ElasticTranscoderClient(config); + * const command = new TestRoleCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link TestRoleCommandInput} for command's `input` shape. + * @see {@link TestRoleCommandOutput} for command's `response` shape. + * @see {@link ElasticTranscoderClientResolvedConfig | config} for command's `input` shape. + * */ export class TestRoleCommand extends $Command< TestRoleCommandInput, diff --git a/clients/client-elastic-transcoder/commands/UpdatePipelineCommand.ts b/clients/client-elastic-transcoder/commands/UpdatePipelineCommand.ts index 3836ca10d210..bdd84417a511 100644 --- a/clients/client-elastic-transcoder/commands/UpdatePipelineCommand.ts +++ b/clients/client-elastic-transcoder/commands/UpdatePipelineCommand.ts @@ -31,6 +31,20 @@ export interface UpdatePipelineCommandOutput extends UpdatePipelineResponse, __M * 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.

* + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ElasticTranscoderClient, UpdatePipelineCommand } from "@aws-sdk/client-elastic-transcoder"; // ES Modules import + * // const { ElasticTranscoderClient, UpdatePipelineCommand } = require("@aws-sdk/client-elastic-transcoder"); // CommonJS import + * const client = new ElasticTranscoderClient(config); + * const command = new UpdatePipelineCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link UpdatePipelineCommandInput} for command's `input` shape. + * @see {@link UpdatePipelineCommandOutput} for command's `response` shape. + * @see {@link ElasticTranscoderClientResolvedConfig | config} for command's `input` shape. + * */ export class UpdatePipelineCommand extends $Command< UpdatePipelineCommandInput, diff --git a/clients/client-elastic-transcoder/commands/UpdatePipelineNotificationsCommand.ts b/clients/client-elastic-transcoder/commands/UpdatePipelineNotificationsCommand.ts index bb3b98db3b85..3af15163c864 100644 --- a/clients/client-elastic-transcoder/commands/UpdatePipelineNotificationsCommand.ts +++ b/clients/client-elastic-transcoder/commands/UpdatePipelineNotificationsCommand.ts @@ -29,6 +29,20 @@ export interface UpdatePipelineNotificationsCommandOutput /** *

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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ElasticTranscoderClient, UpdatePipelineNotificationsCommand } from "@aws-sdk/client-elastic-transcoder"; // ES Modules import + * // const { ElasticTranscoderClient, UpdatePipelineNotificationsCommand } = require("@aws-sdk/client-elastic-transcoder"); // CommonJS import + * const client = new ElasticTranscoderClient(config); + * const command = new UpdatePipelineNotificationsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link UpdatePipelineNotificationsCommandInput} for command's `input` shape. + * @see {@link UpdatePipelineNotificationsCommandOutput} for command's `response` shape. + * @see {@link ElasticTranscoderClientResolvedConfig | config} for command's `input` shape. + * */ export class UpdatePipelineNotificationsCommand extends $Command< UpdatePipelineNotificationsCommandInput, diff --git a/clients/client-elastic-transcoder/commands/UpdatePipelineStatusCommand.ts b/clients/client-elastic-transcoder/commands/UpdatePipelineStatusCommand.ts index 963dec2b070f..58b49fdd08e5 100644 --- a/clients/client-elastic-transcoder/commands/UpdatePipelineStatusCommand.ts +++ b/clients/client-elastic-transcoder/commands/UpdatePipelineStatusCommand.ts @@ -31,6 +31,20 @@ export interface UpdatePipelineStatusCommandOutput extends UpdatePipelineStatusR * 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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ElasticTranscoderClient, UpdatePipelineStatusCommand } from "@aws-sdk/client-elastic-transcoder"; // ES Modules import + * // const { ElasticTranscoderClient, UpdatePipelineStatusCommand } = require("@aws-sdk/client-elastic-transcoder"); // CommonJS import + * const client = new ElasticTranscoderClient(config); + * const command = new UpdatePipelineStatusCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link UpdatePipelineStatusCommandInput} for command's `input` shape. + * @see {@link UpdatePipelineStatusCommandOutput} for command's `response` shape. + * @see {@link ElasticTranscoderClientResolvedConfig | config} for command's `input` shape. + * */ export class UpdatePipelineStatusCommand extends $Command< UpdatePipelineStatusCommandInput, diff --git a/clients/client-elastic-transcoder/models/models_0.ts b/clients/client-elastic-transcoder/models/models_0.ts index 3196ba572861..7433630b8faa 100644 --- a/clients/client-elastic-transcoder/models/models_0.ts +++ b/clients/client-elastic-transcoder/models/models_0.ts @@ -11,6 +11,9 @@ export interface AccessDeniedException extends __SmithyException, $MetadataBeare } export namespace AccessDeniedException { + /** + * @internal + */ export const filterSensitiveLog = (obj: AccessDeniedException): any => ({ ...obj, }); @@ -111,6 +114,9 @@ export interface Encryption { } export namespace Encryption { + /** + * @internal + */ export const filterSensitiveLog = (obj: Encryption): any => ({ ...obj, }); @@ -218,6 +224,9 @@ export interface Artwork { } export namespace Artwork { + /** + * @internal + */ export const filterSensitiveLog = (obj: Artwork): any => ({ ...obj, }); @@ -289,6 +298,9 @@ export interface AudioCodecOptions { } export namespace AudioCodecOptions { + /** + * @internal + */ export const filterSensitiveLog = (obj: AudioCodecOptions): any => ({ ...obj, }); @@ -557,6 +569,9 @@ export interface AudioParameters { } export namespace AudioParameters { + /** + * @internal + */ export const filterSensitiveLog = (obj: AudioParameters): any => ({ ...obj, }); @@ -575,6 +590,9 @@ export interface CancelJobRequest { } export namespace CancelJobRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: CancelJobRequest): any => ({ ...obj, }); @@ -587,6 +605,9 @@ export namespace CancelJobRequest { export interface CancelJobResponse {} export namespace CancelJobResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: CancelJobResponse): any => ({ ...obj, }); @@ -599,6 +620,9 @@ export interface IncompatibleVersionException extends __SmithyException, $Metada } export namespace IncompatibleVersionException { + /** + * @internal + */ export const filterSensitiveLog = (obj: IncompatibleVersionException): any => ({ ...obj, }); @@ -614,6 +638,9 @@ export interface InternalServiceException extends __SmithyException, $MetadataBe } export namespace InternalServiceException { + /** + * @internal + */ export const filterSensitiveLog = (obj: InternalServiceException): any => ({ ...obj, }); @@ -630,6 +657,9 @@ export interface ResourceInUseException extends __SmithyException, $MetadataBear } export namespace ResourceInUseException { + /** + * @internal + */ export const filterSensitiveLog = (obj: ResourceInUseException): any => ({ ...obj, }); @@ -646,6 +676,9 @@ export interface ResourceNotFoundException extends __SmithyException, $MetadataB } export namespace ResourceNotFoundException { + /** + * @internal + */ export const filterSensitiveLog = (obj: ResourceNotFoundException): any => ({ ...obj, }); @@ -661,6 +694,9 @@ export interface ValidationException extends __SmithyException, $MetadataBearer } export namespace ValidationException { + /** + * @internal + */ export const filterSensitiveLog = (obj: ValidationException): any => ({ ...obj, }); @@ -757,6 +793,9 @@ export interface CaptionFormat { } export namespace CaptionFormat { + /** + * @internal + */ export const filterSensitiveLog = (obj: CaptionFormat): any => ({ ...obj, }); @@ -808,6 +847,9 @@ export interface CaptionSource { } export namespace CaptionSource { + /** + * @internal + */ export const filterSensitiveLog = (obj: CaptionSource): any => ({ ...obj, }); @@ -863,6 +905,9 @@ export interface Captions { } export namespace Captions { + /** + * @internal + */ export const filterSensitiveLog = (obj: Captions): any => ({ ...obj, }); @@ -891,6 +936,9 @@ export interface TimeSpan { } export namespace TimeSpan { + /** + * @internal + */ export const filterSensitiveLog = (obj: TimeSpan): any => ({ ...obj, }); @@ -909,6 +957,9 @@ export interface Clip { } export namespace Clip { + /** + * @internal + */ export const filterSensitiveLog = (obj: Clip): any => ({ ...obj, }); @@ -945,6 +996,9 @@ export interface DetectedProperties { } export namespace DetectedProperties { + /** + * @internal + */ export const filterSensitiveLog = (obj: DetectedProperties): any => ({ ...obj, }); @@ -991,6 +1045,9 @@ export interface InputCaptions { } export namespace InputCaptions { + /** + * @internal + */ export const filterSensitiveLog = (obj: InputCaptions): any => ({ ...obj, }); @@ -1127,6 +1184,9 @@ export interface JobInput { } export namespace JobInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: JobInput): any => ({ ...obj, }); @@ -1172,6 +1232,9 @@ export interface JobAlbumArt { } export namespace JobAlbumArt { + /** + * @internal + */ export const filterSensitiveLog = (obj: JobAlbumArt): any => ({ ...obj, }); @@ -1207,6 +1270,9 @@ export interface JobWatermark { } export namespace JobWatermark { + /** + * @internal + */ export const filterSensitiveLog = (obj: JobWatermark): any => ({ ...obj, }); @@ -1386,6 +1452,9 @@ export interface CreateJobOutput { } export namespace CreateJobOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateJobOutput): any => ({ ...obj, }); @@ -1443,6 +1512,9 @@ export interface HlsContentProtection { } export namespace HlsContentProtection { + /** + * @internal + */ export const filterSensitiveLog = (obj: HlsContentProtection): any => ({ ...obj, }); @@ -1504,6 +1576,9 @@ export interface PlayReadyDrm { } export namespace PlayReadyDrm { + /** + * @internal + */ export const filterSensitiveLog = (obj: PlayReadyDrm): any => ({ ...obj, }); @@ -1591,6 +1666,9 @@ export interface CreateJobPlaylist { } export namespace CreateJobPlaylist { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateJobPlaylist): any => ({ ...obj, }); @@ -1658,6 +1736,9 @@ export interface CreateJobRequest { } export namespace CreateJobRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateJobRequest): any => ({ ...obj, }); @@ -1937,6 +2018,9 @@ export interface JobOutput { } export namespace JobOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: JobOutput): any => ({ ...obj, }); @@ -2034,6 +2118,9 @@ export interface Playlist { } export namespace Playlist { + /** + * @internal + */ export const filterSensitiveLog = (obj: Playlist): any => ({ ...obj, }); @@ -2060,6 +2147,9 @@ export interface Timing { } export namespace Timing { + /** + * @internal + */ export const filterSensitiveLog = (obj: Timing): any => ({ ...obj, }); @@ -2181,6 +2271,9 @@ export interface Job { } export namespace Job { + /** + * @internal + */ export const filterSensitiveLog = (obj: Job): any => ({ ...obj, }); @@ -2197,6 +2290,9 @@ export interface CreateJobResponse { } export namespace CreateJobResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateJobResponse): any => ({ ...obj, }); @@ -2213,6 +2309,9 @@ export interface LimitExceededException extends __SmithyException, $MetadataBear } export namespace LimitExceededException { + /** + * @internal + */ export const filterSensitiveLog = (obj: LimitExceededException): any => ({ ...obj, }); @@ -2287,6 +2386,9 @@ export interface Permission { } export namespace Permission { + /** + * @internal + */ export const filterSensitiveLog = (obj: Permission): any => ({ ...obj, }); @@ -2347,6 +2449,9 @@ export interface PipelineOutputConfig { } export namespace PipelineOutputConfig { + /** + * @internal + */ export const filterSensitiveLog = (obj: PipelineOutputConfig): any => ({ ...obj, }); @@ -2381,6 +2486,9 @@ export interface Notifications { } export namespace Notifications { + /** + * @internal + */ export const filterSensitiveLog = (obj: Notifications): any => ({ ...obj, }); @@ -2691,6 +2799,9 @@ export interface CreatePipelineRequest { } export namespace CreatePipelineRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreatePipelineRequest): any => ({ ...obj, }); @@ -2968,6 +3079,9 @@ export interface Pipeline { } export namespace Pipeline { + /** + * @internal + */ export const filterSensitiveLog = (obj: Pipeline): any => ({ ...obj, }); @@ -2995,6 +3109,9 @@ export interface Warning { } export namespace Warning { + /** + * @internal + */ export const filterSensitiveLog = (obj: Warning): any => ({ ...obj, }); @@ -3019,6 +3136,9 @@ export interface CreatePipelineResponse { } export namespace CreatePipelineResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreatePipelineResponse): any => ({ ...obj, }); @@ -3151,6 +3271,9 @@ export interface Thumbnails { } export namespace Thumbnails { + /** + * @internal + */ export const filterSensitiveLog = (obj: Thumbnails): any => ({ ...obj, }); @@ -3384,6 +3507,9 @@ export interface PresetWatermark { } export namespace PresetWatermark { + /** + * @internal + */ export const filterSensitiveLog = (obj: PresetWatermark): any => ({ ...obj, }); @@ -3964,6 +4090,9 @@ export interface VideoParameters { } export namespace VideoParameters { + /** + * @internal + */ export const filterSensitiveLog = (obj: VideoParameters): any => ({ ...obj, }); @@ -4009,6 +4138,9 @@ export interface CreatePresetRequest { } export namespace CreatePresetRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreatePresetRequest): any => ({ ...obj, }); @@ -4073,6 +4205,9 @@ export interface Preset { } export namespace Preset { + /** + * @internal + */ export const filterSensitiveLog = (obj: Preset): any => ({ ...obj, }); @@ -4097,6 +4232,9 @@ export interface CreatePresetResponse { } export namespace CreatePresetResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreatePresetResponse): any => ({ ...obj, }); @@ -4113,6 +4251,9 @@ export interface DeletePipelineRequest { } export namespace DeletePipelineRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeletePipelineRequest): any => ({ ...obj, }); @@ -4124,6 +4265,9 @@ export namespace DeletePipelineRequest { export interface DeletePipelineResponse {} export namespace DeletePipelineResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeletePipelineResponse): any => ({ ...obj, }); @@ -4140,6 +4284,9 @@ export interface DeletePresetRequest { } export namespace DeletePresetRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeletePresetRequest): any => ({ ...obj, }); @@ -4151,6 +4298,9 @@ export namespace DeletePresetRequest { export interface DeletePresetResponse {} export namespace DeletePresetResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeletePresetResponse): any => ({ ...obj, }); @@ -4180,6 +4330,9 @@ export interface ListJobsByPipelineRequest { } export namespace ListJobsByPipelineRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListJobsByPipelineRequest): any => ({ ...obj, }); @@ -4203,6 +4356,9 @@ export interface ListJobsByPipelineResponse { } export namespace ListJobsByPipelineResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListJobsByPipelineResponse): any => ({ ...obj, }); @@ -4235,6 +4391,9 @@ export interface ListJobsByStatusRequest { } export namespace ListJobsByStatusRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListJobsByStatusRequest): any => ({ ...obj, }); @@ -4260,6 +4419,9 @@ export interface ListJobsByStatusResponse { } export namespace ListJobsByStatusResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListJobsByStatusResponse): any => ({ ...obj, }); @@ -4284,6 +4446,9 @@ export interface ListPipelinesRequest { } export namespace ListPipelinesRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListPipelinesRequest): any => ({ ...obj, }); @@ -4307,6 +4472,9 @@ export interface ListPipelinesResponse { } export namespace ListPipelinesResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListPipelinesResponse): any => ({ ...obj, }); @@ -4331,6 +4499,9 @@ export interface ListPresetsRequest { } export namespace ListPresetsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListPresetsRequest): any => ({ ...obj, }); @@ -4354,6 +4525,9 @@ export interface ListPresetsResponse { } export namespace ListPresetsResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListPresetsResponse): any => ({ ...obj, }); @@ -4370,6 +4544,9 @@ export interface ReadJobRequest { } export namespace ReadJobRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ReadJobRequest): any => ({ ...obj, }); @@ -4386,6 +4563,9 @@ export interface ReadJobResponse { } export namespace ReadJobResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ReadJobResponse): any => ({ ...obj, }); @@ -4402,6 +4582,9 @@ export interface ReadPipelineRequest { } export namespace ReadPipelineRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ReadPipelineRequest): any => ({ ...obj, }); @@ -4426,6 +4609,9 @@ export interface ReadPipelineResponse { } export namespace ReadPipelineResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ReadPipelineResponse): any => ({ ...obj, }); @@ -4442,6 +4628,9 @@ export interface ReadPresetRequest { } export namespace ReadPresetRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ReadPresetRequest): any => ({ ...obj, }); @@ -4458,6 +4647,9 @@ export interface ReadPresetResponse { } export namespace ReadPresetResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ReadPresetResponse): any => ({ ...obj, }); @@ -4491,6 +4683,9 @@ export interface TestRoleRequest { } export namespace TestRoleRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: TestRoleRequest): any => ({ ...obj, }); @@ -4516,6 +4711,9 @@ export interface TestRoleResponse { } export namespace TestRoleResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: TestRoleResponse): any => ({ ...obj, }); @@ -4793,6 +4991,9 @@ export interface UpdatePipelineRequest { } export namespace UpdatePipelineRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdatePipelineRequest): any => ({ ...obj, }); @@ -4817,6 +5018,9 @@ export interface UpdatePipelineResponse { } export namespace UpdatePipelineResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdatePipelineResponse): any => ({ ...obj, }); @@ -4867,6 +5071,9 @@ export interface UpdatePipelineNotificationsRequest { } export namespace UpdatePipelineNotificationsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdatePipelineNotificationsRequest): any => ({ ...obj, }); @@ -4884,6 +5091,9 @@ export interface UpdatePipelineNotificationsResponse { } export namespace UpdatePipelineNotificationsResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdatePipelineNotificationsResponse): any => ({ ...obj, }); @@ -4915,6 +5125,9 @@ export interface UpdatePipelineStatusRequest { } export namespace UpdatePipelineStatusRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdatePipelineStatusRequest): any => ({ ...obj, }); @@ -4932,6 +5145,9 @@ export interface UpdatePipelineStatusResponse { } export namespace UpdatePipelineStatusResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdatePipelineStatusResponse): any => ({ ...obj, }); diff --git a/clients/client-elasticache/commands/AddTagsToResourceCommand.ts b/clients/client-elasticache/commands/AddTagsToResourceCommand.ts index d03e4ba16621..d0e3a99d5d01 100644 --- a/clients/client-elasticache/commands/AddTagsToResourceCommand.ts +++ b/clients/client-elasticache/commands/AddTagsToResourceCommand.ts @@ -33,6 +33,20 @@ export interface AddTagsToResourceCommandOutput extends TagListMessage, __Metada *

For more information, * see Using Cost Allocation Tags in Amazon ElastiCache * in the ElastiCache User Guide.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ElastiCacheClient, AddTagsToResourceCommand } from "@aws-sdk/client-elasticache"; // ES Modules import + * // const { ElastiCacheClient, AddTagsToResourceCommand } = require("@aws-sdk/client-elasticache"); // CommonJS import + * const client = new ElastiCacheClient(config); + * const command = new AddTagsToResourceCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link AddTagsToResourceCommandInput} for command's `input` shape. + * @see {@link AddTagsToResourceCommandOutput} for command's `response` shape. + * @see {@link ElastiCacheClientResolvedConfig | config} for command's `input` shape. + * */ export class AddTagsToResourceCommand extends $Command< AddTagsToResourceCommandInput, diff --git a/clients/client-elasticache/commands/AuthorizeCacheSecurityGroupIngressCommand.ts b/clients/client-elasticache/commands/AuthorizeCacheSecurityGroupIngressCommand.ts index 220496947a2e..5ded199928ed 100644 --- a/clients/client-elasticache/commands/AuthorizeCacheSecurityGroupIngressCommand.ts +++ b/clients/client-elasticache/commands/AuthorizeCacheSecurityGroupIngressCommand.ts @@ -33,6 +33,20 @@ export interface AuthorizeCacheSecurityGroupIngressCommandOutput *

You cannot authorize ingress from an Amazon EC2 security group in one region to an * ElastiCache cluster in another region.

* + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ElastiCacheClient, AuthorizeCacheSecurityGroupIngressCommand } from "@aws-sdk/client-elasticache"; // ES Modules import + * // const { ElastiCacheClient, AuthorizeCacheSecurityGroupIngressCommand } = require("@aws-sdk/client-elasticache"); // CommonJS import + * const client = new ElastiCacheClient(config); + * const command = new AuthorizeCacheSecurityGroupIngressCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link AuthorizeCacheSecurityGroupIngressCommandInput} for command's `input` shape. + * @see {@link AuthorizeCacheSecurityGroupIngressCommandOutput} for command's `response` shape. + * @see {@link ElastiCacheClientResolvedConfig | config} for command's `input` shape. + * */ export class AuthorizeCacheSecurityGroupIngressCommand extends $Command< AuthorizeCacheSecurityGroupIngressCommandInput, diff --git a/clients/client-elasticache/commands/BatchApplyUpdateActionCommand.ts b/clients/client-elasticache/commands/BatchApplyUpdateActionCommand.ts index 705414a6aa50..226b2a4a16d2 100644 --- a/clients/client-elasticache/commands/BatchApplyUpdateActionCommand.ts +++ b/clients/client-elasticache/commands/BatchApplyUpdateActionCommand.ts @@ -22,6 +22,20 @@ export interface BatchApplyUpdateActionCommandOutput extends UpdateActionResults /** *

Apply the service update. For more information on service updates and applying them, see Applying Service Updates.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ElastiCacheClient, BatchApplyUpdateActionCommand } from "@aws-sdk/client-elasticache"; // ES Modules import + * // const { ElastiCacheClient, BatchApplyUpdateActionCommand } = require("@aws-sdk/client-elasticache"); // CommonJS import + * const client = new ElastiCacheClient(config); + * const command = new BatchApplyUpdateActionCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link BatchApplyUpdateActionCommandInput} for command's `input` shape. + * @see {@link BatchApplyUpdateActionCommandOutput} for command's `response` shape. + * @see {@link ElastiCacheClientResolvedConfig | config} for command's `input` shape. + * */ export class BatchApplyUpdateActionCommand extends $Command< BatchApplyUpdateActionCommandInput, diff --git a/clients/client-elasticache/commands/BatchStopUpdateActionCommand.ts b/clients/client-elasticache/commands/BatchStopUpdateActionCommand.ts index 50beb74aded2..064cc2dd5db2 100644 --- a/clients/client-elasticache/commands/BatchStopUpdateActionCommand.ts +++ b/clients/client-elasticache/commands/BatchStopUpdateActionCommand.ts @@ -22,6 +22,20 @@ export interface BatchStopUpdateActionCommandOutput extends UpdateActionResultsM /** *

Stop the service update. For more information on service updates and stopping them, see Stopping Service Updates.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ElastiCacheClient, BatchStopUpdateActionCommand } from "@aws-sdk/client-elasticache"; // ES Modules import + * // const { ElastiCacheClient, BatchStopUpdateActionCommand } = require("@aws-sdk/client-elasticache"); // CommonJS import + * const client = new ElastiCacheClient(config); + * const command = new BatchStopUpdateActionCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link BatchStopUpdateActionCommandInput} for command's `input` shape. + * @see {@link BatchStopUpdateActionCommandOutput} for command's `response` shape. + * @see {@link ElastiCacheClientResolvedConfig | config} for command's `input` shape. + * */ export class BatchStopUpdateActionCommand extends $Command< BatchStopUpdateActionCommandInput, diff --git a/clients/client-elasticache/commands/CompleteMigrationCommand.ts b/clients/client-elasticache/commands/CompleteMigrationCommand.ts index 02df7e6e4bc9..f788b39c7988 100644 --- a/clients/client-elasticache/commands/CompleteMigrationCommand.ts +++ b/clients/client-elasticache/commands/CompleteMigrationCommand.ts @@ -22,6 +22,20 @@ export interface CompleteMigrationCommandOutput extends CompleteMigrationRespons /** *

Complete the migration of data.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ElastiCacheClient, CompleteMigrationCommand } from "@aws-sdk/client-elasticache"; // ES Modules import + * // const { ElastiCacheClient, CompleteMigrationCommand } = require("@aws-sdk/client-elasticache"); // CommonJS import + * const client = new ElastiCacheClient(config); + * const command = new CompleteMigrationCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CompleteMigrationCommandInput} for command's `input` shape. + * @see {@link CompleteMigrationCommandOutput} for command's `response` shape. + * @see {@link ElastiCacheClientResolvedConfig | config} for command's `input` shape. + * */ export class CompleteMigrationCommand extends $Command< CompleteMigrationCommandInput, diff --git a/clients/client-elasticache/commands/CopySnapshotCommand.ts b/clients/client-elasticache/commands/CopySnapshotCommand.ts index af2e8f3c3ff0..48741bb6f5fa 100644 --- a/clients/client-elasticache/commands/CopySnapshotCommand.ts +++ b/clients/client-elasticache/commands/CopySnapshotCommand.ts @@ -112,6 +112,20 @@ export interface CopySnapshotCommandOutput extends CopySnapshotResult, __Metadat * For more information, see Step 2: Grant ElastiCache Access to Your Amazon S3 Bucket in the ElastiCache User Guide.

* * + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ElastiCacheClient, CopySnapshotCommand } from "@aws-sdk/client-elasticache"; // ES Modules import + * // const { ElastiCacheClient, CopySnapshotCommand } = require("@aws-sdk/client-elasticache"); // CommonJS import + * const client = new ElastiCacheClient(config); + * const command = new CopySnapshotCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CopySnapshotCommandInput} for command's `input` shape. + * @see {@link CopySnapshotCommandOutput} for command's `response` shape. + * @see {@link ElastiCacheClientResolvedConfig | config} for command's `input` shape. + * */ export class CopySnapshotCommand extends $Command< CopySnapshotCommandInput, diff --git a/clients/client-elasticache/commands/CreateCacheClusterCommand.ts b/clients/client-elasticache/commands/CreateCacheClusterCommand.ts index 349a243ffa74..f0566e5d91fc 100644 --- a/clients/client-elasticache/commands/CreateCacheClusterCommand.ts +++ b/clients/client-elasticache/commands/CreateCacheClusterCommand.ts @@ -25,6 +25,20 @@ export interface CreateCacheClusterCommandOutput extends CreateCacheClusterResul * cluster run the same protocol-compliant cache engine software, either Memcached * or Redis.

*

This operation is not supported for Redis (cluster mode enabled) clusters.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ElastiCacheClient, CreateCacheClusterCommand } from "@aws-sdk/client-elasticache"; // ES Modules import + * // const { ElastiCacheClient, CreateCacheClusterCommand } = require("@aws-sdk/client-elasticache"); // CommonJS import + * const client = new ElastiCacheClient(config); + * const command = new CreateCacheClusterCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreateCacheClusterCommandInput} for command's `input` shape. + * @see {@link CreateCacheClusterCommandOutput} for command's `response` shape. + * @see {@link ElastiCacheClientResolvedConfig | config} for command's `input` shape. + * */ export class CreateCacheClusterCommand extends $Command< CreateCacheClusterCommandInput, diff --git a/clients/client-elasticache/commands/CreateCacheParameterGroupCommand.ts b/clients/client-elasticache/commands/CreateCacheParameterGroupCommand.ts index 482e89f6be2c..1ff0460321f9 100644 --- a/clients/client-elasticache/commands/CreateCacheParameterGroupCommand.ts +++ b/clients/client-elasticache/commands/CreateCacheParameterGroupCommand.ts @@ -37,6 +37,20 @@ export interface CreateCacheParameterGroupCommandOutput extends CreateCacheParam * Parameters and Parameter Groups in the ElastiCache User Guide.

* * + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ElastiCacheClient, CreateCacheParameterGroupCommand } from "@aws-sdk/client-elasticache"; // ES Modules import + * // const { ElastiCacheClient, CreateCacheParameterGroupCommand } = require("@aws-sdk/client-elasticache"); // CommonJS import + * const client = new ElastiCacheClient(config); + * const command = new CreateCacheParameterGroupCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreateCacheParameterGroupCommandInput} for command's `input` shape. + * @see {@link CreateCacheParameterGroupCommandOutput} for command's `response` shape. + * @see {@link ElastiCacheClientResolvedConfig | config} for command's `input` shape. + * */ export class CreateCacheParameterGroupCommand extends $Command< CreateCacheParameterGroupCommandInput, diff --git a/clients/client-elasticache/commands/CreateCacheSecurityGroupCommand.ts b/clients/client-elasticache/commands/CreateCacheSecurityGroupCommand.ts index c7b9c0c48eff..ac6e8e6987ba 100644 --- a/clients/client-elasticache/commands/CreateCacheSecurityGroupCommand.ts +++ b/clients/client-elasticache/commands/CreateCacheSecurityGroupCommand.ts @@ -27,6 +27,20 @@ export interface CreateCacheSecurityGroupCommandOutput extends CreateCacheSecuri * 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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ElastiCacheClient, CreateCacheSecurityGroupCommand } from "@aws-sdk/client-elasticache"; // ES Modules import + * // const { ElastiCacheClient, CreateCacheSecurityGroupCommand } = require("@aws-sdk/client-elasticache"); // CommonJS import + * const client = new ElastiCacheClient(config); + * const command = new CreateCacheSecurityGroupCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreateCacheSecurityGroupCommandInput} for command's `input` shape. + * @see {@link CreateCacheSecurityGroupCommandOutput} for command's `response` shape. + * @see {@link ElastiCacheClientResolvedConfig | config} for command's `input` shape. + * */ export class CreateCacheSecurityGroupCommand extends $Command< CreateCacheSecurityGroupCommandInput, diff --git a/clients/client-elasticache/commands/CreateCacheSubnetGroupCommand.ts b/clients/client-elasticache/commands/CreateCacheSubnetGroupCommand.ts index bdf49a34a595..95ab451031b8 100644 --- a/clients/client-elasticache/commands/CreateCacheSubnetGroupCommand.ts +++ b/clients/client-elasticache/commands/CreateCacheSubnetGroupCommand.ts @@ -23,6 +23,20 @@ export interface CreateCacheSubnetGroupCommandOutput extends CreateCacheSubnetGr /** *

Creates a new cache subnet group.

*

Use this parameter only when you are creating a cluster in an Amazon Virtual Private Cloud (Amazon VPC).

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ElastiCacheClient, CreateCacheSubnetGroupCommand } from "@aws-sdk/client-elasticache"; // ES Modules import + * // const { ElastiCacheClient, CreateCacheSubnetGroupCommand } = require("@aws-sdk/client-elasticache"); // CommonJS import + * const client = new ElastiCacheClient(config); + * const command = new CreateCacheSubnetGroupCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreateCacheSubnetGroupCommandInput} for command's `input` shape. + * @see {@link CreateCacheSubnetGroupCommandOutput} for command's `response` shape. + * @see {@link ElastiCacheClientResolvedConfig | config} for command's `input` shape. + * */ export class CreateCacheSubnetGroupCommand extends $Command< CreateCacheSubnetGroupCommandInput, diff --git a/clients/client-elasticache/commands/CreateGlobalReplicationGroupCommand.ts b/clients/client-elasticache/commands/CreateGlobalReplicationGroupCommand.ts index 00de92f886e4..b2fec04cbcc7 100644 --- a/clients/client-elasticache/commands/CreateGlobalReplicationGroupCommand.ts +++ b/clients/client-elasticache/commands/CreateGlobalReplicationGroupCommand.ts @@ -39,6 +39,20 @@ export interface CreateGlobalReplicationGroupCommandOutput *

The PrimaryReplicationGroupId represents the name of the primary cluster that accepts writes and will replicate updates to the secondary cluster.

* * + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ElastiCacheClient, CreateGlobalReplicationGroupCommand } from "@aws-sdk/client-elasticache"; // ES Modules import + * // const { ElastiCacheClient, CreateGlobalReplicationGroupCommand } = require("@aws-sdk/client-elasticache"); // CommonJS import + * const client = new ElastiCacheClient(config); + * const command = new CreateGlobalReplicationGroupCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreateGlobalReplicationGroupCommandInput} for command's `input` shape. + * @see {@link CreateGlobalReplicationGroupCommandOutput} for command's `response` shape. + * @see {@link ElastiCacheClientResolvedConfig | config} for command's `input` shape. + * */ export class CreateGlobalReplicationGroupCommand extends $Command< CreateGlobalReplicationGroupCommandInput, diff --git a/clients/client-elasticache/commands/CreateReplicationGroupCommand.ts b/clients/client-elasticache/commands/CreateReplicationGroupCommand.ts index 1daf8f5e6c3a..595f38a8dde5 100644 --- a/clients/client-elasticache/commands/CreateReplicationGroupCommand.ts +++ b/clients/client-elasticache/commands/CreateReplicationGroupCommand.ts @@ -48,6 +48,20 @@ export interface CreateReplicationGroupCommandOutput extends CreateReplicationGr * *

This operation is valid for Redis only.

* + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ElastiCacheClient, CreateReplicationGroupCommand } from "@aws-sdk/client-elasticache"; // ES Modules import + * // const { ElastiCacheClient, CreateReplicationGroupCommand } = require("@aws-sdk/client-elasticache"); // CommonJS import + * const client = new ElastiCacheClient(config); + * const command = new CreateReplicationGroupCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreateReplicationGroupCommandInput} for command's `input` shape. + * @see {@link CreateReplicationGroupCommandOutput} for command's `response` shape. + * @see {@link ElastiCacheClientResolvedConfig | config} for command's `input` shape. + * */ export class CreateReplicationGroupCommand extends $Command< CreateReplicationGroupCommandInput, diff --git a/clients/client-elasticache/commands/CreateSnapshotCommand.ts b/clients/client-elasticache/commands/CreateSnapshotCommand.ts index 584d622b4760..2cad3e0d48b8 100644 --- a/clients/client-elasticache/commands/CreateSnapshotCommand.ts +++ b/clients/client-elasticache/commands/CreateSnapshotCommand.ts @@ -27,6 +27,20 @@ export interface CreateSnapshotCommandOutput extends CreateSnapshotResult, __Met * *

This operation is valid for Redis only.

* + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ElastiCacheClient, CreateSnapshotCommand } from "@aws-sdk/client-elasticache"; // ES Modules import + * // const { ElastiCacheClient, CreateSnapshotCommand } = require("@aws-sdk/client-elasticache"); // CommonJS import + * const client = new ElastiCacheClient(config); + * const command = new CreateSnapshotCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreateSnapshotCommandInput} for command's `input` shape. + * @see {@link CreateSnapshotCommandOutput} for command's `response` shape. + * @see {@link ElastiCacheClientResolvedConfig | config} for command's `input` shape. + * */ export class CreateSnapshotCommand extends $Command< CreateSnapshotCommandInput, diff --git a/clients/client-elasticache/commands/CreateUserCommand.ts b/clients/client-elasticache/commands/CreateUserCommand.ts index 0bbd3acf6879..894a303e3f71 100644 --- a/clients/client-elasticache/commands/CreateUserCommand.ts +++ b/clients/client-elasticache/commands/CreateUserCommand.ts @@ -19,6 +19,20 @@ export interface CreateUserCommandOutput extends User, __MetadataBearer {} /** *

For Redis engine version 6.x onwards: Creates a Redis user. For more information, see Using Role Based Access Control (RBAC).

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ElastiCacheClient, CreateUserCommand } from "@aws-sdk/client-elasticache"; // ES Modules import + * // const { ElastiCacheClient, CreateUserCommand } = require("@aws-sdk/client-elasticache"); // CommonJS import + * const client = new ElastiCacheClient(config); + * const command = new CreateUserCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreateUserCommandInput} for command's `input` shape. + * @see {@link CreateUserCommandOutput} for command's `response` shape. + * @see {@link ElastiCacheClientResolvedConfig | config} for command's `input` shape. + * */ export class CreateUserCommand extends $Command< CreateUserCommandInput, diff --git a/clients/client-elasticache/commands/CreateUserGroupCommand.ts b/clients/client-elasticache/commands/CreateUserGroupCommand.ts index 9b62bac69da1..b38bbaa474ea 100644 --- a/clients/client-elasticache/commands/CreateUserGroupCommand.ts +++ b/clients/client-elasticache/commands/CreateUserGroupCommand.ts @@ -23,6 +23,20 @@ export interface CreateUserGroupCommandOutput extends UserGroup, __MetadataBeare /** *

For Redis engine version 6.x onwards: Creates a Redis user group. For more information, see Using Role Based Access Control (RBAC) *

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ElastiCacheClient, CreateUserGroupCommand } from "@aws-sdk/client-elasticache"; // ES Modules import + * // const { ElastiCacheClient, CreateUserGroupCommand } = require("@aws-sdk/client-elasticache"); // CommonJS import + * const client = new ElastiCacheClient(config); + * const command = new CreateUserGroupCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreateUserGroupCommandInput} for command's `input` shape. + * @see {@link CreateUserGroupCommandOutput} for command's `response` shape. + * @see {@link ElastiCacheClientResolvedConfig | config} for command's `input` shape. + * */ export class CreateUserGroupCommand extends $Command< CreateUserGroupCommandInput, diff --git a/clients/client-elasticache/commands/DecreaseNodeGroupsInGlobalReplicationGroupCommand.ts b/clients/client-elasticache/commands/DecreaseNodeGroupsInGlobalReplicationGroupCommand.ts index c1b516dbc78a..aa8850050aa0 100644 --- a/clients/client-elasticache/commands/DecreaseNodeGroupsInGlobalReplicationGroupCommand.ts +++ b/clients/client-elasticache/commands/DecreaseNodeGroupsInGlobalReplicationGroupCommand.ts @@ -28,6 +28,20 @@ export interface DecreaseNodeGroupsInGlobalReplicationGroupCommandOutput /** *

Decreases the number of node groups in a Global datastore

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ElastiCacheClient, DecreaseNodeGroupsInGlobalReplicationGroupCommand } from "@aws-sdk/client-elasticache"; // ES Modules import + * // const { ElastiCacheClient, DecreaseNodeGroupsInGlobalReplicationGroupCommand } = require("@aws-sdk/client-elasticache"); // CommonJS import + * const client = new ElastiCacheClient(config); + * const command = new DecreaseNodeGroupsInGlobalReplicationGroupCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DecreaseNodeGroupsInGlobalReplicationGroupCommandInput} for command's `input` shape. + * @see {@link DecreaseNodeGroupsInGlobalReplicationGroupCommandOutput} for command's `response` shape. + * @see {@link ElastiCacheClientResolvedConfig | config} for command's `input` shape. + * */ export class DecreaseNodeGroupsInGlobalReplicationGroupCommand extends $Command< DecreaseNodeGroupsInGlobalReplicationGroupCommandInput, diff --git a/clients/client-elasticache/commands/DecreaseReplicaCountCommand.ts b/clients/client-elasticache/commands/DecreaseReplicaCountCommand.ts index 307ede3cff73..cedecdeabbdc 100644 --- a/clients/client-elasticache/commands/DecreaseReplicaCountCommand.ts +++ b/clients/client-elasticache/commands/DecreaseReplicaCountCommand.ts @@ -24,6 +24,20 @@ export interface DecreaseReplicaCountCommandOutput extends DecreaseReplicaCountR *

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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ElastiCacheClient, DecreaseReplicaCountCommand } from "@aws-sdk/client-elasticache"; // ES Modules import + * // const { ElastiCacheClient, DecreaseReplicaCountCommand } = require("@aws-sdk/client-elasticache"); // CommonJS import + * const client = new ElastiCacheClient(config); + * const command = new DecreaseReplicaCountCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DecreaseReplicaCountCommandInput} for command's `input` shape. + * @see {@link DecreaseReplicaCountCommandOutput} for command's `response` shape. + * @see {@link ElastiCacheClientResolvedConfig | config} for command's `input` shape. + * */ export class DecreaseReplicaCountCommand extends $Command< DecreaseReplicaCountCommandInput, diff --git a/clients/client-elasticache/commands/DeleteCacheClusterCommand.ts b/clients/client-elasticache/commands/DeleteCacheClusterCommand.ts index e3a1c4e397bb..6320d0f7a26f 100644 --- a/clients/client-elasticache/commands/DeleteCacheClusterCommand.ts +++ b/clients/client-elasticache/commands/DeleteCacheClusterCommand.ts @@ -51,6 +51,20 @@ export interface DeleteCacheClusterCommandOutput extends DeleteCacheClusterResul *

A cluster that is not in the available state

* * + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ElastiCacheClient, DeleteCacheClusterCommand } from "@aws-sdk/client-elasticache"; // ES Modules import + * // const { ElastiCacheClient, DeleteCacheClusterCommand } = require("@aws-sdk/client-elasticache"); // CommonJS import + * const client = new ElastiCacheClient(config); + * const command = new DeleteCacheClusterCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteCacheClusterCommandInput} for command's `input` shape. + * @see {@link DeleteCacheClusterCommandOutput} for command's `response` shape. + * @see {@link ElastiCacheClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteCacheClusterCommand extends $Command< DeleteCacheClusterCommandInput, diff --git a/clients/client-elasticache/commands/DeleteCacheParameterGroupCommand.ts b/clients/client-elasticache/commands/DeleteCacheParameterGroupCommand.ts index d0c8114f9452..57b9bbf32f54 100644 --- a/clients/client-elasticache/commands/DeleteCacheParameterGroupCommand.ts +++ b/clients/client-elasticache/commands/DeleteCacheParameterGroupCommand.ts @@ -24,6 +24,20 @@ export interface DeleteCacheParameterGroupCommandOutput extends __MetadataBearer *

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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ElastiCacheClient, DeleteCacheParameterGroupCommand } from "@aws-sdk/client-elasticache"; // ES Modules import + * // const { ElastiCacheClient, DeleteCacheParameterGroupCommand } = require("@aws-sdk/client-elasticache"); // CommonJS import + * const client = new ElastiCacheClient(config); + * const command = new DeleteCacheParameterGroupCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteCacheParameterGroupCommandInput} for command's `input` shape. + * @see {@link DeleteCacheParameterGroupCommandOutput} for command's `response` shape. + * @see {@link ElastiCacheClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteCacheParameterGroupCommand extends $Command< DeleteCacheParameterGroupCommandInput, diff --git a/clients/client-elasticache/commands/DeleteCacheSecurityGroupCommand.ts b/clients/client-elasticache/commands/DeleteCacheSecurityGroupCommand.ts index 442dd155bebf..f41b3b775e15 100644 --- a/clients/client-elasticache/commands/DeleteCacheSecurityGroupCommand.ts +++ b/clients/client-elasticache/commands/DeleteCacheSecurityGroupCommand.ts @@ -25,6 +25,20 @@ export interface DeleteCacheSecurityGroupCommandOutput extends __MetadataBearer * *

You cannot delete a cache security group if it is associated with any clusters.

* + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ElastiCacheClient, DeleteCacheSecurityGroupCommand } from "@aws-sdk/client-elasticache"; // ES Modules import + * // const { ElastiCacheClient, DeleteCacheSecurityGroupCommand } = require("@aws-sdk/client-elasticache"); // CommonJS import + * const client = new ElastiCacheClient(config); + * const command = new DeleteCacheSecurityGroupCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteCacheSecurityGroupCommandInput} for command's `input` shape. + * @see {@link DeleteCacheSecurityGroupCommandOutput} for command's `response` shape. + * @see {@link ElastiCacheClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteCacheSecurityGroupCommand extends $Command< DeleteCacheSecurityGroupCommandInput, diff --git a/clients/client-elasticache/commands/DeleteCacheSubnetGroupCommand.ts b/clients/client-elasticache/commands/DeleteCacheSubnetGroupCommand.ts index d32838c0472b..142c0b722beb 100644 --- a/clients/client-elasticache/commands/DeleteCacheSubnetGroupCommand.ts +++ b/clients/client-elasticache/commands/DeleteCacheSubnetGroupCommand.ts @@ -25,6 +25,20 @@ export interface DeleteCacheSubnetGroupCommandOutput extends __MetadataBearer {} * *

You cannot delete a default cache subnet group or one that is associated with any clusters.

* + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ElastiCacheClient, DeleteCacheSubnetGroupCommand } from "@aws-sdk/client-elasticache"; // ES Modules import + * // const { ElastiCacheClient, DeleteCacheSubnetGroupCommand } = require("@aws-sdk/client-elasticache"); // CommonJS import + * const client = new ElastiCacheClient(config); + * const command = new DeleteCacheSubnetGroupCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteCacheSubnetGroupCommandInput} for command's `input` shape. + * @see {@link DeleteCacheSubnetGroupCommandOutput} for command's `response` shape. + * @see {@link ElastiCacheClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteCacheSubnetGroupCommand extends $Command< DeleteCacheSubnetGroupCommandInput, diff --git a/clients/client-elasticache/commands/DeleteGlobalReplicationGroupCommand.ts b/clients/client-elasticache/commands/DeleteGlobalReplicationGroupCommand.ts index 27a1d5ce1546..79faa146ac50 100644 --- a/clients/client-elasticache/commands/DeleteGlobalReplicationGroupCommand.ts +++ b/clients/client-elasticache/commands/DeleteGlobalReplicationGroupCommand.ts @@ -40,6 +40,20 @@ export interface DeleteGlobalReplicationGroupCommandOutput * *

When you receive a successful response from this operation, Amazon ElastiCache immediately begins deleting the selected resources; * you cannot cancel or revert this operation.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ElastiCacheClient, DeleteGlobalReplicationGroupCommand } from "@aws-sdk/client-elasticache"; // ES Modules import + * // const { ElastiCacheClient, DeleteGlobalReplicationGroupCommand } = require("@aws-sdk/client-elasticache"); // CommonJS import + * const client = new ElastiCacheClient(config); + * const command = new DeleteGlobalReplicationGroupCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteGlobalReplicationGroupCommandInput} for command's `input` shape. + * @see {@link DeleteGlobalReplicationGroupCommandOutput} for command's `response` shape. + * @see {@link ElastiCacheClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteGlobalReplicationGroupCommand extends $Command< DeleteGlobalReplicationGroupCommandInput, diff --git a/clients/client-elasticache/commands/DeleteReplicationGroupCommand.ts b/clients/client-elasticache/commands/DeleteReplicationGroupCommand.ts index f5138bae7fb1..10d79cd706ab 100644 --- a/clients/client-elasticache/commands/DeleteReplicationGroupCommand.ts +++ b/clients/client-elasticache/commands/DeleteReplicationGroupCommand.ts @@ -30,6 +30,20 @@ export interface DeleteReplicationGroupCommandOutput extends DeleteReplicationGr * *

This operation is valid for Redis only.

* + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ElastiCacheClient, DeleteReplicationGroupCommand } from "@aws-sdk/client-elasticache"; // ES Modules import + * // const { ElastiCacheClient, DeleteReplicationGroupCommand } = require("@aws-sdk/client-elasticache"); // CommonJS import + * const client = new ElastiCacheClient(config); + * const command = new DeleteReplicationGroupCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteReplicationGroupCommandInput} for command's `input` shape. + * @see {@link DeleteReplicationGroupCommandOutput} for command's `response` shape. + * @see {@link ElastiCacheClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteReplicationGroupCommand extends $Command< DeleteReplicationGroupCommandInput, diff --git a/clients/client-elasticache/commands/DeleteSnapshotCommand.ts b/clients/client-elasticache/commands/DeleteSnapshotCommand.ts index cedc60e26a58..862417433786 100644 --- a/clients/client-elasticache/commands/DeleteSnapshotCommand.ts +++ b/clients/client-elasticache/commands/DeleteSnapshotCommand.ts @@ -28,6 +28,20 @@ export interface DeleteSnapshotCommandOutput extends DeleteSnapshotResult, __Met * *

This operation is valid for Redis only.

* + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ElastiCacheClient, DeleteSnapshotCommand } from "@aws-sdk/client-elasticache"; // ES Modules import + * // const { ElastiCacheClient, DeleteSnapshotCommand } = require("@aws-sdk/client-elasticache"); // CommonJS import + * const client = new ElastiCacheClient(config); + * const command = new DeleteSnapshotCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteSnapshotCommandInput} for command's `input` shape. + * @see {@link DeleteSnapshotCommandOutput} for command's `response` shape. + * @see {@link ElastiCacheClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteSnapshotCommand extends $Command< DeleteSnapshotCommandInput, diff --git a/clients/client-elasticache/commands/DeleteUserCommand.ts b/clients/client-elasticache/commands/DeleteUserCommand.ts index c53311122d52..c53b36624ae2 100644 --- a/clients/client-elasticache/commands/DeleteUserCommand.ts +++ b/clients/client-elasticache/commands/DeleteUserCommand.ts @@ -19,6 +19,20 @@ export interface DeleteUserCommandOutput extends User, __MetadataBearer {} /** *

For Redis engine version 6.x 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).

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ElastiCacheClient, DeleteUserCommand } from "@aws-sdk/client-elasticache"; // ES Modules import + * // const { ElastiCacheClient, DeleteUserCommand } = require("@aws-sdk/client-elasticache"); // CommonJS import + * const client = new ElastiCacheClient(config); + * const command = new DeleteUserCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteUserCommandInput} for command's `input` shape. + * @see {@link DeleteUserCommandOutput} for command's `response` shape. + * @see {@link ElastiCacheClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteUserCommand extends $Command< DeleteUserCommandInput, diff --git a/clients/client-elasticache/commands/DeleteUserGroupCommand.ts b/clients/client-elasticache/commands/DeleteUserGroupCommand.ts index 653d37bd42ff..019ce5ec681c 100644 --- a/clients/client-elasticache/commands/DeleteUserGroupCommand.ts +++ b/clients/client-elasticache/commands/DeleteUserGroupCommand.ts @@ -22,6 +22,20 @@ export interface DeleteUserGroupCommandOutput extends UserGroup, __MetadataBeare /** *

For Redis engine version 6.x 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).

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ElastiCacheClient, DeleteUserGroupCommand } from "@aws-sdk/client-elasticache"; // ES Modules import + * // const { ElastiCacheClient, DeleteUserGroupCommand } = require("@aws-sdk/client-elasticache"); // CommonJS import + * const client = new ElastiCacheClient(config); + * const command = new DeleteUserGroupCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteUserGroupCommandInput} for command's `input` shape. + * @see {@link DeleteUserGroupCommandOutput} for command's `response` shape. + * @see {@link ElastiCacheClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteUserGroupCommand extends $Command< DeleteUserGroupCommandInput, diff --git a/clients/client-elasticache/commands/DescribeCacheClustersCommand.ts b/clients/client-elasticache/commands/DescribeCacheClustersCommand.ts index 8519821a75d6..1ed510f5283f 100644 --- a/clients/client-elasticache/commands/DescribeCacheClustersCommand.ts +++ b/clients/client-elasticache/commands/DescribeCacheClustersCommand.ts @@ -37,6 +37,20 @@ export interface DescribeCacheClustersCommandOutput extends CacheClusterMessage, * ready for use.

*

If cache nodes are currently being removed from the cluster, no endpoint information * for the removed nodes is displayed.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ElastiCacheClient, DescribeCacheClustersCommand } from "@aws-sdk/client-elasticache"; // ES Modules import + * // const { ElastiCacheClient, DescribeCacheClustersCommand } = require("@aws-sdk/client-elasticache"); // CommonJS import + * const client = new ElastiCacheClient(config); + * const command = new DescribeCacheClustersCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeCacheClustersCommandInput} for command's `input` shape. + * @see {@link DescribeCacheClustersCommandOutput} for command's `response` shape. + * @see {@link ElastiCacheClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeCacheClustersCommand extends $Command< DescribeCacheClustersCommandInput, diff --git a/clients/client-elasticache/commands/DescribeCacheEngineVersionsCommand.ts b/clients/client-elasticache/commands/DescribeCacheEngineVersionsCommand.ts index b6ff1716e6e4..447ce004f643 100644 --- a/clients/client-elasticache/commands/DescribeCacheEngineVersionsCommand.ts +++ b/clients/client-elasticache/commands/DescribeCacheEngineVersionsCommand.ts @@ -23,6 +23,20 @@ export interface DescribeCacheEngineVersionsCommandOutput extends CacheEngineVer /** *

Returns a list of the available cache * engines and their versions.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ElastiCacheClient, DescribeCacheEngineVersionsCommand } from "@aws-sdk/client-elasticache"; // ES Modules import + * // const { ElastiCacheClient, DescribeCacheEngineVersionsCommand } = require("@aws-sdk/client-elasticache"); // CommonJS import + * const client = new ElastiCacheClient(config); + * const command = new DescribeCacheEngineVersionsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeCacheEngineVersionsCommandInput} for command's `input` shape. + * @see {@link DescribeCacheEngineVersionsCommandOutput} for command's `response` shape. + * @see {@link ElastiCacheClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeCacheEngineVersionsCommand extends $Command< DescribeCacheEngineVersionsCommandInput, diff --git a/clients/client-elasticache/commands/DescribeCacheParameterGroupsCommand.ts b/clients/client-elasticache/commands/DescribeCacheParameterGroupsCommand.ts index d78cdaf73776..7b694e52258c 100644 --- a/clients/client-elasticache/commands/DescribeCacheParameterGroupsCommand.ts +++ b/clients/client-elasticache/commands/DescribeCacheParameterGroupsCommand.ts @@ -24,6 +24,20 @@ export interface DescribeCacheParameterGroupsCommandOutput extends CacheParamete *

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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ElastiCacheClient, DescribeCacheParameterGroupsCommand } from "@aws-sdk/client-elasticache"; // ES Modules import + * // const { ElastiCacheClient, DescribeCacheParameterGroupsCommand } = require("@aws-sdk/client-elasticache"); // CommonJS import + * const client = new ElastiCacheClient(config); + * const command = new DescribeCacheParameterGroupsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeCacheParameterGroupsCommandInput} for command's `input` shape. + * @see {@link DescribeCacheParameterGroupsCommandOutput} for command's `response` shape. + * @see {@link ElastiCacheClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeCacheParameterGroupsCommand extends $Command< DescribeCacheParameterGroupsCommandInput, diff --git a/clients/client-elasticache/commands/DescribeCacheParametersCommand.ts b/clients/client-elasticache/commands/DescribeCacheParametersCommand.ts index 3255f68c4c5c..4bf7c44dd760 100644 --- a/clients/client-elasticache/commands/DescribeCacheParametersCommand.ts +++ b/clients/client-elasticache/commands/DescribeCacheParametersCommand.ts @@ -23,6 +23,20 @@ export interface DescribeCacheParametersCommandOutput extends CacheParameterGrou /** *

Returns the detailed parameter list for a * particular cache parameter group.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ElastiCacheClient, DescribeCacheParametersCommand } from "@aws-sdk/client-elasticache"; // ES Modules import + * // const { ElastiCacheClient, DescribeCacheParametersCommand } = require("@aws-sdk/client-elasticache"); // CommonJS import + * const client = new ElastiCacheClient(config); + * const command = new DescribeCacheParametersCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeCacheParametersCommandInput} for command's `input` shape. + * @see {@link DescribeCacheParametersCommandOutput} for command's `response` shape. + * @see {@link ElastiCacheClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeCacheParametersCommand extends $Command< DescribeCacheParametersCommandInput, diff --git a/clients/client-elasticache/commands/DescribeCacheSecurityGroupsCommand.ts b/clients/client-elasticache/commands/DescribeCacheSecurityGroupsCommand.ts index 0d6b74830091..61c6f0444f30 100644 --- a/clients/client-elasticache/commands/DescribeCacheSecurityGroupsCommand.ts +++ b/clients/client-elasticache/commands/DescribeCacheSecurityGroupsCommand.ts @@ -25,6 +25,20 @@ export interface DescribeCacheSecurityGroupsCommandOutput extends CacheSecurityG * 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 *

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ElastiCacheClient, DescribeCacheSecurityGroupsCommand } from "@aws-sdk/client-elasticache"; // ES Modules import + * // const { ElastiCacheClient, DescribeCacheSecurityGroupsCommand } = require("@aws-sdk/client-elasticache"); // CommonJS import + * const client = new ElastiCacheClient(config); + * const command = new DescribeCacheSecurityGroupsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeCacheSecurityGroupsCommandInput} for command's `input` shape. + * @see {@link DescribeCacheSecurityGroupsCommandOutput} for command's `response` shape. + * @see {@link ElastiCacheClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeCacheSecurityGroupsCommand extends $Command< DescribeCacheSecurityGroupsCommandInput, diff --git a/clients/client-elasticache/commands/DescribeCacheSubnetGroupsCommand.ts b/clients/client-elasticache/commands/DescribeCacheSubnetGroupsCommand.ts index dde684591139..f47e48d3f9d7 100644 --- a/clients/client-elasticache/commands/DescribeCacheSubnetGroupsCommand.ts +++ b/clients/client-elasticache/commands/DescribeCacheSubnetGroupsCommand.ts @@ -25,6 +25,20 @@ export interface DescribeCacheSubnetGroupsCommandOutput extends CacheSubnetGroup * 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. *

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ElastiCacheClient, DescribeCacheSubnetGroupsCommand } from "@aws-sdk/client-elasticache"; // ES Modules import + * // const { ElastiCacheClient, DescribeCacheSubnetGroupsCommand } = require("@aws-sdk/client-elasticache"); // CommonJS import + * const client = new ElastiCacheClient(config); + * const command = new DescribeCacheSubnetGroupsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeCacheSubnetGroupsCommandInput} for command's `input` shape. + * @see {@link DescribeCacheSubnetGroupsCommandOutput} for command's `response` shape. + * @see {@link ElastiCacheClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeCacheSubnetGroupsCommand extends $Command< DescribeCacheSubnetGroupsCommandInput, diff --git a/clients/client-elasticache/commands/DescribeEngineDefaultParametersCommand.ts b/clients/client-elasticache/commands/DescribeEngineDefaultParametersCommand.ts index 69647ddf7806..5b604033454c 100644 --- a/clients/client-elasticache/commands/DescribeEngineDefaultParametersCommand.ts +++ b/clients/client-elasticache/commands/DescribeEngineDefaultParametersCommand.ts @@ -25,6 +25,20 @@ export interface DescribeEngineDefaultParametersCommandOutput /** *

Returns the default engine and * system parameter information for the specified cache engine.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ElastiCacheClient, DescribeEngineDefaultParametersCommand } from "@aws-sdk/client-elasticache"; // ES Modules import + * // const { ElastiCacheClient, DescribeEngineDefaultParametersCommand } = require("@aws-sdk/client-elasticache"); // CommonJS import + * const client = new ElastiCacheClient(config); + * const command = new DescribeEngineDefaultParametersCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeEngineDefaultParametersCommandInput} for command's `input` shape. + * @see {@link DescribeEngineDefaultParametersCommandOutput} for command's `response` shape. + * @see {@link ElastiCacheClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeEngineDefaultParametersCommand extends $Command< DescribeEngineDefaultParametersCommandInput, diff --git a/clients/client-elasticache/commands/DescribeEventsCommand.ts b/clients/client-elasticache/commands/DescribeEventsCommand.ts index 90a85c8d46d8..d6a66b83802e 100644 --- a/clients/client-elasticache/commands/DescribeEventsCommand.ts +++ b/clients/client-elasticache/commands/DescribeEventsCommand.ts @@ -27,6 +27,20 @@ export interface DescribeEventsCommandOutput extends EventsMessage, __MetadataBe * 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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ElastiCacheClient, DescribeEventsCommand } from "@aws-sdk/client-elasticache"; // ES Modules import + * // const { ElastiCacheClient, DescribeEventsCommand } = require("@aws-sdk/client-elasticache"); // CommonJS import + * const client = new ElastiCacheClient(config); + * const command = new DescribeEventsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeEventsCommandInput} for command's `input` shape. + * @see {@link DescribeEventsCommandOutput} for command's `response` shape. + * @see {@link ElastiCacheClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeEventsCommand extends $Command< DescribeEventsCommandInput, diff --git a/clients/client-elasticache/commands/DescribeGlobalReplicationGroupsCommand.ts b/clients/client-elasticache/commands/DescribeGlobalReplicationGroupsCommand.ts index 03d5d552cea6..48ce7ccb7e61 100644 --- a/clients/client-elasticache/commands/DescribeGlobalReplicationGroupsCommand.ts +++ b/clients/client-elasticache/commands/DescribeGlobalReplicationGroupsCommand.ts @@ -24,6 +24,20 @@ export interface DescribeGlobalReplicationGroupsCommandOutput /** *

Returns information about a particular global replication group. If no identifier is specified, returns information about all Global datastores.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ElastiCacheClient, DescribeGlobalReplicationGroupsCommand } from "@aws-sdk/client-elasticache"; // ES Modules import + * // const { ElastiCacheClient, DescribeGlobalReplicationGroupsCommand } = require("@aws-sdk/client-elasticache"); // CommonJS import + * const client = new ElastiCacheClient(config); + * const command = new DescribeGlobalReplicationGroupsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeGlobalReplicationGroupsCommandInput} for command's `input` shape. + * @see {@link DescribeGlobalReplicationGroupsCommandOutput} for command's `response` shape. + * @see {@link ElastiCacheClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeGlobalReplicationGroupsCommand extends $Command< DescribeGlobalReplicationGroupsCommandInput, diff --git a/clients/client-elasticache/commands/DescribeReplicationGroupsCommand.ts b/clients/client-elasticache/commands/DescribeReplicationGroupsCommand.ts index 2bbf1b302a61..1d85dd58107e 100644 --- a/clients/client-elasticache/commands/DescribeReplicationGroupsCommand.ts +++ b/clients/client-elasticache/commands/DescribeReplicationGroupsCommand.ts @@ -27,6 +27,20 @@ export interface DescribeReplicationGroupsCommandOutput extends ReplicationGroup * *

This operation is valid for Redis only.

* + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ElastiCacheClient, DescribeReplicationGroupsCommand } from "@aws-sdk/client-elasticache"; // ES Modules import + * // const { ElastiCacheClient, DescribeReplicationGroupsCommand } = require("@aws-sdk/client-elasticache"); // CommonJS import + * const client = new ElastiCacheClient(config); + * const command = new DescribeReplicationGroupsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeReplicationGroupsCommandInput} for command's `input` shape. + * @see {@link DescribeReplicationGroupsCommandOutput} for command's `response` shape. + * @see {@link ElastiCacheClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeReplicationGroupsCommand extends $Command< DescribeReplicationGroupsCommandInput, diff --git a/clients/client-elasticache/commands/DescribeReservedCacheNodesCommand.ts b/clients/client-elasticache/commands/DescribeReservedCacheNodesCommand.ts index 8208da190a41..a831f52a2fc2 100644 --- a/clients/client-elasticache/commands/DescribeReservedCacheNodesCommand.ts +++ b/clients/client-elasticache/commands/DescribeReservedCacheNodesCommand.ts @@ -23,6 +23,20 @@ export interface DescribeReservedCacheNodesCommandOutput extends ReservedCacheNo /** *

Returns information about reserved cache * nodes for this account, or about a specified reserved cache node.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ElastiCacheClient, DescribeReservedCacheNodesCommand } from "@aws-sdk/client-elasticache"; // ES Modules import + * // const { ElastiCacheClient, DescribeReservedCacheNodesCommand } = require("@aws-sdk/client-elasticache"); // CommonJS import + * const client = new ElastiCacheClient(config); + * const command = new DescribeReservedCacheNodesCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeReservedCacheNodesCommandInput} for command's `input` shape. + * @see {@link DescribeReservedCacheNodesCommandOutput} for command's `response` shape. + * @see {@link ElastiCacheClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeReservedCacheNodesCommand extends $Command< DescribeReservedCacheNodesCommandInput, diff --git a/clients/client-elasticache/commands/DescribeReservedCacheNodesOfferingsCommand.ts b/clients/client-elasticache/commands/DescribeReservedCacheNodesOfferingsCommand.ts index 905cc78ca5fc..d90b1513473c 100644 --- a/clients/client-elasticache/commands/DescribeReservedCacheNodesOfferingsCommand.ts +++ b/clients/client-elasticache/commands/DescribeReservedCacheNodesOfferingsCommand.ts @@ -25,6 +25,20 @@ export interface DescribeReservedCacheNodesOfferingsCommandOutput /** *

Lists available reserved cache * node offerings.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ElastiCacheClient, DescribeReservedCacheNodesOfferingsCommand } from "@aws-sdk/client-elasticache"; // ES Modules import + * // const { ElastiCacheClient, DescribeReservedCacheNodesOfferingsCommand } = require("@aws-sdk/client-elasticache"); // CommonJS import + * const client = new ElastiCacheClient(config); + * const command = new DescribeReservedCacheNodesOfferingsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeReservedCacheNodesOfferingsCommandInput} for command's `input` shape. + * @see {@link DescribeReservedCacheNodesOfferingsCommandOutput} for command's `response` shape. + * @see {@link ElastiCacheClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeReservedCacheNodesOfferingsCommand extends $Command< DescribeReservedCacheNodesOfferingsCommandInput, diff --git a/clients/client-elasticache/commands/DescribeServiceUpdatesCommand.ts b/clients/client-elasticache/commands/DescribeServiceUpdatesCommand.ts index a509313c7487..bbe1c8c48992 100644 --- a/clients/client-elasticache/commands/DescribeServiceUpdatesCommand.ts +++ b/clients/client-elasticache/commands/DescribeServiceUpdatesCommand.ts @@ -22,6 +22,20 @@ export interface DescribeServiceUpdatesCommandOutput extends ServiceUpdatesMessa /** *

Returns details of the service updates

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ElastiCacheClient, DescribeServiceUpdatesCommand } from "@aws-sdk/client-elasticache"; // ES Modules import + * // const { ElastiCacheClient, DescribeServiceUpdatesCommand } = require("@aws-sdk/client-elasticache"); // CommonJS import + * const client = new ElastiCacheClient(config); + * const command = new DescribeServiceUpdatesCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeServiceUpdatesCommandInput} for command's `input` shape. + * @see {@link DescribeServiceUpdatesCommandOutput} for command's `response` shape. + * @see {@link ElastiCacheClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeServiceUpdatesCommand extends $Command< DescribeServiceUpdatesCommandInput, diff --git a/clients/client-elasticache/commands/DescribeSnapshotsCommand.ts b/clients/client-elasticache/commands/DescribeSnapshotsCommand.ts index 20124c693f23..07a950a9ced9 100644 --- a/clients/client-elasticache/commands/DescribeSnapshotsCommand.ts +++ b/clients/client-elasticache/commands/DescribeSnapshotsCommand.ts @@ -29,6 +29,20 @@ export interface DescribeSnapshotsCommandOutput extends DescribeSnapshotsListMes * *

This operation is valid for Redis only.

* + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ElastiCacheClient, DescribeSnapshotsCommand } from "@aws-sdk/client-elasticache"; // ES Modules import + * // const { ElastiCacheClient, DescribeSnapshotsCommand } = require("@aws-sdk/client-elasticache"); // CommonJS import + * const client = new ElastiCacheClient(config); + * const command = new DescribeSnapshotsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeSnapshotsCommandInput} for command's `input` shape. + * @see {@link DescribeSnapshotsCommandOutput} for command's `response` shape. + * @see {@link ElastiCacheClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeSnapshotsCommand extends $Command< DescribeSnapshotsCommandInput, diff --git a/clients/client-elasticache/commands/DescribeUpdateActionsCommand.ts b/clients/client-elasticache/commands/DescribeUpdateActionsCommand.ts index 0a5892908ae9..244664d26f64 100644 --- a/clients/client-elasticache/commands/DescribeUpdateActionsCommand.ts +++ b/clients/client-elasticache/commands/DescribeUpdateActionsCommand.ts @@ -22,6 +22,20 @@ export interface DescribeUpdateActionsCommandOutput extends UpdateActionsMessage /** *

Returns details of the update actions

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ElastiCacheClient, DescribeUpdateActionsCommand } from "@aws-sdk/client-elasticache"; // ES Modules import + * // const { ElastiCacheClient, DescribeUpdateActionsCommand } = require("@aws-sdk/client-elasticache"); // CommonJS import + * const client = new ElastiCacheClient(config); + * const command = new DescribeUpdateActionsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeUpdateActionsCommandInput} for command's `input` shape. + * @see {@link DescribeUpdateActionsCommandOutput} for command's `response` shape. + * @see {@link ElastiCacheClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeUpdateActionsCommand extends $Command< DescribeUpdateActionsCommandInput, diff --git a/clients/client-elasticache/commands/DescribeUserGroupsCommand.ts b/clients/client-elasticache/commands/DescribeUserGroupsCommand.ts index 56b515dd0cc7..a3475bf6d21d 100644 --- a/clients/client-elasticache/commands/DescribeUserGroupsCommand.ts +++ b/clients/client-elasticache/commands/DescribeUserGroupsCommand.ts @@ -22,6 +22,20 @@ export interface DescribeUserGroupsCommandOutput extends DescribeUserGroupsResul /** *

Returns a list of user groups.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ElastiCacheClient, DescribeUserGroupsCommand } from "@aws-sdk/client-elasticache"; // ES Modules import + * // const { ElastiCacheClient, DescribeUserGroupsCommand } = require("@aws-sdk/client-elasticache"); // CommonJS import + * const client = new ElastiCacheClient(config); + * const command = new DescribeUserGroupsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeUserGroupsCommandInput} for command's `input` shape. + * @see {@link DescribeUserGroupsCommandOutput} for command's `response` shape. + * @see {@link ElastiCacheClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeUserGroupsCommand extends $Command< DescribeUserGroupsCommandInput, diff --git a/clients/client-elasticache/commands/DescribeUsersCommand.ts b/clients/client-elasticache/commands/DescribeUsersCommand.ts index fc1080ea8e4a..4c344535d4f0 100644 --- a/clients/client-elasticache/commands/DescribeUsersCommand.ts +++ b/clients/client-elasticache/commands/DescribeUsersCommand.ts @@ -22,6 +22,20 @@ export interface DescribeUsersCommandOutput extends DescribeUsersResult, __Metad /** *

Returns a list of users.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ElastiCacheClient, DescribeUsersCommand } from "@aws-sdk/client-elasticache"; // ES Modules import + * // const { ElastiCacheClient, DescribeUsersCommand } = require("@aws-sdk/client-elasticache"); // CommonJS import + * const client = new ElastiCacheClient(config); + * const command = new DescribeUsersCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeUsersCommandInput} for command's `input` shape. + * @see {@link DescribeUsersCommandOutput} for command's `response` shape. + * @see {@link ElastiCacheClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeUsersCommand extends $Command< DescribeUsersCommandInput, diff --git a/clients/client-elasticache/commands/DisassociateGlobalReplicationGroupCommand.ts b/clients/client-elasticache/commands/DisassociateGlobalReplicationGroupCommand.ts index f00968f11218..b88a1740ec93 100644 --- a/clients/client-elasticache/commands/DisassociateGlobalReplicationGroupCommand.ts +++ b/clients/client-elasticache/commands/DisassociateGlobalReplicationGroupCommand.ts @@ -27,6 +27,20 @@ export interface DisassociateGlobalReplicationGroupCommandOutput /** *

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 AWS region.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ElastiCacheClient, DisassociateGlobalReplicationGroupCommand } from "@aws-sdk/client-elasticache"; // ES Modules import + * // const { ElastiCacheClient, DisassociateGlobalReplicationGroupCommand } = require("@aws-sdk/client-elasticache"); // CommonJS import + * const client = new ElastiCacheClient(config); + * const command = new DisassociateGlobalReplicationGroupCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DisassociateGlobalReplicationGroupCommandInput} for command's `input` shape. + * @see {@link DisassociateGlobalReplicationGroupCommandOutput} for command's `response` shape. + * @see {@link ElastiCacheClientResolvedConfig | config} for command's `input` shape. + * */ export class DisassociateGlobalReplicationGroupCommand extends $Command< DisassociateGlobalReplicationGroupCommandInput, diff --git a/clients/client-elasticache/commands/FailoverGlobalReplicationGroupCommand.ts b/clients/client-elasticache/commands/FailoverGlobalReplicationGroupCommand.ts index a44b366bed86..cf7c826676a5 100644 --- a/clients/client-elasticache/commands/FailoverGlobalReplicationGroupCommand.ts +++ b/clients/client-elasticache/commands/FailoverGlobalReplicationGroupCommand.ts @@ -24,6 +24,20 @@ export interface FailoverGlobalReplicationGroupCommandOutput /** *

Used to failover the primary region to a selected secondary region. The selected secondary region will become primary, and all other clusters will become secondary.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ElastiCacheClient, FailoverGlobalReplicationGroupCommand } from "@aws-sdk/client-elasticache"; // ES Modules import + * // const { ElastiCacheClient, FailoverGlobalReplicationGroupCommand } = require("@aws-sdk/client-elasticache"); // CommonJS import + * const client = new ElastiCacheClient(config); + * const command = new FailoverGlobalReplicationGroupCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link FailoverGlobalReplicationGroupCommandInput} for command's `input` shape. + * @see {@link FailoverGlobalReplicationGroupCommandOutput} for command's `response` shape. + * @see {@link ElastiCacheClientResolvedConfig | config} for command's `input` shape. + * */ export class FailoverGlobalReplicationGroupCommand extends $Command< FailoverGlobalReplicationGroupCommandInput, diff --git a/clients/client-elasticache/commands/IncreaseNodeGroupsInGlobalReplicationGroupCommand.ts b/clients/client-elasticache/commands/IncreaseNodeGroupsInGlobalReplicationGroupCommand.ts index 567810b92c49..d46271cf05e5 100644 --- a/clients/client-elasticache/commands/IncreaseNodeGroupsInGlobalReplicationGroupCommand.ts +++ b/clients/client-elasticache/commands/IncreaseNodeGroupsInGlobalReplicationGroupCommand.ts @@ -28,6 +28,20 @@ export interface IncreaseNodeGroupsInGlobalReplicationGroupCommandOutput /** *

Increase the number of node groups in the Global datastore

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ElastiCacheClient, IncreaseNodeGroupsInGlobalReplicationGroupCommand } from "@aws-sdk/client-elasticache"; // ES Modules import + * // const { ElastiCacheClient, IncreaseNodeGroupsInGlobalReplicationGroupCommand } = require("@aws-sdk/client-elasticache"); // CommonJS import + * const client = new ElastiCacheClient(config); + * const command = new IncreaseNodeGroupsInGlobalReplicationGroupCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link IncreaseNodeGroupsInGlobalReplicationGroupCommandInput} for command's `input` shape. + * @see {@link IncreaseNodeGroupsInGlobalReplicationGroupCommandOutput} for command's `response` shape. + * @see {@link ElastiCacheClientResolvedConfig | config} for command's `input` shape. + * */ export class IncreaseNodeGroupsInGlobalReplicationGroupCommand extends $Command< IncreaseNodeGroupsInGlobalReplicationGroupCommandInput, diff --git a/clients/client-elasticache/commands/IncreaseReplicaCountCommand.ts b/clients/client-elasticache/commands/IncreaseReplicaCountCommand.ts index 399ccb47339b..503b166d0139 100644 --- a/clients/client-elasticache/commands/IncreaseReplicaCountCommand.ts +++ b/clients/client-elasticache/commands/IncreaseReplicaCountCommand.ts @@ -24,6 +24,20 @@ export interface IncreaseReplicaCountCommandOutput extends IncreaseReplicaCountR *

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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ElastiCacheClient, IncreaseReplicaCountCommand } from "@aws-sdk/client-elasticache"; // ES Modules import + * // const { ElastiCacheClient, IncreaseReplicaCountCommand } = require("@aws-sdk/client-elasticache"); // CommonJS import + * const client = new ElastiCacheClient(config); + * const command = new IncreaseReplicaCountCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link IncreaseReplicaCountCommandInput} for command's `input` shape. + * @see {@link IncreaseReplicaCountCommandOutput} for command's `response` shape. + * @see {@link ElastiCacheClientResolvedConfig | config} for command's `input` shape. + * */ export class IncreaseReplicaCountCommand extends $Command< IncreaseReplicaCountCommandInput, diff --git a/clients/client-elasticache/commands/ListAllowedNodeTypeModificationsCommand.ts b/clients/client-elasticache/commands/ListAllowedNodeTypeModificationsCommand.ts index 76da31dfa540..947a147a252a 100644 --- a/clients/client-elasticache/commands/ListAllowedNodeTypeModificationsCommand.ts +++ b/clients/client-elasticache/commands/ListAllowedNodeTypeModificationsCommand.ts @@ -29,6 +29,20 @@ export interface ListAllowedNodeTypeModificationsCommandOutput *

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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ElastiCacheClient, ListAllowedNodeTypeModificationsCommand } from "@aws-sdk/client-elasticache"; // ES Modules import + * // const { ElastiCacheClient, ListAllowedNodeTypeModificationsCommand } = require("@aws-sdk/client-elasticache"); // CommonJS import + * const client = new ElastiCacheClient(config); + * const command = new ListAllowedNodeTypeModificationsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListAllowedNodeTypeModificationsCommandInput} for command's `input` shape. + * @see {@link ListAllowedNodeTypeModificationsCommandOutput} for command's `response` shape. + * @see {@link ElastiCacheClientResolvedConfig | config} for command's `input` shape. + * */ export class ListAllowedNodeTypeModificationsCommand extends $Command< ListAllowedNodeTypeModificationsCommandInput, diff --git a/clients/client-elasticache/commands/ListTagsForResourceCommand.ts b/clients/client-elasticache/commands/ListTagsForResourceCommand.ts index b398128ab039..d1f3cea1b8c8 100644 --- a/clients/client-elasticache/commands/ListTagsForResourceCommand.ts +++ b/clients/client-elasticache/commands/ListTagsForResourceCommand.ts @@ -28,6 +28,20 @@ export interface ListTagsForResourceCommandOutput extends TagListMessage, __Meta * *

If the cluster is not in the available state, ListTagsForResource * returns an error.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ElastiCacheClient, ListTagsForResourceCommand } from "@aws-sdk/client-elasticache"; // ES Modules import + * // const { ElastiCacheClient, ListTagsForResourceCommand } = require("@aws-sdk/client-elasticache"); // CommonJS import + * const client = new ElastiCacheClient(config); + * const command = new ListTagsForResourceCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListTagsForResourceCommandInput} for command's `input` shape. + * @see {@link ListTagsForResourceCommandOutput} for command's `response` shape. + * @see {@link ElastiCacheClientResolvedConfig | config} for command's `input` shape. + * */ export class ListTagsForResourceCommand extends $Command< ListTagsForResourceCommandInput, diff --git a/clients/client-elasticache/commands/ModifyCacheClusterCommand.ts b/clients/client-elasticache/commands/ModifyCacheClusterCommand.ts index 36dbf516633f..aeae7df701d0 100644 --- a/clients/client-elasticache/commands/ModifyCacheClusterCommand.ts +++ b/clients/client-elasticache/commands/ModifyCacheClusterCommand.ts @@ -24,6 +24,20 @@ export interface ModifyCacheClusterCommandOutput extends ModifyCacheClusterResul *

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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ElastiCacheClient, ModifyCacheClusterCommand } from "@aws-sdk/client-elasticache"; // ES Modules import + * // const { ElastiCacheClient, ModifyCacheClusterCommand } = require("@aws-sdk/client-elasticache"); // CommonJS import + * const client = new ElastiCacheClient(config); + * const command = new ModifyCacheClusterCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ModifyCacheClusterCommandInput} for command's `input` shape. + * @see {@link ModifyCacheClusterCommandOutput} for command's `response` shape. + * @see {@link ElastiCacheClientResolvedConfig | config} for command's `input` shape. + * */ export class ModifyCacheClusterCommand extends $Command< ModifyCacheClusterCommandInput, diff --git a/clients/client-elasticache/commands/ModifyCacheParameterGroupCommand.ts b/clients/client-elasticache/commands/ModifyCacheParameterGroupCommand.ts index ecd29fbff432..4daec7b5b40b 100644 --- a/clients/client-elasticache/commands/ModifyCacheParameterGroupCommand.ts +++ b/clients/client-elasticache/commands/ModifyCacheParameterGroupCommand.ts @@ -24,6 +24,20 @@ export interface ModifyCacheParameterGroupCommandOutput extends CacheParameterGr *

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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ElastiCacheClient, ModifyCacheParameterGroupCommand } from "@aws-sdk/client-elasticache"; // ES Modules import + * // const { ElastiCacheClient, ModifyCacheParameterGroupCommand } = require("@aws-sdk/client-elasticache"); // CommonJS import + * const client = new ElastiCacheClient(config); + * const command = new ModifyCacheParameterGroupCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ModifyCacheParameterGroupCommandInput} for command's `input` shape. + * @see {@link ModifyCacheParameterGroupCommandOutput} for command's `response` shape. + * @see {@link ElastiCacheClientResolvedConfig | config} for command's `input` shape. + * */ export class ModifyCacheParameterGroupCommand extends $Command< ModifyCacheParameterGroupCommandInput, diff --git a/clients/client-elasticache/commands/ModifyCacheSubnetGroupCommand.ts b/clients/client-elasticache/commands/ModifyCacheSubnetGroupCommand.ts index 9878329cfed3..699b07abf87d 100644 --- a/clients/client-elasticache/commands/ModifyCacheSubnetGroupCommand.ts +++ b/clients/client-elasticache/commands/ModifyCacheSubnetGroupCommand.ts @@ -22,6 +22,20 @@ export interface ModifyCacheSubnetGroupCommandOutput extends ModifyCacheSubnetGr /** *

Modifies an existing cache subnet group.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ElastiCacheClient, ModifyCacheSubnetGroupCommand } from "@aws-sdk/client-elasticache"; // ES Modules import + * // const { ElastiCacheClient, ModifyCacheSubnetGroupCommand } = require("@aws-sdk/client-elasticache"); // CommonJS import + * const client = new ElastiCacheClient(config); + * const command = new ModifyCacheSubnetGroupCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ModifyCacheSubnetGroupCommandInput} for command's `input` shape. + * @see {@link ModifyCacheSubnetGroupCommandOutput} for command's `response` shape. + * @see {@link ElastiCacheClientResolvedConfig | config} for command's `input` shape. + * */ export class ModifyCacheSubnetGroupCommand extends $Command< ModifyCacheSubnetGroupCommandInput, diff --git a/clients/client-elasticache/commands/ModifyGlobalReplicationGroupCommand.ts b/clients/client-elasticache/commands/ModifyGlobalReplicationGroupCommand.ts index 62bd1264cf68..a4b8d927500b 100644 --- a/clients/client-elasticache/commands/ModifyGlobalReplicationGroupCommand.ts +++ b/clients/client-elasticache/commands/ModifyGlobalReplicationGroupCommand.ts @@ -24,6 +24,20 @@ export interface ModifyGlobalReplicationGroupCommandOutput /** *

Modifies the settings for a Global datastore.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ElastiCacheClient, ModifyGlobalReplicationGroupCommand } from "@aws-sdk/client-elasticache"; // ES Modules import + * // const { ElastiCacheClient, ModifyGlobalReplicationGroupCommand } = require("@aws-sdk/client-elasticache"); // CommonJS import + * const client = new ElastiCacheClient(config); + * const command = new ModifyGlobalReplicationGroupCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ModifyGlobalReplicationGroupCommandInput} for command's `input` shape. + * @see {@link ModifyGlobalReplicationGroupCommandOutput} for command's `response` shape. + * @see {@link ElastiCacheClientResolvedConfig | config} for command's `input` shape. + * */ export class ModifyGlobalReplicationGroupCommand extends $Command< ModifyGlobalReplicationGroupCommandInput, diff --git a/clients/client-elasticache/commands/ModifyReplicationGroupCommand.ts b/clients/client-elasticache/commands/ModifyReplicationGroupCommand.ts index 38f73092f6c0..892d4327094c 100644 --- a/clients/client-elasticache/commands/ModifyReplicationGroupCommand.ts +++ b/clients/client-elasticache/commands/ModifyReplicationGroupCommand.ts @@ -38,6 +38,20 @@ export interface ModifyReplicationGroupCommandOutput extends ModifyReplicationGr * *

This operation is valid for Redis only.

* + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ElastiCacheClient, ModifyReplicationGroupCommand } from "@aws-sdk/client-elasticache"; // ES Modules import + * // const { ElastiCacheClient, ModifyReplicationGroupCommand } = require("@aws-sdk/client-elasticache"); // CommonJS import + * const client = new ElastiCacheClient(config); + * const command = new ModifyReplicationGroupCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ModifyReplicationGroupCommandInput} for command's `input` shape. + * @see {@link ModifyReplicationGroupCommandOutput} for command's `response` shape. + * @see {@link ElastiCacheClientResolvedConfig | config} for command's `input` shape. + * */ export class ModifyReplicationGroupCommand extends $Command< ModifyReplicationGroupCommandInput, diff --git a/clients/client-elasticache/commands/ModifyReplicationGroupShardConfigurationCommand.ts b/clients/client-elasticache/commands/ModifyReplicationGroupShardConfigurationCommand.ts index c7fe34f78b2a..d30c3ede6a7c 100644 --- a/clients/client-elasticache/commands/ModifyReplicationGroupShardConfigurationCommand.ts +++ b/clients/client-elasticache/commands/ModifyReplicationGroupShardConfigurationCommand.ts @@ -29,6 +29,20 @@ export interface ModifyReplicationGroupShardConfigurationCommandOutput /** *

Modifies a replication group's shards (node groups) by allowing you to * add shards, remove shards, or rebalance the keyspaces among existing shards.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ElastiCacheClient, ModifyReplicationGroupShardConfigurationCommand } from "@aws-sdk/client-elasticache"; // ES Modules import + * // const { ElastiCacheClient, ModifyReplicationGroupShardConfigurationCommand } = require("@aws-sdk/client-elasticache"); // CommonJS import + * const client = new ElastiCacheClient(config); + * const command = new ModifyReplicationGroupShardConfigurationCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ModifyReplicationGroupShardConfigurationCommandInput} for command's `input` shape. + * @see {@link ModifyReplicationGroupShardConfigurationCommandOutput} for command's `response` shape. + * @see {@link ElastiCacheClientResolvedConfig | config} for command's `input` shape. + * */ export class ModifyReplicationGroupShardConfigurationCommand extends $Command< ModifyReplicationGroupShardConfigurationCommandInput, diff --git a/clients/client-elasticache/commands/ModifyUserCommand.ts b/clients/client-elasticache/commands/ModifyUserCommand.ts index eb16f2f6bd6c..16a00f431533 100644 --- a/clients/client-elasticache/commands/ModifyUserCommand.ts +++ b/clients/client-elasticache/commands/ModifyUserCommand.ts @@ -19,6 +19,20 @@ export interface ModifyUserCommandOutput extends User, __MetadataBearer {} /** *

Changes user password(s) and/or access string.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ElastiCacheClient, ModifyUserCommand } from "@aws-sdk/client-elasticache"; // ES Modules import + * // const { ElastiCacheClient, ModifyUserCommand } = require("@aws-sdk/client-elasticache"); // CommonJS import + * const client = new ElastiCacheClient(config); + * const command = new ModifyUserCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ModifyUserCommandInput} for command's `input` shape. + * @see {@link ModifyUserCommandOutput} for command's `response` shape. + * @see {@link ElastiCacheClientResolvedConfig | config} for command's `input` shape. + * */ export class ModifyUserCommand extends $Command< ModifyUserCommandInput, diff --git a/clients/client-elasticache/commands/ModifyUserGroupCommand.ts b/clients/client-elasticache/commands/ModifyUserGroupCommand.ts index e769884b31e2..18c7dcab35ae 100644 --- a/clients/client-elasticache/commands/ModifyUserGroupCommand.ts +++ b/clients/client-elasticache/commands/ModifyUserGroupCommand.ts @@ -22,6 +22,20 @@ export interface ModifyUserGroupCommandOutput extends UserGroup, __MetadataBeare /** *

Changes the list of users that belong to the user group.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ElastiCacheClient, ModifyUserGroupCommand } from "@aws-sdk/client-elasticache"; // ES Modules import + * // const { ElastiCacheClient, ModifyUserGroupCommand } = require("@aws-sdk/client-elasticache"); // CommonJS import + * const client = new ElastiCacheClient(config); + * const command = new ModifyUserGroupCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ModifyUserGroupCommandInput} for command's `input` shape. + * @see {@link ModifyUserGroupCommandOutput} for command's `response` shape. + * @see {@link ElastiCacheClientResolvedConfig | config} for command's `input` shape. + * */ export class ModifyUserGroupCommand extends $Command< ModifyUserGroupCommandInput, diff --git a/clients/client-elasticache/commands/PurchaseReservedCacheNodesOfferingCommand.ts b/clients/client-elasticache/commands/PurchaseReservedCacheNodesOfferingCommand.ts index 9f56d1f2a32b..1a72e7989f1c 100644 --- a/clients/client-elasticache/commands/PurchaseReservedCacheNodesOfferingCommand.ts +++ b/clients/client-elasticache/commands/PurchaseReservedCacheNodesOfferingCommand.ts @@ -30,6 +30,20 @@ export interface PurchaseReservedCacheNodesOfferingCommandOutput * 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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ElastiCacheClient, PurchaseReservedCacheNodesOfferingCommand } from "@aws-sdk/client-elasticache"; // ES Modules import + * // const { ElastiCacheClient, PurchaseReservedCacheNodesOfferingCommand } = require("@aws-sdk/client-elasticache"); // CommonJS import + * const client = new ElastiCacheClient(config); + * const command = new PurchaseReservedCacheNodesOfferingCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link PurchaseReservedCacheNodesOfferingCommandInput} for command's `input` shape. + * @see {@link PurchaseReservedCacheNodesOfferingCommandOutput} for command's `response` shape. + * @see {@link ElastiCacheClientResolvedConfig | config} for command's `input` shape. + * */ export class PurchaseReservedCacheNodesOfferingCommand extends $Command< PurchaseReservedCacheNodesOfferingCommandInput, diff --git a/clients/client-elasticache/commands/RebalanceSlotsInGlobalReplicationGroupCommand.ts b/clients/client-elasticache/commands/RebalanceSlotsInGlobalReplicationGroupCommand.ts index a3e335cc48cd..8c112db32ce8 100644 --- a/clients/client-elasticache/commands/RebalanceSlotsInGlobalReplicationGroupCommand.ts +++ b/clients/client-elasticache/commands/RebalanceSlotsInGlobalReplicationGroupCommand.ts @@ -28,6 +28,20 @@ export interface RebalanceSlotsInGlobalReplicationGroupCommandOutput /** *

Redistribute slots to ensure uniform distribution across existing shards in the cluster.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ElastiCacheClient, RebalanceSlotsInGlobalReplicationGroupCommand } from "@aws-sdk/client-elasticache"; // ES Modules import + * // const { ElastiCacheClient, RebalanceSlotsInGlobalReplicationGroupCommand } = require("@aws-sdk/client-elasticache"); // CommonJS import + * const client = new ElastiCacheClient(config); + * const command = new RebalanceSlotsInGlobalReplicationGroupCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link RebalanceSlotsInGlobalReplicationGroupCommandInput} for command's `input` shape. + * @see {@link RebalanceSlotsInGlobalReplicationGroupCommandOutput} for command's `response` shape. + * @see {@link ElastiCacheClientResolvedConfig | config} for command's `input` shape. + * */ export class RebalanceSlotsInGlobalReplicationGroupCommand extends $Command< RebalanceSlotsInGlobalReplicationGroupCommandInput, diff --git a/clients/client-elasticache/commands/RebootCacheClusterCommand.ts b/clients/client-elasticache/commands/RebootCacheClusterCommand.ts index f6f6e230d31f..f157360a56a0 100644 --- a/clients/client-elasticache/commands/RebootCacheClusterCommand.ts +++ b/clients/client-elasticache/commands/RebootCacheClusterCommand.ts @@ -34,6 +34,20 @@ export interface RebootCacheClusterCommandOutput extends RebootCacheClusterResul * *

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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ElastiCacheClient, RebootCacheClusterCommand } from "@aws-sdk/client-elasticache"; // ES Modules import + * // const { ElastiCacheClient, RebootCacheClusterCommand } = require("@aws-sdk/client-elasticache"); // CommonJS import + * const client = new ElastiCacheClient(config); + * const command = new RebootCacheClusterCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link RebootCacheClusterCommandInput} for command's `input` shape. + * @see {@link RebootCacheClusterCommandOutput} for command's `response` shape. + * @see {@link ElastiCacheClientResolvedConfig | config} for command's `input` shape. + * */ export class RebootCacheClusterCommand extends $Command< RebootCacheClusterCommandInput, diff --git a/clients/client-elasticache/commands/RemoveTagsFromResourceCommand.ts b/clients/client-elasticache/commands/RemoveTagsFromResourceCommand.ts index 7eef775860b3..680dbaa6e26c 100644 --- a/clients/client-elasticache/commands/RemoveTagsFromResourceCommand.ts +++ b/clients/client-elasticache/commands/RemoveTagsFromResourceCommand.ts @@ -25,6 +25,20 @@ export interface RemoveTagsFromResourceCommandOutput extends TagListMessage, __M * 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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ElastiCacheClient, RemoveTagsFromResourceCommand } from "@aws-sdk/client-elasticache"; // ES Modules import + * // const { ElastiCacheClient, RemoveTagsFromResourceCommand } = require("@aws-sdk/client-elasticache"); // CommonJS import + * const client = new ElastiCacheClient(config); + * const command = new RemoveTagsFromResourceCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link RemoveTagsFromResourceCommandInput} for command's `input` shape. + * @see {@link RemoveTagsFromResourceCommandOutput} for command's `response` shape. + * @see {@link ElastiCacheClientResolvedConfig | config} for command's `input` shape. + * */ export class RemoveTagsFromResourceCommand extends $Command< RemoveTagsFromResourceCommandInput, diff --git a/clients/client-elasticache/commands/ResetCacheParameterGroupCommand.ts b/clients/client-elasticache/commands/ResetCacheParameterGroupCommand.ts index 1a589ca6cb89..30a90ed49f61 100644 --- a/clients/client-elasticache/commands/ResetCacheParameterGroupCommand.ts +++ b/clients/client-elasticache/commands/ResetCacheParameterGroupCommand.ts @@ -25,6 +25,20 @@ export interface ResetCacheParameterGroupCommandOutput extends CacheParameterGro * 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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ElastiCacheClient, ResetCacheParameterGroupCommand } from "@aws-sdk/client-elasticache"; // ES Modules import + * // const { ElastiCacheClient, ResetCacheParameterGroupCommand } = require("@aws-sdk/client-elasticache"); // CommonJS import + * const client = new ElastiCacheClient(config); + * const command = new ResetCacheParameterGroupCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ResetCacheParameterGroupCommandInput} for command's `input` shape. + * @see {@link ResetCacheParameterGroupCommandOutput} for command's `response` shape. + * @see {@link ElastiCacheClientResolvedConfig | config} for command's `input` shape. + * */ export class ResetCacheParameterGroupCommand extends $Command< ResetCacheParameterGroupCommandInput, diff --git a/clients/client-elasticache/commands/RevokeCacheSecurityGroupIngressCommand.ts b/clients/client-elasticache/commands/RevokeCacheSecurityGroupIngressCommand.ts index 96117ba69501..9ecbf4ec8255 100644 --- a/clients/client-elasticache/commands/RevokeCacheSecurityGroupIngressCommand.ts +++ b/clients/client-elasticache/commands/RevokeCacheSecurityGroupIngressCommand.ts @@ -26,6 +26,20 @@ export interface RevokeCacheSecurityGroupIngressCommandOutput *

Revokes ingress from a cache security group. * Use this operation to disallow access from an Amazon EC2 security group * that had been previously authorized.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ElastiCacheClient, RevokeCacheSecurityGroupIngressCommand } from "@aws-sdk/client-elasticache"; // ES Modules import + * // const { ElastiCacheClient, RevokeCacheSecurityGroupIngressCommand } = require("@aws-sdk/client-elasticache"); // CommonJS import + * const client = new ElastiCacheClient(config); + * const command = new RevokeCacheSecurityGroupIngressCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link RevokeCacheSecurityGroupIngressCommandInput} for command's `input` shape. + * @see {@link RevokeCacheSecurityGroupIngressCommandOutput} for command's `response` shape. + * @see {@link ElastiCacheClientResolvedConfig | config} for command's `input` shape. + * */ export class RevokeCacheSecurityGroupIngressCommand extends $Command< RevokeCacheSecurityGroupIngressCommandInput, diff --git a/clients/client-elasticache/commands/StartMigrationCommand.ts b/clients/client-elasticache/commands/StartMigrationCommand.ts index be5385723546..b7f992520e09 100644 --- a/clients/client-elasticache/commands/StartMigrationCommand.ts +++ b/clients/client-elasticache/commands/StartMigrationCommand.ts @@ -22,6 +22,20 @@ export interface StartMigrationCommandOutput extends StartMigrationResponse, __M /** *

Start the migration of data.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ElastiCacheClient, StartMigrationCommand } from "@aws-sdk/client-elasticache"; // ES Modules import + * // const { ElastiCacheClient, StartMigrationCommand } = require("@aws-sdk/client-elasticache"); // CommonJS import + * const client = new ElastiCacheClient(config); + * const command = new StartMigrationCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link StartMigrationCommandInput} for command's `input` shape. + * @see {@link StartMigrationCommandOutput} for command's `response` shape. + * @see {@link ElastiCacheClientResolvedConfig | config} for command's `input` shape. + * */ export class StartMigrationCommand extends $Command< StartMigrationCommandInput, diff --git a/clients/client-elasticache/commands/TestFailoverCommand.ts b/clients/client-elasticache/commands/TestFailoverCommand.ts index ded70e05e0a3..db336eb665d0 100644 --- a/clients/client-elasticache/commands/TestFailoverCommand.ts +++ b/clients/client-elasticache/commands/TestFailoverCommand.ts @@ -81,6 +81,20 @@ export interface TestFailoverCommandOutput extends TestFailoverResult, __Metadat * * *

Also see, Testing Multi-AZ in the ElastiCache User Guide.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ElastiCacheClient, TestFailoverCommand } from "@aws-sdk/client-elasticache"; // ES Modules import + * // const { ElastiCacheClient, TestFailoverCommand } = require("@aws-sdk/client-elasticache"); // CommonJS import + * const client = new ElastiCacheClient(config); + * const command = new TestFailoverCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link TestFailoverCommandInput} for command's `input` shape. + * @see {@link TestFailoverCommandOutput} for command's `response` shape. + * @see {@link ElastiCacheClientResolvedConfig | config} for command's `input` shape. + * */ export class TestFailoverCommand extends $Command< TestFailoverCommandInput, diff --git a/clients/client-elasticache/models/models_0.ts b/clients/client-elasticache/models/models_0.ts index e5a86638963b..6d99133edb10 100644 --- a/clients/client-elasticache/models/models_0.ts +++ b/clients/client-elasticache/models/models_0.ts @@ -18,6 +18,9 @@ export interface Tag { } export namespace Tag { + /** + * @internal + */ export const filterSensitiveLog = (obj: Tag): any => ({ ...obj, }); @@ -44,6 +47,9 @@ export interface AddTagsToResourceMessage { } export namespace AddTagsToResourceMessage { + /** + * @internal + */ export const filterSensitiveLog = (obj: AddTagsToResourceMessage): any => ({ ...obj, }); @@ -59,6 +65,9 @@ export interface CacheClusterNotFoundFault extends __SmithyException, $MetadataB } export namespace CacheClusterNotFoundFault { + /** + * @internal + */ export const filterSensitiveLog = (obj: CacheClusterNotFoundFault): any => ({ ...obj, }); @@ -74,6 +83,9 @@ export interface CacheParameterGroupNotFoundFault extends __SmithyException, $Me } export namespace CacheParameterGroupNotFoundFault { + /** + * @internal + */ export const filterSensitiveLog = (obj: CacheParameterGroupNotFoundFault): any => ({ ...obj, }); @@ -89,6 +101,9 @@ export interface CacheSecurityGroupNotFoundFault extends __SmithyException, $Met } export namespace CacheSecurityGroupNotFoundFault { + /** + * @internal + */ export const filterSensitiveLog = (obj: CacheSecurityGroupNotFoundFault): any => ({ ...obj, }); @@ -104,6 +119,9 @@ export interface CacheSubnetGroupNotFoundFault extends __SmithyException, $Metad } export namespace CacheSubnetGroupNotFoundFault { + /** + * @internal + */ export const filterSensitiveLog = (obj: CacheSubnetGroupNotFoundFault): any => ({ ...obj, }); @@ -119,6 +137,9 @@ export interface InvalidARNFault extends __SmithyException, $MetadataBearer { } export namespace InvalidARNFault { + /** + * @internal + */ export const filterSensitiveLog = (obj: InvalidARNFault): any => ({ ...obj, }); @@ -134,6 +155,9 @@ export interface InvalidReplicationGroupStateFault extends __SmithyException, $M } export namespace InvalidReplicationGroupStateFault { + /** + * @internal + */ export const filterSensitiveLog = (obj: InvalidReplicationGroupStateFault): any => ({ ...obj, }); @@ -149,6 +173,9 @@ export interface ReplicationGroupNotFoundFault extends __SmithyException, $Metad } export namespace ReplicationGroupNotFoundFault { + /** + * @internal + */ export const filterSensitiveLog = (obj: ReplicationGroupNotFoundFault): any => ({ ...obj, }); @@ -164,6 +191,9 @@ export interface ReservedCacheNodeNotFoundFault extends __SmithyException, $Meta } export namespace ReservedCacheNodeNotFoundFault { + /** + * @internal + */ export const filterSensitiveLog = (obj: ReservedCacheNodeNotFoundFault): any => ({ ...obj, }); @@ -179,6 +209,9 @@ export interface SnapshotNotFoundFault extends __SmithyException, $MetadataBeare } export namespace SnapshotNotFoundFault { + /** + * @internal + */ export const filterSensitiveLog = (obj: SnapshotNotFoundFault): any => ({ ...obj, }); @@ -196,6 +229,9 @@ export interface TagListMessage { } export namespace TagListMessage { + /** + * @internal + */ export const filterSensitiveLog = (obj: TagListMessage): any => ({ ...obj, }); @@ -211,6 +247,9 @@ export interface TagQuotaPerResourceExceeded extends __SmithyException, $Metadat } export namespace TagQuotaPerResourceExceeded { + /** + * @internal + */ export const filterSensitiveLog = (obj: TagQuotaPerResourceExceeded): any => ({ ...obj, }); @@ -226,6 +265,9 @@ export interface UserGroupNotFoundFault extends __SmithyException, $MetadataBear } export namespace UserGroupNotFoundFault { + /** + * @internal + */ export const filterSensitiveLog = (obj: UserGroupNotFoundFault): any => ({ ...obj, }); @@ -241,6 +283,9 @@ export interface UserNotFoundFault extends __SmithyException, $MetadataBearer { } export namespace UserNotFoundFault { + /** + * @internal + */ export const filterSensitiveLog = (obj: UserNotFoundFault): any => ({ ...obj, }); @@ -268,6 +313,9 @@ export interface AllowedNodeTypeModificationsMessage { } export namespace AllowedNodeTypeModificationsMessage { + /** + * @internal + */ export const filterSensitiveLog = (obj: AllowedNodeTypeModificationsMessage): any => ({ ...obj, }); @@ -283,6 +331,9 @@ export interface AuthorizationAlreadyExistsFault extends __SmithyException, $Met } export namespace AuthorizationAlreadyExistsFault { + /** + * @internal + */ export const filterSensitiveLog = (obj: AuthorizationAlreadyExistsFault): any => ({ ...obj, }); @@ -311,6 +362,9 @@ export interface AuthorizeCacheSecurityGroupIngressMessage { } export namespace AuthorizeCacheSecurityGroupIngressMessage { + /** + * @internal + */ export const filterSensitiveLog = (obj: AuthorizeCacheSecurityGroupIngressMessage): any => ({ ...obj, }); @@ -337,6 +391,9 @@ export interface EC2SecurityGroup { } export namespace EC2SecurityGroup { + /** + * @internal + */ export const filterSensitiveLog = (obj: EC2SecurityGroup): any => ({ ...obj, }); @@ -390,6 +447,9 @@ export interface CacheSecurityGroup { } export namespace CacheSecurityGroup { + /** + * @internal + */ export const filterSensitiveLog = (obj: CacheSecurityGroup): any => ({ ...obj, }); @@ -420,6 +480,9 @@ export interface AuthorizeCacheSecurityGroupIngressResult { } export namespace AuthorizeCacheSecurityGroupIngressResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: AuthorizeCacheSecurityGroupIngressResult): any => ({ ...obj, }); @@ -435,6 +498,9 @@ export interface InvalidCacheSecurityGroupStateFault extends __SmithyException, } export namespace InvalidCacheSecurityGroupStateFault { + /** + * @internal + */ export const filterSensitiveLog = (obj: InvalidCacheSecurityGroupStateFault): any => ({ ...obj, }); @@ -453,6 +519,9 @@ export interface InvalidParameterCombinationException extends __SmithyException, } export namespace InvalidParameterCombinationException { + /** + * @internal + */ export const filterSensitiveLog = (obj: InvalidParameterCombinationException): any => ({ ...obj, }); @@ -471,6 +540,9 @@ export interface InvalidParameterValueException extends __SmithyException, $Meta } export namespace InvalidParameterValueException { + /** + * @internal + */ export const filterSensitiveLog = (obj: InvalidParameterValueException): any => ({ ...obj, }); @@ -494,6 +566,9 @@ export interface BatchApplyUpdateActionMessage { } export namespace BatchApplyUpdateActionMessage { + /** + * @internal + */ export const filterSensitiveLog = (obj: BatchApplyUpdateActionMessage): any => ({ ...obj, }); @@ -509,6 +584,9 @@ export interface ServiceUpdateNotFoundFault extends __SmithyException, $Metadata } export namespace ServiceUpdateNotFoundFault { + /** + * @internal + */ export const filterSensitiveLog = (obj: ServiceUpdateNotFoundFault): any => ({ ...obj, }); @@ -552,6 +630,9 @@ export interface ProcessedUpdateAction { } export namespace ProcessedUpdateAction { + /** + * @internal + */ export const filterSensitiveLog = (obj: ProcessedUpdateAction): any => ({ ...obj, }); @@ -588,6 +669,9 @@ export interface UnprocessedUpdateAction { } export namespace UnprocessedUpdateAction { + /** + * @internal + */ export const filterSensitiveLog = (obj: UnprocessedUpdateAction): any => ({ ...obj, }); @@ -606,6 +690,9 @@ export interface UpdateActionResultsMessage { } export namespace UpdateActionResultsMessage { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateActionResultsMessage): any => ({ ...obj, }); @@ -629,6 +716,9 @@ export interface BatchStopUpdateActionMessage { } export namespace BatchStopUpdateActionMessage { + /** + * @internal + */ export const filterSensitiveLog = (obj: BatchStopUpdateActionMessage): any => ({ ...obj, }); @@ -647,6 +737,9 @@ export interface CompleteMigrationMessage { } export namespace CompleteMigrationMessage { + /** + * @internal + */ export const filterSensitiveLog = (obj: CompleteMigrationMessage): any => ({ ...obj, }); @@ -675,6 +768,9 @@ export interface Endpoint { } export namespace Endpoint { + /** + * @internal + */ export const filterSensitiveLog = (obj: Endpoint): any => ({ ...obj, }); @@ -696,6 +792,9 @@ export interface GlobalReplicationGroupInfo { } export namespace GlobalReplicationGroupInfo { + /** + * @internal + */ export const filterSensitiveLog = (obj: GlobalReplicationGroupInfo): any => ({ ...obj, }); @@ -712,6 +811,9 @@ export interface CloudWatchLogsDestinationDetails { } export namespace CloudWatchLogsDestinationDetails { + /** + * @internal + */ export const filterSensitiveLog = (obj: CloudWatchLogsDestinationDetails): any => ({ ...obj, }); @@ -728,6 +830,9 @@ export interface KinesisFirehoseDestinationDetails { } export namespace KinesisFirehoseDestinationDetails { + /** + * @internal + */ export const filterSensitiveLog = (obj: KinesisFirehoseDestinationDetails): any => ({ ...obj, }); @@ -749,6 +854,9 @@ export interface DestinationDetails { } export namespace DestinationDetails { + /** + * @internal + */ export const filterSensitiveLog = (obj: DestinationDetails): any => ({ ...obj, }); @@ -813,6 +921,9 @@ export interface LogDeliveryConfiguration { } export namespace LogDeliveryConfiguration { + /** + * @internal + */ export const filterSensitiveLog = (obj: LogDeliveryConfiguration): any => ({ ...obj, }); @@ -862,6 +973,9 @@ export interface NodeGroupMember { } export namespace NodeGroupMember { + /** + * @internal + */ export const filterSensitiveLog = (obj: NodeGroupMember): any => ({ ...obj, }); @@ -908,6 +1022,9 @@ export interface NodeGroup { } export namespace NodeGroup { + /** + * @internal + */ export const filterSensitiveLog = (obj: NodeGroup): any => ({ ...obj, }); @@ -946,6 +1063,9 @@ export interface PendingLogDeliveryConfiguration { } export namespace PendingLogDeliveryConfiguration { + /** + * @internal + */ export const filterSensitiveLog = (obj: PendingLogDeliveryConfiguration): any => ({ ...obj, }); @@ -962,6 +1082,9 @@ export interface SlotMigration { } export namespace SlotMigration { + /** + * @internal + */ export const filterSensitiveLog = (obj: SlotMigration): any => ({ ...obj, }); @@ -978,6 +1101,9 @@ export interface ReshardingStatus { } export namespace ReshardingStatus { + /** + * @internal + */ export const filterSensitiveLog = (obj: ReshardingStatus): any => ({ ...obj, }); @@ -999,6 +1125,9 @@ export interface UserGroupsUpdateStatus { } export namespace UserGroupsUpdateStatus { + /** + * @internal + */ export const filterSensitiveLog = (obj: UserGroupsUpdateStatus): any => ({ ...obj, }); @@ -1042,6 +1171,9 @@ export interface ReplicationGroupPendingModifiedValues { } export namespace ReplicationGroupPendingModifiedValues { + /** + * @internal + */ export const filterSensitiveLog = (obj: ReplicationGroupPendingModifiedValues): any => ({ ...obj, }); @@ -1221,6 +1353,9 @@ export interface ReplicationGroup { } export namespace ReplicationGroup { + /** + * @internal + */ export const filterSensitiveLog = (obj: ReplicationGroup): any => ({ ...obj, }); @@ -1234,6 +1369,9 @@ export interface CompleteMigrationResponse { } export namespace CompleteMigrationResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: CompleteMigrationResponse): any => ({ ...obj, }); @@ -1249,6 +1387,9 @@ export interface ReplicationGroupNotUnderMigrationFault extends __SmithyExceptio } export namespace ReplicationGroupNotUnderMigrationFault { + /** + * @internal + */ export const filterSensitiveLog = (obj: ReplicationGroupNotUnderMigrationFault): any => ({ ...obj, }); @@ -1293,6 +1434,9 @@ export interface CopySnapshotMessage { } export namespace CopySnapshotMessage { + /** + * @internal + */ export const filterSensitiveLog = (obj: CopySnapshotMessage): any => ({ ...obj, }); @@ -1347,6 +1491,9 @@ export interface NodeGroupConfiguration { } export namespace NodeGroupConfiguration { + /** + * @internal + */ export const filterSensitiveLog = (obj: NodeGroupConfiguration): any => ({ ...obj, }); @@ -1393,6 +1540,9 @@ export interface NodeSnapshot { } export namespace NodeSnapshot { + /** + * @internal + */ export const filterSensitiveLog = (obj: NodeSnapshot): any => ({ ...obj, }); @@ -1811,6 +1961,9 @@ export interface Snapshot { } export namespace Snapshot { + /** + * @internal + */ export const filterSensitiveLog = (obj: Snapshot): any => ({ ...obj, }); @@ -1824,6 +1977,9 @@ export interface CopySnapshotResult { } export namespace CopySnapshotResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: CopySnapshotResult): any => ({ ...obj, }); @@ -1839,6 +1995,9 @@ export interface InvalidSnapshotStateFault extends __SmithyException, $MetadataB } export namespace InvalidSnapshotStateFault { + /** + * @internal + */ export const filterSensitiveLog = (obj: InvalidSnapshotStateFault): any => ({ ...obj, }); @@ -1854,6 +2013,9 @@ export interface SnapshotAlreadyExistsFault extends __SmithyException, $Metadata } export namespace SnapshotAlreadyExistsFault { + /** + * @internal + */ export const filterSensitiveLog = (obj: SnapshotAlreadyExistsFault): any => ({ ...obj, }); @@ -1869,6 +2031,9 @@ export interface SnapshotQuotaExceededFault extends __SmithyException, $Metadata } export namespace SnapshotQuotaExceededFault { + /** + * @internal + */ export const filterSensitiveLog = (obj: SnapshotQuotaExceededFault): any => ({ ...obj, }); @@ -1884,6 +2049,9 @@ export interface CacheClusterAlreadyExistsFault extends __SmithyException, $Meta } export namespace CacheClusterAlreadyExistsFault { + /** + * @internal + */ export const filterSensitiveLog = (obj: CacheClusterAlreadyExistsFault): any => ({ ...obj, }); @@ -1899,6 +2067,9 @@ export interface ClusterQuotaForCustomerExceededFault extends __SmithyException, } export namespace ClusterQuotaForCustomerExceededFault { + /** + * @internal + */ export const filterSensitiveLog = (obj: ClusterQuotaForCustomerExceededFault): any => ({ ...obj, }); @@ -1940,6 +2111,9 @@ export interface LogDeliveryConfigurationRequest { } export namespace LogDeliveryConfigurationRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: LogDeliveryConfigurationRequest): any => ({ ...obj, }); @@ -2406,6 +2580,9 @@ export interface CreateCacheClusterMessage { } export namespace CreateCacheClusterMessage { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateCacheClusterMessage): any => ({ ...obj, }); @@ -2673,6 +2850,9 @@ export interface CacheNode { } export namespace CacheNode { + /** + * @internal + */ export const filterSensitiveLog = (obj: CacheNode): any => ({ ...obj, }); @@ -2700,6 +2880,9 @@ export interface CacheParameterGroupStatus { } export namespace CacheParameterGroupStatus { + /** + * @internal + */ export const filterSensitiveLog = (obj: CacheParameterGroupStatus): any => ({ ...obj, }); @@ -2721,6 +2904,9 @@ export interface CacheSecurityGroupMembership { } export namespace CacheSecurityGroupMembership { + /** + * @internal + */ export const filterSensitiveLog = (obj: CacheSecurityGroupMembership): any => ({ ...obj, }); @@ -2744,6 +2930,9 @@ export interface NotificationConfiguration { } export namespace NotificationConfiguration { + /** + * @internal + */ export const filterSensitiveLog = (obj: NotificationConfiguration): any => ({ ...obj, }); @@ -2789,6 +2978,9 @@ export interface PendingModifiedValues { } export namespace PendingModifiedValues { + /** + * @internal + */ export const filterSensitiveLog = (obj: PendingModifiedValues): any => ({ ...obj, }); @@ -2812,6 +3004,9 @@ export interface SecurityGroupMembership { } export namespace SecurityGroupMembership { + /** + * @internal + */ export const filterSensitiveLog = (obj: SecurityGroupMembership): any => ({ ...obj, }); @@ -3279,6 +3474,9 @@ export interface CacheCluster { } export namespace CacheCluster { + /** + * @internal + */ export const filterSensitiveLog = (obj: CacheCluster): any => ({ ...obj, }); @@ -3292,6 +3490,9 @@ export interface CreateCacheClusterResult { } export namespace CreateCacheClusterResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateCacheClusterResult): any => ({ ...obj, }); @@ -3308,6 +3509,9 @@ export interface InsufficientCacheClusterCapacityFault extends __SmithyException } export namespace InsufficientCacheClusterCapacityFault { + /** + * @internal + */ export const filterSensitiveLog = (obj: InsufficientCacheClusterCapacityFault): any => ({ ...obj, }); @@ -3323,6 +3527,9 @@ export interface InvalidVPCNetworkStateFault extends __SmithyException, $Metadat } export namespace InvalidVPCNetworkStateFault { + /** + * @internal + */ export const filterSensitiveLog = (obj: InvalidVPCNetworkStateFault): any => ({ ...obj, }); @@ -3338,6 +3545,9 @@ export interface NodeQuotaForClusterExceededFault extends __SmithyException, $Me } export namespace NodeQuotaForClusterExceededFault { + /** + * @internal + */ export const filterSensitiveLog = (obj: NodeQuotaForClusterExceededFault): any => ({ ...obj, }); @@ -3353,6 +3563,9 @@ export interface NodeQuotaForCustomerExceededFault extends __SmithyException, $M } export namespace NodeQuotaForCustomerExceededFault { + /** + * @internal + */ export const filterSensitiveLog = (obj: NodeQuotaForCustomerExceededFault): any => ({ ...obj, }); @@ -3368,6 +3581,9 @@ export interface CacheParameterGroupAlreadyExistsFault extends __SmithyException } export namespace CacheParameterGroupAlreadyExistsFault { + /** + * @internal + */ export const filterSensitiveLog = (obj: CacheParameterGroupAlreadyExistsFault): any => ({ ...obj, }); @@ -3383,6 +3599,9 @@ export interface CacheParameterGroupQuotaExceededFault extends __SmithyException } export namespace CacheParameterGroupQuotaExceededFault { + /** + * @internal + */ export const filterSensitiveLog = (obj: CacheParameterGroupQuotaExceededFault): any => ({ ...obj, }); @@ -3425,6 +3644,9 @@ export interface CreateCacheParameterGroupMessage { } export namespace CreateCacheParameterGroupMessage { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateCacheParameterGroupMessage): any => ({ ...obj, }); @@ -3472,6 +3694,9 @@ export interface CacheParameterGroup { } export namespace CacheParameterGroup { + /** + * @internal + */ export const filterSensitiveLog = (obj: CacheParameterGroup): any => ({ ...obj, }); @@ -3485,6 +3710,9 @@ export interface CreateCacheParameterGroupResult { } export namespace CreateCacheParameterGroupResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateCacheParameterGroupResult): any => ({ ...obj, }); @@ -3500,6 +3728,9 @@ export interface InvalidCacheParameterGroupStateFault extends __SmithyException, } export namespace InvalidCacheParameterGroupStateFault { + /** + * @internal + */ export const filterSensitiveLog = (obj: InvalidCacheParameterGroupStateFault): any => ({ ...obj, }); @@ -3515,6 +3746,9 @@ export interface CacheSecurityGroupAlreadyExistsFault extends __SmithyException, } export namespace CacheSecurityGroupAlreadyExistsFault { + /** + * @internal + */ export const filterSensitiveLog = (obj: CacheSecurityGroupAlreadyExistsFault): any => ({ ...obj, }); @@ -3530,6 +3764,9 @@ export interface CacheSecurityGroupQuotaExceededFault extends __SmithyException, } export namespace CacheSecurityGroupQuotaExceededFault { + /** + * @internal + */ export const filterSensitiveLog = (obj: CacheSecurityGroupQuotaExceededFault): any => ({ ...obj, }); @@ -3559,6 +3796,9 @@ export interface CreateCacheSecurityGroupMessage { } export namespace CreateCacheSecurityGroupMessage { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateCacheSecurityGroupMessage): any => ({ ...obj, }); @@ -3589,6 +3829,9 @@ export interface CreateCacheSecurityGroupResult { } export namespace CreateCacheSecurityGroupResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateCacheSecurityGroupResult): any => ({ ...obj, }); @@ -3604,6 +3847,9 @@ export interface CacheSubnetGroupAlreadyExistsFault extends __SmithyException, $ } export namespace CacheSubnetGroupAlreadyExistsFault { + /** + * @internal + */ export const filterSensitiveLog = (obj: CacheSubnetGroupAlreadyExistsFault): any => ({ ...obj, }); @@ -3619,6 +3865,9 @@ export interface CacheSubnetGroupQuotaExceededFault extends __SmithyException, $ } export namespace CacheSubnetGroupQuotaExceededFault { + /** + * @internal + */ export const filterSensitiveLog = (obj: CacheSubnetGroupQuotaExceededFault): any => ({ ...obj, }); @@ -3634,6 +3883,9 @@ export interface CacheSubnetQuotaExceededFault extends __SmithyException, $Metad } export namespace CacheSubnetQuotaExceededFault { + /** + * @internal + */ export const filterSensitiveLog = (obj: CacheSubnetQuotaExceededFault): any => ({ ...obj, }); @@ -3668,6 +3920,9 @@ export interface CreateCacheSubnetGroupMessage { } export namespace CreateCacheSubnetGroupMessage { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateCacheSubnetGroupMessage): any => ({ ...obj, }); @@ -3684,6 +3939,9 @@ export interface AvailabilityZone { } export namespace AvailabilityZone { + /** + * @internal + */ export const filterSensitiveLog = (obj: AvailabilityZone): any => ({ ...obj, }); @@ -3700,6 +3958,9 @@ export interface SubnetOutpost { } export namespace SubnetOutpost { + /** + * @internal + */ export const filterSensitiveLog = (obj: SubnetOutpost): any => ({ ...obj, }); @@ -3727,6 +3988,9 @@ export interface Subnet { } export namespace Subnet { + /** + * @internal + */ export const filterSensitiveLog = (obj: Subnet): any => ({ ...obj, }); @@ -3775,6 +4039,9 @@ export interface CacheSubnetGroup { } export namespace CacheSubnetGroup { + /** + * @internal + */ export const filterSensitiveLog = (obj: CacheSubnetGroup): any => ({ ...obj, }); @@ -3800,6 +4067,9 @@ export interface CreateCacheSubnetGroupResult { } export namespace CreateCacheSubnetGroupResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateCacheSubnetGroupResult): any => ({ ...obj, }); @@ -3815,6 +4085,9 @@ export interface InvalidSubnet extends __SmithyException, $MetadataBearer { } export namespace InvalidSubnet { + /** + * @internal + */ export const filterSensitiveLog = (obj: InvalidSubnet): any => ({ ...obj, }); @@ -3831,6 +4104,9 @@ export interface SubnetNotAllowedFault extends __SmithyException, $MetadataBeare } export namespace SubnetNotAllowedFault { + /** + * @internal + */ export const filterSensitiveLog = (obj: SubnetNotAllowedFault): any => ({ ...obj, }); @@ -3856,6 +4132,9 @@ export interface CreateGlobalReplicationGroupMessage { } export namespace CreateGlobalReplicationGroupMessage { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateGlobalReplicationGroupMessage): any => ({ ...obj, }); @@ -3877,6 +4156,9 @@ export interface GlobalNodeGroup { } export namespace GlobalNodeGroup { + /** + * @internal + */ export const filterSensitiveLog = (obj: GlobalNodeGroup): any => ({ ...obj, }); @@ -3913,6 +4195,9 @@ export interface GlobalReplicationGroupMember { } export namespace GlobalReplicationGroupMember { + /** + * @internal + */ export const filterSensitiveLog = (obj: GlobalReplicationGroupMember): any => ({ ...obj, }); @@ -4013,6 +4298,9 @@ export interface GlobalReplicationGroup { } export namespace GlobalReplicationGroup { + /** + * @internal + */ export const filterSensitiveLog = (obj: GlobalReplicationGroup): any => ({ ...obj, }); @@ -4035,6 +4323,9 @@ export interface CreateGlobalReplicationGroupResult { } export namespace CreateGlobalReplicationGroupResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateGlobalReplicationGroupResult): any => ({ ...obj, }); @@ -4050,6 +4341,9 @@ export interface GlobalReplicationGroupAlreadyExistsFault extends __SmithyExcept } export namespace GlobalReplicationGroupAlreadyExistsFault { + /** + * @internal + */ export const filterSensitiveLog = (obj: GlobalReplicationGroupAlreadyExistsFault): any => ({ ...obj, }); @@ -4065,6 +4359,9 @@ export interface ServiceLinkedRoleNotFoundFault extends __SmithyException, $Meta } export namespace ServiceLinkedRoleNotFoundFault { + /** + * @internal + */ export const filterSensitiveLog = (obj: ServiceLinkedRoleNotFoundFault): any => ({ ...obj, }); @@ -4651,6 +4948,9 @@ export interface CreateReplicationGroupMessage { } export namespace CreateReplicationGroupMessage { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateReplicationGroupMessage): any => ({ ...obj, }); @@ -4664,6 +4964,9 @@ export interface CreateReplicationGroupResult { } export namespace CreateReplicationGroupResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateReplicationGroupResult): any => ({ ...obj, }); @@ -4679,6 +4982,9 @@ export interface GlobalReplicationGroupNotFoundFault extends __SmithyException, } export namespace GlobalReplicationGroupNotFoundFault { + /** + * @internal + */ export const filterSensitiveLog = (obj: GlobalReplicationGroupNotFoundFault): any => ({ ...obj, }); @@ -4694,6 +5000,9 @@ export interface InvalidCacheClusterStateFault extends __SmithyException, $Metad } export namespace InvalidCacheClusterStateFault { + /** + * @internal + */ export const filterSensitiveLog = (obj: InvalidCacheClusterStateFault): any => ({ ...obj, }); @@ -4709,6 +5018,9 @@ export interface InvalidGlobalReplicationGroupStateFault extends __SmithyExcepti } export namespace InvalidGlobalReplicationGroupStateFault { + /** + * @internal + */ export const filterSensitiveLog = (obj: InvalidGlobalReplicationGroupStateFault): any => ({ ...obj, }); @@ -4724,6 +5036,9 @@ export interface InvalidUserGroupStateFault extends __SmithyException, $Metadata } export namespace InvalidUserGroupStateFault { + /** + * @internal + */ export const filterSensitiveLog = (obj: InvalidUserGroupStateFault): any => ({ ...obj, }); @@ -4740,6 +5055,9 @@ export interface NodeGroupsPerReplicationGroupQuotaExceededFault extends __Smith } export namespace NodeGroupsPerReplicationGroupQuotaExceededFault { + /** + * @internal + */ export const filterSensitiveLog = (obj: NodeGroupsPerReplicationGroupQuotaExceededFault): any => ({ ...obj, }); @@ -4755,6 +5073,9 @@ export interface ReplicationGroupAlreadyExistsFault extends __SmithyException, $ } export namespace ReplicationGroupAlreadyExistsFault { + /** + * @internal + */ export const filterSensitiveLog = (obj: ReplicationGroupAlreadyExistsFault): any => ({ ...obj, }); @@ -4791,6 +5112,9 @@ export interface CreateSnapshotMessage { } export namespace CreateSnapshotMessage { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateSnapshotMessage): any => ({ ...obj, }); @@ -4804,6 +5128,9 @@ export interface CreateSnapshotResult { } export namespace CreateSnapshotResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateSnapshotResult): any => ({ ...obj, }); @@ -4829,6 +5156,9 @@ export interface SnapshotFeatureNotSupportedFault extends __SmithyException, $Me } export namespace SnapshotFeatureNotSupportedFault { + /** + * @internal + */ export const filterSensitiveLog = (obj: SnapshotFeatureNotSupportedFault): any => ({ ...obj, }); @@ -4872,6 +5202,9 @@ export interface CreateUserMessage { } export namespace CreateUserMessage { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateUserMessage): any => ({ ...obj, }); @@ -4887,6 +5220,9 @@ export interface DuplicateUserNameFault extends __SmithyException, $MetadataBear } export namespace DuplicateUserNameFault { + /** + * @internal + */ export const filterSensitiveLog = (obj: DuplicateUserNameFault): any => ({ ...obj, }); @@ -4913,6 +5249,9 @@ export interface Authentication { } export namespace Authentication { + /** + * @internal + */ export const filterSensitiveLog = (obj: Authentication): any => ({ ...obj, }); @@ -4961,6 +5300,9 @@ export interface User { } export namespace User { + /** + * @internal + */ export const filterSensitiveLog = (obj: User): any => ({ ...obj, }); @@ -4976,6 +5318,9 @@ export interface UserAlreadyExistsFault extends __SmithyException, $MetadataBear } export namespace UserAlreadyExistsFault { + /** + * @internal + */ export const filterSensitiveLog = (obj: UserAlreadyExistsFault): any => ({ ...obj, }); @@ -4991,6 +5336,9 @@ export interface UserQuotaExceededFault extends __SmithyException, $MetadataBear } export namespace UserQuotaExceededFault { + /** + * @internal + */ export const filterSensitiveLog = (obj: UserQuotaExceededFault): any => ({ ...obj, }); @@ -5019,6 +5367,9 @@ export interface CreateUserGroupMessage { } export namespace CreateUserGroupMessage { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateUserGroupMessage): any => ({ ...obj, }); @@ -5034,6 +5385,9 @@ export interface DefaultUserRequired extends __SmithyException, $MetadataBearer } export namespace DefaultUserRequired { + /** + * @internal + */ export const filterSensitiveLog = (obj: DefaultUserRequired): any => ({ ...obj, }); @@ -5055,6 +5409,9 @@ export interface UserGroupPendingChanges { } export namespace UserGroupPendingChanges { + /** + * @internal + */ export const filterSensitiveLog = (obj: UserGroupPendingChanges): any => ({ ...obj, }); @@ -5098,6 +5455,9 @@ export interface UserGroup { } export namespace UserGroup { + /** + * @internal + */ export const filterSensitiveLog = (obj: UserGroup): any => ({ ...obj, }); @@ -5113,6 +5473,9 @@ export interface UserGroupAlreadyExistsFault extends __SmithyException, $Metadat } export namespace UserGroupAlreadyExistsFault { + /** + * @internal + */ export const filterSensitiveLog = (obj: UserGroupAlreadyExistsFault): any => ({ ...obj, }); @@ -5128,6 +5491,9 @@ export interface UserGroupQuotaExceededFault extends __SmithyException, $Metadat } export namespace UserGroupQuotaExceededFault { + /** + * @internal + */ export const filterSensitiveLog = (obj: UserGroupQuotaExceededFault): any => ({ ...obj, }); @@ -5166,6 +5532,9 @@ export interface DecreaseNodeGroupsInGlobalReplicationGroupMessage { } export namespace DecreaseNodeGroupsInGlobalReplicationGroupMessage { + /** + * @internal + */ export const filterSensitiveLog = (obj: DecreaseNodeGroupsInGlobalReplicationGroupMessage): any => ({ ...obj, }); @@ -5188,6 +5557,9 @@ export interface DecreaseNodeGroupsInGlobalReplicationGroupResult { } export namespace DecreaseNodeGroupsInGlobalReplicationGroupResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: DecreaseNodeGroupsInGlobalReplicationGroupResult): any => ({ ...obj, }); @@ -5245,6 +5617,9 @@ export interface ConfigureShard { } export namespace ConfigureShard { + /** + * @internal + */ export const filterSensitiveLog = (obj: ConfigureShard): any => ({ ...obj, }); @@ -5302,6 +5677,9 @@ export interface DecreaseReplicaCountMessage { } export namespace DecreaseReplicaCountMessage { + /** + * @internal + */ export const filterSensitiveLog = (obj: DecreaseReplicaCountMessage): any => ({ ...obj, }); @@ -5315,6 +5693,9 @@ export interface DecreaseReplicaCountResult { } export namespace DecreaseReplicaCountResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: DecreaseReplicaCountResult): any => ({ ...obj, }); @@ -5330,6 +5711,9 @@ export interface NoOperationFault extends __SmithyException, $MetadataBearer { } export namespace NoOperationFault { + /** + * @internal + */ export const filterSensitiveLog = (obj: NoOperationFault): any => ({ ...obj, }); @@ -5352,6 +5736,9 @@ export interface DeleteCacheClusterMessage { } export namespace DeleteCacheClusterMessage { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteCacheClusterMessage): any => ({ ...obj, }); @@ -5365,6 +5752,9 @@ export interface DeleteCacheClusterResult { } export namespace DeleteCacheClusterResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteCacheClusterResult): any => ({ ...obj, }); @@ -5384,6 +5774,9 @@ export interface DeleteCacheParameterGroupMessage { } export namespace DeleteCacheParameterGroupMessage { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteCacheParameterGroupMessage): any => ({ ...obj, }); @@ -5403,6 +5796,9 @@ export interface DeleteCacheSecurityGroupMessage { } export namespace DeleteCacheSecurityGroupMessage { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteCacheSecurityGroupMessage): any => ({ ...obj, }); @@ -5418,6 +5814,9 @@ export interface CacheSubnetGroupInUse extends __SmithyException, $MetadataBeare } export namespace CacheSubnetGroupInUse { + /** + * @internal + */ export const filterSensitiveLog = (obj: CacheSubnetGroupInUse): any => ({ ...obj, }); @@ -5435,6 +5834,9 @@ export interface DeleteCacheSubnetGroupMessage { } export namespace DeleteCacheSubnetGroupMessage { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteCacheSubnetGroupMessage): any => ({ ...obj, }); @@ -5453,6 +5855,9 @@ export interface DeleteGlobalReplicationGroupMessage { } export namespace DeleteGlobalReplicationGroupMessage { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteGlobalReplicationGroupMessage): any => ({ ...obj, }); @@ -5475,6 +5880,9 @@ export interface DeleteGlobalReplicationGroupResult { } export namespace DeleteGlobalReplicationGroupResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteGlobalReplicationGroupResult): any => ({ ...obj, }); @@ -5505,6 +5913,9 @@ export interface DeleteReplicationGroupMessage { } export namespace DeleteReplicationGroupMessage { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteReplicationGroupMessage): any => ({ ...obj, }); @@ -5518,6 +5929,9 @@ export interface DeleteReplicationGroupResult { } export namespace DeleteReplicationGroupResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteReplicationGroupResult): any => ({ ...obj, }); @@ -5534,6 +5948,9 @@ export interface DeleteSnapshotMessage { } export namespace DeleteSnapshotMessage { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteSnapshotMessage): any => ({ ...obj, }); @@ -5547,6 +5964,9 @@ export interface DeleteSnapshotResult { } export namespace DeleteSnapshotResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteSnapshotResult): any => ({ ...obj, }); @@ -5562,6 +5982,9 @@ export interface DefaultUserAssociatedToUserGroupFault extends __SmithyException } export namespace DefaultUserAssociatedToUserGroupFault { + /** + * @internal + */ export const filterSensitiveLog = (obj: DefaultUserAssociatedToUserGroupFault): any => ({ ...obj, }); @@ -5575,6 +5998,9 @@ export interface DeleteUserMessage { } export namespace DeleteUserMessage { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteUserMessage): any => ({ ...obj, }); @@ -5590,6 +6016,9 @@ export interface InvalidUserStateFault extends __SmithyException, $MetadataBeare } export namespace InvalidUserStateFault { + /** + * @internal + */ export const filterSensitiveLog = (obj: InvalidUserStateFault): any => ({ ...obj, }); @@ -5603,6 +6032,9 @@ export interface DeleteUserGroupMessage { } export namespace DeleteUserGroupMessage { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteUserGroupMessage): any => ({ ...obj, }); @@ -5624,6 +6056,9 @@ export interface CacheClusterMessage { } export namespace CacheClusterMessage { + /** + * @internal + */ export const filterSensitiveLog = (obj: CacheClusterMessage): any => ({ ...obj, }); @@ -5672,6 +6107,9 @@ export interface DescribeCacheClustersMessage { } export namespace DescribeCacheClustersMessage { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeCacheClustersMessage): any => ({ ...obj, }); @@ -5719,6 +6157,9 @@ export interface CacheEngineVersion { } export namespace CacheEngineVersion { + /** + * @internal + */ export const filterSensitiveLog = (obj: CacheEngineVersion): any => ({ ...obj, }); @@ -5741,6 +6182,9 @@ export interface CacheEngineVersionMessage { } export namespace CacheEngineVersionMessage { + /** + * @internal + */ export const filterSensitiveLog = (obj: CacheEngineVersionMessage): any => ({ ...obj, }); @@ -5816,6 +6260,9 @@ export interface DescribeCacheEngineVersionsMessage { } export namespace DescribeCacheEngineVersionsMessage { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeCacheEngineVersionsMessage): any => ({ ...obj, }); @@ -5838,6 +6285,9 @@ export interface CacheParameterGroupsMessage { } export namespace CacheParameterGroupsMessage { + /** + * @internal + */ export const filterSensitiveLog = (obj: CacheParameterGroupsMessage): any => ({ ...obj, }); @@ -5871,6 +6321,9 @@ export interface DescribeCacheParameterGroupsMessage { } export namespace DescribeCacheParameterGroupsMessage { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeCacheParameterGroupsMessage): any => ({ ...obj, }); @@ -5892,6 +6345,9 @@ export interface CacheNodeTypeSpecificValue { } export namespace CacheNodeTypeSpecificValue { + /** + * @internal + */ export const filterSensitiveLog = (obj: CacheNodeTypeSpecificValue): any => ({ ...obj, }); @@ -5957,6 +6413,9 @@ export interface CacheNodeTypeSpecificParameter { } export namespace CacheNodeTypeSpecificParameter { + /** + * @internal + */ export const filterSensitiveLog = (obj: CacheNodeTypeSpecificParameter): any => ({ ...obj, }); @@ -6017,6 +6476,9 @@ export interface Parameter { } export namespace Parameter { + /** + * @internal + */ export const filterSensitiveLog = (obj: Parameter): any => ({ ...obj, }); @@ -6044,6 +6506,9 @@ export interface CacheParameterGroupDetails { } export namespace CacheParameterGroupDetails { + /** + * @internal + */ export const filterSensitiveLog = (obj: CacheParameterGroupDetails): any => ({ ...obj, }); @@ -6085,6 +6550,9 @@ export interface DescribeCacheParametersMessage { } export namespace DescribeCacheParametersMessage { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeCacheParametersMessage): any => ({ ...obj, }); @@ -6106,6 +6574,9 @@ export interface CacheSecurityGroupMessage { } export namespace CacheSecurityGroupMessage { + /** + * @internal + */ export const filterSensitiveLog = (obj: CacheSecurityGroupMessage): any => ({ ...obj, }); @@ -6139,6 +6610,9 @@ export interface DescribeCacheSecurityGroupsMessage { } export namespace DescribeCacheSecurityGroupsMessage { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeCacheSecurityGroupsMessage): any => ({ ...obj, }); @@ -6160,6 +6634,9 @@ export interface CacheSubnetGroupMessage { } export namespace CacheSubnetGroupMessage { + /** + * @internal + */ export const filterSensitiveLog = (obj: CacheSubnetGroupMessage): any => ({ ...obj, }); @@ -6194,6 +6671,9 @@ export interface DescribeCacheSubnetGroupsMessage { } export namespace DescribeCacheSubnetGroupsMessage { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeCacheSubnetGroupsMessage): any => ({ ...obj, }); @@ -6238,6 +6718,9 @@ export interface DescribeEngineDefaultParametersMessage { } export namespace DescribeEngineDefaultParametersMessage { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeEngineDefaultParametersMessage): any => ({ ...obj, }); @@ -6280,6 +6763,9 @@ export interface EngineDefaults { } export namespace EngineDefaults { + /** + * @internal + */ export const filterSensitiveLog = (obj: EngineDefaults): any => ({ ...obj, }); @@ -6293,6 +6779,9 @@ export interface DescribeEngineDefaultParametersResult { } export namespace DescribeEngineDefaultParametersResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeEngineDefaultParametersResult): any => ({ ...obj, }); @@ -6362,6 +6851,9 @@ export interface DescribeEventsMessage { } export namespace DescribeEventsMessage { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeEventsMessage): any => ({ ...obj, }); @@ -6396,6 +6888,9 @@ export interface Event { } export namespace Event { + /** + * @internal + */ export const filterSensitiveLog = (obj: Event): any => ({ ...obj, }); @@ -6417,6 +6912,9 @@ export interface EventsMessage { } export namespace EventsMessage { + /** + * @internal + */ export const filterSensitiveLog = (obj: EventsMessage): any => ({ ...obj, }); @@ -6445,6 +6943,9 @@ export interface DescribeGlobalReplicationGroupsMessage { } export namespace DescribeGlobalReplicationGroupsMessage { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeGlobalReplicationGroupsMessage): any => ({ ...obj, }); @@ -6463,6 +6964,9 @@ export interface DescribeGlobalReplicationGroupsResult { } export namespace DescribeGlobalReplicationGroupsResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeGlobalReplicationGroupsResult): any => ({ ...obj, }); @@ -6497,6 +7001,9 @@ export interface DescribeReplicationGroupsMessage { } export namespace DescribeReplicationGroupsMessage { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeReplicationGroupsMessage): any => ({ ...obj, }); @@ -6518,6 +7025,9 @@ export interface ReplicationGroupMessage { } export namespace ReplicationGroupMessage { + /** + * @internal + */ export const filterSensitiveLog = (obj: ReplicationGroupMessage): any => ({ ...obj, }); @@ -6799,6 +7309,9 @@ export interface DescribeReservedCacheNodesMessage { } export namespace DescribeReservedCacheNodesMessage { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeReservedCacheNodesMessage): any => ({ ...obj, }); @@ -6821,6 +7334,9 @@ export interface RecurringCharge { } export namespace RecurringCharge { + /** + * @internal + */ export const filterSensitiveLog = (obj: RecurringCharge): any => ({ ...obj, }); @@ -7112,6 +7628,9 @@ export interface ReservedCacheNode { } export namespace ReservedCacheNode { + /** + * @internal + */ export const filterSensitiveLog = (obj: ReservedCacheNode): any => ({ ...obj, }); @@ -7133,6 +7652,9 @@ export interface ReservedCacheNodeMessage { } export namespace ReservedCacheNodeMessage { + /** + * @internal + */ export const filterSensitiveLog = (obj: ReservedCacheNodeMessage): any => ({ ...obj, }); @@ -7411,6 +7933,9 @@ export interface DescribeReservedCacheNodesOfferingsMessage { } export namespace DescribeReservedCacheNodesOfferingsMessage { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeReservedCacheNodesOfferingsMessage): any => ({ ...obj, }); @@ -7674,6 +8199,9 @@ export interface ReservedCacheNodesOffering { } export namespace ReservedCacheNodesOffering { + /** + * @internal + */ export const filterSensitiveLog = (obj: ReservedCacheNodesOffering): any => ({ ...obj, }); @@ -7695,6 +8223,9 @@ export interface ReservedCacheNodesOfferingMessage { } export namespace ReservedCacheNodesOfferingMessage { + /** + * @internal + */ export const filterSensitiveLog = (obj: ReservedCacheNodesOfferingMessage): any => ({ ...obj, }); @@ -7710,6 +8241,9 @@ export interface ReservedCacheNodesOfferingNotFoundFault extends __SmithyExcepti } export namespace ReservedCacheNodesOfferingNotFoundFault { + /** + * @internal + */ export const filterSensitiveLog = (obj: ReservedCacheNodesOfferingNotFoundFault): any => ({ ...obj, }); @@ -7747,6 +8281,9 @@ export interface DescribeServiceUpdatesMessage { } export namespace DescribeServiceUpdatesMessage { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeServiceUpdatesMessage): any => ({ ...obj, }); @@ -7829,6 +8366,9 @@ export interface ServiceUpdate { } export namespace ServiceUpdate { + /** + * @internal + */ export const filterSensitiveLog = (obj: ServiceUpdate): any => ({ ...obj, }); @@ -7850,6 +8390,9 @@ export interface ServiceUpdatesMessage { } export namespace ServiceUpdatesMessage { + /** + * @internal + */ export const filterSensitiveLog = (obj: ServiceUpdatesMessage): any => ({ ...obj, }); @@ -7874,6 +8417,9 @@ export interface DescribeSnapshotsListMessage { } export namespace DescribeSnapshotsListMessage { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeSnapshotsListMessage): any => ({ ...obj, }); @@ -7932,6 +8478,9 @@ export interface DescribeSnapshotsMessage { } export namespace DescribeSnapshotsMessage { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeSnapshotsMessage): any => ({ ...obj, }); @@ -7953,6 +8502,9 @@ export interface TimeRangeFilter { } export namespace TimeRangeFilter { + /** + * @internal + */ export const filterSensitiveLog = (obj: TimeRangeFilter): any => ({ ...obj, }); @@ -8014,6 +8566,9 @@ export interface DescribeUpdateActionsMessage { } export namespace DescribeUpdateActionsMessage { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeUpdateActionsMessage): any => ({ ...obj, }); @@ -8079,6 +8634,9 @@ export interface CacheNodeUpdateStatus { } export namespace CacheNodeUpdateStatus { + /** + * @internal + */ export const filterSensitiveLog = (obj: CacheNodeUpdateStatus): any => ({ ...obj, }); @@ -8135,6 +8693,9 @@ export interface NodeGroupMemberUpdateStatus { } export namespace NodeGroupMemberUpdateStatus { + /** + * @internal + */ export const filterSensitiveLog = (obj: NodeGroupMemberUpdateStatus): any => ({ ...obj, }); @@ -8156,6 +8717,9 @@ export interface NodeGroupUpdateStatus { } export namespace NodeGroupUpdateStatus { + /** + * @internal + */ export const filterSensitiveLog = (obj: NodeGroupUpdateStatus): any => ({ ...obj, }); @@ -8259,6 +8823,9 @@ export interface UpdateAction { } export namespace UpdateAction { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateAction): any => ({ ...obj, }); @@ -8280,6 +8847,9 @@ export interface UpdateActionsMessage { } export namespace UpdateActionsMessage { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateActionsMessage): any => ({ ...obj, }); @@ -8303,6 +8873,9 @@ export interface DescribeUserGroupsMessage { } export namespace DescribeUserGroupsMessage { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeUserGroupsMessage): any => ({ ...obj, }); @@ -8321,6 +8894,9 @@ export interface DescribeUserGroupsResult { } export namespace DescribeUserGroupsResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeUserGroupsResult): any => ({ ...obj, }); @@ -8342,6 +8918,9 @@ export interface Filter { } export namespace Filter { + /** + * @internal + */ export const filterSensitiveLog = (obj: Filter): any => ({ ...obj, }); @@ -8375,6 +8954,9 @@ export interface DescribeUsersMessage { } export namespace DescribeUsersMessage { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeUsersMessage): any => ({ ...obj, }); @@ -8393,6 +8975,9 @@ export interface DescribeUsersResult { } export namespace DescribeUsersResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeUsersResult): any => ({ ...obj, }); @@ -8416,6 +9001,9 @@ export interface DisassociateGlobalReplicationGroupMessage { } export namespace DisassociateGlobalReplicationGroupMessage { + /** + * @internal + */ export const filterSensitiveLog = (obj: DisassociateGlobalReplicationGroupMessage): any => ({ ...obj, }); @@ -8438,6 +9026,9 @@ export interface DisassociateGlobalReplicationGroupResult { } export namespace DisassociateGlobalReplicationGroupResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: DisassociateGlobalReplicationGroupResult): any => ({ ...obj, }); @@ -8461,6 +9052,9 @@ export interface FailoverGlobalReplicationGroupMessage { } export namespace FailoverGlobalReplicationGroupMessage { + /** + * @internal + */ export const filterSensitiveLog = (obj: FailoverGlobalReplicationGroupMessage): any => ({ ...obj, }); @@ -8483,6 +9077,9 @@ export interface FailoverGlobalReplicationGroupResult { } export namespace FailoverGlobalReplicationGroupResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: FailoverGlobalReplicationGroupResult): any => ({ ...obj, }); @@ -8506,6 +9103,9 @@ export interface ReshardingConfiguration { } export namespace ReshardingConfiguration { + /** + * @internal + */ export const filterSensitiveLog = (obj: ReshardingConfiguration): any => ({ ...obj, }); @@ -8532,6 +9132,9 @@ export interface RegionalConfiguration { } export namespace RegionalConfiguration { + /** + * @internal + */ export const filterSensitiveLog = (obj: RegionalConfiguration): any => ({ ...obj, }); @@ -8560,6 +9163,9 @@ export interface IncreaseNodeGroupsInGlobalReplicationGroupMessage { } export namespace IncreaseNodeGroupsInGlobalReplicationGroupMessage { + /** + * @internal + */ export const filterSensitiveLog = (obj: IncreaseNodeGroupsInGlobalReplicationGroupMessage): any => ({ ...obj, }); @@ -8582,6 +9188,9 @@ export interface IncreaseNodeGroupsInGlobalReplicationGroupResult { } export namespace IncreaseNodeGroupsInGlobalReplicationGroupResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: IncreaseNodeGroupsInGlobalReplicationGroupResult): any => ({ ...obj, }); @@ -8617,6 +9226,9 @@ export interface IncreaseReplicaCountMessage { } export namespace IncreaseReplicaCountMessage { + /** + * @internal + */ export const filterSensitiveLog = (obj: IncreaseReplicaCountMessage): any => ({ ...obj, }); @@ -8630,6 +9242,9 @@ export interface IncreaseReplicaCountResult { } export namespace IncreaseReplicaCountResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: IncreaseReplicaCountResult): any => ({ ...obj, }); @@ -8645,6 +9260,9 @@ export interface InvalidKMSKeyFault extends __SmithyException, $MetadataBearer { } export namespace InvalidKMSKeyFault { + /** + * @internal + */ export const filterSensitiveLog = (obj: InvalidKMSKeyFault): any => ({ ...obj, }); @@ -8679,6 +9297,9 @@ export interface ListAllowedNodeTypeModificationsMessage { } export namespace ListAllowedNodeTypeModificationsMessage { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListAllowedNodeTypeModificationsMessage): any => ({ ...obj, }); @@ -8698,6 +9319,9 @@ export interface ListTagsForResourceMessage { } export namespace ListTagsForResourceMessage { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListTagsForResourceMessage): any => ({ ...obj, }); @@ -9063,6 +9687,9 @@ export interface ModifyCacheClusterMessage { } export namespace ModifyCacheClusterMessage { + /** + * @internal + */ export const filterSensitiveLog = (obj: ModifyCacheClusterMessage): any => ({ ...obj, }); @@ -9076,6 +9703,9 @@ export interface ModifyCacheClusterResult { } export namespace ModifyCacheClusterResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: ModifyCacheClusterResult): any => ({ ...obj, }); @@ -9104,6 +9734,9 @@ export interface CacheParameterGroupNameMessage { } export namespace CacheParameterGroupNameMessage { + /** + * @internal + */ export const filterSensitiveLog = (obj: CacheParameterGroupNameMessage): any => ({ ...obj, }); @@ -9125,6 +9758,9 @@ export interface ParameterNameValue { } export namespace ParameterNameValue { + /** + * @internal + */ export const filterSensitiveLog = (obj: ParameterNameValue): any => ({ ...obj, }); @@ -9146,6 +9782,9 @@ export interface ModifyCacheParameterGroupMessage { } export namespace ModifyCacheParameterGroupMessage { + /** + * @internal + */ export const filterSensitiveLog = (obj: ModifyCacheParameterGroupMessage): any => ({ ...obj, }); @@ -9175,6 +9814,9 @@ export interface ModifyCacheSubnetGroupMessage { } export namespace ModifyCacheSubnetGroupMessage { + /** + * @internal + */ export const filterSensitiveLog = (obj: ModifyCacheSubnetGroupMessage): any => ({ ...obj, }); @@ -9200,6 +9842,9 @@ export interface ModifyCacheSubnetGroupResult { } export namespace ModifyCacheSubnetGroupResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: ModifyCacheSubnetGroupResult): any => ({ ...obj, }); @@ -9215,6 +9860,9 @@ export interface SubnetInUse extends __SmithyException, $MetadataBearer { } export namespace SubnetInUse { + /** + * @internal + */ export const filterSensitiveLog = (obj: SubnetInUse): any => ({ ...obj, }); @@ -9260,6 +9908,9 @@ export interface ModifyGlobalReplicationGroupMessage { } export namespace ModifyGlobalReplicationGroupMessage { + /** + * @internal + */ export const filterSensitiveLog = (obj: ModifyGlobalReplicationGroupMessage): any => ({ ...obj, }); @@ -9282,6 +9933,9 @@ export interface ModifyGlobalReplicationGroupResult { } export namespace ModifyGlobalReplicationGroupResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: ModifyGlobalReplicationGroupResult): any => ({ ...obj, }); @@ -9530,6 +10184,9 @@ export interface ModifyReplicationGroupMessage { } export namespace ModifyReplicationGroupMessage { + /** + * @internal + */ export const filterSensitiveLog = (obj: ModifyReplicationGroupMessage): any => ({ ...obj, }); @@ -9543,6 +10200,9 @@ export interface ModifyReplicationGroupResult { } export namespace ModifyReplicationGroupResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: ModifyReplicationGroupResult): any => ({ ...obj, }); @@ -9606,6 +10266,9 @@ export interface ModifyReplicationGroupShardConfigurationMessage { } export namespace ModifyReplicationGroupShardConfigurationMessage { + /** + * @internal + */ export const filterSensitiveLog = (obj: ModifyReplicationGroupShardConfigurationMessage): any => ({ ...obj, }); @@ -9619,6 +10282,9 @@ export interface ModifyReplicationGroupShardConfigurationResult { } export namespace ModifyReplicationGroupShardConfigurationResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: ModifyReplicationGroupShardConfigurationResult): any => ({ ...obj, }); @@ -9652,6 +10318,9 @@ export interface ModifyUserMessage { } export namespace ModifyUserMessage { + /** + * @internal + */ export const filterSensitiveLog = (obj: ModifyUserMessage): any => ({ ...obj, }); @@ -9675,6 +10344,9 @@ export interface ModifyUserGroupMessage { } export namespace ModifyUserGroupMessage { + /** + * @internal + */ export const filterSensitiveLog = (obj: ModifyUserGroupMessage): any => ({ ...obj, }); @@ -9716,6 +10388,9 @@ export interface PurchaseReservedCacheNodesOfferingMessage { } export namespace PurchaseReservedCacheNodesOfferingMessage { + /** + * @internal + */ export const filterSensitiveLog = (obj: PurchaseReservedCacheNodesOfferingMessage): any => ({ ...obj, }); @@ -9729,6 +10404,9 @@ export interface PurchaseReservedCacheNodesOfferingResult { } export namespace PurchaseReservedCacheNodesOfferingResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: PurchaseReservedCacheNodesOfferingResult): any => ({ ...obj, }); @@ -9744,6 +10422,9 @@ export interface ReservedCacheNodeAlreadyExistsFault extends __SmithyException, } export namespace ReservedCacheNodeAlreadyExistsFault { + /** + * @internal + */ export const filterSensitiveLog = (obj: ReservedCacheNodeAlreadyExistsFault): any => ({ ...obj, }); @@ -9759,6 +10440,9 @@ export interface ReservedCacheNodeQuotaExceededFault extends __SmithyException, } export namespace ReservedCacheNodeQuotaExceededFault { + /** + * @internal + */ export const filterSensitiveLog = (obj: ReservedCacheNodeQuotaExceededFault): any => ({ ...obj, }); @@ -9777,6 +10461,9 @@ export interface RebalanceSlotsInGlobalReplicationGroupMessage { } export namespace RebalanceSlotsInGlobalReplicationGroupMessage { + /** + * @internal + */ export const filterSensitiveLog = (obj: RebalanceSlotsInGlobalReplicationGroupMessage): any => ({ ...obj, }); @@ -9799,6 +10486,9 @@ export interface RebalanceSlotsInGlobalReplicationGroupResult { } export namespace RebalanceSlotsInGlobalReplicationGroupResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: RebalanceSlotsInGlobalReplicationGroupResult): any => ({ ...obj, }); @@ -9820,6 +10510,9 @@ export interface RebootCacheClusterMessage { } export namespace RebootCacheClusterMessage { + /** + * @internal + */ export const filterSensitiveLog = (obj: RebootCacheClusterMessage): any => ({ ...obj, }); @@ -9833,6 +10526,9 @@ export interface RebootCacheClusterResult { } export namespace RebootCacheClusterResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: RebootCacheClusterResult): any => ({ ...obj, }); @@ -9857,6 +10553,9 @@ export interface RemoveTagsFromResourceMessage { } export namespace RemoveTagsFromResourceMessage { + /** + * @internal + */ export const filterSensitiveLog = (obj: RemoveTagsFromResourceMessage): any => ({ ...obj, }); @@ -9872,6 +10571,9 @@ export interface TagNotFoundFault extends __SmithyException, $MetadataBearer { } export namespace TagNotFoundFault { + /** + * @internal + */ export const filterSensitiveLog = (obj: TagNotFoundFault): any => ({ ...obj, }); @@ -9907,6 +10609,9 @@ export interface ResetCacheParameterGroupMessage { } export namespace ResetCacheParameterGroupMessage { + /** + * @internal + */ export const filterSensitiveLog = (obj: ResetCacheParameterGroupMessage): any => ({ ...obj, }); @@ -9922,6 +10627,9 @@ export interface AuthorizationNotFoundFault extends __SmithyException, $Metadata } export namespace AuthorizationNotFoundFault { + /** + * @internal + */ export const filterSensitiveLog = (obj: AuthorizationNotFoundFault): any => ({ ...obj, }); @@ -9950,6 +10658,9 @@ export interface RevokeCacheSecurityGroupIngressMessage { } export namespace RevokeCacheSecurityGroupIngressMessage { + /** + * @internal + */ export const filterSensitiveLog = (obj: RevokeCacheSecurityGroupIngressMessage): any => ({ ...obj, }); @@ -9980,6 +10691,9 @@ export interface RevokeCacheSecurityGroupIngressResult { } export namespace RevokeCacheSecurityGroupIngressResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: RevokeCacheSecurityGroupIngressResult): any => ({ ...obj, }); @@ -9995,6 +10709,9 @@ export interface ReplicationGroupAlreadyUnderMigrationFault extends __SmithyExce } export namespace ReplicationGroupAlreadyUnderMigrationFault { + /** + * @internal + */ export const filterSensitiveLog = (obj: ReplicationGroupAlreadyUnderMigrationFault): any => ({ ...obj, }); @@ -10016,6 +10733,9 @@ export interface CustomerNodeEndpoint { } export namespace CustomerNodeEndpoint { + /** + * @internal + */ export const filterSensitiveLog = (obj: CustomerNodeEndpoint): any => ({ ...obj, }); @@ -10034,6 +10754,9 @@ export interface StartMigrationMessage { } export namespace StartMigrationMessage { + /** + * @internal + */ export const filterSensitiveLog = (obj: StartMigrationMessage): any => ({ ...obj, }); @@ -10047,6 +10770,9 @@ export interface StartMigrationResponse { } export namespace StartMigrationResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: StartMigrationResponse): any => ({ ...obj, }); @@ -10062,6 +10788,9 @@ export interface APICallRateForCustomerExceededFault extends __SmithyException, } export namespace APICallRateForCustomerExceededFault { + /** + * @internal + */ export const filterSensitiveLog = (obj: APICallRateForCustomerExceededFault): any => ({ ...obj, }); @@ -10078,6 +10807,9 @@ export interface NodeGroupNotFoundFault extends __SmithyException, $MetadataBear } export namespace NodeGroupNotFoundFault { + /** + * @internal + */ export const filterSensitiveLog = (obj: NodeGroupNotFoundFault): any => ({ ...obj, }); @@ -10099,6 +10831,9 @@ export interface TestFailoverMessage { } export namespace TestFailoverMessage { + /** + * @internal + */ export const filterSensitiveLog = (obj: TestFailoverMessage): any => ({ ...obj, }); @@ -10114,6 +10849,9 @@ export interface TestFailoverNotAvailableFault extends __SmithyException, $Metad } export namespace TestFailoverNotAvailableFault { + /** + * @internal + */ export const filterSensitiveLog = (obj: TestFailoverNotAvailableFault): any => ({ ...obj, }); @@ -10127,6 +10865,9 @@ export interface TestFailoverResult { } export namespace TestFailoverResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: TestFailoverResult): any => ({ ...obj, }); diff --git a/clients/client-elasticsearch-service/commands/AcceptInboundCrossClusterSearchConnectionCommand.ts b/clients/client-elasticsearch-service/commands/AcceptInboundCrossClusterSearchConnectionCommand.ts index f5c19610aa97..e36fa349370e 100644 --- a/clients/client-elasticsearch-service/commands/AcceptInboundCrossClusterSearchConnectionCommand.ts +++ b/clients/client-elasticsearch-service/commands/AcceptInboundCrossClusterSearchConnectionCommand.ts @@ -32,6 +32,20 @@ export interface AcceptInboundCrossClusterSearchConnectionCommandOutput /** *

Allows the destination domain owner to accept an inbound cross-cluster search connection request.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ElasticsearchServiceClient, AcceptInboundCrossClusterSearchConnectionCommand } from "@aws-sdk/client-elasticsearch-service"; // ES Modules import + * // const { ElasticsearchServiceClient, AcceptInboundCrossClusterSearchConnectionCommand } = require("@aws-sdk/client-elasticsearch-service"); // CommonJS import + * const client = new ElasticsearchServiceClient(config); + * const command = new AcceptInboundCrossClusterSearchConnectionCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link AcceptInboundCrossClusterSearchConnectionCommandInput} for command's `input` shape. + * @see {@link AcceptInboundCrossClusterSearchConnectionCommandOutput} for command's `response` shape. + * @see {@link ElasticsearchServiceClientResolvedConfig | config} for command's `input` shape. + * */ export class AcceptInboundCrossClusterSearchConnectionCommand extends $Command< AcceptInboundCrossClusterSearchConnectionCommandInput, diff --git a/clients/client-elasticsearch-service/commands/AddTagsCommand.ts b/clients/client-elasticsearch-service/commands/AddTagsCommand.ts index 6a159f84c49f..1a68d4385084 100644 --- a/clients/client-elasticsearch-service/commands/AddTagsCommand.ts +++ b/clients/client-elasticsearch-service/commands/AddTagsCommand.ts @@ -27,6 +27,20 @@ export interface AddTagsCommandOutput extends __MetadataBearer {} /** *

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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ElasticsearchServiceClient, AddTagsCommand } from "@aws-sdk/client-elasticsearch-service"; // ES Modules import + * // const { ElasticsearchServiceClient, AddTagsCommand } = require("@aws-sdk/client-elasticsearch-service"); // CommonJS import + * const client = new ElasticsearchServiceClient(config); + * const command = new AddTagsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link AddTagsCommandInput} for command's `input` shape. + * @see {@link AddTagsCommandOutput} for command's `response` shape. + * @see {@link ElasticsearchServiceClientResolvedConfig | config} for command's `input` shape. + * */ export class AddTagsCommand extends $Command< AddTagsCommandInput, diff --git a/clients/client-elasticsearch-service/commands/AssociatePackageCommand.ts b/clients/client-elasticsearch-service/commands/AssociatePackageCommand.ts index ebe8d8178a80..0bcf87b9c37c 100644 --- a/clients/client-elasticsearch-service/commands/AssociatePackageCommand.ts +++ b/clients/client-elasticsearch-service/commands/AssociatePackageCommand.ts @@ -26,6 +26,20 @@ export interface AssociatePackageCommandOutput extends AssociatePackageResponse, /** *

Associates a package with an Amazon ES domain.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ElasticsearchServiceClient, AssociatePackageCommand } from "@aws-sdk/client-elasticsearch-service"; // ES Modules import + * // const { ElasticsearchServiceClient, AssociatePackageCommand } = require("@aws-sdk/client-elasticsearch-service"); // CommonJS import + * const client = new ElasticsearchServiceClient(config); + * const command = new AssociatePackageCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link AssociatePackageCommandInput} for command's `input` shape. + * @see {@link AssociatePackageCommandOutput} for command's `response` shape. + * @see {@link ElasticsearchServiceClientResolvedConfig | config} for command's `input` shape. + * */ export class AssociatePackageCommand extends $Command< AssociatePackageCommandInput, diff --git a/clients/client-elasticsearch-service/commands/CancelElasticsearchServiceSoftwareUpdateCommand.ts b/clients/client-elasticsearch-service/commands/CancelElasticsearchServiceSoftwareUpdateCommand.ts index 3c603e744d7e..78cdbfdd138e 100644 --- a/clients/client-elasticsearch-service/commands/CancelElasticsearchServiceSoftwareUpdateCommand.ts +++ b/clients/client-elasticsearch-service/commands/CancelElasticsearchServiceSoftwareUpdateCommand.ts @@ -32,6 +32,20 @@ export interface CancelElasticsearchServiceSoftwareUpdateCommandOutput /** *

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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ElasticsearchServiceClient, CancelElasticsearchServiceSoftwareUpdateCommand } from "@aws-sdk/client-elasticsearch-service"; // ES Modules import + * // const { ElasticsearchServiceClient, CancelElasticsearchServiceSoftwareUpdateCommand } = require("@aws-sdk/client-elasticsearch-service"); // CommonJS import + * const client = new ElasticsearchServiceClient(config); + * const command = new CancelElasticsearchServiceSoftwareUpdateCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CancelElasticsearchServiceSoftwareUpdateCommandInput} for command's `input` shape. + * @see {@link CancelElasticsearchServiceSoftwareUpdateCommandOutput} for command's `response` shape. + * @see {@link ElasticsearchServiceClientResolvedConfig | config} for command's `input` shape. + * */ export class CancelElasticsearchServiceSoftwareUpdateCommand extends $Command< CancelElasticsearchServiceSoftwareUpdateCommandInput, diff --git a/clients/client-elasticsearch-service/commands/CreateElasticsearchDomainCommand.ts b/clients/client-elasticsearch-service/commands/CreateElasticsearchDomainCommand.ts index a898256b9933..a65d638acf01 100644 --- a/clients/client-elasticsearch-service/commands/CreateElasticsearchDomainCommand.ts +++ b/clients/client-elasticsearch-service/commands/CreateElasticsearchDomainCommand.ts @@ -27,6 +27,20 @@ export interface CreateElasticsearchDomainCommandOutput extends CreateElasticsea /** *

Creates a new Elasticsearch domain. For more information, * see Creating Elasticsearch Domains in the Amazon Elasticsearch Service Developer Guide.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ElasticsearchServiceClient, CreateElasticsearchDomainCommand } from "@aws-sdk/client-elasticsearch-service"; // ES Modules import + * // const { ElasticsearchServiceClient, CreateElasticsearchDomainCommand } = require("@aws-sdk/client-elasticsearch-service"); // CommonJS import + * const client = new ElasticsearchServiceClient(config); + * const command = new CreateElasticsearchDomainCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreateElasticsearchDomainCommandInput} for command's `input` shape. + * @see {@link CreateElasticsearchDomainCommandOutput} for command's `response` shape. + * @see {@link ElasticsearchServiceClientResolvedConfig | config} for command's `input` shape. + * */ export class CreateElasticsearchDomainCommand extends $Command< CreateElasticsearchDomainCommandInput, diff --git a/clients/client-elasticsearch-service/commands/CreateOutboundCrossClusterSearchConnectionCommand.ts b/clients/client-elasticsearch-service/commands/CreateOutboundCrossClusterSearchConnectionCommand.ts index 8aa130aaa18a..0229e6c74b11 100644 --- a/clients/client-elasticsearch-service/commands/CreateOutboundCrossClusterSearchConnectionCommand.ts +++ b/clients/client-elasticsearch-service/commands/CreateOutboundCrossClusterSearchConnectionCommand.ts @@ -32,6 +32,20 @@ export interface CreateOutboundCrossClusterSearchConnectionCommandOutput /** *

Creates a new cross-cluster search connection from a source domain to a destination domain.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ElasticsearchServiceClient, CreateOutboundCrossClusterSearchConnectionCommand } from "@aws-sdk/client-elasticsearch-service"; // ES Modules import + * // const { ElasticsearchServiceClient, CreateOutboundCrossClusterSearchConnectionCommand } = require("@aws-sdk/client-elasticsearch-service"); // CommonJS import + * const client = new ElasticsearchServiceClient(config); + * const command = new CreateOutboundCrossClusterSearchConnectionCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreateOutboundCrossClusterSearchConnectionCommandInput} for command's `input` shape. + * @see {@link CreateOutboundCrossClusterSearchConnectionCommandOutput} for command's `response` shape. + * @see {@link ElasticsearchServiceClientResolvedConfig | config} for command's `input` shape. + * */ export class CreateOutboundCrossClusterSearchConnectionCommand extends $Command< CreateOutboundCrossClusterSearchConnectionCommandInput, diff --git a/clients/client-elasticsearch-service/commands/CreatePackageCommand.ts b/clients/client-elasticsearch-service/commands/CreatePackageCommand.ts index 04c0bba83e46..d140255f4997 100644 --- a/clients/client-elasticsearch-service/commands/CreatePackageCommand.ts +++ b/clients/client-elasticsearch-service/commands/CreatePackageCommand.ts @@ -26,6 +26,20 @@ export interface CreatePackageCommandOutput extends CreatePackageResponse, __Met /** *

Create a package for use with Amazon ES domains.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ElasticsearchServiceClient, CreatePackageCommand } from "@aws-sdk/client-elasticsearch-service"; // ES Modules import + * // const { ElasticsearchServiceClient, CreatePackageCommand } = require("@aws-sdk/client-elasticsearch-service"); // CommonJS import + * const client = new ElasticsearchServiceClient(config); + * const command = new CreatePackageCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreatePackageCommandInput} for command's `input` shape. + * @see {@link CreatePackageCommandOutput} for command's `response` shape. + * @see {@link ElasticsearchServiceClientResolvedConfig | config} for command's `input` shape. + * */ export class CreatePackageCommand extends $Command< CreatePackageCommandInput, diff --git a/clients/client-elasticsearch-service/commands/DeleteElasticsearchDomainCommand.ts b/clients/client-elasticsearch-service/commands/DeleteElasticsearchDomainCommand.ts index 345178b7a707..f0b2c27e804b 100644 --- a/clients/client-elasticsearch-service/commands/DeleteElasticsearchDomainCommand.ts +++ b/clients/client-elasticsearch-service/commands/DeleteElasticsearchDomainCommand.ts @@ -26,6 +26,20 @@ export interface DeleteElasticsearchDomainCommandOutput extends DeleteElasticsea /** *

Permanently deletes the specified Elasticsearch domain and all of its data. Once a domain is deleted, it cannot be recovered.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ElasticsearchServiceClient, DeleteElasticsearchDomainCommand } from "@aws-sdk/client-elasticsearch-service"; // ES Modules import + * // const { ElasticsearchServiceClient, DeleteElasticsearchDomainCommand } = require("@aws-sdk/client-elasticsearch-service"); // CommonJS import + * const client = new ElasticsearchServiceClient(config); + * const command = new DeleteElasticsearchDomainCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteElasticsearchDomainCommandInput} for command's `input` shape. + * @see {@link DeleteElasticsearchDomainCommandOutput} for command's `response` shape. + * @see {@link ElasticsearchServiceClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteElasticsearchDomainCommand extends $Command< DeleteElasticsearchDomainCommandInput, diff --git a/clients/client-elasticsearch-service/commands/DeleteElasticsearchServiceRoleCommand.ts b/clients/client-elasticsearch-service/commands/DeleteElasticsearchServiceRoleCommand.ts index 472c3d4d3fba..c022ef32e9d2 100644 --- a/clients/client-elasticsearch-service/commands/DeleteElasticsearchServiceRoleCommand.ts +++ b/clients/client-elasticsearch-service/commands/DeleteElasticsearchServiceRoleCommand.ts @@ -25,6 +25,20 @@ export interface DeleteElasticsearchServiceRoleCommandOutput extends __MetadataB /** *

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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ElasticsearchServiceClient, DeleteElasticsearchServiceRoleCommand } from "@aws-sdk/client-elasticsearch-service"; // ES Modules import + * // const { ElasticsearchServiceClient, DeleteElasticsearchServiceRoleCommand } = require("@aws-sdk/client-elasticsearch-service"); // CommonJS import + * const client = new ElasticsearchServiceClient(config); + * const command = new DeleteElasticsearchServiceRoleCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteElasticsearchServiceRoleCommandInput} for command's `input` shape. + * @see {@link DeleteElasticsearchServiceRoleCommandOutput} for command's `response` shape. + * @see {@link ElasticsearchServiceClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteElasticsearchServiceRoleCommand extends $Command< DeleteElasticsearchServiceRoleCommandInput, diff --git a/clients/client-elasticsearch-service/commands/DeleteInboundCrossClusterSearchConnectionCommand.ts b/clients/client-elasticsearch-service/commands/DeleteInboundCrossClusterSearchConnectionCommand.ts index a0ed0d9320fb..7f6e2c2f36e2 100644 --- a/clients/client-elasticsearch-service/commands/DeleteInboundCrossClusterSearchConnectionCommand.ts +++ b/clients/client-elasticsearch-service/commands/DeleteInboundCrossClusterSearchConnectionCommand.ts @@ -32,6 +32,20 @@ export interface DeleteInboundCrossClusterSearchConnectionCommandOutput /** *

Allows the destination domain owner to delete an existing inbound cross-cluster search connection.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ElasticsearchServiceClient, DeleteInboundCrossClusterSearchConnectionCommand } from "@aws-sdk/client-elasticsearch-service"; // ES Modules import + * // const { ElasticsearchServiceClient, DeleteInboundCrossClusterSearchConnectionCommand } = require("@aws-sdk/client-elasticsearch-service"); // CommonJS import + * const client = new ElasticsearchServiceClient(config); + * const command = new DeleteInboundCrossClusterSearchConnectionCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteInboundCrossClusterSearchConnectionCommandInput} for command's `input` shape. + * @see {@link DeleteInboundCrossClusterSearchConnectionCommandOutput} for command's `response` shape. + * @see {@link ElasticsearchServiceClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteInboundCrossClusterSearchConnectionCommand extends $Command< DeleteInboundCrossClusterSearchConnectionCommandInput, diff --git a/clients/client-elasticsearch-service/commands/DeleteOutboundCrossClusterSearchConnectionCommand.ts b/clients/client-elasticsearch-service/commands/DeleteOutboundCrossClusterSearchConnectionCommand.ts index a15ab4325492..adc3d6234d3d 100644 --- a/clients/client-elasticsearch-service/commands/DeleteOutboundCrossClusterSearchConnectionCommand.ts +++ b/clients/client-elasticsearch-service/commands/DeleteOutboundCrossClusterSearchConnectionCommand.ts @@ -32,6 +32,20 @@ export interface DeleteOutboundCrossClusterSearchConnectionCommandOutput /** *

Allows the source domain owner to delete an existing outbound cross-cluster search connection.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ElasticsearchServiceClient, DeleteOutboundCrossClusterSearchConnectionCommand } from "@aws-sdk/client-elasticsearch-service"; // ES Modules import + * // const { ElasticsearchServiceClient, DeleteOutboundCrossClusterSearchConnectionCommand } = require("@aws-sdk/client-elasticsearch-service"); // CommonJS import + * const client = new ElasticsearchServiceClient(config); + * const command = new DeleteOutboundCrossClusterSearchConnectionCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteOutboundCrossClusterSearchConnectionCommandInput} for command's `input` shape. + * @see {@link DeleteOutboundCrossClusterSearchConnectionCommandOutput} for command's `response` shape. + * @see {@link ElasticsearchServiceClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteOutboundCrossClusterSearchConnectionCommand extends $Command< DeleteOutboundCrossClusterSearchConnectionCommandInput, diff --git a/clients/client-elasticsearch-service/commands/DeletePackageCommand.ts b/clients/client-elasticsearch-service/commands/DeletePackageCommand.ts index 6d1f1d524680..980c682cb440 100644 --- a/clients/client-elasticsearch-service/commands/DeletePackageCommand.ts +++ b/clients/client-elasticsearch-service/commands/DeletePackageCommand.ts @@ -26,6 +26,20 @@ export interface DeletePackageCommandOutput extends DeletePackageResponse, __Met /** *

Delete the package.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ElasticsearchServiceClient, DeletePackageCommand } from "@aws-sdk/client-elasticsearch-service"; // ES Modules import + * // const { ElasticsearchServiceClient, DeletePackageCommand } = require("@aws-sdk/client-elasticsearch-service"); // CommonJS import + * const client = new ElasticsearchServiceClient(config); + * const command = new DeletePackageCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeletePackageCommandInput} for command's `input` shape. + * @see {@link DeletePackageCommandOutput} for command's `response` shape. + * @see {@link ElasticsearchServiceClientResolvedConfig | config} for command's `input` shape. + * */ export class DeletePackageCommand extends $Command< DeletePackageCommandInput, diff --git a/clients/client-elasticsearch-service/commands/DescribeDomainAutoTunesCommand.ts b/clients/client-elasticsearch-service/commands/DescribeDomainAutoTunesCommand.ts index ed7b08be1e15..093716123661 100644 --- a/clients/client-elasticsearch-service/commands/DescribeDomainAutoTunesCommand.ts +++ b/clients/client-elasticsearch-service/commands/DescribeDomainAutoTunesCommand.ts @@ -26,6 +26,20 @@ export interface DescribeDomainAutoTunesCommandOutput extends DescribeDomainAuto /** *

Provides scheduled Auto-Tune action details for the Elasticsearch domain, such as Auto-Tune action type, description, severity, and scheduled date.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ElasticsearchServiceClient, DescribeDomainAutoTunesCommand } from "@aws-sdk/client-elasticsearch-service"; // ES Modules import + * // const { ElasticsearchServiceClient, DescribeDomainAutoTunesCommand } = require("@aws-sdk/client-elasticsearch-service"); // CommonJS import + * const client = new ElasticsearchServiceClient(config); + * const command = new DescribeDomainAutoTunesCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeDomainAutoTunesCommandInput} for command's `input` shape. + * @see {@link DescribeDomainAutoTunesCommandOutput} for command's `response` shape. + * @see {@link ElasticsearchServiceClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeDomainAutoTunesCommand extends $Command< DescribeDomainAutoTunesCommandInput, diff --git a/clients/client-elasticsearch-service/commands/DescribeElasticsearchDomainCommand.ts b/clients/client-elasticsearch-service/commands/DescribeElasticsearchDomainCommand.ts index bda10d1ccc35..7c0c5dbadf8d 100644 --- a/clients/client-elasticsearch-service/commands/DescribeElasticsearchDomainCommand.ts +++ b/clients/client-elasticsearch-service/commands/DescribeElasticsearchDomainCommand.ts @@ -28,6 +28,20 @@ export interface DescribeElasticsearchDomainCommandOutput /** *

Returns domain configuration information about the specified Elasticsearch domain, including the domain ID, domain endpoint, and domain ARN.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ElasticsearchServiceClient, DescribeElasticsearchDomainCommand } from "@aws-sdk/client-elasticsearch-service"; // ES Modules import + * // const { ElasticsearchServiceClient, DescribeElasticsearchDomainCommand } = require("@aws-sdk/client-elasticsearch-service"); // CommonJS import + * const client = new ElasticsearchServiceClient(config); + * const command = new DescribeElasticsearchDomainCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeElasticsearchDomainCommandInput} for command's `input` shape. + * @see {@link DescribeElasticsearchDomainCommandOutput} for command's `response` shape. + * @see {@link ElasticsearchServiceClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeElasticsearchDomainCommand extends $Command< DescribeElasticsearchDomainCommandInput, diff --git a/clients/client-elasticsearch-service/commands/DescribeElasticsearchDomainConfigCommand.ts b/clients/client-elasticsearch-service/commands/DescribeElasticsearchDomainConfigCommand.ts index 5a11127bc818..90789e300a51 100644 --- a/clients/client-elasticsearch-service/commands/DescribeElasticsearchDomainConfigCommand.ts +++ b/clients/client-elasticsearch-service/commands/DescribeElasticsearchDomainConfigCommand.ts @@ -31,6 +31,20 @@ export interface DescribeElasticsearchDomainConfigCommandOutput /** *

Provides cluster configuration information about the specified Elasticsearch domain, such as the state, creation date, update version, and update date for cluster options.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ElasticsearchServiceClient, DescribeElasticsearchDomainConfigCommand } from "@aws-sdk/client-elasticsearch-service"; // ES Modules import + * // const { ElasticsearchServiceClient, DescribeElasticsearchDomainConfigCommand } = require("@aws-sdk/client-elasticsearch-service"); // CommonJS import + * const client = new ElasticsearchServiceClient(config); + * const command = new DescribeElasticsearchDomainConfigCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeElasticsearchDomainConfigCommandInput} for command's `input` shape. + * @see {@link DescribeElasticsearchDomainConfigCommandOutput} for command's `response` shape. + * @see {@link ElasticsearchServiceClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeElasticsearchDomainConfigCommand extends $Command< DescribeElasticsearchDomainConfigCommandInput, diff --git a/clients/client-elasticsearch-service/commands/DescribeElasticsearchDomainsCommand.ts b/clients/client-elasticsearch-service/commands/DescribeElasticsearchDomainsCommand.ts index 6f6b5d6164bf..f675ae8ca64e 100644 --- a/clients/client-elasticsearch-service/commands/DescribeElasticsearchDomainsCommand.ts +++ b/clients/client-elasticsearch-service/commands/DescribeElasticsearchDomainsCommand.ts @@ -28,6 +28,20 @@ export interface DescribeElasticsearchDomainsCommandOutput /** *

Returns domain configuration information about the specified Elasticsearch domains, including the domain ID, domain endpoint, and domain ARN.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ElasticsearchServiceClient, DescribeElasticsearchDomainsCommand } from "@aws-sdk/client-elasticsearch-service"; // ES Modules import + * // const { ElasticsearchServiceClient, DescribeElasticsearchDomainsCommand } = require("@aws-sdk/client-elasticsearch-service"); // CommonJS import + * const client = new ElasticsearchServiceClient(config); + * const command = new DescribeElasticsearchDomainsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeElasticsearchDomainsCommandInput} for command's `input` shape. + * @see {@link DescribeElasticsearchDomainsCommandOutput} for command's `response` shape. + * @see {@link ElasticsearchServiceClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeElasticsearchDomainsCommand extends $Command< DescribeElasticsearchDomainsCommandInput, diff --git a/clients/client-elasticsearch-service/commands/DescribeElasticsearchInstanceTypeLimitsCommand.ts b/clients/client-elasticsearch-service/commands/DescribeElasticsearchInstanceTypeLimitsCommand.ts index 79de0d97afcd..aacf9b5a2fa9 100644 --- a/clients/client-elasticsearch-service/commands/DescribeElasticsearchInstanceTypeLimitsCommand.ts +++ b/clients/client-elasticsearch-service/commands/DescribeElasticsearchInstanceTypeLimitsCommand.ts @@ -39,6 +39,20 @@ export interface DescribeElasticsearchInstanceTypeLimitsCommandOutput * * to know what Limits are supported for modifying. *

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ElasticsearchServiceClient, DescribeElasticsearchInstanceTypeLimitsCommand } from "@aws-sdk/client-elasticsearch-service"; // ES Modules import + * // const { ElasticsearchServiceClient, DescribeElasticsearchInstanceTypeLimitsCommand } = require("@aws-sdk/client-elasticsearch-service"); // CommonJS import + * const client = new ElasticsearchServiceClient(config); + * const command = new DescribeElasticsearchInstanceTypeLimitsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeElasticsearchInstanceTypeLimitsCommandInput} for command's `input` shape. + * @see {@link DescribeElasticsearchInstanceTypeLimitsCommandOutput} for command's `response` shape. + * @see {@link ElasticsearchServiceClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeElasticsearchInstanceTypeLimitsCommand extends $Command< DescribeElasticsearchInstanceTypeLimitsCommandInput, diff --git a/clients/client-elasticsearch-service/commands/DescribeInboundCrossClusterSearchConnectionsCommand.ts b/clients/client-elasticsearch-service/commands/DescribeInboundCrossClusterSearchConnectionsCommand.ts index 453f8b793cd8..f781140b8106 100644 --- a/clients/client-elasticsearch-service/commands/DescribeInboundCrossClusterSearchConnectionsCommand.ts +++ b/clients/client-elasticsearch-service/commands/DescribeInboundCrossClusterSearchConnectionsCommand.ts @@ -32,6 +32,20 @@ export interface DescribeInboundCrossClusterSearchConnectionsCommandOutput /** *

Lists all the inbound cross-cluster search connections for a destination domain.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ElasticsearchServiceClient, DescribeInboundCrossClusterSearchConnectionsCommand } from "@aws-sdk/client-elasticsearch-service"; // ES Modules import + * // const { ElasticsearchServiceClient, DescribeInboundCrossClusterSearchConnectionsCommand } = require("@aws-sdk/client-elasticsearch-service"); // CommonJS import + * const client = new ElasticsearchServiceClient(config); + * const command = new DescribeInboundCrossClusterSearchConnectionsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeInboundCrossClusterSearchConnectionsCommandInput} for command's `input` shape. + * @see {@link DescribeInboundCrossClusterSearchConnectionsCommandOutput} for command's `response` shape. + * @see {@link ElasticsearchServiceClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeInboundCrossClusterSearchConnectionsCommand extends $Command< DescribeInboundCrossClusterSearchConnectionsCommandInput, diff --git a/clients/client-elasticsearch-service/commands/DescribeOutboundCrossClusterSearchConnectionsCommand.ts b/clients/client-elasticsearch-service/commands/DescribeOutboundCrossClusterSearchConnectionsCommand.ts index 3afdec028cca..dbf4663a991e 100644 --- a/clients/client-elasticsearch-service/commands/DescribeOutboundCrossClusterSearchConnectionsCommand.ts +++ b/clients/client-elasticsearch-service/commands/DescribeOutboundCrossClusterSearchConnectionsCommand.ts @@ -32,6 +32,20 @@ export interface DescribeOutboundCrossClusterSearchConnectionsCommandOutput /** *

Lists all the outbound cross-cluster search connections for a source domain.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ElasticsearchServiceClient, DescribeOutboundCrossClusterSearchConnectionsCommand } from "@aws-sdk/client-elasticsearch-service"; // ES Modules import + * // const { ElasticsearchServiceClient, DescribeOutboundCrossClusterSearchConnectionsCommand } = require("@aws-sdk/client-elasticsearch-service"); // CommonJS import + * const client = new ElasticsearchServiceClient(config); + * const command = new DescribeOutboundCrossClusterSearchConnectionsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeOutboundCrossClusterSearchConnectionsCommandInput} for command's `input` shape. + * @see {@link DescribeOutboundCrossClusterSearchConnectionsCommandOutput} for command's `response` shape. + * @see {@link ElasticsearchServiceClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeOutboundCrossClusterSearchConnectionsCommand extends $Command< DescribeOutboundCrossClusterSearchConnectionsCommandInput, diff --git a/clients/client-elasticsearch-service/commands/DescribePackagesCommand.ts b/clients/client-elasticsearch-service/commands/DescribePackagesCommand.ts index 9e898b64c2a3..85f81fea321d 100644 --- a/clients/client-elasticsearch-service/commands/DescribePackagesCommand.ts +++ b/clients/client-elasticsearch-service/commands/DescribePackagesCommand.ts @@ -26,6 +26,20 @@ export interface DescribePackagesCommandOutput extends DescribePackagesResponse, /** *

Describes all packages available to Amazon ES. Includes options for filtering, limiting the number of results, and pagination.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ElasticsearchServiceClient, DescribePackagesCommand } from "@aws-sdk/client-elasticsearch-service"; // ES Modules import + * // const { ElasticsearchServiceClient, DescribePackagesCommand } = require("@aws-sdk/client-elasticsearch-service"); // CommonJS import + * const client = new ElasticsearchServiceClient(config); + * const command = new DescribePackagesCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribePackagesCommandInput} for command's `input` shape. + * @see {@link DescribePackagesCommandOutput} for command's `response` shape. + * @see {@link ElasticsearchServiceClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribePackagesCommand extends $Command< DescribePackagesCommandInput, diff --git a/clients/client-elasticsearch-service/commands/DescribeReservedElasticsearchInstanceOfferingsCommand.ts b/clients/client-elasticsearch-service/commands/DescribeReservedElasticsearchInstanceOfferingsCommand.ts index de47c5da48be..4a53e26d5c2d 100644 --- a/clients/client-elasticsearch-service/commands/DescribeReservedElasticsearchInstanceOfferingsCommand.ts +++ b/clients/client-elasticsearch-service/commands/DescribeReservedElasticsearchInstanceOfferingsCommand.ts @@ -32,6 +32,20 @@ export interface DescribeReservedElasticsearchInstanceOfferingsCommandOutput /** *

Lists available reserved Elasticsearch instance offerings.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ElasticsearchServiceClient, DescribeReservedElasticsearchInstanceOfferingsCommand } from "@aws-sdk/client-elasticsearch-service"; // ES Modules import + * // const { ElasticsearchServiceClient, DescribeReservedElasticsearchInstanceOfferingsCommand } = require("@aws-sdk/client-elasticsearch-service"); // CommonJS import + * const client = new ElasticsearchServiceClient(config); + * const command = new DescribeReservedElasticsearchInstanceOfferingsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeReservedElasticsearchInstanceOfferingsCommandInput} for command's `input` shape. + * @see {@link DescribeReservedElasticsearchInstanceOfferingsCommandOutput} for command's `response` shape. + * @see {@link ElasticsearchServiceClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeReservedElasticsearchInstanceOfferingsCommand extends $Command< DescribeReservedElasticsearchInstanceOfferingsCommandInput, diff --git a/clients/client-elasticsearch-service/commands/DescribeReservedElasticsearchInstancesCommand.ts b/clients/client-elasticsearch-service/commands/DescribeReservedElasticsearchInstancesCommand.ts index 7bb16f83e073..b71ce9c82eca 100644 --- a/clients/client-elasticsearch-service/commands/DescribeReservedElasticsearchInstancesCommand.ts +++ b/clients/client-elasticsearch-service/commands/DescribeReservedElasticsearchInstancesCommand.ts @@ -32,6 +32,20 @@ export interface DescribeReservedElasticsearchInstancesCommandOutput /** *

Returns information about reserved Elasticsearch instances for this account.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ElasticsearchServiceClient, DescribeReservedElasticsearchInstancesCommand } from "@aws-sdk/client-elasticsearch-service"; // ES Modules import + * // const { ElasticsearchServiceClient, DescribeReservedElasticsearchInstancesCommand } = require("@aws-sdk/client-elasticsearch-service"); // CommonJS import + * const client = new ElasticsearchServiceClient(config); + * const command = new DescribeReservedElasticsearchInstancesCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeReservedElasticsearchInstancesCommandInput} for command's `input` shape. + * @see {@link DescribeReservedElasticsearchInstancesCommandOutput} for command's `response` shape. + * @see {@link ElasticsearchServiceClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeReservedElasticsearchInstancesCommand extends $Command< DescribeReservedElasticsearchInstancesCommandInput, diff --git a/clients/client-elasticsearch-service/commands/DissociatePackageCommand.ts b/clients/client-elasticsearch-service/commands/DissociatePackageCommand.ts index b345de2a4ec1..59dfca040afe 100644 --- a/clients/client-elasticsearch-service/commands/DissociatePackageCommand.ts +++ b/clients/client-elasticsearch-service/commands/DissociatePackageCommand.ts @@ -26,6 +26,20 @@ export interface DissociatePackageCommandOutput extends DissociatePackageRespons /** *

Dissociates a package from the Amazon ES domain.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ElasticsearchServiceClient, DissociatePackageCommand } from "@aws-sdk/client-elasticsearch-service"; // ES Modules import + * // const { ElasticsearchServiceClient, DissociatePackageCommand } = require("@aws-sdk/client-elasticsearch-service"); // CommonJS import + * const client = new ElasticsearchServiceClient(config); + * const command = new DissociatePackageCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DissociatePackageCommandInput} for command's `input` shape. + * @see {@link DissociatePackageCommandOutput} for command's `response` shape. + * @see {@link ElasticsearchServiceClientResolvedConfig | config} for command's `input` shape. + * */ export class DissociatePackageCommand extends $Command< DissociatePackageCommandInput, diff --git a/clients/client-elasticsearch-service/commands/GetCompatibleElasticsearchVersionsCommand.ts b/clients/client-elasticsearch-service/commands/GetCompatibleElasticsearchVersionsCommand.ts index 4e4eeebab597..bf40612a4f12 100644 --- a/clients/client-elasticsearch-service/commands/GetCompatibleElasticsearchVersionsCommand.ts +++ b/clients/client-elasticsearch-service/commands/GetCompatibleElasticsearchVersionsCommand.ts @@ -38,6 +38,20 @@ export interface GetCompatibleElasticsearchVersionsCommandOutput * * to get all upgrade compatible Elasticsearch versions for that specific domain. *

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ElasticsearchServiceClient, GetCompatibleElasticsearchVersionsCommand } from "@aws-sdk/client-elasticsearch-service"; // ES Modules import + * // const { ElasticsearchServiceClient, GetCompatibleElasticsearchVersionsCommand } = require("@aws-sdk/client-elasticsearch-service"); // CommonJS import + * const client = new ElasticsearchServiceClient(config); + * const command = new GetCompatibleElasticsearchVersionsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetCompatibleElasticsearchVersionsCommandInput} for command's `input` shape. + * @see {@link GetCompatibleElasticsearchVersionsCommandOutput} for command's `response` shape. + * @see {@link ElasticsearchServiceClientResolvedConfig | config} for command's `input` shape. + * */ export class GetCompatibleElasticsearchVersionsCommand extends $Command< GetCompatibleElasticsearchVersionsCommandInput, diff --git a/clients/client-elasticsearch-service/commands/GetPackageVersionHistoryCommand.ts b/clients/client-elasticsearch-service/commands/GetPackageVersionHistoryCommand.ts index e022734a63c4..70132b3c5266 100644 --- a/clients/client-elasticsearch-service/commands/GetPackageVersionHistoryCommand.ts +++ b/clients/client-elasticsearch-service/commands/GetPackageVersionHistoryCommand.ts @@ -26,6 +26,20 @@ export interface GetPackageVersionHistoryCommandOutput extends GetPackageVersion /** *

Returns a list of versions of the package, along with their creation time and commit message.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ElasticsearchServiceClient, GetPackageVersionHistoryCommand } from "@aws-sdk/client-elasticsearch-service"; // ES Modules import + * // const { ElasticsearchServiceClient, GetPackageVersionHistoryCommand } = require("@aws-sdk/client-elasticsearch-service"); // CommonJS import + * const client = new ElasticsearchServiceClient(config); + * const command = new GetPackageVersionHistoryCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetPackageVersionHistoryCommandInput} for command's `input` shape. + * @see {@link GetPackageVersionHistoryCommandOutput} for command's `response` shape. + * @see {@link ElasticsearchServiceClientResolvedConfig | config} for command's `input` shape. + * */ export class GetPackageVersionHistoryCommand extends $Command< GetPackageVersionHistoryCommandInput, diff --git a/clients/client-elasticsearch-service/commands/GetUpgradeHistoryCommand.ts b/clients/client-elasticsearch-service/commands/GetUpgradeHistoryCommand.ts index 30f54009a240..2b969d428fa6 100644 --- a/clients/client-elasticsearch-service/commands/GetUpgradeHistoryCommand.ts +++ b/clients/client-elasticsearch-service/commands/GetUpgradeHistoryCommand.ts @@ -26,6 +26,20 @@ export interface GetUpgradeHistoryCommandOutput extends GetUpgradeHistoryRespons /** *

Retrieves the complete history of the last 10 upgrades that were performed on the domain.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ElasticsearchServiceClient, GetUpgradeHistoryCommand } from "@aws-sdk/client-elasticsearch-service"; // ES Modules import + * // const { ElasticsearchServiceClient, GetUpgradeHistoryCommand } = require("@aws-sdk/client-elasticsearch-service"); // CommonJS import + * const client = new ElasticsearchServiceClient(config); + * const command = new GetUpgradeHistoryCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetUpgradeHistoryCommandInput} for command's `input` shape. + * @see {@link GetUpgradeHistoryCommandOutput} for command's `response` shape. + * @see {@link ElasticsearchServiceClientResolvedConfig | config} for command's `input` shape. + * */ export class GetUpgradeHistoryCommand extends $Command< GetUpgradeHistoryCommandInput, diff --git a/clients/client-elasticsearch-service/commands/GetUpgradeStatusCommand.ts b/clients/client-elasticsearch-service/commands/GetUpgradeStatusCommand.ts index 4539c8b5b672..046bee24375c 100644 --- a/clients/client-elasticsearch-service/commands/GetUpgradeStatusCommand.ts +++ b/clients/client-elasticsearch-service/commands/GetUpgradeStatusCommand.ts @@ -26,6 +26,20 @@ export interface GetUpgradeStatusCommandOutput extends GetUpgradeStatusResponse, /** *

Retrieves the latest status of the last upgrade or upgrade eligibility check that was performed on the domain.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ElasticsearchServiceClient, GetUpgradeStatusCommand } from "@aws-sdk/client-elasticsearch-service"; // ES Modules import + * // const { ElasticsearchServiceClient, GetUpgradeStatusCommand } = require("@aws-sdk/client-elasticsearch-service"); // CommonJS import + * const client = new ElasticsearchServiceClient(config); + * const command = new GetUpgradeStatusCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetUpgradeStatusCommandInput} for command's `input` shape. + * @see {@link GetUpgradeStatusCommandOutput} for command's `response` shape. + * @see {@link ElasticsearchServiceClientResolvedConfig | config} for command's `input` shape. + * */ export class GetUpgradeStatusCommand extends $Command< GetUpgradeStatusCommandInput, diff --git a/clients/client-elasticsearch-service/commands/ListDomainNamesCommand.ts b/clients/client-elasticsearch-service/commands/ListDomainNamesCommand.ts index 1e00b081d614..836788f78458 100644 --- a/clients/client-elasticsearch-service/commands/ListDomainNamesCommand.ts +++ b/clients/client-elasticsearch-service/commands/ListDomainNamesCommand.ts @@ -26,6 +26,20 @@ export interface ListDomainNamesCommandOutput extends ListDomainNamesResponse, _ /** *

Returns the name of all Elasticsearch domains owned by the current user's account.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ElasticsearchServiceClient, ListDomainNamesCommand } from "@aws-sdk/client-elasticsearch-service"; // ES Modules import + * // const { ElasticsearchServiceClient, ListDomainNamesCommand } = require("@aws-sdk/client-elasticsearch-service"); // CommonJS import + * const client = new ElasticsearchServiceClient(config); + * const command = new ListDomainNamesCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListDomainNamesCommandInput} for command's `input` shape. + * @see {@link ListDomainNamesCommandOutput} for command's `response` shape. + * @see {@link ElasticsearchServiceClientResolvedConfig | config} for command's `input` shape. + * */ export class ListDomainNamesCommand extends $Command< ListDomainNamesCommandInput, diff --git a/clients/client-elasticsearch-service/commands/ListDomainsForPackageCommand.ts b/clients/client-elasticsearch-service/commands/ListDomainsForPackageCommand.ts index 79c19f10aaa5..05345e11b85c 100644 --- a/clients/client-elasticsearch-service/commands/ListDomainsForPackageCommand.ts +++ b/clients/client-elasticsearch-service/commands/ListDomainsForPackageCommand.ts @@ -26,6 +26,20 @@ export interface ListDomainsForPackageCommandOutput extends ListDomainsForPackag /** *

Lists all Amazon ES domains associated with the package.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ElasticsearchServiceClient, ListDomainsForPackageCommand } from "@aws-sdk/client-elasticsearch-service"; // ES Modules import + * // const { ElasticsearchServiceClient, ListDomainsForPackageCommand } = require("@aws-sdk/client-elasticsearch-service"); // CommonJS import + * const client = new ElasticsearchServiceClient(config); + * const command = new ListDomainsForPackageCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListDomainsForPackageCommandInput} for command's `input` shape. + * @see {@link ListDomainsForPackageCommandOutput} for command's `response` shape. + * @see {@link ElasticsearchServiceClientResolvedConfig | config} for command's `input` shape. + * */ export class ListDomainsForPackageCommand extends $Command< ListDomainsForPackageCommandInput, diff --git a/clients/client-elasticsearch-service/commands/ListElasticsearchInstanceTypesCommand.ts b/clients/client-elasticsearch-service/commands/ListElasticsearchInstanceTypesCommand.ts index 3f8a1d2f1f00..f3c9949f1ad1 100644 --- a/clients/client-elasticsearch-service/commands/ListElasticsearchInstanceTypesCommand.ts +++ b/clients/client-elasticsearch-service/commands/ListElasticsearchInstanceTypesCommand.ts @@ -28,6 +28,20 @@ export interface ListElasticsearchInstanceTypesCommandOutput /** *

List all Elasticsearch instance types that are supported for given ElasticsearchVersion

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ElasticsearchServiceClient, ListElasticsearchInstanceTypesCommand } from "@aws-sdk/client-elasticsearch-service"; // ES Modules import + * // const { ElasticsearchServiceClient, ListElasticsearchInstanceTypesCommand } = require("@aws-sdk/client-elasticsearch-service"); // CommonJS import + * const client = new ElasticsearchServiceClient(config); + * const command = new ListElasticsearchInstanceTypesCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListElasticsearchInstanceTypesCommandInput} for command's `input` shape. + * @see {@link ListElasticsearchInstanceTypesCommandOutput} for command's `response` shape. + * @see {@link ElasticsearchServiceClientResolvedConfig | config} for command's `input` shape. + * */ export class ListElasticsearchInstanceTypesCommand extends $Command< ListElasticsearchInstanceTypesCommandInput, diff --git a/clients/client-elasticsearch-service/commands/ListElasticsearchVersionsCommand.ts b/clients/client-elasticsearch-service/commands/ListElasticsearchVersionsCommand.ts index 7fb861fbb91a..c98ef0ee2287 100644 --- a/clients/client-elasticsearch-service/commands/ListElasticsearchVersionsCommand.ts +++ b/clients/client-elasticsearch-service/commands/ListElasticsearchVersionsCommand.ts @@ -26,6 +26,20 @@ export interface ListElasticsearchVersionsCommandOutput extends ListElasticsearc /** *

List all supported Elasticsearch versions

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ElasticsearchServiceClient, ListElasticsearchVersionsCommand } from "@aws-sdk/client-elasticsearch-service"; // ES Modules import + * // const { ElasticsearchServiceClient, ListElasticsearchVersionsCommand } = require("@aws-sdk/client-elasticsearch-service"); // CommonJS import + * const client = new ElasticsearchServiceClient(config); + * const command = new ListElasticsearchVersionsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListElasticsearchVersionsCommandInput} for command's `input` shape. + * @see {@link ListElasticsearchVersionsCommandOutput} for command's `response` shape. + * @see {@link ElasticsearchServiceClientResolvedConfig | config} for command's `input` shape. + * */ export class ListElasticsearchVersionsCommand extends $Command< ListElasticsearchVersionsCommandInput, diff --git a/clients/client-elasticsearch-service/commands/ListPackagesForDomainCommand.ts b/clients/client-elasticsearch-service/commands/ListPackagesForDomainCommand.ts index 3fe49e63497c..25b7d35a6847 100644 --- a/clients/client-elasticsearch-service/commands/ListPackagesForDomainCommand.ts +++ b/clients/client-elasticsearch-service/commands/ListPackagesForDomainCommand.ts @@ -26,6 +26,20 @@ export interface ListPackagesForDomainCommandOutput extends ListPackagesForDomai /** *

Lists all packages associated with the Amazon ES domain.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ElasticsearchServiceClient, ListPackagesForDomainCommand } from "@aws-sdk/client-elasticsearch-service"; // ES Modules import + * // const { ElasticsearchServiceClient, ListPackagesForDomainCommand } = require("@aws-sdk/client-elasticsearch-service"); // CommonJS import + * const client = new ElasticsearchServiceClient(config); + * const command = new ListPackagesForDomainCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListPackagesForDomainCommandInput} for command's `input` shape. + * @see {@link ListPackagesForDomainCommandOutput} for command's `response` shape. + * @see {@link ElasticsearchServiceClientResolvedConfig | config} for command's `input` shape. + * */ export class ListPackagesForDomainCommand extends $Command< ListPackagesForDomainCommandInput, diff --git a/clients/client-elasticsearch-service/commands/ListTagsCommand.ts b/clients/client-elasticsearch-service/commands/ListTagsCommand.ts index 4274719ca28a..1b1cd59d26f4 100644 --- a/clients/client-elasticsearch-service/commands/ListTagsCommand.ts +++ b/clients/client-elasticsearch-service/commands/ListTagsCommand.ts @@ -26,6 +26,20 @@ export interface ListTagsCommandOutput extends ListTagsResponse, __MetadataBeare /** *

Returns all tags for the given Elasticsearch domain.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ElasticsearchServiceClient, ListTagsCommand } from "@aws-sdk/client-elasticsearch-service"; // ES Modules import + * // const { ElasticsearchServiceClient, ListTagsCommand } = require("@aws-sdk/client-elasticsearch-service"); // CommonJS import + * const client = new ElasticsearchServiceClient(config); + * const command = new ListTagsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListTagsCommandInput} for command's `input` shape. + * @see {@link ListTagsCommandOutput} for command's `response` shape. + * @see {@link ElasticsearchServiceClientResolvedConfig | config} for command's `input` shape. + * */ export class ListTagsCommand extends $Command< ListTagsCommandInput, diff --git a/clients/client-elasticsearch-service/commands/PurchaseReservedElasticsearchInstanceOfferingCommand.ts b/clients/client-elasticsearch-service/commands/PurchaseReservedElasticsearchInstanceOfferingCommand.ts index 5350fa66a6e8..75e2b75a0125 100644 --- a/clients/client-elasticsearch-service/commands/PurchaseReservedElasticsearchInstanceOfferingCommand.ts +++ b/clients/client-elasticsearch-service/commands/PurchaseReservedElasticsearchInstanceOfferingCommand.ts @@ -32,6 +32,20 @@ export interface PurchaseReservedElasticsearchInstanceOfferingCommandOutput /** *

Allows you to purchase reserved Elasticsearch instances.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ElasticsearchServiceClient, PurchaseReservedElasticsearchInstanceOfferingCommand } from "@aws-sdk/client-elasticsearch-service"; // ES Modules import + * // const { ElasticsearchServiceClient, PurchaseReservedElasticsearchInstanceOfferingCommand } = require("@aws-sdk/client-elasticsearch-service"); // CommonJS import + * const client = new ElasticsearchServiceClient(config); + * const command = new PurchaseReservedElasticsearchInstanceOfferingCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link PurchaseReservedElasticsearchInstanceOfferingCommandInput} for command's `input` shape. + * @see {@link PurchaseReservedElasticsearchInstanceOfferingCommandOutput} for command's `response` shape. + * @see {@link ElasticsearchServiceClientResolvedConfig | config} for command's `input` shape. + * */ export class PurchaseReservedElasticsearchInstanceOfferingCommand extends $Command< PurchaseReservedElasticsearchInstanceOfferingCommandInput, diff --git a/clients/client-elasticsearch-service/commands/RejectInboundCrossClusterSearchConnectionCommand.ts b/clients/client-elasticsearch-service/commands/RejectInboundCrossClusterSearchConnectionCommand.ts index a67739f72ade..1cb8d0f19235 100644 --- a/clients/client-elasticsearch-service/commands/RejectInboundCrossClusterSearchConnectionCommand.ts +++ b/clients/client-elasticsearch-service/commands/RejectInboundCrossClusterSearchConnectionCommand.ts @@ -32,6 +32,20 @@ export interface RejectInboundCrossClusterSearchConnectionCommandOutput /** *

Allows the destination domain owner to reject an inbound cross-cluster search connection request.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ElasticsearchServiceClient, RejectInboundCrossClusterSearchConnectionCommand } from "@aws-sdk/client-elasticsearch-service"; // ES Modules import + * // const { ElasticsearchServiceClient, RejectInboundCrossClusterSearchConnectionCommand } = require("@aws-sdk/client-elasticsearch-service"); // CommonJS import + * const client = new ElasticsearchServiceClient(config); + * const command = new RejectInboundCrossClusterSearchConnectionCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link RejectInboundCrossClusterSearchConnectionCommandInput} for command's `input` shape. + * @see {@link RejectInboundCrossClusterSearchConnectionCommandOutput} for command's `response` shape. + * @see {@link ElasticsearchServiceClientResolvedConfig | config} for command's `input` shape. + * */ export class RejectInboundCrossClusterSearchConnectionCommand extends $Command< RejectInboundCrossClusterSearchConnectionCommandInput, diff --git a/clients/client-elasticsearch-service/commands/RemoveTagsCommand.ts b/clients/client-elasticsearch-service/commands/RemoveTagsCommand.ts index bdda0dc6d4fa..22a2049fde28 100644 --- a/clients/client-elasticsearch-service/commands/RemoveTagsCommand.ts +++ b/clients/client-elasticsearch-service/commands/RemoveTagsCommand.ts @@ -26,6 +26,20 @@ export interface RemoveTagsCommandOutput extends __MetadataBearer {} /** *

Removes the specified set of tags from the specified Elasticsearch domain.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ElasticsearchServiceClient, RemoveTagsCommand } from "@aws-sdk/client-elasticsearch-service"; // ES Modules import + * // const { ElasticsearchServiceClient, RemoveTagsCommand } = require("@aws-sdk/client-elasticsearch-service"); // CommonJS import + * const client = new ElasticsearchServiceClient(config); + * const command = new RemoveTagsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link RemoveTagsCommandInput} for command's `input` shape. + * @see {@link RemoveTagsCommandOutput} for command's `response` shape. + * @see {@link ElasticsearchServiceClientResolvedConfig | config} for command's `input` shape. + * */ export class RemoveTagsCommand extends $Command< RemoveTagsCommandInput, diff --git a/clients/client-elasticsearch-service/commands/StartElasticsearchServiceSoftwareUpdateCommand.ts b/clients/client-elasticsearch-service/commands/StartElasticsearchServiceSoftwareUpdateCommand.ts index b04d000c0406..27c8a78f0482 100644 --- a/clients/client-elasticsearch-service/commands/StartElasticsearchServiceSoftwareUpdateCommand.ts +++ b/clients/client-elasticsearch-service/commands/StartElasticsearchServiceSoftwareUpdateCommand.ts @@ -32,6 +32,20 @@ export interface StartElasticsearchServiceSoftwareUpdateCommandOutput /** *

Schedules a service software update for an Amazon ES domain.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ElasticsearchServiceClient, StartElasticsearchServiceSoftwareUpdateCommand } from "@aws-sdk/client-elasticsearch-service"; // ES Modules import + * // const { ElasticsearchServiceClient, StartElasticsearchServiceSoftwareUpdateCommand } = require("@aws-sdk/client-elasticsearch-service"); // CommonJS import + * const client = new ElasticsearchServiceClient(config); + * const command = new StartElasticsearchServiceSoftwareUpdateCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link StartElasticsearchServiceSoftwareUpdateCommandInput} for command's `input` shape. + * @see {@link StartElasticsearchServiceSoftwareUpdateCommandOutput} for command's `response` shape. + * @see {@link ElasticsearchServiceClientResolvedConfig | config} for command's `input` shape. + * */ export class StartElasticsearchServiceSoftwareUpdateCommand extends $Command< StartElasticsearchServiceSoftwareUpdateCommandInput, diff --git a/clients/client-elasticsearch-service/commands/UpdateElasticsearchDomainConfigCommand.ts b/clients/client-elasticsearch-service/commands/UpdateElasticsearchDomainConfigCommand.ts index f9dcd1198afd..2e9a8b119f34 100644 --- a/clients/client-elasticsearch-service/commands/UpdateElasticsearchDomainConfigCommand.ts +++ b/clients/client-elasticsearch-service/commands/UpdateElasticsearchDomainConfigCommand.ts @@ -28,6 +28,20 @@ export interface UpdateElasticsearchDomainConfigCommandOutput /** *

Modifies the cluster configuration of the specified Elasticsearch domain, setting as setting the instance type and the number of instances.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ElasticsearchServiceClient, UpdateElasticsearchDomainConfigCommand } from "@aws-sdk/client-elasticsearch-service"; // ES Modules import + * // const { ElasticsearchServiceClient, UpdateElasticsearchDomainConfigCommand } = require("@aws-sdk/client-elasticsearch-service"); // CommonJS import + * const client = new ElasticsearchServiceClient(config); + * const command = new UpdateElasticsearchDomainConfigCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link UpdateElasticsearchDomainConfigCommandInput} for command's `input` shape. + * @see {@link UpdateElasticsearchDomainConfigCommandOutput} for command's `response` shape. + * @see {@link ElasticsearchServiceClientResolvedConfig | config} for command's `input` shape. + * */ export class UpdateElasticsearchDomainConfigCommand extends $Command< UpdateElasticsearchDomainConfigCommandInput, diff --git a/clients/client-elasticsearch-service/commands/UpdatePackageCommand.ts b/clients/client-elasticsearch-service/commands/UpdatePackageCommand.ts index 94ba3906f504..a07bcec27fcc 100644 --- a/clients/client-elasticsearch-service/commands/UpdatePackageCommand.ts +++ b/clients/client-elasticsearch-service/commands/UpdatePackageCommand.ts @@ -26,6 +26,20 @@ export interface UpdatePackageCommandOutput extends UpdatePackageResponse, __Met /** *

Updates a package for use with Amazon ES domains.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ElasticsearchServiceClient, UpdatePackageCommand } from "@aws-sdk/client-elasticsearch-service"; // ES Modules import + * // const { ElasticsearchServiceClient, UpdatePackageCommand } = require("@aws-sdk/client-elasticsearch-service"); // CommonJS import + * const client = new ElasticsearchServiceClient(config); + * const command = new UpdatePackageCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link UpdatePackageCommandInput} for command's `input` shape. + * @see {@link UpdatePackageCommandOutput} for command's `response` shape. + * @see {@link ElasticsearchServiceClientResolvedConfig | config} for command's `input` shape. + * */ export class UpdatePackageCommand extends $Command< UpdatePackageCommandInput, diff --git a/clients/client-elasticsearch-service/commands/UpgradeElasticsearchDomainCommand.ts b/clients/client-elasticsearch-service/commands/UpgradeElasticsearchDomainCommand.ts index 6bc108dedfe2..d4df28c5b2cb 100644 --- a/clients/client-elasticsearch-service/commands/UpgradeElasticsearchDomainCommand.ts +++ b/clients/client-elasticsearch-service/commands/UpgradeElasticsearchDomainCommand.ts @@ -26,6 +26,20 @@ export interface UpgradeElasticsearchDomainCommandOutput extends UpgradeElastics /** *

Allows you to either upgrade your domain or perform an Upgrade eligibility check to a compatible Elasticsearch version.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ElasticsearchServiceClient, UpgradeElasticsearchDomainCommand } from "@aws-sdk/client-elasticsearch-service"; // ES Modules import + * // const { ElasticsearchServiceClient, UpgradeElasticsearchDomainCommand } = require("@aws-sdk/client-elasticsearch-service"); // CommonJS import + * const client = new ElasticsearchServiceClient(config); + * const command = new UpgradeElasticsearchDomainCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link UpgradeElasticsearchDomainCommandInput} for command's `input` shape. + * @see {@link UpgradeElasticsearchDomainCommandOutput} for command's `response` shape. + * @see {@link ElasticsearchServiceClientResolvedConfig | config} for command's `input` shape. + * */ export class UpgradeElasticsearchDomainCommand extends $Command< UpgradeElasticsearchDomainCommandInput, diff --git a/clients/client-elasticsearch-service/models/models_0.ts b/clients/client-elasticsearch-service/models/models_0.ts index d41e0fafa9a4..674b26a023cc 100644 --- a/clients/client-elasticsearch-service/models/models_0.ts +++ b/clients/client-elasticsearch-service/models/models_0.ts @@ -12,6 +12,9 @@ export interface AcceptInboundCrossClusterSearchConnectionRequest { } export namespace AcceptInboundCrossClusterSearchConnectionRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: AcceptInboundCrossClusterSearchConnectionRequest): any => ({ ...obj, }); @@ -50,6 +53,9 @@ export interface InboundCrossClusterSearchConnectionStatus { } export namespace InboundCrossClusterSearchConnectionStatus { + /** + * @internal + */ export const filterSensitiveLog = (obj: InboundCrossClusterSearchConnectionStatus): any => ({ ...obj, }); @@ -66,6 +72,9 @@ export interface DomainInformation { } export namespace DomainInformation { + /** + * @internal + */ export const filterSensitiveLog = (obj: DomainInformation): any => ({ ...obj, }); @@ -97,6 +106,9 @@ export interface InboundCrossClusterSearchConnection { } export namespace InboundCrossClusterSearchConnection { + /** + * @internal + */ export const filterSensitiveLog = (obj: InboundCrossClusterSearchConnection): any => ({ ...obj, }); @@ -113,6 +125,9 @@ export interface AcceptInboundCrossClusterSearchConnectionResponse { } export namespace AcceptInboundCrossClusterSearchConnectionResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: AcceptInboundCrossClusterSearchConnectionResponse): any => ({ ...obj, }); @@ -131,6 +146,9 @@ export interface DisabledOperationException extends __SmithyException, $Metadata } export namespace DisabledOperationException { + /** + * @internal + */ export const filterSensitiveLog = (obj: DisabledOperationException): any => ({ ...obj, }); @@ -149,6 +167,9 @@ export interface LimitExceededException extends __SmithyException, $MetadataBear } export namespace LimitExceededException { + /** + * @internal + */ export const filterSensitiveLog = (obj: LimitExceededException): any => ({ ...obj, }); @@ -167,6 +188,9 @@ export interface ResourceNotFoundException extends __SmithyException, $MetadataB } export namespace ResourceNotFoundException { + /** + * @internal + */ export const filterSensitiveLog = (obj: ResourceNotFoundException): any => ({ ...obj, }); @@ -185,6 +209,9 @@ export interface AccessDeniedException extends __SmithyException, $MetadataBeare } export namespace AccessDeniedException { + /** + * @internal + */ export const filterSensitiveLog = (obj: AccessDeniedException): any => ({ ...obj, }); @@ -223,6 +250,9 @@ export interface OptionStatus { } export namespace OptionStatus { + /** + * @internal + */ export const filterSensitiveLog = (obj: OptionStatus): any => ({ ...obj, }); @@ -245,6 +275,9 @@ export interface AccessPoliciesStatus { } export namespace AccessPoliciesStatus { + /** + * @internal + */ export const filterSensitiveLog = (obj: AccessPoliciesStatus): any => ({ ...obj, }); @@ -303,6 +336,9 @@ export interface AdditionalLimit { } export namespace AdditionalLimit { + /** + * @internal + */ export const filterSensitiveLog = (obj: AdditionalLimit): any => ({ ...obj, }); @@ -325,6 +361,9 @@ export interface Tag { } export namespace Tag { + /** + * @internal + */ export const filterSensitiveLog = (obj: Tag): any => ({ ...obj, }); @@ -346,6 +385,9 @@ export interface AddTagsRequest { } export namespace AddTagsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: AddTagsRequest): any => ({ ...obj, }); @@ -364,6 +406,9 @@ export interface BaseException extends __SmithyException, $MetadataBearer { } export namespace BaseException { + /** + * @internal + */ export const filterSensitiveLog = (obj: BaseException): any => ({ ...obj, }); @@ -382,6 +427,9 @@ export interface InternalException extends __SmithyException, $MetadataBearer { } export namespace InternalException { + /** + * @internal + */ export const filterSensitiveLog = (obj: InternalException): any => ({ ...obj, }); @@ -400,6 +448,9 @@ export interface ValidationException extends __SmithyException, $MetadataBearer } export namespace ValidationException { + /** + * @internal + */ export const filterSensitiveLog = (obj: ValidationException): any => ({ ...obj, }); @@ -427,6 +478,9 @@ export interface AdvancedOptionsStatus { } export namespace AdvancedOptionsStatus { + /** + * @internal + */ export const filterSensitiveLog = (obj: AdvancedOptionsStatus): any => ({ ...obj, }); @@ -448,6 +502,9 @@ export interface SAMLIdp { } export namespace SAMLIdp { + /** + * @internal + */ export const filterSensitiveLog = (obj: SAMLIdp): any => ({ ...obj, }); @@ -484,6 +541,9 @@ export interface SAMLOptionsOutput { } export namespace SAMLOptionsOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: SAMLOptionsOutput): any => ({ ...obj, }); @@ -510,6 +570,9 @@ export interface AdvancedSecurityOptions { } export namespace AdvancedSecurityOptions { + /** + * @internal + */ export const filterSensitiveLog = (obj: AdvancedSecurityOptions): any => ({ ...obj, }); @@ -536,6 +599,9 @@ export interface MasterUserOptions { } export namespace MasterUserOptions { + /** + * @internal + */ export const filterSensitiveLog = (obj: MasterUserOptions): any => ({ ...obj, ...(obj.MasterUserName && { MasterUserName: SENSITIVE_STRING }), @@ -584,6 +650,9 @@ export interface SAMLOptionsInput { } export namespace SAMLOptionsInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: SAMLOptionsInput): any => ({ ...obj, ...(obj.MasterUserName && { MasterUserName: SENSITIVE_STRING }), @@ -616,6 +685,9 @@ export interface AdvancedSecurityOptionsInput { } export namespace AdvancedSecurityOptionsInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: AdvancedSecurityOptionsInput): any => ({ ...obj, ...(obj.MasterUserOptions && { MasterUserOptions: MasterUserOptions.filterSensitiveLog(obj.MasterUserOptions) }), @@ -639,6 +711,9 @@ export interface AdvancedSecurityOptionsStatus { } export namespace AdvancedSecurityOptionsStatus { + /** + * @internal + */ export const filterSensitiveLog = (obj: AdvancedSecurityOptionsStatus): any => ({ ...obj, }); @@ -666,6 +741,9 @@ export interface AssociatePackageRequest { } export namespace AssociatePackageRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: AssociatePackageRequest): any => ({ ...obj, }); @@ -684,6 +762,9 @@ export interface ErrorDetails { } export namespace ErrorDetails { + /** + * @internal + */ export const filterSensitiveLog = (obj: ErrorDetails): any => ({ ...obj, }); @@ -738,6 +819,9 @@ export interface DomainPackageDetails { } export namespace DomainPackageDetails { + /** + * @internal + */ export const filterSensitiveLog = (obj: DomainPackageDetails): any => ({ ...obj, }); @@ -760,6 +844,9 @@ export interface AssociatePackageResponse { } export namespace AssociatePackageResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: AssociatePackageResponse): any => ({ ...obj, }); @@ -778,6 +865,9 @@ export interface ConflictException extends __SmithyException, $MetadataBearer { } export namespace ConflictException { + /** + * @internal + */ export const filterSensitiveLog = (obj: ConflictException): any => ({ ...obj, }); @@ -794,6 +884,9 @@ export interface CancelElasticsearchServiceSoftwareUpdateRequest { } export namespace CancelElasticsearchServiceSoftwareUpdateRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: CancelElasticsearchServiceSoftwareUpdateRequest): any => ({ ...obj, }); @@ -847,6 +940,9 @@ export interface ServiceSoftwareOptions { } export namespace ServiceSoftwareOptions { + /** + * @internal + */ export const filterSensitiveLog = (obj: ServiceSoftwareOptions): any => ({ ...obj, }); @@ -863,6 +959,9 @@ export interface CancelElasticsearchServiceSoftwareUpdateResponse { } export namespace CancelElasticsearchServiceSoftwareUpdateResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: CancelElasticsearchServiceSoftwareUpdateResponse): any => ({ ...obj, }); @@ -893,6 +992,9 @@ export interface Duration { } export namespace Duration { + /** + * @internal + */ export const filterSensitiveLog = (obj: Duration): any => ({ ...obj, }); @@ -919,6 +1021,9 @@ export interface AutoTuneMaintenanceSchedule { } export namespace AutoTuneMaintenanceSchedule { + /** + * @internal + */ export const filterSensitiveLog = (obj: AutoTuneMaintenanceSchedule): any => ({ ...obj, }); @@ -940,6 +1045,9 @@ export interface AutoTuneOptionsInput { } export namespace AutoTuneOptionsInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: AutoTuneOptionsInput): any => ({ ...obj, }); @@ -971,6 +1079,9 @@ export interface CognitoOptions { } export namespace CognitoOptions { + /** + * @internal + */ export const filterSensitiveLog = (obj: CognitoOptions): any => ({ ...obj, }); @@ -1018,6 +1129,9 @@ export interface DomainEndpointOptions { } export namespace DomainEndpointOptions { + /** + * @internal + */ export const filterSensitiveLog = (obj: DomainEndpointOptions): any => ({ ...obj, }); @@ -1051,6 +1165,9 @@ export interface EBSOptions { } export namespace EBSOptions { + /** + * @internal + */ export const filterSensitiveLog = (obj: EBSOptions): any => ({ ...obj, }); @@ -1129,6 +1246,9 @@ export interface ZoneAwarenessConfig { } export namespace ZoneAwarenessConfig { + /** + * @internal + */ export const filterSensitiveLog = (obj: ZoneAwarenessConfig): any => ({ ...obj, }); @@ -1190,6 +1310,9 @@ export interface ElasticsearchClusterConfig { } export namespace ElasticsearchClusterConfig { + /** + * @internal + */ export const filterSensitiveLog = (obj: ElasticsearchClusterConfig): any => ({ ...obj, }); @@ -1211,6 +1334,9 @@ export interface EncryptionAtRestOptions { } export namespace EncryptionAtRestOptions { + /** + * @internal + */ export const filterSensitiveLog = (obj: EncryptionAtRestOptions): any => ({ ...obj, }); @@ -1240,6 +1366,9 @@ export interface LogPublishingOption { } export namespace LogPublishingOption { + /** + * @internal + */ export const filterSensitiveLog = (obj: LogPublishingOption): any => ({ ...obj, }); @@ -1256,6 +1385,9 @@ export interface NodeToNodeEncryptionOptions { } export namespace NodeToNodeEncryptionOptions { + /** + * @internal + */ export const filterSensitiveLog = (obj: NodeToNodeEncryptionOptions): any => ({ ...obj, }); @@ -1272,6 +1404,9 @@ export interface SnapshotOptions { } export namespace SnapshotOptions { + /** + * @internal + */ export const filterSensitiveLog = (obj: SnapshotOptions): any => ({ ...obj, }); @@ -1293,6 +1428,9 @@ export interface VPCOptions { } export namespace VPCOptions { + /** + * @internal + */ export const filterSensitiveLog = (obj: VPCOptions): any => ({ ...obj, }); @@ -1383,6 +1521,9 @@ export interface CreateElasticsearchDomainRequest { } export namespace CreateElasticsearchDomainRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateElasticsearchDomainRequest): any => ({ ...obj, ...(obj.AdvancedSecurityOptions && { @@ -1419,6 +1560,9 @@ export interface AutoTuneOptionsOutput { } export namespace AutoTuneOptionsOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: AutoTuneOptionsOutput): any => ({ ...obj, }); @@ -1450,6 +1594,9 @@ export interface VPCDerivedInfo { } export namespace VPCDerivedInfo { + /** + * @internal + */ export const filterSensitiveLog = (obj: VPCDerivedInfo): any => ({ ...obj, }); @@ -1577,6 +1724,9 @@ export interface ElasticsearchDomainStatus { } export namespace ElasticsearchDomainStatus { + /** + * @internal + */ export const filterSensitiveLog = (obj: ElasticsearchDomainStatus): any => ({ ...obj, }); @@ -1593,6 +1743,9 @@ export interface CreateElasticsearchDomainResponse { } export namespace CreateElasticsearchDomainResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateElasticsearchDomainResponse): any => ({ ...obj, }); @@ -1611,6 +1764,9 @@ export interface InvalidTypeException extends __SmithyException, $MetadataBearer } export namespace InvalidTypeException { + /** + * @internal + */ export const filterSensitiveLog = (obj: InvalidTypeException): any => ({ ...obj, }); @@ -1629,6 +1785,9 @@ export interface ResourceAlreadyExistsException extends __SmithyException, $Meta } export namespace ResourceAlreadyExistsException { + /** + * @internal + */ export const filterSensitiveLog = (obj: ResourceAlreadyExistsException): any => ({ ...obj, }); @@ -1655,6 +1814,9 @@ export interface CreateOutboundCrossClusterSearchConnectionRequest { } export namespace CreateOutboundCrossClusterSearchConnectionRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateOutboundCrossClusterSearchConnectionRequest): any => ({ ...obj, }); @@ -1697,6 +1859,9 @@ export interface OutboundCrossClusterSearchConnectionStatus { } export namespace OutboundCrossClusterSearchConnectionStatus { + /** + * @internal + */ export const filterSensitiveLog = (obj: OutboundCrossClusterSearchConnectionStatus): any => ({ ...obj, }); @@ -1733,6 +1898,9 @@ export interface CreateOutboundCrossClusterSearchConnectionResponse { } export namespace CreateOutboundCrossClusterSearchConnectionResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateOutboundCrossClusterSearchConnectionResponse): any => ({ ...obj, }); @@ -1754,6 +1922,9 @@ export interface PackageSource { } export namespace PackageSource { + /** + * @internal + */ export const filterSensitiveLog = (obj: PackageSource): any => ({ ...obj, }); @@ -1791,6 +1962,9 @@ export interface CreatePackageRequest { } export namespace CreatePackageRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreatePackageRequest): any => ({ ...obj, }); @@ -1849,6 +2023,9 @@ export interface PackageDetails { } export namespace PackageDetails { + /** + * @internal + */ export const filterSensitiveLog = (obj: PackageDetails): any => ({ ...obj, }); @@ -1871,6 +2048,9 @@ export interface CreatePackageResponse { } export namespace CreatePackageResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreatePackageResponse): any => ({ ...obj, }); @@ -1887,6 +2067,9 @@ export interface DeleteElasticsearchDomainRequest { } export namespace DeleteElasticsearchDomainRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteElasticsearchDomainRequest): any => ({ ...obj, }); @@ -1903,6 +2086,9 @@ export interface DeleteElasticsearchDomainResponse { } export namespace DeleteElasticsearchDomainResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteElasticsearchDomainResponse): any => ({ ...obj, }); @@ -1919,6 +2105,9 @@ export interface DeleteInboundCrossClusterSearchConnectionRequest { } export namespace DeleteInboundCrossClusterSearchConnectionRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteInboundCrossClusterSearchConnectionRequest): any => ({ ...obj, }); @@ -1935,6 +2124,9 @@ export interface DeleteInboundCrossClusterSearchConnectionResponse { } export namespace DeleteInboundCrossClusterSearchConnectionResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteInboundCrossClusterSearchConnectionResponse): any => ({ ...obj, }); @@ -1951,6 +2143,9 @@ export interface DeleteOutboundCrossClusterSearchConnectionRequest { } export namespace DeleteOutboundCrossClusterSearchConnectionRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteOutboundCrossClusterSearchConnectionRequest): any => ({ ...obj, }); @@ -1987,6 +2182,9 @@ export interface OutboundCrossClusterSearchConnection { } export namespace OutboundCrossClusterSearchConnection { + /** + * @internal + */ export const filterSensitiveLog = (obj: OutboundCrossClusterSearchConnection): any => ({ ...obj, }); @@ -2003,6 +2201,9 @@ export interface DeleteOutboundCrossClusterSearchConnectionResponse { } export namespace DeleteOutboundCrossClusterSearchConnectionResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteOutboundCrossClusterSearchConnectionResponse): any => ({ ...obj, }); @@ -2025,6 +2226,9 @@ export interface DeletePackageRequest { } export namespace DeletePackageRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeletePackageRequest): any => ({ ...obj, }); @@ -2047,6 +2251,9 @@ export interface DeletePackageResponse { } export namespace DeletePackageResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeletePackageResponse): any => ({ ...obj, }); @@ -2073,6 +2280,9 @@ export interface DescribeDomainAutoTunesRequest { } export namespace DescribeDomainAutoTunesRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeDomainAutoTunesRequest): any => ({ ...obj, }); @@ -2115,6 +2325,9 @@ export interface ScheduledAutoTuneDetails { } export namespace ScheduledAutoTuneDetails { + /** + * @internal + */ export const filterSensitiveLog = (obj: ScheduledAutoTuneDetails): any => ({ ...obj, }); @@ -2131,6 +2344,9 @@ export interface AutoTuneDetails { } export namespace AutoTuneDetails { + /** + * @internal + */ export const filterSensitiveLog = (obj: AutoTuneDetails): any => ({ ...obj, }); @@ -2156,6 +2372,9 @@ export interface AutoTune { } export namespace AutoTune { + /** + * @internal + */ export const filterSensitiveLog = (obj: AutoTune): any => ({ ...obj, }); @@ -2177,6 +2396,9 @@ export interface DescribeDomainAutoTunesResponse { } export namespace DescribeDomainAutoTunesResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeDomainAutoTunesResponse): any => ({ ...obj, }); @@ -2193,6 +2415,9 @@ export interface DescribeElasticsearchDomainRequest { } export namespace DescribeElasticsearchDomainRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeElasticsearchDomainRequest): any => ({ ...obj, }); @@ -2209,6 +2434,9 @@ export interface DescribeElasticsearchDomainResponse { } export namespace DescribeElasticsearchDomainResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeElasticsearchDomainResponse): any => ({ ...obj, }); @@ -2225,6 +2453,9 @@ export interface DescribeElasticsearchDomainConfigRequest { } export namespace DescribeElasticsearchDomainConfigRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeElasticsearchDomainConfigRequest): any => ({ ...obj, }); @@ -2256,6 +2487,9 @@ export interface AutoTuneOptions { } export namespace AutoTuneOptions { + /** + * @internal + */ export const filterSensitiveLog = (obj: AutoTuneOptions): any => ({ ...obj, }); @@ -2297,6 +2531,9 @@ export interface AutoTuneStatus { } export namespace AutoTuneStatus { + /** + * @internal + */ export const filterSensitiveLog = (obj: AutoTuneStatus): any => ({ ...obj, }); @@ -2318,6 +2555,9 @@ export interface AutoTuneOptionsStatus { } export namespace AutoTuneOptionsStatus { + /** + * @internal + */ export const filterSensitiveLog = (obj: AutoTuneOptionsStatus): any => ({ ...obj, }); @@ -2339,6 +2579,9 @@ export interface CognitoOptionsStatus { } export namespace CognitoOptionsStatus { + /** + * @internal + */ export const filterSensitiveLog = (obj: CognitoOptionsStatus): any => ({ ...obj, }); @@ -2360,6 +2603,9 @@ export interface DomainEndpointOptionsStatus { } export namespace DomainEndpointOptionsStatus { + /** + * @internal + */ export const filterSensitiveLog = (obj: DomainEndpointOptionsStatus): any => ({ ...obj, }); @@ -2381,6 +2627,9 @@ export interface EBSOptionsStatus { } export namespace EBSOptionsStatus { + /** + * @internal + */ export const filterSensitiveLog = (obj: EBSOptionsStatus): any => ({ ...obj, }); @@ -2402,6 +2651,9 @@ export interface ElasticsearchClusterConfigStatus { } export namespace ElasticsearchClusterConfigStatus { + /** + * @internal + */ export const filterSensitiveLog = (obj: ElasticsearchClusterConfigStatus): any => ({ ...obj, }); @@ -2423,6 +2675,9 @@ export interface ElasticsearchVersionStatus { } export namespace ElasticsearchVersionStatus { + /** + * @internal + */ export const filterSensitiveLog = (obj: ElasticsearchVersionStatus): any => ({ ...obj, }); @@ -2444,6 +2699,9 @@ export interface EncryptionAtRestOptionsStatus { } export namespace EncryptionAtRestOptionsStatus { + /** + * @internal + */ export const filterSensitiveLog = (obj: EncryptionAtRestOptionsStatus): any => ({ ...obj, }); @@ -2465,6 +2723,9 @@ export interface LogPublishingOptionsStatus { } export namespace LogPublishingOptionsStatus { + /** + * @internal + */ export const filterSensitiveLog = (obj: LogPublishingOptionsStatus): any => ({ ...obj, }); @@ -2486,6 +2747,9 @@ export interface NodeToNodeEncryptionOptionsStatus { } export namespace NodeToNodeEncryptionOptionsStatus { + /** + * @internal + */ export const filterSensitiveLog = (obj: NodeToNodeEncryptionOptionsStatus): any => ({ ...obj, }); @@ -2507,6 +2771,9 @@ export interface SnapshotOptionsStatus { } export namespace SnapshotOptionsStatus { + /** + * @internal + */ export const filterSensitiveLog = (obj: SnapshotOptionsStatus): any => ({ ...obj, }); @@ -2528,6 +2795,9 @@ export interface VPCDerivedInfoStatus { } export namespace VPCDerivedInfoStatus { + /** + * @internal + */ export const filterSensitiveLog = (obj: VPCDerivedInfoStatus): any => ({ ...obj, }); @@ -2609,6 +2879,9 @@ export interface ElasticsearchDomainConfig { } export namespace ElasticsearchDomainConfig { + /** + * @internal + */ export const filterSensitiveLog = (obj: ElasticsearchDomainConfig): any => ({ ...obj, }); @@ -2625,6 +2898,9 @@ export interface DescribeElasticsearchDomainConfigResponse { } export namespace DescribeElasticsearchDomainConfigResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeElasticsearchDomainConfigResponse): any => ({ ...obj, }); @@ -2641,6 +2917,9 @@ export interface DescribeElasticsearchDomainsRequest { } export namespace DescribeElasticsearchDomainsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeElasticsearchDomainsRequest): any => ({ ...obj, }); @@ -2657,6 +2936,9 @@ export interface DescribeElasticsearchDomainsResponse { } export namespace DescribeElasticsearchDomainsResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeElasticsearchDomainsResponse): any => ({ ...obj, }); @@ -2709,6 +2991,9 @@ export interface DescribeElasticsearchInstanceTypeLimitsRequest { } export namespace DescribeElasticsearchInstanceTypeLimitsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeElasticsearchInstanceTypeLimitsRequest): any => ({ ...obj, }); @@ -2737,6 +3022,9 @@ export interface InstanceCountLimits { } export namespace InstanceCountLimits { + /** + * @internal + */ export const filterSensitiveLog = (obj: InstanceCountLimits): any => ({ ...obj, }); @@ -2757,6 +3045,9 @@ export interface InstanceLimits { } export namespace InstanceLimits { + /** + * @internal + */ export const filterSensitiveLog = (obj: InstanceLimits): any => ({ ...obj, }); @@ -2802,6 +3093,9 @@ export interface StorageTypeLimit { } export namespace StorageTypeLimit { + /** + * @internal + */ export const filterSensitiveLog = (obj: StorageTypeLimit): any => ({ ...obj, }); @@ -2849,6 +3143,9 @@ export interface StorageType { } export namespace StorageType { + /** + * @internal + */ export const filterSensitiveLog = (obj: StorageType): any => ({ ...obj, }); @@ -2898,6 +3195,9 @@ export interface Limits { } export namespace Limits { + /** + * @internal + */ export const filterSensitiveLog = (obj: Limits): any => ({ ...obj, }); @@ -2929,6 +3229,9 @@ export interface DescribeElasticsearchInstanceTypeLimitsResponse { } export namespace DescribeElasticsearchInstanceTypeLimitsResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeElasticsearchInstanceTypeLimitsResponse): any => ({ ...obj, }); @@ -2959,6 +3262,9 @@ export interface Filter { } export namespace Filter { + /** + * @internal + */ export const filterSensitiveLog = (obj: Filter): any => ({ ...obj, }); @@ -2995,6 +3301,9 @@ export interface DescribeInboundCrossClusterSearchConnectionsRequest { } export namespace DescribeInboundCrossClusterSearchConnectionsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeInboundCrossClusterSearchConnectionsRequest): any => ({ ...obj, }); @@ -3017,6 +3326,9 @@ export interface DescribeInboundCrossClusterSearchConnectionsResponse { } export namespace DescribeInboundCrossClusterSearchConnectionsResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeInboundCrossClusterSearchConnectionsResponse): any => ({ ...obj, }); @@ -3035,6 +3347,9 @@ export interface InvalidPaginationTokenException extends __SmithyException, $Met } export namespace InvalidPaginationTokenException { + /** + * @internal + */ export const filterSensitiveLog = (obj: InvalidPaginationTokenException): any => ({ ...obj, }); @@ -3071,6 +3386,9 @@ export interface DescribeOutboundCrossClusterSearchConnectionsRequest { } export namespace DescribeOutboundCrossClusterSearchConnectionsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeOutboundCrossClusterSearchConnectionsRequest): any => ({ ...obj, }); @@ -3093,6 +3411,9 @@ export interface DescribeOutboundCrossClusterSearchConnectionsResponse { } export namespace DescribeOutboundCrossClusterSearchConnectionsResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeOutboundCrossClusterSearchConnectionsResponse): any => ({ ...obj, }); @@ -3120,6 +3441,9 @@ export interface DescribePackagesFilter { } export namespace DescribePackagesFilter { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribePackagesFilter): any => ({ ...obj, }); @@ -3152,6 +3476,9 @@ export interface DescribePackagesRequest { } export namespace DescribePackagesRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribePackagesRequest): any => ({ ...obj, }); @@ -3176,6 +3503,9 @@ export interface DescribePackagesResponse { } export namespace DescribePackagesResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribePackagesResponse): any => ({ ...obj, }); @@ -3203,6 +3533,9 @@ export interface DescribeReservedElasticsearchInstanceOfferingsRequest { } export namespace DescribeReservedElasticsearchInstanceOfferingsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeReservedElasticsearchInstanceOfferingsRequest): any => ({ ...obj, }); @@ -3226,6 +3559,9 @@ export interface RecurringCharge { } export namespace RecurringCharge { + /** + * @internal + */ export const filterSensitiveLog = (obj: RecurringCharge): any => ({ ...obj, }); @@ -3277,6 +3613,9 @@ export interface ReservedElasticsearchInstanceOffering { } export namespace ReservedElasticsearchInstanceOffering { + /** + * @internal + */ export const filterSensitiveLog = (obj: ReservedElasticsearchInstanceOffering): any => ({ ...obj, }); @@ -3298,6 +3637,9 @@ export interface DescribeReservedElasticsearchInstanceOfferingsResponse { } export namespace DescribeReservedElasticsearchInstanceOfferingsResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeReservedElasticsearchInstanceOfferingsResponse): any => ({ ...obj, }); @@ -3325,6 +3667,9 @@ export interface DescribeReservedElasticsearchInstancesRequest { } export namespace DescribeReservedElasticsearchInstancesRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeReservedElasticsearchInstancesRequest): any => ({ ...obj, }); @@ -3401,6 +3746,9 @@ export interface ReservedElasticsearchInstance { } export namespace ReservedElasticsearchInstance { + /** + * @internal + */ export const filterSensitiveLog = (obj: ReservedElasticsearchInstance): any => ({ ...obj, }); @@ -3422,6 +3770,9 @@ export interface DescribeReservedElasticsearchInstancesResponse { } export namespace DescribeReservedElasticsearchInstancesResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeReservedElasticsearchInstancesResponse): any => ({ ...obj, }); @@ -3449,6 +3800,9 @@ export interface DissociatePackageRequest { } export namespace DissociatePackageRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DissociatePackageRequest): any => ({ ...obj, }); @@ -3471,6 +3825,9 @@ export interface DissociatePackageResponse { } export namespace DissociatePackageResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DissociatePackageResponse): any => ({ ...obj, }); @@ -3493,6 +3850,9 @@ export interface GetCompatibleElasticsearchVersionsRequest { } export namespace GetCompatibleElasticsearchVersionsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetCompatibleElasticsearchVersionsRequest): any => ({ ...obj, }); @@ -3525,6 +3885,9 @@ export interface CompatibleVersionsMap { } export namespace CompatibleVersionsMap { + /** + * @internal + */ export const filterSensitiveLog = (obj: CompatibleVersionsMap): any => ({ ...obj, }); @@ -3553,6 +3916,9 @@ export interface GetCompatibleElasticsearchVersionsResponse { } export namespace GetCompatibleElasticsearchVersionsResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetCompatibleElasticsearchVersionsResponse): any => ({ ...obj, }); @@ -3585,6 +3951,9 @@ export interface GetPackageVersionHistoryRequest { } export namespace GetPackageVersionHistoryRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetPackageVersionHistoryRequest): any => ({ ...obj, }); @@ -3611,6 +3980,9 @@ export interface PackageVersionHistory { } export namespace PackageVersionHistory { + /** + * @internal + */ export const filterSensitiveLog = (obj: PackageVersionHistory): any => ({ ...obj, }); @@ -3636,6 +4008,9 @@ export interface GetPackageVersionHistoryResponse { } export namespace GetPackageVersionHistoryResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetPackageVersionHistoryResponse): any => ({ ...obj, }); @@ -3673,6 +4048,9 @@ export interface GetUpgradeHistoryRequest { } export namespace GetUpgradeHistoryRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetUpgradeHistoryRequest): any => ({ ...obj, }); @@ -3723,6 +4101,9 @@ export interface UpgradeStepItem { } export namespace UpgradeStepItem { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpgradeStepItem): any => ({ ...obj, }); @@ -3768,6 +4149,9 @@ export interface UpgradeHistory { } export namespace UpgradeHistory { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpgradeHistory): any => ({ ...obj, }); @@ -3805,6 +4189,9 @@ export interface GetUpgradeHistoryResponse { } export namespace GetUpgradeHistoryResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetUpgradeHistoryResponse): any => ({ ...obj, }); @@ -3827,6 +4214,9 @@ export interface GetUpgradeStatusRequest { } export namespace GetUpgradeStatusRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetUpgradeStatusRequest): any => ({ ...obj, }); @@ -3878,6 +4268,9 @@ export interface GetUpgradeStatusResponse { } export namespace GetUpgradeStatusResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetUpgradeStatusResponse): any => ({ ...obj, }); @@ -3891,6 +4284,9 @@ export interface DomainInfo { } export namespace DomainInfo { + /** + * @internal + */ export const filterSensitiveLog = (obj: DomainInfo): any => ({ ...obj, }); @@ -3907,6 +4303,9 @@ export interface ListDomainNamesResponse { } export namespace ListDomainNamesResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListDomainNamesResponse): any => ({ ...obj, }); @@ -3939,6 +4338,9 @@ export interface ListDomainsForPackageRequest { } export namespace ListDomainsForPackageRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListDomainsForPackageRequest): any => ({ ...obj, }); @@ -3963,6 +4365,9 @@ export interface ListDomainsForPackageResponse { } export namespace ListDomainsForPackageResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListDomainsForPackageResponse): any => ({ ...obj, }); @@ -4009,6 +4414,9 @@ export interface ListElasticsearchInstanceTypesRequest { } export namespace ListElasticsearchInstanceTypesRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListElasticsearchInstanceTypesRequest): any => ({ ...obj, }); @@ -4045,6 +4453,9 @@ export interface ListElasticsearchInstanceTypesResponse { } export namespace ListElasticsearchInstanceTypesResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListElasticsearchInstanceTypesResponse): any => ({ ...obj, }); @@ -4094,6 +4505,9 @@ export interface ListElasticsearchVersionsRequest { } export namespace ListElasticsearchVersionsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListElasticsearchVersionsRequest): any => ({ ...obj, }); @@ -4125,6 +4539,9 @@ export interface ListElasticsearchVersionsResponse { } export namespace ListElasticsearchVersionsResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListElasticsearchVersionsResponse): any => ({ ...obj, }); @@ -4157,6 +4574,9 @@ export interface ListPackagesForDomainRequest { } export namespace ListPackagesForDomainRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListPackagesForDomainRequest): any => ({ ...obj, }); @@ -4184,6 +4604,9 @@ export interface ListPackagesForDomainResponse { } export namespace ListPackagesForDomainResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListPackagesForDomainResponse): any => ({ ...obj, }); @@ -4200,6 +4623,9 @@ export interface ListTagsRequest { } export namespace ListTagsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListTagsRequest): any => ({ ...obj, }); @@ -4216,6 +4642,9 @@ export interface ListTagsResponse { } export namespace ListTagsResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListTagsResponse): any => ({ ...obj, }); @@ -4242,6 +4671,9 @@ export interface PurchaseReservedElasticsearchInstanceOfferingRequest { } export namespace PurchaseReservedElasticsearchInstanceOfferingRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: PurchaseReservedElasticsearchInstanceOfferingRequest): any => ({ ...obj, }); @@ -4263,6 +4695,9 @@ export interface PurchaseReservedElasticsearchInstanceOfferingResponse { } export namespace PurchaseReservedElasticsearchInstanceOfferingResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: PurchaseReservedElasticsearchInstanceOfferingResponse): any => ({ ...obj, }); @@ -4279,6 +4714,9 @@ export interface RejectInboundCrossClusterSearchConnectionRequest { } export namespace RejectInboundCrossClusterSearchConnectionRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: RejectInboundCrossClusterSearchConnectionRequest): any => ({ ...obj, }); @@ -4295,6 +4733,9 @@ export interface RejectInboundCrossClusterSearchConnectionResponse { } export namespace RejectInboundCrossClusterSearchConnectionResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: RejectInboundCrossClusterSearchConnectionResponse): any => ({ ...obj, }); @@ -4316,6 +4757,9 @@ export interface RemoveTagsRequest { } export namespace RemoveTagsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: RemoveTagsRequest): any => ({ ...obj, }); @@ -4332,6 +4776,9 @@ export interface StartElasticsearchServiceSoftwareUpdateRequest { } export namespace StartElasticsearchServiceSoftwareUpdateRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: StartElasticsearchServiceSoftwareUpdateRequest): any => ({ ...obj, }); @@ -4348,6 +4795,9 @@ export interface StartElasticsearchServiceSoftwareUpdateResponse { } export namespace StartElasticsearchServiceSoftwareUpdateResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: StartElasticsearchServiceSoftwareUpdateResponse): any => ({ ...obj, }); @@ -4430,6 +4880,9 @@ export interface UpdateElasticsearchDomainConfigRequest { } export namespace UpdateElasticsearchDomainConfigRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateElasticsearchDomainConfigRequest): any => ({ ...obj, ...(obj.AdvancedSecurityOptions && { @@ -4449,6 +4902,9 @@ export interface UpdateElasticsearchDomainConfigResponse { } export namespace UpdateElasticsearchDomainConfigResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateElasticsearchDomainConfigResponse): any => ({ ...obj, }); @@ -4486,6 +4942,9 @@ export interface UpdatePackageRequest { } export namespace UpdatePackageRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdatePackageRequest): any => ({ ...obj, }); @@ -4508,6 +4967,9 @@ export interface UpdatePackageResponse { } export namespace UpdatePackageResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdatePackageResponse): any => ({ ...obj, }); @@ -4543,6 +5005,9 @@ export interface UpgradeElasticsearchDomainRequest { } export namespace UpgradeElasticsearchDomainRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpgradeElasticsearchDomainRequest): any => ({ ...obj, }); @@ -4578,6 +5043,9 @@ export interface UpgradeElasticsearchDomainResponse { } export namespace UpgradeElasticsearchDomainResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpgradeElasticsearchDomainResponse): any => ({ ...obj, }); diff --git a/clients/client-emr-containers/commands/CancelJobRunCommand.ts b/clients/client-emr-containers/commands/CancelJobRunCommand.ts index 2895abe29140..55a545915fdf 100644 --- a/clients/client-emr-containers/commands/CancelJobRunCommand.ts +++ b/clients/client-emr-containers/commands/CancelJobRunCommand.ts @@ -22,6 +22,20 @@ export interface CancelJobRunCommandOutput extends CancelJobRunResponse, __Metad /** *

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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { EMRContainersClient, CancelJobRunCommand } from "@aws-sdk/client-emr-containers"; // ES Modules import + * // const { EMRContainersClient, CancelJobRunCommand } = require("@aws-sdk/client-emr-containers"); // CommonJS import + * const client = new EMRContainersClient(config); + * const command = new CancelJobRunCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CancelJobRunCommandInput} for command's `input` shape. + * @see {@link CancelJobRunCommandOutput} for command's `response` shape. + * @see {@link EMRContainersClientResolvedConfig | config} for command's `input` shape. + * */ export class CancelJobRunCommand extends $Command< CancelJobRunCommandInput, diff --git a/clients/client-emr-containers/commands/CreateManagedEndpointCommand.ts b/clients/client-emr-containers/commands/CreateManagedEndpointCommand.ts index 7329595b2ea3..d6f42b8a2d7b 100644 --- a/clients/client-emr-containers/commands/CreateManagedEndpointCommand.ts +++ b/clients/client-emr-containers/commands/CreateManagedEndpointCommand.ts @@ -22,6 +22,20 @@ export interface CreateManagedEndpointCommandOutput extends CreateManagedEndpoin /** *

Creates a managed endpoint. A managed endpoint is a gateway that connects EMR Studio to Amazon EMR on EKS so that EMR Studio can communicate with your virtual cluster.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { EMRContainersClient, CreateManagedEndpointCommand } from "@aws-sdk/client-emr-containers"; // ES Modules import + * // const { EMRContainersClient, CreateManagedEndpointCommand } = require("@aws-sdk/client-emr-containers"); // CommonJS import + * const client = new EMRContainersClient(config); + * const command = new CreateManagedEndpointCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreateManagedEndpointCommandInput} for command's `input` shape. + * @see {@link CreateManagedEndpointCommandOutput} for command's `response` shape. + * @see {@link EMRContainersClientResolvedConfig | config} for command's `input` shape. + * */ export class CreateManagedEndpointCommand extends $Command< CreateManagedEndpointCommandInput, diff --git a/clients/client-emr-containers/commands/CreateVirtualClusterCommand.ts b/clients/client-emr-containers/commands/CreateVirtualClusterCommand.ts index 280599077f8e..f9d9be7fc42b 100644 --- a/clients/client-emr-containers/commands/CreateVirtualClusterCommand.ts +++ b/clients/client-emr-containers/commands/CreateVirtualClusterCommand.ts @@ -22,6 +22,20 @@ export interface CreateVirtualClusterCommandOutput extends CreateVirtualClusterR /** *

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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { EMRContainersClient, CreateVirtualClusterCommand } from "@aws-sdk/client-emr-containers"; // ES Modules import + * // const { EMRContainersClient, CreateVirtualClusterCommand } = require("@aws-sdk/client-emr-containers"); // CommonJS import + * const client = new EMRContainersClient(config); + * const command = new CreateVirtualClusterCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreateVirtualClusterCommandInput} for command's `input` shape. + * @see {@link CreateVirtualClusterCommandOutput} for command's `response` shape. + * @see {@link EMRContainersClientResolvedConfig | config} for command's `input` shape. + * */ export class CreateVirtualClusterCommand extends $Command< CreateVirtualClusterCommandInput, diff --git a/clients/client-emr-containers/commands/DeleteManagedEndpointCommand.ts b/clients/client-emr-containers/commands/DeleteManagedEndpointCommand.ts index 3ed57636650e..4a3ae95721bf 100644 --- a/clients/client-emr-containers/commands/DeleteManagedEndpointCommand.ts +++ b/clients/client-emr-containers/commands/DeleteManagedEndpointCommand.ts @@ -22,6 +22,20 @@ export interface DeleteManagedEndpointCommandOutput extends DeleteManagedEndpoin /** *

Deletes a managed endpoint. A managed endpoint is a gateway that connects EMR Studio to Amazon EMR on EKS so that EMR Studio can communicate with your virtual cluster.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { EMRContainersClient, DeleteManagedEndpointCommand } from "@aws-sdk/client-emr-containers"; // ES Modules import + * // const { EMRContainersClient, DeleteManagedEndpointCommand } = require("@aws-sdk/client-emr-containers"); // CommonJS import + * const client = new EMRContainersClient(config); + * const command = new DeleteManagedEndpointCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteManagedEndpointCommandInput} for command's `input` shape. + * @see {@link DeleteManagedEndpointCommandOutput} for command's `response` shape. + * @see {@link EMRContainersClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteManagedEndpointCommand extends $Command< DeleteManagedEndpointCommandInput, diff --git a/clients/client-emr-containers/commands/DeleteVirtualClusterCommand.ts b/clients/client-emr-containers/commands/DeleteVirtualClusterCommand.ts index c2a1de773fe1..d00238def059 100644 --- a/clients/client-emr-containers/commands/DeleteVirtualClusterCommand.ts +++ b/clients/client-emr-containers/commands/DeleteVirtualClusterCommand.ts @@ -22,6 +22,20 @@ export interface DeleteVirtualClusterCommandOutput extends DeleteVirtualClusterR /** *

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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { EMRContainersClient, DeleteVirtualClusterCommand } from "@aws-sdk/client-emr-containers"; // ES Modules import + * // const { EMRContainersClient, DeleteVirtualClusterCommand } = require("@aws-sdk/client-emr-containers"); // CommonJS import + * const client = new EMRContainersClient(config); + * const command = new DeleteVirtualClusterCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteVirtualClusterCommandInput} for command's `input` shape. + * @see {@link DeleteVirtualClusterCommandOutput} for command's `response` shape. + * @see {@link EMRContainersClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteVirtualClusterCommand extends $Command< DeleteVirtualClusterCommandInput, diff --git a/clients/client-emr-containers/commands/DescribeJobRunCommand.ts b/clients/client-emr-containers/commands/DescribeJobRunCommand.ts index 01d3224b8747..cd1f7ef15ba9 100644 --- a/clients/client-emr-containers/commands/DescribeJobRunCommand.ts +++ b/clients/client-emr-containers/commands/DescribeJobRunCommand.ts @@ -22,6 +22,20 @@ export interface DescribeJobRunCommandOutput extends DescribeJobRunResponse, __M /** *

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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { EMRContainersClient, DescribeJobRunCommand } from "@aws-sdk/client-emr-containers"; // ES Modules import + * // const { EMRContainersClient, DescribeJobRunCommand } = require("@aws-sdk/client-emr-containers"); // CommonJS import + * const client = new EMRContainersClient(config); + * const command = new DescribeJobRunCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeJobRunCommandInput} for command's `input` shape. + * @see {@link DescribeJobRunCommandOutput} for command's `response` shape. + * @see {@link EMRContainersClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeJobRunCommand extends $Command< DescribeJobRunCommandInput, diff --git a/clients/client-emr-containers/commands/DescribeManagedEndpointCommand.ts b/clients/client-emr-containers/commands/DescribeManagedEndpointCommand.ts index 040c9707bb79..1e9ace9547b8 100644 --- a/clients/client-emr-containers/commands/DescribeManagedEndpointCommand.ts +++ b/clients/client-emr-containers/commands/DescribeManagedEndpointCommand.ts @@ -22,6 +22,20 @@ export interface DescribeManagedEndpointCommandOutput extends DescribeManagedEnd /** *

Displays detailed information about a managed endpoint. A managed endpoint is a gateway that connects EMR Studio to Amazon EMR on EKS so that EMR Studio can communicate with your virtual cluster.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { EMRContainersClient, DescribeManagedEndpointCommand } from "@aws-sdk/client-emr-containers"; // ES Modules import + * // const { EMRContainersClient, DescribeManagedEndpointCommand } = require("@aws-sdk/client-emr-containers"); // CommonJS import + * const client = new EMRContainersClient(config); + * const command = new DescribeManagedEndpointCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeManagedEndpointCommandInput} for command's `input` shape. + * @see {@link DescribeManagedEndpointCommandOutput} for command's `response` shape. + * @see {@link EMRContainersClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeManagedEndpointCommand extends $Command< DescribeManagedEndpointCommandInput, diff --git a/clients/client-emr-containers/commands/DescribeVirtualClusterCommand.ts b/clients/client-emr-containers/commands/DescribeVirtualClusterCommand.ts index ca349d5ab264..a3a0854064bf 100644 --- a/clients/client-emr-containers/commands/DescribeVirtualClusterCommand.ts +++ b/clients/client-emr-containers/commands/DescribeVirtualClusterCommand.ts @@ -22,6 +22,20 @@ export interface DescribeVirtualClusterCommandOutput extends DescribeVirtualClus /** *

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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { EMRContainersClient, DescribeVirtualClusterCommand } from "@aws-sdk/client-emr-containers"; // ES Modules import + * // const { EMRContainersClient, DescribeVirtualClusterCommand } = require("@aws-sdk/client-emr-containers"); // CommonJS import + * const client = new EMRContainersClient(config); + * const command = new DescribeVirtualClusterCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeVirtualClusterCommandInput} for command's `input` shape. + * @see {@link DescribeVirtualClusterCommandOutput} for command's `response` shape. + * @see {@link EMRContainersClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeVirtualClusterCommand extends $Command< DescribeVirtualClusterCommandInput, diff --git a/clients/client-emr-containers/commands/ListJobRunsCommand.ts b/clients/client-emr-containers/commands/ListJobRunsCommand.ts index 9e08017a397b..823850692178 100644 --- a/clients/client-emr-containers/commands/ListJobRunsCommand.ts +++ b/clients/client-emr-containers/commands/ListJobRunsCommand.ts @@ -22,6 +22,20 @@ export interface ListJobRunsCommandOutput extends ListJobRunsResponse, __Metadat /** *

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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { EMRContainersClient, ListJobRunsCommand } from "@aws-sdk/client-emr-containers"; // ES Modules import + * // const { EMRContainersClient, ListJobRunsCommand } = require("@aws-sdk/client-emr-containers"); // CommonJS import + * const client = new EMRContainersClient(config); + * const command = new ListJobRunsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListJobRunsCommandInput} for command's `input` shape. + * @see {@link ListJobRunsCommandOutput} for command's `response` shape. + * @see {@link EMRContainersClientResolvedConfig | config} for command's `input` shape. + * */ export class ListJobRunsCommand extends $Command< ListJobRunsCommandInput, diff --git a/clients/client-emr-containers/commands/ListManagedEndpointsCommand.ts b/clients/client-emr-containers/commands/ListManagedEndpointsCommand.ts index b207ea7edbed..866ba879e6de 100644 --- a/clients/client-emr-containers/commands/ListManagedEndpointsCommand.ts +++ b/clients/client-emr-containers/commands/ListManagedEndpointsCommand.ts @@ -22,6 +22,20 @@ export interface ListManagedEndpointsCommandOutput extends ListManagedEndpointsR /** *

Lists managed endpoints based on a set of parameters. A managed endpoint is a gateway that connects EMR Studio to Amazon EMR on EKS so that EMR Studio can communicate with your virtual cluster.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { EMRContainersClient, ListManagedEndpointsCommand } from "@aws-sdk/client-emr-containers"; // ES Modules import + * // const { EMRContainersClient, ListManagedEndpointsCommand } = require("@aws-sdk/client-emr-containers"); // CommonJS import + * const client = new EMRContainersClient(config); + * const command = new ListManagedEndpointsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListManagedEndpointsCommandInput} for command's `input` shape. + * @see {@link ListManagedEndpointsCommandOutput} for command's `response` shape. + * @see {@link EMRContainersClientResolvedConfig | config} for command's `input` shape. + * */ export class ListManagedEndpointsCommand extends $Command< ListManagedEndpointsCommandInput, diff --git a/clients/client-emr-containers/commands/ListTagsForResourceCommand.ts b/clients/client-emr-containers/commands/ListTagsForResourceCommand.ts index 3a0dafadb536..d380c7479ae7 100644 --- a/clients/client-emr-containers/commands/ListTagsForResourceCommand.ts +++ b/clients/client-emr-containers/commands/ListTagsForResourceCommand.ts @@ -22,6 +22,20 @@ export interface ListTagsForResourceCommandOutput extends ListTagsForResourceRes /** *

Lists the tags assigned to the resources.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { EMRContainersClient, ListTagsForResourceCommand } from "@aws-sdk/client-emr-containers"; // ES Modules import + * // const { EMRContainersClient, ListTagsForResourceCommand } = require("@aws-sdk/client-emr-containers"); // CommonJS import + * const client = new EMRContainersClient(config); + * const command = new ListTagsForResourceCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListTagsForResourceCommandInput} for command's `input` shape. + * @see {@link ListTagsForResourceCommandOutput} for command's `response` shape. + * @see {@link EMRContainersClientResolvedConfig | config} for command's `input` shape. + * */ export class ListTagsForResourceCommand extends $Command< ListTagsForResourceCommandInput, diff --git a/clients/client-emr-containers/commands/ListVirtualClustersCommand.ts b/clients/client-emr-containers/commands/ListVirtualClustersCommand.ts index b43dccb6454e..8f528d0f019d 100644 --- a/clients/client-emr-containers/commands/ListVirtualClustersCommand.ts +++ b/clients/client-emr-containers/commands/ListVirtualClustersCommand.ts @@ -22,6 +22,20 @@ export interface ListVirtualClustersCommandOutput extends ListVirtualClustersRes /** *

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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { EMRContainersClient, ListVirtualClustersCommand } from "@aws-sdk/client-emr-containers"; // ES Modules import + * // const { EMRContainersClient, ListVirtualClustersCommand } = require("@aws-sdk/client-emr-containers"); // CommonJS import + * const client = new EMRContainersClient(config); + * const command = new ListVirtualClustersCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListVirtualClustersCommandInput} for command's `input` shape. + * @see {@link ListVirtualClustersCommandOutput} for command's `response` shape. + * @see {@link EMRContainersClientResolvedConfig | config} for command's `input` shape. + * */ export class ListVirtualClustersCommand extends $Command< ListVirtualClustersCommandInput, diff --git a/clients/client-emr-containers/commands/StartJobRunCommand.ts b/clients/client-emr-containers/commands/StartJobRunCommand.ts index 9eedc7cfe587..5326efc3e154 100644 --- a/clients/client-emr-containers/commands/StartJobRunCommand.ts +++ b/clients/client-emr-containers/commands/StartJobRunCommand.ts @@ -22,6 +22,20 @@ export interface StartJobRunCommandOutput extends StartJobRunResponse, __Metadat /** *

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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { EMRContainersClient, StartJobRunCommand } from "@aws-sdk/client-emr-containers"; // ES Modules import + * // const { EMRContainersClient, StartJobRunCommand } = require("@aws-sdk/client-emr-containers"); // CommonJS import + * const client = new EMRContainersClient(config); + * const command = new StartJobRunCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link StartJobRunCommandInput} for command's `input` shape. + * @see {@link StartJobRunCommandOutput} for command's `response` shape. + * @see {@link EMRContainersClientResolvedConfig | config} for command's `input` shape. + * */ export class StartJobRunCommand extends $Command< StartJobRunCommandInput, diff --git a/clients/client-emr-containers/commands/TagResourceCommand.ts b/clients/client-emr-containers/commands/TagResourceCommand.ts index fe61a8734204..64dd19116fea 100644 --- a/clients/client-emr-containers/commands/TagResourceCommand.ts +++ b/clients/client-emr-containers/commands/TagResourceCommand.ts @@ -22,6 +22,20 @@ export interface TagResourceCommandOutput extends TagResourceResponse, __Metadat /** *

Assigns tags to resources. A tag is a label that you assign to an AWS resource. Each tag consists of a key and an optional value, both of which you define. Tags enable you to categorize your AWS 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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { EMRContainersClient, TagResourceCommand } from "@aws-sdk/client-emr-containers"; // ES Modules import + * // const { EMRContainersClient, TagResourceCommand } = require("@aws-sdk/client-emr-containers"); // CommonJS import + * const client = new EMRContainersClient(config); + * const command = new TagResourceCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link TagResourceCommandInput} for command's `input` shape. + * @see {@link TagResourceCommandOutput} for command's `response` shape. + * @see {@link EMRContainersClientResolvedConfig | config} for command's `input` shape. + * */ export class TagResourceCommand extends $Command< TagResourceCommandInput, diff --git a/clients/client-emr-containers/commands/UntagResourceCommand.ts b/clients/client-emr-containers/commands/UntagResourceCommand.ts index 6f68c9348098..3fc7909797ee 100644 --- a/clients/client-emr-containers/commands/UntagResourceCommand.ts +++ b/clients/client-emr-containers/commands/UntagResourceCommand.ts @@ -22,6 +22,20 @@ export interface UntagResourceCommandOutput extends UntagResourceResponse, __Met /** *

Removes tags from resources.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { EMRContainersClient, UntagResourceCommand } from "@aws-sdk/client-emr-containers"; // ES Modules import + * // const { EMRContainersClient, UntagResourceCommand } = require("@aws-sdk/client-emr-containers"); // CommonJS import + * const client = new EMRContainersClient(config); + * const command = new UntagResourceCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link UntagResourceCommandInput} for command's `input` shape. + * @see {@link UntagResourceCommandOutput} for command's `response` shape. + * @see {@link EMRContainersClientResolvedConfig | config} for command's `input` shape. + * */ export class UntagResourceCommand extends $Command< UntagResourceCommandInput, diff --git a/clients/client-emr-containers/models/models_0.ts b/clients/client-emr-containers/models/models_0.ts index 0c342cb2fa71..01b8299c0ee9 100644 --- a/clients/client-emr-containers/models/models_0.ts +++ b/clients/client-emr-containers/models/models_0.ts @@ -14,6 +14,9 @@ export interface CancelJobRunRequest { } export namespace CancelJobRunRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: CancelJobRunRequest): any => ({ ...obj, }); @@ -32,6 +35,9 @@ export interface CancelJobRunResponse { } export namespace CancelJobRunResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: CancelJobRunResponse): any => ({ ...obj, }); @@ -47,6 +53,9 @@ export interface InternalServerException extends __SmithyException, $MetadataBea } export namespace InternalServerException { + /** + * @internal + */ export const filterSensitiveLog = (obj: InternalServerException): any => ({ ...obj, }); @@ -62,6 +71,9 @@ export interface ValidationException extends __SmithyException, $MetadataBearer } export namespace ValidationException { + /** + * @internal + */ export const filterSensitiveLog = (obj: ValidationException): any => ({ ...obj, }); @@ -83,6 +95,9 @@ export interface CloudWatchMonitoringConfiguration { } export namespace CloudWatchMonitoringConfiguration { + /** + * @internal + */ export const filterSensitiveLog = (obj: CloudWatchMonitoringConfiguration): any => ({ ...obj, }); @@ -104,6 +119,9 @@ export interface S3MonitoringConfiguration { } export namespace S3MonitoringConfiguration { + /** + * @internal + */ export const filterSensitiveLog = (obj: S3MonitoringConfiguration): any => ({ ...obj, }); @@ -130,6 +148,9 @@ export interface MonitoringConfiguration { } export namespace MonitoringConfiguration { + /** + * @internal + */ export const filterSensitiveLog = (obj: MonitoringConfiguration): any => ({ ...obj, }); @@ -158,6 +179,9 @@ export interface CreateManagedEndpointResponse { } export namespace CreateManagedEndpointResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateManagedEndpointResponse): any => ({ ...obj, }); @@ -173,6 +197,9 @@ export interface ResourceNotFoundException extends __SmithyException, $MetadataB } export namespace ResourceNotFoundException { + /** + * @internal + */ export const filterSensitiveLog = (obj: ResourceNotFoundException): any => ({ ...obj, }); @@ -189,6 +216,9 @@ export interface EksInfo { } export namespace EksInfo { + /** + * @internal + */ export const filterSensitiveLog = (obj: EksInfo): any => ({ ...obj, }); @@ -223,6 +253,9 @@ export namespace ContainerInfo { return visitor._(value.$unknown[0], value.$unknown[1]); }; + /** + * @internal + */ export const filterSensitiveLog = (obj: ContainerInfo): any => { if (obj.eksInfo !== undefined) return { eksInfo: EksInfo.filterSensitiveLog(obj.eksInfo) }; if (obj.$unknown !== undefined) return { [obj.$unknown[0]]: "UNKNOWN" }; @@ -254,6 +287,9 @@ export interface ContainerProvider { } export namespace ContainerProvider { + /** + * @internal + */ export const filterSensitiveLog = (obj: ContainerProvider): any => ({ ...obj, ...(obj.info && { info: ContainerInfo.filterSensitiveLog(obj.info) }), @@ -283,6 +319,9 @@ export interface CreateVirtualClusterRequest { } export namespace CreateVirtualClusterRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateVirtualClusterRequest): any => ({ ...obj, ...(obj.containerProvider && { containerProvider: ContainerProvider.filterSensitiveLog(obj.containerProvider) }), @@ -307,6 +346,9 @@ export interface CreateVirtualClusterResponse { } export namespace CreateVirtualClusterResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateVirtualClusterResponse): any => ({ ...obj, }); @@ -325,6 +367,9 @@ export interface DeleteManagedEndpointRequest { } export namespace DeleteManagedEndpointRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteManagedEndpointRequest): any => ({ ...obj, }); @@ -343,6 +388,9 @@ export interface DeleteManagedEndpointResponse { } export namespace DeleteManagedEndpointResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteManagedEndpointResponse): any => ({ ...obj, }); @@ -356,6 +404,9 @@ export interface DeleteVirtualClusterRequest { } export namespace DeleteVirtualClusterRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteVirtualClusterRequest): any => ({ ...obj, }); @@ -369,6 +420,9 @@ export interface DeleteVirtualClusterResponse { } export namespace DeleteVirtualClusterResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteVirtualClusterResponse): any => ({ ...obj, }); @@ -387,6 +441,9 @@ export interface DescribeJobRunRequest { } export namespace DescribeJobRunRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeJobRunRequest): any => ({ ...obj, }); @@ -420,6 +477,9 @@ export interface SparkSubmitJobDriver { } export namespace SparkSubmitJobDriver { + /** + * @internal + */ export const filterSensitiveLog = (obj: SparkSubmitJobDriver): any => ({ ...obj, ...(obj.entryPoint && { entryPoint: SENSITIVE_STRING }), @@ -439,6 +499,9 @@ export interface JobDriver { } export namespace JobDriver { + /** + * @internal + */ export const filterSensitiveLog = (obj: JobDriver): any => ({ ...obj, ...(obj.sparkSubmitJobDriver && { @@ -470,6 +533,9 @@ export interface DescribeManagedEndpointRequest { } export namespace DescribeManagedEndpointRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeManagedEndpointRequest): any => ({ ...obj, }); @@ -491,6 +557,9 @@ export interface DescribeVirtualClusterRequest { } export namespace DescribeVirtualClusterRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeVirtualClusterRequest): any => ({ ...obj, }); @@ -544,6 +613,9 @@ export interface VirtualCluster { } export namespace VirtualCluster { + /** + * @internal + */ export const filterSensitiveLog = (obj: VirtualCluster): any => ({ ...obj, ...(obj.containerProvider && { containerProvider: ContainerProvider.filterSensitiveLog(obj.containerProvider) }), @@ -558,6 +630,9 @@ export interface DescribeVirtualClusterResponse { } export namespace DescribeVirtualClusterResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeVirtualClusterResponse): any => ({ ...obj, ...(obj.virtualCluster && { virtualCluster: VirtualCluster.filterSensitiveLog(obj.virtualCluster) }), @@ -602,6 +677,9 @@ export interface ListJobRunsRequest { } export namespace ListJobRunsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListJobRunsRequest): any => ({ ...obj, }); @@ -645,6 +723,9 @@ export interface ListManagedEndpointsRequest { } export namespace ListManagedEndpointsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListManagedEndpointsRequest): any => ({ ...obj, }); @@ -658,6 +739,9 @@ export interface ListTagsForResourceRequest { } export namespace ListTagsForResourceRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListTagsForResourceRequest): any => ({ ...obj, }); @@ -671,6 +755,9 @@ export interface ListTagsForResourceResponse { } export namespace ListTagsForResourceResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListTagsForResourceResponse): any => ({ ...obj, }); @@ -714,6 +801,9 @@ export interface ListVirtualClustersRequest { } export namespace ListVirtualClustersRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListVirtualClustersRequest): any => ({ ...obj, }); @@ -732,6 +822,9 @@ export interface ListVirtualClustersResponse { } export namespace ListVirtualClustersResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListVirtualClustersResponse): any => ({ ...obj, ...(obj.virtualClusters && { @@ -763,6 +856,9 @@ export interface StartJobRunResponse { } export namespace StartJobRunResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: StartJobRunResponse): any => ({ ...obj, }); @@ -781,6 +877,9 @@ export interface TagResourceRequest { } export namespace TagResourceRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: TagResourceRequest): any => ({ ...obj, }); @@ -789,6 +888,9 @@ export namespace TagResourceRequest { export interface TagResourceResponse {} export namespace TagResourceResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: TagResourceResponse): any => ({ ...obj, }); @@ -807,6 +909,9 @@ export interface UntagResourceRequest { } export namespace UntagResourceRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: UntagResourceRequest): any => ({ ...obj, }); @@ -815,6 +920,9 @@ export namespace UntagResourceRequest { export interface UntagResourceResponse {} export namespace UntagResourceResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: UntagResourceResponse): any => ({ ...obj, }); @@ -841,6 +949,9 @@ export interface Configuration { } export namespace Configuration { + /** + * @internal + */ export const filterSensitiveLog = (obj: Configuration): any => ({ ...obj, ...(obj.properties && { properties: SENSITIVE_STRING }), @@ -866,6 +977,9 @@ export interface ConfigurationOverrides { } export namespace ConfigurationOverrides { + /** + * @internal + */ export const filterSensitiveLog = (obj: ConfigurationOverrides): any => ({ ...obj, ...(obj.applicationConfiguration && { @@ -923,6 +1037,9 @@ export interface CreateManagedEndpointRequest { } export namespace CreateManagedEndpointRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateManagedEndpointRequest): any => ({ ...obj, ...(obj.configurationOverrides && { @@ -1015,6 +1132,9 @@ export interface Endpoint { } export namespace Endpoint { + /** + * @internal + */ export const filterSensitiveLog = (obj: Endpoint): any => ({ ...obj, ...(obj.configurationOverrides && { @@ -1109,6 +1229,9 @@ export interface JobRun { } export namespace JobRun { + /** + * @internal + */ export const filterSensitiveLog = (obj: JobRun): any => ({ ...obj, ...(obj.configurationOverrides && { @@ -1161,6 +1284,9 @@ export interface StartJobRunRequest { } export namespace StartJobRunRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: StartJobRunRequest): any => ({ ...obj, ...(obj.jobDriver && { jobDriver: JobDriver.filterSensitiveLog(obj.jobDriver) }), @@ -1178,6 +1304,9 @@ export interface DescribeJobRunResponse { } export namespace DescribeJobRunResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeJobRunResponse): any => ({ ...obj, ...(obj.jobRun && { jobRun: JobRun.filterSensitiveLog(obj.jobRun) }), @@ -1192,6 +1321,9 @@ export interface DescribeManagedEndpointResponse { } export namespace DescribeManagedEndpointResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeManagedEndpointResponse): any => ({ ...obj, ...(obj.endpoint && { endpoint: Endpoint.filterSensitiveLog(obj.endpoint) }), @@ -1211,6 +1343,9 @@ export interface ListJobRunsResponse { } export namespace ListJobRunsResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListJobRunsResponse): any => ({ ...obj, ...(obj.jobRuns && { jobRuns: obj.jobRuns.map((item) => JobRun.filterSensitiveLog(item)) }), @@ -1230,6 +1365,9 @@ export interface ListManagedEndpointsResponse { } export namespace ListManagedEndpointsResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListManagedEndpointsResponse): any => ({ ...obj, }); diff --git a/clients/client-emr/commands/AddInstanceFleetCommand.ts b/clients/client-emr/commands/AddInstanceFleetCommand.ts index d14c715ba73c..d1de6ac031b1 100644 --- a/clients/client-emr/commands/AddInstanceFleetCommand.ts +++ b/clients/client-emr/commands/AddInstanceFleetCommand.ts @@ -26,6 +26,20 @@ export interface AddInstanceFleetCommandOutput extends AddInstanceFleetOutput, _ *

The instance fleet configuration is available only in Amazon EMR versions 4.8.0 and * later, excluding 5.0.x.

* + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { EMRClient, AddInstanceFleetCommand } from "@aws-sdk/client-emr"; // ES Modules import + * // const { EMRClient, AddInstanceFleetCommand } = require("@aws-sdk/client-emr"); // CommonJS import + * const client = new EMRClient(config); + * const command = new AddInstanceFleetCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link AddInstanceFleetCommandInput} for command's `input` shape. + * @see {@link AddInstanceFleetCommandOutput} for command's `response` shape. + * @see {@link EMRClientResolvedConfig | config} for command's `input` shape. + * */ export class AddInstanceFleetCommand extends $Command< AddInstanceFleetCommandInput, diff --git a/clients/client-emr/commands/AddInstanceGroupsCommand.ts b/clients/client-emr/commands/AddInstanceGroupsCommand.ts index 69501533d0a7..f5070aa69360 100644 --- a/clients/client-emr/commands/AddInstanceGroupsCommand.ts +++ b/clients/client-emr/commands/AddInstanceGroupsCommand.ts @@ -22,6 +22,20 @@ export interface AddInstanceGroupsCommandOutput extends AddInstanceGroupsOutput, /** *

Adds one or more instance groups to a running cluster.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { EMRClient, AddInstanceGroupsCommand } from "@aws-sdk/client-emr"; // ES Modules import + * // const { EMRClient, AddInstanceGroupsCommand } = require("@aws-sdk/client-emr"); // CommonJS import + * const client = new EMRClient(config); + * const command = new AddInstanceGroupsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link AddInstanceGroupsCommandInput} for command's `input` shape. + * @see {@link AddInstanceGroupsCommandOutput} for command's `response` shape. + * @see {@link EMRClientResolvedConfig | config} for command's `input` shape. + * */ export class AddInstanceGroupsCommand extends $Command< AddInstanceGroupsCommandInput, diff --git a/clients/client-emr/commands/AddJobFlowStepsCommand.ts b/clients/client-emr/commands/AddJobFlowStepsCommand.ts index 2b3375e5594c..11727ef9a4f9 100644 --- a/clients/client-emr/commands/AddJobFlowStepsCommand.ts +++ b/clients/client-emr/commands/AddJobFlowStepsCommand.ts @@ -38,6 +38,20 @@ export interface AddJobFlowStepsCommandOutput extends AddJobFlowStepsOutput, __M * 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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { EMRClient, AddJobFlowStepsCommand } from "@aws-sdk/client-emr"; // ES Modules import + * // const { EMRClient, AddJobFlowStepsCommand } = require("@aws-sdk/client-emr"); // CommonJS import + * const client = new EMRClient(config); + * const command = new AddJobFlowStepsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link AddJobFlowStepsCommandInput} for command's `input` shape. + * @see {@link AddJobFlowStepsCommandOutput} for command's `response` shape. + * @see {@link EMRClientResolvedConfig | config} for command's `input` shape. + * */ export class AddJobFlowStepsCommand extends $Command< AddJobFlowStepsCommandInput, diff --git a/clients/client-emr/commands/AddTagsCommand.ts b/clients/client-emr/commands/AddTagsCommand.ts index d834d03ae039..e3d339b69483 100644 --- a/clients/client-emr/commands/AddTagsCommand.ts +++ b/clients/client-emr/commands/AddTagsCommand.ts @@ -21,6 +21,20 @@ export interface AddTagsCommandOutput extends AddTagsOutput, __MetadataBearer {} *

Adds tags to an Amazon EMR resource. Tags make it easier to associate clusters in * various ways, such as grouping clusters to track your Amazon EMR resource allocation costs. * For more information, see Tag Clusters.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { EMRClient, AddTagsCommand } from "@aws-sdk/client-emr"; // ES Modules import + * // const { EMRClient, AddTagsCommand } = require("@aws-sdk/client-emr"); // CommonJS import + * const client = new EMRClient(config); + * const command = new AddTagsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link AddTagsCommandInput} for command's `input` shape. + * @see {@link AddTagsCommandOutput} for command's `response` shape. + * @see {@link EMRClientResolvedConfig | config} for command's `input` shape. + * */ export class AddTagsCommand extends $Command { // Start section: command_properties diff --git a/clients/client-emr/commands/CancelStepsCommand.ts b/clients/client-emr/commands/CancelStepsCommand.ts index 95c73e675a98..08ed5f6b5083 100644 --- a/clients/client-emr/commands/CancelStepsCommand.ts +++ b/clients/client-emr/commands/CancelStepsCommand.ts @@ -26,6 +26,20 @@ export interface CancelStepsCommandOutput extends CancelStepsOutput, __MetadataB * 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. You can only * cancel steps that are in a PENDING state.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { EMRClient, CancelStepsCommand } from "@aws-sdk/client-emr"; // ES Modules import + * // const { EMRClient, CancelStepsCommand } = require("@aws-sdk/client-emr"); // CommonJS import + * const client = new EMRClient(config); + * const command = new CancelStepsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CancelStepsCommandInput} for command's `input` shape. + * @see {@link CancelStepsCommandOutput} for command's `response` shape. + * @see {@link EMRClientResolvedConfig | config} for command's `input` shape. + * */ export class CancelStepsCommand extends $Command< CancelStepsCommandInput, diff --git a/clients/client-emr/commands/CreateSecurityConfigurationCommand.ts b/clients/client-emr/commands/CreateSecurityConfigurationCommand.ts index 570c9f51def0..f4a8899ca729 100644 --- a/clients/client-emr/commands/CreateSecurityConfigurationCommand.ts +++ b/clients/client-emr/commands/CreateSecurityConfigurationCommand.ts @@ -23,6 +23,20 @@ export interface CreateSecurityConfigurationCommandOutput extends CreateSecurity /** *

Creates a security configuration, which is stored in the service and can be specified * when a cluster is created.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { EMRClient, CreateSecurityConfigurationCommand } from "@aws-sdk/client-emr"; // ES Modules import + * // const { EMRClient, CreateSecurityConfigurationCommand } = require("@aws-sdk/client-emr"); // CommonJS import + * const client = new EMRClient(config); + * const command = new CreateSecurityConfigurationCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreateSecurityConfigurationCommandInput} for command's `input` shape. + * @see {@link CreateSecurityConfigurationCommandOutput} for command's `response` shape. + * @see {@link EMRClientResolvedConfig | config} for command's `input` shape. + * */ export class CreateSecurityConfigurationCommand extends $Command< CreateSecurityConfigurationCommandInput, diff --git a/clients/client-emr/commands/CreateStudioCommand.ts b/clients/client-emr/commands/CreateStudioCommand.ts index fbb523cc800b..450fe2e3c2cf 100644 --- a/clients/client-emr/commands/CreateStudioCommand.ts +++ b/clients/client-emr/commands/CreateStudioCommand.ts @@ -22,6 +22,20 @@ export interface CreateStudioCommandOutput extends CreateStudioOutput, __Metadat /** *

Creates a new Amazon EMR Studio.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { EMRClient, CreateStudioCommand } from "@aws-sdk/client-emr"; // ES Modules import + * // const { EMRClient, CreateStudioCommand } = require("@aws-sdk/client-emr"); // CommonJS import + * const client = new EMRClient(config); + * const command = new CreateStudioCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreateStudioCommandInput} for command's `input` shape. + * @see {@link CreateStudioCommandOutput} for command's `response` shape. + * @see {@link EMRClientResolvedConfig | config} for command's `input` shape. + * */ export class CreateStudioCommand extends $Command< CreateStudioCommandInput, diff --git a/clients/client-emr/commands/CreateStudioSessionMappingCommand.ts b/clients/client-emr/commands/CreateStudioSessionMappingCommand.ts index 12f03c53a70f..f1cd8ac1470f 100644 --- a/clients/client-emr/commands/CreateStudioSessionMappingCommand.ts +++ b/clients/client-emr/commands/CreateStudioSessionMappingCommand.ts @@ -23,6 +23,20 @@ export interface CreateStudioSessionMappingCommandOutput extends __MetadataBeare /** *

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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { EMRClient, CreateStudioSessionMappingCommand } from "@aws-sdk/client-emr"; // ES Modules import + * // const { EMRClient, CreateStudioSessionMappingCommand } = require("@aws-sdk/client-emr"); // CommonJS import + * const client = new EMRClient(config); + * const command = new CreateStudioSessionMappingCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreateStudioSessionMappingCommandInput} for command's `input` shape. + * @see {@link CreateStudioSessionMappingCommandOutput} for command's `response` shape. + * @see {@link EMRClientResolvedConfig | config} for command's `input` shape. + * */ export class CreateStudioSessionMappingCommand extends $Command< CreateStudioSessionMappingCommandInput, diff --git a/clients/client-emr/commands/DeleteSecurityConfigurationCommand.ts b/clients/client-emr/commands/DeleteSecurityConfigurationCommand.ts index ca6b3ed77925..49129908317a 100644 --- a/clients/client-emr/commands/DeleteSecurityConfigurationCommand.ts +++ b/clients/client-emr/commands/DeleteSecurityConfigurationCommand.ts @@ -22,6 +22,20 @@ export interface DeleteSecurityConfigurationCommandOutput extends DeleteSecurity /** *

Deletes a security configuration.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { EMRClient, DeleteSecurityConfigurationCommand } from "@aws-sdk/client-emr"; // ES Modules import + * // const { EMRClient, DeleteSecurityConfigurationCommand } = require("@aws-sdk/client-emr"); // CommonJS import + * const client = new EMRClient(config); + * const command = new DeleteSecurityConfigurationCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteSecurityConfigurationCommandInput} for command's `input` shape. + * @see {@link DeleteSecurityConfigurationCommandOutput} for command's `response` shape. + * @see {@link EMRClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteSecurityConfigurationCommand extends $Command< DeleteSecurityConfigurationCommandInput, diff --git a/clients/client-emr/commands/DeleteStudioCommand.ts b/clients/client-emr/commands/DeleteStudioCommand.ts index aef55bdb27cb..3a3731e17029 100644 --- a/clients/client-emr/commands/DeleteStudioCommand.ts +++ b/clients/client-emr/commands/DeleteStudioCommand.ts @@ -22,6 +22,20 @@ export interface DeleteStudioCommandOutput extends __MetadataBearer {} /** *

Removes an Amazon EMR Studio from the Studio metadata store.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { EMRClient, DeleteStudioCommand } from "@aws-sdk/client-emr"; // ES Modules import + * // const { EMRClient, DeleteStudioCommand } = require("@aws-sdk/client-emr"); // CommonJS import + * const client = new EMRClient(config); + * const command = new DeleteStudioCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteStudioCommandInput} for command's `input` shape. + * @see {@link DeleteStudioCommandOutput} for command's `response` shape. + * @see {@link EMRClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteStudioCommand extends $Command< DeleteStudioCommandInput, diff --git a/clients/client-emr/commands/DeleteStudioSessionMappingCommand.ts b/clients/client-emr/commands/DeleteStudioSessionMappingCommand.ts index 8f56629e2ec7..1538981e88d6 100644 --- a/clients/client-emr/commands/DeleteStudioSessionMappingCommand.ts +++ b/clients/client-emr/commands/DeleteStudioSessionMappingCommand.ts @@ -22,6 +22,20 @@ export interface DeleteStudioSessionMappingCommandOutput extends __MetadataBeare /** *

Removes a user or group from an Amazon EMR Studio.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { EMRClient, DeleteStudioSessionMappingCommand } from "@aws-sdk/client-emr"; // ES Modules import + * // const { EMRClient, DeleteStudioSessionMappingCommand } = require("@aws-sdk/client-emr"); // CommonJS import + * const client = new EMRClient(config); + * const command = new DeleteStudioSessionMappingCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteStudioSessionMappingCommandInput} for command's `input` shape. + * @see {@link DeleteStudioSessionMappingCommandOutput} for command's `response` shape. + * @see {@link EMRClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteStudioSessionMappingCommand extends $Command< DeleteStudioSessionMappingCommandInput, diff --git a/clients/client-emr/commands/DescribeClusterCommand.ts b/clients/client-emr/commands/DescribeClusterCommand.ts index e13bb7f22a1e..0da2c42b4bec 100644 --- a/clients/client-emr/commands/DescribeClusterCommand.ts +++ b/clients/client-emr/commands/DescribeClusterCommand.ts @@ -23,6 +23,20 @@ export interface DescribeClusterCommandOutput extends DescribeClusterOutput, __M /** *

Provides cluster-level details including status, hardware and software configuration, * VPC settings, and so on.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { EMRClient, DescribeClusterCommand } from "@aws-sdk/client-emr"; // ES Modules import + * // const { EMRClient, DescribeClusterCommand } = require("@aws-sdk/client-emr"); // CommonJS import + * const client = new EMRClient(config); + * const command = new DescribeClusterCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeClusterCommandInput} for command's `input` shape. + * @see {@link DescribeClusterCommandOutput} for command's `response` shape. + * @see {@link EMRClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeClusterCommand extends $Command< DescribeClusterCommandInput, diff --git a/clients/client-emr/commands/DescribeJobFlowsCommand.ts b/clients/client-emr/commands/DescribeJobFlowsCommand.ts index d630c11d398c..ecacf3bf50ed 100644 --- a/clients/client-emr/commands/DescribeJobFlowsCommand.ts +++ b/clients/client-emr/commands/DescribeJobFlowsCommand.ts @@ -44,6 +44,20 @@ export interface DescribeJobFlowsCommandOutput extends DescribeJobFlowsOutput, _ * * *

Amazon EMR can return a maximum of 512 job flow descriptions.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { EMRClient, DescribeJobFlowsCommand } from "@aws-sdk/client-emr"; // ES Modules import + * // const { EMRClient, DescribeJobFlowsCommand } = require("@aws-sdk/client-emr"); // CommonJS import + * const client = new EMRClient(config); + * const command = new DescribeJobFlowsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeJobFlowsCommandInput} for command's `input` shape. + * @see {@link DescribeJobFlowsCommandOutput} for command's `response` shape. + * @see {@link EMRClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeJobFlowsCommand extends $Command< DescribeJobFlowsCommandInput, diff --git a/clients/client-emr/commands/DescribeNotebookExecutionCommand.ts b/clients/client-emr/commands/DescribeNotebookExecutionCommand.ts index b37cfc95f4ed..d68f22b1960b 100644 --- a/clients/client-emr/commands/DescribeNotebookExecutionCommand.ts +++ b/clients/client-emr/commands/DescribeNotebookExecutionCommand.ts @@ -22,6 +22,20 @@ export interface DescribeNotebookExecutionCommandOutput extends DescribeNotebook /** *

Provides details of a notebook execution.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { EMRClient, DescribeNotebookExecutionCommand } from "@aws-sdk/client-emr"; // ES Modules import + * // const { EMRClient, DescribeNotebookExecutionCommand } = require("@aws-sdk/client-emr"); // CommonJS import + * const client = new EMRClient(config); + * const command = new DescribeNotebookExecutionCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeNotebookExecutionCommandInput} for command's `input` shape. + * @see {@link DescribeNotebookExecutionCommandOutput} for command's `response` shape. + * @see {@link EMRClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeNotebookExecutionCommand extends $Command< DescribeNotebookExecutionCommandInput, diff --git a/clients/client-emr/commands/DescribeSecurityConfigurationCommand.ts b/clients/client-emr/commands/DescribeSecurityConfigurationCommand.ts index 7c52a0873f5d..52f08a63b3e4 100644 --- a/clients/client-emr/commands/DescribeSecurityConfigurationCommand.ts +++ b/clients/client-emr/commands/DescribeSecurityConfigurationCommand.ts @@ -25,6 +25,20 @@ export interface DescribeSecurityConfigurationCommandOutput /** *

Provides the details of a security configuration by returning the configuration * JSON.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { EMRClient, DescribeSecurityConfigurationCommand } from "@aws-sdk/client-emr"; // ES Modules import + * // const { EMRClient, DescribeSecurityConfigurationCommand } = require("@aws-sdk/client-emr"); // CommonJS import + * const client = new EMRClient(config); + * const command = new DescribeSecurityConfigurationCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeSecurityConfigurationCommandInput} for command's `input` shape. + * @see {@link DescribeSecurityConfigurationCommandOutput} for command's `response` shape. + * @see {@link EMRClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeSecurityConfigurationCommand extends $Command< DescribeSecurityConfigurationCommandInput, diff --git a/clients/client-emr/commands/DescribeStepCommand.ts b/clients/client-emr/commands/DescribeStepCommand.ts index c4168eee3425..528cf23c76f8 100644 --- a/clients/client-emr/commands/DescribeStepCommand.ts +++ b/clients/client-emr/commands/DescribeStepCommand.ts @@ -22,6 +22,20 @@ export interface DescribeStepCommandOutput extends DescribeStepOutput, __Metadat /** *

Provides more detail about the cluster step.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { EMRClient, DescribeStepCommand } from "@aws-sdk/client-emr"; // ES Modules import + * // const { EMRClient, DescribeStepCommand } = require("@aws-sdk/client-emr"); // CommonJS import + * const client = new EMRClient(config); + * const command = new DescribeStepCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeStepCommandInput} for command's `input` shape. + * @see {@link DescribeStepCommandOutput} for command's `response` shape. + * @see {@link EMRClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeStepCommand extends $Command< DescribeStepCommandInput, diff --git a/clients/client-emr/commands/DescribeStudioCommand.ts b/clients/client-emr/commands/DescribeStudioCommand.ts index 60369b47a95d..b9d348b0083e 100644 --- a/clients/client-emr/commands/DescribeStudioCommand.ts +++ b/clients/client-emr/commands/DescribeStudioCommand.ts @@ -23,6 +23,20 @@ export interface DescribeStudioCommandOutput extends DescribeStudioOutput, __Met /** *

Returns details for the specified Amazon EMR Studio including ID, Name, VPC, Studio * access URL, and so on.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { EMRClient, DescribeStudioCommand } from "@aws-sdk/client-emr"; // ES Modules import + * // const { EMRClient, DescribeStudioCommand } = require("@aws-sdk/client-emr"); // CommonJS import + * const client = new EMRClient(config); + * const command = new DescribeStudioCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeStudioCommandInput} for command's `input` shape. + * @see {@link DescribeStudioCommandOutput} for command's `response` shape. + * @see {@link EMRClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeStudioCommand extends $Command< DescribeStudioCommandInput, diff --git a/clients/client-emr/commands/GetBlockPublicAccessConfigurationCommand.ts b/clients/client-emr/commands/GetBlockPublicAccessConfigurationCommand.ts index 8d114d3721b0..aa85fcde07e1 100644 --- a/clients/client-emr/commands/GetBlockPublicAccessConfigurationCommand.ts +++ b/clients/client-emr/commands/GetBlockPublicAccessConfigurationCommand.ts @@ -27,6 +27,20 @@ export interface GetBlockPublicAccessConfigurationCommandOutput * current Region. For more information see Configure Block * Public Access for Amazon EMR in the Amazon EMR Management * Guide.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { EMRClient, GetBlockPublicAccessConfigurationCommand } from "@aws-sdk/client-emr"; // ES Modules import + * // const { EMRClient, GetBlockPublicAccessConfigurationCommand } = require("@aws-sdk/client-emr"); // CommonJS import + * const client = new EMRClient(config); + * const command = new GetBlockPublicAccessConfigurationCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetBlockPublicAccessConfigurationCommandInput} for command's `input` shape. + * @see {@link GetBlockPublicAccessConfigurationCommandOutput} for command's `response` shape. + * @see {@link EMRClientResolvedConfig | config} for command's `input` shape. + * */ export class GetBlockPublicAccessConfigurationCommand extends $Command< GetBlockPublicAccessConfigurationCommandInput, diff --git a/clients/client-emr/commands/GetManagedScalingPolicyCommand.ts b/clients/client-emr/commands/GetManagedScalingPolicyCommand.ts index 878f2ba5af89..06135352ba10 100644 --- a/clients/client-emr/commands/GetManagedScalingPolicyCommand.ts +++ b/clients/client-emr/commands/GetManagedScalingPolicyCommand.ts @@ -22,6 +22,20 @@ export interface GetManagedScalingPolicyCommandOutput extends GetManagedScalingP /** *

Fetches the attached managed scaling policy for an Amazon EMR cluster.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { EMRClient, GetManagedScalingPolicyCommand } from "@aws-sdk/client-emr"; // ES Modules import + * // const { EMRClient, GetManagedScalingPolicyCommand } = require("@aws-sdk/client-emr"); // CommonJS import + * const client = new EMRClient(config); + * const command = new GetManagedScalingPolicyCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetManagedScalingPolicyCommandInput} for command's `input` shape. + * @see {@link GetManagedScalingPolicyCommandOutput} for command's `response` shape. + * @see {@link EMRClientResolvedConfig | config} for command's `input` shape. + * */ export class GetManagedScalingPolicyCommand extends $Command< GetManagedScalingPolicyCommandInput, diff --git a/clients/client-emr/commands/GetStudioSessionMappingCommand.ts b/clients/client-emr/commands/GetStudioSessionMappingCommand.ts index bd4f17ae896f..d71e00df8887 100644 --- a/clients/client-emr/commands/GetStudioSessionMappingCommand.ts +++ b/clients/client-emr/commands/GetStudioSessionMappingCommand.ts @@ -23,6 +23,20 @@ export interface GetStudioSessionMappingCommandOutput extends GetStudioSessionMa /** *

Fetches mapping details for the specified Amazon EMR Studio and identity (user or * group).

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { EMRClient, GetStudioSessionMappingCommand } from "@aws-sdk/client-emr"; // ES Modules import + * // const { EMRClient, GetStudioSessionMappingCommand } = require("@aws-sdk/client-emr"); // CommonJS import + * const client = new EMRClient(config); + * const command = new GetStudioSessionMappingCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetStudioSessionMappingCommandInput} for command's `input` shape. + * @see {@link GetStudioSessionMappingCommandOutput} for command's `response` shape. + * @see {@link EMRClientResolvedConfig | config} for command's `input` shape. + * */ export class GetStudioSessionMappingCommand extends $Command< GetStudioSessionMappingCommandInput, diff --git a/clients/client-emr/commands/ListBootstrapActionsCommand.ts b/clients/client-emr/commands/ListBootstrapActionsCommand.ts index 6203a20c8477..9c1759eb1f58 100644 --- a/clients/client-emr/commands/ListBootstrapActionsCommand.ts +++ b/clients/client-emr/commands/ListBootstrapActionsCommand.ts @@ -22,6 +22,20 @@ export interface ListBootstrapActionsCommandOutput extends ListBootstrapActionsO /** *

Provides information about the bootstrap actions associated with a cluster.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { EMRClient, ListBootstrapActionsCommand } from "@aws-sdk/client-emr"; // ES Modules import + * // const { EMRClient, ListBootstrapActionsCommand } = require("@aws-sdk/client-emr"); // CommonJS import + * const client = new EMRClient(config); + * const command = new ListBootstrapActionsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListBootstrapActionsCommandInput} for command's `input` shape. + * @see {@link ListBootstrapActionsCommandOutput} for command's `response` shape. + * @see {@link EMRClientResolvedConfig | config} for command's `input` shape. + * */ export class ListBootstrapActionsCommand extends $Command< ListBootstrapActionsCommandInput, diff --git a/clients/client-emr/commands/ListClustersCommand.ts b/clients/client-emr/commands/ListClustersCommand.ts index 4295ab53451f..e701e2d40ca6 100644 --- a/clients/client-emr/commands/ListClustersCommand.ts +++ b/clients/client-emr/commands/ListClustersCommand.ts @@ -26,6 +26,20 @@ export interface ListClustersCommandOutput extends ListClustersOutput, __Metadat * date and time or by status. This call returns a maximum of 50 clusters per call, but * returns a marker to track the paging of the cluster list across multiple ListClusters * calls.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { EMRClient, ListClustersCommand } from "@aws-sdk/client-emr"; // ES Modules import + * // const { EMRClient, ListClustersCommand } = require("@aws-sdk/client-emr"); // CommonJS import + * const client = new EMRClient(config); + * const command = new ListClustersCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListClustersCommandInput} for command's `input` shape. + * @see {@link ListClustersCommandOutput} for command's `response` shape. + * @see {@link EMRClientResolvedConfig | config} for command's `input` shape. + * */ export class ListClustersCommand extends $Command< ListClustersCommandInput, diff --git a/clients/client-emr/commands/ListInstanceFleetsCommand.ts b/clients/client-emr/commands/ListInstanceFleetsCommand.ts index e5164f6e65e8..1d69963248c9 100644 --- a/clients/client-emr/commands/ListInstanceFleetsCommand.ts +++ b/clients/client-emr/commands/ListInstanceFleetsCommand.ts @@ -26,6 +26,20 @@ export interface ListInstanceFleetsCommandOutput extends ListInstanceFleetsOutpu *

The instance fleet configuration is available only in Amazon EMR versions 4.8.0 and * later, excluding 5.0.x versions.

* + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { EMRClient, ListInstanceFleetsCommand } from "@aws-sdk/client-emr"; // ES Modules import + * // const { EMRClient, ListInstanceFleetsCommand } = require("@aws-sdk/client-emr"); // CommonJS import + * const client = new EMRClient(config); + * const command = new ListInstanceFleetsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListInstanceFleetsCommandInput} for command's `input` shape. + * @see {@link ListInstanceFleetsCommandOutput} for command's `response` shape. + * @see {@link EMRClientResolvedConfig | config} for command's `input` shape. + * */ export class ListInstanceFleetsCommand extends $Command< ListInstanceFleetsCommandInput, diff --git a/clients/client-emr/commands/ListInstanceGroupsCommand.ts b/clients/client-emr/commands/ListInstanceGroupsCommand.ts index 89e0a7d5ca96..5abf9f96c7b7 100644 --- a/clients/client-emr/commands/ListInstanceGroupsCommand.ts +++ b/clients/client-emr/commands/ListInstanceGroupsCommand.ts @@ -22,6 +22,20 @@ export interface ListInstanceGroupsCommandOutput extends ListInstanceGroupsOutpu /** *

Provides all available details about the instance groups in a cluster.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { EMRClient, ListInstanceGroupsCommand } from "@aws-sdk/client-emr"; // ES Modules import + * // const { EMRClient, ListInstanceGroupsCommand } = require("@aws-sdk/client-emr"); // CommonJS import + * const client = new EMRClient(config); + * const command = new ListInstanceGroupsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListInstanceGroupsCommandInput} for command's `input` shape. + * @see {@link ListInstanceGroupsCommandOutput} for command's `response` shape. + * @see {@link EMRClientResolvedConfig | config} for command's `input` shape. + * */ export class ListInstanceGroupsCommand extends $Command< ListInstanceGroupsCommandInput, diff --git a/clients/client-emr/commands/ListInstancesCommand.ts b/clients/client-emr/commands/ListInstancesCommand.ts index abc7d296e105..18ed5a93fb87 100644 --- a/clients/client-emr/commands/ListInstancesCommand.ts +++ b/clients/client-emr/commands/ListInstancesCommand.ts @@ -24,6 +24,20 @@ export interface ListInstancesCommandOutput extends ListInstancesOutput, __Metad *

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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { EMRClient, ListInstancesCommand } from "@aws-sdk/client-emr"; // ES Modules import + * // const { EMRClient, ListInstancesCommand } = require("@aws-sdk/client-emr"); // CommonJS import + * const client = new EMRClient(config); + * const command = new ListInstancesCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListInstancesCommandInput} for command's `input` shape. + * @see {@link ListInstancesCommandOutput} for command's `response` shape. + * @see {@link EMRClientResolvedConfig | config} for command's `input` shape. + * */ export class ListInstancesCommand extends $Command< ListInstancesCommandInput, diff --git a/clients/client-emr/commands/ListNotebookExecutionsCommand.ts b/clients/client-emr/commands/ListNotebookExecutionsCommand.ts index 7d2651a139e8..e99438f93a21 100644 --- a/clients/client-emr/commands/ListNotebookExecutionsCommand.ts +++ b/clients/client-emr/commands/ListNotebookExecutionsCommand.ts @@ -25,6 +25,20 @@ export interface ListNotebookExecutionsCommandOutput extends ListNotebookExecuti * 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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { EMRClient, ListNotebookExecutionsCommand } from "@aws-sdk/client-emr"; // ES Modules import + * // const { EMRClient, ListNotebookExecutionsCommand } = require("@aws-sdk/client-emr"); // CommonJS import + * const client = new EMRClient(config); + * const command = new ListNotebookExecutionsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListNotebookExecutionsCommandInput} for command's `input` shape. + * @see {@link ListNotebookExecutionsCommandOutput} for command's `response` shape. + * @see {@link EMRClientResolvedConfig | config} for command's `input` shape. + * */ export class ListNotebookExecutionsCommand extends $Command< ListNotebookExecutionsCommandInput, diff --git a/clients/client-emr/commands/ListSecurityConfigurationsCommand.ts b/clients/client-emr/commands/ListSecurityConfigurationsCommand.ts index 0bbdf1ac2df5..857481959fe1 100644 --- a/clients/client-emr/commands/ListSecurityConfigurationsCommand.ts +++ b/clients/client-emr/commands/ListSecurityConfigurationsCommand.ts @@ -25,6 +25,20 @@ export interface ListSecurityConfigurationsCommandOutput extends ListSecurityCon * 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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { EMRClient, ListSecurityConfigurationsCommand } from "@aws-sdk/client-emr"; // ES Modules import + * // const { EMRClient, ListSecurityConfigurationsCommand } = require("@aws-sdk/client-emr"); // CommonJS import + * const client = new EMRClient(config); + * const command = new ListSecurityConfigurationsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListSecurityConfigurationsCommandInput} for command's `input` shape. + * @see {@link ListSecurityConfigurationsCommandOutput} for command's `response` shape. + * @see {@link EMRClientResolvedConfig | config} for command's `input` shape. + * */ export class ListSecurityConfigurationsCommand extends $Command< ListSecurityConfigurationsCommandInput, diff --git a/clients/client-emr/commands/ListStepsCommand.ts b/clients/client-emr/commands/ListStepsCommand.ts index e25a9f37274b..0c58ceb18ab0 100644 --- a/clients/client-emr/commands/ListStepsCommand.ts +++ b/clients/client-emr/commands/ListStepsCommand.ts @@ -21,6 +21,20 @@ export interface ListStepsCommandOutput extends ListStepsOutput, __MetadataBeare *

Provides a list of steps for the cluster in reverse order unless you specify * stepIds with the request of filter by StepStates. You can * specify a maximum of 10 stepIDs.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { EMRClient, ListStepsCommand } from "@aws-sdk/client-emr"; // ES Modules import + * // const { EMRClient, ListStepsCommand } = require("@aws-sdk/client-emr"); // CommonJS import + * const client = new EMRClient(config); + * const command = new ListStepsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListStepsCommandInput} for command's `input` shape. + * @see {@link ListStepsCommandOutput} for command's `response` shape. + * @see {@link EMRClientResolvedConfig | config} for command's `input` shape. + * */ export class ListStepsCommand extends $Command { // Start section: command_properties diff --git a/clients/client-emr/commands/ListStudioSessionMappingsCommand.ts b/clients/client-emr/commands/ListStudioSessionMappingsCommand.ts index 4fea4666f6d4..f85cee6a2efe 100644 --- a/clients/client-emr/commands/ListStudioSessionMappingsCommand.ts +++ b/clients/client-emr/commands/ListStudioSessionMappingsCommand.ts @@ -23,6 +23,20 @@ export interface ListStudioSessionMappingsCommandOutput extends ListStudioSessio /** *

Returns a list of all user or group session mappings for the Amazon EMR Studio specified by * StudioId.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { EMRClient, ListStudioSessionMappingsCommand } from "@aws-sdk/client-emr"; // ES Modules import + * // const { EMRClient, ListStudioSessionMappingsCommand } = require("@aws-sdk/client-emr"); // CommonJS import + * const client = new EMRClient(config); + * const command = new ListStudioSessionMappingsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListStudioSessionMappingsCommandInput} for command's `input` shape. + * @see {@link ListStudioSessionMappingsCommandOutput} for command's `response` shape. + * @see {@link EMRClientResolvedConfig | config} for command's `input` shape. + * */ export class ListStudioSessionMappingsCommand extends $Command< ListStudioSessionMappingsCommandInput, diff --git a/clients/client-emr/commands/ListStudiosCommand.ts b/clients/client-emr/commands/ListStudiosCommand.ts index b443193aa8ef..ea9637354f48 100644 --- a/clients/client-emr/commands/ListStudiosCommand.ts +++ b/clients/client-emr/commands/ListStudiosCommand.ts @@ -23,6 +23,20 @@ export interface ListStudiosCommandOutput extends ListStudiosOutput, __MetadataB /** *

Returns a list of all Amazon EMR Studios associated with the AWS account. The list * includes details such as ID, Studio Access URL, and creation time for each Studio.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { EMRClient, ListStudiosCommand } from "@aws-sdk/client-emr"; // ES Modules import + * // const { EMRClient, ListStudiosCommand } = require("@aws-sdk/client-emr"); // CommonJS import + * const client = new EMRClient(config); + * const command = new ListStudiosCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListStudiosCommandInput} for command's `input` shape. + * @see {@link ListStudiosCommandOutput} for command's `response` shape. + * @see {@link EMRClientResolvedConfig | config} for command's `input` shape. + * */ export class ListStudiosCommand extends $Command< ListStudiosCommandInput, diff --git a/clients/client-emr/commands/ModifyClusterCommand.ts b/clients/client-emr/commands/ModifyClusterCommand.ts index 6fbd4e5910de..f511a5cd92ef 100644 --- a/clients/client-emr/commands/ModifyClusterCommand.ts +++ b/clients/client-emr/commands/ModifyClusterCommand.ts @@ -23,6 +23,20 @@ export interface ModifyClusterCommandOutput extends ModifyClusterOutput, __Metad /** *

Modifies the number of steps that can be executed concurrently for the cluster specified * using ClusterID.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { EMRClient, ModifyClusterCommand } from "@aws-sdk/client-emr"; // ES Modules import + * // const { EMRClient, ModifyClusterCommand } = require("@aws-sdk/client-emr"); // CommonJS import + * const client = new EMRClient(config); + * const command = new ModifyClusterCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ModifyClusterCommandInput} for command's `input` shape. + * @see {@link ModifyClusterCommandOutput} for command's `response` shape. + * @see {@link EMRClientResolvedConfig | config} for command's `input` shape. + * */ export class ModifyClusterCommand extends $Command< ModifyClusterCommandInput, diff --git a/clients/client-emr/commands/ModifyInstanceFleetCommand.ts b/clients/client-emr/commands/ModifyInstanceFleetCommand.ts index 48f316b48754..0b93fe5628fc 100644 --- a/clients/client-emr/commands/ModifyInstanceFleetCommand.ts +++ b/clients/client-emr/commands/ModifyInstanceFleetCommand.ts @@ -28,6 +28,20 @@ export interface ModifyInstanceFleetCommandOutput extends __MetadataBearer {} *

The instance fleet configuration is available only in Amazon EMR versions 4.8.0 and * later, excluding 5.0.x versions.

* + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { EMRClient, ModifyInstanceFleetCommand } from "@aws-sdk/client-emr"; // ES Modules import + * // const { EMRClient, ModifyInstanceFleetCommand } = require("@aws-sdk/client-emr"); // CommonJS import + * const client = new EMRClient(config); + * const command = new ModifyInstanceFleetCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ModifyInstanceFleetCommandInput} for command's `input` shape. + * @see {@link ModifyInstanceFleetCommandOutput} for command's `response` shape. + * @see {@link EMRClientResolvedConfig | config} for command's `input` shape. + * */ export class ModifyInstanceFleetCommand extends $Command< ModifyInstanceFleetCommandInput, diff --git a/clients/client-emr/commands/ModifyInstanceGroupsCommand.ts b/clients/client-emr/commands/ModifyInstanceGroupsCommand.ts index 7fea782c1076..6937536d1af1 100644 --- a/clients/client-emr/commands/ModifyInstanceGroupsCommand.ts +++ b/clients/client-emr/commands/ModifyInstanceGroupsCommand.ts @@ -24,6 +24,20 @@ export interface ModifyInstanceGroupsCommandOutput extends __MetadataBearer {} *

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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { EMRClient, ModifyInstanceGroupsCommand } from "@aws-sdk/client-emr"; // ES Modules import + * // const { EMRClient, ModifyInstanceGroupsCommand } = require("@aws-sdk/client-emr"); // CommonJS import + * const client = new EMRClient(config); + * const command = new ModifyInstanceGroupsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ModifyInstanceGroupsCommandInput} for command's `input` shape. + * @see {@link ModifyInstanceGroupsCommandOutput} for command's `response` shape. + * @see {@link EMRClientResolvedConfig | config} for command's `input` shape. + * */ export class ModifyInstanceGroupsCommand extends $Command< ModifyInstanceGroupsCommandInput, diff --git a/clients/client-emr/commands/PutAutoScalingPolicyCommand.ts b/clients/client-emr/commands/PutAutoScalingPolicyCommand.ts index ee6f103fcaf8..c6c98f59e85e 100644 --- a/clients/client-emr/commands/PutAutoScalingPolicyCommand.ts +++ b/clients/client-emr/commands/PutAutoScalingPolicyCommand.ts @@ -25,6 +25,20 @@ export interface PutAutoScalingPolicyCommandOutput extends PutAutoScalingPolicyO * 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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { EMRClient, PutAutoScalingPolicyCommand } from "@aws-sdk/client-emr"; // ES Modules import + * // const { EMRClient, PutAutoScalingPolicyCommand } = require("@aws-sdk/client-emr"); // CommonJS import + * const client = new EMRClient(config); + * const command = new PutAutoScalingPolicyCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link PutAutoScalingPolicyCommandInput} for command's `input` shape. + * @see {@link PutAutoScalingPolicyCommandOutput} for command's `response` shape. + * @see {@link EMRClientResolvedConfig | config} for command's `input` shape. + * */ export class PutAutoScalingPolicyCommand extends $Command< PutAutoScalingPolicyCommandInput, diff --git a/clients/client-emr/commands/PutBlockPublicAccessConfigurationCommand.ts b/clients/client-emr/commands/PutBlockPublicAccessConfigurationCommand.ts index a1ae15dc0f85..58f73fa8fb71 100644 --- a/clients/client-emr/commands/PutBlockPublicAccessConfigurationCommand.ts +++ b/clients/client-emr/commands/PutBlockPublicAccessConfigurationCommand.ts @@ -27,6 +27,20 @@ export interface PutBlockPublicAccessConfigurationCommandOutput * in the current Region. For more information see Configure Block * Public Access for Amazon EMR in the Amazon EMR Management * Guide.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { EMRClient, PutBlockPublicAccessConfigurationCommand } from "@aws-sdk/client-emr"; // ES Modules import + * // const { EMRClient, PutBlockPublicAccessConfigurationCommand } = require("@aws-sdk/client-emr"); // CommonJS import + * const client = new EMRClient(config); + * const command = new PutBlockPublicAccessConfigurationCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link PutBlockPublicAccessConfigurationCommandInput} for command's `input` shape. + * @see {@link PutBlockPublicAccessConfigurationCommandOutput} for command's `response` shape. + * @see {@link EMRClientResolvedConfig | config} for command's `input` shape. + * */ export class PutBlockPublicAccessConfigurationCommand extends $Command< PutBlockPublicAccessConfigurationCommandInput, diff --git a/clients/client-emr/commands/PutManagedScalingPolicyCommand.ts b/clients/client-emr/commands/PutManagedScalingPolicyCommand.ts index 0e68d8e13543..de9afe0ef0a4 100644 --- a/clients/client-emr/commands/PutManagedScalingPolicyCommand.ts +++ b/clients/client-emr/commands/PutManagedScalingPolicyCommand.ts @@ -25,6 +25,20 @@ export interface PutManagedScalingPolicyCommandOutput extends PutManagedScalingP * 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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { EMRClient, PutManagedScalingPolicyCommand } from "@aws-sdk/client-emr"; // ES Modules import + * // const { EMRClient, PutManagedScalingPolicyCommand } = require("@aws-sdk/client-emr"); // CommonJS import + * const client = new EMRClient(config); + * const command = new PutManagedScalingPolicyCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link PutManagedScalingPolicyCommandInput} for command's `input` shape. + * @see {@link PutManagedScalingPolicyCommandOutput} for command's `response` shape. + * @see {@link EMRClientResolvedConfig | config} for command's `input` shape. + * */ export class PutManagedScalingPolicyCommand extends $Command< PutManagedScalingPolicyCommandInput, diff --git a/clients/client-emr/commands/RemoveAutoScalingPolicyCommand.ts b/clients/client-emr/commands/RemoveAutoScalingPolicyCommand.ts index 7b92bde5873a..6eee2c6f0db9 100644 --- a/clients/client-emr/commands/RemoveAutoScalingPolicyCommand.ts +++ b/clients/client-emr/commands/RemoveAutoScalingPolicyCommand.ts @@ -23,6 +23,20 @@ export interface RemoveAutoScalingPolicyCommandOutput extends RemoveAutoScalingP /** *

Removes an automatic scaling policy from a specified instance group within an EMR * cluster.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { EMRClient, RemoveAutoScalingPolicyCommand } from "@aws-sdk/client-emr"; // ES Modules import + * // const { EMRClient, RemoveAutoScalingPolicyCommand } = require("@aws-sdk/client-emr"); // CommonJS import + * const client = new EMRClient(config); + * const command = new RemoveAutoScalingPolicyCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link RemoveAutoScalingPolicyCommandInput} for command's `input` shape. + * @see {@link RemoveAutoScalingPolicyCommandOutput} for command's `response` shape. + * @see {@link EMRClientResolvedConfig | config} for command's `input` shape. + * */ export class RemoveAutoScalingPolicyCommand extends $Command< RemoveAutoScalingPolicyCommandInput, diff --git a/clients/client-emr/commands/RemoveManagedScalingPolicyCommand.ts b/clients/client-emr/commands/RemoveManagedScalingPolicyCommand.ts index eef4f6e77ef5..00b248112e0f 100644 --- a/clients/client-emr/commands/RemoveManagedScalingPolicyCommand.ts +++ b/clients/client-emr/commands/RemoveManagedScalingPolicyCommand.ts @@ -22,6 +22,20 @@ export interface RemoveManagedScalingPolicyCommandOutput extends RemoveManagedSc /** *

Removes a managed scaling policy from a specified EMR cluster.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { EMRClient, RemoveManagedScalingPolicyCommand } from "@aws-sdk/client-emr"; // ES Modules import + * // const { EMRClient, RemoveManagedScalingPolicyCommand } = require("@aws-sdk/client-emr"); // CommonJS import + * const client = new EMRClient(config); + * const command = new RemoveManagedScalingPolicyCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link RemoveManagedScalingPolicyCommandInput} for command's `input` shape. + * @see {@link RemoveManagedScalingPolicyCommandOutput} for command's `response` shape. + * @see {@link EMRClientResolvedConfig | config} for command's `input` shape. + * */ export class RemoveManagedScalingPolicyCommand extends $Command< RemoveManagedScalingPolicyCommandInput, diff --git a/clients/client-emr/commands/RemoveTagsCommand.ts b/clients/client-emr/commands/RemoveTagsCommand.ts index 32a5e2af9cad..99f1ac8cb352 100644 --- a/clients/client-emr/commands/RemoveTagsCommand.ts +++ b/clients/client-emr/commands/RemoveTagsCommand.ts @@ -25,6 +25,20 @@ export interface RemoveTagsCommandOutput extends RemoveTagsOutput, __MetadataBea * 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:

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { EMRClient, RemoveTagsCommand } from "@aws-sdk/client-emr"; // ES Modules import + * // const { EMRClient, RemoveTagsCommand } = require("@aws-sdk/client-emr"); // CommonJS import + * const client = new EMRClient(config); + * const command = new RemoveTagsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link RemoveTagsCommandInput} for command's `input` shape. + * @see {@link RemoveTagsCommandOutput} for command's `response` shape. + * @see {@link EMRClientResolvedConfig | config} for command's `input` shape. + * */ export class RemoveTagsCommand extends $Command< RemoveTagsCommandInput, diff --git a/clients/client-emr/commands/RunJobFlowCommand.ts b/clients/client-emr/commands/RunJobFlowCommand.ts index 94b24215746d..9ae0f2b364c1 100644 --- a/clients/client-emr/commands/RunJobFlowCommand.ts +++ b/clients/client-emr/commands/RunJobFlowCommand.ts @@ -44,6 +44,20 @@ export interface RunJobFlowCommandOutput extends RunJobFlowOutput, __MetadataBea * later, excluding 5.0.x versions. The RunJobFlow request can contain InstanceFleets * parameters or InstanceGroups parameters, but not both.

* + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { EMRClient, RunJobFlowCommand } from "@aws-sdk/client-emr"; // ES Modules import + * // const { EMRClient, RunJobFlowCommand } = require("@aws-sdk/client-emr"); // CommonJS import + * const client = new EMRClient(config); + * const command = new RunJobFlowCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link RunJobFlowCommandInput} for command's `input` shape. + * @see {@link RunJobFlowCommandOutput} for command's `response` shape. + * @see {@link EMRClientResolvedConfig | config} for command's `input` shape. + * */ export class RunJobFlowCommand extends $Command< RunJobFlowCommandInput, diff --git a/clients/client-emr/commands/SetTerminationProtectionCommand.ts b/clients/client-emr/commands/SetTerminationProtectionCommand.ts index 3e392734a943..7da5bce87918 100644 --- a/clients/client-emr/commands/SetTerminationProtectionCommand.ts +++ b/clients/client-emr/commands/SetTerminationProtectionCommand.ts @@ -36,6 +36,20 @@ export interface SetTerminationProtectionCommandOutput extends __MetadataBearer * value to false.

*

For more information, seeManaging Cluster * Termination in the Amazon EMR Management Guide.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { EMRClient, SetTerminationProtectionCommand } from "@aws-sdk/client-emr"; // ES Modules import + * // const { EMRClient, SetTerminationProtectionCommand } = require("@aws-sdk/client-emr"); // CommonJS import + * const client = new EMRClient(config); + * const command = new SetTerminationProtectionCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link SetTerminationProtectionCommandInput} for command's `input` shape. + * @see {@link SetTerminationProtectionCommandOutput} for command's `response` shape. + * @see {@link EMRClientResolvedConfig | config} for command's `input` shape. + * */ export class SetTerminationProtectionCommand extends $Command< SetTerminationProtectionCommandInput, diff --git a/clients/client-emr/commands/SetVisibleToAllUsersCommand.ts b/clients/client-emr/commands/SetVisibleToAllUsersCommand.ts index 70dd1415cf86..eab205e59f1e 100644 --- a/clients/client-emr/commands/SetVisibleToAllUsersCommand.ts +++ b/clients/client-emr/commands/SetVisibleToAllUsersCommand.ts @@ -30,6 +30,20 @@ export interface SetVisibleToAllUsersCommandOutput extends __MetadataBearer {} * action works on running clusters. You can override the default true setting * when you create a cluster by using the VisibleToAllUsers parameter with * RunJobFlow.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { EMRClient, SetVisibleToAllUsersCommand } from "@aws-sdk/client-emr"; // ES Modules import + * // const { EMRClient, SetVisibleToAllUsersCommand } = require("@aws-sdk/client-emr"); // CommonJS import + * const client = new EMRClient(config); + * const command = new SetVisibleToAllUsersCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link SetVisibleToAllUsersCommandInput} for command's `input` shape. + * @see {@link SetVisibleToAllUsersCommandOutput} for command's `response` shape. + * @see {@link EMRClientResolvedConfig | config} for command's `input` shape. + * */ export class SetVisibleToAllUsersCommand extends $Command< SetVisibleToAllUsersCommandInput, diff --git a/clients/client-emr/commands/StartNotebookExecutionCommand.ts b/clients/client-emr/commands/StartNotebookExecutionCommand.ts index bd28432a7fb1..99e1ed32f43c 100644 --- a/clients/client-emr/commands/StartNotebookExecutionCommand.ts +++ b/clients/client-emr/commands/StartNotebookExecutionCommand.ts @@ -22,6 +22,20 @@ export interface StartNotebookExecutionCommandOutput extends StartNotebookExecut /** *

Starts a notebook execution.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { EMRClient, StartNotebookExecutionCommand } from "@aws-sdk/client-emr"; // ES Modules import + * // const { EMRClient, StartNotebookExecutionCommand } = require("@aws-sdk/client-emr"); // CommonJS import + * const client = new EMRClient(config); + * const command = new StartNotebookExecutionCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link StartNotebookExecutionCommandInput} for command's `input` shape. + * @see {@link StartNotebookExecutionCommandOutput} for command's `response` shape. + * @see {@link EMRClientResolvedConfig | config} for command's `input` shape. + * */ export class StartNotebookExecutionCommand extends $Command< StartNotebookExecutionCommandInput, diff --git a/clients/client-emr/commands/StopNotebookExecutionCommand.ts b/clients/client-emr/commands/StopNotebookExecutionCommand.ts index da8b44d9ca6c..0e2075e6c082 100644 --- a/clients/client-emr/commands/StopNotebookExecutionCommand.ts +++ b/clients/client-emr/commands/StopNotebookExecutionCommand.ts @@ -22,6 +22,20 @@ export interface StopNotebookExecutionCommandOutput extends __MetadataBearer {} /** *

Stops a notebook execution.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { EMRClient, StopNotebookExecutionCommand } from "@aws-sdk/client-emr"; // ES Modules import + * // const { EMRClient, StopNotebookExecutionCommand } = require("@aws-sdk/client-emr"); // CommonJS import + * const client = new EMRClient(config); + * const command = new StopNotebookExecutionCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link StopNotebookExecutionCommandInput} for command's `input` shape. + * @see {@link StopNotebookExecutionCommandOutput} for command's `response` shape. + * @see {@link EMRClientResolvedConfig | config} for command's `input` shape. + * */ export class StopNotebookExecutionCommand extends $Command< StopNotebookExecutionCommandInput, diff --git a/clients/client-emr/commands/TerminateJobFlowsCommand.ts b/clients/client-emr/commands/TerminateJobFlowsCommand.ts index a4ec3d8029ea..64f4f9901d5c 100644 --- a/clients/client-emr/commands/TerminateJobFlowsCommand.ts +++ b/clients/client-emr/commands/TerminateJobFlowsCommand.ts @@ -29,6 +29,20 @@ export interface TerminateJobFlowsCommandOutput extends __MetadataBearer {} * 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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { EMRClient, TerminateJobFlowsCommand } from "@aws-sdk/client-emr"; // ES Modules import + * // const { EMRClient, TerminateJobFlowsCommand } = require("@aws-sdk/client-emr"); // CommonJS import + * const client = new EMRClient(config); + * const command = new TerminateJobFlowsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link TerminateJobFlowsCommandInput} for command's `input` shape. + * @see {@link TerminateJobFlowsCommandOutput} for command's `response` shape. + * @see {@link EMRClientResolvedConfig | config} for command's `input` shape. + * */ export class TerminateJobFlowsCommand extends $Command< TerminateJobFlowsCommandInput, diff --git a/clients/client-emr/commands/UpdateStudioCommand.ts b/clients/client-emr/commands/UpdateStudioCommand.ts index 87fc7b4a28d0..651a90449cae 100644 --- a/clients/client-emr/commands/UpdateStudioCommand.ts +++ b/clients/client-emr/commands/UpdateStudioCommand.ts @@ -22,6 +22,20 @@ export interface UpdateStudioCommandOutput extends __MetadataBearer {} /** *

Updates an Amazon EMR Studio configuration, including attributes such as name, description, and subnets.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { EMRClient, UpdateStudioCommand } from "@aws-sdk/client-emr"; // ES Modules import + * // const { EMRClient, UpdateStudioCommand } = require("@aws-sdk/client-emr"); // CommonJS import + * const client = new EMRClient(config); + * const command = new UpdateStudioCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link UpdateStudioCommandInput} for command's `input` shape. + * @see {@link UpdateStudioCommandOutput} for command's `response` shape. + * @see {@link EMRClientResolvedConfig | config} for command's `input` shape. + * */ export class UpdateStudioCommand extends $Command< UpdateStudioCommandInput, diff --git a/clients/client-emr/commands/UpdateStudioSessionMappingCommand.ts b/clients/client-emr/commands/UpdateStudioSessionMappingCommand.ts index fb0adcc39634..391e850f2ce8 100644 --- a/clients/client-emr/commands/UpdateStudioSessionMappingCommand.ts +++ b/clients/client-emr/commands/UpdateStudioSessionMappingCommand.ts @@ -23,6 +23,20 @@ export interface UpdateStudioSessionMappingCommandOutput extends __MetadataBeare /** *

Updates the session policy attached to the user or group for the specified Amazon EMR * Studio.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { EMRClient, UpdateStudioSessionMappingCommand } from "@aws-sdk/client-emr"; // ES Modules import + * // const { EMRClient, UpdateStudioSessionMappingCommand } = require("@aws-sdk/client-emr"); // CommonJS import + * const client = new EMRClient(config); + * const command = new UpdateStudioSessionMappingCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link UpdateStudioSessionMappingCommandInput} for command's `input` shape. + * @see {@link UpdateStudioSessionMappingCommandOutput} for command's `response` shape. + * @see {@link EMRClientResolvedConfig | config} for command's `input` shape. + * */ export class UpdateStudioSessionMappingCommand extends $Command< UpdateStudioSessionMappingCommandInput, diff --git a/clients/client-emr/models/models_0.ts b/clients/client-emr/models/models_0.ts index cf5ffd8f7f5a..33c7c0c39caa 100644 --- a/clients/client-emr/models/models_0.ts +++ b/clients/client-emr/models/models_0.ts @@ -37,6 +37,9 @@ export interface VolumeSpecification { } export namespace VolumeSpecification { + /** + * @internal + */ export const filterSensitiveLog = (obj: VolumeSpecification): any => ({ ...obj, }); @@ -61,6 +64,9 @@ export interface EbsBlockDeviceConfig { } export namespace EbsBlockDeviceConfig { + /** + * @internal + */ export const filterSensitiveLog = (obj: EbsBlockDeviceConfig): any => ({ ...obj, }); @@ -82,6 +88,9 @@ export interface EbsConfiguration { } export namespace EbsConfiguration { + /** + * @internal + */ export const filterSensitiveLog = (obj: EbsConfiguration): any => ({ ...obj, }); @@ -133,6 +142,9 @@ export interface OnDemandCapacityReservationOptions { } export namespace OnDemandCapacityReservationOptions { + /** + * @internal + */ export const filterSensitiveLog = (obj: OnDemandCapacityReservationOptions): any => ({ ...obj, }); @@ -160,6 +172,9 @@ export interface OnDemandProvisioningSpecification { } export namespace OnDemandProvisioningSpecification { + /** + * @internal + */ export const filterSensitiveLog = (obj: OnDemandProvisioningSpecification): any => ({ ...obj, }); @@ -219,6 +234,9 @@ export interface SpotProvisioningSpecification { } export namespace SpotProvisioningSpecification { + /** + * @internal + */ export const filterSensitiveLog = (obj: SpotProvisioningSpecification): any => ({ ...obj, }); @@ -253,6 +271,9 @@ export interface InstanceFleetProvisioningSpecifications { } export namespace InstanceFleetProvisioningSpecifications { + /** + * @internal + */ export const filterSensitiveLog = (obj: InstanceFleetProvisioningSpecifications): any => ({ ...obj, }); @@ -276,6 +297,9 @@ export interface AddInstanceFleetOutput { } export namespace AddInstanceFleetOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: AddInstanceFleetOutput): any => ({ ...obj, }); @@ -295,6 +319,9 @@ export interface InternalServerException extends __SmithyException, $MetadataBea } export namespace InternalServerException { + /** + * @internal + */ export const filterSensitiveLog = (obj: InternalServerException): any => ({ ...obj, }); @@ -318,6 +345,9 @@ export interface InvalidRequestException extends __SmithyException, $MetadataBea } export namespace InvalidRequestException { + /** + * @internal + */ export const filterSensitiveLog = (obj: InvalidRequestException): any => ({ ...obj, }); @@ -345,6 +375,9 @@ export interface ScalingConstraints { } export namespace ScalingConstraints { + /** + * @internal + */ export const filterSensitiveLog = (obj: ScalingConstraints): any => ({ ...obj, }); @@ -401,6 +434,9 @@ export interface SimpleScalingPolicyConfiguration { } export namespace SimpleScalingPolicyConfiguration { + /** + * @internal + */ export const filterSensitiveLog = (obj: SimpleScalingPolicyConfiguration): any => ({ ...obj, }); @@ -425,6 +461,9 @@ export interface ScalingAction { } export namespace ScalingAction { + /** + * @internal + */ export const filterSensitiveLog = (obj: ScalingAction): any => ({ ...obj, }); @@ -457,6 +496,9 @@ export interface MetricDimension { } export namespace MetricDimension { + /** + * @internal + */ export const filterSensitiveLog = (obj: MetricDimension): any => ({ ...obj, }); @@ -563,6 +605,9 @@ export interface CloudWatchAlarmDefinition { } export namespace CloudWatchAlarmDefinition { + /** + * @internal + */ export const filterSensitiveLog = (obj: CloudWatchAlarmDefinition): any => ({ ...obj, }); @@ -580,6 +625,9 @@ export interface ScalingTrigger { } export namespace ScalingTrigger { + /** + * @internal + */ export const filterSensitiveLog = (obj: ScalingTrigger): any => ({ ...obj, }); @@ -616,6 +664,9 @@ export interface ScalingRule { } export namespace ScalingRule { + /** + * @internal + */ export const filterSensitiveLog = (obj: ScalingRule): any => ({ ...obj, }); @@ -642,6 +693,9 @@ export interface AutoScalingPolicy { } export namespace AutoScalingPolicy { + /** + * @internal + */ export const filterSensitiveLog = (obj: AutoScalingPolicy): any => ({ ...obj, }); @@ -670,6 +724,9 @@ export interface AddInstanceGroupsOutput { } export namespace AddInstanceGroupsOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: AddInstanceGroupsOutput): any => ({ ...obj, }); @@ -685,6 +742,9 @@ export interface InternalServerError extends __SmithyException, $MetadataBearer } export namespace InternalServerError { + /** + * @internal + */ export const filterSensitiveLog = (obj: InternalServerError): any => ({ ...obj, }); @@ -706,6 +766,9 @@ export interface KeyValue { } export namespace KeyValue { + /** + * @internal + */ export const filterSensitiveLog = (obj: KeyValue): any => ({ ...obj, }); @@ -742,6 +805,9 @@ export interface HadoopJarStepConfig { } export namespace HadoopJarStepConfig { + /** + * @internal + */ export const filterSensitiveLog = (obj: HadoopJarStepConfig): any => ({ ...obj, }); @@ -770,6 +836,9 @@ export interface StepConfig { } export namespace StepConfig { + /** + * @internal + */ export const filterSensitiveLog = (obj: StepConfig): any => ({ ...obj, }); @@ -792,6 +861,9 @@ export interface AddJobFlowStepsInput { } export namespace AddJobFlowStepsInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: AddJobFlowStepsInput): any => ({ ...obj, }); @@ -808,6 +880,9 @@ export interface AddJobFlowStepsOutput { } export namespace AddJobFlowStepsOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: AddJobFlowStepsOutput): any => ({ ...obj, }); @@ -835,6 +910,9 @@ export interface Tag { } export namespace Tag { + /** + * @internal + */ export const filterSensitiveLog = (obj: Tag): any => ({ ...obj, }); @@ -859,6 +937,9 @@ export interface AddTagsInput { } export namespace AddTagsInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: AddTagsInput): any => ({ ...obj, }); @@ -870,6 +951,9 @@ export namespace AddTagsInput { export interface AddTagsOutput {} export namespace AddTagsOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: AddTagsOutput): any => ({ ...obj, }); @@ -910,6 +994,9 @@ export interface Application { } export namespace Application { + /** + * @internal + */ export const filterSensitiveLog = (obj: Application): any => ({ ...obj, }); @@ -955,6 +1042,9 @@ export interface AutoScalingPolicyStateChangeReason { } export namespace AutoScalingPolicyStateChangeReason { + /** + * @internal + */ export const filterSensitiveLog = (obj: AutoScalingPolicyStateChangeReason): any => ({ ...obj, }); @@ -977,6 +1067,9 @@ export interface AutoScalingPolicyStatus { } export namespace AutoScalingPolicyStatus { + /** + * @internal + */ export const filterSensitiveLog = (obj: AutoScalingPolicyStatus): any => ({ ...obj, }); @@ -1008,6 +1101,9 @@ export interface AutoScalingPolicyDescription { } export namespace AutoScalingPolicyDescription { + /** + * @internal + */ export const filterSensitiveLog = (obj: AutoScalingPolicyDescription): any => ({ ...obj, }); @@ -1031,6 +1127,9 @@ export interface PortRange { } export namespace PortRange { + /** + * @internal + */ export const filterSensitiveLog = (obj: PortRange): any => ({ ...obj, }); @@ -1056,6 +1155,9 @@ export interface BlockPublicAccessConfigurationMetadata { } export namespace BlockPublicAccessConfigurationMetadata { + /** + * @internal + */ export const filterSensitiveLog = (obj: BlockPublicAccessConfigurationMetadata): any => ({ ...obj, }); @@ -1078,6 +1180,9 @@ export interface ScriptBootstrapActionConfig { } export namespace ScriptBootstrapActionConfig { + /** + * @internal + */ export const filterSensitiveLog = (obj: ScriptBootstrapActionConfig): any => ({ ...obj, }); @@ -1099,6 +1204,9 @@ export interface BootstrapActionConfig { } export namespace BootstrapActionConfig { + /** + * @internal + */ export const filterSensitiveLog = (obj: BootstrapActionConfig): any => ({ ...obj, }); @@ -1115,6 +1223,9 @@ export interface BootstrapActionDetail { } export namespace BootstrapActionDetail { + /** + * @internal + */ export const filterSensitiveLog = (obj: BootstrapActionDetail): any => ({ ...obj, }); @@ -1145,6 +1256,9 @@ export interface CancelStepsInput { } export namespace CancelStepsInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: CancelStepsInput): any => ({ ...obj, }); @@ -1177,6 +1291,9 @@ export interface CancelStepsInfo { } export namespace CancelStepsInfo { + /** + * @internal + */ export const filterSensitiveLog = (obj: CancelStepsInfo): any => ({ ...obj, }); @@ -1194,6 +1311,9 @@ export interface CancelStepsOutput { } export namespace CancelStepsOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: CancelStepsOutput): any => ({ ...obj, }); @@ -1281,6 +1401,9 @@ export interface Ec2InstanceAttributes { } export namespace Ec2InstanceAttributes { + /** + * @internal + */ export const filterSensitiveLog = (obj: Ec2InstanceAttributes): any => ({ ...obj, }); @@ -1329,6 +1452,9 @@ export interface KerberosAttributes { } export namespace KerberosAttributes { + /** + * @internal + */ export const filterSensitiveLog = (obj: KerberosAttributes): any => ({ ...obj, }); @@ -1364,6 +1490,9 @@ export interface PlacementGroupConfig { } export namespace PlacementGroupConfig { + /** + * @internal + */ export const filterSensitiveLog = (obj: PlacementGroupConfig): any => ({ ...obj, }); @@ -1416,6 +1545,9 @@ export interface ClusterStateChangeReason { } export namespace ClusterStateChangeReason { + /** + * @internal + */ export const filterSensitiveLog = (obj: ClusterStateChangeReason): any => ({ ...obj, }); @@ -1442,6 +1574,9 @@ export interface ClusterTimeline { } export namespace ClusterTimeline { + /** + * @internal + */ export const filterSensitiveLog = (obj: ClusterTimeline): any => ({ ...obj, }); @@ -1469,6 +1604,9 @@ export interface ClusterStatus { } export namespace ClusterStatus { + /** + * @internal + */ export const filterSensitiveLog = (obj: ClusterStatus): any => ({ ...obj, }); @@ -1514,6 +1652,9 @@ export interface ClusterSummary { } export namespace ClusterSummary { + /** + * @internal + */ export const filterSensitiveLog = (obj: ClusterSummary): any => ({ ...obj, }); @@ -1540,6 +1681,9 @@ export interface Command { } export namespace Command { + /** + * @internal + */ export const filterSensitiveLog = (obj: Command): any => ({ ...obj, }); @@ -1596,6 +1740,9 @@ export interface ComputeLimits { } export namespace ComputeLimits { + /** + * @internal + */ export const filterSensitiveLog = (obj: ComputeLimits): any => ({ ...obj, }); @@ -1617,6 +1764,9 @@ export interface CreateSecurityConfigurationInput { } export namespace CreateSecurityConfigurationInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateSecurityConfigurationInput): any => ({ ...obj, }); @@ -1635,6 +1785,9 @@ export interface CreateSecurityConfigurationOutput { } export namespace CreateSecurityConfigurationOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateSecurityConfigurationOutput): any => ({ ...obj, }); @@ -1711,6 +1864,9 @@ export interface CreateStudioInput { } export namespace CreateStudioInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateStudioInput): any => ({ ...obj, }); @@ -1729,6 +1885,9 @@ export interface CreateStudioOutput { } export namespace CreateStudioOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateStudioOutput): any => ({ ...obj, }); @@ -1772,6 +1931,9 @@ export interface CreateStudioSessionMappingInput { } export namespace CreateStudioSessionMappingInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateStudioSessionMappingInput): any => ({ ...obj, }); @@ -1785,6 +1947,9 @@ export interface DeleteSecurityConfigurationInput { } export namespace DeleteSecurityConfigurationInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteSecurityConfigurationInput): any => ({ ...obj, }); @@ -1793,6 +1958,9 @@ export namespace DeleteSecurityConfigurationInput { export interface DeleteSecurityConfigurationOutput {} export namespace DeleteSecurityConfigurationOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteSecurityConfigurationOutput): any => ({ ...obj, }); @@ -1806,6 +1974,9 @@ export interface DeleteStudioInput { } export namespace DeleteStudioInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteStudioInput): any => ({ ...obj, }); @@ -1838,6 +2009,9 @@ export interface DeleteStudioSessionMappingInput { } export namespace DeleteStudioSessionMappingInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteStudioSessionMappingInput): any => ({ ...obj, }); @@ -1854,6 +2028,9 @@ export interface DescribeClusterInput { } export namespace DescribeClusterInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeClusterInput): any => ({ ...obj, }); @@ -1896,6 +2073,9 @@ export interface DescribeJobFlowsInput { } export namespace DescribeJobFlowsInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeJobFlowsInput): any => ({ ...obj, }); @@ -1937,6 +2117,9 @@ export interface JobFlowExecutionStatusDetail { } export namespace JobFlowExecutionStatusDetail { + /** + * @internal + */ export const filterSensitiveLog = (obj: JobFlowExecutionStatusDetail): any => ({ ...obj, }); @@ -2033,6 +2216,9 @@ export interface InstanceGroupDetail { } export namespace InstanceGroupDetail { + /** + * @internal + */ export const filterSensitiveLog = (obj: InstanceGroupDetail): any => ({ ...obj, }); @@ -2063,6 +2249,9 @@ export interface PlacementType { } export namespace PlacementType { + /** + * @internal + */ export const filterSensitiveLog = (obj: PlacementType): any => ({ ...obj, }); @@ -2149,6 +2338,9 @@ export interface JobFlowInstancesDetail { } export namespace JobFlowInstancesDetail { + /** + * @internal + */ export const filterSensitiveLog = (obj: JobFlowInstancesDetail): any => ({ ...obj, }); @@ -2194,6 +2386,9 @@ export interface StepExecutionStatusDetail { } export namespace StepExecutionStatusDetail { + /** + * @internal + */ export const filterSensitiveLog = (obj: StepExecutionStatusDetail): any => ({ ...obj, }); @@ -2215,6 +2410,9 @@ export interface StepDetail { } export namespace StepDetail { + /** + * @internal + */ export const filterSensitiveLog = (obj: StepDetail): any => ({ ...obj, }); @@ -2326,6 +2524,9 @@ export interface JobFlowDetail { } export namespace JobFlowDetail { + /** + * @internal + */ export const filterSensitiveLog = (obj: JobFlowDetail): any => ({ ...obj, }); @@ -2342,6 +2543,9 @@ export interface DescribeJobFlowsOutput { } export namespace DescribeJobFlowsOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeJobFlowsOutput): any => ({ ...obj, }); @@ -2355,6 +2559,9 @@ export interface DescribeNotebookExecutionInput { } export namespace DescribeNotebookExecutionInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeNotebookExecutionInput): any => ({ ...obj, }); @@ -2391,6 +2598,9 @@ export interface ExecutionEngineConfig { } export namespace ExecutionEngineConfig { + /** + * @internal + */ export const filterSensitiveLog = (obj: ExecutionEngineConfig): any => ({ ...obj, }); @@ -2540,6 +2750,9 @@ export interface NotebookExecution { } export namespace NotebookExecution { + /** + * @internal + */ export const filterSensitiveLog = (obj: NotebookExecution): any => ({ ...obj, }); @@ -2553,6 +2766,9 @@ export interface DescribeNotebookExecutionOutput { } export namespace DescribeNotebookExecutionOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeNotebookExecutionOutput): any => ({ ...obj, }); @@ -2566,6 +2782,9 @@ export interface DescribeSecurityConfigurationInput { } export namespace DescribeSecurityConfigurationInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeSecurityConfigurationInput): any => ({ ...obj, }); @@ -2589,6 +2808,9 @@ export interface DescribeSecurityConfigurationOutput { } export namespace DescribeSecurityConfigurationOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeSecurityConfigurationOutput): any => ({ ...obj, }); @@ -2610,6 +2832,9 @@ export interface DescribeStepInput { } export namespace DescribeStepInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeStepInput): any => ({ ...obj, }); @@ -2646,6 +2871,9 @@ export interface HadoopStepConfig { } export namespace HadoopStepConfig { + /** + * @internal + */ export const filterSensitiveLog = (obj: HadoopStepConfig): any => ({ ...obj, }); @@ -2677,6 +2905,9 @@ export interface FailureDetails { } export namespace FailureDetails { + /** + * @internal + */ export const filterSensitiveLog = (obj: FailureDetails): any => ({ ...obj, }); @@ -2711,6 +2942,9 @@ export interface StepStateChangeReason { } export namespace StepStateChangeReason { + /** + * @internal + */ export const filterSensitiveLog = (obj: StepStateChangeReason): any => ({ ...obj, }); @@ -2737,6 +2971,9 @@ export interface StepTimeline { } export namespace StepTimeline { + /** + * @internal + */ export const filterSensitiveLog = (obj: StepTimeline): any => ({ ...obj, }); @@ -2769,6 +3006,9 @@ export interface StepStatus { } export namespace StepStatus { + /** + * @internal + */ export const filterSensitiveLog = (obj: StepStatus): any => ({ ...obj, }); @@ -2807,6 +3047,9 @@ export interface Step { } export namespace Step { + /** + * @internal + */ export const filterSensitiveLog = (obj: Step): any => ({ ...obj, }); @@ -2823,6 +3066,9 @@ export interface DescribeStepOutput { } export namespace DescribeStepOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeStepOutput): any => ({ ...obj, }); @@ -2836,6 +3082,9 @@ export interface DescribeStudioInput { } export namespace DescribeStudioInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeStudioInput): any => ({ ...obj, }); @@ -2928,6 +3177,9 @@ export interface Studio { } export namespace Studio { + /** + * @internal + */ export const filterSensitiveLog = (obj: Studio): any => ({ ...obj, }); @@ -2941,6 +3193,9 @@ export interface DescribeStudioOutput { } export namespace DescribeStudioOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeStudioOutput): any => ({ ...obj, }); @@ -2963,6 +3218,9 @@ export interface EbsBlockDevice { } export namespace EbsBlockDevice { + /** + * @internal + */ export const filterSensitiveLog = (obj: EbsBlockDevice): any => ({ ...obj, }); @@ -2984,6 +3242,9 @@ export interface EbsVolume { } export namespace EbsVolume { + /** + * @internal + */ export const filterSensitiveLog = (obj: EbsVolume): any => ({ ...obj, }); @@ -2992,6 +3253,9 @@ export namespace EbsVolume { export interface GetBlockPublicAccessConfigurationInput {} export namespace GetBlockPublicAccessConfigurationInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetBlockPublicAccessConfigurationInput): any => ({ ...obj, }); @@ -3006,6 +3270,9 @@ export interface GetManagedScalingPolicyInput { } export namespace GetManagedScalingPolicyInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetManagedScalingPolicyInput): any => ({ ...obj, }); @@ -3026,6 +3293,9 @@ export interface ManagedScalingPolicy { } export namespace ManagedScalingPolicy { + /** + * @internal + */ export const filterSensitiveLog = (obj: ManagedScalingPolicy): any => ({ ...obj, }); @@ -3039,6 +3309,9 @@ export interface GetManagedScalingPolicyOutput { } export namespace GetManagedScalingPolicyOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetManagedScalingPolicyOutput): any => ({ ...obj, }); @@ -3070,6 +3343,9 @@ export interface GetStudioSessionMappingInput { } export namespace GetStudioSessionMappingInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetStudioSessionMappingInput): any => ({ ...obj, }); @@ -3119,6 +3395,9 @@ export interface SessionMappingDetail { } export namespace SessionMappingDetail { + /** + * @internal + */ export const filterSensitiveLog = (obj: SessionMappingDetail): any => ({ ...obj, }); @@ -3133,6 +3412,9 @@ export interface GetStudioSessionMappingOutput { } export namespace GetStudioSessionMappingOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetStudioSessionMappingOutput): any => ({ ...obj, }); @@ -3154,6 +3436,9 @@ export interface ListBootstrapActionsInput { } export namespace ListBootstrapActionsInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListBootstrapActionsInput): any => ({ ...obj, }); @@ -3175,6 +3460,9 @@ export interface ListBootstrapActionsOutput { } export namespace ListBootstrapActionsOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListBootstrapActionsOutput): any => ({ ...obj, }); @@ -3207,6 +3495,9 @@ export interface ListClustersInput { } export namespace ListClustersInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListClustersInput): any => ({ ...obj, }); @@ -3229,6 +3520,9 @@ export interface ListClustersOutput { } export namespace ListClustersOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListClustersOutput): any => ({ ...obj, }); @@ -3247,6 +3541,9 @@ export interface ListInstanceFleetsInput { } export namespace ListInstanceFleetsInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListInstanceFleetsInput): any => ({ ...obj, }); @@ -3289,6 +3586,9 @@ export interface InstanceFleetStateChangeReason { } export namespace InstanceFleetStateChangeReason { + /** + * @internal + */ export const filterSensitiveLog = (obj: InstanceFleetStateChangeReason): any => ({ ...obj, }); @@ -3320,6 +3620,9 @@ export interface InstanceFleetTimeline { } export namespace InstanceFleetTimeline { + /** + * @internal + */ export const filterSensitiveLog = (obj: InstanceFleetTimeline): any => ({ ...obj, }); @@ -3387,6 +3690,9 @@ export interface InstanceFleetStatus { } export namespace InstanceFleetStatus { + /** + * @internal + */ export const filterSensitiveLog = (obj: InstanceFleetStatus): any => ({ ...obj, }); @@ -3408,6 +3714,9 @@ export interface ListInstanceGroupsInput { } export namespace ListInstanceGroupsInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListInstanceGroupsInput): any => ({ ...obj, }); @@ -3442,6 +3751,9 @@ export interface InstanceResizePolicy { } export namespace InstanceResizePolicy { + /** + * @internal + */ export const filterSensitiveLog = (obj: InstanceResizePolicy): any => ({ ...obj, }); @@ -3466,6 +3778,9 @@ export interface ShrinkPolicy { } export namespace ShrinkPolicy { + /** + * @internal + */ export const filterSensitiveLog = (obj: ShrinkPolicy): any => ({ ...obj, }); @@ -3494,6 +3809,9 @@ export interface InstanceGroupStateChangeReason { } export namespace InstanceGroupStateChangeReason { + /** + * @internal + */ export const filterSensitiveLog = (obj: InstanceGroupStateChangeReason): any => ({ ...obj, }); @@ -3520,6 +3838,9 @@ export interface InstanceGroupTimeline { } export namespace InstanceGroupTimeline { + /** + * @internal + */ export const filterSensitiveLog = (obj: InstanceGroupTimeline): any => ({ ...obj, }); @@ -3546,6 +3867,9 @@ export interface InstanceGroupStatus { } export namespace InstanceGroupStatus { + /** + * @internal + */ export const filterSensitiveLog = (obj: InstanceGroupStatus): any => ({ ...obj, }); @@ -3601,6 +3925,9 @@ export interface ListInstancesInput { } export namespace ListInstancesInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListInstancesInput): any => ({ ...obj, }); @@ -3630,6 +3957,9 @@ export interface InstanceStateChangeReason { } export namespace InstanceStateChangeReason { + /** + * @internal + */ export const filterSensitiveLog = (obj: InstanceStateChangeReason): any => ({ ...obj, }); @@ -3656,6 +3986,9 @@ export interface InstanceTimeline { } export namespace InstanceTimeline { + /** + * @internal + */ export const filterSensitiveLog = (obj: InstanceTimeline): any => ({ ...obj, }); @@ -3682,6 +4015,9 @@ export interface InstanceStatus { } export namespace InstanceStatus { + /** + * @internal + */ export const filterSensitiveLog = (obj: InstanceStatus): any => ({ ...obj, }); @@ -3754,6 +4090,9 @@ export interface Instance { } export namespace Instance { + /** + * @internal + */ export const filterSensitiveLog = (obj: Instance): any => ({ ...obj, }); @@ -3775,6 +4114,9 @@ export interface ListInstancesOutput { } export namespace ListInstancesOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListInstancesOutput): any => ({ ...obj, }); @@ -3863,6 +4205,9 @@ export interface ListNotebookExecutionsInput { } export namespace ListNotebookExecutionsInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListNotebookExecutionsInput): any => ({ ...obj, }); @@ -3955,6 +4300,9 @@ export interface NotebookExecutionSummary { } export namespace NotebookExecutionSummary { + /** + * @internal + */ export const filterSensitiveLog = (obj: NotebookExecutionSummary): any => ({ ...obj, }); @@ -3974,6 +4322,9 @@ export interface ListNotebookExecutionsOutput { } export namespace ListNotebookExecutionsOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListNotebookExecutionsOutput): any => ({ ...obj, }); @@ -3987,6 +4338,9 @@ export interface ListSecurityConfigurationsInput { } export namespace ListSecurityConfigurationsInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListSecurityConfigurationsInput): any => ({ ...obj, }); @@ -4008,6 +4362,9 @@ export interface SecurityConfigurationSummary { } export namespace SecurityConfigurationSummary { + /** + * @internal + */ export const filterSensitiveLog = (obj: SecurityConfigurationSummary): any => ({ ...obj, }); @@ -4028,6 +4385,9 @@ export interface ListSecurityConfigurationsOutput { } export namespace ListSecurityConfigurationsOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListSecurityConfigurationsOutput): any => ({ ...obj, }); @@ -4061,6 +4421,9 @@ export interface ListStepsInput { } export namespace ListStepsInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListStepsInput): any => ({ ...obj, }); @@ -4099,6 +4462,9 @@ export interface StepSummary { } export namespace StepSummary { + /** + * @internal + */ export const filterSensitiveLog = (obj: StepSummary): any => ({ ...obj, }); @@ -4121,6 +4487,9 @@ export interface ListStepsOutput { } export namespace ListStepsOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListStepsOutput): any => ({ ...obj, }); @@ -4134,6 +4503,9 @@ export interface ListStudiosInput { } export namespace ListStudiosInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListStudiosInput): any => ({ ...obj, }); @@ -4178,6 +4550,9 @@ export interface StudioSummary { } export namespace StudioSummary { + /** + * @internal + */ export const filterSensitiveLog = (obj: StudioSummary): any => ({ ...obj, }); @@ -4196,6 +4571,9 @@ export interface ListStudiosOutput { } export namespace ListStudiosOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListStudiosOutput): any => ({ ...obj, }); @@ -4220,6 +4598,9 @@ export interface ListStudioSessionMappingsInput { } export namespace ListStudioSessionMappingsInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListStudioSessionMappingsInput): any => ({ ...obj, }); @@ -4265,6 +4646,9 @@ export interface SessionMappingSummary { } export namespace SessionMappingSummary { + /** + * @internal + */ export const filterSensitiveLog = (obj: SessionMappingSummary): any => ({ ...obj, }); @@ -4284,6 +4668,9 @@ export interface ListStudioSessionMappingsOutput { } export namespace ListStudioSessionMappingsOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListStudioSessionMappingsOutput): any => ({ ...obj, }); @@ -4303,6 +4690,9 @@ export interface ModifyClusterInput { } export namespace ModifyClusterInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: ModifyClusterInput): any => ({ ...obj, }); @@ -4316,6 +4706,9 @@ export interface ModifyClusterOutput { } export namespace ModifyClusterOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: ModifyClusterOutput): any => ({ ...obj, }); @@ -4348,6 +4741,9 @@ export interface InstanceFleetModifyConfig { } export namespace InstanceFleetModifyConfig { + /** + * @internal + */ export const filterSensitiveLog = (obj: InstanceFleetModifyConfig): any => ({ ...obj, }); @@ -4366,6 +4762,9 @@ export interface ModifyInstanceFleetInput { } export namespace ModifyInstanceFleetInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: ModifyInstanceFleetInput): any => ({ ...obj, }); @@ -4391,6 +4790,9 @@ export interface PutAutoScalingPolicyInput { } export namespace PutAutoScalingPolicyInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: PutAutoScalingPolicyInput): any => ({ ...obj, }); @@ -4420,6 +4822,9 @@ export interface PutAutoScalingPolicyOutput { } export namespace PutAutoScalingPolicyOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: PutAutoScalingPolicyOutput): any => ({ ...obj, }); @@ -4428,6 +4833,9 @@ export namespace PutAutoScalingPolicyOutput { export interface PutBlockPublicAccessConfigurationOutput {} export namespace PutBlockPublicAccessConfigurationOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: PutBlockPublicAccessConfigurationOutput): any => ({ ...obj, }); @@ -4446,6 +4854,9 @@ export interface PutManagedScalingPolicyInput { } export namespace PutManagedScalingPolicyInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: PutManagedScalingPolicyInput): any => ({ ...obj, }); @@ -4454,6 +4865,9 @@ export namespace PutManagedScalingPolicyInput { export interface PutManagedScalingPolicyOutput {} export namespace PutManagedScalingPolicyOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: PutManagedScalingPolicyOutput): any => ({ ...obj, }); @@ -4473,6 +4887,9 @@ export interface RemoveAutoScalingPolicyInput { } export namespace RemoveAutoScalingPolicyInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: RemoveAutoScalingPolicyInput): any => ({ ...obj, }); @@ -4481,6 +4898,9 @@ export namespace RemoveAutoScalingPolicyInput { export interface RemoveAutoScalingPolicyOutput {} export namespace RemoveAutoScalingPolicyOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: RemoveAutoScalingPolicyOutput): any => ({ ...obj, }); @@ -4495,6 +4915,9 @@ export interface RemoveManagedScalingPolicyInput { } export namespace RemoveManagedScalingPolicyInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: RemoveManagedScalingPolicyInput): any => ({ ...obj, }); @@ -4503,6 +4926,9 @@ export namespace RemoveManagedScalingPolicyInput { export interface RemoveManagedScalingPolicyOutput {} export namespace RemoveManagedScalingPolicyOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: RemoveManagedScalingPolicyOutput): any => ({ ...obj, }); @@ -4525,6 +4951,9 @@ export interface RemoveTagsInput { } export namespace RemoveTagsInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: RemoveTagsInput): any => ({ ...obj, }); @@ -4536,6 +4965,9 @@ export namespace RemoveTagsInput { export interface RemoveTagsOutput {} export namespace RemoveTagsOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: RemoveTagsOutput): any => ({ ...obj, }); @@ -4559,6 +4991,9 @@ export interface SupportedProductConfig { } export namespace SupportedProductConfig { + /** + * @internal + */ export const filterSensitiveLog = (obj: SupportedProductConfig): any => ({ ...obj, }); @@ -4580,6 +5015,9 @@ export interface RunJobFlowOutput { } export namespace RunJobFlowOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: RunJobFlowOutput): any => ({ ...obj, }); @@ -4604,6 +5042,9 @@ export interface SetTerminationProtectionInput { } export namespace SetTerminationProtectionInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: SetTerminationProtectionInput): any => ({ ...obj, }); @@ -4628,6 +5069,9 @@ export interface SetVisibleToAllUsersInput { } export namespace SetVisibleToAllUsersInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: SetVisibleToAllUsersInput): any => ({ ...obj, }); @@ -4688,6 +5132,9 @@ export interface StartNotebookExecutionInput { } export namespace StartNotebookExecutionInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: StartNotebookExecutionInput): any => ({ ...obj, }); @@ -4701,6 +5148,9 @@ export interface StartNotebookExecutionOutput { } export namespace StartNotebookExecutionOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: StartNotebookExecutionOutput): any => ({ ...obj, }); @@ -4714,6 +5164,9 @@ export interface StopNotebookExecutionInput { } export namespace StopNotebookExecutionInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: StopNotebookExecutionInput): any => ({ ...obj, }); @@ -4730,6 +5183,9 @@ export interface TerminateJobFlowsInput { } export namespace TerminateJobFlowsInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: TerminateJobFlowsInput): any => ({ ...obj, }); @@ -4763,6 +5219,9 @@ export interface UpdateStudioInput { } export namespace UpdateStudioInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateStudioInput): any => ({ ...obj, }); @@ -4800,6 +5259,9 @@ export interface UpdateStudioSessionMappingInput { } export namespace UpdateStudioSessionMappingInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateStudioSessionMappingInput): any => ({ ...obj, }); @@ -4834,6 +5296,9 @@ export interface Configuration { } export namespace Configuration { + /** + * @internal + */ export const filterSensitiveLog = (obj: Configuration): any => ({ ...obj, }); @@ -4883,6 +5348,9 @@ export interface BlockPublicAccessConfiguration { } export namespace BlockPublicAccessConfiguration { + /** + * @internal + */ export const filterSensitiveLog = (obj: BlockPublicAccessConfiguration): any => ({ ...obj, }); @@ -5092,6 +5560,9 @@ export interface Cluster { } export namespace Cluster { + /** + * @internal + */ export const filterSensitiveLog = (obj: Cluster): any => ({ ...obj, }); @@ -5156,6 +5627,9 @@ export interface InstanceGroupConfig { } export namespace InstanceGroupConfig { + /** + * @internal + */ export const filterSensitiveLog = (obj: InstanceGroupConfig): any => ({ ...obj, }); @@ -5193,6 +5667,9 @@ export interface InstanceGroupModifyConfig { } export namespace InstanceGroupModifyConfig { + /** + * @internal + */ export const filterSensitiveLog = (obj: InstanceGroupModifyConfig): any => ({ ...obj, }); @@ -5252,6 +5729,9 @@ export interface InstanceTypeConfig { } export namespace InstanceTypeConfig { + /** + * @internal + */ export const filterSensitiveLog = (obj: InstanceTypeConfig): any => ({ ...obj, }); @@ -5310,6 +5790,9 @@ export interface InstanceTypeSpecification { } export namespace InstanceTypeSpecification { + /** + * @internal + */ export const filterSensitiveLog = (obj: InstanceTypeSpecification): any => ({ ...obj, }); @@ -5326,6 +5809,9 @@ export interface DescribeClusterOutput { } export namespace DescribeClusterOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeClusterOutput): any => ({ ...obj, }); @@ -5362,6 +5848,9 @@ export interface GetBlockPublicAccessConfigurationOutput { } export namespace GetBlockPublicAccessConfigurationOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetBlockPublicAccessConfigurationOutput): any => ({ ...obj, }); @@ -5389,6 +5878,9 @@ export interface PutBlockPublicAccessConfigurationInput { } export namespace PutBlockPublicAccessConfigurationInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: PutBlockPublicAccessConfigurationInput): any => ({ ...obj, }); @@ -5410,6 +5902,9 @@ export interface AddInstanceGroupsInput { } export namespace AddInstanceGroupsInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: AddInstanceGroupsInput): any => ({ ...obj, }); @@ -5519,6 +6014,9 @@ export interface InstanceFleet { } export namespace InstanceFleet { + /** + * @internal + */ export const filterSensitiveLog = (obj: InstanceFleet): any => ({ ...obj, }); @@ -5599,6 +6097,9 @@ export interface InstanceFleetConfig { } export namespace InstanceFleetConfig { + /** + * @internal + */ export const filterSensitiveLog = (obj: InstanceFleetConfig): any => ({ ...obj, }); @@ -5620,6 +6121,9 @@ export interface ModifyInstanceGroupsInput { } export namespace ModifyInstanceGroupsInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: ModifyInstanceGroupsInput): any => ({ ...obj, }); @@ -5638,6 +6142,9 @@ export interface AddInstanceFleetInput { } export namespace AddInstanceFleetInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: AddInstanceFleetInput): any => ({ ...obj, }); @@ -5748,6 +6255,9 @@ export interface InstanceGroup { } export namespace InstanceGroup { + /** + * @internal + */ export const filterSensitiveLog = (obj: InstanceGroup): any => ({ ...obj, }); @@ -5766,6 +6276,9 @@ export interface ListInstanceFleetsOutput { } export namespace ListInstanceFleetsOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListInstanceFleetsOutput): any => ({ ...obj, }); @@ -5787,6 +6300,9 @@ export interface ListInstanceGroupsOutput { } export namespace ListInstanceGroupsOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListInstanceGroupsOutput): any => ({ ...obj, }); @@ -5908,6 +6424,9 @@ export interface JobFlowInstancesConfig { } export namespace JobFlowInstancesConfig { + /** + * @internal + */ export const filterSensitiveLog = (obj: JobFlowInstancesConfig): any => ({ ...obj, }); @@ -6157,6 +6676,9 @@ export interface RunJobFlowInput { } export namespace RunJobFlowInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: RunJobFlowInput): any => ({ ...obj, }); diff --git a/clients/client-eventbridge/commands/ActivateEventSourceCommand.ts b/clients/client-eventbridge/commands/ActivateEventSourceCommand.ts index 6de35c436e32..e3645b48f8c1 100644 --- a/clients/client-eventbridge/commands/ActivateEventSourceCommand.ts +++ b/clients/client-eventbridge/commands/ActivateEventSourceCommand.ts @@ -23,6 +23,20 @@ export interface ActivateEventSourceCommandOutput extends __MetadataBearer {} /** *

Activates a partner event source that has been deactivated. Once activated, your matching * event bus will start receiving events from the event source.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { EventBridgeClient, ActivateEventSourceCommand } from "@aws-sdk/client-eventbridge"; // ES Modules import + * // const { EventBridgeClient, ActivateEventSourceCommand } = require("@aws-sdk/client-eventbridge"); // CommonJS import + * const client = new EventBridgeClient(config); + * const command = new ActivateEventSourceCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ActivateEventSourceCommandInput} for command's `input` shape. + * @see {@link ActivateEventSourceCommandOutput} for command's `response` shape. + * @see {@link EventBridgeClientResolvedConfig | config} for command's `input` shape. + * */ export class ActivateEventSourceCommand extends $Command< ActivateEventSourceCommandInput, diff --git a/clients/client-eventbridge/commands/CancelReplayCommand.ts b/clients/client-eventbridge/commands/CancelReplayCommand.ts index 5778fa6a4712..245bc1e35a09 100644 --- a/clients/client-eventbridge/commands/CancelReplayCommand.ts +++ b/clients/client-eventbridge/commands/CancelReplayCommand.ts @@ -22,6 +22,20 @@ export interface CancelReplayCommandOutput extends CancelReplayResponse, __Metad /** *

Cancels the specified replay.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { EventBridgeClient, CancelReplayCommand } from "@aws-sdk/client-eventbridge"; // ES Modules import + * // const { EventBridgeClient, CancelReplayCommand } = require("@aws-sdk/client-eventbridge"); // CommonJS import + * const client = new EventBridgeClient(config); + * const command = new CancelReplayCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CancelReplayCommandInput} for command's `input` shape. + * @see {@link CancelReplayCommandOutput} for command's `response` shape. + * @see {@link EventBridgeClientResolvedConfig | config} for command's `input` shape. + * */ export class CancelReplayCommand extends $Command< CancelReplayCommandInput, diff --git a/clients/client-eventbridge/commands/CreateApiDestinationCommand.ts b/clients/client-eventbridge/commands/CreateApiDestinationCommand.ts index 7c7693477285..efe135d2b1ea 100644 --- a/clients/client-eventbridge/commands/CreateApiDestinationCommand.ts +++ b/clients/client-eventbridge/commands/CreateApiDestinationCommand.ts @@ -23,6 +23,20 @@ export interface CreateApiDestinationCommandOutput extends CreateApiDestinationR /** *

Creates an API destination, which is an HTTP invocation endpoint configured as a target * for events.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { EventBridgeClient, CreateApiDestinationCommand } from "@aws-sdk/client-eventbridge"; // ES Modules import + * // const { EventBridgeClient, CreateApiDestinationCommand } = require("@aws-sdk/client-eventbridge"); // CommonJS import + * const client = new EventBridgeClient(config); + * const command = new CreateApiDestinationCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreateApiDestinationCommandInput} for command's `input` shape. + * @see {@link CreateApiDestinationCommandOutput} for command's `response` shape. + * @see {@link EventBridgeClientResolvedConfig | config} for command's `input` shape. + * */ export class CreateApiDestinationCommand extends $Command< CreateApiDestinationCommandInput, diff --git a/clients/client-eventbridge/commands/CreateArchiveCommand.ts b/clients/client-eventbridge/commands/CreateArchiveCommand.ts index 993f76fb587c..9d251167eb03 100644 --- a/clients/client-eventbridge/commands/CreateArchiveCommand.ts +++ b/clients/client-eventbridge/commands/CreateArchiveCommand.ts @@ -26,6 +26,20 @@ export interface CreateArchiveCommandOutput extends CreateArchiveResponse, __Met * 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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { EventBridgeClient, CreateArchiveCommand } from "@aws-sdk/client-eventbridge"; // ES Modules import + * // const { EventBridgeClient, CreateArchiveCommand } = require("@aws-sdk/client-eventbridge"); // CommonJS import + * const client = new EventBridgeClient(config); + * const command = new CreateArchiveCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreateArchiveCommandInput} for command's `input` shape. + * @see {@link CreateArchiveCommandOutput} for command's `response` shape. + * @see {@link EventBridgeClientResolvedConfig | config} for command's `input` shape. + * */ export class CreateArchiveCommand extends $Command< CreateArchiveCommandInput, diff --git a/clients/client-eventbridge/commands/CreateConnectionCommand.ts b/clients/client-eventbridge/commands/CreateConnectionCommand.ts index 6e4e74cd2b92..ed5ab9a81a5c 100644 --- a/clients/client-eventbridge/commands/CreateConnectionCommand.ts +++ b/clients/client-eventbridge/commands/CreateConnectionCommand.ts @@ -23,6 +23,20 @@ export interface CreateConnectionCommandOutput extends CreateConnectionResponse, /** *

Creates a connection. A connection defines the authorization type and credentials to use * for authorization with an API destination HTTP endpoint.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { EventBridgeClient, CreateConnectionCommand } from "@aws-sdk/client-eventbridge"; // ES Modules import + * // const { EventBridgeClient, CreateConnectionCommand } = require("@aws-sdk/client-eventbridge"); // CommonJS import + * const client = new EventBridgeClient(config); + * const command = new CreateConnectionCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreateConnectionCommandInput} for command's `input` shape. + * @see {@link CreateConnectionCommandOutput} for command's `response` shape. + * @see {@link EventBridgeClientResolvedConfig | config} for command's `input` shape. + * */ export class CreateConnectionCommand extends $Command< CreateConnectionCommandInput, diff --git a/clients/client-eventbridge/commands/CreateEventBusCommand.ts b/clients/client-eventbridge/commands/CreateEventBusCommand.ts index 14676bdeda87..15ec3245926a 100644 --- a/clients/client-eventbridge/commands/CreateEventBusCommand.ts +++ b/clients/client-eventbridge/commands/CreateEventBusCommand.ts @@ -24,6 +24,20 @@ export interface CreateEventBusCommandOutput extends CreateEventBusResponse, __M *

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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { EventBridgeClient, CreateEventBusCommand } from "@aws-sdk/client-eventbridge"; // ES Modules import + * // const { EventBridgeClient, CreateEventBusCommand } = require("@aws-sdk/client-eventbridge"); // CommonJS import + * const client = new EventBridgeClient(config); + * const command = new CreateEventBusCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreateEventBusCommandInput} for command's `input` shape. + * @see {@link CreateEventBusCommandOutput} for command's `response` shape. + * @see {@link EventBridgeClientResolvedConfig | config} for command's `input` shape. + * */ export class CreateEventBusCommand extends $Command< CreateEventBusCommandInput, diff --git a/clients/client-eventbridge/commands/CreatePartnerEventSourceCommand.ts b/clients/client-eventbridge/commands/CreatePartnerEventSourceCommand.ts index 3d35cd9a5f9f..9fc99f130096 100644 --- a/clients/client-eventbridge/commands/CreatePartnerEventSourceCommand.ts +++ b/clients/client-eventbridge/commands/CreatePartnerEventSourceCommand.ts @@ -45,6 +45,20 @@ export interface CreatePartnerEventSourceCommandOutput extends CreatePartnerEven * an event-generating resource within the partner system. The combination of * event_namespace and event_name should help AWS * customers decide whether to create an event bus to receive these events.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { EventBridgeClient, CreatePartnerEventSourceCommand } from "@aws-sdk/client-eventbridge"; // ES Modules import + * // const { EventBridgeClient, CreatePartnerEventSourceCommand } = require("@aws-sdk/client-eventbridge"); // CommonJS import + * const client = new EventBridgeClient(config); + * const command = new CreatePartnerEventSourceCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreatePartnerEventSourceCommandInput} for command's `input` shape. + * @see {@link CreatePartnerEventSourceCommandOutput} for command's `response` shape. + * @see {@link EventBridgeClientResolvedConfig | config} for command's `input` shape. + * */ export class CreatePartnerEventSourceCommand extends $Command< CreatePartnerEventSourceCommandInput, diff --git a/clients/client-eventbridge/commands/DeactivateEventSourceCommand.ts b/clients/client-eventbridge/commands/DeactivateEventSourceCommand.ts index 47995923730c..efd048da7cc9 100644 --- a/clients/client-eventbridge/commands/DeactivateEventSourceCommand.ts +++ b/clients/client-eventbridge/commands/DeactivateEventSourceCommand.ts @@ -26,6 +26,20 @@ export interface DeactivateEventSourceCommandOutput extends __MetadataBearer {} *

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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { EventBridgeClient, DeactivateEventSourceCommand } from "@aws-sdk/client-eventbridge"; // ES Modules import + * // const { EventBridgeClient, DeactivateEventSourceCommand } = require("@aws-sdk/client-eventbridge"); // CommonJS import + * const client = new EventBridgeClient(config); + * const command = new DeactivateEventSourceCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeactivateEventSourceCommandInput} for command's `input` shape. + * @see {@link DeactivateEventSourceCommandOutput} for command's `response` shape. + * @see {@link EventBridgeClientResolvedConfig | config} for command's `input` shape. + * */ export class DeactivateEventSourceCommand extends $Command< DeactivateEventSourceCommandInput, diff --git a/clients/client-eventbridge/commands/DeauthorizeConnectionCommand.ts b/clients/client-eventbridge/commands/DeauthorizeConnectionCommand.ts index 1f92c5420ece..c4c102e3fba9 100644 --- a/clients/client-eventbridge/commands/DeauthorizeConnectionCommand.ts +++ b/clients/client-eventbridge/commands/DeauthorizeConnectionCommand.ts @@ -23,6 +23,20 @@ export interface DeauthorizeConnectionCommandOutput extends DeauthorizeConnectio /** *

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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { EventBridgeClient, DeauthorizeConnectionCommand } from "@aws-sdk/client-eventbridge"; // ES Modules import + * // const { EventBridgeClient, DeauthorizeConnectionCommand } = require("@aws-sdk/client-eventbridge"); // CommonJS import + * const client = new EventBridgeClient(config); + * const command = new DeauthorizeConnectionCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeauthorizeConnectionCommandInput} for command's `input` shape. + * @see {@link DeauthorizeConnectionCommandOutput} for command's `response` shape. + * @see {@link EventBridgeClientResolvedConfig | config} for command's `input` shape. + * */ export class DeauthorizeConnectionCommand extends $Command< DeauthorizeConnectionCommandInput, diff --git a/clients/client-eventbridge/commands/DeleteApiDestinationCommand.ts b/clients/client-eventbridge/commands/DeleteApiDestinationCommand.ts index 391fb31e5b49..ba2c2b10ee53 100644 --- a/clients/client-eventbridge/commands/DeleteApiDestinationCommand.ts +++ b/clients/client-eventbridge/commands/DeleteApiDestinationCommand.ts @@ -22,6 +22,20 @@ export interface DeleteApiDestinationCommandOutput extends DeleteApiDestinationR /** *

Deletes the specified API destination.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { EventBridgeClient, DeleteApiDestinationCommand } from "@aws-sdk/client-eventbridge"; // ES Modules import + * // const { EventBridgeClient, DeleteApiDestinationCommand } = require("@aws-sdk/client-eventbridge"); // CommonJS import + * const client = new EventBridgeClient(config); + * const command = new DeleteApiDestinationCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteApiDestinationCommandInput} for command's `input` shape. + * @see {@link DeleteApiDestinationCommandOutput} for command's `response` shape. + * @see {@link EventBridgeClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteApiDestinationCommand extends $Command< DeleteApiDestinationCommandInput, diff --git a/clients/client-eventbridge/commands/DeleteArchiveCommand.ts b/clients/client-eventbridge/commands/DeleteArchiveCommand.ts index 44e7d0222e5d..775ea8fc9f5e 100644 --- a/clients/client-eventbridge/commands/DeleteArchiveCommand.ts +++ b/clients/client-eventbridge/commands/DeleteArchiveCommand.ts @@ -22,6 +22,20 @@ export interface DeleteArchiveCommandOutput extends DeleteArchiveResponse, __Met /** *

Deletes the specified archive.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { EventBridgeClient, DeleteArchiveCommand } from "@aws-sdk/client-eventbridge"; // ES Modules import + * // const { EventBridgeClient, DeleteArchiveCommand } = require("@aws-sdk/client-eventbridge"); // CommonJS import + * const client = new EventBridgeClient(config); + * const command = new DeleteArchiveCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteArchiveCommandInput} for command's `input` shape. + * @see {@link DeleteArchiveCommandOutput} for command's `response` shape. + * @see {@link EventBridgeClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteArchiveCommand extends $Command< DeleteArchiveCommandInput, diff --git a/clients/client-eventbridge/commands/DeleteConnectionCommand.ts b/clients/client-eventbridge/commands/DeleteConnectionCommand.ts index 1cdb93d1a516..ee17dfe82d4e 100644 --- a/clients/client-eventbridge/commands/DeleteConnectionCommand.ts +++ b/clients/client-eventbridge/commands/DeleteConnectionCommand.ts @@ -22,6 +22,20 @@ export interface DeleteConnectionCommandOutput extends DeleteConnectionResponse, /** *

Deletes a connection.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { EventBridgeClient, DeleteConnectionCommand } from "@aws-sdk/client-eventbridge"; // ES Modules import + * // const { EventBridgeClient, DeleteConnectionCommand } = require("@aws-sdk/client-eventbridge"); // CommonJS import + * const client = new EventBridgeClient(config); + * const command = new DeleteConnectionCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteConnectionCommandInput} for command's `input` shape. + * @see {@link DeleteConnectionCommandOutput} for command's `response` shape. + * @see {@link EventBridgeClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteConnectionCommand extends $Command< DeleteConnectionCommandInput, diff --git a/clients/client-eventbridge/commands/DeleteEventBusCommand.ts b/clients/client-eventbridge/commands/DeleteEventBusCommand.ts index 8d2fa018ef18..68b07a8c5e8c 100644 --- a/clients/client-eventbridge/commands/DeleteEventBusCommand.ts +++ b/clients/client-eventbridge/commands/DeleteEventBusCommand.ts @@ -23,6 +23,20 @@ export interface DeleteEventBusCommandOutput extends __MetadataBearer {} /** *

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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { EventBridgeClient, DeleteEventBusCommand } from "@aws-sdk/client-eventbridge"; // ES Modules import + * // const { EventBridgeClient, DeleteEventBusCommand } = require("@aws-sdk/client-eventbridge"); // CommonJS import + * const client = new EventBridgeClient(config); + * const command = new DeleteEventBusCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteEventBusCommandInput} for command's `input` shape. + * @see {@link DeleteEventBusCommandOutput} for command's `response` shape. + * @see {@link EventBridgeClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteEventBusCommand extends $Command< DeleteEventBusCommandInput, diff --git a/clients/client-eventbridge/commands/DeletePartnerEventSourceCommand.ts b/clients/client-eventbridge/commands/DeletePartnerEventSourceCommand.ts index 51301862a3f7..2c8a4a8dde12 100644 --- a/clients/client-eventbridge/commands/DeletePartnerEventSourceCommand.ts +++ b/clients/client-eventbridge/commands/DeletePartnerEventSourceCommand.ts @@ -26,6 +26,20 @@ export interface DeletePartnerEventSourceCommandOutput extends __MetadataBearer *

When you delete an event source, the status of the corresponding partner event bus in the * AWS customer account becomes DELETED.

*

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { EventBridgeClient, DeletePartnerEventSourceCommand } from "@aws-sdk/client-eventbridge"; // ES Modules import + * // const { EventBridgeClient, DeletePartnerEventSourceCommand } = require("@aws-sdk/client-eventbridge"); // CommonJS import + * const client = new EventBridgeClient(config); + * const command = new DeletePartnerEventSourceCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeletePartnerEventSourceCommandInput} for command's `input` shape. + * @see {@link DeletePartnerEventSourceCommandOutput} for command's `response` shape. + * @see {@link EventBridgeClientResolvedConfig | config} for command's `input` shape. + * */ export class DeletePartnerEventSourceCommand extends $Command< DeletePartnerEventSourceCommandInput, diff --git a/clients/client-eventbridge/commands/DeleteRuleCommand.ts b/clients/client-eventbridge/commands/DeleteRuleCommand.ts index 16efdef7587c..b0315c938378 100644 --- a/clients/client-eventbridge/commands/DeleteRuleCommand.ts +++ b/clients/client-eventbridge/commands/DeleteRuleCommand.ts @@ -31,6 +31,20 @@ export interface DeleteRuleCommandOutput extends __MetadataBearer {} * rules are created by those other AWS 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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { EventBridgeClient, DeleteRuleCommand } from "@aws-sdk/client-eventbridge"; // ES Modules import + * // const { EventBridgeClient, DeleteRuleCommand } = require("@aws-sdk/client-eventbridge"); // CommonJS import + * const client = new EventBridgeClient(config); + * const command = new DeleteRuleCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteRuleCommandInput} for command's `input` shape. + * @see {@link DeleteRuleCommandOutput} for command's `response` shape. + * @see {@link EventBridgeClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteRuleCommand extends $Command< DeleteRuleCommandInput, diff --git a/clients/client-eventbridge/commands/DescribeApiDestinationCommand.ts b/clients/client-eventbridge/commands/DescribeApiDestinationCommand.ts index 8964a9cbc9da..fc964843eeaf 100644 --- a/clients/client-eventbridge/commands/DescribeApiDestinationCommand.ts +++ b/clients/client-eventbridge/commands/DescribeApiDestinationCommand.ts @@ -22,6 +22,20 @@ export interface DescribeApiDestinationCommandOutput extends DescribeApiDestinat /** *

Retrieves details about an API destination.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { EventBridgeClient, DescribeApiDestinationCommand } from "@aws-sdk/client-eventbridge"; // ES Modules import + * // const { EventBridgeClient, DescribeApiDestinationCommand } = require("@aws-sdk/client-eventbridge"); // CommonJS import + * const client = new EventBridgeClient(config); + * const command = new DescribeApiDestinationCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeApiDestinationCommandInput} for command's `input` shape. + * @see {@link DescribeApiDestinationCommandOutput} for command's `response` shape. + * @see {@link EventBridgeClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeApiDestinationCommand extends $Command< DescribeApiDestinationCommandInput, diff --git a/clients/client-eventbridge/commands/DescribeArchiveCommand.ts b/clients/client-eventbridge/commands/DescribeArchiveCommand.ts index 241d057f1ada..173a34ac4452 100644 --- a/clients/client-eventbridge/commands/DescribeArchiveCommand.ts +++ b/clients/client-eventbridge/commands/DescribeArchiveCommand.ts @@ -22,6 +22,20 @@ export interface DescribeArchiveCommandOutput extends DescribeArchiveResponse, _ /** *

Retrieves details about an archive.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { EventBridgeClient, DescribeArchiveCommand } from "@aws-sdk/client-eventbridge"; // ES Modules import + * // const { EventBridgeClient, DescribeArchiveCommand } = require("@aws-sdk/client-eventbridge"); // CommonJS import + * const client = new EventBridgeClient(config); + * const command = new DescribeArchiveCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeArchiveCommandInput} for command's `input` shape. + * @see {@link DescribeArchiveCommandOutput} for command's `response` shape. + * @see {@link EventBridgeClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeArchiveCommand extends $Command< DescribeArchiveCommandInput, diff --git a/clients/client-eventbridge/commands/DescribeConnectionCommand.ts b/clients/client-eventbridge/commands/DescribeConnectionCommand.ts index 8afa0a60aab0..453886a0fc1f 100644 --- a/clients/client-eventbridge/commands/DescribeConnectionCommand.ts +++ b/clients/client-eventbridge/commands/DescribeConnectionCommand.ts @@ -22,6 +22,20 @@ export interface DescribeConnectionCommandOutput extends DescribeConnectionRespo /** *

Retrieves details about a connection.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { EventBridgeClient, DescribeConnectionCommand } from "@aws-sdk/client-eventbridge"; // ES Modules import + * // const { EventBridgeClient, DescribeConnectionCommand } = require("@aws-sdk/client-eventbridge"); // CommonJS import + * const client = new EventBridgeClient(config); + * const command = new DescribeConnectionCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeConnectionCommandInput} for command's `input` shape. + * @see {@link DescribeConnectionCommandOutput} for command's `response` shape. + * @see {@link EventBridgeClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeConnectionCommand extends $Command< DescribeConnectionCommandInput, diff --git a/clients/client-eventbridge/commands/DescribeEventBusCommand.ts b/clients/client-eventbridge/commands/DescribeEventBusCommand.ts index d42562304e1a..b7404ec2ec30 100644 --- a/clients/client-eventbridge/commands/DescribeEventBusCommand.ts +++ b/clients/client-eventbridge/commands/DescribeEventBusCommand.ts @@ -28,6 +28,20 @@ export interface DescribeEventBusCommandOutput extends DescribeEventBusResponse, *

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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { EventBridgeClient, DescribeEventBusCommand } from "@aws-sdk/client-eventbridge"; // ES Modules import + * // const { EventBridgeClient, DescribeEventBusCommand } = require("@aws-sdk/client-eventbridge"); // CommonJS import + * const client = new EventBridgeClient(config); + * const command = new DescribeEventBusCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeEventBusCommandInput} for command's `input` shape. + * @see {@link DescribeEventBusCommandOutput} for command's `response` shape. + * @see {@link EventBridgeClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeEventBusCommand extends $Command< DescribeEventBusCommandInput, diff --git a/clients/client-eventbridge/commands/DescribeEventSourceCommand.ts b/clients/client-eventbridge/commands/DescribeEventSourceCommand.ts index bf4e1d371af1..1131a8e2a409 100644 --- a/clients/client-eventbridge/commands/DescribeEventSourceCommand.ts +++ b/clients/client-eventbridge/commands/DescribeEventSourceCommand.ts @@ -23,6 +23,20 @@ export interface DescribeEventSourceCommandOutput extends DescribeEventSourceRes /** *

This operation lists details about a partner event source that is shared with your * account.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { EventBridgeClient, DescribeEventSourceCommand } from "@aws-sdk/client-eventbridge"; // ES Modules import + * // const { EventBridgeClient, DescribeEventSourceCommand } = require("@aws-sdk/client-eventbridge"); // CommonJS import + * const client = new EventBridgeClient(config); + * const command = new DescribeEventSourceCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeEventSourceCommandInput} for command's `input` shape. + * @see {@link DescribeEventSourceCommandOutput} for command's `response` shape. + * @see {@link EventBridgeClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeEventSourceCommand extends $Command< DescribeEventSourceCommandInput, diff --git a/clients/client-eventbridge/commands/DescribePartnerEventSourceCommand.ts b/clients/client-eventbridge/commands/DescribePartnerEventSourceCommand.ts index 419c77b9dcfd..fd07396d4b9e 100644 --- a/clients/client-eventbridge/commands/DescribePartnerEventSourceCommand.ts +++ b/clients/client-eventbridge/commands/DescribePartnerEventSourceCommand.ts @@ -25,6 +25,20 @@ export interface DescribePartnerEventSourceCommandOutput extends DescribePartner * they have created. AWS customers do not use this operation. Instead, AWS customers can use * DescribeEventSource to see details about a partner event source that is * shared with them.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { EventBridgeClient, DescribePartnerEventSourceCommand } from "@aws-sdk/client-eventbridge"; // ES Modules import + * // const { EventBridgeClient, DescribePartnerEventSourceCommand } = require("@aws-sdk/client-eventbridge"); // CommonJS import + * const client = new EventBridgeClient(config); + * const command = new DescribePartnerEventSourceCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribePartnerEventSourceCommandInput} for command's `input` shape. + * @see {@link DescribePartnerEventSourceCommandOutput} for command's `response` shape. + * @see {@link EventBridgeClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribePartnerEventSourceCommand extends $Command< DescribePartnerEventSourceCommandInput, diff --git a/clients/client-eventbridge/commands/DescribeReplayCommand.ts b/clients/client-eventbridge/commands/DescribeReplayCommand.ts index 0ab8866ba0a7..a5f5c463666a 100644 --- a/clients/client-eventbridge/commands/DescribeReplayCommand.ts +++ b/clients/client-eventbridge/commands/DescribeReplayCommand.ts @@ -30,6 +30,20 @@ export interface DescribeReplayCommandOutput extends DescribeReplayResponse, __M * 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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { EventBridgeClient, DescribeReplayCommand } from "@aws-sdk/client-eventbridge"; // ES Modules import + * // const { EventBridgeClient, DescribeReplayCommand } = require("@aws-sdk/client-eventbridge"); // CommonJS import + * const client = new EventBridgeClient(config); + * const command = new DescribeReplayCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeReplayCommandInput} for command's `input` shape. + * @see {@link DescribeReplayCommandOutput} for command's `response` shape. + * @see {@link EventBridgeClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeReplayCommand extends $Command< DescribeReplayCommandInput, diff --git a/clients/client-eventbridge/commands/DescribeRuleCommand.ts b/clients/client-eventbridge/commands/DescribeRuleCommand.ts index 502ea16b8da9..d3677e8f080f 100644 --- a/clients/client-eventbridge/commands/DescribeRuleCommand.ts +++ b/clients/client-eventbridge/commands/DescribeRuleCommand.ts @@ -24,6 +24,20 @@ export interface DescribeRuleCommandOutput extends DescribeRuleResponse, __Metad *

Describes the specified rule.

*

DescribeRule does not list the targets of a rule. To see the targets associated with a * rule, use ListTargetsByRule.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { EventBridgeClient, DescribeRuleCommand } from "@aws-sdk/client-eventbridge"; // ES Modules import + * // const { EventBridgeClient, DescribeRuleCommand } = require("@aws-sdk/client-eventbridge"); // CommonJS import + * const client = new EventBridgeClient(config); + * const command = new DescribeRuleCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeRuleCommandInput} for command's `input` shape. + * @see {@link DescribeRuleCommandOutput} for command's `response` shape. + * @see {@link EventBridgeClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeRuleCommand extends $Command< DescribeRuleCommandInput, diff --git a/clients/client-eventbridge/commands/DisableRuleCommand.ts b/clients/client-eventbridge/commands/DisableRuleCommand.ts index a12080e27a7d..980d11b11ea2 100644 --- a/clients/client-eventbridge/commands/DisableRuleCommand.ts +++ b/clients/client-eventbridge/commands/DisableRuleCommand.ts @@ -26,6 +26,20 @@ export interface DisableRuleCommandOutput extends __MetadataBearer {} * *

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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { EventBridgeClient, DisableRuleCommand } from "@aws-sdk/client-eventbridge"; // ES Modules import + * // const { EventBridgeClient, DisableRuleCommand } = require("@aws-sdk/client-eventbridge"); // CommonJS import + * const client = new EventBridgeClient(config); + * const command = new DisableRuleCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DisableRuleCommandInput} for command's `input` shape. + * @see {@link DisableRuleCommandOutput} for command's `response` shape. + * @see {@link EventBridgeClientResolvedConfig | config} for command's `input` shape. + * */ export class DisableRuleCommand extends $Command< DisableRuleCommandInput, diff --git a/clients/client-eventbridge/commands/EnableRuleCommand.ts b/clients/client-eventbridge/commands/EnableRuleCommand.ts index 7be816c014b3..1870165c8293 100644 --- a/clients/client-eventbridge/commands/EnableRuleCommand.ts +++ b/clients/client-eventbridge/commands/EnableRuleCommand.ts @@ -25,6 +25,20 @@ export interface EnableRuleCommandOutput extends __MetadataBearer {} * *

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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { EventBridgeClient, EnableRuleCommand } from "@aws-sdk/client-eventbridge"; // ES Modules import + * // const { EventBridgeClient, EnableRuleCommand } = require("@aws-sdk/client-eventbridge"); // CommonJS import + * const client = new EventBridgeClient(config); + * const command = new EnableRuleCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link EnableRuleCommandInput} for command's `input` shape. + * @see {@link EnableRuleCommandOutput} for command's `response` shape. + * @see {@link EventBridgeClientResolvedConfig | config} for command's `input` shape. + * */ export class EnableRuleCommand extends $Command< EnableRuleCommandInput, diff --git a/clients/client-eventbridge/commands/ListApiDestinationsCommand.ts b/clients/client-eventbridge/commands/ListApiDestinationsCommand.ts index 9175da9f9777..b2ed68a512a5 100644 --- a/clients/client-eventbridge/commands/ListApiDestinationsCommand.ts +++ b/clients/client-eventbridge/commands/ListApiDestinationsCommand.ts @@ -22,6 +22,20 @@ export interface ListApiDestinationsCommandOutput extends ListApiDestinationsRes /** *

Retrieves a list of API destination in the account in the current Region.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { EventBridgeClient, ListApiDestinationsCommand } from "@aws-sdk/client-eventbridge"; // ES Modules import + * // const { EventBridgeClient, ListApiDestinationsCommand } = require("@aws-sdk/client-eventbridge"); // CommonJS import + * const client = new EventBridgeClient(config); + * const command = new ListApiDestinationsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListApiDestinationsCommandInput} for command's `input` shape. + * @see {@link ListApiDestinationsCommandOutput} for command's `response` shape. + * @see {@link EventBridgeClientResolvedConfig | config} for command's `input` shape. + * */ export class ListApiDestinationsCommand extends $Command< ListApiDestinationsCommandInput, diff --git a/clients/client-eventbridge/commands/ListArchivesCommand.ts b/clients/client-eventbridge/commands/ListArchivesCommand.ts index e2bfcda97429..749343e15dbc 100644 --- a/clients/client-eventbridge/commands/ListArchivesCommand.ts +++ b/clients/client-eventbridge/commands/ListArchivesCommand.ts @@ -23,6 +23,20 @@ export interface ListArchivesCommandOutput extends ListArchivesResponse, __Metad /** *

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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { EventBridgeClient, ListArchivesCommand } from "@aws-sdk/client-eventbridge"; // ES Modules import + * // const { EventBridgeClient, ListArchivesCommand } = require("@aws-sdk/client-eventbridge"); // CommonJS import + * const client = new EventBridgeClient(config); + * const command = new ListArchivesCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListArchivesCommandInput} for command's `input` shape. + * @see {@link ListArchivesCommandOutput} for command's `response` shape. + * @see {@link EventBridgeClientResolvedConfig | config} for command's `input` shape. + * */ export class ListArchivesCommand extends $Command< ListArchivesCommandInput, diff --git a/clients/client-eventbridge/commands/ListConnectionsCommand.ts b/clients/client-eventbridge/commands/ListConnectionsCommand.ts index 7efb37bd85f2..4a2ae8642127 100644 --- a/clients/client-eventbridge/commands/ListConnectionsCommand.ts +++ b/clients/client-eventbridge/commands/ListConnectionsCommand.ts @@ -22,6 +22,20 @@ export interface ListConnectionsCommandOutput extends ListConnectionsResponse, _ /** *

Retrieves a list of connections from the account.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { EventBridgeClient, ListConnectionsCommand } from "@aws-sdk/client-eventbridge"; // ES Modules import + * // const { EventBridgeClient, ListConnectionsCommand } = require("@aws-sdk/client-eventbridge"); // CommonJS import + * const client = new EventBridgeClient(config); + * const command = new ListConnectionsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListConnectionsCommandInput} for command's `input` shape. + * @see {@link ListConnectionsCommandOutput} for command's `response` shape. + * @see {@link EventBridgeClientResolvedConfig | config} for command's `input` shape. + * */ export class ListConnectionsCommand extends $Command< ListConnectionsCommandInput, diff --git a/clients/client-eventbridge/commands/ListEventBusesCommand.ts b/clients/client-eventbridge/commands/ListEventBusesCommand.ts index 5354c2658530..88f9ec48c14c 100644 --- a/clients/client-eventbridge/commands/ListEventBusesCommand.ts +++ b/clients/client-eventbridge/commands/ListEventBusesCommand.ts @@ -23,6 +23,20 @@ export interface ListEventBusesCommandOutput extends ListEventBusesResponse, __M /** *

Lists all the event buses in your account, including the default event bus, custom event * buses, and partner event buses.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { EventBridgeClient, ListEventBusesCommand } from "@aws-sdk/client-eventbridge"; // ES Modules import + * // const { EventBridgeClient, ListEventBusesCommand } = require("@aws-sdk/client-eventbridge"); // CommonJS import + * const client = new EventBridgeClient(config); + * const command = new ListEventBusesCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListEventBusesCommandInput} for command's `input` shape. + * @see {@link ListEventBusesCommandOutput} for command's `response` shape. + * @see {@link EventBridgeClientResolvedConfig | config} for command's `input` shape. + * */ export class ListEventBusesCommand extends $Command< ListEventBusesCommandInput, diff --git a/clients/client-eventbridge/commands/ListEventSourcesCommand.ts b/clients/client-eventbridge/commands/ListEventSourcesCommand.ts index 04063572e9ed..6838f766ef28 100644 --- a/clients/client-eventbridge/commands/ListEventSourcesCommand.ts +++ b/clients/client-eventbridge/commands/ListEventSourcesCommand.ts @@ -23,6 +23,20 @@ export interface ListEventSourcesCommandOutput extends ListEventSourcesResponse, /** *

You can use this to see all the partner event sources that have been shared with your AWS * account. For more information about partner event sources, see CreateEventBus.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { EventBridgeClient, ListEventSourcesCommand } from "@aws-sdk/client-eventbridge"; // ES Modules import + * // const { EventBridgeClient, ListEventSourcesCommand } = require("@aws-sdk/client-eventbridge"); // CommonJS import + * const client = new EventBridgeClient(config); + * const command = new ListEventSourcesCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListEventSourcesCommandInput} for command's `input` shape. + * @see {@link ListEventSourcesCommandOutput} for command's `response` shape. + * @see {@link EventBridgeClientResolvedConfig | config} for command's `input` shape. + * */ export class ListEventSourcesCommand extends $Command< ListEventSourcesCommandInput, diff --git a/clients/client-eventbridge/commands/ListPartnerEventSourceAccountsCommand.ts b/clients/client-eventbridge/commands/ListPartnerEventSourceAccountsCommand.ts index 695121074d18..e60cefb0a572 100644 --- a/clients/client-eventbridge/commands/ListPartnerEventSourceAccountsCommand.ts +++ b/clients/client-eventbridge/commands/ListPartnerEventSourceAccountsCommand.ts @@ -26,6 +26,20 @@ export interface ListPartnerEventSourceAccountsCommandOutput *

An SaaS partner can use this operation to display the AWS account ID that a particular * partner event source name is associated with. This operation is not used by AWS * customers.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { EventBridgeClient, ListPartnerEventSourceAccountsCommand } from "@aws-sdk/client-eventbridge"; // ES Modules import + * // const { EventBridgeClient, ListPartnerEventSourceAccountsCommand } = require("@aws-sdk/client-eventbridge"); // CommonJS import + * const client = new EventBridgeClient(config); + * const command = new ListPartnerEventSourceAccountsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListPartnerEventSourceAccountsCommandInput} for command's `input` shape. + * @see {@link ListPartnerEventSourceAccountsCommandOutput} for command's `response` shape. + * @see {@link EventBridgeClientResolvedConfig | config} for command's `input` shape. + * */ export class ListPartnerEventSourceAccountsCommand extends $Command< ListPartnerEventSourceAccountsCommandInput, diff --git a/clients/client-eventbridge/commands/ListPartnerEventSourcesCommand.ts b/clients/client-eventbridge/commands/ListPartnerEventSourcesCommand.ts index 31593757625d..2f51a8b6af65 100644 --- a/clients/client-eventbridge/commands/ListPartnerEventSourcesCommand.ts +++ b/clients/client-eventbridge/commands/ListPartnerEventSourcesCommand.ts @@ -23,6 +23,20 @@ export interface ListPartnerEventSourcesCommandOutput extends ListPartnerEventSo /** *

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 AWS customers.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { EventBridgeClient, ListPartnerEventSourcesCommand } from "@aws-sdk/client-eventbridge"; // ES Modules import + * // const { EventBridgeClient, ListPartnerEventSourcesCommand } = require("@aws-sdk/client-eventbridge"); // CommonJS import + * const client = new EventBridgeClient(config); + * const command = new ListPartnerEventSourcesCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListPartnerEventSourcesCommandInput} for command's `input` shape. + * @see {@link ListPartnerEventSourcesCommandOutput} for command's `response` shape. + * @see {@link EventBridgeClientResolvedConfig | config} for command's `input` shape. + * */ export class ListPartnerEventSourcesCommand extends $Command< ListPartnerEventSourcesCommandInput, diff --git a/clients/client-eventbridge/commands/ListReplaysCommand.ts b/clients/client-eventbridge/commands/ListReplaysCommand.ts index c9328a15bcba..7e11fde298da 100644 --- a/clients/client-eventbridge/commands/ListReplaysCommand.ts +++ b/clients/client-eventbridge/commands/ListReplaysCommand.ts @@ -23,6 +23,20 @@ export interface ListReplaysCommandOutput extends ListReplaysResponse, __Metadat /** *

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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { EventBridgeClient, ListReplaysCommand } from "@aws-sdk/client-eventbridge"; // ES Modules import + * // const { EventBridgeClient, ListReplaysCommand } = require("@aws-sdk/client-eventbridge"); // CommonJS import + * const client = new EventBridgeClient(config); + * const command = new ListReplaysCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListReplaysCommandInput} for command's `input` shape. + * @see {@link ListReplaysCommandOutput} for command's `response` shape. + * @see {@link EventBridgeClientResolvedConfig | config} for command's `input` shape. + * */ export class ListReplaysCommand extends $Command< ListReplaysCommandInput, diff --git a/clients/client-eventbridge/commands/ListRuleNamesByTargetCommand.ts b/clients/client-eventbridge/commands/ListRuleNamesByTargetCommand.ts index 7e29c87317eb..cf94037937c7 100644 --- a/clients/client-eventbridge/commands/ListRuleNamesByTargetCommand.ts +++ b/clients/client-eventbridge/commands/ListRuleNamesByTargetCommand.ts @@ -23,6 +23,20 @@ export interface ListRuleNamesByTargetCommandOutput extends ListRuleNamesByTarge /** *

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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { EventBridgeClient, ListRuleNamesByTargetCommand } from "@aws-sdk/client-eventbridge"; // ES Modules import + * // const { EventBridgeClient, ListRuleNamesByTargetCommand } = require("@aws-sdk/client-eventbridge"); // CommonJS import + * const client = new EventBridgeClient(config); + * const command = new ListRuleNamesByTargetCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListRuleNamesByTargetCommandInput} for command's `input` shape. + * @see {@link ListRuleNamesByTargetCommandOutput} for command's `response` shape. + * @see {@link EventBridgeClientResolvedConfig | config} for command's `input` shape. + * */ export class ListRuleNamesByTargetCommand extends $Command< ListRuleNamesByTargetCommandInput, diff --git a/clients/client-eventbridge/commands/ListRulesCommand.ts b/clients/client-eventbridge/commands/ListRulesCommand.ts index cce5e7acce95..a6fe315abe59 100644 --- a/clients/client-eventbridge/commands/ListRulesCommand.ts +++ b/clients/client-eventbridge/commands/ListRulesCommand.ts @@ -23,6 +23,20 @@ export interface ListRulesCommandOutput extends ListRulesResponse, __MetadataBea * *

ListRules does not list the targets of a rule. To see the targets associated with a rule, * use ListTargetsByRule.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { EventBridgeClient, ListRulesCommand } from "@aws-sdk/client-eventbridge"; // ES Modules import + * // const { EventBridgeClient, ListRulesCommand } = require("@aws-sdk/client-eventbridge"); // CommonJS import + * const client = new EventBridgeClient(config); + * const command = new ListRulesCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListRulesCommandInput} for command's `input` shape. + * @see {@link ListRulesCommandOutput} for command's `response` shape. + * @see {@link EventBridgeClientResolvedConfig | config} for command's `input` shape. + * */ export class ListRulesCommand extends $Command< ListRulesCommandInput, diff --git a/clients/client-eventbridge/commands/ListTagsForResourceCommand.ts b/clients/client-eventbridge/commands/ListTagsForResourceCommand.ts index 365f8db6d05e..f1255e167d4a 100644 --- a/clients/client-eventbridge/commands/ListTagsForResourceCommand.ts +++ b/clients/client-eventbridge/commands/ListTagsForResourceCommand.ts @@ -23,6 +23,20 @@ export interface ListTagsForResourceCommandOutput extends ListTagsForResourceRes /** *

Displays the tags associated with an EventBridge resource. In EventBridge, rules and event * buses can be tagged.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { EventBridgeClient, ListTagsForResourceCommand } from "@aws-sdk/client-eventbridge"; // ES Modules import + * // const { EventBridgeClient, ListTagsForResourceCommand } = require("@aws-sdk/client-eventbridge"); // CommonJS import + * const client = new EventBridgeClient(config); + * const command = new ListTagsForResourceCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListTagsForResourceCommandInput} for command's `input` shape. + * @see {@link ListTagsForResourceCommandOutput} for command's `response` shape. + * @see {@link EventBridgeClientResolvedConfig | config} for command's `input` shape. + * */ export class ListTagsForResourceCommand extends $Command< ListTagsForResourceCommandInput, diff --git a/clients/client-eventbridge/commands/ListTargetsByRuleCommand.ts b/clients/client-eventbridge/commands/ListTargetsByRuleCommand.ts index 0e8a8b1e7369..e19ed6a141f1 100644 --- a/clients/client-eventbridge/commands/ListTargetsByRuleCommand.ts +++ b/clients/client-eventbridge/commands/ListTargetsByRuleCommand.ts @@ -22,6 +22,20 @@ export interface ListTargetsByRuleCommandOutput extends ListTargetsByRuleRespons /** *

Lists the targets assigned to the specified rule.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { EventBridgeClient, ListTargetsByRuleCommand } from "@aws-sdk/client-eventbridge"; // ES Modules import + * // const { EventBridgeClient, ListTargetsByRuleCommand } = require("@aws-sdk/client-eventbridge"); // CommonJS import + * const client = new EventBridgeClient(config); + * const command = new ListTargetsByRuleCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListTargetsByRuleCommandInput} for command's `input` shape. + * @see {@link ListTargetsByRuleCommandOutput} for command's `response` shape. + * @see {@link EventBridgeClientResolvedConfig | config} for command's `input` shape. + * */ export class ListTargetsByRuleCommand extends $Command< ListTargetsByRuleCommandInput, diff --git a/clients/client-eventbridge/commands/PutEventsCommand.ts b/clients/client-eventbridge/commands/PutEventsCommand.ts index 92e18263e8ba..a73604dc22de 100644 --- a/clients/client-eventbridge/commands/PutEventsCommand.ts +++ b/clients/client-eventbridge/commands/PutEventsCommand.ts @@ -19,6 +19,20 @@ export interface PutEventsCommandOutput extends PutEventsResponse, __MetadataBea /** *

Sends custom events to Amazon EventBridge so that they can be matched to rules.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { EventBridgeClient, PutEventsCommand } from "@aws-sdk/client-eventbridge"; // ES Modules import + * // const { EventBridgeClient, PutEventsCommand } = require("@aws-sdk/client-eventbridge"); // CommonJS import + * const client = new EventBridgeClient(config); + * const command = new PutEventsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link PutEventsCommandInput} for command's `input` shape. + * @see {@link PutEventsCommandOutput} for command's `response` shape. + * @see {@link EventBridgeClientResolvedConfig | config} for command's `input` shape. + * */ export class PutEventsCommand extends $Command< PutEventsCommandInput, diff --git a/clients/client-eventbridge/commands/PutPartnerEventsCommand.ts b/clients/client-eventbridge/commands/PutPartnerEventsCommand.ts index d93bb60920f9..4401495a3377 100644 --- a/clients/client-eventbridge/commands/PutPartnerEventsCommand.ts +++ b/clients/client-eventbridge/commands/PutPartnerEventsCommand.ts @@ -23,6 +23,20 @@ export interface PutPartnerEventsCommandOutput extends PutPartnerEventsResponse, /** *

This is used by SaaS partners to write events to a customer's partner event bus. AWS * customers do not use this operation.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { EventBridgeClient, PutPartnerEventsCommand } from "@aws-sdk/client-eventbridge"; // ES Modules import + * // const { EventBridgeClient, PutPartnerEventsCommand } = require("@aws-sdk/client-eventbridge"); // CommonJS import + * const client = new EventBridgeClient(config); + * const command = new PutPartnerEventsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link PutPartnerEventsCommandInput} for command's `input` shape. + * @see {@link PutPartnerEventsCommandOutput} for command's `response` shape. + * @see {@link EventBridgeClientResolvedConfig | config} for command's `input` shape. + * */ export class PutPartnerEventsCommand extends $Command< PutPartnerEventsCommandInput, diff --git a/clients/client-eventbridge/commands/PutPermissionCommand.ts b/clients/client-eventbridge/commands/PutPermissionCommand.ts index 479aac2c43e3..03bc8c0d56dc 100644 --- a/clients/client-eventbridge/commands/PutPermissionCommand.ts +++ b/clients/client-eventbridge/commands/PutPermissionCommand.ts @@ -41,6 +41,20 @@ export interface PutPermissionCommandOutput extends __MetadataBearer {} * Guide.

* *

The permission policy on the default event bus cannot exceed 10 KB in size.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { EventBridgeClient, PutPermissionCommand } from "@aws-sdk/client-eventbridge"; // ES Modules import + * // const { EventBridgeClient, PutPermissionCommand } = require("@aws-sdk/client-eventbridge"); // CommonJS import + * const client = new EventBridgeClient(config); + * const command = new PutPermissionCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link PutPermissionCommandInput} for command's `input` shape. + * @see {@link PutPermissionCommandOutput} for command's `response` shape. + * @see {@link EventBridgeClientResolvedConfig | config} for command's `input` shape. + * */ export class PutPermissionCommand extends $Command< PutPermissionCommandInput, diff --git a/clients/client-eventbridge/commands/PutRuleCommand.ts b/clients/client-eventbridge/commands/PutRuleCommand.ts index 693726b8fe1f..648ca2212d50 100644 --- a/clients/client-eventbridge/commands/PutRuleCommand.ts +++ b/clients/client-eventbridge/commands/PutRuleCommand.ts @@ -65,6 +65,20 @@ export interface PutRuleCommandOutput extends PutRuleResponse, __MetadataBearer * budgeting, which alerts you when charges exceed your specified limit. For more information, * see Managing Your Costs with * Budgets.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { EventBridgeClient, PutRuleCommand } from "@aws-sdk/client-eventbridge"; // ES Modules import + * // const { EventBridgeClient, PutRuleCommand } = require("@aws-sdk/client-eventbridge"); // CommonJS import + * const client = new EventBridgeClient(config); + * const command = new PutRuleCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link PutRuleCommandInput} for command's `input` shape. + * @see {@link PutRuleCommandOutput} for command's `response` shape. + * @see {@link EventBridgeClientResolvedConfig | config} for command's `input` shape. + * */ export class PutRuleCommand extends $Command< PutRuleCommandInput, diff --git a/clients/client-eventbridge/commands/PutTargetsCommand.ts b/clients/client-eventbridge/commands/PutTargetsCommand.ts index 2dde3b3377d2..147524ca80c7 100644 --- a/clients/client-eventbridge/commands/PutTargetsCommand.ts +++ b/clients/client-eventbridge/commands/PutTargetsCommand.ts @@ -169,6 +169,20 @@ export interface PutTargetsCommandOutput extends PutTargetsResponse, __MetadataB *

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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { EventBridgeClient, PutTargetsCommand } from "@aws-sdk/client-eventbridge"; // ES Modules import + * // const { EventBridgeClient, PutTargetsCommand } = require("@aws-sdk/client-eventbridge"); // CommonJS import + * const client = new EventBridgeClient(config); + * const command = new PutTargetsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link PutTargetsCommandInput} for command's `input` shape. + * @see {@link PutTargetsCommandOutput} for command's `response` shape. + * @see {@link EventBridgeClientResolvedConfig | config} for command's `input` shape. + * */ export class PutTargetsCommand extends $Command< PutTargetsCommandInput, diff --git a/clients/client-eventbridge/commands/RemovePermissionCommand.ts b/clients/client-eventbridge/commands/RemovePermissionCommand.ts index 9fa1705d6e53..ece475f4be22 100644 --- a/clients/client-eventbridge/commands/RemovePermissionCommand.ts +++ b/clients/client-eventbridge/commands/RemovePermissionCommand.ts @@ -25,6 +25,20 @@ export interface RemovePermissionCommandOutput extends __MetadataBearer {} * 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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { EventBridgeClient, RemovePermissionCommand } from "@aws-sdk/client-eventbridge"; // ES Modules import + * // const { EventBridgeClient, RemovePermissionCommand } = require("@aws-sdk/client-eventbridge"); // CommonJS import + * const client = new EventBridgeClient(config); + * const command = new RemovePermissionCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link RemovePermissionCommandInput} for command's `input` shape. + * @see {@link RemovePermissionCommandOutput} for command's `response` shape. + * @see {@link EventBridgeClientResolvedConfig | config} for command's `input` shape. + * */ export class RemovePermissionCommand extends $Command< RemovePermissionCommandInput, diff --git a/clients/client-eventbridge/commands/RemoveTargetsCommand.ts b/clients/client-eventbridge/commands/RemoveTargetsCommand.ts index 67f367e4478c..3673a54f9f56 100644 --- a/clients/client-eventbridge/commands/RemoveTargetsCommand.ts +++ b/clients/client-eventbridge/commands/RemoveTargetsCommand.ts @@ -30,6 +30,20 @@ export interface RemoveTargetsCommandOutput extends RemoveTargetsResponse, __Met *

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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { EventBridgeClient, RemoveTargetsCommand } from "@aws-sdk/client-eventbridge"; // ES Modules import + * // const { EventBridgeClient, RemoveTargetsCommand } = require("@aws-sdk/client-eventbridge"); // CommonJS import + * const client = new EventBridgeClient(config); + * const command = new RemoveTargetsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link RemoveTargetsCommandInput} for command's `input` shape. + * @see {@link RemoveTargetsCommandOutput} for command's `response` shape. + * @see {@link EventBridgeClientResolvedConfig | config} for command's `input` shape. + * */ export class RemoveTargetsCommand extends $Command< RemoveTargetsCommandInput, diff --git a/clients/client-eventbridge/commands/StartReplayCommand.ts b/clients/client-eventbridge/commands/StartReplayCommand.ts index 164c66ccf392..aa909692a52b 100644 --- a/clients/client-eventbridge/commands/StartReplayCommand.ts +++ b/clients/client-eventbridge/commands/StartReplayCommand.ts @@ -30,6 +30,20 @@ export interface StartReplayCommandOutput extends StartReplayResponse, __Metadat * 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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { EventBridgeClient, StartReplayCommand } from "@aws-sdk/client-eventbridge"; // ES Modules import + * // const { EventBridgeClient, StartReplayCommand } = require("@aws-sdk/client-eventbridge"); // CommonJS import + * const client = new EventBridgeClient(config); + * const command = new StartReplayCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link StartReplayCommandInput} for command's `input` shape. + * @see {@link StartReplayCommandOutput} for command's `response` shape. + * @see {@link EventBridgeClientResolvedConfig | config} for command's `input` shape. + * */ export class StartReplayCommand extends $Command< StartReplayCommandInput, diff --git a/clients/client-eventbridge/commands/TagResourceCommand.ts b/clients/client-eventbridge/commands/TagResourceCommand.ts index 0bf8a546523f..2b5cfbceb2f1 100644 --- a/clients/client-eventbridge/commands/TagResourceCommand.ts +++ b/clients/client-eventbridge/commands/TagResourceCommand.ts @@ -32,6 +32,20 @@ export interface TagResourceCommandOutput extends TagResourceResponse, __Metadat * 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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { EventBridgeClient, TagResourceCommand } from "@aws-sdk/client-eventbridge"; // ES Modules import + * // const { EventBridgeClient, TagResourceCommand } = require("@aws-sdk/client-eventbridge"); // CommonJS import + * const client = new EventBridgeClient(config); + * const command = new TagResourceCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link TagResourceCommandInput} for command's `input` shape. + * @see {@link TagResourceCommandOutput} for command's `response` shape. + * @see {@link EventBridgeClientResolvedConfig | config} for command's `input` shape. + * */ export class TagResourceCommand extends $Command< TagResourceCommandInput, diff --git a/clients/client-eventbridge/commands/TestEventPatternCommand.ts b/clients/client-eventbridge/commands/TestEventPatternCommand.ts index 318c510214e5..56b1eea4c989 100644 --- a/clients/client-eventbridge/commands/TestEventPatternCommand.ts +++ b/clients/client-eventbridge/commands/TestEventPatternCommand.ts @@ -26,6 +26,20 @@ export interface TestEventPatternCommandOutput extends TestEventPatternResponse, * 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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { EventBridgeClient, TestEventPatternCommand } from "@aws-sdk/client-eventbridge"; // ES Modules import + * // const { EventBridgeClient, TestEventPatternCommand } = require("@aws-sdk/client-eventbridge"); // CommonJS import + * const client = new EventBridgeClient(config); + * const command = new TestEventPatternCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link TestEventPatternCommandInput} for command's `input` shape. + * @see {@link TestEventPatternCommandOutput} for command's `response` shape. + * @see {@link EventBridgeClientResolvedConfig | config} for command's `input` shape. + * */ export class TestEventPatternCommand extends $Command< TestEventPatternCommandInput, diff --git a/clients/client-eventbridge/commands/UntagResourceCommand.ts b/clients/client-eventbridge/commands/UntagResourceCommand.ts index b3795e7fe36a..beae0b7a1332 100644 --- a/clients/client-eventbridge/commands/UntagResourceCommand.ts +++ b/clients/client-eventbridge/commands/UntagResourceCommand.ts @@ -23,6 +23,20 @@ export interface UntagResourceCommandOutput extends UntagResourceResponse, __Met /** *

Removes one or more tags from the specified EventBridge resource. In Amazon EventBridge * (CloudWatch Events, rules and event buses can be tagged.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { EventBridgeClient, UntagResourceCommand } from "@aws-sdk/client-eventbridge"; // ES Modules import + * // const { EventBridgeClient, UntagResourceCommand } = require("@aws-sdk/client-eventbridge"); // CommonJS import + * const client = new EventBridgeClient(config); + * const command = new UntagResourceCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link UntagResourceCommandInput} for command's `input` shape. + * @see {@link UntagResourceCommandOutput} for command's `response` shape. + * @see {@link EventBridgeClientResolvedConfig | config} for command's `input` shape. + * */ export class UntagResourceCommand extends $Command< UntagResourceCommandInput, diff --git a/clients/client-eventbridge/commands/UpdateApiDestinationCommand.ts b/clients/client-eventbridge/commands/UpdateApiDestinationCommand.ts index 298080933a73..e8a97d50ef38 100644 --- a/clients/client-eventbridge/commands/UpdateApiDestinationCommand.ts +++ b/clients/client-eventbridge/commands/UpdateApiDestinationCommand.ts @@ -22,6 +22,20 @@ export interface UpdateApiDestinationCommandOutput extends UpdateApiDestinationR /** *

Updates an API destination.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { EventBridgeClient, UpdateApiDestinationCommand } from "@aws-sdk/client-eventbridge"; // ES Modules import + * // const { EventBridgeClient, UpdateApiDestinationCommand } = require("@aws-sdk/client-eventbridge"); // CommonJS import + * const client = new EventBridgeClient(config); + * const command = new UpdateApiDestinationCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link UpdateApiDestinationCommandInput} for command's `input` shape. + * @see {@link UpdateApiDestinationCommandOutput} for command's `response` shape. + * @see {@link EventBridgeClientResolvedConfig | config} for command's `input` shape. + * */ export class UpdateApiDestinationCommand extends $Command< UpdateApiDestinationCommandInput, diff --git a/clients/client-eventbridge/commands/UpdateArchiveCommand.ts b/clients/client-eventbridge/commands/UpdateArchiveCommand.ts index 184a5e9e4964..606f5fc4f10b 100644 --- a/clients/client-eventbridge/commands/UpdateArchiveCommand.ts +++ b/clients/client-eventbridge/commands/UpdateArchiveCommand.ts @@ -22,6 +22,20 @@ export interface UpdateArchiveCommandOutput extends UpdateArchiveResponse, __Met /** *

Updates the specified archive.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { EventBridgeClient, UpdateArchiveCommand } from "@aws-sdk/client-eventbridge"; // ES Modules import + * // const { EventBridgeClient, UpdateArchiveCommand } = require("@aws-sdk/client-eventbridge"); // CommonJS import + * const client = new EventBridgeClient(config); + * const command = new UpdateArchiveCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link UpdateArchiveCommandInput} for command's `input` shape. + * @see {@link UpdateArchiveCommandOutput} for command's `response` shape. + * @see {@link EventBridgeClientResolvedConfig | config} for command's `input` shape. + * */ export class UpdateArchiveCommand extends $Command< UpdateArchiveCommandInput, diff --git a/clients/client-eventbridge/commands/UpdateConnectionCommand.ts b/clients/client-eventbridge/commands/UpdateConnectionCommand.ts index 26de51172f3e..c196290c592f 100644 --- a/clients/client-eventbridge/commands/UpdateConnectionCommand.ts +++ b/clients/client-eventbridge/commands/UpdateConnectionCommand.ts @@ -22,6 +22,20 @@ export interface UpdateConnectionCommandOutput extends UpdateConnectionResponse, /** *

Updates settings for a connection.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { EventBridgeClient, UpdateConnectionCommand } from "@aws-sdk/client-eventbridge"; // ES Modules import + * // const { EventBridgeClient, UpdateConnectionCommand } = require("@aws-sdk/client-eventbridge"); // CommonJS import + * const client = new EventBridgeClient(config); + * const command = new UpdateConnectionCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link UpdateConnectionCommandInput} for command's `input` shape. + * @see {@link UpdateConnectionCommandOutput} for command's `response` shape. + * @see {@link EventBridgeClientResolvedConfig | config} for command's `input` shape. + * */ export class UpdateConnectionCommand extends $Command< UpdateConnectionCommandInput, diff --git a/clients/client-eventbridge/models/models_0.ts b/clients/client-eventbridge/models/models_0.ts index b1172f60f3fc..c84bc9c09f7f 100644 --- a/clients/client-eventbridge/models/models_0.ts +++ b/clients/client-eventbridge/models/models_0.ts @@ -9,6 +9,9 @@ export interface ActivateEventSourceRequest { } export namespace ActivateEventSourceRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ActivateEventSourceRequest): any => ({ ...obj, }); @@ -24,6 +27,9 @@ export interface ConcurrentModificationException extends __SmithyException, $Met } export namespace ConcurrentModificationException { + /** + * @internal + */ export const filterSensitiveLog = (obj: ConcurrentModificationException): any => ({ ...obj, }); @@ -39,6 +45,9 @@ export interface InternalException extends __SmithyException, $MetadataBearer { } export namespace InternalException { + /** + * @internal + */ export const filterSensitiveLog = (obj: InternalException): any => ({ ...obj, }); @@ -54,6 +63,9 @@ export interface InvalidStateException extends __SmithyException, $MetadataBeare } export namespace InvalidStateException { + /** + * @internal + */ export const filterSensitiveLog = (obj: InvalidStateException): any => ({ ...obj, }); @@ -69,6 +81,9 @@ export interface OperationDisabledException extends __SmithyException, $Metadata } export namespace OperationDisabledException { + /** + * @internal + */ export const filterSensitiveLog = (obj: OperationDisabledException): any => ({ ...obj, }); @@ -84,6 +99,9 @@ export interface ResourceNotFoundException extends __SmithyException, $MetadataB } export namespace ResourceNotFoundException { + /** + * @internal + */ export const filterSensitiveLog = (obj: ResourceNotFoundException): any => ({ ...obj, }); @@ -155,6 +173,9 @@ export interface ApiDestination { } export namespace ApiDestination { + /** + * @internal + */ export const filterSensitiveLog = (obj: ApiDestination): any => ({ ...obj, }); @@ -216,6 +237,9 @@ export interface Archive { } export namespace Archive { + /** + * @internal + */ export const filterSensitiveLog = (obj: Archive): any => ({ ...obj, }); @@ -234,6 +258,9 @@ export interface CancelReplayRequest { } export namespace CancelReplayRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: CancelReplayRequest): any => ({ ...obj, }); @@ -266,6 +293,9 @@ export interface CancelReplayResponse { } export namespace CancelReplayResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: CancelReplayResponse): any => ({ ...obj, }); @@ -282,6 +312,9 @@ export interface IllegalStatusException extends __SmithyException, $MetadataBear } export namespace IllegalStatusException { + /** + * @internal + */ export const filterSensitiveLog = (obj: IllegalStatusException): any => ({ ...obj, }); @@ -321,6 +354,9 @@ export interface CreateApiDestinationRequest { } export namespace CreateApiDestinationRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateApiDestinationRequest): any => ({ ...obj, }); @@ -349,6 +385,9 @@ export interface CreateApiDestinationResponse { } export namespace CreateApiDestinationResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateApiDestinationResponse): any => ({ ...obj, }); @@ -365,6 +404,9 @@ export interface LimitExceededException extends __SmithyException, $MetadataBear } export namespace LimitExceededException { + /** + * @internal + */ export const filterSensitiveLog = (obj: LimitExceededException): any => ({ ...obj, }); @@ -380,6 +422,9 @@ export interface ResourceAlreadyExistsException extends __SmithyException, $Meta } export namespace ResourceAlreadyExistsException { + /** + * @internal + */ export const filterSensitiveLog = (obj: ResourceAlreadyExistsException): any => ({ ...obj, }); @@ -414,6 +459,9 @@ export interface CreateArchiveRequest { } export namespace CreateArchiveRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateArchiveRequest): any => ({ ...obj, }); @@ -442,6 +490,9 @@ export interface CreateArchiveResponse { } export namespace CreateArchiveResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateArchiveResponse): any => ({ ...obj, }); @@ -457,6 +508,9 @@ export interface InvalidEventPatternException extends __SmithyException, $Metada } export namespace InvalidEventPatternException { + /** + * @internal + */ export const filterSensitiveLog = (obj: InvalidEventPatternException): any => ({ ...obj, }); @@ -484,6 +538,9 @@ export interface CreateConnectionApiKeyAuthRequestParameters { } export namespace CreateConnectionApiKeyAuthRequestParameters { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateConnectionApiKeyAuthRequestParameters): any => ({ ...obj, }); @@ -505,6 +562,9 @@ export interface CreateConnectionBasicAuthRequestParameters { } export namespace CreateConnectionBasicAuthRequestParameters { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateConnectionBasicAuthRequestParameters): any => ({ ...obj, }); @@ -532,6 +592,9 @@ export interface ConnectionBodyParameter { } export namespace ConnectionBodyParameter { + /** + * @internal + */ export const filterSensitiveLog = (obj: ConnectionBodyParameter): any => ({ ...obj, }); @@ -559,6 +622,9 @@ export interface ConnectionHeaderParameter { } export namespace ConnectionHeaderParameter { + /** + * @internal + */ export const filterSensitiveLog = (obj: ConnectionHeaderParameter): any => ({ ...obj, }); @@ -587,6 +653,9 @@ export interface ConnectionQueryStringParameter { } export namespace ConnectionQueryStringParameter { + /** + * @internal + */ export const filterSensitiveLog = (obj: ConnectionQueryStringParameter): any => ({ ...obj, }); @@ -613,6 +682,9 @@ export interface ConnectionHttpParameters { } export namespace ConnectionHttpParameters { + /** + * @internal + */ export const filterSensitiveLog = (obj: ConnectionHttpParameters): any => ({ ...obj, }); @@ -635,6 +707,9 @@ export interface CreateConnectionOAuthClientRequestParameters { } export namespace CreateConnectionOAuthClientRequestParameters { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateConnectionOAuthClientRequestParameters): any => ({ ...obj, }); @@ -675,6 +750,9 @@ export interface CreateConnectionOAuthRequestParameters { } export namespace CreateConnectionOAuthRequestParameters { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateConnectionOAuthRequestParameters): any => ({ ...obj, }); @@ -712,6 +790,9 @@ export interface CreateConnectionAuthRequestParameters { } export namespace CreateConnectionAuthRequestParameters { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateConnectionAuthRequestParameters): any => ({ ...obj, }); @@ -741,6 +822,9 @@ export interface CreateConnectionRequest { } export namespace CreateConnectionRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateConnectionRequest): any => ({ ...obj, }); @@ -779,6 +863,9 @@ export interface CreateConnectionResponse { } export namespace CreateConnectionResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateConnectionResponse): any => ({ ...obj, }); @@ -802,6 +889,9 @@ export interface Tag { } export namespace Tag { + /** + * @internal + */ export const filterSensitiveLog = (obj: Tag): any => ({ ...obj, }); @@ -831,6 +921,9 @@ export interface CreateEventBusRequest { } export namespace CreateEventBusRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateEventBusRequest): any => ({ ...obj, }); @@ -844,6 +937,9 @@ export interface CreateEventBusResponse { } export namespace CreateEventBusResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateEventBusResponse): any => ({ ...obj, }); @@ -868,6 +964,9 @@ export interface CreatePartnerEventSourceRequest { } export namespace CreatePartnerEventSourceRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreatePartnerEventSourceRequest): any => ({ ...obj, }); @@ -881,6 +980,9 @@ export interface CreatePartnerEventSourceResponse { } export namespace CreatePartnerEventSourceResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreatePartnerEventSourceResponse): any => ({ ...obj, }); @@ -894,6 +996,9 @@ export interface DeactivateEventSourceRequest { } export namespace DeactivateEventSourceRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeactivateEventSourceRequest): any => ({ ...obj, }); @@ -907,6 +1012,9 @@ export interface DeauthorizeConnectionRequest { } export namespace DeauthorizeConnectionRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeauthorizeConnectionRequest): any => ({ ...obj, }); @@ -940,6 +1048,9 @@ export interface DeauthorizeConnectionResponse { } export namespace DeauthorizeConnectionResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeauthorizeConnectionResponse): any => ({ ...obj, }); @@ -953,6 +1064,9 @@ export interface DeleteApiDestinationRequest { } export namespace DeleteApiDestinationRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteApiDestinationRequest): any => ({ ...obj, }); @@ -961,6 +1075,9 @@ export namespace DeleteApiDestinationRequest { export interface DeleteApiDestinationResponse {} export namespace DeleteApiDestinationResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteApiDestinationResponse): any => ({ ...obj, }); @@ -974,6 +1091,9 @@ export interface DeleteArchiveRequest { } export namespace DeleteArchiveRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteArchiveRequest): any => ({ ...obj, }); @@ -982,6 +1102,9 @@ export namespace DeleteArchiveRequest { export interface DeleteArchiveResponse {} export namespace DeleteArchiveResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteArchiveResponse): any => ({ ...obj, }); @@ -995,6 +1118,9 @@ export interface DeleteConnectionRequest { } export namespace DeleteConnectionRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteConnectionRequest): any => ({ ...obj, }); @@ -1030,6 +1156,9 @@ export interface DeleteConnectionResponse { } export namespace DeleteConnectionResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteConnectionResponse): any => ({ ...obj, }); @@ -1043,6 +1172,9 @@ export interface DeleteEventBusRequest { } export namespace DeleteEventBusRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteEventBusRequest): any => ({ ...obj, }); @@ -1061,6 +1193,9 @@ export interface DeletePartnerEventSourceRequest { } export namespace DeletePartnerEventSourceRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeletePartnerEventSourceRequest): any => ({ ...obj, }); @@ -1089,6 +1224,9 @@ export interface DeleteRuleRequest { } export namespace DeleteRuleRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteRuleRequest): any => ({ ...obj, }); @@ -1109,6 +1247,9 @@ export interface ManagedRuleException extends __SmithyException, $MetadataBearer } export namespace ManagedRuleException { + /** + * @internal + */ export const filterSensitiveLog = (obj: ManagedRuleException): any => ({ ...obj, }); @@ -1122,6 +1263,9 @@ export interface DescribeApiDestinationRequest { } export namespace DescribeApiDestinationRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeApiDestinationRequest): any => ({ ...obj, }); @@ -1185,6 +1329,9 @@ export interface DescribeApiDestinationResponse { } export namespace DescribeApiDestinationResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeApiDestinationResponse): any => ({ ...obj, }); @@ -1198,6 +1345,9 @@ export interface DescribeArchiveRequest { } export namespace DescribeArchiveRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeArchiveRequest): any => ({ ...obj, }); @@ -1261,6 +1411,9 @@ export interface DescribeArchiveResponse { } export namespace DescribeArchiveResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeArchiveResponse): any => ({ ...obj, }); @@ -1274,6 +1427,9 @@ export interface DescribeConnectionRequest { } export namespace DescribeConnectionRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeConnectionRequest): any => ({ ...obj, }); @@ -1291,6 +1447,9 @@ export interface ConnectionApiKeyAuthResponseParameters { } export namespace ConnectionApiKeyAuthResponseParameters { + /** + * @internal + */ export const filterSensitiveLog = (obj: ConnectionApiKeyAuthResponseParameters): any => ({ ...obj, }); @@ -1308,6 +1467,9 @@ export interface ConnectionBasicAuthResponseParameters { } export namespace ConnectionBasicAuthResponseParameters { + /** + * @internal + */ export const filterSensitiveLog = (obj: ConnectionBasicAuthResponseParameters): any => ({ ...obj, }); @@ -1325,6 +1487,9 @@ export interface ConnectionOAuthClientResponseParameters { } export namespace ConnectionOAuthClientResponseParameters { + /** + * @internal + */ export const filterSensitiveLog = (obj: ConnectionOAuthClientResponseParameters): any => ({ ...obj, }); @@ -1357,6 +1522,9 @@ export interface ConnectionOAuthResponseParameters { } export namespace ConnectionOAuthResponseParameters { + /** + * @internal + */ export const filterSensitiveLog = (obj: ConnectionOAuthResponseParameters): any => ({ ...obj, }); @@ -1389,6 +1557,9 @@ export interface ConnectionAuthResponseParameters { } export namespace ConnectionAuthResponseParameters { + /** + * @internal + */ export const filterSensitiveLog = (obj: ConnectionAuthResponseParameters): any => ({ ...obj, }); @@ -1453,6 +1624,9 @@ export interface DescribeConnectionResponse { } export namespace DescribeConnectionResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeConnectionResponse): any => ({ ...obj, }); @@ -1467,6 +1641,9 @@ export interface DescribeEventBusRequest { } export namespace DescribeEventBusRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeEventBusRequest): any => ({ ...obj, }); @@ -1491,6 +1668,9 @@ export interface DescribeEventBusResponse { } export namespace DescribeEventBusResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeEventBusResponse): any => ({ ...obj, }); @@ -1504,6 +1684,9 @@ export interface DescribeEventSourceRequest { } export namespace DescribeEventSourceRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeEventSourceRequest): any => ({ ...obj, }); @@ -1552,6 +1735,9 @@ export interface DescribeEventSourceResponse { } export namespace DescribeEventSourceResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeEventSourceResponse): any => ({ ...obj, }); @@ -1565,6 +1751,9 @@ export interface DescribePartnerEventSourceRequest { } export namespace DescribePartnerEventSourceRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribePartnerEventSourceRequest): any => ({ ...obj, }); @@ -1583,6 +1772,9 @@ export interface DescribePartnerEventSourceResponse { } export namespace DescribePartnerEventSourceResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribePartnerEventSourceResponse): any => ({ ...obj, }); @@ -1596,6 +1788,9 @@ export interface DescribeReplayRequest { } export namespace DescribeReplayRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeReplayRequest): any => ({ ...obj, }); @@ -1618,6 +1813,9 @@ export interface ReplayDestination { } export namespace ReplayDestination { + /** + * @internal + */ export const filterSensitiveLog = (obj: ReplayDestination): any => ({ ...obj, }); @@ -1686,6 +1884,9 @@ export interface DescribeReplayResponse { } export namespace DescribeReplayResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeReplayResponse): any => ({ ...obj, }); @@ -1705,6 +1906,9 @@ export interface DescribeRuleRequest { } export namespace DescribeRuleRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeRuleRequest): any => ({ ...obj, }); @@ -1774,6 +1978,9 @@ export interface DescribeRuleResponse { } export namespace DescribeRuleResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeRuleResponse): any => ({ ...obj, }); @@ -1793,6 +2000,9 @@ export interface DisableRuleRequest { } export namespace DisableRuleRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DisableRuleRequest): any => ({ ...obj, }); @@ -1812,6 +2022,9 @@ export interface EnableRuleRequest { } export namespace EnableRuleRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: EnableRuleRequest): any => ({ ...obj, }); @@ -1841,6 +2054,9 @@ export interface ListApiDestinationsRequest { } export namespace ListApiDestinationsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListApiDestinationsRequest): any => ({ ...obj, }); @@ -1860,6 +2076,9 @@ export interface ListApiDestinationsResponse { } export namespace ListApiDestinationsResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListApiDestinationsResponse): any => ({ ...obj, }); @@ -1894,6 +2113,9 @@ export interface ListArchivesRequest { } export namespace ListArchivesRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListArchivesRequest): any => ({ ...obj, }); @@ -1912,6 +2134,9 @@ export interface ListArchivesResponse { } export namespace ListArchivesResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListArchivesResponse): any => ({ ...obj, }); @@ -1941,6 +2166,9 @@ export interface ListConnectionsRequest { } export namespace ListConnectionsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListConnectionsRequest): any => ({ ...obj, }); @@ -1992,6 +2220,9 @@ export interface Connection { } export namespace Connection { + /** + * @internal + */ export const filterSensitiveLog = (obj: Connection): any => ({ ...obj, }); @@ -2010,6 +2241,9 @@ export interface ListConnectionsResponse { } export namespace ListConnectionsResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListConnectionsResponse): any => ({ ...obj, }); @@ -2036,6 +2270,9 @@ export interface ListEventBusesRequest { } export namespace ListEventBusesRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListEventBusesRequest): any => ({ ...obj, }); @@ -2067,6 +2304,9 @@ export interface EventBus { } export namespace EventBus { + /** + * @internal + */ export const filterSensitiveLog = (obj: EventBus): any => ({ ...obj, }); @@ -2085,6 +2325,9 @@ export interface ListEventBusesResponse { } export namespace ListEventBusesResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListEventBusesResponse): any => ({ ...obj, }); @@ -2111,6 +2354,9 @@ export interface ListEventSourcesRequest { } export namespace ListEventSourcesRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListEventSourcesRequest): any => ({ ...obj, }); @@ -2158,6 +2404,9 @@ export interface EventSource { } export namespace EventSource { + /** + * @internal + */ export const filterSensitiveLog = (obj: EventSource): any => ({ ...obj, }); @@ -2176,6 +2425,9 @@ export interface ListEventSourcesResponse { } export namespace ListEventSourcesResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListEventSourcesResponse): any => ({ ...obj, }); @@ -2202,6 +2454,9 @@ export interface ListPartnerEventSourceAccountsRequest { } export namespace ListPartnerEventSourceAccountsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListPartnerEventSourceAccountsRequest): any => ({ ...obj, }); @@ -2237,6 +2492,9 @@ export interface PartnerEventSourceAccount { } export namespace PartnerEventSourceAccount { + /** + * @internal + */ export const filterSensitiveLog = (obj: PartnerEventSourceAccount): any => ({ ...obj, }); @@ -2255,6 +2513,9 @@ export interface ListPartnerEventSourceAccountsResponse { } export namespace ListPartnerEventSourceAccountsResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListPartnerEventSourceAccountsResponse): any => ({ ...obj, }); @@ -2282,6 +2543,9 @@ export interface ListPartnerEventSourcesRequest { } export namespace ListPartnerEventSourcesRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListPartnerEventSourcesRequest): any => ({ ...obj, }); @@ -2305,6 +2569,9 @@ export interface PartnerEventSource { } export namespace PartnerEventSource { + /** + * @internal + */ export const filterSensitiveLog = (obj: PartnerEventSource): any => ({ ...obj, }); @@ -2323,6 +2590,9 @@ export interface ListPartnerEventSourcesResponse { } export namespace ListPartnerEventSourcesResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListPartnerEventSourcesResponse): any => ({ ...obj, }); @@ -2357,6 +2627,9 @@ export interface ListReplaysRequest { } export namespace ListReplaysRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListReplaysRequest): any => ({ ...obj, }); @@ -2415,6 +2688,9 @@ export interface Replay { } export namespace Replay { + /** + * @internal + */ export const filterSensitiveLog = (obj: Replay): any => ({ ...obj, }); @@ -2433,6 +2709,9 @@ export interface ListReplaysResponse { } export namespace ListReplaysResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListReplaysResponse): any => ({ ...obj, }); @@ -2462,6 +2741,9 @@ export interface ListRuleNamesByTargetRequest { } export namespace ListRuleNamesByTargetRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListRuleNamesByTargetRequest): any => ({ ...obj, }); @@ -2481,6 +2763,9 @@ export interface ListRuleNamesByTargetResponse { } export namespace ListRuleNamesByTargetResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListRuleNamesByTargetResponse): any => ({ ...obj, }); @@ -2510,6 +2795,9 @@ export interface ListRulesRequest { } export namespace ListRulesRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListRulesRequest): any => ({ ...obj, }); @@ -2569,6 +2857,9 @@ export interface Rule { } export namespace Rule { + /** + * @internal + */ export const filterSensitiveLog = (obj: Rule): any => ({ ...obj, }); @@ -2588,6 +2879,9 @@ export interface ListRulesResponse { } export namespace ListRulesResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListRulesResponse): any => ({ ...obj, }); @@ -2601,6 +2895,9 @@ export interface ListTagsForResourceRequest { } export namespace ListTagsForResourceRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListTagsForResourceRequest): any => ({ ...obj, }); @@ -2614,6 +2911,9 @@ export interface ListTagsForResourceResponse { } export namespace ListTagsForResourceResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListTagsForResourceResponse): any => ({ ...obj, }); @@ -2643,6 +2943,9 @@ export interface ListTargetsByRuleRequest { } export namespace ListTargetsByRuleRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListTargetsByRuleRequest): any => ({ ...obj, }); @@ -2662,6 +2965,9 @@ export interface BatchArrayProperties { } export namespace BatchArrayProperties { + /** + * @internal + */ export const filterSensitiveLog = (obj: BatchArrayProperties): any => ({ ...obj, }); @@ -2680,6 +2986,9 @@ export interface BatchRetryStrategy { } export namespace BatchRetryStrategy { + /** + * @internal + */ export const filterSensitiveLog = (obj: BatchRetryStrategy): any => ({ ...obj, }); @@ -2717,6 +3026,9 @@ export interface BatchParameters { } export namespace BatchParameters { + /** + * @internal + */ export const filterSensitiveLog = (obj: BatchParameters): any => ({ ...obj, }); @@ -2734,6 +3046,9 @@ export interface DeadLetterConfig { } export namespace DeadLetterConfig { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeadLetterConfig): any => ({ ...obj, }); @@ -2772,6 +3087,9 @@ export interface AwsVpcConfiguration { } export namespace AwsVpcConfiguration { + /** + * @internal + */ export const filterSensitiveLog = (obj: AwsVpcConfiguration): any => ({ ...obj, }); @@ -2790,6 +3108,9 @@ export interface NetworkConfiguration { } export namespace NetworkConfiguration { + /** + * @internal + */ export const filterSensitiveLog = (obj: NetworkConfiguration): any => ({ ...obj, }); @@ -2847,6 +3168,9 @@ export interface EcsParameters { } export namespace EcsParameters { + /** + * @internal + */ export const filterSensitiveLog = (obj: EcsParameters): any => ({ ...obj, }); @@ -2878,6 +3202,9 @@ export interface HttpParameters { } export namespace HttpParameters { + /** + * @internal + */ export const filterSensitiveLog = (obj: HttpParameters): any => ({ ...obj, }); @@ -2973,6 +3300,9 @@ export interface InputTransformer { } export namespace InputTransformer { + /** + * @internal + */ export const filterSensitiveLog = (obj: InputTransformer): any => ({ ...obj, }); @@ -2994,6 +3324,9 @@ export interface KinesisParameters { } export namespace KinesisParameters { + /** + * @internal + */ export const filterSensitiveLog = (obj: KinesisParameters): any => ({ ...obj, }); @@ -3039,6 +3372,9 @@ export interface RedshiftDataParameters { } export namespace RedshiftDataParameters { + /** + * @internal + */ export const filterSensitiveLog = (obj: RedshiftDataParameters): any => ({ ...obj, }); @@ -3063,6 +3399,9 @@ export interface RetryPolicy { } export namespace RetryPolicy { + /** + * @internal + */ export const filterSensitiveLog = (obj: RetryPolicy): any => ({ ...obj, }); @@ -3091,6 +3430,9 @@ export interface RunCommandTarget { } export namespace RunCommandTarget { + /** + * @internal + */ export const filterSensitiveLog = (obj: RunCommandTarget): any => ({ ...obj, }); @@ -3109,6 +3451,9 @@ export interface RunCommandParameters { } export namespace RunCommandParameters { + /** + * @internal + */ export const filterSensitiveLog = (obj: RunCommandParameters): any => ({ ...obj, }); @@ -3131,6 +3476,9 @@ export interface SageMakerPipelineParameter { } export namespace SageMakerPipelineParameter { + /** + * @internal + */ export const filterSensitiveLog = (obj: SageMakerPipelineParameter): any => ({ ...obj, }); @@ -3148,6 +3496,9 @@ export interface SageMakerPipelineParameters { } export namespace SageMakerPipelineParameters { + /** + * @internal + */ export const filterSensitiveLog = (obj: SageMakerPipelineParameters): any => ({ ...obj, }); @@ -3165,6 +3516,9 @@ export interface SqsParameters { } export namespace SqsParameters { + /** + * @internal + */ export const filterSensitiveLog = (obj: SqsParameters): any => ({ ...obj, }); @@ -3295,6 +3649,9 @@ export interface Target { } export namespace Target { + /** + * @internal + */ export const filterSensitiveLog = (obj: Target): any => ({ ...obj, }); @@ -3314,6 +3671,9 @@ export interface ListTargetsByRuleResponse { } export namespace ListTargetsByRuleResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListTargetsByRuleResponse): any => ({ ...obj, }); @@ -3365,6 +3725,9 @@ export interface PutEventsRequestEntry { } export namespace PutEventsRequestEntry { + /** + * @internal + */ export const filterSensitiveLog = (obj: PutEventsRequestEntry): any => ({ ...obj, }); @@ -3380,6 +3743,9 @@ export interface PutEventsRequest { } export namespace PutEventsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: PutEventsRequest): any => ({ ...obj, }); @@ -3406,6 +3772,9 @@ export interface PutEventsResultEntry { } export namespace PutEventsResultEntry { + /** + * @internal + */ export const filterSensitiveLog = (obj: PutEventsResultEntry): any => ({ ...obj, }); @@ -3426,6 +3795,9 @@ export interface PutEventsResponse { } export namespace PutEventsResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: PutEventsResponse): any => ({ ...obj, }); @@ -3464,6 +3836,9 @@ export interface PutPartnerEventsRequestEntry { } export namespace PutPartnerEventsRequestEntry { + /** + * @internal + */ export const filterSensitiveLog = (obj: PutPartnerEventsRequestEntry): any => ({ ...obj, }); @@ -3477,6 +3852,9 @@ export interface PutPartnerEventsRequest { } export namespace PutPartnerEventsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: PutPartnerEventsRequest): any => ({ ...obj, }); @@ -3503,6 +3881,9 @@ export interface PutPartnerEventsResultEntry { } export namespace PutPartnerEventsResultEntry { + /** + * @internal + */ export const filterSensitiveLog = (obj: PutPartnerEventsResultEntry): any => ({ ...obj, }); @@ -3523,6 +3904,9 @@ export interface PutPartnerEventsResponse { } export namespace PutPartnerEventsResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: PutPartnerEventsResponse): any => ({ ...obj, }); @@ -3538,6 +3922,9 @@ export interface PolicyLengthExceededException extends __SmithyException, $Metad } export namespace PolicyLengthExceededException { + /** + * @internal + */ export const filterSensitiveLog = (obj: PolicyLengthExceededException): any => ({ ...obj, }); @@ -3575,6 +3962,9 @@ export interface Condition { } export namespace Condition { + /** + * @internal + */ export const filterSensitiveLog = (obj: Condition): any => ({ ...obj, }); @@ -3635,6 +4025,9 @@ export interface PutPermissionRequest { } export namespace PutPermissionRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: PutPermissionRequest): any => ({ ...obj, }); @@ -3685,6 +4078,9 @@ export interface PutRuleRequest { } export namespace PutRuleRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: PutRuleRequest): any => ({ ...obj, }); @@ -3698,6 +4094,9 @@ export interface PutRuleResponse { } export namespace PutRuleResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: PutRuleResponse): any => ({ ...obj, }); @@ -3722,6 +4121,9 @@ export interface PutTargetsRequest { } export namespace PutTargetsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: PutTargetsRequest): any => ({ ...obj, }); @@ -3750,6 +4152,9 @@ export interface PutTargetsResultEntry { } export namespace PutTargetsResultEntry { + /** + * @internal + */ export const filterSensitiveLog = (obj: PutTargetsResultEntry): any => ({ ...obj, }); @@ -3768,6 +4173,9 @@ export interface PutTargetsResponse { } export namespace PutTargetsResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: PutTargetsResponse): any => ({ ...obj, }); @@ -3793,6 +4201,9 @@ export interface RemovePermissionRequest { } export namespace RemovePermissionRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: RemovePermissionRequest): any => ({ ...obj, }); @@ -3826,6 +4237,9 @@ export interface RemoveTargetsRequest { } export namespace RemoveTargetsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: RemoveTargetsRequest): any => ({ ...obj, }); @@ -3854,6 +4268,9 @@ export interface RemoveTargetsResultEntry { } export namespace RemoveTargetsResultEntry { + /** + * @internal + */ export const filterSensitiveLog = (obj: RemoveTargetsResultEntry): any => ({ ...obj, }); @@ -3872,6 +4289,9 @@ export interface RemoveTargetsResponse { } export namespace RemoveTargetsResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: RemoveTargetsResponse): any => ({ ...obj, }); @@ -3913,6 +4333,9 @@ export interface StartReplayRequest { } export namespace StartReplayRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: StartReplayRequest): any => ({ ...obj, }); @@ -3941,6 +4364,9 @@ export interface StartReplayResponse { } export namespace StartReplayResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: StartReplayResponse): any => ({ ...obj, }); @@ -3959,6 +4385,9 @@ export interface TagResourceRequest { } export namespace TagResourceRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: TagResourceRequest): any => ({ ...obj, }); @@ -3967,6 +4396,9 @@ export namespace TagResourceRequest { export interface TagResourceResponse {} export namespace TagResourceResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: TagResourceResponse): any => ({ ...obj, }); @@ -4025,6 +4457,9 @@ export interface TestEventPatternRequest { } export namespace TestEventPatternRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: TestEventPatternRequest): any => ({ ...obj, }); @@ -4038,6 +4473,9 @@ export interface TestEventPatternResponse { } export namespace TestEventPatternResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: TestEventPatternResponse): any => ({ ...obj, }); @@ -4056,6 +4494,9 @@ export interface UntagResourceRequest { } export namespace UntagResourceRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: UntagResourceRequest): any => ({ ...obj, }); @@ -4064,6 +4505,9 @@ export namespace UntagResourceRequest { export interface UntagResourceResponse {} export namespace UntagResourceResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: UntagResourceResponse): any => ({ ...obj, }); @@ -4102,6 +4546,9 @@ export interface UpdateApiDestinationRequest { } export namespace UpdateApiDestinationRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateApiDestinationRequest): any => ({ ...obj, }); @@ -4130,6 +4577,9 @@ export interface UpdateApiDestinationResponse { } export namespace UpdateApiDestinationResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateApiDestinationResponse): any => ({ ...obj, }); @@ -4158,6 +4608,9 @@ export interface UpdateArchiveRequest { } export namespace UpdateArchiveRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateArchiveRequest): any => ({ ...obj, }); @@ -4186,6 +4639,9 @@ export interface UpdateArchiveResponse { } export namespace UpdateArchiveResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateArchiveResponse): any => ({ ...obj, }); @@ -4207,6 +4663,9 @@ export interface UpdateConnectionApiKeyAuthRequestParameters { } export namespace UpdateConnectionApiKeyAuthRequestParameters { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateConnectionApiKeyAuthRequestParameters): any => ({ ...obj, }); @@ -4228,6 +4687,9 @@ export interface UpdateConnectionBasicAuthRequestParameters { } export namespace UpdateConnectionBasicAuthRequestParameters { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateConnectionBasicAuthRequestParameters): any => ({ ...obj, }); @@ -4249,6 +4711,9 @@ export interface UpdateConnectionOAuthClientRequestParameters { } export namespace UpdateConnectionOAuthClientRequestParameters { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateConnectionOAuthClientRequestParameters): any => ({ ...obj, }); @@ -4283,6 +4748,9 @@ export interface UpdateConnectionOAuthRequestParameters { } export namespace UpdateConnectionOAuthRequestParameters { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateConnectionOAuthRequestParameters): any => ({ ...obj, }); @@ -4318,6 +4786,9 @@ export interface UpdateConnectionAuthRequestParameters { } export namespace UpdateConnectionAuthRequestParameters { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateConnectionAuthRequestParameters): any => ({ ...obj, }); @@ -4346,6 +4817,9 @@ export interface UpdateConnectionRequest { } export namespace UpdateConnectionRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateConnectionRequest): any => ({ ...obj, }); @@ -4379,6 +4853,9 @@ export interface UpdateConnectionResponse { } export namespace UpdateConnectionResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateConnectionResponse): any => ({ ...obj, }); diff --git a/clients/client-firehose/commands/CreateDeliveryStreamCommand.ts b/clients/client-firehose/commands/CreateDeliveryStreamCommand.ts index 0dfb153891a3..199e0083fce0 100644 --- a/clients/client-firehose/commands/CreateDeliveryStreamCommand.ts +++ b/clients/client-firehose/commands/CreateDeliveryStreamCommand.ts @@ -90,6 +90,20 @@ export interface CreateDeliveryStreamCommandOutput extends CreateDeliveryStreamO * information, see Grant Kinesis Data * Firehose Access to an Amazon S3 Destination in the Amazon Kinesis Data * Firehose Developer Guide.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { FirehoseClient, CreateDeliveryStreamCommand } from "@aws-sdk/client-firehose"; // ES Modules import + * // const { FirehoseClient, CreateDeliveryStreamCommand } = require("@aws-sdk/client-firehose"); // CommonJS import + * const client = new FirehoseClient(config); + * const command = new CreateDeliveryStreamCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreateDeliveryStreamCommandInput} for command's `input` shape. + * @see {@link CreateDeliveryStreamCommandOutput} for command's `response` shape. + * @see {@link FirehoseClientResolvedConfig | config} for command's `input` shape. + * */ export class CreateDeliveryStreamCommand extends $Command< CreateDeliveryStreamCommandInput, diff --git a/clients/client-firehose/commands/DeleteDeliveryStreamCommand.ts b/clients/client-firehose/commands/DeleteDeliveryStreamCommand.ts index f47e9ae682b4..7592e17acaf1 100644 --- a/clients/client-firehose/commands/DeleteDeliveryStreamCommand.ts +++ b/clients/client-firehose/commands/DeleteDeliveryStreamCommand.ts @@ -31,6 +31,20 @@ export interface DeleteDeliveryStreamCommandOutput extends DeleteDeliveryStreamO * 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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { FirehoseClient, DeleteDeliveryStreamCommand } from "@aws-sdk/client-firehose"; // ES Modules import + * // const { FirehoseClient, DeleteDeliveryStreamCommand } = require("@aws-sdk/client-firehose"); // CommonJS import + * const client = new FirehoseClient(config); + * const command = new DeleteDeliveryStreamCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteDeliveryStreamCommandInput} for command's `input` shape. + * @see {@link DeleteDeliveryStreamCommandOutput} for command's `response` shape. + * @see {@link FirehoseClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteDeliveryStreamCommand extends $Command< DeleteDeliveryStreamCommandInput, diff --git a/clients/client-firehose/commands/DescribeDeliveryStreamCommand.ts b/clients/client-firehose/commands/DescribeDeliveryStreamCommand.ts index 6831803a03eb..25a1a18dca75 100644 --- a/clients/client-firehose/commands/DescribeDeliveryStreamCommand.ts +++ b/clients/client-firehose/commands/DescribeDeliveryStreamCommand.ts @@ -28,6 +28,20 @@ export interface DescribeDeliveryStreamCommandOutput extends DescribeDeliveryStr * 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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { FirehoseClient, DescribeDeliveryStreamCommand } from "@aws-sdk/client-firehose"; // ES Modules import + * // const { FirehoseClient, DescribeDeliveryStreamCommand } = require("@aws-sdk/client-firehose"); // CommonJS import + * const client = new FirehoseClient(config); + * const command = new DescribeDeliveryStreamCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeDeliveryStreamCommandInput} for command's `input` shape. + * @see {@link DescribeDeliveryStreamCommandOutput} for command's `response` shape. + * @see {@link FirehoseClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeDeliveryStreamCommand extends $Command< DescribeDeliveryStreamCommandInput, diff --git a/clients/client-firehose/commands/ListDeliveryStreamsCommand.ts b/clients/client-firehose/commands/ListDeliveryStreamsCommand.ts index ad6228daf78f..3f6f85b193e3 100644 --- a/clients/client-firehose/commands/ListDeliveryStreamsCommand.ts +++ b/clients/client-firehose/commands/ListDeliveryStreamsCommand.ts @@ -29,6 +29,20 @@ export interface ListDeliveryStreamsCommandOutput extends ListDeliveryStreamsOut * 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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { FirehoseClient, ListDeliveryStreamsCommand } from "@aws-sdk/client-firehose"; // ES Modules import + * // const { FirehoseClient, ListDeliveryStreamsCommand } = require("@aws-sdk/client-firehose"); // CommonJS import + * const client = new FirehoseClient(config); + * const command = new ListDeliveryStreamsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListDeliveryStreamsCommandInput} for command's `input` shape. + * @see {@link ListDeliveryStreamsCommandOutput} for command's `response` shape. + * @see {@link FirehoseClientResolvedConfig | config} for command's `input` shape. + * */ export class ListDeliveryStreamsCommand extends $Command< ListDeliveryStreamsCommandInput, diff --git a/clients/client-firehose/commands/ListTagsForDeliveryStreamCommand.ts b/clients/client-firehose/commands/ListTagsForDeliveryStreamCommand.ts index f05b18482a7b..4bbfd3ff02b1 100644 --- a/clients/client-firehose/commands/ListTagsForDeliveryStreamCommand.ts +++ b/clients/client-firehose/commands/ListTagsForDeliveryStreamCommand.ts @@ -23,6 +23,20 @@ export interface ListTagsForDeliveryStreamCommandOutput extends ListTagsForDeliv /** *

Lists the tags for the specified delivery stream. This operation has a limit of five * transactions per second per account.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { FirehoseClient, ListTagsForDeliveryStreamCommand } from "@aws-sdk/client-firehose"; // ES Modules import + * // const { FirehoseClient, ListTagsForDeliveryStreamCommand } = require("@aws-sdk/client-firehose"); // CommonJS import + * const client = new FirehoseClient(config); + * const command = new ListTagsForDeliveryStreamCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListTagsForDeliveryStreamCommandInput} for command's `input` shape. + * @see {@link ListTagsForDeliveryStreamCommandOutput} for command's `response` shape. + * @see {@link FirehoseClientResolvedConfig | config} for command's `input` shape. + * */ export class ListTagsForDeliveryStreamCommand extends $Command< ListTagsForDeliveryStreamCommandInput, diff --git a/clients/client-firehose/commands/PutRecordBatchCommand.ts b/clients/client-firehose/commands/PutRecordBatchCommand.ts index c2073ba8b0b4..76ba45170d8b 100644 --- a/clients/client-firehose/commands/PutRecordBatchCommand.ts +++ b/clients/client-firehose/commands/PutRecordBatchCommand.ts @@ -72,6 +72,20 @@ export interface PutRecordBatchCommandOutput extends PutRecordBatchOutput, __Met *

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.

* + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { FirehoseClient, PutRecordBatchCommand } from "@aws-sdk/client-firehose"; // ES Modules import + * // const { FirehoseClient, PutRecordBatchCommand } = require("@aws-sdk/client-firehose"); // CommonJS import + * const client = new FirehoseClient(config); + * const command = new PutRecordBatchCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link PutRecordBatchCommandInput} for command's `input` shape. + * @see {@link PutRecordBatchCommandOutput} for command's `response` shape. + * @see {@link FirehoseClientResolvedConfig | config} for command's `input` shape. + * */ export class PutRecordBatchCommand extends $Command< PutRecordBatchCommandInput, diff --git a/clients/client-firehose/commands/PutRecordCommand.ts b/clients/client-firehose/commands/PutRecordCommand.ts index ddc3a312118d..89e4c0e28d6a 100644 --- a/clients/client-firehose/commands/PutRecordCommand.ts +++ b/clients/client-firehose/commands/PutRecordCommand.ts @@ -50,6 +50,20 @@ export interface PutRecordCommandOutput extends PutRecordOutput, __MetadataBeare *

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.

* + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { FirehoseClient, PutRecordCommand } from "@aws-sdk/client-firehose"; // ES Modules import + * // const { FirehoseClient, PutRecordCommand } = require("@aws-sdk/client-firehose"); // CommonJS import + * const client = new FirehoseClient(config); + * const command = new PutRecordCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link PutRecordCommandInput} for command's `input` shape. + * @see {@link PutRecordCommandOutput} for command's `response` shape. + * @see {@link FirehoseClientResolvedConfig | config} for command's `input` shape. + * */ export class PutRecordCommand extends $Command< PutRecordCommandInput, diff --git a/clients/client-firehose/commands/StartDeliveryStreamEncryptionCommand.ts b/clients/client-firehose/commands/StartDeliveryStreamEncryptionCommand.ts index c1acdb5bd767..d889d433c97b 100644 --- a/clients/client-firehose/commands/StartDeliveryStreamEncryptionCommand.ts +++ b/clients/client-firehose/commands/StartDeliveryStreamEncryptionCommand.ts @@ -59,6 +59,20 @@ export interface StartDeliveryStreamEncryptionCommandOutput * StartDeliveryStreamEncryption 13 times and * StopDeliveryStreamEncryption 12 times for the same delivery stream in a * 24-hour period.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { FirehoseClient, StartDeliveryStreamEncryptionCommand } from "@aws-sdk/client-firehose"; // ES Modules import + * // const { FirehoseClient, StartDeliveryStreamEncryptionCommand } = require("@aws-sdk/client-firehose"); // CommonJS import + * const client = new FirehoseClient(config); + * const command = new StartDeliveryStreamEncryptionCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link StartDeliveryStreamEncryptionCommandInput} for command's `input` shape. + * @see {@link StartDeliveryStreamEncryptionCommandOutput} for command's `response` shape. + * @see {@link FirehoseClientResolvedConfig | config} for command's `input` shape. + * */ export class StartDeliveryStreamEncryptionCommand extends $Command< StartDeliveryStreamEncryptionCommandInput, diff --git a/clients/client-firehose/commands/StopDeliveryStreamEncryptionCommand.ts b/clients/client-firehose/commands/StopDeliveryStreamEncryptionCommand.ts index b49d1802ebb1..73e60c9b3b9c 100644 --- a/clients/client-firehose/commands/StopDeliveryStreamEncryptionCommand.ts +++ b/clients/client-firehose/commands/StopDeliveryStreamEncryptionCommand.ts @@ -43,6 +43,20 @@ export interface StopDeliveryStreamEncryptionCommandOutput * StartDeliveryStreamEncryption 13 times and * StopDeliveryStreamEncryption 12 times for the same delivery stream in a * 24-hour period.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { FirehoseClient, StopDeliveryStreamEncryptionCommand } from "@aws-sdk/client-firehose"; // ES Modules import + * // const { FirehoseClient, StopDeliveryStreamEncryptionCommand } = require("@aws-sdk/client-firehose"); // CommonJS import + * const client = new FirehoseClient(config); + * const command = new StopDeliveryStreamEncryptionCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link StopDeliveryStreamEncryptionCommandInput} for command's `input` shape. + * @see {@link StopDeliveryStreamEncryptionCommandOutput} for command's `response` shape. + * @see {@link FirehoseClientResolvedConfig | config} for command's `input` shape. + * */ export class StopDeliveryStreamEncryptionCommand extends $Command< StopDeliveryStreamEncryptionCommandInput, diff --git a/clients/client-firehose/commands/TagDeliveryStreamCommand.ts b/clients/client-firehose/commands/TagDeliveryStreamCommand.ts index 4fc883a37294..fcfebf63e4ff 100644 --- a/clients/client-firehose/commands/TagDeliveryStreamCommand.ts +++ b/clients/client-firehose/commands/TagDeliveryStreamCommand.ts @@ -30,6 +30,20 @@ export interface TagDeliveryStreamCommandOutput extends TagDeliveryStreamOutput, * User Guide.

*

Each delivery stream can have up to 50 tags.

*

This operation has a limit of five transactions per second per account.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { FirehoseClient, TagDeliveryStreamCommand } from "@aws-sdk/client-firehose"; // ES Modules import + * // const { FirehoseClient, TagDeliveryStreamCommand } = require("@aws-sdk/client-firehose"); // CommonJS import + * const client = new FirehoseClient(config); + * const command = new TagDeliveryStreamCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link TagDeliveryStreamCommandInput} for command's `input` shape. + * @see {@link TagDeliveryStreamCommandOutput} for command's `response` shape. + * @see {@link FirehoseClientResolvedConfig | config} for command's `input` shape. + * */ export class TagDeliveryStreamCommand extends $Command< TagDeliveryStreamCommandInput, diff --git a/clients/client-firehose/commands/UntagDeliveryStreamCommand.ts b/clients/client-firehose/commands/UntagDeliveryStreamCommand.ts index 3d45c157f06c..95e6ec6c12c4 100644 --- a/clients/client-firehose/commands/UntagDeliveryStreamCommand.ts +++ b/clients/client-firehose/commands/UntagDeliveryStreamCommand.ts @@ -25,6 +25,20 @@ export interface UntagDeliveryStreamCommandOutput extends UntagDeliveryStreamOut * 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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { FirehoseClient, UntagDeliveryStreamCommand } from "@aws-sdk/client-firehose"; // ES Modules import + * // const { FirehoseClient, UntagDeliveryStreamCommand } = require("@aws-sdk/client-firehose"); // CommonJS import + * const client = new FirehoseClient(config); + * const command = new UntagDeliveryStreamCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link UntagDeliveryStreamCommandInput} for command's `input` shape. + * @see {@link UntagDeliveryStreamCommandOutput} for command's `response` shape. + * @see {@link FirehoseClientResolvedConfig | config} for command's `input` shape. + * */ export class UntagDeliveryStreamCommand extends $Command< UntagDeliveryStreamCommandInput, diff --git a/clients/client-firehose/commands/UpdateDestinationCommand.ts b/clients/client-firehose/commands/UpdateDestinationCommand.ts index 35891209e014..fbd07b530340 100644 --- a/clients/client-firehose/commands/UpdateDestinationCommand.ts +++ b/clients/client-firehose/commands/UpdateDestinationCommand.ts @@ -45,6 +45,20 @@ export interface UpdateDestinationCommandOutput extends UpdateDestinationOutput, * 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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { FirehoseClient, UpdateDestinationCommand } from "@aws-sdk/client-firehose"; // ES Modules import + * // const { FirehoseClient, UpdateDestinationCommand } = require("@aws-sdk/client-firehose"); // CommonJS import + * const client = new FirehoseClient(config); + * const command = new UpdateDestinationCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link UpdateDestinationCommandInput} for command's `input` shape. + * @see {@link UpdateDestinationCommandOutput} for command's `response` shape. + * @see {@link FirehoseClientResolvedConfig | config} for command's `input` shape. + * */ export class UpdateDestinationCommand extends $Command< UpdateDestinationCommandInput, diff --git a/clients/client-firehose/models/models_0.ts b/clients/client-firehose/models/models_0.ts index 95b505901598..307c6b82501c 100644 --- a/clients/client-firehose/models/models_0.ts +++ b/clients/client-firehose/models/models_0.ts @@ -30,6 +30,9 @@ export interface BufferingHints { } export namespace BufferingHints { + /** + * @internal + */ export const filterSensitiveLog = (obj: BufferingHints): any => ({ ...obj, }); @@ -58,6 +61,9 @@ export interface CloudWatchLoggingOptions { } export namespace CloudWatchLoggingOptions { + /** + * @internal + */ export const filterSensitiveLog = (obj: CloudWatchLoggingOptions): any => ({ ...obj, }); @@ -85,6 +91,9 @@ export interface ConcurrentModificationException extends __SmithyException, $Met } export namespace ConcurrentModificationException { + /** + * @internal + */ export const filterSensitiveLog = (obj: ConcurrentModificationException): any => ({ ...obj, }); @@ -135,6 +144,9 @@ export interface CopyCommand { } export namespace CopyCommand { + /** + * @internal + */ export const filterSensitiveLog = (obj: CopyCommand): any => ({ ...obj, }); @@ -181,6 +193,9 @@ export interface DeliveryStreamEncryptionConfigurationInput { } export namespace DeliveryStreamEncryptionConfigurationInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeliveryStreamEncryptionConfigurationInput): any => ({ ...obj, }); @@ -210,6 +225,9 @@ export interface ElasticsearchBufferingHints { } export namespace ElasticsearchBufferingHints { + /** + * @internal + */ export const filterSensitiveLog = (obj: ElasticsearchBufferingHints): any => ({ ...obj, }); @@ -241,6 +259,9 @@ export interface ProcessorParameter { } export namespace ProcessorParameter { + /** + * @internal + */ export const filterSensitiveLog = (obj: ProcessorParameter): any => ({ ...obj, }); @@ -264,6 +285,9 @@ export interface Processor { } export namespace Processor { + /** + * @internal + */ export const filterSensitiveLog = (obj: Processor): any => ({ ...obj, }); @@ -285,6 +309,9 @@ export interface ProcessingConfiguration { } export namespace ProcessingConfiguration { + /** + * @internal + */ export const filterSensitiveLog = (obj: ProcessingConfiguration): any => ({ ...obj, }); @@ -305,6 +332,9 @@ export interface ElasticsearchRetryOptions { } export namespace ElasticsearchRetryOptions { + /** + * @internal + */ export const filterSensitiveLog = (obj: ElasticsearchRetryOptions): any => ({ ...obj, }); @@ -325,6 +355,9 @@ export interface KMSEncryptionConfig { } export namespace KMSEncryptionConfig { + /** + * @internal + */ export const filterSensitiveLog = (obj: KMSEncryptionConfig): any => ({ ...obj, }); @@ -349,6 +382,9 @@ export interface EncryptionConfiguration { } export namespace EncryptionConfiguration { + /** + * @internal + */ export const filterSensitiveLog = (obj: EncryptionConfiguration): any => ({ ...obj, }); @@ -413,6 +449,9 @@ export interface S3DestinationConfiguration { } export namespace S3DestinationConfiguration { + /** + * @internal + */ export const filterSensitiveLog = (obj: S3DestinationConfiguration): any => ({ ...obj, }); @@ -505,6 +544,9 @@ export interface VpcConfiguration { } export namespace VpcConfiguration { + /** + * @internal + */ export const filterSensitiveLog = (obj: VpcConfiguration): any => ({ ...obj, }); @@ -610,6 +652,9 @@ export interface ElasticsearchDestinationConfiguration { } export namespace ElasticsearchDestinationConfiguration { + /** + * @internal + */ export const filterSensitiveLog = (obj: ElasticsearchDestinationConfiguration): any => ({ ...obj, }); @@ -633,6 +678,9 @@ export interface HiveJsonSerDe { } export namespace HiveJsonSerDe { + /** + * @internal + */ export const filterSensitiveLog = (obj: HiveJsonSerDe): any => ({ ...obj, }); @@ -672,6 +720,9 @@ export interface OpenXJsonSerDe { } export namespace OpenXJsonSerDe { + /** + * @internal + */ export const filterSensitiveLog = (obj: OpenXJsonSerDe): any => ({ ...obj, }); @@ -702,6 +753,9 @@ export interface Deserializer { } export namespace Deserializer { + /** + * @internal + */ export const filterSensitiveLog = (obj: Deserializer): any => ({ ...obj, }); @@ -720,6 +774,9 @@ export interface InputFormatConfiguration { } export namespace InputFormatConfiguration { + /** + * @internal + */ export const filterSensitiveLog = (obj: InputFormatConfiguration): any => ({ ...obj, }); @@ -813,6 +870,9 @@ export interface OrcSerDe { } export namespace OrcSerDe { + /** + * @internal + */ export const filterSensitiveLog = (obj: OrcSerDe): any => ({ ...obj, }); @@ -875,6 +935,9 @@ export interface ParquetSerDe { } export namespace ParquetSerDe { + /** + * @internal + */ export const filterSensitiveLog = (obj: ParquetSerDe): any => ({ ...obj, }); @@ -901,6 +964,9 @@ export interface Serializer { } export namespace Serializer { + /** + * @internal + */ export const filterSensitiveLog = (obj: Serializer): any => ({ ...obj, }); @@ -920,6 +986,9 @@ export interface OutputFormatConfiguration { } export namespace OutputFormatConfiguration { + /** + * @internal + */ export const filterSensitiveLog = (obj: OutputFormatConfiguration): any => ({ ...obj, }); @@ -971,6 +1040,9 @@ export interface SchemaConfiguration { } export namespace SchemaConfiguration { + /** + * @internal + */ export const filterSensitiveLog = (obj: SchemaConfiguration): any => ({ ...obj, }); @@ -1012,6 +1084,9 @@ export interface DataFormatConversionConfiguration { } export namespace DataFormatConversionConfiguration { + /** + * @internal + */ export const filterSensitiveLog = (obj: DataFormatConversionConfiguration): any => ({ ...obj, }); @@ -1097,6 +1172,9 @@ export interface ExtendedS3DestinationConfiguration { } export namespace ExtendedS3DestinationConfiguration { + /** + * @internal + */ export const filterSensitiveLog = (obj: ExtendedS3DestinationConfiguration): any => ({ ...obj, }); @@ -1127,6 +1205,9 @@ export interface HttpEndpointBufferingHints { } export namespace HttpEndpointBufferingHints { + /** + * @internal + */ export const filterSensitiveLog = (obj: HttpEndpointBufferingHints): any => ({ ...obj, }); @@ -1155,6 +1236,9 @@ export interface HttpEndpointConfiguration { } export namespace HttpEndpointConfiguration { + /** + * @internal + */ export const filterSensitiveLog = (obj: HttpEndpointConfiguration): any => ({ ...obj, ...(obj.Url && { Url: SENSITIVE_STRING }), @@ -1179,6 +1263,9 @@ export interface HttpEndpointCommonAttribute { } export namespace HttpEndpointCommonAttribute { + /** + * @internal + */ export const filterSensitiveLog = (obj: HttpEndpointCommonAttribute): any => ({ ...obj, ...(obj.AttributeName && { AttributeName: SENSITIVE_STRING }), @@ -1203,6 +1290,9 @@ export interface HttpEndpointRequestConfiguration { } export namespace HttpEndpointRequestConfiguration { + /** + * @internal + */ export const filterSensitiveLog = (obj: HttpEndpointRequestConfiguration): any => ({ ...obj, ...(obj.CommonAttributes && { @@ -1227,6 +1317,9 @@ export interface HttpEndpointRetryOptions { } export namespace HttpEndpointRetryOptions { + /** + * @internal + */ export const filterSensitiveLog = (obj: HttpEndpointRetryOptions): any => ({ ...obj, }); @@ -1296,6 +1389,9 @@ export interface HttpEndpointDestinationConfiguration { } export namespace HttpEndpointDestinationConfiguration { + /** + * @internal + */ export const filterSensitiveLog = (obj: HttpEndpointDestinationConfiguration): any => ({ ...obj, ...(obj.EndpointConfiguration && { @@ -1325,6 +1421,9 @@ export interface KinesisStreamSourceConfiguration { } export namespace KinesisStreamSourceConfiguration { + /** + * @internal + */ export const filterSensitiveLog = (obj: KinesisStreamSourceConfiguration): any => ({ ...obj, }); @@ -1346,6 +1445,9 @@ export interface RedshiftRetryOptions { } export namespace RedshiftRetryOptions { + /** + * @internal + */ export const filterSensitiveLog = (obj: RedshiftRetryOptions): any => ({ ...obj, }); @@ -1423,6 +1525,9 @@ export interface RedshiftDestinationConfiguration { } export namespace RedshiftDestinationConfiguration { + /** + * @internal + */ export const filterSensitiveLog = (obj: RedshiftDestinationConfiguration): any => ({ ...obj, ...(obj.Username && { Username: SENSITIVE_STRING }), @@ -1447,6 +1552,9 @@ export interface SplunkRetryOptions { } export namespace SplunkRetryOptions { + /** + * @internal + */ export const filterSensitiveLog = (obj: SplunkRetryOptions): any => ({ ...obj, }); @@ -1518,6 +1626,9 @@ export interface SplunkDestinationConfiguration { } export namespace SplunkDestinationConfiguration { + /** + * @internal + */ export const filterSensitiveLog = (obj: SplunkDestinationConfiguration): any => ({ ...obj, }); @@ -1543,6 +1654,9 @@ export interface Tag { } export namespace Tag { + /** + * @internal + */ export const filterSensitiveLog = (obj: Tag): any => ({ ...obj, }); @@ -1633,6 +1747,9 @@ export interface CreateDeliveryStreamInput { } export namespace CreateDeliveryStreamInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateDeliveryStreamInput): any => ({ ...obj, ...(obj.RedshiftDestinationConfiguration && { @@ -1656,6 +1773,9 @@ export interface CreateDeliveryStreamOutput { } export namespace CreateDeliveryStreamOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateDeliveryStreamOutput): any => ({ ...obj, }); @@ -1674,6 +1794,9 @@ export interface InvalidArgumentException extends __SmithyException, $MetadataBe } export namespace InvalidArgumentException { + /** + * @internal + */ export const filterSensitiveLog = (obj: InvalidArgumentException): any => ({ ...obj, }); @@ -1694,6 +1817,9 @@ export interface InvalidKMSResourceException extends __SmithyException, $Metadat } export namespace InvalidKMSResourceException { + /** + * @internal + */ export const filterSensitiveLog = (obj: InvalidKMSResourceException): any => ({ ...obj, }); @@ -1712,6 +1838,9 @@ export interface LimitExceededException extends __SmithyException, $MetadataBear } export namespace LimitExceededException { + /** + * @internal + */ export const filterSensitiveLog = (obj: LimitExceededException): any => ({ ...obj, }); @@ -1730,6 +1859,9 @@ export interface ResourceInUseException extends __SmithyException, $MetadataBear } export namespace ResourceInUseException { + /** + * @internal + */ export const filterSensitiveLog = (obj: ResourceInUseException): any => ({ ...obj, }); @@ -1754,6 +1886,9 @@ export interface DeleteDeliveryStreamInput { } export namespace DeleteDeliveryStreamInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteDeliveryStreamInput): any => ({ ...obj, }); @@ -1762,6 +1897,9 @@ export namespace DeleteDeliveryStreamInput { export interface DeleteDeliveryStreamOutput {} export namespace DeleteDeliveryStreamOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteDeliveryStreamOutput): any => ({ ...obj, }); @@ -1780,6 +1918,9 @@ export interface ResourceNotFoundException extends __SmithyException, $MetadataB } export namespace ResourceNotFoundException { + /** + * @internal + */ export const filterSensitiveLog = (obj: ResourceNotFoundException): any => ({ ...obj, }); @@ -1821,6 +1962,9 @@ export interface FailureDescription { } export namespace FailureDescription { + /** + * @internal + */ export const filterSensitiveLog = (obj: FailureDescription): any => ({ ...obj, }); @@ -1872,6 +2016,9 @@ export interface DeliveryStreamEncryptionConfiguration { } export namespace DeliveryStreamEncryptionConfiguration { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeliveryStreamEncryptionConfiguration): any => ({ ...obj, }); @@ -1941,6 +2088,9 @@ export interface S3DestinationDescription { } export namespace S3DestinationDescription { + /** + * @internal + */ export const filterSensitiveLog = (obj: S3DestinationDescription): any => ({ ...obj, }); @@ -2037,6 +2187,9 @@ export interface VpcConfigurationDescription { } export namespace VpcConfigurationDescription { + /** + * @internal + */ export const filterSensitiveLog = (obj: VpcConfigurationDescription): any => ({ ...obj, }); @@ -2121,6 +2274,9 @@ export interface ElasticsearchDestinationDescription { } export namespace ElasticsearchDestinationDescription { + /** + * @internal + */ export const filterSensitiveLog = (obj: ElasticsearchDestinationDescription): any => ({ ...obj, }); @@ -2202,6 +2358,9 @@ export interface ExtendedS3DestinationDescription { } export namespace ExtendedS3DestinationDescription { + /** + * @internal + */ export const filterSensitiveLog = (obj: ExtendedS3DestinationDescription): any => ({ ...obj, }); @@ -2223,6 +2382,9 @@ export interface HttpEndpointDescription { } export namespace HttpEndpointDescription { + /** + * @internal + */ export const filterSensitiveLog = (obj: HttpEndpointDescription): any => ({ ...obj, ...(obj.Url && { Url: SENSITIVE_STRING }), @@ -2291,6 +2453,9 @@ export interface HttpEndpointDestinationDescription { } export namespace HttpEndpointDestinationDescription { + /** + * @internal + */ export const filterSensitiveLog = (obj: HttpEndpointDestinationDescription): any => ({ ...obj, ...(obj.EndpointConfiguration && { @@ -2360,6 +2525,9 @@ export interface RedshiftDestinationDescription { } export namespace RedshiftDestinationDescription { + /** + * @internal + */ export const filterSensitiveLog = (obj: RedshiftDestinationDescription): any => ({ ...obj, ...(obj.Username && { Username: SENSITIVE_STRING }), @@ -2427,6 +2595,9 @@ export interface SplunkDestinationDescription { } export namespace SplunkDestinationDescription { + /** + * @internal + */ export const filterSensitiveLog = (obj: SplunkDestinationDescription): any => ({ ...obj, }); @@ -2473,6 +2644,9 @@ export interface DestinationDescription { } export namespace DestinationDescription { + /** + * @internal + */ export const filterSensitiveLog = (obj: DestinationDescription): any => ({ ...obj, ...(obj.RedshiftDestinationDescription && { @@ -2513,6 +2687,9 @@ export interface KinesisStreamSourceDescription { } export namespace KinesisStreamSourceDescription { + /** + * @internal + */ export const filterSensitiveLog = (obj: KinesisStreamSourceDescription): any => ({ ...obj, }); @@ -2531,6 +2708,9 @@ export interface SourceDescription { } export namespace SourceDescription { + /** + * @internal + */ export const filterSensitiveLog = (obj: SourceDescription): any => ({ ...obj, }); @@ -2624,6 +2804,9 @@ export interface DeliveryStreamDescription { } export namespace DeliveryStreamDescription { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeliveryStreamDescription): any => ({ ...obj, ...(obj.Destinations && { @@ -2652,6 +2835,9 @@ export interface DescribeDeliveryStreamInput { } export namespace DescribeDeliveryStreamInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeDeliveryStreamInput): any => ({ ...obj, }); @@ -2665,6 +2851,9 @@ export interface DescribeDeliveryStreamOutput { } export namespace DescribeDeliveryStreamOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeDeliveryStreamOutput): any => ({ ...obj, ...(obj.DeliveryStreamDescription && { @@ -2732,6 +2921,9 @@ export interface S3DestinationUpdate { } export namespace S3DestinationUpdate { + /** + * @internal + */ export const filterSensitiveLog = (obj: S3DestinationUpdate): any => ({ ...obj, }); @@ -2821,6 +3013,9 @@ export interface ElasticsearchDestinationUpdate { } export namespace ElasticsearchDestinationUpdate { + /** + * @internal + */ export const filterSensitiveLog = (obj: ElasticsearchDestinationUpdate): any => ({ ...obj, }); @@ -2903,6 +3098,9 @@ export interface ExtendedS3DestinationUpdate { } export namespace ExtendedS3DestinationUpdate { + /** + * @internal + */ export const filterSensitiveLog = (obj: ExtendedS3DestinationUpdate): any => ({ ...obj, }); @@ -2943,6 +3141,9 @@ export interface ListDeliveryStreamsInput { } export namespace ListDeliveryStreamsInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListDeliveryStreamsInput): any => ({ ...obj, }); @@ -2961,6 +3162,9 @@ export interface ListDeliveryStreamsOutput { } export namespace ListDeliveryStreamsOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListDeliveryStreamsOutput): any => ({ ...obj, }); @@ -2989,6 +3193,9 @@ export interface ListTagsForDeliveryStreamInput { } export namespace ListTagsForDeliveryStreamInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListTagsForDeliveryStreamInput): any => ({ ...obj, }); @@ -3011,6 +3218,9 @@ export interface ListTagsForDeliveryStreamOutput { } export namespace ListTagsForDeliveryStreamOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListTagsForDeliveryStreamOutput): any => ({ ...obj, }); @@ -3028,6 +3238,9 @@ export interface _Record { } export namespace _Record { + /** + * @internal + */ export const filterSensitiveLog = (obj: _Record): any => ({ ...obj, }); @@ -3046,6 +3259,9 @@ export interface PutRecordInput { } export namespace PutRecordInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: PutRecordInput): any => ({ ...obj, }); @@ -3064,6 +3280,9 @@ export interface PutRecordOutput { } export namespace PutRecordOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: PutRecordOutput): any => ({ ...obj, }); @@ -3085,6 +3304,9 @@ export interface ServiceUnavailableException extends __SmithyException, $Metadat } export namespace ServiceUnavailableException { + /** + * @internal + */ export const filterSensitiveLog = (obj: ServiceUnavailableException): any => ({ ...obj, }); @@ -3103,6 +3325,9 @@ export interface PutRecordBatchInput { } export namespace PutRecordBatchInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: PutRecordBatchInput): any => ({ ...obj, }); @@ -3132,6 +3357,9 @@ export interface PutRecordBatchResponseEntry { } export namespace PutRecordBatchResponseEntry { + /** + * @internal + */ export const filterSensitiveLog = (obj: PutRecordBatchResponseEntry): any => ({ ...obj, }); @@ -3159,6 +3387,9 @@ export interface PutRecordBatchOutput { } export namespace PutRecordBatchOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: PutRecordBatchOutput): any => ({ ...obj, }); @@ -3179,6 +3410,9 @@ export interface StartDeliveryStreamEncryptionInput { } export namespace StartDeliveryStreamEncryptionInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: StartDeliveryStreamEncryptionInput): any => ({ ...obj, }); @@ -3187,6 +3421,9 @@ export namespace StartDeliveryStreamEncryptionInput { export interface StartDeliveryStreamEncryptionOutput {} export namespace StartDeliveryStreamEncryptionOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: StartDeliveryStreamEncryptionOutput): any => ({ ...obj, }); @@ -3201,6 +3438,9 @@ export interface StopDeliveryStreamEncryptionInput { } export namespace StopDeliveryStreamEncryptionInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: StopDeliveryStreamEncryptionInput): any => ({ ...obj, }); @@ -3209,6 +3449,9 @@ export namespace StopDeliveryStreamEncryptionInput { export interface StopDeliveryStreamEncryptionOutput {} export namespace StopDeliveryStreamEncryptionOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: StopDeliveryStreamEncryptionOutput): any => ({ ...obj, }); @@ -3227,6 +3470,9 @@ export interface TagDeliveryStreamInput { } export namespace TagDeliveryStreamInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: TagDeliveryStreamInput): any => ({ ...obj, }); @@ -3235,6 +3481,9 @@ export namespace TagDeliveryStreamInput { export interface TagDeliveryStreamOutput {} export namespace TagDeliveryStreamOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: TagDeliveryStreamOutput): any => ({ ...obj, }); @@ -3254,6 +3503,9 @@ export interface UntagDeliveryStreamInput { } export namespace UntagDeliveryStreamInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: UntagDeliveryStreamInput): any => ({ ...obj, }); @@ -3262,6 +3514,9 @@ export namespace UntagDeliveryStreamInput { export interface UntagDeliveryStreamOutput {} export namespace UntagDeliveryStreamOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: UntagDeliveryStreamOutput): any => ({ ...obj, }); @@ -3329,6 +3584,9 @@ export interface HttpEndpointDestinationUpdate { } export namespace HttpEndpointDestinationUpdate { + /** + * @internal + */ export const filterSensitiveLog = (obj: HttpEndpointDestinationUpdate): any => ({ ...obj, ...(obj.EndpointConfiguration && { @@ -3408,6 +3666,9 @@ export interface RedshiftDestinationUpdate { } export namespace RedshiftDestinationUpdate { + /** + * @internal + */ export const filterSensitiveLog = (obj: RedshiftDestinationUpdate): any => ({ ...obj, ...(obj.Username && { Username: SENSITIVE_STRING }), @@ -3479,6 +3740,9 @@ export interface SplunkDestinationUpdate { } export namespace SplunkDestinationUpdate { + /** + * @internal + */ export const filterSensitiveLog = (obj: SplunkDestinationUpdate): any => ({ ...obj, }); @@ -3538,6 +3802,9 @@ export interface UpdateDestinationInput { } export namespace UpdateDestinationInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateDestinationInput): any => ({ ...obj, ...(obj.RedshiftDestinationUpdate && { @@ -3554,6 +3821,9 @@ export namespace UpdateDestinationInput { export interface UpdateDestinationOutput {} export namespace UpdateDestinationOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateDestinationOutput): any => ({ ...obj, }); diff --git a/clients/client-fis/commands/CreateExperimentTemplateCommand.ts b/clients/client-fis/commands/CreateExperimentTemplateCommand.ts index 6999b39e696c..e089fe74fa93 100644 --- a/clients/client-fis/commands/CreateExperimentTemplateCommand.ts +++ b/clients/client-fis/commands/CreateExperimentTemplateCommand.ts @@ -43,6 +43,20 @@ export interface CreateExperimentTemplateCommandOutput extends CreateExperimentT * * *

For more information, see the AWS Fault Injection Simulator User Guide.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { FisClient, CreateExperimentTemplateCommand } from "@aws-sdk/client-fis"; // ES Modules import + * // const { FisClient, CreateExperimentTemplateCommand } = require("@aws-sdk/client-fis"); // CommonJS import + * const client = new FisClient(config); + * const command = new CreateExperimentTemplateCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreateExperimentTemplateCommandInput} for command's `input` shape. + * @see {@link CreateExperimentTemplateCommandOutput} for command's `response` shape. + * @see {@link FisClientResolvedConfig | config} for command's `input` shape. + * */ export class CreateExperimentTemplateCommand extends $Command< CreateExperimentTemplateCommandInput, diff --git a/clients/client-fis/commands/DeleteExperimentTemplateCommand.ts b/clients/client-fis/commands/DeleteExperimentTemplateCommand.ts index 4230a6a526db..a642db056993 100644 --- a/clients/client-fis/commands/DeleteExperimentTemplateCommand.ts +++ b/clients/client-fis/commands/DeleteExperimentTemplateCommand.ts @@ -22,6 +22,20 @@ export interface DeleteExperimentTemplateCommandOutput extends DeleteExperimentT /** *

Deletes the specified experiment template.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { FisClient, DeleteExperimentTemplateCommand } from "@aws-sdk/client-fis"; // ES Modules import + * // const { FisClient, DeleteExperimentTemplateCommand } = require("@aws-sdk/client-fis"); // CommonJS import + * const client = new FisClient(config); + * const command = new DeleteExperimentTemplateCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteExperimentTemplateCommandInput} for command's `input` shape. + * @see {@link DeleteExperimentTemplateCommandOutput} for command's `response` shape. + * @see {@link FisClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteExperimentTemplateCommand extends $Command< DeleteExperimentTemplateCommandInput, diff --git a/clients/client-fis/commands/GetActionCommand.ts b/clients/client-fis/commands/GetActionCommand.ts index 5e66db5a946b..cadc276a93bb 100644 --- a/clients/client-fis/commands/GetActionCommand.ts +++ b/clients/client-fis/commands/GetActionCommand.ts @@ -22,6 +22,20 @@ export interface GetActionCommandOutput extends GetActionResponse, __MetadataBea /** *

Gets information about the specified AWS FIS action.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { FisClient, GetActionCommand } from "@aws-sdk/client-fis"; // ES Modules import + * // const { FisClient, GetActionCommand } = require("@aws-sdk/client-fis"); // CommonJS import + * const client = new FisClient(config); + * const command = new GetActionCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetActionCommandInput} for command's `input` shape. + * @see {@link GetActionCommandOutput} for command's `response` shape. + * @see {@link FisClientResolvedConfig | config} for command's `input` shape. + * */ export class GetActionCommand extends $Command { // Start section: command_properties diff --git a/clients/client-fis/commands/GetExperimentCommand.ts b/clients/client-fis/commands/GetExperimentCommand.ts index 99145f7e9d20..559c8679fb75 100644 --- a/clients/client-fis/commands/GetExperimentCommand.ts +++ b/clients/client-fis/commands/GetExperimentCommand.ts @@ -22,6 +22,20 @@ export interface GetExperimentCommandOutput extends GetExperimentResponse, __Met /** *

Gets information about the specified experiment.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { FisClient, GetExperimentCommand } from "@aws-sdk/client-fis"; // ES Modules import + * // const { FisClient, GetExperimentCommand } = require("@aws-sdk/client-fis"); // CommonJS import + * const client = new FisClient(config); + * const command = new GetExperimentCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetExperimentCommandInput} for command's `input` shape. + * @see {@link GetExperimentCommandOutput} for command's `response` shape. + * @see {@link FisClientResolvedConfig | config} for command's `input` shape. + * */ export class GetExperimentCommand extends $Command< GetExperimentCommandInput, diff --git a/clients/client-fis/commands/GetExperimentTemplateCommand.ts b/clients/client-fis/commands/GetExperimentTemplateCommand.ts index d9ae3ad2dca7..178e3737a6c3 100644 --- a/clients/client-fis/commands/GetExperimentTemplateCommand.ts +++ b/clients/client-fis/commands/GetExperimentTemplateCommand.ts @@ -22,6 +22,20 @@ export interface GetExperimentTemplateCommandOutput extends GetExperimentTemplat /** *

Gets information about the specified experiment template.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { FisClient, GetExperimentTemplateCommand } from "@aws-sdk/client-fis"; // ES Modules import + * // const { FisClient, GetExperimentTemplateCommand } = require("@aws-sdk/client-fis"); // CommonJS import + * const client = new FisClient(config); + * const command = new GetExperimentTemplateCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetExperimentTemplateCommandInput} for command's `input` shape. + * @see {@link GetExperimentTemplateCommandOutput} for command's `response` shape. + * @see {@link FisClientResolvedConfig | config} for command's `input` shape. + * */ export class GetExperimentTemplateCommand extends $Command< GetExperimentTemplateCommandInput, diff --git a/clients/client-fis/commands/ListActionsCommand.ts b/clients/client-fis/commands/ListActionsCommand.ts index e77f6677b275..ea7485f48670 100644 --- a/clients/client-fis/commands/ListActionsCommand.ts +++ b/clients/client-fis/commands/ListActionsCommand.ts @@ -22,6 +22,20 @@ export interface ListActionsCommandOutput extends ListActionsResponse, __Metadat /** *

Lists the available AWS FIS actions.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { FisClient, ListActionsCommand } from "@aws-sdk/client-fis"; // ES Modules import + * // const { FisClient, ListActionsCommand } = require("@aws-sdk/client-fis"); // CommonJS import + * const client = new FisClient(config); + * const command = new ListActionsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListActionsCommandInput} for command's `input` shape. + * @see {@link ListActionsCommandOutput} for command's `response` shape. + * @see {@link FisClientResolvedConfig | config} for command's `input` shape. + * */ export class ListActionsCommand extends $Command< ListActionsCommandInput, diff --git a/clients/client-fis/commands/ListExperimentTemplatesCommand.ts b/clients/client-fis/commands/ListExperimentTemplatesCommand.ts index 6348f92bdc7b..9f081533be5f 100644 --- a/clients/client-fis/commands/ListExperimentTemplatesCommand.ts +++ b/clients/client-fis/commands/ListExperimentTemplatesCommand.ts @@ -22,6 +22,20 @@ export interface ListExperimentTemplatesCommandOutput extends ListExperimentTemp /** *

Lists your experiment templates.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { FisClient, ListExperimentTemplatesCommand } from "@aws-sdk/client-fis"; // ES Modules import + * // const { FisClient, ListExperimentTemplatesCommand } = require("@aws-sdk/client-fis"); // CommonJS import + * const client = new FisClient(config); + * const command = new ListExperimentTemplatesCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListExperimentTemplatesCommandInput} for command's `input` shape. + * @see {@link ListExperimentTemplatesCommandOutput} for command's `response` shape. + * @see {@link FisClientResolvedConfig | config} for command's `input` shape. + * */ export class ListExperimentTemplatesCommand extends $Command< ListExperimentTemplatesCommandInput, diff --git a/clients/client-fis/commands/ListExperimentsCommand.ts b/clients/client-fis/commands/ListExperimentsCommand.ts index 9a3e74f37f3e..c63577676608 100644 --- a/clients/client-fis/commands/ListExperimentsCommand.ts +++ b/clients/client-fis/commands/ListExperimentsCommand.ts @@ -22,6 +22,20 @@ export interface ListExperimentsCommandOutput extends ListExperimentsResponse, _ /** *

Lists your experiments.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { FisClient, ListExperimentsCommand } from "@aws-sdk/client-fis"; // ES Modules import + * // const { FisClient, ListExperimentsCommand } = require("@aws-sdk/client-fis"); // CommonJS import + * const client = new FisClient(config); + * const command = new ListExperimentsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListExperimentsCommandInput} for command's `input` shape. + * @see {@link ListExperimentsCommandOutput} for command's `response` shape. + * @see {@link FisClientResolvedConfig | config} for command's `input` shape. + * */ export class ListExperimentsCommand extends $Command< ListExperimentsCommandInput, diff --git a/clients/client-fis/commands/ListTagsForResourceCommand.ts b/clients/client-fis/commands/ListTagsForResourceCommand.ts index 812f705bf431..480d753482b8 100644 --- a/clients/client-fis/commands/ListTagsForResourceCommand.ts +++ b/clients/client-fis/commands/ListTagsForResourceCommand.ts @@ -22,6 +22,20 @@ export interface ListTagsForResourceCommandOutput extends ListTagsForResourceRes /** *

Lists the tags for the specified resource.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { FisClient, ListTagsForResourceCommand } from "@aws-sdk/client-fis"; // ES Modules import + * // const { FisClient, ListTagsForResourceCommand } = require("@aws-sdk/client-fis"); // CommonJS import + * const client = new FisClient(config); + * const command = new ListTagsForResourceCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListTagsForResourceCommandInput} for command's `input` shape. + * @see {@link ListTagsForResourceCommandOutput} for command's `response` shape. + * @see {@link FisClientResolvedConfig | config} for command's `input` shape. + * */ export class ListTagsForResourceCommand extends $Command< ListTagsForResourceCommandInput, diff --git a/clients/client-fis/commands/StartExperimentCommand.ts b/clients/client-fis/commands/StartExperimentCommand.ts index 05a750ce8d83..2342185fd856 100644 --- a/clients/client-fis/commands/StartExperimentCommand.ts +++ b/clients/client-fis/commands/StartExperimentCommand.ts @@ -22,6 +22,20 @@ export interface StartExperimentCommandOutput extends StartExperimentResponse, _ /** *

Starts running an experiment from the specified experiment template.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { FisClient, StartExperimentCommand } from "@aws-sdk/client-fis"; // ES Modules import + * // const { FisClient, StartExperimentCommand } = require("@aws-sdk/client-fis"); // CommonJS import + * const client = new FisClient(config); + * const command = new StartExperimentCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link StartExperimentCommandInput} for command's `input` shape. + * @see {@link StartExperimentCommandOutput} for command's `response` shape. + * @see {@link FisClientResolvedConfig | config} for command's `input` shape. + * */ export class StartExperimentCommand extends $Command< StartExperimentCommandInput, diff --git a/clients/client-fis/commands/StopExperimentCommand.ts b/clients/client-fis/commands/StopExperimentCommand.ts index ce2902981c9a..5fda18f4a8be 100644 --- a/clients/client-fis/commands/StopExperimentCommand.ts +++ b/clients/client-fis/commands/StopExperimentCommand.ts @@ -22,6 +22,20 @@ export interface StopExperimentCommandOutput extends StopExperimentResponse, __M /** *

Stops the specified experiment.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { FisClient, StopExperimentCommand } from "@aws-sdk/client-fis"; // ES Modules import + * // const { FisClient, StopExperimentCommand } = require("@aws-sdk/client-fis"); // CommonJS import + * const client = new FisClient(config); + * const command = new StopExperimentCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link StopExperimentCommandInput} for command's `input` shape. + * @see {@link StopExperimentCommandOutput} for command's `response` shape. + * @see {@link FisClientResolvedConfig | config} for command's `input` shape. + * */ export class StopExperimentCommand extends $Command< StopExperimentCommandInput, diff --git a/clients/client-fis/commands/TagResourceCommand.ts b/clients/client-fis/commands/TagResourceCommand.ts index 1ebebfb0b987..01d848da04f7 100644 --- a/clients/client-fis/commands/TagResourceCommand.ts +++ b/clients/client-fis/commands/TagResourceCommand.ts @@ -22,6 +22,20 @@ export interface TagResourceCommandOutput extends TagResourceResponse, __Metadat /** *

Applies the specified tags to the specified resource.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { FisClient, TagResourceCommand } from "@aws-sdk/client-fis"; // ES Modules import + * // const { FisClient, TagResourceCommand } = require("@aws-sdk/client-fis"); // CommonJS import + * const client = new FisClient(config); + * const command = new TagResourceCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link TagResourceCommandInput} for command's `input` shape. + * @see {@link TagResourceCommandOutput} for command's `response` shape. + * @see {@link FisClientResolvedConfig | config} for command's `input` shape. + * */ export class TagResourceCommand extends $Command< TagResourceCommandInput, diff --git a/clients/client-fis/commands/UntagResourceCommand.ts b/clients/client-fis/commands/UntagResourceCommand.ts index 2a8b5a3d1c18..6ce6a0ebdb69 100644 --- a/clients/client-fis/commands/UntagResourceCommand.ts +++ b/clients/client-fis/commands/UntagResourceCommand.ts @@ -22,6 +22,20 @@ export interface UntagResourceCommandOutput extends UntagResourceResponse, __Met /** *

Removes the specified tags from the specified resource.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { FisClient, UntagResourceCommand } from "@aws-sdk/client-fis"; // ES Modules import + * // const { FisClient, UntagResourceCommand } = require("@aws-sdk/client-fis"); // CommonJS import + * const client = new FisClient(config); + * const command = new UntagResourceCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link UntagResourceCommandInput} for command's `input` shape. + * @see {@link UntagResourceCommandOutput} for command's `response` shape. + * @see {@link FisClientResolvedConfig | config} for command's `input` shape. + * */ export class UntagResourceCommand extends $Command< UntagResourceCommandInput, diff --git a/clients/client-fis/commands/UpdateExperimentTemplateCommand.ts b/clients/client-fis/commands/UpdateExperimentTemplateCommand.ts index 1341f461847c..dc5138ea45a1 100644 --- a/clients/client-fis/commands/UpdateExperimentTemplateCommand.ts +++ b/clients/client-fis/commands/UpdateExperimentTemplateCommand.ts @@ -22,6 +22,20 @@ export interface UpdateExperimentTemplateCommandOutput extends UpdateExperimentT /** *

Updates the specified experiment template.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { FisClient, UpdateExperimentTemplateCommand } from "@aws-sdk/client-fis"; // ES Modules import + * // const { FisClient, UpdateExperimentTemplateCommand } = require("@aws-sdk/client-fis"); // CommonJS import + * const client = new FisClient(config); + * const command = new UpdateExperimentTemplateCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link UpdateExperimentTemplateCommandInput} for command's `input` shape. + * @see {@link UpdateExperimentTemplateCommandOutput} for command's `response` shape. + * @see {@link FisClientResolvedConfig | config} for command's `input` shape. + * */ export class UpdateExperimentTemplateCommand extends $Command< UpdateExperimentTemplateCommandInput, diff --git a/clients/client-fis/models/models_0.ts b/clients/client-fis/models/models_0.ts index f6e6fe3a97f1..7ecd5b4e6ea0 100644 --- a/clients/client-fis/models/models_0.ts +++ b/clients/client-fis/models/models_0.ts @@ -17,6 +17,9 @@ export interface ActionParameter { } export namespace ActionParameter { + /** + * @internal + */ export const filterSensitiveLog = (obj: ActionParameter): any => ({ ...obj, }); @@ -33,6 +36,9 @@ export interface ActionTarget { } export namespace ActionTarget { + /** + * @internal + */ export const filterSensitiveLog = (obj: ActionTarget): any => ({ ...obj, }); @@ -70,6 +76,9 @@ export interface Action { } export namespace Action { + /** + * @internal + */ export const filterSensitiveLog = (obj: Action): any => ({ ...obj, }); @@ -101,6 +110,9 @@ export interface ActionSummary { } export namespace ActionSummary { + /** + * @internal + */ export const filterSensitiveLog = (obj: ActionSummary): any => ({ ...obj, }); @@ -116,6 +128,9 @@ export interface ConflictException extends __SmithyException, $MetadataBearer { } export namespace ConflictException { + /** + * @internal + */ export const filterSensitiveLog = (obj: ConflictException): any => ({ ...obj, }); @@ -152,6 +167,9 @@ export interface CreateExperimentTemplateActionInput { } export namespace CreateExperimentTemplateActionInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateExperimentTemplateActionInput): any => ({ ...obj, }); @@ -176,6 +194,9 @@ export interface CreateExperimentTemplateStopConditionInput { } export namespace CreateExperimentTemplateStopConditionInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateExperimentTemplateStopConditionInput): any => ({ ...obj, }); @@ -197,6 +218,9 @@ export interface ExperimentTemplateTargetInputFilter { } export namespace ExperimentTemplateTargetInputFilter { + /** + * @internal + */ export const filterSensitiveLog = (obj: ExperimentTemplateTargetInputFilter): any => ({ ...obj, }); @@ -247,6 +271,9 @@ export interface CreateExperimentTemplateTargetInput { } export namespace CreateExperimentTemplateTargetInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateExperimentTemplateTargetInput): any => ({ ...obj, }); @@ -290,6 +317,9 @@ export interface CreateExperimentTemplateRequest { } export namespace CreateExperimentTemplateRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateExperimentTemplateRequest): any => ({ ...obj, }); @@ -326,6 +356,9 @@ export interface ExperimentTemplateAction { } export namespace ExperimentTemplateAction { + /** + * @internal + */ export const filterSensitiveLog = (obj: ExperimentTemplateAction): any => ({ ...obj, }); @@ -347,6 +380,9 @@ export interface ExperimentTemplateStopCondition { } export namespace ExperimentTemplateStopCondition { + /** + * @internal + */ export const filterSensitiveLog = (obj: ExperimentTemplateStopCondition): any => ({ ...obj, }); @@ -368,6 +404,9 @@ export interface ExperimentTemplateTargetFilter { } export namespace ExperimentTemplateTargetFilter { + /** + * @internal + */ export const filterSensitiveLog = (obj: ExperimentTemplateTargetFilter): any => ({ ...obj, }); @@ -404,6 +443,9 @@ export interface ExperimentTemplateTarget { } export namespace ExperimentTemplateTarget { + /** + * @internal + */ export const filterSensitiveLog = (obj: ExperimentTemplateTarget): any => ({ ...obj, }); @@ -460,6 +502,9 @@ export interface ExperimentTemplate { } export namespace ExperimentTemplate { + /** + * @internal + */ export const filterSensitiveLog = (obj: ExperimentTemplate): any => ({ ...obj, }); @@ -473,6 +518,9 @@ export interface CreateExperimentTemplateResponse { } export namespace CreateExperimentTemplateResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateExperimentTemplateResponse): any => ({ ...obj, }); @@ -488,6 +536,9 @@ export interface ResourceNotFoundException extends __SmithyException, $MetadataB } export namespace ResourceNotFoundException { + /** + * @internal + */ export const filterSensitiveLog = (obj: ResourceNotFoundException): any => ({ ...obj, }); @@ -503,6 +554,9 @@ export interface ServiceQuotaExceededException extends __SmithyException, $Metad } export namespace ServiceQuotaExceededException { + /** + * @internal + */ export const filterSensitiveLog = (obj: ServiceQuotaExceededException): any => ({ ...obj, }); @@ -518,6 +572,9 @@ export interface ValidationException extends __SmithyException, $MetadataBearer } export namespace ValidationException { + /** + * @internal + */ export const filterSensitiveLog = (obj: ValidationException): any => ({ ...obj, }); @@ -531,6 +588,9 @@ export interface DeleteExperimentTemplateRequest { } export namespace DeleteExperimentTemplateRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteExperimentTemplateRequest): any => ({ ...obj, }); @@ -544,6 +604,9 @@ export interface DeleteExperimentTemplateResponse { } export namespace DeleteExperimentTemplateResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteExperimentTemplateResponse): any => ({ ...obj, }); @@ -576,6 +639,9 @@ export interface ExperimentActionState { } export namespace ExperimentActionState { + /** + * @internal + */ export const filterSensitiveLog = (obj: ExperimentActionState): any => ({ ...obj, }); @@ -617,6 +683,9 @@ export interface ExperimentAction { } export namespace ExperimentAction { + /** + * @internal + */ export const filterSensitiveLog = (obj: ExperimentAction): any => ({ ...obj, }); @@ -648,6 +717,9 @@ export interface ExperimentState { } export namespace ExperimentState { + /** + * @internal + */ export const filterSensitiveLog = (obj: ExperimentState): any => ({ ...obj, }); @@ -669,6 +741,9 @@ export interface ExperimentStopCondition { } export namespace ExperimentStopCondition { + /** + * @internal + */ export const filterSensitiveLog = (obj: ExperimentStopCondition): any => ({ ...obj, }); @@ -690,6 +765,9 @@ export interface ExperimentTargetFilter { } export namespace ExperimentTargetFilter { + /** + * @internal + */ export const filterSensitiveLog = (obj: ExperimentTargetFilter): any => ({ ...obj, }); @@ -726,6 +804,9 @@ export interface ExperimentTarget { } export namespace ExperimentTarget { + /** + * @internal + */ export const filterSensitiveLog = (obj: ExperimentTarget): any => ({ ...obj, }); @@ -792,6 +873,9 @@ export interface Experiment { } export namespace Experiment { + /** + * @internal + */ export const filterSensitiveLog = (obj: Experiment): any => ({ ...obj, }); @@ -828,6 +912,9 @@ export interface ExperimentSummary { } export namespace ExperimentSummary { + /** + * @internal + */ export const filterSensitiveLog = (obj: ExperimentSummary): any => ({ ...obj, }); @@ -864,6 +951,9 @@ export interface ExperimentTemplateSummary { } export namespace ExperimentTemplateSummary { + /** + * @internal + */ export const filterSensitiveLog = (obj: ExperimentTemplateSummary): any => ({ ...obj, }); @@ -877,6 +967,9 @@ export interface GetActionRequest { } export namespace GetActionRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetActionRequest): any => ({ ...obj, }); @@ -890,6 +983,9 @@ export interface GetActionResponse { } export namespace GetActionResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetActionResponse): any => ({ ...obj, }); @@ -903,6 +999,9 @@ export interface GetExperimentRequest { } export namespace GetExperimentRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetExperimentRequest): any => ({ ...obj, }); @@ -916,6 +1015,9 @@ export interface GetExperimentResponse { } export namespace GetExperimentResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetExperimentResponse): any => ({ ...obj, }); @@ -929,6 +1031,9 @@ export interface GetExperimentTemplateRequest { } export namespace GetExperimentTemplateRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetExperimentTemplateRequest): any => ({ ...obj, }); @@ -942,6 +1047,9 @@ export interface GetExperimentTemplateResponse { } export namespace GetExperimentTemplateResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetExperimentTemplateResponse): any => ({ ...obj, }); @@ -960,6 +1068,9 @@ export interface ListActionsRequest { } export namespace ListActionsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListActionsRequest): any => ({ ...obj, }); @@ -978,6 +1089,9 @@ export interface ListActionsResponse { } export namespace ListActionsResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListActionsResponse): any => ({ ...obj, }); @@ -996,6 +1110,9 @@ export interface ListExperimentsRequest { } export namespace ListExperimentsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListExperimentsRequest): any => ({ ...obj, }); @@ -1014,6 +1131,9 @@ export interface ListExperimentsResponse { } export namespace ListExperimentsResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListExperimentsResponse): any => ({ ...obj, }); @@ -1032,6 +1152,9 @@ export interface ListExperimentTemplatesRequest { } export namespace ListExperimentTemplatesRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListExperimentTemplatesRequest): any => ({ ...obj, }); @@ -1050,6 +1173,9 @@ export interface ListExperimentTemplatesResponse { } export namespace ListExperimentTemplatesResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListExperimentTemplatesResponse): any => ({ ...obj, }); @@ -1063,6 +1189,9 @@ export interface ListTagsForResourceRequest { } export namespace ListTagsForResourceRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListTagsForResourceRequest): any => ({ ...obj, }); @@ -1076,6 +1205,9 @@ export interface ListTagsForResourceResponse { } export namespace ListTagsForResourceResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListTagsForResourceResponse): any => ({ ...obj, }); @@ -1099,6 +1231,9 @@ export interface StartExperimentRequest { } export namespace StartExperimentRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: StartExperimentRequest): any => ({ ...obj, }); @@ -1112,6 +1247,9 @@ export interface StartExperimentResponse { } export namespace StartExperimentResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: StartExperimentResponse): any => ({ ...obj, }); @@ -1125,6 +1263,9 @@ export interface StopExperimentRequest { } export namespace StopExperimentRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: StopExperimentRequest): any => ({ ...obj, }); @@ -1138,6 +1279,9 @@ export interface StopExperimentResponse { } export namespace StopExperimentResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: StopExperimentResponse): any => ({ ...obj, }); @@ -1156,6 +1300,9 @@ export interface TagResourceRequest { } export namespace TagResourceRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: TagResourceRequest): any => ({ ...obj, }); @@ -1164,6 +1311,9 @@ export namespace TagResourceRequest { export interface TagResourceResponse {} export namespace TagResourceResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: TagResourceResponse): any => ({ ...obj, }); @@ -1182,6 +1332,9 @@ export interface UntagResourceRequest { } export namespace UntagResourceRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: UntagResourceRequest): any => ({ ...obj, }); @@ -1190,6 +1343,9 @@ export namespace UntagResourceRequest { export interface UntagResourceResponse {} export namespace UntagResourceResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: UntagResourceResponse): any => ({ ...obj, }); @@ -1226,6 +1382,9 @@ export interface UpdateExperimentTemplateActionInputItem { } export namespace UpdateExperimentTemplateActionInputItem { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateExperimentTemplateActionInputItem): any => ({ ...obj, }); @@ -1249,6 +1408,9 @@ export interface UpdateExperimentTemplateStopConditionInput { } export namespace UpdateExperimentTemplateStopConditionInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateExperimentTemplateStopConditionInput): any => ({ ...obj, }); @@ -1285,6 +1447,9 @@ export interface UpdateExperimentTemplateTargetInput { } export namespace UpdateExperimentTemplateTargetInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateExperimentTemplateTargetInput): any => ({ ...obj, }); @@ -1323,6 +1488,9 @@ export interface UpdateExperimentTemplateRequest { } export namespace UpdateExperimentTemplateRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateExperimentTemplateRequest): any => ({ ...obj, }); @@ -1336,6 +1504,9 @@ export interface UpdateExperimentTemplateResponse { } export namespace UpdateExperimentTemplateResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateExperimentTemplateResponse): any => ({ ...obj, }); diff --git a/clients/client-fms/commands/AssociateAdminAccountCommand.ts b/clients/client-fms/commands/AssociateAdminAccountCommand.ts index d117f951a575..d2416d67cbeb 100644 --- a/clients/client-fms/commands/AssociateAdminAccountCommand.ts +++ b/clients/client-fms/commands/AssociateAdminAccountCommand.ts @@ -28,6 +28,20 @@ export interface AssociateAdminAccountCommandOutput extends __MetadataBearer {} * the given member account.

*

The account that you associate with AWS Firewall Manager is called the AWS Firewall * Manager administrator account.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { FMSClient, AssociateAdminAccountCommand } from "@aws-sdk/client-fms"; // ES Modules import + * // const { FMSClient, AssociateAdminAccountCommand } = require("@aws-sdk/client-fms"); // CommonJS import + * const client = new FMSClient(config); + * const command = new AssociateAdminAccountCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link AssociateAdminAccountCommandInput} for command's `input` shape. + * @see {@link AssociateAdminAccountCommandOutput} for command's `response` shape. + * @see {@link FMSClientResolvedConfig | config} for command's `input` shape. + * */ export class AssociateAdminAccountCommand extends $Command< AssociateAdminAccountCommandInput, diff --git a/clients/client-fms/commands/DeleteAppsListCommand.ts b/clients/client-fms/commands/DeleteAppsListCommand.ts index cc4a02625f46..f09ec3bbf5b8 100644 --- a/clients/client-fms/commands/DeleteAppsListCommand.ts +++ b/clients/client-fms/commands/DeleteAppsListCommand.ts @@ -22,6 +22,20 @@ export interface DeleteAppsListCommandOutput extends __MetadataBearer {} /** *

Permanently deletes an AWS Firewall Manager applications list.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { FMSClient, DeleteAppsListCommand } from "@aws-sdk/client-fms"; // ES Modules import + * // const { FMSClient, DeleteAppsListCommand } = require("@aws-sdk/client-fms"); // CommonJS import + * const client = new FMSClient(config); + * const command = new DeleteAppsListCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteAppsListCommandInput} for command's `input` shape. + * @see {@link DeleteAppsListCommandOutput} for command's `response` shape. + * @see {@link FMSClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteAppsListCommand extends $Command< DeleteAppsListCommandInput, diff --git a/clients/client-fms/commands/DeleteNotificationChannelCommand.ts b/clients/client-fms/commands/DeleteNotificationChannelCommand.ts index 817d1aee3ad9..e72236b9567e 100644 --- a/clients/client-fms/commands/DeleteNotificationChannelCommand.ts +++ b/clients/client-fms/commands/DeleteNotificationChannelCommand.ts @@ -23,6 +23,20 @@ export interface DeleteNotificationChannelCommandOutput extends __MetadataBearer /** *

Deletes an AWS Firewall Manager association with the IAM role and the Amazon Simple * Notification Service (SNS) topic that is used to record AWS Firewall Manager SNS logs.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { FMSClient, DeleteNotificationChannelCommand } from "@aws-sdk/client-fms"; // ES Modules import + * // const { FMSClient, DeleteNotificationChannelCommand } = require("@aws-sdk/client-fms"); // CommonJS import + * const client = new FMSClient(config); + * const command = new DeleteNotificationChannelCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteNotificationChannelCommandInput} for command's `input` shape. + * @see {@link DeleteNotificationChannelCommandOutput} for command's `response` shape. + * @see {@link FMSClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteNotificationChannelCommand extends $Command< DeleteNotificationChannelCommandInput, diff --git a/clients/client-fms/commands/DeletePolicyCommand.ts b/clients/client-fms/commands/DeletePolicyCommand.ts index 69df065a91bc..7b98380e7d81 100644 --- a/clients/client-fms/commands/DeletePolicyCommand.ts +++ b/clients/client-fms/commands/DeletePolicyCommand.ts @@ -22,6 +22,20 @@ export interface DeletePolicyCommandOutput extends __MetadataBearer {} /** *

Permanently deletes an AWS Firewall Manager policy.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { FMSClient, DeletePolicyCommand } from "@aws-sdk/client-fms"; // ES Modules import + * // const { FMSClient, DeletePolicyCommand } = require("@aws-sdk/client-fms"); // CommonJS import + * const client = new FMSClient(config); + * const command = new DeletePolicyCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeletePolicyCommandInput} for command's `input` shape. + * @see {@link DeletePolicyCommandOutput} for command's `response` shape. + * @see {@link FMSClientResolvedConfig | config} for command's `input` shape. + * */ export class DeletePolicyCommand extends $Command< DeletePolicyCommandInput, diff --git a/clients/client-fms/commands/DeleteProtocolsListCommand.ts b/clients/client-fms/commands/DeleteProtocolsListCommand.ts index 416af29bf290..881bfa454b3f 100644 --- a/clients/client-fms/commands/DeleteProtocolsListCommand.ts +++ b/clients/client-fms/commands/DeleteProtocolsListCommand.ts @@ -22,6 +22,20 @@ export interface DeleteProtocolsListCommandOutput extends __MetadataBearer {} /** *

Permanently deletes an AWS Firewall Manager protocols list.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { FMSClient, DeleteProtocolsListCommand } from "@aws-sdk/client-fms"; // ES Modules import + * // const { FMSClient, DeleteProtocolsListCommand } = require("@aws-sdk/client-fms"); // CommonJS import + * const client = new FMSClient(config); + * const command = new DeleteProtocolsListCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteProtocolsListCommandInput} for command's `input` shape. + * @see {@link DeleteProtocolsListCommandOutput} for command's `response` shape. + * @see {@link FMSClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteProtocolsListCommand extends $Command< DeleteProtocolsListCommandInput, diff --git a/clients/client-fms/commands/DisassociateAdminAccountCommand.ts b/clients/client-fms/commands/DisassociateAdminAccountCommand.ts index f884ef1220e3..ee7208cd0578 100644 --- a/clients/client-fms/commands/DisassociateAdminAccountCommand.ts +++ b/clients/client-fms/commands/DisassociateAdminAccountCommand.ts @@ -24,6 +24,20 @@ export interface DisassociateAdminAccountCommandOutput extends __MetadataBearer *

Disassociates the account that has been set as the AWS Firewall Manager administrator * account. To set a different account as the administrator account, you must submit an * AssociateAdminAccount request.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { FMSClient, DisassociateAdminAccountCommand } from "@aws-sdk/client-fms"; // ES Modules import + * // const { FMSClient, DisassociateAdminAccountCommand } = require("@aws-sdk/client-fms"); // CommonJS import + * const client = new FMSClient(config); + * const command = new DisassociateAdminAccountCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DisassociateAdminAccountCommandInput} for command's `input` shape. + * @see {@link DisassociateAdminAccountCommandOutput} for command's `response` shape. + * @see {@link FMSClientResolvedConfig | config} for command's `input` shape. + * */ export class DisassociateAdminAccountCommand extends $Command< DisassociateAdminAccountCommandInput, diff --git a/clients/client-fms/commands/GetAdminAccountCommand.ts b/clients/client-fms/commands/GetAdminAccountCommand.ts index 5cda7c7676c6..14fd1c433393 100644 --- a/clients/client-fms/commands/GetAdminAccountCommand.ts +++ b/clients/client-fms/commands/GetAdminAccountCommand.ts @@ -23,6 +23,20 @@ export interface GetAdminAccountCommandOutput extends GetAdminAccountResponse, _ /** *

Returns the AWS Organizations master account that is associated with AWS Firewall Manager * as the AWS Firewall Manager administrator.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { FMSClient, GetAdminAccountCommand } from "@aws-sdk/client-fms"; // ES Modules import + * // const { FMSClient, GetAdminAccountCommand } = require("@aws-sdk/client-fms"); // CommonJS import + * const client = new FMSClient(config); + * const command = new GetAdminAccountCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetAdminAccountCommandInput} for command's `input` shape. + * @see {@link GetAdminAccountCommandOutput} for command's `response` shape. + * @see {@link FMSClientResolvedConfig | config} for command's `input` shape. + * */ export class GetAdminAccountCommand extends $Command< GetAdminAccountCommandInput, diff --git a/clients/client-fms/commands/GetAppsListCommand.ts b/clients/client-fms/commands/GetAppsListCommand.ts index 2a0cc459009e..6f3a0394c9e9 100644 --- a/clients/client-fms/commands/GetAppsListCommand.ts +++ b/clients/client-fms/commands/GetAppsListCommand.ts @@ -22,6 +22,20 @@ export interface GetAppsListCommandOutput extends GetAppsListResponse, __Metadat /** *

Returns information about the specified AWS Firewall Manager applications list.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { FMSClient, GetAppsListCommand } from "@aws-sdk/client-fms"; // ES Modules import + * // const { FMSClient, GetAppsListCommand } = require("@aws-sdk/client-fms"); // CommonJS import + * const client = new FMSClient(config); + * const command = new GetAppsListCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetAppsListCommandInput} for command's `input` shape. + * @see {@link GetAppsListCommandOutput} for command's `response` shape. + * @see {@link FMSClientResolvedConfig | config} for command's `input` shape. + * */ export class GetAppsListCommand extends $Command< GetAppsListCommandInput, diff --git a/clients/client-fms/commands/GetComplianceDetailCommand.ts b/clients/client-fms/commands/GetComplianceDetailCommand.ts index 7b8a816cf1d7..bcbb57dcc2d4 100644 --- a/clients/client-fms/commands/GetComplianceDetailCommand.ts +++ b/clients/client-fms/commands/GetComplianceDetailCommand.ts @@ -30,6 +30,20 @@ export interface GetComplianceDetailCommandOutput extends GetComplianceDetailRes * 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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { FMSClient, GetComplianceDetailCommand } from "@aws-sdk/client-fms"; // ES Modules import + * // const { FMSClient, GetComplianceDetailCommand } = require("@aws-sdk/client-fms"); // CommonJS import + * const client = new FMSClient(config); + * const command = new GetComplianceDetailCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetComplianceDetailCommandInput} for command's `input` shape. + * @see {@link GetComplianceDetailCommandOutput} for command's `response` shape. + * @see {@link FMSClientResolvedConfig | config} for command's `input` shape. + * */ export class GetComplianceDetailCommand extends $Command< GetComplianceDetailCommandInput, diff --git a/clients/client-fms/commands/GetNotificationChannelCommand.ts b/clients/client-fms/commands/GetNotificationChannelCommand.ts index 227b0c95f9ec..3fb0a887ab03 100644 --- a/clients/client-fms/commands/GetNotificationChannelCommand.ts +++ b/clients/client-fms/commands/GetNotificationChannelCommand.ts @@ -24,6 +24,20 @@ export interface GetNotificationChannelCommandOutput extends GetNotificationChan *

Information * about the Amazon Simple Notification Service (SNS) topic that is used to * record AWS Firewall Manager SNS logs.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { FMSClient, GetNotificationChannelCommand } from "@aws-sdk/client-fms"; // ES Modules import + * // const { FMSClient, GetNotificationChannelCommand } = require("@aws-sdk/client-fms"); // CommonJS import + * const client = new FMSClient(config); + * const command = new GetNotificationChannelCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetNotificationChannelCommandInput} for command's `input` shape. + * @see {@link GetNotificationChannelCommandOutput} for command's `response` shape. + * @see {@link FMSClientResolvedConfig | config} for command's `input` shape. + * */ export class GetNotificationChannelCommand extends $Command< GetNotificationChannelCommandInput, diff --git a/clients/client-fms/commands/GetPolicyCommand.ts b/clients/client-fms/commands/GetPolicyCommand.ts index 2e89b2ef4f50..e2e316016cee 100644 --- a/clients/client-fms/commands/GetPolicyCommand.ts +++ b/clients/client-fms/commands/GetPolicyCommand.ts @@ -19,6 +19,20 @@ export interface GetPolicyCommandOutput extends GetPolicyResponse, __MetadataBea /** *

Returns information about the specified AWS Firewall Manager policy.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { FMSClient, GetPolicyCommand } from "@aws-sdk/client-fms"; // ES Modules import + * // const { FMSClient, GetPolicyCommand } = require("@aws-sdk/client-fms"); // CommonJS import + * const client = new FMSClient(config); + * const command = new GetPolicyCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetPolicyCommandInput} for command's `input` shape. + * @see {@link GetPolicyCommandOutput} for command's `response` shape. + * @see {@link FMSClientResolvedConfig | config} for command's `input` shape. + * */ export class GetPolicyCommand extends $Command { // Start section: command_properties diff --git a/clients/client-fms/commands/GetProtectionStatusCommand.ts b/clients/client-fms/commands/GetProtectionStatusCommand.ts index 1a95968e2e17..49e42658c27c 100644 --- a/clients/client-fms/commands/GetProtectionStatusCommand.ts +++ b/clients/client-fms/commands/GetProtectionStatusCommand.ts @@ -23,6 +23,20 @@ export interface GetProtectionStatusCommandOutput extends GetProtectionStatusRes /** *

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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { FMSClient, GetProtectionStatusCommand } from "@aws-sdk/client-fms"; // ES Modules import + * // const { FMSClient, GetProtectionStatusCommand } = require("@aws-sdk/client-fms"); // CommonJS import + * const client = new FMSClient(config); + * const command = new GetProtectionStatusCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetProtectionStatusCommandInput} for command's `input` shape. + * @see {@link GetProtectionStatusCommandOutput} for command's `response` shape. + * @see {@link FMSClientResolvedConfig | config} for command's `input` shape. + * */ export class GetProtectionStatusCommand extends $Command< GetProtectionStatusCommandInput, diff --git a/clients/client-fms/commands/GetProtocolsListCommand.ts b/clients/client-fms/commands/GetProtocolsListCommand.ts index 2c497b68fd97..62936fc9c873 100644 --- a/clients/client-fms/commands/GetProtocolsListCommand.ts +++ b/clients/client-fms/commands/GetProtocolsListCommand.ts @@ -22,6 +22,20 @@ export interface GetProtocolsListCommandOutput extends GetProtocolsListResponse, /** *

Returns information about the specified AWS Firewall Manager protocols list.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { FMSClient, GetProtocolsListCommand } from "@aws-sdk/client-fms"; // ES Modules import + * // const { FMSClient, GetProtocolsListCommand } = require("@aws-sdk/client-fms"); // CommonJS import + * const client = new FMSClient(config); + * const command = new GetProtocolsListCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetProtocolsListCommandInput} for command's `input` shape. + * @see {@link GetProtocolsListCommandOutput} for command's `response` shape. + * @see {@link FMSClientResolvedConfig | config} for command's `input` shape. + * */ export class GetProtocolsListCommand extends $Command< GetProtocolsListCommandInput, diff --git a/clients/client-fms/commands/GetViolationDetailsCommand.ts b/clients/client-fms/commands/GetViolationDetailsCommand.ts index f831d7aeee6a..5afefcca7f15 100644 --- a/clients/client-fms/commands/GetViolationDetailsCommand.ts +++ b/clients/client-fms/commands/GetViolationDetailsCommand.ts @@ -22,6 +22,20 @@ export interface GetViolationDetailsCommandOutput extends GetViolationDetailsRes /** *

Retrieves violations for a resource based on the specified AWS Firewall Manager policy and AWS account.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { FMSClient, GetViolationDetailsCommand } from "@aws-sdk/client-fms"; // ES Modules import + * // const { FMSClient, GetViolationDetailsCommand } = require("@aws-sdk/client-fms"); // CommonJS import + * const client = new FMSClient(config); + * const command = new GetViolationDetailsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetViolationDetailsCommandInput} for command's `input` shape. + * @see {@link GetViolationDetailsCommandOutput} for command's `response` shape. + * @see {@link FMSClientResolvedConfig | config} for command's `input` shape. + * */ export class GetViolationDetailsCommand extends $Command< GetViolationDetailsCommandInput, diff --git a/clients/client-fms/commands/ListAppsListsCommand.ts b/clients/client-fms/commands/ListAppsListsCommand.ts index fc7ab3a66cd2..97baeddee23b 100644 --- a/clients/client-fms/commands/ListAppsListsCommand.ts +++ b/clients/client-fms/commands/ListAppsListsCommand.ts @@ -22,6 +22,20 @@ export interface ListAppsListsCommandOutput extends ListAppsListsResponse, __Met /** *

Returns an array of AppsListDataSummary objects.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { FMSClient, ListAppsListsCommand } from "@aws-sdk/client-fms"; // ES Modules import + * // const { FMSClient, ListAppsListsCommand } = require("@aws-sdk/client-fms"); // CommonJS import + * const client = new FMSClient(config); + * const command = new ListAppsListsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListAppsListsCommandInput} for command's `input` shape. + * @see {@link ListAppsListsCommandOutput} for command's `response` shape. + * @see {@link FMSClientResolvedConfig | config} for command's `input` shape. + * */ export class ListAppsListsCommand extends $Command< ListAppsListsCommandInput, diff --git a/clients/client-fms/commands/ListComplianceStatusCommand.ts b/clients/client-fms/commands/ListComplianceStatusCommand.ts index 57dc85ee44b8..0ee1df1983b1 100644 --- a/clients/client-fms/commands/ListComplianceStatusCommand.ts +++ b/clients/client-fms/commands/ListComplianceStatusCommand.ts @@ -24,6 +24,20 @@ export interface ListComplianceStatusCommandOutput extends ListComplianceStatusR *

Returns an array of PolicyComplianceStatus objects. Use * PolicyComplianceStatus to get a summary of which member accounts are protected * by the specified policy.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { FMSClient, ListComplianceStatusCommand } from "@aws-sdk/client-fms"; // ES Modules import + * // const { FMSClient, ListComplianceStatusCommand } = require("@aws-sdk/client-fms"); // CommonJS import + * const client = new FMSClient(config); + * const command = new ListComplianceStatusCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListComplianceStatusCommandInput} for command's `input` shape. + * @see {@link ListComplianceStatusCommandOutput} for command's `response` shape. + * @see {@link FMSClientResolvedConfig | config} for command's `input` shape. + * */ export class ListComplianceStatusCommand extends $Command< ListComplianceStatusCommandInput, diff --git a/clients/client-fms/commands/ListMemberAccountsCommand.ts b/clients/client-fms/commands/ListMemberAccountsCommand.ts index 8818bf4adabc..cbe0feabc8bf 100644 --- a/clients/client-fms/commands/ListMemberAccountsCommand.ts +++ b/clients/client-fms/commands/ListMemberAccountsCommand.ts @@ -25,6 +25,20 @@ export interface ListMemberAccountsCommandOutput extends ListMemberAccountsRespo * administrator's AWS organization.

*

The ListMemberAccounts must be submitted by the account that is set as the * AWS Firewall Manager administrator.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { FMSClient, ListMemberAccountsCommand } from "@aws-sdk/client-fms"; // ES Modules import + * // const { FMSClient, ListMemberAccountsCommand } = require("@aws-sdk/client-fms"); // CommonJS import + * const client = new FMSClient(config); + * const command = new ListMemberAccountsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListMemberAccountsCommandInput} for command's `input` shape. + * @see {@link ListMemberAccountsCommandOutput} for command's `response` shape. + * @see {@link FMSClientResolvedConfig | config} for command's `input` shape. + * */ export class ListMemberAccountsCommand extends $Command< ListMemberAccountsCommandInput, diff --git a/clients/client-fms/commands/ListPoliciesCommand.ts b/clients/client-fms/commands/ListPoliciesCommand.ts index 1c7be3eb4209..c51e13f43258 100644 --- a/clients/client-fms/commands/ListPoliciesCommand.ts +++ b/clients/client-fms/commands/ListPoliciesCommand.ts @@ -22,6 +22,20 @@ export interface ListPoliciesCommandOutput extends ListPoliciesResponse, __Metad /** *

Returns an array of PolicySummary objects.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { FMSClient, ListPoliciesCommand } from "@aws-sdk/client-fms"; // ES Modules import + * // const { FMSClient, ListPoliciesCommand } = require("@aws-sdk/client-fms"); // CommonJS import + * const client = new FMSClient(config); + * const command = new ListPoliciesCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListPoliciesCommandInput} for command's `input` shape. + * @see {@link ListPoliciesCommandOutput} for command's `response` shape. + * @see {@link FMSClientResolvedConfig | config} for command's `input` shape. + * */ export class ListPoliciesCommand extends $Command< ListPoliciesCommandInput, diff --git a/clients/client-fms/commands/ListProtocolsListsCommand.ts b/clients/client-fms/commands/ListProtocolsListsCommand.ts index 6a0f7f79336e..38ea0810b7e6 100644 --- a/clients/client-fms/commands/ListProtocolsListsCommand.ts +++ b/clients/client-fms/commands/ListProtocolsListsCommand.ts @@ -22,6 +22,20 @@ export interface ListProtocolsListsCommandOutput extends ListProtocolsListsRespo /** *

Returns an array of ProtocolsListDataSummary objects.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { FMSClient, ListProtocolsListsCommand } from "@aws-sdk/client-fms"; // ES Modules import + * // const { FMSClient, ListProtocolsListsCommand } = require("@aws-sdk/client-fms"); // CommonJS import + * const client = new FMSClient(config); + * const command = new ListProtocolsListsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListProtocolsListsCommandInput} for command's `input` shape. + * @see {@link ListProtocolsListsCommandOutput} for command's `response` shape. + * @see {@link FMSClientResolvedConfig | config} for command's `input` shape. + * */ export class ListProtocolsListsCommand extends $Command< ListProtocolsListsCommandInput, diff --git a/clients/client-fms/commands/ListTagsForResourceCommand.ts b/clients/client-fms/commands/ListTagsForResourceCommand.ts index c893a0c442ff..084a5b0da370 100644 --- a/clients/client-fms/commands/ListTagsForResourceCommand.ts +++ b/clients/client-fms/commands/ListTagsForResourceCommand.ts @@ -22,6 +22,20 @@ export interface ListTagsForResourceCommandOutput extends ListTagsForResourceRes /** *

Retrieves the list of tags for the specified AWS resource.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { FMSClient, ListTagsForResourceCommand } from "@aws-sdk/client-fms"; // ES Modules import + * // const { FMSClient, ListTagsForResourceCommand } = require("@aws-sdk/client-fms"); // CommonJS import + * const client = new FMSClient(config); + * const command = new ListTagsForResourceCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListTagsForResourceCommandInput} for command's `input` shape. + * @see {@link ListTagsForResourceCommandOutput} for command's `response` shape. + * @see {@link FMSClientResolvedConfig | config} for command's `input` shape. + * */ export class ListTagsForResourceCommand extends $Command< ListTagsForResourceCommandInput, diff --git a/clients/client-fms/commands/PutAppsListCommand.ts b/clients/client-fms/commands/PutAppsListCommand.ts index b651096fadaa..b83d20810b82 100644 --- a/clients/client-fms/commands/PutAppsListCommand.ts +++ b/clients/client-fms/commands/PutAppsListCommand.ts @@ -22,6 +22,20 @@ export interface PutAppsListCommandOutput extends PutAppsListResponse, __Metadat /** *

Creates an AWS Firewall Manager applications list.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { FMSClient, PutAppsListCommand } from "@aws-sdk/client-fms"; // ES Modules import + * // const { FMSClient, PutAppsListCommand } = require("@aws-sdk/client-fms"); // CommonJS import + * const client = new FMSClient(config); + * const command = new PutAppsListCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link PutAppsListCommandInput} for command's `input` shape. + * @see {@link PutAppsListCommandOutput} for command's `response` shape. + * @see {@link FMSClientResolvedConfig | config} for command's `input` shape. + * */ export class PutAppsListCommand extends $Command< PutAppsListCommandInput, diff --git a/clients/client-fms/commands/PutNotificationChannelCommand.ts b/clients/client-fms/commands/PutNotificationChannelCommand.ts index f8a509ea1415..cca1798b62ad 100644 --- a/clients/client-fms/commands/PutNotificationChannelCommand.ts +++ b/clients/client-fms/commands/PutNotificationChannelCommand.ts @@ -26,6 +26,20 @@ export interface PutNotificationChannelCommandOutput extends __MetadataBearer {} *

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 AWS Firewall Manager Developer Guide.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { FMSClient, PutNotificationChannelCommand } from "@aws-sdk/client-fms"; // ES Modules import + * // const { FMSClient, PutNotificationChannelCommand } = require("@aws-sdk/client-fms"); // CommonJS import + * const client = new FMSClient(config); + * const command = new PutNotificationChannelCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link PutNotificationChannelCommandInput} for command's `input` shape. + * @see {@link PutNotificationChannelCommandOutput} for command's `response` shape. + * @see {@link FMSClientResolvedConfig | config} for command's `input` shape. + * */ export class PutNotificationChannelCommand extends $Command< PutNotificationChannelCommandInput, diff --git a/clients/client-fms/commands/PutPolicyCommand.ts b/clients/client-fms/commands/PutPolicyCommand.ts index b1e9c3bcdc20..788013e1b743 100644 --- a/clients/client-fms/commands/PutPolicyCommand.ts +++ b/clients/client-fms/commands/PutPolicyCommand.ts @@ -47,6 +47,20 @@ export interface PutPolicyCommandOutput extends PutPolicyResponse, __MetadataBea *

You must be subscribed to Shield Advanced to create a Shield Advanced policy. For more * information about subscribing to Shield Advanced, see * CreateSubscription.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { FMSClient, PutPolicyCommand } from "@aws-sdk/client-fms"; // ES Modules import + * // const { FMSClient, PutPolicyCommand } = require("@aws-sdk/client-fms"); // CommonJS import + * const client = new FMSClient(config); + * const command = new PutPolicyCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link PutPolicyCommandInput} for command's `input` shape. + * @see {@link PutPolicyCommandOutput} for command's `response` shape. + * @see {@link FMSClientResolvedConfig | config} for command's `input` shape. + * */ export class PutPolicyCommand extends $Command { // Start section: command_properties diff --git a/clients/client-fms/commands/PutProtocolsListCommand.ts b/clients/client-fms/commands/PutProtocolsListCommand.ts index 5e779a3befcc..7cbcb6a8a4b9 100644 --- a/clients/client-fms/commands/PutProtocolsListCommand.ts +++ b/clients/client-fms/commands/PutProtocolsListCommand.ts @@ -22,6 +22,20 @@ export interface PutProtocolsListCommandOutput extends PutProtocolsListResponse, /** *

Creates an AWS Firewall Manager protocols list.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { FMSClient, PutProtocolsListCommand } from "@aws-sdk/client-fms"; // ES Modules import + * // const { FMSClient, PutProtocolsListCommand } = require("@aws-sdk/client-fms"); // CommonJS import + * const client = new FMSClient(config); + * const command = new PutProtocolsListCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link PutProtocolsListCommandInput} for command's `input` shape. + * @see {@link PutProtocolsListCommandOutput} for command's `response` shape. + * @see {@link FMSClientResolvedConfig | config} for command's `input` shape. + * */ export class PutProtocolsListCommand extends $Command< PutProtocolsListCommandInput, diff --git a/clients/client-fms/commands/TagResourceCommand.ts b/clients/client-fms/commands/TagResourceCommand.ts index 52180a4d0b4c..7b70ec46e854 100644 --- a/clients/client-fms/commands/TagResourceCommand.ts +++ b/clients/client-fms/commands/TagResourceCommand.ts @@ -22,6 +22,20 @@ export interface TagResourceCommandOutput extends TagResourceResponse, __Metadat /** *

Adds one or more tags to an AWS resource.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { FMSClient, TagResourceCommand } from "@aws-sdk/client-fms"; // ES Modules import + * // const { FMSClient, TagResourceCommand } = require("@aws-sdk/client-fms"); // CommonJS import + * const client = new FMSClient(config); + * const command = new TagResourceCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link TagResourceCommandInput} for command's `input` shape. + * @see {@link TagResourceCommandOutput} for command's `response` shape. + * @see {@link FMSClientResolvedConfig | config} for command's `input` shape. + * */ export class TagResourceCommand extends $Command< TagResourceCommandInput, diff --git a/clients/client-fms/commands/UntagResourceCommand.ts b/clients/client-fms/commands/UntagResourceCommand.ts index 82a86e6c6fc9..f2a152b97831 100644 --- a/clients/client-fms/commands/UntagResourceCommand.ts +++ b/clients/client-fms/commands/UntagResourceCommand.ts @@ -22,6 +22,20 @@ export interface UntagResourceCommandOutput extends UntagResourceResponse, __Met /** *

Removes one or more tags from an AWS resource.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { FMSClient, UntagResourceCommand } from "@aws-sdk/client-fms"; // ES Modules import + * // const { FMSClient, UntagResourceCommand } = require("@aws-sdk/client-fms"); // CommonJS import + * const client = new FMSClient(config); + * const command = new UntagResourceCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link UntagResourceCommandInput} for command's `input` shape. + * @see {@link UntagResourceCommandOutput} for command's `response` shape. + * @see {@link FMSClientResolvedConfig | config} for command's `input` shape. + * */ export class UntagResourceCommand extends $Command< UntagResourceCommandInput, diff --git a/clients/client-fms/models/models_0.ts b/clients/client-fms/models/models_0.ts index 34ee953892ee..8fa8eee66537 100644 --- a/clients/client-fms/models/models_0.ts +++ b/clients/client-fms/models/models_0.ts @@ -30,6 +30,9 @@ export interface App { } export namespace App { + /** + * @internal + */ export const filterSensitiveLog = (obj: App): any => ({ ...obj, }); @@ -78,6 +81,9 @@ export interface AppsListData { } export namespace AppsListData { + /** + * @internal + */ export const filterSensitiveLog = (obj: AppsListData): any => ({ ...obj, }); @@ -109,6 +115,9 @@ export interface AppsListDataSummary { } export namespace AppsListDataSummary { + /** + * @internal + */ export const filterSensitiveLog = (obj: AppsListDataSummary): any => ({ ...obj, }); @@ -125,6 +134,9 @@ export interface AssociateAdminAccountRequest { } export namespace AssociateAdminAccountRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: AssociateAdminAccountRequest): any => ({ ...obj, }); @@ -141,6 +153,9 @@ export interface InternalErrorException extends __SmithyException, $MetadataBear } export namespace InternalErrorException { + /** + * @internal + */ export const filterSensitiveLog = (obj: InternalErrorException): any => ({ ...obj, }); @@ -156,6 +171,9 @@ export interface InvalidInputException extends __SmithyException, $MetadataBeare } export namespace InvalidInputException { + /** + * @internal + */ export const filterSensitiveLog = (obj: InvalidInputException): any => ({ ...obj, }); @@ -175,6 +193,9 @@ export interface InvalidOperationException extends __SmithyException, $MetadataB } export namespace InvalidOperationException { + /** + * @internal + */ export const filterSensitiveLog = (obj: InvalidOperationException): any => ({ ...obj, }); @@ -190,6 +211,9 @@ export interface ResourceNotFoundException extends __SmithyException, $MetadataB } export namespace ResourceNotFoundException { + /** + * @internal + */ export const filterSensitiveLog = (obj: ResourceNotFoundException): any => ({ ...obj, }); @@ -211,6 +235,9 @@ export interface AwsEc2NetworkInterfaceViolation { } export namespace AwsEc2NetworkInterfaceViolation { + /** + * @internal + */ export const filterSensitiveLog = (obj: AwsEc2NetworkInterfaceViolation): any => ({ ...obj, }); @@ -232,6 +259,9 @@ export interface AwsEc2InstanceViolation { } export namespace AwsEc2InstanceViolation { + /** + * @internal + */ export const filterSensitiveLog = (obj: AwsEc2InstanceViolation): any => ({ ...obj, }); @@ -246,6 +276,9 @@ export interface DeleteAppsListRequest { } export namespace DeleteAppsListRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteAppsListRequest): any => ({ ...obj, }); @@ -254,6 +287,9 @@ export namespace DeleteAppsListRequest { export interface DeleteNotificationChannelRequest {} export namespace DeleteNotificationChannelRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteNotificationChannelRequest): any => ({ ...obj, }); @@ -302,6 +338,9 @@ export interface DeletePolicyRequest { } export namespace DeletePolicyRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeletePolicyRequest): any => ({ ...obj, }); @@ -320,6 +359,9 @@ export interface LimitExceededException extends __SmithyException, $MetadataBear } export namespace LimitExceededException { + /** + * @internal + */ export const filterSensitiveLog = (obj: LimitExceededException): any => ({ ...obj, }); @@ -334,6 +376,9 @@ export interface DeleteProtocolsListRequest { } export namespace DeleteProtocolsListRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteProtocolsListRequest): any => ({ ...obj, }); @@ -342,6 +387,9 @@ export namespace DeleteProtocolsListRequest { export interface DisassociateAdminAccountRequest {} export namespace DisassociateAdminAccountRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DisassociateAdminAccountRequest): any => ({ ...obj, }); @@ -350,6 +398,9 @@ export namespace DisassociateAdminAccountRequest { export interface GetAdminAccountRequest {} export namespace GetAdminAccountRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetAdminAccountRequest): any => ({ ...obj, }); @@ -369,6 +420,9 @@ export interface GetAdminAccountResponse { } export namespace GetAdminAccountResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetAdminAccountResponse): any => ({ ...obj, }); @@ -387,6 +441,9 @@ export interface GetAppsListRequest { } export namespace GetAppsListRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetAppsListRequest): any => ({ ...obj, }); @@ -405,6 +462,9 @@ export interface GetAppsListResponse { } export namespace GetAppsListResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetAppsListResponse): any => ({ ...obj, }); @@ -424,6 +484,9 @@ export interface GetComplianceDetailRequest { } export namespace GetComplianceDetailRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetComplianceDetailRequest): any => ({ ...obj, }); @@ -478,6 +541,9 @@ export interface ComplianceViolator { } export namespace ComplianceViolator { + /** + * @internal + */ export const filterSensitiveLog = (obj: ComplianceViolator): any => ({ ...obj, }); @@ -532,6 +598,9 @@ export interface PolicyComplianceDetail { } export namespace PolicyComplianceDetail { + /** + * @internal + */ export const filterSensitiveLog = (obj: PolicyComplianceDetail): any => ({ ...obj, }); @@ -546,6 +615,9 @@ export interface GetComplianceDetailResponse { } export namespace GetComplianceDetailResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetComplianceDetailResponse): any => ({ ...obj, }); @@ -554,6 +626,9 @@ export namespace GetComplianceDetailResponse { export interface GetNotificationChannelRequest {} export namespace GetNotificationChannelRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetNotificationChannelRequest): any => ({ ...obj, }); @@ -572,6 +647,9 @@ export interface GetNotificationChannelResponse { } export namespace GetNotificationChannelResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetNotificationChannelResponse): any => ({ ...obj, }); @@ -585,6 +663,9 @@ export interface GetPolicyRequest { } export namespace GetPolicyRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetPolicyRequest): any => ({ ...obj, }); @@ -617,6 +698,9 @@ export interface ResourceTag { } export namespace ResourceTag { + /** + * @internal + */ export const filterSensitiveLog = (obj: ResourceTag): any => ({ ...obj, }); @@ -704,6 +788,9 @@ export interface SecurityServicePolicyData { } export namespace SecurityServicePolicyData { + /** + * @internal + */ export const filterSensitiveLog = (obj: SecurityServicePolicyData): any => ({ ...obj, }); @@ -826,6 +913,9 @@ export interface Policy { } export namespace Policy { + /** + * @internal + */ export const filterSensitiveLog = (obj: Policy): any => ({ ...obj, }); @@ -844,6 +934,9 @@ export interface GetPolicyResponse { } export namespace GetPolicyResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetPolicyResponse): any => ({ ...obj, }); @@ -859,6 +952,9 @@ export interface InvalidTypeException extends __SmithyException, $MetadataBearer } export namespace InvalidTypeException { + /** + * @internal + */ export const filterSensitiveLog = (obj: InvalidTypeException): any => ({ ...obj, }); @@ -909,6 +1005,9 @@ export interface GetProtectionStatusRequest { } export namespace GetProtectionStatusRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetProtectionStatusRequest): any => ({ ...obj, }); @@ -963,6 +1062,9 @@ export interface GetProtectionStatusResponse { } export namespace GetProtectionStatusResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetProtectionStatusResponse): any => ({ ...obj, }); @@ -981,6 +1083,9 @@ export interface GetProtocolsListRequest { } export namespace GetProtocolsListRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetProtocolsListRequest): any => ({ ...obj, }); @@ -1029,6 +1134,9 @@ export interface ProtocolsListData { } export namespace ProtocolsListData { + /** + * @internal + */ export const filterSensitiveLog = (obj: ProtocolsListData): any => ({ ...obj, }); @@ -1047,6 +1155,9 @@ export interface GetProtocolsListResponse { } export namespace GetProtocolsListResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetProtocolsListResponse): any => ({ ...obj, }); @@ -1082,6 +1193,9 @@ export interface GetViolationDetailsRequest { } export namespace GetViolationDetailsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetViolationDetailsRequest): any => ({ ...obj, }); @@ -1103,6 +1217,9 @@ export interface Tag { } export namespace Tag { + /** + * @internal + */ export const filterSensitiveLog = (obj: Tag): any => ({ ...obj, }); @@ -1124,6 +1241,9 @@ export interface PartialMatch { } export namespace PartialMatch { + /** + * @internal + */ export const filterSensitiveLog = (obj: PartialMatch): any => ({ ...obj, }); @@ -1170,6 +1290,9 @@ export interface SecurityGroupRuleDescription { } export namespace SecurityGroupRuleDescription { + /** + * @internal + */ export const filterSensitiveLog = (obj: SecurityGroupRuleDescription): any => ({ ...obj, }); @@ -1201,6 +1324,9 @@ export interface SecurityGroupRemediationAction { } export namespace SecurityGroupRemediationAction { + /** + * @internal + */ export const filterSensitiveLog = (obj: SecurityGroupRemediationAction): any => ({ ...obj, }); @@ -1232,6 +1358,9 @@ export interface AwsVPCSecurityGroupViolation { } export namespace AwsVPCSecurityGroupViolation { + /** + * @internal + */ export const filterSensitiveLog = (obj: AwsVPCSecurityGroupViolation): any => ({ ...obj, }); @@ -1254,6 +1383,9 @@ export interface DnsDuplicateRuleGroupViolation { } export namespace DnsDuplicateRuleGroupViolation { + /** + * @internal + */ export const filterSensitiveLog = (obj: DnsDuplicateRuleGroupViolation): any => ({ ...obj, }); @@ -1280,6 +1412,9 @@ export interface DnsRuleGroupLimitExceededViolation { } export namespace DnsRuleGroupLimitExceededViolation { + /** + * @internal + */ export const filterSensitiveLog = (obj: DnsRuleGroupLimitExceededViolation): any => ({ ...obj, }); @@ -1319,6 +1454,9 @@ export interface DnsRuleGroupPriorityConflictViolation { } export namespace DnsRuleGroupPriorityConflictViolation { + /** + * @internal + */ export const filterSensitiveLog = (obj: DnsRuleGroupPriorityConflictViolation): any => ({ ...obj, }); @@ -1356,6 +1494,9 @@ export interface NetworkFirewallMissingExpectedRTViolation { } export namespace NetworkFirewallMissingExpectedRTViolation { + /** + * @internal + */ export const filterSensitiveLog = (obj: NetworkFirewallMissingExpectedRTViolation): any => ({ ...obj, }); @@ -1388,6 +1529,9 @@ export interface NetworkFirewallMissingFirewallViolation { } export namespace NetworkFirewallMissingFirewallViolation { + /** + * @internal + */ export const filterSensitiveLog = (obj: NetworkFirewallMissingFirewallViolation): any => ({ ...obj, }); @@ -1420,6 +1564,9 @@ export interface NetworkFirewallMissingSubnetViolation { } export namespace NetworkFirewallMissingSubnetViolation { + /** + * @internal + */ export const filterSensitiveLog = (obj: NetworkFirewallMissingSubnetViolation): any => ({ ...obj, }); @@ -1441,6 +1588,9 @@ export interface StatefulRuleGroup { } export namespace StatefulRuleGroup { + /** + * @internal + */ export const filterSensitiveLog = (obj: StatefulRuleGroup): any => ({ ...obj, }); @@ -1467,6 +1617,9 @@ export interface StatelessRuleGroup { } export namespace StatelessRuleGroup { + /** + * @internal + */ export const filterSensitiveLog = (obj: StatelessRuleGroup): any => ({ ...obj, }); @@ -1503,6 +1656,9 @@ export interface NetworkFirewallPolicyDescription { } export namespace NetworkFirewallPolicyDescription { + /** + * @internal + */ export const filterSensitiveLog = (obj: NetworkFirewallPolicyDescription): any => ({ ...obj, }); @@ -1530,6 +1686,9 @@ export interface NetworkFirewallPolicyModifiedViolation { } export namespace NetworkFirewallPolicyModifiedViolation { + /** + * @internal + */ export const filterSensitiveLog = (obj: NetworkFirewallPolicyModifiedViolation): any => ({ ...obj, }); @@ -1599,6 +1758,9 @@ export interface ResourceViolation { } export namespace ResourceViolation { + /** + * @internal + */ export const filterSensitiveLog = (obj: ResourceViolation): any => ({ ...obj, }); @@ -1645,6 +1807,9 @@ export interface ViolationDetail { } export namespace ViolationDetail { + /** + * @internal + */ export const filterSensitiveLog = (obj: ViolationDetail): any => ({ ...obj, }); @@ -1658,6 +1823,9 @@ export interface GetViolationDetailsResponse { } export namespace GetViolationDetailsResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetViolationDetailsResponse): any => ({ ...obj, }); @@ -1686,6 +1854,9 @@ export interface ListAppsListsRequest { } export namespace ListAppsListsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListAppsListsRequest): any => ({ ...obj, }); @@ -1705,6 +1876,9 @@ export interface ListAppsListsResponse { } export namespace ListAppsListsResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListAppsListsResponse): any => ({ ...obj, }); @@ -1738,6 +1912,9 @@ export interface ListComplianceStatusRequest { } export namespace ListComplianceStatusRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListComplianceStatusRequest): any => ({ ...obj, }); @@ -1775,6 +1952,9 @@ export interface EvaluationResult { } export namespace EvaluationResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: EvaluationResult): any => ({ ...obj, }); @@ -1826,6 +2006,9 @@ export interface PolicyComplianceStatus { } export namespace PolicyComplianceStatus { + /** + * @internal + */ export const filterSensitiveLog = (obj: PolicyComplianceStatus): any => ({ ...obj, }); @@ -1849,6 +2032,9 @@ export interface ListComplianceStatusResponse { } export namespace ListComplianceStatusResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListComplianceStatusResponse): any => ({ ...obj, }); @@ -1875,6 +2061,9 @@ export interface ListMemberAccountsRequest { } export namespace ListMemberAccountsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListMemberAccountsRequest): any => ({ ...obj, }); @@ -1897,6 +2086,9 @@ export interface ListMemberAccountsResponse { } export namespace ListMemberAccountsResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListMemberAccountsResponse): any => ({ ...obj, }); @@ -1925,6 +2117,9 @@ export interface ListPoliciesRequest { } export namespace ListPoliciesRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListPoliciesRequest): any => ({ ...obj, }); @@ -1977,6 +2172,9 @@ export interface PolicySummary { } export namespace PolicySummary { + /** + * @internal + */ export const filterSensitiveLog = (obj: PolicySummary): any => ({ ...obj, }); @@ -1999,6 +2197,9 @@ export interface ListPoliciesResponse { } export namespace ListPoliciesResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListPoliciesResponse): any => ({ ...obj, }); @@ -2027,6 +2228,9 @@ export interface ListProtocolsListsRequest { } export namespace ListProtocolsListsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListProtocolsListsRequest): any => ({ ...obj, }); @@ -2058,6 +2262,9 @@ export interface ProtocolsListDataSummary { } export namespace ProtocolsListDataSummary { + /** + * @internal + */ export const filterSensitiveLog = (obj: ProtocolsListDataSummary): any => ({ ...obj, }); @@ -2077,6 +2284,9 @@ export interface ListProtocolsListsResponse { } export namespace ListProtocolsListsResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListProtocolsListsResponse): any => ({ ...obj, }); @@ -2090,6 +2300,9 @@ export interface ListTagsForResourceRequest { } export namespace ListTagsForResourceRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListTagsForResourceRequest): any => ({ ...obj, }); @@ -2103,6 +2316,9 @@ export interface ListTagsForResourceResponse { } export namespace ListTagsForResourceResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListTagsForResourceResponse): any => ({ ...obj, }); @@ -2121,6 +2337,9 @@ export interface PutAppsListRequest { } export namespace PutAppsListRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: PutAppsListRequest): any => ({ ...obj, }); @@ -2139,6 +2358,9 @@ export interface PutAppsListResponse { } export namespace PutAppsListResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: PutAppsListResponse): any => ({ ...obj, }); @@ -2159,6 +2381,9 @@ export interface PutNotificationChannelRequest { } export namespace PutNotificationChannelRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: PutNotificationChannelRequest): any => ({ ...obj, }); @@ -2177,6 +2402,9 @@ export interface PutPolicyRequest { } export namespace PutPolicyRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: PutPolicyRequest): any => ({ ...obj, }); @@ -2195,6 +2423,9 @@ export interface PutPolicyResponse { } export namespace PutPolicyResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: PutPolicyResponse): any => ({ ...obj, }); @@ -2213,6 +2444,9 @@ export interface PutProtocolsListRequest { } export namespace PutProtocolsListRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: PutProtocolsListRequest): any => ({ ...obj, }); @@ -2231,6 +2465,9 @@ export interface PutProtocolsListResponse { } export namespace PutProtocolsListResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: PutProtocolsListResponse): any => ({ ...obj, }); @@ -2249,6 +2486,9 @@ export interface TagResourceRequest { } export namespace TagResourceRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: TagResourceRequest): any => ({ ...obj, }); @@ -2257,6 +2497,9 @@ export namespace TagResourceRequest { export interface TagResourceResponse {} export namespace TagResourceResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: TagResourceResponse): any => ({ ...obj, }); @@ -2275,6 +2518,9 @@ export interface UntagResourceRequest { } export namespace UntagResourceRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: UntagResourceRequest): any => ({ ...obj, }); @@ -2283,6 +2529,9 @@ export namespace UntagResourceRequest { export interface UntagResourceResponse {} export namespace UntagResourceResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: UntagResourceResponse): any => ({ ...obj, }); diff --git a/clients/client-forecast/commands/CreateDatasetCommand.ts b/clients/client-forecast/commands/CreateDatasetCommand.ts index d3b99297be2f..48c2610fbb61 100644 --- a/clients/client-forecast/commands/CreateDatasetCommand.ts +++ b/clients/client-forecast/commands/CreateDatasetCommand.ts @@ -63,6 +63,20 @@ export interface CreateDatasetCommandOutput extends CreateDatasetResponse, __Met *

The Status of a dataset must be ACTIVE before you can import * training data. Use the DescribeDataset operation to get the status.

* + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ForecastClient, CreateDatasetCommand } from "@aws-sdk/client-forecast"; // ES Modules import + * // const { ForecastClient, CreateDatasetCommand } = require("@aws-sdk/client-forecast"); // CommonJS import + * const client = new ForecastClient(config); + * const command = new CreateDatasetCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreateDatasetCommandInput} for command's `input` shape. + * @see {@link CreateDatasetCommandOutput} for command's `response` shape. + * @see {@link ForecastClientResolvedConfig | config} for command's `input` shape. + * */ export class CreateDatasetCommand extends $Command< CreateDatasetCommandInput, diff --git a/clients/client-forecast/commands/CreateDatasetGroupCommand.ts b/clients/client-forecast/commands/CreateDatasetGroupCommand.ts index caca2b5a8dbc..89966d29abbb 100644 --- a/clients/client-forecast/commands/CreateDatasetGroupCommand.ts +++ b/clients/client-forecast/commands/CreateDatasetGroupCommand.ts @@ -31,6 +31,20 @@ export interface CreateDatasetGroupCommandOutput extends CreateDatasetGroupRespo *

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.

* + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ForecastClient, CreateDatasetGroupCommand } from "@aws-sdk/client-forecast"; // ES Modules import + * // const { ForecastClient, CreateDatasetGroupCommand } = require("@aws-sdk/client-forecast"); // CommonJS import + * const client = new ForecastClient(config); + * const command = new CreateDatasetGroupCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreateDatasetGroupCommandInput} for command's `input` shape. + * @see {@link CreateDatasetGroupCommandOutput} for command's `response` shape. + * @see {@link ForecastClientResolvedConfig | config} for command's `input` shape. + * */ export class CreateDatasetGroupCommand extends $Command< CreateDatasetGroupCommandInput, diff --git a/clients/client-forecast/commands/CreateDatasetImportJobCommand.ts b/clients/client-forecast/commands/CreateDatasetImportJobCommand.ts index 364e4d20857f..a181ce35c62f 100644 --- a/clients/client-forecast/commands/CreateDatasetImportJobCommand.ts +++ b/clients/client-forecast/commands/CreateDatasetImportJobCommand.ts @@ -41,6 +41,20 @@ export interface CreateDatasetImportJobCommandOutput extends CreateDatasetImport * *

To get a list of all your dataset import jobs, filtered by specified criteria, use the * ListDatasetImportJobs operation.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ForecastClient, CreateDatasetImportJobCommand } from "@aws-sdk/client-forecast"; // ES Modules import + * // const { ForecastClient, CreateDatasetImportJobCommand } = require("@aws-sdk/client-forecast"); // CommonJS import + * const client = new ForecastClient(config); + * const command = new CreateDatasetImportJobCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreateDatasetImportJobCommandInput} for command's `input` shape. + * @see {@link CreateDatasetImportJobCommandOutput} for command's `response` shape. + * @see {@link ForecastClientResolvedConfig | config} for command's `input` shape. + * */ export class CreateDatasetImportJobCommand extends $Command< CreateDatasetImportJobCommandInput, diff --git a/clients/client-forecast/commands/CreateForecastCommand.ts b/clients/client-forecast/commands/CreateForecastCommand.ts index fc7784c9b537..d36ace068ec8 100644 --- a/clients/client-forecast/commands/CreateForecastCommand.ts +++ b/clients/client-forecast/commands/CreateForecastCommand.ts @@ -40,6 +40,20 @@ export interface CreateForecastCommandOutput extends CreateForecastResponse, __M * or export the forecast. Use the DescribeForecast operation to get the * status.

* + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ForecastClient, CreateForecastCommand } from "@aws-sdk/client-forecast"; // ES Modules import + * // const { ForecastClient, CreateForecastCommand } = require("@aws-sdk/client-forecast"); // CommonJS import + * const client = new ForecastClient(config); + * const command = new CreateForecastCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreateForecastCommandInput} for command's `input` shape. + * @see {@link CreateForecastCommandOutput} for command's `response` shape. + * @see {@link ForecastClientResolvedConfig | config} for command's `input` shape. + * */ export class CreateForecastCommand extends $Command< CreateForecastCommandInput, diff --git a/clients/client-forecast/commands/CreateForecastExportJobCommand.ts b/clients/client-forecast/commands/CreateForecastExportJobCommand.ts index 8c2f73e8dcd6..0279af7df3ef 100644 --- a/clients/client-forecast/commands/CreateForecastExportJobCommand.ts +++ b/clients/client-forecast/commands/CreateForecastExportJobCommand.ts @@ -35,6 +35,20 @@ export interface CreateForecastExportJobCommandOutput extends CreateForecastExpo *

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.

* + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ForecastClient, CreateForecastExportJobCommand } from "@aws-sdk/client-forecast"; // ES Modules import + * // const { ForecastClient, CreateForecastExportJobCommand } = require("@aws-sdk/client-forecast"); // CommonJS import + * const client = new ForecastClient(config); + * const command = new CreateForecastExportJobCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreateForecastExportJobCommandInput} for command's `input` shape. + * @see {@link CreateForecastExportJobCommandOutput} for command's `response` shape. + * @see {@link ForecastClientResolvedConfig | config} for command's `input` shape. + * */ export class CreateForecastExportJobCommand extends $Command< CreateForecastExportJobCommandInput, diff --git a/clients/client-forecast/commands/CreatePredictorBacktestExportJobCommand.ts b/clients/client-forecast/commands/CreatePredictorBacktestExportJobCommand.ts index b5e123c80801..1dca140be80f 100644 --- a/clients/client-forecast/commands/CreatePredictorBacktestExportJobCommand.ts +++ b/clients/client-forecast/commands/CreatePredictorBacktestExportJobCommand.ts @@ -38,6 +38,20 @@ export interface CreatePredictorBacktestExportJobCommandOutput *

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.

* + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ForecastClient, CreatePredictorBacktestExportJobCommand } from "@aws-sdk/client-forecast"; // ES Modules import + * // const { ForecastClient, CreatePredictorBacktestExportJobCommand } = require("@aws-sdk/client-forecast"); // CommonJS import + * const client = new ForecastClient(config); + * const command = new CreatePredictorBacktestExportJobCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreatePredictorBacktestExportJobCommandInput} for command's `input` shape. + * @see {@link CreatePredictorBacktestExportJobCommandOutput} for command's `response` shape. + * @see {@link ForecastClientResolvedConfig | config} for command's `input` shape. + * */ export class CreatePredictorBacktestExportJobCommand extends $Command< CreatePredictorBacktestExportJobCommandInput, diff --git a/clients/client-forecast/commands/CreatePredictorCommand.ts b/clients/client-forecast/commands/CreatePredictorCommand.ts index 001012acf954..6429389ec387 100644 --- a/clients/client-forecast/commands/CreatePredictorCommand.ts +++ b/clients/client-forecast/commands/CreatePredictorCommand.ts @@ -83,6 +83,20 @@ export interface CreatePredictorCommandOutput extends CreatePredictorResponse, _ * predictor must be ACTIVE, signifying that training has completed. To get the * status, use the DescribePredictor operation.

* + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ForecastClient, CreatePredictorCommand } from "@aws-sdk/client-forecast"; // ES Modules import + * // const { ForecastClient, CreatePredictorCommand } = require("@aws-sdk/client-forecast"); // CommonJS import + * const client = new ForecastClient(config); + * const command = new CreatePredictorCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreatePredictorCommandInput} for command's `input` shape. + * @see {@link CreatePredictorCommandOutput} for command's `response` shape. + * @see {@link ForecastClientResolvedConfig | config} for command's `input` shape. + * */ export class CreatePredictorCommand extends $Command< CreatePredictorCommandInput, diff --git a/clients/client-forecast/commands/DeleteDatasetCommand.ts b/clients/client-forecast/commands/DeleteDatasetCommand.ts index 728b9c127e59..afee479b88a4 100644 --- a/clients/client-forecast/commands/DeleteDatasetCommand.ts +++ b/clients/client-forecast/commands/DeleteDatasetCommand.ts @@ -30,6 +30,20 @@ export interface DeleteDatasetCommandOutput extends __MetadataBearer {} * In order to update the dataset group, use the * operation, omitting the deleted dataset's ARN.

* + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ForecastClient, DeleteDatasetCommand } from "@aws-sdk/client-forecast"; // ES Modules import + * // const { ForecastClient, DeleteDatasetCommand } = require("@aws-sdk/client-forecast"); // CommonJS import + * const client = new ForecastClient(config); + * const command = new DeleteDatasetCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteDatasetCommandInput} for command's `input` shape. + * @see {@link DeleteDatasetCommandOutput} for command's `response` shape. + * @see {@link ForecastClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteDatasetCommand extends $Command< DeleteDatasetCommandInput, diff --git a/clients/client-forecast/commands/DeleteDatasetGroupCommand.ts b/clients/client-forecast/commands/DeleteDatasetGroupCommand.ts index ead521c3ab04..82f030a5b113 100644 --- a/clients/client-forecast/commands/DeleteDatasetGroupCommand.ts +++ b/clients/client-forecast/commands/DeleteDatasetGroupCommand.ts @@ -25,6 +25,20 @@ export interface DeleteDatasetGroupCommandOutput extends __MetadataBearer {} * 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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ForecastClient, DeleteDatasetGroupCommand } from "@aws-sdk/client-forecast"; // ES Modules import + * // const { ForecastClient, DeleteDatasetGroupCommand } = require("@aws-sdk/client-forecast"); // CommonJS import + * const client = new ForecastClient(config); + * const command = new DeleteDatasetGroupCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteDatasetGroupCommandInput} for command's `input` shape. + * @see {@link DeleteDatasetGroupCommandOutput} for command's `response` shape. + * @see {@link ForecastClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteDatasetGroupCommand extends $Command< DeleteDatasetGroupCommandInput, diff --git a/clients/client-forecast/commands/DeleteDatasetImportJobCommand.ts b/clients/client-forecast/commands/DeleteDatasetImportJobCommand.ts index 4ce25fee3b8e..5db24db98f2f 100644 --- a/clients/client-forecast/commands/DeleteDatasetImportJobCommand.ts +++ b/clients/client-forecast/commands/DeleteDatasetImportJobCommand.ts @@ -24,6 +24,20 @@ export interface DeleteDatasetImportJobCommandOutput extends __MetadataBearer {} *

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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ForecastClient, DeleteDatasetImportJobCommand } from "@aws-sdk/client-forecast"; // ES Modules import + * // const { ForecastClient, DeleteDatasetImportJobCommand } = require("@aws-sdk/client-forecast"); // CommonJS import + * const client = new ForecastClient(config); + * const command = new DeleteDatasetImportJobCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteDatasetImportJobCommandInput} for command's `input` shape. + * @see {@link DeleteDatasetImportJobCommandOutput} for command's `response` shape. + * @see {@link ForecastClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteDatasetImportJobCommand extends $Command< DeleteDatasetImportJobCommandInput, diff --git a/clients/client-forecast/commands/DeleteForecastCommand.ts b/clients/client-forecast/commands/DeleteForecastCommand.ts index eae0c0c26a55..58b7b3719762 100644 --- a/clients/client-forecast/commands/DeleteForecastCommand.ts +++ b/clients/client-forecast/commands/DeleteForecastCommand.ts @@ -26,6 +26,20 @@ export interface DeleteForecastCommandOutput extends __MetadataBearer {} * 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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ForecastClient, DeleteForecastCommand } from "@aws-sdk/client-forecast"; // ES Modules import + * // const { ForecastClient, DeleteForecastCommand } = require("@aws-sdk/client-forecast"); // CommonJS import + * const client = new ForecastClient(config); + * const command = new DeleteForecastCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteForecastCommandInput} for command's `input` shape. + * @see {@link DeleteForecastCommandOutput} for command's `response` shape. + * @see {@link ForecastClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteForecastCommand extends $Command< DeleteForecastCommandInput, diff --git a/clients/client-forecast/commands/DeleteForecastExportJobCommand.ts b/clients/client-forecast/commands/DeleteForecastExportJobCommand.ts index 4daaa7b4acf9..4663dd393182 100644 --- a/clients/client-forecast/commands/DeleteForecastExportJobCommand.ts +++ b/clients/client-forecast/commands/DeleteForecastExportJobCommand.ts @@ -24,6 +24,20 @@ export interface DeleteForecastExportJobCommandOutput extends __MetadataBearer { *

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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ForecastClient, DeleteForecastExportJobCommand } from "@aws-sdk/client-forecast"; // ES Modules import + * // const { ForecastClient, DeleteForecastExportJobCommand } = require("@aws-sdk/client-forecast"); // CommonJS import + * const client = new ForecastClient(config); + * const command = new DeleteForecastExportJobCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteForecastExportJobCommandInput} for command's `input` shape. + * @see {@link DeleteForecastExportJobCommandOutput} for command's `response` shape. + * @see {@link ForecastClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteForecastExportJobCommand extends $Command< DeleteForecastExportJobCommandInput, diff --git a/clients/client-forecast/commands/DeletePredictorBacktestExportJobCommand.ts b/clients/client-forecast/commands/DeletePredictorBacktestExportJobCommand.ts index 44d8bf6e19c6..77f35392754f 100644 --- a/clients/client-forecast/commands/DeletePredictorBacktestExportJobCommand.ts +++ b/clients/client-forecast/commands/DeletePredictorBacktestExportJobCommand.ts @@ -22,6 +22,20 @@ export interface DeletePredictorBacktestExportJobCommandOutput extends __Metadat /** *

Deletes a predictor backtest export job.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ForecastClient, DeletePredictorBacktestExportJobCommand } from "@aws-sdk/client-forecast"; // ES Modules import + * // const { ForecastClient, DeletePredictorBacktestExportJobCommand } = require("@aws-sdk/client-forecast"); // CommonJS import + * const client = new ForecastClient(config); + * const command = new DeletePredictorBacktestExportJobCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeletePredictorBacktestExportJobCommandInput} for command's `input` shape. + * @see {@link DeletePredictorBacktestExportJobCommandOutput} for command's `response` shape. + * @see {@link ForecastClientResolvedConfig | config} for command's `input` shape. + * */ export class DeletePredictorBacktestExportJobCommand extends $Command< DeletePredictorBacktestExportJobCommandInput, diff --git a/clients/client-forecast/commands/DeletePredictorCommand.ts b/clients/client-forecast/commands/DeletePredictorCommand.ts index 9b28bff2f6f3..630580f20713 100644 --- a/clients/client-forecast/commands/DeletePredictorCommand.ts +++ b/clients/client-forecast/commands/DeletePredictorCommand.ts @@ -24,6 +24,20 @@ export interface DeletePredictorCommandOutput extends __MetadataBearer {} *

Deletes a predictor created using the CreatePredictor operation. You can * delete only predictor that have a status of ACTIVE or CREATE_FAILED. * To get the status, use the DescribePredictor operation.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ForecastClient, DeletePredictorCommand } from "@aws-sdk/client-forecast"; // ES Modules import + * // const { ForecastClient, DeletePredictorCommand } = require("@aws-sdk/client-forecast"); // CommonJS import + * const client = new ForecastClient(config); + * const command = new DeletePredictorCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeletePredictorCommandInput} for command's `input` shape. + * @see {@link DeletePredictorCommandOutput} for command's `response` shape. + * @see {@link ForecastClientResolvedConfig | config} for command's `input` shape. + * */ export class DeletePredictorCommand extends $Command< DeletePredictorCommandInput, diff --git a/clients/client-forecast/commands/DescribeDatasetCommand.ts b/clients/client-forecast/commands/DescribeDatasetCommand.ts index 62b3a8059e3d..6614dfc66d9d 100644 --- a/clients/client-forecast/commands/DescribeDatasetCommand.ts +++ b/clients/client-forecast/commands/DescribeDatasetCommand.ts @@ -42,6 +42,20 @@ export interface DescribeDatasetCommandOutput extends DescribeDatasetResponse, _ *

* * + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ForecastClient, DescribeDatasetCommand } from "@aws-sdk/client-forecast"; // ES Modules import + * // const { ForecastClient, DescribeDatasetCommand } = require("@aws-sdk/client-forecast"); // CommonJS import + * const client = new ForecastClient(config); + * const command = new DescribeDatasetCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeDatasetCommandInput} for command's `input` shape. + * @see {@link DescribeDatasetCommandOutput} for command's `response` shape. + * @see {@link ForecastClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeDatasetCommand extends $Command< DescribeDatasetCommandInput, diff --git a/clients/client-forecast/commands/DescribeDatasetGroupCommand.ts b/clients/client-forecast/commands/DescribeDatasetGroupCommand.ts index ff13821b5c7e..ad8a64c0e158 100644 --- a/clients/client-forecast/commands/DescribeDatasetGroupCommand.ts +++ b/clients/client-forecast/commands/DescribeDatasetGroupCommand.ts @@ -46,6 +46,20 @@ export interface DescribeDatasetGroupCommandOutput extends DescribeDatasetGroupR *

* * + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ForecastClient, DescribeDatasetGroupCommand } from "@aws-sdk/client-forecast"; // ES Modules import + * // const { ForecastClient, DescribeDatasetGroupCommand } = require("@aws-sdk/client-forecast"); // CommonJS import + * const client = new ForecastClient(config); + * const command = new DescribeDatasetGroupCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeDatasetGroupCommandInput} for command's `input` shape. + * @see {@link DescribeDatasetGroupCommandOutput} for command's `response` shape. + * @see {@link ForecastClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeDatasetGroupCommand extends $Command< DescribeDatasetGroupCommandInput, diff --git a/clients/client-forecast/commands/DescribeDatasetImportJobCommand.ts b/clients/client-forecast/commands/DescribeDatasetImportJobCommand.ts index 34882a9de1f1..404710827776 100644 --- a/clients/client-forecast/commands/DescribeDatasetImportJobCommand.ts +++ b/clients/client-forecast/commands/DescribeDatasetImportJobCommand.ts @@ -56,6 +56,20 @@ export interface DescribeDatasetImportJobCommandOutput extends DescribeDatasetIm * Message - If an error occurred, information about the error.

* * + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ForecastClient, DescribeDatasetImportJobCommand } from "@aws-sdk/client-forecast"; // ES Modules import + * // const { ForecastClient, DescribeDatasetImportJobCommand } = require("@aws-sdk/client-forecast"); // CommonJS import + * const client = new ForecastClient(config); + * const command = new DescribeDatasetImportJobCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeDatasetImportJobCommandInput} for command's `input` shape. + * @see {@link DescribeDatasetImportJobCommandOutput} for command's `response` shape. + * @see {@link ForecastClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeDatasetImportJobCommand extends $Command< DescribeDatasetImportJobCommandInput, diff --git a/clients/client-forecast/commands/DescribeForecastCommand.ts b/clients/client-forecast/commands/DescribeForecastCommand.ts index 64c6abf6a506..5787be2c1220 100644 --- a/clients/client-forecast/commands/DescribeForecastCommand.ts +++ b/clients/client-forecast/commands/DescribeForecastCommand.ts @@ -50,6 +50,20 @@ export interface DescribeForecastCommandOutput extends DescribeForecastResponse, * Message - If an error occurred, information about the error.

* * + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ForecastClient, DescribeForecastCommand } from "@aws-sdk/client-forecast"; // ES Modules import + * // const { ForecastClient, DescribeForecastCommand } = require("@aws-sdk/client-forecast"); // CommonJS import + * const client = new ForecastClient(config); + * const command = new DescribeForecastCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeForecastCommandInput} for command's `input` shape. + * @see {@link DescribeForecastCommandOutput} for command's `response` shape. + * @see {@link ForecastClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeForecastCommand extends $Command< DescribeForecastCommandInput, diff --git a/clients/client-forecast/commands/DescribeForecastExportJobCommand.ts b/clients/client-forecast/commands/DescribeForecastExportJobCommand.ts index 4e6422f8fb38..01c116cdd1af 100644 --- a/clients/client-forecast/commands/DescribeForecastExportJobCommand.ts +++ b/clients/client-forecast/commands/DescribeForecastExportJobCommand.ts @@ -46,6 +46,20 @@ export interface DescribeForecastExportJobCommandOutput extends DescribeForecast * Message - If an error occurred, information about the error.

* * + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ForecastClient, DescribeForecastExportJobCommand } from "@aws-sdk/client-forecast"; // ES Modules import + * // const { ForecastClient, DescribeForecastExportJobCommand } = require("@aws-sdk/client-forecast"); // CommonJS import + * const client = new ForecastClient(config); + * const command = new DescribeForecastExportJobCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeForecastExportJobCommandInput} for command's `input` shape. + * @see {@link DescribeForecastExportJobCommandOutput} for command's `response` shape. + * @see {@link ForecastClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeForecastExportJobCommand extends $Command< DescribeForecastExportJobCommandInput, diff --git a/clients/client-forecast/commands/DescribePredictorBacktestExportJobCommand.ts b/clients/client-forecast/commands/DescribePredictorBacktestExportJobCommand.ts index f73db9e2f9cd..8c8a4f8497f9 100644 --- a/clients/client-forecast/commands/DescribePredictorBacktestExportJobCommand.ts +++ b/clients/client-forecast/commands/DescribePredictorBacktestExportJobCommand.ts @@ -51,6 +51,20 @@ export interface DescribePredictorBacktestExportJobCommandOutput * Message (if an error occurred)

* * + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ForecastClient, DescribePredictorBacktestExportJobCommand } from "@aws-sdk/client-forecast"; // ES Modules import + * // const { ForecastClient, DescribePredictorBacktestExportJobCommand } = require("@aws-sdk/client-forecast"); // CommonJS import + * const client = new ForecastClient(config); + * const command = new DescribePredictorBacktestExportJobCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribePredictorBacktestExportJobCommandInput} for command's `input` shape. + * @see {@link DescribePredictorBacktestExportJobCommandOutput} for command's `response` shape. + * @see {@link ForecastClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribePredictorBacktestExportJobCommand extends $Command< DescribePredictorBacktestExportJobCommandInput, diff --git a/clients/client-forecast/commands/DescribePredictorCommand.ts b/clients/client-forecast/commands/DescribePredictorCommand.ts index 55d9cb7ba648..ce714f557983 100644 --- a/clients/client-forecast/commands/DescribePredictorCommand.ts +++ b/clients/client-forecast/commands/DescribePredictorCommand.ts @@ -56,6 +56,20 @@ export interface DescribePredictorCommandOutput extends DescribePredictorRespons * Message - If an error occurred, information about the error.

* * + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ForecastClient, DescribePredictorCommand } from "@aws-sdk/client-forecast"; // ES Modules import + * // const { ForecastClient, DescribePredictorCommand } = require("@aws-sdk/client-forecast"); // CommonJS import + * const client = new ForecastClient(config); + * const command = new DescribePredictorCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribePredictorCommandInput} for command's `input` shape. + * @see {@link DescribePredictorCommandOutput} for command's `response` shape. + * @see {@link ForecastClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribePredictorCommand extends $Command< DescribePredictorCommandInput, diff --git a/clients/client-forecast/commands/GetAccuracyMetricsCommand.ts b/clients/client-forecast/commands/GetAccuracyMetricsCommand.ts index 0ab8212bf4b6..0637d95ac9e1 100644 --- a/clients/client-forecast/commands/GetAccuracyMetricsCommand.ts +++ b/clients/client-forecast/commands/GetAccuracyMetricsCommand.ts @@ -41,6 +41,20 @@ export interface GetAccuracyMetricsCommandOutput extends GetAccuracyMetricsRespo * ACTIVE, signifying that training has completed. * To get the status, use the DescribePredictor operation.

* + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ForecastClient, GetAccuracyMetricsCommand } from "@aws-sdk/client-forecast"; // ES Modules import + * // const { ForecastClient, GetAccuracyMetricsCommand } = require("@aws-sdk/client-forecast"); // CommonJS import + * const client = new ForecastClient(config); + * const command = new GetAccuracyMetricsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetAccuracyMetricsCommandInput} for command's `input` shape. + * @see {@link GetAccuracyMetricsCommandOutput} for command's `response` shape. + * @see {@link ForecastClientResolvedConfig | config} for command's `input` shape. + * */ export class GetAccuracyMetricsCommand extends $Command< GetAccuracyMetricsCommandInput, diff --git a/clients/client-forecast/commands/ListDatasetGroupsCommand.ts b/clients/client-forecast/commands/ListDatasetGroupsCommand.ts index e381b08b7e3d..512881de6711 100644 --- a/clients/client-forecast/commands/ListDatasetGroupsCommand.ts +++ b/clients/client-forecast/commands/ListDatasetGroupsCommand.ts @@ -25,6 +25,20 @@ export interface ListDatasetGroupsCommandOutput extends ListDatasetGroupsRespons * 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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ForecastClient, ListDatasetGroupsCommand } from "@aws-sdk/client-forecast"; // ES Modules import + * // const { ForecastClient, ListDatasetGroupsCommand } = require("@aws-sdk/client-forecast"); // CommonJS import + * const client = new ForecastClient(config); + * const command = new ListDatasetGroupsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListDatasetGroupsCommandInput} for command's `input` shape. + * @see {@link ListDatasetGroupsCommandOutput} for command's `response` shape. + * @see {@link ForecastClientResolvedConfig | config} for command's `input` shape. + * */ export class ListDatasetGroupsCommand extends $Command< ListDatasetGroupsCommandInput, diff --git a/clients/client-forecast/commands/ListDatasetImportJobsCommand.ts b/clients/client-forecast/commands/ListDatasetImportJobsCommand.ts index ad528de0e24f..40a91387585a 100644 --- a/clients/client-forecast/commands/ListDatasetImportJobsCommand.ts +++ b/clients/client-forecast/commands/ListDatasetImportJobsCommand.ts @@ -25,6 +25,20 @@ export interface ListDatasetImportJobsCommandOutput extends ListDatasetImportJob * 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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ForecastClient, ListDatasetImportJobsCommand } from "@aws-sdk/client-forecast"; // ES Modules import + * // const { ForecastClient, ListDatasetImportJobsCommand } = require("@aws-sdk/client-forecast"); // CommonJS import + * const client = new ForecastClient(config); + * const command = new ListDatasetImportJobsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListDatasetImportJobsCommandInput} for command's `input` shape. + * @see {@link ListDatasetImportJobsCommandOutput} for command's `response` shape. + * @see {@link ForecastClientResolvedConfig | config} for command's `input` shape. + * */ export class ListDatasetImportJobsCommand extends $Command< ListDatasetImportJobsCommandInput, diff --git a/clients/client-forecast/commands/ListDatasetsCommand.ts b/clients/client-forecast/commands/ListDatasetsCommand.ts index 4bf6ef605fd1..7bc81fd207b7 100644 --- a/clients/client-forecast/commands/ListDatasetsCommand.ts +++ b/clients/client-forecast/commands/ListDatasetsCommand.ts @@ -24,6 +24,20 @@ export interface ListDatasetsCommandOutput extends ListDatasetsResponse, __Metad *

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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ForecastClient, ListDatasetsCommand } from "@aws-sdk/client-forecast"; // ES Modules import + * // const { ForecastClient, ListDatasetsCommand } = require("@aws-sdk/client-forecast"); // CommonJS import + * const client = new ForecastClient(config); + * const command = new ListDatasetsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListDatasetsCommandInput} for command's `input` shape. + * @see {@link ListDatasetsCommandOutput} for command's `response` shape. + * @see {@link ForecastClientResolvedConfig | config} for command's `input` shape. + * */ export class ListDatasetsCommand extends $Command< ListDatasetsCommandInput, diff --git a/clients/client-forecast/commands/ListForecastExportJobsCommand.ts b/clients/client-forecast/commands/ListForecastExportJobsCommand.ts index ffcad26cbbf9..995027677750 100644 --- a/clients/client-forecast/commands/ListForecastExportJobsCommand.ts +++ b/clients/client-forecast/commands/ListForecastExportJobsCommand.ts @@ -25,6 +25,20 @@ export interface ListForecastExportJobsCommandOutput extends ListForecastExportJ * 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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ForecastClient, ListForecastExportJobsCommand } from "@aws-sdk/client-forecast"; // ES Modules import + * // const { ForecastClient, ListForecastExportJobsCommand } = require("@aws-sdk/client-forecast"); // CommonJS import + * const client = new ForecastClient(config); + * const command = new ListForecastExportJobsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListForecastExportJobsCommandInput} for command's `input` shape. + * @see {@link ListForecastExportJobsCommandOutput} for command's `response` shape. + * @see {@link ForecastClientResolvedConfig | config} for command's `input` shape. + * */ export class ListForecastExportJobsCommand extends $Command< ListForecastExportJobsCommandInput, diff --git a/clients/client-forecast/commands/ListForecastsCommand.ts b/clients/client-forecast/commands/ListForecastsCommand.ts index d73fc9be6321..7b08583c1f63 100644 --- a/clients/client-forecast/commands/ListForecastsCommand.ts +++ b/clients/client-forecast/commands/ListForecastsCommand.ts @@ -26,6 +26,20 @@ export interface ListForecastsCommandOutput extends ListForecastsResponse, __Met * 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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ForecastClient, ListForecastsCommand } from "@aws-sdk/client-forecast"; // ES Modules import + * // const { ForecastClient, ListForecastsCommand } = require("@aws-sdk/client-forecast"); // CommonJS import + * const client = new ForecastClient(config); + * const command = new ListForecastsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListForecastsCommandInput} for command's `input` shape. + * @see {@link ListForecastsCommandOutput} for command's `response` shape. + * @see {@link ForecastClientResolvedConfig | config} for command's `input` shape. + * */ export class ListForecastsCommand extends $Command< ListForecastsCommandInput, diff --git a/clients/client-forecast/commands/ListPredictorBacktestExportJobsCommand.ts b/clients/client-forecast/commands/ListPredictorBacktestExportJobsCommand.ts index 89dd95b72adf..445bfc1e1b7d 100644 --- a/clients/client-forecast/commands/ListPredictorBacktestExportJobsCommand.ts +++ b/clients/client-forecast/commands/ListPredictorBacktestExportJobsCommand.ts @@ -27,6 +27,20 @@ export interface ListPredictorBacktestExportJobsCommandOutput * 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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ForecastClient, ListPredictorBacktestExportJobsCommand } from "@aws-sdk/client-forecast"; // ES Modules import + * // const { ForecastClient, ListPredictorBacktestExportJobsCommand } = require("@aws-sdk/client-forecast"); // CommonJS import + * const client = new ForecastClient(config); + * const command = new ListPredictorBacktestExportJobsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListPredictorBacktestExportJobsCommandInput} for command's `input` shape. + * @see {@link ListPredictorBacktestExportJobsCommandOutput} for command's `response` shape. + * @see {@link ForecastClientResolvedConfig | config} for command's `input` shape. + * */ export class ListPredictorBacktestExportJobsCommand extends $Command< ListPredictorBacktestExportJobsCommandInput, diff --git a/clients/client-forecast/commands/ListPredictorsCommand.ts b/clients/client-forecast/commands/ListPredictorsCommand.ts index 5068fd4709fe..f80a23aad45f 100644 --- a/clients/client-forecast/commands/ListPredictorsCommand.ts +++ b/clients/client-forecast/commands/ListPredictorsCommand.ts @@ -26,6 +26,20 @@ export interface ListPredictorsCommandOutput extends ListPredictorsResponse, __M * its Amazon Resource Name (ARN). You can retrieve the complete set of properties by using the * ARN with the DescribePredictor operation. You can filter the list using an * array of Filter objects.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ForecastClient, ListPredictorsCommand } from "@aws-sdk/client-forecast"; // ES Modules import + * // const { ForecastClient, ListPredictorsCommand } = require("@aws-sdk/client-forecast"); // CommonJS import + * const client = new ForecastClient(config); + * const command = new ListPredictorsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListPredictorsCommandInput} for command's `input` shape. + * @see {@link ListPredictorsCommandOutput} for command's `response` shape. + * @see {@link ForecastClientResolvedConfig | config} for command's `input` shape. + * */ export class ListPredictorsCommand extends $Command< ListPredictorsCommandInput, diff --git a/clients/client-forecast/commands/ListTagsForResourceCommand.ts b/clients/client-forecast/commands/ListTagsForResourceCommand.ts index 63e99afcb25d..2fe89bb67029 100644 --- a/clients/client-forecast/commands/ListTagsForResourceCommand.ts +++ b/clients/client-forecast/commands/ListTagsForResourceCommand.ts @@ -22,6 +22,20 @@ export interface ListTagsForResourceCommandOutput extends ListTagsForResourceRes /** *

Lists the tags for an Amazon Forecast resource.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ForecastClient, ListTagsForResourceCommand } from "@aws-sdk/client-forecast"; // ES Modules import + * // const { ForecastClient, ListTagsForResourceCommand } = require("@aws-sdk/client-forecast"); // CommonJS import + * const client = new ForecastClient(config); + * const command = new ListTagsForResourceCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListTagsForResourceCommandInput} for command's `input` shape. + * @see {@link ListTagsForResourceCommandOutput} for command's `response` shape. + * @see {@link ForecastClientResolvedConfig | config} for command's `input` shape. + * */ export class ListTagsForResourceCommand extends $Command< ListTagsForResourceCommandInput, diff --git a/clients/client-forecast/commands/StopResourceCommand.ts b/clients/client-forecast/commands/StopResourceCommand.ts index cf2bd45d4f0d..8a9ae00d9bb2 100644 --- a/clients/client-forecast/commands/StopResourceCommand.ts +++ b/clients/client-forecast/commands/StopResourceCommand.ts @@ -44,6 +44,20 @@ export interface StopResourceCommandOutput extends __MetadataBearer {} *

Predictor Backtest Export Job

* * + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ForecastClient, StopResourceCommand } from "@aws-sdk/client-forecast"; // ES Modules import + * // const { ForecastClient, StopResourceCommand } = require("@aws-sdk/client-forecast"); // CommonJS import + * const client = new ForecastClient(config); + * const command = new StopResourceCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link StopResourceCommandInput} for command's `input` shape. + * @see {@link StopResourceCommandOutput} for command's `response` shape. + * @see {@link ForecastClientResolvedConfig | config} for command's `input` shape. + * */ export class StopResourceCommand extends $Command< StopResourceCommandInput, diff --git a/clients/client-forecast/commands/TagResourceCommand.ts b/clients/client-forecast/commands/TagResourceCommand.ts index 97862e86de59..26fe3989d1c8 100644 --- a/clients/client-forecast/commands/TagResourceCommand.ts +++ b/clients/client-forecast/commands/TagResourceCommand.ts @@ -22,6 +22,20 @@ export interface TagResourceCommandOutput extends TagResourceResponse, __Metadat /** *

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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ForecastClient, TagResourceCommand } from "@aws-sdk/client-forecast"; // ES Modules import + * // const { ForecastClient, TagResourceCommand } = require("@aws-sdk/client-forecast"); // CommonJS import + * const client = new ForecastClient(config); + * const command = new TagResourceCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link TagResourceCommandInput} for command's `input` shape. + * @see {@link TagResourceCommandOutput} for command's `response` shape. + * @see {@link ForecastClientResolvedConfig | config} for command's `input` shape. + * */ export class TagResourceCommand extends $Command< TagResourceCommandInput, diff --git a/clients/client-forecast/commands/UntagResourceCommand.ts b/clients/client-forecast/commands/UntagResourceCommand.ts index 28787b9bf756..d725c52b3abc 100644 --- a/clients/client-forecast/commands/UntagResourceCommand.ts +++ b/clients/client-forecast/commands/UntagResourceCommand.ts @@ -22,6 +22,20 @@ export interface UntagResourceCommandOutput extends UntagResourceResponse, __Met /** *

Deletes the specified tags from a resource.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ForecastClient, UntagResourceCommand } from "@aws-sdk/client-forecast"; // ES Modules import + * // const { ForecastClient, UntagResourceCommand } = require("@aws-sdk/client-forecast"); // CommonJS import + * const client = new ForecastClient(config); + * const command = new UntagResourceCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link UntagResourceCommandInput} for command's `input` shape. + * @see {@link UntagResourceCommandOutput} for command's `response` shape. + * @see {@link ForecastClientResolvedConfig | config} for command's `input` shape. + * */ export class UntagResourceCommand extends $Command< UntagResourceCommandInput, diff --git a/clients/client-forecast/commands/UpdateDatasetGroupCommand.ts b/clients/client-forecast/commands/UpdateDatasetGroupCommand.ts index 7653a56adb75..d3d90042446c 100644 --- a/clients/client-forecast/commands/UpdateDatasetGroupCommand.ts +++ b/clients/client-forecast/commands/UpdateDatasetGroupCommand.ts @@ -27,6 +27,20 @@ export interface UpdateDatasetGroupCommandOutput extends UpdateDatasetGroupRespo * use the dataset group to create a predictor. Use the DescribeDatasetGroup * operation to get the status.

* + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ForecastClient, UpdateDatasetGroupCommand } from "@aws-sdk/client-forecast"; // ES Modules import + * // const { ForecastClient, UpdateDatasetGroupCommand } = require("@aws-sdk/client-forecast"); // CommonJS import + * const client = new ForecastClient(config); + * const command = new UpdateDatasetGroupCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link UpdateDatasetGroupCommandInput} for command's `input` shape. + * @see {@link UpdateDatasetGroupCommandOutput} for command's `response` shape. + * @see {@link ForecastClientResolvedConfig | config} for command's `input` shape. + * */ export class UpdateDatasetGroupCommand extends $Command< UpdateDatasetGroupCommandInput, diff --git a/clients/client-forecast/models/models_0.ts b/clients/client-forecast/models/models_0.ts index f1cec27c34ab..b0a1bd40b559 100644 --- a/clients/client-forecast/models/models_0.ts +++ b/clients/client-forecast/models/models_0.ts @@ -37,6 +37,9 @@ export interface EncryptionConfig { } export namespace EncryptionConfig { + /** + * @internal + */ export const filterSensitiveLog = (obj: EncryptionConfig): any => ({ ...obj, }); @@ -68,6 +71,9 @@ export interface SchemaAttribute { } export namespace SchemaAttribute { + /** + * @internal + */ export const filterSensitiveLog = (obj: SchemaAttribute): any => ({ ...obj, }); @@ -84,6 +90,9 @@ export interface Schema { } export namespace Schema { + /** + * @internal + */ export const filterSensitiveLog = (obj: Schema): any => ({ ...obj, }); @@ -129,6 +138,9 @@ export interface Tag { } export namespace Tag { + /** + * @internal + */ export const filterSensitiveLog = (obj: Tag): any => ({ ...obj, ...(obj.Key && { Key: SENSITIVE_STRING }), @@ -212,6 +224,9 @@ export interface CreateDatasetRequest { } export namespace CreateDatasetRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateDatasetRequest): any => ({ ...obj, ...(obj.Tags && { Tags: obj.Tags.map((item) => Tag.filterSensitiveLog(item)) }), @@ -226,6 +241,9 @@ export interface CreateDatasetResponse { } export namespace CreateDatasetResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateDatasetResponse): any => ({ ...obj, }); @@ -242,6 +260,9 @@ export interface InvalidInputException extends __SmithyException, $MetadataBeare } export namespace InvalidInputException { + /** + * @internal + */ export const filterSensitiveLog = (obj: InvalidInputException): any => ({ ...obj, }); @@ -257,6 +278,9 @@ export interface LimitExceededException extends __SmithyException, $MetadataBear } export namespace LimitExceededException { + /** + * @internal + */ export const filterSensitiveLog = (obj: LimitExceededException): any => ({ ...obj, }); @@ -272,6 +296,9 @@ export interface ResourceAlreadyExistsException extends __SmithyException, $Meta } export namespace ResourceAlreadyExistsException { + /** + * @internal + */ export const filterSensitiveLog = (obj: ResourceAlreadyExistsException): any => ({ ...obj, }); @@ -332,6 +359,9 @@ export interface CreateDatasetGroupRequest { } export namespace CreateDatasetGroupRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateDatasetGroupRequest): any => ({ ...obj, ...(obj.Tags && { Tags: obj.Tags.map((item) => Tag.filterSensitiveLog(item)) }), @@ -346,6 +376,9 @@ export interface CreateDatasetGroupResponse { } export namespace CreateDatasetGroupResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateDatasetGroupResponse): any => ({ ...obj, }); @@ -361,6 +394,9 @@ export interface ResourceInUseException extends __SmithyException, $MetadataBear } export namespace ResourceInUseException { + /** + * @internal + */ export const filterSensitiveLog = (obj: ResourceInUseException): any => ({ ...obj, }); @@ -377,6 +413,9 @@ export interface ResourceNotFoundException extends __SmithyException, $MetadataB } export namespace ResourceNotFoundException { + /** + * @internal + */ export const filterSensitiveLog = (obj: ResourceNotFoundException): any => ({ ...obj, }); @@ -409,6 +448,9 @@ export interface S3Config { } export namespace S3Config { + /** + * @internal + */ export const filterSensitiveLog = (obj: S3Config): any => ({ ...obj, }); @@ -428,6 +470,9 @@ export interface DataSource { } export namespace DataSource { + /** + * @internal + */ export const filterSensitiveLog = (obj: DataSource): any => ({ ...obj, }); @@ -539,6 +584,9 @@ export interface CreateDatasetImportJobRequest { } export namespace CreateDatasetImportJobRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateDatasetImportJobRequest): any => ({ ...obj, ...(obj.Tags && { Tags: obj.Tags.map((item) => Tag.filterSensitiveLog(item)) }), @@ -553,6 +601,9 @@ export interface CreateDatasetImportJobResponse { } export namespace CreateDatasetImportJobResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateDatasetImportJobResponse): any => ({ ...obj, }); @@ -609,6 +660,9 @@ export interface CreateForecastRequest { } export namespace CreateForecastRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateForecastRequest): any => ({ ...obj, ...(obj.Tags && { Tags: obj.Tags.map((item) => Tag.filterSensitiveLog(item)) }), @@ -623,6 +677,9 @@ export interface CreateForecastResponse { } export namespace CreateForecastResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateForecastResponse): any => ({ ...obj, }); @@ -641,6 +698,9 @@ export interface DataDestination { } export namespace DataDestination { + /** + * @internal + */ export const filterSensitiveLog = (obj: DataDestination): any => ({ ...obj, }); @@ -697,6 +757,9 @@ export interface CreateForecastExportJobRequest { } export namespace CreateForecastExportJobRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateForecastExportJobRequest): any => ({ ...obj, ...(obj.Tags && { Tags: obj.Tags.map((item) => Tag.filterSensitiveLog(item)) }), @@ -711,6 +774,9 @@ export interface CreateForecastExportJobResponse { } export namespace CreateForecastExportJobResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateForecastExportJobResponse): any => ({ ...obj, }); @@ -742,6 +808,9 @@ export interface EvaluationParameters { } export namespace EvaluationParameters { + /** + * @internal + */ export const filterSensitiveLog = (obj: EvaluationParameters): any => ({ ...obj, }); @@ -830,6 +899,9 @@ export interface FeaturizationMethod { } export namespace FeaturizationMethod { + /** + * @internal + */ export const filterSensitiveLog = (obj: FeaturizationMethod): any => ({ ...obj, }); @@ -880,6 +952,9 @@ export interface Featurization { } export namespace Featurization { + /** + * @internal + */ export const filterSensitiveLog = (obj: Featurization): any => ({ ...obj, }); @@ -931,6 +1006,9 @@ export interface FeaturizationConfig { } export namespace FeaturizationConfig { + /** + * @internal + */ export const filterSensitiveLog = (obj: FeaturizationConfig): any => ({ ...obj, }); @@ -953,6 +1031,9 @@ export interface CategoricalParameterRange { } export namespace CategoricalParameterRange { + /** + * @internal + */ export const filterSensitiveLog = (obj: CategoricalParameterRange): any => ({ ...obj, }); @@ -1020,6 +1101,9 @@ export interface ContinuousParameterRange { } export namespace ContinuousParameterRange { + /** + * @internal + */ export const filterSensitiveLog = (obj: ContinuousParameterRange): any => ({ ...obj, }); @@ -1079,6 +1163,9 @@ export interface IntegerParameterRange { } export namespace IntegerParameterRange { + /** + * @internal + */ export const filterSensitiveLog = (obj: IntegerParameterRange): any => ({ ...obj, }); @@ -1108,6 +1195,9 @@ export interface ParameterRanges { } export namespace ParameterRanges { + /** + * @internal + */ export const filterSensitiveLog = (obj: ParameterRanges): any => ({ ...obj, }); @@ -1132,6 +1222,9 @@ export interface HyperParameterTuningJobConfig { } export namespace HyperParameterTuningJobConfig { + /** + * @internal + */ export const filterSensitiveLog = (obj: HyperParameterTuningJobConfig): any => ({ ...obj, }); @@ -1377,6 +1470,9 @@ export interface SupplementaryFeature { } export namespace SupplementaryFeature { + /** + * @internal + */ export const filterSensitiveLog = (obj: SupplementaryFeature): any => ({ ...obj, }); @@ -1401,6 +1497,9 @@ export interface InputDataConfig { } export namespace InputDataConfig { + /** + * @internal + */ export const filterSensitiveLog = (obj: InputDataConfig): any => ({ ...obj, }); @@ -1577,6 +1676,9 @@ export interface CreatePredictorRequest { } export namespace CreatePredictorRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreatePredictorRequest): any => ({ ...obj, ...(obj.Tags && { Tags: obj.Tags.map((item) => Tag.filterSensitiveLog(item)) }), @@ -1591,6 +1693,9 @@ export interface CreatePredictorResponse { } export namespace CreatePredictorResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreatePredictorResponse): any => ({ ...obj, }); @@ -1651,6 +1756,9 @@ export interface CreatePredictorBacktestExportJobRequest { } export namespace CreatePredictorBacktestExportJobRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreatePredictorBacktestExportJobRequest): any => ({ ...obj, ...(obj.Tags && { Tags: obj.Tags.map((item) => Tag.filterSensitiveLog(item)) }), @@ -1666,6 +1774,9 @@ export interface CreatePredictorBacktestExportJobResponse { } export namespace CreatePredictorBacktestExportJobResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreatePredictorBacktestExportJobResponse): any => ({ ...obj, }); @@ -1679,6 +1790,9 @@ export interface DeleteDatasetRequest { } export namespace DeleteDatasetRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteDatasetRequest): any => ({ ...obj, }); @@ -1692,6 +1806,9 @@ export interface DeleteDatasetGroupRequest { } export namespace DeleteDatasetGroupRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteDatasetGroupRequest): any => ({ ...obj, }); @@ -1705,6 +1822,9 @@ export interface DeleteDatasetImportJobRequest { } export namespace DeleteDatasetImportJobRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteDatasetImportJobRequest): any => ({ ...obj, }); @@ -1718,6 +1838,9 @@ export interface DeleteForecastRequest { } export namespace DeleteForecastRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteForecastRequest): any => ({ ...obj, }); @@ -1731,6 +1854,9 @@ export interface DeleteForecastExportJobRequest { } export namespace DeleteForecastExportJobRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteForecastExportJobRequest): any => ({ ...obj, }); @@ -1744,6 +1870,9 @@ export interface DeletePredictorRequest { } export namespace DeletePredictorRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeletePredictorRequest): any => ({ ...obj, }); @@ -1757,6 +1886,9 @@ export interface DeletePredictorBacktestExportJobRequest { } export namespace DeletePredictorBacktestExportJobRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeletePredictorBacktestExportJobRequest): any => ({ ...obj, }); @@ -1770,6 +1902,9 @@ export interface DescribeDatasetRequest { } export namespace DescribeDatasetRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeDatasetRequest): any => ({ ...obj, }); @@ -1870,6 +2005,9 @@ export interface DescribeDatasetResponse { } export namespace DescribeDatasetResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeDatasetResponse): any => ({ ...obj, }); @@ -1883,6 +2021,9 @@ export interface DescribeDatasetGroupRequest { } export namespace DescribeDatasetGroupRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeDatasetGroupRequest): any => ({ ...obj, }); @@ -1959,6 +2100,9 @@ export interface DescribeDatasetGroupResponse { } export namespace DescribeDatasetGroupResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeDatasetGroupResponse): any => ({ ...obj, }); @@ -1972,6 +2116,9 @@ export interface DescribeDatasetImportJobRequest { } export namespace DescribeDatasetImportJobRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeDatasetImportJobRequest): any => ({ ...obj, }); @@ -2024,6 +2171,9 @@ export interface Statistics { } export namespace Statistics { + /** + * @internal + */ export const filterSensitiveLog = (obj: Statistics): any => ({ ...obj, }); @@ -2172,6 +2322,9 @@ export interface DescribeDatasetImportJobResponse { } export namespace DescribeDatasetImportJobResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeDatasetImportJobResponse): any => ({ ...obj, }); @@ -2185,6 +2338,9 @@ export interface DescribeForecastRequest { } export namespace DescribeForecastRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeForecastRequest): any => ({ ...obj, }); @@ -2294,6 +2450,9 @@ export interface DescribeForecastResponse { } export namespace DescribeForecastResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeForecastResponse): any => ({ ...obj, }); @@ -2307,6 +2466,9 @@ export interface DescribeForecastExportJobRequest { } export namespace DescribeForecastExportJobRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeForecastExportJobRequest): any => ({ ...obj, }); @@ -2406,6 +2568,9 @@ export interface DescribeForecastExportJobResponse { } export namespace DescribeForecastExportJobResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeForecastExportJobResponse): any => ({ ...obj, }); @@ -2419,6 +2584,9 @@ export interface DescribePredictorRequest { } export namespace DescribePredictorRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribePredictorRequest): any => ({ ...obj, }); @@ -2468,6 +2636,9 @@ export interface TestWindowSummary { } export namespace TestWindowSummary { + /** + * @internal + */ export const filterSensitiveLog = (obj: TestWindowSummary): any => ({ ...obj, }); @@ -2491,6 +2662,9 @@ export interface PredictorExecution { } export namespace PredictorExecution { + /** + * @internal + */ export const filterSensitiveLog = (obj: PredictorExecution): any => ({ ...obj, }); @@ -2511,6 +2685,9 @@ export interface PredictorExecutionDetails { } export namespace PredictorExecutionDetails { + /** + * @internal + */ export const filterSensitiveLog = (obj: PredictorExecutionDetails): any => ({ ...obj, }); @@ -2684,6 +2861,9 @@ export interface DescribePredictorResponse { } export namespace DescribePredictorResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribePredictorResponse): any => ({ ...obj, }); @@ -2697,6 +2877,9 @@ export interface DescribePredictorBacktestExportJobRequest { } export namespace DescribePredictorBacktestExportJobRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribePredictorBacktestExportJobRequest): any => ({ ...obj, }); @@ -2793,6 +2976,9 @@ export interface DescribePredictorBacktestExportJobResponse { } export namespace DescribePredictorBacktestExportJobResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribePredictorBacktestExportJobResponse): any => ({ ...obj, }); @@ -2806,6 +2992,9 @@ export interface GetAccuracyMetricsRequest { } export namespace GetAccuracyMetricsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetAccuracyMetricsRequest): any => ({ ...obj, }); @@ -2846,6 +3035,9 @@ export interface ErrorMetric { } export namespace ErrorMetric { + /** + * @internal + */ export const filterSensitiveLog = (obj: ErrorMetric): any => ({ ...obj, }); @@ -2871,6 +3063,9 @@ export interface WeightedQuantileLoss { } export namespace WeightedQuantileLoss { + /** + * @internal + */ export const filterSensitiveLog = (obj: WeightedQuantileLoss): any => ({ ...obj, }); @@ -2904,6 +3099,9 @@ export interface Metrics { } export namespace Metrics { + /** + * @internal + */ export const filterSensitiveLog = (obj: Metrics): any => ({ ...obj, }); @@ -2954,6 +3152,9 @@ export interface WindowSummary { } export namespace WindowSummary { + /** + * @internal + */ export const filterSensitiveLog = (obj: WindowSummary): any => ({ ...obj, }); @@ -2978,6 +3179,9 @@ export interface EvaluationResult { } export namespace EvaluationResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: EvaluationResult): any => ({ ...obj, }); @@ -2991,6 +3195,9 @@ export interface GetAccuracyMetricsResponse { } export namespace GetAccuracyMetricsResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetAccuracyMetricsResponse): any => ({ ...obj, }); @@ -3006,6 +3213,9 @@ export interface InvalidNextTokenException extends __SmithyException, $MetadataB } export namespace InvalidNextTokenException { + /** + * @internal + */ export const filterSensitiveLog = (obj: InvalidNextTokenException): any => ({ ...obj, }); @@ -3026,6 +3236,9 @@ export interface ListDatasetGroupsRequest { } export namespace ListDatasetGroupsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListDatasetGroupsRequest): any => ({ ...obj, }); @@ -3061,6 +3274,9 @@ export interface DatasetGroupSummary { } export namespace DatasetGroupSummary { + /** + * @internal + */ export const filterSensitiveLog = (obj: DatasetGroupSummary): any => ({ ...obj, }); @@ -3080,6 +3296,9 @@ export interface ListDatasetGroupsResponse { } export namespace ListDatasetGroupsResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListDatasetGroupsResponse): any => ({ ...obj, }); @@ -3116,6 +3335,9 @@ export interface Filter { } export namespace Filter { + /** + * @internal + */ export const filterSensitiveLog = (obj: Filter): any => ({ ...obj, }); @@ -3170,6 +3392,9 @@ export interface ListDatasetImportJobsRequest { } export namespace ListDatasetImportJobsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListDatasetImportJobsRequest): any => ({ ...obj, }); @@ -3267,6 +3492,9 @@ export interface DatasetImportJobSummary { } export namespace DatasetImportJobSummary { + /** + * @internal + */ export const filterSensitiveLog = (obj: DatasetImportJobSummary): any => ({ ...obj, }); @@ -3286,6 +3514,9 @@ export interface ListDatasetImportJobsResponse { } export namespace ListDatasetImportJobsResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListDatasetImportJobsResponse): any => ({ ...obj, }); @@ -3306,6 +3537,9 @@ export interface ListDatasetsRequest { } export namespace ListDatasetsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListDatasetsRequest): any => ({ ...obj, }); @@ -3353,6 +3587,9 @@ export interface DatasetSummary { } export namespace DatasetSummary { + /** + * @internal + */ export const filterSensitiveLog = (obj: DatasetSummary): any => ({ ...obj, }); @@ -3372,6 +3609,9 @@ export interface ListDatasetsResponse { } export namespace ListDatasetsResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListDatasetsResponse): any => ({ ...obj, }); @@ -3427,6 +3667,9 @@ export interface ListForecastExportJobsRequest { } export namespace ListForecastExportJobsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListForecastExportJobsRequest): any => ({ ...obj, }); @@ -3526,6 +3769,9 @@ export interface ForecastExportJobSummary { } export namespace ForecastExportJobSummary { + /** + * @internal + */ export const filterSensitiveLog = (obj: ForecastExportJobSummary): any => ({ ...obj, }); @@ -3545,6 +3791,9 @@ export interface ListForecastExportJobsResponse { } export namespace ListForecastExportJobsResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListForecastExportJobsResponse): any => ({ ...obj, }); @@ -3598,6 +3847,9 @@ export interface ListForecastsRequest { } export namespace ListForecastsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListForecastsRequest): any => ({ ...obj, }); @@ -3703,6 +3955,9 @@ export interface ForecastSummary { } export namespace ForecastSummary { + /** + * @internal + */ export const filterSensitiveLog = (obj: ForecastSummary): any => ({ ...obj, }); @@ -3722,6 +3977,9 @@ export interface ListForecastsResponse { } export namespace ListForecastsResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListForecastsResponse): any => ({ ...obj, }); @@ -3771,6 +4029,9 @@ export interface ListPredictorBacktestExportJobsRequest { } export namespace ListPredictorBacktestExportJobsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListPredictorBacktestExportJobsRequest): any => ({ ...obj, }); @@ -3867,6 +4128,9 @@ export interface PredictorBacktestExportJobSummary { } export namespace PredictorBacktestExportJobSummary { + /** + * @internal + */ export const filterSensitiveLog = (obj: PredictorBacktestExportJobSummary): any => ({ ...obj, }); @@ -3887,6 +4151,9 @@ export interface ListPredictorBacktestExportJobsResponse { } export namespace ListPredictorBacktestExportJobsResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListPredictorBacktestExportJobsResponse): any => ({ ...obj, }); @@ -3940,6 +4207,9 @@ export interface ListPredictorsRequest { } export namespace ListPredictorsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListPredictorsRequest): any => ({ ...obj, }); @@ -4039,6 +4309,9 @@ export interface PredictorSummary { } export namespace PredictorSummary { + /** + * @internal + */ export const filterSensitiveLog = (obj: PredictorSummary): any => ({ ...obj, }); @@ -4058,6 +4331,9 @@ export interface ListPredictorsResponse { } export namespace ListPredictorsResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListPredictorsResponse): any => ({ ...obj, }); @@ -4071,6 +4347,9 @@ export interface ListTagsForResourceRequest { } export namespace ListTagsForResourceRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListTagsForResourceRequest): any => ({ ...obj, }); @@ -4084,6 +4363,9 @@ export interface ListTagsForResourceResponse { } export namespace ListTagsForResourceResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListTagsForResourceResponse): any => ({ ...obj, ...(obj.Tags && { Tags: obj.Tags.map((item) => Tag.filterSensitiveLog(item)) }), @@ -4101,6 +4383,9 @@ export interface StopResourceRequest { } export namespace StopResourceRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: StopResourceRequest): any => ({ ...obj, }); @@ -4143,6 +4428,9 @@ export interface TagResourceRequest { } export namespace TagResourceRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: TagResourceRequest): any => ({ ...obj, ...(obj.Tags && { Tags: obj.Tags.map((item) => Tag.filterSensitiveLog(item)) }), @@ -4152,6 +4440,9 @@ export namespace TagResourceRequest { export interface TagResourceResponse {} export namespace TagResourceResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: TagResourceResponse): any => ({ ...obj, }); @@ -4170,6 +4461,9 @@ export interface UntagResourceRequest { } export namespace UntagResourceRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: UntagResourceRequest): any => ({ ...obj, ...(obj.TagKeys && { TagKeys: SENSITIVE_STRING }), @@ -4179,6 +4473,9 @@ export namespace UntagResourceRequest { export interface UntagResourceResponse {} export namespace UntagResourceResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: UntagResourceResponse): any => ({ ...obj, }); @@ -4198,6 +4495,9 @@ export interface UpdateDatasetGroupRequest { } export namespace UpdateDatasetGroupRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateDatasetGroupRequest): any => ({ ...obj, }); @@ -4206,6 +4506,9 @@ export namespace UpdateDatasetGroupRequest { export interface UpdateDatasetGroupResponse {} export namespace UpdateDatasetGroupResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateDatasetGroupResponse): any => ({ ...obj, }); diff --git a/clients/client-forecastquery/commands/QueryForecastCommand.ts b/clients/client-forecastquery/commands/QueryForecastCommand.ts index c864361fc62c..fb4f26f62f3a 100644 --- a/clients/client-forecastquery/commands/QueryForecastCommand.ts +++ b/clients/client-forecastquery/commands/QueryForecastCommand.ts @@ -33,6 +33,20 @@ export interface QueryForecastCommandOutput extends QueryForecastResponse, __Met *

The forecasts generated by Amazon Forecast are in the same timezone as the dataset that was * used to create the predictor.

* + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ForecastqueryClient, QueryForecastCommand } from "@aws-sdk/client-forecastquery"; // ES Modules import + * // const { ForecastqueryClient, QueryForecastCommand } = require("@aws-sdk/client-forecastquery"); // CommonJS import + * const client = new ForecastqueryClient(config); + * const command = new QueryForecastCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link QueryForecastCommandInput} for command's `input` shape. + * @see {@link QueryForecastCommandOutput} for command's `response` shape. + * @see {@link ForecastqueryClientResolvedConfig | config} for command's `input` shape. + * */ export class QueryForecastCommand extends $Command< QueryForecastCommandInput, diff --git a/clients/client-forecastquery/models/models_0.ts b/clients/client-forecastquery/models/models_0.ts index a2bc7b75d720..376e8cbe6033 100644 --- a/clients/client-forecastquery/models/models_0.ts +++ b/clients/client-forecastquery/models/models_0.ts @@ -11,6 +11,9 @@ export interface InvalidInputException extends __SmithyException, $MetadataBeare } export namespace InvalidInputException { + /** + * @internal + */ export const filterSensitiveLog = (obj: InvalidInputException): any => ({ ...obj, }); @@ -26,6 +29,9 @@ export interface InvalidNextTokenException extends __SmithyException, $MetadataB } export namespace InvalidNextTokenException { + /** + * @internal + */ export const filterSensitiveLog = (obj: InvalidNextTokenException): any => ({ ...obj, }); @@ -41,6 +47,9 @@ export interface LimitExceededException extends __SmithyException, $MetadataBear } export namespace LimitExceededException { + /** + * @internal + */ export const filterSensitiveLog = (obj: LimitExceededException): any => ({ ...obj, }); @@ -86,6 +95,9 @@ export interface QueryForecastRequest { } export namespace QueryForecastRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: QueryForecastRequest): any => ({ ...obj, }); @@ -108,6 +120,9 @@ export interface DataPoint { } export namespace DataPoint { + /** + * @internal + */ export const filterSensitiveLog = (obj: DataPoint): any => ({ ...obj, }); @@ -137,6 +152,9 @@ export interface Forecast { } export namespace Forecast { + /** + * @internal + */ export const filterSensitiveLog = (obj: Forecast): any => ({ ...obj, }); @@ -150,6 +168,9 @@ export interface QueryForecastResponse { } export namespace QueryForecastResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: QueryForecastResponse): any => ({ ...obj, }); @@ -165,6 +186,9 @@ export interface ResourceInUseException extends __SmithyException, $MetadataBear } export namespace ResourceInUseException { + /** + * @internal + */ export const filterSensitiveLog = (obj: ResourceInUseException): any => ({ ...obj, }); @@ -181,6 +205,9 @@ export interface ResourceNotFoundException extends __SmithyException, $MetadataB } export namespace ResourceNotFoundException { + /** + * @internal + */ export const filterSensitiveLog = (obj: ResourceNotFoundException): any => ({ ...obj, }); diff --git a/clients/client-frauddetector/commands/BatchCreateVariableCommand.ts b/clients/client-frauddetector/commands/BatchCreateVariableCommand.ts index 21343ae4fcb5..f90e91b55fa2 100644 --- a/clients/client-frauddetector/commands/BatchCreateVariableCommand.ts +++ b/clients/client-frauddetector/commands/BatchCreateVariableCommand.ts @@ -22,6 +22,20 @@ export interface BatchCreateVariableCommandOutput extends BatchCreateVariableRes /** *

Creates a batch of variables.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { FraudDetectorClient, BatchCreateVariableCommand } from "@aws-sdk/client-frauddetector"; // ES Modules import + * // const { FraudDetectorClient, BatchCreateVariableCommand } = require("@aws-sdk/client-frauddetector"); // CommonJS import + * const client = new FraudDetectorClient(config); + * const command = new BatchCreateVariableCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link BatchCreateVariableCommandInput} for command's `input` shape. + * @see {@link BatchCreateVariableCommandOutput} for command's `response` shape. + * @see {@link FraudDetectorClientResolvedConfig | config} for command's `input` shape. + * */ export class BatchCreateVariableCommand extends $Command< BatchCreateVariableCommandInput, diff --git a/clients/client-frauddetector/commands/BatchGetVariableCommand.ts b/clients/client-frauddetector/commands/BatchGetVariableCommand.ts index c364bee8de15..6ccb89432e7e 100644 --- a/clients/client-frauddetector/commands/BatchGetVariableCommand.ts +++ b/clients/client-frauddetector/commands/BatchGetVariableCommand.ts @@ -22,6 +22,20 @@ export interface BatchGetVariableCommandOutput extends BatchGetVariableResult, _ /** *

Gets a batch of variables.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { FraudDetectorClient, BatchGetVariableCommand } from "@aws-sdk/client-frauddetector"; // ES Modules import + * // const { FraudDetectorClient, BatchGetVariableCommand } = require("@aws-sdk/client-frauddetector"); // CommonJS import + * const client = new FraudDetectorClient(config); + * const command = new BatchGetVariableCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link BatchGetVariableCommandInput} for command's `input` shape. + * @see {@link BatchGetVariableCommandOutput} for command's `response` shape. + * @see {@link FraudDetectorClientResolvedConfig | config} for command's `input` shape. + * */ export class BatchGetVariableCommand extends $Command< BatchGetVariableCommandInput, diff --git a/clients/client-frauddetector/commands/CancelBatchPredictionJobCommand.ts b/clients/client-frauddetector/commands/CancelBatchPredictionJobCommand.ts index 8ef9c834e3fc..f1f57f9b5d6d 100644 --- a/clients/client-frauddetector/commands/CancelBatchPredictionJobCommand.ts +++ b/clients/client-frauddetector/commands/CancelBatchPredictionJobCommand.ts @@ -22,6 +22,20 @@ export interface CancelBatchPredictionJobCommandOutput extends CancelBatchPredic /** *

Cancels the specified batch prediction job.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { FraudDetectorClient, CancelBatchPredictionJobCommand } from "@aws-sdk/client-frauddetector"; // ES Modules import + * // const { FraudDetectorClient, CancelBatchPredictionJobCommand } = require("@aws-sdk/client-frauddetector"); // CommonJS import + * const client = new FraudDetectorClient(config); + * const command = new CancelBatchPredictionJobCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CancelBatchPredictionJobCommandInput} for command's `input` shape. + * @see {@link CancelBatchPredictionJobCommandOutput} for command's `response` shape. + * @see {@link FraudDetectorClientResolvedConfig | config} for command's `input` shape. + * */ export class CancelBatchPredictionJobCommand extends $Command< CancelBatchPredictionJobCommandInput, diff --git a/clients/client-frauddetector/commands/CreateBatchPredictionJobCommand.ts b/clients/client-frauddetector/commands/CreateBatchPredictionJobCommand.ts index a696bb941b53..6a62c424655f 100644 --- a/clients/client-frauddetector/commands/CreateBatchPredictionJobCommand.ts +++ b/clients/client-frauddetector/commands/CreateBatchPredictionJobCommand.ts @@ -22,6 +22,20 @@ export interface CreateBatchPredictionJobCommandOutput extends CreateBatchPredic /** *

Creates a batch prediction job.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { FraudDetectorClient, CreateBatchPredictionJobCommand } from "@aws-sdk/client-frauddetector"; // ES Modules import + * // const { FraudDetectorClient, CreateBatchPredictionJobCommand } = require("@aws-sdk/client-frauddetector"); // CommonJS import + * const client = new FraudDetectorClient(config); + * const command = new CreateBatchPredictionJobCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreateBatchPredictionJobCommandInput} for command's `input` shape. + * @see {@link CreateBatchPredictionJobCommandOutput} for command's `response` shape. + * @see {@link FraudDetectorClientResolvedConfig | config} for command's `input` shape. + * */ export class CreateBatchPredictionJobCommand extends $Command< CreateBatchPredictionJobCommandInput, diff --git a/clients/client-frauddetector/commands/CreateDetectorVersionCommand.ts b/clients/client-frauddetector/commands/CreateDetectorVersionCommand.ts index a62e3ec6b546..45d95e463f7b 100644 --- a/clients/client-frauddetector/commands/CreateDetectorVersionCommand.ts +++ b/clients/client-frauddetector/commands/CreateDetectorVersionCommand.ts @@ -22,6 +22,20 @@ export interface CreateDetectorVersionCommandOutput extends CreateDetectorVersio /** *

Creates a detector version. The detector version starts in a DRAFT status.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { FraudDetectorClient, CreateDetectorVersionCommand } from "@aws-sdk/client-frauddetector"; // ES Modules import + * // const { FraudDetectorClient, CreateDetectorVersionCommand } = require("@aws-sdk/client-frauddetector"); // CommonJS import + * const client = new FraudDetectorClient(config); + * const command = new CreateDetectorVersionCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreateDetectorVersionCommandInput} for command's `input` shape. + * @see {@link CreateDetectorVersionCommandOutput} for command's `response` shape. + * @see {@link FraudDetectorClientResolvedConfig | config} for command's `input` shape. + * */ export class CreateDetectorVersionCommand extends $Command< CreateDetectorVersionCommandInput, diff --git a/clients/client-frauddetector/commands/CreateModelCommand.ts b/clients/client-frauddetector/commands/CreateModelCommand.ts index d05583d7617e..7474111892b0 100644 --- a/clients/client-frauddetector/commands/CreateModelCommand.ts +++ b/clients/client-frauddetector/commands/CreateModelCommand.ts @@ -22,6 +22,20 @@ export interface CreateModelCommandOutput extends CreateModelResult, __MetadataB /** *

Creates a model using the specified model type.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { FraudDetectorClient, CreateModelCommand } from "@aws-sdk/client-frauddetector"; // ES Modules import + * // const { FraudDetectorClient, CreateModelCommand } = require("@aws-sdk/client-frauddetector"); // CommonJS import + * const client = new FraudDetectorClient(config); + * const command = new CreateModelCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreateModelCommandInput} for command's `input` shape. + * @see {@link CreateModelCommandOutput} for command's `response` shape. + * @see {@link FraudDetectorClientResolvedConfig | config} for command's `input` shape. + * */ export class CreateModelCommand extends $Command< CreateModelCommandInput, diff --git a/clients/client-frauddetector/commands/CreateModelVersionCommand.ts b/clients/client-frauddetector/commands/CreateModelVersionCommand.ts index 2a781ca3b227..501f2cc2b2b2 100644 --- a/clients/client-frauddetector/commands/CreateModelVersionCommand.ts +++ b/clients/client-frauddetector/commands/CreateModelVersionCommand.ts @@ -23,6 +23,20 @@ export interface CreateModelVersionCommandOutput extends CreateModelVersionResul /** *

Creates a version of the model using the specified model type and model id. *

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { FraudDetectorClient, CreateModelVersionCommand } from "@aws-sdk/client-frauddetector"; // ES Modules import + * // const { FraudDetectorClient, CreateModelVersionCommand } = require("@aws-sdk/client-frauddetector"); // CommonJS import + * const client = new FraudDetectorClient(config); + * const command = new CreateModelVersionCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreateModelVersionCommandInput} for command's `input` shape. + * @see {@link CreateModelVersionCommandOutput} for command's `response` shape. + * @see {@link FraudDetectorClientResolvedConfig | config} for command's `input` shape. + * */ export class CreateModelVersionCommand extends $Command< CreateModelVersionCommandInput, diff --git a/clients/client-frauddetector/commands/CreateRuleCommand.ts b/clients/client-frauddetector/commands/CreateRuleCommand.ts index c6b4a281f106..596662651f39 100644 --- a/clients/client-frauddetector/commands/CreateRuleCommand.ts +++ b/clients/client-frauddetector/commands/CreateRuleCommand.ts @@ -22,6 +22,20 @@ export interface CreateRuleCommandOutput extends CreateRuleResult, __MetadataBea /** *

Creates a rule for use with the specified detector.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { FraudDetectorClient, CreateRuleCommand } from "@aws-sdk/client-frauddetector"; // ES Modules import + * // const { FraudDetectorClient, CreateRuleCommand } = require("@aws-sdk/client-frauddetector"); // CommonJS import + * const client = new FraudDetectorClient(config); + * const command = new CreateRuleCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreateRuleCommandInput} for command's `input` shape. + * @see {@link CreateRuleCommandOutput} for command's `response` shape. + * @see {@link FraudDetectorClientResolvedConfig | config} for command's `input` shape. + * */ export class CreateRuleCommand extends $Command< CreateRuleCommandInput, diff --git a/clients/client-frauddetector/commands/CreateVariableCommand.ts b/clients/client-frauddetector/commands/CreateVariableCommand.ts index 3e781bdcbce6..bcdb62dddee1 100644 --- a/clients/client-frauddetector/commands/CreateVariableCommand.ts +++ b/clients/client-frauddetector/commands/CreateVariableCommand.ts @@ -22,6 +22,20 @@ export interface CreateVariableCommandOutput extends CreateVariableResult, __Met /** *

Creates a variable.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { FraudDetectorClient, CreateVariableCommand } from "@aws-sdk/client-frauddetector"; // ES Modules import + * // const { FraudDetectorClient, CreateVariableCommand } = require("@aws-sdk/client-frauddetector"); // CommonJS import + * const client = new FraudDetectorClient(config); + * const command = new CreateVariableCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreateVariableCommandInput} for command's `input` shape. + * @see {@link CreateVariableCommandOutput} for command's `response` shape. + * @see {@link FraudDetectorClientResolvedConfig | config} for command's `input` shape. + * */ export class CreateVariableCommand extends $Command< CreateVariableCommandInput, diff --git a/clients/client-frauddetector/commands/DeleteBatchPredictionJobCommand.ts b/clients/client-frauddetector/commands/DeleteBatchPredictionJobCommand.ts index e06c288eed0f..bd5397c8131e 100644 --- a/clients/client-frauddetector/commands/DeleteBatchPredictionJobCommand.ts +++ b/clients/client-frauddetector/commands/DeleteBatchPredictionJobCommand.ts @@ -22,6 +22,20 @@ export interface DeleteBatchPredictionJobCommandOutput extends DeleteBatchPredic /** *

Deletes a batch prediction job.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { FraudDetectorClient, DeleteBatchPredictionJobCommand } from "@aws-sdk/client-frauddetector"; // ES Modules import + * // const { FraudDetectorClient, DeleteBatchPredictionJobCommand } = require("@aws-sdk/client-frauddetector"); // CommonJS import + * const client = new FraudDetectorClient(config); + * const command = new DeleteBatchPredictionJobCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteBatchPredictionJobCommandInput} for command's `input` shape. + * @see {@link DeleteBatchPredictionJobCommandOutput} for command's `response` shape. + * @see {@link FraudDetectorClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteBatchPredictionJobCommand extends $Command< DeleteBatchPredictionJobCommandInput, diff --git a/clients/client-frauddetector/commands/DeleteDetectorCommand.ts b/clients/client-frauddetector/commands/DeleteDetectorCommand.ts index c1b6a42c4684..081514d5ff7f 100644 --- a/clients/client-frauddetector/commands/DeleteDetectorCommand.ts +++ b/clients/client-frauddetector/commands/DeleteDetectorCommand.ts @@ -23,6 +23,20 @@ export interface DeleteDetectorCommandOutput extends DeleteDetectorResult, __Met /** *

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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { FraudDetectorClient, DeleteDetectorCommand } from "@aws-sdk/client-frauddetector"; // ES Modules import + * // const { FraudDetectorClient, DeleteDetectorCommand } = require("@aws-sdk/client-frauddetector"); // CommonJS import + * const client = new FraudDetectorClient(config); + * const command = new DeleteDetectorCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteDetectorCommandInput} for command's `input` shape. + * @see {@link DeleteDetectorCommandOutput} for command's `response` shape. + * @see {@link FraudDetectorClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteDetectorCommand extends $Command< DeleteDetectorCommandInput, diff --git a/clients/client-frauddetector/commands/DeleteDetectorVersionCommand.ts b/clients/client-frauddetector/commands/DeleteDetectorVersionCommand.ts index 7822bd38f52a..808ccd7fa5eb 100644 --- a/clients/client-frauddetector/commands/DeleteDetectorVersionCommand.ts +++ b/clients/client-frauddetector/commands/DeleteDetectorVersionCommand.ts @@ -23,6 +23,20 @@ export interface DeleteDetectorVersionCommandOutput extends DeleteDetectorVersio /** *

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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { FraudDetectorClient, DeleteDetectorVersionCommand } from "@aws-sdk/client-frauddetector"; // ES Modules import + * // const { FraudDetectorClient, DeleteDetectorVersionCommand } = require("@aws-sdk/client-frauddetector"); // CommonJS import + * const client = new FraudDetectorClient(config); + * const command = new DeleteDetectorVersionCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteDetectorVersionCommandInput} for command's `input` shape. + * @see {@link DeleteDetectorVersionCommandOutput} for command's `response` shape. + * @see {@link FraudDetectorClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteDetectorVersionCommand extends $Command< DeleteDetectorVersionCommandInput, diff --git a/clients/client-frauddetector/commands/DeleteEntityTypeCommand.ts b/clients/client-frauddetector/commands/DeleteEntityTypeCommand.ts index 30b66f2d42f6..8fe4b2e3733d 100644 --- a/clients/client-frauddetector/commands/DeleteEntityTypeCommand.ts +++ b/clients/client-frauddetector/commands/DeleteEntityTypeCommand.ts @@ -24,6 +24,20 @@ export interface DeleteEntityTypeCommandOutput extends DeleteEntityTypeResult, _ *

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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { FraudDetectorClient, DeleteEntityTypeCommand } from "@aws-sdk/client-frauddetector"; // ES Modules import + * // const { FraudDetectorClient, DeleteEntityTypeCommand } = require("@aws-sdk/client-frauddetector"); // CommonJS import + * const client = new FraudDetectorClient(config); + * const command = new DeleteEntityTypeCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteEntityTypeCommandInput} for command's `input` shape. + * @see {@link DeleteEntityTypeCommandOutput} for command's `response` shape. + * @see {@link FraudDetectorClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteEntityTypeCommand extends $Command< DeleteEntityTypeCommandInput, diff --git a/clients/client-frauddetector/commands/DeleteEventCommand.ts b/clients/client-frauddetector/commands/DeleteEventCommand.ts index 7fc3f6771cd4..1f000bb8acca 100644 --- a/clients/client-frauddetector/commands/DeleteEventCommand.ts +++ b/clients/client-frauddetector/commands/DeleteEventCommand.ts @@ -23,6 +23,20 @@ export interface DeleteEventCommandOutput extends DeleteEventResult, __MetadataB /** *

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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { FraudDetectorClient, DeleteEventCommand } from "@aws-sdk/client-frauddetector"; // ES Modules import + * // const { FraudDetectorClient, DeleteEventCommand } = require("@aws-sdk/client-frauddetector"); // CommonJS import + * const client = new FraudDetectorClient(config); + * const command = new DeleteEventCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteEventCommandInput} for command's `input` shape. + * @see {@link DeleteEventCommandOutput} for command's `response` shape. + * @see {@link FraudDetectorClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteEventCommand extends $Command< DeleteEventCommandInput, diff --git a/clients/client-frauddetector/commands/DeleteEventTypeCommand.ts b/clients/client-frauddetector/commands/DeleteEventTypeCommand.ts index b9f1eb985bb5..5c31d5c9597e 100644 --- a/clients/client-frauddetector/commands/DeleteEventTypeCommand.ts +++ b/clients/client-frauddetector/commands/DeleteEventTypeCommand.ts @@ -24,6 +24,20 @@ export interface DeleteEventTypeCommandOutput extends DeleteEventTypeResult, __M *

Deletes an event type.

*

You cannot delete an event type that is used in a detector or a model.

*

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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { FraudDetectorClient, DeleteEventTypeCommand } from "@aws-sdk/client-frauddetector"; // ES Modules import + * // const { FraudDetectorClient, DeleteEventTypeCommand } = require("@aws-sdk/client-frauddetector"); // CommonJS import + * const client = new FraudDetectorClient(config); + * const command = new DeleteEventTypeCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteEventTypeCommandInput} for command's `input` shape. + * @see {@link DeleteEventTypeCommandOutput} for command's `response` shape. + * @see {@link FraudDetectorClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteEventTypeCommand extends $Command< DeleteEventTypeCommandInput, diff --git a/clients/client-frauddetector/commands/DeleteExternalModelCommand.ts b/clients/client-frauddetector/commands/DeleteExternalModelCommand.ts index d4ea1e47d2a0..28667124fe4e 100644 --- a/clients/client-frauddetector/commands/DeleteExternalModelCommand.ts +++ b/clients/client-frauddetector/commands/DeleteExternalModelCommand.ts @@ -23,6 +23,20 @@ export interface DeleteExternalModelCommandOutput extends DeleteExternalModelRes /** *

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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { FraudDetectorClient, DeleteExternalModelCommand } from "@aws-sdk/client-frauddetector"; // ES Modules import + * // const { FraudDetectorClient, DeleteExternalModelCommand } = require("@aws-sdk/client-frauddetector"); // CommonJS import + * const client = new FraudDetectorClient(config); + * const command = new DeleteExternalModelCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteExternalModelCommandInput} for command's `input` shape. + * @see {@link DeleteExternalModelCommandOutput} for command's `response` shape. + * @see {@link FraudDetectorClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteExternalModelCommand extends $Command< DeleteExternalModelCommandInput, diff --git a/clients/client-frauddetector/commands/DeleteLabelCommand.ts b/clients/client-frauddetector/commands/DeleteLabelCommand.ts index 1019836e4a1e..ff40a266ef9e 100644 --- a/clients/client-frauddetector/commands/DeleteLabelCommand.ts +++ b/clients/client-frauddetector/commands/DeleteLabelCommand.ts @@ -26,6 +26,20 @@ export interface DeleteLabelCommandOutput extends DeleteLabelResult, __MetadataB *

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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { FraudDetectorClient, DeleteLabelCommand } from "@aws-sdk/client-frauddetector"; // ES Modules import + * // const { FraudDetectorClient, DeleteLabelCommand } = require("@aws-sdk/client-frauddetector"); // CommonJS import + * const client = new FraudDetectorClient(config); + * const command = new DeleteLabelCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteLabelCommandInput} for command's `input` shape. + * @see {@link DeleteLabelCommandOutput} for command's `response` shape. + * @see {@link FraudDetectorClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteLabelCommand extends $Command< DeleteLabelCommandInput, diff --git a/clients/client-frauddetector/commands/DeleteModelCommand.ts b/clients/client-frauddetector/commands/DeleteModelCommand.ts index fc655abee208..9f0733254e9e 100644 --- a/clients/client-frauddetector/commands/DeleteModelCommand.ts +++ b/clients/client-frauddetector/commands/DeleteModelCommand.ts @@ -24,6 +24,20 @@ export interface DeleteModelCommandOutput extends DeleteModelResult, __MetadataB *

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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { FraudDetectorClient, DeleteModelCommand } from "@aws-sdk/client-frauddetector"; // ES Modules import + * // const { FraudDetectorClient, DeleteModelCommand } = require("@aws-sdk/client-frauddetector"); // CommonJS import + * const client = new FraudDetectorClient(config); + * const command = new DeleteModelCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteModelCommandInput} for command's `input` shape. + * @see {@link DeleteModelCommandOutput} for command's `response` shape. + * @see {@link FraudDetectorClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteModelCommand extends $Command< DeleteModelCommandInput, diff --git a/clients/client-frauddetector/commands/DeleteModelVersionCommand.ts b/clients/client-frauddetector/commands/DeleteModelVersionCommand.ts index 20d53c86645b..70b532d27945 100644 --- a/clients/client-frauddetector/commands/DeleteModelVersionCommand.ts +++ b/clients/client-frauddetector/commands/DeleteModelVersionCommand.ts @@ -24,6 +24,20 @@ export interface DeleteModelVersionCommandOutput extends DeleteModelVersionResul *

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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { FraudDetectorClient, DeleteModelVersionCommand } from "@aws-sdk/client-frauddetector"; // ES Modules import + * // const { FraudDetectorClient, DeleteModelVersionCommand } = require("@aws-sdk/client-frauddetector"); // CommonJS import + * const client = new FraudDetectorClient(config); + * const command = new DeleteModelVersionCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteModelVersionCommandInput} for command's `input` shape. + * @see {@link DeleteModelVersionCommandOutput} for command's `response` shape. + * @see {@link FraudDetectorClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteModelVersionCommand extends $Command< DeleteModelVersionCommandInput, diff --git a/clients/client-frauddetector/commands/DeleteOutcomeCommand.ts b/clients/client-frauddetector/commands/DeleteOutcomeCommand.ts index 53647a421821..e00da5831f72 100644 --- a/clients/client-frauddetector/commands/DeleteOutcomeCommand.ts +++ b/clients/client-frauddetector/commands/DeleteOutcomeCommand.ts @@ -24,6 +24,20 @@ export interface DeleteOutcomeCommandOutput extends DeleteOutcomeResult, __Metad *

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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { FraudDetectorClient, DeleteOutcomeCommand } from "@aws-sdk/client-frauddetector"; // ES Modules import + * // const { FraudDetectorClient, DeleteOutcomeCommand } = require("@aws-sdk/client-frauddetector"); // CommonJS import + * const client = new FraudDetectorClient(config); + * const command = new DeleteOutcomeCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteOutcomeCommandInput} for command's `input` shape. + * @see {@link DeleteOutcomeCommandOutput} for command's `response` shape. + * @see {@link FraudDetectorClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteOutcomeCommand extends $Command< DeleteOutcomeCommandInput, diff --git a/clients/client-frauddetector/commands/DeleteRuleCommand.ts b/clients/client-frauddetector/commands/DeleteRuleCommand.ts index 550fc8e07d15..52b14daf1a6d 100644 --- a/clients/client-frauddetector/commands/DeleteRuleCommand.ts +++ b/clients/client-frauddetector/commands/DeleteRuleCommand.ts @@ -23,6 +23,20 @@ export interface DeleteRuleCommandOutput extends DeleteRuleResult, __MetadataBea /** *

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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { FraudDetectorClient, DeleteRuleCommand } from "@aws-sdk/client-frauddetector"; // ES Modules import + * // const { FraudDetectorClient, DeleteRuleCommand } = require("@aws-sdk/client-frauddetector"); // CommonJS import + * const client = new FraudDetectorClient(config); + * const command = new DeleteRuleCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteRuleCommandInput} for command's `input` shape. + * @see {@link DeleteRuleCommandOutput} for command's `response` shape. + * @see {@link FraudDetectorClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteRuleCommand extends $Command< DeleteRuleCommandInput, diff --git a/clients/client-frauddetector/commands/DeleteVariableCommand.ts b/clients/client-frauddetector/commands/DeleteVariableCommand.ts index 949ad94db049..976b06b7063a 100644 --- a/clients/client-frauddetector/commands/DeleteVariableCommand.ts +++ b/clients/client-frauddetector/commands/DeleteVariableCommand.ts @@ -25,6 +25,20 @@ export interface DeleteVariableCommandOutput extends DeleteVariableResult, __Met *

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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { FraudDetectorClient, DeleteVariableCommand } from "@aws-sdk/client-frauddetector"; // ES Modules import + * // const { FraudDetectorClient, DeleteVariableCommand } = require("@aws-sdk/client-frauddetector"); // CommonJS import + * const client = new FraudDetectorClient(config); + * const command = new DeleteVariableCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteVariableCommandInput} for command's `input` shape. + * @see {@link DeleteVariableCommandOutput} for command's `response` shape. + * @see {@link FraudDetectorClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteVariableCommand extends $Command< DeleteVariableCommandInput, diff --git a/clients/client-frauddetector/commands/DescribeDetectorCommand.ts b/clients/client-frauddetector/commands/DescribeDetectorCommand.ts index 30e95243a579..263ad166909e 100644 --- a/clients/client-frauddetector/commands/DescribeDetectorCommand.ts +++ b/clients/client-frauddetector/commands/DescribeDetectorCommand.ts @@ -22,6 +22,20 @@ export interface DescribeDetectorCommandOutput extends DescribeDetectorResult, _ /** *

Gets all versions for a specified detector.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { FraudDetectorClient, DescribeDetectorCommand } from "@aws-sdk/client-frauddetector"; // ES Modules import + * // const { FraudDetectorClient, DescribeDetectorCommand } = require("@aws-sdk/client-frauddetector"); // CommonJS import + * const client = new FraudDetectorClient(config); + * const command = new DescribeDetectorCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeDetectorCommandInput} for command's `input` shape. + * @see {@link DescribeDetectorCommandOutput} for command's `response` shape. + * @see {@link FraudDetectorClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeDetectorCommand extends $Command< DescribeDetectorCommandInput, diff --git a/clients/client-frauddetector/commands/DescribeModelVersionsCommand.ts b/clients/client-frauddetector/commands/DescribeModelVersionsCommand.ts index 1d987d1d5ea4..40bd5fe874a4 100644 --- a/clients/client-frauddetector/commands/DescribeModelVersionsCommand.ts +++ b/clients/client-frauddetector/commands/DescribeModelVersionsCommand.ts @@ -22,6 +22,20 @@ export interface DescribeModelVersionsCommandOutput extends DescribeModelVersion /** *

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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { FraudDetectorClient, DescribeModelVersionsCommand } from "@aws-sdk/client-frauddetector"; // ES Modules import + * // const { FraudDetectorClient, DescribeModelVersionsCommand } = require("@aws-sdk/client-frauddetector"); // CommonJS import + * const client = new FraudDetectorClient(config); + * const command = new DescribeModelVersionsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeModelVersionsCommandInput} for command's `input` shape. + * @see {@link DescribeModelVersionsCommandOutput} for command's `response` shape. + * @see {@link FraudDetectorClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeModelVersionsCommand extends $Command< DescribeModelVersionsCommandInput, diff --git a/clients/client-frauddetector/commands/GetBatchPredictionJobsCommand.ts b/clients/client-frauddetector/commands/GetBatchPredictionJobsCommand.ts index b1b79ebcc2a9..6f4d3d607eac 100644 --- a/clients/client-frauddetector/commands/GetBatchPredictionJobsCommand.ts +++ b/clients/client-frauddetector/commands/GetBatchPredictionJobsCommand.ts @@ -22,6 +22,20 @@ export interface GetBatchPredictionJobsCommandOutput extends GetBatchPredictionJ /** *

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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { FraudDetectorClient, GetBatchPredictionJobsCommand } from "@aws-sdk/client-frauddetector"; // ES Modules import + * // const { FraudDetectorClient, GetBatchPredictionJobsCommand } = require("@aws-sdk/client-frauddetector"); // CommonJS import + * const client = new FraudDetectorClient(config); + * const command = new GetBatchPredictionJobsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetBatchPredictionJobsCommandInput} for command's `input` shape. + * @see {@link GetBatchPredictionJobsCommandOutput} for command's `response` shape. + * @see {@link FraudDetectorClientResolvedConfig | config} for command's `input` shape. + * */ export class GetBatchPredictionJobsCommand extends $Command< GetBatchPredictionJobsCommandInput, diff --git a/clients/client-frauddetector/commands/GetDetectorVersionCommand.ts b/clients/client-frauddetector/commands/GetDetectorVersionCommand.ts index e9e058be9902..20936891d759 100644 --- a/clients/client-frauddetector/commands/GetDetectorVersionCommand.ts +++ b/clients/client-frauddetector/commands/GetDetectorVersionCommand.ts @@ -22,6 +22,20 @@ export interface GetDetectorVersionCommandOutput extends GetDetectorVersionResul /** *

Gets a particular detector version.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { FraudDetectorClient, GetDetectorVersionCommand } from "@aws-sdk/client-frauddetector"; // ES Modules import + * // const { FraudDetectorClient, GetDetectorVersionCommand } = require("@aws-sdk/client-frauddetector"); // CommonJS import + * const client = new FraudDetectorClient(config); + * const command = new GetDetectorVersionCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetDetectorVersionCommandInput} for command's `input` shape. + * @see {@link GetDetectorVersionCommandOutput} for command's `response` shape. + * @see {@link FraudDetectorClientResolvedConfig | config} for command's `input` shape. + * */ export class GetDetectorVersionCommand extends $Command< GetDetectorVersionCommandInput, diff --git a/clients/client-frauddetector/commands/GetDetectorsCommand.ts b/clients/client-frauddetector/commands/GetDetectorsCommand.ts index 87429a4962d1..4326198664a4 100644 --- a/clients/client-frauddetector/commands/GetDetectorsCommand.ts +++ b/clients/client-frauddetector/commands/GetDetectorsCommand.ts @@ -27,6 +27,20 @@ export interface GetDetectorsCommandOutput extends GetDetectorsResult, __Metadat * 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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { FraudDetectorClient, GetDetectorsCommand } from "@aws-sdk/client-frauddetector"; // ES Modules import + * // const { FraudDetectorClient, GetDetectorsCommand } = require("@aws-sdk/client-frauddetector"); // CommonJS import + * const client = new FraudDetectorClient(config); + * const command = new GetDetectorsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetDetectorsCommandInput} for command's `input` shape. + * @see {@link GetDetectorsCommandOutput} for command's `response` shape. + * @see {@link FraudDetectorClientResolvedConfig | config} for command's `input` shape. + * */ export class GetDetectorsCommand extends $Command< GetDetectorsCommandInput, diff --git a/clients/client-frauddetector/commands/GetEntityTypesCommand.ts b/clients/client-frauddetector/commands/GetEntityTypesCommand.ts index e862d82f6f33..074464e417a3 100644 --- a/clients/client-frauddetector/commands/GetEntityTypesCommand.ts +++ b/clients/client-frauddetector/commands/GetEntityTypesCommand.ts @@ -27,6 +27,20 @@ export interface GetEntityTypesCommandOutput extends GetEntityTypesResult, __Met * 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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { FraudDetectorClient, GetEntityTypesCommand } from "@aws-sdk/client-frauddetector"; // ES Modules import + * // const { FraudDetectorClient, GetEntityTypesCommand } = require("@aws-sdk/client-frauddetector"); // CommonJS import + * const client = new FraudDetectorClient(config); + * const command = new GetEntityTypesCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetEntityTypesCommandInput} for command's `input` shape. + * @see {@link GetEntityTypesCommandOutput} for command's `response` shape. + * @see {@link FraudDetectorClientResolvedConfig | config} for command's `input` shape. + * */ export class GetEntityTypesCommand extends $Command< GetEntityTypesCommandInput, diff --git a/clients/client-frauddetector/commands/GetEventPredictionCommand.ts b/clients/client-frauddetector/commands/GetEventPredictionCommand.ts index 8fdb16488c9d..4c7bfebde224 100644 --- a/clients/client-frauddetector/commands/GetEventPredictionCommand.ts +++ b/clients/client-frauddetector/commands/GetEventPredictionCommand.ts @@ -22,6 +22,20 @@ export interface GetEventPredictionCommandOutput extends GetEventPredictionResul /** *

Evaluates an event against a detector version. If a version ID is not provided, the detector’s (ACTIVE) version is used.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { FraudDetectorClient, GetEventPredictionCommand } from "@aws-sdk/client-frauddetector"; // ES Modules import + * // const { FraudDetectorClient, GetEventPredictionCommand } = require("@aws-sdk/client-frauddetector"); // CommonJS import + * const client = new FraudDetectorClient(config); + * const command = new GetEventPredictionCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetEventPredictionCommandInput} for command's `input` shape. + * @see {@link GetEventPredictionCommandOutput} for command's `response` shape. + * @see {@link FraudDetectorClientResolvedConfig | config} for command's `input` shape. + * */ export class GetEventPredictionCommand extends $Command< GetEventPredictionCommandInput, diff --git a/clients/client-frauddetector/commands/GetEventTypesCommand.ts b/clients/client-frauddetector/commands/GetEventTypesCommand.ts index 32558a6247ab..195108ca4f5e 100644 --- a/clients/client-frauddetector/commands/GetEventTypesCommand.ts +++ b/clients/client-frauddetector/commands/GetEventTypesCommand.ts @@ -27,6 +27,20 @@ export interface GetEventTypesCommandOutput extends GetEventTypesResult, __Metad * 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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { FraudDetectorClient, GetEventTypesCommand } from "@aws-sdk/client-frauddetector"; // ES Modules import + * // const { FraudDetectorClient, GetEventTypesCommand } = require("@aws-sdk/client-frauddetector"); // CommonJS import + * const client = new FraudDetectorClient(config); + * const command = new GetEventTypesCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetEventTypesCommandInput} for command's `input` shape. + * @see {@link GetEventTypesCommandOutput} for command's `response` shape. + * @see {@link FraudDetectorClientResolvedConfig | config} for command's `input` shape. + * */ export class GetEventTypesCommand extends $Command< GetEventTypesCommandInput, diff --git a/clients/client-frauddetector/commands/GetExternalModelsCommand.ts b/clients/client-frauddetector/commands/GetExternalModelsCommand.ts index 6bc5d2293056..dfd7bd78f6b2 100644 --- a/clients/client-frauddetector/commands/GetExternalModelsCommand.ts +++ b/clients/client-frauddetector/commands/GetExternalModelsCommand.ts @@ -27,6 +27,20 @@ export interface GetExternalModelsCommandOutput extends GetExternalModelsResult, * 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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { FraudDetectorClient, GetExternalModelsCommand } from "@aws-sdk/client-frauddetector"; // ES Modules import + * // const { FraudDetectorClient, GetExternalModelsCommand } = require("@aws-sdk/client-frauddetector"); // CommonJS import + * const client = new FraudDetectorClient(config); + * const command = new GetExternalModelsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetExternalModelsCommandInput} for command's `input` shape. + * @see {@link GetExternalModelsCommandOutput} for command's `response` shape. + * @see {@link FraudDetectorClientResolvedConfig | config} for command's `input` shape. + * */ export class GetExternalModelsCommand extends $Command< GetExternalModelsCommandInput, diff --git a/clients/client-frauddetector/commands/GetKMSEncryptionKeyCommand.ts b/clients/client-frauddetector/commands/GetKMSEncryptionKeyCommand.ts index 25fa4ed93fc2..f665933dd63c 100644 --- a/clients/client-frauddetector/commands/GetKMSEncryptionKeyCommand.ts +++ b/clients/client-frauddetector/commands/GetKMSEncryptionKeyCommand.ts @@ -22,6 +22,20 @@ export interface GetKMSEncryptionKeyCommandOutput extends GetKMSEncryptionKeyRes /** *

Gets the encryption key if a Key Management Service (KMS) customer master key (CMK) has been specified to be used to encrypt content in Amazon Fraud Detector.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { FraudDetectorClient, GetKMSEncryptionKeyCommand } from "@aws-sdk/client-frauddetector"; // ES Modules import + * // const { FraudDetectorClient, GetKMSEncryptionKeyCommand } = require("@aws-sdk/client-frauddetector"); // CommonJS import + * const client = new FraudDetectorClient(config); + * const command = new GetKMSEncryptionKeyCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetKMSEncryptionKeyCommandInput} for command's `input` shape. + * @see {@link GetKMSEncryptionKeyCommandOutput} for command's `response` shape. + * @see {@link FraudDetectorClientResolvedConfig | config} for command's `input` shape. + * */ export class GetKMSEncryptionKeyCommand extends $Command< GetKMSEncryptionKeyCommandInput, diff --git a/clients/client-frauddetector/commands/GetLabelsCommand.ts b/clients/client-frauddetector/commands/GetLabelsCommand.ts index c491c0e35b1a..4a56e9ed82eb 100644 --- a/clients/client-frauddetector/commands/GetLabelsCommand.ts +++ b/clients/client-frauddetector/commands/GetLabelsCommand.ts @@ -24,6 +24,20 @@ export interface GetLabelsCommandOutput extends GetLabelsResult, __MetadataBeare * 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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { FraudDetectorClient, GetLabelsCommand } from "@aws-sdk/client-frauddetector"; // ES Modules import + * // const { FraudDetectorClient, GetLabelsCommand } = require("@aws-sdk/client-frauddetector"); // CommonJS import + * const client = new FraudDetectorClient(config); + * const command = new GetLabelsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetLabelsCommandInput} for command's `input` shape. + * @see {@link GetLabelsCommandOutput} for command's `response` shape. + * @see {@link FraudDetectorClientResolvedConfig | config} for command's `input` shape. + * */ export class GetLabelsCommand extends $Command< GetLabelsCommandInput, diff --git a/clients/client-frauddetector/commands/GetModelVersionCommand.ts b/clients/client-frauddetector/commands/GetModelVersionCommand.ts index a2e17e79b439..2d26a8fe7ef4 100644 --- a/clients/client-frauddetector/commands/GetModelVersionCommand.ts +++ b/clients/client-frauddetector/commands/GetModelVersionCommand.ts @@ -22,6 +22,20 @@ export interface GetModelVersionCommandOutput extends GetModelVersionResult, __M /** *

Gets the details of the specified model version.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { FraudDetectorClient, GetModelVersionCommand } from "@aws-sdk/client-frauddetector"; // ES Modules import + * // const { FraudDetectorClient, GetModelVersionCommand } = require("@aws-sdk/client-frauddetector"); // CommonJS import + * const client = new FraudDetectorClient(config); + * const command = new GetModelVersionCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetModelVersionCommandInput} for command's `input` shape. + * @see {@link GetModelVersionCommandOutput} for command's `response` shape. + * @see {@link FraudDetectorClientResolvedConfig | config} for command's `input` shape. + * */ export class GetModelVersionCommand extends $Command< GetModelVersionCommandInput, diff --git a/clients/client-frauddetector/commands/GetModelsCommand.ts b/clients/client-frauddetector/commands/GetModelsCommand.ts index c9d5d319897e..a4e4df2c6c0a 100644 --- a/clients/client-frauddetector/commands/GetModelsCommand.ts +++ b/clients/client-frauddetector/commands/GetModelsCommand.ts @@ -25,6 +25,20 @@ export interface GetModelsCommandOutput extends GetModelsResult, __MetadataBeare * 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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { FraudDetectorClient, GetModelsCommand } from "@aws-sdk/client-frauddetector"; // ES Modules import + * // const { FraudDetectorClient, GetModelsCommand } = require("@aws-sdk/client-frauddetector"); // CommonJS import + * const client = new FraudDetectorClient(config); + * const command = new GetModelsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetModelsCommandInput} for command's `input` shape. + * @see {@link GetModelsCommandOutput} for command's `response` shape. + * @see {@link FraudDetectorClientResolvedConfig | config} for command's `input` shape. + * */ export class GetModelsCommand extends $Command< GetModelsCommandInput, diff --git a/clients/client-frauddetector/commands/GetOutcomesCommand.ts b/clients/client-frauddetector/commands/GetOutcomesCommand.ts index 0cab56b1ff90..ce8d798b1e34 100644 --- a/clients/client-frauddetector/commands/GetOutcomesCommand.ts +++ b/clients/client-frauddetector/commands/GetOutcomesCommand.ts @@ -27,6 +27,20 @@ export interface GetOutcomesCommandOutput extends GetOutcomesResult, __MetadataB * 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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { FraudDetectorClient, GetOutcomesCommand } from "@aws-sdk/client-frauddetector"; // ES Modules import + * // const { FraudDetectorClient, GetOutcomesCommand } = require("@aws-sdk/client-frauddetector"); // CommonJS import + * const client = new FraudDetectorClient(config); + * const command = new GetOutcomesCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetOutcomesCommandInput} for command's `input` shape. + * @see {@link GetOutcomesCommandOutput} for command's `response` shape. + * @see {@link FraudDetectorClientResolvedConfig | config} for command's `input` shape. + * */ export class GetOutcomesCommand extends $Command< GetOutcomesCommandInput, diff --git a/clients/client-frauddetector/commands/GetRulesCommand.ts b/clients/client-frauddetector/commands/GetRulesCommand.ts index 4d08b33da56d..0b25f6b6a3ee 100644 --- a/clients/client-frauddetector/commands/GetRulesCommand.ts +++ b/clients/client-frauddetector/commands/GetRulesCommand.ts @@ -20,6 +20,20 @@ export interface GetRulesCommandOutput extends GetRulesResult, __MetadataBearer /** *

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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { FraudDetectorClient, GetRulesCommand } from "@aws-sdk/client-frauddetector"; // ES Modules import + * // const { FraudDetectorClient, GetRulesCommand } = require("@aws-sdk/client-frauddetector"); // CommonJS import + * const client = new FraudDetectorClient(config); + * const command = new GetRulesCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetRulesCommandInput} for command's `input` shape. + * @see {@link GetRulesCommandOutput} for command's `response` shape. + * @see {@link FraudDetectorClientResolvedConfig | config} for command's `input` shape. + * */ export class GetRulesCommand extends $Command< GetRulesCommandInput, diff --git a/clients/client-frauddetector/commands/GetVariablesCommand.ts b/clients/client-frauddetector/commands/GetVariablesCommand.ts index 7c78400a6c6a..99256d77a9af 100644 --- a/clients/client-frauddetector/commands/GetVariablesCommand.ts +++ b/clients/client-frauddetector/commands/GetVariablesCommand.ts @@ -27,6 +27,20 @@ export interface GetVariablesCommandOutput extends GetVariablesResult, __Metadat * 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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { FraudDetectorClient, GetVariablesCommand } from "@aws-sdk/client-frauddetector"; // ES Modules import + * // const { FraudDetectorClient, GetVariablesCommand } = require("@aws-sdk/client-frauddetector"); // CommonJS import + * const client = new FraudDetectorClient(config); + * const command = new GetVariablesCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetVariablesCommandInput} for command's `input` shape. + * @see {@link GetVariablesCommandOutput} for command's `response` shape. + * @see {@link FraudDetectorClientResolvedConfig | config} for command's `input` shape. + * */ export class GetVariablesCommand extends $Command< GetVariablesCommandInput, diff --git a/clients/client-frauddetector/commands/ListTagsForResourceCommand.ts b/clients/client-frauddetector/commands/ListTagsForResourceCommand.ts index 7b8c6310a2fb..2bff8be887be 100644 --- a/clients/client-frauddetector/commands/ListTagsForResourceCommand.ts +++ b/clients/client-frauddetector/commands/ListTagsForResourceCommand.ts @@ -24,6 +24,20 @@ export interface ListTagsForResourceCommandOutput extends ListTagsForResourceRes *

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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { FraudDetectorClient, ListTagsForResourceCommand } from "@aws-sdk/client-frauddetector"; // ES Modules import + * // const { FraudDetectorClient, ListTagsForResourceCommand } = require("@aws-sdk/client-frauddetector"); // CommonJS import + * const client = new FraudDetectorClient(config); + * const command = new ListTagsForResourceCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListTagsForResourceCommandInput} for command's `input` shape. + * @see {@link ListTagsForResourceCommandOutput} for command's `response` shape. + * @see {@link FraudDetectorClientResolvedConfig | config} for command's `input` shape. + * */ export class ListTagsForResourceCommand extends $Command< ListTagsForResourceCommandInput, diff --git a/clients/client-frauddetector/commands/PutDetectorCommand.ts b/clients/client-frauddetector/commands/PutDetectorCommand.ts index e179c1572d89..d39fa971674d 100644 --- a/clients/client-frauddetector/commands/PutDetectorCommand.ts +++ b/clients/client-frauddetector/commands/PutDetectorCommand.ts @@ -22,6 +22,20 @@ export interface PutDetectorCommandOutput extends PutDetectorResult, __MetadataB /** *

Creates or updates a detector.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { FraudDetectorClient, PutDetectorCommand } from "@aws-sdk/client-frauddetector"; // ES Modules import + * // const { FraudDetectorClient, PutDetectorCommand } = require("@aws-sdk/client-frauddetector"); // CommonJS import + * const client = new FraudDetectorClient(config); + * const command = new PutDetectorCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link PutDetectorCommandInput} for command's `input` shape. + * @see {@link PutDetectorCommandOutput} for command's `response` shape. + * @see {@link FraudDetectorClientResolvedConfig | config} for command's `input` shape. + * */ export class PutDetectorCommand extends $Command< PutDetectorCommandInput, diff --git a/clients/client-frauddetector/commands/PutEntityTypeCommand.ts b/clients/client-frauddetector/commands/PutEntityTypeCommand.ts index 596bf4949be4..a7a33c547e55 100644 --- a/clients/client-frauddetector/commands/PutEntityTypeCommand.ts +++ b/clients/client-frauddetector/commands/PutEntityTypeCommand.ts @@ -22,6 +22,20 @@ export interface PutEntityTypeCommandOutput extends PutEntityTypeResult, __Metad /** *

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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { FraudDetectorClient, PutEntityTypeCommand } from "@aws-sdk/client-frauddetector"; // ES Modules import + * // const { FraudDetectorClient, PutEntityTypeCommand } = require("@aws-sdk/client-frauddetector"); // CommonJS import + * const client = new FraudDetectorClient(config); + * const command = new PutEntityTypeCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link PutEntityTypeCommandInput} for command's `input` shape. + * @see {@link PutEntityTypeCommandOutput} for command's `response` shape. + * @see {@link FraudDetectorClientResolvedConfig | config} for command's `input` shape. + * */ export class PutEntityTypeCommand extends $Command< PutEntityTypeCommandInput, diff --git a/clients/client-frauddetector/commands/PutEventTypeCommand.ts b/clients/client-frauddetector/commands/PutEventTypeCommand.ts index bfaa144a4fa1..ce5d87cd030b 100644 --- a/clients/client-frauddetector/commands/PutEventTypeCommand.ts +++ b/clients/client-frauddetector/commands/PutEventTypeCommand.ts @@ -22,6 +22,20 @@ export interface PutEventTypeCommandOutput extends PutEventTypeResult, __Metadat /** *

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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { FraudDetectorClient, PutEventTypeCommand } from "@aws-sdk/client-frauddetector"; // ES Modules import + * // const { FraudDetectorClient, PutEventTypeCommand } = require("@aws-sdk/client-frauddetector"); // CommonJS import + * const client = new FraudDetectorClient(config); + * const command = new PutEventTypeCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link PutEventTypeCommandInput} for command's `input` shape. + * @see {@link PutEventTypeCommandOutput} for command's `response` shape. + * @see {@link FraudDetectorClientResolvedConfig | config} for command's `input` shape. + * */ export class PutEventTypeCommand extends $Command< PutEventTypeCommandInput, diff --git a/clients/client-frauddetector/commands/PutExternalModelCommand.ts b/clients/client-frauddetector/commands/PutExternalModelCommand.ts index 7740a4780195..467aacc8f298 100644 --- a/clients/client-frauddetector/commands/PutExternalModelCommand.ts +++ b/clients/client-frauddetector/commands/PutExternalModelCommand.ts @@ -22,6 +22,20 @@ export interface PutExternalModelCommandOutput extends PutExternalModelResult, _ /** *

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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { FraudDetectorClient, PutExternalModelCommand } from "@aws-sdk/client-frauddetector"; // ES Modules import + * // const { FraudDetectorClient, PutExternalModelCommand } = require("@aws-sdk/client-frauddetector"); // CommonJS import + * const client = new FraudDetectorClient(config); + * const command = new PutExternalModelCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link PutExternalModelCommandInput} for command's `input` shape. + * @see {@link PutExternalModelCommandOutput} for command's `response` shape. + * @see {@link FraudDetectorClientResolvedConfig | config} for command's `input` shape. + * */ export class PutExternalModelCommand extends $Command< PutExternalModelCommandInput, diff --git a/clients/client-frauddetector/commands/PutKMSEncryptionKeyCommand.ts b/clients/client-frauddetector/commands/PutKMSEncryptionKeyCommand.ts index 393220190200..cceab4ee9a2a 100644 --- a/clients/client-frauddetector/commands/PutKMSEncryptionKeyCommand.ts +++ b/clients/client-frauddetector/commands/PutKMSEncryptionKeyCommand.ts @@ -22,6 +22,20 @@ export interface PutKMSEncryptionKeyCommandOutput extends PutKMSEncryptionKeyRes /** *

Specifies the Key Management Service (KMS) customer master key (CMK) to be used to encrypt content in Amazon Fraud Detector.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { FraudDetectorClient, PutKMSEncryptionKeyCommand } from "@aws-sdk/client-frauddetector"; // ES Modules import + * // const { FraudDetectorClient, PutKMSEncryptionKeyCommand } = require("@aws-sdk/client-frauddetector"); // CommonJS import + * const client = new FraudDetectorClient(config); + * const command = new PutKMSEncryptionKeyCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link PutKMSEncryptionKeyCommandInput} for command's `input` shape. + * @see {@link PutKMSEncryptionKeyCommandOutput} for command's `response` shape. + * @see {@link FraudDetectorClientResolvedConfig | config} for command's `input` shape. + * */ export class PutKMSEncryptionKeyCommand extends $Command< PutKMSEncryptionKeyCommandInput, diff --git a/clients/client-frauddetector/commands/PutLabelCommand.ts b/clients/client-frauddetector/commands/PutLabelCommand.ts index cfb7bd91bbdd..9920df2b3de4 100644 --- a/clients/client-frauddetector/commands/PutLabelCommand.ts +++ b/clients/client-frauddetector/commands/PutLabelCommand.ts @@ -19,6 +19,20 @@ export interface PutLabelCommandOutput extends PutLabelResult, __MetadataBearer /** *

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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { FraudDetectorClient, PutLabelCommand } from "@aws-sdk/client-frauddetector"; // ES Modules import + * // const { FraudDetectorClient, PutLabelCommand } = require("@aws-sdk/client-frauddetector"); // CommonJS import + * const client = new FraudDetectorClient(config); + * const command = new PutLabelCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link PutLabelCommandInput} for command's `input` shape. + * @see {@link PutLabelCommandOutput} for command's `response` shape. + * @see {@link FraudDetectorClientResolvedConfig | config} for command's `input` shape. + * */ export class PutLabelCommand extends $Command< PutLabelCommandInput, diff --git a/clients/client-frauddetector/commands/PutOutcomeCommand.ts b/clients/client-frauddetector/commands/PutOutcomeCommand.ts index ab91edc34bb7..e4f32ed89a25 100644 --- a/clients/client-frauddetector/commands/PutOutcomeCommand.ts +++ b/clients/client-frauddetector/commands/PutOutcomeCommand.ts @@ -22,6 +22,20 @@ export interface PutOutcomeCommandOutput extends PutOutcomeResult, __MetadataBea /** *

Creates or updates an outcome.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { FraudDetectorClient, PutOutcomeCommand } from "@aws-sdk/client-frauddetector"; // ES Modules import + * // const { FraudDetectorClient, PutOutcomeCommand } = require("@aws-sdk/client-frauddetector"); // CommonJS import + * const client = new FraudDetectorClient(config); + * const command = new PutOutcomeCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link PutOutcomeCommandInput} for command's `input` shape. + * @see {@link PutOutcomeCommandOutput} for command's `response` shape. + * @see {@link FraudDetectorClientResolvedConfig | config} for command's `input` shape. + * */ export class PutOutcomeCommand extends $Command< PutOutcomeCommandInput, diff --git a/clients/client-frauddetector/commands/TagResourceCommand.ts b/clients/client-frauddetector/commands/TagResourceCommand.ts index 22b535678741..5bc6913c0083 100644 --- a/clients/client-frauddetector/commands/TagResourceCommand.ts +++ b/clients/client-frauddetector/commands/TagResourceCommand.ts @@ -22,6 +22,20 @@ export interface TagResourceCommandOutput extends TagResourceResult, __MetadataB /** *

Assigns tags to a resource.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { FraudDetectorClient, TagResourceCommand } from "@aws-sdk/client-frauddetector"; // ES Modules import + * // const { FraudDetectorClient, TagResourceCommand } = require("@aws-sdk/client-frauddetector"); // CommonJS import + * const client = new FraudDetectorClient(config); + * const command = new TagResourceCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link TagResourceCommandInput} for command's `input` shape. + * @see {@link TagResourceCommandOutput} for command's `response` shape. + * @see {@link FraudDetectorClientResolvedConfig | config} for command's `input` shape. + * */ export class TagResourceCommand extends $Command< TagResourceCommandInput, diff --git a/clients/client-frauddetector/commands/UntagResourceCommand.ts b/clients/client-frauddetector/commands/UntagResourceCommand.ts index 07730c724c95..dc21d9642a8c 100644 --- a/clients/client-frauddetector/commands/UntagResourceCommand.ts +++ b/clients/client-frauddetector/commands/UntagResourceCommand.ts @@ -22,6 +22,20 @@ export interface UntagResourceCommandOutput extends UntagResourceResult, __Metad /** *

Removes tags from a resource.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { FraudDetectorClient, UntagResourceCommand } from "@aws-sdk/client-frauddetector"; // ES Modules import + * // const { FraudDetectorClient, UntagResourceCommand } = require("@aws-sdk/client-frauddetector"); // CommonJS import + * const client = new FraudDetectorClient(config); + * const command = new UntagResourceCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link UntagResourceCommandInput} for command's `input` shape. + * @see {@link UntagResourceCommandOutput} for command's `response` shape. + * @see {@link FraudDetectorClientResolvedConfig | config} for command's `input` shape. + * */ export class UntagResourceCommand extends $Command< UntagResourceCommandInput, diff --git a/clients/client-frauddetector/commands/UpdateDetectorVersionCommand.ts b/clients/client-frauddetector/commands/UpdateDetectorVersionCommand.ts index 944e04f4d0cc..d630e1985c53 100644 --- a/clients/client-frauddetector/commands/UpdateDetectorVersionCommand.ts +++ b/clients/client-frauddetector/commands/UpdateDetectorVersionCommand.ts @@ -22,6 +22,20 @@ export interface UpdateDetectorVersionCommandOutput extends UpdateDetectorVersio /** *

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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { FraudDetectorClient, UpdateDetectorVersionCommand } from "@aws-sdk/client-frauddetector"; // ES Modules import + * // const { FraudDetectorClient, UpdateDetectorVersionCommand } = require("@aws-sdk/client-frauddetector"); // CommonJS import + * const client = new FraudDetectorClient(config); + * const command = new UpdateDetectorVersionCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link UpdateDetectorVersionCommandInput} for command's `input` shape. + * @see {@link UpdateDetectorVersionCommandOutput} for command's `response` shape. + * @see {@link FraudDetectorClientResolvedConfig | config} for command's `input` shape. + * */ export class UpdateDetectorVersionCommand extends $Command< UpdateDetectorVersionCommandInput, diff --git a/clients/client-frauddetector/commands/UpdateDetectorVersionMetadataCommand.ts b/clients/client-frauddetector/commands/UpdateDetectorVersionMetadataCommand.ts index 3196b0abdb0e..d1f7838250af 100644 --- a/clients/client-frauddetector/commands/UpdateDetectorVersionMetadataCommand.ts +++ b/clients/client-frauddetector/commands/UpdateDetectorVersionMetadataCommand.ts @@ -25,6 +25,20 @@ export interface UpdateDetectorVersionMetadataCommandOutput /** *

Updates the detector version's description. You can update the metadata for any detector version (DRAFT, ACTIVE, or * INACTIVE).

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { FraudDetectorClient, UpdateDetectorVersionMetadataCommand } from "@aws-sdk/client-frauddetector"; // ES Modules import + * // const { FraudDetectorClient, UpdateDetectorVersionMetadataCommand } = require("@aws-sdk/client-frauddetector"); // CommonJS import + * const client = new FraudDetectorClient(config); + * const command = new UpdateDetectorVersionMetadataCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link UpdateDetectorVersionMetadataCommandInput} for command's `input` shape. + * @see {@link UpdateDetectorVersionMetadataCommandOutput} for command's `response` shape. + * @see {@link FraudDetectorClientResolvedConfig | config} for command's `input` shape. + * */ export class UpdateDetectorVersionMetadataCommand extends $Command< UpdateDetectorVersionMetadataCommandInput, diff --git a/clients/client-frauddetector/commands/UpdateDetectorVersionStatusCommand.ts b/clients/client-frauddetector/commands/UpdateDetectorVersionStatusCommand.ts index 88d3d970ea27..e8b3fa9670d9 100644 --- a/clients/client-frauddetector/commands/UpdateDetectorVersionStatusCommand.ts +++ b/clients/client-frauddetector/commands/UpdateDetectorVersionStatusCommand.ts @@ -23,6 +23,20 @@ export interface UpdateDetectorVersionStatusCommandOutput extends UpdateDetector /** *

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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { FraudDetectorClient, UpdateDetectorVersionStatusCommand } from "@aws-sdk/client-frauddetector"; // ES Modules import + * // const { FraudDetectorClient, UpdateDetectorVersionStatusCommand } = require("@aws-sdk/client-frauddetector"); // CommonJS import + * const client = new FraudDetectorClient(config); + * const command = new UpdateDetectorVersionStatusCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link UpdateDetectorVersionStatusCommandInput} for command's `input` shape. + * @see {@link UpdateDetectorVersionStatusCommandOutput} for command's `response` shape. + * @see {@link FraudDetectorClientResolvedConfig | config} for command's `input` shape. + * */ export class UpdateDetectorVersionStatusCommand extends $Command< UpdateDetectorVersionStatusCommandInput, diff --git a/clients/client-frauddetector/commands/UpdateModelCommand.ts b/clients/client-frauddetector/commands/UpdateModelCommand.ts index f0e8b87c1a96..258bf4fbddad 100644 --- a/clients/client-frauddetector/commands/UpdateModelCommand.ts +++ b/clients/client-frauddetector/commands/UpdateModelCommand.ts @@ -22,6 +22,20 @@ export interface UpdateModelCommandOutput extends UpdateModelResult, __MetadataB /** *

Updates a model. You can update the description attribute using this action.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { FraudDetectorClient, UpdateModelCommand } from "@aws-sdk/client-frauddetector"; // ES Modules import + * // const { FraudDetectorClient, UpdateModelCommand } = require("@aws-sdk/client-frauddetector"); // CommonJS import + * const client = new FraudDetectorClient(config); + * const command = new UpdateModelCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link UpdateModelCommandInput} for command's `input` shape. + * @see {@link UpdateModelCommandOutput} for command's `response` shape. + * @see {@link FraudDetectorClientResolvedConfig | config} for command's `input` shape. + * */ export class UpdateModelCommand extends $Command< UpdateModelCommandInput, diff --git a/clients/client-frauddetector/commands/UpdateModelVersionCommand.ts b/clients/client-frauddetector/commands/UpdateModelVersionCommand.ts index 0ca4aaade73e..65fb543776c4 100644 --- a/clients/client-frauddetector/commands/UpdateModelVersionCommand.ts +++ b/clients/client-frauddetector/commands/UpdateModelVersionCommand.ts @@ -22,6 +22,20 @@ export interface UpdateModelVersionCommandOutput extends UpdateModelVersionResul /** *

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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { FraudDetectorClient, UpdateModelVersionCommand } from "@aws-sdk/client-frauddetector"; // ES Modules import + * // const { FraudDetectorClient, UpdateModelVersionCommand } = require("@aws-sdk/client-frauddetector"); // CommonJS import + * const client = new FraudDetectorClient(config); + * const command = new UpdateModelVersionCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link UpdateModelVersionCommandInput} for command's `input` shape. + * @see {@link UpdateModelVersionCommandOutput} for command's `response` shape. + * @see {@link FraudDetectorClientResolvedConfig | config} for command's `input` shape. + * */ export class UpdateModelVersionCommand extends $Command< UpdateModelVersionCommandInput, diff --git a/clients/client-frauddetector/commands/UpdateModelVersionStatusCommand.ts b/clients/client-frauddetector/commands/UpdateModelVersionStatusCommand.ts index 47b05af0839d..ed2e2a90f580 100644 --- a/clients/client-frauddetector/commands/UpdateModelVersionStatusCommand.ts +++ b/clients/client-frauddetector/commands/UpdateModelVersionStatusCommand.ts @@ -31,6 +31,20 @@ export interface UpdateModelVersionStatusCommandOutput extends UpdateModelVersio *

Change ACTIVEto INACTIVE.

* * + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { FraudDetectorClient, UpdateModelVersionStatusCommand } from "@aws-sdk/client-frauddetector"; // ES Modules import + * // const { FraudDetectorClient, UpdateModelVersionStatusCommand } = require("@aws-sdk/client-frauddetector"); // CommonJS import + * const client = new FraudDetectorClient(config); + * const command = new UpdateModelVersionStatusCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link UpdateModelVersionStatusCommandInput} for command's `input` shape. + * @see {@link UpdateModelVersionStatusCommandOutput} for command's `response` shape. + * @see {@link FraudDetectorClientResolvedConfig | config} for command's `input` shape. + * */ export class UpdateModelVersionStatusCommand extends $Command< UpdateModelVersionStatusCommandInput, diff --git a/clients/client-frauddetector/commands/UpdateRuleMetadataCommand.ts b/clients/client-frauddetector/commands/UpdateRuleMetadataCommand.ts index 51b347c988ab..b9f52bb75863 100644 --- a/clients/client-frauddetector/commands/UpdateRuleMetadataCommand.ts +++ b/clients/client-frauddetector/commands/UpdateRuleMetadataCommand.ts @@ -22,6 +22,20 @@ export interface UpdateRuleMetadataCommandOutput extends UpdateRuleMetadataResul /** *

Updates a rule's metadata. The description attribute can be updated.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { FraudDetectorClient, UpdateRuleMetadataCommand } from "@aws-sdk/client-frauddetector"; // ES Modules import + * // const { FraudDetectorClient, UpdateRuleMetadataCommand } = require("@aws-sdk/client-frauddetector"); // CommonJS import + * const client = new FraudDetectorClient(config); + * const command = new UpdateRuleMetadataCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link UpdateRuleMetadataCommandInput} for command's `input` shape. + * @see {@link UpdateRuleMetadataCommandOutput} for command's `response` shape. + * @see {@link FraudDetectorClientResolvedConfig | config} for command's `input` shape. + * */ export class UpdateRuleMetadataCommand extends $Command< UpdateRuleMetadataCommandInput, diff --git a/clients/client-frauddetector/commands/UpdateRuleVersionCommand.ts b/clients/client-frauddetector/commands/UpdateRuleVersionCommand.ts index 317b228d2d01..6cbc9d939e87 100644 --- a/clients/client-frauddetector/commands/UpdateRuleVersionCommand.ts +++ b/clients/client-frauddetector/commands/UpdateRuleVersionCommand.ts @@ -22,6 +22,20 @@ export interface UpdateRuleVersionCommandOutput extends UpdateRuleVersionResult, /** *

Updates a rule version resulting in a new rule version. Updates a rule version resulting in a new rule version (version 1, 2, 3 ...).

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { FraudDetectorClient, UpdateRuleVersionCommand } from "@aws-sdk/client-frauddetector"; // ES Modules import + * // const { FraudDetectorClient, UpdateRuleVersionCommand } = require("@aws-sdk/client-frauddetector"); // CommonJS import + * const client = new FraudDetectorClient(config); + * const command = new UpdateRuleVersionCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link UpdateRuleVersionCommandInput} for command's `input` shape. + * @see {@link UpdateRuleVersionCommandOutput} for command's `response` shape. + * @see {@link FraudDetectorClientResolvedConfig | config} for command's `input` shape. + * */ export class UpdateRuleVersionCommand extends $Command< UpdateRuleVersionCommandInput, diff --git a/clients/client-frauddetector/commands/UpdateVariableCommand.ts b/clients/client-frauddetector/commands/UpdateVariableCommand.ts index 08bf75706a55..3a031d9fe7a4 100644 --- a/clients/client-frauddetector/commands/UpdateVariableCommand.ts +++ b/clients/client-frauddetector/commands/UpdateVariableCommand.ts @@ -22,6 +22,20 @@ export interface UpdateVariableCommandOutput extends UpdateVariableResult, __Met /** *

Updates a variable.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { FraudDetectorClient, UpdateVariableCommand } from "@aws-sdk/client-frauddetector"; // ES Modules import + * // const { FraudDetectorClient, UpdateVariableCommand } = require("@aws-sdk/client-frauddetector"); // CommonJS import + * const client = new FraudDetectorClient(config); + * const command = new UpdateVariableCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link UpdateVariableCommandInput} for command's `input` shape. + * @see {@link UpdateVariableCommandOutput} for command's `response` shape. + * @see {@link FraudDetectorClientResolvedConfig | config} for command's `input` shape. + * */ export class UpdateVariableCommand extends $Command< UpdateVariableCommandInput, diff --git a/clients/client-frauddetector/models/models_0.ts b/clients/client-frauddetector/models/models_0.ts index 74f99fba983b..e520ba277d0d 100644 --- a/clients/client-frauddetector/models/models_0.ts +++ b/clients/client-frauddetector/models/models_0.ts @@ -11,6 +11,9 @@ export interface AccessDeniedException extends __SmithyException, $MetadataBeare } export namespace AccessDeniedException { + /** + * @internal + */ export const filterSensitiveLog = (obj: AccessDeniedException): any => ({ ...obj, }); @@ -41,6 +44,9 @@ export interface Tag { } export namespace Tag { + /** + * @internal + */ export const filterSensitiveLog = (obj: Tag): any => ({ ...obj, }); @@ -84,6 +90,9 @@ export interface VariableEntry { } export namespace VariableEntry { + /** + * @internal + */ export const filterSensitiveLog = (obj: VariableEntry): any => ({ ...obj, }); @@ -102,6 +111,9 @@ export interface BatchCreateVariableRequest { } export namespace BatchCreateVariableRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: BatchCreateVariableRequest): any => ({ ...obj, }); @@ -128,6 +140,9 @@ export interface BatchCreateVariableError { } export namespace BatchCreateVariableError { + /** + * @internal + */ export const filterSensitiveLog = (obj: BatchCreateVariableError): any => ({ ...obj, }); @@ -141,6 +156,9 @@ export interface BatchCreateVariableResult { } export namespace BatchCreateVariableResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: BatchCreateVariableResult): any => ({ ...obj, }); @@ -156,6 +174,9 @@ export interface InternalServerException extends __SmithyException, $MetadataBea } export namespace InternalServerException { + /** + * @internal + */ export const filterSensitiveLog = (obj: InternalServerException): any => ({ ...obj, }); @@ -171,6 +192,9 @@ export interface ThrottlingException extends __SmithyException, $MetadataBearer } export namespace ThrottlingException { + /** + * @internal + */ export const filterSensitiveLog = (obj: ThrottlingException): any => ({ ...obj, }); @@ -186,6 +210,9 @@ export interface ValidationException extends __SmithyException, $MetadataBearer } export namespace ValidationException { + /** + * @internal + */ export const filterSensitiveLog = (obj: ValidationException): any => ({ ...obj, }); @@ -199,6 +226,9 @@ export interface BatchGetVariableRequest { } export namespace BatchGetVariableRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: BatchGetVariableRequest): any => ({ ...obj, }); @@ -225,6 +255,9 @@ export interface BatchGetVariableError { } export namespace BatchGetVariableError { + /** + * @internal + */ export const filterSensitiveLog = (obj: BatchGetVariableError): any => ({ ...obj, }); @@ -296,6 +329,9 @@ export interface Variable { } export namespace Variable { + /** + * @internal + */ export const filterSensitiveLog = (obj: Variable): any => ({ ...obj, }); @@ -314,6 +350,9 @@ export interface BatchGetVariableResult { } export namespace BatchGetVariableResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: BatchGetVariableResult): any => ({ ...obj, }); @@ -327,6 +366,9 @@ export interface CancelBatchPredictionJobRequest { } export namespace CancelBatchPredictionJobRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: CancelBatchPredictionJobRequest): any => ({ ...obj, }); @@ -335,6 +377,9 @@ export namespace CancelBatchPredictionJobRequest { export interface CancelBatchPredictionJobResult {} export namespace CancelBatchPredictionJobResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: CancelBatchPredictionJobResult): any => ({ ...obj, }); @@ -350,6 +395,9 @@ export interface ResourceNotFoundException extends __SmithyException, $MetadataB } export namespace ResourceNotFoundException { + /** + * @internal + */ export const filterSensitiveLog = (obj: ResourceNotFoundException): any => ({ ...obj, }); @@ -398,6 +446,9 @@ export interface CreateBatchPredictionJobRequest { } export namespace CreateBatchPredictionJobRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateBatchPredictionJobRequest): any => ({ ...obj, }); @@ -406,6 +457,9 @@ export namespace CreateBatchPredictionJobRequest { export interface CreateBatchPredictionJobResult {} export namespace CreateBatchPredictionJobResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateBatchPredictionJobResult): any => ({ ...obj, }); @@ -441,6 +495,9 @@ export interface ModelVersion { } export namespace ModelVersion { + /** + * @internal + */ export const filterSensitiveLog = (obj: ModelVersion): any => ({ ...obj, }); @@ -472,6 +529,9 @@ export interface Rule { } export namespace Rule { + /** + * @internal + */ export const filterSensitiveLog = (obj: Rule): any => ({ ...obj, }); @@ -519,6 +579,9 @@ export interface CreateDetectorVersionRequest { } export namespace CreateDetectorVersionRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateDetectorVersionRequest): any => ({ ...obj, }); @@ -548,6 +611,9 @@ export interface CreateDetectorVersionResult { } export namespace CreateDetectorVersionResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateDetectorVersionResult): any => ({ ...obj, }); @@ -581,6 +647,9 @@ export interface CreateModelRequest { } export namespace CreateModelRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateModelRequest): any => ({ ...obj, }); @@ -589,6 +658,9 @@ export namespace CreateModelRequest { export interface CreateModelResult {} export namespace CreateModelResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateModelResult): any => ({ ...obj, }); @@ -610,6 +682,9 @@ export interface ExternalEventsDetail { } export namespace ExternalEventsDetail { + /** + * @internal + */ export const filterSensitiveLog = (obj: ExternalEventsDetail): any => ({ ...obj, }); @@ -627,6 +702,9 @@ export interface LabelSchema { } export namespace LabelSchema { + /** + * @internal + */ export const filterSensitiveLog = (obj: LabelSchema): any => ({ ...obj, }); @@ -648,6 +726,9 @@ export interface TrainingDataSchema { } export namespace TrainingDataSchema { + /** + * @internal + */ export const filterSensitiveLog = (obj: TrainingDataSchema): any => ({ ...obj, }); @@ -690,6 +771,9 @@ export interface CreateModelVersionRequest { } export namespace CreateModelVersionRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateModelVersionRequest): any => ({ ...obj, }); @@ -718,6 +802,9 @@ export interface CreateModelVersionResult { } export namespace CreateModelVersionResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateModelVersionResult): any => ({ ...obj, }); @@ -765,6 +852,9 @@ export interface CreateRuleRequest { } export namespace CreateRuleRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateRuleRequest): any => ({ ...obj, ...(obj.expression && { expression: SENSITIVE_STRING }), @@ -779,6 +869,9 @@ export interface CreateRuleResult { } export namespace CreateRuleResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateRuleResult): any => ({ ...obj, }); @@ -825,6 +918,9 @@ export interface CreateVariableRequest { } export namespace CreateVariableRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateVariableRequest): any => ({ ...obj, }); @@ -833,6 +929,9 @@ export namespace CreateVariableRequest { export interface CreateVariableResult {} export namespace CreateVariableResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateVariableResult): any => ({ ...obj, }); @@ -846,6 +945,9 @@ export interface DeleteBatchPredictionJobRequest { } export namespace DeleteBatchPredictionJobRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteBatchPredictionJobRequest): any => ({ ...obj, }); @@ -854,6 +956,9 @@ export namespace DeleteBatchPredictionJobRequest { export interface DeleteBatchPredictionJobResult {} export namespace DeleteBatchPredictionJobResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteBatchPredictionJobResult): any => ({ ...obj, }); @@ -880,6 +985,9 @@ export interface ConflictException extends __SmithyException, $MetadataBearer { } export namespace ConflictException { + /** + * @internal + */ export const filterSensitiveLog = (obj: ConflictException): any => ({ ...obj, }); @@ -893,6 +1001,9 @@ export interface DeleteDetectorRequest { } export namespace DeleteDetectorRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteDetectorRequest): any => ({ ...obj, }); @@ -901,6 +1012,9 @@ export namespace DeleteDetectorRequest { export interface DeleteDetectorResult {} export namespace DeleteDetectorResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteDetectorResult): any => ({ ...obj, }); @@ -919,6 +1033,9 @@ export interface DeleteDetectorVersionRequest { } export namespace DeleteDetectorVersionRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteDetectorVersionRequest): any => ({ ...obj, }); @@ -927,6 +1044,9 @@ export namespace DeleteDetectorVersionRequest { export interface DeleteDetectorVersionResult {} export namespace DeleteDetectorVersionResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteDetectorVersionResult): any => ({ ...obj, }); @@ -940,6 +1060,9 @@ export interface DeleteEntityTypeRequest { } export namespace DeleteEntityTypeRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteEntityTypeRequest): any => ({ ...obj, }); @@ -948,6 +1071,9 @@ export namespace DeleteEntityTypeRequest { export interface DeleteEntityTypeResult {} export namespace DeleteEntityTypeResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteEntityTypeResult): any => ({ ...obj, }); @@ -966,6 +1092,9 @@ export interface DeleteEventRequest { } export namespace DeleteEventRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteEventRequest): any => ({ ...obj, }); @@ -974,6 +1103,9 @@ export namespace DeleteEventRequest { export interface DeleteEventResult {} export namespace DeleteEventResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteEventResult): any => ({ ...obj, }); @@ -987,6 +1119,9 @@ export interface DeleteEventTypeRequest { } export namespace DeleteEventTypeRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteEventTypeRequest): any => ({ ...obj, }); @@ -995,6 +1130,9 @@ export namespace DeleteEventTypeRequest { export interface DeleteEventTypeResult {} export namespace DeleteEventTypeResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteEventTypeResult): any => ({ ...obj, }); @@ -1008,6 +1146,9 @@ export interface DeleteExternalModelRequest { } export namespace DeleteExternalModelRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteExternalModelRequest): any => ({ ...obj, }); @@ -1016,6 +1157,9 @@ export namespace DeleteExternalModelRequest { export interface DeleteExternalModelResult {} export namespace DeleteExternalModelResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteExternalModelResult): any => ({ ...obj, }); @@ -1029,6 +1173,9 @@ export interface DeleteLabelRequest { } export namespace DeleteLabelRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteLabelRequest): any => ({ ...obj, }); @@ -1037,6 +1184,9 @@ export namespace DeleteLabelRequest { export interface DeleteLabelResult {} export namespace DeleteLabelResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteLabelResult): any => ({ ...obj, }); @@ -1055,6 +1205,9 @@ export interface DeleteModelRequest { } export namespace DeleteModelRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteModelRequest): any => ({ ...obj, }); @@ -1063,6 +1216,9 @@ export namespace DeleteModelRequest { export interface DeleteModelResult {} export namespace DeleteModelResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteModelResult): any => ({ ...obj, }); @@ -1086,6 +1242,9 @@ export interface DeleteModelVersionRequest { } export namespace DeleteModelVersionRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteModelVersionRequest): any => ({ ...obj, }); @@ -1094,6 +1253,9 @@ export namespace DeleteModelVersionRequest { export interface DeleteModelVersionResult {} export namespace DeleteModelVersionResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteModelVersionResult): any => ({ ...obj, }); @@ -1107,6 +1269,9 @@ export interface DeleteOutcomeRequest { } export namespace DeleteOutcomeRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteOutcomeRequest): any => ({ ...obj, }); @@ -1115,6 +1280,9 @@ export namespace DeleteOutcomeRequest { export interface DeleteOutcomeResult {} export namespace DeleteOutcomeResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteOutcomeResult): any => ({ ...obj, }); @@ -1128,6 +1296,9 @@ export interface DeleteRuleRequest { } export namespace DeleteRuleRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteRuleRequest): any => ({ ...obj, }); @@ -1136,6 +1307,9 @@ export namespace DeleteRuleRequest { export interface DeleteRuleResult {} export namespace DeleteRuleResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteRuleResult): any => ({ ...obj, }); @@ -1149,6 +1323,9 @@ export interface DeleteVariableRequest { } export namespace DeleteVariableRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteVariableRequest): any => ({ ...obj, }); @@ -1157,6 +1334,9 @@ export namespace DeleteVariableRequest { export interface DeleteVariableResult {} export namespace DeleteVariableResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteVariableResult): any => ({ ...obj, }); @@ -1180,6 +1360,9 @@ export interface DescribeDetectorRequest { } export namespace DescribeDetectorRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeDetectorRequest): any => ({ ...obj, }); @@ -1211,6 +1394,9 @@ export interface DetectorVersionSummary { } export namespace DetectorVersionSummary { + /** + * @internal + */ export const filterSensitiveLog = (obj: DetectorVersionSummary): any => ({ ...obj, }); @@ -1239,6 +1425,9 @@ export interface DescribeDetectorResult { } export namespace DescribeDetectorResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeDetectorResult): any => ({ ...obj, }); @@ -1272,6 +1461,9 @@ export interface DescribeModelVersionsRequest { } export namespace DescribeModelVersionsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeModelVersionsRequest): any => ({ ...obj, }); @@ -1308,6 +1500,9 @@ export interface FieldValidationMessage { } export namespace FieldValidationMessage { + /** + * @internal + */ export const filterSensitiveLog = (obj: FieldValidationMessage): any => ({ ...obj, }); @@ -1334,6 +1529,9 @@ export interface FileValidationMessage { } export namespace FileValidationMessage { + /** + * @internal + */ export const filterSensitiveLog = (obj: FileValidationMessage): any => ({ ...obj, }); @@ -1355,6 +1553,9 @@ export interface DataValidationMetrics { } export namespace DataValidationMetrics { + /** + * @internal + */ export const filterSensitiveLog = (obj: DataValidationMetrics): any => ({ ...obj, }); @@ -1386,6 +1587,9 @@ export interface MetricDataPoint { } export namespace MetricDataPoint { + /** + * @internal + */ export const filterSensitiveLog = (obj: MetricDataPoint): any => ({ ...obj, }); @@ -1407,6 +1611,9 @@ export interface TrainingMetrics { } export namespace TrainingMetrics { + /** + * @internal + */ export const filterSensitiveLog = (obj: TrainingMetrics): any => ({ ...obj, }); @@ -1428,6 +1635,9 @@ export interface TrainingResult { } export namespace TrainingResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: TrainingResult): any => ({ ...obj, }); @@ -1494,6 +1704,9 @@ export interface ModelVersionDetail { } export namespace ModelVersionDetail { + /** + * @internal + */ export const filterSensitiveLog = (obj: ModelVersionDetail): any => ({ ...obj, }); @@ -1512,6 +1725,9 @@ export interface DescribeModelVersionsResult { } export namespace DescribeModelVersionsResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeModelVersionsResult): any => ({ ...obj, }); @@ -1535,6 +1751,9 @@ export interface GetBatchPredictionJobsRequest { } export namespace GetBatchPredictionJobsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetBatchPredictionJobsRequest): any => ({ ...obj, }); @@ -1621,6 +1840,9 @@ export interface BatchPrediction { } export namespace BatchPrediction { + /** + * @internal + */ export const filterSensitiveLog = (obj: BatchPrediction): any => ({ ...obj, }); @@ -1639,6 +1861,9 @@ export interface GetBatchPredictionJobsResult { } export namespace GetBatchPredictionJobsResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetBatchPredictionJobsResult): any => ({ ...obj, }); @@ -1662,6 +1887,9 @@ export interface GetDetectorsRequest { } export namespace GetDetectorsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetDetectorsRequest): any => ({ ...obj, }); @@ -1703,6 +1931,9 @@ export interface Detector { } export namespace Detector { + /** + * @internal + */ export const filterSensitiveLog = (obj: Detector): any => ({ ...obj, }); @@ -1721,6 +1952,9 @@ export interface GetDetectorsResult { } export namespace GetDetectorsResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetDetectorsResult): any => ({ ...obj, }); @@ -1739,6 +1973,9 @@ export interface GetDetectorVersionRequest { } export namespace GetDetectorVersionRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetDetectorVersionRequest): any => ({ ...obj, }); @@ -1807,6 +2044,9 @@ export interface GetDetectorVersionResult { } export namespace GetDetectorVersionResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetDetectorVersionResult): any => ({ ...obj, }); @@ -1830,6 +2070,9 @@ export interface GetEntityTypesRequest { } export namespace GetEntityTypesRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetEntityTypesRequest): any => ({ ...obj, }); @@ -1866,6 +2109,9 @@ export interface EntityType { } export namespace EntityType { + /** + * @internal + */ export const filterSensitiveLog = (obj: EntityType): any => ({ ...obj, }); @@ -1884,6 +2130,9 @@ export interface GetEntityTypesResult { } export namespace GetEntityTypesResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetEntityTypesResult): any => ({ ...obj, }); @@ -1905,6 +2154,9 @@ export interface Entity { } export namespace Entity { + /** + * @internal + */ export const filterSensitiveLog = (obj: Entity): any => ({ ...obj, }); @@ -1926,6 +2178,9 @@ export interface ModelEndpointDataBlob { } export namespace ModelEndpointDataBlob { + /** + * @internal + */ export const filterSensitiveLog = (obj: ModelEndpointDataBlob): any => ({ ...obj, }); @@ -1974,6 +2229,9 @@ export interface GetEventPredictionRequest { } export namespace GetEventPredictionRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetEventPredictionRequest): any => ({ ...obj, ...(obj.eventVariables && { eventVariables: SENSITIVE_STRING }), @@ -1997,6 +2255,9 @@ export interface ModelScores { } export namespace ModelScores { + /** + * @internal + */ export const filterSensitiveLog = (obj: ModelScores): any => ({ ...obj, }); @@ -2018,6 +2279,9 @@ export interface RuleResult { } export namespace RuleResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: RuleResult): any => ({ ...obj, }); @@ -2036,6 +2300,9 @@ export interface GetEventPredictionResult { } export namespace GetEventPredictionResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetEventPredictionResult): any => ({ ...obj, }); @@ -2059,6 +2326,9 @@ export interface GetEventTypesRequest { } export namespace GetEventTypesRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetEventTypesRequest): any => ({ ...obj, }); @@ -2110,6 +2380,9 @@ export interface EventType { } export namespace EventType { + /** + * @internal + */ export const filterSensitiveLog = (obj: EventType): any => ({ ...obj, }); @@ -2128,6 +2401,9 @@ export interface GetEventTypesResult { } export namespace GetEventTypesResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetEventTypesResult): any => ({ ...obj, }); @@ -2151,6 +2427,9 @@ export interface GetExternalModelsRequest { } export namespace GetExternalModelsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetExternalModelsRequest): any => ({ ...obj, }); @@ -2197,6 +2476,9 @@ export interface ModelInputConfiguration { } export namespace ModelInputConfiguration { + /** + * @internal + */ export const filterSensitiveLog = (obj: ModelInputConfiguration): any => ({ ...obj, }); @@ -2237,6 +2519,9 @@ export interface ModelOutputConfiguration { } export namespace ModelOutputConfiguration { + /** + * @internal + */ export const filterSensitiveLog = (obj: ModelOutputConfiguration): any => ({ ...obj, }); @@ -2293,6 +2578,9 @@ export interface ExternalModel { } export namespace ExternalModel { + /** + * @internal + */ export const filterSensitiveLog = (obj: ExternalModel): any => ({ ...obj, }); @@ -2311,6 +2599,9 @@ export interface GetExternalModelsResult { } export namespace GetExternalModelsResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetExternalModelsResult): any => ({ ...obj, }); @@ -2327,6 +2618,9 @@ export interface KMSKey { } export namespace KMSKey { + /** + * @internal + */ export const filterSensitiveLog = (obj: KMSKey): any => ({ ...obj, }); @@ -2340,6 +2634,9 @@ export interface GetKMSEncryptionKeyResult { } export namespace GetKMSEncryptionKeyResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetKMSEncryptionKeyResult): any => ({ ...obj, }); @@ -2363,6 +2660,9 @@ export interface GetLabelsRequest { } export namespace GetLabelsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetLabelsRequest): any => ({ ...obj, }); @@ -2399,6 +2699,9 @@ export interface Label { } export namespace Label { + /** + * @internal + */ export const filterSensitiveLog = (obj: Label): any => ({ ...obj, }); @@ -2417,6 +2720,9 @@ export interface GetLabelsResult { } export namespace GetLabelsResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetLabelsResult): any => ({ ...obj, }); @@ -2445,6 +2751,9 @@ export interface GetModelsRequest { } export namespace GetModelsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetModelsRequest): any => ({ ...obj, }); @@ -2491,6 +2800,9 @@ export interface Model { } export namespace Model { + /** + * @internal + */ export const filterSensitiveLog = (obj: Model): any => ({ ...obj, }); @@ -2509,6 +2821,9 @@ export interface GetModelsResult { } export namespace GetModelsResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetModelsResult): any => ({ ...obj, }); @@ -2532,6 +2847,9 @@ export interface GetModelVersionRequest { } export namespace GetModelVersionRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetModelVersionRequest): any => ({ ...obj, }); @@ -2628,6 +2946,9 @@ export interface GetModelVersionResult { } export namespace GetModelVersionResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetModelVersionResult): any => ({ ...obj, }); @@ -2651,6 +2972,9 @@ export interface GetOutcomesRequest { } export namespace GetOutcomesRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetOutcomesRequest): any => ({ ...obj, }); @@ -2687,6 +3011,9 @@ export interface Outcome { } export namespace Outcome { + /** + * @internal + */ export const filterSensitiveLog = (obj: Outcome): any => ({ ...obj, }); @@ -2705,6 +3032,9 @@ export interface GetOutcomesResult { } export namespace GetOutcomesResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetOutcomesResult): any => ({ ...obj, }); @@ -2738,6 +3068,9 @@ export interface GetRulesRequest { } export namespace GetRulesRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetRulesRequest): any => ({ ...obj, }); @@ -2799,6 +3132,9 @@ export interface RuleDetail { } export namespace RuleDetail { + /** + * @internal + */ export const filterSensitiveLog = (obj: RuleDetail): any => ({ ...obj, ...(obj.expression && { expression: SENSITIVE_STRING }), @@ -2818,6 +3154,9 @@ export interface GetRulesResult { } export namespace GetRulesResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetRulesResult): any => ({ ...obj, ...(obj.ruleDetails && { ruleDetails: obj.ruleDetails.map((item) => RuleDetail.filterSensitiveLog(item)) }), @@ -2842,6 +3181,9 @@ export interface GetVariablesRequest { } export namespace GetVariablesRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetVariablesRequest): any => ({ ...obj, }); @@ -2860,6 +3202,9 @@ export interface GetVariablesResult { } export namespace GetVariablesResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetVariablesResult): any => ({ ...obj, }); @@ -2883,6 +3228,9 @@ export interface ListTagsForResourceRequest { } export namespace ListTagsForResourceRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListTagsForResourceRequest): any => ({ ...obj, }); @@ -2901,6 +3249,9 @@ export interface ListTagsForResourceResult { } export namespace ListTagsForResourceResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListTagsForResourceResult): any => ({ ...obj, }); @@ -2929,6 +3280,9 @@ export interface PutDetectorRequest { } export namespace PutDetectorRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: PutDetectorRequest): any => ({ ...obj, }); @@ -2937,6 +3291,9 @@ export namespace PutDetectorRequest { export interface PutDetectorResult {} export namespace PutDetectorResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: PutDetectorResult): any => ({ ...obj, }); @@ -2960,6 +3317,9 @@ export interface PutEntityTypeRequest { } export namespace PutEntityTypeRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: PutEntityTypeRequest): any => ({ ...obj, }); @@ -2968,6 +3328,9 @@ export namespace PutEntityTypeRequest { export interface PutEntityTypeResult {} export namespace PutEntityTypeResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: PutEntityTypeResult): any => ({ ...obj, }); @@ -3006,6 +3369,9 @@ export interface PutEventTypeRequest { } export namespace PutEventTypeRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: PutEventTypeRequest): any => ({ ...obj, }); @@ -3014,6 +3380,9 @@ export namespace PutEventTypeRequest { export interface PutEventTypeResult {} export namespace PutEventTypeResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: PutEventTypeResult): any => ({ ...obj, }); @@ -3057,6 +3426,9 @@ export interface PutExternalModelRequest { } export namespace PutExternalModelRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: PutExternalModelRequest): any => ({ ...obj, }); @@ -3065,6 +3437,9 @@ export namespace PutExternalModelRequest { export interface PutExternalModelResult {} export namespace PutExternalModelResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: PutExternalModelResult): any => ({ ...obj, }); @@ -3078,6 +3453,9 @@ export interface PutKMSEncryptionKeyRequest { } export namespace PutKMSEncryptionKeyRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: PutKMSEncryptionKeyRequest): any => ({ ...obj, }); @@ -3086,6 +3464,9 @@ export namespace PutKMSEncryptionKeyRequest { export interface PutKMSEncryptionKeyResult {} export namespace PutKMSEncryptionKeyResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: PutKMSEncryptionKeyResult): any => ({ ...obj, }); @@ -3109,6 +3490,9 @@ export interface PutLabelRequest { } export namespace PutLabelRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: PutLabelRequest): any => ({ ...obj, }); @@ -3117,6 +3501,9 @@ export namespace PutLabelRequest { export interface PutLabelResult {} export namespace PutLabelResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: PutLabelResult): any => ({ ...obj, }); @@ -3140,6 +3527,9 @@ export interface PutOutcomeRequest { } export namespace PutOutcomeRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: PutOutcomeRequest): any => ({ ...obj, }); @@ -3148,6 +3538,9 @@ export namespace PutOutcomeRequest { export interface PutOutcomeResult {} export namespace PutOutcomeResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: PutOutcomeResult): any => ({ ...obj, }); @@ -3166,6 +3559,9 @@ export interface TagResourceRequest { } export namespace TagResourceRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: TagResourceRequest): any => ({ ...obj, }); @@ -3174,6 +3570,9 @@ export namespace TagResourceRequest { export interface TagResourceResult {} export namespace TagResourceResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: TagResourceResult): any => ({ ...obj, }); @@ -3192,6 +3591,9 @@ export interface UntagResourceRequest { } export namespace UntagResourceRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: UntagResourceRequest): any => ({ ...obj, }); @@ -3200,6 +3602,9 @@ export namespace UntagResourceRequest { export interface UntagResourceResult {} export namespace UntagResourceResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: UntagResourceResult): any => ({ ...obj, }); @@ -3246,6 +3651,9 @@ export interface UpdateDetectorVersionRequest { } export namespace UpdateDetectorVersionRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateDetectorVersionRequest): any => ({ ...obj, }); @@ -3254,6 +3662,9 @@ export namespace UpdateDetectorVersionRequest { export interface UpdateDetectorVersionResult {} export namespace UpdateDetectorVersionResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateDetectorVersionResult): any => ({ ...obj, }); @@ -3277,6 +3688,9 @@ export interface UpdateDetectorVersionMetadataRequest { } export namespace UpdateDetectorVersionMetadataRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateDetectorVersionMetadataRequest): any => ({ ...obj, }); @@ -3285,6 +3699,9 @@ export namespace UpdateDetectorVersionMetadataRequest { export interface UpdateDetectorVersionMetadataResult {} export namespace UpdateDetectorVersionMetadataResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateDetectorVersionMetadataResult): any => ({ ...obj, }); @@ -3308,6 +3725,9 @@ export interface UpdateDetectorVersionStatusRequest { } export namespace UpdateDetectorVersionStatusRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateDetectorVersionStatusRequest): any => ({ ...obj, }); @@ -3316,6 +3736,9 @@ export namespace UpdateDetectorVersionStatusRequest { export interface UpdateDetectorVersionStatusResult {} export namespace UpdateDetectorVersionStatusResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateDetectorVersionStatusResult): any => ({ ...obj, }); @@ -3339,6 +3762,9 @@ export interface UpdateModelRequest { } export namespace UpdateModelRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateModelRequest): any => ({ ...obj, }); @@ -3347,6 +3773,9 @@ export namespace UpdateModelRequest { export interface UpdateModelResult {} export namespace UpdateModelResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateModelResult): any => ({ ...obj, }); @@ -3380,6 +3809,9 @@ export interface UpdateModelVersionRequest { } export namespace UpdateModelVersionRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateModelVersionRequest): any => ({ ...obj, }); @@ -3408,6 +3840,9 @@ export interface UpdateModelVersionResult { } export namespace UpdateModelVersionResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateModelVersionResult): any => ({ ...obj, }); @@ -3442,6 +3877,9 @@ export interface UpdateModelVersionStatusRequest { } export namespace UpdateModelVersionStatusRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateModelVersionStatusRequest): any => ({ ...obj, }); @@ -3450,6 +3888,9 @@ export namespace UpdateModelVersionStatusRequest { export interface UpdateModelVersionStatusResult {} export namespace UpdateModelVersionStatusResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateModelVersionStatusResult): any => ({ ...obj, }); @@ -3468,6 +3909,9 @@ export interface UpdateRuleMetadataRequest { } export namespace UpdateRuleMetadataRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateRuleMetadataRequest): any => ({ ...obj, }); @@ -3476,6 +3920,9 @@ export namespace UpdateRuleMetadataRequest { export interface UpdateRuleMetadataResult {} export namespace UpdateRuleMetadataResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateRuleMetadataResult): any => ({ ...obj, }); @@ -3514,6 +3961,9 @@ export interface UpdateRuleVersionRequest { } export namespace UpdateRuleVersionRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateRuleVersionRequest): any => ({ ...obj, ...(obj.expression && { expression: SENSITIVE_STRING }), @@ -3528,6 +3978,9 @@ export interface UpdateRuleVersionResult { } export namespace UpdateRuleVersionResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateRuleVersionResult): any => ({ ...obj, }); @@ -3556,6 +4009,9 @@ export interface UpdateVariableRequest { } export namespace UpdateVariableRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateVariableRequest): any => ({ ...obj, }); @@ -3564,6 +4020,9 @@ export namespace UpdateVariableRequest { export interface UpdateVariableResult {} export namespace UpdateVariableResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateVariableResult): any => ({ ...obj, }); diff --git a/clients/client-fsx/commands/AssociateFileSystemAliasesCommand.ts b/clients/client-fsx/commands/AssociateFileSystemAliasesCommand.ts index c109214df6b3..1228bc63efb1 100644 --- a/clients/client-fsx/commands/AssociateFileSystemAliasesCommand.ts +++ b/clients/client-fsx/commands/AssociateFileSystemAliasesCommand.ts @@ -32,6 +32,20 @@ export interface AssociateFileSystemAliasesCommandOutput extends AssociateFileSy * Use the API * operation to monitor the status of the aliases Amazon FSx is * associating with the file system.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { FSxClient, AssociateFileSystemAliasesCommand } from "@aws-sdk/client-fsx"; // ES Modules import + * // const { FSxClient, AssociateFileSystemAliasesCommand } = require("@aws-sdk/client-fsx"); // CommonJS import + * const client = new FSxClient(config); + * const command = new AssociateFileSystemAliasesCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link AssociateFileSystemAliasesCommandInput} for command's `input` shape. + * @see {@link AssociateFileSystemAliasesCommandOutput} for command's `response` shape. + * @see {@link FSxClientResolvedConfig | config} for command's `input` shape. + * */ export class AssociateFileSystemAliasesCommand extends $Command< AssociateFileSystemAliasesCommandInput, diff --git a/clients/client-fsx/commands/CancelDataRepositoryTaskCommand.ts b/clients/client-fsx/commands/CancelDataRepositoryTaskCommand.ts index acb46afac3a6..2e6f14c9d6ec 100644 --- a/clients/client-fsx/commands/CancelDataRepositoryTaskCommand.ts +++ b/clients/client-fsx/commands/CancelDataRepositoryTaskCommand.ts @@ -34,6 +34,20 @@ export interface CancelDataRepositoryTaskCommandOutput extends CancelDataReposit *

FSx does not export any files that have not yet been exported.

* * + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { FSxClient, CancelDataRepositoryTaskCommand } from "@aws-sdk/client-fsx"; // ES Modules import + * // const { FSxClient, CancelDataRepositoryTaskCommand } = require("@aws-sdk/client-fsx"); // CommonJS import + * const client = new FSxClient(config); + * const command = new CancelDataRepositoryTaskCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CancelDataRepositoryTaskCommandInput} for command's `input` shape. + * @see {@link CancelDataRepositoryTaskCommandOutput} for command's `response` shape. + * @see {@link FSxClientResolvedConfig | config} for command's `input` shape. + * */ export class CancelDataRepositoryTaskCommand extends $Command< CancelDataRepositoryTaskCommandInput, diff --git a/clients/client-fsx/commands/CopyBackupCommand.ts b/clients/client-fsx/commands/CopyBackupCommand.ts index 8b2068a9fc18..d4464b1d7015 100644 --- a/clients/client-fsx/commands/CopyBackupCommand.ts +++ b/clients/client-fsx/commands/CopyBackupCommand.ts @@ -42,6 +42,20 @@ export interface CopyBackupCommandOutput extends CopyBackupResponse, __MetadataB * Copying backups in the Amazon FSx for Windows User Guide and * Copying backups * in the Amazon FSx for Lustre User Guide.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { FSxClient, CopyBackupCommand } from "@aws-sdk/client-fsx"; // ES Modules import + * // const { FSxClient, CopyBackupCommand } = require("@aws-sdk/client-fsx"); // CommonJS import + * const client = new FSxClient(config); + * const command = new CopyBackupCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CopyBackupCommandInput} for command's `input` shape. + * @see {@link CopyBackupCommandOutput} for command's `response` shape. + * @see {@link FSxClientResolvedConfig | config} for command's `input` shape. + * */ export class CopyBackupCommand extends $Command< CopyBackupCommandInput, diff --git a/clients/client-fsx/commands/CreateBackupCommand.ts b/clients/client-fsx/commands/CreateBackupCommand.ts index b5813552fe56..1ad79fa7c94d 100644 --- a/clients/client-fsx/commands/CreateBackupCommand.ts +++ b/clients/client-fsx/commands/CreateBackupCommand.ts @@ -65,6 +65,20 @@ export interface CreateBackupCommandOutput extends CreateBackupResponse, __Metad * 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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { FSxClient, CreateBackupCommand } from "@aws-sdk/client-fsx"; // ES Modules import + * // const { FSxClient, CreateBackupCommand } = require("@aws-sdk/client-fsx"); // CommonJS import + * const client = new FSxClient(config); + * const command = new CreateBackupCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreateBackupCommandInput} for command's `input` shape. + * @see {@link CreateBackupCommandOutput} for command's `response` shape. + * @see {@link FSxClientResolvedConfig | config} for command's `input` shape. + * */ export class CreateBackupCommand extends $Command< CreateBackupCommandInput, diff --git a/clients/client-fsx/commands/CreateDataRepositoryTaskCommand.ts b/clients/client-fsx/commands/CreateDataRepositoryTaskCommand.ts index bdd1ef1f4e35..e80c15a33c50 100644 --- a/clients/client-fsx/commands/CreateDataRepositoryTaskCommand.ts +++ b/clients/client-fsx/commands/CreateDataRepositoryTaskCommand.ts @@ -30,6 +30,20 @@ export interface CreateDataRepositoryTaskCommandOutput extends CreateDataReposit * Data Repository Tasks. * To learn more about linking a data repository to your file system, see * Linking your file system to an S3 bucket.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { FSxClient, CreateDataRepositoryTaskCommand } from "@aws-sdk/client-fsx"; // ES Modules import + * // const { FSxClient, CreateDataRepositoryTaskCommand } = require("@aws-sdk/client-fsx"); // CommonJS import + * const client = new FSxClient(config); + * const command = new CreateDataRepositoryTaskCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreateDataRepositoryTaskCommandInput} for command's `input` shape. + * @see {@link CreateDataRepositoryTaskCommandOutput} for command's `response` shape. + * @see {@link FSxClientResolvedConfig | config} for command's `input` shape. + * */ export class CreateDataRepositoryTaskCommand extends $Command< CreateDataRepositoryTaskCommandInput, diff --git a/clients/client-fsx/commands/CreateFileSystemCommand.ts b/clients/client-fsx/commands/CreateFileSystemCommand.ts index 3038f5a0d69d..9ab3a23d2689 100644 --- a/clients/client-fsx/commands/CreateFileSystemCommand.ts +++ b/clients/client-fsx/commands/CreateFileSystemCommand.ts @@ -54,6 +54,20 @@ export interface CreateFileSystemCommandOutput extends CreateFileSystemResponse, * creation status by calling the DescribeFileSystems operation, * which returns the file system state along with other information.

* + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { FSxClient, CreateFileSystemCommand } from "@aws-sdk/client-fsx"; // ES Modules import + * // const { FSxClient, CreateFileSystemCommand } = require("@aws-sdk/client-fsx"); // CommonJS import + * const client = new FSxClient(config); + * const command = new CreateFileSystemCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreateFileSystemCommandInput} for command's `input` shape. + * @see {@link CreateFileSystemCommandOutput} for command's `response` shape. + * @see {@link FSxClientResolvedConfig | config} for command's `input` shape. + * */ export class CreateFileSystemCommand extends $Command< CreateFileSystemCommandInput, diff --git a/clients/client-fsx/commands/CreateFileSystemFromBackupCommand.ts b/clients/client-fsx/commands/CreateFileSystemFromBackupCommand.ts index ea79bc72bfb5..cc566668a945 100644 --- a/clients/client-fsx/commands/CreateFileSystemFromBackupCommand.ts +++ b/clients/client-fsx/commands/CreateFileSystemFromBackupCommand.ts @@ -57,6 +57,20 @@ export interface CreateFileSystemFromBackupCommandOutput extends CreateFileSyste * operation, which returns the file system state along with other * information.

* + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { FSxClient, CreateFileSystemFromBackupCommand } from "@aws-sdk/client-fsx"; // ES Modules import + * // const { FSxClient, CreateFileSystemFromBackupCommand } = require("@aws-sdk/client-fsx"); // CommonJS import + * const client = new FSxClient(config); + * const command = new CreateFileSystemFromBackupCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreateFileSystemFromBackupCommandInput} for command's `input` shape. + * @see {@link CreateFileSystemFromBackupCommandOutput} for command's `response` shape. + * @see {@link FSxClientResolvedConfig | config} for command's `input` shape. + * */ export class CreateFileSystemFromBackupCommand extends $Command< CreateFileSystemFromBackupCommandInput, diff --git a/clients/client-fsx/commands/DeleteBackupCommand.ts b/clients/client-fsx/commands/DeleteBackupCommand.ts index b99fc04ec0b6..cc7a9e2fb18b 100644 --- a/clients/client-fsx/commands/DeleteBackupCommand.ts +++ b/clients/client-fsx/commands/DeleteBackupCommand.ts @@ -30,6 +30,20 @@ export interface DeleteBackupCommandOutput extends DeleteBackupResponse, __Metad *

The data in a deleted backup is also deleted and can't be recovered by any * means.

* + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { FSxClient, DeleteBackupCommand } from "@aws-sdk/client-fsx"; // ES Modules import + * // const { FSxClient, DeleteBackupCommand } = require("@aws-sdk/client-fsx"); // CommonJS import + * const client = new FSxClient(config); + * const command = new DeleteBackupCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteBackupCommandInput} for command's `input` shape. + * @see {@link DeleteBackupCommandOutput} for command's `response` shape. + * @see {@link FSxClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteBackupCommand extends $Command< DeleteBackupCommandInput, diff --git a/clients/client-fsx/commands/DeleteFileSystemCommand.ts b/clients/client-fsx/commands/DeleteFileSystemCommand.ts index e2338b605fb1..d0f316723cee 100644 --- a/clients/client-fsx/commands/DeleteFileSystemCommand.ts +++ b/clients/client-fsx/commands/DeleteFileSystemCommand.ts @@ -44,6 +44,20 @@ export interface DeleteFileSystemCommandOutput extends DeleteFileSystemResponse, *

The data in a deleted file system is also deleted and can't be recovered by * any means.

* + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { FSxClient, DeleteFileSystemCommand } from "@aws-sdk/client-fsx"; // ES Modules import + * // const { FSxClient, DeleteFileSystemCommand } = require("@aws-sdk/client-fsx"); // CommonJS import + * const client = new FSxClient(config); + * const command = new DeleteFileSystemCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteFileSystemCommandInput} for command's `input` shape. + * @see {@link DeleteFileSystemCommandOutput} for command's `response` shape. + * @see {@link FSxClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteFileSystemCommand extends $Command< DeleteFileSystemCommandInput, diff --git a/clients/client-fsx/commands/DescribeBackupsCommand.ts b/clients/client-fsx/commands/DescribeBackupsCommand.ts index 73abbd10e5a9..e1f99d3e0ff8 100644 --- a/clients/client-fsx/commands/DescribeBackupsCommand.ts +++ b/clients/client-fsx/commands/DescribeBackupsCommand.ts @@ -52,6 +52,20 @@ export interface DescribeBackupsCommandOutput extends DescribeBackupsResponse, _ * the responses of a multi-call iteration is unspecified.

* * + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { FSxClient, DescribeBackupsCommand } from "@aws-sdk/client-fsx"; // ES Modules import + * // const { FSxClient, DescribeBackupsCommand } = require("@aws-sdk/client-fsx"); // CommonJS import + * const client = new FSxClient(config); + * const command = new DescribeBackupsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeBackupsCommandInput} for command's `input` shape. + * @see {@link DescribeBackupsCommandOutput} for command's `response` shape. + * @see {@link FSxClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeBackupsCommand extends $Command< DescribeBackupsCommandInput, diff --git a/clients/client-fsx/commands/DescribeDataRepositoryTasksCommand.ts b/clients/client-fsx/commands/DescribeDataRepositoryTasksCommand.ts index 2d64be9a3fe5..a7e1ca8b4bb3 100644 --- a/clients/client-fsx/commands/DescribeDataRepositoryTasksCommand.ts +++ b/clients/client-fsx/commands/DescribeDataRepositoryTasksCommand.ts @@ -34,6 +34,20 @@ export interface DescribeDataRepositoryTasksCommandOutput * 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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { FSxClient, DescribeDataRepositoryTasksCommand } from "@aws-sdk/client-fsx"; // ES Modules import + * // const { FSxClient, DescribeDataRepositoryTasksCommand } = require("@aws-sdk/client-fsx"); // CommonJS import + * const client = new FSxClient(config); + * const command = new DescribeDataRepositoryTasksCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeDataRepositoryTasksCommandInput} for command's `input` shape. + * @see {@link DescribeDataRepositoryTasksCommandOutput} for command's `response` shape. + * @see {@link FSxClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeDataRepositoryTasksCommand extends $Command< DescribeDataRepositoryTasksCommandInput, diff --git a/clients/client-fsx/commands/DescribeFileSystemAliasesCommand.ts b/clients/client-fsx/commands/DescribeFileSystemAliasesCommand.ts index 9cc3692d40ee..fb6dfff292c2 100644 --- a/clients/client-fsx/commands/DescribeFileSystemAliasesCommand.ts +++ b/clients/client-fsx/commands/DescribeFileSystemAliasesCommand.ts @@ -24,6 +24,20 @@ export interface DescribeFileSystemAliasesCommandOutput extends DescribeFileSyst *

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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { FSxClient, DescribeFileSystemAliasesCommand } from "@aws-sdk/client-fsx"; // ES Modules import + * // const { FSxClient, DescribeFileSystemAliasesCommand } = require("@aws-sdk/client-fsx"); // CommonJS import + * const client = new FSxClient(config); + * const command = new DescribeFileSystemAliasesCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeFileSystemAliasesCommandInput} for command's `input` shape. + * @see {@link DescribeFileSystemAliasesCommandOutput} for command's `response` shape. + * @see {@link FSxClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeFileSystemAliasesCommand extends $Command< DescribeFileSystemAliasesCommandInput, diff --git a/clients/client-fsx/commands/DescribeFileSystemsCommand.ts b/clients/client-fsx/commands/DescribeFileSystemsCommand.ts index e499bed2cf58..2ce5722a4a76 100644 --- a/clients/client-fsx/commands/DescribeFileSystemsCommand.ts +++ b/clients/client-fsx/commands/DescribeFileSystemsCommand.ts @@ -53,6 +53,20 @@ export interface DescribeFileSystemsCommandOutput extends DescribeFileSystemsRes * across the responses of a multicall iteration is unspecified.

* * + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { FSxClient, DescribeFileSystemsCommand } from "@aws-sdk/client-fsx"; // ES Modules import + * // const { FSxClient, DescribeFileSystemsCommand } = require("@aws-sdk/client-fsx"); // CommonJS import + * const client = new FSxClient(config); + * const command = new DescribeFileSystemsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeFileSystemsCommandInput} for command's `input` shape. + * @see {@link DescribeFileSystemsCommandOutput} for command's `response` shape. + * @see {@link FSxClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeFileSystemsCommand extends $Command< DescribeFileSystemsCommandInput, diff --git a/clients/client-fsx/commands/DisassociateFileSystemAliasesCommand.ts b/clients/client-fsx/commands/DisassociateFileSystemAliasesCommand.ts index ce55d697ca80..d794227a7d81 100644 --- a/clients/client-fsx/commands/DisassociateFileSystemAliasesCommand.ts +++ b/clients/client-fsx/commands/DisassociateFileSystemAliasesCommand.ts @@ -32,6 +32,20 @@ export interface DisassociateFileSystemAliasesCommandOutput * Use the API * operation to monitor the status of the aliases Amazon FSx is * disassociating with the file system.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { FSxClient, DisassociateFileSystemAliasesCommand } from "@aws-sdk/client-fsx"; // ES Modules import + * // const { FSxClient, DisassociateFileSystemAliasesCommand } = require("@aws-sdk/client-fsx"); // CommonJS import + * const client = new FSxClient(config); + * const command = new DisassociateFileSystemAliasesCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DisassociateFileSystemAliasesCommandInput} for command's `input` shape. + * @see {@link DisassociateFileSystemAliasesCommandOutput} for command's `response` shape. + * @see {@link FSxClientResolvedConfig | config} for command's `input` shape. + * */ export class DisassociateFileSystemAliasesCommand extends $Command< DisassociateFileSystemAliasesCommandInput, diff --git a/clients/client-fsx/commands/ListTagsForResourceCommand.ts b/clients/client-fsx/commands/ListTagsForResourceCommand.ts index 5f9eb641ceca..57c8f69a7e58 100644 --- a/clients/client-fsx/commands/ListTagsForResourceCommand.ts +++ b/clients/client-fsx/commands/ListTagsForResourceCommand.ts @@ -50,6 +50,20 @@ export interface ListTagsForResourceCommandOutput extends ListTagsForResourceRes * the responses of a multi-call iteration is unspecified.

* * + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { FSxClient, ListTagsForResourceCommand } from "@aws-sdk/client-fsx"; // ES Modules import + * // const { FSxClient, ListTagsForResourceCommand } = require("@aws-sdk/client-fsx"); // CommonJS import + * const client = new FSxClient(config); + * const command = new ListTagsForResourceCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListTagsForResourceCommandInput} for command's `input` shape. + * @see {@link ListTagsForResourceCommandOutput} for command's `response` shape. + * @see {@link FSxClientResolvedConfig | config} for command's `input` shape. + * */ export class ListTagsForResourceCommand extends $Command< ListTagsForResourceCommandInput, diff --git a/clients/client-fsx/commands/TagResourceCommand.ts b/clients/client-fsx/commands/TagResourceCommand.ts index 0aa00aeb0996..8c32ceb787b2 100644 --- a/clients/client-fsx/commands/TagResourceCommand.ts +++ b/clients/client-fsx/commands/TagResourceCommand.ts @@ -22,6 +22,20 @@ export interface TagResourceCommandOutput extends TagResourceResponse, __Metadat /** *

Tags an Amazon FSx resource.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { FSxClient, TagResourceCommand } from "@aws-sdk/client-fsx"; // ES Modules import + * // const { FSxClient, TagResourceCommand } = require("@aws-sdk/client-fsx"); // CommonJS import + * const client = new FSxClient(config); + * const command = new TagResourceCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link TagResourceCommandInput} for command's `input` shape. + * @see {@link TagResourceCommandOutput} for command's `response` shape. + * @see {@link FSxClientResolvedConfig | config} for command's `input` shape. + * */ export class TagResourceCommand extends $Command< TagResourceCommandInput, diff --git a/clients/client-fsx/commands/UntagResourceCommand.ts b/clients/client-fsx/commands/UntagResourceCommand.ts index 159fb350b7c3..ecba479a150b 100644 --- a/clients/client-fsx/commands/UntagResourceCommand.ts +++ b/clients/client-fsx/commands/UntagResourceCommand.ts @@ -22,6 +22,20 @@ export interface UntagResourceCommandOutput extends UntagResourceResponse, __Met /** *

This action removes a tag from an Amazon FSx resource.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { FSxClient, UntagResourceCommand } from "@aws-sdk/client-fsx"; // ES Modules import + * // const { FSxClient, UntagResourceCommand } = require("@aws-sdk/client-fsx"); // CommonJS import + * const client = new FSxClient(config); + * const command = new UntagResourceCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link UntagResourceCommandInput} for command's `input` shape. + * @see {@link UntagResourceCommandOutput} for command's `response` shape. + * @see {@link FSxClientResolvedConfig | config} for command's `input` shape. + * */ export class UntagResourceCommand extends $Command< UntagResourceCommandInput, diff --git a/clients/client-fsx/commands/UpdateFileSystemCommand.ts b/clients/client-fsx/commands/UpdateFileSystemCommand.ts index 447db8164f08..579b7b979a91 100644 --- a/clients/client-fsx/commands/UpdateFileSystemCommand.ts +++ b/clients/client-fsx/commands/UpdateFileSystemCommand.ts @@ -64,6 +64,20 @@ export interface UpdateFileSystemCommandOutput extends UpdateFileSystemResponse, *

WeeklyMaintenanceStartTime

* * + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { FSxClient, UpdateFileSystemCommand } from "@aws-sdk/client-fsx"; // ES Modules import + * // const { FSxClient, UpdateFileSystemCommand } = require("@aws-sdk/client-fsx"); // CommonJS import + * const client = new FSxClient(config); + * const command = new UpdateFileSystemCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link UpdateFileSystemCommandInput} for command's `input` shape. + * @see {@link UpdateFileSystemCommandOutput} for command's `response` shape. + * @see {@link FSxClientResolvedConfig | config} for command's `input` shape. + * */ export class UpdateFileSystemCommand extends $Command< UpdateFileSystemCommandInput, diff --git a/clients/client-fsx/models/models_0.ts b/clients/client-fsx/models/models_0.ts index 1fe993d8a9f9..61e35fa0f272 100644 --- a/clients/client-fsx/models/models_0.ts +++ b/clients/client-fsx/models/models_0.ts @@ -26,6 +26,9 @@ export interface ActiveDirectoryBackupAttributes { } export namespace ActiveDirectoryBackupAttributes { + /** + * @internal + */ export const filterSensitiveLog = (obj: ActiveDirectoryBackupAttributes): any => ({ ...obj, }); @@ -61,6 +64,9 @@ export interface ActiveDirectoryError extends __SmithyException, $MetadataBearer } export namespace ActiveDirectoryError { + /** + * @internal + */ export const filterSensitiveLog = (obj: ActiveDirectoryError): any => ({ ...obj, }); @@ -84,6 +90,9 @@ export interface AdministrativeActionFailureDetails { } export namespace AdministrativeActionFailureDetails { + /** + * @internal + */ export const filterSensitiveLog = (obj: AdministrativeActionFailureDetails): any => ({ ...obj, }); @@ -109,6 +118,9 @@ export interface FileSystemFailureDetails { } export namespace FileSystemFailureDetails { + /** + * @internal + */ export const filterSensitiveLog = (obj: FileSystemFailureDetails): any => ({ ...obj, }); @@ -146,6 +158,9 @@ export interface DataRepositoryFailureDetails { } export namespace DataRepositoryFailureDetails { + /** + * @internal + */ export const filterSensitiveLog = (obj: DataRepositoryFailureDetails): any => ({ ...obj, }); @@ -257,6 +272,9 @@ export interface DataRepositoryConfiguration { } export namespace DataRepositoryConfiguration { + /** + * @internal + */ export const filterSensitiveLog = (obj: DataRepositoryConfiguration): any => ({ ...obj, }); @@ -358,6 +376,9 @@ export interface LustreFileSystemConfiguration { } export namespace LustreFileSystemConfiguration { + /** + * @internal + */ export const filterSensitiveLog = (obj: LustreFileSystemConfiguration): any => ({ ...obj, }); @@ -388,6 +409,9 @@ export interface Tag { } export namespace Tag { + /** + * @internal + */ export const filterSensitiveLog = (obj: Tag): any => ({ ...obj, }); @@ -454,6 +478,9 @@ export interface Alias { } export namespace Alias { + /** + * @internal + */ export const filterSensitiveLog = (obj: Alias): any => ({ ...obj, }); @@ -506,6 +533,9 @@ export interface SelfManagedActiveDirectoryAttributes { } export namespace SelfManagedActiveDirectoryAttributes { + /** + * @internal + */ export const filterSensitiveLog = (obj: SelfManagedActiveDirectoryAttributes): any => ({ ...obj, }); @@ -633,6 +663,9 @@ export interface WindowsFileSystemConfiguration { } export namespace WindowsFileSystemConfiguration { + /** + * @internal + */ export const filterSensitiveLog = (obj: WindowsFileSystemConfiguration): any => ({ ...obj, }); @@ -681,6 +714,9 @@ export interface AssociateFileSystemAliasesRequest { } export namespace AssociateFileSystemAliasesRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: AssociateFileSystemAliasesRequest): any => ({ ...obj, }); @@ -702,6 +738,9 @@ export interface AssociateFileSystemAliasesResponse { } export namespace AssociateFileSystemAliasesResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: AssociateFileSystemAliasesResponse): any => ({ ...obj, }); @@ -720,6 +759,9 @@ export interface BadRequest extends __SmithyException, $MetadataBearer { } export namespace BadRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: BadRequest): any => ({ ...obj, }); @@ -738,6 +780,9 @@ export interface FileSystemNotFound extends __SmithyException, $MetadataBearer { } export namespace FileSystemNotFound { + /** + * @internal + */ export const filterSensitiveLog = (obj: FileSystemNotFound): any => ({ ...obj, }); @@ -756,6 +801,9 @@ export interface InternalServerError extends __SmithyException, $MetadataBearer } export namespace InternalServerError { + /** + * @internal + */ export const filterSensitiveLog = (obj: InternalServerError): any => ({ ...obj, }); @@ -772,6 +820,9 @@ export interface CancelDataRepositoryTaskRequest { } export namespace CancelDataRepositoryTaskRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: CancelDataRepositoryTaskRequest): any => ({ ...obj, }); @@ -826,6 +877,9 @@ export interface CancelDataRepositoryTaskResponse { } export namespace CancelDataRepositoryTaskResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: CancelDataRepositoryTaskResponse): any => ({ ...obj, }); @@ -844,6 +898,9 @@ export interface DataRepositoryTaskEnded extends __SmithyException, $MetadataBea } export namespace DataRepositoryTaskEnded { + /** + * @internal + */ export const filterSensitiveLog = (obj: DataRepositoryTaskEnded): any => ({ ...obj, }); @@ -862,6 +919,9 @@ export interface DataRepositoryTaskNotFound extends __SmithyException, $Metadata } export namespace DataRepositoryTaskNotFound { + /** + * @internal + */ export const filterSensitiveLog = (obj: DataRepositoryTaskNotFound): any => ({ ...obj, }); @@ -880,6 +940,9 @@ export interface UnsupportedOperation extends __SmithyException, $MetadataBearer } export namespace UnsupportedOperation { + /** + * @internal + */ export const filterSensitiveLog = (obj: UnsupportedOperation): any => ({ ...obj, }); @@ -898,6 +961,9 @@ export interface BackupNotFound extends __SmithyException, $MetadataBearer { } export namespace BackupNotFound { + /** + * @internal + */ export const filterSensitiveLog = (obj: BackupNotFound): any => ({ ...obj, }); @@ -954,6 +1020,9 @@ export interface CopyBackupRequest { } export namespace CopyBackupRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: CopyBackupRequest): any => ({ ...obj, }); @@ -971,6 +1040,9 @@ export interface BackupFailureDetails { } export namespace BackupFailureDetails { + /** + * @internal + */ export const filterSensitiveLog = (obj: BackupFailureDetails): any => ({ ...obj, }); @@ -1012,6 +1084,9 @@ export interface IncompatibleParameterError extends __SmithyException, $Metadata } export namespace IncompatibleParameterError { + /** + * @internal + */ export const filterSensitiveLog = (obj: IncompatibleParameterError): any => ({ ...obj, }); @@ -1032,6 +1107,9 @@ export interface IncompatibleRegionForMultiAZ extends __SmithyException, $Metada } export namespace IncompatibleRegionForMultiAZ { + /** + * @internal + */ export const filterSensitiveLog = (obj: IncompatibleRegionForMultiAZ): any => ({ ...obj, }); @@ -1051,6 +1129,9 @@ export interface InvalidDestinationKmsKey extends __SmithyException, $MetadataBe } export namespace InvalidDestinationKmsKey { + /** + * @internal + */ export const filterSensitiveLog = (obj: InvalidDestinationKmsKey): any => ({ ...obj, }); @@ -1070,6 +1151,9 @@ export interface InvalidRegion extends __SmithyException, $MetadataBearer { } export namespace InvalidRegion { + /** + * @internal + */ export const filterSensitiveLog = (obj: InvalidRegion): any => ({ ...obj, }); @@ -1089,6 +1173,9 @@ export interface InvalidSourceKmsKey extends __SmithyException, $MetadataBearer } export namespace InvalidSourceKmsKey { + /** + * @internal + */ export const filterSensitiveLog = (obj: InvalidSourceKmsKey): any => ({ ...obj, }); @@ -1123,6 +1210,9 @@ export interface ServiceLimitExceeded extends __SmithyException, $MetadataBearer } export namespace ServiceLimitExceeded { + /** + * @internal + */ export const filterSensitiveLog = (obj: ServiceLimitExceeded): any => ({ ...obj, }); @@ -1147,6 +1237,9 @@ export interface SourceBackupUnavailable extends __SmithyException, $MetadataBea } export namespace SourceBackupUnavailable { + /** + * @internal + */ export const filterSensitiveLog = (obj: SourceBackupUnavailable): any => ({ ...obj, }); @@ -1166,6 +1259,9 @@ export interface BackupInProgress extends __SmithyException, $MetadataBearer { } export namespace BackupInProgress { + /** + * @internal + */ export const filterSensitiveLog = (obj: BackupInProgress): any => ({ ...obj, }); @@ -1196,6 +1292,9 @@ export interface CreateBackupRequest { } export namespace CreateBackupRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateBackupRequest): any => ({ ...obj, }); @@ -1248,6 +1347,9 @@ export interface CompletionReport { } export namespace CompletionReport { + /** + * @internal + */ export const filterSensitiveLog = (obj: CompletionReport): any => ({ ...obj, }); @@ -1299,6 +1401,9 @@ export interface CreateDataRepositoryTaskRequest { } export namespace CreateDataRepositoryTaskRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateDataRepositoryTaskRequest): any => ({ ...obj, }); @@ -1315,6 +1420,9 @@ export interface DataRepositoryTaskFailureDetails { } export namespace DataRepositoryTaskFailureDetails { + /** + * @internal + */ export const filterSensitiveLog = (obj: DataRepositoryTaskFailureDetails): any => ({ ...obj, }); @@ -1349,6 +1457,9 @@ export interface DataRepositoryTaskStatus { } export namespace DataRepositoryTaskStatus { + /** + * @internal + */ export const filterSensitiveLog = (obj: DataRepositoryTaskStatus): any => ({ ...obj, }); @@ -1470,6 +1581,9 @@ export interface DataRepositoryTask { } export namespace DataRepositoryTask { + /** + * @internal + */ export const filterSensitiveLog = (obj: DataRepositoryTask): any => ({ ...obj, }); @@ -1483,6 +1597,9 @@ export interface CreateDataRepositoryTaskResponse { } export namespace CreateDataRepositoryTaskResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateDataRepositoryTaskResponse): any => ({ ...obj, }); @@ -1502,6 +1619,9 @@ export interface DataRepositoryTaskExecuting extends __SmithyException, $Metadat } export namespace DataRepositoryTaskExecuting { + /** + * @internal + */ export const filterSensitiveLog = (obj: DataRepositoryTaskExecuting): any => ({ ...obj, }); @@ -1664,6 +1784,9 @@ export interface CreateFileSystemLustreConfiguration { } export namespace CreateFileSystemLustreConfiguration { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateFileSystemLustreConfiguration): any => ({ ...obj, }); @@ -1729,6 +1852,9 @@ export interface SelfManagedActiveDirectoryConfiguration { } export namespace SelfManagedActiveDirectoryConfiguration { + /** + * @internal + */ export const filterSensitiveLog = (obj: SelfManagedActiveDirectoryConfiguration): any => ({ ...obj, ...(obj.Password && { Password: SENSITIVE_STRING }), @@ -1857,6 +1983,9 @@ export interface CreateFileSystemWindowsConfiguration { } export namespace CreateFileSystemWindowsConfiguration { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateFileSystemWindowsConfiguration): any => ({ ...obj, ...(obj.SelfManagedActiveDirectoryConfiguration && { @@ -1986,6 +2115,9 @@ export interface CreateFileSystemRequest { } export namespace CreateFileSystemRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateFileSystemRequest): any => ({ ...obj, ...(obj.WindowsConfiguration && { @@ -2007,6 +2139,9 @@ export interface InvalidExportPath extends __SmithyException, $MetadataBearer { } export namespace InvalidExportPath { + /** + * @internal + */ export const filterSensitiveLog = (obj: InvalidExportPath): any => ({ ...obj, }); @@ -2025,6 +2160,9 @@ export interface InvalidImportPath extends __SmithyException, $MetadataBearer { } export namespace InvalidImportPath { + /** + * @internal + */ export const filterSensitiveLog = (obj: InvalidImportPath): any => ({ ...obj, }); @@ -2065,6 +2203,9 @@ export interface InvalidNetworkSettings extends __SmithyException, $MetadataBear } export namespace InvalidNetworkSettings { + /** + * @internal + */ export const filterSensitiveLog = (obj: InvalidNetworkSettings): any => ({ ...obj, }); @@ -2083,6 +2224,9 @@ export interface InvalidPerUnitStorageThroughput extends __SmithyException, $Met } export namespace InvalidPerUnitStorageThroughput { + /** + * @internal + */ export const filterSensitiveLog = (obj: InvalidPerUnitStorageThroughput): any => ({ ...obj, }); @@ -2101,6 +2245,9 @@ export interface MissingFileSystemConfiguration extends __SmithyException, $Meta } export namespace MissingFileSystemConfiguration { + /** + * @internal + */ export const filterSensitiveLog = (obj: MissingFileSystemConfiguration): any => ({ ...obj, }); @@ -2198,6 +2345,9 @@ export interface CreateFileSystemFromBackupRequest { } export namespace CreateFileSystemFromBackupRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateFileSystemFromBackupRequest): any => ({ ...obj, ...(obj.WindowsConfiguration && { @@ -2224,6 +2374,9 @@ export interface BackupBeingCopied extends __SmithyException, $MetadataBearer { } export namespace BackupBeingCopied { + /** + * @internal + */ export const filterSensitiveLog = (obj: BackupBeingCopied): any => ({ ...obj, }); @@ -2248,6 +2401,9 @@ export interface BackupRestoring extends __SmithyException, $MetadataBearer { } export namespace BackupRestoring { + /** + * @internal + */ export const filterSensitiveLog = (obj: BackupRestoring): any => ({ ...obj, }); @@ -2271,6 +2427,9 @@ export interface DeleteBackupRequest { } export namespace DeleteBackupRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteBackupRequest): any => ({ ...obj, }); @@ -2292,6 +2451,9 @@ export interface DeleteBackupResponse { } export namespace DeleteBackupResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteBackupResponse): any => ({ ...obj, }); @@ -2319,6 +2481,9 @@ export interface DeleteFileSystemLustreConfiguration { } export namespace DeleteFileSystemLustreConfiguration { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteFileSystemLustreConfiguration): any => ({ ...obj, }); @@ -2344,6 +2509,9 @@ export interface DeleteFileSystemWindowsConfiguration { } export namespace DeleteFileSystemWindowsConfiguration { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteFileSystemWindowsConfiguration): any => ({ ...obj, }); @@ -2379,6 +2547,9 @@ export interface DeleteFileSystemRequest { } export namespace DeleteFileSystemRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteFileSystemRequest): any => ({ ...obj, }); @@ -2401,6 +2572,9 @@ export interface DeleteFileSystemLustreResponse { } export namespace DeleteFileSystemLustreResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteFileSystemLustreResponse): any => ({ ...obj, }); @@ -2423,6 +2597,9 @@ export interface DeleteFileSystemWindowsResponse { } export namespace DeleteFileSystemWindowsResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteFileSystemWindowsResponse): any => ({ ...obj, }); @@ -2457,6 +2634,9 @@ export interface DeleteFileSystemResponse { } export namespace DeleteFileSystemResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteFileSystemResponse): any => ({ ...obj, }); @@ -2486,6 +2666,9 @@ export interface Filter { } export namespace Filter { + /** + * @internal + */ export const filterSensitiveLog = (obj: Filter): any => ({ ...obj, }); @@ -2524,6 +2707,9 @@ export interface DescribeBackupsRequest { } export namespace DescribeBackupsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeBackupsRequest): any => ({ ...obj, }); @@ -2562,6 +2748,9 @@ export interface DataRepositoryTaskFilter { } export namespace DataRepositoryTaskFilter { + /** + * @internal + */ export const filterSensitiveLog = (obj: DataRepositoryTaskFilter): any => ({ ...obj, }); @@ -2595,6 +2784,9 @@ export interface DescribeDataRepositoryTasksRequest { } export namespace DescribeDataRepositoryTasksRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeDataRepositoryTasksRequest): any => ({ ...obj, }); @@ -2615,6 +2807,9 @@ export interface DescribeDataRepositoryTasksResponse { } export namespace DescribeDataRepositoryTasksResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeDataRepositoryTasksResponse): any => ({ ...obj, }); @@ -2654,6 +2849,9 @@ export interface DescribeFileSystemAliasesRequest { } export namespace DescribeFileSystemAliasesRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeFileSystemAliasesRequest): any => ({ ...obj, }); @@ -2677,6 +2875,9 @@ export interface DescribeFileSystemAliasesResponse { } export namespace DescribeFileSystemAliasesResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeFileSystemAliasesResponse): any => ({ ...obj, }); @@ -2709,6 +2910,9 @@ export interface DescribeFileSystemsRequest { } export namespace DescribeFileSystemsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeFileSystemsRequest): any => ({ ...obj, }); @@ -2737,6 +2941,9 @@ export interface DisassociateFileSystemAliasesRequest { } export namespace DisassociateFileSystemAliasesRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DisassociateFileSystemAliasesRequest): any => ({ ...obj, }); @@ -2754,6 +2961,9 @@ export interface DisassociateFileSystemAliasesResponse { } export namespace DisassociateFileSystemAliasesResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DisassociateFileSystemAliasesResponse): any => ({ ...obj, }); @@ -2785,6 +2995,9 @@ export interface ListTagsForResourceRequest { } export namespace ListTagsForResourceRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListTagsForResourceRequest): any => ({ ...obj, }); @@ -2808,6 +3021,9 @@ export interface ListTagsForResourceResponse { } export namespace ListTagsForResourceResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListTagsForResourceResponse): any => ({ ...obj, }); @@ -2832,6 +3048,9 @@ export interface NotServiceResourceError extends __SmithyException, $MetadataBea } export namespace NotServiceResourceError { + /** + * @internal + */ export const filterSensitiveLog = (obj: NotServiceResourceError): any => ({ ...obj, }); @@ -2856,6 +3075,9 @@ export interface ResourceDoesNotSupportTagging extends __SmithyException, $Metad } export namespace ResourceDoesNotSupportTagging { + /** + * @internal + */ export const filterSensitiveLog = (obj: ResourceDoesNotSupportTagging): any => ({ ...obj, }); @@ -2879,6 +3101,9 @@ export interface ResourceNotFound extends __SmithyException, $MetadataBearer { } export namespace ResourceNotFound { + /** + * @internal + */ export const filterSensitiveLog = (obj: ResourceNotFound): any => ({ ...obj, }); @@ -2902,6 +3127,9 @@ export interface TagResourceRequest { } export namespace TagResourceRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: TagResourceRequest): any => ({ ...obj, }); @@ -2913,6 +3141,9 @@ export namespace TagResourceRequest { export interface TagResourceResponse {} export namespace TagResourceResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: TagResourceResponse): any => ({ ...obj, }); @@ -2935,6 +3166,9 @@ export interface UntagResourceRequest { } export namespace UntagResourceRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: UntagResourceRequest): any => ({ ...obj, }); @@ -2946,6 +3180,9 @@ export namespace UntagResourceRequest { export interface UntagResourceResponse {} export namespace UntagResourceResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: UntagResourceResponse): any => ({ ...obj, }); @@ -3008,6 +3245,9 @@ export interface UpdateFileSystemLustreConfiguration { } export namespace UpdateFileSystemLustreConfiguration { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateFileSystemLustreConfiguration): any => ({ ...obj, }); @@ -3040,6 +3280,9 @@ export interface SelfManagedActiveDirectoryConfigurationUpdates { } export namespace SelfManagedActiveDirectoryConfigurationUpdates { + /** + * @internal + */ export const filterSensitiveLog = (obj: SelfManagedActiveDirectoryConfigurationUpdates): any => ({ ...obj, ...(obj.Password && { Password: SENSITIVE_STRING }), @@ -3086,6 +3329,9 @@ export interface UpdateFileSystemWindowsConfiguration { } export namespace UpdateFileSystemWindowsConfiguration { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateFileSystemWindowsConfiguration): any => ({ ...obj, ...(obj.SelfManagedActiveDirectoryConfiguration && { @@ -3155,6 +3401,9 @@ export interface UpdateFileSystemRequest { } export namespace UpdateFileSystemRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateFileSystemRequest): any => ({ ...obj, ...(obj.WindowsConfiguration && { @@ -3277,6 +3526,9 @@ export interface AdministrativeAction { } export namespace AdministrativeAction { + /** + * @internal + */ export const filterSensitiveLog = (obj: AdministrativeAction): any => ({ ...obj, }); @@ -3436,6 +3688,9 @@ export interface FileSystem { } export namespace FileSystem { + /** + * @internal + */ export const filterSensitiveLog = (obj: FileSystem): any => ({ ...obj, }); @@ -3552,6 +3807,9 @@ export interface Backup { } export namespace Backup { + /** + * @internal + */ export const filterSensitiveLog = (obj: Backup): any => ({ ...obj, }); @@ -3569,6 +3827,9 @@ export interface CreateFileSystemFromBackupResponse { } export namespace CreateFileSystemFromBackupResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateFileSystemFromBackupResponse): any => ({ ...obj, }); @@ -3585,6 +3846,9 @@ export interface CreateFileSystemResponse { } export namespace CreateFileSystemResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateFileSystemResponse): any => ({ ...obj, }); @@ -3601,6 +3865,9 @@ export interface UpdateFileSystemResponse { } export namespace UpdateFileSystemResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateFileSystemResponse): any => ({ ...obj, }); @@ -3614,6 +3881,9 @@ export interface CopyBackupResponse { } export namespace CopyBackupResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: CopyBackupResponse): any => ({ ...obj, }); @@ -3630,6 +3900,9 @@ export interface CreateBackupResponse { } export namespace CreateBackupResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateBackupResponse): any => ({ ...obj, }); @@ -3653,6 +3926,9 @@ export interface DescribeFileSystemsResponse { } export namespace DescribeFileSystemsResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeFileSystemsResponse): any => ({ ...obj, }); @@ -3676,6 +3952,9 @@ export interface DescribeBackupsResponse { } export namespace DescribeBackupsResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeBackupsResponse): any => ({ ...obj, }); diff --git a/clients/client-gamelift/commands/AcceptMatchCommand.ts b/clients/client-gamelift/commands/AcceptMatchCommand.ts index 1124eb138a21..e8ebd03b514f 100644 --- a/clients/client-gamelift/commands/AcceptMatchCommand.ts +++ b/clients/client-gamelift/commands/AcceptMatchCommand.ts @@ -60,6 +60,20 @@ export interface AcceptMatchCommandOutput extends AcceptMatchOutput, __MetadataB * StartMatchBackfill | * All APIs by task *

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { GameLiftClient, AcceptMatchCommand } from "@aws-sdk/client-gamelift"; // ES Modules import + * // const { GameLiftClient, AcceptMatchCommand } = require("@aws-sdk/client-gamelift"); // CommonJS import + * const client = new GameLiftClient(config); + * const command = new AcceptMatchCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link AcceptMatchCommandInput} for command's `input` shape. + * @see {@link AcceptMatchCommandOutput} for command's `response` shape. + * @see {@link GameLiftClientResolvedConfig | config} for command's `input` shape. + * */ export class AcceptMatchCommand extends $Command< AcceptMatchCommandInput, diff --git a/clients/client-gamelift/commands/ClaimGameServerCommand.ts b/clients/client-gamelift/commands/ClaimGameServerCommand.ts index b40d6707e4a0..200674473d04 100644 --- a/clients/client-gamelift/commands/ClaimGameServerCommand.ts +++ b/clients/client-gamelift/commands/ClaimGameServerCommand.ts @@ -74,6 +74,20 @@ export interface ClaimGameServerCommandOutput extends ClaimGameServerOutput, __M * DeregisterGameServer | * All APIs by task *

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { GameLiftClient, ClaimGameServerCommand } from "@aws-sdk/client-gamelift"; // ES Modules import + * // const { GameLiftClient, ClaimGameServerCommand } = require("@aws-sdk/client-gamelift"); // CommonJS import + * const client = new GameLiftClient(config); + * const command = new ClaimGameServerCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ClaimGameServerCommandInput} for command's `input` shape. + * @see {@link ClaimGameServerCommandOutput} for command's `response` shape. + * @see {@link GameLiftClientResolvedConfig | config} for command's `input` shape. + * */ export class ClaimGameServerCommand extends $Command< ClaimGameServerCommandInput, diff --git a/clients/client-gamelift/commands/CreateAliasCommand.ts b/clients/client-gamelift/commands/CreateAliasCommand.ts index f314f6cc1468..6e11268f00c0 100644 --- a/clients/client-gamelift/commands/CreateAliasCommand.ts +++ b/clients/client-gamelift/commands/CreateAliasCommand.ts @@ -47,6 +47,20 @@ export interface CreateAliasCommandOutput extends CreateAliasOutput, __MetadataB * ResolveAlias | * All APIs by task *

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { GameLiftClient, CreateAliasCommand } from "@aws-sdk/client-gamelift"; // ES Modules import + * // const { GameLiftClient, CreateAliasCommand } = require("@aws-sdk/client-gamelift"); // CommonJS import + * const client = new GameLiftClient(config); + * const command = new CreateAliasCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreateAliasCommandInput} for command's `input` shape. + * @see {@link CreateAliasCommandOutput} for command's `response` shape. + * @see {@link GameLiftClientResolvedConfig | config} for command's `input` shape. + * */ export class CreateAliasCommand extends $Command< CreateAliasCommandInput, diff --git a/clients/client-gamelift/commands/CreateBuildCommand.ts b/clients/client-gamelift/commands/CreateBuildCommand.ts index e61a4515ee31..980dc337ec77 100644 --- a/clients/client-gamelift/commands/CreateBuildCommand.ts +++ b/clients/client-gamelift/commands/CreateBuildCommand.ts @@ -75,6 +75,20 @@ export interface CreateBuildCommandOutput extends CreateBuildOutput, __MetadataB * DeleteBuild | * All APIs by task *

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { GameLiftClient, CreateBuildCommand } from "@aws-sdk/client-gamelift"; // ES Modules import + * // const { GameLiftClient, CreateBuildCommand } = require("@aws-sdk/client-gamelift"); // CommonJS import + * const client = new GameLiftClient(config); + * const command = new CreateBuildCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreateBuildCommandInput} for command's `input` shape. + * @see {@link CreateBuildCommandOutput} for command's `response` shape. + * @see {@link GameLiftClientResolvedConfig | config} for command's `input` shape. + * */ export class CreateBuildCommand extends $Command< CreateBuildCommandInput, diff --git a/clients/client-gamelift/commands/CreateFleetCommand.ts b/clients/client-gamelift/commands/CreateFleetCommand.ts index 65653ee222d8..1e6d0580eaed 100644 --- a/clients/client-gamelift/commands/CreateFleetCommand.ts +++ b/clients/client-gamelift/commands/CreateFleetCommand.ts @@ -73,6 +73,20 @@ export interface CreateFleetCommandOutput extends CreateFleetOutput, __MetadataB * DeleteFleet | * All APIs by task *

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { GameLiftClient, CreateFleetCommand } from "@aws-sdk/client-gamelift"; // ES Modules import + * // const { GameLiftClient, CreateFleetCommand } = require("@aws-sdk/client-gamelift"); // CommonJS import + * const client = new GameLiftClient(config); + * const command = new CreateFleetCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreateFleetCommandInput} for command's `input` shape. + * @see {@link CreateFleetCommandOutput} for command's `response` shape. + * @see {@link GameLiftClientResolvedConfig | config} for command's `input` shape. + * */ export class CreateFleetCommand extends $Command< CreateFleetCommandInput, diff --git a/clients/client-gamelift/commands/CreateFleetLocationsCommand.ts b/clients/client-gamelift/commands/CreateFleetLocationsCommand.ts index 10b56aed62ba..5f9b6e2b337a 100644 --- a/clients/client-gamelift/commands/CreateFleetLocationsCommand.ts +++ b/clients/client-gamelift/commands/CreateFleetLocationsCommand.ts @@ -64,6 +64,20 @@ export interface CreateFleetLocationsCommandOutput extends CreateFleetLocationsO * DeleteFleetLocations | * All APIs by task *

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { GameLiftClient, CreateFleetLocationsCommand } from "@aws-sdk/client-gamelift"; // ES Modules import + * // const { GameLiftClient, CreateFleetLocationsCommand } = require("@aws-sdk/client-gamelift"); // CommonJS import + * const client = new GameLiftClient(config); + * const command = new CreateFleetLocationsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreateFleetLocationsCommandInput} for command's `input` shape. + * @see {@link CreateFleetLocationsCommandOutput} for command's `response` shape. + * @see {@link GameLiftClientResolvedConfig | config} for command's `input` shape. + * */ export class CreateFleetLocationsCommand extends $Command< CreateFleetLocationsCommandInput, diff --git a/clients/client-gamelift/commands/CreateGameServerGroupCommand.ts b/clients/client-gamelift/commands/CreateGameServerGroupCommand.ts index b48f72b545dc..692f7fd489b9 100644 --- a/clients/client-gamelift/commands/CreateGameServerGroupCommand.ts +++ b/clients/client-gamelift/commands/CreateGameServerGroupCommand.ts @@ -75,6 +75,20 @@ export interface CreateGameServerGroupCommandOutput extends CreateGameServerGrou * DescribeGameServerInstances | * All APIs by task *

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { GameLiftClient, CreateGameServerGroupCommand } from "@aws-sdk/client-gamelift"; // ES Modules import + * // const { GameLiftClient, CreateGameServerGroupCommand } = require("@aws-sdk/client-gamelift"); // CommonJS import + * const client = new GameLiftClient(config); + * const command = new CreateGameServerGroupCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreateGameServerGroupCommandInput} for command's `input` shape. + * @see {@link CreateGameServerGroupCommandOutput} for command's `response` shape. + * @see {@link GameLiftClientResolvedConfig | config} for command's `input` shape. + * */ export class CreateGameServerGroupCommand extends $Command< CreateGameServerGroupCommandInput, diff --git a/clients/client-gamelift/commands/CreateGameSessionCommand.ts b/clients/client-gamelift/commands/CreateGameSessionCommand.ts index c3d98f0666dc..65bf1a446183 100644 --- a/clients/client-gamelift/commands/CreateGameSessionCommand.ts +++ b/clients/client-gamelift/commands/CreateGameSessionCommand.ts @@ -75,6 +75,20 @@ export interface CreateGameSessionCommandOutput extends CreateGameSessionOutput, * StopGameSessionPlacement | * All APIs by task *

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { GameLiftClient, CreateGameSessionCommand } from "@aws-sdk/client-gamelift"; // ES Modules import + * // const { GameLiftClient, CreateGameSessionCommand } = require("@aws-sdk/client-gamelift"); // CommonJS import + * const client = new GameLiftClient(config); + * const command = new CreateGameSessionCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreateGameSessionCommandInput} for command's `input` shape. + * @see {@link CreateGameSessionCommandOutput} for command's `response` shape. + * @see {@link GameLiftClientResolvedConfig | config} for command's `input` shape. + * */ export class CreateGameSessionCommand extends $Command< CreateGameSessionCommandInput, diff --git a/clients/client-gamelift/commands/CreateGameSessionQueueCommand.ts b/clients/client-gamelift/commands/CreateGameSessionQueueCommand.ts index a092bd3c73f7..d2ddf5c7dc9d 100644 --- a/clients/client-gamelift/commands/CreateGameSessionQueueCommand.ts +++ b/clients/client-gamelift/commands/CreateGameSessionQueueCommand.ts @@ -65,6 +65,20 @@ export interface CreateGameSessionQueueCommandOutput extends CreateGameSessionQu * DeleteGameSessionQueue | * All APIs by task *

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { GameLiftClient, CreateGameSessionQueueCommand } from "@aws-sdk/client-gamelift"; // ES Modules import + * // const { GameLiftClient, CreateGameSessionQueueCommand } = require("@aws-sdk/client-gamelift"); // CommonJS import + * const client = new GameLiftClient(config); + * const command = new CreateGameSessionQueueCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreateGameSessionQueueCommandInput} for command's `input` shape. + * @see {@link CreateGameSessionQueueCommandOutput} for command's `response` shape. + * @see {@link GameLiftClientResolvedConfig | config} for command's `input` shape. + * */ export class CreateGameSessionQueueCommand extends $Command< CreateGameSessionQueueCommandInput, diff --git a/clients/client-gamelift/commands/CreateMatchmakingConfigurationCommand.ts b/clients/client-gamelift/commands/CreateMatchmakingConfigurationCommand.ts index f4ab1e485770..cbf4e0826708 100644 --- a/clients/client-gamelift/commands/CreateMatchmakingConfigurationCommand.ts +++ b/clients/client-gamelift/commands/CreateMatchmakingConfigurationCommand.ts @@ -65,6 +65,20 @@ export interface CreateMatchmakingConfigurationCommandOutput * DeleteMatchmakingRuleSet | * All APIs by task *

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { GameLiftClient, CreateMatchmakingConfigurationCommand } from "@aws-sdk/client-gamelift"; // ES Modules import + * // const { GameLiftClient, CreateMatchmakingConfigurationCommand } = require("@aws-sdk/client-gamelift"); // CommonJS import + * const client = new GameLiftClient(config); + * const command = new CreateMatchmakingConfigurationCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreateMatchmakingConfigurationCommandInput} for command's `input` shape. + * @see {@link CreateMatchmakingConfigurationCommandOutput} for command's `response` shape. + * @see {@link GameLiftClientResolvedConfig | config} for command's `input` shape. + * */ export class CreateMatchmakingConfigurationCommand extends $Command< CreateMatchmakingConfigurationCommandInput, diff --git a/clients/client-gamelift/commands/CreateMatchmakingRuleSetCommand.ts b/clients/client-gamelift/commands/CreateMatchmakingRuleSetCommand.ts index d25372e71e2d..b159d211bfd9 100644 --- a/clients/client-gamelift/commands/CreateMatchmakingRuleSetCommand.ts +++ b/clients/client-gamelift/commands/CreateMatchmakingRuleSetCommand.ts @@ -68,6 +68,20 @@ export interface CreateMatchmakingRuleSetCommandOutput extends CreateMatchmaking * DeleteMatchmakingRuleSet | * All APIs by task *

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { GameLiftClient, CreateMatchmakingRuleSetCommand } from "@aws-sdk/client-gamelift"; // ES Modules import + * // const { GameLiftClient, CreateMatchmakingRuleSetCommand } = require("@aws-sdk/client-gamelift"); // CommonJS import + * const client = new GameLiftClient(config); + * const command = new CreateMatchmakingRuleSetCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreateMatchmakingRuleSetCommandInput} for command's `input` shape. + * @see {@link CreateMatchmakingRuleSetCommandOutput} for command's `response` shape. + * @see {@link GameLiftClientResolvedConfig | config} for command's `input` shape. + * */ export class CreateMatchmakingRuleSetCommand extends $Command< CreateMatchmakingRuleSetCommandInput, diff --git a/clients/client-gamelift/commands/CreatePlayerSessionCommand.ts b/clients/client-gamelift/commands/CreatePlayerSessionCommand.ts index e41af6423473..57edc351980d 100644 --- a/clients/client-gamelift/commands/CreatePlayerSessionCommand.ts +++ b/clients/client-gamelift/commands/CreatePlayerSessionCommand.ts @@ -45,6 +45,20 @@ export interface CreatePlayerSessionCommandOutput extends CreatePlayerSessionOut * DescribeGameSessionPlacement | * All APIs by task *

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { GameLiftClient, CreatePlayerSessionCommand } from "@aws-sdk/client-gamelift"; // ES Modules import + * // const { GameLiftClient, CreatePlayerSessionCommand } = require("@aws-sdk/client-gamelift"); // CommonJS import + * const client = new GameLiftClient(config); + * const command = new CreatePlayerSessionCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreatePlayerSessionCommandInput} for command's `input` shape. + * @see {@link CreatePlayerSessionCommandOutput} for command's `response` shape. + * @see {@link GameLiftClientResolvedConfig | config} for command's `input` shape. + * */ export class CreatePlayerSessionCommand extends $Command< CreatePlayerSessionCommandInput, diff --git a/clients/client-gamelift/commands/CreatePlayerSessionsCommand.ts b/clients/client-gamelift/commands/CreatePlayerSessionsCommand.ts index ae0e665b6b3a..e661d8c8a477 100644 --- a/clients/client-gamelift/commands/CreatePlayerSessionsCommand.ts +++ b/clients/client-gamelift/commands/CreatePlayerSessionsCommand.ts @@ -45,6 +45,20 @@ export interface CreatePlayerSessionsCommandOutput extends CreatePlayerSessionsO * DescribeGameSessionPlacement | * All APIs by task *

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { GameLiftClient, CreatePlayerSessionsCommand } from "@aws-sdk/client-gamelift"; // ES Modules import + * // const { GameLiftClient, CreatePlayerSessionsCommand } = require("@aws-sdk/client-gamelift"); // CommonJS import + * const client = new GameLiftClient(config); + * const command = new CreatePlayerSessionsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreatePlayerSessionsCommandInput} for command's `input` shape. + * @see {@link CreatePlayerSessionsCommandOutput} for command's `response` shape. + * @see {@link GameLiftClientResolvedConfig | config} for command's `input` shape. + * */ export class CreatePlayerSessionsCommand extends $Command< CreatePlayerSessionsCommandInput, diff --git a/clients/client-gamelift/commands/CreateScriptCommand.ts b/clients/client-gamelift/commands/CreateScriptCommand.ts index 7f25d6bd33af..0633d25b625a 100644 --- a/clients/client-gamelift/commands/CreateScriptCommand.ts +++ b/clients/client-gamelift/commands/CreateScriptCommand.ts @@ -65,6 +65,20 @@ export interface CreateScriptCommandOutput extends CreateScriptOutput, __Metadat * DeleteScript | * All APIs by task *

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { GameLiftClient, CreateScriptCommand } from "@aws-sdk/client-gamelift"; // ES Modules import + * // const { GameLiftClient, CreateScriptCommand } = require("@aws-sdk/client-gamelift"); // CommonJS import + * const client = new GameLiftClient(config); + * const command = new CreateScriptCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreateScriptCommandInput} for command's `input` shape. + * @see {@link CreateScriptCommandOutput} for command's `response` shape. + * @see {@link GameLiftClientResolvedConfig | config} for command's `input` shape. + * */ export class CreateScriptCommand extends $Command< CreateScriptCommandInput, diff --git a/clients/client-gamelift/commands/CreateVpcPeeringAuthorizationCommand.ts b/clients/client-gamelift/commands/CreateVpcPeeringAuthorizationCommand.ts index 52ddf4534e8e..b901fbf69518 100644 --- a/clients/client-gamelift/commands/CreateVpcPeeringAuthorizationCommand.ts +++ b/clients/client-gamelift/commands/CreateVpcPeeringAuthorizationCommand.ts @@ -57,6 +57,20 @@ export interface CreateVpcPeeringAuthorizationCommandOutput * DeleteVpcPeeringConnection | * All APIs by task *

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { GameLiftClient, CreateVpcPeeringAuthorizationCommand } from "@aws-sdk/client-gamelift"; // ES Modules import + * // const { GameLiftClient, CreateVpcPeeringAuthorizationCommand } = require("@aws-sdk/client-gamelift"); // CommonJS import + * const client = new GameLiftClient(config); + * const command = new CreateVpcPeeringAuthorizationCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreateVpcPeeringAuthorizationCommandInput} for command's `input` shape. + * @see {@link CreateVpcPeeringAuthorizationCommandOutput} for command's `response` shape. + * @see {@link GameLiftClientResolvedConfig | config} for command's `input` shape. + * */ export class CreateVpcPeeringAuthorizationCommand extends $Command< CreateVpcPeeringAuthorizationCommandInput, diff --git a/clients/client-gamelift/commands/CreateVpcPeeringConnectionCommand.ts b/clients/client-gamelift/commands/CreateVpcPeeringConnectionCommand.ts index c82861a37985..fa24adbcbc0f 100644 --- a/clients/client-gamelift/commands/CreateVpcPeeringConnectionCommand.ts +++ b/clients/client-gamelift/commands/CreateVpcPeeringConnectionCommand.ts @@ -52,6 +52,20 @@ export interface CreateVpcPeeringConnectionCommandOutput extends CreateVpcPeerin * DeleteVpcPeeringConnection | * All APIs by task *

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { GameLiftClient, CreateVpcPeeringConnectionCommand } from "@aws-sdk/client-gamelift"; // ES Modules import + * // const { GameLiftClient, CreateVpcPeeringConnectionCommand } = require("@aws-sdk/client-gamelift"); // CommonJS import + * const client = new GameLiftClient(config); + * const command = new CreateVpcPeeringConnectionCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreateVpcPeeringConnectionCommandInput} for command's `input` shape. + * @see {@link CreateVpcPeeringConnectionCommandOutput} for command's `response` shape. + * @see {@link GameLiftClientResolvedConfig | config} for command's `input` shape. + * */ export class CreateVpcPeeringConnectionCommand extends $Command< CreateVpcPeeringConnectionCommandInput, diff --git a/clients/client-gamelift/commands/DeleteAliasCommand.ts b/clients/client-gamelift/commands/DeleteAliasCommand.ts index f8e2701d0d54..8e381868760b 100644 --- a/clients/client-gamelift/commands/DeleteAliasCommand.ts +++ b/clients/client-gamelift/commands/DeleteAliasCommand.ts @@ -36,6 +36,20 @@ export interface DeleteAliasCommandOutput extends __MetadataBearer {} * ResolveAlias | * All APIs by task *

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { GameLiftClient, DeleteAliasCommand } from "@aws-sdk/client-gamelift"; // ES Modules import + * // const { GameLiftClient, DeleteAliasCommand } = require("@aws-sdk/client-gamelift"); // CommonJS import + * const client = new GameLiftClient(config); + * const command = new DeleteAliasCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteAliasCommandInput} for command's `input` shape. + * @see {@link DeleteAliasCommandOutput} for command's `response` shape. + * @see {@link GameLiftClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteAliasCommand extends $Command< DeleteAliasCommandInput, diff --git a/clients/client-gamelift/commands/DeleteBuildCommand.ts b/clients/client-gamelift/commands/DeleteBuildCommand.ts index 793af3312a3e..e7fe950d0234 100644 --- a/clients/client-gamelift/commands/DeleteBuildCommand.ts +++ b/clients/client-gamelift/commands/DeleteBuildCommand.ts @@ -43,6 +43,20 @@ export interface DeleteBuildCommandOutput extends __MetadataBearer {} * DeleteBuild | * All APIs by task *

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { GameLiftClient, DeleteBuildCommand } from "@aws-sdk/client-gamelift"; // ES Modules import + * // const { GameLiftClient, DeleteBuildCommand } = require("@aws-sdk/client-gamelift"); // CommonJS import + * const client = new GameLiftClient(config); + * const command = new DeleteBuildCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteBuildCommandInput} for command's `input` shape. + * @see {@link DeleteBuildCommandOutput} for command's `response` shape. + * @see {@link GameLiftClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteBuildCommand extends $Command< DeleteBuildCommandInput, diff --git a/clients/client-gamelift/commands/DeleteFleetCommand.ts b/clients/client-gamelift/commands/DeleteFleetCommand.ts index ae095d4bf13d..e01c1ca5b7f0 100644 --- a/clients/client-gamelift/commands/DeleteFleetCommand.ts +++ b/clients/client-gamelift/commands/DeleteFleetCommand.ts @@ -56,6 +56,20 @@ export interface DeleteFleetCommandOutput extends __MetadataBearer {} * DeleteScalingPolicy | * All APIs by task *

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { GameLiftClient, DeleteFleetCommand } from "@aws-sdk/client-gamelift"; // ES Modules import + * // const { GameLiftClient, DeleteFleetCommand } = require("@aws-sdk/client-gamelift"); // CommonJS import + * const client = new GameLiftClient(config); + * const command = new DeleteFleetCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteFleetCommandInput} for command's `input` shape. + * @see {@link DeleteFleetCommandOutput} for command's `response` shape. + * @see {@link GameLiftClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteFleetCommand extends $Command< DeleteFleetCommandInput, diff --git a/clients/client-gamelift/commands/DeleteFleetLocationsCommand.ts b/clients/client-gamelift/commands/DeleteFleetLocationsCommand.ts index d4fc16513d2f..6e8f2c542a92 100644 --- a/clients/client-gamelift/commands/DeleteFleetLocationsCommand.ts +++ b/clients/client-gamelift/commands/DeleteFleetLocationsCommand.ts @@ -50,6 +50,20 @@ export interface DeleteFleetLocationsCommandOutput extends DeleteFleetLocationsO * DeleteFleetLocations | * All APIs by task *

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { GameLiftClient, DeleteFleetLocationsCommand } from "@aws-sdk/client-gamelift"; // ES Modules import + * // const { GameLiftClient, DeleteFleetLocationsCommand } = require("@aws-sdk/client-gamelift"); // CommonJS import + * const client = new GameLiftClient(config); + * const command = new DeleteFleetLocationsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteFleetLocationsCommandInput} for command's `input` shape. + * @see {@link DeleteFleetLocationsCommandOutput} for command's `response` shape. + * @see {@link GameLiftClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteFleetLocationsCommand extends $Command< DeleteFleetLocationsCommandInput, diff --git a/clients/client-gamelift/commands/DeleteGameServerGroupCommand.ts b/clients/client-gamelift/commands/DeleteGameServerGroupCommand.ts index e81e493af9bb..35dc0e64cfd7 100644 --- a/clients/client-gamelift/commands/DeleteGameServerGroupCommand.ts +++ b/clients/client-gamelift/commands/DeleteGameServerGroupCommand.ts @@ -69,6 +69,20 @@ export interface DeleteGameServerGroupCommandOutput extends DeleteGameServerGrou * DescribeGameServerInstances | * All APIs by task *

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { GameLiftClient, DeleteGameServerGroupCommand } from "@aws-sdk/client-gamelift"; // ES Modules import + * // const { GameLiftClient, DeleteGameServerGroupCommand } = require("@aws-sdk/client-gamelift"); // CommonJS import + * const client = new GameLiftClient(config); + * const command = new DeleteGameServerGroupCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteGameServerGroupCommandInput} for command's `input` shape. + * @see {@link DeleteGameServerGroupCommandOutput} for command's `response` shape. + * @see {@link GameLiftClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteGameServerGroupCommand extends $Command< DeleteGameServerGroupCommandInput, diff --git a/clients/client-gamelift/commands/DeleteGameSessionQueueCommand.ts b/clients/client-gamelift/commands/DeleteGameSessionQueueCommand.ts index 369f41243a13..4fbd492bbcc6 100644 --- a/clients/client-gamelift/commands/DeleteGameSessionQueueCommand.ts +++ b/clients/client-gamelift/commands/DeleteGameSessionQueueCommand.ts @@ -40,6 +40,20 @@ export interface DeleteGameSessionQueueCommandOutput extends DeleteGameSessionQu * DeleteGameSessionQueue | * All APIs by task *

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { GameLiftClient, DeleteGameSessionQueueCommand } from "@aws-sdk/client-gamelift"; // ES Modules import + * // const { GameLiftClient, DeleteGameSessionQueueCommand } = require("@aws-sdk/client-gamelift"); // CommonJS import + * const client = new GameLiftClient(config); + * const command = new DeleteGameSessionQueueCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteGameSessionQueueCommandInput} for command's `input` shape. + * @see {@link DeleteGameSessionQueueCommandOutput} for command's `response` shape. + * @see {@link GameLiftClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteGameSessionQueueCommand extends $Command< DeleteGameSessionQueueCommandInput, diff --git a/clients/client-gamelift/commands/DeleteMatchmakingConfigurationCommand.ts b/clients/client-gamelift/commands/DeleteMatchmakingConfigurationCommand.ts index a74e70ab0091..900a62186203 100644 --- a/clients/client-gamelift/commands/DeleteMatchmakingConfigurationCommand.ts +++ b/clients/client-gamelift/commands/DeleteMatchmakingConfigurationCommand.ts @@ -40,6 +40,20 @@ export interface DeleteMatchmakingConfigurationCommandOutput * DeleteMatchmakingRuleSet | * All APIs by task *

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { GameLiftClient, DeleteMatchmakingConfigurationCommand } from "@aws-sdk/client-gamelift"; // ES Modules import + * // const { GameLiftClient, DeleteMatchmakingConfigurationCommand } = require("@aws-sdk/client-gamelift"); // CommonJS import + * const client = new GameLiftClient(config); + * const command = new DeleteMatchmakingConfigurationCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteMatchmakingConfigurationCommandInput} for command's `input` shape. + * @see {@link DeleteMatchmakingConfigurationCommandOutput} for command's `response` shape. + * @see {@link GameLiftClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteMatchmakingConfigurationCommand extends $Command< DeleteMatchmakingConfigurationCommandInput, diff --git a/clients/client-gamelift/commands/DeleteMatchmakingRuleSetCommand.ts b/clients/client-gamelift/commands/DeleteMatchmakingRuleSetCommand.ts index 7176f0385813..e98e175ba0d1 100644 --- a/clients/client-gamelift/commands/DeleteMatchmakingRuleSetCommand.ts +++ b/clients/client-gamelift/commands/DeleteMatchmakingRuleSetCommand.ts @@ -49,6 +49,20 @@ export interface DeleteMatchmakingRuleSetCommandOutput extends DeleteMatchmaking * DeleteMatchmakingRuleSet | * All APIs by task *

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { GameLiftClient, DeleteMatchmakingRuleSetCommand } from "@aws-sdk/client-gamelift"; // ES Modules import + * // const { GameLiftClient, DeleteMatchmakingRuleSetCommand } = require("@aws-sdk/client-gamelift"); // CommonJS import + * const client = new GameLiftClient(config); + * const command = new DeleteMatchmakingRuleSetCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteMatchmakingRuleSetCommandInput} for command's `input` shape. + * @see {@link DeleteMatchmakingRuleSetCommandOutput} for command's `response` shape. + * @see {@link GameLiftClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteMatchmakingRuleSetCommand extends $Command< DeleteMatchmakingRuleSetCommandInput, diff --git a/clients/client-gamelift/commands/DeleteScalingPolicyCommand.ts b/clients/client-gamelift/commands/DeleteScalingPolicyCommand.ts index 3c64f043e883..75d3be93d57a 100644 --- a/clients/client-gamelift/commands/DeleteScalingPolicyCommand.ts +++ b/clients/client-gamelift/commands/DeleteScalingPolicyCommand.ts @@ -40,6 +40,20 @@ export interface DeleteScalingPolicyCommandOutput extends __MetadataBearer {} * StartFleetActions | * All APIs by task *

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { GameLiftClient, DeleteScalingPolicyCommand } from "@aws-sdk/client-gamelift"; // ES Modules import + * // const { GameLiftClient, DeleteScalingPolicyCommand } = require("@aws-sdk/client-gamelift"); // CommonJS import + * const client = new GameLiftClient(config); + * const command = new DeleteScalingPolicyCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteScalingPolicyCommandInput} for command's `input` shape. + * @see {@link DeleteScalingPolicyCommandOutput} for command's `response` shape. + * @see {@link GameLiftClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteScalingPolicyCommand extends $Command< DeleteScalingPolicyCommandInput, diff --git a/clients/client-gamelift/commands/DeleteScriptCommand.ts b/clients/client-gamelift/commands/DeleteScriptCommand.ts index bac37a5ee38f..da018f26981c 100644 --- a/clients/client-gamelift/commands/DeleteScriptCommand.ts +++ b/clients/client-gamelift/commands/DeleteScriptCommand.ts @@ -45,6 +45,20 @@ export interface DeleteScriptCommandOutput extends __MetadataBearer {} * DeleteScript | * All APIs by task *

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { GameLiftClient, DeleteScriptCommand } from "@aws-sdk/client-gamelift"; // ES Modules import + * // const { GameLiftClient, DeleteScriptCommand } = require("@aws-sdk/client-gamelift"); // CommonJS import + * const client = new GameLiftClient(config); + * const command = new DeleteScriptCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteScriptCommandInput} for command's `input` shape. + * @see {@link DeleteScriptCommandOutput} for command's `response` shape. + * @see {@link GameLiftClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteScriptCommand extends $Command< DeleteScriptCommandInput, diff --git a/clients/client-gamelift/commands/DeleteVpcPeeringAuthorizationCommand.ts b/clients/client-gamelift/commands/DeleteVpcPeeringAuthorizationCommand.ts index 15ff4ac993f1..72da4b2f20b5 100644 --- a/clients/client-gamelift/commands/DeleteVpcPeeringAuthorizationCommand.ts +++ b/clients/client-gamelift/commands/DeleteVpcPeeringAuthorizationCommand.ts @@ -37,6 +37,20 @@ export interface DeleteVpcPeeringAuthorizationCommandOutput * DeleteVpcPeeringConnection | * All APIs by task *

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { GameLiftClient, DeleteVpcPeeringAuthorizationCommand } from "@aws-sdk/client-gamelift"; // ES Modules import + * // const { GameLiftClient, DeleteVpcPeeringAuthorizationCommand } = require("@aws-sdk/client-gamelift"); // CommonJS import + * const client = new GameLiftClient(config); + * const command = new DeleteVpcPeeringAuthorizationCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteVpcPeeringAuthorizationCommandInput} for command's `input` shape. + * @see {@link DeleteVpcPeeringAuthorizationCommandOutput} for command's `response` shape. + * @see {@link GameLiftClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteVpcPeeringAuthorizationCommand extends $Command< DeleteVpcPeeringAuthorizationCommandInput, diff --git a/clients/client-gamelift/commands/DeleteVpcPeeringConnectionCommand.ts b/clients/client-gamelift/commands/DeleteVpcPeeringConnectionCommand.ts index 7657affc8ffe..576fbb6cade6 100644 --- a/clients/client-gamelift/commands/DeleteVpcPeeringConnectionCommand.ts +++ b/clients/client-gamelift/commands/DeleteVpcPeeringConnectionCommand.ts @@ -40,6 +40,20 @@ export interface DeleteVpcPeeringConnectionCommandOutput extends DeleteVpcPeerin * DeleteVpcPeeringConnection | * All APIs by task *

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { GameLiftClient, DeleteVpcPeeringConnectionCommand } from "@aws-sdk/client-gamelift"; // ES Modules import + * // const { GameLiftClient, DeleteVpcPeeringConnectionCommand } = require("@aws-sdk/client-gamelift"); // CommonJS import + * const client = new GameLiftClient(config); + * const command = new DeleteVpcPeeringConnectionCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteVpcPeeringConnectionCommandInput} for command's `input` shape. + * @see {@link DeleteVpcPeeringConnectionCommandOutput} for command's `response` shape. + * @see {@link GameLiftClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteVpcPeeringConnectionCommand extends $Command< DeleteVpcPeeringConnectionCommandInput, diff --git a/clients/client-gamelift/commands/DeregisterGameServerCommand.ts b/clients/client-gamelift/commands/DeregisterGameServerCommand.ts index e9bf4eafb32b..3fb0d7ac30b0 100644 --- a/clients/client-gamelift/commands/DeregisterGameServerCommand.ts +++ b/clients/client-gamelift/commands/DeregisterGameServerCommand.ts @@ -48,6 +48,20 @@ export interface DeregisterGameServerCommandOutput extends __MetadataBearer {} * DeregisterGameServer | * All APIs by task *

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { GameLiftClient, DeregisterGameServerCommand } from "@aws-sdk/client-gamelift"; // ES Modules import + * // const { GameLiftClient, DeregisterGameServerCommand } = require("@aws-sdk/client-gamelift"); // CommonJS import + * const client = new GameLiftClient(config); + * const command = new DeregisterGameServerCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeregisterGameServerCommandInput} for command's `input` shape. + * @see {@link DeregisterGameServerCommandOutput} for command's `response` shape. + * @see {@link GameLiftClientResolvedConfig | config} for command's `input` shape. + * */ export class DeregisterGameServerCommand extends $Command< DeregisterGameServerCommandInput, diff --git a/clients/client-gamelift/commands/DescribeAliasCommand.ts b/clients/client-gamelift/commands/DescribeAliasCommand.ts index 250e8c6a96cd..14df968d5d95 100644 --- a/clients/client-gamelift/commands/DescribeAliasCommand.ts +++ b/clients/client-gamelift/commands/DescribeAliasCommand.ts @@ -37,6 +37,20 @@ export interface DescribeAliasCommandOutput extends DescribeAliasOutput, __Metad * ResolveAlias | * All APIs by task *

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { GameLiftClient, DescribeAliasCommand } from "@aws-sdk/client-gamelift"; // ES Modules import + * // const { GameLiftClient, DescribeAliasCommand } = require("@aws-sdk/client-gamelift"); // CommonJS import + * const client = new GameLiftClient(config); + * const command = new DescribeAliasCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeAliasCommandInput} for command's `input` shape. + * @see {@link DescribeAliasCommandOutput} for command's `response` shape. + * @see {@link GameLiftClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeAliasCommand extends $Command< DescribeAliasCommandInput, diff --git a/clients/client-gamelift/commands/DescribeBuildCommand.ts b/clients/client-gamelift/commands/DescribeBuildCommand.ts index dc3d2079bcdf..f3abc31b65f1 100644 --- a/clients/client-gamelift/commands/DescribeBuildCommand.ts +++ b/clients/client-gamelift/commands/DescribeBuildCommand.ts @@ -41,6 +41,20 @@ export interface DescribeBuildCommandOutput extends DescribeBuildOutput, __Metad * DeleteBuild | * All APIs by task *

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { GameLiftClient, DescribeBuildCommand } from "@aws-sdk/client-gamelift"; // ES Modules import + * // const { GameLiftClient, DescribeBuildCommand } = require("@aws-sdk/client-gamelift"); // CommonJS import + * const client = new GameLiftClient(config); + * const command = new DescribeBuildCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeBuildCommandInput} for command's `input` shape. + * @see {@link DescribeBuildCommandOutput} for command's `response` shape. + * @see {@link GameLiftClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeBuildCommand extends $Command< DescribeBuildCommandInput, diff --git a/clients/client-gamelift/commands/DescribeEC2InstanceLimitsCommand.ts b/clients/client-gamelift/commands/DescribeEC2InstanceLimitsCommand.ts index bd8a37854304..c2271ae92ac7 100644 --- a/clients/client-gamelift/commands/DescribeEC2InstanceLimitsCommand.ts +++ b/clients/client-gamelift/commands/DescribeEC2InstanceLimitsCommand.ts @@ -92,6 +92,20 @@ export interface DescribeEC2InstanceLimitsCommandOutput extends DescribeEC2Insta * DeleteFleet | * All APIs by task *

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { GameLiftClient, DescribeEC2InstanceLimitsCommand } from "@aws-sdk/client-gamelift"; // ES Modules import + * // const { GameLiftClient, DescribeEC2InstanceLimitsCommand } = require("@aws-sdk/client-gamelift"); // CommonJS import + * const client = new GameLiftClient(config); + * const command = new DescribeEC2InstanceLimitsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeEC2InstanceLimitsCommandInput} for command's `input` shape. + * @see {@link DescribeEC2InstanceLimitsCommandOutput} for command's `response` shape. + * @see {@link GameLiftClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeEC2InstanceLimitsCommand extends $Command< DescribeEC2InstanceLimitsCommandInput, diff --git a/clients/client-gamelift/commands/DescribeFleetAttributesCommand.ts b/clients/client-gamelift/commands/DescribeFleetAttributesCommand.ts index 79710e5d5ecd..bd7eecadc361 100644 --- a/clients/client-gamelift/commands/DescribeFleetAttributesCommand.ts +++ b/clients/client-gamelift/commands/DescribeFleetAttributesCommand.ts @@ -64,6 +64,20 @@ export interface DescribeFleetAttributesCommandOutput extends DescribeFleetAttri * DescribeScalingPolicies | * All APIs by task *

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { GameLiftClient, DescribeFleetAttributesCommand } from "@aws-sdk/client-gamelift"; // ES Modules import + * // const { GameLiftClient, DescribeFleetAttributesCommand } = require("@aws-sdk/client-gamelift"); // CommonJS import + * const client = new GameLiftClient(config); + * const command = new DescribeFleetAttributesCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeFleetAttributesCommandInput} for command's `input` shape. + * @see {@link DescribeFleetAttributesCommandOutput} for command's `response` shape. + * @see {@link GameLiftClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeFleetAttributesCommand extends $Command< DescribeFleetAttributesCommandInput, diff --git a/clients/client-gamelift/commands/DescribeFleetCapacityCommand.ts b/clients/client-gamelift/commands/DescribeFleetCapacityCommand.ts index bedc85a0d0bf..15ff15fab7fd 100644 --- a/clients/client-gamelift/commands/DescribeFleetCapacityCommand.ts +++ b/clients/client-gamelift/commands/DescribeFleetCapacityCommand.ts @@ -71,6 +71,20 @@ export interface DescribeFleetCapacityCommandOutput extends DescribeFleetCapacit * DescribeScalingPolicies | * All APIs by task *

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { GameLiftClient, DescribeFleetCapacityCommand } from "@aws-sdk/client-gamelift"; // ES Modules import + * // const { GameLiftClient, DescribeFleetCapacityCommand } = require("@aws-sdk/client-gamelift"); // CommonJS import + * const client = new GameLiftClient(config); + * const command = new DescribeFleetCapacityCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeFleetCapacityCommandInput} for command's `input` shape. + * @see {@link DescribeFleetCapacityCommandOutput} for command's `response` shape. + * @see {@link GameLiftClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeFleetCapacityCommand extends $Command< DescribeFleetCapacityCommandInput, diff --git a/clients/client-gamelift/commands/DescribeFleetEventsCommand.ts b/clients/client-gamelift/commands/DescribeFleetEventsCommand.ts index cb80f790ce3a..c8a9b5a92e3e 100644 --- a/clients/client-gamelift/commands/DescribeFleetEventsCommand.ts +++ b/clients/client-gamelift/commands/DescribeFleetEventsCommand.ts @@ -51,6 +51,20 @@ export interface DescribeFleetEventsCommandOutput extends DescribeFleetEventsOut * DescribeScalingPolicies | * All APIs by task *

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { GameLiftClient, DescribeFleetEventsCommand } from "@aws-sdk/client-gamelift"; // ES Modules import + * // const { GameLiftClient, DescribeFleetEventsCommand } = require("@aws-sdk/client-gamelift"); // CommonJS import + * const client = new GameLiftClient(config); + * const command = new DescribeFleetEventsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeFleetEventsCommandInput} for command's `input` shape. + * @see {@link DescribeFleetEventsCommandOutput} for command's `response` shape. + * @see {@link GameLiftClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeFleetEventsCommand extends $Command< DescribeFleetEventsCommandInput, diff --git a/clients/client-gamelift/commands/DescribeFleetLocationAttributesCommand.ts b/clients/client-gamelift/commands/DescribeFleetLocationAttributesCommand.ts index 47fc0fbd2388..747132437dfc 100644 --- a/clients/client-gamelift/commands/DescribeFleetLocationAttributesCommand.ts +++ b/clients/client-gamelift/commands/DescribeFleetLocationAttributesCommand.ts @@ -64,6 +64,20 @@ export interface DescribeFleetLocationAttributesCommandOutput * DeleteFleetLocations | * All APIs by task *

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { GameLiftClient, DescribeFleetLocationAttributesCommand } from "@aws-sdk/client-gamelift"; // ES Modules import + * // const { GameLiftClient, DescribeFleetLocationAttributesCommand } = require("@aws-sdk/client-gamelift"); // CommonJS import + * const client = new GameLiftClient(config); + * const command = new DescribeFleetLocationAttributesCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeFleetLocationAttributesCommandInput} for command's `input` shape. + * @see {@link DescribeFleetLocationAttributesCommandOutput} for command's `response` shape. + * @see {@link GameLiftClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeFleetLocationAttributesCommand extends $Command< DescribeFleetLocationAttributesCommandInput, diff --git a/clients/client-gamelift/commands/DescribeFleetLocationCapacityCommand.ts b/clients/client-gamelift/commands/DescribeFleetLocationCapacityCommand.ts index 68ba8af1ec0a..87f38eb81614 100644 --- a/clients/client-gamelift/commands/DescribeFleetLocationCapacityCommand.ts +++ b/clients/client-gamelift/commands/DescribeFleetLocationCapacityCommand.ts @@ -56,6 +56,20 @@ export interface DescribeFleetLocationCapacityCommandOutput * DeleteFleetLocations | * All APIs by task *

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { GameLiftClient, DescribeFleetLocationCapacityCommand } from "@aws-sdk/client-gamelift"; // ES Modules import + * // const { GameLiftClient, DescribeFleetLocationCapacityCommand } = require("@aws-sdk/client-gamelift"); // CommonJS import + * const client = new GameLiftClient(config); + * const command = new DescribeFleetLocationCapacityCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeFleetLocationCapacityCommandInput} for command's `input` shape. + * @see {@link DescribeFleetLocationCapacityCommandOutput} for command's `response` shape. + * @see {@link GameLiftClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeFleetLocationCapacityCommand extends $Command< DescribeFleetLocationCapacityCommandInput, diff --git a/clients/client-gamelift/commands/DescribeFleetLocationUtilizationCommand.ts b/clients/client-gamelift/commands/DescribeFleetLocationUtilizationCommand.ts index be9fa9dcc201..0565cc7a9ffd 100644 --- a/clients/client-gamelift/commands/DescribeFleetLocationUtilizationCommand.ts +++ b/clients/client-gamelift/commands/DescribeFleetLocationUtilizationCommand.ts @@ -56,6 +56,20 @@ export interface DescribeFleetLocationUtilizationCommandOutput * DeleteFleetLocations | * All APIs by task *

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { GameLiftClient, DescribeFleetLocationUtilizationCommand } from "@aws-sdk/client-gamelift"; // ES Modules import + * // const { GameLiftClient, DescribeFleetLocationUtilizationCommand } = require("@aws-sdk/client-gamelift"); // CommonJS import + * const client = new GameLiftClient(config); + * const command = new DescribeFleetLocationUtilizationCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeFleetLocationUtilizationCommandInput} for command's `input` shape. + * @see {@link DescribeFleetLocationUtilizationCommandOutput} for command's `response` shape. + * @see {@link GameLiftClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeFleetLocationUtilizationCommand extends $Command< DescribeFleetLocationUtilizationCommandInput, diff --git a/clients/client-gamelift/commands/DescribeFleetPortSettingsCommand.ts b/clients/client-gamelift/commands/DescribeFleetPortSettingsCommand.ts index b50ff1999228..a0ad1242e74a 100644 --- a/clients/client-gamelift/commands/DescribeFleetPortSettingsCommand.ts +++ b/clients/client-gamelift/commands/DescribeFleetPortSettingsCommand.ts @@ -62,6 +62,20 @@ export interface DescribeFleetPortSettingsCommandOutput extends DescribeFleetPor * DescribeScalingPolicies | * All APIs by task *

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { GameLiftClient, DescribeFleetPortSettingsCommand } from "@aws-sdk/client-gamelift"; // ES Modules import + * // const { GameLiftClient, DescribeFleetPortSettingsCommand } = require("@aws-sdk/client-gamelift"); // CommonJS import + * const client = new GameLiftClient(config); + * const command = new DescribeFleetPortSettingsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeFleetPortSettingsCommandInput} for command's `input` shape. + * @see {@link DescribeFleetPortSettingsCommandOutput} for command's `response` shape. + * @see {@link GameLiftClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeFleetPortSettingsCommand extends $Command< DescribeFleetPortSettingsCommandInput, diff --git a/clients/client-gamelift/commands/DescribeFleetUtilizationCommand.ts b/clients/client-gamelift/commands/DescribeFleetUtilizationCommand.ts index c116983242e4..f293de235b3d 100644 --- a/clients/client-gamelift/commands/DescribeFleetUtilizationCommand.ts +++ b/clients/client-gamelift/commands/DescribeFleetUtilizationCommand.ts @@ -72,6 +72,20 @@ export interface DescribeFleetUtilizationCommandOutput extends DescribeFleetUtil * DescribeScalingPolicies | * All APIs by task *

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { GameLiftClient, DescribeFleetUtilizationCommand } from "@aws-sdk/client-gamelift"; // ES Modules import + * // const { GameLiftClient, DescribeFleetUtilizationCommand } = require("@aws-sdk/client-gamelift"); // CommonJS import + * const client = new GameLiftClient(config); + * const command = new DescribeFleetUtilizationCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeFleetUtilizationCommandInput} for command's `input` shape. + * @see {@link DescribeFleetUtilizationCommandOutput} for command's `response` shape. + * @see {@link GameLiftClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeFleetUtilizationCommand extends $Command< DescribeFleetUtilizationCommandInput, diff --git a/clients/client-gamelift/commands/DescribeGameServerCommand.ts b/clients/client-gamelift/commands/DescribeGameServerCommand.ts index 52da6b4e59d9..4327788b3c26 100644 --- a/clients/client-gamelift/commands/DescribeGameServerCommand.ts +++ b/clients/client-gamelift/commands/DescribeGameServerCommand.ts @@ -46,6 +46,20 @@ export interface DescribeGameServerCommandOutput extends DescribeGameServerOutpu * DeregisterGameServer | * All APIs by task *

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { GameLiftClient, DescribeGameServerCommand } from "@aws-sdk/client-gamelift"; // ES Modules import + * // const { GameLiftClient, DescribeGameServerCommand } = require("@aws-sdk/client-gamelift"); // CommonJS import + * const client = new GameLiftClient(config); + * const command = new DescribeGameServerCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeGameServerCommandInput} for command's `input` shape. + * @see {@link DescribeGameServerCommandOutput} for command's `response` shape. + * @see {@link GameLiftClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeGameServerCommand extends $Command< DescribeGameServerCommandInput, diff --git a/clients/client-gamelift/commands/DescribeGameServerGroupCommand.ts b/clients/client-gamelift/commands/DescribeGameServerGroupCommand.ts index dcc56e51d9c1..b88c0c3c15c1 100644 --- a/clients/client-gamelift/commands/DescribeGameServerGroupCommand.ts +++ b/clients/client-gamelift/commands/DescribeGameServerGroupCommand.ts @@ -50,6 +50,20 @@ export interface DescribeGameServerGroupCommandOutput extends DescribeGameServer * DescribeGameServerInstances | * All APIs by task *

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { GameLiftClient, DescribeGameServerGroupCommand } from "@aws-sdk/client-gamelift"; // ES Modules import + * // const { GameLiftClient, DescribeGameServerGroupCommand } = require("@aws-sdk/client-gamelift"); // CommonJS import + * const client = new GameLiftClient(config); + * const command = new DescribeGameServerGroupCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeGameServerGroupCommandInput} for command's `input` shape. + * @see {@link DescribeGameServerGroupCommandOutput} for command's `response` shape. + * @see {@link GameLiftClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeGameServerGroupCommand extends $Command< DescribeGameServerGroupCommandInput, diff --git a/clients/client-gamelift/commands/DescribeGameServerInstancesCommand.ts b/clients/client-gamelift/commands/DescribeGameServerInstancesCommand.ts index eeb58b1a7ad2..3617ccf336da 100644 --- a/clients/client-gamelift/commands/DescribeGameServerInstancesCommand.ts +++ b/clients/client-gamelift/commands/DescribeGameServerInstancesCommand.ts @@ -60,6 +60,20 @@ export interface DescribeGameServerInstancesCommandOutput extends DescribeGameSe * DescribeGameServerInstances | * All APIs by task *

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { GameLiftClient, DescribeGameServerInstancesCommand } from "@aws-sdk/client-gamelift"; // ES Modules import + * // const { GameLiftClient, DescribeGameServerInstancesCommand } = require("@aws-sdk/client-gamelift"); // CommonJS import + * const client = new GameLiftClient(config); + * const command = new DescribeGameServerInstancesCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeGameServerInstancesCommandInput} for command's `input` shape. + * @see {@link DescribeGameServerInstancesCommandOutput} for command's `response` shape. + * @see {@link GameLiftClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeGameServerInstancesCommand extends $Command< DescribeGameServerInstancesCommandInput, diff --git a/clients/client-gamelift/commands/DescribeGameSessionDetailsCommand.ts b/clients/client-gamelift/commands/DescribeGameSessionDetailsCommand.ts index 595b070520ba..cdc1133dfa71 100644 --- a/clients/client-gamelift/commands/DescribeGameSessionDetailsCommand.ts +++ b/clients/client-gamelift/commands/DescribeGameSessionDetailsCommand.ts @@ -70,6 +70,20 @@ export interface DescribeGameSessionDetailsCommandOutput extends DescribeGameSes * StopGameSessionPlacement | * All APIs by task *

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { GameLiftClient, DescribeGameSessionDetailsCommand } from "@aws-sdk/client-gamelift"; // ES Modules import + * // const { GameLiftClient, DescribeGameSessionDetailsCommand } = require("@aws-sdk/client-gamelift"); // CommonJS import + * const client = new GameLiftClient(config); + * const command = new DescribeGameSessionDetailsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeGameSessionDetailsCommandInput} for command's `input` shape. + * @see {@link DescribeGameSessionDetailsCommandOutput} for command's `response` shape. + * @see {@link GameLiftClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeGameSessionDetailsCommand extends $Command< DescribeGameSessionDetailsCommandInput, diff --git a/clients/client-gamelift/commands/DescribeGameSessionPlacementCommand.ts b/clients/client-gamelift/commands/DescribeGameSessionPlacementCommand.ts index 3b1a77dfab4b..fc6d4417aaf7 100644 --- a/clients/client-gamelift/commands/DescribeGameSessionPlacementCommand.ts +++ b/clients/client-gamelift/commands/DescribeGameSessionPlacementCommand.ts @@ -41,6 +41,20 @@ export interface DescribeGameSessionPlacementCommandOutput * StopGameSessionPlacement | * All APIs by task *

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { GameLiftClient, DescribeGameSessionPlacementCommand } from "@aws-sdk/client-gamelift"; // ES Modules import + * // const { GameLiftClient, DescribeGameSessionPlacementCommand } = require("@aws-sdk/client-gamelift"); // CommonJS import + * const client = new GameLiftClient(config); + * const command = new DescribeGameSessionPlacementCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeGameSessionPlacementCommandInput} for command's `input` shape. + * @see {@link DescribeGameSessionPlacementCommandOutput} for command's `response` shape. + * @see {@link GameLiftClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeGameSessionPlacementCommand extends $Command< DescribeGameSessionPlacementCommandInput, diff --git a/clients/client-gamelift/commands/DescribeGameSessionQueuesCommand.ts b/clients/client-gamelift/commands/DescribeGameSessionQueuesCommand.ts index 62686052719a..de7d15f07d3a 100644 --- a/clients/client-gamelift/commands/DescribeGameSessionQueuesCommand.ts +++ b/clients/client-gamelift/commands/DescribeGameSessionQueuesCommand.ts @@ -43,6 +43,20 @@ export interface DescribeGameSessionQueuesCommandOutput extends DescribeGameSess * DeleteGameSessionQueue | * All APIs by task *

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { GameLiftClient, DescribeGameSessionQueuesCommand } from "@aws-sdk/client-gamelift"; // ES Modules import + * // const { GameLiftClient, DescribeGameSessionQueuesCommand } = require("@aws-sdk/client-gamelift"); // CommonJS import + * const client = new GameLiftClient(config); + * const command = new DescribeGameSessionQueuesCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeGameSessionQueuesCommandInput} for command's `input` shape. + * @see {@link DescribeGameSessionQueuesCommandOutput} for command's `response` shape. + * @see {@link GameLiftClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeGameSessionQueuesCommand extends $Command< DescribeGameSessionQueuesCommandInput, diff --git a/clients/client-gamelift/commands/DescribeGameSessionsCommand.ts b/clients/client-gamelift/commands/DescribeGameSessionsCommand.ts index dab8e0bd65a2..cb560e194212 100644 --- a/clients/client-gamelift/commands/DescribeGameSessionsCommand.ts +++ b/clients/client-gamelift/commands/DescribeGameSessionsCommand.ts @@ -72,6 +72,20 @@ export interface DescribeGameSessionsCommandOutput extends DescribeGameSessionsO * StopGameSessionPlacement | * All APIs by task *

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { GameLiftClient, DescribeGameSessionsCommand } from "@aws-sdk/client-gamelift"; // ES Modules import + * // const { GameLiftClient, DescribeGameSessionsCommand } = require("@aws-sdk/client-gamelift"); // CommonJS import + * const client = new GameLiftClient(config); + * const command = new DescribeGameSessionsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeGameSessionsCommandInput} for command's `input` shape. + * @see {@link DescribeGameSessionsCommandOutput} for command's `response` shape. + * @see {@link GameLiftClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeGameSessionsCommand extends $Command< DescribeGameSessionsCommandInput, diff --git a/clients/client-gamelift/commands/DescribeInstancesCommand.ts b/clients/client-gamelift/commands/DescribeInstancesCommand.ts index d780012e7e07..619b51d83a67 100644 --- a/clients/client-gamelift/commands/DescribeInstancesCommand.ts +++ b/clients/client-gamelift/commands/DescribeInstancesCommand.ts @@ -60,6 +60,20 @@ export interface DescribeInstancesCommandOutput extends DescribeInstancesOutput, * DescribeEC2InstanceLimits | * All APIs by task *

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { GameLiftClient, DescribeInstancesCommand } from "@aws-sdk/client-gamelift"; // ES Modules import + * // const { GameLiftClient, DescribeInstancesCommand } = require("@aws-sdk/client-gamelift"); // CommonJS import + * const client = new GameLiftClient(config); + * const command = new DescribeInstancesCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeInstancesCommandInput} for command's `input` shape. + * @see {@link DescribeInstancesCommandOutput} for command's `response` shape. + * @see {@link GameLiftClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeInstancesCommand extends $Command< DescribeInstancesCommandInput, diff --git a/clients/client-gamelift/commands/DescribeMatchmakingCommand.ts b/clients/client-gamelift/commands/DescribeMatchmakingCommand.ts index b37b3ff37353..b47e41a7ff23 100644 --- a/clients/client-gamelift/commands/DescribeMatchmakingCommand.ts +++ b/clients/client-gamelift/commands/DescribeMatchmakingCommand.ts @@ -56,6 +56,20 @@ export interface DescribeMatchmakingCommandOutput extends DescribeMatchmakingOut * StartMatchBackfill | * All APIs by task *

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { GameLiftClient, DescribeMatchmakingCommand } from "@aws-sdk/client-gamelift"; // ES Modules import + * // const { GameLiftClient, DescribeMatchmakingCommand } = require("@aws-sdk/client-gamelift"); // CommonJS import + * const client = new GameLiftClient(config); + * const command = new DescribeMatchmakingCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeMatchmakingCommandInput} for command's `input` shape. + * @see {@link DescribeMatchmakingCommandOutput} for command's `response` shape. + * @see {@link GameLiftClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeMatchmakingCommand extends $Command< DescribeMatchmakingCommandInput, diff --git a/clients/client-gamelift/commands/DescribeMatchmakingConfigurationsCommand.ts b/clients/client-gamelift/commands/DescribeMatchmakingConfigurationsCommand.ts index 4aa601e866d9..126cb053bca9 100644 --- a/clients/client-gamelift/commands/DescribeMatchmakingConfigurationsCommand.ts +++ b/clients/client-gamelift/commands/DescribeMatchmakingConfigurationsCommand.ts @@ -51,6 +51,20 @@ export interface DescribeMatchmakingConfigurationsCommandOutput * DeleteMatchmakingRuleSet | * All APIs by task *

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { GameLiftClient, DescribeMatchmakingConfigurationsCommand } from "@aws-sdk/client-gamelift"; // ES Modules import + * // const { GameLiftClient, DescribeMatchmakingConfigurationsCommand } = require("@aws-sdk/client-gamelift"); // CommonJS import + * const client = new GameLiftClient(config); + * const command = new DescribeMatchmakingConfigurationsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeMatchmakingConfigurationsCommandInput} for command's `input` shape. + * @see {@link DescribeMatchmakingConfigurationsCommandOutput} for command's `response` shape. + * @see {@link GameLiftClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeMatchmakingConfigurationsCommand extends $Command< DescribeMatchmakingConfigurationsCommandInput, diff --git a/clients/client-gamelift/commands/DescribeMatchmakingRuleSetsCommand.ts b/clients/client-gamelift/commands/DescribeMatchmakingRuleSetsCommand.ts index d37b25fffe51..f0feff60717a 100644 --- a/clients/client-gamelift/commands/DescribeMatchmakingRuleSetsCommand.ts +++ b/clients/client-gamelift/commands/DescribeMatchmakingRuleSetsCommand.ts @@ -50,6 +50,20 @@ export interface DescribeMatchmakingRuleSetsCommandOutput extends DescribeMatchm * DeleteMatchmakingRuleSet | * All APIs by task *

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { GameLiftClient, DescribeMatchmakingRuleSetsCommand } from "@aws-sdk/client-gamelift"; // ES Modules import + * // const { GameLiftClient, DescribeMatchmakingRuleSetsCommand } = require("@aws-sdk/client-gamelift"); // CommonJS import + * const client = new GameLiftClient(config); + * const command = new DescribeMatchmakingRuleSetsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeMatchmakingRuleSetsCommandInput} for command's `input` shape. + * @see {@link DescribeMatchmakingRuleSetsCommandOutput} for command's `response` shape. + * @see {@link GameLiftClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeMatchmakingRuleSetsCommand extends $Command< DescribeMatchmakingRuleSetsCommandInput, diff --git a/clients/client-gamelift/commands/DescribePlayerSessionsCommand.ts b/clients/client-gamelift/commands/DescribePlayerSessionsCommand.ts index 69289f550805..841fbb157eea 100644 --- a/clients/client-gamelift/commands/DescribePlayerSessionsCommand.ts +++ b/clients/client-gamelift/commands/DescribePlayerSessionsCommand.ts @@ -56,6 +56,20 @@ export interface DescribePlayerSessionsCommandOutput extends DescribePlayerSessi * DescribeGameSessionPlacement | * All APIs by task *

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { GameLiftClient, DescribePlayerSessionsCommand } from "@aws-sdk/client-gamelift"; // ES Modules import + * // const { GameLiftClient, DescribePlayerSessionsCommand } = require("@aws-sdk/client-gamelift"); // CommonJS import + * const client = new GameLiftClient(config); + * const command = new DescribePlayerSessionsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribePlayerSessionsCommandInput} for command's `input` shape. + * @see {@link DescribePlayerSessionsCommandOutput} for command's `response` shape. + * @see {@link GameLiftClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribePlayerSessionsCommand extends $Command< DescribePlayerSessionsCommandInput, diff --git a/clients/client-gamelift/commands/DescribeRuntimeConfigurationCommand.ts b/clients/client-gamelift/commands/DescribeRuntimeConfigurationCommand.ts index a0a3da4e6958..23ae8516e20b 100644 --- a/clients/client-gamelift/commands/DescribeRuntimeConfigurationCommand.ts +++ b/clients/client-gamelift/commands/DescribeRuntimeConfigurationCommand.ts @@ -56,6 +56,20 @@ export interface DescribeRuntimeConfigurationCommandOutput * DescribeScalingPolicies | * All APIs by task *

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { GameLiftClient, DescribeRuntimeConfigurationCommand } from "@aws-sdk/client-gamelift"; // ES Modules import + * // const { GameLiftClient, DescribeRuntimeConfigurationCommand } = require("@aws-sdk/client-gamelift"); // CommonJS import + * const client = new GameLiftClient(config); + * const command = new DescribeRuntimeConfigurationCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeRuntimeConfigurationCommandInput} for command's `input` shape. + * @see {@link DescribeRuntimeConfigurationCommandOutput} for command's `response` shape. + * @see {@link GameLiftClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeRuntimeConfigurationCommand extends $Command< DescribeRuntimeConfigurationCommandInput, diff --git a/clients/client-gamelift/commands/DescribeScalingPoliciesCommand.ts b/clients/client-gamelift/commands/DescribeScalingPoliciesCommand.ts index a56d6e70d90e..6ac1ee2aa195 100644 --- a/clients/client-gamelift/commands/DescribeScalingPoliciesCommand.ts +++ b/clients/client-gamelift/commands/DescribeScalingPoliciesCommand.ts @@ -44,6 +44,20 @@ export interface DescribeScalingPoliciesCommandOutput extends DescribeScalingPol * StartFleetActions | * All APIs by task *

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { GameLiftClient, DescribeScalingPoliciesCommand } from "@aws-sdk/client-gamelift"; // ES Modules import + * // const { GameLiftClient, DescribeScalingPoliciesCommand } = require("@aws-sdk/client-gamelift"); // CommonJS import + * const client = new GameLiftClient(config); + * const command = new DescribeScalingPoliciesCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeScalingPoliciesCommandInput} for command's `input` shape. + * @see {@link DescribeScalingPoliciesCommandOutput} for command's `response` shape. + * @see {@link GameLiftClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeScalingPoliciesCommand extends $Command< DescribeScalingPoliciesCommandInput, diff --git a/clients/client-gamelift/commands/DescribeScriptCommand.ts b/clients/client-gamelift/commands/DescribeScriptCommand.ts index 55804695e556..8009ef3021d8 100644 --- a/clients/client-gamelift/commands/DescribeScriptCommand.ts +++ b/clients/client-gamelift/commands/DescribeScriptCommand.ts @@ -41,6 +41,20 @@ export interface DescribeScriptCommandOutput extends DescribeScriptOutput, __Met * DeleteScript | * All APIs by task *

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { GameLiftClient, DescribeScriptCommand } from "@aws-sdk/client-gamelift"; // ES Modules import + * // const { GameLiftClient, DescribeScriptCommand } = require("@aws-sdk/client-gamelift"); // CommonJS import + * const client = new GameLiftClient(config); + * const command = new DescribeScriptCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeScriptCommandInput} for command's `input` shape. + * @see {@link DescribeScriptCommandOutput} for command's `response` shape. + * @see {@link GameLiftClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeScriptCommand extends $Command< DescribeScriptCommandInput, diff --git a/clients/client-gamelift/commands/DescribeVpcPeeringAuthorizationsCommand.ts b/clients/client-gamelift/commands/DescribeVpcPeeringAuthorizationsCommand.ts index 7a9d958e35a5..ddd8a4b7c277 100644 --- a/clients/client-gamelift/commands/DescribeVpcPeeringAuthorizationsCommand.ts +++ b/clients/client-gamelift/commands/DescribeVpcPeeringAuthorizationsCommand.ts @@ -38,6 +38,20 @@ export interface DescribeVpcPeeringAuthorizationsCommandOutput * DeleteVpcPeeringConnection | * All APIs by task *

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { GameLiftClient, DescribeVpcPeeringAuthorizationsCommand } from "@aws-sdk/client-gamelift"; // ES Modules import + * // const { GameLiftClient, DescribeVpcPeeringAuthorizationsCommand } = require("@aws-sdk/client-gamelift"); // CommonJS import + * const client = new GameLiftClient(config); + * const command = new DescribeVpcPeeringAuthorizationsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeVpcPeeringAuthorizationsCommandInput} for command's `input` shape. + * @see {@link DescribeVpcPeeringAuthorizationsCommandOutput} for command's `response` shape. + * @see {@link GameLiftClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeVpcPeeringAuthorizationsCommand extends $Command< DescribeVpcPeeringAuthorizationsCommandInput, diff --git a/clients/client-gamelift/commands/DescribeVpcPeeringConnectionsCommand.ts b/clients/client-gamelift/commands/DescribeVpcPeeringConnectionsCommand.ts index 553d08184911..c275529db263 100644 --- a/clients/client-gamelift/commands/DescribeVpcPeeringConnectionsCommand.ts +++ b/clients/client-gamelift/commands/DescribeVpcPeeringConnectionsCommand.ts @@ -42,6 +42,20 @@ export interface DescribeVpcPeeringConnectionsCommandOutput * DeleteVpcPeeringConnection | * All APIs by task *

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { GameLiftClient, DescribeVpcPeeringConnectionsCommand } from "@aws-sdk/client-gamelift"; // ES Modules import + * // const { GameLiftClient, DescribeVpcPeeringConnectionsCommand } = require("@aws-sdk/client-gamelift"); // CommonJS import + * const client = new GameLiftClient(config); + * const command = new DescribeVpcPeeringConnectionsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeVpcPeeringConnectionsCommandInput} for command's `input` shape. + * @see {@link DescribeVpcPeeringConnectionsCommandOutput} for command's `response` shape. + * @see {@link GameLiftClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeVpcPeeringConnectionsCommand extends $Command< DescribeVpcPeeringConnectionsCommandInput, diff --git a/clients/client-gamelift/commands/GetGameSessionLogUrlCommand.ts b/clients/client-gamelift/commands/GetGameSessionLogUrlCommand.ts index ee1c216587e8..67757d049d57 100644 --- a/clients/client-gamelift/commands/GetGameSessionLogUrlCommand.ts +++ b/clients/client-gamelift/commands/GetGameSessionLogUrlCommand.ts @@ -44,6 +44,20 @@ export interface GetGameSessionLogUrlCommandOutput extends GetGameSessionLogUrlO * StopGameSessionPlacement | * All APIs by task *

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { GameLiftClient, GetGameSessionLogUrlCommand } from "@aws-sdk/client-gamelift"; // ES Modules import + * // const { GameLiftClient, GetGameSessionLogUrlCommand } = require("@aws-sdk/client-gamelift"); // CommonJS import + * const client = new GameLiftClient(config); + * const command = new GetGameSessionLogUrlCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetGameSessionLogUrlCommandInput} for command's `input` shape. + * @see {@link GetGameSessionLogUrlCommandOutput} for command's `response` shape. + * @see {@link GameLiftClientResolvedConfig | config} for command's `input` shape. + * */ export class GetGameSessionLogUrlCommand extends $Command< GetGameSessionLogUrlCommandInput, diff --git a/clients/client-gamelift/commands/GetInstanceAccessCommand.ts b/clients/client-gamelift/commands/GetInstanceAccessCommand.ts index 84527fb116d0..ff93f79f3ca9 100644 --- a/clients/client-gamelift/commands/GetInstanceAccessCommand.ts +++ b/clients/client-gamelift/commands/GetInstanceAccessCommand.ts @@ -56,6 +56,20 @@ export interface GetInstanceAccessCommandOutput extends GetInstanceAccessOutput, * DescribeEC2InstanceLimits | * All APIs by task *

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { GameLiftClient, GetInstanceAccessCommand } from "@aws-sdk/client-gamelift"; // ES Modules import + * // const { GameLiftClient, GetInstanceAccessCommand } = require("@aws-sdk/client-gamelift"); // CommonJS import + * const client = new GameLiftClient(config); + * const command = new GetInstanceAccessCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetInstanceAccessCommandInput} for command's `input` shape. + * @see {@link GetInstanceAccessCommandOutput} for command's `response` shape. + * @see {@link GameLiftClientResolvedConfig | config} for command's `input` shape. + * */ export class GetInstanceAccessCommand extends $Command< GetInstanceAccessCommandInput, diff --git a/clients/client-gamelift/commands/ListAliasesCommand.ts b/clients/client-gamelift/commands/ListAliasesCommand.ts index 9605ff9c4c07..6b52de4a324a 100644 --- a/clients/client-gamelift/commands/ListAliasesCommand.ts +++ b/clients/client-gamelift/commands/ListAliasesCommand.ts @@ -39,6 +39,20 @@ export interface ListAliasesCommandOutput extends ListAliasesOutput, __MetadataB * ResolveAlias | * All APIs by task *

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { GameLiftClient, ListAliasesCommand } from "@aws-sdk/client-gamelift"; // ES Modules import + * // const { GameLiftClient, ListAliasesCommand } = require("@aws-sdk/client-gamelift"); // CommonJS import + * const client = new GameLiftClient(config); + * const command = new ListAliasesCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListAliasesCommandInput} for command's `input` shape. + * @see {@link ListAliasesCommandOutput} for command's `response` shape. + * @see {@link GameLiftClientResolvedConfig | config} for command's `input` shape. + * */ export class ListAliasesCommand extends $Command< ListAliasesCommandInput, diff --git a/clients/client-gamelift/commands/ListBuildsCommand.ts b/clients/client-gamelift/commands/ListBuildsCommand.ts index 0d3696e7ec59..204a3e5c82d0 100644 --- a/clients/client-gamelift/commands/ListBuildsCommand.ts +++ b/clients/client-gamelift/commands/ListBuildsCommand.ts @@ -46,6 +46,20 @@ export interface ListBuildsCommandOutput extends ListBuildsOutput, __MetadataBea * DeleteBuild | * All APIs by task *

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { GameLiftClient, ListBuildsCommand } from "@aws-sdk/client-gamelift"; // ES Modules import + * // const { GameLiftClient, ListBuildsCommand } = require("@aws-sdk/client-gamelift"); // CommonJS import + * const client = new GameLiftClient(config); + * const command = new ListBuildsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListBuildsCommandInput} for command's `input` shape. + * @see {@link ListBuildsCommandOutput} for command's `response` shape. + * @see {@link GameLiftClientResolvedConfig | config} for command's `input` shape. + * */ export class ListBuildsCommand extends $Command< ListBuildsCommandInput, diff --git a/clients/client-gamelift/commands/ListFleetsCommand.ts b/clients/client-gamelift/commands/ListFleetsCommand.ts index f49bc6f2a1b2..2273f1bf9361 100644 --- a/clients/client-gamelift/commands/ListFleetsCommand.ts +++ b/clients/client-gamelift/commands/ListFleetsCommand.ts @@ -68,6 +68,20 @@ export interface ListFleetsCommandOutput extends ListFleetsOutput, __MetadataBea * DeleteFleet | * All APIs by task *

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { GameLiftClient, ListFleetsCommand } from "@aws-sdk/client-gamelift"; // ES Modules import + * // const { GameLiftClient, ListFleetsCommand } = require("@aws-sdk/client-gamelift"); // CommonJS import + * const client = new GameLiftClient(config); + * const command = new ListFleetsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListFleetsCommandInput} for command's `input` shape. + * @see {@link ListFleetsCommandOutput} for command's `response` shape. + * @see {@link GameLiftClientResolvedConfig | config} for command's `input` shape. + * */ export class ListFleetsCommand extends $Command< ListFleetsCommandInput, diff --git a/clients/client-gamelift/commands/ListGameServerGroupsCommand.ts b/clients/client-gamelift/commands/ListGameServerGroupsCommand.ts index 8e09a1b369ad..16702a77b685 100644 --- a/clients/client-gamelift/commands/ListGameServerGroupsCommand.ts +++ b/clients/client-gamelift/commands/ListGameServerGroupsCommand.ts @@ -47,6 +47,20 @@ export interface ListGameServerGroupsCommandOutput extends ListGameServerGroupsO * DescribeGameServerInstances | * All APIs by task *

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { GameLiftClient, ListGameServerGroupsCommand } from "@aws-sdk/client-gamelift"; // ES Modules import + * // const { GameLiftClient, ListGameServerGroupsCommand } = require("@aws-sdk/client-gamelift"); // CommonJS import + * const client = new GameLiftClient(config); + * const command = new ListGameServerGroupsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListGameServerGroupsCommandInput} for command's `input` shape. + * @see {@link ListGameServerGroupsCommandOutput} for command's `response` shape. + * @see {@link GameLiftClientResolvedConfig | config} for command's `input` shape. + * */ export class ListGameServerGroupsCommand extends $Command< ListGameServerGroupsCommandInput, diff --git a/clients/client-gamelift/commands/ListGameServersCommand.ts b/clients/client-gamelift/commands/ListGameServersCommand.ts index c07b645851a4..f805cbd3a402 100644 --- a/clients/client-gamelift/commands/ListGameServersCommand.ts +++ b/clients/client-gamelift/commands/ListGameServersCommand.ts @@ -45,6 +45,20 @@ export interface ListGameServersCommandOutput extends ListGameServersOutput, __M * DeregisterGameServer | * All APIs by task *

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { GameLiftClient, ListGameServersCommand } from "@aws-sdk/client-gamelift"; // ES Modules import + * // const { GameLiftClient, ListGameServersCommand } = require("@aws-sdk/client-gamelift"); // CommonJS import + * const client = new GameLiftClient(config); + * const command = new ListGameServersCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListGameServersCommandInput} for command's `input` shape. + * @see {@link ListGameServersCommandOutput} for command's `response` shape. + * @see {@link GameLiftClientResolvedConfig | config} for command's `input` shape. + * */ export class ListGameServersCommand extends $Command< ListGameServersCommandInput, diff --git a/clients/client-gamelift/commands/ListScriptsCommand.ts b/clients/client-gamelift/commands/ListScriptsCommand.ts index 8ac5ca0db859..0463683876e4 100644 --- a/clients/client-gamelift/commands/ListScriptsCommand.ts +++ b/clients/client-gamelift/commands/ListScriptsCommand.ts @@ -39,6 +39,20 @@ export interface ListScriptsCommandOutput extends ListScriptsOutput, __MetadataB * DeleteScript | * All APIs by task *

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { GameLiftClient, ListScriptsCommand } from "@aws-sdk/client-gamelift"; // ES Modules import + * // const { GameLiftClient, ListScriptsCommand } = require("@aws-sdk/client-gamelift"); // CommonJS import + * const client = new GameLiftClient(config); + * const command = new ListScriptsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListScriptsCommandInput} for command's `input` shape. + * @see {@link ListScriptsCommandOutput} for command's `response` shape. + * @see {@link GameLiftClientResolvedConfig | config} for command's `input` shape. + * */ export class ListScriptsCommand extends $Command< ListScriptsCommandInput, diff --git a/clients/client-gamelift/commands/ListTagsForResourceCommand.ts b/clients/client-gamelift/commands/ListTagsForResourceCommand.ts index 486c1ebf5a9e..7e4e973c897c 100644 --- a/clients/client-gamelift/commands/ListTagsForResourceCommand.ts +++ b/clients/client-gamelift/commands/ListTagsForResourceCommand.ts @@ -70,6 +70,20 @@ export interface ListTagsForResourceCommandOutput extends ListTagsForResourceRes * ListTagsForResource | * All APIs by task *

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { GameLiftClient, ListTagsForResourceCommand } from "@aws-sdk/client-gamelift"; // ES Modules import + * // const { GameLiftClient, ListTagsForResourceCommand } = require("@aws-sdk/client-gamelift"); // CommonJS import + * const client = new GameLiftClient(config); + * const command = new ListTagsForResourceCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListTagsForResourceCommandInput} for command's `input` shape. + * @see {@link ListTagsForResourceCommandOutput} for command's `response` shape. + * @see {@link GameLiftClientResolvedConfig | config} for command's `input` shape. + * */ export class ListTagsForResourceCommand extends $Command< ListTagsForResourceCommandInput, diff --git a/clients/client-gamelift/commands/PutScalingPolicyCommand.ts b/clients/client-gamelift/commands/PutScalingPolicyCommand.ts index b4367711798f..69dc1fda040c 100644 --- a/clients/client-gamelift/commands/PutScalingPolicyCommand.ts +++ b/clients/client-gamelift/commands/PutScalingPolicyCommand.ts @@ -98,6 +98,20 @@ export interface PutScalingPolicyCommandOutput extends PutScalingPolicyOutput, _ * StartFleetActions | * All APIs by task *

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { GameLiftClient, PutScalingPolicyCommand } from "@aws-sdk/client-gamelift"; // ES Modules import + * // const { GameLiftClient, PutScalingPolicyCommand } = require("@aws-sdk/client-gamelift"); // CommonJS import + * const client = new GameLiftClient(config); + * const command = new PutScalingPolicyCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link PutScalingPolicyCommandInput} for command's `input` shape. + * @see {@link PutScalingPolicyCommandOutput} for command's `response` shape. + * @see {@link GameLiftClientResolvedConfig | config} for command's `input` shape. + * */ export class PutScalingPolicyCommand extends $Command< PutScalingPolicyCommandInput, diff --git a/clients/client-gamelift/commands/RegisterGameServerCommand.ts b/clients/client-gamelift/commands/RegisterGameServerCommand.ts index 1e5787130515..50dd1f8db387 100644 --- a/clients/client-gamelift/commands/RegisterGameServerCommand.ts +++ b/clients/client-gamelift/commands/RegisterGameServerCommand.ts @@ -56,6 +56,20 @@ export interface RegisterGameServerCommandOutput extends RegisterGameServerOutpu * DeregisterGameServer | * All APIs by task *

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { GameLiftClient, RegisterGameServerCommand } from "@aws-sdk/client-gamelift"; // ES Modules import + * // const { GameLiftClient, RegisterGameServerCommand } = require("@aws-sdk/client-gamelift"); // CommonJS import + * const client = new GameLiftClient(config); + * const command = new RegisterGameServerCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link RegisterGameServerCommandInput} for command's `input` shape. + * @see {@link RegisterGameServerCommandOutput} for command's `response` shape. + * @see {@link GameLiftClientResolvedConfig | config} for command's `input` shape. + * */ export class RegisterGameServerCommand extends $Command< RegisterGameServerCommandInput, diff --git a/clients/client-gamelift/commands/RequestUploadCredentialsCommand.ts b/clients/client-gamelift/commands/RequestUploadCredentialsCommand.ts index 5c1b287163b6..dda8322a93fa 100644 --- a/clients/client-gamelift/commands/RequestUploadCredentialsCommand.ts +++ b/clients/client-gamelift/commands/RequestUploadCredentialsCommand.ts @@ -45,6 +45,20 @@ export interface RequestUploadCredentialsCommandOutput extends RequestUploadCred * DeleteBuild | * All APIs by task *

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { GameLiftClient, RequestUploadCredentialsCommand } from "@aws-sdk/client-gamelift"; // ES Modules import + * // const { GameLiftClient, RequestUploadCredentialsCommand } = require("@aws-sdk/client-gamelift"); // CommonJS import + * const client = new GameLiftClient(config); + * const command = new RequestUploadCredentialsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link RequestUploadCredentialsCommandInput} for command's `input` shape. + * @see {@link RequestUploadCredentialsCommandOutput} for command's `response` shape. + * @see {@link GameLiftClientResolvedConfig | config} for command's `input` shape. + * */ export class RequestUploadCredentialsCommand extends $Command< RequestUploadCredentialsCommandInput, diff --git a/clients/client-gamelift/commands/ResolveAliasCommand.ts b/clients/client-gamelift/commands/ResolveAliasCommand.ts index 6f262034950e..d373be8c5c85 100644 --- a/clients/client-gamelift/commands/ResolveAliasCommand.ts +++ b/clients/client-gamelift/commands/ResolveAliasCommand.ts @@ -34,6 +34,20 @@ export interface ResolveAliasCommandOutput extends ResolveAliasOutput, __Metadat * ResolveAlias | * All APIs by task *

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { GameLiftClient, ResolveAliasCommand } from "@aws-sdk/client-gamelift"; // ES Modules import + * // const { GameLiftClient, ResolveAliasCommand } = require("@aws-sdk/client-gamelift"); // CommonJS import + * const client = new GameLiftClient(config); + * const command = new ResolveAliasCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ResolveAliasCommandInput} for command's `input` shape. + * @see {@link ResolveAliasCommandOutput} for command's `response` shape. + * @see {@link GameLiftClientResolvedConfig | config} for command's `input` shape. + * */ export class ResolveAliasCommand extends $Command< ResolveAliasCommandInput, diff --git a/clients/client-gamelift/commands/ResumeGameServerGroupCommand.ts b/clients/client-gamelift/commands/ResumeGameServerGroupCommand.ts index 49befac89ec6..2be7bab49c4f 100644 --- a/clients/client-gamelift/commands/ResumeGameServerGroupCommand.ts +++ b/clients/client-gamelift/commands/ResumeGameServerGroupCommand.ts @@ -53,6 +53,20 @@ export interface ResumeGameServerGroupCommandOutput extends ResumeGameServerGrou * DescribeGameServerInstances | * All APIs by task *

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { GameLiftClient, ResumeGameServerGroupCommand } from "@aws-sdk/client-gamelift"; // ES Modules import + * // const { GameLiftClient, ResumeGameServerGroupCommand } = require("@aws-sdk/client-gamelift"); // CommonJS import + * const client = new GameLiftClient(config); + * const command = new ResumeGameServerGroupCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ResumeGameServerGroupCommandInput} for command's `input` shape. + * @see {@link ResumeGameServerGroupCommandOutput} for command's `response` shape. + * @see {@link GameLiftClientResolvedConfig | config} for command's `input` shape. + * */ export class ResumeGameServerGroupCommand extends $Command< ResumeGameServerGroupCommandInput, diff --git a/clients/client-gamelift/commands/SearchGameSessionsCommand.ts b/clients/client-gamelift/commands/SearchGameSessionsCommand.ts index 56318b6e8b37..46de2b8cbba8 100644 --- a/clients/client-gamelift/commands/SearchGameSessionsCommand.ts +++ b/clients/client-gamelift/commands/SearchGameSessionsCommand.ts @@ -118,6 +118,20 @@ export interface SearchGameSessionsCommandOutput extends SearchGameSessionsOutpu * StopGameSessionPlacement | * All APIs by task *

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { GameLiftClient, SearchGameSessionsCommand } from "@aws-sdk/client-gamelift"; // ES Modules import + * // const { GameLiftClient, SearchGameSessionsCommand } = require("@aws-sdk/client-gamelift"); // CommonJS import + * const client = new GameLiftClient(config); + * const command = new SearchGameSessionsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link SearchGameSessionsCommandInput} for command's `input` shape. + * @see {@link SearchGameSessionsCommandOutput} for command's `response` shape. + * @see {@link GameLiftClientResolvedConfig | config} for command's `input` shape. + * */ export class SearchGameSessionsCommand extends $Command< SearchGameSessionsCommandInput, diff --git a/clients/client-gamelift/commands/StartFleetActionsCommand.ts b/clients/client-gamelift/commands/StartFleetActionsCommand.ts index 881feca150ce..91a0f74bb001 100644 --- a/clients/client-gamelift/commands/StartFleetActionsCommand.ts +++ b/clients/client-gamelift/commands/StartFleetActionsCommand.ts @@ -59,6 +59,20 @@ export interface StartFleetActionsCommandOutput extends StartFleetActionsOutput, * DeleteFleet | * All APIs by task *

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { GameLiftClient, StartFleetActionsCommand } from "@aws-sdk/client-gamelift"; // ES Modules import + * // const { GameLiftClient, StartFleetActionsCommand } = require("@aws-sdk/client-gamelift"); // CommonJS import + * const client = new GameLiftClient(config); + * const command = new StartFleetActionsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link StartFleetActionsCommandInput} for command's `input` shape. + * @see {@link StartFleetActionsCommandOutput} for command's `response` shape. + * @see {@link GameLiftClientResolvedConfig | config} for command's `input` shape. + * */ export class StartFleetActionsCommand extends $Command< StartFleetActionsCommandInput, diff --git a/clients/client-gamelift/commands/StartGameSessionPlacementCommand.ts b/clients/client-gamelift/commands/StartGameSessionPlacementCommand.ts index ab7802a50140..3623204e6eb8 100644 --- a/clients/client-gamelift/commands/StartGameSessionPlacementCommand.ts +++ b/clients/client-gamelift/commands/StartGameSessionPlacementCommand.ts @@ -76,6 +76,20 @@ export interface StartGameSessionPlacementCommandOutput extends StartGameSession * StopGameSessionPlacement | * All APIs by task *

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { GameLiftClient, StartGameSessionPlacementCommand } from "@aws-sdk/client-gamelift"; // ES Modules import + * // const { GameLiftClient, StartGameSessionPlacementCommand } = require("@aws-sdk/client-gamelift"); // CommonJS import + * const client = new GameLiftClient(config); + * const command = new StartGameSessionPlacementCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link StartGameSessionPlacementCommandInput} for command's `input` shape. + * @see {@link StartGameSessionPlacementCommandOutput} for command's `response` shape. + * @see {@link GameLiftClientResolvedConfig | config} for command's `input` shape. + * */ export class StartGameSessionPlacementCommand extends $Command< StartGameSessionPlacementCommandInput, diff --git a/clients/client-gamelift/commands/StartMatchBackfillCommand.ts b/clients/client-gamelift/commands/StartMatchBackfillCommand.ts index 10c047915c53..4486e44e3431 100644 --- a/clients/client-gamelift/commands/StartMatchBackfillCommand.ts +++ b/clients/client-gamelift/commands/StartMatchBackfillCommand.ts @@ -68,6 +68,20 @@ export interface StartMatchBackfillCommandOutput extends StartMatchBackfillOutpu * StartMatchBackfill | * All APIs by task *

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { GameLiftClient, StartMatchBackfillCommand } from "@aws-sdk/client-gamelift"; // ES Modules import + * // const { GameLiftClient, StartMatchBackfillCommand } = require("@aws-sdk/client-gamelift"); // CommonJS import + * const client = new GameLiftClient(config); + * const command = new StartMatchBackfillCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link StartMatchBackfillCommandInput} for command's `input` shape. + * @see {@link StartMatchBackfillCommandOutput} for command's `response` shape. + * @see {@link GameLiftClientResolvedConfig | config} for command's `input` shape. + * */ export class StartMatchBackfillCommand extends $Command< StartMatchBackfillCommandInput, diff --git a/clients/client-gamelift/commands/StartMatchmakingCommand.ts b/clients/client-gamelift/commands/StartMatchmakingCommand.ts index 46aa769842f3..2ae17f3c6645 100644 --- a/clients/client-gamelift/commands/StartMatchmakingCommand.ts +++ b/clients/client-gamelift/commands/StartMatchmakingCommand.ts @@ -62,6 +62,20 @@ export interface StartMatchmakingCommandOutput extends StartMatchmakingOutput, _ * StartMatchBackfill | * All APIs by task *

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { GameLiftClient, StartMatchmakingCommand } from "@aws-sdk/client-gamelift"; // ES Modules import + * // const { GameLiftClient, StartMatchmakingCommand } = require("@aws-sdk/client-gamelift"); // CommonJS import + * const client = new GameLiftClient(config); + * const command = new StartMatchmakingCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link StartMatchmakingCommandInput} for command's `input` shape. + * @see {@link StartMatchmakingCommandOutput} for command's `response` shape. + * @see {@link GameLiftClientResolvedConfig | config} for command's `input` shape. + * */ export class StartMatchmakingCommand extends $Command< StartMatchmakingCommandInput, diff --git a/clients/client-gamelift/commands/StopFleetActionsCommand.ts b/clients/client-gamelift/commands/StopFleetActionsCommand.ts index 5a0ee64b8f07..792ea62fd890 100644 --- a/clients/client-gamelift/commands/StopFleetActionsCommand.ts +++ b/clients/client-gamelift/commands/StopFleetActionsCommand.ts @@ -64,6 +64,20 @@ export interface StopFleetActionsCommandOutput extends StopFleetActionsOutput, _ * DeleteFleet | * All APIs by task *

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { GameLiftClient, StopFleetActionsCommand } from "@aws-sdk/client-gamelift"; // ES Modules import + * // const { GameLiftClient, StopFleetActionsCommand } = require("@aws-sdk/client-gamelift"); // CommonJS import + * const client = new GameLiftClient(config); + * const command = new StopFleetActionsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link StopFleetActionsCommandInput} for command's `input` shape. + * @see {@link StopFleetActionsCommandOutput} for command's `response` shape. + * @see {@link GameLiftClientResolvedConfig | config} for command's `input` shape. + * */ export class StopFleetActionsCommand extends $Command< StopFleetActionsCommandInput, diff --git a/clients/client-gamelift/commands/StopGameSessionPlacementCommand.ts b/clients/client-gamelift/commands/StopGameSessionPlacementCommand.ts index 076f6cfa5364..1c5cb0b5ebf6 100644 --- a/clients/client-gamelift/commands/StopGameSessionPlacementCommand.ts +++ b/clients/client-gamelift/commands/StopGameSessionPlacementCommand.ts @@ -39,6 +39,20 @@ export interface StopGameSessionPlacementCommandOutput extends StopGameSessionPl * StopGameSessionPlacement | * All APIs by task *

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { GameLiftClient, StopGameSessionPlacementCommand } from "@aws-sdk/client-gamelift"; // ES Modules import + * // const { GameLiftClient, StopGameSessionPlacementCommand } = require("@aws-sdk/client-gamelift"); // CommonJS import + * const client = new GameLiftClient(config); + * const command = new StopGameSessionPlacementCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link StopGameSessionPlacementCommandInput} for command's `input` shape. + * @see {@link StopGameSessionPlacementCommandOutput} for command's `response` shape. + * @see {@link GameLiftClientResolvedConfig | config} for command's `input` shape. + * */ export class StopGameSessionPlacementCommand extends $Command< StopGameSessionPlacementCommandInput, diff --git a/clients/client-gamelift/commands/StopMatchmakingCommand.ts b/clients/client-gamelift/commands/StopMatchmakingCommand.ts index 7ca5b0284405..4526f44962e9 100644 --- a/clients/client-gamelift/commands/StopMatchmakingCommand.ts +++ b/clients/client-gamelift/commands/StopMatchmakingCommand.ts @@ -51,6 +51,20 @@ export interface StopMatchmakingCommandOutput extends StopMatchmakingOutput, __M * StartMatchBackfill | * All APIs by task *

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { GameLiftClient, StopMatchmakingCommand } from "@aws-sdk/client-gamelift"; // ES Modules import + * // const { GameLiftClient, StopMatchmakingCommand } = require("@aws-sdk/client-gamelift"); // CommonJS import + * const client = new GameLiftClient(config); + * const command = new StopMatchmakingCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link StopMatchmakingCommandInput} for command's `input` shape. + * @see {@link StopMatchmakingCommandOutput} for command's `response` shape. + * @see {@link GameLiftClientResolvedConfig | config} for command's `input` shape. + * */ export class StopMatchmakingCommand extends $Command< StopMatchmakingCommandInput, diff --git a/clients/client-gamelift/commands/SuspendGameServerGroupCommand.ts b/clients/client-gamelift/commands/SuspendGameServerGroupCommand.ts index 47440c3c5884..0b08ead37572 100644 --- a/clients/client-gamelift/commands/SuspendGameServerGroupCommand.ts +++ b/clients/client-gamelift/commands/SuspendGameServerGroupCommand.ts @@ -63,6 +63,20 @@ export interface SuspendGameServerGroupCommandOutput extends SuspendGameServerGr * DescribeGameServerInstances | * All APIs by task *

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { GameLiftClient, SuspendGameServerGroupCommand } from "@aws-sdk/client-gamelift"; // ES Modules import + * // const { GameLiftClient, SuspendGameServerGroupCommand } = require("@aws-sdk/client-gamelift"); // CommonJS import + * const client = new GameLiftClient(config); + * const command = new SuspendGameServerGroupCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link SuspendGameServerGroupCommandInput} for command's `input` shape. + * @see {@link SuspendGameServerGroupCommandOutput} for command's `response` shape. + * @see {@link GameLiftClientResolvedConfig | config} for command's `input` shape. + * */ export class SuspendGameServerGroupCommand extends $Command< SuspendGameServerGroupCommandInput, diff --git a/clients/client-gamelift/commands/TagResourceCommand.ts b/clients/client-gamelift/commands/TagResourceCommand.ts index d135f284ea37..06cc640be1ce 100644 --- a/clients/client-gamelift/commands/TagResourceCommand.ts +++ b/clients/client-gamelift/commands/TagResourceCommand.ts @@ -72,6 +72,20 @@ export interface TagResourceCommandOutput extends TagResourceResponse, __Metadat * ListTagsForResource | * All APIs by task *

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { GameLiftClient, TagResourceCommand } from "@aws-sdk/client-gamelift"; // ES Modules import + * // const { GameLiftClient, TagResourceCommand } = require("@aws-sdk/client-gamelift"); // CommonJS import + * const client = new GameLiftClient(config); + * const command = new TagResourceCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link TagResourceCommandInput} for command's `input` shape. + * @see {@link TagResourceCommandOutput} for command's `response` shape. + * @see {@link GameLiftClientResolvedConfig | config} for command's `input` shape. + * */ export class TagResourceCommand extends $Command< TagResourceCommandInput, diff --git a/clients/client-gamelift/commands/UntagResourceCommand.ts b/clients/client-gamelift/commands/UntagResourceCommand.ts index 2dd7798e9d56..df07a05344c4 100644 --- a/clients/client-gamelift/commands/UntagResourceCommand.ts +++ b/clients/client-gamelift/commands/UntagResourceCommand.ts @@ -72,6 +72,20 @@ export interface UntagResourceCommandOutput extends UntagResourceResponse, __Met * ListTagsForResource | * All APIs by task *

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { GameLiftClient, UntagResourceCommand } from "@aws-sdk/client-gamelift"; // ES Modules import + * // const { GameLiftClient, UntagResourceCommand } = require("@aws-sdk/client-gamelift"); // CommonJS import + * const client = new GameLiftClient(config); + * const command = new UntagResourceCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link UntagResourceCommandInput} for command's `input` shape. + * @see {@link UntagResourceCommandOutput} for command's `response` shape. + * @see {@link GameLiftClientResolvedConfig | config} for command's `input` shape. + * */ export class UntagResourceCommand extends $Command< UntagResourceCommandInput, diff --git a/clients/client-gamelift/commands/UpdateAliasCommand.ts b/clients/client-gamelift/commands/UpdateAliasCommand.ts index e073f2902802..90e52d5ba8a2 100644 --- a/clients/client-gamelift/commands/UpdateAliasCommand.ts +++ b/clients/client-gamelift/commands/UpdateAliasCommand.ts @@ -37,6 +37,20 @@ export interface UpdateAliasCommandOutput extends UpdateAliasOutput, __MetadataB * ResolveAlias | * All APIs by task *

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { GameLiftClient, UpdateAliasCommand } from "@aws-sdk/client-gamelift"; // ES Modules import + * // const { GameLiftClient, UpdateAliasCommand } = require("@aws-sdk/client-gamelift"); // CommonJS import + * const client = new GameLiftClient(config); + * const command = new UpdateAliasCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link UpdateAliasCommandInput} for command's `input` shape. + * @see {@link UpdateAliasCommandOutput} for command's `response` shape. + * @see {@link GameLiftClientResolvedConfig | config} for command's `input` shape. + * */ export class UpdateAliasCommand extends $Command< UpdateAliasCommandInput, diff --git a/clients/client-gamelift/commands/UpdateBuildCommand.ts b/clients/client-gamelift/commands/UpdateBuildCommand.ts index 336c08ebcb5d..727e112fc562 100644 --- a/clients/client-gamelift/commands/UpdateBuildCommand.ts +++ b/clients/client-gamelift/commands/UpdateBuildCommand.ts @@ -42,6 +42,20 @@ export interface UpdateBuildCommandOutput extends UpdateBuildOutput, __MetadataB * DeleteBuild | * All APIs by task *

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { GameLiftClient, UpdateBuildCommand } from "@aws-sdk/client-gamelift"; // ES Modules import + * // const { GameLiftClient, UpdateBuildCommand } = require("@aws-sdk/client-gamelift"); // CommonJS import + * const client = new GameLiftClient(config); + * const command = new UpdateBuildCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link UpdateBuildCommandInput} for command's `input` shape. + * @see {@link UpdateBuildCommandOutput} for command's `response` shape. + * @see {@link GameLiftClientResolvedConfig | config} for command's `input` shape. + * */ export class UpdateBuildCommand extends $Command< UpdateBuildCommandInput, diff --git a/clients/client-gamelift/commands/UpdateFleetAttributesCommand.ts b/clients/client-gamelift/commands/UpdateFleetAttributesCommand.ts index a0e57e4021fc..35039974ba47 100644 --- a/clients/client-gamelift/commands/UpdateFleetAttributesCommand.ts +++ b/clients/client-gamelift/commands/UpdateFleetAttributesCommand.ts @@ -49,6 +49,20 @@ export interface UpdateFleetAttributesCommandOutput extends UpdateFleetAttribute * DeleteScalingPolicy | * All APIs by task *

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { GameLiftClient, UpdateFleetAttributesCommand } from "@aws-sdk/client-gamelift"; // ES Modules import + * // const { GameLiftClient, UpdateFleetAttributesCommand } = require("@aws-sdk/client-gamelift"); // CommonJS import + * const client = new GameLiftClient(config); + * const command = new UpdateFleetAttributesCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link UpdateFleetAttributesCommandInput} for command's `input` shape. + * @see {@link UpdateFleetAttributesCommandOutput} for command's `response` shape. + * @see {@link GameLiftClientResolvedConfig | config} for command's `input` shape. + * */ export class UpdateFleetAttributesCommand extends $Command< UpdateFleetAttributesCommandInput, diff --git a/clients/client-gamelift/commands/UpdateFleetCapacityCommand.ts b/clients/client-gamelift/commands/UpdateFleetCapacityCommand.ts index 3d38f2e5e314..b94a7dafb24e 100644 --- a/clients/client-gamelift/commands/UpdateFleetCapacityCommand.ts +++ b/clients/client-gamelift/commands/UpdateFleetCapacityCommand.ts @@ -82,6 +82,20 @@ export interface UpdateFleetCapacityCommandOutput extends UpdateFleetCapacityOut * DeleteScalingPolicy | * All APIs by task *

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { GameLiftClient, UpdateFleetCapacityCommand } from "@aws-sdk/client-gamelift"; // ES Modules import + * // const { GameLiftClient, UpdateFleetCapacityCommand } = require("@aws-sdk/client-gamelift"); // CommonJS import + * const client = new GameLiftClient(config); + * const command = new UpdateFleetCapacityCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link UpdateFleetCapacityCommandInput} for command's `input` shape. + * @see {@link UpdateFleetCapacityCommandOutput} for command's `response` shape. + * @see {@link GameLiftClientResolvedConfig | config} for command's `input` shape. + * */ export class UpdateFleetCapacityCommand extends $Command< UpdateFleetCapacityCommandInput, diff --git a/clients/client-gamelift/commands/UpdateFleetPortSettingsCommand.ts b/clients/client-gamelift/commands/UpdateFleetPortSettingsCommand.ts index 431707f1283c..04d286dd09c0 100644 --- a/clients/client-gamelift/commands/UpdateFleetPortSettingsCommand.ts +++ b/clients/client-gamelift/commands/UpdateFleetPortSettingsCommand.ts @@ -55,6 +55,20 @@ export interface UpdateFleetPortSettingsCommandOutput extends UpdateFleetPortSet * DeleteScalingPolicy | * All APIs by task *

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { GameLiftClient, UpdateFleetPortSettingsCommand } from "@aws-sdk/client-gamelift"; // ES Modules import + * // const { GameLiftClient, UpdateFleetPortSettingsCommand } = require("@aws-sdk/client-gamelift"); // CommonJS import + * const client = new GameLiftClient(config); + * const command = new UpdateFleetPortSettingsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link UpdateFleetPortSettingsCommandInput} for command's `input` shape. + * @see {@link UpdateFleetPortSettingsCommandOutput} for command's `response` shape. + * @see {@link GameLiftClientResolvedConfig | config} for command's `input` shape. + * */ export class UpdateFleetPortSettingsCommand extends $Command< UpdateFleetPortSettingsCommandInput, diff --git a/clients/client-gamelift/commands/UpdateGameServerCommand.ts b/clients/client-gamelift/commands/UpdateGameServerCommand.ts index 1d90a62467fa..417ec7b99631 100644 --- a/clients/client-gamelift/commands/UpdateGameServerCommand.ts +++ b/clients/client-gamelift/commands/UpdateGameServerCommand.ts @@ -67,6 +67,20 @@ export interface UpdateGameServerCommandOutput extends UpdateGameServerOutput, _ * DeregisterGameServer | * All APIs by task *

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { GameLiftClient, UpdateGameServerCommand } from "@aws-sdk/client-gamelift"; // ES Modules import + * // const { GameLiftClient, UpdateGameServerCommand } = require("@aws-sdk/client-gamelift"); // CommonJS import + * const client = new GameLiftClient(config); + * const command = new UpdateGameServerCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link UpdateGameServerCommandInput} for command's `input` shape. + * @see {@link UpdateGameServerCommandOutput} for command's `response` shape. + * @see {@link GameLiftClientResolvedConfig | config} for command's `input` shape. + * */ export class UpdateGameServerCommand extends $Command< UpdateGameServerCommandInput, diff --git a/clients/client-gamelift/commands/UpdateGameServerGroupCommand.ts b/clients/client-gamelift/commands/UpdateGameServerGroupCommand.ts index 56c22bdbd376..a3000e8269eb 100644 --- a/clients/client-gamelift/commands/UpdateGameServerGroupCommand.ts +++ b/clients/client-gamelift/commands/UpdateGameServerGroupCommand.ts @@ -51,6 +51,20 @@ export interface UpdateGameServerGroupCommandOutput extends UpdateGameServerGrou * DescribeGameServerInstances | * All APIs by task *

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { GameLiftClient, UpdateGameServerGroupCommand } from "@aws-sdk/client-gamelift"; // ES Modules import + * // const { GameLiftClient, UpdateGameServerGroupCommand } = require("@aws-sdk/client-gamelift"); // CommonJS import + * const client = new GameLiftClient(config); + * const command = new UpdateGameServerGroupCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link UpdateGameServerGroupCommandInput} for command's `input` shape. + * @see {@link UpdateGameServerGroupCommandOutput} for command's `response` shape. + * @see {@link GameLiftClientResolvedConfig | config} for command's `input` shape. + * */ export class UpdateGameServerGroupCommand extends $Command< UpdateGameServerGroupCommandInput, diff --git a/clients/client-gamelift/commands/UpdateGameSessionCommand.ts b/clients/client-gamelift/commands/UpdateGameSessionCommand.ts index f915df113f49..a8b9cc3cd0ed 100644 --- a/clients/client-gamelift/commands/UpdateGameSessionCommand.ts +++ b/clients/client-gamelift/commands/UpdateGameSessionCommand.ts @@ -40,6 +40,20 @@ export interface UpdateGameSessionCommandOutput extends UpdateGameSessionOutput, * StopGameSessionPlacement | * All APIs by task *

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { GameLiftClient, UpdateGameSessionCommand } from "@aws-sdk/client-gamelift"; // ES Modules import + * // const { GameLiftClient, UpdateGameSessionCommand } = require("@aws-sdk/client-gamelift"); // CommonJS import + * const client = new GameLiftClient(config); + * const command = new UpdateGameSessionCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link UpdateGameSessionCommandInput} for command's `input` shape. + * @see {@link UpdateGameSessionCommandOutput} for command's `response` shape. + * @see {@link GameLiftClientResolvedConfig | config} for command's `input` shape. + * */ export class UpdateGameSessionCommand extends $Command< UpdateGameSessionCommandInput, diff --git a/clients/client-gamelift/commands/UpdateGameSessionQueueCommand.ts b/clients/client-gamelift/commands/UpdateGameSessionQueueCommand.ts index 0eb3dec1f000..0c25a2b8a08b 100644 --- a/clients/client-gamelift/commands/UpdateGameSessionQueueCommand.ts +++ b/clients/client-gamelift/commands/UpdateGameSessionQueueCommand.ts @@ -42,6 +42,20 @@ export interface UpdateGameSessionQueueCommandOutput extends UpdateGameSessionQu * DeleteGameSessionQueue | * All APIs by task *

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { GameLiftClient, UpdateGameSessionQueueCommand } from "@aws-sdk/client-gamelift"; // ES Modules import + * // const { GameLiftClient, UpdateGameSessionQueueCommand } = require("@aws-sdk/client-gamelift"); // CommonJS import + * const client = new GameLiftClient(config); + * const command = new UpdateGameSessionQueueCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link UpdateGameSessionQueueCommandInput} for command's `input` shape. + * @see {@link UpdateGameSessionQueueCommandOutput} for command's `response` shape. + * @see {@link GameLiftClientResolvedConfig | config} for command's `input` shape. + * */ export class UpdateGameSessionQueueCommand extends $Command< UpdateGameSessionQueueCommandInput, diff --git a/clients/client-gamelift/commands/UpdateMatchmakingConfigurationCommand.ts b/clients/client-gamelift/commands/UpdateMatchmakingConfigurationCommand.ts index 64fd4c18a689..879858fd92cf 100644 --- a/clients/client-gamelift/commands/UpdateMatchmakingConfigurationCommand.ts +++ b/clients/client-gamelift/commands/UpdateMatchmakingConfigurationCommand.ts @@ -47,6 +47,20 @@ export interface UpdateMatchmakingConfigurationCommandOutput * DeleteMatchmakingRuleSet | * All APIs by task *

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { GameLiftClient, UpdateMatchmakingConfigurationCommand } from "@aws-sdk/client-gamelift"; // ES Modules import + * // const { GameLiftClient, UpdateMatchmakingConfigurationCommand } = require("@aws-sdk/client-gamelift"); // CommonJS import + * const client = new GameLiftClient(config); + * const command = new UpdateMatchmakingConfigurationCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link UpdateMatchmakingConfigurationCommandInput} for command's `input` shape. + * @see {@link UpdateMatchmakingConfigurationCommandOutput} for command's `response` shape. + * @see {@link GameLiftClientResolvedConfig | config} for command's `input` shape. + * */ export class UpdateMatchmakingConfigurationCommand extends $Command< UpdateMatchmakingConfigurationCommandInput, diff --git a/clients/client-gamelift/commands/UpdateRuntimeConfigurationCommand.ts b/clients/client-gamelift/commands/UpdateRuntimeConfigurationCommand.ts index 3a549d4dcc40..2efbf5bc9d51 100644 --- a/clients/client-gamelift/commands/UpdateRuntimeConfigurationCommand.ts +++ b/clients/client-gamelift/commands/UpdateRuntimeConfigurationCommand.ts @@ -56,6 +56,20 @@ export interface UpdateRuntimeConfigurationCommandOutput extends UpdateRuntimeCo * DeleteScalingPolicy | * All APIs by task *

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { GameLiftClient, UpdateRuntimeConfigurationCommand } from "@aws-sdk/client-gamelift"; // ES Modules import + * // const { GameLiftClient, UpdateRuntimeConfigurationCommand } = require("@aws-sdk/client-gamelift"); // CommonJS import + * const client = new GameLiftClient(config); + * const command = new UpdateRuntimeConfigurationCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link UpdateRuntimeConfigurationCommandInput} for command's `input` shape. + * @see {@link UpdateRuntimeConfigurationCommandOutput} for command's `response` shape. + * @see {@link GameLiftClientResolvedConfig | config} for command's `input` shape. + * */ export class UpdateRuntimeConfigurationCommand extends $Command< UpdateRuntimeConfigurationCommandInput, diff --git a/clients/client-gamelift/commands/UpdateScriptCommand.ts b/clients/client-gamelift/commands/UpdateScriptCommand.ts index 32e0b8900f7a..283964676010 100644 --- a/clients/client-gamelift/commands/UpdateScriptCommand.ts +++ b/clients/client-gamelift/commands/UpdateScriptCommand.ts @@ -48,6 +48,20 @@ export interface UpdateScriptCommandOutput extends UpdateScriptOutput, __Metadat * DeleteScript | * All APIs by task *

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { GameLiftClient, UpdateScriptCommand } from "@aws-sdk/client-gamelift"; // ES Modules import + * // const { GameLiftClient, UpdateScriptCommand } = require("@aws-sdk/client-gamelift"); // CommonJS import + * const client = new GameLiftClient(config); + * const command = new UpdateScriptCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link UpdateScriptCommandInput} for command's `input` shape. + * @see {@link UpdateScriptCommandOutput} for command's `response` shape. + * @see {@link GameLiftClientResolvedConfig | config} for command's `input` shape. + * */ export class UpdateScriptCommand extends $Command< UpdateScriptCommandInput, diff --git a/clients/client-gamelift/commands/ValidateMatchmakingRuleSetCommand.ts b/clients/client-gamelift/commands/ValidateMatchmakingRuleSetCommand.ts index 49a8e8994b9f..165963fa0c1d 100644 --- a/clients/client-gamelift/commands/ValidateMatchmakingRuleSetCommand.ts +++ b/clients/client-gamelift/commands/ValidateMatchmakingRuleSetCommand.ts @@ -49,6 +49,20 @@ export interface ValidateMatchmakingRuleSetCommandOutput extends ValidateMatchma * DeleteMatchmakingRuleSet | * All APIs by task *

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { GameLiftClient, ValidateMatchmakingRuleSetCommand } from "@aws-sdk/client-gamelift"; // ES Modules import + * // const { GameLiftClient, ValidateMatchmakingRuleSetCommand } = require("@aws-sdk/client-gamelift"); // CommonJS import + * const client = new GameLiftClient(config); + * const command = new ValidateMatchmakingRuleSetCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ValidateMatchmakingRuleSetCommandInput} for command's `input` shape. + * @see {@link ValidateMatchmakingRuleSetCommandOutput} for command's `response` shape. + * @see {@link GameLiftClientResolvedConfig | config} for command's `input` shape. + * */ export class ValidateMatchmakingRuleSetCommand extends $Command< ValidateMatchmakingRuleSetCommandInput, diff --git a/clients/client-gamelift/models/models_0.ts b/clients/client-gamelift/models/models_0.ts index 0e58cf7ab4a2..e524f1373560 100644 --- a/clients/client-gamelift/models/models_0.ts +++ b/clients/client-gamelift/models/models_0.ts @@ -26,6 +26,9 @@ export interface AcceptMatchInput { } export namespace AcceptMatchInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: AcceptMatchInput): any => ({ ...obj, }); @@ -34,6 +37,9 @@ export namespace AcceptMatchInput { export interface AcceptMatchOutput {} export namespace AcceptMatchOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: AcceptMatchOutput): any => ({ ...obj, }); @@ -51,6 +57,9 @@ export interface InternalServiceException extends __SmithyException, $MetadataBe } export namespace InternalServiceException { + /** + * @internal + */ export const filterSensitiveLog = (obj: InternalServiceException): any => ({ ...obj, }); @@ -67,6 +76,9 @@ export interface InvalidRequestException extends __SmithyException, $MetadataBea } export namespace InvalidRequestException { + /** + * @internal + */ export const filterSensitiveLog = (obj: InvalidRequestException): any => ({ ...obj, }); @@ -83,6 +95,9 @@ export interface NotFoundException extends __SmithyException, $MetadataBearer { } export namespace NotFoundException { + /** + * @internal + */ export const filterSensitiveLog = (obj: NotFoundException): any => ({ ...obj, }); @@ -98,6 +113,9 @@ export interface UnsupportedRegionException extends __SmithyException, $Metadata } export namespace UnsupportedRegionException { + /** + * @internal + */ export const filterSensitiveLog = (obj: UnsupportedRegionException): any => ({ ...obj, }); @@ -155,6 +173,9 @@ export interface RoutingStrategy { } export namespace RoutingStrategy { + /** + * @internal + */ export const filterSensitiveLog = (obj: RoutingStrategy): any => ({ ...obj, }); @@ -213,6 +234,9 @@ export interface Alias { } export namespace Alias { + /** + * @internal + */ export const filterSensitiveLog = (obj: Alias): any => ({ ...obj, }); @@ -250,6 +274,9 @@ export interface AttributeValue { } export namespace AttributeValue { + /** + * @internal + */ export const filterSensitiveLog = (obj: AttributeValue): any => ({ ...obj, }); @@ -279,6 +306,9 @@ export interface AwsCredentials { } export namespace AwsCredentials { + /** + * @internal + */ export const filterSensitiveLog = (obj: AwsCredentials): any => ({ ...obj, }); @@ -387,6 +417,9 @@ export interface Build { } export namespace Build { + /** + * @internal + */ export const filterSensitiveLog = (obj: Build): any => ({ ...obj, }); @@ -427,6 +460,9 @@ export interface CertificateConfiguration { } export namespace CertificateConfiguration { + /** + * @internal + */ export const filterSensitiveLog = (obj: CertificateConfiguration): any => ({ ...obj, }); @@ -456,6 +492,9 @@ export interface ClaimGameServerInput { } export namespace ClaimGameServerInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: ClaimGameServerInput): any => ({ ...obj, }); @@ -579,6 +618,9 @@ export interface GameServer { } export namespace GameServer { + /** + * @internal + */ export const filterSensitiveLog = (obj: GameServer): any => ({ ...obj, }); @@ -592,6 +634,9 @@ export interface ClaimGameServerOutput { } export namespace ClaimGameServerOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: ClaimGameServerOutput): any => ({ ...obj, }); @@ -609,6 +654,9 @@ export interface ConflictException extends __SmithyException, $MetadataBearer { } export namespace ConflictException { + /** + * @internal + */ export const filterSensitiveLog = (obj: ConflictException): any => ({ ...obj, }); @@ -628,6 +676,9 @@ export interface OutOfCapacityException extends __SmithyException, $MetadataBear } export namespace OutOfCapacityException { + /** + * @internal + */ export const filterSensitiveLog = (obj: OutOfCapacityException): any => ({ ...obj, }); @@ -643,6 +694,9 @@ export interface UnauthorizedException extends __SmithyException, $MetadataBeare } export namespace UnauthorizedException { + /** + * @internal + */ export const filterSensitiveLog = (obj: UnauthorizedException): any => ({ ...obj, }); @@ -697,6 +751,9 @@ export interface Tag { } export namespace Tag { + /** + * @internal + */ export const filterSensitiveLog = (obj: Tag): any => ({ ...obj, }); @@ -736,6 +793,9 @@ export interface CreateAliasInput { } export namespace CreateAliasInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateAliasInput): any => ({ ...obj, }); @@ -752,6 +812,9 @@ export interface CreateAliasOutput { } export namespace CreateAliasOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateAliasOutput): any => ({ ...obj, }); @@ -768,6 +831,9 @@ export interface LimitExceededException extends __SmithyException, $MetadataBear } export namespace LimitExceededException { + /** + * @internal + */ export const filterSensitiveLog = (obj: LimitExceededException): any => ({ ...obj, }); @@ -786,6 +852,9 @@ export interface TaggingFailedException extends __SmithyException, $MetadataBear } export namespace TaggingFailedException { + /** + * @internal + */ export const filterSensitiveLog = (obj: TaggingFailedException): any => ({ ...obj, }); @@ -826,6 +895,9 @@ export interface S3Location { } export namespace S3Location { + /** + * @internal + */ export const filterSensitiveLog = (obj: S3Location): any => ({ ...obj, }); @@ -880,6 +952,9 @@ export interface CreateBuildInput { } export namespace CreateBuildInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateBuildInput): any => ({ ...obj, }); @@ -910,6 +985,9 @@ export interface CreateBuildOutput { } export namespace CreateBuildOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateBuildOutput): any => ({ ...obj, ...(obj.UploadCredentials && { UploadCredentials: SENSITIVE_STRING }), @@ -960,6 +1038,9 @@ export interface IpPermission { } export namespace IpPermission { + /** + * @internal + */ export const filterSensitiveLog = (obj: IpPermission): any => ({ ...obj, }); @@ -1072,6 +1153,9 @@ export interface LocationConfiguration { } export namespace LocationConfiguration { + /** + * @internal + */ export const filterSensitiveLog = (obj: LocationConfiguration): any => ({ ...obj, }); @@ -1106,6 +1190,9 @@ export interface ResourceCreationLimitPolicy { } export namespace ResourceCreationLimitPolicy { + /** + * @internal + */ export const filterSensitiveLog = (obj: ResourceCreationLimitPolicy): any => ({ ...obj, }); @@ -1148,6 +1235,9 @@ export interface ServerProcess { } export namespace ServerProcess { + /** + * @internal + */ export const filterSensitiveLog = (obj: ServerProcess): any => ({ ...obj, }); @@ -1195,6 +1285,9 @@ export interface RuntimeConfiguration { } export namespace RuntimeConfiguration { + /** + * @internal + */ export const filterSensitiveLog = (obj: RuntimeConfiguration): any => ({ ...obj, }); @@ -1385,6 +1478,9 @@ export interface CreateFleetInput { } export namespace CreateFleetInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateFleetInput): any => ({ ...obj, }); @@ -1607,6 +1703,9 @@ export interface FleetAttributes { } export namespace FleetAttributes { + /** + * @internal + */ export const filterSensitiveLog = (obj: FleetAttributes): any => ({ ...obj, }); @@ -1640,6 +1739,9 @@ export interface LocationState { } export namespace LocationState { + /** + * @internal + */ export const filterSensitiveLog = (obj: LocationState): any => ({ ...obj, }); @@ -1666,6 +1768,9 @@ export interface CreateFleetOutput { } export namespace CreateFleetOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateFleetOutput): any => ({ ...obj, }); @@ -1689,6 +1794,9 @@ export interface CreateFleetLocationsInput { } export namespace CreateFleetLocationsInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateFleetLocationsInput): any => ({ ...obj, }); @@ -1720,6 +1828,9 @@ export interface CreateFleetLocationsOutput { } export namespace CreateFleetLocationsOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateFleetLocationsOutput): any => ({ ...obj, }); @@ -1737,6 +1848,9 @@ export interface InvalidFleetStatusException extends __SmithyException, $Metadat } export namespace InvalidFleetStatusException { + /** + * @internal + */ export const filterSensitiveLog = (obj: InvalidFleetStatusException): any => ({ ...obj, }); @@ -1761,6 +1875,9 @@ export interface TargetTrackingConfiguration { } export namespace TargetTrackingConfiguration { + /** + * @internal + */ export const filterSensitiveLog = (obj: TargetTrackingConfiguration): any => ({ ...obj, }); @@ -1796,6 +1913,9 @@ export interface GameServerGroupAutoScalingPolicy { } export namespace GameServerGroupAutoScalingPolicy { + /** + * @internal + */ export const filterSensitiveLog = (obj: GameServerGroupAutoScalingPolicy): any => ({ ...obj, }); @@ -1899,6 +2019,9 @@ export interface InstanceDefinition { } export namespace InstanceDefinition { + /** + * @internal + */ export const filterSensitiveLog = (obj: InstanceDefinition): any => ({ ...obj, }); @@ -1932,6 +2055,9 @@ export interface LaunchTemplateSpecification { } export namespace LaunchTemplateSpecification { + /** + * @internal + */ export const filterSensitiveLog = (obj: LaunchTemplateSpecification): any => ({ ...obj, }); @@ -2070,6 +2196,9 @@ export interface CreateGameServerGroupInput { } export namespace CreateGameServerGroupInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateGameServerGroupInput): any => ({ ...obj, }); @@ -2251,6 +2380,9 @@ export interface GameServerGroup { } export namespace GameServerGroup { + /** + * @internal + */ export const filterSensitiveLog = (obj: GameServerGroup): any => ({ ...obj, }); @@ -2267,6 +2399,9 @@ export interface CreateGameServerGroupOutput { } export namespace CreateGameServerGroupOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateGameServerGroupOutput): any => ({ ...obj, }); @@ -2292,6 +2427,9 @@ export interface GameProperty { } export namespace GameProperty { + /** + * @internal + */ export const filterSensitiveLog = (obj: GameProperty): any => ({ ...obj, }); @@ -2375,6 +2513,9 @@ export interface CreateGameSessionInput { } export namespace CreateGameSessionInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateGameSessionInput): any => ({ ...obj, }); @@ -2546,6 +2687,9 @@ export interface GameSession { } export namespace GameSession { + /** + * @internal + */ export const filterSensitiveLog = (obj: GameSession): any => ({ ...obj, }); @@ -2562,6 +2706,9 @@ export interface CreateGameSessionOutput { } export namespace CreateGameSessionOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateGameSessionOutput): any => ({ ...obj, }); @@ -2579,6 +2726,9 @@ export interface FleetCapacityExceededException extends __SmithyException, $Meta } export namespace FleetCapacityExceededException { + /** + * @internal + */ export const filterSensitiveLog = (obj: FleetCapacityExceededException): any => ({ ...obj, }); @@ -2595,6 +2745,9 @@ export interface IdempotentParameterMismatchException extends __SmithyException, } export namespace IdempotentParameterMismatchException { + /** + * @internal + */ export const filterSensitiveLog = (obj: IdempotentParameterMismatchException): any => ({ ...obj, }); @@ -2614,6 +2767,9 @@ export interface TerminalRoutingStrategyException extends __SmithyException, $Me } export namespace TerminalRoutingStrategyException { + /** + * @internal + */ export const filterSensitiveLog = (obj: TerminalRoutingStrategyException): any => ({ ...obj, }); @@ -2634,6 +2790,9 @@ export interface GameSessionQueueDestination { } export namespace GameSessionQueueDestination { + /** + * @internal + */ export const filterSensitiveLog = (obj: GameSessionQueueDestination): any => ({ ...obj, }); @@ -2655,6 +2814,9 @@ export interface FilterConfiguration { } export namespace FilterConfiguration { + /** + * @internal + */ export const filterSensitiveLog = (obj: FilterConfiguration): any => ({ ...obj, }); @@ -2684,6 +2846,9 @@ export interface PlayerLatencyPolicy { } export namespace PlayerLatencyPolicy { + /** + * @internal + */ export const filterSensitiveLog = (obj: PlayerLatencyPolicy): any => ({ ...obj, }); @@ -2761,6 +2926,9 @@ export interface PriorityConfiguration { } export namespace PriorityConfiguration { + /** + * @internal + */ export const filterSensitiveLog = (obj: PriorityConfiguration): any => ({ ...obj, }); @@ -2837,6 +3005,9 @@ export interface CreateGameSessionQueueInput { } export namespace CreateGameSessionQueueInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateGameSessionQueueInput): any => ({ ...obj, }); @@ -2914,6 +3085,9 @@ export interface GameSessionQueue { } export namespace GameSessionQueue { + /** + * @internal + */ export const filterSensitiveLog = (obj: GameSessionQueue): any => ({ ...obj, }); @@ -2930,6 +3104,9 @@ export interface CreateGameSessionQueueOutput { } export namespace CreateGameSessionQueueOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateGameSessionQueueOutput): any => ({ ...obj, }); @@ -3073,6 +3250,9 @@ export interface CreateMatchmakingConfigurationInput { } export namespace CreateMatchmakingConfigurationInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateMatchmakingConfigurationInput): any => ({ ...obj, }); @@ -3211,6 +3391,9 @@ export interface MatchmakingConfiguration { } export namespace MatchmakingConfiguration { + /** + * @internal + */ export const filterSensitiveLog = (obj: MatchmakingConfiguration): any => ({ ...obj, }); @@ -3227,6 +3410,9 @@ export interface CreateMatchmakingConfigurationOutput { } export namespace CreateMatchmakingConfigurationOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateMatchmakingConfigurationOutput): any => ({ ...obj, }); @@ -3264,6 +3450,9 @@ export interface CreateMatchmakingRuleSetInput { } export namespace CreateMatchmakingRuleSetInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateMatchmakingRuleSetInput): any => ({ ...obj, }); @@ -3333,6 +3522,9 @@ export interface MatchmakingRuleSet { } export namespace MatchmakingRuleSet { + /** + * @internal + */ export const filterSensitiveLog = (obj: MatchmakingRuleSet): any => ({ ...obj, }); @@ -3349,6 +3541,9 @@ export interface CreateMatchmakingRuleSetOutput { } export namespace CreateMatchmakingRuleSetOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateMatchmakingRuleSetOutput): any => ({ ...obj, }); @@ -3375,6 +3570,9 @@ export interface CreatePlayerSessionInput { } export namespace CreatePlayerSessionInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreatePlayerSessionInput): any => ({ ...obj, }); @@ -3510,6 +3708,9 @@ export interface PlayerSession { } export namespace PlayerSession { + /** + * @internal + */ export const filterSensitiveLog = (obj: PlayerSession): any => ({ ...obj, }); @@ -3526,6 +3727,9 @@ export interface CreatePlayerSessionOutput { } export namespace CreatePlayerSessionOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreatePlayerSessionOutput): any => ({ ...obj, }); @@ -3542,6 +3746,9 @@ export interface GameSessionFullException extends __SmithyException, $MetadataBe } export namespace GameSessionFullException { + /** + * @internal + */ export const filterSensitiveLog = (obj: GameSessionFullException): any => ({ ...obj, }); @@ -3559,6 +3766,9 @@ export interface InvalidGameSessionStatusException extends __SmithyException, $M } export namespace InvalidGameSessionStatusException { + /** + * @internal + */ export const filterSensitiveLog = (obj: InvalidGameSessionStatusException): any => ({ ...obj, }); @@ -3588,6 +3798,9 @@ export interface CreatePlayerSessionsInput { } export namespace CreatePlayerSessionsInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreatePlayerSessionsInput): any => ({ ...obj, }); @@ -3604,6 +3817,9 @@ export interface CreatePlayerSessionsOutput { } export namespace CreatePlayerSessionsOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreatePlayerSessionsOutput): any => ({ ...obj, }); @@ -3656,6 +3872,9 @@ export interface CreateScriptInput { } export namespace CreateScriptInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateScriptInput): any => ({ ...obj, }); @@ -3717,6 +3936,9 @@ export interface Script { } export namespace Script { + /** + * @internal + */ export const filterSensitiveLog = (obj: Script): any => ({ ...obj, }); @@ -3735,6 +3957,9 @@ export interface CreateScriptOutput { } export namespace CreateScriptOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateScriptOutput): any => ({ ...obj, }); @@ -3760,6 +3985,9 @@ export interface CreateVpcPeeringAuthorizationInput { } export namespace CreateVpcPeeringAuthorizationInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateVpcPeeringAuthorizationInput): any => ({ ...obj, }); @@ -3816,6 +4044,9 @@ export interface VpcPeeringAuthorization { } export namespace VpcPeeringAuthorization { + /** + * @internal + */ export const filterSensitiveLog = (obj: VpcPeeringAuthorization): any => ({ ...obj, }); @@ -3832,6 +4063,9 @@ export interface CreateVpcPeeringAuthorizationOutput { } export namespace CreateVpcPeeringAuthorizationOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateVpcPeeringAuthorizationOutput): any => ({ ...obj, }); @@ -3864,6 +4098,9 @@ export interface CreateVpcPeeringConnectionInput { } export namespace CreateVpcPeeringConnectionInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateVpcPeeringConnectionInput): any => ({ ...obj, }); @@ -3872,6 +4109,9 @@ export namespace CreateVpcPeeringConnectionInput { export interface CreateVpcPeeringConnectionOutput {} export namespace CreateVpcPeeringConnectionOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateVpcPeeringConnectionOutput): any => ({ ...obj, }); @@ -3889,6 +4129,9 @@ export interface DeleteAliasInput { } export namespace DeleteAliasInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteAliasInput): any => ({ ...obj, }); @@ -3905,6 +4148,9 @@ export interface DeleteBuildInput { } export namespace DeleteBuildInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteBuildInput): any => ({ ...obj, }); @@ -3921,6 +4167,9 @@ export interface DeleteFleetInput { } export namespace DeleteFleetInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteFleetInput): any => ({ ...obj, }); @@ -3944,6 +4193,9 @@ export interface DeleteFleetLocationsInput { } export namespace DeleteFleetLocationsInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteFleetLocationsInput): any => ({ ...obj, }); @@ -3971,6 +4223,9 @@ export interface DeleteFleetLocationsOutput { } export namespace DeleteFleetLocationsOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteFleetLocationsOutput): any => ({ ...obj, }); @@ -4014,6 +4269,9 @@ export interface DeleteGameServerGroupInput { } export namespace DeleteGameServerGroupInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteGameServerGroupInput): any => ({ ...obj, }); @@ -4028,6 +4286,9 @@ export interface DeleteGameServerGroupOutput { } export namespace DeleteGameServerGroupOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteGameServerGroupOutput): any => ({ ...obj, }); @@ -4044,6 +4305,9 @@ export interface DeleteGameSessionQueueInput { } export namespace DeleteGameSessionQueueInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteGameSessionQueueInput): any => ({ ...obj, }); @@ -4052,6 +4316,9 @@ export namespace DeleteGameSessionQueueInput { export interface DeleteGameSessionQueueOutput {} export namespace DeleteGameSessionQueueOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteGameSessionQueueOutput): any => ({ ...obj, }); @@ -4068,6 +4335,9 @@ export interface DeleteMatchmakingConfigurationInput { } export namespace DeleteMatchmakingConfigurationInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteMatchmakingConfigurationInput): any => ({ ...obj, }); @@ -4076,6 +4346,9 @@ export namespace DeleteMatchmakingConfigurationInput { export interface DeleteMatchmakingConfigurationOutput {} export namespace DeleteMatchmakingConfigurationOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteMatchmakingConfigurationOutput): any => ({ ...obj, }); @@ -4093,6 +4366,9 @@ export interface DeleteMatchmakingRuleSetInput { } export namespace DeleteMatchmakingRuleSetInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteMatchmakingRuleSetInput): any => ({ ...obj, }); @@ -4104,6 +4380,9 @@ export namespace DeleteMatchmakingRuleSetInput { export interface DeleteMatchmakingRuleSetOutput {} export namespace DeleteMatchmakingRuleSetOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteMatchmakingRuleSetOutput): any => ({ ...obj, }); @@ -4125,6 +4404,9 @@ export interface DeleteScalingPolicyInput { } export namespace DeleteScalingPolicyInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteScalingPolicyInput): any => ({ ...obj, }); @@ -4138,6 +4420,9 @@ export interface DeleteScriptInput { } export namespace DeleteScriptInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteScriptInput): any => ({ ...obj, }); @@ -4163,6 +4448,9 @@ export interface DeleteVpcPeeringAuthorizationInput { } export namespace DeleteVpcPeeringAuthorizationInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteVpcPeeringAuthorizationInput): any => ({ ...obj, }); @@ -4171,6 +4459,9 @@ export namespace DeleteVpcPeeringAuthorizationInput { export interface DeleteVpcPeeringAuthorizationOutput {} export namespace DeleteVpcPeeringAuthorizationOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteVpcPeeringAuthorizationOutput): any => ({ ...obj, }); @@ -4193,6 +4484,9 @@ export interface DeleteVpcPeeringConnectionInput { } export namespace DeleteVpcPeeringConnectionInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteVpcPeeringConnectionInput): any => ({ ...obj, }); @@ -4201,6 +4495,9 @@ export namespace DeleteVpcPeeringConnectionInput { export interface DeleteVpcPeeringConnectionOutput {} export namespace DeleteVpcPeeringConnectionOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteVpcPeeringConnectionOutput): any => ({ ...obj, }); @@ -4220,6 +4517,9 @@ export interface DeregisterGameServerInput { } export namespace DeregisterGameServerInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeregisterGameServerInput): any => ({ ...obj, }); @@ -4237,6 +4537,9 @@ export interface DescribeAliasInput { } export namespace DescribeAliasInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeAliasInput): any => ({ ...obj, }); @@ -4253,6 +4556,9 @@ export interface DescribeAliasOutput { } export namespace DescribeAliasOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeAliasOutput): any => ({ ...obj, }); @@ -4269,6 +4575,9 @@ export interface DescribeBuildInput { } export namespace DescribeBuildInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeBuildInput): any => ({ ...obj, }); @@ -4285,6 +4594,9 @@ export interface DescribeBuildOutput { } export namespace DescribeBuildOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeBuildOutput): any => ({ ...obj, }); @@ -4310,6 +4622,9 @@ export interface DescribeEC2InstanceLimitsInput { } export namespace DescribeEC2InstanceLimitsInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeEC2InstanceLimitsInput): any => ({ ...obj, }); @@ -4354,6 +4669,9 @@ export interface EC2InstanceLimit { } export namespace EC2InstanceLimit { + /** + * @internal + */ export const filterSensitiveLog = (obj: EC2InstanceLimit): any => ({ ...obj, }); @@ -4371,6 +4689,9 @@ export interface DescribeEC2InstanceLimitsOutput { } export namespace DescribeEC2InstanceLimitsOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeEC2InstanceLimitsOutput): any => ({ ...obj, }); @@ -4401,6 +4722,9 @@ export interface DescribeFleetAttributesInput { } export namespace DescribeFleetAttributesInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeFleetAttributesInput): any => ({ ...obj, }); @@ -4423,6 +4747,9 @@ export interface DescribeFleetAttributesOutput { } export namespace DescribeFleetAttributesOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeFleetAttributesOutput): any => ({ ...obj, }); @@ -4453,6 +4780,9 @@ export interface DescribeFleetCapacityInput { } export namespace DescribeFleetCapacityInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeFleetCapacityInput): any => ({ ...obj, }); @@ -4503,6 +4833,9 @@ export interface EC2InstanceCounts { } export namespace EC2InstanceCounts { + /** + * @internal + */ export const filterSensitiveLog = (obj: EC2InstanceCounts): any => ({ ...obj, }); @@ -4552,6 +4885,9 @@ export interface FleetCapacity { } export namespace FleetCapacity { + /** + * @internal + */ export const filterSensitiveLog = (obj: FleetCapacity): any => ({ ...obj, }); @@ -4574,6 +4910,9 @@ export interface DescribeFleetCapacityOutput { } export namespace DescribeFleetCapacityOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeFleetCapacityOutput): any => ({ ...obj, }); @@ -4614,6 +4953,9 @@ export interface DescribeFleetEventsInput { } export namespace DescribeFleetEventsInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeFleetEventsInput): any => ({ ...obj, }); @@ -4835,6 +5177,9 @@ export interface Event { } export namespace Event { + /** + * @internal + */ export const filterSensitiveLog = (obj: Event): any => ({ ...obj, }); @@ -4857,6 +5202,9 @@ export interface DescribeFleetEventsOutput { } export namespace DescribeFleetEventsOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeFleetEventsOutput): any => ({ ...obj, }); @@ -4890,6 +5238,9 @@ export interface DescribeFleetLocationAttributesInput { } export namespace DescribeFleetLocationAttributesInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeFleetLocationAttributesInput): any => ({ ...obj, }); @@ -4928,6 +5279,9 @@ export interface LocationAttributes { } export namespace LocationAttributes { + /** + * @internal + */ export const filterSensitiveLog = (obj: LocationAttributes): any => ({ ...obj, }); @@ -4959,6 +5313,9 @@ export interface DescribeFleetLocationAttributesOutput { } export namespace DescribeFleetLocationAttributesOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeFleetLocationAttributesOutput): any => ({ ...obj, }); @@ -4982,6 +5339,9 @@ export interface DescribeFleetLocationCapacityInput { } export namespace DescribeFleetLocationCapacityInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeFleetLocationCapacityInput): any => ({ ...obj, }); @@ -4999,6 +5359,9 @@ export interface DescribeFleetLocationCapacityOutput { } export namespace DescribeFleetLocationCapacityOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeFleetLocationCapacityOutput): any => ({ ...obj, }); @@ -5022,6 +5385,9 @@ export interface DescribeFleetLocationUtilizationInput { } export namespace DescribeFleetLocationUtilizationInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeFleetLocationUtilizationInput): any => ({ ...obj, }); @@ -5080,6 +5446,9 @@ export interface FleetUtilization { } export namespace FleetUtilization { + /** + * @internal + */ export const filterSensitiveLog = (obj: FleetUtilization): any => ({ ...obj, }); @@ -5097,6 +5466,9 @@ export interface DescribeFleetLocationUtilizationOutput { } export namespace DescribeFleetLocationUtilizationOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeFleetLocationUtilizationOutput): any => ({ ...obj, }); @@ -5120,6 +5492,9 @@ export interface DescribeFleetPortSettingsInput { } export namespace DescribeFleetPortSettingsInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeFleetPortSettingsInput): any => ({ ...obj, }); @@ -5159,6 +5534,9 @@ export interface DescribeFleetPortSettingsOutput { } export namespace DescribeFleetPortSettingsOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeFleetPortSettingsOutput): any => ({ ...obj, }); @@ -5188,6 +5566,9 @@ export interface DescribeFleetUtilizationInput { } export namespace DescribeFleetUtilizationInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeFleetUtilizationInput): any => ({ ...obj, }); @@ -5210,6 +5591,9 @@ export interface DescribeFleetUtilizationOutput { } export namespace DescribeFleetUtilizationOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeFleetUtilizationOutput): any => ({ ...obj, }); @@ -5229,6 +5613,9 @@ export interface DescribeGameServerInput { } export namespace DescribeGameServerInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeGameServerInput): any => ({ ...obj, }); @@ -5242,6 +5629,9 @@ export interface DescribeGameServerOutput { } export namespace DescribeGameServerOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeGameServerOutput): any => ({ ...obj, }); @@ -5255,6 +5645,9 @@ export interface DescribeGameServerGroupInput { } export namespace DescribeGameServerGroupInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeGameServerGroupInput): any => ({ ...obj, }); @@ -5268,6 +5661,9 @@ export interface DescribeGameServerGroupOutput { } export namespace DescribeGameServerGroupOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeGameServerGroupOutput): any => ({ ...obj, }); @@ -5302,6 +5698,9 @@ export interface DescribeGameServerInstancesInput { } export namespace DescribeGameServerInstancesInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeGameServerInstancesInput): any => ({ ...obj, }); @@ -5389,6 +5788,9 @@ export interface GameServerInstance { } export namespace GameServerInstance { + /** + * @internal + */ export const filterSensitiveLog = (obj: GameServerInstance): any => ({ ...obj, }); @@ -5411,6 +5813,9 @@ export interface DescribeGameServerInstancesOutput { } export namespace DescribeGameServerInstancesOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeGameServerInstancesOutput): any => ({ ...obj, }); @@ -5462,6 +5867,9 @@ export interface DescribeGameSessionDetailsInput { } export namespace DescribeGameSessionDetailsInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeGameSessionDetailsInput): any => ({ ...obj, }); @@ -5497,6 +5905,9 @@ export interface GameSessionDetail { } export namespace GameSessionDetail { + /** + * @internal + */ export const filterSensitiveLog = (obj: GameSessionDetail): any => ({ ...obj, }); @@ -5518,6 +5929,9 @@ export interface DescribeGameSessionDetailsOutput { } export namespace DescribeGameSessionDetailsOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeGameSessionDetailsOutput): any => ({ ...obj, }); @@ -5534,6 +5948,9 @@ export interface DescribeGameSessionPlacementInput { } export namespace DescribeGameSessionPlacementInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeGameSessionPlacementInput): any => ({ ...obj, }); @@ -5568,6 +5985,9 @@ export interface PlacedPlayerSession { } export namespace PlacedPlayerSession { + /** + * @internal + */ export const filterSensitiveLog = (obj: PlacedPlayerSession): any => ({ ...obj, }); @@ -5600,6 +6020,9 @@ export interface PlayerLatency { } export namespace PlayerLatency { + /** + * @internal + */ export const filterSensitiveLog = (obj: PlayerLatency): any => ({ ...obj, }); @@ -5791,6 +6214,9 @@ export interface GameSessionPlacement { } export namespace GameSessionPlacement { + /** + * @internal + */ export const filterSensitiveLog = (obj: GameSessionPlacement): any => ({ ...obj, }); @@ -5807,6 +6233,9 @@ export interface DescribeGameSessionPlacementOutput { } export namespace DescribeGameSessionPlacementOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeGameSessionPlacementOutput): any => ({ ...obj, }); @@ -5834,6 +6263,9 @@ export interface DescribeGameSessionQueuesInput { } export namespace DescribeGameSessionQueuesInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeGameSessionQueuesInput): any => ({ ...obj, }); @@ -5855,6 +6287,9 @@ export interface DescribeGameSessionQueuesOutput { } export namespace DescribeGameSessionQueuesOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeGameSessionQueuesOutput): any => ({ ...obj, }); @@ -5907,6 +6342,9 @@ export interface DescribeGameSessionsInput { } export namespace DescribeGameSessionsInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeGameSessionsInput): any => ({ ...obj, }); @@ -5928,6 +6366,9 @@ export interface DescribeGameSessionsOutput { } export namespace DescribeGameSessionsOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeGameSessionsOutput): any => ({ ...obj, }); @@ -5967,6 +6408,9 @@ export interface DescribeInstancesInput { } export namespace DescribeInstancesInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeInstancesInput): any => ({ ...obj, }); @@ -6075,6 +6519,9 @@ export interface Instance { } export namespace Instance { + /** + * @internal + */ export const filterSensitiveLog = (obj: Instance): any => ({ ...obj, }); @@ -6096,6 +6543,9 @@ export interface DescribeInstancesOutput { } export namespace DescribeInstancesOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeInstancesOutput): any => ({ ...obj, }); @@ -6112,6 +6562,9 @@ export interface DescribeMatchmakingInput { } export namespace DescribeMatchmakingInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeMatchmakingInput): any => ({ ...obj, }); @@ -6137,6 +6590,9 @@ export interface MatchedPlayerSession { } export namespace MatchedPlayerSession { + /** + * @internal + */ export const filterSensitiveLog = (obj: MatchedPlayerSession): any => ({ ...obj, }); @@ -6188,6 +6644,9 @@ export interface GameSessionConnectionInfo { } export namespace GameSessionConnectionInfo { + /** + * @internal + */ export const filterSensitiveLog = (obj: GameSessionConnectionInfo): any => ({ ...obj, }); @@ -6230,6 +6689,9 @@ export interface Player { } export namespace Player { + /** + * @internal + */ export const filterSensitiveLog = (obj: Player): any => ({ ...obj, }); @@ -6374,6 +6836,9 @@ export interface MatchmakingTicket { } export namespace MatchmakingTicket { + /** + * @internal + */ export const filterSensitiveLog = (obj: MatchmakingTicket): any => ({ ...obj, }); @@ -6390,6 +6855,9 @@ export interface DescribeMatchmakingOutput { } export namespace DescribeMatchmakingOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeMatchmakingOutput): any => ({ ...obj, }); @@ -6423,6 +6891,9 @@ export interface DescribeMatchmakingConfigurationsInput { } export namespace DescribeMatchmakingConfigurationsInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeMatchmakingConfigurationsInput): any => ({ ...obj, }); @@ -6444,6 +6915,9 @@ export interface DescribeMatchmakingConfigurationsOutput { } export namespace DescribeMatchmakingConfigurationsOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeMatchmakingConfigurationsOutput): any => ({ ...obj, }); @@ -6472,6 +6946,9 @@ export interface DescribeMatchmakingRuleSetsInput { } export namespace DescribeMatchmakingRuleSetsInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeMatchmakingRuleSetsInput): any => ({ ...obj, }); @@ -6493,6 +6970,9 @@ export interface DescribeMatchmakingRuleSetsOutput { } export namespace DescribeMatchmakingRuleSetsOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeMatchmakingRuleSetsOutput): any => ({ ...obj, }); @@ -6559,6 +7039,9 @@ export interface DescribePlayerSessionsInput { } export namespace DescribePlayerSessionsInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribePlayerSessionsInput): any => ({ ...obj, }); @@ -6581,6 +7064,9 @@ export interface DescribePlayerSessionsOutput { } export namespace DescribePlayerSessionsOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribePlayerSessionsOutput): any => ({ ...obj, }); @@ -6598,6 +7084,9 @@ export interface DescribeRuntimeConfigurationInput { } export namespace DescribeRuntimeConfigurationInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeRuntimeConfigurationInput): any => ({ ...obj, }); @@ -6615,6 +7104,9 @@ export interface DescribeRuntimeConfigurationOutput { } export namespace DescribeRuntimeConfigurationOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeRuntimeConfigurationOutput): any => ({ ...obj, }); @@ -6702,6 +7194,9 @@ export interface DescribeScalingPoliciesInput { } export namespace DescribeScalingPoliciesInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeScalingPoliciesInput): any => ({ ...obj, }); @@ -6764,6 +7259,9 @@ export interface TargetConfiguration { } export namespace TargetConfiguration { + /** + * @internal + */ export const filterSensitiveLog = (obj: TargetConfiguration): any => ({ ...obj, }); @@ -6997,6 +7495,9 @@ export interface ScalingPolicy { } export namespace ScalingPolicy { + /** + * @internal + */ export const filterSensitiveLog = (obj: ScalingPolicy): any => ({ ...obj, }); @@ -7019,6 +7520,9 @@ export interface DescribeScalingPoliciesOutput { } export namespace DescribeScalingPoliciesOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeScalingPoliciesOutput): any => ({ ...obj, }); @@ -7033,6 +7537,9 @@ export interface DescribeScriptInput { } export namespace DescribeScriptInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeScriptInput): any => ({ ...obj, }); @@ -7046,6 +7553,9 @@ export interface DescribeScriptOutput { } export namespace DescribeScriptOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeScriptOutput): any => ({ ...obj, }); @@ -7054,6 +7564,9 @@ export namespace DescribeScriptOutput { export interface DescribeVpcPeeringAuthorizationsInput {} export namespace DescribeVpcPeeringAuthorizationsInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeVpcPeeringAuthorizationsInput): any => ({ ...obj, }); @@ -7068,6 +7581,9 @@ export interface DescribeVpcPeeringAuthorizationsOutput { } export namespace DescribeVpcPeeringAuthorizationsOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeVpcPeeringAuthorizationsOutput): any => ({ ...obj, }); @@ -7084,6 +7600,9 @@ export interface DescribeVpcPeeringConnectionsInput { } export namespace DescribeVpcPeeringConnectionsInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeVpcPeeringConnectionsInput): any => ({ ...obj, }); @@ -7108,6 +7627,9 @@ export interface VpcPeeringConnectionStatus { } export namespace VpcPeeringConnectionStatus { + /** + * @internal + */ export const filterSensitiveLog = (obj: VpcPeeringConnectionStatus): any => ({ ...obj, }); @@ -7180,6 +7702,9 @@ export interface VpcPeeringConnection { } export namespace VpcPeeringConnection { + /** + * @internal + */ export const filterSensitiveLog = (obj: VpcPeeringConnection): any => ({ ...obj, }); @@ -7196,6 +7721,9 @@ export interface DescribeVpcPeeringConnectionsOutput { } export namespace DescribeVpcPeeringConnectionsOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeVpcPeeringConnectionsOutput): any => ({ ...obj, }); @@ -7218,6 +7746,9 @@ export interface DesiredPlayerSession { } export namespace DesiredPlayerSession { + /** + * @internal + */ export const filterSensitiveLog = (obj: DesiredPlayerSession): any => ({ ...obj, }); @@ -7234,6 +7765,9 @@ export interface GetGameSessionLogUrlInput { } export namespace GetGameSessionLogUrlInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetGameSessionLogUrlInput): any => ({ ...obj, }); @@ -7253,6 +7787,9 @@ export interface GetGameSessionLogUrlOutput { } export namespace GetGameSessionLogUrlOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetGameSessionLogUrlOutput): any => ({ ...obj, }); @@ -7279,6 +7816,9 @@ export interface GetInstanceAccessInput { } export namespace GetInstanceAccessInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetInstanceAccessInput): any => ({ ...obj, }); @@ -7303,6 +7843,9 @@ export interface InstanceCredentials { } export namespace InstanceCredentials { + /** + * @internal + */ export const filterSensitiveLog = (obj: InstanceCredentials): any => ({ ...obj, }); @@ -7340,6 +7883,9 @@ export interface InstanceAccess { } export namespace InstanceAccess { + /** + * @internal + */ export const filterSensitiveLog = (obj: InstanceAccess): any => ({ ...obj, ...(obj.Credentials && { Credentials: SENSITIVE_STRING }), @@ -7358,6 +7904,9 @@ export interface GetInstanceAccessOutput { } export namespace GetInstanceAccessOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetInstanceAccessOutput): any => ({ ...obj, ...(obj.InstanceAccess && { InstanceAccess: InstanceAccess.filterSensitiveLog(obj.InstanceAccess) }), @@ -7405,6 +7954,9 @@ export interface ListAliasesInput { } export namespace ListAliasesInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListAliasesInput): any => ({ ...obj, }); @@ -7426,6 +7978,9 @@ export interface ListAliasesOutput { } export namespace ListAliasesOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListAliasesOutput): any => ({ ...obj, }); @@ -7473,6 +8028,9 @@ export interface ListBuildsInput { } export namespace ListBuildsInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListBuildsInput): any => ({ ...obj, }); @@ -7494,6 +8052,9 @@ export interface ListBuildsOutput { } export namespace ListBuildsOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListBuildsOutput): any => ({ ...obj, }); @@ -7527,6 +8088,9 @@ export interface ListFleetsInput { } export namespace ListFleetsInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListFleetsInput): any => ({ ...obj, }); @@ -7551,6 +8115,9 @@ export interface ListFleetsOutput { } export namespace ListFleetsOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListFleetsOutput): any => ({ ...obj, }); @@ -7569,6 +8136,9 @@ export interface ListGameServerGroupsInput { } export namespace ListGameServerGroupsInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListGameServerGroupsInput): any => ({ ...obj, }); @@ -7587,6 +8157,9 @@ export interface ListGameServerGroupsOutput { } export namespace ListGameServerGroupsOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListGameServerGroupsOutput): any => ({ ...obj, }); @@ -7624,6 +8197,9 @@ export interface ListGameServersInput { } export namespace ListGameServersInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListGameServersInput): any => ({ ...obj, }); @@ -7642,6 +8218,9 @@ export interface ListGameServersOutput { } export namespace ListGameServersOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListGameServersOutput): any => ({ ...obj, }); @@ -7660,6 +8239,9 @@ export interface ListScriptsInput { } export namespace ListScriptsInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListScriptsInput): any => ({ ...obj, }); @@ -7678,6 +8260,9 @@ export interface ListScriptsOutput { } export namespace ListScriptsOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListScriptsOutput): any => ({ ...obj, }); @@ -7696,6 +8281,9 @@ export interface ListTagsForResourceRequest { } export namespace ListTagsForResourceRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListTagsForResourceRequest): any => ({ ...obj, }); @@ -7711,6 +8299,9 @@ export interface ListTagsForResourceResponse { } export namespace ListTagsForResourceResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListTagsForResourceResponse): any => ({ ...obj, }); @@ -7867,6 +8458,9 @@ export interface PutScalingPolicyInput { } export namespace PutScalingPolicyInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: PutScalingPolicyInput): any => ({ ...obj, }); @@ -7883,6 +8477,9 @@ export interface PutScalingPolicyOutput { } export namespace PutScalingPolicyOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: PutScalingPolicyOutput): any => ({ ...obj, }); @@ -7923,6 +8520,9 @@ export interface RegisterGameServerInput { } export namespace RegisterGameServerInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: RegisterGameServerInput): any => ({ ...obj, }); @@ -7936,6 +8536,9 @@ export interface RegisterGameServerOutput { } export namespace RegisterGameServerOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: RegisterGameServerOutput): any => ({ ...obj, }); @@ -7952,6 +8555,9 @@ export interface RequestUploadCredentialsInput { } export namespace RequestUploadCredentialsInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: RequestUploadCredentialsInput): any => ({ ...obj, }); @@ -7976,6 +8582,9 @@ export interface RequestUploadCredentialsOutput { } export namespace RequestUploadCredentialsOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: RequestUploadCredentialsOutput): any => ({ ...obj, ...(obj.UploadCredentials && { UploadCredentials: SENSITIVE_STRING }), @@ -7994,6 +8603,9 @@ export interface ResolveAliasInput { } export namespace ResolveAliasInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: ResolveAliasInput): any => ({ ...obj, }); @@ -8017,6 +8629,9 @@ export interface ResolveAliasOutput { } export namespace ResolveAliasOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: ResolveAliasOutput): any => ({ ...obj, }); @@ -8035,6 +8650,9 @@ export interface ResumeGameServerGroupInput { } export namespace ResumeGameServerGroupInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: ResumeGameServerGroupInput): any => ({ ...obj, }); @@ -8050,6 +8668,9 @@ export interface ResumeGameServerGroupOutput { } export namespace ResumeGameServerGroupOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: ResumeGameServerGroupOutput): any => ({ ...obj, }); @@ -8182,6 +8803,9 @@ export interface SearchGameSessionsInput { } export namespace SearchGameSessionsInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: SearchGameSessionsInput): any => ({ ...obj, }); @@ -8204,6 +8828,9 @@ export interface SearchGameSessionsOutput { } export namespace SearchGameSessionsOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: SearchGameSessionsOutput): any => ({ ...obj, }); @@ -8231,6 +8858,9 @@ export interface StartFleetActionsInput { } export namespace StartFleetActionsInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: StartFleetActionsInput): any => ({ ...obj, }); @@ -8252,6 +8882,9 @@ export interface StartFleetActionsOutput { } export namespace StartFleetActionsOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: StartFleetActionsOutput): any => ({ ...obj, }); @@ -8309,6 +8942,9 @@ export interface StartGameSessionPlacementInput { } export namespace StartGameSessionPlacementInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: StartGameSessionPlacementInput): any => ({ ...obj, }); @@ -8327,6 +8963,9 @@ export interface StartGameSessionPlacementOutput { } export namespace StartGameSessionPlacementOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: StartGameSessionPlacementOutput): any => ({ ...obj, }); @@ -8380,6 +9019,9 @@ export interface StartMatchBackfillInput { } export namespace StartMatchBackfillInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: StartMatchBackfillInput): any => ({ ...obj, }); @@ -8398,6 +9040,9 @@ export interface StartMatchBackfillOutput { } export namespace StartMatchBackfillOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: StartMatchBackfillOutput): any => ({ ...obj, }); @@ -8431,6 +9076,9 @@ export interface StartMatchmakingInput { } export namespace StartMatchmakingInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: StartMatchmakingInput): any => ({ ...obj, }); @@ -8449,6 +9097,9 @@ export interface StartMatchmakingOutput { } export namespace StartMatchmakingOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: StartMatchmakingOutput): any => ({ ...obj, }); @@ -8476,6 +9127,9 @@ export interface StopFleetActionsInput { } export namespace StopFleetActionsInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: StopFleetActionsInput): any => ({ ...obj, }); @@ -8497,6 +9151,9 @@ export interface StopFleetActionsOutput { } export namespace StopFleetActionsOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: StopFleetActionsOutput): any => ({ ...obj, }); @@ -8513,6 +9170,9 @@ export interface StopGameSessionPlacementInput { } export namespace StopGameSessionPlacementInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: StopGameSessionPlacementInput): any => ({ ...obj, }); @@ -8530,6 +9190,9 @@ export interface StopGameSessionPlacementOutput { } export namespace StopGameSessionPlacementOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: StopGameSessionPlacementOutput): any => ({ ...obj, }); @@ -8546,6 +9209,9 @@ export interface StopMatchmakingInput { } export namespace StopMatchmakingInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: StopMatchmakingInput): any => ({ ...obj, }); @@ -8554,6 +9220,9 @@ export namespace StopMatchmakingInput { export interface StopMatchmakingOutput {} export namespace StopMatchmakingOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: StopMatchmakingOutput): any => ({ ...obj, }); @@ -8572,6 +9241,9 @@ export interface SuspendGameServerGroupInput { } export namespace SuspendGameServerGroupInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: SuspendGameServerGroupInput): any => ({ ...obj, }); @@ -8587,6 +9259,9 @@ export interface SuspendGameServerGroupOutput { } export namespace SuspendGameServerGroupOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: SuspendGameServerGroupOutput): any => ({ ...obj, }); @@ -8613,6 +9288,9 @@ export interface TagResourceRequest { } export namespace TagResourceRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: TagResourceRequest): any => ({ ...obj, }); @@ -8621,6 +9299,9 @@ export namespace TagResourceRequest { export interface TagResourceResponse {} export namespace TagResourceResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: TagResourceResponse): any => ({ ...obj, }); @@ -8644,6 +9325,9 @@ export interface UntagResourceRequest { } export namespace UntagResourceRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: UntagResourceRequest): any => ({ ...obj, }); @@ -8652,6 +9336,9 @@ export namespace UntagResourceRequest { export interface UntagResourceResponse {} export namespace UntagResourceResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: UntagResourceResponse): any => ({ ...obj, }); @@ -8685,6 +9372,9 @@ export interface UpdateAliasInput { } export namespace UpdateAliasInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateAliasInput): any => ({ ...obj, }); @@ -8701,6 +9391,9 @@ export interface UpdateAliasOutput { } export namespace UpdateAliasOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateAliasOutput): any => ({ ...obj, }); @@ -8727,6 +9420,9 @@ export interface UpdateBuildInput { } export namespace UpdateBuildInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateBuildInput): any => ({ ...obj, }); @@ -8743,6 +9439,9 @@ export interface UpdateBuildOutput { } export namespace UpdateBuildOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateBuildOutput): any => ({ ...obj, }); @@ -8804,6 +9503,9 @@ export interface UpdateFleetAttributesInput { } export namespace UpdateFleetAttributesInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateFleetAttributesInput): any => ({ ...obj, }); @@ -8820,6 +9522,9 @@ export interface UpdateFleetAttributesOutput { } export namespace UpdateFleetAttributesOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateFleetAttributesOutput): any => ({ ...obj, }); @@ -8861,6 +9566,9 @@ export interface UpdateFleetCapacityInput { } export namespace UpdateFleetCapacityInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateFleetCapacityInput): any => ({ ...obj, }); @@ -8888,6 +9596,9 @@ export interface UpdateFleetCapacityOutput { } export namespace UpdateFleetCapacityOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateFleetCapacityOutput): any => ({ ...obj, }); @@ -8915,6 +9626,9 @@ export interface UpdateFleetPortSettingsInput { } export namespace UpdateFleetPortSettingsInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateFleetPortSettingsInput): any => ({ ...obj, }); @@ -8931,6 +9645,9 @@ export interface UpdateFleetPortSettingsOutput { } export namespace UpdateFleetPortSettingsOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateFleetPortSettingsOutput): any => ({ ...obj, }); @@ -8973,6 +9690,9 @@ export interface UpdateGameServerInput { } export namespace UpdateGameServerInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateGameServerInput): any => ({ ...obj, }); @@ -8986,6 +9706,9 @@ export interface UpdateGameServerOutput { } export namespace UpdateGameServerOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateGameServerOutput): any => ({ ...obj, }); @@ -9058,6 +9781,9 @@ export interface UpdateGameServerGroupInput { } export namespace UpdateGameServerGroupInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateGameServerGroupInput): any => ({ ...obj, }); @@ -9071,6 +9797,9 @@ export interface UpdateGameServerGroupOutput { } export namespace UpdateGameServerGroupOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateGameServerGroupOutput): any => ({ ...obj, }); @@ -9120,6 +9849,9 @@ export interface UpdateGameSessionInput { } export namespace UpdateGameSessionInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateGameSessionInput): any => ({ ...obj, }); @@ -9136,6 +9868,9 @@ export interface UpdateGameSessionOutput { } export namespace UpdateGameSessionOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateGameSessionOutput): any => ({ ...obj, }); @@ -9200,6 +9935,9 @@ export interface UpdateGameSessionQueueInput { } export namespace UpdateGameSessionQueueInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateGameSessionQueueInput): any => ({ ...obj, }); @@ -9216,6 +9954,9 @@ export interface UpdateGameSessionQueueOutput { } export namespace UpdateGameSessionQueueOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateGameSessionQueueOutput): any => ({ ...obj, }); @@ -9337,6 +10078,9 @@ export interface UpdateMatchmakingConfigurationInput { } export namespace UpdateMatchmakingConfigurationInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateMatchmakingConfigurationInput): any => ({ ...obj, }); @@ -9353,6 +10097,9 @@ export interface UpdateMatchmakingConfigurationOutput { } export namespace UpdateMatchmakingConfigurationOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateMatchmakingConfigurationOutput): any => ({ ...obj, }); @@ -9378,6 +10125,9 @@ export interface UpdateRuntimeConfigurationInput { } export namespace UpdateRuntimeConfigurationInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateRuntimeConfigurationInput): any => ({ ...obj, }); @@ -9395,6 +10145,9 @@ export interface UpdateRuntimeConfigurationOutput { } export namespace UpdateRuntimeConfigurationOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateRuntimeConfigurationOutput): any => ({ ...obj, }); @@ -9439,6 +10192,9 @@ export interface UpdateScriptInput { } export namespace UpdateScriptInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateScriptInput): any => ({ ...obj, }); @@ -9457,6 +10213,9 @@ export interface UpdateScriptOutput { } export namespace UpdateScriptOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateScriptOutput): any => ({ ...obj, }); @@ -9473,6 +10232,9 @@ export interface ValidateMatchmakingRuleSetInput { } export namespace ValidateMatchmakingRuleSetInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: ValidateMatchmakingRuleSetInput): any => ({ ...obj, }); @@ -9489,6 +10251,9 @@ export interface ValidateMatchmakingRuleSetOutput { } export namespace ValidateMatchmakingRuleSetOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: ValidateMatchmakingRuleSetOutput): any => ({ ...obj, }); diff --git a/clients/client-glacier/commands/AbortMultipartUploadCommand.ts b/clients/client-glacier/commands/AbortMultipartUploadCommand.ts index 0dfc5680218b..36b02c3c29e8 100644 --- a/clients/client-glacier/commands/AbortMultipartUploadCommand.ts +++ b/clients/client-glacier/commands/AbortMultipartUploadCommand.ts @@ -39,6 +39,20 @@ export interface AbortMultipartUploadCommandOutput extends __MetadataBearer {} *

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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { GlacierClient, AbortMultipartUploadCommand } from "@aws-sdk/client-glacier"; // ES Modules import + * // const { GlacierClient, AbortMultipartUploadCommand } = require("@aws-sdk/client-glacier"); // CommonJS import + * const client = new GlacierClient(config); + * const command = new AbortMultipartUploadCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link AbortMultipartUploadCommandInput} for command's `input` shape. + * @see {@link AbortMultipartUploadCommandOutput} for command's `response` shape. + * @see {@link GlacierClientResolvedConfig | config} for command's `input` shape. + * */ export class AbortMultipartUploadCommand extends $Command< AbortMultipartUploadCommandInput, diff --git a/clients/client-glacier/commands/AbortVaultLockCommand.ts b/clients/client-glacier/commands/AbortVaultLockCommand.ts index 665541b2fba0..c6113e878c23 100644 --- a/clients/client-glacier/commands/AbortVaultLockCommand.ts +++ b/clients/client-glacier/commands/AbortVaultLockCommand.ts @@ -35,6 +35,20 @@ export interface AbortVaultLockCommandOutput extends __MetadataBearer {} *

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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { GlacierClient, AbortVaultLockCommand } from "@aws-sdk/client-glacier"; // ES Modules import + * // const { GlacierClient, AbortVaultLockCommand } = require("@aws-sdk/client-glacier"); // CommonJS import + * const client = new GlacierClient(config); + * const command = new AbortVaultLockCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link AbortVaultLockCommandInput} for command's `input` shape. + * @see {@link AbortVaultLockCommandOutput} for command's `response` shape. + * @see {@link GlacierClientResolvedConfig | config} for command's `input` shape. + * */ export class AbortVaultLockCommand extends $Command< AbortVaultLockCommandInput, diff --git a/clients/client-glacier/commands/AddTagsToVaultCommand.ts b/clients/client-glacier/commands/AddTagsToVaultCommand.ts index 7b400ab309cb..41155743bb67 100644 --- a/clients/client-glacier/commands/AddTagsToVaultCommand.ts +++ b/clients/client-glacier/commands/AddTagsToVaultCommand.ts @@ -27,6 +27,20 @@ export interface AddTagsToVaultCommandOutput extends __MetadataBearer {} * 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. *

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { GlacierClient, AddTagsToVaultCommand } from "@aws-sdk/client-glacier"; // ES Modules import + * // const { GlacierClient, AddTagsToVaultCommand } = require("@aws-sdk/client-glacier"); // CommonJS import + * const client = new GlacierClient(config); + * const command = new AddTagsToVaultCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link AddTagsToVaultCommandInput} for command's `input` shape. + * @see {@link AddTagsToVaultCommandOutput} for command's `response` shape. + * @see {@link GlacierClientResolvedConfig | config} for command's `input` shape. + * */ export class AddTagsToVaultCommand extends $Command< AddTagsToVaultCommandInput, diff --git a/clients/client-glacier/commands/CompleteMultipartUploadCommand.ts b/clients/client-glacier/commands/CompleteMultipartUploadCommand.ts index c2970323bbec..1a0387a751b9 100644 --- a/clients/client-glacier/commands/CompleteMultipartUploadCommand.ts +++ b/clients/client-glacier/commands/CompleteMultipartUploadCommand.ts @@ -59,6 +59,20 @@ export interface CompleteMultipartUploadCommandOutput extends ArchiveCreationOut *

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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { GlacierClient, CompleteMultipartUploadCommand } from "@aws-sdk/client-glacier"; // ES Modules import + * // const { GlacierClient, CompleteMultipartUploadCommand } = require("@aws-sdk/client-glacier"); // CommonJS import + * const client = new GlacierClient(config); + * const command = new CompleteMultipartUploadCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CompleteMultipartUploadCommandInput} for command's `input` shape. + * @see {@link CompleteMultipartUploadCommandOutput} for command's `response` shape. + * @see {@link GlacierClientResolvedConfig | config} for command's `input` shape. + * */ export class CompleteMultipartUploadCommand extends $Command< CompleteMultipartUploadCommandInput, diff --git a/clients/client-glacier/commands/CompleteVaultLockCommand.ts b/clients/client-glacier/commands/CompleteVaultLockCommand.ts index d1bbc3f3fca6..353d0471d3a5 100644 --- a/clients/client-glacier/commands/CompleteVaultLockCommand.ts +++ b/clients/client-glacier/commands/CompleteVaultLockCommand.ts @@ -35,6 +35,20 @@ export interface CompleteVaultLockCommandOutput extends __MetadataBearer {} * 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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { GlacierClient, CompleteVaultLockCommand } from "@aws-sdk/client-glacier"; // ES Modules import + * // const { GlacierClient, CompleteVaultLockCommand } = require("@aws-sdk/client-glacier"); // CommonJS import + * const client = new GlacierClient(config); + * const command = new CompleteVaultLockCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CompleteVaultLockCommandInput} for command's `input` shape. + * @see {@link CompleteVaultLockCommandOutput} for command's `response` shape. + * @see {@link GlacierClientResolvedConfig | config} for command's `input` shape. + * */ export class CompleteVaultLockCommand extends $Command< CompleteVaultLockCommandInput, diff --git a/clients/client-glacier/commands/CreateVaultCommand.ts b/clients/client-glacier/commands/CreateVaultCommand.ts index 878892d27db1..4ea76b6d4e1a 100644 --- a/clients/client-glacier/commands/CreateVaultCommand.ts +++ b/clients/client-glacier/commands/CreateVaultCommand.ts @@ -45,6 +45,20 @@ export interface CreateVaultCommandOutput extends CreateVaultOutput, __MetadataB *

For conceptual information and underlying REST API, see Creating a Vault in Amazon * Glacier and Create Vault in the * Amazon Glacier Developer Guide.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { GlacierClient, CreateVaultCommand } from "@aws-sdk/client-glacier"; // ES Modules import + * // const { GlacierClient, CreateVaultCommand } = require("@aws-sdk/client-glacier"); // CommonJS import + * const client = new GlacierClient(config); + * const command = new CreateVaultCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreateVaultCommandInput} for command's `input` shape. + * @see {@link CreateVaultCommandOutput} for command's `response` shape. + * @see {@link GlacierClientResolvedConfig | config} for command's `input` shape. + * */ export class CreateVaultCommand extends $Command< CreateVaultCommandInput, diff --git a/clients/client-glacier/commands/DeleteArchiveCommand.ts b/clients/client-glacier/commands/DeleteArchiveCommand.ts index 3656b72cf26a..d49e36201162 100644 --- a/clients/client-glacier/commands/DeleteArchiveCommand.ts +++ b/clients/client-glacier/commands/DeleteArchiveCommand.ts @@ -48,6 +48,20 @@ export interface DeleteArchiveCommandOutput extends __MetadataBearer {} *

For conceptual information and underlying REST API, see Deleting an Archive in Amazon * Glacier and Delete Archive in the * Amazon Glacier Developer Guide.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { GlacierClient, DeleteArchiveCommand } from "@aws-sdk/client-glacier"; // ES Modules import + * // const { GlacierClient, DeleteArchiveCommand } = require("@aws-sdk/client-glacier"); // CommonJS import + * const client = new GlacierClient(config); + * const command = new DeleteArchiveCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteArchiveCommandInput} for command's `input` shape. + * @see {@link DeleteArchiveCommandOutput} for command's `response` shape. + * @see {@link GlacierClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteArchiveCommand extends $Command< DeleteArchiveCommandInput, diff --git a/clients/client-glacier/commands/DeleteVaultAccessPolicyCommand.ts b/clients/client-glacier/commands/DeleteVaultAccessPolicyCommand.ts index 40b57a277f26..eeca9ca09bbb 100644 --- a/clients/client-glacier/commands/DeleteVaultAccessPolicyCommand.ts +++ b/clients/client-glacier/commands/DeleteVaultAccessPolicyCommand.ts @@ -28,6 +28,20 @@ export interface DeleteVaultAccessPolicyCommandOutput extends __MetadataBearer { *

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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { GlacierClient, DeleteVaultAccessPolicyCommand } from "@aws-sdk/client-glacier"; // ES Modules import + * // const { GlacierClient, DeleteVaultAccessPolicyCommand } = require("@aws-sdk/client-glacier"); // CommonJS import + * const client = new GlacierClient(config); + * const command = new DeleteVaultAccessPolicyCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteVaultAccessPolicyCommandInput} for command's `input` shape. + * @see {@link DeleteVaultAccessPolicyCommandOutput} for command's `response` shape. + * @see {@link GlacierClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteVaultAccessPolicyCommand extends $Command< DeleteVaultAccessPolicyCommandInput, diff --git a/clients/client-glacier/commands/DeleteVaultCommand.ts b/clients/client-glacier/commands/DeleteVaultCommand.ts index 19730d0896d7..5fca82fdba9f 100644 --- a/clients/client-glacier/commands/DeleteVaultCommand.ts +++ b/clients/client-glacier/commands/DeleteVaultCommand.ts @@ -41,6 +41,20 @@ export interface DeleteVaultCommandOutput extends __MetadataBearer {} *

For conceptual information and underlying REST API, see Deleting a Vault in Amazon * Glacier and Delete Vault in the * Amazon S3 Glacier Developer Guide.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { GlacierClient, DeleteVaultCommand } from "@aws-sdk/client-glacier"; // ES Modules import + * // const { GlacierClient, DeleteVaultCommand } = require("@aws-sdk/client-glacier"); // CommonJS import + * const client = new GlacierClient(config); + * const command = new DeleteVaultCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteVaultCommandInput} for command's `input` shape. + * @see {@link DeleteVaultCommandOutput} for command's `response` shape. + * @see {@link GlacierClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteVaultCommand extends $Command< DeleteVaultCommandInput, diff --git a/clients/client-glacier/commands/DeleteVaultNotificationsCommand.ts b/clients/client-glacier/commands/DeleteVaultNotificationsCommand.ts index cfecdbc0fd71..ab92ff97a886 100644 --- a/clients/client-glacier/commands/DeleteVaultNotificationsCommand.ts +++ b/clients/client-glacier/commands/DeleteVaultNotificationsCommand.ts @@ -34,6 +34,20 @@ export interface DeleteVaultNotificationsCommandOutput extends __MetadataBearer *

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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { GlacierClient, DeleteVaultNotificationsCommand } from "@aws-sdk/client-glacier"; // ES Modules import + * // const { GlacierClient, DeleteVaultNotificationsCommand } = require("@aws-sdk/client-glacier"); // CommonJS import + * const client = new GlacierClient(config); + * const command = new DeleteVaultNotificationsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteVaultNotificationsCommandInput} for command's `input` shape. + * @see {@link DeleteVaultNotificationsCommandOutput} for command's `response` shape. + * @see {@link GlacierClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteVaultNotificationsCommand extends $Command< DeleteVaultNotificationsCommandInput, diff --git a/clients/client-glacier/commands/DescribeJobCommand.ts b/clients/client-glacier/commands/DescribeJobCommand.ts index 8da9da7112f9..fd5b4a572583 100644 --- a/clients/client-glacier/commands/DescribeJobCommand.ts +++ b/clients/client-glacier/commands/DescribeJobCommand.ts @@ -45,6 +45,20 @@ export interface DescribeJobCommandOutput extends GlacierJobDescription, __Metad *

For more information about using this operation, * see the documentation for the underlying REST API Describe Job * in the Amazon Glacier Developer Guide.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { GlacierClient, DescribeJobCommand } from "@aws-sdk/client-glacier"; // ES Modules import + * // const { GlacierClient, DescribeJobCommand } = require("@aws-sdk/client-glacier"); // CommonJS import + * const client = new GlacierClient(config); + * const command = new DescribeJobCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeJobCommandInput} for command's `input` shape. + * @see {@link DescribeJobCommandOutput} for command's `response` shape. + * @see {@link GlacierClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeJobCommand extends $Command< DescribeJobCommandInput, diff --git a/clients/client-glacier/commands/DescribeVaultCommand.ts b/clients/client-glacier/commands/DescribeVaultCommand.ts index 768a18c364fe..d422481e4a8f 100644 --- a/clients/client-glacier/commands/DescribeVaultCommand.ts +++ b/clients/client-glacier/commands/DescribeVaultCommand.ts @@ -39,6 +39,20 @@ export interface DescribeVaultCommandOutput extends DescribeVaultOutput, __Metad *

For conceptual information and underlying REST API, see Retrieving Vault Metadata in * Amazon S3 Glacier and Describe Vault in the * Amazon Glacier Developer Guide.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { GlacierClient, DescribeVaultCommand } from "@aws-sdk/client-glacier"; // ES Modules import + * // const { GlacierClient, DescribeVaultCommand } = require("@aws-sdk/client-glacier"); // CommonJS import + * const client = new GlacierClient(config); + * const command = new DescribeVaultCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeVaultCommandInput} for command's `input` shape. + * @see {@link DescribeVaultCommandOutput} for command's `response` shape. + * @see {@link GlacierClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeVaultCommand extends $Command< DescribeVaultCommandInput, diff --git a/clients/client-glacier/commands/GetDataRetrievalPolicyCommand.ts b/clients/client-glacier/commands/GetDataRetrievalPolicyCommand.ts index 320262c9008b..78428d8b3847 100644 --- a/clients/client-glacier/commands/GetDataRetrievalPolicyCommand.ts +++ b/clients/client-glacier/commands/GetDataRetrievalPolicyCommand.ts @@ -24,6 +24,20 @@ export interface GetDataRetrievalPolicyCommandOutput extends GetDataRetrievalPol *

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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { GlacierClient, GetDataRetrievalPolicyCommand } from "@aws-sdk/client-glacier"; // ES Modules import + * // const { GlacierClient, GetDataRetrievalPolicyCommand } = require("@aws-sdk/client-glacier"); // CommonJS import + * const client = new GlacierClient(config); + * const command = new GetDataRetrievalPolicyCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetDataRetrievalPolicyCommandInput} for command's `input` shape. + * @see {@link GetDataRetrievalPolicyCommandOutput} for command's `response` shape. + * @see {@link GlacierClientResolvedConfig | config} for command's `input` shape. + * */ export class GetDataRetrievalPolicyCommand extends $Command< GetDataRetrievalPolicyCommandInput, diff --git a/clients/client-glacier/commands/GetJobOutputCommand.ts b/clients/client-glacier/commands/GetJobOutputCommand.ts index 3e5c1fca9404..3a8c0591c3de 100644 --- a/clients/client-glacier/commands/GetJobOutputCommand.ts +++ b/clients/client-glacier/commands/GetJobOutputCommand.ts @@ -58,6 +58,20 @@ export interface GetJobOutputCommandOutput extends GetJobOutputOutput, __Metadat * Vault Inventory, Downloading an * Archive, and Get Job Output *

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { GlacierClient, GetJobOutputCommand } from "@aws-sdk/client-glacier"; // ES Modules import + * // const { GlacierClient, GetJobOutputCommand } = require("@aws-sdk/client-glacier"); // CommonJS import + * const client = new GlacierClient(config); + * const command = new GetJobOutputCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetJobOutputCommandInput} for command's `input` shape. + * @see {@link GetJobOutputCommandOutput} for command's `response` shape. + * @see {@link GlacierClientResolvedConfig | config} for command's `input` shape. + * */ export class GetJobOutputCommand extends $Command< GetJobOutputCommandInput, diff --git a/clients/client-glacier/commands/GetVaultAccessPolicyCommand.ts b/clients/client-glacier/commands/GetVaultAccessPolicyCommand.ts index 3e6cfc5f838c..f935d6d84b6a 100644 --- a/clients/client-glacier/commands/GetVaultAccessPolicyCommand.ts +++ b/clients/client-glacier/commands/GetVaultAccessPolicyCommand.ts @@ -27,6 +27,20 @@ export interface GetVaultAccessPolicyCommandOutput extends GetVaultAccessPolicyO * operation returns a 404 Not found error. For more information about vault * access policies, see Amazon Glacier Access Control * with Vault Access Policies.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { GlacierClient, GetVaultAccessPolicyCommand } from "@aws-sdk/client-glacier"; // ES Modules import + * // const { GlacierClient, GetVaultAccessPolicyCommand } = require("@aws-sdk/client-glacier"); // CommonJS import + * const client = new GlacierClient(config); + * const command = new GetVaultAccessPolicyCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetVaultAccessPolicyCommandInput} for command's `input` shape. + * @see {@link GetVaultAccessPolicyCommandOutput} for command's `response` shape. + * @see {@link GlacierClientResolvedConfig | config} for command's `input` shape. + * */ export class GetVaultAccessPolicyCommand extends $Command< GetVaultAccessPolicyCommandInput, diff --git a/clients/client-glacier/commands/GetVaultLockCommand.ts b/clients/client-glacier/commands/GetVaultLockCommand.ts index 0deb5f17e0ef..3390f92c3db2 100644 --- a/clients/client-glacier/commands/GetVaultLockCommand.ts +++ b/clients/client-glacier/commands/GetVaultLockCommand.ts @@ -49,6 +49,20 @@ export interface GetVaultLockCommandOutput extends GetVaultLockOutput, __Metadat *

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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { GlacierClient, GetVaultLockCommand } from "@aws-sdk/client-glacier"; // ES Modules import + * // const { GlacierClient, GetVaultLockCommand } = require("@aws-sdk/client-glacier"); // CommonJS import + * const client = new GlacierClient(config); + * const command = new GetVaultLockCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetVaultLockCommandInput} for command's `input` shape. + * @see {@link GetVaultLockCommandOutput} for command's `response` shape. + * @see {@link GlacierClientResolvedConfig | config} for command's `input` shape. + * */ export class GetVaultLockCommand extends $Command< GetVaultLockCommandInput, diff --git a/clients/client-glacier/commands/GetVaultNotificationsCommand.ts b/clients/client-glacier/commands/GetVaultNotificationsCommand.ts index c31857aea557..3508976ddb5d 100644 --- a/clients/client-glacier/commands/GetVaultNotificationsCommand.ts +++ b/clients/client-glacier/commands/GetVaultNotificationsCommand.ts @@ -37,6 +37,20 @@ export interface GetVaultNotificationsCommandOutput extends GetVaultNotification *

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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { GlacierClient, GetVaultNotificationsCommand } from "@aws-sdk/client-glacier"; // ES Modules import + * // const { GlacierClient, GetVaultNotificationsCommand } = require("@aws-sdk/client-glacier"); // CommonJS import + * const client = new GlacierClient(config); + * const command = new GetVaultNotificationsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetVaultNotificationsCommandInput} for command's `input` shape. + * @see {@link GetVaultNotificationsCommandOutput} for command's `response` shape. + * @see {@link GlacierClientResolvedConfig | config} for command's `input` shape. + * */ export class GetVaultNotificationsCommand extends $Command< GetVaultNotificationsCommandInput, diff --git a/clients/client-glacier/commands/InitiateJobCommand.ts b/clients/client-glacier/commands/InitiateJobCommand.ts index a84f5c6e7f71..498bb1353469 100644 --- a/clients/client-glacier/commands/InitiateJobCommand.ts +++ b/clients/client-glacier/commands/InitiateJobCommand.ts @@ -26,6 +26,20 @@ export interface InitiateJobCommandOutput extends InitiateJobOutput, __MetadataB * see the documentation for the underlying REST API Initiate * a Job. *

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { GlacierClient, InitiateJobCommand } from "@aws-sdk/client-glacier"; // ES Modules import + * // const { GlacierClient, InitiateJobCommand } = require("@aws-sdk/client-glacier"); // CommonJS import + * const client = new GlacierClient(config); + * const command = new InitiateJobCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link InitiateJobCommandInput} for command's `input` shape. + * @see {@link InitiateJobCommandOutput} for command's `response` shape. + * @see {@link GlacierClientResolvedConfig | config} for command's `input` shape. + * */ export class InitiateJobCommand extends $Command< InitiateJobCommandInput, diff --git a/clients/client-glacier/commands/InitiateMultipartUploadCommand.ts b/clients/client-glacier/commands/InitiateMultipartUploadCommand.ts index dd1bb72d0d94..f846f5fc6994 100644 --- a/clients/client-glacier/commands/InitiateMultipartUploadCommand.ts +++ b/clients/client-glacier/commands/InitiateMultipartUploadCommand.ts @@ -55,6 +55,20 @@ export interface InitiateMultipartUploadCommandOutput extends InitiateMultipartU *

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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { GlacierClient, InitiateMultipartUploadCommand } from "@aws-sdk/client-glacier"; // ES Modules import + * // const { GlacierClient, InitiateMultipartUploadCommand } = require("@aws-sdk/client-glacier"); // CommonJS import + * const client = new GlacierClient(config); + * const command = new InitiateMultipartUploadCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link InitiateMultipartUploadCommandInput} for command's `input` shape. + * @see {@link InitiateMultipartUploadCommandOutput} for command's `response` shape. + * @see {@link GlacierClientResolvedConfig | config} for command's `input` shape. + * */ export class InitiateMultipartUploadCommand extends $Command< InitiateMultipartUploadCommandInput, diff --git a/clients/client-glacier/commands/InitiateVaultLockCommand.ts b/clients/client-glacier/commands/InitiateVaultLockCommand.ts index 0d4e18dea617..7dbc6ff16ced 100644 --- a/clients/client-glacier/commands/InitiateVaultLockCommand.ts +++ b/clients/client-glacier/commands/InitiateVaultLockCommand.ts @@ -56,6 +56,20 @@ export interface InitiateVaultLockCommandOutput extends InitiateVaultLockOutput, * 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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { GlacierClient, InitiateVaultLockCommand } from "@aws-sdk/client-glacier"; // ES Modules import + * // const { GlacierClient, InitiateVaultLockCommand } = require("@aws-sdk/client-glacier"); // CommonJS import + * const client = new GlacierClient(config); + * const command = new InitiateVaultLockCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link InitiateVaultLockCommandInput} for command's `input` shape. + * @see {@link InitiateVaultLockCommandOutput} for command's `response` shape. + * @see {@link GlacierClientResolvedConfig | config} for command's `input` shape. + * */ export class InitiateVaultLockCommand extends $Command< InitiateVaultLockCommandInput, diff --git a/clients/client-glacier/commands/ListJobsCommand.ts b/clients/client-glacier/commands/ListJobsCommand.ts index c9303b56c12f..e7a0cdd78056 100644 --- a/clients/client-glacier/commands/ListJobsCommand.ts +++ b/clients/client-glacier/commands/ListJobsCommand.ts @@ -57,6 +57,20 @@ export interface ListJobsCommandOutput extends ListJobsOutput, __MetadataBearer * *

For more information about using this operation, * see the documentation for the underlying REST API List Jobs.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { GlacierClient, ListJobsCommand } from "@aws-sdk/client-glacier"; // ES Modules import + * // const { GlacierClient, ListJobsCommand } = require("@aws-sdk/client-glacier"); // CommonJS import + * const client = new GlacierClient(config); + * const command = new ListJobsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListJobsCommandInput} for command's `input` shape. + * @see {@link ListJobsCommandOutput} for command's `response` shape. + * @see {@link GlacierClientResolvedConfig | config} for command's `input` shape. + * */ export class ListJobsCommand extends $Command< ListJobsCommandInput, diff --git a/clients/client-glacier/commands/ListMultipartUploadsCommand.ts b/clients/client-glacier/commands/ListMultipartUploadsCommand.ts index 1ad44366e8d8..1a62bff48175 100644 --- a/clients/client-glacier/commands/ListMultipartUploadsCommand.ts +++ b/clients/client-glacier/commands/ListMultipartUploadsCommand.ts @@ -47,6 +47,20 @@ export interface ListMultipartUploadsCommandOutput extends ListMultipartUploadsO *

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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { GlacierClient, ListMultipartUploadsCommand } from "@aws-sdk/client-glacier"; // ES Modules import + * // const { GlacierClient, ListMultipartUploadsCommand } = require("@aws-sdk/client-glacier"); // CommonJS import + * const client = new GlacierClient(config); + * const command = new ListMultipartUploadsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListMultipartUploadsCommandInput} for command's `input` shape. + * @see {@link ListMultipartUploadsCommandOutput} for command's `response` shape. + * @see {@link GlacierClientResolvedConfig | config} for command's `input` shape. + * */ export class ListMultipartUploadsCommand extends $Command< ListMultipartUploadsCommandInput, diff --git a/clients/client-glacier/commands/ListPartsCommand.ts b/clients/client-glacier/commands/ListPartsCommand.ts index 3b3a7a8802ec..f586a871072d 100644 --- a/clients/client-glacier/commands/ListPartsCommand.ts +++ b/clients/client-glacier/commands/ListPartsCommand.ts @@ -43,6 +43,20 @@ export interface ListPartsCommandOutput extends ListPartsOutput, __MetadataBeare *

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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { GlacierClient, ListPartsCommand } from "@aws-sdk/client-glacier"; // ES Modules import + * // const { GlacierClient, ListPartsCommand } = require("@aws-sdk/client-glacier"); // CommonJS import + * const client = new GlacierClient(config); + * const command = new ListPartsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListPartsCommandInput} for command's `input` shape. + * @see {@link ListPartsCommandOutput} for command's `response` shape. + * @see {@link GlacierClientResolvedConfig | config} for command's `input` shape. + * */ export class ListPartsCommand extends $Command< ListPartsCommandInput, diff --git a/clients/client-glacier/commands/ListProvisionedCapacityCommand.ts b/clients/client-glacier/commands/ListProvisionedCapacityCommand.ts index 038a48e3d2b3..73fa81d60d79 100644 --- a/clients/client-glacier/commands/ListProvisionedCapacityCommand.ts +++ b/clients/client-glacier/commands/ListProvisionedCapacityCommand.ts @@ -23,6 +23,20 @@ export interface ListProvisionedCapacityCommandOutput extends ListProvisionedCap /** *

This operation lists the provisioned capacity units for the specified AWS * account.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { GlacierClient, ListProvisionedCapacityCommand } from "@aws-sdk/client-glacier"; // ES Modules import + * // const { GlacierClient, ListProvisionedCapacityCommand } = require("@aws-sdk/client-glacier"); // CommonJS import + * const client = new GlacierClient(config); + * const command = new ListProvisionedCapacityCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListProvisionedCapacityCommandInput} for command's `input` shape. + * @see {@link ListProvisionedCapacityCommandOutput} for command's `response` shape. + * @see {@link GlacierClientResolvedConfig | config} for command's `input` shape. + * */ export class ListProvisionedCapacityCommand extends $Command< ListProvisionedCapacityCommandInput, diff --git a/clients/client-glacier/commands/ListTagsForVaultCommand.ts b/clients/client-glacier/commands/ListTagsForVaultCommand.ts index bfc86023fe2d..9414e8eb2240 100644 --- a/clients/client-glacier/commands/ListTagsForVaultCommand.ts +++ b/clients/client-glacier/commands/ListTagsForVaultCommand.ts @@ -24,6 +24,20 @@ export interface ListTagsForVaultCommandOutput extends ListTagsForVaultOutput, _ *

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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { GlacierClient, ListTagsForVaultCommand } from "@aws-sdk/client-glacier"; // ES Modules import + * // const { GlacierClient, ListTagsForVaultCommand } = require("@aws-sdk/client-glacier"); // CommonJS import + * const client = new GlacierClient(config); + * const command = new ListTagsForVaultCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListTagsForVaultCommandInput} for command's `input` shape. + * @see {@link ListTagsForVaultCommandOutput} for command's `response` shape. + * @see {@link GlacierClientResolvedConfig | config} for command's `input` shape. + * */ export class ListTagsForVaultCommand extends $Command< ListTagsForVaultCommandInput, diff --git a/clients/client-glacier/commands/ListVaultsCommand.ts b/clients/client-glacier/commands/ListVaultsCommand.ts index 8508df7180df..5f33cdff43f0 100644 --- a/clients/client-glacier/commands/ListVaultsCommand.ts +++ b/clients/client-glacier/commands/ListVaultsCommand.ts @@ -40,6 +40,20 @@ export interface ListVaultsCommandOutput extends ListVaultsOutput, __MetadataBea *

For conceptual information and underlying REST API, see Retrieving Vault Metadata in * Amazon S3 Glacier and List Vaults in the * Amazon Glacier Developer Guide.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { GlacierClient, ListVaultsCommand } from "@aws-sdk/client-glacier"; // ES Modules import + * // const { GlacierClient, ListVaultsCommand } = require("@aws-sdk/client-glacier"); // CommonJS import + * const client = new GlacierClient(config); + * const command = new ListVaultsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListVaultsCommandInput} for command's `input` shape. + * @see {@link ListVaultsCommandOutput} for command's `response` shape. + * @see {@link GlacierClientResolvedConfig | config} for command's `input` shape. + * */ export class ListVaultsCommand extends $Command< ListVaultsCommandInput, diff --git a/clients/client-glacier/commands/PurchaseProvisionedCapacityCommand.ts b/clients/client-glacier/commands/PurchaseProvisionedCapacityCommand.ts index a551bf76e9d1..43b01673df0b 100644 --- a/clients/client-glacier/commands/PurchaseProvisionedCapacityCommand.ts +++ b/clients/client-glacier/commands/PurchaseProvisionedCapacityCommand.ts @@ -22,6 +22,20 @@ export interface PurchaseProvisionedCapacityCommandOutput extends PurchaseProvis /** *

This operation purchases a provisioned capacity unit for an AWS account.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { GlacierClient, PurchaseProvisionedCapacityCommand } from "@aws-sdk/client-glacier"; // ES Modules import + * // const { GlacierClient, PurchaseProvisionedCapacityCommand } = require("@aws-sdk/client-glacier"); // CommonJS import + * const client = new GlacierClient(config); + * const command = new PurchaseProvisionedCapacityCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link PurchaseProvisionedCapacityCommandInput} for command's `input` shape. + * @see {@link PurchaseProvisionedCapacityCommandOutput} for command's `response` shape. + * @see {@link GlacierClientResolvedConfig | config} for command's `input` shape. + * */ export class PurchaseProvisionedCapacityCommand extends $Command< PurchaseProvisionedCapacityCommandInput, diff --git a/clients/client-glacier/commands/RemoveTagsFromVaultCommand.ts b/clients/client-glacier/commands/RemoveTagsFromVaultCommand.ts index e688d8aa4b04..a8e0962eec0e 100644 --- a/clients/client-glacier/commands/RemoveTagsFromVaultCommand.ts +++ b/clients/client-glacier/commands/RemoveTagsFromVaultCommand.ts @@ -25,6 +25,20 @@ export interface RemoveTagsFromVaultCommandOutput extends __MetadataBearer {} * 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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { GlacierClient, RemoveTagsFromVaultCommand } from "@aws-sdk/client-glacier"; // ES Modules import + * // const { GlacierClient, RemoveTagsFromVaultCommand } = require("@aws-sdk/client-glacier"); // CommonJS import + * const client = new GlacierClient(config); + * const command = new RemoveTagsFromVaultCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link RemoveTagsFromVaultCommandInput} for command's `input` shape. + * @see {@link RemoveTagsFromVaultCommandOutput} for command's `response` shape. + * @see {@link GlacierClientResolvedConfig | config} for command's `input` shape. + * */ export class RemoveTagsFromVaultCommand extends $Command< RemoveTagsFromVaultCommandInput, diff --git a/clients/client-glacier/commands/SetDataRetrievalPolicyCommand.ts b/clients/client-glacier/commands/SetDataRetrievalPolicyCommand.ts index b960fa24c2b1..ca3b95044768 100644 --- a/clients/client-glacier/commands/SetDataRetrievalPolicyCommand.ts +++ b/clients/client-glacier/commands/SetDataRetrievalPolicyCommand.ts @@ -27,6 +27,20 @@ export interface SetDataRetrievalPolicyCommandOutput extends __MetadataBearer {} *

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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { GlacierClient, SetDataRetrievalPolicyCommand } from "@aws-sdk/client-glacier"; // ES Modules import + * // const { GlacierClient, SetDataRetrievalPolicyCommand } = require("@aws-sdk/client-glacier"); // CommonJS import + * const client = new GlacierClient(config); + * const command = new SetDataRetrievalPolicyCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link SetDataRetrievalPolicyCommandInput} for command's `input` shape. + * @see {@link SetDataRetrievalPolicyCommandOutput} for command's `response` shape. + * @see {@link GlacierClientResolvedConfig | config} for command's `input` shape. + * */ export class SetDataRetrievalPolicyCommand extends $Command< SetDataRetrievalPolicyCommandInput, diff --git a/clients/client-glacier/commands/SetVaultAccessPolicyCommand.ts b/clients/client-glacier/commands/SetVaultAccessPolicyCommand.ts index 3b5a210539b3..bbbba51dcef0 100644 --- a/clients/client-glacier/commands/SetVaultAccessPolicyCommand.ts +++ b/clients/client-glacier/commands/SetVaultAccessPolicyCommand.ts @@ -27,6 +27,20 @@ export interface SetVaultAccessPolicyCommandOutput extends __MetadataBearer {} * 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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { GlacierClient, SetVaultAccessPolicyCommand } from "@aws-sdk/client-glacier"; // ES Modules import + * // const { GlacierClient, SetVaultAccessPolicyCommand } = require("@aws-sdk/client-glacier"); // CommonJS import + * const client = new GlacierClient(config); + * const command = new SetVaultAccessPolicyCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link SetVaultAccessPolicyCommandInput} for command's `input` shape. + * @see {@link SetVaultAccessPolicyCommandOutput} for command's `response` shape. + * @see {@link GlacierClientResolvedConfig | config} for command's `input` shape. + * */ export class SetVaultAccessPolicyCommand extends $Command< SetVaultAccessPolicyCommandInput, diff --git a/clients/client-glacier/commands/SetVaultNotificationsCommand.ts b/clients/client-glacier/commands/SetVaultNotificationsCommand.ts index 084e9b3d6254..f42339956696 100644 --- a/clients/client-glacier/commands/SetVaultNotificationsCommand.ts +++ b/clients/client-glacier/commands/SetVaultNotificationsCommand.ts @@ -59,6 +59,20 @@ export interface SetVaultNotificationsCommandOutput extends __MetadataBearer {} *

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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { GlacierClient, SetVaultNotificationsCommand } from "@aws-sdk/client-glacier"; // ES Modules import + * // const { GlacierClient, SetVaultNotificationsCommand } = require("@aws-sdk/client-glacier"); // CommonJS import + * const client = new GlacierClient(config); + * const command = new SetVaultNotificationsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link SetVaultNotificationsCommandInput} for command's `input` shape. + * @see {@link SetVaultNotificationsCommandOutput} for command's `response` shape. + * @see {@link GlacierClientResolvedConfig | config} for command's `input` shape. + * */ export class SetVaultNotificationsCommand extends $Command< SetVaultNotificationsCommandInput, diff --git a/clients/client-glacier/commands/UploadArchiveCommand.ts b/clients/client-glacier/commands/UploadArchiveCommand.ts index 28658b19f960..e76f18dfec74 100644 --- a/clients/client-glacier/commands/UploadArchiveCommand.ts +++ b/clients/client-glacier/commands/UploadArchiveCommand.ts @@ -62,6 +62,20 @@ export interface UploadArchiveCommandOutput extends ArchiveCreationOutput, __Met *

For conceptual information and underlying REST API, see Uploading an Archive in Amazon * Glacier and Upload Archive in the * Amazon Glacier Developer Guide.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { GlacierClient, UploadArchiveCommand } from "@aws-sdk/client-glacier"; // ES Modules import + * // const { GlacierClient, UploadArchiveCommand } = require("@aws-sdk/client-glacier"); // CommonJS import + * const client = new GlacierClient(config); + * const command = new UploadArchiveCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link UploadArchiveCommandInput} for command's `input` shape. + * @see {@link UploadArchiveCommandOutput} for command's `response` shape. + * @see {@link GlacierClientResolvedConfig | config} for command's `input` shape. + * */ export class UploadArchiveCommand extends $Command< UploadArchiveCommandInput, diff --git a/clients/client-glacier/commands/UploadMultipartPartCommand.ts b/clients/client-glacier/commands/UploadMultipartPartCommand.ts index 4a2e106e7728..6bd8b19db051 100644 --- a/clients/client-glacier/commands/UploadMultipartPartCommand.ts +++ b/clients/client-glacier/commands/UploadMultipartPartCommand.ts @@ -81,6 +81,20 @@ export interface UploadMultipartPartCommandOutput extends UploadMultipartPartOut *

For conceptual information and underlying REST API, see Uploading Large Archives in * Parts (Multipart Upload) and Upload Part in the * Amazon Glacier Developer Guide.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { GlacierClient, UploadMultipartPartCommand } from "@aws-sdk/client-glacier"; // ES Modules import + * // const { GlacierClient, UploadMultipartPartCommand } = require("@aws-sdk/client-glacier"); // CommonJS import + * const client = new GlacierClient(config); + * const command = new UploadMultipartPartCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link UploadMultipartPartCommandInput} for command's `input` shape. + * @see {@link UploadMultipartPartCommandOutput} for command's `response` shape. + * @see {@link GlacierClientResolvedConfig | config} for command's `input` shape. + * */ export class UploadMultipartPartCommand extends $Command< UploadMultipartPartCommandInput, diff --git a/clients/client-glacier/models/models_0.ts b/clients/client-glacier/models/models_0.ts index d5f6c40b5357..5562afc0c968 100644 --- a/clients/client-glacier/models/models_0.ts +++ b/clients/client-glacier/models/models_0.ts @@ -31,6 +31,9 @@ export interface AbortMultipartUploadInput { } export namespace AbortMultipartUploadInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: AbortMultipartUploadInput): any => ({ ...obj, }); @@ -59,6 +62,9 @@ export interface InvalidParameterValueException extends __SmithyException, $Meta } export namespace InvalidParameterValueException { + /** + * @internal + */ export const filterSensitiveLog = (obj: InvalidParameterValueException): any => ({ ...obj, }); @@ -87,6 +93,9 @@ export interface MissingParameterValueException extends __SmithyException, $Meta } export namespace MissingParameterValueException { + /** + * @internal + */ export const filterSensitiveLog = (obj: MissingParameterValueException): any => ({ ...obj, }); @@ -117,6 +126,9 @@ export interface ResourceNotFoundException extends __SmithyException, $MetadataB } export namespace ResourceNotFoundException { + /** + * @internal + */ export const filterSensitiveLog = (obj: ResourceNotFoundException): any => ({ ...obj, }); @@ -145,6 +157,9 @@ export interface ServiceUnavailableException extends __SmithyException, $Metadat } export namespace ServiceUnavailableException { + /** + * @internal + */ export const filterSensitiveLog = (obj: ServiceUnavailableException): any => ({ ...obj, }); @@ -170,6 +185,9 @@ export interface AbortVaultLockInput { } export namespace AbortVaultLockInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: AbortVaultLockInput): any => ({ ...obj, }); @@ -212,6 +230,9 @@ export interface Grantee { } export namespace Grantee { + /** + * @internal + */ export const filterSensitiveLog = (obj: Grantee): any => ({ ...obj, }); @@ -241,6 +262,9 @@ export interface Grant { } export namespace Grant { + /** + * @internal + */ export const filterSensitiveLog = (obj: Grant): any => ({ ...obj, }); @@ -278,6 +302,9 @@ export interface AddTagsToVaultInput { } export namespace AddTagsToVaultInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: AddTagsToVaultInput): any => ({ ...obj, }); @@ -306,6 +333,9 @@ export interface LimitExceededException extends __SmithyException, $MetadataBear } export namespace LimitExceededException { + /** + * @internal + */ export const filterSensitiveLog = (obj: LimitExceededException): any => ({ ...obj, }); @@ -335,6 +365,9 @@ export interface ArchiveCreationOutput { } export namespace ArchiveCreationOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: ArchiveCreationOutput): any => ({ ...obj, }); @@ -392,6 +425,9 @@ export interface CompleteMultipartUploadInput { } export namespace CompleteMultipartUploadInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: CompleteMultipartUploadInput): any => ({ ...obj, }); @@ -422,6 +458,9 @@ export interface CompleteVaultLockInput { } export namespace CompleteVaultLockInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: CompleteVaultLockInput): any => ({ ...obj, }); @@ -447,6 +486,9 @@ export interface CreateVaultInput { } export namespace CreateVaultInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateVaultInput): any => ({ ...obj, }); @@ -463,6 +505,9 @@ export interface CreateVaultOutput { } export namespace CreateVaultOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateVaultOutput): any => ({ ...obj, }); @@ -514,6 +559,9 @@ export interface CSVInput { } export namespace CSVInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: CSVInput): any => ({ ...obj, }); @@ -559,6 +607,9 @@ export interface CSVOutput { } export namespace CSVOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: CSVOutput): any => ({ ...obj, }); @@ -584,6 +635,9 @@ export interface DataRetrievalRule { } export namespace DataRetrievalRule { + /** + * @internal + */ export const filterSensitiveLog = (obj: DataRetrievalRule): any => ({ ...obj, }); @@ -601,6 +655,9 @@ export interface DataRetrievalPolicy { } export namespace DataRetrievalPolicy { + /** + * @internal + */ export const filterSensitiveLog = (obj: DataRetrievalPolicy): any => ({ ...obj, }); @@ -631,6 +688,9 @@ export interface DeleteArchiveInput { } export namespace DeleteArchiveInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteArchiveInput): any => ({ ...obj, }); @@ -656,6 +716,9 @@ export interface DeleteVaultInput { } export namespace DeleteVaultInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteVaultInput): any => ({ ...obj, }); @@ -681,6 +744,9 @@ export interface DeleteVaultAccessPolicyInput { } export namespace DeleteVaultAccessPolicyInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteVaultAccessPolicyInput): any => ({ ...obj, }); @@ -707,6 +773,9 @@ export interface DeleteVaultNotificationsInput { } export namespace DeleteVaultNotificationsInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteVaultNotificationsInput): any => ({ ...obj, }); @@ -737,6 +806,9 @@ export interface DescribeJobInput { } export namespace DescribeJobInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeJobInput): any => ({ ...obj, }); @@ -783,6 +855,9 @@ export interface InventoryRetrievalJobDescription { } export namespace InventoryRetrievalJobDescription { + /** + * @internal + */ export const filterSensitiveLog = (obj: InventoryRetrievalJobDescription): any => ({ ...obj, }); @@ -818,6 +893,9 @@ export interface Encryption { } export namespace Encryption { + /** + * @internal + */ export const filterSensitiveLog = (obj: Encryption): any => ({ ...obj, }); @@ -875,6 +953,9 @@ export interface S3Location { } export namespace S3Location { + /** + * @internal + */ export const filterSensitiveLog = (obj: S3Location): any => ({ ...obj, }); @@ -891,6 +972,9 @@ export interface OutputLocation { } export namespace OutputLocation { + /** + * @internal + */ export const filterSensitiveLog = (obj: OutputLocation): any => ({ ...obj, }); @@ -911,6 +995,9 @@ export interface InputSerialization { } export namespace InputSerialization { + /** + * @internal + */ export const filterSensitiveLog = (obj: InputSerialization): any => ({ ...obj, }); @@ -927,6 +1014,9 @@ export interface OutputSerialization { } export namespace OutputSerialization { + /** + * @internal + */ export const filterSensitiveLog = (obj: OutputSerialization): any => ({ ...obj, }); @@ -958,6 +1048,9 @@ export interface SelectParameters { } export namespace SelectParameters { + /** + * @internal + */ export const filterSensitiveLog = (obj: SelectParameters): any => ({ ...obj, }); @@ -1127,6 +1220,9 @@ export interface GlacierJobDescription { } export namespace GlacierJobDescription { + /** + * @internal + */ export const filterSensitiveLog = (obj: GlacierJobDescription): any => ({ ...obj, }); @@ -1153,6 +1249,9 @@ export interface DescribeVaultInput { } export namespace DescribeVaultInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeVaultInput): any => ({ ...obj, }); @@ -1202,6 +1301,9 @@ export interface DescribeVaultOutput { } export namespace DescribeVaultOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeVaultOutput): any => ({ ...obj, }); @@ -1222,6 +1324,9 @@ export interface GetDataRetrievalPolicyInput { } export namespace GetDataRetrievalPolicyInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetDataRetrievalPolicyInput): any => ({ ...obj, }); @@ -1239,6 +1344,9 @@ export interface GetDataRetrievalPolicyOutput { } export namespace GetDataRetrievalPolicyOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetDataRetrievalPolicyOutput): any => ({ ...obj, }); @@ -1309,6 +1417,9 @@ export interface GetJobOutputInput { } export namespace GetJobOutputInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetJobOutputInput): any => ({ ...obj, }); @@ -1381,6 +1492,9 @@ export interface GetJobOutputOutput { } export namespace GetJobOutputOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetJobOutputOutput): any => ({ ...obj, }); @@ -1406,6 +1520,9 @@ export interface GetVaultAccessPolicyInput { } export namespace GetVaultAccessPolicyInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetVaultAccessPolicyInput): any => ({ ...obj, }); @@ -1422,6 +1539,9 @@ export interface VaultAccessPolicy { } export namespace VaultAccessPolicy { + /** + * @internal + */ export const filterSensitiveLog = (obj: VaultAccessPolicy): any => ({ ...obj, }); @@ -1438,6 +1558,9 @@ export interface GetVaultAccessPolicyOutput { } export namespace GetVaultAccessPolicyOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetVaultAccessPolicyOutput): any => ({ ...obj, }); @@ -1463,6 +1586,9 @@ export interface GetVaultLockInput { } export namespace GetVaultLockInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetVaultLockInput): any => ({ ...obj, }); @@ -1498,6 +1624,9 @@ export interface GetVaultLockOutput { } export namespace GetVaultLockOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetVaultLockOutput): any => ({ ...obj, }); @@ -1524,6 +1653,9 @@ export interface GetVaultNotificationsInput { } export namespace GetVaultNotificationsInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetVaultNotificationsInput): any => ({ ...obj, }); @@ -1547,6 +1679,9 @@ export interface VaultNotificationConfig { } export namespace VaultNotificationConfig { + /** + * @internal + */ export const filterSensitiveLog = (obj: VaultNotificationConfig): any => ({ ...obj, }); @@ -1563,6 +1698,9 @@ export interface GetVaultNotificationsOutput { } export namespace GetVaultNotificationsOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetVaultNotificationsOutput): any => ({ ...obj, }); @@ -1602,6 +1740,9 @@ export interface InventoryRetrievalJobInput { } export namespace InventoryRetrievalJobInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: InventoryRetrievalJobInput): any => ({ ...obj, }); @@ -1685,6 +1826,9 @@ export interface JobParameters { } export namespace JobParameters { + /** + * @internal + */ export const filterSensitiveLog = (obj: JobParameters): any => ({ ...obj, }); @@ -1715,6 +1859,9 @@ export interface InitiateJobInput { } export namespace InitiateJobInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: InitiateJobInput): any => ({ ...obj, }); @@ -1741,6 +1888,9 @@ export interface InitiateJobOutput { } export namespace InitiateJobOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: InitiateJobOutput): any => ({ ...obj, }); @@ -1760,6 +1910,9 @@ export interface InsufficientCapacityException extends __SmithyException, $Metad } export namespace InsufficientCapacityException { + /** + * @internal + */ export const filterSensitiveLog = (obj: InsufficientCapacityException): any => ({ ...obj, }); @@ -1789,6 +1942,9 @@ export interface PolicyEnforcedException extends __SmithyException, $MetadataBea } export namespace PolicyEnforcedException { + /** + * @internal + */ export const filterSensitiveLog = (obj: PolicyEnforcedException): any => ({ ...obj, }); @@ -1829,6 +1985,9 @@ export interface InitiateMultipartUploadInput { } export namespace InitiateMultipartUploadInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: InitiateMultipartUploadInput): any => ({ ...obj, }); @@ -1851,6 +2010,9 @@ export interface InitiateMultipartUploadOutput { } export namespace InitiateMultipartUploadOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: InitiateMultipartUploadOutput): any => ({ ...obj, }); @@ -1867,6 +2029,9 @@ export interface VaultLockPolicy { } export namespace VaultLockPolicy { + /** + * @internal + */ export const filterSensitiveLog = (obj: VaultLockPolicy): any => ({ ...obj, }); @@ -1898,6 +2063,9 @@ export interface InitiateVaultLockInput { } export namespace InitiateVaultLockInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: InitiateVaultLockInput): any => ({ ...obj, }); @@ -1914,6 +2082,9 @@ export interface InitiateVaultLockOutput { } export namespace InitiateVaultLockOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: InitiateVaultLockOutput): any => ({ ...obj, }); @@ -1966,6 +2137,9 @@ export interface ListJobsInput { } export namespace ListJobsInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListJobsInput): any => ({ ...obj, }); @@ -1992,6 +2166,9 @@ export interface ListJobsOutput { } export namespace ListJobsOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListJobsOutput): any => ({ ...obj, }); @@ -2032,6 +2209,9 @@ export interface ListMultipartUploadsInput { } export namespace ListMultipartUploadsInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListMultipartUploadsInput): any => ({ ...obj, }); @@ -2071,6 +2251,9 @@ export interface UploadListElement { } export namespace UploadListElement { + /** + * @internal + */ export const filterSensitiveLog = (obj: UploadListElement): any => ({ ...obj, }); @@ -2094,6 +2277,9 @@ export interface ListMultipartUploadsOutput { } export namespace ListMultipartUploadsOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListMultipartUploadsOutput): any => ({ ...obj, }); @@ -2140,6 +2326,9 @@ export interface ListPartsInput { } export namespace ListPartsInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListPartsInput): any => ({ ...obj, }); @@ -2162,6 +2351,9 @@ export interface PartListElement { } export namespace PartListElement { + /** + * @internal + */ export const filterSensitiveLog = (obj: PartListElement): any => ({ ...obj, }); @@ -2215,6 +2407,9 @@ export interface ListPartsOutput { } export namespace ListPartsOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListPartsOutput): any => ({ ...obj, }); @@ -2231,6 +2426,9 @@ export interface ListProvisionedCapacityInput { } export namespace ListProvisionedCapacityInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListProvisionedCapacityInput): any => ({ ...obj, }); @@ -2257,6 +2455,9 @@ export interface ProvisionedCapacityDescription { } export namespace ProvisionedCapacityDescription { + /** + * @internal + */ export const filterSensitiveLog = (obj: ProvisionedCapacityDescription): any => ({ ...obj, }); @@ -2270,6 +2471,9 @@ export interface ListProvisionedCapacityOutput { } export namespace ListProvisionedCapacityOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListProvisionedCapacityOutput): any => ({ ...obj, }); @@ -2295,6 +2499,9 @@ export interface ListTagsForVaultInput { } export namespace ListTagsForVaultInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListTagsForVaultInput): any => ({ ...obj, }); @@ -2311,6 +2518,9 @@ export interface ListTagsForVaultOutput { } export namespace ListTagsForVaultOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListTagsForVaultOutput): any => ({ ...obj, }); @@ -2345,6 +2555,9 @@ export interface ListVaultsInput { } export namespace ListVaultsInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListVaultsInput): any => ({ ...obj, }); @@ -2367,6 +2580,9 @@ export interface ListVaultsOutput { } export namespace ListVaultsOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListVaultsOutput): any => ({ ...obj, }); @@ -2383,6 +2599,9 @@ export interface PurchaseProvisionedCapacityInput { } export namespace PurchaseProvisionedCapacityInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: PurchaseProvisionedCapacityInput): any => ({ ...obj, }); @@ -2396,6 +2615,9 @@ export interface PurchaseProvisionedCapacityOutput { } export namespace PurchaseProvisionedCapacityOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: PurchaseProvisionedCapacityOutput): any => ({ ...obj, }); @@ -2426,6 +2648,9 @@ export interface RemoveTagsFromVaultInput { } export namespace RemoveTagsFromVaultInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: RemoveTagsFromVaultInput): any => ({ ...obj, }); @@ -2451,6 +2676,9 @@ export interface SetDataRetrievalPolicyInput { } export namespace SetDataRetrievalPolicyInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: SetDataRetrievalPolicyInput): any => ({ ...obj, }); @@ -2481,6 +2709,9 @@ export interface SetVaultAccessPolicyInput { } export namespace SetVaultAccessPolicyInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: SetVaultAccessPolicyInput): any => ({ ...obj, }); @@ -2512,6 +2743,9 @@ export interface SetVaultNotificationsInput { } export namespace SetVaultNotificationsInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: SetVaultNotificationsInput): any => ({ ...obj, }); @@ -2542,6 +2776,9 @@ export interface RequestTimeoutException extends __SmithyException, $MetadataBea } export namespace RequestTimeoutException { + /** + * @internal + */ export const filterSensitiveLog = (obj: RequestTimeoutException): any => ({ ...obj, }); @@ -2582,6 +2819,9 @@ export interface UploadArchiveInput { } export namespace UploadArchiveInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: UploadArchiveInput): any => ({ ...obj, }); @@ -2631,6 +2871,9 @@ export interface UploadMultipartPartInput { } export namespace UploadMultipartPartInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: UploadMultipartPartInput): any => ({ ...obj, }); @@ -2647,6 +2890,9 @@ export interface UploadMultipartPartOutput { } export namespace UploadMultipartPartOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: UploadMultipartPartOutput): any => ({ ...obj, }); diff --git a/clients/client-global-accelerator/commands/AddCustomRoutingEndpointsCommand.ts b/clients/client-global-accelerator/commands/AddCustomRoutingEndpointsCommand.ts index 61abc96dce36..1fd3b429ed3c 100644 --- a/clients/client-global-accelerator/commands/AddCustomRoutingEndpointsCommand.ts +++ b/clients/client-global-accelerator/commands/AddCustomRoutingEndpointsCommand.ts @@ -36,6 +36,20 @@ export interface AddCustomRoutingEndpointsCommandOutput extends AddCustomRouting * destinations to receive traffic, or to specify individual port mappings that can receive * traffic, see the * AllowCustomRoutingTraffic operation.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { GlobalAcceleratorClient, AddCustomRoutingEndpointsCommand } from "@aws-sdk/client-global-accelerator"; // ES Modules import + * // const { GlobalAcceleratorClient, AddCustomRoutingEndpointsCommand } = require("@aws-sdk/client-global-accelerator"); // CommonJS import + * const client = new GlobalAcceleratorClient(config); + * const command = new AddCustomRoutingEndpointsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link AddCustomRoutingEndpointsCommandInput} for command's `input` shape. + * @see {@link AddCustomRoutingEndpointsCommandOutput} for command's `response` shape. + * @see {@link GlobalAcceleratorClientResolvedConfig | config} for command's `input` shape. + * */ export class AddCustomRoutingEndpointsCommand extends $Command< AddCustomRoutingEndpointsCommandInput, diff --git a/clients/client-global-accelerator/commands/AdvertiseByoipCidrCommand.ts b/clients/client-global-accelerator/commands/AdvertiseByoipCidrCommand.ts index 3833caa7e9af..557c2bd5568b 100644 --- a/clients/client-global-accelerator/commands/AdvertiseByoipCidrCommand.ts +++ b/clients/client-global-accelerator/commands/AdvertiseByoipCidrCommand.ts @@ -32,6 +32,20 @@ export interface AdvertiseByoipCidrCommandOutput extends AdvertiseByoipCidrRespo * WithdrawByoipCidr.

*

For more information, see Bring Your Own * IP Addresses (BYOIP) in the AWS Global Accelerator Developer Guide.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { GlobalAcceleratorClient, AdvertiseByoipCidrCommand } from "@aws-sdk/client-global-accelerator"; // ES Modules import + * // const { GlobalAcceleratorClient, AdvertiseByoipCidrCommand } = require("@aws-sdk/client-global-accelerator"); // CommonJS import + * const client = new GlobalAcceleratorClient(config); + * const command = new AdvertiseByoipCidrCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link AdvertiseByoipCidrCommandInput} for command's `input` shape. + * @see {@link AdvertiseByoipCidrCommandOutput} for command's `response` shape. + * @see {@link GlobalAcceleratorClientResolvedConfig | config} for command's `input` shape. + * */ export class AdvertiseByoipCidrCommand extends $Command< AdvertiseByoipCidrCommandInput, diff --git a/clients/client-global-accelerator/commands/AllowCustomRoutingTrafficCommand.ts b/clients/client-global-accelerator/commands/AllowCustomRoutingTrafficCommand.ts index 7fa100a25f00..954f488dd9f1 100644 --- a/clients/client-global-accelerator/commands/AllowCustomRoutingTrafficCommand.ts +++ b/clients/client-global-accelerator/commands/AllowCustomRoutingTrafficCommand.ts @@ -31,6 +31,20 @@ export interface AllowCustomRoutingTrafficCommandOutput extends __MetadataBearer * 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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { GlobalAcceleratorClient, AllowCustomRoutingTrafficCommand } from "@aws-sdk/client-global-accelerator"; // ES Modules import + * // const { GlobalAcceleratorClient, AllowCustomRoutingTrafficCommand } = require("@aws-sdk/client-global-accelerator"); // CommonJS import + * const client = new GlobalAcceleratorClient(config); + * const command = new AllowCustomRoutingTrafficCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link AllowCustomRoutingTrafficCommandInput} for command's `input` shape. + * @see {@link AllowCustomRoutingTrafficCommandOutput} for command's `response` shape. + * @see {@link GlobalAcceleratorClientResolvedConfig | config} for command's `input` shape. + * */ export class AllowCustomRoutingTrafficCommand extends $Command< AllowCustomRoutingTrafficCommandInput, diff --git a/clients/client-global-accelerator/commands/CreateAcceleratorCommand.ts b/clients/client-global-accelerator/commands/CreateAcceleratorCommand.ts index bda8c01fa003..2467002b2422 100644 --- a/clients/client-global-accelerator/commands/CreateAcceleratorCommand.ts +++ b/clients/client-global-accelerator/commands/CreateAcceleratorCommand.ts @@ -31,6 +31,20 @@ export interface CreateAcceleratorCommandOutput extends CreateAcceleratorRespons *

Global Accelerator is a global service that supports endpoints in multiple AWS Regions but you must specify the * US West (Oregon) Region to create or update accelerators.

* + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { GlobalAcceleratorClient, CreateAcceleratorCommand } from "@aws-sdk/client-global-accelerator"; // ES Modules import + * // const { GlobalAcceleratorClient, CreateAcceleratorCommand } = require("@aws-sdk/client-global-accelerator"); // CommonJS import + * const client = new GlobalAcceleratorClient(config); + * const command = new CreateAcceleratorCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreateAcceleratorCommandInput} for command's `input` shape. + * @see {@link CreateAcceleratorCommandOutput} for command's `response` shape. + * @see {@link GlobalAcceleratorClientResolvedConfig | config} for command's `input` shape. + * */ export class CreateAcceleratorCommand extends $Command< CreateAcceleratorCommandInput, diff --git a/clients/client-global-accelerator/commands/CreateCustomRoutingAcceleratorCommand.ts b/clients/client-global-accelerator/commands/CreateCustomRoutingAcceleratorCommand.ts index d5424ec87e1a..d456615b216f 100644 --- a/clients/client-global-accelerator/commands/CreateCustomRoutingAcceleratorCommand.ts +++ b/clients/client-global-accelerator/commands/CreateCustomRoutingAcceleratorCommand.ts @@ -37,6 +37,20 @@ export interface CreateCustomRoutingAcceleratorCommandOutput *

Global Accelerator is a global service that supports endpoints in multiple AWS Regions but you must specify the * US West (Oregon) Region to create or update accelerators.

* + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { GlobalAcceleratorClient, CreateCustomRoutingAcceleratorCommand } from "@aws-sdk/client-global-accelerator"; // ES Modules import + * // const { GlobalAcceleratorClient, CreateCustomRoutingAcceleratorCommand } = require("@aws-sdk/client-global-accelerator"); // CommonJS import + * const client = new GlobalAcceleratorClient(config); + * const command = new CreateCustomRoutingAcceleratorCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreateCustomRoutingAcceleratorCommandInput} for command's `input` shape. + * @see {@link CreateCustomRoutingAcceleratorCommandOutput} for command's `response` shape. + * @see {@link GlobalAcceleratorClientResolvedConfig | config} for command's `input` shape. + * */ export class CreateCustomRoutingAcceleratorCommand extends $Command< CreateCustomRoutingAcceleratorCommandInput, diff --git a/clients/client-global-accelerator/commands/CreateCustomRoutingEndpointGroupCommand.ts b/clients/client-global-accelerator/commands/CreateCustomRoutingEndpointGroupCommand.ts index c0dca1844180..1066ec35d902 100644 --- a/clients/client-global-accelerator/commands/CreateCustomRoutingEndpointGroupCommand.ts +++ b/clients/client-global-accelerator/commands/CreateCustomRoutingEndpointGroupCommand.ts @@ -30,6 +30,20 @@ export interface CreateCustomRoutingEndpointGroupCommandOutput *

Create an endpoint group for the specified listener for a custom routing accelerator. * An endpoint group is a collection of endpoints in one AWS * Region.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { GlobalAcceleratorClient, CreateCustomRoutingEndpointGroupCommand } from "@aws-sdk/client-global-accelerator"; // ES Modules import + * // const { GlobalAcceleratorClient, CreateCustomRoutingEndpointGroupCommand } = require("@aws-sdk/client-global-accelerator"); // CommonJS import + * const client = new GlobalAcceleratorClient(config); + * const command = new CreateCustomRoutingEndpointGroupCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreateCustomRoutingEndpointGroupCommandInput} for command's `input` shape. + * @see {@link CreateCustomRoutingEndpointGroupCommandOutput} for command's `response` shape. + * @see {@link GlobalAcceleratorClientResolvedConfig | config} for command's `input` shape. + * */ export class CreateCustomRoutingEndpointGroupCommand extends $Command< CreateCustomRoutingEndpointGroupCommandInput, diff --git a/clients/client-global-accelerator/commands/CreateCustomRoutingListenerCommand.ts b/clients/client-global-accelerator/commands/CreateCustomRoutingListenerCommand.ts index d86d92d04c57..621c87ccfdd6 100644 --- a/clients/client-global-accelerator/commands/CreateCustomRoutingListenerCommand.ts +++ b/clients/client-global-accelerator/commands/CreateCustomRoutingListenerCommand.ts @@ -29,6 +29,20 @@ export interface CreateCustomRoutingListenerCommandOutput /** *

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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { GlobalAcceleratorClient, CreateCustomRoutingListenerCommand } from "@aws-sdk/client-global-accelerator"; // ES Modules import + * // const { GlobalAcceleratorClient, CreateCustomRoutingListenerCommand } = require("@aws-sdk/client-global-accelerator"); // CommonJS import + * const client = new GlobalAcceleratorClient(config); + * const command = new CreateCustomRoutingListenerCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreateCustomRoutingListenerCommandInput} for command's `input` shape. + * @see {@link CreateCustomRoutingListenerCommandOutput} for command's `response` shape. + * @see {@link GlobalAcceleratorClientResolvedConfig | config} for command's `input` shape. + * */ export class CreateCustomRoutingListenerCommand extends $Command< CreateCustomRoutingListenerCommandInput, diff --git a/clients/client-global-accelerator/commands/CreateEndpointGroupCommand.ts b/clients/client-global-accelerator/commands/CreateEndpointGroupCommand.ts index 13b93c9ed4d7..891c704fb045 100644 --- a/clients/client-global-accelerator/commands/CreateEndpointGroupCommand.ts +++ b/clients/client-global-accelerator/commands/CreateEndpointGroupCommand.ts @@ -27,6 +27,20 @@ export interface CreateEndpointGroupCommandOutput extends CreateEndpointGroupRes /** *

Create an endpoint group for the specified listener. An endpoint group is a collection of endpoints in one AWS * Region. A resource must be valid and active when you add it as an endpoint.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { GlobalAcceleratorClient, CreateEndpointGroupCommand } from "@aws-sdk/client-global-accelerator"; // ES Modules import + * // const { GlobalAcceleratorClient, CreateEndpointGroupCommand } = require("@aws-sdk/client-global-accelerator"); // CommonJS import + * const client = new GlobalAcceleratorClient(config); + * const command = new CreateEndpointGroupCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreateEndpointGroupCommandInput} for command's `input` shape. + * @see {@link CreateEndpointGroupCommandOutput} for command's `response` shape. + * @see {@link GlobalAcceleratorClientResolvedConfig | config} for command's `input` shape. + * */ export class CreateEndpointGroupCommand extends $Command< CreateEndpointGroupCommandInput, diff --git a/clients/client-global-accelerator/commands/CreateListenerCommand.ts b/clients/client-global-accelerator/commands/CreateListenerCommand.ts index b4754b17bd4f..264459839926 100644 --- a/clients/client-global-accelerator/commands/CreateListenerCommand.ts +++ b/clients/client-global-accelerator/commands/CreateListenerCommand.ts @@ -27,6 +27,20 @@ export interface CreateListenerCommandOutput extends CreateListenerResponse, __M /** *

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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { GlobalAcceleratorClient, CreateListenerCommand } from "@aws-sdk/client-global-accelerator"; // ES Modules import + * // const { GlobalAcceleratorClient, CreateListenerCommand } = require("@aws-sdk/client-global-accelerator"); // CommonJS import + * const client = new GlobalAcceleratorClient(config); + * const command = new CreateListenerCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreateListenerCommandInput} for command's `input` shape. + * @see {@link CreateListenerCommandOutput} for command's `response` shape. + * @see {@link GlobalAcceleratorClientResolvedConfig | config} for command's `input` shape. + * */ export class CreateListenerCommand extends $Command< CreateListenerCommandInput, diff --git a/clients/client-global-accelerator/commands/DeleteAcceleratorCommand.ts b/clients/client-global-accelerator/commands/DeleteAcceleratorCommand.ts index be2d13f5755f..0247b6f297de 100644 --- a/clients/client-global-accelerator/commands/DeleteAcceleratorCommand.ts +++ b/clients/client-global-accelerator/commands/DeleteAcceleratorCommand.ts @@ -39,6 +39,20 @@ export interface DeleteAcceleratorCommandOutput extends __MetadataBearer {} * see Authentication and Access Control in * the AWS Global Accelerator Developer Guide.

* + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { GlobalAcceleratorClient, DeleteAcceleratorCommand } from "@aws-sdk/client-global-accelerator"; // ES Modules import + * // const { GlobalAcceleratorClient, DeleteAcceleratorCommand } = require("@aws-sdk/client-global-accelerator"); // CommonJS import + * const client = new GlobalAcceleratorClient(config); + * const command = new DeleteAcceleratorCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteAcceleratorCommandInput} for command's `input` shape. + * @see {@link DeleteAcceleratorCommandOutput} for command's `response` shape. + * @see {@link GlobalAcceleratorClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteAcceleratorCommand extends $Command< DeleteAcceleratorCommandInput, diff --git a/clients/client-global-accelerator/commands/DeleteCustomRoutingAcceleratorCommand.ts b/clients/client-global-accelerator/commands/DeleteCustomRoutingAcceleratorCommand.ts index 0f9f147ad1ac..696369c10cc3 100644 --- a/clients/client-global-accelerator/commands/DeleteCustomRoutingAcceleratorCommand.ts +++ b/clients/client-global-accelerator/commands/DeleteCustomRoutingAcceleratorCommand.ts @@ -39,6 +39,20 @@ export interface DeleteCustomRoutingAcceleratorCommandOutput extends __MetadataB * see Authentication and Access Control in * the AWS Global Accelerator Developer Guide.

* + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { GlobalAcceleratorClient, DeleteCustomRoutingAcceleratorCommand } from "@aws-sdk/client-global-accelerator"; // ES Modules import + * // const { GlobalAcceleratorClient, DeleteCustomRoutingAcceleratorCommand } = require("@aws-sdk/client-global-accelerator"); // CommonJS import + * const client = new GlobalAcceleratorClient(config); + * const command = new DeleteCustomRoutingAcceleratorCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteCustomRoutingAcceleratorCommandInput} for command's `input` shape. + * @see {@link DeleteCustomRoutingAcceleratorCommandOutput} for command's `response` shape. + * @see {@link GlobalAcceleratorClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteCustomRoutingAcceleratorCommand extends $Command< DeleteCustomRoutingAcceleratorCommandInput, diff --git a/clients/client-global-accelerator/commands/DeleteCustomRoutingEndpointGroupCommand.ts b/clients/client-global-accelerator/commands/DeleteCustomRoutingEndpointGroupCommand.ts index ef8e2b668955..f4eb63e178b7 100644 --- a/clients/client-global-accelerator/commands/DeleteCustomRoutingEndpointGroupCommand.ts +++ b/clients/client-global-accelerator/commands/DeleteCustomRoutingEndpointGroupCommand.ts @@ -26,6 +26,20 @@ export interface DeleteCustomRoutingEndpointGroupCommandOutput extends __Metadat /** *

Delete an endpoint group from a listener for a custom routing accelerator.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { GlobalAcceleratorClient, DeleteCustomRoutingEndpointGroupCommand } from "@aws-sdk/client-global-accelerator"; // ES Modules import + * // const { GlobalAcceleratorClient, DeleteCustomRoutingEndpointGroupCommand } = require("@aws-sdk/client-global-accelerator"); // CommonJS import + * const client = new GlobalAcceleratorClient(config); + * const command = new DeleteCustomRoutingEndpointGroupCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteCustomRoutingEndpointGroupCommandInput} for command's `input` shape. + * @see {@link DeleteCustomRoutingEndpointGroupCommandOutput} for command's `response` shape. + * @see {@link GlobalAcceleratorClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteCustomRoutingEndpointGroupCommand extends $Command< DeleteCustomRoutingEndpointGroupCommandInput, diff --git a/clients/client-global-accelerator/commands/DeleteCustomRoutingListenerCommand.ts b/clients/client-global-accelerator/commands/DeleteCustomRoutingListenerCommand.ts index 836919bea199..dc820bd18f8b 100644 --- a/clients/client-global-accelerator/commands/DeleteCustomRoutingListenerCommand.ts +++ b/clients/client-global-accelerator/commands/DeleteCustomRoutingListenerCommand.ts @@ -26,6 +26,20 @@ export interface DeleteCustomRoutingListenerCommandOutput extends __MetadataBear /** *

Delete a listener for a custom routing accelerator.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { GlobalAcceleratorClient, DeleteCustomRoutingListenerCommand } from "@aws-sdk/client-global-accelerator"; // ES Modules import + * // const { GlobalAcceleratorClient, DeleteCustomRoutingListenerCommand } = require("@aws-sdk/client-global-accelerator"); // CommonJS import + * const client = new GlobalAcceleratorClient(config); + * const command = new DeleteCustomRoutingListenerCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteCustomRoutingListenerCommandInput} for command's `input` shape. + * @see {@link DeleteCustomRoutingListenerCommandOutput} for command's `response` shape. + * @see {@link GlobalAcceleratorClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteCustomRoutingListenerCommand extends $Command< DeleteCustomRoutingListenerCommandInput, diff --git a/clients/client-global-accelerator/commands/DeleteEndpointGroupCommand.ts b/clients/client-global-accelerator/commands/DeleteEndpointGroupCommand.ts index 2d7eae9695cd..f07a7583a8c7 100644 --- a/clients/client-global-accelerator/commands/DeleteEndpointGroupCommand.ts +++ b/clients/client-global-accelerator/commands/DeleteEndpointGroupCommand.ts @@ -26,6 +26,20 @@ export interface DeleteEndpointGroupCommandOutput extends __MetadataBearer {} /** *

Delete an endpoint group from a listener.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { GlobalAcceleratorClient, DeleteEndpointGroupCommand } from "@aws-sdk/client-global-accelerator"; // ES Modules import + * // const { GlobalAcceleratorClient, DeleteEndpointGroupCommand } = require("@aws-sdk/client-global-accelerator"); // CommonJS import + * const client = new GlobalAcceleratorClient(config); + * const command = new DeleteEndpointGroupCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteEndpointGroupCommandInput} for command's `input` shape. + * @see {@link DeleteEndpointGroupCommandOutput} for command's `response` shape. + * @see {@link GlobalAcceleratorClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteEndpointGroupCommand extends $Command< DeleteEndpointGroupCommandInput, diff --git a/clients/client-global-accelerator/commands/DeleteListenerCommand.ts b/clients/client-global-accelerator/commands/DeleteListenerCommand.ts index 501b702290cc..a1d6c367ee3e 100644 --- a/clients/client-global-accelerator/commands/DeleteListenerCommand.ts +++ b/clients/client-global-accelerator/commands/DeleteListenerCommand.ts @@ -26,6 +26,20 @@ export interface DeleteListenerCommandOutput extends __MetadataBearer {} /** *

Delete a listener from an accelerator.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { GlobalAcceleratorClient, DeleteListenerCommand } from "@aws-sdk/client-global-accelerator"; // ES Modules import + * // const { GlobalAcceleratorClient, DeleteListenerCommand } = require("@aws-sdk/client-global-accelerator"); // CommonJS import + * const client = new GlobalAcceleratorClient(config); + * const command = new DeleteListenerCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteListenerCommandInput} for command's `input` shape. + * @see {@link DeleteListenerCommandOutput} for command's `response` shape. + * @see {@link GlobalAcceleratorClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteListenerCommand extends $Command< DeleteListenerCommandInput, diff --git a/clients/client-global-accelerator/commands/DenyCustomRoutingTrafficCommand.ts b/clients/client-global-accelerator/commands/DenyCustomRoutingTrafficCommand.ts index 84f628bc0002..12a98934e91f 100644 --- a/clients/client-global-accelerator/commands/DenyCustomRoutingTrafficCommand.ts +++ b/clients/client-global-accelerator/commands/DenyCustomRoutingTrafficCommand.ts @@ -31,6 +31,20 @@ export interface DenyCustomRoutingTrafficCommandOutput extends __MetadataBearer * 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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { GlobalAcceleratorClient, DenyCustomRoutingTrafficCommand } from "@aws-sdk/client-global-accelerator"; // ES Modules import + * // const { GlobalAcceleratorClient, DenyCustomRoutingTrafficCommand } = require("@aws-sdk/client-global-accelerator"); // CommonJS import + * const client = new GlobalAcceleratorClient(config); + * const command = new DenyCustomRoutingTrafficCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DenyCustomRoutingTrafficCommandInput} for command's `input` shape. + * @see {@link DenyCustomRoutingTrafficCommandOutput} for command's `response` shape. + * @see {@link GlobalAcceleratorClientResolvedConfig | config} for command's `input` shape. + * */ export class DenyCustomRoutingTrafficCommand extends $Command< DenyCustomRoutingTrafficCommandInput, diff --git a/clients/client-global-accelerator/commands/DeprovisionByoipCidrCommand.ts b/clients/client-global-accelerator/commands/DeprovisionByoipCidrCommand.ts index e48fbca0b6b7..1cf7aa438b60 100644 --- a/clients/client-global-accelerator/commands/DeprovisionByoipCidrCommand.ts +++ b/clients/client-global-accelerator/commands/DeprovisionByoipCidrCommand.ts @@ -32,6 +32,20 @@ export interface DeprovisionByoipCidrCommandOutput extends DeprovisionByoipCidrR *

*

For more information, see Bring Your Own * IP Addresses (BYOIP) in the AWS Global Accelerator Developer Guide.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { GlobalAcceleratorClient, DeprovisionByoipCidrCommand } from "@aws-sdk/client-global-accelerator"; // ES Modules import + * // const { GlobalAcceleratorClient, DeprovisionByoipCidrCommand } = require("@aws-sdk/client-global-accelerator"); // CommonJS import + * const client = new GlobalAcceleratorClient(config); + * const command = new DeprovisionByoipCidrCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeprovisionByoipCidrCommandInput} for command's `input` shape. + * @see {@link DeprovisionByoipCidrCommandOutput} for command's `response` shape. + * @see {@link GlobalAcceleratorClientResolvedConfig | config} for command's `input` shape. + * */ export class DeprovisionByoipCidrCommand extends $Command< DeprovisionByoipCidrCommandInput, diff --git a/clients/client-global-accelerator/commands/DescribeAcceleratorAttributesCommand.ts b/clients/client-global-accelerator/commands/DescribeAcceleratorAttributesCommand.ts index f76565337e17..9c4241323cf3 100644 --- a/clients/client-global-accelerator/commands/DescribeAcceleratorAttributesCommand.ts +++ b/clients/client-global-accelerator/commands/DescribeAcceleratorAttributesCommand.ts @@ -29,6 +29,20 @@ export interface DescribeAcceleratorAttributesCommandOutput /** *

Describe the attributes of an accelerator. *

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { GlobalAcceleratorClient, DescribeAcceleratorAttributesCommand } from "@aws-sdk/client-global-accelerator"; // ES Modules import + * // const { GlobalAcceleratorClient, DescribeAcceleratorAttributesCommand } = require("@aws-sdk/client-global-accelerator"); // CommonJS import + * const client = new GlobalAcceleratorClient(config); + * const command = new DescribeAcceleratorAttributesCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeAcceleratorAttributesCommandInput} for command's `input` shape. + * @see {@link DescribeAcceleratorAttributesCommandOutput} for command's `response` shape. + * @see {@link GlobalAcceleratorClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeAcceleratorAttributesCommand extends $Command< DescribeAcceleratorAttributesCommandInput, diff --git a/clients/client-global-accelerator/commands/DescribeAcceleratorCommand.ts b/clients/client-global-accelerator/commands/DescribeAcceleratorCommand.ts index 4a42bcf95ab1..d268be63e1da 100644 --- a/clients/client-global-accelerator/commands/DescribeAcceleratorCommand.ts +++ b/clients/client-global-accelerator/commands/DescribeAcceleratorCommand.ts @@ -26,6 +26,20 @@ export interface DescribeAcceleratorCommandOutput extends DescribeAcceleratorRes /** *

Describe an accelerator.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { GlobalAcceleratorClient, DescribeAcceleratorCommand } from "@aws-sdk/client-global-accelerator"; // ES Modules import + * // const { GlobalAcceleratorClient, DescribeAcceleratorCommand } = require("@aws-sdk/client-global-accelerator"); // CommonJS import + * const client = new GlobalAcceleratorClient(config); + * const command = new DescribeAcceleratorCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeAcceleratorCommandInput} for command's `input` shape. + * @see {@link DescribeAcceleratorCommandOutput} for command's `response` shape. + * @see {@link GlobalAcceleratorClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeAcceleratorCommand extends $Command< DescribeAcceleratorCommandInput, diff --git a/clients/client-global-accelerator/commands/DescribeCustomRoutingAcceleratorAttributesCommand.ts b/clients/client-global-accelerator/commands/DescribeCustomRoutingAcceleratorAttributesCommand.ts index 7fb2db3253da..de4c805907b4 100644 --- a/clients/client-global-accelerator/commands/DescribeCustomRoutingAcceleratorAttributesCommand.ts +++ b/clients/client-global-accelerator/commands/DescribeCustomRoutingAcceleratorAttributesCommand.ts @@ -32,6 +32,20 @@ export interface DescribeCustomRoutingAcceleratorAttributesCommandOutput /** *

Describe the attributes of a custom routing accelerator.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { GlobalAcceleratorClient, DescribeCustomRoutingAcceleratorAttributesCommand } from "@aws-sdk/client-global-accelerator"; // ES Modules import + * // const { GlobalAcceleratorClient, DescribeCustomRoutingAcceleratorAttributesCommand } = require("@aws-sdk/client-global-accelerator"); // CommonJS import + * const client = new GlobalAcceleratorClient(config); + * const command = new DescribeCustomRoutingAcceleratorAttributesCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeCustomRoutingAcceleratorAttributesCommandInput} for command's `input` shape. + * @see {@link DescribeCustomRoutingAcceleratorAttributesCommandOutput} for command's `response` shape. + * @see {@link GlobalAcceleratorClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeCustomRoutingAcceleratorAttributesCommand extends $Command< DescribeCustomRoutingAcceleratorAttributesCommandInput, diff --git a/clients/client-global-accelerator/commands/DescribeCustomRoutingAcceleratorCommand.ts b/clients/client-global-accelerator/commands/DescribeCustomRoutingAcceleratorCommand.ts index 782683db0de6..62da858f6ed9 100644 --- a/clients/client-global-accelerator/commands/DescribeCustomRoutingAcceleratorCommand.ts +++ b/clients/client-global-accelerator/commands/DescribeCustomRoutingAcceleratorCommand.ts @@ -28,6 +28,20 @@ export interface DescribeCustomRoutingAcceleratorCommandOutput /** *

Describe a custom routing accelerator.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { GlobalAcceleratorClient, DescribeCustomRoutingAcceleratorCommand } from "@aws-sdk/client-global-accelerator"; // ES Modules import + * // const { GlobalAcceleratorClient, DescribeCustomRoutingAcceleratorCommand } = require("@aws-sdk/client-global-accelerator"); // CommonJS import + * const client = new GlobalAcceleratorClient(config); + * const command = new DescribeCustomRoutingAcceleratorCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeCustomRoutingAcceleratorCommandInput} for command's `input` shape. + * @see {@link DescribeCustomRoutingAcceleratorCommandOutput} for command's `response` shape. + * @see {@link GlobalAcceleratorClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeCustomRoutingAcceleratorCommand extends $Command< DescribeCustomRoutingAcceleratorCommandInput, diff --git a/clients/client-global-accelerator/commands/DescribeCustomRoutingEndpointGroupCommand.ts b/clients/client-global-accelerator/commands/DescribeCustomRoutingEndpointGroupCommand.ts index b404673e05bd..f76db65f3fe5 100644 --- a/clients/client-global-accelerator/commands/DescribeCustomRoutingEndpointGroupCommand.ts +++ b/clients/client-global-accelerator/commands/DescribeCustomRoutingEndpointGroupCommand.ts @@ -31,6 +31,20 @@ export interface DescribeCustomRoutingEndpointGroupCommandOutput /** *

Describe an endpoint group for a custom routing accelerator.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { GlobalAcceleratorClient, DescribeCustomRoutingEndpointGroupCommand } from "@aws-sdk/client-global-accelerator"; // ES Modules import + * // const { GlobalAcceleratorClient, DescribeCustomRoutingEndpointGroupCommand } = require("@aws-sdk/client-global-accelerator"); // CommonJS import + * const client = new GlobalAcceleratorClient(config); + * const command = new DescribeCustomRoutingEndpointGroupCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeCustomRoutingEndpointGroupCommandInput} for command's `input` shape. + * @see {@link DescribeCustomRoutingEndpointGroupCommandOutput} for command's `response` shape. + * @see {@link GlobalAcceleratorClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeCustomRoutingEndpointGroupCommand extends $Command< DescribeCustomRoutingEndpointGroupCommandInput, diff --git a/clients/client-global-accelerator/commands/DescribeCustomRoutingListenerCommand.ts b/clients/client-global-accelerator/commands/DescribeCustomRoutingListenerCommand.ts index 6390feec416a..cb70e09a4e8f 100644 --- a/clients/client-global-accelerator/commands/DescribeCustomRoutingListenerCommand.ts +++ b/clients/client-global-accelerator/commands/DescribeCustomRoutingListenerCommand.ts @@ -28,6 +28,20 @@ export interface DescribeCustomRoutingListenerCommandOutput /** *

The description of a listener for a custom routing accelerator.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { GlobalAcceleratorClient, DescribeCustomRoutingListenerCommand } from "@aws-sdk/client-global-accelerator"; // ES Modules import + * // const { GlobalAcceleratorClient, DescribeCustomRoutingListenerCommand } = require("@aws-sdk/client-global-accelerator"); // CommonJS import + * const client = new GlobalAcceleratorClient(config); + * const command = new DescribeCustomRoutingListenerCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeCustomRoutingListenerCommandInput} for command's `input` shape. + * @see {@link DescribeCustomRoutingListenerCommandOutput} for command's `response` shape. + * @see {@link GlobalAcceleratorClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeCustomRoutingListenerCommand extends $Command< DescribeCustomRoutingListenerCommandInput, diff --git a/clients/client-global-accelerator/commands/DescribeEndpointGroupCommand.ts b/clients/client-global-accelerator/commands/DescribeEndpointGroupCommand.ts index 6ca56f9eb0c9..8472baaf9d2c 100644 --- a/clients/client-global-accelerator/commands/DescribeEndpointGroupCommand.ts +++ b/clients/client-global-accelerator/commands/DescribeEndpointGroupCommand.ts @@ -26,6 +26,20 @@ export interface DescribeEndpointGroupCommandOutput extends DescribeEndpointGrou /** *

Describe an endpoint group.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { GlobalAcceleratorClient, DescribeEndpointGroupCommand } from "@aws-sdk/client-global-accelerator"; // ES Modules import + * // const { GlobalAcceleratorClient, DescribeEndpointGroupCommand } = require("@aws-sdk/client-global-accelerator"); // CommonJS import + * const client = new GlobalAcceleratorClient(config); + * const command = new DescribeEndpointGroupCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeEndpointGroupCommandInput} for command's `input` shape. + * @see {@link DescribeEndpointGroupCommandOutput} for command's `response` shape. + * @see {@link GlobalAcceleratorClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeEndpointGroupCommand extends $Command< DescribeEndpointGroupCommandInput, diff --git a/clients/client-global-accelerator/commands/DescribeListenerCommand.ts b/clients/client-global-accelerator/commands/DescribeListenerCommand.ts index 07bf91fb55fe..a15e944d7821 100644 --- a/clients/client-global-accelerator/commands/DescribeListenerCommand.ts +++ b/clients/client-global-accelerator/commands/DescribeListenerCommand.ts @@ -26,6 +26,20 @@ export interface DescribeListenerCommandOutput extends DescribeListenerResponse, /** *

Describe a listener.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { GlobalAcceleratorClient, DescribeListenerCommand } from "@aws-sdk/client-global-accelerator"; // ES Modules import + * // const { GlobalAcceleratorClient, DescribeListenerCommand } = require("@aws-sdk/client-global-accelerator"); // CommonJS import + * const client = new GlobalAcceleratorClient(config); + * const command = new DescribeListenerCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeListenerCommandInput} for command's `input` shape. + * @see {@link DescribeListenerCommandOutput} for command's `response` shape. + * @see {@link GlobalAcceleratorClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeListenerCommand extends $Command< DescribeListenerCommandInput, diff --git a/clients/client-global-accelerator/commands/ListAcceleratorsCommand.ts b/clients/client-global-accelerator/commands/ListAcceleratorsCommand.ts index 0a114ce7eb99..bbd666894173 100644 --- a/clients/client-global-accelerator/commands/ListAcceleratorsCommand.ts +++ b/clients/client-global-accelerator/commands/ListAcceleratorsCommand.ts @@ -26,6 +26,20 @@ export interface ListAcceleratorsCommandOutput extends ListAcceleratorsResponse, /** *

List the accelerators for an AWS account.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { GlobalAcceleratorClient, ListAcceleratorsCommand } from "@aws-sdk/client-global-accelerator"; // ES Modules import + * // const { GlobalAcceleratorClient, ListAcceleratorsCommand } = require("@aws-sdk/client-global-accelerator"); // CommonJS import + * const client = new GlobalAcceleratorClient(config); + * const command = new ListAcceleratorsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListAcceleratorsCommandInput} for command's `input` shape. + * @see {@link ListAcceleratorsCommandOutput} for command's `response` shape. + * @see {@link GlobalAcceleratorClientResolvedConfig | config} for command's `input` shape. + * */ export class ListAcceleratorsCommand extends $Command< ListAcceleratorsCommandInput, diff --git a/clients/client-global-accelerator/commands/ListByoipCidrsCommand.ts b/clients/client-global-accelerator/commands/ListByoipCidrsCommand.ts index 011062566697..2cacf5ebc1ef 100644 --- a/clients/client-global-accelerator/commands/ListByoipCidrsCommand.ts +++ b/clients/client-global-accelerator/commands/ListByoipCidrsCommand.ts @@ -27,6 +27,20 @@ export interface ListByoipCidrsCommandOutput extends ListByoipCidrsResponse, __M /** *

Lists the IP address ranges that were specified in calls to ProvisionByoipCidr, including * the current state and a history of state changes.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { GlobalAcceleratorClient, ListByoipCidrsCommand } from "@aws-sdk/client-global-accelerator"; // ES Modules import + * // const { GlobalAcceleratorClient, ListByoipCidrsCommand } = require("@aws-sdk/client-global-accelerator"); // CommonJS import + * const client = new GlobalAcceleratorClient(config); + * const command = new ListByoipCidrsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListByoipCidrsCommandInput} for command's `input` shape. + * @see {@link ListByoipCidrsCommandOutput} for command's `response` shape. + * @see {@link GlobalAcceleratorClientResolvedConfig | config} for command's `input` shape. + * */ export class ListByoipCidrsCommand extends $Command< ListByoipCidrsCommandInput, diff --git a/clients/client-global-accelerator/commands/ListCustomRoutingAcceleratorsCommand.ts b/clients/client-global-accelerator/commands/ListCustomRoutingAcceleratorsCommand.ts index 4cc9e97ebcc3..8b350737edaf 100644 --- a/clients/client-global-accelerator/commands/ListCustomRoutingAcceleratorsCommand.ts +++ b/clients/client-global-accelerator/commands/ListCustomRoutingAcceleratorsCommand.ts @@ -28,6 +28,20 @@ export interface ListCustomRoutingAcceleratorsCommandOutput /** *

List the custom routing accelerators for an AWS account.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { GlobalAcceleratorClient, ListCustomRoutingAcceleratorsCommand } from "@aws-sdk/client-global-accelerator"; // ES Modules import + * // const { GlobalAcceleratorClient, ListCustomRoutingAcceleratorsCommand } = require("@aws-sdk/client-global-accelerator"); // CommonJS import + * const client = new GlobalAcceleratorClient(config); + * const command = new ListCustomRoutingAcceleratorsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListCustomRoutingAcceleratorsCommandInput} for command's `input` shape. + * @see {@link ListCustomRoutingAcceleratorsCommandOutput} for command's `response` shape. + * @see {@link GlobalAcceleratorClientResolvedConfig | config} for command's `input` shape. + * */ export class ListCustomRoutingAcceleratorsCommand extends $Command< ListCustomRoutingAcceleratorsCommandInput, diff --git a/clients/client-global-accelerator/commands/ListCustomRoutingEndpointGroupsCommand.ts b/clients/client-global-accelerator/commands/ListCustomRoutingEndpointGroupsCommand.ts index c7f91ce0589d..66bf191e72ae 100644 --- a/clients/client-global-accelerator/commands/ListCustomRoutingEndpointGroupsCommand.ts +++ b/clients/client-global-accelerator/commands/ListCustomRoutingEndpointGroupsCommand.ts @@ -28,6 +28,20 @@ export interface ListCustomRoutingEndpointGroupsCommandOutput /** *

List the endpoint groups that are associated with a listener for a custom routing accelerator.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { GlobalAcceleratorClient, ListCustomRoutingEndpointGroupsCommand } from "@aws-sdk/client-global-accelerator"; // ES Modules import + * // const { GlobalAcceleratorClient, ListCustomRoutingEndpointGroupsCommand } = require("@aws-sdk/client-global-accelerator"); // CommonJS import + * const client = new GlobalAcceleratorClient(config); + * const command = new ListCustomRoutingEndpointGroupsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListCustomRoutingEndpointGroupsCommandInput} for command's `input` shape. + * @see {@link ListCustomRoutingEndpointGroupsCommandOutput} for command's `response` shape. + * @see {@link GlobalAcceleratorClientResolvedConfig | config} for command's `input` shape. + * */ export class ListCustomRoutingEndpointGroupsCommand extends $Command< ListCustomRoutingEndpointGroupsCommandInput, diff --git a/clients/client-global-accelerator/commands/ListCustomRoutingListenersCommand.ts b/clients/client-global-accelerator/commands/ListCustomRoutingListenersCommand.ts index 7df3fe10089d..d33e147fc952 100644 --- a/clients/client-global-accelerator/commands/ListCustomRoutingListenersCommand.ts +++ b/clients/client-global-accelerator/commands/ListCustomRoutingListenersCommand.ts @@ -26,6 +26,20 @@ export interface ListCustomRoutingListenersCommandOutput extends ListCustomRouti /** *

List the listeners for a custom routing accelerator.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { GlobalAcceleratorClient, ListCustomRoutingListenersCommand } from "@aws-sdk/client-global-accelerator"; // ES Modules import + * // const { GlobalAcceleratorClient, ListCustomRoutingListenersCommand } = require("@aws-sdk/client-global-accelerator"); // CommonJS import + * const client = new GlobalAcceleratorClient(config); + * const command = new ListCustomRoutingListenersCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListCustomRoutingListenersCommandInput} for command's `input` shape. + * @see {@link ListCustomRoutingListenersCommandOutput} for command's `response` shape. + * @see {@link GlobalAcceleratorClientResolvedConfig | config} for command's `input` shape. + * */ export class ListCustomRoutingListenersCommand extends $Command< ListCustomRoutingListenersCommandInput, diff --git a/clients/client-global-accelerator/commands/ListCustomRoutingPortMappingsByDestinationCommand.ts b/clients/client-global-accelerator/commands/ListCustomRoutingPortMappingsByDestinationCommand.ts index 0c9efa3c0933..dfdea0367cb0 100644 --- a/clients/client-global-accelerator/commands/ListCustomRoutingPortMappingsByDestinationCommand.ts +++ b/clients/client-global-accelerator/commands/ListCustomRoutingPortMappingsByDestinationCommand.ts @@ -35,6 +35,20 @@ export interface ListCustomRoutingPortMappingsByDestinationCommandOutput * 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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { GlobalAcceleratorClient, ListCustomRoutingPortMappingsByDestinationCommand } from "@aws-sdk/client-global-accelerator"; // ES Modules import + * // const { GlobalAcceleratorClient, ListCustomRoutingPortMappingsByDestinationCommand } = require("@aws-sdk/client-global-accelerator"); // CommonJS import + * const client = new GlobalAcceleratorClient(config); + * const command = new ListCustomRoutingPortMappingsByDestinationCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListCustomRoutingPortMappingsByDestinationCommandInput} for command's `input` shape. + * @see {@link ListCustomRoutingPortMappingsByDestinationCommandOutput} for command's `response` shape. + * @see {@link GlobalAcceleratorClientResolvedConfig | config} for command's `input` shape. + * */ export class ListCustomRoutingPortMappingsByDestinationCommand extends $Command< ListCustomRoutingPortMappingsByDestinationCommandInput, diff --git a/clients/client-global-accelerator/commands/ListCustomRoutingPortMappingsCommand.ts b/clients/client-global-accelerator/commands/ListCustomRoutingPortMappingsCommand.ts index a1dd2cade6ac..3520aa09f4ed 100644 --- a/clients/client-global-accelerator/commands/ListCustomRoutingPortMappingsCommand.ts +++ b/clients/client-global-accelerator/commands/ListCustomRoutingPortMappingsCommand.ts @@ -36,6 +36,20 @@ export interface ListCustomRoutingPortMappingsCommandOutput * 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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { GlobalAcceleratorClient, ListCustomRoutingPortMappingsCommand } from "@aws-sdk/client-global-accelerator"; // ES Modules import + * // const { GlobalAcceleratorClient, ListCustomRoutingPortMappingsCommand } = require("@aws-sdk/client-global-accelerator"); // CommonJS import + * const client = new GlobalAcceleratorClient(config); + * const command = new ListCustomRoutingPortMappingsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListCustomRoutingPortMappingsCommandInput} for command's `input` shape. + * @see {@link ListCustomRoutingPortMappingsCommandOutput} for command's `response` shape. + * @see {@link GlobalAcceleratorClientResolvedConfig | config} for command's `input` shape. + * */ export class ListCustomRoutingPortMappingsCommand extends $Command< ListCustomRoutingPortMappingsCommandInput, diff --git a/clients/client-global-accelerator/commands/ListEndpointGroupsCommand.ts b/clients/client-global-accelerator/commands/ListEndpointGroupsCommand.ts index 5d94aafc0535..6dcb0ee5e24e 100644 --- a/clients/client-global-accelerator/commands/ListEndpointGroupsCommand.ts +++ b/clients/client-global-accelerator/commands/ListEndpointGroupsCommand.ts @@ -26,6 +26,20 @@ export interface ListEndpointGroupsCommandOutput extends ListEndpointGroupsRespo /** *

List the endpoint groups that are associated with a listener.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { GlobalAcceleratorClient, ListEndpointGroupsCommand } from "@aws-sdk/client-global-accelerator"; // ES Modules import + * // const { GlobalAcceleratorClient, ListEndpointGroupsCommand } = require("@aws-sdk/client-global-accelerator"); // CommonJS import + * const client = new GlobalAcceleratorClient(config); + * const command = new ListEndpointGroupsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListEndpointGroupsCommandInput} for command's `input` shape. + * @see {@link ListEndpointGroupsCommandOutput} for command's `response` shape. + * @see {@link GlobalAcceleratorClientResolvedConfig | config} for command's `input` shape. + * */ export class ListEndpointGroupsCommand extends $Command< ListEndpointGroupsCommandInput, diff --git a/clients/client-global-accelerator/commands/ListListenersCommand.ts b/clients/client-global-accelerator/commands/ListListenersCommand.ts index af45359c6b7b..995ced9b9cd8 100644 --- a/clients/client-global-accelerator/commands/ListListenersCommand.ts +++ b/clients/client-global-accelerator/commands/ListListenersCommand.ts @@ -26,6 +26,20 @@ export interface ListListenersCommandOutput extends ListListenersResponse, __Met /** *

List the listeners for an accelerator.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { GlobalAcceleratorClient, ListListenersCommand } from "@aws-sdk/client-global-accelerator"; // ES Modules import + * // const { GlobalAcceleratorClient, ListListenersCommand } = require("@aws-sdk/client-global-accelerator"); // CommonJS import + * const client = new GlobalAcceleratorClient(config); + * const command = new ListListenersCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListListenersCommandInput} for command's `input` shape. + * @see {@link ListListenersCommandOutput} for command's `response` shape. + * @see {@link GlobalAcceleratorClientResolvedConfig | config} for command's `input` shape. + * */ export class ListListenersCommand extends $Command< ListListenersCommandInput, diff --git a/clients/client-global-accelerator/commands/ListTagsForResourceCommand.ts b/clients/client-global-accelerator/commands/ListTagsForResourceCommand.ts index 448b2274cc25..bfbf127954b3 100644 --- a/clients/client-global-accelerator/commands/ListTagsForResourceCommand.ts +++ b/clients/client-global-accelerator/commands/ListTagsForResourceCommand.ts @@ -28,6 +28,20 @@ export interface ListTagsForResourceCommandOutput extends ListTagsForResourceRes *

List all tags for an accelerator.

*

For more information, see Tagging * in AWS Global Accelerator in the AWS Global Accelerator Developer Guide.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { GlobalAcceleratorClient, ListTagsForResourceCommand } from "@aws-sdk/client-global-accelerator"; // ES Modules import + * // const { GlobalAcceleratorClient, ListTagsForResourceCommand } = require("@aws-sdk/client-global-accelerator"); // CommonJS import + * const client = new GlobalAcceleratorClient(config); + * const command = new ListTagsForResourceCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListTagsForResourceCommandInput} for command's `input` shape. + * @see {@link ListTagsForResourceCommandOutput} for command's `response` shape. + * @see {@link GlobalAcceleratorClientResolvedConfig | config} for command's `input` shape. + * */ export class ListTagsForResourceCommand extends $Command< ListTagsForResourceCommandInput, diff --git a/clients/client-global-accelerator/commands/ProvisionByoipCidrCommand.ts b/clients/client-global-accelerator/commands/ProvisionByoipCidrCommand.ts index b8867454213f..7f82932dc33e 100644 --- a/clients/client-global-accelerator/commands/ProvisionByoipCidrCommand.ts +++ b/clients/client-global-accelerator/commands/ProvisionByoipCidrCommand.ts @@ -31,6 +31,20 @@ export interface ProvisionByoipCidrCommandOutput extends ProvisionByoipCidrRespo * AdvertiseByoipCidr.

*

For more information, see Bring Your Own * IP Addresses (BYOIP) in the AWS Global Accelerator Developer Guide.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { GlobalAcceleratorClient, ProvisionByoipCidrCommand } from "@aws-sdk/client-global-accelerator"; // ES Modules import + * // const { GlobalAcceleratorClient, ProvisionByoipCidrCommand } = require("@aws-sdk/client-global-accelerator"); // CommonJS import + * const client = new GlobalAcceleratorClient(config); + * const command = new ProvisionByoipCidrCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ProvisionByoipCidrCommandInput} for command's `input` shape. + * @see {@link ProvisionByoipCidrCommandOutput} for command's `response` shape. + * @see {@link GlobalAcceleratorClientResolvedConfig | config} for command's `input` shape. + * */ export class ProvisionByoipCidrCommand extends $Command< ProvisionByoipCidrCommandInput, diff --git a/clients/client-global-accelerator/commands/RemoveCustomRoutingEndpointsCommand.ts b/clients/client-global-accelerator/commands/RemoveCustomRoutingEndpointsCommand.ts index 495058545a5e..02664d2edba5 100644 --- a/clients/client-global-accelerator/commands/RemoveCustomRoutingEndpointsCommand.ts +++ b/clients/client-global-accelerator/commands/RemoveCustomRoutingEndpointsCommand.ts @@ -26,6 +26,20 @@ export interface RemoveCustomRoutingEndpointsCommandOutput extends __MetadataBea /** *

Remove endpoints from a custom routing accelerator.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { GlobalAcceleratorClient, RemoveCustomRoutingEndpointsCommand } from "@aws-sdk/client-global-accelerator"; // ES Modules import + * // const { GlobalAcceleratorClient, RemoveCustomRoutingEndpointsCommand } = require("@aws-sdk/client-global-accelerator"); // CommonJS import + * const client = new GlobalAcceleratorClient(config); + * const command = new RemoveCustomRoutingEndpointsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link RemoveCustomRoutingEndpointsCommandInput} for command's `input` shape. + * @see {@link RemoveCustomRoutingEndpointsCommandOutput} for command's `response` shape. + * @see {@link GlobalAcceleratorClientResolvedConfig | config} for command's `input` shape. + * */ export class RemoveCustomRoutingEndpointsCommand extends $Command< RemoveCustomRoutingEndpointsCommandInput, diff --git a/clients/client-global-accelerator/commands/TagResourceCommand.ts b/clients/client-global-accelerator/commands/TagResourceCommand.ts index a36e1e87703e..693ac895ee70 100644 --- a/clients/client-global-accelerator/commands/TagResourceCommand.ts +++ b/clients/client-global-accelerator/commands/TagResourceCommand.ts @@ -28,6 +28,20 @@ export interface TagResourceCommandOutput extends TagResourceResponse, __Metadat *

Add tags to an accelerator resource.

*

For more information, see Tagging * in AWS Global Accelerator in the AWS Global Accelerator Developer Guide.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { GlobalAcceleratorClient, TagResourceCommand } from "@aws-sdk/client-global-accelerator"; // ES Modules import + * // const { GlobalAcceleratorClient, TagResourceCommand } = require("@aws-sdk/client-global-accelerator"); // CommonJS import + * const client = new GlobalAcceleratorClient(config); + * const command = new TagResourceCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link TagResourceCommandInput} for command's `input` shape. + * @see {@link TagResourceCommandOutput} for command's `response` shape. + * @see {@link GlobalAcceleratorClientResolvedConfig | config} for command's `input` shape. + * */ export class TagResourceCommand extends $Command< TagResourceCommandInput, diff --git a/clients/client-global-accelerator/commands/UntagResourceCommand.ts b/clients/client-global-accelerator/commands/UntagResourceCommand.ts index 64628f6fa574..a485a44eef59 100644 --- a/clients/client-global-accelerator/commands/UntagResourceCommand.ts +++ b/clients/client-global-accelerator/commands/UntagResourceCommand.ts @@ -29,6 +29,20 @@ export interface UntagResourceCommandOutput extends UntagResourceResponse, __Met * The operation succeeds even if you attempt to remove tags from an accelerator that was already removed.

*

For more information, see Tagging * in AWS Global Accelerator in the AWS Global Accelerator Developer Guide.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { GlobalAcceleratorClient, UntagResourceCommand } from "@aws-sdk/client-global-accelerator"; // ES Modules import + * // const { GlobalAcceleratorClient, UntagResourceCommand } = require("@aws-sdk/client-global-accelerator"); // CommonJS import + * const client = new GlobalAcceleratorClient(config); + * const command = new UntagResourceCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link UntagResourceCommandInput} for command's `input` shape. + * @see {@link UntagResourceCommandOutput} for command's `response` shape. + * @see {@link GlobalAcceleratorClientResolvedConfig | config} for command's `input` shape. + * */ export class UntagResourceCommand extends $Command< UntagResourceCommandInput, diff --git a/clients/client-global-accelerator/commands/UpdateAcceleratorAttributesCommand.ts b/clients/client-global-accelerator/commands/UpdateAcceleratorAttributesCommand.ts index 166e81a82916..4ec12addbf6a 100644 --- a/clients/client-global-accelerator/commands/UpdateAcceleratorAttributesCommand.ts +++ b/clients/client-global-accelerator/commands/UpdateAcceleratorAttributesCommand.ts @@ -28,6 +28,20 @@ export interface UpdateAcceleratorAttributesCommandOutput /** *

Update the attributes for an accelerator.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { GlobalAcceleratorClient, UpdateAcceleratorAttributesCommand } from "@aws-sdk/client-global-accelerator"; // ES Modules import + * // const { GlobalAcceleratorClient, UpdateAcceleratorAttributesCommand } = require("@aws-sdk/client-global-accelerator"); // CommonJS import + * const client = new GlobalAcceleratorClient(config); + * const command = new UpdateAcceleratorAttributesCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link UpdateAcceleratorAttributesCommandInput} for command's `input` shape. + * @see {@link UpdateAcceleratorAttributesCommandOutput} for command's `response` shape. + * @see {@link GlobalAcceleratorClientResolvedConfig | config} for command's `input` shape. + * */ export class UpdateAcceleratorAttributesCommand extends $Command< UpdateAcceleratorAttributesCommandInput, diff --git a/clients/client-global-accelerator/commands/UpdateAcceleratorCommand.ts b/clients/client-global-accelerator/commands/UpdateAcceleratorCommand.ts index 693b87cc46e0..b94704ad9b60 100644 --- a/clients/client-global-accelerator/commands/UpdateAcceleratorCommand.ts +++ b/clients/client-global-accelerator/commands/UpdateAcceleratorCommand.ts @@ -31,6 +31,20 @@ export interface UpdateAcceleratorCommandOutput extends UpdateAcceleratorRespons *

Global Accelerator is a global service that supports endpoints in multiple AWS Regions but you must specify the * US West (Oregon) Region to create or update accelerators.

* + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { GlobalAcceleratorClient, UpdateAcceleratorCommand } from "@aws-sdk/client-global-accelerator"; // ES Modules import + * // const { GlobalAcceleratorClient, UpdateAcceleratorCommand } = require("@aws-sdk/client-global-accelerator"); // CommonJS import + * const client = new GlobalAcceleratorClient(config); + * const command = new UpdateAcceleratorCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link UpdateAcceleratorCommandInput} for command's `input` shape. + * @see {@link UpdateAcceleratorCommandOutput} for command's `response` shape. + * @see {@link GlobalAcceleratorClientResolvedConfig | config} for command's `input` shape. + * */ export class UpdateAcceleratorCommand extends $Command< UpdateAcceleratorCommandInput, diff --git a/clients/client-global-accelerator/commands/UpdateCustomRoutingAcceleratorAttributesCommand.ts b/clients/client-global-accelerator/commands/UpdateCustomRoutingAcceleratorAttributesCommand.ts index d81918ca618a..4c301d7e3586 100644 --- a/clients/client-global-accelerator/commands/UpdateCustomRoutingAcceleratorAttributesCommand.ts +++ b/clients/client-global-accelerator/commands/UpdateCustomRoutingAcceleratorAttributesCommand.ts @@ -32,6 +32,20 @@ export interface UpdateCustomRoutingAcceleratorAttributesCommandOutput /** *

Update the attributes for a custom routing accelerator.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { GlobalAcceleratorClient, UpdateCustomRoutingAcceleratorAttributesCommand } from "@aws-sdk/client-global-accelerator"; // ES Modules import + * // const { GlobalAcceleratorClient, UpdateCustomRoutingAcceleratorAttributesCommand } = require("@aws-sdk/client-global-accelerator"); // CommonJS import + * const client = new GlobalAcceleratorClient(config); + * const command = new UpdateCustomRoutingAcceleratorAttributesCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link UpdateCustomRoutingAcceleratorAttributesCommandInput} for command's `input` shape. + * @see {@link UpdateCustomRoutingAcceleratorAttributesCommandOutput} for command's `response` shape. + * @see {@link GlobalAcceleratorClientResolvedConfig | config} for command's `input` shape. + * */ export class UpdateCustomRoutingAcceleratorAttributesCommand extends $Command< UpdateCustomRoutingAcceleratorAttributesCommandInput, diff --git a/clients/client-global-accelerator/commands/UpdateCustomRoutingAcceleratorCommand.ts b/clients/client-global-accelerator/commands/UpdateCustomRoutingAcceleratorCommand.ts index 1670cf4c1170..fb975be73531 100644 --- a/clients/client-global-accelerator/commands/UpdateCustomRoutingAcceleratorCommand.ts +++ b/clients/client-global-accelerator/commands/UpdateCustomRoutingAcceleratorCommand.ts @@ -28,6 +28,20 @@ export interface UpdateCustomRoutingAcceleratorCommandOutput /** *

Update a custom routing accelerator.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { GlobalAcceleratorClient, UpdateCustomRoutingAcceleratorCommand } from "@aws-sdk/client-global-accelerator"; // ES Modules import + * // const { GlobalAcceleratorClient, UpdateCustomRoutingAcceleratorCommand } = require("@aws-sdk/client-global-accelerator"); // CommonJS import + * const client = new GlobalAcceleratorClient(config); + * const command = new UpdateCustomRoutingAcceleratorCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link UpdateCustomRoutingAcceleratorCommandInput} for command's `input` shape. + * @see {@link UpdateCustomRoutingAcceleratorCommandOutput} for command's `response` shape. + * @see {@link GlobalAcceleratorClientResolvedConfig | config} for command's `input` shape. + * */ export class UpdateCustomRoutingAcceleratorCommand extends $Command< UpdateCustomRoutingAcceleratorCommandInput, diff --git a/clients/client-global-accelerator/commands/UpdateCustomRoutingListenerCommand.ts b/clients/client-global-accelerator/commands/UpdateCustomRoutingListenerCommand.ts index bd2ee2ab8e1a..b2055d9e97e2 100644 --- a/clients/client-global-accelerator/commands/UpdateCustomRoutingListenerCommand.ts +++ b/clients/client-global-accelerator/commands/UpdateCustomRoutingListenerCommand.ts @@ -28,6 +28,20 @@ export interface UpdateCustomRoutingListenerCommandOutput /** *

Update a listener for a custom routing accelerator.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { GlobalAcceleratorClient, UpdateCustomRoutingListenerCommand } from "@aws-sdk/client-global-accelerator"; // ES Modules import + * // const { GlobalAcceleratorClient, UpdateCustomRoutingListenerCommand } = require("@aws-sdk/client-global-accelerator"); // CommonJS import + * const client = new GlobalAcceleratorClient(config); + * const command = new UpdateCustomRoutingListenerCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link UpdateCustomRoutingListenerCommandInput} for command's `input` shape. + * @see {@link UpdateCustomRoutingListenerCommandOutput} for command's `response` shape. + * @see {@link GlobalAcceleratorClientResolvedConfig | config} for command's `input` shape. + * */ export class UpdateCustomRoutingListenerCommand extends $Command< UpdateCustomRoutingListenerCommandInput, diff --git a/clients/client-global-accelerator/commands/UpdateEndpointGroupCommand.ts b/clients/client-global-accelerator/commands/UpdateEndpointGroupCommand.ts index 2ca13921c001..a8d5e09c5dd0 100644 --- a/clients/client-global-accelerator/commands/UpdateEndpointGroupCommand.ts +++ b/clients/client-global-accelerator/commands/UpdateEndpointGroupCommand.ts @@ -26,6 +26,20 @@ export interface UpdateEndpointGroupCommandOutput extends UpdateEndpointGroupRes /** *

Update an endpoint group. A resource must be valid and active when you add it as an endpoint.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { GlobalAcceleratorClient, UpdateEndpointGroupCommand } from "@aws-sdk/client-global-accelerator"; // ES Modules import + * // const { GlobalAcceleratorClient, UpdateEndpointGroupCommand } = require("@aws-sdk/client-global-accelerator"); // CommonJS import + * const client = new GlobalAcceleratorClient(config); + * const command = new UpdateEndpointGroupCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link UpdateEndpointGroupCommandInput} for command's `input` shape. + * @see {@link UpdateEndpointGroupCommandOutput} for command's `response` shape. + * @see {@link GlobalAcceleratorClientResolvedConfig | config} for command's `input` shape. + * */ export class UpdateEndpointGroupCommand extends $Command< UpdateEndpointGroupCommandInput, diff --git a/clients/client-global-accelerator/commands/UpdateListenerCommand.ts b/clients/client-global-accelerator/commands/UpdateListenerCommand.ts index 76614a85263e..ca7487d296f5 100644 --- a/clients/client-global-accelerator/commands/UpdateListenerCommand.ts +++ b/clients/client-global-accelerator/commands/UpdateListenerCommand.ts @@ -26,6 +26,20 @@ export interface UpdateListenerCommandOutput extends UpdateListenerResponse, __M /** *

Update a listener.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { GlobalAcceleratorClient, UpdateListenerCommand } from "@aws-sdk/client-global-accelerator"; // ES Modules import + * // const { GlobalAcceleratorClient, UpdateListenerCommand } = require("@aws-sdk/client-global-accelerator"); // CommonJS import + * const client = new GlobalAcceleratorClient(config); + * const command = new UpdateListenerCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link UpdateListenerCommandInput} for command's `input` shape. + * @see {@link UpdateListenerCommandOutput} for command's `response` shape. + * @see {@link GlobalAcceleratorClientResolvedConfig | config} for command's `input` shape. + * */ export class UpdateListenerCommand extends $Command< UpdateListenerCommandInput, diff --git a/clients/client-global-accelerator/commands/WithdrawByoipCidrCommand.ts b/clients/client-global-accelerator/commands/WithdrawByoipCidrCommand.ts index eaf8bc014697..7bae74c11968 100644 --- a/clients/client-global-accelerator/commands/WithdrawByoipCidrCommand.ts +++ b/clients/client-global-accelerator/commands/WithdrawByoipCidrCommand.ts @@ -32,6 +32,20 @@ export interface WithdrawByoipCidrCommandOutput extends WithdrawByoipCidrRespons * propagation delays.

*

For more information, see Bring Your Own * IP Addresses (BYOIP) in the AWS Global Accelerator Developer Guide.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { GlobalAcceleratorClient, WithdrawByoipCidrCommand } from "@aws-sdk/client-global-accelerator"; // ES Modules import + * // const { GlobalAcceleratorClient, WithdrawByoipCidrCommand } = require("@aws-sdk/client-global-accelerator"); // CommonJS import + * const client = new GlobalAcceleratorClient(config); + * const command = new WithdrawByoipCidrCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link WithdrawByoipCidrCommandInput} for command's `input` shape. + * @see {@link WithdrawByoipCidrCommandOutput} for command's `response` shape. + * @see {@link GlobalAcceleratorClientResolvedConfig | config} for command's `input` shape. + * */ export class WithdrawByoipCidrCommand extends $Command< WithdrawByoipCidrCommandInput, diff --git a/clients/client-global-accelerator/models/models_0.ts b/clients/client-global-accelerator/models/models_0.ts index b7a64d036c04..e0f24839b90b 100644 --- a/clients/client-global-accelerator/models/models_0.ts +++ b/clients/client-global-accelerator/models/models_0.ts @@ -21,6 +21,9 @@ export interface IpSet { } export namespace IpSet { + /** + * @internal + */ export const filterSensitiveLog = (obj: IpSet): any => ({ ...obj, }); @@ -88,6 +91,9 @@ export interface Accelerator { } export namespace Accelerator { + /** + * @internal + */ export const filterSensitiveLog = (obj: Accelerator): any => ({ ...obj, }); @@ -123,6 +129,9 @@ export interface AcceleratorAttributes { } export namespace AcceleratorAttributes { + /** + * @internal + */ export const filterSensitiveLog = (obj: AcceleratorAttributes): any => ({ ...obj, }); @@ -138,6 +147,9 @@ export interface AcceleratorNotDisabledException extends __SmithyException, $Met } export namespace AcceleratorNotDisabledException { + /** + * @internal + */ export const filterSensitiveLog = (obj: AcceleratorNotDisabledException): any => ({ ...obj, }); @@ -153,6 +165,9 @@ export interface AcceleratorNotFoundException extends __SmithyException, $Metada } export namespace AcceleratorNotFoundException { + /** + * @internal + */ export const filterSensitiveLog = (obj: AcceleratorNotFoundException): any => ({ ...obj, }); @@ -168,6 +183,9 @@ export interface AccessDeniedException extends __SmithyException, $MetadataBeare } export namespace AccessDeniedException { + /** + * @internal + */ export const filterSensitiveLog = (obj: AccessDeniedException): any => ({ ...obj, }); @@ -185,6 +203,9 @@ export interface CustomRoutingEndpointConfiguration { } export namespace CustomRoutingEndpointConfiguration { + /** + * @internal + */ export const filterSensitiveLog = (obj: CustomRoutingEndpointConfiguration): any => ({ ...obj, }); @@ -203,6 +224,9 @@ export interface AddCustomRoutingEndpointsRequest { } export namespace AddCustomRoutingEndpointsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: AddCustomRoutingEndpointsRequest): any => ({ ...obj, }); @@ -221,6 +245,9 @@ export interface CustomRoutingEndpointDescription { } export namespace CustomRoutingEndpointDescription { + /** + * @internal + */ export const filterSensitiveLog = (obj: CustomRoutingEndpointDescription): any => ({ ...obj, }); @@ -239,6 +266,9 @@ export interface AddCustomRoutingEndpointsResponse { } export namespace AddCustomRoutingEndpointsResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: AddCustomRoutingEndpointsResponse): any => ({ ...obj, }); @@ -254,6 +284,9 @@ export interface ConflictException extends __SmithyException, $MetadataBearer { } export namespace ConflictException { + /** + * @internal + */ export const filterSensitiveLog = (obj: ConflictException): any => ({ ...obj, }); @@ -269,6 +302,9 @@ export interface EndpointAlreadyExistsException extends __SmithyException, $Meta } export namespace EndpointAlreadyExistsException { + /** + * @internal + */ export const filterSensitiveLog = (obj: EndpointAlreadyExistsException): any => ({ ...obj, }); @@ -284,6 +320,9 @@ export interface EndpointGroupNotFoundException extends __SmithyException, $Meta } export namespace EndpointGroupNotFoundException { + /** + * @internal + */ export const filterSensitiveLog = (obj: EndpointGroupNotFoundException): any => ({ ...obj, }); @@ -299,6 +338,9 @@ export interface InternalServiceErrorException extends __SmithyException, $Metad } export namespace InternalServiceErrorException { + /** + * @internal + */ export const filterSensitiveLog = (obj: InternalServiceErrorException): any => ({ ...obj, }); @@ -314,6 +356,9 @@ export interface InvalidArgumentException extends __SmithyException, $MetadataBe } export namespace InvalidArgumentException { + /** + * @internal + */ export const filterSensitiveLog = (obj: InvalidArgumentException): any => ({ ...obj, }); @@ -329,6 +374,9 @@ export interface LimitExceededException extends __SmithyException, $MetadataBear } export namespace LimitExceededException { + /** + * @internal + */ export const filterSensitiveLog = (obj: LimitExceededException): any => ({ ...obj, }); @@ -343,6 +391,9 @@ export interface AdvertiseByoipCidrRequest { } export namespace AdvertiseByoipCidrRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: AdvertiseByoipCidrRequest): any => ({ ...obj, }); @@ -368,6 +419,9 @@ export interface ByoipCidrEvent { } export namespace ByoipCidrEvent { + /** + * @internal + */ export const filterSensitiveLog = (obj: ByoipCidrEvent): any => ({ ...obj, }); @@ -478,6 +532,9 @@ export interface ByoipCidr { } export namespace ByoipCidr { + /** + * @internal + */ export const filterSensitiveLog = (obj: ByoipCidr): any => ({ ...obj, }); @@ -491,6 +548,9 @@ export interface AdvertiseByoipCidrResponse { } export namespace AdvertiseByoipCidrResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: AdvertiseByoipCidrResponse): any => ({ ...obj, }); @@ -506,6 +566,9 @@ export interface ByoipCidrNotFoundException extends __SmithyException, $Metadata } export namespace ByoipCidrNotFoundException { + /** + * @internal + */ export const filterSensitiveLog = (obj: ByoipCidrNotFoundException): any => ({ ...obj, }); @@ -522,6 +585,9 @@ export interface IncorrectCidrStateException extends __SmithyException, $Metadat } export namespace IncorrectCidrStateException { + /** + * @internal + */ export const filterSensitiveLog = (obj: IncorrectCidrStateException): any => ({ ...obj, }); @@ -566,6 +632,9 @@ export interface AllowCustomRoutingTrafficRequest { } export namespace AllowCustomRoutingTrafficRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: AllowCustomRoutingTrafficRequest): any => ({ ...obj, }); @@ -582,6 +651,9 @@ export interface AssociatedEndpointGroupFoundException extends __SmithyException } export namespace AssociatedEndpointGroupFoundException { + /** + * @internal + */ export const filterSensitiveLog = (obj: AssociatedEndpointGroupFoundException): any => ({ ...obj, }); @@ -598,6 +670,9 @@ export interface AssociatedListenerFoundException extends __SmithyException, $Me } export namespace AssociatedListenerFoundException { + /** + * @internal + */ export const filterSensitiveLog = (obj: AssociatedListenerFoundException): any => ({ ...obj, }); @@ -622,6 +697,9 @@ export interface CidrAuthorizationContext { } export namespace CidrAuthorizationContext { + /** + * @internal + */ export const filterSensitiveLog = (obj: CidrAuthorizationContext): any => ({ ...obj, }); @@ -645,6 +723,9 @@ export interface Tag { } export namespace Tag { + /** + * @internal + */ export const filterSensitiveLog = (obj: Tag): any => ({ ...obj, }); @@ -697,6 +778,9 @@ export interface CreateAcceleratorRequest { } export namespace CreateAcceleratorRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateAcceleratorRequest): any => ({ ...obj, }); @@ -710,6 +794,9 @@ export interface CreateAcceleratorResponse { } export namespace CreateAcceleratorResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateAcceleratorResponse): any => ({ ...obj, }); @@ -762,6 +849,9 @@ export interface CreateCustomRoutingAcceleratorRequest { } export namespace CreateCustomRoutingAcceleratorRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateCustomRoutingAcceleratorRequest): any => ({ ...obj, }); @@ -827,6 +917,9 @@ export interface CustomRoutingAccelerator { } export namespace CustomRoutingAccelerator { + /** + * @internal + */ export const filterSensitiveLog = (obj: CustomRoutingAccelerator): any => ({ ...obj, }); @@ -840,6 +933,9 @@ export interface CreateCustomRoutingAcceleratorResponse { } export namespace CreateCustomRoutingAcceleratorResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateCustomRoutingAcceleratorResponse): any => ({ ...obj, }); @@ -872,6 +968,9 @@ export interface CustomRoutingDestinationConfiguration { } export namespace CustomRoutingDestinationConfiguration { + /** + * @internal + */ export const filterSensitiveLog = (obj: CustomRoutingDestinationConfiguration): any => ({ ...obj, }); @@ -903,6 +1002,9 @@ export interface CreateCustomRoutingEndpointGroupRequest { } export namespace CreateCustomRoutingEndpointGroupRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateCustomRoutingEndpointGroupRequest): any => ({ ...obj, }); @@ -935,6 +1037,9 @@ export interface CustomRoutingDestinationDescription { } export namespace CustomRoutingDestinationDescription { + /** + * @internal + */ export const filterSensitiveLog = (obj: CustomRoutingDestinationDescription): any => ({ ...obj, }); @@ -969,6 +1074,9 @@ export interface CustomRoutingEndpointGroup { } export namespace CustomRoutingEndpointGroup { + /** + * @internal + */ export const filterSensitiveLog = (obj: CustomRoutingEndpointGroup): any => ({ ...obj, }); @@ -982,6 +1090,9 @@ export interface CreateCustomRoutingEndpointGroupResponse { } export namespace CreateCustomRoutingEndpointGroupResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateCustomRoutingEndpointGroupResponse): any => ({ ...obj, }); @@ -997,6 +1108,9 @@ export interface EndpointGroupAlreadyExistsException extends __SmithyException, } export namespace EndpointGroupAlreadyExistsException { + /** + * @internal + */ export const filterSensitiveLog = (obj: EndpointGroupAlreadyExistsException): any => ({ ...obj, }); @@ -1012,6 +1126,9 @@ export interface InvalidPortRangeException extends __SmithyException, $MetadataB } export namespace InvalidPortRangeException { + /** + * @internal + */ export const filterSensitiveLog = (obj: InvalidPortRangeException): any => ({ ...obj, }); @@ -1027,6 +1144,9 @@ export interface ListenerNotFoundException extends __SmithyException, $MetadataB } export namespace ListenerNotFoundException { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListenerNotFoundException): any => ({ ...obj, }); @@ -1048,6 +1168,9 @@ export interface PortRange { } export namespace PortRange { + /** + * @internal + */ export const filterSensitiveLog = (obj: PortRange): any => ({ ...obj, }); @@ -1074,6 +1197,9 @@ export interface CreateCustomRoutingListenerRequest { } export namespace CreateCustomRoutingListenerRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateCustomRoutingListenerRequest): any => ({ ...obj, }); @@ -1097,6 +1223,9 @@ export interface CustomRoutingListener { } export namespace CustomRoutingListener { + /** + * @internal + */ export const filterSensitiveLog = (obj: CustomRoutingListener): any => ({ ...obj, }); @@ -1110,6 +1239,9 @@ export interface CreateCustomRoutingListenerResponse { } export namespace CreateCustomRoutingListenerResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateCustomRoutingListenerResponse): any => ({ ...obj, }); @@ -1149,6 +1281,9 @@ export interface EndpointConfiguration { } export namespace EndpointConfiguration { + /** + * @internal + */ export const filterSensitiveLog = (obj: EndpointConfiguration): any => ({ ...obj, }); @@ -1183,6 +1318,9 @@ export interface PortOverride { } export namespace PortOverride { + /** + * @internal + */ export const filterSensitiveLog = (obj: PortOverride): any => ({ ...obj, }); @@ -1262,6 +1400,9 @@ export interface CreateEndpointGroupRequest { } export namespace CreateEndpointGroupRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateEndpointGroupRequest): any => ({ ...obj, }); @@ -1313,6 +1454,9 @@ export interface EndpointDescription { } export namespace EndpointDescription { + /** + * @internal + */ export const filterSensitiveLog = (obj: EndpointDescription): any => ({ ...obj, }); @@ -1388,6 +1532,9 @@ export interface EndpointGroup { } export namespace EndpointGroup { + /** + * @internal + */ export const filterSensitiveLog = (obj: EndpointGroup): any => ({ ...obj, }); @@ -1401,6 +1548,9 @@ export interface CreateEndpointGroupResponse { } export namespace CreateEndpointGroupResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateEndpointGroupResponse): any => ({ ...obj, }); @@ -1446,6 +1596,9 @@ export interface CreateListenerRequest { } export namespace CreateListenerRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateListenerRequest): any => ({ ...obj, }); @@ -1488,6 +1641,9 @@ export interface Listener { } export namespace Listener { + /** + * @internal + */ export const filterSensitiveLog = (obj: Listener): any => ({ ...obj, }); @@ -1501,6 +1657,9 @@ export interface CreateListenerResponse { } export namespace CreateListenerResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateListenerResponse): any => ({ ...obj, }); @@ -1536,6 +1695,9 @@ export interface CustomRoutingAcceleratorAttributes { } export namespace CustomRoutingAcceleratorAttributes { + /** + * @internal + */ export const filterSensitiveLog = (obj: CustomRoutingAcceleratorAttributes): any => ({ ...obj, }); @@ -1554,6 +1716,9 @@ export interface DeleteAcceleratorRequest { } export namespace DeleteAcceleratorRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteAcceleratorRequest): any => ({ ...obj, }); @@ -1567,6 +1732,9 @@ export interface DeleteCustomRoutingAcceleratorRequest { } export namespace DeleteCustomRoutingAcceleratorRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteCustomRoutingAcceleratorRequest): any => ({ ...obj, }); @@ -1580,6 +1748,9 @@ export interface DeleteCustomRoutingEndpointGroupRequest { } export namespace DeleteCustomRoutingEndpointGroupRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteCustomRoutingEndpointGroupRequest): any => ({ ...obj, }); @@ -1593,6 +1764,9 @@ export interface DeleteCustomRoutingListenerRequest { } export namespace DeleteCustomRoutingListenerRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteCustomRoutingListenerRequest): any => ({ ...obj, }); @@ -1606,6 +1780,9 @@ export interface DeleteEndpointGroupRequest { } export namespace DeleteEndpointGroupRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteEndpointGroupRequest): any => ({ ...obj, }); @@ -1619,6 +1796,9 @@ export interface DeleteListenerRequest { } export namespace DeleteListenerRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteListenerRequest): any => ({ ...obj, }); @@ -1662,6 +1842,9 @@ export interface DenyCustomRoutingTrafficRequest { } export namespace DenyCustomRoutingTrafficRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DenyCustomRoutingTrafficRequest): any => ({ ...obj, }); @@ -1676,6 +1859,9 @@ export interface DeprovisionByoipCidrRequest { } export namespace DeprovisionByoipCidrRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeprovisionByoipCidrRequest): any => ({ ...obj, }); @@ -1689,6 +1875,9 @@ export interface DeprovisionByoipCidrResponse { } export namespace DeprovisionByoipCidrResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeprovisionByoipCidrResponse): any => ({ ...obj, }); @@ -1702,6 +1891,9 @@ export interface DescribeAcceleratorRequest { } export namespace DescribeAcceleratorRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeAcceleratorRequest): any => ({ ...obj, }); @@ -1715,6 +1907,9 @@ export interface DescribeAcceleratorResponse { } export namespace DescribeAcceleratorResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeAcceleratorResponse): any => ({ ...obj, }); @@ -1728,6 +1923,9 @@ export interface DescribeAcceleratorAttributesRequest { } export namespace DescribeAcceleratorAttributesRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeAcceleratorAttributesRequest): any => ({ ...obj, }); @@ -1741,6 +1939,9 @@ export interface DescribeAcceleratorAttributesResponse { } export namespace DescribeAcceleratorAttributesResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeAcceleratorAttributesResponse): any => ({ ...obj, }); @@ -1754,6 +1955,9 @@ export interface DescribeCustomRoutingAcceleratorRequest { } export namespace DescribeCustomRoutingAcceleratorRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeCustomRoutingAcceleratorRequest): any => ({ ...obj, }); @@ -1767,6 +1971,9 @@ export interface DescribeCustomRoutingAcceleratorResponse { } export namespace DescribeCustomRoutingAcceleratorResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeCustomRoutingAcceleratorResponse): any => ({ ...obj, }); @@ -1780,6 +1987,9 @@ export interface DescribeCustomRoutingAcceleratorAttributesRequest { } export namespace DescribeCustomRoutingAcceleratorAttributesRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeCustomRoutingAcceleratorAttributesRequest): any => ({ ...obj, }); @@ -1793,6 +2003,9 @@ export interface DescribeCustomRoutingAcceleratorAttributesResponse { } export namespace DescribeCustomRoutingAcceleratorAttributesResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeCustomRoutingAcceleratorAttributesResponse): any => ({ ...obj, }); @@ -1806,6 +2019,9 @@ export interface DescribeCustomRoutingEndpointGroupRequest { } export namespace DescribeCustomRoutingEndpointGroupRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeCustomRoutingEndpointGroupRequest): any => ({ ...obj, }); @@ -1819,6 +2035,9 @@ export interface DescribeCustomRoutingEndpointGroupResponse { } export namespace DescribeCustomRoutingEndpointGroupResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeCustomRoutingEndpointGroupResponse): any => ({ ...obj, }); @@ -1832,6 +2051,9 @@ export interface DescribeCustomRoutingListenerRequest { } export namespace DescribeCustomRoutingListenerRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeCustomRoutingListenerRequest): any => ({ ...obj, }); @@ -1845,6 +2067,9 @@ export interface DescribeCustomRoutingListenerResponse { } export namespace DescribeCustomRoutingListenerResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeCustomRoutingListenerResponse): any => ({ ...obj, }); @@ -1858,6 +2083,9 @@ export interface DescribeEndpointGroupRequest { } export namespace DescribeEndpointGroupRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeEndpointGroupRequest): any => ({ ...obj, }); @@ -1871,6 +2099,9 @@ export interface DescribeEndpointGroupResponse { } export namespace DescribeEndpointGroupResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeEndpointGroupResponse): any => ({ ...obj, }); @@ -1884,6 +2115,9 @@ export interface DescribeListenerRequest { } export namespace DescribeListenerRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeListenerRequest): any => ({ ...obj, }); @@ -1897,6 +2131,9 @@ export interface DescribeListenerResponse { } export namespace DescribeListenerResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeListenerResponse): any => ({ ...obj, }); @@ -1918,6 +2155,9 @@ export interface SocketAddress { } export namespace SocketAddress { + /** + * @internal + */ export const filterSensitiveLog = (obj: SocketAddress): any => ({ ...obj, }); @@ -1972,6 +2212,9 @@ export interface DestinationPortMapping { } export namespace DestinationPortMapping { + /** + * @internal + */ export const filterSensitiveLog = (obj: DestinationPortMapping): any => ({ ...obj, }); @@ -1987,6 +2230,9 @@ export interface EndpointNotFoundException extends __SmithyException, $MetadataB } export namespace EndpointNotFoundException { + /** + * @internal + */ export const filterSensitiveLog = (obj: EndpointNotFoundException): any => ({ ...obj, }); @@ -2002,6 +2248,9 @@ export interface InvalidNextTokenException extends __SmithyException, $MetadataB } export namespace InvalidNextTokenException { + /** + * @internal + */ export const filterSensitiveLog = (obj: InvalidNextTokenException): any => ({ ...obj, }); @@ -2020,6 +2269,9 @@ export interface ListAcceleratorsRequest { } export namespace ListAcceleratorsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListAcceleratorsRequest): any => ({ ...obj, }); @@ -2038,6 +2290,9 @@ export interface ListAcceleratorsResponse { } export namespace ListAcceleratorsResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListAcceleratorsResponse): any => ({ ...obj, }); @@ -2057,6 +2312,9 @@ export interface ListByoipCidrsRequest { } export namespace ListByoipCidrsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListByoipCidrsRequest): any => ({ ...obj, }); @@ -2075,6 +2333,9 @@ export interface ListByoipCidrsResponse { } export namespace ListByoipCidrsResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListByoipCidrsResponse): any => ({ ...obj, }); @@ -2093,6 +2354,9 @@ export interface ListCustomRoutingAcceleratorsRequest { } export namespace ListCustomRoutingAcceleratorsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListCustomRoutingAcceleratorsRequest): any => ({ ...obj, }); @@ -2111,6 +2375,9 @@ export interface ListCustomRoutingAcceleratorsResponse { } export namespace ListCustomRoutingAcceleratorsResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListCustomRoutingAcceleratorsResponse): any => ({ ...obj, }); @@ -2134,6 +2401,9 @@ export interface ListCustomRoutingEndpointGroupsRequest { } export namespace ListCustomRoutingEndpointGroupsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListCustomRoutingEndpointGroupsRequest): any => ({ ...obj, }); @@ -2152,6 +2422,9 @@ export interface ListCustomRoutingEndpointGroupsResponse { } export namespace ListCustomRoutingEndpointGroupsResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListCustomRoutingEndpointGroupsResponse): any => ({ ...obj, }); @@ -2175,6 +2448,9 @@ export interface ListCustomRoutingListenersRequest { } export namespace ListCustomRoutingListenersRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListCustomRoutingListenersRequest): any => ({ ...obj, }); @@ -2193,6 +2469,9 @@ export interface ListCustomRoutingListenersResponse { } export namespace ListCustomRoutingListenersResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListCustomRoutingListenersResponse): any => ({ ...obj, }); @@ -2221,6 +2500,9 @@ export interface ListCustomRoutingPortMappingsRequest { } export namespace ListCustomRoutingPortMappingsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListCustomRoutingPortMappingsRequest): any => ({ ...obj, }); @@ -2266,6 +2548,9 @@ export interface PortMapping { } export namespace PortMapping { + /** + * @internal + */ export const filterSensitiveLog = (obj: PortMapping): any => ({ ...obj, }); @@ -2284,6 +2569,9 @@ export interface ListCustomRoutingPortMappingsResponse { } export namespace ListCustomRoutingPortMappingsResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListCustomRoutingPortMappingsResponse): any => ({ ...obj, }); @@ -2313,6 +2601,9 @@ export interface ListCustomRoutingPortMappingsByDestinationRequest { } export namespace ListCustomRoutingPortMappingsByDestinationRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListCustomRoutingPortMappingsByDestinationRequest): any => ({ ...obj, }); @@ -2331,6 +2622,9 @@ export interface ListCustomRoutingPortMappingsByDestinationResponse { } export namespace ListCustomRoutingPortMappingsByDestinationResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListCustomRoutingPortMappingsByDestinationResponse): any => ({ ...obj, }); @@ -2354,6 +2648,9 @@ export interface ListEndpointGroupsRequest { } export namespace ListEndpointGroupsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListEndpointGroupsRequest): any => ({ ...obj, }); @@ -2372,6 +2669,9 @@ export interface ListEndpointGroupsResponse { } export namespace ListEndpointGroupsResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListEndpointGroupsResponse): any => ({ ...obj, }); @@ -2395,6 +2695,9 @@ export interface ListListenersRequest { } export namespace ListListenersRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListListenersRequest): any => ({ ...obj, }); @@ -2413,6 +2716,9 @@ export interface ListListenersResponse { } export namespace ListListenersResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListListenersResponse): any => ({ ...obj, }); @@ -2426,6 +2732,9 @@ export interface ListTagsForResourceRequest { } export namespace ListTagsForResourceRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListTagsForResourceRequest): any => ({ ...obj, }); @@ -2439,6 +2748,9 @@ export interface ListTagsForResourceResponse { } export namespace ListTagsForResourceResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListTagsForResourceResponse): any => ({ ...obj, }); @@ -2461,6 +2773,9 @@ export interface ProvisionByoipCidrRequest { } export namespace ProvisionByoipCidrRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ProvisionByoipCidrRequest): any => ({ ...obj, }); @@ -2474,6 +2789,9 @@ export interface ProvisionByoipCidrResponse { } export namespace ProvisionByoipCidrResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ProvisionByoipCidrResponse): any => ({ ...obj, }); @@ -2493,6 +2811,9 @@ export interface RemoveCustomRoutingEndpointsRequest { } export namespace RemoveCustomRoutingEndpointsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: RemoveCustomRoutingEndpointsRequest): any => ({ ...obj, }); @@ -2511,6 +2832,9 @@ export interface TagResourceRequest { } export namespace TagResourceRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: TagResourceRequest): any => ({ ...obj, }); @@ -2519,6 +2843,9 @@ export namespace TagResourceRequest { export interface TagResourceResponse {} export namespace TagResourceResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: TagResourceResponse): any => ({ ...obj, }); @@ -2537,6 +2864,9 @@ export interface UntagResourceRequest { } export namespace UntagResourceRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: UntagResourceRequest): any => ({ ...obj, }); @@ -2545,6 +2875,9 @@ export namespace UntagResourceRequest { export interface UntagResourceResponse {} export namespace UntagResourceResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: UntagResourceResponse): any => ({ ...obj, }); @@ -2575,6 +2908,9 @@ export interface UpdateAcceleratorRequest { } export namespace UpdateAcceleratorRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateAcceleratorRequest): any => ({ ...obj, }); @@ -2588,6 +2924,9 @@ export interface UpdateAcceleratorResponse { } export namespace UpdateAcceleratorResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateAcceleratorResponse): any => ({ ...obj, }); @@ -2625,6 +2964,9 @@ export interface UpdateAcceleratorAttributesRequest { } export namespace UpdateAcceleratorAttributesRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateAcceleratorAttributesRequest): any => ({ ...obj, }); @@ -2638,6 +2980,9 @@ export interface UpdateAcceleratorAttributesResponse { } export namespace UpdateAcceleratorAttributesResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateAcceleratorAttributesResponse): any => ({ ...obj, }); @@ -2668,6 +3013,9 @@ export interface UpdateCustomRoutingAcceleratorRequest { } export namespace UpdateCustomRoutingAcceleratorRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateCustomRoutingAcceleratorRequest): any => ({ ...obj, }); @@ -2681,6 +3029,9 @@ export interface UpdateCustomRoutingAcceleratorResponse { } export namespace UpdateCustomRoutingAcceleratorResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateCustomRoutingAcceleratorResponse): any => ({ ...obj, }); @@ -2718,6 +3069,9 @@ export interface UpdateCustomRoutingAcceleratorAttributesRequest { } export namespace UpdateCustomRoutingAcceleratorAttributesRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateCustomRoutingAcceleratorAttributesRequest): any => ({ ...obj, }); @@ -2731,6 +3085,9 @@ export interface UpdateCustomRoutingAcceleratorAttributesResponse { } export namespace UpdateCustomRoutingAcceleratorAttributesResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateCustomRoutingAcceleratorAttributesResponse): any => ({ ...obj, }); @@ -2752,6 +3109,9 @@ export interface UpdateCustomRoutingListenerRequest { } export namespace UpdateCustomRoutingListenerRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateCustomRoutingListenerRequest): any => ({ ...obj, }); @@ -2765,6 +3125,9 @@ export interface UpdateCustomRoutingListenerResponse { } export namespace UpdateCustomRoutingListenerResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateCustomRoutingListenerResponse): any => ({ ...obj, }); @@ -2832,6 +3195,9 @@ export interface UpdateEndpointGroupRequest { } export namespace UpdateEndpointGroupRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateEndpointGroupRequest): any => ({ ...obj, }); @@ -2845,6 +3211,9 @@ export interface UpdateEndpointGroupResponse { } export namespace UpdateEndpointGroupResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateEndpointGroupResponse): any => ({ ...obj, }); @@ -2884,6 +3253,9 @@ export interface UpdateListenerRequest { } export namespace UpdateListenerRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateListenerRequest): any => ({ ...obj, }); @@ -2897,6 +3269,9 @@ export interface UpdateListenerResponse { } export namespace UpdateListenerResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateListenerResponse): any => ({ ...obj, }); @@ -2910,6 +3285,9 @@ export interface WithdrawByoipCidrRequest { } export namespace WithdrawByoipCidrRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: WithdrawByoipCidrRequest): any => ({ ...obj, }); @@ -2923,6 +3301,9 @@ export interface WithdrawByoipCidrResponse { } export namespace WithdrawByoipCidrResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: WithdrawByoipCidrResponse): any => ({ ...obj, }); diff --git a/clients/client-glue/commands/BatchCreatePartitionCommand.ts b/clients/client-glue/commands/BatchCreatePartitionCommand.ts index a63592c64ac6..7c23982dfa22 100644 --- a/clients/client-glue/commands/BatchCreatePartitionCommand.ts +++ b/clients/client-glue/commands/BatchCreatePartitionCommand.ts @@ -22,6 +22,20 @@ export interface BatchCreatePartitionCommandOutput extends BatchCreatePartitionR /** *

Creates one or more partitions in a batch operation.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { GlueClient, BatchCreatePartitionCommand } from "@aws-sdk/client-glue"; // ES Modules import + * // const { GlueClient, BatchCreatePartitionCommand } = require("@aws-sdk/client-glue"); // CommonJS import + * const client = new GlueClient(config); + * const command = new BatchCreatePartitionCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link BatchCreatePartitionCommandInput} for command's `input` shape. + * @see {@link BatchCreatePartitionCommandOutput} for command's `response` shape. + * @see {@link GlueClientResolvedConfig | config} for command's `input` shape. + * */ export class BatchCreatePartitionCommand extends $Command< BatchCreatePartitionCommandInput, diff --git a/clients/client-glue/commands/BatchDeleteConnectionCommand.ts b/clients/client-glue/commands/BatchDeleteConnectionCommand.ts index 270ab1d180f7..dd127bd847e6 100644 --- a/clients/client-glue/commands/BatchDeleteConnectionCommand.ts +++ b/clients/client-glue/commands/BatchDeleteConnectionCommand.ts @@ -22,6 +22,20 @@ export interface BatchDeleteConnectionCommandOutput extends BatchDeleteConnectio /** *

Deletes a list of connection definitions from the Data Catalog.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { GlueClient, BatchDeleteConnectionCommand } from "@aws-sdk/client-glue"; // ES Modules import + * // const { GlueClient, BatchDeleteConnectionCommand } = require("@aws-sdk/client-glue"); // CommonJS import + * const client = new GlueClient(config); + * const command = new BatchDeleteConnectionCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link BatchDeleteConnectionCommandInput} for command's `input` shape. + * @see {@link BatchDeleteConnectionCommandOutput} for command's `response` shape. + * @see {@link GlueClientResolvedConfig | config} for command's `input` shape. + * */ export class BatchDeleteConnectionCommand extends $Command< BatchDeleteConnectionCommandInput, diff --git a/clients/client-glue/commands/BatchDeletePartitionCommand.ts b/clients/client-glue/commands/BatchDeletePartitionCommand.ts index f2bc4bd3db9a..9e18f6bd9d1e 100644 --- a/clients/client-glue/commands/BatchDeletePartitionCommand.ts +++ b/clients/client-glue/commands/BatchDeletePartitionCommand.ts @@ -22,6 +22,20 @@ export interface BatchDeletePartitionCommandOutput extends BatchDeletePartitionR /** *

Deletes one or more partitions in a batch operation.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { GlueClient, BatchDeletePartitionCommand } from "@aws-sdk/client-glue"; // ES Modules import + * // const { GlueClient, BatchDeletePartitionCommand } = require("@aws-sdk/client-glue"); // CommonJS import + * const client = new GlueClient(config); + * const command = new BatchDeletePartitionCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link BatchDeletePartitionCommandInput} for command's `input` shape. + * @see {@link BatchDeletePartitionCommandOutput} for command's `response` shape. + * @see {@link GlueClientResolvedConfig | config} for command's `input` shape. + * */ export class BatchDeletePartitionCommand extends $Command< BatchDeletePartitionCommandInput, diff --git a/clients/client-glue/commands/BatchDeleteTableCommand.ts b/clients/client-glue/commands/BatchDeleteTableCommand.ts index 62f52ab55651..7140d1ac8000 100644 --- a/clients/client-glue/commands/BatchDeleteTableCommand.ts +++ b/clients/client-glue/commands/BatchDeleteTableCommand.ts @@ -32,6 +32,20 @@ export interface BatchDeleteTableCommandOutput extends BatchDeleteTableResponse, * BatchDeletePartition, to delete any resources that belong to the * table.

* + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { GlueClient, BatchDeleteTableCommand } from "@aws-sdk/client-glue"; // ES Modules import + * // const { GlueClient, BatchDeleteTableCommand } = require("@aws-sdk/client-glue"); // CommonJS import + * const client = new GlueClient(config); + * const command = new BatchDeleteTableCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link BatchDeleteTableCommandInput} for command's `input` shape. + * @see {@link BatchDeleteTableCommandOutput} for command's `response` shape. + * @see {@link GlueClientResolvedConfig | config} for command's `input` shape. + * */ export class BatchDeleteTableCommand extends $Command< BatchDeleteTableCommandInput, diff --git a/clients/client-glue/commands/BatchDeleteTableVersionCommand.ts b/clients/client-glue/commands/BatchDeleteTableVersionCommand.ts index 59030d5f7d5b..d38c30d9f50a 100644 --- a/clients/client-glue/commands/BatchDeleteTableVersionCommand.ts +++ b/clients/client-glue/commands/BatchDeleteTableVersionCommand.ts @@ -22,6 +22,20 @@ export interface BatchDeleteTableVersionCommandOutput extends BatchDeleteTableVe /** *

Deletes a specified batch of versions of a table.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { GlueClient, BatchDeleteTableVersionCommand } from "@aws-sdk/client-glue"; // ES Modules import + * // const { GlueClient, BatchDeleteTableVersionCommand } = require("@aws-sdk/client-glue"); // CommonJS import + * const client = new GlueClient(config); + * const command = new BatchDeleteTableVersionCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link BatchDeleteTableVersionCommandInput} for command's `input` shape. + * @see {@link BatchDeleteTableVersionCommandOutput} for command's `response` shape. + * @see {@link GlueClientResolvedConfig | config} for command's `input` shape. + * */ export class BatchDeleteTableVersionCommand extends $Command< BatchDeleteTableVersionCommandInput, diff --git a/clients/client-glue/commands/BatchGetCrawlersCommand.ts b/clients/client-glue/commands/BatchGetCrawlersCommand.ts index 81170d009e77..2fdf8ff9f428 100644 --- a/clients/client-glue/commands/BatchGetCrawlersCommand.ts +++ b/clients/client-glue/commands/BatchGetCrawlersCommand.ts @@ -22,6 +22,20 @@ export interface BatchGetCrawlersCommandOutput extends BatchGetCrawlersResponse, /** *

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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { GlueClient, BatchGetCrawlersCommand } from "@aws-sdk/client-glue"; // ES Modules import + * // const { GlueClient, BatchGetCrawlersCommand } = require("@aws-sdk/client-glue"); // CommonJS import + * const client = new GlueClient(config); + * const command = new BatchGetCrawlersCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link BatchGetCrawlersCommandInput} for command's `input` shape. + * @see {@link BatchGetCrawlersCommandOutput} for command's `response` shape. + * @see {@link GlueClientResolvedConfig | config} for command's `input` shape. + * */ export class BatchGetCrawlersCommand extends $Command< BatchGetCrawlersCommandInput, diff --git a/clients/client-glue/commands/BatchGetDevEndpointsCommand.ts b/clients/client-glue/commands/BatchGetDevEndpointsCommand.ts index 5f6697e6e97e..0ac75693782d 100644 --- a/clients/client-glue/commands/BatchGetDevEndpointsCommand.ts +++ b/clients/client-glue/commands/BatchGetDevEndpointsCommand.ts @@ -25,6 +25,20 @@ export interface BatchGetDevEndpointsCommandOutput extends BatchGetDevEndpointsR * 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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { GlueClient, BatchGetDevEndpointsCommand } from "@aws-sdk/client-glue"; // ES Modules import + * // const { GlueClient, BatchGetDevEndpointsCommand } = require("@aws-sdk/client-glue"); // CommonJS import + * const client = new GlueClient(config); + * const command = new BatchGetDevEndpointsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link BatchGetDevEndpointsCommandInput} for command's `input` shape. + * @see {@link BatchGetDevEndpointsCommandOutput} for command's `response` shape. + * @see {@link GlueClientResolvedConfig | config} for command's `input` shape. + * */ export class BatchGetDevEndpointsCommand extends $Command< BatchGetDevEndpointsCommandInput, diff --git a/clients/client-glue/commands/BatchGetJobsCommand.ts b/clients/client-glue/commands/BatchGetJobsCommand.ts index ad71c8998f33..49b85725c7e2 100644 --- a/clients/client-glue/commands/BatchGetJobsCommand.ts +++ b/clients/client-glue/commands/BatchGetJobsCommand.ts @@ -23,6 +23,20 @@ export interface BatchGetJobsCommandOutput extends BatchGetJobsResponse, __Metad /** *

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. *

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { GlueClient, BatchGetJobsCommand } from "@aws-sdk/client-glue"; // ES Modules import + * // const { GlueClient, BatchGetJobsCommand } = require("@aws-sdk/client-glue"); // CommonJS import + * const client = new GlueClient(config); + * const command = new BatchGetJobsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link BatchGetJobsCommandInput} for command's `input` shape. + * @see {@link BatchGetJobsCommandOutput} for command's `response` shape. + * @see {@link GlueClientResolvedConfig | config} for command's `input` shape. + * */ export class BatchGetJobsCommand extends $Command< BatchGetJobsCommandInput, diff --git a/clients/client-glue/commands/BatchGetPartitionCommand.ts b/clients/client-glue/commands/BatchGetPartitionCommand.ts index b4eda9a7fb25..ad099d3b2c27 100644 --- a/clients/client-glue/commands/BatchGetPartitionCommand.ts +++ b/clients/client-glue/commands/BatchGetPartitionCommand.ts @@ -22,6 +22,20 @@ export interface BatchGetPartitionCommandOutput extends BatchGetPartitionRespons /** *

Retrieves partitions in a batch request.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { GlueClient, BatchGetPartitionCommand } from "@aws-sdk/client-glue"; // ES Modules import + * // const { GlueClient, BatchGetPartitionCommand } = require("@aws-sdk/client-glue"); // CommonJS import + * const client = new GlueClient(config); + * const command = new BatchGetPartitionCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link BatchGetPartitionCommandInput} for command's `input` shape. + * @see {@link BatchGetPartitionCommandOutput} for command's `response` shape. + * @see {@link GlueClientResolvedConfig | config} for command's `input` shape. + * */ export class BatchGetPartitionCommand extends $Command< BatchGetPartitionCommandInput, diff --git a/clients/client-glue/commands/BatchGetTriggersCommand.ts b/clients/client-glue/commands/BatchGetTriggersCommand.ts index 567adec6f739..3f3e112654eb 100644 --- a/clients/client-glue/commands/BatchGetTriggersCommand.ts +++ b/clients/client-glue/commands/BatchGetTriggersCommand.ts @@ -22,6 +22,20 @@ export interface BatchGetTriggersCommandOutput extends BatchGetTriggersResponse, /** *

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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { GlueClient, BatchGetTriggersCommand } from "@aws-sdk/client-glue"; // ES Modules import + * // const { GlueClient, BatchGetTriggersCommand } = require("@aws-sdk/client-glue"); // CommonJS import + * const client = new GlueClient(config); + * const command = new BatchGetTriggersCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link BatchGetTriggersCommandInput} for command's `input` shape. + * @see {@link BatchGetTriggersCommandOutput} for command's `response` shape. + * @see {@link GlueClientResolvedConfig | config} for command's `input` shape. + * */ export class BatchGetTriggersCommand extends $Command< BatchGetTriggersCommandInput, diff --git a/clients/client-glue/commands/BatchGetWorkflowsCommand.ts b/clients/client-glue/commands/BatchGetWorkflowsCommand.ts index 839104af0dfd..6040f36a931a 100644 --- a/clients/client-glue/commands/BatchGetWorkflowsCommand.ts +++ b/clients/client-glue/commands/BatchGetWorkflowsCommand.ts @@ -22,6 +22,20 @@ export interface BatchGetWorkflowsCommandOutput extends BatchGetWorkflowsRespons /** *

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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { GlueClient, BatchGetWorkflowsCommand } from "@aws-sdk/client-glue"; // ES Modules import + * // const { GlueClient, BatchGetWorkflowsCommand } = require("@aws-sdk/client-glue"); // CommonJS import + * const client = new GlueClient(config); + * const command = new BatchGetWorkflowsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link BatchGetWorkflowsCommandInput} for command's `input` shape. + * @see {@link BatchGetWorkflowsCommandOutput} for command's `response` shape. + * @see {@link GlueClientResolvedConfig | config} for command's `input` shape. + * */ export class BatchGetWorkflowsCommand extends $Command< BatchGetWorkflowsCommandInput, diff --git a/clients/client-glue/commands/BatchStopJobRunCommand.ts b/clients/client-glue/commands/BatchStopJobRunCommand.ts index f8bf2f6a3cf8..13e9a4f29518 100644 --- a/clients/client-glue/commands/BatchStopJobRunCommand.ts +++ b/clients/client-glue/commands/BatchStopJobRunCommand.ts @@ -22,6 +22,20 @@ export interface BatchStopJobRunCommandOutput extends BatchStopJobRunResponse, _ /** *

Stops one or more job runs for a specified job definition.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { GlueClient, BatchStopJobRunCommand } from "@aws-sdk/client-glue"; // ES Modules import + * // const { GlueClient, BatchStopJobRunCommand } = require("@aws-sdk/client-glue"); // CommonJS import + * const client = new GlueClient(config); + * const command = new BatchStopJobRunCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link BatchStopJobRunCommandInput} for command's `input` shape. + * @see {@link BatchStopJobRunCommandOutput} for command's `response` shape. + * @see {@link GlueClientResolvedConfig | config} for command's `input` shape. + * */ export class BatchStopJobRunCommand extends $Command< BatchStopJobRunCommandInput, diff --git a/clients/client-glue/commands/BatchUpdatePartitionCommand.ts b/clients/client-glue/commands/BatchUpdatePartitionCommand.ts index c7880d6e8ea7..cd8ec8f82d50 100644 --- a/clients/client-glue/commands/BatchUpdatePartitionCommand.ts +++ b/clients/client-glue/commands/BatchUpdatePartitionCommand.ts @@ -22,6 +22,20 @@ export interface BatchUpdatePartitionCommandOutput extends BatchUpdatePartitionR /** *

Updates one or more partitions in a batch operation.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { GlueClient, BatchUpdatePartitionCommand } from "@aws-sdk/client-glue"; // ES Modules import + * // const { GlueClient, BatchUpdatePartitionCommand } = require("@aws-sdk/client-glue"); // CommonJS import + * const client = new GlueClient(config); + * const command = new BatchUpdatePartitionCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link BatchUpdatePartitionCommandInput} for command's `input` shape. + * @see {@link BatchUpdatePartitionCommandOutput} for command's `response` shape. + * @see {@link GlueClientResolvedConfig | config} for command's `input` shape. + * */ export class BatchUpdatePartitionCommand extends $Command< BatchUpdatePartitionCommandInput, diff --git a/clients/client-glue/commands/CancelMLTaskRunCommand.ts b/clients/client-glue/commands/CancelMLTaskRunCommand.ts index a806200afa49..835e63ddda45 100644 --- a/clients/client-glue/commands/CancelMLTaskRunCommand.ts +++ b/clients/client-glue/commands/CancelMLTaskRunCommand.ts @@ -25,6 +25,20 @@ export interface CancelMLTaskRunCommandOutput extends CancelMLTaskRunResponse, _ * 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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { GlueClient, CancelMLTaskRunCommand } from "@aws-sdk/client-glue"; // ES Modules import + * // const { GlueClient, CancelMLTaskRunCommand } = require("@aws-sdk/client-glue"); // CommonJS import + * const client = new GlueClient(config); + * const command = new CancelMLTaskRunCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CancelMLTaskRunCommandInput} for command's `input` shape. + * @see {@link CancelMLTaskRunCommandOutput} for command's `response` shape. + * @see {@link GlueClientResolvedConfig | config} for command's `input` shape. + * */ export class CancelMLTaskRunCommand extends $Command< CancelMLTaskRunCommandInput, diff --git a/clients/client-glue/commands/CheckSchemaVersionValidityCommand.ts b/clients/client-glue/commands/CheckSchemaVersionValidityCommand.ts index 0f52ac2f535b..ca07b8e291d4 100644 --- a/clients/client-glue/commands/CheckSchemaVersionValidityCommand.ts +++ b/clients/client-glue/commands/CheckSchemaVersionValidityCommand.ts @@ -22,6 +22,20 @@ export interface CheckSchemaVersionValidityCommandOutput extends CheckSchemaVers /** *

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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { GlueClient, CheckSchemaVersionValidityCommand } from "@aws-sdk/client-glue"; // ES Modules import + * // const { GlueClient, CheckSchemaVersionValidityCommand } = require("@aws-sdk/client-glue"); // CommonJS import + * const client = new GlueClient(config); + * const command = new CheckSchemaVersionValidityCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CheckSchemaVersionValidityCommandInput} for command's `input` shape. + * @see {@link CheckSchemaVersionValidityCommandOutput} for command's `response` shape. + * @see {@link GlueClientResolvedConfig | config} for command's `input` shape. + * */ export class CheckSchemaVersionValidityCommand extends $Command< CheckSchemaVersionValidityCommandInput, diff --git a/clients/client-glue/commands/CreateClassifierCommand.ts b/clients/client-glue/commands/CreateClassifierCommand.ts index 5474d8f3a5a9..39b1e7d2e553 100644 --- a/clients/client-glue/commands/CreateClassifierCommand.ts +++ b/clients/client-glue/commands/CreateClassifierCommand.ts @@ -24,6 +24,20 @@ export interface CreateClassifierCommandOutput extends CreateClassifierResponse, *

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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { GlueClient, CreateClassifierCommand } from "@aws-sdk/client-glue"; // ES Modules import + * // const { GlueClient, CreateClassifierCommand } = require("@aws-sdk/client-glue"); // CommonJS import + * const client = new GlueClient(config); + * const command = new CreateClassifierCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreateClassifierCommandInput} for command's `input` shape. + * @see {@link CreateClassifierCommandOutput} for command's `response` shape. + * @see {@link GlueClientResolvedConfig | config} for command's `input` shape. + * */ export class CreateClassifierCommand extends $Command< CreateClassifierCommandInput, diff --git a/clients/client-glue/commands/CreateConnectionCommand.ts b/clients/client-glue/commands/CreateConnectionCommand.ts index 6801ee655b57..396d9e5275d9 100644 --- a/clients/client-glue/commands/CreateConnectionCommand.ts +++ b/clients/client-glue/commands/CreateConnectionCommand.ts @@ -22,6 +22,20 @@ export interface CreateConnectionCommandOutput extends CreateConnectionResponse, /** *

Creates a connection definition in the Data Catalog.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { GlueClient, CreateConnectionCommand } from "@aws-sdk/client-glue"; // ES Modules import + * // const { GlueClient, CreateConnectionCommand } = require("@aws-sdk/client-glue"); // CommonJS import + * const client = new GlueClient(config); + * const command = new CreateConnectionCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreateConnectionCommandInput} for command's `input` shape. + * @see {@link CreateConnectionCommandOutput} for command's `response` shape. + * @see {@link GlueClientResolvedConfig | config} for command's `input` shape. + * */ export class CreateConnectionCommand extends $Command< CreateConnectionCommandInput, diff --git a/clients/client-glue/commands/CreateCrawlerCommand.ts b/clients/client-glue/commands/CreateCrawlerCommand.ts index dc2afe507dd2..6917f2a7fbb1 100644 --- a/clients/client-glue/commands/CreateCrawlerCommand.ts +++ b/clients/client-glue/commands/CreateCrawlerCommand.ts @@ -24,6 +24,20 @@ export interface CreateCrawlerCommandOutput extends CreateCrawlerResponse, __Met *

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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { GlueClient, CreateCrawlerCommand } from "@aws-sdk/client-glue"; // ES Modules import + * // const { GlueClient, CreateCrawlerCommand } = require("@aws-sdk/client-glue"); // CommonJS import + * const client = new GlueClient(config); + * const command = new CreateCrawlerCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreateCrawlerCommandInput} for command's `input` shape. + * @see {@link CreateCrawlerCommandOutput} for command's `response` shape. + * @see {@link GlueClientResolvedConfig | config} for command's `input` shape. + * */ export class CreateCrawlerCommand extends $Command< CreateCrawlerCommandInput, diff --git a/clients/client-glue/commands/CreateDatabaseCommand.ts b/clients/client-glue/commands/CreateDatabaseCommand.ts index ccb00ebc2b93..6274b905bd2e 100644 --- a/clients/client-glue/commands/CreateDatabaseCommand.ts +++ b/clients/client-glue/commands/CreateDatabaseCommand.ts @@ -22,6 +22,20 @@ export interface CreateDatabaseCommandOutput extends CreateDatabaseResponse, __M /** *

Creates a new database in a Data Catalog.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { GlueClient, CreateDatabaseCommand } from "@aws-sdk/client-glue"; // ES Modules import + * // const { GlueClient, CreateDatabaseCommand } = require("@aws-sdk/client-glue"); // CommonJS import + * const client = new GlueClient(config); + * const command = new CreateDatabaseCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreateDatabaseCommandInput} for command's `input` shape. + * @see {@link CreateDatabaseCommandOutput} for command's `response` shape. + * @see {@link GlueClientResolvedConfig | config} for command's `input` shape. + * */ export class CreateDatabaseCommand extends $Command< CreateDatabaseCommandInput, diff --git a/clients/client-glue/commands/CreateDevEndpointCommand.ts b/clients/client-glue/commands/CreateDevEndpointCommand.ts index 71cd401a1af0..899590d509b2 100644 --- a/clients/client-glue/commands/CreateDevEndpointCommand.ts +++ b/clients/client-glue/commands/CreateDevEndpointCommand.ts @@ -22,6 +22,20 @@ export interface CreateDevEndpointCommandOutput extends CreateDevEndpointRespons /** *

Creates a new development endpoint.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { GlueClient, CreateDevEndpointCommand } from "@aws-sdk/client-glue"; // ES Modules import + * // const { GlueClient, CreateDevEndpointCommand } = require("@aws-sdk/client-glue"); // CommonJS import + * const client = new GlueClient(config); + * const command = new CreateDevEndpointCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreateDevEndpointCommandInput} for command's `input` shape. + * @see {@link CreateDevEndpointCommandOutput} for command's `response` shape. + * @see {@link GlueClientResolvedConfig | config} for command's `input` shape. + * */ export class CreateDevEndpointCommand extends $Command< CreateDevEndpointCommandInput, diff --git a/clients/client-glue/commands/CreateJobCommand.ts b/clients/client-glue/commands/CreateJobCommand.ts index c696f43c03ce..b3022e7c1824 100644 --- a/clients/client-glue/commands/CreateJobCommand.ts +++ b/clients/client-glue/commands/CreateJobCommand.ts @@ -19,6 +19,20 @@ export interface CreateJobCommandOutput extends CreateJobResponse, __MetadataBea /** *

Creates a new job definition.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { GlueClient, CreateJobCommand } from "@aws-sdk/client-glue"; // ES Modules import + * // const { GlueClient, CreateJobCommand } = require("@aws-sdk/client-glue"); // CommonJS import + * const client = new GlueClient(config); + * const command = new CreateJobCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreateJobCommandInput} for command's `input` shape. + * @see {@link CreateJobCommandOutput} for command's `response` shape. + * @see {@link GlueClientResolvedConfig | config} for command's `input` shape. + * */ export class CreateJobCommand extends $Command< CreateJobCommandInput, diff --git a/clients/client-glue/commands/CreateMLTransformCommand.ts b/clients/client-glue/commands/CreateMLTransformCommand.ts index 32668cf6083e..46400234d962 100644 --- a/clients/client-glue/commands/CreateMLTransformCommand.ts +++ b/clients/client-glue/commands/CreateMLTransformCommand.ts @@ -34,6 +34,20 @@ export interface CreateMLTransformCommandOutput extends CreateMLTransformRespons * transform. These parameters include Role, and optionally, * AllocatedCapacity, Timeout, and MaxRetries. For more * information, see Jobs.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { GlueClient, CreateMLTransformCommand } from "@aws-sdk/client-glue"; // ES Modules import + * // const { GlueClient, CreateMLTransformCommand } = require("@aws-sdk/client-glue"); // CommonJS import + * const client = new GlueClient(config); + * const command = new CreateMLTransformCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreateMLTransformCommandInput} for command's `input` shape. + * @see {@link CreateMLTransformCommandOutput} for command's `response` shape. + * @see {@link GlueClientResolvedConfig | config} for command's `input` shape. + * */ export class CreateMLTransformCommand extends $Command< CreateMLTransformCommandInput, diff --git a/clients/client-glue/commands/CreatePartitionCommand.ts b/clients/client-glue/commands/CreatePartitionCommand.ts index 89759b07f4b1..70cb9d55f555 100644 --- a/clients/client-glue/commands/CreatePartitionCommand.ts +++ b/clients/client-glue/commands/CreatePartitionCommand.ts @@ -22,6 +22,20 @@ export interface CreatePartitionCommandOutput extends CreatePartitionResponse, _ /** *

Creates a new partition.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { GlueClient, CreatePartitionCommand } from "@aws-sdk/client-glue"; // ES Modules import + * // const { GlueClient, CreatePartitionCommand } = require("@aws-sdk/client-glue"); // CommonJS import + * const client = new GlueClient(config); + * const command = new CreatePartitionCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreatePartitionCommandInput} for command's `input` shape. + * @see {@link CreatePartitionCommandOutput} for command's `response` shape. + * @see {@link GlueClientResolvedConfig | config} for command's `input` shape. + * */ export class CreatePartitionCommand extends $Command< CreatePartitionCommandInput, diff --git a/clients/client-glue/commands/CreatePartitionIndexCommand.ts b/clients/client-glue/commands/CreatePartitionIndexCommand.ts index 7341442f281a..bbfba35086b3 100644 --- a/clients/client-glue/commands/CreatePartitionIndexCommand.ts +++ b/clients/client-glue/commands/CreatePartitionIndexCommand.ts @@ -22,6 +22,20 @@ export interface CreatePartitionIndexCommandOutput extends CreatePartitionIndexR /** *

Creates a specified partition index in an existing table.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { GlueClient, CreatePartitionIndexCommand } from "@aws-sdk/client-glue"; // ES Modules import + * // const { GlueClient, CreatePartitionIndexCommand } = require("@aws-sdk/client-glue"); // CommonJS import + * const client = new GlueClient(config); + * const command = new CreatePartitionIndexCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreatePartitionIndexCommandInput} for command's `input` shape. + * @see {@link CreatePartitionIndexCommandOutput} for command's `response` shape. + * @see {@link GlueClientResolvedConfig | config} for command's `input` shape. + * */ export class CreatePartitionIndexCommand extends $Command< CreatePartitionIndexCommandInput, diff --git a/clients/client-glue/commands/CreateRegistryCommand.ts b/clients/client-glue/commands/CreateRegistryCommand.ts index e46b03695afd..87e22ec45e9d 100644 --- a/clients/client-glue/commands/CreateRegistryCommand.ts +++ b/clients/client-glue/commands/CreateRegistryCommand.ts @@ -22,6 +22,20 @@ export interface CreateRegistryCommandOutput extends CreateRegistryResponse, __M /** *

Creates a new registry which may be used to hold a collection of schemas.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { GlueClient, CreateRegistryCommand } from "@aws-sdk/client-glue"; // ES Modules import + * // const { GlueClient, CreateRegistryCommand } = require("@aws-sdk/client-glue"); // CommonJS import + * const client = new GlueClient(config); + * const command = new CreateRegistryCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreateRegistryCommandInput} for command's `input` shape. + * @see {@link CreateRegistryCommandOutput} for command's `response` shape. + * @see {@link GlueClientResolvedConfig | config} for command's `input` shape. + * */ export class CreateRegistryCommand extends $Command< CreateRegistryCommandInput, diff --git a/clients/client-glue/commands/CreateSchemaCommand.ts b/clients/client-glue/commands/CreateSchemaCommand.ts index c55c507260b3..ca6d0f7d1a4b 100644 --- a/clients/client-glue/commands/CreateSchemaCommand.ts +++ b/clients/client-glue/commands/CreateSchemaCommand.ts @@ -24,6 +24,20 @@ export interface CreateSchemaCommandOutput extends CreateSchemaResponse, __Metad *

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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { GlueClient, CreateSchemaCommand } from "@aws-sdk/client-glue"; // ES Modules import + * // const { GlueClient, CreateSchemaCommand } = require("@aws-sdk/client-glue"); // CommonJS import + * const client = new GlueClient(config); + * const command = new CreateSchemaCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreateSchemaCommandInput} for command's `input` shape. + * @see {@link CreateSchemaCommandOutput} for command's `response` shape. + * @see {@link GlueClientResolvedConfig | config} for command's `input` shape. + * */ export class CreateSchemaCommand extends $Command< CreateSchemaCommandInput, diff --git a/clients/client-glue/commands/CreateScriptCommand.ts b/clients/client-glue/commands/CreateScriptCommand.ts index f589a118770c..23fa0ea94cf2 100644 --- a/clients/client-glue/commands/CreateScriptCommand.ts +++ b/clients/client-glue/commands/CreateScriptCommand.ts @@ -22,6 +22,20 @@ export interface CreateScriptCommandOutput extends CreateScriptResponse, __Metad /** *

Transforms a directed acyclic graph (DAG) into code.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { GlueClient, CreateScriptCommand } from "@aws-sdk/client-glue"; // ES Modules import + * // const { GlueClient, CreateScriptCommand } = require("@aws-sdk/client-glue"); // CommonJS import + * const client = new GlueClient(config); + * const command = new CreateScriptCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreateScriptCommandInput} for command's `input` shape. + * @see {@link CreateScriptCommandOutput} for command's `response` shape. + * @see {@link GlueClientResolvedConfig | config} for command's `input` shape. + * */ export class CreateScriptCommand extends $Command< CreateScriptCommandInput, diff --git a/clients/client-glue/commands/CreateSecurityConfigurationCommand.ts b/clients/client-glue/commands/CreateSecurityConfigurationCommand.ts index 67d54364ec97..dfa84bdc8cb8 100644 --- a/clients/client-glue/commands/CreateSecurityConfigurationCommand.ts +++ b/clients/client-glue/commands/CreateSecurityConfigurationCommand.ts @@ -24,6 +24,20 @@ export interface CreateSecurityConfigurationCommandOutput /** *

Creates a new security configuration. A security configuration is a set of security properties that can be used by AWS Glue. You can use a security configuration to encrypt data at rest. For information about using security configurations in AWS Glue, see Encrypting Data Written by Crawlers, Jobs, and Development Endpoints.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { GlueClient, CreateSecurityConfigurationCommand } from "@aws-sdk/client-glue"; // ES Modules import + * // const { GlueClient, CreateSecurityConfigurationCommand } = require("@aws-sdk/client-glue"); // CommonJS import + * const client = new GlueClient(config); + * const command = new CreateSecurityConfigurationCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreateSecurityConfigurationCommandInput} for command's `input` shape. + * @see {@link CreateSecurityConfigurationCommandOutput} for command's `response` shape. + * @see {@link GlueClientResolvedConfig | config} for command's `input` shape. + * */ export class CreateSecurityConfigurationCommand extends $Command< CreateSecurityConfigurationCommandInput, diff --git a/clients/client-glue/commands/CreateTableCommand.ts b/clients/client-glue/commands/CreateTableCommand.ts index 1b93a6bc8e2b..850a55a3b69b 100644 --- a/clients/client-glue/commands/CreateTableCommand.ts +++ b/clients/client-glue/commands/CreateTableCommand.ts @@ -22,6 +22,20 @@ export interface CreateTableCommandOutput extends CreateTableResponse, __Metadat /** *

Creates a new table definition in the Data Catalog.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { GlueClient, CreateTableCommand } from "@aws-sdk/client-glue"; // ES Modules import + * // const { GlueClient, CreateTableCommand } = require("@aws-sdk/client-glue"); // CommonJS import + * const client = new GlueClient(config); + * const command = new CreateTableCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreateTableCommandInput} for command's `input` shape. + * @see {@link CreateTableCommandOutput} for command's `response` shape. + * @see {@link GlueClientResolvedConfig | config} for command's `input` shape. + * */ export class CreateTableCommand extends $Command< CreateTableCommandInput, diff --git a/clients/client-glue/commands/CreateTriggerCommand.ts b/clients/client-glue/commands/CreateTriggerCommand.ts index 7f9f890828f8..d0c3225bad58 100644 --- a/clients/client-glue/commands/CreateTriggerCommand.ts +++ b/clients/client-glue/commands/CreateTriggerCommand.ts @@ -22,6 +22,20 @@ export interface CreateTriggerCommandOutput extends CreateTriggerResponse, __Met /** *

Creates a new trigger.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { GlueClient, CreateTriggerCommand } from "@aws-sdk/client-glue"; // ES Modules import + * // const { GlueClient, CreateTriggerCommand } = require("@aws-sdk/client-glue"); // CommonJS import + * const client = new GlueClient(config); + * const command = new CreateTriggerCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreateTriggerCommandInput} for command's `input` shape. + * @see {@link CreateTriggerCommandOutput} for command's `response` shape. + * @see {@link GlueClientResolvedConfig | config} for command's `input` shape. + * */ export class CreateTriggerCommand extends $Command< CreateTriggerCommandInput, diff --git a/clients/client-glue/commands/CreateUserDefinedFunctionCommand.ts b/clients/client-glue/commands/CreateUserDefinedFunctionCommand.ts index c9fcacea4658..9d65ebcafaec 100644 --- a/clients/client-glue/commands/CreateUserDefinedFunctionCommand.ts +++ b/clients/client-glue/commands/CreateUserDefinedFunctionCommand.ts @@ -22,6 +22,20 @@ export interface CreateUserDefinedFunctionCommandOutput extends CreateUserDefine /** *

Creates a new function definition in the Data Catalog.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { GlueClient, CreateUserDefinedFunctionCommand } from "@aws-sdk/client-glue"; // ES Modules import + * // const { GlueClient, CreateUserDefinedFunctionCommand } = require("@aws-sdk/client-glue"); // CommonJS import + * const client = new GlueClient(config); + * const command = new CreateUserDefinedFunctionCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreateUserDefinedFunctionCommandInput} for command's `input` shape. + * @see {@link CreateUserDefinedFunctionCommandOutput} for command's `response` shape. + * @see {@link GlueClientResolvedConfig | config} for command's `input` shape. + * */ export class CreateUserDefinedFunctionCommand extends $Command< CreateUserDefinedFunctionCommandInput, diff --git a/clients/client-glue/commands/CreateWorkflowCommand.ts b/clients/client-glue/commands/CreateWorkflowCommand.ts index 1fab9c40a309..4d40a4e0af9f 100644 --- a/clients/client-glue/commands/CreateWorkflowCommand.ts +++ b/clients/client-glue/commands/CreateWorkflowCommand.ts @@ -22,6 +22,20 @@ export interface CreateWorkflowCommandOutput extends CreateWorkflowResponse, __M /** *

Creates a new workflow.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { GlueClient, CreateWorkflowCommand } from "@aws-sdk/client-glue"; // ES Modules import + * // const { GlueClient, CreateWorkflowCommand } = require("@aws-sdk/client-glue"); // CommonJS import + * const client = new GlueClient(config); + * const command = new CreateWorkflowCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreateWorkflowCommandInput} for command's `input` shape. + * @see {@link CreateWorkflowCommandOutput} for command's `response` shape. + * @see {@link GlueClientResolvedConfig | config} for command's `input` shape. + * */ export class CreateWorkflowCommand extends $Command< CreateWorkflowCommandInput, diff --git a/clients/client-glue/commands/DeleteClassifierCommand.ts b/clients/client-glue/commands/DeleteClassifierCommand.ts index 0d3f29c6236b..2edeacfa162f 100644 --- a/clients/client-glue/commands/DeleteClassifierCommand.ts +++ b/clients/client-glue/commands/DeleteClassifierCommand.ts @@ -22,6 +22,20 @@ export interface DeleteClassifierCommandOutput extends DeleteClassifierResponse, /** *

Removes a classifier from the Data Catalog.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { GlueClient, DeleteClassifierCommand } from "@aws-sdk/client-glue"; // ES Modules import + * // const { GlueClient, DeleteClassifierCommand } = require("@aws-sdk/client-glue"); // CommonJS import + * const client = new GlueClient(config); + * const command = new DeleteClassifierCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteClassifierCommandInput} for command's `input` shape. + * @see {@link DeleteClassifierCommandOutput} for command's `response` shape. + * @see {@link GlueClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteClassifierCommand extends $Command< DeleteClassifierCommandInput, diff --git a/clients/client-glue/commands/DeleteColumnStatisticsForPartitionCommand.ts b/clients/client-glue/commands/DeleteColumnStatisticsForPartitionCommand.ts index 7b5bd356d783..e0399a3980e2 100644 --- a/clients/client-glue/commands/DeleteColumnStatisticsForPartitionCommand.ts +++ b/clients/client-glue/commands/DeleteColumnStatisticsForPartitionCommand.ts @@ -29,6 +29,20 @@ export interface DeleteColumnStatisticsForPartitionCommandOutput *

Delete the partition column statistics of a column.

* *

The Identity and Access Management (IAM) permission required for this operation is DeletePartition.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { GlueClient, DeleteColumnStatisticsForPartitionCommand } from "@aws-sdk/client-glue"; // ES Modules import + * // const { GlueClient, DeleteColumnStatisticsForPartitionCommand } = require("@aws-sdk/client-glue"); // CommonJS import + * const client = new GlueClient(config); + * const command = new DeleteColumnStatisticsForPartitionCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteColumnStatisticsForPartitionCommandInput} for command's `input` shape. + * @see {@link DeleteColumnStatisticsForPartitionCommandOutput} for command's `response` shape. + * @see {@link GlueClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteColumnStatisticsForPartitionCommand extends $Command< DeleteColumnStatisticsForPartitionCommandInput, diff --git a/clients/client-glue/commands/DeleteColumnStatisticsForTableCommand.ts b/clients/client-glue/commands/DeleteColumnStatisticsForTableCommand.ts index ee722e88ca2a..18a8e00644ae 100644 --- a/clients/client-glue/commands/DeleteColumnStatisticsForTableCommand.ts +++ b/clients/client-glue/commands/DeleteColumnStatisticsForTableCommand.ts @@ -26,6 +26,20 @@ export interface DeleteColumnStatisticsForTableCommandOutput *

Retrieves table statistics of columns.

* *

The Identity and Access Management (IAM) permission required for this operation is DeleteTable.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { GlueClient, DeleteColumnStatisticsForTableCommand } from "@aws-sdk/client-glue"; // ES Modules import + * // const { GlueClient, DeleteColumnStatisticsForTableCommand } = require("@aws-sdk/client-glue"); // CommonJS import + * const client = new GlueClient(config); + * const command = new DeleteColumnStatisticsForTableCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteColumnStatisticsForTableCommandInput} for command's `input` shape. + * @see {@link DeleteColumnStatisticsForTableCommandOutput} for command's `response` shape. + * @see {@link GlueClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteColumnStatisticsForTableCommand extends $Command< DeleteColumnStatisticsForTableCommandInput, diff --git a/clients/client-glue/commands/DeleteConnectionCommand.ts b/clients/client-glue/commands/DeleteConnectionCommand.ts index 05916715355c..8ce77c70d0b4 100644 --- a/clients/client-glue/commands/DeleteConnectionCommand.ts +++ b/clients/client-glue/commands/DeleteConnectionCommand.ts @@ -22,6 +22,20 @@ export interface DeleteConnectionCommandOutput extends DeleteConnectionResponse, /** *

Deletes a connection from the Data Catalog.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { GlueClient, DeleteConnectionCommand } from "@aws-sdk/client-glue"; // ES Modules import + * // const { GlueClient, DeleteConnectionCommand } = require("@aws-sdk/client-glue"); // CommonJS import + * const client = new GlueClient(config); + * const command = new DeleteConnectionCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteConnectionCommandInput} for command's `input` shape. + * @see {@link DeleteConnectionCommandOutput} for command's `response` shape. + * @see {@link GlueClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteConnectionCommand extends $Command< DeleteConnectionCommandInput, diff --git a/clients/client-glue/commands/DeleteCrawlerCommand.ts b/clients/client-glue/commands/DeleteCrawlerCommand.ts index f1f60a481642..d5aec6347593 100644 --- a/clients/client-glue/commands/DeleteCrawlerCommand.ts +++ b/clients/client-glue/commands/DeleteCrawlerCommand.ts @@ -23,6 +23,20 @@ export interface DeleteCrawlerCommandOutput extends DeleteCrawlerResponse, __Met /** *

Removes a specified crawler from the AWS Glue Data Catalog, unless the crawler state is * RUNNING.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { GlueClient, DeleteCrawlerCommand } from "@aws-sdk/client-glue"; // ES Modules import + * // const { GlueClient, DeleteCrawlerCommand } = require("@aws-sdk/client-glue"); // CommonJS import + * const client = new GlueClient(config); + * const command = new DeleteCrawlerCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteCrawlerCommandInput} for command's `input` shape. + * @see {@link DeleteCrawlerCommandOutput} for command's `response` shape. + * @see {@link GlueClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteCrawlerCommand extends $Command< DeleteCrawlerCommandInput, diff --git a/clients/client-glue/commands/DeleteDatabaseCommand.ts b/clients/client-glue/commands/DeleteDatabaseCommand.ts index a21ee8b3e764..37099adf4884 100644 --- a/clients/client-glue/commands/DeleteDatabaseCommand.ts +++ b/clients/client-glue/commands/DeleteDatabaseCommand.ts @@ -34,6 +34,20 @@ export interface DeleteDatabaseCommandOutput extends DeleteDatabaseResponse, __M * DeleteTable or BatchDeleteTable, to delete any resources that * belong to the database.

* + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { GlueClient, DeleteDatabaseCommand } from "@aws-sdk/client-glue"; // ES Modules import + * // const { GlueClient, DeleteDatabaseCommand } = require("@aws-sdk/client-glue"); // CommonJS import + * const client = new GlueClient(config); + * const command = new DeleteDatabaseCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteDatabaseCommandInput} for command's `input` shape. + * @see {@link DeleteDatabaseCommandOutput} for command's `response` shape. + * @see {@link GlueClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteDatabaseCommand extends $Command< DeleteDatabaseCommandInput, diff --git a/clients/client-glue/commands/DeleteDevEndpointCommand.ts b/clients/client-glue/commands/DeleteDevEndpointCommand.ts index 88e4aece3cfc..f81199b8db15 100644 --- a/clients/client-glue/commands/DeleteDevEndpointCommand.ts +++ b/clients/client-glue/commands/DeleteDevEndpointCommand.ts @@ -22,6 +22,20 @@ export interface DeleteDevEndpointCommandOutput extends DeleteDevEndpointRespons /** *

Deletes a specified development endpoint.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { GlueClient, DeleteDevEndpointCommand } from "@aws-sdk/client-glue"; // ES Modules import + * // const { GlueClient, DeleteDevEndpointCommand } = require("@aws-sdk/client-glue"); // CommonJS import + * const client = new GlueClient(config); + * const command = new DeleteDevEndpointCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteDevEndpointCommandInput} for command's `input` shape. + * @see {@link DeleteDevEndpointCommandOutput} for command's `response` shape. + * @see {@link GlueClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteDevEndpointCommand extends $Command< DeleteDevEndpointCommandInput, diff --git a/clients/client-glue/commands/DeleteJobCommand.ts b/clients/client-glue/commands/DeleteJobCommand.ts index da4039d183de..92b9e4a7b1d2 100644 --- a/clients/client-glue/commands/DeleteJobCommand.ts +++ b/clients/client-glue/commands/DeleteJobCommand.ts @@ -20,6 +20,20 @@ export interface DeleteJobCommandOutput extends DeleteJobResponse, __MetadataBea /** *

Deletes a specified job definition. If the job definition * is not found, no exception is thrown.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { GlueClient, DeleteJobCommand } from "@aws-sdk/client-glue"; // ES Modules import + * // const { GlueClient, DeleteJobCommand } = require("@aws-sdk/client-glue"); // CommonJS import + * const client = new GlueClient(config); + * const command = new DeleteJobCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteJobCommandInput} for command's `input` shape. + * @see {@link DeleteJobCommandOutput} for command's `response` shape. + * @see {@link GlueClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteJobCommand extends $Command< DeleteJobCommandInput, diff --git a/clients/client-glue/commands/DeleteMLTransformCommand.ts b/clients/client-glue/commands/DeleteMLTransformCommand.ts index e3a19745d63b..ddebc4d81129 100644 --- a/clients/client-glue/commands/DeleteMLTransformCommand.ts +++ b/clients/client-glue/commands/DeleteMLTransformCommand.ts @@ -27,6 +27,20 @@ export interface DeleteMLTransformCommandOutput extends DeleteMLTransformRespons * by AWS Glue. If you no longer need a transform, you can delete it by calling * DeleteMLTransforms. However, any AWS Glue jobs that still reference the deleted * transform will no longer succeed.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { GlueClient, DeleteMLTransformCommand } from "@aws-sdk/client-glue"; // ES Modules import + * // const { GlueClient, DeleteMLTransformCommand } = require("@aws-sdk/client-glue"); // CommonJS import + * const client = new GlueClient(config); + * const command = new DeleteMLTransformCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteMLTransformCommandInput} for command's `input` shape. + * @see {@link DeleteMLTransformCommandOutput} for command's `response` shape. + * @see {@link GlueClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteMLTransformCommand extends $Command< DeleteMLTransformCommandInput, diff --git a/clients/client-glue/commands/DeletePartitionCommand.ts b/clients/client-glue/commands/DeletePartitionCommand.ts index 372d926bd39c..a177416c63a8 100644 --- a/clients/client-glue/commands/DeletePartitionCommand.ts +++ b/clients/client-glue/commands/DeletePartitionCommand.ts @@ -22,6 +22,20 @@ export interface DeletePartitionCommandOutput extends DeletePartitionResponse, _ /** *

Deletes a specified partition.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { GlueClient, DeletePartitionCommand } from "@aws-sdk/client-glue"; // ES Modules import + * // const { GlueClient, DeletePartitionCommand } = require("@aws-sdk/client-glue"); // CommonJS import + * const client = new GlueClient(config); + * const command = new DeletePartitionCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeletePartitionCommandInput} for command's `input` shape. + * @see {@link DeletePartitionCommandOutput} for command's `response` shape. + * @see {@link GlueClientResolvedConfig | config} for command's `input` shape. + * */ export class DeletePartitionCommand extends $Command< DeletePartitionCommandInput, diff --git a/clients/client-glue/commands/DeletePartitionIndexCommand.ts b/clients/client-glue/commands/DeletePartitionIndexCommand.ts index 1a731ed63641..0499a713fc3d 100644 --- a/clients/client-glue/commands/DeletePartitionIndexCommand.ts +++ b/clients/client-glue/commands/DeletePartitionIndexCommand.ts @@ -22,6 +22,20 @@ export interface DeletePartitionIndexCommandOutput extends DeletePartitionIndexR /** *

Deletes a specified partition index from an existing table.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { GlueClient, DeletePartitionIndexCommand } from "@aws-sdk/client-glue"; // ES Modules import + * // const { GlueClient, DeletePartitionIndexCommand } = require("@aws-sdk/client-glue"); // CommonJS import + * const client = new GlueClient(config); + * const command = new DeletePartitionIndexCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeletePartitionIndexCommandInput} for command's `input` shape. + * @see {@link DeletePartitionIndexCommandOutput} for command's `response` shape. + * @see {@link GlueClientResolvedConfig | config} for command's `input` shape. + * */ export class DeletePartitionIndexCommand extends $Command< DeletePartitionIndexCommandInput, diff --git a/clients/client-glue/commands/DeleteRegistryCommand.ts b/clients/client-glue/commands/DeleteRegistryCommand.ts index d1ba8fe8c3e9..a8dfe534c9f7 100644 --- a/clients/client-glue/commands/DeleteRegistryCommand.ts +++ b/clients/client-glue/commands/DeleteRegistryCommand.ts @@ -22,6 +22,20 @@ export interface DeleteRegistryCommandOutput extends DeleteRegistryResponse, __M /** *

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 disable all online operations for the registry such as the UpdateRegistry, CreateSchema, UpdateSchema, and RegisterSchemaVersion APIs.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { GlueClient, DeleteRegistryCommand } from "@aws-sdk/client-glue"; // ES Modules import + * // const { GlueClient, DeleteRegistryCommand } = require("@aws-sdk/client-glue"); // CommonJS import + * const client = new GlueClient(config); + * const command = new DeleteRegistryCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteRegistryCommandInput} for command's `input` shape. + * @see {@link DeleteRegistryCommandOutput} for command's `response` shape. + * @see {@link GlueClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteRegistryCommand extends $Command< DeleteRegistryCommandInput, diff --git a/clients/client-glue/commands/DeleteResourcePolicyCommand.ts b/clients/client-glue/commands/DeleteResourcePolicyCommand.ts index f49cd7a5b22a..12a6f7c255b0 100644 --- a/clients/client-glue/commands/DeleteResourcePolicyCommand.ts +++ b/clients/client-glue/commands/DeleteResourcePolicyCommand.ts @@ -22,6 +22,20 @@ export interface DeleteResourcePolicyCommandOutput extends DeleteResourcePolicyR /** *

Deletes a specified policy.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { GlueClient, DeleteResourcePolicyCommand } from "@aws-sdk/client-glue"; // ES Modules import + * // const { GlueClient, DeleteResourcePolicyCommand } = require("@aws-sdk/client-glue"); // CommonJS import + * const client = new GlueClient(config); + * const command = new DeleteResourcePolicyCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteResourcePolicyCommandInput} for command's `input` shape. + * @see {@link DeleteResourcePolicyCommandOutput} for command's `response` shape. + * @see {@link GlueClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteResourcePolicyCommand extends $Command< DeleteResourcePolicyCommandInput, diff --git a/clients/client-glue/commands/DeleteSchemaCommand.ts b/clients/client-glue/commands/DeleteSchemaCommand.ts index 764747afaeba..7459d3582e4d 100644 --- a/clients/client-glue/commands/DeleteSchemaCommand.ts +++ b/clients/client-glue/commands/DeleteSchemaCommand.ts @@ -22,6 +22,20 @@ export interface DeleteSchemaCommandOutput extends DeleteSchemaResponse, __Metad /** *

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 disable all online operations for the schema, such as the GetSchemaByDefinition, and RegisterSchemaVersion APIs.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { GlueClient, DeleteSchemaCommand } from "@aws-sdk/client-glue"; // ES Modules import + * // const { GlueClient, DeleteSchemaCommand } = require("@aws-sdk/client-glue"); // CommonJS import + * const client = new GlueClient(config); + * const command = new DeleteSchemaCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteSchemaCommandInput} for command's `input` shape. + * @see {@link DeleteSchemaCommandOutput} for command's `response` shape. + * @see {@link GlueClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteSchemaCommand extends $Command< DeleteSchemaCommandInput, diff --git a/clients/client-glue/commands/DeleteSchemaVersionsCommand.ts b/clients/client-glue/commands/DeleteSchemaVersionsCommand.ts index c2cb5cd41844..571a026ccecd 100644 --- a/clients/client-glue/commands/DeleteSchemaVersionsCommand.ts +++ b/clients/client-glue/commands/DeleteSchemaVersionsCommand.ts @@ -25,6 +25,20 @@ export interface DeleteSchemaVersionsCommandOutput extends DeleteSchemaVersionsR *

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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { GlueClient, DeleteSchemaVersionsCommand } from "@aws-sdk/client-glue"; // ES Modules import + * // const { GlueClient, DeleteSchemaVersionsCommand } = require("@aws-sdk/client-glue"); // CommonJS import + * const client = new GlueClient(config); + * const command = new DeleteSchemaVersionsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteSchemaVersionsCommandInput} for command's `input` shape. + * @see {@link DeleteSchemaVersionsCommandOutput} for command's `response` shape. + * @see {@link GlueClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteSchemaVersionsCommand extends $Command< DeleteSchemaVersionsCommandInput, diff --git a/clients/client-glue/commands/DeleteSecurityConfigurationCommand.ts b/clients/client-glue/commands/DeleteSecurityConfigurationCommand.ts index 2fd622ca5dfe..779f720e1ee9 100644 --- a/clients/client-glue/commands/DeleteSecurityConfigurationCommand.ts +++ b/clients/client-glue/commands/DeleteSecurityConfigurationCommand.ts @@ -24,6 +24,20 @@ export interface DeleteSecurityConfigurationCommandOutput /** *

Deletes a specified security configuration.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { GlueClient, DeleteSecurityConfigurationCommand } from "@aws-sdk/client-glue"; // ES Modules import + * // const { GlueClient, DeleteSecurityConfigurationCommand } = require("@aws-sdk/client-glue"); // CommonJS import + * const client = new GlueClient(config); + * const command = new DeleteSecurityConfigurationCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteSecurityConfigurationCommandInput} for command's `input` shape. + * @see {@link DeleteSecurityConfigurationCommandOutput} for command's `response` shape. + * @see {@link GlueClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteSecurityConfigurationCommand extends $Command< DeleteSecurityConfigurationCommandInput, diff --git a/clients/client-glue/commands/DeleteTableCommand.ts b/clients/client-glue/commands/DeleteTableCommand.ts index 13e02d658bc9..94cc9ce196aa 100644 --- a/clients/client-glue/commands/DeleteTableCommand.ts +++ b/clients/client-glue/commands/DeleteTableCommand.ts @@ -32,6 +32,20 @@ export interface DeleteTableCommandOutput extends DeleteTableResponse, __Metadat * BatchDeletePartition, to delete any resources that belong to the * table.

* + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { GlueClient, DeleteTableCommand } from "@aws-sdk/client-glue"; // ES Modules import + * // const { GlueClient, DeleteTableCommand } = require("@aws-sdk/client-glue"); // CommonJS import + * const client = new GlueClient(config); + * const command = new DeleteTableCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteTableCommandInput} for command's `input` shape. + * @see {@link DeleteTableCommandOutput} for command's `response` shape. + * @see {@link GlueClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteTableCommand extends $Command< DeleteTableCommandInput, diff --git a/clients/client-glue/commands/DeleteTableVersionCommand.ts b/clients/client-glue/commands/DeleteTableVersionCommand.ts index a1850d18b5d1..ce9b5062ae9a 100644 --- a/clients/client-glue/commands/DeleteTableVersionCommand.ts +++ b/clients/client-glue/commands/DeleteTableVersionCommand.ts @@ -22,6 +22,20 @@ export interface DeleteTableVersionCommandOutput extends DeleteTableVersionRespo /** *

Deletes a specified version of a table.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { GlueClient, DeleteTableVersionCommand } from "@aws-sdk/client-glue"; // ES Modules import + * // const { GlueClient, DeleteTableVersionCommand } = require("@aws-sdk/client-glue"); // CommonJS import + * const client = new GlueClient(config); + * const command = new DeleteTableVersionCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteTableVersionCommandInput} for command's `input` shape. + * @see {@link DeleteTableVersionCommandOutput} for command's `response` shape. + * @see {@link GlueClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteTableVersionCommand extends $Command< DeleteTableVersionCommandInput, diff --git a/clients/client-glue/commands/DeleteTriggerCommand.ts b/clients/client-glue/commands/DeleteTriggerCommand.ts index ddbccdbb5d4e..fb12b84ebbc8 100644 --- a/clients/client-glue/commands/DeleteTriggerCommand.ts +++ b/clients/client-glue/commands/DeleteTriggerCommand.ts @@ -23,6 +23,20 @@ export interface DeleteTriggerCommandOutput extends DeleteTriggerResponse, __Met /** *

Deletes a specified trigger. If the trigger is not found, no * exception is thrown.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { GlueClient, DeleteTriggerCommand } from "@aws-sdk/client-glue"; // ES Modules import + * // const { GlueClient, DeleteTriggerCommand } = require("@aws-sdk/client-glue"); // CommonJS import + * const client = new GlueClient(config); + * const command = new DeleteTriggerCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteTriggerCommandInput} for command's `input` shape. + * @see {@link DeleteTriggerCommandOutput} for command's `response` shape. + * @see {@link GlueClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteTriggerCommand extends $Command< DeleteTriggerCommandInput, diff --git a/clients/client-glue/commands/DeleteUserDefinedFunctionCommand.ts b/clients/client-glue/commands/DeleteUserDefinedFunctionCommand.ts index 95af9a11c6d2..e08f430366b9 100644 --- a/clients/client-glue/commands/DeleteUserDefinedFunctionCommand.ts +++ b/clients/client-glue/commands/DeleteUserDefinedFunctionCommand.ts @@ -22,6 +22,20 @@ export interface DeleteUserDefinedFunctionCommandOutput extends DeleteUserDefine /** *

Deletes an existing function definition from the Data Catalog.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { GlueClient, DeleteUserDefinedFunctionCommand } from "@aws-sdk/client-glue"; // ES Modules import + * // const { GlueClient, DeleteUserDefinedFunctionCommand } = require("@aws-sdk/client-glue"); // CommonJS import + * const client = new GlueClient(config); + * const command = new DeleteUserDefinedFunctionCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteUserDefinedFunctionCommandInput} for command's `input` shape. + * @see {@link DeleteUserDefinedFunctionCommandOutput} for command's `response` shape. + * @see {@link GlueClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteUserDefinedFunctionCommand extends $Command< DeleteUserDefinedFunctionCommandInput, diff --git a/clients/client-glue/commands/DeleteWorkflowCommand.ts b/clients/client-glue/commands/DeleteWorkflowCommand.ts index 7e044f9f1822..7ccbdb324610 100644 --- a/clients/client-glue/commands/DeleteWorkflowCommand.ts +++ b/clients/client-glue/commands/DeleteWorkflowCommand.ts @@ -22,6 +22,20 @@ export interface DeleteWorkflowCommandOutput extends DeleteWorkflowResponse, __M /** *

Deletes a workflow.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { GlueClient, DeleteWorkflowCommand } from "@aws-sdk/client-glue"; // ES Modules import + * // const { GlueClient, DeleteWorkflowCommand } = require("@aws-sdk/client-glue"); // CommonJS import + * const client = new GlueClient(config); + * const command = new DeleteWorkflowCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteWorkflowCommandInput} for command's `input` shape. + * @see {@link DeleteWorkflowCommandOutput} for command's `response` shape. + * @see {@link GlueClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteWorkflowCommand extends $Command< DeleteWorkflowCommandInput, diff --git a/clients/client-glue/commands/GetCatalogImportStatusCommand.ts b/clients/client-glue/commands/GetCatalogImportStatusCommand.ts index 9b41e110b377..b4df27f3396c 100644 --- a/clients/client-glue/commands/GetCatalogImportStatusCommand.ts +++ b/clients/client-glue/commands/GetCatalogImportStatusCommand.ts @@ -22,6 +22,20 @@ export interface GetCatalogImportStatusCommandOutput extends GetCatalogImportSta /** *

Retrieves the status of a migration operation.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { GlueClient, GetCatalogImportStatusCommand } from "@aws-sdk/client-glue"; // ES Modules import + * // const { GlueClient, GetCatalogImportStatusCommand } = require("@aws-sdk/client-glue"); // CommonJS import + * const client = new GlueClient(config); + * const command = new GetCatalogImportStatusCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetCatalogImportStatusCommandInput} for command's `input` shape. + * @see {@link GetCatalogImportStatusCommandOutput} for command's `response` shape. + * @see {@link GlueClientResolvedConfig | config} for command's `input` shape. + * */ export class GetCatalogImportStatusCommand extends $Command< GetCatalogImportStatusCommandInput, diff --git a/clients/client-glue/commands/GetClassifierCommand.ts b/clients/client-glue/commands/GetClassifierCommand.ts index e4072370f494..06bdbd38ecd3 100644 --- a/clients/client-glue/commands/GetClassifierCommand.ts +++ b/clients/client-glue/commands/GetClassifierCommand.ts @@ -22,6 +22,20 @@ export interface GetClassifierCommandOutput extends GetClassifierResponse, __Met /** *

Retrieve a classifier by name.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { GlueClient, GetClassifierCommand } from "@aws-sdk/client-glue"; // ES Modules import + * // const { GlueClient, GetClassifierCommand } = require("@aws-sdk/client-glue"); // CommonJS import + * const client = new GlueClient(config); + * const command = new GetClassifierCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetClassifierCommandInput} for command's `input` shape. + * @see {@link GetClassifierCommandOutput} for command's `response` shape. + * @see {@link GlueClientResolvedConfig | config} for command's `input` shape. + * */ export class GetClassifierCommand extends $Command< GetClassifierCommandInput, diff --git a/clients/client-glue/commands/GetClassifiersCommand.ts b/clients/client-glue/commands/GetClassifiersCommand.ts index 8ad43ef7c8fe..776a71903b1b 100644 --- a/clients/client-glue/commands/GetClassifiersCommand.ts +++ b/clients/client-glue/commands/GetClassifiersCommand.ts @@ -22,6 +22,20 @@ export interface GetClassifiersCommandOutput extends GetClassifiersResponse, __M /** *

Lists all classifier objects in the Data Catalog.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { GlueClient, GetClassifiersCommand } from "@aws-sdk/client-glue"; // ES Modules import + * // const { GlueClient, GetClassifiersCommand } = require("@aws-sdk/client-glue"); // CommonJS import + * const client = new GlueClient(config); + * const command = new GetClassifiersCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetClassifiersCommandInput} for command's `input` shape. + * @see {@link GetClassifiersCommandOutput} for command's `response` shape. + * @see {@link GlueClientResolvedConfig | config} for command's `input` shape. + * */ export class GetClassifiersCommand extends $Command< GetClassifiersCommandInput, diff --git a/clients/client-glue/commands/GetColumnStatisticsForPartitionCommand.ts b/clients/client-glue/commands/GetColumnStatisticsForPartitionCommand.ts index 4223379ec2bd..0cad0d9eb063 100644 --- a/clients/client-glue/commands/GetColumnStatisticsForPartitionCommand.ts +++ b/clients/client-glue/commands/GetColumnStatisticsForPartitionCommand.ts @@ -26,6 +26,20 @@ export interface GetColumnStatisticsForPartitionCommandOutput *

Retrieves partition statistics of columns.

* *

The Identity and Access Management (IAM) permission required for this operation is GetPartition.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { GlueClient, GetColumnStatisticsForPartitionCommand } from "@aws-sdk/client-glue"; // ES Modules import + * // const { GlueClient, GetColumnStatisticsForPartitionCommand } = require("@aws-sdk/client-glue"); // CommonJS import + * const client = new GlueClient(config); + * const command = new GetColumnStatisticsForPartitionCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetColumnStatisticsForPartitionCommandInput} for command's `input` shape. + * @see {@link GetColumnStatisticsForPartitionCommandOutput} for command's `response` shape. + * @see {@link GlueClientResolvedConfig | config} for command's `input` shape. + * */ export class GetColumnStatisticsForPartitionCommand extends $Command< GetColumnStatisticsForPartitionCommandInput, diff --git a/clients/client-glue/commands/GetColumnStatisticsForTableCommand.ts b/clients/client-glue/commands/GetColumnStatisticsForTableCommand.ts index 989e4f4a7cdd..1ac8b8e96c87 100644 --- a/clients/client-glue/commands/GetColumnStatisticsForTableCommand.ts +++ b/clients/client-glue/commands/GetColumnStatisticsForTableCommand.ts @@ -26,6 +26,20 @@ export interface GetColumnStatisticsForTableCommandOutput *

Retrieves table statistics of columns.

* *

The Identity and Access Management (IAM) permission required for this operation is GetTable.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { GlueClient, GetColumnStatisticsForTableCommand } from "@aws-sdk/client-glue"; // ES Modules import + * // const { GlueClient, GetColumnStatisticsForTableCommand } = require("@aws-sdk/client-glue"); // CommonJS import + * const client = new GlueClient(config); + * const command = new GetColumnStatisticsForTableCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetColumnStatisticsForTableCommandInput} for command's `input` shape. + * @see {@link GetColumnStatisticsForTableCommandOutput} for command's `response` shape. + * @see {@link GlueClientResolvedConfig | config} for command's `input` shape. + * */ export class GetColumnStatisticsForTableCommand extends $Command< GetColumnStatisticsForTableCommandInput, diff --git a/clients/client-glue/commands/GetConnectionCommand.ts b/clients/client-glue/commands/GetConnectionCommand.ts index 025e55d83efd..b9512a142b19 100644 --- a/clients/client-glue/commands/GetConnectionCommand.ts +++ b/clients/client-glue/commands/GetConnectionCommand.ts @@ -22,6 +22,20 @@ export interface GetConnectionCommandOutput extends GetConnectionResponse, __Met /** *

Retrieves a connection definition from the Data Catalog.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { GlueClient, GetConnectionCommand } from "@aws-sdk/client-glue"; // ES Modules import + * // const { GlueClient, GetConnectionCommand } = require("@aws-sdk/client-glue"); // CommonJS import + * const client = new GlueClient(config); + * const command = new GetConnectionCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetConnectionCommandInput} for command's `input` shape. + * @see {@link GetConnectionCommandOutput} for command's `response` shape. + * @see {@link GlueClientResolvedConfig | config} for command's `input` shape. + * */ export class GetConnectionCommand extends $Command< GetConnectionCommandInput, diff --git a/clients/client-glue/commands/GetConnectionsCommand.ts b/clients/client-glue/commands/GetConnectionsCommand.ts index f128eece2658..28f4835f5220 100644 --- a/clients/client-glue/commands/GetConnectionsCommand.ts +++ b/clients/client-glue/commands/GetConnectionsCommand.ts @@ -22,6 +22,20 @@ export interface GetConnectionsCommandOutput extends GetConnectionsResponse, __M /** *

Retrieves a list of connection definitions from the Data Catalog.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { GlueClient, GetConnectionsCommand } from "@aws-sdk/client-glue"; // ES Modules import + * // const { GlueClient, GetConnectionsCommand } = require("@aws-sdk/client-glue"); // CommonJS import + * const client = new GlueClient(config); + * const command = new GetConnectionsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetConnectionsCommandInput} for command's `input` shape. + * @see {@link GetConnectionsCommandOutput} for command's `response` shape. + * @see {@link GlueClientResolvedConfig | config} for command's `input` shape. + * */ export class GetConnectionsCommand extends $Command< GetConnectionsCommandInput, diff --git a/clients/client-glue/commands/GetCrawlerCommand.ts b/clients/client-glue/commands/GetCrawlerCommand.ts index f2098c7685d3..49c506397264 100644 --- a/clients/client-glue/commands/GetCrawlerCommand.ts +++ b/clients/client-glue/commands/GetCrawlerCommand.ts @@ -22,6 +22,20 @@ export interface GetCrawlerCommandOutput extends GetCrawlerResponse, __MetadataB /** *

Retrieves metadata for a specified crawler.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { GlueClient, GetCrawlerCommand } from "@aws-sdk/client-glue"; // ES Modules import + * // const { GlueClient, GetCrawlerCommand } = require("@aws-sdk/client-glue"); // CommonJS import + * const client = new GlueClient(config); + * const command = new GetCrawlerCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetCrawlerCommandInput} for command's `input` shape. + * @see {@link GetCrawlerCommandOutput} for command's `response` shape. + * @see {@link GlueClientResolvedConfig | config} for command's `input` shape. + * */ export class GetCrawlerCommand extends $Command< GetCrawlerCommandInput, diff --git a/clients/client-glue/commands/GetCrawlerMetricsCommand.ts b/clients/client-glue/commands/GetCrawlerMetricsCommand.ts index b70c066a95c0..c1d15f974328 100644 --- a/clients/client-glue/commands/GetCrawlerMetricsCommand.ts +++ b/clients/client-glue/commands/GetCrawlerMetricsCommand.ts @@ -22,6 +22,20 @@ export interface GetCrawlerMetricsCommandOutput extends GetCrawlerMetricsRespons /** *

Retrieves metrics about specified crawlers.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { GlueClient, GetCrawlerMetricsCommand } from "@aws-sdk/client-glue"; // ES Modules import + * // const { GlueClient, GetCrawlerMetricsCommand } = require("@aws-sdk/client-glue"); // CommonJS import + * const client = new GlueClient(config); + * const command = new GetCrawlerMetricsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetCrawlerMetricsCommandInput} for command's `input` shape. + * @see {@link GetCrawlerMetricsCommandOutput} for command's `response` shape. + * @see {@link GlueClientResolvedConfig | config} for command's `input` shape. + * */ export class GetCrawlerMetricsCommand extends $Command< GetCrawlerMetricsCommandInput, diff --git a/clients/client-glue/commands/GetCrawlersCommand.ts b/clients/client-glue/commands/GetCrawlersCommand.ts index f42e3ca4b3a9..26e9b2ac220a 100644 --- a/clients/client-glue/commands/GetCrawlersCommand.ts +++ b/clients/client-glue/commands/GetCrawlersCommand.ts @@ -23,6 +23,20 @@ export interface GetCrawlersCommandOutput extends GetCrawlersResponse, __Metadat /** *

Retrieves metadata for all crawlers defined in the customer * account.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { GlueClient, GetCrawlersCommand } from "@aws-sdk/client-glue"; // ES Modules import + * // const { GlueClient, GetCrawlersCommand } = require("@aws-sdk/client-glue"); // CommonJS import + * const client = new GlueClient(config); + * const command = new GetCrawlersCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetCrawlersCommandInput} for command's `input` shape. + * @see {@link GetCrawlersCommandOutput} for command's `response` shape. + * @see {@link GlueClientResolvedConfig | config} for command's `input` shape. + * */ export class GetCrawlersCommand extends $Command< GetCrawlersCommandInput, diff --git a/clients/client-glue/commands/GetDataCatalogEncryptionSettingsCommand.ts b/clients/client-glue/commands/GetDataCatalogEncryptionSettingsCommand.ts index 71425c7d1b88..d10fb5fef51f 100644 --- a/clients/client-glue/commands/GetDataCatalogEncryptionSettingsCommand.ts +++ b/clients/client-glue/commands/GetDataCatalogEncryptionSettingsCommand.ts @@ -24,6 +24,20 @@ export interface GetDataCatalogEncryptionSettingsCommandOutput /** *

Retrieves the security configuration for a specified catalog.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { GlueClient, GetDataCatalogEncryptionSettingsCommand } from "@aws-sdk/client-glue"; // ES Modules import + * // const { GlueClient, GetDataCatalogEncryptionSettingsCommand } = require("@aws-sdk/client-glue"); // CommonJS import + * const client = new GlueClient(config); + * const command = new GetDataCatalogEncryptionSettingsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetDataCatalogEncryptionSettingsCommandInput} for command's `input` shape. + * @see {@link GetDataCatalogEncryptionSettingsCommandOutput} for command's `response` shape. + * @see {@link GlueClientResolvedConfig | config} for command's `input` shape. + * */ export class GetDataCatalogEncryptionSettingsCommand extends $Command< GetDataCatalogEncryptionSettingsCommandInput, diff --git a/clients/client-glue/commands/GetDatabaseCommand.ts b/clients/client-glue/commands/GetDatabaseCommand.ts index 593ef856268b..cb5684d057c7 100644 --- a/clients/client-glue/commands/GetDatabaseCommand.ts +++ b/clients/client-glue/commands/GetDatabaseCommand.ts @@ -22,6 +22,20 @@ export interface GetDatabaseCommandOutput extends GetDatabaseResponse, __Metadat /** *

Retrieves the definition of a specified database.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { GlueClient, GetDatabaseCommand } from "@aws-sdk/client-glue"; // ES Modules import + * // const { GlueClient, GetDatabaseCommand } = require("@aws-sdk/client-glue"); // CommonJS import + * const client = new GlueClient(config); + * const command = new GetDatabaseCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetDatabaseCommandInput} for command's `input` shape. + * @see {@link GetDatabaseCommandOutput} for command's `response` shape. + * @see {@link GlueClientResolvedConfig | config} for command's `input` shape. + * */ export class GetDatabaseCommand extends $Command< GetDatabaseCommandInput, diff --git a/clients/client-glue/commands/GetDatabasesCommand.ts b/clients/client-glue/commands/GetDatabasesCommand.ts index 89d6460937bb..0433a5c6a628 100644 --- a/clients/client-glue/commands/GetDatabasesCommand.ts +++ b/clients/client-glue/commands/GetDatabasesCommand.ts @@ -22,6 +22,20 @@ export interface GetDatabasesCommandOutput extends GetDatabasesResponse, __Metad /** *

Retrieves all databases defined in a given Data Catalog.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { GlueClient, GetDatabasesCommand } from "@aws-sdk/client-glue"; // ES Modules import + * // const { GlueClient, GetDatabasesCommand } = require("@aws-sdk/client-glue"); // CommonJS import + * const client = new GlueClient(config); + * const command = new GetDatabasesCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetDatabasesCommandInput} for command's `input` shape. + * @see {@link GetDatabasesCommandOutput} for command's `response` shape. + * @see {@link GlueClientResolvedConfig | config} for command's `input` shape. + * */ export class GetDatabasesCommand extends $Command< GetDatabasesCommandInput, diff --git a/clients/client-glue/commands/GetDataflowGraphCommand.ts b/clients/client-glue/commands/GetDataflowGraphCommand.ts index 7f0fea9b6303..8003cae79ff4 100644 --- a/clients/client-glue/commands/GetDataflowGraphCommand.ts +++ b/clients/client-glue/commands/GetDataflowGraphCommand.ts @@ -22,6 +22,20 @@ export interface GetDataflowGraphCommandOutput extends GetDataflowGraphResponse, /** *

Transforms a Python script into a directed acyclic graph (DAG).

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { GlueClient, GetDataflowGraphCommand } from "@aws-sdk/client-glue"; // ES Modules import + * // const { GlueClient, GetDataflowGraphCommand } = require("@aws-sdk/client-glue"); // CommonJS import + * const client = new GlueClient(config); + * const command = new GetDataflowGraphCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetDataflowGraphCommandInput} for command's `input` shape. + * @see {@link GetDataflowGraphCommandOutput} for command's `response` shape. + * @see {@link GlueClientResolvedConfig | config} for command's `input` shape. + * */ export class GetDataflowGraphCommand extends $Command< GetDataflowGraphCommandInput, diff --git a/clients/client-glue/commands/GetDevEndpointCommand.ts b/clients/client-glue/commands/GetDevEndpointCommand.ts index c2753897dea6..669d9065c0f4 100644 --- a/clients/client-glue/commands/GetDevEndpointCommand.ts +++ b/clients/client-glue/commands/GetDevEndpointCommand.ts @@ -27,6 +27,20 @@ export interface GetDevEndpointCommandOutput extends GetDevEndpointResponse, __M * a private IP address, and the public IP address field is not populated. When you create a * non-VPC development endpoint, AWS Glue returns only a public IP address.

* + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { GlueClient, GetDevEndpointCommand } from "@aws-sdk/client-glue"; // ES Modules import + * // const { GlueClient, GetDevEndpointCommand } = require("@aws-sdk/client-glue"); // CommonJS import + * const client = new GlueClient(config); + * const command = new GetDevEndpointCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetDevEndpointCommandInput} for command's `input` shape. + * @see {@link GetDevEndpointCommandOutput} for command's `response` shape. + * @see {@link GlueClientResolvedConfig | config} for command's `input` shape. + * */ export class GetDevEndpointCommand extends $Command< GetDevEndpointCommandInput, diff --git a/clients/client-glue/commands/GetDevEndpointsCommand.ts b/clients/client-glue/commands/GetDevEndpointsCommand.ts index 82800474fbc5..c07f5395fb40 100644 --- a/clients/client-glue/commands/GetDevEndpointsCommand.ts +++ b/clients/client-glue/commands/GetDevEndpointsCommand.ts @@ -27,6 +27,20 @@ export interface GetDevEndpointsCommandOutput extends GetDevEndpointsResponse, _ * and the public IP address field is not populated. When you create a non-VPC development * endpoint, AWS Glue returns only a public IP address.

* + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { GlueClient, GetDevEndpointsCommand } from "@aws-sdk/client-glue"; // ES Modules import + * // const { GlueClient, GetDevEndpointsCommand } = require("@aws-sdk/client-glue"); // CommonJS import + * const client = new GlueClient(config); + * const command = new GetDevEndpointsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetDevEndpointsCommandInput} for command's `input` shape. + * @see {@link GetDevEndpointsCommandOutput} for command's `response` shape. + * @see {@link GlueClientResolvedConfig | config} for command's `input` shape. + * */ export class GetDevEndpointsCommand extends $Command< GetDevEndpointsCommandInput, diff --git a/clients/client-glue/commands/GetJobBookmarkCommand.ts b/clients/client-glue/commands/GetJobBookmarkCommand.ts index c8a9c60c2e01..886fc16e1591 100644 --- a/clients/client-glue/commands/GetJobBookmarkCommand.ts +++ b/clients/client-glue/commands/GetJobBookmarkCommand.ts @@ -23,6 +23,20 @@ export interface GetJobBookmarkCommandOutput extends GetJobBookmarkResponse, __M /** *

Returns information on a job bookmark entry.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { GlueClient, GetJobBookmarkCommand } from "@aws-sdk/client-glue"; // ES Modules import + * // const { GlueClient, GetJobBookmarkCommand } = require("@aws-sdk/client-glue"); // CommonJS import + * const client = new GlueClient(config); + * const command = new GetJobBookmarkCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetJobBookmarkCommandInput} for command's `input` shape. + * @see {@link GetJobBookmarkCommandOutput} for command's `response` shape. + * @see {@link GlueClientResolvedConfig | config} for command's `input` shape. + * */ export class GetJobBookmarkCommand extends $Command< GetJobBookmarkCommandInput, diff --git a/clients/client-glue/commands/GetJobCommand.ts b/clients/client-glue/commands/GetJobCommand.ts index a5a7981a8a8a..61832132eb72 100644 --- a/clients/client-glue/commands/GetJobCommand.ts +++ b/clients/client-glue/commands/GetJobCommand.ts @@ -19,6 +19,20 @@ export interface GetJobCommandOutput extends GetJobResponse, __MetadataBearer {} /** *

Retrieves an existing job definition.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { GlueClient, GetJobCommand } from "@aws-sdk/client-glue"; // ES Modules import + * // const { GlueClient, GetJobCommand } = require("@aws-sdk/client-glue"); // CommonJS import + * const client = new GlueClient(config); + * const command = new GetJobCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetJobCommandInput} for command's `input` shape. + * @see {@link GetJobCommandOutput} for command's `response` shape. + * @see {@link GlueClientResolvedConfig | config} for command's `input` shape. + * */ export class GetJobCommand extends $Command { // Start section: command_properties diff --git a/clients/client-glue/commands/GetJobRunCommand.ts b/clients/client-glue/commands/GetJobRunCommand.ts index fc6f7643a630..314967534543 100644 --- a/clients/client-glue/commands/GetJobRunCommand.ts +++ b/clients/client-glue/commands/GetJobRunCommand.ts @@ -19,6 +19,20 @@ export interface GetJobRunCommandOutput extends GetJobRunResponse, __MetadataBea /** *

Retrieves the metadata for a given job run.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { GlueClient, GetJobRunCommand } from "@aws-sdk/client-glue"; // ES Modules import + * // const { GlueClient, GetJobRunCommand } = require("@aws-sdk/client-glue"); // CommonJS import + * const client = new GlueClient(config); + * const command = new GetJobRunCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetJobRunCommandInput} for command's `input` shape. + * @see {@link GetJobRunCommandOutput} for command's `response` shape. + * @see {@link GlueClientResolvedConfig | config} for command's `input` shape. + * */ export class GetJobRunCommand extends $Command< GetJobRunCommandInput, diff --git a/clients/client-glue/commands/GetJobRunsCommand.ts b/clients/client-glue/commands/GetJobRunsCommand.ts index 3c492000a309..b5642601c363 100644 --- a/clients/client-glue/commands/GetJobRunsCommand.ts +++ b/clients/client-glue/commands/GetJobRunsCommand.ts @@ -22,6 +22,20 @@ export interface GetJobRunsCommandOutput extends GetJobRunsResponse, __MetadataB /** *

Retrieves metadata for all runs of a given job definition.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { GlueClient, GetJobRunsCommand } from "@aws-sdk/client-glue"; // ES Modules import + * // const { GlueClient, GetJobRunsCommand } = require("@aws-sdk/client-glue"); // CommonJS import + * const client = new GlueClient(config); + * const command = new GetJobRunsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetJobRunsCommandInput} for command's `input` shape. + * @see {@link GetJobRunsCommandOutput} for command's `response` shape. + * @see {@link GlueClientResolvedConfig | config} for command's `input` shape. + * */ export class GetJobRunsCommand extends $Command< GetJobRunsCommandInput, diff --git a/clients/client-glue/commands/GetJobsCommand.ts b/clients/client-glue/commands/GetJobsCommand.ts index 7d3ebafee010..d38477bd3b3a 100644 --- a/clients/client-glue/commands/GetJobsCommand.ts +++ b/clients/client-glue/commands/GetJobsCommand.ts @@ -19,6 +19,20 @@ export interface GetJobsCommandOutput extends GetJobsResponse, __MetadataBearer /** *

Retrieves all current job definitions.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { GlueClient, GetJobsCommand } from "@aws-sdk/client-glue"; // ES Modules import + * // const { GlueClient, GetJobsCommand } = require("@aws-sdk/client-glue"); // CommonJS import + * const client = new GlueClient(config); + * const command = new GetJobsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetJobsCommandInput} for command's `input` shape. + * @see {@link GetJobsCommandOutput} for command's `response` shape. + * @see {@link GlueClientResolvedConfig | config} for command's `input` shape. + * */ export class GetJobsCommand extends $Command { // Start section: command_properties diff --git a/clients/client-glue/commands/GetMLTaskRunCommand.ts b/clients/client-glue/commands/GetMLTaskRunCommand.ts index ace5fddfc4ca..3cde2ba01c98 100644 --- a/clients/client-glue/commands/GetMLTaskRunCommand.ts +++ b/clients/client-glue/commands/GetMLTaskRunCommand.ts @@ -26,6 +26,20 @@ export interface GetMLTaskRunCommandOutput extends GetMLTaskRunResponse, __Metad * learning workflows. You can check the stats of any task run by calling * GetMLTaskRun with the TaskRunID and its parent transform's * TransformID.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { GlueClient, GetMLTaskRunCommand } from "@aws-sdk/client-glue"; // ES Modules import + * // const { GlueClient, GetMLTaskRunCommand } = require("@aws-sdk/client-glue"); // CommonJS import + * const client = new GlueClient(config); + * const command = new GetMLTaskRunCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetMLTaskRunCommandInput} for command's `input` shape. + * @see {@link GetMLTaskRunCommandOutput} for command's `response` shape. + * @see {@link GlueClientResolvedConfig | config} for command's `input` shape. + * */ export class GetMLTaskRunCommand extends $Command< GetMLTaskRunCommandInput, diff --git a/clients/client-glue/commands/GetMLTaskRunsCommand.ts b/clients/client-glue/commands/GetMLTaskRunsCommand.ts index f9603e4a44bc..fb12fe1441aa 100644 --- a/clients/client-glue/commands/GetMLTaskRunsCommand.ts +++ b/clients/client-glue/commands/GetMLTaskRunsCommand.ts @@ -28,6 +28,20 @@ export interface GetMLTaskRunsCommandOutput extends GetMLTaskRunsResponse, __Met * optional parameters as documented in this section.

* *

This operation returns a list of historic runs and must be paginated.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { GlueClient, GetMLTaskRunsCommand } from "@aws-sdk/client-glue"; // ES Modules import + * // const { GlueClient, GetMLTaskRunsCommand } = require("@aws-sdk/client-glue"); // CommonJS import + * const client = new GlueClient(config); + * const command = new GetMLTaskRunsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetMLTaskRunsCommandInput} for command's `input` shape. + * @see {@link GetMLTaskRunsCommandOutput} for command's `response` shape. + * @see {@link GlueClientResolvedConfig | config} for command's `input` shape. + * */ export class GetMLTaskRunsCommand extends $Command< GetMLTaskRunsCommandInput, diff --git a/clients/client-glue/commands/GetMLTransformCommand.ts b/clients/client-glue/commands/GetMLTransformCommand.ts index 40ac9fa85fc9..942e9791b98b 100644 --- a/clients/client-glue/commands/GetMLTransformCommand.ts +++ b/clients/client-glue/commands/GetMLTransformCommand.ts @@ -26,6 +26,20 @@ export interface GetMLTransformCommandOutput extends GetMLTransformResponse, __M * the details of the transformation to be performed by learning from examples provided by * humans. These transformations are then saved by AWS Glue. You can retrieve their metadata by * calling GetMLTransform.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { GlueClient, GetMLTransformCommand } from "@aws-sdk/client-glue"; // ES Modules import + * // const { GlueClient, GetMLTransformCommand } = require("@aws-sdk/client-glue"); // CommonJS import + * const client = new GlueClient(config); + * const command = new GetMLTransformCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetMLTransformCommandInput} for command's `input` shape. + * @see {@link GetMLTransformCommandOutput} for command's `response` shape. + * @see {@link GlueClientResolvedConfig | config} for command's `input` shape. + * */ export class GetMLTransformCommand extends $Command< GetMLTransformCommandInput, diff --git a/clients/client-glue/commands/GetMLTransformsCommand.ts b/clients/client-glue/commands/GetMLTransformsCommand.ts index a64a82635aa0..d0d7315d6ea7 100644 --- a/clients/client-glue/commands/GetMLTransformsCommand.ts +++ b/clients/client-glue/commands/GetMLTransformsCommand.ts @@ -26,6 +26,20 @@ export interface GetMLTransformsCommandOutput extends GetMLTransformsResponse, _ * details of the transformation to be performed by learning from examples provided by humans. * These transformations are then saved by AWS Glue, and you can retrieve their metadata by * calling GetMLTransforms.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { GlueClient, GetMLTransformsCommand } from "@aws-sdk/client-glue"; // ES Modules import + * // const { GlueClient, GetMLTransformsCommand } = require("@aws-sdk/client-glue"); // CommonJS import + * const client = new GlueClient(config); + * const command = new GetMLTransformsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetMLTransformsCommandInput} for command's `input` shape. + * @see {@link GetMLTransformsCommandOutput} for command's `response` shape. + * @see {@link GlueClientResolvedConfig | config} for command's `input` shape. + * */ export class GetMLTransformsCommand extends $Command< GetMLTransformsCommandInput, diff --git a/clients/client-glue/commands/GetMappingCommand.ts b/clients/client-glue/commands/GetMappingCommand.ts index ed4ec774fa75..5a83ad6b7dcc 100644 --- a/clients/client-glue/commands/GetMappingCommand.ts +++ b/clients/client-glue/commands/GetMappingCommand.ts @@ -22,6 +22,20 @@ export interface GetMappingCommandOutput extends GetMappingResponse, __MetadataB /** *

Creates mappings.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { GlueClient, GetMappingCommand } from "@aws-sdk/client-glue"; // ES Modules import + * // const { GlueClient, GetMappingCommand } = require("@aws-sdk/client-glue"); // CommonJS import + * const client = new GlueClient(config); + * const command = new GetMappingCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetMappingCommandInput} for command's `input` shape. + * @see {@link GetMappingCommandOutput} for command's `response` shape. + * @see {@link GlueClientResolvedConfig | config} for command's `input` shape. + * */ export class GetMappingCommand extends $Command< GetMappingCommandInput, diff --git a/clients/client-glue/commands/GetPartitionCommand.ts b/clients/client-glue/commands/GetPartitionCommand.ts index a22a10ae3d1b..ce6662e366b3 100644 --- a/clients/client-glue/commands/GetPartitionCommand.ts +++ b/clients/client-glue/commands/GetPartitionCommand.ts @@ -22,6 +22,20 @@ export interface GetPartitionCommandOutput extends GetPartitionResponse, __Metad /** *

Retrieves information about a specified partition.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { GlueClient, GetPartitionCommand } from "@aws-sdk/client-glue"; // ES Modules import + * // const { GlueClient, GetPartitionCommand } = require("@aws-sdk/client-glue"); // CommonJS import + * const client = new GlueClient(config); + * const command = new GetPartitionCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetPartitionCommandInput} for command's `input` shape. + * @see {@link GetPartitionCommandOutput} for command's `response` shape. + * @see {@link GlueClientResolvedConfig | config} for command's `input` shape. + * */ export class GetPartitionCommand extends $Command< GetPartitionCommandInput, diff --git a/clients/client-glue/commands/GetPartitionIndexesCommand.ts b/clients/client-glue/commands/GetPartitionIndexesCommand.ts index e5b9e5c29e3e..885418144015 100644 --- a/clients/client-glue/commands/GetPartitionIndexesCommand.ts +++ b/clients/client-glue/commands/GetPartitionIndexesCommand.ts @@ -22,6 +22,20 @@ export interface GetPartitionIndexesCommandOutput extends GetPartitionIndexesRes /** *

Retrieves the partition indexes associated with a table.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { GlueClient, GetPartitionIndexesCommand } from "@aws-sdk/client-glue"; // ES Modules import + * // const { GlueClient, GetPartitionIndexesCommand } = require("@aws-sdk/client-glue"); // CommonJS import + * const client = new GlueClient(config); + * const command = new GetPartitionIndexesCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetPartitionIndexesCommandInput} for command's `input` shape. + * @see {@link GetPartitionIndexesCommandOutput} for command's `response` shape. + * @see {@link GlueClientResolvedConfig | config} for command's `input` shape. + * */ export class GetPartitionIndexesCommand extends $Command< GetPartitionIndexesCommandInput, diff --git a/clients/client-glue/commands/GetPartitionsCommand.ts b/clients/client-glue/commands/GetPartitionsCommand.ts index 09d572829909..00023d9c82c2 100644 --- a/clients/client-glue/commands/GetPartitionsCommand.ts +++ b/clients/client-glue/commands/GetPartitionsCommand.ts @@ -22,6 +22,20 @@ export interface GetPartitionsCommandOutput extends GetPartitionsResponse, __Met /** *

Retrieves information about the partitions in a table.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { GlueClient, GetPartitionsCommand } from "@aws-sdk/client-glue"; // ES Modules import + * // const { GlueClient, GetPartitionsCommand } = require("@aws-sdk/client-glue"); // CommonJS import + * const client = new GlueClient(config); + * const command = new GetPartitionsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetPartitionsCommandInput} for command's `input` shape. + * @see {@link GetPartitionsCommandOutput} for command's `response` shape. + * @see {@link GlueClientResolvedConfig | config} for command's `input` shape. + * */ export class GetPartitionsCommand extends $Command< GetPartitionsCommandInput, diff --git a/clients/client-glue/commands/GetPlanCommand.ts b/clients/client-glue/commands/GetPlanCommand.ts index cd426d82d271..1e827928e8d7 100644 --- a/clients/client-glue/commands/GetPlanCommand.ts +++ b/clients/client-glue/commands/GetPlanCommand.ts @@ -19,6 +19,20 @@ export interface GetPlanCommandOutput extends GetPlanResponse, __MetadataBearer /** *

Gets code to perform a specified mapping.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { GlueClient, GetPlanCommand } from "@aws-sdk/client-glue"; // ES Modules import + * // const { GlueClient, GetPlanCommand } = require("@aws-sdk/client-glue"); // CommonJS import + * const client = new GlueClient(config); + * const command = new GetPlanCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetPlanCommandInput} for command's `input` shape. + * @see {@link GetPlanCommandOutput} for command's `response` shape. + * @see {@link GlueClientResolvedConfig | config} for command's `input` shape. + * */ export class GetPlanCommand extends $Command { // Start section: command_properties diff --git a/clients/client-glue/commands/GetRegistryCommand.ts b/clients/client-glue/commands/GetRegistryCommand.ts index 0f0cb698b315..f04410d43601 100644 --- a/clients/client-glue/commands/GetRegistryCommand.ts +++ b/clients/client-glue/commands/GetRegistryCommand.ts @@ -22,6 +22,20 @@ export interface GetRegistryCommandOutput extends GetRegistryResponse, __Metadat /** *

Describes the specified registry in detail.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { GlueClient, GetRegistryCommand } from "@aws-sdk/client-glue"; // ES Modules import + * // const { GlueClient, GetRegistryCommand } = require("@aws-sdk/client-glue"); // CommonJS import + * const client = new GlueClient(config); + * const command = new GetRegistryCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetRegistryCommandInput} for command's `input` shape. + * @see {@link GetRegistryCommandOutput} for command's `response` shape. + * @see {@link GlueClientResolvedConfig | config} for command's `input` shape. + * */ export class GetRegistryCommand extends $Command< GetRegistryCommandInput, diff --git a/clients/client-glue/commands/GetResourcePoliciesCommand.ts b/clients/client-glue/commands/GetResourcePoliciesCommand.ts index bd93e8fe3a88..a85124478b99 100644 --- a/clients/client-glue/commands/GetResourcePoliciesCommand.ts +++ b/clients/client-glue/commands/GetResourcePoliciesCommand.ts @@ -27,6 +27,20 @@ export interface GetResourcePoliciesCommandOutput extends GetResourcePoliciesRes *

If you enabled metadata encryption in Data Catalog settings, and you do not have * permission on the AWS KMS key, the operation can't return the Data Catalog resource * policy.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { GlueClient, GetResourcePoliciesCommand } from "@aws-sdk/client-glue"; // ES Modules import + * // const { GlueClient, GetResourcePoliciesCommand } = require("@aws-sdk/client-glue"); // CommonJS import + * const client = new GlueClient(config); + * const command = new GetResourcePoliciesCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetResourcePoliciesCommandInput} for command's `input` shape. + * @see {@link GetResourcePoliciesCommandOutput} for command's `response` shape. + * @see {@link GlueClientResolvedConfig | config} for command's `input` shape. + * */ export class GetResourcePoliciesCommand extends $Command< GetResourcePoliciesCommandInput, diff --git a/clients/client-glue/commands/GetResourcePolicyCommand.ts b/clients/client-glue/commands/GetResourcePolicyCommand.ts index 880a3eec6fcd..9705de97b840 100644 --- a/clients/client-glue/commands/GetResourcePolicyCommand.ts +++ b/clients/client-glue/commands/GetResourcePolicyCommand.ts @@ -22,6 +22,20 @@ export interface GetResourcePolicyCommandOutput extends GetResourcePolicyRespons /** *

Retrieves a specified resource policy.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { GlueClient, GetResourcePolicyCommand } from "@aws-sdk/client-glue"; // ES Modules import + * // const { GlueClient, GetResourcePolicyCommand } = require("@aws-sdk/client-glue"); // CommonJS import + * const client = new GlueClient(config); + * const command = new GetResourcePolicyCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetResourcePolicyCommandInput} for command's `input` shape. + * @see {@link GetResourcePolicyCommandOutput} for command's `response` shape. + * @see {@link GlueClientResolvedConfig | config} for command's `input` shape. + * */ export class GetResourcePolicyCommand extends $Command< GetResourcePolicyCommandInput, diff --git a/clients/client-glue/commands/GetSchemaByDefinitionCommand.ts b/clients/client-glue/commands/GetSchemaByDefinitionCommand.ts index 96a47d5d5dbe..2ac73b3bf818 100644 --- a/clients/client-glue/commands/GetSchemaByDefinitionCommand.ts +++ b/clients/client-glue/commands/GetSchemaByDefinitionCommand.ts @@ -22,6 +22,20 @@ export interface GetSchemaByDefinitionCommandOutput extends GetSchemaByDefinitio /** *

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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { GlueClient, GetSchemaByDefinitionCommand } from "@aws-sdk/client-glue"; // ES Modules import + * // const { GlueClient, GetSchemaByDefinitionCommand } = require("@aws-sdk/client-glue"); // CommonJS import + * const client = new GlueClient(config); + * const command = new GetSchemaByDefinitionCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetSchemaByDefinitionCommandInput} for command's `input` shape. + * @see {@link GetSchemaByDefinitionCommandOutput} for command's `response` shape. + * @see {@link GlueClientResolvedConfig | config} for command's `input` shape. + * */ export class GetSchemaByDefinitionCommand extends $Command< GetSchemaByDefinitionCommandInput, diff --git a/clients/client-glue/commands/GetSchemaCommand.ts b/clients/client-glue/commands/GetSchemaCommand.ts index b30345ceedbf..cdf9fc23dc6d 100644 --- a/clients/client-glue/commands/GetSchemaCommand.ts +++ b/clients/client-glue/commands/GetSchemaCommand.ts @@ -19,6 +19,20 @@ export interface GetSchemaCommandOutput extends GetSchemaResponse, __MetadataBea /** *

Describes the specified schema in detail.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { GlueClient, GetSchemaCommand } from "@aws-sdk/client-glue"; // ES Modules import + * // const { GlueClient, GetSchemaCommand } = require("@aws-sdk/client-glue"); // CommonJS import + * const client = new GlueClient(config); + * const command = new GetSchemaCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetSchemaCommandInput} for command's `input` shape. + * @see {@link GetSchemaCommandOutput} for command's `response` shape. + * @see {@link GlueClientResolvedConfig | config} for command's `input` shape. + * */ export class GetSchemaCommand extends $Command< GetSchemaCommandInput, diff --git a/clients/client-glue/commands/GetSchemaVersionCommand.ts b/clients/client-glue/commands/GetSchemaVersionCommand.ts index bda4130aacd9..dd598180d75b 100644 --- a/clients/client-glue/commands/GetSchemaVersionCommand.ts +++ b/clients/client-glue/commands/GetSchemaVersionCommand.ts @@ -22,6 +22,20 @@ export interface GetSchemaVersionCommandOutput extends GetSchemaVersionResponse, /** *

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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { GlueClient, GetSchemaVersionCommand } from "@aws-sdk/client-glue"; // ES Modules import + * // const { GlueClient, GetSchemaVersionCommand } = require("@aws-sdk/client-glue"); // CommonJS import + * const client = new GlueClient(config); + * const command = new GetSchemaVersionCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetSchemaVersionCommandInput} for command's `input` shape. + * @see {@link GetSchemaVersionCommandOutput} for command's `response` shape. + * @see {@link GlueClientResolvedConfig | config} for command's `input` shape. + * */ export class GetSchemaVersionCommand extends $Command< GetSchemaVersionCommandInput, diff --git a/clients/client-glue/commands/GetSchemaVersionsDiffCommand.ts b/clients/client-glue/commands/GetSchemaVersionsDiffCommand.ts index f92436495fa5..db04dd33bcbf 100644 --- a/clients/client-glue/commands/GetSchemaVersionsDiffCommand.ts +++ b/clients/client-glue/commands/GetSchemaVersionsDiffCommand.ts @@ -23,6 +23,20 @@ export interface GetSchemaVersionsDiffCommandOutput extends GetSchemaVersionsDif /** *

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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { GlueClient, GetSchemaVersionsDiffCommand } from "@aws-sdk/client-glue"; // ES Modules import + * // const { GlueClient, GetSchemaVersionsDiffCommand } = require("@aws-sdk/client-glue"); // CommonJS import + * const client = new GlueClient(config); + * const command = new GetSchemaVersionsDiffCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetSchemaVersionsDiffCommandInput} for command's `input` shape. + * @see {@link GetSchemaVersionsDiffCommandOutput} for command's `response` shape. + * @see {@link GlueClientResolvedConfig | config} for command's `input` shape. + * */ export class GetSchemaVersionsDiffCommand extends $Command< GetSchemaVersionsDiffCommandInput, diff --git a/clients/client-glue/commands/GetSecurityConfigurationCommand.ts b/clients/client-glue/commands/GetSecurityConfigurationCommand.ts index 08bb55051e36..e3379162d759 100644 --- a/clients/client-glue/commands/GetSecurityConfigurationCommand.ts +++ b/clients/client-glue/commands/GetSecurityConfigurationCommand.ts @@ -22,6 +22,20 @@ export interface GetSecurityConfigurationCommandOutput extends GetSecurityConfig /** *

Retrieves a specified security configuration.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { GlueClient, GetSecurityConfigurationCommand } from "@aws-sdk/client-glue"; // ES Modules import + * // const { GlueClient, GetSecurityConfigurationCommand } = require("@aws-sdk/client-glue"); // CommonJS import + * const client = new GlueClient(config); + * const command = new GetSecurityConfigurationCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetSecurityConfigurationCommandInput} for command's `input` shape. + * @see {@link GetSecurityConfigurationCommandOutput} for command's `response` shape. + * @see {@link GlueClientResolvedConfig | config} for command's `input` shape. + * */ export class GetSecurityConfigurationCommand extends $Command< GetSecurityConfigurationCommandInput, diff --git a/clients/client-glue/commands/GetSecurityConfigurationsCommand.ts b/clients/client-glue/commands/GetSecurityConfigurationsCommand.ts index eaeb141ef1a4..18a2b46f9d59 100644 --- a/clients/client-glue/commands/GetSecurityConfigurationsCommand.ts +++ b/clients/client-glue/commands/GetSecurityConfigurationsCommand.ts @@ -22,6 +22,20 @@ export interface GetSecurityConfigurationsCommandOutput extends GetSecurityConfi /** *

Retrieves a list of all security configurations.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { GlueClient, GetSecurityConfigurationsCommand } from "@aws-sdk/client-glue"; // ES Modules import + * // const { GlueClient, GetSecurityConfigurationsCommand } = require("@aws-sdk/client-glue"); // CommonJS import + * const client = new GlueClient(config); + * const command = new GetSecurityConfigurationsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetSecurityConfigurationsCommandInput} for command's `input` shape. + * @see {@link GetSecurityConfigurationsCommandOutput} for command's `response` shape. + * @see {@link GlueClientResolvedConfig | config} for command's `input` shape. + * */ export class GetSecurityConfigurationsCommand extends $Command< GetSecurityConfigurationsCommandInput, diff --git a/clients/client-glue/commands/GetTableCommand.ts b/clients/client-glue/commands/GetTableCommand.ts index 7efbebd19e36..3476520dd645 100644 --- a/clients/client-glue/commands/GetTableCommand.ts +++ b/clients/client-glue/commands/GetTableCommand.ts @@ -20,6 +20,20 @@ export interface GetTableCommandOutput extends GetTableResponse, __MetadataBeare /** *

Retrieves the Table definition in a Data Catalog for * a specified table.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { GlueClient, GetTableCommand } from "@aws-sdk/client-glue"; // ES Modules import + * // const { GlueClient, GetTableCommand } = require("@aws-sdk/client-glue"); // CommonJS import + * const client = new GlueClient(config); + * const command = new GetTableCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetTableCommandInput} for command's `input` shape. + * @see {@link GetTableCommandOutput} for command's `response` shape. + * @see {@link GlueClientResolvedConfig | config} for command's `input` shape. + * */ export class GetTableCommand extends $Command { // Start section: command_properties diff --git a/clients/client-glue/commands/GetTableVersionCommand.ts b/clients/client-glue/commands/GetTableVersionCommand.ts index 6a05fc02c394..21796b7dceb4 100644 --- a/clients/client-glue/commands/GetTableVersionCommand.ts +++ b/clients/client-glue/commands/GetTableVersionCommand.ts @@ -22,6 +22,20 @@ export interface GetTableVersionCommandOutput extends GetTableVersionResponse, _ /** *

Retrieves a specified version of a table.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { GlueClient, GetTableVersionCommand } from "@aws-sdk/client-glue"; // ES Modules import + * // const { GlueClient, GetTableVersionCommand } = require("@aws-sdk/client-glue"); // CommonJS import + * const client = new GlueClient(config); + * const command = new GetTableVersionCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetTableVersionCommandInput} for command's `input` shape. + * @see {@link GetTableVersionCommandOutput} for command's `response` shape. + * @see {@link GlueClientResolvedConfig | config} for command's `input` shape. + * */ export class GetTableVersionCommand extends $Command< GetTableVersionCommandInput, diff --git a/clients/client-glue/commands/GetTableVersionsCommand.ts b/clients/client-glue/commands/GetTableVersionsCommand.ts index 2691d63c1f69..d54610a11d98 100644 --- a/clients/client-glue/commands/GetTableVersionsCommand.ts +++ b/clients/client-glue/commands/GetTableVersionsCommand.ts @@ -23,6 +23,20 @@ export interface GetTableVersionsCommandOutput extends GetTableVersionsResponse, /** *

Retrieves a list of strings that identify available versions of * a specified table.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { GlueClient, GetTableVersionsCommand } from "@aws-sdk/client-glue"; // ES Modules import + * // const { GlueClient, GetTableVersionsCommand } = require("@aws-sdk/client-glue"); // CommonJS import + * const client = new GlueClient(config); + * const command = new GetTableVersionsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetTableVersionsCommandInput} for command's `input` shape. + * @see {@link GetTableVersionsCommandOutput} for command's `response` shape. + * @see {@link GlueClientResolvedConfig | config} for command's `input` shape. + * */ export class GetTableVersionsCommand extends $Command< GetTableVersionsCommandInput, diff --git a/clients/client-glue/commands/GetTablesCommand.ts b/clients/client-glue/commands/GetTablesCommand.ts index beccb60b5fd5..39f567f5c31e 100644 --- a/clients/client-glue/commands/GetTablesCommand.ts +++ b/clients/client-glue/commands/GetTablesCommand.ts @@ -20,6 +20,20 @@ export interface GetTablesCommandOutput extends GetTablesResponse, __MetadataBea /** *

Retrieves the definitions of some or all of the tables in a given * Database.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { GlueClient, GetTablesCommand } from "@aws-sdk/client-glue"; // ES Modules import + * // const { GlueClient, GetTablesCommand } = require("@aws-sdk/client-glue"); // CommonJS import + * const client = new GlueClient(config); + * const command = new GetTablesCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetTablesCommandInput} for command's `input` shape. + * @see {@link GetTablesCommandOutput} for command's `response` shape. + * @see {@link GlueClientResolvedConfig | config} for command's `input` shape. + * */ export class GetTablesCommand extends $Command< GetTablesCommandInput, diff --git a/clients/client-glue/commands/GetTagsCommand.ts b/clients/client-glue/commands/GetTagsCommand.ts index e493fc2c8d92..541f949335da 100644 --- a/clients/client-glue/commands/GetTagsCommand.ts +++ b/clients/client-glue/commands/GetTagsCommand.ts @@ -19,6 +19,20 @@ export interface GetTagsCommandOutput extends GetTagsResponse, __MetadataBearer /** *

Retrieves a list of tags associated with a resource.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { GlueClient, GetTagsCommand } from "@aws-sdk/client-glue"; // ES Modules import + * // const { GlueClient, GetTagsCommand } = require("@aws-sdk/client-glue"); // CommonJS import + * const client = new GlueClient(config); + * const command = new GetTagsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetTagsCommandInput} for command's `input` shape. + * @see {@link GetTagsCommandOutput} for command's `response` shape. + * @see {@link GlueClientResolvedConfig | config} for command's `input` shape. + * */ export class GetTagsCommand extends $Command { // Start section: command_properties diff --git a/clients/client-glue/commands/GetTriggerCommand.ts b/clients/client-glue/commands/GetTriggerCommand.ts index 117040277e5c..b3dfb7c408c6 100644 --- a/clients/client-glue/commands/GetTriggerCommand.ts +++ b/clients/client-glue/commands/GetTriggerCommand.ts @@ -22,6 +22,20 @@ export interface GetTriggerCommandOutput extends GetTriggerResponse, __MetadataB /** *

Retrieves the definition of a trigger.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { GlueClient, GetTriggerCommand } from "@aws-sdk/client-glue"; // ES Modules import + * // const { GlueClient, GetTriggerCommand } = require("@aws-sdk/client-glue"); // CommonJS import + * const client = new GlueClient(config); + * const command = new GetTriggerCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetTriggerCommandInput} for command's `input` shape. + * @see {@link GetTriggerCommandOutput} for command's `response` shape. + * @see {@link GlueClientResolvedConfig | config} for command's `input` shape. + * */ export class GetTriggerCommand extends $Command< GetTriggerCommandInput, diff --git a/clients/client-glue/commands/GetTriggersCommand.ts b/clients/client-glue/commands/GetTriggersCommand.ts index 9db31ccb81dd..76933dde4838 100644 --- a/clients/client-glue/commands/GetTriggersCommand.ts +++ b/clients/client-glue/commands/GetTriggersCommand.ts @@ -22,6 +22,20 @@ export interface GetTriggersCommandOutput extends GetTriggersResponse, __Metadat /** *

Gets all the triggers associated with a job.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { GlueClient, GetTriggersCommand } from "@aws-sdk/client-glue"; // ES Modules import + * // const { GlueClient, GetTriggersCommand } = require("@aws-sdk/client-glue"); // CommonJS import + * const client = new GlueClient(config); + * const command = new GetTriggersCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetTriggersCommandInput} for command's `input` shape. + * @see {@link GetTriggersCommandOutput} for command's `response` shape. + * @see {@link GlueClientResolvedConfig | config} for command's `input` shape. + * */ export class GetTriggersCommand extends $Command< GetTriggersCommandInput, diff --git a/clients/client-glue/commands/GetUserDefinedFunctionCommand.ts b/clients/client-glue/commands/GetUserDefinedFunctionCommand.ts index fd20c5d54be4..f211c0ed5fe6 100644 --- a/clients/client-glue/commands/GetUserDefinedFunctionCommand.ts +++ b/clients/client-glue/commands/GetUserDefinedFunctionCommand.ts @@ -22,6 +22,20 @@ export interface GetUserDefinedFunctionCommandOutput extends GetUserDefinedFunct /** *

Retrieves a specified function definition from the Data Catalog.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { GlueClient, GetUserDefinedFunctionCommand } from "@aws-sdk/client-glue"; // ES Modules import + * // const { GlueClient, GetUserDefinedFunctionCommand } = require("@aws-sdk/client-glue"); // CommonJS import + * const client = new GlueClient(config); + * const command = new GetUserDefinedFunctionCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetUserDefinedFunctionCommandInput} for command's `input` shape. + * @see {@link GetUserDefinedFunctionCommandOutput} for command's `response` shape. + * @see {@link GlueClientResolvedConfig | config} for command's `input` shape. + * */ export class GetUserDefinedFunctionCommand extends $Command< GetUserDefinedFunctionCommandInput, diff --git a/clients/client-glue/commands/GetUserDefinedFunctionsCommand.ts b/clients/client-glue/commands/GetUserDefinedFunctionsCommand.ts index 4fb7a4e63fd0..9b4646652028 100644 --- a/clients/client-glue/commands/GetUserDefinedFunctionsCommand.ts +++ b/clients/client-glue/commands/GetUserDefinedFunctionsCommand.ts @@ -22,6 +22,20 @@ export interface GetUserDefinedFunctionsCommandOutput extends GetUserDefinedFunc /** *

Retrieves multiple function definitions from the Data Catalog.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { GlueClient, GetUserDefinedFunctionsCommand } from "@aws-sdk/client-glue"; // ES Modules import + * // const { GlueClient, GetUserDefinedFunctionsCommand } = require("@aws-sdk/client-glue"); // CommonJS import + * const client = new GlueClient(config); + * const command = new GetUserDefinedFunctionsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetUserDefinedFunctionsCommandInput} for command's `input` shape. + * @see {@link GetUserDefinedFunctionsCommandOutput} for command's `response` shape. + * @see {@link GlueClientResolvedConfig | config} for command's `input` shape. + * */ export class GetUserDefinedFunctionsCommand extends $Command< GetUserDefinedFunctionsCommandInput, diff --git a/clients/client-glue/commands/GetWorkflowCommand.ts b/clients/client-glue/commands/GetWorkflowCommand.ts index da5afef39285..bfcce8ac1456 100644 --- a/clients/client-glue/commands/GetWorkflowCommand.ts +++ b/clients/client-glue/commands/GetWorkflowCommand.ts @@ -22,6 +22,20 @@ export interface GetWorkflowCommandOutput extends GetWorkflowResponse, __Metadat /** *

Retrieves resource metadata for a workflow.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { GlueClient, GetWorkflowCommand } from "@aws-sdk/client-glue"; // ES Modules import + * // const { GlueClient, GetWorkflowCommand } = require("@aws-sdk/client-glue"); // CommonJS import + * const client = new GlueClient(config); + * const command = new GetWorkflowCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetWorkflowCommandInput} for command's `input` shape. + * @see {@link GetWorkflowCommandOutput} for command's `response` shape. + * @see {@link GlueClientResolvedConfig | config} for command's `input` shape. + * */ export class GetWorkflowCommand extends $Command< GetWorkflowCommandInput, diff --git a/clients/client-glue/commands/GetWorkflowRunCommand.ts b/clients/client-glue/commands/GetWorkflowRunCommand.ts index e90e61572e26..0f5e77751398 100644 --- a/clients/client-glue/commands/GetWorkflowRunCommand.ts +++ b/clients/client-glue/commands/GetWorkflowRunCommand.ts @@ -22,6 +22,20 @@ export interface GetWorkflowRunCommandOutput extends GetWorkflowRunResponse, __M /** *

Retrieves the metadata for a given workflow run.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { GlueClient, GetWorkflowRunCommand } from "@aws-sdk/client-glue"; // ES Modules import + * // const { GlueClient, GetWorkflowRunCommand } = require("@aws-sdk/client-glue"); // CommonJS import + * const client = new GlueClient(config); + * const command = new GetWorkflowRunCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetWorkflowRunCommandInput} for command's `input` shape. + * @see {@link GetWorkflowRunCommandOutput} for command's `response` shape. + * @see {@link GlueClientResolvedConfig | config} for command's `input` shape. + * */ export class GetWorkflowRunCommand extends $Command< GetWorkflowRunCommandInput, diff --git a/clients/client-glue/commands/GetWorkflowRunPropertiesCommand.ts b/clients/client-glue/commands/GetWorkflowRunPropertiesCommand.ts index f0c2ef3b8487..2fb1827b68a3 100644 --- a/clients/client-glue/commands/GetWorkflowRunPropertiesCommand.ts +++ b/clients/client-glue/commands/GetWorkflowRunPropertiesCommand.ts @@ -22,6 +22,20 @@ export interface GetWorkflowRunPropertiesCommandOutput extends GetWorkflowRunPro /** *

Retrieves the workflow run properties which were set during the run.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { GlueClient, GetWorkflowRunPropertiesCommand } from "@aws-sdk/client-glue"; // ES Modules import + * // const { GlueClient, GetWorkflowRunPropertiesCommand } = require("@aws-sdk/client-glue"); // CommonJS import + * const client = new GlueClient(config); + * const command = new GetWorkflowRunPropertiesCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetWorkflowRunPropertiesCommandInput} for command's `input` shape. + * @see {@link GetWorkflowRunPropertiesCommandOutput} for command's `response` shape. + * @see {@link GlueClientResolvedConfig | config} for command's `input` shape. + * */ export class GetWorkflowRunPropertiesCommand extends $Command< GetWorkflowRunPropertiesCommandInput, diff --git a/clients/client-glue/commands/GetWorkflowRunsCommand.ts b/clients/client-glue/commands/GetWorkflowRunsCommand.ts index 42542888a3c7..60b87bb4b4a2 100644 --- a/clients/client-glue/commands/GetWorkflowRunsCommand.ts +++ b/clients/client-glue/commands/GetWorkflowRunsCommand.ts @@ -22,6 +22,20 @@ export interface GetWorkflowRunsCommandOutput extends GetWorkflowRunsResponse, _ /** *

Retrieves metadata for all runs of a given workflow.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { GlueClient, GetWorkflowRunsCommand } from "@aws-sdk/client-glue"; // ES Modules import + * // const { GlueClient, GetWorkflowRunsCommand } = require("@aws-sdk/client-glue"); // CommonJS import + * const client = new GlueClient(config); + * const command = new GetWorkflowRunsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetWorkflowRunsCommandInput} for command's `input` shape. + * @see {@link GetWorkflowRunsCommandOutput} for command's `response` shape. + * @see {@link GlueClientResolvedConfig | config} for command's `input` shape. + * */ export class GetWorkflowRunsCommand extends $Command< GetWorkflowRunsCommandInput, diff --git a/clients/client-glue/commands/ImportCatalogToGlueCommand.ts b/clients/client-glue/commands/ImportCatalogToGlueCommand.ts index c0c695579e80..4febb3620a5b 100644 --- a/clients/client-glue/commands/ImportCatalogToGlueCommand.ts +++ b/clients/client-glue/commands/ImportCatalogToGlueCommand.ts @@ -22,6 +22,20 @@ export interface ImportCatalogToGlueCommandOutput extends ImportCatalogToGlueRes /** *

Imports an existing Amazon Athena Data Catalog to AWS Glue

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { GlueClient, ImportCatalogToGlueCommand } from "@aws-sdk/client-glue"; // ES Modules import + * // const { GlueClient, ImportCatalogToGlueCommand } = require("@aws-sdk/client-glue"); // CommonJS import + * const client = new GlueClient(config); + * const command = new ImportCatalogToGlueCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ImportCatalogToGlueCommandInput} for command's `input` shape. + * @see {@link ImportCatalogToGlueCommandOutput} for command's `response` shape. + * @see {@link GlueClientResolvedConfig | config} for command's `input` shape. + * */ export class ImportCatalogToGlueCommand extends $Command< ImportCatalogToGlueCommandInput, diff --git a/clients/client-glue/commands/ListCrawlersCommand.ts b/clients/client-glue/commands/ListCrawlersCommand.ts index b058aa7db363..c75ec77cf152 100644 --- a/clients/client-glue/commands/ListCrawlersCommand.ts +++ b/clients/client-glue/commands/ListCrawlersCommand.ts @@ -28,6 +28,20 @@ export interface ListCrawlersCommandOutput extends ListCrawlersResponse, __Metad *

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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { GlueClient, ListCrawlersCommand } from "@aws-sdk/client-glue"; // ES Modules import + * // const { GlueClient, ListCrawlersCommand } = require("@aws-sdk/client-glue"); // CommonJS import + * const client = new GlueClient(config); + * const command = new ListCrawlersCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListCrawlersCommandInput} for command's `input` shape. + * @see {@link ListCrawlersCommandOutput} for command's `response` shape. + * @see {@link GlueClientResolvedConfig | config} for command's `input` shape. + * */ export class ListCrawlersCommand extends $Command< ListCrawlersCommandInput, diff --git a/clients/client-glue/commands/ListDevEndpointsCommand.ts b/clients/client-glue/commands/ListDevEndpointsCommand.ts index ddb0063b139f..cff9214b7d2d 100644 --- a/clients/client-glue/commands/ListDevEndpointsCommand.ts +++ b/clients/client-glue/commands/ListDevEndpointsCommand.ts @@ -28,6 +28,20 @@ export interface ListDevEndpointsCommandOutput extends ListDevEndpointsResponse, *

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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { GlueClient, ListDevEndpointsCommand } from "@aws-sdk/client-glue"; // ES Modules import + * // const { GlueClient, ListDevEndpointsCommand } = require("@aws-sdk/client-glue"); // CommonJS import + * const client = new GlueClient(config); + * const command = new ListDevEndpointsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListDevEndpointsCommandInput} for command's `input` shape. + * @see {@link ListDevEndpointsCommandOutput} for command's `response` shape. + * @see {@link GlueClientResolvedConfig | config} for command's `input` shape. + * */ export class ListDevEndpointsCommand extends $Command< ListDevEndpointsCommandInput, diff --git a/clients/client-glue/commands/ListJobsCommand.ts b/clients/client-glue/commands/ListJobsCommand.ts index be5aabb9b0b1..64a706801452 100644 --- a/clients/client-glue/commands/ListJobsCommand.ts +++ b/clients/client-glue/commands/ListJobsCommand.ts @@ -23,6 +23,20 @@ export interface ListJobsCommandOutput extends ListJobsResponse, __MetadataBeare *

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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { GlueClient, ListJobsCommand } from "@aws-sdk/client-glue"; // ES Modules import + * // const { GlueClient, ListJobsCommand } = require("@aws-sdk/client-glue"); // CommonJS import + * const client = new GlueClient(config); + * const command = new ListJobsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListJobsCommandInput} for command's `input` shape. + * @see {@link ListJobsCommandOutput} for command's `response` shape. + * @see {@link GlueClientResolvedConfig | config} for command's `input` shape. + * */ export class ListJobsCommand extends $Command { // Start section: command_properties diff --git a/clients/client-glue/commands/ListMLTransformsCommand.ts b/clients/client-glue/commands/ListMLTransformsCommand.ts index 7196be81e254..007b2044f7b8 100644 --- a/clients/client-glue/commands/ListMLTransformsCommand.ts +++ b/clients/client-glue/commands/ListMLTransformsCommand.ts @@ -26,6 +26,20 @@ export interface ListMLTransformsCommandOutput extends ListMLTransformsResponse, * 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. *

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { GlueClient, ListMLTransformsCommand } from "@aws-sdk/client-glue"; // ES Modules import + * // const { GlueClient, ListMLTransformsCommand } = require("@aws-sdk/client-glue"); // CommonJS import + * const client = new GlueClient(config); + * const command = new ListMLTransformsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListMLTransformsCommandInput} for command's `input` shape. + * @see {@link ListMLTransformsCommandOutput} for command's `response` shape. + * @see {@link GlueClientResolvedConfig | config} for command's `input` shape. + * */ export class ListMLTransformsCommand extends $Command< ListMLTransformsCommandInput, diff --git a/clients/client-glue/commands/ListRegistriesCommand.ts b/clients/client-glue/commands/ListRegistriesCommand.ts index fce7de0752ce..b9c561933850 100644 --- a/clients/client-glue/commands/ListRegistriesCommand.ts +++ b/clients/client-glue/commands/ListRegistriesCommand.ts @@ -22,6 +22,20 @@ export interface ListRegistriesCommandOutput extends ListRegistriesResponse, __M /** *

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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { GlueClient, ListRegistriesCommand } from "@aws-sdk/client-glue"; // ES Modules import + * // const { GlueClient, ListRegistriesCommand } = require("@aws-sdk/client-glue"); // CommonJS import + * const client = new GlueClient(config); + * const command = new ListRegistriesCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListRegistriesCommandInput} for command's `input` shape. + * @see {@link ListRegistriesCommandOutput} for command's `response` shape. + * @see {@link GlueClientResolvedConfig | config} for command's `input` shape. + * */ export class ListRegistriesCommand extends $Command< ListRegistriesCommandInput, diff --git a/clients/client-glue/commands/ListSchemaVersionsCommand.ts b/clients/client-glue/commands/ListSchemaVersionsCommand.ts index 22452641d205..2942da584076 100644 --- a/clients/client-glue/commands/ListSchemaVersionsCommand.ts +++ b/clients/client-glue/commands/ListSchemaVersionsCommand.ts @@ -22,6 +22,20 @@ export interface ListSchemaVersionsCommandOutput extends ListSchemaVersionsRespo /** *

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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { GlueClient, ListSchemaVersionsCommand } from "@aws-sdk/client-glue"; // ES Modules import + * // const { GlueClient, ListSchemaVersionsCommand } = require("@aws-sdk/client-glue"); // CommonJS import + * const client = new GlueClient(config); + * const command = new ListSchemaVersionsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListSchemaVersionsCommandInput} for command's `input` shape. + * @see {@link ListSchemaVersionsCommandOutput} for command's `response` shape. + * @see {@link GlueClientResolvedConfig | config} for command's `input` shape. + * */ export class ListSchemaVersionsCommand extends $Command< ListSchemaVersionsCommandInput, diff --git a/clients/client-glue/commands/ListSchemasCommand.ts b/clients/client-glue/commands/ListSchemasCommand.ts index cfcecb403128..da6d64f2d7b3 100644 --- a/clients/client-glue/commands/ListSchemasCommand.ts +++ b/clients/client-glue/commands/ListSchemasCommand.ts @@ -23,6 +23,20 @@ export interface ListSchemasCommandOutput extends ListSchemasResponse, __Metadat /** *

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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { GlueClient, ListSchemasCommand } from "@aws-sdk/client-glue"; // ES Modules import + * // const { GlueClient, ListSchemasCommand } = require("@aws-sdk/client-glue"); // CommonJS import + * const client = new GlueClient(config); + * const command = new ListSchemasCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListSchemasCommandInput} for command's `input` shape. + * @see {@link ListSchemasCommandOutput} for command's `response` shape. + * @see {@link GlueClientResolvedConfig | config} for command's `input` shape. + * */ export class ListSchemasCommand extends $Command< ListSchemasCommandInput, diff --git a/clients/client-glue/commands/ListTriggersCommand.ts b/clients/client-glue/commands/ListTriggersCommand.ts index a8433ca38062..bda9c0070552 100644 --- a/clients/client-glue/commands/ListTriggersCommand.ts +++ b/clients/client-glue/commands/ListTriggersCommand.ts @@ -26,6 +26,20 @@ export interface ListTriggersCommandOutput extends ListTriggersResponse, __Metad *

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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { GlueClient, ListTriggersCommand } from "@aws-sdk/client-glue"; // ES Modules import + * // const { GlueClient, ListTriggersCommand } = require("@aws-sdk/client-glue"); // CommonJS import + * const client = new GlueClient(config); + * const command = new ListTriggersCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListTriggersCommandInput} for command's `input` shape. + * @see {@link ListTriggersCommandOutput} for command's `response` shape. + * @see {@link GlueClientResolvedConfig | config} for command's `input` shape. + * */ export class ListTriggersCommand extends $Command< ListTriggersCommandInput, diff --git a/clients/client-glue/commands/ListWorkflowsCommand.ts b/clients/client-glue/commands/ListWorkflowsCommand.ts index c6842a4eb353..6995b9c4a13a 100644 --- a/clients/client-glue/commands/ListWorkflowsCommand.ts +++ b/clients/client-glue/commands/ListWorkflowsCommand.ts @@ -22,6 +22,20 @@ export interface ListWorkflowsCommandOutput extends ListWorkflowsResponse, __Met /** *

Lists names of workflows created in the account.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { GlueClient, ListWorkflowsCommand } from "@aws-sdk/client-glue"; // ES Modules import + * // const { GlueClient, ListWorkflowsCommand } = require("@aws-sdk/client-glue"); // CommonJS import + * const client = new GlueClient(config); + * const command = new ListWorkflowsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListWorkflowsCommandInput} for command's `input` shape. + * @see {@link ListWorkflowsCommandOutput} for command's `response` shape. + * @see {@link GlueClientResolvedConfig | config} for command's `input` shape. + * */ export class ListWorkflowsCommand extends $Command< ListWorkflowsCommandInput, diff --git a/clients/client-glue/commands/PutDataCatalogEncryptionSettingsCommand.ts b/clients/client-glue/commands/PutDataCatalogEncryptionSettingsCommand.ts index cb44c472f9af..793fa7ef17d6 100644 --- a/clients/client-glue/commands/PutDataCatalogEncryptionSettingsCommand.ts +++ b/clients/client-glue/commands/PutDataCatalogEncryptionSettingsCommand.ts @@ -25,6 +25,20 @@ export interface PutDataCatalogEncryptionSettingsCommandOutput /** *

Sets the security configuration for a specified catalog. After the configuration has been * set, the specified encryption is applied to every catalog write thereafter.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { GlueClient, PutDataCatalogEncryptionSettingsCommand } from "@aws-sdk/client-glue"; // ES Modules import + * // const { GlueClient, PutDataCatalogEncryptionSettingsCommand } = require("@aws-sdk/client-glue"); // CommonJS import + * const client = new GlueClient(config); + * const command = new PutDataCatalogEncryptionSettingsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link PutDataCatalogEncryptionSettingsCommandInput} for command's `input` shape. + * @see {@link PutDataCatalogEncryptionSettingsCommandOutput} for command's `response` shape. + * @see {@link GlueClientResolvedConfig | config} for command's `input` shape. + * */ export class PutDataCatalogEncryptionSettingsCommand extends $Command< PutDataCatalogEncryptionSettingsCommandInput, diff --git a/clients/client-glue/commands/PutResourcePolicyCommand.ts b/clients/client-glue/commands/PutResourcePolicyCommand.ts index 449c37c63296..6ab142e32121 100644 --- a/clients/client-glue/commands/PutResourcePolicyCommand.ts +++ b/clients/client-glue/commands/PutResourcePolicyCommand.ts @@ -22,6 +22,20 @@ export interface PutResourcePolicyCommandOutput extends PutResourcePolicyRespons /** *

Sets the Data Catalog resource policy for access control.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { GlueClient, PutResourcePolicyCommand } from "@aws-sdk/client-glue"; // ES Modules import + * // const { GlueClient, PutResourcePolicyCommand } = require("@aws-sdk/client-glue"); // CommonJS import + * const client = new GlueClient(config); + * const command = new PutResourcePolicyCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link PutResourcePolicyCommandInput} for command's `input` shape. + * @see {@link PutResourcePolicyCommandOutput} for command's `response` shape. + * @see {@link GlueClientResolvedConfig | config} for command's `input` shape. + * */ export class PutResourcePolicyCommand extends $Command< PutResourcePolicyCommandInput, diff --git a/clients/client-glue/commands/PutSchemaVersionMetadataCommand.ts b/clients/client-glue/commands/PutSchemaVersionMetadataCommand.ts index 1ac2c30df4e8..03b0fa57b82e 100644 --- a/clients/client-glue/commands/PutSchemaVersionMetadataCommand.ts +++ b/clients/client-glue/commands/PutSchemaVersionMetadataCommand.ts @@ -22,6 +22,20 @@ export interface PutSchemaVersionMetadataCommandOutput extends PutSchemaVersionM /** *

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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { GlueClient, PutSchemaVersionMetadataCommand } from "@aws-sdk/client-glue"; // ES Modules import + * // const { GlueClient, PutSchemaVersionMetadataCommand } = require("@aws-sdk/client-glue"); // CommonJS import + * const client = new GlueClient(config); + * const command = new PutSchemaVersionMetadataCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link PutSchemaVersionMetadataCommandInput} for command's `input` shape. + * @see {@link PutSchemaVersionMetadataCommandOutput} for command's `response` shape. + * @see {@link GlueClientResolvedConfig | config} for command's `input` shape. + * */ export class PutSchemaVersionMetadataCommand extends $Command< PutSchemaVersionMetadataCommandInput, diff --git a/clients/client-glue/commands/PutWorkflowRunPropertiesCommand.ts b/clients/client-glue/commands/PutWorkflowRunPropertiesCommand.ts index dd318e9da9d5..5969b0b99e18 100644 --- a/clients/client-glue/commands/PutWorkflowRunPropertiesCommand.ts +++ b/clients/client-glue/commands/PutWorkflowRunPropertiesCommand.ts @@ -22,6 +22,20 @@ export interface PutWorkflowRunPropertiesCommandOutput extends PutWorkflowRunPro /** *

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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { GlueClient, PutWorkflowRunPropertiesCommand } from "@aws-sdk/client-glue"; // ES Modules import + * // const { GlueClient, PutWorkflowRunPropertiesCommand } = require("@aws-sdk/client-glue"); // CommonJS import + * const client = new GlueClient(config); + * const command = new PutWorkflowRunPropertiesCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link PutWorkflowRunPropertiesCommandInput} for command's `input` shape. + * @see {@link PutWorkflowRunPropertiesCommandOutput} for command's `response` shape. + * @see {@link GlueClientResolvedConfig | config} for command's `input` shape. + * */ export class PutWorkflowRunPropertiesCommand extends $Command< PutWorkflowRunPropertiesCommandInput, diff --git a/clients/client-glue/commands/QuerySchemaVersionMetadataCommand.ts b/clients/client-glue/commands/QuerySchemaVersionMetadataCommand.ts index 627e9cc4ce7d..58497d02e44d 100644 --- a/clients/client-glue/commands/QuerySchemaVersionMetadataCommand.ts +++ b/clients/client-glue/commands/QuerySchemaVersionMetadataCommand.ts @@ -22,6 +22,20 @@ export interface QuerySchemaVersionMetadataCommandOutput extends QuerySchemaVers /** *

Queries for the schema version metadata information.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { GlueClient, QuerySchemaVersionMetadataCommand } from "@aws-sdk/client-glue"; // ES Modules import + * // const { GlueClient, QuerySchemaVersionMetadataCommand } = require("@aws-sdk/client-glue"); // CommonJS import + * const client = new GlueClient(config); + * const command = new QuerySchemaVersionMetadataCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link QuerySchemaVersionMetadataCommandInput} for command's `input` shape. + * @see {@link QuerySchemaVersionMetadataCommandOutput} for command's `response` shape. + * @see {@link GlueClientResolvedConfig | config} for command's `input` shape. + * */ export class QuerySchemaVersionMetadataCommand extends $Command< QuerySchemaVersionMetadataCommandInput, diff --git a/clients/client-glue/commands/RegisterSchemaVersionCommand.ts b/clients/client-glue/commands/RegisterSchemaVersionCommand.ts index 2f54cb4a0d62..cdb6eb799c83 100644 --- a/clients/client-glue/commands/RegisterSchemaVersionCommand.ts +++ b/clients/client-glue/commands/RegisterSchemaVersionCommand.ts @@ -24,6 +24,20 @@ export interface RegisterSchemaVersionCommandOutput extends RegisterSchemaVersio *

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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { GlueClient, RegisterSchemaVersionCommand } from "@aws-sdk/client-glue"; // ES Modules import + * // const { GlueClient, RegisterSchemaVersionCommand } = require("@aws-sdk/client-glue"); // CommonJS import + * const client = new GlueClient(config); + * const command = new RegisterSchemaVersionCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link RegisterSchemaVersionCommandInput} for command's `input` shape. + * @see {@link RegisterSchemaVersionCommandOutput} for command's `response` shape. + * @see {@link GlueClientResolvedConfig | config} for command's `input` shape. + * */ export class RegisterSchemaVersionCommand extends $Command< RegisterSchemaVersionCommandInput, diff --git a/clients/client-glue/commands/RemoveSchemaVersionMetadataCommand.ts b/clients/client-glue/commands/RemoveSchemaVersionMetadataCommand.ts index 0ef1c912f0a8..4409880705d7 100644 --- a/clients/client-glue/commands/RemoveSchemaVersionMetadataCommand.ts +++ b/clients/client-glue/commands/RemoveSchemaVersionMetadataCommand.ts @@ -24,6 +24,20 @@ export interface RemoveSchemaVersionMetadataCommandOutput /** *

Removes a key value pair from the schema version metadata for the specified schema version ID.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { GlueClient, RemoveSchemaVersionMetadataCommand } from "@aws-sdk/client-glue"; // ES Modules import + * // const { GlueClient, RemoveSchemaVersionMetadataCommand } = require("@aws-sdk/client-glue"); // CommonJS import + * const client = new GlueClient(config); + * const command = new RemoveSchemaVersionMetadataCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link RemoveSchemaVersionMetadataCommandInput} for command's `input` shape. + * @see {@link RemoveSchemaVersionMetadataCommandOutput} for command's `response` shape. + * @see {@link GlueClientResolvedConfig | config} for command's `input` shape. + * */ export class RemoveSchemaVersionMetadataCommand extends $Command< RemoveSchemaVersionMetadataCommandInput, diff --git a/clients/client-glue/commands/ResetJobBookmarkCommand.ts b/clients/client-glue/commands/ResetJobBookmarkCommand.ts index 4c8080f6f1c8..8efd430d27c9 100644 --- a/clients/client-glue/commands/ResetJobBookmarkCommand.ts +++ b/clients/client-glue/commands/ResetJobBookmarkCommand.ts @@ -22,6 +22,20 @@ export interface ResetJobBookmarkCommandOutput extends ResetJobBookmarkResponse, /** *

Resets a bookmark entry.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { GlueClient, ResetJobBookmarkCommand } from "@aws-sdk/client-glue"; // ES Modules import + * // const { GlueClient, ResetJobBookmarkCommand } = require("@aws-sdk/client-glue"); // CommonJS import + * const client = new GlueClient(config); + * const command = new ResetJobBookmarkCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ResetJobBookmarkCommandInput} for command's `input` shape. + * @see {@link ResetJobBookmarkCommandOutput} for command's `response` shape. + * @see {@link GlueClientResolvedConfig | config} for command's `input` shape. + * */ export class ResetJobBookmarkCommand extends $Command< ResetJobBookmarkCommandInput, diff --git a/clients/client-glue/commands/ResumeWorkflowRunCommand.ts b/clients/client-glue/commands/ResumeWorkflowRunCommand.ts index 77078355c07c..7389cfda735f 100644 --- a/clients/client-glue/commands/ResumeWorkflowRunCommand.ts +++ b/clients/client-glue/commands/ResumeWorkflowRunCommand.ts @@ -22,6 +22,20 @@ export interface ResumeWorkflowRunCommandOutput extends ResumeWorkflowRunRespons /** *

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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { GlueClient, ResumeWorkflowRunCommand } from "@aws-sdk/client-glue"; // ES Modules import + * // const { GlueClient, ResumeWorkflowRunCommand } = require("@aws-sdk/client-glue"); // CommonJS import + * const client = new GlueClient(config); + * const command = new ResumeWorkflowRunCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ResumeWorkflowRunCommandInput} for command's `input` shape. + * @see {@link ResumeWorkflowRunCommandOutput} for command's `response` shape. + * @see {@link GlueClientResolvedConfig | config} for command's `input` shape. + * */ export class ResumeWorkflowRunCommand extends $Command< ResumeWorkflowRunCommandInput, diff --git a/clients/client-glue/commands/SearchTablesCommand.ts b/clients/client-glue/commands/SearchTablesCommand.ts index c86106a32284..1102b379c71e 100644 --- a/clients/client-glue/commands/SearchTablesCommand.ts +++ b/clients/client-glue/commands/SearchTablesCommand.ts @@ -23,6 +23,20 @@ export interface SearchTablesCommandOutput extends SearchTablesResponse, __Metad /** *

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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { GlueClient, SearchTablesCommand } from "@aws-sdk/client-glue"; // ES Modules import + * // const { GlueClient, SearchTablesCommand } = require("@aws-sdk/client-glue"); // CommonJS import + * const client = new GlueClient(config); + * const command = new SearchTablesCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link SearchTablesCommandInput} for command's `input` shape. + * @see {@link SearchTablesCommandOutput} for command's `response` shape. + * @see {@link GlueClientResolvedConfig | config} for command's `input` shape. + * */ export class SearchTablesCommand extends $Command< SearchTablesCommandInput, diff --git a/clients/client-glue/commands/StartCrawlerCommand.ts b/clients/client-glue/commands/StartCrawlerCommand.ts index 177e01a49e34..70ce73efd402 100644 --- a/clients/client-glue/commands/StartCrawlerCommand.ts +++ b/clients/client-glue/commands/StartCrawlerCommand.ts @@ -24,6 +24,20 @@ export interface StartCrawlerCommandOutput extends StartCrawlerResponse, __Metad *

Starts a crawl using the specified crawler, regardless * of what is scheduled. If the crawler is already running, returns a * CrawlerRunningException.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { GlueClient, StartCrawlerCommand } from "@aws-sdk/client-glue"; // ES Modules import + * // const { GlueClient, StartCrawlerCommand } = require("@aws-sdk/client-glue"); // CommonJS import + * const client = new GlueClient(config); + * const command = new StartCrawlerCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link StartCrawlerCommandInput} for command's `input` shape. + * @see {@link StartCrawlerCommandOutput} for command's `response` shape. + * @see {@link GlueClientResolvedConfig | config} for command's `input` shape. + * */ export class StartCrawlerCommand extends $Command< StartCrawlerCommandInput, diff --git a/clients/client-glue/commands/StartCrawlerScheduleCommand.ts b/clients/client-glue/commands/StartCrawlerScheduleCommand.ts index a71efd84df50..4b5170a41641 100644 --- a/clients/client-glue/commands/StartCrawlerScheduleCommand.ts +++ b/clients/client-glue/commands/StartCrawlerScheduleCommand.ts @@ -24,6 +24,20 @@ export interface StartCrawlerScheduleCommandOutput extends StartCrawlerScheduleR *

Changes the schedule state of the specified crawler to * SCHEDULED, unless the crawler is already running or the * schedule state is already SCHEDULED.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { GlueClient, StartCrawlerScheduleCommand } from "@aws-sdk/client-glue"; // ES Modules import + * // const { GlueClient, StartCrawlerScheduleCommand } = require("@aws-sdk/client-glue"); // CommonJS import + * const client = new GlueClient(config); + * const command = new StartCrawlerScheduleCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link StartCrawlerScheduleCommandInput} for command's `input` shape. + * @see {@link StartCrawlerScheduleCommandOutput} for command's `response` shape. + * @see {@link GlueClientResolvedConfig | config} for command's `input` shape. + * */ export class StartCrawlerScheduleCommand extends $Command< StartCrawlerScheduleCommandInput, diff --git a/clients/client-glue/commands/StartExportLabelsTaskRunCommand.ts b/clients/client-glue/commands/StartExportLabelsTaskRunCommand.ts index ad6aa53c9ac4..53b391b69d8c 100644 --- a/clients/client-glue/commands/StartExportLabelsTaskRunCommand.ts +++ b/clients/client-glue/commands/StartExportLabelsTaskRunCommand.ts @@ -30,6 +30,20 @@ export interface StartExportLabelsTaskRunCommandOutput extends StartExportLabels * 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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { GlueClient, StartExportLabelsTaskRunCommand } from "@aws-sdk/client-glue"; // ES Modules import + * // const { GlueClient, StartExportLabelsTaskRunCommand } = require("@aws-sdk/client-glue"); // CommonJS import + * const client = new GlueClient(config); + * const command = new StartExportLabelsTaskRunCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link StartExportLabelsTaskRunCommandInput} for command's `input` shape. + * @see {@link StartExportLabelsTaskRunCommandOutput} for command's `response` shape. + * @see {@link GlueClientResolvedConfig | config} for command's `input` shape. + * */ export class StartExportLabelsTaskRunCommand extends $Command< StartExportLabelsTaskRunCommandInput, diff --git a/clients/client-glue/commands/StartImportLabelsTaskRunCommand.ts b/clients/client-glue/commands/StartImportLabelsTaskRunCommand.ts index ea3b7fbd430a..44243061fe39 100644 --- a/clients/client-glue/commands/StartImportLabelsTaskRunCommand.ts +++ b/clients/client-glue/commands/StartImportLabelsTaskRunCommand.ts @@ -46,6 +46,20 @@ export interface StartImportLabelsTaskRunCommandOutput extends StartImportLabels * *

You can check on the status of your task run by calling the GetMLTaskRun * operation.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { GlueClient, StartImportLabelsTaskRunCommand } from "@aws-sdk/client-glue"; // ES Modules import + * // const { GlueClient, StartImportLabelsTaskRunCommand } = require("@aws-sdk/client-glue"); // CommonJS import + * const client = new GlueClient(config); + * const command = new StartImportLabelsTaskRunCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link StartImportLabelsTaskRunCommandInput} for command's `input` shape. + * @see {@link StartImportLabelsTaskRunCommandOutput} for command's `response` shape. + * @see {@link GlueClientResolvedConfig | config} for command's `input` shape. + * */ export class StartImportLabelsTaskRunCommand extends $Command< StartImportLabelsTaskRunCommandInput, diff --git a/clients/client-glue/commands/StartJobRunCommand.ts b/clients/client-glue/commands/StartJobRunCommand.ts index e22629eba977..3fa51627d62a 100644 --- a/clients/client-glue/commands/StartJobRunCommand.ts +++ b/clients/client-glue/commands/StartJobRunCommand.ts @@ -22,6 +22,20 @@ export interface StartJobRunCommandOutput extends StartJobRunResponse, __Metadat /** *

Starts a job run using a job definition.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { GlueClient, StartJobRunCommand } from "@aws-sdk/client-glue"; // ES Modules import + * // const { GlueClient, StartJobRunCommand } = require("@aws-sdk/client-glue"); // CommonJS import + * const client = new GlueClient(config); + * const command = new StartJobRunCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link StartJobRunCommandInput} for command's `input` shape. + * @see {@link StartJobRunCommandOutput} for command's `response` shape. + * @see {@link GlueClientResolvedConfig | config} for command's `input` shape. + * */ export class StartJobRunCommand extends $Command< StartJobRunCommandInput, diff --git a/clients/client-glue/commands/StartMLEvaluationTaskRunCommand.ts b/clients/client-glue/commands/StartMLEvaluationTaskRunCommand.ts index cf360bf1f14c..4ccfc1dfaf3e 100644 --- a/clients/client-glue/commands/StartMLEvaluationTaskRunCommand.ts +++ b/clients/client-glue/commands/StartMLEvaluationTaskRunCommand.ts @@ -29,6 +29,20 @@ export interface StartMLEvaluationTaskRunCommandOutput extends StartMLEvaluation * *

Returns a unique identifier for the run. You can call GetMLTaskRun to get more * information about the stats of the EvaluationTaskRun.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { GlueClient, StartMLEvaluationTaskRunCommand } from "@aws-sdk/client-glue"; // ES Modules import + * // const { GlueClient, StartMLEvaluationTaskRunCommand } = require("@aws-sdk/client-glue"); // CommonJS import + * const client = new GlueClient(config); + * const command = new StartMLEvaluationTaskRunCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link StartMLEvaluationTaskRunCommandInput} for command's `input` shape. + * @see {@link StartMLEvaluationTaskRunCommandOutput} for command's `response` shape. + * @see {@link GlueClientResolvedConfig | config} for command's `input` shape. + * */ export class StartMLEvaluationTaskRunCommand extends $Command< StartMLEvaluationTaskRunCommandInput, diff --git a/clients/client-glue/commands/StartMLLabelingSetGenerationTaskRunCommand.ts b/clients/client-glue/commands/StartMLLabelingSetGenerationTaskRunCommand.ts index 330a620548d2..188bbbe0f1ef 100644 --- a/clients/client-glue/commands/StartMLLabelingSetGenerationTaskRunCommand.ts +++ b/clients/client-glue/commands/StartMLLabelingSetGenerationTaskRunCommand.ts @@ -40,6 +40,20 @@ export interface StartMLLabelingSetGenerationTaskRunCommandOutput * 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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { GlueClient, StartMLLabelingSetGenerationTaskRunCommand } from "@aws-sdk/client-glue"; // ES Modules import + * // const { GlueClient, StartMLLabelingSetGenerationTaskRunCommand } = require("@aws-sdk/client-glue"); // CommonJS import + * const client = new GlueClient(config); + * const command = new StartMLLabelingSetGenerationTaskRunCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link StartMLLabelingSetGenerationTaskRunCommandInput} for command's `input` shape. + * @see {@link StartMLLabelingSetGenerationTaskRunCommandOutput} for command's `response` shape. + * @see {@link GlueClientResolvedConfig | config} for command's `input` shape. + * */ export class StartMLLabelingSetGenerationTaskRunCommand extends $Command< StartMLLabelingSetGenerationTaskRunCommandInput, diff --git a/clients/client-glue/commands/StartTriggerCommand.ts b/clients/client-glue/commands/StartTriggerCommand.ts index f0a575e1f37d..2754c0ba5fd9 100644 --- a/clients/client-glue/commands/StartTriggerCommand.ts +++ b/clients/client-glue/commands/StartTriggerCommand.ts @@ -24,6 +24,20 @@ export interface StartTriggerCommandOutput extends StartTriggerResponse, __Metad *

Starts an existing trigger. See Triggering * Jobs for information about how different types of trigger are * started.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { GlueClient, StartTriggerCommand } from "@aws-sdk/client-glue"; // ES Modules import + * // const { GlueClient, StartTriggerCommand } = require("@aws-sdk/client-glue"); // CommonJS import + * const client = new GlueClient(config); + * const command = new StartTriggerCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link StartTriggerCommandInput} for command's `input` shape. + * @see {@link StartTriggerCommandOutput} for command's `response` shape. + * @see {@link GlueClientResolvedConfig | config} for command's `input` shape. + * */ export class StartTriggerCommand extends $Command< StartTriggerCommandInput, diff --git a/clients/client-glue/commands/StartWorkflowRunCommand.ts b/clients/client-glue/commands/StartWorkflowRunCommand.ts index 83a0eef12b92..7c4e8eb7cd30 100644 --- a/clients/client-glue/commands/StartWorkflowRunCommand.ts +++ b/clients/client-glue/commands/StartWorkflowRunCommand.ts @@ -22,6 +22,20 @@ export interface StartWorkflowRunCommandOutput extends StartWorkflowRunResponse, /** *

Starts a new run of the specified workflow.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { GlueClient, StartWorkflowRunCommand } from "@aws-sdk/client-glue"; // ES Modules import + * // const { GlueClient, StartWorkflowRunCommand } = require("@aws-sdk/client-glue"); // CommonJS import + * const client = new GlueClient(config); + * const command = new StartWorkflowRunCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link StartWorkflowRunCommandInput} for command's `input` shape. + * @see {@link StartWorkflowRunCommandOutput} for command's `response` shape. + * @see {@link GlueClientResolvedConfig | config} for command's `input` shape. + * */ export class StartWorkflowRunCommand extends $Command< StartWorkflowRunCommandInput, diff --git a/clients/client-glue/commands/StopCrawlerCommand.ts b/clients/client-glue/commands/StopCrawlerCommand.ts index 792556878cff..595db121cfc5 100644 --- a/clients/client-glue/commands/StopCrawlerCommand.ts +++ b/clients/client-glue/commands/StopCrawlerCommand.ts @@ -22,6 +22,20 @@ export interface StopCrawlerCommandOutput extends StopCrawlerResponse, __Metadat /** *

If the specified crawler is running, stops the crawl.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { GlueClient, StopCrawlerCommand } from "@aws-sdk/client-glue"; // ES Modules import + * // const { GlueClient, StopCrawlerCommand } = require("@aws-sdk/client-glue"); // CommonJS import + * const client = new GlueClient(config); + * const command = new StopCrawlerCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link StopCrawlerCommandInput} for command's `input` shape. + * @see {@link StopCrawlerCommandOutput} for command's `response` shape. + * @see {@link GlueClientResolvedConfig | config} for command's `input` shape. + * */ export class StopCrawlerCommand extends $Command< StopCrawlerCommandInput, diff --git a/clients/client-glue/commands/StopCrawlerScheduleCommand.ts b/clients/client-glue/commands/StopCrawlerScheduleCommand.ts index a40ef8f2e1c0..d5e50366281c 100644 --- a/clients/client-glue/commands/StopCrawlerScheduleCommand.ts +++ b/clients/client-glue/commands/StopCrawlerScheduleCommand.ts @@ -24,6 +24,20 @@ export interface StopCrawlerScheduleCommandOutput extends StopCrawlerScheduleRes *

Sets the schedule state of the specified crawler to * NOT_SCHEDULED, but does not stop the crawler if it is * already running.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { GlueClient, StopCrawlerScheduleCommand } from "@aws-sdk/client-glue"; // ES Modules import + * // const { GlueClient, StopCrawlerScheduleCommand } = require("@aws-sdk/client-glue"); // CommonJS import + * const client = new GlueClient(config); + * const command = new StopCrawlerScheduleCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link StopCrawlerScheduleCommandInput} for command's `input` shape. + * @see {@link StopCrawlerScheduleCommandOutput} for command's `response` shape. + * @see {@link GlueClientResolvedConfig | config} for command's `input` shape. + * */ export class StopCrawlerScheduleCommand extends $Command< StopCrawlerScheduleCommandInput, diff --git a/clients/client-glue/commands/StopTriggerCommand.ts b/clients/client-glue/commands/StopTriggerCommand.ts index 568e2902567b..c2d081854f84 100644 --- a/clients/client-glue/commands/StopTriggerCommand.ts +++ b/clients/client-glue/commands/StopTriggerCommand.ts @@ -22,6 +22,20 @@ export interface StopTriggerCommandOutput extends StopTriggerResponse, __Metadat /** *

Stops a specified trigger.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { GlueClient, StopTriggerCommand } from "@aws-sdk/client-glue"; // ES Modules import + * // const { GlueClient, StopTriggerCommand } = require("@aws-sdk/client-glue"); // CommonJS import + * const client = new GlueClient(config); + * const command = new StopTriggerCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link StopTriggerCommandInput} for command's `input` shape. + * @see {@link StopTriggerCommandOutput} for command's `response` shape. + * @see {@link GlueClientResolvedConfig | config} for command's `input` shape. + * */ export class StopTriggerCommand extends $Command< StopTriggerCommandInput, diff --git a/clients/client-glue/commands/StopWorkflowRunCommand.ts b/clients/client-glue/commands/StopWorkflowRunCommand.ts index c68686ba59fe..7ad51b7bec2f 100644 --- a/clients/client-glue/commands/StopWorkflowRunCommand.ts +++ b/clients/client-glue/commands/StopWorkflowRunCommand.ts @@ -22,6 +22,20 @@ export interface StopWorkflowRunCommandOutput extends StopWorkflowRunResponse, _ /** *

Stops the execution of the specified workflow run.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { GlueClient, StopWorkflowRunCommand } from "@aws-sdk/client-glue"; // ES Modules import + * // const { GlueClient, StopWorkflowRunCommand } = require("@aws-sdk/client-glue"); // CommonJS import + * const client = new GlueClient(config); + * const command = new StopWorkflowRunCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link StopWorkflowRunCommandInput} for command's `input` shape. + * @see {@link StopWorkflowRunCommandOutput} for command's `response` shape. + * @see {@link GlueClientResolvedConfig | config} for command's `input` shape. + * */ export class StopWorkflowRunCommand extends $Command< StopWorkflowRunCommandInput, diff --git a/clients/client-glue/commands/TagResourceCommand.ts b/clients/client-glue/commands/TagResourceCommand.ts index 51d73421608c..2d7b04e50b0b 100644 --- a/clients/client-glue/commands/TagResourceCommand.ts +++ b/clients/client-glue/commands/TagResourceCommand.ts @@ -24,6 +24,20 @@ export interface TagResourceCommandOutput extends TagResourceResponse, __Metadat *

Adds tags to a resource. A tag is a label you can assign to an AWS resource. * In AWS Glue, you can tag only certain resources. For information about what * resources you can tag, see AWS Tags in AWS Glue.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { GlueClient, TagResourceCommand } from "@aws-sdk/client-glue"; // ES Modules import + * // const { GlueClient, TagResourceCommand } = require("@aws-sdk/client-glue"); // CommonJS import + * const client = new GlueClient(config); + * const command = new TagResourceCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link TagResourceCommandInput} for command's `input` shape. + * @see {@link TagResourceCommandOutput} for command's `response` shape. + * @see {@link GlueClientResolvedConfig | config} for command's `input` shape. + * */ export class TagResourceCommand extends $Command< TagResourceCommandInput, diff --git a/clients/client-glue/commands/UntagResourceCommand.ts b/clients/client-glue/commands/UntagResourceCommand.ts index 411890536d0b..28368de3c16c 100644 --- a/clients/client-glue/commands/UntagResourceCommand.ts +++ b/clients/client-glue/commands/UntagResourceCommand.ts @@ -22,6 +22,20 @@ export interface UntagResourceCommandOutput extends UntagResourceResponse, __Met /** *

Removes tags from a resource.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { GlueClient, UntagResourceCommand } from "@aws-sdk/client-glue"; // ES Modules import + * // const { GlueClient, UntagResourceCommand } = require("@aws-sdk/client-glue"); // CommonJS import + * const client = new GlueClient(config); + * const command = new UntagResourceCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link UntagResourceCommandInput} for command's `input` shape. + * @see {@link UntagResourceCommandOutput} for command's `response` shape. + * @see {@link GlueClientResolvedConfig | config} for command's `input` shape. + * */ export class UntagResourceCommand extends $Command< UntagResourceCommandInput, diff --git a/clients/client-glue/commands/UpdateClassifierCommand.ts b/clients/client-glue/commands/UpdateClassifierCommand.ts index 8780fab263d7..1349ce0df5dc 100644 --- a/clients/client-glue/commands/UpdateClassifierCommand.ts +++ b/clients/client-glue/commands/UpdateClassifierCommand.ts @@ -24,6 +24,20 @@ export interface UpdateClassifierCommandOutput extends UpdateClassifierResponse, *

Modifies an existing classifier (a GrokClassifier, * an XMLClassifier, a JsonClassifier, or a CsvClassifier, depending on * which field is present).

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { GlueClient, UpdateClassifierCommand } from "@aws-sdk/client-glue"; // ES Modules import + * // const { GlueClient, UpdateClassifierCommand } = require("@aws-sdk/client-glue"); // CommonJS import + * const client = new GlueClient(config); + * const command = new UpdateClassifierCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link UpdateClassifierCommandInput} for command's `input` shape. + * @see {@link UpdateClassifierCommandOutput} for command's `response` shape. + * @see {@link GlueClientResolvedConfig | config} for command's `input` shape. + * */ export class UpdateClassifierCommand extends $Command< UpdateClassifierCommandInput, diff --git a/clients/client-glue/commands/UpdateColumnStatisticsForPartitionCommand.ts b/clients/client-glue/commands/UpdateColumnStatisticsForPartitionCommand.ts index b452b0454d4c..e2915d6d6f70 100644 --- a/clients/client-glue/commands/UpdateColumnStatisticsForPartitionCommand.ts +++ b/clients/client-glue/commands/UpdateColumnStatisticsForPartitionCommand.ts @@ -29,6 +29,20 @@ export interface UpdateColumnStatisticsForPartitionCommandOutput *

Creates or updates partition statistics of columns.

* *

The Identity and Access Management (IAM) permission required for this operation is UpdatePartition.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { GlueClient, UpdateColumnStatisticsForPartitionCommand } from "@aws-sdk/client-glue"; // ES Modules import + * // const { GlueClient, UpdateColumnStatisticsForPartitionCommand } = require("@aws-sdk/client-glue"); // CommonJS import + * const client = new GlueClient(config); + * const command = new UpdateColumnStatisticsForPartitionCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link UpdateColumnStatisticsForPartitionCommandInput} for command's `input` shape. + * @see {@link UpdateColumnStatisticsForPartitionCommandOutput} for command's `response` shape. + * @see {@link GlueClientResolvedConfig | config} for command's `input` shape. + * */ export class UpdateColumnStatisticsForPartitionCommand extends $Command< UpdateColumnStatisticsForPartitionCommandInput, diff --git a/clients/client-glue/commands/UpdateColumnStatisticsForTableCommand.ts b/clients/client-glue/commands/UpdateColumnStatisticsForTableCommand.ts index 83b9d486119a..0480b332706c 100644 --- a/clients/client-glue/commands/UpdateColumnStatisticsForTableCommand.ts +++ b/clients/client-glue/commands/UpdateColumnStatisticsForTableCommand.ts @@ -26,6 +26,20 @@ export interface UpdateColumnStatisticsForTableCommandOutput *

Creates or updates table statistics of columns.

* *

The Identity and Access Management (IAM) permission required for this operation is UpdateTable.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { GlueClient, UpdateColumnStatisticsForTableCommand } from "@aws-sdk/client-glue"; // ES Modules import + * // const { GlueClient, UpdateColumnStatisticsForTableCommand } = require("@aws-sdk/client-glue"); // CommonJS import + * const client = new GlueClient(config); + * const command = new UpdateColumnStatisticsForTableCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link UpdateColumnStatisticsForTableCommandInput} for command's `input` shape. + * @see {@link UpdateColumnStatisticsForTableCommandOutput} for command's `response` shape. + * @see {@link GlueClientResolvedConfig | config} for command's `input` shape. + * */ export class UpdateColumnStatisticsForTableCommand extends $Command< UpdateColumnStatisticsForTableCommandInput, diff --git a/clients/client-glue/commands/UpdateConnectionCommand.ts b/clients/client-glue/commands/UpdateConnectionCommand.ts index 199f6de3b3ae..d64aa16b179b 100644 --- a/clients/client-glue/commands/UpdateConnectionCommand.ts +++ b/clients/client-glue/commands/UpdateConnectionCommand.ts @@ -22,6 +22,20 @@ export interface UpdateConnectionCommandOutput extends UpdateConnectionResponse, /** *

Updates a connection definition in the Data Catalog.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { GlueClient, UpdateConnectionCommand } from "@aws-sdk/client-glue"; // ES Modules import + * // const { GlueClient, UpdateConnectionCommand } = require("@aws-sdk/client-glue"); // CommonJS import + * const client = new GlueClient(config); + * const command = new UpdateConnectionCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link UpdateConnectionCommandInput} for command's `input` shape. + * @see {@link UpdateConnectionCommandOutput} for command's `response` shape. + * @see {@link GlueClientResolvedConfig | config} for command's `input` shape. + * */ export class UpdateConnectionCommand extends $Command< UpdateConnectionCommandInput, diff --git a/clients/client-glue/commands/UpdateCrawlerCommand.ts b/clients/client-glue/commands/UpdateCrawlerCommand.ts index ba1ae0d53884..c66197c291cd 100644 --- a/clients/client-glue/commands/UpdateCrawlerCommand.ts +++ b/clients/client-glue/commands/UpdateCrawlerCommand.ts @@ -24,6 +24,20 @@ export interface UpdateCrawlerCommandOutput extends UpdateCrawlerResponse, __Met *

Updates a crawler. If a crawler is * running, you must stop it using StopCrawler before updating * it.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { GlueClient, UpdateCrawlerCommand } from "@aws-sdk/client-glue"; // ES Modules import + * // const { GlueClient, UpdateCrawlerCommand } = require("@aws-sdk/client-glue"); // CommonJS import + * const client = new GlueClient(config); + * const command = new UpdateCrawlerCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link UpdateCrawlerCommandInput} for command's `input` shape. + * @see {@link UpdateCrawlerCommandOutput} for command's `response` shape. + * @see {@link GlueClientResolvedConfig | config} for command's `input` shape. + * */ export class UpdateCrawlerCommand extends $Command< UpdateCrawlerCommandInput, diff --git a/clients/client-glue/commands/UpdateCrawlerScheduleCommand.ts b/clients/client-glue/commands/UpdateCrawlerScheduleCommand.ts index 12a08c4c0a77..81beb9b71dff 100644 --- a/clients/client-glue/commands/UpdateCrawlerScheduleCommand.ts +++ b/clients/client-glue/commands/UpdateCrawlerScheduleCommand.ts @@ -22,6 +22,20 @@ export interface UpdateCrawlerScheduleCommandOutput extends UpdateCrawlerSchedul /** *

Updates the schedule of a crawler using a cron expression.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { GlueClient, UpdateCrawlerScheduleCommand } from "@aws-sdk/client-glue"; // ES Modules import + * // const { GlueClient, UpdateCrawlerScheduleCommand } = require("@aws-sdk/client-glue"); // CommonJS import + * const client = new GlueClient(config); + * const command = new UpdateCrawlerScheduleCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link UpdateCrawlerScheduleCommandInput} for command's `input` shape. + * @see {@link UpdateCrawlerScheduleCommandOutput} for command's `response` shape. + * @see {@link GlueClientResolvedConfig | config} for command's `input` shape. + * */ export class UpdateCrawlerScheduleCommand extends $Command< UpdateCrawlerScheduleCommandInput, diff --git a/clients/client-glue/commands/UpdateDatabaseCommand.ts b/clients/client-glue/commands/UpdateDatabaseCommand.ts index 317541e6e54b..17f5cb11e0b4 100644 --- a/clients/client-glue/commands/UpdateDatabaseCommand.ts +++ b/clients/client-glue/commands/UpdateDatabaseCommand.ts @@ -22,6 +22,20 @@ export interface UpdateDatabaseCommandOutput extends UpdateDatabaseResponse, __M /** *

Updates an existing database definition in a Data Catalog.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { GlueClient, UpdateDatabaseCommand } from "@aws-sdk/client-glue"; // ES Modules import + * // const { GlueClient, UpdateDatabaseCommand } = require("@aws-sdk/client-glue"); // CommonJS import + * const client = new GlueClient(config); + * const command = new UpdateDatabaseCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link UpdateDatabaseCommandInput} for command's `input` shape. + * @see {@link UpdateDatabaseCommandOutput} for command's `response` shape. + * @see {@link GlueClientResolvedConfig | config} for command's `input` shape. + * */ export class UpdateDatabaseCommand extends $Command< UpdateDatabaseCommandInput, diff --git a/clients/client-glue/commands/UpdateDevEndpointCommand.ts b/clients/client-glue/commands/UpdateDevEndpointCommand.ts index bfc6f6dbf336..1b211179a4e9 100644 --- a/clients/client-glue/commands/UpdateDevEndpointCommand.ts +++ b/clients/client-glue/commands/UpdateDevEndpointCommand.ts @@ -22,6 +22,20 @@ export interface UpdateDevEndpointCommandOutput extends UpdateDevEndpointRespons /** *

Updates a specified development endpoint.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { GlueClient, UpdateDevEndpointCommand } from "@aws-sdk/client-glue"; // ES Modules import + * // const { GlueClient, UpdateDevEndpointCommand } = require("@aws-sdk/client-glue"); // CommonJS import + * const client = new GlueClient(config); + * const command = new UpdateDevEndpointCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link UpdateDevEndpointCommandInput} for command's `input` shape. + * @see {@link UpdateDevEndpointCommandOutput} for command's `response` shape. + * @see {@link GlueClientResolvedConfig | config} for command's `input` shape. + * */ export class UpdateDevEndpointCommand extends $Command< UpdateDevEndpointCommandInput, diff --git a/clients/client-glue/commands/UpdateJobCommand.ts b/clients/client-glue/commands/UpdateJobCommand.ts index 081121daec20..bba900eb3e61 100644 --- a/clients/client-glue/commands/UpdateJobCommand.ts +++ b/clients/client-glue/commands/UpdateJobCommand.ts @@ -19,6 +19,20 @@ export interface UpdateJobCommandOutput extends UpdateJobResponse, __MetadataBea /** *

Updates an existing job definition.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { GlueClient, UpdateJobCommand } from "@aws-sdk/client-glue"; // ES Modules import + * // const { GlueClient, UpdateJobCommand } = require("@aws-sdk/client-glue"); // CommonJS import + * const client = new GlueClient(config); + * const command = new UpdateJobCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link UpdateJobCommandInput} for command's `input` shape. + * @see {@link UpdateJobCommandOutput} for command's `response` shape. + * @see {@link GlueClientResolvedConfig | config} for command's `input` shape. + * */ export class UpdateJobCommand extends $Command< UpdateJobCommandInput, diff --git a/clients/client-glue/commands/UpdateMLTransformCommand.ts b/clients/client-glue/commands/UpdateMLTransformCommand.ts index 0e2b1bdd5fcb..a0dc48d7d7f7 100644 --- a/clients/client-glue/commands/UpdateMLTransformCommand.ts +++ b/clients/client-glue/commands/UpdateMLTransformCommand.ts @@ -26,6 +26,20 @@ export interface UpdateMLTransformCommandOutput extends UpdateMLTransformRespons *

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).

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { GlueClient, UpdateMLTransformCommand } from "@aws-sdk/client-glue"; // ES Modules import + * // const { GlueClient, UpdateMLTransformCommand } = require("@aws-sdk/client-glue"); // CommonJS import + * const client = new GlueClient(config); + * const command = new UpdateMLTransformCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link UpdateMLTransformCommandInput} for command's `input` shape. + * @see {@link UpdateMLTransformCommandOutput} for command's `response` shape. + * @see {@link GlueClientResolvedConfig | config} for command's `input` shape. + * */ export class UpdateMLTransformCommand extends $Command< UpdateMLTransformCommandInput, diff --git a/clients/client-glue/commands/UpdatePartitionCommand.ts b/clients/client-glue/commands/UpdatePartitionCommand.ts index 4a3aa6ee10b7..da14e2885ab4 100644 --- a/clients/client-glue/commands/UpdatePartitionCommand.ts +++ b/clients/client-glue/commands/UpdatePartitionCommand.ts @@ -22,6 +22,20 @@ export interface UpdatePartitionCommandOutput extends UpdatePartitionResponse, _ /** *

Updates a partition.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { GlueClient, UpdatePartitionCommand } from "@aws-sdk/client-glue"; // ES Modules import + * // const { GlueClient, UpdatePartitionCommand } = require("@aws-sdk/client-glue"); // CommonJS import + * const client = new GlueClient(config); + * const command = new UpdatePartitionCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link UpdatePartitionCommandInput} for command's `input` shape. + * @see {@link UpdatePartitionCommandOutput} for command's `response` shape. + * @see {@link GlueClientResolvedConfig | config} for command's `input` shape. + * */ export class UpdatePartitionCommand extends $Command< UpdatePartitionCommandInput, diff --git a/clients/client-glue/commands/UpdateRegistryCommand.ts b/clients/client-glue/commands/UpdateRegistryCommand.ts index ad28685ae3ac..ee75e725c307 100644 --- a/clients/client-glue/commands/UpdateRegistryCommand.ts +++ b/clients/client-glue/commands/UpdateRegistryCommand.ts @@ -22,6 +22,20 @@ export interface UpdateRegistryCommandOutput extends UpdateRegistryResponse, __M /** *

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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { GlueClient, UpdateRegistryCommand } from "@aws-sdk/client-glue"; // ES Modules import + * // const { GlueClient, UpdateRegistryCommand } = require("@aws-sdk/client-glue"); // CommonJS import + * const client = new GlueClient(config); + * const command = new UpdateRegistryCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link UpdateRegistryCommandInput} for command's `input` shape. + * @see {@link UpdateRegistryCommandOutput} for command's `response` shape. + * @see {@link GlueClientResolvedConfig | config} for command's `input` shape. + * */ export class UpdateRegistryCommand extends $Command< UpdateRegistryCommandInput, diff --git a/clients/client-glue/commands/UpdateSchemaCommand.ts b/clients/client-glue/commands/UpdateSchemaCommand.ts index fc3fe06581bd..b58eeaeefe23 100644 --- a/clients/client-glue/commands/UpdateSchemaCommand.ts +++ b/clients/client-glue/commands/UpdateSchemaCommand.ts @@ -25,6 +25,20 @@ export interface UpdateSchemaCommandOutput extends UpdateSchemaResponse, __Metad *

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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { GlueClient, UpdateSchemaCommand } from "@aws-sdk/client-glue"; // ES Modules import + * // const { GlueClient, UpdateSchemaCommand } = require("@aws-sdk/client-glue"); // CommonJS import + * const client = new GlueClient(config); + * const command = new UpdateSchemaCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link UpdateSchemaCommandInput} for command's `input` shape. + * @see {@link UpdateSchemaCommandOutput} for command's `response` shape. + * @see {@link GlueClientResolvedConfig | config} for command's `input` shape. + * */ export class UpdateSchemaCommand extends $Command< UpdateSchemaCommandInput, diff --git a/clients/client-glue/commands/UpdateTableCommand.ts b/clients/client-glue/commands/UpdateTableCommand.ts index 2339ea7453f1..01a16e9ed1b1 100644 --- a/clients/client-glue/commands/UpdateTableCommand.ts +++ b/clients/client-glue/commands/UpdateTableCommand.ts @@ -22,6 +22,20 @@ export interface UpdateTableCommandOutput extends UpdateTableResponse, __Metadat /** *

Updates a metadata table in the Data Catalog.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { GlueClient, UpdateTableCommand } from "@aws-sdk/client-glue"; // ES Modules import + * // const { GlueClient, UpdateTableCommand } = require("@aws-sdk/client-glue"); // CommonJS import + * const client = new GlueClient(config); + * const command = new UpdateTableCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link UpdateTableCommandInput} for command's `input` shape. + * @see {@link UpdateTableCommandOutput} for command's `response` shape. + * @see {@link GlueClientResolvedConfig | config} for command's `input` shape. + * */ export class UpdateTableCommand extends $Command< UpdateTableCommandInput, diff --git a/clients/client-glue/commands/UpdateTriggerCommand.ts b/clients/client-glue/commands/UpdateTriggerCommand.ts index 24abfa8bf34d..2bbd6702d382 100644 --- a/clients/client-glue/commands/UpdateTriggerCommand.ts +++ b/clients/client-glue/commands/UpdateTriggerCommand.ts @@ -22,6 +22,20 @@ export interface UpdateTriggerCommandOutput extends UpdateTriggerResponse, __Met /** *

Updates a trigger definition.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { GlueClient, UpdateTriggerCommand } from "@aws-sdk/client-glue"; // ES Modules import + * // const { GlueClient, UpdateTriggerCommand } = require("@aws-sdk/client-glue"); // CommonJS import + * const client = new GlueClient(config); + * const command = new UpdateTriggerCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link UpdateTriggerCommandInput} for command's `input` shape. + * @see {@link UpdateTriggerCommandOutput} for command's `response` shape. + * @see {@link GlueClientResolvedConfig | config} for command's `input` shape. + * */ export class UpdateTriggerCommand extends $Command< UpdateTriggerCommandInput, diff --git a/clients/client-glue/commands/UpdateUserDefinedFunctionCommand.ts b/clients/client-glue/commands/UpdateUserDefinedFunctionCommand.ts index 8946e660d080..68a1f19cd084 100644 --- a/clients/client-glue/commands/UpdateUserDefinedFunctionCommand.ts +++ b/clients/client-glue/commands/UpdateUserDefinedFunctionCommand.ts @@ -22,6 +22,20 @@ export interface UpdateUserDefinedFunctionCommandOutput extends UpdateUserDefine /** *

Updates an existing function definition in the Data Catalog.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { GlueClient, UpdateUserDefinedFunctionCommand } from "@aws-sdk/client-glue"; // ES Modules import + * // const { GlueClient, UpdateUserDefinedFunctionCommand } = require("@aws-sdk/client-glue"); // CommonJS import + * const client = new GlueClient(config); + * const command = new UpdateUserDefinedFunctionCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link UpdateUserDefinedFunctionCommandInput} for command's `input` shape. + * @see {@link UpdateUserDefinedFunctionCommandOutput} for command's `response` shape. + * @see {@link GlueClientResolvedConfig | config} for command's `input` shape. + * */ export class UpdateUserDefinedFunctionCommand extends $Command< UpdateUserDefinedFunctionCommandInput, diff --git a/clients/client-glue/commands/UpdateWorkflowCommand.ts b/clients/client-glue/commands/UpdateWorkflowCommand.ts index 5c1e802335ae..31ab39fb674e 100644 --- a/clients/client-glue/commands/UpdateWorkflowCommand.ts +++ b/clients/client-glue/commands/UpdateWorkflowCommand.ts @@ -22,6 +22,20 @@ export interface UpdateWorkflowCommandOutput extends UpdateWorkflowResponse, __M /** *

Updates an existing workflow.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { GlueClient, UpdateWorkflowCommand } from "@aws-sdk/client-glue"; // ES Modules import + * // const { GlueClient, UpdateWorkflowCommand } = require("@aws-sdk/client-glue"); // CommonJS import + * const client = new GlueClient(config); + * const command = new UpdateWorkflowCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link UpdateWorkflowCommandInput} for command's `input` shape. + * @see {@link UpdateWorkflowCommandOutput} for command's `response` shape. + * @see {@link GlueClientResolvedConfig | config} for command's `input` shape. + * */ export class UpdateWorkflowCommand extends $Command< UpdateWorkflowCommandInput, diff --git a/clients/client-glue/models/models_0.ts b/clients/client-glue/models/models_0.ts index 92ca9900b80a..6bdd30b12e45 100644 --- a/clients/client-glue/models/models_0.ts +++ b/clients/client-glue/models/models_0.ts @@ -14,6 +14,9 @@ export interface AccessDeniedException extends __SmithyException, $MetadataBeare } export namespace AccessDeniedException { + /** + * @internal + */ export const filterSensitiveLog = (obj: AccessDeniedException): any => ({ ...obj, }); @@ -31,6 +34,9 @@ export interface NotificationProperty { } export namespace NotificationProperty { + /** + * @internal + */ export const filterSensitiveLog = (obj: NotificationProperty): any => ({ ...obj, }); @@ -79,6 +85,9 @@ export interface Action { } export namespace Action { + /** + * @internal + */ export const filterSensitiveLog = (obj: Action): any => ({ ...obj, }); @@ -97,6 +106,9 @@ export interface AlreadyExistsException extends __SmithyException, $MetadataBear } export namespace AlreadyExistsException { + /** + * @internal + */ export const filterSensitiveLog = (obj: AlreadyExistsException): any => ({ ...obj, }); @@ -128,6 +140,9 @@ export interface Column { } export namespace Column { + /** + * @internal + */ export const filterSensitiveLog = (obj: Column): any => ({ ...obj, }); @@ -154,6 +169,9 @@ export interface SchemaId { } export namespace SchemaId { + /** + * @internal + */ export const filterSensitiveLog = (obj: SchemaId): any => ({ ...obj, }); @@ -180,6 +198,9 @@ export interface SchemaReference { } export namespace SchemaReference { + /** + * @internal + */ export const filterSensitiveLog = (obj: SchemaReference): any => ({ ...obj, }); @@ -208,6 +229,9 @@ export interface SerDeInfo { } export namespace SerDeInfo { + /** + * @internal + */ export const filterSensitiveLog = (obj: SerDeInfo): any => ({ ...obj, }); @@ -236,6 +260,9 @@ export interface SkewedInfo { } export namespace SkewedInfo { + /** + * @internal + */ export const filterSensitiveLog = (obj: SkewedInfo): any => ({ ...obj, }); @@ -258,6 +285,9 @@ export interface Order { } export namespace Order { + /** + * @internal + */ export const filterSensitiveLog = (obj: Order): any => ({ ...obj, }); @@ -345,6 +375,9 @@ export interface StorageDescriptor { } export namespace StorageDescriptor { + /** + * @internal + */ export const filterSensitiveLog = (obj: StorageDescriptor): any => ({ ...obj, }); @@ -384,6 +417,9 @@ export interface PartitionInput { } export namespace PartitionInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: PartitionInput): any => ({ ...obj, }); @@ -415,6 +451,9 @@ export interface BatchCreatePartitionRequest { } export namespace BatchCreatePartitionRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: BatchCreatePartitionRequest): any => ({ ...obj, }); @@ -436,6 +475,9 @@ export interface ErrorDetail { } export namespace ErrorDetail { + /** + * @internal + */ export const filterSensitiveLog = (obj: ErrorDetail): any => ({ ...obj, }); @@ -457,6 +499,9 @@ export interface PartitionError { } export namespace PartitionError { + /** + * @internal + */ export const filterSensitiveLog = (obj: PartitionError): any => ({ ...obj, }); @@ -470,6 +515,9 @@ export interface BatchCreatePartitionResponse { } export namespace BatchCreatePartitionResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: BatchCreatePartitionResponse): any => ({ ...obj, }); @@ -488,6 +536,9 @@ export interface EntityNotFoundException extends __SmithyException, $MetadataBea } export namespace EntityNotFoundException { + /** + * @internal + */ export const filterSensitiveLog = (obj: EntityNotFoundException): any => ({ ...obj, }); @@ -506,6 +557,9 @@ export interface GlueEncryptionException extends __SmithyException, $MetadataBea } export namespace GlueEncryptionException { + /** + * @internal + */ export const filterSensitiveLog = (obj: GlueEncryptionException): any => ({ ...obj, }); @@ -524,6 +578,9 @@ export interface InternalServiceException extends __SmithyException, $MetadataBe } export namespace InternalServiceException { + /** + * @internal + */ export const filterSensitiveLog = (obj: InternalServiceException): any => ({ ...obj, }); @@ -542,6 +599,9 @@ export interface InvalidInputException extends __SmithyException, $MetadataBeare } export namespace InvalidInputException { + /** + * @internal + */ export const filterSensitiveLog = (obj: InvalidInputException): any => ({ ...obj, }); @@ -560,6 +620,9 @@ export interface OperationTimeoutException extends __SmithyException, $MetadataB } export namespace OperationTimeoutException { + /** + * @internal + */ export const filterSensitiveLog = (obj: OperationTimeoutException): any => ({ ...obj, }); @@ -578,6 +641,9 @@ export interface ResourceNumberLimitExceededException extends __SmithyException, } export namespace ResourceNumberLimitExceededException { + /** + * @internal + */ export const filterSensitiveLog = (obj: ResourceNumberLimitExceededException): any => ({ ...obj, }); @@ -597,6 +663,9 @@ export interface BatchDeleteConnectionRequest { } export namespace BatchDeleteConnectionRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: BatchDeleteConnectionRequest): any => ({ ...obj, }); @@ -617,6 +686,9 @@ export interface BatchDeleteConnectionResponse { } export namespace BatchDeleteConnectionResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: BatchDeleteConnectionResponse): any => ({ ...obj, }); @@ -633,6 +705,9 @@ export interface PartitionValueList { } export namespace PartitionValueList { + /** + * @internal + */ export const filterSensitiveLog = (obj: PartitionValueList): any => ({ ...obj, }); @@ -664,6 +739,9 @@ export interface BatchDeletePartitionRequest { } export namespace BatchDeletePartitionRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: BatchDeletePartitionRequest): any => ({ ...obj, }); @@ -677,6 +755,9 @@ export interface BatchDeletePartitionResponse { } export namespace BatchDeletePartitionResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: BatchDeletePartitionResponse): any => ({ ...obj, }); @@ -702,6 +783,9 @@ export interface BatchDeleteTableRequest { } export namespace BatchDeleteTableRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: BatchDeleteTableRequest): any => ({ ...obj, }); @@ -723,6 +807,9 @@ export interface TableError { } export namespace TableError { + /** + * @internal + */ export const filterSensitiveLog = (obj: TableError): any => ({ ...obj, }); @@ -736,6 +823,9 @@ export interface BatchDeleteTableResponse { } export namespace BatchDeleteTableResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: BatchDeleteTableResponse): any => ({ ...obj, }); @@ -767,6 +857,9 @@ export interface BatchDeleteTableVersionRequest { } export namespace BatchDeleteTableVersionRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: BatchDeleteTableVersionRequest): any => ({ ...obj, }); @@ -793,6 +886,9 @@ export interface TableVersionError { } export namespace TableVersionError { + /** + * @internal + */ export const filterSensitiveLog = (obj: TableVersionError): any => ({ ...obj, }); @@ -807,6 +903,9 @@ export interface BatchDeleteTableVersionResponse { } export namespace BatchDeleteTableVersionResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: BatchDeleteTableVersionResponse): any => ({ ...obj, }); @@ -821,6 +920,9 @@ export interface BatchGetCrawlersRequest { } export namespace BatchGetCrawlersRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: BatchGetCrawlersRequest): any => ({ ...obj, }); @@ -868,6 +970,9 @@ export interface LastCrawlInfo { } export namespace LastCrawlInfo { + /** + * @internal + */ export const filterSensitiveLog = (obj: LastCrawlInfo): any => ({ ...obj, }); @@ -898,6 +1003,9 @@ export interface LineageConfiguration { } export namespace LineageConfiguration { + /** + * @internal + */ export const filterSensitiveLog = (obj: LineageConfiguration): any => ({ ...obj, }); @@ -923,6 +1031,9 @@ export interface RecrawlPolicy { } export namespace RecrawlPolicy { + /** + * @internal + */ export const filterSensitiveLog = (obj: RecrawlPolicy): any => ({ ...obj, }); @@ -952,6 +1063,9 @@ export interface Schedule { } export namespace Schedule { + /** + * @internal + */ export const filterSensitiveLog = (obj: Schedule): any => ({ ...obj, }); @@ -984,6 +1098,9 @@ export interface SchemaChangePolicy { } export namespace SchemaChangePolicy { + /** + * @internal + */ export const filterSensitiveLog = (obj: SchemaChangePolicy): any => ({ ...obj, }); @@ -1011,6 +1128,9 @@ export interface CatalogTarget { } export namespace CatalogTarget { + /** + * @internal + */ export const filterSensitiveLog = (obj: CatalogTarget): any => ({ ...obj, }); @@ -1041,6 +1161,9 @@ export interface DynamoDBTarget { } export namespace DynamoDBTarget { + /** + * @internal + */ export const filterSensitiveLog = (obj: DynamoDBTarget): any => ({ ...obj, }); @@ -1068,6 +1191,9 @@ export interface JdbcTarget { } export namespace JdbcTarget { + /** + * @internal + */ export const filterSensitiveLog = (obj: JdbcTarget): any => ({ ...obj, }); @@ -1096,6 +1222,9 @@ export interface MongoDBTarget { } export namespace MongoDBTarget { + /** + * @internal + */ export const filterSensitiveLog = (obj: MongoDBTarget): any => ({ ...obj, }); @@ -1123,6 +1252,9 @@ export interface S3Target { } export namespace S3Target { + /** + * @internal + */ export const filterSensitiveLog = (obj: S3Target): any => ({ ...obj, }); @@ -1159,6 +1291,9 @@ export interface CrawlerTargets { } export namespace CrawlerTargets { + /** + * @internal + */ export const filterSensitiveLog = (obj: CrawlerTargets): any => ({ ...obj, }); @@ -1274,6 +1409,9 @@ export interface Crawler { } export namespace Crawler { + /** + * @internal + */ export const filterSensitiveLog = (obj: Crawler): any => ({ ...obj, }); @@ -1292,6 +1430,9 @@ export interface BatchGetCrawlersResponse { } export namespace BatchGetCrawlersResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: BatchGetCrawlersResponse): any => ({ ...obj, }); @@ -1306,6 +1447,9 @@ export interface BatchGetDevEndpointsRequest { } export namespace BatchGetDevEndpointsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: BatchGetDevEndpointsRequest): any => ({ ...obj, }); @@ -1516,6 +1660,9 @@ export interface DevEndpoint { } export namespace DevEndpoint { + /** + * @internal + */ export const filterSensitiveLog = (obj: DevEndpoint): any => ({ ...obj, }); @@ -1534,6 +1681,9 @@ export interface BatchGetDevEndpointsResponse { } export namespace BatchGetDevEndpointsResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: BatchGetDevEndpointsResponse): any => ({ ...obj, }); @@ -1548,6 +1698,9 @@ export interface BatchGetJobsRequest { } export namespace BatchGetJobsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: BatchGetJobsRequest): any => ({ ...obj, }); @@ -1577,6 +1730,9 @@ export interface JobCommand { } export namespace JobCommand { + /** + * @internal + */ export const filterSensitiveLog = (obj: JobCommand): any => ({ ...obj, }); @@ -1593,6 +1749,9 @@ export interface ConnectionsList { } export namespace ConnectionsList { + /** + * @internal + */ export const filterSensitiveLog = (obj: ConnectionsList): any => ({ ...obj, }); @@ -1611,6 +1770,9 @@ export interface ExecutionProperty { } export namespace ExecutionProperty { + /** + * @internal + */ export const filterSensitiveLog = (obj: ExecutionProperty): any => ({ ...obj, }); @@ -1776,6 +1938,9 @@ export interface Job { } export namespace Job { + /** + * @internal + */ export const filterSensitiveLog = (obj: Job): any => ({ ...obj, }); @@ -1794,6 +1959,9 @@ export interface BatchGetJobsResponse { } export namespace BatchGetJobsResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: BatchGetJobsResponse): any => ({ ...obj, }); @@ -1823,6 +1991,9 @@ export interface BatchGetPartitionRequest { } export namespace BatchGetPartitionRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: BatchGetPartitionRequest): any => ({ ...obj, }); @@ -1881,6 +2052,9 @@ export interface Partition { } export namespace Partition { + /** + * @internal + */ export const filterSensitiveLog = (obj: Partition): any => ({ ...obj, }); @@ -1900,6 +2074,9 @@ export interface BatchGetPartitionResponse { } export namespace BatchGetPartitionResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: BatchGetPartitionResponse): any => ({ ...obj, }); @@ -1913,6 +2090,9 @@ export interface BatchGetTriggersRequest { } export namespace BatchGetTriggersRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: BatchGetTriggersRequest): any => ({ ...obj, }); @@ -1972,6 +2152,9 @@ export interface Condition { } export namespace Condition { + /** + * @internal + */ export const filterSensitiveLog = (obj: Condition): any => ({ ...obj, }); @@ -1999,6 +2182,9 @@ export interface Predicate { } export namespace Predicate { + /** + * @internal + */ export const filterSensitiveLog = (obj: Predicate): any => ({ ...obj, }); @@ -2075,6 +2261,9 @@ export interface Trigger { } export namespace Trigger { + /** + * @internal + */ export const filterSensitiveLog = (obj: Trigger): any => ({ ...obj, }); @@ -2093,6 +2282,9 @@ export interface BatchGetTriggersResponse { } export namespace BatchGetTriggersResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: BatchGetTriggersResponse): any => ({ ...obj, }); @@ -2111,6 +2303,9 @@ export interface BatchGetWorkflowsRequest { } export namespace BatchGetWorkflowsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: BatchGetWorkflowsRequest): any => ({ ...obj, }); @@ -2133,6 +2328,9 @@ export interface Edge { } export namespace Edge { + /** + * @internal + */ export const filterSensitiveLog = (obj: Edge): any => ({ ...obj, }); @@ -2174,6 +2372,9 @@ export interface Crawl { } export namespace Crawl { + /** + * @internal + */ export const filterSensitiveLog = (obj: Crawl): any => ({ ...obj, }); @@ -2190,6 +2391,9 @@ export interface CrawlerNodeDetails { } export namespace CrawlerNodeDetails { + /** + * @internal + */ export const filterSensitiveLog = (obj: CrawlerNodeDetails): any => ({ ...obj, }); @@ -2212,6 +2416,9 @@ export interface Predecessor { } export namespace Predecessor { + /** + * @internal + */ export const filterSensitiveLog = (obj: Predecessor): any => ({ ...obj, }); @@ -2388,6 +2595,9 @@ export interface JobRun { } export namespace JobRun { + /** + * @internal + */ export const filterSensitiveLog = (obj: JobRun): any => ({ ...obj, }); @@ -2404,6 +2614,9 @@ export interface JobNodeDetails { } export namespace JobNodeDetails { + /** + * @internal + */ export const filterSensitiveLog = (obj: JobNodeDetails): any => ({ ...obj, }); @@ -2420,6 +2633,9 @@ export interface TriggerNodeDetails { } export namespace TriggerNodeDetails { + /** + * @internal + */ export const filterSensitiveLog = (obj: TriggerNodeDetails): any => ({ ...obj, }); @@ -2467,6 +2683,9 @@ export interface Node { } export namespace Node { + /** + * @internal + */ export const filterSensitiveLog = (obj: Node): any => ({ ...obj, }); @@ -2489,6 +2708,9 @@ export interface WorkflowGraph { } export namespace WorkflowGraph { + /** + * @internal + */ export const filterSensitiveLog = (obj: WorkflowGraph): any => ({ ...obj, }); @@ -2530,6 +2752,9 @@ export interface WorkflowRunStatistics { } export namespace WorkflowRunStatistics { + /** + * @internal + */ export const filterSensitiveLog = (obj: WorkflowRunStatistics): any => ({ ...obj, }); @@ -2600,6 +2825,9 @@ export interface WorkflowRun { } export namespace WorkflowRun { + /** + * @internal + */ export const filterSensitiveLog = (obj: WorkflowRun): any => ({ ...obj, }); @@ -2653,6 +2881,9 @@ export interface Workflow { } export namespace Workflow { + /** + * @internal + */ export const filterSensitiveLog = (obj: Workflow): any => ({ ...obj, }); @@ -2671,6 +2902,9 @@ export interface BatchGetWorkflowsResponse { } export namespace BatchGetWorkflowsResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: BatchGetWorkflowsResponse): any => ({ ...obj, }); @@ -2690,6 +2924,9 @@ export interface BatchStopJobRunRequest { } export namespace BatchStopJobRunRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: BatchStopJobRunRequest): any => ({ ...obj, }); @@ -2717,6 +2954,9 @@ export interface BatchStopJobRunError { } export namespace BatchStopJobRunError { + /** + * @internal + */ export const filterSensitiveLog = (obj: BatchStopJobRunError): any => ({ ...obj, }); @@ -2738,6 +2978,9 @@ export interface BatchStopJobRunSuccessfulSubmission { } export namespace BatchStopJobRunSuccessfulSubmission { + /** + * @internal + */ export const filterSensitiveLog = (obj: BatchStopJobRunSuccessfulSubmission): any => ({ ...obj, }); @@ -2758,6 +3001,9 @@ export interface BatchStopJobRunResponse { } export namespace BatchStopJobRunResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: BatchStopJobRunResponse): any => ({ ...obj, }); @@ -2779,6 +3025,9 @@ export interface BatchUpdatePartitionRequestEntry { } export namespace BatchUpdatePartitionRequestEntry { + /** + * @internal + */ export const filterSensitiveLog = (obj: BatchUpdatePartitionRequestEntry): any => ({ ...obj, }); @@ -2809,6 +3058,9 @@ export interface BatchUpdatePartitionRequest { } export namespace BatchUpdatePartitionRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: BatchUpdatePartitionRequest): any => ({ ...obj, }); @@ -2830,6 +3082,9 @@ export interface BatchUpdatePartitionFailureEntry { } export namespace BatchUpdatePartitionFailureEntry { + /** + * @internal + */ export const filterSensitiveLog = (obj: BatchUpdatePartitionFailureEntry): any => ({ ...obj, }); @@ -2843,6 +3098,9 @@ export interface BatchUpdatePartitionResponse { } export namespace BatchUpdatePartitionResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: BatchUpdatePartitionResponse): any => ({ ...obj, }); @@ -2861,6 +3119,9 @@ export interface CancelMLTaskRunRequest { } export namespace CancelMLTaskRunRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: CancelMLTaskRunRequest): any => ({ ...obj, }); @@ -2894,6 +3155,9 @@ export interface CancelMLTaskRunResponse { } export namespace CancelMLTaskRunResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: CancelMLTaskRunResponse): any => ({ ...obj, }); @@ -2916,6 +3180,9 @@ export interface CheckSchemaVersionValidityInput { } export namespace CheckSchemaVersionValidityInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: CheckSchemaVersionValidityInput): any => ({ ...obj, }); @@ -2934,6 +3201,9 @@ export interface CheckSchemaVersionValidityResponse { } export namespace CheckSchemaVersionValidityResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: CheckSchemaVersionValidityResponse): any => ({ ...obj, }); @@ -2986,6 +3256,9 @@ export interface CreateCsvClassifierRequest { } export namespace CreateCsvClassifierRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateCsvClassifierRequest): any => ({ ...obj, }); @@ -3019,6 +3292,9 @@ export interface CreateGrokClassifierRequest { } export namespace CreateGrokClassifierRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateGrokClassifierRequest): any => ({ ...obj, }); @@ -3041,6 +3317,9 @@ export interface CreateJsonClassifierRequest { } export namespace CreateJsonClassifierRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateJsonClassifierRequest): any => ({ ...obj, }); @@ -3071,6 +3350,9 @@ export interface CreateXMLClassifierRequest { } export namespace CreateXMLClassifierRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateXMLClassifierRequest): any => ({ ...obj, }); @@ -3103,6 +3385,9 @@ export interface CreateClassifierRequest { } export namespace CreateClassifierRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateClassifierRequest): any => ({ ...obj, }); @@ -3111,6 +3396,9 @@ export namespace CreateClassifierRequest { export interface CreateClassifierResponse {} export namespace CreateClassifierResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateClassifierResponse): any => ({ ...obj, }); @@ -3182,6 +3470,9 @@ export interface PhysicalConnectionRequirements { } export namespace PhysicalConnectionRequirements { + /** + * @internal + */ export const filterSensitiveLog = (obj: PhysicalConnectionRequirements): any => ({ ...obj, }); @@ -3251,6 +3542,9 @@ export interface ConnectionInput { } export namespace ConnectionInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: ConnectionInput): any => ({ ...obj, }); @@ -3271,6 +3565,9 @@ export interface CreateConnectionRequest { } export namespace CreateConnectionRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateConnectionRequest): any => ({ ...obj, }); @@ -3279,6 +3576,9 @@ export namespace CreateConnectionRequest { export interface CreateConnectionResponse {} export namespace CreateConnectionResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateConnectionResponse): any => ({ ...obj, }); @@ -3368,6 +3668,9 @@ export interface CreateCrawlerRequest { } export namespace CreateCrawlerRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateCrawlerRequest): any => ({ ...obj, }); @@ -3376,6 +3679,9 @@ export namespace CreateCrawlerRequest { export interface CreateCrawlerResponse {} export namespace CreateCrawlerResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateCrawlerResponse): any => ({ ...obj, }); @@ -3404,6 +3710,9 @@ export interface DataLakePrincipal { } export namespace DataLakePrincipal { + /** + * @internal + */ export const filterSensitiveLog = (obj: DataLakePrincipal): any => ({ ...obj, }); @@ -3425,6 +3734,9 @@ export interface PrincipalPermissions { } export namespace PrincipalPermissions { + /** + * @internal + */ export const filterSensitiveLog = (obj: PrincipalPermissions): any => ({ ...obj, }); @@ -3446,6 +3758,9 @@ export interface DatabaseIdentifier { } export namespace DatabaseIdentifier { + /** + * @internal + */ export const filterSensitiveLog = (obj: DatabaseIdentifier): any => ({ ...obj, }); @@ -3490,6 +3805,9 @@ export interface DatabaseInput { } export namespace DatabaseInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: DatabaseInput): any => ({ ...obj, }); @@ -3509,6 +3827,9 @@ export interface CreateDatabaseRequest { } export namespace CreateDatabaseRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateDatabaseRequest): any => ({ ...obj, }); @@ -3517,6 +3838,9 @@ export namespace CreateDatabaseRequest { export interface CreateDatabaseResponse {} export namespace CreateDatabaseResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateDatabaseResponse): any => ({ ...obj, }); @@ -3643,6 +3967,9 @@ export interface CreateDevEndpointRequest { } export namespace CreateDevEndpointRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateDevEndpointRequest): any => ({ ...obj, }); @@ -3771,6 +4098,9 @@ export interface CreateDevEndpointResponse { } export namespace CreateDevEndpointResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateDevEndpointResponse): any => ({ ...obj, }); @@ -3789,6 +4119,9 @@ export interface IdempotentParameterMismatchException extends __SmithyException, } export namespace IdempotentParameterMismatchException { + /** + * @internal + */ export const filterSensitiveLog = (obj: IdempotentParameterMismatchException): any => ({ ...obj, }); @@ -3807,6 +4140,9 @@ export interface ValidationException extends __SmithyException, $MetadataBearer } export namespace ValidationException { + /** + * @internal + */ export const filterSensitiveLog = (obj: ValidationException): any => ({ ...obj, }); @@ -3825,6 +4161,9 @@ export interface ConcurrentModificationException extends __SmithyException, $Met } export namespace ConcurrentModificationException { + /** + * @internal + */ export const filterSensitiveLog = (obj: ConcurrentModificationException): any => ({ ...obj, }); @@ -3980,6 +4319,9 @@ export interface CreateJobRequest { } export namespace CreateJobRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateJobRequest): any => ({ ...obj, }); @@ -3993,6 +4335,9 @@ export interface CreateJobResponse { } export namespace CreateJobResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateJobResponse): any => ({ ...obj, }); @@ -4024,6 +4369,9 @@ export interface GlueTable { } export namespace GlueTable { + /** + * @internal + */ export const filterSensitiveLog = (obj: GlueTable): any => ({ ...obj, }); @@ -4073,6 +4421,9 @@ export interface FindMatchesParameters { } export namespace FindMatchesParameters { + /** + * @internal + */ export const filterSensitiveLog = (obj: FindMatchesParameters): any => ({ ...obj, }); @@ -4100,6 +4451,9 @@ export interface TransformParameters { } export namespace TransformParameters { + /** + * @internal + */ export const filterSensitiveLog = (obj: TransformParameters): any => ({ ...obj, }); @@ -4135,6 +4489,9 @@ export interface MLUserDataEncryption { } export namespace MLUserDataEncryption { + /** + * @internal + */ export const filterSensitiveLog = (obj: MLUserDataEncryption): any => ({ ...obj, }); @@ -4158,6 +4515,9 @@ export interface TransformEncryption { } export namespace TransformEncryption { + /** + * @internal + */ export const filterSensitiveLog = (obj: TransformEncryption): any => ({ ...obj, }); @@ -4299,6 +4659,9 @@ export interface CreateMLTransformRequest { } export namespace CreateMLTransformRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateMLTransformRequest): any => ({ ...obj, }); @@ -4312,6 +4675,9 @@ export interface CreateMLTransformResponse { } export namespace CreateMLTransformResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateMLTransformResponse): any => ({ ...obj, }); @@ -4342,6 +4708,9 @@ export interface CreatePartitionRequest { } export namespace CreatePartitionRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreatePartitionRequest): any => ({ ...obj, }); @@ -4350,6 +4719,9 @@ export namespace CreatePartitionRequest { export interface CreatePartitionResponse {} export namespace CreatePartitionResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreatePartitionResponse): any => ({ ...obj, }); @@ -4371,6 +4743,9 @@ export interface PartitionIndex { } export namespace PartitionIndex { + /** + * @internal + */ export const filterSensitiveLog = (obj: PartitionIndex): any => ({ ...obj, }); @@ -4399,6 +4774,9 @@ export interface CreatePartitionIndexRequest { } export namespace CreatePartitionIndexRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreatePartitionIndexRequest): any => ({ ...obj, }); @@ -4407,6 +4785,9 @@ export namespace CreatePartitionIndexRequest { export interface CreatePartitionIndexResponse {} export namespace CreatePartitionIndexResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreatePartitionIndexResponse): any => ({ ...obj, }); @@ -4430,6 +4811,9 @@ export interface CreateRegistryInput { } export namespace CreateRegistryInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateRegistryInput): any => ({ ...obj, }); @@ -4458,6 +4842,9 @@ export interface CreateRegistryResponse { } export namespace CreateRegistryResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateRegistryResponse): any => ({ ...obj, }); @@ -4490,6 +4877,9 @@ export interface RegistryId { } export namespace RegistryId { + /** + * @internal + */ export const filterSensitiveLog = (obj: RegistryId): any => ({ ...obj, }); @@ -4568,6 +4958,9 @@ export interface CreateSchemaInput { } export namespace CreateSchemaInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateSchemaInput): any => ({ ...obj, }); @@ -4659,6 +5052,9 @@ export interface CreateSchemaResponse { } export namespace CreateSchemaResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateSchemaResponse): any => ({ ...obj, }); @@ -4685,6 +5081,9 @@ export interface CodeGenEdge { } export namespace CodeGenEdge { + /** + * @internal + */ export const filterSensitiveLog = (obj: CodeGenEdge): any => ({ ...obj, }); @@ -4711,6 +5110,9 @@ export interface CodeGenNodeArg { } export namespace CodeGenNodeArg { + /** + * @internal + */ export const filterSensitiveLog = (obj: CodeGenNodeArg): any => ({ ...obj, }); @@ -4742,6 +5144,9 @@ export interface CodeGenNode { } export namespace CodeGenNode { + /** + * @internal + */ export const filterSensitiveLog = (obj: CodeGenNode): any => ({ ...obj, }); @@ -4770,6 +5175,9 @@ export interface CreateScriptRequest { } export namespace CreateScriptRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateScriptRequest): any => ({ ...obj, }); @@ -4788,6 +5196,9 @@ export interface CreateScriptResponse { } export namespace CreateScriptResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateScriptResponse): any => ({ ...obj, }); @@ -4814,6 +5225,9 @@ export interface CloudWatchEncryption { } export namespace CloudWatchEncryption { + /** + * @internal + */ export const filterSensitiveLog = (obj: CloudWatchEncryption): any => ({ ...obj, }); @@ -4840,6 +5254,9 @@ export interface JobBookmarksEncryption { } export namespace JobBookmarksEncryption { + /** + * @internal + */ export const filterSensitiveLog = (obj: JobBookmarksEncryption): any => ({ ...obj, }); @@ -4867,6 +5284,9 @@ export interface S3Encryption { } export namespace S3Encryption { + /** + * @internal + */ export const filterSensitiveLog = (obj: S3Encryption): any => ({ ...obj, }); @@ -4893,6 +5313,9 @@ export interface EncryptionConfiguration { } export namespace EncryptionConfiguration { + /** + * @internal + */ export const filterSensitiveLog = (obj: EncryptionConfiguration): any => ({ ...obj, }); @@ -4911,6 +5334,9 @@ export interface CreateSecurityConfigurationRequest { } export namespace CreateSecurityConfigurationRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateSecurityConfigurationRequest): any => ({ ...obj, }); @@ -4929,6 +5355,9 @@ export interface CreateSecurityConfigurationResponse { } export namespace CreateSecurityConfigurationResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateSecurityConfigurationResponse): any => ({ ...obj, }); @@ -4955,6 +5384,9 @@ export interface TableIdentifier { } export namespace TableIdentifier { + /** + * @internal + */ export const filterSensitiveLog = (obj: TableIdentifier): any => ({ ...obj, }); @@ -5040,6 +5472,9 @@ export interface TableInput { } export namespace TableInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: TableInput): any => ({ ...obj, }); @@ -5071,6 +5506,9 @@ export interface CreateTableRequest { } export namespace CreateTableRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateTableRequest): any => ({ ...obj, }); @@ -5079,6 +5517,9 @@ export namespace CreateTableRequest { export interface CreateTableResponse {} export namespace CreateTableResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateTableResponse): any => ({ ...obj, }); @@ -5140,6 +5581,9 @@ export interface CreateTriggerRequest { } export namespace CreateTriggerRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateTriggerRequest): any => ({ ...obj, }); @@ -5153,6 +5597,9 @@ export interface CreateTriggerResponse { } export namespace CreateTriggerResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateTriggerResponse): any => ({ ...obj, }); @@ -5186,6 +5633,9 @@ export interface ResourceUri { } export namespace ResourceUri { + /** + * @internal + */ export const filterSensitiveLog = (obj: ResourceUri): any => ({ ...obj, }); @@ -5222,6 +5672,9 @@ export interface UserDefinedFunctionInput { } export namespace UserDefinedFunctionInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: UserDefinedFunctionInput): any => ({ ...obj, }); @@ -5247,6 +5700,9 @@ export interface CreateUserDefinedFunctionRequest { } export namespace CreateUserDefinedFunctionRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateUserDefinedFunctionRequest): any => ({ ...obj, }); @@ -5255,6 +5711,9 @@ export namespace CreateUserDefinedFunctionRequest { export interface CreateUserDefinedFunctionResponse {} export namespace CreateUserDefinedFunctionResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateUserDefinedFunctionResponse): any => ({ ...obj, }); @@ -5288,6 +5747,9 @@ export interface CreateWorkflowRequest { } export namespace CreateWorkflowRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateWorkflowRequest): any => ({ ...obj, }); @@ -5301,6 +5763,9 @@ export interface CreateWorkflowResponse { } export namespace CreateWorkflowResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateWorkflowResponse): any => ({ ...obj, }); @@ -5314,6 +5779,9 @@ export interface DeleteClassifierRequest { } export namespace DeleteClassifierRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteClassifierRequest): any => ({ ...obj, }); @@ -5322,6 +5790,9 @@ export namespace DeleteClassifierRequest { export interface DeleteClassifierResponse {} export namespace DeleteClassifierResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteClassifierResponse): any => ({ ...obj, }); @@ -5356,6 +5827,9 @@ export interface DeleteColumnStatisticsForPartitionRequest { } export namespace DeleteColumnStatisticsForPartitionRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteColumnStatisticsForPartitionRequest): any => ({ ...obj, }); @@ -5364,6 +5838,9 @@ export namespace DeleteColumnStatisticsForPartitionRequest { export interface DeleteColumnStatisticsForPartitionResponse {} export namespace DeleteColumnStatisticsForPartitionResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteColumnStatisticsForPartitionResponse): any => ({ ...obj, }); @@ -5393,6 +5870,9 @@ export interface DeleteColumnStatisticsForTableRequest { } export namespace DeleteColumnStatisticsForTableRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteColumnStatisticsForTableRequest): any => ({ ...obj, }); @@ -5401,6 +5881,9 @@ export namespace DeleteColumnStatisticsForTableRequest { export interface DeleteColumnStatisticsForTableResponse {} export namespace DeleteColumnStatisticsForTableResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteColumnStatisticsForTableResponse): any => ({ ...obj, }); @@ -5420,6 +5903,9 @@ export interface DeleteConnectionRequest { } export namespace DeleteConnectionRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteConnectionRequest): any => ({ ...obj, }); @@ -5428,6 +5914,9 @@ export namespace DeleteConnectionRequest { export interface DeleteConnectionResponse {} export namespace DeleteConnectionResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteConnectionResponse): any => ({ ...obj, }); @@ -5446,6 +5935,9 @@ export interface CrawlerRunningException extends __SmithyException, $MetadataBea } export namespace CrawlerRunningException { + /** + * @internal + */ export const filterSensitiveLog = (obj: CrawlerRunningException): any => ({ ...obj, }); @@ -5459,6 +5951,9 @@ export interface DeleteCrawlerRequest { } export namespace DeleteCrawlerRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteCrawlerRequest): any => ({ ...obj, }); @@ -5467,6 +5962,9 @@ export namespace DeleteCrawlerRequest { export interface DeleteCrawlerResponse {} export namespace DeleteCrawlerResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteCrawlerResponse): any => ({ ...obj, }); @@ -5485,6 +5983,9 @@ export interface SchedulerTransitioningException extends __SmithyException, $Met } export namespace SchedulerTransitioningException { + /** + * @internal + */ export const filterSensitiveLog = (obj: SchedulerTransitioningException): any => ({ ...obj, }); @@ -5505,6 +6006,9 @@ export interface DeleteDatabaseRequest { } export namespace DeleteDatabaseRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteDatabaseRequest): any => ({ ...obj, }); @@ -5513,6 +6017,9 @@ export namespace DeleteDatabaseRequest { export interface DeleteDatabaseResponse {} export namespace DeleteDatabaseResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteDatabaseResponse): any => ({ ...obj, }); @@ -5526,6 +6033,9 @@ export interface DeleteDevEndpointRequest { } export namespace DeleteDevEndpointRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteDevEndpointRequest): any => ({ ...obj, }); @@ -5534,6 +6044,9 @@ export namespace DeleteDevEndpointRequest { export interface DeleteDevEndpointResponse {} export namespace DeleteDevEndpointResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteDevEndpointResponse): any => ({ ...obj, }); @@ -5547,6 +6060,9 @@ export interface DeleteJobRequest { } export namespace DeleteJobRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteJobRequest): any => ({ ...obj, }); @@ -5560,6 +6076,9 @@ export interface DeleteJobResponse { } export namespace DeleteJobResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteJobResponse): any => ({ ...obj, }); @@ -5573,6 +6092,9 @@ export interface DeleteMLTransformRequest { } export namespace DeleteMLTransformRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteMLTransformRequest): any => ({ ...obj, }); @@ -5586,6 +6108,9 @@ export interface DeleteMLTransformResponse { } export namespace DeleteMLTransformResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteMLTransformResponse): any => ({ ...obj, }); @@ -5616,6 +6141,9 @@ export interface DeletePartitionRequest { } export namespace DeletePartitionRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeletePartitionRequest): any => ({ ...obj, }); @@ -5624,6 +6152,9 @@ export namespace DeletePartitionRequest { export interface DeletePartitionResponse {} export namespace DeletePartitionResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeletePartitionResponse): any => ({ ...obj, }); @@ -5642,6 +6173,9 @@ export interface ConflictException extends __SmithyException, $MetadataBearer { } export namespace ConflictException { + /** + * @internal + */ export const filterSensitiveLog = (obj: ConflictException): any => ({ ...obj, }); @@ -5670,6 +6204,9 @@ export interface DeletePartitionIndexRequest { } export namespace DeletePartitionIndexRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeletePartitionIndexRequest): any => ({ ...obj, }); @@ -5678,6 +6215,9 @@ export namespace DeletePartitionIndexRequest { export interface DeletePartitionIndexResponse {} export namespace DeletePartitionIndexResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeletePartitionIndexResponse): any => ({ ...obj, }); @@ -5691,6 +6231,9 @@ export interface DeleteRegistryInput { } export namespace DeleteRegistryInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteRegistryInput): any => ({ ...obj, }); @@ -5719,6 +6262,9 @@ export interface DeleteRegistryResponse { } export namespace DeleteRegistryResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteRegistryResponse): any => ({ ...obj, }); @@ -5737,6 +6283,9 @@ export interface ConditionCheckFailureException extends __SmithyException, $Meta } export namespace ConditionCheckFailureException { + /** + * @internal + */ export const filterSensitiveLog = (obj: ConditionCheckFailureException): any => ({ ...obj, }); @@ -5755,6 +6304,9 @@ export interface DeleteResourcePolicyRequest { } export namespace DeleteResourcePolicyRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteResourcePolicyRequest): any => ({ ...obj, }); @@ -5763,6 +6315,9 @@ export namespace DeleteResourcePolicyRequest { export interface DeleteResourcePolicyResponse {} export namespace DeleteResourcePolicyResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteResourcePolicyResponse): any => ({ ...obj, }); @@ -5776,6 +6331,9 @@ export interface DeleteSchemaInput { } export namespace DeleteSchemaInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteSchemaInput): any => ({ ...obj, }); @@ -5799,6 +6357,9 @@ export interface DeleteSchemaResponse { } export namespace DeleteSchemaResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteSchemaResponse): any => ({ ...obj, }); @@ -5825,6 +6386,9 @@ export interface DeleteSchemaVersionsInput { } export namespace DeleteSchemaVersionsInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteSchemaVersionsInput): any => ({ ...obj, }); @@ -5846,6 +6410,9 @@ export interface ErrorDetails { } export namespace ErrorDetails { + /** + * @internal + */ export const filterSensitiveLog = (obj: ErrorDetails): any => ({ ...obj, }); @@ -5867,6 +6434,9 @@ export interface SchemaVersionErrorItem { } export namespace SchemaVersionErrorItem { + /** + * @internal + */ export const filterSensitiveLog = (obj: SchemaVersionErrorItem): any => ({ ...obj, }); @@ -5880,6 +6450,9 @@ export interface DeleteSchemaVersionsResponse { } export namespace DeleteSchemaVersionsResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteSchemaVersionsResponse): any => ({ ...obj, }); @@ -5893,6 +6466,9 @@ export interface DeleteSecurityConfigurationRequest { } export namespace DeleteSecurityConfigurationRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteSecurityConfigurationRequest): any => ({ ...obj, }); @@ -5901,6 +6477,9 @@ export namespace DeleteSecurityConfigurationRequest { export interface DeleteSecurityConfigurationResponse {} export namespace DeleteSecurityConfigurationResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteSecurityConfigurationResponse): any => ({ ...obj, }); @@ -5927,6 +6506,9 @@ export interface DeleteTableRequest { } export namespace DeleteTableRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteTableRequest): any => ({ ...obj, }); @@ -5935,6 +6517,9 @@ export namespace DeleteTableRequest { export interface DeleteTableResponse {} export namespace DeleteTableResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteTableResponse): any => ({ ...obj, }); @@ -5966,6 +6551,9 @@ export interface DeleteTableVersionRequest { } export namespace DeleteTableVersionRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteTableVersionRequest): any => ({ ...obj, }); @@ -5974,6 +6562,9 @@ export namespace DeleteTableVersionRequest { export interface DeleteTableVersionResponse {} export namespace DeleteTableVersionResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteTableVersionResponse): any => ({ ...obj, }); @@ -5987,6 +6578,9 @@ export interface DeleteTriggerRequest { } export namespace DeleteTriggerRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteTriggerRequest): any => ({ ...obj, }); @@ -6000,6 +6594,9 @@ export interface DeleteTriggerResponse { } export namespace DeleteTriggerResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteTriggerResponse): any => ({ ...obj, }); @@ -6024,6 +6621,9 @@ export interface DeleteUserDefinedFunctionRequest { } export namespace DeleteUserDefinedFunctionRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteUserDefinedFunctionRequest): any => ({ ...obj, }); @@ -6032,6 +6632,9 @@ export namespace DeleteUserDefinedFunctionRequest { export interface DeleteUserDefinedFunctionResponse {} export namespace DeleteUserDefinedFunctionResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteUserDefinedFunctionResponse): any => ({ ...obj, }); @@ -6045,6 +6648,9 @@ export interface DeleteWorkflowRequest { } export namespace DeleteWorkflowRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteWorkflowRequest): any => ({ ...obj, }); @@ -6058,6 +6664,9 @@ export interface DeleteWorkflowResponse { } export namespace DeleteWorkflowResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteWorkflowResponse): any => ({ ...obj, }); @@ -6071,6 +6680,9 @@ export interface GetCatalogImportStatusRequest { } export namespace GetCatalogImportStatusRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetCatalogImportStatusRequest): any => ({ ...obj, }); @@ -6098,6 +6710,9 @@ export interface CatalogImportStatus { } export namespace CatalogImportStatus { + /** + * @internal + */ export const filterSensitiveLog = (obj: CatalogImportStatus): any => ({ ...obj, }); @@ -6111,6 +6726,9 @@ export interface GetCatalogImportStatusResponse { } export namespace GetCatalogImportStatusResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetCatalogImportStatusResponse): any => ({ ...obj, }); @@ -6124,6 +6742,9 @@ export interface GetClassifierRequest { } export namespace GetClassifierRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetClassifierRequest): any => ({ ...obj, }); @@ -6187,6 +6808,9 @@ export interface CsvClassifier { } export namespace CsvClassifier { + /** + * @internal + */ export const filterSensitiveLog = (obj: CsvClassifier): any => ({ ...obj, }); @@ -6236,6 +6860,9 @@ export interface GrokClassifier { } export namespace GrokClassifier { + /** + * @internal + */ export const filterSensitiveLog = (obj: GrokClassifier): any => ({ ...obj, }); @@ -6273,6 +6900,9 @@ export interface JsonClassifier { } export namespace JsonClassifier { + /** + * @internal + */ export const filterSensitiveLog = (obj: JsonClassifier): any => ({ ...obj, }); @@ -6318,6 +6948,9 @@ export interface XMLClassifier { } export namespace XMLClassifier { + /** + * @internal + */ export const filterSensitiveLog = (obj: XMLClassifier): any => ({ ...obj, }); @@ -6356,6 +6989,9 @@ export interface Classifier { } export namespace Classifier { + /** + * @internal + */ export const filterSensitiveLog = (obj: Classifier): any => ({ ...obj, }); @@ -6369,6 +7005,9 @@ export interface GetClassifierResponse { } export namespace GetClassifierResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetClassifierResponse): any => ({ ...obj, }); @@ -6387,6 +7026,9 @@ export interface GetClassifiersRequest { } export namespace GetClassifiersRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetClassifiersRequest): any => ({ ...obj, }); @@ -6406,6 +7048,9 @@ export interface GetClassifiersResponse { } export namespace GetClassifiersResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetClassifiersResponse): any => ({ ...obj, }); @@ -6440,6 +7085,9 @@ export interface GetColumnStatisticsForPartitionRequest { } export namespace GetColumnStatisticsForPartitionRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetColumnStatisticsForPartitionRequest): any => ({ ...obj, }); @@ -6466,6 +7114,9 @@ export interface BinaryColumnStatisticsData { } export namespace BinaryColumnStatisticsData { + /** + * @internal + */ export const filterSensitiveLog = (obj: BinaryColumnStatisticsData): any => ({ ...obj, }); @@ -6492,6 +7143,9 @@ export interface BooleanColumnStatisticsData { } export namespace BooleanColumnStatisticsData { + /** + * @internal + */ export const filterSensitiveLog = (obj: BooleanColumnStatisticsData): any => ({ ...obj, }); @@ -6523,6 +7177,9 @@ export interface DateColumnStatisticsData { } export namespace DateColumnStatisticsData { + /** + * @internal + */ export const filterSensitiveLog = (obj: DateColumnStatisticsData): any => ({ ...obj, }); @@ -6545,6 +7202,9 @@ export interface DecimalNumber { } export namespace DecimalNumber { + /** + * @internal + */ export const filterSensitiveLog = (obj: DecimalNumber): any => ({ ...obj, }); @@ -6576,6 +7236,9 @@ export interface DecimalColumnStatisticsData { } export namespace DecimalColumnStatisticsData { + /** + * @internal + */ export const filterSensitiveLog = (obj: DecimalColumnStatisticsData): any => ({ ...obj, }); @@ -6607,6 +7270,9 @@ export interface DoubleColumnStatisticsData { } export namespace DoubleColumnStatisticsData { + /** + * @internal + */ export const filterSensitiveLog = (obj: DoubleColumnStatisticsData): any => ({ ...obj, }); @@ -6638,6 +7304,9 @@ export interface LongColumnStatisticsData { } export namespace LongColumnStatisticsData { + /** + * @internal + */ export const filterSensitiveLog = (obj: LongColumnStatisticsData): any => ({ ...obj, }); @@ -6669,6 +7338,9 @@ export interface StringColumnStatisticsData { } export namespace StringColumnStatisticsData { + /** + * @internal + */ export const filterSensitiveLog = (obj: StringColumnStatisticsData): any => ({ ...obj, }); @@ -6730,6 +7402,9 @@ export interface ColumnStatisticsData { } export namespace ColumnStatisticsData { + /** + * @internal + */ export const filterSensitiveLog = (obj: ColumnStatisticsData): any => ({ ...obj, }); @@ -6761,6 +7436,9 @@ export interface ColumnStatistics { } export namespace ColumnStatistics { + /** + * @internal + */ export const filterSensitiveLog = (obj: ColumnStatistics): any => ({ ...obj, }); @@ -6782,6 +7460,9 @@ export interface ColumnError { } export namespace ColumnError { + /** + * @internal + */ export const filterSensitiveLog = (obj: ColumnError): any => ({ ...obj, }); @@ -6800,6 +7481,9 @@ export interface GetColumnStatisticsForPartitionResponse { } export namespace GetColumnStatisticsForPartitionResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetColumnStatisticsForPartitionResponse): any => ({ ...obj, }); @@ -6829,6 +7513,9 @@ export interface GetColumnStatisticsForTableRequest { } export namespace GetColumnStatisticsForTableRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetColumnStatisticsForTableRequest): any => ({ ...obj, }); @@ -6847,6 +7534,9 @@ export interface GetColumnStatisticsForTableResponse { } export namespace GetColumnStatisticsForTableResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetColumnStatisticsForTableResponse): any => ({ ...obj, }); @@ -6875,6 +7565,9 @@ export interface GetConnectionRequest { } export namespace GetConnectionRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetConnectionRequest): any => ({ ...obj, }); @@ -7063,6 +7756,9 @@ export interface Connection { } export namespace Connection { + /** + * @internal + */ export const filterSensitiveLog = (obj: Connection): any => ({ ...obj, }); @@ -7076,6 +7772,9 @@ export interface GetConnectionResponse { } export namespace GetConnectionResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetConnectionResponse): any => ({ ...obj, }); @@ -7099,6 +7798,9 @@ export interface GetConnectionsFilter { } export namespace GetConnectionsFilter { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetConnectionsFilter): any => ({ ...obj, }); @@ -7137,6 +7839,9 @@ export interface GetConnectionsRequest { } export namespace GetConnectionsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetConnectionsRequest): any => ({ ...obj, }); @@ -7156,6 +7861,9 @@ export interface GetConnectionsResponse { } export namespace GetConnectionsResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetConnectionsResponse): any => ({ ...obj, }); @@ -7169,6 +7877,9 @@ export interface GetCrawlerRequest { } export namespace GetCrawlerRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetCrawlerRequest): any => ({ ...obj, }); @@ -7182,6 +7893,9 @@ export interface GetCrawlerResponse { } export namespace GetCrawlerResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetCrawlerResponse): any => ({ ...obj, }); @@ -7205,6 +7919,9 @@ export interface GetCrawlerMetricsRequest { } export namespace GetCrawlerMetricsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetCrawlerMetricsRequest): any => ({ ...obj, }); @@ -7256,6 +7973,9 @@ export interface CrawlerMetrics { } export namespace CrawlerMetrics { + /** + * @internal + */ export const filterSensitiveLog = (obj: CrawlerMetrics): any => ({ ...obj, }); @@ -7275,6 +7995,9 @@ export interface GetCrawlerMetricsResponse { } export namespace GetCrawlerMetricsResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetCrawlerMetricsResponse): any => ({ ...obj, }); @@ -7293,6 +8016,9 @@ export interface GetCrawlersRequest { } export namespace GetCrawlersRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetCrawlersRequest): any => ({ ...obj, }); @@ -7312,6 +8038,9 @@ export interface GetCrawlersResponse { } export namespace GetCrawlersResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetCrawlersResponse): any => ({ ...obj, }); @@ -7332,6 +8061,9 @@ export interface GetDatabaseRequest { } export namespace GetDatabaseRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetDatabaseRequest): any => ({ ...obj, }); @@ -7386,6 +8118,9 @@ export interface Database { } export namespace Database { + /** + * @internal + */ export const filterSensitiveLog = (obj: Database): any => ({ ...obj, }); @@ -7399,6 +8134,9 @@ export interface GetDatabaseResponse { } export namespace GetDatabaseResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetDatabaseResponse): any => ({ ...obj, }); @@ -7442,6 +8180,9 @@ export interface GetDatabasesRequest { } export namespace GetDatabasesRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetDatabasesRequest): any => ({ ...obj, }); @@ -7461,6 +8202,9 @@ export interface GetDatabasesResponse { } export namespace GetDatabasesResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetDatabasesResponse): any => ({ ...obj, }); @@ -7475,6 +8219,9 @@ export interface GetDataCatalogEncryptionSettingsRequest { } export namespace GetDataCatalogEncryptionSettingsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetDataCatalogEncryptionSettingsRequest): any => ({ ...obj, }); @@ -7513,6 +8260,9 @@ export interface ConnectionPasswordEncryption { } export namespace ConnectionPasswordEncryption { + /** + * @internal + */ export const filterSensitiveLog = (obj: ConnectionPasswordEncryption): any => ({ ...obj, }); @@ -7539,6 +8289,9 @@ export interface EncryptionAtRest { } export namespace EncryptionAtRest { + /** + * @internal + */ export const filterSensitiveLog = (obj: EncryptionAtRest): any => ({ ...obj, }); @@ -7564,6 +8317,9 @@ export interface DataCatalogEncryptionSettings { } export namespace DataCatalogEncryptionSettings { + /** + * @internal + */ export const filterSensitiveLog = (obj: DataCatalogEncryptionSettings): any => ({ ...obj, }); @@ -7577,6 +8333,9 @@ export interface GetDataCatalogEncryptionSettingsResponse { } export namespace GetDataCatalogEncryptionSettingsResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetDataCatalogEncryptionSettingsResponse): any => ({ ...obj, }); @@ -7590,6 +8349,9 @@ export interface GetDataflowGraphRequest { } export namespace GetDataflowGraphRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetDataflowGraphRequest): any => ({ ...obj, }); @@ -7608,6 +8370,9 @@ export interface GetDataflowGraphResponse { } export namespace GetDataflowGraphResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetDataflowGraphResponse): any => ({ ...obj, }); @@ -7621,6 +8386,9 @@ export interface GetDevEndpointRequest { } export namespace GetDevEndpointRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetDevEndpointRequest): any => ({ ...obj, }); @@ -7634,6 +8402,9 @@ export interface GetDevEndpointResponse { } export namespace GetDevEndpointResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetDevEndpointResponse): any => ({ ...obj, }); @@ -7652,6 +8423,9 @@ export interface GetDevEndpointsRequest { } export namespace GetDevEndpointsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetDevEndpointsRequest): any => ({ ...obj, }); @@ -7671,6 +8445,9 @@ export interface GetDevEndpointsResponse { } export namespace GetDevEndpointsResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetDevEndpointsResponse): any => ({ ...obj, }); @@ -7684,6 +8461,9 @@ export interface GetJobRequest { } export namespace GetJobRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetJobRequest): any => ({ ...obj, }); @@ -7697,6 +8477,9 @@ export interface GetJobResponse { } export namespace GetJobResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetJobResponse): any => ({ ...obj, }); @@ -7715,6 +8498,9 @@ export interface GetJobBookmarkRequest { } export namespace GetJobBookmarkRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetJobBookmarkRequest): any => ({ ...obj, }); @@ -7761,6 +8547,9 @@ export interface JobBookmarkEntry { } export namespace JobBookmarkEntry { + /** + * @internal + */ export const filterSensitiveLog = (obj: JobBookmarkEntry): any => ({ ...obj, }); diff --git a/clients/client-glue/models/models_1.ts b/clients/client-glue/models/models_1.ts index 720e4b421c26..c7774cce00b9 100644 --- a/clients/client-glue/models/models_1.ts +++ b/clients/client-glue/models/models_1.ts @@ -60,6 +60,9 @@ export interface GetJobBookmarkResponse { } export namespace GetJobBookmarkResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetJobBookmarkResponse): any => ({ ...obj, }); @@ -83,6 +86,9 @@ export interface GetJobRunRequest { } export namespace GetJobRunRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetJobRunRequest): any => ({ ...obj, }); @@ -96,6 +102,9 @@ export interface GetJobRunResponse { } export namespace GetJobRunResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetJobRunResponse): any => ({ ...obj, }); @@ -119,6 +128,9 @@ export interface GetJobRunsRequest { } export namespace GetJobRunsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetJobRunsRequest): any => ({ ...obj, }); @@ -137,6 +149,9 @@ export interface GetJobRunsResponse { } export namespace GetJobRunsResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetJobRunsResponse): any => ({ ...obj, }); @@ -155,6 +170,9 @@ export interface GetJobsRequest { } export namespace GetJobsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetJobsRequest): any => ({ ...obj, }); @@ -173,6 +191,9 @@ export interface GetJobsResponse { } export namespace GetJobsResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetJobsResponse): any => ({ ...obj, }); @@ -199,6 +220,9 @@ export interface Location { } export namespace Location { + /** + * @internal + */ export const filterSensitiveLog = (obj: Location): any => ({ ...obj, }); @@ -220,6 +244,9 @@ export interface CatalogEntry { } export namespace CatalogEntry { + /** + * @internal + */ export const filterSensitiveLog = (obj: CatalogEntry): any => ({ ...obj, }); @@ -243,6 +270,9 @@ export interface GetMappingRequest { } export namespace GetMappingRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetMappingRequest): any => ({ ...obj, }); @@ -284,6 +314,9 @@ export interface MappingEntry { } export namespace MappingEntry { + /** + * @internal + */ export const filterSensitiveLog = (obj: MappingEntry): any => ({ ...obj, }); @@ -297,6 +330,9 @@ export interface GetMappingResponse { } export namespace GetMappingResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetMappingResponse): any => ({ ...obj, }); @@ -315,6 +351,9 @@ export interface GetMLTaskRunRequest { } export namespace GetMLTaskRunRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetMLTaskRunRequest): any => ({ ...obj, }); @@ -332,6 +371,9 @@ export interface ExportLabelsTaskRunProperties { } export namespace ExportLabelsTaskRunProperties { + /** + * @internal + */ export const filterSensitiveLog = (obj: ExportLabelsTaskRunProperties): any => ({ ...obj, }); @@ -358,6 +400,9 @@ export interface FindMatchesTaskRunProperties { } export namespace FindMatchesTaskRunProperties { + /** + * @internal + */ export const filterSensitiveLog = (obj: FindMatchesTaskRunProperties): any => ({ ...obj, }); @@ -380,6 +425,9 @@ export interface ImportLabelsTaskRunProperties { } export namespace ImportLabelsTaskRunProperties { + /** + * @internal + */ export const filterSensitiveLog = (obj: ImportLabelsTaskRunProperties): any => ({ ...obj, }); @@ -397,6 +445,9 @@ export interface LabelingSetGenerationTaskRunProperties { } export namespace LabelingSetGenerationTaskRunProperties { + /** + * @internal + */ export const filterSensitiveLog = (obj: LabelingSetGenerationTaskRunProperties): any => ({ ...obj, }); @@ -441,6 +492,9 @@ export interface TaskRunProperties { } export namespace TaskRunProperties { + /** + * @internal + */ export const filterSensitiveLog = (obj: TaskRunProperties): any => ({ ...obj, }); @@ -499,6 +553,9 @@ export interface GetMLTaskRunResponse { } export namespace GetMLTaskRunResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetMLTaskRunResponse): any => ({ ...obj, }); @@ -531,6 +588,9 @@ export interface TaskRunFilterCriteria { } export namespace TaskRunFilterCriteria { + /** + * @internal + */ export const filterSensitiveLog = (obj: TaskRunFilterCriteria): any => ({ ...obj, }); @@ -566,6 +626,9 @@ export interface TaskRunSortCriteria { } export namespace TaskRunSortCriteria { + /** + * @internal + */ export const filterSensitiveLog = (obj: TaskRunSortCriteria): any => ({ ...obj, }); @@ -599,6 +662,9 @@ export interface GetMLTaskRunsRequest { } export namespace GetMLTaskRunsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetMLTaskRunsRequest): any => ({ ...obj, }); @@ -660,6 +726,9 @@ export interface TaskRun { } export namespace TaskRun { + /** + * @internal + */ export const filterSensitiveLog = (obj: TaskRun): any => ({ ...obj, }); @@ -678,6 +747,9 @@ export interface GetMLTaskRunsResponse { } export namespace GetMLTaskRunsResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetMLTaskRunsResponse): any => ({ ...obj, }); @@ -692,6 +764,9 @@ export interface GetMLTransformRequest { } export namespace GetMLTransformRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetMLTransformRequest): any => ({ ...obj, }); @@ -715,6 +790,9 @@ export interface ColumnImportance { } export namespace ColumnImportance { + /** + * @internal + */ export const filterSensitiveLog = (obj: ColumnImportance): any => ({ ...obj, }); @@ -750,6 +828,9 @@ export interface ConfusionMatrix { } export namespace ConfusionMatrix { + /** + * @internal + */ export const filterSensitiveLog = (obj: ConfusionMatrix): any => ({ ...obj, }); @@ -803,6 +884,9 @@ export interface FindMatchesMetrics { } export namespace FindMatchesMetrics { + /** + * @internal + */ export const filterSensitiveLog = (obj: FindMatchesMetrics): any => ({ ...obj, }); @@ -824,6 +908,9 @@ export interface EvaluationMetrics { } export namespace EvaluationMetrics { + /** + * @internal + */ export const filterSensitiveLog = (obj: EvaluationMetrics): any => ({ ...obj, }); @@ -846,6 +933,9 @@ export interface SchemaColumn { } export namespace SchemaColumn { + /** + * @internal + */ export const filterSensitiveLog = (obj: SchemaColumn): any => ({ ...obj, }); @@ -974,6 +1064,9 @@ export interface GetMLTransformResponse { } export namespace GetMLTransformResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetMLTransformResponse): any => ({ ...obj, }); @@ -1034,6 +1127,9 @@ export interface TransformFilterCriteria { } export namespace TransformFilterCriteria { + /** + * @internal + */ export const filterSensitiveLog = (obj: TransformFilterCriteria): any => ({ ...obj, }); @@ -1065,6 +1161,9 @@ export interface TransformSortCriteria { } export namespace TransformSortCriteria { + /** + * @internal + */ export const filterSensitiveLog = (obj: TransformSortCriteria): any => ({ ...obj, }); @@ -1093,6 +1192,9 @@ export interface GetMLTransformsRequest { } export namespace GetMLTransformsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetMLTransformsRequest): any => ({ ...obj, }); @@ -1269,6 +1371,9 @@ export interface MLTransform { } export namespace MLTransform { + /** + * @internal + */ export const filterSensitiveLog = (obj: MLTransform): any => ({ ...obj, }); @@ -1287,6 +1392,9 @@ export interface GetMLTransformsResponse { } export namespace GetMLTransformsResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetMLTransformsResponse): any => ({ ...obj, }); @@ -1316,6 +1424,9 @@ export interface GetPartitionRequest { } export namespace GetPartitionRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetPartitionRequest): any => ({ ...obj, }); @@ -1330,6 +1441,9 @@ export interface GetPartitionResponse { } export namespace GetPartitionResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetPartitionResponse): any => ({ ...obj, }); @@ -1358,6 +1472,9 @@ export interface GetPartitionIndexesRequest { } export namespace GetPartitionIndexesRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetPartitionIndexesRequest): any => ({ ...obj, }); @@ -1407,6 +1524,9 @@ export interface BackfillError { } export namespace BackfillError { + /** + * @internal + */ export const filterSensitiveLog = (obj: BackfillError): any => ({ ...obj, }); @@ -1435,6 +1555,9 @@ export interface KeySchemaElement { } export namespace KeySchemaElement { + /** + * @internal + */ export const filterSensitiveLog = (obj: KeySchemaElement): any => ({ ...obj, }); @@ -1482,6 +1605,9 @@ export interface PartitionIndexDescriptor { } export namespace PartitionIndexDescriptor { + /** + * @internal + */ export const filterSensitiveLog = (obj: PartitionIndexDescriptor): any => ({ ...obj, }); @@ -1500,6 +1626,9 @@ export interface GetPartitionIndexesResponse { } export namespace GetPartitionIndexesResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetPartitionIndexesResponse): any => ({ ...obj, }); @@ -1523,6 +1652,9 @@ export interface Segment { } export namespace Segment { + /** + * @internal + */ export const filterSensitiveLog = (obj: Segment): any => ({ ...obj, }); @@ -1675,6 +1807,9 @@ export interface GetPartitionsRequest { } export namespace GetPartitionsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetPartitionsRequest): any => ({ ...obj, }); @@ -1694,6 +1829,9 @@ export interface GetPartitionsResponse { } export namespace GetPartitionsResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetPartitionsResponse): any => ({ ...obj, }); @@ -1744,6 +1882,9 @@ export interface GetPlanRequest { } export namespace GetPlanRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetPlanRequest): any => ({ ...obj, }); @@ -1762,6 +1903,9 @@ export interface GetPlanResponse { } export namespace GetPlanResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetPlanResponse): any => ({ ...obj, }); @@ -1775,6 +1919,9 @@ export interface GetRegistryInput { } export namespace GetRegistryInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetRegistryInput): any => ({ ...obj, }); @@ -1813,6 +1960,9 @@ export interface GetRegistryResponse { } export namespace GetRegistryResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetRegistryResponse): any => ({ ...obj, }); @@ -1831,6 +1981,9 @@ export interface GetResourcePoliciesRequest { } export namespace GetResourcePoliciesRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetResourcePoliciesRequest): any => ({ ...obj, }); @@ -1862,6 +2015,9 @@ export interface GluePolicy { } export namespace GluePolicy { + /** + * @internal + */ export const filterSensitiveLog = (obj: GluePolicy): any => ({ ...obj, }); @@ -1880,6 +2036,9 @@ export interface GetResourcePoliciesResponse { } export namespace GetResourcePoliciesResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetResourcePoliciesResponse): any => ({ ...obj, }); @@ -1896,6 +2055,9 @@ export interface GetResourcePolicyRequest { } export namespace GetResourcePolicyRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetResourcePolicyRequest): any => ({ ...obj, }); @@ -1924,6 +2086,9 @@ export interface GetResourcePolicyResponse { } export namespace GetResourcePolicyResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetResourcePolicyResponse): any => ({ ...obj, }); @@ -1945,6 +2110,9 @@ export interface GetSchemaInput { } export namespace GetSchemaInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetSchemaInput): any => ({ ...obj, }); @@ -2018,6 +2186,9 @@ export interface GetSchemaResponse { } export namespace GetSchemaResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetSchemaResponse): any => ({ ...obj, }); @@ -2044,6 +2215,9 @@ export interface GetSchemaByDefinitionInput { } export namespace GetSchemaByDefinitionInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetSchemaByDefinitionInput): any => ({ ...obj, }); @@ -2077,6 +2251,9 @@ export interface GetSchemaByDefinitionResponse { } export namespace GetSchemaByDefinitionResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetSchemaByDefinitionResponse): any => ({ ...obj, }); @@ -2098,6 +2275,9 @@ export interface SchemaVersionNumber { } export namespace SchemaVersionNumber { + /** + * @internal + */ export const filterSensitiveLog = (obj: SchemaVersionNumber): any => ({ ...obj, }); @@ -2129,6 +2309,9 @@ export interface GetSchemaVersionInput { } export namespace GetSchemaVersionInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetSchemaVersionInput): any => ({ ...obj, }); @@ -2172,6 +2355,9 @@ export interface GetSchemaVersionResponse { } export namespace GetSchemaVersionResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetSchemaVersionResponse): any => ({ ...obj, }); @@ -2212,6 +2398,9 @@ export interface GetSchemaVersionsDiffInput { } export namespace GetSchemaVersionsDiffInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetSchemaVersionsDiffInput): any => ({ ...obj, }); @@ -2225,6 +2414,9 @@ export interface GetSchemaVersionsDiffResponse { } export namespace GetSchemaVersionsDiffResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetSchemaVersionsDiffResponse): any => ({ ...obj, }); @@ -2238,6 +2430,9 @@ export interface GetSecurityConfigurationRequest { } export namespace GetSecurityConfigurationRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetSecurityConfigurationRequest): any => ({ ...obj, }); @@ -2264,6 +2459,9 @@ export interface SecurityConfiguration { } export namespace SecurityConfiguration { + /** + * @internal + */ export const filterSensitiveLog = (obj: SecurityConfiguration): any => ({ ...obj, }); @@ -2277,6 +2475,9 @@ export interface GetSecurityConfigurationResponse { } export namespace GetSecurityConfigurationResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetSecurityConfigurationResponse): any => ({ ...obj, }); @@ -2295,6 +2496,9 @@ export interface GetSecurityConfigurationsRequest { } export namespace GetSecurityConfigurationsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetSecurityConfigurationsRequest): any => ({ ...obj, }); @@ -2314,6 +2518,9 @@ export interface GetSecurityConfigurationsResponse { } export namespace GetSecurityConfigurationsResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetSecurityConfigurationsResponse): any => ({ ...obj, }); @@ -2340,6 +2547,9 @@ export interface GetTableRequest { } export namespace GetTableRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetTableRequest): any => ({ ...obj, }); @@ -2457,6 +2667,9 @@ export interface Table { } export namespace Table { + /** + * @internal + */ export const filterSensitiveLog = (obj: Table): any => ({ ...obj, }); @@ -2470,6 +2683,9 @@ export interface GetTableResponse { } export namespace GetTableResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetTableResponse): any => ({ ...obj, }); @@ -2506,6 +2722,9 @@ export interface GetTablesRequest { } export namespace GetTablesRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetTablesRequest): any => ({ ...obj, }); @@ -2525,6 +2744,9 @@ export interface GetTablesResponse { } export namespace GetTablesResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetTablesResponse): any => ({ ...obj, }); @@ -2556,6 +2778,9 @@ export interface GetTableVersionRequest { } export namespace GetTableVersionRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetTableVersionRequest): any => ({ ...obj, }); @@ -2577,6 +2802,9 @@ export interface TableVersion { } export namespace TableVersion { + /** + * @internal + */ export const filterSensitiveLog = (obj: TableVersion): any => ({ ...obj, }); @@ -2590,6 +2818,9 @@ export interface GetTableVersionResponse { } export namespace GetTableVersionResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetTableVersionResponse): any => ({ ...obj, }); @@ -2626,6 +2857,9 @@ export interface GetTableVersionsRequest { } export namespace GetTableVersionsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetTableVersionsRequest): any => ({ ...obj, }); @@ -2646,6 +2880,9 @@ export interface GetTableVersionsResponse { } export namespace GetTableVersionsResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetTableVersionsResponse): any => ({ ...obj, }); @@ -2659,6 +2896,9 @@ export interface GetTagsRequest { } export namespace GetTagsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetTagsRequest): any => ({ ...obj, }); @@ -2672,6 +2912,9 @@ export interface GetTagsResponse { } export namespace GetTagsResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetTagsResponse): any => ({ ...obj, }); @@ -2685,6 +2928,9 @@ export interface GetTriggerRequest { } export namespace GetTriggerRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetTriggerRequest): any => ({ ...obj, }); @@ -2698,6 +2944,9 @@ export interface GetTriggerResponse { } export namespace GetTriggerResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetTriggerResponse): any => ({ ...obj, }); @@ -2722,6 +2971,9 @@ export interface GetTriggersRequest { } export namespace GetTriggersRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetTriggersRequest): any => ({ ...obj, }); @@ -2741,6 +2993,9 @@ export interface GetTriggersResponse { } export namespace GetTriggersResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetTriggersResponse): any => ({ ...obj, }); @@ -2765,6 +3020,9 @@ export interface GetUserDefinedFunctionRequest { } export namespace GetUserDefinedFunctionRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetUserDefinedFunctionRequest): any => ({ ...obj, }); @@ -2817,6 +3075,9 @@ export interface UserDefinedFunction { } export namespace UserDefinedFunction { + /** + * @internal + */ export const filterSensitiveLog = (obj: UserDefinedFunction): any => ({ ...obj, }); @@ -2830,6 +3091,9 @@ export interface GetUserDefinedFunctionResponse { } export namespace GetUserDefinedFunctionResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetUserDefinedFunctionResponse): any => ({ ...obj, }); @@ -2866,6 +3130,9 @@ export interface GetUserDefinedFunctionsRequest { } export namespace GetUserDefinedFunctionsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetUserDefinedFunctionsRequest): any => ({ ...obj, }); @@ -2885,6 +3152,9 @@ export interface GetUserDefinedFunctionsResponse { } export namespace GetUserDefinedFunctionsResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetUserDefinedFunctionsResponse): any => ({ ...obj, }); @@ -2903,6 +3173,9 @@ export interface GetWorkflowRequest { } export namespace GetWorkflowRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetWorkflowRequest): any => ({ ...obj, }); @@ -2916,6 +3189,9 @@ export interface GetWorkflowResponse { } export namespace GetWorkflowResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetWorkflowResponse): any => ({ ...obj, }); @@ -2939,6 +3215,9 @@ export interface GetWorkflowRunRequest { } export namespace GetWorkflowRunRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetWorkflowRunRequest): any => ({ ...obj, }); @@ -2952,6 +3231,9 @@ export interface GetWorkflowRunResponse { } export namespace GetWorkflowRunResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetWorkflowRunResponse): any => ({ ...obj, }); @@ -2970,6 +3252,9 @@ export interface GetWorkflowRunPropertiesRequest { } export namespace GetWorkflowRunPropertiesRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetWorkflowRunPropertiesRequest): any => ({ ...obj, }); @@ -2983,6 +3268,9 @@ export interface GetWorkflowRunPropertiesResponse { } export namespace GetWorkflowRunPropertiesResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetWorkflowRunPropertiesResponse): any => ({ ...obj, }); @@ -3011,6 +3299,9 @@ export interface GetWorkflowRunsRequest { } export namespace GetWorkflowRunsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetWorkflowRunsRequest): any => ({ ...obj, }); @@ -3029,6 +3320,9 @@ export interface GetWorkflowRunsResponse { } export namespace GetWorkflowRunsResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetWorkflowRunsResponse): any => ({ ...obj, }); @@ -3042,6 +3336,9 @@ export interface ImportCatalogToGlueRequest { } export namespace ImportCatalogToGlueRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ImportCatalogToGlueRequest): any => ({ ...obj, }); @@ -3050,6 +3347,9 @@ export namespace ImportCatalogToGlueRequest { export interface ImportCatalogToGlueResponse {} export namespace ImportCatalogToGlueResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ImportCatalogToGlueResponse): any => ({ ...obj, }); @@ -3073,6 +3373,9 @@ export interface ListCrawlersRequest { } export namespace ListCrawlersRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListCrawlersRequest): any => ({ ...obj, }); @@ -3092,6 +3395,9 @@ export interface ListCrawlersResponse { } export namespace ListCrawlersResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListCrawlersResponse): any => ({ ...obj, }); @@ -3115,6 +3421,9 @@ export interface ListDevEndpointsRequest { } export namespace ListDevEndpointsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListDevEndpointsRequest): any => ({ ...obj, }); @@ -3135,6 +3444,9 @@ export interface ListDevEndpointsResponse { } export namespace ListDevEndpointsResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListDevEndpointsResponse): any => ({ ...obj, }); @@ -3158,6 +3470,9 @@ export interface ListJobsRequest { } export namespace ListJobsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListJobsRequest): any => ({ ...obj, }); @@ -3177,6 +3492,9 @@ export interface ListJobsResponse { } export namespace ListJobsResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListJobsResponse): any => ({ ...obj, }); @@ -3210,6 +3528,9 @@ export interface ListMLTransformsRequest { } export namespace ListMLTransformsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListMLTransformsRequest): any => ({ ...obj, }); @@ -3230,6 +3551,9 @@ export interface ListMLTransformsResponse { } export namespace ListMLTransformsResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListMLTransformsResponse): any => ({ ...obj, }); @@ -3248,6 +3572,9 @@ export interface ListRegistriesInput { } export namespace ListRegistriesInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListRegistriesInput): any => ({ ...obj, }); @@ -3289,6 +3616,9 @@ export interface RegistryListItem { } export namespace RegistryListItem { + /** + * @internal + */ export const filterSensitiveLog = (obj: RegistryListItem): any => ({ ...obj, }); @@ -3307,6 +3637,9 @@ export interface ListRegistriesResponse { } export namespace ListRegistriesResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListRegistriesResponse): any => ({ ...obj, }); @@ -3330,6 +3663,9 @@ export interface ListSchemasInput { } export namespace ListSchemasInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListSchemasInput): any => ({ ...obj, }); @@ -3376,6 +3712,9 @@ export interface SchemaListItem { } export namespace SchemaListItem { + /** + * @internal + */ export const filterSensitiveLog = (obj: SchemaListItem): any => ({ ...obj, }); @@ -3394,6 +3733,9 @@ export interface ListSchemasResponse { } export namespace ListSchemasResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListSchemasResponse): any => ({ ...obj, }); @@ -3425,6 +3767,9 @@ export interface ListSchemaVersionsInput { } export namespace ListSchemaVersionsInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListSchemaVersionsInput): any => ({ ...obj, }); @@ -3461,6 +3806,9 @@ export interface SchemaVersionListItem { } export namespace SchemaVersionListItem { + /** + * @internal + */ export const filterSensitiveLog = (obj: SchemaVersionListItem): any => ({ ...obj, }); @@ -3479,6 +3827,9 @@ export interface ListSchemaVersionsResponse { } export namespace ListSchemaVersionsResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListSchemaVersionsResponse): any => ({ ...obj, }); @@ -3508,6 +3859,9 @@ export interface ListTriggersRequest { } export namespace ListTriggersRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListTriggersRequest): any => ({ ...obj, }); @@ -3527,6 +3881,9 @@ export interface ListTriggersResponse { } export namespace ListTriggersResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListTriggersResponse): any => ({ ...obj, }); @@ -3545,6 +3902,9 @@ export interface ListWorkflowsRequest { } export namespace ListWorkflowsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListWorkflowsRequest): any => ({ ...obj, }); @@ -3563,6 +3923,9 @@ export interface ListWorkflowsResponse { } export namespace ListWorkflowsResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListWorkflowsResponse): any => ({ ...obj, }); @@ -3582,6 +3945,9 @@ export interface PutDataCatalogEncryptionSettingsRequest { } export namespace PutDataCatalogEncryptionSettingsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: PutDataCatalogEncryptionSettingsRequest): any => ({ ...obj, }); @@ -3590,6 +3956,9 @@ export namespace PutDataCatalogEncryptionSettingsRequest { export interface PutDataCatalogEncryptionSettingsResponse {} export namespace PutDataCatalogEncryptionSettingsResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: PutDataCatalogEncryptionSettingsResponse): any => ({ ...obj, }); @@ -3651,6 +4020,9 @@ export interface PutResourcePolicyRequest { } export namespace PutResourcePolicyRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: PutResourcePolicyRequest): any => ({ ...obj, }); @@ -3666,6 +4038,9 @@ export interface PutResourcePolicyResponse { } export namespace PutResourcePolicyResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: PutResourcePolicyResponse): any => ({ ...obj, }); @@ -3687,6 +4062,9 @@ export interface MetadataKeyValuePair { } export namespace MetadataKeyValuePair { + /** + * @internal + */ export const filterSensitiveLog = (obj: MetadataKeyValuePair): any => ({ ...obj, }); @@ -3715,6 +4093,9 @@ export interface PutSchemaVersionMetadataInput { } export namespace PutSchemaVersionMetadataInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: PutSchemaVersionMetadataInput): any => ({ ...obj, }); @@ -3763,6 +4144,9 @@ export interface PutSchemaVersionMetadataResponse { } export namespace PutSchemaVersionMetadataResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: PutSchemaVersionMetadataResponse): any => ({ ...obj, }); @@ -3786,6 +4170,9 @@ export interface PutWorkflowRunPropertiesRequest { } export namespace PutWorkflowRunPropertiesRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: PutWorkflowRunPropertiesRequest): any => ({ ...obj, }); @@ -3794,6 +4181,9 @@ export namespace PutWorkflowRunPropertiesRequest { export interface PutWorkflowRunPropertiesResponse {} export namespace PutWorkflowRunPropertiesResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: PutWorkflowRunPropertiesResponse): any => ({ ...obj, }); @@ -3832,6 +4222,9 @@ export interface QuerySchemaVersionMetadataInput { } export namespace QuerySchemaVersionMetadataInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: QuerySchemaVersionMetadataInput): any => ({ ...obj, }); @@ -3853,6 +4246,9 @@ export interface OtherMetadataValueListItem { } export namespace OtherMetadataValueListItem { + /** + * @internal + */ export const filterSensitiveLog = (obj: OtherMetadataValueListItem): any => ({ ...obj, }); @@ -3879,6 +4275,9 @@ export interface MetadataInfo { } export namespace MetadataInfo { + /** + * @internal + */ export const filterSensitiveLog = (obj: MetadataInfo): any => ({ ...obj, }); @@ -3902,6 +4301,9 @@ export interface QuerySchemaVersionMetadataResponse { } export namespace QuerySchemaVersionMetadataResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: QuerySchemaVersionMetadataResponse): any => ({ ...obj, }); @@ -3928,6 +4330,9 @@ export interface RegisterSchemaVersionInput { } export namespace RegisterSchemaVersionInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: RegisterSchemaVersionInput): any => ({ ...obj, }); @@ -3951,6 +4356,9 @@ export interface RegisterSchemaVersionResponse { } export namespace RegisterSchemaVersionResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: RegisterSchemaVersionResponse): any => ({ ...obj, }); @@ -3979,6 +4387,9 @@ export interface RemoveSchemaVersionMetadataInput { } export namespace RemoveSchemaVersionMetadataInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: RemoveSchemaVersionMetadataInput): any => ({ ...obj, }); @@ -4027,6 +4438,9 @@ export interface RemoveSchemaVersionMetadataResponse { } export namespace RemoveSchemaVersionMetadataResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: RemoveSchemaVersionMetadataResponse): any => ({ ...obj, }); @@ -4045,6 +4459,9 @@ export interface ResetJobBookmarkRequest { } export namespace ResetJobBookmarkRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ResetJobBookmarkRequest): any => ({ ...obj, }); @@ -4058,6 +4475,9 @@ export interface ResetJobBookmarkResponse { } export namespace ResetJobBookmarkResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ResetJobBookmarkResponse): any => ({ ...obj, }); @@ -4076,6 +4496,9 @@ export interface ConcurrentRunsExceededException extends __SmithyException, $Met } export namespace ConcurrentRunsExceededException { + /** + * @internal + */ export const filterSensitiveLog = (obj: ConcurrentRunsExceededException): any => ({ ...obj, }); @@ -4094,6 +4517,9 @@ export interface IllegalWorkflowStateException extends __SmithyException, $Metad } export namespace IllegalWorkflowStateException { + /** + * @internal + */ export const filterSensitiveLog = (obj: IllegalWorkflowStateException): any => ({ ...obj, }); @@ -4117,6 +4543,9 @@ export interface ResumeWorkflowRunRequest { } export namespace ResumeWorkflowRunRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ResumeWorkflowRunRequest): any => ({ ...obj, }); @@ -4135,6 +4564,9 @@ export interface ResumeWorkflowRunResponse { } export namespace ResumeWorkflowRunResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ResumeWorkflowRunResponse): any => ({ ...obj, }); @@ -4169,6 +4601,9 @@ export interface PropertyPredicate { } export namespace PropertyPredicate { + /** + * @internal + */ export const filterSensitiveLog = (obj: PropertyPredicate): any => ({ ...obj, }); @@ -4195,6 +4630,9 @@ export interface SortCriterion { } export namespace SortCriterion { + /** + * @internal + */ export const filterSensitiveLog = (obj: SortCriterion): any => ({ ...obj, }); @@ -4252,6 +4690,9 @@ export interface SearchTablesRequest { } export namespace SearchTablesRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: SearchTablesRequest): any => ({ ...obj, }); @@ -4270,6 +4711,9 @@ export interface SearchTablesResponse { } export namespace SearchTablesResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: SearchTablesResponse): any => ({ ...obj, }); @@ -4283,6 +4727,9 @@ export interface StartCrawlerRequest { } export namespace StartCrawlerRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: StartCrawlerRequest): any => ({ ...obj, }); @@ -4291,6 +4738,9 @@ export namespace StartCrawlerRequest { export interface StartCrawlerResponse {} export namespace StartCrawlerResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: StartCrawlerResponse): any => ({ ...obj, }); @@ -4309,6 +4759,9 @@ export interface NoScheduleException extends __SmithyException, $MetadataBearer } export namespace NoScheduleException { + /** + * @internal + */ export const filterSensitiveLog = (obj: NoScheduleException): any => ({ ...obj, }); @@ -4327,6 +4780,9 @@ export interface SchedulerRunningException extends __SmithyException, $MetadataB } export namespace SchedulerRunningException { + /** + * @internal + */ export const filterSensitiveLog = (obj: SchedulerRunningException): any => ({ ...obj, }); @@ -4340,6 +4796,9 @@ export interface StartCrawlerScheduleRequest { } export namespace StartCrawlerScheduleRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: StartCrawlerScheduleRequest): any => ({ ...obj, }); @@ -4348,6 +4807,9 @@ export namespace StartCrawlerScheduleRequest { export interface StartCrawlerScheduleResponse {} export namespace StartCrawlerScheduleResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: StartCrawlerScheduleResponse): any => ({ ...obj, }); @@ -4366,6 +4828,9 @@ export interface StartExportLabelsTaskRunRequest { } export namespace StartExportLabelsTaskRunRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: StartExportLabelsTaskRunRequest): any => ({ ...obj, }); @@ -4379,6 +4844,9 @@ export interface StartExportLabelsTaskRunResponse { } export namespace StartExportLabelsTaskRunResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: StartExportLabelsTaskRunResponse): any => ({ ...obj, }); @@ -4403,6 +4871,9 @@ export interface StartImportLabelsTaskRunRequest { } export namespace StartImportLabelsTaskRunRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: StartImportLabelsTaskRunRequest): any => ({ ...obj, }); @@ -4416,6 +4887,9 @@ export interface StartImportLabelsTaskRunResponse { } export namespace StartImportLabelsTaskRunResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: StartImportLabelsTaskRunResponse): any => ({ ...obj, }); @@ -4519,6 +4993,9 @@ export interface StartJobRunRequest { } export namespace StartJobRunRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: StartJobRunRequest): any => ({ ...obj, }); @@ -4532,6 +5009,9 @@ export interface StartJobRunResponse { } export namespace StartJobRunResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: StartJobRunResponse): any => ({ ...obj, }); @@ -4550,6 +5030,9 @@ export interface MLTransformNotReadyException extends __SmithyException, $Metada } export namespace MLTransformNotReadyException { + /** + * @internal + */ export const filterSensitiveLog = (obj: MLTransformNotReadyException): any => ({ ...obj, }); @@ -4563,6 +5046,9 @@ export interface StartMLEvaluationTaskRunRequest { } export namespace StartMLEvaluationTaskRunRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: StartMLEvaluationTaskRunRequest): any => ({ ...obj, }); @@ -4576,6 +5062,9 @@ export interface StartMLEvaluationTaskRunResponse { } export namespace StartMLEvaluationTaskRunResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: StartMLEvaluationTaskRunResponse): any => ({ ...obj, }); @@ -4595,6 +5084,9 @@ export interface StartMLLabelingSetGenerationTaskRunRequest { } export namespace StartMLLabelingSetGenerationTaskRunRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: StartMLLabelingSetGenerationTaskRunRequest): any => ({ ...obj, }); @@ -4608,6 +5100,9 @@ export interface StartMLLabelingSetGenerationTaskRunResponse { } export namespace StartMLLabelingSetGenerationTaskRunResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: StartMLLabelingSetGenerationTaskRunResponse): any => ({ ...obj, }); @@ -4621,6 +5116,9 @@ export interface StartTriggerRequest { } export namespace StartTriggerRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: StartTriggerRequest): any => ({ ...obj, }); @@ -4634,6 +5132,9 @@ export interface StartTriggerResponse { } export namespace StartTriggerResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: StartTriggerResponse): any => ({ ...obj, }); @@ -4647,6 +5148,9 @@ export interface StartWorkflowRunRequest { } export namespace StartWorkflowRunRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: StartWorkflowRunRequest): any => ({ ...obj, }); @@ -4660,6 +5164,9 @@ export interface StartWorkflowRunResponse { } export namespace StartWorkflowRunResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: StartWorkflowRunResponse): any => ({ ...obj, }); @@ -4678,6 +5185,9 @@ export interface CrawlerNotRunningException extends __SmithyException, $Metadata } export namespace CrawlerNotRunningException { + /** + * @internal + */ export const filterSensitiveLog = (obj: CrawlerNotRunningException): any => ({ ...obj, }); @@ -4696,6 +5206,9 @@ export interface CrawlerStoppingException extends __SmithyException, $MetadataBe } export namespace CrawlerStoppingException { + /** + * @internal + */ export const filterSensitiveLog = (obj: CrawlerStoppingException): any => ({ ...obj, }); @@ -4709,6 +5222,9 @@ export interface StopCrawlerRequest { } export namespace StopCrawlerRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: StopCrawlerRequest): any => ({ ...obj, }); @@ -4717,6 +5233,9 @@ export namespace StopCrawlerRequest { export interface StopCrawlerResponse {} export namespace StopCrawlerResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: StopCrawlerResponse): any => ({ ...obj, }); @@ -4735,6 +5254,9 @@ export interface SchedulerNotRunningException extends __SmithyException, $Metada } export namespace SchedulerNotRunningException { + /** + * @internal + */ export const filterSensitiveLog = (obj: SchedulerNotRunningException): any => ({ ...obj, }); @@ -4748,6 +5270,9 @@ export interface StopCrawlerScheduleRequest { } export namespace StopCrawlerScheduleRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: StopCrawlerScheduleRequest): any => ({ ...obj, }); @@ -4756,6 +5281,9 @@ export namespace StopCrawlerScheduleRequest { export interface StopCrawlerScheduleResponse {} export namespace StopCrawlerScheduleResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: StopCrawlerScheduleResponse): any => ({ ...obj, }); @@ -4769,6 +5297,9 @@ export interface StopTriggerRequest { } export namespace StopTriggerRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: StopTriggerRequest): any => ({ ...obj, }); @@ -4782,6 +5313,9 @@ export interface StopTriggerResponse { } export namespace StopTriggerResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: StopTriggerResponse): any => ({ ...obj, }); @@ -4800,6 +5334,9 @@ export interface StopWorkflowRunRequest { } export namespace StopWorkflowRunRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: StopWorkflowRunRequest): any => ({ ...obj, }); @@ -4808,6 +5345,9 @@ export namespace StopWorkflowRunRequest { export interface StopWorkflowRunResponse {} export namespace StopWorkflowRunResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: StopWorkflowRunResponse): any => ({ ...obj, }); @@ -4827,6 +5367,9 @@ export interface TagResourceRequest { } export namespace TagResourceRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: TagResourceRequest): any => ({ ...obj, }); @@ -4835,6 +5378,9 @@ export namespace TagResourceRequest { export interface TagResourceResponse {} export namespace TagResourceResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: TagResourceResponse): any => ({ ...obj, }); @@ -4853,6 +5399,9 @@ export interface UntagResourceRequest { } export namespace UntagResourceRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: UntagResourceRequest): any => ({ ...obj, }); @@ -4861,6 +5410,9 @@ export namespace UntagResourceRequest { export interface UntagResourceResponse {} export namespace UntagResourceResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: UntagResourceResponse): any => ({ ...obj, }); @@ -4908,6 +5460,9 @@ export interface UpdateCsvClassifierRequest { } export namespace UpdateCsvClassifierRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateCsvClassifierRequest): any => ({ ...obj, }); @@ -4941,6 +5496,9 @@ export interface UpdateGrokClassifierRequest { } export namespace UpdateGrokClassifierRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateGrokClassifierRequest): any => ({ ...obj, }); @@ -4963,6 +5521,9 @@ export interface UpdateJsonClassifierRequest { } export namespace UpdateJsonClassifierRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateJsonClassifierRequest): any => ({ ...obj, }); @@ -4993,6 +5554,9 @@ export interface UpdateXMLClassifierRequest { } export namespace UpdateXMLClassifierRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateXMLClassifierRequest): any => ({ ...obj, }); @@ -5021,6 +5585,9 @@ export interface UpdateClassifierRequest { } export namespace UpdateClassifierRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateClassifierRequest): any => ({ ...obj, }); @@ -5029,6 +5596,9 @@ export namespace UpdateClassifierRequest { export interface UpdateClassifierResponse {} export namespace UpdateClassifierResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateClassifierResponse): any => ({ ...obj, }); @@ -5047,6 +5617,9 @@ export interface VersionMismatchException extends __SmithyException, $MetadataBe } export namespace VersionMismatchException { + /** + * @internal + */ export const filterSensitiveLog = (obj: VersionMismatchException): any => ({ ...obj, }); @@ -5081,6 +5654,9 @@ export interface UpdateColumnStatisticsForPartitionRequest { } export namespace UpdateColumnStatisticsForPartitionRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateColumnStatisticsForPartitionRequest): any => ({ ...obj, }); @@ -5102,6 +5678,9 @@ export interface ColumnStatisticsError { } export namespace ColumnStatisticsError { + /** + * @internal + */ export const filterSensitiveLog = (obj: ColumnStatisticsError): any => ({ ...obj, }); @@ -5115,6 +5694,9 @@ export interface UpdateColumnStatisticsForPartitionResponse { } export namespace UpdateColumnStatisticsForPartitionResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateColumnStatisticsForPartitionResponse): any => ({ ...obj, }); @@ -5144,6 +5726,9 @@ export interface UpdateColumnStatisticsForTableRequest { } export namespace UpdateColumnStatisticsForTableRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateColumnStatisticsForTableRequest): any => ({ ...obj, }); @@ -5157,6 +5742,9 @@ export interface UpdateColumnStatisticsForTableResponse { } export namespace UpdateColumnStatisticsForTableResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateColumnStatisticsForTableResponse): any => ({ ...obj, }); @@ -5182,6 +5770,9 @@ export interface UpdateConnectionRequest { } export namespace UpdateConnectionRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateConnectionRequest): any => ({ ...obj, }); @@ -5190,6 +5781,9 @@ export namespace UpdateConnectionRequest { export interface UpdateConnectionResponse {} export namespace UpdateConnectionResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateConnectionResponse): any => ({ ...obj, }); @@ -5273,6 +5867,9 @@ export interface UpdateCrawlerRequest { } export namespace UpdateCrawlerRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateCrawlerRequest): any => ({ ...obj, }); @@ -5281,6 +5878,9 @@ export namespace UpdateCrawlerRequest { export interface UpdateCrawlerResponse {} export namespace UpdateCrawlerResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateCrawlerResponse): any => ({ ...obj, }); @@ -5301,6 +5901,9 @@ export interface UpdateCrawlerScheduleRequest { } export namespace UpdateCrawlerScheduleRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateCrawlerScheduleRequest): any => ({ ...obj, }); @@ -5309,6 +5912,9 @@ export namespace UpdateCrawlerScheduleRequest { export interface UpdateCrawlerScheduleResponse {} export namespace UpdateCrawlerScheduleResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateCrawlerScheduleResponse): any => ({ ...obj, }); @@ -5335,6 +5941,9 @@ export interface UpdateDatabaseRequest { } export namespace UpdateDatabaseRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateDatabaseRequest): any => ({ ...obj, }); @@ -5343,6 +5952,9 @@ export namespace UpdateDatabaseRequest { export interface UpdateDatabaseResponse {} export namespace UpdateDatabaseResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateDatabaseResponse): any => ({ ...obj, }); @@ -5375,6 +5987,9 @@ export interface DevEndpointCustomLibraries { } export namespace DevEndpointCustomLibraries { + /** + * @internal + */ export const filterSensitiveLog = (obj: DevEndpointCustomLibraries): any => ({ ...obj, }); @@ -5448,6 +6063,9 @@ export interface UpdateDevEndpointRequest { } export namespace UpdateDevEndpointRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateDevEndpointRequest): any => ({ ...obj, }); @@ -5456,6 +6074,9 @@ export namespace UpdateDevEndpointRequest { export interface UpdateDevEndpointResponse {} export namespace UpdateDevEndpointResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateDevEndpointResponse): any => ({ ...obj, }); @@ -5603,6 +6224,9 @@ export interface JobUpdate { } export namespace JobUpdate { + /** + * @internal + */ export const filterSensitiveLog = (obj: JobUpdate): any => ({ ...obj, }); @@ -5621,6 +6245,9 @@ export interface UpdateJobRequest { } export namespace UpdateJobRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateJobRequest): any => ({ ...obj, }); @@ -5634,6 +6261,9 @@ export interface UpdateJobResponse { } export namespace UpdateJobResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateJobResponse): any => ({ ...obj, }); @@ -5715,6 +6345,9 @@ export interface UpdateMLTransformRequest { } export namespace UpdateMLTransformRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateMLTransformRequest): any => ({ ...obj, }); @@ -5728,6 +6361,9 @@ export interface UpdateMLTransformResponse { } export namespace UpdateMLTransformResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateMLTransformResponse): any => ({ ...obj, }); @@ -5765,6 +6401,9 @@ export interface UpdatePartitionRequest { } export namespace UpdatePartitionRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdatePartitionRequest): any => ({ ...obj, }); @@ -5773,6 +6412,9 @@ export namespace UpdatePartitionRequest { export interface UpdatePartitionResponse {} export namespace UpdatePartitionResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdatePartitionResponse): any => ({ ...obj, }); @@ -5791,6 +6433,9 @@ export interface UpdateRegistryInput { } export namespace UpdateRegistryInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateRegistryInput): any => ({ ...obj, }); @@ -5809,6 +6454,9 @@ export interface UpdateRegistryResponse { } export namespace UpdateRegistryResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateRegistryResponse): any => ({ ...obj, }); @@ -5845,6 +6493,9 @@ export interface UpdateSchemaInput { } export namespace UpdateSchemaInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateSchemaInput): any => ({ ...obj, }); @@ -5868,6 +6519,9 @@ export interface UpdateSchemaResponse { } export namespace UpdateSchemaResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateSchemaResponse): any => ({ ...obj, }); @@ -5901,6 +6555,9 @@ export interface UpdateTableRequest { } export namespace UpdateTableRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateTableRequest): any => ({ ...obj, }); @@ -5909,6 +6566,9 @@ export namespace UpdateTableRequest { export interface UpdateTableResponse {} export namespace UpdateTableResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateTableResponse): any => ({ ...obj, }); @@ -5949,6 +6609,9 @@ export interface TriggerUpdate { } export namespace TriggerUpdate { + /** + * @internal + */ export const filterSensitiveLog = (obj: TriggerUpdate): any => ({ ...obj, }); @@ -5967,6 +6630,9 @@ export interface UpdateTriggerRequest { } export namespace UpdateTriggerRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateTriggerRequest): any => ({ ...obj, }); @@ -5980,6 +6646,9 @@ export interface UpdateTriggerResponse { } export namespace UpdateTriggerResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateTriggerResponse): any => ({ ...obj, }); @@ -6011,6 +6680,9 @@ export interface UpdateUserDefinedFunctionRequest { } export namespace UpdateUserDefinedFunctionRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateUserDefinedFunctionRequest): any => ({ ...obj, }); @@ -6019,6 +6691,9 @@ export namespace UpdateUserDefinedFunctionRequest { export interface UpdateUserDefinedFunctionResponse {} export namespace UpdateUserDefinedFunctionResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateUserDefinedFunctionResponse): any => ({ ...obj, }); @@ -6047,6 +6722,9 @@ export interface UpdateWorkflowRequest { } export namespace UpdateWorkflowRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateWorkflowRequest): any => ({ ...obj, }); @@ -6060,6 +6738,9 @@ export interface UpdateWorkflowResponse { } export namespace UpdateWorkflowResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateWorkflowResponse): any => ({ ...obj, }); diff --git a/clients/client-greengrass/commands/AssociateRoleToGroupCommand.ts b/clients/client-greengrass/commands/AssociateRoleToGroupCommand.ts index 0f4dbc98f206..cb7c880d0aac 100644 --- a/clients/client-greengrass/commands/AssociateRoleToGroupCommand.ts +++ b/clients/client-greengrass/commands/AssociateRoleToGroupCommand.ts @@ -22,6 +22,20 @@ export interface AssociateRoleToGroupCommandOutput extends AssociateRoleToGroupR /** * 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. + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { GreengrassClient, AssociateRoleToGroupCommand } from "@aws-sdk/client-greengrass"; // ES Modules import + * // const { GreengrassClient, AssociateRoleToGroupCommand } = require("@aws-sdk/client-greengrass"); // CommonJS import + * const client = new GreengrassClient(config); + * const command = new AssociateRoleToGroupCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link AssociateRoleToGroupCommandInput} for command's `input` shape. + * @see {@link AssociateRoleToGroupCommandOutput} for command's `response` shape. + * @see {@link GreengrassClientResolvedConfig | config} for command's `input` shape. + * */ export class AssociateRoleToGroupCommand extends $Command< AssociateRoleToGroupCommandInput, diff --git a/clients/client-greengrass/commands/AssociateServiceRoleToAccountCommand.ts b/clients/client-greengrass/commands/AssociateServiceRoleToAccountCommand.ts index ab27617d987d..436eb3a3c4c0 100644 --- a/clients/client-greengrass/commands/AssociateServiceRoleToAccountCommand.ts +++ b/clients/client-greengrass/commands/AssociateServiceRoleToAccountCommand.ts @@ -24,6 +24,20 @@ export interface AssociateServiceRoleToAccountCommandOutput /** * 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''. + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { GreengrassClient, AssociateServiceRoleToAccountCommand } from "@aws-sdk/client-greengrass"; // ES Modules import + * // const { GreengrassClient, AssociateServiceRoleToAccountCommand } = require("@aws-sdk/client-greengrass"); // CommonJS import + * const client = new GreengrassClient(config); + * const command = new AssociateServiceRoleToAccountCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link AssociateServiceRoleToAccountCommandInput} for command's `input` shape. + * @see {@link AssociateServiceRoleToAccountCommandOutput} for command's `response` shape. + * @see {@link GreengrassClientResolvedConfig | config} for command's `input` shape. + * */ export class AssociateServiceRoleToAccountCommand extends $Command< AssociateServiceRoleToAccountCommandInput, diff --git a/clients/client-greengrass/commands/CreateConnectorDefinitionCommand.ts b/clients/client-greengrass/commands/CreateConnectorDefinitionCommand.ts index 72a2e83aeb46..96d91bcf9fff 100644 --- a/clients/client-greengrass/commands/CreateConnectorDefinitionCommand.ts +++ b/clients/client-greengrass/commands/CreateConnectorDefinitionCommand.ts @@ -22,6 +22,20 @@ export interface CreateConnectorDefinitionCommandOutput extends CreateConnectorD /** * Creates a connector definition. You may provide the initial version of the connector definition now or use ''CreateConnectorDefinitionVersion'' at a later time. + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { GreengrassClient, CreateConnectorDefinitionCommand } from "@aws-sdk/client-greengrass"; // ES Modules import + * // const { GreengrassClient, CreateConnectorDefinitionCommand } = require("@aws-sdk/client-greengrass"); // CommonJS import + * const client = new GreengrassClient(config); + * const command = new CreateConnectorDefinitionCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreateConnectorDefinitionCommandInput} for command's `input` shape. + * @see {@link CreateConnectorDefinitionCommandOutput} for command's `response` shape. + * @see {@link GreengrassClientResolvedConfig | config} for command's `input` shape. + * */ export class CreateConnectorDefinitionCommand extends $Command< CreateConnectorDefinitionCommandInput, diff --git a/clients/client-greengrass/commands/CreateConnectorDefinitionVersionCommand.ts b/clients/client-greengrass/commands/CreateConnectorDefinitionVersionCommand.ts index 8ecc3da2dcb6..6dd63cf7676b 100644 --- a/clients/client-greengrass/commands/CreateConnectorDefinitionVersionCommand.ts +++ b/clients/client-greengrass/commands/CreateConnectorDefinitionVersionCommand.ts @@ -24,6 +24,20 @@ export interface CreateConnectorDefinitionVersionCommandOutput /** * Creates a version of a connector definition which has already been defined. + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { GreengrassClient, CreateConnectorDefinitionVersionCommand } from "@aws-sdk/client-greengrass"; // ES Modules import + * // const { GreengrassClient, CreateConnectorDefinitionVersionCommand } = require("@aws-sdk/client-greengrass"); // CommonJS import + * const client = new GreengrassClient(config); + * const command = new CreateConnectorDefinitionVersionCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreateConnectorDefinitionVersionCommandInput} for command's `input` shape. + * @see {@link CreateConnectorDefinitionVersionCommandOutput} for command's `response` shape. + * @see {@link GreengrassClientResolvedConfig | config} for command's `input` shape. + * */ export class CreateConnectorDefinitionVersionCommand extends $Command< CreateConnectorDefinitionVersionCommandInput, diff --git a/clients/client-greengrass/commands/CreateCoreDefinitionCommand.ts b/clients/client-greengrass/commands/CreateCoreDefinitionCommand.ts index 93ea46145067..932f2f8906b3 100644 --- a/clients/client-greengrass/commands/CreateCoreDefinitionCommand.ts +++ b/clients/client-greengrass/commands/CreateCoreDefinitionCommand.ts @@ -22,6 +22,20 @@ export interface CreateCoreDefinitionCommandOutput extends CreateCoreDefinitionR /** * 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. + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { GreengrassClient, CreateCoreDefinitionCommand } from "@aws-sdk/client-greengrass"; // ES Modules import + * // const { GreengrassClient, CreateCoreDefinitionCommand } = require("@aws-sdk/client-greengrass"); // CommonJS import + * const client = new GreengrassClient(config); + * const command = new CreateCoreDefinitionCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreateCoreDefinitionCommandInput} for command's `input` shape. + * @see {@link CreateCoreDefinitionCommandOutput} for command's `response` shape. + * @see {@link GreengrassClientResolvedConfig | config} for command's `input` shape. + * */ export class CreateCoreDefinitionCommand extends $Command< CreateCoreDefinitionCommandInput, diff --git a/clients/client-greengrass/commands/CreateCoreDefinitionVersionCommand.ts b/clients/client-greengrass/commands/CreateCoreDefinitionVersionCommand.ts index 818176301d17..31f532e0be2b 100644 --- a/clients/client-greengrass/commands/CreateCoreDefinitionVersionCommand.ts +++ b/clients/client-greengrass/commands/CreateCoreDefinitionVersionCommand.ts @@ -24,6 +24,20 @@ export interface CreateCoreDefinitionVersionCommandOutput /** * Creates a version of a core definition that has already been defined. Greengrass groups must each contain exactly one Greengrass core. + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { GreengrassClient, CreateCoreDefinitionVersionCommand } from "@aws-sdk/client-greengrass"; // ES Modules import + * // const { GreengrassClient, CreateCoreDefinitionVersionCommand } = require("@aws-sdk/client-greengrass"); // CommonJS import + * const client = new GreengrassClient(config); + * const command = new CreateCoreDefinitionVersionCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreateCoreDefinitionVersionCommandInput} for command's `input` shape. + * @see {@link CreateCoreDefinitionVersionCommandOutput} for command's `response` shape. + * @see {@link GreengrassClientResolvedConfig | config} for command's `input` shape. + * */ export class CreateCoreDefinitionVersionCommand extends $Command< CreateCoreDefinitionVersionCommandInput, diff --git a/clients/client-greengrass/commands/CreateDeploymentCommand.ts b/clients/client-greengrass/commands/CreateDeploymentCommand.ts index 4d655d77f2c8..0174986a5f97 100644 --- a/clients/client-greengrass/commands/CreateDeploymentCommand.ts +++ b/clients/client-greengrass/commands/CreateDeploymentCommand.ts @@ -22,6 +22,20 @@ export interface CreateDeploymentCommandOutput extends CreateDeploymentResponse, /** * Creates a deployment. ''CreateDeployment'' requests are idempotent with respect to the ''X-Amzn-Client-Token'' token and the request parameters. + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { GreengrassClient, CreateDeploymentCommand } from "@aws-sdk/client-greengrass"; // ES Modules import + * // const { GreengrassClient, CreateDeploymentCommand } = require("@aws-sdk/client-greengrass"); // CommonJS import + * const client = new GreengrassClient(config); + * const command = new CreateDeploymentCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreateDeploymentCommandInput} for command's `input` shape. + * @see {@link CreateDeploymentCommandOutput} for command's `response` shape. + * @see {@link GreengrassClientResolvedConfig | config} for command's `input` shape. + * */ export class CreateDeploymentCommand extends $Command< CreateDeploymentCommandInput, diff --git a/clients/client-greengrass/commands/CreateDeviceDefinitionCommand.ts b/clients/client-greengrass/commands/CreateDeviceDefinitionCommand.ts index dc9f3af1151b..b45cc2deb92e 100644 --- a/clients/client-greengrass/commands/CreateDeviceDefinitionCommand.ts +++ b/clients/client-greengrass/commands/CreateDeviceDefinitionCommand.ts @@ -22,6 +22,20 @@ export interface CreateDeviceDefinitionCommandOutput extends CreateDeviceDefinit /** * Creates a device definition. You may provide the initial version of the device definition now or use ''CreateDeviceDefinitionVersion'' at a later time. + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { GreengrassClient, CreateDeviceDefinitionCommand } from "@aws-sdk/client-greengrass"; // ES Modules import + * // const { GreengrassClient, CreateDeviceDefinitionCommand } = require("@aws-sdk/client-greengrass"); // CommonJS import + * const client = new GreengrassClient(config); + * const command = new CreateDeviceDefinitionCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreateDeviceDefinitionCommandInput} for command's `input` shape. + * @see {@link CreateDeviceDefinitionCommandOutput} for command's `response` shape. + * @see {@link GreengrassClientResolvedConfig | config} for command's `input` shape. + * */ export class CreateDeviceDefinitionCommand extends $Command< CreateDeviceDefinitionCommandInput, diff --git a/clients/client-greengrass/commands/CreateDeviceDefinitionVersionCommand.ts b/clients/client-greengrass/commands/CreateDeviceDefinitionVersionCommand.ts index ec5b4357635c..a597d3f83fc4 100644 --- a/clients/client-greengrass/commands/CreateDeviceDefinitionVersionCommand.ts +++ b/clients/client-greengrass/commands/CreateDeviceDefinitionVersionCommand.ts @@ -24,6 +24,20 @@ export interface CreateDeviceDefinitionVersionCommandOutput /** * Creates a version of a device definition that has already been defined. + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { GreengrassClient, CreateDeviceDefinitionVersionCommand } from "@aws-sdk/client-greengrass"; // ES Modules import + * // const { GreengrassClient, CreateDeviceDefinitionVersionCommand } = require("@aws-sdk/client-greengrass"); // CommonJS import + * const client = new GreengrassClient(config); + * const command = new CreateDeviceDefinitionVersionCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreateDeviceDefinitionVersionCommandInput} for command's `input` shape. + * @see {@link CreateDeviceDefinitionVersionCommandOutput} for command's `response` shape. + * @see {@link GreengrassClientResolvedConfig | config} for command's `input` shape. + * */ export class CreateDeviceDefinitionVersionCommand extends $Command< CreateDeviceDefinitionVersionCommandInput, diff --git a/clients/client-greengrass/commands/CreateFunctionDefinitionCommand.ts b/clients/client-greengrass/commands/CreateFunctionDefinitionCommand.ts index 094fd06b8da7..72173e1ddba0 100644 --- a/clients/client-greengrass/commands/CreateFunctionDefinitionCommand.ts +++ b/clients/client-greengrass/commands/CreateFunctionDefinitionCommand.ts @@ -22,6 +22,20 @@ export interface CreateFunctionDefinitionCommandOutput extends CreateFunctionDef /** * 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. + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { GreengrassClient, CreateFunctionDefinitionCommand } from "@aws-sdk/client-greengrass"; // ES Modules import + * // const { GreengrassClient, CreateFunctionDefinitionCommand } = require("@aws-sdk/client-greengrass"); // CommonJS import + * const client = new GreengrassClient(config); + * const command = new CreateFunctionDefinitionCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreateFunctionDefinitionCommandInput} for command's `input` shape. + * @see {@link CreateFunctionDefinitionCommandOutput} for command's `response` shape. + * @see {@link GreengrassClientResolvedConfig | config} for command's `input` shape. + * */ export class CreateFunctionDefinitionCommand extends $Command< CreateFunctionDefinitionCommandInput, diff --git a/clients/client-greengrass/commands/CreateFunctionDefinitionVersionCommand.ts b/clients/client-greengrass/commands/CreateFunctionDefinitionVersionCommand.ts index 401b8abd81a7..238bf48aa6b9 100644 --- a/clients/client-greengrass/commands/CreateFunctionDefinitionVersionCommand.ts +++ b/clients/client-greengrass/commands/CreateFunctionDefinitionVersionCommand.ts @@ -24,6 +24,20 @@ export interface CreateFunctionDefinitionVersionCommandOutput /** * Creates a version of a Lambda function definition that has already been defined. + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { GreengrassClient, CreateFunctionDefinitionVersionCommand } from "@aws-sdk/client-greengrass"; // ES Modules import + * // const { GreengrassClient, CreateFunctionDefinitionVersionCommand } = require("@aws-sdk/client-greengrass"); // CommonJS import + * const client = new GreengrassClient(config); + * const command = new CreateFunctionDefinitionVersionCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreateFunctionDefinitionVersionCommandInput} for command's `input` shape. + * @see {@link CreateFunctionDefinitionVersionCommandOutput} for command's `response` shape. + * @see {@link GreengrassClientResolvedConfig | config} for command's `input` shape. + * */ export class CreateFunctionDefinitionVersionCommand extends $Command< CreateFunctionDefinitionVersionCommandInput, diff --git a/clients/client-greengrass/commands/CreateGroupCertificateAuthorityCommand.ts b/clients/client-greengrass/commands/CreateGroupCertificateAuthorityCommand.ts index f92a4ebde578..ce9bbcb68755 100644 --- a/clients/client-greengrass/commands/CreateGroupCertificateAuthorityCommand.ts +++ b/clients/client-greengrass/commands/CreateGroupCertificateAuthorityCommand.ts @@ -24,6 +24,20 @@ export interface CreateGroupCertificateAuthorityCommandOutput /** * Creates a CA for the group. If a CA already exists, it will rotate the existing CA. + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { GreengrassClient, CreateGroupCertificateAuthorityCommand } from "@aws-sdk/client-greengrass"; // ES Modules import + * // const { GreengrassClient, CreateGroupCertificateAuthorityCommand } = require("@aws-sdk/client-greengrass"); // CommonJS import + * const client = new GreengrassClient(config); + * const command = new CreateGroupCertificateAuthorityCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreateGroupCertificateAuthorityCommandInput} for command's `input` shape. + * @see {@link CreateGroupCertificateAuthorityCommandOutput} for command's `response` shape. + * @see {@link GreengrassClientResolvedConfig | config} for command's `input` shape. + * */ export class CreateGroupCertificateAuthorityCommand extends $Command< CreateGroupCertificateAuthorityCommandInput, diff --git a/clients/client-greengrass/commands/CreateGroupCommand.ts b/clients/client-greengrass/commands/CreateGroupCommand.ts index 33b5391ba5d2..6088d07bdba7 100644 --- a/clients/client-greengrass/commands/CreateGroupCommand.ts +++ b/clients/client-greengrass/commands/CreateGroupCommand.ts @@ -22,6 +22,20 @@ export interface CreateGroupCommandOutput extends CreateGroupResponse, __Metadat /** * 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. + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { GreengrassClient, CreateGroupCommand } from "@aws-sdk/client-greengrass"; // ES Modules import + * // const { GreengrassClient, CreateGroupCommand } = require("@aws-sdk/client-greengrass"); // CommonJS import + * const client = new GreengrassClient(config); + * const command = new CreateGroupCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreateGroupCommandInput} for command's `input` shape. + * @see {@link CreateGroupCommandOutput} for command's `response` shape. + * @see {@link GreengrassClientResolvedConfig | config} for command's `input` shape. + * */ export class CreateGroupCommand extends $Command< CreateGroupCommandInput, diff --git a/clients/client-greengrass/commands/CreateGroupVersionCommand.ts b/clients/client-greengrass/commands/CreateGroupVersionCommand.ts index 02ae21e6c4ab..1a0d69bf40b2 100644 --- a/clients/client-greengrass/commands/CreateGroupVersionCommand.ts +++ b/clients/client-greengrass/commands/CreateGroupVersionCommand.ts @@ -22,6 +22,20 @@ export interface CreateGroupVersionCommandOutput extends CreateGroupVersionRespo /** * Creates a version of a group which has already been defined. + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { GreengrassClient, CreateGroupVersionCommand } from "@aws-sdk/client-greengrass"; // ES Modules import + * // const { GreengrassClient, CreateGroupVersionCommand } = require("@aws-sdk/client-greengrass"); // CommonJS import + * const client = new GreengrassClient(config); + * const command = new CreateGroupVersionCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreateGroupVersionCommandInput} for command's `input` shape. + * @see {@link CreateGroupVersionCommandOutput} for command's `response` shape. + * @see {@link GreengrassClientResolvedConfig | config} for command's `input` shape. + * */ export class CreateGroupVersionCommand extends $Command< CreateGroupVersionCommandInput, diff --git a/clients/client-greengrass/commands/CreateLoggerDefinitionCommand.ts b/clients/client-greengrass/commands/CreateLoggerDefinitionCommand.ts index 77d92cf9b6d0..1d772c377611 100644 --- a/clients/client-greengrass/commands/CreateLoggerDefinitionCommand.ts +++ b/clients/client-greengrass/commands/CreateLoggerDefinitionCommand.ts @@ -22,6 +22,20 @@ export interface CreateLoggerDefinitionCommandOutput extends CreateLoggerDefinit /** * Creates a logger definition. You may provide the initial version of the logger definition now or use ''CreateLoggerDefinitionVersion'' at a later time. + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { GreengrassClient, CreateLoggerDefinitionCommand } from "@aws-sdk/client-greengrass"; // ES Modules import + * // const { GreengrassClient, CreateLoggerDefinitionCommand } = require("@aws-sdk/client-greengrass"); // CommonJS import + * const client = new GreengrassClient(config); + * const command = new CreateLoggerDefinitionCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreateLoggerDefinitionCommandInput} for command's `input` shape. + * @see {@link CreateLoggerDefinitionCommandOutput} for command's `response` shape. + * @see {@link GreengrassClientResolvedConfig | config} for command's `input` shape. + * */ export class CreateLoggerDefinitionCommand extends $Command< CreateLoggerDefinitionCommandInput, diff --git a/clients/client-greengrass/commands/CreateLoggerDefinitionVersionCommand.ts b/clients/client-greengrass/commands/CreateLoggerDefinitionVersionCommand.ts index 1bf66aa59827..b3d7247b92a4 100644 --- a/clients/client-greengrass/commands/CreateLoggerDefinitionVersionCommand.ts +++ b/clients/client-greengrass/commands/CreateLoggerDefinitionVersionCommand.ts @@ -24,6 +24,20 @@ export interface CreateLoggerDefinitionVersionCommandOutput /** * Creates a version of a logger definition that has already been defined. + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { GreengrassClient, CreateLoggerDefinitionVersionCommand } from "@aws-sdk/client-greengrass"; // ES Modules import + * // const { GreengrassClient, CreateLoggerDefinitionVersionCommand } = require("@aws-sdk/client-greengrass"); // CommonJS import + * const client = new GreengrassClient(config); + * const command = new CreateLoggerDefinitionVersionCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreateLoggerDefinitionVersionCommandInput} for command's `input` shape. + * @see {@link CreateLoggerDefinitionVersionCommandOutput} for command's `response` shape. + * @see {@link GreengrassClientResolvedConfig | config} for command's `input` shape. + * */ export class CreateLoggerDefinitionVersionCommand extends $Command< CreateLoggerDefinitionVersionCommandInput, diff --git a/clients/client-greengrass/commands/CreateResourceDefinitionCommand.ts b/clients/client-greengrass/commands/CreateResourceDefinitionCommand.ts index e04c5119c40e..343527641281 100644 --- a/clients/client-greengrass/commands/CreateResourceDefinitionCommand.ts +++ b/clients/client-greengrass/commands/CreateResourceDefinitionCommand.ts @@ -22,6 +22,20 @@ export interface CreateResourceDefinitionCommandOutput extends CreateResourceDef /** * 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. + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { GreengrassClient, CreateResourceDefinitionCommand } from "@aws-sdk/client-greengrass"; // ES Modules import + * // const { GreengrassClient, CreateResourceDefinitionCommand } = require("@aws-sdk/client-greengrass"); // CommonJS import + * const client = new GreengrassClient(config); + * const command = new CreateResourceDefinitionCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreateResourceDefinitionCommandInput} for command's `input` shape. + * @see {@link CreateResourceDefinitionCommandOutput} for command's `response` shape. + * @see {@link GreengrassClientResolvedConfig | config} for command's `input` shape. + * */ export class CreateResourceDefinitionCommand extends $Command< CreateResourceDefinitionCommandInput, diff --git a/clients/client-greengrass/commands/CreateResourceDefinitionVersionCommand.ts b/clients/client-greengrass/commands/CreateResourceDefinitionVersionCommand.ts index dc4819828f5e..e7909b9217a0 100644 --- a/clients/client-greengrass/commands/CreateResourceDefinitionVersionCommand.ts +++ b/clients/client-greengrass/commands/CreateResourceDefinitionVersionCommand.ts @@ -24,6 +24,20 @@ export interface CreateResourceDefinitionVersionCommandOutput /** * Creates a version of a resource definition that has already been defined. + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { GreengrassClient, CreateResourceDefinitionVersionCommand } from "@aws-sdk/client-greengrass"; // ES Modules import + * // const { GreengrassClient, CreateResourceDefinitionVersionCommand } = require("@aws-sdk/client-greengrass"); // CommonJS import + * const client = new GreengrassClient(config); + * const command = new CreateResourceDefinitionVersionCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreateResourceDefinitionVersionCommandInput} for command's `input` shape. + * @see {@link CreateResourceDefinitionVersionCommandOutput} for command's `response` shape. + * @see {@link GreengrassClientResolvedConfig | config} for command's `input` shape. + * */ export class CreateResourceDefinitionVersionCommand extends $Command< CreateResourceDefinitionVersionCommandInput, diff --git a/clients/client-greengrass/commands/CreateSoftwareUpdateJobCommand.ts b/clients/client-greengrass/commands/CreateSoftwareUpdateJobCommand.ts index 5153da360193..a09573482528 100644 --- a/clients/client-greengrass/commands/CreateSoftwareUpdateJobCommand.ts +++ b/clients/client-greengrass/commands/CreateSoftwareUpdateJobCommand.ts @@ -22,6 +22,20 @@ export interface CreateSoftwareUpdateJobCommandOutput extends CreateSoftwareUpda /** * 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. + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { GreengrassClient, CreateSoftwareUpdateJobCommand } from "@aws-sdk/client-greengrass"; // ES Modules import + * // const { GreengrassClient, CreateSoftwareUpdateJobCommand } = require("@aws-sdk/client-greengrass"); // CommonJS import + * const client = new GreengrassClient(config); + * const command = new CreateSoftwareUpdateJobCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreateSoftwareUpdateJobCommandInput} for command's `input` shape. + * @see {@link CreateSoftwareUpdateJobCommandOutput} for command's `response` shape. + * @see {@link GreengrassClientResolvedConfig | config} for command's `input` shape. + * */ export class CreateSoftwareUpdateJobCommand extends $Command< CreateSoftwareUpdateJobCommandInput, diff --git a/clients/client-greengrass/commands/CreateSubscriptionDefinitionCommand.ts b/clients/client-greengrass/commands/CreateSubscriptionDefinitionCommand.ts index 9d8481fd5356..8eafa74394d6 100644 --- a/clients/client-greengrass/commands/CreateSubscriptionDefinitionCommand.ts +++ b/clients/client-greengrass/commands/CreateSubscriptionDefinitionCommand.ts @@ -24,6 +24,20 @@ export interface CreateSubscriptionDefinitionCommandOutput /** * Creates a subscription definition. You may provide the initial version of the subscription definition now or use ''CreateSubscriptionDefinitionVersion'' at a later time. + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { GreengrassClient, CreateSubscriptionDefinitionCommand } from "@aws-sdk/client-greengrass"; // ES Modules import + * // const { GreengrassClient, CreateSubscriptionDefinitionCommand } = require("@aws-sdk/client-greengrass"); // CommonJS import + * const client = new GreengrassClient(config); + * const command = new CreateSubscriptionDefinitionCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreateSubscriptionDefinitionCommandInput} for command's `input` shape. + * @see {@link CreateSubscriptionDefinitionCommandOutput} for command's `response` shape. + * @see {@link GreengrassClientResolvedConfig | config} for command's `input` shape. + * */ export class CreateSubscriptionDefinitionCommand extends $Command< CreateSubscriptionDefinitionCommandInput, diff --git a/clients/client-greengrass/commands/CreateSubscriptionDefinitionVersionCommand.ts b/clients/client-greengrass/commands/CreateSubscriptionDefinitionVersionCommand.ts index 5cf99ea771e7..6decdc835621 100644 --- a/clients/client-greengrass/commands/CreateSubscriptionDefinitionVersionCommand.ts +++ b/clients/client-greengrass/commands/CreateSubscriptionDefinitionVersionCommand.ts @@ -27,6 +27,20 @@ export interface CreateSubscriptionDefinitionVersionCommandOutput /** * Creates a version of a subscription definition which has already been defined. + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { GreengrassClient, CreateSubscriptionDefinitionVersionCommand } from "@aws-sdk/client-greengrass"; // ES Modules import + * // const { GreengrassClient, CreateSubscriptionDefinitionVersionCommand } = require("@aws-sdk/client-greengrass"); // CommonJS import + * const client = new GreengrassClient(config); + * const command = new CreateSubscriptionDefinitionVersionCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreateSubscriptionDefinitionVersionCommandInput} for command's `input` shape. + * @see {@link CreateSubscriptionDefinitionVersionCommandOutput} for command's `response` shape. + * @see {@link GreengrassClientResolvedConfig | config} for command's `input` shape. + * */ export class CreateSubscriptionDefinitionVersionCommand extends $Command< CreateSubscriptionDefinitionVersionCommandInput, diff --git a/clients/client-greengrass/commands/DeleteConnectorDefinitionCommand.ts b/clients/client-greengrass/commands/DeleteConnectorDefinitionCommand.ts index 0ee1459bd695..23055025ee0b 100644 --- a/clients/client-greengrass/commands/DeleteConnectorDefinitionCommand.ts +++ b/clients/client-greengrass/commands/DeleteConnectorDefinitionCommand.ts @@ -22,6 +22,20 @@ export interface DeleteConnectorDefinitionCommandOutput extends DeleteConnectorD /** * Deletes a connector definition. + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { GreengrassClient, DeleteConnectorDefinitionCommand } from "@aws-sdk/client-greengrass"; // ES Modules import + * // const { GreengrassClient, DeleteConnectorDefinitionCommand } = require("@aws-sdk/client-greengrass"); // CommonJS import + * const client = new GreengrassClient(config); + * const command = new DeleteConnectorDefinitionCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteConnectorDefinitionCommandInput} for command's `input` shape. + * @see {@link DeleteConnectorDefinitionCommandOutput} for command's `response` shape. + * @see {@link GreengrassClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteConnectorDefinitionCommand extends $Command< DeleteConnectorDefinitionCommandInput, diff --git a/clients/client-greengrass/commands/DeleteCoreDefinitionCommand.ts b/clients/client-greengrass/commands/DeleteCoreDefinitionCommand.ts index fd07448ff7df..07ffb392dfe6 100644 --- a/clients/client-greengrass/commands/DeleteCoreDefinitionCommand.ts +++ b/clients/client-greengrass/commands/DeleteCoreDefinitionCommand.ts @@ -22,6 +22,20 @@ export interface DeleteCoreDefinitionCommandOutput extends DeleteCoreDefinitionR /** * Deletes a core definition. + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { GreengrassClient, DeleteCoreDefinitionCommand } from "@aws-sdk/client-greengrass"; // ES Modules import + * // const { GreengrassClient, DeleteCoreDefinitionCommand } = require("@aws-sdk/client-greengrass"); // CommonJS import + * const client = new GreengrassClient(config); + * const command = new DeleteCoreDefinitionCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteCoreDefinitionCommandInput} for command's `input` shape. + * @see {@link DeleteCoreDefinitionCommandOutput} for command's `response` shape. + * @see {@link GreengrassClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteCoreDefinitionCommand extends $Command< DeleteCoreDefinitionCommandInput, diff --git a/clients/client-greengrass/commands/DeleteDeviceDefinitionCommand.ts b/clients/client-greengrass/commands/DeleteDeviceDefinitionCommand.ts index 057229b53af9..6b6777e45c02 100644 --- a/clients/client-greengrass/commands/DeleteDeviceDefinitionCommand.ts +++ b/clients/client-greengrass/commands/DeleteDeviceDefinitionCommand.ts @@ -22,6 +22,20 @@ export interface DeleteDeviceDefinitionCommandOutput extends DeleteDeviceDefinit /** * Deletes a device definition. + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { GreengrassClient, DeleteDeviceDefinitionCommand } from "@aws-sdk/client-greengrass"; // ES Modules import + * // const { GreengrassClient, DeleteDeviceDefinitionCommand } = require("@aws-sdk/client-greengrass"); // CommonJS import + * const client = new GreengrassClient(config); + * const command = new DeleteDeviceDefinitionCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteDeviceDefinitionCommandInput} for command's `input` shape. + * @see {@link DeleteDeviceDefinitionCommandOutput} for command's `response` shape. + * @see {@link GreengrassClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteDeviceDefinitionCommand extends $Command< DeleteDeviceDefinitionCommandInput, diff --git a/clients/client-greengrass/commands/DeleteFunctionDefinitionCommand.ts b/clients/client-greengrass/commands/DeleteFunctionDefinitionCommand.ts index 3ee443736782..1e7e6d0df7db 100644 --- a/clients/client-greengrass/commands/DeleteFunctionDefinitionCommand.ts +++ b/clients/client-greengrass/commands/DeleteFunctionDefinitionCommand.ts @@ -22,6 +22,20 @@ export interface DeleteFunctionDefinitionCommandOutput extends DeleteFunctionDef /** * Deletes a Lambda function definition. + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { GreengrassClient, DeleteFunctionDefinitionCommand } from "@aws-sdk/client-greengrass"; // ES Modules import + * // const { GreengrassClient, DeleteFunctionDefinitionCommand } = require("@aws-sdk/client-greengrass"); // CommonJS import + * const client = new GreengrassClient(config); + * const command = new DeleteFunctionDefinitionCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteFunctionDefinitionCommandInput} for command's `input` shape. + * @see {@link DeleteFunctionDefinitionCommandOutput} for command's `response` shape. + * @see {@link GreengrassClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteFunctionDefinitionCommand extends $Command< DeleteFunctionDefinitionCommandInput, diff --git a/clients/client-greengrass/commands/DeleteGroupCommand.ts b/clients/client-greengrass/commands/DeleteGroupCommand.ts index c2d6f01ef028..fad289aaf4c4 100644 --- a/clients/client-greengrass/commands/DeleteGroupCommand.ts +++ b/clients/client-greengrass/commands/DeleteGroupCommand.ts @@ -22,6 +22,20 @@ export interface DeleteGroupCommandOutput extends DeleteGroupResponse, __Metadat /** * Deletes a group. + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { GreengrassClient, DeleteGroupCommand } from "@aws-sdk/client-greengrass"; // ES Modules import + * // const { GreengrassClient, DeleteGroupCommand } = require("@aws-sdk/client-greengrass"); // CommonJS import + * const client = new GreengrassClient(config); + * const command = new DeleteGroupCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteGroupCommandInput} for command's `input` shape. + * @see {@link DeleteGroupCommandOutput} for command's `response` shape. + * @see {@link GreengrassClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteGroupCommand extends $Command< DeleteGroupCommandInput, diff --git a/clients/client-greengrass/commands/DeleteLoggerDefinitionCommand.ts b/clients/client-greengrass/commands/DeleteLoggerDefinitionCommand.ts index 64460f825407..50011b76fbe4 100644 --- a/clients/client-greengrass/commands/DeleteLoggerDefinitionCommand.ts +++ b/clients/client-greengrass/commands/DeleteLoggerDefinitionCommand.ts @@ -22,6 +22,20 @@ export interface DeleteLoggerDefinitionCommandOutput extends DeleteLoggerDefinit /** * Deletes a logger definition. + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { GreengrassClient, DeleteLoggerDefinitionCommand } from "@aws-sdk/client-greengrass"; // ES Modules import + * // const { GreengrassClient, DeleteLoggerDefinitionCommand } = require("@aws-sdk/client-greengrass"); // CommonJS import + * const client = new GreengrassClient(config); + * const command = new DeleteLoggerDefinitionCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteLoggerDefinitionCommandInput} for command's `input` shape. + * @see {@link DeleteLoggerDefinitionCommandOutput} for command's `response` shape. + * @see {@link GreengrassClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteLoggerDefinitionCommand extends $Command< DeleteLoggerDefinitionCommandInput, diff --git a/clients/client-greengrass/commands/DeleteResourceDefinitionCommand.ts b/clients/client-greengrass/commands/DeleteResourceDefinitionCommand.ts index 54172a436dbf..1ed5418a1704 100644 --- a/clients/client-greengrass/commands/DeleteResourceDefinitionCommand.ts +++ b/clients/client-greengrass/commands/DeleteResourceDefinitionCommand.ts @@ -22,6 +22,20 @@ export interface DeleteResourceDefinitionCommandOutput extends DeleteResourceDef /** * Deletes a resource definition. + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { GreengrassClient, DeleteResourceDefinitionCommand } from "@aws-sdk/client-greengrass"; // ES Modules import + * // const { GreengrassClient, DeleteResourceDefinitionCommand } = require("@aws-sdk/client-greengrass"); // CommonJS import + * const client = new GreengrassClient(config); + * const command = new DeleteResourceDefinitionCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteResourceDefinitionCommandInput} for command's `input` shape. + * @see {@link DeleteResourceDefinitionCommandOutput} for command's `response` shape. + * @see {@link GreengrassClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteResourceDefinitionCommand extends $Command< DeleteResourceDefinitionCommandInput, diff --git a/clients/client-greengrass/commands/DeleteSubscriptionDefinitionCommand.ts b/clients/client-greengrass/commands/DeleteSubscriptionDefinitionCommand.ts index daf84aaedb6b..df24621cc0e1 100644 --- a/clients/client-greengrass/commands/DeleteSubscriptionDefinitionCommand.ts +++ b/clients/client-greengrass/commands/DeleteSubscriptionDefinitionCommand.ts @@ -24,6 +24,20 @@ export interface DeleteSubscriptionDefinitionCommandOutput /** * Deletes a subscription definition. + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { GreengrassClient, DeleteSubscriptionDefinitionCommand } from "@aws-sdk/client-greengrass"; // ES Modules import + * // const { GreengrassClient, DeleteSubscriptionDefinitionCommand } = require("@aws-sdk/client-greengrass"); // CommonJS import + * const client = new GreengrassClient(config); + * const command = new DeleteSubscriptionDefinitionCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteSubscriptionDefinitionCommandInput} for command's `input` shape. + * @see {@link DeleteSubscriptionDefinitionCommandOutput} for command's `response` shape. + * @see {@link GreengrassClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteSubscriptionDefinitionCommand extends $Command< DeleteSubscriptionDefinitionCommandInput, diff --git a/clients/client-greengrass/commands/DisassociateRoleFromGroupCommand.ts b/clients/client-greengrass/commands/DisassociateRoleFromGroupCommand.ts index 784ad96af026..938fefc0755b 100644 --- a/clients/client-greengrass/commands/DisassociateRoleFromGroupCommand.ts +++ b/clients/client-greengrass/commands/DisassociateRoleFromGroupCommand.ts @@ -22,6 +22,20 @@ export interface DisassociateRoleFromGroupCommandOutput extends DisassociateRole /** * Disassociates the role from a group. + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { GreengrassClient, DisassociateRoleFromGroupCommand } from "@aws-sdk/client-greengrass"; // ES Modules import + * // const { GreengrassClient, DisassociateRoleFromGroupCommand } = require("@aws-sdk/client-greengrass"); // CommonJS import + * const client = new GreengrassClient(config); + * const command = new DisassociateRoleFromGroupCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DisassociateRoleFromGroupCommandInput} for command's `input` shape. + * @see {@link DisassociateRoleFromGroupCommandOutput} for command's `response` shape. + * @see {@link GreengrassClientResolvedConfig | config} for command's `input` shape. + * */ export class DisassociateRoleFromGroupCommand extends $Command< DisassociateRoleFromGroupCommandInput, diff --git a/clients/client-greengrass/commands/DisassociateServiceRoleFromAccountCommand.ts b/clients/client-greengrass/commands/DisassociateServiceRoleFromAccountCommand.ts index 49f978135f75..408bd8da532e 100644 --- a/clients/client-greengrass/commands/DisassociateServiceRoleFromAccountCommand.ts +++ b/clients/client-greengrass/commands/DisassociateServiceRoleFromAccountCommand.ts @@ -27,6 +27,20 @@ export interface DisassociateServiceRoleFromAccountCommandOutput /** * Disassociates the service role from your account. Without a service role, deployments will not work. + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { GreengrassClient, DisassociateServiceRoleFromAccountCommand } from "@aws-sdk/client-greengrass"; // ES Modules import + * // const { GreengrassClient, DisassociateServiceRoleFromAccountCommand } = require("@aws-sdk/client-greengrass"); // CommonJS import + * const client = new GreengrassClient(config); + * const command = new DisassociateServiceRoleFromAccountCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DisassociateServiceRoleFromAccountCommandInput} for command's `input` shape. + * @see {@link DisassociateServiceRoleFromAccountCommandOutput} for command's `response` shape. + * @see {@link GreengrassClientResolvedConfig | config} for command's `input` shape. + * */ export class DisassociateServiceRoleFromAccountCommand extends $Command< DisassociateServiceRoleFromAccountCommandInput, diff --git a/clients/client-greengrass/commands/GetAssociatedRoleCommand.ts b/clients/client-greengrass/commands/GetAssociatedRoleCommand.ts index 059bc4118faf..1e76dd1b9382 100644 --- a/clients/client-greengrass/commands/GetAssociatedRoleCommand.ts +++ b/clients/client-greengrass/commands/GetAssociatedRoleCommand.ts @@ -22,6 +22,20 @@ export interface GetAssociatedRoleCommandOutput extends GetAssociatedRoleRespons /** * Retrieves the role associated with a particular group. + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { GreengrassClient, GetAssociatedRoleCommand } from "@aws-sdk/client-greengrass"; // ES Modules import + * // const { GreengrassClient, GetAssociatedRoleCommand } = require("@aws-sdk/client-greengrass"); // CommonJS import + * const client = new GreengrassClient(config); + * const command = new GetAssociatedRoleCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetAssociatedRoleCommandInput} for command's `input` shape. + * @see {@link GetAssociatedRoleCommandOutput} for command's `response` shape. + * @see {@link GreengrassClientResolvedConfig | config} for command's `input` shape. + * */ export class GetAssociatedRoleCommand extends $Command< GetAssociatedRoleCommandInput, diff --git a/clients/client-greengrass/commands/GetBulkDeploymentStatusCommand.ts b/clients/client-greengrass/commands/GetBulkDeploymentStatusCommand.ts index f240e7fcd260..176247f11988 100644 --- a/clients/client-greengrass/commands/GetBulkDeploymentStatusCommand.ts +++ b/clients/client-greengrass/commands/GetBulkDeploymentStatusCommand.ts @@ -22,6 +22,20 @@ export interface GetBulkDeploymentStatusCommandOutput extends GetBulkDeploymentS /** * Returns the status of a bulk deployment. + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { GreengrassClient, GetBulkDeploymentStatusCommand } from "@aws-sdk/client-greengrass"; // ES Modules import + * // const { GreengrassClient, GetBulkDeploymentStatusCommand } = require("@aws-sdk/client-greengrass"); // CommonJS import + * const client = new GreengrassClient(config); + * const command = new GetBulkDeploymentStatusCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetBulkDeploymentStatusCommandInput} for command's `input` shape. + * @see {@link GetBulkDeploymentStatusCommandOutput} for command's `response` shape. + * @see {@link GreengrassClientResolvedConfig | config} for command's `input` shape. + * */ export class GetBulkDeploymentStatusCommand extends $Command< GetBulkDeploymentStatusCommandInput, diff --git a/clients/client-greengrass/commands/GetConnectivityInfoCommand.ts b/clients/client-greengrass/commands/GetConnectivityInfoCommand.ts index 821376b8fac6..1b2cdae3c7c8 100644 --- a/clients/client-greengrass/commands/GetConnectivityInfoCommand.ts +++ b/clients/client-greengrass/commands/GetConnectivityInfoCommand.ts @@ -22,6 +22,20 @@ export interface GetConnectivityInfoCommandOutput extends GetConnectivityInfoRes /** * Retrieves the connectivity information for a core. + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { GreengrassClient, GetConnectivityInfoCommand } from "@aws-sdk/client-greengrass"; // ES Modules import + * // const { GreengrassClient, GetConnectivityInfoCommand } = require("@aws-sdk/client-greengrass"); // CommonJS import + * const client = new GreengrassClient(config); + * const command = new GetConnectivityInfoCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetConnectivityInfoCommandInput} for command's `input` shape. + * @see {@link GetConnectivityInfoCommandOutput} for command's `response` shape. + * @see {@link GreengrassClientResolvedConfig | config} for command's `input` shape. + * */ export class GetConnectivityInfoCommand extends $Command< GetConnectivityInfoCommandInput, diff --git a/clients/client-greengrass/commands/GetConnectorDefinitionCommand.ts b/clients/client-greengrass/commands/GetConnectorDefinitionCommand.ts index 90943ae5b54f..810bf39e89d5 100644 --- a/clients/client-greengrass/commands/GetConnectorDefinitionCommand.ts +++ b/clients/client-greengrass/commands/GetConnectorDefinitionCommand.ts @@ -22,6 +22,20 @@ export interface GetConnectorDefinitionCommandOutput extends GetConnectorDefinit /** * Retrieves information about a connector definition. + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { GreengrassClient, GetConnectorDefinitionCommand } from "@aws-sdk/client-greengrass"; // ES Modules import + * // const { GreengrassClient, GetConnectorDefinitionCommand } = require("@aws-sdk/client-greengrass"); // CommonJS import + * const client = new GreengrassClient(config); + * const command = new GetConnectorDefinitionCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetConnectorDefinitionCommandInput} for command's `input` shape. + * @see {@link GetConnectorDefinitionCommandOutput} for command's `response` shape. + * @see {@link GreengrassClientResolvedConfig | config} for command's `input` shape. + * */ export class GetConnectorDefinitionCommand extends $Command< GetConnectorDefinitionCommandInput, diff --git a/clients/client-greengrass/commands/GetConnectorDefinitionVersionCommand.ts b/clients/client-greengrass/commands/GetConnectorDefinitionVersionCommand.ts index ebd6783a0b3f..88f30f627c2f 100644 --- a/clients/client-greengrass/commands/GetConnectorDefinitionVersionCommand.ts +++ b/clients/client-greengrass/commands/GetConnectorDefinitionVersionCommand.ts @@ -24,6 +24,20 @@ export interface GetConnectorDefinitionVersionCommandOutput /** * 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. + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { GreengrassClient, GetConnectorDefinitionVersionCommand } from "@aws-sdk/client-greengrass"; // ES Modules import + * // const { GreengrassClient, GetConnectorDefinitionVersionCommand } = require("@aws-sdk/client-greengrass"); // CommonJS import + * const client = new GreengrassClient(config); + * const command = new GetConnectorDefinitionVersionCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetConnectorDefinitionVersionCommandInput} for command's `input` shape. + * @see {@link GetConnectorDefinitionVersionCommandOutput} for command's `response` shape. + * @see {@link GreengrassClientResolvedConfig | config} for command's `input` shape. + * */ export class GetConnectorDefinitionVersionCommand extends $Command< GetConnectorDefinitionVersionCommandInput, diff --git a/clients/client-greengrass/commands/GetCoreDefinitionCommand.ts b/clients/client-greengrass/commands/GetCoreDefinitionCommand.ts index 5288a4710afd..b10bf825e9b7 100644 --- a/clients/client-greengrass/commands/GetCoreDefinitionCommand.ts +++ b/clients/client-greengrass/commands/GetCoreDefinitionCommand.ts @@ -22,6 +22,20 @@ export interface GetCoreDefinitionCommandOutput extends GetCoreDefinitionRespons /** * Retrieves information about a core definition version. + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { GreengrassClient, GetCoreDefinitionCommand } from "@aws-sdk/client-greengrass"; // ES Modules import + * // const { GreengrassClient, GetCoreDefinitionCommand } = require("@aws-sdk/client-greengrass"); // CommonJS import + * const client = new GreengrassClient(config); + * const command = new GetCoreDefinitionCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetCoreDefinitionCommandInput} for command's `input` shape. + * @see {@link GetCoreDefinitionCommandOutput} for command's `response` shape. + * @see {@link GreengrassClientResolvedConfig | config} for command's `input` shape. + * */ export class GetCoreDefinitionCommand extends $Command< GetCoreDefinitionCommandInput, diff --git a/clients/client-greengrass/commands/GetCoreDefinitionVersionCommand.ts b/clients/client-greengrass/commands/GetCoreDefinitionVersionCommand.ts index c2d32cfb324e..855a2b40632e 100644 --- a/clients/client-greengrass/commands/GetCoreDefinitionVersionCommand.ts +++ b/clients/client-greengrass/commands/GetCoreDefinitionVersionCommand.ts @@ -22,6 +22,20 @@ export interface GetCoreDefinitionVersionCommandOutput extends GetCoreDefinition /** * Retrieves information about a core definition version. + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { GreengrassClient, GetCoreDefinitionVersionCommand } from "@aws-sdk/client-greengrass"; // ES Modules import + * // const { GreengrassClient, GetCoreDefinitionVersionCommand } = require("@aws-sdk/client-greengrass"); // CommonJS import + * const client = new GreengrassClient(config); + * const command = new GetCoreDefinitionVersionCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetCoreDefinitionVersionCommandInput} for command's `input` shape. + * @see {@link GetCoreDefinitionVersionCommandOutput} for command's `response` shape. + * @see {@link GreengrassClientResolvedConfig | config} for command's `input` shape. + * */ export class GetCoreDefinitionVersionCommand extends $Command< GetCoreDefinitionVersionCommandInput, diff --git a/clients/client-greengrass/commands/GetDeploymentStatusCommand.ts b/clients/client-greengrass/commands/GetDeploymentStatusCommand.ts index 66ea1e444386..5aebab8864bd 100644 --- a/clients/client-greengrass/commands/GetDeploymentStatusCommand.ts +++ b/clients/client-greengrass/commands/GetDeploymentStatusCommand.ts @@ -22,6 +22,20 @@ export interface GetDeploymentStatusCommandOutput extends GetDeploymentStatusRes /** * Returns the status of a deployment. + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { GreengrassClient, GetDeploymentStatusCommand } from "@aws-sdk/client-greengrass"; // ES Modules import + * // const { GreengrassClient, GetDeploymentStatusCommand } = require("@aws-sdk/client-greengrass"); // CommonJS import + * const client = new GreengrassClient(config); + * const command = new GetDeploymentStatusCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetDeploymentStatusCommandInput} for command's `input` shape. + * @see {@link GetDeploymentStatusCommandOutput} for command's `response` shape. + * @see {@link GreengrassClientResolvedConfig | config} for command's `input` shape. + * */ export class GetDeploymentStatusCommand extends $Command< GetDeploymentStatusCommandInput, diff --git a/clients/client-greengrass/commands/GetDeviceDefinitionCommand.ts b/clients/client-greengrass/commands/GetDeviceDefinitionCommand.ts index 11eba1e0e9a8..3e1a64c74e8e 100644 --- a/clients/client-greengrass/commands/GetDeviceDefinitionCommand.ts +++ b/clients/client-greengrass/commands/GetDeviceDefinitionCommand.ts @@ -22,6 +22,20 @@ export interface GetDeviceDefinitionCommandOutput extends GetDeviceDefinitionRes /** * Retrieves information about a device definition. + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { GreengrassClient, GetDeviceDefinitionCommand } from "@aws-sdk/client-greengrass"; // ES Modules import + * // const { GreengrassClient, GetDeviceDefinitionCommand } = require("@aws-sdk/client-greengrass"); // CommonJS import + * const client = new GreengrassClient(config); + * const command = new GetDeviceDefinitionCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetDeviceDefinitionCommandInput} for command's `input` shape. + * @see {@link GetDeviceDefinitionCommandOutput} for command's `response` shape. + * @see {@link GreengrassClientResolvedConfig | config} for command's `input` shape. + * */ export class GetDeviceDefinitionCommand extends $Command< GetDeviceDefinitionCommandInput, diff --git a/clients/client-greengrass/commands/GetDeviceDefinitionVersionCommand.ts b/clients/client-greengrass/commands/GetDeviceDefinitionVersionCommand.ts index dda6891ba48e..69ed85f7c45b 100644 --- a/clients/client-greengrass/commands/GetDeviceDefinitionVersionCommand.ts +++ b/clients/client-greengrass/commands/GetDeviceDefinitionVersionCommand.ts @@ -22,6 +22,20 @@ export interface GetDeviceDefinitionVersionCommandOutput extends GetDeviceDefini /** * Retrieves information about a device definition version. + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { GreengrassClient, GetDeviceDefinitionVersionCommand } from "@aws-sdk/client-greengrass"; // ES Modules import + * // const { GreengrassClient, GetDeviceDefinitionVersionCommand } = require("@aws-sdk/client-greengrass"); // CommonJS import + * const client = new GreengrassClient(config); + * const command = new GetDeviceDefinitionVersionCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetDeviceDefinitionVersionCommandInput} for command's `input` shape. + * @see {@link GetDeviceDefinitionVersionCommandOutput} for command's `response` shape. + * @see {@link GreengrassClientResolvedConfig | config} for command's `input` shape. + * */ export class GetDeviceDefinitionVersionCommand extends $Command< GetDeviceDefinitionVersionCommandInput, diff --git a/clients/client-greengrass/commands/GetFunctionDefinitionCommand.ts b/clients/client-greengrass/commands/GetFunctionDefinitionCommand.ts index d23a83eee6df..009e132fa585 100644 --- a/clients/client-greengrass/commands/GetFunctionDefinitionCommand.ts +++ b/clients/client-greengrass/commands/GetFunctionDefinitionCommand.ts @@ -22,6 +22,20 @@ export interface GetFunctionDefinitionCommandOutput extends GetFunctionDefinitio /** * Retrieves information about a Lambda function definition, including its creation time and latest version. + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { GreengrassClient, GetFunctionDefinitionCommand } from "@aws-sdk/client-greengrass"; // ES Modules import + * // const { GreengrassClient, GetFunctionDefinitionCommand } = require("@aws-sdk/client-greengrass"); // CommonJS import + * const client = new GreengrassClient(config); + * const command = new GetFunctionDefinitionCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetFunctionDefinitionCommandInput} for command's `input` shape. + * @see {@link GetFunctionDefinitionCommandOutput} for command's `response` shape. + * @see {@link GreengrassClientResolvedConfig | config} for command's `input` shape. + * */ export class GetFunctionDefinitionCommand extends $Command< GetFunctionDefinitionCommandInput, diff --git a/clients/client-greengrass/commands/GetFunctionDefinitionVersionCommand.ts b/clients/client-greengrass/commands/GetFunctionDefinitionVersionCommand.ts index d0bd4df1a086..938b4080ec46 100644 --- a/clients/client-greengrass/commands/GetFunctionDefinitionVersionCommand.ts +++ b/clients/client-greengrass/commands/GetFunctionDefinitionVersionCommand.ts @@ -24,6 +24,20 @@ export interface GetFunctionDefinitionVersionCommandOutput /** * Retrieves information about a Lambda function definition version, including which Lambda functions are included in the version and their configurations. + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { GreengrassClient, GetFunctionDefinitionVersionCommand } from "@aws-sdk/client-greengrass"; // ES Modules import + * // const { GreengrassClient, GetFunctionDefinitionVersionCommand } = require("@aws-sdk/client-greengrass"); // CommonJS import + * const client = new GreengrassClient(config); + * const command = new GetFunctionDefinitionVersionCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetFunctionDefinitionVersionCommandInput} for command's `input` shape. + * @see {@link GetFunctionDefinitionVersionCommandOutput} for command's `response` shape. + * @see {@link GreengrassClientResolvedConfig | config} for command's `input` shape. + * */ export class GetFunctionDefinitionVersionCommand extends $Command< GetFunctionDefinitionVersionCommandInput, diff --git a/clients/client-greengrass/commands/GetGroupCertificateAuthorityCommand.ts b/clients/client-greengrass/commands/GetGroupCertificateAuthorityCommand.ts index cf5563a523f6..bcf481094103 100644 --- a/clients/client-greengrass/commands/GetGroupCertificateAuthorityCommand.ts +++ b/clients/client-greengrass/commands/GetGroupCertificateAuthorityCommand.ts @@ -24,6 +24,20 @@ export interface GetGroupCertificateAuthorityCommandOutput /** * Retreives the CA associated with a group. Returns the public key of the CA. + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { GreengrassClient, GetGroupCertificateAuthorityCommand } from "@aws-sdk/client-greengrass"; // ES Modules import + * // const { GreengrassClient, GetGroupCertificateAuthorityCommand } = require("@aws-sdk/client-greengrass"); // CommonJS import + * const client = new GreengrassClient(config); + * const command = new GetGroupCertificateAuthorityCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetGroupCertificateAuthorityCommandInput} for command's `input` shape. + * @see {@link GetGroupCertificateAuthorityCommandOutput} for command's `response` shape. + * @see {@link GreengrassClientResolvedConfig | config} for command's `input` shape. + * */ export class GetGroupCertificateAuthorityCommand extends $Command< GetGroupCertificateAuthorityCommandInput, diff --git a/clients/client-greengrass/commands/GetGroupCertificateConfigurationCommand.ts b/clients/client-greengrass/commands/GetGroupCertificateConfigurationCommand.ts index 5b68e4d862d0..5b6c79b8c41a 100644 --- a/clients/client-greengrass/commands/GetGroupCertificateConfigurationCommand.ts +++ b/clients/client-greengrass/commands/GetGroupCertificateConfigurationCommand.ts @@ -24,6 +24,20 @@ export interface GetGroupCertificateConfigurationCommandOutput /** * Retrieves the current configuration for the CA used by the group. + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { GreengrassClient, GetGroupCertificateConfigurationCommand } from "@aws-sdk/client-greengrass"; // ES Modules import + * // const { GreengrassClient, GetGroupCertificateConfigurationCommand } = require("@aws-sdk/client-greengrass"); // CommonJS import + * const client = new GreengrassClient(config); + * const command = new GetGroupCertificateConfigurationCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetGroupCertificateConfigurationCommandInput} for command's `input` shape. + * @see {@link GetGroupCertificateConfigurationCommandOutput} for command's `response` shape. + * @see {@link GreengrassClientResolvedConfig | config} for command's `input` shape. + * */ export class GetGroupCertificateConfigurationCommand extends $Command< GetGroupCertificateConfigurationCommandInput, diff --git a/clients/client-greengrass/commands/GetGroupCommand.ts b/clients/client-greengrass/commands/GetGroupCommand.ts index 80e746ad1d64..2c99d3193782 100644 --- a/clients/client-greengrass/commands/GetGroupCommand.ts +++ b/clients/client-greengrass/commands/GetGroupCommand.ts @@ -22,6 +22,20 @@ export interface GetGroupCommandOutput extends GetGroupResponse, __MetadataBeare /** * Retrieves information about a group. + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { GreengrassClient, GetGroupCommand } from "@aws-sdk/client-greengrass"; // ES Modules import + * // const { GreengrassClient, GetGroupCommand } = require("@aws-sdk/client-greengrass"); // CommonJS import + * const client = new GreengrassClient(config); + * const command = new GetGroupCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetGroupCommandInput} for command's `input` shape. + * @see {@link GetGroupCommandOutput} for command's `response` shape. + * @see {@link GreengrassClientResolvedConfig | config} for command's `input` shape. + * */ export class GetGroupCommand extends $Command< GetGroupCommandInput, diff --git a/clients/client-greengrass/commands/GetGroupVersionCommand.ts b/clients/client-greengrass/commands/GetGroupVersionCommand.ts index f2aeb21d8bf2..e86fd85bb3dc 100644 --- a/clients/client-greengrass/commands/GetGroupVersionCommand.ts +++ b/clients/client-greengrass/commands/GetGroupVersionCommand.ts @@ -22,6 +22,20 @@ export interface GetGroupVersionCommandOutput extends GetGroupVersionResponse, _ /** * Retrieves information about a group version. + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { GreengrassClient, GetGroupVersionCommand } from "@aws-sdk/client-greengrass"; // ES Modules import + * // const { GreengrassClient, GetGroupVersionCommand } = require("@aws-sdk/client-greengrass"); // CommonJS import + * const client = new GreengrassClient(config); + * const command = new GetGroupVersionCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetGroupVersionCommandInput} for command's `input` shape. + * @see {@link GetGroupVersionCommandOutput} for command's `response` shape. + * @see {@link GreengrassClientResolvedConfig | config} for command's `input` shape. + * */ export class GetGroupVersionCommand extends $Command< GetGroupVersionCommandInput, diff --git a/clients/client-greengrass/commands/GetLoggerDefinitionCommand.ts b/clients/client-greengrass/commands/GetLoggerDefinitionCommand.ts index e49d736a9894..ba0032815858 100644 --- a/clients/client-greengrass/commands/GetLoggerDefinitionCommand.ts +++ b/clients/client-greengrass/commands/GetLoggerDefinitionCommand.ts @@ -22,6 +22,20 @@ export interface GetLoggerDefinitionCommandOutput extends GetLoggerDefinitionRes /** * Retrieves information about a logger definition. + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { GreengrassClient, GetLoggerDefinitionCommand } from "@aws-sdk/client-greengrass"; // ES Modules import + * // const { GreengrassClient, GetLoggerDefinitionCommand } = require("@aws-sdk/client-greengrass"); // CommonJS import + * const client = new GreengrassClient(config); + * const command = new GetLoggerDefinitionCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetLoggerDefinitionCommandInput} for command's `input` shape. + * @see {@link GetLoggerDefinitionCommandOutput} for command's `response` shape. + * @see {@link GreengrassClientResolvedConfig | config} for command's `input` shape. + * */ export class GetLoggerDefinitionCommand extends $Command< GetLoggerDefinitionCommandInput, diff --git a/clients/client-greengrass/commands/GetLoggerDefinitionVersionCommand.ts b/clients/client-greengrass/commands/GetLoggerDefinitionVersionCommand.ts index 718e69facb44..73c979b79ac3 100644 --- a/clients/client-greengrass/commands/GetLoggerDefinitionVersionCommand.ts +++ b/clients/client-greengrass/commands/GetLoggerDefinitionVersionCommand.ts @@ -22,6 +22,20 @@ export interface GetLoggerDefinitionVersionCommandOutput extends GetLoggerDefini /** * Retrieves information about a logger definition version. + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { GreengrassClient, GetLoggerDefinitionVersionCommand } from "@aws-sdk/client-greengrass"; // ES Modules import + * // const { GreengrassClient, GetLoggerDefinitionVersionCommand } = require("@aws-sdk/client-greengrass"); // CommonJS import + * const client = new GreengrassClient(config); + * const command = new GetLoggerDefinitionVersionCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetLoggerDefinitionVersionCommandInput} for command's `input` shape. + * @see {@link GetLoggerDefinitionVersionCommandOutput} for command's `response` shape. + * @see {@link GreengrassClientResolvedConfig | config} for command's `input` shape. + * */ export class GetLoggerDefinitionVersionCommand extends $Command< GetLoggerDefinitionVersionCommandInput, diff --git a/clients/client-greengrass/commands/GetResourceDefinitionCommand.ts b/clients/client-greengrass/commands/GetResourceDefinitionCommand.ts index 6442e90d54cf..538ed6fea79f 100644 --- a/clients/client-greengrass/commands/GetResourceDefinitionCommand.ts +++ b/clients/client-greengrass/commands/GetResourceDefinitionCommand.ts @@ -22,6 +22,20 @@ export interface GetResourceDefinitionCommandOutput extends GetResourceDefinitio /** * Retrieves information about a resource definition, including its creation time and latest version. + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { GreengrassClient, GetResourceDefinitionCommand } from "@aws-sdk/client-greengrass"; // ES Modules import + * // const { GreengrassClient, GetResourceDefinitionCommand } = require("@aws-sdk/client-greengrass"); // CommonJS import + * const client = new GreengrassClient(config); + * const command = new GetResourceDefinitionCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetResourceDefinitionCommandInput} for command's `input` shape. + * @see {@link GetResourceDefinitionCommandOutput} for command's `response` shape. + * @see {@link GreengrassClientResolvedConfig | config} for command's `input` shape. + * */ export class GetResourceDefinitionCommand extends $Command< GetResourceDefinitionCommandInput, diff --git a/clients/client-greengrass/commands/GetResourceDefinitionVersionCommand.ts b/clients/client-greengrass/commands/GetResourceDefinitionVersionCommand.ts index 286554834243..ea2b0ad9f712 100644 --- a/clients/client-greengrass/commands/GetResourceDefinitionVersionCommand.ts +++ b/clients/client-greengrass/commands/GetResourceDefinitionVersionCommand.ts @@ -24,6 +24,20 @@ export interface GetResourceDefinitionVersionCommandOutput /** * Retrieves information about a resource definition version, including which resources are included in the version. + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { GreengrassClient, GetResourceDefinitionVersionCommand } from "@aws-sdk/client-greengrass"; // ES Modules import + * // const { GreengrassClient, GetResourceDefinitionVersionCommand } = require("@aws-sdk/client-greengrass"); // CommonJS import + * const client = new GreengrassClient(config); + * const command = new GetResourceDefinitionVersionCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetResourceDefinitionVersionCommandInput} for command's `input` shape. + * @see {@link GetResourceDefinitionVersionCommandOutput} for command's `response` shape. + * @see {@link GreengrassClientResolvedConfig | config} for command's `input` shape. + * */ export class GetResourceDefinitionVersionCommand extends $Command< GetResourceDefinitionVersionCommandInput, diff --git a/clients/client-greengrass/commands/GetServiceRoleForAccountCommand.ts b/clients/client-greengrass/commands/GetServiceRoleForAccountCommand.ts index a99bd1342eb6..ef5d9e5d2b6d 100644 --- a/clients/client-greengrass/commands/GetServiceRoleForAccountCommand.ts +++ b/clients/client-greengrass/commands/GetServiceRoleForAccountCommand.ts @@ -22,6 +22,20 @@ export interface GetServiceRoleForAccountCommandOutput extends GetServiceRoleFor /** * Retrieves the service role that is attached to your account. + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { GreengrassClient, GetServiceRoleForAccountCommand } from "@aws-sdk/client-greengrass"; // ES Modules import + * // const { GreengrassClient, GetServiceRoleForAccountCommand } = require("@aws-sdk/client-greengrass"); // CommonJS import + * const client = new GreengrassClient(config); + * const command = new GetServiceRoleForAccountCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetServiceRoleForAccountCommandInput} for command's `input` shape. + * @see {@link GetServiceRoleForAccountCommandOutput} for command's `response` shape. + * @see {@link GreengrassClientResolvedConfig | config} for command's `input` shape. + * */ export class GetServiceRoleForAccountCommand extends $Command< GetServiceRoleForAccountCommandInput, diff --git a/clients/client-greengrass/commands/GetSubscriptionDefinitionCommand.ts b/clients/client-greengrass/commands/GetSubscriptionDefinitionCommand.ts index 898ac259e079..0f27346ae59d 100644 --- a/clients/client-greengrass/commands/GetSubscriptionDefinitionCommand.ts +++ b/clients/client-greengrass/commands/GetSubscriptionDefinitionCommand.ts @@ -22,6 +22,20 @@ export interface GetSubscriptionDefinitionCommandOutput extends GetSubscriptionD /** * Retrieves information about a subscription definition. + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { GreengrassClient, GetSubscriptionDefinitionCommand } from "@aws-sdk/client-greengrass"; // ES Modules import + * // const { GreengrassClient, GetSubscriptionDefinitionCommand } = require("@aws-sdk/client-greengrass"); // CommonJS import + * const client = new GreengrassClient(config); + * const command = new GetSubscriptionDefinitionCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetSubscriptionDefinitionCommandInput} for command's `input` shape. + * @see {@link GetSubscriptionDefinitionCommandOutput} for command's `response` shape. + * @see {@link GreengrassClientResolvedConfig | config} for command's `input` shape. + * */ export class GetSubscriptionDefinitionCommand extends $Command< GetSubscriptionDefinitionCommandInput, diff --git a/clients/client-greengrass/commands/GetSubscriptionDefinitionVersionCommand.ts b/clients/client-greengrass/commands/GetSubscriptionDefinitionVersionCommand.ts index 042807e8a856..5ceb3991b9fd 100644 --- a/clients/client-greengrass/commands/GetSubscriptionDefinitionVersionCommand.ts +++ b/clients/client-greengrass/commands/GetSubscriptionDefinitionVersionCommand.ts @@ -24,6 +24,20 @@ export interface GetSubscriptionDefinitionVersionCommandOutput /** * Retrieves information about a subscription definition version. + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { GreengrassClient, GetSubscriptionDefinitionVersionCommand } from "@aws-sdk/client-greengrass"; // ES Modules import + * // const { GreengrassClient, GetSubscriptionDefinitionVersionCommand } = require("@aws-sdk/client-greengrass"); // CommonJS import + * const client = new GreengrassClient(config); + * const command = new GetSubscriptionDefinitionVersionCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetSubscriptionDefinitionVersionCommandInput} for command's `input` shape. + * @see {@link GetSubscriptionDefinitionVersionCommandOutput} for command's `response` shape. + * @see {@link GreengrassClientResolvedConfig | config} for command's `input` shape. + * */ export class GetSubscriptionDefinitionVersionCommand extends $Command< GetSubscriptionDefinitionVersionCommandInput, diff --git a/clients/client-greengrass/commands/GetThingRuntimeConfigurationCommand.ts b/clients/client-greengrass/commands/GetThingRuntimeConfigurationCommand.ts index 3ed5724beb3f..b29a92f437d9 100644 --- a/clients/client-greengrass/commands/GetThingRuntimeConfigurationCommand.ts +++ b/clients/client-greengrass/commands/GetThingRuntimeConfigurationCommand.ts @@ -24,6 +24,20 @@ export interface GetThingRuntimeConfigurationCommandOutput /** * Get the runtime configuration of a thing. + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { GreengrassClient, GetThingRuntimeConfigurationCommand } from "@aws-sdk/client-greengrass"; // ES Modules import + * // const { GreengrassClient, GetThingRuntimeConfigurationCommand } = require("@aws-sdk/client-greengrass"); // CommonJS import + * const client = new GreengrassClient(config); + * const command = new GetThingRuntimeConfigurationCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetThingRuntimeConfigurationCommandInput} for command's `input` shape. + * @see {@link GetThingRuntimeConfigurationCommandOutput} for command's `response` shape. + * @see {@link GreengrassClientResolvedConfig | config} for command's `input` shape. + * */ export class GetThingRuntimeConfigurationCommand extends $Command< GetThingRuntimeConfigurationCommandInput, diff --git a/clients/client-greengrass/commands/ListBulkDeploymentDetailedReportsCommand.ts b/clients/client-greengrass/commands/ListBulkDeploymentDetailedReportsCommand.ts index 61009de7fc86..18c99646932a 100644 --- a/clients/client-greengrass/commands/ListBulkDeploymentDetailedReportsCommand.ts +++ b/clients/client-greengrass/commands/ListBulkDeploymentDetailedReportsCommand.ts @@ -27,6 +27,20 @@ export interface ListBulkDeploymentDetailedReportsCommandOutput /** * Gets a paginated list of the deployments that have been started in a bulk deployment operation, and their current deployment status. + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { GreengrassClient, ListBulkDeploymentDetailedReportsCommand } from "@aws-sdk/client-greengrass"; // ES Modules import + * // const { GreengrassClient, ListBulkDeploymentDetailedReportsCommand } = require("@aws-sdk/client-greengrass"); // CommonJS import + * const client = new GreengrassClient(config); + * const command = new ListBulkDeploymentDetailedReportsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListBulkDeploymentDetailedReportsCommandInput} for command's `input` shape. + * @see {@link ListBulkDeploymentDetailedReportsCommandOutput} for command's `response` shape. + * @see {@link GreengrassClientResolvedConfig | config} for command's `input` shape. + * */ export class ListBulkDeploymentDetailedReportsCommand extends $Command< ListBulkDeploymentDetailedReportsCommandInput, diff --git a/clients/client-greengrass/commands/ListBulkDeploymentsCommand.ts b/clients/client-greengrass/commands/ListBulkDeploymentsCommand.ts index 8fd321faa3d9..73caa92ce366 100644 --- a/clients/client-greengrass/commands/ListBulkDeploymentsCommand.ts +++ b/clients/client-greengrass/commands/ListBulkDeploymentsCommand.ts @@ -22,6 +22,20 @@ export interface ListBulkDeploymentsCommandOutput extends ListBulkDeploymentsRes /** * Returns a list of bulk deployments. + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { GreengrassClient, ListBulkDeploymentsCommand } from "@aws-sdk/client-greengrass"; // ES Modules import + * // const { GreengrassClient, ListBulkDeploymentsCommand } = require("@aws-sdk/client-greengrass"); // CommonJS import + * const client = new GreengrassClient(config); + * const command = new ListBulkDeploymentsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListBulkDeploymentsCommandInput} for command's `input` shape. + * @see {@link ListBulkDeploymentsCommandOutput} for command's `response` shape. + * @see {@link GreengrassClientResolvedConfig | config} for command's `input` shape. + * */ export class ListBulkDeploymentsCommand extends $Command< ListBulkDeploymentsCommandInput, diff --git a/clients/client-greengrass/commands/ListConnectorDefinitionVersionsCommand.ts b/clients/client-greengrass/commands/ListConnectorDefinitionVersionsCommand.ts index cf9320a29543..d276adb13c9f 100644 --- a/clients/client-greengrass/commands/ListConnectorDefinitionVersionsCommand.ts +++ b/clients/client-greengrass/commands/ListConnectorDefinitionVersionsCommand.ts @@ -24,6 +24,20 @@ export interface ListConnectorDefinitionVersionsCommandOutput /** * 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. + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { GreengrassClient, ListConnectorDefinitionVersionsCommand } from "@aws-sdk/client-greengrass"; // ES Modules import + * // const { GreengrassClient, ListConnectorDefinitionVersionsCommand } = require("@aws-sdk/client-greengrass"); // CommonJS import + * const client = new GreengrassClient(config); + * const command = new ListConnectorDefinitionVersionsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListConnectorDefinitionVersionsCommandInput} for command's `input` shape. + * @see {@link ListConnectorDefinitionVersionsCommandOutput} for command's `response` shape. + * @see {@link GreengrassClientResolvedConfig | config} for command's `input` shape. + * */ export class ListConnectorDefinitionVersionsCommand extends $Command< ListConnectorDefinitionVersionsCommandInput, diff --git a/clients/client-greengrass/commands/ListConnectorDefinitionsCommand.ts b/clients/client-greengrass/commands/ListConnectorDefinitionsCommand.ts index e2261b792645..afbcdd1bf21e 100644 --- a/clients/client-greengrass/commands/ListConnectorDefinitionsCommand.ts +++ b/clients/client-greengrass/commands/ListConnectorDefinitionsCommand.ts @@ -22,6 +22,20 @@ export interface ListConnectorDefinitionsCommandOutput extends ListConnectorDefi /** * Retrieves a list of connector definitions. + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { GreengrassClient, ListConnectorDefinitionsCommand } from "@aws-sdk/client-greengrass"; // ES Modules import + * // const { GreengrassClient, ListConnectorDefinitionsCommand } = require("@aws-sdk/client-greengrass"); // CommonJS import + * const client = new GreengrassClient(config); + * const command = new ListConnectorDefinitionsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListConnectorDefinitionsCommandInput} for command's `input` shape. + * @see {@link ListConnectorDefinitionsCommandOutput} for command's `response` shape. + * @see {@link GreengrassClientResolvedConfig | config} for command's `input` shape. + * */ export class ListConnectorDefinitionsCommand extends $Command< ListConnectorDefinitionsCommandInput, diff --git a/clients/client-greengrass/commands/ListCoreDefinitionVersionsCommand.ts b/clients/client-greengrass/commands/ListCoreDefinitionVersionsCommand.ts index 61593dcdd9f6..750461fdc616 100644 --- a/clients/client-greengrass/commands/ListCoreDefinitionVersionsCommand.ts +++ b/clients/client-greengrass/commands/ListCoreDefinitionVersionsCommand.ts @@ -22,6 +22,20 @@ export interface ListCoreDefinitionVersionsCommandOutput extends ListCoreDefinit /** * Lists the versions of a core definition. + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { GreengrassClient, ListCoreDefinitionVersionsCommand } from "@aws-sdk/client-greengrass"; // ES Modules import + * // const { GreengrassClient, ListCoreDefinitionVersionsCommand } = require("@aws-sdk/client-greengrass"); // CommonJS import + * const client = new GreengrassClient(config); + * const command = new ListCoreDefinitionVersionsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListCoreDefinitionVersionsCommandInput} for command's `input` shape. + * @see {@link ListCoreDefinitionVersionsCommandOutput} for command's `response` shape. + * @see {@link GreengrassClientResolvedConfig | config} for command's `input` shape. + * */ export class ListCoreDefinitionVersionsCommand extends $Command< ListCoreDefinitionVersionsCommandInput, diff --git a/clients/client-greengrass/commands/ListCoreDefinitionsCommand.ts b/clients/client-greengrass/commands/ListCoreDefinitionsCommand.ts index faefd6926840..cb486ee31312 100644 --- a/clients/client-greengrass/commands/ListCoreDefinitionsCommand.ts +++ b/clients/client-greengrass/commands/ListCoreDefinitionsCommand.ts @@ -22,6 +22,20 @@ export interface ListCoreDefinitionsCommandOutput extends ListCoreDefinitionsRes /** * Retrieves a list of core definitions. + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { GreengrassClient, ListCoreDefinitionsCommand } from "@aws-sdk/client-greengrass"; // ES Modules import + * // const { GreengrassClient, ListCoreDefinitionsCommand } = require("@aws-sdk/client-greengrass"); // CommonJS import + * const client = new GreengrassClient(config); + * const command = new ListCoreDefinitionsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListCoreDefinitionsCommandInput} for command's `input` shape. + * @see {@link ListCoreDefinitionsCommandOutput} for command's `response` shape. + * @see {@link GreengrassClientResolvedConfig | config} for command's `input` shape. + * */ export class ListCoreDefinitionsCommand extends $Command< ListCoreDefinitionsCommandInput, diff --git a/clients/client-greengrass/commands/ListDeploymentsCommand.ts b/clients/client-greengrass/commands/ListDeploymentsCommand.ts index 157f7a08a019..3234cb060d7f 100644 --- a/clients/client-greengrass/commands/ListDeploymentsCommand.ts +++ b/clients/client-greengrass/commands/ListDeploymentsCommand.ts @@ -22,6 +22,20 @@ export interface ListDeploymentsCommandOutput extends ListDeploymentsResponse, _ /** * Returns a history of deployments for the group. + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { GreengrassClient, ListDeploymentsCommand } from "@aws-sdk/client-greengrass"; // ES Modules import + * // const { GreengrassClient, ListDeploymentsCommand } = require("@aws-sdk/client-greengrass"); // CommonJS import + * const client = new GreengrassClient(config); + * const command = new ListDeploymentsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListDeploymentsCommandInput} for command's `input` shape. + * @see {@link ListDeploymentsCommandOutput} for command's `response` shape. + * @see {@link GreengrassClientResolvedConfig | config} for command's `input` shape. + * */ export class ListDeploymentsCommand extends $Command< ListDeploymentsCommandInput, diff --git a/clients/client-greengrass/commands/ListDeviceDefinitionVersionsCommand.ts b/clients/client-greengrass/commands/ListDeviceDefinitionVersionsCommand.ts index d44e423f61b3..96bbbcf7f53f 100644 --- a/clients/client-greengrass/commands/ListDeviceDefinitionVersionsCommand.ts +++ b/clients/client-greengrass/commands/ListDeviceDefinitionVersionsCommand.ts @@ -24,6 +24,20 @@ export interface ListDeviceDefinitionVersionsCommandOutput /** * Lists the versions of a device definition. + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { GreengrassClient, ListDeviceDefinitionVersionsCommand } from "@aws-sdk/client-greengrass"; // ES Modules import + * // const { GreengrassClient, ListDeviceDefinitionVersionsCommand } = require("@aws-sdk/client-greengrass"); // CommonJS import + * const client = new GreengrassClient(config); + * const command = new ListDeviceDefinitionVersionsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListDeviceDefinitionVersionsCommandInput} for command's `input` shape. + * @see {@link ListDeviceDefinitionVersionsCommandOutput} for command's `response` shape. + * @see {@link GreengrassClientResolvedConfig | config} for command's `input` shape. + * */ export class ListDeviceDefinitionVersionsCommand extends $Command< ListDeviceDefinitionVersionsCommandInput, diff --git a/clients/client-greengrass/commands/ListDeviceDefinitionsCommand.ts b/clients/client-greengrass/commands/ListDeviceDefinitionsCommand.ts index 10594de976d6..9c9ea04412b7 100644 --- a/clients/client-greengrass/commands/ListDeviceDefinitionsCommand.ts +++ b/clients/client-greengrass/commands/ListDeviceDefinitionsCommand.ts @@ -22,6 +22,20 @@ export interface ListDeviceDefinitionsCommandOutput extends ListDeviceDefinition /** * Retrieves a list of device definitions. + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { GreengrassClient, ListDeviceDefinitionsCommand } from "@aws-sdk/client-greengrass"; // ES Modules import + * // const { GreengrassClient, ListDeviceDefinitionsCommand } = require("@aws-sdk/client-greengrass"); // CommonJS import + * const client = new GreengrassClient(config); + * const command = new ListDeviceDefinitionsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListDeviceDefinitionsCommandInput} for command's `input` shape. + * @see {@link ListDeviceDefinitionsCommandOutput} for command's `response` shape. + * @see {@link GreengrassClientResolvedConfig | config} for command's `input` shape. + * */ export class ListDeviceDefinitionsCommand extends $Command< ListDeviceDefinitionsCommandInput, diff --git a/clients/client-greengrass/commands/ListFunctionDefinitionVersionsCommand.ts b/clients/client-greengrass/commands/ListFunctionDefinitionVersionsCommand.ts index c994d08e0aed..db00d3f81547 100644 --- a/clients/client-greengrass/commands/ListFunctionDefinitionVersionsCommand.ts +++ b/clients/client-greengrass/commands/ListFunctionDefinitionVersionsCommand.ts @@ -24,6 +24,20 @@ export interface ListFunctionDefinitionVersionsCommandOutput /** * Lists the versions of a Lambda function definition. + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { GreengrassClient, ListFunctionDefinitionVersionsCommand } from "@aws-sdk/client-greengrass"; // ES Modules import + * // const { GreengrassClient, ListFunctionDefinitionVersionsCommand } = require("@aws-sdk/client-greengrass"); // CommonJS import + * const client = new GreengrassClient(config); + * const command = new ListFunctionDefinitionVersionsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListFunctionDefinitionVersionsCommandInput} for command's `input` shape. + * @see {@link ListFunctionDefinitionVersionsCommandOutput} for command's `response` shape. + * @see {@link GreengrassClientResolvedConfig | config} for command's `input` shape. + * */ export class ListFunctionDefinitionVersionsCommand extends $Command< ListFunctionDefinitionVersionsCommandInput, diff --git a/clients/client-greengrass/commands/ListFunctionDefinitionsCommand.ts b/clients/client-greengrass/commands/ListFunctionDefinitionsCommand.ts index 9b58170a0114..b3bc649a1e6b 100644 --- a/clients/client-greengrass/commands/ListFunctionDefinitionsCommand.ts +++ b/clients/client-greengrass/commands/ListFunctionDefinitionsCommand.ts @@ -22,6 +22,20 @@ export interface ListFunctionDefinitionsCommandOutput extends ListFunctionDefini /** * Retrieves a list of Lambda function definitions. + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { GreengrassClient, ListFunctionDefinitionsCommand } from "@aws-sdk/client-greengrass"; // ES Modules import + * // const { GreengrassClient, ListFunctionDefinitionsCommand } = require("@aws-sdk/client-greengrass"); // CommonJS import + * const client = new GreengrassClient(config); + * const command = new ListFunctionDefinitionsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListFunctionDefinitionsCommandInput} for command's `input` shape. + * @see {@link ListFunctionDefinitionsCommandOutput} for command's `response` shape. + * @see {@link GreengrassClientResolvedConfig | config} for command's `input` shape. + * */ export class ListFunctionDefinitionsCommand extends $Command< ListFunctionDefinitionsCommandInput, diff --git a/clients/client-greengrass/commands/ListGroupCertificateAuthoritiesCommand.ts b/clients/client-greengrass/commands/ListGroupCertificateAuthoritiesCommand.ts index 357215b87a13..e554fabe2723 100644 --- a/clients/client-greengrass/commands/ListGroupCertificateAuthoritiesCommand.ts +++ b/clients/client-greengrass/commands/ListGroupCertificateAuthoritiesCommand.ts @@ -24,6 +24,20 @@ export interface ListGroupCertificateAuthoritiesCommandOutput /** * Retrieves the current CAs for a group. + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { GreengrassClient, ListGroupCertificateAuthoritiesCommand } from "@aws-sdk/client-greengrass"; // ES Modules import + * // const { GreengrassClient, ListGroupCertificateAuthoritiesCommand } = require("@aws-sdk/client-greengrass"); // CommonJS import + * const client = new GreengrassClient(config); + * const command = new ListGroupCertificateAuthoritiesCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListGroupCertificateAuthoritiesCommandInput} for command's `input` shape. + * @see {@link ListGroupCertificateAuthoritiesCommandOutput} for command's `response` shape. + * @see {@link GreengrassClientResolvedConfig | config} for command's `input` shape. + * */ export class ListGroupCertificateAuthoritiesCommand extends $Command< ListGroupCertificateAuthoritiesCommandInput, diff --git a/clients/client-greengrass/commands/ListGroupVersionsCommand.ts b/clients/client-greengrass/commands/ListGroupVersionsCommand.ts index 1fca51b1427c..641afbbde417 100644 --- a/clients/client-greengrass/commands/ListGroupVersionsCommand.ts +++ b/clients/client-greengrass/commands/ListGroupVersionsCommand.ts @@ -22,6 +22,20 @@ export interface ListGroupVersionsCommandOutput extends ListGroupVersionsRespons /** * Lists the versions of a group. + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { GreengrassClient, ListGroupVersionsCommand } from "@aws-sdk/client-greengrass"; // ES Modules import + * // const { GreengrassClient, ListGroupVersionsCommand } = require("@aws-sdk/client-greengrass"); // CommonJS import + * const client = new GreengrassClient(config); + * const command = new ListGroupVersionsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListGroupVersionsCommandInput} for command's `input` shape. + * @see {@link ListGroupVersionsCommandOutput} for command's `response` shape. + * @see {@link GreengrassClientResolvedConfig | config} for command's `input` shape. + * */ export class ListGroupVersionsCommand extends $Command< ListGroupVersionsCommandInput, diff --git a/clients/client-greengrass/commands/ListGroupsCommand.ts b/clients/client-greengrass/commands/ListGroupsCommand.ts index 1955eeaf85db..cdbb8b50be9c 100644 --- a/clients/client-greengrass/commands/ListGroupsCommand.ts +++ b/clients/client-greengrass/commands/ListGroupsCommand.ts @@ -22,6 +22,20 @@ export interface ListGroupsCommandOutput extends ListGroupsResponse, __MetadataB /** * Retrieves a list of groups. + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { GreengrassClient, ListGroupsCommand } from "@aws-sdk/client-greengrass"; // ES Modules import + * // const { GreengrassClient, ListGroupsCommand } = require("@aws-sdk/client-greengrass"); // CommonJS import + * const client = new GreengrassClient(config); + * const command = new ListGroupsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListGroupsCommandInput} for command's `input` shape. + * @see {@link ListGroupsCommandOutput} for command's `response` shape. + * @see {@link GreengrassClientResolvedConfig | config} for command's `input` shape. + * */ export class ListGroupsCommand extends $Command< ListGroupsCommandInput, diff --git a/clients/client-greengrass/commands/ListLoggerDefinitionVersionsCommand.ts b/clients/client-greengrass/commands/ListLoggerDefinitionVersionsCommand.ts index cebc16869fae..24a6f44c0693 100644 --- a/clients/client-greengrass/commands/ListLoggerDefinitionVersionsCommand.ts +++ b/clients/client-greengrass/commands/ListLoggerDefinitionVersionsCommand.ts @@ -24,6 +24,20 @@ export interface ListLoggerDefinitionVersionsCommandOutput /** * Lists the versions of a logger definition. + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { GreengrassClient, ListLoggerDefinitionVersionsCommand } from "@aws-sdk/client-greengrass"; // ES Modules import + * // const { GreengrassClient, ListLoggerDefinitionVersionsCommand } = require("@aws-sdk/client-greengrass"); // CommonJS import + * const client = new GreengrassClient(config); + * const command = new ListLoggerDefinitionVersionsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListLoggerDefinitionVersionsCommandInput} for command's `input` shape. + * @see {@link ListLoggerDefinitionVersionsCommandOutput} for command's `response` shape. + * @see {@link GreengrassClientResolvedConfig | config} for command's `input` shape. + * */ export class ListLoggerDefinitionVersionsCommand extends $Command< ListLoggerDefinitionVersionsCommandInput, diff --git a/clients/client-greengrass/commands/ListLoggerDefinitionsCommand.ts b/clients/client-greengrass/commands/ListLoggerDefinitionsCommand.ts index 2022b45ec975..f27f1fd17005 100644 --- a/clients/client-greengrass/commands/ListLoggerDefinitionsCommand.ts +++ b/clients/client-greengrass/commands/ListLoggerDefinitionsCommand.ts @@ -22,6 +22,20 @@ export interface ListLoggerDefinitionsCommandOutput extends ListLoggerDefinition /** * Retrieves a list of logger definitions. + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { GreengrassClient, ListLoggerDefinitionsCommand } from "@aws-sdk/client-greengrass"; // ES Modules import + * // const { GreengrassClient, ListLoggerDefinitionsCommand } = require("@aws-sdk/client-greengrass"); // CommonJS import + * const client = new GreengrassClient(config); + * const command = new ListLoggerDefinitionsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListLoggerDefinitionsCommandInput} for command's `input` shape. + * @see {@link ListLoggerDefinitionsCommandOutput} for command's `response` shape. + * @see {@link GreengrassClientResolvedConfig | config} for command's `input` shape. + * */ export class ListLoggerDefinitionsCommand extends $Command< ListLoggerDefinitionsCommandInput, diff --git a/clients/client-greengrass/commands/ListResourceDefinitionVersionsCommand.ts b/clients/client-greengrass/commands/ListResourceDefinitionVersionsCommand.ts index dbc1956d4e69..53f019864440 100644 --- a/clients/client-greengrass/commands/ListResourceDefinitionVersionsCommand.ts +++ b/clients/client-greengrass/commands/ListResourceDefinitionVersionsCommand.ts @@ -24,6 +24,20 @@ export interface ListResourceDefinitionVersionsCommandOutput /** * Lists the versions of a resource definition. + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { GreengrassClient, ListResourceDefinitionVersionsCommand } from "@aws-sdk/client-greengrass"; // ES Modules import + * // const { GreengrassClient, ListResourceDefinitionVersionsCommand } = require("@aws-sdk/client-greengrass"); // CommonJS import + * const client = new GreengrassClient(config); + * const command = new ListResourceDefinitionVersionsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListResourceDefinitionVersionsCommandInput} for command's `input` shape. + * @see {@link ListResourceDefinitionVersionsCommandOutput} for command's `response` shape. + * @see {@link GreengrassClientResolvedConfig | config} for command's `input` shape. + * */ export class ListResourceDefinitionVersionsCommand extends $Command< ListResourceDefinitionVersionsCommandInput, diff --git a/clients/client-greengrass/commands/ListResourceDefinitionsCommand.ts b/clients/client-greengrass/commands/ListResourceDefinitionsCommand.ts index 118d0cd26b4e..a782fe7fa015 100644 --- a/clients/client-greengrass/commands/ListResourceDefinitionsCommand.ts +++ b/clients/client-greengrass/commands/ListResourceDefinitionsCommand.ts @@ -22,6 +22,20 @@ export interface ListResourceDefinitionsCommandOutput extends ListResourceDefini /** * Retrieves a list of resource definitions. + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { GreengrassClient, ListResourceDefinitionsCommand } from "@aws-sdk/client-greengrass"; // ES Modules import + * // const { GreengrassClient, ListResourceDefinitionsCommand } = require("@aws-sdk/client-greengrass"); // CommonJS import + * const client = new GreengrassClient(config); + * const command = new ListResourceDefinitionsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListResourceDefinitionsCommandInput} for command's `input` shape. + * @see {@link ListResourceDefinitionsCommandOutput} for command's `response` shape. + * @see {@link GreengrassClientResolvedConfig | config} for command's `input` shape. + * */ export class ListResourceDefinitionsCommand extends $Command< ListResourceDefinitionsCommandInput, diff --git a/clients/client-greengrass/commands/ListSubscriptionDefinitionVersionsCommand.ts b/clients/client-greengrass/commands/ListSubscriptionDefinitionVersionsCommand.ts index 65b48ef19455..03b3df292839 100644 --- a/clients/client-greengrass/commands/ListSubscriptionDefinitionVersionsCommand.ts +++ b/clients/client-greengrass/commands/ListSubscriptionDefinitionVersionsCommand.ts @@ -27,6 +27,20 @@ export interface ListSubscriptionDefinitionVersionsCommandOutput /** * Lists the versions of a subscription definition. + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { GreengrassClient, ListSubscriptionDefinitionVersionsCommand } from "@aws-sdk/client-greengrass"; // ES Modules import + * // const { GreengrassClient, ListSubscriptionDefinitionVersionsCommand } = require("@aws-sdk/client-greengrass"); // CommonJS import + * const client = new GreengrassClient(config); + * const command = new ListSubscriptionDefinitionVersionsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListSubscriptionDefinitionVersionsCommandInput} for command's `input` shape. + * @see {@link ListSubscriptionDefinitionVersionsCommandOutput} for command's `response` shape. + * @see {@link GreengrassClientResolvedConfig | config} for command's `input` shape. + * */ export class ListSubscriptionDefinitionVersionsCommand extends $Command< ListSubscriptionDefinitionVersionsCommandInput, diff --git a/clients/client-greengrass/commands/ListSubscriptionDefinitionsCommand.ts b/clients/client-greengrass/commands/ListSubscriptionDefinitionsCommand.ts index c52fa1770937..c05fc5788671 100644 --- a/clients/client-greengrass/commands/ListSubscriptionDefinitionsCommand.ts +++ b/clients/client-greengrass/commands/ListSubscriptionDefinitionsCommand.ts @@ -24,6 +24,20 @@ export interface ListSubscriptionDefinitionsCommandOutput /** * Retrieves a list of subscription definitions. + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { GreengrassClient, ListSubscriptionDefinitionsCommand } from "@aws-sdk/client-greengrass"; // ES Modules import + * // const { GreengrassClient, ListSubscriptionDefinitionsCommand } = require("@aws-sdk/client-greengrass"); // CommonJS import + * const client = new GreengrassClient(config); + * const command = new ListSubscriptionDefinitionsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListSubscriptionDefinitionsCommandInput} for command's `input` shape. + * @see {@link ListSubscriptionDefinitionsCommandOutput} for command's `response` shape. + * @see {@link GreengrassClientResolvedConfig | config} for command's `input` shape. + * */ export class ListSubscriptionDefinitionsCommand extends $Command< ListSubscriptionDefinitionsCommandInput, diff --git a/clients/client-greengrass/commands/ListTagsForResourceCommand.ts b/clients/client-greengrass/commands/ListTagsForResourceCommand.ts index 25e2f654c2ca..05938772d753 100644 --- a/clients/client-greengrass/commands/ListTagsForResourceCommand.ts +++ b/clients/client-greengrass/commands/ListTagsForResourceCommand.ts @@ -22,6 +22,20 @@ export interface ListTagsForResourceCommandOutput extends ListTagsForResourceRes /** * Retrieves a list of resource tags for a resource arn. + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { GreengrassClient, ListTagsForResourceCommand } from "@aws-sdk/client-greengrass"; // ES Modules import + * // const { GreengrassClient, ListTagsForResourceCommand } = require("@aws-sdk/client-greengrass"); // CommonJS import + * const client = new GreengrassClient(config); + * const command = new ListTagsForResourceCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListTagsForResourceCommandInput} for command's `input` shape. + * @see {@link ListTagsForResourceCommandOutput} for command's `response` shape. + * @see {@link GreengrassClientResolvedConfig | config} for command's `input` shape. + * */ export class ListTagsForResourceCommand extends $Command< ListTagsForResourceCommandInput, diff --git a/clients/client-greengrass/commands/ResetDeploymentsCommand.ts b/clients/client-greengrass/commands/ResetDeploymentsCommand.ts index 600409c0b5ba..9a768bb67a49 100644 --- a/clients/client-greengrass/commands/ResetDeploymentsCommand.ts +++ b/clients/client-greengrass/commands/ResetDeploymentsCommand.ts @@ -22,6 +22,20 @@ export interface ResetDeploymentsCommandOutput extends ResetDeploymentsResponse, /** * Resets a group's deployments. + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { GreengrassClient, ResetDeploymentsCommand } from "@aws-sdk/client-greengrass"; // ES Modules import + * // const { GreengrassClient, ResetDeploymentsCommand } = require("@aws-sdk/client-greengrass"); // CommonJS import + * const client = new GreengrassClient(config); + * const command = new ResetDeploymentsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ResetDeploymentsCommandInput} for command's `input` shape. + * @see {@link ResetDeploymentsCommandOutput} for command's `response` shape. + * @see {@link GreengrassClientResolvedConfig | config} for command's `input` shape. + * */ export class ResetDeploymentsCommand extends $Command< ResetDeploymentsCommandInput, diff --git a/clients/client-greengrass/commands/StartBulkDeploymentCommand.ts b/clients/client-greengrass/commands/StartBulkDeploymentCommand.ts index 323d612c52e3..84c0decfb0a9 100644 --- a/clients/client-greengrass/commands/StartBulkDeploymentCommand.ts +++ b/clients/client-greengrass/commands/StartBulkDeploymentCommand.ts @@ -22,6 +22,20 @@ export interface StartBulkDeploymentCommandOutput extends StartBulkDeploymentRes /** * 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. + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { GreengrassClient, StartBulkDeploymentCommand } from "@aws-sdk/client-greengrass"; // ES Modules import + * // const { GreengrassClient, StartBulkDeploymentCommand } = require("@aws-sdk/client-greengrass"); // CommonJS import + * const client = new GreengrassClient(config); + * const command = new StartBulkDeploymentCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link StartBulkDeploymentCommandInput} for command's `input` shape. + * @see {@link StartBulkDeploymentCommandOutput} for command's `response` shape. + * @see {@link GreengrassClientResolvedConfig | config} for command's `input` shape. + * */ export class StartBulkDeploymentCommand extends $Command< StartBulkDeploymentCommandInput, diff --git a/clients/client-greengrass/commands/StopBulkDeploymentCommand.ts b/clients/client-greengrass/commands/StopBulkDeploymentCommand.ts index b14403cbb7ce..3b708c4d450e 100644 --- a/clients/client-greengrass/commands/StopBulkDeploymentCommand.ts +++ b/clients/client-greengrass/commands/StopBulkDeploymentCommand.ts @@ -22,6 +22,20 @@ export interface StopBulkDeploymentCommandOutput extends StopBulkDeploymentRespo /** * 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. + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { GreengrassClient, StopBulkDeploymentCommand } from "@aws-sdk/client-greengrass"; // ES Modules import + * // const { GreengrassClient, StopBulkDeploymentCommand } = require("@aws-sdk/client-greengrass"); // CommonJS import + * const client = new GreengrassClient(config); + * const command = new StopBulkDeploymentCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link StopBulkDeploymentCommandInput} for command's `input` shape. + * @see {@link StopBulkDeploymentCommandOutput} for command's `response` shape. + * @see {@link GreengrassClientResolvedConfig | config} for command's `input` shape. + * */ export class StopBulkDeploymentCommand extends $Command< StopBulkDeploymentCommandInput, diff --git a/clients/client-greengrass/commands/TagResourceCommand.ts b/clients/client-greengrass/commands/TagResourceCommand.ts index d9ea87cfea2e..8a7a5dda564a 100644 --- a/clients/client-greengrass/commands/TagResourceCommand.ts +++ b/clients/client-greengrass/commands/TagResourceCommand.ts @@ -22,6 +22,20 @@ export interface TagResourceCommandOutput extends __MetadataBearer {} /** * Adds tags to a Greengrass resource. Valid resources are 'Group', 'ConnectorDefinition', 'CoreDefinition', 'DeviceDefinition', 'FunctionDefinition', 'LoggerDefinition', 'SubscriptionDefinition', 'ResourceDefinition', and 'BulkDeployment'. + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { GreengrassClient, TagResourceCommand } from "@aws-sdk/client-greengrass"; // ES Modules import + * // const { GreengrassClient, TagResourceCommand } = require("@aws-sdk/client-greengrass"); // CommonJS import + * const client = new GreengrassClient(config); + * const command = new TagResourceCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link TagResourceCommandInput} for command's `input` shape. + * @see {@link TagResourceCommandOutput} for command's `response` shape. + * @see {@link GreengrassClientResolvedConfig | config} for command's `input` shape. + * */ export class TagResourceCommand extends $Command< TagResourceCommandInput, diff --git a/clients/client-greengrass/commands/UntagResourceCommand.ts b/clients/client-greengrass/commands/UntagResourceCommand.ts index 5a9f3b7cc993..8882bbe55ed6 100644 --- a/clients/client-greengrass/commands/UntagResourceCommand.ts +++ b/clients/client-greengrass/commands/UntagResourceCommand.ts @@ -22,6 +22,20 @@ export interface UntagResourceCommandOutput extends __MetadataBearer {} /** * Remove resource tags from a Greengrass Resource. + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { GreengrassClient, UntagResourceCommand } from "@aws-sdk/client-greengrass"; // ES Modules import + * // const { GreengrassClient, UntagResourceCommand } = require("@aws-sdk/client-greengrass"); // CommonJS import + * const client = new GreengrassClient(config); + * const command = new UntagResourceCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link UntagResourceCommandInput} for command's `input` shape. + * @see {@link UntagResourceCommandOutput} for command's `response` shape. + * @see {@link GreengrassClientResolvedConfig | config} for command's `input` shape. + * */ export class UntagResourceCommand extends $Command< UntagResourceCommandInput, diff --git a/clients/client-greengrass/commands/UpdateConnectivityInfoCommand.ts b/clients/client-greengrass/commands/UpdateConnectivityInfoCommand.ts index cedb1e894fed..41cbbc057af6 100644 --- a/clients/client-greengrass/commands/UpdateConnectivityInfoCommand.ts +++ b/clients/client-greengrass/commands/UpdateConnectivityInfoCommand.ts @@ -22,6 +22,20 @@ export interface UpdateConnectivityInfoCommandOutput extends UpdateConnectivityI /** * 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. + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { GreengrassClient, UpdateConnectivityInfoCommand } from "@aws-sdk/client-greengrass"; // ES Modules import + * // const { GreengrassClient, UpdateConnectivityInfoCommand } = require("@aws-sdk/client-greengrass"); // CommonJS import + * const client = new GreengrassClient(config); + * const command = new UpdateConnectivityInfoCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link UpdateConnectivityInfoCommandInput} for command's `input` shape. + * @see {@link UpdateConnectivityInfoCommandOutput} for command's `response` shape. + * @see {@link GreengrassClientResolvedConfig | config} for command's `input` shape. + * */ export class UpdateConnectivityInfoCommand extends $Command< UpdateConnectivityInfoCommandInput, diff --git a/clients/client-greengrass/commands/UpdateConnectorDefinitionCommand.ts b/clients/client-greengrass/commands/UpdateConnectorDefinitionCommand.ts index 1c6c3146ae3b..a24c0ea44e43 100644 --- a/clients/client-greengrass/commands/UpdateConnectorDefinitionCommand.ts +++ b/clients/client-greengrass/commands/UpdateConnectorDefinitionCommand.ts @@ -22,6 +22,20 @@ export interface UpdateConnectorDefinitionCommandOutput extends UpdateConnectorD /** * Updates a connector definition. + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { GreengrassClient, UpdateConnectorDefinitionCommand } from "@aws-sdk/client-greengrass"; // ES Modules import + * // const { GreengrassClient, UpdateConnectorDefinitionCommand } = require("@aws-sdk/client-greengrass"); // CommonJS import + * const client = new GreengrassClient(config); + * const command = new UpdateConnectorDefinitionCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link UpdateConnectorDefinitionCommandInput} for command's `input` shape. + * @see {@link UpdateConnectorDefinitionCommandOutput} for command's `response` shape. + * @see {@link GreengrassClientResolvedConfig | config} for command's `input` shape. + * */ export class UpdateConnectorDefinitionCommand extends $Command< UpdateConnectorDefinitionCommandInput, diff --git a/clients/client-greengrass/commands/UpdateCoreDefinitionCommand.ts b/clients/client-greengrass/commands/UpdateCoreDefinitionCommand.ts index 11d08fb48961..4e52e78994a8 100644 --- a/clients/client-greengrass/commands/UpdateCoreDefinitionCommand.ts +++ b/clients/client-greengrass/commands/UpdateCoreDefinitionCommand.ts @@ -22,6 +22,20 @@ export interface UpdateCoreDefinitionCommandOutput extends UpdateCoreDefinitionR /** * Updates a core definition. + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { GreengrassClient, UpdateCoreDefinitionCommand } from "@aws-sdk/client-greengrass"; // ES Modules import + * // const { GreengrassClient, UpdateCoreDefinitionCommand } = require("@aws-sdk/client-greengrass"); // CommonJS import + * const client = new GreengrassClient(config); + * const command = new UpdateCoreDefinitionCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link UpdateCoreDefinitionCommandInput} for command's `input` shape. + * @see {@link UpdateCoreDefinitionCommandOutput} for command's `response` shape. + * @see {@link GreengrassClientResolvedConfig | config} for command's `input` shape. + * */ export class UpdateCoreDefinitionCommand extends $Command< UpdateCoreDefinitionCommandInput, diff --git a/clients/client-greengrass/commands/UpdateDeviceDefinitionCommand.ts b/clients/client-greengrass/commands/UpdateDeviceDefinitionCommand.ts index e999a8402276..b7745e100343 100644 --- a/clients/client-greengrass/commands/UpdateDeviceDefinitionCommand.ts +++ b/clients/client-greengrass/commands/UpdateDeviceDefinitionCommand.ts @@ -22,6 +22,20 @@ export interface UpdateDeviceDefinitionCommandOutput extends UpdateDeviceDefinit /** * Updates a device definition. + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { GreengrassClient, UpdateDeviceDefinitionCommand } from "@aws-sdk/client-greengrass"; // ES Modules import + * // const { GreengrassClient, UpdateDeviceDefinitionCommand } = require("@aws-sdk/client-greengrass"); // CommonJS import + * const client = new GreengrassClient(config); + * const command = new UpdateDeviceDefinitionCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link UpdateDeviceDefinitionCommandInput} for command's `input` shape. + * @see {@link UpdateDeviceDefinitionCommandOutput} for command's `response` shape. + * @see {@link GreengrassClientResolvedConfig | config} for command's `input` shape. + * */ export class UpdateDeviceDefinitionCommand extends $Command< UpdateDeviceDefinitionCommandInput, diff --git a/clients/client-greengrass/commands/UpdateFunctionDefinitionCommand.ts b/clients/client-greengrass/commands/UpdateFunctionDefinitionCommand.ts index 0bed4c7f871d..c490d0386cf4 100644 --- a/clients/client-greengrass/commands/UpdateFunctionDefinitionCommand.ts +++ b/clients/client-greengrass/commands/UpdateFunctionDefinitionCommand.ts @@ -22,6 +22,20 @@ export interface UpdateFunctionDefinitionCommandOutput extends UpdateFunctionDef /** * Updates a Lambda function definition. + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { GreengrassClient, UpdateFunctionDefinitionCommand } from "@aws-sdk/client-greengrass"; // ES Modules import + * // const { GreengrassClient, UpdateFunctionDefinitionCommand } = require("@aws-sdk/client-greengrass"); // CommonJS import + * const client = new GreengrassClient(config); + * const command = new UpdateFunctionDefinitionCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link UpdateFunctionDefinitionCommandInput} for command's `input` shape. + * @see {@link UpdateFunctionDefinitionCommandOutput} for command's `response` shape. + * @see {@link GreengrassClientResolvedConfig | config} for command's `input` shape. + * */ export class UpdateFunctionDefinitionCommand extends $Command< UpdateFunctionDefinitionCommandInput, diff --git a/clients/client-greengrass/commands/UpdateGroupCertificateConfigurationCommand.ts b/clients/client-greengrass/commands/UpdateGroupCertificateConfigurationCommand.ts index fe8e881b5111..c5c8aa5a1829 100644 --- a/clients/client-greengrass/commands/UpdateGroupCertificateConfigurationCommand.ts +++ b/clients/client-greengrass/commands/UpdateGroupCertificateConfigurationCommand.ts @@ -27,6 +27,20 @@ export interface UpdateGroupCertificateConfigurationCommandOutput /** * Updates the Certificate expiry time for a group. + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { GreengrassClient, UpdateGroupCertificateConfigurationCommand } from "@aws-sdk/client-greengrass"; // ES Modules import + * // const { GreengrassClient, UpdateGroupCertificateConfigurationCommand } = require("@aws-sdk/client-greengrass"); // CommonJS import + * const client = new GreengrassClient(config); + * const command = new UpdateGroupCertificateConfigurationCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link UpdateGroupCertificateConfigurationCommandInput} for command's `input` shape. + * @see {@link UpdateGroupCertificateConfigurationCommandOutput} for command's `response` shape. + * @see {@link GreengrassClientResolvedConfig | config} for command's `input` shape. + * */ export class UpdateGroupCertificateConfigurationCommand extends $Command< UpdateGroupCertificateConfigurationCommandInput, diff --git a/clients/client-greengrass/commands/UpdateGroupCommand.ts b/clients/client-greengrass/commands/UpdateGroupCommand.ts index faafdf08cd7d..0dd44d3f926b 100644 --- a/clients/client-greengrass/commands/UpdateGroupCommand.ts +++ b/clients/client-greengrass/commands/UpdateGroupCommand.ts @@ -22,6 +22,20 @@ export interface UpdateGroupCommandOutput extends UpdateGroupResponse, __Metadat /** * Updates a group. + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { GreengrassClient, UpdateGroupCommand } from "@aws-sdk/client-greengrass"; // ES Modules import + * // const { GreengrassClient, UpdateGroupCommand } = require("@aws-sdk/client-greengrass"); // CommonJS import + * const client = new GreengrassClient(config); + * const command = new UpdateGroupCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link UpdateGroupCommandInput} for command's `input` shape. + * @see {@link UpdateGroupCommandOutput} for command's `response` shape. + * @see {@link GreengrassClientResolvedConfig | config} for command's `input` shape. + * */ export class UpdateGroupCommand extends $Command< UpdateGroupCommandInput, diff --git a/clients/client-greengrass/commands/UpdateLoggerDefinitionCommand.ts b/clients/client-greengrass/commands/UpdateLoggerDefinitionCommand.ts index de5dbf3d0d0b..62f929e4ef5a 100644 --- a/clients/client-greengrass/commands/UpdateLoggerDefinitionCommand.ts +++ b/clients/client-greengrass/commands/UpdateLoggerDefinitionCommand.ts @@ -22,6 +22,20 @@ export interface UpdateLoggerDefinitionCommandOutput extends UpdateLoggerDefinit /** * Updates a logger definition. + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { GreengrassClient, UpdateLoggerDefinitionCommand } from "@aws-sdk/client-greengrass"; // ES Modules import + * // const { GreengrassClient, UpdateLoggerDefinitionCommand } = require("@aws-sdk/client-greengrass"); // CommonJS import + * const client = new GreengrassClient(config); + * const command = new UpdateLoggerDefinitionCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link UpdateLoggerDefinitionCommandInput} for command's `input` shape. + * @see {@link UpdateLoggerDefinitionCommandOutput} for command's `response` shape. + * @see {@link GreengrassClientResolvedConfig | config} for command's `input` shape. + * */ export class UpdateLoggerDefinitionCommand extends $Command< UpdateLoggerDefinitionCommandInput, diff --git a/clients/client-greengrass/commands/UpdateResourceDefinitionCommand.ts b/clients/client-greengrass/commands/UpdateResourceDefinitionCommand.ts index 57cc3b00d7f4..fd304eb61c8e 100644 --- a/clients/client-greengrass/commands/UpdateResourceDefinitionCommand.ts +++ b/clients/client-greengrass/commands/UpdateResourceDefinitionCommand.ts @@ -22,6 +22,20 @@ export interface UpdateResourceDefinitionCommandOutput extends UpdateResourceDef /** * Updates a resource definition. + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { GreengrassClient, UpdateResourceDefinitionCommand } from "@aws-sdk/client-greengrass"; // ES Modules import + * // const { GreengrassClient, UpdateResourceDefinitionCommand } = require("@aws-sdk/client-greengrass"); // CommonJS import + * const client = new GreengrassClient(config); + * const command = new UpdateResourceDefinitionCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link UpdateResourceDefinitionCommandInput} for command's `input` shape. + * @see {@link UpdateResourceDefinitionCommandOutput} for command's `response` shape. + * @see {@link GreengrassClientResolvedConfig | config} for command's `input` shape. + * */ export class UpdateResourceDefinitionCommand extends $Command< UpdateResourceDefinitionCommandInput, diff --git a/clients/client-greengrass/commands/UpdateSubscriptionDefinitionCommand.ts b/clients/client-greengrass/commands/UpdateSubscriptionDefinitionCommand.ts index ecb8017e3074..de80be2a5b7e 100644 --- a/clients/client-greengrass/commands/UpdateSubscriptionDefinitionCommand.ts +++ b/clients/client-greengrass/commands/UpdateSubscriptionDefinitionCommand.ts @@ -24,6 +24,20 @@ export interface UpdateSubscriptionDefinitionCommandOutput /** * Updates a subscription definition. + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { GreengrassClient, UpdateSubscriptionDefinitionCommand } from "@aws-sdk/client-greengrass"; // ES Modules import + * // const { GreengrassClient, UpdateSubscriptionDefinitionCommand } = require("@aws-sdk/client-greengrass"); // CommonJS import + * const client = new GreengrassClient(config); + * const command = new UpdateSubscriptionDefinitionCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link UpdateSubscriptionDefinitionCommandInput} for command's `input` shape. + * @see {@link UpdateSubscriptionDefinitionCommandOutput} for command's `response` shape. + * @see {@link GreengrassClientResolvedConfig | config} for command's `input` shape. + * */ export class UpdateSubscriptionDefinitionCommand extends $Command< UpdateSubscriptionDefinitionCommandInput, diff --git a/clients/client-greengrass/commands/UpdateThingRuntimeConfigurationCommand.ts b/clients/client-greengrass/commands/UpdateThingRuntimeConfigurationCommand.ts index 31924e3919e0..e4e145fd41fe 100644 --- a/clients/client-greengrass/commands/UpdateThingRuntimeConfigurationCommand.ts +++ b/clients/client-greengrass/commands/UpdateThingRuntimeConfigurationCommand.ts @@ -24,6 +24,20 @@ export interface UpdateThingRuntimeConfigurationCommandOutput /** * Updates the runtime configuration of a thing. + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { GreengrassClient, UpdateThingRuntimeConfigurationCommand } from "@aws-sdk/client-greengrass"; // ES Modules import + * // const { GreengrassClient, UpdateThingRuntimeConfigurationCommand } = require("@aws-sdk/client-greengrass"); // CommonJS import + * const client = new GreengrassClient(config); + * const command = new UpdateThingRuntimeConfigurationCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link UpdateThingRuntimeConfigurationCommandInput} for command's `input` shape. + * @see {@link UpdateThingRuntimeConfigurationCommandOutput} for command's `response` shape. + * @see {@link GreengrassClientResolvedConfig | config} for command's `input` shape. + * */ export class UpdateThingRuntimeConfigurationCommand extends $Command< UpdateThingRuntimeConfigurationCommandInput, diff --git a/clients/client-greengrass/models/models_0.ts b/clients/client-greengrass/models/models_0.ts index 39279913299c..e9c5951a068c 100644 --- a/clients/client-greengrass/models/models_0.ts +++ b/clients/client-greengrass/models/models_0.ts @@ -27,6 +27,9 @@ export interface ConnectivityInfo { } export namespace ConnectivityInfo { + /** + * @internal + */ export const filterSensitiveLog = (obj: ConnectivityInfo): any => ({ ...obj, }); @@ -53,6 +56,9 @@ export interface Connector { } export namespace Connector { + /** + * @internal + */ export const filterSensitiveLog = (obj: Connector): any => ({ ...obj, }); @@ -84,6 +90,9 @@ export interface Core { } export namespace Core { + /** + * @internal + */ export const filterSensitiveLog = (obj: Core): any => ({ ...obj, }); @@ -135,6 +144,9 @@ export interface DefinitionInformation { } export namespace DefinitionInformation { + /** + * @internal + */ export const filterSensitiveLog = (obj: DefinitionInformation): any => ({ ...obj, }); @@ -166,6 +178,9 @@ export interface Device { } export namespace Device { + /** + * @internal + */ export const filterSensitiveLog = (obj: Device): any => ({ ...obj, }); @@ -197,6 +212,9 @@ export interface FunctionRunAsConfig { } export namespace FunctionRunAsConfig { + /** + * @internal + */ export const filterSensitiveLog = (obj: FunctionRunAsConfig): any => ({ ...obj, }); @@ -218,6 +236,9 @@ export interface FunctionExecutionConfig { } export namespace FunctionExecutionConfig { + /** + * @internal + */ export const filterSensitiveLog = (obj: FunctionExecutionConfig): any => ({ ...obj, }); @@ -244,6 +265,9 @@ export interface ResourceAccessPolicy { } export namespace ResourceAccessPolicy { + /** + * @internal + */ export const filterSensitiveLog = (obj: ResourceAccessPolicy): any => ({ ...obj, }); @@ -275,6 +299,9 @@ export interface FunctionConfigurationEnvironment { } export namespace FunctionConfigurationEnvironment { + /** + * @internal + */ export const filterSensitiveLog = (obj: FunctionConfigurationEnvironment): any => ({ ...obj, }); @@ -321,6 +348,9 @@ export interface FunctionConfiguration { } export namespace FunctionConfiguration { + /** + * @internal + */ export const filterSensitiveLog = (obj: FunctionConfiguration): any => ({ ...obj, }); @@ -347,6 +377,9 @@ export interface Function { } export namespace Function { + /** + * @internal + */ export const filterSensitiveLog = (obj: Function): any => ({ ...obj, }); @@ -368,6 +401,9 @@ export interface GroupCertificateAuthorityProperties { } export namespace GroupCertificateAuthorityProperties { + /** + * @internal + */ export const filterSensitiveLog = (obj: GroupCertificateAuthorityProperties): any => ({ ...obj, }); @@ -414,6 +450,9 @@ export interface GroupInformation { } export namespace GroupInformation { + /** + * @internal + */ export const filterSensitiveLog = (obj: GroupInformation): any => ({ ...obj, }); @@ -468,6 +507,9 @@ export interface Logger { } export namespace Logger { + /** + * @internal + */ export const filterSensitiveLog = (obj: Logger): any => ({ ...obj, }); @@ -489,6 +531,9 @@ export interface GroupOwnerSetting { } export namespace GroupOwnerSetting { + /** + * @internal + */ export const filterSensitiveLog = (obj: GroupOwnerSetting): any => ({ ...obj, }); @@ -510,6 +555,9 @@ export interface LocalDeviceResourceData { } export namespace LocalDeviceResourceData { + /** + * @internal + */ export const filterSensitiveLog = (obj: LocalDeviceResourceData): any => ({ ...obj, }); @@ -536,6 +584,9 @@ export interface LocalVolumeResourceData { } export namespace LocalVolumeResourceData { + /** + * @internal + */ export const filterSensitiveLog = (obj: LocalVolumeResourceData): any => ({ ...obj, }); @@ -557,6 +608,9 @@ export interface ResourceDownloadOwnerSetting { } export namespace ResourceDownloadOwnerSetting { + /** + * @internal + */ export const filterSensitiveLog = (obj: ResourceDownloadOwnerSetting): any => ({ ...obj, }); @@ -583,6 +637,9 @@ export interface S3MachineLearningModelResourceData { } export namespace S3MachineLearningModelResourceData { + /** + * @internal + */ export const filterSensitiveLog = (obj: S3MachineLearningModelResourceData): any => ({ ...obj, }); @@ -609,6 +666,9 @@ export interface SageMakerMachineLearningModelResourceData { } export namespace SageMakerMachineLearningModelResourceData { + /** + * @internal + */ export const filterSensitiveLog = (obj: SageMakerMachineLearningModelResourceData): any => ({ ...obj, }); @@ -630,6 +690,9 @@ export interface SecretsManagerSecretResourceData { } export namespace SecretsManagerSecretResourceData { + /** + * @internal + */ export const filterSensitiveLog = (obj: SecretsManagerSecretResourceData): any => ({ ...obj, }); @@ -666,6 +729,9 @@ export interface ResourceDataContainer { } export namespace ResourceDataContainer { + /** + * @internal + */ export const filterSensitiveLog = (obj: ResourceDataContainer): any => ({ ...obj, }); @@ -692,6 +758,9 @@ export interface Resource { } export namespace Resource { + /** + * @internal + */ export const filterSensitiveLog = (obj: Resource): any => ({ ...obj, }); @@ -723,6 +792,9 @@ export interface Subscription { } export namespace Subscription { + /** + * @internal + */ export const filterSensitiveLog = (obj: Subscription): any => ({ ...obj, }); @@ -754,6 +826,9 @@ export interface VersionInformation { } export namespace VersionInformation { + /** + * @internal + */ export const filterSensitiveLog = (obj: VersionInformation): any => ({ ...obj, }); @@ -772,6 +847,9 @@ export interface AssociateRoleToGroupRequest { } export namespace AssociateRoleToGroupRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: AssociateRoleToGroupRequest): any => ({ ...obj, }); @@ -785,6 +863,9 @@ export interface AssociateRoleToGroupResponse { } export namespace AssociateRoleToGroupResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: AssociateRoleToGroupResponse): any => ({ ...obj, }); @@ -806,6 +887,9 @@ export interface ErrorDetail { } export namespace ErrorDetail { + /** + * @internal + */ export const filterSensitiveLog = (obj: ErrorDetail): any => ({ ...obj, }); @@ -829,6 +913,9 @@ export interface BadRequestException extends __SmithyException, $MetadataBearer } export namespace BadRequestException { + /** + * @internal + */ export const filterSensitiveLog = (obj: BadRequestException): any => ({ ...obj, }); @@ -852,6 +939,9 @@ export interface InternalServerErrorException extends __SmithyException, $Metada } export namespace InternalServerErrorException { + /** + * @internal + */ export const filterSensitiveLog = (obj: InternalServerErrorException): any => ({ ...obj, }); @@ -865,6 +955,9 @@ export interface AssociateServiceRoleToAccountRequest { } export namespace AssociateServiceRoleToAccountRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: AssociateServiceRoleToAccountRequest): any => ({ ...obj, }); @@ -878,6 +971,9 @@ export interface AssociateServiceRoleToAccountResponse { } export namespace AssociateServiceRoleToAccountResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: AssociateServiceRoleToAccountResponse): any => ({ ...obj, }); @@ -904,6 +1000,9 @@ export interface BulkDeployment { } export namespace BulkDeployment { + /** + * @internal + */ export const filterSensitiveLog = (obj: BulkDeployment): any => ({ ...obj, }); @@ -930,6 +1029,9 @@ export interface BulkDeploymentMetrics { } export namespace BulkDeploymentMetrics { + /** + * @internal + */ export const filterSensitiveLog = (obj: BulkDeploymentMetrics): any => ({ ...obj, }); @@ -988,6 +1090,9 @@ export interface BulkDeploymentResult { } export namespace BulkDeploymentResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: BulkDeploymentResult): any => ({ ...obj, }); @@ -1018,6 +1123,9 @@ export interface ConnectorDefinitionVersion { } export namespace ConnectorDefinitionVersion { + /** + * @internal + */ export const filterSensitiveLog = (obj: ConnectorDefinitionVersion): any => ({ ...obj, }); @@ -1034,6 +1142,9 @@ export interface CoreDefinitionVersion { } export namespace CoreDefinitionVersion { + /** + * @internal + */ export const filterSensitiveLog = (obj: CoreDefinitionVersion): any => ({ ...obj, }); @@ -1062,6 +1173,9 @@ export interface CreateConnectorDefinitionRequest { } export namespace CreateConnectorDefinitionRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateConnectorDefinitionRequest): any => ({ ...obj, }); @@ -1105,6 +1219,9 @@ export interface CreateConnectorDefinitionResponse { } export namespace CreateConnectorDefinitionResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateConnectorDefinitionResponse): any => ({ ...obj, }); @@ -1128,6 +1245,9 @@ export interface CreateConnectorDefinitionVersionRequest { } export namespace CreateConnectorDefinitionVersionRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateConnectorDefinitionVersionRequest): any => ({ ...obj, }); @@ -1156,6 +1276,9 @@ export interface CreateConnectorDefinitionVersionResponse { } export namespace CreateConnectorDefinitionVersionResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateConnectorDefinitionVersionResponse): any => ({ ...obj, }); @@ -1187,6 +1310,9 @@ export interface CreateCoreDefinitionRequest { } export namespace CreateCoreDefinitionRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateCoreDefinitionRequest): any => ({ ...obj, }); @@ -1230,6 +1356,9 @@ export interface CreateCoreDefinitionResponse { } export namespace CreateCoreDefinitionResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateCoreDefinitionResponse): any => ({ ...obj, }); @@ -1253,6 +1382,9 @@ export interface CreateCoreDefinitionVersionRequest { } export namespace CreateCoreDefinitionVersionRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateCoreDefinitionVersionRequest): any => ({ ...obj, }); @@ -1281,6 +1413,9 @@ export interface CreateCoreDefinitionVersionResponse { } export namespace CreateCoreDefinitionVersionResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateCoreDefinitionVersionResponse): any => ({ ...obj, }); @@ -1314,6 +1449,9 @@ export interface CreateDeploymentRequest { } export namespace CreateDeploymentRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateDeploymentRequest): any => ({ ...obj, }); @@ -1332,6 +1470,9 @@ export interface CreateDeploymentResponse { } export namespace CreateDeploymentResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateDeploymentResponse): any => ({ ...obj, }); @@ -1348,6 +1489,9 @@ export interface DeviceDefinitionVersion { } export namespace DeviceDefinitionVersion { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeviceDefinitionVersion): any => ({ ...obj, }); @@ -1376,6 +1520,9 @@ export interface CreateDeviceDefinitionRequest { } export namespace CreateDeviceDefinitionRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateDeviceDefinitionRequest): any => ({ ...obj, }); @@ -1419,6 +1566,9 @@ export interface CreateDeviceDefinitionResponse { } export namespace CreateDeviceDefinitionResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateDeviceDefinitionResponse): any => ({ ...obj, }); @@ -1442,6 +1592,9 @@ export interface CreateDeviceDefinitionVersionRequest { } export namespace CreateDeviceDefinitionVersionRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateDeviceDefinitionVersionRequest): any => ({ ...obj, }); @@ -1470,6 +1623,9 @@ export interface CreateDeviceDefinitionVersionResponse { } export namespace CreateDeviceDefinitionVersionResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateDeviceDefinitionVersionResponse): any => ({ ...obj, }); @@ -1491,6 +1647,9 @@ export interface FunctionDefaultExecutionConfig { } export namespace FunctionDefaultExecutionConfig { + /** + * @internal + */ export const filterSensitiveLog = (obj: FunctionDefaultExecutionConfig): any => ({ ...obj, }); @@ -1507,6 +1666,9 @@ export interface FunctionDefaultConfig { } export namespace FunctionDefaultConfig { + /** + * @internal + */ export const filterSensitiveLog = (obj: FunctionDefaultConfig): any => ({ ...obj, }); @@ -1528,6 +1690,9 @@ export interface FunctionDefinitionVersion { } export namespace FunctionDefinitionVersion { + /** + * @internal + */ export const filterSensitiveLog = (obj: FunctionDefinitionVersion): any => ({ ...obj, }); @@ -1556,6 +1721,9 @@ export interface CreateFunctionDefinitionRequest { } export namespace CreateFunctionDefinitionRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateFunctionDefinitionRequest): any => ({ ...obj, }); @@ -1599,6 +1767,9 @@ export interface CreateFunctionDefinitionResponse { } export namespace CreateFunctionDefinitionResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateFunctionDefinitionResponse): any => ({ ...obj, }); @@ -1630,6 +1801,9 @@ export interface CreateFunctionDefinitionVersionRequest { } export namespace CreateFunctionDefinitionVersionRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateFunctionDefinitionVersionRequest): any => ({ ...obj, }); @@ -1658,6 +1832,9 @@ export interface CreateFunctionDefinitionVersionResponse { } export namespace CreateFunctionDefinitionVersionResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateFunctionDefinitionVersionResponse): any => ({ ...obj, }); @@ -1704,6 +1881,9 @@ export interface GroupVersion { } export namespace GroupVersion { + /** + * @internal + */ export const filterSensitiveLog = (obj: GroupVersion): any => ({ ...obj, }); @@ -1732,6 +1912,9 @@ export interface CreateGroupRequest { } export namespace CreateGroupRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateGroupRequest): any => ({ ...obj, }); @@ -1775,6 +1958,9 @@ export interface CreateGroupResponse { } export namespace CreateGroupResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateGroupResponse): any => ({ ...obj, }); @@ -1793,6 +1979,9 @@ export interface CreateGroupCertificateAuthorityRequest { } export namespace CreateGroupCertificateAuthorityRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateGroupCertificateAuthorityRequest): any => ({ ...obj, }); @@ -1806,6 +1995,9 @@ export interface CreateGroupCertificateAuthorityResponse { } export namespace CreateGroupCertificateAuthorityResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateGroupCertificateAuthorityResponse): any => ({ ...obj, }); @@ -1859,6 +2051,9 @@ export interface CreateGroupVersionRequest { } export namespace CreateGroupVersionRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateGroupVersionRequest): any => ({ ...obj, }); @@ -1887,6 +2082,9 @@ export interface CreateGroupVersionResponse { } export namespace CreateGroupVersionResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateGroupVersionResponse): any => ({ ...obj, }); @@ -1903,6 +2101,9 @@ export interface LoggerDefinitionVersion { } export namespace LoggerDefinitionVersion { + /** + * @internal + */ export const filterSensitiveLog = (obj: LoggerDefinitionVersion): any => ({ ...obj, }); @@ -1931,6 +2132,9 @@ export interface CreateLoggerDefinitionRequest { } export namespace CreateLoggerDefinitionRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateLoggerDefinitionRequest): any => ({ ...obj, }); @@ -1974,6 +2178,9 @@ export interface CreateLoggerDefinitionResponse { } export namespace CreateLoggerDefinitionResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateLoggerDefinitionResponse): any => ({ ...obj, }); @@ -1997,6 +2204,9 @@ export interface CreateLoggerDefinitionVersionRequest { } export namespace CreateLoggerDefinitionVersionRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateLoggerDefinitionVersionRequest): any => ({ ...obj, }); @@ -2025,6 +2235,9 @@ export interface CreateLoggerDefinitionVersionResponse { } export namespace CreateLoggerDefinitionVersionResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateLoggerDefinitionVersionResponse): any => ({ ...obj, }); @@ -2041,6 +2254,9 @@ export interface ResourceDefinitionVersion { } export namespace ResourceDefinitionVersion { + /** + * @internal + */ export const filterSensitiveLog = (obj: ResourceDefinitionVersion): any => ({ ...obj, }); @@ -2069,6 +2285,9 @@ export interface CreateResourceDefinitionRequest { } export namespace CreateResourceDefinitionRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateResourceDefinitionRequest): any => ({ ...obj, }); @@ -2112,6 +2331,9 @@ export interface CreateResourceDefinitionResponse { } export namespace CreateResourceDefinitionResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateResourceDefinitionResponse): any => ({ ...obj, }); @@ -2135,6 +2357,9 @@ export interface CreateResourceDefinitionVersionRequest { } export namespace CreateResourceDefinitionVersionRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateResourceDefinitionVersionRequest): any => ({ ...obj, }); @@ -2163,6 +2388,9 @@ export interface CreateResourceDefinitionVersionResponse { } export namespace CreateResourceDefinitionVersionResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateResourceDefinitionVersionResponse): any => ({ ...obj, }); @@ -2236,6 +2464,9 @@ export interface CreateSoftwareUpdateJobRequest { } export namespace CreateSoftwareUpdateJobRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateSoftwareUpdateJobRequest): any => ({ ...obj, }); @@ -2259,6 +2490,9 @@ export interface CreateSoftwareUpdateJobResponse { } export namespace CreateSoftwareUpdateJobResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateSoftwareUpdateJobResponse): any => ({ ...obj, }); @@ -2275,6 +2509,9 @@ export interface SubscriptionDefinitionVersion { } export namespace SubscriptionDefinitionVersion { + /** + * @internal + */ export const filterSensitiveLog = (obj: SubscriptionDefinitionVersion): any => ({ ...obj, }); @@ -2303,6 +2540,9 @@ export interface CreateSubscriptionDefinitionRequest { } export namespace CreateSubscriptionDefinitionRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateSubscriptionDefinitionRequest): any => ({ ...obj, }); @@ -2346,6 +2586,9 @@ export interface CreateSubscriptionDefinitionResponse { } export namespace CreateSubscriptionDefinitionResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateSubscriptionDefinitionResponse): any => ({ ...obj, }); @@ -2369,6 +2612,9 @@ export interface CreateSubscriptionDefinitionVersionRequest { } export namespace CreateSubscriptionDefinitionVersionRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateSubscriptionDefinitionVersionRequest): any => ({ ...obj, }); @@ -2397,6 +2643,9 @@ export interface CreateSubscriptionDefinitionVersionResponse { } export namespace CreateSubscriptionDefinitionVersionResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateSubscriptionDefinitionVersionResponse): any => ({ ...obj, }); @@ -2410,6 +2659,9 @@ export interface DeleteConnectorDefinitionRequest { } export namespace DeleteConnectorDefinitionRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteConnectorDefinitionRequest): any => ({ ...obj, }); @@ -2418,6 +2670,9 @@ export namespace DeleteConnectorDefinitionRequest { export interface DeleteConnectorDefinitionResponse {} export namespace DeleteConnectorDefinitionResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteConnectorDefinitionResponse): any => ({ ...obj, }); @@ -2431,6 +2686,9 @@ export interface DeleteCoreDefinitionRequest { } export namespace DeleteCoreDefinitionRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteCoreDefinitionRequest): any => ({ ...obj, }); @@ -2439,6 +2697,9 @@ export namespace DeleteCoreDefinitionRequest { export interface DeleteCoreDefinitionResponse {} export namespace DeleteCoreDefinitionResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteCoreDefinitionResponse): any => ({ ...obj, }); @@ -2452,6 +2713,9 @@ export interface DeleteDeviceDefinitionRequest { } export namespace DeleteDeviceDefinitionRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteDeviceDefinitionRequest): any => ({ ...obj, }); @@ -2460,6 +2724,9 @@ export namespace DeleteDeviceDefinitionRequest { export interface DeleteDeviceDefinitionResponse {} export namespace DeleteDeviceDefinitionResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteDeviceDefinitionResponse): any => ({ ...obj, }); @@ -2473,6 +2740,9 @@ export interface DeleteFunctionDefinitionRequest { } export namespace DeleteFunctionDefinitionRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteFunctionDefinitionRequest): any => ({ ...obj, }); @@ -2481,6 +2751,9 @@ export namespace DeleteFunctionDefinitionRequest { export interface DeleteFunctionDefinitionResponse {} export namespace DeleteFunctionDefinitionResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteFunctionDefinitionResponse): any => ({ ...obj, }); @@ -2494,6 +2767,9 @@ export interface DeleteGroupRequest { } export namespace DeleteGroupRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteGroupRequest): any => ({ ...obj, }); @@ -2502,6 +2778,9 @@ export namespace DeleteGroupRequest { export interface DeleteGroupResponse {} export namespace DeleteGroupResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteGroupResponse): any => ({ ...obj, }); @@ -2515,6 +2794,9 @@ export interface DeleteLoggerDefinitionRequest { } export namespace DeleteLoggerDefinitionRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteLoggerDefinitionRequest): any => ({ ...obj, }); @@ -2523,6 +2805,9 @@ export namespace DeleteLoggerDefinitionRequest { export interface DeleteLoggerDefinitionResponse {} export namespace DeleteLoggerDefinitionResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteLoggerDefinitionResponse): any => ({ ...obj, }); @@ -2536,6 +2821,9 @@ export interface DeleteResourceDefinitionRequest { } export namespace DeleteResourceDefinitionRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteResourceDefinitionRequest): any => ({ ...obj, }); @@ -2544,6 +2832,9 @@ export namespace DeleteResourceDefinitionRequest { export interface DeleteResourceDefinitionResponse {} export namespace DeleteResourceDefinitionResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteResourceDefinitionResponse): any => ({ ...obj, }); @@ -2557,6 +2848,9 @@ export interface DeleteSubscriptionDefinitionRequest { } export namespace DeleteSubscriptionDefinitionRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteSubscriptionDefinitionRequest): any => ({ ...obj, }); @@ -2565,6 +2859,9 @@ export namespace DeleteSubscriptionDefinitionRequest { export interface DeleteSubscriptionDefinitionResponse {} export namespace DeleteSubscriptionDefinitionResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteSubscriptionDefinitionResponse): any => ({ ...obj, }); @@ -2601,6 +2898,9 @@ export interface Deployment { } export namespace Deployment { + /** + * @internal + */ export const filterSensitiveLog = (obj: Deployment): any => ({ ...obj, }); @@ -2614,6 +2914,9 @@ export interface DisassociateRoleFromGroupRequest { } export namespace DisassociateRoleFromGroupRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DisassociateRoleFromGroupRequest): any => ({ ...obj, }); @@ -2627,6 +2930,9 @@ export interface DisassociateRoleFromGroupResponse { } export namespace DisassociateRoleFromGroupResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DisassociateRoleFromGroupResponse): any => ({ ...obj, }); @@ -2635,6 +2941,9 @@ export namespace DisassociateRoleFromGroupResponse { export interface DisassociateServiceRoleFromAccountRequest {} export namespace DisassociateServiceRoleFromAccountRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DisassociateServiceRoleFromAccountRequest): any => ({ ...obj, }); @@ -2648,6 +2957,9 @@ export interface DisassociateServiceRoleFromAccountResponse { } export namespace DisassociateServiceRoleFromAccountResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DisassociateServiceRoleFromAccountResponse): any => ({ ...obj, }); @@ -2661,6 +2973,9 @@ export interface GetAssociatedRoleRequest { } export namespace GetAssociatedRoleRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetAssociatedRoleRequest): any => ({ ...obj, }); @@ -2679,6 +2994,9 @@ export interface GetAssociatedRoleResponse { } export namespace GetAssociatedRoleResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetAssociatedRoleResponse): any => ({ ...obj, }); @@ -2692,6 +3010,9 @@ export interface GetBulkDeploymentStatusRequest { } export namespace GetBulkDeploymentStatusRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetBulkDeploymentStatusRequest): any => ({ ...obj, }); @@ -2730,6 +3051,9 @@ export interface GetBulkDeploymentStatusResponse { } export namespace GetBulkDeploymentStatusResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetBulkDeploymentStatusResponse): any => ({ ...obj, }); @@ -2743,6 +3067,9 @@ export interface GetConnectivityInfoRequest { } export namespace GetConnectivityInfoRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetConnectivityInfoRequest): any => ({ ...obj, }); @@ -2761,6 +3088,9 @@ export interface GetConnectivityInfoResponse { } export namespace GetConnectivityInfoResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetConnectivityInfoResponse): any => ({ ...obj, }); @@ -2774,6 +3104,9 @@ export interface GetConnectorDefinitionRequest { } export namespace GetConnectorDefinitionRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetConnectorDefinitionRequest): any => ({ ...obj, }); @@ -2822,6 +3155,9 @@ export interface GetConnectorDefinitionResponse { } export namespace GetConnectorDefinitionResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetConnectorDefinitionResponse): any => ({ ...obj, }); @@ -2845,6 +3181,9 @@ export interface GetConnectorDefinitionVersionRequest { } export namespace GetConnectorDefinitionVersionRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetConnectorDefinitionVersionRequest): any => ({ ...obj, }); @@ -2883,6 +3222,9 @@ export interface GetConnectorDefinitionVersionResponse { } export namespace GetConnectorDefinitionVersionResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetConnectorDefinitionVersionResponse): any => ({ ...obj, }); @@ -2896,6 +3238,9 @@ export interface GetCoreDefinitionRequest { } export namespace GetCoreDefinitionRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetCoreDefinitionRequest): any => ({ ...obj, }); @@ -2944,6 +3289,9 @@ export interface GetCoreDefinitionResponse { } export namespace GetCoreDefinitionResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetCoreDefinitionResponse): any => ({ ...obj, }); @@ -2962,6 +3310,9 @@ export interface GetCoreDefinitionVersionRequest { } export namespace GetCoreDefinitionVersionRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetCoreDefinitionVersionRequest): any => ({ ...obj, }); @@ -3000,6 +3351,9 @@ export interface GetCoreDefinitionVersionResponse { } export namespace GetCoreDefinitionVersionResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetCoreDefinitionVersionResponse): any => ({ ...obj, }); @@ -3018,6 +3372,9 @@ export interface GetDeploymentStatusRequest { } export namespace GetDeploymentStatusRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetDeploymentStatusRequest): any => ({ ...obj, }); @@ -3051,6 +3408,9 @@ export interface GetDeploymentStatusResponse { } export namespace GetDeploymentStatusResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetDeploymentStatusResponse): any => ({ ...obj, }); @@ -3064,6 +3424,9 @@ export interface GetDeviceDefinitionRequest { } export namespace GetDeviceDefinitionRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetDeviceDefinitionRequest): any => ({ ...obj, }); @@ -3112,6 +3475,9 @@ export interface GetDeviceDefinitionResponse { } export namespace GetDeviceDefinitionResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetDeviceDefinitionResponse): any => ({ ...obj, }); @@ -3135,6 +3501,9 @@ export interface GetDeviceDefinitionVersionRequest { } export namespace GetDeviceDefinitionVersionRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetDeviceDefinitionVersionRequest): any => ({ ...obj, }); @@ -3173,6 +3542,9 @@ export interface GetDeviceDefinitionVersionResponse { } export namespace GetDeviceDefinitionVersionResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetDeviceDefinitionVersionResponse): any => ({ ...obj, }); @@ -3186,6 +3558,9 @@ export interface GetFunctionDefinitionRequest { } export namespace GetFunctionDefinitionRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetFunctionDefinitionRequest): any => ({ ...obj, }); @@ -3234,6 +3609,9 @@ export interface GetFunctionDefinitionResponse { } export namespace GetFunctionDefinitionResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetFunctionDefinitionResponse): any => ({ ...obj, }); @@ -3257,6 +3635,9 @@ export interface GetFunctionDefinitionVersionRequest { } export namespace GetFunctionDefinitionVersionRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetFunctionDefinitionVersionRequest): any => ({ ...obj, }); @@ -3295,6 +3676,9 @@ export interface GetFunctionDefinitionVersionResponse { } export namespace GetFunctionDefinitionVersionResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetFunctionDefinitionVersionResponse): any => ({ ...obj, }); @@ -3308,6 +3692,9 @@ export interface GetGroupRequest { } export namespace GetGroupRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetGroupRequest): any => ({ ...obj, }); @@ -3356,6 +3743,9 @@ export interface GetGroupResponse { } export namespace GetGroupResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetGroupResponse): any => ({ ...obj, }); @@ -3374,6 +3764,9 @@ export interface GetGroupCertificateAuthorityRequest { } export namespace GetGroupCertificateAuthorityRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetGroupCertificateAuthorityRequest): any => ({ ...obj, }); @@ -3397,6 +3790,9 @@ export interface GetGroupCertificateAuthorityResponse { } export namespace GetGroupCertificateAuthorityResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetGroupCertificateAuthorityResponse): any => ({ ...obj, }); @@ -3410,6 +3806,9 @@ export interface GetGroupCertificateConfigurationRequest { } export namespace GetGroupCertificateConfigurationRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetGroupCertificateConfigurationRequest): any => ({ ...obj, }); @@ -3433,6 +3832,9 @@ export interface GetGroupCertificateConfigurationResponse { } export namespace GetGroupCertificateConfigurationResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetGroupCertificateConfigurationResponse): any => ({ ...obj, }); @@ -3451,6 +3853,9 @@ export interface GetGroupVersionRequest { } export namespace GetGroupVersionRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetGroupVersionRequest): any => ({ ...obj, }); @@ -3484,6 +3889,9 @@ export interface GetGroupVersionResponse { } export namespace GetGroupVersionResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetGroupVersionResponse): any => ({ ...obj, }); @@ -3497,6 +3905,9 @@ export interface GetLoggerDefinitionRequest { } export namespace GetLoggerDefinitionRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetLoggerDefinitionRequest): any => ({ ...obj, }); @@ -3545,6 +3956,9 @@ export interface GetLoggerDefinitionResponse { } export namespace GetLoggerDefinitionResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetLoggerDefinitionResponse): any => ({ ...obj, }); @@ -3568,6 +3982,9 @@ export interface GetLoggerDefinitionVersionRequest { } export namespace GetLoggerDefinitionVersionRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetLoggerDefinitionVersionRequest): any => ({ ...obj, }); @@ -3601,6 +4018,9 @@ export interface GetLoggerDefinitionVersionResponse { } export namespace GetLoggerDefinitionVersionResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetLoggerDefinitionVersionResponse): any => ({ ...obj, }); @@ -3614,6 +4034,9 @@ export interface GetResourceDefinitionRequest { } export namespace GetResourceDefinitionRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetResourceDefinitionRequest): any => ({ ...obj, }); @@ -3662,6 +4085,9 @@ export interface GetResourceDefinitionResponse { } export namespace GetResourceDefinitionResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetResourceDefinitionResponse): any => ({ ...obj, }); @@ -3680,6 +4106,9 @@ export interface GetResourceDefinitionVersionRequest { } export namespace GetResourceDefinitionVersionRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetResourceDefinitionVersionRequest): any => ({ ...obj, }); @@ -3713,6 +4142,9 @@ export interface GetResourceDefinitionVersionResponse { } export namespace GetResourceDefinitionVersionResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetResourceDefinitionVersionResponse): any => ({ ...obj, }); @@ -3721,6 +4153,9 @@ export namespace GetResourceDefinitionVersionResponse { export interface GetServiceRoleForAccountRequest {} export namespace GetServiceRoleForAccountRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetServiceRoleForAccountRequest): any => ({ ...obj, }); @@ -3739,6 +4174,9 @@ export interface GetServiceRoleForAccountResponse { } export namespace GetServiceRoleForAccountResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetServiceRoleForAccountResponse): any => ({ ...obj, }); @@ -3752,6 +4190,9 @@ export interface GetSubscriptionDefinitionRequest { } export namespace GetSubscriptionDefinitionRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetSubscriptionDefinitionRequest): any => ({ ...obj, }); @@ -3800,6 +4241,9 @@ export interface GetSubscriptionDefinitionResponse { } export namespace GetSubscriptionDefinitionResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetSubscriptionDefinitionResponse): any => ({ ...obj, }); @@ -3823,6 +4267,9 @@ export interface GetSubscriptionDefinitionVersionRequest { } export namespace GetSubscriptionDefinitionVersionRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetSubscriptionDefinitionVersionRequest): any => ({ ...obj, }); @@ -3861,6 +4308,9 @@ export interface GetSubscriptionDefinitionVersionResponse { } export namespace GetSubscriptionDefinitionVersionResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetSubscriptionDefinitionVersionResponse): any => ({ ...obj, }); @@ -3874,6 +4324,9 @@ export interface GetThingRuntimeConfigurationRequest { } export namespace GetThingRuntimeConfigurationRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetThingRuntimeConfigurationRequest): any => ({ ...obj, }); @@ -3900,6 +4353,9 @@ export interface TelemetryConfiguration { } export namespace TelemetryConfiguration { + /** + * @internal + */ export const filterSensitiveLog = (obj: TelemetryConfiguration): any => ({ ...obj, }); @@ -3916,6 +4372,9 @@ export interface RuntimeConfiguration { } export namespace RuntimeConfiguration { + /** + * @internal + */ export const filterSensitiveLog = (obj: RuntimeConfiguration): any => ({ ...obj, }); @@ -3929,6 +4388,9 @@ export interface GetThingRuntimeConfigurationResponse { } export namespace GetThingRuntimeConfigurationResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetThingRuntimeConfigurationResponse): any => ({ ...obj, }); @@ -3952,6 +4414,9 @@ export interface ListBulkDeploymentDetailedReportsRequest { } export namespace ListBulkDeploymentDetailedReportsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListBulkDeploymentDetailedReportsRequest): any => ({ ...obj, }); @@ -3970,6 +4435,9 @@ export interface ListBulkDeploymentDetailedReportsResponse { } export namespace ListBulkDeploymentDetailedReportsResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListBulkDeploymentDetailedReportsResponse): any => ({ ...obj, }); @@ -3988,6 +4456,9 @@ export interface ListBulkDeploymentsRequest { } export namespace ListBulkDeploymentsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListBulkDeploymentsRequest): any => ({ ...obj, }); @@ -4006,6 +4477,9 @@ export interface ListBulkDeploymentsResponse { } export namespace ListBulkDeploymentsResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListBulkDeploymentsResponse): any => ({ ...obj, }); @@ -4024,6 +4498,9 @@ export interface ListConnectorDefinitionsRequest { } export namespace ListConnectorDefinitionsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListConnectorDefinitionsRequest): any => ({ ...obj, }); @@ -4042,6 +4519,9 @@ export interface ListConnectorDefinitionsResponse { } export namespace ListConnectorDefinitionsResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListConnectorDefinitionsResponse): any => ({ ...obj, }); @@ -4065,6 +4545,9 @@ export interface ListConnectorDefinitionVersionsRequest { } export namespace ListConnectorDefinitionVersionsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListConnectorDefinitionVersionsRequest): any => ({ ...obj, }); @@ -4083,6 +4566,9 @@ export interface ListConnectorDefinitionVersionsResponse { } export namespace ListConnectorDefinitionVersionsResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListConnectorDefinitionVersionsResponse): any => ({ ...obj, }); @@ -4101,6 +4587,9 @@ export interface ListCoreDefinitionsRequest { } export namespace ListCoreDefinitionsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListCoreDefinitionsRequest): any => ({ ...obj, }); @@ -4119,6 +4608,9 @@ export interface ListCoreDefinitionsResponse { } export namespace ListCoreDefinitionsResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListCoreDefinitionsResponse): any => ({ ...obj, }); @@ -4142,6 +4634,9 @@ export interface ListCoreDefinitionVersionsRequest { } export namespace ListCoreDefinitionVersionsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListCoreDefinitionVersionsRequest): any => ({ ...obj, }); @@ -4160,6 +4655,9 @@ export interface ListCoreDefinitionVersionsResponse { } export namespace ListCoreDefinitionVersionsResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListCoreDefinitionVersionsResponse): any => ({ ...obj, }); @@ -4183,6 +4681,9 @@ export interface ListDeploymentsRequest { } export namespace ListDeploymentsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListDeploymentsRequest): any => ({ ...obj, }); @@ -4201,6 +4702,9 @@ export interface ListDeploymentsResponse { } export namespace ListDeploymentsResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListDeploymentsResponse): any => ({ ...obj, }); @@ -4219,6 +4723,9 @@ export interface ListDeviceDefinitionsRequest { } export namespace ListDeviceDefinitionsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListDeviceDefinitionsRequest): any => ({ ...obj, }); @@ -4237,6 +4744,9 @@ export interface ListDeviceDefinitionsResponse { } export namespace ListDeviceDefinitionsResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListDeviceDefinitionsResponse): any => ({ ...obj, }); @@ -4260,6 +4770,9 @@ export interface ListDeviceDefinitionVersionsRequest { } export namespace ListDeviceDefinitionVersionsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListDeviceDefinitionVersionsRequest): any => ({ ...obj, }); @@ -4278,6 +4791,9 @@ export interface ListDeviceDefinitionVersionsResponse { } export namespace ListDeviceDefinitionVersionsResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListDeviceDefinitionVersionsResponse): any => ({ ...obj, }); @@ -4296,6 +4812,9 @@ export interface ListFunctionDefinitionsRequest { } export namespace ListFunctionDefinitionsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListFunctionDefinitionsRequest): any => ({ ...obj, }); @@ -4314,6 +4833,9 @@ export interface ListFunctionDefinitionsResponse { } export namespace ListFunctionDefinitionsResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListFunctionDefinitionsResponse): any => ({ ...obj, }); @@ -4337,6 +4859,9 @@ export interface ListFunctionDefinitionVersionsRequest { } export namespace ListFunctionDefinitionVersionsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListFunctionDefinitionVersionsRequest): any => ({ ...obj, }); @@ -4355,6 +4880,9 @@ export interface ListFunctionDefinitionVersionsResponse { } export namespace ListFunctionDefinitionVersionsResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListFunctionDefinitionVersionsResponse): any => ({ ...obj, }); @@ -4368,6 +4896,9 @@ export interface ListGroupCertificateAuthoritiesRequest { } export namespace ListGroupCertificateAuthoritiesRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListGroupCertificateAuthoritiesRequest): any => ({ ...obj, }); @@ -4381,6 +4912,9 @@ export interface ListGroupCertificateAuthoritiesResponse { } export namespace ListGroupCertificateAuthoritiesResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListGroupCertificateAuthoritiesResponse): any => ({ ...obj, }); @@ -4399,6 +4933,9 @@ export interface ListGroupsRequest { } export namespace ListGroupsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListGroupsRequest): any => ({ ...obj, }); @@ -4417,6 +4954,9 @@ export interface ListGroupsResponse { } export namespace ListGroupsResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListGroupsResponse): any => ({ ...obj, }); @@ -4440,6 +4980,9 @@ export interface ListGroupVersionsRequest { } export namespace ListGroupVersionsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListGroupVersionsRequest): any => ({ ...obj, }); @@ -4458,6 +5001,9 @@ export interface ListGroupVersionsResponse { } export namespace ListGroupVersionsResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListGroupVersionsResponse): any => ({ ...obj, }); @@ -4476,6 +5022,9 @@ export interface ListLoggerDefinitionsRequest { } export namespace ListLoggerDefinitionsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListLoggerDefinitionsRequest): any => ({ ...obj, }); @@ -4494,6 +5043,9 @@ export interface ListLoggerDefinitionsResponse { } export namespace ListLoggerDefinitionsResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListLoggerDefinitionsResponse): any => ({ ...obj, }); @@ -4517,6 +5069,9 @@ export interface ListLoggerDefinitionVersionsRequest { } export namespace ListLoggerDefinitionVersionsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListLoggerDefinitionVersionsRequest): any => ({ ...obj, }); @@ -4535,6 +5090,9 @@ export interface ListLoggerDefinitionVersionsResponse { } export namespace ListLoggerDefinitionVersionsResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListLoggerDefinitionVersionsResponse): any => ({ ...obj, }); @@ -4553,6 +5111,9 @@ export interface ListResourceDefinitionsRequest { } export namespace ListResourceDefinitionsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListResourceDefinitionsRequest): any => ({ ...obj, }); @@ -4571,6 +5132,9 @@ export interface ListResourceDefinitionsResponse { } export namespace ListResourceDefinitionsResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListResourceDefinitionsResponse): any => ({ ...obj, }); @@ -4594,6 +5158,9 @@ export interface ListResourceDefinitionVersionsRequest { } export namespace ListResourceDefinitionVersionsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListResourceDefinitionVersionsRequest): any => ({ ...obj, }); @@ -4612,6 +5179,9 @@ export interface ListResourceDefinitionVersionsResponse { } export namespace ListResourceDefinitionVersionsResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListResourceDefinitionVersionsResponse): any => ({ ...obj, }); @@ -4630,6 +5200,9 @@ export interface ListSubscriptionDefinitionsRequest { } export namespace ListSubscriptionDefinitionsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListSubscriptionDefinitionsRequest): any => ({ ...obj, }); @@ -4648,6 +5221,9 @@ export interface ListSubscriptionDefinitionsResponse { } export namespace ListSubscriptionDefinitionsResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListSubscriptionDefinitionsResponse): any => ({ ...obj, }); @@ -4671,6 +5247,9 @@ export interface ListSubscriptionDefinitionVersionsRequest { } export namespace ListSubscriptionDefinitionVersionsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListSubscriptionDefinitionVersionsRequest): any => ({ ...obj, }); @@ -4689,6 +5268,9 @@ export interface ListSubscriptionDefinitionVersionsResponse { } export namespace ListSubscriptionDefinitionVersionsResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListSubscriptionDefinitionVersionsResponse): any => ({ ...obj, }); @@ -4702,6 +5284,9 @@ export interface ListTagsForResourceRequest { } export namespace ListTagsForResourceRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListTagsForResourceRequest): any => ({ ...obj, }); @@ -4715,6 +5300,9 @@ export interface ListTagsForResourceResponse { } export namespace ListTagsForResourceResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListTagsForResourceResponse): any => ({ ...obj, }); @@ -4741,6 +5329,9 @@ export interface ResetDeploymentsRequest { } export namespace ResetDeploymentsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ResetDeploymentsRequest): any => ({ ...obj, }); @@ -4759,6 +5350,9 @@ export interface ResetDeploymentsResponse { } export namespace ResetDeploymentsResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ResetDeploymentsResponse): any => ({ ...obj, }); @@ -4787,6 +5381,9 @@ export interface StartBulkDeploymentRequest { } export namespace StartBulkDeploymentRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: StartBulkDeploymentRequest): any => ({ ...obj, }); @@ -4805,6 +5402,9 @@ export interface StartBulkDeploymentResponse { } export namespace StartBulkDeploymentResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: StartBulkDeploymentResponse): any => ({ ...obj, }); @@ -4818,6 +5418,9 @@ export interface StopBulkDeploymentRequest { } export namespace StopBulkDeploymentRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: StopBulkDeploymentRequest): any => ({ ...obj, }); @@ -4826,6 +5429,9 @@ export namespace StopBulkDeploymentRequest { export interface StopBulkDeploymentResponse {} export namespace StopBulkDeploymentResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: StopBulkDeploymentResponse): any => ({ ...obj, }); @@ -4847,6 +5453,9 @@ export interface TagResourceRequest { } export namespace TagResourceRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: TagResourceRequest): any => ({ ...obj, }); @@ -4865,6 +5474,9 @@ export interface UntagResourceRequest { } export namespace UntagResourceRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: UntagResourceRequest): any => ({ ...obj, }); @@ -4886,6 +5498,9 @@ export interface UpdateConnectivityInfoRequest { } export namespace UpdateConnectivityInfoRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateConnectivityInfoRequest): any => ({ ...obj, }); @@ -4904,6 +5519,9 @@ export interface UpdateConnectivityInfoResponse { } export namespace UpdateConnectivityInfoResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateConnectivityInfoResponse): any => ({ ...obj, }); @@ -4922,6 +5540,9 @@ export interface UpdateConnectorDefinitionRequest { } export namespace UpdateConnectorDefinitionRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateConnectorDefinitionRequest): any => ({ ...obj, }); @@ -4930,6 +5551,9 @@ export namespace UpdateConnectorDefinitionRequest { export interface UpdateConnectorDefinitionResponse {} export namespace UpdateConnectorDefinitionResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateConnectorDefinitionResponse): any => ({ ...obj, }); @@ -4948,6 +5572,9 @@ export interface UpdateCoreDefinitionRequest { } export namespace UpdateCoreDefinitionRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateCoreDefinitionRequest): any => ({ ...obj, }); @@ -4956,6 +5583,9 @@ export namespace UpdateCoreDefinitionRequest { export interface UpdateCoreDefinitionResponse {} export namespace UpdateCoreDefinitionResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateCoreDefinitionResponse): any => ({ ...obj, }); @@ -4974,6 +5604,9 @@ export interface UpdateDeviceDefinitionRequest { } export namespace UpdateDeviceDefinitionRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateDeviceDefinitionRequest): any => ({ ...obj, }); @@ -4982,6 +5615,9 @@ export namespace UpdateDeviceDefinitionRequest { export interface UpdateDeviceDefinitionResponse {} export namespace UpdateDeviceDefinitionResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateDeviceDefinitionResponse): any => ({ ...obj, }); @@ -5000,6 +5636,9 @@ export interface UpdateFunctionDefinitionRequest { } export namespace UpdateFunctionDefinitionRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateFunctionDefinitionRequest): any => ({ ...obj, }); @@ -5008,6 +5647,9 @@ export namespace UpdateFunctionDefinitionRequest { export interface UpdateFunctionDefinitionResponse {} export namespace UpdateFunctionDefinitionResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateFunctionDefinitionResponse): any => ({ ...obj, }); @@ -5026,6 +5668,9 @@ export interface UpdateGroupRequest { } export namespace UpdateGroupRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateGroupRequest): any => ({ ...obj, }); @@ -5034,6 +5679,9 @@ export namespace UpdateGroupRequest { export interface UpdateGroupResponse {} export namespace UpdateGroupResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateGroupResponse): any => ({ ...obj, }); @@ -5052,6 +5700,9 @@ export interface UpdateGroupCertificateConfigurationRequest { } export namespace UpdateGroupCertificateConfigurationRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateGroupCertificateConfigurationRequest): any => ({ ...obj, }); @@ -5075,6 +5726,9 @@ export interface UpdateGroupCertificateConfigurationResponse { } export namespace UpdateGroupCertificateConfigurationResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateGroupCertificateConfigurationResponse): any => ({ ...obj, }); @@ -5093,6 +5747,9 @@ export interface UpdateLoggerDefinitionRequest { } export namespace UpdateLoggerDefinitionRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateLoggerDefinitionRequest): any => ({ ...obj, }); @@ -5101,6 +5758,9 @@ export namespace UpdateLoggerDefinitionRequest { export interface UpdateLoggerDefinitionResponse {} export namespace UpdateLoggerDefinitionResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateLoggerDefinitionResponse): any => ({ ...obj, }); @@ -5119,6 +5779,9 @@ export interface UpdateResourceDefinitionRequest { } export namespace UpdateResourceDefinitionRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateResourceDefinitionRequest): any => ({ ...obj, }); @@ -5127,6 +5790,9 @@ export namespace UpdateResourceDefinitionRequest { export interface UpdateResourceDefinitionResponse {} export namespace UpdateResourceDefinitionResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateResourceDefinitionResponse): any => ({ ...obj, }); @@ -5145,6 +5811,9 @@ export interface UpdateSubscriptionDefinitionRequest { } export namespace UpdateSubscriptionDefinitionRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateSubscriptionDefinitionRequest): any => ({ ...obj, }); @@ -5153,6 +5822,9 @@ export namespace UpdateSubscriptionDefinitionRequest { export interface UpdateSubscriptionDefinitionResponse {} export namespace UpdateSubscriptionDefinitionResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateSubscriptionDefinitionResponse): any => ({ ...obj, }); @@ -5169,6 +5841,9 @@ export interface TelemetryConfigurationUpdate { } export namespace TelemetryConfigurationUpdate { + /** + * @internal + */ export const filterSensitiveLog = (obj: TelemetryConfigurationUpdate): any => ({ ...obj, }); @@ -5187,6 +5862,9 @@ export interface UpdateThingRuntimeConfigurationRequest { } export namespace UpdateThingRuntimeConfigurationRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateThingRuntimeConfigurationRequest): any => ({ ...obj, }); @@ -5195,6 +5873,9 @@ export namespace UpdateThingRuntimeConfigurationRequest { export interface UpdateThingRuntimeConfigurationResponse {} export namespace UpdateThingRuntimeConfigurationResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateThingRuntimeConfigurationResponse): any => ({ ...obj, }); diff --git a/clients/client-greengrassv2/commands/CancelDeploymentCommand.ts b/clients/client-greengrassv2/commands/CancelDeploymentCommand.ts index c81f60273e8c..8473cfaced15 100644 --- a/clients/client-greengrassv2/commands/CancelDeploymentCommand.ts +++ b/clients/client-greengrassv2/commands/CancelDeploymentCommand.ts @@ -24,6 +24,20 @@ export interface CancelDeploymentCommandOutput extends CancelDeploymentResponse, *

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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { GreengrassV2Client, CancelDeploymentCommand } from "@aws-sdk/client-greengrassv2"; // ES Modules import + * // const { GreengrassV2Client, CancelDeploymentCommand } = require("@aws-sdk/client-greengrassv2"); // CommonJS import + * const client = new GreengrassV2Client(config); + * const command = new CancelDeploymentCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CancelDeploymentCommandInput} for command's `input` shape. + * @see {@link CancelDeploymentCommandOutput} for command's `response` shape. + * @see {@link GreengrassV2ClientResolvedConfig | config} for command's `input` shape. + * */ export class CancelDeploymentCommand extends $Command< CancelDeploymentCommandInput, diff --git a/clients/client-greengrassv2/commands/CreateComponentVersionCommand.ts b/clients/client-greengrassv2/commands/CreateComponentVersionCommand.ts index 8aaaa357be42..a7abdae6b880 100644 --- a/clients/client-greengrassv2/commands/CreateComponentVersionCommand.ts +++ b/clients/client-greengrassv2/commands/CreateComponentVersionCommand.ts @@ -75,6 +75,20 @@ export interface CreateComponentVersionCommandOutput extends CreateComponentVers * when you call this operation.

* * + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { GreengrassV2Client, CreateComponentVersionCommand } from "@aws-sdk/client-greengrassv2"; // ES Modules import + * // const { GreengrassV2Client, CreateComponentVersionCommand } = require("@aws-sdk/client-greengrassv2"); // CommonJS import + * const client = new GreengrassV2Client(config); + * const command = new CreateComponentVersionCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreateComponentVersionCommandInput} for command's `input` shape. + * @see {@link CreateComponentVersionCommandOutput} for command's `response` shape. + * @see {@link GreengrassV2ClientResolvedConfig | config} for command's `input` shape. + * */ export class CreateComponentVersionCommand extends $Command< CreateComponentVersionCommandInput, diff --git a/clients/client-greengrassv2/commands/CreateDeploymentCommand.ts b/clients/client-greengrassv2/commands/CreateDeploymentCommand.ts index 233cfabef01c..0fbfe3dcd6f7 100644 --- a/clients/client-greengrassv2/commands/CreateDeploymentCommand.ts +++ b/clients/client-greengrassv2/commands/CreateDeploymentCommand.ts @@ -32,6 +32,20 @@ export interface CreateDeploymentCommandOutput extends CreateDeploymentResponse, * This operation returns the revision number of the new deployment when you create it.

*

For more information, see the Create deployments in the * AWS IoT Greengrass V2 Developer Guide.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { GreengrassV2Client, CreateDeploymentCommand } from "@aws-sdk/client-greengrassv2"; // ES Modules import + * // const { GreengrassV2Client, CreateDeploymentCommand } = require("@aws-sdk/client-greengrassv2"); // CommonJS import + * const client = new GreengrassV2Client(config); + * const command = new CreateDeploymentCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreateDeploymentCommandInput} for command's `input` shape. + * @see {@link CreateDeploymentCommandOutput} for command's `response` shape. + * @see {@link GreengrassV2ClientResolvedConfig | config} for command's `input` shape. + * */ export class CreateDeploymentCommand extends $Command< CreateDeploymentCommandInput, diff --git a/clients/client-greengrassv2/commands/DeleteComponentCommand.ts b/clients/client-greengrassv2/commands/DeleteComponentCommand.ts index 84619b884168..b3a0818ef67e 100644 --- a/clients/client-greengrassv2/commands/DeleteComponentCommand.ts +++ b/clients/client-greengrassv2/commands/DeleteComponentCommand.ts @@ -28,6 +28,20 @@ export interface DeleteComponentCommandOutput extends __MetadataBearer {} * component version, you can remove the component from the deployment or update the deployment * to use a valid version.

* + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { GreengrassV2Client, DeleteComponentCommand } from "@aws-sdk/client-greengrassv2"; // ES Modules import + * // const { GreengrassV2Client, DeleteComponentCommand } = require("@aws-sdk/client-greengrassv2"); // CommonJS import + * const client = new GreengrassV2Client(config); + * const command = new DeleteComponentCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteComponentCommandInput} for command's `input` shape. + * @see {@link DeleteComponentCommandOutput} for command's `response` shape. + * @see {@link GreengrassV2ClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteComponentCommand extends $Command< DeleteComponentCommandInput, diff --git a/clients/client-greengrassv2/commands/DeleteCoreDeviceCommand.ts b/clients/client-greengrassv2/commands/DeleteCoreDeviceCommand.ts index dcf128f6e274..d3efcc9743af 100644 --- a/clients/client-greengrassv2/commands/DeleteCoreDeviceCommand.ts +++ b/clients/client-greengrassv2/commands/DeleteCoreDeviceCommand.ts @@ -25,6 +25,20 @@ export interface DeleteCoreDeviceCommandOutput extends __MetadataBearer {} * device from the list of core devices. This operation doesn't delete the AWS IoT thing. For more * information about how to delete the AWS IoT thing, see DeleteThing in the * AWS IoT API Reference.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { GreengrassV2Client, DeleteCoreDeviceCommand } from "@aws-sdk/client-greengrassv2"; // ES Modules import + * // const { GreengrassV2Client, DeleteCoreDeviceCommand } = require("@aws-sdk/client-greengrassv2"); // CommonJS import + * const client = new GreengrassV2Client(config); + * const command = new DeleteCoreDeviceCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteCoreDeviceCommandInput} for command's `input` shape. + * @see {@link DeleteCoreDeviceCommandOutput} for command's `response` shape. + * @see {@link GreengrassV2ClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteCoreDeviceCommand extends $Command< DeleteCoreDeviceCommandInput, diff --git a/clients/client-greengrassv2/commands/DescribeComponentCommand.ts b/clients/client-greengrassv2/commands/DescribeComponentCommand.ts index c06fbfb0c2f6..5bfaf46fbb92 100644 --- a/clients/client-greengrassv2/commands/DescribeComponentCommand.ts +++ b/clients/client-greengrassv2/commands/DescribeComponentCommand.ts @@ -22,6 +22,20 @@ export interface DescribeComponentCommandOutput extends DescribeComponentRespons /** *

Retrieves metadata for a version of a component.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { GreengrassV2Client, DescribeComponentCommand } from "@aws-sdk/client-greengrassv2"; // ES Modules import + * // const { GreengrassV2Client, DescribeComponentCommand } = require("@aws-sdk/client-greengrassv2"); // CommonJS import + * const client = new GreengrassV2Client(config); + * const command = new DescribeComponentCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeComponentCommandInput} for command's `input` shape. + * @see {@link DescribeComponentCommandOutput} for command's `response` shape. + * @see {@link GreengrassV2ClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeComponentCommand extends $Command< DescribeComponentCommandInput, diff --git a/clients/client-greengrassv2/commands/GetComponentCommand.ts b/clients/client-greengrassv2/commands/GetComponentCommand.ts index e3f5748aaa48..8000d0647906 100644 --- a/clients/client-greengrassv2/commands/GetComponentCommand.ts +++ b/clients/client-greengrassv2/commands/GetComponentCommand.ts @@ -23,6 +23,20 @@ export interface GetComponentCommandOutput extends GetComponentResponse, __Metad /** *

Gets the recipe for a version of a component. Core devices can call this operation to * identify the artifacts and requirements to install a component.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { GreengrassV2Client, GetComponentCommand } from "@aws-sdk/client-greengrassv2"; // ES Modules import + * // const { GreengrassV2Client, GetComponentCommand } = require("@aws-sdk/client-greengrassv2"); // CommonJS import + * const client = new GreengrassV2Client(config); + * const command = new GetComponentCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetComponentCommandInput} for command's `input` shape. + * @see {@link GetComponentCommandOutput} for command's `response` shape. + * @see {@link GreengrassV2ClientResolvedConfig | config} for command's `input` shape. + * */ export class GetComponentCommand extends $Command< GetComponentCommandInput, diff --git a/clients/client-greengrassv2/commands/GetComponentVersionArtifactCommand.ts b/clients/client-greengrassv2/commands/GetComponentVersionArtifactCommand.ts index 1005053fd418..eaa25f235586 100644 --- a/clients/client-greengrassv2/commands/GetComponentVersionArtifactCommand.ts +++ b/clients/client-greengrassv2/commands/GetComponentVersionArtifactCommand.ts @@ -25,6 +25,20 @@ export interface GetComponentVersionArtifactCommandOutput /** *

Gets the pre-signed URL to download a public component artifact. Core devices call this * operation to identify the URL that they can use to download an artifact to install.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { GreengrassV2Client, GetComponentVersionArtifactCommand } from "@aws-sdk/client-greengrassv2"; // ES Modules import + * // const { GreengrassV2Client, GetComponentVersionArtifactCommand } = require("@aws-sdk/client-greengrassv2"); // CommonJS import + * const client = new GreengrassV2Client(config); + * const command = new GetComponentVersionArtifactCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetComponentVersionArtifactCommandInput} for command's `input` shape. + * @see {@link GetComponentVersionArtifactCommandOutput} for command's `response` shape. + * @see {@link GreengrassV2ClientResolvedConfig | config} for command's `input` shape. + * */ export class GetComponentVersionArtifactCommand extends $Command< GetComponentVersionArtifactCommandInput, diff --git a/clients/client-greengrassv2/commands/GetCoreDeviceCommand.ts b/clients/client-greengrassv2/commands/GetCoreDeviceCommand.ts index 7f4b41e9c4c2..21ef2d721a11 100644 --- a/clients/client-greengrassv2/commands/GetCoreDeviceCommand.ts +++ b/clients/client-greengrassv2/commands/GetCoreDeviceCommand.ts @@ -22,6 +22,20 @@ export interface GetCoreDeviceCommandOutput extends GetCoreDeviceResponse, __Met /** *

Retrieves metadata for a AWS IoT Greengrass core device.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { GreengrassV2Client, GetCoreDeviceCommand } from "@aws-sdk/client-greengrassv2"; // ES Modules import + * // const { GreengrassV2Client, GetCoreDeviceCommand } = require("@aws-sdk/client-greengrassv2"); // CommonJS import + * const client = new GreengrassV2Client(config); + * const command = new GetCoreDeviceCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetCoreDeviceCommandInput} for command's `input` shape. + * @see {@link GetCoreDeviceCommandOutput} for command's `response` shape. + * @see {@link GreengrassV2ClientResolvedConfig | config} for command's `input` shape. + * */ export class GetCoreDeviceCommand extends $Command< GetCoreDeviceCommandInput, diff --git a/clients/client-greengrassv2/commands/GetDeploymentCommand.ts b/clients/client-greengrassv2/commands/GetDeploymentCommand.ts index 0c41f8eb6873..447016e61e20 100644 --- a/clients/client-greengrassv2/commands/GetDeploymentCommand.ts +++ b/clients/client-greengrassv2/commands/GetDeploymentCommand.ts @@ -22,6 +22,20 @@ export interface GetDeploymentCommandOutput extends GetDeploymentResponse, __Met /** *

Gets a deployment. Deployments define the components that run on AWS IoT Greengrass core devices.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { GreengrassV2Client, GetDeploymentCommand } from "@aws-sdk/client-greengrassv2"; // ES Modules import + * // const { GreengrassV2Client, GetDeploymentCommand } = require("@aws-sdk/client-greengrassv2"); // CommonJS import + * const client = new GreengrassV2Client(config); + * const command = new GetDeploymentCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetDeploymentCommandInput} for command's `input` shape. + * @see {@link GetDeploymentCommandOutput} for command's `response` shape. + * @see {@link GreengrassV2ClientResolvedConfig | config} for command's `input` shape. + * */ export class GetDeploymentCommand extends $Command< GetDeploymentCommandInput, diff --git a/clients/client-greengrassv2/commands/ListComponentVersionsCommand.ts b/clients/client-greengrassv2/commands/ListComponentVersionsCommand.ts index 30b065baf2d0..1a766db4719f 100644 --- a/clients/client-greengrassv2/commands/ListComponentVersionsCommand.ts +++ b/clients/client-greengrassv2/commands/ListComponentVersionsCommand.ts @@ -22,6 +22,20 @@ export interface ListComponentVersionsCommandOutput extends ListComponentVersion /** *

Retrieves a paginated list of all versions for a component.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { GreengrassV2Client, ListComponentVersionsCommand } from "@aws-sdk/client-greengrassv2"; // ES Modules import + * // const { GreengrassV2Client, ListComponentVersionsCommand } = require("@aws-sdk/client-greengrassv2"); // CommonJS import + * const client = new GreengrassV2Client(config); + * const command = new ListComponentVersionsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListComponentVersionsCommandInput} for command's `input` shape. + * @see {@link ListComponentVersionsCommandOutput} for command's `response` shape. + * @see {@link GreengrassV2ClientResolvedConfig | config} for command's `input` shape. + * */ export class ListComponentVersionsCommand extends $Command< ListComponentVersionsCommandInput, diff --git a/clients/client-greengrassv2/commands/ListComponentsCommand.ts b/clients/client-greengrassv2/commands/ListComponentsCommand.ts index 074cd1df41cf..50ae207e7ec3 100644 --- a/clients/client-greengrassv2/commands/ListComponentsCommand.ts +++ b/clients/client-greengrassv2/commands/ListComponentsCommand.ts @@ -23,6 +23,20 @@ export interface ListComponentsCommandOutput extends ListComponentsResponse, __M /** *

Retrieves a paginated list of component summaries. This list includes components that you * have permission to view.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { GreengrassV2Client, ListComponentsCommand } from "@aws-sdk/client-greengrassv2"; // ES Modules import + * // const { GreengrassV2Client, ListComponentsCommand } = require("@aws-sdk/client-greengrassv2"); // CommonJS import + * const client = new GreengrassV2Client(config); + * const command = new ListComponentsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListComponentsCommandInput} for command's `input` shape. + * @see {@link ListComponentsCommandOutput} for command's `response` shape. + * @see {@link GreengrassV2ClientResolvedConfig | config} for command's `input` shape. + * */ export class ListComponentsCommand extends $Command< ListComponentsCommandInput, diff --git a/clients/client-greengrassv2/commands/ListCoreDevicesCommand.ts b/clients/client-greengrassv2/commands/ListCoreDevicesCommand.ts index 970734438d1e..ee4114bcf06c 100644 --- a/clients/client-greengrassv2/commands/ListCoreDevicesCommand.ts +++ b/clients/client-greengrassv2/commands/ListCoreDevicesCommand.ts @@ -22,6 +22,20 @@ export interface ListCoreDevicesCommandOutput extends ListCoreDevicesResponse, _ /** *

Retrieves a paginated list of AWS IoT Greengrass core devices.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { GreengrassV2Client, ListCoreDevicesCommand } from "@aws-sdk/client-greengrassv2"; // ES Modules import + * // const { GreengrassV2Client, ListCoreDevicesCommand } = require("@aws-sdk/client-greengrassv2"); // CommonJS import + * const client = new GreengrassV2Client(config); + * const command = new ListCoreDevicesCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListCoreDevicesCommandInput} for command's `input` shape. + * @see {@link ListCoreDevicesCommandOutput} for command's `response` shape. + * @see {@link GreengrassV2ClientResolvedConfig | config} for command's `input` shape. + * */ export class ListCoreDevicesCommand extends $Command< ListCoreDevicesCommandInput, diff --git a/clients/client-greengrassv2/commands/ListDeploymentsCommand.ts b/clients/client-greengrassv2/commands/ListDeploymentsCommand.ts index 4594bf42955f..925900ce17b3 100644 --- a/clients/client-greengrassv2/commands/ListDeploymentsCommand.ts +++ b/clients/client-greengrassv2/commands/ListDeploymentsCommand.ts @@ -22,6 +22,20 @@ export interface ListDeploymentsCommandOutput extends ListDeploymentsResponse, _ /** *

Retrieves a paginated list of deployments.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { GreengrassV2Client, ListDeploymentsCommand } from "@aws-sdk/client-greengrassv2"; // ES Modules import + * // const { GreengrassV2Client, ListDeploymentsCommand } = require("@aws-sdk/client-greengrassv2"); // CommonJS import + * const client = new GreengrassV2Client(config); + * const command = new ListDeploymentsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListDeploymentsCommandInput} for command's `input` shape. + * @see {@link ListDeploymentsCommandOutput} for command's `response` shape. + * @see {@link GreengrassV2ClientResolvedConfig | config} for command's `input` shape. + * */ export class ListDeploymentsCommand extends $Command< ListDeploymentsCommandInput, diff --git a/clients/client-greengrassv2/commands/ListEffectiveDeploymentsCommand.ts b/clients/client-greengrassv2/commands/ListEffectiveDeploymentsCommand.ts index 2561d1f5791e..e784a4f50820 100644 --- a/clients/client-greengrassv2/commands/ListEffectiveDeploymentsCommand.ts +++ b/clients/client-greengrassv2/commands/ListEffectiveDeploymentsCommand.ts @@ -23,6 +23,20 @@ export interface ListEffectiveDeploymentsCommandOutput extends ListEffectiveDepl /** *

Retrieves a paginated list of deployment jobs that AWS IoT Greengrass sends to AWS IoT Greengrass core * devices.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { GreengrassV2Client, ListEffectiveDeploymentsCommand } from "@aws-sdk/client-greengrassv2"; // ES Modules import + * // const { GreengrassV2Client, ListEffectiveDeploymentsCommand } = require("@aws-sdk/client-greengrassv2"); // CommonJS import + * const client = new GreengrassV2Client(config); + * const command = new ListEffectiveDeploymentsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListEffectiveDeploymentsCommandInput} for command's `input` shape. + * @see {@link ListEffectiveDeploymentsCommandOutput} for command's `response` shape. + * @see {@link GreengrassV2ClientResolvedConfig | config} for command's `input` shape. + * */ export class ListEffectiveDeploymentsCommand extends $Command< ListEffectiveDeploymentsCommandInput, diff --git a/clients/client-greengrassv2/commands/ListInstalledComponentsCommand.ts b/clients/client-greengrassv2/commands/ListInstalledComponentsCommand.ts index 68f192b74c8a..17ade524a7b6 100644 --- a/clients/client-greengrassv2/commands/ListInstalledComponentsCommand.ts +++ b/clients/client-greengrassv2/commands/ListInstalledComponentsCommand.ts @@ -22,6 +22,20 @@ export interface ListInstalledComponentsCommandOutput extends ListInstalledCompo /** *

Retrieves a paginated list of the components that a AWS IoT Greengrass core device runs.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { GreengrassV2Client, ListInstalledComponentsCommand } from "@aws-sdk/client-greengrassv2"; // ES Modules import + * // const { GreengrassV2Client, ListInstalledComponentsCommand } = require("@aws-sdk/client-greengrassv2"); // CommonJS import + * const client = new GreengrassV2Client(config); + * const command = new ListInstalledComponentsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListInstalledComponentsCommandInput} for command's `input` shape. + * @see {@link ListInstalledComponentsCommandOutput} for command's `response` shape. + * @see {@link GreengrassV2ClientResolvedConfig | config} for command's `input` shape. + * */ export class ListInstalledComponentsCommand extends $Command< ListInstalledComponentsCommandInput, diff --git a/clients/client-greengrassv2/commands/ListTagsForResourceCommand.ts b/clients/client-greengrassv2/commands/ListTagsForResourceCommand.ts index ed61ccdac9b6..8eea2c302a41 100644 --- a/clients/client-greengrassv2/commands/ListTagsForResourceCommand.ts +++ b/clients/client-greengrassv2/commands/ListTagsForResourceCommand.ts @@ -22,6 +22,20 @@ export interface ListTagsForResourceCommandOutput extends ListTagsForResourceRes /** *

Retrieves the list of tags for an AWS IoT Greengrass resource.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { GreengrassV2Client, ListTagsForResourceCommand } from "@aws-sdk/client-greengrassv2"; // ES Modules import + * // const { GreengrassV2Client, ListTagsForResourceCommand } = require("@aws-sdk/client-greengrassv2"); // CommonJS import + * const client = new GreengrassV2Client(config); + * const command = new ListTagsForResourceCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListTagsForResourceCommandInput} for command's `input` shape. + * @see {@link ListTagsForResourceCommandOutput} for command's `response` shape. + * @see {@link GreengrassV2ClientResolvedConfig | config} for command's `input` shape. + * */ export class ListTagsForResourceCommand extends $Command< ListTagsForResourceCommandInput, diff --git a/clients/client-greengrassv2/commands/ResolveComponentCandidatesCommand.ts b/clients/client-greengrassv2/commands/ResolveComponentCandidatesCommand.ts index 7cebbe854961..734a2604508a 100644 --- a/clients/client-greengrassv2/commands/ResolveComponentCandidatesCommand.ts +++ b/clients/client-greengrassv2/commands/ResolveComponentCandidatesCommand.ts @@ -36,6 +36,20 @@ export interface ResolveComponentCandidatesCommandOutput extends ResolveComponen *

To use this operation, you must use the data plane API endpoint and authenticate with an * AWS IoT device certificate. For more information, see AWS IoT Greengrass endpoints and quotas.

* + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { GreengrassV2Client, ResolveComponentCandidatesCommand } from "@aws-sdk/client-greengrassv2"; // ES Modules import + * // const { GreengrassV2Client, ResolveComponentCandidatesCommand } = require("@aws-sdk/client-greengrassv2"); // CommonJS import + * const client = new GreengrassV2Client(config); + * const command = new ResolveComponentCandidatesCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ResolveComponentCandidatesCommandInput} for command's `input` shape. + * @see {@link ResolveComponentCandidatesCommandOutput} for command's `response` shape. + * @see {@link GreengrassV2ClientResolvedConfig | config} for command's `input` shape. + * */ export class ResolveComponentCandidatesCommand extends $Command< ResolveComponentCandidatesCommandInput, diff --git a/clients/client-greengrassv2/commands/TagResourceCommand.ts b/clients/client-greengrassv2/commands/TagResourceCommand.ts index f25cbea5473f..f8e2fa44b284 100644 --- a/clients/client-greengrassv2/commands/TagResourceCommand.ts +++ b/clients/client-greengrassv2/commands/TagResourceCommand.ts @@ -23,6 +23,20 @@ export interface TagResourceCommandOutput extends TagResourceResponse, __Metadat /** *

Adds tags to an AWS IoT Greengrass resource. If a tag already exists for the resource, this operation * updates the tag's value.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { GreengrassV2Client, TagResourceCommand } from "@aws-sdk/client-greengrassv2"; // ES Modules import + * // const { GreengrassV2Client, TagResourceCommand } = require("@aws-sdk/client-greengrassv2"); // CommonJS import + * const client = new GreengrassV2Client(config); + * const command = new TagResourceCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link TagResourceCommandInput} for command's `input` shape. + * @see {@link TagResourceCommandOutput} for command's `response` shape. + * @see {@link GreengrassV2ClientResolvedConfig | config} for command's `input` shape. + * */ export class TagResourceCommand extends $Command< TagResourceCommandInput, diff --git a/clients/client-greengrassv2/commands/UntagResourceCommand.ts b/clients/client-greengrassv2/commands/UntagResourceCommand.ts index 2cf4242812d6..4c2907c610b1 100644 --- a/clients/client-greengrassv2/commands/UntagResourceCommand.ts +++ b/clients/client-greengrassv2/commands/UntagResourceCommand.ts @@ -22,6 +22,20 @@ export interface UntagResourceCommandOutput extends UntagResourceResponse, __Met /** *

Removes a tag from an AWS IoT Greengrass resource.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { GreengrassV2Client, UntagResourceCommand } from "@aws-sdk/client-greengrassv2"; // ES Modules import + * // const { GreengrassV2Client, UntagResourceCommand } = require("@aws-sdk/client-greengrassv2"); // CommonJS import + * const client = new GreengrassV2Client(config); + * const command = new UntagResourceCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link UntagResourceCommandInput} for command's `input` shape. + * @see {@link UntagResourceCommandOutput} for command's `response` shape. + * @see {@link GreengrassV2ClientResolvedConfig | config} for command's `input` shape. + * */ export class UntagResourceCommand extends $Command< UntagResourceCommandInput, diff --git a/clients/client-greengrassv2/models/models_0.ts b/clients/client-greengrassv2/models/models_0.ts index 97b2f3869242..cc91e731d934 100644 --- a/clients/client-greengrassv2/models/models_0.ts +++ b/clients/client-greengrassv2/models/models_0.ts @@ -11,6 +11,9 @@ export interface AccessDeniedException extends __SmithyException, $MetadataBeare } export namespace AccessDeniedException { + /** + * @internal + */ export const filterSensitiveLog = (obj: AccessDeniedException): any => ({ ...obj, }); @@ -24,6 +27,9 @@ export interface CancelDeploymentRequest { } export namespace CancelDeploymentRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: CancelDeploymentRequest): any => ({ ...obj, }); @@ -37,6 +43,9 @@ export interface CancelDeploymentResponse { } export namespace CancelDeploymentResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: CancelDeploymentResponse): any => ({ ...obj, }); @@ -62,6 +71,9 @@ export interface ConflictException extends __SmithyException, $MetadataBearer { } export namespace ConflictException { + /** + * @internal + */ export const filterSensitiveLog = (obj: ConflictException): any => ({ ...obj, }); @@ -81,6 +93,9 @@ export interface InternalServerException extends __SmithyException, $MetadataBea } export namespace InternalServerException { + /** + * @internal + */ export const filterSensitiveLog = (obj: InternalServerException): any => ({ ...obj, }); @@ -105,6 +120,9 @@ export interface ResourceNotFoundException extends __SmithyException, $MetadataB } export namespace ResourceNotFoundException { + /** + * @internal + */ export const filterSensitiveLog = (obj: ResourceNotFoundException): any => ({ ...obj, }); @@ -135,6 +153,9 @@ export interface ThrottlingException extends __SmithyException, $MetadataBearer } export namespace ThrottlingException { + /** + * @internal + */ export const filterSensitiveLog = (obj: ThrottlingException): any => ({ ...obj, }); @@ -156,6 +177,9 @@ export interface ValidationExceptionField { } export namespace ValidationExceptionField { + /** + * @internal + */ export const filterSensitiveLog = (obj: ValidationExceptionField): any => ({ ...obj, }); @@ -188,6 +212,9 @@ export interface ValidationException extends __SmithyException, $MetadataBearer } export namespace ValidationException { + /** + * @internal + */ export const filterSensitiveLog = (obj: ValidationException): any => ({ ...obj, }); @@ -224,6 +251,9 @@ export interface CloudComponentStatus { } export namespace CloudComponentStatus { + /** + * @internal + */ export const filterSensitiveLog = (obj: CloudComponentStatus): any => ({ ...obj, }); @@ -251,6 +281,9 @@ export interface ComponentPlatform { } export namespace ComponentPlatform { + /** + * @internal + */ export const filterSensitiveLog = (obj: ComponentPlatform): any => ({ ...obj, }); @@ -292,6 +325,9 @@ export interface ComponentLatestVersion { } export namespace ComponentLatestVersion { + /** + * @internal + */ export const filterSensitiveLog = (obj: ComponentLatestVersion): any => ({ ...obj, }); @@ -318,6 +354,9 @@ export interface Component { } export namespace Component { + /** + * @internal + */ export const filterSensitiveLog = (obj: Component): any => ({ ...obj, }); @@ -347,6 +386,9 @@ export interface ComponentCandidate { } export namespace ComponentCandidate { + /** + * @internal + */ export const filterSensitiveLog = (obj: ComponentCandidate): any => ({ ...obj, }); @@ -381,6 +423,9 @@ export interface ComponentConfigurationUpdate { } export namespace ComponentConfigurationUpdate { + /** + * @internal + */ export const filterSensitiveLog = (obj: ComponentConfigurationUpdate): any => ({ ...obj, }); @@ -422,6 +467,9 @@ export interface ComponentDependencyRequirement { } export namespace ComponentDependencyRequirement { + /** + * @internal + */ export const filterSensitiveLog = (obj: ComponentDependencyRequirement): any => ({ ...obj, }); @@ -443,6 +491,9 @@ export interface ComponentRunWith { } export namespace ComponentRunWith { + /** + * @internal + */ export const filterSensitiveLog = (obj: ComponentRunWith): any => ({ ...obj, }); @@ -478,6 +529,9 @@ export interface ComponentDeploymentSpecification { } export namespace ComponentDeploymentSpecification { + /** + * @internal + */ export const filterSensitiveLog = (obj: ComponentDeploymentSpecification): any => ({ ...obj, }); @@ -504,6 +558,9 @@ export interface ComponentVersionListItem { } export namespace ComponentVersionListItem { + /** + * @internal + */ export const filterSensitiveLog = (obj: ComponentVersionListItem): any => ({ ...obj, }); @@ -553,6 +610,9 @@ export interface CoreDevice { } export namespace CoreDevice { + /** + * @internal + */ export const filterSensitiveLog = (obj: CoreDevice): any => ({ ...obj, }); @@ -595,6 +655,9 @@ export interface LambdaEventSource { } export namespace LambdaEventSource { + /** + * @internal + */ export const filterSensitiveLog = (obj: LambdaEventSource): any => ({ ...obj, }); @@ -636,6 +699,9 @@ export interface LambdaDeviceMount { } export namespace LambdaDeviceMount { + /** + * @internal + */ export const filterSensitiveLog = (obj: LambdaDeviceMount): any => ({ ...obj, }); @@ -674,6 +740,9 @@ export interface LambdaVolumeMount { } export namespace LambdaVolumeMount { + /** + * @internal + */ export const filterSensitiveLog = (obj: LambdaVolumeMount): any => ({ ...obj, }); @@ -710,6 +779,9 @@ export interface LambdaContainerParams { } export namespace LambdaContainerParams { + /** + * @internal + */ export const filterSensitiveLog = (obj: LambdaContainerParams): any => ({ ...obj, }); @@ -740,6 +812,9 @@ export interface LambdaLinuxProcessParams { } export namespace LambdaLinuxProcessParams { + /** + * @internal + */ export const filterSensitiveLog = (obj: LambdaLinuxProcessParams): any => ({ ...obj, }); @@ -829,6 +904,9 @@ export interface LambdaExecutionParameters { } export namespace LambdaExecutionParameters { + /** + * @internal + */ export const filterSensitiveLog = (obj: LambdaExecutionParameters): any => ({ ...obj, }); @@ -875,6 +953,9 @@ export interface LambdaFunctionRecipeSource { } export namespace LambdaFunctionRecipeSource { + /** + * @internal + */ export const filterSensitiveLog = (obj: LambdaFunctionRecipeSource): any => ({ ...obj, }); @@ -903,6 +984,9 @@ export interface CreateComponentVersionRequest { } export namespace CreateComponentVersionRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateComponentVersionRequest): any => ({ ...obj, }); @@ -937,6 +1021,9 @@ export interface CreateComponentVersionResponse { } export namespace CreateComponentVersionResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateComponentVersionResponse): any => ({ ...obj, }); @@ -972,6 +1059,9 @@ export interface ServiceQuotaExceededException extends __SmithyException, $Metad } export namespace ServiceQuotaExceededException { + /** + * @internal + */ export const filterSensitiveLog = (obj: ServiceQuotaExceededException): any => ({ ...obj, }); @@ -1024,6 +1114,9 @@ export interface DeploymentComponentUpdatePolicy { } export namespace DeploymentComponentUpdatePolicy { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeploymentComponentUpdatePolicy): any => ({ ...obj, }); @@ -1045,6 +1138,9 @@ export interface DeploymentConfigurationValidationPolicy { } export namespace DeploymentConfigurationValidationPolicy { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeploymentConfigurationValidationPolicy): any => ({ ...obj, }); @@ -1082,6 +1178,9 @@ export interface DeploymentPolicies { } export namespace DeploymentPolicies { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeploymentPolicies): any => ({ ...obj, }); @@ -1139,6 +1238,9 @@ export interface IoTJobAbortCriteria { } export namespace IoTJobAbortCriteria { + /** + * @internal + */ export const filterSensitiveLog = (obj: IoTJobAbortCriteria): any => ({ ...obj, }); @@ -1156,6 +1258,9 @@ export interface IoTJobAbortConfig { } export namespace IoTJobAbortConfig { + /** + * @internal + */ export const filterSensitiveLog = (obj: IoTJobAbortConfig): any => ({ ...obj, }); @@ -1181,6 +1286,9 @@ export interface IoTJobRateIncreaseCriteria { } export namespace IoTJobRateIncreaseCriteria { + /** + * @internal + */ export const filterSensitiveLog = (obj: IoTJobRateIncreaseCriteria): any => ({ ...obj, }); @@ -1211,6 +1319,9 @@ export interface IoTJobExponentialRolloutRate { } export namespace IoTJobExponentialRolloutRate { + /** + * @internal + */ export const filterSensitiveLog = (obj: IoTJobExponentialRolloutRate): any => ({ ...obj, }); @@ -1233,6 +1344,9 @@ export interface IoTJobExecutionsRolloutConfig { } export namespace IoTJobExecutionsRolloutConfig { + /** + * @internal + */ export const filterSensitiveLog = (obj: IoTJobExecutionsRolloutConfig): any => ({ ...obj, }); @@ -1253,6 +1367,9 @@ export interface IoTJobTimeoutConfig { } export namespace IoTJobTimeoutConfig { + /** + * @internal + */ export const filterSensitiveLog = (obj: IoTJobTimeoutConfig): any => ({ ...obj, }); @@ -1282,6 +1399,9 @@ export interface DeploymentIoTJobConfiguration { } export namespace DeploymentIoTJobConfiguration { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeploymentIoTJobConfiguration): any => ({ ...obj, }); @@ -1329,6 +1449,9 @@ export interface CreateDeploymentRequest { } export namespace CreateDeploymentRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateDeploymentRequest): any => ({ ...obj, }); @@ -1352,6 +1475,9 @@ export interface CreateDeploymentResponse { } export namespace CreateDeploymentResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateDeploymentResponse): any => ({ ...obj, }); @@ -1365,6 +1491,9 @@ export interface DeleteComponentRequest { } export namespace DeleteComponentRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteComponentRequest): any => ({ ...obj, }); @@ -1378,6 +1507,9 @@ export interface DeleteCoreDeviceRequest { } export namespace DeleteCoreDeviceRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteCoreDeviceRequest): any => ({ ...obj, }); @@ -1436,6 +1568,9 @@ export interface Deployment { } export namespace Deployment { + /** + * @internal + */ export const filterSensitiveLog = (obj: Deployment): any => ({ ...obj, }); @@ -1454,6 +1589,9 @@ export interface DescribeComponentRequest { } export namespace DescribeComponentRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeComponentRequest): any => ({ ...obj, }); @@ -1510,6 +1648,9 @@ export interface DescribeComponentResponse { } export namespace DescribeComponentResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeComponentResponse): any => ({ ...obj, }); @@ -1586,6 +1727,9 @@ export interface EffectiveDeployment { } export namespace EffectiveDeployment { + /** + * @internal + */ export const filterSensitiveLog = (obj: EffectiveDeployment): any => ({ ...obj, }); @@ -1609,6 +1753,9 @@ export interface GetComponentRequest { } export namespace GetComponentRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetComponentRequest): any => ({ ...obj, }); @@ -1634,6 +1781,9 @@ export interface GetComponentResponse { } export namespace GetComponentResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetComponentResponse): any => ({ ...obj, }); @@ -1657,6 +1807,9 @@ export interface GetComponentVersionArtifactRequest { } export namespace GetComponentVersionArtifactRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetComponentVersionArtifactRequest): any => ({ ...obj, }); @@ -1670,6 +1823,9 @@ export interface GetComponentVersionArtifactResponse { } export namespace GetComponentVersionArtifactResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetComponentVersionArtifactResponse): any => ({ ...obj, }); @@ -1683,6 +1839,9 @@ export interface GetCoreDeviceRequest { } export namespace GetCoreDeviceRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetCoreDeviceRequest): any => ({ ...obj, }); @@ -1743,6 +1902,9 @@ export interface GetCoreDeviceResponse { } export namespace GetCoreDeviceResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetCoreDeviceResponse): any => ({ ...obj, }); @@ -1756,6 +1918,9 @@ export interface GetDeploymentRequest { } export namespace GetDeploymentRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetDeploymentRequest): any => ({ ...obj, }); @@ -1838,6 +2003,9 @@ export interface GetDeploymentResponse { } export namespace GetDeploymentResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetDeploymentResponse): any => ({ ...obj, }); @@ -1863,6 +2031,9 @@ export interface ListComponentsRequest { } export namespace ListComponentsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListComponentsRequest): any => ({ ...obj, }); @@ -1881,6 +2052,9 @@ export interface ListComponentsResponse { } export namespace ListComponentsResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListComponentsResponse): any => ({ ...obj, }); @@ -1904,6 +2078,9 @@ export interface ListComponentVersionsRequest { } export namespace ListComponentVersionsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListComponentVersionsRequest): any => ({ ...obj, }); @@ -1922,6 +2099,9 @@ export interface ListComponentVersionsResponse { } export namespace ListComponentVersionsResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListComponentVersionsResponse): any => ({ ...obj, }); @@ -1963,6 +2143,9 @@ export interface ListCoreDevicesRequest { } export namespace ListCoreDevicesRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListCoreDevicesRequest): any => ({ ...obj, }); @@ -1981,6 +2164,9 @@ export interface ListCoreDevicesResponse { } export namespace ListCoreDevicesResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListCoreDevicesResponse): any => ({ ...obj, }); @@ -2022,6 +2208,9 @@ export interface ListDeploymentsRequest { } export namespace ListDeploymentsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListDeploymentsRequest): any => ({ ...obj, }); @@ -2040,6 +2229,9 @@ export interface ListDeploymentsResponse { } export namespace ListDeploymentsResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListDeploymentsResponse): any => ({ ...obj, }); @@ -2063,6 +2255,9 @@ export interface ListEffectiveDeploymentsRequest { } export namespace ListEffectiveDeploymentsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListEffectiveDeploymentsRequest): any => ({ ...obj, }); @@ -2081,6 +2276,9 @@ export interface ListEffectiveDeploymentsResponse { } export namespace ListEffectiveDeploymentsResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListEffectiveDeploymentsResponse): any => ({ ...obj, }); @@ -2104,6 +2302,9 @@ export interface ListInstalledComponentsRequest { } export namespace ListInstalledComponentsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListInstalledComponentsRequest): any => ({ ...obj, }); @@ -2151,6 +2352,9 @@ export interface InstalledComponent { } export namespace InstalledComponent { + /** + * @internal + */ export const filterSensitiveLog = (obj: InstalledComponent): any => ({ ...obj, }); @@ -2169,6 +2373,9 @@ export interface ListInstalledComponentsResponse { } export namespace ListInstalledComponentsResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListInstalledComponentsResponse): any => ({ ...obj, }); @@ -2182,6 +2389,9 @@ export interface ListTagsForResourceRequest { } export namespace ListTagsForResourceRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListTagsForResourceRequest): any => ({ ...obj, }); @@ -2197,6 +2407,9 @@ export interface ListTagsForResourceResponse { } export namespace ListTagsForResourceResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListTagsForResourceResponse): any => ({ ...obj, }); @@ -2215,6 +2428,9 @@ export interface ResolveComponentCandidatesRequest { } export namespace ResolveComponentCandidatesRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ResolveComponentCandidatesRequest): any => ({ ...obj, }); @@ -2247,6 +2463,9 @@ export interface ResolvedComponentVersion { } export namespace ResolvedComponentVersion { + /** + * @internal + */ export const filterSensitiveLog = (obj: ResolvedComponentVersion): any => ({ ...obj, }); @@ -2261,6 +2480,9 @@ export interface ResolveComponentCandidatesResponse { } export namespace ResolveComponentCandidatesResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ResolveComponentCandidatesResponse): any => ({ ...obj, }); @@ -2281,6 +2503,9 @@ export interface TagResourceRequest { } export namespace TagResourceRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: TagResourceRequest): any => ({ ...obj, }); @@ -2289,6 +2514,9 @@ export namespace TagResourceRequest { export interface TagResourceResponse {} export namespace TagResourceResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: TagResourceResponse): any => ({ ...obj, }); @@ -2307,6 +2535,9 @@ export interface UntagResourceRequest { } export namespace UntagResourceRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: UntagResourceRequest): any => ({ ...obj, }); @@ -2315,6 +2546,9 @@ export namespace UntagResourceRequest { export interface UntagResourceResponse {} export namespace UntagResourceResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: UntagResourceResponse): any => ({ ...obj, }); diff --git a/clients/client-groundstation/commands/CancelContactCommand.ts b/clients/client-groundstation/commands/CancelContactCommand.ts index 04f44a81b119..b2d0b012287f 100644 --- a/clients/client-groundstation/commands/CancelContactCommand.ts +++ b/clients/client-groundstation/commands/CancelContactCommand.ts @@ -22,6 +22,20 @@ export interface CancelContactCommandOutput extends ContactIdResponse, __Metadat /** *

Cancels a contact with a specified contact ID.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { GroundStationClient, CancelContactCommand } from "@aws-sdk/client-groundstation"; // ES Modules import + * // const { GroundStationClient, CancelContactCommand } = require("@aws-sdk/client-groundstation"); // CommonJS import + * const client = new GroundStationClient(config); + * const command = new CancelContactCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CancelContactCommandInput} for command's `input` shape. + * @see {@link CancelContactCommandOutput} for command's `response` shape. + * @see {@link GroundStationClientResolvedConfig | config} for command's `input` shape. + * */ export class CancelContactCommand extends $Command< CancelContactCommandInput, diff --git a/clients/client-groundstation/commands/CreateConfigCommand.ts b/clients/client-groundstation/commands/CreateConfigCommand.ts index 66aafd898ec0..7cdc7e1baf0c 100644 --- a/clients/client-groundstation/commands/CreateConfigCommand.ts +++ b/clients/client-groundstation/commands/CreateConfigCommand.ts @@ -23,6 +23,20 @@ export interface CreateConfigCommandOutput extends ConfigIdResponse, __MetadataB /** *

Creates a Config with the specified configData parameters.

*

Only one type of configData can be specified.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { GroundStationClient, CreateConfigCommand } from "@aws-sdk/client-groundstation"; // ES Modules import + * // const { GroundStationClient, CreateConfigCommand } = require("@aws-sdk/client-groundstation"); // CommonJS import + * const client = new GroundStationClient(config); + * const command = new CreateConfigCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreateConfigCommandInput} for command's `input` shape. + * @see {@link CreateConfigCommandOutput} for command's `response` shape. + * @see {@link GroundStationClientResolvedConfig | config} for command's `input` shape. + * */ export class CreateConfigCommand extends $Command< CreateConfigCommandInput, diff --git a/clients/client-groundstation/commands/CreateDataflowEndpointGroupCommand.ts b/clients/client-groundstation/commands/CreateDataflowEndpointGroupCommand.ts index e8dc3b71214a..aa200dcad332 100644 --- a/clients/client-groundstation/commands/CreateDataflowEndpointGroupCommand.ts +++ b/clients/client-groundstation/commands/CreateDataflowEndpointGroupCommand.ts @@ -26,6 +26,20 @@ export interface CreateDataflowEndpointGroupCommandOutput extends DataflowEndpoi * 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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { GroundStationClient, CreateDataflowEndpointGroupCommand } from "@aws-sdk/client-groundstation"; // ES Modules import + * // const { GroundStationClient, CreateDataflowEndpointGroupCommand } = require("@aws-sdk/client-groundstation"); // CommonJS import + * const client = new GroundStationClient(config); + * const command = new CreateDataflowEndpointGroupCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreateDataflowEndpointGroupCommandInput} for command's `input` shape. + * @see {@link CreateDataflowEndpointGroupCommandOutput} for command's `response` shape. + * @see {@link GroundStationClientResolvedConfig | config} for command's `input` shape. + * */ export class CreateDataflowEndpointGroupCommand extends $Command< CreateDataflowEndpointGroupCommandInput, diff --git a/clients/client-groundstation/commands/CreateMissionProfileCommand.ts b/clients/client-groundstation/commands/CreateMissionProfileCommand.ts index 30937066d1f8..ee707618fa8a 100644 --- a/clients/client-groundstation/commands/CreateMissionProfileCommand.ts +++ b/clients/client-groundstation/commands/CreateMissionProfileCommand.ts @@ -25,6 +25,20 @@ export interface CreateMissionProfileCommandOutput extends MissionProfileIdRespo *

* dataflowEdges is a list of lists of strings. Each lower level list of strings * has two elements: a from ARN and a to ARN.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { GroundStationClient, CreateMissionProfileCommand } from "@aws-sdk/client-groundstation"; // ES Modules import + * // const { GroundStationClient, CreateMissionProfileCommand } = require("@aws-sdk/client-groundstation"); // CommonJS import + * const client = new GroundStationClient(config); + * const command = new CreateMissionProfileCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreateMissionProfileCommandInput} for command's `input` shape. + * @see {@link CreateMissionProfileCommandOutput} for command's `response` shape. + * @see {@link GroundStationClientResolvedConfig | config} for command's `input` shape. + * */ export class CreateMissionProfileCommand extends $Command< CreateMissionProfileCommandInput, diff --git a/clients/client-groundstation/commands/DeleteConfigCommand.ts b/clients/client-groundstation/commands/DeleteConfigCommand.ts index f8d72fa6243d..044540869e05 100644 --- a/clients/client-groundstation/commands/DeleteConfigCommand.ts +++ b/clients/client-groundstation/commands/DeleteConfigCommand.ts @@ -22,6 +22,20 @@ export interface DeleteConfigCommandOutput extends ConfigIdResponse, __MetadataB /** *

Deletes a Config.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { GroundStationClient, DeleteConfigCommand } from "@aws-sdk/client-groundstation"; // ES Modules import + * // const { GroundStationClient, DeleteConfigCommand } = require("@aws-sdk/client-groundstation"); // CommonJS import + * const client = new GroundStationClient(config); + * const command = new DeleteConfigCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteConfigCommandInput} for command's `input` shape. + * @see {@link DeleteConfigCommandOutput} for command's `response` shape. + * @see {@link GroundStationClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteConfigCommand extends $Command< DeleteConfigCommandInput, diff --git a/clients/client-groundstation/commands/DeleteDataflowEndpointGroupCommand.ts b/clients/client-groundstation/commands/DeleteDataflowEndpointGroupCommand.ts index 339fa26dea41..c3aae476ae95 100644 --- a/clients/client-groundstation/commands/DeleteDataflowEndpointGroupCommand.ts +++ b/clients/client-groundstation/commands/DeleteDataflowEndpointGroupCommand.ts @@ -22,6 +22,20 @@ export interface DeleteDataflowEndpointGroupCommandOutput extends DataflowEndpoi /** *

Deletes a dataflow endpoint group.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { GroundStationClient, DeleteDataflowEndpointGroupCommand } from "@aws-sdk/client-groundstation"; // ES Modules import + * // const { GroundStationClient, DeleteDataflowEndpointGroupCommand } = require("@aws-sdk/client-groundstation"); // CommonJS import + * const client = new GroundStationClient(config); + * const command = new DeleteDataflowEndpointGroupCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteDataflowEndpointGroupCommandInput} for command's `input` shape. + * @see {@link DeleteDataflowEndpointGroupCommandOutput} for command's `response` shape. + * @see {@link GroundStationClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteDataflowEndpointGroupCommand extends $Command< DeleteDataflowEndpointGroupCommandInput, diff --git a/clients/client-groundstation/commands/DeleteMissionProfileCommand.ts b/clients/client-groundstation/commands/DeleteMissionProfileCommand.ts index dbf270b3f8ea..cf3b41343ced 100644 --- a/clients/client-groundstation/commands/DeleteMissionProfileCommand.ts +++ b/clients/client-groundstation/commands/DeleteMissionProfileCommand.ts @@ -22,6 +22,20 @@ export interface DeleteMissionProfileCommandOutput extends MissionProfileIdRespo /** *

Deletes a mission profile.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { GroundStationClient, DeleteMissionProfileCommand } from "@aws-sdk/client-groundstation"; // ES Modules import + * // const { GroundStationClient, DeleteMissionProfileCommand } = require("@aws-sdk/client-groundstation"); // CommonJS import + * const client = new GroundStationClient(config); + * const command = new DeleteMissionProfileCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteMissionProfileCommandInput} for command's `input` shape. + * @see {@link DeleteMissionProfileCommandOutput} for command's `response` shape. + * @see {@link GroundStationClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteMissionProfileCommand extends $Command< DeleteMissionProfileCommandInput, diff --git a/clients/client-groundstation/commands/DescribeContactCommand.ts b/clients/client-groundstation/commands/DescribeContactCommand.ts index 13df7c748093..c6ff1b2b5822 100644 --- a/clients/client-groundstation/commands/DescribeContactCommand.ts +++ b/clients/client-groundstation/commands/DescribeContactCommand.ts @@ -22,6 +22,20 @@ export interface DescribeContactCommandOutput extends DescribeContactResponse, _ /** *

Describes an existing contact.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { GroundStationClient, DescribeContactCommand } from "@aws-sdk/client-groundstation"; // ES Modules import + * // const { GroundStationClient, DescribeContactCommand } = require("@aws-sdk/client-groundstation"); // CommonJS import + * const client = new GroundStationClient(config); + * const command = new DescribeContactCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeContactCommandInput} for command's `input` shape. + * @see {@link DescribeContactCommandOutput} for command's `response` shape. + * @see {@link GroundStationClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeContactCommand extends $Command< DescribeContactCommandInput, diff --git a/clients/client-groundstation/commands/GetConfigCommand.ts b/clients/client-groundstation/commands/GetConfigCommand.ts index 70e1f70ef978..53176081e49c 100644 --- a/clients/client-groundstation/commands/GetConfigCommand.ts +++ b/clients/client-groundstation/commands/GetConfigCommand.ts @@ -23,6 +23,20 @@ export interface GetConfigCommandOutput extends GetConfigResponse, __MetadataBea /** *

Returns Config information.

*

Only one Config response can be returned.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { GroundStationClient, GetConfigCommand } from "@aws-sdk/client-groundstation"; // ES Modules import + * // const { GroundStationClient, GetConfigCommand } = require("@aws-sdk/client-groundstation"); // CommonJS import + * const client = new GroundStationClient(config); + * const command = new GetConfigCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetConfigCommandInput} for command's `input` shape. + * @see {@link GetConfigCommandOutput} for command's `response` shape. + * @see {@link GroundStationClientResolvedConfig | config} for command's `input` shape. + * */ export class GetConfigCommand extends $Command< GetConfigCommandInput, diff --git a/clients/client-groundstation/commands/GetDataflowEndpointGroupCommand.ts b/clients/client-groundstation/commands/GetDataflowEndpointGroupCommand.ts index 1db2895802e3..bba6ca225aef 100644 --- a/clients/client-groundstation/commands/GetDataflowEndpointGroupCommand.ts +++ b/clients/client-groundstation/commands/GetDataflowEndpointGroupCommand.ts @@ -22,6 +22,20 @@ export interface GetDataflowEndpointGroupCommandOutput extends GetDataflowEndpoi /** *

Returns the dataflow endpoint group.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { GroundStationClient, GetDataflowEndpointGroupCommand } from "@aws-sdk/client-groundstation"; // ES Modules import + * // const { GroundStationClient, GetDataflowEndpointGroupCommand } = require("@aws-sdk/client-groundstation"); // CommonJS import + * const client = new GroundStationClient(config); + * const command = new GetDataflowEndpointGroupCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetDataflowEndpointGroupCommandInput} for command's `input` shape. + * @see {@link GetDataflowEndpointGroupCommandOutput} for command's `response` shape. + * @see {@link GroundStationClientResolvedConfig | config} for command's `input` shape. + * */ export class GetDataflowEndpointGroupCommand extends $Command< GetDataflowEndpointGroupCommandInput, diff --git a/clients/client-groundstation/commands/GetMinuteUsageCommand.ts b/clients/client-groundstation/commands/GetMinuteUsageCommand.ts index 81705087cc20..1ef994ad64f4 100644 --- a/clients/client-groundstation/commands/GetMinuteUsageCommand.ts +++ b/clients/client-groundstation/commands/GetMinuteUsageCommand.ts @@ -22,6 +22,20 @@ export interface GetMinuteUsageCommandOutput extends GetMinuteUsageResponse, __M /** *

Returns the number of minutes used by account.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { GroundStationClient, GetMinuteUsageCommand } from "@aws-sdk/client-groundstation"; // ES Modules import + * // const { GroundStationClient, GetMinuteUsageCommand } = require("@aws-sdk/client-groundstation"); // CommonJS import + * const client = new GroundStationClient(config); + * const command = new GetMinuteUsageCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetMinuteUsageCommandInput} for command's `input` shape. + * @see {@link GetMinuteUsageCommandOutput} for command's `response` shape. + * @see {@link GroundStationClientResolvedConfig | config} for command's `input` shape. + * */ export class GetMinuteUsageCommand extends $Command< GetMinuteUsageCommandInput, diff --git a/clients/client-groundstation/commands/GetMissionProfileCommand.ts b/clients/client-groundstation/commands/GetMissionProfileCommand.ts index 05ce5b221fad..794332d1b063 100644 --- a/clients/client-groundstation/commands/GetMissionProfileCommand.ts +++ b/clients/client-groundstation/commands/GetMissionProfileCommand.ts @@ -22,6 +22,20 @@ export interface GetMissionProfileCommandOutput extends GetMissionProfileRespons /** *

Returns a mission profile.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { GroundStationClient, GetMissionProfileCommand } from "@aws-sdk/client-groundstation"; // ES Modules import + * // const { GroundStationClient, GetMissionProfileCommand } = require("@aws-sdk/client-groundstation"); // CommonJS import + * const client = new GroundStationClient(config); + * const command = new GetMissionProfileCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetMissionProfileCommandInput} for command's `input` shape. + * @see {@link GetMissionProfileCommandOutput} for command's `response` shape. + * @see {@link GroundStationClientResolvedConfig | config} for command's `input` shape. + * */ export class GetMissionProfileCommand extends $Command< GetMissionProfileCommandInput, diff --git a/clients/client-groundstation/commands/GetSatelliteCommand.ts b/clients/client-groundstation/commands/GetSatelliteCommand.ts index 6ee784abc59a..eaf60467a1b3 100644 --- a/clients/client-groundstation/commands/GetSatelliteCommand.ts +++ b/clients/client-groundstation/commands/GetSatelliteCommand.ts @@ -22,6 +22,20 @@ export interface GetSatelliteCommandOutput extends GetSatelliteResponse, __Metad /** *

Returns a satellite.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { GroundStationClient, GetSatelliteCommand } from "@aws-sdk/client-groundstation"; // ES Modules import + * // const { GroundStationClient, GetSatelliteCommand } = require("@aws-sdk/client-groundstation"); // CommonJS import + * const client = new GroundStationClient(config); + * const command = new GetSatelliteCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetSatelliteCommandInput} for command's `input` shape. + * @see {@link GetSatelliteCommandOutput} for command's `response` shape. + * @see {@link GroundStationClientResolvedConfig | config} for command's `input` shape. + * */ export class GetSatelliteCommand extends $Command< GetSatelliteCommandInput, diff --git a/clients/client-groundstation/commands/ListConfigsCommand.ts b/clients/client-groundstation/commands/ListConfigsCommand.ts index 7fc8f1e91fd6..06ce9d865bde 100644 --- a/clients/client-groundstation/commands/ListConfigsCommand.ts +++ b/clients/client-groundstation/commands/ListConfigsCommand.ts @@ -22,6 +22,20 @@ export interface ListConfigsCommandOutput extends ListConfigsResponse, __Metadat /** *

Returns a list of Config objects.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { GroundStationClient, ListConfigsCommand } from "@aws-sdk/client-groundstation"; // ES Modules import + * // const { GroundStationClient, ListConfigsCommand } = require("@aws-sdk/client-groundstation"); // CommonJS import + * const client = new GroundStationClient(config); + * const command = new ListConfigsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListConfigsCommandInput} for command's `input` shape. + * @see {@link ListConfigsCommandOutput} for command's `response` shape. + * @see {@link GroundStationClientResolvedConfig | config} for command's `input` shape. + * */ export class ListConfigsCommand extends $Command< ListConfigsCommandInput, diff --git a/clients/client-groundstation/commands/ListContactsCommand.ts b/clients/client-groundstation/commands/ListContactsCommand.ts index f5b2d75e5573..739c9fdd82fe 100644 --- a/clients/client-groundstation/commands/ListContactsCommand.ts +++ b/clients/client-groundstation/commands/ListContactsCommand.ts @@ -25,6 +25,20 @@ export interface ListContactsCommandOutput extends ListContactsResponse, __Metad *

If statusList contains AVAILABLE, the request must include * groundStation, missionprofileArn, and satelliteArn. *

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { GroundStationClient, ListContactsCommand } from "@aws-sdk/client-groundstation"; // ES Modules import + * // const { GroundStationClient, ListContactsCommand } = require("@aws-sdk/client-groundstation"); // CommonJS import + * const client = new GroundStationClient(config); + * const command = new ListContactsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListContactsCommandInput} for command's `input` shape. + * @see {@link ListContactsCommandOutput} for command's `response` shape. + * @see {@link GroundStationClientResolvedConfig | config} for command's `input` shape. + * */ export class ListContactsCommand extends $Command< ListContactsCommandInput, diff --git a/clients/client-groundstation/commands/ListDataflowEndpointGroupsCommand.ts b/clients/client-groundstation/commands/ListDataflowEndpointGroupsCommand.ts index 881e4907fbfc..6db5b736971a 100644 --- a/clients/client-groundstation/commands/ListDataflowEndpointGroupsCommand.ts +++ b/clients/client-groundstation/commands/ListDataflowEndpointGroupsCommand.ts @@ -22,6 +22,20 @@ export interface ListDataflowEndpointGroupsCommandOutput extends ListDataflowEnd /** *

Returns a list of DataflowEndpoint groups.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { GroundStationClient, ListDataflowEndpointGroupsCommand } from "@aws-sdk/client-groundstation"; // ES Modules import + * // const { GroundStationClient, ListDataflowEndpointGroupsCommand } = require("@aws-sdk/client-groundstation"); // CommonJS import + * const client = new GroundStationClient(config); + * const command = new ListDataflowEndpointGroupsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListDataflowEndpointGroupsCommandInput} for command's `input` shape. + * @see {@link ListDataflowEndpointGroupsCommandOutput} for command's `response` shape. + * @see {@link GroundStationClientResolvedConfig | config} for command's `input` shape. + * */ export class ListDataflowEndpointGroupsCommand extends $Command< ListDataflowEndpointGroupsCommandInput, diff --git a/clients/client-groundstation/commands/ListGroundStationsCommand.ts b/clients/client-groundstation/commands/ListGroundStationsCommand.ts index 8d29eb4c42a1..f0a2cacb10ab 100644 --- a/clients/client-groundstation/commands/ListGroundStationsCommand.ts +++ b/clients/client-groundstation/commands/ListGroundStationsCommand.ts @@ -22,6 +22,20 @@ export interface ListGroundStationsCommandOutput extends ListGroundStationsRespo /** *

Returns a list of ground stations.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { GroundStationClient, ListGroundStationsCommand } from "@aws-sdk/client-groundstation"; // ES Modules import + * // const { GroundStationClient, ListGroundStationsCommand } = require("@aws-sdk/client-groundstation"); // CommonJS import + * const client = new GroundStationClient(config); + * const command = new ListGroundStationsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListGroundStationsCommandInput} for command's `input` shape. + * @see {@link ListGroundStationsCommandOutput} for command's `response` shape. + * @see {@link GroundStationClientResolvedConfig | config} for command's `input` shape. + * */ export class ListGroundStationsCommand extends $Command< ListGroundStationsCommandInput, diff --git a/clients/client-groundstation/commands/ListMissionProfilesCommand.ts b/clients/client-groundstation/commands/ListMissionProfilesCommand.ts index 8fb7faf0384d..25163596385e 100644 --- a/clients/client-groundstation/commands/ListMissionProfilesCommand.ts +++ b/clients/client-groundstation/commands/ListMissionProfilesCommand.ts @@ -22,6 +22,20 @@ export interface ListMissionProfilesCommandOutput extends ListMissionProfilesRes /** *

Returns a list of mission profiles.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { GroundStationClient, ListMissionProfilesCommand } from "@aws-sdk/client-groundstation"; // ES Modules import + * // const { GroundStationClient, ListMissionProfilesCommand } = require("@aws-sdk/client-groundstation"); // CommonJS import + * const client = new GroundStationClient(config); + * const command = new ListMissionProfilesCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListMissionProfilesCommandInput} for command's `input` shape. + * @see {@link ListMissionProfilesCommandOutput} for command's `response` shape. + * @see {@link GroundStationClientResolvedConfig | config} for command's `input` shape. + * */ export class ListMissionProfilesCommand extends $Command< ListMissionProfilesCommandInput, diff --git a/clients/client-groundstation/commands/ListSatellitesCommand.ts b/clients/client-groundstation/commands/ListSatellitesCommand.ts index fcd42e9d224b..8a07b6d61464 100644 --- a/clients/client-groundstation/commands/ListSatellitesCommand.ts +++ b/clients/client-groundstation/commands/ListSatellitesCommand.ts @@ -22,6 +22,20 @@ export interface ListSatellitesCommandOutput extends ListSatellitesResponse, __M /** *

Returns a list of satellites.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { GroundStationClient, ListSatellitesCommand } from "@aws-sdk/client-groundstation"; // ES Modules import + * // const { GroundStationClient, ListSatellitesCommand } = require("@aws-sdk/client-groundstation"); // CommonJS import + * const client = new GroundStationClient(config); + * const command = new ListSatellitesCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListSatellitesCommandInput} for command's `input` shape. + * @see {@link ListSatellitesCommandOutput} for command's `response` shape. + * @see {@link GroundStationClientResolvedConfig | config} for command's `input` shape. + * */ export class ListSatellitesCommand extends $Command< ListSatellitesCommandInput, diff --git a/clients/client-groundstation/commands/ListTagsForResourceCommand.ts b/clients/client-groundstation/commands/ListTagsForResourceCommand.ts index 23dc4b723d00..1c6cca0a5ea0 100644 --- a/clients/client-groundstation/commands/ListTagsForResourceCommand.ts +++ b/clients/client-groundstation/commands/ListTagsForResourceCommand.ts @@ -22,6 +22,20 @@ export interface ListTagsForResourceCommandOutput extends ListTagsForResourceRes /** *

Returns a list of tags for a specified resource.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { GroundStationClient, ListTagsForResourceCommand } from "@aws-sdk/client-groundstation"; // ES Modules import + * // const { GroundStationClient, ListTagsForResourceCommand } = require("@aws-sdk/client-groundstation"); // CommonJS import + * const client = new GroundStationClient(config); + * const command = new ListTagsForResourceCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListTagsForResourceCommandInput} for command's `input` shape. + * @see {@link ListTagsForResourceCommandOutput} for command's `response` shape. + * @see {@link GroundStationClientResolvedConfig | config} for command's `input` shape. + * */ export class ListTagsForResourceCommand extends $Command< ListTagsForResourceCommandInput, diff --git a/clients/client-groundstation/commands/ReserveContactCommand.ts b/clients/client-groundstation/commands/ReserveContactCommand.ts index cdc8fe807c83..68c26d35817f 100644 --- a/clients/client-groundstation/commands/ReserveContactCommand.ts +++ b/clients/client-groundstation/commands/ReserveContactCommand.ts @@ -22,6 +22,20 @@ export interface ReserveContactCommandOutput extends ContactIdResponse, __Metada /** *

Reserves a contact using specified parameters.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { GroundStationClient, ReserveContactCommand } from "@aws-sdk/client-groundstation"; // ES Modules import + * // const { GroundStationClient, ReserveContactCommand } = require("@aws-sdk/client-groundstation"); // CommonJS import + * const client = new GroundStationClient(config); + * const command = new ReserveContactCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ReserveContactCommandInput} for command's `input` shape. + * @see {@link ReserveContactCommandOutput} for command's `response` shape. + * @see {@link GroundStationClientResolvedConfig | config} for command's `input` shape. + * */ export class ReserveContactCommand extends $Command< ReserveContactCommandInput, diff --git a/clients/client-groundstation/commands/TagResourceCommand.ts b/clients/client-groundstation/commands/TagResourceCommand.ts index 42a7d2d4bdd3..2d373c2de273 100644 --- a/clients/client-groundstation/commands/TagResourceCommand.ts +++ b/clients/client-groundstation/commands/TagResourceCommand.ts @@ -22,6 +22,20 @@ export interface TagResourceCommandOutput extends TagResourceResponse, __Metadat /** *

Assigns a tag to a resource.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { GroundStationClient, TagResourceCommand } from "@aws-sdk/client-groundstation"; // ES Modules import + * // const { GroundStationClient, TagResourceCommand } = require("@aws-sdk/client-groundstation"); // CommonJS import + * const client = new GroundStationClient(config); + * const command = new TagResourceCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link TagResourceCommandInput} for command's `input` shape. + * @see {@link TagResourceCommandOutput} for command's `response` shape. + * @see {@link GroundStationClientResolvedConfig | config} for command's `input` shape. + * */ export class TagResourceCommand extends $Command< TagResourceCommandInput, diff --git a/clients/client-groundstation/commands/UntagResourceCommand.ts b/clients/client-groundstation/commands/UntagResourceCommand.ts index 7cdf3dce47cd..631d5eba146b 100644 --- a/clients/client-groundstation/commands/UntagResourceCommand.ts +++ b/clients/client-groundstation/commands/UntagResourceCommand.ts @@ -22,6 +22,20 @@ export interface UntagResourceCommandOutput extends UntagResourceResponse, __Met /** *

Deassigns a resource tag.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { GroundStationClient, UntagResourceCommand } from "@aws-sdk/client-groundstation"; // ES Modules import + * // const { GroundStationClient, UntagResourceCommand } = require("@aws-sdk/client-groundstation"); // CommonJS import + * const client = new GroundStationClient(config); + * const command = new UntagResourceCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link UntagResourceCommandInput} for command's `input` shape. + * @see {@link UntagResourceCommandOutput} for command's `response` shape. + * @see {@link GroundStationClientResolvedConfig | config} for command's `input` shape. + * */ export class UntagResourceCommand extends $Command< UntagResourceCommandInput, diff --git a/clients/client-groundstation/commands/UpdateConfigCommand.ts b/clients/client-groundstation/commands/UpdateConfigCommand.ts index d007f2b2b4ca..84fb2ef86435 100644 --- a/clients/client-groundstation/commands/UpdateConfigCommand.ts +++ b/clients/client-groundstation/commands/UpdateConfigCommand.ts @@ -24,6 +24,20 @@ export interface UpdateConfigCommandOutput extends ConfigIdResponse, __MetadataB *

Updates the Config used when scheduling contacts.

*

Updating a Config will not update the execution parameters * for existing future contacts scheduled with this Config.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { GroundStationClient, UpdateConfigCommand } from "@aws-sdk/client-groundstation"; // ES Modules import + * // const { GroundStationClient, UpdateConfigCommand } = require("@aws-sdk/client-groundstation"); // CommonJS import + * const client = new GroundStationClient(config); + * const command = new UpdateConfigCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link UpdateConfigCommandInput} for command's `input` shape. + * @see {@link UpdateConfigCommandOutput} for command's `response` shape. + * @see {@link GroundStationClientResolvedConfig | config} for command's `input` shape. + * */ export class UpdateConfigCommand extends $Command< UpdateConfigCommandInput, diff --git a/clients/client-groundstation/commands/UpdateMissionProfileCommand.ts b/clients/client-groundstation/commands/UpdateMissionProfileCommand.ts index 74f5a5883200..b283262a77af 100644 --- a/clients/client-groundstation/commands/UpdateMissionProfileCommand.ts +++ b/clients/client-groundstation/commands/UpdateMissionProfileCommand.ts @@ -24,6 +24,20 @@ export interface UpdateMissionProfileCommandOutput extends MissionProfileIdRespo *

Updates a mission profile.

*

Updating a mission profile will not update the execution parameters * for existing future contacts.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { GroundStationClient, UpdateMissionProfileCommand } from "@aws-sdk/client-groundstation"; // ES Modules import + * // const { GroundStationClient, UpdateMissionProfileCommand } = require("@aws-sdk/client-groundstation"); // CommonJS import + * const client = new GroundStationClient(config); + * const command = new UpdateMissionProfileCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link UpdateMissionProfileCommandInput} for command's `input` shape. + * @see {@link UpdateMissionProfileCommandOutput} for command's `response` shape. + * @see {@link GroundStationClientResolvedConfig | config} for command's `input` shape. + * */ export class UpdateMissionProfileCommand extends $Command< UpdateMissionProfileCommandInput, diff --git a/clients/client-groundstation/models/models_0.ts b/clients/client-groundstation/models/models_0.ts index eb536458ba1e..5380b1d8cb97 100644 --- a/clients/client-groundstation/models/models_0.ts +++ b/clients/client-groundstation/models/models_0.ts @@ -17,6 +17,9 @@ export interface AntennaDemodDecodeDetails { } export namespace AntennaDemodDecodeDetails { + /** + * @internal + */ export const filterSensitiveLog = (obj: AntennaDemodDecodeDetails): any => ({ ...obj, }); @@ -55,6 +58,9 @@ export interface FrequencyBandwidth { } export namespace FrequencyBandwidth { + /** + * @internal + */ export const filterSensitiveLog = (obj: FrequencyBandwidth): any => ({ ...obj, }); @@ -82,6 +88,9 @@ export interface Frequency { } export namespace Frequency { + /** + * @internal + */ export const filterSensitiveLog = (obj: Frequency): any => ({ ...obj, }); @@ -125,6 +134,9 @@ export interface SpectrumConfig { } export namespace SpectrumConfig { + /** + * @internal + */ export const filterSensitiveLog = (obj: SpectrumConfig): any => ({ ...obj, }); @@ -142,6 +154,9 @@ export interface AntennaDownlinkConfig { } export namespace AntennaDownlinkConfig { + /** + * @internal + */ export const filterSensitiveLog = (obj: AntennaDownlinkConfig): any => ({ ...obj, }); @@ -158,6 +173,9 @@ export interface DecodeConfig { } export namespace DecodeConfig { + /** + * @internal + */ export const filterSensitiveLog = (obj: DecodeConfig): any => ({ ...obj, }); @@ -174,6 +192,9 @@ export interface DemodulationConfig { } export namespace DemodulationConfig { + /** + * @internal + */ export const filterSensitiveLog = (obj: DemodulationConfig): any => ({ ...obj, }); @@ -200,6 +221,9 @@ export interface AntennaDownlinkDemodDecodeConfig { } export namespace AntennaDownlinkDemodDecodeConfig { + /** + * @internal + */ export const filterSensitiveLog = (obj: AntennaDownlinkDemodDecodeConfig): any => ({ ...obj, }); @@ -221,6 +245,9 @@ export interface UplinkSpectrumConfig { } export namespace UplinkSpectrumConfig { + /** + * @internal + */ export const filterSensitiveLog = (obj: UplinkSpectrumConfig): any => ({ ...obj, }); @@ -246,6 +273,9 @@ export interface Eirp { } export namespace Eirp { + /** + * @internal + */ export const filterSensitiveLog = (obj: Eirp): any => ({ ...obj, }); @@ -272,6 +302,9 @@ export interface AntennaUplinkConfig { } export namespace AntennaUplinkConfig { + /** + * @internal + */ export const filterSensitiveLog = (obj: AntennaUplinkConfig): any => ({ ...obj, }); @@ -288,6 +321,9 @@ export interface CancelContactRequest { } export namespace CancelContactRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: CancelContactRequest): any => ({ ...obj, }); @@ -304,6 +340,9 @@ export interface ContactIdResponse { } export namespace ContactIdResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ContactIdResponse): any => ({ ...obj, }); @@ -323,6 +362,9 @@ export interface DependencyException extends __SmithyException, $MetadataBearer } export namespace DependencyException { + /** + * @internal + */ export const filterSensitiveLog = (obj: DependencyException): any => ({ ...obj, }); @@ -342,6 +384,9 @@ export interface InvalidParameterException extends __SmithyException, $MetadataB } export namespace InvalidParameterException { + /** + * @internal + */ export const filterSensitiveLog = (obj: InvalidParameterException): any => ({ ...obj, }); @@ -357,6 +402,9 @@ export interface ResourceNotFoundException extends __SmithyException, $MetadataB } export namespace ResourceNotFoundException { + /** + * @internal + */ export const filterSensitiveLog = (obj: ResourceNotFoundException): any => ({ ...obj, }); @@ -393,6 +441,9 @@ export interface ConfigIdResponse { } export namespace ConfigIdResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ConfigIdResponse): any => ({ ...obj, }); @@ -414,6 +465,9 @@ export interface DataflowEndpointConfig { } export namespace DataflowEndpointConfig { + /** + * @internal + */ export const filterSensitiveLog = (obj: DataflowEndpointConfig): any => ({ ...obj, }); @@ -440,6 +494,9 @@ export interface S3RecordingConfig { } export namespace S3RecordingConfig { + /** + * @internal + */ export const filterSensitiveLog = (obj: S3RecordingConfig): any => ({ ...obj, }); @@ -463,6 +520,9 @@ export interface TrackingConfig { } export namespace TrackingConfig { + /** + * @internal + */ export const filterSensitiveLog = (obj: TrackingConfig): any => ({ ...obj, }); @@ -487,6 +547,9 @@ export interface UplinkEchoConfig { } export namespace UplinkEchoConfig { + /** + * @internal + */ export const filterSensitiveLog = (obj: UplinkEchoConfig): any => ({ ...obj, }); @@ -640,6 +703,9 @@ export namespace ConfigTypeData { return visitor._(value.$unknown[0], value.$unknown[1]); }; + /** + * @internal + */ export const filterSensitiveLog = (obj: ConfigTypeData): any => { if (obj.antennaDownlinkConfig !== undefined) return { antennaDownlinkConfig: AntennaDownlinkConfig.filterSensitiveLog(obj.antennaDownlinkConfig) }; @@ -684,6 +750,9 @@ export interface CreateConfigRequest { } export namespace CreateConfigRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateConfigRequest): any => ({ ...obj, ...(obj.configData && { configData: ConfigTypeData.filterSensitiveLog(obj.configData) }), @@ -704,6 +773,9 @@ export interface ResourceLimitExceededException extends __SmithyException, $Meta } export namespace ResourceLimitExceededException { + /** + * @internal + */ export const filterSensitiveLog = (obj: ResourceLimitExceededException): any => ({ ...obj, }); @@ -725,6 +797,9 @@ export interface DeleteConfigRequest { } export namespace DeleteConfigRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteConfigRequest): any => ({ ...obj, }); @@ -746,6 +821,9 @@ export interface GetConfigRequest { } export namespace GetConfigRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetConfigRequest): any => ({ ...obj, }); @@ -788,6 +866,9 @@ export interface GetConfigResponse { } export namespace GetConfigResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetConfigResponse): any => ({ ...obj, ...(obj.configData && { configData: ConfigTypeData.filterSensitiveLog(obj.configData) }), @@ -810,6 +891,9 @@ export interface ListConfigsRequest { } export namespace ListConfigsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListConfigsRequest): any => ({ ...obj, }); @@ -841,6 +925,9 @@ export interface ConfigListItem { } export namespace ConfigListItem { + /** + * @internal + */ export const filterSensitiveLog = (obj: ConfigListItem): any => ({ ...obj, }); @@ -862,6 +949,9 @@ export interface ListConfigsResponse { } export namespace ListConfigsResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListConfigsResponse): any => ({ ...obj, }); @@ -893,6 +983,9 @@ export interface UpdateConfigRequest { } export namespace UpdateConfigRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateConfigRequest): any => ({ ...obj, ...(obj.configData && { configData: ConfigTypeData.filterSensitiveLog(obj.configData) }), @@ -915,6 +1008,9 @@ export interface SocketAddress { } export namespace SocketAddress { + /** + * @internal + */ export const filterSensitiveLog = (obj: SocketAddress): any => ({ ...obj, }); @@ -954,6 +1050,9 @@ export interface DataflowEndpoint { } export namespace DataflowEndpoint { + /** + * @internal + */ export const filterSensitiveLog = (obj: DataflowEndpoint): any => ({ ...obj, }); @@ -980,6 +1079,9 @@ export interface SecurityDetails { } export namespace SecurityDetails { + /** + * @internal + */ export const filterSensitiveLog = (obj: SecurityDetails): any => ({ ...obj, }); @@ -1001,6 +1103,9 @@ export interface EndpointDetails { } export namespace EndpointDetails { + /** + * @internal + */ export const filterSensitiveLog = (obj: EndpointDetails): any => ({ ...obj, }); @@ -1022,6 +1127,9 @@ export interface S3RecordingDetails { } export namespace S3RecordingDetails { + /** + * @internal + */ export const filterSensitiveLog = (obj: S3RecordingDetails): any => ({ ...obj, }); @@ -1089,6 +1197,9 @@ export namespace ConfigDetails { return visitor._(value.$unknown[0], value.$unknown[1]); }; + /** + * @internal + */ export const filterSensitiveLog = (obj: ConfigDetails): any => { if (obj.endpointDetails !== undefined) return { endpointDetails: EndpointDetails.filterSensitiveLog(obj.endpointDetails) }; @@ -1111,6 +1222,9 @@ export interface DescribeContactRequest { } export namespace DescribeContactRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeContactRequest): any => ({ ...obj, }); @@ -1158,6 +1272,9 @@ export interface Destination { } export namespace Destination { + /** + * @internal + */ export const filterSensitiveLog = (obj: Destination): any => ({ ...obj, ...(obj.configDetails && { configDetails: ConfigDetails.filterSensitiveLog(obj.configDetails) }), @@ -1190,6 +1307,9 @@ export interface Source { } export namespace Source { + /** + * @internal + */ export const filterSensitiveLog = (obj: Source): any => ({ ...obj, ...(obj.configDetails && { configDetails: ConfigDetails.filterSensitiveLog(obj.configDetails) }), @@ -1217,6 +1337,9 @@ export interface DataflowDetail { } export namespace DataflowDetail { + /** + * @internal + */ export const filterSensitiveLog = (obj: DataflowDetail): any => ({ ...obj, ...(obj.source && { source: Source.filterSensitiveLog(obj.source) }), @@ -1240,6 +1363,9 @@ export interface Elevation { } export namespace Elevation { + /** + * @internal + */ export const filterSensitiveLog = (obj: Elevation): any => ({ ...obj, }); @@ -1321,6 +1447,9 @@ export interface DescribeContactResponse { } export namespace DescribeContactResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeContactResponse): any => ({ ...obj, ...(obj.dataflowList && { dataflowList: obj.dataflowList.map((item) => DataflowDetail.filterSensitiveLog(item)) }), @@ -1373,6 +1502,9 @@ export interface ListContactsRequest { } export namespace ListContactsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListContactsRequest): any => ({ ...obj, }); @@ -1449,6 +1581,9 @@ export interface ContactData { } export namespace ContactData { + /** + * @internal + */ export const filterSensitiveLog = (obj: ContactData): any => ({ ...obj, }); @@ -1470,6 +1605,9 @@ export interface ListContactsResponse { } export namespace ListContactsResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListContactsResponse): any => ({ ...obj, }); @@ -1511,6 +1649,9 @@ export interface ReserveContactRequest { } export namespace ReserveContactRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ReserveContactRequest): any => ({ ...obj, }); @@ -1532,6 +1673,9 @@ export interface CreateDataflowEndpointGroupRequest { } export namespace CreateDataflowEndpointGroupRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateDataflowEndpointGroupRequest): any => ({ ...obj, }); @@ -1548,6 +1692,9 @@ export interface DataflowEndpointGroupIdResponse { } export namespace DataflowEndpointGroupIdResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DataflowEndpointGroupIdResponse): any => ({ ...obj, }); @@ -1596,6 +1743,9 @@ export interface CreateMissionProfileRequest { } export namespace CreateMissionProfileRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateMissionProfileRequest): any => ({ ...obj, }); @@ -1612,6 +1762,9 @@ export interface MissionProfileIdResponse { } export namespace MissionProfileIdResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: MissionProfileIdResponse): any => ({ ...obj, }); @@ -1628,6 +1781,9 @@ export interface DeleteDataflowEndpointGroupRequest { } export namespace DeleteDataflowEndpointGroupRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteDataflowEndpointGroupRequest): any => ({ ...obj, }); @@ -1644,6 +1800,9 @@ export interface GetDataflowEndpointGroupRequest { } export namespace GetDataflowEndpointGroupRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetDataflowEndpointGroupRequest): any => ({ ...obj, }); @@ -1675,6 +1834,9 @@ export interface GetDataflowEndpointGroupResponse { } export namespace GetDataflowEndpointGroupResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetDataflowEndpointGroupResponse): any => ({ ...obj, }); @@ -1696,6 +1858,9 @@ export interface ListDataflowEndpointGroupsRequest { } export namespace ListDataflowEndpointGroupsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListDataflowEndpointGroupsRequest): any => ({ ...obj, }); @@ -1717,6 +1882,9 @@ export interface DataflowEndpointListItem { } export namespace DataflowEndpointListItem { + /** + * @internal + */ export const filterSensitiveLog = (obj: DataflowEndpointListItem): any => ({ ...obj, }); @@ -1738,6 +1906,9 @@ export interface ListDataflowEndpointGroupsResponse { } export namespace ListDataflowEndpointGroupsResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListDataflowEndpointGroupsResponse): any => ({ ...obj, }); @@ -1754,6 +1925,9 @@ export interface DeleteMissionProfileRequest { } export namespace DeleteMissionProfileRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteMissionProfileRequest): any => ({ ...obj, }); @@ -1775,6 +1949,9 @@ export interface GetMinuteUsageRequest { } export namespace GetMinuteUsageRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetMinuteUsageRequest): any => ({ ...obj, }); @@ -1811,6 +1988,9 @@ export interface GetMinuteUsageResponse { } export namespace GetMinuteUsageResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetMinuteUsageResponse): any => ({ ...obj, }); @@ -1827,6 +2007,9 @@ export interface GetMissionProfileRequest { } export namespace GetMissionProfileRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetMissionProfileRequest): any => ({ ...obj, }); @@ -1890,6 +2073,9 @@ export interface GetMissionProfileResponse { } export namespace GetMissionProfileResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetMissionProfileResponse): any => ({ ...obj, }); @@ -1906,6 +2092,9 @@ export interface GetSatelliteRequest { } export namespace GetSatelliteRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetSatelliteRequest): any => ({ ...obj, }); @@ -1937,6 +2126,9 @@ export interface GetSatelliteResponse { } export namespace GetSatelliteResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetSatelliteResponse): any => ({ ...obj, }); @@ -1963,6 +2155,9 @@ export interface ListGroundStationsRequest { } export namespace ListGroundStationsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListGroundStationsRequest): any => ({ ...obj, }); @@ -1989,6 +2184,9 @@ export interface GroundStationData { } export namespace GroundStationData { + /** + * @internal + */ export const filterSensitiveLog = (obj: GroundStationData): any => ({ ...obj, }); @@ -2010,6 +2208,9 @@ export interface ListGroundStationsResponse { } export namespace ListGroundStationsResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListGroundStationsResponse): any => ({ ...obj, }); @@ -2026,6 +2227,9 @@ export interface ListTagsForResourceRequest { } export namespace ListTagsForResourceRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListTagsForResourceRequest): any => ({ ...obj, }); @@ -2042,6 +2246,9 @@ export interface ListTagsForResourceResponse { } export namespace ListTagsForResourceResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListTagsForResourceResponse): any => ({ ...obj, }); @@ -2063,6 +2270,9 @@ export interface ListMissionProfilesRequest { } export namespace ListMissionProfilesRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListMissionProfilesRequest): any => ({ ...obj, }); @@ -2094,6 +2304,9 @@ export interface MissionProfileListItem { } export namespace MissionProfileListItem { + /** + * @internal + */ export const filterSensitiveLog = (obj: MissionProfileListItem): any => ({ ...obj, }); @@ -2115,6 +2328,9 @@ export interface ListMissionProfilesResponse { } export namespace ListMissionProfilesResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListMissionProfilesResponse): any => ({ ...obj, }); @@ -2163,6 +2379,9 @@ export interface UpdateMissionProfileRequest { } export namespace UpdateMissionProfileRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateMissionProfileRequest): any => ({ ...obj, }); @@ -2184,6 +2403,9 @@ export interface ListSatellitesRequest { } export namespace ListSatellitesRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListSatellitesRequest): any => ({ ...obj, }); @@ -2215,6 +2437,9 @@ export interface SatelliteListItem { } export namespace SatelliteListItem { + /** + * @internal + */ export const filterSensitiveLog = (obj: SatelliteListItem): any => ({ ...obj, }); @@ -2236,6 +2461,9 @@ export interface ListSatellitesResponse { } export namespace ListSatellitesResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListSatellitesResponse): any => ({ ...obj, }); @@ -2257,6 +2485,9 @@ export interface TagResourceRequest { } export namespace TagResourceRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: TagResourceRequest): any => ({ ...obj, }); @@ -2268,6 +2499,9 @@ export namespace TagResourceRequest { export interface TagResourceResponse {} export namespace TagResourceResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: TagResourceResponse): any => ({ ...obj, }); @@ -2289,6 +2523,9 @@ export interface UntagResourceRequest { } export namespace UntagResourceRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: UntagResourceRequest): any => ({ ...obj, }); @@ -2300,6 +2537,9 @@ export namespace UntagResourceRequest { export interface UntagResourceResponse {} export namespace UntagResourceResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: UntagResourceResponse): any => ({ ...obj, }); diff --git a/clients/client-guardduty/commands/AcceptInvitationCommand.ts b/clients/client-guardduty/commands/AcceptInvitationCommand.ts index e87e2785c5d4..de4a3d386eef 100644 --- a/clients/client-guardduty/commands/AcceptInvitationCommand.ts +++ b/clients/client-guardduty/commands/AcceptInvitationCommand.ts @@ -22,6 +22,20 @@ export interface AcceptInvitationCommandOutput extends AcceptInvitationResponse, /** *

Accepts the invitation to be monitored by a GuardDuty administrator account.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { GuardDutyClient, AcceptInvitationCommand } from "@aws-sdk/client-guardduty"; // ES Modules import + * // const { GuardDutyClient, AcceptInvitationCommand } = require("@aws-sdk/client-guardduty"); // CommonJS import + * const client = new GuardDutyClient(config); + * const command = new AcceptInvitationCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link AcceptInvitationCommandInput} for command's `input` shape. + * @see {@link AcceptInvitationCommandOutput} for command's `response` shape. + * @see {@link GuardDutyClientResolvedConfig | config} for command's `input` shape. + * */ export class AcceptInvitationCommand extends $Command< AcceptInvitationCommandInput, diff --git a/clients/client-guardduty/commands/ArchiveFindingsCommand.ts b/clients/client-guardduty/commands/ArchiveFindingsCommand.ts index f4ebf89c0b9e..57ed42af6d12 100644 --- a/clients/client-guardduty/commands/ArchiveFindingsCommand.ts +++ b/clients/client-guardduty/commands/ArchiveFindingsCommand.ts @@ -26,6 +26,20 @@ export interface ArchiveFindingsCommandOutput extends ArchiveFindingsResponse, _ *

Only the administrator account can archive findings. Member accounts don't have permission to * archive findings from their accounts.

* + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { GuardDutyClient, ArchiveFindingsCommand } from "@aws-sdk/client-guardduty"; // ES Modules import + * // const { GuardDutyClient, ArchiveFindingsCommand } = require("@aws-sdk/client-guardduty"); // CommonJS import + * const client = new GuardDutyClient(config); + * const command = new ArchiveFindingsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ArchiveFindingsCommandInput} for command's `input` shape. + * @see {@link ArchiveFindingsCommandOutput} for command's `response` shape. + * @see {@link GuardDutyClientResolvedConfig | config} for command's `input` shape. + * */ export class ArchiveFindingsCommand extends $Command< ArchiveFindingsCommandInput, diff --git a/clients/client-guardduty/commands/CreateDetectorCommand.ts b/clients/client-guardduty/commands/CreateDetectorCommand.ts index 7b848e78a2fa..aa34a15e52e2 100644 --- a/clients/client-guardduty/commands/CreateDetectorCommand.ts +++ b/clients/client-guardduty/commands/CreateDetectorCommand.ts @@ -25,6 +25,20 @@ export interface CreateDetectorCommandOutput extends CreateDetectorResponse, __M * 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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { GuardDutyClient, CreateDetectorCommand } from "@aws-sdk/client-guardduty"; // ES Modules import + * // const { GuardDutyClient, CreateDetectorCommand } = require("@aws-sdk/client-guardduty"); // CommonJS import + * const client = new GuardDutyClient(config); + * const command = new CreateDetectorCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreateDetectorCommandInput} for command's `input` shape. + * @see {@link CreateDetectorCommandOutput} for command's `response` shape. + * @see {@link GuardDutyClientResolvedConfig | config} for command's `input` shape. + * */ export class CreateDetectorCommand extends $Command< CreateDetectorCommandInput, diff --git a/clients/client-guardduty/commands/CreateFilterCommand.ts b/clients/client-guardduty/commands/CreateFilterCommand.ts index 52b5f59e0ad6..fe03f4af7bbf 100644 --- a/clients/client-guardduty/commands/CreateFilterCommand.ts +++ b/clients/client-guardduty/commands/CreateFilterCommand.ts @@ -22,6 +22,20 @@ export interface CreateFilterCommandOutput extends CreateFilterResponse, __Metad /** *

Creates a filter using the specified finding criteria.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { GuardDutyClient, CreateFilterCommand } from "@aws-sdk/client-guardduty"; // ES Modules import + * // const { GuardDutyClient, CreateFilterCommand } = require("@aws-sdk/client-guardduty"); // CommonJS import + * const client = new GuardDutyClient(config); + * const command = new CreateFilterCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreateFilterCommandInput} for command's `input` shape. + * @see {@link CreateFilterCommandOutput} for command's `response` shape. + * @see {@link GuardDutyClientResolvedConfig | config} for command's `input` shape. + * */ export class CreateFilterCommand extends $Command< CreateFilterCommandInput, diff --git a/clients/client-guardduty/commands/CreateIPSetCommand.ts b/clients/client-guardduty/commands/CreateIPSetCommand.ts index e979fdff9d09..454d6590a867 100644 --- a/clients/client-guardduty/commands/CreateIPSetCommand.ts +++ b/clients/client-guardduty/commands/CreateIPSetCommand.ts @@ -25,6 +25,20 @@ export interface CreateIPSetCommandOutput extends CreateIPSetResponse, __Metadat * IPSet is a list of IP addresses that are trusted for secure communication with AWS * 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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { GuardDutyClient, CreateIPSetCommand } from "@aws-sdk/client-guardduty"; // ES Modules import + * // const { GuardDutyClient, CreateIPSetCommand } = require("@aws-sdk/client-guardduty"); // CommonJS import + * const client = new GuardDutyClient(config); + * const command = new CreateIPSetCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreateIPSetCommandInput} for command's `input` shape. + * @see {@link CreateIPSetCommandOutput} for command's `response` shape. + * @see {@link GuardDutyClientResolvedConfig | config} for command's `input` shape. + * */ export class CreateIPSetCommand extends $Command< CreateIPSetCommandInput, diff --git a/clients/client-guardduty/commands/CreateMembersCommand.ts b/clients/client-guardduty/commands/CreateMembersCommand.ts index 42008dc7feec..675fea9b66bf 100644 --- a/clients/client-guardduty/commands/CreateMembersCommand.ts +++ b/clients/client-guardduty/commands/CreateMembersCommand.ts @@ -33,6 +33,20 @@ export interface CreateMembersCommandOutput extends CreateMembersResponse, __Met * Invite * Members * .

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { GuardDutyClient, CreateMembersCommand } from "@aws-sdk/client-guardduty"; // ES Modules import + * // const { GuardDutyClient, CreateMembersCommand } = require("@aws-sdk/client-guardduty"); // CommonJS import + * const client = new GuardDutyClient(config); + * const command = new CreateMembersCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreateMembersCommandInput} for command's `input` shape. + * @see {@link CreateMembersCommandOutput} for command's `response` shape. + * @see {@link GuardDutyClientResolvedConfig | config} for command's `input` shape. + * */ export class CreateMembersCommand extends $Command< CreateMembersCommandInput, diff --git a/clients/client-guardduty/commands/CreatePublishingDestinationCommand.ts b/clients/client-guardduty/commands/CreatePublishingDestinationCommand.ts index 5b44ddfc1bd8..6ecf68b09f92 100644 --- a/clients/client-guardduty/commands/CreatePublishingDestinationCommand.ts +++ b/clients/client-guardduty/commands/CreatePublishingDestinationCommand.ts @@ -25,6 +25,20 @@ export interface CreatePublishingDestinationCommandOutput /** *

Creates a publishing destination to export findings to. The resource to export findings to * must exist before you use this operation.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { GuardDutyClient, CreatePublishingDestinationCommand } from "@aws-sdk/client-guardduty"; // ES Modules import + * // const { GuardDutyClient, CreatePublishingDestinationCommand } = require("@aws-sdk/client-guardduty"); // CommonJS import + * const client = new GuardDutyClient(config); + * const command = new CreatePublishingDestinationCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreatePublishingDestinationCommandInput} for command's `input` shape. + * @see {@link CreatePublishingDestinationCommandOutput} for command's `response` shape. + * @see {@link GuardDutyClientResolvedConfig | config} for command's `input` shape. + * */ export class CreatePublishingDestinationCommand extends $Command< CreatePublishingDestinationCommandInput, diff --git a/clients/client-guardduty/commands/CreateSampleFindingsCommand.ts b/clients/client-guardduty/commands/CreateSampleFindingsCommand.ts index e67f6538fc99..b21b448f727a 100644 --- a/clients/client-guardduty/commands/CreateSampleFindingsCommand.ts +++ b/clients/client-guardduty/commands/CreateSampleFindingsCommand.ts @@ -24,6 +24,20 @@ export interface CreateSampleFindingsCommandOutput extends CreateSampleFindingsR *

Generates example findings of types specified by the list of finding types. If 'NULL' is * specified for findingTypes, the API generates example findings of all supported * finding types.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { GuardDutyClient, CreateSampleFindingsCommand } from "@aws-sdk/client-guardduty"; // ES Modules import + * // const { GuardDutyClient, CreateSampleFindingsCommand } = require("@aws-sdk/client-guardduty"); // CommonJS import + * const client = new GuardDutyClient(config); + * const command = new CreateSampleFindingsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreateSampleFindingsCommandInput} for command's `input` shape. + * @see {@link CreateSampleFindingsCommandOutput} for command's `response` shape. + * @see {@link GuardDutyClientResolvedConfig | config} for command's `input` shape. + * */ export class CreateSampleFindingsCommand extends $Command< CreateSampleFindingsCommandInput, diff --git a/clients/client-guardduty/commands/CreateThreatIntelSetCommand.ts b/clients/client-guardduty/commands/CreateThreatIntelSetCommand.ts index 9793eb762309..06e83373d9e3 100644 --- a/clients/client-guardduty/commands/CreateThreatIntelSetCommand.ts +++ b/clients/client-guardduty/commands/CreateThreatIntelSetCommand.ts @@ -24,6 +24,20 @@ export interface CreateThreatIntelSetCommandOutput extends CreateThreatIntelSetR *

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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { GuardDutyClient, CreateThreatIntelSetCommand } from "@aws-sdk/client-guardduty"; // ES Modules import + * // const { GuardDutyClient, CreateThreatIntelSetCommand } = require("@aws-sdk/client-guardduty"); // CommonJS import + * const client = new GuardDutyClient(config); + * const command = new CreateThreatIntelSetCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreateThreatIntelSetCommandInput} for command's `input` shape. + * @see {@link CreateThreatIntelSetCommandOutput} for command's `response` shape. + * @see {@link GuardDutyClientResolvedConfig | config} for command's `input` shape. + * */ export class CreateThreatIntelSetCommand extends $Command< CreateThreatIntelSetCommandInput, diff --git a/clients/client-guardduty/commands/DeclineInvitationsCommand.ts b/clients/client-guardduty/commands/DeclineInvitationsCommand.ts index a0f2db09e83c..1c88baa2223d 100644 --- a/clients/client-guardduty/commands/DeclineInvitationsCommand.ts +++ b/clients/client-guardduty/commands/DeclineInvitationsCommand.ts @@ -23,6 +23,20 @@ export interface DeclineInvitationsCommandOutput extends DeclineInvitationsRespo /** *

Declines invitations sent to the current member account by AWS accounts specified by their * account IDs.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { GuardDutyClient, DeclineInvitationsCommand } from "@aws-sdk/client-guardduty"; // ES Modules import + * // const { GuardDutyClient, DeclineInvitationsCommand } = require("@aws-sdk/client-guardduty"); // CommonJS import + * const client = new GuardDutyClient(config); + * const command = new DeclineInvitationsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeclineInvitationsCommandInput} for command's `input` shape. + * @see {@link DeclineInvitationsCommandOutput} for command's `response` shape. + * @see {@link GuardDutyClientResolvedConfig | config} for command's `input` shape. + * */ export class DeclineInvitationsCommand extends $Command< DeclineInvitationsCommandInput, diff --git a/clients/client-guardduty/commands/DeleteDetectorCommand.ts b/clients/client-guardduty/commands/DeleteDetectorCommand.ts index fc9b74355eae..cd0acc8b61f1 100644 --- a/clients/client-guardduty/commands/DeleteDetectorCommand.ts +++ b/clients/client-guardduty/commands/DeleteDetectorCommand.ts @@ -22,6 +22,20 @@ export interface DeleteDetectorCommandOutput extends DeleteDetectorResponse, __M /** *

Deletes an Amazon GuardDuty detector that is specified by the detector ID.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { GuardDutyClient, DeleteDetectorCommand } from "@aws-sdk/client-guardduty"; // ES Modules import + * // const { GuardDutyClient, DeleteDetectorCommand } = require("@aws-sdk/client-guardduty"); // CommonJS import + * const client = new GuardDutyClient(config); + * const command = new DeleteDetectorCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteDetectorCommandInput} for command's `input` shape. + * @see {@link DeleteDetectorCommandOutput} for command's `response` shape. + * @see {@link GuardDutyClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteDetectorCommand extends $Command< DeleteDetectorCommandInput, diff --git a/clients/client-guardduty/commands/DeleteFilterCommand.ts b/clients/client-guardduty/commands/DeleteFilterCommand.ts index b86cbf03bb32..31cbdd12ba62 100644 --- a/clients/client-guardduty/commands/DeleteFilterCommand.ts +++ b/clients/client-guardduty/commands/DeleteFilterCommand.ts @@ -22,6 +22,20 @@ export interface DeleteFilterCommandOutput extends DeleteFilterResponse, __Metad /** *

Deletes the filter specified by the filter name.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { GuardDutyClient, DeleteFilterCommand } from "@aws-sdk/client-guardduty"; // ES Modules import + * // const { GuardDutyClient, DeleteFilterCommand } = require("@aws-sdk/client-guardduty"); // CommonJS import + * const client = new GuardDutyClient(config); + * const command = new DeleteFilterCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteFilterCommandInput} for command's `input` shape. + * @see {@link DeleteFilterCommandOutput} for command's `response` shape. + * @see {@link GuardDutyClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteFilterCommand extends $Command< DeleteFilterCommandInput, diff --git a/clients/client-guardduty/commands/DeleteIPSetCommand.ts b/clients/client-guardduty/commands/DeleteIPSetCommand.ts index 9c359ffc68ad..cdc9a01cdd18 100644 --- a/clients/client-guardduty/commands/DeleteIPSetCommand.ts +++ b/clients/client-guardduty/commands/DeleteIPSetCommand.ts @@ -23,6 +23,20 @@ export interface DeleteIPSetCommandOutput extends DeleteIPSetResponse, __Metadat /** *

Deletes the IPSet specified by the ipSetId. IPSets are called trusted IP * lists in the console user interface.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { GuardDutyClient, DeleteIPSetCommand } from "@aws-sdk/client-guardduty"; // ES Modules import + * // const { GuardDutyClient, DeleteIPSetCommand } = require("@aws-sdk/client-guardduty"); // CommonJS import + * const client = new GuardDutyClient(config); + * const command = new DeleteIPSetCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteIPSetCommandInput} for command's `input` shape. + * @see {@link DeleteIPSetCommandOutput} for command's `response` shape. + * @see {@link GuardDutyClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteIPSetCommand extends $Command< DeleteIPSetCommandInput, diff --git a/clients/client-guardduty/commands/DeleteInvitationsCommand.ts b/clients/client-guardduty/commands/DeleteInvitationsCommand.ts index cb444031704c..5b8a9b13d2cb 100644 --- a/clients/client-guardduty/commands/DeleteInvitationsCommand.ts +++ b/clients/client-guardduty/commands/DeleteInvitationsCommand.ts @@ -23,6 +23,20 @@ export interface DeleteInvitationsCommandOutput extends DeleteInvitationsRespons /** *

Deletes invitations sent to the current member account by AWS accounts specified by their * account IDs.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { GuardDutyClient, DeleteInvitationsCommand } from "@aws-sdk/client-guardduty"; // ES Modules import + * // const { GuardDutyClient, DeleteInvitationsCommand } = require("@aws-sdk/client-guardduty"); // CommonJS import + * const client = new GuardDutyClient(config); + * const command = new DeleteInvitationsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteInvitationsCommandInput} for command's `input` shape. + * @see {@link DeleteInvitationsCommandOutput} for command's `response` shape. + * @see {@link GuardDutyClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteInvitationsCommand extends $Command< DeleteInvitationsCommandInput, diff --git a/clients/client-guardduty/commands/DeleteMembersCommand.ts b/clients/client-guardduty/commands/DeleteMembersCommand.ts index 481671d316b5..6a7a0e94f4f1 100644 --- a/clients/client-guardduty/commands/DeleteMembersCommand.ts +++ b/clients/client-guardduty/commands/DeleteMembersCommand.ts @@ -23,6 +23,20 @@ export interface DeleteMembersCommandOutput extends DeleteMembersResponse, __Met /** *

Deletes GuardDuty member accounts (to the current GuardDuty administrator account) specified by * the account IDs.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { GuardDutyClient, DeleteMembersCommand } from "@aws-sdk/client-guardduty"; // ES Modules import + * // const { GuardDutyClient, DeleteMembersCommand } = require("@aws-sdk/client-guardduty"); // CommonJS import + * const client = new GuardDutyClient(config); + * const command = new DeleteMembersCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteMembersCommandInput} for command's `input` shape. + * @see {@link DeleteMembersCommandOutput} for command's `response` shape. + * @see {@link GuardDutyClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteMembersCommand extends $Command< DeleteMembersCommandInput, diff --git a/clients/client-guardduty/commands/DeletePublishingDestinationCommand.ts b/clients/client-guardduty/commands/DeletePublishingDestinationCommand.ts index eb4b82802984..bd25a418dff4 100644 --- a/clients/client-guardduty/commands/DeletePublishingDestinationCommand.ts +++ b/clients/client-guardduty/commands/DeletePublishingDestinationCommand.ts @@ -24,6 +24,20 @@ export interface DeletePublishingDestinationCommandOutput /** *

Deletes the publishing definition with the specified destinationId.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { GuardDutyClient, DeletePublishingDestinationCommand } from "@aws-sdk/client-guardduty"; // ES Modules import + * // const { GuardDutyClient, DeletePublishingDestinationCommand } = require("@aws-sdk/client-guardduty"); // CommonJS import + * const client = new GuardDutyClient(config); + * const command = new DeletePublishingDestinationCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeletePublishingDestinationCommandInput} for command's `input` shape. + * @see {@link DeletePublishingDestinationCommandOutput} for command's `response` shape. + * @see {@link GuardDutyClientResolvedConfig | config} for command's `input` shape. + * */ export class DeletePublishingDestinationCommand extends $Command< DeletePublishingDestinationCommandInput, diff --git a/clients/client-guardduty/commands/DeleteThreatIntelSetCommand.ts b/clients/client-guardduty/commands/DeleteThreatIntelSetCommand.ts index 3d8ae54125b1..dee8d434d0b4 100644 --- a/clients/client-guardduty/commands/DeleteThreatIntelSetCommand.ts +++ b/clients/client-guardduty/commands/DeleteThreatIntelSetCommand.ts @@ -22,6 +22,20 @@ export interface DeleteThreatIntelSetCommandOutput extends DeleteThreatIntelSetR /** *

Deletes the ThreatIntelSet specified by the ThreatIntelSet ID.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { GuardDutyClient, DeleteThreatIntelSetCommand } from "@aws-sdk/client-guardduty"; // ES Modules import + * // const { GuardDutyClient, DeleteThreatIntelSetCommand } = require("@aws-sdk/client-guardduty"); // CommonJS import + * const client = new GuardDutyClient(config); + * const command = new DeleteThreatIntelSetCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteThreatIntelSetCommandInput} for command's `input` shape. + * @see {@link DeleteThreatIntelSetCommandOutput} for command's `response` shape. + * @see {@link GuardDutyClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteThreatIntelSetCommand extends $Command< DeleteThreatIntelSetCommandInput, diff --git a/clients/client-guardduty/commands/DescribeOrganizationConfigurationCommand.ts b/clients/client-guardduty/commands/DescribeOrganizationConfigurationCommand.ts index 205634abeb2a..aad028aadfef 100644 --- a/clients/client-guardduty/commands/DescribeOrganizationConfigurationCommand.ts +++ b/clients/client-guardduty/commands/DescribeOrganizationConfigurationCommand.ts @@ -28,6 +28,20 @@ export interface DescribeOrganizationConfigurationCommandOutput /** *

Returns information about the account selected as the delegated administrator for * GuardDuty.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { GuardDutyClient, DescribeOrganizationConfigurationCommand } from "@aws-sdk/client-guardduty"; // ES Modules import + * // const { GuardDutyClient, DescribeOrganizationConfigurationCommand } = require("@aws-sdk/client-guardduty"); // CommonJS import + * const client = new GuardDutyClient(config); + * const command = new DescribeOrganizationConfigurationCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeOrganizationConfigurationCommandInput} for command's `input` shape. + * @see {@link DescribeOrganizationConfigurationCommandOutput} for command's `response` shape. + * @see {@link GuardDutyClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeOrganizationConfigurationCommand extends $Command< DescribeOrganizationConfigurationCommandInput, diff --git a/clients/client-guardduty/commands/DescribePublishingDestinationCommand.ts b/clients/client-guardduty/commands/DescribePublishingDestinationCommand.ts index e040fd64672b..92c67bde26d8 100644 --- a/clients/client-guardduty/commands/DescribePublishingDestinationCommand.ts +++ b/clients/client-guardduty/commands/DescribePublishingDestinationCommand.ts @@ -25,6 +25,20 @@ export interface DescribePublishingDestinationCommandOutput /** *

Returns information about the publishing destination specified by the provided * destinationId.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { GuardDutyClient, DescribePublishingDestinationCommand } from "@aws-sdk/client-guardduty"; // ES Modules import + * // const { GuardDutyClient, DescribePublishingDestinationCommand } = require("@aws-sdk/client-guardduty"); // CommonJS import + * const client = new GuardDutyClient(config); + * const command = new DescribePublishingDestinationCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribePublishingDestinationCommandInput} for command's `input` shape. + * @see {@link DescribePublishingDestinationCommandOutput} for command's `response` shape. + * @see {@link GuardDutyClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribePublishingDestinationCommand extends $Command< DescribePublishingDestinationCommandInput, diff --git a/clients/client-guardduty/commands/DisableOrganizationAdminAccountCommand.ts b/clients/client-guardduty/commands/DisableOrganizationAdminAccountCommand.ts index 9bd776b86ab1..708344fc6e6c 100644 --- a/clients/client-guardduty/commands/DisableOrganizationAdminAccountCommand.ts +++ b/clients/client-guardduty/commands/DisableOrganizationAdminAccountCommand.ts @@ -25,6 +25,20 @@ export interface DisableOrganizationAdminAccountCommandOutput /** *

Disables an AWS account within the Organization as the GuardDuty delegated * administrator.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { GuardDutyClient, DisableOrganizationAdminAccountCommand } from "@aws-sdk/client-guardduty"; // ES Modules import + * // const { GuardDutyClient, DisableOrganizationAdminAccountCommand } = require("@aws-sdk/client-guardduty"); // CommonJS import + * const client = new GuardDutyClient(config); + * const command = new DisableOrganizationAdminAccountCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DisableOrganizationAdminAccountCommandInput} for command's `input` shape. + * @see {@link DisableOrganizationAdminAccountCommandOutput} for command's `response` shape. + * @see {@link GuardDutyClientResolvedConfig | config} for command's `input` shape. + * */ export class DisableOrganizationAdminAccountCommand extends $Command< DisableOrganizationAdminAccountCommandInput, diff --git a/clients/client-guardduty/commands/DisassociateFromMasterAccountCommand.ts b/clients/client-guardduty/commands/DisassociateFromMasterAccountCommand.ts index 69917f420a92..b834f7b8a07c 100644 --- a/clients/client-guardduty/commands/DisassociateFromMasterAccountCommand.ts +++ b/clients/client-guardduty/commands/DisassociateFromMasterAccountCommand.ts @@ -24,6 +24,20 @@ export interface DisassociateFromMasterAccountCommandOutput /** *

Disassociates the current GuardDuty member account from its administrator account.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { GuardDutyClient, DisassociateFromMasterAccountCommand } from "@aws-sdk/client-guardduty"; // ES Modules import + * // const { GuardDutyClient, DisassociateFromMasterAccountCommand } = require("@aws-sdk/client-guardduty"); // CommonJS import + * const client = new GuardDutyClient(config); + * const command = new DisassociateFromMasterAccountCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DisassociateFromMasterAccountCommandInput} for command's `input` shape. + * @see {@link DisassociateFromMasterAccountCommandOutput} for command's `response` shape. + * @see {@link GuardDutyClientResolvedConfig | config} for command's `input` shape. + * */ export class DisassociateFromMasterAccountCommand extends $Command< DisassociateFromMasterAccountCommandInput, diff --git a/clients/client-guardduty/commands/DisassociateMembersCommand.ts b/clients/client-guardduty/commands/DisassociateMembersCommand.ts index fc7be542fa34..d37139a2e164 100644 --- a/clients/client-guardduty/commands/DisassociateMembersCommand.ts +++ b/clients/client-guardduty/commands/DisassociateMembersCommand.ts @@ -23,6 +23,20 @@ export interface DisassociateMembersCommandOutput extends DisassociateMembersRes /** *

Disassociates GuardDuty member accounts (to the current GuardDuty administrator account) * specified by the account IDs.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { GuardDutyClient, DisassociateMembersCommand } from "@aws-sdk/client-guardduty"; // ES Modules import + * // const { GuardDutyClient, DisassociateMembersCommand } = require("@aws-sdk/client-guardduty"); // CommonJS import + * const client = new GuardDutyClient(config); + * const command = new DisassociateMembersCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DisassociateMembersCommandInput} for command's `input` shape. + * @see {@link DisassociateMembersCommandOutput} for command's `response` shape. + * @see {@link GuardDutyClientResolvedConfig | config} for command's `input` shape. + * */ export class DisassociateMembersCommand extends $Command< DisassociateMembersCommandInput, diff --git a/clients/client-guardduty/commands/EnableOrganizationAdminAccountCommand.ts b/clients/client-guardduty/commands/EnableOrganizationAdminAccountCommand.ts index ac89ad37b54c..5ff7dac81d36 100644 --- a/clients/client-guardduty/commands/EnableOrganizationAdminAccountCommand.ts +++ b/clients/client-guardduty/commands/EnableOrganizationAdminAccountCommand.ts @@ -25,6 +25,20 @@ export interface EnableOrganizationAdminAccountCommandOutput /** *

Enables an AWS account within the organization as the GuardDuty delegated * administrator.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { GuardDutyClient, EnableOrganizationAdminAccountCommand } from "@aws-sdk/client-guardduty"; // ES Modules import + * // const { GuardDutyClient, EnableOrganizationAdminAccountCommand } = require("@aws-sdk/client-guardduty"); // CommonJS import + * const client = new GuardDutyClient(config); + * const command = new EnableOrganizationAdminAccountCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link EnableOrganizationAdminAccountCommandInput} for command's `input` shape. + * @see {@link EnableOrganizationAdminAccountCommandOutput} for command's `response` shape. + * @see {@link GuardDutyClientResolvedConfig | config} for command's `input` shape. + * */ export class EnableOrganizationAdminAccountCommand extends $Command< EnableOrganizationAdminAccountCommandInput, diff --git a/clients/client-guardduty/commands/GetDetectorCommand.ts b/clients/client-guardduty/commands/GetDetectorCommand.ts index 3ce101053644..5f7fd81b08cc 100644 --- a/clients/client-guardduty/commands/GetDetectorCommand.ts +++ b/clients/client-guardduty/commands/GetDetectorCommand.ts @@ -22,6 +22,20 @@ export interface GetDetectorCommandOutput extends GetDetectorResponse, __Metadat /** *

Retrieves an Amazon GuardDuty detector specified by the detectorId.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { GuardDutyClient, GetDetectorCommand } from "@aws-sdk/client-guardduty"; // ES Modules import + * // const { GuardDutyClient, GetDetectorCommand } = require("@aws-sdk/client-guardduty"); // CommonJS import + * const client = new GuardDutyClient(config); + * const command = new GetDetectorCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetDetectorCommandInput} for command's `input` shape. + * @see {@link GetDetectorCommandOutput} for command's `response` shape. + * @see {@link GuardDutyClientResolvedConfig | config} for command's `input` shape. + * */ export class GetDetectorCommand extends $Command< GetDetectorCommandInput, diff --git a/clients/client-guardduty/commands/GetFilterCommand.ts b/clients/client-guardduty/commands/GetFilterCommand.ts index 574059bc4d5c..442bcbaa3695 100644 --- a/clients/client-guardduty/commands/GetFilterCommand.ts +++ b/clients/client-guardduty/commands/GetFilterCommand.ts @@ -22,6 +22,20 @@ export interface GetFilterCommandOutput extends GetFilterResponse, __MetadataBea /** *

Returns the details of the filter specified by the filter name.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { GuardDutyClient, GetFilterCommand } from "@aws-sdk/client-guardduty"; // ES Modules import + * // const { GuardDutyClient, GetFilterCommand } = require("@aws-sdk/client-guardduty"); // CommonJS import + * const client = new GuardDutyClient(config); + * const command = new GetFilterCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetFilterCommandInput} for command's `input` shape. + * @see {@link GetFilterCommandOutput} for command's `response` shape. + * @see {@link GuardDutyClientResolvedConfig | config} for command's `input` shape. + * */ export class GetFilterCommand extends $Command< GetFilterCommandInput, diff --git a/clients/client-guardduty/commands/GetFindingsCommand.ts b/clients/client-guardduty/commands/GetFindingsCommand.ts index b7f0807e5393..2e04d47101e9 100644 --- a/clients/client-guardduty/commands/GetFindingsCommand.ts +++ b/clients/client-guardduty/commands/GetFindingsCommand.ts @@ -22,6 +22,20 @@ export interface GetFindingsCommandOutput extends GetFindingsResponse, __Metadat /** *

Describes Amazon GuardDuty findings specified by finding IDs.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { GuardDutyClient, GetFindingsCommand } from "@aws-sdk/client-guardduty"; // ES Modules import + * // const { GuardDutyClient, GetFindingsCommand } = require("@aws-sdk/client-guardduty"); // CommonJS import + * const client = new GuardDutyClient(config); + * const command = new GetFindingsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetFindingsCommandInput} for command's `input` shape. + * @see {@link GetFindingsCommandOutput} for command's `response` shape. + * @see {@link GuardDutyClientResolvedConfig | config} for command's `input` shape. + * */ export class GetFindingsCommand extends $Command< GetFindingsCommandInput, diff --git a/clients/client-guardduty/commands/GetFindingsStatisticsCommand.ts b/clients/client-guardduty/commands/GetFindingsStatisticsCommand.ts index 34d74270e41e..1b7e3c6ef0ca 100644 --- a/clients/client-guardduty/commands/GetFindingsStatisticsCommand.ts +++ b/clients/client-guardduty/commands/GetFindingsStatisticsCommand.ts @@ -22,6 +22,20 @@ export interface GetFindingsStatisticsCommandOutput extends GetFindingsStatistic /** *

Lists Amazon GuardDuty findings statistics for the specified detector ID.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { GuardDutyClient, GetFindingsStatisticsCommand } from "@aws-sdk/client-guardduty"; // ES Modules import + * // const { GuardDutyClient, GetFindingsStatisticsCommand } = require("@aws-sdk/client-guardduty"); // CommonJS import + * const client = new GuardDutyClient(config); + * const command = new GetFindingsStatisticsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetFindingsStatisticsCommandInput} for command's `input` shape. + * @see {@link GetFindingsStatisticsCommandOutput} for command's `response` shape. + * @see {@link GuardDutyClientResolvedConfig | config} for command's `input` shape. + * */ export class GetFindingsStatisticsCommand extends $Command< GetFindingsStatisticsCommandInput, diff --git a/clients/client-guardduty/commands/GetIPSetCommand.ts b/clients/client-guardduty/commands/GetIPSetCommand.ts index f94815f7e7e7..531837bcc3b3 100644 --- a/clients/client-guardduty/commands/GetIPSetCommand.ts +++ b/clients/client-guardduty/commands/GetIPSetCommand.ts @@ -22,6 +22,20 @@ export interface GetIPSetCommandOutput extends GetIPSetResponse, __MetadataBeare /** *

Retrieves the IPSet specified by the ipSetId.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { GuardDutyClient, GetIPSetCommand } from "@aws-sdk/client-guardduty"; // ES Modules import + * // const { GuardDutyClient, GetIPSetCommand } = require("@aws-sdk/client-guardduty"); // CommonJS import + * const client = new GuardDutyClient(config); + * const command = new GetIPSetCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetIPSetCommandInput} for command's `input` shape. + * @see {@link GetIPSetCommandOutput} for command's `response` shape. + * @see {@link GuardDutyClientResolvedConfig | config} for command's `input` shape. + * */ export class GetIPSetCommand extends $Command< GetIPSetCommandInput, diff --git a/clients/client-guardduty/commands/GetInvitationsCountCommand.ts b/clients/client-guardduty/commands/GetInvitationsCountCommand.ts index 1e56f6ee0a64..f8ce74fce7dd 100644 --- a/clients/client-guardduty/commands/GetInvitationsCountCommand.ts +++ b/clients/client-guardduty/commands/GetInvitationsCountCommand.ts @@ -23,6 +23,20 @@ export interface GetInvitationsCountCommandOutput extends GetInvitationsCountRes /** *

Returns the count of all GuardDuty membership invitations that were sent to the current * member account except the currently accepted invitation.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { GuardDutyClient, GetInvitationsCountCommand } from "@aws-sdk/client-guardduty"; // ES Modules import + * // const { GuardDutyClient, GetInvitationsCountCommand } = require("@aws-sdk/client-guardduty"); // CommonJS import + * const client = new GuardDutyClient(config); + * const command = new GetInvitationsCountCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetInvitationsCountCommandInput} for command's `input` shape. + * @see {@link GetInvitationsCountCommandOutput} for command's `response` shape. + * @see {@link GuardDutyClientResolvedConfig | config} for command's `input` shape. + * */ export class GetInvitationsCountCommand extends $Command< GetInvitationsCountCommandInput, diff --git a/clients/client-guardduty/commands/GetMasterAccountCommand.ts b/clients/client-guardduty/commands/GetMasterAccountCommand.ts index bcd0b45527cb..ddadb30b01c0 100644 --- a/clients/client-guardduty/commands/GetMasterAccountCommand.ts +++ b/clients/client-guardduty/commands/GetMasterAccountCommand.ts @@ -23,6 +23,20 @@ export interface GetMasterAccountCommandOutput extends GetMasterAccountResponse, /** *

Provides the details for the GuardDuty administrator account associated with the current * GuardDuty member account.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { GuardDutyClient, GetMasterAccountCommand } from "@aws-sdk/client-guardduty"; // ES Modules import + * // const { GuardDutyClient, GetMasterAccountCommand } = require("@aws-sdk/client-guardduty"); // CommonJS import + * const client = new GuardDutyClient(config); + * const command = new GetMasterAccountCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetMasterAccountCommandInput} for command's `input` shape. + * @see {@link GetMasterAccountCommandOutput} for command's `response` shape. + * @see {@link GuardDutyClientResolvedConfig | config} for command's `input` shape. + * */ export class GetMasterAccountCommand extends $Command< GetMasterAccountCommandInput, diff --git a/clients/client-guardduty/commands/GetMemberDetectorsCommand.ts b/clients/client-guardduty/commands/GetMemberDetectorsCommand.ts index 0588919dfff6..e2e80333768f 100644 --- a/clients/client-guardduty/commands/GetMemberDetectorsCommand.ts +++ b/clients/client-guardduty/commands/GetMemberDetectorsCommand.ts @@ -22,6 +22,20 @@ export interface GetMemberDetectorsCommandOutput extends GetMemberDetectorsRespo /** *

Describes which data sources are enabled for the member account's detector.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { GuardDutyClient, GetMemberDetectorsCommand } from "@aws-sdk/client-guardduty"; // ES Modules import + * // const { GuardDutyClient, GetMemberDetectorsCommand } = require("@aws-sdk/client-guardduty"); // CommonJS import + * const client = new GuardDutyClient(config); + * const command = new GetMemberDetectorsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetMemberDetectorsCommandInput} for command's `input` shape. + * @see {@link GetMemberDetectorsCommandOutput} for command's `response` shape. + * @see {@link GuardDutyClientResolvedConfig | config} for command's `input` shape. + * */ export class GetMemberDetectorsCommand extends $Command< GetMemberDetectorsCommandInput, diff --git a/clients/client-guardduty/commands/GetMembersCommand.ts b/clients/client-guardduty/commands/GetMembersCommand.ts index a7f5479eee67..5218d431549d 100644 --- a/clients/client-guardduty/commands/GetMembersCommand.ts +++ b/clients/client-guardduty/commands/GetMembersCommand.ts @@ -23,6 +23,20 @@ export interface GetMembersCommandOutput extends GetMembersResponse, __MetadataB /** *

Retrieves GuardDuty member accounts (of the current GuardDuty administrator account) specified by * the account IDs.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { GuardDutyClient, GetMembersCommand } from "@aws-sdk/client-guardduty"; // ES Modules import + * // const { GuardDutyClient, GetMembersCommand } = require("@aws-sdk/client-guardduty"); // CommonJS import + * const client = new GuardDutyClient(config); + * const command = new GetMembersCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetMembersCommandInput} for command's `input` shape. + * @see {@link GetMembersCommandOutput} for command's `response` shape. + * @see {@link GuardDutyClientResolvedConfig | config} for command's `input` shape. + * */ export class GetMembersCommand extends $Command< GetMembersCommandInput, diff --git a/clients/client-guardduty/commands/GetThreatIntelSetCommand.ts b/clients/client-guardduty/commands/GetThreatIntelSetCommand.ts index dd8e016cf505..f8234dfd883e 100644 --- a/clients/client-guardduty/commands/GetThreatIntelSetCommand.ts +++ b/clients/client-guardduty/commands/GetThreatIntelSetCommand.ts @@ -22,6 +22,20 @@ export interface GetThreatIntelSetCommandOutput extends GetThreatIntelSetRespons /** *

Retrieves the ThreatIntelSet that is specified by the ThreatIntelSet ID.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { GuardDutyClient, GetThreatIntelSetCommand } from "@aws-sdk/client-guardduty"; // ES Modules import + * // const { GuardDutyClient, GetThreatIntelSetCommand } = require("@aws-sdk/client-guardduty"); // CommonJS import + * const client = new GuardDutyClient(config); + * const command = new GetThreatIntelSetCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetThreatIntelSetCommandInput} for command's `input` shape. + * @see {@link GetThreatIntelSetCommandOutput} for command's `response` shape. + * @see {@link GuardDutyClientResolvedConfig | config} for command's `input` shape. + * */ export class GetThreatIntelSetCommand extends $Command< GetThreatIntelSetCommandInput, diff --git a/clients/client-guardduty/commands/GetUsageStatisticsCommand.ts b/clients/client-guardduty/commands/GetUsageStatisticsCommand.ts index 6615f08effbd..165e19f8b19a 100644 --- a/clients/client-guardduty/commands/GetUsageStatisticsCommand.ts +++ b/clients/client-guardduty/commands/GetUsageStatisticsCommand.ts @@ -25,6 +25,20 @@ export interface GetUsageStatisticsCommandOutput extends GetUsageStatisticsRespo * 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 projects * usage over 30 days to provide a monthly cost estimate. For more information see Understanding How Usage Costs are Calculated.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { GuardDutyClient, GetUsageStatisticsCommand } from "@aws-sdk/client-guardduty"; // ES Modules import + * // const { GuardDutyClient, GetUsageStatisticsCommand } = require("@aws-sdk/client-guardduty"); // CommonJS import + * const client = new GuardDutyClient(config); + * const command = new GetUsageStatisticsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetUsageStatisticsCommandInput} for command's `input` shape. + * @see {@link GetUsageStatisticsCommandOutput} for command's `response` shape. + * @see {@link GuardDutyClientResolvedConfig | config} for command's `input` shape. + * */ export class GetUsageStatisticsCommand extends $Command< GetUsageStatisticsCommandInput, diff --git a/clients/client-guardduty/commands/InviteMembersCommand.ts b/clients/client-guardduty/commands/InviteMembersCommand.ts index 855d1410dcd8..4ac8ca896dcc 100644 --- a/clients/client-guardduty/commands/InviteMembersCommand.ts +++ b/clients/client-guardduty/commands/InviteMembersCommand.ts @@ -24,6 +24,20 @@ export interface InviteMembersCommandOutput extends InviteMembersResponse, __Met *

Invites other AWS accounts (created as members of the current AWS account by * CreateMembers) to enable GuardDuty, and allow the current AWS account to view and manage these * accounts' findings on their behalf as the GuardDuty administrator account.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { GuardDutyClient, InviteMembersCommand } from "@aws-sdk/client-guardduty"; // ES Modules import + * // const { GuardDutyClient, InviteMembersCommand } = require("@aws-sdk/client-guardduty"); // CommonJS import + * const client = new GuardDutyClient(config); + * const command = new InviteMembersCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link InviteMembersCommandInput} for command's `input` shape. + * @see {@link InviteMembersCommandOutput} for command's `response` shape. + * @see {@link GuardDutyClientResolvedConfig | config} for command's `input` shape. + * */ export class InviteMembersCommand extends $Command< InviteMembersCommandInput, diff --git a/clients/client-guardduty/commands/ListDetectorsCommand.ts b/clients/client-guardduty/commands/ListDetectorsCommand.ts index 29425c0d2a36..9d38ba4954dc 100644 --- a/clients/client-guardduty/commands/ListDetectorsCommand.ts +++ b/clients/client-guardduty/commands/ListDetectorsCommand.ts @@ -22,6 +22,20 @@ export interface ListDetectorsCommandOutput extends ListDetectorsResponse, __Met /** *

Lists detectorIds of all the existing Amazon GuardDuty detector resources.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { GuardDutyClient, ListDetectorsCommand } from "@aws-sdk/client-guardduty"; // ES Modules import + * // const { GuardDutyClient, ListDetectorsCommand } = require("@aws-sdk/client-guardduty"); // CommonJS import + * const client = new GuardDutyClient(config); + * const command = new ListDetectorsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListDetectorsCommandInput} for command's `input` shape. + * @see {@link ListDetectorsCommandOutput} for command's `response` shape. + * @see {@link GuardDutyClientResolvedConfig | config} for command's `input` shape. + * */ export class ListDetectorsCommand extends $Command< ListDetectorsCommandInput, diff --git a/clients/client-guardduty/commands/ListFiltersCommand.ts b/clients/client-guardduty/commands/ListFiltersCommand.ts index 0f21d26a8340..3a17fee06a8a 100644 --- a/clients/client-guardduty/commands/ListFiltersCommand.ts +++ b/clients/client-guardduty/commands/ListFiltersCommand.ts @@ -22,6 +22,20 @@ export interface ListFiltersCommandOutput extends ListFiltersResponse, __Metadat /** *

Returns a paginated list of the current filters.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { GuardDutyClient, ListFiltersCommand } from "@aws-sdk/client-guardduty"; // ES Modules import + * // const { GuardDutyClient, ListFiltersCommand } = require("@aws-sdk/client-guardduty"); // CommonJS import + * const client = new GuardDutyClient(config); + * const command = new ListFiltersCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListFiltersCommandInput} for command's `input` shape. + * @see {@link ListFiltersCommandOutput} for command's `response` shape. + * @see {@link GuardDutyClientResolvedConfig | config} for command's `input` shape. + * */ export class ListFiltersCommand extends $Command< ListFiltersCommandInput, diff --git a/clients/client-guardduty/commands/ListFindingsCommand.ts b/clients/client-guardduty/commands/ListFindingsCommand.ts index 2f06339a2898..0c8ac72cfb30 100644 --- a/clients/client-guardduty/commands/ListFindingsCommand.ts +++ b/clients/client-guardduty/commands/ListFindingsCommand.ts @@ -22,6 +22,20 @@ export interface ListFindingsCommandOutput extends ListFindingsResponse, __Metad /** *

Lists Amazon GuardDuty findings for the specified detector ID.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { GuardDutyClient, ListFindingsCommand } from "@aws-sdk/client-guardduty"; // ES Modules import + * // const { GuardDutyClient, ListFindingsCommand } = require("@aws-sdk/client-guardduty"); // CommonJS import + * const client = new GuardDutyClient(config); + * const command = new ListFindingsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListFindingsCommandInput} for command's `input` shape. + * @see {@link ListFindingsCommandOutput} for command's `response` shape. + * @see {@link GuardDutyClientResolvedConfig | config} for command's `input` shape. + * */ export class ListFindingsCommand extends $Command< ListFindingsCommandInput, diff --git a/clients/client-guardduty/commands/ListIPSetsCommand.ts b/clients/client-guardduty/commands/ListIPSetsCommand.ts index 683a937efa82..528d33cad32b 100644 --- a/clients/client-guardduty/commands/ListIPSetsCommand.ts +++ b/clients/client-guardduty/commands/ListIPSetsCommand.ts @@ -24,6 +24,20 @@ export interface ListIPSetsCommandOutput extends ListIPSetsResponse, __MetadataB *

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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { GuardDutyClient, ListIPSetsCommand } from "@aws-sdk/client-guardduty"; // ES Modules import + * // const { GuardDutyClient, ListIPSetsCommand } = require("@aws-sdk/client-guardduty"); // CommonJS import + * const client = new GuardDutyClient(config); + * const command = new ListIPSetsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListIPSetsCommandInput} for command's `input` shape. + * @see {@link ListIPSetsCommandOutput} for command's `response` shape. + * @see {@link GuardDutyClientResolvedConfig | config} for command's `input` shape. + * */ export class ListIPSetsCommand extends $Command< ListIPSetsCommandInput, diff --git a/clients/client-guardduty/commands/ListInvitationsCommand.ts b/clients/client-guardduty/commands/ListInvitationsCommand.ts index 3cb67061fe62..d6ffaf9c5008 100644 --- a/clients/client-guardduty/commands/ListInvitationsCommand.ts +++ b/clients/client-guardduty/commands/ListInvitationsCommand.ts @@ -23,6 +23,20 @@ export interface ListInvitationsCommandOutput extends ListInvitationsResponse, _ /** *

Lists all GuardDuty membership invitations that were sent to the current AWS * account.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { GuardDutyClient, ListInvitationsCommand } from "@aws-sdk/client-guardduty"; // ES Modules import + * // const { GuardDutyClient, ListInvitationsCommand } = require("@aws-sdk/client-guardduty"); // CommonJS import + * const client = new GuardDutyClient(config); + * const command = new ListInvitationsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListInvitationsCommandInput} for command's `input` shape. + * @see {@link ListInvitationsCommandOutput} for command's `response` shape. + * @see {@link GuardDutyClientResolvedConfig | config} for command's `input` shape. + * */ export class ListInvitationsCommand extends $Command< ListInvitationsCommandInput, diff --git a/clients/client-guardduty/commands/ListMembersCommand.ts b/clients/client-guardduty/commands/ListMembersCommand.ts index f1909c80966f..ffb365b1d1cc 100644 --- a/clients/client-guardduty/commands/ListMembersCommand.ts +++ b/clients/client-guardduty/commands/ListMembersCommand.ts @@ -22,6 +22,20 @@ export interface ListMembersCommandOutput extends ListMembersResponse, __Metadat /** *

Lists details about all member accounts for the current GuardDuty administrator account.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { GuardDutyClient, ListMembersCommand } from "@aws-sdk/client-guardduty"; // ES Modules import + * // const { GuardDutyClient, ListMembersCommand } = require("@aws-sdk/client-guardduty"); // CommonJS import + * const client = new GuardDutyClient(config); + * const command = new ListMembersCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListMembersCommandInput} for command's `input` shape. + * @see {@link ListMembersCommandOutput} for command's `response` shape. + * @see {@link GuardDutyClientResolvedConfig | config} for command's `input` shape. + * */ export class ListMembersCommand extends $Command< ListMembersCommandInput, diff --git a/clients/client-guardduty/commands/ListOrganizationAdminAccountsCommand.ts b/clients/client-guardduty/commands/ListOrganizationAdminAccountsCommand.ts index d24ddd56a866..028013194d88 100644 --- a/clients/client-guardduty/commands/ListOrganizationAdminAccountsCommand.ts +++ b/clients/client-guardduty/commands/ListOrganizationAdminAccountsCommand.ts @@ -24,6 +24,20 @@ export interface ListOrganizationAdminAccountsCommandOutput /** *

Lists the accounts configured as GuardDuty delegated administrators.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { GuardDutyClient, ListOrganizationAdminAccountsCommand } from "@aws-sdk/client-guardduty"; // ES Modules import + * // const { GuardDutyClient, ListOrganizationAdminAccountsCommand } = require("@aws-sdk/client-guardduty"); // CommonJS import + * const client = new GuardDutyClient(config); + * const command = new ListOrganizationAdminAccountsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListOrganizationAdminAccountsCommandInput} for command's `input` shape. + * @see {@link ListOrganizationAdminAccountsCommandOutput} for command's `response` shape. + * @see {@link GuardDutyClientResolvedConfig | config} for command's `input` shape. + * */ export class ListOrganizationAdminAccountsCommand extends $Command< ListOrganizationAdminAccountsCommandInput, diff --git a/clients/client-guardduty/commands/ListPublishingDestinationsCommand.ts b/clients/client-guardduty/commands/ListPublishingDestinationsCommand.ts index 16c32925a808..4ec3f30f6511 100644 --- a/clients/client-guardduty/commands/ListPublishingDestinationsCommand.ts +++ b/clients/client-guardduty/commands/ListPublishingDestinationsCommand.ts @@ -23,6 +23,20 @@ export interface ListPublishingDestinationsCommandOutput extends ListPublishingD /** *

Returns a list of publishing destinations associated with the specified * dectectorId.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { GuardDutyClient, ListPublishingDestinationsCommand } from "@aws-sdk/client-guardduty"; // ES Modules import + * // const { GuardDutyClient, ListPublishingDestinationsCommand } = require("@aws-sdk/client-guardduty"); // CommonJS import + * const client = new GuardDutyClient(config); + * const command = new ListPublishingDestinationsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListPublishingDestinationsCommandInput} for command's `input` shape. + * @see {@link ListPublishingDestinationsCommandOutput} for command's `response` shape. + * @see {@link GuardDutyClientResolvedConfig | config} for command's `input` shape. + * */ export class ListPublishingDestinationsCommand extends $Command< ListPublishingDestinationsCommandInput, diff --git a/clients/client-guardduty/commands/ListTagsForResourceCommand.ts b/clients/client-guardduty/commands/ListTagsForResourceCommand.ts index 630a8afee306..e9d80bf5dc86 100644 --- a/clients/client-guardduty/commands/ListTagsForResourceCommand.ts +++ b/clients/client-guardduty/commands/ListTagsForResourceCommand.ts @@ -24,6 +24,20 @@ export interface ListTagsForResourceCommandOutput extends ListTagsForResourceRes *

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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { GuardDutyClient, ListTagsForResourceCommand } from "@aws-sdk/client-guardduty"; // ES Modules import + * // const { GuardDutyClient, ListTagsForResourceCommand } = require("@aws-sdk/client-guardduty"); // CommonJS import + * const client = new GuardDutyClient(config); + * const command = new ListTagsForResourceCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListTagsForResourceCommandInput} for command's `input` shape. + * @see {@link ListTagsForResourceCommandOutput} for command's `response` shape. + * @see {@link GuardDutyClientResolvedConfig | config} for command's `input` shape. + * */ export class ListTagsForResourceCommand extends $Command< ListTagsForResourceCommandInput, diff --git a/clients/client-guardduty/commands/ListThreatIntelSetsCommand.ts b/clients/client-guardduty/commands/ListThreatIntelSetsCommand.ts index bbb764ce4719..ad1adc2bd434 100644 --- a/clients/client-guardduty/commands/ListThreatIntelSetsCommand.ts +++ b/clients/client-guardduty/commands/ListThreatIntelSetsCommand.ts @@ -24,6 +24,20 @@ export interface ListThreatIntelSetsCommandOutput extends ListThreatIntelSetsRes *

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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { GuardDutyClient, ListThreatIntelSetsCommand } from "@aws-sdk/client-guardduty"; // ES Modules import + * // const { GuardDutyClient, ListThreatIntelSetsCommand } = require("@aws-sdk/client-guardduty"); // CommonJS import + * const client = new GuardDutyClient(config); + * const command = new ListThreatIntelSetsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListThreatIntelSetsCommandInput} for command's `input` shape. + * @see {@link ListThreatIntelSetsCommandOutput} for command's `response` shape. + * @see {@link GuardDutyClientResolvedConfig | config} for command's `input` shape. + * */ export class ListThreatIntelSetsCommand extends $Command< ListThreatIntelSetsCommandInput, diff --git a/clients/client-guardduty/commands/StartMonitoringMembersCommand.ts b/clients/client-guardduty/commands/StartMonitoringMembersCommand.ts index 078a411d0f38..64b24534024b 100644 --- a/clients/client-guardduty/commands/StartMonitoringMembersCommand.ts +++ b/clients/client-guardduty/commands/StartMonitoringMembersCommand.ts @@ -24,6 +24,20 @@ export interface StartMonitoringMembersCommandOutput extends StartMonitoringMemb *

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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { GuardDutyClient, StartMonitoringMembersCommand } from "@aws-sdk/client-guardduty"; // ES Modules import + * // const { GuardDutyClient, StartMonitoringMembersCommand } = require("@aws-sdk/client-guardduty"); // CommonJS import + * const client = new GuardDutyClient(config); + * const command = new StartMonitoringMembersCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link StartMonitoringMembersCommandInput} for command's `input` shape. + * @see {@link StartMonitoringMembersCommandOutput} for command's `response` shape. + * @see {@link GuardDutyClientResolvedConfig | config} for command's `input` shape. + * */ export class StartMonitoringMembersCommand extends $Command< StartMonitoringMembersCommandInput, diff --git a/clients/client-guardduty/commands/StopMonitoringMembersCommand.ts b/clients/client-guardduty/commands/StopMonitoringMembersCommand.ts index ad07a53bc4a1..98b42569e1a6 100644 --- a/clients/client-guardduty/commands/StopMonitoringMembersCommand.ts +++ b/clients/client-guardduty/commands/StopMonitoringMembersCommand.ts @@ -24,6 +24,20 @@ export interface StopMonitoringMembersCommandOutput extends StopMonitoringMember *

Stops GuardDuty monitoring for the specified member accounts. Use the * StartMonitoringMembers operation to restart monitoring for those * accounts.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { GuardDutyClient, StopMonitoringMembersCommand } from "@aws-sdk/client-guardduty"; // ES Modules import + * // const { GuardDutyClient, StopMonitoringMembersCommand } = require("@aws-sdk/client-guardduty"); // CommonJS import + * const client = new GuardDutyClient(config); + * const command = new StopMonitoringMembersCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link StopMonitoringMembersCommandInput} for command's `input` shape. + * @see {@link StopMonitoringMembersCommandOutput} for command's `response` shape. + * @see {@link GuardDutyClientResolvedConfig | config} for command's `input` shape. + * */ export class StopMonitoringMembersCommand extends $Command< StopMonitoringMembersCommandInput, diff --git a/clients/client-guardduty/commands/TagResourceCommand.ts b/clients/client-guardduty/commands/TagResourceCommand.ts index ca9b70b77dbe..0f51ea031a75 100644 --- a/clients/client-guardduty/commands/TagResourceCommand.ts +++ b/clients/client-guardduty/commands/TagResourceCommand.ts @@ -22,6 +22,20 @@ export interface TagResourceCommandOutput extends TagResourceResponse, __Metadat /** *

Adds tags to a resource.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { GuardDutyClient, TagResourceCommand } from "@aws-sdk/client-guardduty"; // ES Modules import + * // const { GuardDutyClient, TagResourceCommand } = require("@aws-sdk/client-guardduty"); // CommonJS import + * const client = new GuardDutyClient(config); + * const command = new TagResourceCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link TagResourceCommandInput} for command's `input` shape. + * @see {@link TagResourceCommandOutput} for command's `response` shape. + * @see {@link GuardDutyClientResolvedConfig | config} for command's `input` shape. + * */ export class TagResourceCommand extends $Command< TagResourceCommandInput, diff --git a/clients/client-guardduty/commands/UnarchiveFindingsCommand.ts b/clients/client-guardduty/commands/UnarchiveFindingsCommand.ts index b272c397e14f..5a386136fbf6 100644 --- a/clients/client-guardduty/commands/UnarchiveFindingsCommand.ts +++ b/clients/client-guardduty/commands/UnarchiveFindingsCommand.ts @@ -22,6 +22,20 @@ export interface UnarchiveFindingsCommandOutput extends UnarchiveFindingsRespons /** *

Unarchives GuardDuty findings specified by the findingIds.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { GuardDutyClient, UnarchiveFindingsCommand } from "@aws-sdk/client-guardduty"; // ES Modules import + * // const { GuardDutyClient, UnarchiveFindingsCommand } = require("@aws-sdk/client-guardduty"); // CommonJS import + * const client = new GuardDutyClient(config); + * const command = new UnarchiveFindingsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link UnarchiveFindingsCommandInput} for command's `input` shape. + * @see {@link UnarchiveFindingsCommandOutput} for command's `response` shape. + * @see {@link GuardDutyClientResolvedConfig | config} for command's `input` shape. + * */ export class UnarchiveFindingsCommand extends $Command< UnarchiveFindingsCommandInput, diff --git a/clients/client-guardduty/commands/UntagResourceCommand.ts b/clients/client-guardduty/commands/UntagResourceCommand.ts index ddbe40375069..e759871153fb 100644 --- a/clients/client-guardduty/commands/UntagResourceCommand.ts +++ b/clients/client-guardduty/commands/UntagResourceCommand.ts @@ -22,6 +22,20 @@ export interface UntagResourceCommandOutput extends UntagResourceResponse, __Met /** *

Removes tags from a resource.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { GuardDutyClient, UntagResourceCommand } from "@aws-sdk/client-guardduty"; // ES Modules import + * // const { GuardDutyClient, UntagResourceCommand } = require("@aws-sdk/client-guardduty"); // CommonJS import + * const client = new GuardDutyClient(config); + * const command = new UntagResourceCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link UntagResourceCommandInput} for command's `input` shape. + * @see {@link UntagResourceCommandOutput} for command's `response` shape. + * @see {@link GuardDutyClientResolvedConfig | config} for command's `input` shape. + * */ export class UntagResourceCommand extends $Command< UntagResourceCommandInput, diff --git a/clients/client-guardduty/commands/UpdateDetectorCommand.ts b/clients/client-guardduty/commands/UpdateDetectorCommand.ts index b8d9260dedf2..6c9c60550eb7 100644 --- a/clients/client-guardduty/commands/UpdateDetectorCommand.ts +++ b/clients/client-guardduty/commands/UpdateDetectorCommand.ts @@ -22,6 +22,20 @@ export interface UpdateDetectorCommandOutput extends UpdateDetectorResponse, __M /** *

Updates the Amazon GuardDuty detector specified by the detectorId.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { GuardDutyClient, UpdateDetectorCommand } from "@aws-sdk/client-guardduty"; // ES Modules import + * // const { GuardDutyClient, UpdateDetectorCommand } = require("@aws-sdk/client-guardduty"); // CommonJS import + * const client = new GuardDutyClient(config); + * const command = new UpdateDetectorCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link UpdateDetectorCommandInput} for command's `input` shape. + * @see {@link UpdateDetectorCommandOutput} for command's `response` shape. + * @see {@link GuardDutyClientResolvedConfig | config} for command's `input` shape. + * */ export class UpdateDetectorCommand extends $Command< UpdateDetectorCommandInput, diff --git a/clients/client-guardduty/commands/UpdateFilterCommand.ts b/clients/client-guardduty/commands/UpdateFilterCommand.ts index 9956ab06b759..f0cfcad2876d 100644 --- a/clients/client-guardduty/commands/UpdateFilterCommand.ts +++ b/clients/client-guardduty/commands/UpdateFilterCommand.ts @@ -22,6 +22,20 @@ export interface UpdateFilterCommandOutput extends UpdateFilterResponse, __Metad /** *

Updates the filter specified by the filter name.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { GuardDutyClient, UpdateFilterCommand } from "@aws-sdk/client-guardduty"; // ES Modules import + * // const { GuardDutyClient, UpdateFilterCommand } = require("@aws-sdk/client-guardduty"); // CommonJS import + * const client = new GuardDutyClient(config); + * const command = new UpdateFilterCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link UpdateFilterCommandInput} for command's `input` shape. + * @see {@link UpdateFilterCommandOutput} for command's `response` shape. + * @see {@link GuardDutyClientResolvedConfig | config} for command's `input` shape. + * */ export class UpdateFilterCommand extends $Command< UpdateFilterCommandInput, diff --git a/clients/client-guardduty/commands/UpdateFindingsFeedbackCommand.ts b/clients/client-guardduty/commands/UpdateFindingsFeedbackCommand.ts index e581cb62107a..b9945cae5e05 100644 --- a/clients/client-guardduty/commands/UpdateFindingsFeedbackCommand.ts +++ b/clients/client-guardduty/commands/UpdateFindingsFeedbackCommand.ts @@ -22,6 +22,20 @@ export interface UpdateFindingsFeedbackCommandOutput extends UpdateFindingsFeedb /** *

Marks the specified GuardDuty findings as useful or not useful.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { GuardDutyClient, UpdateFindingsFeedbackCommand } from "@aws-sdk/client-guardduty"; // ES Modules import + * // const { GuardDutyClient, UpdateFindingsFeedbackCommand } = require("@aws-sdk/client-guardduty"); // CommonJS import + * const client = new GuardDutyClient(config); + * const command = new UpdateFindingsFeedbackCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link UpdateFindingsFeedbackCommandInput} for command's `input` shape. + * @see {@link UpdateFindingsFeedbackCommandOutput} for command's `response` shape. + * @see {@link GuardDutyClientResolvedConfig | config} for command's `input` shape. + * */ export class UpdateFindingsFeedbackCommand extends $Command< UpdateFindingsFeedbackCommandInput, diff --git a/clients/client-guardduty/commands/UpdateIPSetCommand.ts b/clients/client-guardduty/commands/UpdateIPSetCommand.ts index 1a2baf078140..2ab984d2f080 100644 --- a/clients/client-guardduty/commands/UpdateIPSetCommand.ts +++ b/clients/client-guardduty/commands/UpdateIPSetCommand.ts @@ -22,6 +22,20 @@ export interface UpdateIPSetCommandOutput extends UpdateIPSetResponse, __Metadat /** *

Updates the IPSet specified by the IPSet ID.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { GuardDutyClient, UpdateIPSetCommand } from "@aws-sdk/client-guardduty"; // ES Modules import + * // const { GuardDutyClient, UpdateIPSetCommand } = require("@aws-sdk/client-guardduty"); // CommonJS import + * const client = new GuardDutyClient(config); + * const command = new UpdateIPSetCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link UpdateIPSetCommandInput} for command's `input` shape. + * @see {@link UpdateIPSetCommandOutput} for command's `response` shape. + * @see {@link GuardDutyClientResolvedConfig | config} for command's `input` shape. + * */ export class UpdateIPSetCommand extends $Command< UpdateIPSetCommandInput, diff --git a/clients/client-guardduty/commands/UpdateMemberDetectorsCommand.ts b/clients/client-guardduty/commands/UpdateMemberDetectorsCommand.ts index 40f1a9cadc1d..a681be06bf07 100644 --- a/clients/client-guardduty/commands/UpdateMemberDetectorsCommand.ts +++ b/clients/client-guardduty/commands/UpdateMemberDetectorsCommand.ts @@ -22,6 +22,20 @@ export interface UpdateMemberDetectorsCommandOutput extends UpdateMemberDetector /** *

Contains information on member accounts to be updated.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { GuardDutyClient, UpdateMemberDetectorsCommand } from "@aws-sdk/client-guardduty"; // ES Modules import + * // const { GuardDutyClient, UpdateMemberDetectorsCommand } = require("@aws-sdk/client-guardduty"); // CommonJS import + * const client = new GuardDutyClient(config); + * const command = new UpdateMemberDetectorsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link UpdateMemberDetectorsCommandInput} for command's `input` shape. + * @see {@link UpdateMemberDetectorsCommandOutput} for command's `response` shape. + * @see {@link GuardDutyClientResolvedConfig | config} for command's `input` shape. + * */ export class UpdateMemberDetectorsCommand extends $Command< UpdateMemberDetectorsCommandInput, diff --git a/clients/client-guardduty/commands/UpdateOrganizationConfigurationCommand.ts b/clients/client-guardduty/commands/UpdateOrganizationConfigurationCommand.ts index cbc8df2aba69..0e181d8ddb67 100644 --- a/clients/client-guardduty/commands/UpdateOrganizationConfigurationCommand.ts +++ b/clients/client-guardduty/commands/UpdateOrganizationConfigurationCommand.ts @@ -24,6 +24,20 @@ export interface UpdateOrganizationConfigurationCommandOutput /** *

Updates the delegated administrator account with the values provided.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { GuardDutyClient, UpdateOrganizationConfigurationCommand } from "@aws-sdk/client-guardduty"; // ES Modules import + * // const { GuardDutyClient, UpdateOrganizationConfigurationCommand } = require("@aws-sdk/client-guardduty"); // CommonJS import + * const client = new GuardDutyClient(config); + * const command = new UpdateOrganizationConfigurationCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link UpdateOrganizationConfigurationCommandInput} for command's `input` shape. + * @see {@link UpdateOrganizationConfigurationCommandOutput} for command's `response` shape. + * @see {@link GuardDutyClientResolvedConfig | config} for command's `input` shape. + * */ export class UpdateOrganizationConfigurationCommand extends $Command< UpdateOrganizationConfigurationCommandInput, diff --git a/clients/client-guardduty/commands/UpdatePublishingDestinationCommand.ts b/clients/client-guardduty/commands/UpdatePublishingDestinationCommand.ts index 6f903b965646..f51bf7fbf67a 100644 --- a/clients/client-guardduty/commands/UpdatePublishingDestinationCommand.ts +++ b/clients/client-guardduty/commands/UpdatePublishingDestinationCommand.ts @@ -25,6 +25,20 @@ export interface UpdatePublishingDestinationCommandOutput /** *

Updates information about the publishing destination specified by the * destinationId.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { GuardDutyClient, UpdatePublishingDestinationCommand } from "@aws-sdk/client-guardduty"; // ES Modules import + * // const { GuardDutyClient, UpdatePublishingDestinationCommand } = require("@aws-sdk/client-guardduty"); // CommonJS import + * const client = new GuardDutyClient(config); + * const command = new UpdatePublishingDestinationCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link UpdatePublishingDestinationCommandInput} for command's `input` shape. + * @see {@link UpdatePublishingDestinationCommandOutput} for command's `response` shape. + * @see {@link GuardDutyClientResolvedConfig | config} for command's `input` shape. + * */ export class UpdatePublishingDestinationCommand extends $Command< UpdatePublishingDestinationCommandInput, diff --git a/clients/client-guardduty/commands/UpdateThreatIntelSetCommand.ts b/clients/client-guardduty/commands/UpdateThreatIntelSetCommand.ts index 1e978c71ba1a..34dcbe0a028e 100644 --- a/clients/client-guardduty/commands/UpdateThreatIntelSetCommand.ts +++ b/clients/client-guardduty/commands/UpdateThreatIntelSetCommand.ts @@ -22,6 +22,20 @@ export interface UpdateThreatIntelSetCommandOutput extends UpdateThreatIntelSetR /** *

Updates the ThreatIntelSet specified by the ThreatIntelSet ID.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { GuardDutyClient, UpdateThreatIntelSetCommand } from "@aws-sdk/client-guardduty"; // ES Modules import + * // const { GuardDutyClient, UpdateThreatIntelSetCommand } = require("@aws-sdk/client-guardduty"); // CommonJS import + * const client = new GuardDutyClient(config); + * const command = new UpdateThreatIntelSetCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link UpdateThreatIntelSetCommandInput} for command's `input` shape. + * @see {@link UpdateThreatIntelSetCommandOutput} for command's `response` shape. + * @see {@link GuardDutyClientResolvedConfig | config} for command's `input` shape. + * */ export class UpdateThreatIntelSetCommand extends $Command< UpdateThreatIntelSetCommandInput, diff --git a/clients/client-guardduty/models/models_0.ts b/clients/client-guardduty/models/models_0.ts index 074985ecebbc..3373f261aea9 100644 --- a/clients/client-guardduty/models/models_0.ts +++ b/clients/client-guardduty/models/models_0.ts @@ -19,6 +19,9 @@ export interface AcceptInvitationRequest { } export namespace AcceptInvitationRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: AcceptInvitationRequest): any => ({ ...obj, }); @@ -27,6 +30,9 @@ export namespace AcceptInvitationRequest { export interface AcceptInvitationResponse {} export namespace AcceptInvitationResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: AcceptInvitationResponse): any => ({ ...obj, }); @@ -50,6 +56,9 @@ export interface BadRequestException extends __SmithyException, $MetadataBearer } export namespace BadRequestException { + /** + * @internal + */ export const filterSensitiveLog = (obj: BadRequestException): any => ({ ...obj, }); @@ -73,6 +82,9 @@ export interface InternalServerErrorException extends __SmithyException, $Metada } export namespace InternalServerErrorException { + /** + * @internal + */ export const filterSensitiveLog = (obj: InternalServerErrorException): any => ({ ...obj, }); @@ -96,6 +108,9 @@ export interface AccessControlList { } export namespace AccessControlList { + /** + * @internal + */ export const filterSensitiveLog = (obj: AccessControlList): any => ({ ...obj, }); @@ -127,6 +142,9 @@ export interface AccessKeyDetails { } export namespace AccessKeyDetails { + /** + * @internal + */ export const filterSensitiveLog = (obj: AccessKeyDetails): any => ({ ...obj, }); @@ -148,6 +166,9 @@ export interface AccountDetail { } export namespace AccountDetail { + /** + * @internal + */ export const filterSensitiveLog = (obj: AccountDetail): any => ({ ...obj, }); @@ -181,6 +202,9 @@ export interface BlockPublicAccess { } export namespace BlockPublicAccess { + /** + * @internal + */ export const filterSensitiveLog = (obj: BlockPublicAccess): any => ({ ...obj, }); @@ -197,6 +221,9 @@ export interface AccountLevelPermissions { } export namespace AccountLevelPermissions { + /** + * @internal + */ export const filterSensitiveLog = (obj: AccountLevelPermissions): any => ({ ...obj, }); @@ -213,6 +240,9 @@ export interface DomainDetails { } export namespace DomainDetails { + /** + * @internal + */ export const filterSensitiveLog = (obj: DomainDetails): any => ({ ...obj, }); @@ -229,6 +259,9 @@ export interface City { } export namespace City { + /** + * @internal + */ export const filterSensitiveLog = (obj: City): any => ({ ...obj, }); @@ -250,6 +283,9 @@ export interface Country { } export namespace Country { + /** + * @internal + */ export const filterSensitiveLog = (obj: Country): any => ({ ...obj, }); @@ -271,6 +307,9 @@ export interface GeoLocation { } export namespace GeoLocation { + /** + * @internal + */ export const filterSensitiveLog = (obj: GeoLocation): any => ({ ...obj, }); @@ -303,6 +342,9 @@ export interface Organization { } export namespace Organization { + /** + * @internal + */ export const filterSensitiveLog = (obj: Organization): any => ({ ...obj, }); @@ -339,6 +381,9 @@ export interface RemoteIpDetails { } export namespace RemoteIpDetails { + /** + * @internal + */ export const filterSensitiveLog = (obj: RemoteIpDetails): any => ({ ...obj, }); @@ -380,6 +425,9 @@ export interface AwsApiCallAction { } export namespace AwsApiCallAction { + /** + * @internal + */ export const filterSensitiveLog = (obj: AwsApiCallAction): any => ({ ...obj, }); @@ -396,6 +444,9 @@ export interface DnsRequestAction { } export namespace DnsRequestAction { + /** + * @internal + */ export const filterSensitiveLog = (obj: DnsRequestAction): any => ({ ...obj, }); @@ -412,6 +463,9 @@ export interface LocalIpDetails { } export namespace LocalIpDetails { + /** + * @internal + */ export const filterSensitiveLog = (obj: LocalIpDetails): any => ({ ...obj, }); @@ -433,6 +487,9 @@ export interface LocalPortDetails { } export namespace LocalPortDetails { + /** + * @internal + */ export const filterSensitiveLog = (obj: LocalPortDetails): any => ({ ...obj, }); @@ -454,6 +511,9 @@ export interface RemotePortDetails { } export namespace RemotePortDetails { + /** + * @internal + */ export const filterSensitiveLog = (obj: RemotePortDetails): any => ({ ...obj, }); @@ -500,6 +560,9 @@ export interface NetworkConnectionAction { } export namespace NetworkConnectionAction { + /** + * @internal + */ export const filterSensitiveLog = (obj: NetworkConnectionAction): any => ({ ...obj, }); @@ -526,6 +589,9 @@ export interface PortProbeDetail { } export namespace PortProbeDetail { + /** + * @internal + */ export const filterSensitiveLog = (obj: PortProbeDetail): any => ({ ...obj, }); @@ -547,6 +613,9 @@ export interface PortProbeAction { } export namespace PortProbeAction { + /** + * @internal + */ export const filterSensitiveLog = (obj: PortProbeAction): any => ({ ...obj, }); @@ -583,6 +652,9 @@ export interface Action { } export namespace Action { + /** + * @internal + */ export const filterSensitiveLog = (obj: Action): any => ({ ...obj, }); @@ -610,6 +682,9 @@ export interface AdminAccount { } export namespace AdminAccount { + /** + * @internal + */ export const filterSensitiveLog = (obj: AdminAccount): any => ({ ...obj, }); @@ -629,6 +704,9 @@ export interface ArchiveFindingsRequest { } export namespace ArchiveFindingsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ArchiveFindingsRequest): any => ({ ...obj, }); @@ -637,6 +715,9 @@ export namespace ArchiveFindingsRequest { export interface ArchiveFindingsResponse {} export namespace ArchiveFindingsResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ArchiveFindingsResponse): any => ({ ...obj, }); @@ -660,6 +741,9 @@ export interface BucketPolicy { } export namespace BucketPolicy { + /** + * @internal + */ export const filterSensitiveLog = (obj: BucketPolicy): any => ({ ...obj, }); @@ -687,6 +771,9 @@ export interface BucketLevelPermissions { } export namespace BucketLevelPermissions { + /** + * @internal + */ export const filterSensitiveLog = (obj: BucketLevelPermissions): any => ({ ...obj, }); @@ -708,6 +795,9 @@ export interface CloudTrailConfigurationResult { } export namespace CloudTrailConfigurationResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: CloudTrailConfigurationResult): any => ({ ...obj, }); @@ -805,6 +895,9 @@ export interface Condition { } export namespace Condition { + /** + * @internal + */ export const filterSensitiveLog = (obj: Condition): any => ({ ...obj, }); @@ -821,6 +914,9 @@ export interface S3LogsConfiguration { } export namespace S3LogsConfiguration { + /** + * @internal + */ export const filterSensitiveLog = (obj: S3LogsConfiguration): any => ({ ...obj, }); @@ -837,6 +933,9 @@ export interface DataSourceConfigurations { } export namespace DataSourceConfigurations { + /** + * @internal + */ export const filterSensitiveLog = (obj: DataSourceConfigurations): any => ({ ...obj, }); @@ -876,6 +975,9 @@ export interface CreateDetectorRequest { } export namespace CreateDetectorRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateDetectorRequest): any => ({ ...obj, }); @@ -889,6 +991,9 @@ export interface CreateDetectorResponse { } export namespace CreateDetectorResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateDetectorResponse): any => ({ ...obj, }); @@ -911,6 +1016,9 @@ export interface FindingCriteria { } export namespace FindingCriteria { + /** + * @internal + */ export const filterSensitiveLog = (obj: FindingCriteria): any => ({ ...obj, }); @@ -1122,6 +1230,9 @@ export interface CreateFilterRequest { } export namespace CreateFilterRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateFilterRequest): any => ({ ...obj, }); @@ -1135,6 +1246,9 @@ export interface CreateFilterResponse { } export namespace CreateFilterResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateFilterResponse): any => ({ ...obj, }); @@ -1191,6 +1305,9 @@ export interface CreateIPSetRequest { } export namespace CreateIPSetRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateIPSetRequest): any => ({ ...obj, }); @@ -1204,6 +1321,9 @@ export interface CreateIPSetResponse { } export namespace CreateIPSetResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateIPSetResponse): any => ({ ...obj, }); @@ -1224,6 +1344,9 @@ export interface CreateMembersRequest { } export namespace CreateMembersRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateMembersRequest): any => ({ ...obj, }); @@ -1245,6 +1368,9 @@ export interface UnprocessedAccount { } export namespace UnprocessedAccount { + /** + * @internal + */ export const filterSensitiveLog = (obj: UnprocessedAccount): any => ({ ...obj, }); @@ -1259,6 +1385,9 @@ export interface CreateMembersResponse { } export namespace CreateMembersResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateMembersResponse): any => ({ ...obj, }); @@ -1281,6 +1410,9 @@ export interface DestinationProperties { } export namespace DestinationProperties { + /** + * @internal + */ export const filterSensitiveLog = (obj: DestinationProperties): any => ({ ...obj, }); @@ -1315,6 +1447,9 @@ export interface CreatePublishingDestinationRequest { } export namespace CreatePublishingDestinationRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreatePublishingDestinationRequest): any => ({ ...obj, }); @@ -1328,6 +1463,9 @@ export interface CreatePublishingDestinationResponse { } export namespace CreatePublishingDestinationResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreatePublishingDestinationResponse): any => ({ ...obj, }); @@ -1346,6 +1484,9 @@ export interface CreateSampleFindingsRequest { } export namespace CreateSampleFindingsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateSampleFindingsRequest): any => ({ ...obj, }); @@ -1354,6 +1495,9 @@ export namespace CreateSampleFindingsRequest { export interface CreateSampleFindingsResponse {} export namespace CreateSampleFindingsResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateSampleFindingsResponse): any => ({ ...obj, }); @@ -1410,6 +1554,9 @@ export interface CreateThreatIntelSetRequest { } export namespace CreateThreatIntelSetRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateThreatIntelSetRequest): any => ({ ...obj, }); @@ -1423,6 +1570,9 @@ export interface CreateThreatIntelSetResponse { } export namespace CreateThreatIntelSetResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateThreatIntelSetResponse): any => ({ ...obj, }); @@ -1446,6 +1596,9 @@ export interface DNSLogsConfigurationResult { } export namespace DNSLogsConfigurationResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: DNSLogsConfigurationResult): any => ({ ...obj, }); @@ -1462,6 +1615,9 @@ export interface FlowLogsConfigurationResult { } export namespace FlowLogsConfigurationResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: FlowLogsConfigurationResult): any => ({ ...obj, }); @@ -1479,6 +1635,9 @@ export interface S3LogsConfigurationResult { } export namespace S3LogsConfigurationResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: S3LogsConfigurationResult): any => ({ ...obj, }); @@ -1512,6 +1671,9 @@ export interface DataSourceConfigurationsResult { } export namespace DataSourceConfigurationsResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: DataSourceConfigurationsResult): any => ({ ...obj, }); @@ -1526,6 +1688,9 @@ export interface DeclineInvitationsRequest { } export namespace DeclineInvitationsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeclineInvitationsRequest): any => ({ ...obj, }); @@ -1540,6 +1705,9 @@ export interface DeclineInvitationsResponse { } export namespace DeclineInvitationsResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeclineInvitationsResponse): any => ({ ...obj, }); @@ -1564,6 +1732,9 @@ export interface DefaultServerSideEncryption { } export namespace DefaultServerSideEncryption { + /** + * @internal + */ export const filterSensitiveLog = (obj: DefaultServerSideEncryption): any => ({ ...obj, }); @@ -1577,6 +1748,9 @@ export interface DeleteDetectorRequest { } export namespace DeleteDetectorRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteDetectorRequest): any => ({ ...obj, }); @@ -1585,6 +1759,9 @@ export namespace DeleteDetectorRequest { export interface DeleteDetectorResponse {} export namespace DeleteDetectorResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteDetectorResponse): any => ({ ...obj, }); @@ -1603,6 +1780,9 @@ export interface DeleteFilterRequest { } export namespace DeleteFilterRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteFilterRequest): any => ({ ...obj, }); @@ -1611,6 +1791,9 @@ export namespace DeleteFilterRequest { export interface DeleteFilterResponse {} export namespace DeleteFilterResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteFilterResponse): any => ({ ...obj, }); @@ -1625,6 +1808,9 @@ export interface DeleteInvitationsRequest { } export namespace DeleteInvitationsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteInvitationsRequest): any => ({ ...obj, }); @@ -1639,6 +1825,9 @@ export interface DeleteInvitationsResponse { } export namespace DeleteInvitationsResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteInvitationsResponse): any => ({ ...obj, }); @@ -1657,6 +1846,9 @@ export interface DeleteIPSetRequest { } export namespace DeleteIPSetRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteIPSetRequest): any => ({ ...obj, }); @@ -1665,6 +1857,9 @@ export namespace DeleteIPSetRequest { export interface DeleteIPSetResponse {} export namespace DeleteIPSetResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteIPSetResponse): any => ({ ...obj, }); @@ -1684,6 +1879,9 @@ export interface DeleteMembersRequest { } export namespace DeleteMembersRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteMembersRequest): any => ({ ...obj, }); @@ -1697,6 +1895,9 @@ export interface DeleteMembersResponse { } export namespace DeleteMembersResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteMembersResponse): any => ({ ...obj, }); @@ -1715,6 +1916,9 @@ export interface DeletePublishingDestinationRequest { } export namespace DeletePublishingDestinationRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeletePublishingDestinationRequest): any => ({ ...obj, }); @@ -1723,6 +1927,9 @@ export namespace DeletePublishingDestinationRequest { export interface DeletePublishingDestinationResponse {} export namespace DeletePublishingDestinationResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeletePublishingDestinationResponse): any => ({ ...obj, }); @@ -1741,6 +1948,9 @@ export interface DeleteThreatIntelSetRequest { } export namespace DeleteThreatIntelSetRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteThreatIntelSetRequest): any => ({ ...obj, }); @@ -1749,6 +1959,9 @@ export namespace DeleteThreatIntelSetRequest { export interface DeleteThreatIntelSetResponse {} export namespace DeleteThreatIntelSetResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteThreatIntelSetResponse): any => ({ ...obj, }); @@ -1763,6 +1976,9 @@ export interface DescribeOrganizationConfigurationRequest { } export namespace DescribeOrganizationConfigurationRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeOrganizationConfigurationRequest): any => ({ ...obj, }); @@ -1781,6 +1997,9 @@ export interface OrganizationS3LogsConfigurationResult { } export namespace OrganizationS3LogsConfigurationResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: OrganizationS3LogsConfigurationResult): any => ({ ...obj, }); @@ -1798,6 +2017,9 @@ export interface OrganizationDataSourceConfigurationsResult { } export namespace OrganizationDataSourceConfigurationsResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: OrganizationDataSourceConfigurationsResult): any => ({ ...obj, }); @@ -1824,6 +2046,9 @@ export interface DescribeOrganizationConfigurationResponse { } export namespace DescribeOrganizationConfigurationResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeOrganizationConfigurationResponse): any => ({ ...obj, }); @@ -1843,6 +2068,9 @@ export interface DescribePublishingDestinationRequest { } export namespace DescribePublishingDestinationRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribePublishingDestinationRequest): any => ({ ...obj, }); @@ -1886,6 +2114,9 @@ export interface DescribePublishingDestinationResponse { } export namespace DescribePublishingDestinationResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribePublishingDestinationResponse): any => ({ ...obj, }); @@ -1914,6 +2145,9 @@ export interface Destination { } export namespace Destination { + /** + * @internal + */ export const filterSensitiveLog = (obj: Destination): any => ({ ...obj, }); @@ -1933,6 +2167,9 @@ export interface DisableOrganizationAdminAccountRequest { } export namespace DisableOrganizationAdminAccountRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DisableOrganizationAdminAccountRequest): any => ({ ...obj, }); @@ -1941,6 +2178,9 @@ export namespace DisableOrganizationAdminAccountRequest { export interface DisableOrganizationAdminAccountResponse {} export namespace DisableOrganizationAdminAccountResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DisableOrganizationAdminAccountResponse): any => ({ ...obj, }); @@ -1954,6 +2194,9 @@ export interface DisassociateFromMasterAccountRequest { } export namespace DisassociateFromMasterAccountRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DisassociateFromMasterAccountRequest): any => ({ ...obj, }); @@ -1962,6 +2205,9 @@ export namespace DisassociateFromMasterAccountRequest { export interface DisassociateFromMasterAccountResponse {} export namespace DisassociateFromMasterAccountResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DisassociateFromMasterAccountResponse): any => ({ ...obj, }); @@ -1982,6 +2228,9 @@ export interface DisassociateMembersRequest { } export namespace DisassociateMembersRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DisassociateMembersRequest): any => ({ ...obj, }); @@ -1996,6 +2245,9 @@ export interface DisassociateMembersResponse { } export namespace DisassociateMembersResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DisassociateMembersResponse): any => ({ ...obj, }); @@ -2010,6 +2262,9 @@ export interface EnableOrganizationAdminAccountRequest { } export namespace EnableOrganizationAdminAccountRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: EnableOrganizationAdminAccountRequest): any => ({ ...obj, }); @@ -2018,6 +2273,9 @@ export namespace EnableOrganizationAdminAccountRequest { export interface EnableOrganizationAdminAccountResponse {} export namespace EnableOrganizationAdminAccountResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: EnableOrganizationAdminAccountResponse): any => ({ ...obj, }); @@ -2041,6 +2299,9 @@ export interface ThreatIntelligenceDetail { } export namespace ThreatIntelligenceDetail { + /** + * @internal + */ export const filterSensitiveLog = (obj: ThreatIntelligenceDetail): any => ({ ...obj, }); @@ -2057,6 +2318,9 @@ export interface Evidence { } export namespace Evidence { + /** + * @internal + */ export const filterSensitiveLog = (obj: Evidence): any => ({ ...obj, }); @@ -2083,6 +2347,9 @@ export interface IamInstanceProfile { } export namespace IamInstanceProfile { + /** + * @internal + */ export const filterSensitiveLog = (obj: IamInstanceProfile): any => ({ ...obj, }); @@ -2104,6 +2371,9 @@ export interface PrivateIpAddressDetails { } export namespace PrivateIpAddressDetails { + /** + * @internal + */ export const filterSensitiveLog = (obj: PrivateIpAddressDetails): any => ({ ...obj, }); @@ -2125,6 +2395,9 @@ export interface SecurityGroup { } export namespace SecurityGroup { + /** + * @internal + */ export const filterSensitiveLog = (obj: SecurityGroup): any => ({ ...obj, }); @@ -2186,6 +2459,9 @@ export interface NetworkInterface { } export namespace NetworkInterface { + /** + * @internal + */ export const filterSensitiveLog = (obj: NetworkInterface): any => ({ ...obj, }); @@ -2207,6 +2483,9 @@ export interface ProductCode { } export namespace ProductCode { + /** + * @internal + */ export const filterSensitiveLog = (obj: ProductCode): any => ({ ...obj, }); @@ -2228,6 +2507,9 @@ export interface Tag { } export namespace Tag { + /** + * @internal + */ export const filterSensitiveLog = (obj: Tag): any => ({ ...obj, }); @@ -2305,6 +2587,9 @@ export interface InstanceDetails { } export namespace InstanceDetails { + /** + * @internal + */ export const filterSensitiveLog = (obj: InstanceDetails): any => ({ ...obj, }); @@ -2324,6 +2609,9 @@ export interface Owner { } export namespace Owner { + /** + * @internal + */ export const filterSensitiveLog = (obj: Owner): any => ({ ...obj, }); @@ -2345,6 +2633,9 @@ export interface PermissionConfiguration { } export namespace PermissionConfiguration { + /** + * @internal + */ export const filterSensitiveLog = (obj: PermissionConfiguration): any => ({ ...obj, }); @@ -2367,6 +2658,9 @@ export interface PublicAccess { } export namespace PublicAccess { + /** + * @internal + */ export const filterSensitiveLog = (obj: PublicAccess): any => ({ ...obj, }); @@ -2418,6 +2712,9 @@ export interface S3BucketDetail { } export namespace S3BucketDetail { + /** + * @internal + */ export const filterSensitiveLog = (obj: S3BucketDetail): any => ({ ...obj, }); @@ -2452,6 +2749,9 @@ export interface Resource { } export namespace Resource { + /** + * @internal + */ export const filterSensitiveLog = (obj: Resource): any => ({ ...obj, }); @@ -2515,6 +2815,9 @@ export interface Service { } export namespace Service { + /** + * @internal + */ export const filterSensitiveLog = (obj: Service): any => ({ ...obj, }); @@ -2603,6 +2906,9 @@ export interface Finding { } export namespace Finding { + /** + * @internal + */ export const filterSensitiveLog = (obj: Finding): any => ({ ...obj, }); @@ -2619,6 +2925,9 @@ export interface FindingStatistics { } export namespace FindingStatistics { + /** + * @internal + */ export const filterSensitiveLog = (obj: FindingStatistics): any => ({ ...obj, }); @@ -2636,6 +2945,9 @@ export interface GetDetectorRequest { } export namespace GetDetectorRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetDetectorRequest): any => ({ ...obj, }); @@ -2679,6 +2991,9 @@ export interface GetDetectorResponse { } export namespace GetDetectorResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetDetectorResponse): any => ({ ...obj, }); @@ -2697,6 +3012,9 @@ export interface GetFilterRequest { } export namespace GetFilterRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetFilterRequest): any => ({ ...obj, }); @@ -2736,6 +3054,9 @@ export interface GetFilterResponse { } export namespace GetFilterResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetFilterResponse): any => ({ ...obj, }); @@ -2762,6 +3083,9 @@ export interface SortCriteria { } export namespace SortCriteria { + /** + * @internal + */ export const filterSensitiveLog = (obj: SortCriteria): any => ({ ...obj, }); @@ -2786,6 +3110,9 @@ export interface GetFindingsRequest { } export namespace GetFindingsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetFindingsRequest): any => ({ ...obj, }); @@ -2799,6 +3126,9 @@ export interface GetFindingsResponse { } export namespace GetFindingsResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetFindingsResponse): any => ({ ...obj, }); @@ -2823,6 +3153,9 @@ export interface GetFindingsStatisticsRequest { } export namespace GetFindingsStatisticsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetFindingsStatisticsRequest): any => ({ ...obj, }); @@ -2836,6 +3169,9 @@ export interface GetFindingsStatisticsResponse { } export namespace GetFindingsStatisticsResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetFindingsStatisticsResponse): any => ({ ...obj, }); @@ -2844,6 +3180,9 @@ export namespace GetFindingsStatisticsResponse { export interface GetInvitationsCountRequest {} export namespace GetInvitationsCountRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetInvitationsCountRequest): any => ({ ...obj, }); @@ -2857,6 +3196,9 @@ export interface GetInvitationsCountResponse { } export namespace GetInvitationsCountResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetInvitationsCountResponse): any => ({ ...obj, }); @@ -2875,6 +3217,9 @@ export interface GetIPSetRequest { } export namespace GetIPSetRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetIPSetRequest): any => ({ ...obj, }); @@ -2919,6 +3264,9 @@ export interface GetIPSetResponse { } export namespace GetIPSetResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetIPSetResponse): any => ({ ...obj, }); @@ -2932,6 +3280,9 @@ export interface GetMasterAccountRequest { } export namespace GetMasterAccountRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetMasterAccountRequest): any => ({ ...obj, }); @@ -2963,6 +3314,9 @@ export interface Master { } export namespace Master { + /** + * @internal + */ export const filterSensitiveLog = (obj: Master): any => ({ ...obj, }); @@ -2976,6 +3330,9 @@ export interface GetMasterAccountResponse { } export namespace GetMasterAccountResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetMasterAccountResponse): any => ({ ...obj, }); @@ -2994,6 +3351,9 @@ export interface GetMemberDetectorsRequest { } export namespace GetMemberDetectorsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetMemberDetectorsRequest): any => ({ ...obj, }); @@ -3015,6 +3375,9 @@ export interface MemberDataSourceConfiguration { } export namespace MemberDataSourceConfiguration { + /** + * @internal + */ export const filterSensitiveLog = (obj: MemberDataSourceConfiguration): any => ({ ...obj, }); @@ -3034,6 +3397,9 @@ export interface GetMemberDetectorsResponse { } export namespace GetMemberDetectorsResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetMemberDetectorsResponse): any => ({ ...obj, }); @@ -3053,6 +3419,9 @@ export interface GetMembersRequest { } export namespace GetMembersRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetMembersRequest): any => ({ ...obj, }); @@ -3099,6 +3468,9 @@ export interface Member { } export namespace Member { + /** + * @internal + */ export const filterSensitiveLog = (obj: Member): any => ({ ...obj, }); @@ -3118,6 +3490,9 @@ export interface GetMembersResponse { } export namespace GetMembersResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetMembersResponse): any => ({ ...obj, }); @@ -3136,6 +3511,9 @@ export interface GetThreatIntelSetRequest { } export namespace GetThreatIntelSetRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetThreatIntelSetRequest): any => ({ ...obj, }); @@ -3181,6 +3559,9 @@ export interface GetThreatIntelSetResponse { } export namespace GetThreatIntelSetResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetThreatIntelSetResponse): any => ({ ...obj, }); @@ -3208,6 +3589,9 @@ export interface UsageCriteria { } export namespace UsageCriteria { + /** + * @internal + */ export const filterSensitiveLog = (obj: UsageCriteria): any => ({ ...obj, }); @@ -3258,6 +3642,9 @@ export interface GetUsageStatisticsRequest { } export namespace GetUsageStatisticsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetUsageStatisticsRequest): any => ({ ...obj, }); @@ -3279,6 +3666,9 @@ export interface Total { } export namespace Total { + /** + * @internal + */ export const filterSensitiveLog = (obj: Total): any => ({ ...obj, }); @@ -3300,6 +3690,9 @@ export interface UsageAccountResult { } export namespace UsageAccountResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: UsageAccountResult): any => ({ ...obj, }); @@ -3321,6 +3714,9 @@ export interface UsageDataSourceResult { } export namespace UsageDataSourceResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: UsageDataSourceResult): any => ({ ...obj, }); @@ -3342,6 +3738,9 @@ export interface UsageResourceResult { } export namespace UsageResourceResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: UsageResourceResult): any => ({ ...obj, }); @@ -3375,6 +3774,9 @@ export interface UsageStatistics { } export namespace UsageStatistics { + /** + * @internal + */ export const filterSensitiveLog = (obj: UsageStatistics): any => ({ ...obj, }); @@ -3395,6 +3797,9 @@ export interface GetUsageStatisticsResponse { } export namespace GetUsageStatisticsResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetUsageStatisticsResponse): any => ({ ...obj, }); @@ -3426,6 +3831,9 @@ export interface InviteMembersRequest { } export namespace InviteMembersRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: InviteMembersRequest): any => ({ ...obj, }); @@ -3440,6 +3848,9 @@ export interface InviteMembersResponse { } export namespace InviteMembersResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: InviteMembersResponse): any => ({ ...obj, }); @@ -3462,6 +3873,9 @@ export interface ListDetectorsRequest { } export namespace ListDetectorsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListDetectorsRequest): any => ({ ...obj, }); @@ -3481,6 +3895,9 @@ export interface ListDetectorsResponse { } export namespace ListDetectorsResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListDetectorsResponse): any => ({ ...obj, }); @@ -3508,6 +3925,9 @@ export interface ListFiltersRequest { } export namespace ListFiltersRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListFiltersRequest): any => ({ ...obj, }); @@ -3527,6 +3947,9 @@ export interface ListFiltersResponse { } export namespace ListFiltersResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListFiltersResponse): any => ({ ...obj, }); @@ -3718,6 +4141,9 @@ export interface ListFindingsRequest { } export namespace ListFindingsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListFindingsRequest): any => ({ ...obj, }); @@ -3737,6 +4163,9 @@ export interface ListFindingsResponse { } export namespace ListFindingsResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListFindingsResponse): any => ({ ...obj, }); @@ -3759,6 +4188,9 @@ export interface ListInvitationsRequest { } export namespace ListInvitationsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListInvitationsRequest): any => ({ ...obj, }); @@ -3791,6 +4223,9 @@ export interface Invitation { } export namespace Invitation { + /** + * @internal + */ export const filterSensitiveLog = (obj: Invitation): any => ({ ...obj, }); @@ -3810,6 +4245,9 @@ export interface ListInvitationsResponse { } export namespace ListInvitationsResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListInvitationsResponse): any => ({ ...obj, }); @@ -3837,6 +4275,9 @@ export interface ListIPSetsRequest { } export namespace ListIPSetsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListIPSetsRequest): any => ({ ...obj, }); @@ -3856,6 +4297,9 @@ export interface ListIPSetsResponse { } export namespace ListIPSetsResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListIPSetsResponse): any => ({ ...obj, }); @@ -3889,6 +4333,9 @@ export interface ListMembersRequest { } export namespace ListMembersRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListMembersRequest): any => ({ ...obj, }); @@ -3908,6 +4355,9 @@ export interface ListMembersResponse { } export namespace ListMembersResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListMembersResponse): any => ({ ...obj, }); @@ -3929,6 +4379,9 @@ export interface ListOrganizationAdminAccountsRequest { } export namespace ListOrganizationAdminAccountsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListOrganizationAdminAccountsRequest): any => ({ ...obj, }); @@ -3949,6 +4402,9 @@ export interface ListOrganizationAdminAccountsResponse { } export namespace ListOrganizationAdminAccountsResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListOrganizationAdminAccountsResponse): any => ({ ...obj, }); @@ -3975,6 +4431,9 @@ export interface ListPublishingDestinationsRequest { } export namespace ListPublishingDestinationsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListPublishingDestinationsRequest): any => ({ ...obj, }); @@ -3997,6 +4456,9 @@ export interface ListPublishingDestinationsResponse { } export namespace ListPublishingDestinationsResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListPublishingDestinationsResponse): any => ({ ...obj, }); @@ -4010,6 +4472,9 @@ export interface ListTagsForResourceRequest { } export namespace ListTagsForResourceRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListTagsForResourceRequest): any => ({ ...obj, }); @@ -4023,6 +4488,9 @@ export interface ListTagsForResourceResponse { } export namespace ListTagsForResourceResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListTagsForResourceResponse): any => ({ ...obj, }); @@ -4050,6 +4518,9 @@ export interface ListThreatIntelSetsRequest { } export namespace ListThreatIntelSetsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListThreatIntelSetsRequest): any => ({ ...obj, }); @@ -4069,6 +4540,9 @@ export interface ListThreatIntelSetsResponse { } export namespace ListThreatIntelSetsResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListThreatIntelSetsResponse): any => ({ ...obj, }); @@ -4088,6 +4562,9 @@ export interface StartMonitoringMembersRequest { } export namespace StartMonitoringMembersRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: StartMonitoringMembersRequest): any => ({ ...obj, }); @@ -4102,6 +4579,9 @@ export interface StartMonitoringMembersResponse { } export namespace StartMonitoringMembersResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: StartMonitoringMembersResponse): any => ({ ...obj, }); @@ -4121,6 +4601,9 @@ export interface StopMonitoringMembersRequest { } export namespace StopMonitoringMembersRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: StopMonitoringMembersRequest): any => ({ ...obj, }); @@ -4135,6 +4618,9 @@ export interface StopMonitoringMembersResponse { } export namespace StopMonitoringMembersResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: StopMonitoringMembersResponse): any => ({ ...obj, }); @@ -4153,6 +4639,9 @@ export interface TagResourceRequest { } export namespace TagResourceRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: TagResourceRequest): any => ({ ...obj, }); @@ -4161,6 +4650,9 @@ export namespace TagResourceRequest { export interface TagResourceResponse {} export namespace TagResourceResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: TagResourceResponse): any => ({ ...obj, }); @@ -4179,6 +4671,9 @@ export interface UnarchiveFindingsRequest { } export namespace UnarchiveFindingsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: UnarchiveFindingsRequest): any => ({ ...obj, }); @@ -4187,6 +4682,9 @@ export namespace UnarchiveFindingsRequest { export interface UnarchiveFindingsResponse {} export namespace UnarchiveFindingsResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: UnarchiveFindingsResponse): any => ({ ...obj, }); @@ -4205,6 +4703,9 @@ export interface UntagResourceRequest { } export namespace UntagResourceRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: UntagResourceRequest): any => ({ ...obj, }); @@ -4213,6 +4714,9 @@ export namespace UntagResourceRequest { export interface UntagResourceResponse {} export namespace UntagResourceResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: UntagResourceResponse): any => ({ ...obj, }); @@ -4242,6 +4746,9 @@ export interface UpdateDetectorRequest { } export namespace UpdateDetectorRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateDetectorRequest): any => ({ ...obj, }); @@ -4250,6 +4757,9 @@ export namespace UpdateDetectorRequest { export interface UpdateDetectorResponse {} export namespace UpdateDetectorResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateDetectorResponse): any => ({ ...obj, }); @@ -4290,6 +4800,9 @@ export interface UpdateFilterRequest { } export namespace UpdateFilterRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateFilterRequest): any => ({ ...obj, }); @@ -4303,6 +4816,9 @@ export interface UpdateFilterResponse { } export namespace UpdateFilterResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateFilterResponse): any => ({ ...obj, }); @@ -4331,6 +4847,9 @@ export interface UpdateFindingsFeedbackRequest { } export namespace UpdateFindingsFeedbackRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateFindingsFeedbackRequest): any => ({ ...obj, }); @@ -4339,6 +4858,9 @@ export namespace UpdateFindingsFeedbackRequest { export interface UpdateFindingsFeedbackResponse {} export namespace UpdateFindingsFeedbackResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateFindingsFeedbackResponse): any => ({ ...obj, }); @@ -4373,6 +4895,9 @@ export interface UpdateIPSetRequest { } export namespace UpdateIPSetRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateIPSetRequest): any => ({ ...obj, }); @@ -4381,6 +4906,9 @@ export namespace UpdateIPSetRequest { export interface UpdateIPSetResponse {} export namespace UpdateIPSetResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateIPSetResponse): any => ({ ...obj, }); @@ -4404,6 +4932,9 @@ export interface UpdateMemberDetectorsRequest { } export namespace UpdateMemberDetectorsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateMemberDetectorsRequest): any => ({ ...obj, }); @@ -4418,6 +4949,9 @@ export interface UpdateMemberDetectorsResponse { } export namespace UpdateMemberDetectorsResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateMemberDetectorsResponse): any => ({ ...obj, }); @@ -4436,6 +4970,9 @@ export interface OrganizationS3LogsConfiguration { } export namespace OrganizationS3LogsConfiguration { + /** + * @internal + */ export const filterSensitiveLog = (obj: OrganizationS3LogsConfiguration): any => ({ ...obj, }); @@ -4454,6 +4991,9 @@ export interface OrganizationDataSourceConfigurations { } export namespace OrganizationDataSourceConfigurations { + /** + * @internal + */ export const filterSensitiveLog = (obj: OrganizationDataSourceConfigurations): any => ({ ...obj, }); @@ -4477,6 +5017,9 @@ export interface UpdateOrganizationConfigurationRequest { } export namespace UpdateOrganizationConfigurationRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateOrganizationConfigurationRequest): any => ({ ...obj, }); @@ -4485,6 +5028,9 @@ export namespace UpdateOrganizationConfigurationRequest { export interface UpdateOrganizationConfigurationResponse {} export namespace UpdateOrganizationConfigurationResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateOrganizationConfigurationResponse): any => ({ ...obj, }); @@ -4509,6 +5055,9 @@ export interface UpdatePublishingDestinationRequest { } export namespace UpdatePublishingDestinationRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdatePublishingDestinationRequest): any => ({ ...obj, }); @@ -4517,6 +5066,9 @@ export namespace UpdatePublishingDestinationRequest { export interface UpdatePublishingDestinationResponse {} export namespace UpdatePublishingDestinationResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdatePublishingDestinationResponse): any => ({ ...obj, }); @@ -4552,6 +5104,9 @@ export interface UpdateThreatIntelSetRequest { } export namespace UpdateThreatIntelSetRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateThreatIntelSetRequest): any => ({ ...obj, }); @@ -4560,6 +5115,9 @@ export namespace UpdateThreatIntelSetRequest { export interface UpdateThreatIntelSetResponse {} export namespace UpdateThreatIntelSetResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateThreatIntelSetResponse): any => ({ ...obj, }); diff --git a/clients/client-health/commands/DescribeAffectedAccountsForOrganizationCommand.ts b/clients/client-health/commands/DescribeAffectedAccountsForOrganizationCommand.ts index b82ce63bf01d..dc95b7199be9 100644 --- a/clients/client-health/commands/DescribeAffectedAccountsForOrganizationCommand.ts +++ b/clients/client-health/commands/DescribeAffectedAccountsForOrganizationCommand.ts @@ -37,6 +37,20 @@ export interface DescribeAffectedAccountsForOrganizationCommandOutput * *

This API operation uses pagination. Specify the nextToken parameter in the next request to return more results.

* + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { HealthClient, DescribeAffectedAccountsForOrganizationCommand } from "@aws-sdk/client-health"; // ES Modules import + * // const { HealthClient, DescribeAffectedAccountsForOrganizationCommand } = require("@aws-sdk/client-health"); // CommonJS import + * const client = new HealthClient(config); + * const command = new DescribeAffectedAccountsForOrganizationCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeAffectedAccountsForOrganizationCommandInput} for command's `input` shape. + * @see {@link DescribeAffectedAccountsForOrganizationCommandOutput} for command's `response` shape. + * @see {@link HealthClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeAffectedAccountsForOrganizationCommand extends $Command< DescribeAffectedAccountsForOrganizationCommandInput, diff --git a/clients/client-health/commands/DescribeAffectedEntitiesCommand.ts b/clients/client-health/commands/DescribeAffectedEntitiesCommand.ts index 9282871a24b2..05107464d7d7 100644 --- a/clients/client-health/commands/DescribeAffectedEntitiesCommand.ts +++ b/clients/client-health/commands/DescribeAffectedEntitiesCommand.ts @@ -40,6 +40,20 @@ export interface DescribeAffectedEntitiesCommandOutput extends DescribeAffectedE * * * + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { HealthClient, DescribeAffectedEntitiesCommand } from "@aws-sdk/client-health"; // ES Modules import + * // const { HealthClient, DescribeAffectedEntitiesCommand } = require("@aws-sdk/client-health"); // CommonJS import + * const client = new HealthClient(config); + * const command = new DescribeAffectedEntitiesCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeAffectedEntitiesCommandInput} for command's `input` shape. + * @see {@link DescribeAffectedEntitiesCommandOutput} for command's `response` shape. + * @see {@link HealthClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeAffectedEntitiesCommand extends $Command< DescribeAffectedEntitiesCommandInput, diff --git a/clients/client-health/commands/DescribeAffectedEntitiesForOrganizationCommand.ts b/clients/client-health/commands/DescribeAffectedEntitiesForOrganizationCommand.ts index c0e6e2bd9750..5e59d7d66b5d 100644 --- a/clients/client-health/commands/DescribeAffectedEntitiesForOrganizationCommand.ts +++ b/clients/client-health/commands/DescribeAffectedEntitiesForOrganizationCommand.ts @@ -49,6 +49,20 @@ export interface DescribeAffectedEntitiesForOrganizationCommandOutput * * * + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { HealthClient, DescribeAffectedEntitiesForOrganizationCommand } from "@aws-sdk/client-health"; // ES Modules import + * // const { HealthClient, DescribeAffectedEntitiesForOrganizationCommand } = require("@aws-sdk/client-health"); // CommonJS import + * const client = new HealthClient(config); + * const command = new DescribeAffectedEntitiesForOrganizationCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeAffectedEntitiesForOrganizationCommandInput} for command's `input` shape. + * @see {@link DescribeAffectedEntitiesForOrganizationCommandOutput} for command's `response` shape. + * @see {@link HealthClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeAffectedEntitiesForOrganizationCommand extends $Command< DescribeAffectedEntitiesForOrganizationCommandInput, diff --git a/clients/client-health/commands/DescribeEntityAggregatesCommand.ts b/clients/client-health/commands/DescribeEntityAggregatesCommand.ts index 49b9de9ffd42..2e5dcc4ac3d3 100644 --- a/clients/client-health/commands/DescribeEntityAggregatesCommand.ts +++ b/clients/client-health/commands/DescribeEntityAggregatesCommand.ts @@ -23,6 +23,20 @@ export interface DescribeEntityAggregatesCommandOutput extends DescribeEntityAgg /** *

Returns the number of entities that are affected by each of the specified events. If no * events are specified, the counts of all affected entities are returned.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { HealthClient, DescribeEntityAggregatesCommand } from "@aws-sdk/client-health"; // ES Modules import + * // const { HealthClient, DescribeEntityAggregatesCommand } = require("@aws-sdk/client-health"); // CommonJS import + * const client = new HealthClient(config); + * const command = new DescribeEntityAggregatesCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeEntityAggregatesCommandInput} for command's `input` shape. + * @see {@link DescribeEntityAggregatesCommandOutput} for command's `response` shape. + * @see {@link HealthClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeEntityAggregatesCommand extends $Command< DescribeEntityAggregatesCommandInput, diff --git a/clients/client-health/commands/DescribeEventAggregatesCommand.ts b/clients/client-health/commands/DescribeEventAggregatesCommand.ts index a902b33c1082..6dbb0b5c1041 100644 --- a/clients/client-health/commands/DescribeEventAggregatesCommand.ts +++ b/clients/client-health/commands/DescribeEventAggregatesCommand.ts @@ -28,6 +28,20 @@ export interface DescribeEventAggregatesCommandOutput extends DescribeEventAggre * *

This API operation uses pagination. Specify the nextToken parameter in the next request to return more results.

* + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { HealthClient, DescribeEventAggregatesCommand } from "@aws-sdk/client-health"; // ES Modules import + * // const { HealthClient, DescribeEventAggregatesCommand } = require("@aws-sdk/client-health"); // CommonJS import + * const client = new HealthClient(config); + * const command = new DescribeEventAggregatesCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeEventAggregatesCommandInput} for command's `input` shape. + * @see {@link DescribeEventAggregatesCommandOutput} for command's `response` shape. + * @see {@link HealthClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeEventAggregatesCommand extends $Command< DescribeEventAggregatesCommandInput, diff --git a/clients/client-health/commands/DescribeEventDetailsCommand.ts b/clients/client-health/commands/DescribeEventDetailsCommand.ts index 3bfe74840e1b..4982b5197527 100644 --- a/clients/client-health/commands/DescribeEventDetailsCommand.ts +++ b/clients/client-health/commands/DescribeEventDetailsCommand.ts @@ -31,6 +31,20 @@ export interface DescribeEventDetailsCommandOutput extends DescribeEventDetailsR *

This operation supports resource-level permissions. You can use this operation to allow or deny access to specific AWS Health events. For more * information, see Resource- and action-based conditions in the AWS Health User Guide.

* + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { HealthClient, DescribeEventDetailsCommand } from "@aws-sdk/client-health"; // ES Modules import + * // const { HealthClient, DescribeEventDetailsCommand } = require("@aws-sdk/client-health"); // CommonJS import + * const client = new HealthClient(config); + * const command = new DescribeEventDetailsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeEventDetailsCommandInput} for command's `input` shape. + * @see {@link DescribeEventDetailsCommandOutput} for command's `response` shape. + * @see {@link HealthClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeEventDetailsCommand extends $Command< DescribeEventDetailsCommandInput, diff --git a/clients/client-health/commands/DescribeEventDetailsForOrganizationCommand.ts b/clients/client-health/commands/DescribeEventDetailsForOrganizationCommand.ts index e45dcfbf5af2..3f8e45ceaa09 100644 --- a/clients/client-health/commands/DescribeEventDetailsForOrganizationCommand.ts +++ b/clients/client-health/commands/DescribeEventDetailsForOrganizationCommand.ts @@ -56,6 +56,20 @@ export interface DescribeEventDetailsForOrganizationCommandOutput *

This operation doesn't support resource-level permissions. You can't use this operation to allow or deny access to specific AWS Health events. For more * information, see Resource- and action-based conditions in the AWS Health User Guide.

* + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { HealthClient, DescribeEventDetailsForOrganizationCommand } from "@aws-sdk/client-health"; // ES Modules import + * // const { HealthClient, DescribeEventDetailsForOrganizationCommand } = require("@aws-sdk/client-health"); // CommonJS import + * const client = new HealthClient(config); + * const command = new DescribeEventDetailsForOrganizationCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeEventDetailsForOrganizationCommandInput} for command's `input` shape. + * @see {@link DescribeEventDetailsForOrganizationCommandOutput} for command's `response` shape. + * @see {@link HealthClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeEventDetailsForOrganizationCommand extends $Command< DescribeEventDetailsForOrganizationCommandInput, diff --git a/clients/client-health/commands/DescribeEventTypesCommand.ts b/clients/client-health/commands/DescribeEventTypesCommand.ts index e859fa3a5984..cb5156300b8e 100644 --- a/clients/client-health/commands/DescribeEventTypesCommand.ts +++ b/clients/client-health/commands/DescribeEventTypesCommand.ts @@ -29,6 +29,20 @@ export interface DescribeEventTypesCommandOutput extends DescribeEventTypesRespo * *

This API operation uses pagination. Specify the nextToken parameter in the next request to return more results.

* + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { HealthClient, DescribeEventTypesCommand } from "@aws-sdk/client-health"; // ES Modules import + * // const { HealthClient, DescribeEventTypesCommand } = require("@aws-sdk/client-health"); // CommonJS import + * const client = new HealthClient(config); + * const command = new DescribeEventTypesCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeEventTypesCommandInput} for command's `input` shape. + * @see {@link DescribeEventTypesCommandOutput} for command's `response` shape. + * @see {@link HealthClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeEventTypesCommand extends $Command< DescribeEventTypesCommandInput, diff --git a/clients/client-health/commands/DescribeEventsCommand.ts b/clients/client-health/commands/DescribeEventsCommand.ts index e5ff07829648..9a5a7b1fc2c0 100644 --- a/clients/client-health/commands/DescribeEventsCommand.ts +++ b/clients/client-health/commands/DescribeEventsCommand.ts @@ -45,6 +45,20 @@ export interface DescribeEventsCommandOutput extends DescribeEventsResponse, __M * * * + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { HealthClient, DescribeEventsCommand } from "@aws-sdk/client-health"; // ES Modules import + * // const { HealthClient, DescribeEventsCommand } = require("@aws-sdk/client-health"); // CommonJS import + * const client = new HealthClient(config); + * const command = new DescribeEventsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeEventsCommandInput} for command's `input` shape. + * @see {@link DescribeEventsCommandOutput} for command's `response` shape. + * @see {@link HealthClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeEventsCommand extends $Command< DescribeEventsCommandInput, diff --git a/clients/client-health/commands/DescribeEventsForOrganizationCommand.ts b/clients/client-health/commands/DescribeEventsForOrganizationCommand.ts index 156de574983b..6caceb71d9cc 100644 --- a/clients/client-health/commands/DescribeEventsForOrganizationCommand.ts +++ b/clients/client-health/commands/DescribeEventsForOrganizationCommand.ts @@ -55,6 +55,20 @@ export interface DescribeEventsForOrganizationCommandOutput * *

This API operation uses pagination. Specify the nextToken parameter in the next request to return more results.

* + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { HealthClient, DescribeEventsForOrganizationCommand } from "@aws-sdk/client-health"; // ES Modules import + * // const { HealthClient, DescribeEventsForOrganizationCommand } = require("@aws-sdk/client-health"); // CommonJS import + * const client = new HealthClient(config); + * const command = new DescribeEventsForOrganizationCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeEventsForOrganizationCommandInput} for command's `input` shape. + * @see {@link DescribeEventsForOrganizationCommandOutput} for command's `response` shape. + * @see {@link HealthClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeEventsForOrganizationCommand extends $Command< DescribeEventsForOrganizationCommandInput, diff --git a/clients/client-health/commands/DescribeHealthServiceStatusForOrganizationCommand.ts b/clients/client-health/commands/DescribeHealthServiceStatusForOrganizationCommand.ts index 31bb6232c9b8..778e613e98cb 100644 --- a/clients/client-health/commands/DescribeHealthServiceStatusForOrganizationCommand.ts +++ b/clients/client-health/commands/DescribeHealthServiceStatusForOrganizationCommand.ts @@ -26,6 +26,20 @@ export interface DescribeHealthServiceStatusForOrganizationCommandOutput *

This operation provides status information on enabling or disabling AWS 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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { HealthClient, DescribeHealthServiceStatusForOrganizationCommand } from "@aws-sdk/client-health"; // ES Modules import + * // const { HealthClient, DescribeHealthServiceStatusForOrganizationCommand } = require("@aws-sdk/client-health"); // CommonJS import + * const client = new HealthClient(config); + * const command = new DescribeHealthServiceStatusForOrganizationCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeHealthServiceStatusForOrganizationCommandInput} for command's `input` shape. + * @see {@link DescribeHealthServiceStatusForOrganizationCommandOutput} for command's `response` shape. + * @see {@link HealthClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeHealthServiceStatusForOrganizationCommand extends $Command< DescribeHealthServiceStatusForOrganizationCommandInput, diff --git a/clients/client-health/commands/DisableHealthServiceAccessForOrganizationCommand.ts b/clients/client-health/commands/DisableHealthServiceAccessForOrganizationCommand.ts index 3e3edbe246da..d5273965cf1d 100644 --- a/clients/client-health/commands/DisableHealthServiceAccessForOrganizationCommand.ts +++ b/clients/client-health/commands/DisableHealthServiceAccessForOrganizationCommand.ts @@ -35,6 +35,20 @@ export interface DisableHealthServiceAccessForOrganizationCommandOutput extends * an error. AWS Health continues to aggregate health events for your AWS * account.

* + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { HealthClient, DisableHealthServiceAccessForOrganizationCommand } from "@aws-sdk/client-health"; // ES Modules import + * // const { HealthClient, DisableHealthServiceAccessForOrganizationCommand } = require("@aws-sdk/client-health"); // CommonJS import + * const client = new HealthClient(config); + * const command = new DisableHealthServiceAccessForOrganizationCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DisableHealthServiceAccessForOrganizationCommandInput} for command's `input` shape. + * @see {@link DisableHealthServiceAccessForOrganizationCommandOutput} for command's `response` shape. + * @see {@link HealthClientResolvedConfig | config} for command's `input` shape. + * */ export class DisableHealthServiceAccessForOrganizationCommand extends $Command< DisableHealthServiceAccessForOrganizationCommandInput, diff --git a/clients/client-health/commands/EnableHealthServiceAccessForOrganizationCommand.ts b/clients/client-health/commands/EnableHealthServiceAccessForOrganizationCommand.ts index 450dda5dcb28..7918fe3bfb8a 100644 --- a/clients/client-health/commands/EnableHealthServiceAccessForOrganizationCommand.ts +++ b/clients/client-health/commands/EnableHealthServiceAccessForOrganizationCommand.ts @@ -43,6 +43,20 @@ export interface EnableHealthServiceAccessForOrganizationCommandOutput extends _ *

If you don't have the required support plan, you can instead use the AWS Health console * to enable the organizational view feature. For more information, see Aggregating * AWS Health events in the AWS Health User Guide.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { HealthClient, EnableHealthServiceAccessForOrganizationCommand } from "@aws-sdk/client-health"; // ES Modules import + * // const { HealthClient, EnableHealthServiceAccessForOrganizationCommand } = require("@aws-sdk/client-health"); // CommonJS import + * const client = new HealthClient(config); + * const command = new EnableHealthServiceAccessForOrganizationCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link EnableHealthServiceAccessForOrganizationCommandInput} for command's `input` shape. + * @see {@link EnableHealthServiceAccessForOrganizationCommandOutput} for command's `response` shape. + * @see {@link HealthClientResolvedConfig | config} for command's `input` shape. + * */ export class EnableHealthServiceAccessForOrganizationCommand extends $Command< EnableHealthServiceAccessForOrganizationCommandInput, diff --git a/clients/client-health/models/models_0.ts b/clients/client-health/models/models_0.ts index 7c1aeab893de..bcee34c33ce5 100644 --- a/clients/client-health/models/models_0.ts +++ b/clients/client-health/models/models_0.ts @@ -61,6 +61,9 @@ export interface AffectedEntity { } export namespace AffectedEntity { + /** + * @internal + */ export const filterSensitiveLog = (obj: AffectedEntity): any => ({ ...obj, }); @@ -89,6 +92,9 @@ export interface DescribeAffectedAccountsForOrganizationRequest { } export namespace DescribeAffectedAccountsForOrganizationRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeAffectedAccountsForOrganizationRequest): any => ({ ...obj, }); @@ -139,6 +145,9 @@ export interface DescribeAffectedAccountsForOrganizationResponse { } export namespace DescribeAffectedAccountsForOrganizationResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeAffectedAccountsForOrganizationResponse): any => ({ ...obj, }); @@ -154,6 +163,9 @@ export interface InvalidPaginationToken extends __SmithyException, $MetadataBear } export namespace InvalidPaginationToken { + /** + * @internal + */ export const filterSensitiveLog = (obj: InvalidPaginationToken): any => ({ ...obj, }); @@ -182,6 +194,9 @@ export interface DateTimeRange { } export namespace DateTimeRange { + /** + * @internal + */ export const filterSensitiveLog = (obj: DateTimeRange): any => ({ ...obj, }); @@ -229,6 +244,9 @@ export interface EntityFilter { } export namespace EntityFilter { + /** + * @internal + */ export const filterSensitiveLog = (obj: EntityFilter): any => ({ ...obj, }); @@ -260,6 +278,9 @@ export interface DescribeAffectedEntitiesRequest { } export namespace DescribeAffectedEntitiesRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeAffectedEntitiesRequest): any => ({ ...obj, }); @@ -281,6 +302,9 @@ export interface DescribeAffectedEntitiesResponse { } export namespace DescribeAffectedEntitiesResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeAffectedEntitiesResponse): any => ({ ...obj, }); @@ -296,6 +320,9 @@ export interface UnsupportedLocale extends __SmithyException, $MetadataBearer { } export namespace UnsupportedLocale { + /** + * @internal + */ export const filterSensitiveLog = (obj: UnsupportedLocale): any => ({ ...obj, }); @@ -320,6 +347,9 @@ export interface EventAccountFilter { } export namespace EventAccountFilter { + /** + * @internal + */ export const filterSensitiveLog = (obj: EventAccountFilter): any => ({ ...obj, }); @@ -352,6 +382,9 @@ export interface DescribeAffectedEntitiesForOrganizationRequest { } export namespace DescribeAffectedEntitiesForOrganizationRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeAffectedEntitiesForOrganizationRequest): any => ({ ...obj, }); @@ -388,6 +421,9 @@ export interface OrganizationAffectedEntitiesErrorItem { } export namespace OrganizationAffectedEntitiesErrorItem { + /** + * @internal + */ export const filterSensitiveLog = (obj: OrganizationAffectedEntitiesErrorItem): any => ({ ...obj, }); @@ -417,6 +453,9 @@ export interface DescribeAffectedEntitiesForOrganizationResponse { } export namespace DescribeAffectedEntitiesForOrganizationResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeAffectedEntitiesForOrganizationResponse): any => ({ ...obj, }); @@ -431,6 +470,9 @@ export interface DescribeEntityAggregatesRequest { } export namespace DescribeEntityAggregatesRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeEntityAggregatesRequest): any => ({ ...obj, }); @@ -455,6 +497,9 @@ export interface EntityAggregate { } export namespace EntityAggregate { + /** + * @internal + */ export const filterSensitiveLog = (obj: EntityAggregate): any => ({ ...obj, }); @@ -468,6 +513,9 @@ export interface DescribeEntityAggregatesResponse { } export namespace DescribeEntityAggregatesResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeEntityAggregatesResponse): any => ({ ...obj, }); @@ -569,6 +617,9 @@ export interface EventFilter { } export namespace EventFilter { + /** + * @internal + */ export const filterSensitiveLog = (obj: EventFilter): any => ({ ...obj, }); @@ -600,6 +651,9 @@ export interface DescribeEventAggregatesRequest { } export namespace DescribeEventAggregatesRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeEventAggregatesRequest): any => ({ ...obj, }); @@ -621,6 +675,9 @@ export interface EventAggregate { } export namespace EventAggregate { + /** + * @internal + */ export const filterSensitiveLog = (obj: EventAggregate): any => ({ ...obj, }); @@ -642,6 +699,9 @@ export interface DescribeEventAggregatesResponse { } export namespace DescribeEventAggregatesResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeEventAggregatesResponse): any => ({ ...obj, }); @@ -661,6 +721,9 @@ export interface DescribeEventDetailsRequest { } export namespace DescribeEventDetailsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeEventDetailsRequest): any => ({ ...obj, }); @@ -690,6 +753,9 @@ export interface EventDetailsErrorItem { } export namespace EventDetailsErrorItem { + /** + * @internal + */ export const filterSensitiveLog = (obj: EventDetailsErrorItem): any => ({ ...obj, }); @@ -798,6 +864,9 @@ export interface Event { } export namespace Event { + /** + * @internal + */ export const filterSensitiveLog = (obj: Event): any => ({ ...obj, }); @@ -814,6 +883,9 @@ export interface EventDescription { } export namespace EventDescription { + /** + * @internal + */ export const filterSensitiveLog = (obj: EventDescription): any => ({ ...obj, }); @@ -842,6 +914,9 @@ export interface EventDetails { } export namespace EventDetails { + /** + * @internal + */ export const filterSensitiveLog = (obj: EventDetails): any => ({ ...obj, }); @@ -860,6 +935,9 @@ export interface DescribeEventDetailsResponse { } export namespace DescribeEventDetailsResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeEventDetailsResponse): any => ({ ...obj, }); @@ -879,6 +957,9 @@ export interface DescribeEventDetailsForOrganizationRequest { } export namespace DescribeEventDetailsForOrganizationRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeEventDetailsForOrganizationRequest): any => ({ ...obj, }); @@ -914,6 +995,9 @@ export interface OrganizationEventDetailsErrorItem { } export namespace OrganizationEventDetailsErrorItem { + /** + * @internal + */ export const filterSensitiveLog = (obj: OrganizationEventDetailsErrorItem): any => ({ ...obj, }); @@ -966,6 +1050,9 @@ export interface OrganizationEventDetails { } export namespace OrganizationEventDetails { + /** + * @internal + */ export const filterSensitiveLog = (obj: OrganizationEventDetails): any => ({ ...obj, }); @@ -984,6 +1071,9 @@ export interface DescribeEventDetailsForOrganizationResponse { } export namespace DescribeEventDetailsForOrganizationResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeEventDetailsForOrganizationResponse): any => ({ ...obj, }); @@ -1015,6 +1105,9 @@ export interface DescribeEventsRequest { } export namespace DescribeEventsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeEventsRequest): any => ({ ...obj, }); @@ -1036,6 +1129,9 @@ export interface DescribeEventsResponse { } export namespace DescribeEventsResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeEventsResponse): any => ({ ...obj, }); @@ -1125,6 +1221,9 @@ export interface OrganizationEventFilter { } export namespace OrganizationEventFilter { + /** + * @internal + */ export const filterSensitiveLog = (obj: OrganizationEventFilter): any => ({ ...obj, }); @@ -1156,6 +1255,9 @@ export interface DescribeEventsForOrganizationRequest { } export namespace DescribeEventsForOrganizationRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeEventsForOrganizationRequest): any => ({ ...obj, }); @@ -1240,6 +1342,9 @@ export interface OrganizationEvent { } export namespace OrganizationEvent { + /** + * @internal + */ export const filterSensitiveLog = (obj: OrganizationEvent): any => ({ ...obj, }); @@ -1261,6 +1366,9 @@ export interface DescribeEventsForOrganizationResponse { } export namespace DescribeEventsForOrganizationResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeEventsForOrganizationResponse): any => ({ ...obj, }); @@ -1289,6 +1397,9 @@ export interface EventTypeFilter { } export namespace EventTypeFilter { + /** + * @internal + */ export const filterSensitiveLog = (obj: EventTypeFilter): any => ({ ...obj, }); @@ -1320,6 +1431,9 @@ export interface DescribeEventTypesRequest { } export namespace DescribeEventTypesRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeEventTypesRequest): any => ({ ...obj, }); @@ -1357,6 +1471,9 @@ export interface EventType { } export namespace EventType { + /** + * @internal + */ export const filterSensitiveLog = (obj: EventType): any => ({ ...obj, }); @@ -1384,6 +1501,9 @@ export interface DescribeEventTypesResponse { } export namespace DescribeEventTypesResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeEventTypesResponse): any => ({ ...obj, }); @@ -1399,6 +1519,9 @@ export interface DescribeHealthServiceStatusForOrganizationResponse { } export namespace DescribeHealthServiceStatusForOrganizationResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeHealthServiceStatusForOrganizationResponse): any => ({ ...obj, }); @@ -1416,6 +1539,9 @@ export interface ConcurrentModificationException extends __SmithyException, $Met } export namespace ConcurrentModificationException { + /** + * @internal + */ export const filterSensitiveLog = (obj: ConcurrentModificationException): any => ({ ...obj, }); diff --git a/clients/client-healthlake/commands/CreateFHIRDatastoreCommand.ts b/clients/client-healthlake/commands/CreateFHIRDatastoreCommand.ts index 0df73dccc76f..2e13682d121d 100644 --- a/clients/client-healthlake/commands/CreateFHIRDatastoreCommand.ts +++ b/clients/client-healthlake/commands/CreateFHIRDatastoreCommand.ts @@ -22,6 +22,20 @@ export interface CreateFHIRDatastoreCommandOutput extends CreateFHIRDatastoreRes /** *

Creates a Data Store that can ingest and export FHIR formatted data.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { HealthLakeClient, CreateFHIRDatastoreCommand } from "@aws-sdk/client-healthlake"; // ES Modules import + * // const { HealthLakeClient, CreateFHIRDatastoreCommand } = require("@aws-sdk/client-healthlake"); // CommonJS import + * const client = new HealthLakeClient(config); + * const command = new CreateFHIRDatastoreCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreateFHIRDatastoreCommandInput} for command's `input` shape. + * @see {@link CreateFHIRDatastoreCommandOutput} for command's `response` shape. + * @see {@link HealthLakeClientResolvedConfig | config} for command's `input` shape. + * */ export class CreateFHIRDatastoreCommand extends $Command< CreateFHIRDatastoreCommandInput, diff --git a/clients/client-healthlake/commands/DeleteFHIRDatastoreCommand.ts b/clients/client-healthlake/commands/DeleteFHIRDatastoreCommand.ts index 537f22f26c67..4a697d2630cd 100644 --- a/clients/client-healthlake/commands/DeleteFHIRDatastoreCommand.ts +++ b/clients/client-healthlake/commands/DeleteFHIRDatastoreCommand.ts @@ -22,6 +22,20 @@ export interface DeleteFHIRDatastoreCommandOutput extends DeleteFHIRDatastoreRes /** *

Deletes a Data Store.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { HealthLakeClient, DeleteFHIRDatastoreCommand } from "@aws-sdk/client-healthlake"; // ES Modules import + * // const { HealthLakeClient, DeleteFHIRDatastoreCommand } = require("@aws-sdk/client-healthlake"); // CommonJS import + * const client = new HealthLakeClient(config); + * const command = new DeleteFHIRDatastoreCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteFHIRDatastoreCommandInput} for command's `input` shape. + * @see {@link DeleteFHIRDatastoreCommandOutput} for command's `response` shape. + * @see {@link HealthLakeClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteFHIRDatastoreCommand extends $Command< DeleteFHIRDatastoreCommandInput, diff --git a/clients/client-healthlake/commands/DescribeFHIRDatastoreCommand.ts b/clients/client-healthlake/commands/DescribeFHIRDatastoreCommand.ts index 85b63a869639..2f2fcc9a1f11 100644 --- a/clients/client-healthlake/commands/DescribeFHIRDatastoreCommand.ts +++ b/clients/client-healthlake/commands/DescribeFHIRDatastoreCommand.ts @@ -24,6 +24,20 @@ export interface DescribeFHIRDatastoreCommandOutput extends DescribeFHIRDatastor *

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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { HealthLakeClient, DescribeFHIRDatastoreCommand } from "@aws-sdk/client-healthlake"; // ES Modules import + * // const { HealthLakeClient, DescribeFHIRDatastoreCommand } = require("@aws-sdk/client-healthlake"); // CommonJS import + * const client = new HealthLakeClient(config); + * const command = new DescribeFHIRDatastoreCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeFHIRDatastoreCommandInput} for command's `input` shape. + * @see {@link DescribeFHIRDatastoreCommandOutput} for command's `response` shape. + * @see {@link HealthLakeClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeFHIRDatastoreCommand extends $Command< DescribeFHIRDatastoreCommandInput, diff --git a/clients/client-healthlake/commands/DescribeFHIRExportJobCommand.ts b/clients/client-healthlake/commands/DescribeFHIRExportJobCommand.ts index 7167a4e1d1ea..df3ff25eb538 100644 --- a/clients/client-healthlake/commands/DescribeFHIRExportJobCommand.ts +++ b/clients/client-healthlake/commands/DescribeFHIRExportJobCommand.ts @@ -22,6 +22,20 @@ export interface DescribeFHIRExportJobCommandOutput extends DescribeFHIRExportJo /** *

Displays the properties of a FHIR export job, including the ID, ARN, name, and the status of the job.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { HealthLakeClient, DescribeFHIRExportJobCommand } from "@aws-sdk/client-healthlake"; // ES Modules import + * // const { HealthLakeClient, DescribeFHIRExportJobCommand } = require("@aws-sdk/client-healthlake"); // CommonJS import + * const client = new HealthLakeClient(config); + * const command = new DescribeFHIRExportJobCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeFHIRExportJobCommandInput} for command's `input` shape. + * @see {@link DescribeFHIRExportJobCommandOutput} for command's `response` shape. + * @see {@link HealthLakeClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeFHIRExportJobCommand extends $Command< DescribeFHIRExportJobCommandInput, diff --git a/clients/client-healthlake/commands/DescribeFHIRImportJobCommand.ts b/clients/client-healthlake/commands/DescribeFHIRImportJobCommand.ts index bef0daf1a1aa..f054e01e251b 100644 --- a/clients/client-healthlake/commands/DescribeFHIRImportJobCommand.ts +++ b/clients/client-healthlake/commands/DescribeFHIRImportJobCommand.ts @@ -22,6 +22,20 @@ export interface DescribeFHIRImportJobCommandOutput extends DescribeFHIRImportJo /** *

Displays the properties of a FHIR import job, including the ID, ARN, name, and the status of the job.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { HealthLakeClient, DescribeFHIRImportJobCommand } from "@aws-sdk/client-healthlake"; // ES Modules import + * // const { HealthLakeClient, DescribeFHIRImportJobCommand } = require("@aws-sdk/client-healthlake"); // CommonJS import + * const client = new HealthLakeClient(config); + * const command = new DescribeFHIRImportJobCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeFHIRImportJobCommandInput} for command's `input` shape. + * @see {@link DescribeFHIRImportJobCommandOutput} for command's `response` shape. + * @see {@link HealthLakeClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeFHIRImportJobCommand extends $Command< DescribeFHIRImportJobCommandInput, diff --git a/clients/client-healthlake/commands/ListFHIRDatastoresCommand.ts b/clients/client-healthlake/commands/ListFHIRDatastoresCommand.ts index 77bcb6c8a4dc..c7c91c09f8e8 100644 --- a/clients/client-healthlake/commands/ListFHIRDatastoresCommand.ts +++ b/clients/client-healthlake/commands/ListFHIRDatastoresCommand.ts @@ -23,6 +23,20 @@ export interface ListFHIRDatastoresCommandOutput extends ListFHIRDatastoresRespo /** *

Lists all FHIR Data Stores that are in the user’s account, regardless of Data Store * status.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { HealthLakeClient, ListFHIRDatastoresCommand } from "@aws-sdk/client-healthlake"; // ES Modules import + * // const { HealthLakeClient, ListFHIRDatastoresCommand } = require("@aws-sdk/client-healthlake"); // CommonJS import + * const client = new HealthLakeClient(config); + * const command = new ListFHIRDatastoresCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListFHIRDatastoresCommandInput} for command's `input` shape. + * @see {@link ListFHIRDatastoresCommandOutput} for command's `response` shape. + * @see {@link HealthLakeClientResolvedConfig | config} for command's `input` shape. + * */ export class ListFHIRDatastoresCommand extends $Command< ListFHIRDatastoresCommandInput, diff --git a/clients/client-healthlake/commands/StartFHIRExportJobCommand.ts b/clients/client-healthlake/commands/StartFHIRExportJobCommand.ts index 6a21c2b430d3..3e5784a53183 100644 --- a/clients/client-healthlake/commands/StartFHIRExportJobCommand.ts +++ b/clients/client-healthlake/commands/StartFHIRExportJobCommand.ts @@ -22,6 +22,20 @@ export interface StartFHIRExportJobCommandOutput extends StartFHIRExportJobRespo /** *

Begins a FHIR export job.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { HealthLakeClient, StartFHIRExportJobCommand } from "@aws-sdk/client-healthlake"; // ES Modules import + * // const { HealthLakeClient, StartFHIRExportJobCommand } = require("@aws-sdk/client-healthlake"); // CommonJS import + * const client = new HealthLakeClient(config); + * const command = new StartFHIRExportJobCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link StartFHIRExportJobCommandInput} for command's `input` shape. + * @see {@link StartFHIRExportJobCommandOutput} for command's `response` shape. + * @see {@link HealthLakeClientResolvedConfig | config} for command's `input` shape. + * */ export class StartFHIRExportJobCommand extends $Command< StartFHIRExportJobCommandInput, diff --git a/clients/client-healthlake/commands/StartFHIRImportJobCommand.ts b/clients/client-healthlake/commands/StartFHIRImportJobCommand.ts index 1185fec48273..394ee90a441a 100644 --- a/clients/client-healthlake/commands/StartFHIRImportJobCommand.ts +++ b/clients/client-healthlake/commands/StartFHIRImportJobCommand.ts @@ -22,6 +22,20 @@ export interface StartFHIRImportJobCommandOutput extends StartFHIRImportJobRespo /** *

Begins a FHIR Import job.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { HealthLakeClient, StartFHIRImportJobCommand } from "@aws-sdk/client-healthlake"; // ES Modules import + * // const { HealthLakeClient, StartFHIRImportJobCommand } = require("@aws-sdk/client-healthlake"); // CommonJS import + * const client = new HealthLakeClient(config); + * const command = new StartFHIRImportJobCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link StartFHIRImportJobCommandInput} for command's `input` shape. + * @see {@link StartFHIRImportJobCommandOutput} for command's `response` shape. + * @see {@link HealthLakeClientResolvedConfig | config} for command's `input` shape. + * */ export class StartFHIRImportJobCommand extends $Command< StartFHIRImportJobCommandInput, diff --git a/clients/client-healthlake/models/models_0.ts b/clients/client-healthlake/models/models_0.ts index c684297496dc..95e879e6ceba 100644 --- a/clients/client-healthlake/models/models_0.ts +++ b/clients/client-healthlake/models/models_0.ts @@ -11,6 +11,9 @@ export interface AccessDeniedException extends __SmithyException, $MetadataBeare } export namespace AccessDeniedException { + /** + * @internal + */ export const filterSensitiveLog = (obj: AccessDeniedException): any => ({ ...obj, }); @@ -26,6 +29,9 @@ export interface ConflictException extends __SmithyException, $MetadataBearer { } export namespace ConflictException { + /** + * @internal + */ export const filterSensitiveLog = (obj: ConflictException): any => ({ ...obj, }); @@ -50,6 +56,9 @@ export interface PreloadDataConfig { } export namespace PreloadDataConfig { + /** + * @internal + */ export const filterSensitiveLog = (obj: PreloadDataConfig): any => ({ ...obj, }); @@ -79,6 +88,9 @@ export interface CreateFHIRDatastoreRequest { } export namespace CreateFHIRDatastoreRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateFHIRDatastoreRequest): any => ({ ...obj, }); @@ -118,6 +130,9 @@ export interface CreateFHIRDatastoreResponse { } export namespace CreateFHIRDatastoreResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateFHIRDatastoreResponse): any => ({ ...obj, }); @@ -133,6 +148,9 @@ export interface InternalServerException extends __SmithyException, $MetadataBea } export namespace InternalServerException { + /** + * @internal + */ export const filterSensitiveLog = (obj: InternalServerException): any => ({ ...obj, }); @@ -148,6 +166,9 @@ export interface ThrottlingException extends __SmithyException, $MetadataBearer } export namespace ThrottlingException { + /** + * @internal + */ export const filterSensitiveLog = (obj: ThrottlingException): any => ({ ...obj, }); @@ -163,6 +184,9 @@ export interface ValidationException extends __SmithyException, $MetadataBearer } export namespace ValidationException { + /** + * @internal + */ export const filterSensitiveLog = (obj: ValidationException): any => ({ ...obj, }); @@ -196,6 +220,9 @@ export interface DatastoreFilter { } export namespace DatastoreFilter { + /** + * @internal + */ export const filterSensitiveLog = (obj: DatastoreFilter): any => ({ ...obj, }); @@ -247,6 +274,9 @@ export interface DatastoreProperties { } export namespace DatastoreProperties { + /** + * @internal + */ export const filterSensitiveLog = (obj: DatastoreProperties): any => ({ ...obj, }); @@ -260,6 +290,9 @@ export interface DeleteFHIRDatastoreRequest { } export namespace DeleteFHIRDatastoreRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteFHIRDatastoreRequest): any => ({ ...obj, }); @@ -289,6 +322,9 @@ export interface DeleteFHIRDatastoreResponse { } export namespace DeleteFHIRDatastoreResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteFHIRDatastoreResponse): any => ({ ...obj, }); @@ -304,6 +340,9 @@ export interface ResourceNotFoundException extends __SmithyException, $MetadataB } export namespace ResourceNotFoundException { + /** + * @internal + */ export const filterSensitiveLog = (obj: ResourceNotFoundException): any => ({ ...obj, }); @@ -317,6 +356,9 @@ export interface DescribeFHIRDatastoreRequest { } export namespace DescribeFHIRDatastoreRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeFHIRDatastoreRequest): any => ({ ...obj, }); @@ -332,6 +374,9 @@ export interface DescribeFHIRDatastoreResponse { } export namespace DescribeFHIRDatastoreResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeFHIRDatastoreResponse): any => ({ ...obj, }); @@ -350,6 +395,9 @@ export interface DescribeFHIRExportJobRequest { } export namespace DescribeFHIRExportJobRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeFHIRExportJobRequest): any => ({ ...obj, }); @@ -391,6 +439,9 @@ export namespace OutputDataConfig { return visitor._(value.$unknown[0], value.$unknown[1]); }; + /** + * @internal + */ export const filterSensitiveLog = (obj: OutputDataConfig): any => { if (obj.S3Uri !== undefined) return { S3Uri: obj.S3Uri }; if (obj.$unknown !== undefined) return { [obj.$unknown[0]]: "UNKNOWN" }; @@ -448,6 +499,9 @@ export interface ExportJobProperties { } export namespace ExportJobProperties { + /** + * @internal + */ export const filterSensitiveLog = (obj: ExportJobProperties): any => ({ ...obj, ...(obj.OutputDataConfig && { OutputDataConfig: OutputDataConfig.filterSensitiveLog(obj.OutputDataConfig) }), @@ -462,6 +516,9 @@ export interface DescribeFHIRExportJobResponse { } export namespace DescribeFHIRExportJobResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeFHIRExportJobResponse): any => ({ ...obj, ...(obj.ExportJobProperties && { @@ -483,6 +540,9 @@ export interface DescribeFHIRImportJobRequest { } export namespace DescribeFHIRImportJobRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeFHIRImportJobRequest): any => ({ ...obj, }); @@ -517,6 +577,9 @@ export namespace InputDataConfig { return visitor._(value.$unknown[0], value.$unknown[1]); }; + /** + * @internal + */ export const filterSensitiveLog = (obj: InputDataConfig): any => { if (obj.S3Uri !== undefined) return { S3Uri: obj.S3Uri }; if (obj.$unknown !== undefined) return { [obj.$unknown[0]]: "UNKNOWN" }; @@ -574,6 +637,9 @@ export interface ImportJobProperties { } export namespace ImportJobProperties { + /** + * @internal + */ export const filterSensitiveLog = (obj: ImportJobProperties): any => ({ ...obj, ...(obj.InputDataConfig && { InputDataConfig: InputDataConfig.filterSensitiveLog(obj.InputDataConfig) }), @@ -588,6 +654,9 @@ export interface DescribeFHIRImportJobResponse { } export namespace DescribeFHIRImportJobResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeFHIRImportJobResponse): any => ({ ...obj, ...(obj.ImportJobProperties && { @@ -615,6 +684,9 @@ export interface ListFHIRDatastoresRequest { } export namespace ListFHIRDatastoresRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListFHIRDatastoresRequest): any => ({ ...obj, }); @@ -633,6 +705,9 @@ export interface ListFHIRDatastoresResponse { } export namespace ListFHIRDatastoresResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListFHIRDatastoresResponse): any => ({ ...obj, }); @@ -666,6 +741,9 @@ export interface StartFHIRExportJobRequest { } export namespace StartFHIRExportJobRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: StartFHIRExportJobRequest): any => ({ ...obj, ...(obj.OutputDataConfig && { OutputDataConfig: OutputDataConfig.filterSensitiveLog(obj.OutputDataConfig) }), @@ -690,6 +768,9 @@ export interface StartFHIRExportJobResponse { } export namespace StartFHIRExportJobResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: StartFHIRExportJobResponse): any => ({ ...obj, }); @@ -723,6 +804,9 @@ export interface StartFHIRImportJobRequest { } export namespace StartFHIRImportJobRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: StartFHIRImportJobRequest): any => ({ ...obj, ...(obj.InputDataConfig && { InputDataConfig: InputDataConfig.filterSensitiveLog(obj.InputDataConfig) }), @@ -747,6 +831,9 @@ export interface StartFHIRImportJobResponse { } export namespace StartFHIRImportJobResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: StartFHIRImportJobResponse): any => ({ ...obj, }); diff --git a/clients/client-honeycode/commands/BatchCreateTableRowsCommand.ts b/clients/client-honeycode/commands/BatchCreateTableRowsCommand.ts index 2f550f5ac596..667a027a500f 100644 --- a/clients/client-honeycode/commands/BatchCreateTableRowsCommand.ts +++ b/clients/client-honeycode/commands/BatchCreateTableRowsCommand.ts @@ -31,6 +31,20 @@ export interface BatchCreateTableRowsCommandOutput extends BatchCreateTableRowsR * 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. *

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { HoneycodeClient, BatchCreateTableRowsCommand } from "@aws-sdk/client-honeycode"; // ES Modules import + * // const { HoneycodeClient, BatchCreateTableRowsCommand } = require("@aws-sdk/client-honeycode"); // CommonJS import + * const client = new HoneycodeClient(config); + * const command = new BatchCreateTableRowsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link BatchCreateTableRowsCommandInput} for command's `input` shape. + * @see {@link BatchCreateTableRowsCommandOutput} for command's `response` shape. + * @see {@link HoneycodeClientResolvedConfig | config} for command's `input` shape. + * */ export class BatchCreateTableRowsCommand extends $Command< BatchCreateTableRowsCommandInput, diff --git a/clients/client-honeycode/commands/BatchDeleteTableRowsCommand.ts b/clients/client-honeycode/commands/BatchDeleteTableRowsCommand.ts index 287dd1b663d0..03a3845e20a1 100644 --- a/clients/client-honeycode/commands/BatchDeleteTableRowsCommand.ts +++ b/clients/client-honeycode/commands/BatchDeleteTableRowsCommand.ts @@ -25,6 +25,20 @@ export interface BatchDeleteTableRowsCommandOutput extends BatchDeleteTableRowsR * 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. *

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { HoneycodeClient, BatchDeleteTableRowsCommand } from "@aws-sdk/client-honeycode"; // ES Modules import + * // const { HoneycodeClient, BatchDeleteTableRowsCommand } = require("@aws-sdk/client-honeycode"); // CommonJS import + * const client = new HoneycodeClient(config); + * const command = new BatchDeleteTableRowsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link BatchDeleteTableRowsCommandInput} for command's `input` shape. + * @see {@link BatchDeleteTableRowsCommandOutput} for command's `response` shape. + * @see {@link HoneycodeClientResolvedConfig | config} for command's `input` shape. + * */ export class BatchDeleteTableRowsCommand extends $Command< BatchDeleteTableRowsCommandInput, diff --git a/clients/client-honeycode/commands/BatchUpdateTableRowsCommand.ts b/clients/client-honeycode/commands/BatchUpdateTableRowsCommand.ts index 7b7346cf3ac0..f13809f578d6 100644 --- a/clients/client-honeycode/commands/BatchUpdateTableRowsCommand.ts +++ b/clients/client-honeycode/commands/BatchUpdateTableRowsCommand.ts @@ -31,6 +31,20 @@ export interface BatchUpdateTableRowsCommandOutput extends BatchUpdateTableRowsR * for that row. To clear out the data in a specific cell, you need to set the value as an empty string * (""). *

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { HoneycodeClient, BatchUpdateTableRowsCommand } from "@aws-sdk/client-honeycode"; // ES Modules import + * // const { HoneycodeClient, BatchUpdateTableRowsCommand } = require("@aws-sdk/client-honeycode"); // CommonJS import + * const client = new HoneycodeClient(config); + * const command = new BatchUpdateTableRowsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link BatchUpdateTableRowsCommandInput} for command's `input` shape. + * @see {@link BatchUpdateTableRowsCommandOutput} for command's `response` shape. + * @see {@link HoneycodeClientResolvedConfig | config} for command's `input` shape. + * */ export class BatchUpdateTableRowsCommand extends $Command< BatchUpdateTableRowsCommandInput, diff --git a/clients/client-honeycode/commands/BatchUpsertTableRowsCommand.ts b/clients/client-honeycode/commands/BatchUpsertTableRowsCommand.ts index 192faf3467e5..dfdb4b05ba01 100644 --- a/clients/client-honeycode/commands/BatchUpsertTableRowsCommand.ts +++ b/clients/client-honeycode/commands/BatchUpsertTableRowsCommand.ts @@ -34,6 +34,20 @@ export interface BatchUpsertTableRowsCommandOutput extends BatchUpsertTableRowsR * 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 (""). *

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { HoneycodeClient, BatchUpsertTableRowsCommand } from "@aws-sdk/client-honeycode"; // ES Modules import + * // const { HoneycodeClient, BatchUpsertTableRowsCommand } = require("@aws-sdk/client-honeycode"); // CommonJS import + * const client = new HoneycodeClient(config); + * const command = new BatchUpsertTableRowsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link BatchUpsertTableRowsCommandInput} for command's `input` shape. + * @see {@link BatchUpsertTableRowsCommandOutput} for command's `response` shape. + * @see {@link HoneycodeClientResolvedConfig | config} for command's `input` shape. + * */ export class BatchUpsertTableRowsCommand extends $Command< BatchUpsertTableRowsCommandInput, diff --git a/clients/client-honeycode/commands/DescribeTableDataImportJobCommand.ts b/clients/client-honeycode/commands/DescribeTableDataImportJobCommand.ts index 45400ee47165..ad2d40b6ce95 100644 --- a/clients/client-honeycode/commands/DescribeTableDataImportJobCommand.ts +++ b/clients/client-honeycode/commands/DescribeTableDataImportJobCommand.ts @@ -24,6 +24,20 @@ export interface DescribeTableDataImportJobCommandOutput extends DescribeTableDa *

* The DescribeTableDataImportJob API allows you to retrieve the status and details of a table data import job. *

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { HoneycodeClient, DescribeTableDataImportJobCommand } from "@aws-sdk/client-honeycode"; // ES Modules import + * // const { HoneycodeClient, DescribeTableDataImportJobCommand } = require("@aws-sdk/client-honeycode"); // CommonJS import + * const client = new HoneycodeClient(config); + * const command = new DescribeTableDataImportJobCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeTableDataImportJobCommandInput} for command's `input` shape. + * @see {@link DescribeTableDataImportJobCommandOutput} for command's `response` shape. + * @see {@link HoneycodeClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeTableDataImportJobCommand extends $Command< DescribeTableDataImportJobCommandInput, diff --git a/clients/client-honeycode/commands/GetScreenDataCommand.ts b/clients/client-honeycode/commands/GetScreenDataCommand.ts index d14ce4efbd9b..ec69d6c2f7d9 100644 --- a/clients/client-honeycode/commands/GetScreenDataCommand.ts +++ b/clients/client-honeycode/commands/GetScreenDataCommand.ts @@ -26,6 +26,20 @@ export interface GetScreenDataCommandOutput extends GetScreenDataResult, __Metad * The API allows setting local variables in the screen to filter, sort or otherwise affect what will be * displayed on the screen. *

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { HoneycodeClient, GetScreenDataCommand } from "@aws-sdk/client-honeycode"; // ES Modules import + * // const { HoneycodeClient, GetScreenDataCommand } = require("@aws-sdk/client-honeycode"); // CommonJS import + * const client = new HoneycodeClient(config); + * const command = new GetScreenDataCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetScreenDataCommandInput} for command's `input` shape. + * @see {@link GetScreenDataCommandOutput} for command's `response` shape. + * @see {@link HoneycodeClientResolvedConfig | config} for command's `input` shape. + * */ export class GetScreenDataCommand extends $Command< GetScreenDataCommandInput, diff --git a/clients/client-honeycode/commands/InvokeScreenAutomationCommand.ts b/clients/client-honeycode/commands/InvokeScreenAutomationCommand.ts index 170bca9f0098..ec21700059ec 100644 --- a/clients/client-honeycode/commands/InvokeScreenAutomationCommand.ts +++ b/clients/client-honeycode/commands/InvokeScreenAutomationCommand.ts @@ -26,6 +26,20 @@ export interface InvokeScreenAutomationCommandOutput extends InvokeScreenAutomat * 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. *

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { HoneycodeClient, InvokeScreenAutomationCommand } from "@aws-sdk/client-honeycode"; // ES Modules import + * // const { HoneycodeClient, InvokeScreenAutomationCommand } = require("@aws-sdk/client-honeycode"); // CommonJS import + * const client = new HoneycodeClient(config); + * const command = new InvokeScreenAutomationCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link InvokeScreenAutomationCommandInput} for command's `input` shape. + * @see {@link InvokeScreenAutomationCommandOutput} for command's `response` shape. + * @see {@link HoneycodeClientResolvedConfig | config} for command's `input` shape. + * */ export class InvokeScreenAutomationCommand extends $Command< InvokeScreenAutomationCommandInput, diff --git a/clients/client-honeycode/commands/ListTableColumnsCommand.ts b/clients/client-honeycode/commands/ListTableColumnsCommand.ts index 7e0e5f46833e..f6caada5767d 100644 --- a/clients/client-honeycode/commands/ListTableColumnsCommand.ts +++ b/clients/client-honeycode/commands/ListTableColumnsCommand.ts @@ -24,6 +24,20 @@ export interface ListTableColumnsCommandOutput extends ListTableColumnsResult, _ *

* The ListTableColumns API allows you to retrieve a list of all the columns in a table in a workbook. *

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { HoneycodeClient, ListTableColumnsCommand } from "@aws-sdk/client-honeycode"; // ES Modules import + * // const { HoneycodeClient, ListTableColumnsCommand } = require("@aws-sdk/client-honeycode"); // CommonJS import + * const client = new HoneycodeClient(config); + * const command = new ListTableColumnsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListTableColumnsCommandInput} for command's `input` shape. + * @see {@link ListTableColumnsCommandOutput} for command's `response` shape. + * @see {@link HoneycodeClientResolvedConfig | config} for command's `input` shape. + * */ export class ListTableColumnsCommand extends $Command< ListTableColumnsCommandInput, diff --git a/clients/client-honeycode/commands/ListTableRowsCommand.ts b/clients/client-honeycode/commands/ListTableRowsCommand.ts index 1dd2a5ed0739..059bc4d8066c 100644 --- a/clients/client-honeycode/commands/ListTableRowsCommand.ts +++ b/clients/client-honeycode/commands/ListTableRowsCommand.ts @@ -24,6 +24,20 @@ export interface ListTableRowsCommandOutput extends ListTableRowsResult, __Metad *

* The ListTableRows API allows you to retrieve a list of all the rows in a table in a workbook. *

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { HoneycodeClient, ListTableRowsCommand } from "@aws-sdk/client-honeycode"; // ES Modules import + * // const { HoneycodeClient, ListTableRowsCommand } = require("@aws-sdk/client-honeycode"); // CommonJS import + * const client = new HoneycodeClient(config); + * const command = new ListTableRowsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListTableRowsCommandInput} for command's `input` shape. + * @see {@link ListTableRowsCommandOutput} for command's `response` shape. + * @see {@link HoneycodeClientResolvedConfig | config} for command's `input` shape. + * */ export class ListTableRowsCommand extends $Command< ListTableRowsCommandInput, diff --git a/clients/client-honeycode/commands/ListTablesCommand.ts b/clients/client-honeycode/commands/ListTablesCommand.ts index cb0d260f7bbe..b978d73240d5 100644 --- a/clients/client-honeycode/commands/ListTablesCommand.ts +++ b/clients/client-honeycode/commands/ListTablesCommand.ts @@ -24,6 +24,20 @@ export interface ListTablesCommandOutput extends ListTablesResult, __MetadataBea *

* The ListTables API allows you to retrieve a list of all the tables in a workbook. *

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { HoneycodeClient, ListTablesCommand } from "@aws-sdk/client-honeycode"; // ES Modules import + * // const { HoneycodeClient, ListTablesCommand } = require("@aws-sdk/client-honeycode"); // CommonJS import + * const client = new HoneycodeClient(config); + * const command = new ListTablesCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListTablesCommandInput} for command's `input` shape. + * @see {@link ListTablesCommandOutput} for command's `response` shape. + * @see {@link HoneycodeClientResolvedConfig | config} for command's `input` shape. + * */ export class ListTablesCommand extends $Command< ListTablesCommandInput, diff --git a/clients/client-honeycode/commands/QueryTableRowsCommand.ts b/clients/client-honeycode/commands/QueryTableRowsCommand.ts index 9a9adfe58f89..74f97dce83fc 100644 --- a/clients/client-honeycode/commands/QueryTableRowsCommand.ts +++ b/clients/client-honeycode/commands/QueryTableRowsCommand.ts @@ -24,6 +24,20 @@ export interface QueryTableRowsCommandOutput extends QueryTableRowsResult, __Met *

* The QueryTableRows API allows you to use a filter formula to query for specific rows in a table. *

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { HoneycodeClient, QueryTableRowsCommand } from "@aws-sdk/client-honeycode"; // ES Modules import + * // const { HoneycodeClient, QueryTableRowsCommand } = require("@aws-sdk/client-honeycode"); // CommonJS import + * const client = new HoneycodeClient(config); + * const command = new QueryTableRowsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link QueryTableRowsCommandInput} for command's `input` shape. + * @see {@link QueryTableRowsCommandOutput} for command's `response` shape. + * @see {@link HoneycodeClientResolvedConfig | config} for command's `input` shape. + * */ export class QueryTableRowsCommand extends $Command< QueryTableRowsCommandInput, diff --git a/clients/client-honeycode/commands/StartTableDataImportJobCommand.ts b/clients/client-honeycode/commands/StartTableDataImportJobCommand.ts index 8fa45c064e89..9774ba4d9724 100644 --- a/clients/client-honeycode/commands/StartTableDataImportJobCommand.ts +++ b/clients/client-honeycode/commands/StartTableDataImportJobCommand.ts @@ -26,6 +26,20 @@ export interface StartTableDataImportJobCommandOutput extends StartTableDataImpo * the id of the job that was started. To find out the status of the import request, you need to call the * DescribeTableDataImportJob API. *

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { HoneycodeClient, StartTableDataImportJobCommand } from "@aws-sdk/client-honeycode"; // ES Modules import + * // const { HoneycodeClient, StartTableDataImportJobCommand } = require("@aws-sdk/client-honeycode"); // CommonJS import + * const client = new HoneycodeClient(config); + * const command = new StartTableDataImportJobCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link StartTableDataImportJobCommandInput} for command's `input` shape. + * @see {@link StartTableDataImportJobCommandOutput} for command's `response` shape. + * @see {@link HoneycodeClientResolvedConfig | config} for command's `input` shape. + * */ export class StartTableDataImportJobCommand extends $Command< StartTableDataImportJobCommandInput, diff --git a/clients/client-honeycode/models/models_0.ts b/clients/client-honeycode/models/models_0.ts index 35f6b18646f6..09c349cfa322 100644 --- a/clients/client-honeycode/models/models_0.ts +++ b/clients/client-honeycode/models/models_0.ts @@ -14,6 +14,9 @@ export interface AccessDeniedException extends __SmithyException, $MetadataBeare } export namespace AccessDeniedException { + /** + * @internal + */ export const filterSensitiveLog = (obj: AccessDeniedException): any => ({ ...obj, }); @@ -29,6 +32,9 @@ export interface AutomationExecutionException extends __SmithyException, $Metada } export namespace AutomationExecutionException { + /** + * @internal + */ export const filterSensitiveLog = (obj: AutomationExecutionException): any => ({ ...obj, }); @@ -44,6 +50,9 @@ export interface AutomationExecutionTimeoutException extends __SmithyException, } export namespace AutomationExecutionTimeoutException { + /** + * @internal + */ export const filterSensitiveLog = (obj: AutomationExecutionTimeoutException): any => ({ ...obj, }); @@ -65,6 +74,9 @@ export interface CellInput { } export namespace CellInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: CellInput): any => ({ ...obj, ...(obj.fact && { fact: SENSITIVE_STRING }), @@ -97,6 +109,9 @@ export interface CreateRowData { } export namespace CreateRowData { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateRowData): any => ({ ...obj, ...(obj.cellsToCreate && { @@ -158,6 +173,9 @@ export interface BatchCreateTableRowsRequest { } export namespace BatchCreateTableRowsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: BatchCreateTableRowsRequest): any => ({ ...obj, ...(obj.rowsToCreate && { rowsToCreate: obj.rowsToCreate.map((item) => CreateRowData.filterSensitiveLog(item)) }), @@ -189,6 +207,9 @@ export interface FailedBatchItem { } export namespace FailedBatchItem { + /** + * @internal + */ export const filterSensitiveLog = (obj: FailedBatchItem): any => ({ ...obj, }); @@ -216,6 +237,9 @@ export interface BatchCreateTableRowsResult { } export namespace BatchCreateTableRowsResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: BatchCreateTableRowsResult): any => ({ ...obj, }); @@ -231,6 +255,9 @@ export interface InternalServerException extends __SmithyException, $MetadataBea } export namespace InternalServerException { + /** + * @internal + */ export const filterSensitiveLog = (obj: InternalServerException): any => ({ ...obj, }); @@ -246,6 +273,9 @@ export interface RequestTimeoutException extends __SmithyException, $MetadataBea } export namespace RequestTimeoutException { + /** + * @internal + */ export const filterSensitiveLog = (obj: RequestTimeoutException): any => ({ ...obj, }); @@ -261,6 +291,9 @@ export interface ResourceNotFoundException extends __SmithyException, $MetadataB } export namespace ResourceNotFoundException { + /** + * @internal + */ export const filterSensitiveLog = (obj: ResourceNotFoundException): any => ({ ...obj, }); @@ -278,6 +311,9 @@ export interface ServiceQuotaExceededException extends __SmithyException, $Metad } export namespace ServiceQuotaExceededException { + /** + * @internal + */ export const filterSensitiveLog = (obj: ServiceQuotaExceededException): any => ({ ...obj, }); @@ -293,6 +329,9 @@ export interface ServiceUnavailableException extends __SmithyException, $Metadat } export namespace ServiceUnavailableException { + /** + * @internal + */ export const filterSensitiveLog = (obj: ServiceUnavailableException): any => ({ ...obj, }); @@ -308,6 +347,9 @@ export interface ThrottlingException extends __SmithyException, $MetadataBearer } export namespace ThrottlingException { + /** + * @internal + */ export const filterSensitiveLog = (obj: ThrottlingException): any => ({ ...obj, }); @@ -325,6 +367,9 @@ export interface ValidationException extends __SmithyException, $MetadataBearer } export namespace ValidationException { + /** + * @internal + */ export const filterSensitiveLog = (obj: ValidationException): any => ({ ...obj, }); @@ -375,6 +420,9 @@ export interface BatchDeleteTableRowsRequest { } export namespace BatchDeleteTableRowsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: BatchDeleteTableRowsRequest): any => ({ ...obj, }); @@ -397,6 +445,9 @@ export interface BatchDeleteTableRowsResult { } export namespace BatchDeleteTableRowsResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: BatchDeleteTableRowsResult): any => ({ ...obj, }); @@ -425,6 +476,9 @@ export interface UpdateRowData { } export namespace UpdateRowData { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateRowData): any => ({ ...obj, ...(obj.cellsToUpdate && { @@ -487,6 +541,9 @@ export interface BatchUpdateTableRowsRequest { } export namespace BatchUpdateTableRowsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: BatchUpdateTableRowsRequest): any => ({ ...obj, ...(obj.rowsToUpdate && { rowsToUpdate: obj.rowsToUpdate.map((item) => UpdateRowData.filterSensitiveLog(item)) }), @@ -510,6 +567,9 @@ export interface BatchUpdateTableRowsResult { } export namespace BatchUpdateTableRowsResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: BatchUpdateTableRowsResult): any => ({ ...obj, }); @@ -544,6 +604,9 @@ export interface Filter { } export namespace Filter { + /** + * @internal + */ export const filterSensitiveLog = (obj: Filter): any => ({ ...obj, ...(obj.formula && { formula: SENSITIVE_STRING }), @@ -591,6 +654,9 @@ export interface UpsertRowData { } export namespace UpsertRowData { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpsertRowData): any => ({ ...obj, ...(obj.filter && { filter: Filter.filterSensitiveLog(obj.filter) }), @@ -655,6 +721,9 @@ export interface BatchUpsertTableRowsRequest { } export namespace BatchUpsertTableRowsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: BatchUpsertTableRowsRequest): any => ({ ...obj, ...(obj.rowsToUpsert && { rowsToUpsert: obj.rowsToUpsert.map((item) => UpsertRowData.filterSensitiveLog(item)) }), @@ -690,6 +759,9 @@ export interface UpsertRowsResult { } export namespace UpsertRowsResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpsertRowsResult): any => ({ ...obj, }); @@ -721,6 +793,9 @@ export interface BatchUpsertTableRowsResult { } export namespace BatchUpsertTableRowsResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: BatchUpsertTableRowsResult): any => ({ ...obj, }); @@ -816,6 +891,9 @@ export interface Cell { } export namespace Cell { + /** + * @internal + */ export const filterSensitiveLog = (obj: Cell): any => ({ ...obj, ...(obj.formula && { formula: SENSITIVE_STRING }), @@ -838,6 +916,9 @@ export interface ColumnMetadata { } export namespace ColumnMetadata { + /** + * @internal + */ export const filterSensitiveLog = (obj: ColumnMetadata): any => ({ ...obj, ...(obj.name && { name: SENSITIVE_STRING }), @@ -868,6 +949,9 @@ export interface DataItem { } export namespace DataItem { + /** + * @internal + */ export const filterSensitiveLog = (obj: DataItem): any => ({ ...obj, }); @@ -910,6 +994,9 @@ export interface DelimitedTextImportOptions { } export namespace DelimitedTextImportOptions { + /** + * @internal + */ export const filterSensitiveLog = (obj: DelimitedTextImportOptions): any => ({ ...obj, }); @@ -942,6 +1029,9 @@ export interface DescribeTableDataImportJobRequest { } export namespace DescribeTableDataImportJobRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeTableDataImportJobRequest): any => ({ ...obj, }); @@ -962,6 +1052,9 @@ export interface ImportDataSourceConfig { } export namespace ImportDataSourceConfig { + /** + * @internal + */ export const filterSensitiveLog = (obj: ImportDataSourceConfig): any => ({ ...obj, }); @@ -978,6 +1071,9 @@ export interface ImportDataSource { } export namespace ImportDataSource { + /** + * @internal + */ export const filterSensitiveLog = (obj: ImportDataSource): any => ({ ...obj, }); @@ -994,6 +1090,9 @@ export interface SourceDataColumnProperties { } export namespace SourceDataColumnProperties { + /** + * @internal + */ export const filterSensitiveLog = (obj: SourceDataColumnProperties): any => ({ ...obj, }); @@ -1010,6 +1109,9 @@ export interface DestinationOptions { } export namespace DestinationOptions { + /** + * @internal + */ export const filterSensitiveLog = (obj: DestinationOptions): any => ({ ...obj, }); @@ -1031,6 +1133,9 @@ export interface ImportOptions { } export namespace ImportOptions { + /** + * @internal + */ export const filterSensitiveLog = (obj: ImportOptions): any => ({ ...obj, }); @@ -1052,6 +1157,9 @@ export interface ImportJobSubmitter { } export namespace ImportJobSubmitter { + /** + * @internal + */ export const filterSensitiveLog = (obj: ImportJobSubmitter): any => ({ ...obj, ...(obj.email && { email: SENSITIVE_STRING }), @@ -1084,6 +1192,9 @@ export interface TableDataImportJobMetadata { } export namespace TableDataImportJobMetadata { + /** + * @internal + */ export const filterSensitiveLog = (obj: TableDataImportJobMetadata): any => ({ ...obj, ...(obj.submitter && { submitter: ImportJobSubmitter.filterSensitiveLog(obj.submitter) }), @@ -1121,6 +1232,9 @@ export interface DescribeTableDataImportJobResult { } export namespace DescribeTableDataImportJobResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeTableDataImportJobResult): any => ({ ...obj, ...(obj.jobMetadata && { jobMetadata: TableDataImportJobMetadata.filterSensitiveLog(obj.jobMetadata) }), @@ -1138,6 +1252,9 @@ export interface VariableValue { } export namespace VariableValue { + /** + * @internal + */ export const filterSensitiveLog = (obj: VariableValue): any => ({ ...obj, }); @@ -1193,6 +1310,9 @@ export interface GetScreenDataRequest { } export namespace GetScreenDataRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetScreenDataRequest): any => ({ ...obj, ...(obj.variables && { variables: SENSITIVE_STRING }), @@ -1215,6 +1335,9 @@ export interface ResultRow { } export namespace ResultRow { + /** + * @internal + */ export const filterSensitiveLog = (obj: ResultRow): any => ({ ...obj, ...(obj.dataItems && { dataItems: SENSITIVE_STRING }), @@ -1254,6 +1377,9 @@ export interface ResultSet { } export namespace ResultSet { + /** + * @internal + */ export const filterSensitiveLog = (obj: ResultSet): any => ({ ...obj, ...(obj.headers && { headers: obj.headers.map((item) => ColumnMetadata.filterSensitiveLog(item)) }), @@ -1285,6 +1411,9 @@ export interface GetScreenDataResult { } export namespace GetScreenDataResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetScreenDataResult): any => ({ ...obj, ...(obj.results && { @@ -1357,6 +1486,9 @@ export interface InvokeScreenAutomationRequest { } export namespace InvokeScreenAutomationRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: InvokeScreenAutomationRequest): any => ({ ...obj, ...(obj.variables && { variables: SENSITIVE_STRING }), @@ -1371,6 +1503,9 @@ export interface InvokeScreenAutomationResult { } export namespace InvokeScreenAutomationResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: InvokeScreenAutomationResult): any => ({ ...obj, }); @@ -1406,6 +1541,9 @@ export interface ListTableColumnsRequest { } export namespace ListTableColumnsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListTableColumnsRequest): any => ({ ...obj, }); @@ -1435,6 +1573,9 @@ export interface TableColumn { } export namespace TableColumn { + /** + * @internal + */ export const filterSensitiveLog = (obj: TableColumn): any => ({ ...obj, }); @@ -1467,6 +1608,9 @@ export interface ListTableColumnsResult { } export namespace ListTableColumnsResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListTableColumnsResult): any => ({ ...obj, }); @@ -1516,6 +1660,9 @@ export interface ListTableRowsRequest { } export namespace ListTableRowsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListTableRowsRequest): any => ({ ...obj, }); @@ -1538,6 +1685,9 @@ export interface TableRow { } export namespace TableRow { + /** + * @internal + */ export const filterSensitiveLog = (obj: TableRow): any => ({ ...obj, ...(obj.cells && { cells: SENSITIVE_STRING }), @@ -1586,6 +1736,9 @@ export interface ListTableRowsResult { } export namespace ListTableRowsResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListTableRowsResult): any => ({ ...obj, ...(obj.rows && { rows: obj.rows.map((item) => TableRow.filterSensitiveLog(item)) }), @@ -1619,6 +1772,9 @@ export interface ListTablesRequest { } export namespace ListTablesRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListTablesRequest): any => ({ ...obj, }); @@ -1640,6 +1796,9 @@ export interface Table { } export namespace Table { + /** + * @internal + */ export const filterSensitiveLog = (obj: Table): any => ({ ...obj, }); @@ -1672,6 +1831,9 @@ export interface ListTablesResult { } export namespace ListTablesResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListTablesResult): any => ({ ...obj, }); @@ -1718,6 +1880,9 @@ export interface QueryTableRowsRequest { } export namespace QueryTableRowsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: QueryTableRowsRequest): any => ({ ...obj, ...(obj.filterFormula && { filterFormula: Filter.filterSensitiveLog(obj.filterFormula) }), @@ -1758,6 +1923,9 @@ export interface QueryTableRowsResult { } export namespace QueryTableRowsResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: QueryTableRowsResult): any => ({ ...obj, ...(obj.rows && { rows: obj.rows.map((item) => TableRow.filterSensitiveLog(item)) }), @@ -1820,6 +1988,9 @@ export interface StartTableDataImportJobRequest { } export namespace StartTableDataImportJobRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: StartTableDataImportJobRequest): any => ({ ...obj, }); @@ -1843,6 +2014,9 @@ export interface StartTableDataImportJobResult { } export namespace StartTableDataImportJobResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: StartTableDataImportJobResult): any => ({ ...obj, }); diff --git a/clients/client-iam/commands/AddClientIDToOpenIDConnectProviderCommand.ts b/clients/client-iam/commands/AddClientIDToOpenIDConnectProviderCommand.ts index 48069ae08deb..f60b1b1b880b 100644 --- a/clients/client-iam/commands/AddClientIDToOpenIDConnectProviderCommand.ts +++ b/clients/client-iam/commands/AddClientIDToOpenIDConnectProviderCommand.ts @@ -25,6 +25,20 @@ export interface AddClientIDToOpenIDConnectProviderCommandOutput extends __Metad * 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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { IAMClient, AddClientIDToOpenIDConnectProviderCommand } from "@aws-sdk/client-iam"; // ES Modules import + * // const { IAMClient, AddClientIDToOpenIDConnectProviderCommand } = require("@aws-sdk/client-iam"); // CommonJS import + * const client = new IAMClient(config); + * const command = new AddClientIDToOpenIDConnectProviderCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link AddClientIDToOpenIDConnectProviderCommandInput} for command's `input` shape. + * @see {@link AddClientIDToOpenIDConnectProviderCommandOutput} for command's `response` shape. + * @see {@link IAMClientResolvedConfig | config} for command's `input` shape. + * */ export class AddClientIDToOpenIDConnectProviderCommand extends $Command< AddClientIDToOpenIDConnectProviderCommandInput, diff --git a/clients/client-iam/commands/AddRoleToInstanceProfileCommand.ts b/clients/client-iam/commands/AddRoleToInstanceProfileCommand.ts index c2aca3b874b8..e991ea2add0a 100644 --- a/clients/client-iam/commands/AddRoleToInstanceProfileCommand.ts +++ b/clients/client-iam/commands/AddRoleToInstanceProfileCommand.ts @@ -34,6 +34,20 @@ export interface AddRoleToInstanceProfileCommandOutput extends __MetadataBearer *

For more information about roles, see Working with roles. For more * information about instance profiles, see About instance * profiles.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { IAMClient, AddRoleToInstanceProfileCommand } from "@aws-sdk/client-iam"; // ES Modules import + * // const { IAMClient, AddRoleToInstanceProfileCommand } = require("@aws-sdk/client-iam"); // CommonJS import + * const client = new IAMClient(config); + * const command = new AddRoleToInstanceProfileCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link AddRoleToInstanceProfileCommandInput} for command's `input` shape. + * @see {@link AddRoleToInstanceProfileCommandOutput} for command's `response` shape. + * @see {@link IAMClientResolvedConfig | config} for command's `input` shape. + * */ export class AddRoleToInstanceProfileCommand extends $Command< AddRoleToInstanceProfileCommandInput, diff --git a/clients/client-iam/commands/AddUserToGroupCommand.ts b/clients/client-iam/commands/AddUserToGroupCommand.ts index fc85288d2e0d..54a147970563 100644 --- a/clients/client-iam/commands/AddUserToGroupCommand.ts +++ b/clients/client-iam/commands/AddUserToGroupCommand.ts @@ -22,6 +22,20 @@ export interface AddUserToGroupCommandOutput extends __MetadataBearer {} /** *

Adds the specified user to the specified group.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { IAMClient, AddUserToGroupCommand } from "@aws-sdk/client-iam"; // ES Modules import + * // const { IAMClient, AddUserToGroupCommand } = require("@aws-sdk/client-iam"); // CommonJS import + * const client = new IAMClient(config); + * const command = new AddUserToGroupCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link AddUserToGroupCommandInput} for command's `input` shape. + * @see {@link AddUserToGroupCommandOutput} for command's `response` shape. + * @see {@link IAMClientResolvedConfig | config} for command's `input` shape. + * */ export class AddUserToGroupCommand extends $Command< AddUserToGroupCommandInput, diff --git a/clients/client-iam/commands/AttachGroupPolicyCommand.ts b/clients/client-iam/commands/AttachGroupPolicyCommand.ts index 95aa74394a44..2ef928632d03 100644 --- a/clients/client-iam/commands/AttachGroupPolicyCommand.ts +++ b/clients/client-iam/commands/AttachGroupPolicyCommand.ts @@ -29,6 +29,20 @@ export interface AttachGroupPolicyCommandOutput extends __MetadataBearer {} * in the IAM User Guide.

*

For more information about policies, see Managed policies and inline * policies in the IAM User Guide.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { IAMClient, AttachGroupPolicyCommand } from "@aws-sdk/client-iam"; // ES Modules import + * // const { IAMClient, AttachGroupPolicyCommand } = require("@aws-sdk/client-iam"); // CommonJS import + * const client = new IAMClient(config); + * const command = new AttachGroupPolicyCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link AttachGroupPolicyCommandInput} for command's `input` shape. + * @see {@link AttachGroupPolicyCommandOutput} for command's `response` shape. + * @see {@link IAMClientResolvedConfig | config} for command's `input` shape. + * */ export class AttachGroupPolicyCommand extends $Command< AttachGroupPolicyCommandInput, diff --git a/clients/client-iam/commands/AttachRolePolicyCommand.ts b/clients/client-iam/commands/AttachRolePolicyCommand.ts index 293ee8262a84..c72536d92bfc 100644 --- a/clients/client-iam/commands/AttachRolePolicyCommand.ts +++ b/clients/client-iam/commands/AttachRolePolicyCommand.ts @@ -36,6 +36,20 @@ export interface AttachRolePolicyCommandOutput extends __MetadataBearer {} *

As a best practice, you can validate your IAM policies. * To learn more, see Validating IAM policies * in the IAM User Guide.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { IAMClient, AttachRolePolicyCommand } from "@aws-sdk/client-iam"; // ES Modules import + * // const { IAMClient, AttachRolePolicyCommand } = require("@aws-sdk/client-iam"); // CommonJS import + * const client = new IAMClient(config); + * const command = new AttachRolePolicyCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link AttachRolePolicyCommandInput} for command's `input` shape. + * @see {@link AttachRolePolicyCommandOutput} for command's `response` shape. + * @see {@link IAMClientResolvedConfig | config} for command's `input` shape. + * */ export class AttachRolePolicyCommand extends $Command< AttachRolePolicyCommandInput, diff --git a/clients/client-iam/commands/AttachUserPolicyCommand.ts b/clients/client-iam/commands/AttachUserPolicyCommand.ts index 10f14c2591fe..ad45e16a9e69 100644 --- a/clients/client-iam/commands/AttachUserPolicyCommand.ts +++ b/clients/client-iam/commands/AttachUserPolicyCommand.ts @@ -29,6 +29,20 @@ export interface AttachUserPolicyCommandOutput extends __MetadataBearer {} * in the IAM User Guide.

*

For more information about policies, see Managed policies and inline * policies in the IAM User Guide.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { IAMClient, AttachUserPolicyCommand } from "@aws-sdk/client-iam"; // ES Modules import + * // const { IAMClient, AttachUserPolicyCommand } = require("@aws-sdk/client-iam"); // CommonJS import + * const client = new IAMClient(config); + * const command = new AttachUserPolicyCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link AttachUserPolicyCommandInput} for command's `input` shape. + * @see {@link AttachUserPolicyCommandOutput} for command's `response` shape. + * @see {@link IAMClientResolvedConfig | config} for command's `input` shape. + * */ export class AttachUserPolicyCommand extends $Command< AttachUserPolicyCommandInput, diff --git a/clients/client-iam/commands/ChangePasswordCommand.ts b/clients/client-iam/commands/ChangePasswordCommand.ts index 328c3834fe16..576bd6ad8d50 100644 --- a/clients/client-iam/commands/ChangePasswordCommand.ts +++ b/clients/client-iam/commands/ChangePasswordCommand.ts @@ -29,6 +29,20 @@ export interface ChangePasswordCommandOutput extends __MetadataBearer {} * 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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { IAMClient, ChangePasswordCommand } from "@aws-sdk/client-iam"; // ES Modules import + * // const { IAMClient, ChangePasswordCommand } = require("@aws-sdk/client-iam"); // CommonJS import + * const client = new IAMClient(config); + * const command = new ChangePasswordCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ChangePasswordCommandInput} for command's `input` shape. + * @see {@link ChangePasswordCommandOutput} for command's `response` shape. + * @see {@link IAMClientResolvedConfig | config} for command's `input` shape. + * */ export class ChangePasswordCommand extends $Command< ChangePasswordCommandInput, diff --git a/clients/client-iam/commands/CreateAccessKeyCommand.ts b/clients/client-iam/commands/CreateAccessKeyCommand.ts index d4823d5ed108..fedb62311481 100644 --- a/clients/client-iam/commands/CreateAccessKeyCommand.ts +++ b/clients/client-iam/commands/CreateAccessKeyCommand.ts @@ -35,6 +35,20 @@ export interface CreateAccessKeyCommandOutput extends CreateAccessKeyResponse, _ * 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.

* + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { IAMClient, CreateAccessKeyCommand } from "@aws-sdk/client-iam"; // ES Modules import + * // const { IAMClient, CreateAccessKeyCommand } = require("@aws-sdk/client-iam"); // CommonJS import + * const client = new IAMClient(config); + * const command = new CreateAccessKeyCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreateAccessKeyCommandInput} for command's `input` shape. + * @see {@link CreateAccessKeyCommandOutput} for command's `response` shape. + * @see {@link IAMClientResolvedConfig | config} for command's `input` shape. + * */ export class CreateAccessKeyCommand extends $Command< CreateAccessKeyCommandInput, diff --git a/clients/client-iam/commands/CreateAccountAliasCommand.ts b/clients/client-iam/commands/CreateAccountAliasCommand.ts index 3aeee713f9c5..2fa0174c3122 100644 --- a/clients/client-iam/commands/CreateAccountAliasCommand.ts +++ b/clients/client-iam/commands/CreateAccountAliasCommand.ts @@ -25,6 +25,20 @@ export interface CreateAccountAliasCommandOutput extends __MetadataBearer {} * alias, see Using an * alias for your AWS account ID in the * IAM User Guide.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { IAMClient, CreateAccountAliasCommand } from "@aws-sdk/client-iam"; // ES Modules import + * // const { IAMClient, CreateAccountAliasCommand } = require("@aws-sdk/client-iam"); // CommonJS import + * const client = new IAMClient(config); + * const command = new CreateAccountAliasCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreateAccountAliasCommandInput} for command's `input` shape. + * @see {@link CreateAccountAliasCommandOutput} for command's `response` shape. + * @see {@link IAMClientResolvedConfig | config} for command's `input` shape. + * */ export class CreateAccountAliasCommand extends $Command< CreateAccountAliasCommandInput, diff --git a/clients/client-iam/commands/CreateGroupCommand.ts b/clients/client-iam/commands/CreateGroupCommand.ts index b1e637d1a212..4b9c9bdaa846 100644 --- a/clients/client-iam/commands/CreateGroupCommand.ts +++ b/clients/client-iam/commands/CreateGroupCommand.ts @@ -21,6 +21,20 @@ export interface CreateGroupCommandOutput extends CreateGroupResponse, __Metadat *

Creates a new group.

*

For information about the number of groups you can create, see IAM and STS * quotas in the IAM User Guide.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { IAMClient, CreateGroupCommand } from "@aws-sdk/client-iam"; // ES Modules import + * // const { IAMClient, CreateGroupCommand } = require("@aws-sdk/client-iam"); // CommonJS import + * const client = new IAMClient(config); + * const command = new CreateGroupCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreateGroupCommandInput} for command's `input` shape. + * @see {@link CreateGroupCommandOutput} for command's `response` shape. + * @see {@link IAMClientResolvedConfig | config} for command's `input` shape. + * */ export class CreateGroupCommand extends $Command< CreateGroupCommandInput, diff --git a/clients/client-iam/commands/CreateInstanceProfileCommand.ts b/clients/client-iam/commands/CreateInstanceProfileCommand.ts index 24194fbc817c..fecbabdb58da 100644 --- a/clients/client-iam/commands/CreateInstanceProfileCommand.ts +++ b/clients/client-iam/commands/CreateInstanceProfileCommand.ts @@ -26,6 +26,20 @@ export interface CreateInstanceProfileCommandOutput extends CreateInstanceProfil * 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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { IAMClient, CreateInstanceProfileCommand } from "@aws-sdk/client-iam"; // ES Modules import + * // const { IAMClient, CreateInstanceProfileCommand } = require("@aws-sdk/client-iam"); // CommonJS import + * const client = new IAMClient(config); + * const command = new CreateInstanceProfileCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreateInstanceProfileCommandInput} for command's `input` shape. + * @see {@link CreateInstanceProfileCommandOutput} for command's `response` shape. + * @see {@link IAMClientResolvedConfig | config} for command's `input` shape. + * */ export class CreateInstanceProfileCommand extends $Command< CreateInstanceProfileCommandInput, diff --git a/clients/client-iam/commands/CreateLoginProfileCommand.ts b/clients/client-iam/commands/CreateLoginProfileCommand.ts index 729e8de6f2fc..fc5868f070e8 100644 --- a/clients/client-iam/commands/CreateLoginProfileCommand.ts +++ b/clients/client-iam/commands/CreateLoginProfileCommand.ts @@ -29,6 +29,20 @@ export interface CreateLoginProfileCommandOutput extends CreateLoginProfileRespo * AWS Management Console.

*

For more information about managing passwords, see Managing passwords in the * IAM User Guide.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { IAMClient, CreateLoginProfileCommand } from "@aws-sdk/client-iam"; // ES Modules import + * // const { IAMClient, CreateLoginProfileCommand } = require("@aws-sdk/client-iam"); // CommonJS import + * const client = new IAMClient(config); + * const command = new CreateLoginProfileCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreateLoginProfileCommandInput} for command's `input` shape. + * @see {@link CreateLoginProfileCommandOutput} for command's `response` shape. + * @see {@link IAMClientResolvedConfig | config} for command's `input` shape. + * */ export class CreateLoginProfileCommand extends $Command< CreateLoginProfileCommandInput, diff --git a/clients/client-iam/commands/CreateOpenIDConnectProviderCommand.ts b/clients/client-iam/commands/CreateOpenIDConnectProviderCommand.ts index 1249d38243a4..1eaacee231af 100644 --- a/clients/client-iam/commands/CreateOpenIDConnectProviderCommand.ts +++ b/clients/client-iam/commands/CreateOpenIDConnectProviderCommand.ts @@ -48,6 +48,20 @@ export interface CreateOpenIDConnectProviderCommandOutput * operation creates. Therefore, it is best to limit access to the CreateOpenIDConnectProvider operation to highly privileged * users.

* + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { IAMClient, CreateOpenIDConnectProviderCommand } from "@aws-sdk/client-iam"; // ES Modules import + * // const { IAMClient, CreateOpenIDConnectProviderCommand } = require("@aws-sdk/client-iam"); // CommonJS import + * const client = new IAMClient(config); + * const command = new CreateOpenIDConnectProviderCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreateOpenIDConnectProviderCommandInput} for command's `input` shape. + * @see {@link CreateOpenIDConnectProviderCommandOutput} for command's `response` shape. + * @see {@link IAMClientResolvedConfig | config} for command's `input` shape. + * */ export class CreateOpenIDConnectProviderCommand extends $Command< CreateOpenIDConnectProviderCommandInput, diff --git a/clients/client-iam/commands/CreatePolicyCommand.ts b/clients/client-iam/commands/CreatePolicyCommand.ts index 2aa12625b13c..f3de0210a12d 100644 --- a/clients/client-iam/commands/CreatePolicyCommand.ts +++ b/clients/client-iam/commands/CreatePolicyCommand.ts @@ -29,6 +29,20 @@ export interface CreatePolicyCommandOutput extends CreatePolicyResponse, __Metad *

For more information about managed policies in general, see Managed * policies and inline policies in the * IAM User Guide.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { IAMClient, CreatePolicyCommand } from "@aws-sdk/client-iam"; // ES Modules import + * // const { IAMClient, CreatePolicyCommand } = require("@aws-sdk/client-iam"); // CommonJS import + * const client = new IAMClient(config); + * const command = new CreatePolicyCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreatePolicyCommandInput} for command's `input` shape. + * @see {@link CreatePolicyCommandOutput} for command's `response` shape. + * @see {@link IAMClientResolvedConfig | config} for command's `input` shape. + * */ export class CreatePolicyCommand extends $Command< CreatePolicyCommandInput, diff --git a/clients/client-iam/commands/CreatePolicyVersionCommand.ts b/clients/client-iam/commands/CreatePolicyVersionCommand.ts index 2123577340ff..227e041e0300 100644 --- a/clients/client-iam/commands/CreatePolicyVersionCommand.ts +++ b/clients/client-iam/commands/CreatePolicyVersionCommand.ts @@ -29,6 +29,20 @@ export interface CreatePolicyVersionCommandOutput extends CreatePolicyVersionRes * the policy is attached.

*

For more information about managed policy versions, see Versioning for managed * policies in the IAM User Guide.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { IAMClient, CreatePolicyVersionCommand } from "@aws-sdk/client-iam"; // ES Modules import + * // const { IAMClient, CreatePolicyVersionCommand } = require("@aws-sdk/client-iam"); // CommonJS import + * const client = new IAMClient(config); + * const command = new CreatePolicyVersionCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreatePolicyVersionCommandInput} for command's `input` shape. + * @see {@link CreatePolicyVersionCommandOutput} for command's `response` shape. + * @see {@link IAMClientResolvedConfig | config} for command's `input` shape. + * */ export class CreatePolicyVersionCommand extends $Command< CreatePolicyVersionCommandInput, diff --git a/clients/client-iam/commands/CreateRoleCommand.ts b/clients/client-iam/commands/CreateRoleCommand.ts index 16cbced91e73..cec06afb9526 100644 --- a/clients/client-iam/commands/CreateRoleCommand.ts +++ b/clients/client-iam/commands/CreateRoleCommand.ts @@ -23,6 +23,20 @@ export interface CreateRoleCommandOutput extends CreateRoleResponse, __MetadataB * 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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { IAMClient, CreateRoleCommand } from "@aws-sdk/client-iam"; // ES Modules import + * // const { IAMClient, CreateRoleCommand } = require("@aws-sdk/client-iam"); // CommonJS import + * const client = new IAMClient(config); + * const command = new CreateRoleCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreateRoleCommandInput} for command's `input` shape. + * @see {@link CreateRoleCommandOutput} for command's `response` shape. + * @see {@link IAMClientResolvedConfig | config} for command's `input` shape. + * */ export class CreateRoleCommand extends $Command< CreateRoleCommandInput, diff --git a/clients/client-iam/commands/CreateSAMLProviderCommand.ts b/clients/client-iam/commands/CreateSAMLProviderCommand.ts index 86d7532eb66a..797a73cabd44 100644 --- a/clients/client-iam/commands/CreateSAMLProviderCommand.ts +++ b/clients/client-iam/commands/CreateSAMLProviderCommand.ts @@ -39,6 +39,20 @@ export interface CreateSAMLProviderCommandOutput extends CreateSAMLProviderRespo *

For more information, see Enabling SAML 2.0 * federated users to access the AWS Management Console and About SAML 2.0-based * federation in the IAM User Guide.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { IAMClient, CreateSAMLProviderCommand } from "@aws-sdk/client-iam"; // ES Modules import + * // const { IAMClient, CreateSAMLProviderCommand } = require("@aws-sdk/client-iam"); // CommonJS import + * const client = new IAMClient(config); + * const command = new CreateSAMLProviderCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreateSAMLProviderCommandInput} for command's `input` shape. + * @see {@link CreateSAMLProviderCommandOutput} for command's `response` shape. + * @see {@link IAMClientResolvedConfig | config} for command's `input` shape. + * */ export class CreateSAMLProviderCommand extends $Command< CreateSAMLProviderCommandInput, diff --git a/clients/client-iam/commands/CreateServiceLinkedRoleCommand.ts b/clients/client-iam/commands/CreateServiceLinkedRoleCommand.ts index 631aeb077f44..b88ffb5d0c0e 100644 --- a/clients/client-iam/commands/CreateServiceLinkedRoleCommand.ts +++ b/clients/client-iam/commands/CreateServiceLinkedRoleCommand.ts @@ -30,6 +30,20 @@ export interface CreateServiceLinkedRoleCommandOutput extends CreateServiceLinke * roles in the IAM User Guide.

*

To attach a policy to this service-linked role, you must make the request using the * AWS service that depends on this role.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { IAMClient, CreateServiceLinkedRoleCommand } from "@aws-sdk/client-iam"; // ES Modules import + * // const { IAMClient, CreateServiceLinkedRoleCommand } = require("@aws-sdk/client-iam"); // CommonJS import + * const client = new IAMClient(config); + * const command = new CreateServiceLinkedRoleCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreateServiceLinkedRoleCommandInput} for command's `input` shape. + * @see {@link CreateServiceLinkedRoleCommandOutput} for command's `response` shape. + * @see {@link IAMClientResolvedConfig | config} for command's `input` shape. + * */ export class CreateServiceLinkedRoleCommand extends $Command< CreateServiceLinkedRoleCommandInput, diff --git a/clients/client-iam/commands/CreateServiceSpecificCredentialCommand.ts b/clients/client-iam/commands/CreateServiceSpecificCredentialCommand.ts index 81bc2cd2f738..d83119ccce63 100644 --- a/clients/client-iam/commands/CreateServiceSpecificCredentialCommand.ts +++ b/clients/client-iam/commands/CreateServiceSpecificCredentialCommand.ts @@ -34,6 +34,20 @@ export interface CreateServiceSpecificCredentialCommandOutput *

For more information about service-specific credentials, see Using IAM * with AWS CodeCommit: Git credentials, SSH keys, and AWS access keys in the * IAM User Guide.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { IAMClient, CreateServiceSpecificCredentialCommand } from "@aws-sdk/client-iam"; // ES Modules import + * // const { IAMClient, CreateServiceSpecificCredentialCommand } = require("@aws-sdk/client-iam"); // CommonJS import + * const client = new IAMClient(config); + * const command = new CreateServiceSpecificCredentialCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreateServiceSpecificCredentialCommandInput} for command's `input` shape. + * @see {@link CreateServiceSpecificCredentialCommandOutput} for command's `response` shape. + * @see {@link IAMClientResolvedConfig | config} for command's `input` shape. + * */ export class CreateServiceSpecificCredentialCommand extends $Command< CreateServiceSpecificCredentialCommandInput, diff --git a/clients/client-iam/commands/CreateUserCommand.ts b/clients/client-iam/commands/CreateUserCommand.ts index 84ef09661692..6c298a7117d2 100644 --- a/clients/client-iam/commands/CreateUserCommand.ts +++ b/clients/client-iam/commands/CreateUserCommand.ts @@ -21,6 +21,20 @@ export interface CreateUserCommandOutput extends CreateUserResponse, __MetadataB *

Creates a new IAM user for your AWS account.

*

For information about quotas for the number of IAM users you can create, see IAM and STS * quotas in the IAM User Guide.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { IAMClient, CreateUserCommand } from "@aws-sdk/client-iam"; // ES Modules import + * // const { IAMClient, CreateUserCommand } = require("@aws-sdk/client-iam"); // CommonJS import + * const client = new IAMClient(config); + * const command = new CreateUserCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreateUserCommandInput} for command's `input` shape. + * @see {@link CreateUserCommandOutput} for command's `response` shape. + * @see {@link IAMClientResolvedConfig | config} for command's `input` shape. + * */ export class CreateUserCommand extends $Command< CreateUserCommandInput, diff --git a/clients/client-iam/commands/CreateVirtualMFADeviceCommand.ts b/clients/client-iam/commands/CreateVirtualMFADeviceCommand.ts index 73a976409f00..259fb23847e2 100644 --- a/clients/client-iam/commands/CreateVirtualMFADeviceCommand.ts +++ b/clients/client-iam/commands/CreateVirtualMFADeviceCommand.ts @@ -34,6 +34,20 @@ export interface CreateVirtualMFADeviceCommandOutput extends CreateVirtualMFADev * provision your virtual device, you should ensure that the information is destroyed * following secure procedures.

* + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { IAMClient, CreateVirtualMFADeviceCommand } from "@aws-sdk/client-iam"; // ES Modules import + * // const { IAMClient, CreateVirtualMFADeviceCommand } = require("@aws-sdk/client-iam"); // CommonJS import + * const client = new IAMClient(config); + * const command = new CreateVirtualMFADeviceCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreateVirtualMFADeviceCommandInput} for command's `input` shape. + * @see {@link CreateVirtualMFADeviceCommandOutput} for command's `response` shape. + * @see {@link IAMClientResolvedConfig | config} for command's `input` shape. + * */ export class CreateVirtualMFADeviceCommand extends $Command< CreateVirtualMFADeviceCommandInput, diff --git a/clients/client-iam/commands/DeactivateMFADeviceCommand.ts b/clients/client-iam/commands/DeactivateMFADeviceCommand.ts index f7fdb45f9cb5..2296efd79ed8 100644 --- a/clients/client-iam/commands/DeactivateMFADeviceCommand.ts +++ b/clients/client-iam/commands/DeactivateMFADeviceCommand.ts @@ -26,6 +26,20 @@ export interface DeactivateMFADeviceCommandOutput extends __MetadataBearer {} *

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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { IAMClient, DeactivateMFADeviceCommand } from "@aws-sdk/client-iam"; // ES Modules import + * // const { IAMClient, DeactivateMFADeviceCommand } = require("@aws-sdk/client-iam"); // CommonJS import + * const client = new IAMClient(config); + * const command = new DeactivateMFADeviceCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeactivateMFADeviceCommandInput} for command's `input` shape. + * @see {@link DeactivateMFADeviceCommandOutput} for command's `response` shape. + * @see {@link IAMClientResolvedConfig | config} for command's `input` shape. + * */ export class DeactivateMFADeviceCommand extends $Command< DeactivateMFADeviceCommandInput, diff --git a/clients/client-iam/commands/DeleteAccessKeyCommand.ts b/clients/client-iam/commands/DeleteAccessKeyCommand.ts index b208c158b6c6..cab0e5ae830d 100644 --- a/clients/client-iam/commands/DeleteAccessKeyCommand.ts +++ b/clients/client-iam/commands/DeleteAccessKeyCommand.ts @@ -26,6 +26,20 @@ export interface DeleteAccessKeyCommandOutput extends __MetadataBearer {} * the AWS access key ID signing the request. This operation works for access keys under * the AWS account. Consequently, you can use this operation to manage AWS account root * user credentials even if the AWS account has no associated users.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { IAMClient, DeleteAccessKeyCommand } from "@aws-sdk/client-iam"; // ES Modules import + * // const { IAMClient, DeleteAccessKeyCommand } = require("@aws-sdk/client-iam"); // CommonJS import + * const client = new IAMClient(config); + * const command = new DeleteAccessKeyCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteAccessKeyCommandInput} for command's `input` shape. + * @see {@link DeleteAccessKeyCommandOutput} for command's `response` shape. + * @see {@link IAMClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteAccessKeyCommand extends $Command< DeleteAccessKeyCommandInput, diff --git a/clients/client-iam/commands/DeleteAccountAliasCommand.ts b/clients/client-iam/commands/DeleteAccountAliasCommand.ts index 44c6488b4969..c4eb1e39f8b4 100644 --- a/clients/client-iam/commands/DeleteAccountAliasCommand.ts +++ b/clients/client-iam/commands/DeleteAccountAliasCommand.ts @@ -24,6 +24,20 @@ export interface DeleteAccountAliasCommandOutput extends __MetadataBearer {} *

Deletes the specified AWS account alias. For information about using an AWS * account alias, see Using an alias for your AWS account ID in the * IAM User Guide.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { IAMClient, DeleteAccountAliasCommand } from "@aws-sdk/client-iam"; // ES Modules import + * // const { IAMClient, DeleteAccountAliasCommand } = require("@aws-sdk/client-iam"); // CommonJS import + * const client = new IAMClient(config); + * const command = new DeleteAccountAliasCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteAccountAliasCommandInput} for command's `input` shape. + * @see {@link DeleteAccountAliasCommandOutput} for command's `response` shape. + * @see {@link IAMClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteAccountAliasCommand extends $Command< DeleteAccountAliasCommandInput, diff --git a/clients/client-iam/commands/DeleteAccountPasswordPolicyCommand.ts b/clients/client-iam/commands/DeleteAccountPasswordPolicyCommand.ts index f706097b6202..f4b0b9960f3d 100644 --- a/clients/client-iam/commands/DeleteAccountPasswordPolicyCommand.ts +++ b/clients/client-iam/commands/DeleteAccountPasswordPolicyCommand.ts @@ -21,6 +21,20 @@ export interface DeleteAccountPasswordPolicyCommandOutput extends __MetadataBear /** *

Deletes the password policy for the AWS account. There are no parameters.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { IAMClient, DeleteAccountPasswordPolicyCommand } from "@aws-sdk/client-iam"; // ES Modules import + * // const { IAMClient, DeleteAccountPasswordPolicyCommand } = require("@aws-sdk/client-iam"); // CommonJS import + * const client = new IAMClient(config); + * const command = new DeleteAccountPasswordPolicyCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteAccountPasswordPolicyCommandInput} for command's `input` shape. + * @see {@link DeleteAccountPasswordPolicyCommandOutput} for command's `response` shape. + * @see {@link IAMClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteAccountPasswordPolicyCommand extends $Command< DeleteAccountPasswordPolicyCommandInput, diff --git a/clients/client-iam/commands/DeleteGroupCommand.ts b/clients/client-iam/commands/DeleteGroupCommand.ts index e1897f6ca5a6..1462daa80652 100644 --- a/clients/client-iam/commands/DeleteGroupCommand.ts +++ b/clients/client-iam/commands/DeleteGroupCommand.ts @@ -20,6 +20,20 @@ export interface DeleteGroupCommandOutput extends __MetadataBearer {} /** *

Deletes the specified IAM group. The group must not contain any users or have any * attached policies.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { IAMClient, DeleteGroupCommand } from "@aws-sdk/client-iam"; // ES Modules import + * // const { IAMClient, DeleteGroupCommand } = require("@aws-sdk/client-iam"); // CommonJS import + * const client = new IAMClient(config); + * const command = new DeleteGroupCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteGroupCommandInput} for command's `input` shape. + * @see {@link DeleteGroupCommandOutput} for command's `response` shape. + * @see {@link IAMClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteGroupCommand extends $Command< DeleteGroupCommandInput, diff --git a/clients/client-iam/commands/DeleteGroupPolicyCommand.ts b/clients/client-iam/commands/DeleteGroupPolicyCommand.ts index e24c48afc19f..7e9bffdb0af8 100644 --- a/clients/client-iam/commands/DeleteGroupPolicyCommand.ts +++ b/clients/client-iam/commands/DeleteGroupPolicyCommand.ts @@ -27,6 +27,20 @@ export interface DeleteGroupPolicyCommandOutput extends __MetadataBearer {} * a group, use DetachGroupPolicy. For more information about policies, * refer to Managed policies and inline * policies in the IAM User Guide.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { IAMClient, DeleteGroupPolicyCommand } from "@aws-sdk/client-iam"; // ES Modules import + * // const { IAMClient, DeleteGroupPolicyCommand } = require("@aws-sdk/client-iam"); // CommonJS import + * const client = new IAMClient(config); + * const command = new DeleteGroupPolicyCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteGroupPolicyCommandInput} for command's `input` shape. + * @see {@link DeleteGroupPolicyCommandOutput} for command's `response` shape. + * @see {@link IAMClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteGroupPolicyCommand extends $Command< DeleteGroupPolicyCommandInput, diff --git a/clients/client-iam/commands/DeleteInstanceProfileCommand.ts b/clients/client-iam/commands/DeleteInstanceProfileCommand.ts index 0f95990619bb..ba57978f2a74 100644 --- a/clients/client-iam/commands/DeleteInstanceProfileCommand.ts +++ b/clients/client-iam/commands/DeleteInstanceProfileCommand.ts @@ -31,6 +31,20 @@ export interface DeleteInstanceProfileCommandOutput extends __MetadataBearer {} * *

For more information about instance profiles, see About instance * profiles.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { IAMClient, DeleteInstanceProfileCommand } from "@aws-sdk/client-iam"; // ES Modules import + * // const { IAMClient, DeleteInstanceProfileCommand } = require("@aws-sdk/client-iam"); // CommonJS import + * const client = new IAMClient(config); + * const command = new DeleteInstanceProfileCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteInstanceProfileCommandInput} for command's `input` shape. + * @see {@link DeleteInstanceProfileCommandOutput} for command's `response` shape. + * @see {@link IAMClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteInstanceProfileCommand extends $Command< DeleteInstanceProfileCommandInput, diff --git a/clients/client-iam/commands/DeleteLoginProfileCommand.ts b/clients/client-iam/commands/DeleteLoginProfileCommand.ts index c544a0399385..5773f8741eb0 100644 --- a/clients/client-iam/commands/DeleteLoginProfileCommand.ts +++ b/clients/client-iam/commands/DeleteLoginProfileCommand.ts @@ -34,6 +34,20 @@ export interface DeleteLoginProfileCommandOutput extends __MetadataBearer {} * making keys inactive or deleting them, see UpdateAccessKey and * DeleteAccessKey.

* + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { IAMClient, DeleteLoginProfileCommand } from "@aws-sdk/client-iam"; // ES Modules import + * // const { IAMClient, DeleteLoginProfileCommand } = require("@aws-sdk/client-iam"); // CommonJS import + * const client = new IAMClient(config); + * const command = new DeleteLoginProfileCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteLoginProfileCommandInput} for command's `input` shape. + * @see {@link DeleteLoginProfileCommandOutput} for command's `response` shape. + * @see {@link IAMClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteLoginProfileCommand extends $Command< DeleteLoginProfileCommandInput, diff --git a/clients/client-iam/commands/DeleteOpenIDConnectProviderCommand.ts b/clients/client-iam/commands/DeleteOpenIDConnectProviderCommand.ts index 37543a09b167..b9789e27a1e6 100644 --- a/clients/client-iam/commands/DeleteOpenIDConnectProviderCommand.ts +++ b/clients/client-iam/commands/DeleteOpenIDConnectProviderCommand.ts @@ -27,6 +27,20 @@ export interface DeleteOpenIDConnectProviderCommandOutput extends __MetadataBear * 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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { IAMClient, DeleteOpenIDConnectProviderCommand } from "@aws-sdk/client-iam"; // ES Modules import + * // const { IAMClient, DeleteOpenIDConnectProviderCommand } = require("@aws-sdk/client-iam"); // CommonJS import + * const client = new IAMClient(config); + * const command = new DeleteOpenIDConnectProviderCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteOpenIDConnectProviderCommandInput} for command's `input` shape. + * @see {@link DeleteOpenIDConnectProviderCommandOutput} for command's `response` shape. + * @see {@link IAMClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteOpenIDConnectProviderCommand extends $Command< DeleteOpenIDConnectProviderCommandInput, diff --git a/clients/client-iam/commands/DeletePolicyCommand.ts b/clients/client-iam/commands/DeletePolicyCommand.ts index f0b2c6f86076..0036bec8ef34 100644 --- a/clients/client-iam/commands/DeletePolicyCommand.ts +++ b/clients/client-iam/commands/DeletePolicyCommand.ts @@ -43,6 +43,20 @@ export interface DeletePolicyCommandOutput extends __MetadataBearer {} * *

For information about managed policies, see Managed policies and inline * policies in the IAM User Guide.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { IAMClient, DeletePolicyCommand } from "@aws-sdk/client-iam"; // ES Modules import + * // const { IAMClient, DeletePolicyCommand } = require("@aws-sdk/client-iam"); // CommonJS import + * const client = new IAMClient(config); + * const command = new DeletePolicyCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeletePolicyCommandInput} for command's `input` shape. + * @see {@link DeletePolicyCommandOutput} for command's `response` shape. + * @see {@link IAMClientResolvedConfig | config} for command's `input` shape. + * */ export class DeletePolicyCommand extends $Command< DeletePolicyCommandInput, diff --git a/clients/client-iam/commands/DeletePolicyVersionCommand.ts b/clients/client-iam/commands/DeletePolicyVersionCommand.ts index 829aa176f722..cf03fdf23013 100644 --- a/clients/client-iam/commands/DeletePolicyVersionCommand.ts +++ b/clients/client-iam/commands/DeletePolicyVersionCommand.ts @@ -27,6 +27,20 @@ export interface DeletePolicyVersionCommandOutput extends __MetadataBearer {} * 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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { IAMClient, DeletePolicyVersionCommand } from "@aws-sdk/client-iam"; // ES Modules import + * // const { IAMClient, DeletePolicyVersionCommand } = require("@aws-sdk/client-iam"); // CommonJS import + * const client = new IAMClient(config); + * const command = new DeletePolicyVersionCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeletePolicyVersionCommandInput} for command's `input` shape. + * @see {@link DeletePolicyVersionCommandOutput} for command's `response` shape. + * @see {@link IAMClientResolvedConfig | config} for command's `input` shape. + * */ export class DeletePolicyVersionCommand extends $Command< DeletePolicyVersionCommandInput, diff --git a/clients/client-iam/commands/DeleteRoleCommand.ts b/clients/client-iam/commands/DeleteRoleCommand.ts index 30b20b14f01d..e6c8a77eb5b2 100644 --- a/clients/client-iam/commands/DeleteRoleCommand.ts +++ b/clients/client-iam/commands/DeleteRoleCommand.ts @@ -25,6 +25,20 @@ export interface DeleteRoleCommandOutput extends __MetadataBearer {} * 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.

* + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { IAMClient, DeleteRoleCommand } from "@aws-sdk/client-iam"; // ES Modules import + * // const { IAMClient, DeleteRoleCommand } = require("@aws-sdk/client-iam"); // CommonJS import + * const client = new IAMClient(config); + * const command = new DeleteRoleCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteRoleCommandInput} for command's `input` shape. + * @see {@link DeleteRoleCommandOutput} for command's `response` shape. + * @see {@link IAMClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteRoleCommand extends $Command< DeleteRoleCommandInput, diff --git a/clients/client-iam/commands/DeleteRolePermissionsBoundaryCommand.ts b/clients/client-iam/commands/DeleteRolePermissionsBoundaryCommand.ts index 04d1eb9582ba..ff3c5b6d0257 100644 --- a/clients/client-iam/commands/DeleteRolePermissionsBoundaryCommand.ts +++ b/clients/client-iam/commands/DeleteRolePermissionsBoundaryCommand.ts @@ -27,6 +27,20 @@ export interface DeleteRolePermissionsBoundaryCommandOutput extends __MetadataBe * example, it might allow anyone who assumes the role to perform all the actions * granted in its permissions policies.

* + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { IAMClient, DeleteRolePermissionsBoundaryCommand } from "@aws-sdk/client-iam"; // ES Modules import + * // const { IAMClient, DeleteRolePermissionsBoundaryCommand } = require("@aws-sdk/client-iam"); // CommonJS import + * const client = new IAMClient(config); + * const command = new DeleteRolePermissionsBoundaryCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteRolePermissionsBoundaryCommandInput} for command's `input` shape. + * @see {@link DeleteRolePermissionsBoundaryCommandOutput} for command's `response` shape. + * @see {@link IAMClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteRolePermissionsBoundaryCommand extends $Command< DeleteRolePermissionsBoundaryCommandInput, diff --git a/clients/client-iam/commands/DeleteRolePolicyCommand.ts b/clients/client-iam/commands/DeleteRolePolicyCommand.ts index 081e5de85946..a78327833d29 100644 --- a/clients/client-iam/commands/DeleteRolePolicyCommand.ts +++ b/clients/client-iam/commands/DeleteRolePolicyCommand.ts @@ -27,6 +27,20 @@ export interface DeleteRolePolicyCommandOutput extends __MetadataBearer {} * a role, use DetachRolePolicy. For more information about policies, * refer to Managed policies and inline * policies in the IAM User Guide.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { IAMClient, DeleteRolePolicyCommand } from "@aws-sdk/client-iam"; // ES Modules import + * // const { IAMClient, DeleteRolePolicyCommand } = require("@aws-sdk/client-iam"); // CommonJS import + * const client = new IAMClient(config); + * const command = new DeleteRolePolicyCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteRolePolicyCommandInput} for command's `input` shape. + * @see {@link DeleteRolePolicyCommandOutput} for command's `response` shape. + * @see {@link IAMClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteRolePolicyCommand extends $Command< DeleteRolePolicyCommandInput, diff --git a/clients/client-iam/commands/DeleteSAMLProviderCommand.ts b/clients/client-iam/commands/DeleteSAMLProviderCommand.ts index d689fd74e0c2..c190e9990441 100644 --- a/clients/client-iam/commands/DeleteSAMLProviderCommand.ts +++ b/clients/client-iam/commands/DeleteSAMLProviderCommand.ts @@ -28,6 +28,20 @@ export interface DeleteSAMLProviderCommandOutput extends __MetadataBearer {} * *

This operation requires Signature Version 4.

* + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { IAMClient, DeleteSAMLProviderCommand } from "@aws-sdk/client-iam"; // ES Modules import + * // const { IAMClient, DeleteSAMLProviderCommand } = require("@aws-sdk/client-iam"); // CommonJS import + * const client = new IAMClient(config); + * const command = new DeleteSAMLProviderCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteSAMLProviderCommandInput} for command's `input` shape. + * @see {@link DeleteSAMLProviderCommandOutput} for command's `response` shape. + * @see {@link IAMClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteSAMLProviderCommand extends $Command< DeleteSAMLProviderCommandInput, diff --git a/clients/client-iam/commands/DeleteSSHPublicKeyCommand.ts b/clients/client-iam/commands/DeleteSSHPublicKeyCommand.ts index e8ef374354ce..efaa529611f4 100644 --- a/clients/client-iam/commands/DeleteSSHPublicKeyCommand.ts +++ b/clients/client-iam/commands/DeleteSSHPublicKeyCommand.ts @@ -26,6 +26,20 @@ export interface DeleteSSHPublicKeyCommandOutput extends __MetadataBearer {} * associated IAM user to an AWS CodeCommit repository. For more information about using SSH keys * to authenticate to an AWS CodeCommit repository, see Set up AWS CodeCommit for * SSH connections in the AWS CodeCommit User Guide.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { IAMClient, DeleteSSHPublicKeyCommand } from "@aws-sdk/client-iam"; // ES Modules import + * // const { IAMClient, DeleteSSHPublicKeyCommand } = require("@aws-sdk/client-iam"); // CommonJS import + * const client = new IAMClient(config); + * const command = new DeleteSSHPublicKeyCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteSSHPublicKeyCommandInput} for command's `input` shape. + * @see {@link DeleteSSHPublicKeyCommandOutput} for command's `response` shape. + * @see {@link IAMClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteSSHPublicKeyCommand extends $Command< DeleteSSHPublicKeyCommandInput, diff --git a/clients/client-iam/commands/DeleteServerCertificateCommand.ts b/clients/client-iam/commands/DeleteServerCertificateCommand.ts index 0b546653dd86..abae2e6b89d1 100644 --- a/clients/client-iam/commands/DeleteServerCertificateCommand.ts +++ b/clients/client-iam/commands/DeleteServerCertificateCommand.ts @@ -36,6 +36,20 @@ export interface DeleteServerCertificateCommandOutput extends __MetadataBearer { * see DeleteLoadBalancerListeners in the Elastic Load Balancing API * Reference.

* + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { IAMClient, DeleteServerCertificateCommand } from "@aws-sdk/client-iam"; // ES Modules import + * // const { IAMClient, DeleteServerCertificateCommand } = require("@aws-sdk/client-iam"); // CommonJS import + * const client = new IAMClient(config); + * const command = new DeleteServerCertificateCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteServerCertificateCommandInput} for command's `input` shape. + * @see {@link DeleteServerCertificateCommandOutput} for command's `response` shape. + * @see {@link IAMClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteServerCertificateCommand extends $Command< DeleteServerCertificateCommandInput, diff --git a/clients/client-iam/commands/DeleteServiceLinkedRoleCommand.ts b/clients/client-iam/commands/DeleteServiceLinkedRoleCommand.ts index c552f737e393..368a3407a533 100644 --- a/clients/client-iam/commands/DeleteServiceLinkedRoleCommand.ts +++ b/clients/client-iam/commands/DeleteServiceLinkedRoleCommand.ts @@ -38,6 +38,20 @@ export interface DeleteServiceLinkedRoleCommandOutput extends DeleteServiceLinke * service.

*

For more information about service-linked roles, see Roles terms and concepts: AWS service-linked role in the * IAM User Guide.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { IAMClient, DeleteServiceLinkedRoleCommand } from "@aws-sdk/client-iam"; // ES Modules import + * // const { IAMClient, DeleteServiceLinkedRoleCommand } = require("@aws-sdk/client-iam"); // CommonJS import + * const client = new IAMClient(config); + * const command = new DeleteServiceLinkedRoleCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteServiceLinkedRoleCommandInput} for command's `input` shape. + * @see {@link DeleteServiceLinkedRoleCommandOutput} for command's `response` shape. + * @see {@link IAMClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteServiceLinkedRoleCommand extends $Command< DeleteServiceLinkedRoleCommandInput, diff --git a/clients/client-iam/commands/DeleteServiceSpecificCredentialCommand.ts b/clients/client-iam/commands/DeleteServiceSpecificCredentialCommand.ts index 64e6f63683f9..a7b07b5d227d 100644 --- a/clients/client-iam/commands/DeleteServiceSpecificCredentialCommand.ts +++ b/clients/client-iam/commands/DeleteServiceSpecificCredentialCommand.ts @@ -22,6 +22,20 @@ export interface DeleteServiceSpecificCredentialCommandOutput extends __Metadata /** *

Deletes the specified service-specific credential.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { IAMClient, DeleteServiceSpecificCredentialCommand } from "@aws-sdk/client-iam"; // ES Modules import + * // const { IAMClient, DeleteServiceSpecificCredentialCommand } = require("@aws-sdk/client-iam"); // CommonJS import + * const client = new IAMClient(config); + * const command = new DeleteServiceSpecificCredentialCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteServiceSpecificCredentialCommandInput} for command's `input` shape. + * @see {@link DeleteServiceSpecificCredentialCommandOutput} for command's `response` shape. + * @see {@link IAMClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteServiceSpecificCredentialCommand extends $Command< DeleteServiceSpecificCredentialCommandInput, diff --git a/clients/client-iam/commands/DeleteSigningCertificateCommand.ts b/clients/client-iam/commands/DeleteSigningCertificateCommand.ts index 05e3618433b6..a189751c8fee 100644 --- a/clients/client-iam/commands/DeleteSigningCertificateCommand.ts +++ b/clients/client-iam/commands/DeleteSigningCertificateCommand.ts @@ -26,6 +26,20 @@ export interface DeleteSigningCertificateCommandOutput extends __MetadataBearer * the AWS access key ID signing the request. This operation works for access keys under * the AWS account. Consequently, you can use this operation to manage AWS account root * user credentials even if the AWS account has no associated IAM users.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { IAMClient, DeleteSigningCertificateCommand } from "@aws-sdk/client-iam"; // ES Modules import + * // const { IAMClient, DeleteSigningCertificateCommand } = require("@aws-sdk/client-iam"); // CommonJS import + * const client = new IAMClient(config); + * const command = new DeleteSigningCertificateCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteSigningCertificateCommandInput} for command's `input` shape. + * @see {@link DeleteSigningCertificateCommandOutput} for command's `response` shape. + * @see {@link IAMClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteSigningCertificateCommand extends $Command< DeleteSigningCertificateCommandInput, diff --git a/clients/client-iam/commands/DeleteUserCommand.ts b/clients/client-iam/commands/DeleteUserCommand.ts index fb8c3b7f8339..774ead61e5dd 100644 --- a/clients/client-iam/commands/DeleteUserCommand.ts +++ b/clients/client-iam/commands/DeleteUserCommand.ts @@ -51,6 +51,20 @@ export interface DeleteUserCommandOutput extends __MetadataBearer {} *

Group memberships (RemoveUserFromGroup)

* * + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { IAMClient, DeleteUserCommand } from "@aws-sdk/client-iam"; // ES Modules import + * // const { IAMClient, DeleteUserCommand } = require("@aws-sdk/client-iam"); // CommonJS import + * const client = new IAMClient(config); + * const command = new DeleteUserCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteUserCommandInput} for command's `input` shape. + * @see {@link DeleteUserCommandOutput} for command's `response` shape. + * @see {@link IAMClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteUserCommand extends $Command< DeleteUserCommandInput, diff --git a/clients/client-iam/commands/DeleteUserPermissionsBoundaryCommand.ts b/clients/client-iam/commands/DeleteUserPermissionsBoundaryCommand.ts index 72fa30d5b77f..d1366d2cbfbf 100644 --- a/clients/client-iam/commands/DeleteUserPermissionsBoundaryCommand.ts +++ b/clients/client-iam/commands/DeleteUserPermissionsBoundaryCommand.ts @@ -27,6 +27,20 @@ export interface DeleteUserPermissionsBoundaryCommandOutput extends __MetadataBe * allowing the user to perform all the actions granted in its permissions policies. *

* + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { IAMClient, DeleteUserPermissionsBoundaryCommand } from "@aws-sdk/client-iam"; // ES Modules import + * // const { IAMClient, DeleteUserPermissionsBoundaryCommand } = require("@aws-sdk/client-iam"); // CommonJS import + * const client = new IAMClient(config); + * const command = new DeleteUserPermissionsBoundaryCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteUserPermissionsBoundaryCommandInput} for command's `input` shape. + * @see {@link DeleteUserPermissionsBoundaryCommandOutput} for command's `response` shape. + * @see {@link IAMClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteUserPermissionsBoundaryCommand extends $Command< DeleteUserPermissionsBoundaryCommandInput, diff --git a/clients/client-iam/commands/DeleteUserPolicyCommand.ts b/clients/client-iam/commands/DeleteUserPolicyCommand.ts index 3279d0bfe6ed..65563a9f9c2b 100644 --- a/clients/client-iam/commands/DeleteUserPolicyCommand.ts +++ b/clients/client-iam/commands/DeleteUserPolicyCommand.ts @@ -27,6 +27,20 @@ export interface DeleteUserPolicyCommandOutput extends __MetadataBearer {} * a user, use DetachUserPolicy. For more information about policies, * refer to Managed policies and inline * policies in the IAM User Guide.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { IAMClient, DeleteUserPolicyCommand } from "@aws-sdk/client-iam"; // ES Modules import + * // const { IAMClient, DeleteUserPolicyCommand } = require("@aws-sdk/client-iam"); // CommonJS import + * const client = new IAMClient(config); + * const command = new DeleteUserPolicyCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteUserPolicyCommandInput} for command's `input` shape. + * @see {@link DeleteUserPolicyCommandOutput} for command's `response` shape. + * @see {@link IAMClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteUserPolicyCommand extends $Command< DeleteUserPolicyCommandInput, diff --git a/clients/client-iam/commands/DeleteVirtualMFADeviceCommand.ts b/clients/client-iam/commands/DeleteVirtualMFADeviceCommand.ts index ffe596820f36..a6bbe38c4fc5 100644 --- a/clients/client-iam/commands/DeleteVirtualMFADeviceCommand.ts +++ b/clients/client-iam/commands/DeleteVirtualMFADeviceCommand.ts @@ -26,6 +26,20 @@ export interface DeleteVirtualMFADeviceCommandOutput extends __MetadataBearer {} *

You must deactivate a user's virtual MFA device before you can delete it. For * information about deactivating MFA devices, see DeactivateMFADevice.

* + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { IAMClient, DeleteVirtualMFADeviceCommand } from "@aws-sdk/client-iam"; // ES Modules import + * // const { IAMClient, DeleteVirtualMFADeviceCommand } = require("@aws-sdk/client-iam"); // CommonJS import + * const client = new IAMClient(config); + * const command = new DeleteVirtualMFADeviceCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteVirtualMFADeviceCommandInput} for command's `input` shape. + * @see {@link DeleteVirtualMFADeviceCommandOutput} for command's `response` shape. + * @see {@link IAMClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteVirtualMFADeviceCommand extends $Command< DeleteVirtualMFADeviceCommandInput, diff --git a/clients/client-iam/commands/DetachGroupPolicyCommand.ts b/clients/client-iam/commands/DetachGroupPolicyCommand.ts index ad0bec0669ad..1b0328bdba26 100644 --- a/clients/client-iam/commands/DetachGroupPolicyCommand.ts +++ b/clients/client-iam/commands/DetachGroupPolicyCommand.ts @@ -26,6 +26,20 @@ export interface DetachGroupPolicyCommandOutput extends __MetadataBearer {} * use DeleteGroupPolicy. For information about policies, see Managed * policies and inline policies in the * IAM User Guide.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { IAMClient, DetachGroupPolicyCommand } from "@aws-sdk/client-iam"; // ES Modules import + * // const { IAMClient, DetachGroupPolicyCommand } = require("@aws-sdk/client-iam"); // CommonJS import + * const client = new IAMClient(config); + * const command = new DetachGroupPolicyCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DetachGroupPolicyCommandInput} for command's `input` shape. + * @see {@link DetachGroupPolicyCommandOutput} for command's `response` shape. + * @see {@link IAMClientResolvedConfig | config} for command's `input` shape. + * */ export class DetachGroupPolicyCommand extends $Command< DetachGroupPolicyCommandInput, diff --git a/clients/client-iam/commands/DetachRolePolicyCommand.ts b/clients/client-iam/commands/DetachRolePolicyCommand.ts index ff0f2df29577..208ced022860 100644 --- a/clients/client-iam/commands/DetachRolePolicyCommand.ts +++ b/clients/client-iam/commands/DetachRolePolicyCommand.ts @@ -26,6 +26,20 @@ export interface DetachRolePolicyCommandOutput extends __MetadataBearer {} * DeleteRolePolicy. For information about policies, see Managed * policies and inline policies in the * IAM User Guide.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { IAMClient, DetachRolePolicyCommand } from "@aws-sdk/client-iam"; // ES Modules import + * // const { IAMClient, DetachRolePolicyCommand } = require("@aws-sdk/client-iam"); // CommonJS import + * const client = new IAMClient(config); + * const command = new DetachRolePolicyCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DetachRolePolicyCommandInput} for command's `input` shape. + * @see {@link DetachRolePolicyCommandOutput} for command's `response` shape. + * @see {@link IAMClientResolvedConfig | config} for command's `input` shape. + * */ export class DetachRolePolicyCommand extends $Command< DetachRolePolicyCommandInput, diff --git a/clients/client-iam/commands/DetachUserPolicyCommand.ts b/clients/client-iam/commands/DetachUserPolicyCommand.ts index 3e33f4381446..d6b3a7e2122d 100644 --- a/clients/client-iam/commands/DetachUserPolicyCommand.ts +++ b/clients/client-iam/commands/DetachUserPolicyCommand.ts @@ -26,6 +26,20 @@ export interface DetachUserPolicyCommandOutput extends __MetadataBearer {} * DeleteUserPolicy. For information about policies, see Managed * policies and inline policies in the * IAM User Guide.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { IAMClient, DetachUserPolicyCommand } from "@aws-sdk/client-iam"; // ES Modules import + * // const { IAMClient, DetachUserPolicyCommand } = require("@aws-sdk/client-iam"); // CommonJS import + * const client = new IAMClient(config); + * const command = new DetachUserPolicyCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DetachUserPolicyCommandInput} for command's `input` shape. + * @see {@link DetachUserPolicyCommandOutput} for command's `response` shape. + * @see {@link IAMClientResolvedConfig | config} for command's `input` shape. + * */ export class DetachUserPolicyCommand extends $Command< DetachUserPolicyCommandInput, diff --git a/clients/client-iam/commands/EnableMFADeviceCommand.ts b/clients/client-iam/commands/EnableMFADeviceCommand.ts index 211ccd1d4878..232c65eee6e3 100644 --- a/clients/client-iam/commands/EnableMFADeviceCommand.ts +++ b/clients/client-iam/commands/EnableMFADeviceCommand.ts @@ -24,6 +24,20 @@ export interface EnableMFADeviceCommandOutput extends __MetadataBearer {} *

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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { IAMClient, EnableMFADeviceCommand } from "@aws-sdk/client-iam"; // ES Modules import + * // const { IAMClient, EnableMFADeviceCommand } = require("@aws-sdk/client-iam"); // CommonJS import + * const client = new IAMClient(config); + * const command = new EnableMFADeviceCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link EnableMFADeviceCommandInput} for command's `input` shape. + * @see {@link EnableMFADeviceCommandOutput} for command's `response` shape. + * @see {@link IAMClientResolvedConfig | config} for command's `input` shape. + * */ export class EnableMFADeviceCommand extends $Command< EnableMFADeviceCommandInput, diff --git a/clients/client-iam/commands/GenerateCredentialReportCommand.ts b/clients/client-iam/commands/GenerateCredentialReportCommand.ts index b24c321f80b6..0419837c9934 100644 --- a/clients/client-iam/commands/GenerateCredentialReportCommand.ts +++ b/clients/client-iam/commands/GenerateCredentialReportCommand.ts @@ -24,6 +24,20 @@ export interface GenerateCredentialReportCommandOutput extends GenerateCredentia *

Generates a credential report for the AWS account. For more information about the * credential report, see Getting credential reports in * the IAM User Guide.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { IAMClient, GenerateCredentialReportCommand } from "@aws-sdk/client-iam"; // ES Modules import + * // const { IAMClient, GenerateCredentialReportCommand } = require("@aws-sdk/client-iam"); // CommonJS import + * const client = new IAMClient(config); + * const command = new GenerateCredentialReportCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GenerateCredentialReportCommandInput} for command's `input` shape. + * @see {@link GenerateCredentialReportCommandOutput} for command's `response` shape. + * @see {@link IAMClientResolvedConfig | config} for command's `input` shape. + * */ export class GenerateCredentialReportCommand extends $Command< GenerateCredentialReportCommandInput, diff --git a/clients/client-iam/commands/GenerateOrganizationsAccessReportCommand.ts b/clients/client-iam/commands/GenerateOrganizationsAccessReportCommand.ts index a84b88d25971..a9f979eae441 100644 --- a/clients/client-iam/commands/GenerateOrganizationsAccessReportCommand.ts +++ b/clients/client-iam/commands/GenerateOrganizationsAccessReportCommand.ts @@ -158,6 +158,20 @@ export interface GenerateOrganizationsAccessReportCommandOutput * *

For more information about service last accessed data, see Reducing policy scope by * viewing user activity in the IAM User Guide.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { IAMClient, GenerateOrganizationsAccessReportCommand } from "@aws-sdk/client-iam"; // ES Modules import + * // const { IAMClient, GenerateOrganizationsAccessReportCommand } = require("@aws-sdk/client-iam"); // CommonJS import + * const client = new IAMClient(config); + * const command = new GenerateOrganizationsAccessReportCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GenerateOrganizationsAccessReportCommandInput} for command's `input` shape. + * @see {@link GenerateOrganizationsAccessReportCommandOutput} for command's `response` shape. + * @see {@link IAMClientResolvedConfig | config} for command's `input` shape. + * */ export class GenerateOrganizationsAccessReportCommand extends $Command< GenerateOrganizationsAccessReportCommandInput, diff --git a/clients/client-iam/commands/GenerateServiceLastAccessedDetailsCommand.ts b/clients/client-iam/commands/GenerateServiceLastAccessedDetailsCommand.ts index e923f9e3b44d..63a85b96afec 100644 --- a/clients/client-iam/commands/GenerateServiceLastAccessedDetailsCommand.ts +++ b/clients/client-iam/commands/GenerateServiceLastAccessedDetailsCommand.ts @@ -80,6 +80,20 @@ export interface GenerateServiceLastAccessedDetailsCommandOutput * *

For more information about service and action last accessed data, see Reducing permissions using service last accessed data in the * IAM User Guide.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { IAMClient, GenerateServiceLastAccessedDetailsCommand } from "@aws-sdk/client-iam"; // ES Modules import + * // const { IAMClient, GenerateServiceLastAccessedDetailsCommand } = require("@aws-sdk/client-iam"); // CommonJS import + * const client = new IAMClient(config); + * const command = new GenerateServiceLastAccessedDetailsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GenerateServiceLastAccessedDetailsCommandInput} for command's `input` shape. + * @see {@link GenerateServiceLastAccessedDetailsCommandOutput} for command's `response` shape. + * @see {@link IAMClientResolvedConfig | config} for command's `input` shape. + * */ export class GenerateServiceLastAccessedDetailsCommand extends $Command< GenerateServiceLastAccessedDetailsCommandInput, diff --git a/clients/client-iam/commands/GetAccessKeyLastUsedCommand.ts b/clients/client-iam/commands/GetAccessKeyLastUsedCommand.ts index e3ef2a5b2031..7a79f67e02ce 100644 --- a/clients/client-iam/commands/GetAccessKeyLastUsedCommand.ts +++ b/clients/client-iam/commands/GetAccessKeyLastUsedCommand.ts @@ -24,6 +24,20 @@ export interface GetAccessKeyLastUsedCommandOutput extends GetAccessKeyLastUsedR *

Retrieves information about when the specified access key was last used. The * information includes the date and time of last use, along with the AWS service and * Region that were specified in the last request made with that key.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { IAMClient, GetAccessKeyLastUsedCommand } from "@aws-sdk/client-iam"; // ES Modules import + * // const { IAMClient, GetAccessKeyLastUsedCommand } = require("@aws-sdk/client-iam"); // CommonJS import + * const client = new IAMClient(config); + * const command = new GetAccessKeyLastUsedCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetAccessKeyLastUsedCommandInput} for command's `input` shape. + * @see {@link GetAccessKeyLastUsedCommandOutput} for command's `response` shape. + * @see {@link IAMClientResolvedConfig | config} for command's `input` shape. + * */ export class GetAccessKeyLastUsedCommand extends $Command< GetAccessKeyLastUsedCommandInput, diff --git a/clients/client-iam/commands/GetAccountAuthorizationDetailsCommand.ts b/clients/client-iam/commands/GetAccountAuthorizationDetailsCommand.ts index ada8c12e9420..56c840f5b445 100644 --- a/clients/client-iam/commands/GetAccountAuthorizationDetailsCommand.ts +++ b/clients/client-iam/commands/GetAccountAuthorizationDetailsCommand.ts @@ -37,6 +37,20 @@ export interface GetAccountAuthorizationDetailsCommandOutput *

You can optionally filter the results using the Filter parameter. You can * paginate the results using the MaxItems and Marker * parameters.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { IAMClient, GetAccountAuthorizationDetailsCommand } from "@aws-sdk/client-iam"; // ES Modules import + * // const { IAMClient, GetAccountAuthorizationDetailsCommand } = require("@aws-sdk/client-iam"); // CommonJS import + * const client = new IAMClient(config); + * const command = new GetAccountAuthorizationDetailsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetAccountAuthorizationDetailsCommandInput} for command's `input` shape. + * @see {@link GetAccountAuthorizationDetailsCommandOutput} for command's `response` shape. + * @see {@link IAMClientResolvedConfig | config} for command's `input` shape. + * */ export class GetAccountAuthorizationDetailsCommand extends $Command< GetAccountAuthorizationDetailsCommandInput, diff --git a/clients/client-iam/commands/GetAccountPasswordPolicyCommand.ts b/clients/client-iam/commands/GetAccountPasswordPolicyCommand.ts index 223d929ef7bf..93dec117428d 100644 --- a/clients/client-iam/commands/GetAccountPasswordPolicyCommand.ts +++ b/clients/client-iam/commands/GetAccountPasswordPolicyCommand.ts @@ -25,6 +25,20 @@ export interface GetAccountPasswordPolicyCommandOutput extends GetAccountPasswor * 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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { IAMClient, GetAccountPasswordPolicyCommand } from "@aws-sdk/client-iam"; // ES Modules import + * // const { IAMClient, GetAccountPasswordPolicyCommand } = require("@aws-sdk/client-iam"); // CommonJS import + * const client = new IAMClient(config); + * const command = new GetAccountPasswordPolicyCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetAccountPasswordPolicyCommandInput} for command's `input` shape. + * @see {@link GetAccountPasswordPolicyCommandOutput} for command's `response` shape. + * @see {@link IAMClientResolvedConfig | config} for command's `input` shape. + * */ export class GetAccountPasswordPolicyCommand extends $Command< GetAccountPasswordPolicyCommandInput, diff --git a/clients/client-iam/commands/GetAccountSummaryCommand.ts b/clients/client-iam/commands/GetAccountSummaryCommand.ts index 5d7c55fa4a8c..eb209ef0f0ca 100644 --- a/clients/client-iam/commands/GetAccountSummaryCommand.ts +++ b/clients/client-iam/commands/GetAccountSummaryCommand.ts @@ -25,6 +25,20 @@ export interface GetAccountSummaryCommandOutput extends GetAccountSummaryRespons * account.

*

For information about IAM quotas, see IAM and STS quotas in the * IAM User Guide.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { IAMClient, GetAccountSummaryCommand } from "@aws-sdk/client-iam"; // ES Modules import + * // const { IAMClient, GetAccountSummaryCommand } = require("@aws-sdk/client-iam"); // CommonJS import + * const client = new IAMClient(config); + * const command = new GetAccountSummaryCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetAccountSummaryCommandInput} for command's `input` shape. + * @see {@link GetAccountSummaryCommandOutput} for command's `response` shape. + * @see {@link IAMClientResolvedConfig | config} for command's `input` shape. + * */ export class GetAccountSummaryCommand extends $Command< GetAccountSummaryCommandInput, diff --git a/clients/client-iam/commands/GetContextKeysForCustomPolicyCommand.ts b/clients/client-iam/commands/GetContextKeysForCustomPolicyCommand.ts index 93958a1afec3..a29ae4c79bd0 100644 --- a/clients/client-iam/commands/GetContextKeysForCustomPolicyCommand.ts +++ b/clients/client-iam/commands/GetContextKeysForCustomPolicyCommand.ts @@ -31,6 +31,20 @@ export interface GetContextKeysForCustomPolicyCommandOutput extends GetContextKe * 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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { IAMClient, GetContextKeysForCustomPolicyCommand } from "@aws-sdk/client-iam"; // ES Modules import + * // const { IAMClient, GetContextKeysForCustomPolicyCommand } = require("@aws-sdk/client-iam"); // CommonJS import + * const client = new IAMClient(config); + * const command = new GetContextKeysForCustomPolicyCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetContextKeysForCustomPolicyCommandInput} for command's `input` shape. + * @see {@link GetContextKeysForCustomPolicyCommandOutput} for command's `response` shape. + * @see {@link IAMClientResolvedConfig | config} for command's `input` shape. + * */ export class GetContextKeysForCustomPolicyCommand extends $Command< GetContextKeysForCustomPolicyCommandInput, diff --git a/clients/client-iam/commands/GetContextKeysForPrincipalPolicyCommand.ts b/clients/client-iam/commands/GetContextKeysForPrincipalPolicyCommand.ts index 17ddd18bd2f4..40eb4c74fa1f 100644 --- a/clients/client-iam/commands/GetContextKeysForPrincipalPolicyCommand.ts +++ b/clients/client-iam/commands/GetContextKeysForPrincipalPolicyCommand.ts @@ -37,6 +37,20 @@ export interface GetContextKeysForPrincipalPolicyCommandOutput *

Context keys are variables maintained by AWS 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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { IAMClient, GetContextKeysForPrincipalPolicyCommand } from "@aws-sdk/client-iam"; // ES Modules import + * // const { IAMClient, GetContextKeysForPrincipalPolicyCommand } = require("@aws-sdk/client-iam"); // CommonJS import + * const client = new IAMClient(config); + * const command = new GetContextKeysForPrincipalPolicyCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetContextKeysForPrincipalPolicyCommandInput} for command's `input` shape. + * @see {@link GetContextKeysForPrincipalPolicyCommandOutput} for command's `response` shape. + * @see {@link IAMClientResolvedConfig | config} for command's `input` shape. + * */ export class GetContextKeysForPrincipalPolicyCommand extends $Command< GetContextKeysForPrincipalPolicyCommandInput, diff --git a/clients/client-iam/commands/GetCredentialReportCommand.ts b/clients/client-iam/commands/GetCredentialReportCommand.ts index 07a823c05313..3cd469070738 100644 --- a/clients/client-iam/commands/GetCredentialReportCommand.ts +++ b/clients/client-iam/commands/GetCredentialReportCommand.ts @@ -24,6 +24,20 @@ export interface GetCredentialReportCommandOutput extends GetCredentialReportRes *

Retrieves a credential report for the AWS account. For more information about the * credential report, see Getting credential reports in * the IAM User Guide.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { IAMClient, GetCredentialReportCommand } from "@aws-sdk/client-iam"; // ES Modules import + * // const { IAMClient, GetCredentialReportCommand } = require("@aws-sdk/client-iam"); // CommonJS import + * const client = new IAMClient(config); + * const command = new GetCredentialReportCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetCredentialReportCommandInput} for command's `input` shape. + * @see {@link GetCredentialReportCommandOutput} for command's `response` shape. + * @see {@link IAMClientResolvedConfig | config} for command's `input` shape. + * */ export class GetCredentialReportCommand extends $Command< GetCredentialReportCommandInput, diff --git a/clients/client-iam/commands/GetGroupCommand.ts b/clients/client-iam/commands/GetGroupCommand.ts index 59a552b12398..6d92ddc47967 100644 --- a/clients/client-iam/commands/GetGroupCommand.ts +++ b/clients/client-iam/commands/GetGroupCommand.ts @@ -20,6 +20,20 @@ export interface GetGroupCommandOutput extends GetGroupResponse, __MetadataBeare /** *

Returns a list of IAM users that are in the specified IAM group. You can paginate * the results using the MaxItems and Marker parameters.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { IAMClient, GetGroupCommand } from "@aws-sdk/client-iam"; // ES Modules import + * // const { IAMClient, GetGroupCommand } = require("@aws-sdk/client-iam"); // CommonJS import + * const client = new IAMClient(config); + * const command = new GetGroupCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetGroupCommandInput} for command's `input` shape. + * @see {@link GetGroupCommandOutput} for command's `response` shape. + * @see {@link IAMClientResolvedConfig | config} for command's `input` shape. + * */ export class GetGroupCommand extends $Command { // Start section: command_properties diff --git a/clients/client-iam/commands/GetGroupPolicyCommand.ts b/clients/client-iam/commands/GetGroupPolicyCommand.ts index b6ee9760e67e..1f97401273b0 100644 --- a/clients/client-iam/commands/GetGroupPolicyCommand.ts +++ b/clients/client-iam/commands/GetGroupPolicyCommand.ts @@ -36,6 +36,20 @@ export interface GetGroupPolicyCommandOutput extends GetGroupPolicyResponse, __M * retrieve the policy document.

*

For more information about policies, see Managed policies and inline * policies in the IAM User Guide.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { IAMClient, GetGroupPolicyCommand } from "@aws-sdk/client-iam"; // ES Modules import + * // const { IAMClient, GetGroupPolicyCommand } = require("@aws-sdk/client-iam"); // CommonJS import + * const client = new IAMClient(config); + * const command = new GetGroupPolicyCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetGroupPolicyCommandInput} for command's `input` shape. + * @see {@link GetGroupPolicyCommandOutput} for command's `response` shape. + * @see {@link IAMClientResolvedConfig | config} for command's `input` shape. + * */ export class GetGroupPolicyCommand extends $Command< GetGroupPolicyCommandInput, diff --git a/clients/client-iam/commands/GetInstanceProfileCommand.ts b/clients/client-iam/commands/GetInstanceProfileCommand.ts index 1f2e125e7785..75be498c869c 100644 --- a/clients/client-iam/commands/GetInstanceProfileCommand.ts +++ b/clients/client-iam/commands/GetInstanceProfileCommand.ts @@ -25,6 +25,20 @@ export interface GetInstanceProfileCommandOutput extends GetInstanceProfileRespo * profile's path, GUID, ARN, and role. For more information about instance profiles, see * About * instance profiles in the IAM User Guide.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { IAMClient, GetInstanceProfileCommand } from "@aws-sdk/client-iam"; // ES Modules import + * // const { IAMClient, GetInstanceProfileCommand } = require("@aws-sdk/client-iam"); // CommonJS import + * const client = new IAMClient(config); + * const command = new GetInstanceProfileCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetInstanceProfileCommandInput} for command's `input` shape. + * @see {@link GetInstanceProfileCommandOutput} for command's `response` shape. + * @see {@link IAMClientResolvedConfig | config} for command's `input` shape. + * */ export class GetInstanceProfileCommand extends $Command< GetInstanceProfileCommandInput, diff --git a/clients/client-iam/commands/GetLoginProfileCommand.ts b/clients/client-iam/commands/GetLoginProfileCommand.ts index 2eac8070588b..4c5bd5decb19 100644 --- a/clients/client-iam/commands/GetLoginProfileCommand.ts +++ b/clients/client-iam/commands/GetLoginProfileCommand.ts @@ -24,6 +24,20 @@ export interface GetLoginProfileCommandOutput extends GetLoginProfileResponse, _ *

Retrieves the user name and password creation date for the specified IAM user. If * the user has not been assigned a password, the operation returns a 404 * (NoSuchEntity) error.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { IAMClient, GetLoginProfileCommand } from "@aws-sdk/client-iam"; // ES Modules import + * // const { IAMClient, GetLoginProfileCommand } = require("@aws-sdk/client-iam"); // CommonJS import + * const client = new IAMClient(config); + * const command = new GetLoginProfileCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetLoginProfileCommandInput} for command's `input` shape. + * @see {@link GetLoginProfileCommandOutput} for command's `response` shape. + * @see {@link IAMClientResolvedConfig | config} for command's `input` shape. + * */ export class GetLoginProfileCommand extends $Command< GetLoginProfileCommandInput, diff --git a/clients/client-iam/commands/GetOpenIDConnectProviderCommand.ts b/clients/client-iam/commands/GetOpenIDConnectProviderCommand.ts index 8e9520078574..7c7e6fa59bbb 100644 --- a/clients/client-iam/commands/GetOpenIDConnectProviderCommand.ts +++ b/clients/client-iam/commands/GetOpenIDConnectProviderCommand.ts @@ -23,6 +23,20 @@ export interface GetOpenIDConnectProviderCommandOutput extends GetOpenIDConnectP /** *

Returns information about the specified OpenID Connect (OIDC) provider resource object * in IAM.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { IAMClient, GetOpenIDConnectProviderCommand } from "@aws-sdk/client-iam"; // ES Modules import + * // const { IAMClient, GetOpenIDConnectProviderCommand } = require("@aws-sdk/client-iam"); // CommonJS import + * const client = new IAMClient(config); + * const command = new GetOpenIDConnectProviderCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetOpenIDConnectProviderCommandInput} for command's `input` shape. + * @see {@link GetOpenIDConnectProviderCommandOutput} for command's `response` shape. + * @see {@link IAMClientResolvedConfig | config} for command's `input` shape. + * */ export class GetOpenIDConnectProviderCommand extends $Command< GetOpenIDConnectProviderCommandInput, diff --git a/clients/client-iam/commands/GetOrganizationsAccessReportCommand.ts b/clients/client-iam/commands/GetOrganizationsAccessReportCommand.ts index 4bd15fdc948a..004e348a4fb8 100644 --- a/clients/client-iam/commands/GetOrganizationsAccessReportCommand.ts +++ b/clients/client-iam/commands/GetOrganizationsAccessReportCommand.ts @@ -41,6 +41,20 @@ export interface GetOrganizationsAccessReportCommandOutput * 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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { IAMClient, GetOrganizationsAccessReportCommand } from "@aws-sdk/client-iam"; // ES Modules import + * // const { IAMClient, GetOrganizationsAccessReportCommand } = require("@aws-sdk/client-iam"); // CommonJS import + * const client = new IAMClient(config); + * const command = new GetOrganizationsAccessReportCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetOrganizationsAccessReportCommandInput} for command's `input` shape. + * @see {@link GetOrganizationsAccessReportCommandOutput} for command's `response` shape. + * @see {@link IAMClientResolvedConfig | config} for command's `input` shape. + * */ export class GetOrganizationsAccessReportCommand extends $Command< GetOrganizationsAccessReportCommandInput, diff --git a/clients/client-iam/commands/GetPolicyCommand.ts b/clients/client-iam/commands/GetPolicyCommand.ts index c739c9db60a8..802a4c4c477e 100644 --- a/clients/client-iam/commands/GetPolicyCommand.ts +++ b/clients/client-iam/commands/GetPolicyCommand.ts @@ -28,6 +28,20 @@ export interface GetPolicyCommandOutput extends GetPolicyResponse, __MetadataBea * 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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { IAMClient, GetPolicyCommand } from "@aws-sdk/client-iam"; // ES Modules import + * // const { IAMClient, GetPolicyCommand } = require("@aws-sdk/client-iam"); // CommonJS import + * const client = new IAMClient(config); + * const command = new GetPolicyCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetPolicyCommandInput} for command's `input` shape. + * @see {@link GetPolicyCommandOutput} for command's `response` shape. + * @see {@link IAMClientResolvedConfig | config} for command's `input` shape. + * */ export class GetPolicyCommand extends $Command { // Start section: command_properties diff --git a/clients/client-iam/commands/GetPolicyVersionCommand.ts b/clients/client-iam/commands/GetPolicyVersionCommand.ts index 01ca55dd7174..1f35366c9136 100644 --- a/clients/client-iam/commands/GetPolicyVersionCommand.ts +++ b/clients/client-iam/commands/GetPolicyVersionCommand.ts @@ -37,6 +37,20 @@ export interface GetPolicyVersionCommandOutput extends GetPolicyVersionResponse, * policies in the IAM User Guide.

*

For more information about managed policy versions, see Versioning for managed * policies in the IAM User Guide.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { IAMClient, GetPolicyVersionCommand } from "@aws-sdk/client-iam"; // ES Modules import + * // const { IAMClient, GetPolicyVersionCommand } = require("@aws-sdk/client-iam"); // CommonJS import + * const client = new IAMClient(config); + * const command = new GetPolicyVersionCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetPolicyVersionCommandInput} for command's `input` shape. + * @see {@link GetPolicyVersionCommandOutput} for command's `response` shape. + * @see {@link IAMClientResolvedConfig | config} for command's `input` shape. + * */ export class GetPolicyVersionCommand extends $Command< GetPolicyVersionCommandInput, diff --git a/clients/client-iam/commands/GetRoleCommand.ts b/clients/client-iam/commands/GetRoleCommand.ts index 6c4a4771e227..b6904409389a 100644 --- a/clients/client-iam/commands/GetRoleCommand.ts +++ b/clients/client-iam/commands/GetRoleCommand.ts @@ -28,6 +28,20 @@ export interface GetRoleCommandOutput extends GetRoleResponse, __MetadataBearer * can use the decode method of the java.net.URLDecoder utility class in * the Java SDK. Other languages and SDKs provide similar functionality.

* + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { IAMClient, GetRoleCommand } from "@aws-sdk/client-iam"; // ES Modules import + * // const { IAMClient, GetRoleCommand } = require("@aws-sdk/client-iam"); // CommonJS import + * const client = new IAMClient(config); + * const command = new GetRoleCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetRoleCommandInput} for command's `input` shape. + * @see {@link GetRoleCommandOutput} for command's `response` shape. + * @see {@link IAMClientResolvedConfig | config} for command's `input` shape. + * */ export class GetRoleCommand extends $Command { // Start section: command_properties diff --git a/clients/client-iam/commands/GetRolePolicyCommand.ts b/clients/client-iam/commands/GetRolePolicyCommand.ts index fcdd77dee0ef..82e8d708d0fe 100644 --- a/clients/client-iam/commands/GetRolePolicyCommand.ts +++ b/clients/client-iam/commands/GetRolePolicyCommand.ts @@ -38,6 +38,20 @@ export interface GetRolePolicyCommandOutput extends GetRolePolicyResponse, __Met * policies in the IAM User Guide.

*

For more information about roles, see Using roles to delegate permissions and * federate identities.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { IAMClient, GetRolePolicyCommand } from "@aws-sdk/client-iam"; // ES Modules import + * // const { IAMClient, GetRolePolicyCommand } = require("@aws-sdk/client-iam"); // CommonJS import + * const client = new IAMClient(config); + * const command = new GetRolePolicyCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetRolePolicyCommandInput} for command's `input` shape. + * @see {@link GetRolePolicyCommandOutput} for command's `response` shape. + * @see {@link IAMClientResolvedConfig | config} for command's `input` shape. + * */ export class GetRolePolicyCommand extends $Command< GetRolePolicyCommandInput, diff --git a/clients/client-iam/commands/GetSAMLProviderCommand.ts b/clients/client-iam/commands/GetSAMLProviderCommand.ts index f78e52abd293..029e711ecf5b 100644 --- a/clients/client-iam/commands/GetSAMLProviderCommand.ts +++ b/clients/client-iam/commands/GetSAMLProviderCommand.ts @@ -26,6 +26,20 @@ export interface GetSAMLProviderCommandOutput extends GetSAMLProviderResponse, _ * *

This operation requires Signature Version 4.

* + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { IAMClient, GetSAMLProviderCommand } from "@aws-sdk/client-iam"; // ES Modules import + * // const { IAMClient, GetSAMLProviderCommand } = require("@aws-sdk/client-iam"); // CommonJS import + * const client = new IAMClient(config); + * const command = new GetSAMLProviderCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetSAMLProviderCommandInput} for command's `input` shape. + * @see {@link GetSAMLProviderCommandOutput} for command's `response` shape. + * @see {@link IAMClientResolvedConfig | config} for command's `input` shape. + * */ export class GetSAMLProviderCommand extends $Command< GetSAMLProviderCommandInput, diff --git a/clients/client-iam/commands/GetSSHPublicKeyCommand.ts b/clients/client-iam/commands/GetSSHPublicKeyCommand.ts index aadc95675a77..ef593dc74ace 100644 --- a/clients/client-iam/commands/GetSSHPublicKeyCommand.ts +++ b/clients/client-iam/commands/GetSSHPublicKeyCommand.ts @@ -26,6 +26,20 @@ export interface GetSSHPublicKeyCommandOutput extends GetSSHPublicKeyResponse, _ * associated IAM user to an AWS CodeCommit repository. For more information about using SSH keys * to authenticate to an AWS CodeCommit repository, see Set up AWS CodeCommit for SSH * connections in the AWS CodeCommit User Guide.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { IAMClient, GetSSHPublicKeyCommand } from "@aws-sdk/client-iam"; // ES Modules import + * // const { IAMClient, GetSSHPublicKeyCommand } = require("@aws-sdk/client-iam"); // CommonJS import + * const client = new IAMClient(config); + * const command = new GetSSHPublicKeyCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetSSHPublicKeyCommandInput} for command's `input` shape. + * @see {@link GetSSHPublicKeyCommandOutput} for command's `response` shape. + * @see {@link IAMClientResolvedConfig | config} for command's `input` shape. + * */ export class GetSSHPublicKeyCommand extends $Command< GetSSHPublicKeyCommandInput, diff --git a/clients/client-iam/commands/GetServerCertificateCommand.ts b/clients/client-iam/commands/GetServerCertificateCommand.ts index 97b4d52837ed..191059061f3a 100644 --- a/clients/client-iam/commands/GetServerCertificateCommand.ts +++ b/clients/client-iam/commands/GetServerCertificateCommand.ts @@ -26,6 +26,20 @@ export interface GetServerCertificateCommandOutput extends GetServerCertificateR * with server certificates in the IAM User Guide. This * topic includes a list of AWS services that can use the server certificates that you * manage with IAM.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { IAMClient, GetServerCertificateCommand } from "@aws-sdk/client-iam"; // ES Modules import + * // const { IAMClient, GetServerCertificateCommand } = require("@aws-sdk/client-iam"); // CommonJS import + * const client = new IAMClient(config); + * const command = new GetServerCertificateCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetServerCertificateCommandInput} for command's `input` shape. + * @see {@link GetServerCertificateCommandOutput} for command's `response` shape. + * @see {@link IAMClientResolvedConfig | config} for command's `input` shape. + * */ export class GetServerCertificateCommand extends $Command< GetServerCertificateCommandInput, diff --git a/clients/client-iam/commands/GetServiceLastAccessedDetailsCommand.ts b/clients/client-iam/commands/GetServiceLastAccessedDetailsCommand.ts index e4e9a65c0f7e..d23a6cad46b8 100644 --- a/clients/client-iam/commands/GetServiceLastAccessedDetailsCommand.ts +++ b/clients/client-iam/commands/GetServiceLastAccessedDetailsCommand.ts @@ -75,6 +75,20 @@ export interface GetServiceLastAccessedDetailsCommandOutput * 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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { IAMClient, GetServiceLastAccessedDetailsCommand } from "@aws-sdk/client-iam"; // ES Modules import + * // const { IAMClient, GetServiceLastAccessedDetailsCommand } = require("@aws-sdk/client-iam"); // CommonJS import + * const client = new IAMClient(config); + * const command = new GetServiceLastAccessedDetailsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetServiceLastAccessedDetailsCommandInput} for command's `input` shape. + * @see {@link GetServiceLastAccessedDetailsCommandOutput} for command's `response` shape. + * @see {@link IAMClientResolvedConfig | config} for command's `input` shape. + * */ export class GetServiceLastAccessedDetailsCommand extends $Command< GetServiceLastAccessedDetailsCommandInput, diff --git a/clients/client-iam/commands/GetServiceLastAccessedDetailsWithEntitiesCommand.ts b/clients/client-iam/commands/GetServiceLastAccessedDetailsWithEntitiesCommand.ts index 745ee9ff3f62..19f78f0d2d67 100644 --- a/clients/client-iam/commands/GetServiceLastAccessedDetailsWithEntitiesCommand.ts +++ b/clients/client-iam/commands/GetServiceLastAccessedDetailsWithEntitiesCommand.ts @@ -53,6 +53,20 @@ export interface GetServiceLastAccessedDetailsWithEntitiesCommandOutput * 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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { IAMClient, GetServiceLastAccessedDetailsWithEntitiesCommand } from "@aws-sdk/client-iam"; // ES Modules import + * // const { IAMClient, GetServiceLastAccessedDetailsWithEntitiesCommand } = require("@aws-sdk/client-iam"); // CommonJS import + * const client = new IAMClient(config); + * const command = new GetServiceLastAccessedDetailsWithEntitiesCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetServiceLastAccessedDetailsWithEntitiesCommandInput} for command's `input` shape. + * @see {@link GetServiceLastAccessedDetailsWithEntitiesCommandOutput} for command's `response` shape. + * @see {@link IAMClientResolvedConfig | config} for command's `input` shape. + * */ export class GetServiceLastAccessedDetailsWithEntitiesCommand extends $Command< GetServiceLastAccessedDetailsWithEntitiesCommandInput, diff --git a/clients/client-iam/commands/GetServiceLinkedRoleDeletionStatusCommand.ts b/clients/client-iam/commands/GetServiceLinkedRoleDeletionStatusCommand.ts index f5ccc37a63f1..5b3fbe5a9443 100644 --- a/clients/client-iam/commands/GetServiceLinkedRoleDeletionStatusCommand.ts +++ b/clients/client-iam/commands/GetServiceLinkedRoleDeletionStatusCommand.ts @@ -31,6 +31,20 @@ export interface GetServiceLinkedRoleDeletionStatusCommandOutput * 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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { IAMClient, GetServiceLinkedRoleDeletionStatusCommand } from "@aws-sdk/client-iam"; // ES Modules import + * // const { IAMClient, GetServiceLinkedRoleDeletionStatusCommand } = require("@aws-sdk/client-iam"); // CommonJS import + * const client = new IAMClient(config); + * const command = new GetServiceLinkedRoleDeletionStatusCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetServiceLinkedRoleDeletionStatusCommandInput} for command's `input` shape. + * @see {@link GetServiceLinkedRoleDeletionStatusCommandOutput} for command's `response` shape. + * @see {@link IAMClientResolvedConfig | config} for command's `input` shape. + * */ export class GetServiceLinkedRoleDeletionStatusCommand extends $Command< GetServiceLinkedRoleDeletionStatusCommandInput, diff --git a/clients/client-iam/commands/GetUserCommand.ts b/clients/client-iam/commands/GetUserCommand.ts index f0d1a3504ad9..a4f0d5ad4c29 100644 --- a/clients/client-iam/commands/GetUserCommand.ts +++ b/clients/client-iam/commands/GetUserCommand.ts @@ -22,6 +22,20 @@ export interface GetUserCommandOutput extends GetUserResponse, __MetadataBearer * date, path, unique ID, and ARN.

*

If you do not specify a user name, IAM determines the user name implicitly based on * the AWS access key ID used to sign the request to this operation.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { IAMClient, GetUserCommand } from "@aws-sdk/client-iam"; // ES Modules import + * // const { IAMClient, GetUserCommand } = require("@aws-sdk/client-iam"); // CommonJS import + * const client = new IAMClient(config); + * const command = new GetUserCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetUserCommandInput} for command's `input` shape. + * @see {@link GetUserCommandOutput} for command's `response` shape. + * @see {@link IAMClientResolvedConfig | config} for command's `input` shape. + * */ export class GetUserCommand extends $Command { // Start section: command_properties diff --git a/clients/client-iam/commands/GetUserPolicyCommand.ts b/clients/client-iam/commands/GetUserPolicyCommand.ts index 5e6a6cd248f1..60afebec514d 100644 --- a/clients/client-iam/commands/GetUserPolicyCommand.ts +++ b/clients/client-iam/commands/GetUserPolicyCommand.ts @@ -36,6 +36,20 @@ export interface GetUserPolicyCommandOutput extends GetUserPolicyResponse, __Met * the policy document.

*

For more information about policies, see Managed policies and inline * policies in the IAM User Guide.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { IAMClient, GetUserPolicyCommand } from "@aws-sdk/client-iam"; // ES Modules import + * // const { IAMClient, GetUserPolicyCommand } = require("@aws-sdk/client-iam"); // CommonJS import + * const client = new IAMClient(config); + * const command = new GetUserPolicyCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetUserPolicyCommandInput} for command's `input` shape. + * @see {@link GetUserPolicyCommandOutput} for command's `response` shape. + * @see {@link IAMClientResolvedConfig | config} for command's `input` shape. + * */ export class GetUserPolicyCommand extends $Command< GetUserPolicyCommandInput, diff --git a/clients/client-iam/commands/ListAccessKeysCommand.ts b/clients/client-iam/commands/ListAccessKeysCommand.ts index 01e0fec3089d..372525a875b7 100644 --- a/clients/client-iam/commands/ListAccessKeysCommand.ts +++ b/clients/client-iam/commands/ListAccessKeysCommand.ts @@ -34,6 +34,20 @@ export interface ListAccessKeysCommandOutput extends ListAccessKeysResponse, __M *

To ensure the security of your AWS account, the secret access key is accessible * only during key and user creation.

* + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { IAMClient, ListAccessKeysCommand } from "@aws-sdk/client-iam"; // ES Modules import + * // const { IAMClient, ListAccessKeysCommand } = require("@aws-sdk/client-iam"); // CommonJS import + * const client = new IAMClient(config); + * const command = new ListAccessKeysCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListAccessKeysCommandInput} for command's `input` shape. + * @see {@link ListAccessKeysCommandOutput} for command's `response` shape. + * @see {@link IAMClientResolvedConfig | config} for command's `input` shape. + * */ export class ListAccessKeysCommand extends $Command< ListAccessKeysCommandInput, diff --git a/clients/client-iam/commands/ListAccountAliasesCommand.ts b/clients/client-iam/commands/ListAccountAliasesCommand.ts index b4c5934668cb..e87270ef19b3 100644 --- a/clients/client-iam/commands/ListAccountAliasesCommand.ts +++ b/clients/client-iam/commands/ListAccountAliasesCommand.ts @@ -24,6 +24,20 @@ export interface ListAccountAliasesCommandOutput extends ListAccountAliasesRespo *

Lists the account alias associated with the AWS account (Note: you can have only * one). For information about using an AWS account alias, see Using an alias for your * AWS account ID in the IAM User Guide.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { IAMClient, ListAccountAliasesCommand } from "@aws-sdk/client-iam"; // ES Modules import + * // const { IAMClient, ListAccountAliasesCommand } = require("@aws-sdk/client-iam"); // CommonJS import + * const client = new IAMClient(config); + * const command = new ListAccountAliasesCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListAccountAliasesCommandInput} for command's `input` shape. + * @see {@link ListAccountAliasesCommandOutput} for command's `response` shape. + * @see {@link IAMClientResolvedConfig | config} for command's `input` shape. + * */ export class ListAccountAliasesCommand extends $Command< ListAccountAliasesCommandInput, diff --git a/clients/client-iam/commands/ListAttachedGroupPoliciesCommand.ts b/clients/client-iam/commands/ListAttachedGroupPoliciesCommand.ts index 1e9a6be21a79..0e31a39bd858 100644 --- a/clients/client-iam/commands/ListAttachedGroupPoliciesCommand.ts +++ b/clients/client-iam/commands/ListAttachedGroupPoliciesCommand.ts @@ -31,6 +31,20 @@ export interface ListAttachedGroupPoliciesCommandOutput extends ListAttachedGrou * 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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { IAMClient, ListAttachedGroupPoliciesCommand } from "@aws-sdk/client-iam"; // ES Modules import + * // const { IAMClient, ListAttachedGroupPoliciesCommand } = require("@aws-sdk/client-iam"); // CommonJS import + * const client = new IAMClient(config); + * const command = new ListAttachedGroupPoliciesCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListAttachedGroupPoliciesCommandInput} for command's `input` shape. + * @see {@link ListAttachedGroupPoliciesCommandOutput} for command's `response` shape. + * @see {@link IAMClientResolvedConfig | config} for command's `input` shape. + * */ export class ListAttachedGroupPoliciesCommand extends $Command< ListAttachedGroupPoliciesCommandInput, diff --git a/clients/client-iam/commands/ListAttachedRolePoliciesCommand.ts b/clients/client-iam/commands/ListAttachedRolePoliciesCommand.ts index 233fc70ea7f0..72c6eabdad45 100644 --- a/clients/client-iam/commands/ListAttachedRolePoliciesCommand.ts +++ b/clients/client-iam/commands/ListAttachedRolePoliciesCommand.ts @@ -31,6 +31,20 @@ export interface ListAttachedRolePoliciesCommandOutput extends ListAttachedRoleP * 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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { IAMClient, ListAttachedRolePoliciesCommand } from "@aws-sdk/client-iam"; // ES Modules import + * // const { IAMClient, ListAttachedRolePoliciesCommand } = require("@aws-sdk/client-iam"); // CommonJS import + * const client = new IAMClient(config); + * const command = new ListAttachedRolePoliciesCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListAttachedRolePoliciesCommandInput} for command's `input` shape. + * @see {@link ListAttachedRolePoliciesCommandOutput} for command's `response` shape. + * @see {@link IAMClientResolvedConfig | config} for command's `input` shape. + * */ export class ListAttachedRolePoliciesCommand extends $Command< ListAttachedRolePoliciesCommandInput, diff --git a/clients/client-iam/commands/ListAttachedUserPoliciesCommand.ts b/clients/client-iam/commands/ListAttachedUserPoliciesCommand.ts index c6974101b2f6..0caaf1b100ed 100644 --- a/clients/client-iam/commands/ListAttachedUserPoliciesCommand.ts +++ b/clients/client-iam/commands/ListAttachedUserPoliciesCommand.ts @@ -31,6 +31,20 @@ export interface ListAttachedUserPoliciesCommandOutput extends ListAttachedUserP * 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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { IAMClient, ListAttachedUserPoliciesCommand } from "@aws-sdk/client-iam"; // ES Modules import + * // const { IAMClient, ListAttachedUserPoliciesCommand } = require("@aws-sdk/client-iam"); // CommonJS import + * const client = new IAMClient(config); + * const command = new ListAttachedUserPoliciesCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListAttachedUserPoliciesCommandInput} for command's `input` shape. + * @see {@link ListAttachedUserPoliciesCommandOutput} for command's `response` shape. + * @see {@link IAMClientResolvedConfig | config} for command's `input` shape. + * */ export class ListAttachedUserPoliciesCommand extends $Command< ListAttachedUserPoliciesCommandInput, diff --git a/clients/client-iam/commands/ListEntitiesForPolicyCommand.ts b/clients/client-iam/commands/ListEntitiesForPolicyCommand.ts index c57ae3ac0df2..73f8b2414034 100644 --- a/clients/client-iam/commands/ListEntitiesForPolicyCommand.ts +++ b/clients/client-iam/commands/ListEntitiesForPolicyCommand.ts @@ -29,6 +29,20 @@ export interface ListEntitiesForPolicyCommandOutput extends ListEntitiesForPolic * Role.

*

You can paginate the results using the MaxItems and Marker * parameters.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { IAMClient, ListEntitiesForPolicyCommand } from "@aws-sdk/client-iam"; // ES Modules import + * // const { IAMClient, ListEntitiesForPolicyCommand } = require("@aws-sdk/client-iam"); // CommonJS import + * const client = new IAMClient(config); + * const command = new ListEntitiesForPolicyCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListEntitiesForPolicyCommandInput} for command's `input` shape. + * @see {@link ListEntitiesForPolicyCommandOutput} for command's `response` shape. + * @see {@link IAMClientResolvedConfig | config} for command's `input` shape. + * */ export class ListEntitiesForPolicyCommand extends $Command< ListEntitiesForPolicyCommandInput, diff --git a/clients/client-iam/commands/ListGroupPoliciesCommand.ts b/clients/client-iam/commands/ListGroupPoliciesCommand.ts index 62aa0bfcefef..efd768c017c6 100644 --- a/clients/client-iam/commands/ListGroupPoliciesCommand.ts +++ b/clients/client-iam/commands/ListGroupPoliciesCommand.ts @@ -30,6 +30,20 @@ export interface ListGroupPoliciesCommandOutput extends ListGroupPoliciesRespons *

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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { IAMClient, ListGroupPoliciesCommand } from "@aws-sdk/client-iam"; // ES Modules import + * // const { IAMClient, ListGroupPoliciesCommand } = require("@aws-sdk/client-iam"); // CommonJS import + * const client = new IAMClient(config); + * const command = new ListGroupPoliciesCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListGroupPoliciesCommandInput} for command's `input` shape. + * @see {@link ListGroupPoliciesCommandOutput} for command's `response` shape. + * @see {@link IAMClientResolvedConfig | config} for command's `input` shape. + * */ export class ListGroupPoliciesCommand extends $Command< ListGroupPoliciesCommandInput, diff --git a/clients/client-iam/commands/ListGroupsCommand.ts b/clients/client-iam/commands/ListGroupsCommand.ts index 53eb7277b4fe..00876fca1aa1 100644 --- a/clients/client-iam/commands/ListGroupsCommand.ts +++ b/clients/client-iam/commands/ListGroupsCommand.ts @@ -21,6 +21,20 @@ export interface ListGroupsCommandOutput extends ListGroupsResponse, __MetadataB *

Lists the IAM groups that have the specified path prefix.

*

You can paginate the results using the MaxItems and Marker * parameters.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { IAMClient, ListGroupsCommand } from "@aws-sdk/client-iam"; // ES Modules import + * // const { IAMClient, ListGroupsCommand } = require("@aws-sdk/client-iam"); // CommonJS import + * const client = new IAMClient(config); + * const command = new ListGroupsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListGroupsCommandInput} for command's `input` shape. + * @see {@link ListGroupsCommandOutput} for command's `response` shape. + * @see {@link IAMClientResolvedConfig | config} for command's `input` shape. + * */ export class ListGroupsCommand extends $Command< ListGroupsCommandInput, diff --git a/clients/client-iam/commands/ListGroupsForUserCommand.ts b/clients/client-iam/commands/ListGroupsForUserCommand.ts index 99357e35d918..8ada5812f9d1 100644 --- a/clients/client-iam/commands/ListGroupsForUserCommand.ts +++ b/clients/client-iam/commands/ListGroupsForUserCommand.ts @@ -24,6 +24,20 @@ export interface ListGroupsForUserCommandOutput extends ListGroupsForUserRespons *

Lists the IAM groups that the specified IAM user belongs to.

*

You can paginate the results using the MaxItems and Marker * parameters.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { IAMClient, ListGroupsForUserCommand } from "@aws-sdk/client-iam"; // ES Modules import + * // const { IAMClient, ListGroupsForUserCommand } = require("@aws-sdk/client-iam"); // CommonJS import + * const client = new IAMClient(config); + * const command = new ListGroupsForUserCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListGroupsForUserCommandInput} for command's `input` shape. + * @see {@link ListGroupsForUserCommandOutput} for command's `response` shape. + * @see {@link IAMClientResolvedConfig | config} for command's `input` shape. + * */ export class ListGroupsForUserCommand extends $Command< ListGroupsForUserCommandInput, diff --git a/clients/client-iam/commands/ListInstanceProfileTagsCommand.ts b/clients/client-iam/commands/ListInstanceProfileTagsCommand.ts index 3b3b2aca9cca..98da83e51463 100644 --- a/clients/client-iam/commands/ListInstanceProfileTagsCommand.ts +++ b/clients/client-iam/commands/ListInstanceProfileTagsCommand.ts @@ -24,6 +24,20 @@ export interface ListInstanceProfileTagsCommandOutput extends ListInstanceProfil *

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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { IAMClient, ListInstanceProfileTagsCommand } from "@aws-sdk/client-iam"; // ES Modules import + * // const { IAMClient, ListInstanceProfileTagsCommand } = require("@aws-sdk/client-iam"); // CommonJS import + * const client = new IAMClient(config); + * const command = new ListInstanceProfileTagsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListInstanceProfileTagsCommandInput} for command's `input` shape. + * @see {@link ListInstanceProfileTagsCommandOutput} for command's `response` shape. + * @see {@link IAMClientResolvedConfig | config} for command's `input` shape. + * */ export class ListInstanceProfileTagsCommand extends $Command< ListInstanceProfileTagsCommandInput, diff --git a/clients/client-iam/commands/ListInstanceProfilesCommand.ts b/clients/client-iam/commands/ListInstanceProfilesCommand.ts index c1e5b0027dd0..3203fbf327d3 100644 --- a/clients/client-iam/commands/ListInstanceProfilesCommand.ts +++ b/clients/client-iam/commands/ListInstanceProfilesCommand.ts @@ -31,6 +31,20 @@ export interface ListInstanceProfilesCommandOutput extends ListInstanceProfilesR * *

You can paginate the results using the MaxItems and Marker * parameters.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { IAMClient, ListInstanceProfilesCommand } from "@aws-sdk/client-iam"; // ES Modules import + * // const { IAMClient, ListInstanceProfilesCommand } = require("@aws-sdk/client-iam"); // CommonJS import + * const client = new IAMClient(config); + * const command = new ListInstanceProfilesCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListInstanceProfilesCommandInput} for command's `input` shape. + * @see {@link ListInstanceProfilesCommandOutput} for command's `response` shape. + * @see {@link IAMClientResolvedConfig | config} for command's `input` shape. + * */ export class ListInstanceProfilesCommand extends $Command< ListInstanceProfilesCommandInput, diff --git a/clients/client-iam/commands/ListInstanceProfilesForRoleCommand.ts b/clients/client-iam/commands/ListInstanceProfilesForRoleCommand.ts index 58a5e749f5e2..c687c2f3a940 100644 --- a/clients/client-iam/commands/ListInstanceProfilesForRoleCommand.ts +++ b/clients/client-iam/commands/ListInstanceProfilesForRoleCommand.ts @@ -29,6 +29,20 @@ export interface ListInstanceProfilesForRoleCommandOutput * profiles.

*

You can paginate the results using the MaxItems and Marker * parameters.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { IAMClient, ListInstanceProfilesForRoleCommand } from "@aws-sdk/client-iam"; // ES Modules import + * // const { IAMClient, ListInstanceProfilesForRoleCommand } = require("@aws-sdk/client-iam"); // CommonJS import + * const client = new IAMClient(config); + * const command = new ListInstanceProfilesForRoleCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListInstanceProfilesForRoleCommandInput} for command's `input` shape. + * @see {@link ListInstanceProfilesForRoleCommandOutput} for command's `response` shape. + * @see {@link IAMClientResolvedConfig | config} for command's `input` shape. + * */ export class ListInstanceProfilesForRoleCommand extends $Command< ListInstanceProfilesForRoleCommandInput, diff --git a/clients/client-iam/commands/ListMFADeviceTagsCommand.ts b/clients/client-iam/commands/ListMFADeviceTagsCommand.ts index 218f91c08a90..ee1f44ac6976 100644 --- a/clients/client-iam/commands/ListMFADeviceTagsCommand.ts +++ b/clients/client-iam/commands/ListMFADeviceTagsCommand.ts @@ -24,6 +24,20 @@ export interface ListMFADeviceTagsCommandOutput extends ListMFADeviceTagsRespons *

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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { IAMClient, ListMFADeviceTagsCommand } from "@aws-sdk/client-iam"; // ES Modules import + * // const { IAMClient, ListMFADeviceTagsCommand } = require("@aws-sdk/client-iam"); // CommonJS import + * const client = new IAMClient(config); + * const command = new ListMFADeviceTagsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListMFADeviceTagsCommandInput} for command's `input` shape. + * @see {@link ListMFADeviceTagsCommandOutput} for command's `response` shape. + * @see {@link IAMClientResolvedConfig | config} for command's `input` shape. + * */ export class ListMFADeviceTagsCommand extends $Command< ListMFADeviceTagsCommandInput, diff --git a/clients/client-iam/commands/ListMFADevicesCommand.ts b/clients/client-iam/commands/ListMFADevicesCommand.ts index 99a4bf30d291..ef2c58ce6e4f 100644 --- a/clients/client-iam/commands/ListMFADevicesCommand.ts +++ b/clients/client-iam/commands/ListMFADevicesCommand.ts @@ -27,6 +27,20 @@ export interface ListMFADevicesCommandOutput extends ListMFADevicesResponse, __M * access key ID signing the request for this operation.

*

You can paginate the results using the MaxItems and Marker * parameters.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { IAMClient, ListMFADevicesCommand } from "@aws-sdk/client-iam"; // ES Modules import + * // const { IAMClient, ListMFADevicesCommand } = require("@aws-sdk/client-iam"); // CommonJS import + * const client = new IAMClient(config); + * const command = new ListMFADevicesCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListMFADevicesCommandInput} for command's `input` shape. + * @see {@link ListMFADevicesCommandOutput} for command's `response` shape. + * @see {@link IAMClientResolvedConfig | config} for command's `input` shape. + * */ export class ListMFADevicesCommand extends $Command< ListMFADevicesCommandInput, diff --git a/clients/client-iam/commands/ListOpenIDConnectProviderTagsCommand.ts b/clients/client-iam/commands/ListOpenIDConnectProviderTagsCommand.ts index 9b31c2ebc404..547cdeb82efc 100644 --- a/clients/client-iam/commands/ListOpenIDConnectProviderTagsCommand.ts +++ b/clients/client-iam/commands/ListOpenIDConnectProviderTagsCommand.ts @@ -28,6 +28,20 @@ export interface ListOpenIDConnectProviderTagsCommandOutput * federation.

*

For more information about tagging, see Tagging IAM resources in the * IAM User Guide.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { IAMClient, ListOpenIDConnectProviderTagsCommand } from "@aws-sdk/client-iam"; // ES Modules import + * // const { IAMClient, ListOpenIDConnectProviderTagsCommand } = require("@aws-sdk/client-iam"); // CommonJS import + * const client = new IAMClient(config); + * const command = new ListOpenIDConnectProviderTagsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListOpenIDConnectProviderTagsCommandInput} for command's `input` shape. + * @see {@link ListOpenIDConnectProviderTagsCommandOutput} for command's `response` shape. + * @see {@link IAMClientResolvedConfig | config} for command's `input` shape. + * */ export class ListOpenIDConnectProviderTagsCommand extends $Command< ListOpenIDConnectProviderTagsCommandInput, diff --git a/clients/client-iam/commands/ListOpenIDConnectProvidersCommand.ts b/clients/client-iam/commands/ListOpenIDConnectProvidersCommand.ts index cb7a2faa06b2..54d4d230272c 100644 --- a/clients/client-iam/commands/ListOpenIDConnectProvidersCommand.ts +++ b/clients/client-iam/commands/ListOpenIDConnectProvidersCommand.ts @@ -27,6 +27,20 @@ export interface ListOpenIDConnectProvidersCommandOutput extends ListOpenIDConne *

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.

* + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { IAMClient, ListOpenIDConnectProvidersCommand } from "@aws-sdk/client-iam"; // ES Modules import + * // const { IAMClient, ListOpenIDConnectProvidersCommand } = require("@aws-sdk/client-iam"); // CommonJS import + * const client = new IAMClient(config); + * const command = new ListOpenIDConnectProvidersCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListOpenIDConnectProvidersCommandInput} for command's `input` shape. + * @see {@link ListOpenIDConnectProvidersCommandOutput} for command's `response` shape. + * @see {@link IAMClientResolvedConfig | config} for command's `input` shape. + * */ export class ListOpenIDConnectProvidersCommand extends $Command< ListOpenIDConnectProvidersCommandInput, diff --git a/clients/client-iam/commands/ListPoliciesCommand.ts b/clients/client-iam/commands/ListPoliciesCommand.ts index 63ca933bd2ca..f763ae249102 100644 --- a/clients/client-iam/commands/ListPoliciesCommand.ts +++ b/clients/client-iam/commands/ListPoliciesCommand.ts @@ -34,6 +34,20 @@ export interface ListPoliciesCommandOutput extends ListPoliciesResponse, __Metad * 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.

* + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { IAMClient, ListPoliciesCommand } from "@aws-sdk/client-iam"; // ES Modules import + * // const { IAMClient, ListPoliciesCommand } = require("@aws-sdk/client-iam"); // CommonJS import + * const client = new IAMClient(config); + * const command = new ListPoliciesCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListPoliciesCommandInput} for command's `input` shape. + * @see {@link ListPoliciesCommandOutput} for command's `response` shape. + * @see {@link IAMClientResolvedConfig | config} for command's `input` shape. + * */ export class ListPoliciesCommand extends $Command< ListPoliciesCommandInput, diff --git a/clients/client-iam/commands/ListPoliciesGrantingServiceAccessCommand.ts b/clients/client-iam/commands/ListPoliciesGrantingServiceAccessCommand.ts index 07481fceedf4..09b40f10b159 100644 --- a/clients/client-iam/commands/ListPoliciesGrantingServiceAccessCommand.ts +++ b/clients/client-iam/commands/ListPoliciesGrantingServiceAccessCommand.ts @@ -66,6 +66,20 @@ export interface ListPoliciesGrantingServiceAccessCommandOutput * 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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { IAMClient, ListPoliciesGrantingServiceAccessCommand } from "@aws-sdk/client-iam"; // ES Modules import + * // const { IAMClient, ListPoliciesGrantingServiceAccessCommand } = require("@aws-sdk/client-iam"); // CommonJS import + * const client = new IAMClient(config); + * const command = new ListPoliciesGrantingServiceAccessCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListPoliciesGrantingServiceAccessCommandInput} for command's `input` shape. + * @see {@link ListPoliciesGrantingServiceAccessCommandOutput} for command's `response` shape. + * @see {@link IAMClientResolvedConfig | config} for command's `input` shape. + * */ export class ListPoliciesGrantingServiceAccessCommand extends $Command< ListPoliciesGrantingServiceAccessCommandInput, diff --git a/clients/client-iam/commands/ListPolicyTagsCommand.ts b/clients/client-iam/commands/ListPolicyTagsCommand.ts index ee4d04e7af8c..ab22db373e49 100644 --- a/clients/client-iam/commands/ListPolicyTagsCommand.ts +++ b/clients/client-iam/commands/ListPolicyTagsCommand.ts @@ -24,6 +24,20 @@ export interface ListPolicyTagsCommandOutput extends ListPolicyTagsResponse, __M *

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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { IAMClient, ListPolicyTagsCommand } from "@aws-sdk/client-iam"; // ES Modules import + * // const { IAMClient, ListPolicyTagsCommand } = require("@aws-sdk/client-iam"); // CommonJS import + * const client = new IAMClient(config); + * const command = new ListPolicyTagsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListPolicyTagsCommandInput} for command's `input` shape. + * @see {@link ListPolicyTagsCommandOutput} for command's `response` shape. + * @see {@link IAMClientResolvedConfig | config} for command's `input` shape. + * */ export class ListPolicyTagsCommand extends $Command< ListPolicyTagsCommandInput, diff --git a/clients/client-iam/commands/ListPolicyVersionsCommand.ts b/clients/client-iam/commands/ListPolicyVersionsCommand.ts index 2fb33323557e..e74774c1ae25 100644 --- a/clients/client-iam/commands/ListPolicyVersionsCommand.ts +++ b/clients/client-iam/commands/ListPolicyVersionsCommand.ts @@ -25,6 +25,20 @@ export interface ListPolicyVersionsCommandOutput extends ListPolicyVersionsRespo * 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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { IAMClient, ListPolicyVersionsCommand } from "@aws-sdk/client-iam"; // ES Modules import + * // const { IAMClient, ListPolicyVersionsCommand } = require("@aws-sdk/client-iam"); // CommonJS import + * const client = new IAMClient(config); + * const command = new ListPolicyVersionsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListPolicyVersionsCommandInput} for command's `input` shape. + * @see {@link ListPolicyVersionsCommandOutput} for command's `response` shape. + * @see {@link IAMClientResolvedConfig | config} for command's `input` shape. + * */ export class ListPolicyVersionsCommand extends $Command< ListPolicyVersionsCommandInput, diff --git a/clients/client-iam/commands/ListRolePoliciesCommand.ts b/clients/client-iam/commands/ListRolePoliciesCommand.ts index 8a1867282d34..0b87faf873eb 100644 --- a/clients/client-iam/commands/ListRolePoliciesCommand.ts +++ b/clients/client-iam/commands/ListRolePoliciesCommand.ts @@ -30,6 +30,20 @@ export interface ListRolePoliciesCommandOutput extends ListRolePoliciesResponse, *

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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { IAMClient, ListRolePoliciesCommand } from "@aws-sdk/client-iam"; // ES Modules import + * // const { IAMClient, ListRolePoliciesCommand } = require("@aws-sdk/client-iam"); // CommonJS import + * const client = new IAMClient(config); + * const command = new ListRolePoliciesCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListRolePoliciesCommandInput} for command's `input` shape. + * @see {@link ListRolePoliciesCommandOutput} for command's `response` shape. + * @see {@link IAMClientResolvedConfig | config} for command's `input` shape. + * */ export class ListRolePoliciesCommand extends $Command< ListRolePoliciesCommandInput, diff --git a/clients/client-iam/commands/ListRoleTagsCommand.ts b/clients/client-iam/commands/ListRoleTagsCommand.ts index eec08f43cb4e..5141bc181ced 100644 --- a/clients/client-iam/commands/ListRoleTagsCommand.ts +++ b/clients/client-iam/commands/ListRoleTagsCommand.ts @@ -21,6 +21,20 @@ export interface ListRoleTagsCommandOutput extends ListRoleTagsResponse, __Metad *

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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { IAMClient, ListRoleTagsCommand } from "@aws-sdk/client-iam"; // ES Modules import + * // const { IAMClient, ListRoleTagsCommand } = require("@aws-sdk/client-iam"); // CommonJS import + * const client = new IAMClient(config); + * const command = new ListRoleTagsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListRoleTagsCommandInput} for command's `input` shape. + * @see {@link ListRoleTagsCommandOutput} for command's `response` shape. + * @see {@link IAMClientResolvedConfig | config} for command's `input` shape. + * */ export class ListRoleTagsCommand extends $Command< ListRoleTagsCommandInput, diff --git a/clients/client-iam/commands/ListRolesCommand.ts b/clients/client-iam/commands/ListRolesCommand.ts index 18dcccf23c6e..c4d7b206d2ec 100644 --- a/clients/client-iam/commands/ListRolesCommand.ts +++ b/clients/client-iam/commands/ListRolesCommand.ts @@ -27,6 +27,20 @@ export interface ListRolesCommandOutput extends ListRolesResponse, __MetadataBea * *

You can paginate the results using the MaxItems and Marker * parameters.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { IAMClient, ListRolesCommand } from "@aws-sdk/client-iam"; // ES Modules import + * // const { IAMClient, ListRolesCommand } = require("@aws-sdk/client-iam"); // CommonJS import + * const client = new IAMClient(config); + * const command = new ListRolesCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListRolesCommandInput} for command's `input` shape. + * @see {@link ListRolesCommandOutput} for command's `response` shape. + * @see {@link IAMClientResolvedConfig | config} for command's `input` shape. + * */ export class ListRolesCommand extends $Command { // Start section: command_properties diff --git a/clients/client-iam/commands/ListSAMLProviderTagsCommand.ts b/clients/client-iam/commands/ListSAMLProviderTagsCommand.ts index 19aac0915210..7df072fbcb9b 100644 --- a/clients/client-iam/commands/ListSAMLProviderTagsCommand.ts +++ b/clients/client-iam/commands/ListSAMLProviderTagsCommand.ts @@ -26,6 +26,20 @@ export interface ListSAMLProviderTagsCommandOutput extends ListSAMLProviderTagsR * federation.

*

For more information about tagging, see Tagging IAM resources in the * IAM User Guide.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { IAMClient, ListSAMLProviderTagsCommand } from "@aws-sdk/client-iam"; // ES Modules import + * // const { IAMClient, ListSAMLProviderTagsCommand } = require("@aws-sdk/client-iam"); // CommonJS import + * const client = new IAMClient(config); + * const command = new ListSAMLProviderTagsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListSAMLProviderTagsCommandInput} for command's `input` shape. + * @see {@link ListSAMLProviderTagsCommandOutput} for command's `response` shape. + * @see {@link IAMClientResolvedConfig | config} for command's `input` shape. + * */ export class ListSAMLProviderTagsCommand extends $Command< ListSAMLProviderTagsCommandInput, diff --git a/clients/client-iam/commands/ListSAMLProvidersCommand.ts b/clients/client-iam/commands/ListSAMLProvidersCommand.ts index 6503e006f28f..b9c9c40b57bb 100644 --- a/clients/client-iam/commands/ListSAMLProvidersCommand.ts +++ b/clients/client-iam/commands/ListSAMLProvidersCommand.ts @@ -27,6 +27,20 @@ export interface ListSAMLProvidersCommandOutput extends ListSAMLProvidersRespons * *

This operation requires Signature Version 4.

* + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { IAMClient, ListSAMLProvidersCommand } from "@aws-sdk/client-iam"; // ES Modules import + * // const { IAMClient, ListSAMLProvidersCommand } = require("@aws-sdk/client-iam"); // CommonJS import + * const client = new IAMClient(config); + * const command = new ListSAMLProvidersCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListSAMLProvidersCommandInput} for command's `input` shape. + * @see {@link ListSAMLProvidersCommandOutput} for command's `response` shape. + * @see {@link IAMClientResolvedConfig | config} for command's `input` shape. + * */ export class ListSAMLProvidersCommand extends $Command< ListSAMLProvidersCommandInput, diff --git a/clients/client-iam/commands/ListSSHPublicKeysCommand.ts b/clients/client-iam/commands/ListSSHPublicKeysCommand.ts index 5809d0c8dde2..44a842bc17aa 100644 --- a/clients/client-iam/commands/ListSSHPublicKeysCommand.ts +++ b/clients/client-iam/commands/ListSSHPublicKeysCommand.ts @@ -29,6 +29,20 @@ export interface ListSSHPublicKeysCommandOutput extends ListSSHPublicKeysRespons * SSH connections in the AWS 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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { IAMClient, ListSSHPublicKeysCommand } from "@aws-sdk/client-iam"; // ES Modules import + * // const { IAMClient, ListSSHPublicKeysCommand } = require("@aws-sdk/client-iam"); // CommonJS import + * const client = new IAMClient(config); + * const command = new ListSSHPublicKeysCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListSSHPublicKeysCommandInput} for command's `input` shape. + * @see {@link ListSSHPublicKeysCommandOutput} for command's `response` shape. + * @see {@link IAMClientResolvedConfig | config} for command's `input` shape. + * */ export class ListSSHPublicKeysCommand extends $Command< ListSSHPublicKeysCommandInput, diff --git a/clients/client-iam/commands/ListServerCertificateTagsCommand.ts b/clients/client-iam/commands/ListServerCertificateTagsCommand.ts index 8bf76446b95c..11c73f635442 100644 --- a/clients/client-iam/commands/ListServerCertificateTagsCommand.ts +++ b/clients/client-iam/commands/ListServerCertificateTagsCommand.ts @@ -31,6 +31,20 @@ export interface ListServerCertificateTagsCommandOutput extends ListServerCertif * certificates, Working with server * certificates in the IAM User Guide.

* + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { IAMClient, ListServerCertificateTagsCommand } from "@aws-sdk/client-iam"; // ES Modules import + * // const { IAMClient, ListServerCertificateTagsCommand } = require("@aws-sdk/client-iam"); // CommonJS import + * const client = new IAMClient(config); + * const command = new ListServerCertificateTagsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListServerCertificateTagsCommandInput} for command's `input` shape. + * @see {@link ListServerCertificateTagsCommandOutput} for command's `response` shape. + * @see {@link IAMClientResolvedConfig | config} for command's `input` shape. + * */ export class ListServerCertificateTagsCommand extends $Command< ListServerCertificateTagsCommandInput, diff --git a/clients/client-iam/commands/ListServerCertificatesCommand.ts b/clients/client-iam/commands/ListServerCertificatesCommand.ts index 60da53ef6106..08fbe2db7d9c 100644 --- a/clients/client-iam/commands/ListServerCertificatesCommand.ts +++ b/clients/client-iam/commands/ListServerCertificatesCommand.ts @@ -33,6 +33,20 @@ export interface ListServerCertificatesCommandOutput extends ListServerCertifica *

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.

* + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { IAMClient, ListServerCertificatesCommand } from "@aws-sdk/client-iam"; // ES Modules import + * // const { IAMClient, ListServerCertificatesCommand } = require("@aws-sdk/client-iam"); // CommonJS import + * const client = new IAMClient(config); + * const command = new ListServerCertificatesCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListServerCertificatesCommandInput} for command's `input` shape. + * @see {@link ListServerCertificatesCommandOutput} for command's `response` shape. + * @see {@link IAMClientResolvedConfig | config} for command's `input` shape. + * */ export class ListServerCertificatesCommand extends $Command< ListServerCertificatesCommandInput, diff --git a/clients/client-iam/commands/ListServiceSpecificCredentialsCommand.ts b/clients/client-iam/commands/ListServiceSpecificCredentialsCommand.ts index 8beb602db20a..b55f32a79875 100644 --- a/clients/client-iam/commands/ListServiceSpecificCredentialsCommand.ts +++ b/clients/client-iam/commands/ListServiceSpecificCredentialsCommand.ts @@ -29,6 +29,20 @@ export interface ListServiceSpecificCredentialsCommandOutput * the IAM user to a specific service. For more information about using service-specific * credentials to authenticate to an AWS service, see Set up service-specific credentials * in the AWS CodeCommit User Guide.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { IAMClient, ListServiceSpecificCredentialsCommand } from "@aws-sdk/client-iam"; // ES Modules import + * // const { IAMClient, ListServiceSpecificCredentialsCommand } = require("@aws-sdk/client-iam"); // CommonJS import + * const client = new IAMClient(config); + * const command = new ListServiceSpecificCredentialsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListServiceSpecificCredentialsCommandInput} for command's `input` shape. + * @see {@link ListServiceSpecificCredentialsCommandOutput} for command's `response` shape. + * @see {@link IAMClientResolvedConfig | config} for command's `input` shape. + * */ export class ListServiceSpecificCredentialsCommand extends $Command< ListServiceSpecificCredentialsCommandInput, diff --git a/clients/client-iam/commands/ListSigningCertificatesCommand.ts b/clients/client-iam/commands/ListSigningCertificatesCommand.ts index 88beb4e43500..ea67b2ba9d4c 100644 --- a/clients/client-iam/commands/ListSigningCertificatesCommand.ts +++ b/clients/client-iam/commands/ListSigningCertificatesCommand.ts @@ -31,6 +31,20 @@ export interface ListSigningCertificatesCommandOutput extends ListSigningCertifi * This operation works for access keys under the AWS account. Consequently, you can use * this operation to manage AWS account root user credentials even if the AWS account * has no associated users.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { IAMClient, ListSigningCertificatesCommand } from "@aws-sdk/client-iam"; // ES Modules import + * // const { IAMClient, ListSigningCertificatesCommand } = require("@aws-sdk/client-iam"); // CommonJS import + * const client = new IAMClient(config); + * const command = new ListSigningCertificatesCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListSigningCertificatesCommandInput} for command's `input` shape. + * @see {@link ListSigningCertificatesCommandOutput} for command's `response` shape. + * @see {@link IAMClientResolvedConfig | config} for command's `input` shape. + * */ export class ListSigningCertificatesCommand extends $Command< ListSigningCertificatesCommandInput, diff --git a/clients/client-iam/commands/ListUserPoliciesCommand.ts b/clients/client-iam/commands/ListUserPoliciesCommand.ts index a265be3be8de..c499df87ede3 100644 --- a/clients/client-iam/commands/ListUserPoliciesCommand.ts +++ b/clients/client-iam/commands/ListUserPoliciesCommand.ts @@ -29,6 +29,20 @@ export interface ListUserPoliciesCommandOutput extends ListUserPoliciesResponse, *

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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { IAMClient, ListUserPoliciesCommand } from "@aws-sdk/client-iam"; // ES Modules import + * // const { IAMClient, ListUserPoliciesCommand } = require("@aws-sdk/client-iam"); // CommonJS import + * const client = new IAMClient(config); + * const command = new ListUserPoliciesCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListUserPoliciesCommandInput} for command's `input` shape. + * @see {@link ListUserPoliciesCommandOutput} for command's `response` shape. + * @see {@link IAMClientResolvedConfig | config} for command's `input` shape. + * */ export class ListUserPoliciesCommand extends $Command< ListUserPoliciesCommandInput, diff --git a/clients/client-iam/commands/ListUserTagsCommand.ts b/clients/client-iam/commands/ListUserTagsCommand.ts index f0e295263ada..4c0f7ce21bc6 100644 --- a/clients/client-iam/commands/ListUserTagsCommand.ts +++ b/clients/client-iam/commands/ListUserTagsCommand.ts @@ -20,6 +20,20 @@ export interface ListUserTagsCommandOutput extends ListUserTagsResponse, __Metad /** *

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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { IAMClient, ListUserTagsCommand } from "@aws-sdk/client-iam"; // ES Modules import + * // const { IAMClient, ListUserTagsCommand } = require("@aws-sdk/client-iam"); // CommonJS import + * const client = new IAMClient(config); + * const command = new ListUserTagsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListUserTagsCommandInput} for command's `input` shape. + * @see {@link ListUserTagsCommandOutput} for command's `response` shape. + * @see {@link IAMClientResolvedConfig | config} for command's `input` shape. + * */ export class ListUserTagsCommand extends $Command< ListUserTagsCommandInput, diff --git a/clients/client-iam/commands/ListUsersCommand.ts b/clients/client-iam/commands/ListUsersCommand.ts index 3a3197fb715f..c9afaef77fe9 100644 --- a/clients/client-iam/commands/ListUsersCommand.ts +++ b/clients/client-iam/commands/ListUsersCommand.ts @@ -27,6 +27,20 @@ export interface ListUsersCommandOutput extends ListUsersResponse, __MetadataBea * *

You can paginate the results using the MaxItems and Marker * parameters.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { IAMClient, ListUsersCommand } from "@aws-sdk/client-iam"; // ES Modules import + * // const { IAMClient, ListUsersCommand } = require("@aws-sdk/client-iam"); // CommonJS import + * const client = new IAMClient(config); + * const command = new ListUsersCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListUsersCommandInput} for command's `input` shape. + * @see {@link ListUsersCommandOutput} for command's `response` shape. + * @see {@link IAMClientResolvedConfig | config} for command's `input` shape. + * */ export class ListUsersCommand extends $Command { // Start section: command_properties diff --git a/clients/client-iam/commands/ListVirtualMFADevicesCommand.ts b/clients/client-iam/commands/ListVirtualMFADevicesCommand.ts index fc1e517d60e9..a8794b135e25 100644 --- a/clients/client-iam/commands/ListVirtualMFADevicesCommand.ts +++ b/clients/client-iam/commands/ListVirtualMFADevicesCommand.ts @@ -32,6 +32,20 @@ export interface ListVirtualMFADevicesCommandOutput extends ListVirtualMFADevice * *

You can paginate the results using the MaxItems and Marker * parameters.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { IAMClient, ListVirtualMFADevicesCommand } from "@aws-sdk/client-iam"; // ES Modules import + * // const { IAMClient, ListVirtualMFADevicesCommand } = require("@aws-sdk/client-iam"); // CommonJS import + * const client = new IAMClient(config); + * const command = new ListVirtualMFADevicesCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListVirtualMFADevicesCommandInput} for command's `input` shape. + * @see {@link ListVirtualMFADevicesCommandOutput} for command's `response` shape. + * @see {@link IAMClientResolvedConfig | config} for command's `input` shape. + * */ export class ListVirtualMFADevicesCommand extends $Command< ListVirtualMFADevicesCommandInput, diff --git a/clients/client-iam/commands/PutGroupPolicyCommand.ts b/clients/client-iam/commands/PutGroupPolicyCommand.ts index a8ec279b62d4..3b07eb479e89 100644 --- a/clients/client-iam/commands/PutGroupPolicyCommand.ts +++ b/clients/client-iam/commands/PutGroupPolicyCommand.ts @@ -36,6 +36,20 @@ export interface PutGroupPolicyCommandOutput extends __MetadataBearer {} * API with IAM, see Making query requests in the * IAM User Guide.

* + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { IAMClient, PutGroupPolicyCommand } from "@aws-sdk/client-iam"; // ES Modules import + * // const { IAMClient, PutGroupPolicyCommand } = require("@aws-sdk/client-iam"); // CommonJS import + * const client = new IAMClient(config); + * const command = new PutGroupPolicyCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link PutGroupPolicyCommandInput} for command's `input` shape. + * @see {@link PutGroupPolicyCommandOutput} for command's `response` shape. + * @see {@link IAMClientResolvedConfig | config} for command's `input` shape. + * */ export class PutGroupPolicyCommand extends $Command< PutGroupPolicyCommandInput, diff --git a/clients/client-iam/commands/PutRolePermissionsBoundaryCommand.ts b/clients/client-iam/commands/PutRolePermissionsBoundaryCommand.ts index abbf49d0c96a..05530ca7a0b9 100644 --- a/clients/client-iam/commands/PutRolePermissionsBoundaryCommand.ts +++ b/clients/client-iam/commands/PutRolePermissionsBoundaryCommand.ts @@ -33,6 +33,20 @@ export interface PutRolePermissionsBoundaryCommandOutput extends __MetadataBeare * a role are evaluated, see IAM JSON policy * evaluation logic in the IAM User Guide.

* + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { IAMClient, PutRolePermissionsBoundaryCommand } from "@aws-sdk/client-iam"; // ES Modules import + * // const { IAMClient, PutRolePermissionsBoundaryCommand } = require("@aws-sdk/client-iam"); // CommonJS import + * const client = new IAMClient(config); + * const command = new PutRolePermissionsBoundaryCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link PutRolePermissionsBoundaryCommandInput} for command's `input` shape. + * @see {@link PutRolePermissionsBoundaryCommandOutput} for command's `response` shape. + * @see {@link IAMClientResolvedConfig | config} for command's `input` shape. + * */ export class PutRolePermissionsBoundaryCommand extends $Command< PutRolePermissionsBoundaryCommandInput, diff --git a/clients/client-iam/commands/PutRolePolicyCommand.ts b/clients/client-iam/commands/PutRolePolicyCommand.ts index c2d9a9e28676..662b14801e96 100644 --- a/clients/client-iam/commands/PutRolePolicyCommand.ts +++ b/clients/client-iam/commands/PutRolePolicyCommand.ts @@ -41,6 +41,20 @@ export interface PutRolePolicyCommandOutput extends __MetadataBearer {} * API with IAM, see Making query requests in the * IAM User Guide.

* + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { IAMClient, PutRolePolicyCommand } from "@aws-sdk/client-iam"; // ES Modules import + * // const { IAMClient, PutRolePolicyCommand } = require("@aws-sdk/client-iam"); // CommonJS import + * const client = new IAMClient(config); + * const command = new PutRolePolicyCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link PutRolePolicyCommandInput} for command's `input` shape. + * @see {@link PutRolePolicyCommandOutput} for command's `response` shape. + * @see {@link IAMClientResolvedConfig | config} for command's `input` shape. + * */ export class PutRolePolicyCommand extends $Command< PutRolePolicyCommandInput, diff --git a/clients/client-iam/commands/PutUserPermissionsBoundaryCommand.ts b/clients/client-iam/commands/PutUserPermissionsBoundaryCommand.ts index cf6894cb005e..ea08d7a18f7b 100644 --- a/clients/client-iam/commands/PutUserPermissionsBoundaryCommand.ts +++ b/clients/client-iam/commands/PutUserPermissionsBoundaryCommand.ts @@ -32,6 +32,20 @@ export interface PutUserPermissionsBoundaryCommandOutput extends __MetadataBeare * permissions for a user are evaluated, see IAM JSON policy * evaluation logic in the IAM User Guide.

* + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { IAMClient, PutUserPermissionsBoundaryCommand } from "@aws-sdk/client-iam"; // ES Modules import + * // const { IAMClient, PutUserPermissionsBoundaryCommand } = require("@aws-sdk/client-iam"); // CommonJS import + * const client = new IAMClient(config); + * const command = new PutUserPermissionsBoundaryCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link PutUserPermissionsBoundaryCommandInput} for command's `input` shape. + * @see {@link PutUserPermissionsBoundaryCommandOutput} for command's `response` shape. + * @see {@link IAMClientResolvedConfig | config} for command's `input` shape. + * */ export class PutUserPermissionsBoundaryCommand extends $Command< PutUserPermissionsBoundaryCommandInput, diff --git a/clients/client-iam/commands/PutUserPolicyCommand.ts b/clients/client-iam/commands/PutUserPolicyCommand.ts index c731d92dc1cf..0a94649d6c02 100644 --- a/clients/client-iam/commands/PutUserPolicyCommand.ts +++ b/clients/client-iam/commands/PutUserPolicyCommand.ts @@ -36,6 +36,20 @@ export interface PutUserPolicyCommandOutput extends __MetadataBearer {} * API with IAM, see Making query requests in the * IAM User Guide.

* + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { IAMClient, PutUserPolicyCommand } from "@aws-sdk/client-iam"; // ES Modules import + * // const { IAMClient, PutUserPolicyCommand } = require("@aws-sdk/client-iam"); // CommonJS import + * const client = new IAMClient(config); + * const command = new PutUserPolicyCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link PutUserPolicyCommandInput} for command's `input` shape. + * @see {@link PutUserPolicyCommandOutput} for command's `response` shape. + * @see {@link IAMClientResolvedConfig | config} for command's `input` shape. + * */ export class PutUserPolicyCommand extends $Command< PutUserPolicyCommandInput, diff --git a/clients/client-iam/commands/RemoveClientIDFromOpenIDConnectProviderCommand.ts b/clients/client-iam/commands/RemoveClientIDFromOpenIDConnectProviderCommand.ts index 1c9c609234b1..66c4eb03e25c 100644 --- a/clients/client-iam/commands/RemoveClientIDFromOpenIDConnectProviderCommand.ts +++ b/clients/client-iam/commands/RemoveClientIDFromOpenIDConnectProviderCommand.ts @@ -27,6 +27,20 @@ export interface RemoveClientIDFromOpenIDConnectProviderCommandOutput extends __ * 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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { IAMClient, RemoveClientIDFromOpenIDConnectProviderCommand } from "@aws-sdk/client-iam"; // ES Modules import + * // const { IAMClient, RemoveClientIDFromOpenIDConnectProviderCommand } = require("@aws-sdk/client-iam"); // CommonJS import + * const client = new IAMClient(config); + * const command = new RemoveClientIDFromOpenIDConnectProviderCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link RemoveClientIDFromOpenIDConnectProviderCommandInput} for command's `input` shape. + * @see {@link RemoveClientIDFromOpenIDConnectProviderCommandOutput} for command's `response` shape. + * @see {@link IAMClientResolvedConfig | config} for command's `input` shape. + * */ export class RemoveClientIDFromOpenIDConnectProviderCommand extends $Command< RemoveClientIDFromOpenIDConnectProviderCommandInput, diff --git a/clients/client-iam/commands/RemoveRoleFromInstanceProfileCommand.ts b/clients/client-iam/commands/RemoveRoleFromInstanceProfileCommand.ts index 6022134fcf3b..ec3dcd562f0a 100644 --- a/clients/client-iam/commands/RemoveRoleFromInstanceProfileCommand.ts +++ b/clients/client-iam/commands/RemoveRoleFromInstanceProfileCommand.ts @@ -31,6 +31,20 @@ export interface RemoveRoleFromInstanceProfileCommandOutput extends __MetadataBe *

For more information about IAM roles, see Working with roles. For more * information about instance profiles, see About instance * profiles.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { IAMClient, RemoveRoleFromInstanceProfileCommand } from "@aws-sdk/client-iam"; // ES Modules import + * // const { IAMClient, RemoveRoleFromInstanceProfileCommand } = require("@aws-sdk/client-iam"); // CommonJS import + * const client = new IAMClient(config); + * const command = new RemoveRoleFromInstanceProfileCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link RemoveRoleFromInstanceProfileCommandInput} for command's `input` shape. + * @see {@link RemoveRoleFromInstanceProfileCommandOutput} for command's `response` shape. + * @see {@link IAMClientResolvedConfig | config} for command's `input` shape. + * */ export class RemoveRoleFromInstanceProfileCommand extends $Command< RemoveRoleFromInstanceProfileCommandInput, diff --git a/clients/client-iam/commands/RemoveUserFromGroupCommand.ts b/clients/client-iam/commands/RemoveUserFromGroupCommand.ts index 473103972cf6..a31c26575cea 100644 --- a/clients/client-iam/commands/RemoveUserFromGroupCommand.ts +++ b/clients/client-iam/commands/RemoveUserFromGroupCommand.ts @@ -22,6 +22,20 @@ export interface RemoveUserFromGroupCommandOutput extends __MetadataBearer {} /** *

Removes the specified user from the specified group.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { IAMClient, RemoveUserFromGroupCommand } from "@aws-sdk/client-iam"; // ES Modules import + * // const { IAMClient, RemoveUserFromGroupCommand } = require("@aws-sdk/client-iam"); // CommonJS import + * const client = new IAMClient(config); + * const command = new RemoveUserFromGroupCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link RemoveUserFromGroupCommandInput} for command's `input` shape. + * @see {@link RemoveUserFromGroupCommandOutput} for command's `response` shape. + * @see {@link IAMClientResolvedConfig | config} for command's `input` shape. + * */ export class RemoveUserFromGroupCommand extends $Command< RemoveUserFromGroupCommandInput, diff --git a/clients/client-iam/commands/ResetServiceSpecificCredentialCommand.ts b/clients/client-iam/commands/ResetServiceSpecificCredentialCommand.ts index 743b9747bfac..81f409de7ac6 100644 --- a/clients/client-iam/commands/ResetServiceSpecificCredentialCommand.ts +++ b/clients/client-iam/commands/ResetServiceSpecificCredentialCommand.ts @@ -27,6 +27,20 @@ export interface ResetServiceSpecificCredentialCommandOutput * generated and cryptographically strong. It cannot be configured by the user. Resetting * the password immediately invalidates the previous password associated with this * user.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { IAMClient, ResetServiceSpecificCredentialCommand } from "@aws-sdk/client-iam"; // ES Modules import + * // const { IAMClient, ResetServiceSpecificCredentialCommand } = require("@aws-sdk/client-iam"); // CommonJS import + * const client = new IAMClient(config); + * const command = new ResetServiceSpecificCredentialCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ResetServiceSpecificCredentialCommandInput} for command's `input` shape. + * @see {@link ResetServiceSpecificCredentialCommandOutput} for command's `response` shape. + * @see {@link IAMClientResolvedConfig | config} for command's `input` shape. + * */ export class ResetServiceSpecificCredentialCommand extends $Command< ResetServiceSpecificCredentialCommandInput, diff --git a/clients/client-iam/commands/ResyncMFADeviceCommand.ts b/clients/client-iam/commands/ResyncMFADeviceCommand.ts index 4b53ec4c11e9..1e1da712082f 100644 --- a/clients/client-iam/commands/ResyncMFADeviceCommand.ts +++ b/clients/client-iam/commands/ResyncMFADeviceCommand.ts @@ -25,6 +25,20 @@ export interface ResyncMFADeviceCommandOutput extends __MetadataBearer {} * servers.

*

For more information about creating and working with virtual MFA devices, see Using a virtual MFA * device in the IAM User Guide.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { IAMClient, ResyncMFADeviceCommand } from "@aws-sdk/client-iam"; // ES Modules import + * // const { IAMClient, ResyncMFADeviceCommand } = require("@aws-sdk/client-iam"); // CommonJS import + * const client = new IAMClient(config); + * const command = new ResyncMFADeviceCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ResyncMFADeviceCommandInput} for command's `input` shape. + * @see {@link ResyncMFADeviceCommandOutput} for command's `response` shape. + * @see {@link IAMClientResolvedConfig | config} for command's `input` shape. + * */ export class ResyncMFADeviceCommand extends $Command< ResyncMFADeviceCommandInput, diff --git a/clients/client-iam/commands/SetDefaultPolicyVersionCommand.ts b/clients/client-iam/commands/SetDefaultPolicyVersionCommand.ts index 0cefa9e8e882..84a72e5891ee 100644 --- a/clients/client-iam/commands/SetDefaultPolicyVersionCommand.ts +++ b/clients/client-iam/commands/SetDefaultPolicyVersionCommand.ts @@ -27,6 +27,20 @@ export interface SetDefaultPolicyVersionCommandOutput extends __MetadataBearer { * 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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { IAMClient, SetDefaultPolicyVersionCommand } from "@aws-sdk/client-iam"; // ES Modules import + * // const { IAMClient, SetDefaultPolicyVersionCommand } = require("@aws-sdk/client-iam"); // CommonJS import + * const client = new IAMClient(config); + * const command = new SetDefaultPolicyVersionCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link SetDefaultPolicyVersionCommandInput} for command's `input` shape. + * @see {@link SetDefaultPolicyVersionCommandOutput} for command's `response` shape. + * @see {@link IAMClientResolvedConfig | config} for command's `input` shape. + * */ export class SetDefaultPolicyVersionCommand extends $Command< SetDefaultPolicyVersionCommandInput, diff --git a/clients/client-iam/commands/SetSecurityTokenServicePreferencesCommand.ts b/clients/client-iam/commands/SetSecurityTokenServicePreferencesCommand.ts index 215e66f016f4..b4cb4cdb5a21 100644 --- a/clients/client-iam/commands/SetSecurityTokenServicePreferencesCommand.ts +++ b/clients/client-iam/commands/SetSecurityTokenServicePreferencesCommand.ts @@ -41,6 +41,20 @@ export interface SetSecurityTokenServicePreferencesCommandOutput extends __Metad * IAM User Guide.

*

To view the current session token version, see the * GlobalEndpointTokenVersion entry in the response of the GetAccountSummary operation.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { IAMClient, SetSecurityTokenServicePreferencesCommand } from "@aws-sdk/client-iam"; // ES Modules import + * // const { IAMClient, SetSecurityTokenServicePreferencesCommand } = require("@aws-sdk/client-iam"); // CommonJS import + * const client = new IAMClient(config); + * const command = new SetSecurityTokenServicePreferencesCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link SetSecurityTokenServicePreferencesCommandInput} for command's `input` shape. + * @see {@link SetSecurityTokenServicePreferencesCommandOutput} for command's `response` shape. + * @see {@link IAMClientResolvedConfig | config} for command's `input` shape. + * */ export class SetSecurityTokenServicePreferencesCommand extends $Command< SetSecurityTokenServicePreferencesCommandInput, diff --git a/clients/client-iam/commands/SimulateCustomPolicyCommand.ts b/clients/client-iam/commands/SimulateCustomPolicyCommand.ts index f2cfa26c4099..704248200cac 100644 --- a/clients/client-iam/commands/SimulateCustomPolicyCommand.ts +++ b/clients/client-iam/commands/SimulateCustomPolicyCommand.ts @@ -38,6 +38,20 @@ export interface SimulateCustomPolicyCommandOutput extends SimulatePolicyRespons *

For more information about using the policy simulator, see Testing IAM policies * with the IAM policy simulator in the * IAM User Guide.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { IAMClient, SimulateCustomPolicyCommand } from "@aws-sdk/client-iam"; // ES Modules import + * // const { IAMClient, SimulateCustomPolicyCommand } = require("@aws-sdk/client-iam"); // CommonJS import + * const client = new IAMClient(config); + * const command = new SimulateCustomPolicyCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link SimulateCustomPolicyCommandInput} for command's `input` shape. + * @see {@link SimulateCustomPolicyCommandOutput} for command's `response` shape. + * @see {@link IAMClientResolvedConfig | config} for command's `input` shape. + * */ export class SimulateCustomPolicyCommand extends $Command< SimulateCustomPolicyCommandInput, diff --git a/clients/client-iam/commands/SimulatePrincipalPolicyCommand.ts b/clients/client-iam/commands/SimulatePrincipalPolicyCommand.ts index a0f4f85d90bb..cfac3d1846a3 100644 --- a/clients/client-iam/commands/SimulatePrincipalPolicyCommand.ts +++ b/clients/client-iam/commands/SimulatePrincipalPolicyCommand.ts @@ -47,6 +47,20 @@ export interface SimulatePrincipalPolicyCommandOutput extends SimulatePolicyResp *

For more information about using the policy simulator, see Testing IAM policies * with the IAM policy simulator in the * IAM User Guide.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { IAMClient, SimulatePrincipalPolicyCommand } from "@aws-sdk/client-iam"; // ES Modules import + * // const { IAMClient, SimulatePrincipalPolicyCommand } = require("@aws-sdk/client-iam"); // CommonJS import + * const client = new IAMClient(config); + * const command = new SimulatePrincipalPolicyCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link SimulatePrincipalPolicyCommandInput} for command's `input` shape. + * @see {@link SimulatePrincipalPolicyCommandOutput} for command's `response` shape. + * @see {@link IAMClientResolvedConfig | config} for command's `input` shape. + * */ export class SimulatePrincipalPolicyCommand extends $Command< SimulatePrincipalPolicyCommandInput, diff --git a/clients/client-iam/commands/TagInstanceProfileCommand.ts b/clients/client-iam/commands/TagInstanceProfileCommand.ts index e0ef7f2023b6..4396d0c6bb6b 100644 --- a/clients/client-iam/commands/TagInstanceProfileCommand.ts +++ b/clients/client-iam/commands/TagInstanceProfileCommand.ts @@ -57,6 +57,20 @@ export interface TagInstanceProfileCommandOutput extends __MetadataBearer {} * * * + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { IAMClient, TagInstanceProfileCommand } from "@aws-sdk/client-iam"; // ES Modules import + * // const { IAMClient, TagInstanceProfileCommand } = require("@aws-sdk/client-iam"); // CommonJS import + * const client = new IAMClient(config); + * const command = new TagInstanceProfileCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link TagInstanceProfileCommandInput} for command's `input` shape. + * @see {@link TagInstanceProfileCommandOutput} for command's `response` shape. + * @see {@link IAMClientResolvedConfig | config} for command's `input` shape. + * */ export class TagInstanceProfileCommand extends $Command< TagInstanceProfileCommandInput, diff --git a/clients/client-iam/commands/TagMFADeviceCommand.ts b/clients/client-iam/commands/TagMFADeviceCommand.ts index 2386167fb1ac..b6bc592a6296 100644 --- a/clients/client-iam/commands/TagMFADeviceCommand.ts +++ b/clients/client-iam/commands/TagMFADeviceCommand.ts @@ -55,6 +55,20 @@ export interface TagMFADeviceCommandOutput extends __MetadataBearer {} * * * + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { IAMClient, TagMFADeviceCommand } from "@aws-sdk/client-iam"; // ES Modules import + * // const { IAMClient, TagMFADeviceCommand } = require("@aws-sdk/client-iam"); // CommonJS import + * const client = new IAMClient(config); + * const command = new TagMFADeviceCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link TagMFADeviceCommandInput} for command's `input` shape. + * @see {@link TagMFADeviceCommandOutput} for command's `response` shape. + * @see {@link IAMClientResolvedConfig | config} for command's `input` shape. + * */ export class TagMFADeviceCommand extends $Command< TagMFADeviceCommandInput, diff --git a/clients/client-iam/commands/TagOpenIDConnectProviderCommand.ts b/clients/client-iam/commands/TagOpenIDConnectProviderCommand.ts index a91f69b63fae..633343307d24 100644 --- a/clients/client-iam/commands/TagOpenIDConnectProviderCommand.ts +++ b/clients/client-iam/commands/TagOpenIDConnectProviderCommand.ts @@ -59,6 +59,20 @@ export interface TagOpenIDConnectProviderCommandOutput extends __MetadataBearer * * * + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { IAMClient, TagOpenIDConnectProviderCommand } from "@aws-sdk/client-iam"; // ES Modules import + * // const { IAMClient, TagOpenIDConnectProviderCommand } = require("@aws-sdk/client-iam"); // CommonJS import + * const client = new IAMClient(config); + * const command = new TagOpenIDConnectProviderCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link TagOpenIDConnectProviderCommandInput} for command's `input` shape. + * @see {@link TagOpenIDConnectProviderCommandOutput} for command's `response` shape. + * @see {@link IAMClientResolvedConfig | config} for command's `input` shape. + * */ export class TagOpenIDConnectProviderCommand extends $Command< TagOpenIDConnectProviderCommandInput, diff --git a/clients/client-iam/commands/TagPolicyCommand.ts b/clients/client-iam/commands/TagPolicyCommand.ts index 47edd62ccaf8..640ebbed1ff2 100644 --- a/clients/client-iam/commands/TagPolicyCommand.ts +++ b/clients/client-iam/commands/TagPolicyCommand.ts @@ -54,6 +54,20 @@ export interface TagPolicyCommandOutput extends __MetadataBearer {} * * * + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { IAMClient, TagPolicyCommand } from "@aws-sdk/client-iam"; // ES Modules import + * // const { IAMClient, TagPolicyCommand } = require("@aws-sdk/client-iam"); // CommonJS import + * const client = new IAMClient(config); + * const command = new TagPolicyCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link TagPolicyCommandInput} for command's `input` shape. + * @see {@link TagPolicyCommandOutput} for command's `response` shape. + * @see {@link IAMClientResolvedConfig | config} for command's `input` shape. + * */ export class TagPolicyCommand extends $Command { // Start section: command_properties diff --git a/clients/client-iam/commands/TagRoleCommand.ts b/clients/client-iam/commands/TagRoleCommand.ts index 5aa0468dae8f..25b512a8f4eb 100644 --- a/clients/client-iam/commands/TagRoleCommand.ts +++ b/clients/client-iam/commands/TagRoleCommand.ts @@ -63,6 +63,20 @@ export interface TagRoleCommandOutput extends __MetadataBearer {} * *

For more information about tagging, see Tagging IAM identities in the * IAM User Guide.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { IAMClient, TagRoleCommand } from "@aws-sdk/client-iam"; // ES Modules import + * // const { IAMClient, TagRoleCommand } = require("@aws-sdk/client-iam"); // CommonJS import + * const client = new IAMClient(config); + * const command = new TagRoleCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link TagRoleCommandInput} for command's `input` shape. + * @see {@link TagRoleCommandOutput} for command's `response` shape. + * @see {@link IAMClientResolvedConfig | config} for command's `input` shape. + * */ export class TagRoleCommand extends $Command { // Start section: command_properties diff --git a/clients/client-iam/commands/TagSAMLProviderCommand.ts b/clients/client-iam/commands/TagSAMLProviderCommand.ts index 0628ac57bbaf..6569c8ee88b1 100644 --- a/clients/client-iam/commands/TagSAMLProviderCommand.ts +++ b/clients/client-iam/commands/TagSAMLProviderCommand.ts @@ -59,6 +59,20 @@ export interface TagSAMLProviderCommandOutput extends __MetadataBearer {} * * * + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { IAMClient, TagSAMLProviderCommand } from "@aws-sdk/client-iam"; // ES Modules import + * // const { IAMClient, TagSAMLProviderCommand } = require("@aws-sdk/client-iam"); // CommonJS import + * const client = new IAMClient(config); + * const command = new TagSAMLProviderCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link TagSAMLProviderCommandInput} for command's `input` shape. + * @see {@link TagSAMLProviderCommandOutput} for command's `response` shape. + * @see {@link IAMClientResolvedConfig | config} for command's `input` shape. + * */ export class TagSAMLProviderCommand extends $Command< TagSAMLProviderCommandInput, diff --git a/clients/client-iam/commands/TagServerCertificateCommand.ts b/clients/client-iam/commands/TagServerCertificateCommand.ts index 893a8a6f0ef3..f5353671c0c0 100644 --- a/clients/client-iam/commands/TagServerCertificateCommand.ts +++ b/clients/client-iam/commands/TagServerCertificateCommand.ts @@ -69,6 +69,20 @@ export interface TagServerCertificateCommandOutput extends __MetadataBearer {} * * * + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { IAMClient, TagServerCertificateCommand } from "@aws-sdk/client-iam"; // ES Modules import + * // const { IAMClient, TagServerCertificateCommand } = require("@aws-sdk/client-iam"); // CommonJS import + * const client = new IAMClient(config); + * const command = new TagServerCertificateCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link TagServerCertificateCommandInput} for command's `input` shape. + * @see {@link TagServerCertificateCommandOutput} for command's `response` shape. + * @see {@link IAMClientResolvedConfig | config} for command's `input` shape. + * */ export class TagServerCertificateCommand extends $Command< TagServerCertificateCommandInput, diff --git a/clients/client-iam/commands/TagUserCommand.ts b/clients/client-iam/commands/TagUserCommand.ts index 22c85cee1432..55977270b471 100644 --- a/clients/client-iam/commands/TagUserCommand.ts +++ b/clients/client-iam/commands/TagUserCommand.ts @@ -62,6 +62,20 @@ export interface TagUserCommandOutput extends __MetadataBearer {} * *

For more information about tagging, see Tagging IAM identities in the * IAM User Guide.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { IAMClient, TagUserCommand } from "@aws-sdk/client-iam"; // ES Modules import + * // const { IAMClient, TagUserCommand } = require("@aws-sdk/client-iam"); // CommonJS import + * const client = new IAMClient(config); + * const command = new TagUserCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link TagUserCommandInput} for command's `input` shape. + * @see {@link TagUserCommandOutput} for command's `response` shape. + * @see {@link IAMClientResolvedConfig | config} for command's `input` shape. + * */ export class TagUserCommand extends $Command { // Start section: command_properties diff --git a/clients/client-iam/commands/UntagInstanceProfileCommand.ts b/clients/client-iam/commands/UntagInstanceProfileCommand.ts index 29fbb31f9492..676ebabf0b8e 100644 --- a/clients/client-iam/commands/UntagInstanceProfileCommand.ts +++ b/clients/client-iam/commands/UntagInstanceProfileCommand.ts @@ -23,6 +23,20 @@ export interface UntagInstanceProfileCommandOutput extends __MetadataBearer {} /** *

Removes the specified tags from the IAM instance profile. For more information about tagging, see Tagging IAM resources in the * IAM User Guide.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { IAMClient, UntagInstanceProfileCommand } from "@aws-sdk/client-iam"; // ES Modules import + * // const { IAMClient, UntagInstanceProfileCommand } = require("@aws-sdk/client-iam"); // CommonJS import + * const client = new IAMClient(config); + * const command = new UntagInstanceProfileCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link UntagInstanceProfileCommandInput} for command's `input` shape. + * @see {@link UntagInstanceProfileCommandOutput} for command's `response` shape. + * @see {@link IAMClientResolvedConfig | config} for command's `input` shape. + * */ export class UntagInstanceProfileCommand extends $Command< UntagInstanceProfileCommandInput, diff --git a/clients/client-iam/commands/UntagMFADeviceCommand.ts b/clients/client-iam/commands/UntagMFADeviceCommand.ts index 133aefb23c49..27902a30f370 100644 --- a/clients/client-iam/commands/UntagMFADeviceCommand.ts +++ b/clients/client-iam/commands/UntagMFADeviceCommand.ts @@ -24,6 +24,20 @@ export interface UntagMFADeviceCommandOutput extends __MetadataBearer {} *

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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { IAMClient, UntagMFADeviceCommand } from "@aws-sdk/client-iam"; // ES Modules import + * // const { IAMClient, UntagMFADeviceCommand } = require("@aws-sdk/client-iam"); // CommonJS import + * const client = new IAMClient(config); + * const command = new UntagMFADeviceCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link UntagMFADeviceCommandInput} for command's `input` shape. + * @see {@link UntagMFADeviceCommandOutput} for command's `response` shape. + * @see {@link IAMClientResolvedConfig | config} for command's `input` shape. + * */ export class UntagMFADeviceCommand extends $Command< UntagMFADeviceCommandInput, diff --git a/clients/client-iam/commands/UntagOpenIDConnectProviderCommand.ts b/clients/client-iam/commands/UntagOpenIDConnectProviderCommand.ts index 12df9b6d6366..c50501b3d5c3 100644 --- a/clients/client-iam/commands/UntagOpenIDConnectProviderCommand.ts +++ b/clients/client-iam/commands/UntagOpenIDConnectProviderCommand.ts @@ -25,6 +25,20 @@ export interface UntagOpenIDConnectProviderCommandOutput extends __MetadataBeare * 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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { IAMClient, UntagOpenIDConnectProviderCommand } from "@aws-sdk/client-iam"; // ES Modules import + * // const { IAMClient, UntagOpenIDConnectProviderCommand } = require("@aws-sdk/client-iam"); // CommonJS import + * const client = new IAMClient(config); + * const command = new UntagOpenIDConnectProviderCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link UntagOpenIDConnectProviderCommandInput} for command's `input` shape. + * @see {@link UntagOpenIDConnectProviderCommandOutput} for command's `response` shape. + * @see {@link IAMClientResolvedConfig | config} for command's `input` shape. + * */ export class UntagOpenIDConnectProviderCommand extends $Command< UntagOpenIDConnectProviderCommandInput, diff --git a/clients/client-iam/commands/UntagPolicyCommand.ts b/clients/client-iam/commands/UntagPolicyCommand.ts index 59872d2d99d1..60ba1eeb8b42 100644 --- a/clients/client-iam/commands/UntagPolicyCommand.ts +++ b/clients/client-iam/commands/UntagPolicyCommand.ts @@ -20,6 +20,20 @@ export interface UntagPolicyCommandOutput extends __MetadataBearer {} /** *

Removes the specified tags from the customer managed policy. For more information about tagging, see Tagging IAM resources in the * IAM User Guide.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { IAMClient, UntagPolicyCommand } from "@aws-sdk/client-iam"; // ES Modules import + * // const { IAMClient, UntagPolicyCommand } = require("@aws-sdk/client-iam"); // CommonJS import + * const client = new IAMClient(config); + * const command = new UntagPolicyCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link UntagPolicyCommandInput} for command's `input` shape. + * @see {@link UntagPolicyCommandOutput} for command's `response` shape. + * @see {@link IAMClientResolvedConfig | config} for command's `input` shape. + * */ export class UntagPolicyCommand extends $Command< UntagPolicyCommandInput, diff --git a/clients/client-iam/commands/UntagRoleCommand.ts b/clients/client-iam/commands/UntagRoleCommand.ts index 00ec1424e305..80d6233e839b 100644 --- a/clients/client-iam/commands/UntagRoleCommand.ts +++ b/clients/client-iam/commands/UntagRoleCommand.ts @@ -20,6 +20,20 @@ export interface UntagRoleCommandOutput extends __MetadataBearer {} /** *

Removes the specified tags from the role. For more information about tagging, see Tagging IAM resources in the * IAM User Guide.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { IAMClient, UntagRoleCommand } from "@aws-sdk/client-iam"; // ES Modules import + * // const { IAMClient, UntagRoleCommand } = require("@aws-sdk/client-iam"); // CommonJS import + * const client = new IAMClient(config); + * const command = new UntagRoleCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link UntagRoleCommandInput} for command's `input` shape. + * @see {@link UntagRoleCommandOutput} for command's `response` shape. + * @see {@link IAMClientResolvedConfig | config} for command's `input` shape. + * */ export class UntagRoleCommand extends $Command { // Start section: command_properties diff --git a/clients/client-iam/commands/UntagSAMLProviderCommand.ts b/clients/client-iam/commands/UntagSAMLProviderCommand.ts index ed72f78f872f..fd609c5689ed 100644 --- a/clients/client-iam/commands/UntagSAMLProviderCommand.ts +++ b/clients/client-iam/commands/UntagSAMLProviderCommand.ts @@ -25,6 +25,20 @@ export interface UntagSAMLProviderCommandOutput extends __MetadataBearer {} * 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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { IAMClient, UntagSAMLProviderCommand } from "@aws-sdk/client-iam"; // ES Modules import + * // const { IAMClient, UntagSAMLProviderCommand } = require("@aws-sdk/client-iam"); // CommonJS import + * const client = new IAMClient(config); + * const command = new UntagSAMLProviderCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link UntagSAMLProviderCommandInput} for command's `input` shape. + * @see {@link UntagSAMLProviderCommandOutput} for command's `response` shape. + * @see {@link IAMClientResolvedConfig | config} for command's `input` shape. + * */ export class UntagSAMLProviderCommand extends $Command< UntagSAMLProviderCommandInput, diff --git a/clients/client-iam/commands/UntagServerCertificateCommand.ts b/clients/client-iam/commands/UntagServerCertificateCommand.ts index e0e04cee6a86..5c39841e4cf7 100644 --- a/clients/client-iam/commands/UntagServerCertificateCommand.ts +++ b/clients/client-iam/commands/UntagServerCertificateCommand.ts @@ -31,6 +31,20 @@ export interface UntagServerCertificateCommandOutput extends __MetadataBearer {} * certificates, Working with server * certificates in the IAM User Guide.

* + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { IAMClient, UntagServerCertificateCommand } from "@aws-sdk/client-iam"; // ES Modules import + * // const { IAMClient, UntagServerCertificateCommand } = require("@aws-sdk/client-iam"); // CommonJS import + * const client = new IAMClient(config); + * const command = new UntagServerCertificateCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link UntagServerCertificateCommandInput} for command's `input` shape. + * @see {@link UntagServerCertificateCommandOutput} for command's `response` shape. + * @see {@link IAMClientResolvedConfig | config} for command's `input` shape. + * */ export class UntagServerCertificateCommand extends $Command< UntagServerCertificateCommandInput, diff --git a/clients/client-iam/commands/UntagUserCommand.ts b/clients/client-iam/commands/UntagUserCommand.ts index 6f7f19a63fe2..3c8164dd0e6c 100644 --- a/clients/client-iam/commands/UntagUserCommand.ts +++ b/clients/client-iam/commands/UntagUserCommand.ts @@ -20,6 +20,20 @@ export interface UntagUserCommandOutput extends __MetadataBearer {} /** *

Removes the specified tags from the user. For more information about tagging, see Tagging IAM resources in the * IAM User Guide.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { IAMClient, UntagUserCommand } from "@aws-sdk/client-iam"; // ES Modules import + * // const { IAMClient, UntagUserCommand } = require("@aws-sdk/client-iam"); // CommonJS import + * const client = new IAMClient(config); + * const command = new UntagUserCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link UntagUserCommandInput} for command's `input` shape. + * @see {@link UntagUserCommandOutput} for command's `response` shape. + * @see {@link IAMClientResolvedConfig | config} for command's `input` shape. + * */ export class UntagUserCommand extends $Command { // Start section: command_properties diff --git a/clients/client-iam/commands/UpdateAccessKeyCommand.ts b/clients/client-iam/commands/UpdateAccessKeyCommand.ts index 8cbf4b64ceb9..e1cb0a5726a7 100644 --- a/clients/client-iam/commands/UpdateAccessKeyCommand.ts +++ b/clients/client-iam/commands/UpdateAccessKeyCommand.ts @@ -31,6 +31,20 @@ export interface UpdateAccessKeyCommandOutput extends __MetadataBearer {} * users.

*

For information about rotating keys, see Managing keys and certificates * in the IAM User Guide.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { IAMClient, UpdateAccessKeyCommand } from "@aws-sdk/client-iam"; // ES Modules import + * // const { IAMClient, UpdateAccessKeyCommand } = require("@aws-sdk/client-iam"); // CommonJS import + * const client = new IAMClient(config); + * const command = new UpdateAccessKeyCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link UpdateAccessKeyCommandInput} for command's `input` shape. + * @see {@link UpdateAccessKeyCommandOutput} for command's `response` shape. + * @see {@link IAMClientResolvedConfig | config} for command's `input` shape. + * */ export class UpdateAccessKeyCommand extends $Command< UpdateAccessKeyCommandInput, diff --git a/clients/client-iam/commands/UpdateAccountPasswordPolicyCommand.ts b/clients/client-iam/commands/UpdateAccountPasswordPolicyCommand.ts index ea0f401e5d94..6b0455481b81 100644 --- a/clients/client-iam/commands/UpdateAccountPasswordPolicyCommand.ts +++ b/clients/client-iam/commands/UpdateAccountPasswordPolicyCommand.ts @@ -37,6 +37,20 @@ export interface UpdateAccountPasswordPolicyCommandOutput extends __MetadataBear * *

For more information about using a password policy, see Managing an IAM password * policy in the IAM User Guide.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { IAMClient, UpdateAccountPasswordPolicyCommand } from "@aws-sdk/client-iam"; // ES Modules import + * // const { IAMClient, UpdateAccountPasswordPolicyCommand } = require("@aws-sdk/client-iam"); // CommonJS import + * const client = new IAMClient(config); + * const command = new UpdateAccountPasswordPolicyCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link UpdateAccountPasswordPolicyCommandInput} for command's `input` shape. + * @see {@link UpdateAccountPasswordPolicyCommandOutput} for command's `response` shape. + * @see {@link IAMClientResolvedConfig | config} for command's `input` shape. + * */ export class UpdateAccountPasswordPolicyCommand extends $Command< UpdateAccountPasswordPolicyCommandInput, diff --git a/clients/client-iam/commands/UpdateAssumeRolePolicyCommand.ts b/clients/client-iam/commands/UpdateAssumeRolePolicyCommand.ts index 2270dbb77737..701995d12aac 100644 --- a/clients/client-iam/commands/UpdateAssumeRolePolicyCommand.ts +++ b/clients/client-iam/commands/UpdateAssumeRolePolicyCommand.ts @@ -25,6 +25,20 @@ export interface UpdateAssumeRolePolicyCommandOutput extends __MetadataBearer {} * typically referred to as the "role trust policy". For more information about roles, see * Using roles to * delegate permissions and federate identities.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { IAMClient, UpdateAssumeRolePolicyCommand } from "@aws-sdk/client-iam"; // ES Modules import + * // const { IAMClient, UpdateAssumeRolePolicyCommand } = require("@aws-sdk/client-iam"); // CommonJS import + * const client = new IAMClient(config); + * const command = new UpdateAssumeRolePolicyCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link UpdateAssumeRolePolicyCommandInput} for command's `input` shape. + * @see {@link UpdateAssumeRolePolicyCommandOutput} for command's `response` shape. + * @see {@link IAMClientResolvedConfig | config} for command's `input` shape. + * */ export class UpdateAssumeRolePolicyCommand extends $Command< UpdateAssumeRolePolicyCommandInput, diff --git a/clients/client-iam/commands/UpdateGroupCommand.ts b/clients/client-iam/commands/UpdateGroupCommand.ts index ac52acbcdb23..418cdb6d1ccd 100644 --- a/clients/client-iam/commands/UpdateGroupCommand.ts +++ b/clients/client-iam/commands/UpdateGroupCommand.ts @@ -33,6 +33,20 @@ export interface UpdateGroupCommandOutput extends __MetadataBearer {} * update fails. For more information about permissions, see Access management. *

* + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { IAMClient, UpdateGroupCommand } from "@aws-sdk/client-iam"; // ES Modules import + * // const { IAMClient, UpdateGroupCommand } = require("@aws-sdk/client-iam"); // CommonJS import + * const client = new IAMClient(config); + * const command = new UpdateGroupCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link UpdateGroupCommandInput} for command's `input` shape. + * @see {@link UpdateGroupCommandOutput} for command's `response` shape. + * @see {@link IAMClientResolvedConfig | config} for command's `input` shape. + * */ export class UpdateGroupCommand extends $Command< UpdateGroupCommandInput, diff --git a/clients/client-iam/commands/UpdateLoginProfileCommand.ts b/clients/client-iam/commands/UpdateLoginProfileCommand.ts index 00a33d4329b0..a57683a5e9c0 100644 --- a/clients/client-iam/commands/UpdateLoginProfileCommand.ts +++ b/clients/client-iam/commands/UpdateLoginProfileCommand.ts @@ -28,6 +28,20 @@ export interface UpdateLoginProfileCommandOutput extends __MetadataBearer {} * in the AWS Management Console.

*

For more information about modifying passwords, see Managing passwords in the * IAM User Guide.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { IAMClient, UpdateLoginProfileCommand } from "@aws-sdk/client-iam"; // ES Modules import + * // const { IAMClient, UpdateLoginProfileCommand } = require("@aws-sdk/client-iam"); // CommonJS import + * const client = new IAMClient(config); + * const command = new UpdateLoginProfileCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link UpdateLoginProfileCommandInput} for command's `input` shape. + * @see {@link UpdateLoginProfileCommandOutput} for command's `response` shape. + * @see {@link IAMClientResolvedConfig | config} for command's `input` shape. + * */ export class UpdateLoginProfileCommand extends $Command< UpdateLoginProfileCommandInput, diff --git a/clients/client-iam/commands/UpdateOpenIDConnectProviderThumbprintCommand.ts b/clients/client-iam/commands/UpdateOpenIDConnectProviderThumbprintCommand.ts index bd63b6919a1b..84ab6ec01b73 100644 --- a/clients/client-iam/commands/UpdateOpenIDConnectProviderThumbprintCommand.ts +++ b/clients/client-iam/commands/UpdateOpenIDConnectProviderThumbprintCommand.ts @@ -37,6 +37,20 @@ export interface UpdateOpenIDConnectProviderThumbprintCommandOutput extends __Me * UpdateOpenIDConnectProviderThumbprint operation to highly * privileged users.

* + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { IAMClient, UpdateOpenIDConnectProviderThumbprintCommand } from "@aws-sdk/client-iam"; // ES Modules import + * // const { IAMClient, UpdateOpenIDConnectProviderThumbprintCommand } = require("@aws-sdk/client-iam"); // CommonJS import + * const client = new IAMClient(config); + * const command = new UpdateOpenIDConnectProviderThumbprintCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link UpdateOpenIDConnectProviderThumbprintCommandInput} for command's `input` shape. + * @see {@link UpdateOpenIDConnectProviderThumbprintCommandOutput} for command's `response` shape. + * @see {@link IAMClientResolvedConfig | config} for command's `input` shape. + * */ export class UpdateOpenIDConnectProviderThumbprintCommand extends $Command< UpdateOpenIDConnectProviderThumbprintCommandInput, diff --git a/clients/client-iam/commands/UpdateRoleCommand.ts b/clients/client-iam/commands/UpdateRoleCommand.ts index 5226729fc634..b3ebe97b384f 100644 --- a/clients/client-iam/commands/UpdateRoleCommand.ts +++ b/clients/client-iam/commands/UpdateRoleCommand.ts @@ -19,6 +19,20 @@ export interface UpdateRoleCommandOutput extends UpdateRoleResponse, __MetadataB /** *

Updates the description or maximum session duration setting of a role.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { IAMClient, UpdateRoleCommand } from "@aws-sdk/client-iam"; // ES Modules import + * // const { IAMClient, UpdateRoleCommand } = require("@aws-sdk/client-iam"); // CommonJS import + * const client = new IAMClient(config); + * const command = new UpdateRoleCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link UpdateRoleCommandInput} for command's `input` shape. + * @see {@link UpdateRoleCommandOutput} for command's `response` shape. + * @see {@link IAMClientResolvedConfig | config} for command's `input` shape. + * */ export class UpdateRoleCommand extends $Command< UpdateRoleCommandInput, diff --git a/clients/client-iam/commands/UpdateRoleDescriptionCommand.ts b/clients/client-iam/commands/UpdateRoleDescriptionCommand.ts index b443b064095b..fa59bf861580 100644 --- a/clients/client-iam/commands/UpdateRoleDescriptionCommand.ts +++ b/clients/client-iam/commands/UpdateRoleDescriptionCommand.ts @@ -24,6 +24,20 @@ export interface UpdateRoleDescriptionCommandOutput extends UpdateRoleDescriptio *

Use UpdateRole instead.

*

Modifies only the description of a role. This operation performs the same function as * the Description parameter in the UpdateRole operation.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { IAMClient, UpdateRoleDescriptionCommand } from "@aws-sdk/client-iam"; // ES Modules import + * // const { IAMClient, UpdateRoleDescriptionCommand } = require("@aws-sdk/client-iam"); // CommonJS import + * const client = new IAMClient(config); + * const command = new UpdateRoleDescriptionCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link UpdateRoleDescriptionCommandInput} for command's `input` shape. + * @see {@link UpdateRoleDescriptionCommandOutput} for command's `response` shape. + * @see {@link IAMClientResolvedConfig | config} for command's `input` shape. + * */ export class UpdateRoleDescriptionCommand extends $Command< UpdateRoleDescriptionCommandInput, diff --git a/clients/client-iam/commands/UpdateSAMLProviderCommand.ts b/clients/client-iam/commands/UpdateSAMLProviderCommand.ts index 1b82b6396cd4..eb928c41ef7b 100644 --- a/clients/client-iam/commands/UpdateSAMLProviderCommand.ts +++ b/clients/client-iam/commands/UpdateSAMLProviderCommand.ts @@ -25,6 +25,20 @@ export interface UpdateSAMLProviderCommandOutput extends UpdateSAMLProviderRespo * *

This operation requires Signature Version 4.

* + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { IAMClient, UpdateSAMLProviderCommand } from "@aws-sdk/client-iam"; // ES Modules import + * // const { IAMClient, UpdateSAMLProviderCommand } = require("@aws-sdk/client-iam"); // CommonJS import + * const client = new IAMClient(config); + * const command = new UpdateSAMLProviderCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link UpdateSAMLProviderCommandInput} for command's `input` shape. + * @see {@link UpdateSAMLProviderCommandOutput} for command's `response` shape. + * @see {@link IAMClientResolvedConfig | config} for command's `input` shape. + * */ export class UpdateSAMLProviderCommand extends $Command< UpdateSAMLProviderCommandInput, diff --git a/clients/client-iam/commands/UpdateSSHPublicKeyCommand.ts b/clients/client-iam/commands/UpdateSSHPublicKeyCommand.ts index 663960937e25..8819f134e20d 100644 --- a/clients/client-iam/commands/UpdateSSHPublicKeyCommand.ts +++ b/clients/client-iam/commands/UpdateSSHPublicKeyCommand.ts @@ -28,6 +28,20 @@ export interface UpdateSSHPublicKeyCommandOutput extends __MetadataBearer {} * associated IAM user to an AWS CodeCommit repository. For more information about using SSH keys * to authenticate to an AWS CodeCommit repository, see Set up AWS CodeCommit for * SSH connections in the AWS CodeCommit User Guide.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { IAMClient, UpdateSSHPublicKeyCommand } from "@aws-sdk/client-iam"; // ES Modules import + * // const { IAMClient, UpdateSSHPublicKeyCommand } = require("@aws-sdk/client-iam"); // CommonJS import + * const client = new IAMClient(config); + * const command = new UpdateSSHPublicKeyCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link UpdateSSHPublicKeyCommandInput} for command's `input` shape. + * @see {@link UpdateSSHPublicKeyCommandOutput} for command's `response` shape. + * @see {@link IAMClientResolvedConfig | config} for command's `input` shape. + * */ export class UpdateSSHPublicKeyCommand extends $Command< UpdateSSHPublicKeyCommandInput, diff --git a/clients/client-iam/commands/UpdateServerCertificateCommand.ts b/clients/client-iam/commands/UpdateServerCertificateCommand.ts index c36f9bbb8246..0e3cd461a063 100644 --- a/clients/client-iam/commands/UpdateServerCertificateCommand.ts +++ b/clients/client-iam/commands/UpdateServerCertificateCommand.ts @@ -41,6 +41,20 @@ export interface UpdateServerCertificateCommandOutput extends __MetadataBearer { * the ProdCert certificate, then the update fails. For more information * about permissions, see Access management in the IAM User Guide.

* + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { IAMClient, UpdateServerCertificateCommand } from "@aws-sdk/client-iam"; // ES Modules import + * // const { IAMClient, UpdateServerCertificateCommand } = require("@aws-sdk/client-iam"); // CommonJS import + * const client = new IAMClient(config); + * const command = new UpdateServerCertificateCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link UpdateServerCertificateCommandInput} for command's `input` shape. + * @see {@link UpdateServerCertificateCommandOutput} for command's `response` shape. + * @see {@link IAMClientResolvedConfig | config} for command's `input` shape. + * */ export class UpdateServerCertificateCommand extends $Command< UpdateServerCertificateCommandInput, diff --git a/clients/client-iam/commands/UpdateServiceSpecificCredentialCommand.ts b/clients/client-iam/commands/UpdateServiceSpecificCredentialCommand.ts index d1b299d4c61c..e73ebca7b7c4 100644 --- a/clients/client-iam/commands/UpdateServiceSpecificCredentialCommand.ts +++ b/clients/client-iam/commands/UpdateServiceSpecificCredentialCommand.ts @@ -25,6 +25,20 @@ export interface UpdateServiceSpecificCredentialCommandOutput extends __Metadata * 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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { IAMClient, UpdateServiceSpecificCredentialCommand } from "@aws-sdk/client-iam"; // ES Modules import + * // const { IAMClient, UpdateServiceSpecificCredentialCommand } = require("@aws-sdk/client-iam"); // CommonJS import + * const client = new IAMClient(config); + * const command = new UpdateServiceSpecificCredentialCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link UpdateServiceSpecificCredentialCommandInput} for command's `input` shape. + * @see {@link UpdateServiceSpecificCredentialCommandOutput} for command's `response` shape. + * @see {@link IAMClientResolvedConfig | config} for command's `input` shape. + * */ export class UpdateServiceSpecificCredentialCommand extends $Command< UpdateServiceSpecificCredentialCommandInput, diff --git a/clients/client-iam/commands/UpdateSigningCertificateCommand.ts b/clients/client-iam/commands/UpdateSigningCertificateCommand.ts index 6d270566f30e..5bddc3684eea 100644 --- a/clients/client-iam/commands/UpdateSigningCertificateCommand.ts +++ b/clients/client-iam/commands/UpdateSigningCertificateCommand.ts @@ -29,6 +29,20 @@ export interface UpdateSigningCertificateCommandOutput extends __MetadataBearer * works for access keys under the AWS account. Consequently, you can use this operation * to manage AWS account root user credentials even if the AWS account has no * associated users.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { IAMClient, UpdateSigningCertificateCommand } from "@aws-sdk/client-iam"; // ES Modules import + * // const { IAMClient, UpdateSigningCertificateCommand } = require("@aws-sdk/client-iam"); // CommonJS import + * const client = new IAMClient(config); + * const command = new UpdateSigningCertificateCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link UpdateSigningCertificateCommandInput} for command's `input` shape. + * @see {@link UpdateSigningCertificateCommandOutput} for command's `response` shape. + * @see {@link IAMClientResolvedConfig | config} for command's `input` shape. + * */ export class UpdateSigningCertificateCommand extends $Command< UpdateSigningCertificateCommandInput, diff --git a/clients/client-iam/commands/UpdateUserCommand.ts b/clients/client-iam/commands/UpdateUserCommand.ts index f5996b3c4dbc..17b5cb3d530a 100644 --- a/clients/client-iam/commands/UpdateUserCommand.ts +++ b/clients/client-iam/commands/UpdateUserCommand.ts @@ -31,6 +31,20 @@ export interface UpdateUserCommandOutput extends __MetadataBearer {} * 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.

* + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { IAMClient, UpdateUserCommand } from "@aws-sdk/client-iam"; // ES Modules import + * // const { IAMClient, UpdateUserCommand } = require("@aws-sdk/client-iam"); // CommonJS import + * const client = new IAMClient(config); + * const command = new UpdateUserCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link UpdateUserCommandInput} for command's `input` shape. + * @see {@link UpdateUserCommandOutput} for command's `response` shape. + * @see {@link IAMClientResolvedConfig | config} for command's `input` shape. + * */ export class UpdateUserCommand extends $Command< UpdateUserCommandInput, diff --git a/clients/client-iam/commands/UploadSSHPublicKeyCommand.ts b/clients/client-iam/commands/UploadSSHPublicKeyCommand.ts index 7e8dbabe9718..e3e732fa1ddd 100644 --- a/clients/client-iam/commands/UploadSSHPublicKeyCommand.ts +++ b/clients/client-iam/commands/UploadSSHPublicKeyCommand.ts @@ -26,6 +26,20 @@ export interface UploadSSHPublicKeyCommandOutput extends UploadSSHPublicKeyRespo * associated IAM user to an AWS CodeCommit repository. For more information about using SSH keys * to authenticate to an AWS CodeCommit repository, see Set up AWS CodeCommit for * SSH connections in the AWS CodeCommit User Guide.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { IAMClient, UploadSSHPublicKeyCommand } from "@aws-sdk/client-iam"; // ES Modules import + * // const { IAMClient, UploadSSHPublicKeyCommand } = require("@aws-sdk/client-iam"); // CommonJS import + * const client = new IAMClient(config); + * const command = new UploadSSHPublicKeyCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link UploadSSHPublicKeyCommandInput} for command's `input` shape. + * @see {@link UploadSSHPublicKeyCommandOutput} for command's `response` shape. + * @see {@link IAMClientResolvedConfig | config} for command's `input` shape. + * */ export class UploadSSHPublicKeyCommand extends $Command< UploadSSHPublicKeyCommandInput, diff --git a/clients/client-iam/commands/UploadServerCertificateCommand.ts b/clients/client-iam/commands/UploadServerCertificateCommand.ts index 828f59d8b997..ccc3dc1d8b94 100644 --- a/clients/client-iam/commands/UploadServerCertificateCommand.ts +++ b/clients/client-iam/commands/UploadServerCertificateCommand.ts @@ -44,6 +44,20 @@ export interface UploadServerCertificateCommandOutput extends UploadServerCertif * information about using the Query API with IAM, see Calling the API by making HTTP query * requests in the IAM User Guide.

* + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { IAMClient, UploadServerCertificateCommand } from "@aws-sdk/client-iam"; // ES Modules import + * // const { IAMClient, UploadServerCertificateCommand } = require("@aws-sdk/client-iam"); // CommonJS import + * const client = new IAMClient(config); + * const command = new UploadServerCertificateCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link UploadServerCertificateCommandInput} for command's `input` shape. + * @see {@link UploadServerCertificateCommandOutput} for command's `response` shape. + * @see {@link IAMClientResolvedConfig | config} for command's `input` shape. + * */ export class UploadServerCertificateCommand extends $Command< UploadServerCertificateCommandInput, diff --git a/clients/client-iam/commands/UploadSigningCertificateCommand.ts b/clients/client-iam/commands/UploadSigningCertificateCommand.ts index cac47baf8ba1..d2264e4e48ef 100644 --- a/clients/client-iam/commands/UploadSigningCertificateCommand.ts +++ b/clients/client-iam/commands/UploadSigningCertificateCommand.ts @@ -41,6 +41,20 @@ export interface UploadSigningCertificateCommandOutput extends UploadSigningCert * general information about using the Query API with IAM, see Making query * requests in the IAM User Guide.

* + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { IAMClient, UploadSigningCertificateCommand } from "@aws-sdk/client-iam"; // ES Modules import + * // const { IAMClient, UploadSigningCertificateCommand } = require("@aws-sdk/client-iam"); // CommonJS import + * const client = new IAMClient(config); + * const command = new UploadSigningCertificateCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link UploadSigningCertificateCommandInput} for command's `input` shape. + * @see {@link UploadSigningCertificateCommandOutput} for command's `response` shape. + * @see {@link IAMClientResolvedConfig | config} for command's `input` shape. + * */ export class UploadSigningCertificateCommand extends $Command< UploadSigningCertificateCommandInput, diff --git a/clients/client-iam/models/models_0.ts b/clients/client-iam/models/models_0.ts index 88c647e64dc9..56c5b08d376c 100644 --- a/clients/client-iam/models/models_0.ts +++ b/clients/client-iam/models/models_0.ts @@ -62,6 +62,9 @@ export interface AccessDetail { } export namespace AccessDetail { + /** + * @internal + */ export const filterSensitiveLog = (obj: AccessDetail): any => ({ ...obj, }); @@ -108,6 +111,9 @@ export interface AccessKey { } export namespace AccessKey { + /** + * @internal + */ export const filterSensitiveLog = (obj: AccessKey): any => ({ ...obj, ...(obj.SecretAccessKey && { SecretAccessKey: SENSITIVE_STRING }), @@ -179,6 +185,9 @@ export interface AccessKeyLastUsed { } export namespace AccessKeyLastUsed { + /** + * @internal + */ export const filterSensitiveLog = (obj: AccessKeyLastUsed): any => ({ ...obj, }); @@ -213,6 +222,9 @@ export interface AccessKeyMetadata { } export namespace AccessKeyMetadata { + /** + * @internal + */ export const filterSensitiveLog = (obj: AccessKeyMetadata): any => ({ ...obj, }); @@ -233,6 +245,9 @@ export interface AddClientIDToOpenIDConnectProviderRequest { } export namespace AddClientIDToOpenIDConnectProviderRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: AddClientIDToOpenIDConnectProviderRequest): any => ({ ...obj, }); @@ -249,6 +264,9 @@ export interface InvalidInputException extends __SmithyException, $MetadataBeare } export namespace InvalidInputException { + /** + * @internal + */ export const filterSensitiveLog = (obj: InvalidInputException): any => ({ ...obj, }); @@ -265,6 +283,9 @@ export interface LimitExceededException extends __SmithyException, $MetadataBear } export namespace LimitExceededException { + /** + * @internal + */ export const filterSensitiveLog = (obj: LimitExceededException): any => ({ ...obj, }); @@ -281,6 +302,9 @@ export interface NoSuchEntityException extends __SmithyException, $MetadataBeare } export namespace NoSuchEntityException { + /** + * @internal + */ export const filterSensitiveLog = (obj: NoSuchEntityException): any => ({ ...obj, }); @@ -297,6 +321,9 @@ export interface ServiceFailureException extends __SmithyException, $MetadataBea } export namespace ServiceFailureException { + /** + * @internal + */ export const filterSensitiveLog = (obj: ServiceFailureException): any => ({ ...obj, }); @@ -319,6 +346,9 @@ export interface AddRoleToInstanceProfileRequest { } export namespace AddRoleToInstanceProfileRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: AddRoleToInstanceProfileRequest): any => ({ ...obj, }); @@ -335,6 +365,9 @@ export interface EntityAlreadyExistsException extends __SmithyException, $Metada } export namespace EntityAlreadyExistsException { + /** + * @internal + */ export const filterSensitiveLog = (obj: EntityAlreadyExistsException): any => ({ ...obj, }); @@ -353,6 +386,9 @@ export interface UnmodifiableEntityException extends __SmithyException, $Metadat } export namespace UnmodifiableEntityException { + /** + * @internal + */ export const filterSensitiveLog = (obj: UnmodifiableEntityException): any => ({ ...obj, }); @@ -375,6 +411,9 @@ export interface AddUserToGroupRequest { } export namespace AddUserToGroupRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: AddUserToGroupRequest): any => ({ ...obj, }); @@ -408,6 +447,9 @@ export interface AttachedPermissionsBoundary { } export namespace AttachedPermissionsBoundary { + /** + * @internal + */ export const filterSensitiveLog = (obj: AttachedPermissionsBoundary): any => ({ ...obj, }); @@ -435,6 +477,9 @@ export interface AttachedPolicy { } export namespace AttachedPolicy { + /** + * @internal + */ export const filterSensitiveLog = (obj: AttachedPolicy): any => ({ ...obj, }); @@ -456,6 +501,9 @@ export interface AttachGroupPolicyRequest { } export namespace AttachGroupPolicyRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: AttachGroupPolicyRequest): any => ({ ...obj, }); @@ -472,6 +520,9 @@ export interface PolicyNotAttachableException extends __SmithyException, $Metada } export namespace PolicyNotAttachableException { + /** + * @internal + */ export const filterSensitiveLog = (obj: PolicyNotAttachableException): any => ({ ...obj, }); @@ -493,6 +544,9 @@ export interface AttachRolePolicyRequest { } export namespace AttachRolePolicyRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: AttachRolePolicyRequest): any => ({ ...obj, }); @@ -514,6 +568,9 @@ export interface AttachUserPolicyRequest { } export namespace AttachUserPolicyRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: AttachUserPolicyRequest): any => ({ ...obj, }); @@ -540,6 +597,9 @@ export interface ChangePasswordRequest { } export namespace ChangePasswordRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ChangePasswordRequest): any => ({ ...obj, ...(obj.OldPassword && { OldPassword: SENSITIVE_STRING }), @@ -560,6 +620,9 @@ export interface EntityTemporarilyUnmodifiableException extends __SmithyExceptio } export namespace EntityTemporarilyUnmodifiableException { + /** + * @internal + */ export const filterSensitiveLog = (obj: EntityTemporarilyUnmodifiableException): any => ({ ...obj, }); @@ -576,6 +639,9 @@ export interface InvalidUserTypeException extends __SmithyException, $MetadataBe } export namespace InvalidUserTypeException { + /** + * @internal + */ export const filterSensitiveLog = (obj: InvalidUserTypeException): any => ({ ...obj, }); @@ -592,6 +658,9 @@ export interface PasswordPolicyViolationException extends __SmithyException, $Me } export namespace PasswordPolicyViolationException { + /** + * @internal + */ export const filterSensitiveLog = (obj: PasswordPolicyViolationException): any => ({ ...obj, }); @@ -607,6 +676,9 @@ export interface CreateAccessKeyRequest { } export namespace CreateAccessKeyRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateAccessKeyRequest): any => ({ ...obj, }); @@ -624,6 +696,9 @@ export interface CreateAccessKeyResponse { } export namespace CreateAccessKeyResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateAccessKeyResponse): any => ({ ...obj, ...(obj.AccessKey && { AccessKey: AccessKey.filterSensitiveLog(obj.AccessKey) }), @@ -641,6 +716,9 @@ export interface CreateAccountAliasRequest { } export namespace CreateAccountAliasRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateAccountAliasRequest): any => ({ ...obj, }); @@ -668,6 +746,9 @@ export interface CreateGroupRequest { } export namespace CreateGroupRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateGroupRequest): any => ({ ...obj, }); @@ -728,6 +809,9 @@ export interface Group { } export namespace Group { + /** + * @internal + */ export const filterSensitiveLog = (obj: Group): any => ({ ...obj, }); @@ -744,6 +828,9 @@ export interface CreateGroupResponse { } export namespace CreateGroupResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateGroupResponse): any => ({ ...obj, }); @@ -760,6 +847,9 @@ export interface ConcurrentModificationException extends __SmithyException, $Met } export namespace ConcurrentModificationException { + /** + * @internal + */ export const filterSensitiveLog = (obj: ConcurrentModificationException): any => ({ ...obj, }); @@ -794,6 +884,9 @@ export interface Tag { } export namespace Tag { + /** + * @internal + */ export const filterSensitiveLog = (obj: Tag): any => ({ ...obj, }); @@ -831,6 +924,9 @@ export interface CreateInstanceProfileRequest { } export namespace CreateInstanceProfileRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateInstanceProfileRequest): any => ({ ...obj, }); @@ -862,6 +958,9 @@ export interface RoleLastUsed { } export namespace RoleLastUsed { + /** + * @internal + */ export const filterSensitiveLog = (obj: RoleLastUsed): any => ({ ...obj, }); @@ -946,6 +1045,9 @@ export interface Role { } export namespace Role { + /** + * @internal + */ export const filterSensitiveLog = (obj: Role): any => ({ ...obj, }); @@ -1020,6 +1122,9 @@ export interface InstanceProfile { } export namespace InstanceProfile { + /** + * @internal + */ export const filterSensitiveLog = (obj: InstanceProfile): any => ({ ...obj, }); @@ -1037,6 +1142,9 @@ export interface CreateInstanceProfileResponse { } export namespace CreateInstanceProfileResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateInstanceProfileResponse): any => ({ ...obj, }); @@ -1070,6 +1178,9 @@ export interface CreateLoginProfileRequest { } export namespace CreateLoginProfileRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateLoginProfileRequest): any => ({ ...obj, ...(obj.Password && { Password: SENSITIVE_STRING }), @@ -1099,6 +1210,9 @@ export interface LoginProfile { } export namespace LoginProfile { + /** + * @internal + */ export const filterSensitiveLog = (obj: LoginProfile): any => ({ ...obj, }); @@ -1116,6 +1230,9 @@ export interface CreateLoginProfileResponse { } export namespace CreateLoginProfileResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateLoginProfileResponse): any => ({ ...obj, }); @@ -1180,6 +1297,9 @@ export interface CreateOpenIDConnectProviderRequest { } export namespace CreateOpenIDConnectProviderRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateOpenIDConnectProviderRequest): any => ({ ...obj, }); @@ -1206,6 +1326,9 @@ export interface CreateOpenIDConnectProviderResponse { } export namespace CreateOpenIDConnectProviderResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateOpenIDConnectProviderResponse): any => ({ ...obj, }); @@ -1280,6 +1403,9 @@ export interface CreatePolicyRequest { } export namespace CreatePolicyRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreatePolicyRequest): any => ({ ...obj, }); @@ -1372,6 +1498,9 @@ export interface Policy { } export namespace Policy { + /** + * @internal + */ export const filterSensitiveLog = (obj: Policy): any => ({ ...obj, }); @@ -1389,6 +1518,9 @@ export interface CreatePolicyResponse { } export namespace CreatePolicyResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreatePolicyResponse): any => ({ ...obj, }); @@ -1405,6 +1537,9 @@ export interface MalformedPolicyDocumentException extends __SmithyException, $Me } export namespace MalformedPolicyDocumentException { + /** + * @internal + */ export const filterSensitiveLog = (obj: MalformedPolicyDocumentException): any => ({ ...obj, }); @@ -1456,6 +1591,9 @@ export interface CreatePolicyVersionRequest { } export namespace CreatePolicyVersionRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreatePolicyVersionRequest): any => ({ ...obj, }); @@ -1499,6 +1637,9 @@ export interface PolicyVersion { } export namespace PolicyVersion { + /** + * @internal + */ export const filterSensitiveLog = (obj: PolicyVersion): any => ({ ...obj, }); @@ -1516,6 +1657,9 @@ export interface CreatePolicyVersionResponse { } export namespace CreatePolicyVersionResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreatePolicyVersionResponse): any => ({ ...obj, }); @@ -1609,6 +1753,9 @@ export interface CreateRoleRequest { } export namespace CreateRoleRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateRoleRequest): any => ({ ...obj, }); @@ -1625,6 +1772,9 @@ export interface CreateRoleResponse { } export namespace CreateRoleResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateRoleResponse): any => ({ ...obj, }); @@ -1663,6 +1813,9 @@ export interface CreateSAMLProviderRequest { } export namespace CreateSAMLProviderRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateSAMLProviderRequest): any => ({ ...obj, }); @@ -1687,6 +1840,9 @@ export interface CreateSAMLProviderResponse { } export namespace CreateSAMLProviderResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateSAMLProviderResponse): any => ({ ...obj, }); @@ -1725,6 +1881,9 @@ export interface CreateServiceLinkedRoleRequest { } export namespace CreateServiceLinkedRoleRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateServiceLinkedRoleRequest): any => ({ ...obj, }); @@ -1739,6 +1898,9 @@ export interface CreateServiceLinkedRoleResponse { } export namespace CreateServiceLinkedRoleResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateServiceLinkedRoleResponse): any => ({ ...obj, }); @@ -1763,6 +1925,9 @@ export interface CreateServiceSpecificCredentialRequest { } export namespace CreateServiceSpecificCredentialRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateServiceSpecificCredentialRequest): any => ({ ...obj, }); @@ -1814,6 +1979,9 @@ export interface ServiceSpecificCredential { } export namespace ServiceSpecificCredential { + /** + * @internal + */ export const filterSensitiveLog = (obj: ServiceSpecificCredential): any => ({ ...obj, ...(obj.ServicePassword && { ServicePassword: SENSITIVE_STRING }), @@ -1833,6 +2001,9 @@ export interface CreateServiceSpecificCredentialResponse { } export namespace CreateServiceSpecificCredentialResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateServiceSpecificCredentialResponse): any => ({ ...obj, ...(obj.ServiceSpecificCredential && { @@ -1851,6 +2022,9 @@ export interface ServiceNotSupportedException extends __SmithyException, $Metada } export namespace ServiceNotSupportedException { + /** + * @internal + */ export const filterSensitiveLog = (obj: ServiceNotSupportedException): any => ({ ...obj, }); @@ -1895,6 +2069,9 @@ export interface CreateUserRequest { } export namespace CreateUserRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateUserRequest): any => ({ ...obj, }); @@ -1992,6 +2169,9 @@ export interface User { } export namespace User { + /** + * @internal + */ export const filterSensitiveLog = (obj: User): any => ({ ...obj, }); @@ -2008,6 +2188,9 @@ export interface CreateUserResponse { } export namespace CreateUserResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateUserResponse): any => ({ ...obj, }); @@ -2046,6 +2229,9 @@ export interface CreateVirtualMFADeviceRequest { } export namespace CreateVirtualMFADeviceRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateVirtualMFADeviceRequest): any => ({ ...obj, }); @@ -2093,6 +2279,9 @@ export interface VirtualMFADevice { } export namespace VirtualMFADevice { + /** + * @internal + */ export const filterSensitiveLog = (obj: VirtualMFADevice): any => ({ ...obj, ...(obj.Base32StringSeed && { Base32StringSeed: SENSITIVE_STRING }), @@ -2112,6 +2301,9 @@ export interface CreateVirtualMFADeviceResponse { } export namespace CreateVirtualMFADeviceResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateVirtualMFADeviceResponse): any => ({ ...obj, ...(obj.VirtualMFADevice && { VirtualMFADevice: VirtualMFADevice.filterSensitiveLog(obj.VirtualMFADevice) }), @@ -2137,6 +2329,9 @@ export interface DeactivateMFADeviceRequest { } export namespace DeactivateMFADeviceRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeactivateMFADeviceRequest): any => ({ ...obj, }); @@ -2160,6 +2355,9 @@ export interface DeleteAccessKeyRequest { } export namespace DeleteAccessKeyRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteAccessKeyRequest): any => ({ ...obj, }); @@ -2176,6 +2374,9 @@ export interface DeleteAccountAliasRequest { } export namespace DeleteAccountAliasRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteAccountAliasRequest): any => ({ ...obj, }); @@ -2192,6 +2393,9 @@ export interface DeleteConflictException extends __SmithyException, $MetadataBea } export namespace DeleteConflictException { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteConflictException): any => ({ ...obj, }); @@ -2207,6 +2411,9 @@ export interface DeleteGroupRequest { } export namespace DeleteGroupRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteGroupRequest): any => ({ ...obj, }); @@ -2230,6 +2437,9 @@ export interface DeleteGroupPolicyRequest { } export namespace DeleteGroupPolicyRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteGroupPolicyRequest): any => ({ ...obj, }); @@ -2245,6 +2455,9 @@ export interface DeleteInstanceProfileRequest { } export namespace DeleteInstanceProfileRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteInstanceProfileRequest): any => ({ ...obj, }); @@ -2260,6 +2473,9 @@ export interface DeleteLoginProfileRequest { } export namespace DeleteLoginProfileRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteLoginProfileRequest): any => ({ ...obj, }); @@ -2274,6 +2490,9 @@ export interface DeleteOpenIDConnectProviderRequest { } export namespace DeleteOpenIDConnectProviderRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteOpenIDConnectProviderRequest): any => ({ ...obj, }); @@ -2288,6 +2507,9 @@ export interface DeletePolicyRequest { } export namespace DeletePolicyRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeletePolicyRequest): any => ({ ...obj, }); @@ -2313,6 +2535,9 @@ export interface DeletePolicyVersionRequest { } export namespace DeletePolicyVersionRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeletePolicyVersionRequest): any => ({ ...obj, }); @@ -2328,6 +2553,9 @@ export interface DeleteRoleRequest { } export namespace DeleteRoleRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteRoleRequest): any => ({ ...obj, }); @@ -2342,6 +2570,9 @@ export interface DeleteRolePermissionsBoundaryRequest { } export namespace DeleteRolePermissionsBoundaryRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteRolePermissionsBoundaryRequest): any => ({ ...obj, }); @@ -2365,6 +2596,9 @@ export interface DeleteRolePolicyRequest { } export namespace DeleteRolePolicyRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteRolePolicyRequest): any => ({ ...obj, }); @@ -2378,6 +2612,9 @@ export interface DeleteSAMLProviderRequest { } export namespace DeleteSAMLProviderRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteSAMLProviderRequest): any => ({ ...obj, }); @@ -2393,6 +2630,9 @@ export interface DeleteServerCertificateRequest { } export namespace DeleteServerCertificateRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteServerCertificateRequest): any => ({ ...obj, }); @@ -2406,6 +2646,9 @@ export interface DeleteServiceLinkedRoleRequest { } export namespace DeleteServiceLinkedRoleRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteServiceLinkedRoleRequest): any => ({ ...obj, }); @@ -2421,6 +2664,9 @@ export interface DeleteServiceLinkedRoleResponse { } export namespace DeleteServiceLinkedRoleResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteServiceLinkedRoleResponse): any => ({ ...obj, }); @@ -2446,6 +2692,9 @@ export interface DeleteServiceSpecificCredentialRequest { } export namespace DeleteServiceSpecificCredentialRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteServiceSpecificCredentialRequest): any => ({ ...obj, }); @@ -2468,6 +2717,9 @@ export interface DeleteSigningCertificateRequest { } export namespace DeleteSigningCertificateRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteSigningCertificateRequest): any => ({ ...obj, }); @@ -2490,6 +2742,9 @@ export interface DeleteSSHPublicKeyRequest { } export namespace DeleteSSHPublicKeyRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteSSHPublicKeyRequest): any => ({ ...obj, }); @@ -2505,6 +2760,9 @@ export interface DeleteUserRequest { } export namespace DeleteUserRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteUserRequest): any => ({ ...obj, }); @@ -2519,6 +2777,9 @@ export interface DeleteUserPermissionsBoundaryRequest { } export namespace DeleteUserPermissionsBoundaryRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteUserPermissionsBoundaryRequest): any => ({ ...obj, }); @@ -2542,6 +2803,9 @@ export interface DeleteUserPolicyRequest { } export namespace DeleteUserPolicyRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteUserPolicyRequest): any => ({ ...obj, }); @@ -2559,6 +2823,9 @@ export interface DeleteVirtualMFADeviceRequest { } export namespace DeleteVirtualMFADeviceRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteVirtualMFADeviceRequest): any => ({ ...obj, }); @@ -2580,6 +2847,9 @@ export interface DetachGroupPolicyRequest { } export namespace DetachGroupPolicyRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DetachGroupPolicyRequest): any => ({ ...obj, }); @@ -2601,6 +2871,9 @@ export interface DetachRolePolicyRequest { } export namespace DetachRolePolicyRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DetachRolePolicyRequest): any => ({ ...obj, }); @@ -2622,6 +2895,9 @@ export interface DetachUserPolicyRequest { } export namespace DetachUserPolicyRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DetachUserPolicyRequest): any => ({ ...obj, }); @@ -2674,6 +2950,9 @@ export interface EnableMFADeviceRequest { } export namespace EnableMFADeviceRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: EnableMFADeviceRequest): any => ({ ...obj, }); @@ -2690,6 +2969,9 @@ export interface InvalidAuthenticationCodeException extends __SmithyException, $ } export namespace InvalidAuthenticationCodeException { + /** + * @internal + */ export const filterSensitiveLog = (obj: InvalidAuthenticationCodeException): any => ({ ...obj, }); @@ -2718,6 +3000,9 @@ export interface GenerateCredentialReportResponse { } export namespace GenerateCredentialReportResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: GenerateCredentialReportResponse): any => ({ ...obj, }); @@ -2744,6 +3029,9 @@ export interface GenerateOrganizationsAccessReportRequest { } export namespace GenerateOrganizationsAccessReportRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GenerateOrganizationsAccessReportRequest): any => ({ ...obj, }); @@ -2757,6 +3045,9 @@ export interface GenerateOrganizationsAccessReportResponse { } export namespace GenerateOrganizationsAccessReportResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: GenerateOrganizationsAccessReportResponse): any => ({ ...obj, }); @@ -2773,6 +3064,9 @@ export interface ReportGenerationLimitExceededException extends __SmithyExceptio } export namespace ReportGenerationLimitExceededException { + /** + * @internal + */ export const filterSensitiveLog = (obj: ReportGenerationLimitExceededException): any => ({ ...obj, }); @@ -2797,6 +3091,9 @@ export interface GenerateServiceLastAccessedDetailsRequest { } export namespace GenerateServiceLastAccessedDetailsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GenerateServiceLastAccessedDetailsRequest): any => ({ ...obj, }); @@ -2813,6 +3110,9 @@ export interface GenerateServiceLastAccessedDetailsResponse { } export namespace GenerateServiceLastAccessedDetailsResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: GenerateServiceLastAccessedDetailsResponse): any => ({ ...obj, }); @@ -2828,6 +3128,9 @@ export interface GetAccessKeyLastUsedRequest { } export namespace GetAccessKeyLastUsedRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetAccessKeyLastUsedRequest): any => ({ ...obj, }); @@ -2852,6 +3155,9 @@ export interface GetAccessKeyLastUsedResponse { } export namespace GetAccessKeyLastUsedResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetAccessKeyLastUsedResponse): any => ({ ...obj, }); @@ -2897,6 +3203,9 @@ export interface GetAccountAuthorizationDetailsRequest { } export namespace GetAccountAuthorizationDetailsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetAccountAuthorizationDetailsRequest): any => ({ ...obj, }); @@ -2919,6 +3228,9 @@ export interface PolicyDetail { } export namespace PolicyDetail { + /** + * @internal + */ export const filterSensitiveLog = (obj: PolicyDetail): any => ({ ...obj, }); @@ -2972,6 +3284,9 @@ export interface GroupDetail { } export namespace GroupDetail { + /** + * @internal + */ export const filterSensitiveLog = (obj: GroupDetail): any => ({ ...obj, }); @@ -3066,6 +3381,9 @@ export interface ManagedPolicyDetail { } export namespace ManagedPolicyDetail { + /** + * @internal + */ export const filterSensitiveLog = (obj: ManagedPolicyDetail): any => ({ ...obj, }); @@ -3154,6 +3472,9 @@ export interface RoleDetail { } export namespace RoleDetail { + /** + * @internal + */ export const filterSensitiveLog = (obj: RoleDetail): any => ({ ...obj, }); @@ -3226,6 +3547,9 @@ export interface UserDetail { } export namespace UserDetail { + /** + * @internal + */ export const filterSensitiveLog = (obj: UserDetail): any => ({ ...obj, }); @@ -3275,6 +3599,9 @@ export interface GetAccountAuthorizationDetailsResponse { } export namespace GetAccountAuthorizationDetailsResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetAccountAuthorizationDetailsResponse): any => ({ ...obj, }); @@ -3342,6 +3669,9 @@ export interface PasswordPolicy { } export namespace PasswordPolicy { + /** + * @internal + */ export const filterSensitiveLog = (obj: PasswordPolicy): any => ({ ...obj, }); @@ -3359,6 +3689,9 @@ export interface GetAccountPasswordPolicyResponse { } export namespace GetAccountPasswordPolicyResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetAccountPasswordPolicyResponse): any => ({ ...obj, }); @@ -3405,6 +3738,9 @@ export interface GetAccountSummaryResponse { } export namespace GetAccountSummaryResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetAccountSummaryResponse): any => ({ ...obj, }); @@ -3436,6 +3772,9 @@ export interface GetContextKeysForCustomPolicyRequest { } export namespace GetContextKeysForCustomPolicyRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetContextKeysForCustomPolicyRequest): any => ({ ...obj, }); @@ -3452,6 +3791,9 @@ export interface GetContextKeysForPolicyResponse { } export namespace GetContextKeysForPolicyResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetContextKeysForPolicyResponse): any => ({ ...obj, }); @@ -3494,6 +3836,9 @@ export interface GetContextKeysForPrincipalPolicyRequest { } export namespace GetContextKeysForPrincipalPolicyRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetContextKeysForPrincipalPolicyRequest): any => ({ ...obj, }); @@ -3512,6 +3857,9 @@ export interface CredentialReportExpiredException extends __SmithyException, $Me } export namespace CredentialReportExpiredException { + /** + * @internal + */ export const filterSensitiveLog = (obj: CredentialReportExpiredException): any => ({ ...obj, }); @@ -3528,6 +3876,9 @@ export interface CredentialReportNotPresentException extends __SmithyException, } export namespace CredentialReportNotPresentException { + /** + * @internal + */ export const filterSensitiveLog = (obj: CredentialReportNotPresentException): any => ({ ...obj, }); @@ -3543,6 +3894,9 @@ export interface CredentialReportNotReadyException extends __SmithyException, $M } export namespace CredentialReportNotReadyException { + /** + * @internal + */ export const filterSensitiveLog = (obj: CredentialReportNotReadyException): any => ({ ...obj, }); @@ -3572,6 +3926,9 @@ export interface GetCredentialReportResponse { } export namespace GetCredentialReportResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetCredentialReportResponse): any => ({ ...obj, }); @@ -3607,6 +3964,9 @@ export interface GetGroupRequest { } export namespace GetGroupRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetGroupRequest): any => ({ ...obj, }); @@ -3645,6 +4005,9 @@ export interface GetGroupResponse { } export namespace GetGroupResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetGroupResponse): any => ({ ...obj, }); @@ -3667,6 +4030,9 @@ export interface GetGroupPolicyRequest { } export namespace GetGroupPolicyRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetGroupPolicyRequest): any => ({ ...obj, }); @@ -3697,6 +4063,9 @@ export interface GetGroupPolicyResponse { } export namespace GetGroupPolicyResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetGroupPolicyResponse): any => ({ ...obj, }); @@ -3712,6 +4081,9 @@ export interface GetInstanceProfileRequest { } export namespace GetInstanceProfileRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetInstanceProfileRequest): any => ({ ...obj, }); @@ -3729,6 +4101,9 @@ export interface GetInstanceProfileResponse { } export namespace GetInstanceProfileResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetInstanceProfileResponse): any => ({ ...obj, }); @@ -3744,6 +4119,9 @@ export interface GetLoginProfileRequest { } export namespace GetLoginProfileRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetLoginProfileRequest): any => ({ ...obj, }); @@ -3761,6 +4139,9 @@ export interface GetLoginProfileResponse { } export namespace GetLoginProfileResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetLoginProfileResponse): any => ({ ...obj, }); @@ -3776,6 +4157,9 @@ export interface GetOpenIDConnectProviderRequest { } export namespace GetOpenIDConnectProviderRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetOpenIDConnectProviderRequest): any => ({ ...obj, }); @@ -3819,6 +4203,9 @@ export interface GetOpenIDConnectProviderResponse { } export namespace GetOpenIDConnectProviderResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetOpenIDConnectProviderResponse): any => ({ ...obj, }); @@ -3866,6 +4253,9 @@ export interface GetOrganizationsAccessReportRequest { } export namespace GetOrganizationsAccessReportRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetOrganizationsAccessReportRequest): any => ({ ...obj, }); @@ -3888,6 +4278,9 @@ export interface ErrorDetails { } export namespace ErrorDetails { + /** + * @internal + */ export const filterSensitiveLog = (obj: ErrorDetails): any => ({ ...obj, }); @@ -3958,6 +4351,9 @@ export interface GetOrganizationsAccessReportResponse { } export namespace GetOrganizationsAccessReportResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetOrganizationsAccessReportResponse): any => ({ ...obj, }); @@ -3973,6 +4369,9 @@ export interface GetPolicyRequest { } export namespace GetPolicyRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetPolicyRequest): any => ({ ...obj, }); @@ -3989,6 +4388,9 @@ export interface GetPolicyResponse { } export namespace GetPolicyResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetPolicyResponse): any => ({ ...obj, }); @@ -4012,6 +4414,9 @@ export interface GetPolicyVersionRequest { } export namespace GetPolicyVersionRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetPolicyVersionRequest): any => ({ ...obj, }); @@ -4029,6 +4434,9 @@ export interface GetPolicyVersionResponse { } export namespace GetPolicyVersionResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetPolicyVersionResponse): any => ({ ...obj, }); @@ -4044,6 +4452,9 @@ export interface GetRoleRequest { } export namespace GetRoleRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetRoleRequest): any => ({ ...obj, }); @@ -4060,6 +4471,9 @@ export interface GetRoleResponse { } export namespace GetRoleResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetRoleResponse): any => ({ ...obj, }); @@ -4082,6 +4496,9 @@ export interface GetRolePolicyRequest { } export namespace GetRolePolicyRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetRolePolicyRequest): any => ({ ...obj, }); @@ -4112,6 +4529,9 @@ export interface GetRolePolicyResponse { } export namespace GetRolePolicyResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetRolePolicyResponse): any => ({ ...obj, }); @@ -4127,6 +4547,9 @@ export interface GetSAMLProviderRequest { } export namespace GetSAMLProviderRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetSAMLProviderRequest): any => ({ ...obj, }); @@ -4161,6 +4584,9 @@ export interface GetSAMLProviderResponse { } export namespace GetSAMLProviderResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetSAMLProviderResponse): any => ({ ...obj, }); @@ -4176,6 +4602,9 @@ export interface GetServerCertificateRequest { } export namespace GetServerCertificateRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetServerCertificateRequest): any => ({ ...obj, }); @@ -4224,6 +4653,9 @@ export interface ServerCertificateMetadata { } export namespace ServerCertificateMetadata { + /** + * @internal + */ export const filterSensitiveLog = (obj: ServerCertificateMetadata): any => ({ ...obj, }); @@ -4258,6 +4690,9 @@ export interface ServerCertificate { } export namespace ServerCertificate { + /** + * @internal + */ export const filterSensitiveLog = (obj: ServerCertificate): any => ({ ...obj, }); @@ -4275,6 +4710,9 @@ export interface GetServerCertificateResponse { } export namespace GetServerCertificateResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetServerCertificateResponse): any => ({ ...obj, }); @@ -4311,6 +4749,9 @@ export interface GetServiceLastAccessedDetailsRequest { } export namespace GetServiceLastAccessedDetailsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetServiceLastAccessedDetailsRequest): any => ({ ...obj, }); @@ -4353,6 +4794,9 @@ export interface TrackedActionLastAccessed { } export namespace TrackedActionLastAccessed { + /** + * @internal + */ export const filterSensitiveLog = (obj: TrackedActionLastAccessed): any => ({ ...obj, }); @@ -4423,6 +4867,9 @@ export interface ServiceLastAccessed { } export namespace ServiceLastAccessed { + /** + * @internal + */ export const filterSensitiveLog = (obj: ServiceLastAccessed): any => ({ ...obj, }); @@ -4485,6 +4932,9 @@ export interface GetServiceLastAccessedDetailsResponse { } export namespace GetServiceLastAccessedDetailsResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetServiceLastAccessedDetailsResponse): any => ({ ...obj, }); @@ -4531,6 +4981,9 @@ export interface GetServiceLastAccessedDetailsWithEntitiesRequest { } export namespace GetServiceLastAccessedDetailsWithEntitiesRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetServiceLastAccessedDetailsWithEntitiesRequest): any => ({ ...obj, }); @@ -4577,6 +5030,9 @@ export interface EntityInfo { } export namespace EntityInfo { + /** + * @internal + */ export const filterSensitiveLog = (obj: EntityInfo): any => ({ ...obj, }); @@ -4605,6 +5061,9 @@ export interface EntityDetails { } export namespace EntityDetails { + /** + * @internal + */ export const filterSensitiveLog = (obj: EntityDetails): any => ({ ...obj, }); @@ -4661,6 +5120,9 @@ export interface GetServiceLastAccessedDetailsWithEntitiesResponse { } export namespace GetServiceLastAccessedDetailsWithEntitiesResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetServiceLastAccessedDetailsWithEntitiesResponse): any => ({ ...obj, }); @@ -4675,6 +5137,9 @@ export interface GetServiceLinkedRoleDeletionStatusRequest { } export namespace GetServiceLinkedRoleDeletionStatusRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetServiceLinkedRoleDeletionStatusRequest): any => ({ ...obj, }); @@ -4698,6 +5163,9 @@ export interface RoleUsageType { } export namespace RoleUsageType { + /** + * @internal + */ export const filterSensitiveLog = (obj: RoleUsageType): any => ({ ...obj, }); @@ -4725,6 +5193,9 @@ export interface DeletionTaskFailureReasonType { } export namespace DeletionTaskFailureReasonType { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeletionTaskFailureReasonType): any => ({ ...obj, }); @@ -4750,6 +5221,9 @@ export interface GetServiceLinkedRoleDeletionStatusResponse { } export namespace GetServiceLinkedRoleDeletionStatusResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetServiceLinkedRoleDeletionStatusResponse): any => ({ ...obj, }); @@ -4781,6 +5255,9 @@ export interface GetSSHPublicKeyRequest { } export namespace GetSSHPublicKeyRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetSSHPublicKeyRequest): any => ({ ...obj, }); @@ -4827,6 +5304,9 @@ export interface SSHPublicKey { } export namespace SSHPublicKey { + /** + * @internal + */ export const filterSensitiveLog = (obj: SSHPublicKey): any => ({ ...obj, }); @@ -4844,6 +5324,9 @@ export interface GetSSHPublicKeyResponse { } export namespace GetSSHPublicKeyResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetSSHPublicKeyResponse): any => ({ ...obj, }); @@ -4860,6 +5343,9 @@ export interface UnrecognizedPublicKeyEncodingException extends __SmithyExceptio } export namespace UnrecognizedPublicKeyEncodingException { + /** + * @internal + */ export const filterSensitiveLog = (obj: UnrecognizedPublicKeyEncodingException): any => ({ ...obj, }); @@ -4876,6 +5362,9 @@ export interface GetUserRequest { } export namespace GetUserRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetUserRequest): any => ({ ...obj, }); @@ -4907,6 +5396,9 @@ export interface GetUserResponse { } export namespace GetUserResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetUserResponse): any => ({ ...obj, }); @@ -4929,6 +5421,9 @@ export interface GetUserPolicyRequest { } export namespace GetUserPolicyRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetUserPolicyRequest): any => ({ ...obj, }); @@ -4959,6 +5454,9 @@ export interface GetUserPolicyResponse { } export namespace GetUserPolicyResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetUserPolicyResponse): any => ({ ...obj, }); @@ -4994,6 +5492,9 @@ export interface ListAccessKeysRequest { } export namespace ListAccessKeysRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListAccessKeysRequest): any => ({ ...obj, }); @@ -5028,6 +5529,9 @@ export interface ListAccessKeysResponse { } export namespace ListAccessKeysResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListAccessKeysResponse): any => ({ ...obj, }); @@ -5056,6 +5560,9 @@ export interface ListAccountAliasesRequest { } export namespace ListAccountAliasesRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListAccountAliasesRequest): any => ({ ...obj, }); @@ -5091,6 +5598,9 @@ export interface ListAccountAliasesResponse { } export namespace ListAccountAliasesResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListAccountAliasesResponse): any => ({ ...obj, }); @@ -5136,6 +5646,9 @@ export interface ListAttachedGroupPoliciesRequest { } export namespace ListAttachedGroupPoliciesRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListAttachedGroupPoliciesRequest): any => ({ ...obj, }); @@ -5170,6 +5683,9 @@ export interface ListAttachedGroupPoliciesResponse { } export namespace ListAttachedGroupPoliciesResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListAttachedGroupPoliciesResponse): any => ({ ...obj, }); @@ -5215,6 +5731,9 @@ export interface ListAttachedRolePoliciesRequest { } export namespace ListAttachedRolePoliciesRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListAttachedRolePoliciesRequest): any => ({ ...obj, }); @@ -5249,6 +5768,9 @@ export interface ListAttachedRolePoliciesResponse { } export namespace ListAttachedRolePoliciesResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListAttachedRolePoliciesResponse): any => ({ ...obj, }); @@ -5294,6 +5816,9 @@ export interface ListAttachedUserPoliciesRequest { } export namespace ListAttachedUserPoliciesRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListAttachedUserPoliciesRequest): any => ({ ...obj, }); @@ -5328,6 +5853,9 @@ export interface ListAttachedUserPoliciesResponse { } export namespace ListAttachedUserPoliciesResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListAttachedUserPoliciesResponse): any => ({ ...obj, }); @@ -5394,6 +5922,9 @@ export interface ListEntitiesForPolicyRequest { } export namespace ListEntitiesForPolicyRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListEntitiesForPolicyRequest): any => ({ ...obj, }); @@ -5420,6 +5951,9 @@ export interface PolicyGroup { } export namespace PolicyGroup { + /** + * @internal + */ export const filterSensitiveLog = (obj: PolicyGroup): any => ({ ...obj, }); @@ -5446,6 +5980,9 @@ export interface PolicyRole { } export namespace PolicyRole { + /** + * @internal + */ export const filterSensitiveLog = (obj: PolicyRole): any => ({ ...obj, }); @@ -5472,6 +6009,9 @@ export interface PolicyUser { } export namespace PolicyUser { + /** + * @internal + */ export const filterSensitiveLog = (obj: PolicyUser): any => ({ ...obj, }); @@ -5516,6 +6056,9 @@ export interface ListEntitiesForPolicyResponse { } export namespace ListEntitiesForPolicyResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListEntitiesForPolicyResponse): any => ({ ...obj, }); @@ -5551,6 +6094,9 @@ export interface ListGroupPoliciesRequest { } export namespace ListGroupPoliciesRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListGroupPoliciesRequest): any => ({ ...obj, }); @@ -5587,6 +6133,9 @@ export interface ListGroupPoliciesResponse { } export namespace ListGroupPoliciesResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListGroupPoliciesResponse): any => ({ ...obj, }); @@ -5627,6 +6176,9 @@ export interface ListGroupsRequest { } export namespace ListGroupsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListGroupsRequest): any => ({ ...obj, }); @@ -5660,6 +6212,9 @@ export interface ListGroupsResponse { } export namespace ListGroupsResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListGroupsResponse): any => ({ ...obj, }); @@ -5695,6 +6250,9 @@ export interface ListGroupsForUserRequest { } export namespace ListGroupsForUserRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListGroupsForUserRequest): any => ({ ...obj, }); @@ -5729,6 +6287,9 @@ export interface ListGroupsForUserResponse { } export namespace ListGroupsForUserResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListGroupsForUserResponse): any => ({ ...obj, }); @@ -5769,6 +6330,9 @@ export interface ListInstanceProfilesRequest { } export namespace ListInstanceProfilesRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListInstanceProfilesRequest): any => ({ ...obj, }); @@ -5803,6 +6367,9 @@ export interface ListInstanceProfilesResponse { } export namespace ListInstanceProfilesResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListInstanceProfilesResponse): any => ({ ...obj, }); @@ -5838,6 +6405,9 @@ export interface ListInstanceProfilesForRoleRequest { } export namespace ListInstanceProfilesForRoleRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListInstanceProfilesForRoleRequest): any => ({ ...obj, }); @@ -5872,6 +6442,9 @@ export interface ListInstanceProfilesForRoleResponse { } export namespace ListInstanceProfilesForRoleResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListInstanceProfilesForRoleResponse): any => ({ ...obj, }); @@ -5906,6 +6479,9 @@ export interface ListInstanceProfileTagsRequest { } export namespace ListInstanceProfileTagsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListInstanceProfileTagsRequest): any => ({ ...obj, }); @@ -5934,6 +6510,9 @@ export interface ListInstanceProfileTagsResponse { } export namespace ListInstanceProfileTagsResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListInstanceProfileTagsResponse): any => ({ ...obj, }); @@ -5969,6 +6548,9 @@ export interface ListMFADevicesRequest { } export namespace ListMFADevicesRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListMFADevicesRequest): any => ({ ...obj, }); @@ -5998,6 +6580,9 @@ export interface MFADevice { } export namespace MFADevice { + /** + * @internal + */ export const filterSensitiveLog = (obj: MFADevice): any => ({ ...obj, }); @@ -6032,6 +6617,9 @@ export interface ListMFADevicesResponse { } export namespace ListMFADevicesResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListMFADevicesResponse): any => ({ ...obj, }); @@ -6067,6 +6655,9 @@ export interface ListMFADeviceTagsRequest { } export namespace ListMFADeviceTagsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListMFADeviceTagsRequest): any => ({ ...obj, }); @@ -6095,6 +6686,9 @@ export interface ListMFADeviceTagsResponse { } export namespace ListMFADeviceTagsResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListMFADeviceTagsResponse): any => ({ ...obj, }); @@ -6103,6 +6697,9 @@ export namespace ListMFADeviceTagsResponse { export interface ListOpenIDConnectProvidersRequest {} export namespace ListOpenIDConnectProvidersRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListOpenIDConnectProvidersRequest): any => ({ ...obj, }); @@ -6121,6 +6718,9 @@ export interface OpenIDConnectProviderListEntry { } export namespace OpenIDConnectProviderListEntry { + /** + * @internal + */ export const filterSensitiveLog = (obj: OpenIDConnectProviderListEntry): any => ({ ...obj, }); @@ -6138,6 +6738,9 @@ export interface ListOpenIDConnectProvidersResponse { } export namespace ListOpenIDConnectProvidersResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListOpenIDConnectProvidersResponse): any => ({ ...obj, }); @@ -6173,6 +6776,9 @@ export interface ListOpenIDConnectProviderTagsRequest { } export namespace ListOpenIDConnectProviderTagsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListOpenIDConnectProviderTagsRequest): any => ({ ...obj, }); @@ -6202,6 +6808,9 @@ export interface ListOpenIDConnectProviderTagsResponse { } export namespace ListOpenIDConnectProviderTagsResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListOpenIDConnectProviderTagsResponse): any => ({ ...obj, }); @@ -6274,6 +6883,9 @@ export interface ListPoliciesRequest { } export namespace ListPoliciesRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListPoliciesRequest): any => ({ ...obj, }); @@ -6308,6 +6920,9 @@ export interface ListPoliciesResponse { } export namespace ListPoliciesResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListPoliciesResponse): any => ({ ...obj, }); @@ -6341,6 +6956,9 @@ export interface ListPoliciesGrantingServiceAccessRequest { } export namespace ListPoliciesGrantingServiceAccessRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListPoliciesGrantingServiceAccessRequest): any => ({ ...obj, }); @@ -6395,6 +7013,9 @@ export interface PolicyGrantingServiceAccess { } export namespace PolicyGrantingServiceAccess { + /** + * @internal + */ export const filterSensitiveLog = (obj: PolicyGrantingServiceAccess): any => ({ ...obj, }); @@ -6425,6 +7046,9 @@ export interface ListPoliciesGrantingServiceAccessEntry { } export namespace ListPoliciesGrantingServiceAccessEntry { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListPoliciesGrantingServiceAccessEntry): any => ({ ...obj, }); @@ -6456,6 +7080,9 @@ export interface ListPoliciesGrantingServiceAccessResponse { } export namespace ListPoliciesGrantingServiceAccessResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListPoliciesGrantingServiceAccessResponse): any => ({ ...obj, }); @@ -6490,6 +7117,9 @@ export interface ListPolicyTagsRequest { } export namespace ListPolicyTagsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListPolicyTagsRequest): any => ({ ...obj, }); @@ -6519,6 +7149,9 @@ export interface ListPolicyTagsResponse { } export namespace ListPolicyTagsResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListPolicyTagsResponse): any => ({ ...obj, }); @@ -6554,6 +7187,9 @@ export interface ListPolicyVersionsRequest { } export namespace ListPolicyVersionsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListPolicyVersionsRequest): any => ({ ...obj, }); @@ -6590,6 +7226,9 @@ export interface ListPolicyVersionsResponse { } export namespace ListPolicyVersionsResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListPolicyVersionsResponse): any => ({ ...obj, }); @@ -6625,6 +7264,9 @@ export interface ListRolePoliciesRequest { } export namespace ListRolePoliciesRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListRolePoliciesRequest): any => ({ ...obj, }); @@ -6659,6 +7301,9 @@ export interface ListRolePoliciesResponse { } export namespace ListRolePoliciesResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListRolePoliciesResponse): any => ({ ...obj, }); @@ -6699,6 +7344,9 @@ export interface ListRolesRequest { } export namespace ListRolesRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListRolesRequest): any => ({ ...obj, }); @@ -6732,6 +7380,9 @@ export interface ListRolesResponse { } export namespace ListRolesResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListRolesResponse): any => ({ ...obj, }); @@ -6766,6 +7417,9 @@ export interface ListRoleTagsRequest { } export namespace ListRoleTagsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListRoleTagsRequest): any => ({ ...obj, }); @@ -6794,6 +7448,9 @@ export interface ListRoleTagsResponse { } export namespace ListRoleTagsResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListRoleTagsResponse): any => ({ ...obj, }); @@ -6802,6 +7459,9 @@ export namespace ListRoleTagsResponse { export interface ListSAMLProvidersRequest {} export namespace ListSAMLProvidersRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListSAMLProvidersRequest): any => ({ ...obj, }); @@ -6828,6 +7488,9 @@ export interface SAMLProviderListEntry { } export namespace SAMLProviderListEntry { + /** + * @internal + */ export const filterSensitiveLog = (obj: SAMLProviderListEntry): any => ({ ...obj, }); @@ -6846,6 +7509,9 @@ export interface ListSAMLProvidersResponse { } export namespace ListSAMLProvidersResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListSAMLProvidersResponse): any => ({ ...obj, }); @@ -6881,6 +7547,9 @@ export interface ListSAMLProviderTagsRequest { } export namespace ListSAMLProviderTagsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListSAMLProviderTagsRequest): any => ({ ...obj, }); @@ -6910,6 +7579,9 @@ export interface ListSAMLProviderTagsResponse { } export namespace ListSAMLProviderTagsResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListSAMLProviderTagsResponse): any => ({ ...obj, }); @@ -6950,6 +7622,9 @@ export interface ListServerCertificatesRequest { } export namespace ListServerCertificatesRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListServerCertificatesRequest): any => ({ ...obj, }); @@ -6984,6 +7659,9 @@ export interface ListServerCertificatesResponse { } export namespace ListServerCertificatesResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListServerCertificatesResponse): any => ({ ...obj, }); @@ -7018,6 +7696,9 @@ export interface ListServerCertificateTagsRequest { } export namespace ListServerCertificateTagsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListServerCertificateTagsRequest): any => ({ ...obj, }); @@ -7047,6 +7728,9 @@ export interface ListServerCertificateTagsResponse { } export namespace ListServerCertificateTagsResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListServerCertificateTagsResponse): any => ({ ...obj, }); @@ -7070,6 +7754,9 @@ export interface ListServiceSpecificCredentialsRequest { } export namespace ListServiceSpecificCredentialsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListServiceSpecificCredentialsRequest): any => ({ ...obj, }); @@ -7113,6 +7800,9 @@ export interface ServiceSpecificCredentialMetadata { } export namespace ServiceSpecificCredentialMetadata { + /** + * @internal + */ export const filterSensitiveLog = (obj: ServiceSpecificCredentialMetadata): any => ({ ...obj, }); @@ -7127,6 +7817,9 @@ export interface ListServiceSpecificCredentialsResponse { } export namespace ListServiceSpecificCredentialsResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListServiceSpecificCredentialsResponse): any => ({ ...obj, }); @@ -7162,6 +7855,9 @@ export interface ListSigningCertificatesRequest { } export namespace ListSigningCertificatesRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListSigningCertificatesRequest): any => ({ ...obj, }); @@ -7201,6 +7897,9 @@ export interface SigningCertificate { } export namespace SigningCertificate { + /** + * @internal + */ export const filterSensitiveLog = (obj: SigningCertificate): any => ({ ...obj, }); @@ -7235,6 +7934,9 @@ export interface ListSigningCertificatesResponse { } export namespace ListSigningCertificatesResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListSigningCertificatesResponse): any => ({ ...obj, }); @@ -7272,6 +7974,9 @@ export interface ListSSHPublicKeysRequest { } export namespace ListSSHPublicKeysRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListSSHPublicKeysRequest): any => ({ ...obj, }); @@ -7309,6 +8014,9 @@ export interface SSHPublicKeyMetadata { } export namespace SSHPublicKeyMetadata { + /** + * @internal + */ export const filterSensitiveLog = (obj: SSHPublicKeyMetadata): any => ({ ...obj, }); @@ -7343,6 +8051,9 @@ export interface ListSSHPublicKeysResponse { } export namespace ListSSHPublicKeysResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListSSHPublicKeysResponse): any => ({ ...obj, }); @@ -7378,6 +8089,9 @@ export interface ListUserPoliciesRequest { } export namespace ListUserPoliciesRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListUserPoliciesRequest): any => ({ ...obj, }); @@ -7412,6 +8126,9 @@ export interface ListUserPoliciesResponse { } export namespace ListUserPoliciesResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListUserPoliciesResponse): any => ({ ...obj, }); @@ -7452,6 +8169,9 @@ export interface ListUsersRequest { } export namespace ListUsersRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListUsersRequest): any => ({ ...obj, }); @@ -7485,6 +8205,9 @@ export interface ListUsersResponse { } export namespace ListUsersResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListUsersResponse): any => ({ ...obj, }); @@ -7519,6 +8242,9 @@ export interface ListUserTagsRequest { } export namespace ListUserTagsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListUserTagsRequest): any => ({ ...obj, }); @@ -7547,6 +8273,9 @@ export interface ListUserTagsResponse { } export namespace ListUserTagsResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListUserTagsResponse): any => ({ ...obj, }); @@ -7583,6 +8312,9 @@ export interface ListVirtualMFADevicesRequest { } export namespace ListVirtualMFADevicesRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListVirtualMFADevicesRequest): any => ({ ...obj, }); @@ -7618,6 +8350,9 @@ export interface ListVirtualMFADevicesResponse { } export namespace ListVirtualMFADevicesResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListVirtualMFADevicesResponse): any => ({ ...obj, ...(obj.VirtualMFADevices && { @@ -7668,6 +8403,9 @@ export interface PutGroupPolicyRequest { } export namespace PutGroupPolicyRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: PutGroupPolicyRequest): any => ({ ...obj, }); @@ -7688,6 +8426,9 @@ export interface PutRolePermissionsBoundaryRequest { } export namespace PutRolePermissionsBoundaryRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: PutRolePermissionsBoundaryRequest): any => ({ ...obj, }); @@ -7735,6 +8476,9 @@ export interface PutRolePolicyRequest { } export namespace PutRolePolicyRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: PutRolePolicyRequest): any => ({ ...obj, }); @@ -7755,6 +8499,9 @@ export interface PutUserPermissionsBoundaryRequest { } export namespace PutUserPermissionsBoundaryRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: PutUserPermissionsBoundaryRequest): any => ({ ...obj, }); @@ -7802,6 +8549,9 @@ export interface PutUserPolicyRequest { } export namespace PutUserPolicyRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: PutUserPolicyRequest): any => ({ ...obj, }); @@ -7823,6 +8573,9 @@ export interface RemoveClientIDFromOpenIDConnectProviderRequest { } export namespace RemoveClientIDFromOpenIDConnectProviderRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: RemoveClientIDFromOpenIDConnectProviderRequest): any => ({ ...obj, }); @@ -7845,6 +8598,9 @@ export interface RemoveRoleFromInstanceProfileRequest { } export namespace RemoveRoleFromInstanceProfileRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: RemoveRoleFromInstanceProfileRequest): any => ({ ...obj, }); @@ -7867,6 +8623,9 @@ export interface RemoveUserFromGroupRequest { } export namespace RemoveUserFromGroupRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: RemoveUserFromGroupRequest): any => ({ ...obj, }); @@ -7891,6 +8650,9 @@ export interface ResetServiceSpecificCredentialRequest { } export namespace ResetServiceSpecificCredentialRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ResetServiceSpecificCredentialRequest): any => ({ ...obj, }); @@ -7909,6 +8671,9 @@ export interface ResetServiceSpecificCredentialResponse { } export namespace ResetServiceSpecificCredentialResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ResetServiceSpecificCredentialResponse): any => ({ ...obj, ...(obj.ServiceSpecificCredential && { @@ -7946,6 +8711,9 @@ export interface ResyncMFADeviceRequest { } export namespace ResyncMFADeviceRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ResyncMFADeviceRequest): any => ({ ...obj, }); @@ -7968,6 +8736,9 @@ export interface SetDefaultPolicyVersionRequest { } export namespace SetDefaultPolicyVersionRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: SetDefaultPolicyVersionRequest): any => ({ ...obj, }); @@ -7993,6 +8764,9 @@ export interface SetSecurityTokenServicePreferencesRequest { } export namespace SetSecurityTokenServicePreferencesRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: SetSecurityTokenServicePreferencesRequest): any => ({ ...obj, }); @@ -8009,6 +8783,9 @@ export interface PolicyEvaluationException extends __SmithyException, $MetadataB } export namespace PolicyEvaluationException { + /** + * @internal + */ export const filterSensitiveLog = (obj: PolicyEvaluationException): any => ({ ...obj, }); @@ -8058,6 +8835,9 @@ export interface ContextEntry { } export namespace ContextEntry { + /** + * @internal + */ export const filterSensitiveLog = (obj: ContextEntry): any => ({ ...obj, }); @@ -8276,6 +9056,9 @@ export interface SimulateCustomPolicyRequest { } export namespace SimulateCustomPolicyRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: SimulateCustomPolicyRequest): any => ({ ...obj, }); @@ -8307,6 +9090,9 @@ export interface Position { } export namespace Position { + /** + * @internal + */ export const filterSensitiveLog = (obj: Position): any => ({ ...obj, }); @@ -8353,6 +9139,9 @@ export interface Statement { } export namespace Statement { + /** + * @internal + */ export const filterSensitiveLog = (obj: Statement): any => ({ ...obj, }); @@ -8370,6 +9159,9 @@ export interface OrganizationsDecisionDetail { } export namespace OrganizationsDecisionDetail { + /** + * @internal + */ export const filterSensitiveLog = (obj: OrganizationsDecisionDetail): any => ({ ...obj, }); @@ -8394,6 +9186,9 @@ export interface PermissionsBoundaryDecisionDetail { } export namespace PermissionsBoundaryDecisionDetail { + /** + * @internal + */ export const filterSensitiveLog = (obj: PermissionsBoundaryDecisionDetail): any => ({ ...obj, }); @@ -8453,6 +9248,9 @@ export interface ResourceSpecificResult { } export namespace ResourceSpecificResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: ResourceSpecificResult): any => ({ ...obj, }); @@ -8538,6 +9336,9 @@ export interface EvaluationResult { } export namespace EvaluationResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: EvaluationResult): any => ({ ...obj, }); @@ -8572,6 +9373,9 @@ export interface SimulatePolicyResponse { } export namespace SimulatePolicyResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: SimulatePolicyResponse): any => ({ ...obj, }); @@ -8801,6 +9605,9 @@ export interface SimulatePrincipalPolicyRequest { } export namespace SimulatePrincipalPolicyRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: SimulatePrincipalPolicyRequest): any => ({ ...obj, }); @@ -8822,6 +9629,9 @@ export interface TagInstanceProfileRequest { } export namespace TagInstanceProfileRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: TagInstanceProfileRequest): any => ({ ...obj, }); @@ -8844,6 +9654,9 @@ export interface TagMFADeviceRequest { } export namespace TagMFADeviceRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: TagMFADeviceRequest): any => ({ ...obj, }); @@ -8865,6 +9678,9 @@ export interface TagOpenIDConnectProviderRequest { } export namespace TagOpenIDConnectProviderRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: TagOpenIDConnectProviderRequest): any => ({ ...obj, }); @@ -8886,6 +9702,9 @@ export interface TagPolicyRequest { } export namespace TagPolicyRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: TagPolicyRequest): any => ({ ...obj, }); @@ -8906,6 +9725,9 @@ export interface TagRoleRequest { } export namespace TagRoleRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: TagRoleRequest): any => ({ ...obj, }); @@ -8927,6 +9749,9 @@ export interface TagSAMLProviderRequest { } export namespace TagSAMLProviderRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: TagSAMLProviderRequest): any => ({ ...obj, }); @@ -8948,6 +9773,9 @@ export interface TagServerCertificateRequest { } export namespace TagServerCertificateRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: TagServerCertificateRequest): any => ({ ...obj, }); @@ -8968,6 +9796,9 @@ export interface TagUserRequest { } export namespace TagUserRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: TagUserRequest): any => ({ ...obj, }); @@ -8989,6 +9820,9 @@ export interface UntagInstanceProfileRequest { } export namespace UntagInstanceProfileRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: UntagInstanceProfileRequest): any => ({ ...obj, }); @@ -9011,6 +9845,9 @@ export interface UntagMFADeviceRequest { } export namespace UntagMFADeviceRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: UntagMFADeviceRequest): any => ({ ...obj, }); @@ -9032,6 +9869,9 @@ export interface UntagOpenIDConnectProviderRequest { } export namespace UntagOpenIDConnectProviderRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: UntagOpenIDConnectProviderRequest): any => ({ ...obj, }); diff --git a/clients/client-iam/models/models_1.ts b/clients/client-iam/models/models_1.ts index da04fd704ac9..f7db7dd93a9e 100644 --- a/clients/client-iam/models/models_1.ts +++ b/clients/client-iam/models/models_1.ts @@ -19,6 +19,9 @@ export interface UntagPolicyRequest { } export namespace UntagPolicyRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: UntagPolicyRequest): any => ({ ...obj, }); @@ -40,6 +43,9 @@ export interface UntagRoleRequest { } export namespace UntagRoleRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: UntagRoleRequest): any => ({ ...obj, }); @@ -62,6 +68,9 @@ export interface UntagSAMLProviderRequest { } export namespace UntagSAMLProviderRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: UntagSAMLProviderRequest): any => ({ ...obj, }); @@ -83,6 +92,9 @@ export interface UntagServerCertificateRequest { } export namespace UntagServerCertificateRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: UntagServerCertificateRequest): any => ({ ...obj, }); @@ -104,6 +116,9 @@ export interface UntagUserRequest { } export namespace UntagUserRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: UntagUserRequest): any => ({ ...obj, }); @@ -133,6 +148,9 @@ export interface UpdateAccessKeyRequest { } export namespace UpdateAccessKeyRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateAccessKeyRequest): any => ({ ...obj, }); @@ -220,6 +238,9 @@ export interface UpdateAccountPasswordPolicyRequest { } export namespace UpdateAccountPasswordPolicyRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateAccountPasswordPolicyRequest): any => ({ ...obj, }); @@ -260,6 +281,9 @@ export interface UpdateAssumeRolePolicyRequest { } export namespace UpdateAssumeRolePolicyRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateAssumeRolePolicyRequest): any => ({ ...obj, }); @@ -293,6 +317,9 @@ export interface UpdateGroupRequest { } export namespace UpdateGroupRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateGroupRequest): any => ({ ...obj, }); @@ -337,6 +364,9 @@ export interface UpdateLoginProfileRequest { } export namespace UpdateLoginProfileRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateLoginProfileRequest): any => ({ ...obj, ...(obj.Password && { Password: SENSITIVE_STRING }), @@ -360,6 +390,9 @@ export interface UpdateOpenIDConnectProviderThumbprintRequest { } export namespace UpdateOpenIDConnectProviderThumbprintRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateOpenIDConnectProviderThumbprintRequest): any => ({ ...obj, }); @@ -395,6 +428,9 @@ export interface UpdateRoleRequest { } export namespace UpdateRoleRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateRoleRequest): any => ({ ...obj, }); @@ -403,6 +439,9 @@ export namespace UpdateRoleRequest { export interface UpdateRoleResponse {} export namespace UpdateRoleResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateRoleResponse): any => ({ ...obj, }); @@ -421,6 +460,9 @@ export interface UpdateRoleDescriptionRequest { } export namespace UpdateRoleDescriptionRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateRoleDescriptionRequest): any => ({ ...obj, }); @@ -434,6 +476,9 @@ export interface UpdateRoleDescriptionResponse { } export namespace UpdateRoleDescriptionResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateRoleDescriptionResponse): any => ({ ...obj, }); @@ -457,6 +502,9 @@ export interface UpdateSAMLProviderRequest { } export namespace UpdateSAMLProviderRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateSAMLProviderRequest): any => ({ ...obj, }); @@ -474,6 +522,9 @@ export interface UpdateSAMLProviderResponse { } export namespace UpdateSAMLProviderResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateSAMLProviderResponse): any => ({ ...obj, }); @@ -507,6 +558,9 @@ export interface UpdateServerCertificateRequest { } export namespace UpdateServerCertificateRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateServerCertificateRequest): any => ({ ...obj, }); @@ -536,6 +590,9 @@ export interface UpdateServiceSpecificCredentialRequest { } export namespace UpdateServiceSpecificCredentialRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateServiceSpecificCredentialRequest): any => ({ ...obj, }); @@ -565,6 +622,9 @@ export interface UpdateSigningCertificateRequest { } export namespace UpdateSigningCertificateRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateSigningCertificateRequest): any => ({ ...obj, }); @@ -594,6 +654,9 @@ export interface UpdateSSHPublicKeyRequest { } export namespace UpdateSSHPublicKeyRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateSSHPublicKeyRequest): any => ({ ...obj, }); @@ -629,6 +692,9 @@ export interface UpdateUserRequest { } export namespace UpdateUserRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateUserRequest): any => ({ ...obj, }); @@ -645,6 +711,9 @@ export interface KeyPairMismatchException extends __SmithyException, $MetadataBe } export namespace KeyPairMismatchException { + /** + * @internal + */ export const filterSensitiveLog = (obj: KeyPairMismatchException): any => ({ ...obj, }); @@ -661,6 +730,9 @@ export interface MalformedCertificateException extends __SmithyException, $Metad } export namespace MalformedCertificateException { + /** + * @internal + */ export const filterSensitiveLog = (obj: MalformedCertificateException): any => ({ ...obj, }); @@ -769,6 +841,9 @@ export interface UploadServerCertificateRequest { } export namespace UploadServerCertificateRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: UploadServerCertificateRequest): any => ({ ...obj, ...(obj.PrivateKey && { PrivateKey: SENSITIVE_STRING }), @@ -795,6 +870,9 @@ export interface UploadServerCertificateResponse { } export namespace UploadServerCertificateResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: UploadServerCertificateResponse): any => ({ ...obj, }); @@ -811,6 +889,9 @@ export interface DuplicateCertificateException extends __SmithyException, $Metad } export namespace DuplicateCertificateException { + /** + * @internal + */ export const filterSensitiveLog = (obj: DuplicateCertificateException): any => ({ ...obj, }); @@ -826,6 +907,9 @@ export interface InvalidCertificateException extends __SmithyException, $Metadat } export namespace InvalidCertificateException { + /** + * @internal + */ export const filterSensitiveLog = (obj: InvalidCertificateException): any => ({ ...obj, }); @@ -862,6 +946,9 @@ export interface UploadSigningCertificateRequest { } export namespace UploadSigningCertificateRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: UploadSigningCertificateRequest): any => ({ ...obj, }); @@ -879,6 +966,9 @@ export interface UploadSigningCertificateResponse { } export namespace UploadSigningCertificateResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: UploadSigningCertificateResponse): any => ({ ...obj, }); @@ -895,6 +985,9 @@ export interface DuplicateSSHPublicKeyException extends __SmithyException, $Meta } export namespace DuplicateSSHPublicKeyException { + /** + * @internal + */ export const filterSensitiveLog = (obj: DuplicateSSHPublicKeyException): any => ({ ...obj, }); @@ -910,6 +1003,9 @@ export interface InvalidPublicKeyException extends __SmithyException, $MetadataB } export namespace InvalidPublicKeyException { + /** + * @internal + */ export const filterSensitiveLog = (obj: InvalidPublicKeyException): any => ({ ...obj, }); @@ -948,6 +1044,9 @@ export interface UploadSSHPublicKeyRequest { } export namespace UploadSSHPublicKeyRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: UploadSSHPublicKeyRequest): any => ({ ...obj, }); @@ -965,6 +1064,9 @@ export interface UploadSSHPublicKeyResponse { } export namespace UploadSSHPublicKeyResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: UploadSSHPublicKeyResponse): any => ({ ...obj, }); diff --git a/clients/client-identitystore/commands/DescribeGroupCommand.ts b/clients/client-identitystore/commands/DescribeGroupCommand.ts index 556af9693c67..6287f4bba5ae 100644 --- a/clients/client-identitystore/commands/DescribeGroupCommand.ts +++ b/clients/client-identitystore/commands/DescribeGroupCommand.ts @@ -22,6 +22,20 @@ export interface DescribeGroupCommandOutput extends DescribeGroupResponse, __Met /** *

Retrieves the group metadata and attributes from GroupId in an identity store.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { IdentitystoreClient, DescribeGroupCommand } from "@aws-sdk/client-identitystore"; // ES Modules import + * // const { IdentitystoreClient, DescribeGroupCommand } = require("@aws-sdk/client-identitystore"); // CommonJS import + * const client = new IdentitystoreClient(config); + * const command = new DescribeGroupCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeGroupCommandInput} for command's `input` shape. + * @see {@link DescribeGroupCommandOutput} for command's `response` shape. + * @see {@link IdentitystoreClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeGroupCommand extends $Command< DescribeGroupCommandInput, diff --git a/clients/client-identitystore/commands/DescribeUserCommand.ts b/clients/client-identitystore/commands/DescribeUserCommand.ts index a0ff07a168a3..eb49780588e5 100644 --- a/clients/client-identitystore/commands/DescribeUserCommand.ts +++ b/clients/client-identitystore/commands/DescribeUserCommand.ts @@ -22,6 +22,20 @@ export interface DescribeUserCommandOutput extends DescribeUserResponse, __Metad /** *

Retrieves the user metadata and attributes from UserId in an identity store.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { IdentitystoreClient, DescribeUserCommand } from "@aws-sdk/client-identitystore"; // ES Modules import + * // const { IdentitystoreClient, DescribeUserCommand } = require("@aws-sdk/client-identitystore"); // CommonJS import + * const client = new IdentitystoreClient(config); + * const command = new DescribeUserCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeUserCommandInput} for command's `input` shape. + * @see {@link DescribeUserCommandOutput} for command's `response` shape. + * @see {@link IdentitystoreClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeUserCommand extends $Command< DescribeUserCommandInput, diff --git a/clients/client-identitystore/commands/ListGroupsCommand.ts b/clients/client-identitystore/commands/ListGroupsCommand.ts index 55ad4b74901c..ca2d145b8e8c 100644 --- a/clients/client-identitystore/commands/ListGroupsCommand.ts +++ b/clients/client-identitystore/commands/ListGroupsCommand.ts @@ -22,6 +22,20 @@ export interface ListGroupsCommandOutput extends ListGroupsResponse, __MetadataB /** *

Lists the attribute name and value of the group that you specified in the search. We only support DisplayName as a valid filter attribute path currently, and filter is required. This API returns minimum attributes, including GroupId and group DisplayName in the response.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { IdentitystoreClient, ListGroupsCommand } from "@aws-sdk/client-identitystore"; // ES Modules import + * // const { IdentitystoreClient, ListGroupsCommand } = require("@aws-sdk/client-identitystore"); // CommonJS import + * const client = new IdentitystoreClient(config); + * const command = new ListGroupsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListGroupsCommandInput} for command's `input` shape. + * @see {@link ListGroupsCommandOutput} for command's `response` shape. + * @see {@link IdentitystoreClientResolvedConfig | config} for command's `input` shape. + * */ export class ListGroupsCommand extends $Command< ListGroupsCommandInput, diff --git a/clients/client-identitystore/commands/ListUsersCommand.ts b/clients/client-identitystore/commands/ListUsersCommand.ts index bdf2246790af..f93856116f40 100644 --- a/clients/client-identitystore/commands/ListUsersCommand.ts +++ b/clients/client-identitystore/commands/ListUsersCommand.ts @@ -19,6 +19,20 @@ export interface ListUsersCommandOutput extends ListUsersResponse, __MetadataBea /** *

Lists the attribute name and value of the user that you specified in the search. We only support UserName as a valid filter attribute path currently, and filter is required. This API returns minimum attributes, including UserId and UserName in the response.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { IdentitystoreClient, ListUsersCommand } from "@aws-sdk/client-identitystore"; // ES Modules import + * // const { IdentitystoreClient, ListUsersCommand } = require("@aws-sdk/client-identitystore"); // CommonJS import + * const client = new IdentitystoreClient(config); + * const command = new ListUsersCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListUsersCommandInput} for command's `input` shape. + * @see {@link ListUsersCommandOutput} for command's `response` shape. + * @see {@link IdentitystoreClientResolvedConfig | config} for command's `input` shape. + * */ export class ListUsersCommand extends $Command< ListUsersCommandInput, diff --git a/clients/client-identitystore/models/models_0.ts b/clients/client-identitystore/models/models_0.ts index 03bdafbc08c6..156cbb2ff0e5 100644 --- a/clients/client-identitystore/models/models_0.ts +++ b/clients/client-identitystore/models/models_0.ts @@ -15,6 +15,9 @@ export interface AccessDeniedException extends __SmithyException, $MetadataBeare } export namespace AccessDeniedException { + /** + * @internal + */ export const filterSensitiveLog = (obj: AccessDeniedException): any => ({ ...obj, }); @@ -33,6 +36,9 @@ export interface DescribeGroupRequest { } export namespace DescribeGroupRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeGroupRequest): any => ({ ...obj, }); @@ -51,6 +57,9 @@ export interface DescribeGroupResponse { } export namespace DescribeGroupResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeGroupResponse): any => ({ ...obj, }); @@ -70,6 +79,9 @@ export interface InternalServerException extends __SmithyException, $MetadataBea } export namespace InternalServerException { + /** + * @internal + */ export const filterSensitiveLog = (obj: InternalServerException): any => ({ ...obj, }); @@ -105,6 +117,9 @@ export interface ResourceNotFoundException extends __SmithyException, $MetadataB } export namespace ResourceNotFoundException { + /** + * @internal + */ export const filterSensitiveLog = (obj: ResourceNotFoundException): any => ({ ...obj, }); @@ -124,6 +139,9 @@ export interface ThrottlingException extends __SmithyException, $MetadataBearer } export namespace ThrottlingException { + /** + * @internal + */ export const filterSensitiveLog = (obj: ThrottlingException): any => ({ ...obj, }); @@ -143,6 +161,9 @@ export interface ValidationException extends __SmithyException, $MetadataBearer } export namespace ValidationException { + /** + * @internal + */ export const filterSensitiveLog = (obj: ValidationException): any => ({ ...obj, }); @@ -161,6 +182,9 @@ export interface DescribeUserRequest { } export namespace DescribeUserRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeUserRequest): any => ({ ...obj, }); @@ -179,6 +203,9 @@ export interface DescribeUserResponse { } export namespace DescribeUserResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeUserResponse): any => ({ ...obj, ...(obj.UserName && { UserName: SENSITIVE_STRING }), @@ -201,6 +228,9 @@ export interface Filter { } export namespace Filter { + /** + * @internal + */ export const filterSensitiveLog = (obj: Filter): any => ({ ...obj, ...(obj.AttributeValue && { AttributeValue: SENSITIVE_STRING }), @@ -230,6 +260,9 @@ export interface ListGroupsRequest { } export namespace ListGroupsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListGroupsRequest): any => ({ ...obj, ...(obj.Filters && { Filters: obj.Filters.map((item) => Filter.filterSensitiveLog(item)) }), @@ -252,6 +285,9 @@ export interface Group { } export namespace Group { + /** + * @internal + */ export const filterSensitiveLog = (obj: Group): any => ({ ...obj, }); @@ -270,6 +306,9 @@ export interface ListGroupsResponse { } export namespace ListGroupsResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListGroupsResponse): any => ({ ...obj, }); @@ -298,6 +337,9 @@ export interface ListUsersRequest { } export namespace ListUsersRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListUsersRequest): any => ({ ...obj, ...(obj.Filters && { Filters: obj.Filters.map((item) => Filter.filterSensitiveLog(item)) }), @@ -320,6 +362,9 @@ export interface User { } export namespace User { + /** + * @internal + */ export const filterSensitiveLog = (obj: User): any => ({ ...obj, ...(obj.UserName && { UserName: SENSITIVE_STRING }), @@ -339,6 +384,9 @@ export interface ListUsersResponse { } export namespace ListUsersResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListUsersResponse): any => ({ ...obj, ...(obj.Users && { Users: obj.Users.map((item) => User.filterSensitiveLog(item)) }), diff --git a/clients/client-imagebuilder/commands/CancelImageCreationCommand.ts b/clients/client-imagebuilder/commands/CancelImageCreationCommand.ts index bba784ebf1e4..b95e8901097e 100644 --- a/clients/client-imagebuilder/commands/CancelImageCreationCommand.ts +++ b/clients/client-imagebuilder/commands/CancelImageCreationCommand.ts @@ -23,6 +23,20 @@ export interface CancelImageCreationCommandOutput extends CancelImageCreationRes /** *

CancelImageCreation cancels the creation of Image. This operation can only be used on * images in a non-terminal state.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ImagebuilderClient, CancelImageCreationCommand } from "@aws-sdk/client-imagebuilder"; // ES Modules import + * // const { ImagebuilderClient, CancelImageCreationCommand } = require("@aws-sdk/client-imagebuilder"); // CommonJS import + * const client = new ImagebuilderClient(config); + * const command = new CancelImageCreationCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CancelImageCreationCommandInput} for command's `input` shape. + * @see {@link CancelImageCreationCommandOutput} for command's `response` shape. + * @see {@link ImagebuilderClientResolvedConfig | config} for command's `input` shape. + * */ export class CancelImageCreationCommand extends $Command< CancelImageCreationCommandInput, diff --git a/clients/client-imagebuilder/commands/CreateComponentCommand.ts b/clients/client-imagebuilder/commands/CreateComponentCommand.ts index 2eecdbf6cc7f..6160c4a0fced 100644 --- a/clients/client-imagebuilder/commands/CreateComponentCommand.ts +++ b/clients/client-imagebuilder/commands/CreateComponentCommand.ts @@ -23,6 +23,20 @@ export interface CreateComponentCommandOutput extends CreateComponentResponse, _ /** *

Creates a new component that can be used to build, validate, test, and assess your * image.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ImagebuilderClient, CreateComponentCommand } from "@aws-sdk/client-imagebuilder"; // ES Modules import + * // const { ImagebuilderClient, CreateComponentCommand } = require("@aws-sdk/client-imagebuilder"); // CommonJS import + * const client = new ImagebuilderClient(config); + * const command = new CreateComponentCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreateComponentCommandInput} for command's `input` shape. + * @see {@link CreateComponentCommandOutput} for command's `response` shape. + * @see {@link ImagebuilderClientResolvedConfig | config} for command's `input` shape. + * */ export class CreateComponentCommand extends $Command< CreateComponentCommandInput, diff --git a/clients/client-imagebuilder/commands/CreateContainerRecipeCommand.ts b/clients/client-imagebuilder/commands/CreateContainerRecipeCommand.ts index bd0f7088aeb0..3779ad254bbb 100644 --- a/clients/client-imagebuilder/commands/CreateContainerRecipeCommand.ts +++ b/clients/client-imagebuilder/commands/CreateContainerRecipeCommand.ts @@ -22,6 +22,20 @@ export interface CreateContainerRecipeCommandOutput extends CreateContainerRecip /** *

Creates a new container recipe. Container recipes define how images are configured, tested, and assessed.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ImagebuilderClient, CreateContainerRecipeCommand } from "@aws-sdk/client-imagebuilder"; // ES Modules import + * // const { ImagebuilderClient, CreateContainerRecipeCommand } = require("@aws-sdk/client-imagebuilder"); // CommonJS import + * const client = new ImagebuilderClient(config); + * const command = new CreateContainerRecipeCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreateContainerRecipeCommandInput} for command's `input` shape. + * @see {@link CreateContainerRecipeCommandOutput} for command's `response` shape. + * @see {@link ImagebuilderClientResolvedConfig | config} for command's `input` shape. + * */ export class CreateContainerRecipeCommand extends $Command< CreateContainerRecipeCommandInput, diff --git a/clients/client-imagebuilder/commands/CreateDistributionConfigurationCommand.ts b/clients/client-imagebuilder/commands/CreateDistributionConfigurationCommand.ts index f169eb01ca5e..cd9ba13f58ff 100644 --- a/clients/client-imagebuilder/commands/CreateDistributionConfigurationCommand.ts +++ b/clients/client-imagebuilder/commands/CreateDistributionConfigurationCommand.ts @@ -25,6 +25,20 @@ export interface CreateDistributionConfigurationCommandOutput /** *

Creates a new distribution configuration. Distribution configurations define and configure * the outputs of your pipeline.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ImagebuilderClient, CreateDistributionConfigurationCommand } from "@aws-sdk/client-imagebuilder"; // ES Modules import + * // const { ImagebuilderClient, CreateDistributionConfigurationCommand } = require("@aws-sdk/client-imagebuilder"); // CommonJS import + * const client = new ImagebuilderClient(config); + * const command = new CreateDistributionConfigurationCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreateDistributionConfigurationCommandInput} for command's `input` shape. + * @see {@link CreateDistributionConfigurationCommandOutput} for command's `response` shape. + * @see {@link ImagebuilderClientResolvedConfig | config} for command's `input` shape. + * */ export class CreateDistributionConfigurationCommand extends $Command< CreateDistributionConfigurationCommandInput, diff --git a/clients/client-imagebuilder/commands/CreateImageCommand.ts b/clients/client-imagebuilder/commands/CreateImageCommand.ts index 0c3077eaeeaa..2f455d4825c3 100644 --- a/clients/client-imagebuilder/commands/CreateImageCommand.ts +++ b/clients/client-imagebuilder/commands/CreateImageCommand.ts @@ -23,6 +23,20 @@ export interface CreateImageCommandOutput extends CreateImageResponse, __Metadat /** *

Creates a new image. This request will create a new image along with all of the * configured output resources defined in the distribution configuration.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ImagebuilderClient, CreateImageCommand } from "@aws-sdk/client-imagebuilder"; // ES Modules import + * // const { ImagebuilderClient, CreateImageCommand } = require("@aws-sdk/client-imagebuilder"); // CommonJS import + * const client = new ImagebuilderClient(config); + * const command = new CreateImageCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreateImageCommandInput} for command's `input` shape. + * @see {@link CreateImageCommandOutput} for command's `response` shape. + * @see {@link ImagebuilderClientResolvedConfig | config} for command's `input` shape. + * */ export class CreateImageCommand extends $Command< CreateImageCommandInput, diff --git a/clients/client-imagebuilder/commands/CreateImagePipelineCommand.ts b/clients/client-imagebuilder/commands/CreateImagePipelineCommand.ts index be6dc7b6ddb4..41df55aa1d12 100644 --- a/clients/client-imagebuilder/commands/CreateImagePipelineCommand.ts +++ b/clients/client-imagebuilder/commands/CreateImagePipelineCommand.ts @@ -23,6 +23,20 @@ export interface CreateImagePipelineCommandOutput extends CreateImagePipelineRes /** *

Creates a new image pipeline. Image pipelines enable you to automate the creation and * distribution of images.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ImagebuilderClient, CreateImagePipelineCommand } from "@aws-sdk/client-imagebuilder"; // ES Modules import + * // const { ImagebuilderClient, CreateImagePipelineCommand } = require("@aws-sdk/client-imagebuilder"); // CommonJS import + * const client = new ImagebuilderClient(config); + * const command = new CreateImagePipelineCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreateImagePipelineCommandInput} for command's `input` shape. + * @see {@link CreateImagePipelineCommandOutput} for command's `response` shape. + * @see {@link ImagebuilderClientResolvedConfig | config} for command's `input` shape. + * */ export class CreateImagePipelineCommand extends $Command< CreateImagePipelineCommandInput, diff --git a/clients/client-imagebuilder/commands/CreateImageRecipeCommand.ts b/clients/client-imagebuilder/commands/CreateImageRecipeCommand.ts index ebf450165863..31611c2a9f21 100644 --- a/clients/client-imagebuilder/commands/CreateImageRecipeCommand.ts +++ b/clients/client-imagebuilder/commands/CreateImageRecipeCommand.ts @@ -23,6 +23,20 @@ export interface CreateImageRecipeCommandOutput extends CreateImageRecipeRespons /** *

Creates a new image recipe. Image recipes define how images are configured, tested, and * assessed.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ImagebuilderClient, CreateImageRecipeCommand } from "@aws-sdk/client-imagebuilder"; // ES Modules import + * // const { ImagebuilderClient, CreateImageRecipeCommand } = require("@aws-sdk/client-imagebuilder"); // CommonJS import + * const client = new ImagebuilderClient(config); + * const command = new CreateImageRecipeCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreateImageRecipeCommandInput} for command's `input` shape. + * @see {@link CreateImageRecipeCommandOutput} for command's `response` shape. + * @see {@link ImagebuilderClientResolvedConfig | config} for command's `input` shape. + * */ export class CreateImageRecipeCommand extends $Command< CreateImageRecipeCommandInput, diff --git a/clients/client-imagebuilder/commands/CreateInfrastructureConfigurationCommand.ts b/clients/client-imagebuilder/commands/CreateInfrastructureConfigurationCommand.ts index a454a6d30278..9471c37ccc1e 100644 --- a/clients/client-imagebuilder/commands/CreateInfrastructureConfigurationCommand.ts +++ b/clients/client-imagebuilder/commands/CreateInfrastructureConfigurationCommand.ts @@ -28,6 +28,20 @@ export interface CreateInfrastructureConfigurationCommandOutput /** *

Creates a new infrastructure configuration. An infrastructure configuration defines the * environment in which your image will be built and tested.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ImagebuilderClient, CreateInfrastructureConfigurationCommand } from "@aws-sdk/client-imagebuilder"; // ES Modules import + * // const { ImagebuilderClient, CreateInfrastructureConfigurationCommand } = require("@aws-sdk/client-imagebuilder"); // CommonJS import + * const client = new ImagebuilderClient(config); + * const command = new CreateInfrastructureConfigurationCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreateInfrastructureConfigurationCommandInput} for command's `input` shape. + * @see {@link CreateInfrastructureConfigurationCommandOutput} for command's `response` shape. + * @see {@link ImagebuilderClientResolvedConfig | config} for command's `input` shape. + * */ export class CreateInfrastructureConfigurationCommand extends $Command< CreateInfrastructureConfigurationCommandInput, diff --git a/clients/client-imagebuilder/commands/DeleteComponentCommand.ts b/clients/client-imagebuilder/commands/DeleteComponentCommand.ts index 6d7f92dafeb8..0d69fc99715b 100644 --- a/clients/client-imagebuilder/commands/DeleteComponentCommand.ts +++ b/clients/client-imagebuilder/commands/DeleteComponentCommand.ts @@ -22,6 +22,20 @@ export interface DeleteComponentCommandOutput extends DeleteComponentResponse, _ /** *

Deletes a component build version.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ImagebuilderClient, DeleteComponentCommand } from "@aws-sdk/client-imagebuilder"; // ES Modules import + * // const { ImagebuilderClient, DeleteComponentCommand } = require("@aws-sdk/client-imagebuilder"); // CommonJS import + * const client = new ImagebuilderClient(config); + * const command = new DeleteComponentCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteComponentCommandInput} for command's `input` shape. + * @see {@link DeleteComponentCommandOutput} for command's `response` shape. + * @see {@link ImagebuilderClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteComponentCommand extends $Command< DeleteComponentCommandInput, diff --git a/clients/client-imagebuilder/commands/DeleteContainerRecipeCommand.ts b/clients/client-imagebuilder/commands/DeleteContainerRecipeCommand.ts index 7f527e4ef254..8628de3487d5 100644 --- a/clients/client-imagebuilder/commands/DeleteContainerRecipeCommand.ts +++ b/clients/client-imagebuilder/commands/DeleteContainerRecipeCommand.ts @@ -22,6 +22,20 @@ export interface DeleteContainerRecipeCommandOutput extends DeleteContainerRecip /** *

Deletes a container recipe.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ImagebuilderClient, DeleteContainerRecipeCommand } from "@aws-sdk/client-imagebuilder"; // ES Modules import + * // const { ImagebuilderClient, DeleteContainerRecipeCommand } = require("@aws-sdk/client-imagebuilder"); // CommonJS import + * const client = new ImagebuilderClient(config); + * const command = new DeleteContainerRecipeCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteContainerRecipeCommandInput} for command's `input` shape. + * @see {@link DeleteContainerRecipeCommandOutput} for command's `response` shape. + * @see {@link ImagebuilderClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteContainerRecipeCommand extends $Command< DeleteContainerRecipeCommandInput, diff --git a/clients/client-imagebuilder/commands/DeleteDistributionConfigurationCommand.ts b/clients/client-imagebuilder/commands/DeleteDistributionConfigurationCommand.ts index a9294ca81ad0..85ba7ffb2276 100644 --- a/clients/client-imagebuilder/commands/DeleteDistributionConfigurationCommand.ts +++ b/clients/client-imagebuilder/commands/DeleteDistributionConfigurationCommand.ts @@ -24,6 +24,20 @@ export interface DeleteDistributionConfigurationCommandOutput /** *

Deletes a distribution configuration.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ImagebuilderClient, DeleteDistributionConfigurationCommand } from "@aws-sdk/client-imagebuilder"; // ES Modules import + * // const { ImagebuilderClient, DeleteDistributionConfigurationCommand } = require("@aws-sdk/client-imagebuilder"); // CommonJS import + * const client = new ImagebuilderClient(config); + * const command = new DeleteDistributionConfigurationCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteDistributionConfigurationCommandInput} for command's `input` shape. + * @see {@link DeleteDistributionConfigurationCommandOutput} for command's `response` shape. + * @see {@link ImagebuilderClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteDistributionConfigurationCommand extends $Command< DeleteDistributionConfigurationCommandInput, diff --git a/clients/client-imagebuilder/commands/DeleteImageCommand.ts b/clients/client-imagebuilder/commands/DeleteImageCommand.ts index b6820491f85f..175a28240dbd 100644 --- a/clients/client-imagebuilder/commands/DeleteImageCommand.ts +++ b/clients/client-imagebuilder/commands/DeleteImageCommand.ts @@ -22,6 +22,20 @@ export interface DeleteImageCommandOutput extends DeleteImageResponse, __Metadat /** *

Deletes an image.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ImagebuilderClient, DeleteImageCommand } from "@aws-sdk/client-imagebuilder"; // ES Modules import + * // const { ImagebuilderClient, DeleteImageCommand } = require("@aws-sdk/client-imagebuilder"); // CommonJS import + * const client = new ImagebuilderClient(config); + * const command = new DeleteImageCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteImageCommandInput} for command's `input` shape. + * @see {@link DeleteImageCommandOutput} for command's `response` shape. + * @see {@link ImagebuilderClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteImageCommand extends $Command< DeleteImageCommandInput, diff --git a/clients/client-imagebuilder/commands/DeleteImagePipelineCommand.ts b/clients/client-imagebuilder/commands/DeleteImagePipelineCommand.ts index 5b115adcaca3..0d077fe10b18 100644 --- a/clients/client-imagebuilder/commands/DeleteImagePipelineCommand.ts +++ b/clients/client-imagebuilder/commands/DeleteImagePipelineCommand.ts @@ -22,6 +22,20 @@ export interface DeleteImagePipelineCommandOutput extends DeleteImagePipelineRes /** *

Deletes an image pipeline.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ImagebuilderClient, DeleteImagePipelineCommand } from "@aws-sdk/client-imagebuilder"; // ES Modules import + * // const { ImagebuilderClient, DeleteImagePipelineCommand } = require("@aws-sdk/client-imagebuilder"); // CommonJS import + * const client = new ImagebuilderClient(config); + * const command = new DeleteImagePipelineCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteImagePipelineCommandInput} for command's `input` shape. + * @see {@link DeleteImagePipelineCommandOutput} for command's `response` shape. + * @see {@link ImagebuilderClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteImagePipelineCommand extends $Command< DeleteImagePipelineCommandInput, diff --git a/clients/client-imagebuilder/commands/DeleteImageRecipeCommand.ts b/clients/client-imagebuilder/commands/DeleteImageRecipeCommand.ts index 7972f1c4db14..7da77994655e 100644 --- a/clients/client-imagebuilder/commands/DeleteImageRecipeCommand.ts +++ b/clients/client-imagebuilder/commands/DeleteImageRecipeCommand.ts @@ -22,6 +22,20 @@ export interface DeleteImageRecipeCommandOutput extends DeleteImageRecipeRespons /** *

Deletes an image recipe.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ImagebuilderClient, DeleteImageRecipeCommand } from "@aws-sdk/client-imagebuilder"; // ES Modules import + * // const { ImagebuilderClient, DeleteImageRecipeCommand } = require("@aws-sdk/client-imagebuilder"); // CommonJS import + * const client = new ImagebuilderClient(config); + * const command = new DeleteImageRecipeCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteImageRecipeCommandInput} for command's `input` shape. + * @see {@link DeleteImageRecipeCommandOutput} for command's `response` shape. + * @see {@link ImagebuilderClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteImageRecipeCommand extends $Command< DeleteImageRecipeCommandInput, diff --git a/clients/client-imagebuilder/commands/DeleteInfrastructureConfigurationCommand.ts b/clients/client-imagebuilder/commands/DeleteInfrastructureConfigurationCommand.ts index 8620101efddf..bdd0f7928da1 100644 --- a/clients/client-imagebuilder/commands/DeleteInfrastructureConfigurationCommand.ts +++ b/clients/client-imagebuilder/commands/DeleteInfrastructureConfigurationCommand.ts @@ -27,6 +27,20 @@ export interface DeleteInfrastructureConfigurationCommandOutput /** *

Deletes an infrastructure configuration.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ImagebuilderClient, DeleteInfrastructureConfigurationCommand } from "@aws-sdk/client-imagebuilder"; // ES Modules import + * // const { ImagebuilderClient, DeleteInfrastructureConfigurationCommand } = require("@aws-sdk/client-imagebuilder"); // CommonJS import + * const client = new ImagebuilderClient(config); + * const command = new DeleteInfrastructureConfigurationCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteInfrastructureConfigurationCommandInput} for command's `input` shape. + * @see {@link DeleteInfrastructureConfigurationCommandOutput} for command's `response` shape. + * @see {@link ImagebuilderClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteInfrastructureConfigurationCommand extends $Command< DeleteInfrastructureConfigurationCommandInput, diff --git a/clients/client-imagebuilder/commands/GetComponentCommand.ts b/clients/client-imagebuilder/commands/GetComponentCommand.ts index 7c3fef4aecb5..3d118310b9ef 100644 --- a/clients/client-imagebuilder/commands/GetComponentCommand.ts +++ b/clients/client-imagebuilder/commands/GetComponentCommand.ts @@ -22,6 +22,20 @@ export interface GetComponentCommandOutput extends GetComponentResponse, __Metad /** *

Gets a component object.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ImagebuilderClient, GetComponentCommand } from "@aws-sdk/client-imagebuilder"; // ES Modules import + * // const { ImagebuilderClient, GetComponentCommand } = require("@aws-sdk/client-imagebuilder"); // CommonJS import + * const client = new ImagebuilderClient(config); + * const command = new GetComponentCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetComponentCommandInput} for command's `input` shape. + * @see {@link GetComponentCommandOutput} for command's `response` shape. + * @see {@link ImagebuilderClientResolvedConfig | config} for command's `input` shape. + * */ export class GetComponentCommand extends $Command< GetComponentCommandInput, diff --git a/clients/client-imagebuilder/commands/GetComponentPolicyCommand.ts b/clients/client-imagebuilder/commands/GetComponentPolicyCommand.ts index d48beeb1c7bd..73c05bbcd567 100644 --- a/clients/client-imagebuilder/commands/GetComponentPolicyCommand.ts +++ b/clients/client-imagebuilder/commands/GetComponentPolicyCommand.ts @@ -22,6 +22,20 @@ export interface GetComponentPolicyCommandOutput extends GetComponentPolicyRespo /** *

Gets a component policy.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ImagebuilderClient, GetComponentPolicyCommand } from "@aws-sdk/client-imagebuilder"; // ES Modules import + * // const { ImagebuilderClient, GetComponentPolicyCommand } = require("@aws-sdk/client-imagebuilder"); // CommonJS import + * const client = new ImagebuilderClient(config); + * const command = new GetComponentPolicyCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetComponentPolicyCommandInput} for command's `input` shape. + * @see {@link GetComponentPolicyCommandOutput} for command's `response` shape. + * @see {@link ImagebuilderClientResolvedConfig | config} for command's `input` shape. + * */ export class GetComponentPolicyCommand extends $Command< GetComponentPolicyCommandInput, diff --git a/clients/client-imagebuilder/commands/GetContainerRecipeCommand.ts b/clients/client-imagebuilder/commands/GetContainerRecipeCommand.ts index da1e4820340f..1e993beecbfa 100644 --- a/clients/client-imagebuilder/commands/GetContainerRecipeCommand.ts +++ b/clients/client-imagebuilder/commands/GetContainerRecipeCommand.ts @@ -22,6 +22,20 @@ export interface GetContainerRecipeCommandOutput extends GetContainerRecipeRespo /** *

Retrieves a container recipe.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ImagebuilderClient, GetContainerRecipeCommand } from "@aws-sdk/client-imagebuilder"; // ES Modules import + * // const { ImagebuilderClient, GetContainerRecipeCommand } = require("@aws-sdk/client-imagebuilder"); // CommonJS import + * const client = new ImagebuilderClient(config); + * const command = new GetContainerRecipeCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetContainerRecipeCommandInput} for command's `input` shape. + * @see {@link GetContainerRecipeCommandOutput} for command's `response` shape. + * @see {@link ImagebuilderClientResolvedConfig | config} for command's `input` shape. + * */ export class GetContainerRecipeCommand extends $Command< GetContainerRecipeCommandInput, diff --git a/clients/client-imagebuilder/commands/GetContainerRecipePolicyCommand.ts b/clients/client-imagebuilder/commands/GetContainerRecipePolicyCommand.ts index 334b93370a40..7c302f06d690 100644 --- a/clients/client-imagebuilder/commands/GetContainerRecipePolicyCommand.ts +++ b/clients/client-imagebuilder/commands/GetContainerRecipePolicyCommand.ts @@ -22,6 +22,20 @@ export interface GetContainerRecipePolicyCommandOutput extends GetContainerRecip /** *

Retrieves the policy for a container recipe.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ImagebuilderClient, GetContainerRecipePolicyCommand } from "@aws-sdk/client-imagebuilder"; // ES Modules import + * // const { ImagebuilderClient, GetContainerRecipePolicyCommand } = require("@aws-sdk/client-imagebuilder"); // CommonJS import + * const client = new ImagebuilderClient(config); + * const command = new GetContainerRecipePolicyCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetContainerRecipePolicyCommandInput} for command's `input` shape. + * @see {@link GetContainerRecipePolicyCommandOutput} for command's `response` shape. + * @see {@link ImagebuilderClientResolvedConfig | config} for command's `input` shape. + * */ export class GetContainerRecipePolicyCommand extends $Command< GetContainerRecipePolicyCommandInput, diff --git a/clients/client-imagebuilder/commands/GetDistributionConfigurationCommand.ts b/clients/client-imagebuilder/commands/GetDistributionConfigurationCommand.ts index 4b574eb52223..34ac5c971168 100644 --- a/clients/client-imagebuilder/commands/GetDistributionConfigurationCommand.ts +++ b/clients/client-imagebuilder/commands/GetDistributionConfigurationCommand.ts @@ -24,6 +24,20 @@ export interface GetDistributionConfigurationCommandOutput /** *

Gets a distribution configuration.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ImagebuilderClient, GetDistributionConfigurationCommand } from "@aws-sdk/client-imagebuilder"; // ES Modules import + * // const { ImagebuilderClient, GetDistributionConfigurationCommand } = require("@aws-sdk/client-imagebuilder"); // CommonJS import + * const client = new ImagebuilderClient(config); + * const command = new GetDistributionConfigurationCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetDistributionConfigurationCommandInput} for command's `input` shape. + * @see {@link GetDistributionConfigurationCommandOutput} for command's `response` shape. + * @see {@link ImagebuilderClientResolvedConfig | config} for command's `input` shape. + * */ export class GetDistributionConfigurationCommand extends $Command< GetDistributionConfigurationCommandInput, diff --git a/clients/client-imagebuilder/commands/GetImageCommand.ts b/clients/client-imagebuilder/commands/GetImageCommand.ts index 70f2c33eaac6..88ec3d048dcd 100644 --- a/clients/client-imagebuilder/commands/GetImageCommand.ts +++ b/clients/client-imagebuilder/commands/GetImageCommand.ts @@ -22,6 +22,20 @@ export interface GetImageCommandOutput extends GetImageResponse, __MetadataBeare /** *

Gets an image.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ImagebuilderClient, GetImageCommand } from "@aws-sdk/client-imagebuilder"; // ES Modules import + * // const { ImagebuilderClient, GetImageCommand } = require("@aws-sdk/client-imagebuilder"); // CommonJS import + * const client = new ImagebuilderClient(config); + * const command = new GetImageCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetImageCommandInput} for command's `input` shape. + * @see {@link GetImageCommandOutput} for command's `response` shape. + * @see {@link ImagebuilderClientResolvedConfig | config} for command's `input` shape. + * */ export class GetImageCommand extends $Command< GetImageCommandInput, diff --git a/clients/client-imagebuilder/commands/GetImagePipelineCommand.ts b/clients/client-imagebuilder/commands/GetImagePipelineCommand.ts index fcd0cb34b62b..d4dac1bb1a43 100644 --- a/clients/client-imagebuilder/commands/GetImagePipelineCommand.ts +++ b/clients/client-imagebuilder/commands/GetImagePipelineCommand.ts @@ -22,6 +22,20 @@ export interface GetImagePipelineCommandOutput extends GetImagePipelineResponse, /** *

Gets an image pipeline.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ImagebuilderClient, GetImagePipelineCommand } from "@aws-sdk/client-imagebuilder"; // ES Modules import + * // const { ImagebuilderClient, GetImagePipelineCommand } = require("@aws-sdk/client-imagebuilder"); // CommonJS import + * const client = new ImagebuilderClient(config); + * const command = new GetImagePipelineCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetImagePipelineCommandInput} for command's `input` shape. + * @see {@link GetImagePipelineCommandOutput} for command's `response` shape. + * @see {@link ImagebuilderClientResolvedConfig | config} for command's `input` shape. + * */ export class GetImagePipelineCommand extends $Command< GetImagePipelineCommandInput, diff --git a/clients/client-imagebuilder/commands/GetImagePolicyCommand.ts b/clients/client-imagebuilder/commands/GetImagePolicyCommand.ts index eff63b75cf4e..1bd7aae60491 100644 --- a/clients/client-imagebuilder/commands/GetImagePolicyCommand.ts +++ b/clients/client-imagebuilder/commands/GetImagePolicyCommand.ts @@ -22,6 +22,20 @@ export interface GetImagePolicyCommandOutput extends GetImagePolicyResponse, __M /** *

Gets an image policy.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ImagebuilderClient, GetImagePolicyCommand } from "@aws-sdk/client-imagebuilder"; // ES Modules import + * // const { ImagebuilderClient, GetImagePolicyCommand } = require("@aws-sdk/client-imagebuilder"); // CommonJS import + * const client = new ImagebuilderClient(config); + * const command = new GetImagePolicyCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetImagePolicyCommandInput} for command's `input` shape. + * @see {@link GetImagePolicyCommandOutput} for command's `response` shape. + * @see {@link ImagebuilderClientResolvedConfig | config} for command's `input` shape. + * */ export class GetImagePolicyCommand extends $Command< GetImagePolicyCommandInput, diff --git a/clients/client-imagebuilder/commands/GetImageRecipeCommand.ts b/clients/client-imagebuilder/commands/GetImageRecipeCommand.ts index ba8c9d433f05..f6c3420dfe66 100644 --- a/clients/client-imagebuilder/commands/GetImageRecipeCommand.ts +++ b/clients/client-imagebuilder/commands/GetImageRecipeCommand.ts @@ -22,6 +22,20 @@ export interface GetImageRecipeCommandOutput extends GetImageRecipeResponse, __M /** *

Gets an image recipe.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ImagebuilderClient, GetImageRecipeCommand } from "@aws-sdk/client-imagebuilder"; // ES Modules import + * // const { ImagebuilderClient, GetImageRecipeCommand } = require("@aws-sdk/client-imagebuilder"); // CommonJS import + * const client = new ImagebuilderClient(config); + * const command = new GetImageRecipeCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetImageRecipeCommandInput} for command's `input` shape. + * @see {@link GetImageRecipeCommandOutput} for command's `response` shape. + * @see {@link ImagebuilderClientResolvedConfig | config} for command's `input` shape. + * */ export class GetImageRecipeCommand extends $Command< GetImageRecipeCommandInput, diff --git a/clients/client-imagebuilder/commands/GetImageRecipePolicyCommand.ts b/clients/client-imagebuilder/commands/GetImageRecipePolicyCommand.ts index 3d1dd9848ff1..53b019d7c2bd 100644 --- a/clients/client-imagebuilder/commands/GetImageRecipePolicyCommand.ts +++ b/clients/client-imagebuilder/commands/GetImageRecipePolicyCommand.ts @@ -22,6 +22,20 @@ export interface GetImageRecipePolicyCommandOutput extends GetImageRecipePolicyR /** *

Gets an image recipe policy.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ImagebuilderClient, GetImageRecipePolicyCommand } from "@aws-sdk/client-imagebuilder"; // ES Modules import + * // const { ImagebuilderClient, GetImageRecipePolicyCommand } = require("@aws-sdk/client-imagebuilder"); // CommonJS import + * const client = new ImagebuilderClient(config); + * const command = new GetImageRecipePolicyCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetImageRecipePolicyCommandInput} for command's `input` shape. + * @see {@link GetImageRecipePolicyCommandOutput} for command's `response` shape. + * @see {@link ImagebuilderClientResolvedConfig | config} for command's `input` shape. + * */ export class GetImageRecipePolicyCommand extends $Command< GetImageRecipePolicyCommandInput, diff --git a/clients/client-imagebuilder/commands/GetInfrastructureConfigurationCommand.ts b/clients/client-imagebuilder/commands/GetInfrastructureConfigurationCommand.ts index e1c32740d4d1..b5ae10cac73c 100644 --- a/clients/client-imagebuilder/commands/GetInfrastructureConfigurationCommand.ts +++ b/clients/client-imagebuilder/commands/GetInfrastructureConfigurationCommand.ts @@ -24,6 +24,20 @@ export interface GetInfrastructureConfigurationCommandOutput /** *

Gets an infrastructure configuration.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ImagebuilderClient, GetInfrastructureConfigurationCommand } from "@aws-sdk/client-imagebuilder"; // ES Modules import + * // const { ImagebuilderClient, GetInfrastructureConfigurationCommand } = require("@aws-sdk/client-imagebuilder"); // CommonJS import + * const client = new ImagebuilderClient(config); + * const command = new GetInfrastructureConfigurationCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetInfrastructureConfigurationCommandInput} for command's `input` shape. + * @see {@link GetInfrastructureConfigurationCommandOutput} for command's `response` shape. + * @see {@link ImagebuilderClientResolvedConfig | config} for command's `input` shape. + * */ export class GetInfrastructureConfigurationCommand extends $Command< GetInfrastructureConfigurationCommandInput, diff --git a/clients/client-imagebuilder/commands/ImportComponentCommand.ts b/clients/client-imagebuilder/commands/ImportComponentCommand.ts index 7bfa07b09d8c..1e7776c18146 100644 --- a/clients/client-imagebuilder/commands/ImportComponentCommand.ts +++ b/clients/client-imagebuilder/commands/ImportComponentCommand.ts @@ -22,6 +22,20 @@ export interface ImportComponentCommandOutput extends ImportComponentResponse, _ /** *

Imports a component and transforms its data into a component document.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ImagebuilderClient, ImportComponentCommand } from "@aws-sdk/client-imagebuilder"; // ES Modules import + * // const { ImagebuilderClient, ImportComponentCommand } = require("@aws-sdk/client-imagebuilder"); // CommonJS import + * const client = new ImagebuilderClient(config); + * const command = new ImportComponentCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ImportComponentCommandInput} for command's `input` shape. + * @see {@link ImportComponentCommandOutput} for command's `response` shape. + * @see {@link ImagebuilderClientResolvedConfig | config} for command's `input` shape. + * */ export class ImportComponentCommand extends $Command< ImportComponentCommandInput, diff --git a/clients/client-imagebuilder/commands/ListComponentBuildVersionsCommand.ts b/clients/client-imagebuilder/commands/ListComponentBuildVersionsCommand.ts index 85ae73214fe6..803a397e836e 100644 --- a/clients/client-imagebuilder/commands/ListComponentBuildVersionsCommand.ts +++ b/clients/client-imagebuilder/commands/ListComponentBuildVersionsCommand.ts @@ -22,6 +22,20 @@ export interface ListComponentBuildVersionsCommandOutput extends ListComponentBu /** *

Returns the list of component build versions for the specified semantic version.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ImagebuilderClient, ListComponentBuildVersionsCommand } from "@aws-sdk/client-imagebuilder"; // ES Modules import + * // const { ImagebuilderClient, ListComponentBuildVersionsCommand } = require("@aws-sdk/client-imagebuilder"); // CommonJS import + * const client = new ImagebuilderClient(config); + * const command = new ListComponentBuildVersionsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListComponentBuildVersionsCommandInput} for command's `input` shape. + * @see {@link ListComponentBuildVersionsCommandOutput} for command's `response` shape. + * @see {@link ImagebuilderClientResolvedConfig | config} for command's `input` shape. + * */ export class ListComponentBuildVersionsCommand extends $Command< ListComponentBuildVersionsCommandInput, diff --git a/clients/client-imagebuilder/commands/ListComponentsCommand.ts b/clients/client-imagebuilder/commands/ListComponentsCommand.ts index 3d7cff47c9e3..e3ae5054b061 100644 --- a/clients/client-imagebuilder/commands/ListComponentsCommand.ts +++ b/clients/client-imagebuilder/commands/ListComponentsCommand.ts @@ -22,6 +22,20 @@ export interface ListComponentsCommandOutput extends ListComponentsResponse, __M /** *

Returns the list of component build versions for the specified semantic version.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ImagebuilderClient, ListComponentsCommand } from "@aws-sdk/client-imagebuilder"; // ES Modules import + * // const { ImagebuilderClient, ListComponentsCommand } = require("@aws-sdk/client-imagebuilder"); // CommonJS import + * const client = new ImagebuilderClient(config); + * const command = new ListComponentsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListComponentsCommandInput} for command's `input` shape. + * @see {@link ListComponentsCommandOutput} for command's `response` shape. + * @see {@link ImagebuilderClientResolvedConfig | config} for command's `input` shape. + * */ export class ListComponentsCommand extends $Command< ListComponentsCommandInput, diff --git a/clients/client-imagebuilder/commands/ListContainerRecipesCommand.ts b/clients/client-imagebuilder/commands/ListContainerRecipesCommand.ts index d39d48bd6df8..10e790ed1ffd 100644 --- a/clients/client-imagebuilder/commands/ListContainerRecipesCommand.ts +++ b/clients/client-imagebuilder/commands/ListContainerRecipesCommand.ts @@ -22,6 +22,20 @@ export interface ListContainerRecipesCommandOutput extends ListContainerRecipesR /** *

Returns a list of container recipes.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ImagebuilderClient, ListContainerRecipesCommand } from "@aws-sdk/client-imagebuilder"; // ES Modules import + * // const { ImagebuilderClient, ListContainerRecipesCommand } = require("@aws-sdk/client-imagebuilder"); // CommonJS import + * const client = new ImagebuilderClient(config); + * const command = new ListContainerRecipesCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListContainerRecipesCommandInput} for command's `input` shape. + * @see {@link ListContainerRecipesCommandOutput} for command's `response` shape. + * @see {@link ImagebuilderClientResolvedConfig | config} for command's `input` shape. + * */ export class ListContainerRecipesCommand extends $Command< ListContainerRecipesCommandInput, diff --git a/clients/client-imagebuilder/commands/ListDistributionConfigurationsCommand.ts b/clients/client-imagebuilder/commands/ListDistributionConfigurationsCommand.ts index e1fc424deca3..6e2fe5b29bdd 100644 --- a/clients/client-imagebuilder/commands/ListDistributionConfigurationsCommand.ts +++ b/clients/client-imagebuilder/commands/ListDistributionConfigurationsCommand.ts @@ -24,6 +24,20 @@ export interface ListDistributionConfigurationsCommandOutput /** *

Returns a list of distribution configurations.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ImagebuilderClient, ListDistributionConfigurationsCommand } from "@aws-sdk/client-imagebuilder"; // ES Modules import + * // const { ImagebuilderClient, ListDistributionConfigurationsCommand } = require("@aws-sdk/client-imagebuilder"); // CommonJS import + * const client = new ImagebuilderClient(config); + * const command = new ListDistributionConfigurationsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListDistributionConfigurationsCommandInput} for command's `input` shape. + * @see {@link ListDistributionConfigurationsCommandOutput} for command's `response` shape. + * @see {@link ImagebuilderClientResolvedConfig | config} for command's `input` shape. + * */ export class ListDistributionConfigurationsCommand extends $Command< ListDistributionConfigurationsCommandInput, diff --git a/clients/client-imagebuilder/commands/ListImageBuildVersionsCommand.ts b/clients/client-imagebuilder/commands/ListImageBuildVersionsCommand.ts index 4bc7fc8c47c4..74b171cea9ff 100644 --- a/clients/client-imagebuilder/commands/ListImageBuildVersionsCommand.ts +++ b/clients/client-imagebuilder/commands/ListImageBuildVersionsCommand.ts @@ -22,6 +22,20 @@ export interface ListImageBuildVersionsCommandOutput extends ListImageBuildVersi /** *

Returns a list of image build versions.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ImagebuilderClient, ListImageBuildVersionsCommand } from "@aws-sdk/client-imagebuilder"; // ES Modules import + * // const { ImagebuilderClient, ListImageBuildVersionsCommand } = require("@aws-sdk/client-imagebuilder"); // CommonJS import + * const client = new ImagebuilderClient(config); + * const command = new ListImageBuildVersionsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListImageBuildVersionsCommandInput} for command's `input` shape. + * @see {@link ListImageBuildVersionsCommandOutput} for command's `response` shape. + * @see {@link ImagebuilderClientResolvedConfig | config} for command's `input` shape. + * */ export class ListImageBuildVersionsCommand extends $Command< ListImageBuildVersionsCommandInput, diff --git a/clients/client-imagebuilder/commands/ListImagePackagesCommand.ts b/clients/client-imagebuilder/commands/ListImagePackagesCommand.ts index 922288fab5c4..98125a1ea1b9 100644 --- a/clients/client-imagebuilder/commands/ListImagePackagesCommand.ts +++ b/clients/client-imagebuilder/commands/ListImagePackagesCommand.ts @@ -22,6 +22,20 @@ export interface ListImagePackagesCommandOutput extends ListImagePackagesRespons /** *

List the Packages that are associated with an Image Build Version, as determined by AWS Systems Manager Inventory at build time.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ImagebuilderClient, ListImagePackagesCommand } from "@aws-sdk/client-imagebuilder"; // ES Modules import + * // const { ImagebuilderClient, ListImagePackagesCommand } = require("@aws-sdk/client-imagebuilder"); // CommonJS import + * const client = new ImagebuilderClient(config); + * const command = new ListImagePackagesCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListImagePackagesCommandInput} for command's `input` shape. + * @see {@link ListImagePackagesCommandOutput} for command's `response` shape. + * @see {@link ImagebuilderClientResolvedConfig | config} for command's `input` shape. + * */ export class ListImagePackagesCommand extends $Command< ListImagePackagesCommandInput, diff --git a/clients/client-imagebuilder/commands/ListImagePipelineImagesCommand.ts b/clients/client-imagebuilder/commands/ListImagePipelineImagesCommand.ts index 5cca78f5c609..c6d8965a6323 100644 --- a/clients/client-imagebuilder/commands/ListImagePipelineImagesCommand.ts +++ b/clients/client-imagebuilder/commands/ListImagePipelineImagesCommand.ts @@ -22,6 +22,20 @@ export interface ListImagePipelineImagesCommandOutput extends ListImagePipelineI /** *

Returns a list of images created by the specified pipeline.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ImagebuilderClient, ListImagePipelineImagesCommand } from "@aws-sdk/client-imagebuilder"; // ES Modules import + * // const { ImagebuilderClient, ListImagePipelineImagesCommand } = require("@aws-sdk/client-imagebuilder"); // CommonJS import + * const client = new ImagebuilderClient(config); + * const command = new ListImagePipelineImagesCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListImagePipelineImagesCommandInput} for command's `input` shape. + * @see {@link ListImagePipelineImagesCommandOutput} for command's `response` shape. + * @see {@link ImagebuilderClientResolvedConfig | config} for command's `input` shape. + * */ export class ListImagePipelineImagesCommand extends $Command< ListImagePipelineImagesCommandInput, diff --git a/clients/client-imagebuilder/commands/ListImagePipelinesCommand.ts b/clients/client-imagebuilder/commands/ListImagePipelinesCommand.ts index 79626fd19b4c..29f5047e7ac9 100644 --- a/clients/client-imagebuilder/commands/ListImagePipelinesCommand.ts +++ b/clients/client-imagebuilder/commands/ListImagePipelinesCommand.ts @@ -22,6 +22,20 @@ export interface ListImagePipelinesCommandOutput extends ListImagePipelinesRespo /** *

Returns a list of image pipelines.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ImagebuilderClient, ListImagePipelinesCommand } from "@aws-sdk/client-imagebuilder"; // ES Modules import + * // const { ImagebuilderClient, ListImagePipelinesCommand } = require("@aws-sdk/client-imagebuilder"); // CommonJS import + * const client = new ImagebuilderClient(config); + * const command = new ListImagePipelinesCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListImagePipelinesCommandInput} for command's `input` shape. + * @see {@link ListImagePipelinesCommandOutput} for command's `response` shape. + * @see {@link ImagebuilderClientResolvedConfig | config} for command's `input` shape. + * */ export class ListImagePipelinesCommand extends $Command< ListImagePipelinesCommandInput, diff --git a/clients/client-imagebuilder/commands/ListImageRecipesCommand.ts b/clients/client-imagebuilder/commands/ListImageRecipesCommand.ts index 068c7d54a031..cf4179c7e9e3 100644 --- a/clients/client-imagebuilder/commands/ListImageRecipesCommand.ts +++ b/clients/client-imagebuilder/commands/ListImageRecipesCommand.ts @@ -22,6 +22,20 @@ export interface ListImageRecipesCommandOutput extends ListImageRecipesResponse, /** *

Returns a list of image recipes.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ImagebuilderClient, ListImageRecipesCommand } from "@aws-sdk/client-imagebuilder"; // ES Modules import + * // const { ImagebuilderClient, ListImageRecipesCommand } = require("@aws-sdk/client-imagebuilder"); // CommonJS import + * const client = new ImagebuilderClient(config); + * const command = new ListImageRecipesCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListImageRecipesCommandInput} for command's `input` shape. + * @see {@link ListImageRecipesCommandOutput} for command's `response` shape. + * @see {@link ImagebuilderClientResolvedConfig | config} for command's `input` shape. + * */ export class ListImageRecipesCommand extends $Command< ListImageRecipesCommandInput, diff --git a/clients/client-imagebuilder/commands/ListImagesCommand.ts b/clients/client-imagebuilder/commands/ListImagesCommand.ts index 472a57affb89..23b4dfe08c36 100644 --- a/clients/client-imagebuilder/commands/ListImagesCommand.ts +++ b/clients/client-imagebuilder/commands/ListImagesCommand.ts @@ -22,6 +22,20 @@ export interface ListImagesCommandOutput extends ListImagesResponse, __MetadataB /** *

Returns the list of images that you have access to.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ImagebuilderClient, ListImagesCommand } from "@aws-sdk/client-imagebuilder"; // ES Modules import + * // const { ImagebuilderClient, ListImagesCommand } = require("@aws-sdk/client-imagebuilder"); // CommonJS import + * const client = new ImagebuilderClient(config); + * const command = new ListImagesCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListImagesCommandInput} for command's `input` shape. + * @see {@link ListImagesCommandOutput} for command's `response` shape. + * @see {@link ImagebuilderClientResolvedConfig | config} for command's `input` shape. + * */ export class ListImagesCommand extends $Command< ListImagesCommandInput, diff --git a/clients/client-imagebuilder/commands/ListInfrastructureConfigurationsCommand.ts b/clients/client-imagebuilder/commands/ListInfrastructureConfigurationsCommand.ts index fe6fc6a57c02..fe879f2fd14e 100644 --- a/clients/client-imagebuilder/commands/ListInfrastructureConfigurationsCommand.ts +++ b/clients/client-imagebuilder/commands/ListInfrastructureConfigurationsCommand.ts @@ -24,6 +24,20 @@ export interface ListInfrastructureConfigurationsCommandOutput /** *

Returns a list of infrastructure configurations.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ImagebuilderClient, ListInfrastructureConfigurationsCommand } from "@aws-sdk/client-imagebuilder"; // ES Modules import + * // const { ImagebuilderClient, ListInfrastructureConfigurationsCommand } = require("@aws-sdk/client-imagebuilder"); // CommonJS import + * const client = new ImagebuilderClient(config); + * const command = new ListInfrastructureConfigurationsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListInfrastructureConfigurationsCommandInput} for command's `input` shape. + * @see {@link ListInfrastructureConfigurationsCommandOutput} for command's `response` shape. + * @see {@link ImagebuilderClientResolvedConfig | config} for command's `input` shape. + * */ export class ListInfrastructureConfigurationsCommand extends $Command< ListInfrastructureConfigurationsCommandInput, diff --git a/clients/client-imagebuilder/commands/ListTagsForResourceCommand.ts b/clients/client-imagebuilder/commands/ListTagsForResourceCommand.ts index f51609a9091d..61efc0675b08 100644 --- a/clients/client-imagebuilder/commands/ListTagsForResourceCommand.ts +++ b/clients/client-imagebuilder/commands/ListTagsForResourceCommand.ts @@ -22,6 +22,20 @@ export interface ListTagsForResourceCommandOutput extends ListTagsForResourceRes /** *

Returns the list of tags for the specified resource.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ImagebuilderClient, ListTagsForResourceCommand } from "@aws-sdk/client-imagebuilder"; // ES Modules import + * // const { ImagebuilderClient, ListTagsForResourceCommand } = require("@aws-sdk/client-imagebuilder"); // CommonJS import + * const client = new ImagebuilderClient(config); + * const command = new ListTagsForResourceCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListTagsForResourceCommandInput} for command's `input` shape. + * @see {@link ListTagsForResourceCommandOutput} for command's `response` shape. + * @see {@link ImagebuilderClientResolvedConfig | config} for command's `input` shape. + * */ export class ListTagsForResourceCommand extends $Command< ListTagsForResourceCommandInput, diff --git a/clients/client-imagebuilder/commands/PutComponentPolicyCommand.ts b/clients/client-imagebuilder/commands/PutComponentPolicyCommand.ts index 1ec27cbb1a35..9ba6814d10c7 100644 --- a/clients/client-imagebuilder/commands/PutComponentPolicyCommand.ts +++ b/clients/client-imagebuilder/commands/PutComponentPolicyCommand.ts @@ -24,6 +24,20 @@ export interface PutComponentPolicyCommandOutput extends PutComponentPolicyRespo *

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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ImagebuilderClient, PutComponentPolicyCommand } from "@aws-sdk/client-imagebuilder"; // ES Modules import + * // const { ImagebuilderClient, PutComponentPolicyCommand } = require("@aws-sdk/client-imagebuilder"); // CommonJS import + * const client = new ImagebuilderClient(config); + * const command = new PutComponentPolicyCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link PutComponentPolicyCommandInput} for command's `input` shape. + * @see {@link PutComponentPolicyCommandOutput} for command's `response` shape. + * @see {@link ImagebuilderClientResolvedConfig | config} for command's `input` shape. + * */ export class PutComponentPolicyCommand extends $Command< PutComponentPolicyCommandInput, diff --git a/clients/client-imagebuilder/commands/PutContainerRecipePolicyCommand.ts b/clients/client-imagebuilder/commands/PutContainerRecipePolicyCommand.ts index 95e9ed2eb5be..05ecfe34c599 100644 --- a/clients/client-imagebuilder/commands/PutContainerRecipePolicyCommand.ts +++ b/clients/client-imagebuilder/commands/PutContainerRecipePolicyCommand.ts @@ -22,6 +22,20 @@ export interface PutContainerRecipePolicyCommandOutput extends PutContainerRecip /** *

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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ImagebuilderClient, PutContainerRecipePolicyCommand } from "@aws-sdk/client-imagebuilder"; // ES Modules import + * // const { ImagebuilderClient, PutContainerRecipePolicyCommand } = require("@aws-sdk/client-imagebuilder"); // CommonJS import + * const client = new ImagebuilderClient(config); + * const command = new PutContainerRecipePolicyCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link PutContainerRecipePolicyCommandInput} for command's `input` shape. + * @see {@link PutContainerRecipePolicyCommandOutput} for command's `response` shape. + * @see {@link ImagebuilderClientResolvedConfig | config} for command's `input` shape. + * */ export class PutContainerRecipePolicyCommand extends $Command< PutContainerRecipePolicyCommandInput, diff --git a/clients/client-imagebuilder/commands/PutImagePolicyCommand.ts b/clients/client-imagebuilder/commands/PutImagePolicyCommand.ts index 7fed08c48497..6ab8b34827cb 100644 --- a/clients/client-imagebuilder/commands/PutImagePolicyCommand.ts +++ b/clients/client-imagebuilder/commands/PutImagePolicyCommand.ts @@ -24,6 +24,20 @@ export interface PutImagePolicyCommandOutput extends PutImagePolicyResponse, __M *

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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ImagebuilderClient, PutImagePolicyCommand } from "@aws-sdk/client-imagebuilder"; // ES Modules import + * // const { ImagebuilderClient, PutImagePolicyCommand } = require("@aws-sdk/client-imagebuilder"); // CommonJS import + * const client = new ImagebuilderClient(config); + * const command = new PutImagePolicyCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link PutImagePolicyCommandInput} for command's `input` shape. + * @see {@link PutImagePolicyCommandOutput} for command's `response` shape. + * @see {@link ImagebuilderClientResolvedConfig | config} for command's `input` shape. + * */ export class PutImagePolicyCommand extends $Command< PutImagePolicyCommandInput, diff --git a/clients/client-imagebuilder/commands/PutImageRecipePolicyCommand.ts b/clients/client-imagebuilder/commands/PutImageRecipePolicyCommand.ts index 6594dee9a38b..a938580771da 100644 --- a/clients/client-imagebuilder/commands/PutImageRecipePolicyCommand.ts +++ b/clients/client-imagebuilder/commands/PutImageRecipePolicyCommand.ts @@ -24,6 +24,20 @@ export interface PutImageRecipePolicyCommandOutput extends PutImageRecipePolicyR *

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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ImagebuilderClient, PutImageRecipePolicyCommand } from "@aws-sdk/client-imagebuilder"; // ES Modules import + * // const { ImagebuilderClient, PutImageRecipePolicyCommand } = require("@aws-sdk/client-imagebuilder"); // CommonJS import + * const client = new ImagebuilderClient(config); + * const command = new PutImageRecipePolicyCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link PutImageRecipePolicyCommandInput} for command's `input` shape. + * @see {@link PutImageRecipePolicyCommandOutput} for command's `response` shape. + * @see {@link ImagebuilderClientResolvedConfig | config} for command's `input` shape. + * */ export class PutImageRecipePolicyCommand extends $Command< PutImageRecipePolicyCommandInput, diff --git a/clients/client-imagebuilder/commands/StartImagePipelineExecutionCommand.ts b/clients/client-imagebuilder/commands/StartImagePipelineExecutionCommand.ts index 8f4940fafbbd..6928e00931d9 100644 --- a/clients/client-imagebuilder/commands/StartImagePipelineExecutionCommand.ts +++ b/clients/client-imagebuilder/commands/StartImagePipelineExecutionCommand.ts @@ -24,6 +24,20 @@ export interface StartImagePipelineExecutionCommandOutput /** *

Manually triggers a pipeline to create an image.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ImagebuilderClient, StartImagePipelineExecutionCommand } from "@aws-sdk/client-imagebuilder"; // ES Modules import + * // const { ImagebuilderClient, StartImagePipelineExecutionCommand } = require("@aws-sdk/client-imagebuilder"); // CommonJS import + * const client = new ImagebuilderClient(config); + * const command = new StartImagePipelineExecutionCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link StartImagePipelineExecutionCommandInput} for command's `input` shape. + * @see {@link StartImagePipelineExecutionCommandOutput} for command's `response` shape. + * @see {@link ImagebuilderClientResolvedConfig | config} for command's `input` shape. + * */ export class StartImagePipelineExecutionCommand extends $Command< StartImagePipelineExecutionCommandInput, diff --git a/clients/client-imagebuilder/commands/TagResourceCommand.ts b/clients/client-imagebuilder/commands/TagResourceCommand.ts index e66752fd8bed..6fb6082f6dc2 100644 --- a/clients/client-imagebuilder/commands/TagResourceCommand.ts +++ b/clients/client-imagebuilder/commands/TagResourceCommand.ts @@ -22,6 +22,20 @@ export interface TagResourceCommandOutput extends TagResourceResponse, __Metadat /** *

Adds a tag to a resource.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ImagebuilderClient, TagResourceCommand } from "@aws-sdk/client-imagebuilder"; // ES Modules import + * // const { ImagebuilderClient, TagResourceCommand } = require("@aws-sdk/client-imagebuilder"); // CommonJS import + * const client = new ImagebuilderClient(config); + * const command = new TagResourceCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link TagResourceCommandInput} for command's `input` shape. + * @see {@link TagResourceCommandOutput} for command's `response` shape. + * @see {@link ImagebuilderClientResolvedConfig | config} for command's `input` shape. + * */ export class TagResourceCommand extends $Command< TagResourceCommandInput, diff --git a/clients/client-imagebuilder/commands/UntagResourceCommand.ts b/clients/client-imagebuilder/commands/UntagResourceCommand.ts index 2636bd08a956..c24886082f96 100644 --- a/clients/client-imagebuilder/commands/UntagResourceCommand.ts +++ b/clients/client-imagebuilder/commands/UntagResourceCommand.ts @@ -22,6 +22,20 @@ export interface UntagResourceCommandOutput extends UntagResourceResponse, __Met /** *

Removes a tag from a resource.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ImagebuilderClient, UntagResourceCommand } from "@aws-sdk/client-imagebuilder"; // ES Modules import + * // const { ImagebuilderClient, UntagResourceCommand } = require("@aws-sdk/client-imagebuilder"); // CommonJS import + * const client = new ImagebuilderClient(config); + * const command = new UntagResourceCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link UntagResourceCommandInput} for command's `input` shape. + * @see {@link UntagResourceCommandOutput} for command's `response` shape. + * @see {@link ImagebuilderClientResolvedConfig | config} for command's `input` shape. + * */ export class UntagResourceCommand extends $Command< UntagResourceCommandInput, diff --git a/clients/client-imagebuilder/commands/UpdateDistributionConfigurationCommand.ts b/clients/client-imagebuilder/commands/UpdateDistributionConfigurationCommand.ts index dc24edea5bdd..8f7289d845bc 100644 --- a/clients/client-imagebuilder/commands/UpdateDistributionConfigurationCommand.ts +++ b/clients/client-imagebuilder/commands/UpdateDistributionConfigurationCommand.ts @@ -25,6 +25,20 @@ export interface UpdateDistributionConfigurationCommandOutput /** *

Updates a new distribution configuration. Distribution configurations define and * configure the outputs of your pipeline.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ImagebuilderClient, UpdateDistributionConfigurationCommand } from "@aws-sdk/client-imagebuilder"; // ES Modules import + * // const { ImagebuilderClient, UpdateDistributionConfigurationCommand } = require("@aws-sdk/client-imagebuilder"); // CommonJS import + * const client = new ImagebuilderClient(config); + * const command = new UpdateDistributionConfigurationCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link UpdateDistributionConfigurationCommandInput} for command's `input` shape. + * @see {@link UpdateDistributionConfigurationCommandOutput} for command's `response` shape. + * @see {@link ImagebuilderClientResolvedConfig | config} for command's `input` shape. + * */ export class UpdateDistributionConfigurationCommand extends $Command< UpdateDistributionConfigurationCommandInput, diff --git a/clients/client-imagebuilder/commands/UpdateImagePipelineCommand.ts b/clients/client-imagebuilder/commands/UpdateImagePipelineCommand.ts index 06db16a6c1b2..222fa9764a2f 100644 --- a/clients/client-imagebuilder/commands/UpdateImagePipelineCommand.ts +++ b/clients/client-imagebuilder/commands/UpdateImagePipelineCommand.ts @@ -23,6 +23,20 @@ export interface UpdateImagePipelineCommandOutput extends UpdateImagePipelineRes /** *

Updates a new image pipeline. Image pipelines enable you to automate the creation and * distribution of images.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ImagebuilderClient, UpdateImagePipelineCommand } from "@aws-sdk/client-imagebuilder"; // ES Modules import + * // const { ImagebuilderClient, UpdateImagePipelineCommand } = require("@aws-sdk/client-imagebuilder"); // CommonJS import + * const client = new ImagebuilderClient(config); + * const command = new UpdateImagePipelineCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link UpdateImagePipelineCommandInput} for command's `input` shape. + * @see {@link UpdateImagePipelineCommandOutput} for command's `response` shape. + * @see {@link ImagebuilderClientResolvedConfig | config} for command's `input` shape. + * */ export class UpdateImagePipelineCommand extends $Command< UpdateImagePipelineCommandInput, diff --git a/clients/client-imagebuilder/commands/UpdateInfrastructureConfigurationCommand.ts b/clients/client-imagebuilder/commands/UpdateInfrastructureConfigurationCommand.ts index 8e741b72ada0..0572a0b6fe71 100644 --- a/clients/client-imagebuilder/commands/UpdateInfrastructureConfigurationCommand.ts +++ b/clients/client-imagebuilder/commands/UpdateInfrastructureConfigurationCommand.ts @@ -28,6 +28,20 @@ export interface UpdateInfrastructureConfigurationCommandOutput /** *

Updates a new infrastructure configuration. An infrastructure configuration defines the * environment in which your image will be built and tested.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ImagebuilderClient, UpdateInfrastructureConfigurationCommand } from "@aws-sdk/client-imagebuilder"; // ES Modules import + * // const { ImagebuilderClient, UpdateInfrastructureConfigurationCommand } = require("@aws-sdk/client-imagebuilder"); // CommonJS import + * const client = new ImagebuilderClient(config); + * const command = new UpdateInfrastructureConfigurationCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link UpdateInfrastructureConfigurationCommandInput} for command's `input` shape. + * @see {@link UpdateInfrastructureConfigurationCommandOutput} for command's `response` shape. + * @see {@link ImagebuilderClientResolvedConfig | config} for command's `input` shape. + * */ export class UpdateInfrastructureConfigurationCommand extends $Command< UpdateInfrastructureConfigurationCommandInput, diff --git a/clients/client-imagebuilder/models/models_0.ts b/clients/client-imagebuilder/models/models_0.ts index 0b2d8a29eb00..7f3a45a5d98a 100644 --- a/clients/client-imagebuilder/models/models_0.ts +++ b/clients/client-imagebuilder/models/models_0.ts @@ -31,6 +31,9 @@ export interface ImageState { } export namespace ImageState { + /** + * @internal + */ export const filterSensitiveLog = (obj: ImageState): any => ({ ...obj, }); @@ -72,6 +75,9 @@ export interface Ami { } export namespace Ami { + /** + * @internal + */ export const filterSensitiveLog = (obj: Ami): any => ({ ...obj, }); @@ -97,6 +103,9 @@ export interface LaunchPermissionConfiguration { } export namespace LaunchPermissionConfiguration { + /** + * @internal + */ export const filterSensitiveLog = (obj: LaunchPermissionConfiguration): any => ({ ...obj, }); @@ -139,6 +148,9 @@ export interface AmiDistributionConfiguration { } export namespace AmiDistributionConfiguration { + /** + * @internal + */ export const filterSensitiveLog = (obj: AmiDistributionConfiguration): any => ({ ...obj, }); @@ -154,6 +166,9 @@ export interface CallRateLimitExceededException extends __SmithyException, $Meta } export namespace CallRateLimitExceededException { + /** + * @internal + */ export const filterSensitiveLog = (obj: CallRateLimitExceededException): any => ({ ...obj, }); @@ -172,6 +187,9 @@ export interface CancelImageCreationRequest { } export namespace CancelImageCreationRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: CancelImageCreationRequest): any => ({ ...obj, }); @@ -195,6 +213,9 @@ export interface CancelImageCreationResponse { } export namespace CancelImageCreationResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: CancelImageCreationResponse): any => ({ ...obj, }); @@ -212,6 +233,9 @@ export interface ClientException extends __SmithyException, $MetadataBearer { } export namespace ClientException { + /** + * @internal + */ export const filterSensitiveLog = (obj: ClientException): any => ({ ...obj, }); @@ -227,6 +251,9 @@ export interface ForbiddenException extends __SmithyException, $MetadataBearer { } export namespace ForbiddenException { + /** + * @internal + */ export const filterSensitiveLog = (obj: ForbiddenException): any => ({ ...obj, }); @@ -243,6 +270,9 @@ export interface IdempotentParameterMismatchException extends __SmithyException, } export namespace IdempotentParameterMismatchException { + /** + * @internal + */ export const filterSensitiveLog = (obj: IdempotentParameterMismatchException): any => ({ ...obj, }); @@ -258,6 +288,9 @@ export interface InvalidRequestException extends __SmithyException, $MetadataBea } export namespace InvalidRequestException { + /** + * @internal + */ export const filterSensitiveLog = (obj: InvalidRequestException): any => ({ ...obj, }); @@ -274,6 +307,9 @@ export interface ResourceInUseException extends __SmithyException, $MetadataBear } export namespace ResourceInUseException { + /** + * @internal + */ export const filterSensitiveLog = (obj: ResourceInUseException): any => ({ ...obj, }); @@ -289,6 +325,9 @@ export interface ServiceException extends __SmithyException, $MetadataBearer { } export namespace ServiceException { + /** + * @internal + */ export const filterSensitiveLog = (obj: ServiceException): any => ({ ...obj, }); @@ -304,6 +343,9 @@ export interface ServiceUnavailableException extends __SmithyException, $Metadat } export namespace ServiceUnavailableException { + /** + * @internal + */ export const filterSensitiveLog = (obj: ServiceUnavailableException): any => ({ ...obj, }); @@ -398,6 +440,9 @@ export interface Component { } export namespace Component { + /** + * @internal + */ export const filterSensitiveLog = (obj: Component): any => ({ ...obj, }); @@ -414,6 +459,9 @@ export interface ComponentConfiguration { } export namespace ComponentConfiguration { + /** + * @internal + */ export const filterSensitiveLog = (obj: ComponentConfiguration): any => ({ ...obj, }); @@ -487,6 +535,9 @@ export interface ComponentSummary { } export namespace ComponentSummary { + /** + * @internal + */ export const filterSensitiveLog = (obj: ComponentSummary): any => ({ ...obj, }); @@ -546,6 +597,9 @@ export interface ComponentVersion { } export namespace ComponentVersion { + /** + * @internal + */ export const filterSensitiveLog = (obj: ComponentVersion): any => ({ ...obj, }); @@ -567,6 +621,9 @@ export interface Container { } export namespace Container { + /** + * @internal + */ export const filterSensitiveLog = (obj: Container): any => ({ ...obj, }); @@ -592,6 +649,9 @@ export interface TargetContainerRepository { } export namespace TargetContainerRepository { + /** + * @internal + */ export const filterSensitiveLog = (obj: TargetContainerRepository): any => ({ ...obj, }); @@ -618,6 +678,9 @@ export interface ContainerDistributionConfiguration { } export namespace ContainerDistributionConfiguration { + /** + * @internal + */ export const filterSensitiveLog = (obj: ContainerDistributionConfiguration): any => ({ ...obj, }); @@ -678,6 +741,9 @@ export interface EbsInstanceBlockDeviceSpecification { } export namespace EbsInstanceBlockDeviceSpecification { + /** + * @internal + */ export const filterSensitiveLog = (obj: EbsInstanceBlockDeviceSpecification): any => ({ ...obj, }); @@ -709,6 +775,9 @@ export interface InstanceBlockDeviceMapping { } export namespace InstanceBlockDeviceMapping { + /** + * @internal + */ export const filterSensitiveLog = (obj: InstanceBlockDeviceMapping): any => ({ ...obj, }); @@ -732,6 +801,9 @@ export interface InstanceConfiguration { } export namespace InstanceConfiguration { + /** + * @internal + */ export const filterSensitiveLog = (obj: InstanceConfiguration): any => ({ ...obj, }); @@ -828,6 +900,9 @@ export interface ContainerRecipe { } export namespace ContainerRecipe { + /** + * @internal + */ export const filterSensitiveLog = (obj: ContainerRecipe): any => ({ ...obj, }); @@ -879,6 +954,9 @@ export interface ContainerRecipeSummary { } export namespace ContainerRecipeSummary { + /** + * @internal + */ export const filterSensitiveLog = (obj: ContainerRecipeSummary): any => ({ ...obj, }); @@ -951,6 +1029,9 @@ export interface CreateComponentRequest { } export namespace CreateComponentRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateComponentRequest): any => ({ ...obj, }); @@ -974,6 +1055,9 @@ export interface CreateComponentResponse { } export namespace CreateComponentResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateComponentResponse): any => ({ ...obj, }); @@ -990,6 +1074,9 @@ export interface InvalidParameterCombinationException extends __SmithyException, } export namespace InvalidParameterCombinationException { + /** + * @internal + */ export const filterSensitiveLog = (obj: InvalidParameterCombinationException): any => ({ ...obj, }); @@ -1005,6 +1092,9 @@ export interface InvalidVersionNumberException extends __SmithyException, $Metad } export namespace InvalidVersionNumberException { + /** + * @internal + */ export const filterSensitiveLog = (obj: InvalidVersionNumberException): any => ({ ...obj, }); @@ -1020,6 +1110,9 @@ export interface ServiceQuotaExceededException extends __SmithyException, $Metad } export namespace ServiceQuotaExceededException { + /** + * @internal + */ export const filterSensitiveLog = (obj: ServiceQuotaExceededException): any => ({ ...obj, }); @@ -1108,6 +1201,9 @@ export interface CreateContainerRecipeRequest { } export namespace CreateContainerRecipeRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateContainerRecipeRequest): any => ({ ...obj, }); @@ -1131,6 +1227,9 @@ export interface CreateContainerRecipeResponse { } export namespace CreateContainerRecipeResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateContainerRecipeResponse): any => ({ ...obj, }); @@ -1146,6 +1245,9 @@ export interface ResourceAlreadyExistsException extends __SmithyException, $Meta } export namespace ResourceAlreadyExistsException { + /** + * @internal + */ export const filterSensitiveLog = (obj: ResourceAlreadyExistsException): any => ({ ...obj, }); @@ -1172,6 +1274,9 @@ export interface LaunchTemplateConfiguration { } export namespace LaunchTemplateConfiguration { + /** + * @internal + */ export const filterSensitiveLog = (obj: LaunchTemplateConfiguration): any => ({ ...obj, }); @@ -1211,6 +1316,9 @@ export interface Distribution { } export namespace Distribution { + /** + * @internal + */ export const filterSensitiveLog = (obj: Distribution): any => ({ ...obj, }); @@ -1244,6 +1352,9 @@ export interface CreateDistributionConfigurationRequest { } export namespace CreateDistributionConfigurationRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateDistributionConfigurationRequest): any => ({ ...obj, }); @@ -1268,6 +1379,9 @@ export interface CreateDistributionConfigurationResponse { } export namespace CreateDistributionConfigurationResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateDistributionConfigurationResponse): any => ({ ...obj, }); @@ -1289,6 +1403,9 @@ export interface ImageTestsConfiguration { } export namespace ImageTestsConfiguration { + /** + * @internal + */ export const filterSensitiveLog = (obj: ImageTestsConfiguration): any => ({ ...obj, }); @@ -1342,6 +1459,9 @@ export interface CreateImageRequest { } export namespace CreateImageRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateImageRequest): any => ({ ...obj, }); @@ -1365,6 +1485,9 @@ export interface CreateImageResponse { } export namespace CreateImageResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateImageResponse): any => ({ ...obj, }); @@ -1409,6 +1532,9 @@ export interface Schedule { } export namespace Schedule { + /** + * @internal + */ export const filterSensitiveLog = (obj: Schedule): any => ({ ...obj, }); @@ -1487,6 +1613,9 @@ export interface CreateImagePipelineRequest { } export namespace CreateImagePipelineRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateImagePipelineRequest): any => ({ ...obj, }); @@ -1510,6 +1639,9 @@ export interface CreateImagePipelineResponse { } export namespace CreateImagePipelineResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateImagePipelineResponse): any => ({ ...obj, }); @@ -1568,6 +1700,9 @@ export interface CreateImageRecipeRequest { } export namespace CreateImageRecipeRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateImageRecipeRequest): any => ({ ...obj, }); @@ -1591,6 +1726,9 @@ export interface CreateImageRecipeResponse { } export namespace CreateImageRecipeResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateImageRecipeResponse): any => ({ ...obj, }); @@ -1612,6 +1750,9 @@ export interface S3Logs { } export namespace S3Logs { + /** + * @internal + */ export const filterSensitiveLog = (obj: S3Logs): any => ({ ...obj, }); @@ -1628,6 +1769,9 @@ export interface Logging { } export namespace Logging { + /** + * @internal + */ export const filterSensitiveLog = (obj: Logging): any => ({ ...obj, }); @@ -1706,6 +1850,9 @@ export interface CreateInfrastructureConfigurationRequest { } export namespace CreateInfrastructureConfigurationRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateInfrastructureConfigurationRequest): any => ({ ...obj, }); @@ -1730,6 +1877,9 @@ export interface CreateInfrastructureConfigurationResponse { } export namespace CreateInfrastructureConfigurationResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateInfrastructureConfigurationResponse): any => ({ ...obj, }); @@ -1743,6 +1893,9 @@ export interface DeleteComponentRequest { } export namespace DeleteComponentRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteComponentRequest): any => ({ ...obj, }); @@ -1761,6 +1914,9 @@ export interface DeleteComponentResponse { } export namespace DeleteComponentResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteComponentResponse): any => ({ ...obj, }); @@ -1777,6 +1933,9 @@ export interface ResourceDependencyException extends __SmithyException, $Metadat } export namespace ResourceDependencyException { + /** + * @internal + */ export const filterSensitiveLog = (obj: ResourceDependencyException): any => ({ ...obj, }); @@ -1790,6 +1949,9 @@ export interface DeleteContainerRecipeRequest { } export namespace DeleteContainerRecipeRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteContainerRecipeRequest): any => ({ ...obj, }); @@ -1808,6 +1970,9 @@ export interface DeleteContainerRecipeResponse { } export namespace DeleteContainerRecipeResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteContainerRecipeResponse): any => ({ ...obj, }); @@ -1821,6 +1986,9 @@ export interface DeleteDistributionConfigurationRequest { } export namespace DeleteDistributionConfigurationRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteDistributionConfigurationRequest): any => ({ ...obj, }); @@ -1839,6 +2007,9 @@ export interface DeleteDistributionConfigurationResponse { } export namespace DeleteDistributionConfigurationResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteDistributionConfigurationResponse): any => ({ ...obj, }); @@ -1852,6 +2023,9 @@ export interface DeleteImageRequest { } export namespace DeleteImageRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteImageRequest): any => ({ ...obj, }); @@ -1870,6 +2044,9 @@ export interface DeleteImageResponse { } export namespace DeleteImageResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteImageResponse): any => ({ ...obj, }); @@ -1883,6 +2060,9 @@ export interface DeleteImagePipelineRequest { } export namespace DeleteImagePipelineRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteImagePipelineRequest): any => ({ ...obj, }); @@ -1901,6 +2081,9 @@ export interface DeleteImagePipelineResponse { } export namespace DeleteImagePipelineResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteImagePipelineResponse): any => ({ ...obj, }); @@ -1914,6 +2097,9 @@ export interface DeleteImageRecipeRequest { } export namespace DeleteImageRecipeRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteImageRecipeRequest): any => ({ ...obj, }); @@ -1932,6 +2118,9 @@ export interface DeleteImageRecipeResponse { } export namespace DeleteImageRecipeResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteImageRecipeResponse): any => ({ ...obj, }); @@ -1945,6 +2134,9 @@ export interface DeleteInfrastructureConfigurationRequest { } export namespace DeleteInfrastructureConfigurationRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteInfrastructureConfigurationRequest): any => ({ ...obj, }); @@ -1963,6 +2155,9 @@ export interface DeleteInfrastructureConfigurationResponse { } export namespace DeleteInfrastructureConfigurationResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteInfrastructureConfigurationResponse): any => ({ ...obj, }); @@ -2015,6 +2210,9 @@ export interface DistributionConfiguration { } export namespace DistributionConfiguration { + /** + * @internal + */ export const filterSensitiveLog = (obj: DistributionConfiguration): any => ({ ...obj, }); @@ -2061,6 +2259,9 @@ export interface DistributionConfigurationSummary { } export namespace DistributionConfigurationSummary { + /** + * @internal + */ export const filterSensitiveLog = (obj: DistributionConfigurationSummary): any => ({ ...obj, }); @@ -2084,6 +2285,9 @@ export interface Filter { } export namespace Filter { + /** + * @internal + */ export const filterSensitiveLog = (obj: Filter): any => ({ ...obj, }); @@ -2098,6 +2302,9 @@ export interface GetComponentRequest { } export namespace GetComponentRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetComponentRequest): any => ({ ...obj, }); @@ -2116,6 +2323,9 @@ export interface GetComponentResponse { } export namespace GetComponentResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetComponentResponse): any => ({ ...obj, }); @@ -2129,6 +2339,9 @@ export interface GetComponentPolicyRequest { } export namespace GetComponentPolicyRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetComponentPolicyRequest): any => ({ ...obj, }); @@ -2147,6 +2360,9 @@ export interface GetComponentPolicyResponse { } export namespace GetComponentPolicyResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetComponentPolicyResponse): any => ({ ...obj, }); @@ -2162,6 +2378,9 @@ export interface ResourceNotFoundException extends __SmithyException, $MetadataB } export namespace ResourceNotFoundException { + /** + * @internal + */ export const filterSensitiveLog = (obj: ResourceNotFoundException): any => ({ ...obj, }); @@ -2175,6 +2394,9 @@ export interface GetContainerRecipeRequest { } export namespace GetContainerRecipeRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetContainerRecipeRequest): any => ({ ...obj, }); @@ -2193,6 +2415,9 @@ export interface GetContainerRecipeResponse { } export namespace GetContainerRecipeResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetContainerRecipeResponse): any => ({ ...obj, }); @@ -2206,6 +2431,9 @@ export interface GetContainerRecipePolicyRequest { } export namespace GetContainerRecipePolicyRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetContainerRecipePolicyRequest): any => ({ ...obj, }); @@ -2224,6 +2452,9 @@ export interface GetContainerRecipePolicyResponse { } export namespace GetContainerRecipePolicyResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetContainerRecipePolicyResponse): any => ({ ...obj, }); @@ -2238,6 +2469,9 @@ export interface GetDistributionConfigurationRequest { } export namespace GetDistributionConfigurationRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetDistributionConfigurationRequest): any => ({ ...obj, }); @@ -2256,6 +2490,9 @@ export interface GetDistributionConfigurationResponse { } export namespace GetDistributionConfigurationResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetDistributionConfigurationResponse): any => ({ ...obj, }); @@ -2269,6 +2506,9 @@ export interface GetImageRequest { } export namespace GetImageRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetImageRequest): any => ({ ...obj, }); @@ -2350,6 +2590,9 @@ export interface ImageRecipe { } export namespace ImageRecipe { + /** + * @internal + */ export const filterSensitiveLog = (obj: ImageRecipe): any => ({ ...obj, }); @@ -2437,6 +2680,9 @@ export interface InfrastructureConfiguration { } export namespace InfrastructureConfiguration { + /** + * @internal + */ export const filterSensitiveLog = (obj: InfrastructureConfiguration): any => ({ ...obj, }); @@ -2458,6 +2704,9 @@ export interface OutputResources { } export namespace OutputResources { + /** + * @internal + */ export const filterSensitiveLog = (obj: OutputResources): any => ({ ...obj, }); @@ -2562,6 +2811,9 @@ export interface Image { } export namespace Image { + /** + * @internal + */ export const filterSensitiveLog = (obj: Image): any => ({ ...obj, }); @@ -2580,6 +2832,9 @@ export interface GetImageResponse { } export namespace GetImageResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetImageResponse): any => ({ ...obj, }); @@ -2593,6 +2848,9 @@ export interface GetImagePipelineRequest { } export namespace GetImagePipelineRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetImagePipelineRequest): any => ({ ...obj, }); @@ -2694,6 +2952,9 @@ export interface ImagePipeline { } export namespace ImagePipeline { + /** + * @internal + */ export const filterSensitiveLog = (obj: ImagePipeline): any => ({ ...obj, }); @@ -2712,6 +2973,9 @@ export interface GetImagePipelineResponse { } export namespace GetImagePipelineResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetImagePipelineResponse): any => ({ ...obj, }); @@ -2725,6 +2989,9 @@ export interface GetImagePolicyRequest { } export namespace GetImagePolicyRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetImagePolicyRequest): any => ({ ...obj, }); @@ -2743,6 +3010,9 @@ export interface GetImagePolicyResponse { } export namespace GetImagePolicyResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetImagePolicyResponse): any => ({ ...obj, }); @@ -2756,6 +3026,9 @@ export interface GetImageRecipeRequest { } export namespace GetImageRecipeRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetImageRecipeRequest): any => ({ ...obj, }); @@ -2774,6 +3047,9 @@ export interface GetImageRecipeResponse { } export namespace GetImageRecipeResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetImageRecipeResponse): any => ({ ...obj, }); @@ -2787,6 +3063,9 @@ export interface GetImageRecipePolicyRequest { } export namespace GetImageRecipePolicyRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetImageRecipePolicyRequest): any => ({ ...obj, }); @@ -2805,6 +3084,9 @@ export interface GetImageRecipePolicyResponse { } export namespace GetImageRecipePolicyResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetImageRecipePolicyResponse): any => ({ ...obj, }); @@ -2822,6 +3104,9 @@ export interface GetInfrastructureConfigurationRequest { } export namespace GetInfrastructureConfigurationRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetInfrastructureConfigurationRequest): any => ({ ...obj, }); @@ -2843,6 +3128,9 @@ export interface GetInfrastructureConfigurationResponse { } export namespace GetInfrastructureConfigurationResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetInfrastructureConfigurationResponse): any => ({ ...obj, }); @@ -2919,6 +3207,9 @@ export interface ImportComponentRequest { } export namespace ImportComponentRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ImportComponentRequest): any => ({ ...obj, }); @@ -2942,6 +3233,9 @@ export interface ImportComponentResponse { } export namespace ImportComponentResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ImportComponentResponse): any => ({ ...obj, }); @@ -2957,6 +3251,9 @@ export interface InvalidPaginationTokenException extends __SmithyException, $Met } export namespace InvalidPaginationTokenException { + /** + * @internal + */ export const filterSensitiveLog = (obj: InvalidPaginationTokenException): any => ({ ...obj, }); @@ -2981,6 +3278,9 @@ export interface ListComponentBuildVersionsRequest { } export namespace ListComponentBuildVersionsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListComponentBuildVersionsRequest): any => ({ ...obj, }); @@ -3006,6 +3306,9 @@ export interface ListComponentBuildVersionsResponse { } export namespace ListComponentBuildVersionsResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListComponentBuildVersionsResponse): any => ({ ...obj, }); @@ -3049,6 +3352,9 @@ export interface ListComponentsRequest { } export namespace ListComponentsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListComponentsRequest): any => ({ ...obj, }); @@ -3074,6 +3380,9 @@ export interface ListComponentsResponse { } export namespace ListComponentsResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListComponentsResponse): any => ({ ...obj, }); @@ -3102,6 +3411,9 @@ export interface ListContainerRecipesRequest { } export namespace ListContainerRecipesRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListContainerRecipesRequest): any => ({ ...obj, }); @@ -3125,6 +3437,9 @@ export interface ListContainerRecipesResponse { } export namespace ListContainerRecipesResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListContainerRecipesResponse): any => ({ ...obj, }); @@ -3155,6 +3470,9 @@ export interface ListDistributionConfigurationsRequest { } export namespace ListDistributionConfigurationsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListDistributionConfigurationsRequest): any => ({ ...obj, }); @@ -3180,6 +3498,9 @@ export interface ListDistributionConfigurationsResponse { } export namespace ListDistributionConfigurationsResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListDistributionConfigurationsResponse): any => ({ ...obj, }); @@ -3209,6 +3530,9 @@ export interface ListImageBuildVersionsRequest { } export namespace ListImageBuildVersionsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListImageBuildVersionsRequest): any => ({ ...obj, }); @@ -3276,6 +3600,9 @@ export interface ImageSummary { } export namespace ImageSummary { + /** + * @internal + */ export const filterSensitiveLog = (obj: ImageSummary): any => ({ ...obj, }); @@ -3301,6 +3628,9 @@ export interface ListImageBuildVersionsResponse { } export namespace ListImageBuildVersionsResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListImageBuildVersionsResponse): any => ({ ...obj, }); @@ -3324,6 +3654,9 @@ export interface ListImagePackagesRequest { } export namespace ListImagePackagesRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListImagePackagesRequest): any => ({ ...obj, }); @@ -3345,6 +3678,9 @@ export interface ImagePackage { } export namespace ImagePackage { + /** + * @internal + */ export const filterSensitiveLog = (obj: ImagePackage): any => ({ ...obj, }); @@ -3368,6 +3704,9 @@ export interface ListImagePackagesResponse { } export namespace ListImagePackagesResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListImagePackagesResponse): any => ({ ...obj, }); @@ -3397,6 +3736,9 @@ export interface ListImagePipelineImagesRequest { } export namespace ListImagePipelineImagesRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListImagePipelineImagesRequest): any => ({ ...obj, }); @@ -3422,6 +3764,9 @@ export interface ListImagePipelineImagesResponse { } export namespace ListImagePipelineImagesResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListImagePipelineImagesResponse): any => ({ ...obj, }); @@ -3446,6 +3791,9 @@ export interface ListImagePipelinesRequest { } export namespace ListImagePipelinesRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListImagePipelinesRequest): any => ({ ...obj, }); @@ -3471,6 +3819,9 @@ export interface ListImagePipelinesResponse { } export namespace ListImagePipelinesResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListImagePipelinesResponse): any => ({ ...obj, }); @@ -3503,6 +3854,9 @@ export interface ListImageRecipesRequest { } export namespace ListImageRecipesRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListImageRecipesRequest): any => ({ ...obj, }); @@ -3549,6 +3903,9 @@ export interface ImageRecipeSummary { } export namespace ImageRecipeSummary { + /** + * @internal + */ export const filterSensitiveLog = (obj: ImageRecipeSummary): any => ({ ...obj, }); @@ -3574,6 +3931,9 @@ export interface ListImageRecipesResponse { } export namespace ListImageRecipesResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListImageRecipesResponse): any => ({ ...obj, }); @@ -3616,6 +3976,9 @@ export interface ListImagesRequest { } export namespace ListImagesRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListImagesRequest): any => ({ ...obj, }); @@ -3668,6 +4031,9 @@ export interface ImageVersion { } export namespace ImageVersion { + /** + * @internal + */ export const filterSensitiveLog = (obj: ImageVersion): any => ({ ...obj, }); @@ -3693,6 +4059,9 @@ export interface ListImagesResponse { } export namespace ListImagesResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListImagesResponse): any => ({ ...obj, }); @@ -3717,6 +4086,9 @@ export interface ListInfrastructureConfigurationsRequest { } export namespace ListInfrastructureConfigurationsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListInfrastructureConfigurationsRequest): any => ({ ...obj, }); @@ -3773,6 +4145,9 @@ export interface InfrastructureConfigurationSummary { } export namespace InfrastructureConfigurationSummary { + /** + * @internal + */ export const filterSensitiveLog = (obj: InfrastructureConfigurationSummary): any => ({ ...obj, }); @@ -3798,6 +4173,9 @@ export interface ListInfrastructureConfigurationsResponse { } export namespace ListInfrastructureConfigurationsResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListInfrastructureConfigurationsResponse): any => ({ ...obj, }); @@ -3814,6 +4192,9 @@ export interface InvalidParameterException extends __SmithyException, $MetadataB } export namespace InvalidParameterException { + /** + * @internal + */ export const filterSensitiveLog = (obj: InvalidParameterException): any => ({ ...obj, }); @@ -3827,6 +4208,9 @@ export interface ListTagsForResourceRequest { } export namespace ListTagsForResourceRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListTagsForResourceRequest): any => ({ ...obj, }); @@ -3840,6 +4224,9 @@ export interface ListTagsForResourceResponse { } export namespace ListTagsForResourceResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListTagsForResourceResponse): any => ({ ...obj, }); @@ -3855,6 +4242,9 @@ export interface InvalidParameterValueException extends __SmithyException, $Meta } export namespace InvalidParameterValueException { + /** + * @internal + */ export const filterSensitiveLog = (obj: InvalidParameterValueException): any => ({ ...obj, }); @@ -3873,6 +4263,9 @@ export interface PutComponentPolicyRequest { } export namespace PutComponentPolicyRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: PutComponentPolicyRequest): any => ({ ...obj, }); @@ -3891,6 +4284,9 @@ export interface PutComponentPolicyResponse { } export namespace PutComponentPolicyResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: PutComponentPolicyResponse): any => ({ ...obj, }); @@ -3909,6 +4305,9 @@ export interface PutContainerRecipePolicyRequest { } export namespace PutContainerRecipePolicyRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: PutContainerRecipePolicyRequest): any => ({ ...obj, }); @@ -3927,6 +4326,9 @@ export interface PutContainerRecipePolicyResponse { } export namespace PutContainerRecipePolicyResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: PutContainerRecipePolicyResponse): any => ({ ...obj, }); @@ -3945,6 +4347,9 @@ export interface PutImagePolicyRequest { } export namespace PutImagePolicyRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: PutImagePolicyRequest): any => ({ ...obj, }); @@ -3963,6 +4368,9 @@ export interface PutImagePolicyResponse { } export namespace PutImagePolicyResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: PutImagePolicyResponse): any => ({ ...obj, }); @@ -3981,6 +4389,9 @@ export interface PutImageRecipePolicyRequest { } export namespace PutImageRecipePolicyRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: PutImageRecipePolicyRequest): any => ({ ...obj, }); @@ -3999,6 +4410,9 @@ export interface PutImageRecipePolicyResponse { } export namespace PutImageRecipePolicyResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: PutImageRecipePolicyResponse): any => ({ ...obj, }); @@ -4017,6 +4431,9 @@ export interface StartImagePipelineExecutionRequest { } export namespace StartImagePipelineExecutionRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: StartImagePipelineExecutionRequest): any => ({ ...obj, }); @@ -4040,6 +4457,9 @@ export interface StartImagePipelineExecutionResponse { } export namespace StartImagePipelineExecutionResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: StartImagePipelineExecutionResponse): any => ({ ...obj, }); @@ -4058,6 +4478,9 @@ export interface TagResourceRequest { } export namespace TagResourceRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: TagResourceRequest): any => ({ ...obj, }); @@ -4066,6 +4489,9 @@ export namespace TagResourceRequest { export interface TagResourceResponse {} export namespace TagResourceResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: TagResourceResponse): any => ({ ...obj, }); @@ -4084,6 +4510,9 @@ export interface UntagResourceRequest { } export namespace UntagResourceRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: UntagResourceRequest): any => ({ ...obj, }); @@ -4092,6 +4521,9 @@ export namespace UntagResourceRequest { export interface UntagResourceResponse {} export namespace UntagResourceResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: UntagResourceResponse): any => ({ ...obj, }); @@ -4120,6 +4552,9 @@ export interface UpdateDistributionConfigurationRequest { } export namespace UpdateDistributionConfigurationRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateDistributionConfigurationRequest): any => ({ ...obj, }); @@ -4144,6 +4579,9 @@ export interface UpdateDistributionConfigurationResponse { } export namespace UpdateDistributionConfigurationResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateDistributionConfigurationResponse): any => ({ ...obj, }); @@ -4212,6 +4650,9 @@ export interface UpdateImagePipelineRequest { } export namespace UpdateImagePipelineRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateImagePipelineRequest): any => ({ ...obj, }); @@ -4235,6 +4676,9 @@ export interface UpdateImagePipelineResponse { } export namespace UpdateImagePipelineResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateImagePipelineResponse): any => ({ ...obj, }); @@ -4309,6 +4753,9 @@ export interface UpdateInfrastructureConfigurationRequest { } export namespace UpdateInfrastructureConfigurationRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateInfrastructureConfigurationRequest): any => ({ ...obj, }); @@ -4333,6 +4780,9 @@ export interface UpdateInfrastructureConfigurationResponse { } export namespace UpdateInfrastructureConfigurationResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateInfrastructureConfigurationResponse): any => ({ ...obj, }); diff --git a/clients/client-inspector/commands/AddAttributesToFindingsCommand.ts b/clients/client-inspector/commands/AddAttributesToFindingsCommand.ts index fba09f2fda68..e72f2ccdf026 100644 --- a/clients/client-inspector/commands/AddAttributesToFindingsCommand.ts +++ b/clients/client-inspector/commands/AddAttributesToFindingsCommand.ts @@ -23,6 +23,20 @@ export interface AddAttributesToFindingsCommandOutput extends AddAttributesToFin /** *

Assigns attributes (key and value pairs) to the findings that are specified by the * ARNs of the findings.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { InspectorClient, AddAttributesToFindingsCommand } from "@aws-sdk/client-inspector"; // ES Modules import + * // const { InspectorClient, AddAttributesToFindingsCommand } = require("@aws-sdk/client-inspector"); // CommonJS import + * const client = new InspectorClient(config); + * const command = new AddAttributesToFindingsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link AddAttributesToFindingsCommandInput} for command's `input` shape. + * @see {@link AddAttributesToFindingsCommandOutput} for command's `response` shape. + * @see {@link InspectorClientResolvedConfig | config} for command's `input` shape. + * */ export class AddAttributesToFindingsCommand extends $Command< AddAttributesToFindingsCommandInput, diff --git a/clients/client-inspector/commands/CreateAssessmentTargetCommand.ts b/clients/client-inspector/commands/CreateAssessmentTargetCommand.ts index 4e52c3aa7900..002f6f2af214 100644 --- a/clients/client-inspector/commands/CreateAssessmentTargetCommand.ts +++ b/clients/client-inspector/commands/CreateAssessmentTargetCommand.ts @@ -29,6 +29,20 @@ export interface CreateAssessmentTargetCommandOutput extends CreateAssessmentTar * 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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { InspectorClient, CreateAssessmentTargetCommand } from "@aws-sdk/client-inspector"; // ES Modules import + * // const { InspectorClient, CreateAssessmentTargetCommand } = require("@aws-sdk/client-inspector"); // CommonJS import + * const client = new InspectorClient(config); + * const command = new CreateAssessmentTargetCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreateAssessmentTargetCommandInput} for command's `input` shape. + * @see {@link CreateAssessmentTargetCommandOutput} for command's `response` shape. + * @see {@link InspectorClientResolvedConfig | config} for command's `input` shape. + * */ export class CreateAssessmentTargetCommand extends $Command< CreateAssessmentTargetCommandInput, diff --git a/clients/client-inspector/commands/CreateAssessmentTemplateCommand.ts b/clients/client-inspector/commands/CreateAssessmentTemplateCommand.ts index d9e8b4a5311d..47a6cabc7366 100644 --- a/clients/client-inspector/commands/CreateAssessmentTemplateCommand.ts +++ b/clients/client-inspector/commands/CreateAssessmentTemplateCommand.ts @@ -25,6 +25,20 @@ export interface CreateAssessmentTemplateCommandOutput extends CreateAssessmentT * 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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { InspectorClient, CreateAssessmentTemplateCommand } from "@aws-sdk/client-inspector"; // ES Modules import + * // const { InspectorClient, CreateAssessmentTemplateCommand } = require("@aws-sdk/client-inspector"); // CommonJS import + * const client = new InspectorClient(config); + * const command = new CreateAssessmentTemplateCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreateAssessmentTemplateCommandInput} for command's `input` shape. + * @see {@link CreateAssessmentTemplateCommandOutput} for command's `response` shape. + * @see {@link InspectorClientResolvedConfig | config} for command's `input` shape. + * */ export class CreateAssessmentTemplateCommand extends $Command< CreateAssessmentTemplateCommandInput, diff --git a/clients/client-inspector/commands/CreateExclusionsPreviewCommand.ts b/clients/client-inspector/commands/CreateExclusionsPreviewCommand.ts index 39f2dcf5e530..777797ded570 100644 --- a/clients/client-inspector/commands/CreateExclusionsPreviewCommand.ts +++ b/clients/client-inspector/commands/CreateExclusionsPreviewCommand.ts @@ -24,6 +24,20 @@ export interface CreateExclusionsPreviewCommandOutput extends CreateExclusionsPr *

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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { InspectorClient, CreateExclusionsPreviewCommand } from "@aws-sdk/client-inspector"; // ES Modules import + * // const { InspectorClient, CreateExclusionsPreviewCommand } = require("@aws-sdk/client-inspector"); // CommonJS import + * const client = new InspectorClient(config); + * const command = new CreateExclusionsPreviewCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreateExclusionsPreviewCommandInput} for command's `input` shape. + * @see {@link CreateExclusionsPreviewCommandOutput} for command's `response` shape. + * @see {@link InspectorClientResolvedConfig | config} for command's `input` shape. + * */ export class CreateExclusionsPreviewCommand extends $Command< CreateExclusionsPreviewCommandInput, diff --git a/clients/client-inspector/commands/CreateResourceGroupCommand.ts b/clients/client-inspector/commands/CreateResourceGroupCommand.ts index 85c7d3cfb2d1..e7abd27c8108 100644 --- a/clients/client-inspector/commands/CreateResourceGroupCommand.ts +++ b/clients/client-inspector/commands/CreateResourceGroupCommand.ts @@ -25,6 +25,20 @@ export interface CreateResourceGroupCommandOutput extends CreateResourceGroupRes * 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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { InspectorClient, CreateResourceGroupCommand } from "@aws-sdk/client-inspector"; // ES Modules import + * // const { InspectorClient, CreateResourceGroupCommand } = require("@aws-sdk/client-inspector"); // CommonJS import + * const client = new InspectorClient(config); + * const command = new CreateResourceGroupCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreateResourceGroupCommandInput} for command's `input` shape. + * @see {@link CreateResourceGroupCommandOutput} for command's `response` shape. + * @see {@link InspectorClientResolvedConfig | config} for command's `input` shape. + * */ export class CreateResourceGroupCommand extends $Command< CreateResourceGroupCommandInput, diff --git a/clients/client-inspector/commands/DeleteAssessmentRunCommand.ts b/clients/client-inspector/commands/DeleteAssessmentRunCommand.ts index b7de174565df..5855f707e945 100644 --- a/clients/client-inspector/commands/DeleteAssessmentRunCommand.ts +++ b/clients/client-inspector/commands/DeleteAssessmentRunCommand.ts @@ -23,6 +23,20 @@ export interface DeleteAssessmentRunCommandOutput extends __MetadataBearer {} /** *

Deletes the assessment run that is specified by the ARN of the assessment * run.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { InspectorClient, DeleteAssessmentRunCommand } from "@aws-sdk/client-inspector"; // ES Modules import + * // const { InspectorClient, DeleteAssessmentRunCommand } = require("@aws-sdk/client-inspector"); // CommonJS import + * const client = new InspectorClient(config); + * const command = new DeleteAssessmentRunCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteAssessmentRunCommandInput} for command's `input` shape. + * @see {@link DeleteAssessmentRunCommandOutput} for command's `response` shape. + * @see {@link InspectorClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteAssessmentRunCommand extends $Command< DeleteAssessmentRunCommandInput, diff --git a/clients/client-inspector/commands/DeleteAssessmentTargetCommand.ts b/clients/client-inspector/commands/DeleteAssessmentTargetCommand.ts index 59e0b5776ac6..640951f1befa 100644 --- a/clients/client-inspector/commands/DeleteAssessmentTargetCommand.ts +++ b/clients/client-inspector/commands/DeleteAssessmentTargetCommand.ts @@ -23,6 +23,20 @@ export interface DeleteAssessmentTargetCommandOutput extends __MetadataBearer {} /** *

Deletes the assessment target that is specified by the ARN of the assessment * target.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { InspectorClient, DeleteAssessmentTargetCommand } from "@aws-sdk/client-inspector"; // ES Modules import + * // const { InspectorClient, DeleteAssessmentTargetCommand } = require("@aws-sdk/client-inspector"); // CommonJS import + * const client = new InspectorClient(config); + * const command = new DeleteAssessmentTargetCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteAssessmentTargetCommandInput} for command's `input` shape. + * @see {@link DeleteAssessmentTargetCommandOutput} for command's `response` shape. + * @see {@link InspectorClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteAssessmentTargetCommand extends $Command< DeleteAssessmentTargetCommandInput, diff --git a/clients/client-inspector/commands/DeleteAssessmentTemplateCommand.ts b/clients/client-inspector/commands/DeleteAssessmentTemplateCommand.ts index 730b81cc8308..403634436dd1 100644 --- a/clients/client-inspector/commands/DeleteAssessmentTemplateCommand.ts +++ b/clients/client-inspector/commands/DeleteAssessmentTemplateCommand.ts @@ -23,6 +23,20 @@ export interface DeleteAssessmentTemplateCommandOutput extends __MetadataBearer /** *

Deletes the assessment template that is specified by the ARN of the assessment * template.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { InspectorClient, DeleteAssessmentTemplateCommand } from "@aws-sdk/client-inspector"; // ES Modules import + * // const { InspectorClient, DeleteAssessmentTemplateCommand } = require("@aws-sdk/client-inspector"); // CommonJS import + * const client = new InspectorClient(config); + * const command = new DeleteAssessmentTemplateCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteAssessmentTemplateCommandInput} for command's `input` shape. + * @see {@link DeleteAssessmentTemplateCommandOutput} for command's `response` shape. + * @see {@link InspectorClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteAssessmentTemplateCommand extends $Command< DeleteAssessmentTemplateCommandInput, diff --git a/clients/client-inspector/commands/DescribeAssessmentRunsCommand.ts b/clients/client-inspector/commands/DescribeAssessmentRunsCommand.ts index 947d01116fc7..1874257d6628 100644 --- a/clients/client-inspector/commands/DescribeAssessmentRunsCommand.ts +++ b/clients/client-inspector/commands/DescribeAssessmentRunsCommand.ts @@ -23,6 +23,20 @@ export interface DescribeAssessmentRunsCommandOutput extends DescribeAssessmentR /** *

Describes the assessment runs that are specified by the ARNs of the assessment * runs.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { InspectorClient, DescribeAssessmentRunsCommand } from "@aws-sdk/client-inspector"; // ES Modules import + * // const { InspectorClient, DescribeAssessmentRunsCommand } = require("@aws-sdk/client-inspector"); // CommonJS import + * const client = new InspectorClient(config); + * const command = new DescribeAssessmentRunsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeAssessmentRunsCommandInput} for command's `input` shape. + * @see {@link DescribeAssessmentRunsCommandOutput} for command's `response` shape. + * @see {@link InspectorClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeAssessmentRunsCommand extends $Command< DescribeAssessmentRunsCommandInput, diff --git a/clients/client-inspector/commands/DescribeAssessmentTargetsCommand.ts b/clients/client-inspector/commands/DescribeAssessmentTargetsCommand.ts index 980ba1cb83db..454a6e4db773 100644 --- a/clients/client-inspector/commands/DescribeAssessmentTargetsCommand.ts +++ b/clients/client-inspector/commands/DescribeAssessmentTargetsCommand.ts @@ -23,6 +23,20 @@ export interface DescribeAssessmentTargetsCommandOutput extends DescribeAssessme /** *

Describes the assessment targets that are specified by the ARNs of the assessment * targets.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { InspectorClient, DescribeAssessmentTargetsCommand } from "@aws-sdk/client-inspector"; // ES Modules import + * // const { InspectorClient, DescribeAssessmentTargetsCommand } = require("@aws-sdk/client-inspector"); // CommonJS import + * const client = new InspectorClient(config); + * const command = new DescribeAssessmentTargetsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeAssessmentTargetsCommandInput} for command's `input` shape. + * @see {@link DescribeAssessmentTargetsCommandOutput} for command's `response` shape. + * @see {@link InspectorClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeAssessmentTargetsCommand extends $Command< DescribeAssessmentTargetsCommandInput, diff --git a/clients/client-inspector/commands/DescribeAssessmentTemplatesCommand.ts b/clients/client-inspector/commands/DescribeAssessmentTemplatesCommand.ts index 7be80ff27073..0349bfc001f2 100644 --- a/clients/client-inspector/commands/DescribeAssessmentTemplatesCommand.ts +++ b/clients/client-inspector/commands/DescribeAssessmentTemplatesCommand.ts @@ -25,6 +25,20 @@ export interface DescribeAssessmentTemplatesCommandOutput /** *

Describes the assessment templates that are specified by the ARNs of the assessment * templates.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { InspectorClient, DescribeAssessmentTemplatesCommand } from "@aws-sdk/client-inspector"; // ES Modules import + * // const { InspectorClient, DescribeAssessmentTemplatesCommand } = require("@aws-sdk/client-inspector"); // CommonJS import + * const client = new InspectorClient(config); + * const command = new DescribeAssessmentTemplatesCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeAssessmentTemplatesCommandInput} for command's `input` shape. + * @see {@link DescribeAssessmentTemplatesCommandOutput} for command's `response` shape. + * @see {@link InspectorClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeAssessmentTemplatesCommand extends $Command< DescribeAssessmentTemplatesCommandInput, diff --git a/clients/client-inspector/commands/DescribeCrossAccountAccessRoleCommand.ts b/clients/client-inspector/commands/DescribeCrossAccountAccessRoleCommand.ts index cb497f9eacf6..21c92ff1c3c1 100644 --- a/clients/client-inspector/commands/DescribeCrossAccountAccessRoleCommand.ts +++ b/clients/client-inspector/commands/DescribeCrossAccountAccessRoleCommand.ts @@ -25,6 +25,20 @@ export interface DescribeCrossAccountAccessRoleCommandOutput /** *

Describes the IAM role that enables Amazon Inspector to access your AWS * account.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { InspectorClient, DescribeCrossAccountAccessRoleCommand } from "@aws-sdk/client-inspector"; // ES Modules import + * // const { InspectorClient, DescribeCrossAccountAccessRoleCommand } = require("@aws-sdk/client-inspector"); // CommonJS import + * const client = new InspectorClient(config); + * const command = new DescribeCrossAccountAccessRoleCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeCrossAccountAccessRoleCommandInput} for command's `input` shape. + * @see {@link DescribeCrossAccountAccessRoleCommandOutput} for command's `response` shape. + * @see {@link InspectorClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeCrossAccountAccessRoleCommand extends $Command< DescribeCrossAccountAccessRoleCommandInput, diff --git a/clients/client-inspector/commands/DescribeExclusionsCommand.ts b/clients/client-inspector/commands/DescribeExclusionsCommand.ts index 240c821aa8ee..4d63de311064 100644 --- a/clients/client-inspector/commands/DescribeExclusionsCommand.ts +++ b/clients/client-inspector/commands/DescribeExclusionsCommand.ts @@ -22,6 +22,20 @@ export interface DescribeExclusionsCommandOutput extends DescribeExclusionsRespo /** *

Describes the exclusions that are specified by the exclusions' ARNs.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { InspectorClient, DescribeExclusionsCommand } from "@aws-sdk/client-inspector"; // ES Modules import + * // const { InspectorClient, DescribeExclusionsCommand } = require("@aws-sdk/client-inspector"); // CommonJS import + * const client = new InspectorClient(config); + * const command = new DescribeExclusionsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeExclusionsCommandInput} for command's `input` shape. + * @see {@link DescribeExclusionsCommandOutput} for command's `response` shape. + * @see {@link InspectorClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeExclusionsCommand extends $Command< DescribeExclusionsCommandInput, diff --git a/clients/client-inspector/commands/DescribeFindingsCommand.ts b/clients/client-inspector/commands/DescribeFindingsCommand.ts index 003f1c9df16e..2e874f0d6106 100644 --- a/clients/client-inspector/commands/DescribeFindingsCommand.ts +++ b/clients/client-inspector/commands/DescribeFindingsCommand.ts @@ -22,6 +22,20 @@ export interface DescribeFindingsCommandOutput extends DescribeFindingsResponse, /** *

Describes the findings that are specified by the ARNs of the findings.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { InspectorClient, DescribeFindingsCommand } from "@aws-sdk/client-inspector"; // ES Modules import + * // const { InspectorClient, DescribeFindingsCommand } = require("@aws-sdk/client-inspector"); // CommonJS import + * const client = new InspectorClient(config); + * const command = new DescribeFindingsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeFindingsCommandInput} for command's `input` shape. + * @see {@link DescribeFindingsCommandOutput} for command's `response` shape. + * @see {@link InspectorClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeFindingsCommand extends $Command< DescribeFindingsCommandInput, diff --git a/clients/client-inspector/commands/DescribeResourceGroupsCommand.ts b/clients/client-inspector/commands/DescribeResourceGroupsCommand.ts index 5cdba54aa5b0..987d39a1a263 100644 --- a/clients/client-inspector/commands/DescribeResourceGroupsCommand.ts +++ b/clients/client-inspector/commands/DescribeResourceGroupsCommand.ts @@ -23,6 +23,20 @@ export interface DescribeResourceGroupsCommandOutput extends DescribeResourceGro /** *

Describes the resource groups that are specified by the ARNs of the resource * groups.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { InspectorClient, DescribeResourceGroupsCommand } from "@aws-sdk/client-inspector"; // ES Modules import + * // const { InspectorClient, DescribeResourceGroupsCommand } = require("@aws-sdk/client-inspector"); // CommonJS import + * const client = new InspectorClient(config); + * const command = new DescribeResourceGroupsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeResourceGroupsCommandInput} for command's `input` shape. + * @see {@link DescribeResourceGroupsCommandOutput} for command's `response` shape. + * @see {@link InspectorClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeResourceGroupsCommand extends $Command< DescribeResourceGroupsCommandInput, diff --git a/clients/client-inspector/commands/DescribeRulesPackagesCommand.ts b/clients/client-inspector/commands/DescribeRulesPackagesCommand.ts index 46034e96b33d..6e3394da5eb4 100644 --- a/clients/client-inspector/commands/DescribeRulesPackagesCommand.ts +++ b/clients/client-inspector/commands/DescribeRulesPackagesCommand.ts @@ -23,6 +23,20 @@ export interface DescribeRulesPackagesCommandOutput extends DescribeRulesPackage /** *

Describes the rules packages that are specified by the ARNs of the rules * packages.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { InspectorClient, DescribeRulesPackagesCommand } from "@aws-sdk/client-inspector"; // ES Modules import + * // const { InspectorClient, DescribeRulesPackagesCommand } = require("@aws-sdk/client-inspector"); // CommonJS import + * const client = new InspectorClient(config); + * const command = new DescribeRulesPackagesCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeRulesPackagesCommandInput} for command's `input` shape. + * @see {@link DescribeRulesPackagesCommandOutput} for command's `response` shape. + * @see {@link InspectorClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeRulesPackagesCommand extends $Command< DescribeRulesPackagesCommandInput, diff --git a/clients/client-inspector/commands/GetAssessmentReportCommand.ts b/clients/client-inspector/commands/GetAssessmentReportCommand.ts index b0e4ab640400..833384276698 100644 --- a/clients/client-inspector/commands/GetAssessmentReportCommand.ts +++ b/clients/client-inspector/commands/GetAssessmentReportCommand.ts @@ -23,6 +23,20 @@ export interface GetAssessmentReportCommandOutput extends GetAssessmentReportRes /** *

Produces an assessment report that includes detailed and comprehensive results of a * specified assessment run.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { InspectorClient, GetAssessmentReportCommand } from "@aws-sdk/client-inspector"; // ES Modules import + * // const { InspectorClient, GetAssessmentReportCommand } = require("@aws-sdk/client-inspector"); // CommonJS import + * const client = new InspectorClient(config); + * const command = new GetAssessmentReportCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetAssessmentReportCommandInput} for command's `input` shape. + * @see {@link GetAssessmentReportCommandOutput} for command's `response` shape. + * @see {@link InspectorClientResolvedConfig | config} for command's `input` shape. + * */ export class GetAssessmentReportCommand extends $Command< GetAssessmentReportCommandInput, diff --git a/clients/client-inspector/commands/GetExclusionsPreviewCommand.ts b/clients/client-inspector/commands/GetExclusionsPreviewCommand.ts index c594cf60bbe4..a6dd5c73cc28 100644 --- a/clients/client-inspector/commands/GetExclusionsPreviewCommand.ts +++ b/clients/client-inspector/commands/GetExclusionsPreviewCommand.ts @@ -24,6 +24,20 @@ export interface GetExclusionsPreviewCommandOutput extends GetExclusionsPreviewR *

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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { InspectorClient, GetExclusionsPreviewCommand } from "@aws-sdk/client-inspector"; // ES Modules import + * // const { InspectorClient, GetExclusionsPreviewCommand } = require("@aws-sdk/client-inspector"); // CommonJS import + * const client = new InspectorClient(config); + * const command = new GetExclusionsPreviewCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetExclusionsPreviewCommandInput} for command's `input` shape. + * @see {@link GetExclusionsPreviewCommandOutput} for command's `response` shape. + * @see {@link InspectorClientResolvedConfig | config} for command's `input` shape. + * */ export class GetExclusionsPreviewCommand extends $Command< GetExclusionsPreviewCommandInput, diff --git a/clients/client-inspector/commands/GetTelemetryMetadataCommand.ts b/clients/client-inspector/commands/GetTelemetryMetadataCommand.ts index 9405de89bf73..cad2db6c8a96 100644 --- a/clients/client-inspector/commands/GetTelemetryMetadataCommand.ts +++ b/clients/client-inspector/commands/GetTelemetryMetadataCommand.ts @@ -23,6 +23,20 @@ export interface GetTelemetryMetadataCommandOutput extends GetTelemetryMetadataR /** *

Information about the data that is collected for the specified assessment * run.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { InspectorClient, GetTelemetryMetadataCommand } from "@aws-sdk/client-inspector"; // ES Modules import + * // const { InspectorClient, GetTelemetryMetadataCommand } = require("@aws-sdk/client-inspector"); // CommonJS import + * const client = new InspectorClient(config); + * const command = new GetTelemetryMetadataCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetTelemetryMetadataCommandInput} for command's `input` shape. + * @see {@link GetTelemetryMetadataCommandOutput} for command's `response` shape. + * @see {@link InspectorClientResolvedConfig | config} for command's `input` shape. + * */ export class GetTelemetryMetadataCommand extends $Command< GetTelemetryMetadataCommandInput, diff --git a/clients/client-inspector/commands/ListAssessmentRunAgentsCommand.ts b/clients/client-inspector/commands/ListAssessmentRunAgentsCommand.ts index 7307bcc0ff31..2969fca3ddbc 100644 --- a/clients/client-inspector/commands/ListAssessmentRunAgentsCommand.ts +++ b/clients/client-inspector/commands/ListAssessmentRunAgentsCommand.ts @@ -23,6 +23,20 @@ export interface ListAssessmentRunAgentsCommandOutput extends ListAssessmentRunA /** *

Lists the agents of the assessment runs that are specified by the ARNs of the * assessment runs.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { InspectorClient, ListAssessmentRunAgentsCommand } from "@aws-sdk/client-inspector"; // ES Modules import + * // const { InspectorClient, ListAssessmentRunAgentsCommand } = require("@aws-sdk/client-inspector"); // CommonJS import + * const client = new InspectorClient(config); + * const command = new ListAssessmentRunAgentsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListAssessmentRunAgentsCommandInput} for command's `input` shape. + * @see {@link ListAssessmentRunAgentsCommandOutput} for command's `response` shape. + * @see {@link InspectorClientResolvedConfig | config} for command's `input` shape. + * */ export class ListAssessmentRunAgentsCommand extends $Command< ListAssessmentRunAgentsCommandInput, diff --git a/clients/client-inspector/commands/ListAssessmentRunsCommand.ts b/clients/client-inspector/commands/ListAssessmentRunsCommand.ts index 47c2755cfffa..afd6e8feb100 100644 --- a/clients/client-inspector/commands/ListAssessmentRunsCommand.ts +++ b/clients/client-inspector/commands/ListAssessmentRunsCommand.ts @@ -23,6 +23,20 @@ export interface ListAssessmentRunsCommandOutput extends ListAssessmentRunsRespo /** *

Lists the assessment runs that correspond to the assessment templates that are * specified by the ARNs of the assessment templates.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { InspectorClient, ListAssessmentRunsCommand } from "@aws-sdk/client-inspector"; // ES Modules import + * // const { InspectorClient, ListAssessmentRunsCommand } = require("@aws-sdk/client-inspector"); // CommonJS import + * const client = new InspectorClient(config); + * const command = new ListAssessmentRunsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListAssessmentRunsCommandInput} for command's `input` shape. + * @see {@link ListAssessmentRunsCommandOutput} for command's `response` shape. + * @see {@link InspectorClientResolvedConfig | config} for command's `input` shape. + * */ export class ListAssessmentRunsCommand extends $Command< ListAssessmentRunsCommandInput, diff --git a/clients/client-inspector/commands/ListAssessmentTargetsCommand.ts b/clients/client-inspector/commands/ListAssessmentTargetsCommand.ts index 5d9b6bf60ff8..62b3bc5b7d5c 100644 --- a/clients/client-inspector/commands/ListAssessmentTargetsCommand.ts +++ b/clients/client-inspector/commands/ListAssessmentTargetsCommand.ts @@ -24,6 +24,20 @@ export interface ListAssessmentTargetsCommandOutput extends ListAssessmentTarget *

Lists the ARNs of the assessment targets within this AWS account. For more * information about assessment targets, see Amazon Inspector Assessment * Targets.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { InspectorClient, ListAssessmentTargetsCommand } from "@aws-sdk/client-inspector"; // ES Modules import + * // const { InspectorClient, ListAssessmentTargetsCommand } = require("@aws-sdk/client-inspector"); // CommonJS import + * const client = new InspectorClient(config); + * const command = new ListAssessmentTargetsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListAssessmentTargetsCommandInput} for command's `input` shape. + * @see {@link ListAssessmentTargetsCommandOutput} for command's `response` shape. + * @see {@link InspectorClientResolvedConfig | config} for command's `input` shape. + * */ export class ListAssessmentTargetsCommand extends $Command< ListAssessmentTargetsCommandInput, diff --git a/clients/client-inspector/commands/ListAssessmentTemplatesCommand.ts b/clients/client-inspector/commands/ListAssessmentTemplatesCommand.ts index c932af607ebc..78fb5628959d 100644 --- a/clients/client-inspector/commands/ListAssessmentTemplatesCommand.ts +++ b/clients/client-inspector/commands/ListAssessmentTemplatesCommand.ts @@ -23,6 +23,20 @@ export interface ListAssessmentTemplatesCommandOutput extends ListAssessmentTemp /** *

Lists the assessment templates that correspond to the assessment targets that are * specified by the ARNs of the assessment targets.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { InspectorClient, ListAssessmentTemplatesCommand } from "@aws-sdk/client-inspector"; // ES Modules import + * // const { InspectorClient, ListAssessmentTemplatesCommand } = require("@aws-sdk/client-inspector"); // CommonJS import + * const client = new InspectorClient(config); + * const command = new ListAssessmentTemplatesCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListAssessmentTemplatesCommandInput} for command's `input` shape. + * @see {@link ListAssessmentTemplatesCommandOutput} for command's `response` shape. + * @see {@link InspectorClientResolvedConfig | config} for command's `input` shape. + * */ export class ListAssessmentTemplatesCommand extends $Command< ListAssessmentTemplatesCommandInput, diff --git a/clients/client-inspector/commands/ListEventSubscriptionsCommand.ts b/clients/client-inspector/commands/ListEventSubscriptionsCommand.ts index f4ac6a49e566..3a3a562eceb8 100644 --- a/clients/client-inspector/commands/ListEventSubscriptionsCommand.ts +++ b/clients/client-inspector/commands/ListEventSubscriptionsCommand.ts @@ -23,6 +23,20 @@ export interface ListEventSubscriptionsCommandOutput extends ListEventSubscripti /** *

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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { InspectorClient, ListEventSubscriptionsCommand } from "@aws-sdk/client-inspector"; // ES Modules import + * // const { InspectorClient, ListEventSubscriptionsCommand } = require("@aws-sdk/client-inspector"); // CommonJS import + * const client = new InspectorClient(config); + * const command = new ListEventSubscriptionsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListEventSubscriptionsCommandInput} for command's `input` shape. + * @see {@link ListEventSubscriptionsCommandOutput} for command's `response` shape. + * @see {@link InspectorClientResolvedConfig | config} for command's `input` shape. + * */ export class ListEventSubscriptionsCommand extends $Command< ListEventSubscriptionsCommandInput, diff --git a/clients/client-inspector/commands/ListExclusionsCommand.ts b/clients/client-inspector/commands/ListExclusionsCommand.ts index 48fde14a13d9..9b31086a926f 100644 --- a/clients/client-inspector/commands/ListExclusionsCommand.ts +++ b/clients/client-inspector/commands/ListExclusionsCommand.ts @@ -22,6 +22,20 @@ export interface ListExclusionsCommandOutput extends ListExclusionsResponse, __M /** *

List exclusions that are generated by the assessment run.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { InspectorClient, ListExclusionsCommand } from "@aws-sdk/client-inspector"; // ES Modules import + * // const { InspectorClient, ListExclusionsCommand } = require("@aws-sdk/client-inspector"); // CommonJS import + * const client = new InspectorClient(config); + * const command = new ListExclusionsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListExclusionsCommandInput} for command's `input` shape. + * @see {@link ListExclusionsCommandOutput} for command's `response` shape. + * @see {@link InspectorClientResolvedConfig | config} for command's `input` shape. + * */ export class ListExclusionsCommand extends $Command< ListExclusionsCommandInput, diff --git a/clients/client-inspector/commands/ListFindingsCommand.ts b/clients/client-inspector/commands/ListFindingsCommand.ts index f710f4fb880b..4cc322059ec0 100644 --- a/clients/client-inspector/commands/ListFindingsCommand.ts +++ b/clients/client-inspector/commands/ListFindingsCommand.ts @@ -23,6 +23,20 @@ export interface ListFindingsCommandOutput extends ListFindingsResponse, __Metad /** *

Lists findings that are generated by the assessment runs that are specified by the * ARNs of the assessment runs.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { InspectorClient, ListFindingsCommand } from "@aws-sdk/client-inspector"; // ES Modules import + * // const { InspectorClient, ListFindingsCommand } = require("@aws-sdk/client-inspector"); // CommonJS import + * const client = new InspectorClient(config); + * const command = new ListFindingsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListFindingsCommandInput} for command's `input` shape. + * @see {@link ListFindingsCommandOutput} for command's `response` shape. + * @see {@link InspectorClientResolvedConfig | config} for command's `input` shape. + * */ export class ListFindingsCommand extends $Command< ListFindingsCommandInput, diff --git a/clients/client-inspector/commands/ListRulesPackagesCommand.ts b/clients/client-inspector/commands/ListRulesPackagesCommand.ts index 330d009ac765..1492c1be2358 100644 --- a/clients/client-inspector/commands/ListRulesPackagesCommand.ts +++ b/clients/client-inspector/commands/ListRulesPackagesCommand.ts @@ -22,6 +22,20 @@ export interface ListRulesPackagesCommandOutput extends ListRulesPackagesRespons /** *

Lists all available Amazon Inspector rules packages.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { InspectorClient, ListRulesPackagesCommand } from "@aws-sdk/client-inspector"; // ES Modules import + * // const { InspectorClient, ListRulesPackagesCommand } = require("@aws-sdk/client-inspector"); // CommonJS import + * const client = new InspectorClient(config); + * const command = new ListRulesPackagesCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListRulesPackagesCommandInput} for command's `input` shape. + * @see {@link ListRulesPackagesCommandOutput} for command's `response` shape. + * @see {@link InspectorClientResolvedConfig | config} for command's `input` shape. + * */ export class ListRulesPackagesCommand extends $Command< ListRulesPackagesCommandInput, diff --git a/clients/client-inspector/commands/ListTagsForResourceCommand.ts b/clients/client-inspector/commands/ListTagsForResourceCommand.ts index abab87d59c19..f8bfdcb59eb1 100644 --- a/clients/client-inspector/commands/ListTagsForResourceCommand.ts +++ b/clients/client-inspector/commands/ListTagsForResourceCommand.ts @@ -22,6 +22,20 @@ export interface ListTagsForResourceCommandOutput extends ListTagsForResourceRes /** *

Lists all tags associated with an assessment template.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { InspectorClient, ListTagsForResourceCommand } from "@aws-sdk/client-inspector"; // ES Modules import + * // const { InspectorClient, ListTagsForResourceCommand } = require("@aws-sdk/client-inspector"); // CommonJS import + * const client = new InspectorClient(config); + * const command = new ListTagsForResourceCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListTagsForResourceCommandInput} for command's `input` shape. + * @see {@link ListTagsForResourceCommandOutput} for command's `response` shape. + * @see {@link InspectorClientResolvedConfig | config} for command's `input` shape. + * */ export class ListTagsForResourceCommand extends $Command< ListTagsForResourceCommandInput, diff --git a/clients/client-inspector/commands/PreviewAgentsCommand.ts b/clients/client-inspector/commands/PreviewAgentsCommand.ts index 888e50c8c394..a5e16571a748 100644 --- a/clients/client-inspector/commands/PreviewAgentsCommand.ts +++ b/clients/client-inspector/commands/PreviewAgentsCommand.ts @@ -23,6 +23,20 @@ export interface PreviewAgentsCommandOutput extends PreviewAgentsResponse, __Met /** *

Previews the agents installed on the EC2 instances that are part of the specified * assessment target.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { InspectorClient, PreviewAgentsCommand } from "@aws-sdk/client-inspector"; // ES Modules import + * // const { InspectorClient, PreviewAgentsCommand } = require("@aws-sdk/client-inspector"); // CommonJS import + * const client = new InspectorClient(config); + * const command = new PreviewAgentsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link PreviewAgentsCommandInput} for command's `input` shape. + * @see {@link PreviewAgentsCommandOutput} for command's `response` shape. + * @see {@link InspectorClientResolvedConfig | config} for command's `input` shape. + * */ export class PreviewAgentsCommand extends $Command< PreviewAgentsCommandInput, diff --git a/clients/client-inspector/commands/RegisterCrossAccountAccessRoleCommand.ts b/clients/client-inspector/commands/RegisterCrossAccountAccessRoleCommand.ts index 582c60a4dd8d..d64fd3060966 100644 --- a/clients/client-inspector/commands/RegisterCrossAccountAccessRoleCommand.ts +++ b/clients/client-inspector/commands/RegisterCrossAccountAccessRoleCommand.ts @@ -23,6 +23,20 @@ export interface RegisterCrossAccountAccessRoleCommandOutput extends __MetadataB /** *

Registers the IAM role that grants Amazon Inspector access to AWS Services needed to * perform security assessments.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { InspectorClient, RegisterCrossAccountAccessRoleCommand } from "@aws-sdk/client-inspector"; // ES Modules import + * // const { InspectorClient, RegisterCrossAccountAccessRoleCommand } = require("@aws-sdk/client-inspector"); // CommonJS import + * const client = new InspectorClient(config); + * const command = new RegisterCrossAccountAccessRoleCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link RegisterCrossAccountAccessRoleCommandInput} for command's `input` shape. + * @see {@link RegisterCrossAccountAccessRoleCommandOutput} for command's `response` shape. + * @see {@link InspectorClientResolvedConfig | config} for command's `input` shape. + * */ export class RegisterCrossAccountAccessRoleCommand extends $Command< RegisterCrossAccountAccessRoleCommandInput, diff --git a/clients/client-inspector/commands/RemoveAttributesFromFindingsCommand.ts b/clients/client-inspector/commands/RemoveAttributesFromFindingsCommand.ts index b3d2079308c2..fcad91ee43ed 100644 --- a/clients/client-inspector/commands/RemoveAttributesFromFindingsCommand.ts +++ b/clients/client-inspector/commands/RemoveAttributesFromFindingsCommand.ts @@ -25,6 +25,20 @@ export interface RemoveAttributesFromFindingsCommandOutput /** *

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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { InspectorClient, RemoveAttributesFromFindingsCommand } from "@aws-sdk/client-inspector"; // ES Modules import + * // const { InspectorClient, RemoveAttributesFromFindingsCommand } = require("@aws-sdk/client-inspector"); // CommonJS import + * const client = new InspectorClient(config); + * const command = new RemoveAttributesFromFindingsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link RemoveAttributesFromFindingsCommandInput} for command's `input` shape. + * @see {@link RemoveAttributesFromFindingsCommandOutput} for command's `response` shape. + * @see {@link InspectorClientResolvedConfig | config} for command's `input` shape. + * */ export class RemoveAttributesFromFindingsCommand extends $Command< RemoveAttributesFromFindingsCommandInput, diff --git a/clients/client-inspector/commands/SetTagsForResourceCommand.ts b/clients/client-inspector/commands/SetTagsForResourceCommand.ts index 1ba1cf666777..79eabccb3290 100644 --- a/clients/client-inspector/commands/SetTagsForResourceCommand.ts +++ b/clients/client-inspector/commands/SetTagsForResourceCommand.ts @@ -23,6 +23,20 @@ export interface SetTagsForResourceCommandOutput extends __MetadataBearer {} /** *

Sets tags (key and value pairs) to the assessment template that is specified by the * ARN of the assessment template.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { InspectorClient, SetTagsForResourceCommand } from "@aws-sdk/client-inspector"; // ES Modules import + * // const { InspectorClient, SetTagsForResourceCommand } = require("@aws-sdk/client-inspector"); // CommonJS import + * const client = new InspectorClient(config); + * const command = new SetTagsForResourceCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link SetTagsForResourceCommandInput} for command's `input` shape. + * @see {@link SetTagsForResourceCommandOutput} for command's `response` shape. + * @see {@link InspectorClientResolvedConfig | config} for command's `input` shape. + * */ export class SetTagsForResourceCommand extends $Command< SetTagsForResourceCommandInput, diff --git a/clients/client-inspector/commands/StartAssessmentRunCommand.ts b/clients/client-inspector/commands/StartAssessmentRunCommand.ts index 2a30fbbdd0c9..6b2daccb3921 100644 --- a/clients/client-inspector/commands/StartAssessmentRunCommand.ts +++ b/clients/client-inspector/commands/StartAssessmentRunCommand.ts @@ -24,6 +24,20 @@ export interface StartAssessmentRunCommandOutput extends StartAssessmentRunRespo *

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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { InspectorClient, StartAssessmentRunCommand } from "@aws-sdk/client-inspector"; // ES Modules import + * // const { InspectorClient, StartAssessmentRunCommand } = require("@aws-sdk/client-inspector"); // CommonJS import + * const client = new InspectorClient(config); + * const command = new StartAssessmentRunCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link StartAssessmentRunCommandInput} for command's `input` shape. + * @see {@link StartAssessmentRunCommandOutput} for command's `response` shape. + * @see {@link InspectorClientResolvedConfig | config} for command's `input` shape. + * */ export class StartAssessmentRunCommand extends $Command< StartAssessmentRunCommandInput, diff --git a/clients/client-inspector/commands/StopAssessmentRunCommand.ts b/clients/client-inspector/commands/StopAssessmentRunCommand.ts index a30e48a5235f..44f8466b6536 100644 --- a/clients/client-inspector/commands/StopAssessmentRunCommand.ts +++ b/clients/client-inspector/commands/StopAssessmentRunCommand.ts @@ -23,6 +23,20 @@ export interface StopAssessmentRunCommandOutput extends __MetadataBearer {} /** *

Stops the assessment run that is specified by the ARN of the assessment * run.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { InspectorClient, StopAssessmentRunCommand } from "@aws-sdk/client-inspector"; // ES Modules import + * // const { InspectorClient, StopAssessmentRunCommand } = require("@aws-sdk/client-inspector"); // CommonJS import + * const client = new InspectorClient(config); + * const command = new StopAssessmentRunCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link StopAssessmentRunCommandInput} for command's `input` shape. + * @see {@link StopAssessmentRunCommandOutput} for command's `response` shape. + * @see {@link InspectorClientResolvedConfig | config} for command's `input` shape. + * */ export class StopAssessmentRunCommand extends $Command< StopAssessmentRunCommandInput, diff --git a/clients/client-inspector/commands/SubscribeToEventCommand.ts b/clients/client-inspector/commands/SubscribeToEventCommand.ts index 3eeebef1fcbb..9a2a932b86c2 100644 --- a/clients/client-inspector/commands/SubscribeToEventCommand.ts +++ b/clients/client-inspector/commands/SubscribeToEventCommand.ts @@ -23,6 +23,20 @@ export interface SubscribeToEventCommandOutput extends __MetadataBearer {} /** *

Enables the process of sending Amazon Simple Notification Service (SNS) notifications * about a specified event to a specified SNS topic.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { InspectorClient, SubscribeToEventCommand } from "@aws-sdk/client-inspector"; // ES Modules import + * // const { InspectorClient, SubscribeToEventCommand } = require("@aws-sdk/client-inspector"); // CommonJS import + * const client = new InspectorClient(config); + * const command = new SubscribeToEventCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link SubscribeToEventCommandInput} for command's `input` shape. + * @see {@link SubscribeToEventCommandOutput} for command's `response` shape. + * @see {@link InspectorClientResolvedConfig | config} for command's `input` shape. + * */ export class SubscribeToEventCommand extends $Command< SubscribeToEventCommandInput, diff --git a/clients/client-inspector/commands/UnsubscribeFromEventCommand.ts b/clients/client-inspector/commands/UnsubscribeFromEventCommand.ts index 17333b904053..54b7e891744e 100644 --- a/clients/client-inspector/commands/UnsubscribeFromEventCommand.ts +++ b/clients/client-inspector/commands/UnsubscribeFromEventCommand.ts @@ -23,6 +23,20 @@ export interface UnsubscribeFromEventCommandOutput extends __MetadataBearer {} /** *

Disables the process of sending Amazon Simple Notification Service (SNS) * notifications about a specified event to a specified SNS topic.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { InspectorClient, UnsubscribeFromEventCommand } from "@aws-sdk/client-inspector"; // ES Modules import + * // const { InspectorClient, UnsubscribeFromEventCommand } = require("@aws-sdk/client-inspector"); // CommonJS import + * const client = new InspectorClient(config); + * const command = new UnsubscribeFromEventCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link UnsubscribeFromEventCommandInput} for command's `input` shape. + * @see {@link UnsubscribeFromEventCommandOutput} for command's `response` shape. + * @see {@link InspectorClientResolvedConfig | config} for command's `input` shape. + * */ export class UnsubscribeFromEventCommand extends $Command< UnsubscribeFromEventCommandInput, diff --git a/clients/client-inspector/commands/UpdateAssessmentTargetCommand.ts b/clients/client-inspector/commands/UpdateAssessmentTargetCommand.ts index f60e5b998176..5b97aa09148b 100644 --- a/clients/client-inspector/commands/UpdateAssessmentTargetCommand.ts +++ b/clients/client-inspector/commands/UpdateAssessmentTargetCommand.ts @@ -25,6 +25,20 @@ export interface UpdateAssessmentTargetCommandOutput extends __MetadataBearer {} * target.

*

If resourceGroupArn is not specified, all EC2 instances in the current AWS account * and region are included in the assessment target.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { InspectorClient, UpdateAssessmentTargetCommand } from "@aws-sdk/client-inspector"; // ES Modules import + * // const { InspectorClient, UpdateAssessmentTargetCommand } = require("@aws-sdk/client-inspector"); // CommonJS import + * const client = new InspectorClient(config); + * const command = new UpdateAssessmentTargetCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link UpdateAssessmentTargetCommandInput} for command's `input` shape. + * @see {@link UpdateAssessmentTargetCommandOutput} for command's `response` shape. + * @see {@link InspectorClientResolvedConfig | config} for command's `input` shape. + * */ export class UpdateAssessmentTargetCommand extends $Command< UpdateAssessmentTargetCommandInput, diff --git a/clients/client-inspector/models/models_0.ts b/clients/client-inspector/models/models_0.ts index 60085acb2764..b83618a28943 100644 --- a/clients/client-inspector/models/models_0.ts +++ b/clients/client-inspector/models/models_0.ts @@ -35,6 +35,9 @@ export interface AccessDeniedException extends __SmithyException, $MetadataBeare } export namespace AccessDeniedException { + /** + * @internal + */ export const filterSensitiveLog = (obj: AccessDeniedException): any => ({ ...obj, }); @@ -57,6 +60,9 @@ export interface Attribute { } export namespace Attribute { + /** + * @internal + */ export const filterSensitiveLog = (obj: Attribute): any => ({ ...obj, }); @@ -75,6 +81,9 @@ export interface AddAttributesToFindingsRequest { } export namespace AddAttributesToFindingsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: AddAttributesToFindingsRequest): any => ({ ...obj, }); @@ -106,6 +115,9 @@ export interface FailedItemDetails { } export namespace FailedItemDetails { + /** + * @internal + */ export const filterSensitiveLog = (obj: FailedItemDetails): any => ({ ...obj, }); @@ -120,6 +132,9 @@ export interface AddAttributesToFindingsResponse { } export namespace AddAttributesToFindingsResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: AddAttributesToFindingsResponse): any => ({ ...obj, }); @@ -143,6 +158,9 @@ export interface InternalException extends __SmithyException, $MetadataBearer { } export namespace InternalException { + /** + * @internal + */ export const filterSensitiveLog = (obj: InternalException): any => ({ ...obj, }); @@ -229,6 +247,9 @@ export interface InvalidInputException extends __SmithyException, $MetadataBeare } export namespace InvalidInputException { + /** + * @internal + */ export const filterSensitiveLog = (obj: InvalidInputException): any => ({ ...obj, }); @@ -269,6 +290,9 @@ export interface NoSuchEntityException extends __SmithyException, $MetadataBeare } export namespace NoSuchEntityException { + /** + * @internal + */ export const filterSensitiveLog = (obj: NoSuchEntityException): any => ({ ...obj, }); @@ -292,6 +316,9 @@ export interface ServiceTemporarilyUnavailableException extends __SmithyExceptio } export namespace ServiceTemporarilyUnavailableException { + /** + * @internal + */ export const filterSensitiveLog = (obj: ServiceTemporarilyUnavailableException): any => ({ ...obj, }); @@ -316,6 +343,9 @@ export interface AgentAlreadyRunningAssessment { } export namespace AgentAlreadyRunningAssessment { + /** + * @internal + */ export const filterSensitiveLog = (obj: AgentAlreadyRunningAssessment): any => ({ ...obj, }); @@ -353,6 +383,9 @@ export interface AgentFilter { } export namespace AgentFilter { + /** + * @internal + */ export const filterSensitiveLog = (obj: AgentFilter): any => ({ ...obj, }); @@ -408,6 +441,9 @@ export interface AgentPreview { } export namespace AgentPreview { + /** + * @internal + */ export const filterSensitiveLog = (obj: AgentPreview): any => ({ ...obj, }); @@ -442,6 +478,9 @@ export interface AgentsAlreadyRunningAssessmentException extends __SmithyExcepti } export namespace AgentsAlreadyRunningAssessmentException { + /** + * @internal + */ export const filterSensitiveLog = (obj: AgentsAlreadyRunningAssessmentException): any => ({ ...obj, }); @@ -508,6 +547,9 @@ export interface AssessmentRunNotification { } export namespace AssessmentRunNotification { + /** + * @internal + */ export const filterSensitiveLog = (obj: AssessmentRunNotification): any => ({ ...obj, }); @@ -546,6 +588,9 @@ export interface AssessmentRunStateChange { } export namespace AssessmentRunStateChange { + /** + * @internal + */ export const filterSensitiveLog = (obj: AssessmentRunStateChange): any => ({ ...obj, }); @@ -639,6 +684,9 @@ export interface AssessmentRun { } export namespace AssessmentRun { + /** + * @internal + */ export const filterSensitiveLog = (obj: AssessmentRun): any => ({ ...obj, }); @@ -667,6 +715,9 @@ export interface TelemetryMetadata { } export namespace TelemetryMetadata { + /** + * @internal + */ export const filterSensitiveLog = (obj: TelemetryMetadata): any => ({ ...obj, }); @@ -716,6 +767,9 @@ export interface AssessmentRunAgent { } export namespace AssessmentRunAgent { + /** + * @internal + */ export const filterSensitiveLog = (obj: AssessmentRunAgent): any => ({ ...obj, }); @@ -738,6 +792,9 @@ export interface TimestampRange { } export namespace TimestampRange { + /** + * @internal + */ export const filterSensitiveLog = (obj: TimestampRange): any => ({ ...obj, }); @@ -761,6 +818,9 @@ export interface DurationRange { } export namespace DurationRange { + /** + * @internal + */ export const filterSensitiveLog = (obj: DurationRange): any => ({ ...obj, }); @@ -822,6 +882,9 @@ export interface AssessmentRunFilter { } export namespace AssessmentRunFilter { + /** + * @internal + */ export const filterSensitiveLog = (obj: AssessmentRunFilter): any => ({ ...obj, }); @@ -857,6 +920,9 @@ export interface AssessmentRunInProgressException extends __SmithyException, $Me } export namespace AssessmentRunInProgressException { + /** + * @internal + */ export const filterSensitiveLog = (obj: AssessmentRunInProgressException): any => ({ ...obj, }); @@ -895,6 +961,9 @@ export interface AssessmentTarget { } export namespace AssessmentTarget { + /** + * @internal + */ export const filterSensitiveLog = (obj: AssessmentTarget): any => ({ ...obj, }); @@ -914,6 +983,9 @@ export interface AssessmentTargetFilter { } export namespace AssessmentTargetFilter { + /** + * @internal + */ export const filterSensitiveLog = (obj: AssessmentTargetFilter): any => ({ ...obj, }); @@ -978,6 +1050,9 @@ export interface AssessmentTemplate { } export namespace AssessmentTemplate { + /** + * @internal + */ export const filterSensitiveLog = (obj: AssessmentTemplate): any => ({ ...obj, }); @@ -1011,6 +1086,9 @@ export interface AssessmentTemplateFilter { } export namespace AssessmentTemplateFilter { + /** + * @internal + */ export const filterSensitiveLog = (obj: AssessmentTemplateFilter): any => ({ ...obj, }); @@ -1034,6 +1112,9 @@ export interface PrivateIp { } export namespace PrivateIp { + /** + * @internal + */ export const filterSensitiveLog = (obj: PrivateIp): any => ({ ...obj, }); @@ -1057,6 +1138,9 @@ export interface SecurityGroup { } export namespace SecurityGroup { + /** + * @internal + */ export const filterSensitiveLog = (obj: SecurityGroup): any => ({ ...obj, }); @@ -1122,6 +1206,9 @@ export interface NetworkInterface { } export namespace NetworkInterface { + /** + * @internal + */ export const filterSensitiveLog = (obj: NetworkInterface): any => ({ ...obj, }); @@ -1143,6 +1230,9 @@ export interface Tag { } export namespace Tag { + /** + * @internal + */ export const filterSensitiveLog = (obj: Tag): any => ({ ...obj, }); @@ -1198,6 +1288,9 @@ export interface AssetAttributes { } export namespace AssetAttributes { + /** + * @internal + */ export const filterSensitiveLog = (obj: AssetAttributes): any => ({ ...obj, }); @@ -1223,6 +1316,9 @@ export interface CreateAssessmentTargetRequest { } export namespace CreateAssessmentTargetRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateAssessmentTargetRequest): any => ({ ...obj, }); @@ -1236,6 +1332,9 @@ export interface CreateAssessmentTargetResponse { } export namespace CreateAssessmentTargetResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateAssessmentTargetResponse): any => ({ ...obj, }); @@ -1270,6 +1369,9 @@ export interface InvalidCrossAccountRoleException extends __SmithyException, $Me } export namespace InvalidCrossAccountRoleException { + /** + * @internal + */ export const filterSensitiveLog = (obj: InvalidCrossAccountRoleException): any => ({ ...obj, }); @@ -1307,6 +1409,9 @@ export interface LimitExceededException extends __SmithyException, $MetadataBear } export namespace LimitExceededException { + /** + * @internal + */ export const filterSensitiveLog = (obj: LimitExceededException): any => ({ ...obj, }); @@ -1348,6 +1453,9 @@ export interface CreateAssessmentTemplateRequest { } export namespace CreateAssessmentTemplateRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateAssessmentTemplateRequest): any => ({ ...obj, }); @@ -1361,6 +1469,9 @@ export interface CreateAssessmentTemplateResponse { } export namespace CreateAssessmentTemplateResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateAssessmentTemplateResponse): any => ({ ...obj, }); @@ -1375,6 +1486,9 @@ export interface CreateExclusionsPreviewRequest { } export namespace CreateExclusionsPreviewRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateExclusionsPreviewRequest): any => ({ ...obj, }); @@ -1390,6 +1504,9 @@ export interface CreateExclusionsPreviewResponse { } export namespace CreateExclusionsPreviewResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateExclusionsPreviewResponse): any => ({ ...obj, }); @@ -1406,6 +1523,9 @@ export interface PreviewGenerationInProgressException extends __SmithyException, } export namespace PreviewGenerationInProgressException { + /** + * @internal + */ export const filterSensitiveLog = (obj: PreviewGenerationInProgressException): any => ({ ...obj, }); @@ -1428,6 +1548,9 @@ export interface ResourceGroupTag { } export namespace ResourceGroupTag { + /** + * @internal + */ export const filterSensitiveLog = (obj: ResourceGroupTag): any => ({ ...obj, }); @@ -1443,6 +1566,9 @@ export interface CreateResourceGroupRequest { } export namespace CreateResourceGroupRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateResourceGroupRequest): any => ({ ...obj, }); @@ -1456,6 +1582,9 @@ export interface CreateResourceGroupResponse { } export namespace CreateResourceGroupResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateResourceGroupResponse): any => ({ ...obj, }); @@ -1469,6 +1598,9 @@ export interface DeleteAssessmentRunRequest { } export namespace DeleteAssessmentRunRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteAssessmentRunRequest): any => ({ ...obj, }); @@ -1482,6 +1614,9 @@ export interface DeleteAssessmentTargetRequest { } export namespace DeleteAssessmentTargetRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteAssessmentTargetRequest): any => ({ ...obj, }); @@ -1495,6 +1630,9 @@ export interface DeleteAssessmentTemplateRequest { } export namespace DeleteAssessmentTemplateRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteAssessmentTemplateRequest): any => ({ ...obj, }); @@ -1508,6 +1646,9 @@ export interface DescribeAssessmentRunsRequest { } export namespace DescribeAssessmentRunsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeAssessmentRunsRequest): any => ({ ...obj, }); @@ -1527,6 +1668,9 @@ export interface DescribeAssessmentRunsResponse { } export namespace DescribeAssessmentRunsResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeAssessmentRunsResponse): any => ({ ...obj, }); @@ -1540,6 +1684,9 @@ export interface DescribeAssessmentTargetsRequest { } export namespace DescribeAssessmentTargetsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeAssessmentTargetsRequest): any => ({ ...obj, }); @@ -1559,6 +1706,9 @@ export interface DescribeAssessmentTargetsResponse { } export namespace DescribeAssessmentTargetsResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeAssessmentTargetsResponse): any => ({ ...obj, }); @@ -1569,6 +1719,9 @@ export interface DescribeAssessmentTemplatesRequest { } export namespace DescribeAssessmentTemplatesRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeAssessmentTemplatesRequest): any => ({ ...obj, }); @@ -1588,6 +1741,9 @@ export interface DescribeAssessmentTemplatesResponse { } export namespace DescribeAssessmentTemplatesResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeAssessmentTemplatesResponse): any => ({ ...obj, }); @@ -1613,6 +1769,9 @@ export interface DescribeCrossAccountAccessRoleResponse { } export namespace DescribeCrossAccountAccessRoleResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeCrossAccountAccessRoleResponse): any => ({ ...obj, }); @@ -1636,6 +1795,9 @@ export interface DescribeExclusionsRequest { } export namespace DescribeExclusionsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeExclusionsRequest): any => ({ ...obj, }); @@ -1663,6 +1825,9 @@ export interface Scope { } export namespace Scope { + /** + * @internal + */ export const filterSensitiveLog = (obj: Scope): any => ({ ...obj, }); @@ -1704,6 +1869,9 @@ export interface Exclusion { } export namespace Exclusion { + /** + * @internal + */ export const filterSensitiveLog = (obj: Exclusion): any => ({ ...obj, }); @@ -1723,6 +1891,9 @@ export interface DescribeExclusionsResponse { } export namespace DescribeExclusionsResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeExclusionsResponse): any => ({ ...obj, }); @@ -1742,6 +1913,9 @@ export interface DescribeFindingsRequest { } export namespace DescribeFindingsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeFindingsRequest): any => ({ ...obj, }); @@ -1768,6 +1942,9 @@ export interface InspectorServiceAttributes { } export namespace InspectorServiceAttributes { + /** + * @internal + */ export const filterSensitiveLog = (obj: InspectorServiceAttributes): any => ({ ...obj, }); @@ -1871,6 +2048,9 @@ export interface Finding { } export namespace Finding { + /** + * @internal + */ export const filterSensitiveLog = (obj: Finding): any => ({ ...obj, }); @@ -1890,6 +2070,9 @@ export interface DescribeFindingsResponse { } export namespace DescribeFindingsResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeFindingsResponse): any => ({ ...obj, }); @@ -1903,6 +2086,9 @@ export interface DescribeResourceGroupsRequest { } export namespace DescribeResourceGroupsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeResourceGroupsRequest): any => ({ ...obj, }); @@ -1933,6 +2119,9 @@ export interface ResourceGroup { } export namespace ResourceGroup { + /** + * @internal + */ export const filterSensitiveLog = (obj: ResourceGroup): any => ({ ...obj, }); @@ -1952,6 +2141,9 @@ export interface DescribeResourceGroupsResponse { } export namespace DescribeResourceGroupsResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeResourceGroupsResponse): any => ({ ...obj, }); @@ -1970,6 +2162,9 @@ export interface DescribeRulesPackagesRequest { } export namespace DescribeRulesPackagesRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeRulesPackagesRequest): any => ({ ...obj, }); @@ -2007,6 +2202,9 @@ export interface RulesPackage { } export namespace RulesPackage { + /** + * @internal + */ export const filterSensitiveLog = (obj: RulesPackage): any => ({ ...obj, }); @@ -2026,6 +2224,9 @@ export interface DescribeRulesPackagesResponse { } export namespace DescribeRulesPackagesResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeRulesPackagesResponse): any => ({ ...obj, }); @@ -2048,6 +2249,9 @@ export interface EventSubscription { } export namespace EventSubscription { + /** + * @internal + */ export const filterSensitiveLog = (obj: EventSubscription): any => ({ ...obj, }); @@ -2085,6 +2289,9 @@ export interface ExclusionPreview { } export namespace ExclusionPreview { + /** + * @internal + */ export const filterSensitiveLog = (obj: ExclusionPreview): any => ({ ...obj, }); @@ -2147,6 +2354,9 @@ export interface FindingFilter { } export namespace FindingFilter { + /** + * @internal + */ export const filterSensitiveLog = (obj: FindingFilter): any => ({ ...obj, }); @@ -2184,6 +2394,9 @@ export interface GetAssessmentReportRequest { } export namespace GetAssessmentReportRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetAssessmentReportRequest): any => ({ ...obj, }); @@ -2209,6 +2422,9 @@ export interface GetAssessmentReportResponse { } export namespace GetAssessmentReportResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetAssessmentReportResponse): any => ({ ...obj, }); @@ -2229,6 +2445,9 @@ export interface UnsupportedFeatureException extends __SmithyException, $Metadat } export namespace UnsupportedFeatureException { + /** + * @internal + */ export const filterSensitiveLog = (obj: UnsupportedFeatureException): any => ({ ...obj, }); @@ -2268,6 +2487,9 @@ export interface GetExclusionsPreviewRequest { } export namespace GetExclusionsPreviewRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetExclusionsPreviewRequest): any => ({ ...obj, }); @@ -2299,6 +2521,9 @@ export interface GetExclusionsPreviewResponse { } export namespace GetExclusionsPreviewResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetExclusionsPreviewResponse): any => ({ ...obj, }); @@ -2313,6 +2538,9 @@ export interface GetTelemetryMetadataRequest { } export namespace GetTelemetryMetadataRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetTelemetryMetadataRequest): any => ({ ...obj, }); @@ -2326,6 +2554,9 @@ export interface GetTelemetryMetadataResponse { } export namespace GetTelemetryMetadataResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetTelemetryMetadataResponse): any => ({ ...obj, }); @@ -2363,6 +2594,9 @@ export interface ListAssessmentRunAgentsRequest { } export namespace ListAssessmentRunAgentsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListAssessmentRunAgentsRequest): any => ({ ...obj, }); @@ -2383,6 +2617,9 @@ export interface ListAssessmentRunAgentsResponse { } export namespace ListAssessmentRunAgentsResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListAssessmentRunAgentsResponse): any => ({ ...obj, }); @@ -2421,6 +2658,9 @@ export interface ListAssessmentRunsRequest { } export namespace ListAssessmentRunsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListAssessmentRunsRequest): any => ({ ...obj, }); @@ -2442,6 +2682,9 @@ export interface ListAssessmentRunsResponse { } export namespace ListAssessmentRunsResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListAssessmentRunsResponse): any => ({ ...obj, }); @@ -2474,6 +2717,9 @@ export interface ListAssessmentTargetsRequest { } export namespace ListAssessmentTargetsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListAssessmentTargetsRequest): any => ({ ...obj, }); @@ -2495,6 +2741,9 @@ export interface ListAssessmentTargetsResponse { } export namespace ListAssessmentTargetsResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListAssessmentTargetsResponse): any => ({ ...obj, }); @@ -2533,6 +2782,9 @@ export interface ListAssessmentTemplatesRequest { } export namespace ListAssessmentTemplatesRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListAssessmentTemplatesRequest): any => ({ ...obj, }); @@ -2554,6 +2806,9 @@ export interface ListAssessmentTemplatesResponse { } export namespace ListAssessmentTemplatesResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListAssessmentTemplatesResponse): any => ({ ...obj, }); @@ -2583,6 +2838,9 @@ export interface ListEventSubscriptionsRequest { } export namespace ListEventSubscriptionsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListEventSubscriptionsRequest): any => ({ ...obj, }); @@ -2611,6 +2869,9 @@ export interface Subscription { } export namespace Subscription { + /** + * @internal + */ export const filterSensitiveLog = (obj: Subscription): any => ({ ...obj, }); @@ -2631,6 +2892,9 @@ export interface ListEventSubscriptionsResponse { } export namespace ListEventSubscriptionsResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListEventSubscriptionsResponse): any => ({ ...obj, }); @@ -2659,6 +2923,9 @@ export interface ListExclusionsRequest { } export namespace ListExclusionsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListExclusionsRequest): any => ({ ...obj, }); @@ -2680,6 +2947,9 @@ export interface ListExclusionsResponse { } export namespace ListExclusionsResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListExclusionsResponse): any => ({ ...obj, }); @@ -2718,6 +2988,9 @@ export interface ListFindingsRequest { } export namespace ListFindingsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListFindingsRequest): any => ({ ...obj, }); @@ -2738,6 +3011,9 @@ export interface ListFindingsResponse { } export namespace ListFindingsResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListFindingsResponse): any => ({ ...obj, }); @@ -2761,6 +3037,9 @@ export interface ListRulesPackagesRequest { } export namespace ListRulesPackagesRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListRulesPackagesRequest): any => ({ ...obj, }); @@ -2781,6 +3060,9 @@ export interface ListRulesPackagesResponse { } export namespace ListRulesPackagesResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListRulesPackagesResponse): any => ({ ...obj, }); @@ -2794,6 +3076,9 @@ export interface ListTagsForResourceRequest { } export namespace ListTagsForResourceRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListTagsForResourceRequest): any => ({ ...obj, }); @@ -2807,6 +3092,9 @@ export interface ListTagsForResourceResponse { } export namespace ListTagsForResourceResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListTagsForResourceResponse): any => ({ ...obj, }); @@ -2835,6 +3123,9 @@ export interface PreviewAgentsRequest { } export namespace PreviewAgentsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: PreviewAgentsRequest): any => ({ ...obj, }); @@ -2855,6 +3146,9 @@ export interface PreviewAgentsResponse { } export namespace PreviewAgentsResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: PreviewAgentsResponse): any => ({ ...obj, }); @@ -2869,6 +3163,9 @@ export interface RegisterCrossAccountAccessRoleRequest { } export namespace RegisterCrossAccountAccessRoleRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: RegisterCrossAccountAccessRoleRequest): any => ({ ...obj, }); @@ -2888,6 +3185,9 @@ export interface RemoveAttributesFromFindingsRequest { } export namespace RemoveAttributesFromFindingsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: RemoveAttributesFromFindingsRequest): any => ({ ...obj, }); @@ -2902,6 +3202,9 @@ export interface RemoveAttributesFromFindingsResponse { } export namespace RemoveAttributesFromFindingsResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: RemoveAttributesFromFindingsResponse): any => ({ ...obj, }); @@ -2921,6 +3224,9 @@ export interface SetTagsForResourceRequest { } export namespace SetTagsForResourceRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: SetTagsForResourceRequest): any => ({ ...obj, }); @@ -2941,6 +3247,9 @@ export interface StartAssessmentRunRequest { } export namespace StartAssessmentRunRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: StartAssessmentRunRequest): any => ({ ...obj, }); @@ -2954,6 +3263,9 @@ export interface StartAssessmentRunResponse { } export namespace StartAssessmentRunResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: StartAssessmentRunResponse): any => ({ ...obj, }); @@ -2980,6 +3292,9 @@ export interface StopAssessmentRunRequest { } export namespace StopAssessmentRunRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: StopAssessmentRunRequest): any => ({ ...obj, }); @@ -3004,6 +3319,9 @@ export interface SubscribeToEventRequest { } export namespace SubscribeToEventRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: SubscribeToEventRequest): any => ({ ...obj, }); @@ -3028,6 +3346,9 @@ export interface UnsubscribeFromEventRequest { } export namespace UnsubscribeFromEventRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: UnsubscribeFromEventRequest): any => ({ ...obj, }); @@ -3052,6 +3373,9 @@ export interface UpdateAssessmentTargetRequest { } export namespace UpdateAssessmentTargetRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateAssessmentTargetRequest): any => ({ ...obj, }); diff --git a/clients/client-iot-1click-devices-service/commands/ClaimDevicesByClaimCodeCommand.ts b/clients/client-iot-1click-devices-service/commands/ClaimDevicesByClaimCodeCommand.ts index aa6c935c1ddf..63ed75a3af73 100644 --- a/clients/client-iot-1click-devices-service/commands/ClaimDevicesByClaimCodeCommand.ts +++ b/clients/client-iot-1click-devices-service/commands/ClaimDevicesByClaimCodeCommand.ts @@ -27,6 +27,20 @@ export interface ClaimDevicesByClaimCodeCommandOutput extends ClaimDevicesByClai /** *

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).

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { IoT1ClickDevicesServiceClient, ClaimDevicesByClaimCodeCommand } from "@aws-sdk/client-iot-1click-devices-service"; // ES Modules import + * // const { IoT1ClickDevicesServiceClient, ClaimDevicesByClaimCodeCommand } = require("@aws-sdk/client-iot-1click-devices-service"); // CommonJS import + * const client = new IoT1ClickDevicesServiceClient(config); + * const command = new ClaimDevicesByClaimCodeCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ClaimDevicesByClaimCodeCommandInput} for command's `input` shape. + * @see {@link ClaimDevicesByClaimCodeCommandOutput} for command's `response` shape. + * @see {@link IoT1ClickDevicesServiceClientResolvedConfig | config} for command's `input` shape. + * */ export class ClaimDevicesByClaimCodeCommand extends $Command< ClaimDevicesByClaimCodeCommandInput, diff --git a/clients/client-iot-1click-devices-service/commands/DescribeDeviceCommand.ts b/clients/client-iot-1click-devices-service/commands/DescribeDeviceCommand.ts index 31fd0252a997..f1e95d5b21b1 100644 --- a/clients/client-iot-1click-devices-service/commands/DescribeDeviceCommand.ts +++ b/clients/client-iot-1click-devices-service/commands/DescribeDeviceCommand.ts @@ -27,6 +27,20 @@ export interface DescribeDeviceCommandOutput extends DescribeDeviceResponse, __M /** *

Given a device ID, returns a DescribeDeviceResponse object describing the * details of the device.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { IoT1ClickDevicesServiceClient, DescribeDeviceCommand } from "@aws-sdk/client-iot-1click-devices-service"; // ES Modules import + * // const { IoT1ClickDevicesServiceClient, DescribeDeviceCommand } = require("@aws-sdk/client-iot-1click-devices-service"); // CommonJS import + * const client = new IoT1ClickDevicesServiceClient(config); + * const command = new DescribeDeviceCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeDeviceCommandInput} for command's `input` shape. + * @see {@link DescribeDeviceCommandOutput} for command's `response` shape. + * @see {@link IoT1ClickDevicesServiceClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeDeviceCommand extends $Command< DescribeDeviceCommandInput, diff --git a/clients/client-iot-1click-devices-service/commands/FinalizeDeviceClaimCommand.ts b/clients/client-iot-1click-devices-service/commands/FinalizeDeviceClaimCommand.ts index 48772b97dea4..7a675a00e394 100644 --- a/clients/client-iot-1click-devices-service/commands/FinalizeDeviceClaimCommand.ts +++ b/clients/client-iot-1click-devices-service/commands/FinalizeDeviceClaimCommand.ts @@ -30,6 +30,20 @@ export interface FinalizeDeviceClaimCommandOutput extends FinalizeDeviceClaimRes * and finalizing the claim. For a device of type button, a device event can * be published by simply clicking the device.

* + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { IoT1ClickDevicesServiceClient, FinalizeDeviceClaimCommand } from "@aws-sdk/client-iot-1click-devices-service"; // ES Modules import + * // const { IoT1ClickDevicesServiceClient, FinalizeDeviceClaimCommand } = require("@aws-sdk/client-iot-1click-devices-service"); // CommonJS import + * const client = new IoT1ClickDevicesServiceClient(config); + * const command = new FinalizeDeviceClaimCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link FinalizeDeviceClaimCommandInput} for command's `input` shape. + * @see {@link FinalizeDeviceClaimCommandOutput} for command's `response` shape. + * @see {@link IoT1ClickDevicesServiceClientResolvedConfig | config} for command's `input` shape. + * */ export class FinalizeDeviceClaimCommand extends $Command< FinalizeDeviceClaimCommandInput, diff --git a/clients/client-iot-1click-devices-service/commands/GetDeviceMethodsCommand.ts b/clients/client-iot-1click-devices-service/commands/GetDeviceMethodsCommand.ts index cc0c2dbd8139..5f2a53b8f135 100644 --- a/clients/client-iot-1click-devices-service/commands/GetDeviceMethodsCommand.ts +++ b/clients/client-iot-1click-devices-service/commands/GetDeviceMethodsCommand.ts @@ -26,6 +26,20 @@ export interface GetDeviceMethodsCommandOutput extends GetDeviceMethodsResponse, /** *

Given a device ID, returns the invokable methods associated with the device.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { IoT1ClickDevicesServiceClient, GetDeviceMethodsCommand } from "@aws-sdk/client-iot-1click-devices-service"; // ES Modules import + * // const { IoT1ClickDevicesServiceClient, GetDeviceMethodsCommand } = require("@aws-sdk/client-iot-1click-devices-service"); // CommonJS import + * const client = new IoT1ClickDevicesServiceClient(config); + * const command = new GetDeviceMethodsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetDeviceMethodsCommandInput} for command's `input` shape. + * @see {@link GetDeviceMethodsCommandOutput} for command's `response` shape. + * @see {@link IoT1ClickDevicesServiceClientResolvedConfig | config} for command's `input` shape. + * */ export class GetDeviceMethodsCommand extends $Command< GetDeviceMethodsCommandInput, diff --git a/clients/client-iot-1click-devices-service/commands/InitiateDeviceClaimCommand.ts b/clients/client-iot-1click-devices-service/commands/InitiateDeviceClaimCommand.ts index 45df66a57d88..47b2a73faf8e 100644 --- a/clients/client-iot-1click-devices-service/commands/InitiateDeviceClaimCommand.ts +++ b/clients/client-iot-1click-devices-service/commands/InitiateDeviceClaimCommand.ts @@ -30,6 +30,20 @@ export interface InitiateDeviceClaimCommandOutput extends InitiateDeviceClaimRes * and finalizing the claim. For a device of type button, a device event can * be published by simply clicking the device.

* + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { IoT1ClickDevicesServiceClient, InitiateDeviceClaimCommand } from "@aws-sdk/client-iot-1click-devices-service"; // ES Modules import + * // const { IoT1ClickDevicesServiceClient, InitiateDeviceClaimCommand } = require("@aws-sdk/client-iot-1click-devices-service"); // CommonJS import + * const client = new IoT1ClickDevicesServiceClient(config); + * const command = new InitiateDeviceClaimCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link InitiateDeviceClaimCommandInput} for command's `input` shape. + * @see {@link InitiateDeviceClaimCommandOutput} for command's `response` shape. + * @see {@link IoT1ClickDevicesServiceClientResolvedConfig | config} for command's `input` shape. + * */ export class InitiateDeviceClaimCommand extends $Command< InitiateDeviceClaimCommandInput, diff --git a/clients/client-iot-1click-devices-service/commands/InvokeDeviceMethodCommand.ts b/clients/client-iot-1click-devices-service/commands/InvokeDeviceMethodCommand.ts index 28ce1710d759..ae53536a6f44 100644 --- a/clients/client-iot-1click-devices-service/commands/InvokeDeviceMethodCommand.ts +++ b/clients/client-iot-1click-devices-service/commands/InvokeDeviceMethodCommand.ts @@ -27,6 +27,20 @@ export interface InvokeDeviceMethodCommandOutput extends InvokeDeviceMethodRespo /** *

Given a device ID, issues a request to invoke a named device method (with possible * parameters). See the "Example POST" code snippet below.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { IoT1ClickDevicesServiceClient, InvokeDeviceMethodCommand } from "@aws-sdk/client-iot-1click-devices-service"; // ES Modules import + * // const { IoT1ClickDevicesServiceClient, InvokeDeviceMethodCommand } = require("@aws-sdk/client-iot-1click-devices-service"); // CommonJS import + * const client = new IoT1ClickDevicesServiceClient(config); + * const command = new InvokeDeviceMethodCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link InvokeDeviceMethodCommandInput} for command's `input` shape. + * @see {@link InvokeDeviceMethodCommandOutput} for command's `response` shape. + * @see {@link IoT1ClickDevicesServiceClientResolvedConfig | config} for command's `input` shape. + * */ export class InvokeDeviceMethodCommand extends $Command< InvokeDeviceMethodCommandInput, diff --git a/clients/client-iot-1click-devices-service/commands/ListDeviceEventsCommand.ts b/clients/client-iot-1click-devices-service/commands/ListDeviceEventsCommand.ts index b9cc8e76a069..37e265d35b31 100644 --- a/clients/client-iot-1click-devices-service/commands/ListDeviceEventsCommand.ts +++ b/clients/client-iot-1click-devices-service/commands/ListDeviceEventsCommand.ts @@ -27,6 +27,20 @@ export interface ListDeviceEventsCommandOutput extends ListDeviceEventsResponse, /** *

Using a device ID, returns a DeviceEventsResponse object containing an * array of events for the device.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { IoT1ClickDevicesServiceClient, ListDeviceEventsCommand } from "@aws-sdk/client-iot-1click-devices-service"; // ES Modules import + * // const { IoT1ClickDevicesServiceClient, ListDeviceEventsCommand } = require("@aws-sdk/client-iot-1click-devices-service"); // CommonJS import + * const client = new IoT1ClickDevicesServiceClient(config); + * const command = new ListDeviceEventsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListDeviceEventsCommandInput} for command's `input` shape. + * @see {@link ListDeviceEventsCommandOutput} for command's `response` shape. + * @see {@link IoT1ClickDevicesServiceClientResolvedConfig | config} for command's `input` shape. + * */ export class ListDeviceEventsCommand extends $Command< ListDeviceEventsCommandInput, diff --git a/clients/client-iot-1click-devices-service/commands/ListDevicesCommand.ts b/clients/client-iot-1click-devices-service/commands/ListDevicesCommand.ts index a3b7ba51edf7..eda3994bdf0f 100644 --- a/clients/client-iot-1click-devices-service/commands/ListDevicesCommand.ts +++ b/clients/client-iot-1click-devices-service/commands/ListDevicesCommand.ts @@ -26,6 +26,20 @@ export interface ListDevicesCommandOutput extends ListDevicesResponse, __Metadat /** *

Lists the 1-Click compatible devices associated with your AWS account.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { IoT1ClickDevicesServiceClient, ListDevicesCommand } from "@aws-sdk/client-iot-1click-devices-service"; // ES Modules import + * // const { IoT1ClickDevicesServiceClient, ListDevicesCommand } = require("@aws-sdk/client-iot-1click-devices-service"); // CommonJS import + * const client = new IoT1ClickDevicesServiceClient(config); + * const command = new ListDevicesCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListDevicesCommandInput} for command's `input` shape. + * @see {@link ListDevicesCommandOutput} for command's `response` shape. + * @see {@link IoT1ClickDevicesServiceClientResolvedConfig | config} for command's `input` shape. + * */ export class ListDevicesCommand extends $Command< ListDevicesCommandInput, diff --git a/clients/client-iot-1click-devices-service/commands/ListTagsForResourceCommand.ts b/clients/client-iot-1click-devices-service/commands/ListTagsForResourceCommand.ts index 260d0d29193f..6312b0576556 100644 --- a/clients/client-iot-1click-devices-service/commands/ListTagsForResourceCommand.ts +++ b/clients/client-iot-1click-devices-service/commands/ListTagsForResourceCommand.ts @@ -26,6 +26,20 @@ export interface ListTagsForResourceCommandOutput extends ListTagsForResourceRes /** *

Lists the tags associated with the specified resource ARN.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { IoT1ClickDevicesServiceClient, ListTagsForResourceCommand } from "@aws-sdk/client-iot-1click-devices-service"; // ES Modules import + * // const { IoT1ClickDevicesServiceClient, ListTagsForResourceCommand } = require("@aws-sdk/client-iot-1click-devices-service"); // CommonJS import + * const client = new IoT1ClickDevicesServiceClient(config); + * const command = new ListTagsForResourceCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListTagsForResourceCommandInput} for command's `input` shape. + * @see {@link ListTagsForResourceCommandOutput} for command's `response` shape. + * @see {@link IoT1ClickDevicesServiceClientResolvedConfig | config} for command's `input` shape. + * */ export class ListTagsForResourceCommand extends $Command< ListTagsForResourceCommandInput, diff --git a/clients/client-iot-1click-devices-service/commands/TagResourceCommand.ts b/clients/client-iot-1click-devices-service/commands/TagResourceCommand.ts index 46e61b63237b..05f8eb935850 100644 --- a/clients/client-iot-1click-devices-service/commands/TagResourceCommand.ts +++ b/clients/client-iot-1click-devices-service/commands/TagResourceCommand.ts @@ -27,6 +27,20 @@ export interface TagResourceCommandOutput extends __MetadataBearer {} /** *

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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { IoT1ClickDevicesServiceClient, TagResourceCommand } from "@aws-sdk/client-iot-1click-devices-service"; // ES Modules import + * // const { IoT1ClickDevicesServiceClient, TagResourceCommand } = require("@aws-sdk/client-iot-1click-devices-service"); // CommonJS import + * const client = new IoT1ClickDevicesServiceClient(config); + * const command = new TagResourceCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link TagResourceCommandInput} for command's `input` shape. + * @see {@link TagResourceCommandOutput} for command's `response` shape. + * @see {@link IoT1ClickDevicesServiceClientResolvedConfig | config} for command's `input` shape. + * */ export class TagResourceCommand extends $Command< TagResourceCommandInput, diff --git a/clients/client-iot-1click-devices-service/commands/UnclaimDeviceCommand.ts b/clients/client-iot-1click-devices-service/commands/UnclaimDeviceCommand.ts index 0378ca67bc68..f900da54dbb7 100644 --- a/clients/client-iot-1click-devices-service/commands/UnclaimDeviceCommand.ts +++ b/clients/client-iot-1click-devices-service/commands/UnclaimDeviceCommand.ts @@ -26,6 +26,20 @@ export interface UnclaimDeviceCommandOutput extends UnclaimDeviceResponse, __Met /** *

Disassociates a device from your AWS account using its device ID.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { IoT1ClickDevicesServiceClient, UnclaimDeviceCommand } from "@aws-sdk/client-iot-1click-devices-service"; // ES Modules import + * // const { IoT1ClickDevicesServiceClient, UnclaimDeviceCommand } = require("@aws-sdk/client-iot-1click-devices-service"); // CommonJS import + * const client = new IoT1ClickDevicesServiceClient(config); + * const command = new UnclaimDeviceCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link UnclaimDeviceCommandInput} for command's `input` shape. + * @see {@link UnclaimDeviceCommandOutput} for command's `response` shape. + * @see {@link IoT1ClickDevicesServiceClientResolvedConfig | config} for command's `input` shape. + * */ export class UnclaimDeviceCommand extends $Command< UnclaimDeviceCommandInput, diff --git a/clients/client-iot-1click-devices-service/commands/UntagResourceCommand.ts b/clients/client-iot-1click-devices-service/commands/UntagResourceCommand.ts index 97c487bec7ff..a3ce649dba61 100644 --- a/clients/client-iot-1click-devices-service/commands/UntagResourceCommand.ts +++ b/clients/client-iot-1click-devices-service/commands/UntagResourceCommand.ts @@ -27,6 +27,20 @@ export interface UntagResourceCommandOutput extends __MetadataBearer {} /** *

Using tag keys, deletes the tags (key/value pairs) associated with the specified * resource ARN.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { IoT1ClickDevicesServiceClient, UntagResourceCommand } from "@aws-sdk/client-iot-1click-devices-service"; // ES Modules import + * // const { IoT1ClickDevicesServiceClient, UntagResourceCommand } = require("@aws-sdk/client-iot-1click-devices-service"); // CommonJS import + * const client = new IoT1ClickDevicesServiceClient(config); + * const command = new UntagResourceCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link UntagResourceCommandInput} for command's `input` shape. + * @see {@link UntagResourceCommandOutput} for command's `response` shape. + * @see {@link IoT1ClickDevicesServiceClientResolvedConfig | config} for command's `input` shape. + * */ export class UntagResourceCommand extends $Command< UntagResourceCommandInput, diff --git a/clients/client-iot-1click-devices-service/commands/UpdateDeviceStateCommand.ts b/clients/client-iot-1click-devices-service/commands/UpdateDeviceStateCommand.ts index bac9991fe3db..2ae5380479a9 100644 --- a/clients/client-iot-1click-devices-service/commands/UpdateDeviceStateCommand.ts +++ b/clients/client-iot-1click-devices-service/commands/UpdateDeviceStateCommand.ts @@ -27,6 +27,20 @@ export interface UpdateDeviceStateCommandOutput extends UpdateDeviceStateRespons /** *

Using a Boolean value (true or false), this operation * enables or disables the device given a device ID.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { IoT1ClickDevicesServiceClient, UpdateDeviceStateCommand } from "@aws-sdk/client-iot-1click-devices-service"; // ES Modules import + * // const { IoT1ClickDevicesServiceClient, UpdateDeviceStateCommand } = require("@aws-sdk/client-iot-1click-devices-service"); // CommonJS import + * const client = new IoT1ClickDevicesServiceClient(config); + * const command = new UpdateDeviceStateCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link UpdateDeviceStateCommandInput} for command's `input` shape. + * @see {@link UpdateDeviceStateCommandOutput} for command's `response` shape. + * @see {@link IoT1ClickDevicesServiceClientResolvedConfig | config} for command's `input` shape. + * */ export class UpdateDeviceStateCommand extends $Command< UpdateDeviceStateCommandInput, diff --git a/clients/client-iot-1click-devices-service/models/models_0.ts b/clients/client-iot-1click-devices-service/models/models_0.ts index 86948d34a274..e8cd4fd89539 100644 --- a/clients/client-iot-1click-devices-service/models/models_0.ts +++ b/clients/client-iot-1click-devices-service/models/models_0.ts @@ -41,6 +41,9 @@ export interface DeviceDescription { } export namespace DeviceDescription { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeviceDescription): any => ({ ...obj, }); @@ -49,6 +52,9 @@ export namespace DeviceDescription { export interface Attributes {} export namespace Attributes { + /** + * @internal + */ export const filterSensitiveLog = (obj: Attributes): any => ({ ...obj, }); @@ -72,6 +78,9 @@ export interface Device { } export namespace Device { + /** + * @internal + */ export const filterSensitiveLog = (obj: Device): any => ({ ...obj, }); @@ -90,6 +99,9 @@ export interface DeviceEvent { } export namespace DeviceEvent { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeviceEvent): any => ({ ...obj, }); @@ -108,6 +120,9 @@ export interface DeviceMethod { } export namespace DeviceMethod { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeviceMethod): any => ({ ...obj, }); @@ -121,6 +136,9 @@ export interface ClaimDevicesByClaimCodeRequest { } export namespace ClaimDevicesByClaimCodeRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ClaimDevicesByClaimCodeRequest): any => ({ ...obj, }); @@ -140,6 +158,9 @@ export interface ClaimDevicesByClaimCodeResponse { } export namespace ClaimDevicesByClaimCodeResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ClaimDevicesByClaimCodeResponse): any => ({ ...obj, }); @@ -160,6 +181,9 @@ export interface ForbiddenException extends __SmithyException, $MetadataBearer { } export namespace ForbiddenException { + /** + * @internal + */ export const filterSensitiveLog = (obj: ForbiddenException): any => ({ ...obj, }); @@ -180,6 +204,9 @@ export interface InternalFailureException extends __SmithyException, $MetadataBe } export namespace InternalFailureException { + /** + * @internal + */ export const filterSensitiveLog = (obj: InternalFailureException): any => ({ ...obj, }); @@ -200,6 +227,9 @@ export interface InvalidRequestException extends __SmithyException, $MetadataBea } export namespace InvalidRequestException { + /** + * @internal + */ export const filterSensitiveLog = (obj: InvalidRequestException): any => ({ ...obj, }); @@ -213,6 +243,9 @@ export interface DescribeDeviceRequest { } export namespace DescribeDeviceRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeDeviceRequest): any => ({ ...obj, }); @@ -226,6 +259,9 @@ export interface DescribeDeviceResponse { } export namespace DescribeDeviceResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeDeviceResponse): any => ({ ...obj, }); @@ -246,6 +282,9 @@ export interface ResourceNotFoundException extends __SmithyException, $MetadataB } export namespace ResourceNotFoundException { + /** + * @internal + */ export const filterSensitiveLog = (obj: ResourceNotFoundException): any => ({ ...obj, }); @@ -268,6 +307,9 @@ export interface FinalizeDeviceClaimRequest { } export namespace FinalizeDeviceClaimRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: FinalizeDeviceClaimRequest): any => ({ ...obj, }); @@ -281,6 +323,9 @@ export interface FinalizeDeviceClaimResponse { } export namespace FinalizeDeviceClaimResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: FinalizeDeviceClaimResponse): any => ({ ...obj, }); @@ -301,6 +346,9 @@ export interface PreconditionFailedException extends __SmithyException, $Metadat } export namespace PreconditionFailedException { + /** + * @internal + */ export const filterSensitiveLog = (obj: PreconditionFailedException): any => ({ ...obj, }); @@ -321,6 +369,9 @@ export interface ResourceConflictException extends __SmithyException, $MetadataB } export namespace ResourceConflictException { + /** + * @internal + */ export const filterSensitiveLog = (obj: ResourceConflictException): any => ({ ...obj, }); @@ -334,6 +385,9 @@ export interface GetDeviceMethodsRequest { } export namespace GetDeviceMethodsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetDeviceMethodsRequest): any => ({ ...obj, }); @@ -347,6 +401,9 @@ export interface GetDeviceMethodsResponse { } export namespace GetDeviceMethodsResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetDeviceMethodsResponse): any => ({ ...obj, }); @@ -360,6 +417,9 @@ export interface InitiateDeviceClaimRequest { } export namespace InitiateDeviceClaimRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: InitiateDeviceClaimRequest): any => ({ ...obj, }); @@ -373,6 +433,9 @@ export interface InitiateDeviceClaimResponse { } export namespace InitiateDeviceClaimResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: InitiateDeviceClaimResponse): any => ({ ...obj, }); @@ -396,6 +459,9 @@ export interface InvokeDeviceMethodRequest { } export namespace InvokeDeviceMethodRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: InvokeDeviceMethodRequest): any => ({ ...obj, }); @@ -409,6 +475,9 @@ export interface InvokeDeviceMethodResponse { } export namespace InvokeDeviceMethodResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: InvokeDeviceMethodResponse): any => ({ ...obj, }); @@ -430,6 +499,9 @@ export interface RangeNotSatisfiableException extends __SmithyException, $Metada } export namespace RangeNotSatisfiableException { + /** + * @internal + */ export const filterSensitiveLog = (obj: RangeNotSatisfiableException): any => ({ ...obj, }); @@ -468,6 +540,9 @@ export interface ListDeviceEventsRequest { } export namespace ListDeviceEventsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListDeviceEventsRequest): any => ({ ...obj, }); @@ -487,6 +562,9 @@ export interface ListDeviceEventsResponse { } export namespace ListDeviceEventsResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListDeviceEventsResponse): any => ({ ...obj, }); @@ -511,6 +589,9 @@ export interface ListDevicesRequest { } export namespace ListDevicesRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListDevicesRequest): any => ({ ...obj, }); @@ -529,6 +610,9 @@ export interface ListDevicesResponse { } export namespace ListDevicesResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListDevicesResponse): any => ({ ...obj, }); @@ -542,6 +626,9 @@ export interface ListTagsForResourceRequest { } export namespace ListTagsForResourceRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListTagsForResourceRequest): any => ({ ...obj, }); @@ -559,6 +646,9 @@ export interface ListTagsForResourceResponse { } export namespace ListTagsForResourceResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListTagsForResourceResponse): any => ({ ...obj, }); @@ -581,6 +671,9 @@ export interface TagResourceRequest { } export namespace TagResourceRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: TagResourceRequest): any => ({ ...obj, }); @@ -594,6 +687,9 @@ export interface UnclaimDeviceRequest { } export namespace UnclaimDeviceRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: UnclaimDeviceRequest): any => ({ ...obj, }); @@ -607,6 +703,9 @@ export interface UnclaimDeviceResponse { } export namespace UnclaimDeviceResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: UnclaimDeviceResponse): any => ({ ...obj, }); @@ -625,6 +724,9 @@ export interface UntagResourceRequest { } export namespace UntagResourceRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: UntagResourceRequest): any => ({ ...obj, }); @@ -644,6 +746,9 @@ export interface UpdateDeviceStateRequest { } export namespace UpdateDeviceStateRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateDeviceStateRequest): any => ({ ...obj, }); @@ -652,6 +757,9 @@ export namespace UpdateDeviceStateRequest { export interface UpdateDeviceStateResponse {} export namespace UpdateDeviceStateResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateDeviceStateResponse): any => ({ ...obj, }); diff --git a/clients/client-iot-1click-projects/commands/AssociateDeviceWithPlacementCommand.ts b/clients/client-iot-1click-projects/commands/AssociateDeviceWithPlacementCommand.ts index 3b8475c32c81..bd52e4fa921f 100644 --- a/clients/client-iot-1click-projects/commands/AssociateDeviceWithPlacementCommand.ts +++ b/clients/client-iot-1click-projects/commands/AssociateDeviceWithPlacementCommand.ts @@ -28,6 +28,20 @@ export interface AssociateDeviceWithPlacementCommandOutput /** *

Associates a physical device with a placement.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { IoT1ClickProjectsClient, AssociateDeviceWithPlacementCommand } from "@aws-sdk/client-iot-1click-projects"; // ES Modules import + * // const { IoT1ClickProjectsClient, AssociateDeviceWithPlacementCommand } = require("@aws-sdk/client-iot-1click-projects"); // CommonJS import + * const client = new IoT1ClickProjectsClient(config); + * const command = new AssociateDeviceWithPlacementCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link AssociateDeviceWithPlacementCommandInput} for command's `input` shape. + * @see {@link AssociateDeviceWithPlacementCommandOutput} for command's `response` shape. + * @see {@link IoT1ClickProjectsClientResolvedConfig | config} for command's `input` shape. + * */ export class AssociateDeviceWithPlacementCommand extends $Command< AssociateDeviceWithPlacementCommandInput, diff --git a/clients/client-iot-1click-projects/commands/CreatePlacementCommand.ts b/clients/client-iot-1click-projects/commands/CreatePlacementCommand.ts index dbc3040841f2..be4e56aede83 100644 --- a/clients/client-iot-1click-projects/commands/CreatePlacementCommand.ts +++ b/clients/client-iot-1click-projects/commands/CreatePlacementCommand.ts @@ -26,6 +26,20 @@ export interface CreatePlacementCommandOutput extends CreatePlacementResponse, _ /** *

Creates an empty placement.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { IoT1ClickProjectsClient, CreatePlacementCommand } from "@aws-sdk/client-iot-1click-projects"; // ES Modules import + * // const { IoT1ClickProjectsClient, CreatePlacementCommand } = require("@aws-sdk/client-iot-1click-projects"); // CommonJS import + * const client = new IoT1ClickProjectsClient(config); + * const command = new CreatePlacementCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreatePlacementCommandInput} for command's `input` shape. + * @see {@link CreatePlacementCommandOutput} for command's `response` shape. + * @see {@link IoT1ClickProjectsClientResolvedConfig | config} for command's `input` shape. + * */ export class CreatePlacementCommand extends $Command< CreatePlacementCommandInput, diff --git a/clients/client-iot-1click-projects/commands/CreateProjectCommand.ts b/clients/client-iot-1click-projects/commands/CreateProjectCommand.ts index 298a777ad501..f14826e283ac 100644 --- a/clients/client-iot-1click-projects/commands/CreateProjectCommand.ts +++ b/clients/client-iot-1click-projects/commands/CreateProjectCommand.ts @@ -27,6 +27,20 @@ export interface CreateProjectCommandOutput extends CreateProjectResponse, __Met /** *

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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { IoT1ClickProjectsClient, CreateProjectCommand } from "@aws-sdk/client-iot-1click-projects"; // ES Modules import + * // const { IoT1ClickProjectsClient, CreateProjectCommand } = require("@aws-sdk/client-iot-1click-projects"); // CommonJS import + * const client = new IoT1ClickProjectsClient(config); + * const command = new CreateProjectCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreateProjectCommandInput} for command's `input` shape. + * @see {@link CreateProjectCommandOutput} for command's `response` shape. + * @see {@link IoT1ClickProjectsClientResolvedConfig | config} for command's `input` shape. + * */ export class CreateProjectCommand extends $Command< CreateProjectCommandInput, diff --git a/clients/client-iot-1click-projects/commands/DeletePlacementCommand.ts b/clients/client-iot-1click-projects/commands/DeletePlacementCommand.ts index c0e634878875..5afaf026a0f7 100644 --- a/clients/client-iot-1click-projects/commands/DeletePlacementCommand.ts +++ b/clients/client-iot-1click-projects/commands/DeletePlacementCommand.ts @@ -30,6 +30,20 @@ export interface DeletePlacementCommandOutput extends DeletePlacementResponse, _ * *

When you delete a placement, all associated data becomes irretrievable.

* + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { IoT1ClickProjectsClient, DeletePlacementCommand } from "@aws-sdk/client-iot-1click-projects"; // ES Modules import + * // const { IoT1ClickProjectsClient, DeletePlacementCommand } = require("@aws-sdk/client-iot-1click-projects"); // CommonJS import + * const client = new IoT1ClickProjectsClient(config); + * const command = new DeletePlacementCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeletePlacementCommandInput} for command's `input` shape. + * @see {@link DeletePlacementCommandOutput} for command's `response` shape. + * @see {@link IoT1ClickProjectsClientResolvedConfig | config} for command's `input` shape. + * */ export class DeletePlacementCommand extends $Command< DeletePlacementCommandInput, diff --git a/clients/client-iot-1click-projects/commands/DeleteProjectCommand.ts b/clients/client-iot-1click-projects/commands/DeleteProjectCommand.ts index 07c66d5a1c81..21e781d35145 100644 --- a/clients/client-iot-1click-projects/commands/DeleteProjectCommand.ts +++ b/clients/client-iot-1click-projects/commands/DeleteProjectCommand.ts @@ -30,6 +30,20 @@ export interface DeleteProjectCommandOutput extends DeleteProjectResponse, __Met * *

When you delete a project, all associated data becomes irretrievable.

* + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { IoT1ClickProjectsClient, DeleteProjectCommand } from "@aws-sdk/client-iot-1click-projects"; // ES Modules import + * // const { IoT1ClickProjectsClient, DeleteProjectCommand } = require("@aws-sdk/client-iot-1click-projects"); // CommonJS import + * const client = new IoT1ClickProjectsClient(config); + * const command = new DeleteProjectCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteProjectCommandInput} for command's `input` shape. + * @see {@link DeleteProjectCommandOutput} for command's `response` shape. + * @see {@link IoT1ClickProjectsClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteProjectCommand extends $Command< DeleteProjectCommandInput, diff --git a/clients/client-iot-1click-projects/commands/DescribePlacementCommand.ts b/clients/client-iot-1click-projects/commands/DescribePlacementCommand.ts index 4dbbfc044d5d..b65ea3341ce2 100644 --- a/clients/client-iot-1click-projects/commands/DescribePlacementCommand.ts +++ b/clients/client-iot-1click-projects/commands/DescribePlacementCommand.ts @@ -26,6 +26,20 @@ export interface DescribePlacementCommandOutput extends DescribePlacementRespons /** *

Describes a placement in a project.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { IoT1ClickProjectsClient, DescribePlacementCommand } from "@aws-sdk/client-iot-1click-projects"; // ES Modules import + * // const { IoT1ClickProjectsClient, DescribePlacementCommand } = require("@aws-sdk/client-iot-1click-projects"); // CommonJS import + * const client = new IoT1ClickProjectsClient(config); + * const command = new DescribePlacementCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribePlacementCommandInput} for command's `input` shape. + * @see {@link DescribePlacementCommandOutput} for command's `response` shape. + * @see {@link IoT1ClickProjectsClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribePlacementCommand extends $Command< DescribePlacementCommandInput, diff --git a/clients/client-iot-1click-projects/commands/DescribeProjectCommand.ts b/clients/client-iot-1click-projects/commands/DescribeProjectCommand.ts index 3c5deabcec9d..4c65cdf46901 100644 --- a/clients/client-iot-1click-projects/commands/DescribeProjectCommand.ts +++ b/clients/client-iot-1click-projects/commands/DescribeProjectCommand.ts @@ -26,6 +26,20 @@ export interface DescribeProjectCommandOutput extends DescribeProjectResponse, _ /** *

Returns an object describing a project.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { IoT1ClickProjectsClient, DescribeProjectCommand } from "@aws-sdk/client-iot-1click-projects"; // ES Modules import + * // const { IoT1ClickProjectsClient, DescribeProjectCommand } = require("@aws-sdk/client-iot-1click-projects"); // CommonJS import + * const client = new IoT1ClickProjectsClient(config); + * const command = new DescribeProjectCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeProjectCommandInput} for command's `input` shape. + * @see {@link DescribeProjectCommandOutput} for command's `response` shape. + * @see {@link IoT1ClickProjectsClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeProjectCommand extends $Command< DescribeProjectCommandInput, diff --git a/clients/client-iot-1click-projects/commands/DisassociateDeviceFromPlacementCommand.ts b/clients/client-iot-1click-projects/commands/DisassociateDeviceFromPlacementCommand.ts index bf3a3a018d92..7852efcfd204 100644 --- a/clients/client-iot-1click-projects/commands/DisassociateDeviceFromPlacementCommand.ts +++ b/clients/client-iot-1click-projects/commands/DisassociateDeviceFromPlacementCommand.ts @@ -28,6 +28,20 @@ export interface DisassociateDeviceFromPlacementCommandOutput /** *

Removes a physical device from a placement.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { IoT1ClickProjectsClient, DisassociateDeviceFromPlacementCommand } from "@aws-sdk/client-iot-1click-projects"; // ES Modules import + * // const { IoT1ClickProjectsClient, DisassociateDeviceFromPlacementCommand } = require("@aws-sdk/client-iot-1click-projects"); // CommonJS import + * const client = new IoT1ClickProjectsClient(config); + * const command = new DisassociateDeviceFromPlacementCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DisassociateDeviceFromPlacementCommandInput} for command's `input` shape. + * @see {@link DisassociateDeviceFromPlacementCommandOutput} for command's `response` shape. + * @see {@link IoT1ClickProjectsClientResolvedConfig | config} for command's `input` shape. + * */ export class DisassociateDeviceFromPlacementCommand extends $Command< DisassociateDeviceFromPlacementCommandInput, diff --git a/clients/client-iot-1click-projects/commands/GetDevicesInPlacementCommand.ts b/clients/client-iot-1click-projects/commands/GetDevicesInPlacementCommand.ts index 14822ec6d337..1793cbd94a0c 100644 --- a/clients/client-iot-1click-projects/commands/GetDevicesInPlacementCommand.ts +++ b/clients/client-iot-1click-projects/commands/GetDevicesInPlacementCommand.ts @@ -26,6 +26,20 @@ export interface GetDevicesInPlacementCommandOutput extends GetDevicesInPlacemen /** *

Returns an object enumerating the devices in a placement.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { IoT1ClickProjectsClient, GetDevicesInPlacementCommand } from "@aws-sdk/client-iot-1click-projects"; // ES Modules import + * // const { IoT1ClickProjectsClient, GetDevicesInPlacementCommand } = require("@aws-sdk/client-iot-1click-projects"); // CommonJS import + * const client = new IoT1ClickProjectsClient(config); + * const command = new GetDevicesInPlacementCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetDevicesInPlacementCommandInput} for command's `input` shape. + * @see {@link GetDevicesInPlacementCommandOutput} for command's `response` shape. + * @see {@link IoT1ClickProjectsClientResolvedConfig | config} for command's `input` shape. + * */ export class GetDevicesInPlacementCommand extends $Command< GetDevicesInPlacementCommandInput, diff --git a/clients/client-iot-1click-projects/commands/ListPlacementsCommand.ts b/clients/client-iot-1click-projects/commands/ListPlacementsCommand.ts index 985484f3906b..cc3e27dcdc44 100644 --- a/clients/client-iot-1click-projects/commands/ListPlacementsCommand.ts +++ b/clients/client-iot-1click-projects/commands/ListPlacementsCommand.ts @@ -26,6 +26,20 @@ export interface ListPlacementsCommandOutput extends ListPlacementsResponse, __M /** *

Lists the placement(s) of a project.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { IoT1ClickProjectsClient, ListPlacementsCommand } from "@aws-sdk/client-iot-1click-projects"; // ES Modules import + * // const { IoT1ClickProjectsClient, ListPlacementsCommand } = require("@aws-sdk/client-iot-1click-projects"); // CommonJS import + * const client = new IoT1ClickProjectsClient(config); + * const command = new ListPlacementsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListPlacementsCommandInput} for command's `input` shape. + * @see {@link ListPlacementsCommandOutput} for command's `response` shape. + * @see {@link IoT1ClickProjectsClientResolvedConfig | config} for command's `input` shape. + * */ export class ListPlacementsCommand extends $Command< ListPlacementsCommandInput, diff --git a/clients/client-iot-1click-projects/commands/ListProjectsCommand.ts b/clients/client-iot-1click-projects/commands/ListProjectsCommand.ts index b076600b4caa..8c0c00d1498d 100644 --- a/clients/client-iot-1click-projects/commands/ListProjectsCommand.ts +++ b/clients/client-iot-1click-projects/commands/ListProjectsCommand.ts @@ -26,6 +26,20 @@ export interface ListProjectsCommandOutput extends ListProjectsResponse, __Metad /** *

Lists the AWS IoT 1-Click project(s) associated with your AWS account and region.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { IoT1ClickProjectsClient, ListProjectsCommand } from "@aws-sdk/client-iot-1click-projects"; // ES Modules import + * // const { IoT1ClickProjectsClient, ListProjectsCommand } = require("@aws-sdk/client-iot-1click-projects"); // CommonJS import + * const client = new IoT1ClickProjectsClient(config); + * const command = new ListProjectsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListProjectsCommandInput} for command's `input` shape. + * @see {@link ListProjectsCommandOutput} for command's `response` shape. + * @see {@link IoT1ClickProjectsClientResolvedConfig | config} for command's `input` shape. + * */ export class ListProjectsCommand extends $Command< ListProjectsCommandInput, diff --git a/clients/client-iot-1click-projects/commands/ListTagsForResourceCommand.ts b/clients/client-iot-1click-projects/commands/ListTagsForResourceCommand.ts index c0cbbfaa94aa..a1539e90193f 100644 --- a/clients/client-iot-1click-projects/commands/ListTagsForResourceCommand.ts +++ b/clients/client-iot-1click-projects/commands/ListTagsForResourceCommand.ts @@ -26,6 +26,20 @@ export interface ListTagsForResourceCommandOutput extends ListTagsForResourceRes /** *

Lists the tags (metadata key/value pairs) which you have assigned to the resource.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { IoT1ClickProjectsClient, ListTagsForResourceCommand } from "@aws-sdk/client-iot-1click-projects"; // ES Modules import + * // const { IoT1ClickProjectsClient, ListTagsForResourceCommand } = require("@aws-sdk/client-iot-1click-projects"); // CommonJS import + * const client = new IoT1ClickProjectsClient(config); + * const command = new ListTagsForResourceCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListTagsForResourceCommandInput} for command's `input` shape. + * @see {@link ListTagsForResourceCommandOutput} for command's `response` shape. + * @see {@link IoT1ClickProjectsClientResolvedConfig | config} for command's `input` shape. + * */ export class ListTagsForResourceCommand extends $Command< ListTagsForResourceCommandInput, diff --git a/clients/client-iot-1click-projects/commands/TagResourceCommand.ts b/clients/client-iot-1click-projects/commands/TagResourceCommand.ts index e5ebd74cdfaa..fc4bdbe28b78 100644 --- a/clients/client-iot-1click-projects/commands/TagResourceCommand.ts +++ b/clients/client-iot-1click-projects/commands/TagResourceCommand.ts @@ -28,6 +28,20 @@ export interface TagResourceCommandOutput extends TagResourceResponse, __Metadat *

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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { IoT1ClickProjectsClient, TagResourceCommand } from "@aws-sdk/client-iot-1click-projects"; // ES Modules import + * // const { IoT1ClickProjectsClient, TagResourceCommand } = require("@aws-sdk/client-iot-1click-projects"); // CommonJS import + * const client = new IoT1ClickProjectsClient(config); + * const command = new TagResourceCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link TagResourceCommandInput} for command's `input` shape. + * @see {@link TagResourceCommandOutput} for command's `response` shape. + * @see {@link IoT1ClickProjectsClientResolvedConfig | config} for command's `input` shape. + * */ export class TagResourceCommand extends $Command< TagResourceCommandInput, diff --git a/clients/client-iot-1click-projects/commands/UntagResourceCommand.ts b/clients/client-iot-1click-projects/commands/UntagResourceCommand.ts index ac4854b44c1e..c859a94bbb09 100644 --- a/clients/client-iot-1click-projects/commands/UntagResourceCommand.ts +++ b/clients/client-iot-1click-projects/commands/UntagResourceCommand.ts @@ -26,6 +26,20 @@ export interface UntagResourceCommandOutput extends UntagResourceResponse, __Met /** *

Removes one or more tags (metadata key/value pairs) from a resource.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { IoT1ClickProjectsClient, UntagResourceCommand } from "@aws-sdk/client-iot-1click-projects"; // ES Modules import + * // const { IoT1ClickProjectsClient, UntagResourceCommand } = require("@aws-sdk/client-iot-1click-projects"); // CommonJS import + * const client = new IoT1ClickProjectsClient(config); + * const command = new UntagResourceCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link UntagResourceCommandInput} for command's `input` shape. + * @see {@link UntagResourceCommandOutput} for command's `response` shape. + * @see {@link IoT1ClickProjectsClientResolvedConfig | config} for command's `input` shape. + * */ export class UntagResourceCommand extends $Command< UntagResourceCommandInput, diff --git a/clients/client-iot-1click-projects/commands/UpdatePlacementCommand.ts b/clients/client-iot-1click-projects/commands/UpdatePlacementCommand.ts index 6b2a07c0390d..21c6c1f2f3c8 100644 --- a/clients/client-iot-1click-projects/commands/UpdatePlacementCommand.ts +++ b/clients/client-iot-1click-projects/commands/UpdatePlacementCommand.ts @@ -27,6 +27,20 @@ export interface UpdatePlacementCommandOutput extends UpdatePlacementResponse, _ /** *

Updates a placement with the given attributes. To clear an attribute, pass an empty value * (i.e., "").

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { IoT1ClickProjectsClient, UpdatePlacementCommand } from "@aws-sdk/client-iot-1click-projects"; // ES Modules import + * // const { IoT1ClickProjectsClient, UpdatePlacementCommand } = require("@aws-sdk/client-iot-1click-projects"); // CommonJS import + * const client = new IoT1ClickProjectsClient(config); + * const command = new UpdatePlacementCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link UpdatePlacementCommandInput} for command's `input` shape. + * @see {@link UpdatePlacementCommandOutput} for command's `response` shape. + * @see {@link IoT1ClickProjectsClientResolvedConfig | config} for command's `input` shape. + * */ export class UpdatePlacementCommand extends $Command< UpdatePlacementCommandInput, diff --git a/clients/client-iot-1click-projects/commands/UpdateProjectCommand.ts b/clients/client-iot-1click-projects/commands/UpdateProjectCommand.ts index 99e8cbf06ac8..7a13f796807e 100644 --- a/clients/client-iot-1click-projects/commands/UpdateProjectCommand.ts +++ b/clients/client-iot-1click-projects/commands/UpdateProjectCommand.ts @@ -29,6 +29,20 @@ export interface UpdateProjectCommandOutput extends UpdateProjectResponse, __Met * 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., "").

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { IoT1ClickProjectsClient, UpdateProjectCommand } from "@aws-sdk/client-iot-1click-projects"; // ES Modules import + * // const { IoT1ClickProjectsClient, UpdateProjectCommand } = require("@aws-sdk/client-iot-1click-projects"); // CommonJS import + * const client = new IoT1ClickProjectsClient(config); + * const command = new UpdateProjectCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link UpdateProjectCommandInput} for command's `input` shape. + * @see {@link UpdateProjectCommandOutput} for command's `response` shape. + * @see {@link IoT1ClickProjectsClientResolvedConfig | config} for command's `input` shape. + * */ export class UpdateProjectCommand extends $Command< UpdateProjectCommandInput, diff --git a/clients/client-iot-1click-projects/models/models_0.ts b/clients/client-iot-1click-projects/models/models_0.ts index 2067010e0f22..fd885956d2e6 100644 --- a/clients/client-iot-1click-projects/models/models_0.ts +++ b/clients/client-iot-1click-projects/models/models_0.ts @@ -26,6 +26,9 @@ export interface AssociateDeviceWithPlacementRequest { } export namespace AssociateDeviceWithPlacementRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: AssociateDeviceWithPlacementRequest): any => ({ ...obj, }); @@ -34,6 +37,9 @@ export namespace AssociateDeviceWithPlacementRequest { export interface AssociateDeviceWithPlacementResponse {} export namespace AssociateDeviceWithPlacementResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: AssociateDeviceWithPlacementResponse): any => ({ ...obj, }); @@ -50,6 +56,9 @@ export interface InternalFailureException extends __SmithyException, $MetadataBe } export namespace InternalFailureException { + /** + * @internal + */ export const filterSensitiveLog = (obj: InternalFailureException): any => ({ ...obj, }); @@ -66,6 +75,9 @@ export interface InvalidRequestException extends __SmithyException, $MetadataBea } export namespace InvalidRequestException { + /** + * @internal + */ export const filterSensitiveLog = (obj: InvalidRequestException): any => ({ ...obj, }); @@ -82,6 +94,9 @@ export interface ResourceConflictException extends __SmithyException, $MetadataB } export namespace ResourceConflictException { + /** + * @internal + */ export const filterSensitiveLog = (obj: ResourceConflictException): any => ({ ...obj, }); @@ -98,6 +113,9 @@ export interface ResourceNotFoundException extends __SmithyException, $MetadataB } export namespace ResourceNotFoundException { + /** + * @internal + */ export const filterSensitiveLog = (obj: ResourceNotFoundException): any => ({ ...obj, }); @@ -122,6 +140,9 @@ export interface CreatePlacementRequest { } export namespace CreatePlacementRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreatePlacementRequest): any => ({ ...obj, }); @@ -130,6 +151,9 @@ export namespace CreatePlacementRequest { export interface CreatePlacementResponse {} export namespace CreatePlacementResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreatePlacementResponse): any => ({ ...obj, }); @@ -152,6 +176,9 @@ export interface DeviceTemplate { } export namespace DeviceTemplate { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeviceTemplate): any => ({ ...obj, }); @@ -175,6 +202,9 @@ export interface PlacementTemplate { } export namespace PlacementTemplate { + /** + * @internal + */ export const filterSensitiveLog = (obj: PlacementTemplate): any => ({ ...obj, }); @@ -208,6 +238,9 @@ export interface CreateProjectRequest { } export namespace CreateProjectRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateProjectRequest): any => ({ ...obj, }); @@ -216,6 +249,9 @@ export namespace CreateProjectRequest { export interface CreateProjectResponse {} export namespace CreateProjectResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateProjectResponse): any => ({ ...obj, }); @@ -234,6 +270,9 @@ export interface DeletePlacementRequest { } export namespace DeletePlacementRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeletePlacementRequest): any => ({ ...obj, }); @@ -242,6 +281,9 @@ export namespace DeletePlacementRequest { export interface DeletePlacementResponse {} export namespace DeletePlacementResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeletePlacementResponse): any => ({ ...obj, }); @@ -258,6 +300,9 @@ export interface TooManyRequestsException extends __SmithyException, $MetadataBe } export namespace TooManyRequestsException { + /** + * @internal + */ export const filterSensitiveLog = (obj: TooManyRequestsException): any => ({ ...obj, }); @@ -271,6 +316,9 @@ export interface DeleteProjectRequest { } export namespace DeleteProjectRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteProjectRequest): any => ({ ...obj, }); @@ -279,6 +327,9 @@ export namespace DeleteProjectRequest { export interface DeleteProjectResponse {} export namespace DeleteProjectResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteProjectResponse): any => ({ ...obj, }); @@ -297,6 +348,9 @@ export interface DescribePlacementRequest { } export namespace DescribePlacementRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribePlacementRequest): any => ({ ...obj, }); @@ -335,6 +389,9 @@ export interface PlacementDescription { } export namespace PlacementDescription { + /** + * @internal + */ export const filterSensitiveLog = (obj: PlacementDescription): any => ({ ...obj, }); @@ -348,6 +405,9 @@ export interface DescribePlacementResponse { } export namespace DescribePlacementResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribePlacementResponse): any => ({ ...obj, }); @@ -361,6 +421,9 @@ export interface DescribeProjectRequest { } export namespace DescribeProjectRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeProjectRequest): any => ({ ...obj, }); @@ -409,6 +472,9 @@ export interface ProjectDescription { } export namespace ProjectDescription { + /** + * @internal + */ export const filterSensitiveLog = (obj: ProjectDescription): any => ({ ...obj, }); @@ -422,6 +488,9 @@ export interface DescribeProjectResponse { } export namespace DescribeProjectResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeProjectResponse): any => ({ ...obj, }); @@ -445,6 +514,9 @@ export interface DisassociateDeviceFromPlacementRequest { } export namespace DisassociateDeviceFromPlacementRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DisassociateDeviceFromPlacementRequest): any => ({ ...obj, }); @@ -453,6 +525,9 @@ export namespace DisassociateDeviceFromPlacementRequest { export interface DisassociateDeviceFromPlacementResponse {} export namespace DisassociateDeviceFromPlacementResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DisassociateDeviceFromPlacementResponse): any => ({ ...obj, }); @@ -471,6 +546,9 @@ export interface GetDevicesInPlacementRequest { } export namespace GetDevicesInPlacementRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetDevicesInPlacementRequest): any => ({ ...obj, }); @@ -484,6 +562,9 @@ export interface GetDevicesInPlacementResponse { } export namespace GetDevicesInPlacementResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetDevicesInPlacementResponse): any => ({ ...obj, }); @@ -508,6 +589,9 @@ export interface ListPlacementsRequest { } export namespace ListPlacementsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListPlacementsRequest): any => ({ ...obj, }); @@ -541,6 +625,9 @@ export interface PlacementSummary { } export namespace PlacementSummary { + /** + * @internal + */ export const filterSensitiveLog = (obj: PlacementSummary): any => ({ ...obj, }); @@ -560,6 +647,9 @@ export interface ListPlacementsResponse { } export namespace ListPlacementsResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListPlacementsResponse): any => ({ ...obj, }); @@ -579,6 +669,9 @@ export interface ListProjectsRequest { } export namespace ListProjectsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListProjectsRequest): any => ({ ...obj, }); @@ -617,6 +710,9 @@ export interface ProjectSummary { } export namespace ProjectSummary { + /** + * @internal + */ export const filterSensitiveLog = (obj: ProjectSummary): any => ({ ...obj, }); @@ -636,6 +732,9 @@ export interface ListProjectsResponse { } export namespace ListProjectsResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListProjectsResponse): any => ({ ...obj, }); @@ -649,6 +748,9 @@ export interface ListTagsForResourceRequest { } export namespace ListTagsForResourceRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListTagsForResourceRequest): any => ({ ...obj, }); @@ -662,6 +764,9 @@ export interface ListTagsForResourceResponse { } export namespace ListTagsForResourceResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListTagsForResourceResponse): any => ({ ...obj, }); @@ -681,6 +786,9 @@ export interface TagResourceRequest { } export namespace TagResourceRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: TagResourceRequest): any => ({ ...obj, }); @@ -689,6 +797,9 @@ export namespace TagResourceRequest { export interface TagResourceResponse {} export namespace TagResourceResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: TagResourceResponse): any => ({ ...obj, }); @@ -707,6 +818,9 @@ export interface UntagResourceRequest { } export namespace UntagResourceRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: UntagResourceRequest): any => ({ ...obj, }); @@ -715,6 +829,9 @@ export namespace UntagResourceRequest { export interface UntagResourceResponse {} export namespace UntagResourceResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: UntagResourceResponse): any => ({ ...obj, }); @@ -739,6 +856,9 @@ export interface UpdatePlacementRequest { } export namespace UpdatePlacementRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdatePlacementRequest): any => ({ ...obj, }); @@ -747,6 +867,9 @@ export namespace UpdatePlacementRequest { export interface UpdatePlacementResponse {} export namespace UpdatePlacementResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdatePlacementResponse): any => ({ ...obj, }); @@ -773,6 +896,9 @@ export interface UpdateProjectRequest { } export namespace UpdateProjectRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateProjectRequest): any => ({ ...obj, }); @@ -781,6 +907,9 @@ export namespace UpdateProjectRequest { export interface UpdateProjectResponse {} export namespace UpdateProjectResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateProjectResponse): any => ({ ...obj, }); diff --git a/clients/client-iot-data-plane/commands/DeleteThingShadowCommand.ts b/clients/client-iot-data-plane/commands/DeleteThingShadowCommand.ts index 332cb172cdfa..2234de6d1c5a 100644 --- a/clients/client-iot-data-plane/commands/DeleteThingShadowCommand.ts +++ b/clients/client-iot-data-plane/commands/DeleteThingShadowCommand.ts @@ -23,6 +23,20 @@ export interface DeleteThingShadowCommandOutput extends DeleteThingShadowRespons /** *

Deletes the shadow for the specified thing.

*

For more information, see DeleteThingShadow in the AWS IoT Developer Guide.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { IoTDataPlaneClient, DeleteThingShadowCommand } from "@aws-sdk/client-iot-data-plane"; // ES Modules import + * // const { IoTDataPlaneClient, DeleteThingShadowCommand } = require("@aws-sdk/client-iot-data-plane"); // CommonJS import + * const client = new IoTDataPlaneClient(config); + * const command = new DeleteThingShadowCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteThingShadowCommandInput} for command's `input` shape. + * @see {@link DeleteThingShadowCommandOutput} for command's `response` shape. + * @see {@link IoTDataPlaneClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteThingShadowCommand extends $Command< DeleteThingShadowCommandInput, diff --git a/clients/client-iot-data-plane/commands/GetThingShadowCommand.ts b/clients/client-iot-data-plane/commands/GetThingShadowCommand.ts index cbf7b2d44b6e..ba0fd82d9e86 100644 --- a/clients/client-iot-data-plane/commands/GetThingShadowCommand.ts +++ b/clients/client-iot-data-plane/commands/GetThingShadowCommand.ts @@ -24,6 +24,20 @@ export interface GetThingShadowCommandOutput extends GetThingShadowResponse, __M *

Gets the shadow for the specified thing.

*

For more information, see GetThingShadow in the * AWS IoT Developer Guide.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { IoTDataPlaneClient, GetThingShadowCommand } from "@aws-sdk/client-iot-data-plane"; // ES Modules import + * // const { IoTDataPlaneClient, GetThingShadowCommand } = require("@aws-sdk/client-iot-data-plane"); // CommonJS import + * const client = new IoTDataPlaneClient(config); + * const command = new GetThingShadowCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetThingShadowCommandInput} for command's `input` shape. + * @see {@link GetThingShadowCommandOutput} for command's `response` shape. + * @see {@link IoTDataPlaneClientResolvedConfig | config} for command's `input` shape. + * */ export class GetThingShadowCommand extends $Command< GetThingShadowCommandInput, diff --git a/clients/client-iot-data-plane/commands/ListNamedShadowsForThingCommand.ts b/clients/client-iot-data-plane/commands/ListNamedShadowsForThingCommand.ts index 960d9b3fb2f5..39774c9ed32f 100644 --- a/clients/client-iot-data-plane/commands/ListNamedShadowsForThingCommand.ts +++ b/clients/client-iot-data-plane/commands/ListNamedShadowsForThingCommand.ts @@ -22,6 +22,20 @@ export interface ListNamedShadowsForThingCommandOutput extends ListNamedShadowsF /** *

Lists the shadows for the specified thing.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { IoTDataPlaneClient, ListNamedShadowsForThingCommand } from "@aws-sdk/client-iot-data-plane"; // ES Modules import + * // const { IoTDataPlaneClient, ListNamedShadowsForThingCommand } = require("@aws-sdk/client-iot-data-plane"); // CommonJS import + * const client = new IoTDataPlaneClient(config); + * const command = new ListNamedShadowsForThingCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListNamedShadowsForThingCommandInput} for command's `input` shape. + * @see {@link ListNamedShadowsForThingCommandOutput} for command's `response` shape. + * @see {@link IoTDataPlaneClientResolvedConfig | config} for command's `input` shape. + * */ export class ListNamedShadowsForThingCommand extends $Command< ListNamedShadowsForThingCommandInput, diff --git a/clients/client-iot-data-plane/commands/PublishCommand.ts b/clients/client-iot-data-plane/commands/PublishCommand.ts index e5128f4375d0..c296f19a9c31 100644 --- a/clients/client-iot-data-plane/commands/PublishCommand.ts +++ b/clients/client-iot-data-plane/commands/PublishCommand.ts @@ -24,6 +24,20 @@ export interface PublishCommandOutput extends __MetadataBearer {} *

Publishes state information.

*

For more information, see HTTP Protocol in the * AWS IoT Developer Guide.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { IoTDataPlaneClient, PublishCommand } from "@aws-sdk/client-iot-data-plane"; // ES Modules import + * // const { IoTDataPlaneClient, PublishCommand } = require("@aws-sdk/client-iot-data-plane"); // CommonJS import + * const client = new IoTDataPlaneClient(config); + * const command = new PublishCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link PublishCommandInput} for command's `input` shape. + * @see {@link PublishCommandOutput} for command's `response` shape. + * @see {@link IoTDataPlaneClientResolvedConfig | config} for command's `input` shape. + * */ export class PublishCommand extends $Command< PublishCommandInput, diff --git a/clients/client-iot-data-plane/commands/UpdateThingShadowCommand.ts b/clients/client-iot-data-plane/commands/UpdateThingShadowCommand.ts index 9309ef96d4e4..b349618b18e7 100644 --- a/clients/client-iot-data-plane/commands/UpdateThingShadowCommand.ts +++ b/clients/client-iot-data-plane/commands/UpdateThingShadowCommand.ts @@ -24,6 +24,20 @@ export interface UpdateThingShadowCommandOutput extends UpdateThingShadowRespons *

Updates the shadow for the specified thing.

*

For more information, see UpdateThingShadow in the * AWS IoT Developer Guide.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { IoTDataPlaneClient, UpdateThingShadowCommand } from "@aws-sdk/client-iot-data-plane"; // ES Modules import + * // const { IoTDataPlaneClient, UpdateThingShadowCommand } = require("@aws-sdk/client-iot-data-plane"); // CommonJS import + * const client = new IoTDataPlaneClient(config); + * const command = new UpdateThingShadowCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link UpdateThingShadowCommandInput} for command's `input` shape. + * @see {@link UpdateThingShadowCommandOutput} for command's `response` shape. + * @see {@link IoTDataPlaneClientResolvedConfig | config} for command's `input` shape. + * */ export class UpdateThingShadowCommand extends $Command< UpdateThingShadowCommandInput, diff --git a/clients/client-iot-data-plane/models/models_0.ts b/clients/client-iot-data-plane/models/models_0.ts index e0d030a6e4ae..69251ba8fa3e 100644 --- a/clients/client-iot-data-plane/models/models_0.ts +++ b/clients/client-iot-data-plane/models/models_0.ts @@ -14,6 +14,9 @@ export interface ConflictException extends __SmithyException, $MetadataBearer { } export namespace ConflictException { + /** + * @internal + */ export const filterSensitiveLog = (obj: ConflictException): any => ({ ...obj, }); @@ -35,6 +38,9 @@ export interface DeleteThingShadowRequest { } export namespace DeleteThingShadowRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteThingShadowRequest): any => ({ ...obj, }); @@ -51,6 +57,9 @@ export interface DeleteThingShadowResponse { } export namespace DeleteThingShadowResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteThingShadowResponse): any => ({ ...obj, }); @@ -69,6 +78,9 @@ export interface InternalFailureException extends __SmithyException, $MetadataBe } export namespace InternalFailureException { + /** + * @internal + */ export const filterSensitiveLog = (obj: InternalFailureException): any => ({ ...obj, }); @@ -87,6 +99,9 @@ export interface InvalidRequestException extends __SmithyException, $MetadataBea } export namespace InvalidRequestException { + /** + * @internal + */ export const filterSensitiveLog = (obj: InvalidRequestException): any => ({ ...obj, }); @@ -105,6 +120,9 @@ export interface MethodNotAllowedException extends __SmithyException, $MetadataB } export namespace MethodNotAllowedException { + /** + * @internal + */ export const filterSensitiveLog = (obj: MethodNotAllowedException): any => ({ ...obj, }); @@ -123,6 +141,9 @@ export interface ResourceNotFoundException extends __SmithyException, $MetadataB } export namespace ResourceNotFoundException { + /** + * @internal + */ export const filterSensitiveLog = (obj: ResourceNotFoundException): any => ({ ...obj, }); @@ -141,6 +162,9 @@ export interface ServiceUnavailableException extends __SmithyException, $Metadat } export namespace ServiceUnavailableException { + /** + * @internal + */ export const filterSensitiveLog = (obj: ServiceUnavailableException): any => ({ ...obj, }); @@ -159,6 +183,9 @@ export interface ThrottlingException extends __SmithyException, $MetadataBearer } export namespace ThrottlingException { + /** + * @internal + */ export const filterSensitiveLog = (obj: ThrottlingException): any => ({ ...obj, }); @@ -177,6 +204,9 @@ export interface UnauthorizedException extends __SmithyException, $MetadataBeare } export namespace UnauthorizedException { + /** + * @internal + */ export const filterSensitiveLog = (obj: UnauthorizedException): any => ({ ...obj, }); @@ -195,6 +225,9 @@ export interface UnsupportedDocumentEncodingException extends __SmithyException, } export namespace UnsupportedDocumentEncodingException { + /** + * @internal + */ export const filterSensitiveLog = (obj: UnsupportedDocumentEncodingException): any => ({ ...obj, }); @@ -216,6 +249,9 @@ export interface GetThingShadowRequest { } export namespace GetThingShadowRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetThingShadowRequest): any => ({ ...obj, }); @@ -232,6 +268,9 @@ export interface GetThingShadowResponse { } export namespace GetThingShadowResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetThingShadowResponse): any => ({ ...obj, }); @@ -255,6 +294,9 @@ export interface ListNamedShadowsForThingRequest { } export namespace ListNamedShadowsForThingRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListNamedShadowsForThingRequest): any => ({ ...obj, }); @@ -278,6 +320,9 @@ export interface ListNamedShadowsForThingResponse { } export namespace ListNamedShadowsForThingResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListNamedShadowsForThingResponse): any => ({ ...obj, }); @@ -304,6 +349,9 @@ export interface PublishRequest { } export namespace PublishRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: PublishRequest): any => ({ ...obj, }); @@ -322,6 +370,9 @@ export interface RequestEntityTooLargeException extends __SmithyException, $Meta } export namespace RequestEntityTooLargeException { + /** + * @internal + */ export const filterSensitiveLog = (obj: RequestEntityTooLargeException): any => ({ ...obj, }); @@ -348,6 +399,9 @@ export interface UpdateThingShadowRequest { } export namespace UpdateThingShadowRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateThingShadowRequest): any => ({ ...obj, }); @@ -364,6 +418,9 @@ export interface UpdateThingShadowResponse { } export namespace UpdateThingShadowResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateThingShadowResponse): any => ({ ...obj, }); diff --git a/clients/client-iot-events-data/commands/BatchPutMessageCommand.ts b/clients/client-iot-events-data/commands/BatchPutMessageCommand.ts index 52d0ef48b89b..f9755dc92fd3 100644 --- a/clients/client-iot-events-data/commands/BatchPutMessageCommand.ts +++ b/clients/client-iot-events-data/commands/BatchPutMessageCommand.ts @@ -26,6 +26,20 @@ export interface BatchPutMessageCommandOutput extends BatchPutMessageResponse, _ * 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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { IoTEventsDataClient, BatchPutMessageCommand } from "@aws-sdk/client-iot-events-data"; // ES Modules import + * // const { IoTEventsDataClient, BatchPutMessageCommand } = require("@aws-sdk/client-iot-events-data"); // CommonJS import + * const client = new IoTEventsDataClient(config); + * const command = new BatchPutMessageCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link BatchPutMessageCommandInput} for command's `input` shape. + * @see {@link BatchPutMessageCommandOutput} for command's `response` shape. + * @see {@link IoTEventsDataClientResolvedConfig | config} for command's `input` shape. + * */ export class BatchPutMessageCommand extends $Command< BatchPutMessageCommandInput, diff --git a/clients/client-iot-events-data/commands/BatchUpdateDetectorCommand.ts b/clients/client-iot-events-data/commands/BatchUpdateDetectorCommand.ts index f95a13a6f01b..425cb54988c5 100644 --- a/clients/client-iot-events-data/commands/BatchUpdateDetectorCommand.ts +++ b/clients/client-iot-events-data/commands/BatchUpdateDetectorCommand.ts @@ -23,6 +23,20 @@ export interface BatchUpdateDetectorCommandOutput extends BatchUpdateDetectorRes /** *

Updates the state, variable values, and timer settings of one or more detectors (instances) * of a specified detector model.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { IoTEventsDataClient, BatchUpdateDetectorCommand } from "@aws-sdk/client-iot-events-data"; // ES Modules import + * // const { IoTEventsDataClient, BatchUpdateDetectorCommand } = require("@aws-sdk/client-iot-events-data"); // CommonJS import + * const client = new IoTEventsDataClient(config); + * const command = new BatchUpdateDetectorCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link BatchUpdateDetectorCommandInput} for command's `input` shape. + * @see {@link BatchUpdateDetectorCommandOutput} for command's `response` shape. + * @see {@link IoTEventsDataClientResolvedConfig | config} for command's `input` shape. + * */ export class BatchUpdateDetectorCommand extends $Command< BatchUpdateDetectorCommandInput, diff --git a/clients/client-iot-events-data/commands/DescribeDetectorCommand.ts b/clients/client-iot-events-data/commands/DescribeDetectorCommand.ts index e2e4e63813e9..7b3918dfa905 100644 --- a/clients/client-iot-events-data/commands/DescribeDetectorCommand.ts +++ b/clients/client-iot-events-data/commands/DescribeDetectorCommand.ts @@ -22,6 +22,20 @@ export interface DescribeDetectorCommandOutput extends DescribeDetectorResponse, /** *

Returns information about the specified detector (instance).

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { IoTEventsDataClient, DescribeDetectorCommand } from "@aws-sdk/client-iot-events-data"; // ES Modules import + * // const { IoTEventsDataClient, DescribeDetectorCommand } = require("@aws-sdk/client-iot-events-data"); // CommonJS import + * const client = new IoTEventsDataClient(config); + * const command = new DescribeDetectorCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeDetectorCommandInput} for command's `input` shape. + * @see {@link DescribeDetectorCommandOutput} for command's `response` shape. + * @see {@link IoTEventsDataClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeDetectorCommand extends $Command< DescribeDetectorCommandInput, diff --git a/clients/client-iot-events-data/commands/ListDetectorsCommand.ts b/clients/client-iot-events-data/commands/ListDetectorsCommand.ts index 4918bcebc7c6..ff992fe70972 100644 --- a/clients/client-iot-events-data/commands/ListDetectorsCommand.ts +++ b/clients/client-iot-events-data/commands/ListDetectorsCommand.ts @@ -22,6 +22,20 @@ export interface ListDetectorsCommandOutput extends ListDetectorsResponse, __Met /** *

Lists detectors (the instances of a detector model).

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { IoTEventsDataClient, ListDetectorsCommand } from "@aws-sdk/client-iot-events-data"; // ES Modules import + * // const { IoTEventsDataClient, ListDetectorsCommand } = require("@aws-sdk/client-iot-events-data"); // CommonJS import + * const client = new IoTEventsDataClient(config); + * const command = new ListDetectorsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListDetectorsCommandInput} for command's `input` shape. + * @see {@link ListDetectorsCommandOutput} for command's `response` shape. + * @see {@link IoTEventsDataClientResolvedConfig | config} for command's `input` shape. + * */ export class ListDetectorsCommand extends $Command< ListDetectorsCommandInput, diff --git a/clients/client-iot-events-data/models/models_0.ts b/clients/client-iot-events-data/models/models_0.ts index 908316fca585..0de761c9e169 100644 --- a/clients/client-iot-events-data/models/models_0.ts +++ b/clients/client-iot-events-data/models/models_0.ts @@ -24,6 +24,9 @@ export interface Message { } export namespace Message { + /** + * @internal + */ export const filterSensitiveLog = (obj: Message): any => ({ ...obj, }); @@ -39,6 +42,9 @@ export interface BatchPutMessageRequest { } export namespace BatchPutMessageRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: BatchPutMessageRequest): any => ({ ...obj, }); @@ -74,6 +80,9 @@ export interface BatchPutMessageErrorEntry { } export namespace BatchPutMessageErrorEntry { + /** + * @internal + */ export const filterSensitiveLog = (obj: BatchPutMessageErrorEntry): any => ({ ...obj, }); @@ -87,6 +96,9 @@ export interface BatchPutMessageResponse { } export namespace BatchPutMessageResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: BatchPutMessageResponse): any => ({ ...obj, }); @@ -105,6 +117,9 @@ export interface InternalFailureException extends __SmithyException, $MetadataBe } export namespace InternalFailureException { + /** + * @internal + */ export const filterSensitiveLog = (obj: InternalFailureException): any => ({ ...obj, }); @@ -123,6 +138,9 @@ export interface InvalidRequestException extends __SmithyException, $MetadataBea } export namespace InvalidRequestException { + /** + * @internal + */ export const filterSensitiveLog = (obj: InvalidRequestException): any => ({ ...obj, }); @@ -141,6 +159,9 @@ export interface ServiceUnavailableException extends __SmithyException, $Metadat } export namespace ServiceUnavailableException { + /** + * @internal + */ export const filterSensitiveLog = (obj: ServiceUnavailableException): any => ({ ...obj, }); @@ -159,6 +180,9 @@ export interface ThrottlingException extends __SmithyException, $MetadataBearer } export namespace ThrottlingException { + /** + * @internal + */ export const filterSensitiveLog = (obj: ThrottlingException): any => ({ ...obj, }); @@ -180,6 +204,9 @@ export interface TimerDefinition { } export namespace TimerDefinition { + /** + * @internal + */ export const filterSensitiveLog = (obj: TimerDefinition): any => ({ ...obj, }); @@ -201,6 +228,9 @@ export interface VariableDefinition { } export namespace VariableDefinition { + /** + * @internal + */ export const filterSensitiveLog = (obj: VariableDefinition): any => ({ ...obj, }); @@ -228,6 +258,9 @@ export interface DetectorStateDefinition { } export namespace DetectorStateDefinition { + /** + * @internal + */ export const filterSensitiveLog = (obj: DetectorStateDefinition): any => ({ ...obj, }); @@ -261,6 +294,9 @@ export interface UpdateDetectorRequest { } export namespace UpdateDetectorRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateDetectorRequest): any => ({ ...obj, }); @@ -274,6 +310,9 @@ export interface BatchUpdateDetectorRequest { } export namespace BatchUpdateDetectorRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: BatchUpdateDetectorRequest): any => ({ ...obj, }); @@ -301,6 +340,9 @@ export interface BatchUpdateDetectorErrorEntry { } export namespace BatchUpdateDetectorErrorEntry { + /** + * @internal + */ export const filterSensitiveLog = (obj: BatchUpdateDetectorErrorEntry): any => ({ ...obj, }); @@ -315,6 +357,9 @@ export interface BatchUpdateDetectorResponse { } export namespace BatchUpdateDetectorResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: BatchUpdateDetectorResponse): any => ({ ...obj, }); @@ -333,6 +378,9 @@ export interface DescribeDetectorRequest { } export namespace DescribeDetectorRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeDetectorRequest): any => ({ ...obj, }); @@ -354,6 +402,9 @@ export interface Timer { } export namespace Timer { + /** + * @internal + */ export const filterSensitiveLog = (obj: Timer): any => ({ ...obj, }); @@ -375,6 +426,9 @@ export interface Variable { } export namespace Variable { + /** + * @internal + */ export const filterSensitiveLog = (obj: Variable): any => ({ ...obj, }); @@ -401,6 +455,9 @@ export interface DetectorState { } export namespace DetectorState { + /** + * @internal + */ export const filterSensitiveLog = (obj: DetectorState): any => ({ ...obj, }); @@ -443,6 +500,9 @@ export interface Detector { } export namespace Detector { + /** + * @internal + */ export const filterSensitiveLog = (obj: Detector): any => ({ ...obj, }); @@ -456,6 +516,9 @@ export interface DescribeDetectorResponse { } export namespace DescribeDetectorResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeDetectorResponse): any => ({ ...obj, }); @@ -474,6 +537,9 @@ export interface ResourceNotFoundException extends __SmithyException, $MetadataB } export namespace ResourceNotFoundException { + /** + * @internal + */ export const filterSensitiveLog = (obj: ResourceNotFoundException): any => ({ ...obj, }); @@ -490,6 +556,9 @@ export interface DetectorStateSummary { } export namespace DetectorStateSummary { + /** + * @internal + */ export const filterSensitiveLog = (obj: DetectorStateSummary): any => ({ ...obj, }); @@ -532,6 +601,9 @@ export interface DetectorSummary { } export namespace DetectorSummary { + /** + * @internal + */ export const filterSensitiveLog = (obj: DetectorSummary): any => ({ ...obj, }); @@ -560,6 +632,9 @@ export interface ListDetectorsRequest { } export namespace ListDetectorsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListDetectorsRequest): any => ({ ...obj, }); @@ -579,6 +654,9 @@ export interface ListDetectorsResponse { } export namespace ListDetectorsResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListDetectorsResponse): any => ({ ...obj, }); diff --git a/clients/client-iot-events/commands/CreateDetectorModelCommand.ts b/clients/client-iot-events/commands/CreateDetectorModelCommand.ts index 2179170f2d2c..6961229c320f 100644 --- a/clients/client-iot-events/commands/CreateDetectorModelCommand.ts +++ b/clients/client-iot-events/commands/CreateDetectorModelCommand.ts @@ -22,6 +22,20 @@ export interface CreateDetectorModelCommandOutput extends CreateDetectorModelRes /** *

Creates a detector model.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { IoTEventsClient, CreateDetectorModelCommand } from "@aws-sdk/client-iot-events"; // ES Modules import + * // const { IoTEventsClient, CreateDetectorModelCommand } = require("@aws-sdk/client-iot-events"); // CommonJS import + * const client = new IoTEventsClient(config); + * const command = new CreateDetectorModelCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreateDetectorModelCommandInput} for command's `input` shape. + * @see {@link CreateDetectorModelCommandOutput} for command's `response` shape. + * @see {@link IoTEventsClientResolvedConfig | config} for command's `input` shape. + * */ export class CreateDetectorModelCommand extends $Command< CreateDetectorModelCommandInput, diff --git a/clients/client-iot-events/commands/CreateInputCommand.ts b/clients/client-iot-events/commands/CreateInputCommand.ts index 32ec7ae347fb..518cd37a5b8d 100644 --- a/clients/client-iot-events/commands/CreateInputCommand.ts +++ b/clients/client-iot-events/commands/CreateInputCommand.ts @@ -22,6 +22,20 @@ export interface CreateInputCommandOutput extends CreateInputResponse, __Metadat /** *

Creates an input.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { IoTEventsClient, CreateInputCommand } from "@aws-sdk/client-iot-events"; // ES Modules import + * // const { IoTEventsClient, CreateInputCommand } = require("@aws-sdk/client-iot-events"); // CommonJS import + * const client = new IoTEventsClient(config); + * const command = new CreateInputCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreateInputCommandInput} for command's `input` shape. + * @see {@link CreateInputCommandOutput} for command's `response` shape. + * @see {@link IoTEventsClientResolvedConfig | config} for command's `input` shape. + * */ export class CreateInputCommand extends $Command< CreateInputCommandInput, diff --git a/clients/client-iot-events/commands/DeleteDetectorModelCommand.ts b/clients/client-iot-events/commands/DeleteDetectorModelCommand.ts index be2a3e941c81..93030df0add2 100644 --- a/clients/client-iot-events/commands/DeleteDetectorModelCommand.ts +++ b/clients/client-iot-events/commands/DeleteDetectorModelCommand.ts @@ -23,6 +23,20 @@ export interface DeleteDetectorModelCommandOutput extends DeleteDetectorModelRes /** *

Deletes a detector model. Any active instances of the detector model are also * deleted.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { IoTEventsClient, DeleteDetectorModelCommand } from "@aws-sdk/client-iot-events"; // ES Modules import + * // const { IoTEventsClient, DeleteDetectorModelCommand } = require("@aws-sdk/client-iot-events"); // CommonJS import + * const client = new IoTEventsClient(config); + * const command = new DeleteDetectorModelCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteDetectorModelCommandInput} for command's `input` shape. + * @see {@link DeleteDetectorModelCommandOutput} for command's `response` shape. + * @see {@link IoTEventsClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteDetectorModelCommand extends $Command< DeleteDetectorModelCommandInput, diff --git a/clients/client-iot-events/commands/DeleteInputCommand.ts b/clients/client-iot-events/commands/DeleteInputCommand.ts index 5785b8488575..923c01d72e03 100644 --- a/clients/client-iot-events/commands/DeleteInputCommand.ts +++ b/clients/client-iot-events/commands/DeleteInputCommand.ts @@ -22,6 +22,20 @@ export interface DeleteInputCommandOutput extends DeleteInputResponse, __Metadat /** *

Deletes an input.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { IoTEventsClient, DeleteInputCommand } from "@aws-sdk/client-iot-events"; // ES Modules import + * // const { IoTEventsClient, DeleteInputCommand } = require("@aws-sdk/client-iot-events"); // CommonJS import + * const client = new IoTEventsClient(config); + * const command = new DeleteInputCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteInputCommandInput} for command's `input` shape. + * @see {@link DeleteInputCommandOutput} for command's `response` shape. + * @see {@link IoTEventsClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteInputCommand extends $Command< DeleteInputCommandInput, diff --git a/clients/client-iot-events/commands/DescribeDetectorModelAnalysisCommand.ts b/clients/client-iot-events/commands/DescribeDetectorModelAnalysisCommand.ts index 55023cbe0bc0..3ed2d210e640 100644 --- a/clients/client-iot-events/commands/DescribeDetectorModelAnalysisCommand.ts +++ b/clients/client-iot-events/commands/DescribeDetectorModelAnalysisCommand.ts @@ -24,6 +24,20 @@ export interface DescribeDetectorModelAnalysisCommandOutput /** *

Retrieves execution information about a detector model analysis

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { IoTEventsClient, DescribeDetectorModelAnalysisCommand } from "@aws-sdk/client-iot-events"; // ES Modules import + * // const { IoTEventsClient, DescribeDetectorModelAnalysisCommand } = require("@aws-sdk/client-iot-events"); // CommonJS import + * const client = new IoTEventsClient(config); + * const command = new DescribeDetectorModelAnalysisCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeDetectorModelAnalysisCommandInput} for command's `input` shape. + * @see {@link DescribeDetectorModelAnalysisCommandOutput} for command's `response` shape. + * @see {@link IoTEventsClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeDetectorModelAnalysisCommand extends $Command< DescribeDetectorModelAnalysisCommandInput, diff --git a/clients/client-iot-events/commands/DescribeDetectorModelCommand.ts b/clients/client-iot-events/commands/DescribeDetectorModelCommand.ts index d68e10787775..d5423921260a 100644 --- a/clients/client-iot-events/commands/DescribeDetectorModelCommand.ts +++ b/clients/client-iot-events/commands/DescribeDetectorModelCommand.ts @@ -23,6 +23,20 @@ export interface DescribeDetectorModelCommandOutput extends DescribeDetectorMode /** *

Describes a detector model. If the version parameter is not specified, * information about the latest version is returned.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { IoTEventsClient, DescribeDetectorModelCommand } from "@aws-sdk/client-iot-events"; // ES Modules import + * // const { IoTEventsClient, DescribeDetectorModelCommand } = require("@aws-sdk/client-iot-events"); // CommonJS import + * const client = new IoTEventsClient(config); + * const command = new DescribeDetectorModelCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeDetectorModelCommandInput} for command's `input` shape. + * @see {@link DescribeDetectorModelCommandOutput} for command's `response` shape. + * @see {@link IoTEventsClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeDetectorModelCommand extends $Command< DescribeDetectorModelCommandInput, diff --git a/clients/client-iot-events/commands/DescribeInputCommand.ts b/clients/client-iot-events/commands/DescribeInputCommand.ts index 0ccf9cf4ea5b..dc45d573e360 100644 --- a/clients/client-iot-events/commands/DescribeInputCommand.ts +++ b/clients/client-iot-events/commands/DescribeInputCommand.ts @@ -22,6 +22,20 @@ export interface DescribeInputCommandOutput extends DescribeInputResponse, __Met /** *

Describes an input.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { IoTEventsClient, DescribeInputCommand } from "@aws-sdk/client-iot-events"; // ES Modules import + * // const { IoTEventsClient, DescribeInputCommand } = require("@aws-sdk/client-iot-events"); // CommonJS import + * const client = new IoTEventsClient(config); + * const command = new DescribeInputCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeInputCommandInput} for command's `input` shape. + * @see {@link DescribeInputCommandOutput} for command's `response` shape. + * @see {@link IoTEventsClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeInputCommand extends $Command< DescribeInputCommandInput, diff --git a/clients/client-iot-events/commands/DescribeLoggingOptionsCommand.ts b/clients/client-iot-events/commands/DescribeLoggingOptionsCommand.ts index 8764220d4aa3..96e09ccf1970 100644 --- a/clients/client-iot-events/commands/DescribeLoggingOptionsCommand.ts +++ b/clients/client-iot-events/commands/DescribeLoggingOptionsCommand.ts @@ -22,6 +22,20 @@ export interface DescribeLoggingOptionsCommandOutput extends DescribeLoggingOpti /** *

Retrieves the current settings of the AWS IoT Events logging options.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { IoTEventsClient, DescribeLoggingOptionsCommand } from "@aws-sdk/client-iot-events"; // ES Modules import + * // const { IoTEventsClient, DescribeLoggingOptionsCommand } = require("@aws-sdk/client-iot-events"); // CommonJS import + * const client = new IoTEventsClient(config); + * const command = new DescribeLoggingOptionsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeLoggingOptionsCommandInput} for command's `input` shape. + * @see {@link DescribeLoggingOptionsCommandOutput} for command's `response` shape. + * @see {@link IoTEventsClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeLoggingOptionsCommand extends $Command< DescribeLoggingOptionsCommandInput, diff --git a/clients/client-iot-events/commands/GetDetectorModelAnalysisResultsCommand.ts b/clients/client-iot-events/commands/GetDetectorModelAnalysisResultsCommand.ts index 733d6c166c8d..5e8ffff910eb 100644 --- a/clients/client-iot-events/commands/GetDetectorModelAnalysisResultsCommand.ts +++ b/clients/client-iot-events/commands/GetDetectorModelAnalysisResultsCommand.ts @@ -24,6 +24,20 @@ export interface GetDetectorModelAnalysisResultsCommandOutput /** *

Retrieves one or more analysis results of the detector model.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { IoTEventsClient, GetDetectorModelAnalysisResultsCommand } from "@aws-sdk/client-iot-events"; // ES Modules import + * // const { IoTEventsClient, GetDetectorModelAnalysisResultsCommand } = require("@aws-sdk/client-iot-events"); // CommonJS import + * const client = new IoTEventsClient(config); + * const command = new GetDetectorModelAnalysisResultsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetDetectorModelAnalysisResultsCommandInput} for command's `input` shape. + * @see {@link GetDetectorModelAnalysisResultsCommandOutput} for command's `response` shape. + * @see {@link IoTEventsClientResolvedConfig | config} for command's `input` shape. + * */ export class GetDetectorModelAnalysisResultsCommand extends $Command< GetDetectorModelAnalysisResultsCommandInput, diff --git a/clients/client-iot-events/commands/ListDetectorModelVersionsCommand.ts b/clients/client-iot-events/commands/ListDetectorModelVersionsCommand.ts index ff2be8674a5f..433bbdb200c2 100644 --- a/clients/client-iot-events/commands/ListDetectorModelVersionsCommand.ts +++ b/clients/client-iot-events/commands/ListDetectorModelVersionsCommand.ts @@ -23,6 +23,20 @@ export interface ListDetectorModelVersionsCommandOutput extends ListDetectorMode /** *

Lists all the versions of a detector model. Only the metadata associated with each * detector model version is returned.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { IoTEventsClient, ListDetectorModelVersionsCommand } from "@aws-sdk/client-iot-events"; // ES Modules import + * // const { IoTEventsClient, ListDetectorModelVersionsCommand } = require("@aws-sdk/client-iot-events"); // CommonJS import + * const client = new IoTEventsClient(config); + * const command = new ListDetectorModelVersionsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListDetectorModelVersionsCommandInput} for command's `input` shape. + * @see {@link ListDetectorModelVersionsCommandOutput} for command's `response` shape. + * @see {@link IoTEventsClientResolvedConfig | config} for command's `input` shape. + * */ export class ListDetectorModelVersionsCommand extends $Command< ListDetectorModelVersionsCommandInput, diff --git a/clients/client-iot-events/commands/ListDetectorModelsCommand.ts b/clients/client-iot-events/commands/ListDetectorModelsCommand.ts index 79c52f4f8f5c..49886ac74609 100644 --- a/clients/client-iot-events/commands/ListDetectorModelsCommand.ts +++ b/clients/client-iot-events/commands/ListDetectorModelsCommand.ts @@ -23,6 +23,20 @@ export interface ListDetectorModelsCommandOutput extends ListDetectorModelsRespo /** *

Lists the detector models you have created. Only the metadata associated with each * detector model is returned.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { IoTEventsClient, ListDetectorModelsCommand } from "@aws-sdk/client-iot-events"; // ES Modules import + * // const { IoTEventsClient, ListDetectorModelsCommand } = require("@aws-sdk/client-iot-events"); // CommonJS import + * const client = new IoTEventsClient(config); + * const command = new ListDetectorModelsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListDetectorModelsCommandInput} for command's `input` shape. + * @see {@link ListDetectorModelsCommandOutput} for command's `response` shape. + * @see {@link IoTEventsClientResolvedConfig | config} for command's `input` shape. + * */ export class ListDetectorModelsCommand extends $Command< ListDetectorModelsCommandInput, diff --git a/clients/client-iot-events/commands/ListInputsCommand.ts b/clients/client-iot-events/commands/ListInputsCommand.ts index e74362d5f199..fe9a44ca3e36 100644 --- a/clients/client-iot-events/commands/ListInputsCommand.ts +++ b/clients/client-iot-events/commands/ListInputsCommand.ts @@ -22,6 +22,20 @@ export interface ListInputsCommandOutput extends ListInputsResponse, __MetadataB /** *

Lists the inputs you have created.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { IoTEventsClient, ListInputsCommand } from "@aws-sdk/client-iot-events"; // ES Modules import + * // const { IoTEventsClient, ListInputsCommand } = require("@aws-sdk/client-iot-events"); // CommonJS import + * const client = new IoTEventsClient(config); + * const command = new ListInputsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListInputsCommandInput} for command's `input` shape. + * @see {@link ListInputsCommandOutput} for command's `response` shape. + * @see {@link IoTEventsClientResolvedConfig | config} for command's `input` shape. + * */ export class ListInputsCommand extends $Command< ListInputsCommandInput, diff --git a/clients/client-iot-events/commands/ListTagsForResourceCommand.ts b/clients/client-iot-events/commands/ListTagsForResourceCommand.ts index 153807250030..787c016b0e89 100644 --- a/clients/client-iot-events/commands/ListTagsForResourceCommand.ts +++ b/clients/client-iot-events/commands/ListTagsForResourceCommand.ts @@ -22,6 +22,20 @@ export interface ListTagsForResourceCommandOutput extends ListTagsForResourceRes /** *

Lists the tags (metadata) you have assigned to the resource.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { IoTEventsClient, ListTagsForResourceCommand } from "@aws-sdk/client-iot-events"; // ES Modules import + * // const { IoTEventsClient, ListTagsForResourceCommand } = require("@aws-sdk/client-iot-events"); // CommonJS import + * const client = new IoTEventsClient(config); + * const command = new ListTagsForResourceCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListTagsForResourceCommandInput} for command's `input` shape. + * @see {@link ListTagsForResourceCommandOutput} for command's `response` shape. + * @see {@link IoTEventsClientResolvedConfig | config} for command's `input` shape. + * */ export class ListTagsForResourceCommand extends $Command< ListTagsForResourceCommandInput, diff --git a/clients/client-iot-events/commands/PutLoggingOptionsCommand.ts b/clients/client-iot-events/commands/PutLoggingOptionsCommand.ts index cae56706fef5..c6f177e8a249 100644 --- a/clients/client-iot-events/commands/PutLoggingOptionsCommand.ts +++ b/clients/client-iot-events/commands/PutLoggingOptionsCommand.ts @@ -26,6 +26,20 @@ export interface PutLoggingOptionsCommandOutput extends __MetadataBearer {} * 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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { IoTEventsClient, PutLoggingOptionsCommand } from "@aws-sdk/client-iot-events"; // ES Modules import + * // const { IoTEventsClient, PutLoggingOptionsCommand } = require("@aws-sdk/client-iot-events"); // CommonJS import + * const client = new IoTEventsClient(config); + * const command = new PutLoggingOptionsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link PutLoggingOptionsCommandInput} for command's `input` shape. + * @see {@link PutLoggingOptionsCommandOutput} for command's `response` shape. + * @see {@link IoTEventsClientResolvedConfig | config} for command's `input` shape. + * */ export class PutLoggingOptionsCommand extends $Command< PutLoggingOptionsCommandInput, diff --git a/clients/client-iot-events/commands/StartDetectorModelAnalysisCommand.ts b/clients/client-iot-events/commands/StartDetectorModelAnalysisCommand.ts index 8f1e17e47669..3a45fda79838 100644 --- a/clients/client-iot-events/commands/StartDetectorModelAnalysisCommand.ts +++ b/clients/client-iot-events/commands/StartDetectorModelAnalysisCommand.ts @@ -24,6 +24,20 @@ export interface StartDetectorModelAnalysisCommandOutput extends StartDetectorMo *

Performs an analysis of your detector model. For more information, * see Running detector model analyses * in the AWS IoT Events Developer Guide.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { IoTEventsClient, StartDetectorModelAnalysisCommand } from "@aws-sdk/client-iot-events"; // ES Modules import + * // const { IoTEventsClient, StartDetectorModelAnalysisCommand } = require("@aws-sdk/client-iot-events"); // CommonJS import + * const client = new IoTEventsClient(config); + * const command = new StartDetectorModelAnalysisCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link StartDetectorModelAnalysisCommandInput} for command's `input` shape. + * @see {@link StartDetectorModelAnalysisCommandOutput} for command's `response` shape. + * @see {@link IoTEventsClientResolvedConfig | config} for command's `input` shape. + * */ export class StartDetectorModelAnalysisCommand extends $Command< StartDetectorModelAnalysisCommandInput, diff --git a/clients/client-iot-events/commands/TagResourceCommand.ts b/clients/client-iot-events/commands/TagResourceCommand.ts index 4eadcc063391..dea7ca8fbf3a 100644 --- a/clients/client-iot-events/commands/TagResourceCommand.ts +++ b/clients/client-iot-events/commands/TagResourceCommand.ts @@ -23,6 +23,20 @@ export interface TagResourceCommandOutput extends TagResourceResponse, __Metadat /** *

Adds to or modifies the tags of the given resource. Tags are metadata that can be used to * manage a resource.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { IoTEventsClient, TagResourceCommand } from "@aws-sdk/client-iot-events"; // ES Modules import + * // const { IoTEventsClient, TagResourceCommand } = require("@aws-sdk/client-iot-events"); // CommonJS import + * const client = new IoTEventsClient(config); + * const command = new TagResourceCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link TagResourceCommandInput} for command's `input` shape. + * @see {@link TagResourceCommandOutput} for command's `response` shape. + * @see {@link IoTEventsClientResolvedConfig | config} for command's `input` shape. + * */ export class TagResourceCommand extends $Command< TagResourceCommandInput, diff --git a/clients/client-iot-events/commands/UntagResourceCommand.ts b/clients/client-iot-events/commands/UntagResourceCommand.ts index e7f47437eb09..9b5e654d3ffa 100644 --- a/clients/client-iot-events/commands/UntagResourceCommand.ts +++ b/clients/client-iot-events/commands/UntagResourceCommand.ts @@ -22,6 +22,20 @@ export interface UntagResourceCommandOutput extends UntagResourceResponse, __Met /** *

Removes the given tags (metadata) from the resource.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { IoTEventsClient, UntagResourceCommand } from "@aws-sdk/client-iot-events"; // ES Modules import + * // const { IoTEventsClient, UntagResourceCommand } = require("@aws-sdk/client-iot-events"); // CommonJS import + * const client = new IoTEventsClient(config); + * const command = new UntagResourceCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link UntagResourceCommandInput} for command's `input` shape. + * @see {@link UntagResourceCommandOutput} for command's `response` shape. + * @see {@link IoTEventsClientResolvedConfig | config} for command's `input` shape. + * */ export class UntagResourceCommand extends $Command< UntagResourceCommandInput, diff --git a/clients/client-iot-events/commands/UpdateDetectorModelCommand.ts b/clients/client-iot-events/commands/UpdateDetectorModelCommand.ts index db6574de80eb..20757829a114 100644 --- a/clients/client-iot-events/commands/UpdateDetectorModelCommand.ts +++ b/clients/client-iot-events/commands/UpdateDetectorModelCommand.ts @@ -23,6 +23,20 @@ export interface UpdateDetectorModelCommandOutput extends UpdateDetectorModelRes /** *

Updates a detector model. Detectors (instances) spawned by the previous version are * deleted and then re-created as new inputs arrive.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { IoTEventsClient, UpdateDetectorModelCommand } from "@aws-sdk/client-iot-events"; // ES Modules import + * // const { IoTEventsClient, UpdateDetectorModelCommand } = require("@aws-sdk/client-iot-events"); // CommonJS import + * const client = new IoTEventsClient(config); + * const command = new UpdateDetectorModelCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link UpdateDetectorModelCommandInput} for command's `input` shape. + * @see {@link UpdateDetectorModelCommandOutput} for command's `response` shape. + * @see {@link IoTEventsClientResolvedConfig | config} for command's `input` shape. + * */ export class UpdateDetectorModelCommand extends $Command< UpdateDetectorModelCommandInput, diff --git a/clients/client-iot-events/commands/UpdateInputCommand.ts b/clients/client-iot-events/commands/UpdateInputCommand.ts index a94fae32886f..5c0c22863550 100644 --- a/clients/client-iot-events/commands/UpdateInputCommand.ts +++ b/clients/client-iot-events/commands/UpdateInputCommand.ts @@ -22,6 +22,20 @@ export interface UpdateInputCommandOutput extends UpdateInputResponse, __Metadat /** *

Updates an input.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { IoTEventsClient, UpdateInputCommand } from "@aws-sdk/client-iot-events"; // ES Modules import + * // const { IoTEventsClient, UpdateInputCommand } = require("@aws-sdk/client-iot-events"); // CommonJS import + * const client = new IoTEventsClient(config); + * const command = new UpdateInputCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link UpdateInputCommandInput} for command's `input` shape. + * @see {@link UpdateInputCommandOutput} for command's `response` shape. + * @see {@link IoTEventsClientResolvedConfig | config} for command's `input` shape. + * */ export class UpdateInputCommand extends $Command< UpdateInputCommandInput, diff --git a/clients/client-iot-events/models/models_0.ts b/clients/client-iot-events/models/models_0.ts index 040f80abeeed..6b574b92856e 100644 --- a/clients/client-iot-events/models/models_0.ts +++ b/clients/client-iot-events/models/models_0.ts @@ -12,6 +12,9 @@ export interface ClearTimerAction { } export namespace ClearTimerAction { + /** + * @internal + */ export const filterSensitiveLog = (obj: ClearTimerAction): any => ({ ...obj, }); @@ -47,6 +50,9 @@ export interface Payload { } export namespace Payload { + /** + * @internal + */ export const filterSensitiveLog = (obj: Payload): any => ({ ...obj, }); @@ -211,6 +217,9 @@ export interface DynamoDBAction { } export namespace DynamoDBAction { + /** + * @internal + */ export const filterSensitiveLog = (obj: DynamoDBAction): any => ({ ...obj, }); @@ -282,6 +291,9 @@ export interface DynamoDBv2Action { } export namespace DynamoDBv2Action { + /** + * @internal + */ export const filterSensitiveLog = (obj: DynamoDBv2Action): any => ({ ...obj, }); @@ -312,6 +324,9 @@ export interface FirehoseAction { } export namespace FirehoseAction { + /** + * @internal + */ export const filterSensitiveLog = (obj: FirehoseAction): any => ({ ...obj, }); @@ -334,6 +349,9 @@ export interface IotEventsAction { } export namespace IotEventsAction { + /** + * @internal + */ export const filterSensitiveLog = (obj: IotEventsAction): any => ({ ...obj, }); @@ -387,6 +405,9 @@ export interface AssetPropertyTimestamp { } export namespace AssetPropertyTimestamp { + /** + * @internal + */ export const filterSensitiveLog = (obj: AssetPropertyTimestamp): any => ({ ...obj, }); @@ -457,6 +478,9 @@ export interface AssetPropertyVariant { } export namespace AssetPropertyVariant { + /** + * @internal + */ export const filterSensitiveLog = (obj: AssetPropertyVariant): any => ({ ...obj, }); @@ -505,6 +529,9 @@ export interface AssetPropertyValue { } export namespace AssetPropertyValue { + /** + * @internal + */ export const filterSensitiveLog = (obj: AssetPropertyValue): any => ({ ...obj, }); @@ -578,6 +605,9 @@ export interface IotSiteWiseAction { } export namespace IotSiteWiseAction { + /** + * @internal + */ export const filterSensitiveLog = (obj: IotSiteWiseAction): any => ({ ...obj, }); @@ -602,6 +632,9 @@ export interface IotTopicPublishAction { } export namespace IotTopicPublishAction { + /** + * @internal + */ export const filterSensitiveLog = (obj: IotTopicPublishAction): any => ({ ...obj, }); @@ -624,6 +657,9 @@ export interface LambdaAction { } export namespace LambdaAction { + /** + * @internal + */ export const filterSensitiveLog = (obj: LambdaAction): any => ({ ...obj, }); @@ -642,6 +678,9 @@ export interface ResetTimerAction { } export namespace ResetTimerAction { + /** + * @internal + */ export const filterSensitiveLog = (obj: ResetTimerAction): any => ({ ...obj, }); @@ -675,6 +714,9 @@ export interface SetTimerAction { } export namespace SetTimerAction { + /** + * @internal + */ export const filterSensitiveLog = (obj: SetTimerAction): any => ({ ...obj, }); @@ -696,6 +738,9 @@ export interface SetVariableAction { } export namespace SetVariableAction { + /** + * @internal + */ export const filterSensitiveLog = (obj: SetVariableAction): any => ({ ...obj, }); @@ -718,6 +763,9 @@ export interface SNSTopicPublishAction { } export namespace SNSTopicPublishAction { + /** + * @internal + */ export const filterSensitiveLog = (obj: SNSTopicPublishAction): any => ({ ...obj, }); @@ -747,6 +795,9 @@ export interface SqsAction { } export namespace SqsAction { + /** + * @internal + */ export const filterSensitiveLog = (obj: SqsAction): any => ({ ...obj, }); @@ -838,6 +889,9 @@ export interface Action { } export namespace Action { + /** + * @internal + */ export const filterSensitiveLog = (obj: Action): any => ({ ...obj, }); @@ -861,6 +915,9 @@ export interface AnalysisResultLocation { } export namespace AnalysisResultLocation { + /** + * @internal + */ export const filterSensitiveLog = (obj: AnalysisResultLocation): any => ({ ...obj, }); @@ -947,6 +1004,9 @@ export interface AnalysisResult { } export namespace AnalysisResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: AnalysisResult): any => ({ ...obj, }); @@ -978,6 +1038,9 @@ export interface Attribute { } export namespace Attribute { + /** + * @internal + */ export const filterSensitiveLog = (obj: Attribute): any => ({ ...obj, }); @@ -1007,6 +1070,9 @@ export interface Event { } export namespace Event { + /** + * @internal + */ export const filterSensitiveLog = (obj: Event): any => ({ ...obj, }); @@ -1025,6 +1091,9 @@ export interface OnEnterLifecycle { } export namespace OnEnterLifecycle { + /** + * @internal + */ export const filterSensitiveLog = (obj: OnEnterLifecycle): any => ({ ...obj, }); @@ -1043,6 +1112,9 @@ export interface OnExitLifecycle { } export namespace OnExitLifecycle { + /** + * @internal + */ export const filterSensitiveLog = (obj: OnExitLifecycle): any => ({ ...obj, }); @@ -1076,6 +1148,9 @@ export interface TransitionEvent { } export namespace TransitionEvent { + /** + * @internal + */ export const filterSensitiveLog = (obj: TransitionEvent): any => ({ ...obj, }); @@ -1098,6 +1173,9 @@ export interface OnInputLifecycle { } export namespace OnInputLifecycle { + /** + * @internal + */ export const filterSensitiveLog = (obj: OnInputLifecycle): any => ({ ...obj, }); @@ -1132,6 +1210,9 @@ export interface State { } export namespace State { + /** + * @internal + */ export const filterSensitiveLog = (obj: State): any => ({ ...obj, }); @@ -1153,6 +1234,9 @@ export interface DetectorModelDefinition { } export namespace DetectorModelDefinition { + /** + * @internal + */ export const filterSensitiveLog = (obj: DetectorModelDefinition): any => ({ ...obj, }); @@ -1179,6 +1263,9 @@ export interface Tag { } export namespace Tag { + /** + * @internal + */ export const filterSensitiveLog = (obj: Tag): any => ({ ...obj, }); @@ -1227,6 +1314,9 @@ export interface CreateDetectorModelRequest { } export namespace CreateDetectorModelRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateDetectorModelRequest): any => ({ ...obj, }); @@ -1305,6 +1395,9 @@ export interface DetectorModelConfiguration { } export namespace DetectorModelConfiguration { + /** + * @internal + */ export const filterSensitiveLog = (obj: DetectorModelConfiguration): any => ({ ...obj, }); @@ -1318,6 +1411,9 @@ export interface CreateDetectorModelResponse { } export namespace CreateDetectorModelResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateDetectorModelResponse): any => ({ ...obj, }); @@ -1336,6 +1432,9 @@ export interface InternalFailureException extends __SmithyException, $MetadataBe } export namespace InternalFailureException { + /** + * @internal + */ export const filterSensitiveLog = (obj: InternalFailureException): any => ({ ...obj, }); @@ -1354,6 +1453,9 @@ export interface InvalidRequestException extends __SmithyException, $MetadataBea } export namespace InvalidRequestException { + /** + * @internal + */ export const filterSensitiveLog = (obj: InvalidRequestException): any => ({ ...obj, }); @@ -1372,6 +1474,9 @@ export interface LimitExceededException extends __SmithyException, $MetadataBear } export namespace LimitExceededException { + /** + * @internal + */ export const filterSensitiveLog = (obj: LimitExceededException): any => ({ ...obj, }); @@ -1400,6 +1505,9 @@ export interface ResourceAlreadyExistsException extends __SmithyException, $Meta } export namespace ResourceAlreadyExistsException { + /** + * @internal + */ export const filterSensitiveLog = (obj: ResourceAlreadyExistsException): any => ({ ...obj, }); @@ -1418,6 +1526,9 @@ export interface ResourceInUseException extends __SmithyException, $MetadataBear } export namespace ResourceInUseException { + /** + * @internal + */ export const filterSensitiveLog = (obj: ResourceInUseException): any => ({ ...obj, }); @@ -1436,6 +1547,9 @@ export interface ServiceUnavailableException extends __SmithyException, $Metadat } export namespace ServiceUnavailableException { + /** + * @internal + */ export const filterSensitiveLog = (obj: ServiceUnavailableException): any => ({ ...obj, }); @@ -1454,6 +1568,9 @@ export interface ThrottlingException extends __SmithyException, $MetadataBearer } export namespace ThrottlingException { + /** + * @internal + */ export const filterSensitiveLog = (obj: ThrottlingException): any => ({ ...obj, }); @@ -1474,6 +1591,9 @@ export interface InputDefinition { } export namespace InputDefinition { + /** + * @internal + */ export const filterSensitiveLog = (obj: InputDefinition): any => ({ ...obj, }); @@ -1502,6 +1622,9 @@ export interface CreateInputRequest { } export namespace CreateInputRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateInputRequest): any => ({ ...obj, }); @@ -1550,6 +1673,9 @@ export interface InputConfiguration { } export namespace InputConfiguration { + /** + * @internal + */ export const filterSensitiveLog = (obj: InputConfiguration): any => ({ ...obj, }); @@ -1563,6 +1689,9 @@ export interface CreateInputResponse { } export namespace CreateInputResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateInputResponse): any => ({ ...obj, }); @@ -1576,6 +1705,9 @@ export interface DeleteDetectorModelRequest { } export namespace DeleteDetectorModelRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteDetectorModelRequest): any => ({ ...obj, }); @@ -1584,6 +1716,9 @@ export namespace DeleteDetectorModelRequest { export interface DeleteDetectorModelResponse {} export namespace DeleteDetectorModelResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteDetectorModelResponse): any => ({ ...obj, }); @@ -1602,6 +1737,9 @@ export interface ResourceNotFoundException extends __SmithyException, $MetadataB } export namespace ResourceNotFoundException { + /** + * @internal + */ export const filterSensitiveLog = (obj: ResourceNotFoundException): any => ({ ...obj, }); @@ -1615,6 +1753,9 @@ export interface DeleteInputRequest { } export namespace DeleteInputRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteInputRequest): any => ({ ...obj, }); @@ -1623,6 +1764,9 @@ export namespace DeleteInputRequest { export interface DeleteInputResponse {} export namespace DeleteInputResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteInputResponse): any => ({ ...obj, }); @@ -1641,6 +1785,9 @@ export interface DescribeDetectorModelRequest { } export namespace DescribeDetectorModelRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeDetectorModelRequest): any => ({ ...obj, }); @@ -1662,6 +1809,9 @@ export interface DetectorModel { } export namespace DetectorModel { + /** + * @internal + */ export const filterSensitiveLog = (obj: DetectorModel): any => ({ ...obj, }); @@ -1675,6 +1825,9 @@ export interface DescribeDetectorModelResponse { } export namespace DescribeDetectorModelResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeDetectorModelResponse): any => ({ ...obj, }); @@ -1688,6 +1841,9 @@ export interface DescribeDetectorModelAnalysisRequest { } export namespace DescribeDetectorModelAnalysisRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeDetectorModelAnalysisRequest): any => ({ ...obj, }); @@ -1715,6 +1871,9 @@ export interface DescribeDetectorModelAnalysisResponse { } export namespace DescribeDetectorModelAnalysisResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeDetectorModelAnalysisResponse): any => ({ ...obj, }); @@ -1728,6 +1887,9 @@ export interface DescribeInputRequest { } export namespace DescribeInputRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeInputRequest): any => ({ ...obj, }); @@ -1749,6 +1911,9 @@ export interface Input { } export namespace Input { + /** + * @internal + */ export const filterSensitiveLog = (obj: Input): any => ({ ...obj, }); @@ -1762,6 +1927,9 @@ export interface DescribeInputResponse { } export namespace DescribeInputResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeInputResponse): any => ({ ...obj, }); @@ -1770,6 +1938,9 @@ export namespace DescribeInputResponse { export interface DescribeLoggingOptionsRequest {} export namespace DescribeLoggingOptionsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeLoggingOptionsRequest): any => ({ ...obj, }); @@ -1793,6 +1964,9 @@ export interface DetectorDebugOption { } export namespace DetectorDebugOption { + /** + * @internal + */ export const filterSensitiveLog = (obj: DetectorDebugOption): any => ({ ...obj, }); @@ -1831,6 +2005,9 @@ export interface LoggingOptions { } export namespace LoggingOptions { + /** + * @internal + */ export const filterSensitiveLog = (obj: LoggingOptions): any => ({ ...obj, }); @@ -1844,6 +2021,9 @@ export interface DescribeLoggingOptionsResponse { } export namespace DescribeLoggingOptionsResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeLoggingOptionsResponse): any => ({ ...obj, }); @@ -1862,6 +2042,9 @@ export interface UnsupportedOperationException extends __SmithyException, $Metad } export namespace UnsupportedOperationException { + /** + * @internal + */ export const filterSensitiveLog = (obj: UnsupportedOperationException): any => ({ ...obj, }); @@ -1888,6 +2071,9 @@ export interface DetectorModelSummary { } export namespace DetectorModelSummary { + /** + * @internal + */ export const filterSensitiveLog = (obj: DetectorModelSummary): any => ({ ...obj, }); @@ -1940,6 +2126,9 @@ export interface DetectorModelVersionSummary { } export namespace DetectorModelVersionSummary { + /** + * @internal + */ export const filterSensitiveLog = (obj: DetectorModelVersionSummary): any => ({ ...obj, }); @@ -1963,6 +2152,9 @@ export interface GetDetectorModelAnalysisResultsRequest { } export namespace GetDetectorModelAnalysisResultsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetDetectorModelAnalysisResultsRequest): any => ({ ...obj, }); @@ -1982,6 +2174,9 @@ export interface GetDetectorModelAnalysisResultsResponse { } export namespace GetDetectorModelAnalysisResultsResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetDetectorModelAnalysisResultsResponse): any => ({ ...obj, }); @@ -2023,6 +2218,9 @@ export interface InputSummary { } export namespace InputSummary { + /** + * @internal + */ export const filterSensitiveLog = (obj: InputSummary): any => ({ ...obj, }); @@ -2041,6 +2239,9 @@ export interface ListDetectorModelsRequest { } export namespace ListDetectorModelsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListDetectorModelsRequest): any => ({ ...obj, }); @@ -2060,6 +2261,9 @@ export interface ListDetectorModelsResponse { } export namespace ListDetectorModelsResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListDetectorModelsResponse): any => ({ ...obj, }); @@ -2083,6 +2287,9 @@ export interface ListDetectorModelVersionsRequest { } export namespace ListDetectorModelVersionsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListDetectorModelVersionsRequest): any => ({ ...obj, }); @@ -2102,6 +2309,9 @@ export interface ListDetectorModelVersionsResponse { } export namespace ListDetectorModelVersionsResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListDetectorModelVersionsResponse): any => ({ ...obj, }); @@ -2120,6 +2330,9 @@ export interface ListInputsRequest { } export namespace ListInputsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListInputsRequest): any => ({ ...obj, }); @@ -2139,6 +2352,9 @@ export interface ListInputsResponse { } export namespace ListInputsResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListInputsResponse): any => ({ ...obj, }); @@ -2152,6 +2368,9 @@ export interface ListTagsForResourceRequest { } export namespace ListTagsForResourceRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListTagsForResourceRequest): any => ({ ...obj, }); @@ -2165,6 +2384,9 @@ export interface ListTagsForResourceResponse { } export namespace ListTagsForResourceResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListTagsForResourceResponse): any => ({ ...obj, }); @@ -2178,6 +2400,9 @@ export interface PutLoggingOptionsRequest { } export namespace PutLoggingOptionsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: PutLoggingOptionsRequest): any => ({ ...obj, }); @@ -2191,6 +2416,9 @@ export interface StartDetectorModelAnalysisRequest { } export namespace StartDetectorModelAnalysisRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: StartDetectorModelAnalysisRequest): any => ({ ...obj, }); @@ -2204,6 +2432,9 @@ export interface StartDetectorModelAnalysisResponse { } export namespace StartDetectorModelAnalysisResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: StartDetectorModelAnalysisResponse): any => ({ ...obj, }); @@ -2222,6 +2453,9 @@ export interface TagResourceRequest { } export namespace TagResourceRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: TagResourceRequest): any => ({ ...obj, }); @@ -2230,6 +2464,9 @@ export namespace TagResourceRequest { export interface TagResourceResponse {} export namespace TagResourceResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: TagResourceResponse): any => ({ ...obj, }); @@ -2248,6 +2485,9 @@ export interface UntagResourceRequest { } export namespace UntagResourceRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: UntagResourceRequest): any => ({ ...obj, }); @@ -2256,6 +2496,9 @@ export namespace UntagResourceRequest { export interface UntagResourceResponse {} export namespace UntagResourceResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: UntagResourceResponse): any => ({ ...obj, }); @@ -2290,6 +2533,9 @@ export interface UpdateDetectorModelRequest { } export namespace UpdateDetectorModelRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateDetectorModelRequest): any => ({ ...obj, }); @@ -2303,6 +2549,9 @@ export interface UpdateDetectorModelResponse { } export namespace UpdateDetectorModelResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateDetectorModelResponse): any => ({ ...obj, }); @@ -2326,6 +2575,9 @@ export interface UpdateInputRequest { } export namespace UpdateInputRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateInputRequest): any => ({ ...obj, }); @@ -2339,6 +2591,9 @@ export interface UpdateInputResponse { } export namespace UpdateInputResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateInputResponse): any => ({ ...obj, }); diff --git a/clients/client-iot-jobs-data-plane/commands/DescribeJobExecutionCommand.ts b/clients/client-iot-jobs-data-plane/commands/DescribeJobExecutionCommand.ts index 5438a8f4686a..e7411f337e48 100644 --- a/clients/client-iot-jobs-data-plane/commands/DescribeJobExecutionCommand.ts +++ b/clients/client-iot-jobs-data-plane/commands/DescribeJobExecutionCommand.ts @@ -22,6 +22,20 @@ export interface DescribeJobExecutionCommandOutput extends DescribeJobExecutionR /** *

Gets details of a job execution.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { IoTJobsDataPlaneClient, DescribeJobExecutionCommand } from "@aws-sdk/client-iot-jobs-data-plane"; // ES Modules import + * // const { IoTJobsDataPlaneClient, DescribeJobExecutionCommand } = require("@aws-sdk/client-iot-jobs-data-plane"); // CommonJS import + * const client = new IoTJobsDataPlaneClient(config); + * const command = new DescribeJobExecutionCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeJobExecutionCommandInput} for command's `input` shape. + * @see {@link DescribeJobExecutionCommandOutput} for command's `response` shape. + * @see {@link IoTJobsDataPlaneClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeJobExecutionCommand extends $Command< DescribeJobExecutionCommandInput, diff --git a/clients/client-iot-jobs-data-plane/commands/GetPendingJobExecutionsCommand.ts b/clients/client-iot-jobs-data-plane/commands/GetPendingJobExecutionsCommand.ts index 8cdde0c674c4..51e32f91a4f3 100644 --- a/clients/client-iot-jobs-data-plane/commands/GetPendingJobExecutionsCommand.ts +++ b/clients/client-iot-jobs-data-plane/commands/GetPendingJobExecutionsCommand.ts @@ -22,6 +22,20 @@ export interface GetPendingJobExecutionsCommandOutput extends GetPendingJobExecu /** *

Gets the list of all jobs for a thing that are not in a terminal status.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { IoTJobsDataPlaneClient, GetPendingJobExecutionsCommand } from "@aws-sdk/client-iot-jobs-data-plane"; // ES Modules import + * // const { IoTJobsDataPlaneClient, GetPendingJobExecutionsCommand } = require("@aws-sdk/client-iot-jobs-data-plane"); // CommonJS import + * const client = new IoTJobsDataPlaneClient(config); + * const command = new GetPendingJobExecutionsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetPendingJobExecutionsCommandInput} for command's `input` shape. + * @see {@link GetPendingJobExecutionsCommandOutput} for command's `response` shape. + * @see {@link IoTJobsDataPlaneClientResolvedConfig | config} for command's `input` shape. + * */ export class GetPendingJobExecutionsCommand extends $Command< GetPendingJobExecutionsCommandInput, diff --git a/clients/client-iot-jobs-data-plane/commands/StartNextPendingJobExecutionCommand.ts b/clients/client-iot-jobs-data-plane/commands/StartNextPendingJobExecutionCommand.ts index 6e1bd4718158..ba56dd8386bf 100644 --- a/clients/client-iot-jobs-data-plane/commands/StartNextPendingJobExecutionCommand.ts +++ b/clients/client-iot-jobs-data-plane/commands/StartNextPendingJobExecutionCommand.ts @@ -24,6 +24,20 @@ export interface StartNextPendingJobExecutionCommandOutput /** *

Gets and starts the next pending (status IN_PROGRESS or QUEUED) job execution for a thing.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { IoTJobsDataPlaneClient, StartNextPendingJobExecutionCommand } from "@aws-sdk/client-iot-jobs-data-plane"; // ES Modules import + * // const { IoTJobsDataPlaneClient, StartNextPendingJobExecutionCommand } = require("@aws-sdk/client-iot-jobs-data-plane"); // CommonJS import + * const client = new IoTJobsDataPlaneClient(config); + * const command = new StartNextPendingJobExecutionCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link StartNextPendingJobExecutionCommandInput} for command's `input` shape. + * @see {@link StartNextPendingJobExecutionCommandOutput} for command's `response` shape. + * @see {@link IoTJobsDataPlaneClientResolvedConfig | config} for command's `input` shape. + * */ export class StartNextPendingJobExecutionCommand extends $Command< StartNextPendingJobExecutionCommandInput, diff --git a/clients/client-iot-jobs-data-plane/commands/UpdateJobExecutionCommand.ts b/clients/client-iot-jobs-data-plane/commands/UpdateJobExecutionCommand.ts index 077a057b420a..c6c5261e8b51 100644 --- a/clients/client-iot-jobs-data-plane/commands/UpdateJobExecutionCommand.ts +++ b/clients/client-iot-jobs-data-plane/commands/UpdateJobExecutionCommand.ts @@ -22,6 +22,20 @@ export interface UpdateJobExecutionCommandOutput extends UpdateJobExecutionRespo /** *

Updates the status of a job execution.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { IoTJobsDataPlaneClient, UpdateJobExecutionCommand } from "@aws-sdk/client-iot-jobs-data-plane"; // ES Modules import + * // const { IoTJobsDataPlaneClient, UpdateJobExecutionCommand } = require("@aws-sdk/client-iot-jobs-data-plane"); // CommonJS import + * const client = new IoTJobsDataPlaneClient(config); + * const command = new UpdateJobExecutionCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link UpdateJobExecutionCommandInput} for command's `input` shape. + * @see {@link UpdateJobExecutionCommandOutput} for command's `response` shape. + * @see {@link IoTJobsDataPlaneClientResolvedConfig | config} for command's `input` shape. + * */ export class UpdateJobExecutionCommand extends $Command< UpdateJobExecutionCommandInput, diff --git a/clients/client-iot-jobs-data-plane/models/models_0.ts b/clients/client-iot-jobs-data-plane/models/models_0.ts index 3decb4d5afca..b3055f997a4f 100644 --- a/clients/client-iot-jobs-data-plane/models/models_0.ts +++ b/clients/client-iot-jobs-data-plane/models/models_0.ts @@ -14,6 +14,9 @@ export interface CertificateValidationException extends __SmithyException, $Meta } export namespace CertificateValidationException { + /** + * @internal + */ export const filterSensitiveLog = (obj: CertificateValidationException): any => ({ ...obj, }); @@ -43,6 +46,9 @@ export interface DescribeJobExecutionRequest { } export namespace DescribeJobExecutionRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeJobExecutionRequest): any => ({ ...obj, }); @@ -124,6 +130,9 @@ export interface JobExecution { } export namespace JobExecution { + /** + * @internal + */ export const filterSensitiveLog = (obj: JobExecution): any => ({ ...obj, }); @@ -137,6 +146,9 @@ export interface DescribeJobExecutionResponse { } export namespace DescribeJobExecutionResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeJobExecutionResponse): any => ({ ...obj, }); @@ -155,6 +167,9 @@ export interface InvalidRequestException extends __SmithyException, $MetadataBea } export namespace InvalidRequestException { + /** + * @internal + */ export const filterSensitiveLog = (obj: InvalidRequestException): any => ({ ...obj, }); @@ -173,6 +188,9 @@ export interface ResourceNotFoundException extends __SmithyException, $MetadataB } export namespace ResourceNotFoundException { + /** + * @internal + */ export const filterSensitiveLog = (obj: ResourceNotFoundException): any => ({ ...obj, }); @@ -191,6 +209,9 @@ export interface ServiceUnavailableException extends __SmithyException, $Metadat } export namespace ServiceUnavailableException { + /** + * @internal + */ export const filterSensitiveLog = (obj: ServiceUnavailableException): any => ({ ...obj, }); @@ -206,6 +227,9 @@ export interface TerminalStateException extends __SmithyException, $MetadataBear } export namespace TerminalStateException { + /** + * @internal + */ export const filterSensitiveLog = (obj: TerminalStateException): any => ({ ...obj, }); @@ -229,6 +253,9 @@ export interface ThrottlingException extends __SmithyException, $MetadataBearer } export namespace ThrottlingException { + /** + * @internal + */ export const filterSensitiveLog = (obj: ThrottlingException): any => ({ ...obj, }); @@ -242,6 +269,9 @@ export interface GetPendingJobExecutionsRequest { } export namespace GetPendingJobExecutionsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetPendingJobExecutionsRequest): any => ({ ...obj, }); @@ -284,6 +314,9 @@ export interface JobExecutionSummary { } export namespace JobExecutionSummary { + /** + * @internal + */ export const filterSensitiveLog = (obj: JobExecutionSummary): any => ({ ...obj, }); @@ -302,6 +335,9 @@ export interface GetPendingJobExecutionsResponse { } export namespace GetPendingJobExecutionsResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetPendingJobExecutionsResponse): any => ({ ...obj, }); @@ -319,6 +355,9 @@ export interface InvalidStateTransitionException extends __SmithyException, $Met } export namespace InvalidStateTransitionException { + /** + * @internal + */ export const filterSensitiveLog = (obj: InvalidStateTransitionException): any => ({ ...obj, }); @@ -349,6 +388,9 @@ export interface StartNextPendingJobExecutionRequest { } export namespace StartNextPendingJobExecutionRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: StartNextPendingJobExecutionRequest): any => ({ ...obj, }); @@ -362,6 +404,9 @@ export interface StartNextPendingJobExecutionResponse { } export namespace StartNextPendingJobExecutionResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: StartNextPendingJobExecutionResponse): any => ({ ...obj, }); @@ -428,6 +473,9 @@ export interface UpdateJobExecutionRequest { } export namespace UpdateJobExecutionRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateJobExecutionRequest): any => ({ ...obj, }); @@ -456,6 +504,9 @@ export interface JobExecutionState { } export namespace JobExecutionState { + /** + * @internal + */ export const filterSensitiveLog = (obj: JobExecutionState): any => ({ ...obj, }); @@ -474,6 +525,9 @@ export interface UpdateJobExecutionResponse { } export namespace UpdateJobExecutionResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateJobExecutionResponse): any => ({ ...obj, }); diff --git a/clients/client-iot-wireless/commands/AssociateAwsAccountWithPartnerAccountCommand.ts b/clients/client-iot-wireless/commands/AssociateAwsAccountWithPartnerAccountCommand.ts index 1a2f47055e55..3b3c3a78a26f 100644 --- a/clients/client-iot-wireless/commands/AssociateAwsAccountWithPartnerAccountCommand.ts +++ b/clients/client-iot-wireless/commands/AssociateAwsAccountWithPartnerAccountCommand.ts @@ -28,6 +28,20 @@ export interface AssociateAwsAccountWithPartnerAccountCommandOutput /** *

Associates a partner account with your AWS account.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { IoTWirelessClient, AssociateAwsAccountWithPartnerAccountCommand } from "@aws-sdk/client-iot-wireless"; // ES Modules import + * // const { IoTWirelessClient, AssociateAwsAccountWithPartnerAccountCommand } = require("@aws-sdk/client-iot-wireless"); // CommonJS import + * const client = new IoTWirelessClient(config); + * const command = new AssociateAwsAccountWithPartnerAccountCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link AssociateAwsAccountWithPartnerAccountCommandInput} for command's `input` shape. + * @see {@link AssociateAwsAccountWithPartnerAccountCommandOutput} for command's `response` shape. + * @see {@link IoTWirelessClientResolvedConfig | config} for command's `input` shape. + * */ export class AssociateAwsAccountWithPartnerAccountCommand extends $Command< AssociateAwsAccountWithPartnerAccountCommandInput, diff --git a/clients/client-iot-wireless/commands/AssociateWirelessDeviceWithThingCommand.ts b/clients/client-iot-wireless/commands/AssociateWirelessDeviceWithThingCommand.ts index b75fb09fc3c1..aed4fe9e6f63 100644 --- a/clients/client-iot-wireless/commands/AssociateWirelessDeviceWithThingCommand.ts +++ b/clients/client-iot-wireless/commands/AssociateWirelessDeviceWithThingCommand.ts @@ -24,6 +24,20 @@ export interface AssociateWirelessDeviceWithThingCommandOutput /** *

Associates a wireless device with a thing.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { IoTWirelessClient, AssociateWirelessDeviceWithThingCommand } from "@aws-sdk/client-iot-wireless"; // ES Modules import + * // const { IoTWirelessClient, AssociateWirelessDeviceWithThingCommand } = require("@aws-sdk/client-iot-wireless"); // CommonJS import + * const client = new IoTWirelessClient(config); + * const command = new AssociateWirelessDeviceWithThingCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link AssociateWirelessDeviceWithThingCommandInput} for command's `input` shape. + * @see {@link AssociateWirelessDeviceWithThingCommandOutput} for command's `response` shape. + * @see {@link IoTWirelessClientResolvedConfig | config} for command's `input` shape. + * */ export class AssociateWirelessDeviceWithThingCommand extends $Command< AssociateWirelessDeviceWithThingCommandInput, diff --git a/clients/client-iot-wireless/commands/AssociateWirelessGatewayWithCertificateCommand.ts b/clients/client-iot-wireless/commands/AssociateWirelessGatewayWithCertificateCommand.ts index 739efc180f73..3c03b922ddb6 100644 --- a/clients/client-iot-wireless/commands/AssociateWirelessGatewayWithCertificateCommand.ts +++ b/clients/client-iot-wireless/commands/AssociateWirelessGatewayWithCertificateCommand.ts @@ -28,6 +28,20 @@ export interface AssociateWirelessGatewayWithCertificateCommandOutput /** *

Associates a wireless gateway with a certificate.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { IoTWirelessClient, AssociateWirelessGatewayWithCertificateCommand } from "@aws-sdk/client-iot-wireless"; // ES Modules import + * // const { IoTWirelessClient, AssociateWirelessGatewayWithCertificateCommand } = require("@aws-sdk/client-iot-wireless"); // CommonJS import + * const client = new IoTWirelessClient(config); + * const command = new AssociateWirelessGatewayWithCertificateCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link AssociateWirelessGatewayWithCertificateCommandInput} for command's `input` shape. + * @see {@link AssociateWirelessGatewayWithCertificateCommandOutput} for command's `response` shape. + * @see {@link IoTWirelessClientResolvedConfig | config} for command's `input` shape. + * */ export class AssociateWirelessGatewayWithCertificateCommand extends $Command< AssociateWirelessGatewayWithCertificateCommandInput, diff --git a/clients/client-iot-wireless/commands/AssociateWirelessGatewayWithThingCommand.ts b/clients/client-iot-wireless/commands/AssociateWirelessGatewayWithThingCommand.ts index c01b66784308..1a7bebb85a5a 100644 --- a/clients/client-iot-wireless/commands/AssociateWirelessGatewayWithThingCommand.ts +++ b/clients/client-iot-wireless/commands/AssociateWirelessGatewayWithThingCommand.ts @@ -27,6 +27,20 @@ export interface AssociateWirelessGatewayWithThingCommandOutput /** *

Associates a wireless gateway with a thing.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { IoTWirelessClient, AssociateWirelessGatewayWithThingCommand } from "@aws-sdk/client-iot-wireless"; // ES Modules import + * // const { IoTWirelessClient, AssociateWirelessGatewayWithThingCommand } = require("@aws-sdk/client-iot-wireless"); // CommonJS import + * const client = new IoTWirelessClient(config); + * const command = new AssociateWirelessGatewayWithThingCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link AssociateWirelessGatewayWithThingCommandInput} for command's `input` shape. + * @see {@link AssociateWirelessGatewayWithThingCommandOutput} for command's `response` shape. + * @see {@link IoTWirelessClientResolvedConfig | config} for command's `input` shape. + * */ export class AssociateWirelessGatewayWithThingCommand extends $Command< AssociateWirelessGatewayWithThingCommandInput, diff --git a/clients/client-iot-wireless/commands/CreateDestinationCommand.ts b/clients/client-iot-wireless/commands/CreateDestinationCommand.ts index 824d49fb37c7..79b5d227e073 100644 --- a/clients/client-iot-wireless/commands/CreateDestinationCommand.ts +++ b/clients/client-iot-wireless/commands/CreateDestinationCommand.ts @@ -22,6 +22,20 @@ export interface CreateDestinationCommandOutput extends CreateDestinationRespons /** *

Creates a new destination that maps a device message to an AWS IoT rule.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { IoTWirelessClient, CreateDestinationCommand } from "@aws-sdk/client-iot-wireless"; // ES Modules import + * // const { IoTWirelessClient, CreateDestinationCommand } = require("@aws-sdk/client-iot-wireless"); // CommonJS import + * const client = new IoTWirelessClient(config); + * const command = new CreateDestinationCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreateDestinationCommandInput} for command's `input` shape. + * @see {@link CreateDestinationCommandOutput} for command's `response` shape. + * @see {@link IoTWirelessClientResolvedConfig | config} for command's `input` shape. + * */ export class CreateDestinationCommand extends $Command< CreateDestinationCommandInput, diff --git a/clients/client-iot-wireless/commands/CreateDeviceProfileCommand.ts b/clients/client-iot-wireless/commands/CreateDeviceProfileCommand.ts index 6ea812583261..7ef04a1f8e81 100644 --- a/clients/client-iot-wireless/commands/CreateDeviceProfileCommand.ts +++ b/clients/client-iot-wireless/commands/CreateDeviceProfileCommand.ts @@ -22,6 +22,20 @@ export interface CreateDeviceProfileCommandOutput extends CreateDeviceProfileRes /** *

Creates a new device profile.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { IoTWirelessClient, CreateDeviceProfileCommand } from "@aws-sdk/client-iot-wireless"; // ES Modules import + * // const { IoTWirelessClient, CreateDeviceProfileCommand } = require("@aws-sdk/client-iot-wireless"); // CommonJS import + * const client = new IoTWirelessClient(config); + * const command = new CreateDeviceProfileCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreateDeviceProfileCommandInput} for command's `input` shape. + * @see {@link CreateDeviceProfileCommandOutput} for command's `response` shape. + * @see {@link IoTWirelessClientResolvedConfig | config} for command's `input` shape. + * */ export class CreateDeviceProfileCommand extends $Command< CreateDeviceProfileCommandInput, diff --git a/clients/client-iot-wireless/commands/CreateServiceProfileCommand.ts b/clients/client-iot-wireless/commands/CreateServiceProfileCommand.ts index bd818346d74a..9e39d0be7caf 100644 --- a/clients/client-iot-wireless/commands/CreateServiceProfileCommand.ts +++ b/clients/client-iot-wireless/commands/CreateServiceProfileCommand.ts @@ -22,6 +22,20 @@ export interface CreateServiceProfileCommandOutput extends CreateServiceProfileR /** *

Creates a new service profile.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { IoTWirelessClient, CreateServiceProfileCommand } from "@aws-sdk/client-iot-wireless"; // ES Modules import + * // const { IoTWirelessClient, CreateServiceProfileCommand } = require("@aws-sdk/client-iot-wireless"); // CommonJS import + * const client = new IoTWirelessClient(config); + * const command = new CreateServiceProfileCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreateServiceProfileCommandInput} for command's `input` shape. + * @see {@link CreateServiceProfileCommandOutput} for command's `response` shape. + * @see {@link IoTWirelessClientResolvedConfig | config} for command's `input` shape. + * */ export class CreateServiceProfileCommand extends $Command< CreateServiceProfileCommandInput, diff --git a/clients/client-iot-wireless/commands/CreateWirelessDeviceCommand.ts b/clients/client-iot-wireless/commands/CreateWirelessDeviceCommand.ts index 1b5a20197ea5..41c2874c7cb0 100644 --- a/clients/client-iot-wireless/commands/CreateWirelessDeviceCommand.ts +++ b/clients/client-iot-wireless/commands/CreateWirelessDeviceCommand.ts @@ -22,6 +22,20 @@ export interface CreateWirelessDeviceCommandOutput extends CreateWirelessDeviceR /** *

Provisions a wireless device.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { IoTWirelessClient, CreateWirelessDeviceCommand } from "@aws-sdk/client-iot-wireless"; // ES Modules import + * // const { IoTWirelessClient, CreateWirelessDeviceCommand } = require("@aws-sdk/client-iot-wireless"); // CommonJS import + * const client = new IoTWirelessClient(config); + * const command = new CreateWirelessDeviceCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreateWirelessDeviceCommandInput} for command's `input` shape. + * @see {@link CreateWirelessDeviceCommandOutput} for command's `response` shape. + * @see {@link IoTWirelessClientResolvedConfig | config} for command's `input` shape. + * */ export class CreateWirelessDeviceCommand extends $Command< CreateWirelessDeviceCommandInput, diff --git a/clients/client-iot-wireless/commands/CreateWirelessGatewayCommand.ts b/clients/client-iot-wireless/commands/CreateWirelessGatewayCommand.ts index 8e38fc957ad3..270a283ed78a 100644 --- a/clients/client-iot-wireless/commands/CreateWirelessGatewayCommand.ts +++ b/clients/client-iot-wireless/commands/CreateWirelessGatewayCommand.ts @@ -22,6 +22,20 @@ export interface CreateWirelessGatewayCommandOutput extends CreateWirelessGatewa /** *

Provisions a wireless gateway.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { IoTWirelessClient, CreateWirelessGatewayCommand } from "@aws-sdk/client-iot-wireless"; // ES Modules import + * // const { IoTWirelessClient, CreateWirelessGatewayCommand } = require("@aws-sdk/client-iot-wireless"); // CommonJS import + * const client = new IoTWirelessClient(config); + * const command = new CreateWirelessGatewayCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreateWirelessGatewayCommandInput} for command's `input` shape. + * @see {@link CreateWirelessGatewayCommandOutput} for command's `response` shape. + * @see {@link IoTWirelessClientResolvedConfig | config} for command's `input` shape. + * */ export class CreateWirelessGatewayCommand extends $Command< CreateWirelessGatewayCommandInput, diff --git a/clients/client-iot-wireless/commands/CreateWirelessGatewayTaskCommand.ts b/clients/client-iot-wireless/commands/CreateWirelessGatewayTaskCommand.ts index 8058f3bd8421..1b12af9d0490 100644 --- a/clients/client-iot-wireless/commands/CreateWirelessGatewayTaskCommand.ts +++ b/clients/client-iot-wireless/commands/CreateWirelessGatewayTaskCommand.ts @@ -22,6 +22,20 @@ export interface CreateWirelessGatewayTaskCommandOutput extends CreateWirelessGa /** *

Creates a task for a wireless gateway.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { IoTWirelessClient, CreateWirelessGatewayTaskCommand } from "@aws-sdk/client-iot-wireless"; // ES Modules import + * // const { IoTWirelessClient, CreateWirelessGatewayTaskCommand } = require("@aws-sdk/client-iot-wireless"); // CommonJS import + * const client = new IoTWirelessClient(config); + * const command = new CreateWirelessGatewayTaskCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreateWirelessGatewayTaskCommandInput} for command's `input` shape. + * @see {@link CreateWirelessGatewayTaskCommandOutput} for command's `response` shape. + * @see {@link IoTWirelessClientResolvedConfig | config} for command's `input` shape. + * */ export class CreateWirelessGatewayTaskCommand extends $Command< CreateWirelessGatewayTaskCommandInput, diff --git a/clients/client-iot-wireless/commands/CreateWirelessGatewayTaskDefinitionCommand.ts b/clients/client-iot-wireless/commands/CreateWirelessGatewayTaskDefinitionCommand.ts index bc8b8ea77741..935b537ff17f 100644 --- a/clients/client-iot-wireless/commands/CreateWirelessGatewayTaskDefinitionCommand.ts +++ b/clients/client-iot-wireless/commands/CreateWirelessGatewayTaskDefinitionCommand.ts @@ -27,6 +27,20 @@ export interface CreateWirelessGatewayTaskDefinitionCommandOutput /** *

Creates a gateway task definition.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { IoTWirelessClient, CreateWirelessGatewayTaskDefinitionCommand } from "@aws-sdk/client-iot-wireless"; // ES Modules import + * // const { IoTWirelessClient, CreateWirelessGatewayTaskDefinitionCommand } = require("@aws-sdk/client-iot-wireless"); // CommonJS import + * const client = new IoTWirelessClient(config); + * const command = new CreateWirelessGatewayTaskDefinitionCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreateWirelessGatewayTaskDefinitionCommandInput} for command's `input` shape. + * @see {@link CreateWirelessGatewayTaskDefinitionCommandOutput} for command's `response` shape. + * @see {@link IoTWirelessClientResolvedConfig | config} for command's `input` shape. + * */ export class CreateWirelessGatewayTaskDefinitionCommand extends $Command< CreateWirelessGatewayTaskDefinitionCommandInput, diff --git a/clients/client-iot-wireless/commands/DeleteDestinationCommand.ts b/clients/client-iot-wireless/commands/DeleteDestinationCommand.ts index c59d8a178545..6da89201cbad 100644 --- a/clients/client-iot-wireless/commands/DeleteDestinationCommand.ts +++ b/clients/client-iot-wireless/commands/DeleteDestinationCommand.ts @@ -22,6 +22,20 @@ export interface DeleteDestinationCommandOutput extends DeleteDestinationRespons /** *

Deletes a destination.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { IoTWirelessClient, DeleteDestinationCommand } from "@aws-sdk/client-iot-wireless"; // ES Modules import + * // const { IoTWirelessClient, DeleteDestinationCommand } = require("@aws-sdk/client-iot-wireless"); // CommonJS import + * const client = new IoTWirelessClient(config); + * const command = new DeleteDestinationCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteDestinationCommandInput} for command's `input` shape. + * @see {@link DeleteDestinationCommandOutput} for command's `response` shape. + * @see {@link IoTWirelessClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteDestinationCommand extends $Command< DeleteDestinationCommandInput, diff --git a/clients/client-iot-wireless/commands/DeleteDeviceProfileCommand.ts b/clients/client-iot-wireless/commands/DeleteDeviceProfileCommand.ts index b85f10a8762c..7b60ae5c4928 100644 --- a/clients/client-iot-wireless/commands/DeleteDeviceProfileCommand.ts +++ b/clients/client-iot-wireless/commands/DeleteDeviceProfileCommand.ts @@ -22,6 +22,20 @@ export interface DeleteDeviceProfileCommandOutput extends DeleteDeviceProfileRes /** *

Deletes a device profile.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { IoTWirelessClient, DeleteDeviceProfileCommand } from "@aws-sdk/client-iot-wireless"; // ES Modules import + * // const { IoTWirelessClient, DeleteDeviceProfileCommand } = require("@aws-sdk/client-iot-wireless"); // CommonJS import + * const client = new IoTWirelessClient(config); + * const command = new DeleteDeviceProfileCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteDeviceProfileCommandInput} for command's `input` shape. + * @see {@link DeleteDeviceProfileCommandOutput} for command's `response` shape. + * @see {@link IoTWirelessClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteDeviceProfileCommand extends $Command< DeleteDeviceProfileCommandInput, diff --git a/clients/client-iot-wireless/commands/DeleteServiceProfileCommand.ts b/clients/client-iot-wireless/commands/DeleteServiceProfileCommand.ts index ed2f5f7d0a74..59ca2239cf38 100644 --- a/clients/client-iot-wireless/commands/DeleteServiceProfileCommand.ts +++ b/clients/client-iot-wireless/commands/DeleteServiceProfileCommand.ts @@ -22,6 +22,20 @@ export interface DeleteServiceProfileCommandOutput extends DeleteServiceProfileR /** *

Deletes a service profile.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { IoTWirelessClient, DeleteServiceProfileCommand } from "@aws-sdk/client-iot-wireless"; // ES Modules import + * // const { IoTWirelessClient, DeleteServiceProfileCommand } = require("@aws-sdk/client-iot-wireless"); // CommonJS import + * const client = new IoTWirelessClient(config); + * const command = new DeleteServiceProfileCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteServiceProfileCommandInput} for command's `input` shape. + * @see {@link DeleteServiceProfileCommandOutput} for command's `response` shape. + * @see {@link IoTWirelessClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteServiceProfileCommand extends $Command< DeleteServiceProfileCommandInput, diff --git a/clients/client-iot-wireless/commands/DeleteWirelessDeviceCommand.ts b/clients/client-iot-wireless/commands/DeleteWirelessDeviceCommand.ts index 61c1054e1b11..3e47cfa32d60 100644 --- a/clients/client-iot-wireless/commands/DeleteWirelessDeviceCommand.ts +++ b/clients/client-iot-wireless/commands/DeleteWirelessDeviceCommand.ts @@ -22,6 +22,20 @@ export interface DeleteWirelessDeviceCommandOutput extends DeleteWirelessDeviceR /** *

Deletes a wireless device.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { IoTWirelessClient, DeleteWirelessDeviceCommand } from "@aws-sdk/client-iot-wireless"; // ES Modules import + * // const { IoTWirelessClient, DeleteWirelessDeviceCommand } = require("@aws-sdk/client-iot-wireless"); // CommonJS import + * const client = new IoTWirelessClient(config); + * const command = new DeleteWirelessDeviceCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteWirelessDeviceCommandInput} for command's `input` shape. + * @see {@link DeleteWirelessDeviceCommandOutput} for command's `response` shape. + * @see {@link IoTWirelessClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteWirelessDeviceCommand extends $Command< DeleteWirelessDeviceCommandInput, diff --git a/clients/client-iot-wireless/commands/DeleteWirelessGatewayCommand.ts b/clients/client-iot-wireless/commands/DeleteWirelessGatewayCommand.ts index ba78889bf516..23434729230e 100644 --- a/clients/client-iot-wireless/commands/DeleteWirelessGatewayCommand.ts +++ b/clients/client-iot-wireless/commands/DeleteWirelessGatewayCommand.ts @@ -22,6 +22,20 @@ export interface DeleteWirelessGatewayCommandOutput extends DeleteWirelessGatewa /** *

Deletes a wireless gateway.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { IoTWirelessClient, DeleteWirelessGatewayCommand } from "@aws-sdk/client-iot-wireless"; // ES Modules import + * // const { IoTWirelessClient, DeleteWirelessGatewayCommand } = require("@aws-sdk/client-iot-wireless"); // CommonJS import + * const client = new IoTWirelessClient(config); + * const command = new DeleteWirelessGatewayCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteWirelessGatewayCommandInput} for command's `input` shape. + * @see {@link DeleteWirelessGatewayCommandOutput} for command's `response` shape. + * @see {@link IoTWirelessClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteWirelessGatewayCommand extends $Command< DeleteWirelessGatewayCommandInput, diff --git a/clients/client-iot-wireless/commands/DeleteWirelessGatewayTaskCommand.ts b/clients/client-iot-wireless/commands/DeleteWirelessGatewayTaskCommand.ts index e3f9d0be4f36..271a3ee5255d 100644 --- a/clients/client-iot-wireless/commands/DeleteWirelessGatewayTaskCommand.ts +++ b/clients/client-iot-wireless/commands/DeleteWirelessGatewayTaskCommand.ts @@ -22,6 +22,20 @@ export interface DeleteWirelessGatewayTaskCommandOutput extends DeleteWirelessGa /** *

Deletes a wireless gateway task.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { IoTWirelessClient, DeleteWirelessGatewayTaskCommand } from "@aws-sdk/client-iot-wireless"; // ES Modules import + * // const { IoTWirelessClient, DeleteWirelessGatewayTaskCommand } = require("@aws-sdk/client-iot-wireless"); // CommonJS import + * const client = new IoTWirelessClient(config); + * const command = new DeleteWirelessGatewayTaskCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteWirelessGatewayTaskCommandInput} for command's `input` shape. + * @see {@link DeleteWirelessGatewayTaskCommandOutput} for command's `response` shape. + * @see {@link IoTWirelessClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteWirelessGatewayTaskCommand extends $Command< DeleteWirelessGatewayTaskCommandInput, diff --git a/clients/client-iot-wireless/commands/DeleteWirelessGatewayTaskDefinitionCommand.ts b/clients/client-iot-wireless/commands/DeleteWirelessGatewayTaskDefinitionCommand.ts index 9f05b036aae7..d572ae37b80f 100644 --- a/clients/client-iot-wireless/commands/DeleteWirelessGatewayTaskDefinitionCommand.ts +++ b/clients/client-iot-wireless/commands/DeleteWirelessGatewayTaskDefinitionCommand.ts @@ -27,6 +27,20 @@ export interface DeleteWirelessGatewayTaskDefinitionCommandOutput /** *

Deletes a wireless gateway task definition. Deleting this task definition does not affect tasks that are currently in progress.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { IoTWirelessClient, DeleteWirelessGatewayTaskDefinitionCommand } from "@aws-sdk/client-iot-wireless"; // ES Modules import + * // const { IoTWirelessClient, DeleteWirelessGatewayTaskDefinitionCommand } = require("@aws-sdk/client-iot-wireless"); // CommonJS import + * const client = new IoTWirelessClient(config); + * const command = new DeleteWirelessGatewayTaskDefinitionCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteWirelessGatewayTaskDefinitionCommandInput} for command's `input` shape. + * @see {@link DeleteWirelessGatewayTaskDefinitionCommandOutput} for command's `response` shape. + * @see {@link IoTWirelessClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteWirelessGatewayTaskDefinitionCommand extends $Command< DeleteWirelessGatewayTaskDefinitionCommandInput, diff --git a/clients/client-iot-wireless/commands/DisassociateAwsAccountFromPartnerAccountCommand.ts b/clients/client-iot-wireless/commands/DisassociateAwsAccountFromPartnerAccountCommand.ts index b7a1098dd8fc..b560c35bfdd4 100644 --- a/clients/client-iot-wireless/commands/DisassociateAwsAccountFromPartnerAccountCommand.ts +++ b/clients/client-iot-wireless/commands/DisassociateAwsAccountFromPartnerAccountCommand.ts @@ -28,6 +28,20 @@ export interface DisassociateAwsAccountFromPartnerAccountCommandOutput /** *

Disassociates your AWS account from a partner account. If PartnerAccountId and PartnerType are null, disassociates your AWS account from all partner accounts.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { IoTWirelessClient, DisassociateAwsAccountFromPartnerAccountCommand } from "@aws-sdk/client-iot-wireless"; // ES Modules import + * // const { IoTWirelessClient, DisassociateAwsAccountFromPartnerAccountCommand } = require("@aws-sdk/client-iot-wireless"); // CommonJS import + * const client = new IoTWirelessClient(config); + * const command = new DisassociateAwsAccountFromPartnerAccountCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DisassociateAwsAccountFromPartnerAccountCommandInput} for command's `input` shape. + * @see {@link DisassociateAwsAccountFromPartnerAccountCommandOutput} for command's `response` shape. + * @see {@link IoTWirelessClientResolvedConfig | config} for command's `input` shape. + * */ export class DisassociateAwsAccountFromPartnerAccountCommand extends $Command< DisassociateAwsAccountFromPartnerAccountCommandInput, diff --git a/clients/client-iot-wireless/commands/DisassociateWirelessDeviceFromThingCommand.ts b/clients/client-iot-wireless/commands/DisassociateWirelessDeviceFromThingCommand.ts index 0f1e72ffce51..b2c3ccd85330 100644 --- a/clients/client-iot-wireless/commands/DisassociateWirelessDeviceFromThingCommand.ts +++ b/clients/client-iot-wireless/commands/DisassociateWirelessDeviceFromThingCommand.ts @@ -27,6 +27,20 @@ export interface DisassociateWirelessDeviceFromThingCommandOutput /** *

Disassociates a wireless device from its currently associated thing.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { IoTWirelessClient, DisassociateWirelessDeviceFromThingCommand } from "@aws-sdk/client-iot-wireless"; // ES Modules import + * // const { IoTWirelessClient, DisassociateWirelessDeviceFromThingCommand } = require("@aws-sdk/client-iot-wireless"); // CommonJS import + * const client = new IoTWirelessClient(config); + * const command = new DisassociateWirelessDeviceFromThingCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DisassociateWirelessDeviceFromThingCommandInput} for command's `input` shape. + * @see {@link DisassociateWirelessDeviceFromThingCommandOutput} for command's `response` shape. + * @see {@link IoTWirelessClientResolvedConfig | config} for command's `input` shape. + * */ export class DisassociateWirelessDeviceFromThingCommand extends $Command< DisassociateWirelessDeviceFromThingCommandInput, diff --git a/clients/client-iot-wireless/commands/DisassociateWirelessGatewayFromCertificateCommand.ts b/clients/client-iot-wireless/commands/DisassociateWirelessGatewayFromCertificateCommand.ts index 4b032ec43362..1b6d15a6bebb 100644 --- a/clients/client-iot-wireless/commands/DisassociateWirelessGatewayFromCertificateCommand.ts +++ b/clients/client-iot-wireless/commands/DisassociateWirelessGatewayFromCertificateCommand.ts @@ -28,6 +28,20 @@ export interface DisassociateWirelessGatewayFromCertificateCommandOutput /** *

Disassociates a wireless gateway from its currently associated certificate.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { IoTWirelessClient, DisassociateWirelessGatewayFromCertificateCommand } from "@aws-sdk/client-iot-wireless"; // ES Modules import + * // const { IoTWirelessClient, DisassociateWirelessGatewayFromCertificateCommand } = require("@aws-sdk/client-iot-wireless"); // CommonJS import + * const client = new IoTWirelessClient(config); + * const command = new DisassociateWirelessGatewayFromCertificateCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DisassociateWirelessGatewayFromCertificateCommandInput} for command's `input` shape. + * @see {@link DisassociateWirelessGatewayFromCertificateCommandOutput} for command's `response` shape. + * @see {@link IoTWirelessClientResolvedConfig | config} for command's `input` shape. + * */ export class DisassociateWirelessGatewayFromCertificateCommand extends $Command< DisassociateWirelessGatewayFromCertificateCommandInput, diff --git a/clients/client-iot-wireless/commands/DisassociateWirelessGatewayFromThingCommand.ts b/clients/client-iot-wireless/commands/DisassociateWirelessGatewayFromThingCommand.ts index 7f92d52f1b03..777815759a05 100644 --- a/clients/client-iot-wireless/commands/DisassociateWirelessGatewayFromThingCommand.ts +++ b/clients/client-iot-wireless/commands/DisassociateWirelessGatewayFromThingCommand.ts @@ -27,6 +27,20 @@ export interface DisassociateWirelessGatewayFromThingCommandOutput /** *

Disassociates a wireless gateway from its currently associated thing.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { IoTWirelessClient, DisassociateWirelessGatewayFromThingCommand } from "@aws-sdk/client-iot-wireless"; // ES Modules import + * // const { IoTWirelessClient, DisassociateWirelessGatewayFromThingCommand } = require("@aws-sdk/client-iot-wireless"); // CommonJS import + * const client = new IoTWirelessClient(config); + * const command = new DisassociateWirelessGatewayFromThingCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DisassociateWirelessGatewayFromThingCommandInput} for command's `input` shape. + * @see {@link DisassociateWirelessGatewayFromThingCommandOutput} for command's `response` shape. + * @see {@link IoTWirelessClientResolvedConfig | config} for command's `input` shape. + * */ export class DisassociateWirelessGatewayFromThingCommand extends $Command< DisassociateWirelessGatewayFromThingCommandInput, diff --git a/clients/client-iot-wireless/commands/GetDestinationCommand.ts b/clients/client-iot-wireless/commands/GetDestinationCommand.ts index ff5af7db3d20..78a950acba94 100644 --- a/clients/client-iot-wireless/commands/GetDestinationCommand.ts +++ b/clients/client-iot-wireless/commands/GetDestinationCommand.ts @@ -22,6 +22,20 @@ export interface GetDestinationCommandOutput extends GetDestinationResponse, __M /** *

Gets information about a destination.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { IoTWirelessClient, GetDestinationCommand } from "@aws-sdk/client-iot-wireless"; // ES Modules import + * // const { IoTWirelessClient, GetDestinationCommand } = require("@aws-sdk/client-iot-wireless"); // CommonJS import + * const client = new IoTWirelessClient(config); + * const command = new GetDestinationCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetDestinationCommandInput} for command's `input` shape. + * @see {@link GetDestinationCommandOutput} for command's `response` shape. + * @see {@link IoTWirelessClientResolvedConfig | config} for command's `input` shape. + * */ export class GetDestinationCommand extends $Command< GetDestinationCommandInput, diff --git a/clients/client-iot-wireless/commands/GetDeviceProfileCommand.ts b/clients/client-iot-wireless/commands/GetDeviceProfileCommand.ts index 6848b033c09c..3c24100c600f 100644 --- a/clients/client-iot-wireless/commands/GetDeviceProfileCommand.ts +++ b/clients/client-iot-wireless/commands/GetDeviceProfileCommand.ts @@ -22,6 +22,20 @@ export interface GetDeviceProfileCommandOutput extends GetDeviceProfileResponse, /** *

Gets information about a device profile.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { IoTWirelessClient, GetDeviceProfileCommand } from "@aws-sdk/client-iot-wireless"; // ES Modules import + * // const { IoTWirelessClient, GetDeviceProfileCommand } = require("@aws-sdk/client-iot-wireless"); // CommonJS import + * const client = new IoTWirelessClient(config); + * const command = new GetDeviceProfileCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetDeviceProfileCommandInput} for command's `input` shape. + * @see {@link GetDeviceProfileCommandOutput} for command's `response` shape. + * @see {@link IoTWirelessClientResolvedConfig | config} for command's `input` shape. + * */ export class GetDeviceProfileCommand extends $Command< GetDeviceProfileCommandInput, diff --git a/clients/client-iot-wireless/commands/GetPartnerAccountCommand.ts b/clients/client-iot-wireless/commands/GetPartnerAccountCommand.ts index 7484721c2f1e..c0308d999217 100644 --- a/clients/client-iot-wireless/commands/GetPartnerAccountCommand.ts +++ b/clients/client-iot-wireless/commands/GetPartnerAccountCommand.ts @@ -22,6 +22,20 @@ export interface GetPartnerAccountCommandOutput extends GetPartnerAccountRespons /** *

Gets information about a partner account. If PartnerAccountId and PartnerType are null, returns all partner accounts.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { IoTWirelessClient, GetPartnerAccountCommand } from "@aws-sdk/client-iot-wireless"; // ES Modules import + * // const { IoTWirelessClient, GetPartnerAccountCommand } = require("@aws-sdk/client-iot-wireless"); // CommonJS import + * const client = new IoTWirelessClient(config); + * const command = new GetPartnerAccountCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetPartnerAccountCommandInput} for command's `input` shape. + * @see {@link GetPartnerAccountCommandOutput} for command's `response` shape. + * @see {@link IoTWirelessClientResolvedConfig | config} for command's `input` shape. + * */ export class GetPartnerAccountCommand extends $Command< GetPartnerAccountCommandInput, diff --git a/clients/client-iot-wireless/commands/GetServiceEndpointCommand.ts b/clients/client-iot-wireless/commands/GetServiceEndpointCommand.ts index bccaa6e372c5..84479cdc4209 100644 --- a/clients/client-iot-wireless/commands/GetServiceEndpointCommand.ts +++ b/clients/client-iot-wireless/commands/GetServiceEndpointCommand.ts @@ -22,6 +22,20 @@ export interface GetServiceEndpointCommandOutput extends GetServiceEndpointRespo /** *

Gets the account-specific endpoint for Configuration and Update Server (CUPS) protocol or LoRaWAN Network Server (LNS) connections.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { IoTWirelessClient, GetServiceEndpointCommand } from "@aws-sdk/client-iot-wireless"; // ES Modules import + * // const { IoTWirelessClient, GetServiceEndpointCommand } = require("@aws-sdk/client-iot-wireless"); // CommonJS import + * const client = new IoTWirelessClient(config); + * const command = new GetServiceEndpointCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetServiceEndpointCommandInput} for command's `input` shape. + * @see {@link GetServiceEndpointCommandOutput} for command's `response` shape. + * @see {@link IoTWirelessClientResolvedConfig | config} for command's `input` shape. + * */ export class GetServiceEndpointCommand extends $Command< GetServiceEndpointCommandInput, diff --git a/clients/client-iot-wireless/commands/GetServiceProfileCommand.ts b/clients/client-iot-wireless/commands/GetServiceProfileCommand.ts index 9c54bf3e3ce5..b070f9b6cb78 100644 --- a/clients/client-iot-wireless/commands/GetServiceProfileCommand.ts +++ b/clients/client-iot-wireless/commands/GetServiceProfileCommand.ts @@ -22,6 +22,20 @@ export interface GetServiceProfileCommandOutput extends GetServiceProfileRespons /** *

Gets information about a service profile.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { IoTWirelessClient, GetServiceProfileCommand } from "@aws-sdk/client-iot-wireless"; // ES Modules import + * // const { IoTWirelessClient, GetServiceProfileCommand } = require("@aws-sdk/client-iot-wireless"); // CommonJS import + * const client = new IoTWirelessClient(config); + * const command = new GetServiceProfileCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetServiceProfileCommandInput} for command's `input` shape. + * @see {@link GetServiceProfileCommandOutput} for command's `response` shape. + * @see {@link IoTWirelessClientResolvedConfig | config} for command's `input` shape. + * */ export class GetServiceProfileCommand extends $Command< GetServiceProfileCommandInput, diff --git a/clients/client-iot-wireless/commands/GetWirelessDeviceCommand.ts b/clients/client-iot-wireless/commands/GetWirelessDeviceCommand.ts index dac6caf5316b..4f9939b17dbf 100644 --- a/clients/client-iot-wireless/commands/GetWirelessDeviceCommand.ts +++ b/clients/client-iot-wireless/commands/GetWirelessDeviceCommand.ts @@ -22,6 +22,20 @@ export interface GetWirelessDeviceCommandOutput extends GetWirelessDeviceRespons /** *

Gets information about a wireless device.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { IoTWirelessClient, GetWirelessDeviceCommand } from "@aws-sdk/client-iot-wireless"; // ES Modules import + * // const { IoTWirelessClient, GetWirelessDeviceCommand } = require("@aws-sdk/client-iot-wireless"); // CommonJS import + * const client = new IoTWirelessClient(config); + * const command = new GetWirelessDeviceCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetWirelessDeviceCommandInput} for command's `input` shape. + * @see {@link GetWirelessDeviceCommandOutput} for command's `response` shape. + * @see {@link IoTWirelessClientResolvedConfig | config} for command's `input` shape. + * */ export class GetWirelessDeviceCommand extends $Command< GetWirelessDeviceCommandInput, diff --git a/clients/client-iot-wireless/commands/GetWirelessDeviceStatisticsCommand.ts b/clients/client-iot-wireless/commands/GetWirelessDeviceStatisticsCommand.ts index dab231ea24e3..b325fc7d4140 100644 --- a/clients/client-iot-wireless/commands/GetWirelessDeviceStatisticsCommand.ts +++ b/clients/client-iot-wireless/commands/GetWirelessDeviceStatisticsCommand.ts @@ -24,6 +24,20 @@ export interface GetWirelessDeviceStatisticsCommandOutput /** *

Gets operating information about a wireless device.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { IoTWirelessClient, GetWirelessDeviceStatisticsCommand } from "@aws-sdk/client-iot-wireless"; // ES Modules import + * // const { IoTWirelessClient, GetWirelessDeviceStatisticsCommand } = require("@aws-sdk/client-iot-wireless"); // CommonJS import + * const client = new IoTWirelessClient(config); + * const command = new GetWirelessDeviceStatisticsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetWirelessDeviceStatisticsCommandInput} for command's `input` shape. + * @see {@link GetWirelessDeviceStatisticsCommandOutput} for command's `response` shape. + * @see {@link IoTWirelessClientResolvedConfig | config} for command's `input` shape. + * */ export class GetWirelessDeviceStatisticsCommand extends $Command< GetWirelessDeviceStatisticsCommandInput, diff --git a/clients/client-iot-wireless/commands/GetWirelessGatewayCertificateCommand.ts b/clients/client-iot-wireless/commands/GetWirelessGatewayCertificateCommand.ts index 05f9f5eb3c35..77d5acc56018 100644 --- a/clients/client-iot-wireless/commands/GetWirelessGatewayCertificateCommand.ts +++ b/clients/client-iot-wireless/commands/GetWirelessGatewayCertificateCommand.ts @@ -24,6 +24,20 @@ export interface GetWirelessGatewayCertificateCommandOutput /** *

Gets the ID of the certificate that is currently associated with a wireless gateway.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { IoTWirelessClient, GetWirelessGatewayCertificateCommand } from "@aws-sdk/client-iot-wireless"; // ES Modules import + * // const { IoTWirelessClient, GetWirelessGatewayCertificateCommand } = require("@aws-sdk/client-iot-wireless"); // CommonJS import + * const client = new IoTWirelessClient(config); + * const command = new GetWirelessGatewayCertificateCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetWirelessGatewayCertificateCommandInput} for command's `input` shape. + * @see {@link GetWirelessGatewayCertificateCommandOutput} for command's `response` shape. + * @see {@link IoTWirelessClientResolvedConfig | config} for command's `input` shape. + * */ export class GetWirelessGatewayCertificateCommand extends $Command< GetWirelessGatewayCertificateCommandInput, diff --git a/clients/client-iot-wireless/commands/GetWirelessGatewayCommand.ts b/clients/client-iot-wireless/commands/GetWirelessGatewayCommand.ts index 89ea3e14bc82..ed703baafaef 100644 --- a/clients/client-iot-wireless/commands/GetWirelessGatewayCommand.ts +++ b/clients/client-iot-wireless/commands/GetWirelessGatewayCommand.ts @@ -22,6 +22,20 @@ export interface GetWirelessGatewayCommandOutput extends GetWirelessGatewayRespo /** *

Gets information about a wireless gateway.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { IoTWirelessClient, GetWirelessGatewayCommand } from "@aws-sdk/client-iot-wireless"; // ES Modules import + * // const { IoTWirelessClient, GetWirelessGatewayCommand } = require("@aws-sdk/client-iot-wireless"); // CommonJS import + * const client = new IoTWirelessClient(config); + * const command = new GetWirelessGatewayCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetWirelessGatewayCommandInput} for command's `input` shape. + * @see {@link GetWirelessGatewayCommandOutput} for command's `response` shape. + * @see {@link IoTWirelessClientResolvedConfig | config} for command's `input` shape. + * */ export class GetWirelessGatewayCommand extends $Command< GetWirelessGatewayCommandInput, diff --git a/clients/client-iot-wireless/commands/GetWirelessGatewayFirmwareInformationCommand.ts b/clients/client-iot-wireless/commands/GetWirelessGatewayFirmwareInformationCommand.ts index f873df79e58a..2cec119fe60d 100644 --- a/clients/client-iot-wireless/commands/GetWirelessGatewayFirmwareInformationCommand.ts +++ b/clients/client-iot-wireless/commands/GetWirelessGatewayFirmwareInformationCommand.ts @@ -28,6 +28,20 @@ export interface GetWirelessGatewayFirmwareInformationCommandOutput /** *

Gets the firmware version and other information about a wireless gateway.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { IoTWirelessClient, GetWirelessGatewayFirmwareInformationCommand } from "@aws-sdk/client-iot-wireless"; // ES Modules import + * // const { IoTWirelessClient, GetWirelessGatewayFirmwareInformationCommand } = require("@aws-sdk/client-iot-wireless"); // CommonJS import + * const client = new IoTWirelessClient(config); + * const command = new GetWirelessGatewayFirmwareInformationCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetWirelessGatewayFirmwareInformationCommandInput} for command's `input` shape. + * @see {@link GetWirelessGatewayFirmwareInformationCommandOutput} for command's `response` shape. + * @see {@link IoTWirelessClientResolvedConfig | config} for command's `input` shape. + * */ export class GetWirelessGatewayFirmwareInformationCommand extends $Command< GetWirelessGatewayFirmwareInformationCommandInput, diff --git a/clients/client-iot-wireless/commands/GetWirelessGatewayStatisticsCommand.ts b/clients/client-iot-wireless/commands/GetWirelessGatewayStatisticsCommand.ts index 608f341e0f13..5e136201376c 100644 --- a/clients/client-iot-wireless/commands/GetWirelessGatewayStatisticsCommand.ts +++ b/clients/client-iot-wireless/commands/GetWirelessGatewayStatisticsCommand.ts @@ -24,6 +24,20 @@ export interface GetWirelessGatewayStatisticsCommandOutput /** *

Gets operating information about a wireless gateway.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { IoTWirelessClient, GetWirelessGatewayStatisticsCommand } from "@aws-sdk/client-iot-wireless"; // ES Modules import + * // const { IoTWirelessClient, GetWirelessGatewayStatisticsCommand } = require("@aws-sdk/client-iot-wireless"); // CommonJS import + * const client = new IoTWirelessClient(config); + * const command = new GetWirelessGatewayStatisticsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetWirelessGatewayStatisticsCommandInput} for command's `input` shape. + * @see {@link GetWirelessGatewayStatisticsCommandOutput} for command's `response` shape. + * @see {@link IoTWirelessClientResolvedConfig | config} for command's `input` shape. + * */ export class GetWirelessGatewayStatisticsCommand extends $Command< GetWirelessGatewayStatisticsCommandInput, diff --git a/clients/client-iot-wireless/commands/GetWirelessGatewayTaskCommand.ts b/clients/client-iot-wireless/commands/GetWirelessGatewayTaskCommand.ts index 7c3afdd92225..b757ab4ee545 100644 --- a/clients/client-iot-wireless/commands/GetWirelessGatewayTaskCommand.ts +++ b/clients/client-iot-wireless/commands/GetWirelessGatewayTaskCommand.ts @@ -22,6 +22,20 @@ export interface GetWirelessGatewayTaskCommandOutput extends GetWirelessGatewayT /** *

Gets information about a wireless gateway task.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { IoTWirelessClient, GetWirelessGatewayTaskCommand } from "@aws-sdk/client-iot-wireless"; // ES Modules import + * // const { IoTWirelessClient, GetWirelessGatewayTaskCommand } = require("@aws-sdk/client-iot-wireless"); // CommonJS import + * const client = new IoTWirelessClient(config); + * const command = new GetWirelessGatewayTaskCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetWirelessGatewayTaskCommandInput} for command's `input` shape. + * @see {@link GetWirelessGatewayTaskCommandOutput} for command's `response` shape. + * @see {@link IoTWirelessClientResolvedConfig | config} for command's `input` shape. + * */ export class GetWirelessGatewayTaskCommand extends $Command< GetWirelessGatewayTaskCommandInput, diff --git a/clients/client-iot-wireless/commands/GetWirelessGatewayTaskDefinitionCommand.ts b/clients/client-iot-wireless/commands/GetWirelessGatewayTaskDefinitionCommand.ts index b4c2af546b4a..db61e0ed0c13 100644 --- a/clients/client-iot-wireless/commands/GetWirelessGatewayTaskDefinitionCommand.ts +++ b/clients/client-iot-wireless/commands/GetWirelessGatewayTaskDefinitionCommand.ts @@ -24,6 +24,20 @@ export interface GetWirelessGatewayTaskDefinitionCommandOutput /** *

Gets information about a wireless gateway task definition.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { IoTWirelessClient, GetWirelessGatewayTaskDefinitionCommand } from "@aws-sdk/client-iot-wireless"; // ES Modules import + * // const { IoTWirelessClient, GetWirelessGatewayTaskDefinitionCommand } = require("@aws-sdk/client-iot-wireless"); // CommonJS import + * const client = new IoTWirelessClient(config); + * const command = new GetWirelessGatewayTaskDefinitionCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetWirelessGatewayTaskDefinitionCommandInput} for command's `input` shape. + * @see {@link GetWirelessGatewayTaskDefinitionCommandOutput} for command's `response` shape. + * @see {@link IoTWirelessClientResolvedConfig | config} for command's `input` shape. + * */ export class GetWirelessGatewayTaskDefinitionCommand extends $Command< GetWirelessGatewayTaskDefinitionCommandInput, diff --git a/clients/client-iot-wireless/commands/ListDestinationsCommand.ts b/clients/client-iot-wireless/commands/ListDestinationsCommand.ts index 5e21a928923e..985f6e8cf70e 100644 --- a/clients/client-iot-wireless/commands/ListDestinationsCommand.ts +++ b/clients/client-iot-wireless/commands/ListDestinationsCommand.ts @@ -22,6 +22,20 @@ export interface ListDestinationsCommandOutput extends ListDestinationsResponse, /** *

Lists the destinations registered to your AWS account.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { IoTWirelessClient, ListDestinationsCommand } from "@aws-sdk/client-iot-wireless"; // ES Modules import + * // const { IoTWirelessClient, ListDestinationsCommand } = require("@aws-sdk/client-iot-wireless"); // CommonJS import + * const client = new IoTWirelessClient(config); + * const command = new ListDestinationsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListDestinationsCommandInput} for command's `input` shape. + * @see {@link ListDestinationsCommandOutput} for command's `response` shape. + * @see {@link IoTWirelessClientResolvedConfig | config} for command's `input` shape. + * */ export class ListDestinationsCommand extends $Command< ListDestinationsCommandInput, diff --git a/clients/client-iot-wireless/commands/ListDeviceProfilesCommand.ts b/clients/client-iot-wireless/commands/ListDeviceProfilesCommand.ts index 0554efe227e9..5d6f05e61a4f 100644 --- a/clients/client-iot-wireless/commands/ListDeviceProfilesCommand.ts +++ b/clients/client-iot-wireless/commands/ListDeviceProfilesCommand.ts @@ -22,6 +22,20 @@ export interface ListDeviceProfilesCommandOutput extends ListDeviceProfilesRespo /** *

Lists the device profiles registered to your AWS account.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { IoTWirelessClient, ListDeviceProfilesCommand } from "@aws-sdk/client-iot-wireless"; // ES Modules import + * // const { IoTWirelessClient, ListDeviceProfilesCommand } = require("@aws-sdk/client-iot-wireless"); // CommonJS import + * const client = new IoTWirelessClient(config); + * const command = new ListDeviceProfilesCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListDeviceProfilesCommandInput} for command's `input` shape. + * @see {@link ListDeviceProfilesCommandOutput} for command's `response` shape. + * @see {@link IoTWirelessClientResolvedConfig | config} for command's `input` shape. + * */ export class ListDeviceProfilesCommand extends $Command< ListDeviceProfilesCommandInput, diff --git a/clients/client-iot-wireless/commands/ListPartnerAccountsCommand.ts b/clients/client-iot-wireless/commands/ListPartnerAccountsCommand.ts index b4066d2e3e28..d9c36dda8338 100644 --- a/clients/client-iot-wireless/commands/ListPartnerAccountsCommand.ts +++ b/clients/client-iot-wireless/commands/ListPartnerAccountsCommand.ts @@ -22,6 +22,20 @@ export interface ListPartnerAccountsCommandOutput extends ListPartnerAccountsRes /** *

Lists the partner accounts associated with your AWS account.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { IoTWirelessClient, ListPartnerAccountsCommand } from "@aws-sdk/client-iot-wireless"; // ES Modules import + * // const { IoTWirelessClient, ListPartnerAccountsCommand } = require("@aws-sdk/client-iot-wireless"); // CommonJS import + * const client = new IoTWirelessClient(config); + * const command = new ListPartnerAccountsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListPartnerAccountsCommandInput} for command's `input` shape. + * @see {@link ListPartnerAccountsCommandOutput} for command's `response` shape. + * @see {@link IoTWirelessClientResolvedConfig | config} for command's `input` shape. + * */ export class ListPartnerAccountsCommand extends $Command< ListPartnerAccountsCommandInput, diff --git a/clients/client-iot-wireless/commands/ListServiceProfilesCommand.ts b/clients/client-iot-wireless/commands/ListServiceProfilesCommand.ts index 86229c229ff7..ab0a30eee815 100644 --- a/clients/client-iot-wireless/commands/ListServiceProfilesCommand.ts +++ b/clients/client-iot-wireless/commands/ListServiceProfilesCommand.ts @@ -22,6 +22,20 @@ export interface ListServiceProfilesCommandOutput extends ListServiceProfilesRes /** *

Lists the service profiles registered to your AWS account.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { IoTWirelessClient, ListServiceProfilesCommand } from "@aws-sdk/client-iot-wireless"; // ES Modules import + * // const { IoTWirelessClient, ListServiceProfilesCommand } = require("@aws-sdk/client-iot-wireless"); // CommonJS import + * const client = new IoTWirelessClient(config); + * const command = new ListServiceProfilesCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListServiceProfilesCommandInput} for command's `input` shape. + * @see {@link ListServiceProfilesCommandOutput} for command's `response` shape. + * @see {@link IoTWirelessClientResolvedConfig | config} for command's `input` shape. + * */ export class ListServiceProfilesCommand extends $Command< ListServiceProfilesCommandInput, diff --git a/clients/client-iot-wireless/commands/ListTagsForResourceCommand.ts b/clients/client-iot-wireless/commands/ListTagsForResourceCommand.ts index 6a6a05778693..da49a64ea403 100644 --- a/clients/client-iot-wireless/commands/ListTagsForResourceCommand.ts +++ b/clients/client-iot-wireless/commands/ListTagsForResourceCommand.ts @@ -22,6 +22,20 @@ export interface ListTagsForResourceCommandOutput extends ListTagsForResourceRes /** *

Lists the tags (metadata) you have assigned to the resource.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { IoTWirelessClient, ListTagsForResourceCommand } from "@aws-sdk/client-iot-wireless"; // ES Modules import + * // const { IoTWirelessClient, ListTagsForResourceCommand } = require("@aws-sdk/client-iot-wireless"); // CommonJS import + * const client = new IoTWirelessClient(config); + * const command = new ListTagsForResourceCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListTagsForResourceCommandInput} for command's `input` shape. + * @see {@link ListTagsForResourceCommandOutput} for command's `response` shape. + * @see {@link IoTWirelessClientResolvedConfig | config} for command's `input` shape. + * */ export class ListTagsForResourceCommand extends $Command< ListTagsForResourceCommandInput, diff --git a/clients/client-iot-wireless/commands/ListWirelessDevicesCommand.ts b/clients/client-iot-wireless/commands/ListWirelessDevicesCommand.ts index 7dd137c994e5..a2e27e386e72 100644 --- a/clients/client-iot-wireless/commands/ListWirelessDevicesCommand.ts +++ b/clients/client-iot-wireless/commands/ListWirelessDevicesCommand.ts @@ -22,6 +22,20 @@ export interface ListWirelessDevicesCommandOutput extends ListWirelessDevicesRes /** *

Lists the wireless devices registered to your AWS account.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { IoTWirelessClient, ListWirelessDevicesCommand } from "@aws-sdk/client-iot-wireless"; // ES Modules import + * // const { IoTWirelessClient, ListWirelessDevicesCommand } = require("@aws-sdk/client-iot-wireless"); // CommonJS import + * const client = new IoTWirelessClient(config); + * const command = new ListWirelessDevicesCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListWirelessDevicesCommandInput} for command's `input` shape. + * @see {@link ListWirelessDevicesCommandOutput} for command's `response` shape. + * @see {@link IoTWirelessClientResolvedConfig | config} for command's `input` shape. + * */ export class ListWirelessDevicesCommand extends $Command< ListWirelessDevicesCommandInput, diff --git a/clients/client-iot-wireless/commands/ListWirelessGatewayTaskDefinitionsCommand.ts b/clients/client-iot-wireless/commands/ListWirelessGatewayTaskDefinitionsCommand.ts index b8a5a961dbc9..9b881f9e35aa 100644 --- a/clients/client-iot-wireless/commands/ListWirelessGatewayTaskDefinitionsCommand.ts +++ b/clients/client-iot-wireless/commands/ListWirelessGatewayTaskDefinitionsCommand.ts @@ -27,6 +27,20 @@ export interface ListWirelessGatewayTaskDefinitionsCommandOutput /** *

List the wireless gateway tasks definitions registered to your AWS account.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { IoTWirelessClient, ListWirelessGatewayTaskDefinitionsCommand } from "@aws-sdk/client-iot-wireless"; // ES Modules import + * // const { IoTWirelessClient, ListWirelessGatewayTaskDefinitionsCommand } = require("@aws-sdk/client-iot-wireless"); // CommonJS import + * const client = new IoTWirelessClient(config); + * const command = new ListWirelessGatewayTaskDefinitionsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListWirelessGatewayTaskDefinitionsCommandInput} for command's `input` shape. + * @see {@link ListWirelessGatewayTaskDefinitionsCommandOutput} for command's `response` shape. + * @see {@link IoTWirelessClientResolvedConfig | config} for command's `input` shape. + * */ export class ListWirelessGatewayTaskDefinitionsCommand extends $Command< ListWirelessGatewayTaskDefinitionsCommandInput, diff --git a/clients/client-iot-wireless/commands/ListWirelessGatewaysCommand.ts b/clients/client-iot-wireless/commands/ListWirelessGatewaysCommand.ts index da63a4b03ebb..f9e219eefaa9 100644 --- a/clients/client-iot-wireless/commands/ListWirelessGatewaysCommand.ts +++ b/clients/client-iot-wireless/commands/ListWirelessGatewaysCommand.ts @@ -22,6 +22,20 @@ export interface ListWirelessGatewaysCommandOutput extends ListWirelessGatewaysR /** *

Lists the wireless gateways registered to your AWS account.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { IoTWirelessClient, ListWirelessGatewaysCommand } from "@aws-sdk/client-iot-wireless"; // ES Modules import + * // const { IoTWirelessClient, ListWirelessGatewaysCommand } = require("@aws-sdk/client-iot-wireless"); // CommonJS import + * const client = new IoTWirelessClient(config); + * const command = new ListWirelessGatewaysCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListWirelessGatewaysCommandInput} for command's `input` shape. + * @see {@link ListWirelessGatewaysCommandOutput} for command's `response` shape. + * @see {@link IoTWirelessClientResolvedConfig | config} for command's `input` shape. + * */ export class ListWirelessGatewaysCommand extends $Command< ListWirelessGatewaysCommandInput, diff --git a/clients/client-iot-wireless/commands/SendDataToWirelessDeviceCommand.ts b/clients/client-iot-wireless/commands/SendDataToWirelessDeviceCommand.ts index 100417fa7a52..cd6bbbdbf0ca 100644 --- a/clients/client-iot-wireless/commands/SendDataToWirelessDeviceCommand.ts +++ b/clients/client-iot-wireless/commands/SendDataToWirelessDeviceCommand.ts @@ -22,6 +22,20 @@ export interface SendDataToWirelessDeviceCommandOutput extends SendDataToWireles /** *

Sends a decrypted application data frame to a device.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { IoTWirelessClient, SendDataToWirelessDeviceCommand } from "@aws-sdk/client-iot-wireless"; // ES Modules import + * // const { IoTWirelessClient, SendDataToWirelessDeviceCommand } = require("@aws-sdk/client-iot-wireless"); // CommonJS import + * const client = new IoTWirelessClient(config); + * const command = new SendDataToWirelessDeviceCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link SendDataToWirelessDeviceCommandInput} for command's `input` shape. + * @see {@link SendDataToWirelessDeviceCommandOutput} for command's `response` shape. + * @see {@link IoTWirelessClientResolvedConfig | config} for command's `input` shape. + * */ export class SendDataToWirelessDeviceCommand extends $Command< SendDataToWirelessDeviceCommandInput, diff --git a/clients/client-iot-wireless/commands/TagResourceCommand.ts b/clients/client-iot-wireless/commands/TagResourceCommand.ts index 46d225b4650f..edaada2755fa 100644 --- a/clients/client-iot-wireless/commands/TagResourceCommand.ts +++ b/clients/client-iot-wireless/commands/TagResourceCommand.ts @@ -22,6 +22,20 @@ export interface TagResourceCommandOutput extends TagResourceResponse, __Metadat /** *

Adds a tag to a resource.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { IoTWirelessClient, TagResourceCommand } from "@aws-sdk/client-iot-wireless"; // ES Modules import + * // const { IoTWirelessClient, TagResourceCommand } = require("@aws-sdk/client-iot-wireless"); // CommonJS import + * const client = new IoTWirelessClient(config); + * const command = new TagResourceCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link TagResourceCommandInput} for command's `input` shape. + * @see {@link TagResourceCommandOutput} for command's `response` shape. + * @see {@link IoTWirelessClientResolvedConfig | config} for command's `input` shape. + * */ export class TagResourceCommand extends $Command< TagResourceCommandInput, diff --git a/clients/client-iot-wireless/commands/TestWirelessDeviceCommand.ts b/clients/client-iot-wireless/commands/TestWirelessDeviceCommand.ts index b6d9ca506688..ca9e91ca2feb 100644 --- a/clients/client-iot-wireless/commands/TestWirelessDeviceCommand.ts +++ b/clients/client-iot-wireless/commands/TestWirelessDeviceCommand.ts @@ -22,6 +22,20 @@ export interface TestWirelessDeviceCommandOutput extends TestWirelessDeviceRespo /** *

Simulates a provisioned device by sending an uplink data payload of Hello.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { IoTWirelessClient, TestWirelessDeviceCommand } from "@aws-sdk/client-iot-wireless"; // ES Modules import + * // const { IoTWirelessClient, TestWirelessDeviceCommand } = require("@aws-sdk/client-iot-wireless"); // CommonJS import + * const client = new IoTWirelessClient(config); + * const command = new TestWirelessDeviceCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link TestWirelessDeviceCommandInput} for command's `input` shape. + * @see {@link TestWirelessDeviceCommandOutput} for command's `response` shape. + * @see {@link IoTWirelessClientResolvedConfig | config} for command's `input` shape. + * */ export class TestWirelessDeviceCommand extends $Command< TestWirelessDeviceCommandInput, diff --git a/clients/client-iot-wireless/commands/UntagResourceCommand.ts b/clients/client-iot-wireless/commands/UntagResourceCommand.ts index 9daf9cc9cdb9..af63c54f9186 100644 --- a/clients/client-iot-wireless/commands/UntagResourceCommand.ts +++ b/clients/client-iot-wireless/commands/UntagResourceCommand.ts @@ -22,6 +22,20 @@ export interface UntagResourceCommandOutput extends UntagResourceResponse, __Met /** *

Removes one or more tags from a resource.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { IoTWirelessClient, UntagResourceCommand } from "@aws-sdk/client-iot-wireless"; // ES Modules import + * // const { IoTWirelessClient, UntagResourceCommand } = require("@aws-sdk/client-iot-wireless"); // CommonJS import + * const client = new IoTWirelessClient(config); + * const command = new UntagResourceCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link UntagResourceCommandInput} for command's `input` shape. + * @see {@link UntagResourceCommandOutput} for command's `response` shape. + * @see {@link IoTWirelessClientResolvedConfig | config} for command's `input` shape. + * */ export class UntagResourceCommand extends $Command< UntagResourceCommandInput, diff --git a/clients/client-iot-wireless/commands/UpdateDestinationCommand.ts b/clients/client-iot-wireless/commands/UpdateDestinationCommand.ts index ac9c24069715..d79b442976c5 100644 --- a/clients/client-iot-wireless/commands/UpdateDestinationCommand.ts +++ b/clients/client-iot-wireless/commands/UpdateDestinationCommand.ts @@ -22,6 +22,20 @@ export interface UpdateDestinationCommandOutput extends UpdateDestinationRespons /** *

Updates properties of a destination.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { IoTWirelessClient, UpdateDestinationCommand } from "@aws-sdk/client-iot-wireless"; // ES Modules import + * // const { IoTWirelessClient, UpdateDestinationCommand } = require("@aws-sdk/client-iot-wireless"); // CommonJS import + * const client = new IoTWirelessClient(config); + * const command = new UpdateDestinationCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link UpdateDestinationCommandInput} for command's `input` shape. + * @see {@link UpdateDestinationCommandOutput} for command's `response` shape. + * @see {@link IoTWirelessClientResolvedConfig | config} for command's `input` shape. + * */ export class UpdateDestinationCommand extends $Command< UpdateDestinationCommandInput, diff --git a/clients/client-iot-wireless/commands/UpdatePartnerAccountCommand.ts b/clients/client-iot-wireless/commands/UpdatePartnerAccountCommand.ts index 1e9249dc91b1..994b90ca9c85 100644 --- a/clients/client-iot-wireless/commands/UpdatePartnerAccountCommand.ts +++ b/clients/client-iot-wireless/commands/UpdatePartnerAccountCommand.ts @@ -22,6 +22,20 @@ export interface UpdatePartnerAccountCommandOutput extends UpdatePartnerAccountR /** *

Updates properties of a partner account.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { IoTWirelessClient, UpdatePartnerAccountCommand } from "@aws-sdk/client-iot-wireless"; // ES Modules import + * // const { IoTWirelessClient, UpdatePartnerAccountCommand } = require("@aws-sdk/client-iot-wireless"); // CommonJS import + * const client = new IoTWirelessClient(config); + * const command = new UpdatePartnerAccountCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link UpdatePartnerAccountCommandInput} for command's `input` shape. + * @see {@link UpdatePartnerAccountCommandOutput} for command's `response` shape. + * @see {@link IoTWirelessClientResolvedConfig | config} for command's `input` shape. + * */ export class UpdatePartnerAccountCommand extends $Command< UpdatePartnerAccountCommandInput, diff --git a/clients/client-iot-wireless/commands/UpdateWirelessDeviceCommand.ts b/clients/client-iot-wireless/commands/UpdateWirelessDeviceCommand.ts index 29c57225ef9c..cb98b2a28aff 100644 --- a/clients/client-iot-wireless/commands/UpdateWirelessDeviceCommand.ts +++ b/clients/client-iot-wireless/commands/UpdateWirelessDeviceCommand.ts @@ -22,6 +22,20 @@ export interface UpdateWirelessDeviceCommandOutput extends UpdateWirelessDeviceR /** *

Updates properties of a wireless device.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { IoTWirelessClient, UpdateWirelessDeviceCommand } from "@aws-sdk/client-iot-wireless"; // ES Modules import + * // const { IoTWirelessClient, UpdateWirelessDeviceCommand } = require("@aws-sdk/client-iot-wireless"); // CommonJS import + * const client = new IoTWirelessClient(config); + * const command = new UpdateWirelessDeviceCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link UpdateWirelessDeviceCommandInput} for command's `input` shape. + * @see {@link UpdateWirelessDeviceCommandOutput} for command's `response` shape. + * @see {@link IoTWirelessClientResolvedConfig | config} for command's `input` shape. + * */ export class UpdateWirelessDeviceCommand extends $Command< UpdateWirelessDeviceCommandInput, diff --git a/clients/client-iot-wireless/commands/UpdateWirelessGatewayCommand.ts b/clients/client-iot-wireless/commands/UpdateWirelessGatewayCommand.ts index 2a898674257c..229277a330d5 100644 --- a/clients/client-iot-wireless/commands/UpdateWirelessGatewayCommand.ts +++ b/clients/client-iot-wireless/commands/UpdateWirelessGatewayCommand.ts @@ -22,6 +22,20 @@ export interface UpdateWirelessGatewayCommandOutput extends UpdateWirelessGatewa /** *

Updates properties of a wireless gateway.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { IoTWirelessClient, UpdateWirelessGatewayCommand } from "@aws-sdk/client-iot-wireless"; // ES Modules import + * // const { IoTWirelessClient, UpdateWirelessGatewayCommand } = require("@aws-sdk/client-iot-wireless"); // CommonJS import + * const client = new IoTWirelessClient(config); + * const command = new UpdateWirelessGatewayCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link UpdateWirelessGatewayCommandInput} for command's `input` shape. + * @see {@link UpdateWirelessGatewayCommandOutput} for command's `response` shape. + * @see {@link IoTWirelessClientResolvedConfig | config} for command's `input` shape. + * */ export class UpdateWirelessGatewayCommand extends $Command< UpdateWirelessGatewayCommandInput, diff --git a/clients/client-iot-wireless/models/models_0.ts b/clients/client-iot-wireless/models/models_0.ts index 015c640f8ba7..1696ea784c3e 100644 --- a/clients/client-iot-wireless/models/models_0.ts +++ b/clients/client-iot-wireless/models/models_0.ts @@ -17,6 +17,9 @@ export interface SessionKeysAbpV1_0_x { } export namespace SessionKeysAbpV1_0_x { + /** + * @internal + */ export const filterSensitiveLog = (obj: SessionKeysAbpV1_0_x): any => ({ ...obj, }); @@ -38,6 +41,9 @@ export interface AbpV1_0_x { } export namespace AbpV1_0_x { + /** + * @internal + */ export const filterSensitiveLog = (obj: AbpV1_0_x): any => ({ ...obj, }); @@ -69,6 +75,9 @@ export interface SessionKeysAbpV1_1 { } export namespace SessionKeysAbpV1_1 { + /** + * @internal + */ export const filterSensitiveLog = (obj: SessionKeysAbpV1_1): any => ({ ...obj, }); @@ -90,6 +99,9 @@ export interface AbpV1_1 { } export namespace AbpV1_1 { + /** + * @internal + */ export const filterSensitiveLog = (obj: AbpV1_1): any => ({ ...obj, }); @@ -105,6 +117,9 @@ export interface AccessDeniedException extends __SmithyException, $MetadataBeare } export namespace AccessDeniedException { + /** + * @internal + */ export const filterSensitiveLog = (obj: AccessDeniedException): any => ({ ...obj, }); @@ -126,6 +141,9 @@ export interface SidewalkAccountInfo { } export namespace SidewalkAccountInfo { + /** + * @internal + */ export const filterSensitiveLog = (obj: SidewalkAccountInfo): any => ({ ...obj, ...(obj.AppServerPrivateKey && { AppServerPrivateKey: SENSITIVE_STRING }), @@ -148,6 +166,9 @@ export interface Tag { } export namespace Tag { + /** + * @internal + */ export const filterSensitiveLog = (obj: Tag): any => ({ ...obj, }); @@ -171,6 +192,9 @@ export interface AssociateAwsAccountWithPartnerAccountRequest { } export namespace AssociateAwsAccountWithPartnerAccountRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: AssociateAwsAccountWithPartnerAccountRequest): any => ({ ...obj, ...(obj.Sidewalk && { Sidewalk: SidewalkAccountInfo.filterSensitiveLog(obj.Sidewalk) }), @@ -190,6 +214,9 @@ export interface AssociateAwsAccountWithPartnerAccountResponse { } export namespace AssociateAwsAccountWithPartnerAccountResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: AssociateAwsAccountWithPartnerAccountResponse): any => ({ ...obj, ...(obj.Sidewalk && { Sidewalk: SidewalkAccountInfo.filterSensitiveLog(obj.Sidewalk) }), @@ -208,6 +235,9 @@ export interface ConflictException extends __SmithyException, $MetadataBearer { } export namespace ConflictException { + /** + * @internal + */ export const filterSensitiveLog = (obj: ConflictException): any => ({ ...obj, }); @@ -223,6 +253,9 @@ export interface InternalServerException extends __SmithyException, $MetadataBea } export namespace InternalServerException { + /** + * @internal + */ export const filterSensitiveLog = (obj: InternalServerException): any => ({ ...obj, }); @@ -240,6 +273,9 @@ export interface ResourceNotFoundException extends __SmithyException, $MetadataB } export namespace ResourceNotFoundException { + /** + * @internal + */ export const filterSensitiveLog = (obj: ResourceNotFoundException): any => ({ ...obj, }); @@ -255,6 +291,9 @@ export interface ThrottlingException extends __SmithyException, $MetadataBearer } export namespace ThrottlingException { + /** + * @internal + */ export const filterSensitiveLog = (obj: ThrottlingException): any => ({ ...obj, }); @@ -270,6 +309,9 @@ export interface ValidationException extends __SmithyException, $MetadataBearer } export namespace ValidationException { + /** + * @internal + */ export const filterSensitiveLog = (obj: ValidationException): any => ({ ...obj, }); @@ -288,6 +330,9 @@ export interface AssociateWirelessDeviceWithThingRequest { } export namespace AssociateWirelessDeviceWithThingRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: AssociateWirelessDeviceWithThingRequest): any => ({ ...obj, }); @@ -296,6 +341,9 @@ export namespace AssociateWirelessDeviceWithThingRequest { export interface AssociateWirelessDeviceWithThingResponse {} export namespace AssociateWirelessDeviceWithThingResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: AssociateWirelessDeviceWithThingResponse): any => ({ ...obj, }); @@ -314,6 +362,9 @@ export interface AssociateWirelessGatewayWithCertificateRequest { } export namespace AssociateWirelessGatewayWithCertificateRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: AssociateWirelessGatewayWithCertificateRequest): any => ({ ...obj, }); @@ -327,6 +378,9 @@ export interface AssociateWirelessGatewayWithCertificateResponse { } export namespace AssociateWirelessGatewayWithCertificateResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: AssociateWirelessGatewayWithCertificateResponse): any => ({ ...obj, }); @@ -345,6 +399,9 @@ export interface AssociateWirelessGatewayWithThingRequest { } export namespace AssociateWirelessGatewayWithThingRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: AssociateWirelessGatewayWithThingRequest): any => ({ ...obj, }); @@ -353,6 +410,9 @@ export namespace AssociateWirelessGatewayWithThingRequest { export interface AssociateWirelessGatewayWithThingResponse {} export namespace AssociateWirelessGatewayWithThingResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: AssociateWirelessGatewayWithThingResponse): any => ({ ...obj, }); @@ -385,6 +445,9 @@ export interface CertificateList { } export namespace CertificateList { + /** + * @internal + */ export const filterSensitiveLog = (obj: CertificateList): any => ({ ...obj, }); @@ -438,6 +501,9 @@ export interface CreateDestinationRequest { } export namespace CreateDestinationRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateDestinationRequest): any => ({ ...obj, }); @@ -456,6 +522,9 @@ export interface CreateDestinationResponse { } export namespace CreateDestinationResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateDestinationResponse): any => ({ ...obj, }); @@ -562,6 +631,9 @@ export interface LoRaWANDeviceProfile { } export namespace LoRaWANDeviceProfile { + /** + * @internal + */ export const filterSensitiveLog = (obj: LoRaWANDeviceProfile): any => ({ ...obj, }); @@ -590,6 +662,9 @@ export interface CreateDeviceProfileRequest { } export namespace CreateDeviceProfileRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateDeviceProfileRequest): any => ({ ...obj, }); @@ -608,6 +683,9 @@ export interface CreateDeviceProfileResponse { } export namespace CreateDeviceProfileResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateDeviceProfileResponse): any => ({ ...obj, }); @@ -624,6 +702,9 @@ export interface LoRaWANServiceProfile { } export namespace LoRaWANServiceProfile { + /** + * @internal + */ export const filterSensitiveLog = (obj: LoRaWANServiceProfile): any => ({ ...obj, }); @@ -652,6 +733,9 @@ export interface CreateServiceProfileRequest { } export namespace CreateServiceProfileRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateServiceProfileRequest): any => ({ ...obj, }); @@ -670,6 +754,9 @@ export interface CreateServiceProfileResponse { } export namespace CreateServiceProfileResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateServiceProfileResponse): any => ({ ...obj, }); @@ -691,6 +778,9 @@ export interface OtaaV1_0_x { } export namespace OtaaV1_0_x { + /** + * @internal + */ export const filterSensitiveLog = (obj: OtaaV1_0_x): any => ({ ...obj, }); @@ -717,6 +807,9 @@ export interface OtaaV1_1 { } export namespace OtaaV1_1 { + /** + * @internal + */ export const filterSensitiveLog = (obj: OtaaV1_1): any => ({ ...obj, }); @@ -763,6 +856,9 @@ export interface LoRaWANDevice { } export namespace LoRaWANDevice { + /** + * @internal + */ export const filterSensitiveLog = (obj: LoRaWANDevice): any => ({ ...obj, }); @@ -811,6 +907,9 @@ export interface CreateWirelessDeviceRequest { } export namespace CreateWirelessDeviceRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateWirelessDeviceRequest): any => ({ ...obj, }); @@ -829,6 +928,9 @@ export interface CreateWirelessDeviceResponse { } export namespace CreateWirelessDeviceResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateWirelessDeviceResponse): any => ({ ...obj, }); @@ -850,6 +952,9 @@ export interface LoRaWANGateway { } export namespace LoRaWANGateway { + /** + * @internal + */ export const filterSensitiveLog = (obj: LoRaWANGateway): any => ({ ...obj, }); @@ -883,6 +988,9 @@ export interface CreateWirelessGatewayRequest { } export namespace CreateWirelessGatewayRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateWirelessGatewayRequest): any => ({ ...obj, }); @@ -901,6 +1009,9 @@ export interface CreateWirelessGatewayResponse { } export namespace CreateWirelessGatewayResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateWirelessGatewayResponse): any => ({ ...obj, }); @@ -919,6 +1030,9 @@ export interface CreateWirelessGatewayTaskRequest { } export namespace CreateWirelessGatewayTaskRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateWirelessGatewayTaskRequest): any => ({ ...obj, }); @@ -946,6 +1060,9 @@ export interface CreateWirelessGatewayTaskResponse { } export namespace CreateWirelessGatewayTaskResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateWirelessGatewayTaskResponse): any => ({ ...obj, }); @@ -972,6 +1089,9 @@ export interface LoRaWANGatewayVersion { } export namespace LoRaWANGatewayVersion { + /** + * @internal + */ export const filterSensitiveLog = (obj: LoRaWANGatewayVersion): any => ({ ...obj, }); @@ -1003,6 +1123,9 @@ export interface LoRaWANUpdateGatewayTaskCreate { } export namespace LoRaWANUpdateGatewayTaskCreate { + /** + * @internal + */ export const filterSensitiveLog = (obj: LoRaWANUpdateGatewayTaskCreate): any => ({ ...obj, }); @@ -1029,6 +1152,9 @@ export interface UpdateWirelessGatewayTaskCreate { } export namespace UpdateWirelessGatewayTaskCreate { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateWirelessGatewayTaskCreate): any => ({ ...obj, }); @@ -1062,6 +1188,9 @@ export interface CreateWirelessGatewayTaskDefinitionRequest { } export namespace CreateWirelessGatewayTaskDefinitionRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateWirelessGatewayTaskDefinitionRequest): any => ({ ...obj, }); @@ -1080,6 +1209,9 @@ export interface CreateWirelessGatewayTaskDefinitionResponse { } export namespace CreateWirelessGatewayTaskDefinitionResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateWirelessGatewayTaskDefinitionResponse): any => ({ ...obj, }); @@ -1093,6 +1225,9 @@ export interface DeleteDestinationRequest { } export namespace DeleteDestinationRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteDestinationRequest): any => ({ ...obj, }); @@ -1101,6 +1236,9 @@ export namespace DeleteDestinationRequest { export interface DeleteDestinationResponse {} export namespace DeleteDestinationResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteDestinationResponse): any => ({ ...obj, }); @@ -1114,6 +1252,9 @@ export interface DeleteDeviceProfileRequest { } export namespace DeleteDeviceProfileRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteDeviceProfileRequest): any => ({ ...obj, }); @@ -1122,6 +1263,9 @@ export namespace DeleteDeviceProfileRequest { export interface DeleteDeviceProfileResponse {} export namespace DeleteDeviceProfileResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteDeviceProfileResponse): any => ({ ...obj, }); @@ -1135,6 +1279,9 @@ export interface DeleteServiceProfileRequest { } export namespace DeleteServiceProfileRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteServiceProfileRequest): any => ({ ...obj, }); @@ -1143,6 +1290,9 @@ export namespace DeleteServiceProfileRequest { export interface DeleteServiceProfileResponse {} export namespace DeleteServiceProfileResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteServiceProfileResponse): any => ({ ...obj, }); @@ -1156,6 +1306,9 @@ export interface DeleteWirelessDeviceRequest { } export namespace DeleteWirelessDeviceRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteWirelessDeviceRequest): any => ({ ...obj, }); @@ -1164,6 +1317,9 @@ export namespace DeleteWirelessDeviceRequest { export interface DeleteWirelessDeviceResponse {} export namespace DeleteWirelessDeviceResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteWirelessDeviceResponse): any => ({ ...obj, }); @@ -1177,6 +1333,9 @@ export interface DeleteWirelessGatewayRequest { } export namespace DeleteWirelessGatewayRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteWirelessGatewayRequest): any => ({ ...obj, }); @@ -1185,6 +1344,9 @@ export namespace DeleteWirelessGatewayRequest { export interface DeleteWirelessGatewayResponse {} export namespace DeleteWirelessGatewayResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteWirelessGatewayResponse): any => ({ ...obj, }); @@ -1198,6 +1360,9 @@ export interface DeleteWirelessGatewayTaskRequest { } export namespace DeleteWirelessGatewayTaskRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteWirelessGatewayTaskRequest): any => ({ ...obj, }); @@ -1206,6 +1371,9 @@ export namespace DeleteWirelessGatewayTaskRequest { export interface DeleteWirelessGatewayTaskResponse {} export namespace DeleteWirelessGatewayTaskResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteWirelessGatewayTaskResponse): any => ({ ...obj, }); @@ -1219,6 +1387,9 @@ export interface DeleteWirelessGatewayTaskDefinitionRequest { } export namespace DeleteWirelessGatewayTaskDefinitionRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteWirelessGatewayTaskDefinitionRequest): any => ({ ...obj, }); @@ -1227,6 +1398,9 @@ export namespace DeleteWirelessGatewayTaskDefinitionRequest { export interface DeleteWirelessGatewayTaskDefinitionResponse {} export namespace DeleteWirelessGatewayTaskDefinitionResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteWirelessGatewayTaskDefinitionResponse): any => ({ ...obj, }); @@ -1268,6 +1442,9 @@ export interface Destinations { } export namespace Destinations { + /** + * @internal + */ export const filterSensitiveLog = (obj: Destinations): any => ({ ...obj, }); @@ -1294,6 +1471,9 @@ export interface DeviceProfile { } export namespace DeviceProfile { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeviceProfile): any => ({ ...obj, }); @@ -1323,6 +1503,9 @@ export interface DisassociateAwsAccountFromPartnerAccountRequest { } export namespace DisassociateAwsAccountFromPartnerAccountRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DisassociateAwsAccountFromPartnerAccountRequest): any => ({ ...obj, }); @@ -1331,6 +1514,9 @@ export namespace DisassociateAwsAccountFromPartnerAccountRequest { export interface DisassociateAwsAccountFromPartnerAccountResponse {} export namespace DisassociateAwsAccountFromPartnerAccountResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DisassociateAwsAccountFromPartnerAccountResponse): any => ({ ...obj, }); @@ -1344,6 +1530,9 @@ export interface DisassociateWirelessDeviceFromThingRequest { } export namespace DisassociateWirelessDeviceFromThingRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DisassociateWirelessDeviceFromThingRequest): any => ({ ...obj, }); @@ -1352,6 +1541,9 @@ export namespace DisassociateWirelessDeviceFromThingRequest { export interface DisassociateWirelessDeviceFromThingResponse {} export namespace DisassociateWirelessDeviceFromThingResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DisassociateWirelessDeviceFromThingResponse): any => ({ ...obj, }); @@ -1365,6 +1557,9 @@ export interface DisassociateWirelessGatewayFromCertificateRequest { } export namespace DisassociateWirelessGatewayFromCertificateRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DisassociateWirelessGatewayFromCertificateRequest): any => ({ ...obj, }); @@ -1373,6 +1568,9 @@ export namespace DisassociateWirelessGatewayFromCertificateRequest { export interface DisassociateWirelessGatewayFromCertificateResponse {} export namespace DisassociateWirelessGatewayFromCertificateResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DisassociateWirelessGatewayFromCertificateResponse): any => ({ ...obj, }); @@ -1386,6 +1584,9 @@ export interface DisassociateWirelessGatewayFromThingRequest { } export namespace DisassociateWirelessGatewayFromThingRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DisassociateWirelessGatewayFromThingRequest): any => ({ ...obj, }); @@ -1394,6 +1595,9 @@ export namespace DisassociateWirelessGatewayFromThingRequest { export interface DisassociateWirelessGatewayFromThingResponse {} export namespace DisassociateWirelessGatewayFromThingResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DisassociateWirelessGatewayFromThingResponse): any => ({ ...obj, }); @@ -1415,6 +1619,9 @@ export interface GetDestinationRequest { } export namespace GetDestinationRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetDestinationRequest): any => ({ ...obj, }); @@ -1453,6 +1660,9 @@ export interface GetDestinationResponse { } export namespace GetDestinationResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetDestinationResponse): any => ({ ...obj, }); @@ -1466,6 +1676,9 @@ export interface GetDeviceProfileRequest { } export namespace GetDeviceProfileRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetDeviceProfileRequest): any => ({ ...obj, }); @@ -1494,6 +1707,9 @@ export interface GetDeviceProfileResponse { } export namespace GetDeviceProfileResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetDeviceProfileResponse): any => ({ ...obj, }); @@ -1512,6 +1728,9 @@ export interface GetPartnerAccountRequest { } export namespace GetPartnerAccountRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetPartnerAccountRequest): any => ({ ...obj, }); @@ -1538,6 +1757,9 @@ export interface SidewalkAccountInfoWithFingerprint { } export namespace SidewalkAccountInfoWithFingerprint { + /** + * @internal + */ export const filterSensitiveLog = (obj: SidewalkAccountInfoWithFingerprint): any => ({ ...obj, ...(obj.Fingerprint && { Fingerprint: SENSITIVE_STRING }), @@ -1557,6 +1779,9 @@ export interface GetPartnerAccountResponse { } export namespace GetPartnerAccountResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetPartnerAccountResponse): any => ({ ...obj, ...(obj.Sidewalk && { Sidewalk: SidewalkAccountInfoWithFingerprint.filterSensitiveLog(obj.Sidewalk) }), @@ -1576,6 +1801,9 @@ export interface GetServiceEndpointRequest { } export namespace GetServiceEndpointRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetServiceEndpointRequest): any => ({ ...obj, }); @@ -1599,6 +1827,9 @@ export interface GetServiceEndpointResponse { } export namespace GetServiceEndpointResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetServiceEndpointResponse): any => ({ ...obj, }); @@ -1612,6 +1843,9 @@ export interface GetServiceProfileRequest { } export namespace GetServiceProfileRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetServiceProfileRequest): any => ({ ...obj, }); @@ -1718,6 +1952,9 @@ export interface LoRaWANGetServiceProfileInfo { } export namespace LoRaWANGetServiceProfileInfo { + /** + * @internal + */ export const filterSensitiveLog = (obj: LoRaWANGetServiceProfileInfo): any => ({ ...obj, }); @@ -1746,6 +1983,9 @@ export interface GetServiceProfileResponse { } export namespace GetServiceProfileResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetServiceProfileResponse): any => ({ ...obj, }); @@ -1770,6 +2010,9 @@ export interface GetWirelessDeviceRequest { } export namespace GetWirelessDeviceRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetWirelessDeviceRequest): any => ({ ...obj, }); @@ -1796,6 +2039,9 @@ export interface SidewalkDevice { } export namespace SidewalkDevice { + /** + * @internal + */ export const filterSensitiveLog = (obj: SidewalkDevice): any => ({ ...obj, }); @@ -1854,6 +2100,9 @@ export interface GetWirelessDeviceResponse { } export namespace GetWirelessDeviceResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetWirelessDeviceResponse): any => ({ ...obj, }); @@ -1867,6 +2116,9 @@ export interface GetWirelessDeviceStatisticsRequest { } export namespace GetWirelessDeviceStatisticsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetWirelessDeviceStatisticsRequest): any => ({ ...obj, }); @@ -1893,6 +2145,9 @@ export interface LoRaWANGatewayMetadata { } export namespace LoRaWANGatewayMetadata { + /** + * @internal + */ export const filterSensitiveLog = (obj: LoRaWANGatewayMetadata): any => ({ ...obj, }); @@ -1934,6 +2189,9 @@ export interface LoRaWANDeviceMetadata { } export namespace LoRaWANDeviceMetadata { + /** + * @internal + */ export const filterSensitiveLog = (obj: LoRaWANDeviceMetadata): any => ({ ...obj, }); @@ -1965,6 +2223,9 @@ export interface SidewalkDeviceMetadata { } export namespace SidewalkDeviceMetadata { + /** + * @internal + */ export const filterSensitiveLog = (obj: SidewalkDeviceMetadata): any => ({ ...obj, }); @@ -1993,6 +2254,9 @@ export interface GetWirelessDeviceStatisticsResponse { } export namespace GetWirelessDeviceStatisticsResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetWirelessDeviceStatisticsResponse): any => ({ ...obj, }); @@ -2017,6 +2281,9 @@ export interface GetWirelessGatewayRequest { } export namespace GetWirelessGatewayRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetWirelessGatewayRequest): any => ({ ...obj, }); @@ -2060,6 +2327,9 @@ export interface GetWirelessGatewayResponse { } export namespace GetWirelessGatewayResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetWirelessGatewayResponse): any => ({ ...obj, }); @@ -2073,6 +2343,9 @@ export interface GetWirelessGatewayCertificateRequest { } export namespace GetWirelessGatewayCertificateRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetWirelessGatewayCertificateRequest): any => ({ ...obj, }); @@ -2091,6 +2364,9 @@ export interface GetWirelessGatewayCertificateResponse { } export namespace GetWirelessGatewayCertificateResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetWirelessGatewayCertificateResponse): any => ({ ...obj, }); @@ -2104,6 +2380,9 @@ export interface GetWirelessGatewayFirmwareInformationRequest { } export namespace GetWirelessGatewayFirmwareInformationRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetWirelessGatewayFirmwareInformationRequest): any => ({ ...obj, }); @@ -2120,6 +2399,9 @@ export interface LoRaWANGatewayCurrentVersion { } export namespace LoRaWANGatewayCurrentVersion { + /** + * @internal + */ export const filterSensitiveLog = (obj: LoRaWANGatewayCurrentVersion): any => ({ ...obj, }); @@ -2133,6 +2415,9 @@ export interface GetWirelessGatewayFirmwareInformationResponse { } export namespace GetWirelessGatewayFirmwareInformationResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetWirelessGatewayFirmwareInformationResponse): any => ({ ...obj, }); @@ -2146,6 +2431,9 @@ export interface GetWirelessGatewayStatisticsRequest { } export namespace GetWirelessGatewayStatisticsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetWirelessGatewayStatisticsRequest): any => ({ ...obj, }); @@ -2169,6 +2457,9 @@ export interface GetWirelessGatewayStatisticsResponse { } export namespace GetWirelessGatewayStatisticsResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetWirelessGatewayStatisticsResponse): any => ({ ...obj, }); @@ -2182,6 +2473,9 @@ export interface GetWirelessGatewayTaskRequest { } export namespace GetWirelessGatewayTaskRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetWirelessGatewayTaskRequest): any => ({ ...obj, }); @@ -2215,6 +2509,9 @@ export interface GetWirelessGatewayTaskResponse { } export namespace GetWirelessGatewayTaskResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetWirelessGatewayTaskResponse): any => ({ ...obj, }); @@ -2228,6 +2525,9 @@ export interface GetWirelessGatewayTaskDefinitionRequest { } export namespace GetWirelessGatewayTaskDefinitionRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetWirelessGatewayTaskDefinitionRequest): any => ({ ...obj, }); @@ -2256,6 +2556,9 @@ export interface GetWirelessGatewayTaskDefinitionResponse { } export namespace GetWirelessGatewayTaskDefinitionResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetWirelessGatewayTaskDefinitionResponse): any => ({ ...obj, }); @@ -2274,6 +2577,9 @@ export interface ListDestinationsRequest { } export namespace ListDestinationsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListDestinationsRequest): any => ({ ...obj, }); @@ -2292,6 +2598,9 @@ export interface ListDestinationsResponse { } export namespace ListDestinationsResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListDestinationsResponse): any => ({ ...obj, }); @@ -2310,6 +2619,9 @@ export interface ListDeviceProfilesRequest { } export namespace ListDeviceProfilesRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListDeviceProfilesRequest): any => ({ ...obj, }); @@ -2328,6 +2640,9 @@ export interface ListDeviceProfilesResponse { } export namespace ListDeviceProfilesResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListDeviceProfilesResponse): any => ({ ...obj, }); @@ -2346,6 +2661,9 @@ export interface ListPartnerAccountsRequest { } export namespace ListPartnerAccountsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListPartnerAccountsRequest): any => ({ ...obj, }); @@ -2364,6 +2682,9 @@ export interface ListPartnerAccountsResponse { } export namespace ListPartnerAccountsResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListPartnerAccountsResponse): any => ({ ...obj, ...(obj.Sidewalk && { @@ -2385,6 +2706,9 @@ export interface ListServiceProfilesRequest { } export namespace ListServiceProfilesRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListServiceProfilesRequest): any => ({ ...obj, }); @@ -2411,6 +2735,9 @@ export interface ServiceProfile { } export namespace ServiceProfile { + /** + * @internal + */ export const filterSensitiveLog = (obj: ServiceProfile): any => ({ ...obj, }); @@ -2429,6 +2756,9 @@ export interface ListServiceProfilesResponse { } export namespace ListServiceProfilesResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListServiceProfilesResponse): any => ({ ...obj, }); @@ -2442,6 +2772,9 @@ export interface ListTagsForResourceRequest { } export namespace ListTagsForResourceRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListTagsForResourceRequest): any => ({ ...obj, }); @@ -2455,6 +2788,9 @@ export interface ListTagsForResourceResponse { } export namespace ListTagsForResourceResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListTagsForResourceResponse): any => ({ ...obj, }); @@ -2493,6 +2829,9 @@ export interface ListWirelessDevicesRequest { } export namespace ListWirelessDevicesRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListWirelessDevicesRequest): any => ({ ...obj, }); @@ -2509,6 +2848,9 @@ export interface LoRaWANListDevice { } export namespace LoRaWANListDevice { + /** + * @internal + */ export const filterSensitiveLog = (obj: LoRaWANListDevice): any => ({ ...obj, }); @@ -2540,6 +2882,9 @@ export interface SidewalkListDevice { } export namespace SidewalkListDevice { + /** + * @internal + */ export const filterSensitiveLog = (obj: SidewalkListDevice): any => ({ ...obj, }); @@ -2591,6 +2936,9 @@ export interface WirelessDeviceStatistics { } export namespace WirelessDeviceStatistics { + /** + * @internal + */ export const filterSensitiveLog = (obj: WirelessDeviceStatistics): any => ({ ...obj, }); @@ -2609,6 +2957,9 @@ export interface ListWirelessDevicesResponse { } export namespace ListWirelessDevicesResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListWirelessDevicesResponse): any => ({ ...obj, }); @@ -2627,6 +2978,9 @@ export interface ListWirelessGatewaysRequest { } export namespace ListWirelessGatewaysRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListWirelessGatewaysRequest): any => ({ ...obj, }); @@ -2668,6 +3022,9 @@ export interface WirelessGatewayStatistics { } export namespace WirelessGatewayStatistics { + /** + * @internal + */ export const filterSensitiveLog = (obj: WirelessGatewayStatistics): any => ({ ...obj, }); @@ -2686,6 +3043,9 @@ export interface ListWirelessGatewaysResponse { } export namespace ListWirelessGatewaysResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListWirelessGatewaysResponse): any => ({ ...obj, }); @@ -2713,6 +3073,9 @@ export interface ListWirelessGatewayTaskDefinitionsRequest { } export namespace ListWirelessGatewayTaskDefinitionsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListWirelessGatewayTaskDefinitionsRequest): any => ({ ...obj, }); @@ -2734,6 +3097,9 @@ export interface LoRaWANUpdateGatewayTaskEntry { } export namespace LoRaWANUpdateGatewayTaskEntry { + /** + * @internal + */ export const filterSensitiveLog = (obj: LoRaWANUpdateGatewayTaskEntry): any => ({ ...obj, }); @@ -2760,6 +3126,9 @@ export interface UpdateWirelessGatewayTaskEntry { } export namespace UpdateWirelessGatewayTaskEntry { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateWirelessGatewayTaskEntry): any => ({ ...obj, }); @@ -2778,6 +3147,9 @@ export interface ListWirelessGatewayTaskDefinitionsResponse { } export namespace ListWirelessGatewayTaskDefinitionsResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListWirelessGatewayTaskDefinitionsResponse): any => ({ ...obj, }); @@ -2794,6 +3166,9 @@ export interface LoRaWANSendDataToDevice { } export namespace LoRaWANSendDataToDevice { + /** + * @internal + */ export const filterSensitiveLog = (obj: LoRaWANSendDataToDevice): any => ({ ...obj, }); @@ -2822,6 +3197,9 @@ export interface SidewalkSendDataToDevice { } export namespace SidewalkSendDataToDevice { + /** + * @internal + */ export const filterSensitiveLog = (obj: SidewalkSendDataToDevice): any => ({ ...obj, }); @@ -2843,6 +3221,9 @@ export interface WirelessMetadata { } export namespace WirelessMetadata { + /** + * @internal + */ export const filterSensitiveLog = (obj: WirelessMetadata): any => ({ ...obj, }); @@ -2871,6 +3252,9 @@ export interface SendDataToWirelessDeviceRequest { } export namespace SendDataToWirelessDeviceRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: SendDataToWirelessDeviceRequest): any => ({ ...obj, }); @@ -2884,6 +3268,9 @@ export interface SendDataToWirelessDeviceResponse { } export namespace SendDataToWirelessDeviceResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: SendDataToWirelessDeviceResponse): any => ({ ...obj, }); @@ -2902,6 +3289,9 @@ export interface TagResourceRequest { } export namespace TagResourceRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: TagResourceRequest): any => ({ ...obj, }); @@ -2910,6 +3300,9 @@ export namespace TagResourceRequest { export interface TagResourceResponse {} export namespace TagResourceResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: TagResourceResponse): any => ({ ...obj, }); @@ -2926,6 +3319,9 @@ export interface TooManyTagsException extends __SmithyException, $MetadataBearer } export namespace TooManyTagsException { + /** + * @internal + */ export const filterSensitiveLog = (obj: TooManyTagsException): any => ({ ...obj, }); @@ -2939,6 +3335,9 @@ export interface TestWirelessDeviceRequest { } export namespace TestWirelessDeviceRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: TestWirelessDeviceRequest): any => ({ ...obj, }); @@ -2952,6 +3351,9 @@ export interface TestWirelessDeviceResponse { } export namespace TestWirelessDeviceResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: TestWirelessDeviceResponse): any => ({ ...obj, }); @@ -2970,6 +3372,9 @@ export interface UntagResourceRequest { } export namespace UntagResourceRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: UntagResourceRequest): any => ({ ...obj, }); @@ -2978,6 +3383,9 @@ export namespace UntagResourceRequest { export interface UntagResourceResponse {} export namespace UntagResourceResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: UntagResourceResponse): any => ({ ...obj, }); @@ -3011,6 +3419,9 @@ export interface UpdateDestinationRequest { } export namespace UpdateDestinationRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateDestinationRequest): any => ({ ...obj, }); @@ -3019,6 +3430,9 @@ export namespace UpdateDestinationRequest { export interface UpdateDestinationResponse {} export namespace UpdateDestinationResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateDestinationResponse): any => ({ ...obj, }); @@ -3035,6 +3449,9 @@ export interface SidewalkUpdateAccount { } export namespace SidewalkUpdateAccount { + /** + * @internal + */ export const filterSensitiveLog = (obj: SidewalkUpdateAccount): any => ({ ...obj, ...(obj.AppServerPrivateKey && { AppServerPrivateKey: SENSITIVE_STRING }), @@ -3059,6 +3476,9 @@ export interface UpdatePartnerAccountRequest { } export namespace UpdatePartnerAccountRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdatePartnerAccountRequest): any => ({ ...obj, ...(obj.Sidewalk && { Sidewalk: SidewalkUpdateAccount.filterSensitiveLog(obj.Sidewalk) }), @@ -3068,6 +3488,9 @@ export namespace UpdatePartnerAccountRequest { export interface UpdatePartnerAccountResponse {} export namespace UpdatePartnerAccountResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdatePartnerAccountResponse): any => ({ ...obj, }); @@ -3089,6 +3512,9 @@ export interface LoRaWANUpdateDevice { } export namespace LoRaWANUpdateDevice { + /** + * @internal + */ export const filterSensitiveLog = (obj: LoRaWANUpdateDevice): any => ({ ...obj, }); @@ -3122,6 +3548,9 @@ export interface UpdateWirelessDeviceRequest { } export namespace UpdateWirelessDeviceRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateWirelessDeviceRequest): any => ({ ...obj, }); @@ -3130,6 +3559,9 @@ export namespace UpdateWirelessDeviceRequest { export interface UpdateWirelessDeviceResponse {} export namespace UpdateWirelessDeviceResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateWirelessDeviceResponse): any => ({ ...obj, }); @@ -3153,6 +3585,9 @@ export interface UpdateWirelessGatewayRequest { } export namespace UpdateWirelessGatewayRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateWirelessGatewayRequest): any => ({ ...obj, }); @@ -3161,6 +3596,9 @@ export namespace UpdateWirelessGatewayRequest { export interface UpdateWirelessGatewayResponse {} export namespace UpdateWirelessGatewayResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateWirelessGatewayResponse): any => ({ ...obj, }); diff --git a/clients/client-iot/commands/AcceptCertificateTransferCommand.ts b/clients/client-iot/commands/AcceptCertificateTransferCommand.ts index dc8cd1300b02..a46de5d0a25e 100644 --- a/clients/client-iot/commands/AcceptCertificateTransferCommand.ts +++ b/clients/client-iot/commands/AcceptCertificateTransferCommand.ts @@ -25,6 +25,20 @@ export interface AcceptCertificateTransferCommandOutput extends __MetadataBearer * INACTIVE.

*

To check for pending certificate transfers, call ListCertificates * to enumerate your certificates.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { IoTClient, AcceptCertificateTransferCommand } from "@aws-sdk/client-iot"; // ES Modules import + * // const { IoTClient, AcceptCertificateTransferCommand } = require("@aws-sdk/client-iot"); // CommonJS import + * const client = new IoTClient(config); + * const command = new AcceptCertificateTransferCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link AcceptCertificateTransferCommandInput} for command's `input` shape. + * @see {@link AcceptCertificateTransferCommandOutput} for command's `response` shape. + * @see {@link IoTClientResolvedConfig | config} for command's `input` shape. + * */ export class AcceptCertificateTransferCommand extends $Command< AcceptCertificateTransferCommandInput, diff --git a/clients/client-iot/commands/AddThingToBillingGroupCommand.ts b/clients/client-iot/commands/AddThingToBillingGroupCommand.ts index 8977a9de8ef1..e2999a1f9b57 100644 --- a/clients/client-iot/commands/AddThingToBillingGroupCommand.ts +++ b/clients/client-iot/commands/AddThingToBillingGroupCommand.ts @@ -22,6 +22,20 @@ export interface AddThingToBillingGroupCommandOutput extends AddThingToBillingGr /** *

Adds a thing to a billing group.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { IoTClient, AddThingToBillingGroupCommand } from "@aws-sdk/client-iot"; // ES Modules import + * // const { IoTClient, AddThingToBillingGroupCommand } = require("@aws-sdk/client-iot"); // CommonJS import + * const client = new IoTClient(config); + * const command = new AddThingToBillingGroupCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link AddThingToBillingGroupCommandInput} for command's `input` shape. + * @see {@link AddThingToBillingGroupCommandOutput} for command's `response` shape. + * @see {@link IoTClientResolvedConfig | config} for command's `input` shape. + * */ export class AddThingToBillingGroupCommand extends $Command< AddThingToBillingGroupCommandInput, diff --git a/clients/client-iot/commands/AddThingToThingGroupCommand.ts b/clients/client-iot/commands/AddThingToThingGroupCommand.ts index a0cec0d57166..97498f4b1389 100644 --- a/clients/client-iot/commands/AddThingToThingGroupCommand.ts +++ b/clients/client-iot/commands/AddThingToThingGroupCommand.ts @@ -22,6 +22,20 @@ export interface AddThingToThingGroupCommandOutput extends AddThingToThingGroupR /** *

Adds a thing to a thing group.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { IoTClient, AddThingToThingGroupCommand } from "@aws-sdk/client-iot"; // ES Modules import + * // const { IoTClient, AddThingToThingGroupCommand } = require("@aws-sdk/client-iot"); // CommonJS import + * const client = new IoTClient(config); + * const command = new AddThingToThingGroupCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link AddThingToThingGroupCommandInput} for command's `input` shape. + * @see {@link AddThingToThingGroupCommandOutput} for command's `response` shape. + * @see {@link IoTClientResolvedConfig | config} for command's `input` shape. + * */ export class AddThingToThingGroupCommand extends $Command< AddThingToThingGroupCommandInput, diff --git a/clients/client-iot/commands/AssociateTargetsWithJobCommand.ts b/clients/client-iot/commands/AssociateTargetsWithJobCommand.ts index 9501edfbe1b7..830821974141 100644 --- a/clients/client-iot/commands/AssociateTargetsWithJobCommand.ts +++ b/clients/client-iot/commands/AssociateTargetsWithJobCommand.ts @@ -34,6 +34,20 @@ export interface AssociateTargetsWithJobCommandOutput extends AssociateTargetsWi *

The total number of targets associated with a job must not exceed 100.

* * + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { IoTClient, AssociateTargetsWithJobCommand } from "@aws-sdk/client-iot"; // ES Modules import + * // const { IoTClient, AssociateTargetsWithJobCommand } = require("@aws-sdk/client-iot"); // CommonJS import + * const client = new IoTClient(config); + * const command = new AssociateTargetsWithJobCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link AssociateTargetsWithJobCommandInput} for command's `input` shape. + * @see {@link AssociateTargetsWithJobCommandOutput} for command's `response` shape. + * @see {@link IoTClientResolvedConfig | config} for command's `input` shape. + * */ export class AssociateTargetsWithJobCommand extends $Command< AssociateTargetsWithJobCommandInput, diff --git a/clients/client-iot/commands/AttachPolicyCommand.ts b/clients/client-iot/commands/AttachPolicyCommand.ts index 368cae471e5b..b477aa6ad60f 100644 --- a/clients/client-iot/commands/AttachPolicyCommand.ts +++ b/clients/client-iot/commands/AttachPolicyCommand.ts @@ -22,6 +22,20 @@ export interface AttachPolicyCommandOutput extends __MetadataBearer {} /** *

Attaches a policy to the specified target.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { IoTClient, AttachPolicyCommand } from "@aws-sdk/client-iot"; // ES Modules import + * // const { IoTClient, AttachPolicyCommand } = require("@aws-sdk/client-iot"); // CommonJS import + * const client = new IoTClient(config); + * const command = new AttachPolicyCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link AttachPolicyCommandInput} for command's `input` shape. + * @see {@link AttachPolicyCommandOutput} for command's `response` shape. + * @see {@link IoTClientResolvedConfig | config} for command's `input` shape. + * */ export class AttachPolicyCommand extends $Command< AttachPolicyCommandInput, diff --git a/clients/client-iot/commands/AttachPrincipalPolicyCommand.ts b/clients/client-iot/commands/AttachPrincipalPolicyCommand.ts index 9d2af899c364..d48100fbb53d 100644 --- a/clients/client-iot/commands/AttachPrincipalPolicyCommand.ts +++ b/clients/client-iot/commands/AttachPrincipalPolicyCommand.ts @@ -27,6 +27,20 @@ export interface AttachPrincipalPolicyCommandOutput extends __MetadataBearer {} * credential).

*

* Note: This API is deprecated. Please use AttachPolicy instead.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { IoTClient, AttachPrincipalPolicyCommand } from "@aws-sdk/client-iot"; // ES Modules import + * // const { IoTClient, AttachPrincipalPolicyCommand } = require("@aws-sdk/client-iot"); // CommonJS import + * const client = new IoTClient(config); + * const command = new AttachPrincipalPolicyCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link AttachPrincipalPolicyCommandInput} for command's `input` shape. + * @see {@link AttachPrincipalPolicyCommandOutput} for command's `response` shape. + * @see {@link IoTClientResolvedConfig | config} for command's `input` shape. + * */ export class AttachPrincipalPolicyCommand extends $Command< AttachPrincipalPolicyCommandInput, diff --git a/clients/client-iot/commands/AttachSecurityProfileCommand.ts b/clients/client-iot/commands/AttachSecurityProfileCommand.ts index 524f82a971d7..4bbed5d81c2c 100644 --- a/clients/client-iot/commands/AttachSecurityProfileCommand.ts +++ b/clients/client-iot/commands/AttachSecurityProfileCommand.ts @@ -23,6 +23,20 @@ export interface AttachSecurityProfileCommandOutput extends AttachSecurityProfil /** *

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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { IoTClient, AttachSecurityProfileCommand } from "@aws-sdk/client-iot"; // ES Modules import + * // const { IoTClient, AttachSecurityProfileCommand } = require("@aws-sdk/client-iot"); // CommonJS import + * const client = new IoTClient(config); + * const command = new AttachSecurityProfileCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link AttachSecurityProfileCommandInput} for command's `input` shape. + * @see {@link AttachSecurityProfileCommandOutput} for command's `response` shape. + * @see {@link IoTClientResolvedConfig | config} for command's `input` shape. + * */ export class AttachSecurityProfileCommand extends $Command< AttachSecurityProfileCommandInput, diff --git a/clients/client-iot/commands/AttachThingPrincipalCommand.ts b/clients/client-iot/commands/AttachThingPrincipalCommand.ts index c19c27fe9bc0..a597af88325d 100644 --- a/clients/client-iot/commands/AttachThingPrincipalCommand.ts +++ b/clients/client-iot/commands/AttachThingPrincipalCommand.ts @@ -24,6 +24,20 @@ export interface AttachThingPrincipalCommandOutput extends AttachThingPrincipalR *

Attaches the specified principal to the specified thing. A principal can be X.509 * certificates, IAM users, groups, and roles, Amazon Cognito identities or federated * identities.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { IoTClient, AttachThingPrincipalCommand } from "@aws-sdk/client-iot"; // ES Modules import + * // const { IoTClient, AttachThingPrincipalCommand } = require("@aws-sdk/client-iot"); // CommonJS import + * const client = new IoTClient(config); + * const command = new AttachThingPrincipalCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link AttachThingPrincipalCommandInput} for command's `input` shape. + * @see {@link AttachThingPrincipalCommandOutput} for command's `response` shape. + * @see {@link IoTClientResolvedConfig | config} for command's `input` shape. + * */ export class AttachThingPrincipalCommand extends $Command< AttachThingPrincipalCommandInput, diff --git a/clients/client-iot/commands/CancelAuditMitigationActionsTaskCommand.ts b/clients/client-iot/commands/CancelAuditMitigationActionsTaskCommand.ts index 9248a3a30bd8..5f2488619f5c 100644 --- a/clients/client-iot/commands/CancelAuditMitigationActionsTaskCommand.ts +++ b/clients/client-iot/commands/CancelAuditMitigationActionsTaskCommand.ts @@ -26,6 +26,20 @@ export interface CancelAuditMitigationActionsTaskCommandOutput *

Cancels a mitigation action task that is in progress. If the task * is not * in progress, an InvalidRequestException occurs.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { IoTClient, CancelAuditMitigationActionsTaskCommand } from "@aws-sdk/client-iot"; // ES Modules import + * // const { IoTClient, CancelAuditMitigationActionsTaskCommand } = require("@aws-sdk/client-iot"); // CommonJS import + * const client = new IoTClient(config); + * const command = new CancelAuditMitigationActionsTaskCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CancelAuditMitigationActionsTaskCommandInput} for command's `input` shape. + * @see {@link CancelAuditMitigationActionsTaskCommandOutput} for command's `response` shape. + * @see {@link IoTClientResolvedConfig | config} for command's `input` shape. + * */ export class CancelAuditMitigationActionsTaskCommand extends $Command< CancelAuditMitigationActionsTaskCommandInput, diff --git a/clients/client-iot/commands/CancelAuditTaskCommand.ts b/clients/client-iot/commands/CancelAuditTaskCommand.ts index 73a7e44e7062..f9a90326681f 100644 --- a/clients/client-iot/commands/CancelAuditTaskCommand.ts +++ b/clients/client-iot/commands/CancelAuditTaskCommand.ts @@ -22,6 +22,20 @@ export interface CancelAuditTaskCommandOutput extends CancelAuditTaskResponse, _ /** *

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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { IoTClient, CancelAuditTaskCommand } from "@aws-sdk/client-iot"; // ES Modules import + * // const { IoTClient, CancelAuditTaskCommand } = require("@aws-sdk/client-iot"); // CommonJS import + * const client = new IoTClient(config); + * const command = new CancelAuditTaskCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CancelAuditTaskCommandInput} for command's `input` shape. + * @see {@link CancelAuditTaskCommandOutput} for command's `response` shape. + * @see {@link IoTClientResolvedConfig | config} for command's `input` shape. + * */ export class CancelAuditTaskCommand extends $Command< CancelAuditTaskCommandInput, diff --git a/clients/client-iot/commands/CancelCertificateTransferCommand.ts b/clients/client-iot/commands/CancelCertificateTransferCommand.ts index 7face5b4413d..a7c44a7f607c 100644 --- a/clients/client-iot/commands/CancelCertificateTransferCommand.ts +++ b/clients/client-iot/commands/CancelCertificateTransferCommand.ts @@ -29,6 +29,20 @@ export interface CancelCertificateTransferCommandOutput extends __MetadataBearer * 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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { IoTClient, CancelCertificateTransferCommand } from "@aws-sdk/client-iot"; // ES Modules import + * // const { IoTClient, CancelCertificateTransferCommand } = require("@aws-sdk/client-iot"); // CommonJS import + * const client = new IoTClient(config); + * const command = new CancelCertificateTransferCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CancelCertificateTransferCommandInput} for command's `input` shape. + * @see {@link CancelCertificateTransferCommandOutput} for command's `response` shape. + * @see {@link IoTClientResolvedConfig | config} for command's `input` shape. + * */ export class CancelCertificateTransferCommand extends $Command< CancelCertificateTransferCommandInput, diff --git a/clients/client-iot/commands/CancelDetectMitigationActionsTaskCommand.ts b/clients/client-iot/commands/CancelDetectMitigationActionsTaskCommand.ts index e2906f0e4dc6..13c181016523 100644 --- a/clients/client-iot/commands/CancelDetectMitigationActionsTaskCommand.ts +++ b/clients/client-iot/commands/CancelDetectMitigationActionsTaskCommand.ts @@ -29,6 +29,20 @@ export interface CancelDetectMitigationActionsTaskCommandOutput *

* Cancels a Device Defender ML Detect mitigation action. *

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { IoTClient, CancelDetectMitigationActionsTaskCommand } from "@aws-sdk/client-iot"; // ES Modules import + * // const { IoTClient, CancelDetectMitigationActionsTaskCommand } = require("@aws-sdk/client-iot"); // CommonJS import + * const client = new IoTClient(config); + * const command = new CancelDetectMitigationActionsTaskCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CancelDetectMitigationActionsTaskCommandInput} for command's `input` shape. + * @see {@link CancelDetectMitigationActionsTaskCommandOutput} for command's `response` shape. + * @see {@link IoTClientResolvedConfig | config} for command's `input` shape. + * */ export class CancelDetectMitigationActionsTaskCommand extends $Command< CancelDetectMitigationActionsTaskCommandInput, diff --git a/clients/client-iot/commands/CancelJobCommand.ts b/clients/client-iot/commands/CancelJobCommand.ts index 55367f4088f5..de0e140a07da 100644 --- a/clients/client-iot/commands/CancelJobCommand.ts +++ b/clients/client-iot/commands/CancelJobCommand.ts @@ -22,6 +22,20 @@ export interface CancelJobCommandOutput extends CancelJobResponse, __MetadataBea /** *

Cancels a job.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { IoTClient, CancelJobCommand } from "@aws-sdk/client-iot"; // ES Modules import + * // const { IoTClient, CancelJobCommand } = require("@aws-sdk/client-iot"); // CommonJS import + * const client = new IoTClient(config); + * const command = new CancelJobCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CancelJobCommandInput} for command's `input` shape. + * @see {@link CancelJobCommandOutput} for command's `response` shape. + * @see {@link IoTClientResolvedConfig | config} for command's `input` shape. + * */ export class CancelJobCommand extends $Command { // Start section: command_properties diff --git a/clients/client-iot/commands/CancelJobExecutionCommand.ts b/clients/client-iot/commands/CancelJobExecutionCommand.ts index 364b4aa26e46..1bf28637a9ec 100644 --- a/clients/client-iot/commands/CancelJobExecutionCommand.ts +++ b/clients/client-iot/commands/CancelJobExecutionCommand.ts @@ -22,6 +22,20 @@ export interface CancelJobExecutionCommandOutput extends __MetadataBearer {} /** *

Cancels the execution of a job for a given thing.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { IoTClient, CancelJobExecutionCommand } from "@aws-sdk/client-iot"; // ES Modules import + * // const { IoTClient, CancelJobExecutionCommand } = require("@aws-sdk/client-iot"); // CommonJS import + * const client = new IoTClient(config); + * const command = new CancelJobExecutionCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CancelJobExecutionCommandInput} for command's `input` shape. + * @see {@link CancelJobExecutionCommandOutput} for command's `response` shape. + * @see {@link IoTClientResolvedConfig | config} for command's `input` shape. + * */ export class CancelJobExecutionCommand extends $Command< CancelJobExecutionCommandInput, diff --git a/clients/client-iot/commands/ClearDefaultAuthorizerCommand.ts b/clients/client-iot/commands/ClearDefaultAuthorizerCommand.ts index 44afdb13230f..9ebdfd5a7fa8 100644 --- a/clients/client-iot/commands/ClearDefaultAuthorizerCommand.ts +++ b/clients/client-iot/commands/ClearDefaultAuthorizerCommand.ts @@ -22,6 +22,20 @@ export interface ClearDefaultAuthorizerCommandOutput extends ClearDefaultAuthori /** *

Clears the default authorizer.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { IoTClient, ClearDefaultAuthorizerCommand } from "@aws-sdk/client-iot"; // ES Modules import + * // const { IoTClient, ClearDefaultAuthorizerCommand } = require("@aws-sdk/client-iot"); // CommonJS import + * const client = new IoTClient(config); + * const command = new ClearDefaultAuthorizerCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ClearDefaultAuthorizerCommandInput} for command's `input` shape. + * @see {@link ClearDefaultAuthorizerCommandOutput} for command's `response` shape. + * @see {@link IoTClientResolvedConfig | config} for command's `input` shape. + * */ export class ClearDefaultAuthorizerCommand extends $Command< ClearDefaultAuthorizerCommandInput, diff --git a/clients/client-iot/commands/ConfirmTopicRuleDestinationCommand.ts b/clients/client-iot/commands/ConfirmTopicRuleDestinationCommand.ts index 7964939ae60d..2aa477344c8e 100644 --- a/clients/client-iot/commands/ConfirmTopicRuleDestinationCommand.ts +++ b/clients/client-iot/commands/ConfirmTopicRuleDestinationCommand.ts @@ -27,6 +27,20 @@ export interface ConfirmTopicRuleDestinationCommandOutput * 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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { IoTClient, ConfirmTopicRuleDestinationCommand } from "@aws-sdk/client-iot"; // ES Modules import + * // const { IoTClient, ConfirmTopicRuleDestinationCommand } = require("@aws-sdk/client-iot"); // CommonJS import + * const client = new IoTClient(config); + * const command = new ConfirmTopicRuleDestinationCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ConfirmTopicRuleDestinationCommandInput} for command's `input` shape. + * @see {@link ConfirmTopicRuleDestinationCommandOutput} for command's `response` shape. + * @see {@link IoTClientResolvedConfig | config} for command's `input` shape. + * */ export class ConfirmTopicRuleDestinationCommand extends $Command< ConfirmTopicRuleDestinationCommandInput, diff --git a/clients/client-iot/commands/CreateAuditSuppressionCommand.ts b/clients/client-iot/commands/CreateAuditSuppressionCommand.ts index a604beb5635e..62a85eb9dce3 100644 --- a/clients/client-iot/commands/CreateAuditSuppressionCommand.ts +++ b/clients/client-iot/commands/CreateAuditSuppressionCommand.ts @@ -24,6 +24,20 @@ export interface CreateAuditSuppressionCommandOutput extends CreateAuditSuppress *

* Creates a Device Defender audit suppression. *

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { IoTClient, CreateAuditSuppressionCommand } from "@aws-sdk/client-iot"; // ES Modules import + * // const { IoTClient, CreateAuditSuppressionCommand } = require("@aws-sdk/client-iot"); // CommonJS import + * const client = new IoTClient(config); + * const command = new CreateAuditSuppressionCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreateAuditSuppressionCommandInput} for command's `input` shape. + * @see {@link CreateAuditSuppressionCommandOutput} for command's `response` shape. + * @see {@link IoTClientResolvedConfig | config} for command's `input` shape. + * */ export class CreateAuditSuppressionCommand extends $Command< CreateAuditSuppressionCommandInput, diff --git a/clients/client-iot/commands/CreateAuthorizerCommand.ts b/clients/client-iot/commands/CreateAuthorizerCommand.ts index 1bc7fe1596af..5f4af4496221 100644 --- a/clients/client-iot/commands/CreateAuthorizerCommand.ts +++ b/clients/client-iot/commands/CreateAuthorizerCommand.ts @@ -22,6 +22,20 @@ export interface CreateAuthorizerCommandOutput extends CreateAuthorizerResponse, /** *

Creates an authorizer.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { IoTClient, CreateAuthorizerCommand } from "@aws-sdk/client-iot"; // ES Modules import + * // const { IoTClient, CreateAuthorizerCommand } = require("@aws-sdk/client-iot"); // CommonJS import + * const client = new IoTClient(config); + * const command = new CreateAuthorizerCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreateAuthorizerCommandInput} for command's `input` shape. + * @see {@link CreateAuthorizerCommandOutput} for command's `response` shape. + * @see {@link IoTClientResolvedConfig | config} for command's `input` shape. + * */ export class CreateAuthorizerCommand extends $Command< CreateAuthorizerCommandInput, diff --git a/clients/client-iot/commands/CreateBillingGroupCommand.ts b/clients/client-iot/commands/CreateBillingGroupCommand.ts index 546bd99da49c..e58c3db89841 100644 --- a/clients/client-iot/commands/CreateBillingGroupCommand.ts +++ b/clients/client-iot/commands/CreateBillingGroupCommand.ts @@ -22,6 +22,20 @@ export interface CreateBillingGroupCommandOutput extends CreateBillingGroupRespo /** *

Creates a billing group.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { IoTClient, CreateBillingGroupCommand } from "@aws-sdk/client-iot"; // ES Modules import + * // const { IoTClient, CreateBillingGroupCommand } = require("@aws-sdk/client-iot"); // CommonJS import + * const client = new IoTClient(config); + * const command = new CreateBillingGroupCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreateBillingGroupCommandInput} for command's `input` shape. + * @see {@link CreateBillingGroupCommandOutput} for command's `response` shape. + * @see {@link IoTClientResolvedConfig | config} for command's `input` shape. + * */ export class CreateBillingGroupCommand extends $Command< CreateBillingGroupCommandInput, diff --git a/clients/client-iot/commands/CreateCertificateFromCsrCommand.ts b/clients/client-iot/commands/CreateCertificateFromCsrCommand.ts index 7600a8818c32..c1212a501825 100644 --- a/clients/client-iot/commands/CreateCertificateFromCsrCommand.ts +++ b/clients/client-iot/commands/CreateCertificateFromCsrCommand.ts @@ -56,6 +56,20 @@ export interface CreateCertificateFromCsrCommandOutput extends CreateCertificate * my-csr-directory is:

*

> forfiles /p my-csr-directory /c "cmd /c aws iot create-certificate-from-csr * --certificate-signing-request file://@path"

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { IoTClient, CreateCertificateFromCsrCommand } from "@aws-sdk/client-iot"; // ES Modules import + * // const { IoTClient, CreateCertificateFromCsrCommand } = require("@aws-sdk/client-iot"); // CommonJS import + * const client = new IoTClient(config); + * const command = new CreateCertificateFromCsrCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreateCertificateFromCsrCommandInput} for command's `input` shape. + * @see {@link CreateCertificateFromCsrCommandOutput} for command's `response` shape. + * @see {@link IoTClientResolvedConfig | config} for command's `input` shape. + * */ export class CreateCertificateFromCsrCommand extends $Command< CreateCertificateFromCsrCommandInput, diff --git a/clients/client-iot/commands/CreateCustomMetricCommand.ts b/clients/client-iot/commands/CreateCustomMetricCommand.ts index 426e5411a98e..ff2470d8e456 100644 --- a/clients/client-iot/commands/CreateCustomMetricCommand.ts +++ b/clients/client-iot/commands/CreateCustomMetricCommand.ts @@ -25,6 +25,20 @@ export interface CreateCustomMetricCommandOutput extends CreateCustomMetricRespo * Custom * Metric * published by your devices to Device Defender.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { IoTClient, CreateCustomMetricCommand } from "@aws-sdk/client-iot"; // ES Modules import + * // const { IoTClient, CreateCustomMetricCommand } = require("@aws-sdk/client-iot"); // CommonJS import + * const client = new IoTClient(config); + * const command = new CreateCustomMetricCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreateCustomMetricCommandInput} for command's `input` shape. + * @see {@link CreateCustomMetricCommandOutput} for command's `response` shape. + * @see {@link IoTClientResolvedConfig | config} for command's `input` shape. + * */ export class CreateCustomMetricCommand extends $Command< CreateCustomMetricCommandInput, diff --git a/clients/client-iot/commands/CreateDimensionCommand.ts b/clients/client-iot/commands/CreateDimensionCommand.ts index 26c468f3e09f..ff001392597d 100644 --- a/clients/client-iot/commands/CreateDimensionCommand.ts +++ b/clients/client-iot/commands/CreateDimensionCommand.ts @@ -22,6 +22,20 @@ export interface CreateDimensionCommandOutput extends CreateDimensionResponse, _ /** *

Create a dimension that you can use to limit the scope of a metric used in a security profile for AWS 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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { IoTClient, CreateDimensionCommand } from "@aws-sdk/client-iot"; // ES Modules import + * // const { IoTClient, CreateDimensionCommand } = require("@aws-sdk/client-iot"); // CommonJS import + * const client = new IoTClient(config); + * const command = new CreateDimensionCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreateDimensionCommandInput} for command's `input` shape. + * @see {@link CreateDimensionCommandOutput} for command's `response` shape. + * @see {@link IoTClientResolvedConfig | config} for command's `input` shape. + * */ export class CreateDimensionCommand extends $Command< CreateDimensionCommandInput, diff --git a/clients/client-iot/commands/CreateDomainConfigurationCommand.ts b/clients/client-iot/commands/CreateDomainConfigurationCommand.ts index cdf024c701b0..599f76384409 100644 --- a/clients/client-iot/commands/CreateDomainConfigurationCommand.ts +++ b/clients/client-iot/commands/CreateDomainConfigurationCommand.ts @@ -25,6 +25,20 @@ export interface CreateDomainConfigurationCommandOutput extends CreateDomainConf * *

The domain configuration feature is in public preview and is subject to change.

* + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { IoTClient, CreateDomainConfigurationCommand } from "@aws-sdk/client-iot"; // ES Modules import + * // const { IoTClient, CreateDomainConfigurationCommand } = require("@aws-sdk/client-iot"); // CommonJS import + * const client = new IoTClient(config); + * const command = new CreateDomainConfigurationCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreateDomainConfigurationCommandInput} for command's `input` shape. + * @see {@link CreateDomainConfigurationCommandOutput} for command's `response` shape. + * @see {@link IoTClientResolvedConfig | config} for command's `input` shape. + * */ export class CreateDomainConfigurationCommand extends $Command< CreateDomainConfigurationCommandInput, diff --git a/clients/client-iot/commands/CreateDynamicThingGroupCommand.ts b/clients/client-iot/commands/CreateDynamicThingGroupCommand.ts index 9aea354331f5..7ca1c78feae9 100644 --- a/clients/client-iot/commands/CreateDynamicThingGroupCommand.ts +++ b/clients/client-iot/commands/CreateDynamicThingGroupCommand.ts @@ -22,6 +22,20 @@ export interface CreateDynamicThingGroupCommandOutput extends CreateDynamicThing /** *

Creates a dynamic thing group.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { IoTClient, CreateDynamicThingGroupCommand } from "@aws-sdk/client-iot"; // ES Modules import + * // const { IoTClient, CreateDynamicThingGroupCommand } = require("@aws-sdk/client-iot"); // CommonJS import + * const client = new IoTClient(config); + * const command = new CreateDynamicThingGroupCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreateDynamicThingGroupCommandInput} for command's `input` shape. + * @see {@link CreateDynamicThingGroupCommandOutput} for command's `response` shape. + * @see {@link IoTClientResolvedConfig | config} for command's `input` shape. + * */ export class CreateDynamicThingGroupCommand extends $Command< CreateDynamicThingGroupCommandInput, diff --git a/clients/client-iot/commands/CreateJobCommand.ts b/clients/client-iot/commands/CreateJobCommand.ts index abb655ddb054..0b15ecc3244a 100644 --- a/clients/client-iot/commands/CreateJobCommand.ts +++ b/clients/client-iot/commands/CreateJobCommand.ts @@ -22,6 +22,20 @@ export interface CreateJobCommandOutput extends CreateJobResponse, __MetadataBea /** *

Creates a job.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { IoTClient, CreateJobCommand } from "@aws-sdk/client-iot"; // ES Modules import + * // const { IoTClient, CreateJobCommand } = require("@aws-sdk/client-iot"); // CommonJS import + * const client = new IoTClient(config); + * const command = new CreateJobCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreateJobCommandInput} for command's `input` shape. + * @see {@link CreateJobCommandOutput} for command's `response` shape. + * @see {@link IoTClientResolvedConfig | config} for command's `input` shape. + * */ export class CreateJobCommand extends $Command { // Start section: command_properties diff --git a/clients/client-iot/commands/CreateKeysAndCertificateCommand.ts b/clients/client-iot/commands/CreateKeysAndCertificateCommand.ts index 58171ba76537..89f20462cb9c 100644 --- a/clients/client-iot/commands/CreateKeysAndCertificateCommand.ts +++ b/clients/client-iot/commands/CreateKeysAndCertificateCommand.ts @@ -27,6 +27,20 @@ export interface CreateKeysAndCertificateCommandOutput extends CreateKeysAndCert *

* Note This is the only time AWS IoT issues the private key * for this certificate, so it is important to keep it in a secure location.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { IoTClient, CreateKeysAndCertificateCommand } from "@aws-sdk/client-iot"; // ES Modules import + * // const { IoTClient, CreateKeysAndCertificateCommand } = require("@aws-sdk/client-iot"); // CommonJS import + * const client = new IoTClient(config); + * const command = new CreateKeysAndCertificateCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreateKeysAndCertificateCommandInput} for command's `input` shape. + * @see {@link CreateKeysAndCertificateCommandOutput} for command's `response` shape. + * @see {@link IoTClientResolvedConfig | config} for command's `input` shape. + * */ export class CreateKeysAndCertificateCommand extends $Command< CreateKeysAndCertificateCommandInput, diff --git a/clients/client-iot/commands/CreateMitigationActionCommand.ts b/clients/client-iot/commands/CreateMitigationActionCommand.ts index 3a47a9255a05..fbe39f382851 100644 --- a/clients/client-iot/commands/CreateMitigationActionCommand.ts +++ b/clients/client-iot/commands/CreateMitigationActionCommand.ts @@ -22,6 +22,20 @@ export interface CreateMitigationActionCommandOutput extends CreateMitigationAct /** *

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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { IoTClient, CreateMitigationActionCommand } from "@aws-sdk/client-iot"; // ES Modules import + * // const { IoTClient, CreateMitigationActionCommand } = require("@aws-sdk/client-iot"); // CommonJS import + * const client = new IoTClient(config); + * const command = new CreateMitigationActionCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreateMitigationActionCommandInput} for command's `input` shape. + * @see {@link CreateMitigationActionCommandOutput} for command's `response` shape. + * @see {@link IoTClientResolvedConfig | config} for command's `input` shape. + * */ export class CreateMitigationActionCommand extends $Command< CreateMitigationActionCommandInput, diff --git a/clients/client-iot/commands/CreateOTAUpdateCommand.ts b/clients/client-iot/commands/CreateOTAUpdateCommand.ts index 1b36fe6122eb..6d3fa7c71aaf 100644 --- a/clients/client-iot/commands/CreateOTAUpdateCommand.ts +++ b/clients/client-iot/commands/CreateOTAUpdateCommand.ts @@ -22,6 +22,20 @@ export interface CreateOTAUpdateCommandOutput extends CreateOTAUpdateResponse, _ /** *

Creates an AWS IoT OTAUpdate on a target group of things or groups.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { IoTClient, CreateOTAUpdateCommand } from "@aws-sdk/client-iot"; // ES Modules import + * // const { IoTClient, CreateOTAUpdateCommand } = require("@aws-sdk/client-iot"); // CommonJS import + * const client = new IoTClient(config); + * const command = new CreateOTAUpdateCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreateOTAUpdateCommandInput} for command's `input` shape. + * @see {@link CreateOTAUpdateCommandOutput} for command's `response` shape. + * @see {@link IoTClientResolvedConfig | config} for command's `input` shape. + * */ export class CreateOTAUpdateCommand extends $Command< CreateOTAUpdateCommandInput, diff --git a/clients/client-iot/commands/CreatePolicyCommand.ts b/clients/client-iot/commands/CreatePolicyCommand.ts index ac97c5a3f09c..3a158df76e12 100644 --- a/clients/client-iot/commands/CreatePolicyCommand.ts +++ b/clients/client-iot/commands/CreatePolicyCommand.ts @@ -25,6 +25,20 @@ export interface CreatePolicyCommandOutput extends CreatePolicyResponse, __Metad *

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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { IoTClient, CreatePolicyCommand } from "@aws-sdk/client-iot"; // ES Modules import + * // const { IoTClient, CreatePolicyCommand } = require("@aws-sdk/client-iot"); // CommonJS import + * const client = new IoTClient(config); + * const command = new CreatePolicyCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreatePolicyCommandInput} for command's `input` shape. + * @see {@link CreatePolicyCommandOutput} for command's `response` shape. + * @see {@link IoTClientResolvedConfig | config} for command's `input` shape. + * */ export class CreatePolicyCommand extends $Command< CreatePolicyCommandInput, diff --git a/clients/client-iot/commands/CreatePolicyVersionCommand.ts b/clients/client-iot/commands/CreatePolicyVersionCommand.ts index 7f23c0d9845a..dbaf01f9191f 100644 --- a/clients/client-iot/commands/CreatePolicyVersionCommand.ts +++ b/clients/client-iot/commands/CreatePolicyVersionCommand.ts @@ -28,6 +28,20 @@ export interface CreatePolicyVersionCommandOutput extends CreatePolicyVersionRes *

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).

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { IoTClient, CreatePolicyVersionCommand } from "@aws-sdk/client-iot"; // ES Modules import + * // const { IoTClient, CreatePolicyVersionCommand } = require("@aws-sdk/client-iot"); // CommonJS import + * const client = new IoTClient(config); + * const command = new CreatePolicyVersionCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreatePolicyVersionCommandInput} for command's `input` shape. + * @see {@link CreatePolicyVersionCommandOutput} for command's `response` shape. + * @see {@link IoTClientResolvedConfig | config} for command's `input` shape. + * */ export class CreatePolicyVersionCommand extends $Command< CreatePolicyVersionCommandInput, diff --git a/clients/client-iot/commands/CreateProvisioningClaimCommand.ts b/clients/client-iot/commands/CreateProvisioningClaimCommand.ts index 44ee5d95bcfe..925e56ceed4b 100644 --- a/clients/client-iot/commands/CreateProvisioningClaimCommand.ts +++ b/clients/client-iot/commands/CreateProvisioningClaimCommand.ts @@ -22,6 +22,20 @@ export interface CreateProvisioningClaimCommandOutput extends CreateProvisioning /** *

Creates a provisioning claim.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { IoTClient, CreateProvisioningClaimCommand } from "@aws-sdk/client-iot"; // ES Modules import + * // const { IoTClient, CreateProvisioningClaimCommand } = require("@aws-sdk/client-iot"); // CommonJS import + * const client = new IoTClient(config); + * const command = new CreateProvisioningClaimCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreateProvisioningClaimCommandInput} for command's `input` shape. + * @see {@link CreateProvisioningClaimCommandOutput} for command's `response` shape. + * @see {@link IoTClientResolvedConfig | config} for command's `input` shape. + * */ export class CreateProvisioningClaimCommand extends $Command< CreateProvisioningClaimCommandInput, diff --git a/clients/client-iot/commands/CreateProvisioningTemplateCommand.ts b/clients/client-iot/commands/CreateProvisioningTemplateCommand.ts index 501826092004..e805f65e81c4 100644 --- a/clients/client-iot/commands/CreateProvisioningTemplateCommand.ts +++ b/clients/client-iot/commands/CreateProvisioningTemplateCommand.ts @@ -22,6 +22,20 @@ export interface CreateProvisioningTemplateCommandOutput extends CreateProvision /** *

Creates a fleet provisioning template.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { IoTClient, CreateProvisioningTemplateCommand } from "@aws-sdk/client-iot"; // ES Modules import + * // const { IoTClient, CreateProvisioningTemplateCommand } = require("@aws-sdk/client-iot"); // CommonJS import + * const client = new IoTClient(config); + * const command = new CreateProvisioningTemplateCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreateProvisioningTemplateCommandInput} for command's `input` shape. + * @see {@link CreateProvisioningTemplateCommandOutput} for command's `response` shape. + * @see {@link IoTClientResolvedConfig | config} for command's `input` shape. + * */ export class CreateProvisioningTemplateCommand extends $Command< CreateProvisioningTemplateCommandInput, diff --git a/clients/client-iot/commands/CreateProvisioningTemplateVersionCommand.ts b/clients/client-iot/commands/CreateProvisioningTemplateVersionCommand.ts index 073ac1cfe9b4..121eda630baf 100644 --- a/clients/client-iot/commands/CreateProvisioningTemplateVersionCommand.ts +++ b/clients/client-iot/commands/CreateProvisioningTemplateVersionCommand.ts @@ -27,6 +27,20 @@ export interface CreateProvisioningTemplateVersionCommandOutput /** *

Creates a new version of a fleet provisioning template.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { IoTClient, CreateProvisioningTemplateVersionCommand } from "@aws-sdk/client-iot"; // ES Modules import + * // const { IoTClient, CreateProvisioningTemplateVersionCommand } = require("@aws-sdk/client-iot"); // CommonJS import + * const client = new IoTClient(config); + * const command = new CreateProvisioningTemplateVersionCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreateProvisioningTemplateVersionCommandInput} for command's `input` shape. + * @see {@link CreateProvisioningTemplateVersionCommandOutput} for command's `response` shape. + * @see {@link IoTClientResolvedConfig | config} for command's `input` shape. + * */ export class CreateProvisioningTemplateVersionCommand extends $Command< CreateProvisioningTemplateVersionCommandInput, diff --git a/clients/client-iot/commands/CreateRoleAliasCommand.ts b/clients/client-iot/commands/CreateRoleAliasCommand.ts index d609596fd43f..8d749306ddc5 100644 --- a/clients/client-iot/commands/CreateRoleAliasCommand.ts +++ b/clients/client-iot/commands/CreateRoleAliasCommand.ts @@ -22,6 +22,20 @@ export interface CreateRoleAliasCommandOutput extends CreateRoleAliasResponse, _ /** *

Creates a role alias.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { IoTClient, CreateRoleAliasCommand } from "@aws-sdk/client-iot"; // ES Modules import + * // const { IoTClient, CreateRoleAliasCommand } = require("@aws-sdk/client-iot"); // CommonJS import + * const client = new IoTClient(config); + * const command = new CreateRoleAliasCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreateRoleAliasCommandInput} for command's `input` shape. + * @see {@link CreateRoleAliasCommandOutput} for command's `response` shape. + * @see {@link IoTClientResolvedConfig | config} for command's `input` shape. + * */ export class CreateRoleAliasCommand extends $Command< CreateRoleAliasCommandInput, diff --git a/clients/client-iot/commands/CreateScheduledAuditCommand.ts b/clients/client-iot/commands/CreateScheduledAuditCommand.ts index 7b1ec8dd0878..a013802e8cfe 100644 --- a/clients/client-iot/commands/CreateScheduledAuditCommand.ts +++ b/clients/client-iot/commands/CreateScheduledAuditCommand.ts @@ -23,6 +23,20 @@ export interface CreateScheduledAuditCommandOutput extends CreateScheduledAuditR /** *

Creates a scheduled audit that is run at a specified * time interval.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { IoTClient, CreateScheduledAuditCommand } from "@aws-sdk/client-iot"; // ES Modules import + * // const { IoTClient, CreateScheduledAuditCommand } = require("@aws-sdk/client-iot"); // CommonJS import + * const client = new IoTClient(config); + * const command = new CreateScheduledAuditCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreateScheduledAuditCommandInput} for command's `input` shape. + * @see {@link CreateScheduledAuditCommandOutput} for command's `response` shape. + * @see {@link IoTClientResolvedConfig | config} for command's `input` shape. + * */ export class CreateScheduledAuditCommand extends $Command< CreateScheduledAuditCommandInput, diff --git a/clients/client-iot/commands/CreateSecurityProfileCommand.ts b/clients/client-iot/commands/CreateSecurityProfileCommand.ts index 1edf47c850fb..ecbf19c56009 100644 --- a/clients/client-iot/commands/CreateSecurityProfileCommand.ts +++ b/clients/client-iot/commands/CreateSecurityProfileCommand.ts @@ -22,6 +22,20 @@ export interface CreateSecurityProfileCommandOutput extends CreateSecurityProfil /** *

Creates a Device Defender security profile.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { IoTClient, CreateSecurityProfileCommand } from "@aws-sdk/client-iot"; // ES Modules import + * // const { IoTClient, CreateSecurityProfileCommand } = require("@aws-sdk/client-iot"); // CommonJS import + * const client = new IoTClient(config); + * const command = new CreateSecurityProfileCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreateSecurityProfileCommandInput} for command's `input` shape. + * @see {@link CreateSecurityProfileCommandOutput} for command's `response` shape. + * @see {@link IoTClientResolvedConfig | config} for command's `input` shape. + * */ export class CreateSecurityProfileCommand extends $Command< CreateSecurityProfileCommandInput, diff --git a/clients/client-iot/commands/CreateStreamCommand.ts b/clients/client-iot/commands/CreateStreamCommand.ts index 135cd0895eea..c83140244d4c 100644 --- a/clients/client-iot/commands/CreateStreamCommand.ts +++ b/clients/client-iot/commands/CreateStreamCommand.ts @@ -24,6 +24,20 @@ export interface CreateStreamCommandOutput extends CreateStreamResponse, __Metad *

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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { IoTClient, CreateStreamCommand } from "@aws-sdk/client-iot"; // ES Modules import + * // const { IoTClient, CreateStreamCommand } = require("@aws-sdk/client-iot"); // CommonJS import + * const client = new IoTClient(config); + * const command = new CreateStreamCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreateStreamCommandInput} for command's `input` shape. + * @see {@link CreateStreamCommandOutput} for command's `response` shape. + * @see {@link IoTClientResolvedConfig | config} for command's `input` shape. + * */ export class CreateStreamCommand extends $Command< CreateStreamCommandInput, diff --git a/clients/client-iot/commands/CreateThingCommand.ts b/clients/client-iot/commands/CreateThingCommand.ts index b556ce3b7c81..e2df9360bfe9 100644 --- a/clients/client-iot/commands/CreateThingCommand.ts +++ b/clients/client-iot/commands/CreateThingCommand.ts @@ -29,6 +29,20 @@ export interface CreateThingCommandOutput extends CreateThingResponse, __Metadat *

This is a control plane operation. See Authorization for * information about authorizing control plane actions.

* + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { IoTClient, CreateThingCommand } from "@aws-sdk/client-iot"; // ES Modules import + * // const { IoTClient, CreateThingCommand } = require("@aws-sdk/client-iot"); // CommonJS import + * const client = new IoTClient(config); + * const command = new CreateThingCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreateThingCommandInput} for command's `input` shape. + * @see {@link CreateThingCommandOutput} for command's `response` shape. + * @see {@link IoTClientResolvedConfig | config} for command's `input` shape. + * */ export class CreateThingCommand extends $Command< CreateThingCommandInput, diff --git a/clients/client-iot/commands/CreateThingGroupCommand.ts b/clients/client-iot/commands/CreateThingGroupCommand.ts index c4597190b611..fba741f3be2e 100644 --- a/clients/client-iot/commands/CreateThingGroupCommand.ts +++ b/clients/client-iot/commands/CreateThingGroupCommand.ts @@ -26,6 +26,20 @@ export interface CreateThingGroupCommandOutput extends CreateThingGroupResponse, *

This is a control plane operation. See Authorization for * information about authorizing control plane actions.

* + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { IoTClient, CreateThingGroupCommand } from "@aws-sdk/client-iot"; // ES Modules import + * // const { IoTClient, CreateThingGroupCommand } = require("@aws-sdk/client-iot"); // CommonJS import + * const client = new IoTClient(config); + * const command = new CreateThingGroupCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreateThingGroupCommandInput} for command's `input` shape. + * @see {@link CreateThingGroupCommandOutput} for command's `response` shape. + * @see {@link IoTClientResolvedConfig | config} for command's `input` shape. + * */ export class CreateThingGroupCommand extends $Command< CreateThingGroupCommandInput, diff --git a/clients/client-iot/commands/CreateThingTypeCommand.ts b/clients/client-iot/commands/CreateThingTypeCommand.ts index e4cb273bf80b..b9336c04f6cc 100644 --- a/clients/client-iot/commands/CreateThingTypeCommand.ts +++ b/clients/client-iot/commands/CreateThingTypeCommand.ts @@ -22,6 +22,20 @@ export interface CreateThingTypeCommandOutput extends CreateThingTypeResponse, _ /** *

Creates a new thing type.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { IoTClient, CreateThingTypeCommand } from "@aws-sdk/client-iot"; // ES Modules import + * // const { IoTClient, CreateThingTypeCommand } = require("@aws-sdk/client-iot"); // CommonJS import + * const client = new IoTClient(config); + * const command = new CreateThingTypeCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreateThingTypeCommandInput} for command's `input` shape. + * @see {@link CreateThingTypeCommandOutput} for command's `response` shape. + * @see {@link IoTClientResolvedConfig | config} for command's `input` shape. + * */ export class CreateThingTypeCommand extends $Command< CreateThingTypeCommandInput, diff --git a/clients/client-iot/commands/CreateTopicRuleCommand.ts b/clients/client-iot/commands/CreateTopicRuleCommand.ts index 283257de5e97..503b5162d3ec 100644 --- a/clients/client-iot/commands/CreateTopicRuleCommand.ts +++ b/clients/client-iot/commands/CreateTopicRuleCommand.ts @@ -23,6 +23,20 @@ export interface CreateTopicRuleCommandOutput extends __MetadataBearer {} /** *

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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { IoTClient, CreateTopicRuleCommand } from "@aws-sdk/client-iot"; // ES Modules import + * // const { IoTClient, CreateTopicRuleCommand } = require("@aws-sdk/client-iot"); // CommonJS import + * const client = new IoTClient(config); + * const command = new CreateTopicRuleCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreateTopicRuleCommandInput} for command's `input` shape. + * @see {@link CreateTopicRuleCommandOutput} for command's `response` shape. + * @see {@link IoTClientResolvedConfig | config} for command's `input` shape. + * */ export class CreateTopicRuleCommand extends $Command< CreateTopicRuleCommandInput, diff --git a/clients/client-iot/commands/CreateTopicRuleDestinationCommand.ts b/clients/client-iot/commands/CreateTopicRuleDestinationCommand.ts index 8dc32812d440..1adf2640bc89 100644 --- a/clients/client-iot/commands/CreateTopicRuleDestinationCommand.ts +++ b/clients/client-iot/commands/CreateTopicRuleDestinationCommand.ts @@ -22,6 +22,20 @@ export interface CreateTopicRuleDestinationCommandOutput extends CreateTopicRule /** *

Creates a topic rule destination. The destination must be confirmed prior to use.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { IoTClient, CreateTopicRuleDestinationCommand } from "@aws-sdk/client-iot"; // ES Modules import + * // const { IoTClient, CreateTopicRuleDestinationCommand } = require("@aws-sdk/client-iot"); // CommonJS import + * const client = new IoTClient(config); + * const command = new CreateTopicRuleDestinationCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreateTopicRuleDestinationCommandInput} for command's `input` shape. + * @see {@link CreateTopicRuleDestinationCommandOutput} for command's `response` shape. + * @see {@link IoTClientResolvedConfig | config} for command's `input` shape. + * */ export class CreateTopicRuleDestinationCommand extends $Command< CreateTopicRuleDestinationCommandInput, diff --git a/clients/client-iot/commands/DeleteAccountAuditConfigurationCommand.ts b/clients/client-iot/commands/DeleteAccountAuditConfigurationCommand.ts index 044c9209295d..f1f0f490885a 100644 --- a/clients/client-iot/commands/DeleteAccountAuditConfigurationCommand.ts +++ b/clients/client-iot/commands/DeleteAccountAuditConfigurationCommand.ts @@ -26,6 +26,20 @@ export interface DeleteAccountAuditConfigurationCommandOutput *

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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { IoTClient, DeleteAccountAuditConfigurationCommand } from "@aws-sdk/client-iot"; // ES Modules import + * // const { IoTClient, DeleteAccountAuditConfigurationCommand } = require("@aws-sdk/client-iot"); // CommonJS import + * const client = new IoTClient(config); + * const command = new DeleteAccountAuditConfigurationCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteAccountAuditConfigurationCommandInput} for command's `input` shape. + * @see {@link DeleteAccountAuditConfigurationCommandOutput} for command's `response` shape. + * @see {@link IoTClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteAccountAuditConfigurationCommand extends $Command< DeleteAccountAuditConfigurationCommandInput, diff --git a/clients/client-iot/commands/DeleteAuditSuppressionCommand.ts b/clients/client-iot/commands/DeleteAuditSuppressionCommand.ts index b970f72faf36..9f7c3a091928 100644 --- a/clients/client-iot/commands/DeleteAuditSuppressionCommand.ts +++ b/clients/client-iot/commands/DeleteAuditSuppressionCommand.ts @@ -24,6 +24,20 @@ export interface DeleteAuditSuppressionCommandOutput extends DeleteAuditSuppress *

* Deletes a Device Defender audit suppression. *

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { IoTClient, DeleteAuditSuppressionCommand } from "@aws-sdk/client-iot"; // ES Modules import + * // const { IoTClient, DeleteAuditSuppressionCommand } = require("@aws-sdk/client-iot"); // CommonJS import + * const client = new IoTClient(config); + * const command = new DeleteAuditSuppressionCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteAuditSuppressionCommandInput} for command's `input` shape. + * @see {@link DeleteAuditSuppressionCommandOutput} for command's `response` shape. + * @see {@link IoTClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteAuditSuppressionCommand extends $Command< DeleteAuditSuppressionCommandInput, diff --git a/clients/client-iot/commands/DeleteAuthorizerCommand.ts b/clients/client-iot/commands/DeleteAuthorizerCommand.ts index 6481fbbeb6b7..52f59c16580d 100644 --- a/clients/client-iot/commands/DeleteAuthorizerCommand.ts +++ b/clients/client-iot/commands/DeleteAuthorizerCommand.ts @@ -22,6 +22,20 @@ export interface DeleteAuthorizerCommandOutput extends DeleteAuthorizerResponse, /** *

Deletes an authorizer.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { IoTClient, DeleteAuthorizerCommand } from "@aws-sdk/client-iot"; // ES Modules import + * // const { IoTClient, DeleteAuthorizerCommand } = require("@aws-sdk/client-iot"); // CommonJS import + * const client = new IoTClient(config); + * const command = new DeleteAuthorizerCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteAuthorizerCommandInput} for command's `input` shape. + * @see {@link DeleteAuthorizerCommandOutput} for command's `response` shape. + * @see {@link IoTClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteAuthorizerCommand extends $Command< DeleteAuthorizerCommandInput, diff --git a/clients/client-iot/commands/DeleteBillingGroupCommand.ts b/clients/client-iot/commands/DeleteBillingGroupCommand.ts index ea0e04553c24..322cbb9cfd43 100644 --- a/clients/client-iot/commands/DeleteBillingGroupCommand.ts +++ b/clients/client-iot/commands/DeleteBillingGroupCommand.ts @@ -22,6 +22,20 @@ export interface DeleteBillingGroupCommandOutput extends DeleteBillingGroupRespo /** *

Deletes the billing group.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { IoTClient, DeleteBillingGroupCommand } from "@aws-sdk/client-iot"; // ES Modules import + * // const { IoTClient, DeleteBillingGroupCommand } = require("@aws-sdk/client-iot"); // CommonJS import + * const client = new IoTClient(config); + * const command = new DeleteBillingGroupCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteBillingGroupCommandInput} for command's `input` shape. + * @see {@link DeleteBillingGroupCommandOutput} for command's `response` shape. + * @see {@link IoTClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteBillingGroupCommand extends $Command< DeleteBillingGroupCommandInput, diff --git a/clients/client-iot/commands/DeleteCACertificateCommand.ts b/clients/client-iot/commands/DeleteCACertificateCommand.ts index 3e2467b6ca68..2603061a6ff9 100644 --- a/clients/client-iot/commands/DeleteCACertificateCommand.ts +++ b/clients/client-iot/commands/DeleteCACertificateCommand.ts @@ -22,6 +22,20 @@ export interface DeleteCACertificateCommandOutput extends DeleteCACertificateRes /** *

Deletes a registered CA certificate.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { IoTClient, DeleteCACertificateCommand } from "@aws-sdk/client-iot"; // ES Modules import + * // const { IoTClient, DeleteCACertificateCommand } = require("@aws-sdk/client-iot"); // CommonJS import + * const client = new IoTClient(config); + * const command = new DeleteCACertificateCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteCACertificateCommandInput} for command's `input` shape. + * @see {@link DeleteCACertificateCommandOutput} for command's `response` shape. + * @see {@link IoTClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteCACertificateCommand extends $Command< DeleteCACertificateCommandInput, diff --git a/clients/client-iot/commands/DeleteCertificateCommand.ts b/clients/client-iot/commands/DeleteCertificateCommand.ts index a857043b42a4..44cff8739c0a 100644 --- a/clients/client-iot/commands/DeleteCertificateCommand.ts +++ b/clients/client-iot/commands/DeleteCertificateCommand.ts @@ -25,6 +25,20 @@ export interface DeleteCertificateCommandOutput extends __MetadataBearer {} *

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 DetachPrincipalPolicy API to detach all policies. Next, use the UpdateCertificate API to set the certificate to the INACTIVE * status.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { IoTClient, DeleteCertificateCommand } from "@aws-sdk/client-iot"; // ES Modules import + * // const { IoTClient, DeleteCertificateCommand } = require("@aws-sdk/client-iot"); // CommonJS import + * const client = new IoTClient(config); + * const command = new DeleteCertificateCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteCertificateCommandInput} for command's `input` shape. + * @see {@link DeleteCertificateCommandOutput} for command's `response` shape. + * @see {@link IoTClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteCertificateCommand extends $Command< DeleteCertificateCommandInput, diff --git a/clients/client-iot/commands/DeleteCustomMetricCommand.ts b/clients/client-iot/commands/DeleteCustomMetricCommand.ts index 94d0ef9a9764..b6bf41350067 100644 --- a/clients/client-iot/commands/DeleteCustomMetricCommand.ts +++ b/clients/client-iot/commands/DeleteCustomMetricCommand.ts @@ -32,6 +32,20 @@ export interface DeleteCustomMetricCommandOutput extends DeleteCustomMetricRespo *

* Deletes a Device Defender detect custom metric. *

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { IoTClient, DeleteCustomMetricCommand } from "@aws-sdk/client-iot"; // ES Modules import + * // const { IoTClient, DeleteCustomMetricCommand } = require("@aws-sdk/client-iot"); // CommonJS import + * const client = new IoTClient(config); + * const command = new DeleteCustomMetricCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteCustomMetricCommandInput} for command's `input` shape. + * @see {@link DeleteCustomMetricCommandOutput} for command's `response` shape. + * @see {@link IoTClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteCustomMetricCommand extends $Command< DeleteCustomMetricCommandInput, diff --git a/clients/client-iot/commands/DeleteDimensionCommand.ts b/clients/client-iot/commands/DeleteDimensionCommand.ts index dba803191471..e1e98282b03a 100644 --- a/clients/client-iot/commands/DeleteDimensionCommand.ts +++ b/clients/client-iot/commands/DeleteDimensionCommand.ts @@ -22,6 +22,20 @@ export interface DeleteDimensionCommandOutput extends DeleteDimensionResponse, _ /** *

Removes the specified dimension from your AWS account.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { IoTClient, DeleteDimensionCommand } from "@aws-sdk/client-iot"; // ES Modules import + * // const { IoTClient, DeleteDimensionCommand } = require("@aws-sdk/client-iot"); // CommonJS import + * const client = new IoTClient(config); + * const command = new DeleteDimensionCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteDimensionCommandInput} for command's `input` shape. + * @see {@link DeleteDimensionCommandOutput} for command's `response` shape. + * @see {@link IoTClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteDimensionCommand extends $Command< DeleteDimensionCommandInput, diff --git a/clients/client-iot/commands/DeleteDomainConfigurationCommand.ts b/clients/client-iot/commands/DeleteDomainConfigurationCommand.ts index 6ca55b4874e8..f5fc877eeb86 100644 --- a/clients/client-iot/commands/DeleteDomainConfigurationCommand.ts +++ b/clients/client-iot/commands/DeleteDomainConfigurationCommand.ts @@ -25,6 +25,20 @@ export interface DeleteDomainConfigurationCommandOutput extends DeleteDomainConf * *

The domain configuration feature is in public preview and is subject to change.

* + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { IoTClient, DeleteDomainConfigurationCommand } from "@aws-sdk/client-iot"; // ES Modules import + * // const { IoTClient, DeleteDomainConfigurationCommand } = require("@aws-sdk/client-iot"); // CommonJS import + * const client = new IoTClient(config); + * const command = new DeleteDomainConfigurationCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteDomainConfigurationCommandInput} for command's `input` shape. + * @see {@link DeleteDomainConfigurationCommandOutput} for command's `response` shape. + * @see {@link IoTClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteDomainConfigurationCommand extends $Command< DeleteDomainConfigurationCommandInput, diff --git a/clients/client-iot/commands/DeleteDynamicThingGroupCommand.ts b/clients/client-iot/commands/DeleteDynamicThingGroupCommand.ts index 831b9137c812..915dc19852da 100644 --- a/clients/client-iot/commands/DeleteDynamicThingGroupCommand.ts +++ b/clients/client-iot/commands/DeleteDynamicThingGroupCommand.ts @@ -22,6 +22,20 @@ export interface DeleteDynamicThingGroupCommandOutput extends DeleteDynamicThing /** *

Deletes a dynamic thing group.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { IoTClient, DeleteDynamicThingGroupCommand } from "@aws-sdk/client-iot"; // ES Modules import + * // const { IoTClient, DeleteDynamicThingGroupCommand } = require("@aws-sdk/client-iot"); // CommonJS import + * const client = new IoTClient(config); + * const command = new DeleteDynamicThingGroupCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteDynamicThingGroupCommandInput} for command's `input` shape. + * @see {@link DeleteDynamicThingGroupCommandOutput} for command's `response` shape. + * @see {@link IoTClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteDynamicThingGroupCommand extends $Command< DeleteDynamicThingGroupCommandInput, diff --git a/clients/client-iot/commands/DeleteJobCommand.ts b/clients/client-iot/commands/DeleteJobCommand.ts index eaa0a5365882..77f7d10a9cdc 100644 --- a/clients/client-iot/commands/DeleteJobCommand.ts +++ b/clients/client-iot/commands/DeleteJobCommand.ts @@ -29,6 +29,20 @@ export interface DeleteJobCommandOutput extends __MetadataBearer {} * 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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { IoTClient, DeleteJobCommand } from "@aws-sdk/client-iot"; // ES Modules import + * // const { IoTClient, DeleteJobCommand } = require("@aws-sdk/client-iot"); // CommonJS import + * const client = new IoTClient(config); + * const command = new DeleteJobCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteJobCommandInput} for command's `input` shape. + * @see {@link DeleteJobCommandOutput} for command's `response` shape. + * @see {@link IoTClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteJobCommand extends $Command { // Start section: command_properties diff --git a/clients/client-iot/commands/DeleteJobExecutionCommand.ts b/clients/client-iot/commands/DeleteJobExecutionCommand.ts index af4e96b9a8a6..45d1142ef3bb 100644 --- a/clients/client-iot/commands/DeleteJobExecutionCommand.ts +++ b/clients/client-iot/commands/DeleteJobExecutionCommand.ts @@ -22,6 +22,20 @@ export interface DeleteJobExecutionCommandOutput extends __MetadataBearer {} /** *

Deletes a job execution.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { IoTClient, DeleteJobExecutionCommand } from "@aws-sdk/client-iot"; // ES Modules import + * // const { IoTClient, DeleteJobExecutionCommand } = require("@aws-sdk/client-iot"); // CommonJS import + * const client = new IoTClient(config); + * const command = new DeleteJobExecutionCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteJobExecutionCommandInput} for command's `input` shape. + * @see {@link DeleteJobExecutionCommandOutput} for command's `response` shape. + * @see {@link IoTClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteJobExecutionCommand extends $Command< DeleteJobExecutionCommandInput, diff --git a/clients/client-iot/commands/DeleteMitigationActionCommand.ts b/clients/client-iot/commands/DeleteMitigationActionCommand.ts index 0ba7be271f66..23c77a0f49fd 100644 --- a/clients/client-iot/commands/DeleteMitigationActionCommand.ts +++ b/clients/client-iot/commands/DeleteMitigationActionCommand.ts @@ -22,6 +22,20 @@ export interface DeleteMitigationActionCommandOutput extends DeleteMitigationAct /** *

Deletes a defined mitigation action from your AWS account.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { IoTClient, DeleteMitigationActionCommand } from "@aws-sdk/client-iot"; // ES Modules import + * // const { IoTClient, DeleteMitigationActionCommand } = require("@aws-sdk/client-iot"); // CommonJS import + * const client = new IoTClient(config); + * const command = new DeleteMitigationActionCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteMitigationActionCommandInput} for command's `input` shape. + * @see {@link DeleteMitigationActionCommandOutput} for command's `response` shape. + * @see {@link IoTClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteMitigationActionCommand extends $Command< DeleteMitigationActionCommandInput, diff --git a/clients/client-iot/commands/DeleteOTAUpdateCommand.ts b/clients/client-iot/commands/DeleteOTAUpdateCommand.ts index fae833f21792..6c2247f1dd5c 100644 --- a/clients/client-iot/commands/DeleteOTAUpdateCommand.ts +++ b/clients/client-iot/commands/DeleteOTAUpdateCommand.ts @@ -22,6 +22,20 @@ export interface DeleteOTAUpdateCommandOutput extends DeleteOTAUpdateResponse, _ /** *

Delete an OTA update.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { IoTClient, DeleteOTAUpdateCommand } from "@aws-sdk/client-iot"; // ES Modules import + * // const { IoTClient, DeleteOTAUpdateCommand } = require("@aws-sdk/client-iot"); // CommonJS import + * const client = new IoTClient(config); + * const command = new DeleteOTAUpdateCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteOTAUpdateCommandInput} for command's `input` shape. + * @see {@link DeleteOTAUpdateCommandOutput} for command's `response` shape. + * @see {@link IoTClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteOTAUpdateCommand extends $Command< DeleteOTAUpdateCommandInput, diff --git a/clients/client-iot/commands/DeletePolicyCommand.ts b/clients/client-iot/commands/DeletePolicyCommand.ts index 409f3945c8b2..70c4773ce4da 100644 --- a/clients/client-iot/commands/DeletePolicyCommand.ts +++ b/clients/client-iot/commands/DeletePolicyCommand.ts @@ -29,6 +29,20 @@ export interface DeletePolicyCommandOutput extends __MetadataBearer {} * certificate; and then use the DeletePolicy API to delete the policy.

*

When a policy is deleted using DeletePolicy, its default version is deleted with * it.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { IoTClient, DeletePolicyCommand } from "@aws-sdk/client-iot"; // ES Modules import + * // const { IoTClient, DeletePolicyCommand } = require("@aws-sdk/client-iot"); // CommonJS import + * const client = new IoTClient(config); + * const command = new DeletePolicyCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeletePolicyCommandInput} for command's `input` shape. + * @see {@link DeletePolicyCommandOutput} for command's `response` shape. + * @see {@link IoTClientResolvedConfig | config} for command's `input` shape. + * */ export class DeletePolicyCommand extends $Command< DeletePolicyCommandInput, diff --git a/clients/client-iot/commands/DeletePolicyVersionCommand.ts b/clients/client-iot/commands/DeletePolicyVersionCommand.ts index 73c99e123af8..126316db62c6 100644 --- a/clients/client-iot/commands/DeletePolicyVersionCommand.ts +++ b/clients/client-iot/commands/DeletePolicyVersionCommand.ts @@ -24,6 +24,20 @@ export interface DeletePolicyVersionCommandOutput extends __MetadataBearer {} *

Deletes the specified version of the specified policy. You cannot delete the default * version of a policy using this API. 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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { IoTClient, DeletePolicyVersionCommand } from "@aws-sdk/client-iot"; // ES Modules import + * // const { IoTClient, DeletePolicyVersionCommand } = require("@aws-sdk/client-iot"); // CommonJS import + * const client = new IoTClient(config); + * const command = new DeletePolicyVersionCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeletePolicyVersionCommandInput} for command's `input` shape. + * @see {@link DeletePolicyVersionCommandOutput} for command's `response` shape. + * @see {@link IoTClientResolvedConfig | config} for command's `input` shape. + * */ export class DeletePolicyVersionCommand extends $Command< DeletePolicyVersionCommandInput, diff --git a/clients/client-iot/commands/DeleteProvisioningTemplateCommand.ts b/clients/client-iot/commands/DeleteProvisioningTemplateCommand.ts index 25cef91cd172..87fb11fb4678 100644 --- a/clients/client-iot/commands/DeleteProvisioningTemplateCommand.ts +++ b/clients/client-iot/commands/DeleteProvisioningTemplateCommand.ts @@ -22,6 +22,20 @@ export interface DeleteProvisioningTemplateCommandOutput extends DeleteProvision /** *

Deletes a fleet provisioning template.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { IoTClient, DeleteProvisioningTemplateCommand } from "@aws-sdk/client-iot"; // ES Modules import + * // const { IoTClient, DeleteProvisioningTemplateCommand } = require("@aws-sdk/client-iot"); // CommonJS import + * const client = new IoTClient(config); + * const command = new DeleteProvisioningTemplateCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteProvisioningTemplateCommandInput} for command's `input` shape. + * @see {@link DeleteProvisioningTemplateCommandOutput} for command's `response` shape. + * @see {@link IoTClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteProvisioningTemplateCommand extends $Command< DeleteProvisioningTemplateCommandInput, diff --git a/clients/client-iot/commands/DeleteProvisioningTemplateVersionCommand.ts b/clients/client-iot/commands/DeleteProvisioningTemplateVersionCommand.ts index 7874c8136e86..43d2413457b2 100644 --- a/clients/client-iot/commands/DeleteProvisioningTemplateVersionCommand.ts +++ b/clients/client-iot/commands/DeleteProvisioningTemplateVersionCommand.ts @@ -27,6 +27,20 @@ export interface DeleteProvisioningTemplateVersionCommandOutput /** *

Deletes a fleet provisioning template version.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { IoTClient, DeleteProvisioningTemplateVersionCommand } from "@aws-sdk/client-iot"; // ES Modules import + * // const { IoTClient, DeleteProvisioningTemplateVersionCommand } = require("@aws-sdk/client-iot"); // CommonJS import + * const client = new IoTClient(config); + * const command = new DeleteProvisioningTemplateVersionCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteProvisioningTemplateVersionCommandInput} for command's `input` shape. + * @see {@link DeleteProvisioningTemplateVersionCommandOutput} for command's `response` shape. + * @see {@link IoTClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteProvisioningTemplateVersionCommand extends $Command< DeleteProvisioningTemplateVersionCommandInput, diff --git a/clients/client-iot/commands/DeleteRegistrationCodeCommand.ts b/clients/client-iot/commands/DeleteRegistrationCodeCommand.ts index da6e3273e47d..a3937fd3b4eb 100644 --- a/clients/client-iot/commands/DeleteRegistrationCodeCommand.ts +++ b/clients/client-iot/commands/DeleteRegistrationCodeCommand.ts @@ -22,6 +22,20 @@ export interface DeleteRegistrationCodeCommandOutput extends DeleteRegistrationC /** *

Deletes a CA certificate registration code.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { IoTClient, DeleteRegistrationCodeCommand } from "@aws-sdk/client-iot"; // ES Modules import + * // const { IoTClient, DeleteRegistrationCodeCommand } = require("@aws-sdk/client-iot"); // CommonJS import + * const client = new IoTClient(config); + * const command = new DeleteRegistrationCodeCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteRegistrationCodeCommandInput} for command's `input` shape. + * @see {@link DeleteRegistrationCodeCommandOutput} for command's `response` shape. + * @see {@link IoTClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteRegistrationCodeCommand extends $Command< DeleteRegistrationCodeCommandInput, diff --git a/clients/client-iot/commands/DeleteRoleAliasCommand.ts b/clients/client-iot/commands/DeleteRoleAliasCommand.ts index 8471d3b7cea4..c72ddcf68a8f 100644 --- a/clients/client-iot/commands/DeleteRoleAliasCommand.ts +++ b/clients/client-iot/commands/DeleteRoleAliasCommand.ts @@ -22,6 +22,20 @@ export interface DeleteRoleAliasCommandOutput extends DeleteRoleAliasResponse, _ /** *

Deletes a role alias

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { IoTClient, DeleteRoleAliasCommand } from "@aws-sdk/client-iot"; // ES Modules import + * // const { IoTClient, DeleteRoleAliasCommand } = require("@aws-sdk/client-iot"); // CommonJS import + * const client = new IoTClient(config); + * const command = new DeleteRoleAliasCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteRoleAliasCommandInput} for command's `input` shape. + * @see {@link DeleteRoleAliasCommandOutput} for command's `response` shape. + * @see {@link IoTClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteRoleAliasCommand extends $Command< DeleteRoleAliasCommandInput, diff --git a/clients/client-iot/commands/DeleteScheduledAuditCommand.ts b/clients/client-iot/commands/DeleteScheduledAuditCommand.ts index fcdc7a413a01..637d4d1a4e44 100644 --- a/clients/client-iot/commands/DeleteScheduledAuditCommand.ts +++ b/clients/client-iot/commands/DeleteScheduledAuditCommand.ts @@ -22,6 +22,20 @@ export interface DeleteScheduledAuditCommandOutput extends DeleteScheduledAuditR /** *

Deletes a scheduled audit.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { IoTClient, DeleteScheduledAuditCommand } from "@aws-sdk/client-iot"; // ES Modules import + * // const { IoTClient, DeleteScheduledAuditCommand } = require("@aws-sdk/client-iot"); // CommonJS import + * const client = new IoTClient(config); + * const command = new DeleteScheduledAuditCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteScheduledAuditCommandInput} for command's `input` shape. + * @see {@link DeleteScheduledAuditCommandOutput} for command's `response` shape. + * @see {@link IoTClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteScheduledAuditCommand extends $Command< DeleteScheduledAuditCommandInput, diff --git a/clients/client-iot/commands/DeleteSecurityProfileCommand.ts b/clients/client-iot/commands/DeleteSecurityProfileCommand.ts index ff8729c5c9a8..3a627ec9a599 100644 --- a/clients/client-iot/commands/DeleteSecurityProfileCommand.ts +++ b/clients/client-iot/commands/DeleteSecurityProfileCommand.ts @@ -22,6 +22,20 @@ export interface DeleteSecurityProfileCommandOutput extends DeleteSecurityProfil /** *

Deletes a Device Defender security profile.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { IoTClient, DeleteSecurityProfileCommand } from "@aws-sdk/client-iot"; // ES Modules import + * // const { IoTClient, DeleteSecurityProfileCommand } = require("@aws-sdk/client-iot"); // CommonJS import + * const client = new IoTClient(config); + * const command = new DeleteSecurityProfileCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteSecurityProfileCommandInput} for command's `input` shape. + * @see {@link DeleteSecurityProfileCommandOutput} for command's `response` shape. + * @see {@link IoTClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteSecurityProfileCommand extends $Command< DeleteSecurityProfileCommandInput, diff --git a/clients/client-iot/commands/DeleteStreamCommand.ts b/clients/client-iot/commands/DeleteStreamCommand.ts index f5871a6c916a..73e4f73c63a1 100644 --- a/clients/client-iot/commands/DeleteStreamCommand.ts +++ b/clients/client-iot/commands/DeleteStreamCommand.ts @@ -22,6 +22,20 @@ export interface DeleteStreamCommandOutput extends DeleteStreamResponse, __Metad /** *

Deletes a stream.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { IoTClient, DeleteStreamCommand } from "@aws-sdk/client-iot"; // ES Modules import + * // const { IoTClient, DeleteStreamCommand } = require("@aws-sdk/client-iot"); // CommonJS import + * const client = new IoTClient(config); + * const command = new DeleteStreamCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteStreamCommandInput} for command's `input` shape. + * @see {@link DeleteStreamCommandOutput} for command's `response` shape. + * @see {@link IoTClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteStreamCommand extends $Command< DeleteStreamCommandInput, diff --git a/clients/client-iot/commands/DeleteThingCommand.ts b/clients/client-iot/commands/DeleteThingCommand.ts index 13eb61dbef0f..c68a45f3607d 100644 --- a/clients/client-iot/commands/DeleteThingCommand.ts +++ b/clients/client-iot/commands/DeleteThingCommand.ts @@ -23,6 +23,20 @@ export interface DeleteThingCommandOutput extends DeleteThingResponse, __Metadat /** *

Deletes the specified thing. Returns successfully with no error if the deletion is * successful or you specify a thing that doesn't exist.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { IoTClient, DeleteThingCommand } from "@aws-sdk/client-iot"; // ES Modules import + * // const { IoTClient, DeleteThingCommand } = require("@aws-sdk/client-iot"); // CommonJS import + * const client = new IoTClient(config); + * const command = new DeleteThingCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteThingCommandInput} for command's `input` shape. + * @see {@link DeleteThingCommandOutput} for command's `response` shape. + * @see {@link IoTClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteThingCommand extends $Command< DeleteThingCommandInput, diff --git a/clients/client-iot/commands/DeleteThingGroupCommand.ts b/clients/client-iot/commands/DeleteThingGroupCommand.ts index fbb94411ea55..9826e7803349 100644 --- a/clients/client-iot/commands/DeleteThingGroupCommand.ts +++ b/clients/client-iot/commands/DeleteThingGroupCommand.ts @@ -22,6 +22,20 @@ export interface DeleteThingGroupCommandOutput extends DeleteThingGroupResponse, /** *

Deletes a thing group.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { IoTClient, DeleteThingGroupCommand } from "@aws-sdk/client-iot"; // ES Modules import + * // const { IoTClient, DeleteThingGroupCommand } = require("@aws-sdk/client-iot"); // CommonJS import + * const client = new IoTClient(config); + * const command = new DeleteThingGroupCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteThingGroupCommandInput} for command's `input` shape. + * @see {@link DeleteThingGroupCommandOutput} for command's `response` shape. + * @see {@link IoTClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteThingGroupCommand extends $Command< DeleteThingGroupCommandInput, diff --git a/clients/client-iot/commands/DeleteThingTypeCommand.ts b/clients/client-iot/commands/DeleteThingTypeCommand.ts index 6829f3a7736c..cd002cd64d6c 100644 --- a/clients/client-iot/commands/DeleteThingTypeCommand.ts +++ b/clients/client-iot/commands/DeleteThingTypeCommand.ts @@ -24,6 +24,20 @@ export interface DeleteThingTypeCommandOutput extends DeleteThingTypeResponse, _ *

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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { IoTClient, DeleteThingTypeCommand } from "@aws-sdk/client-iot"; // ES Modules import + * // const { IoTClient, DeleteThingTypeCommand } = require("@aws-sdk/client-iot"); // CommonJS import + * const client = new IoTClient(config); + * const command = new DeleteThingTypeCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteThingTypeCommandInput} for command's `input` shape. + * @see {@link DeleteThingTypeCommandOutput} for command's `response` shape. + * @see {@link IoTClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteThingTypeCommand extends $Command< DeleteThingTypeCommandInput, diff --git a/clients/client-iot/commands/DeleteTopicRuleCommand.ts b/clients/client-iot/commands/DeleteTopicRuleCommand.ts index 20800bf6126f..5be712e89f8a 100644 --- a/clients/client-iot/commands/DeleteTopicRuleCommand.ts +++ b/clients/client-iot/commands/DeleteTopicRuleCommand.ts @@ -22,6 +22,20 @@ export interface DeleteTopicRuleCommandOutput extends __MetadataBearer {} /** *

Deletes the rule.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { IoTClient, DeleteTopicRuleCommand } from "@aws-sdk/client-iot"; // ES Modules import + * // const { IoTClient, DeleteTopicRuleCommand } = require("@aws-sdk/client-iot"); // CommonJS import + * const client = new IoTClient(config); + * const command = new DeleteTopicRuleCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteTopicRuleCommandInput} for command's `input` shape. + * @see {@link DeleteTopicRuleCommandOutput} for command's `response` shape. + * @see {@link IoTClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteTopicRuleCommand extends $Command< DeleteTopicRuleCommandInput, diff --git a/clients/client-iot/commands/DeleteTopicRuleDestinationCommand.ts b/clients/client-iot/commands/DeleteTopicRuleDestinationCommand.ts index c75a8cc3701b..637876df7843 100644 --- a/clients/client-iot/commands/DeleteTopicRuleDestinationCommand.ts +++ b/clients/client-iot/commands/DeleteTopicRuleDestinationCommand.ts @@ -22,6 +22,20 @@ export interface DeleteTopicRuleDestinationCommandOutput extends DeleteTopicRule /** *

Deletes a topic rule destination.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { IoTClient, DeleteTopicRuleDestinationCommand } from "@aws-sdk/client-iot"; // ES Modules import + * // const { IoTClient, DeleteTopicRuleDestinationCommand } = require("@aws-sdk/client-iot"); // CommonJS import + * const client = new IoTClient(config); + * const command = new DeleteTopicRuleDestinationCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteTopicRuleDestinationCommandInput} for command's `input` shape. + * @see {@link DeleteTopicRuleDestinationCommandOutput} for command's `response` shape. + * @see {@link IoTClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteTopicRuleDestinationCommand extends $Command< DeleteTopicRuleDestinationCommandInput, diff --git a/clients/client-iot/commands/DeleteV2LoggingLevelCommand.ts b/clients/client-iot/commands/DeleteV2LoggingLevelCommand.ts index b73ac7fda22e..c12ffb302852 100644 --- a/clients/client-iot/commands/DeleteV2LoggingLevelCommand.ts +++ b/clients/client-iot/commands/DeleteV2LoggingLevelCommand.ts @@ -22,6 +22,20 @@ export interface DeleteV2LoggingLevelCommandOutput extends __MetadataBearer {} /** *

Deletes a logging level.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { IoTClient, DeleteV2LoggingLevelCommand } from "@aws-sdk/client-iot"; // ES Modules import + * // const { IoTClient, DeleteV2LoggingLevelCommand } = require("@aws-sdk/client-iot"); // CommonJS import + * const client = new IoTClient(config); + * const command = new DeleteV2LoggingLevelCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteV2LoggingLevelCommandInput} for command's `input` shape. + * @see {@link DeleteV2LoggingLevelCommandOutput} for command's `response` shape. + * @see {@link IoTClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteV2LoggingLevelCommand extends $Command< DeleteV2LoggingLevelCommandInput, diff --git a/clients/client-iot/commands/DeprecateThingTypeCommand.ts b/clients/client-iot/commands/DeprecateThingTypeCommand.ts index ad41295cbd7d..b17b551a7b19 100644 --- a/clients/client-iot/commands/DeprecateThingTypeCommand.ts +++ b/clients/client-iot/commands/DeprecateThingTypeCommand.ts @@ -23,6 +23,20 @@ export interface DeprecateThingTypeCommandOutput extends DeprecateThingTypeRespo /** *

Deprecates a thing type. You can not associate new things with deprecated thing * type.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { IoTClient, DeprecateThingTypeCommand } from "@aws-sdk/client-iot"; // ES Modules import + * // const { IoTClient, DeprecateThingTypeCommand } = require("@aws-sdk/client-iot"); // CommonJS import + * const client = new IoTClient(config); + * const command = new DeprecateThingTypeCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeprecateThingTypeCommandInput} for command's `input` shape. + * @see {@link DeprecateThingTypeCommandOutput} for command's `response` shape. + * @see {@link IoTClientResolvedConfig | config} for command's `input` shape. + * */ export class DeprecateThingTypeCommand extends $Command< DeprecateThingTypeCommandInput, diff --git a/clients/client-iot/commands/DescribeAccountAuditConfigurationCommand.ts b/clients/client-iot/commands/DescribeAccountAuditConfigurationCommand.ts index 48b34732d4a2..412d462fbe6b 100644 --- a/clients/client-iot/commands/DescribeAccountAuditConfigurationCommand.ts +++ b/clients/client-iot/commands/DescribeAccountAuditConfigurationCommand.ts @@ -29,6 +29,20 @@ export interface DescribeAccountAuditConfigurationCommandOutput *

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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { IoTClient, DescribeAccountAuditConfigurationCommand } from "@aws-sdk/client-iot"; // ES Modules import + * // const { IoTClient, DescribeAccountAuditConfigurationCommand } = require("@aws-sdk/client-iot"); // CommonJS import + * const client = new IoTClient(config); + * const command = new DescribeAccountAuditConfigurationCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeAccountAuditConfigurationCommandInput} for command's `input` shape. + * @see {@link DescribeAccountAuditConfigurationCommandOutput} for command's `response` shape. + * @see {@link IoTClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeAccountAuditConfigurationCommand extends $Command< DescribeAccountAuditConfigurationCommandInput, diff --git a/clients/client-iot/commands/DescribeAuditFindingCommand.ts b/clients/client-iot/commands/DescribeAuditFindingCommand.ts index 5c27d9f86aaa..9f15b10a309e 100644 --- a/clients/client-iot/commands/DescribeAuditFindingCommand.ts +++ b/clients/client-iot/commands/DescribeAuditFindingCommand.ts @@ -26,6 +26,20 @@ export interface DescribeAuditFindingCommandOutput extends DescribeAuditFindingR * and the start time * when the audit that returned the * finding.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { IoTClient, DescribeAuditFindingCommand } from "@aws-sdk/client-iot"; // ES Modules import + * // const { IoTClient, DescribeAuditFindingCommand } = require("@aws-sdk/client-iot"); // CommonJS import + * const client = new IoTClient(config); + * const command = new DescribeAuditFindingCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeAuditFindingCommandInput} for command's `input` shape. + * @see {@link DescribeAuditFindingCommandOutput} for command's `response` shape. + * @see {@link IoTClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeAuditFindingCommand extends $Command< DescribeAuditFindingCommandInput, diff --git a/clients/client-iot/commands/DescribeAuditMitigationActionsTaskCommand.ts b/clients/client-iot/commands/DescribeAuditMitigationActionsTaskCommand.ts index 3cf2c9cfba94..a51877ecc2d0 100644 --- a/clients/client-iot/commands/DescribeAuditMitigationActionsTaskCommand.ts +++ b/clients/client-iot/commands/DescribeAuditMitigationActionsTaskCommand.ts @@ -27,6 +27,20 @@ export interface DescribeAuditMitigationActionsTaskCommandOutput /** *

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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { IoTClient, DescribeAuditMitigationActionsTaskCommand } from "@aws-sdk/client-iot"; // ES Modules import + * // const { IoTClient, DescribeAuditMitigationActionsTaskCommand } = require("@aws-sdk/client-iot"); // CommonJS import + * const client = new IoTClient(config); + * const command = new DescribeAuditMitigationActionsTaskCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeAuditMitigationActionsTaskCommandInput} for command's `input` shape. + * @see {@link DescribeAuditMitigationActionsTaskCommandOutput} for command's `response` shape. + * @see {@link IoTClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeAuditMitigationActionsTaskCommand extends $Command< DescribeAuditMitigationActionsTaskCommandInput, diff --git a/clients/client-iot/commands/DescribeAuditSuppressionCommand.ts b/clients/client-iot/commands/DescribeAuditSuppressionCommand.ts index 691ddc0a06a6..5c4776f9efa8 100644 --- a/clients/client-iot/commands/DescribeAuditSuppressionCommand.ts +++ b/clients/client-iot/commands/DescribeAuditSuppressionCommand.ts @@ -24,6 +24,20 @@ export interface DescribeAuditSuppressionCommandOutput extends DescribeAuditSupp *

* Gets information about a Device Defender audit suppression. *

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { IoTClient, DescribeAuditSuppressionCommand } from "@aws-sdk/client-iot"; // ES Modules import + * // const { IoTClient, DescribeAuditSuppressionCommand } = require("@aws-sdk/client-iot"); // CommonJS import + * const client = new IoTClient(config); + * const command = new DescribeAuditSuppressionCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeAuditSuppressionCommandInput} for command's `input` shape. + * @see {@link DescribeAuditSuppressionCommandOutput} for command's `response` shape. + * @see {@link IoTClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeAuditSuppressionCommand extends $Command< DescribeAuditSuppressionCommandInput, diff --git a/clients/client-iot/commands/DescribeAuditTaskCommand.ts b/clients/client-iot/commands/DescribeAuditTaskCommand.ts index 658ef569eeb2..061d92383e56 100644 --- a/clients/client-iot/commands/DescribeAuditTaskCommand.ts +++ b/clients/client-iot/commands/DescribeAuditTaskCommand.ts @@ -22,6 +22,20 @@ export interface DescribeAuditTaskCommandOutput extends DescribeAuditTaskRespons /** *

Gets information about a Device Defender audit.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { IoTClient, DescribeAuditTaskCommand } from "@aws-sdk/client-iot"; // ES Modules import + * // const { IoTClient, DescribeAuditTaskCommand } = require("@aws-sdk/client-iot"); // CommonJS import + * const client = new IoTClient(config); + * const command = new DescribeAuditTaskCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeAuditTaskCommandInput} for command's `input` shape. + * @see {@link DescribeAuditTaskCommandOutput} for command's `response` shape. + * @see {@link IoTClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeAuditTaskCommand extends $Command< DescribeAuditTaskCommandInput, diff --git a/clients/client-iot/commands/DescribeAuthorizerCommand.ts b/clients/client-iot/commands/DescribeAuthorizerCommand.ts index 912f6e90ac91..90e53ce0b8c9 100644 --- a/clients/client-iot/commands/DescribeAuthorizerCommand.ts +++ b/clients/client-iot/commands/DescribeAuthorizerCommand.ts @@ -22,6 +22,20 @@ export interface DescribeAuthorizerCommandOutput extends DescribeAuthorizerRespo /** *

Describes an authorizer.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { IoTClient, DescribeAuthorizerCommand } from "@aws-sdk/client-iot"; // ES Modules import + * // const { IoTClient, DescribeAuthorizerCommand } = require("@aws-sdk/client-iot"); // CommonJS import + * const client = new IoTClient(config); + * const command = new DescribeAuthorizerCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeAuthorizerCommandInput} for command's `input` shape. + * @see {@link DescribeAuthorizerCommandOutput} for command's `response` shape. + * @see {@link IoTClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeAuthorizerCommand extends $Command< DescribeAuthorizerCommandInput, diff --git a/clients/client-iot/commands/DescribeBillingGroupCommand.ts b/clients/client-iot/commands/DescribeBillingGroupCommand.ts index e0f62377c115..c09c3e4d2dc0 100644 --- a/clients/client-iot/commands/DescribeBillingGroupCommand.ts +++ b/clients/client-iot/commands/DescribeBillingGroupCommand.ts @@ -22,6 +22,20 @@ export interface DescribeBillingGroupCommandOutput extends DescribeBillingGroupR /** *

Returns information about a billing group.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { IoTClient, DescribeBillingGroupCommand } from "@aws-sdk/client-iot"; // ES Modules import + * // const { IoTClient, DescribeBillingGroupCommand } = require("@aws-sdk/client-iot"); // CommonJS import + * const client = new IoTClient(config); + * const command = new DescribeBillingGroupCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeBillingGroupCommandInput} for command's `input` shape. + * @see {@link DescribeBillingGroupCommandOutput} for command's `response` shape. + * @see {@link IoTClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeBillingGroupCommand extends $Command< DescribeBillingGroupCommandInput, diff --git a/clients/client-iot/commands/DescribeCACertificateCommand.ts b/clients/client-iot/commands/DescribeCACertificateCommand.ts index 4113558ee68e..abab2f7d3198 100644 --- a/clients/client-iot/commands/DescribeCACertificateCommand.ts +++ b/clients/client-iot/commands/DescribeCACertificateCommand.ts @@ -22,6 +22,20 @@ export interface DescribeCACertificateCommandOutput extends DescribeCACertificat /** *

Describes a registered CA certificate.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { IoTClient, DescribeCACertificateCommand } from "@aws-sdk/client-iot"; // ES Modules import + * // const { IoTClient, DescribeCACertificateCommand } = require("@aws-sdk/client-iot"); // CommonJS import + * const client = new IoTClient(config); + * const command = new DescribeCACertificateCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeCACertificateCommandInput} for command's `input` shape. + * @see {@link DescribeCACertificateCommandOutput} for command's `response` shape. + * @see {@link IoTClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeCACertificateCommand extends $Command< DescribeCACertificateCommandInput, diff --git a/clients/client-iot/commands/DescribeCertificateCommand.ts b/clients/client-iot/commands/DescribeCertificateCommand.ts index 26010c4d2b1e..9bf4bfea69d6 100644 --- a/clients/client-iot/commands/DescribeCertificateCommand.ts +++ b/clients/client-iot/commands/DescribeCertificateCommand.ts @@ -22,6 +22,20 @@ export interface DescribeCertificateCommandOutput extends DescribeCertificateRes /** *

Gets information about the specified certificate.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { IoTClient, DescribeCertificateCommand } from "@aws-sdk/client-iot"; // ES Modules import + * // const { IoTClient, DescribeCertificateCommand } = require("@aws-sdk/client-iot"); // CommonJS import + * const client = new IoTClient(config); + * const command = new DescribeCertificateCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeCertificateCommandInput} for command's `input` shape. + * @see {@link DescribeCertificateCommandOutput} for command's `response` shape. + * @see {@link IoTClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeCertificateCommand extends $Command< DescribeCertificateCommandInput, diff --git a/clients/client-iot/commands/DescribeCustomMetricCommand.ts b/clients/client-iot/commands/DescribeCustomMetricCommand.ts index 56be85662807..112aa00ac4d1 100644 --- a/clients/client-iot/commands/DescribeCustomMetricCommand.ts +++ b/clients/client-iot/commands/DescribeCustomMetricCommand.ts @@ -24,6 +24,20 @@ export interface DescribeCustomMetricCommandOutput extends DescribeCustomMetricR *

* Gets information about a Device Defender detect custom metric. *

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { IoTClient, DescribeCustomMetricCommand } from "@aws-sdk/client-iot"; // ES Modules import + * // const { IoTClient, DescribeCustomMetricCommand } = require("@aws-sdk/client-iot"); // CommonJS import + * const client = new IoTClient(config); + * const command = new DescribeCustomMetricCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeCustomMetricCommandInput} for command's `input` shape. + * @see {@link DescribeCustomMetricCommandOutput} for command's `response` shape. + * @see {@link IoTClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeCustomMetricCommand extends $Command< DescribeCustomMetricCommandInput, diff --git a/clients/client-iot/commands/DescribeDefaultAuthorizerCommand.ts b/clients/client-iot/commands/DescribeDefaultAuthorizerCommand.ts index dcd54a587e52..433a94213881 100644 --- a/clients/client-iot/commands/DescribeDefaultAuthorizerCommand.ts +++ b/clients/client-iot/commands/DescribeDefaultAuthorizerCommand.ts @@ -22,6 +22,20 @@ export interface DescribeDefaultAuthorizerCommandOutput extends DescribeDefaultA /** *

Describes the default authorizer.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { IoTClient, DescribeDefaultAuthorizerCommand } from "@aws-sdk/client-iot"; // ES Modules import + * // const { IoTClient, DescribeDefaultAuthorizerCommand } = require("@aws-sdk/client-iot"); // CommonJS import + * const client = new IoTClient(config); + * const command = new DescribeDefaultAuthorizerCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeDefaultAuthorizerCommandInput} for command's `input` shape. + * @see {@link DescribeDefaultAuthorizerCommandOutput} for command's `response` shape. + * @see {@link IoTClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeDefaultAuthorizerCommand extends $Command< DescribeDefaultAuthorizerCommandInput, diff --git a/clients/client-iot/commands/DescribeDetectMitigationActionsTaskCommand.ts b/clients/client-iot/commands/DescribeDetectMitigationActionsTaskCommand.ts index 68d94982dd92..606faf6a117d 100644 --- a/clients/client-iot/commands/DescribeDetectMitigationActionsTaskCommand.ts +++ b/clients/client-iot/commands/DescribeDetectMitigationActionsTaskCommand.ts @@ -29,6 +29,20 @@ export interface DescribeDetectMitigationActionsTaskCommandOutput *

* Gets information about a Device Defender ML Detect mitigation action. *

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { IoTClient, DescribeDetectMitigationActionsTaskCommand } from "@aws-sdk/client-iot"; // ES Modules import + * // const { IoTClient, DescribeDetectMitigationActionsTaskCommand } = require("@aws-sdk/client-iot"); // CommonJS import + * const client = new IoTClient(config); + * const command = new DescribeDetectMitigationActionsTaskCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeDetectMitigationActionsTaskCommandInput} for command's `input` shape. + * @see {@link DescribeDetectMitigationActionsTaskCommandOutput} for command's `response` shape. + * @see {@link IoTClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeDetectMitigationActionsTaskCommand extends $Command< DescribeDetectMitigationActionsTaskCommandInput, diff --git a/clients/client-iot/commands/DescribeDimensionCommand.ts b/clients/client-iot/commands/DescribeDimensionCommand.ts index 12bcc5b7b30e..ebe128c0182a 100644 --- a/clients/client-iot/commands/DescribeDimensionCommand.ts +++ b/clients/client-iot/commands/DescribeDimensionCommand.ts @@ -22,6 +22,20 @@ export interface DescribeDimensionCommandOutput extends DescribeDimensionRespons /** *

Provides details about a dimension that is defined in your AWS account.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { IoTClient, DescribeDimensionCommand } from "@aws-sdk/client-iot"; // ES Modules import + * // const { IoTClient, DescribeDimensionCommand } = require("@aws-sdk/client-iot"); // CommonJS import + * const client = new IoTClient(config); + * const command = new DescribeDimensionCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeDimensionCommandInput} for command's `input` shape. + * @see {@link DescribeDimensionCommandOutput} for command's `response` shape. + * @see {@link IoTClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeDimensionCommand extends $Command< DescribeDimensionCommandInput, diff --git a/clients/client-iot/commands/DescribeDomainConfigurationCommand.ts b/clients/client-iot/commands/DescribeDomainConfigurationCommand.ts index 2e04bd26b2ab..a052871f288f 100644 --- a/clients/client-iot/commands/DescribeDomainConfigurationCommand.ts +++ b/clients/client-iot/commands/DescribeDomainConfigurationCommand.ts @@ -27,6 +27,20 @@ export interface DescribeDomainConfigurationCommandOutput * *

The domain configuration feature is in public preview and is subject to change.

* + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { IoTClient, DescribeDomainConfigurationCommand } from "@aws-sdk/client-iot"; // ES Modules import + * // const { IoTClient, DescribeDomainConfigurationCommand } = require("@aws-sdk/client-iot"); // CommonJS import + * const client = new IoTClient(config); + * const command = new DescribeDomainConfigurationCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeDomainConfigurationCommandInput} for command's `input` shape. + * @see {@link DescribeDomainConfigurationCommandOutput} for command's `response` shape. + * @see {@link IoTClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeDomainConfigurationCommand extends $Command< DescribeDomainConfigurationCommandInput, diff --git a/clients/client-iot/commands/DescribeEndpointCommand.ts b/clients/client-iot/commands/DescribeEndpointCommand.ts index a1695f613eff..bf7c0913fa53 100644 --- a/clients/client-iot/commands/DescribeEndpointCommand.ts +++ b/clients/client-iot/commands/DescribeEndpointCommand.ts @@ -22,6 +22,20 @@ export interface DescribeEndpointCommandOutput extends DescribeEndpointResponse, /** *

Returns a unique endpoint specific to the AWS account making the call.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { IoTClient, DescribeEndpointCommand } from "@aws-sdk/client-iot"; // ES Modules import + * // const { IoTClient, DescribeEndpointCommand } = require("@aws-sdk/client-iot"); // CommonJS import + * const client = new IoTClient(config); + * const command = new DescribeEndpointCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeEndpointCommandInput} for command's `input` shape. + * @see {@link DescribeEndpointCommandOutput} for command's `response` shape. + * @see {@link IoTClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeEndpointCommand extends $Command< DescribeEndpointCommandInput, diff --git a/clients/client-iot/commands/DescribeEventConfigurationsCommand.ts b/clients/client-iot/commands/DescribeEventConfigurationsCommand.ts index 2e50a5994eeb..83f52bacb2ee 100644 --- a/clients/client-iot/commands/DescribeEventConfigurationsCommand.ts +++ b/clients/client-iot/commands/DescribeEventConfigurationsCommand.ts @@ -24,6 +24,20 @@ export interface DescribeEventConfigurationsCommandOutput /** *

Describes event configurations.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { IoTClient, DescribeEventConfigurationsCommand } from "@aws-sdk/client-iot"; // ES Modules import + * // const { IoTClient, DescribeEventConfigurationsCommand } = require("@aws-sdk/client-iot"); // CommonJS import + * const client = new IoTClient(config); + * const command = new DescribeEventConfigurationsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeEventConfigurationsCommandInput} for command's `input` shape. + * @see {@link DescribeEventConfigurationsCommandOutput} for command's `response` shape. + * @see {@link IoTClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeEventConfigurationsCommand extends $Command< DescribeEventConfigurationsCommandInput, diff --git a/clients/client-iot/commands/DescribeIndexCommand.ts b/clients/client-iot/commands/DescribeIndexCommand.ts index 228fd15bf355..a1b3e8ed872b 100644 --- a/clients/client-iot/commands/DescribeIndexCommand.ts +++ b/clients/client-iot/commands/DescribeIndexCommand.ts @@ -22,6 +22,20 @@ export interface DescribeIndexCommandOutput extends DescribeIndexResponse, __Met /** *

Describes a search index.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { IoTClient, DescribeIndexCommand } from "@aws-sdk/client-iot"; // ES Modules import + * // const { IoTClient, DescribeIndexCommand } = require("@aws-sdk/client-iot"); // CommonJS import + * const client = new IoTClient(config); + * const command = new DescribeIndexCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeIndexCommandInput} for command's `input` shape. + * @see {@link DescribeIndexCommandOutput} for command's `response` shape. + * @see {@link IoTClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeIndexCommand extends $Command< DescribeIndexCommandInput, diff --git a/clients/client-iot/commands/DescribeJobCommand.ts b/clients/client-iot/commands/DescribeJobCommand.ts index 792471e0d33f..752cf94db414 100644 --- a/clients/client-iot/commands/DescribeJobCommand.ts +++ b/clients/client-iot/commands/DescribeJobCommand.ts @@ -22,6 +22,20 @@ export interface DescribeJobCommandOutput extends DescribeJobResponse, __Metadat /** *

Describes a job.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { IoTClient, DescribeJobCommand } from "@aws-sdk/client-iot"; // ES Modules import + * // const { IoTClient, DescribeJobCommand } = require("@aws-sdk/client-iot"); // CommonJS import + * const client = new IoTClient(config); + * const command = new DescribeJobCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeJobCommandInput} for command's `input` shape. + * @see {@link DescribeJobCommandOutput} for command's `response` shape. + * @see {@link IoTClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeJobCommand extends $Command< DescribeJobCommandInput, diff --git a/clients/client-iot/commands/DescribeJobExecutionCommand.ts b/clients/client-iot/commands/DescribeJobExecutionCommand.ts index f93d0451e475..65ea567d77c3 100644 --- a/clients/client-iot/commands/DescribeJobExecutionCommand.ts +++ b/clients/client-iot/commands/DescribeJobExecutionCommand.ts @@ -22,6 +22,20 @@ export interface DescribeJobExecutionCommandOutput extends DescribeJobExecutionR /** *

Describes a job execution.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { IoTClient, DescribeJobExecutionCommand } from "@aws-sdk/client-iot"; // ES Modules import + * // const { IoTClient, DescribeJobExecutionCommand } = require("@aws-sdk/client-iot"); // CommonJS import + * const client = new IoTClient(config); + * const command = new DescribeJobExecutionCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeJobExecutionCommandInput} for command's `input` shape. + * @see {@link DescribeJobExecutionCommandOutput} for command's `response` shape. + * @see {@link IoTClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeJobExecutionCommand extends $Command< DescribeJobExecutionCommandInput, diff --git a/clients/client-iot/commands/DescribeMitigationActionCommand.ts b/clients/client-iot/commands/DescribeMitigationActionCommand.ts index 711d2018d352..63dc673535a1 100644 --- a/clients/client-iot/commands/DescribeMitigationActionCommand.ts +++ b/clients/client-iot/commands/DescribeMitigationActionCommand.ts @@ -22,6 +22,20 @@ export interface DescribeMitigationActionCommandOutput extends DescribeMitigatio /** *

Gets information about a mitigation action.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { IoTClient, DescribeMitigationActionCommand } from "@aws-sdk/client-iot"; // ES Modules import + * // const { IoTClient, DescribeMitigationActionCommand } = require("@aws-sdk/client-iot"); // CommonJS import + * const client = new IoTClient(config); + * const command = new DescribeMitigationActionCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeMitigationActionCommandInput} for command's `input` shape. + * @see {@link DescribeMitigationActionCommandOutput} for command's `response` shape. + * @see {@link IoTClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeMitigationActionCommand extends $Command< DescribeMitigationActionCommandInput, diff --git a/clients/client-iot/commands/DescribeProvisioningTemplateCommand.ts b/clients/client-iot/commands/DescribeProvisioningTemplateCommand.ts index f84cb01713ae..c56f8d5fca05 100644 --- a/clients/client-iot/commands/DescribeProvisioningTemplateCommand.ts +++ b/clients/client-iot/commands/DescribeProvisioningTemplateCommand.ts @@ -24,6 +24,20 @@ export interface DescribeProvisioningTemplateCommandOutput /** *

Returns information about a fleet provisioning template.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { IoTClient, DescribeProvisioningTemplateCommand } from "@aws-sdk/client-iot"; // ES Modules import + * // const { IoTClient, DescribeProvisioningTemplateCommand } = require("@aws-sdk/client-iot"); // CommonJS import + * const client = new IoTClient(config); + * const command = new DescribeProvisioningTemplateCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeProvisioningTemplateCommandInput} for command's `input` shape. + * @see {@link DescribeProvisioningTemplateCommandOutput} for command's `response` shape. + * @see {@link IoTClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeProvisioningTemplateCommand extends $Command< DescribeProvisioningTemplateCommandInput, diff --git a/clients/client-iot/commands/DescribeProvisioningTemplateVersionCommand.ts b/clients/client-iot/commands/DescribeProvisioningTemplateVersionCommand.ts index 6f5a113aa448..25d98a2ec3aa 100644 --- a/clients/client-iot/commands/DescribeProvisioningTemplateVersionCommand.ts +++ b/clients/client-iot/commands/DescribeProvisioningTemplateVersionCommand.ts @@ -27,6 +27,20 @@ export interface DescribeProvisioningTemplateVersionCommandOutput /** *

Returns information about a fleet provisioning template version.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { IoTClient, DescribeProvisioningTemplateVersionCommand } from "@aws-sdk/client-iot"; // ES Modules import + * // const { IoTClient, DescribeProvisioningTemplateVersionCommand } = require("@aws-sdk/client-iot"); // CommonJS import + * const client = new IoTClient(config); + * const command = new DescribeProvisioningTemplateVersionCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeProvisioningTemplateVersionCommandInput} for command's `input` shape. + * @see {@link DescribeProvisioningTemplateVersionCommandOutput} for command's `response` shape. + * @see {@link IoTClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeProvisioningTemplateVersionCommand extends $Command< DescribeProvisioningTemplateVersionCommandInput, diff --git a/clients/client-iot/commands/DescribeRoleAliasCommand.ts b/clients/client-iot/commands/DescribeRoleAliasCommand.ts index 348fd4eb41b0..62415d5d0252 100644 --- a/clients/client-iot/commands/DescribeRoleAliasCommand.ts +++ b/clients/client-iot/commands/DescribeRoleAliasCommand.ts @@ -22,6 +22,20 @@ export interface DescribeRoleAliasCommandOutput extends DescribeRoleAliasRespons /** *

Describes a role alias.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { IoTClient, DescribeRoleAliasCommand } from "@aws-sdk/client-iot"; // ES Modules import + * // const { IoTClient, DescribeRoleAliasCommand } = require("@aws-sdk/client-iot"); // CommonJS import + * const client = new IoTClient(config); + * const command = new DescribeRoleAliasCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeRoleAliasCommandInput} for command's `input` shape. + * @see {@link DescribeRoleAliasCommandOutput} for command's `response` shape. + * @see {@link IoTClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeRoleAliasCommand extends $Command< DescribeRoleAliasCommandInput, diff --git a/clients/client-iot/commands/DescribeScheduledAuditCommand.ts b/clients/client-iot/commands/DescribeScheduledAuditCommand.ts index 5943ccaf36d8..45e64624c8e7 100644 --- a/clients/client-iot/commands/DescribeScheduledAuditCommand.ts +++ b/clients/client-iot/commands/DescribeScheduledAuditCommand.ts @@ -22,6 +22,20 @@ export interface DescribeScheduledAuditCommandOutput extends DescribeScheduledAu /** *

Gets information about a scheduled audit.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { IoTClient, DescribeScheduledAuditCommand } from "@aws-sdk/client-iot"; // ES Modules import + * // const { IoTClient, DescribeScheduledAuditCommand } = require("@aws-sdk/client-iot"); // CommonJS import + * const client = new IoTClient(config); + * const command = new DescribeScheduledAuditCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeScheduledAuditCommandInput} for command's `input` shape. + * @see {@link DescribeScheduledAuditCommandOutput} for command's `response` shape. + * @see {@link IoTClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeScheduledAuditCommand extends $Command< DescribeScheduledAuditCommandInput, diff --git a/clients/client-iot/commands/DescribeSecurityProfileCommand.ts b/clients/client-iot/commands/DescribeSecurityProfileCommand.ts index b3d1dd889e3f..a273e27a0f1e 100644 --- a/clients/client-iot/commands/DescribeSecurityProfileCommand.ts +++ b/clients/client-iot/commands/DescribeSecurityProfileCommand.ts @@ -22,6 +22,20 @@ export interface DescribeSecurityProfileCommandOutput extends DescribeSecurityPr /** *

Gets information about a Device Defender security profile.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { IoTClient, DescribeSecurityProfileCommand } from "@aws-sdk/client-iot"; // ES Modules import + * // const { IoTClient, DescribeSecurityProfileCommand } = require("@aws-sdk/client-iot"); // CommonJS import + * const client = new IoTClient(config); + * const command = new DescribeSecurityProfileCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeSecurityProfileCommandInput} for command's `input` shape. + * @see {@link DescribeSecurityProfileCommandOutput} for command's `response` shape. + * @see {@link IoTClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeSecurityProfileCommand extends $Command< DescribeSecurityProfileCommandInput, diff --git a/clients/client-iot/commands/DescribeStreamCommand.ts b/clients/client-iot/commands/DescribeStreamCommand.ts index 10311a5c5188..3a6832058779 100644 --- a/clients/client-iot/commands/DescribeStreamCommand.ts +++ b/clients/client-iot/commands/DescribeStreamCommand.ts @@ -22,6 +22,20 @@ export interface DescribeStreamCommandOutput extends DescribeStreamResponse, __M /** *

Gets information about a stream.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { IoTClient, DescribeStreamCommand } from "@aws-sdk/client-iot"; // ES Modules import + * // const { IoTClient, DescribeStreamCommand } = require("@aws-sdk/client-iot"); // CommonJS import + * const client = new IoTClient(config); + * const command = new DescribeStreamCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeStreamCommandInput} for command's `input` shape. + * @see {@link DescribeStreamCommandOutput} for command's `response` shape. + * @see {@link IoTClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeStreamCommand extends $Command< DescribeStreamCommandInput, diff --git a/clients/client-iot/commands/DescribeThingCommand.ts b/clients/client-iot/commands/DescribeThingCommand.ts index 2ecb5a72d051..ac9c48180118 100644 --- a/clients/client-iot/commands/DescribeThingCommand.ts +++ b/clients/client-iot/commands/DescribeThingCommand.ts @@ -22,6 +22,20 @@ export interface DescribeThingCommandOutput extends DescribeThingResponse, __Met /** *

Gets information about the specified thing.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { IoTClient, DescribeThingCommand } from "@aws-sdk/client-iot"; // ES Modules import + * // const { IoTClient, DescribeThingCommand } = require("@aws-sdk/client-iot"); // CommonJS import + * const client = new IoTClient(config); + * const command = new DescribeThingCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeThingCommandInput} for command's `input` shape. + * @see {@link DescribeThingCommandOutput} for command's `response` shape. + * @see {@link IoTClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeThingCommand extends $Command< DescribeThingCommandInput, diff --git a/clients/client-iot/commands/DescribeThingGroupCommand.ts b/clients/client-iot/commands/DescribeThingGroupCommand.ts index 4dab11c8b2e0..4184a9f8cbaa 100644 --- a/clients/client-iot/commands/DescribeThingGroupCommand.ts +++ b/clients/client-iot/commands/DescribeThingGroupCommand.ts @@ -22,6 +22,20 @@ export interface DescribeThingGroupCommandOutput extends DescribeThingGroupRespo /** *

Describe a thing group.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { IoTClient, DescribeThingGroupCommand } from "@aws-sdk/client-iot"; // ES Modules import + * // const { IoTClient, DescribeThingGroupCommand } = require("@aws-sdk/client-iot"); // CommonJS import + * const client = new IoTClient(config); + * const command = new DescribeThingGroupCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeThingGroupCommandInput} for command's `input` shape. + * @see {@link DescribeThingGroupCommandOutput} for command's `response` shape. + * @see {@link IoTClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeThingGroupCommand extends $Command< DescribeThingGroupCommandInput, diff --git a/clients/client-iot/commands/DescribeThingRegistrationTaskCommand.ts b/clients/client-iot/commands/DescribeThingRegistrationTaskCommand.ts index 27df113d61ba..a9aa44805acf 100644 --- a/clients/client-iot/commands/DescribeThingRegistrationTaskCommand.ts +++ b/clients/client-iot/commands/DescribeThingRegistrationTaskCommand.ts @@ -24,6 +24,20 @@ export interface DescribeThingRegistrationTaskCommandOutput /** *

Describes a bulk thing provisioning task.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { IoTClient, DescribeThingRegistrationTaskCommand } from "@aws-sdk/client-iot"; // ES Modules import + * // const { IoTClient, DescribeThingRegistrationTaskCommand } = require("@aws-sdk/client-iot"); // CommonJS import + * const client = new IoTClient(config); + * const command = new DescribeThingRegistrationTaskCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeThingRegistrationTaskCommandInput} for command's `input` shape. + * @see {@link DescribeThingRegistrationTaskCommandOutput} for command's `response` shape. + * @see {@link IoTClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeThingRegistrationTaskCommand extends $Command< DescribeThingRegistrationTaskCommandInput, diff --git a/clients/client-iot/commands/DescribeThingTypeCommand.ts b/clients/client-iot/commands/DescribeThingTypeCommand.ts index 91579be02ad9..c5c2d1083f3e 100644 --- a/clients/client-iot/commands/DescribeThingTypeCommand.ts +++ b/clients/client-iot/commands/DescribeThingTypeCommand.ts @@ -22,6 +22,20 @@ export interface DescribeThingTypeCommandOutput extends DescribeThingTypeRespons /** *

Gets information about the specified thing type.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { IoTClient, DescribeThingTypeCommand } from "@aws-sdk/client-iot"; // ES Modules import + * // const { IoTClient, DescribeThingTypeCommand } = require("@aws-sdk/client-iot"); // CommonJS import + * const client = new IoTClient(config); + * const command = new DescribeThingTypeCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeThingTypeCommandInput} for command's `input` shape. + * @see {@link DescribeThingTypeCommandOutput} for command's `response` shape. + * @see {@link IoTClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeThingTypeCommand extends $Command< DescribeThingTypeCommandInput, diff --git a/clients/client-iot/commands/DetachPolicyCommand.ts b/clients/client-iot/commands/DetachPolicyCommand.ts index 9c9bb4262334..cd54aa82e7c4 100644 --- a/clients/client-iot/commands/DetachPolicyCommand.ts +++ b/clients/client-iot/commands/DetachPolicyCommand.ts @@ -22,6 +22,20 @@ export interface DetachPolicyCommandOutput extends __MetadataBearer {} /** *

Detaches a policy from the specified target.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { IoTClient, DetachPolicyCommand } from "@aws-sdk/client-iot"; // ES Modules import + * // const { IoTClient, DetachPolicyCommand } = require("@aws-sdk/client-iot"); // CommonJS import + * const client = new IoTClient(config); + * const command = new DetachPolicyCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DetachPolicyCommandInput} for command's `input` shape. + * @see {@link DetachPolicyCommandOutput} for command's `response` shape. + * @see {@link IoTClientResolvedConfig | config} for command's `input` shape. + * */ export class DetachPolicyCommand extends $Command< DetachPolicyCommandInput, diff --git a/clients/client-iot/commands/DetachPrincipalPolicyCommand.ts b/clients/client-iot/commands/DetachPrincipalPolicyCommand.ts index ba27ae8e12a0..41c0e65b7d75 100644 --- a/clients/client-iot/commands/DetachPrincipalPolicyCommand.ts +++ b/clients/client-iot/commands/DetachPrincipalPolicyCommand.ts @@ -26,6 +26,20 @@ export interface DetachPrincipalPolicyCommandOutput extends __MetadataBearer {} *

Removes the specified policy from the specified certificate.

*

* Note: This API is deprecated. Please use DetachPolicy instead.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { IoTClient, DetachPrincipalPolicyCommand } from "@aws-sdk/client-iot"; // ES Modules import + * // const { IoTClient, DetachPrincipalPolicyCommand } = require("@aws-sdk/client-iot"); // CommonJS import + * const client = new IoTClient(config); + * const command = new DetachPrincipalPolicyCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DetachPrincipalPolicyCommandInput} for command's `input` shape. + * @see {@link DetachPrincipalPolicyCommandOutput} for command's `response` shape. + * @see {@link IoTClientResolvedConfig | config} for command's `input` shape. + * */ export class DetachPrincipalPolicyCommand extends $Command< DetachPrincipalPolicyCommandInput, diff --git a/clients/client-iot/commands/DetachSecurityProfileCommand.ts b/clients/client-iot/commands/DetachSecurityProfileCommand.ts index d67bd4f6d81c..66e08ddc1c19 100644 --- a/clients/client-iot/commands/DetachSecurityProfileCommand.ts +++ b/clients/client-iot/commands/DetachSecurityProfileCommand.ts @@ -22,6 +22,20 @@ export interface DetachSecurityProfileCommandOutput extends DetachSecurityProfil /** *

Disassociates a Device Defender security profile from a thing group or from this account.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { IoTClient, DetachSecurityProfileCommand } from "@aws-sdk/client-iot"; // ES Modules import + * // const { IoTClient, DetachSecurityProfileCommand } = require("@aws-sdk/client-iot"); // CommonJS import + * const client = new IoTClient(config); + * const command = new DetachSecurityProfileCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DetachSecurityProfileCommandInput} for command's `input` shape. + * @see {@link DetachSecurityProfileCommandOutput} for command's `response` shape. + * @see {@link IoTClientResolvedConfig | config} for command's `input` shape. + * */ export class DetachSecurityProfileCommand extends $Command< DetachSecurityProfileCommandInput, diff --git a/clients/client-iot/commands/DetachThingPrincipalCommand.ts b/clients/client-iot/commands/DetachThingPrincipalCommand.ts index aa65d0832586..290e3b8c05bb 100644 --- a/clients/client-iot/commands/DetachThingPrincipalCommand.ts +++ b/clients/client-iot/commands/DetachThingPrincipalCommand.ts @@ -28,6 +28,20 @@ export interface DetachThingPrincipalCommandOutput extends DetachThingPrincipalR *

This call is asynchronous. It might take several seconds for the detachment to * propagate.

* + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { IoTClient, DetachThingPrincipalCommand } from "@aws-sdk/client-iot"; // ES Modules import + * // const { IoTClient, DetachThingPrincipalCommand } = require("@aws-sdk/client-iot"); // CommonJS import + * const client = new IoTClient(config); + * const command = new DetachThingPrincipalCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DetachThingPrincipalCommandInput} for command's `input` shape. + * @see {@link DetachThingPrincipalCommandOutput} for command's `response` shape. + * @see {@link IoTClientResolvedConfig | config} for command's `input` shape. + * */ export class DetachThingPrincipalCommand extends $Command< DetachThingPrincipalCommandInput, diff --git a/clients/client-iot/commands/DisableTopicRuleCommand.ts b/clients/client-iot/commands/DisableTopicRuleCommand.ts index 47ef15a840cc..ab92cc7158f0 100644 --- a/clients/client-iot/commands/DisableTopicRuleCommand.ts +++ b/clients/client-iot/commands/DisableTopicRuleCommand.ts @@ -22,6 +22,20 @@ export interface DisableTopicRuleCommandOutput extends __MetadataBearer {} /** *

Disables the rule.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { IoTClient, DisableTopicRuleCommand } from "@aws-sdk/client-iot"; // ES Modules import + * // const { IoTClient, DisableTopicRuleCommand } = require("@aws-sdk/client-iot"); // CommonJS import + * const client = new IoTClient(config); + * const command = new DisableTopicRuleCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DisableTopicRuleCommandInput} for command's `input` shape. + * @see {@link DisableTopicRuleCommandOutput} for command's `response` shape. + * @see {@link IoTClientResolvedConfig | config} for command's `input` shape. + * */ export class DisableTopicRuleCommand extends $Command< DisableTopicRuleCommandInput, diff --git a/clients/client-iot/commands/EnableTopicRuleCommand.ts b/clients/client-iot/commands/EnableTopicRuleCommand.ts index 15cf73d4422c..329d028fe80c 100644 --- a/clients/client-iot/commands/EnableTopicRuleCommand.ts +++ b/clients/client-iot/commands/EnableTopicRuleCommand.ts @@ -22,6 +22,20 @@ export interface EnableTopicRuleCommandOutput extends __MetadataBearer {} /** *

Enables the rule.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { IoTClient, EnableTopicRuleCommand } from "@aws-sdk/client-iot"; // ES Modules import + * // const { IoTClient, EnableTopicRuleCommand } = require("@aws-sdk/client-iot"); // CommonJS import + * const client = new IoTClient(config); + * const command = new EnableTopicRuleCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link EnableTopicRuleCommandInput} for command's `input` shape. + * @see {@link EnableTopicRuleCommandOutput} for command's `response` shape. + * @see {@link IoTClientResolvedConfig | config} for command's `input` shape. + * */ export class EnableTopicRuleCommand extends $Command< EnableTopicRuleCommandInput, diff --git a/clients/client-iot/commands/GetBehaviorModelTrainingSummariesCommand.ts b/clients/client-iot/commands/GetBehaviorModelTrainingSummariesCommand.ts index 3ca07aadab27..efdbba57d0fd 100644 --- a/clients/client-iot/commands/GetBehaviorModelTrainingSummariesCommand.ts +++ b/clients/client-iot/commands/GetBehaviorModelTrainingSummariesCommand.ts @@ -29,6 +29,20 @@ export interface GetBehaviorModelTrainingSummariesCommandOutput *

* Returns a Device Defender's ML Detect Security Profile training model's status. *

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { IoTClient, GetBehaviorModelTrainingSummariesCommand } from "@aws-sdk/client-iot"; // ES Modules import + * // const { IoTClient, GetBehaviorModelTrainingSummariesCommand } = require("@aws-sdk/client-iot"); // CommonJS import + * const client = new IoTClient(config); + * const command = new GetBehaviorModelTrainingSummariesCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetBehaviorModelTrainingSummariesCommandInput} for command's `input` shape. + * @see {@link GetBehaviorModelTrainingSummariesCommandOutput} for command's `response` shape. + * @see {@link IoTClientResolvedConfig | config} for command's `input` shape. + * */ export class GetBehaviorModelTrainingSummariesCommand extends $Command< GetBehaviorModelTrainingSummariesCommandInput, diff --git a/clients/client-iot/commands/GetCardinalityCommand.ts b/clients/client-iot/commands/GetCardinalityCommand.ts index 2aa4f4bc89fe..9af294527ad4 100644 --- a/clients/client-iot/commands/GetCardinalityCommand.ts +++ b/clients/client-iot/commands/GetCardinalityCommand.ts @@ -22,6 +22,20 @@ export interface GetCardinalityCommandOutput extends GetCardinalityResponse, __M /** *

Returns the approximate count of unique values that match the query.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { IoTClient, GetCardinalityCommand } from "@aws-sdk/client-iot"; // ES Modules import + * // const { IoTClient, GetCardinalityCommand } = require("@aws-sdk/client-iot"); // CommonJS import + * const client = new IoTClient(config); + * const command = new GetCardinalityCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetCardinalityCommandInput} for command's `input` shape. + * @see {@link GetCardinalityCommandOutput} for command's `response` shape. + * @see {@link IoTClientResolvedConfig | config} for command's `input` shape. + * */ export class GetCardinalityCommand extends $Command< GetCardinalityCommandInput, diff --git a/clients/client-iot/commands/GetEffectivePoliciesCommand.ts b/clients/client-iot/commands/GetEffectivePoliciesCommand.ts index c91531a06bc8..5b5a2c76d192 100644 --- a/clients/client-iot/commands/GetEffectivePoliciesCommand.ts +++ b/clients/client-iot/commands/GetEffectivePoliciesCommand.ts @@ -23,6 +23,20 @@ export interface GetEffectivePoliciesCommandOutput extends GetEffectivePoliciesR /** *

Gets a list of the policies that have an effect on the authorization behavior of the * specified device when it connects to the AWS IoT device gateway.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { IoTClient, GetEffectivePoliciesCommand } from "@aws-sdk/client-iot"; // ES Modules import + * // const { IoTClient, GetEffectivePoliciesCommand } = require("@aws-sdk/client-iot"); // CommonJS import + * const client = new IoTClient(config); + * const command = new GetEffectivePoliciesCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetEffectivePoliciesCommandInput} for command's `input` shape. + * @see {@link GetEffectivePoliciesCommandOutput} for command's `response` shape. + * @see {@link IoTClientResolvedConfig | config} for command's `input` shape. + * */ export class GetEffectivePoliciesCommand extends $Command< GetEffectivePoliciesCommandInput, diff --git a/clients/client-iot/commands/GetIndexingConfigurationCommand.ts b/clients/client-iot/commands/GetIndexingConfigurationCommand.ts index 5ab94ed19eae..65e5e563c234 100644 --- a/clients/client-iot/commands/GetIndexingConfigurationCommand.ts +++ b/clients/client-iot/commands/GetIndexingConfigurationCommand.ts @@ -22,6 +22,20 @@ export interface GetIndexingConfigurationCommandOutput extends GetIndexingConfig /** *

Gets the indexing configuration.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { IoTClient, GetIndexingConfigurationCommand } from "@aws-sdk/client-iot"; // ES Modules import + * // const { IoTClient, GetIndexingConfigurationCommand } = require("@aws-sdk/client-iot"); // CommonJS import + * const client = new IoTClient(config); + * const command = new GetIndexingConfigurationCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetIndexingConfigurationCommandInput} for command's `input` shape. + * @see {@link GetIndexingConfigurationCommandOutput} for command's `response` shape. + * @see {@link IoTClientResolvedConfig | config} for command's `input` shape. + * */ export class GetIndexingConfigurationCommand extends $Command< GetIndexingConfigurationCommandInput, diff --git a/clients/client-iot/commands/GetJobDocumentCommand.ts b/clients/client-iot/commands/GetJobDocumentCommand.ts index 231f85395b05..896d4fdd5b52 100644 --- a/clients/client-iot/commands/GetJobDocumentCommand.ts +++ b/clients/client-iot/commands/GetJobDocumentCommand.ts @@ -22,6 +22,20 @@ export interface GetJobDocumentCommandOutput extends GetJobDocumentResponse, __M /** *

Gets a job document.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { IoTClient, GetJobDocumentCommand } from "@aws-sdk/client-iot"; // ES Modules import + * // const { IoTClient, GetJobDocumentCommand } = require("@aws-sdk/client-iot"); // CommonJS import + * const client = new IoTClient(config); + * const command = new GetJobDocumentCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetJobDocumentCommandInput} for command's `input` shape. + * @see {@link GetJobDocumentCommandOutput} for command's `response` shape. + * @see {@link IoTClientResolvedConfig | config} for command's `input` shape. + * */ export class GetJobDocumentCommand extends $Command< GetJobDocumentCommandInput, diff --git a/clients/client-iot/commands/GetLoggingOptionsCommand.ts b/clients/client-iot/commands/GetLoggingOptionsCommand.ts index 9325e7fbfdf8..8d4d937523e5 100644 --- a/clients/client-iot/commands/GetLoggingOptionsCommand.ts +++ b/clients/client-iot/commands/GetLoggingOptionsCommand.ts @@ -24,6 +24,20 @@ export interface GetLoggingOptionsCommandOutput extends GetLoggingOptionsRespons *

Gets the logging options.

*

NOTE: use of this command is not recommended. Use GetV2LoggingOptions * instead.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { IoTClient, GetLoggingOptionsCommand } from "@aws-sdk/client-iot"; // ES Modules import + * // const { IoTClient, GetLoggingOptionsCommand } = require("@aws-sdk/client-iot"); // CommonJS import + * const client = new IoTClient(config); + * const command = new GetLoggingOptionsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetLoggingOptionsCommandInput} for command's `input` shape. + * @see {@link GetLoggingOptionsCommandOutput} for command's `response` shape. + * @see {@link IoTClientResolvedConfig | config} for command's `input` shape. + * */ export class GetLoggingOptionsCommand extends $Command< GetLoggingOptionsCommandInput, diff --git a/clients/client-iot/commands/GetOTAUpdateCommand.ts b/clients/client-iot/commands/GetOTAUpdateCommand.ts index 730b55c0201c..ee4e11b3ed4b 100644 --- a/clients/client-iot/commands/GetOTAUpdateCommand.ts +++ b/clients/client-iot/commands/GetOTAUpdateCommand.ts @@ -22,6 +22,20 @@ export interface GetOTAUpdateCommandOutput extends GetOTAUpdateResponse, __Metad /** *

Gets an OTA update.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { IoTClient, GetOTAUpdateCommand } from "@aws-sdk/client-iot"; // ES Modules import + * // const { IoTClient, GetOTAUpdateCommand } = require("@aws-sdk/client-iot"); // CommonJS import + * const client = new IoTClient(config); + * const command = new GetOTAUpdateCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetOTAUpdateCommandInput} for command's `input` shape. + * @see {@link GetOTAUpdateCommandOutput} for command's `response` shape. + * @see {@link IoTClientResolvedConfig | config} for command's `input` shape. + * */ export class GetOTAUpdateCommand extends $Command< GetOTAUpdateCommandInput, diff --git a/clients/client-iot/commands/GetPercentilesCommand.ts b/clients/client-iot/commands/GetPercentilesCommand.ts index 7a40c3aaf51a..69251e6b476b 100644 --- a/clients/client-iot/commands/GetPercentilesCommand.ts +++ b/clients/client-iot/commands/GetPercentilesCommand.ts @@ -30,6 +30,20 @@ export interface GetPercentilesCommandOutput extends GetPercentilesResponse, __M * 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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { IoTClient, GetPercentilesCommand } from "@aws-sdk/client-iot"; // ES Modules import + * // const { IoTClient, GetPercentilesCommand } = require("@aws-sdk/client-iot"); // CommonJS import + * const client = new IoTClient(config); + * const command = new GetPercentilesCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetPercentilesCommandInput} for command's `input` shape. + * @see {@link GetPercentilesCommandOutput} for command's `response` shape. + * @see {@link IoTClientResolvedConfig | config} for command's `input` shape. + * */ export class GetPercentilesCommand extends $Command< GetPercentilesCommandInput, diff --git a/clients/client-iot/commands/GetPolicyCommand.ts b/clients/client-iot/commands/GetPolicyCommand.ts index 4865df1c918b..d8058057f947 100644 --- a/clients/client-iot/commands/GetPolicyCommand.ts +++ b/clients/client-iot/commands/GetPolicyCommand.ts @@ -23,6 +23,20 @@ export interface GetPolicyCommandOutput extends GetPolicyResponse, __MetadataBea /** *

Gets information about the specified policy with the policy document of the default * version.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { IoTClient, GetPolicyCommand } from "@aws-sdk/client-iot"; // ES Modules import + * // const { IoTClient, GetPolicyCommand } = require("@aws-sdk/client-iot"); // CommonJS import + * const client = new IoTClient(config); + * const command = new GetPolicyCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetPolicyCommandInput} for command's `input` shape. + * @see {@link GetPolicyCommandOutput} for command's `response` shape. + * @see {@link IoTClientResolvedConfig | config} for command's `input` shape. + * */ export class GetPolicyCommand extends $Command { // Start section: command_properties diff --git a/clients/client-iot/commands/GetPolicyVersionCommand.ts b/clients/client-iot/commands/GetPolicyVersionCommand.ts index 3b24fb32633d..35fd6c1b7be7 100644 --- a/clients/client-iot/commands/GetPolicyVersionCommand.ts +++ b/clients/client-iot/commands/GetPolicyVersionCommand.ts @@ -22,6 +22,20 @@ export interface GetPolicyVersionCommandOutput extends GetPolicyVersionResponse, /** *

Gets information about the specified policy version.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { IoTClient, GetPolicyVersionCommand } from "@aws-sdk/client-iot"; // ES Modules import + * // const { IoTClient, GetPolicyVersionCommand } = require("@aws-sdk/client-iot"); // CommonJS import + * const client = new IoTClient(config); + * const command = new GetPolicyVersionCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetPolicyVersionCommandInput} for command's `input` shape. + * @see {@link GetPolicyVersionCommandOutput} for command's `response` shape. + * @see {@link IoTClientResolvedConfig | config} for command's `input` shape. + * */ export class GetPolicyVersionCommand extends $Command< GetPolicyVersionCommandInput, diff --git a/clients/client-iot/commands/GetRegistrationCodeCommand.ts b/clients/client-iot/commands/GetRegistrationCodeCommand.ts index c6ad2bcff25b..170e8127459f 100644 --- a/clients/client-iot/commands/GetRegistrationCodeCommand.ts +++ b/clients/client-iot/commands/GetRegistrationCodeCommand.ts @@ -22,6 +22,20 @@ export interface GetRegistrationCodeCommandOutput extends GetRegistrationCodeRes /** *

Gets a registration code used to register a CA certificate with AWS IoT.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { IoTClient, GetRegistrationCodeCommand } from "@aws-sdk/client-iot"; // ES Modules import + * // const { IoTClient, GetRegistrationCodeCommand } = require("@aws-sdk/client-iot"); // CommonJS import + * const client = new IoTClient(config); + * const command = new GetRegistrationCodeCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetRegistrationCodeCommandInput} for command's `input` shape. + * @see {@link GetRegistrationCodeCommandOutput} for command's `response` shape. + * @see {@link IoTClientResolvedConfig | config} for command's `input` shape. + * */ export class GetRegistrationCodeCommand extends $Command< GetRegistrationCodeCommandInput, diff --git a/clients/client-iot/commands/GetStatisticsCommand.ts b/clients/client-iot/commands/GetStatisticsCommand.ts index 8ce0a86365d8..db85f7279155 100644 --- a/clients/client-iot/commands/GetStatisticsCommand.ts +++ b/clients/client-iot/commands/GetStatisticsCommand.ts @@ -24,6 +24,20 @@ export interface GetStatisticsCommandOutput extends GetStatisticsResponse, __Met *

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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { IoTClient, GetStatisticsCommand } from "@aws-sdk/client-iot"; // ES Modules import + * // const { IoTClient, GetStatisticsCommand } = require("@aws-sdk/client-iot"); // CommonJS import + * const client = new IoTClient(config); + * const command = new GetStatisticsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetStatisticsCommandInput} for command's `input` shape. + * @see {@link GetStatisticsCommandOutput} for command's `response` shape. + * @see {@link IoTClientResolvedConfig | config} for command's `input` shape. + * */ export class GetStatisticsCommand extends $Command< GetStatisticsCommandInput, diff --git a/clients/client-iot/commands/GetTopicRuleCommand.ts b/clients/client-iot/commands/GetTopicRuleCommand.ts index 95f5fcff1389..b549365a819b 100644 --- a/clients/client-iot/commands/GetTopicRuleCommand.ts +++ b/clients/client-iot/commands/GetTopicRuleCommand.ts @@ -22,6 +22,20 @@ export interface GetTopicRuleCommandOutput extends GetTopicRuleResponse, __Metad /** *

Gets information about the rule.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { IoTClient, GetTopicRuleCommand } from "@aws-sdk/client-iot"; // ES Modules import + * // const { IoTClient, GetTopicRuleCommand } = require("@aws-sdk/client-iot"); // CommonJS import + * const client = new IoTClient(config); + * const command = new GetTopicRuleCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetTopicRuleCommandInput} for command's `input` shape. + * @see {@link GetTopicRuleCommandOutput} for command's `response` shape. + * @see {@link IoTClientResolvedConfig | config} for command's `input` shape. + * */ export class GetTopicRuleCommand extends $Command< GetTopicRuleCommandInput, diff --git a/clients/client-iot/commands/GetTopicRuleDestinationCommand.ts b/clients/client-iot/commands/GetTopicRuleDestinationCommand.ts index 68f640141502..74f2758156a8 100644 --- a/clients/client-iot/commands/GetTopicRuleDestinationCommand.ts +++ b/clients/client-iot/commands/GetTopicRuleDestinationCommand.ts @@ -22,6 +22,20 @@ export interface GetTopicRuleDestinationCommandOutput extends GetTopicRuleDestin /** *

Gets information about a topic rule destination.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { IoTClient, GetTopicRuleDestinationCommand } from "@aws-sdk/client-iot"; // ES Modules import + * // const { IoTClient, GetTopicRuleDestinationCommand } = require("@aws-sdk/client-iot"); // CommonJS import + * const client = new IoTClient(config); + * const command = new GetTopicRuleDestinationCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetTopicRuleDestinationCommandInput} for command's `input` shape. + * @see {@link GetTopicRuleDestinationCommandOutput} for command's `response` shape. + * @see {@link IoTClientResolvedConfig | config} for command's `input` shape. + * */ export class GetTopicRuleDestinationCommand extends $Command< GetTopicRuleDestinationCommandInput, diff --git a/clients/client-iot/commands/GetV2LoggingOptionsCommand.ts b/clients/client-iot/commands/GetV2LoggingOptionsCommand.ts index 88b351b18f81..35752592e25d 100644 --- a/clients/client-iot/commands/GetV2LoggingOptionsCommand.ts +++ b/clients/client-iot/commands/GetV2LoggingOptionsCommand.ts @@ -22,6 +22,20 @@ export interface GetV2LoggingOptionsCommandOutput extends GetV2LoggingOptionsRes /** *

Gets the fine grained logging options.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { IoTClient, GetV2LoggingOptionsCommand } from "@aws-sdk/client-iot"; // ES Modules import + * // const { IoTClient, GetV2LoggingOptionsCommand } = require("@aws-sdk/client-iot"); // CommonJS import + * const client = new IoTClient(config); + * const command = new GetV2LoggingOptionsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetV2LoggingOptionsCommandInput} for command's `input` shape. + * @see {@link GetV2LoggingOptionsCommandOutput} for command's `response` shape. + * @see {@link IoTClientResolvedConfig | config} for command's `input` shape. + * */ export class GetV2LoggingOptionsCommand extends $Command< GetV2LoggingOptionsCommandInput, diff --git a/clients/client-iot/commands/ListActiveViolationsCommand.ts b/clients/client-iot/commands/ListActiveViolationsCommand.ts index 8ff10fb0624a..8abf10c3b272 100644 --- a/clients/client-iot/commands/ListActiveViolationsCommand.ts +++ b/clients/client-iot/commands/ListActiveViolationsCommand.ts @@ -22,6 +22,20 @@ export interface ListActiveViolationsCommandOutput extends ListActiveViolationsR /** *

Lists the active violations for a given Device Defender security profile.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { IoTClient, ListActiveViolationsCommand } from "@aws-sdk/client-iot"; // ES Modules import + * // const { IoTClient, ListActiveViolationsCommand } = require("@aws-sdk/client-iot"); // CommonJS import + * const client = new IoTClient(config); + * const command = new ListActiveViolationsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListActiveViolationsCommandInput} for command's `input` shape. + * @see {@link ListActiveViolationsCommandOutput} for command's `response` shape. + * @see {@link IoTClientResolvedConfig | config} for command's `input` shape. + * */ export class ListActiveViolationsCommand extends $Command< ListActiveViolationsCommandInput, diff --git a/clients/client-iot/commands/ListAttachedPoliciesCommand.ts b/clients/client-iot/commands/ListAttachedPoliciesCommand.ts index 66cccd9e0c01..7967ed32c124 100644 --- a/clients/client-iot/commands/ListAttachedPoliciesCommand.ts +++ b/clients/client-iot/commands/ListAttachedPoliciesCommand.ts @@ -22,6 +22,20 @@ export interface ListAttachedPoliciesCommandOutput extends ListAttachedPoliciesR /** *

Lists the policies attached to the specified thing group.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { IoTClient, ListAttachedPoliciesCommand } from "@aws-sdk/client-iot"; // ES Modules import + * // const { IoTClient, ListAttachedPoliciesCommand } = require("@aws-sdk/client-iot"); // CommonJS import + * const client = new IoTClient(config); + * const command = new ListAttachedPoliciesCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListAttachedPoliciesCommandInput} for command's `input` shape. + * @see {@link ListAttachedPoliciesCommandOutput} for command's `response` shape. + * @see {@link IoTClientResolvedConfig | config} for command's `input` shape. + * */ export class ListAttachedPoliciesCommand extends $Command< ListAttachedPoliciesCommandInput, diff --git a/clients/client-iot/commands/ListAuditFindingsCommand.ts b/clients/client-iot/commands/ListAuditFindingsCommand.ts index 97169ec57966..0625d028d1d2 100644 --- a/clients/client-iot/commands/ListAuditFindingsCommand.ts +++ b/clients/client-iot/commands/ListAuditFindingsCommand.ts @@ -23,6 +23,20 @@ export interface ListAuditFindingsCommandOutput extends ListAuditFindingsRespons /** *

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.)

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { IoTClient, ListAuditFindingsCommand } from "@aws-sdk/client-iot"; // ES Modules import + * // const { IoTClient, ListAuditFindingsCommand } = require("@aws-sdk/client-iot"); // CommonJS import + * const client = new IoTClient(config); + * const command = new ListAuditFindingsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListAuditFindingsCommandInput} for command's `input` shape. + * @see {@link ListAuditFindingsCommandOutput} for command's `response` shape. + * @see {@link IoTClientResolvedConfig | config} for command's `input` shape. + * */ export class ListAuditFindingsCommand extends $Command< ListAuditFindingsCommandInput, diff --git a/clients/client-iot/commands/ListAuditMitigationActionsExecutionsCommand.ts b/clients/client-iot/commands/ListAuditMitigationActionsExecutionsCommand.ts index 606c51450103..e9d51d4e1ada 100644 --- a/clients/client-iot/commands/ListAuditMitigationActionsExecutionsCommand.ts +++ b/clients/client-iot/commands/ListAuditMitigationActionsExecutionsCommand.ts @@ -28,6 +28,20 @@ export interface ListAuditMitigationActionsExecutionsCommandOutput /** *

Gets the status of audit mitigation action tasks that were * executed.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { IoTClient, ListAuditMitigationActionsExecutionsCommand } from "@aws-sdk/client-iot"; // ES Modules import + * // const { IoTClient, ListAuditMitigationActionsExecutionsCommand } = require("@aws-sdk/client-iot"); // CommonJS import + * const client = new IoTClient(config); + * const command = new ListAuditMitigationActionsExecutionsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListAuditMitigationActionsExecutionsCommandInput} for command's `input` shape. + * @see {@link ListAuditMitigationActionsExecutionsCommandOutput} for command's `response` shape. + * @see {@link IoTClientResolvedConfig | config} for command's `input` shape. + * */ export class ListAuditMitigationActionsExecutionsCommand extends $Command< ListAuditMitigationActionsExecutionsCommandInput, diff --git a/clients/client-iot/commands/ListAuditMitigationActionsTasksCommand.ts b/clients/client-iot/commands/ListAuditMitigationActionsTasksCommand.ts index ff67e0dd8359..37b3be26b3e7 100644 --- a/clients/client-iot/commands/ListAuditMitigationActionsTasksCommand.ts +++ b/clients/client-iot/commands/ListAuditMitigationActionsTasksCommand.ts @@ -24,6 +24,20 @@ export interface ListAuditMitigationActionsTasksCommandOutput /** *

Gets a list of audit mitigation action tasks that match the specified filters.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { IoTClient, ListAuditMitigationActionsTasksCommand } from "@aws-sdk/client-iot"; // ES Modules import + * // const { IoTClient, ListAuditMitigationActionsTasksCommand } = require("@aws-sdk/client-iot"); // CommonJS import + * const client = new IoTClient(config); + * const command = new ListAuditMitigationActionsTasksCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListAuditMitigationActionsTasksCommandInput} for command's `input` shape. + * @see {@link ListAuditMitigationActionsTasksCommandOutput} for command's `response` shape. + * @see {@link IoTClientResolvedConfig | config} for command's `input` shape. + * */ export class ListAuditMitigationActionsTasksCommand extends $Command< ListAuditMitigationActionsTasksCommandInput, diff --git a/clients/client-iot/commands/ListAuditSuppressionsCommand.ts b/clients/client-iot/commands/ListAuditSuppressionsCommand.ts index 5c5ae71f7bda..3d94e20da001 100644 --- a/clients/client-iot/commands/ListAuditSuppressionsCommand.ts +++ b/clients/client-iot/commands/ListAuditSuppressionsCommand.ts @@ -24,6 +24,20 @@ export interface ListAuditSuppressionsCommandOutput extends ListAuditSuppression *

* Lists your Device Defender audit listings. *

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { IoTClient, ListAuditSuppressionsCommand } from "@aws-sdk/client-iot"; // ES Modules import + * // const { IoTClient, ListAuditSuppressionsCommand } = require("@aws-sdk/client-iot"); // CommonJS import + * const client = new IoTClient(config); + * const command = new ListAuditSuppressionsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListAuditSuppressionsCommandInput} for command's `input` shape. + * @see {@link ListAuditSuppressionsCommandOutput} for command's `response` shape. + * @see {@link IoTClientResolvedConfig | config} for command's `input` shape. + * */ export class ListAuditSuppressionsCommand extends $Command< ListAuditSuppressionsCommandInput, diff --git a/clients/client-iot/commands/ListAuditTasksCommand.ts b/clients/client-iot/commands/ListAuditTasksCommand.ts index fc40804f3713..64a992c37822 100644 --- a/clients/client-iot/commands/ListAuditTasksCommand.ts +++ b/clients/client-iot/commands/ListAuditTasksCommand.ts @@ -23,6 +23,20 @@ export interface ListAuditTasksCommandOutput extends ListAuditTasksResponse, __M /** *

Lists the Device Defender audits that have been performed during a given * time period.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { IoTClient, ListAuditTasksCommand } from "@aws-sdk/client-iot"; // ES Modules import + * // const { IoTClient, ListAuditTasksCommand } = require("@aws-sdk/client-iot"); // CommonJS import + * const client = new IoTClient(config); + * const command = new ListAuditTasksCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListAuditTasksCommandInput} for command's `input` shape. + * @see {@link ListAuditTasksCommandOutput} for command's `response` shape. + * @see {@link IoTClientResolvedConfig | config} for command's `input` shape. + * */ export class ListAuditTasksCommand extends $Command< ListAuditTasksCommandInput, diff --git a/clients/client-iot/commands/ListAuthorizersCommand.ts b/clients/client-iot/commands/ListAuthorizersCommand.ts index a9ab73046073..7c9318613a1f 100644 --- a/clients/client-iot/commands/ListAuthorizersCommand.ts +++ b/clients/client-iot/commands/ListAuthorizersCommand.ts @@ -22,6 +22,20 @@ export interface ListAuthorizersCommandOutput extends ListAuthorizersResponse, _ /** *

Lists the authorizers registered in your account.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { IoTClient, ListAuthorizersCommand } from "@aws-sdk/client-iot"; // ES Modules import + * // const { IoTClient, ListAuthorizersCommand } = require("@aws-sdk/client-iot"); // CommonJS import + * const client = new IoTClient(config); + * const command = new ListAuthorizersCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListAuthorizersCommandInput} for command's `input` shape. + * @see {@link ListAuthorizersCommandOutput} for command's `response` shape. + * @see {@link IoTClientResolvedConfig | config} for command's `input` shape. + * */ export class ListAuthorizersCommand extends $Command< ListAuthorizersCommandInput, diff --git a/clients/client-iot/commands/ListBillingGroupsCommand.ts b/clients/client-iot/commands/ListBillingGroupsCommand.ts index 00f2a44081eb..fdf99c42fa2b 100644 --- a/clients/client-iot/commands/ListBillingGroupsCommand.ts +++ b/clients/client-iot/commands/ListBillingGroupsCommand.ts @@ -22,6 +22,20 @@ export interface ListBillingGroupsCommandOutput extends ListBillingGroupsRespons /** *

Lists the billing groups you have created.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { IoTClient, ListBillingGroupsCommand } from "@aws-sdk/client-iot"; // ES Modules import + * // const { IoTClient, ListBillingGroupsCommand } = require("@aws-sdk/client-iot"); // CommonJS import + * const client = new IoTClient(config); + * const command = new ListBillingGroupsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListBillingGroupsCommandInput} for command's `input` shape. + * @see {@link ListBillingGroupsCommandOutput} for command's `response` shape. + * @see {@link IoTClientResolvedConfig | config} for command's `input` shape. + * */ export class ListBillingGroupsCommand extends $Command< ListBillingGroupsCommandInput, diff --git a/clients/client-iot/commands/ListCACertificatesCommand.ts b/clients/client-iot/commands/ListCACertificatesCommand.ts index 72084ce09170..6ac088ad4454 100644 --- a/clients/client-iot/commands/ListCACertificatesCommand.ts +++ b/clients/client-iot/commands/ListCACertificatesCommand.ts @@ -24,6 +24,20 @@ export interface ListCACertificatesCommandOutput extends ListCACertificatesRespo *

Lists the CA certificates registered for your AWS account.

*

The results are paginated with a default page size of 25. You can use the returned * marker to retrieve additional results.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { IoTClient, ListCACertificatesCommand } from "@aws-sdk/client-iot"; // ES Modules import + * // const { IoTClient, ListCACertificatesCommand } = require("@aws-sdk/client-iot"); // CommonJS import + * const client = new IoTClient(config); + * const command = new ListCACertificatesCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListCACertificatesCommandInput} for command's `input` shape. + * @see {@link ListCACertificatesCommandOutput} for command's `response` shape. + * @see {@link IoTClientResolvedConfig | config} for command's `input` shape. + * */ export class ListCACertificatesCommand extends $Command< ListCACertificatesCommandInput, diff --git a/clients/client-iot/commands/ListCertificatesByCACommand.ts b/clients/client-iot/commands/ListCertificatesByCACommand.ts index d14132c2db92..1b13fe633b25 100644 --- a/clients/client-iot/commands/ListCertificatesByCACommand.ts +++ b/clients/client-iot/commands/ListCertificatesByCACommand.ts @@ -22,6 +22,20 @@ export interface ListCertificatesByCACommandOutput extends ListCertificatesByCAR /** *

List the device certificates signed by the specified CA certificate.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { IoTClient, ListCertificatesByCACommand } from "@aws-sdk/client-iot"; // ES Modules import + * // const { IoTClient, ListCertificatesByCACommand } = require("@aws-sdk/client-iot"); // CommonJS import + * const client = new IoTClient(config); + * const command = new ListCertificatesByCACommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListCertificatesByCACommandInput} for command's `input` shape. + * @see {@link ListCertificatesByCACommandOutput} for command's `response` shape. + * @see {@link IoTClientResolvedConfig | config} for command's `input` shape. + * */ export class ListCertificatesByCACommand extends $Command< ListCertificatesByCACommandInput, diff --git a/clients/client-iot/commands/ListCertificatesCommand.ts b/clients/client-iot/commands/ListCertificatesCommand.ts index 030265ef6d9b..3773614e624f 100644 --- a/clients/client-iot/commands/ListCertificatesCommand.ts +++ b/clients/client-iot/commands/ListCertificatesCommand.ts @@ -24,6 +24,20 @@ export interface ListCertificatesCommandOutput extends ListCertificatesResponse, *

Lists the certificates registered in your AWS account.

*

The results are paginated with a default page size of 25. You can use the returned * marker to retrieve additional results.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { IoTClient, ListCertificatesCommand } from "@aws-sdk/client-iot"; // ES Modules import + * // const { IoTClient, ListCertificatesCommand } = require("@aws-sdk/client-iot"); // CommonJS import + * const client = new IoTClient(config); + * const command = new ListCertificatesCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListCertificatesCommandInput} for command's `input` shape. + * @see {@link ListCertificatesCommandOutput} for command's `response` shape. + * @see {@link IoTClientResolvedConfig | config} for command's `input` shape. + * */ export class ListCertificatesCommand extends $Command< ListCertificatesCommandInput, diff --git a/clients/client-iot/commands/ListCustomMetricsCommand.ts b/clients/client-iot/commands/ListCustomMetricsCommand.ts index b7d6c6d84db2..60db0da9a93a 100644 --- a/clients/client-iot/commands/ListCustomMetricsCommand.ts +++ b/clients/client-iot/commands/ListCustomMetricsCommand.ts @@ -24,6 +24,20 @@ export interface ListCustomMetricsCommandOutput extends ListCustomMetricsRespons *

* Lists your Device Defender detect custom metrics. *

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { IoTClient, ListCustomMetricsCommand } from "@aws-sdk/client-iot"; // ES Modules import + * // const { IoTClient, ListCustomMetricsCommand } = require("@aws-sdk/client-iot"); // CommonJS import + * const client = new IoTClient(config); + * const command = new ListCustomMetricsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListCustomMetricsCommandInput} for command's `input` shape. + * @see {@link ListCustomMetricsCommandOutput} for command's `response` shape. + * @see {@link IoTClientResolvedConfig | config} for command's `input` shape. + * */ export class ListCustomMetricsCommand extends $Command< ListCustomMetricsCommandInput, diff --git a/clients/client-iot/commands/ListDetectMitigationActionsExecutionsCommand.ts b/clients/client-iot/commands/ListDetectMitigationActionsExecutionsCommand.ts index 564c397ef370..3fe04a9d8c0f 100644 --- a/clients/client-iot/commands/ListDetectMitigationActionsExecutionsCommand.ts +++ b/clients/client-iot/commands/ListDetectMitigationActionsExecutionsCommand.ts @@ -30,6 +30,20 @@ export interface ListDetectMitigationActionsExecutionsCommandOutput *

* Lists mitigation actions executions for a Device Defender ML Detect Security Profile. *

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { IoTClient, ListDetectMitigationActionsExecutionsCommand } from "@aws-sdk/client-iot"; // ES Modules import + * // const { IoTClient, ListDetectMitigationActionsExecutionsCommand } = require("@aws-sdk/client-iot"); // CommonJS import + * const client = new IoTClient(config); + * const command = new ListDetectMitigationActionsExecutionsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListDetectMitigationActionsExecutionsCommandInput} for command's `input` shape. + * @see {@link ListDetectMitigationActionsExecutionsCommandOutput} for command's `response` shape. + * @see {@link IoTClientResolvedConfig | config} for command's `input` shape. + * */ export class ListDetectMitigationActionsExecutionsCommand extends $Command< ListDetectMitigationActionsExecutionsCommandInput, diff --git a/clients/client-iot/commands/ListDetectMitigationActionsTasksCommand.ts b/clients/client-iot/commands/ListDetectMitigationActionsTasksCommand.ts index 31855e4e621a..fc85f3bfca49 100644 --- a/clients/client-iot/commands/ListDetectMitigationActionsTasksCommand.ts +++ b/clients/client-iot/commands/ListDetectMitigationActionsTasksCommand.ts @@ -26,6 +26,20 @@ export interface ListDetectMitigationActionsTasksCommandOutput *

* List of Device Defender ML Detect mitigation actions tasks. *

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { IoTClient, ListDetectMitigationActionsTasksCommand } from "@aws-sdk/client-iot"; // ES Modules import + * // const { IoTClient, ListDetectMitigationActionsTasksCommand } = require("@aws-sdk/client-iot"); // CommonJS import + * const client = new IoTClient(config); + * const command = new ListDetectMitigationActionsTasksCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListDetectMitigationActionsTasksCommandInput} for command's `input` shape. + * @see {@link ListDetectMitigationActionsTasksCommandOutput} for command's `response` shape. + * @see {@link IoTClientResolvedConfig | config} for command's `input` shape. + * */ export class ListDetectMitigationActionsTasksCommand extends $Command< ListDetectMitigationActionsTasksCommandInput, diff --git a/clients/client-iot/commands/ListDimensionsCommand.ts b/clients/client-iot/commands/ListDimensionsCommand.ts index 1e3400a1f20f..54ee3e656d96 100644 --- a/clients/client-iot/commands/ListDimensionsCommand.ts +++ b/clients/client-iot/commands/ListDimensionsCommand.ts @@ -22,6 +22,20 @@ export interface ListDimensionsCommandOutput extends ListDimensionsResponse, __M /** *

List the set of dimensions that are defined for your AWS account.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { IoTClient, ListDimensionsCommand } from "@aws-sdk/client-iot"; // ES Modules import + * // const { IoTClient, ListDimensionsCommand } = require("@aws-sdk/client-iot"); // CommonJS import + * const client = new IoTClient(config); + * const command = new ListDimensionsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListDimensionsCommandInput} for command's `input` shape. + * @see {@link ListDimensionsCommandOutput} for command's `response` shape. + * @see {@link IoTClientResolvedConfig | config} for command's `input` shape. + * */ export class ListDimensionsCommand extends $Command< ListDimensionsCommandInput, diff --git a/clients/client-iot/commands/ListDomainConfigurationsCommand.ts b/clients/client-iot/commands/ListDomainConfigurationsCommand.ts index e45fc2000bdd..de55a88a6d12 100644 --- a/clients/client-iot/commands/ListDomainConfigurationsCommand.ts +++ b/clients/client-iot/commands/ListDomainConfigurationsCommand.ts @@ -25,6 +25,20 @@ export interface ListDomainConfigurationsCommandOutput extends ListDomainConfigu * *

The domain configuration feature is in public preview and is subject to change.

* + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { IoTClient, ListDomainConfigurationsCommand } from "@aws-sdk/client-iot"; // ES Modules import + * // const { IoTClient, ListDomainConfigurationsCommand } = require("@aws-sdk/client-iot"); // CommonJS import + * const client = new IoTClient(config); + * const command = new ListDomainConfigurationsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListDomainConfigurationsCommandInput} for command's `input` shape. + * @see {@link ListDomainConfigurationsCommandOutput} for command's `response` shape. + * @see {@link IoTClientResolvedConfig | config} for command's `input` shape. + * */ export class ListDomainConfigurationsCommand extends $Command< ListDomainConfigurationsCommandInput, diff --git a/clients/client-iot/commands/ListIndicesCommand.ts b/clients/client-iot/commands/ListIndicesCommand.ts index 3b6e995f1e29..cd366e2d5c33 100644 --- a/clients/client-iot/commands/ListIndicesCommand.ts +++ b/clients/client-iot/commands/ListIndicesCommand.ts @@ -22,6 +22,20 @@ export interface ListIndicesCommandOutput extends ListIndicesResponse, __Metadat /** *

Lists the search indices.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { IoTClient, ListIndicesCommand } from "@aws-sdk/client-iot"; // ES Modules import + * // const { IoTClient, ListIndicesCommand } = require("@aws-sdk/client-iot"); // CommonJS import + * const client = new IoTClient(config); + * const command = new ListIndicesCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListIndicesCommandInput} for command's `input` shape. + * @see {@link ListIndicesCommandOutput} for command's `response` shape. + * @see {@link IoTClientResolvedConfig | config} for command's `input` shape. + * */ export class ListIndicesCommand extends $Command< ListIndicesCommandInput, diff --git a/clients/client-iot/commands/ListJobExecutionsForJobCommand.ts b/clients/client-iot/commands/ListJobExecutionsForJobCommand.ts index fe79c82207b4..4a4b7343a48c 100644 --- a/clients/client-iot/commands/ListJobExecutionsForJobCommand.ts +++ b/clients/client-iot/commands/ListJobExecutionsForJobCommand.ts @@ -22,6 +22,20 @@ export interface ListJobExecutionsForJobCommandOutput extends ListJobExecutionsF /** *

Lists the job executions for a job.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { IoTClient, ListJobExecutionsForJobCommand } from "@aws-sdk/client-iot"; // ES Modules import + * // const { IoTClient, ListJobExecutionsForJobCommand } = require("@aws-sdk/client-iot"); // CommonJS import + * const client = new IoTClient(config); + * const command = new ListJobExecutionsForJobCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListJobExecutionsForJobCommandInput} for command's `input` shape. + * @see {@link ListJobExecutionsForJobCommandOutput} for command's `response` shape. + * @see {@link IoTClientResolvedConfig | config} for command's `input` shape. + * */ export class ListJobExecutionsForJobCommand extends $Command< ListJobExecutionsForJobCommandInput, diff --git a/clients/client-iot/commands/ListJobExecutionsForThingCommand.ts b/clients/client-iot/commands/ListJobExecutionsForThingCommand.ts index ac055a7d828e..35c5dba8b0a0 100644 --- a/clients/client-iot/commands/ListJobExecutionsForThingCommand.ts +++ b/clients/client-iot/commands/ListJobExecutionsForThingCommand.ts @@ -22,6 +22,20 @@ export interface ListJobExecutionsForThingCommandOutput extends ListJobExecution /** *

Lists the job executions for the specified thing.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { IoTClient, ListJobExecutionsForThingCommand } from "@aws-sdk/client-iot"; // ES Modules import + * // const { IoTClient, ListJobExecutionsForThingCommand } = require("@aws-sdk/client-iot"); // CommonJS import + * const client = new IoTClient(config); + * const command = new ListJobExecutionsForThingCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListJobExecutionsForThingCommandInput} for command's `input` shape. + * @see {@link ListJobExecutionsForThingCommandOutput} for command's `response` shape. + * @see {@link IoTClientResolvedConfig | config} for command's `input` shape. + * */ export class ListJobExecutionsForThingCommand extends $Command< ListJobExecutionsForThingCommandInput, diff --git a/clients/client-iot/commands/ListJobsCommand.ts b/clients/client-iot/commands/ListJobsCommand.ts index 4cdcef944c3c..22f67c46c9b9 100644 --- a/clients/client-iot/commands/ListJobsCommand.ts +++ b/clients/client-iot/commands/ListJobsCommand.ts @@ -22,6 +22,20 @@ export interface ListJobsCommandOutput extends ListJobsResponse, __MetadataBeare /** *

Lists jobs.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { IoTClient, ListJobsCommand } from "@aws-sdk/client-iot"; // ES Modules import + * // const { IoTClient, ListJobsCommand } = require("@aws-sdk/client-iot"); // CommonJS import + * const client = new IoTClient(config); + * const command = new ListJobsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListJobsCommandInput} for command's `input` shape. + * @see {@link ListJobsCommandOutput} for command's `response` shape. + * @see {@link IoTClientResolvedConfig | config} for command's `input` shape. + * */ export class ListJobsCommand extends $Command { // Start section: command_properties diff --git a/clients/client-iot/commands/ListMitigationActionsCommand.ts b/clients/client-iot/commands/ListMitigationActionsCommand.ts index 8983a741129e..b43bd6bbaf97 100644 --- a/clients/client-iot/commands/ListMitigationActionsCommand.ts +++ b/clients/client-iot/commands/ListMitigationActionsCommand.ts @@ -22,6 +22,20 @@ export interface ListMitigationActionsCommandOutput extends ListMitigationAction /** *

Gets a list of all mitigation actions that match the specified filter criteria.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { IoTClient, ListMitigationActionsCommand } from "@aws-sdk/client-iot"; // ES Modules import + * // const { IoTClient, ListMitigationActionsCommand } = require("@aws-sdk/client-iot"); // CommonJS import + * const client = new IoTClient(config); + * const command = new ListMitigationActionsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListMitigationActionsCommandInput} for command's `input` shape. + * @see {@link ListMitigationActionsCommandOutput} for command's `response` shape. + * @see {@link IoTClientResolvedConfig | config} for command's `input` shape. + * */ export class ListMitigationActionsCommand extends $Command< ListMitigationActionsCommandInput, diff --git a/clients/client-iot/commands/ListOTAUpdatesCommand.ts b/clients/client-iot/commands/ListOTAUpdatesCommand.ts index 5d012b3684a0..4c979e17f05d 100644 --- a/clients/client-iot/commands/ListOTAUpdatesCommand.ts +++ b/clients/client-iot/commands/ListOTAUpdatesCommand.ts @@ -22,6 +22,20 @@ export interface ListOTAUpdatesCommandOutput extends ListOTAUpdatesResponse, __M /** *

Lists OTA updates.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { IoTClient, ListOTAUpdatesCommand } from "@aws-sdk/client-iot"; // ES Modules import + * // const { IoTClient, ListOTAUpdatesCommand } = require("@aws-sdk/client-iot"); // CommonJS import + * const client = new IoTClient(config); + * const command = new ListOTAUpdatesCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListOTAUpdatesCommandInput} for command's `input` shape. + * @see {@link ListOTAUpdatesCommandOutput} for command's `response` shape. + * @see {@link IoTClientResolvedConfig | config} for command's `input` shape. + * */ export class ListOTAUpdatesCommand extends $Command< ListOTAUpdatesCommandInput, diff --git a/clients/client-iot/commands/ListOutgoingCertificatesCommand.ts b/clients/client-iot/commands/ListOutgoingCertificatesCommand.ts index 7ba6605a19bb..5268a9aac3af 100644 --- a/clients/client-iot/commands/ListOutgoingCertificatesCommand.ts +++ b/clients/client-iot/commands/ListOutgoingCertificatesCommand.ts @@ -22,6 +22,20 @@ export interface ListOutgoingCertificatesCommandOutput extends ListOutgoingCerti /** *

Lists certificates that are being transferred but not yet accepted.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { IoTClient, ListOutgoingCertificatesCommand } from "@aws-sdk/client-iot"; // ES Modules import + * // const { IoTClient, ListOutgoingCertificatesCommand } = require("@aws-sdk/client-iot"); // CommonJS import + * const client = new IoTClient(config); + * const command = new ListOutgoingCertificatesCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListOutgoingCertificatesCommandInput} for command's `input` shape. + * @see {@link ListOutgoingCertificatesCommandOutput} for command's `response` shape. + * @see {@link IoTClientResolvedConfig | config} for command's `input` shape. + * */ export class ListOutgoingCertificatesCommand extends $Command< ListOutgoingCertificatesCommandInput, diff --git a/clients/client-iot/commands/ListPoliciesCommand.ts b/clients/client-iot/commands/ListPoliciesCommand.ts index 0b09791565ac..a96658115ccb 100644 --- a/clients/client-iot/commands/ListPoliciesCommand.ts +++ b/clients/client-iot/commands/ListPoliciesCommand.ts @@ -22,6 +22,20 @@ export interface ListPoliciesCommandOutput extends ListPoliciesResponse, __Metad /** *

Lists your policies.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { IoTClient, ListPoliciesCommand } from "@aws-sdk/client-iot"; // ES Modules import + * // const { IoTClient, ListPoliciesCommand } = require("@aws-sdk/client-iot"); // CommonJS import + * const client = new IoTClient(config); + * const command = new ListPoliciesCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListPoliciesCommandInput} for command's `input` shape. + * @see {@link ListPoliciesCommandOutput} for command's `response` shape. + * @see {@link IoTClientResolvedConfig | config} for command's `input` shape. + * */ export class ListPoliciesCommand extends $Command< ListPoliciesCommandInput, diff --git a/clients/client-iot/commands/ListPolicyPrincipalsCommand.ts b/clients/client-iot/commands/ListPolicyPrincipalsCommand.ts index b185fd3a10f7..7b114eb624cb 100644 --- a/clients/client-iot/commands/ListPolicyPrincipalsCommand.ts +++ b/clients/client-iot/commands/ListPolicyPrincipalsCommand.ts @@ -26,6 +26,20 @@ export interface ListPolicyPrincipalsCommandOutput extends ListPolicyPrincipalsR *

Lists the principals associated with the specified policy.

*

* Note: This API is deprecated. Please use ListTargetsForPolicy instead.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { IoTClient, ListPolicyPrincipalsCommand } from "@aws-sdk/client-iot"; // ES Modules import + * // const { IoTClient, ListPolicyPrincipalsCommand } = require("@aws-sdk/client-iot"); // CommonJS import + * const client = new IoTClient(config); + * const command = new ListPolicyPrincipalsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListPolicyPrincipalsCommandInput} for command's `input` shape. + * @see {@link ListPolicyPrincipalsCommandOutput} for command's `response` shape. + * @see {@link IoTClientResolvedConfig | config} for command's `input` shape. + * */ export class ListPolicyPrincipalsCommand extends $Command< ListPolicyPrincipalsCommandInput, diff --git a/clients/client-iot/commands/ListPolicyVersionsCommand.ts b/clients/client-iot/commands/ListPolicyVersionsCommand.ts index bcc610593d81..2e9dbf604f46 100644 --- a/clients/client-iot/commands/ListPolicyVersionsCommand.ts +++ b/clients/client-iot/commands/ListPolicyVersionsCommand.ts @@ -23,6 +23,20 @@ export interface ListPolicyVersionsCommandOutput extends ListPolicyVersionsRespo /** *

Lists the versions of the specified policy and identifies the default * version.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { IoTClient, ListPolicyVersionsCommand } from "@aws-sdk/client-iot"; // ES Modules import + * // const { IoTClient, ListPolicyVersionsCommand } = require("@aws-sdk/client-iot"); // CommonJS import + * const client = new IoTClient(config); + * const command = new ListPolicyVersionsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListPolicyVersionsCommandInput} for command's `input` shape. + * @see {@link ListPolicyVersionsCommandOutput} for command's `response` shape. + * @see {@link IoTClientResolvedConfig | config} for command's `input` shape. + * */ export class ListPolicyVersionsCommand extends $Command< ListPolicyVersionsCommandInput, diff --git a/clients/client-iot/commands/ListPrincipalPoliciesCommand.ts b/clients/client-iot/commands/ListPrincipalPoliciesCommand.ts index 6c44902e47c3..bb9420f5b0f6 100644 --- a/clients/client-iot/commands/ListPrincipalPoliciesCommand.ts +++ b/clients/client-iot/commands/ListPrincipalPoliciesCommand.ts @@ -27,6 +27,20 @@ export interface ListPrincipalPoliciesCommandOutput extends ListPrincipalPolicie * identity, the ID must be in AmazonCognito Identity format.

*

* Note: This API is deprecated. Please use ListAttachedPolicies instead.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { IoTClient, ListPrincipalPoliciesCommand } from "@aws-sdk/client-iot"; // ES Modules import + * // const { IoTClient, ListPrincipalPoliciesCommand } = require("@aws-sdk/client-iot"); // CommonJS import + * const client = new IoTClient(config); + * const command = new ListPrincipalPoliciesCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListPrincipalPoliciesCommandInput} for command's `input` shape. + * @see {@link ListPrincipalPoliciesCommandOutput} for command's `response` shape. + * @see {@link IoTClientResolvedConfig | config} for command's `input` shape. + * */ export class ListPrincipalPoliciesCommand extends $Command< ListPrincipalPoliciesCommandInput, diff --git a/clients/client-iot/commands/ListPrincipalThingsCommand.ts b/clients/client-iot/commands/ListPrincipalThingsCommand.ts index 8dc95176afe8..1c47f418ac6e 100644 --- a/clients/client-iot/commands/ListPrincipalThingsCommand.ts +++ b/clients/client-iot/commands/ListPrincipalThingsCommand.ts @@ -24,6 +24,20 @@ export interface ListPrincipalThingsCommandOutput extends ListPrincipalThingsRes *

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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { IoTClient, ListPrincipalThingsCommand } from "@aws-sdk/client-iot"; // ES Modules import + * // const { IoTClient, ListPrincipalThingsCommand } = require("@aws-sdk/client-iot"); // CommonJS import + * const client = new IoTClient(config); + * const command = new ListPrincipalThingsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListPrincipalThingsCommandInput} for command's `input` shape. + * @see {@link ListPrincipalThingsCommandOutput} for command's `response` shape. + * @see {@link IoTClientResolvedConfig | config} for command's `input` shape. + * */ export class ListPrincipalThingsCommand extends $Command< ListPrincipalThingsCommandInput, diff --git a/clients/client-iot/commands/ListProvisioningTemplateVersionsCommand.ts b/clients/client-iot/commands/ListProvisioningTemplateVersionsCommand.ts index 1ad5df998f22..6747436e80c1 100644 --- a/clients/client-iot/commands/ListProvisioningTemplateVersionsCommand.ts +++ b/clients/client-iot/commands/ListProvisioningTemplateVersionsCommand.ts @@ -24,6 +24,20 @@ export interface ListProvisioningTemplateVersionsCommandOutput /** *

A list of fleet provisioning template versions.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { IoTClient, ListProvisioningTemplateVersionsCommand } from "@aws-sdk/client-iot"; // ES Modules import + * // const { IoTClient, ListProvisioningTemplateVersionsCommand } = require("@aws-sdk/client-iot"); // CommonJS import + * const client = new IoTClient(config); + * const command = new ListProvisioningTemplateVersionsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListProvisioningTemplateVersionsCommandInput} for command's `input` shape. + * @see {@link ListProvisioningTemplateVersionsCommandOutput} for command's `response` shape. + * @see {@link IoTClientResolvedConfig | config} for command's `input` shape. + * */ export class ListProvisioningTemplateVersionsCommand extends $Command< ListProvisioningTemplateVersionsCommandInput, diff --git a/clients/client-iot/commands/ListProvisioningTemplatesCommand.ts b/clients/client-iot/commands/ListProvisioningTemplatesCommand.ts index e8798298515f..12e5080be4be 100644 --- a/clients/client-iot/commands/ListProvisioningTemplatesCommand.ts +++ b/clients/client-iot/commands/ListProvisioningTemplatesCommand.ts @@ -22,6 +22,20 @@ export interface ListProvisioningTemplatesCommandOutput extends ListProvisioning /** *

Lists the fleet provisioning templates in your AWS account.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { IoTClient, ListProvisioningTemplatesCommand } from "@aws-sdk/client-iot"; // ES Modules import + * // const { IoTClient, ListProvisioningTemplatesCommand } = require("@aws-sdk/client-iot"); // CommonJS import + * const client = new IoTClient(config); + * const command = new ListProvisioningTemplatesCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListProvisioningTemplatesCommandInput} for command's `input` shape. + * @see {@link ListProvisioningTemplatesCommandOutput} for command's `response` shape. + * @see {@link IoTClientResolvedConfig | config} for command's `input` shape. + * */ export class ListProvisioningTemplatesCommand extends $Command< ListProvisioningTemplatesCommandInput, diff --git a/clients/client-iot/commands/ListRoleAliasesCommand.ts b/clients/client-iot/commands/ListRoleAliasesCommand.ts index 9829b3057c83..f4c07d97a535 100644 --- a/clients/client-iot/commands/ListRoleAliasesCommand.ts +++ b/clients/client-iot/commands/ListRoleAliasesCommand.ts @@ -22,6 +22,20 @@ export interface ListRoleAliasesCommandOutput extends ListRoleAliasesResponse, _ /** *

Lists the role aliases registered in your account.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { IoTClient, ListRoleAliasesCommand } from "@aws-sdk/client-iot"; // ES Modules import + * // const { IoTClient, ListRoleAliasesCommand } = require("@aws-sdk/client-iot"); // CommonJS import + * const client = new IoTClient(config); + * const command = new ListRoleAliasesCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListRoleAliasesCommandInput} for command's `input` shape. + * @see {@link ListRoleAliasesCommandOutput} for command's `response` shape. + * @see {@link IoTClientResolvedConfig | config} for command's `input` shape. + * */ export class ListRoleAliasesCommand extends $Command< ListRoleAliasesCommandInput, diff --git a/clients/client-iot/commands/ListScheduledAuditsCommand.ts b/clients/client-iot/commands/ListScheduledAuditsCommand.ts index 775a6d58a26d..0429e5e286e6 100644 --- a/clients/client-iot/commands/ListScheduledAuditsCommand.ts +++ b/clients/client-iot/commands/ListScheduledAuditsCommand.ts @@ -22,6 +22,20 @@ export interface ListScheduledAuditsCommandOutput extends ListScheduledAuditsRes /** *

Lists all of your scheduled audits.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { IoTClient, ListScheduledAuditsCommand } from "@aws-sdk/client-iot"; // ES Modules import + * // const { IoTClient, ListScheduledAuditsCommand } = require("@aws-sdk/client-iot"); // CommonJS import + * const client = new IoTClient(config); + * const command = new ListScheduledAuditsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListScheduledAuditsCommandInput} for command's `input` shape. + * @see {@link ListScheduledAuditsCommandOutput} for command's `response` shape. + * @see {@link IoTClientResolvedConfig | config} for command's `input` shape. + * */ export class ListScheduledAuditsCommand extends $Command< ListScheduledAuditsCommandInput, diff --git a/clients/client-iot/commands/ListSecurityProfilesCommand.ts b/clients/client-iot/commands/ListSecurityProfilesCommand.ts index 6158f3042172..45e3ecc12c8f 100644 --- a/clients/client-iot/commands/ListSecurityProfilesCommand.ts +++ b/clients/client-iot/commands/ListSecurityProfilesCommand.ts @@ -28,6 +28,20 @@ export interface ListSecurityProfilesCommandOutput extends ListSecurityProfilesR *

* dimensionName and metricName cannot be used in the same request.

* + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { IoTClient, ListSecurityProfilesCommand } from "@aws-sdk/client-iot"; // ES Modules import + * // const { IoTClient, ListSecurityProfilesCommand } = require("@aws-sdk/client-iot"); // CommonJS import + * const client = new IoTClient(config); + * const command = new ListSecurityProfilesCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListSecurityProfilesCommandInput} for command's `input` shape. + * @see {@link ListSecurityProfilesCommandOutput} for command's `response` shape. + * @see {@link IoTClientResolvedConfig | config} for command's `input` shape. + * */ export class ListSecurityProfilesCommand extends $Command< ListSecurityProfilesCommandInput, diff --git a/clients/client-iot/commands/ListSecurityProfilesForTargetCommand.ts b/clients/client-iot/commands/ListSecurityProfilesForTargetCommand.ts index 45f16e33962a..5cbdd2413622 100644 --- a/clients/client-iot/commands/ListSecurityProfilesForTargetCommand.ts +++ b/clients/client-iot/commands/ListSecurityProfilesForTargetCommand.ts @@ -24,6 +24,20 @@ export interface ListSecurityProfilesForTargetCommandOutput /** *

Lists the Device Defender security profiles attached to a target (thing group).

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { IoTClient, ListSecurityProfilesForTargetCommand } from "@aws-sdk/client-iot"; // ES Modules import + * // const { IoTClient, ListSecurityProfilesForTargetCommand } = require("@aws-sdk/client-iot"); // CommonJS import + * const client = new IoTClient(config); + * const command = new ListSecurityProfilesForTargetCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListSecurityProfilesForTargetCommandInput} for command's `input` shape. + * @see {@link ListSecurityProfilesForTargetCommandOutput} for command's `response` shape. + * @see {@link IoTClientResolvedConfig | config} for command's `input` shape. + * */ export class ListSecurityProfilesForTargetCommand extends $Command< ListSecurityProfilesForTargetCommandInput, diff --git a/clients/client-iot/commands/ListStreamsCommand.ts b/clients/client-iot/commands/ListStreamsCommand.ts index 9e3b94e69cf2..f90ef889c030 100644 --- a/clients/client-iot/commands/ListStreamsCommand.ts +++ b/clients/client-iot/commands/ListStreamsCommand.ts @@ -22,6 +22,20 @@ export interface ListStreamsCommandOutput extends ListStreamsResponse, __Metadat /** *

Lists all of the streams in your AWS account.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { IoTClient, ListStreamsCommand } from "@aws-sdk/client-iot"; // ES Modules import + * // const { IoTClient, ListStreamsCommand } = require("@aws-sdk/client-iot"); // CommonJS import + * const client = new IoTClient(config); + * const command = new ListStreamsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListStreamsCommandInput} for command's `input` shape. + * @see {@link ListStreamsCommandOutput} for command's `response` shape. + * @see {@link IoTClientResolvedConfig | config} for command's `input` shape. + * */ export class ListStreamsCommand extends $Command< ListStreamsCommandInput, diff --git a/clients/client-iot/commands/ListTagsForResourceCommand.ts b/clients/client-iot/commands/ListTagsForResourceCommand.ts index 260104341925..66abf21682d0 100644 --- a/clients/client-iot/commands/ListTagsForResourceCommand.ts +++ b/clients/client-iot/commands/ListTagsForResourceCommand.ts @@ -22,6 +22,20 @@ export interface ListTagsForResourceCommandOutput extends ListTagsForResourceRes /** *

Lists the tags (metadata) you have assigned to the resource.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { IoTClient, ListTagsForResourceCommand } from "@aws-sdk/client-iot"; // ES Modules import + * // const { IoTClient, ListTagsForResourceCommand } = require("@aws-sdk/client-iot"); // CommonJS import + * const client = new IoTClient(config); + * const command = new ListTagsForResourceCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListTagsForResourceCommandInput} for command's `input` shape. + * @see {@link ListTagsForResourceCommandOutput} for command's `response` shape. + * @see {@link IoTClientResolvedConfig | config} for command's `input` shape. + * */ export class ListTagsForResourceCommand extends $Command< ListTagsForResourceCommandInput, diff --git a/clients/client-iot/commands/ListTargetsForPolicyCommand.ts b/clients/client-iot/commands/ListTargetsForPolicyCommand.ts index 7ac06dbfb47f..d79b8e3ae0ff 100644 --- a/clients/client-iot/commands/ListTargetsForPolicyCommand.ts +++ b/clients/client-iot/commands/ListTargetsForPolicyCommand.ts @@ -22,6 +22,20 @@ export interface ListTargetsForPolicyCommandOutput extends ListTargetsForPolicyR /** *

List targets for the specified policy.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { IoTClient, ListTargetsForPolicyCommand } from "@aws-sdk/client-iot"; // ES Modules import + * // const { IoTClient, ListTargetsForPolicyCommand } = require("@aws-sdk/client-iot"); // CommonJS import + * const client = new IoTClient(config); + * const command = new ListTargetsForPolicyCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListTargetsForPolicyCommandInput} for command's `input` shape. + * @see {@link ListTargetsForPolicyCommandOutput} for command's `response` shape. + * @see {@link IoTClientResolvedConfig | config} for command's `input` shape. + * */ export class ListTargetsForPolicyCommand extends $Command< ListTargetsForPolicyCommandInput, diff --git a/clients/client-iot/commands/ListTargetsForSecurityProfileCommand.ts b/clients/client-iot/commands/ListTargetsForSecurityProfileCommand.ts index 0c009f10ee52..2c772078a16c 100644 --- a/clients/client-iot/commands/ListTargetsForSecurityProfileCommand.ts +++ b/clients/client-iot/commands/ListTargetsForSecurityProfileCommand.ts @@ -24,6 +24,20 @@ export interface ListTargetsForSecurityProfileCommandOutput /** *

Lists the targets (thing groups) associated with a given Device Defender security profile.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { IoTClient, ListTargetsForSecurityProfileCommand } from "@aws-sdk/client-iot"; // ES Modules import + * // const { IoTClient, ListTargetsForSecurityProfileCommand } = require("@aws-sdk/client-iot"); // CommonJS import + * const client = new IoTClient(config); + * const command = new ListTargetsForSecurityProfileCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListTargetsForSecurityProfileCommandInput} for command's `input` shape. + * @see {@link ListTargetsForSecurityProfileCommandOutput} for command's `response` shape. + * @see {@link IoTClientResolvedConfig | config} for command's `input` shape. + * */ export class ListTargetsForSecurityProfileCommand extends $Command< ListTargetsForSecurityProfileCommandInput, diff --git a/clients/client-iot/commands/ListThingGroupsCommand.ts b/clients/client-iot/commands/ListThingGroupsCommand.ts index ed2955ab36fb..0359ff64b7ff 100644 --- a/clients/client-iot/commands/ListThingGroupsCommand.ts +++ b/clients/client-iot/commands/ListThingGroupsCommand.ts @@ -22,6 +22,20 @@ export interface ListThingGroupsCommandOutput extends ListThingGroupsResponse, _ /** *

List the thing groups in your account.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { IoTClient, ListThingGroupsCommand } from "@aws-sdk/client-iot"; // ES Modules import + * // const { IoTClient, ListThingGroupsCommand } = require("@aws-sdk/client-iot"); // CommonJS import + * const client = new IoTClient(config); + * const command = new ListThingGroupsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListThingGroupsCommandInput} for command's `input` shape. + * @see {@link ListThingGroupsCommandOutput} for command's `response` shape. + * @see {@link IoTClientResolvedConfig | config} for command's `input` shape. + * */ export class ListThingGroupsCommand extends $Command< ListThingGroupsCommandInput, diff --git a/clients/client-iot/commands/ListThingGroupsForThingCommand.ts b/clients/client-iot/commands/ListThingGroupsForThingCommand.ts index 08041bf6cef6..5e3859a49942 100644 --- a/clients/client-iot/commands/ListThingGroupsForThingCommand.ts +++ b/clients/client-iot/commands/ListThingGroupsForThingCommand.ts @@ -22,6 +22,20 @@ export interface ListThingGroupsForThingCommandOutput extends ListThingGroupsFor /** *

List the thing groups to which the specified thing belongs.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { IoTClient, ListThingGroupsForThingCommand } from "@aws-sdk/client-iot"; // ES Modules import + * // const { IoTClient, ListThingGroupsForThingCommand } = require("@aws-sdk/client-iot"); // CommonJS import + * const client = new IoTClient(config); + * const command = new ListThingGroupsForThingCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListThingGroupsForThingCommandInput} for command's `input` shape. + * @see {@link ListThingGroupsForThingCommandOutput} for command's `response` shape. + * @see {@link IoTClientResolvedConfig | config} for command's `input` shape. + * */ export class ListThingGroupsForThingCommand extends $Command< ListThingGroupsForThingCommandInput, diff --git a/clients/client-iot/commands/ListThingPrincipalsCommand.ts b/clients/client-iot/commands/ListThingPrincipalsCommand.ts index be7ba99a82ce..0d2af19432e0 100644 --- a/clients/client-iot/commands/ListThingPrincipalsCommand.ts +++ b/clients/client-iot/commands/ListThingPrincipalsCommand.ts @@ -24,6 +24,20 @@ export interface ListThingPrincipalsCommandOutput extends ListThingPrincipalsRes *

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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { IoTClient, ListThingPrincipalsCommand } from "@aws-sdk/client-iot"; // ES Modules import + * // const { IoTClient, ListThingPrincipalsCommand } = require("@aws-sdk/client-iot"); // CommonJS import + * const client = new IoTClient(config); + * const command = new ListThingPrincipalsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListThingPrincipalsCommandInput} for command's `input` shape. + * @see {@link ListThingPrincipalsCommandOutput} for command's `response` shape. + * @see {@link IoTClientResolvedConfig | config} for command's `input` shape. + * */ export class ListThingPrincipalsCommand extends $Command< ListThingPrincipalsCommandInput, diff --git a/clients/client-iot/commands/ListThingRegistrationTaskReportsCommand.ts b/clients/client-iot/commands/ListThingRegistrationTaskReportsCommand.ts index b753c79f3238..1f4c5f399714 100644 --- a/clients/client-iot/commands/ListThingRegistrationTaskReportsCommand.ts +++ b/clients/client-iot/commands/ListThingRegistrationTaskReportsCommand.ts @@ -24,6 +24,20 @@ export interface ListThingRegistrationTaskReportsCommandOutput /** *

Information about the thing registration tasks.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { IoTClient, ListThingRegistrationTaskReportsCommand } from "@aws-sdk/client-iot"; // ES Modules import + * // const { IoTClient, ListThingRegistrationTaskReportsCommand } = require("@aws-sdk/client-iot"); // CommonJS import + * const client = new IoTClient(config); + * const command = new ListThingRegistrationTaskReportsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListThingRegistrationTaskReportsCommandInput} for command's `input` shape. + * @see {@link ListThingRegistrationTaskReportsCommandOutput} for command's `response` shape. + * @see {@link IoTClientResolvedConfig | config} for command's `input` shape. + * */ export class ListThingRegistrationTaskReportsCommand extends $Command< ListThingRegistrationTaskReportsCommandInput, diff --git a/clients/client-iot/commands/ListThingRegistrationTasksCommand.ts b/clients/client-iot/commands/ListThingRegistrationTasksCommand.ts index 8cfc0560415b..da531293e8a6 100644 --- a/clients/client-iot/commands/ListThingRegistrationTasksCommand.ts +++ b/clients/client-iot/commands/ListThingRegistrationTasksCommand.ts @@ -22,6 +22,20 @@ export interface ListThingRegistrationTasksCommandOutput extends ListThingRegist /** *

List bulk thing provisioning tasks.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { IoTClient, ListThingRegistrationTasksCommand } from "@aws-sdk/client-iot"; // ES Modules import + * // const { IoTClient, ListThingRegistrationTasksCommand } = require("@aws-sdk/client-iot"); // CommonJS import + * const client = new IoTClient(config); + * const command = new ListThingRegistrationTasksCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListThingRegistrationTasksCommandInput} for command's `input` shape. + * @see {@link ListThingRegistrationTasksCommandOutput} for command's `response` shape. + * @see {@link IoTClientResolvedConfig | config} for command's `input` shape. + * */ export class ListThingRegistrationTasksCommand extends $Command< ListThingRegistrationTasksCommandInput, diff --git a/clients/client-iot/commands/ListThingTypesCommand.ts b/clients/client-iot/commands/ListThingTypesCommand.ts index f73cd2c12904..d15b969c282c 100644 --- a/clients/client-iot/commands/ListThingTypesCommand.ts +++ b/clients/client-iot/commands/ListThingTypesCommand.ts @@ -22,6 +22,20 @@ export interface ListThingTypesCommandOutput extends ListThingTypesResponse, __M /** *

Lists the existing thing types.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { IoTClient, ListThingTypesCommand } from "@aws-sdk/client-iot"; // ES Modules import + * // const { IoTClient, ListThingTypesCommand } = require("@aws-sdk/client-iot"); // CommonJS import + * const client = new IoTClient(config); + * const command = new ListThingTypesCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListThingTypesCommandInput} for command's `input` shape. + * @see {@link ListThingTypesCommandOutput} for command's `response` shape. + * @see {@link IoTClientResolvedConfig | config} for command's `input` shape. + * */ export class ListThingTypesCommand extends $Command< ListThingTypesCommandInput, diff --git a/clients/client-iot/commands/ListThingsCommand.ts b/clients/client-iot/commands/ListThingsCommand.ts index 3d71f42beb4d..b418782307a7 100644 --- a/clients/client-iot/commands/ListThingsCommand.ts +++ b/clients/client-iot/commands/ListThingsCommand.ts @@ -29,6 +29,20 @@ export interface ListThingsCommandOutput extends ListThingsResponse, __MetadataB * *

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.

* + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { IoTClient, ListThingsCommand } from "@aws-sdk/client-iot"; // ES Modules import + * // const { IoTClient, ListThingsCommand } = require("@aws-sdk/client-iot"); // CommonJS import + * const client = new IoTClient(config); + * const command = new ListThingsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListThingsCommandInput} for command's `input` shape. + * @see {@link ListThingsCommandOutput} for command's `response` shape. + * @see {@link IoTClientResolvedConfig | config} for command's `input` shape. + * */ export class ListThingsCommand extends $Command< ListThingsCommandInput, diff --git a/clients/client-iot/commands/ListThingsInBillingGroupCommand.ts b/clients/client-iot/commands/ListThingsInBillingGroupCommand.ts index 445f44a54fc0..eec7c8c73e54 100644 --- a/clients/client-iot/commands/ListThingsInBillingGroupCommand.ts +++ b/clients/client-iot/commands/ListThingsInBillingGroupCommand.ts @@ -22,6 +22,20 @@ export interface ListThingsInBillingGroupCommandOutput extends ListThingsInBilli /** *

Lists the things you have added to the given billing group.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { IoTClient, ListThingsInBillingGroupCommand } from "@aws-sdk/client-iot"; // ES Modules import + * // const { IoTClient, ListThingsInBillingGroupCommand } = require("@aws-sdk/client-iot"); // CommonJS import + * const client = new IoTClient(config); + * const command = new ListThingsInBillingGroupCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListThingsInBillingGroupCommandInput} for command's `input` shape. + * @see {@link ListThingsInBillingGroupCommandOutput} for command's `response` shape. + * @see {@link IoTClientResolvedConfig | config} for command's `input` shape. + * */ export class ListThingsInBillingGroupCommand extends $Command< ListThingsInBillingGroupCommandInput, diff --git a/clients/client-iot/commands/ListThingsInThingGroupCommand.ts b/clients/client-iot/commands/ListThingsInThingGroupCommand.ts index 09d0d0b9ccaa..d3be71f432c7 100644 --- a/clients/client-iot/commands/ListThingsInThingGroupCommand.ts +++ b/clients/client-iot/commands/ListThingsInThingGroupCommand.ts @@ -22,6 +22,20 @@ export interface ListThingsInThingGroupCommandOutput extends ListThingsInThingGr /** *

Lists the things in the specified group.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { IoTClient, ListThingsInThingGroupCommand } from "@aws-sdk/client-iot"; // ES Modules import + * // const { IoTClient, ListThingsInThingGroupCommand } = require("@aws-sdk/client-iot"); // CommonJS import + * const client = new IoTClient(config); + * const command = new ListThingsInThingGroupCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListThingsInThingGroupCommandInput} for command's `input` shape. + * @see {@link ListThingsInThingGroupCommandOutput} for command's `response` shape. + * @see {@link IoTClientResolvedConfig | config} for command's `input` shape. + * */ export class ListThingsInThingGroupCommand extends $Command< ListThingsInThingGroupCommandInput, diff --git a/clients/client-iot/commands/ListTopicRuleDestinationsCommand.ts b/clients/client-iot/commands/ListTopicRuleDestinationsCommand.ts index e0d25e7190a2..d326e79bb1df 100644 --- a/clients/client-iot/commands/ListTopicRuleDestinationsCommand.ts +++ b/clients/client-iot/commands/ListTopicRuleDestinationsCommand.ts @@ -22,6 +22,20 @@ export interface ListTopicRuleDestinationsCommandOutput extends ListTopicRuleDes /** *

Lists all the topic rule destinations in your AWS account.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { IoTClient, ListTopicRuleDestinationsCommand } from "@aws-sdk/client-iot"; // ES Modules import + * // const { IoTClient, ListTopicRuleDestinationsCommand } = require("@aws-sdk/client-iot"); // CommonJS import + * const client = new IoTClient(config); + * const command = new ListTopicRuleDestinationsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListTopicRuleDestinationsCommandInput} for command's `input` shape. + * @see {@link ListTopicRuleDestinationsCommandOutput} for command's `response` shape. + * @see {@link IoTClientResolvedConfig | config} for command's `input` shape. + * */ export class ListTopicRuleDestinationsCommand extends $Command< ListTopicRuleDestinationsCommandInput, diff --git a/clients/client-iot/commands/ListTopicRulesCommand.ts b/clients/client-iot/commands/ListTopicRulesCommand.ts index de831ae853e3..19a1c0f5c9ea 100644 --- a/clients/client-iot/commands/ListTopicRulesCommand.ts +++ b/clients/client-iot/commands/ListTopicRulesCommand.ts @@ -22,6 +22,20 @@ export interface ListTopicRulesCommandOutput extends ListTopicRulesResponse, __M /** *

Lists the rules for the specific topic.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { IoTClient, ListTopicRulesCommand } from "@aws-sdk/client-iot"; // ES Modules import + * // const { IoTClient, ListTopicRulesCommand } = require("@aws-sdk/client-iot"); // CommonJS import + * const client = new IoTClient(config); + * const command = new ListTopicRulesCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListTopicRulesCommandInput} for command's `input` shape. + * @see {@link ListTopicRulesCommandOutput} for command's `response` shape. + * @see {@link IoTClientResolvedConfig | config} for command's `input` shape. + * */ export class ListTopicRulesCommand extends $Command< ListTopicRulesCommandInput, diff --git a/clients/client-iot/commands/ListV2LoggingLevelsCommand.ts b/clients/client-iot/commands/ListV2LoggingLevelsCommand.ts index 62e9407afacc..61cbad2e30a6 100644 --- a/clients/client-iot/commands/ListV2LoggingLevelsCommand.ts +++ b/clients/client-iot/commands/ListV2LoggingLevelsCommand.ts @@ -22,6 +22,20 @@ export interface ListV2LoggingLevelsCommandOutput extends ListV2LoggingLevelsRes /** *

Lists logging levels.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { IoTClient, ListV2LoggingLevelsCommand } from "@aws-sdk/client-iot"; // ES Modules import + * // const { IoTClient, ListV2LoggingLevelsCommand } = require("@aws-sdk/client-iot"); // CommonJS import + * const client = new IoTClient(config); + * const command = new ListV2LoggingLevelsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListV2LoggingLevelsCommandInput} for command's `input` shape. + * @see {@link ListV2LoggingLevelsCommandOutput} for command's `response` shape. + * @see {@link IoTClientResolvedConfig | config} for command's `input` shape. + * */ export class ListV2LoggingLevelsCommand extends $Command< ListV2LoggingLevelsCommandInput, diff --git a/clients/client-iot/commands/ListViolationEventsCommand.ts b/clients/client-iot/commands/ListViolationEventsCommand.ts index 83b5b8d52d63..c9491ee25302 100644 --- a/clients/client-iot/commands/ListViolationEventsCommand.ts +++ b/clients/client-iot/commands/ListViolationEventsCommand.ts @@ -24,6 +24,20 @@ export interface ListViolationEventsCommandOutput extends ListViolationEventsRes *

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).

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { IoTClient, ListViolationEventsCommand } from "@aws-sdk/client-iot"; // ES Modules import + * // const { IoTClient, ListViolationEventsCommand } = require("@aws-sdk/client-iot"); // CommonJS import + * const client = new IoTClient(config); + * const command = new ListViolationEventsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListViolationEventsCommandInput} for command's `input` shape. + * @see {@link ListViolationEventsCommandOutput} for command's `response` shape. + * @see {@link IoTClientResolvedConfig | config} for command's `input` shape. + * */ export class ListViolationEventsCommand extends $Command< ListViolationEventsCommandInput, diff --git a/clients/client-iot/commands/RegisterCACertificateCommand.ts b/clients/client-iot/commands/RegisterCACertificateCommand.ts index d1af9a162006..e9a1c1f53cc4 100644 --- a/clients/client-iot/commands/RegisterCACertificateCommand.ts +++ b/clients/client-iot/commands/RegisterCACertificateCommand.ts @@ -27,6 +27,20 @@ export interface RegisterCACertificateCommandOutput extends RegisterCACertificat * up to 10 certificate authorities sign your device certificates. If you have more than one * CA certificate registered, make sure you pass the CA certificate when you register your * device certificates with the RegisterCertificate API.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { IoTClient, RegisterCACertificateCommand } from "@aws-sdk/client-iot"; // ES Modules import + * // const { IoTClient, RegisterCACertificateCommand } = require("@aws-sdk/client-iot"); // CommonJS import + * const client = new IoTClient(config); + * const command = new RegisterCACertificateCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link RegisterCACertificateCommandInput} for command's `input` shape. + * @see {@link RegisterCACertificateCommandOutput} for command's `response` shape. + * @see {@link IoTClientResolvedConfig | config} for command's `input` shape. + * */ export class RegisterCACertificateCommand extends $Command< RegisterCACertificateCommandInput, diff --git a/clients/client-iot/commands/RegisterCertificateCommand.ts b/clients/client-iot/commands/RegisterCertificateCommand.ts index 12014b35f9af..39ddcf9fd100 100644 --- a/clients/client-iot/commands/RegisterCertificateCommand.ts +++ b/clients/client-iot/commands/RegisterCertificateCommand.ts @@ -24,6 +24,20 @@ export interface RegisterCertificateCommandOutput extends RegisterCertificateRes *

Registers a device certificate with AWS IoT. 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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { IoTClient, RegisterCertificateCommand } from "@aws-sdk/client-iot"; // ES Modules import + * // const { IoTClient, RegisterCertificateCommand } = require("@aws-sdk/client-iot"); // CommonJS import + * const client = new IoTClient(config); + * const command = new RegisterCertificateCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link RegisterCertificateCommandInput} for command's `input` shape. + * @see {@link RegisterCertificateCommandOutput} for command's `response` shape. + * @see {@link IoTClientResolvedConfig | config} for command's `input` shape. + * */ export class RegisterCertificateCommand extends $Command< RegisterCertificateCommandInput, diff --git a/clients/client-iot/commands/RegisterCertificateWithoutCACommand.ts b/clients/client-iot/commands/RegisterCertificateWithoutCACommand.ts index 69af2edcd7c1..5b420876ef53 100644 --- a/clients/client-iot/commands/RegisterCertificateWithoutCACommand.ts +++ b/clients/client-iot/commands/RegisterCertificateWithoutCACommand.ts @@ -24,6 +24,20 @@ export interface RegisterCertificateWithoutCACommandOutput /** *

Register a certificate that does not have a certificate authority (CA).

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { IoTClient, RegisterCertificateWithoutCACommand } from "@aws-sdk/client-iot"; // ES Modules import + * // const { IoTClient, RegisterCertificateWithoutCACommand } = require("@aws-sdk/client-iot"); // CommonJS import + * const client = new IoTClient(config); + * const command = new RegisterCertificateWithoutCACommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link RegisterCertificateWithoutCACommandInput} for command's `input` shape. + * @see {@link RegisterCertificateWithoutCACommandOutput} for command's `response` shape. + * @see {@link IoTClientResolvedConfig | config} for command's `input` shape. + * */ export class RegisterCertificateWithoutCACommand extends $Command< RegisterCertificateWithoutCACommandInput, diff --git a/clients/client-iot/commands/RegisterThingCommand.ts b/clients/client-iot/commands/RegisterThingCommand.ts index ade8671d0dfb..d0cbba917486 100644 --- a/clients/client-iot/commands/RegisterThingCommand.ts +++ b/clients/client-iot/commands/RegisterThingCommand.ts @@ -26,6 +26,20 @@ export interface RegisterThingCommandOutput extends RegisterThingResponse, __Met * plane APIs. These calls might exceed your account level * AWS IoT Throttling Limits and cause throttle errors. Please contact AWS Customer Support to raise * your throttling limits if necessary.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { IoTClient, RegisterThingCommand } from "@aws-sdk/client-iot"; // ES Modules import + * // const { IoTClient, RegisterThingCommand } = require("@aws-sdk/client-iot"); // CommonJS import + * const client = new IoTClient(config); + * const command = new RegisterThingCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link RegisterThingCommandInput} for command's `input` shape. + * @see {@link RegisterThingCommandOutput} for command's `response` shape. + * @see {@link IoTClientResolvedConfig | config} for command's `input` shape. + * */ export class RegisterThingCommand extends $Command< RegisterThingCommandInput, diff --git a/clients/client-iot/commands/RejectCertificateTransferCommand.ts b/clients/client-iot/commands/RejectCertificateTransferCommand.ts index 23ae48317a3e..c1e1777c237e 100644 --- a/clients/client-iot/commands/RejectCertificateTransferCommand.ts +++ b/clients/client-iot/commands/RejectCertificateTransferCommand.ts @@ -28,6 +28,20 @@ export interface RejectCertificateTransferCommandOutput extends __MetadataBearer * 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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { IoTClient, RejectCertificateTransferCommand } from "@aws-sdk/client-iot"; // ES Modules import + * // const { IoTClient, RejectCertificateTransferCommand } = require("@aws-sdk/client-iot"); // CommonJS import + * const client = new IoTClient(config); + * const command = new RejectCertificateTransferCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link RejectCertificateTransferCommandInput} for command's `input` shape. + * @see {@link RejectCertificateTransferCommandOutput} for command's `response` shape. + * @see {@link IoTClientResolvedConfig | config} for command's `input` shape. + * */ export class RejectCertificateTransferCommand extends $Command< RejectCertificateTransferCommandInput, diff --git a/clients/client-iot/commands/RemoveThingFromBillingGroupCommand.ts b/clients/client-iot/commands/RemoveThingFromBillingGroupCommand.ts index 8a5a6d7b6238..dca63c794846 100644 --- a/clients/client-iot/commands/RemoveThingFromBillingGroupCommand.ts +++ b/clients/client-iot/commands/RemoveThingFromBillingGroupCommand.ts @@ -24,6 +24,20 @@ export interface RemoveThingFromBillingGroupCommandOutput /** *

Removes the given thing from the billing group.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { IoTClient, RemoveThingFromBillingGroupCommand } from "@aws-sdk/client-iot"; // ES Modules import + * // const { IoTClient, RemoveThingFromBillingGroupCommand } = require("@aws-sdk/client-iot"); // CommonJS import + * const client = new IoTClient(config); + * const command = new RemoveThingFromBillingGroupCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link RemoveThingFromBillingGroupCommandInput} for command's `input` shape. + * @see {@link RemoveThingFromBillingGroupCommandOutput} for command's `response` shape. + * @see {@link IoTClientResolvedConfig | config} for command's `input` shape. + * */ export class RemoveThingFromBillingGroupCommand extends $Command< RemoveThingFromBillingGroupCommandInput, diff --git a/clients/client-iot/commands/RemoveThingFromThingGroupCommand.ts b/clients/client-iot/commands/RemoveThingFromThingGroupCommand.ts index 1a117e7fe519..2a2cfd7fa475 100644 --- a/clients/client-iot/commands/RemoveThingFromThingGroupCommand.ts +++ b/clients/client-iot/commands/RemoveThingFromThingGroupCommand.ts @@ -27,6 +27,20 @@ export interface RemoveThingFromThingGroupCommandOutput extends RemoveThingFromT * either a thingArn or a thingName to * identify the thing to remove from the thing group. *

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { IoTClient, RemoveThingFromThingGroupCommand } from "@aws-sdk/client-iot"; // ES Modules import + * // const { IoTClient, RemoveThingFromThingGroupCommand } = require("@aws-sdk/client-iot"); // CommonJS import + * const client = new IoTClient(config); + * const command = new RemoveThingFromThingGroupCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link RemoveThingFromThingGroupCommandInput} for command's `input` shape. + * @see {@link RemoveThingFromThingGroupCommandOutput} for command's `response` shape. + * @see {@link IoTClientResolvedConfig | config} for command's `input` shape. + * */ export class RemoveThingFromThingGroupCommand extends $Command< RemoveThingFromThingGroupCommandInput, diff --git a/clients/client-iot/commands/ReplaceTopicRuleCommand.ts b/clients/client-iot/commands/ReplaceTopicRuleCommand.ts index 13b4b9f0e403..5575b2fe2b2d 100644 --- a/clients/client-iot/commands/ReplaceTopicRuleCommand.ts +++ b/clients/client-iot/commands/ReplaceTopicRuleCommand.ts @@ -24,6 +24,20 @@ export interface ReplaceTopicRuleCommandOutput extends __MetadataBearer {} *

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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { IoTClient, ReplaceTopicRuleCommand } from "@aws-sdk/client-iot"; // ES Modules import + * // const { IoTClient, ReplaceTopicRuleCommand } = require("@aws-sdk/client-iot"); // CommonJS import + * const client = new IoTClient(config); + * const command = new ReplaceTopicRuleCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ReplaceTopicRuleCommandInput} for command's `input` shape. + * @see {@link ReplaceTopicRuleCommandOutput} for command's `response` shape. + * @see {@link IoTClientResolvedConfig | config} for command's `input` shape. + * */ export class ReplaceTopicRuleCommand extends $Command< ReplaceTopicRuleCommandInput, diff --git a/clients/client-iot/commands/SearchIndexCommand.ts b/clients/client-iot/commands/SearchIndexCommand.ts index a66806882801..91eecf7a8f02 100644 --- a/clients/client-iot/commands/SearchIndexCommand.ts +++ b/clients/client-iot/commands/SearchIndexCommand.ts @@ -22,6 +22,20 @@ export interface SearchIndexCommandOutput extends SearchIndexResponse, __Metadat /** *

The query search index.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { IoTClient, SearchIndexCommand } from "@aws-sdk/client-iot"; // ES Modules import + * // const { IoTClient, SearchIndexCommand } = require("@aws-sdk/client-iot"); // CommonJS import + * const client = new IoTClient(config); + * const command = new SearchIndexCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link SearchIndexCommandInput} for command's `input` shape. + * @see {@link SearchIndexCommandOutput} for command's `response` shape. + * @see {@link IoTClientResolvedConfig | config} for command's `input` shape. + * */ export class SearchIndexCommand extends $Command< SearchIndexCommandInput, diff --git a/clients/client-iot/commands/SetDefaultAuthorizerCommand.ts b/clients/client-iot/commands/SetDefaultAuthorizerCommand.ts index c7d65609a29f..ec023f884256 100644 --- a/clients/client-iot/commands/SetDefaultAuthorizerCommand.ts +++ b/clients/client-iot/commands/SetDefaultAuthorizerCommand.ts @@ -23,6 +23,20 @@ export interface SetDefaultAuthorizerCommandOutput extends SetDefaultAuthorizerR /** *

Sets the default authorizer. This will be used if a websocket connection is made * without specifying an authorizer.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { IoTClient, SetDefaultAuthorizerCommand } from "@aws-sdk/client-iot"; // ES Modules import + * // const { IoTClient, SetDefaultAuthorizerCommand } = require("@aws-sdk/client-iot"); // CommonJS import + * const client = new IoTClient(config); + * const command = new SetDefaultAuthorizerCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link SetDefaultAuthorizerCommandInput} for command's `input` shape. + * @see {@link SetDefaultAuthorizerCommandOutput} for command's `response` shape. + * @see {@link IoTClientResolvedConfig | config} for command's `input` shape. + * */ export class SetDefaultAuthorizerCommand extends $Command< SetDefaultAuthorizerCommandInput, diff --git a/clients/client-iot/commands/SetDefaultPolicyVersionCommand.ts b/clients/client-iot/commands/SetDefaultPolicyVersionCommand.ts index 41794501cc29..e73c530e0fa8 100644 --- a/clients/client-iot/commands/SetDefaultPolicyVersionCommand.ts +++ b/clients/client-iot/commands/SetDefaultPolicyVersionCommand.ts @@ -25,6 +25,20 @@ export interface SetDefaultPolicyVersionCommandOutput extends __MetadataBearer { * (operative) version. This action affects all certificates to which the policy is attached. * To list the principals the policy is attached to, use the ListPrincipalPolicy * API.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { IoTClient, SetDefaultPolicyVersionCommand } from "@aws-sdk/client-iot"; // ES Modules import + * // const { IoTClient, SetDefaultPolicyVersionCommand } = require("@aws-sdk/client-iot"); // CommonJS import + * const client = new IoTClient(config); + * const command = new SetDefaultPolicyVersionCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link SetDefaultPolicyVersionCommandInput} for command's `input` shape. + * @see {@link SetDefaultPolicyVersionCommandOutput} for command's `response` shape. + * @see {@link IoTClientResolvedConfig | config} for command's `input` shape. + * */ export class SetDefaultPolicyVersionCommand extends $Command< SetDefaultPolicyVersionCommandInput, diff --git a/clients/client-iot/commands/SetLoggingOptionsCommand.ts b/clients/client-iot/commands/SetLoggingOptionsCommand.ts index 9a290f4e0772..b7ab2bf41294 100644 --- a/clients/client-iot/commands/SetLoggingOptionsCommand.ts +++ b/clients/client-iot/commands/SetLoggingOptionsCommand.ts @@ -24,6 +24,20 @@ export interface SetLoggingOptionsCommandOutput extends __MetadataBearer {} *

Sets the logging options.

*

NOTE: use of this command is not recommended. Use SetV2LoggingOptions * instead.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { IoTClient, SetLoggingOptionsCommand } from "@aws-sdk/client-iot"; // ES Modules import + * // const { IoTClient, SetLoggingOptionsCommand } = require("@aws-sdk/client-iot"); // CommonJS import + * const client = new IoTClient(config); + * const command = new SetLoggingOptionsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link SetLoggingOptionsCommandInput} for command's `input` shape. + * @see {@link SetLoggingOptionsCommandOutput} for command's `response` shape. + * @see {@link IoTClientResolvedConfig | config} for command's `input` shape. + * */ export class SetLoggingOptionsCommand extends $Command< SetLoggingOptionsCommandInput, diff --git a/clients/client-iot/commands/SetV2LoggingLevelCommand.ts b/clients/client-iot/commands/SetV2LoggingLevelCommand.ts index dc597bc07373..ac000bfd1607 100644 --- a/clients/client-iot/commands/SetV2LoggingLevelCommand.ts +++ b/clients/client-iot/commands/SetV2LoggingLevelCommand.ts @@ -22,6 +22,20 @@ export interface SetV2LoggingLevelCommandOutput extends __MetadataBearer {} /** *

Sets the logging level.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { IoTClient, SetV2LoggingLevelCommand } from "@aws-sdk/client-iot"; // ES Modules import + * // const { IoTClient, SetV2LoggingLevelCommand } = require("@aws-sdk/client-iot"); // CommonJS import + * const client = new IoTClient(config); + * const command = new SetV2LoggingLevelCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link SetV2LoggingLevelCommandInput} for command's `input` shape. + * @see {@link SetV2LoggingLevelCommandOutput} for command's `response` shape. + * @see {@link IoTClientResolvedConfig | config} for command's `input` shape. + * */ export class SetV2LoggingLevelCommand extends $Command< SetV2LoggingLevelCommandInput, diff --git a/clients/client-iot/commands/SetV2LoggingOptionsCommand.ts b/clients/client-iot/commands/SetV2LoggingOptionsCommand.ts index b21e007db4a5..283112d3002c 100644 --- a/clients/client-iot/commands/SetV2LoggingOptionsCommand.ts +++ b/clients/client-iot/commands/SetV2LoggingOptionsCommand.ts @@ -22,6 +22,20 @@ export interface SetV2LoggingOptionsCommandOutput extends __MetadataBearer {} /** *

Sets the logging options for the V2 logging service.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { IoTClient, SetV2LoggingOptionsCommand } from "@aws-sdk/client-iot"; // ES Modules import + * // const { IoTClient, SetV2LoggingOptionsCommand } = require("@aws-sdk/client-iot"); // CommonJS import + * const client = new IoTClient(config); + * const command = new SetV2LoggingOptionsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link SetV2LoggingOptionsCommandInput} for command's `input` shape. + * @see {@link SetV2LoggingOptionsCommandOutput} for command's `response` shape. + * @see {@link IoTClientResolvedConfig | config} for command's `input` shape. + * */ export class SetV2LoggingOptionsCommand extends $Command< SetV2LoggingOptionsCommandInput, diff --git a/clients/client-iot/commands/StartAuditMitigationActionsTaskCommand.ts b/clients/client-iot/commands/StartAuditMitigationActionsTaskCommand.ts index e6f1b4dba765..6fed7717e44f 100644 --- a/clients/client-iot/commands/StartAuditMitigationActionsTaskCommand.ts +++ b/clients/client-iot/commands/StartAuditMitigationActionsTaskCommand.ts @@ -24,6 +24,20 @@ export interface StartAuditMitigationActionsTaskCommandOutput /** *

Starts a task that applies a set of mitigation actions to the specified target.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { IoTClient, StartAuditMitigationActionsTaskCommand } from "@aws-sdk/client-iot"; // ES Modules import + * // const { IoTClient, StartAuditMitigationActionsTaskCommand } = require("@aws-sdk/client-iot"); // CommonJS import + * const client = new IoTClient(config); + * const command = new StartAuditMitigationActionsTaskCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link StartAuditMitigationActionsTaskCommandInput} for command's `input` shape. + * @see {@link StartAuditMitigationActionsTaskCommandOutput} for command's `response` shape. + * @see {@link IoTClientResolvedConfig | config} for command's `input` shape. + * */ export class StartAuditMitigationActionsTaskCommand extends $Command< StartAuditMitigationActionsTaskCommandInput, diff --git a/clients/client-iot/commands/StartDetectMitigationActionsTaskCommand.ts b/clients/client-iot/commands/StartDetectMitigationActionsTaskCommand.ts index dcc10c20cafa..25feeb27fc37 100644 --- a/clients/client-iot/commands/StartDetectMitigationActionsTaskCommand.ts +++ b/clients/client-iot/commands/StartDetectMitigationActionsTaskCommand.ts @@ -26,6 +26,20 @@ export interface StartDetectMitigationActionsTaskCommandOutput *

* Starts a Device Defender ML Detect mitigation actions task. *

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { IoTClient, StartDetectMitigationActionsTaskCommand } from "@aws-sdk/client-iot"; // ES Modules import + * // const { IoTClient, StartDetectMitigationActionsTaskCommand } = require("@aws-sdk/client-iot"); // CommonJS import + * const client = new IoTClient(config); + * const command = new StartDetectMitigationActionsTaskCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link StartDetectMitigationActionsTaskCommandInput} for command's `input` shape. + * @see {@link StartDetectMitigationActionsTaskCommandOutput} for command's `response` shape. + * @see {@link IoTClientResolvedConfig | config} for command's `input` shape. + * */ export class StartDetectMitigationActionsTaskCommand extends $Command< StartDetectMitigationActionsTaskCommandInput, diff --git a/clients/client-iot/commands/StartOnDemandAuditTaskCommand.ts b/clients/client-iot/commands/StartOnDemandAuditTaskCommand.ts index 83e7c3536586..344646e78f98 100644 --- a/clients/client-iot/commands/StartOnDemandAuditTaskCommand.ts +++ b/clients/client-iot/commands/StartOnDemandAuditTaskCommand.ts @@ -22,6 +22,20 @@ export interface StartOnDemandAuditTaskCommandOutput extends StartOnDemandAuditT /** *

Starts an on-demand Device Defender audit.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { IoTClient, StartOnDemandAuditTaskCommand } from "@aws-sdk/client-iot"; // ES Modules import + * // const { IoTClient, StartOnDemandAuditTaskCommand } = require("@aws-sdk/client-iot"); // CommonJS import + * const client = new IoTClient(config); + * const command = new StartOnDemandAuditTaskCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link StartOnDemandAuditTaskCommandInput} for command's `input` shape. + * @see {@link StartOnDemandAuditTaskCommandOutput} for command's `response` shape. + * @see {@link IoTClientResolvedConfig | config} for command's `input` shape. + * */ export class StartOnDemandAuditTaskCommand extends $Command< StartOnDemandAuditTaskCommandInput, diff --git a/clients/client-iot/commands/StartThingRegistrationTaskCommand.ts b/clients/client-iot/commands/StartThingRegistrationTaskCommand.ts index 14eae445fa98..65bae39887b4 100644 --- a/clients/client-iot/commands/StartThingRegistrationTaskCommand.ts +++ b/clients/client-iot/commands/StartThingRegistrationTaskCommand.ts @@ -22,6 +22,20 @@ export interface StartThingRegistrationTaskCommandOutput extends StartThingRegis /** *

Creates a bulk thing provisioning task.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { IoTClient, StartThingRegistrationTaskCommand } from "@aws-sdk/client-iot"; // ES Modules import + * // const { IoTClient, StartThingRegistrationTaskCommand } = require("@aws-sdk/client-iot"); // CommonJS import + * const client = new IoTClient(config); + * const command = new StartThingRegistrationTaskCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link StartThingRegistrationTaskCommandInput} for command's `input` shape. + * @see {@link StartThingRegistrationTaskCommandOutput} for command's `response` shape. + * @see {@link IoTClientResolvedConfig | config} for command's `input` shape. + * */ export class StartThingRegistrationTaskCommand extends $Command< StartThingRegistrationTaskCommandInput, diff --git a/clients/client-iot/commands/StopThingRegistrationTaskCommand.ts b/clients/client-iot/commands/StopThingRegistrationTaskCommand.ts index c4242e4073b8..e7a73389ae6c 100644 --- a/clients/client-iot/commands/StopThingRegistrationTaskCommand.ts +++ b/clients/client-iot/commands/StopThingRegistrationTaskCommand.ts @@ -22,6 +22,20 @@ export interface StopThingRegistrationTaskCommandOutput extends StopThingRegistr /** *

Cancels a bulk thing provisioning task.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { IoTClient, StopThingRegistrationTaskCommand } from "@aws-sdk/client-iot"; // ES Modules import + * // const { IoTClient, StopThingRegistrationTaskCommand } = require("@aws-sdk/client-iot"); // CommonJS import + * const client = new IoTClient(config); + * const command = new StopThingRegistrationTaskCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link StopThingRegistrationTaskCommandInput} for command's `input` shape. + * @see {@link StopThingRegistrationTaskCommandOutput} for command's `response` shape. + * @see {@link IoTClientResolvedConfig | config} for command's `input` shape. + * */ export class StopThingRegistrationTaskCommand extends $Command< StopThingRegistrationTaskCommandInput, diff --git a/clients/client-iot/commands/TagResourceCommand.ts b/clients/client-iot/commands/TagResourceCommand.ts index 6476b19877f6..704f102edb0e 100644 --- a/clients/client-iot/commands/TagResourceCommand.ts +++ b/clients/client-iot/commands/TagResourceCommand.ts @@ -23,6 +23,20 @@ export interface TagResourceCommandOutput extends TagResourceResponse, __Metadat /** *

Adds to or modifies the tags of the given resource. Tags are metadata which can be * used to manage a resource.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { IoTClient, TagResourceCommand } from "@aws-sdk/client-iot"; // ES Modules import + * // const { IoTClient, TagResourceCommand } = require("@aws-sdk/client-iot"); // CommonJS import + * const client = new IoTClient(config); + * const command = new TagResourceCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link TagResourceCommandInput} for command's `input` shape. + * @see {@link TagResourceCommandOutput} for command's `response` shape. + * @see {@link IoTClientResolvedConfig | config} for command's `input` shape. + * */ export class TagResourceCommand extends $Command< TagResourceCommandInput, diff --git a/clients/client-iot/commands/TestAuthorizationCommand.ts b/clients/client-iot/commands/TestAuthorizationCommand.ts index f63abfe5c7da..402212f3a1d4 100644 --- a/clients/client-iot/commands/TestAuthorizationCommand.ts +++ b/clients/client-iot/commands/TestAuthorizationCommand.ts @@ -24,6 +24,20 @@ export interface TestAuthorizationCommandOutput extends TestAuthorizationRespons *

Tests if a specified principal is authorized to perform an AWS IoT action on a * specified resource. Use this to test and debug the authorization behavior of devices that * connect to the AWS IoT device gateway.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { IoTClient, TestAuthorizationCommand } from "@aws-sdk/client-iot"; // ES Modules import + * // const { IoTClient, TestAuthorizationCommand } = require("@aws-sdk/client-iot"); // CommonJS import + * const client = new IoTClient(config); + * const command = new TestAuthorizationCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link TestAuthorizationCommandInput} for command's `input` shape. + * @see {@link TestAuthorizationCommandOutput} for command's `response` shape. + * @see {@link IoTClientResolvedConfig | config} for command's `input` shape. + * */ export class TestAuthorizationCommand extends $Command< TestAuthorizationCommandInput, diff --git a/clients/client-iot/commands/TestInvokeAuthorizerCommand.ts b/clients/client-iot/commands/TestInvokeAuthorizerCommand.ts index 94a8e880d7b9..fa9344560675 100644 --- a/clients/client-iot/commands/TestInvokeAuthorizerCommand.ts +++ b/clients/client-iot/commands/TestInvokeAuthorizerCommand.ts @@ -24,6 +24,20 @@ export interface TestInvokeAuthorizerCommandOutput extends TestInvokeAuthorizerR *

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 AWS * IoT device gateway.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { IoTClient, TestInvokeAuthorizerCommand } from "@aws-sdk/client-iot"; // ES Modules import + * // const { IoTClient, TestInvokeAuthorizerCommand } = require("@aws-sdk/client-iot"); // CommonJS import + * const client = new IoTClient(config); + * const command = new TestInvokeAuthorizerCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link TestInvokeAuthorizerCommandInput} for command's `input` shape. + * @see {@link TestInvokeAuthorizerCommandOutput} for command's `response` shape. + * @see {@link IoTClientResolvedConfig | config} for command's `input` shape. + * */ export class TestInvokeAuthorizerCommand extends $Command< TestInvokeAuthorizerCommandInput, diff --git a/clients/client-iot/commands/TransferCertificateCommand.ts b/clients/client-iot/commands/TransferCertificateCommand.ts index 0309583a66f9..5cdcb0c7ed21 100644 --- a/clients/client-iot/commands/TransferCertificateCommand.ts +++ b/clients/client-iot/commands/TransferCertificateCommand.ts @@ -29,6 +29,20 @@ export interface TransferCertificateCommandOutput extends TransferCertificateRes * UpdateCertificate API to deactivate it.

*

The certificate must not have any policies attached to it. You can use the * DetachPrincipalPolicy API to detach them.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { IoTClient, TransferCertificateCommand } from "@aws-sdk/client-iot"; // ES Modules import + * // const { IoTClient, TransferCertificateCommand } = require("@aws-sdk/client-iot"); // CommonJS import + * const client = new IoTClient(config); + * const command = new TransferCertificateCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link TransferCertificateCommandInput} for command's `input` shape. + * @see {@link TransferCertificateCommandOutput} for command's `response` shape. + * @see {@link IoTClientResolvedConfig | config} for command's `input` shape. + * */ export class TransferCertificateCommand extends $Command< TransferCertificateCommandInput, diff --git a/clients/client-iot/commands/UntagResourceCommand.ts b/clients/client-iot/commands/UntagResourceCommand.ts index 455cfe3df196..8b756b275122 100644 --- a/clients/client-iot/commands/UntagResourceCommand.ts +++ b/clients/client-iot/commands/UntagResourceCommand.ts @@ -22,6 +22,20 @@ export interface UntagResourceCommandOutput extends UntagResourceResponse, __Met /** *

Removes the given tags (metadata) from the resource.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { IoTClient, UntagResourceCommand } from "@aws-sdk/client-iot"; // ES Modules import + * // const { IoTClient, UntagResourceCommand } = require("@aws-sdk/client-iot"); // CommonJS import + * const client = new IoTClient(config); + * const command = new UntagResourceCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link UntagResourceCommandInput} for command's `input` shape. + * @see {@link UntagResourceCommandOutput} for command's `response` shape. + * @see {@link IoTClientResolvedConfig | config} for command's `input` shape. + * */ export class UntagResourceCommand extends $Command< UntagResourceCommandInput, diff --git a/clients/client-iot/commands/UpdateAccountAuditConfigurationCommand.ts b/clients/client-iot/commands/UpdateAccountAuditConfigurationCommand.ts index 2a4781d06cc5..c765eaffe432 100644 --- a/clients/client-iot/commands/UpdateAccountAuditConfigurationCommand.ts +++ b/clients/client-iot/commands/UpdateAccountAuditConfigurationCommand.ts @@ -26,6 +26,20 @@ export interface UpdateAccountAuditConfigurationCommandOutput *

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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { IoTClient, UpdateAccountAuditConfigurationCommand } from "@aws-sdk/client-iot"; // ES Modules import + * // const { IoTClient, UpdateAccountAuditConfigurationCommand } = require("@aws-sdk/client-iot"); // CommonJS import + * const client = new IoTClient(config); + * const command = new UpdateAccountAuditConfigurationCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link UpdateAccountAuditConfigurationCommandInput} for command's `input` shape. + * @see {@link UpdateAccountAuditConfigurationCommandOutput} for command's `response` shape. + * @see {@link IoTClientResolvedConfig | config} for command's `input` shape. + * */ export class UpdateAccountAuditConfigurationCommand extends $Command< UpdateAccountAuditConfigurationCommandInput, diff --git a/clients/client-iot/commands/UpdateAuditSuppressionCommand.ts b/clients/client-iot/commands/UpdateAuditSuppressionCommand.ts index df49db12e4f9..1a5aded19bc9 100644 --- a/clients/client-iot/commands/UpdateAuditSuppressionCommand.ts +++ b/clients/client-iot/commands/UpdateAuditSuppressionCommand.ts @@ -24,6 +24,20 @@ export interface UpdateAuditSuppressionCommandOutput extends UpdateAuditSuppress *

* Updates a Device Defender audit suppression. *

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { IoTClient, UpdateAuditSuppressionCommand } from "@aws-sdk/client-iot"; // ES Modules import + * // const { IoTClient, UpdateAuditSuppressionCommand } = require("@aws-sdk/client-iot"); // CommonJS import + * const client = new IoTClient(config); + * const command = new UpdateAuditSuppressionCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link UpdateAuditSuppressionCommandInput} for command's `input` shape. + * @see {@link UpdateAuditSuppressionCommandOutput} for command's `response` shape. + * @see {@link IoTClientResolvedConfig | config} for command's `input` shape. + * */ export class UpdateAuditSuppressionCommand extends $Command< UpdateAuditSuppressionCommandInput, diff --git a/clients/client-iot/commands/UpdateAuthorizerCommand.ts b/clients/client-iot/commands/UpdateAuthorizerCommand.ts index f0a9aaed5c17..fb9c61eabc21 100644 --- a/clients/client-iot/commands/UpdateAuthorizerCommand.ts +++ b/clients/client-iot/commands/UpdateAuthorizerCommand.ts @@ -22,6 +22,20 @@ export interface UpdateAuthorizerCommandOutput extends UpdateAuthorizerResponse, /** *

Updates an authorizer.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { IoTClient, UpdateAuthorizerCommand } from "@aws-sdk/client-iot"; // ES Modules import + * // const { IoTClient, UpdateAuthorizerCommand } = require("@aws-sdk/client-iot"); // CommonJS import + * const client = new IoTClient(config); + * const command = new UpdateAuthorizerCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link UpdateAuthorizerCommandInput} for command's `input` shape. + * @see {@link UpdateAuthorizerCommandOutput} for command's `response` shape. + * @see {@link IoTClientResolvedConfig | config} for command's `input` shape. + * */ export class UpdateAuthorizerCommand extends $Command< UpdateAuthorizerCommandInput, diff --git a/clients/client-iot/commands/UpdateBillingGroupCommand.ts b/clients/client-iot/commands/UpdateBillingGroupCommand.ts index 1ed5e83ab2fe..67aeb00e3596 100644 --- a/clients/client-iot/commands/UpdateBillingGroupCommand.ts +++ b/clients/client-iot/commands/UpdateBillingGroupCommand.ts @@ -22,6 +22,20 @@ export interface UpdateBillingGroupCommandOutput extends UpdateBillingGroupRespo /** *

Updates information about the billing group.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { IoTClient, UpdateBillingGroupCommand } from "@aws-sdk/client-iot"; // ES Modules import + * // const { IoTClient, UpdateBillingGroupCommand } = require("@aws-sdk/client-iot"); // CommonJS import + * const client = new IoTClient(config); + * const command = new UpdateBillingGroupCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link UpdateBillingGroupCommandInput} for command's `input` shape. + * @see {@link UpdateBillingGroupCommandOutput} for command's `response` shape. + * @see {@link IoTClientResolvedConfig | config} for command's `input` shape. + * */ export class UpdateBillingGroupCommand extends $Command< UpdateBillingGroupCommandInput, diff --git a/clients/client-iot/commands/UpdateCACertificateCommand.ts b/clients/client-iot/commands/UpdateCACertificateCommand.ts index 559be2eb684d..e779fefde60e 100644 --- a/clients/client-iot/commands/UpdateCACertificateCommand.ts +++ b/clients/client-iot/commands/UpdateCACertificateCommand.ts @@ -22,6 +22,20 @@ export interface UpdateCACertificateCommandOutput extends __MetadataBearer {} /** *

Updates a registered CA certificate.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { IoTClient, UpdateCACertificateCommand } from "@aws-sdk/client-iot"; // ES Modules import + * // const { IoTClient, UpdateCACertificateCommand } = require("@aws-sdk/client-iot"); // CommonJS import + * const client = new IoTClient(config); + * const command = new UpdateCACertificateCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link UpdateCACertificateCommandInput} for command's `input` shape. + * @see {@link UpdateCACertificateCommandOutput} for command's `response` shape. + * @see {@link IoTClientResolvedConfig | config} for command's `input` shape. + * */ export class UpdateCACertificateCommand extends $Command< UpdateCACertificateCommandInput, diff --git a/clients/client-iot/commands/UpdateCertificateCommand.ts b/clients/client-iot/commands/UpdateCertificateCommand.ts index 58ea33192b69..480fa6a8fb59 100644 --- a/clients/client-iot/commands/UpdateCertificateCommand.ts +++ b/clients/client-iot/commands/UpdateCertificateCommand.ts @@ -28,6 +28,20 @@ export interface UpdateCertificateCommandOutput extends __MetadataBearer {} *

Within a few minutes of updating a certificate from the ACTIVE state to any other * state, AWS IoT disconnects all devices that used that certificate to connect. Devices cannot * use a certificate that is not in the ACTIVE state to reconnect.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { IoTClient, UpdateCertificateCommand } from "@aws-sdk/client-iot"; // ES Modules import + * // const { IoTClient, UpdateCertificateCommand } = require("@aws-sdk/client-iot"); // CommonJS import + * const client = new IoTClient(config); + * const command = new UpdateCertificateCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link UpdateCertificateCommandInput} for command's `input` shape. + * @see {@link UpdateCertificateCommandOutput} for command's `response` shape. + * @see {@link IoTClientResolvedConfig | config} for command's `input` shape. + * */ export class UpdateCertificateCommand extends $Command< UpdateCertificateCommandInput, diff --git a/clients/client-iot/commands/UpdateCustomMetricCommand.ts b/clients/client-iot/commands/UpdateCustomMetricCommand.ts index a1c854b003b5..de69379de3ac 100644 --- a/clients/client-iot/commands/UpdateCustomMetricCommand.ts +++ b/clients/client-iot/commands/UpdateCustomMetricCommand.ts @@ -23,6 +23,20 @@ export interface UpdateCustomMetricCommandOutput extends UpdateCustomMetricRespo /** *

Updates a * Device Defender detect custom metric.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { IoTClient, UpdateCustomMetricCommand } from "@aws-sdk/client-iot"; // ES Modules import + * // const { IoTClient, UpdateCustomMetricCommand } = require("@aws-sdk/client-iot"); // CommonJS import + * const client = new IoTClient(config); + * const command = new UpdateCustomMetricCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link UpdateCustomMetricCommandInput} for command's `input` shape. + * @see {@link UpdateCustomMetricCommandOutput} for command's `response` shape. + * @see {@link IoTClientResolvedConfig | config} for command's `input` shape. + * */ export class UpdateCustomMetricCommand extends $Command< UpdateCustomMetricCommandInput, diff --git a/clients/client-iot/commands/UpdateDimensionCommand.ts b/clients/client-iot/commands/UpdateDimensionCommand.ts index d26d781dfecf..862f1c1d3327 100644 --- a/clients/client-iot/commands/UpdateDimensionCommand.ts +++ b/clients/client-iot/commands/UpdateDimensionCommand.ts @@ -27,6 +27,20 @@ export interface UpdateDimensionCommandOutput extends UpdateDimensionResponse, _ * it is created (you can delete it and * recreate * it).

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { IoTClient, UpdateDimensionCommand } from "@aws-sdk/client-iot"; // ES Modules import + * // const { IoTClient, UpdateDimensionCommand } = require("@aws-sdk/client-iot"); // CommonJS import + * const client = new IoTClient(config); + * const command = new UpdateDimensionCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link UpdateDimensionCommandInput} for command's `input` shape. + * @see {@link UpdateDimensionCommandOutput} for command's `response` shape. + * @see {@link IoTClientResolvedConfig | config} for command's `input` shape. + * */ export class UpdateDimensionCommand extends $Command< UpdateDimensionCommandInput, diff --git a/clients/client-iot/commands/UpdateDomainConfigurationCommand.ts b/clients/client-iot/commands/UpdateDomainConfigurationCommand.ts index 39ebbc2c8c1b..5071eddfe8d5 100644 --- a/clients/client-iot/commands/UpdateDomainConfigurationCommand.ts +++ b/clients/client-iot/commands/UpdateDomainConfigurationCommand.ts @@ -25,6 +25,20 @@ export interface UpdateDomainConfigurationCommandOutput extends UpdateDomainConf * *

The domain configuration feature is in public preview and is subject to change.

* + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { IoTClient, UpdateDomainConfigurationCommand } from "@aws-sdk/client-iot"; // ES Modules import + * // const { IoTClient, UpdateDomainConfigurationCommand } = require("@aws-sdk/client-iot"); // CommonJS import + * const client = new IoTClient(config); + * const command = new UpdateDomainConfigurationCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link UpdateDomainConfigurationCommandInput} for command's `input` shape. + * @see {@link UpdateDomainConfigurationCommandOutput} for command's `response` shape. + * @see {@link IoTClientResolvedConfig | config} for command's `input` shape. + * */ export class UpdateDomainConfigurationCommand extends $Command< UpdateDomainConfigurationCommandInput, diff --git a/clients/client-iot/commands/UpdateDynamicThingGroupCommand.ts b/clients/client-iot/commands/UpdateDynamicThingGroupCommand.ts index e14ca17a857f..90aa3985776a 100644 --- a/clients/client-iot/commands/UpdateDynamicThingGroupCommand.ts +++ b/clients/client-iot/commands/UpdateDynamicThingGroupCommand.ts @@ -22,6 +22,20 @@ export interface UpdateDynamicThingGroupCommandOutput extends UpdateDynamicThing /** *

Updates a dynamic thing group.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { IoTClient, UpdateDynamicThingGroupCommand } from "@aws-sdk/client-iot"; // ES Modules import + * // const { IoTClient, UpdateDynamicThingGroupCommand } = require("@aws-sdk/client-iot"); // CommonJS import + * const client = new IoTClient(config); + * const command = new UpdateDynamicThingGroupCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link UpdateDynamicThingGroupCommandInput} for command's `input` shape. + * @see {@link UpdateDynamicThingGroupCommandOutput} for command's `response` shape. + * @see {@link IoTClientResolvedConfig | config} for command's `input` shape. + * */ export class UpdateDynamicThingGroupCommand extends $Command< UpdateDynamicThingGroupCommandInput, diff --git a/clients/client-iot/commands/UpdateEventConfigurationsCommand.ts b/clients/client-iot/commands/UpdateEventConfigurationsCommand.ts index e0d63452fccc..5d2172af5a1f 100644 --- a/clients/client-iot/commands/UpdateEventConfigurationsCommand.ts +++ b/clients/client-iot/commands/UpdateEventConfigurationsCommand.ts @@ -22,6 +22,20 @@ export interface UpdateEventConfigurationsCommandOutput extends UpdateEventConfi /** *

Updates the event configurations.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { IoTClient, UpdateEventConfigurationsCommand } from "@aws-sdk/client-iot"; // ES Modules import + * // const { IoTClient, UpdateEventConfigurationsCommand } = require("@aws-sdk/client-iot"); // CommonJS import + * const client = new IoTClient(config); + * const command = new UpdateEventConfigurationsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link UpdateEventConfigurationsCommandInput} for command's `input` shape. + * @see {@link UpdateEventConfigurationsCommandOutput} for command's `response` shape. + * @see {@link IoTClientResolvedConfig | config} for command's `input` shape. + * */ export class UpdateEventConfigurationsCommand extends $Command< UpdateEventConfigurationsCommandInput, diff --git a/clients/client-iot/commands/UpdateIndexingConfigurationCommand.ts b/clients/client-iot/commands/UpdateIndexingConfigurationCommand.ts index b5bcf1701efa..638f16dc4e2b 100644 --- a/clients/client-iot/commands/UpdateIndexingConfigurationCommand.ts +++ b/clients/client-iot/commands/UpdateIndexingConfigurationCommand.ts @@ -24,6 +24,20 @@ export interface UpdateIndexingConfigurationCommandOutput /** *

Updates the search configuration.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { IoTClient, UpdateIndexingConfigurationCommand } from "@aws-sdk/client-iot"; // ES Modules import + * // const { IoTClient, UpdateIndexingConfigurationCommand } = require("@aws-sdk/client-iot"); // CommonJS import + * const client = new IoTClient(config); + * const command = new UpdateIndexingConfigurationCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link UpdateIndexingConfigurationCommandInput} for command's `input` shape. + * @see {@link UpdateIndexingConfigurationCommandOutput} for command's `response` shape. + * @see {@link IoTClientResolvedConfig | config} for command's `input` shape. + * */ export class UpdateIndexingConfigurationCommand extends $Command< UpdateIndexingConfigurationCommandInput, diff --git a/clients/client-iot/commands/UpdateJobCommand.ts b/clients/client-iot/commands/UpdateJobCommand.ts index 44054e28affe..eb4df21ac1b4 100644 --- a/clients/client-iot/commands/UpdateJobCommand.ts +++ b/clients/client-iot/commands/UpdateJobCommand.ts @@ -22,6 +22,20 @@ export interface UpdateJobCommandOutput extends __MetadataBearer {} /** *

Updates supported fields of the specified job.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { IoTClient, UpdateJobCommand } from "@aws-sdk/client-iot"; // ES Modules import + * // const { IoTClient, UpdateJobCommand } = require("@aws-sdk/client-iot"); // CommonJS import + * const client = new IoTClient(config); + * const command = new UpdateJobCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link UpdateJobCommandInput} for command's `input` shape. + * @see {@link UpdateJobCommandOutput} for command's `response` shape. + * @see {@link IoTClientResolvedConfig | config} for command's `input` shape. + * */ export class UpdateJobCommand extends $Command { // Start section: command_properties diff --git a/clients/client-iot/commands/UpdateMitigationActionCommand.ts b/clients/client-iot/commands/UpdateMitigationActionCommand.ts index 6cb9eba82770..ad481bc32ad9 100644 --- a/clients/client-iot/commands/UpdateMitigationActionCommand.ts +++ b/clients/client-iot/commands/UpdateMitigationActionCommand.ts @@ -22,6 +22,20 @@ export interface UpdateMitigationActionCommandOutput extends UpdateMitigationAct /** *

Updates the definition for the specified mitigation action.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { IoTClient, UpdateMitigationActionCommand } from "@aws-sdk/client-iot"; // ES Modules import + * // const { IoTClient, UpdateMitigationActionCommand } = require("@aws-sdk/client-iot"); // CommonJS import + * const client = new IoTClient(config); + * const command = new UpdateMitigationActionCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link UpdateMitigationActionCommandInput} for command's `input` shape. + * @see {@link UpdateMitigationActionCommandOutput} for command's `response` shape. + * @see {@link IoTClientResolvedConfig | config} for command's `input` shape. + * */ export class UpdateMitigationActionCommand extends $Command< UpdateMitigationActionCommandInput, diff --git a/clients/client-iot/commands/UpdateProvisioningTemplateCommand.ts b/clients/client-iot/commands/UpdateProvisioningTemplateCommand.ts index 74f348ce1500..5a9b1588e0b8 100644 --- a/clients/client-iot/commands/UpdateProvisioningTemplateCommand.ts +++ b/clients/client-iot/commands/UpdateProvisioningTemplateCommand.ts @@ -22,6 +22,20 @@ export interface UpdateProvisioningTemplateCommandOutput extends UpdateProvision /** *

Updates a fleet provisioning template.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { IoTClient, UpdateProvisioningTemplateCommand } from "@aws-sdk/client-iot"; // ES Modules import + * // const { IoTClient, UpdateProvisioningTemplateCommand } = require("@aws-sdk/client-iot"); // CommonJS import + * const client = new IoTClient(config); + * const command = new UpdateProvisioningTemplateCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link UpdateProvisioningTemplateCommandInput} for command's `input` shape. + * @see {@link UpdateProvisioningTemplateCommandOutput} for command's `response` shape. + * @see {@link IoTClientResolvedConfig | config} for command's `input` shape. + * */ export class UpdateProvisioningTemplateCommand extends $Command< UpdateProvisioningTemplateCommandInput, diff --git a/clients/client-iot/commands/UpdateRoleAliasCommand.ts b/clients/client-iot/commands/UpdateRoleAliasCommand.ts index 7881b2c41d06..e3d4fc31b3c2 100644 --- a/clients/client-iot/commands/UpdateRoleAliasCommand.ts +++ b/clients/client-iot/commands/UpdateRoleAliasCommand.ts @@ -22,6 +22,20 @@ export interface UpdateRoleAliasCommandOutput extends UpdateRoleAliasResponse, _ /** *

Updates a role alias.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { IoTClient, UpdateRoleAliasCommand } from "@aws-sdk/client-iot"; // ES Modules import + * // const { IoTClient, UpdateRoleAliasCommand } = require("@aws-sdk/client-iot"); // CommonJS import + * const client = new IoTClient(config); + * const command = new UpdateRoleAliasCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link UpdateRoleAliasCommandInput} for command's `input` shape. + * @see {@link UpdateRoleAliasCommandOutput} for command's `response` shape. + * @see {@link IoTClientResolvedConfig | config} for command's `input` shape. + * */ export class UpdateRoleAliasCommand extends $Command< UpdateRoleAliasCommandInput, diff --git a/clients/client-iot/commands/UpdateScheduledAuditCommand.ts b/clients/client-iot/commands/UpdateScheduledAuditCommand.ts index 58a6fc29dfca..00cd917f25f9 100644 --- a/clients/client-iot/commands/UpdateScheduledAuditCommand.ts +++ b/clients/client-iot/commands/UpdateScheduledAuditCommand.ts @@ -23,6 +23,20 @@ export interface UpdateScheduledAuditCommandOutput extends UpdateScheduledAuditR /** *

Updates a scheduled audit, including which checks are performed and * how often the audit takes place.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { IoTClient, UpdateScheduledAuditCommand } from "@aws-sdk/client-iot"; // ES Modules import + * // const { IoTClient, UpdateScheduledAuditCommand } = require("@aws-sdk/client-iot"); // CommonJS import + * const client = new IoTClient(config); + * const command = new UpdateScheduledAuditCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link UpdateScheduledAuditCommandInput} for command's `input` shape. + * @see {@link UpdateScheduledAuditCommandOutput} for command's `response` shape. + * @see {@link IoTClientResolvedConfig | config} for command's `input` shape. + * */ export class UpdateScheduledAuditCommand extends $Command< UpdateScheduledAuditCommandInput, diff --git a/clients/client-iot/commands/UpdateSecurityProfileCommand.ts b/clients/client-iot/commands/UpdateSecurityProfileCommand.ts index 38a73e401ff9..56a6bf79651c 100644 --- a/clients/client-iot/commands/UpdateSecurityProfileCommand.ts +++ b/clients/client-iot/commands/UpdateSecurityProfileCommand.ts @@ -22,6 +22,20 @@ export interface UpdateSecurityProfileCommandOutput extends UpdateSecurityProfil /** *

Updates a Device Defender security profile.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { IoTClient, UpdateSecurityProfileCommand } from "@aws-sdk/client-iot"; // ES Modules import + * // const { IoTClient, UpdateSecurityProfileCommand } = require("@aws-sdk/client-iot"); // CommonJS import + * const client = new IoTClient(config); + * const command = new UpdateSecurityProfileCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link UpdateSecurityProfileCommandInput} for command's `input` shape. + * @see {@link UpdateSecurityProfileCommandOutput} for command's `response` shape. + * @see {@link IoTClientResolvedConfig | config} for command's `input` shape. + * */ export class UpdateSecurityProfileCommand extends $Command< UpdateSecurityProfileCommandInput, diff --git a/clients/client-iot/commands/UpdateStreamCommand.ts b/clients/client-iot/commands/UpdateStreamCommand.ts index 945037990beb..b30b2d4a0080 100644 --- a/clients/client-iot/commands/UpdateStreamCommand.ts +++ b/clients/client-iot/commands/UpdateStreamCommand.ts @@ -22,6 +22,20 @@ export interface UpdateStreamCommandOutput extends UpdateStreamResponse, __Metad /** *

Updates an existing stream. The stream version will be incremented by one.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { IoTClient, UpdateStreamCommand } from "@aws-sdk/client-iot"; // ES Modules import + * // const { IoTClient, UpdateStreamCommand } = require("@aws-sdk/client-iot"); // CommonJS import + * const client = new IoTClient(config); + * const command = new UpdateStreamCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link UpdateStreamCommandInput} for command's `input` shape. + * @see {@link UpdateStreamCommandOutput} for command's `response` shape. + * @see {@link IoTClientResolvedConfig | config} for command's `input` shape. + * */ export class UpdateStreamCommand extends $Command< UpdateStreamCommandInput, diff --git a/clients/client-iot/commands/UpdateThingCommand.ts b/clients/client-iot/commands/UpdateThingCommand.ts index c5cd1b21226d..d978099509d0 100644 --- a/clients/client-iot/commands/UpdateThingCommand.ts +++ b/clients/client-iot/commands/UpdateThingCommand.ts @@ -22,6 +22,20 @@ export interface UpdateThingCommandOutput extends UpdateThingResponse, __Metadat /** *

Updates the data for a thing.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { IoTClient, UpdateThingCommand } from "@aws-sdk/client-iot"; // ES Modules import + * // const { IoTClient, UpdateThingCommand } = require("@aws-sdk/client-iot"); // CommonJS import + * const client = new IoTClient(config); + * const command = new UpdateThingCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link UpdateThingCommandInput} for command's `input` shape. + * @see {@link UpdateThingCommandOutput} for command's `response` shape. + * @see {@link IoTClientResolvedConfig | config} for command's `input` shape. + * */ export class UpdateThingCommand extends $Command< UpdateThingCommandInput, diff --git a/clients/client-iot/commands/UpdateThingGroupCommand.ts b/clients/client-iot/commands/UpdateThingGroupCommand.ts index f2a1bd47b80c..0b0ee7cbee58 100644 --- a/clients/client-iot/commands/UpdateThingGroupCommand.ts +++ b/clients/client-iot/commands/UpdateThingGroupCommand.ts @@ -22,6 +22,20 @@ export interface UpdateThingGroupCommandOutput extends UpdateThingGroupResponse, /** *

Update a thing group.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { IoTClient, UpdateThingGroupCommand } from "@aws-sdk/client-iot"; // ES Modules import + * // const { IoTClient, UpdateThingGroupCommand } = require("@aws-sdk/client-iot"); // CommonJS import + * const client = new IoTClient(config); + * const command = new UpdateThingGroupCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link UpdateThingGroupCommandInput} for command's `input` shape. + * @see {@link UpdateThingGroupCommandOutput} for command's `response` shape. + * @see {@link IoTClientResolvedConfig | config} for command's `input` shape. + * */ export class UpdateThingGroupCommand extends $Command< UpdateThingGroupCommandInput, diff --git a/clients/client-iot/commands/UpdateThingGroupsForThingCommand.ts b/clients/client-iot/commands/UpdateThingGroupsForThingCommand.ts index cd938dbce938..8a2ba0d233b4 100644 --- a/clients/client-iot/commands/UpdateThingGroupsForThingCommand.ts +++ b/clients/client-iot/commands/UpdateThingGroupsForThingCommand.ts @@ -22,6 +22,20 @@ export interface UpdateThingGroupsForThingCommandOutput extends UpdateThingGroup /** *

Updates the groups to which the thing belongs.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { IoTClient, UpdateThingGroupsForThingCommand } from "@aws-sdk/client-iot"; // ES Modules import + * // const { IoTClient, UpdateThingGroupsForThingCommand } = require("@aws-sdk/client-iot"); // CommonJS import + * const client = new IoTClient(config); + * const command = new UpdateThingGroupsForThingCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link UpdateThingGroupsForThingCommandInput} for command's `input` shape. + * @see {@link UpdateThingGroupsForThingCommandOutput} for command's `response` shape. + * @see {@link IoTClientResolvedConfig | config} for command's `input` shape. + * */ export class UpdateThingGroupsForThingCommand extends $Command< UpdateThingGroupsForThingCommandInput, diff --git a/clients/client-iot/commands/UpdateTopicRuleDestinationCommand.ts b/clients/client-iot/commands/UpdateTopicRuleDestinationCommand.ts index e4a4157806e1..6759e53b2bc7 100644 --- a/clients/client-iot/commands/UpdateTopicRuleDestinationCommand.ts +++ b/clients/client-iot/commands/UpdateTopicRuleDestinationCommand.ts @@ -23,6 +23,20 @@ export interface UpdateTopicRuleDestinationCommandOutput extends UpdateTopicRule /** *

Updates a topic rule destination. You use this to change the status, endpoint URL, or * confirmation URL of the destination.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { IoTClient, UpdateTopicRuleDestinationCommand } from "@aws-sdk/client-iot"; // ES Modules import + * // const { IoTClient, UpdateTopicRuleDestinationCommand } = require("@aws-sdk/client-iot"); // CommonJS import + * const client = new IoTClient(config); + * const command = new UpdateTopicRuleDestinationCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link UpdateTopicRuleDestinationCommandInput} for command's `input` shape. + * @see {@link UpdateTopicRuleDestinationCommandOutput} for command's `response` shape. + * @see {@link IoTClientResolvedConfig | config} for command's `input` shape. + * */ export class UpdateTopicRuleDestinationCommand extends $Command< UpdateTopicRuleDestinationCommandInput, diff --git a/clients/client-iot/commands/ValidateSecurityProfileBehaviorsCommand.ts b/clients/client-iot/commands/ValidateSecurityProfileBehaviorsCommand.ts index ebbfa9e02ef4..94c0059ed76c 100644 --- a/clients/client-iot/commands/ValidateSecurityProfileBehaviorsCommand.ts +++ b/clients/client-iot/commands/ValidateSecurityProfileBehaviorsCommand.ts @@ -24,6 +24,20 @@ export interface ValidateSecurityProfileBehaviorsCommandOutput /** *

Validates a Device Defender security profile behaviors specification.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { IoTClient, ValidateSecurityProfileBehaviorsCommand } from "@aws-sdk/client-iot"; // ES Modules import + * // const { IoTClient, ValidateSecurityProfileBehaviorsCommand } = require("@aws-sdk/client-iot"); // CommonJS import + * const client = new IoTClient(config); + * const command = new ValidateSecurityProfileBehaviorsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ValidateSecurityProfileBehaviorsCommandInput} for command's `input` shape. + * @see {@link ValidateSecurityProfileBehaviorsCommandOutput} for command's `response` shape. + * @see {@link IoTClientResolvedConfig | config} for command's `input` shape. + * */ export class ValidateSecurityProfileBehaviorsCommand extends $Command< ValidateSecurityProfileBehaviorsCommandInput, diff --git a/clients/client-iot/models/models_0.ts b/clients/client-iot/models/models_0.ts index d9c029f94ff2..81f5ab90d638 100644 --- a/clients/client-iot/models/models_0.ts +++ b/clients/client-iot/models/models_0.ts @@ -40,6 +40,9 @@ export interface AbortCriteria { } export namespace AbortCriteria { + /** + * @internal + */ export const filterSensitiveLog = (obj: AbortCriteria): any => ({ ...obj, }); @@ -56,6 +59,9 @@ export interface AbortConfig { } export namespace AbortConfig { + /** + * @internal + */ export const filterSensitiveLog = (obj: AbortConfig): any => ({ ...obj, }); @@ -78,6 +84,9 @@ export interface AcceptCertificateTransferRequest { } export namespace AcceptCertificateTransferRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: AcceptCertificateTransferRequest): any => ({ ...obj, }); @@ -96,6 +105,9 @@ export interface InternalFailureException extends __SmithyException, $MetadataBe } export namespace InternalFailureException { + /** + * @internal + */ export const filterSensitiveLog = (obj: InternalFailureException): any => ({ ...obj, }); @@ -114,6 +126,9 @@ export interface InvalidRequestException extends __SmithyException, $MetadataBea } export namespace InvalidRequestException { + /** + * @internal + */ export const filterSensitiveLog = (obj: InvalidRequestException): any => ({ ...obj, }); @@ -132,6 +147,9 @@ export interface ResourceNotFoundException extends __SmithyException, $MetadataB } export namespace ResourceNotFoundException { + /** + * @internal + */ export const filterSensitiveLog = (obj: ResourceNotFoundException): any => ({ ...obj, }); @@ -150,6 +168,9 @@ export interface ServiceUnavailableException extends __SmithyException, $Metadat } export namespace ServiceUnavailableException { + /** + * @internal + */ export const filterSensitiveLog = (obj: ServiceUnavailableException): any => ({ ...obj, }); @@ -168,6 +189,9 @@ export interface ThrottlingException extends __SmithyException, $MetadataBearer } export namespace ThrottlingException { + /** + * @internal + */ export const filterSensitiveLog = (obj: ThrottlingException): any => ({ ...obj, }); @@ -187,6 +211,9 @@ export interface TransferAlreadyCompletedException extends __SmithyException, $M } export namespace TransferAlreadyCompletedException { + /** + * @internal + */ export const filterSensitiveLog = (obj: TransferAlreadyCompletedException): any => ({ ...obj, }); @@ -205,6 +232,9 @@ export interface UnauthorizedException extends __SmithyException, $MetadataBeare } export namespace UnauthorizedException { + /** + * @internal + */ export const filterSensitiveLog = (obj: UnauthorizedException): any => ({ ...obj, }); @@ -237,6 +267,9 @@ export interface CloudwatchAlarmAction { } export namespace CloudwatchAlarmAction { + /** + * @internal + */ export const filterSensitiveLog = (obj: CloudwatchAlarmAction): any => ({ ...obj, }); @@ -258,6 +291,9 @@ export interface CloudwatchLogsAction { } export namespace CloudwatchLogsAction { + /** + * @internal + */ export const filterSensitiveLog = (obj: CloudwatchLogsAction): any => ({ ...obj, }); @@ -300,6 +336,9 @@ export interface CloudwatchMetricAction { } export namespace CloudwatchMetricAction { + /** + * @internal + */ export const filterSensitiveLog = (obj: CloudwatchMetricAction): any => ({ ...obj, }); @@ -383,6 +422,9 @@ export interface DynamoDBAction { } export namespace DynamoDBAction { + /** + * @internal + */ export const filterSensitiveLog = (obj: DynamoDBAction): any => ({ ...obj, }); @@ -400,6 +442,9 @@ export interface PutItemInput { } export namespace PutItemInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: PutItemInput): any => ({ ...obj, }); @@ -430,6 +475,9 @@ export interface DynamoDBv2Action { } export namespace DynamoDBv2Action { + /** + * @internal + */ export const filterSensitiveLog = (obj: DynamoDBv2Action): any => ({ ...obj, }); @@ -467,6 +515,9 @@ export interface ElasticsearchAction { } export namespace ElasticsearchAction { + /** + * @internal + */ export const filterSensitiveLog = (obj: ElasticsearchAction): any => ({ ...obj, }); @@ -508,6 +559,9 @@ export interface FirehoseAction { } export namespace FirehoseAction { + /** + * @internal + */ export const filterSensitiveLog = (obj: FirehoseAction): any => ({ ...obj, }); @@ -534,6 +588,9 @@ export interface SigV4Authorization { } export namespace SigV4Authorization { + /** + * @internal + */ export const filterSensitiveLog = (obj: SigV4Authorization): any => ({ ...obj, }); @@ -551,6 +608,9 @@ export interface HttpAuthorization { } export namespace HttpAuthorization { + /** + * @internal + */ export const filterSensitiveLog = (obj: HttpAuthorization): any => ({ ...obj, }); @@ -572,6 +632,9 @@ export interface HttpActionHeader { } export namespace HttpActionHeader { + /** + * @internal + */ export const filterSensitiveLog = (obj: HttpActionHeader): any => ({ ...obj, }); @@ -610,6 +673,9 @@ export interface HttpAction { } export namespace HttpAction { + /** + * @internal + */ export const filterSensitiveLog = (obj: HttpAction): any => ({ ...obj, }); @@ -649,6 +715,9 @@ export interface IotAnalyticsAction { } export namespace IotAnalyticsAction { + /** + * @internal + */ export const filterSensitiveLog = (obj: IotAnalyticsAction): any => ({ ...obj, }); @@ -694,6 +763,9 @@ export interface IotEventsAction { } export namespace IotEventsAction { + /** + * @internal + */ export const filterSensitiveLog = (obj: IotEventsAction): any => ({ ...obj, }); @@ -717,6 +789,9 @@ export interface AssetPropertyTimestamp { } export namespace AssetPropertyTimestamp { + /** + * @internal + */ export const filterSensitiveLog = (obj: AssetPropertyTimestamp): any => ({ ...obj, }); @@ -804,6 +879,9 @@ export namespace AssetPropertyVariant { return visitor._(value.$unknown[0], value.$unknown[1]); }; + /** + * @internal + */ export const filterSensitiveLog = (obj: AssetPropertyVariant): any => { if (obj.stringValue !== undefined) return { stringValue: obj.stringValue }; if (obj.integerValue !== undefined) return { integerValue: obj.integerValue }; @@ -835,6 +913,9 @@ export interface AssetPropertyValue { } export namespace AssetPropertyValue { + /** + * @internal + */ export const filterSensitiveLog = (obj: AssetPropertyValue): any => ({ ...obj, ...(obj.value && { value: AssetPropertyVariant.filterSensitiveLog(obj.value) }), @@ -881,6 +962,9 @@ export interface PutAssetPropertyValueEntry { } export namespace PutAssetPropertyValueEntry { + /** + * @internal + */ export const filterSensitiveLog = (obj: PutAssetPropertyValueEntry): any => ({ ...obj, ...(obj.propertyValues && { @@ -908,6 +992,9 @@ export interface IotSiteWiseAction { } export namespace IotSiteWiseAction { + /** + * @internal + */ export const filterSensitiveLog = (obj: IotSiteWiseAction): any => ({ ...obj, }); @@ -944,6 +1031,9 @@ export interface KafkaAction { } export namespace KafkaAction { + /** + * @internal + */ export const filterSensitiveLog = (obj: KafkaAction): any => ({ ...obj, }); @@ -970,6 +1060,9 @@ export interface KinesisAction { } export namespace KinesisAction { + /** + * @internal + */ export const filterSensitiveLog = (obj: KinesisAction): any => ({ ...obj, }); @@ -986,6 +1079,9 @@ export interface LambdaAction { } export namespace LambdaAction { + /** + * @internal + */ export const filterSensitiveLog = (obj: LambdaAction): any => ({ ...obj, }); @@ -1013,6 +1109,9 @@ export interface RepublishAction { } export namespace RepublishAction { + /** + * @internal + */ export const filterSensitiveLog = (obj: RepublishAction): any => ({ ...obj, }); @@ -1056,6 +1155,9 @@ export interface S3Action { } export namespace S3Action { + /** + * @internal + */ export const filterSensitiveLog = (obj: S3Action): any => ({ ...obj, }); @@ -1081,6 +1183,9 @@ export interface SalesforceAction { } export namespace SalesforceAction { + /** + * @internal + */ export const filterSensitiveLog = (obj: SalesforceAction): any => ({ ...obj, }); @@ -1115,6 +1220,9 @@ export interface SnsAction { } export namespace SnsAction { + /** + * @internal + */ export const filterSensitiveLog = (obj: SnsAction): any => ({ ...obj, }); @@ -1141,6 +1249,9 @@ export interface SqsAction { } export namespace SqsAction { + /** + * @internal + */ export const filterSensitiveLog = (obj: SqsAction): any => ({ ...obj, }); @@ -1170,6 +1281,9 @@ export interface StepFunctionsAction { } export namespace StepFunctionsAction { + /** + * @internal + */ export const filterSensitiveLog = (obj: StepFunctionsAction): any => ({ ...obj, }); @@ -1198,6 +1312,9 @@ export interface TimestreamDimension { } export namespace TimestreamDimension { + /** + * @internal + */ export const filterSensitiveLog = (obj: TimestreamDimension): any => ({ ...obj, }); @@ -1224,6 +1341,9 @@ export interface TimestreamTimestamp { } export namespace TimestreamTimestamp { + /** + * @internal + */ export const filterSensitiveLog = (obj: TimestreamTimestamp): any => ({ ...obj, }); @@ -1269,6 +1389,9 @@ export interface TimestreamAction { } export namespace TimestreamAction { + /** + * @internal + */ export const filterSensitiveLog = (obj: TimestreamAction): any => ({ ...obj, }); @@ -1390,6 +1513,9 @@ export interface Action { } export namespace Action { + /** + * @internal + */ export const filterSensitiveLog = (obj: Action): any => ({ ...obj, }); @@ -1436,6 +1562,9 @@ export interface MachineLearningDetectionConfig { } export namespace MachineLearningDetectionConfig { + /** + * @internal + */ export const filterSensitiveLog = (obj: MachineLearningDetectionConfig): any => ({ ...obj, }); @@ -1461,6 +1590,9 @@ export interface StatisticalThreshold { } export namespace StatisticalThreshold { + /** + * @internal + */ export const filterSensitiveLog = (obj: StatisticalThreshold): any => ({ ...obj, }); @@ -1511,6 +1643,9 @@ export interface MetricValue { } export namespace MetricValue { + /** + * @internal + */ export const filterSensitiveLog = (obj: MetricValue): any => ({ ...obj, }); @@ -1592,6 +1727,9 @@ export interface BehaviorCriteria { } export namespace BehaviorCriteria { + /** + * @internal + */ export const filterSensitiveLog = (obj: BehaviorCriteria): any => ({ ...obj, }); @@ -1618,6 +1756,9 @@ export interface MetricDimension { } export namespace MetricDimension { + /** + * @internal + */ export const filterSensitiveLog = (obj: MetricDimension): any => ({ ...obj, }); @@ -1659,6 +1800,9 @@ export interface Behavior { } export namespace Behavior { + /** + * @internal + */ export const filterSensitiveLog = (obj: Behavior): any => ({ ...obj, }); @@ -1679,6 +1823,9 @@ export interface ViolationEventAdditionalInfo { } export namespace ViolationEventAdditionalInfo { + /** + * @internal + */ export const filterSensitiveLog = (obj: ViolationEventAdditionalInfo): any => ({ ...obj, }); @@ -1732,6 +1879,9 @@ export interface ActiveViolation { } export namespace ActiveViolation { + /** + * @internal + */ export const filterSensitiveLog = (obj: ActiveViolation): any => ({ ...obj, }); @@ -1753,6 +1903,9 @@ export interface MetricToRetain { } export namespace MetricToRetain { + /** + * @internal + */ export const filterSensitiveLog = (obj: MetricToRetain): any => ({ ...obj, }); @@ -1774,6 +1927,9 @@ export interface AddThingsToThingGroupParams { } export namespace AddThingsToThingGroupParams { + /** + * @internal + */ export const filterSensitiveLog = (obj: AddThingsToThingGroupParams): any => ({ ...obj, }); @@ -1802,6 +1958,9 @@ export interface AddThingToBillingGroupRequest { } export namespace AddThingToBillingGroupRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: AddThingToBillingGroupRequest): any => ({ ...obj, }); @@ -1810,6 +1969,9 @@ export namespace AddThingToBillingGroupRequest { export interface AddThingToBillingGroupResponse {} export namespace AddThingToBillingGroupResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: AddThingToBillingGroupResponse): any => ({ ...obj, }); @@ -1846,6 +2008,9 @@ export interface AddThingToThingGroupRequest { } export namespace AddThingToThingGroupRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: AddThingToThingGroupRequest): any => ({ ...obj, }); @@ -1854,6 +2019,9 @@ export namespace AddThingToThingGroupRequest { export interface AddThingToThingGroupResponse {} export namespace AddThingToThingGroupResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: AddThingToThingGroupResponse): any => ({ ...obj, }); @@ -1876,6 +2044,9 @@ export interface AlertTarget { } export namespace AlertTarget { + /** + * @internal + */ export const filterSensitiveLog = (obj: AlertTarget): any => ({ ...obj, }); @@ -1901,6 +2072,9 @@ export interface Policy { } export namespace Policy { + /** + * @internal + */ export const filterSensitiveLog = (obj: Policy): any => ({ ...obj, }); @@ -1917,6 +2091,9 @@ export interface Allowed { } export namespace Allowed { + /** + * @internal + */ export const filterSensitiveLog = (obj: Allowed): any => ({ ...obj, }); @@ -1953,6 +2130,9 @@ export interface AssociateTargetsWithJobRequest { } export namespace AssociateTargetsWithJobRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: AssociateTargetsWithJobRequest): any => ({ ...obj, }); @@ -1976,6 +2156,9 @@ export interface AssociateTargetsWithJobResponse { } export namespace AssociateTargetsWithJobResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: AssociateTargetsWithJobResponse): any => ({ ...obj, }); @@ -1994,6 +2177,9 @@ export interface LimitExceededException extends __SmithyException, $MetadataBear } export namespace LimitExceededException { + /** + * @internal + */ export const filterSensitiveLog = (obj: LimitExceededException): any => ({ ...obj, }); @@ -2012,6 +2198,9 @@ export interface AttachPolicyRequest { } export namespace AttachPolicyRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: AttachPolicyRequest): any => ({ ...obj, }); @@ -2034,6 +2223,9 @@ export interface AttachPrincipalPolicyRequest { } export namespace AttachPrincipalPolicyRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: AttachPrincipalPolicyRequest): any => ({ ...obj, }); @@ -2052,6 +2244,9 @@ export interface AttachSecurityProfileRequest { } export namespace AttachSecurityProfileRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: AttachSecurityProfileRequest): any => ({ ...obj, }); @@ -2060,6 +2255,9 @@ export namespace AttachSecurityProfileRequest { export interface AttachSecurityProfileResponse {} export namespace AttachSecurityProfileResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: AttachSecurityProfileResponse): any => ({ ...obj, }); @@ -2080,6 +2278,9 @@ export interface VersionConflictException extends __SmithyException, $MetadataBe } export namespace VersionConflictException { + /** + * @internal + */ export const filterSensitiveLog = (obj: VersionConflictException): any => ({ ...obj, }); @@ -2102,6 +2303,9 @@ export interface AttachThingPrincipalRequest { } export namespace AttachThingPrincipalRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: AttachThingPrincipalRequest): any => ({ ...obj, }); @@ -2113,6 +2317,9 @@ export namespace AttachThingPrincipalRequest { export interface AttachThingPrincipalResponse {} export namespace AttachThingPrincipalResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: AttachThingPrincipalResponse): any => ({ ...obj, }); @@ -2142,6 +2349,9 @@ export interface AttributePayload { } export namespace AttributePayload { + /** + * @internal + */ export const filterSensitiveLog = (obj: AttributePayload): any => ({ ...obj, }); @@ -2158,6 +2368,9 @@ export interface AuditCheckConfiguration { } export namespace AuditCheckConfiguration { + /** + * @internal + */ export const filterSensitiveLog = (obj: AuditCheckConfiguration): any => ({ ...obj, }); @@ -2217,6 +2430,9 @@ export interface AuditCheckDetails { } export namespace AuditCheckDetails { + /** + * @internal + */ export const filterSensitiveLog = (obj: AuditCheckDetails): any => ({ ...obj, }); @@ -2238,6 +2454,9 @@ export interface PolicyVersionIdentifier { } export namespace PolicyVersionIdentifier { + /** + * @internal + */ export const filterSensitiveLog = (obj: PolicyVersionIdentifier): any => ({ ...obj, }); @@ -2289,6 +2508,9 @@ export interface ResourceIdentifier { } export namespace ResourceIdentifier { + /** + * @internal + */ export const filterSensitiveLog = (obj: ResourceIdentifier): any => ({ ...obj, }); @@ -2326,6 +2548,9 @@ export interface NonCompliantResource { } export namespace NonCompliantResource { + /** + * @internal + */ export const filterSensitiveLog = (obj: NonCompliantResource): any => ({ ...obj, }); @@ -2352,6 +2577,9 @@ export interface RelatedResource { } export namespace RelatedResource { + /** + * @internal + */ export const filterSensitiveLog = (obj: RelatedResource): any => ({ ...obj, }); @@ -2429,6 +2657,9 @@ export interface AuditFinding { } export namespace AuditFinding { + /** + * @internal + */ export const filterSensitiveLog = (obj: AuditFinding): any => ({ ...obj, }); @@ -2501,6 +2732,9 @@ export interface AuditMitigationActionExecutionMetadata { } export namespace AuditMitigationActionExecutionMetadata { + /** + * @internal + */ export const filterSensitiveLog = (obj: AuditMitigationActionExecutionMetadata): any => ({ ...obj, }); @@ -2534,6 +2768,9 @@ export interface AuditMitigationActionsTaskMetadata { } export namespace AuditMitigationActionsTaskMetadata { + /** + * @internal + */ export const filterSensitiveLog = (obj: AuditMitigationActionsTaskMetadata): any => ({ ...obj, }); @@ -2570,6 +2807,9 @@ export interface TaskStatisticsForAuditCheck { } export namespace TaskStatisticsForAuditCheck { + /** + * @internal + */ export const filterSensitiveLog = (obj: TaskStatisticsForAuditCheck): any => ({ ...obj, }); @@ -2596,6 +2836,9 @@ export interface AuditMitigationActionsTaskTarget { } export namespace AuditMitigationActionsTaskTarget { + /** + * @internal + */ export const filterSensitiveLog = (obj: AuditMitigationActionsTaskTarget): any => ({ ...obj, }); @@ -2622,6 +2865,9 @@ export interface AuditNotificationTarget { } export namespace AuditNotificationTarget { + /** + * @internal + */ export const filterSensitiveLog = (obj: AuditNotificationTarget): any => ({ ...obj, }); @@ -2671,6 +2917,9 @@ export interface AuditSuppression { } export namespace AuditSuppression { + /** + * @internal + */ export const filterSensitiveLog = (obj: AuditSuppression): any => ({ ...obj, }); @@ -2710,6 +2959,9 @@ export interface AuditTaskMetadata { } export namespace AuditTaskMetadata { + /** + * @internal + */ export const filterSensitiveLog = (obj: AuditTaskMetadata): any => ({ ...obj, }); @@ -2738,6 +2990,9 @@ export interface AuthInfo { } export namespace AuthInfo { + /** + * @internal + */ export const filterSensitiveLog = (obj: AuthInfo): any => ({ ...obj, }); @@ -2759,6 +3014,9 @@ export interface AuthorizerConfig { } export namespace AuthorizerConfig { + /** + * @internal + */ export const filterSensitiveLog = (obj: AuthorizerConfig): any => ({ ...obj, }); @@ -2821,6 +3079,9 @@ export interface AuthorizerDescription { } export namespace AuthorizerDescription { + /** + * @internal + */ export const filterSensitiveLog = (obj: AuthorizerDescription): any => ({ ...obj, }); @@ -2842,6 +3103,9 @@ export interface AuthorizerSummary { } export namespace AuthorizerSummary { + /** + * @internal + */ export const filterSensitiveLog = (obj: AuthorizerSummary): any => ({ ...obj, }); @@ -2858,6 +3122,9 @@ export interface ExplicitDeny { } export namespace ExplicitDeny { + /** + * @internal + */ export const filterSensitiveLog = (obj: ExplicitDeny): any => ({ ...obj, }); @@ -2876,6 +3143,9 @@ export interface ImplicitDeny { } export namespace ImplicitDeny { + /** + * @internal + */ export const filterSensitiveLog = (obj: ImplicitDeny): any => ({ ...obj, }); @@ -2899,6 +3169,9 @@ export interface Denied { } export namespace Denied { + /** + * @internal + */ export const filterSensitiveLog = (obj: Denied): any => ({ ...obj, }); @@ -2937,6 +3210,9 @@ export interface AuthResult { } export namespace AuthResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: AuthResult): any => ({ ...obj, }); @@ -2955,6 +3231,9 @@ export interface CancelAuditMitigationActionsTaskRequest { } export namespace CancelAuditMitigationActionsTaskRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: CancelAuditMitigationActionsTaskRequest): any => ({ ...obj, }); @@ -2963,6 +3242,9 @@ export namespace CancelAuditMitigationActionsTaskRequest { export interface CancelAuditMitigationActionsTaskResponse {} export namespace CancelAuditMitigationActionsTaskResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: CancelAuditMitigationActionsTaskResponse): any => ({ ...obj, }); @@ -2977,6 +3259,9 @@ export interface CancelAuditTaskRequest { } export namespace CancelAuditTaskRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: CancelAuditTaskRequest): any => ({ ...obj, }); @@ -2985,6 +3270,9 @@ export namespace CancelAuditTaskRequest { export interface CancelAuditTaskResponse {} export namespace CancelAuditTaskResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: CancelAuditTaskResponse): any => ({ ...obj, }); @@ -3002,6 +3290,9 @@ export interface CancelCertificateTransferRequest { } export namespace CancelCertificateTransferRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: CancelCertificateTransferRequest): any => ({ ...obj, }); @@ -3017,6 +3308,9 @@ export interface CancelDetectMitigationActionsTaskRequest { } export namespace CancelDetectMitigationActionsTaskRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: CancelDetectMitigationActionsTaskRequest): any => ({ ...obj, }); @@ -3025,6 +3319,9 @@ export namespace CancelDetectMitigationActionsTaskRequest { export interface CancelDetectMitigationActionsTaskResponse {} export namespace CancelDetectMitigationActionsTaskResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: CancelDetectMitigationActionsTaskResponse): any => ({ ...obj, }); @@ -3058,6 +3355,9 @@ export interface CancelJobRequest { } export namespace CancelJobRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: CancelJobRequest): any => ({ ...obj, }); @@ -3081,6 +3381,9 @@ export interface CancelJobResponse { } export namespace CancelJobResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: CancelJobResponse): any => ({ ...obj, }); @@ -3127,6 +3430,9 @@ export interface CancelJobExecutionRequest { } export namespace CancelJobExecutionRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: CancelJobExecutionRequest): any => ({ ...obj, }); @@ -3147,6 +3453,9 @@ export interface InvalidStateTransitionException extends __SmithyException, $Met } export namespace InvalidStateTransitionException { + /** + * @internal + */ export const filterSensitiveLog = (obj: InvalidStateTransitionException): any => ({ ...obj, }); @@ -3155,6 +3464,9 @@ export namespace InvalidStateTransitionException { export interface ClearDefaultAuthorizerRequest {} export namespace ClearDefaultAuthorizerRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ClearDefaultAuthorizerRequest): any => ({ ...obj, }); @@ -3163,6 +3475,9 @@ export namespace ClearDefaultAuthorizerRequest { export interface ClearDefaultAuthorizerResponse {} export namespace ClearDefaultAuthorizerResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ClearDefaultAuthorizerResponse): any => ({ ...obj, }); @@ -3176,6 +3491,9 @@ export interface ConfirmTopicRuleDestinationRequest { } export namespace ConfirmTopicRuleDestinationRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ConfirmTopicRuleDestinationRequest): any => ({ ...obj, }); @@ -3184,6 +3502,9 @@ export namespace ConfirmTopicRuleDestinationRequest { export interface ConfirmTopicRuleDestinationResponse {} export namespace ConfirmTopicRuleDestinationResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ConfirmTopicRuleDestinationResponse): any => ({ ...obj, }); @@ -3203,6 +3524,9 @@ export interface ConflictingResourceUpdateException extends __SmithyException, $ } export namespace ConflictingResourceUpdateException { + /** + * @internal + */ export const filterSensitiveLog = (obj: ConflictingResourceUpdateException): any => ({ ...obj, }); @@ -3221,6 +3545,9 @@ export interface InternalException extends __SmithyException, $MetadataBearer { } export namespace InternalException { + /** + * @internal + */ export const filterSensitiveLog = (obj: InternalException): any => ({ ...obj, }); @@ -3270,6 +3597,9 @@ export interface CreateAuditSuppressionRequest { } export namespace CreateAuditSuppressionRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateAuditSuppressionRequest): any => ({ ...obj, }); @@ -3278,6 +3608,9 @@ export namespace CreateAuditSuppressionRequest { export interface CreateAuditSuppressionResponse {} export namespace CreateAuditSuppressionResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateAuditSuppressionResponse): any => ({ ...obj, }); @@ -3306,6 +3639,9 @@ export interface ResourceAlreadyExistsException extends __SmithyException, $Meta } export namespace ResourceAlreadyExistsException { + /** + * @internal + */ export const filterSensitiveLog = (obj: ResourceAlreadyExistsException): any => ({ ...obj, }); @@ -3327,6 +3663,9 @@ export interface Tag { } export namespace Tag { + /** + * @internal + */ export const filterSensitiveLog = (obj: Tag): any => ({ ...obj, }); @@ -3378,6 +3717,9 @@ export interface CreateAuthorizerRequest { } export namespace CreateAuthorizerRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateAuthorizerRequest): any => ({ ...obj, }); @@ -3396,6 +3738,9 @@ export interface CreateAuthorizerResponse { } export namespace CreateAuthorizerResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateAuthorizerResponse): any => ({ ...obj, }); @@ -3412,6 +3757,9 @@ export interface BillingGroupProperties { } export namespace BillingGroupProperties { + /** + * @internal + */ export const filterSensitiveLog = (obj: BillingGroupProperties): any => ({ ...obj, }); @@ -3435,6 +3783,9 @@ export interface CreateBillingGroupRequest { } export namespace CreateBillingGroupRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateBillingGroupRequest): any => ({ ...obj, }); @@ -3458,6 +3809,9 @@ export interface CreateBillingGroupResponse { } export namespace CreateBillingGroupResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateBillingGroupResponse): any => ({ ...obj, }); @@ -3479,6 +3833,9 @@ export interface CreateCertificateFromCsrRequest { } export namespace CreateCertificateFromCsrRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateCertificateFromCsrRequest): any => ({ ...obj, }); @@ -3507,6 +3864,9 @@ export interface CreateCertificateFromCsrResponse { } export namespace CreateCertificateFromCsrResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateCertificateFromCsrResponse): any => ({ ...obj, }); @@ -3562,6 +3922,9 @@ export interface CreateCustomMetricRequest { } export namespace CreateCustomMetricRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateCustomMetricRequest): any => ({ ...obj, }); @@ -3585,6 +3948,9 @@ export interface CreateCustomMetricResponse { } export namespace CreateCustomMetricResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateCustomMetricResponse): any => ({ ...obj, }); @@ -3623,6 +3989,9 @@ export interface CreateDimensionRequest { } export namespace CreateDimensionRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateDimensionRequest): any => ({ ...obj, }); @@ -3644,6 +4013,9 @@ export interface CreateDimensionResponse { } export namespace CreateDimensionResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateDimensionResponse): any => ({ ...obj, }); @@ -3662,6 +4034,9 @@ export interface CertificateValidationException extends __SmithyException, $Meta } export namespace CertificateValidationException { + /** + * @internal + */ export const filterSensitiveLog = (obj: CertificateValidationException): any => ({ ...obj, }); @@ -3723,6 +4098,9 @@ export interface CreateDomainConfigurationRequest { } export namespace CreateDomainConfigurationRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateDomainConfigurationRequest): any => ({ ...obj, }); @@ -3741,6 +4119,9 @@ export interface CreateDomainConfigurationResponse { } export namespace CreateDomainConfigurationResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateDomainConfigurationResponse): any => ({ ...obj, }); @@ -3762,6 +4143,9 @@ export interface ThingGroupProperties { } export namespace ThingGroupProperties { + /** + * @internal + */ export const filterSensitiveLog = (obj: ThingGroupProperties): any => ({ ...obj, }); @@ -3808,6 +4192,9 @@ export interface CreateDynamicThingGroupRequest { } export namespace CreateDynamicThingGroupRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateDynamicThingGroupRequest): any => ({ ...obj, }); @@ -3846,6 +4233,9 @@ export interface CreateDynamicThingGroupResponse { } export namespace CreateDynamicThingGroupResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateDynamicThingGroupResponse): any => ({ ...obj, }); @@ -3864,6 +4254,9 @@ export interface InvalidQueryException extends __SmithyException, $MetadataBeare } export namespace InvalidQueryException { + /** + * @internal + */ export const filterSensitiveLog = (obj: InvalidQueryException): any => ({ ...obj, }); @@ -3885,6 +4278,9 @@ export interface RateIncreaseCriteria { } export namespace RateIncreaseCriteria { + /** + * @internal + */ export const filterSensitiveLog = (obj: RateIncreaseCriteria): any => ({ ...obj, }); @@ -3913,6 +4309,9 @@ export interface ExponentialRolloutRate { } export namespace ExponentialRolloutRate { + /** + * @internal + */ export const filterSensitiveLog = (obj: ExponentialRolloutRate): any => ({ ...obj, }); @@ -3936,6 +4335,9 @@ export interface JobExecutionsRolloutConfig { } export namespace JobExecutionsRolloutConfig { + /** + * @internal + */ export const filterSensitiveLog = (obj: JobExecutionsRolloutConfig): any => ({ ...obj, }); @@ -3959,6 +4361,9 @@ export interface PresignedUrlConfig { } export namespace PresignedUrlConfig { + /** + * @internal + */ export const filterSensitiveLog = (obj: PresignedUrlConfig): any => ({ ...obj, }); @@ -3987,6 +4392,9 @@ export interface TimeoutConfig { } export namespace TimeoutConfig { + /** + * @internal + */ export const filterSensitiveLog = (obj: TimeoutConfig): any => ({ ...obj, }); @@ -4078,6 +4486,9 @@ export interface CreateJobRequest { } export namespace CreateJobRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateJobRequest): any => ({ ...obj, }); @@ -4101,6 +4512,9 @@ export interface CreateJobResponse { } export namespace CreateJobResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateJobResponse): any => ({ ...obj, }); @@ -4117,6 +4531,9 @@ export interface CreateKeysAndCertificateRequest { } export namespace CreateKeysAndCertificateRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateKeysAndCertificateRequest): any => ({ ...obj, }); @@ -4138,6 +4555,9 @@ export interface KeyPair { } export namespace KeyPair { + /** + * @internal + */ export const filterSensitiveLog = (obj: KeyPair): any => ({ ...obj, ...(obj.PrivateKey && { PrivateKey: SENSITIVE_STRING }), @@ -4171,6 +4591,9 @@ export interface CreateKeysAndCertificateResponse { } export namespace CreateKeysAndCertificateResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateKeysAndCertificateResponse): any => ({ ...obj, ...(obj.keyPair && { keyPair: KeyPair.filterSensitiveLog(obj.keyPair) }), @@ -4201,6 +4624,9 @@ export interface EnableIoTLoggingParams { } export namespace EnableIoTLoggingParams { + /** + * @internal + */ export const filterSensitiveLog = (obj: EnableIoTLoggingParams): any => ({ ...obj, }); @@ -4217,6 +4643,9 @@ export interface PublishFindingToSnsParams { } export namespace PublishFindingToSnsParams { + /** + * @internal + */ export const filterSensitiveLog = (obj: PublishFindingToSnsParams): any => ({ ...obj, }); @@ -4237,6 +4666,9 @@ export interface ReplaceDefaultPolicyVersionParams { } export namespace ReplaceDefaultPolicyVersionParams { + /** + * @internal + */ export const filterSensitiveLog = (obj: ReplaceDefaultPolicyVersionParams): any => ({ ...obj, }); @@ -4257,6 +4689,9 @@ export interface UpdateCACertificateParams { } export namespace UpdateCACertificateParams { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateCACertificateParams): any => ({ ...obj, }); @@ -4277,6 +4712,9 @@ export interface UpdateDeviceCertificateParams { } export namespace UpdateDeviceCertificateParams { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateDeviceCertificateParams): any => ({ ...obj, }); @@ -4318,6 +4756,9 @@ export interface MitigationActionParams { } export namespace MitigationActionParams { + /** + * @internal + */ export const filterSensitiveLog = (obj: MitigationActionParams): any => ({ ...obj, }); @@ -4346,6 +4787,9 @@ export interface CreateMitigationActionRequest { } export namespace CreateMitigationActionRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateMitigationActionRequest): any => ({ ...obj, }); @@ -4364,6 +4808,9 @@ export interface CreateMitigationActionResponse { } export namespace CreateMitigationActionResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateMitigationActionResponse): any => ({ ...obj, }); @@ -4408,6 +4855,9 @@ export interface AwsJobAbortCriteria { } export namespace AwsJobAbortCriteria { + /** + * @internal + */ export const filterSensitiveLog = (obj: AwsJobAbortCriteria): any => ({ ...obj, }); @@ -4424,6 +4874,9 @@ export interface AwsJobAbortConfig { } export namespace AwsJobAbortConfig { + /** + * @internal + */ export const filterSensitiveLog = (obj: AwsJobAbortConfig): any => ({ ...obj, }); @@ -4447,6 +4900,9 @@ export interface AwsJobRateIncreaseCriteria { } export namespace AwsJobRateIncreaseCriteria { + /** + * @internal + */ export const filterSensitiveLog = (obj: AwsJobRateIncreaseCriteria): any => ({ ...obj, }); @@ -4477,6 +4933,9 @@ export interface AwsJobExponentialRolloutRate { } export namespace AwsJobExponentialRolloutRate { + /** + * @internal + */ export const filterSensitiveLog = (obj: AwsJobExponentialRolloutRate): any => ({ ...obj, }); @@ -4499,6 +4958,9 @@ export interface AwsJobExecutionsRolloutConfig { } export namespace AwsJobExecutionsRolloutConfig { + /** + * @internal + */ export const filterSensitiveLog = (obj: AwsJobExecutionsRolloutConfig): any => ({ ...obj, }); @@ -4517,6 +4979,9 @@ export interface AwsJobPresignedUrlConfig { } export namespace AwsJobPresignedUrlConfig { + /** + * @internal + */ export const filterSensitiveLog = (obj: AwsJobPresignedUrlConfig): any => ({ ...obj, }); @@ -4540,6 +5005,9 @@ export interface AwsJobTimeoutConfig { } export namespace AwsJobTimeoutConfig { + /** + * @internal + */ export const filterSensitiveLog = (obj: AwsJobTimeoutConfig): any => ({ ...obj, }); @@ -4561,6 +5029,9 @@ export interface CodeSigningCertificateChain { } export namespace CodeSigningCertificateChain { + /** + * @internal + */ export const filterSensitiveLog = (obj: CodeSigningCertificateChain): any => ({ ...obj, }); @@ -4577,6 +5048,9 @@ export interface CodeSigningSignature { } export namespace CodeSigningSignature { + /** + * @internal + */ export const filterSensitiveLog = (obj: CodeSigningSignature): any => ({ ...obj, }); @@ -4608,6 +5082,9 @@ export interface CustomCodeSigning { } export namespace CustomCodeSigning { + /** + * @internal + */ export const filterSensitiveLog = (obj: CustomCodeSigning): any => ({ ...obj, }); @@ -4629,6 +5106,9 @@ export interface S3Destination { } export namespace S3Destination { + /** + * @internal + */ export const filterSensitiveLog = (obj: S3Destination): any => ({ ...obj, }); @@ -4645,6 +5125,9 @@ export interface Destination { } export namespace Destination { + /** + * @internal + */ export const filterSensitiveLog = (obj: Destination): any => ({ ...obj, }); @@ -4671,6 +5154,9 @@ export interface SigningProfileParameter { } export namespace SigningProfileParameter { + /** + * @internal + */ export const filterSensitiveLog = (obj: SigningProfileParameter): any => ({ ...obj, }); @@ -4697,6 +5183,9 @@ export interface StartSigningJobParameter { } export namespace StartSigningJobParameter { + /** + * @internal + */ export const filterSensitiveLog = (obj: StartSigningJobParameter): any => ({ ...obj, }); @@ -4723,6 +5212,9 @@ export interface CodeSigning { } export namespace CodeSigning { + /** + * @internal + */ export const filterSensitiveLog = (obj: CodeSigning): any => ({ ...obj, }); @@ -4749,6 +5241,9 @@ export interface S3Location { } export namespace S3Location { + /** + * @internal + */ export const filterSensitiveLog = (obj: S3Location): any => ({ ...obj, }); @@ -4770,6 +5265,9 @@ export interface _Stream { } export namespace _Stream { + /** + * @internal + */ export const filterSensitiveLog = (obj: _Stream): any => ({ ...obj, }); @@ -4791,6 +5289,9 @@ export interface FileLocation { } export namespace FileLocation { + /** + * @internal + */ export const filterSensitiveLog = (obj: FileLocation): any => ({ ...obj, }); @@ -4833,6 +5334,9 @@ export interface OTAUpdateFile { } export namespace OTAUpdateFile { + /** + * @internal + */ export const filterSensitiveLog = (obj: OTAUpdateFile): any => ({ ...obj, }); @@ -4920,6 +5424,9 @@ export interface CreateOTAUpdateRequest { } export namespace CreateOTAUpdateRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateOTAUpdateRequest): any => ({ ...obj, }); @@ -4960,6 +5467,9 @@ export interface CreateOTAUpdateResponse { } export namespace CreateOTAUpdateResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateOTAUpdateResponse): any => ({ ...obj, }); @@ -4994,6 +5504,9 @@ export interface CreatePolicyRequest { } export namespace CreatePolicyRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreatePolicyRequest): any => ({ ...obj, }); @@ -5025,6 +5538,9 @@ export interface CreatePolicyResponse { } export namespace CreatePolicyResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreatePolicyResponse): any => ({ ...obj, }); @@ -5043,6 +5559,9 @@ export interface MalformedPolicyException extends __SmithyException, $MetadataBe } export namespace MalformedPolicyException { + /** + * @internal + */ export const filterSensitiveLog = (obj: MalformedPolicyException): any => ({ ...obj, }); @@ -5072,6 +5591,9 @@ export interface CreatePolicyVersionRequest { } export namespace CreatePolicyVersionRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreatePolicyVersionRequest): any => ({ ...obj, }); @@ -5103,6 +5625,9 @@ export interface CreatePolicyVersionResponse { } export namespace CreatePolicyVersionResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreatePolicyVersionResponse): any => ({ ...obj, }); @@ -5121,6 +5646,9 @@ export interface VersionsLimitExceededException extends __SmithyException, $Meta } export namespace VersionsLimitExceededException { + /** + * @internal + */ export const filterSensitiveLog = (obj: VersionsLimitExceededException): any => ({ ...obj, }); @@ -5134,6 +5662,9 @@ export interface CreateProvisioningClaimRequest { } export namespace CreateProvisioningClaimRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateProvisioningClaimRequest): any => ({ ...obj, }); @@ -5162,6 +5693,9 @@ export interface CreateProvisioningClaimResponse { } export namespace CreateProvisioningClaimResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateProvisioningClaimResponse): any => ({ ...obj, ...(obj.keyPair && { keyPair: KeyPair.filterSensitiveLog(obj.keyPair) }), @@ -5189,6 +5723,9 @@ export interface ProvisioningHook { } export namespace ProvisioningHook { + /** + * @internal + */ export const filterSensitiveLog = (obj: ProvisioningHook): any => ({ ...obj, }); @@ -5240,6 +5777,9 @@ export interface CreateProvisioningTemplateRequest { } export namespace CreateProvisioningTemplateRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateProvisioningTemplateRequest): any => ({ ...obj, }); @@ -5263,6 +5803,9 @@ export interface CreateProvisioningTemplateResponse { } export namespace CreateProvisioningTemplateResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateProvisioningTemplateResponse): any => ({ ...obj, }); @@ -5286,6 +5829,9 @@ export interface CreateProvisioningTemplateVersionRequest { } export namespace CreateProvisioningTemplateVersionRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateProvisioningTemplateVersionRequest): any => ({ ...obj, }); @@ -5315,6 +5861,9 @@ export interface CreateProvisioningTemplateVersionResponse { } export namespace CreateProvisioningTemplateVersionResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateProvisioningTemplateVersionResponse): any => ({ ...obj, }); @@ -5351,6 +5900,9 @@ export interface CreateRoleAliasRequest { } export namespace CreateRoleAliasRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateRoleAliasRequest): any => ({ ...obj, }); @@ -5369,6 +5921,9 @@ export interface CreateRoleAliasResponse { } export namespace CreateRoleAliasResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateRoleAliasResponse): any => ({ ...obj, }); @@ -5436,6 +5991,9 @@ export interface CreateScheduledAuditRequest { } export namespace CreateScheduledAuditRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateScheduledAuditRequest): any => ({ ...obj, }); @@ -5449,6 +6007,9 @@ export interface CreateScheduledAuditResponse { } export namespace CreateScheduledAuditResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateScheduledAuditResponse): any => ({ ...obj, }); @@ -5500,6 +6061,9 @@ export interface CreateSecurityProfileRequest { } export namespace CreateSecurityProfileRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateSecurityProfileRequest): any => ({ ...obj, }); @@ -5518,6 +6082,9 @@ export interface CreateSecurityProfileResponse { } export namespace CreateSecurityProfileResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateSecurityProfileResponse): any => ({ ...obj, }); @@ -5539,6 +6106,9 @@ export interface StreamFile { } export namespace StreamFile { + /** + * @internal + */ export const filterSensitiveLog = (obj: StreamFile): any => ({ ...obj, }); @@ -5572,6 +6142,9 @@ export interface CreateStreamRequest { } export namespace CreateStreamRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateStreamRequest): any => ({ ...obj, }); @@ -5600,6 +6173,9 @@ export interface CreateStreamResponse { } export namespace CreateStreamResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateStreamResponse): any => ({ ...obj, }); @@ -5637,6 +6213,9 @@ export interface CreateThingRequest { } export namespace CreateThingRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateThingRequest): any => ({ ...obj, }); @@ -5663,6 +6242,9 @@ export interface CreateThingResponse { } export namespace CreateThingResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateThingResponse): any => ({ ...obj, }); @@ -5691,6 +6273,9 @@ export interface CreateThingGroupRequest { } export namespace CreateThingGroupRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateThingGroupRequest): any => ({ ...obj, }); @@ -5714,6 +6299,9 @@ export interface CreateThingGroupResponse { } export namespace CreateThingGroupResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateThingGroupResponse): any => ({ ...obj, }); @@ -5736,6 +6324,9 @@ export interface ThingTypeProperties { } export namespace ThingTypeProperties { + /** + * @internal + */ export const filterSensitiveLog = (obj: ThingTypeProperties): any => ({ ...obj, }); @@ -5764,6 +6355,9 @@ export interface CreateThingTypeRequest { } export namespace CreateThingTypeRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateThingTypeRequest): any => ({ ...obj, }); @@ -5790,6 +6384,9 @@ export interface CreateThingTypeResponse { } export namespace CreateThingTypeResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateThingTypeResponse): any => ({ ...obj, }); @@ -5832,6 +6429,9 @@ export interface TopicRulePayload { } export namespace TopicRulePayload { + /** + * @internal + */ export const filterSensitiveLog = (obj: TopicRulePayload): any => ({ ...obj, }); @@ -5865,6 +6465,9 @@ export interface CreateTopicRuleRequest { } export namespace CreateTopicRuleRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateTopicRuleRequest): any => ({ ...obj, }); @@ -5883,6 +6486,9 @@ export interface SqlParseException extends __SmithyException, $MetadataBearer { } export namespace SqlParseException { + /** + * @internal + */ export const filterSensitiveLog = (obj: SqlParseException): any => ({ ...obj, }); @@ -5900,6 +6506,9 @@ export interface HttpUrlDestinationConfiguration { } export namespace HttpUrlDestinationConfiguration { + /** + * @internal + */ export const filterSensitiveLog = (obj: HttpUrlDestinationConfiguration): any => ({ ...obj, }); @@ -5931,6 +6540,9 @@ export interface VpcDestinationConfiguration { } export namespace VpcDestinationConfiguration { + /** + * @internal + */ export const filterSensitiveLog = (obj: VpcDestinationConfiguration): any => ({ ...obj, }); @@ -5952,6 +6564,9 @@ export interface TopicRuleDestinationConfiguration { } export namespace TopicRuleDestinationConfiguration { + /** + * @internal + */ export const filterSensitiveLog = (obj: TopicRuleDestinationConfiguration): any => ({ ...obj, }); @@ -5965,6 +6580,9 @@ export interface CreateTopicRuleDestinationRequest { } export namespace CreateTopicRuleDestinationRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateTopicRuleDestinationRequest): any => ({ ...obj, }); @@ -5981,6 +6599,9 @@ export interface HttpUrlDestinationProperties { } export namespace HttpUrlDestinationProperties { + /** + * @internal + */ export const filterSensitiveLog = (obj: HttpUrlDestinationProperties): any => ({ ...obj, }); @@ -6020,6 +6641,9 @@ export interface VpcDestinationProperties { } export namespace VpcDestinationProperties { + /** + * @internal + */ export const filterSensitiveLog = (obj: VpcDestinationProperties): any => ({ ...obj, }); @@ -6098,6 +6722,9 @@ export interface TopicRuleDestination { } export namespace TopicRuleDestination { + /** + * @internal + */ export const filterSensitiveLog = (obj: TopicRuleDestination): any => ({ ...obj, }); @@ -6111,6 +6738,9 @@ export interface CreateTopicRuleDestinationResponse { } export namespace CreateTopicRuleDestinationResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateTopicRuleDestinationResponse): any => ({ ...obj, }); @@ -6124,6 +6754,9 @@ export interface DeleteAccountAuditConfigurationRequest { } export namespace DeleteAccountAuditConfigurationRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteAccountAuditConfigurationRequest): any => ({ ...obj, }); @@ -6132,6 +6765,9 @@ export namespace DeleteAccountAuditConfigurationRequest { export interface DeleteAccountAuditConfigurationResponse {} export namespace DeleteAccountAuditConfigurationResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteAccountAuditConfigurationResponse): any => ({ ...obj, }); @@ -6153,6 +6789,9 @@ export interface DeleteAuditSuppressionRequest { } export namespace DeleteAuditSuppressionRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteAuditSuppressionRequest): any => ({ ...obj, }); @@ -6161,6 +6800,9 @@ export namespace DeleteAuditSuppressionRequest { export interface DeleteAuditSuppressionResponse {} export namespace DeleteAuditSuppressionResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteAuditSuppressionResponse): any => ({ ...obj, }); @@ -6174,6 +6816,9 @@ export interface DeleteAuthorizerRequest { } export namespace DeleteAuthorizerRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteAuthorizerRequest): any => ({ ...obj, }); @@ -6182,6 +6827,9 @@ export namespace DeleteAuthorizerRequest { export interface DeleteAuthorizerResponse {} export namespace DeleteAuthorizerResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteAuthorizerResponse): any => ({ ...obj, }); @@ -6201,6 +6849,9 @@ export interface DeleteConflictException extends __SmithyException, $MetadataBea } export namespace DeleteConflictException { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteConflictException): any => ({ ...obj, }); @@ -6222,6 +6873,9 @@ export interface DeleteBillingGroupRequest { } export namespace DeleteBillingGroupRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteBillingGroupRequest): any => ({ ...obj, }); @@ -6230,6 +6884,9 @@ export namespace DeleteBillingGroupRequest { export interface DeleteBillingGroupResponse {} export namespace DeleteBillingGroupResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteBillingGroupResponse): any => ({ ...obj, }); @@ -6248,6 +6905,9 @@ export interface CertificateStateException extends __SmithyException, $MetadataB } export namespace CertificateStateException { + /** + * @internal + */ export const filterSensitiveLog = (obj: CertificateStateException): any => ({ ...obj, }); @@ -6265,6 +6925,9 @@ export interface DeleteCACertificateRequest { } export namespace DeleteCACertificateRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteCACertificateRequest): any => ({ ...obj, }); @@ -6276,6 +6939,9 @@ export namespace DeleteCACertificateRequest { export interface DeleteCACertificateResponse {} export namespace DeleteCACertificateResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteCACertificateResponse): any => ({ ...obj, }); @@ -6299,6 +6965,9 @@ export interface DeleteCertificateRequest { } export namespace DeleteCertificateRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteCertificateRequest): any => ({ ...obj, }); @@ -6314,6 +6983,9 @@ export interface DeleteCustomMetricRequest { } export namespace DeleteCustomMetricRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteCustomMetricRequest): any => ({ ...obj, }); @@ -6322,6 +6994,9 @@ export namespace DeleteCustomMetricRequest { export interface DeleteCustomMetricResponse {} export namespace DeleteCustomMetricResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteCustomMetricResponse): any => ({ ...obj, }); @@ -6335,6 +7010,9 @@ export interface DeleteDimensionRequest { } export namespace DeleteDimensionRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteDimensionRequest): any => ({ ...obj, }); @@ -6343,6 +7021,9 @@ export namespace DeleteDimensionRequest { export interface DeleteDimensionResponse {} export namespace DeleteDimensionResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteDimensionResponse): any => ({ ...obj, }); @@ -6356,6 +7037,9 @@ export interface DeleteDomainConfigurationRequest { } export namespace DeleteDomainConfigurationRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteDomainConfigurationRequest): any => ({ ...obj, }); @@ -6364,6 +7048,9 @@ export namespace DeleteDomainConfigurationRequest { export interface DeleteDomainConfigurationResponse {} export namespace DeleteDomainConfigurationResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteDomainConfigurationResponse): any => ({ ...obj, }); @@ -6382,6 +7069,9 @@ export interface DeleteDynamicThingGroupRequest { } export namespace DeleteDynamicThingGroupRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteDynamicThingGroupRequest): any => ({ ...obj, }); @@ -6390,6 +7080,9 @@ export namespace DeleteDynamicThingGroupRequest { export interface DeleteDynamicThingGroupResponse {} export namespace DeleteDynamicThingGroupResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteDynamicThingGroupResponse): any => ({ ...obj, }); @@ -6432,6 +7125,9 @@ export interface DeleteJobRequest { } export namespace DeleteJobRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteJobRequest): any => ({ ...obj, }); @@ -6483,6 +7179,9 @@ export interface DeleteJobExecutionRequest { } export namespace DeleteJobExecutionRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteJobExecutionRequest): any => ({ ...obj, }); @@ -6496,6 +7195,9 @@ export interface DeleteMitigationActionRequest { } export namespace DeleteMitigationActionRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteMitigationActionRequest): any => ({ ...obj, }); @@ -6504,6 +7206,9 @@ export namespace DeleteMitigationActionRequest { export interface DeleteMitigationActionResponse {} export namespace DeleteMitigationActionResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteMitigationActionResponse): any => ({ ...obj, }); @@ -6529,6 +7234,9 @@ export interface DeleteOTAUpdateRequest { } export namespace DeleteOTAUpdateRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteOTAUpdateRequest): any => ({ ...obj, }); @@ -6537,6 +7245,9 @@ export namespace DeleteOTAUpdateRequest { export interface DeleteOTAUpdateResponse {} export namespace DeleteOTAUpdateResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteOTAUpdateResponse): any => ({ ...obj, }); @@ -6553,6 +7264,9 @@ export interface DeletePolicyRequest { } export namespace DeletePolicyRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeletePolicyRequest): any => ({ ...obj, }); @@ -6574,6 +7288,9 @@ export interface DeletePolicyVersionRequest { } export namespace DeletePolicyVersionRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeletePolicyVersionRequest): any => ({ ...obj, }); @@ -6587,6 +7304,9 @@ export interface DeleteProvisioningTemplateRequest { } export namespace DeleteProvisioningTemplateRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteProvisioningTemplateRequest): any => ({ ...obj, }); @@ -6595,6 +7315,9 @@ export namespace DeleteProvisioningTemplateRequest { export interface DeleteProvisioningTemplateResponse {} export namespace DeleteProvisioningTemplateResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteProvisioningTemplateResponse): any => ({ ...obj, }); @@ -6613,6 +7336,9 @@ export interface DeleteProvisioningTemplateVersionRequest { } export namespace DeleteProvisioningTemplateVersionRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteProvisioningTemplateVersionRequest): any => ({ ...obj, }); @@ -6621,6 +7347,9 @@ export namespace DeleteProvisioningTemplateVersionRequest { export interface DeleteProvisioningTemplateVersionResponse {} export namespace DeleteProvisioningTemplateVersionResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteProvisioningTemplateVersionResponse): any => ({ ...obj, }); @@ -6632,6 +7361,9 @@ export namespace DeleteProvisioningTemplateVersionResponse { export interface DeleteRegistrationCodeRequest {} export namespace DeleteRegistrationCodeRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteRegistrationCodeRequest): any => ({ ...obj, }); @@ -6643,6 +7375,9 @@ export namespace DeleteRegistrationCodeRequest { export interface DeleteRegistrationCodeResponse {} export namespace DeleteRegistrationCodeResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteRegistrationCodeResponse): any => ({ ...obj, }); @@ -6656,6 +7391,9 @@ export interface DeleteRoleAliasRequest { } export namespace DeleteRoleAliasRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteRoleAliasRequest): any => ({ ...obj, }); @@ -6664,6 +7402,9 @@ export namespace DeleteRoleAliasRequest { export interface DeleteRoleAliasResponse {} export namespace DeleteRoleAliasResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteRoleAliasResponse): any => ({ ...obj, }); @@ -6677,6 +7418,9 @@ export interface DeleteScheduledAuditRequest { } export namespace DeleteScheduledAuditRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteScheduledAuditRequest): any => ({ ...obj, }); @@ -6685,6 +7429,9 @@ export namespace DeleteScheduledAuditRequest { export interface DeleteScheduledAuditResponse {} export namespace DeleteScheduledAuditResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteScheduledAuditResponse): any => ({ ...obj, }); @@ -6705,6 +7452,9 @@ export interface DeleteSecurityProfileRequest { } export namespace DeleteSecurityProfileRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteSecurityProfileRequest): any => ({ ...obj, }); @@ -6713,6 +7463,9 @@ export namespace DeleteSecurityProfileRequest { export interface DeleteSecurityProfileResponse {} export namespace DeleteSecurityProfileResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteSecurityProfileResponse): any => ({ ...obj, }); @@ -6726,6 +7479,9 @@ export interface DeleteStreamRequest { } export namespace DeleteStreamRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteStreamRequest): any => ({ ...obj, }); @@ -6734,6 +7490,9 @@ export namespace DeleteStreamRequest { export interface DeleteStreamResponse {} export namespace DeleteStreamResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteStreamResponse): any => ({ ...obj, }); @@ -6758,6 +7517,9 @@ export interface DeleteThingRequest { } export namespace DeleteThingRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteThingRequest): any => ({ ...obj, }); @@ -6769,6 +7531,9 @@ export namespace DeleteThingRequest { export interface DeleteThingResponse {} export namespace DeleteThingResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteThingResponse): any => ({ ...obj, }); @@ -6787,6 +7552,9 @@ export interface DeleteThingGroupRequest { } export namespace DeleteThingGroupRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteThingGroupRequest): any => ({ ...obj, }); @@ -6795,6 +7563,9 @@ export namespace DeleteThingGroupRequest { export interface DeleteThingGroupResponse {} export namespace DeleteThingGroupResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteThingGroupResponse): any => ({ ...obj, }); @@ -6811,6 +7582,9 @@ export interface DeleteThingTypeRequest { } export namespace DeleteThingTypeRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteThingTypeRequest): any => ({ ...obj, }); @@ -6822,6 +7596,9 @@ export namespace DeleteThingTypeRequest { export interface DeleteThingTypeResponse {} export namespace DeleteThingTypeResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteThingTypeResponse): any => ({ ...obj, }); @@ -6838,6 +7615,9 @@ export interface DeleteTopicRuleRequest { } export namespace DeleteTopicRuleRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteTopicRuleRequest): any => ({ ...obj, }); @@ -6851,6 +7631,9 @@ export interface DeleteTopicRuleDestinationRequest { } export namespace DeleteTopicRuleDestinationRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteTopicRuleDestinationRequest): any => ({ ...obj, }); @@ -6859,6 +7642,9 @@ export namespace DeleteTopicRuleDestinationRequest { export interface DeleteTopicRuleDestinationResponse {} export namespace DeleteTopicRuleDestinationResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteTopicRuleDestinationResponse): any => ({ ...obj, }); @@ -6883,6 +7669,9 @@ export interface DeleteV2LoggingLevelRequest { } export namespace DeleteV2LoggingLevelRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteV2LoggingLevelRequest): any => ({ ...obj, }); diff --git a/clients/client-iot/models/models_1.ts b/clients/client-iot/models/models_1.ts index 11d27c89bac2..dd9ebef195ff 100644 --- a/clients/client-iot/models/models_1.ts +++ b/clients/client-iot/models/models_1.ts @@ -74,6 +74,9 @@ export interface DeprecateThingTypeRequest { } export namespace DeprecateThingTypeRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeprecateThingTypeRequest): any => ({ ...obj, }); @@ -85,6 +88,9 @@ export namespace DeprecateThingTypeRequest { export interface DeprecateThingTypeResponse {} export namespace DeprecateThingTypeResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeprecateThingTypeResponse): any => ({ ...obj, }); @@ -93,6 +99,9 @@ export namespace DeprecateThingTypeResponse { export interface DescribeAccountAuditConfigurationRequest {} export namespace DescribeAccountAuditConfigurationRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeAccountAuditConfigurationRequest): any => ({ ...obj, }); @@ -121,6 +130,9 @@ export interface DescribeAccountAuditConfigurationResponse { } export namespace DescribeAccountAuditConfigurationResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeAccountAuditConfigurationResponse): any => ({ ...obj, }); @@ -134,6 +146,9 @@ export interface DescribeAuditFindingRequest { } export namespace DescribeAuditFindingRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeAuditFindingRequest): any => ({ ...obj, }); @@ -147,6 +162,9 @@ export interface DescribeAuditFindingResponse { } export namespace DescribeAuditFindingResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeAuditFindingResponse): any => ({ ...obj, }); @@ -160,6 +178,9 @@ export interface DescribeAuditMitigationActionsTaskRequest { } export namespace DescribeAuditMitigationActionsTaskRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeAuditMitigationActionsTaskRequest): any => ({ ...obj, }); @@ -191,6 +212,9 @@ export interface MitigationAction { } export namespace MitigationAction { + /** + * @internal + */ export const filterSensitiveLog = (obj: MitigationAction): any => ({ ...obj, }); @@ -234,6 +258,9 @@ export interface DescribeAuditMitigationActionsTaskResponse { } export namespace DescribeAuditMitigationActionsTaskResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeAuditMitigationActionsTaskResponse): any => ({ ...obj, }); @@ -255,6 +282,9 @@ export interface DescribeAuditSuppressionRequest { } export namespace DescribeAuditSuppressionRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeAuditSuppressionRequest): any => ({ ...obj, }); @@ -297,6 +327,9 @@ export interface DescribeAuditSuppressionResponse { } export namespace DescribeAuditSuppressionResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeAuditSuppressionResponse): any => ({ ...obj, }); @@ -310,6 +343,9 @@ export interface DescribeAuditTaskRequest { } export namespace DescribeAuditTaskRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeAuditTaskRequest): any => ({ ...obj, }); @@ -356,6 +392,9 @@ export interface TaskStatistics { } export namespace TaskStatistics { + /** + * @internal + */ export const filterSensitiveLog = (obj: TaskStatistics): any => ({ ...obj, }); @@ -395,6 +434,9 @@ export interface DescribeAuditTaskResponse { } export namespace DescribeAuditTaskResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeAuditTaskResponse): any => ({ ...obj, }); @@ -408,6 +450,9 @@ export interface DescribeAuthorizerRequest { } export namespace DescribeAuthorizerRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeAuthorizerRequest): any => ({ ...obj, }); @@ -421,6 +466,9 @@ export interface DescribeAuthorizerResponse { } export namespace DescribeAuthorizerResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeAuthorizerResponse): any => ({ ...obj, }); @@ -434,6 +482,9 @@ export interface DescribeBillingGroupRequest { } export namespace DescribeBillingGroupRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeBillingGroupRequest): any => ({ ...obj, }); @@ -450,6 +501,9 @@ export interface BillingGroupMetadata { } export namespace BillingGroupMetadata { + /** + * @internal + */ export const filterSensitiveLog = (obj: BillingGroupMetadata): any => ({ ...obj, }); @@ -488,6 +542,9 @@ export interface DescribeBillingGroupResponse { } export namespace DescribeBillingGroupResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeBillingGroupResponse): any => ({ ...obj, }); @@ -504,6 +561,9 @@ export interface DescribeCACertificateRequest { } export namespace DescribeCACertificateRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeCACertificateRequest): any => ({ ...obj, }); @@ -530,6 +590,9 @@ export interface CertificateValidity { } export namespace CertificateValidity { + /** + * @internal + */ export const filterSensitiveLog = (obj: CertificateValidity): any => ({ ...obj, }); @@ -597,6 +660,9 @@ export interface CACertificateDescription { } export namespace CACertificateDescription { + /** + * @internal + */ export const filterSensitiveLog = (obj: CACertificateDescription): any => ({ ...obj, }); @@ -618,6 +684,9 @@ export interface RegistrationConfig { } export namespace RegistrationConfig { + /** + * @internal + */ export const filterSensitiveLog = (obj: RegistrationConfig): any => ({ ...obj, }); @@ -639,6 +708,9 @@ export interface DescribeCACertificateResponse { } export namespace DescribeCACertificateResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeCACertificateResponse): any => ({ ...obj, }); @@ -656,6 +728,9 @@ export interface DescribeCertificateRequest { } export namespace DescribeCertificateRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeCertificateRequest): any => ({ ...obj, }); @@ -706,6 +781,9 @@ export interface TransferData { } export namespace TransferData { + /** + * @internal + */ export const filterSensitiveLog = (obj: TransferData): any => ({ ...obj, }); @@ -787,6 +865,9 @@ export interface CertificateDescription { } export namespace CertificateDescription { + /** + * @internal + */ export const filterSensitiveLog = (obj: CertificateDescription): any => ({ ...obj, }); @@ -803,6 +884,9 @@ export interface DescribeCertificateResponse { } export namespace DescribeCertificateResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeCertificateResponse): any => ({ ...obj, }); @@ -818,6 +902,9 @@ export interface DescribeCustomMetricRequest { } export namespace DescribeCustomMetricRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeCustomMetricRequest): any => ({ ...obj, }); @@ -868,6 +955,9 @@ export interface DescribeCustomMetricResponse { } export namespace DescribeCustomMetricResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeCustomMetricResponse): any => ({ ...obj, }); @@ -876,6 +966,9 @@ export namespace DescribeCustomMetricResponse { export interface DescribeDefaultAuthorizerRequest {} export namespace DescribeDefaultAuthorizerRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeDefaultAuthorizerRequest): any => ({ ...obj, }); @@ -889,6 +982,9 @@ export interface DescribeDefaultAuthorizerResponse { } export namespace DescribeDefaultAuthorizerResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeDefaultAuthorizerResponse): any => ({ ...obj, }); @@ -904,6 +1000,9 @@ export interface DescribeDetectMitigationActionsTaskRequest { } export namespace DescribeDetectMitigationActionsTaskRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeDetectMitigationActionsTaskRequest): any => ({ ...obj, }); @@ -938,6 +1037,9 @@ export interface DetectMitigationActionsTaskTarget { } export namespace DetectMitigationActionsTaskTarget { + /** + * @internal + */ export const filterSensitiveLog = (obj: DetectMitigationActionsTaskTarget): any => ({ ...obj, }); @@ -972,6 +1074,9 @@ export interface DetectMitigationActionsTaskStatistics { } export namespace DetectMitigationActionsTaskStatistics { + /** + * @internal + */ export const filterSensitiveLog = (obj: DetectMitigationActionsTaskStatistics): any => ({ ...obj, }); @@ -1006,6 +1111,9 @@ export interface ViolationEventOccurrenceRange { } export namespace ViolationEventOccurrenceRange { + /** + * @internal + */ export const filterSensitiveLog = (obj: ViolationEventOccurrenceRange): any => ({ ...obj, }); @@ -1089,6 +1197,9 @@ export interface DetectMitigationActionsTaskSummary { } export namespace DetectMitigationActionsTaskSummary { + /** + * @internal + */ export const filterSensitiveLog = (obj: DetectMitigationActionsTaskSummary): any => ({ ...obj, }); @@ -1104,6 +1215,9 @@ export interface DescribeDetectMitigationActionsTaskResponse { } export namespace DescribeDetectMitigationActionsTaskResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeDetectMitigationActionsTaskResponse): any => ({ ...obj, }); @@ -1117,6 +1231,9 @@ export interface DescribeDimensionRequest { } export namespace DescribeDimensionRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeDimensionRequest): any => ({ ...obj, }); @@ -1158,6 +1275,9 @@ export interface DescribeDimensionResponse { } export namespace DescribeDimensionResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeDimensionResponse): any => ({ ...obj, }); @@ -1171,6 +1291,9 @@ export interface DescribeDomainConfigurationRequest { } export namespace DescribeDomainConfigurationRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeDomainConfigurationRequest): any => ({ ...obj, }); @@ -1213,6 +1336,9 @@ export interface ServerCertificateSummary { } export namespace ServerCertificateSummary { + /** + * @internal + */ export const filterSensitiveLog = (obj: ServerCertificateSummary): any => ({ ...obj, }); @@ -1266,6 +1392,9 @@ export interface DescribeDomainConfigurationResponse { } export namespace DescribeDomainConfigurationResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeDomainConfigurationResponse): any => ({ ...obj, }); @@ -1310,6 +1439,9 @@ export interface DescribeEndpointRequest { } export namespace DescribeEndpointRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeEndpointRequest): any => ({ ...obj, }); @@ -1327,6 +1459,9 @@ export interface DescribeEndpointResponse { } export namespace DescribeEndpointResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeEndpointResponse): any => ({ ...obj, }); @@ -1335,6 +1470,9 @@ export namespace DescribeEndpointResponse { export interface DescribeEventConfigurationsRequest {} export namespace DescribeEventConfigurationsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeEventConfigurationsRequest): any => ({ ...obj, }); @@ -1365,6 +1503,9 @@ export interface Configuration { } export namespace Configuration { + /** + * @internal + */ export const filterSensitiveLog = (obj: Configuration): any => ({ ...obj, }); @@ -1388,6 +1529,9 @@ export interface DescribeEventConfigurationsResponse { } export namespace DescribeEventConfigurationsResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeEventConfigurationsResponse): any => ({ ...obj, }); @@ -1401,6 +1545,9 @@ export interface DescribeIndexRequest { } export namespace DescribeIndexRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeIndexRequest): any => ({ ...obj, }); @@ -1447,6 +1594,9 @@ export interface DescribeIndexResponse { } export namespace DescribeIndexResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeIndexResponse): any => ({ ...obj, }); @@ -1460,6 +1610,9 @@ export interface DescribeJobRequest { } export namespace DescribeJobRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeJobRequest): any => ({ ...obj, }); @@ -1517,6 +1670,9 @@ export interface JobProcessDetails { } export namespace JobProcessDetails { + /** + * @internal + */ export const filterSensitiveLog = (obj: JobProcessDetails): any => ({ ...obj, }); @@ -1642,6 +1798,9 @@ export interface Job { } export namespace Job { + /** + * @internal + */ export const filterSensitiveLog = (obj: Job): any => ({ ...obj, }); @@ -1660,6 +1819,9 @@ export interface DescribeJobResponse { } export namespace DescribeJobResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeJobResponse): any => ({ ...obj, }); @@ -1684,6 +1846,9 @@ export interface DescribeJobExecutionRequest { } export namespace DescribeJobExecutionRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeJobExecutionRequest): any => ({ ...obj, }); @@ -1711,6 +1876,9 @@ export interface JobExecutionStatusDetails { } export namespace JobExecutionStatusDetails { + /** + * @internal + */ export const filterSensitiveLog = (obj: JobExecutionStatusDetails): any => ({ ...obj, }); @@ -1785,6 +1953,9 @@ export interface JobExecution { } export namespace JobExecution { + /** + * @internal + */ export const filterSensitiveLog = (obj: JobExecution): any => ({ ...obj, }); @@ -1798,6 +1969,9 @@ export interface DescribeJobExecutionResponse { } export namespace DescribeJobExecutionResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeJobExecutionResponse): any => ({ ...obj, }); @@ -1811,6 +1985,9 @@ export interface DescribeMitigationActionRequest { } export namespace DescribeMitigationActionRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeMitigationActionRequest): any => ({ ...obj, }); @@ -1868,6 +2045,9 @@ export interface DescribeMitigationActionResponse { } export namespace DescribeMitigationActionResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeMitigationActionResponse): any => ({ ...obj, }); @@ -1881,6 +2061,9 @@ export interface DescribeProvisioningTemplateRequest { } export namespace DescribeProvisioningTemplateRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeProvisioningTemplateRequest): any => ({ ...obj, }); @@ -1940,6 +2123,9 @@ export interface DescribeProvisioningTemplateResponse { } export namespace DescribeProvisioningTemplateResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeProvisioningTemplateResponse): any => ({ ...obj, }); @@ -1958,6 +2144,9 @@ export interface DescribeProvisioningTemplateVersionRequest { } export namespace DescribeProvisioningTemplateVersionRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeProvisioningTemplateVersionRequest): any => ({ ...obj, }); @@ -1986,6 +2175,9 @@ export interface DescribeProvisioningTemplateVersionResponse { } export namespace DescribeProvisioningTemplateVersionResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeProvisioningTemplateVersionResponse): any => ({ ...obj, }); @@ -1999,6 +2191,9 @@ export interface DescribeRoleAliasRequest { } export namespace DescribeRoleAliasRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeRoleAliasRequest): any => ({ ...obj, }); @@ -2045,6 +2240,9 @@ export interface RoleAliasDescription { } export namespace RoleAliasDescription { + /** + * @internal + */ export const filterSensitiveLog = (obj: RoleAliasDescription): any => ({ ...obj, }); @@ -2058,6 +2256,9 @@ export interface DescribeRoleAliasResponse { } export namespace DescribeRoleAliasResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeRoleAliasResponse): any => ({ ...obj, }); @@ -2071,6 +2272,9 @@ export interface DescribeScheduledAuditRequest { } export namespace DescribeScheduledAuditRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeScheduledAuditRequest): any => ({ ...obj, }); @@ -2125,6 +2329,9 @@ export interface DescribeScheduledAuditResponse { } export namespace DescribeScheduledAuditResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeScheduledAuditResponse): any => ({ ...obj, }); @@ -2139,6 +2346,9 @@ export interface DescribeSecurityProfileRequest { } export namespace DescribeSecurityProfileRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeSecurityProfileRequest): any => ({ ...obj, }); @@ -2213,6 +2423,9 @@ export interface DescribeSecurityProfileResponse { } export namespace DescribeSecurityProfileResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeSecurityProfileResponse): any => ({ ...obj, }); @@ -2226,6 +2439,9 @@ export interface DescribeStreamRequest { } export namespace DescribeStreamRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeStreamRequest): any => ({ ...obj, }); @@ -2277,6 +2493,9 @@ export interface StreamInfo { } export namespace StreamInfo { + /** + * @internal + */ export const filterSensitiveLog = (obj: StreamInfo): any => ({ ...obj, }); @@ -2290,6 +2509,9 @@ export interface DescribeStreamResponse { } export namespace DescribeStreamResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeStreamResponse): any => ({ ...obj, }); @@ -2306,6 +2528,9 @@ export interface DescribeThingRequest { } export namespace DescribeThingRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeThingRequest): any => ({ ...obj, }); @@ -2365,6 +2590,9 @@ export interface DescribeThingResponse { } export namespace DescribeThingResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeThingResponse): any => ({ ...obj, }); @@ -2378,6 +2606,9 @@ export interface DescribeThingGroupRequest { } export namespace DescribeThingGroupRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeThingGroupRequest): any => ({ ...obj, }); @@ -2405,6 +2636,9 @@ export interface GroupNameAndArn { } export namespace GroupNameAndArn { + /** + * @internal + */ export const filterSensitiveLog = (obj: GroupNameAndArn): any => ({ ...obj, }); @@ -2431,6 +2665,9 @@ export interface ThingGroupMetadata { } export namespace ThingGroupMetadata { + /** + * @internal + */ export const filterSensitiveLog = (obj: ThingGroupMetadata): any => ({ ...obj, }); @@ -2489,6 +2726,9 @@ export interface DescribeThingGroupResponse { } export namespace DescribeThingGroupResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeThingGroupResponse): any => ({ ...obj, }); @@ -2502,6 +2742,9 @@ export interface DescribeThingRegistrationTaskRequest { } export namespace DescribeThingRegistrationTaskRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeThingRegistrationTaskRequest): any => ({ ...obj, }); @@ -2578,6 +2821,9 @@ export interface DescribeThingRegistrationTaskResponse { } export namespace DescribeThingRegistrationTaskResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeThingRegistrationTaskResponse): any => ({ ...obj, }); @@ -2594,6 +2840,9 @@ export interface DescribeThingTypeRequest { } export namespace DescribeThingTypeRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeThingTypeRequest): any => ({ ...obj, }); @@ -2623,6 +2872,9 @@ export interface ThingTypeMetadata { } export namespace ThingTypeMetadata { + /** + * @internal + */ export const filterSensitiveLog = (obj: ThingTypeMetadata): any => ({ ...obj, }); @@ -2662,6 +2914,9 @@ export interface DescribeThingTypeResponse { } export namespace DescribeThingTypeResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeThingTypeResponse): any => ({ ...obj, }); @@ -2680,6 +2935,9 @@ export interface DetachPolicyRequest { } export namespace DetachPolicyRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DetachPolicyRequest): any => ({ ...obj, }); @@ -2702,6 +2960,9 @@ export interface DetachPrincipalPolicyRequest { } export namespace DetachPrincipalPolicyRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DetachPrincipalPolicyRequest): any => ({ ...obj, }); @@ -2720,6 +2981,9 @@ export interface DetachSecurityProfileRequest { } export namespace DetachSecurityProfileRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DetachSecurityProfileRequest): any => ({ ...obj, }); @@ -2728,6 +2992,9 @@ export namespace DetachSecurityProfileRequest { export interface DetachSecurityProfileResponse {} export namespace DetachSecurityProfileResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DetachSecurityProfileResponse): any => ({ ...obj, }); @@ -2751,6 +3018,9 @@ export interface DetachThingPrincipalRequest { } export namespace DetachThingPrincipalRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DetachThingPrincipalRequest): any => ({ ...obj, }); @@ -2762,6 +3032,9 @@ export namespace DetachThingPrincipalRequest { export interface DetachThingPrincipalResponse {} export namespace DetachThingPrincipalResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DetachThingPrincipalResponse): any => ({ ...obj, }); @@ -2778,6 +3051,9 @@ export interface DisableTopicRuleRequest { } export namespace DisableTopicRuleRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DisableTopicRuleRequest): any => ({ ...obj, }); @@ -2794,6 +3070,9 @@ export interface EnableTopicRuleRequest { } export namespace EnableTopicRuleRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: EnableTopicRuleRequest): any => ({ ...obj, }); @@ -2823,6 +3102,9 @@ export interface GetBehaviorModelTrainingSummariesRequest { } export namespace GetBehaviorModelTrainingSummariesRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetBehaviorModelTrainingSummariesRequest): any => ({ ...obj, }); @@ -2884,6 +3166,9 @@ export interface BehaviorModelTrainingSummary { } export namespace BehaviorModelTrainingSummary { + /** + * @internal + */ export const filterSensitiveLog = (obj: BehaviorModelTrainingSummary): any => ({ ...obj, }); @@ -2906,6 +3191,9 @@ export interface GetBehaviorModelTrainingSummariesResponse { } export namespace GetBehaviorModelTrainingSummariesResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetBehaviorModelTrainingSummariesResponse): any => ({ ...obj, }); @@ -2934,6 +3222,9 @@ export interface GetCardinalityRequest { } export namespace GetCardinalityRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetCardinalityRequest): any => ({ ...obj, }); @@ -2947,6 +3238,9 @@ export interface GetCardinalityResponse { } export namespace GetCardinalityResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetCardinalityResponse): any => ({ ...obj, }); @@ -2965,6 +3259,9 @@ export interface IndexNotReadyException extends __SmithyException, $MetadataBear } export namespace IndexNotReadyException { + /** + * @internal + */ export const filterSensitiveLog = (obj: IndexNotReadyException): any => ({ ...obj, }); @@ -2980,6 +3277,9 @@ export interface InvalidAggregationException extends __SmithyException, $Metadat } export namespace InvalidAggregationException { + /** + * @internal + */ export const filterSensitiveLog = (obj: InvalidAggregationException): any => ({ ...obj, }); @@ -3003,6 +3303,9 @@ export interface GetEffectivePoliciesRequest { } export namespace GetEffectivePoliciesRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetEffectivePoliciesRequest): any => ({ ...obj, }); @@ -3029,6 +3332,9 @@ export interface EffectivePolicy { } export namespace EffectivePolicy { + /** + * @internal + */ export const filterSensitiveLog = (obj: EffectivePolicy): any => ({ ...obj, }); @@ -3042,6 +3348,9 @@ export interface GetEffectivePoliciesResponse { } export namespace GetEffectivePoliciesResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetEffectivePoliciesResponse): any => ({ ...obj, }); @@ -3050,6 +3359,9 @@ export namespace GetEffectivePoliciesResponse { export interface GetIndexingConfigurationRequest {} export namespace GetIndexingConfigurationRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetIndexingConfigurationRequest): any => ({ ...obj, }); @@ -3077,6 +3389,9 @@ export interface Field { } export namespace Field { + /** + * @internal + */ export const filterSensitiveLog = (obj: Field): any => ({ ...obj, }); @@ -3111,6 +3426,9 @@ export interface ThingGroupIndexingConfiguration { } export namespace ThingGroupIndexingConfiguration { + /** + * @internal + */ export const filterSensitiveLog = (obj: ThingGroupIndexingConfiguration): any => ({ ...obj, }); @@ -3175,6 +3493,9 @@ export interface ThingIndexingConfiguration { } export namespace ThingIndexingConfiguration { + /** + * @internal + */ export const filterSensitiveLog = (obj: ThingIndexingConfiguration): any => ({ ...obj, }); @@ -3193,6 +3514,9 @@ export interface GetIndexingConfigurationResponse { } export namespace GetIndexingConfigurationResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetIndexingConfigurationResponse): any => ({ ...obj, }); @@ -3206,6 +3530,9 @@ export interface GetJobDocumentRequest { } export namespace GetJobDocumentRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetJobDocumentRequest): any => ({ ...obj, }); @@ -3219,6 +3546,9 @@ export interface GetJobDocumentResponse { } export namespace GetJobDocumentResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetJobDocumentResponse): any => ({ ...obj, }); @@ -3230,6 +3560,9 @@ export namespace GetJobDocumentResponse { export interface GetLoggingOptionsRequest {} export namespace GetLoggingOptionsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetLoggingOptionsRequest): any => ({ ...obj, }); @@ -3251,6 +3584,9 @@ export interface GetLoggingOptionsResponse { } export namespace GetLoggingOptionsResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetLoggingOptionsResponse): any => ({ ...obj, }); @@ -3264,6 +3600,9 @@ export interface GetOTAUpdateRequest { } export namespace GetOTAUpdateRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetOTAUpdateRequest): any => ({ ...obj, }); @@ -3285,6 +3624,9 @@ export interface ErrorInfo { } export namespace ErrorInfo { + /** + * @internal + */ export const filterSensitiveLog = (obj: ErrorInfo): any => ({ ...obj, }); @@ -3382,6 +3724,9 @@ export interface OTAUpdateInfo { } export namespace OTAUpdateInfo { + /** + * @internal + */ export const filterSensitiveLog = (obj: OTAUpdateInfo): any => ({ ...obj, }); @@ -3395,6 +3740,9 @@ export interface GetOTAUpdateResponse { } export namespace GetOTAUpdateResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetOTAUpdateResponse): any => ({ ...obj, }); @@ -3428,6 +3776,9 @@ export interface GetPercentilesRequest { } export namespace GetPercentilesRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetPercentilesRequest): any => ({ ...obj, }); @@ -3449,6 +3800,9 @@ export interface PercentPair { } export namespace PercentPair { + /** + * @internal + */ export const filterSensitiveLog = (obj: PercentPair): any => ({ ...obj, }); @@ -3462,6 +3816,9 @@ export interface GetPercentilesResponse { } export namespace GetPercentilesResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetPercentilesResponse): any => ({ ...obj, }); @@ -3478,6 +3835,9 @@ export interface GetPolicyRequest { } export namespace GetPolicyRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetPolicyRequest): any => ({ ...obj, }); @@ -3524,6 +3884,9 @@ export interface GetPolicyResponse { } export namespace GetPolicyResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetPolicyResponse): any => ({ ...obj, }); @@ -3545,6 +3908,9 @@ export interface GetPolicyVersionRequest { } export namespace GetPolicyVersionRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetPolicyVersionRequest): any => ({ ...obj, }); @@ -3596,6 +3962,9 @@ export interface GetPolicyVersionResponse { } export namespace GetPolicyVersionResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetPolicyVersionResponse): any => ({ ...obj, }); @@ -3607,6 +3976,9 @@ export namespace GetPolicyVersionResponse { export interface GetRegistrationCodeRequest {} export namespace GetRegistrationCodeRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetRegistrationCodeRequest): any => ({ ...obj, }); @@ -3623,6 +3995,9 @@ export interface GetRegistrationCodeResponse { } export namespace GetRegistrationCodeResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetRegistrationCodeResponse): any => ({ ...obj, }); @@ -3652,6 +4027,9 @@ export interface GetStatisticsRequest { } export namespace GetStatisticsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetStatisticsRequest): any => ({ ...obj, }); @@ -3704,6 +4082,9 @@ export interface Statistics { } export namespace Statistics { + /** + * @internal + */ export const filterSensitiveLog = (obj: Statistics): any => ({ ...obj, }); @@ -3718,6 +4099,9 @@ export interface GetStatisticsResponse { } export namespace GetStatisticsResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetStatisticsResponse): any => ({ ...obj, }); @@ -3734,6 +4118,9 @@ export interface GetTopicRuleRequest { } export namespace GetTopicRuleRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetTopicRuleRequest): any => ({ ...obj, }); @@ -3786,6 +4173,9 @@ export interface TopicRule { } export namespace TopicRule { + /** + * @internal + */ export const filterSensitiveLog = (obj: TopicRule): any => ({ ...obj, }); @@ -3807,6 +4197,9 @@ export interface GetTopicRuleResponse { } export namespace GetTopicRuleResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetTopicRuleResponse): any => ({ ...obj, }); @@ -3820,6 +4213,9 @@ export interface GetTopicRuleDestinationRequest { } export namespace GetTopicRuleDestinationRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetTopicRuleDestinationRequest): any => ({ ...obj, }); @@ -3833,6 +4229,9 @@ export interface GetTopicRuleDestinationResponse { } export namespace GetTopicRuleDestinationResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetTopicRuleDestinationResponse): any => ({ ...obj, }); @@ -3841,6 +4240,9 @@ export namespace GetTopicRuleDestinationResponse { export interface GetV2LoggingOptionsRequest {} export namespace GetV2LoggingOptionsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetV2LoggingOptionsRequest): any => ({ ...obj, }); @@ -3864,6 +4266,9 @@ export interface GetV2LoggingOptionsResponse { } export namespace GetV2LoggingOptionsResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetV2LoggingOptionsResponse): any => ({ ...obj, }); @@ -3882,6 +4287,9 @@ export interface NotConfiguredException extends __SmithyException, $MetadataBear } export namespace NotConfiguredException { + /** + * @internal + */ export const filterSensitiveLog = (obj: NotConfiguredException): any => ({ ...obj, }); @@ -3930,6 +4338,9 @@ export interface ListActiveViolationsRequest { } export namespace ListActiveViolationsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListActiveViolationsRequest): any => ({ ...obj, }); @@ -3949,6 +4360,9 @@ export interface ListActiveViolationsResponse { } export namespace ListActiveViolationsResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListActiveViolationsResponse): any => ({ ...obj, }); @@ -3977,6 +4391,9 @@ export interface ListAttachedPoliciesRequest { } export namespace ListAttachedPoliciesRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListAttachedPoliciesRequest): any => ({ ...obj, }); @@ -3996,6 +4413,9 @@ export interface ListAttachedPoliciesResponse { } export namespace ListAttachedPoliciesResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListAttachedPoliciesResponse): any => ({ ...obj, }); @@ -4049,6 +4469,9 @@ export interface ListAuditFindingsRequest { } export namespace ListAuditFindingsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListAuditFindingsRequest): any => ({ ...obj, }); @@ -4068,6 +4491,9 @@ export interface ListAuditFindingsResponse { } export namespace ListAuditFindingsResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListAuditFindingsResponse): any => ({ ...obj, }); @@ -4101,6 +4527,9 @@ export interface ListAuditMitigationActionsExecutionsRequest { } export namespace ListAuditMitigationActionsExecutionsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListAuditMitigationActionsExecutionsRequest): any => ({ ...obj, }); @@ -4119,6 +4548,9 @@ export interface ListAuditMitigationActionsExecutionsResponse { } export namespace ListAuditMitigationActionsExecutionsResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListAuditMitigationActionsExecutionsResponse): any => ({ ...obj, }); @@ -4162,6 +4594,9 @@ export interface ListAuditMitigationActionsTasksRequest { } export namespace ListAuditMitigationActionsTasksRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListAuditMitigationActionsTasksRequest): any => ({ ...obj, }); @@ -4180,6 +4615,9 @@ export interface ListAuditMitigationActionsTasksResponse { } export namespace ListAuditMitigationActionsTasksResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListAuditMitigationActionsTasksResponse): any => ({ ...obj, }); @@ -4222,6 +4660,9 @@ export interface ListAuditSuppressionsRequest { } export namespace ListAuditSuppressionsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListAuditSuppressionsRequest): any => ({ ...obj, }); @@ -4244,6 +4685,9 @@ export interface ListAuditSuppressionsResponse { } export namespace ListAuditSuppressionsResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListAuditSuppressionsResponse): any => ({ ...obj, }); @@ -4286,6 +4730,9 @@ export interface ListAuditTasksRequest { } export namespace ListAuditTasksRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListAuditTasksRequest): any => ({ ...obj, }); @@ -4305,6 +4752,9 @@ export interface ListAuditTasksResponse { } export namespace ListAuditTasksResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListAuditTasksResponse): any => ({ ...obj, }); @@ -4333,6 +4783,9 @@ export interface ListAuthorizersRequest { } export namespace ListAuthorizersRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListAuthorizersRequest): any => ({ ...obj, }); @@ -4351,6 +4804,9 @@ export interface ListAuthorizersResponse { } export namespace ListAuthorizersResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListAuthorizersResponse): any => ({ ...obj, }); @@ -4376,6 +4832,9 @@ export interface ListBillingGroupsRequest { } export namespace ListBillingGroupsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListBillingGroupsRequest): any => ({ ...obj, }); @@ -4394,6 +4853,9 @@ export interface ListBillingGroupsResponse { } export namespace ListBillingGroupsResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListBillingGroupsResponse): any => ({ ...obj, }); @@ -4420,6 +4882,9 @@ export interface ListCACertificatesRequest { } export namespace ListCACertificatesRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListCACertificatesRequest): any => ({ ...obj, }); @@ -4452,6 +4917,9 @@ export interface CACertificate { } export namespace CACertificate { + /** + * @internal + */ export const filterSensitiveLog = (obj: CACertificate): any => ({ ...obj, }); @@ -4473,6 +4941,9 @@ export interface ListCACertificatesResponse { } export namespace ListCACertificatesResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListCACertificatesResponse): any => ({ ...obj, }); @@ -4500,6 +4971,9 @@ export interface ListCertificatesRequest { } export namespace ListCertificatesRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListCertificatesRequest): any => ({ ...obj, }); @@ -4538,6 +5012,9 @@ export interface Certificate { } export namespace Certificate { + /** + * @internal + */ export const filterSensitiveLog = (obj: Certificate): any => ({ ...obj, }); @@ -4560,6 +5037,9 @@ export interface ListCertificatesResponse { } export namespace ListCertificatesResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListCertificatesResponse): any => ({ ...obj, }); @@ -4593,6 +5073,9 @@ export interface ListCertificatesByCARequest { } export namespace ListCertificatesByCARequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListCertificatesByCARequest): any => ({ ...obj, }); @@ -4615,6 +5098,9 @@ export interface ListCertificatesByCAResponse { } export namespace ListCertificatesByCAResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListCertificatesByCAResponse): any => ({ ...obj, }); @@ -4637,6 +5123,9 @@ export interface ListCustomMetricsRequest { } export namespace ListCustomMetricsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListCustomMetricsRequest): any => ({ ...obj, }); @@ -4660,6 +5149,9 @@ export interface ListCustomMetricsResponse { } export namespace ListCustomMetricsResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListCustomMetricsResponse): any => ({ ...obj, }); @@ -4718,6 +5210,9 @@ export interface ListDetectMitigationActionsExecutionsRequest { } export namespace ListDetectMitigationActionsExecutionsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListDetectMitigationActionsExecutionsRequest): any => ({ ...obj, }); @@ -4801,6 +5296,9 @@ export interface DetectMitigationActionExecution { } export namespace DetectMitigationActionExecution { + /** + * @internal + */ export const filterSensitiveLog = (obj: DetectMitigationActionExecution): any => ({ ...obj, }); @@ -4823,6 +5321,9 @@ export interface ListDetectMitigationActionsExecutionsResponse { } export namespace ListDetectMitigationActionsExecutionsResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListDetectMitigationActionsExecutionsResponse): any => ({ ...obj, }); @@ -4858,6 +5359,9 @@ export interface ListDetectMitigationActionsTasksRequest { } export namespace ListDetectMitigationActionsTasksRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListDetectMitigationActionsTasksRequest): any => ({ ...obj, }); @@ -4880,6 +5384,9 @@ export interface ListDetectMitigationActionsTasksResponse { } export namespace ListDetectMitigationActionsTasksResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListDetectMitigationActionsTasksResponse): any => ({ ...obj, }); @@ -4898,6 +5405,9 @@ export interface ListDimensionsRequest { } export namespace ListDimensionsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListDimensionsRequest): any => ({ ...obj, }); @@ -4916,6 +5426,9 @@ export interface ListDimensionsResponse { } export namespace ListDimensionsResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListDimensionsResponse): any => ({ ...obj, }); @@ -4939,6 +5452,9 @@ export interface ListDomainConfigurationsRequest { } export namespace ListDomainConfigurationsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListDomainConfigurationsRequest): any => ({ ...obj, }); @@ -4981,6 +5497,9 @@ export interface DomainConfigurationSummary { } export namespace DomainConfigurationSummary { + /** + * @internal + */ export const filterSensitiveLog = (obj: DomainConfigurationSummary): any => ({ ...obj, }); @@ -4999,6 +5518,9 @@ export interface ListDomainConfigurationsResponse { } export namespace ListDomainConfigurationsResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListDomainConfigurationsResponse): any => ({ ...obj, }); @@ -5018,6 +5540,9 @@ export interface ListIndicesRequest { } export namespace ListIndicesRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListIndicesRequest): any => ({ ...obj, }); @@ -5037,6 +5562,9 @@ export interface ListIndicesResponse { } export namespace ListIndicesResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListIndicesResponse): any => ({ ...obj, }); @@ -5065,6 +5593,9 @@ export interface ListJobExecutionsForJobRequest { } export namespace ListJobExecutionsForJobRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListJobExecutionsForJobRequest): any => ({ ...obj, }); @@ -5103,6 +5634,9 @@ export interface JobExecutionSummary { } export namespace JobExecutionSummary { + /** + * @internal + */ export const filterSensitiveLog = (obj: JobExecutionSummary): any => ({ ...obj, }); @@ -5124,6 +5658,9 @@ export interface JobExecutionSummaryForJob { } export namespace JobExecutionSummaryForJob { + /** + * @internal + */ export const filterSensitiveLog = (obj: JobExecutionSummaryForJob): any => ({ ...obj, }); @@ -5143,6 +5680,9 @@ export interface ListJobExecutionsForJobResponse { } export namespace ListJobExecutionsForJobResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListJobExecutionsForJobResponse): any => ({ ...obj, }); @@ -5184,6 +5724,9 @@ export interface ListJobExecutionsForThingRequest { } export namespace ListJobExecutionsForThingRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListJobExecutionsForThingRequest): any => ({ ...obj, }); @@ -5205,6 +5748,9 @@ export interface JobExecutionSummaryForThing { } export namespace JobExecutionSummaryForThing { + /** + * @internal + */ export const filterSensitiveLog = (obj: JobExecutionSummaryForThing): any => ({ ...obj, }); @@ -5224,6 +5770,9 @@ export interface ListJobExecutionsForThingResponse { } export namespace ListJobExecutionsForThingResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListJobExecutionsForThingResponse): any => ({ ...obj, }); @@ -5278,6 +5827,9 @@ export interface ListJobsRequest { } export namespace ListJobsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListJobsRequest): any => ({ ...obj, }); @@ -5332,6 +5884,9 @@ export interface JobSummary { } export namespace JobSummary { + /** + * @internal + */ export const filterSensitiveLog = (obj: JobSummary): any => ({ ...obj, }); @@ -5351,6 +5906,9 @@ export interface ListJobsResponse { } export namespace ListJobsResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListJobsResponse): any => ({ ...obj, }); @@ -5374,6 +5932,9 @@ export interface ListMitigationActionsRequest { } export namespace ListMitigationActionsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListMitigationActionsRequest): any => ({ ...obj, }); @@ -5400,6 +5961,9 @@ export interface MitigationActionIdentifier { } export namespace MitigationActionIdentifier { + /** + * @internal + */ export const filterSensitiveLog = (obj: MitigationActionIdentifier): any => ({ ...obj, }); @@ -5418,6 +5982,9 @@ export interface ListMitigationActionsResponse { } export namespace ListMitigationActionsResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListMitigationActionsResponse): any => ({ ...obj, }); @@ -5441,6 +6008,9 @@ export interface ListOTAUpdatesRequest { } export namespace ListOTAUpdatesRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListOTAUpdatesRequest): any => ({ ...obj, }); @@ -5467,6 +6037,9 @@ export interface OTAUpdateSummary { } export namespace OTAUpdateSummary { + /** + * @internal + */ export const filterSensitiveLog = (obj: OTAUpdateSummary): any => ({ ...obj, }); @@ -5485,6 +6058,9 @@ export interface ListOTAUpdatesResponse { } export namespace ListOTAUpdatesResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListOTAUpdatesResponse): any => ({ ...obj, }); @@ -5512,6 +6088,9 @@ export interface ListOutgoingCertificatesRequest { } export namespace ListOutgoingCertificatesRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListOutgoingCertificatesRequest): any => ({ ...obj, }); @@ -5553,6 +6132,9 @@ export interface OutgoingCertificate { } export namespace OutgoingCertificate { + /** + * @internal + */ export const filterSensitiveLog = (obj: OutgoingCertificate): any => ({ ...obj, }); @@ -5574,6 +6156,9 @@ export interface ListOutgoingCertificatesResponse { } export namespace ListOutgoingCertificatesResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListOutgoingCertificatesResponse): any => ({ ...obj, }); @@ -5601,6 +6186,9 @@ export interface ListPoliciesRequest { } export namespace ListPoliciesRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListPoliciesRequest): any => ({ ...obj, }); @@ -5623,6 +6211,9 @@ export interface ListPoliciesResponse { } export namespace ListPoliciesResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListPoliciesResponse): any => ({ ...obj, }); @@ -5655,6 +6246,9 @@ export interface ListPolicyPrincipalsRequest { } export namespace ListPolicyPrincipalsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListPolicyPrincipalsRequest): any => ({ ...obj, }); @@ -5677,6 +6271,9 @@ export interface ListPolicyPrincipalsResponse { } export namespace ListPolicyPrincipalsResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListPolicyPrincipalsResponse): any => ({ ...obj, }); @@ -5693,6 +6290,9 @@ export interface ListPolicyVersionsRequest { } export namespace ListPolicyVersionsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListPolicyVersionsRequest): any => ({ ...obj, }); @@ -5719,6 +6319,9 @@ export interface PolicyVersion { } export namespace PolicyVersion { + /** + * @internal + */ export const filterSensitiveLog = (obj: PolicyVersion): any => ({ ...obj, }); @@ -5735,6 +6338,9 @@ export interface ListPolicyVersionsResponse { } export namespace ListPolicyVersionsResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListPolicyVersionsResponse): any => ({ ...obj, }); @@ -5767,6 +6373,9 @@ export interface ListPrincipalPoliciesRequest { } export namespace ListPrincipalPoliciesRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListPrincipalPoliciesRequest): any => ({ ...obj, }); @@ -5789,6 +6398,9 @@ export interface ListPrincipalPoliciesResponse { } export namespace ListPrincipalPoliciesResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListPrincipalPoliciesResponse): any => ({ ...obj, }); @@ -5817,6 +6429,9 @@ export interface ListPrincipalThingsRequest { } export namespace ListPrincipalThingsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListPrincipalThingsRequest): any => ({ ...obj, }); @@ -5838,6 +6453,9 @@ export interface ListPrincipalThingsResponse { } export namespace ListPrincipalThingsResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListPrincipalThingsResponse): any => ({ ...obj, }); @@ -5856,6 +6474,9 @@ export interface ListProvisioningTemplatesRequest { } export namespace ListProvisioningTemplatesRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListProvisioningTemplatesRequest): any => ({ ...obj, }); @@ -5897,6 +6518,9 @@ export interface ProvisioningTemplateSummary { } export namespace ProvisioningTemplateSummary { + /** + * @internal + */ export const filterSensitiveLog = (obj: ProvisioningTemplateSummary): any => ({ ...obj, }); @@ -5915,6 +6539,9 @@ export interface ListProvisioningTemplatesResponse { } export namespace ListProvisioningTemplatesResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListProvisioningTemplatesResponse): any => ({ ...obj, }); @@ -5938,6 +6565,9 @@ export interface ListProvisioningTemplateVersionsRequest { } export namespace ListProvisioningTemplateVersionsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListProvisioningTemplateVersionsRequest): any => ({ ...obj, }); @@ -5965,6 +6595,9 @@ export interface ProvisioningTemplateVersionSummary { } export namespace ProvisioningTemplateVersionSummary { + /** + * @internal + */ export const filterSensitiveLog = (obj: ProvisioningTemplateVersionSummary): any => ({ ...obj, }); @@ -5983,6 +6616,9 @@ export interface ListProvisioningTemplateVersionsResponse { } export namespace ListProvisioningTemplateVersionsResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListProvisioningTemplateVersionsResponse): any => ({ ...obj, }); @@ -6006,6 +6642,9 @@ export interface ListRoleAliasesRequest { } export namespace ListRoleAliasesRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListRoleAliasesRequest): any => ({ ...obj, }); @@ -6024,6 +6663,9 @@ export interface ListRoleAliasesResponse { } export namespace ListRoleAliasesResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListRoleAliasesResponse): any => ({ ...obj, }); @@ -6042,6 +6684,9 @@ export interface ListScheduledAuditsRequest { } export namespace ListScheduledAuditsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListScheduledAuditsRequest): any => ({ ...obj, }); @@ -6082,6 +6727,9 @@ export interface ScheduledAuditMetadata { } export namespace ScheduledAuditMetadata { + /** + * @internal + */ export const filterSensitiveLog = (obj: ScheduledAuditMetadata): any => ({ ...obj, }); @@ -6101,6 +6749,9 @@ export interface ListScheduledAuditsResponse { } export namespace ListScheduledAuditsResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListScheduledAuditsResponse): any => ({ ...obj, }); @@ -6132,6 +6783,9 @@ export interface ListSecurityProfilesRequest { } export namespace ListSecurityProfilesRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListSecurityProfilesRequest): any => ({ ...obj, }); @@ -6153,6 +6807,9 @@ export interface SecurityProfileIdentifier { } export namespace SecurityProfileIdentifier { + /** + * @internal + */ export const filterSensitiveLog = (obj: SecurityProfileIdentifier): any => ({ ...obj, }); @@ -6172,6 +6829,9 @@ export interface ListSecurityProfilesResponse { } export namespace ListSecurityProfilesResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListSecurityProfilesResponse): any => ({ ...obj, }); @@ -6200,6 +6860,9 @@ export interface ListSecurityProfilesForTargetRequest { } export namespace ListSecurityProfilesForTargetRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListSecurityProfilesForTargetRequest): any => ({ ...obj, }); @@ -6217,6 +6880,9 @@ export interface SecurityProfileTarget { } export namespace SecurityProfileTarget { + /** + * @internal + */ export const filterSensitiveLog = (obj: SecurityProfileTarget): any => ({ ...obj, }); @@ -6238,6 +6904,9 @@ export interface SecurityProfileTargetMapping { } export namespace SecurityProfileTargetMapping { + /** + * @internal + */ export const filterSensitiveLog = (obj: SecurityProfileTargetMapping): any => ({ ...obj, }); @@ -6257,6 +6926,9 @@ export interface ListSecurityProfilesForTargetResponse { } export namespace ListSecurityProfilesForTargetResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListSecurityProfilesForTargetResponse): any => ({ ...obj, }); @@ -6280,6 +6952,9 @@ export interface ListStreamsRequest { } export namespace ListStreamsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListStreamsRequest): any => ({ ...obj, }); @@ -6311,6 +6986,9 @@ export interface StreamSummary { } export namespace StreamSummary { + /** + * @internal + */ export const filterSensitiveLog = (obj: StreamSummary): any => ({ ...obj, }); @@ -6329,6 +7007,9 @@ export interface ListStreamsResponse { } export namespace ListStreamsResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListStreamsResponse): any => ({ ...obj, }); @@ -6349,6 +7030,9 @@ export interface ListTagsForResourceRequest { } export namespace ListTagsForResourceRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListTagsForResourceRequest): any => ({ ...obj, }); @@ -6367,6 +7051,9 @@ export interface ListTagsForResourceResponse { } export namespace ListTagsForResourceResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListTagsForResourceResponse): any => ({ ...obj, }); @@ -6390,6 +7077,9 @@ export interface ListTargetsForPolicyRequest { } export namespace ListTargetsForPolicyRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListTargetsForPolicyRequest): any => ({ ...obj, }); @@ -6408,6 +7098,9 @@ export interface ListTargetsForPolicyResponse { } export namespace ListTargetsForPolicyResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListTargetsForPolicyResponse): any => ({ ...obj, }); @@ -6431,6 +7124,9 @@ export interface ListTargetsForSecurityProfileRequest { } export namespace ListTargetsForSecurityProfileRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListTargetsForSecurityProfileRequest): any => ({ ...obj, }); @@ -6450,6 +7146,9 @@ export interface ListTargetsForSecurityProfileResponse { } export namespace ListTargetsForSecurityProfileResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListTargetsForSecurityProfileResponse): any => ({ ...obj, }); @@ -6485,6 +7184,9 @@ export interface ListThingGroupsRequest { } export namespace ListThingGroupsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListThingGroupsRequest): any => ({ ...obj, }); @@ -6503,6 +7205,9 @@ export interface ListThingGroupsResponse { } export namespace ListThingGroupsResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListThingGroupsResponse): any => ({ ...obj, }); @@ -6528,6 +7233,9 @@ export interface ListThingGroupsForThingRequest { } export namespace ListThingGroupsForThingRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListThingGroupsForThingRequest): any => ({ ...obj, }); @@ -6546,6 +7254,9 @@ export interface ListThingGroupsForThingResponse { } export namespace ListThingGroupsForThingResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListThingGroupsForThingResponse): any => ({ ...obj, }); @@ -6574,6 +7285,9 @@ export interface ListThingPrincipalsRequest { } export namespace ListThingPrincipalsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListThingPrincipalsRequest): any => ({ ...obj, }); @@ -6595,6 +7309,9 @@ export interface ListThingPrincipalsResponse { } export namespace ListThingPrincipalsResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListThingPrincipalsResponse): any => ({ ...obj, }); @@ -6630,6 +7347,9 @@ export interface ListThingRegistrationTaskReportsRequest { } export namespace ListThingRegistrationTaskReportsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListThingRegistrationTaskReportsRequest): any => ({ ...obj, }); @@ -6653,6 +7373,9 @@ export interface ListThingRegistrationTaskReportsResponse { } export namespace ListThingRegistrationTaskReportsResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListThingRegistrationTaskReportsResponse): any => ({ ...obj, }); @@ -6678,6 +7401,9 @@ export interface ListThingRegistrationTasksRequest { } export namespace ListThingRegistrationTasksRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListThingRegistrationTasksRequest): any => ({ ...obj, }); @@ -6696,6 +7422,9 @@ export interface ListThingRegistrationTasksResponse { } export namespace ListThingRegistrationTasksResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListThingRegistrationTasksResponse): any => ({ ...obj, }); @@ -6743,6 +7472,9 @@ export interface ListThingsRequest { } export namespace ListThingsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListThingsRequest): any => ({ ...obj, }); @@ -6780,6 +7512,9 @@ export interface ThingAttribute { } export namespace ThingAttribute { + /** + * @internal + */ export const filterSensitiveLog = (obj: ThingAttribute): any => ({ ...obj, }); @@ -6801,6 +7536,9 @@ export interface ListThingsResponse { } export namespace ListThingsResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListThingsResponse): any => ({ ...obj, }); @@ -6826,6 +7564,9 @@ export interface ListThingsInBillingGroupRequest { } export namespace ListThingsInBillingGroupRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListThingsInBillingGroupRequest): any => ({ ...obj, }); @@ -6844,6 +7585,9 @@ export interface ListThingsInBillingGroupResponse { } export namespace ListThingsInBillingGroupResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListThingsInBillingGroupResponse): any => ({ ...obj, }); @@ -6875,6 +7619,9 @@ export interface ListThingsInThingGroupRequest { } export namespace ListThingsInThingGroupRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListThingsInThingGroupRequest): any => ({ ...obj, }); @@ -6893,6 +7640,9 @@ export interface ListThingsInThingGroupResponse { } export namespace ListThingsInThingGroupResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListThingsInThingGroupResponse): any => ({ ...obj, }); @@ -6921,6 +7671,9 @@ export interface ListThingTypesRequest { } export namespace ListThingTypesRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListThingTypesRequest): any => ({ ...obj, }); @@ -6954,6 +7707,9 @@ export interface ThingTypeDefinition { } export namespace ThingTypeDefinition { + /** + * @internal + */ export const filterSensitiveLog = (obj: ThingTypeDefinition): any => ({ ...obj, }); @@ -6975,6 +7731,9 @@ export interface ListThingTypesResponse { } export namespace ListThingTypesResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListThingTypesResponse): any => ({ ...obj, }); @@ -6995,6 +7754,9 @@ export interface ListTopicRuleDestinationsRequest { } export namespace ListTopicRuleDestinationsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListTopicRuleDestinationsRequest): any => ({ ...obj, }); @@ -7012,6 +7774,9 @@ export interface HttpUrlDestinationSummary { } export namespace HttpUrlDestinationSummary { + /** + * @internal + */ export const filterSensitiveLog = (obj: HttpUrlDestinationSummary): any => ({ ...obj, }); @@ -7043,6 +7808,9 @@ export interface VpcDestinationSummary { } export namespace VpcDestinationSummary { + /** + * @internal + */ export const filterSensitiveLog = (obj: VpcDestinationSummary): any => ({ ...obj, }); @@ -7120,6 +7888,9 @@ export interface TopicRuleDestinationSummary { } export namespace TopicRuleDestinationSummary { + /** + * @internal + */ export const filterSensitiveLog = (obj: TopicRuleDestinationSummary): any => ({ ...obj, }); @@ -7138,6 +7909,9 @@ export interface ListTopicRuleDestinationsResponse { } export namespace ListTopicRuleDestinationsResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListTopicRuleDestinationsResponse): any => ({ ...obj, }); @@ -7171,6 +7945,9 @@ export interface ListTopicRulesRequest { } export namespace ListTopicRulesRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListTopicRulesRequest): any => ({ ...obj, }); @@ -7207,6 +7984,9 @@ export interface TopicRuleListItem { } export namespace TopicRuleListItem { + /** + * @internal + */ export const filterSensitiveLog = (obj: TopicRuleListItem): any => ({ ...obj, }); @@ -7228,6 +8008,9 @@ export interface ListTopicRulesResponse { } export namespace ListTopicRulesResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListTopicRulesResponse): any => ({ ...obj, }); @@ -7254,6 +8037,9 @@ export interface ListV2LoggingLevelsRequest { } export namespace ListV2LoggingLevelsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListV2LoggingLevelsRequest): any => ({ ...obj, }); @@ -7275,6 +8061,9 @@ export interface LogTarget { } export namespace LogTarget { + /** + * @internal + */ export const filterSensitiveLog = (obj: LogTarget): any => ({ ...obj, }); @@ -7296,6 +8085,9 @@ export interface LogTargetConfiguration { } export namespace LogTargetConfiguration { + /** + * @internal + */ export const filterSensitiveLog = (obj: LogTargetConfiguration): any => ({ ...obj, }); @@ -7314,6 +8106,9 @@ export interface ListV2LoggingLevelsResponse { } export namespace ListV2LoggingLevelsResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListV2LoggingLevelsResponse): any => ({ ...obj, }); @@ -7366,6 +8161,9 @@ export interface ListViolationEventsRequest { } export namespace ListViolationEventsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListViolationEventsRequest): any => ({ ...obj, }); @@ -7425,6 +8223,9 @@ export interface ViolationEvent { } export namespace ViolationEvent { + /** + * @internal + */ export const filterSensitiveLog = (obj: ViolationEvent): any => ({ ...obj, }); @@ -7445,6 +8246,9 @@ export interface ListViolationEventsResponse { } export namespace ListViolationEventsResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListViolationEventsResponse): any => ({ ...obj, }); @@ -7494,6 +8298,9 @@ export interface RegisterCACertificateRequest { } export namespace RegisterCACertificateRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: RegisterCACertificateRequest): any => ({ ...obj, }); @@ -7515,6 +8322,9 @@ export interface RegisterCACertificateResponse { } export namespace RegisterCACertificateResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: RegisterCACertificateResponse): any => ({ ...obj, }); @@ -7533,6 +8343,9 @@ export interface RegistrationCodeValidationException extends __SmithyException, } export namespace RegistrationCodeValidationException { + /** + * @internal + */ export const filterSensitiveLog = (obj: RegistrationCodeValidationException): any => ({ ...obj, }); @@ -7553,6 +8366,9 @@ export interface CertificateConflictException extends __SmithyException, $Metada } export namespace CertificateConflictException { + /** + * @internal + */ export const filterSensitiveLog = (obj: CertificateConflictException): any => ({ ...obj, }); @@ -7586,6 +8402,9 @@ export interface RegisterCertificateRequest { } export namespace RegisterCertificateRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: RegisterCertificateRequest): any => ({ ...obj, }); @@ -7607,6 +8426,9 @@ export interface RegisterCertificateResponse { } export namespace RegisterCertificateResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: RegisterCertificateResponse): any => ({ ...obj, }); @@ -7625,6 +8447,9 @@ export interface RegisterCertificateWithoutCARequest { } export namespace RegisterCertificateWithoutCARequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: RegisterCertificateWithoutCARequest): any => ({ ...obj, }); @@ -7644,6 +8469,9 @@ export interface RegisterCertificateWithoutCAResponse { } export namespace RegisterCertificateWithoutCAResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: RegisterCertificateWithoutCAResponse): any => ({ ...obj, }); @@ -7662,6 +8490,9 @@ export interface RegisterThingRequest { } export namespace RegisterThingRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: RegisterThingRequest): any => ({ ...obj, }); diff --git a/clients/client-iot/models/models_2.ts b/clients/client-iot/models/models_2.ts index 4b9cffb2b4c6..7986b2600f5b 100644 --- a/clients/client-iot/models/models_2.ts +++ b/clients/client-iot/models/models_2.ts @@ -58,6 +58,9 @@ export interface RegisterThingResponse { } export namespace RegisterThingResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: RegisterThingResponse): any => ({ ...obj, }); @@ -76,6 +79,9 @@ export interface ResourceRegistrationFailureException extends __SmithyException, } export namespace ResourceRegistrationFailureException { + /** + * @internal + */ export const filterSensitiveLog = (obj: ResourceRegistrationFailureException): any => ({ ...obj, }); @@ -98,6 +104,9 @@ export interface RejectCertificateTransferRequest { } export namespace RejectCertificateTransferRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: RejectCertificateTransferRequest): any => ({ ...obj, }); @@ -126,6 +135,9 @@ export interface RemoveThingFromBillingGroupRequest { } export namespace RemoveThingFromBillingGroupRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: RemoveThingFromBillingGroupRequest): any => ({ ...obj, }); @@ -134,6 +146,9 @@ export namespace RemoveThingFromBillingGroupRequest { export interface RemoveThingFromBillingGroupResponse {} export namespace RemoveThingFromBillingGroupResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: RemoveThingFromBillingGroupResponse): any => ({ ...obj, }); @@ -162,6 +177,9 @@ export interface RemoveThingFromThingGroupRequest { } export namespace RemoveThingFromThingGroupRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: RemoveThingFromThingGroupRequest): any => ({ ...obj, }); @@ -170,6 +188,9 @@ export namespace RemoveThingFromThingGroupRequest { export interface RemoveThingFromThingGroupResponse {} export namespace RemoveThingFromThingGroupResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: RemoveThingFromThingGroupResponse): any => ({ ...obj, }); @@ -191,6 +212,9 @@ export interface ReplaceTopicRuleRequest { } export namespace ReplaceTopicRuleRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ReplaceTopicRuleRequest): any => ({ ...obj, }); @@ -225,6 +249,9 @@ export interface SearchIndexRequest { } export namespace SearchIndexRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: SearchIndexRequest): any => ({ ...obj, }); @@ -261,6 +288,9 @@ export interface ThingGroupDocument { } export namespace ThingGroupDocument { + /** + * @internal + */ export const filterSensitiveLog = (obj: ThingGroupDocument): any => ({ ...obj, }); @@ -284,6 +314,9 @@ export interface ThingConnectivity { } export namespace ThingConnectivity { + /** + * @internal + */ export const filterSensitiveLog = (obj: ThingConnectivity): any => ({ ...obj, }); @@ -330,6 +363,9 @@ export interface ThingDocument { } export namespace ThingDocument { + /** + * @internal + */ export const filterSensitiveLog = (obj: ThingDocument): any => ({ ...obj, }); @@ -354,6 +390,9 @@ export interface SearchIndexResponse { } export namespace SearchIndexResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: SearchIndexResponse): any => ({ ...obj, }); @@ -367,6 +406,9 @@ export interface SetDefaultAuthorizerRequest { } export namespace SetDefaultAuthorizerRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: SetDefaultAuthorizerRequest): any => ({ ...obj, }); @@ -385,6 +427,9 @@ export interface SetDefaultAuthorizerResponse { } export namespace SetDefaultAuthorizerResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: SetDefaultAuthorizerResponse): any => ({ ...obj, }); @@ -406,6 +451,9 @@ export interface SetDefaultPolicyVersionRequest { } export namespace SetDefaultPolicyVersionRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: SetDefaultPolicyVersionRequest): any => ({ ...obj, }); @@ -427,6 +475,9 @@ export interface LoggingOptionsPayload { } export namespace LoggingOptionsPayload { + /** + * @internal + */ export const filterSensitiveLog = (obj: LoggingOptionsPayload): any => ({ ...obj, }); @@ -443,6 +494,9 @@ export interface SetLoggingOptionsRequest { } export namespace SetLoggingOptionsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: SetLoggingOptionsRequest): any => ({ ...obj, }); @@ -461,6 +515,9 @@ export interface SetV2LoggingLevelRequest { } export namespace SetV2LoggingLevelRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: SetV2LoggingLevelRequest): any => ({ ...obj, }); @@ -484,6 +541,9 @@ export interface SetV2LoggingOptionsRequest { } export namespace SetV2LoggingOptionsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: SetV2LoggingOptionsRequest): any => ({ ...obj, }); @@ -515,6 +575,9 @@ export interface StartAuditMitigationActionsTaskRequest { } export namespace StartAuditMitigationActionsTaskRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: StartAuditMitigationActionsTaskRequest): any => ({ ...obj, }); @@ -528,6 +591,9 @@ export interface StartAuditMitigationActionsTaskResponse { } export namespace StartAuditMitigationActionsTaskResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: StartAuditMitigationActionsTaskResponse): any => ({ ...obj, }); @@ -545,6 +611,9 @@ export interface TaskAlreadyExistsException extends __SmithyException, $Metadata } export namespace TaskAlreadyExistsException { + /** + * @internal + */ export const filterSensitiveLog = (obj: TaskAlreadyExistsException): any => ({ ...obj, }); @@ -602,6 +671,9 @@ export interface StartDetectMitigationActionsTaskRequest { } export namespace StartDetectMitigationActionsTaskRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: StartDetectMitigationActionsTaskRequest): any => ({ ...obj, }); @@ -617,6 +689,9 @@ export interface StartDetectMitigationActionsTaskResponse { } export namespace StartDetectMitigationActionsTaskResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: StartDetectMitigationActionsTaskResponse): any => ({ ...obj, }); @@ -633,6 +708,9 @@ export interface StartOnDemandAuditTaskRequest { } export namespace StartOnDemandAuditTaskRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: StartOnDemandAuditTaskRequest): any => ({ ...obj, }); @@ -646,6 +724,9 @@ export interface StartOnDemandAuditTaskResponse { } export namespace StartOnDemandAuditTaskResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: StartOnDemandAuditTaskResponse): any => ({ ...obj, }); @@ -676,6 +757,9 @@ export interface StartThingRegistrationTaskRequest { } export namespace StartThingRegistrationTaskRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: StartThingRegistrationTaskRequest): any => ({ ...obj, }); @@ -689,6 +773,9 @@ export interface StartThingRegistrationTaskResponse { } export namespace StartThingRegistrationTaskResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: StartThingRegistrationTaskResponse): any => ({ ...obj, }); @@ -702,6 +789,9 @@ export interface StopThingRegistrationTaskRequest { } export namespace StopThingRegistrationTaskRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: StopThingRegistrationTaskRequest): any => ({ ...obj, }); @@ -710,6 +800,9 @@ export namespace StopThingRegistrationTaskRequest { export interface StopThingRegistrationTaskResponse {} export namespace StopThingRegistrationTaskResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: StopThingRegistrationTaskResponse): any => ({ ...obj, }); @@ -728,6 +821,9 @@ export interface TagResourceRequest { } export namespace TagResourceRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: TagResourceRequest): any => ({ ...obj, }); @@ -736,6 +832,9 @@ export namespace TagResourceRequest { export interface TagResourceResponse {} export namespace TagResourceResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: TagResourceResponse): any => ({ ...obj, }); @@ -777,6 +876,9 @@ export interface TestAuthorizationRequest { } export namespace TestAuthorizationRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: TestAuthorizationRequest): any => ({ ...obj, }); @@ -790,6 +892,9 @@ export interface TestAuthorizationResponse { } export namespace TestAuthorizationResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: TestAuthorizationResponse): any => ({ ...obj, }); @@ -808,6 +913,9 @@ export interface InvalidResponseException extends __SmithyException, $MetadataBe } export namespace InvalidResponseException { + /** + * @internal + */ export const filterSensitiveLog = (obj: InvalidResponseException): any => ({ ...obj, }); @@ -829,6 +937,9 @@ export interface HttpContext { } export namespace HttpContext { + /** + * @internal + */ export const filterSensitiveLog = (obj: HttpContext): any => ({ ...obj, }); @@ -855,6 +966,9 @@ export interface MqttContext { } export namespace MqttContext { + /** + * @internal + */ export const filterSensitiveLog = (obj: MqttContext): any => ({ ...obj, }); @@ -871,6 +985,9 @@ export interface TlsContext { } export namespace TlsContext { + /** + * @internal + */ export const filterSensitiveLog = (obj: TlsContext): any => ({ ...obj, }); @@ -910,6 +1027,9 @@ export interface TestInvokeAuthorizerRequest { } export namespace TestInvokeAuthorizerRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: TestInvokeAuthorizerRequest): any => ({ ...obj, }); @@ -943,6 +1063,9 @@ export interface TestInvokeAuthorizerResponse { } export namespace TestInvokeAuthorizerResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: TestInvokeAuthorizerResponse): any => ({ ...obj, }); @@ -970,6 +1093,9 @@ export interface TransferCertificateRequest { } export namespace TransferCertificateRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: TransferCertificateRequest): any => ({ ...obj, }); @@ -986,6 +1112,9 @@ export interface TransferCertificateResponse { } export namespace TransferCertificateResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: TransferCertificateResponse): any => ({ ...obj, }); @@ -1005,6 +1134,9 @@ export interface TransferConflictException extends __SmithyException, $MetadataB } export namespace TransferConflictException { + /** + * @internal + */ export const filterSensitiveLog = (obj: TransferConflictException): any => ({ ...obj, }); @@ -1023,6 +1155,9 @@ export interface UntagResourceRequest { } export namespace UntagResourceRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: UntagResourceRequest): any => ({ ...obj, }); @@ -1031,6 +1166,9 @@ export namespace UntagResourceRequest { export interface UntagResourceResponse {} export namespace UntagResourceResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: UntagResourceResponse): any => ({ ...obj, }); @@ -1073,6 +1211,9 @@ export interface UpdateAccountAuditConfigurationRequest { } export namespace UpdateAccountAuditConfigurationRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateAccountAuditConfigurationRequest): any => ({ ...obj, }); @@ -1081,6 +1222,9 @@ export namespace UpdateAccountAuditConfigurationRequest { export interface UpdateAccountAuditConfigurationResponse {} export namespace UpdateAccountAuditConfigurationResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateAccountAuditConfigurationResponse): any => ({ ...obj, }); @@ -1123,6 +1267,9 @@ export interface UpdateAuditSuppressionRequest { } export namespace UpdateAuditSuppressionRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateAuditSuppressionRequest): any => ({ ...obj, }); @@ -1131,6 +1278,9 @@ export namespace UpdateAuditSuppressionRequest { export interface UpdateAuditSuppressionResponse {} export namespace UpdateAuditSuppressionResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateAuditSuppressionResponse): any => ({ ...obj, }); @@ -1164,6 +1314,9 @@ export interface UpdateAuthorizerRequest { } export namespace UpdateAuthorizerRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateAuthorizerRequest): any => ({ ...obj, }); @@ -1182,6 +1335,9 @@ export interface UpdateAuthorizerResponse { } export namespace UpdateAuthorizerResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateAuthorizerResponse): any => ({ ...obj, }); @@ -1208,6 +1364,9 @@ export interface UpdateBillingGroupRequest { } export namespace UpdateBillingGroupRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateBillingGroupRequest): any => ({ ...obj, }); @@ -1221,6 +1380,9 @@ export interface UpdateBillingGroupResponse { } export namespace UpdateBillingGroupResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateBillingGroupResponse): any => ({ ...obj, }); @@ -1261,6 +1423,9 @@ export interface UpdateCACertificateRequest { } export namespace UpdateCACertificateRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateCACertificateRequest): any => ({ ...obj, }); @@ -1290,6 +1455,9 @@ export interface UpdateCertificateRequest { } export namespace UpdateCertificateRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateCertificateRequest): any => ({ ...obj, }); @@ -1316,6 +1484,9 @@ export interface UpdateCustomMetricRequest { } export namespace UpdateCustomMetricRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateCustomMetricRequest): any => ({ ...obj, }); @@ -1366,6 +1537,9 @@ export interface UpdateCustomMetricResponse { } export namespace UpdateCustomMetricResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateCustomMetricResponse): any => ({ ...obj, }); @@ -1384,6 +1558,9 @@ export interface UpdateDimensionRequest { } export namespace UpdateDimensionRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateDimensionRequest): any => ({ ...obj, }); @@ -1424,6 +1601,9 @@ export interface UpdateDimensionResponse { } export namespace UpdateDimensionResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateDimensionResponse): any => ({ ...obj, }); @@ -1452,6 +1632,9 @@ export interface UpdateDomainConfigurationRequest { } export namespace UpdateDomainConfigurationRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateDomainConfigurationRequest): any => ({ ...obj, }); @@ -1470,6 +1653,9 @@ export interface UpdateDomainConfigurationResponse { } export namespace UpdateDomainConfigurationResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateDomainConfigurationResponse): any => ({ ...obj, }); @@ -1515,6 +1701,9 @@ export interface UpdateDynamicThingGroupRequest { } export namespace UpdateDynamicThingGroupRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateDynamicThingGroupRequest): any => ({ ...obj, }); @@ -1528,6 +1717,9 @@ export interface UpdateDynamicThingGroupResponse { } export namespace UpdateDynamicThingGroupResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateDynamicThingGroupResponse): any => ({ ...obj, }); @@ -1541,6 +1733,9 @@ export interface UpdateEventConfigurationsRequest { } export namespace UpdateEventConfigurationsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateEventConfigurationsRequest): any => ({ ...obj, }); @@ -1549,6 +1744,9 @@ export namespace UpdateEventConfigurationsRequest { export interface UpdateEventConfigurationsResponse {} export namespace UpdateEventConfigurationsResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateEventConfigurationsResponse): any => ({ ...obj, }); @@ -1567,6 +1765,9 @@ export interface UpdateIndexingConfigurationRequest { } export namespace UpdateIndexingConfigurationRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateIndexingConfigurationRequest): any => ({ ...obj, }); @@ -1575,6 +1776,9 @@ export namespace UpdateIndexingConfigurationRequest { export interface UpdateIndexingConfigurationResponse {} export namespace UpdateIndexingConfigurationResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateIndexingConfigurationResponse): any => ({ ...obj, }); @@ -1627,6 +1831,9 @@ export interface UpdateJobRequest { } export namespace UpdateJobRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateJobRequest): any => ({ ...obj, }); @@ -1653,6 +1860,9 @@ export interface UpdateMitigationActionRequest { } export namespace UpdateMitigationActionRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateMitigationActionRequest): any => ({ ...obj, }); @@ -1671,6 +1881,9 @@ export interface UpdateMitigationActionResponse { } export namespace UpdateMitigationActionResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateMitigationActionResponse): any => ({ ...obj, }); @@ -1715,6 +1928,9 @@ export interface UpdateProvisioningTemplateRequest { } export namespace UpdateProvisioningTemplateRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateProvisioningTemplateRequest): any => ({ ...obj, }); @@ -1723,6 +1939,9 @@ export namespace UpdateProvisioningTemplateRequest { export interface UpdateProvisioningTemplateResponse {} export namespace UpdateProvisioningTemplateResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateProvisioningTemplateResponse): any => ({ ...obj, }); @@ -1746,6 +1965,9 @@ export interface UpdateRoleAliasRequest { } export namespace UpdateRoleAliasRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateRoleAliasRequest): any => ({ ...obj, }); @@ -1764,6 +1986,9 @@ export interface UpdateRoleAliasResponse { } export namespace UpdateRoleAliasResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateRoleAliasResponse): any => ({ ...obj, }); @@ -1813,6 +2038,9 @@ export interface UpdateScheduledAuditRequest { } export namespace UpdateScheduledAuditRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateScheduledAuditRequest): any => ({ ...obj, }); @@ -1826,6 +2054,9 @@ export interface UpdateScheduledAuditResponse { } export namespace UpdateScheduledAuditResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateScheduledAuditResponse): any => ({ ...obj, }); @@ -1901,6 +2132,9 @@ export interface UpdateSecurityProfileRequest { } export namespace UpdateSecurityProfileRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateSecurityProfileRequest): any => ({ ...obj, }); @@ -1970,6 +2204,9 @@ export interface UpdateSecurityProfileResponse { } export namespace UpdateSecurityProfileResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateSecurityProfileResponse): any => ({ ...obj, }); @@ -1998,6 +2235,9 @@ export interface UpdateStreamRequest { } export namespace UpdateStreamRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateStreamRequest): any => ({ ...obj, }); @@ -2026,6 +2266,9 @@ export interface UpdateStreamResponse { } export namespace UpdateStreamResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateStreamResponse): any => ({ ...obj, }); @@ -2073,6 +2316,9 @@ export interface UpdateThingRequest { } export namespace UpdateThingRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateThingRequest): any => ({ ...obj, }); @@ -2084,6 +2330,9 @@ export namespace UpdateThingRequest { export interface UpdateThingResponse {} export namespace UpdateThingResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateThingResponse): any => ({ ...obj, }); @@ -2108,6 +2357,9 @@ export interface UpdateThingGroupRequest { } export namespace UpdateThingGroupRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateThingGroupRequest): any => ({ ...obj, }); @@ -2121,6 +2373,9 @@ export interface UpdateThingGroupResponse { } export namespace UpdateThingGroupResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateThingGroupResponse): any => ({ ...obj, }); @@ -2152,6 +2407,9 @@ export interface UpdateThingGroupsForThingRequest { } export namespace UpdateThingGroupsForThingRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateThingGroupsForThingRequest): any => ({ ...obj, }); @@ -2160,6 +2418,9 @@ export namespace UpdateThingGroupsForThingRequest { export interface UpdateThingGroupsForThingResponse {} export namespace UpdateThingGroupsForThingResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateThingGroupsForThingResponse): any => ({ ...obj, }); @@ -2209,6 +2470,9 @@ export interface UpdateTopicRuleDestinationRequest { } export namespace UpdateTopicRuleDestinationRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateTopicRuleDestinationRequest): any => ({ ...obj, }); @@ -2217,6 +2481,9 @@ export namespace UpdateTopicRuleDestinationRequest { export interface UpdateTopicRuleDestinationResponse {} export namespace UpdateTopicRuleDestinationResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateTopicRuleDestinationResponse): any => ({ ...obj, }); @@ -2230,6 +2497,9 @@ export interface ValidateSecurityProfileBehaviorsRequest { } export namespace ValidateSecurityProfileBehaviorsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ValidateSecurityProfileBehaviorsRequest): any => ({ ...obj, }); @@ -2246,6 +2516,9 @@ export interface ValidationError { } export namespace ValidationError { + /** + * @internal + */ export const filterSensitiveLog = (obj: ValidationError): any => ({ ...obj, }); @@ -2264,6 +2537,9 @@ export interface ValidateSecurityProfileBehaviorsResponse { } export namespace ValidateSecurityProfileBehaviorsResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ValidateSecurityProfileBehaviorsResponse): any => ({ ...obj, }); diff --git a/clients/client-iotanalytics/commands/BatchPutMessageCommand.ts b/clients/client-iotanalytics/commands/BatchPutMessageCommand.ts index 26b3348718e3..20e8c9be7e67 100644 --- a/clients/client-iotanalytics/commands/BatchPutMessageCommand.ts +++ b/clients/client-iotanalytics/commands/BatchPutMessageCommand.ts @@ -22,6 +22,20 @@ export interface BatchPutMessageCommandOutput extends BatchPutMessageResponse, _ /** *

Sends messages to a channel.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { IoTAnalyticsClient, BatchPutMessageCommand } from "@aws-sdk/client-iotanalytics"; // ES Modules import + * // const { IoTAnalyticsClient, BatchPutMessageCommand } = require("@aws-sdk/client-iotanalytics"); // CommonJS import + * const client = new IoTAnalyticsClient(config); + * const command = new BatchPutMessageCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link BatchPutMessageCommandInput} for command's `input` shape. + * @see {@link BatchPutMessageCommandOutput} for command's `response` shape. + * @see {@link IoTAnalyticsClientResolvedConfig | config} for command's `input` shape. + * */ export class BatchPutMessageCommand extends $Command< BatchPutMessageCommandInput, diff --git a/clients/client-iotanalytics/commands/CancelPipelineReprocessingCommand.ts b/clients/client-iotanalytics/commands/CancelPipelineReprocessingCommand.ts index 6466a6477788..0d577aa7496b 100644 --- a/clients/client-iotanalytics/commands/CancelPipelineReprocessingCommand.ts +++ b/clients/client-iotanalytics/commands/CancelPipelineReprocessingCommand.ts @@ -22,6 +22,20 @@ export interface CancelPipelineReprocessingCommandOutput extends CancelPipelineR /** *

Cancels the reprocessing of data through the pipeline.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { IoTAnalyticsClient, CancelPipelineReprocessingCommand } from "@aws-sdk/client-iotanalytics"; // ES Modules import + * // const { IoTAnalyticsClient, CancelPipelineReprocessingCommand } = require("@aws-sdk/client-iotanalytics"); // CommonJS import + * const client = new IoTAnalyticsClient(config); + * const command = new CancelPipelineReprocessingCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CancelPipelineReprocessingCommandInput} for command's `input` shape. + * @see {@link CancelPipelineReprocessingCommandOutput} for command's `response` shape. + * @see {@link IoTAnalyticsClientResolvedConfig | config} for command's `input` shape. + * */ export class CancelPipelineReprocessingCommand extends $Command< CancelPipelineReprocessingCommandInput, diff --git a/clients/client-iotanalytics/commands/CreateChannelCommand.ts b/clients/client-iotanalytics/commands/CreateChannelCommand.ts index 5daed1cb655b..2f50bbf64567 100644 --- a/clients/client-iotanalytics/commands/CreateChannelCommand.ts +++ b/clients/client-iotanalytics/commands/CreateChannelCommand.ts @@ -23,6 +23,20 @@ export interface CreateChannelCommandOutput extends CreateChannelResponse, __Met /** *

Creates a channel. A channel collects data from an MQTT topic and archives the raw, * unprocessed messages before publishing the data to a pipeline.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { IoTAnalyticsClient, CreateChannelCommand } from "@aws-sdk/client-iotanalytics"; // ES Modules import + * // const { IoTAnalyticsClient, CreateChannelCommand } = require("@aws-sdk/client-iotanalytics"); // CommonJS import + * const client = new IoTAnalyticsClient(config); + * const command = new CreateChannelCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreateChannelCommandInput} for command's `input` shape. + * @see {@link CreateChannelCommandOutput} for command's `response` shape. + * @see {@link IoTAnalyticsClientResolvedConfig | config} for command's `input` shape. + * */ export class CreateChannelCommand extends $Command< CreateChannelCommandInput, diff --git a/clients/client-iotanalytics/commands/CreateDatasetCommand.ts b/clients/client-iotanalytics/commands/CreateDatasetCommand.ts index b6b166a52510..bf67b1e8fd6a 100644 --- a/clients/client-iotanalytics/commands/CreateDatasetCommand.ts +++ b/clients/client-iotanalytics/commands/CreateDatasetCommand.ts @@ -26,6 +26,20 @@ export interface CreateDatasetCommandOutput extends CreateDatasetResponse, __Met * 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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { IoTAnalyticsClient, CreateDatasetCommand } from "@aws-sdk/client-iotanalytics"; // ES Modules import + * // const { IoTAnalyticsClient, CreateDatasetCommand } = require("@aws-sdk/client-iotanalytics"); // CommonJS import + * const client = new IoTAnalyticsClient(config); + * const command = new CreateDatasetCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreateDatasetCommandInput} for command's `input` shape. + * @see {@link CreateDatasetCommandOutput} for command's `response` shape. + * @see {@link IoTAnalyticsClientResolvedConfig | config} for command's `input` shape. + * */ export class CreateDatasetCommand extends $Command< CreateDatasetCommandInput, diff --git a/clients/client-iotanalytics/commands/CreateDatasetContentCommand.ts b/clients/client-iotanalytics/commands/CreateDatasetContentCommand.ts index da0d8cdc4482..ea1bc6316f74 100644 --- a/clients/client-iotanalytics/commands/CreateDatasetContentCommand.ts +++ b/clients/client-iotanalytics/commands/CreateDatasetContentCommand.ts @@ -23,6 +23,20 @@ export interface CreateDatasetContentCommandOutput extends CreateDatasetContentR /** *

Creates the content of a data set by applying a queryAction (a SQL query) or * a containerAction (executing a containerized application).

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { IoTAnalyticsClient, CreateDatasetContentCommand } from "@aws-sdk/client-iotanalytics"; // ES Modules import + * // const { IoTAnalyticsClient, CreateDatasetContentCommand } = require("@aws-sdk/client-iotanalytics"); // CommonJS import + * const client = new IoTAnalyticsClient(config); + * const command = new CreateDatasetContentCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreateDatasetContentCommandInput} for command's `input` shape. + * @see {@link CreateDatasetContentCommandOutput} for command's `response` shape. + * @see {@link IoTAnalyticsClientResolvedConfig | config} for command's `input` shape. + * */ export class CreateDatasetContentCommand extends $Command< CreateDatasetContentCommandInput, diff --git a/clients/client-iotanalytics/commands/CreateDatastoreCommand.ts b/clients/client-iotanalytics/commands/CreateDatastoreCommand.ts index 30579ff81c90..8f59c2c5d107 100644 --- a/clients/client-iotanalytics/commands/CreateDatastoreCommand.ts +++ b/clients/client-iotanalytics/commands/CreateDatastoreCommand.ts @@ -22,6 +22,20 @@ export interface CreateDatastoreCommandOutput extends CreateDatastoreResponse, _ /** *

Creates a data store, which is a repository for messages.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { IoTAnalyticsClient, CreateDatastoreCommand } from "@aws-sdk/client-iotanalytics"; // ES Modules import + * // const { IoTAnalyticsClient, CreateDatastoreCommand } = require("@aws-sdk/client-iotanalytics"); // CommonJS import + * const client = new IoTAnalyticsClient(config); + * const command = new CreateDatastoreCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreateDatastoreCommandInput} for command's `input` shape. + * @see {@link CreateDatastoreCommandOutput} for command's `response` shape. + * @see {@link IoTAnalyticsClientResolvedConfig | config} for command's `input` shape. + * */ export class CreateDatastoreCommand extends $Command< CreateDatastoreCommandInput, diff --git a/clients/client-iotanalytics/commands/CreatePipelineCommand.ts b/clients/client-iotanalytics/commands/CreatePipelineCommand.ts index 8bcc901f6e49..9cb7b73701de 100644 --- a/clients/client-iotanalytics/commands/CreatePipelineCommand.ts +++ b/clients/client-iotanalytics/commands/CreatePipelineCommand.ts @@ -25,6 +25,20 @@ export interface CreatePipelineCommandOutput extends CreatePipelineResponse, __M * 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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { IoTAnalyticsClient, CreatePipelineCommand } from "@aws-sdk/client-iotanalytics"; // ES Modules import + * // const { IoTAnalyticsClient, CreatePipelineCommand } = require("@aws-sdk/client-iotanalytics"); // CommonJS import + * const client = new IoTAnalyticsClient(config); + * const command = new CreatePipelineCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreatePipelineCommandInput} for command's `input` shape. + * @see {@link CreatePipelineCommandOutput} for command's `response` shape. + * @see {@link IoTAnalyticsClientResolvedConfig | config} for command's `input` shape. + * */ export class CreatePipelineCommand extends $Command< CreatePipelineCommandInput, diff --git a/clients/client-iotanalytics/commands/DeleteChannelCommand.ts b/clients/client-iotanalytics/commands/DeleteChannelCommand.ts index 72b55f4c0d1c..7012319b8c78 100644 --- a/clients/client-iotanalytics/commands/DeleteChannelCommand.ts +++ b/clients/client-iotanalytics/commands/DeleteChannelCommand.ts @@ -22,6 +22,20 @@ export interface DeleteChannelCommandOutput extends __MetadataBearer {} /** *

Deletes the specified channel.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { IoTAnalyticsClient, DeleteChannelCommand } from "@aws-sdk/client-iotanalytics"; // ES Modules import + * // const { IoTAnalyticsClient, DeleteChannelCommand } = require("@aws-sdk/client-iotanalytics"); // CommonJS import + * const client = new IoTAnalyticsClient(config); + * const command = new DeleteChannelCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteChannelCommandInput} for command's `input` shape. + * @see {@link DeleteChannelCommandOutput} for command's `response` shape. + * @see {@link IoTAnalyticsClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteChannelCommand extends $Command< DeleteChannelCommandInput, diff --git a/clients/client-iotanalytics/commands/DeleteDatasetCommand.ts b/clients/client-iotanalytics/commands/DeleteDatasetCommand.ts index 1bafa828d1c8..eed18c5dc5b5 100644 --- a/clients/client-iotanalytics/commands/DeleteDatasetCommand.ts +++ b/clients/client-iotanalytics/commands/DeleteDatasetCommand.ts @@ -24,6 +24,20 @@ export interface DeleteDatasetCommandOutput extends __MetadataBearer {} *

Deletes the specified dataset.

*

You do not have to delete the content of the dataset before you perform this * operation.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { IoTAnalyticsClient, DeleteDatasetCommand } from "@aws-sdk/client-iotanalytics"; // ES Modules import + * // const { IoTAnalyticsClient, DeleteDatasetCommand } = require("@aws-sdk/client-iotanalytics"); // CommonJS import + * const client = new IoTAnalyticsClient(config); + * const command = new DeleteDatasetCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteDatasetCommandInput} for command's `input` shape. + * @see {@link DeleteDatasetCommandOutput} for command's `response` shape. + * @see {@link IoTAnalyticsClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteDatasetCommand extends $Command< DeleteDatasetCommandInput, diff --git a/clients/client-iotanalytics/commands/DeleteDatasetContentCommand.ts b/clients/client-iotanalytics/commands/DeleteDatasetContentCommand.ts index 1bba288e689b..05a6703598c8 100644 --- a/clients/client-iotanalytics/commands/DeleteDatasetContentCommand.ts +++ b/clients/client-iotanalytics/commands/DeleteDatasetContentCommand.ts @@ -22,6 +22,20 @@ export interface DeleteDatasetContentCommandOutput extends __MetadataBearer {} /** *

Deletes the content of the specified dataset.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { IoTAnalyticsClient, DeleteDatasetContentCommand } from "@aws-sdk/client-iotanalytics"; // ES Modules import + * // const { IoTAnalyticsClient, DeleteDatasetContentCommand } = require("@aws-sdk/client-iotanalytics"); // CommonJS import + * const client = new IoTAnalyticsClient(config); + * const command = new DeleteDatasetContentCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteDatasetContentCommandInput} for command's `input` shape. + * @see {@link DeleteDatasetContentCommandOutput} for command's `response` shape. + * @see {@link IoTAnalyticsClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteDatasetContentCommand extends $Command< DeleteDatasetContentCommandInput, diff --git a/clients/client-iotanalytics/commands/DeleteDatastoreCommand.ts b/clients/client-iotanalytics/commands/DeleteDatastoreCommand.ts index a9992f0adaf5..6e8ec1be7047 100644 --- a/clients/client-iotanalytics/commands/DeleteDatastoreCommand.ts +++ b/clients/client-iotanalytics/commands/DeleteDatastoreCommand.ts @@ -22,6 +22,20 @@ export interface DeleteDatastoreCommandOutput extends __MetadataBearer {} /** *

Deletes the specified data store.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { IoTAnalyticsClient, DeleteDatastoreCommand } from "@aws-sdk/client-iotanalytics"; // ES Modules import + * // const { IoTAnalyticsClient, DeleteDatastoreCommand } = require("@aws-sdk/client-iotanalytics"); // CommonJS import + * const client = new IoTAnalyticsClient(config); + * const command = new DeleteDatastoreCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteDatastoreCommandInput} for command's `input` shape. + * @see {@link DeleteDatastoreCommandOutput} for command's `response` shape. + * @see {@link IoTAnalyticsClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteDatastoreCommand extends $Command< DeleteDatastoreCommandInput, diff --git a/clients/client-iotanalytics/commands/DeletePipelineCommand.ts b/clients/client-iotanalytics/commands/DeletePipelineCommand.ts index bc6ecf825d92..e26f6d827984 100644 --- a/clients/client-iotanalytics/commands/DeletePipelineCommand.ts +++ b/clients/client-iotanalytics/commands/DeletePipelineCommand.ts @@ -22,6 +22,20 @@ export interface DeletePipelineCommandOutput extends __MetadataBearer {} /** *

Deletes the specified pipeline.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { IoTAnalyticsClient, DeletePipelineCommand } from "@aws-sdk/client-iotanalytics"; // ES Modules import + * // const { IoTAnalyticsClient, DeletePipelineCommand } = require("@aws-sdk/client-iotanalytics"); // CommonJS import + * const client = new IoTAnalyticsClient(config); + * const command = new DeletePipelineCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeletePipelineCommandInput} for command's `input` shape. + * @see {@link DeletePipelineCommandOutput} for command's `response` shape. + * @see {@link IoTAnalyticsClientResolvedConfig | config} for command's `input` shape. + * */ export class DeletePipelineCommand extends $Command< DeletePipelineCommandInput, diff --git a/clients/client-iotanalytics/commands/DescribeChannelCommand.ts b/clients/client-iotanalytics/commands/DescribeChannelCommand.ts index 2670a41f6125..fb02791cd2a6 100644 --- a/clients/client-iotanalytics/commands/DescribeChannelCommand.ts +++ b/clients/client-iotanalytics/commands/DescribeChannelCommand.ts @@ -22,6 +22,20 @@ export interface DescribeChannelCommandOutput extends DescribeChannelResponse, _ /** *

Retrieves information about a channel.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { IoTAnalyticsClient, DescribeChannelCommand } from "@aws-sdk/client-iotanalytics"; // ES Modules import + * // const { IoTAnalyticsClient, DescribeChannelCommand } = require("@aws-sdk/client-iotanalytics"); // CommonJS import + * const client = new IoTAnalyticsClient(config); + * const command = new DescribeChannelCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeChannelCommandInput} for command's `input` shape. + * @see {@link DescribeChannelCommandOutput} for command's `response` shape. + * @see {@link IoTAnalyticsClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeChannelCommand extends $Command< DescribeChannelCommandInput, diff --git a/clients/client-iotanalytics/commands/DescribeDatasetCommand.ts b/clients/client-iotanalytics/commands/DescribeDatasetCommand.ts index 2e422046706f..89c5eb7b4e87 100644 --- a/clients/client-iotanalytics/commands/DescribeDatasetCommand.ts +++ b/clients/client-iotanalytics/commands/DescribeDatasetCommand.ts @@ -22,6 +22,20 @@ export interface DescribeDatasetCommandOutput extends DescribeDatasetResponse, _ /** *

Retrieves information about a dataset.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { IoTAnalyticsClient, DescribeDatasetCommand } from "@aws-sdk/client-iotanalytics"; // ES Modules import + * // const { IoTAnalyticsClient, DescribeDatasetCommand } = require("@aws-sdk/client-iotanalytics"); // CommonJS import + * const client = new IoTAnalyticsClient(config); + * const command = new DescribeDatasetCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeDatasetCommandInput} for command's `input` shape. + * @see {@link DescribeDatasetCommandOutput} for command's `response` shape. + * @see {@link IoTAnalyticsClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeDatasetCommand extends $Command< DescribeDatasetCommandInput, diff --git a/clients/client-iotanalytics/commands/DescribeDatastoreCommand.ts b/clients/client-iotanalytics/commands/DescribeDatastoreCommand.ts index f94b72f4d106..ea36b55fc3ed 100644 --- a/clients/client-iotanalytics/commands/DescribeDatastoreCommand.ts +++ b/clients/client-iotanalytics/commands/DescribeDatastoreCommand.ts @@ -22,6 +22,20 @@ export interface DescribeDatastoreCommandOutput extends DescribeDatastoreRespons /** *

Retrieves information about a data store.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { IoTAnalyticsClient, DescribeDatastoreCommand } from "@aws-sdk/client-iotanalytics"; // ES Modules import + * // const { IoTAnalyticsClient, DescribeDatastoreCommand } = require("@aws-sdk/client-iotanalytics"); // CommonJS import + * const client = new IoTAnalyticsClient(config); + * const command = new DescribeDatastoreCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeDatastoreCommandInput} for command's `input` shape. + * @see {@link DescribeDatastoreCommandOutput} for command's `response` shape. + * @see {@link IoTAnalyticsClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeDatastoreCommand extends $Command< DescribeDatastoreCommandInput, diff --git a/clients/client-iotanalytics/commands/DescribeLoggingOptionsCommand.ts b/clients/client-iotanalytics/commands/DescribeLoggingOptionsCommand.ts index 107a7947f05e..dc833ea27c2f 100644 --- a/clients/client-iotanalytics/commands/DescribeLoggingOptionsCommand.ts +++ b/clients/client-iotanalytics/commands/DescribeLoggingOptionsCommand.ts @@ -22,6 +22,20 @@ export interface DescribeLoggingOptionsCommandOutput extends DescribeLoggingOpti /** *

Retrieves the current settings of the AWS IoT Analytics logging options.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { IoTAnalyticsClient, DescribeLoggingOptionsCommand } from "@aws-sdk/client-iotanalytics"; // ES Modules import + * // const { IoTAnalyticsClient, DescribeLoggingOptionsCommand } = require("@aws-sdk/client-iotanalytics"); // CommonJS import + * const client = new IoTAnalyticsClient(config); + * const command = new DescribeLoggingOptionsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeLoggingOptionsCommandInput} for command's `input` shape. + * @see {@link DescribeLoggingOptionsCommandOutput} for command's `response` shape. + * @see {@link IoTAnalyticsClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeLoggingOptionsCommand extends $Command< DescribeLoggingOptionsCommandInput, diff --git a/clients/client-iotanalytics/commands/DescribePipelineCommand.ts b/clients/client-iotanalytics/commands/DescribePipelineCommand.ts index 1eefbce9acf2..33931b55007b 100644 --- a/clients/client-iotanalytics/commands/DescribePipelineCommand.ts +++ b/clients/client-iotanalytics/commands/DescribePipelineCommand.ts @@ -22,6 +22,20 @@ export interface DescribePipelineCommandOutput extends DescribePipelineResponse, /** *

Retrieves information about a pipeline.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { IoTAnalyticsClient, DescribePipelineCommand } from "@aws-sdk/client-iotanalytics"; // ES Modules import + * // const { IoTAnalyticsClient, DescribePipelineCommand } = require("@aws-sdk/client-iotanalytics"); // CommonJS import + * const client = new IoTAnalyticsClient(config); + * const command = new DescribePipelineCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribePipelineCommandInput} for command's `input` shape. + * @see {@link DescribePipelineCommandOutput} for command's `response` shape. + * @see {@link IoTAnalyticsClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribePipelineCommand extends $Command< DescribePipelineCommandInput, diff --git a/clients/client-iotanalytics/commands/GetDatasetContentCommand.ts b/clients/client-iotanalytics/commands/GetDatasetContentCommand.ts index 099f2d3b3683..48066c55e799 100644 --- a/clients/client-iotanalytics/commands/GetDatasetContentCommand.ts +++ b/clients/client-iotanalytics/commands/GetDatasetContentCommand.ts @@ -22,6 +22,20 @@ export interface GetDatasetContentCommandOutput extends GetDatasetContentRespons /** *

Retrieves the contents of a data set as presigned URIs.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { IoTAnalyticsClient, GetDatasetContentCommand } from "@aws-sdk/client-iotanalytics"; // ES Modules import + * // const { IoTAnalyticsClient, GetDatasetContentCommand } = require("@aws-sdk/client-iotanalytics"); // CommonJS import + * const client = new IoTAnalyticsClient(config); + * const command = new GetDatasetContentCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetDatasetContentCommandInput} for command's `input` shape. + * @see {@link GetDatasetContentCommandOutput} for command's `response` shape. + * @see {@link IoTAnalyticsClientResolvedConfig | config} for command's `input` shape. + * */ export class GetDatasetContentCommand extends $Command< GetDatasetContentCommandInput, diff --git a/clients/client-iotanalytics/commands/ListChannelsCommand.ts b/clients/client-iotanalytics/commands/ListChannelsCommand.ts index 7adbec644e01..7793b656654d 100644 --- a/clients/client-iotanalytics/commands/ListChannelsCommand.ts +++ b/clients/client-iotanalytics/commands/ListChannelsCommand.ts @@ -22,6 +22,20 @@ export interface ListChannelsCommandOutput extends ListChannelsResponse, __Metad /** *

Retrieves a list of channels.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { IoTAnalyticsClient, ListChannelsCommand } from "@aws-sdk/client-iotanalytics"; // ES Modules import + * // const { IoTAnalyticsClient, ListChannelsCommand } = require("@aws-sdk/client-iotanalytics"); // CommonJS import + * const client = new IoTAnalyticsClient(config); + * const command = new ListChannelsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListChannelsCommandInput} for command's `input` shape. + * @see {@link ListChannelsCommandOutput} for command's `response` shape. + * @see {@link IoTAnalyticsClientResolvedConfig | config} for command's `input` shape. + * */ export class ListChannelsCommand extends $Command< ListChannelsCommandInput, diff --git a/clients/client-iotanalytics/commands/ListDatasetContentsCommand.ts b/clients/client-iotanalytics/commands/ListDatasetContentsCommand.ts index a8c15e830f0c..35cab53bd007 100644 --- a/clients/client-iotanalytics/commands/ListDatasetContentsCommand.ts +++ b/clients/client-iotanalytics/commands/ListDatasetContentsCommand.ts @@ -22,6 +22,20 @@ export interface ListDatasetContentsCommandOutput extends ListDatasetContentsRes /** *

Lists information about data set contents that have been created.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { IoTAnalyticsClient, ListDatasetContentsCommand } from "@aws-sdk/client-iotanalytics"; // ES Modules import + * // const { IoTAnalyticsClient, ListDatasetContentsCommand } = require("@aws-sdk/client-iotanalytics"); // CommonJS import + * const client = new IoTAnalyticsClient(config); + * const command = new ListDatasetContentsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListDatasetContentsCommandInput} for command's `input` shape. + * @see {@link ListDatasetContentsCommandOutput} for command's `response` shape. + * @see {@link IoTAnalyticsClientResolvedConfig | config} for command's `input` shape. + * */ export class ListDatasetContentsCommand extends $Command< ListDatasetContentsCommandInput, diff --git a/clients/client-iotanalytics/commands/ListDatasetsCommand.ts b/clients/client-iotanalytics/commands/ListDatasetsCommand.ts index 67297c10aaaf..329f376c2678 100644 --- a/clients/client-iotanalytics/commands/ListDatasetsCommand.ts +++ b/clients/client-iotanalytics/commands/ListDatasetsCommand.ts @@ -22,6 +22,20 @@ export interface ListDatasetsCommandOutput extends ListDatasetsResponse, __Metad /** *

Retrieves information about data sets.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { IoTAnalyticsClient, ListDatasetsCommand } from "@aws-sdk/client-iotanalytics"; // ES Modules import + * // const { IoTAnalyticsClient, ListDatasetsCommand } = require("@aws-sdk/client-iotanalytics"); // CommonJS import + * const client = new IoTAnalyticsClient(config); + * const command = new ListDatasetsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListDatasetsCommandInput} for command's `input` shape. + * @see {@link ListDatasetsCommandOutput} for command's `response` shape. + * @see {@link IoTAnalyticsClientResolvedConfig | config} for command's `input` shape. + * */ export class ListDatasetsCommand extends $Command< ListDatasetsCommandInput, diff --git a/clients/client-iotanalytics/commands/ListDatastoresCommand.ts b/clients/client-iotanalytics/commands/ListDatastoresCommand.ts index 9f29373df38f..6ca98c9cd9a7 100644 --- a/clients/client-iotanalytics/commands/ListDatastoresCommand.ts +++ b/clients/client-iotanalytics/commands/ListDatastoresCommand.ts @@ -22,6 +22,20 @@ export interface ListDatastoresCommandOutput extends ListDatastoresResponse, __M /** *

Retrieves a list of data stores.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { IoTAnalyticsClient, ListDatastoresCommand } from "@aws-sdk/client-iotanalytics"; // ES Modules import + * // const { IoTAnalyticsClient, ListDatastoresCommand } = require("@aws-sdk/client-iotanalytics"); // CommonJS import + * const client = new IoTAnalyticsClient(config); + * const command = new ListDatastoresCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListDatastoresCommandInput} for command's `input` shape. + * @see {@link ListDatastoresCommandOutput} for command's `response` shape. + * @see {@link IoTAnalyticsClientResolvedConfig | config} for command's `input` shape. + * */ export class ListDatastoresCommand extends $Command< ListDatastoresCommandInput, diff --git a/clients/client-iotanalytics/commands/ListPipelinesCommand.ts b/clients/client-iotanalytics/commands/ListPipelinesCommand.ts index 2d824f2e0dcd..daaf3061d57f 100644 --- a/clients/client-iotanalytics/commands/ListPipelinesCommand.ts +++ b/clients/client-iotanalytics/commands/ListPipelinesCommand.ts @@ -22,6 +22,20 @@ export interface ListPipelinesCommandOutput extends ListPipelinesResponse, __Met /** *

Retrieves a list of pipelines.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { IoTAnalyticsClient, ListPipelinesCommand } from "@aws-sdk/client-iotanalytics"; // ES Modules import + * // const { IoTAnalyticsClient, ListPipelinesCommand } = require("@aws-sdk/client-iotanalytics"); // CommonJS import + * const client = new IoTAnalyticsClient(config); + * const command = new ListPipelinesCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListPipelinesCommandInput} for command's `input` shape. + * @see {@link ListPipelinesCommandOutput} for command's `response` shape. + * @see {@link IoTAnalyticsClientResolvedConfig | config} for command's `input` shape. + * */ export class ListPipelinesCommand extends $Command< ListPipelinesCommandInput, diff --git a/clients/client-iotanalytics/commands/ListTagsForResourceCommand.ts b/clients/client-iotanalytics/commands/ListTagsForResourceCommand.ts index da1c410fe96c..c80e457a045d 100644 --- a/clients/client-iotanalytics/commands/ListTagsForResourceCommand.ts +++ b/clients/client-iotanalytics/commands/ListTagsForResourceCommand.ts @@ -22,6 +22,20 @@ export interface ListTagsForResourceCommandOutput extends ListTagsForResourceRes /** *

Lists the tags (metadata) that you have assigned to the resource.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { IoTAnalyticsClient, ListTagsForResourceCommand } from "@aws-sdk/client-iotanalytics"; // ES Modules import + * // const { IoTAnalyticsClient, ListTagsForResourceCommand } = require("@aws-sdk/client-iotanalytics"); // CommonJS import + * const client = new IoTAnalyticsClient(config); + * const command = new ListTagsForResourceCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListTagsForResourceCommandInput} for command's `input` shape. + * @see {@link ListTagsForResourceCommandOutput} for command's `response` shape. + * @see {@link IoTAnalyticsClientResolvedConfig | config} for command's `input` shape. + * */ export class ListTagsForResourceCommand extends $Command< ListTagsForResourceCommandInput, diff --git a/clients/client-iotanalytics/commands/PutLoggingOptionsCommand.ts b/clients/client-iotanalytics/commands/PutLoggingOptionsCommand.ts index 47211acb949d..6c44238c4bb5 100644 --- a/clients/client-iotanalytics/commands/PutLoggingOptionsCommand.ts +++ b/clients/client-iotanalytics/commands/PutLoggingOptionsCommand.ts @@ -26,6 +26,20 @@ export interface PutLoggingOptionsCommandOutput extends __MetadataBearer {} * 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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { IoTAnalyticsClient, PutLoggingOptionsCommand } from "@aws-sdk/client-iotanalytics"; // ES Modules import + * // const { IoTAnalyticsClient, PutLoggingOptionsCommand } = require("@aws-sdk/client-iotanalytics"); // CommonJS import + * const client = new IoTAnalyticsClient(config); + * const command = new PutLoggingOptionsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link PutLoggingOptionsCommandInput} for command's `input` shape. + * @see {@link PutLoggingOptionsCommandOutput} for command's `response` shape. + * @see {@link IoTAnalyticsClientResolvedConfig | config} for command's `input` shape. + * */ export class PutLoggingOptionsCommand extends $Command< PutLoggingOptionsCommandInput, diff --git a/clients/client-iotanalytics/commands/RunPipelineActivityCommand.ts b/clients/client-iotanalytics/commands/RunPipelineActivityCommand.ts index 53dd6f862057..92e0eadffa55 100644 --- a/clients/client-iotanalytics/commands/RunPipelineActivityCommand.ts +++ b/clients/client-iotanalytics/commands/RunPipelineActivityCommand.ts @@ -22,6 +22,20 @@ export interface RunPipelineActivityCommandOutput extends RunPipelineActivityRes /** *

Simulates the results of running a pipeline activity on a message payload.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { IoTAnalyticsClient, RunPipelineActivityCommand } from "@aws-sdk/client-iotanalytics"; // ES Modules import + * // const { IoTAnalyticsClient, RunPipelineActivityCommand } = require("@aws-sdk/client-iotanalytics"); // CommonJS import + * const client = new IoTAnalyticsClient(config); + * const command = new RunPipelineActivityCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link RunPipelineActivityCommandInput} for command's `input` shape. + * @see {@link RunPipelineActivityCommandOutput} for command's `response` shape. + * @see {@link IoTAnalyticsClientResolvedConfig | config} for command's `input` shape. + * */ export class RunPipelineActivityCommand extends $Command< RunPipelineActivityCommandInput, diff --git a/clients/client-iotanalytics/commands/SampleChannelDataCommand.ts b/clients/client-iotanalytics/commands/SampleChannelDataCommand.ts index 1ec9c104e7cf..4afce9dac391 100644 --- a/clients/client-iotanalytics/commands/SampleChannelDataCommand.ts +++ b/clients/client-iotanalytics/commands/SampleChannelDataCommand.ts @@ -23,6 +23,20 @@ export interface SampleChannelDataCommandOutput extends SampleChannelDataRespons /** *

Retrieves a sample of messages from the specified channel ingested during the specified * timeframe. Up to 10 messages can be retrieved.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { IoTAnalyticsClient, SampleChannelDataCommand } from "@aws-sdk/client-iotanalytics"; // ES Modules import + * // const { IoTAnalyticsClient, SampleChannelDataCommand } = require("@aws-sdk/client-iotanalytics"); // CommonJS import + * const client = new IoTAnalyticsClient(config); + * const command = new SampleChannelDataCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link SampleChannelDataCommandInput} for command's `input` shape. + * @see {@link SampleChannelDataCommandOutput} for command's `response` shape. + * @see {@link IoTAnalyticsClientResolvedConfig | config} for command's `input` shape. + * */ export class SampleChannelDataCommand extends $Command< SampleChannelDataCommandInput, diff --git a/clients/client-iotanalytics/commands/StartPipelineReprocessingCommand.ts b/clients/client-iotanalytics/commands/StartPipelineReprocessingCommand.ts index 5f11c005bffd..d8606e62c063 100644 --- a/clients/client-iotanalytics/commands/StartPipelineReprocessingCommand.ts +++ b/clients/client-iotanalytics/commands/StartPipelineReprocessingCommand.ts @@ -22,6 +22,20 @@ export interface StartPipelineReprocessingCommandOutput extends StartPipelineRep /** *

Starts the reprocessing of raw message data through the pipeline.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { IoTAnalyticsClient, StartPipelineReprocessingCommand } from "@aws-sdk/client-iotanalytics"; // ES Modules import + * // const { IoTAnalyticsClient, StartPipelineReprocessingCommand } = require("@aws-sdk/client-iotanalytics"); // CommonJS import + * const client = new IoTAnalyticsClient(config); + * const command = new StartPipelineReprocessingCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link StartPipelineReprocessingCommandInput} for command's `input` shape. + * @see {@link StartPipelineReprocessingCommandOutput} for command's `response` shape. + * @see {@link IoTAnalyticsClientResolvedConfig | config} for command's `input` shape. + * */ export class StartPipelineReprocessingCommand extends $Command< StartPipelineReprocessingCommandInput, diff --git a/clients/client-iotanalytics/commands/TagResourceCommand.ts b/clients/client-iotanalytics/commands/TagResourceCommand.ts index 410ffd28222d..7ac184344f93 100644 --- a/clients/client-iotanalytics/commands/TagResourceCommand.ts +++ b/clients/client-iotanalytics/commands/TagResourceCommand.ts @@ -23,6 +23,20 @@ export interface TagResourceCommandOutput extends TagResourceResponse, __Metadat /** *

Adds to or modifies the tags of the given resource. Tags are metadata that can be used to * manage a resource.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { IoTAnalyticsClient, TagResourceCommand } from "@aws-sdk/client-iotanalytics"; // ES Modules import + * // const { IoTAnalyticsClient, TagResourceCommand } = require("@aws-sdk/client-iotanalytics"); // CommonJS import + * const client = new IoTAnalyticsClient(config); + * const command = new TagResourceCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link TagResourceCommandInput} for command's `input` shape. + * @see {@link TagResourceCommandOutput} for command's `response` shape. + * @see {@link IoTAnalyticsClientResolvedConfig | config} for command's `input` shape. + * */ export class TagResourceCommand extends $Command< TagResourceCommandInput, diff --git a/clients/client-iotanalytics/commands/UntagResourceCommand.ts b/clients/client-iotanalytics/commands/UntagResourceCommand.ts index 9d734b7a26ea..47b9c2312f0b 100644 --- a/clients/client-iotanalytics/commands/UntagResourceCommand.ts +++ b/clients/client-iotanalytics/commands/UntagResourceCommand.ts @@ -22,6 +22,20 @@ export interface UntagResourceCommandOutput extends UntagResourceResponse, __Met /** *

Removes the given tags (metadata) from the resource.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { IoTAnalyticsClient, UntagResourceCommand } from "@aws-sdk/client-iotanalytics"; // ES Modules import + * // const { IoTAnalyticsClient, UntagResourceCommand } = require("@aws-sdk/client-iotanalytics"); // CommonJS import + * const client = new IoTAnalyticsClient(config); + * const command = new UntagResourceCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link UntagResourceCommandInput} for command's `input` shape. + * @see {@link UntagResourceCommandOutput} for command's `response` shape. + * @see {@link IoTAnalyticsClientResolvedConfig | config} for command's `input` shape. + * */ export class UntagResourceCommand extends $Command< UntagResourceCommandInput, diff --git a/clients/client-iotanalytics/commands/UpdateChannelCommand.ts b/clients/client-iotanalytics/commands/UpdateChannelCommand.ts index aa0217a5688a..fca22513c2b4 100644 --- a/clients/client-iotanalytics/commands/UpdateChannelCommand.ts +++ b/clients/client-iotanalytics/commands/UpdateChannelCommand.ts @@ -22,6 +22,20 @@ export interface UpdateChannelCommandOutput extends __MetadataBearer {} /** *

Updates the settings of a channel.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { IoTAnalyticsClient, UpdateChannelCommand } from "@aws-sdk/client-iotanalytics"; // ES Modules import + * // const { IoTAnalyticsClient, UpdateChannelCommand } = require("@aws-sdk/client-iotanalytics"); // CommonJS import + * const client = new IoTAnalyticsClient(config); + * const command = new UpdateChannelCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link UpdateChannelCommandInput} for command's `input` shape. + * @see {@link UpdateChannelCommandOutput} for command's `response` shape. + * @see {@link IoTAnalyticsClientResolvedConfig | config} for command's `input` shape. + * */ export class UpdateChannelCommand extends $Command< UpdateChannelCommandInput, diff --git a/clients/client-iotanalytics/commands/UpdateDatasetCommand.ts b/clients/client-iotanalytics/commands/UpdateDatasetCommand.ts index 53cf09c7b624..602af69b0b5c 100644 --- a/clients/client-iotanalytics/commands/UpdateDatasetCommand.ts +++ b/clients/client-iotanalytics/commands/UpdateDatasetCommand.ts @@ -22,6 +22,20 @@ export interface UpdateDatasetCommandOutput extends __MetadataBearer {} /** *

Updates the settings of a data set.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { IoTAnalyticsClient, UpdateDatasetCommand } from "@aws-sdk/client-iotanalytics"; // ES Modules import + * // const { IoTAnalyticsClient, UpdateDatasetCommand } = require("@aws-sdk/client-iotanalytics"); // CommonJS import + * const client = new IoTAnalyticsClient(config); + * const command = new UpdateDatasetCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link UpdateDatasetCommandInput} for command's `input` shape. + * @see {@link UpdateDatasetCommandOutput} for command's `response` shape. + * @see {@link IoTAnalyticsClientResolvedConfig | config} for command's `input` shape. + * */ export class UpdateDatasetCommand extends $Command< UpdateDatasetCommandInput, diff --git a/clients/client-iotanalytics/commands/UpdateDatastoreCommand.ts b/clients/client-iotanalytics/commands/UpdateDatastoreCommand.ts index 5c84de5d22db..cd6f3f752a88 100644 --- a/clients/client-iotanalytics/commands/UpdateDatastoreCommand.ts +++ b/clients/client-iotanalytics/commands/UpdateDatastoreCommand.ts @@ -22,6 +22,20 @@ export interface UpdateDatastoreCommandOutput extends __MetadataBearer {} /** *

Updates the settings of a data store.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { IoTAnalyticsClient, UpdateDatastoreCommand } from "@aws-sdk/client-iotanalytics"; // ES Modules import + * // const { IoTAnalyticsClient, UpdateDatastoreCommand } = require("@aws-sdk/client-iotanalytics"); // CommonJS import + * const client = new IoTAnalyticsClient(config); + * const command = new UpdateDatastoreCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link UpdateDatastoreCommandInput} for command's `input` shape. + * @see {@link UpdateDatastoreCommandOutput} for command's `response` shape. + * @see {@link IoTAnalyticsClientResolvedConfig | config} for command's `input` shape. + * */ export class UpdateDatastoreCommand extends $Command< UpdateDatastoreCommandInput, diff --git a/clients/client-iotanalytics/commands/UpdatePipelineCommand.ts b/clients/client-iotanalytics/commands/UpdatePipelineCommand.ts index 7856ff39e2db..3aecf3a45636 100644 --- a/clients/client-iotanalytics/commands/UpdatePipelineCommand.ts +++ b/clients/client-iotanalytics/commands/UpdatePipelineCommand.ts @@ -24,6 +24,20 @@ export interface UpdatePipelineCommandOutput extends __MetadataBearer {} *

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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { IoTAnalyticsClient, UpdatePipelineCommand } from "@aws-sdk/client-iotanalytics"; // ES Modules import + * // const { IoTAnalyticsClient, UpdatePipelineCommand } = require("@aws-sdk/client-iotanalytics"); // CommonJS import + * const client = new IoTAnalyticsClient(config); + * const command = new UpdatePipelineCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link UpdatePipelineCommandInput} for command's `input` shape. + * @see {@link UpdatePipelineCommandOutput} for command's `response` shape. + * @see {@link IoTAnalyticsClientResolvedConfig | config} for command's `input` shape. + * */ export class UpdatePipelineCommand extends $Command< UpdatePipelineCommandInput, diff --git a/clients/client-iotanalytics/models/models_0.ts b/clients/client-iotanalytics/models/models_0.ts index aca60ec2bd8c..5fcf19c5726f 100644 --- a/clients/client-iotanalytics/models/models_0.ts +++ b/clients/client-iotanalytics/models/models_0.ts @@ -27,6 +27,9 @@ export interface AddAttributesActivity { } export namespace AddAttributesActivity { + /** + * @internal + */ export const filterSensitiveLog = (obj: AddAttributesActivity): any => ({ ...obj, }); @@ -51,6 +54,9 @@ export interface Message { } export namespace Message { + /** + * @internal + */ export const filterSensitiveLog = (obj: Message): any => ({ ...obj, }); @@ -96,6 +102,9 @@ export interface BatchPutMessageRequest { } export namespace BatchPutMessageRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: BatchPutMessageRequest): any => ({ ...obj, }); @@ -123,6 +132,9 @@ export interface BatchPutMessageErrorEntry { } export namespace BatchPutMessageErrorEntry { + /** + * @internal + */ export const filterSensitiveLog = (obj: BatchPutMessageErrorEntry): any => ({ ...obj, }); @@ -136,6 +148,9 @@ export interface BatchPutMessageResponse { } export namespace BatchPutMessageResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: BatchPutMessageResponse): any => ({ ...obj, }); @@ -151,6 +166,9 @@ export interface InternalFailureException extends __SmithyException, $MetadataBe } export namespace InternalFailureException { + /** + * @internal + */ export const filterSensitiveLog = (obj: InternalFailureException): any => ({ ...obj, }); @@ -166,6 +184,9 @@ export interface InvalidRequestException extends __SmithyException, $MetadataBea } export namespace InvalidRequestException { + /** + * @internal + */ export const filterSensitiveLog = (obj: InvalidRequestException): any => ({ ...obj, }); @@ -181,6 +202,9 @@ export interface ResourceNotFoundException extends __SmithyException, $MetadataB } export namespace ResourceNotFoundException { + /** + * @internal + */ export const filterSensitiveLog = (obj: ResourceNotFoundException): any => ({ ...obj, }); @@ -196,6 +220,9 @@ export interface ServiceUnavailableException extends __SmithyException, $Metadat } export namespace ServiceUnavailableException { + /** + * @internal + */ export const filterSensitiveLog = (obj: ServiceUnavailableException): any => ({ ...obj, }); @@ -211,6 +238,9 @@ export interface ThrottlingException extends __SmithyException, $MetadataBearer } export namespace ThrottlingException { + /** + * @internal + */ export const filterSensitiveLog = (obj: ThrottlingException): any => ({ ...obj, }); @@ -230,6 +260,9 @@ export interface CancelPipelineReprocessingRequest { } export namespace CancelPipelineReprocessingRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: CancelPipelineReprocessingRequest): any => ({ ...obj, }); @@ -238,6 +271,9 @@ export namespace CancelPipelineReprocessingRequest { export interface CancelPipelineReprocessingResponse {} export namespace CancelPipelineReprocessingResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: CancelPipelineReprocessingResponse): any => ({ ...obj, }); @@ -270,6 +306,9 @@ export interface CustomerManagedChannelS3Storage { } export namespace CustomerManagedChannelS3Storage { + /** + * @internal + */ export const filterSensitiveLog = (obj: CustomerManagedChannelS3Storage): any => ({ ...obj, }); @@ -283,6 +322,9 @@ export namespace CustomerManagedChannelS3Storage { export interface ServiceManagedChannelS3Storage {} export namespace ServiceManagedChannelS3Storage { + /** + * @internal + */ export const filterSensitiveLog = (obj: ServiceManagedChannelS3Storage): any => ({ ...obj, }); @@ -311,6 +353,9 @@ export interface ChannelStorage { } export namespace ChannelStorage { + /** + * @internal + */ export const filterSensitiveLog = (obj: ChannelStorage): any => ({ ...obj, }); @@ -333,6 +378,9 @@ export interface RetentionPeriod { } export namespace RetentionPeriod { + /** + * @internal + */ export const filterSensitiveLog = (obj: RetentionPeriod): any => ({ ...obj, }); @@ -354,6 +402,9 @@ export interface Tag { } export namespace Tag { + /** + * @internal + */ export const filterSensitiveLog = (obj: Tag): any => ({ ...obj, }); @@ -386,6 +437,9 @@ export interface CreateChannelRequest { } export namespace CreateChannelRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateChannelRequest): any => ({ ...obj, }); @@ -409,6 +463,9 @@ export interface CreateChannelResponse { } export namespace CreateChannelResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateChannelResponse): any => ({ ...obj, }); @@ -424,6 +481,9 @@ export interface LimitExceededException extends __SmithyException, $MetadataBear } export namespace LimitExceededException { + /** + * @internal + */ export const filterSensitiveLog = (obj: LimitExceededException): any => ({ ...obj, }); @@ -448,6 +508,9 @@ export interface ResourceAlreadyExistsException extends __SmithyException, $Meta } export namespace ResourceAlreadyExistsException { + /** + * @internal + */ export const filterSensitiveLog = (obj: ResourceAlreadyExistsException): any => ({ ...obj, }); @@ -477,6 +540,9 @@ export interface ResourceConfiguration { } export namespace ResourceConfiguration { + /** + * @internal + */ export const filterSensitiveLog = (obj: ResourceConfiguration): any => ({ ...obj, }); @@ -494,6 +560,9 @@ export interface DatasetContentVersionValue { } export namespace DatasetContentVersionValue { + /** + * @internal + */ export const filterSensitiveLog = (obj: DatasetContentVersionValue): any => ({ ...obj, }); @@ -511,6 +580,9 @@ export interface OutputFileUriValue { } export namespace OutputFileUriValue { + /** + * @internal + */ export const filterSensitiveLog = (obj: OutputFileUriValue): any => ({ ...obj, }); @@ -549,6 +621,9 @@ export interface Variable { } export namespace Variable { + /** + * @internal + */ export const filterSensitiveLog = (obj: Variable): any => ({ ...obj, }); @@ -587,6 +662,9 @@ export interface ContainerDatasetAction { } export namespace ContainerDatasetAction { + /** + * @internal + */ export const filterSensitiveLog = (obj: ContainerDatasetAction): any => ({ ...obj, }); @@ -617,6 +695,9 @@ export interface DeltaTime { } export namespace DeltaTime { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeltaTime): any => ({ ...obj, }); @@ -635,6 +716,9 @@ export interface QueryFilter { } export namespace QueryFilter { + /** + * @internal + */ export const filterSensitiveLog = (obj: QueryFilter): any => ({ ...obj, }); @@ -656,6 +740,9 @@ export interface SqlQueryDatasetAction { } export namespace SqlQueryDatasetAction { + /** + * @internal + */ export const filterSensitiveLog = (obj: SqlQueryDatasetAction): any => ({ ...obj, }); @@ -687,6 +774,9 @@ export interface DatasetAction { } export namespace DatasetAction { + /** + * @internal + */ export const filterSensitiveLog = (obj: DatasetAction): any => ({ ...obj, }); @@ -709,6 +799,9 @@ export interface IotEventsDestinationConfiguration { } export namespace IotEventsDestinationConfiguration { + /** + * @internal + */ export const filterSensitiveLog = (obj: IotEventsDestinationConfiguration): any => ({ ...obj, }); @@ -734,6 +827,9 @@ export interface GlueConfiguration { } export namespace GlueConfiguration { + /** + * @internal + */ export const filterSensitiveLog = (obj: GlueConfiguration): any => ({ ...obj, }); @@ -793,6 +889,9 @@ export interface S3DestinationConfiguration { } export namespace S3DestinationConfiguration { + /** + * @internal + */ export const filterSensitiveLog = (obj: S3DestinationConfiguration): any => ({ ...obj, }); @@ -814,6 +913,9 @@ export interface DatasetContentDeliveryDestination { } export namespace DatasetContentDeliveryDestination { + /** + * @internal + */ export const filterSensitiveLog = (obj: DatasetContentDeliveryDestination): any => ({ ...obj, }); @@ -836,6 +938,9 @@ export interface DatasetContentDeliveryRule { } export namespace DatasetContentDeliveryRule { + /** + * @internal + */ export const filterSensitiveLog = (obj: DatasetContentDeliveryRule): any => ({ ...obj, }); @@ -865,6 +970,9 @@ export interface DeltaTimeSessionWindowConfiguration { } export namespace DeltaTimeSessionWindowConfiguration { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeltaTimeSessionWindowConfiguration): any => ({ ...obj, }); @@ -881,6 +989,9 @@ export interface LateDataRuleConfiguration { } export namespace LateDataRuleConfiguration { + /** + * @internal + */ export const filterSensitiveLog = (obj: LateDataRuleConfiguration): any => ({ ...obj, }); @@ -903,6 +1014,9 @@ export interface LateDataRule { } export namespace LateDataRule { + /** + * @internal + */ export const filterSensitiveLog = (obj: LateDataRule): any => ({ ...obj, }); @@ -921,6 +1035,9 @@ export interface TriggeringDataset { } export namespace TriggeringDataset { + /** + * @internal + */ export const filterSensitiveLog = (obj: TriggeringDataset): any => ({ ...obj, }); @@ -939,6 +1056,9 @@ export interface Schedule { } export namespace Schedule { + /** + * @internal + */ export const filterSensitiveLog = (obj: Schedule): any => ({ ...obj, }); @@ -962,6 +1082,9 @@ export interface DatasetTrigger { } export namespace DatasetTrigger { + /** + * @internal + */ export const filterSensitiveLog = (obj: DatasetTrigger): any => ({ ...obj, }); @@ -984,6 +1107,9 @@ export interface VersioningConfiguration { } export namespace VersioningConfiguration { + /** + * @internal + */ export const filterSensitiveLog = (obj: VersioningConfiguration): any => ({ ...obj, }); @@ -1045,6 +1171,9 @@ export interface CreateDatasetRequest { } export namespace CreateDatasetRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateDatasetRequest): any => ({ ...obj, }); @@ -1068,6 +1197,9 @@ export interface CreateDatasetResponse { } export namespace CreateDatasetResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateDatasetResponse): any => ({ ...obj, }); @@ -1087,6 +1219,9 @@ export interface CreateDatasetContentRequest { } export namespace CreateDatasetContentRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateDatasetContentRequest): any => ({ ...obj, }); @@ -1100,6 +1235,9 @@ export interface CreateDatasetContentResponse { } export namespace CreateDatasetContentResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateDatasetContentResponse): any => ({ ...obj, }); @@ -1132,6 +1270,9 @@ export interface CustomerManagedDatastoreS3Storage { } export namespace CustomerManagedDatastoreS3Storage { + /** + * @internal + */ export const filterSensitiveLog = (obj: CustomerManagedDatastoreS3Storage): any => ({ ...obj, }); @@ -1145,6 +1286,9 @@ export namespace CustomerManagedDatastoreS3Storage { export interface ServiceManagedDatastoreS3Storage {} export namespace ServiceManagedDatastoreS3Storage { + /** + * @internal + */ export const filterSensitiveLog = (obj: ServiceManagedDatastoreS3Storage): any => ({ ...obj, }); @@ -1203,6 +1347,9 @@ export namespace DatastoreStorage { return visitor._(value.$unknown[0], value.$unknown[1]); }; + /** + * @internal + */ export const filterSensitiveLog = (obj: DatastoreStorage): any => { if (obj.serviceManagedS3 !== undefined) return { serviceManagedS3: ServiceManagedDatastoreS3Storage.filterSensitiveLog(obj.serviceManagedS3) }; @@ -1218,6 +1365,9 @@ export namespace DatastoreStorage { export interface JsonConfiguration {} export namespace JsonConfiguration { + /** + * @internal + */ export const filterSensitiveLog = (obj: JsonConfiguration): any => ({ ...obj, }); @@ -1240,6 +1390,9 @@ export interface Column { } export namespace Column { + /** + * @internal + */ export const filterSensitiveLog = (obj: Column): any => ({ ...obj, }); @@ -1257,6 +1410,9 @@ export interface SchemaDefinition { } export namespace SchemaDefinition { + /** + * @internal + */ export const filterSensitiveLog = (obj: SchemaDefinition): any => ({ ...obj, }); @@ -1273,6 +1429,9 @@ export interface ParquetConfiguration { } export namespace ParquetConfiguration { + /** + * @internal + */ export const filterSensitiveLog = (obj: ParquetConfiguration): any => ({ ...obj, }); @@ -1297,6 +1456,9 @@ export interface FileFormatConfiguration { } export namespace FileFormatConfiguration { + /** + * @internal + */ export const filterSensitiveLog = (obj: FileFormatConfiguration): any => ({ ...obj, }); @@ -1337,6 +1499,9 @@ export interface CreateDatastoreRequest { } export namespace CreateDatastoreRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateDatastoreRequest): any => ({ ...obj, ...(obj.datastoreStorage && { datastoreStorage: DatastoreStorage.filterSensitiveLog(obj.datastoreStorage) }), @@ -1361,6 +1526,9 @@ export interface CreateDatastoreResponse { } export namespace CreateDatastoreResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateDatastoreResponse): any => ({ ...obj, }); @@ -1387,6 +1555,9 @@ export interface ChannelActivity { } export namespace ChannelActivity { + /** + * @internal + */ export const filterSensitiveLog = (obj: ChannelActivity): any => ({ ...obj, }); @@ -1408,6 +1579,9 @@ export interface DatastoreActivity { } export namespace DatastoreActivity { + /** + * @internal + */ export const filterSensitiveLog = (obj: DatastoreActivity): any => ({ ...obj, }); @@ -1444,6 +1618,9 @@ export interface DeviceRegistryEnrichActivity { } export namespace DeviceRegistryEnrichActivity { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeviceRegistryEnrichActivity): any => ({ ...obj, }); @@ -1481,6 +1658,9 @@ export interface DeviceShadowEnrichActivity { } export namespace DeviceShadowEnrichActivity { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeviceShadowEnrichActivity): any => ({ ...obj, }); @@ -1508,6 +1688,9 @@ export interface FilterActivity { } export namespace FilterActivity { + /** + * @internal + */ export const filterSensitiveLog = (obj: FilterActivity): any => ({ ...obj, }); @@ -1541,6 +1724,9 @@ export interface LambdaActivity { } export namespace LambdaActivity { + /** + * @internal + */ export const filterSensitiveLog = (obj: LambdaActivity): any => ({ ...obj, }); @@ -1573,6 +1759,9 @@ export interface MathActivity { } export namespace MathActivity { + /** + * @internal + */ export const filterSensitiveLog = (obj: MathActivity): any => ({ ...obj, }); @@ -1599,6 +1788,9 @@ export interface RemoveAttributesActivity { } export namespace RemoveAttributesActivity { + /** + * @internal + */ export const filterSensitiveLog = (obj: RemoveAttributesActivity): any => ({ ...obj, }); @@ -1626,6 +1818,9 @@ export interface SelectAttributesActivity { } export namespace SelectAttributesActivity { + /** + * @internal + */ export const filterSensitiveLog = (obj: SelectAttributesActivity): any => ({ ...obj, }); @@ -1689,6 +1884,9 @@ export interface PipelineActivity { } export namespace PipelineActivity { + /** + * @internal + */ export const filterSensitiveLog = (obj: PipelineActivity): any => ({ ...obj, }); @@ -1722,6 +1920,9 @@ export interface CreatePipelineRequest { } export namespace CreatePipelineRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreatePipelineRequest): any => ({ ...obj, }); @@ -1740,6 +1941,9 @@ export interface CreatePipelineResponse { } export namespace CreatePipelineResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreatePipelineResponse): any => ({ ...obj, }); @@ -1753,6 +1957,9 @@ export interface DeleteChannelRequest { } export namespace DeleteChannelRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteChannelRequest): any => ({ ...obj, }); @@ -1766,6 +1973,9 @@ export interface DeleteDatasetRequest { } export namespace DeleteDatasetRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteDatasetRequest): any => ({ ...obj, }); @@ -1786,6 +1996,9 @@ export interface DeleteDatasetContentRequest { } export namespace DeleteDatasetContentRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteDatasetContentRequest): any => ({ ...obj, }); @@ -1799,6 +2012,9 @@ export interface DeleteDatastoreRequest { } export namespace DeleteDatastoreRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteDatastoreRequest): any => ({ ...obj, }); @@ -1812,6 +2028,9 @@ export interface DeletePipelineRequest { } export namespace DeletePipelineRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeletePipelineRequest): any => ({ ...obj, }); @@ -1831,6 +2050,9 @@ export interface DescribeChannelRequest { } export namespace DescribeChannelRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeChannelRequest): any => ({ ...obj, }); @@ -1895,6 +2117,9 @@ export interface Channel { } export namespace Channel { + /** + * @internal + */ export const filterSensitiveLog = (obj: Channel): any => ({ ...obj, }); @@ -1916,6 +2141,9 @@ export interface EstimatedResourceSize { } export namespace EstimatedResourceSize { + /** + * @internal + */ export const filterSensitiveLog = (obj: EstimatedResourceSize): any => ({ ...obj, }); @@ -1932,6 +2160,9 @@ export interface ChannelStatistics { } export namespace ChannelStatistics { + /** + * @internal + */ export const filterSensitiveLog = (obj: ChannelStatistics): any => ({ ...obj, }); @@ -1951,6 +2182,9 @@ export interface DescribeChannelResponse { } export namespace DescribeChannelResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeChannelResponse): any => ({ ...obj, }); @@ -1964,6 +2198,9 @@ export interface DescribeDatasetRequest { } export namespace DescribeDatasetRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeDatasetRequest): any => ({ ...obj, }); @@ -2045,6 +2282,9 @@ export interface Dataset { } export namespace Dataset { + /** + * @internal + */ export const filterSensitiveLog = (obj: Dataset): any => ({ ...obj, }); @@ -2058,6 +2298,9 @@ export interface DescribeDatasetResponse { } export namespace DescribeDatasetResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeDatasetResponse): any => ({ ...obj, }); @@ -2078,6 +2321,9 @@ export interface DescribeDatastoreRequest { } export namespace DescribeDatastoreRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeDatastoreRequest): any => ({ ...obj, }); @@ -2164,6 +2410,9 @@ export interface Datastore { } export namespace Datastore { + /** + * @internal + */ export const filterSensitiveLog = (obj: Datastore): any => ({ ...obj, ...(obj.storage && { storage: DatastoreStorage.filterSensitiveLog(obj.storage) }), @@ -2181,6 +2430,9 @@ export interface DatastoreStatistics { } export namespace DatastoreStatistics { + /** + * @internal + */ export const filterSensitiveLog = (obj: DatastoreStatistics): any => ({ ...obj, }); @@ -2200,6 +2452,9 @@ export interface DescribeDatastoreResponse { } export namespace DescribeDatastoreResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeDatastoreResponse): any => ({ ...obj, ...(obj.datastore && { datastore: Datastore.filterSensitiveLog(obj.datastore) }), @@ -2209,6 +2464,9 @@ export namespace DescribeDatastoreResponse { export interface DescribeLoggingOptionsRequest {} export namespace DescribeLoggingOptionsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeLoggingOptionsRequest): any => ({ ...obj, }); @@ -2239,6 +2497,9 @@ export interface LoggingOptions { } export namespace LoggingOptions { + /** + * @internal + */ export const filterSensitiveLog = (obj: LoggingOptions): any => ({ ...obj, }); @@ -2252,6 +2513,9 @@ export interface DescribeLoggingOptionsResponse { } export namespace DescribeLoggingOptionsResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeLoggingOptionsResponse): any => ({ ...obj, }); @@ -2265,6 +2529,9 @@ export interface DescribePipelineRequest { } export namespace DescribePipelineRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribePipelineRequest): any => ({ ...obj, }); @@ -2298,6 +2565,9 @@ export interface ReprocessingSummary { } export namespace ReprocessingSummary { + /** + * @internal + */ export const filterSensitiveLog = (obj: ReprocessingSummary): any => ({ ...obj, }); @@ -2339,6 +2609,9 @@ export interface Pipeline { } export namespace Pipeline { + /** + * @internal + */ export const filterSensitiveLog = (obj: Pipeline): any => ({ ...obj, }); @@ -2352,6 +2625,9 @@ export interface DescribePipelineResponse { } export namespace DescribePipelineResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribePipelineResponse): any => ({ ...obj, }); @@ -2372,6 +2648,9 @@ export interface GetDatasetContentRequest { } export namespace GetDatasetContentRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetDatasetContentRequest): any => ({ ...obj, }); @@ -2393,6 +2672,9 @@ export interface DatasetEntry { } export namespace DatasetEntry { + /** + * @internal + */ export const filterSensitiveLog = (obj: DatasetEntry): any => ({ ...obj, }); @@ -2421,6 +2703,9 @@ export interface DatasetContentStatus { } export namespace DatasetContentStatus { + /** + * @internal + */ export const filterSensitiveLog = (obj: DatasetContentStatus): any => ({ ...obj, }); @@ -2444,6 +2729,9 @@ export interface GetDatasetContentResponse { } export namespace GetDatasetContentResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetDatasetContentResponse): any => ({ ...obj, }); @@ -2463,6 +2751,9 @@ export interface ListChannelsRequest { } export namespace ListChannelsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListChannelsRequest): any => ({ ...obj, }); @@ -2492,6 +2783,9 @@ export interface CustomerManagedChannelS3StorageSummary { } export namespace CustomerManagedChannelS3StorageSummary { + /** + * @internal + */ export const filterSensitiveLog = (obj: CustomerManagedChannelS3StorageSummary): any => ({ ...obj, }); @@ -2503,6 +2797,9 @@ export namespace CustomerManagedChannelS3StorageSummary { export interface ServiceManagedChannelS3StorageSummary {} export namespace ServiceManagedChannelS3StorageSummary { + /** + * @internal + */ export const filterSensitiveLog = (obj: ServiceManagedChannelS3StorageSummary): any => ({ ...obj, }); @@ -2524,6 +2821,9 @@ export interface ChannelStorageSummary { } export namespace ChannelStorageSummary { + /** + * @internal + */ export const filterSensitiveLog = (obj: ChannelStorageSummary): any => ({ ...obj, }); @@ -2568,6 +2868,9 @@ export interface ChannelSummary { } export namespace ChannelSummary { + /** + * @internal + */ export const filterSensitiveLog = (obj: ChannelSummary): any => ({ ...obj, }); @@ -2587,6 +2890,9 @@ export interface ListChannelsResponse { } export namespace ListChannelsResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListChannelsResponse): any => ({ ...obj, }); @@ -2624,6 +2930,9 @@ export interface ListDatasetContentsRequest { } export namespace ListDatasetContentsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListDatasetContentsRequest): any => ({ ...obj, }); @@ -2660,6 +2969,9 @@ export interface DatasetContentSummary { } export namespace DatasetContentSummary { + /** + * @internal + */ export const filterSensitiveLog = (obj: DatasetContentSummary): any => ({ ...obj, }); @@ -2679,6 +2991,9 @@ export interface ListDatasetContentsResponse { } export namespace ListDatasetContentsResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListDatasetContentsResponse): any => ({ ...obj, }); @@ -2698,6 +3013,9 @@ export interface ListDatasetsRequest { } export namespace ListDatasetsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListDatasetsRequest): any => ({ ...obj, }); @@ -2724,6 +3042,9 @@ export interface DatasetActionSummary { } export namespace DatasetActionSummary { + /** + * @internal + */ export const filterSensitiveLog = (obj: DatasetActionSummary): any => ({ ...obj, }); @@ -2767,6 +3088,9 @@ export interface DatasetSummary { } export namespace DatasetSummary { + /** + * @internal + */ export const filterSensitiveLog = (obj: DatasetSummary): any => ({ ...obj, }); @@ -2786,6 +3110,9 @@ export interface ListDatasetsResponse { } export namespace ListDatasetsResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListDatasetsResponse): any => ({ ...obj, }); @@ -2805,6 +3132,9 @@ export interface ListDatastoresRequest { } export namespace ListDatastoresRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListDatastoresRequest): any => ({ ...obj, }); @@ -2834,6 +3164,9 @@ export interface CustomerManagedDatastoreS3StorageSummary { } export namespace CustomerManagedDatastoreS3StorageSummary { + /** + * @internal + */ export const filterSensitiveLog = (obj: CustomerManagedDatastoreS3StorageSummary): any => ({ ...obj, }); @@ -2845,6 +3178,9 @@ export namespace CustomerManagedDatastoreS3StorageSummary { export interface ServiceManagedDatastoreS3StorageSummary {} export namespace ServiceManagedDatastoreS3StorageSummary { + /** + * @internal + */ export const filterSensitiveLog = (obj: ServiceManagedDatastoreS3StorageSummary): any => ({ ...obj, }); @@ -2866,6 +3202,9 @@ export interface DatastoreStorageSummary { } export namespace DatastoreStorageSummary { + /** + * @internal + */ export const filterSensitiveLog = (obj: DatastoreStorageSummary): any => ({ ...obj, }); @@ -2920,6 +3259,9 @@ export interface DatastoreSummary { } export namespace DatastoreSummary { + /** + * @internal + */ export const filterSensitiveLog = (obj: DatastoreSummary): any => ({ ...obj, }); @@ -2939,6 +3281,9 @@ export interface ListDatastoresResponse { } export namespace ListDatastoresResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListDatastoresResponse): any => ({ ...obj, }); @@ -2958,6 +3303,9 @@ export interface ListPipelinesRequest { } export namespace ListPipelinesRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListPipelinesRequest): any => ({ ...obj, }); @@ -2989,6 +3337,9 @@ export interface PipelineSummary { } export namespace PipelineSummary { + /** + * @internal + */ export const filterSensitiveLog = (obj: PipelineSummary): any => ({ ...obj, }); @@ -3008,6 +3359,9 @@ export interface ListPipelinesResponse { } export namespace ListPipelinesResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListPipelinesResponse): any => ({ ...obj, }); @@ -3021,6 +3375,9 @@ export interface ListTagsForResourceRequest { } export namespace ListTagsForResourceRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListTagsForResourceRequest): any => ({ ...obj, }); @@ -3034,6 +3391,9 @@ export interface ListTagsForResourceResponse { } export namespace ListTagsForResourceResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListTagsForResourceResponse): any => ({ ...obj, }); @@ -3047,6 +3407,9 @@ export interface PutLoggingOptionsRequest { } export namespace PutLoggingOptionsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: PutLoggingOptionsRequest): any => ({ ...obj, }); @@ -3069,6 +3432,9 @@ export interface RunPipelineActivityRequest { } export namespace RunPipelineActivityRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: RunPipelineActivityRequest): any => ({ ...obj, }); @@ -3089,6 +3455,9 @@ export interface RunPipelineActivityResponse { } export namespace RunPipelineActivityResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: RunPipelineActivityResponse): any => ({ ...obj, }); @@ -3118,6 +3487,9 @@ export interface SampleChannelDataRequest { } export namespace SampleChannelDataRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: SampleChannelDataRequest): any => ({ ...obj, }); @@ -3132,6 +3504,9 @@ export interface SampleChannelDataResponse { } export namespace SampleChannelDataResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: SampleChannelDataResponse): any => ({ ...obj, }); @@ -3149,6 +3524,9 @@ export interface ChannelMessages { } export namespace ChannelMessages { + /** + * @internal + */ export const filterSensitiveLog = (obj: ChannelMessages): any => ({ ...obj, }); @@ -3183,6 +3561,9 @@ export interface StartPipelineReprocessingRequest { } export namespace StartPipelineReprocessingRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: StartPipelineReprocessingRequest): any => ({ ...obj, }); @@ -3196,6 +3577,9 @@ export interface StartPipelineReprocessingResponse { } export namespace StartPipelineReprocessingResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: StartPipelineReprocessingResponse): any => ({ ...obj, }); @@ -3214,6 +3598,9 @@ export interface TagResourceRequest { } export namespace TagResourceRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: TagResourceRequest): any => ({ ...obj, }); @@ -3222,6 +3609,9 @@ export namespace TagResourceRequest { export interface TagResourceResponse {} export namespace TagResourceResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: TagResourceResponse): any => ({ ...obj, }); @@ -3240,6 +3630,9 @@ export interface UntagResourceRequest { } export namespace UntagResourceRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: UntagResourceRequest): any => ({ ...obj, }); @@ -3248,6 +3641,9 @@ export namespace UntagResourceRequest { export interface UntagResourceResponse {} export namespace UntagResourceResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: UntagResourceResponse): any => ({ ...obj, }); @@ -3275,6 +3671,9 @@ export interface UpdateChannelRequest { } export namespace UpdateChannelRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateChannelRequest): any => ({ ...obj, }); @@ -3326,6 +3725,9 @@ export interface UpdateDatasetRequest { } export namespace UpdateDatasetRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateDatasetRequest): any => ({ ...obj, }); @@ -3361,6 +3763,9 @@ export interface UpdateDatastoreRequest { } export namespace UpdateDatastoreRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateDatastoreRequest): any => ({ ...obj, ...(obj.datastoreStorage && { datastoreStorage: DatastoreStorage.filterSensitiveLog(obj.datastoreStorage) }), @@ -3390,6 +3795,9 @@ export interface UpdatePipelineRequest { } export namespace UpdatePipelineRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdatePipelineRequest): any => ({ ...obj, }); diff --git a/clients/client-iotdeviceadvisor/commands/CreateSuiteDefinitionCommand.ts b/clients/client-iotdeviceadvisor/commands/CreateSuiteDefinitionCommand.ts index 673b64b629df..53c6b6cb9a79 100644 --- a/clients/client-iotdeviceadvisor/commands/CreateSuiteDefinitionCommand.ts +++ b/clients/client-iotdeviceadvisor/commands/CreateSuiteDefinitionCommand.ts @@ -22,6 +22,20 @@ export interface CreateSuiteDefinitionCommandOutput extends CreateSuiteDefinitio /** *

Creates a Device Advisor test suite.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { IotDeviceAdvisorClient, CreateSuiteDefinitionCommand } from "@aws-sdk/client-iotdeviceadvisor"; // ES Modules import + * // const { IotDeviceAdvisorClient, CreateSuiteDefinitionCommand } = require("@aws-sdk/client-iotdeviceadvisor"); // CommonJS import + * const client = new IotDeviceAdvisorClient(config); + * const command = new CreateSuiteDefinitionCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreateSuiteDefinitionCommandInput} for command's `input` shape. + * @see {@link CreateSuiteDefinitionCommandOutput} for command's `response` shape. + * @see {@link IotDeviceAdvisorClientResolvedConfig | config} for command's `input` shape. + * */ export class CreateSuiteDefinitionCommand extends $Command< CreateSuiteDefinitionCommandInput, diff --git a/clients/client-iotdeviceadvisor/commands/DeleteSuiteDefinitionCommand.ts b/clients/client-iotdeviceadvisor/commands/DeleteSuiteDefinitionCommand.ts index d83b076fa310..065a454162f9 100644 --- a/clients/client-iotdeviceadvisor/commands/DeleteSuiteDefinitionCommand.ts +++ b/clients/client-iotdeviceadvisor/commands/DeleteSuiteDefinitionCommand.ts @@ -22,6 +22,20 @@ export interface DeleteSuiteDefinitionCommandOutput extends DeleteSuiteDefinitio /** *

Deletes a Device Advisor test suite.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { IotDeviceAdvisorClient, DeleteSuiteDefinitionCommand } from "@aws-sdk/client-iotdeviceadvisor"; // ES Modules import + * // const { IotDeviceAdvisorClient, DeleteSuiteDefinitionCommand } = require("@aws-sdk/client-iotdeviceadvisor"); // CommonJS import + * const client = new IotDeviceAdvisorClient(config); + * const command = new DeleteSuiteDefinitionCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteSuiteDefinitionCommandInput} for command's `input` shape. + * @see {@link DeleteSuiteDefinitionCommandOutput} for command's `response` shape. + * @see {@link IotDeviceAdvisorClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteSuiteDefinitionCommand extends $Command< DeleteSuiteDefinitionCommandInput, diff --git a/clients/client-iotdeviceadvisor/commands/GetSuiteDefinitionCommand.ts b/clients/client-iotdeviceadvisor/commands/GetSuiteDefinitionCommand.ts index ea7434e0e875..c26a93b0b28f 100644 --- a/clients/client-iotdeviceadvisor/commands/GetSuiteDefinitionCommand.ts +++ b/clients/client-iotdeviceadvisor/commands/GetSuiteDefinitionCommand.ts @@ -22,6 +22,20 @@ export interface GetSuiteDefinitionCommandOutput extends GetSuiteDefinitionRespo /** *

Gets information about a Device Advisor test suite.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { IotDeviceAdvisorClient, GetSuiteDefinitionCommand } from "@aws-sdk/client-iotdeviceadvisor"; // ES Modules import + * // const { IotDeviceAdvisorClient, GetSuiteDefinitionCommand } = require("@aws-sdk/client-iotdeviceadvisor"); // CommonJS import + * const client = new IotDeviceAdvisorClient(config); + * const command = new GetSuiteDefinitionCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetSuiteDefinitionCommandInput} for command's `input` shape. + * @see {@link GetSuiteDefinitionCommandOutput} for command's `response` shape. + * @see {@link IotDeviceAdvisorClientResolvedConfig | config} for command's `input` shape. + * */ export class GetSuiteDefinitionCommand extends $Command< GetSuiteDefinitionCommandInput, diff --git a/clients/client-iotdeviceadvisor/commands/GetSuiteRunCommand.ts b/clients/client-iotdeviceadvisor/commands/GetSuiteRunCommand.ts index 8364828b43f0..25986fa97f4b 100644 --- a/clients/client-iotdeviceadvisor/commands/GetSuiteRunCommand.ts +++ b/clients/client-iotdeviceadvisor/commands/GetSuiteRunCommand.ts @@ -22,6 +22,20 @@ export interface GetSuiteRunCommandOutput extends GetSuiteRunResponse, __Metadat /** *

Gets information about a Device Advisor test suite run.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { IotDeviceAdvisorClient, GetSuiteRunCommand } from "@aws-sdk/client-iotdeviceadvisor"; // ES Modules import + * // const { IotDeviceAdvisorClient, GetSuiteRunCommand } = require("@aws-sdk/client-iotdeviceadvisor"); // CommonJS import + * const client = new IotDeviceAdvisorClient(config); + * const command = new GetSuiteRunCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetSuiteRunCommandInput} for command's `input` shape. + * @see {@link GetSuiteRunCommandOutput} for command's `response` shape. + * @see {@link IotDeviceAdvisorClientResolvedConfig | config} for command's `input` shape. + * */ export class GetSuiteRunCommand extends $Command< GetSuiteRunCommandInput, diff --git a/clients/client-iotdeviceadvisor/commands/GetSuiteRunReportCommand.ts b/clients/client-iotdeviceadvisor/commands/GetSuiteRunReportCommand.ts index d4eb31e45ad5..f66597a90d8f 100644 --- a/clients/client-iotdeviceadvisor/commands/GetSuiteRunReportCommand.ts +++ b/clients/client-iotdeviceadvisor/commands/GetSuiteRunReportCommand.ts @@ -22,6 +22,20 @@ export interface GetSuiteRunReportCommandOutput extends GetSuiteRunReportRespons /** *

Gets a report download link for a successful Device Advisor qualifying test suite run.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { IotDeviceAdvisorClient, GetSuiteRunReportCommand } from "@aws-sdk/client-iotdeviceadvisor"; // ES Modules import + * // const { IotDeviceAdvisorClient, GetSuiteRunReportCommand } = require("@aws-sdk/client-iotdeviceadvisor"); // CommonJS import + * const client = new IotDeviceAdvisorClient(config); + * const command = new GetSuiteRunReportCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetSuiteRunReportCommandInput} for command's `input` shape. + * @see {@link GetSuiteRunReportCommandOutput} for command's `response` shape. + * @see {@link IotDeviceAdvisorClientResolvedConfig | config} for command's `input` shape. + * */ export class GetSuiteRunReportCommand extends $Command< GetSuiteRunReportCommandInput, diff --git a/clients/client-iotdeviceadvisor/commands/ListSuiteDefinitionsCommand.ts b/clients/client-iotdeviceadvisor/commands/ListSuiteDefinitionsCommand.ts index ee5d9ecaacc9..47a6fe34c83a 100644 --- a/clients/client-iotdeviceadvisor/commands/ListSuiteDefinitionsCommand.ts +++ b/clients/client-iotdeviceadvisor/commands/ListSuiteDefinitionsCommand.ts @@ -22,6 +22,20 @@ export interface ListSuiteDefinitionsCommandOutput extends ListSuiteDefinitionsR /** *

Lists the Device Advisor test suites you have created.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { IotDeviceAdvisorClient, ListSuiteDefinitionsCommand } from "@aws-sdk/client-iotdeviceadvisor"; // ES Modules import + * // const { IotDeviceAdvisorClient, ListSuiteDefinitionsCommand } = require("@aws-sdk/client-iotdeviceadvisor"); // CommonJS import + * const client = new IotDeviceAdvisorClient(config); + * const command = new ListSuiteDefinitionsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListSuiteDefinitionsCommandInput} for command's `input` shape. + * @see {@link ListSuiteDefinitionsCommandOutput} for command's `response` shape. + * @see {@link IotDeviceAdvisorClientResolvedConfig | config} for command's `input` shape. + * */ export class ListSuiteDefinitionsCommand extends $Command< ListSuiteDefinitionsCommandInput, diff --git a/clients/client-iotdeviceadvisor/commands/ListSuiteRunsCommand.ts b/clients/client-iotdeviceadvisor/commands/ListSuiteRunsCommand.ts index 3486749609d9..5762321e3d8a 100644 --- a/clients/client-iotdeviceadvisor/commands/ListSuiteRunsCommand.ts +++ b/clients/client-iotdeviceadvisor/commands/ListSuiteRunsCommand.ts @@ -23,6 +23,20 @@ export interface ListSuiteRunsCommandOutput extends ListSuiteRunsResponse, __Met /** *

Lists the 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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { IotDeviceAdvisorClient, ListSuiteRunsCommand } from "@aws-sdk/client-iotdeviceadvisor"; // ES Modules import + * // const { IotDeviceAdvisorClient, ListSuiteRunsCommand } = require("@aws-sdk/client-iotdeviceadvisor"); // CommonJS import + * const client = new IotDeviceAdvisorClient(config); + * const command = new ListSuiteRunsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListSuiteRunsCommandInput} for command's `input` shape. + * @see {@link ListSuiteRunsCommandOutput} for command's `response` shape. + * @see {@link IotDeviceAdvisorClientResolvedConfig | config} for command's `input` shape. + * */ export class ListSuiteRunsCommand extends $Command< ListSuiteRunsCommandInput, diff --git a/clients/client-iotdeviceadvisor/commands/ListTagsForResourceCommand.ts b/clients/client-iotdeviceadvisor/commands/ListTagsForResourceCommand.ts index bc5d59f577dd..c151b96d9af0 100644 --- a/clients/client-iotdeviceadvisor/commands/ListTagsForResourceCommand.ts +++ b/clients/client-iotdeviceadvisor/commands/ListTagsForResourceCommand.ts @@ -22,6 +22,20 @@ export interface ListTagsForResourceCommandOutput extends ListTagsForResourceRes /** *

Lists the tags attached to an IoT Device Advisor resource.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { IotDeviceAdvisorClient, ListTagsForResourceCommand } from "@aws-sdk/client-iotdeviceadvisor"; // ES Modules import + * // const { IotDeviceAdvisorClient, ListTagsForResourceCommand } = require("@aws-sdk/client-iotdeviceadvisor"); // CommonJS import + * const client = new IotDeviceAdvisorClient(config); + * const command = new ListTagsForResourceCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListTagsForResourceCommandInput} for command's `input` shape. + * @see {@link ListTagsForResourceCommandOutput} for command's `response` shape. + * @see {@link IotDeviceAdvisorClientResolvedConfig | config} for command's `input` shape. + * */ export class ListTagsForResourceCommand extends $Command< ListTagsForResourceCommandInput, diff --git a/clients/client-iotdeviceadvisor/commands/ListTestCasesCommand.ts b/clients/client-iotdeviceadvisor/commands/ListTestCasesCommand.ts index 348a6b14ca6e..af690d9a85d0 100644 --- a/clients/client-iotdeviceadvisor/commands/ListTestCasesCommand.ts +++ b/clients/client-iotdeviceadvisor/commands/ListTestCasesCommand.ts @@ -22,6 +22,20 @@ export interface ListTestCasesCommandOutput extends ListTestCasesResponse, __Met /** *

Lists all the test cases in the test suite.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { IotDeviceAdvisorClient, ListTestCasesCommand } from "@aws-sdk/client-iotdeviceadvisor"; // ES Modules import + * // const { IotDeviceAdvisorClient, ListTestCasesCommand } = require("@aws-sdk/client-iotdeviceadvisor"); // CommonJS import + * const client = new IotDeviceAdvisorClient(config); + * const command = new ListTestCasesCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListTestCasesCommandInput} for command's `input` shape. + * @see {@link ListTestCasesCommandOutput} for command's `response` shape. + * @see {@link IotDeviceAdvisorClientResolvedConfig | config} for command's `input` shape. + * */ export class ListTestCasesCommand extends $Command< ListTestCasesCommandInput, diff --git a/clients/client-iotdeviceadvisor/commands/StartSuiteRunCommand.ts b/clients/client-iotdeviceadvisor/commands/StartSuiteRunCommand.ts index 3bfc038b48b6..1ac7309ae4a1 100644 --- a/clients/client-iotdeviceadvisor/commands/StartSuiteRunCommand.ts +++ b/clients/client-iotdeviceadvisor/commands/StartSuiteRunCommand.ts @@ -22,6 +22,20 @@ export interface StartSuiteRunCommandOutput extends StartSuiteRunResponse, __Met /** *

Starts a Device Advisor test suite run.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { IotDeviceAdvisorClient, StartSuiteRunCommand } from "@aws-sdk/client-iotdeviceadvisor"; // ES Modules import + * // const { IotDeviceAdvisorClient, StartSuiteRunCommand } = require("@aws-sdk/client-iotdeviceadvisor"); // CommonJS import + * const client = new IotDeviceAdvisorClient(config); + * const command = new StartSuiteRunCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link StartSuiteRunCommandInput} for command's `input` shape. + * @see {@link StartSuiteRunCommandOutput} for command's `response` shape. + * @see {@link IotDeviceAdvisorClientResolvedConfig | config} for command's `input` shape. + * */ export class StartSuiteRunCommand extends $Command< StartSuiteRunCommandInput, diff --git a/clients/client-iotdeviceadvisor/commands/TagResourceCommand.ts b/clients/client-iotdeviceadvisor/commands/TagResourceCommand.ts index d7c3fd700093..fd76cb8fac3b 100644 --- a/clients/client-iotdeviceadvisor/commands/TagResourceCommand.ts +++ b/clients/client-iotdeviceadvisor/commands/TagResourceCommand.ts @@ -22,6 +22,20 @@ export interface TagResourceCommandOutput extends TagResourceResponse, __Metadat /** *

Adds to and modifies existing tags of an IoT Device Advisor resource.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { IotDeviceAdvisorClient, TagResourceCommand } from "@aws-sdk/client-iotdeviceadvisor"; // ES Modules import + * // const { IotDeviceAdvisorClient, TagResourceCommand } = require("@aws-sdk/client-iotdeviceadvisor"); // CommonJS import + * const client = new IotDeviceAdvisorClient(config); + * const command = new TagResourceCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link TagResourceCommandInput} for command's `input` shape. + * @see {@link TagResourceCommandOutput} for command's `response` shape. + * @see {@link IotDeviceAdvisorClientResolvedConfig | config} for command's `input` shape. + * */ export class TagResourceCommand extends $Command< TagResourceCommandInput, diff --git a/clients/client-iotdeviceadvisor/commands/UntagResourceCommand.ts b/clients/client-iotdeviceadvisor/commands/UntagResourceCommand.ts index 66365aa8a35a..feb1e7fe09ca 100644 --- a/clients/client-iotdeviceadvisor/commands/UntagResourceCommand.ts +++ b/clients/client-iotdeviceadvisor/commands/UntagResourceCommand.ts @@ -22,6 +22,20 @@ export interface UntagResourceCommandOutput extends UntagResourceResponse, __Met /** *

Removes tags from an IoT Device Advisor resource.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { IotDeviceAdvisorClient, UntagResourceCommand } from "@aws-sdk/client-iotdeviceadvisor"; // ES Modules import + * // const { IotDeviceAdvisorClient, UntagResourceCommand } = require("@aws-sdk/client-iotdeviceadvisor"); // CommonJS import + * const client = new IotDeviceAdvisorClient(config); + * const command = new UntagResourceCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link UntagResourceCommandInput} for command's `input` shape. + * @see {@link UntagResourceCommandOutput} for command's `response` shape. + * @see {@link IotDeviceAdvisorClientResolvedConfig | config} for command's `input` shape. + * */ export class UntagResourceCommand extends $Command< UntagResourceCommandInput, diff --git a/clients/client-iotdeviceadvisor/commands/UpdateSuiteDefinitionCommand.ts b/clients/client-iotdeviceadvisor/commands/UpdateSuiteDefinitionCommand.ts index 2f47f4e54864..7698419e6215 100644 --- a/clients/client-iotdeviceadvisor/commands/UpdateSuiteDefinitionCommand.ts +++ b/clients/client-iotdeviceadvisor/commands/UpdateSuiteDefinitionCommand.ts @@ -22,6 +22,20 @@ export interface UpdateSuiteDefinitionCommandOutput extends UpdateSuiteDefinitio /** *

Updates a Device Advisor test suite.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { IotDeviceAdvisorClient, UpdateSuiteDefinitionCommand } from "@aws-sdk/client-iotdeviceadvisor"; // ES Modules import + * // const { IotDeviceAdvisorClient, UpdateSuiteDefinitionCommand } = require("@aws-sdk/client-iotdeviceadvisor"); // CommonJS import + * const client = new IotDeviceAdvisorClient(config); + * const command = new UpdateSuiteDefinitionCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link UpdateSuiteDefinitionCommandInput} for command's `input` shape. + * @see {@link UpdateSuiteDefinitionCommandOutput} for command's `response` shape. + * @see {@link IotDeviceAdvisorClientResolvedConfig | config} for command's `input` shape. + * */ export class UpdateSuiteDefinitionCommand extends $Command< UpdateSuiteDefinitionCommandInput, diff --git a/clients/client-iotdeviceadvisor/models/models_0.ts b/clients/client-iotdeviceadvisor/models/models_0.ts index e2202662a04b..04207bae1b4c 100644 --- a/clients/client-iotdeviceadvisor/models/models_0.ts +++ b/clients/client-iotdeviceadvisor/models/models_0.ts @@ -14,6 +14,9 @@ export interface ConflictException extends __SmithyException, $MetadataBearer { } export namespace ConflictException { + /** + * @internal + */ export const filterSensitiveLog = (obj: ConflictException): any => ({ ...obj, }); @@ -35,6 +38,9 @@ export interface DeviceUnderTest { } export namespace DeviceUnderTest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeviceUnderTest): any => ({ ...obj, }); @@ -71,6 +77,9 @@ export interface SuiteDefinitionConfiguration { } export namespace SuiteDefinitionConfiguration { + /** + * @internal + */ export const filterSensitiveLog = (obj: SuiteDefinitionConfiguration): any => ({ ...obj, }); @@ -89,6 +98,9 @@ export interface CreateSuiteDefinitionRequest { } export namespace CreateSuiteDefinitionRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateSuiteDefinitionRequest): any => ({ ...obj, }); @@ -117,6 +129,9 @@ export interface CreateSuiteDefinitionResponse { } export namespace CreateSuiteDefinitionResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateSuiteDefinitionResponse): any => ({ ...obj, }); @@ -135,6 +150,9 @@ export interface InternalServerException extends __SmithyException, $MetadataBea } export namespace InternalServerException { + /** + * @internal + */ export const filterSensitiveLog = (obj: InternalServerException): any => ({ ...obj, }); @@ -153,6 +171,9 @@ export interface ValidationException extends __SmithyException, $MetadataBearer } export namespace ValidationException { + /** + * @internal + */ export const filterSensitiveLog = (obj: ValidationException): any => ({ ...obj, }); @@ -166,6 +187,9 @@ export interface DeleteSuiteDefinitionRequest { } export namespace DeleteSuiteDefinitionRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteSuiteDefinitionRequest): any => ({ ...obj, }); @@ -174,6 +198,9 @@ export namespace DeleteSuiteDefinitionRequest { export interface DeleteSuiteDefinitionResponse {} export namespace DeleteSuiteDefinitionResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteSuiteDefinitionResponse): any => ({ ...obj, }); @@ -192,6 +219,9 @@ export interface GetSuiteDefinitionRequest { } export namespace GetSuiteDefinitionRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetSuiteDefinitionRequest): any => ({ ...obj, }); @@ -240,6 +270,9 @@ export interface GetSuiteDefinitionResponse { } export namespace GetSuiteDefinitionResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetSuiteDefinitionResponse): any => ({ ...obj, }); @@ -258,6 +291,9 @@ export interface ResourceNotFoundException extends __SmithyException, $MetadataB } export namespace ResourceNotFoundException { + /** + * @internal + */ export const filterSensitiveLog = (obj: ResourceNotFoundException): any => ({ ...obj, }); @@ -276,6 +312,9 @@ export interface GetSuiteRunRequest { } export namespace GetSuiteRunRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetSuiteRunRequest): any => ({ ...obj, }); @@ -312,6 +351,9 @@ export interface SuiteRunConfiguration { } export namespace SuiteRunConfiguration { + /** + * @internal + */ export const filterSensitiveLog = (obj: SuiteRunConfiguration): any => ({ ...obj, }); @@ -378,6 +420,9 @@ export interface TestCaseRun { } export namespace TestCaseRun { + /** + * @internal + */ export const filterSensitiveLog = (obj: TestCaseRun): any => ({ ...obj, }); @@ -404,6 +449,9 @@ export interface GroupResult { } export namespace GroupResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: GroupResult): any => ({ ...obj, }); @@ -420,6 +468,9 @@ export interface TestResult { } export namespace TestResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: TestResult): any => ({ ...obj, }); @@ -483,6 +534,9 @@ export interface GetSuiteRunResponse { } export namespace GetSuiteRunResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetSuiteRunResponse): any => ({ ...obj, }); @@ -501,6 +555,9 @@ export interface GetSuiteRunReportRequest { } export namespace GetSuiteRunReportRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetSuiteRunReportRequest): any => ({ ...obj, }); @@ -514,6 +571,9 @@ export interface GetSuiteRunReportResponse { } export namespace GetSuiteRunReportResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetSuiteRunReportResponse): any => ({ ...obj, }); @@ -532,6 +592,9 @@ export interface ListSuiteDefinitionsRequest { } export namespace ListSuiteDefinitionsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListSuiteDefinitionsRequest): any => ({ ...obj, }); @@ -568,6 +631,9 @@ export interface SuiteDefinitionInformation { } export namespace SuiteDefinitionInformation { + /** + * @internal + */ export const filterSensitiveLog = (obj: SuiteDefinitionInformation): any => ({ ...obj, }); @@ -586,6 +652,9 @@ export interface ListSuiteDefinitionsResponse { } export namespace ListSuiteDefinitionsResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListSuiteDefinitionsResponse): any => ({ ...obj, }); @@ -614,6 +683,9 @@ export interface ListSuiteRunsRequest { } export namespace ListSuiteRunsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListSuiteRunsRequest): any => ({ ...obj, }); @@ -675,6 +747,9 @@ export interface SuiteRunInformation { } export namespace SuiteRunInformation { + /** + * @internal + */ export const filterSensitiveLog = (obj: SuiteRunInformation): any => ({ ...obj, }); @@ -693,6 +768,9 @@ export interface ListSuiteRunsResponse { } export namespace ListSuiteRunsResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListSuiteRunsResponse): any => ({ ...obj, }); @@ -706,6 +784,9 @@ export interface ListTagsForResourceRequest { } export namespace ListTagsForResourceRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListTagsForResourceRequest): any => ({ ...obj, }); @@ -719,6 +800,9 @@ export interface ListTagsForResourceResponse { } export namespace ListTagsForResourceResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListTagsForResourceResponse): any => ({ ...obj, }); @@ -742,6 +826,9 @@ export interface ListTestCasesRequest { } export namespace ListTestCasesRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListTestCasesRequest): any => ({ ...obj, }); @@ -763,6 +850,9 @@ export interface TestCaseDefinition { } export namespace TestCaseDefinition { + /** + * @internal + */ export const filterSensitiveLog = (obj: TestCaseDefinition): any => ({ ...obj, }); @@ -789,6 +879,9 @@ export interface TestCase { } export namespace TestCase { + /** + * @internal + */ export const filterSensitiveLog = (obj: TestCase): any => ({ ...obj, }); @@ -810,6 +903,9 @@ export interface TestCaseCategory { } export namespace TestCaseCategory { + /** + * @internal + */ export const filterSensitiveLog = (obj: TestCaseCategory): any => ({ ...obj, }); @@ -838,6 +934,9 @@ export interface ListTestCasesResponse { } export namespace ListTestCasesResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListTestCasesResponse): any => ({ ...obj, }); @@ -866,6 +965,9 @@ export interface StartSuiteRunRequest { } export namespace StartSuiteRunRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: StartSuiteRunRequest): any => ({ ...obj, }); @@ -889,6 +991,9 @@ export interface StartSuiteRunResponse { } export namespace StartSuiteRunResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: StartSuiteRunResponse): any => ({ ...obj, }); @@ -907,6 +1012,9 @@ export interface TagResourceRequest { } export namespace TagResourceRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: TagResourceRequest): any => ({ ...obj, }); @@ -915,6 +1023,9 @@ export namespace TagResourceRequest { export interface TagResourceResponse {} export namespace TagResourceResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: TagResourceResponse): any => ({ ...obj, }); @@ -933,6 +1044,9 @@ export interface UntagResourceRequest { } export namespace UntagResourceRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: UntagResourceRequest): any => ({ ...obj, }); @@ -941,6 +1055,9 @@ export namespace UntagResourceRequest { export interface UntagResourceResponse {} export namespace UntagResourceResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: UntagResourceResponse): any => ({ ...obj, }); @@ -959,6 +1076,9 @@ export interface UpdateSuiteDefinitionRequest { } export namespace UpdateSuiteDefinitionRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateSuiteDefinitionRequest): any => ({ ...obj, }); @@ -997,6 +1117,9 @@ export interface UpdateSuiteDefinitionResponse { } export namespace UpdateSuiteDefinitionResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateSuiteDefinitionResponse): any => ({ ...obj, }); diff --git a/clients/client-iotfleethub/commands/CreateApplicationCommand.ts b/clients/client-iotfleethub/commands/CreateApplicationCommand.ts index f49fb863ab5e..963a6c971fe7 100644 --- a/clients/client-iotfleethub/commands/CreateApplicationCommand.ts +++ b/clients/client-iotfleethub/commands/CreateApplicationCommand.ts @@ -25,6 +25,20 @@ export interface CreateApplicationCommandOutput extends CreateApplicationRespons * *

Fleet Hub for AWS IoT Device Management is in public preview and is subject to change.

* + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { IoTFleetHubClient, CreateApplicationCommand } from "@aws-sdk/client-iotfleethub"; // ES Modules import + * // const { IoTFleetHubClient, CreateApplicationCommand } = require("@aws-sdk/client-iotfleethub"); // CommonJS import + * const client = new IoTFleetHubClient(config); + * const command = new CreateApplicationCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreateApplicationCommandInput} for command's `input` shape. + * @see {@link CreateApplicationCommandOutput} for command's `response` shape. + * @see {@link IoTFleetHubClientResolvedConfig | config} for command's `input` shape. + * */ export class CreateApplicationCommand extends $Command< CreateApplicationCommandInput, diff --git a/clients/client-iotfleethub/commands/DeleteApplicationCommand.ts b/clients/client-iotfleethub/commands/DeleteApplicationCommand.ts index e7dc16a4de6d..3e785534160a 100644 --- a/clients/client-iotfleethub/commands/DeleteApplicationCommand.ts +++ b/clients/client-iotfleethub/commands/DeleteApplicationCommand.ts @@ -25,6 +25,20 @@ export interface DeleteApplicationCommandOutput extends DeleteApplicationRespons * *

Fleet Hub for AWS IoT Device Management is in public preview and is subject to change.

* + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { IoTFleetHubClient, DeleteApplicationCommand } from "@aws-sdk/client-iotfleethub"; // ES Modules import + * // const { IoTFleetHubClient, DeleteApplicationCommand } = require("@aws-sdk/client-iotfleethub"); // CommonJS import + * const client = new IoTFleetHubClient(config); + * const command = new DeleteApplicationCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteApplicationCommandInput} for command's `input` shape. + * @see {@link DeleteApplicationCommandOutput} for command's `response` shape. + * @see {@link IoTFleetHubClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteApplicationCommand extends $Command< DeleteApplicationCommandInput, diff --git a/clients/client-iotfleethub/commands/DescribeApplicationCommand.ts b/clients/client-iotfleethub/commands/DescribeApplicationCommand.ts index c07eaaf52cd2..b124b4b74ca8 100644 --- a/clients/client-iotfleethub/commands/DescribeApplicationCommand.ts +++ b/clients/client-iotfleethub/commands/DescribeApplicationCommand.ts @@ -25,6 +25,20 @@ export interface DescribeApplicationCommandOutput extends DescribeApplicationRes * *

Fleet Hub for AWS IoT Device Management is in public preview and is subject to change.

* + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { IoTFleetHubClient, DescribeApplicationCommand } from "@aws-sdk/client-iotfleethub"; // ES Modules import + * // const { IoTFleetHubClient, DescribeApplicationCommand } = require("@aws-sdk/client-iotfleethub"); // CommonJS import + * const client = new IoTFleetHubClient(config); + * const command = new DescribeApplicationCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeApplicationCommandInput} for command's `input` shape. + * @see {@link DescribeApplicationCommandOutput} for command's `response` shape. + * @see {@link IoTFleetHubClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeApplicationCommand extends $Command< DescribeApplicationCommandInput, diff --git a/clients/client-iotfleethub/commands/ListApplicationsCommand.ts b/clients/client-iotfleethub/commands/ListApplicationsCommand.ts index eedbafe17d57..69f2deecd499 100644 --- a/clients/client-iotfleethub/commands/ListApplicationsCommand.ts +++ b/clients/client-iotfleethub/commands/ListApplicationsCommand.ts @@ -25,6 +25,20 @@ export interface ListApplicationsCommandOutput extends ListApplicationsResponse, * *

Fleet Hub for AWS IoT Device Management is in public preview and is subject to change.

* + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { IoTFleetHubClient, ListApplicationsCommand } from "@aws-sdk/client-iotfleethub"; // ES Modules import + * // const { IoTFleetHubClient, ListApplicationsCommand } = require("@aws-sdk/client-iotfleethub"); // CommonJS import + * const client = new IoTFleetHubClient(config); + * const command = new ListApplicationsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListApplicationsCommandInput} for command's `input` shape. + * @see {@link ListApplicationsCommandOutput} for command's `response` shape. + * @see {@link IoTFleetHubClientResolvedConfig | config} for command's `input` shape. + * */ export class ListApplicationsCommand extends $Command< ListApplicationsCommandInput, diff --git a/clients/client-iotfleethub/commands/ListTagsForResourceCommand.ts b/clients/client-iotfleethub/commands/ListTagsForResourceCommand.ts index 2aa201c7dad7..64d7714798fb 100644 --- a/clients/client-iotfleethub/commands/ListTagsForResourceCommand.ts +++ b/clients/client-iotfleethub/commands/ListTagsForResourceCommand.ts @@ -25,6 +25,20 @@ export interface ListTagsForResourceCommandOutput extends ListTagsForResourceRes * *

Fleet Hub for AWS IoT Device Management is in public preview and is subject to change.

* + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { IoTFleetHubClient, ListTagsForResourceCommand } from "@aws-sdk/client-iotfleethub"; // ES Modules import + * // const { IoTFleetHubClient, ListTagsForResourceCommand } = require("@aws-sdk/client-iotfleethub"); // CommonJS import + * const client = new IoTFleetHubClient(config); + * const command = new ListTagsForResourceCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListTagsForResourceCommandInput} for command's `input` shape. + * @see {@link ListTagsForResourceCommandOutput} for command's `response` shape. + * @see {@link IoTFleetHubClientResolvedConfig | config} for command's `input` shape. + * */ export class ListTagsForResourceCommand extends $Command< ListTagsForResourceCommandInput, diff --git a/clients/client-iotfleethub/commands/TagResourceCommand.ts b/clients/client-iotfleethub/commands/TagResourceCommand.ts index aadb2c63fa0c..40106be045ab 100644 --- a/clients/client-iotfleethub/commands/TagResourceCommand.ts +++ b/clients/client-iotfleethub/commands/TagResourceCommand.ts @@ -25,6 +25,20 @@ export interface TagResourceCommandOutput extends TagResourceResponse, __Metadat * *

Fleet Hub for AWS IoT Device Management is in public preview and is subject to change.

* + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { IoTFleetHubClient, TagResourceCommand } from "@aws-sdk/client-iotfleethub"; // ES Modules import + * // const { IoTFleetHubClient, TagResourceCommand } = require("@aws-sdk/client-iotfleethub"); // CommonJS import + * const client = new IoTFleetHubClient(config); + * const command = new TagResourceCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link TagResourceCommandInput} for command's `input` shape. + * @see {@link TagResourceCommandOutput} for command's `response` shape. + * @see {@link IoTFleetHubClientResolvedConfig | config} for command's `input` shape. + * */ export class TagResourceCommand extends $Command< TagResourceCommandInput, diff --git a/clients/client-iotfleethub/commands/UntagResourceCommand.ts b/clients/client-iotfleethub/commands/UntagResourceCommand.ts index fe6be6a79415..b153bfc10186 100644 --- a/clients/client-iotfleethub/commands/UntagResourceCommand.ts +++ b/clients/client-iotfleethub/commands/UntagResourceCommand.ts @@ -25,6 +25,20 @@ export interface UntagResourceCommandOutput extends UntagResourceResponse, __Met * *

Fleet Hub for AWS IoT Device Management is in public preview and is subject to change.

* + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { IoTFleetHubClient, UntagResourceCommand } from "@aws-sdk/client-iotfleethub"; // ES Modules import + * // const { IoTFleetHubClient, UntagResourceCommand } = require("@aws-sdk/client-iotfleethub"); // CommonJS import + * const client = new IoTFleetHubClient(config); + * const command = new UntagResourceCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link UntagResourceCommandInput} for command's `input` shape. + * @see {@link UntagResourceCommandOutput} for command's `response` shape. + * @see {@link IoTFleetHubClientResolvedConfig | config} for command's `input` shape. + * */ export class UntagResourceCommand extends $Command< UntagResourceCommandInput, diff --git a/clients/client-iotfleethub/commands/UpdateApplicationCommand.ts b/clients/client-iotfleethub/commands/UpdateApplicationCommand.ts index 39e4d29ac890..4f9c3107afef 100644 --- a/clients/client-iotfleethub/commands/UpdateApplicationCommand.ts +++ b/clients/client-iotfleethub/commands/UpdateApplicationCommand.ts @@ -25,6 +25,20 @@ export interface UpdateApplicationCommandOutput extends UpdateApplicationRespons * *

Fleet Hub for AWS IoT Device Management is in public preview and is subject to change.

* + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { IoTFleetHubClient, UpdateApplicationCommand } from "@aws-sdk/client-iotfleethub"; // ES Modules import + * // const { IoTFleetHubClient, UpdateApplicationCommand } = require("@aws-sdk/client-iotfleethub"); // CommonJS import + * const client = new IoTFleetHubClient(config); + * const command = new UpdateApplicationCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link UpdateApplicationCommandInput} for command's `input` shape. + * @see {@link UpdateApplicationCommandOutput} for command's `response` shape. + * @see {@link IoTFleetHubClientResolvedConfig | config} for command's `input` shape. + * */ export class UpdateApplicationCommand extends $Command< UpdateApplicationCommandInput, diff --git a/clients/client-iotfleethub/models/models_0.ts b/clients/client-iotfleethub/models/models_0.ts index 747396304710..2c3e643f3c56 100644 --- a/clients/client-iotfleethub/models/models_0.ts +++ b/clients/client-iotfleethub/models/models_0.ts @@ -53,6 +53,9 @@ export interface ApplicationSummary { } export namespace ApplicationSummary { + /** + * @internal + */ export const filterSensitiveLog = (obj: ApplicationSummary): any => ({ ...obj, }); @@ -91,6 +94,9 @@ export interface CreateApplicationRequest { } export namespace CreateApplicationRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateApplicationRequest): any => ({ ...obj, }); @@ -109,6 +115,9 @@ export interface CreateApplicationResponse { } export namespace CreateApplicationResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateApplicationResponse): any => ({ ...obj, }); @@ -124,6 +133,9 @@ export interface InternalFailureException extends __SmithyException, $MetadataBe } export namespace InternalFailureException { + /** + * @internal + */ export const filterSensitiveLog = (obj: InternalFailureException): any => ({ ...obj, }); @@ -139,6 +151,9 @@ export interface InvalidRequestException extends __SmithyException, $MetadataBea } export namespace InvalidRequestException { + /** + * @internal + */ export const filterSensitiveLog = (obj: InvalidRequestException): any => ({ ...obj, }); @@ -154,6 +169,9 @@ export interface LimitExceededException extends __SmithyException, $MetadataBear } export namespace LimitExceededException { + /** + * @internal + */ export const filterSensitiveLog = (obj: LimitExceededException): any => ({ ...obj, }); @@ -169,6 +187,9 @@ export interface ThrottlingException extends __SmithyException, $MetadataBearer } export namespace ThrottlingException { + /** + * @internal + */ export const filterSensitiveLog = (obj: ThrottlingException): any => ({ ...obj, }); @@ -188,6 +209,9 @@ export interface DeleteApplicationRequest { } export namespace DeleteApplicationRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteApplicationRequest): any => ({ ...obj, }); @@ -196,6 +220,9 @@ export namespace DeleteApplicationRequest { export interface DeleteApplicationResponse {} export namespace DeleteApplicationResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteApplicationResponse): any => ({ ...obj, }); @@ -211,6 +238,9 @@ export interface ResourceNotFoundException extends __SmithyException, $MetadataB } export namespace ResourceNotFoundException { + /** + * @internal + */ export const filterSensitiveLog = (obj: ResourceNotFoundException): any => ({ ...obj, }); @@ -224,6 +254,9 @@ export interface DescribeApplicationRequest { } export namespace DescribeApplicationRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeApplicationRequest): any => ({ ...obj, }); @@ -292,6 +325,9 @@ export interface DescribeApplicationResponse { } export namespace DescribeApplicationResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeApplicationResponse): any => ({ ...obj, }); @@ -305,6 +341,9 @@ export interface ListApplicationsRequest { } export namespace ListApplicationsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListApplicationsRequest): any => ({ ...obj, }); @@ -323,6 +362,9 @@ export interface ListApplicationsResponse { } export namespace ListApplicationsResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListApplicationsResponse): any => ({ ...obj, }); @@ -336,6 +378,9 @@ export interface ListTagsForResourceRequest { } export namespace ListTagsForResourceRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListTagsForResourceRequest): any => ({ ...obj, }); @@ -349,6 +394,9 @@ export interface ListTagsForResourceResponse { } export namespace ListTagsForResourceResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListTagsForResourceResponse): any => ({ ...obj, }); @@ -367,6 +415,9 @@ export interface TagResourceRequest { } export namespace TagResourceRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: TagResourceRequest): any => ({ ...obj, }); @@ -375,6 +426,9 @@ export namespace TagResourceRequest { export interface TagResourceResponse {} export namespace TagResourceResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: TagResourceResponse): any => ({ ...obj, }); @@ -393,6 +447,9 @@ export interface UntagResourceRequest { } export namespace UntagResourceRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: UntagResourceRequest): any => ({ ...obj, }); @@ -401,6 +458,9 @@ export namespace UntagResourceRequest { export interface UntagResourceResponse {} export namespace UntagResourceResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: UntagResourceResponse): any => ({ ...obj, }); @@ -416,6 +476,9 @@ export interface ConflictException extends __SmithyException, $MetadataBearer { } export namespace ConflictException { + /** + * @internal + */ export const filterSensitiveLog = (obj: ConflictException): any => ({ ...obj, }); @@ -445,6 +508,9 @@ export interface UpdateApplicationRequest { } export namespace UpdateApplicationRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateApplicationRequest): any => ({ ...obj, }); @@ -453,6 +519,9 @@ export namespace UpdateApplicationRequest { export interface UpdateApplicationResponse {} export namespace UpdateApplicationResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateApplicationResponse): any => ({ ...obj, }); diff --git a/clients/client-iotsecuretunneling/commands/CloseTunnelCommand.ts b/clients/client-iotsecuretunneling/commands/CloseTunnelCommand.ts index b64592bb8245..74a56b49e592 100644 --- a/clients/client-iotsecuretunneling/commands/CloseTunnelCommand.ts +++ b/clients/client-iotsecuretunneling/commands/CloseTunnelCommand.ts @@ -28,6 +28,20 @@ export interface CloseTunnelCommandOutput extends CloseTunnelResponse, __Metadat *

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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { IoTSecureTunnelingClient, CloseTunnelCommand } from "@aws-sdk/client-iotsecuretunneling"; // ES Modules import + * // const { IoTSecureTunnelingClient, CloseTunnelCommand } = require("@aws-sdk/client-iotsecuretunneling"); // CommonJS import + * const client = new IoTSecureTunnelingClient(config); + * const command = new CloseTunnelCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CloseTunnelCommandInput} for command's `input` shape. + * @see {@link CloseTunnelCommandOutput} for command's `response` shape. + * @see {@link IoTSecureTunnelingClientResolvedConfig | config} for command's `input` shape. + * */ export class CloseTunnelCommand extends $Command< CloseTunnelCommandInput, diff --git a/clients/client-iotsecuretunneling/commands/DescribeTunnelCommand.ts b/clients/client-iotsecuretunneling/commands/DescribeTunnelCommand.ts index e128952bf6e1..fba1efa075c8 100644 --- a/clients/client-iotsecuretunneling/commands/DescribeTunnelCommand.ts +++ b/clients/client-iotsecuretunneling/commands/DescribeTunnelCommand.ts @@ -26,6 +26,20 @@ export interface DescribeTunnelCommandOutput extends DescribeTunnelResponse, __M /** *

Gets information about a tunnel identified by the unique tunnel id.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { IoTSecureTunnelingClient, DescribeTunnelCommand } from "@aws-sdk/client-iotsecuretunneling"; // ES Modules import + * // const { IoTSecureTunnelingClient, DescribeTunnelCommand } = require("@aws-sdk/client-iotsecuretunneling"); // CommonJS import + * const client = new IoTSecureTunnelingClient(config); + * const command = new DescribeTunnelCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeTunnelCommandInput} for command's `input` shape. + * @see {@link DescribeTunnelCommandOutput} for command's `response` shape. + * @see {@link IoTSecureTunnelingClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeTunnelCommand extends $Command< DescribeTunnelCommandInput, diff --git a/clients/client-iotsecuretunneling/commands/ListTagsForResourceCommand.ts b/clients/client-iotsecuretunneling/commands/ListTagsForResourceCommand.ts index 952b460683d1..fa0d43315d05 100644 --- a/clients/client-iotsecuretunneling/commands/ListTagsForResourceCommand.ts +++ b/clients/client-iotsecuretunneling/commands/ListTagsForResourceCommand.ts @@ -26,6 +26,20 @@ export interface ListTagsForResourceCommandOutput extends ListTagsForResourceRes /** *

Lists the tags for the specified resource.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { IoTSecureTunnelingClient, ListTagsForResourceCommand } from "@aws-sdk/client-iotsecuretunneling"; // ES Modules import + * // const { IoTSecureTunnelingClient, ListTagsForResourceCommand } = require("@aws-sdk/client-iotsecuretunneling"); // CommonJS import + * const client = new IoTSecureTunnelingClient(config); + * const command = new ListTagsForResourceCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListTagsForResourceCommandInput} for command's `input` shape. + * @see {@link ListTagsForResourceCommandOutput} for command's `response` shape. + * @see {@link IoTSecureTunnelingClientResolvedConfig | config} for command's `input` shape. + * */ export class ListTagsForResourceCommand extends $Command< ListTagsForResourceCommandInput, diff --git a/clients/client-iotsecuretunneling/commands/ListTunnelsCommand.ts b/clients/client-iotsecuretunneling/commands/ListTunnelsCommand.ts index a9cf47226ca0..c8ea7d038876 100644 --- a/clients/client-iotsecuretunneling/commands/ListTunnelsCommand.ts +++ b/clients/client-iotsecuretunneling/commands/ListTunnelsCommand.ts @@ -27,6 +27,20 @@ export interface ListTunnelsCommandOutput extends ListTunnelsResponse, __Metadat /** *

List all tunnels for an AWS account. Tunnels are listed by creation time in * descending order, newer tunnels will be listed before older tunnels.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { IoTSecureTunnelingClient, ListTunnelsCommand } from "@aws-sdk/client-iotsecuretunneling"; // ES Modules import + * // const { IoTSecureTunnelingClient, ListTunnelsCommand } = require("@aws-sdk/client-iotsecuretunneling"); // CommonJS import + * const client = new IoTSecureTunnelingClient(config); + * const command = new ListTunnelsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListTunnelsCommandInput} for command's `input` shape. + * @see {@link ListTunnelsCommandOutput} for command's `response` shape. + * @see {@link IoTSecureTunnelingClientResolvedConfig | config} for command's `input` shape. + * */ export class ListTunnelsCommand extends $Command< ListTunnelsCommandInput, diff --git a/clients/client-iotsecuretunneling/commands/OpenTunnelCommand.ts b/clients/client-iotsecuretunneling/commands/OpenTunnelCommand.ts index b0697d6032a5..f9935fd73a62 100644 --- a/clients/client-iotsecuretunneling/commands/OpenTunnelCommand.ts +++ b/clients/client-iotsecuretunneling/commands/OpenTunnelCommand.ts @@ -27,6 +27,20 @@ export interface OpenTunnelCommandOutput extends OpenTunnelResponse, __MetadataB /** *

Creates a new tunnel, and returns two client access tokens for clients to use to * connect to the AWS IoT Secure Tunneling proxy server.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { IoTSecureTunnelingClient, OpenTunnelCommand } from "@aws-sdk/client-iotsecuretunneling"; // ES Modules import + * // const { IoTSecureTunnelingClient, OpenTunnelCommand } = require("@aws-sdk/client-iotsecuretunneling"); // CommonJS import + * const client = new IoTSecureTunnelingClient(config); + * const command = new OpenTunnelCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link OpenTunnelCommandInput} for command's `input` shape. + * @see {@link OpenTunnelCommandOutput} for command's `response` shape. + * @see {@link IoTSecureTunnelingClientResolvedConfig | config} for command's `input` shape. + * */ export class OpenTunnelCommand extends $Command< OpenTunnelCommandInput, diff --git a/clients/client-iotsecuretunneling/commands/TagResourceCommand.ts b/clients/client-iotsecuretunneling/commands/TagResourceCommand.ts index 3a32572c4246..2e48c3dc0466 100644 --- a/clients/client-iotsecuretunneling/commands/TagResourceCommand.ts +++ b/clients/client-iotsecuretunneling/commands/TagResourceCommand.ts @@ -26,6 +26,20 @@ export interface TagResourceCommandOutput extends TagResourceResponse, __Metadat /** *

A resource tag.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { IoTSecureTunnelingClient, TagResourceCommand } from "@aws-sdk/client-iotsecuretunneling"; // ES Modules import + * // const { IoTSecureTunnelingClient, TagResourceCommand } = require("@aws-sdk/client-iotsecuretunneling"); // CommonJS import + * const client = new IoTSecureTunnelingClient(config); + * const command = new TagResourceCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link TagResourceCommandInput} for command's `input` shape. + * @see {@link TagResourceCommandOutput} for command's `response` shape. + * @see {@link IoTSecureTunnelingClientResolvedConfig | config} for command's `input` shape. + * */ export class TagResourceCommand extends $Command< TagResourceCommandInput, diff --git a/clients/client-iotsecuretunneling/commands/UntagResourceCommand.ts b/clients/client-iotsecuretunneling/commands/UntagResourceCommand.ts index 621ae02c9213..a4c437dbe97c 100644 --- a/clients/client-iotsecuretunneling/commands/UntagResourceCommand.ts +++ b/clients/client-iotsecuretunneling/commands/UntagResourceCommand.ts @@ -26,6 +26,20 @@ export interface UntagResourceCommandOutput extends UntagResourceResponse, __Met /** *

Removes a tag from a resource.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { IoTSecureTunnelingClient, UntagResourceCommand } from "@aws-sdk/client-iotsecuretunneling"; // ES Modules import + * // const { IoTSecureTunnelingClient, UntagResourceCommand } = require("@aws-sdk/client-iotsecuretunneling"); // CommonJS import + * const client = new IoTSecureTunnelingClient(config); + * const command = new UntagResourceCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link UntagResourceCommandInput} for command's `input` shape. + * @see {@link UntagResourceCommandOutput} for command's `response` shape. + * @see {@link IoTSecureTunnelingClientResolvedConfig | config} for command's `input` shape. + * */ export class UntagResourceCommand extends $Command< UntagResourceCommandInput, diff --git a/clients/client-iotsecuretunneling/models/models_0.ts b/clients/client-iotsecuretunneling/models/models_0.ts index e18d196fa492..43856fe9a6da 100644 --- a/clients/client-iotsecuretunneling/models/models_0.ts +++ b/clients/client-iotsecuretunneling/models/models_0.ts @@ -15,6 +15,9 @@ export interface CloseTunnelRequest { } export namespace CloseTunnelRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: CloseTunnelRequest): any => ({ ...obj, }); @@ -23,6 +26,9 @@ export namespace CloseTunnelRequest { export interface CloseTunnelResponse {} export namespace CloseTunnelResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: CloseTunnelResponse): any => ({ ...obj, }); @@ -38,6 +44,9 @@ export interface ResourceNotFoundException extends __SmithyException, $MetadataB } export namespace ResourceNotFoundException { + /** + * @internal + */ export const filterSensitiveLog = (obj: ResourceNotFoundException): any => ({ ...obj, }); @@ -65,6 +74,9 @@ export interface ConnectionState { } export namespace ConnectionState { + /** + * @internal + */ export const filterSensitiveLog = (obj: ConnectionState): any => ({ ...obj, }); @@ -78,6 +90,9 @@ export interface DescribeTunnelRequest { } export namespace DescribeTunnelRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeTunnelRequest): any => ({ ...obj, }); @@ -102,6 +117,9 @@ export interface DestinationConfig { } export namespace DestinationConfig { + /** + * @internal + */ export const filterSensitiveLog = (obj: DestinationConfig): any => ({ ...obj, }); @@ -129,6 +147,9 @@ export interface Tag { } export namespace Tag { + /** + * @internal + */ export const filterSensitiveLog = (obj: Tag): any => ({ ...obj, }); @@ -147,6 +168,9 @@ export interface TimeoutConfig { } export namespace TimeoutConfig { + /** + * @internal + */ export const filterSensitiveLog = (obj: TimeoutConfig): any => ({ ...obj, }); @@ -217,6 +241,9 @@ export interface Tunnel { } export namespace Tunnel { + /** + * @internal + */ export const filterSensitiveLog = (obj: Tunnel): any => ({ ...obj, }); @@ -230,6 +257,9 @@ export interface DescribeTunnelResponse { } export namespace DescribeTunnelResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeTunnelResponse): any => ({ ...obj, }); @@ -243,6 +273,9 @@ export interface ListTagsForResourceRequest { } export namespace ListTagsForResourceRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListTagsForResourceRequest): any => ({ ...obj, }); @@ -256,6 +289,9 @@ export interface ListTagsForResourceResponse { } export namespace ListTagsForResourceResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListTagsForResourceResponse): any => ({ ...obj, }); @@ -279,6 +315,9 @@ export interface ListTunnelsRequest { } export namespace ListTunnelsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListTunnelsRequest): any => ({ ...obj, }); @@ -322,6 +361,9 @@ export interface TunnelSummary { } export namespace TunnelSummary { + /** + * @internal + */ export const filterSensitiveLog = (obj: TunnelSummary): any => ({ ...obj, }); @@ -340,6 +382,9 @@ export interface ListTunnelsResponse { } export namespace ListTunnelsResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListTunnelsResponse): any => ({ ...obj, }); @@ -355,6 +400,9 @@ export interface LimitExceededException extends __SmithyException, $MetadataBear } export namespace LimitExceededException { + /** + * @internal + */ export const filterSensitiveLog = (obj: LimitExceededException): any => ({ ...obj, }); @@ -383,6 +431,9 @@ export interface OpenTunnelRequest { } export namespace OpenTunnelRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: OpenTunnelRequest): any => ({ ...obj, }); @@ -415,6 +466,9 @@ export interface OpenTunnelResponse { } export namespace OpenTunnelResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: OpenTunnelResponse): any => ({ ...obj, ...(obj.sourceAccessToken && { sourceAccessToken: SENSITIVE_STRING }), @@ -435,6 +489,9 @@ export interface TagResourceRequest { } export namespace TagResourceRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: TagResourceRequest): any => ({ ...obj, }); @@ -443,6 +500,9 @@ export namespace TagResourceRequest { export interface TagResourceResponse {} export namespace TagResourceResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: TagResourceResponse): any => ({ ...obj, }); @@ -461,6 +521,9 @@ export interface UntagResourceRequest { } export namespace UntagResourceRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: UntagResourceRequest): any => ({ ...obj, }); @@ -469,6 +532,9 @@ export namespace UntagResourceRequest { export interface UntagResourceResponse {} export namespace UntagResourceResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: UntagResourceResponse): any => ({ ...obj, }); diff --git a/clients/client-iotsitewise/commands/AssociateAssetsCommand.ts b/clients/client-iotsitewise/commands/AssociateAssetsCommand.ts index 682ae0c5f508..3d52fb2384d6 100644 --- a/clients/client-iotsitewise/commands/AssociateAssetsCommand.ts +++ b/clients/client-iotsitewise/commands/AssociateAssetsCommand.ts @@ -24,6 +24,20 @@ export interface AssociateAssetsCommandOutput extends __MetadataBearer {} *

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 * AWS IoT SiteWise User Guide.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { IoTSiteWiseClient, AssociateAssetsCommand } from "@aws-sdk/client-iotsitewise"; // ES Modules import + * // const { IoTSiteWiseClient, AssociateAssetsCommand } = require("@aws-sdk/client-iotsitewise"); // CommonJS import + * const client = new IoTSiteWiseClient(config); + * const command = new AssociateAssetsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link AssociateAssetsCommandInput} for command's `input` shape. + * @see {@link AssociateAssetsCommandOutput} for command's `response` shape. + * @see {@link IoTSiteWiseClientResolvedConfig | config} for command's `input` shape. + * */ export class AssociateAssetsCommand extends $Command< AssociateAssetsCommandInput, diff --git a/clients/client-iotsitewise/commands/BatchAssociateProjectAssetsCommand.ts b/clients/client-iotsitewise/commands/BatchAssociateProjectAssetsCommand.ts index 54edf1ccd4c0..e14bd45ae024 100644 --- a/clients/client-iotsitewise/commands/BatchAssociateProjectAssetsCommand.ts +++ b/clients/client-iotsitewise/commands/BatchAssociateProjectAssetsCommand.ts @@ -24,6 +24,20 @@ export interface BatchAssociateProjectAssetsCommandOutput /** *

Associates a group (batch) of assets with an AWS IoT SiteWise Monitor project.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { IoTSiteWiseClient, BatchAssociateProjectAssetsCommand } from "@aws-sdk/client-iotsitewise"; // ES Modules import + * // const { IoTSiteWiseClient, BatchAssociateProjectAssetsCommand } = require("@aws-sdk/client-iotsitewise"); // CommonJS import + * const client = new IoTSiteWiseClient(config); + * const command = new BatchAssociateProjectAssetsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link BatchAssociateProjectAssetsCommandInput} for command's `input` shape. + * @see {@link BatchAssociateProjectAssetsCommandOutput} for command's `response` shape. + * @see {@link IoTSiteWiseClientResolvedConfig | config} for command's `input` shape. + * */ export class BatchAssociateProjectAssetsCommand extends $Command< BatchAssociateProjectAssetsCommandInput, diff --git a/clients/client-iotsitewise/commands/BatchDisassociateProjectAssetsCommand.ts b/clients/client-iotsitewise/commands/BatchDisassociateProjectAssetsCommand.ts index 2ba5b1143dd2..05de9330cdb8 100644 --- a/clients/client-iotsitewise/commands/BatchDisassociateProjectAssetsCommand.ts +++ b/clients/client-iotsitewise/commands/BatchDisassociateProjectAssetsCommand.ts @@ -24,6 +24,20 @@ export interface BatchDisassociateProjectAssetsCommandOutput /** *

Disassociates a group (batch) of assets from an AWS IoT SiteWise Monitor project.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { IoTSiteWiseClient, BatchDisassociateProjectAssetsCommand } from "@aws-sdk/client-iotsitewise"; // ES Modules import + * // const { IoTSiteWiseClient, BatchDisassociateProjectAssetsCommand } = require("@aws-sdk/client-iotsitewise"); // CommonJS import + * const client = new IoTSiteWiseClient(config); + * const command = new BatchDisassociateProjectAssetsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link BatchDisassociateProjectAssetsCommandInput} for command's `input` shape. + * @see {@link BatchDisassociateProjectAssetsCommandOutput} for command's `response` shape. + * @see {@link IoTSiteWiseClientResolvedConfig | config} for command's `input` shape. + * */ export class BatchDisassociateProjectAssetsCommand extends $Command< BatchDisassociateProjectAssetsCommandInput, diff --git a/clients/client-iotsitewise/commands/BatchPutAssetPropertyValueCommand.ts b/clients/client-iotsitewise/commands/BatchPutAssetPropertyValueCommand.ts index 90a9f33aeff2..4bd13eb74905 100644 --- a/clients/client-iotsitewise/commands/BatchPutAssetPropertyValueCommand.ts +++ b/clients/client-iotsitewise/commands/BatchPutAssetPropertyValueCommand.ts @@ -46,6 +46,20 @@ export interface BatchPutAssetPropertyValueCommandOutput extends BatchPutAssetPr *

AWS IoT SiteWise authorizes access to each BatchPutAssetPropertyValue entry individually. * For more information, see BatchPutAssetPropertyValue authorization in the * AWS IoT SiteWise User Guide.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { IoTSiteWiseClient, BatchPutAssetPropertyValueCommand } from "@aws-sdk/client-iotsitewise"; // ES Modules import + * // const { IoTSiteWiseClient, BatchPutAssetPropertyValueCommand } = require("@aws-sdk/client-iotsitewise"); // CommonJS import + * const client = new IoTSiteWiseClient(config); + * const command = new BatchPutAssetPropertyValueCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link BatchPutAssetPropertyValueCommandInput} for command's `input` shape. + * @see {@link BatchPutAssetPropertyValueCommandOutput} for command's `response` shape. + * @see {@link IoTSiteWiseClientResolvedConfig | config} for command's `input` shape. + * */ export class BatchPutAssetPropertyValueCommand extends $Command< BatchPutAssetPropertyValueCommandInput, diff --git a/clients/client-iotsitewise/commands/CreateAccessPolicyCommand.ts b/clients/client-iotsitewise/commands/CreateAccessPolicyCommand.ts index 943c7ff3c363..3fca15259c13 100644 --- a/clients/client-iotsitewise/commands/CreateAccessPolicyCommand.ts +++ b/clients/client-iotsitewise/commands/CreateAccessPolicyCommand.ts @@ -23,6 +23,20 @@ export interface CreateAccessPolicyCommandOutput extends CreateAccessPolicyRespo /** *

Creates an access policy that grants the specified identity (AWS SSO user, AWS SSO group, or * IAM user) access to the specified AWS IoT SiteWise Monitor portal or project resource.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { IoTSiteWiseClient, CreateAccessPolicyCommand } from "@aws-sdk/client-iotsitewise"; // ES Modules import + * // const { IoTSiteWiseClient, CreateAccessPolicyCommand } = require("@aws-sdk/client-iotsitewise"); // CommonJS import + * const client = new IoTSiteWiseClient(config); + * const command = new CreateAccessPolicyCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreateAccessPolicyCommandInput} for command's `input` shape. + * @see {@link CreateAccessPolicyCommandOutput} for command's `response` shape. + * @see {@link IoTSiteWiseClientResolvedConfig | config} for command's `input` shape. + * */ export class CreateAccessPolicyCommand extends $Command< CreateAccessPolicyCommandInput, diff --git a/clients/client-iotsitewise/commands/CreateAssetCommand.ts b/clients/client-iotsitewise/commands/CreateAssetCommand.ts index 97088571947e..b246e35866b4 100644 --- a/clients/client-iotsitewise/commands/CreateAssetCommand.ts +++ b/clients/client-iotsitewise/commands/CreateAssetCommand.ts @@ -23,6 +23,20 @@ export interface CreateAssetCommandOutput extends CreateAssetResponse, __Metadat /** *

Creates an asset from an existing asset model. For more information, see Creating assets in the * AWS IoT SiteWise User Guide.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { IoTSiteWiseClient, CreateAssetCommand } from "@aws-sdk/client-iotsitewise"; // ES Modules import + * // const { IoTSiteWiseClient, CreateAssetCommand } = require("@aws-sdk/client-iotsitewise"); // CommonJS import + * const client = new IoTSiteWiseClient(config); + * const command = new CreateAssetCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreateAssetCommandInput} for command's `input` shape. + * @see {@link CreateAssetCommandOutput} for command's `response` shape. + * @see {@link IoTSiteWiseClientResolvedConfig | config} for command's `input` shape. + * */ export class CreateAssetCommand extends $Command< CreateAssetCommandInput, diff --git a/clients/client-iotsitewise/commands/CreateAssetModelCommand.ts b/clients/client-iotsitewise/commands/CreateAssetModelCommand.ts index 5509ec4bfe93..3d971a73da55 100644 --- a/clients/client-iotsitewise/commands/CreateAssetModelCommand.ts +++ b/clients/client-iotsitewise/commands/CreateAssetModelCommand.ts @@ -26,6 +26,20 @@ export interface CreateAssetModelCommandOutput extends CreateAssetModelResponse, * 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 * AWS IoT SiteWise User Guide.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { IoTSiteWiseClient, CreateAssetModelCommand } from "@aws-sdk/client-iotsitewise"; // ES Modules import + * // const { IoTSiteWiseClient, CreateAssetModelCommand } = require("@aws-sdk/client-iotsitewise"); // CommonJS import + * const client = new IoTSiteWiseClient(config); + * const command = new CreateAssetModelCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreateAssetModelCommandInput} for command's `input` shape. + * @see {@link CreateAssetModelCommandOutput} for command's `response` shape. + * @see {@link IoTSiteWiseClientResolvedConfig | config} for command's `input` shape. + * */ export class CreateAssetModelCommand extends $Command< CreateAssetModelCommandInput, diff --git a/clients/client-iotsitewise/commands/CreateDashboardCommand.ts b/clients/client-iotsitewise/commands/CreateDashboardCommand.ts index db6c32ead4b2..f22c658ce376 100644 --- a/clients/client-iotsitewise/commands/CreateDashboardCommand.ts +++ b/clients/client-iotsitewise/commands/CreateDashboardCommand.ts @@ -22,6 +22,20 @@ export interface CreateDashboardCommandOutput extends CreateDashboardResponse, _ /** *

Creates a dashboard in an AWS IoT SiteWise Monitor project.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { IoTSiteWiseClient, CreateDashboardCommand } from "@aws-sdk/client-iotsitewise"; // ES Modules import + * // const { IoTSiteWiseClient, CreateDashboardCommand } = require("@aws-sdk/client-iotsitewise"); // CommonJS import + * const client = new IoTSiteWiseClient(config); + * const command = new CreateDashboardCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreateDashboardCommandInput} for command's `input` shape. + * @see {@link CreateDashboardCommandOutput} for command's `response` shape. + * @see {@link IoTSiteWiseClientResolvedConfig | config} for command's `input` shape. + * */ export class CreateDashboardCommand extends $Command< CreateDashboardCommandInput, diff --git a/clients/client-iotsitewise/commands/CreateGatewayCommand.ts b/clients/client-iotsitewise/commands/CreateGatewayCommand.ts index 554cb31d89b3..358886b439b0 100644 --- a/clients/client-iotsitewise/commands/CreateGatewayCommand.ts +++ b/clients/client-iotsitewise/commands/CreateGatewayCommand.ts @@ -24,6 +24,20 @@ export interface CreateGatewayCommandOutput extends CreateGatewayResponse, __Met *

Creates a gateway, which is a virtual or edge device that delivers industrial data streams * from local servers to AWS IoT SiteWise. For more information, see Ingesting data using a gateway in the * AWS IoT SiteWise User Guide.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { IoTSiteWiseClient, CreateGatewayCommand } from "@aws-sdk/client-iotsitewise"; // ES Modules import + * // const { IoTSiteWiseClient, CreateGatewayCommand } = require("@aws-sdk/client-iotsitewise"); // CommonJS import + * const client = new IoTSiteWiseClient(config); + * const command = new CreateGatewayCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreateGatewayCommandInput} for command's `input` shape. + * @see {@link CreateGatewayCommandOutput} for command's `response` shape. + * @see {@link IoTSiteWiseClientResolvedConfig | config} for command's `input` shape. + * */ export class CreateGatewayCommand extends $Command< CreateGatewayCommandInput, diff --git a/clients/client-iotsitewise/commands/CreatePortalCommand.ts b/clients/client-iotsitewise/commands/CreatePortalCommand.ts index 0b71f970a4f7..ff82634f5f3e 100644 --- a/clients/client-iotsitewise/commands/CreatePortalCommand.ts +++ b/clients/client-iotsitewise/commands/CreatePortalCommand.ts @@ -28,6 +28,20 @@ export interface CreatePortalCommandOutput extends CreatePortalResponse, __Metad * portal. For more information, see Adding or removing portal * administrators in the AWS IoT SiteWise User Guide.

* + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { IoTSiteWiseClient, CreatePortalCommand } from "@aws-sdk/client-iotsitewise"; // ES Modules import + * // const { IoTSiteWiseClient, CreatePortalCommand } = require("@aws-sdk/client-iotsitewise"); // CommonJS import + * const client = new IoTSiteWiseClient(config); + * const command = new CreatePortalCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreatePortalCommandInput} for command's `input` shape. + * @see {@link CreatePortalCommandOutput} for command's `response` shape. + * @see {@link IoTSiteWiseClientResolvedConfig | config} for command's `input` shape. + * */ export class CreatePortalCommand extends $Command< CreatePortalCommandInput, diff --git a/clients/client-iotsitewise/commands/CreateProjectCommand.ts b/clients/client-iotsitewise/commands/CreateProjectCommand.ts index 94bbd6b37097..590a6af2573c 100644 --- a/clients/client-iotsitewise/commands/CreateProjectCommand.ts +++ b/clients/client-iotsitewise/commands/CreateProjectCommand.ts @@ -22,6 +22,20 @@ export interface CreateProjectCommandOutput extends CreateProjectResponse, __Met /** *

Creates a project in the specified portal.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { IoTSiteWiseClient, CreateProjectCommand } from "@aws-sdk/client-iotsitewise"; // ES Modules import + * // const { IoTSiteWiseClient, CreateProjectCommand } = require("@aws-sdk/client-iotsitewise"); // CommonJS import + * const client = new IoTSiteWiseClient(config); + * const command = new CreateProjectCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreateProjectCommandInput} for command's `input` shape. + * @see {@link CreateProjectCommandOutput} for command's `response` shape. + * @see {@link IoTSiteWiseClientResolvedConfig | config} for command's `input` shape. + * */ export class CreateProjectCommand extends $Command< CreateProjectCommandInput, diff --git a/clients/client-iotsitewise/commands/DeleteAccessPolicyCommand.ts b/clients/client-iotsitewise/commands/DeleteAccessPolicyCommand.ts index 39be7c37b694..1b2b8c3d0d4a 100644 --- a/clients/client-iotsitewise/commands/DeleteAccessPolicyCommand.ts +++ b/clients/client-iotsitewise/commands/DeleteAccessPolicyCommand.ts @@ -24,6 +24,20 @@ export interface DeleteAccessPolicyCommandOutput extends DeleteAccessPolicyRespo *

Deletes an access policy that grants the specified identity access to the specified * AWS IoT SiteWise Monitor resource. You can use this operation to revoke access to an AWS IoT SiteWise Monitor * resource.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { IoTSiteWiseClient, DeleteAccessPolicyCommand } from "@aws-sdk/client-iotsitewise"; // ES Modules import + * // const { IoTSiteWiseClient, DeleteAccessPolicyCommand } = require("@aws-sdk/client-iotsitewise"); // CommonJS import + * const client = new IoTSiteWiseClient(config); + * const command = new DeleteAccessPolicyCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteAccessPolicyCommandInput} for command's `input` shape. + * @see {@link DeleteAccessPolicyCommandOutput} for command's `response` shape. + * @see {@link IoTSiteWiseClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteAccessPolicyCommand extends $Command< DeleteAccessPolicyCommandInput, diff --git a/clients/client-iotsitewise/commands/DeleteAssetCommand.ts b/clients/client-iotsitewise/commands/DeleteAssetCommand.ts index 135f230b05de..df0e67fdd7f4 100644 --- a/clients/client-iotsitewise/commands/DeleteAssetCommand.ts +++ b/clients/client-iotsitewise/commands/DeleteAssetCommand.ts @@ -28,6 +28,20 @@ export interface DeleteAssetCommandOutput extends DeleteAssetResponse, __Metadat *

You can't delete an asset that's associated to another asset. For more information, see * DisassociateAssets.

* + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { IoTSiteWiseClient, DeleteAssetCommand } from "@aws-sdk/client-iotsitewise"; // ES Modules import + * // const { IoTSiteWiseClient, DeleteAssetCommand } = require("@aws-sdk/client-iotsitewise"); // CommonJS import + * const client = new IoTSiteWiseClient(config); + * const command = new DeleteAssetCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteAssetCommandInput} for command's `input` shape. + * @see {@link DeleteAssetCommandOutput} for command's `response` shape. + * @see {@link IoTSiteWiseClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteAssetCommand extends $Command< DeleteAssetCommandInput, diff --git a/clients/client-iotsitewise/commands/DeleteAssetModelCommand.ts b/clients/client-iotsitewise/commands/DeleteAssetModelCommand.ts index 6e73b422be32..2d7ed467f630 100644 --- a/clients/client-iotsitewise/commands/DeleteAssetModelCommand.ts +++ b/clients/client-iotsitewise/commands/DeleteAssetModelCommand.ts @@ -26,6 +26,20 @@ export interface DeleteAssetModelCommandOutput extends DeleteAssetModelResponse, * 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 * AWS IoT SiteWise User Guide.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { IoTSiteWiseClient, DeleteAssetModelCommand } from "@aws-sdk/client-iotsitewise"; // ES Modules import + * // const { IoTSiteWiseClient, DeleteAssetModelCommand } = require("@aws-sdk/client-iotsitewise"); // CommonJS import + * const client = new IoTSiteWiseClient(config); + * const command = new DeleteAssetModelCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteAssetModelCommandInput} for command's `input` shape. + * @see {@link DeleteAssetModelCommandOutput} for command's `response` shape. + * @see {@link IoTSiteWiseClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteAssetModelCommand extends $Command< DeleteAssetModelCommandInput, diff --git a/clients/client-iotsitewise/commands/DeleteDashboardCommand.ts b/clients/client-iotsitewise/commands/DeleteDashboardCommand.ts index abe5f71d3d2c..8f9c2fb06658 100644 --- a/clients/client-iotsitewise/commands/DeleteDashboardCommand.ts +++ b/clients/client-iotsitewise/commands/DeleteDashboardCommand.ts @@ -22,6 +22,20 @@ export interface DeleteDashboardCommandOutput extends DeleteDashboardResponse, _ /** *

Deletes a dashboard from AWS IoT SiteWise Monitor.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { IoTSiteWiseClient, DeleteDashboardCommand } from "@aws-sdk/client-iotsitewise"; // ES Modules import + * // const { IoTSiteWiseClient, DeleteDashboardCommand } = require("@aws-sdk/client-iotsitewise"); // CommonJS import + * const client = new IoTSiteWiseClient(config); + * const command = new DeleteDashboardCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteDashboardCommandInput} for command's `input` shape. + * @see {@link DeleteDashboardCommandOutput} for command's `response` shape. + * @see {@link IoTSiteWiseClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteDashboardCommand extends $Command< DeleteDashboardCommandInput, diff --git a/clients/client-iotsitewise/commands/DeleteGatewayCommand.ts b/clients/client-iotsitewise/commands/DeleteGatewayCommand.ts index 22ca2517b522..84e51081ffc5 100644 --- a/clients/client-iotsitewise/commands/DeleteGatewayCommand.ts +++ b/clients/client-iotsitewise/commands/DeleteGatewayCommand.ts @@ -23,6 +23,20 @@ export interface DeleteGatewayCommandOutput extends __MetadataBearer {} /** *

Deletes a gateway from AWS IoT SiteWise. When you delete a gateway, some of the gateway's files remain * in your gateway's file system.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { IoTSiteWiseClient, DeleteGatewayCommand } from "@aws-sdk/client-iotsitewise"; // ES Modules import + * // const { IoTSiteWiseClient, DeleteGatewayCommand } = require("@aws-sdk/client-iotsitewise"); // CommonJS import + * const client = new IoTSiteWiseClient(config); + * const command = new DeleteGatewayCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteGatewayCommandInput} for command's `input` shape. + * @see {@link DeleteGatewayCommandOutput} for command's `response` shape. + * @see {@link IoTSiteWiseClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteGatewayCommand extends $Command< DeleteGatewayCommandInput, diff --git a/clients/client-iotsitewise/commands/DeletePortalCommand.ts b/clients/client-iotsitewise/commands/DeletePortalCommand.ts index cbcaf55769d5..34f7556c8cef 100644 --- a/clients/client-iotsitewise/commands/DeletePortalCommand.ts +++ b/clients/client-iotsitewise/commands/DeletePortalCommand.ts @@ -22,6 +22,20 @@ export interface DeletePortalCommandOutput extends DeletePortalResponse, __Metad /** *

Deletes a portal from AWS IoT SiteWise Monitor.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { IoTSiteWiseClient, DeletePortalCommand } from "@aws-sdk/client-iotsitewise"; // ES Modules import + * // const { IoTSiteWiseClient, DeletePortalCommand } = require("@aws-sdk/client-iotsitewise"); // CommonJS import + * const client = new IoTSiteWiseClient(config); + * const command = new DeletePortalCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeletePortalCommandInput} for command's `input` shape. + * @see {@link DeletePortalCommandOutput} for command's `response` shape. + * @see {@link IoTSiteWiseClientResolvedConfig | config} for command's `input` shape. + * */ export class DeletePortalCommand extends $Command< DeletePortalCommandInput, diff --git a/clients/client-iotsitewise/commands/DeleteProjectCommand.ts b/clients/client-iotsitewise/commands/DeleteProjectCommand.ts index 0867b8318a4e..802687dbdcde 100644 --- a/clients/client-iotsitewise/commands/DeleteProjectCommand.ts +++ b/clients/client-iotsitewise/commands/DeleteProjectCommand.ts @@ -22,6 +22,20 @@ export interface DeleteProjectCommandOutput extends DeleteProjectResponse, __Met /** *

Deletes a project from AWS IoT SiteWise Monitor.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { IoTSiteWiseClient, DeleteProjectCommand } from "@aws-sdk/client-iotsitewise"; // ES Modules import + * // const { IoTSiteWiseClient, DeleteProjectCommand } = require("@aws-sdk/client-iotsitewise"); // CommonJS import + * const client = new IoTSiteWiseClient(config); + * const command = new DeleteProjectCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteProjectCommandInput} for command's `input` shape. + * @see {@link DeleteProjectCommandOutput} for command's `response` shape. + * @see {@link IoTSiteWiseClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteProjectCommand extends $Command< DeleteProjectCommandInput, diff --git a/clients/client-iotsitewise/commands/DescribeAccessPolicyCommand.ts b/clients/client-iotsitewise/commands/DescribeAccessPolicyCommand.ts index eff74b3092d9..7fbd73ee963d 100644 --- a/clients/client-iotsitewise/commands/DescribeAccessPolicyCommand.ts +++ b/clients/client-iotsitewise/commands/DescribeAccessPolicyCommand.ts @@ -23,6 +23,20 @@ export interface DescribeAccessPolicyCommandOutput extends DescribeAccessPolicyR /** *

Describes an access policy, which specifies an identity's access to an AWS IoT SiteWise Monitor portal or * project.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { IoTSiteWiseClient, DescribeAccessPolicyCommand } from "@aws-sdk/client-iotsitewise"; // ES Modules import + * // const { IoTSiteWiseClient, DescribeAccessPolicyCommand } = require("@aws-sdk/client-iotsitewise"); // CommonJS import + * const client = new IoTSiteWiseClient(config); + * const command = new DescribeAccessPolicyCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeAccessPolicyCommandInput} for command's `input` shape. + * @see {@link DescribeAccessPolicyCommandOutput} for command's `response` shape. + * @see {@link IoTSiteWiseClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeAccessPolicyCommand extends $Command< DescribeAccessPolicyCommandInput, diff --git a/clients/client-iotsitewise/commands/DescribeAssetCommand.ts b/clients/client-iotsitewise/commands/DescribeAssetCommand.ts index 16cc58f45900..47688e207081 100644 --- a/clients/client-iotsitewise/commands/DescribeAssetCommand.ts +++ b/clients/client-iotsitewise/commands/DescribeAssetCommand.ts @@ -22,6 +22,20 @@ export interface DescribeAssetCommandOutput extends DescribeAssetResponse, __Met /** *

Retrieves information about an asset.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { IoTSiteWiseClient, DescribeAssetCommand } from "@aws-sdk/client-iotsitewise"; // ES Modules import + * // const { IoTSiteWiseClient, DescribeAssetCommand } = require("@aws-sdk/client-iotsitewise"); // CommonJS import + * const client = new IoTSiteWiseClient(config); + * const command = new DescribeAssetCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeAssetCommandInput} for command's `input` shape. + * @see {@link DescribeAssetCommandOutput} for command's `response` shape. + * @see {@link IoTSiteWiseClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeAssetCommand extends $Command< DescribeAssetCommandInput, diff --git a/clients/client-iotsitewise/commands/DescribeAssetModelCommand.ts b/clients/client-iotsitewise/commands/DescribeAssetModelCommand.ts index 475e481f29b9..a21f3d424d27 100644 --- a/clients/client-iotsitewise/commands/DescribeAssetModelCommand.ts +++ b/clients/client-iotsitewise/commands/DescribeAssetModelCommand.ts @@ -22,6 +22,20 @@ export interface DescribeAssetModelCommandOutput extends DescribeAssetModelRespo /** *

Retrieves information about an asset model.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { IoTSiteWiseClient, DescribeAssetModelCommand } from "@aws-sdk/client-iotsitewise"; // ES Modules import + * // const { IoTSiteWiseClient, DescribeAssetModelCommand } = require("@aws-sdk/client-iotsitewise"); // CommonJS import + * const client = new IoTSiteWiseClient(config); + * const command = new DescribeAssetModelCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeAssetModelCommandInput} for command's `input` shape. + * @see {@link DescribeAssetModelCommandOutput} for command's `response` shape. + * @see {@link IoTSiteWiseClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeAssetModelCommand extends $Command< DescribeAssetModelCommandInput, diff --git a/clients/client-iotsitewise/commands/DescribeAssetPropertyCommand.ts b/clients/client-iotsitewise/commands/DescribeAssetPropertyCommand.ts index 50317e84570e..a1cb068aaaed 100644 --- a/clients/client-iotsitewise/commands/DescribeAssetPropertyCommand.ts +++ b/clients/client-iotsitewise/commands/DescribeAssetPropertyCommand.ts @@ -29,6 +29,20 @@ export interface DescribeAssetPropertyCommandOutput extends DescribeAssetPropert * *

This operation doesn't return the value of the asset property. To get the value of an * asset property, use GetAssetPropertyValue.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { IoTSiteWiseClient, DescribeAssetPropertyCommand } from "@aws-sdk/client-iotsitewise"; // ES Modules import + * // const { IoTSiteWiseClient, DescribeAssetPropertyCommand } = require("@aws-sdk/client-iotsitewise"); // CommonJS import + * const client = new IoTSiteWiseClient(config); + * const command = new DescribeAssetPropertyCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeAssetPropertyCommandInput} for command's `input` shape. + * @see {@link DescribeAssetPropertyCommandOutput} for command's `response` shape. + * @see {@link IoTSiteWiseClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeAssetPropertyCommand extends $Command< DescribeAssetPropertyCommandInput, diff --git a/clients/client-iotsitewise/commands/DescribeDashboardCommand.ts b/clients/client-iotsitewise/commands/DescribeDashboardCommand.ts index 7f3e1683eb11..f33fed7c2862 100644 --- a/clients/client-iotsitewise/commands/DescribeDashboardCommand.ts +++ b/clients/client-iotsitewise/commands/DescribeDashboardCommand.ts @@ -22,6 +22,20 @@ export interface DescribeDashboardCommandOutput extends DescribeDashboardRespons /** *

Retrieves information about a dashboard.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { IoTSiteWiseClient, DescribeDashboardCommand } from "@aws-sdk/client-iotsitewise"; // ES Modules import + * // const { IoTSiteWiseClient, DescribeDashboardCommand } = require("@aws-sdk/client-iotsitewise"); // CommonJS import + * const client = new IoTSiteWiseClient(config); + * const command = new DescribeDashboardCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeDashboardCommandInput} for command's `input` shape. + * @see {@link DescribeDashboardCommandOutput} for command's `response` shape. + * @see {@link IoTSiteWiseClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeDashboardCommand extends $Command< DescribeDashboardCommandInput, diff --git a/clients/client-iotsitewise/commands/DescribeDefaultEncryptionConfigurationCommand.ts b/clients/client-iotsitewise/commands/DescribeDefaultEncryptionConfigurationCommand.ts index 9d76df4aad14..38fbe3f0f222 100644 --- a/clients/client-iotsitewise/commands/DescribeDefaultEncryptionConfigurationCommand.ts +++ b/clients/client-iotsitewise/commands/DescribeDefaultEncryptionConfigurationCommand.ts @@ -30,6 +30,20 @@ export interface DescribeDefaultEncryptionConfigurationCommandOutput *

Retrieves information about the default encryption configuration for the * AWS account in the default or specified region. For more information, see Key management * in the AWS IoT SiteWise User Guide.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { IoTSiteWiseClient, DescribeDefaultEncryptionConfigurationCommand } from "@aws-sdk/client-iotsitewise"; // ES Modules import + * // const { IoTSiteWiseClient, DescribeDefaultEncryptionConfigurationCommand } = require("@aws-sdk/client-iotsitewise"); // CommonJS import + * const client = new IoTSiteWiseClient(config); + * const command = new DescribeDefaultEncryptionConfigurationCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeDefaultEncryptionConfigurationCommandInput} for command's `input` shape. + * @see {@link DescribeDefaultEncryptionConfigurationCommandOutput} for command's `response` shape. + * @see {@link IoTSiteWiseClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeDefaultEncryptionConfigurationCommand extends $Command< DescribeDefaultEncryptionConfigurationCommandInput, diff --git a/clients/client-iotsitewise/commands/DescribeGatewayCapabilityConfigurationCommand.ts b/clients/client-iotsitewise/commands/DescribeGatewayCapabilityConfigurationCommand.ts index 1cde04d85f0a..d8ebffd393a8 100644 --- a/clients/client-iotsitewise/commands/DescribeGatewayCapabilityConfigurationCommand.ts +++ b/clients/client-iotsitewise/commands/DescribeGatewayCapabilityConfigurationCommand.ts @@ -32,6 +32,20 @@ export interface DescribeGatewayCapabilityConfigurationCommandOutput * can contain multiple data source configurations. If you define OPC-UA sources for a gateway in * the AWS 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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { IoTSiteWiseClient, DescribeGatewayCapabilityConfigurationCommand } from "@aws-sdk/client-iotsitewise"; // ES Modules import + * // const { IoTSiteWiseClient, DescribeGatewayCapabilityConfigurationCommand } = require("@aws-sdk/client-iotsitewise"); // CommonJS import + * const client = new IoTSiteWiseClient(config); + * const command = new DescribeGatewayCapabilityConfigurationCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeGatewayCapabilityConfigurationCommandInput} for command's `input` shape. + * @see {@link DescribeGatewayCapabilityConfigurationCommandOutput} for command's `response` shape. + * @see {@link IoTSiteWiseClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeGatewayCapabilityConfigurationCommand extends $Command< DescribeGatewayCapabilityConfigurationCommandInput, diff --git a/clients/client-iotsitewise/commands/DescribeGatewayCommand.ts b/clients/client-iotsitewise/commands/DescribeGatewayCommand.ts index 07ac53e3bb23..58079426aa56 100644 --- a/clients/client-iotsitewise/commands/DescribeGatewayCommand.ts +++ b/clients/client-iotsitewise/commands/DescribeGatewayCommand.ts @@ -22,6 +22,20 @@ export interface DescribeGatewayCommandOutput extends DescribeGatewayResponse, _ /** *

Retrieves information about a gateway.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { IoTSiteWiseClient, DescribeGatewayCommand } from "@aws-sdk/client-iotsitewise"; // ES Modules import + * // const { IoTSiteWiseClient, DescribeGatewayCommand } = require("@aws-sdk/client-iotsitewise"); // CommonJS import + * const client = new IoTSiteWiseClient(config); + * const command = new DescribeGatewayCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeGatewayCommandInput} for command's `input` shape. + * @see {@link DescribeGatewayCommandOutput} for command's `response` shape. + * @see {@link IoTSiteWiseClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeGatewayCommand extends $Command< DescribeGatewayCommandInput, diff --git a/clients/client-iotsitewise/commands/DescribeLoggingOptionsCommand.ts b/clients/client-iotsitewise/commands/DescribeLoggingOptionsCommand.ts index 94478859b736..16361acc7b68 100644 --- a/clients/client-iotsitewise/commands/DescribeLoggingOptionsCommand.ts +++ b/clients/client-iotsitewise/commands/DescribeLoggingOptionsCommand.ts @@ -22,6 +22,20 @@ export interface DescribeLoggingOptionsCommandOutput extends DescribeLoggingOpti /** *

Retrieves the current AWS IoT SiteWise logging options.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { IoTSiteWiseClient, DescribeLoggingOptionsCommand } from "@aws-sdk/client-iotsitewise"; // ES Modules import + * // const { IoTSiteWiseClient, DescribeLoggingOptionsCommand } = require("@aws-sdk/client-iotsitewise"); // CommonJS import + * const client = new IoTSiteWiseClient(config); + * const command = new DescribeLoggingOptionsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeLoggingOptionsCommandInput} for command's `input` shape. + * @see {@link DescribeLoggingOptionsCommandOutput} for command's `response` shape. + * @see {@link IoTSiteWiseClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeLoggingOptionsCommand extends $Command< DescribeLoggingOptionsCommandInput, diff --git a/clients/client-iotsitewise/commands/DescribePortalCommand.ts b/clients/client-iotsitewise/commands/DescribePortalCommand.ts index 856ccb28dc81..a92cf89f0dc9 100644 --- a/clients/client-iotsitewise/commands/DescribePortalCommand.ts +++ b/clients/client-iotsitewise/commands/DescribePortalCommand.ts @@ -22,6 +22,20 @@ export interface DescribePortalCommandOutput extends DescribePortalResponse, __M /** *

Retrieves information about a portal.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { IoTSiteWiseClient, DescribePortalCommand } from "@aws-sdk/client-iotsitewise"; // ES Modules import + * // const { IoTSiteWiseClient, DescribePortalCommand } = require("@aws-sdk/client-iotsitewise"); // CommonJS import + * const client = new IoTSiteWiseClient(config); + * const command = new DescribePortalCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribePortalCommandInput} for command's `input` shape. + * @see {@link DescribePortalCommandOutput} for command's `response` shape. + * @see {@link IoTSiteWiseClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribePortalCommand extends $Command< DescribePortalCommandInput, diff --git a/clients/client-iotsitewise/commands/DescribeProjectCommand.ts b/clients/client-iotsitewise/commands/DescribeProjectCommand.ts index 2c3e2ac965b6..c2f66cecc1d4 100644 --- a/clients/client-iotsitewise/commands/DescribeProjectCommand.ts +++ b/clients/client-iotsitewise/commands/DescribeProjectCommand.ts @@ -22,6 +22,20 @@ export interface DescribeProjectCommandOutput extends DescribeProjectResponse, _ /** *

Retrieves information about a project.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { IoTSiteWiseClient, DescribeProjectCommand } from "@aws-sdk/client-iotsitewise"; // ES Modules import + * // const { IoTSiteWiseClient, DescribeProjectCommand } = require("@aws-sdk/client-iotsitewise"); // CommonJS import + * const client = new IoTSiteWiseClient(config); + * const command = new DescribeProjectCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeProjectCommandInput} for command's `input` shape. + * @see {@link DescribeProjectCommandOutput} for command's `response` shape. + * @see {@link IoTSiteWiseClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeProjectCommand extends $Command< DescribeProjectCommandInput, diff --git a/clients/client-iotsitewise/commands/DisassociateAssetsCommand.ts b/clients/client-iotsitewise/commands/DisassociateAssetsCommand.ts index 20bdfc8f6102..0cdb0d82afc7 100644 --- a/clients/client-iotsitewise/commands/DisassociateAssetsCommand.ts +++ b/clients/client-iotsitewise/commands/DisassociateAssetsCommand.ts @@ -23,6 +23,20 @@ export interface DisassociateAssetsCommandOutput extends __MetadataBearer {} /** *

Disassociates a child asset from the given parent asset through a hierarchy defined in the * parent asset's model.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { IoTSiteWiseClient, DisassociateAssetsCommand } from "@aws-sdk/client-iotsitewise"; // ES Modules import + * // const { IoTSiteWiseClient, DisassociateAssetsCommand } = require("@aws-sdk/client-iotsitewise"); // CommonJS import + * const client = new IoTSiteWiseClient(config); + * const command = new DisassociateAssetsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DisassociateAssetsCommandInput} for command's `input` shape. + * @see {@link DisassociateAssetsCommandOutput} for command's `response` shape. + * @see {@link IoTSiteWiseClientResolvedConfig | config} for command's `input` shape. + * */ export class DisassociateAssetsCommand extends $Command< DisassociateAssetsCommandInput, diff --git a/clients/client-iotsitewise/commands/GetAssetPropertyAggregatesCommand.ts b/clients/client-iotsitewise/commands/GetAssetPropertyAggregatesCommand.ts index c38e3f845bda..fad6794e7976 100644 --- a/clients/client-iotsitewise/commands/GetAssetPropertyAggregatesCommand.ts +++ b/clients/client-iotsitewise/commands/GetAssetPropertyAggregatesCommand.ts @@ -33,6 +33,20 @@ export interface GetAssetPropertyAggregatesCommandOutput extends GetAssetPropert * /company/windfarm/3/turbine/7/temperature). To define an asset property's alias, see UpdateAssetProperty.

* * + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { IoTSiteWiseClient, GetAssetPropertyAggregatesCommand } from "@aws-sdk/client-iotsitewise"; // ES Modules import + * // const { IoTSiteWiseClient, GetAssetPropertyAggregatesCommand } = require("@aws-sdk/client-iotsitewise"); // CommonJS import + * const client = new IoTSiteWiseClient(config); + * const command = new GetAssetPropertyAggregatesCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetAssetPropertyAggregatesCommandInput} for command's `input` shape. + * @see {@link GetAssetPropertyAggregatesCommandOutput} for command's `response` shape. + * @see {@link IoTSiteWiseClientResolvedConfig | config} for command's `input` shape. + * */ export class GetAssetPropertyAggregatesCommand extends $Command< GetAssetPropertyAggregatesCommandInput, diff --git a/clients/client-iotsitewise/commands/GetAssetPropertyValueCommand.ts b/clients/client-iotsitewise/commands/GetAssetPropertyValueCommand.ts index 07e980c68643..9580fce7f6b3 100644 --- a/clients/client-iotsitewise/commands/GetAssetPropertyValueCommand.ts +++ b/clients/client-iotsitewise/commands/GetAssetPropertyValueCommand.ts @@ -33,6 +33,20 @@ export interface GetAssetPropertyValueCommandOutput extends GetAssetPropertyValu * /company/windfarm/3/turbine/7/temperature). To define an asset property's alias, see UpdateAssetProperty.

* * + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { IoTSiteWiseClient, GetAssetPropertyValueCommand } from "@aws-sdk/client-iotsitewise"; // ES Modules import + * // const { IoTSiteWiseClient, GetAssetPropertyValueCommand } = require("@aws-sdk/client-iotsitewise"); // CommonJS import + * const client = new IoTSiteWiseClient(config); + * const command = new GetAssetPropertyValueCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetAssetPropertyValueCommandInput} for command's `input` shape. + * @see {@link GetAssetPropertyValueCommandOutput} for command's `response` shape. + * @see {@link IoTSiteWiseClientResolvedConfig | config} for command's `input` shape. + * */ export class GetAssetPropertyValueCommand extends $Command< GetAssetPropertyValueCommandInput, diff --git a/clients/client-iotsitewise/commands/GetAssetPropertyValueHistoryCommand.ts b/clients/client-iotsitewise/commands/GetAssetPropertyValueHistoryCommand.ts index faee99ffc601..56580a12c8b7 100644 --- a/clients/client-iotsitewise/commands/GetAssetPropertyValueHistoryCommand.ts +++ b/clients/client-iotsitewise/commands/GetAssetPropertyValueHistoryCommand.ts @@ -35,6 +35,20 @@ export interface GetAssetPropertyValueHistoryCommandOutput * /company/windfarm/3/turbine/7/temperature). To define an asset property's alias, see UpdateAssetProperty.

* * + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { IoTSiteWiseClient, GetAssetPropertyValueHistoryCommand } from "@aws-sdk/client-iotsitewise"; // ES Modules import + * // const { IoTSiteWiseClient, GetAssetPropertyValueHistoryCommand } = require("@aws-sdk/client-iotsitewise"); // CommonJS import + * const client = new IoTSiteWiseClient(config); + * const command = new GetAssetPropertyValueHistoryCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetAssetPropertyValueHistoryCommandInput} for command's `input` shape. + * @see {@link GetAssetPropertyValueHistoryCommandOutput} for command's `response` shape. + * @see {@link IoTSiteWiseClientResolvedConfig | config} for command's `input` shape. + * */ export class GetAssetPropertyValueHistoryCommand extends $Command< GetAssetPropertyValueHistoryCommandInput, diff --git a/clients/client-iotsitewise/commands/GetInterpolatedAssetPropertyValuesCommand.ts b/clients/client-iotsitewise/commands/GetInterpolatedAssetPropertyValuesCommand.ts index 460635ec38e0..5235280295dc 100644 --- a/clients/client-iotsitewise/commands/GetInterpolatedAssetPropertyValuesCommand.ts +++ b/clients/client-iotsitewise/commands/GetInterpolatedAssetPropertyValuesCommand.ts @@ -40,6 +40,20 @@ export interface GetInterpolatedAssetPropertyValuesCommandOutput * /company/windfarm/3/turbine/7/temperature). To define an asset property's alias, see UpdateAssetProperty.

* * + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { IoTSiteWiseClient, GetInterpolatedAssetPropertyValuesCommand } from "@aws-sdk/client-iotsitewise"; // ES Modules import + * // const { IoTSiteWiseClient, GetInterpolatedAssetPropertyValuesCommand } = require("@aws-sdk/client-iotsitewise"); // CommonJS import + * const client = new IoTSiteWiseClient(config); + * const command = new GetInterpolatedAssetPropertyValuesCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetInterpolatedAssetPropertyValuesCommandInput} for command's `input` shape. + * @see {@link GetInterpolatedAssetPropertyValuesCommandOutput} for command's `response` shape. + * @see {@link IoTSiteWiseClientResolvedConfig | config} for command's `input` shape. + * */ export class GetInterpolatedAssetPropertyValuesCommand extends $Command< GetInterpolatedAssetPropertyValuesCommandInput, diff --git a/clients/client-iotsitewise/commands/ListAccessPoliciesCommand.ts b/clients/client-iotsitewise/commands/ListAccessPoliciesCommand.ts index 4d722d245ae1..fbcea38a632f 100644 --- a/clients/client-iotsitewise/commands/ListAccessPoliciesCommand.ts +++ b/clients/client-iotsitewise/commands/ListAccessPoliciesCommand.ts @@ -23,6 +23,20 @@ export interface ListAccessPoliciesCommandOutput extends ListAccessPoliciesRespo /** *

Retrieves a paginated list of access policies for an identity (an AWS SSO user, an AWS SSO * group, or an IAM user) or an AWS IoT SiteWise Monitor resource (a portal or project).

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { IoTSiteWiseClient, ListAccessPoliciesCommand } from "@aws-sdk/client-iotsitewise"; // ES Modules import + * // const { IoTSiteWiseClient, ListAccessPoliciesCommand } = require("@aws-sdk/client-iotsitewise"); // CommonJS import + * const client = new IoTSiteWiseClient(config); + * const command = new ListAccessPoliciesCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListAccessPoliciesCommandInput} for command's `input` shape. + * @see {@link ListAccessPoliciesCommandOutput} for command's `response` shape. + * @see {@link IoTSiteWiseClientResolvedConfig | config} for command's `input` shape. + * */ export class ListAccessPoliciesCommand extends $Command< ListAccessPoliciesCommandInput, diff --git a/clients/client-iotsitewise/commands/ListAssetModelsCommand.ts b/clients/client-iotsitewise/commands/ListAssetModelsCommand.ts index 9efdf8f39c9d..facb7d8b6b53 100644 --- a/clients/client-iotsitewise/commands/ListAssetModelsCommand.ts +++ b/clients/client-iotsitewise/commands/ListAssetModelsCommand.ts @@ -22,6 +22,20 @@ export interface ListAssetModelsCommandOutput extends ListAssetModelsResponse, _ /** *

Retrieves a paginated list of summaries of all asset models.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { IoTSiteWiseClient, ListAssetModelsCommand } from "@aws-sdk/client-iotsitewise"; // ES Modules import + * // const { IoTSiteWiseClient, ListAssetModelsCommand } = require("@aws-sdk/client-iotsitewise"); // CommonJS import + * const client = new IoTSiteWiseClient(config); + * const command = new ListAssetModelsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListAssetModelsCommandInput} for command's `input` shape. + * @see {@link ListAssetModelsCommandOutput} for command's `response` shape. + * @see {@link IoTSiteWiseClientResolvedConfig | config} for command's `input` shape. + * */ export class ListAssetModelsCommand extends $Command< ListAssetModelsCommandInput, diff --git a/clients/client-iotsitewise/commands/ListAssetRelationshipsCommand.ts b/clients/client-iotsitewise/commands/ListAssetRelationshipsCommand.ts index c110f914258c..d475796f3b23 100644 --- a/clients/client-iotsitewise/commands/ListAssetRelationshipsCommand.ts +++ b/clients/client-iotsitewise/commands/ListAssetRelationshipsCommand.ts @@ -24,6 +24,20 @@ export interface ListAssetRelationshipsCommandOutput extends ListAssetRelationsh *

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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { IoTSiteWiseClient, ListAssetRelationshipsCommand } from "@aws-sdk/client-iotsitewise"; // ES Modules import + * // const { IoTSiteWiseClient, ListAssetRelationshipsCommand } = require("@aws-sdk/client-iotsitewise"); // CommonJS import + * const client = new IoTSiteWiseClient(config); + * const command = new ListAssetRelationshipsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListAssetRelationshipsCommandInput} for command's `input` shape. + * @see {@link ListAssetRelationshipsCommandOutput} for command's `response` shape. + * @see {@link IoTSiteWiseClientResolvedConfig | config} for command's `input` shape. + * */ export class ListAssetRelationshipsCommand extends $Command< ListAssetRelationshipsCommandInput, diff --git a/clients/client-iotsitewise/commands/ListAssetsCommand.ts b/clients/client-iotsitewise/commands/ListAssetsCommand.ts index 4d3235613d43..da5d12a84f87 100644 --- a/clients/client-iotsitewise/commands/ListAssetsCommand.ts +++ b/clients/client-iotsitewise/commands/ListAssetsCommand.ts @@ -34,6 +34,20 @@ export interface ListAssetsCommandOutput extends ListAssetsResponse, __MetadataB *

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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { IoTSiteWiseClient, ListAssetsCommand } from "@aws-sdk/client-iotsitewise"; // ES Modules import + * // const { IoTSiteWiseClient, ListAssetsCommand } = require("@aws-sdk/client-iotsitewise"); // CommonJS import + * const client = new IoTSiteWiseClient(config); + * const command = new ListAssetsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListAssetsCommandInput} for command's `input` shape. + * @see {@link ListAssetsCommandOutput} for command's `response` shape. + * @see {@link IoTSiteWiseClientResolvedConfig | config} for command's `input` shape. + * */ export class ListAssetsCommand extends $Command< ListAssetsCommandInput, diff --git a/clients/client-iotsitewise/commands/ListAssociatedAssetsCommand.ts b/clients/client-iotsitewise/commands/ListAssociatedAssetsCommand.ts index 6718b1f68a83..776a12f5e0ef 100644 --- a/clients/client-iotsitewise/commands/ListAssociatedAssetsCommand.ts +++ b/clients/client-iotsitewise/commands/ListAssociatedAssetsCommand.ts @@ -31,6 +31,20 @@ export interface ListAssociatedAssetsCommandOutput extends ListAssociatedAssetsR *

List an asset's parent asset.

* * + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { IoTSiteWiseClient, ListAssociatedAssetsCommand } from "@aws-sdk/client-iotsitewise"; // ES Modules import + * // const { IoTSiteWiseClient, ListAssociatedAssetsCommand } = require("@aws-sdk/client-iotsitewise"); // CommonJS import + * const client = new IoTSiteWiseClient(config); + * const command = new ListAssociatedAssetsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListAssociatedAssetsCommandInput} for command's `input` shape. + * @see {@link ListAssociatedAssetsCommandOutput} for command's `response` shape. + * @see {@link IoTSiteWiseClientResolvedConfig | config} for command's `input` shape. + * */ export class ListAssociatedAssetsCommand extends $Command< ListAssociatedAssetsCommandInput, diff --git a/clients/client-iotsitewise/commands/ListDashboardsCommand.ts b/clients/client-iotsitewise/commands/ListDashboardsCommand.ts index cab9df6b82a8..cc7e1cf79781 100644 --- a/clients/client-iotsitewise/commands/ListDashboardsCommand.ts +++ b/clients/client-iotsitewise/commands/ListDashboardsCommand.ts @@ -22,6 +22,20 @@ export interface ListDashboardsCommandOutput extends ListDashboardsResponse, __M /** *

Retrieves a paginated list of dashboards for an AWS IoT SiteWise Monitor project.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { IoTSiteWiseClient, ListDashboardsCommand } from "@aws-sdk/client-iotsitewise"; // ES Modules import + * // const { IoTSiteWiseClient, ListDashboardsCommand } = require("@aws-sdk/client-iotsitewise"); // CommonJS import + * const client = new IoTSiteWiseClient(config); + * const command = new ListDashboardsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListDashboardsCommandInput} for command's `input` shape. + * @see {@link ListDashboardsCommandOutput} for command's `response` shape. + * @see {@link IoTSiteWiseClientResolvedConfig | config} for command's `input` shape. + * */ export class ListDashboardsCommand extends $Command< ListDashboardsCommandInput, diff --git a/clients/client-iotsitewise/commands/ListGatewaysCommand.ts b/clients/client-iotsitewise/commands/ListGatewaysCommand.ts index 2a3d25e80227..97f268e0a17f 100644 --- a/clients/client-iotsitewise/commands/ListGatewaysCommand.ts +++ b/clients/client-iotsitewise/commands/ListGatewaysCommand.ts @@ -22,6 +22,20 @@ export interface ListGatewaysCommandOutput extends ListGatewaysResponse, __Metad /** *

Retrieves a paginated list of gateways.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { IoTSiteWiseClient, ListGatewaysCommand } from "@aws-sdk/client-iotsitewise"; // ES Modules import + * // const { IoTSiteWiseClient, ListGatewaysCommand } = require("@aws-sdk/client-iotsitewise"); // CommonJS import + * const client = new IoTSiteWiseClient(config); + * const command = new ListGatewaysCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListGatewaysCommandInput} for command's `input` shape. + * @see {@link ListGatewaysCommandOutput} for command's `response` shape. + * @see {@link IoTSiteWiseClientResolvedConfig | config} for command's `input` shape. + * */ export class ListGatewaysCommand extends $Command< ListGatewaysCommandInput, diff --git a/clients/client-iotsitewise/commands/ListPortalsCommand.ts b/clients/client-iotsitewise/commands/ListPortalsCommand.ts index ab5bdbff5848..723022aba889 100644 --- a/clients/client-iotsitewise/commands/ListPortalsCommand.ts +++ b/clients/client-iotsitewise/commands/ListPortalsCommand.ts @@ -22,6 +22,20 @@ export interface ListPortalsCommandOutput extends ListPortalsResponse, __Metadat /** *

Retrieves a paginated list of AWS IoT SiteWise Monitor portals.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { IoTSiteWiseClient, ListPortalsCommand } from "@aws-sdk/client-iotsitewise"; // ES Modules import + * // const { IoTSiteWiseClient, ListPortalsCommand } = require("@aws-sdk/client-iotsitewise"); // CommonJS import + * const client = new IoTSiteWiseClient(config); + * const command = new ListPortalsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListPortalsCommandInput} for command's `input` shape. + * @see {@link ListPortalsCommandOutput} for command's `response` shape. + * @see {@link IoTSiteWiseClientResolvedConfig | config} for command's `input` shape. + * */ export class ListPortalsCommand extends $Command< ListPortalsCommandInput, diff --git a/clients/client-iotsitewise/commands/ListProjectAssetsCommand.ts b/clients/client-iotsitewise/commands/ListProjectAssetsCommand.ts index f0f617f75106..62d8c5eb3332 100644 --- a/clients/client-iotsitewise/commands/ListProjectAssetsCommand.ts +++ b/clients/client-iotsitewise/commands/ListProjectAssetsCommand.ts @@ -22,6 +22,20 @@ export interface ListProjectAssetsCommandOutput extends ListProjectAssetsRespons /** *

Retrieves a paginated list of assets associated with an AWS IoT SiteWise Monitor project.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { IoTSiteWiseClient, ListProjectAssetsCommand } from "@aws-sdk/client-iotsitewise"; // ES Modules import + * // const { IoTSiteWiseClient, ListProjectAssetsCommand } = require("@aws-sdk/client-iotsitewise"); // CommonJS import + * const client = new IoTSiteWiseClient(config); + * const command = new ListProjectAssetsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListProjectAssetsCommandInput} for command's `input` shape. + * @see {@link ListProjectAssetsCommandOutput} for command's `response` shape. + * @see {@link IoTSiteWiseClientResolvedConfig | config} for command's `input` shape. + * */ export class ListProjectAssetsCommand extends $Command< ListProjectAssetsCommandInput, diff --git a/clients/client-iotsitewise/commands/ListProjectsCommand.ts b/clients/client-iotsitewise/commands/ListProjectsCommand.ts index 224c5de6cd72..474de1764d4d 100644 --- a/clients/client-iotsitewise/commands/ListProjectsCommand.ts +++ b/clients/client-iotsitewise/commands/ListProjectsCommand.ts @@ -22,6 +22,20 @@ export interface ListProjectsCommandOutput extends ListProjectsResponse, __Metad /** *

Retrieves a paginated list of projects for an AWS IoT SiteWise Monitor portal.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { IoTSiteWiseClient, ListProjectsCommand } from "@aws-sdk/client-iotsitewise"; // ES Modules import + * // const { IoTSiteWiseClient, ListProjectsCommand } = require("@aws-sdk/client-iotsitewise"); // CommonJS import + * const client = new IoTSiteWiseClient(config); + * const command = new ListProjectsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListProjectsCommandInput} for command's `input` shape. + * @see {@link ListProjectsCommandOutput} for command's `response` shape. + * @see {@link IoTSiteWiseClientResolvedConfig | config} for command's `input` shape. + * */ export class ListProjectsCommand extends $Command< ListProjectsCommandInput, diff --git a/clients/client-iotsitewise/commands/ListTagsForResourceCommand.ts b/clients/client-iotsitewise/commands/ListTagsForResourceCommand.ts index e042229d53d8..32a4f9acc6db 100644 --- a/clients/client-iotsitewise/commands/ListTagsForResourceCommand.ts +++ b/clients/client-iotsitewise/commands/ListTagsForResourceCommand.ts @@ -22,6 +22,20 @@ export interface ListTagsForResourceCommandOutput extends ListTagsForResourceRes /** *

Retrieves the list of tags for an AWS IoT SiteWise resource.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { IoTSiteWiseClient, ListTagsForResourceCommand } from "@aws-sdk/client-iotsitewise"; // ES Modules import + * // const { IoTSiteWiseClient, ListTagsForResourceCommand } = require("@aws-sdk/client-iotsitewise"); // CommonJS import + * const client = new IoTSiteWiseClient(config); + * const command = new ListTagsForResourceCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListTagsForResourceCommandInput} for command's `input` shape. + * @see {@link ListTagsForResourceCommandOutput} for command's `response` shape. + * @see {@link IoTSiteWiseClientResolvedConfig | config} for command's `input` shape. + * */ export class ListTagsForResourceCommand extends $Command< ListTagsForResourceCommandInput, diff --git a/clients/client-iotsitewise/commands/PutDefaultEncryptionConfigurationCommand.ts b/clients/client-iotsitewise/commands/PutDefaultEncryptionConfigurationCommand.ts index 4077b3afcbf0..e99f7f39bdc2 100644 --- a/clients/client-iotsitewise/commands/PutDefaultEncryptionConfigurationCommand.ts +++ b/clients/client-iotsitewise/commands/PutDefaultEncryptionConfigurationCommand.ts @@ -29,6 +29,20 @@ export interface PutDefaultEncryptionConfigurationCommandOutput *

Sets the default encryption configuration for the AWS * account. For more information, see Key management * in the AWS IoT SiteWise User Guide.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { IoTSiteWiseClient, PutDefaultEncryptionConfigurationCommand } from "@aws-sdk/client-iotsitewise"; // ES Modules import + * // const { IoTSiteWiseClient, PutDefaultEncryptionConfigurationCommand } = require("@aws-sdk/client-iotsitewise"); // CommonJS import + * const client = new IoTSiteWiseClient(config); + * const command = new PutDefaultEncryptionConfigurationCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link PutDefaultEncryptionConfigurationCommandInput} for command's `input` shape. + * @see {@link PutDefaultEncryptionConfigurationCommandOutput} for command's `response` shape. + * @see {@link IoTSiteWiseClientResolvedConfig | config} for command's `input` shape. + * */ export class PutDefaultEncryptionConfigurationCommand extends $Command< PutDefaultEncryptionConfigurationCommandInput, diff --git a/clients/client-iotsitewise/commands/PutLoggingOptionsCommand.ts b/clients/client-iotsitewise/commands/PutLoggingOptionsCommand.ts index afface35fba4..70261ef18145 100644 --- a/clients/client-iotsitewise/commands/PutLoggingOptionsCommand.ts +++ b/clients/client-iotsitewise/commands/PutLoggingOptionsCommand.ts @@ -22,6 +22,20 @@ export interface PutLoggingOptionsCommandOutput extends PutLoggingOptionsRespons /** *

Sets logging options for AWS IoT SiteWise.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { IoTSiteWiseClient, PutLoggingOptionsCommand } from "@aws-sdk/client-iotsitewise"; // ES Modules import + * // const { IoTSiteWiseClient, PutLoggingOptionsCommand } = require("@aws-sdk/client-iotsitewise"); // CommonJS import + * const client = new IoTSiteWiseClient(config); + * const command = new PutLoggingOptionsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link PutLoggingOptionsCommandInput} for command's `input` shape. + * @see {@link PutLoggingOptionsCommandOutput} for command's `response` shape. + * @see {@link IoTSiteWiseClientResolvedConfig | config} for command's `input` shape. + * */ export class PutLoggingOptionsCommand extends $Command< PutLoggingOptionsCommandInput, diff --git a/clients/client-iotsitewise/commands/TagResourceCommand.ts b/clients/client-iotsitewise/commands/TagResourceCommand.ts index 973cc0813d26..bae839d0fdd7 100644 --- a/clients/client-iotsitewise/commands/TagResourceCommand.ts +++ b/clients/client-iotsitewise/commands/TagResourceCommand.ts @@ -23,6 +23,20 @@ export interface TagResourceCommandOutput extends TagResourceResponse, __Metadat /** *

Adds tags to an AWS IoT SiteWise resource. If a tag already exists for the resource, this operation * updates the tag's value.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { IoTSiteWiseClient, TagResourceCommand } from "@aws-sdk/client-iotsitewise"; // ES Modules import + * // const { IoTSiteWiseClient, TagResourceCommand } = require("@aws-sdk/client-iotsitewise"); // CommonJS import + * const client = new IoTSiteWiseClient(config); + * const command = new TagResourceCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link TagResourceCommandInput} for command's `input` shape. + * @see {@link TagResourceCommandOutput} for command's `response` shape. + * @see {@link IoTSiteWiseClientResolvedConfig | config} for command's `input` shape. + * */ export class TagResourceCommand extends $Command< TagResourceCommandInput, diff --git a/clients/client-iotsitewise/commands/UntagResourceCommand.ts b/clients/client-iotsitewise/commands/UntagResourceCommand.ts index 0ed9f5355da2..437fd24201d8 100644 --- a/clients/client-iotsitewise/commands/UntagResourceCommand.ts +++ b/clients/client-iotsitewise/commands/UntagResourceCommand.ts @@ -22,6 +22,20 @@ export interface UntagResourceCommandOutput extends UntagResourceResponse, __Met /** *

Removes a tag from an AWS IoT SiteWise resource.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { IoTSiteWiseClient, UntagResourceCommand } from "@aws-sdk/client-iotsitewise"; // ES Modules import + * // const { IoTSiteWiseClient, UntagResourceCommand } = require("@aws-sdk/client-iotsitewise"); // CommonJS import + * const client = new IoTSiteWiseClient(config); + * const command = new UntagResourceCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link UntagResourceCommandInput} for command's `input` shape. + * @see {@link UntagResourceCommandOutput} for command's `response` shape. + * @see {@link IoTSiteWiseClientResolvedConfig | config} for command's `input` shape. + * */ export class UntagResourceCommand extends $Command< UntagResourceCommandInput, diff --git a/clients/client-iotsitewise/commands/UpdateAccessPolicyCommand.ts b/clients/client-iotsitewise/commands/UpdateAccessPolicyCommand.ts index 67ebb86ea761..01d131c6df35 100644 --- a/clients/client-iotsitewise/commands/UpdateAccessPolicyCommand.ts +++ b/clients/client-iotsitewise/commands/UpdateAccessPolicyCommand.ts @@ -23,6 +23,20 @@ export interface UpdateAccessPolicyCommandOutput extends UpdateAccessPolicyRespo /** *

Updates an existing access policy that specifies an identity's access to an AWS IoT SiteWise Monitor * portal or project resource.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { IoTSiteWiseClient, UpdateAccessPolicyCommand } from "@aws-sdk/client-iotsitewise"; // ES Modules import + * // const { IoTSiteWiseClient, UpdateAccessPolicyCommand } = require("@aws-sdk/client-iotsitewise"); // CommonJS import + * const client = new IoTSiteWiseClient(config); + * const command = new UpdateAccessPolicyCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link UpdateAccessPolicyCommandInput} for command's `input` shape. + * @see {@link UpdateAccessPolicyCommandOutput} for command's `response` shape. + * @see {@link IoTSiteWiseClientResolvedConfig | config} for command's `input` shape. + * */ export class UpdateAccessPolicyCommand extends $Command< UpdateAccessPolicyCommandInput, diff --git a/clients/client-iotsitewise/commands/UpdateAssetCommand.ts b/clients/client-iotsitewise/commands/UpdateAssetCommand.ts index c82a8c36fcb0..9a28d921a64b 100644 --- a/clients/client-iotsitewise/commands/UpdateAssetCommand.ts +++ b/clients/client-iotsitewise/commands/UpdateAssetCommand.ts @@ -23,6 +23,20 @@ export interface UpdateAssetCommandOutput extends UpdateAssetResponse, __Metadat /** *

Updates an asset's name. For more information, see Updating assets and models in the * AWS IoT SiteWise User Guide.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { IoTSiteWiseClient, UpdateAssetCommand } from "@aws-sdk/client-iotsitewise"; // ES Modules import + * // const { IoTSiteWiseClient, UpdateAssetCommand } = require("@aws-sdk/client-iotsitewise"); // CommonJS import + * const client = new IoTSiteWiseClient(config); + * const command = new UpdateAssetCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link UpdateAssetCommandInput} for command's `input` shape. + * @see {@link UpdateAssetCommandOutput} for command's `response` shape. + * @see {@link IoTSiteWiseClientResolvedConfig | config} for command's `input` shape. + * */ export class UpdateAssetCommand extends $Command< UpdateAssetCommandInput, diff --git a/clients/client-iotsitewise/commands/UpdateAssetModelCommand.ts b/clients/client-iotsitewise/commands/UpdateAssetModelCommand.ts index f4b5f5142dc2..265f2a2191c9 100644 --- a/clients/client-iotsitewise/commands/UpdateAssetModelCommand.ts +++ b/clients/client-iotsitewise/commands/UpdateAssetModelCommand.ts @@ -34,6 +34,20 @@ export interface UpdateAssetModelCommandOutput extends UpdateAssetModelResponse, * asset associated with that hierarchy. You can't change the type or data type of an existing * property.

* + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { IoTSiteWiseClient, UpdateAssetModelCommand } from "@aws-sdk/client-iotsitewise"; // ES Modules import + * // const { IoTSiteWiseClient, UpdateAssetModelCommand } = require("@aws-sdk/client-iotsitewise"); // CommonJS import + * const client = new IoTSiteWiseClient(config); + * const command = new UpdateAssetModelCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link UpdateAssetModelCommandInput} for command's `input` shape. + * @see {@link UpdateAssetModelCommandOutput} for command's `response` shape. + * @see {@link IoTSiteWiseClientResolvedConfig | config} for command's `input` shape. + * */ export class UpdateAssetModelCommand extends $Command< UpdateAssetModelCommandInput, diff --git a/clients/client-iotsitewise/commands/UpdateAssetPropertyCommand.ts b/clients/client-iotsitewise/commands/UpdateAssetPropertyCommand.ts index 0c41a6e4b4b4..aadb86f17120 100644 --- a/clients/client-iotsitewise/commands/UpdateAssetPropertyCommand.ts +++ b/clients/client-iotsitewise/commands/UpdateAssetPropertyCommand.ts @@ -27,6 +27,20 @@ export interface UpdateAssetPropertyCommandOutput extends __MetadataBearer {} * your existing property's alias or notification state, you must include the existing values * in the UpdateAssetProperty request. For more information, see DescribeAssetProperty.

* + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { IoTSiteWiseClient, UpdateAssetPropertyCommand } from "@aws-sdk/client-iotsitewise"; // ES Modules import + * // const { IoTSiteWiseClient, UpdateAssetPropertyCommand } = require("@aws-sdk/client-iotsitewise"); // CommonJS import + * const client = new IoTSiteWiseClient(config); + * const command = new UpdateAssetPropertyCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link UpdateAssetPropertyCommandInput} for command's `input` shape. + * @see {@link UpdateAssetPropertyCommandOutput} for command's `response` shape. + * @see {@link IoTSiteWiseClientResolvedConfig | config} for command's `input` shape. + * */ export class UpdateAssetPropertyCommand extends $Command< UpdateAssetPropertyCommandInput, diff --git a/clients/client-iotsitewise/commands/UpdateDashboardCommand.ts b/clients/client-iotsitewise/commands/UpdateDashboardCommand.ts index 950188036d0b..556da9d52a17 100644 --- a/clients/client-iotsitewise/commands/UpdateDashboardCommand.ts +++ b/clients/client-iotsitewise/commands/UpdateDashboardCommand.ts @@ -22,6 +22,20 @@ export interface UpdateDashboardCommandOutput extends UpdateDashboardResponse, _ /** *

Updates an AWS IoT SiteWise Monitor dashboard.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { IoTSiteWiseClient, UpdateDashboardCommand } from "@aws-sdk/client-iotsitewise"; // ES Modules import + * // const { IoTSiteWiseClient, UpdateDashboardCommand } = require("@aws-sdk/client-iotsitewise"); // CommonJS import + * const client = new IoTSiteWiseClient(config); + * const command = new UpdateDashboardCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link UpdateDashboardCommandInput} for command's `input` shape. + * @see {@link UpdateDashboardCommandOutput} for command's `response` shape. + * @see {@link IoTSiteWiseClientResolvedConfig | config} for command's `input` shape. + * */ export class UpdateDashboardCommand extends $Command< UpdateDashboardCommandInput, diff --git a/clients/client-iotsitewise/commands/UpdateGatewayCapabilityConfigurationCommand.ts b/clients/client-iotsitewise/commands/UpdateGatewayCapabilityConfigurationCommand.ts index 7e8e6d32c006..d3869e7bef2e 100644 --- a/clients/client-iotsitewise/commands/UpdateGatewayCapabilityConfigurationCommand.ts +++ b/clients/client-iotsitewise/commands/UpdateGatewayCapabilityConfigurationCommand.ts @@ -31,6 +31,20 @@ export interface UpdateGatewayCapabilityConfigurationCommandOutput * can contain multiple data source configurations. If you define OPC-UA sources for a gateway in * the AWS 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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { IoTSiteWiseClient, UpdateGatewayCapabilityConfigurationCommand } from "@aws-sdk/client-iotsitewise"; // ES Modules import + * // const { IoTSiteWiseClient, UpdateGatewayCapabilityConfigurationCommand } = require("@aws-sdk/client-iotsitewise"); // CommonJS import + * const client = new IoTSiteWiseClient(config); + * const command = new UpdateGatewayCapabilityConfigurationCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link UpdateGatewayCapabilityConfigurationCommandInput} for command's `input` shape. + * @see {@link UpdateGatewayCapabilityConfigurationCommandOutput} for command's `response` shape. + * @see {@link IoTSiteWiseClientResolvedConfig | config} for command's `input` shape. + * */ export class UpdateGatewayCapabilityConfigurationCommand extends $Command< UpdateGatewayCapabilityConfigurationCommandInput, diff --git a/clients/client-iotsitewise/commands/UpdateGatewayCommand.ts b/clients/client-iotsitewise/commands/UpdateGatewayCommand.ts index 68c19ab208af..6da7de1cf91e 100644 --- a/clients/client-iotsitewise/commands/UpdateGatewayCommand.ts +++ b/clients/client-iotsitewise/commands/UpdateGatewayCommand.ts @@ -22,6 +22,20 @@ export interface UpdateGatewayCommandOutput extends __MetadataBearer {} /** *

Updates a gateway's name.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { IoTSiteWiseClient, UpdateGatewayCommand } from "@aws-sdk/client-iotsitewise"; // ES Modules import + * // const { IoTSiteWiseClient, UpdateGatewayCommand } = require("@aws-sdk/client-iotsitewise"); // CommonJS import + * const client = new IoTSiteWiseClient(config); + * const command = new UpdateGatewayCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link UpdateGatewayCommandInput} for command's `input` shape. + * @see {@link UpdateGatewayCommandOutput} for command's `response` shape. + * @see {@link IoTSiteWiseClientResolvedConfig | config} for command's `input` shape. + * */ export class UpdateGatewayCommand extends $Command< UpdateGatewayCommandInput, diff --git a/clients/client-iotsitewise/commands/UpdatePortalCommand.ts b/clients/client-iotsitewise/commands/UpdatePortalCommand.ts index dbd8a3509618..e637e0126c72 100644 --- a/clients/client-iotsitewise/commands/UpdatePortalCommand.ts +++ b/clients/client-iotsitewise/commands/UpdatePortalCommand.ts @@ -22,6 +22,20 @@ export interface UpdatePortalCommandOutput extends UpdatePortalResponse, __Metad /** *

Updates an AWS IoT SiteWise Monitor portal.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { IoTSiteWiseClient, UpdatePortalCommand } from "@aws-sdk/client-iotsitewise"; // ES Modules import + * // const { IoTSiteWiseClient, UpdatePortalCommand } = require("@aws-sdk/client-iotsitewise"); // CommonJS import + * const client = new IoTSiteWiseClient(config); + * const command = new UpdatePortalCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link UpdatePortalCommandInput} for command's `input` shape. + * @see {@link UpdatePortalCommandOutput} for command's `response` shape. + * @see {@link IoTSiteWiseClientResolvedConfig | config} for command's `input` shape. + * */ export class UpdatePortalCommand extends $Command< UpdatePortalCommandInput, diff --git a/clients/client-iotsitewise/commands/UpdateProjectCommand.ts b/clients/client-iotsitewise/commands/UpdateProjectCommand.ts index 56fea71fef74..d3c69ef118a9 100644 --- a/clients/client-iotsitewise/commands/UpdateProjectCommand.ts +++ b/clients/client-iotsitewise/commands/UpdateProjectCommand.ts @@ -22,6 +22,20 @@ export interface UpdateProjectCommandOutput extends UpdateProjectResponse, __Met /** *

Updates an AWS IoT SiteWise Monitor project.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { IoTSiteWiseClient, UpdateProjectCommand } from "@aws-sdk/client-iotsitewise"; // ES Modules import + * // const { IoTSiteWiseClient, UpdateProjectCommand } = require("@aws-sdk/client-iotsitewise"); // CommonJS import + * const client = new IoTSiteWiseClient(config); + * const command = new UpdateProjectCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link UpdateProjectCommandInput} for command's `input` shape. + * @see {@link UpdateProjectCommandOutput} for command's `response` shape. + * @see {@link IoTSiteWiseClientResolvedConfig | config} for command's `input` shape. + * */ export class UpdateProjectCommand extends $Command< UpdateProjectCommandInput, diff --git a/clients/client-iotsitewise/models/models_0.ts b/clients/client-iotsitewise/models/models_0.ts index 7185b3391c32..a7867e98f84e 100644 --- a/clients/client-iotsitewise/models/models_0.ts +++ b/clients/client-iotsitewise/models/models_0.ts @@ -12,6 +12,9 @@ export interface GroupIdentity { } export namespace GroupIdentity { + /** + * @internal + */ export const filterSensitiveLog = (obj: GroupIdentity): any => ({ ...obj, }); @@ -30,6 +33,9 @@ export interface IAMRoleIdentity { } export namespace IAMRoleIdentity { + /** + * @internal + */ export const filterSensitiveLog = (obj: IAMRoleIdentity): any => ({ ...obj, }); @@ -52,6 +58,9 @@ export interface IAMUserIdentity { } export namespace IAMUserIdentity { + /** + * @internal + */ export const filterSensitiveLog = (obj: IAMUserIdentity): any => ({ ...obj, }); @@ -68,6 +77,9 @@ export interface UserIdentity { } export namespace UserIdentity { + /** + * @internal + */ export const filterSensitiveLog = (obj: UserIdentity): any => ({ ...obj, }); @@ -103,6 +115,9 @@ export interface Identity { } export namespace Identity { + /** + * @internal + */ export const filterSensitiveLog = (obj: Identity): any => ({ ...obj, }); @@ -124,6 +139,9 @@ export interface PortalResource { } export namespace PortalResource { + /** + * @internal + */ export const filterSensitiveLog = (obj: PortalResource): any => ({ ...obj, }); @@ -140,6 +158,9 @@ export interface ProjectResource { } export namespace ProjectResource { + /** + * @internal + */ export const filterSensitiveLog = (obj: ProjectResource): any => ({ ...obj, }); @@ -161,6 +182,9 @@ export interface Resource { } export namespace Resource { + /** + * @internal + */ export const filterSensitiveLog = (obj: Resource): any => ({ ...obj, }); @@ -204,6 +228,9 @@ export interface AccessPolicySummary { } export namespace AccessPolicySummary { + /** + * @internal + */ export const filterSensitiveLog = (obj: AccessPolicySummary): any => ({ ...obj, }); @@ -251,6 +278,9 @@ export interface Aggregates { } export namespace Aggregates { + /** + * @internal + */ export const filterSensitiveLog = (obj: Aggregates): any => ({ ...obj, }); @@ -278,6 +308,9 @@ export interface AggregatedValue { } export namespace AggregatedValue { + /** + * @internal + */ export const filterSensitiveLog = (obj: AggregatedValue): any => ({ ...obj, }); @@ -322,6 +355,9 @@ export interface PropertyNotification { } export namespace PropertyNotification { + /** + * @internal + */ export const filterSensitiveLog = (obj: PropertyNotification): any => ({ ...obj, }); @@ -372,6 +408,9 @@ export interface AssetProperty { } export namespace AssetProperty { + /** + * @internal + */ export const filterSensitiveLog = (obj: AssetProperty): any => ({ ...obj, }); @@ -405,6 +444,9 @@ export interface AssetCompositeModel { } export namespace AssetCompositeModel { + /** + * @internal + */ export const filterSensitiveLog = (obj: AssetCompositeModel): any => ({ ...obj, }); @@ -435,6 +477,9 @@ export interface AssetErrorDetails { } export namespace AssetErrorDetails { + /** + * @internal + */ export const filterSensitiveLog = (obj: AssetErrorDetails): any => ({ ...obj, }); @@ -457,6 +502,9 @@ export interface AssetHierarchy { } export namespace AssetHierarchy { + /** + * @internal + */ export const filterSensitiveLog = (obj: AssetHierarchy): any => ({ ...obj, }); @@ -479,6 +527,9 @@ export interface AssetHierarchyInfo { } export namespace AssetHierarchyInfo { + /** + * @internal + */ export const filterSensitiveLog = (obj: AssetHierarchyInfo): any => ({ ...obj, }); @@ -499,6 +550,9 @@ export interface Attribute { } export namespace Attribute { + /** + * @internal + */ export const filterSensitiveLog = (obj: Attribute): any => ({ ...obj, }); @@ -511,6 +565,9 @@ export namespace Attribute { export interface Measurement {} export namespace Measurement { + /** + * @internal + */ export const filterSensitiveLog = (obj: Measurement): any => ({ ...obj, }); @@ -538,6 +595,9 @@ export interface VariableValue { } export namespace VariableValue { + /** + * @internal + */ export const filterSensitiveLog = (obj: VariableValue): any => ({ ...obj, }); @@ -559,6 +619,9 @@ export interface ExpressionVariable { } export namespace ExpressionVariable { + /** + * @internal + */ export const filterSensitiveLog = (obj: ExpressionVariable): any => ({ ...obj, }); @@ -583,6 +646,9 @@ export interface TumblingWindow { } export namespace TumblingWindow { + /** + * @internal + */ export const filterSensitiveLog = (obj: TumblingWindow): any => ({ ...obj, }); @@ -600,6 +666,9 @@ export interface MetricWindow { } export namespace MetricWindow { + /** + * @internal + */ export const filterSensitiveLog = (obj: MetricWindow): any => ({ ...obj, }); @@ -638,6 +707,9 @@ export interface Metric { } export namespace Metric { + /** + * @internal + */ export const filterSensitiveLog = (obj: Metric): any => ({ ...obj, }); @@ -667,6 +739,9 @@ export interface Transform { } export namespace Transform { + /** + * @internal + */ export const filterSensitiveLog = (obj: Transform): any => ({ ...obj, }); @@ -705,6 +780,9 @@ export interface PropertyType { } export namespace PropertyType { + /** + * @internal + */ export const filterSensitiveLog = (obj: PropertyType): any => ({ ...obj, }); @@ -748,6 +826,9 @@ export interface AssetModelProperty { } export namespace AssetModelProperty { + /** + * @internal + */ export const filterSensitiveLog = (obj: AssetModelProperty): any => ({ ...obj, }); @@ -781,6 +862,9 @@ export interface AssetModelCompositeModel { } export namespace AssetModelCompositeModel { + /** + * @internal + */ export const filterSensitiveLog = (obj: AssetModelCompositeModel): any => ({ ...obj, }); @@ -826,6 +910,9 @@ export interface AssetModelPropertyDefinition { } export namespace AssetModelPropertyDefinition { + /** + * @internal + */ export const filterSensitiveLog = (obj: AssetModelPropertyDefinition): any => ({ ...obj, }); @@ -859,6 +946,9 @@ export interface AssetModelCompositeModelDefinition { } export namespace AssetModelCompositeModelDefinition { + /** + * @internal + */ export const filterSensitiveLog = (obj: AssetModelCompositeModelDefinition): any => ({ ...obj, }); @@ -888,6 +978,9 @@ export interface AssetModelHierarchy { } export namespace AssetModelHierarchy { + /** + * @internal + */ export const filterSensitiveLog = (obj: AssetModelHierarchy): any => ({ ...obj, }); @@ -911,6 +1004,9 @@ export interface AssetModelHierarchyDefinition { } export namespace AssetModelHierarchyDefinition { + /** + * @internal + */ export const filterSensitiveLog = (obj: AssetModelHierarchyDefinition): any => ({ ...obj, }); @@ -946,6 +1042,9 @@ export interface ErrorDetails { } export namespace ErrorDetails { + /** + * @internal + */ export const filterSensitiveLog = (obj: ErrorDetails): any => ({ ...obj, }); @@ -968,6 +1067,9 @@ export interface AssetModelStatus { } export namespace AssetModelStatus { + /** + * @internal + */ export const filterSensitiveLog = (obj: AssetModelStatus): any => ({ ...obj, }); @@ -1017,6 +1119,9 @@ export interface AssetModelSummary { } export namespace AssetModelSummary { + /** + * @internal + */ export const filterSensitiveLog = (obj: AssetModelSummary): any => ({ ...obj, }); @@ -1039,6 +1144,9 @@ export interface TimeInNanos { } export namespace TimeInNanos { + /** + * @internal + */ export const filterSensitiveLog = (obj: TimeInNanos): any => ({ ...obj, }); @@ -1070,6 +1178,9 @@ export interface Variant { } export namespace Variant { + /** + * @internal + */ export const filterSensitiveLog = (obj: Variant): any => ({ ...obj, }); @@ -1096,6 +1207,9 @@ export interface AssetPropertyValue { } export namespace AssetPropertyValue { + /** + * @internal + */ export const filterSensitiveLog = (obj: AssetPropertyValue): any => ({ ...obj, }); @@ -1132,6 +1246,9 @@ export interface AssetRelationshipSummary { } export namespace AssetRelationshipSummary { + /** + * @internal + */ export const filterSensitiveLog = (obj: AssetRelationshipSummary): any => ({ ...obj, }); @@ -1163,6 +1280,9 @@ export interface AssetStatus { } export namespace AssetStatus { + /** + * @internal + */ export const filterSensitiveLog = (obj: AssetStatus): any => ({ ...obj, }); @@ -1217,6 +1337,9 @@ export interface AssetSummary { } export namespace AssetSummary { + /** + * @internal + */ export const filterSensitiveLog = (obj: AssetSummary): any => ({ ...obj, }); @@ -1247,6 +1370,9 @@ export interface AssociateAssetsRequest { } export namespace AssociateAssetsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: AssociateAssetsRequest): any => ({ ...obj, }); @@ -1272,6 +1398,9 @@ export interface ConflictingOperationException extends __SmithyException, $Metad } export namespace ConflictingOperationException { + /** + * @internal + */ export const filterSensitiveLog = (obj: ConflictingOperationException): any => ({ ...obj, }); @@ -1287,6 +1416,9 @@ export interface InternalFailureException extends __SmithyException, $MetadataBe } export namespace InternalFailureException { + /** + * @internal + */ export const filterSensitiveLog = (obj: InternalFailureException): any => ({ ...obj, }); @@ -1303,6 +1435,9 @@ export interface InvalidRequestException extends __SmithyException, $MetadataBea } export namespace InvalidRequestException { + /** + * @internal + */ export const filterSensitiveLog = (obj: InvalidRequestException): any => ({ ...obj, }); @@ -1321,6 +1456,9 @@ export interface LimitExceededException extends __SmithyException, $MetadataBear } export namespace LimitExceededException { + /** + * @internal + */ export const filterSensitiveLog = (obj: LimitExceededException): any => ({ ...obj, }); @@ -1336,6 +1474,9 @@ export interface ResourceNotFoundException extends __SmithyException, $MetadataB } export namespace ResourceNotFoundException { + /** + * @internal + */ export const filterSensitiveLog = (obj: ResourceNotFoundException): any => ({ ...obj, }); @@ -1354,6 +1495,9 @@ export interface ThrottlingException extends __SmithyException, $MetadataBearer } export namespace ThrottlingException { + /** + * @internal + */ export const filterSensitiveLog = (obj: ThrottlingException): any => ({ ...obj, }); @@ -1408,6 +1552,9 @@ export interface AssociatedAssetsSummary { } export namespace AssociatedAssetsSummary { + /** + * @internal + */ export const filterSensitiveLog = (obj: AssociatedAssetsSummary): any => ({ ...obj, }); @@ -1436,6 +1583,9 @@ export interface BatchAssociateProjectAssetsRequest { } export namespace BatchAssociateProjectAssetsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: BatchAssociateProjectAssetsRequest): any => ({ ...obj, }); @@ -1449,6 +1599,9 @@ export interface BatchAssociateProjectAssetsResponse { } export namespace BatchAssociateProjectAssetsResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: BatchAssociateProjectAssetsResponse): any => ({ ...obj, }); @@ -1472,6 +1625,9 @@ export interface BatchDisassociateProjectAssetsRequest { } export namespace BatchDisassociateProjectAssetsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: BatchDisassociateProjectAssetsRequest): any => ({ ...obj, }); @@ -1485,6 +1641,9 @@ export interface BatchDisassociateProjectAssetsResponse { } export namespace BatchDisassociateProjectAssetsResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: BatchDisassociateProjectAssetsResponse): any => ({ ...obj, }); @@ -1528,6 +1687,9 @@ export interface PutAssetPropertyValueEntry { } export namespace PutAssetPropertyValueEntry { + /** + * @internal + */ export const filterSensitiveLog = (obj: PutAssetPropertyValueEntry): any => ({ ...obj, }); @@ -1542,6 +1704,9 @@ export interface BatchPutAssetPropertyValueRequest { } export namespace BatchPutAssetPropertyValueRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: BatchPutAssetPropertyValueRequest): any => ({ ...obj, }); @@ -1580,6 +1745,9 @@ export interface BatchPutAssetPropertyError { } export namespace BatchPutAssetPropertyError { + /** + * @internal + */ export const filterSensitiveLog = (obj: BatchPutAssetPropertyError): any => ({ ...obj, }); @@ -1602,6 +1770,9 @@ export interface BatchPutAssetPropertyErrorEntry { } export namespace BatchPutAssetPropertyErrorEntry { + /** + * @internal + */ export const filterSensitiveLog = (obj: BatchPutAssetPropertyErrorEntry): any => ({ ...obj, }); @@ -1616,6 +1787,9 @@ export interface BatchPutAssetPropertyValueResponse { } export namespace BatchPutAssetPropertyValueResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: BatchPutAssetPropertyValueResponse): any => ({ ...obj, }); @@ -1631,6 +1805,9 @@ export interface ServiceUnavailableException extends __SmithyException, $Metadat } export namespace ServiceUnavailableException { + /** + * @internal + */ export const filterSensitiveLog = (obj: ServiceUnavailableException): any => ({ ...obj, }); @@ -1666,6 +1843,9 @@ export interface CreateAccessPolicyRequest { } export namespace CreateAccessPolicyRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateAccessPolicyRequest): any => ({ ...obj, }); @@ -1687,6 +1867,9 @@ export interface CreateAccessPolicyResponse { } export namespace CreateAccessPolicyResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateAccessPolicyResponse): any => ({ ...obj, }); @@ -1717,6 +1900,9 @@ export interface CreateAssetRequest { } export namespace CreateAssetRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateAssetRequest): any => ({ ...obj, }); @@ -1745,6 +1931,9 @@ export interface CreateAssetResponse { } export namespace CreateAssetResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateAssetResponse): any => ({ ...obj, }); @@ -1769,6 +1958,9 @@ export interface ResourceAlreadyExistsException extends __SmithyException, $Meta } export namespace ResourceAlreadyExistsException { + /** + * @internal + */ export const filterSensitiveLog = (obj: ResourceAlreadyExistsException): any => ({ ...obj, }); @@ -1824,6 +2016,9 @@ export interface CreateAssetModelRequest { } export namespace CreateAssetModelRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateAssetModelRequest): any => ({ ...obj, }); @@ -1851,6 +2046,9 @@ export interface CreateAssetModelResponse { } export namespace CreateAssetModelResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateAssetModelResponse): any => ({ ...obj, }); @@ -1892,6 +2090,9 @@ export interface CreateDashboardRequest { } export namespace CreateDashboardRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateDashboardRequest): any => ({ ...obj, }); @@ -1913,6 +2114,9 @@ export interface CreateDashboardResponse { } export namespace CreateDashboardResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateDashboardResponse): any => ({ ...obj, }); @@ -1934,6 +2138,9 @@ export interface Greengrass { } export namespace Greengrass { + /** + * @internal + */ export const filterSensitiveLog = (obj: Greengrass): any => ({ ...obj, }); @@ -1950,6 +2157,9 @@ export interface GatewayPlatform { } export namespace GatewayPlatform { + /** + * @internal + */ export const filterSensitiveLog = (obj: GatewayPlatform): any => ({ ...obj, }); @@ -1975,6 +2185,9 @@ export interface CreateGatewayRequest { } export namespace CreateGatewayRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateGatewayRequest): any => ({ ...obj, }); @@ -1996,6 +2209,9 @@ export interface CreateGatewayResponse { } export namespace CreateGatewayResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateGatewayResponse): any => ({ ...obj, }); @@ -2022,6 +2238,9 @@ export interface ImageFile { } export namespace ImageFile { + /** + * @internal + */ export const filterSensitiveLog = (obj: ImageFile): any => ({ ...obj, }); @@ -2094,6 +2313,9 @@ export interface CreatePortalRequest { } export namespace CreatePortalRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreatePortalRequest): any => ({ ...obj, }); @@ -2121,6 +2343,9 @@ export interface MonitorErrorDetails { } export namespace MonitorErrorDetails { + /** + * @internal + */ export const filterSensitiveLog = (obj: MonitorErrorDetails): any => ({ ...obj, }); @@ -2150,6 +2375,9 @@ export interface PortalStatus { } export namespace PortalStatus { + /** + * @internal + */ export const filterSensitiveLog = (obj: PortalStatus): any => ({ ...obj, }); @@ -2189,6 +2417,9 @@ export interface CreatePortalResponse { } export namespace CreatePortalResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreatePortalResponse): any => ({ ...obj, }); @@ -2224,6 +2455,9 @@ export interface CreateProjectRequest { } export namespace CreateProjectRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateProjectRequest): any => ({ ...obj, }); @@ -2245,6 +2479,9 @@ export interface CreateProjectResponse { } export namespace CreateProjectResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateProjectResponse): any => ({ ...obj, }); @@ -2263,6 +2500,9 @@ export interface DeleteAccessPolicyRequest { } export namespace DeleteAccessPolicyRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteAccessPolicyRequest): any => ({ ...obj, }); @@ -2271,6 +2511,9 @@ export namespace DeleteAccessPolicyRequest { export interface DeleteAccessPolicyResponse {} export namespace DeleteAccessPolicyResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteAccessPolicyResponse): any => ({ ...obj, }); @@ -2289,6 +2532,9 @@ export interface DeleteAssetRequest { } export namespace DeleteAssetRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteAssetRequest): any => ({ ...obj, }); @@ -2303,6 +2549,9 @@ export interface DeleteAssetResponse { } export namespace DeleteAssetResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteAssetResponse): any => ({ ...obj, }); @@ -2321,6 +2570,9 @@ export interface DeleteAssetModelRequest { } export namespace DeleteAssetModelRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteAssetModelRequest): any => ({ ...obj, }); @@ -2335,6 +2587,9 @@ export interface DeleteAssetModelResponse { } export namespace DeleteAssetModelResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteAssetModelResponse): any => ({ ...obj, }); @@ -2353,6 +2608,9 @@ export interface DeleteDashboardRequest { } export namespace DeleteDashboardRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteDashboardRequest): any => ({ ...obj, }); @@ -2361,6 +2619,9 @@ export namespace DeleteDashboardRequest { export interface DeleteDashboardResponse {} export namespace DeleteDashboardResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteDashboardResponse): any => ({ ...obj, }); @@ -2374,6 +2635,9 @@ export interface DeleteGatewayRequest { } export namespace DeleteGatewayRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteGatewayRequest): any => ({ ...obj, }); @@ -2392,6 +2656,9 @@ export interface DeletePortalRequest { } export namespace DeletePortalRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeletePortalRequest): any => ({ ...obj, }); @@ -2406,6 +2673,9 @@ export interface DeletePortalResponse { } export namespace DeletePortalResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeletePortalResponse): any => ({ ...obj, }); @@ -2424,6 +2694,9 @@ export interface DeleteProjectRequest { } export namespace DeleteProjectRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteProjectRequest): any => ({ ...obj, }); @@ -2432,6 +2705,9 @@ export namespace DeleteProjectRequest { export interface DeleteProjectResponse {} export namespace DeleteProjectResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteProjectResponse): any => ({ ...obj, }); @@ -2445,6 +2721,9 @@ export interface DescribeAccessPolicyRequest { } export namespace DescribeAccessPolicyRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeAccessPolicyRequest): any => ({ ...obj, }); @@ -2494,6 +2773,9 @@ export interface DescribeAccessPolicyResponse { } export namespace DescribeAccessPolicyResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeAccessPolicyResponse): any => ({ ...obj, }); @@ -2507,6 +2789,9 @@ export interface DescribeAssetRequest { } export namespace DescribeAssetRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeAssetRequest): any => ({ ...obj, }); @@ -2570,6 +2855,9 @@ export interface DescribeAssetResponse { } export namespace DescribeAssetResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeAssetResponse): any => ({ ...obj, }); @@ -2583,6 +2871,9 @@ export interface DescribeAssetModelRequest { } export namespace DescribeAssetModelRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeAssetModelRequest): any => ({ ...obj, }); @@ -2649,6 +2940,9 @@ export interface DescribeAssetModelResponse { } export namespace DescribeAssetModelResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeAssetModelResponse): any => ({ ...obj, }); @@ -2667,6 +2961,9 @@ export interface DescribeAssetPropertyRequest { } export namespace DescribeAssetPropertyRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeAssetPropertyRequest): any => ({ ...obj, }); @@ -2716,6 +3013,9 @@ export interface Property { } export namespace Property { + /** + * @internal + */ export const filterSensitiveLog = (obj: Property): any => ({ ...obj, }); @@ -2742,6 +3042,9 @@ export interface CompositeModelProperty { } export namespace CompositeModelProperty { + /** + * @internal + */ export const filterSensitiveLog = (obj: CompositeModelProperty): any => ({ ...obj, }); @@ -2779,6 +3082,9 @@ export interface DescribeAssetPropertyResponse { } export namespace DescribeAssetPropertyResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeAssetPropertyResponse): any => ({ ...obj, }); @@ -2792,6 +3098,9 @@ export interface DescribeDashboardRequest { } export namespace DescribeDashboardRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeDashboardRequest): any => ({ ...obj, }); @@ -2844,6 +3153,9 @@ export interface DescribeDashboardResponse { } export namespace DescribeDashboardResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeDashboardResponse): any => ({ ...obj, }); @@ -2852,6 +3164,9 @@ export namespace DescribeDashboardResponse { export interface DescribeDefaultEncryptionConfigurationRequest {} export namespace DescribeDefaultEncryptionConfigurationRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeDefaultEncryptionConfigurationRequest): any => ({ ...obj, }); @@ -2873,6 +3188,9 @@ export interface ConfigurationErrorDetails { } export namespace ConfigurationErrorDetails { + /** + * @internal + */ export const filterSensitiveLog = (obj: ConfigurationErrorDetails): any => ({ ...obj, }); @@ -2900,6 +3218,9 @@ export interface ConfigurationStatus { } export namespace ConfigurationStatus { + /** + * @internal + */ export const filterSensitiveLog = (obj: ConfigurationStatus): any => ({ ...obj, }); @@ -2931,6 +3252,9 @@ export interface DescribeDefaultEncryptionConfigurationResponse { } export namespace DescribeDefaultEncryptionConfigurationResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeDefaultEncryptionConfigurationResponse): any => ({ ...obj, }); @@ -2944,6 +3268,9 @@ export interface DescribeGatewayRequest { } export namespace DescribeGatewayRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeGatewayRequest): any => ({ ...obj, }); @@ -2989,6 +3316,9 @@ export interface GatewayCapabilitySummary { } export namespace GatewayCapabilitySummary { + /** + * @internal + */ export const filterSensitiveLog = (obj: GatewayCapabilitySummary): any => ({ ...obj, }); @@ -3037,6 +3367,9 @@ export interface DescribeGatewayResponse { } export namespace DescribeGatewayResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeGatewayResponse): any => ({ ...obj, }); @@ -3059,6 +3392,9 @@ export interface DescribeGatewayCapabilityConfigurationRequest { } export namespace DescribeGatewayCapabilityConfigurationRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeGatewayCapabilityConfigurationRequest): any => ({ ...obj, }); @@ -3102,6 +3438,9 @@ export interface DescribeGatewayCapabilityConfigurationResponse { } export namespace DescribeGatewayCapabilityConfigurationResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeGatewayCapabilityConfigurationResponse): any => ({ ...obj, }); @@ -3110,6 +3449,9 @@ export namespace DescribeGatewayCapabilityConfigurationResponse { export interface DescribeLoggingOptionsRequest {} export namespace DescribeLoggingOptionsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeLoggingOptionsRequest): any => ({ ...obj, }); @@ -3132,6 +3474,9 @@ export interface LoggingOptions { } export namespace LoggingOptions { + /** + * @internal + */ export const filterSensitiveLog = (obj: LoggingOptions): any => ({ ...obj, }); @@ -3145,6 +3490,9 @@ export interface DescribeLoggingOptionsResponse { } export namespace DescribeLoggingOptionsResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeLoggingOptionsResponse): any => ({ ...obj, }); @@ -3158,6 +3506,9 @@ export interface DescribePortalRequest { } export namespace DescribePortalRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribePortalRequest): any => ({ ...obj, }); @@ -3180,6 +3531,9 @@ export interface ImageLocation { } export namespace ImageLocation { + /** + * @internal + */ export const filterSensitiveLog = (obj: ImageLocation): any => ({ ...obj, }); @@ -3261,6 +3615,9 @@ export interface DescribePortalResponse { } export namespace DescribePortalResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribePortalResponse): any => ({ ...obj, }); @@ -3274,6 +3631,9 @@ export interface DescribeProjectRequest { } export namespace DescribeProjectRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeProjectRequest): any => ({ ...obj, }); @@ -3320,6 +3680,9 @@ export interface DescribeProjectResponse { } export namespace DescribeProjectResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeProjectResponse): any => ({ ...obj, }); @@ -3351,6 +3714,9 @@ export interface DisassociateAssetsRequest { } export namespace DisassociateAssetsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DisassociateAssetsRequest): any => ({ ...obj, }); @@ -3425,6 +3791,9 @@ export interface GetAssetPropertyAggregatesRequest { } export namespace GetAssetPropertyAggregatesRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetAssetPropertyAggregatesRequest): any => ({ ...obj, }); @@ -3443,6 +3812,9 @@ export interface GetAssetPropertyAggregatesResponse { } export namespace GetAssetPropertyAggregatesResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetAssetPropertyAggregatesResponse): any => ({ ...obj, }); @@ -3469,6 +3841,9 @@ export interface GetAssetPropertyValueRequest { } export namespace GetAssetPropertyValueRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetAssetPropertyValueRequest): any => ({ ...obj, }); @@ -3482,6 +3857,9 @@ export interface GetAssetPropertyValueResponse { } export namespace GetAssetPropertyValueResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetAssetPropertyValueResponse): any => ({ ...obj, }); @@ -3541,6 +3919,9 @@ export interface GetAssetPropertyValueHistoryRequest { } export namespace GetAssetPropertyValueHistoryRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetAssetPropertyValueHistoryRequest): any => ({ ...obj, }); @@ -3559,6 +3940,9 @@ export interface GetAssetPropertyValueHistoryResponse { } export namespace GetAssetPropertyValueHistoryResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetAssetPropertyValueHistoryResponse): any => ({ ...obj, }); @@ -3637,6 +4021,9 @@ export interface GetInterpolatedAssetPropertyValuesRequest { } export namespace GetInterpolatedAssetPropertyValuesRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetInterpolatedAssetPropertyValuesRequest): any => ({ ...obj, }); @@ -3658,6 +4045,9 @@ export interface InterpolatedAssetPropertyValue { } export namespace InterpolatedAssetPropertyValue { + /** + * @internal + */ export const filterSensitiveLog = (obj: InterpolatedAssetPropertyValue): any => ({ ...obj, }); @@ -3676,6 +4066,9 @@ export interface GetInterpolatedAssetPropertyValuesResponse { } export namespace GetInterpolatedAssetPropertyValuesResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetInterpolatedAssetPropertyValuesResponse): any => ({ ...obj, }); @@ -3737,6 +4130,9 @@ export interface ListAccessPoliciesRequest { } export namespace ListAccessPoliciesRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListAccessPoliciesRequest): any => ({ ...obj, }); @@ -3755,6 +4151,9 @@ export interface ListAccessPoliciesResponse { } export namespace ListAccessPoliciesResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListAccessPoliciesResponse): any => ({ ...obj, }); @@ -3774,6 +4173,9 @@ export interface ListAssetModelsRequest { } export namespace ListAssetModelsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListAssetModelsRequest): any => ({ ...obj, }); @@ -3792,6 +4194,9 @@ export interface ListAssetModelsResponse { } export namespace ListAssetModelsResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListAssetModelsResponse): any => ({ ...obj, }); @@ -3833,6 +4238,9 @@ export interface ListAssetRelationshipsRequest { } export namespace ListAssetRelationshipsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListAssetRelationshipsRequest): any => ({ ...obj, }); @@ -3851,6 +4259,9 @@ export interface ListAssetRelationshipsResponse { } export namespace ListAssetRelationshipsResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListAssetRelationshipsResponse): any => ({ ...obj, }); @@ -3901,6 +4312,9 @@ export interface ListAssetsRequest { } export namespace ListAssetsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListAssetsRequest): any => ({ ...obj, }); @@ -3919,6 +4333,9 @@ export interface ListAssetsResponse { } export namespace ListAssetsResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListAssetsResponse): any => ({ ...obj, }); @@ -3976,6 +4393,9 @@ export interface ListAssociatedAssetsRequest { } export namespace ListAssociatedAssetsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListAssociatedAssetsRequest): any => ({ ...obj, }); @@ -3994,6 +4414,9 @@ export interface ListAssociatedAssetsResponse { } export namespace ListAssociatedAssetsResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListAssociatedAssetsResponse): any => ({ ...obj, }); @@ -4018,6 +4441,9 @@ export interface ListDashboardsRequest { } export namespace ListDashboardsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListDashboardsRequest): any => ({ ...obj, }); @@ -4054,6 +4480,9 @@ export interface DashboardSummary { } export namespace DashboardSummary { + /** + * @internal + */ export const filterSensitiveLog = (obj: DashboardSummary): any => ({ ...obj, }); @@ -4072,6 +4501,9 @@ export interface ListDashboardsResponse { } export namespace ListDashboardsResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListDashboardsResponse): any => ({ ...obj, }); @@ -4091,6 +4523,9 @@ export interface ListGatewaysRequest { } export namespace ListGatewaysRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListGatewaysRequest): any => ({ ...obj, }); @@ -4129,6 +4564,9 @@ export interface GatewaySummary { } export namespace GatewaySummary { + /** + * @internal + */ export const filterSensitiveLog = (obj: GatewaySummary): any => ({ ...obj, }); @@ -4147,6 +4585,9 @@ export interface ListGatewaysResponse { } export namespace ListGatewaysResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListGatewaysResponse): any => ({ ...obj, }); @@ -4166,6 +4607,9 @@ export interface ListPortalsRequest { } export namespace ListPortalsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListPortalsRequest): any => ({ ...obj, }); @@ -4221,6 +4665,9 @@ export interface PortalSummary { } export namespace PortalSummary { + /** + * @internal + */ export const filterSensitiveLog = (obj: PortalSummary): any => ({ ...obj, }); @@ -4239,6 +4686,9 @@ export interface ListPortalsResponse { } export namespace ListPortalsResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListPortalsResponse): any => ({ ...obj, }); @@ -4263,6 +4713,9 @@ export interface ListProjectAssetsRequest { } export namespace ListProjectAssetsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListProjectAssetsRequest): any => ({ ...obj, }); @@ -4281,6 +4734,9 @@ export interface ListProjectAssetsResponse { } export namespace ListProjectAssetsResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListProjectAssetsResponse): any => ({ ...obj, }); @@ -4305,6 +4761,9 @@ export interface ListProjectsRequest { } export namespace ListProjectsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListProjectsRequest): any => ({ ...obj, }); @@ -4341,6 +4800,9 @@ export interface ProjectSummary { } export namespace ProjectSummary { + /** + * @internal + */ export const filterSensitiveLog = (obj: ProjectSummary): any => ({ ...obj, }); @@ -4359,6 +4821,9 @@ export interface ListProjectsResponse { } export namespace ListProjectsResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListProjectsResponse): any => ({ ...obj, }); @@ -4372,6 +4837,9 @@ export interface ListTagsForResourceRequest { } export namespace ListTagsForResourceRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListTagsForResourceRequest): any => ({ ...obj, }); @@ -4387,6 +4855,9 @@ export interface ListTagsForResourceResponse { } export namespace ListTagsForResourceResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListTagsForResourceResponse): any => ({ ...obj, }); @@ -4402,6 +4873,9 @@ export interface UnauthorizedException extends __SmithyException, $MetadataBeare } export namespace UnauthorizedException { + /** + * @internal + */ export const filterSensitiveLog = (obj: UnauthorizedException): any => ({ ...obj, }); @@ -4421,6 +4895,9 @@ export interface PutDefaultEncryptionConfigurationRequest { } export namespace PutDefaultEncryptionConfigurationRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: PutDefaultEncryptionConfigurationRequest): any => ({ ...obj, }); @@ -4447,6 +4924,9 @@ export interface PutDefaultEncryptionConfigurationResponse { } export namespace PutDefaultEncryptionConfigurationResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: PutDefaultEncryptionConfigurationResponse): any => ({ ...obj, }); @@ -4460,6 +4940,9 @@ export interface PutLoggingOptionsRequest { } export namespace PutLoggingOptionsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: PutLoggingOptionsRequest): any => ({ ...obj, }); @@ -4468,6 +4951,9 @@ export namespace PutLoggingOptionsRequest { export interface PutLoggingOptionsResponse {} export namespace PutLoggingOptionsResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: PutLoggingOptionsResponse): any => ({ ...obj, }); @@ -4488,6 +4974,9 @@ export interface TagResourceRequest { } export namespace TagResourceRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: TagResourceRequest): any => ({ ...obj, }); @@ -4496,6 +4985,9 @@ export namespace TagResourceRequest { export interface TagResourceResponse {} export namespace TagResourceResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: TagResourceResponse): any => ({ ...obj, }); @@ -4517,6 +5009,9 @@ export interface TooManyTagsException extends __SmithyException, $MetadataBearer } export namespace TooManyTagsException { + /** + * @internal + */ export const filterSensitiveLog = (obj: TooManyTagsException): any => ({ ...obj, }); @@ -4535,6 +5030,9 @@ export interface UntagResourceRequest { } export namespace UntagResourceRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: UntagResourceRequest): any => ({ ...obj, }); @@ -4543,6 +5041,9 @@ export namespace UntagResourceRequest { export interface UntagResourceResponse {} export namespace UntagResourceResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: UntagResourceResponse): any => ({ ...obj, }); @@ -4576,6 +5077,9 @@ export interface UpdateAccessPolicyRequest { } export namespace UpdateAccessPolicyRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateAccessPolicyRequest): any => ({ ...obj, }); @@ -4584,6 +5088,9 @@ export namespace UpdateAccessPolicyRequest { export interface UpdateAccessPolicyResponse {} export namespace UpdateAccessPolicyResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateAccessPolicyResponse): any => ({ ...obj, }); @@ -4607,6 +5114,9 @@ export interface UpdateAssetRequest { } export namespace UpdateAssetRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateAssetRequest): any => ({ ...obj, }); @@ -4621,6 +5131,9 @@ export interface UpdateAssetResponse { } export namespace UpdateAssetResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateAssetResponse): any => ({ ...obj, }); @@ -4674,6 +5187,9 @@ export interface UpdateAssetModelRequest { } export namespace UpdateAssetModelRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateAssetModelRequest): any => ({ ...obj, }); @@ -4688,6 +5204,9 @@ export interface UpdateAssetModelResponse { } export namespace UpdateAssetModelResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateAssetModelResponse): any => ({ ...obj, }); @@ -4728,6 +5247,9 @@ export interface UpdateAssetPropertyRequest { } export namespace UpdateAssetPropertyRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateAssetPropertyRequest): any => ({ ...obj, }); @@ -4762,6 +5284,9 @@ export interface UpdateDashboardRequest { } export namespace UpdateDashboardRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateDashboardRequest): any => ({ ...obj, }); @@ -4770,6 +5295,9 @@ export namespace UpdateDashboardRequest { export interface UpdateDashboardResponse {} export namespace UpdateDashboardResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateDashboardResponse): any => ({ ...obj, }); @@ -4788,6 +5316,9 @@ export interface UpdateGatewayRequest { } export namespace UpdateGatewayRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateGatewayRequest): any => ({ ...obj, }); @@ -4816,6 +5347,9 @@ export interface UpdateGatewayCapabilityConfigurationRequest { } export namespace UpdateGatewayCapabilityConfigurationRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateGatewayCapabilityConfigurationRequest): any => ({ ...obj, }); @@ -4850,6 +5384,9 @@ export interface UpdateGatewayCapabilityConfigurationResponse { } export namespace UpdateGatewayCapabilityConfigurationResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateGatewayCapabilityConfigurationResponse): any => ({ ...obj, }); @@ -4879,6 +5416,9 @@ export interface Image { } export namespace Image { + /** + * @internal + */ export const filterSensitiveLog = (obj: Image): any => ({ ...obj, }); @@ -4932,6 +5472,9 @@ export interface UpdatePortalRequest { } export namespace UpdatePortalRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdatePortalRequest): any => ({ ...obj, }); @@ -4946,6 +5489,9 @@ export interface UpdatePortalResponse { } export namespace UpdatePortalResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdatePortalResponse): any => ({ ...obj, }); @@ -4974,6 +5520,9 @@ export interface UpdateProjectRequest { } export namespace UpdateProjectRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateProjectRequest): any => ({ ...obj, }); @@ -4982,6 +5531,9 @@ export namespace UpdateProjectRequest { export interface UpdateProjectResponse {} export namespace UpdateProjectResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateProjectResponse): any => ({ ...obj, }); diff --git a/clients/client-iotthingsgraph/commands/AssociateEntityToThingCommand.ts b/clients/client-iotthingsgraph/commands/AssociateEntityToThingCommand.ts index 473479b4f36f..a3916dab8327 100644 --- a/clients/client-iotthingsgraph/commands/AssociateEntityToThingCommand.ts +++ b/clients/client-iotthingsgraph/commands/AssociateEntityToThingCommand.ts @@ -23,6 +23,20 @@ export interface AssociateEntityToThingCommandOutput extends AssociateEntityToTh /** *

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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { IoTThingsGraphClient, AssociateEntityToThingCommand } from "@aws-sdk/client-iotthingsgraph"; // ES Modules import + * // const { IoTThingsGraphClient, AssociateEntityToThingCommand } = require("@aws-sdk/client-iotthingsgraph"); // CommonJS import + * const client = new IoTThingsGraphClient(config); + * const command = new AssociateEntityToThingCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link AssociateEntityToThingCommandInput} for command's `input` shape. + * @see {@link AssociateEntityToThingCommandOutput} for command's `response` shape. + * @see {@link IoTThingsGraphClientResolvedConfig | config} for command's `input` shape. + * */ export class AssociateEntityToThingCommand extends $Command< AssociateEntityToThingCommandInput, diff --git a/clients/client-iotthingsgraph/commands/CreateFlowTemplateCommand.ts b/clients/client-iotthingsgraph/commands/CreateFlowTemplateCommand.ts index 9fce14f40c2b..7700841545fb 100644 --- a/clients/client-iotthingsgraph/commands/CreateFlowTemplateCommand.ts +++ b/clients/client-iotthingsgraph/commands/CreateFlowTemplateCommand.ts @@ -24,6 +24,20 @@ export interface CreateFlowTemplateCommandOutput extends CreateFlowTemplateRespo *

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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { IoTThingsGraphClient, CreateFlowTemplateCommand } from "@aws-sdk/client-iotthingsgraph"; // ES Modules import + * // const { IoTThingsGraphClient, CreateFlowTemplateCommand } = require("@aws-sdk/client-iotthingsgraph"); // CommonJS import + * const client = new IoTThingsGraphClient(config); + * const command = new CreateFlowTemplateCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreateFlowTemplateCommandInput} for command's `input` shape. + * @see {@link CreateFlowTemplateCommandOutput} for command's `response` shape. + * @see {@link IoTThingsGraphClientResolvedConfig | config} for command's `input` shape. + * */ export class CreateFlowTemplateCommand extends $Command< CreateFlowTemplateCommandInput, diff --git a/clients/client-iotthingsgraph/commands/CreateSystemInstanceCommand.ts b/clients/client-iotthingsgraph/commands/CreateSystemInstanceCommand.ts index c05d7fd5a6d4..ff2cf1ee9211 100644 --- a/clients/client-iotthingsgraph/commands/CreateSystemInstanceCommand.ts +++ b/clients/client-iotthingsgraph/commands/CreateSystemInstanceCommand.ts @@ -30,6 +30,20 @@ export interface CreateSystemInstanceCommandOutput extends CreateSystemInstanceR *

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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { IoTThingsGraphClient, CreateSystemInstanceCommand } from "@aws-sdk/client-iotthingsgraph"; // ES Modules import + * // const { IoTThingsGraphClient, CreateSystemInstanceCommand } = require("@aws-sdk/client-iotthingsgraph"); // CommonJS import + * const client = new IoTThingsGraphClient(config); + * const command = new CreateSystemInstanceCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreateSystemInstanceCommandInput} for command's `input` shape. + * @see {@link CreateSystemInstanceCommandOutput} for command's `response` shape. + * @see {@link IoTThingsGraphClientResolvedConfig | config} for command's `input` shape. + * */ export class CreateSystemInstanceCommand extends $Command< CreateSystemInstanceCommandInput, diff --git a/clients/client-iotthingsgraph/commands/CreateSystemTemplateCommand.ts b/clients/client-iotthingsgraph/commands/CreateSystemTemplateCommand.ts index 113a84e660b0..092302426319 100644 --- a/clients/client-iotthingsgraph/commands/CreateSystemTemplateCommand.ts +++ b/clients/client-iotthingsgraph/commands/CreateSystemTemplateCommand.ts @@ -23,6 +23,20 @@ export interface CreateSystemTemplateCommandOutput extends CreateSystemTemplateR /** *

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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { IoTThingsGraphClient, CreateSystemTemplateCommand } from "@aws-sdk/client-iotthingsgraph"; // ES Modules import + * // const { IoTThingsGraphClient, CreateSystemTemplateCommand } = require("@aws-sdk/client-iotthingsgraph"); // CommonJS import + * const client = new IoTThingsGraphClient(config); + * const command = new CreateSystemTemplateCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreateSystemTemplateCommandInput} for command's `input` shape. + * @see {@link CreateSystemTemplateCommandOutput} for command's `response` shape. + * @see {@link IoTThingsGraphClientResolvedConfig | config} for command's `input` shape. + * */ export class CreateSystemTemplateCommand extends $Command< CreateSystemTemplateCommandInput, diff --git a/clients/client-iotthingsgraph/commands/DeleteFlowTemplateCommand.ts b/clients/client-iotthingsgraph/commands/DeleteFlowTemplateCommand.ts index 5dc72f9d5f34..9a809d15e92e 100644 --- a/clients/client-iotthingsgraph/commands/DeleteFlowTemplateCommand.ts +++ b/clients/client-iotthingsgraph/commands/DeleteFlowTemplateCommand.ts @@ -23,6 +23,20 @@ export interface DeleteFlowTemplateCommandOutput extends DeleteFlowTemplateRespo /** *

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).

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { IoTThingsGraphClient, DeleteFlowTemplateCommand } from "@aws-sdk/client-iotthingsgraph"; // ES Modules import + * // const { IoTThingsGraphClient, DeleteFlowTemplateCommand } = require("@aws-sdk/client-iotthingsgraph"); // CommonJS import + * const client = new IoTThingsGraphClient(config); + * const command = new DeleteFlowTemplateCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteFlowTemplateCommandInput} for command's `input` shape. + * @see {@link DeleteFlowTemplateCommandOutput} for command's `response` shape. + * @see {@link IoTThingsGraphClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteFlowTemplateCommand extends $Command< DeleteFlowTemplateCommandInput, diff --git a/clients/client-iotthingsgraph/commands/DeleteNamespaceCommand.ts b/clients/client-iotthingsgraph/commands/DeleteNamespaceCommand.ts index 97918943b979..4a5040365b66 100644 --- a/clients/client-iotthingsgraph/commands/DeleteNamespaceCommand.ts +++ b/clients/client-iotthingsgraph/commands/DeleteNamespaceCommand.ts @@ -22,6 +22,20 @@ export interface DeleteNamespaceCommandOutput extends DeleteNamespaceResponse, _ /** *

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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { IoTThingsGraphClient, DeleteNamespaceCommand } from "@aws-sdk/client-iotthingsgraph"; // ES Modules import + * // const { IoTThingsGraphClient, DeleteNamespaceCommand } = require("@aws-sdk/client-iotthingsgraph"); // CommonJS import + * const client = new IoTThingsGraphClient(config); + * const command = new DeleteNamespaceCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteNamespaceCommandInput} for command's `input` shape. + * @see {@link DeleteNamespaceCommandOutput} for command's `response` shape. + * @see {@link IoTThingsGraphClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteNamespaceCommand extends $Command< DeleteNamespaceCommandInput, diff --git a/clients/client-iotthingsgraph/commands/DeleteSystemInstanceCommand.ts b/clients/client-iotthingsgraph/commands/DeleteSystemInstanceCommand.ts index b94ffa050fe7..b3213890bec1 100644 --- a/clients/client-iotthingsgraph/commands/DeleteSystemInstanceCommand.ts +++ b/clients/client-iotthingsgraph/commands/DeleteSystemInstanceCommand.ts @@ -24,6 +24,20 @@ export interface DeleteSystemInstanceCommandOutput extends DeleteSystemInstanceR *

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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { IoTThingsGraphClient, DeleteSystemInstanceCommand } from "@aws-sdk/client-iotthingsgraph"; // ES Modules import + * // const { IoTThingsGraphClient, DeleteSystemInstanceCommand } = require("@aws-sdk/client-iotthingsgraph"); // CommonJS import + * const client = new IoTThingsGraphClient(config); + * const command = new DeleteSystemInstanceCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteSystemInstanceCommandInput} for command's `input` shape. + * @see {@link DeleteSystemInstanceCommandOutput} for command's `response` shape. + * @see {@link IoTThingsGraphClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteSystemInstanceCommand extends $Command< DeleteSystemInstanceCommandInput, diff --git a/clients/client-iotthingsgraph/commands/DeleteSystemTemplateCommand.ts b/clients/client-iotthingsgraph/commands/DeleteSystemTemplateCommand.ts index 887ed0709eb1..1ee84ef86890 100644 --- a/clients/client-iotthingsgraph/commands/DeleteSystemTemplateCommand.ts +++ b/clients/client-iotthingsgraph/commands/DeleteSystemTemplateCommand.ts @@ -23,6 +23,20 @@ export interface DeleteSystemTemplateCommandOutput extends DeleteSystemTemplateR /** *

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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { IoTThingsGraphClient, DeleteSystemTemplateCommand } from "@aws-sdk/client-iotthingsgraph"; // ES Modules import + * // const { IoTThingsGraphClient, DeleteSystemTemplateCommand } = require("@aws-sdk/client-iotthingsgraph"); // CommonJS import + * const client = new IoTThingsGraphClient(config); + * const command = new DeleteSystemTemplateCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteSystemTemplateCommandInput} for command's `input` shape. + * @see {@link DeleteSystemTemplateCommandOutput} for command's `response` shape. + * @see {@link IoTThingsGraphClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteSystemTemplateCommand extends $Command< DeleteSystemTemplateCommandInput, diff --git a/clients/client-iotthingsgraph/commands/DeploySystemInstanceCommand.ts b/clients/client-iotthingsgraph/commands/DeploySystemInstanceCommand.ts index c00ffd878780..ca12978bca9e 100644 --- a/clients/client-iotthingsgraph/commands/DeploySystemInstanceCommand.ts +++ b/clients/client-iotthingsgraph/commands/DeploySystemInstanceCommand.ts @@ -33,6 +33,20 @@ export interface DeploySystemInstanceCommandOutput extends DeploySystemInstanceR *

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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { IoTThingsGraphClient, DeploySystemInstanceCommand } from "@aws-sdk/client-iotthingsgraph"; // ES Modules import + * // const { IoTThingsGraphClient, DeploySystemInstanceCommand } = require("@aws-sdk/client-iotthingsgraph"); // CommonJS import + * const client = new IoTThingsGraphClient(config); + * const command = new DeploySystemInstanceCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeploySystemInstanceCommandInput} for command's `input` shape. + * @see {@link DeploySystemInstanceCommandOutput} for command's `response` shape. + * @see {@link IoTThingsGraphClientResolvedConfig | config} for command's `input` shape. + * */ export class DeploySystemInstanceCommand extends $Command< DeploySystemInstanceCommandInput, diff --git a/clients/client-iotthingsgraph/commands/DeprecateFlowTemplateCommand.ts b/clients/client-iotthingsgraph/commands/DeprecateFlowTemplateCommand.ts index 783416578f9b..a969700abfdd 100644 --- a/clients/client-iotthingsgraph/commands/DeprecateFlowTemplateCommand.ts +++ b/clients/client-iotthingsgraph/commands/DeprecateFlowTemplateCommand.ts @@ -22,6 +22,20 @@ export interface DeprecateFlowTemplateCommandOutput extends DeprecateFlowTemplat /** *

Deprecates the specified workflow. This action marks the workflow for deletion. Deprecated flows can't be deployed, but existing deployments will continue to run.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { IoTThingsGraphClient, DeprecateFlowTemplateCommand } from "@aws-sdk/client-iotthingsgraph"; // ES Modules import + * // const { IoTThingsGraphClient, DeprecateFlowTemplateCommand } = require("@aws-sdk/client-iotthingsgraph"); // CommonJS import + * const client = new IoTThingsGraphClient(config); + * const command = new DeprecateFlowTemplateCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeprecateFlowTemplateCommandInput} for command's `input` shape. + * @see {@link DeprecateFlowTemplateCommandOutput} for command's `response` shape. + * @see {@link IoTThingsGraphClientResolvedConfig | config} for command's `input` shape. + * */ export class DeprecateFlowTemplateCommand extends $Command< DeprecateFlowTemplateCommandInput, diff --git a/clients/client-iotthingsgraph/commands/DeprecateSystemTemplateCommand.ts b/clients/client-iotthingsgraph/commands/DeprecateSystemTemplateCommand.ts index 849166ce7b22..389bc07d630d 100644 --- a/clients/client-iotthingsgraph/commands/DeprecateSystemTemplateCommand.ts +++ b/clients/client-iotthingsgraph/commands/DeprecateSystemTemplateCommand.ts @@ -22,6 +22,20 @@ export interface DeprecateSystemTemplateCommandOutput extends DeprecateSystemTem /** *

Deprecates the specified system.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { IoTThingsGraphClient, DeprecateSystemTemplateCommand } from "@aws-sdk/client-iotthingsgraph"; // ES Modules import + * // const { IoTThingsGraphClient, DeprecateSystemTemplateCommand } = require("@aws-sdk/client-iotthingsgraph"); // CommonJS import + * const client = new IoTThingsGraphClient(config); + * const command = new DeprecateSystemTemplateCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeprecateSystemTemplateCommandInput} for command's `input` shape. + * @see {@link DeprecateSystemTemplateCommandOutput} for command's `response` shape. + * @see {@link IoTThingsGraphClientResolvedConfig | config} for command's `input` shape. + * */ export class DeprecateSystemTemplateCommand extends $Command< DeprecateSystemTemplateCommandInput, diff --git a/clients/client-iotthingsgraph/commands/DescribeNamespaceCommand.ts b/clients/client-iotthingsgraph/commands/DescribeNamespaceCommand.ts index 17f30bb21cf4..c69bb95f6a45 100644 --- a/clients/client-iotthingsgraph/commands/DescribeNamespaceCommand.ts +++ b/clients/client-iotthingsgraph/commands/DescribeNamespaceCommand.ts @@ -22,6 +22,20 @@ export interface DescribeNamespaceCommandOutput extends DescribeNamespaceRespons /** *

Gets the latest version of the user's namespace and the public version that it is tracking.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { IoTThingsGraphClient, DescribeNamespaceCommand } from "@aws-sdk/client-iotthingsgraph"; // ES Modules import + * // const { IoTThingsGraphClient, DescribeNamespaceCommand } = require("@aws-sdk/client-iotthingsgraph"); // CommonJS import + * const client = new IoTThingsGraphClient(config); + * const command = new DescribeNamespaceCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeNamespaceCommandInput} for command's `input` shape. + * @see {@link DescribeNamespaceCommandOutput} for command's `response` shape. + * @see {@link IoTThingsGraphClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeNamespaceCommand extends $Command< DescribeNamespaceCommandInput, diff --git a/clients/client-iotthingsgraph/commands/DissociateEntityFromThingCommand.ts b/clients/client-iotthingsgraph/commands/DissociateEntityFromThingCommand.ts index 3c7ed3a780e6..4f7396adb28f 100644 --- a/clients/client-iotthingsgraph/commands/DissociateEntityFromThingCommand.ts +++ b/clients/client-iotthingsgraph/commands/DissociateEntityFromThingCommand.ts @@ -23,6 +23,20 @@ export interface DissociateEntityFromThingCommandOutput extends DissociateEntity /** *

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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { IoTThingsGraphClient, DissociateEntityFromThingCommand } from "@aws-sdk/client-iotthingsgraph"; // ES Modules import + * // const { IoTThingsGraphClient, DissociateEntityFromThingCommand } = require("@aws-sdk/client-iotthingsgraph"); // CommonJS import + * const client = new IoTThingsGraphClient(config); + * const command = new DissociateEntityFromThingCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DissociateEntityFromThingCommandInput} for command's `input` shape. + * @see {@link DissociateEntityFromThingCommandOutput} for command's `response` shape. + * @see {@link IoTThingsGraphClientResolvedConfig | config} for command's `input` shape. + * */ export class DissociateEntityFromThingCommand extends $Command< DissociateEntityFromThingCommandInput, diff --git a/clients/client-iotthingsgraph/commands/GetEntitiesCommand.ts b/clients/client-iotthingsgraph/commands/GetEntitiesCommand.ts index b4d43ac7fc82..8ff90ec8e5c7 100644 --- a/clients/client-iotthingsgraph/commands/GetEntitiesCommand.ts +++ b/clients/client-iotthingsgraph/commands/GetEntitiesCommand.ts @@ -53,6 +53,20 @@ export interface GetEntitiesCommandOutput extends GetEntitiesResponse, __Metadat * * *

This action doesn't return definitions for systems, flows, and deployments.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { IoTThingsGraphClient, GetEntitiesCommand } from "@aws-sdk/client-iotthingsgraph"; // ES Modules import + * // const { IoTThingsGraphClient, GetEntitiesCommand } = require("@aws-sdk/client-iotthingsgraph"); // CommonJS import + * const client = new IoTThingsGraphClient(config); + * const command = new GetEntitiesCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetEntitiesCommandInput} for command's `input` shape. + * @see {@link GetEntitiesCommandOutput} for command's `response` shape. + * @see {@link IoTThingsGraphClientResolvedConfig | config} for command's `input` shape. + * */ export class GetEntitiesCommand extends $Command< GetEntitiesCommandInput, diff --git a/clients/client-iotthingsgraph/commands/GetFlowTemplateCommand.ts b/clients/client-iotthingsgraph/commands/GetFlowTemplateCommand.ts index a53ce2d058bc..fabaea781b2f 100644 --- a/clients/client-iotthingsgraph/commands/GetFlowTemplateCommand.ts +++ b/clients/client-iotthingsgraph/commands/GetFlowTemplateCommand.ts @@ -22,6 +22,20 @@ export interface GetFlowTemplateCommandOutput extends GetFlowTemplateResponse, _ /** *

Gets the latest version of the DefinitionDocument and FlowTemplateSummary for the specified workflow.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { IoTThingsGraphClient, GetFlowTemplateCommand } from "@aws-sdk/client-iotthingsgraph"; // ES Modules import + * // const { IoTThingsGraphClient, GetFlowTemplateCommand } = require("@aws-sdk/client-iotthingsgraph"); // CommonJS import + * const client = new IoTThingsGraphClient(config); + * const command = new GetFlowTemplateCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetFlowTemplateCommandInput} for command's `input` shape. + * @see {@link GetFlowTemplateCommandOutput} for command's `response` shape. + * @see {@link IoTThingsGraphClientResolvedConfig | config} for command's `input` shape. + * */ export class GetFlowTemplateCommand extends $Command< GetFlowTemplateCommandInput, diff --git a/clients/client-iotthingsgraph/commands/GetFlowTemplateRevisionsCommand.ts b/clients/client-iotthingsgraph/commands/GetFlowTemplateRevisionsCommand.ts index cc0d03ec7524..56a4124e5ccc 100644 --- a/clients/client-iotthingsgraph/commands/GetFlowTemplateRevisionsCommand.ts +++ b/clients/client-iotthingsgraph/commands/GetFlowTemplateRevisionsCommand.ts @@ -23,6 +23,20 @@ export interface GetFlowTemplateRevisionsCommandOutput extends GetFlowTemplateRe /** *

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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { IoTThingsGraphClient, GetFlowTemplateRevisionsCommand } from "@aws-sdk/client-iotthingsgraph"; // ES Modules import + * // const { IoTThingsGraphClient, GetFlowTemplateRevisionsCommand } = require("@aws-sdk/client-iotthingsgraph"); // CommonJS import + * const client = new IoTThingsGraphClient(config); + * const command = new GetFlowTemplateRevisionsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetFlowTemplateRevisionsCommandInput} for command's `input` shape. + * @see {@link GetFlowTemplateRevisionsCommandOutput} for command's `response` shape. + * @see {@link IoTThingsGraphClientResolvedConfig | config} for command's `input` shape. + * */ export class GetFlowTemplateRevisionsCommand extends $Command< GetFlowTemplateRevisionsCommandInput, diff --git a/clients/client-iotthingsgraph/commands/GetNamespaceDeletionStatusCommand.ts b/clients/client-iotthingsgraph/commands/GetNamespaceDeletionStatusCommand.ts index 574368c6fad7..70b39e421ab6 100644 --- a/clients/client-iotthingsgraph/commands/GetNamespaceDeletionStatusCommand.ts +++ b/clients/client-iotthingsgraph/commands/GetNamespaceDeletionStatusCommand.ts @@ -22,6 +22,20 @@ export interface GetNamespaceDeletionStatusCommandOutput extends GetNamespaceDel /** *

Gets the status of a namespace deletion task.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { IoTThingsGraphClient, GetNamespaceDeletionStatusCommand } from "@aws-sdk/client-iotthingsgraph"; // ES Modules import + * // const { IoTThingsGraphClient, GetNamespaceDeletionStatusCommand } = require("@aws-sdk/client-iotthingsgraph"); // CommonJS import + * const client = new IoTThingsGraphClient(config); + * const command = new GetNamespaceDeletionStatusCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetNamespaceDeletionStatusCommandInput} for command's `input` shape. + * @see {@link GetNamespaceDeletionStatusCommandOutput} for command's `response` shape. + * @see {@link IoTThingsGraphClientResolvedConfig | config} for command's `input` shape. + * */ export class GetNamespaceDeletionStatusCommand extends $Command< GetNamespaceDeletionStatusCommandInput, diff --git a/clients/client-iotthingsgraph/commands/GetSystemInstanceCommand.ts b/clients/client-iotthingsgraph/commands/GetSystemInstanceCommand.ts index c67ca2308a5a..dc475ff37280 100644 --- a/clients/client-iotthingsgraph/commands/GetSystemInstanceCommand.ts +++ b/clients/client-iotthingsgraph/commands/GetSystemInstanceCommand.ts @@ -22,6 +22,20 @@ export interface GetSystemInstanceCommandOutput extends GetSystemInstanceRespons /** *

Gets a system instance.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { IoTThingsGraphClient, GetSystemInstanceCommand } from "@aws-sdk/client-iotthingsgraph"; // ES Modules import + * // const { IoTThingsGraphClient, GetSystemInstanceCommand } = require("@aws-sdk/client-iotthingsgraph"); // CommonJS import + * const client = new IoTThingsGraphClient(config); + * const command = new GetSystemInstanceCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetSystemInstanceCommandInput} for command's `input` shape. + * @see {@link GetSystemInstanceCommandOutput} for command's `response` shape. + * @see {@link IoTThingsGraphClientResolvedConfig | config} for command's `input` shape. + * */ export class GetSystemInstanceCommand extends $Command< GetSystemInstanceCommandInput, diff --git a/clients/client-iotthingsgraph/commands/GetSystemTemplateCommand.ts b/clients/client-iotthingsgraph/commands/GetSystemTemplateCommand.ts index a46a50ce3ac6..fc1b40520095 100644 --- a/clients/client-iotthingsgraph/commands/GetSystemTemplateCommand.ts +++ b/clients/client-iotthingsgraph/commands/GetSystemTemplateCommand.ts @@ -22,6 +22,20 @@ export interface GetSystemTemplateCommandOutput extends GetSystemTemplateRespons /** *

Gets a system.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { IoTThingsGraphClient, GetSystemTemplateCommand } from "@aws-sdk/client-iotthingsgraph"; // ES Modules import + * // const { IoTThingsGraphClient, GetSystemTemplateCommand } = require("@aws-sdk/client-iotthingsgraph"); // CommonJS import + * const client = new IoTThingsGraphClient(config); + * const command = new GetSystemTemplateCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetSystemTemplateCommandInput} for command's `input` shape. + * @see {@link GetSystemTemplateCommandOutput} for command's `response` shape. + * @see {@link IoTThingsGraphClientResolvedConfig | config} for command's `input` shape. + * */ export class GetSystemTemplateCommand extends $Command< GetSystemTemplateCommandInput, diff --git a/clients/client-iotthingsgraph/commands/GetSystemTemplateRevisionsCommand.ts b/clients/client-iotthingsgraph/commands/GetSystemTemplateRevisionsCommand.ts index a1a2be3038c2..2ad9c304f27f 100644 --- a/clients/client-iotthingsgraph/commands/GetSystemTemplateRevisionsCommand.ts +++ b/clients/client-iotthingsgraph/commands/GetSystemTemplateRevisionsCommand.ts @@ -23,6 +23,20 @@ export interface GetSystemTemplateRevisionsCommandOutput extends GetSystemTempla /** *

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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { IoTThingsGraphClient, GetSystemTemplateRevisionsCommand } from "@aws-sdk/client-iotthingsgraph"; // ES Modules import + * // const { IoTThingsGraphClient, GetSystemTemplateRevisionsCommand } = require("@aws-sdk/client-iotthingsgraph"); // CommonJS import + * const client = new IoTThingsGraphClient(config); + * const command = new GetSystemTemplateRevisionsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetSystemTemplateRevisionsCommandInput} for command's `input` shape. + * @see {@link GetSystemTemplateRevisionsCommandOutput} for command's `response` shape. + * @see {@link IoTThingsGraphClientResolvedConfig | config} for command's `input` shape. + * */ export class GetSystemTemplateRevisionsCommand extends $Command< GetSystemTemplateRevisionsCommandInput, diff --git a/clients/client-iotthingsgraph/commands/GetUploadStatusCommand.ts b/clients/client-iotthingsgraph/commands/GetUploadStatusCommand.ts index 8cf4d1db6431..79cae2289067 100644 --- a/clients/client-iotthingsgraph/commands/GetUploadStatusCommand.ts +++ b/clients/client-iotthingsgraph/commands/GetUploadStatusCommand.ts @@ -22,6 +22,20 @@ export interface GetUploadStatusCommandOutput extends GetUploadStatusResponse, _ /** *

Gets the status of the specified upload.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { IoTThingsGraphClient, GetUploadStatusCommand } from "@aws-sdk/client-iotthingsgraph"; // ES Modules import + * // const { IoTThingsGraphClient, GetUploadStatusCommand } = require("@aws-sdk/client-iotthingsgraph"); // CommonJS import + * const client = new IoTThingsGraphClient(config); + * const command = new GetUploadStatusCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetUploadStatusCommandInput} for command's `input` shape. + * @see {@link GetUploadStatusCommandOutput} for command's `response` shape. + * @see {@link IoTThingsGraphClientResolvedConfig | config} for command's `input` shape. + * */ export class GetUploadStatusCommand extends $Command< GetUploadStatusCommandInput, diff --git a/clients/client-iotthingsgraph/commands/ListFlowExecutionMessagesCommand.ts b/clients/client-iotthingsgraph/commands/ListFlowExecutionMessagesCommand.ts index c1a487ff91ae..f0e812baab6f 100644 --- a/clients/client-iotthingsgraph/commands/ListFlowExecutionMessagesCommand.ts +++ b/clients/client-iotthingsgraph/commands/ListFlowExecutionMessagesCommand.ts @@ -22,6 +22,20 @@ export interface ListFlowExecutionMessagesCommandOutput extends ListFlowExecutio /** *

Returns a list of objects that contain information about events in a flow execution.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { IoTThingsGraphClient, ListFlowExecutionMessagesCommand } from "@aws-sdk/client-iotthingsgraph"; // ES Modules import + * // const { IoTThingsGraphClient, ListFlowExecutionMessagesCommand } = require("@aws-sdk/client-iotthingsgraph"); // CommonJS import + * const client = new IoTThingsGraphClient(config); + * const command = new ListFlowExecutionMessagesCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListFlowExecutionMessagesCommandInput} for command's `input` shape. + * @see {@link ListFlowExecutionMessagesCommandOutput} for command's `response` shape. + * @see {@link IoTThingsGraphClientResolvedConfig | config} for command's `input` shape. + * */ export class ListFlowExecutionMessagesCommand extends $Command< ListFlowExecutionMessagesCommandInput, diff --git a/clients/client-iotthingsgraph/commands/ListTagsForResourceCommand.ts b/clients/client-iotthingsgraph/commands/ListTagsForResourceCommand.ts index bc756992c384..9196d77a5cac 100644 --- a/clients/client-iotthingsgraph/commands/ListTagsForResourceCommand.ts +++ b/clients/client-iotthingsgraph/commands/ListTagsForResourceCommand.ts @@ -22,6 +22,20 @@ export interface ListTagsForResourceCommandOutput extends ListTagsForResourceRes /** *

Lists all tags on an AWS IoT Things Graph resource.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { IoTThingsGraphClient, ListTagsForResourceCommand } from "@aws-sdk/client-iotthingsgraph"; // ES Modules import + * // const { IoTThingsGraphClient, ListTagsForResourceCommand } = require("@aws-sdk/client-iotthingsgraph"); // CommonJS import + * const client = new IoTThingsGraphClient(config); + * const command = new ListTagsForResourceCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListTagsForResourceCommandInput} for command's `input` shape. + * @see {@link ListTagsForResourceCommandOutput} for command's `response` shape. + * @see {@link IoTThingsGraphClientResolvedConfig | config} for command's `input` shape. + * */ export class ListTagsForResourceCommand extends $Command< ListTagsForResourceCommandInput, diff --git a/clients/client-iotthingsgraph/commands/SearchEntitiesCommand.ts b/clients/client-iotthingsgraph/commands/SearchEntitiesCommand.ts index ead30ff7be1a..71d23ecf848d 100644 --- a/clients/client-iotthingsgraph/commands/SearchEntitiesCommand.ts +++ b/clients/client-iotthingsgraph/commands/SearchEntitiesCommand.ts @@ -22,6 +22,20 @@ export interface SearchEntitiesCommandOutput extends SearchEntitiesResponse, __M /** *

Searches for entities of the specified type. You can search for entities in your namespace and the public namespace that you're tracking.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { IoTThingsGraphClient, SearchEntitiesCommand } from "@aws-sdk/client-iotthingsgraph"; // ES Modules import + * // const { IoTThingsGraphClient, SearchEntitiesCommand } = require("@aws-sdk/client-iotthingsgraph"); // CommonJS import + * const client = new IoTThingsGraphClient(config); + * const command = new SearchEntitiesCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link SearchEntitiesCommandInput} for command's `input` shape. + * @see {@link SearchEntitiesCommandOutput} for command's `response` shape. + * @see {@link IoTThingsGraphClientResolvedConfig | config} for command's `input` shape. + * */ export class SearchEntitiesCommand extends $Command< SearchEntitiesCommandInput, diff --git a/clients/client-iotthingsgraph/commands/SearchFlowExecutionsCommand.ts b/clients/client-iotthingsgraph/commands/SearchFlowExecutionsCommand.ts index 80f129cef960..f847c5515b28 100644 --- a/clients/client-iotthingsgraph/commands/SearchFlowExecutionsCommand.ts +++ b/clients/client-iotthingsgraph/commands/SearchFlowExecutionsCommand.ts @@ -22,6 +22,20 @@ export interface SearchFlowExecutionsCommandOutput extends SearchFlowExecutionsR /** *

Searches for AWS IoT Things Graph workflow execution instances.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { IoTThingsGraphClient, SearchFlowExecutionsCommand } from "@aws-sdk/client-iotthingsgraph"; // ES Modules import + * // const { IoTThingsGraphClient, SearchFlowExecutionsCommand } = require("@aws-sdk/client-iotthingsgraph"); // CommonJS import + * const client = new IoTThingsGraphClient(config); + * const command = new SearchFlowExecutionsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link SearchFlowExecutionsCommandInput} for command's `input` shape. + * @see {@link SearchFlowExecutionsCommandOutput} for command's `response` shape. + * @see {@link IoTThingsGraphClientResolvedConfig | config} for command's `input` shape. + * */ export class SearchFlowExecutionsCommand extends $Command< SearchFlowExecutionsCommandInput, diff --git a/clients/client-iotthingsgraph/commands/SearchFlowTemplatesCommand.ts b/clients/client-iotthingsgraph/commands/SearchFlowTemplatesCommand.ts index cd4fbdbe99bb..4c08399997b0 100644 --- a/clients/client-iotthingsgraph/commands/SearchFlowTemplatesCommand.ts +++ b/clients/client-iotthingsgraph/commands/SearchFlowTemplatesCommand.ts @@ -22,6 +22,20 @@ export interface SearchFlowTemplatesCommandOutput extends SearchFlowTemplatesRes /** *

Searches for summary information about workflows.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { IoTThingsGraphClient, SearchFlowTemplatesCommand } from "@aws-sdk/client-iotthingsgraph"; // ES Modules import + * // const { IoTThingsGraphClient, SearchFlowTemplatesCommand } = require("@aws-sdk/client-iotthingsgraph"); // CommonJS import + * const client = new IoTThingsGraphClient(config); + * const command = new SearchFlowTemplatesCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link SearchFlowTemplatesCommandInput} for command's `input` shape. + * @see {@link SearchFlowTemplatesCommandOutput} for command's `response` shape. + * @see {@link IoTThingsGraphClientResolvedConfig | config} for command's `input` shape. + * */ export class SearchFlowTemplatesCommand extends $Command< SearchFlowTemplatesCommandInput, diff --git a/clients/client-iotthingsgraph/commands/SearchSystemInstancesCommand.ts b/clients/client-iotthingsgraph/commands/SearchSystemInstancesCommand.ts index 8ef2be180df7..6e124b1bdd6a 100644 --- a/clients/client-iotthingsgraph/commands/SearchSystemInstancesCommand.ts +++ b/clients/client-iotthingsgraph/commands/SearchSystemInstancesCommand.ts @@ -22,6 +22,20 @@ export interface SearchSystemInstancesCommandOutput extends SearchSystemInstance /** *

Searches for system instances in the user's account.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { IoTThingsGraphClient, SearchSystemInstancesCommand } from "@aws-sdk/client-iotthingsgraph"; // ES Modules import + * // const { IoTThingsGraphClient, SearchSystemInstancesCommand } = require("@aws-sdk/client-iotthingsgraph"); // CommonJS import + * const client = new IoTThingsGraphClient(config); + * const command = new SearchSystemInstancesCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link SearchSystemInstancesCommandInput} for command's `input` shape. + * @see {@link SearchSystemInstancesCommandOutput} for command's `response` shape. + * @see {@link IoTThingsGraphClientResolvedConfig | config} for command's `input` shape. + * */ export class SearchSystemInstancesCommand extends $Command< SearchSystemInstancesCommandInput, diff --git a/clients/client-iotthingsgraph/commands/SearchSystemTemplatesCommand.ts b/clients/client-iotthingsgraph/commands/SearchSystemTemplatesCommand.ts index e907435d7dfc..54cfa3466216 100644 --- a/clients/client-iotthingsgraph/commands/SearchSystemTemplatesCommand.ts +++ b/clients/client-iotthingsgraph/commands/SearchSystemTemplatesCommand.ts @@ -22,6 +22,20 @@ export interface SearchSystemTemplatesCommandOutput extends SearchSystemTemplate /** *

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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { IoTThingsGraphClient, SearchSystemTemplatesCommand } from "@aws-sdk/client-iotthingsgraph"; // ES Modules import + * // const { IoTThingsGraphClient, SearchSystemTemplatesCommand } = require("@aws-sdk/client-iotthingsgraph"); // CommonJS import + * const client = new IoTThingsGraphClient(config); + * const command = new SearchSystemTemplatesCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link SearchSystemTemplatesCommandInput} for command's `input` shape. + * @see {@link SearchSystemTemplatesCommandOutput} for command's `response` shape. + * @see {@link IoTThingsGraphClientResolvedConfig | config} for command's `input` shape. + * */ export class SearchSystemTemplatesCommand extends $Command< SearchSystemTemplatesCommandInput, diff --git a/clients/client-iotthingsgraph/commands/SearchThingsCommand.ts b/clients/client-iotthingsgraph/commands/SearchThingsCommand.ts index ad84409678c7..0b008ee50041 100644 --- a/clients/client-iotthingsgraph/commands/SearchThingsCommand.ts +++ b/clients/client-iotthingsgraph/commands/SearchThingsCommand.ts @@ -25,6 +25,20 @@ export interface SearchThingsCommandOutput extends SearchThingsResponse, __Metad *

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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { IoTThingsGraphClient, SearchThingsCommand } from "@aws-sdk/client-iotthingsgraph"; // ES Modules import + * // const { IoTThingsGraphClient, SearchThingsCommand } = require("@aws-sdk/client-iotthingsgraph"); // CommonJS import + * const client = new IoTThingsGraphClient(config); + * const command = new SearchThingsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link SearchThingsCommandInput} for command's `input` shape. + * @see {@link SearchThingsCommandOutput} for command's `response` shape. + * @see {@link IoTThingsGraphClientResolvedConfig | config} for command's `input` shape. + * */ export class SearchThingsCommand extends $Command< SearchThingsCommandInput, diff --git a/clients/client-iotthingsgraph/commands/TagResourceCommand.ts b/clients/client-iotthingsgraph/commands/TagResourceCommand.ts index 6474def383fd..b9f1f74b22fa 100644 --- a/clients/client-iotthingsgraph/commands/TagResourceCommand.ts +++ b/clients/client-iotthingsgraph/commands/TagResourceCommand.ts @@ -22,6 +22,20 @@ export interface TagResourceCommandOutput extends TagResourceResponse, __Metadat /** *

Creates a tag for the specified resource.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { IoTThingsGraphClient, TagResourceCommand } from "@aws-sdk/client-iotthingsgraph"; // ES Modules import + * // const { IoTThingsGraphClient, TagResourceCommand } = require("@aws-sdk/client-iotthingsgraph"); // CommonJS import + * const client = new IoTThingsGraphClient(config); + * const command = new TagResourceCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link TagResourceCommandInput} for command's `input` shape. + * @see {@link TagResourceCommandOutput} for command's `response` shape. + * @see {@link IoTThingsGraphClientResolvedConfig | config} for command's `input` shape. + * */ export class TagResourceCommand extends $Command< TagResourceCommandInput, diff --git a/clients/client-iotthingsgraph/commands/UndeploySystemInstanceCommand.ts b/clients/client-iotthingsgraph/commands/UndeploySystemInstanceCommand.ts index 930aac7caf1a..0b09a19a8741 100644 --- a/clients/client-iotthingsgraph/commands/UndeploySystemInstanceCommand.ts +++ b/clients/client-iotthingsgraph/commands/UndeploySystemInstanceCommand.ts @@ -22,6 +22,20 @@ export interface UndeploySystemInstanceCommandOutput extends UndeploySystemInsta /** *

Removes a system instance from its target (Cloud or Greengrass).

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { IoTThingsGraphClient, UndeploySystemInstanceCommand } from "@aws-sdk/client-iotthingsgraph"; // ES Modules import + * // const { IoTThingsGraphClient, UndeploySystemInstanceCommand } = require("@aws-sdk/client-iotthingsgraph"); // CommonJS import + * const client = new IoTThingsGraphClient(config); + * const command = new UndeploySystemInstanceCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link UndeploySystemInstanceCommandInput} for command's `input` shape. + * @see {@link UndeploySystemInstanceCommandOutput} for command's `response` shape. + * @see {@link IoTThingsGraphClientResolvedConfig | config} for command's `input` shape. + * */ export class UndeploySystemInstanceCommand extends $Command< UndeploySystemInstanceCommandInput, diff --git a/clients/client-iotthingsgraph/commands/UntagResourceCommand.ts b/clients/client-iotthingsgraph/commands/UntagResourceCommand.ts index 4a2bfab58630..c3ea7803dbda 100644 --- a/clients/client-iotthingsgraph/commands/UntagResourceCommand.ts +++ b/clients/client-iotthingsgraph/commands/UntagResourceCommand.ts @@ -22,6 +22,20 @@ export interface UntagResourceCommandOutput extends UntagResourceResponse, __Met /** *

Removes a tag from the specified resource.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { IoTThingsGraphClient, UntagResourceCommand } from "@aws-sdk/client-iotthingsgraph"; // ES Modules import + * // const { IoTThingsGraphClient, UntagResourceCommand } = require("@aws-sdk/client-iotthingsgraph"); // CommonJS import + * const client = new IoTThingsGraphClient(config); + * const command = new UntagResourceCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link UntagResourceCommandInput} for command's `input` shape. + * @see {@link UntagResourceCommandOutput} for command's `response` shape. + * @see {@link IoTThingsGraphClientResolvedConfig | config} for command's `input` shape. + * */ export class UntagResourceCommand extends $Command< UntagResourceCommandInput, diff --git a/clients/client-iotthingsgraph/commands/UpdateFlowTemplateCommand.ts b/clients/client-iotthingsgraph/commands/UpdateFlowTemplateCommand.ts index 5f255e593cbd..ea1ae59f33b0 100644 --- a/clients/client-iotthingsgraph/commands/UpdateFlowTemplateCommand.ts +++ b/clients/client-iotthingsgraph/commands/UpdateFlowTemplateCommand.ts @@ -23,6 +23,20 @@ export interface UpdateFlowTemplateCommandOutput extends UpdateFlowTemplateRespo /** *

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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { IoTThingsGraphClient, UpdateFlowTemplateCommand } from "@aws-sdk/client-iotthingsgraph"; // ES Modules import + * // const { IoTThingsGraphClient, UpdateFlowTemplateCommand } = require("@aws-sdk/client-iotthingsgraph"); // CommonJS import + * const client = new IoTThingsGraphClient(config); + * const command = new UpdateFlowTemplateCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link UpdateFlowTemplateCommandInput} for command's `input` shape. + * @see {@link UpdateFlowTemplateCommandOutput} for command's `response` shape. + * @see {@link IoTThingsGraphClientResolvedConfig | config} for command's `input` shape. + * */ export class UpdateFlowTemplateCommand extends $Command< UpdateFlowTemplateCommandInput, diff --git a/clients/client-iotthingsgraph/commands/UpdateSystemTemplateCommand.ts b/clients/client-iotthingsgraph/commands/UpdateSystemTemplateCommand.ts index 6ea506a67a76..3e8778c5a910 100644 --- a/clients/client-iotthingsgraph/commands/UpdateSystemTemplateCommand.ts +++ b/clients/client-iotthingsgraph/commands/UpdateSystemTemplateCommand.ts @@ -22,6 +22,20 @@ export interface UpdateSystemTemplateCommandOutput extends UpdateSystemTemplateR /** *

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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { IoTThingsGraphClient, UpdateSystemTemplateCommand } from "@aws-sdk/client-iotthingsgraph"; // ES Modules import + * // const { IoTThingsGraphClient, UpdateSystemTemplateCommand } = require("@aws-sdk/client-iotthingsgraph"); // CommonJS import + * const client = new IoTThingsGraphClient(config); + * const command = new UpdateSystemTemplateCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link UpdateSystemTemplateCommandInput} for command's `input` shape. + * @see {@link UpdateSystemTemplateCommandOutput} for command's `response` shape. + * @see {@link IoTThingsGraphClientResolvedConfig | config} for command's `input` shape. + * */ export class UpdateSystemTemplateCommand extends $Command< UpdateSystemTemplateCommandInput, diff --git a/clients/client-iotthingsgraph/commands/UploadEntityDefinitionsCommand.ts b/clients/client-iotthingsgraph/commands/UploadEntityDefinitionsCommand.ts index e50ff41ca6d9..46f5a9cebe00 100644 --- a/clients/client-iotthingsgraph/commands/UploadEntityDefinitionsCommand.ts +++ b/clients/client-iotthingsgraph/commands/UploadEntityDefinitionsCommand.ts @@ -32,6 +32,20 @@ export interface UploadEntityDefinitionsCommandOutput extends UploadEntityDefini *

Valid entities are Device, DeviceModel, Service, Capability, State, Action, Event, Property, * Mapping, Enum. *

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { IoTThingsGraphClient, UploadEntityDefinitionsCommand } from "@aws-sdk/client-iotthingsgraph"; // ES Modules import + * // const { IoTThingsGraphClient, UploadEntityDefinitionsCommand } = require("@aws-sdk/client-iotthingsgraph"); // CommonJS import + * const client = new IoTThingsGraphClient(config); + * const command = new UploadEntityDefinitionsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link UploadEntityDefinitionsCommandInput} for command's `input` shape. + * @see {@link UploadEntityDefinitionsCommandOutput} for command's `response` shape. + * @see {@link IoTThingsGraphClientResolvedConfig | config} for command's `input` shape. + * */ export class UploadEntityDefinitionsCommand extends $Command< UploadEntityDefinitionsCommandInput, diff --git a/clients/client-iotthingsgraph/models/models_0.ts b/clients/client-iotthingsgraph/models/models_0.ts index fb492a6c7685..ee1c0ffe7e5b 100644 --- a/clients/client-iotthingsgraph/models/models_0.ts +++ b/clients/client-iotthingsgraph/models/models_0.ts @@ -23,6 +23,9 @@ export interface AssociateEntityToThingRequest { } export namespace AssociateEntityToThingRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: AssociateEntityToThingRequest): any => ({ ...obj, }); @@ -31,6 +34,9 @@ export namespace AssociateEntityToThingRequest { export interface AssociateEntityToThingResponse {} export namespace AssociateEntityToThingResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: AssociateEntityToThingResponse): any => ({ ...obj, }); @@ -46,6 +52,9 @@ export interface InternalFailureException extends __SmithyException, $MetadataBe } export namespace InternalFailureException { + /** + * @internal + */ export const filterSensitiveLog = (obj: InternalFailureException): any => ({ ...obj, }); @@ -61,6 +70,9 @@ export interface InvalidRequestException extends __SmithyException, $MetadataBea } export namespace InvalidRequestException { + /** + * @internal + */ export const filterSensitiveLog = (obj: InvalidRequestException): any => ({ ...obj, }); @@ -76,6 +88,9 @@ export interface ResourceNotFoundException extends __SmithyException, $MetadataB } export namespace ResourceNotFoundException { + /** + * @internal + */ export const filterSensitiveLog = (obj: ResourceNotFoundException): any => ({ ...obj, }); @@ -91,6 +106,9 @@ export interface ThrottlingException extends __SmithyException, $MetadataBearer } export namespace ThrottlingException { + /** + * @internal + */ export const filterSensitiveLog = (obj: ThrottlingException): any => ({ ...obj, }); @@ -116,6 +134,9 @@ export interface DefinitionDocument { } export namespace DefinitionDocument { + /** + * @internal + */ export const filterSensitiveLog = (obj: DefinitionDocument): any => ({ ...obj, }); @@ -135,6 +156,9 @@ export interface CreateFlowTemplateRequest { } export namespace CreateFlowTemplateRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateFlowTemplateRequest): any => ({ ...obj, }); @@ -166,6 +190,9 @@ export interface FlowTemplateSummary { } export namespace FlowTemplateSummary { + /** + * @internal + */ export const filterSensitiveLog = (obj: FlowTemplateSummary): any => ({ ...obj, }); @@ -179,6 +206,9 @@ export interface CreateFlowTemplateResponse { } export namespace CreateFlowTemplateResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateFlowTemplateResponse): any => ({ ...obj, }); @@ -194,6 +224,9 @@ export interface LimitExceededException extends __SmithyException, $MetadataBear } export namespace LimitExceededException { + /** + * @internal + */ export const filterSensitiveLog = (obj: LimitExceededException): any => ({ ...obj, }); @@ -209,6 +242,9 @@ export interface ResourceAlreadyExistsException extends __SmithyException, $Meta } export namespace ResourceAlreadyExistsException { + /** + * @internal + */ export const filterSensitiveLog = (obj: ResourceAlreadyExistsException): any => ({ ...obj, }); @@ -230,6 +266,9 @@ export interface MetricsConfiguration { } export namespace MetricsConfiguration { + /** + * @internal + */ export const filterSensitiveLog = (obj: MetricsConfiguration): any => ({ ...obj, }); @@ -251,6 +290,9 @@ export interface Tag { } export namespace Tag { + /** + * @internal + */ export const filterSensitiveLog = (obj: Tag): any => ({ ...obj, }); @@ -303,6 +345,9 @@ export interface CreateSystemInstanceRequest { } export namespace CreateSystemInstanceRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateSystemInstanceRequest): any => ({ ...obj, }); @@ -372,6 +417,9 @@ export interface SystemInstanceSummary { } export namespace SystemInstanceSummary { + /** + * @internal + */ export const filterSensitiveLog = (obj: SystemInstanceSummary): any => ({ ...obj, }); @@ -385,6 +433,9 @@ export interface CreateSystemInstanceResponse { } export namespace CreateSystemInstanceResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateSystemInstanceResponse): any => ({ ...obj, }); @@ -404,6 +455,9 @@ export interface CreateSystemTemplateRequest { } export namespace CreateSystemTemplateRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateSystemTemplateRequest): any => ({ ...obj, }); @@ -435,6 +489,9 @@ export interface SystemTemplateSummary { } export namespace SystemTemplateSummary { + /** + * @internal + */ export const filterSensitiveLog = (obj: SystemTemplateSummary): any => ({ ...obj, }); @@ -448,6 +505,9 @@ export interface CreateSystemTemplateResponse { } export namespace CreateSystemTemplateResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateSystemTemplateResponse): any => ({ ...obj, }); @@ -465,6 +525,9 @@ export interface DeleteFlowTemplateRequest { } export namespace DeleteFlowTemplateRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteFlowTemplateRequest): any => ({ ...obj, }); @@ -473,6 +536,9 @@ export namespace DeleteFlowTemplateRequest { export interface DeleteFlowTemplateResponse {} export namespace DeleteFlowTemplateResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteFlowTemplateResponse): any => ({ ...obj, }); @@ -488,6 +554,9 @@ export interface ResourceInUseException extends __SmithyException, $MetadataBear } export namespace ResourceInUseException { + /** + * @internal + */ export const filterSensitiveLog = (obj: ResourceInUseException): any => ({ ...obj, }); @@ -496,6 +565,9 @@ export namespace ResourceInUseException { export interface DeleteNamespaceRequest {} export namespace DeleteNamespaceRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteNamespaceRequest): any => ({ ...obj, }); @@ -514,6 +586,9 @@ export interface DeleteNamespaceResponse { } export namespace DeleteNamespaceResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteNamespaceResponse): any => ({ ...obj, }); @@ -527,6 +602,9 @@ export interface DeleteSystemInstanceRequest { } export namespace DeleteSystemInstanceRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteSystemInstanceRequest): any => ({ ...obj, }); @@ -535,6 +613,9 @@ export namespace DeleteSystemInstanceRequest { export interface DeleteSystemInstanceResponse {} export namespace DeleteSystemInstanceResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteSystemInstanceResponse): any => ({ ...obj, }); @@ -552,6 +633,9 @@ export interface DeleteSystemTemplateRequest { } export namespace DeleteSystemTemplateRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteSystemTemplateRequest): any => ({ ...obj, }); @@ -560,6 +644,9 @@ export namespace DeleteSystemTemplateRequest { export interface DeleteSystemTemplateResponse {} export namespace DeleteSystemTemplateResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteSystemTemplateResponse): any => ({ ...obj, }); @@ -581,6 +668,9 @@ export interface DependencyRevision { } export namespace DependencyRevision { + /** + * @internal + */ export const filterSensitiveLog = (obj: DependencyRevision): any => ({ ...obj, }); @@ -598,6 +688,9 @@ export interface DeploySystemInstanceRequest { } export namespace DeploySystemInstanceRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeploySystemInstanceRequest): any => ({ ...obj, }); @@ -616,6 +709,9 @@ export interface DeploySystemInstanceResponse { } export namespace DeploySystemInstanceResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeploySystemInstanceResponse): any => ({ ...obj, }); @@ -633,6 +729,9 @@ export interface DeprecateFlowTemplateRequest { } export namespace DeprecateFlowTemplateRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeprecateFlowTemplateRequest): any => ({ ...obj, }); @@ -641,6 +740,9 @@ export namespace DeprecateFlowTemplateRequest { export interface DeprecateFlowTemplateResponse {} export namespace DeprecateFlowTemplateResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeprecateFlowTemplateResponse): any => ({ ...obj, }); @@ -658,6 +760,9 @@ export interface DeprecateSystemTemplateRequest { } export namespace DeprecateSystemTemplateRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeprecateSystemTemplateRequest): any => ({ ...obj, }); @@ -666,6 +771,9 @@ export namespace DeprecateSystemTemplateRequest { export interface DeprecateSystemTemplateResponse {} export namespace DeprecateSystemTemplateResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeprecateSystemTemplateResponse): any => ({ ...obj, }); @@ -679,6 +787,9 @@ export interface DescribeNamespaceRequest { } export namespace DescribeNamespaceRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeNamespaceRequest): any => ({ ...obj, }); @@ -712,6 +823,9 @@ export interface DescribeNamespaceResponse { } export namespace DescribeNamespaceResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeNamespaceResponse): any => ({ ...obj, }); @@ -743,6 +857,9 @@ export interface DissociateEntityFromThingRequest { } export namespace DissociateEntityFromThingRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DissociateEntityFromThingRequest): any => ({ ...obj, }); @@ -751,6 +868,9 @@ export namespace DissociateEntityFromThingRequest { export interface DissociateEntityFromThingResponse {} export namespace DissociateEntityFromThingResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DissociateEntityFromThingResponse): any => ({ ...obj, }); @@ -787,6 +907,9 @@ export interface EntityDescription { } export namespace EntityDescription { + /** + * @internal + */ export const filterSensitiveLog = (obj: EntityDescription): any => ({ ...obj, }); @@ -818,6 +941,9 @@ export interface EntityFilter { } export namespace EntityFilter { + /** + * @internal + */ export const filterSensitiveLog = (obj: EntityFilter): any => ({ ...obj, }); @@ -869,6 +995,9 @@ export interface FlowExecutionMessage { } export namespace FlowExecutionMessage { + /** + * @internal + */ export const filterSensitiveLog = (obj: FlowExecutionMessage): any => ({ ...obj, }); @@ -917,6 +1046,9 @@ export interface FlowExecutionSummary { } export namespace FlowExecutionSummary { + /** + * @internal + */ export const filterSensitiveLog = (obj: FlowExecutionSummary): any => ({ ...obj, }); @@ -943,6 +1075,9 @@ export interface FlowTemplateDescription { } export namespace FlowTemplateDescription { + /** + * @internal + */ export const filterSensitiveLog = (obj: FlowTemplateDescription): any => ({ ...obj, }); @@ -968,6 +1103,9 @@ export interface FlowTemplateFilter { } export namespace FlowTemplateFilter { + /** + * @internal + */ export const filterSensitiveLog = (obj: FlowTemplateFilter): any => ({ ...obj, }); @@ -990,6 +1128,9 @@ export interface GetEntitiesRequest { } export namespace GetEntitiesRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetEntitiesRequest): any => ({ ...obj, }); @@ -1003,6 +1144,9 @@ export interface GetEntitiesResponse { } export namespace GetEntitiesResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetEntitiesResponse): any => ({ ...obj, }); @@ -1025,6 +1169,9 @@ export interface GetFlowTemplateRequest { } export namespace GetFlowTemplateRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetFlowTemplateRequest): any => ({ ...obj, }); @@ -1038,6 +1185,9 @@ export interface GetFlowTemplateResponse { } export namespace GetFlowTemplateResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetFlowTemplateResponse): any => ({ ...obj, }); @@ -1065,6 +1215,9 @@ export interface GetFlowTemplateRevisionsRequest { } export namespace GetFlowTemplateRevisionsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetFlowTemplateRevisionsRequest): any => ({ ...obj, }); @@ -1083,6 +1236,9 @@ export interface GetFlowTemplateRevisionsResponse { } export namespace GetFlowTemplateRevisionsResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetFlowTemplateRevisionsResponse): any => ({ ...obj, }); @@ -1091,6 +1247,9 @@ export namespace GetFlowTemplateRevisionsResponse { export interface GetNamespaceDeletionStatusRequest {} export namespace GetNamespaceDeletionStatusRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetNamespaceDeletionStatusRequest): any => ({ ...obj, }); @@ -1134,6 +1293,9 @@ export interface GetNamespaceDeletionStatusResponse { } export namespace GetNamespaceDeletionStatusResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetNamespaceDeletionStatusResponse): any => ({ ...obj, }); @@ -1151,6 +1313,9 @@ export interface GetSystemInstanceRequest { } export namespace GetSystemInstanceRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetSystemInstanceRequest): any => ({ ...obj, }); @@ -1199,6 +1364,9 @@ export interface SystemInstanceDescription { } export namespace SystemInstanceDescription { + /** + * @internal + */ export const filterSensitiveLog = (obj: SystemInstanceDescription): any => ({ ...obj, }); @@ -1212,6 +1380,9 @@ export interface GetSystemInstanceResponse { } export namespace GetSystemInstanceResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetSystemInstanceResponse): any => ({ ...obj, }); @@ -1234,6 +1405,9 @@ export interface GetSystemTemplateRequest { } export namespace GetSystemTemplateRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetSystemTemplateRequest): any => ({ ...obj, }); @@ -1260,6 +1434,9 @@ export interface SystemTemplateDescription { } export namespace SystemTemplateDescription { + /** + * @internal + */ export const filterSensitiveLog = (obj: SystemTemplateDescription): any => ({ ...obj, }); @@ -1273,6 +1450,9 @@ export interface GetSystemTemplateResponse { } export namespace GetSystemTemplateResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetSystemTemplateResponse): any => ({ ...obj, }); @@ -1300,6 +1480,9 @@ export interface GetSystemTemplateRevisionsRequest { } export namespace GetSystemTemplateRevisionsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetSystemTemplateRevisionsRequest): any => ({ ...obj, }); @@ -1318,6 +1501,9 @@ export interface GetSystemTemplateRevisionsResponse { } export namespace GetSystemTemplateRevisionsResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetSystemTemplateRevisionsResponse): any => ({ ...obj, }); @@ -1331,6 +1517,9 @@ export interface GetUploadStatusRequest { } export namespace GetUploadStatusRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetUploadStatusRequest): any => ({ ...obj, }); @@ -1380,6 +1569,9 @@ export interface GetUploadStatusResponse { } export namespace GetUploadStatusResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetUploadStatusResponse): any => ({ ...obj, }); @@ -1403,6 +1595,9 @@ export interface ListFlowExecutionMessagesRequest { } export namespace ListFlowExecutionMessagesRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListFlowExecutionMessagesRequest): any => ({ ...obj, }); @@ -1421,6 +1616,9 @@ export interface ListFlowExecutionMessagesResponse { } export namespace ListFlowExecutionMessagesResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListFlowExecutionMessagesResponse): any => ({ ...obj, }); @@ -1444,6 +1642,9 @@ export interface ListTagsForResourceRequest { } export namespace ListTagsForResourceRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListTagsForResourceRequest): any => ({ ...obj, }); @@ -1462,6 +1663,9 @@ export interface ListTagsForResourceResponse { } export namespace ListTagsForResourceResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListTagsForResourceResponse): any => ({ ...obj, }); @@ -1499,6 +1703,9 @@ export interface SearchEntitiesRequest { } export namespace SearchEntitiesRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: SearchEntitiesRequest): any => ({ ...obj, }); @@ -1517,6 +1724,9 @@ export interface SearchEntitiesResponse { } export namespace SearchEntitiesResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: SearchEntitiesResponse): any => ({ ...obj, }); @@ -1555,6 +1765,9 @@ export interface SearchFlowExecutionsRequest { } export namespace SearchFlowExecutionsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: SearchFlowExecutionsRequest): any => ({ ...obj, }); @@ -1573,6 +1786,9 @@ export interface SearchFlowExecutionsResponse { } export namespace SearchFlowExecutionsResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: SearchFlowExecutionsResponse): any => ({ ...obj, }); @@ -1596,6 +1812,9 @@ export interface SearchFlowTemplatesRequest { } export namespace SearchFlowTemplatesRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: SearchFlowTemplatesRequest): any => ({ ...obj, }); @@ -1614,6 +1833,9 @@ export interface SearchFlowTemplatesResponse { } export namespace SearchFlowTemplatesResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: SearchFlowTemplatesResponse): any => ({ ...obj, }); @@ -1643,6 +1865,9 @@ export interface SystemInstanceFilter { } export namespace SystemInstanceFilter { + /** + * @internal + */ export const filterSensitiveLog = (obj: SystemInstanceFilter): any => ({ ...obj, }); @@ -1668,6 +1893,9 @@ export interface SearchSystemInstancesRequest { } export namespace SearchSystemInstancesRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: SearchSystemInstancesRequest): any => ({ ...obj, }); @@ -1686,6 +1914,9 @@ export interface SearchSystemInstancesResponse { } export namespace SearchSystemInstancesResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: SearchSystemInstancesResponse): any => ({ ...obj, }); @@ -1711,6 +1942,9 @@ export interface SystemTemplateFilter { } export namespace SystemTemplateFilter { + /** + * @internal + */ export const filterSensitiveLog = (obj: SystemTemplateFilter): any => ({ ...obj, }); @@ -1734,6 +1968,9 @@ export interface SearchSystemTemplatesRequest { } export namespace SearchSystemTemplatesRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: SearchSystemTemplatesRequest): any => ({ ...obj, }); @@ -1752,6 +1989,9 @@ export interface SearchSystemTemplatesResponse { } export namespace SearchSystemTemplatesResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: SearchSystemTemplatesResponse): any => ({ ...obj, }); @@ -1784,6 +2024,9 @@ export interface SearchThingsRequest { } export namespace SearchThingsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: SearchThingsRequest): any => ({ ...obj, }); @@ -1805,6 +2048,9 @@ export interface Thing { } export namespace Thing { + /** + * @internal + */ export const filterSensitiveLog = (obj: Thing): any => ({ ...obj, }); @@ -1823,6 +2069,9 @@ export interface SearchThingsResponse { } export namespace SearchThingsResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: SearchThingsResponse): any => ({ ...obj, }); @@ -1841,6 +2090,9 @@ export interface TagResourceRequest { } export namespace TagResourceRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: TagResourceRequest): any => ({ ...obj, }); @@ -1849,6 +2101,9 @@ export namespace TagResourceRequest { export interface TagResourceResponse {} export namespace TagResourceResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: TagResourceResponse): any => ({ ...obj, }); @@ -1862,6 +2117,9 @@ export interface UndeploySystemInstanceRequest { } export namespace UndeploySystemInstanceRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: UndeploySystemInstanceRequest): any => ({ ...obj, }); @@ -1875,6 +2133,9 @@ export interface UndeploySystemInstanceResponse { } export namespace UndeploySystemInstanceResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: UndeploySystemInstanceResponse): any => ({ ...obj, }); @@ -1894,6 +2155,9 @@ export interface UntagResourceRequest { } export namespace UntagResourceRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: UntagResourceRequest): any => ({ ...obj, }); @@ -1902,6 +2166,9 @@ export namespace UntagResourceRequest { export interface UntagResourceResponse {} export namespace UntagResourceResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: UntagResourceResponse): any => ({ ...obj, }); @@ -1931,6 +2198,9 @@ export interface UpdateFlowTemplateRequest { } export namespace UpdateFlowTemplateRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateFlowTemplateRequest): any => ({ ...obj, }); @@ -1944,6 +2214,9 @@ export interface UpdateFlowTemplateResponse { } export namespace UpdateFlowTemplateResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateFlowTemplateResponse): any => ({ ...obj, }); @@ -1972,6 +2245,9 @@ export interface UpdateSystemTemplateRequest { } export namespace UpdateSystemTemplateRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateSystemTemplateRequest): any => ({ ...obj, }); @@ -1985,6 +2261,9 @@ export interface UpdateSystemTemplateResponse { } export namespace UpdateSystemTemplateResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateSystemTemplateResponse): any => ({ ...obj, }); @@ -2009,6 +2288,9 @@ export interface UploadEntityDefinitionsRequest { } export namespace UploadEntityDefinitionsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: UploadEntityDefinitionsRequest): any => ({ ...obj, }); @@ -2022,6 +2304,9 @@ export interface UploadEntityDefinitionsResponse { } export namespace UploadEntityDefinitionsResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: UploadEntityDefinitionsResponse): any => ({ ...obj, }); diff --git a/clients/client-ivs/commands/BatchGetChannelCommand.ts b/clients/client-ivs/commands/BatchGetChannelCommand.ts index eb958e34846e..26654726cf7d 100644 --- a/clients/client-ivs/commands/BatchGetChannelCommand.ts +++ b/clients/client-ivs/commands/BatchGetChannelCommand.ts @@ -22,6 +22,20 @@ export interface BatchGetChannelCommandOutput extends BatchGetChannelResponse, _ /** *

Performs GetChannel on multiple ARNs simultaneously.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { IvsClient, BatchGetChannelCommand } from "@aws-sdk/client-ivs"; // ES Modules import + * // const { IvsClient, BatchGetChannelCommand } = require("@aws-sdk/client-ivs"); // CommonJS import + * const client = new IvsClient(config); + * const command = new BatchGetChannelCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link BatchGetChannelCommandInput} for command's `input` shape. + * @see {@link BatchGetChannelCommandOutput} for command's `response` shape. + * @see {@link IvsClientResolvedConfig | config} for command's `input` shape. + * */ export class BatchGetChannelCommand extends $Command< BatchGetChannelCommandInput, diff --git a/clients/client-ivs/commands/BatchGetStreamKeyCommand.ts b/clients/client-ivs/commands/BatchGetStreamKeyCommand.ts index f7b2839b1894..3666abfda1a3 100644 --- a/clients/client-ivs/commands/BatchGetStreamKeyCommand.ts +++ b/clients/client-ivs/commands/BatchGetStreamKeyCommand.ts @@ -22,6 +22,20 @@ export interface BatchGetStreamKeyCommandOutput extends BatchGetStreamKeyRespons /** *

Performs GetStreamKey on multiple ARNs simultaneously.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { IvsClient, BatchGetStreamKeyCommand } from "@aws-sdk/client-ivs"; // ES Modules import + * // const { IvsClient, BatchGetStreamKeyCommand } = require("@aws-sdk/client-ivs"); // CommonJS import + * const client = new IvsClient(config); + * const command = new BatchGetStreamKeyCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link BatchGetStreamKeyCommandInput} for command's `input` shape. + * @see {@link BatchGetStreamKeyCommandOutput} for command's `response` shape. + * @see {@link IvsClientResolvedConfig | config} for command's `input` shape. + * */ export class BatchGetStreamKeyCommand extends $Command< BatchGetStreamKeyCommandInput, diff --git a/clients/client-ivs/commands/CreateChannelCommand.ts b/clients/client-ivs/commands/CreateChannelCommand.ts index 0d2cd5db9c7a..622f226d914f 100644 --- a/clients/client-ivs/commands/CreateChannelCommand.ts +++ b/clients/client-ivs/commands/CreateChannelCommand.ts @@ -22,6 +22,20 @@ export interface CreateChannelCommandOutput extends CreateChannelResponse, __Met /** *

Creates a new channel and an associated stream key to start streaming.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { IvsClient, CreateChannelCommand } from "@aws-sdk/client-ivs"; // ES Modules import + * // const { IvsClient, CreateChannelCommand } = require("@aws-sdk/client-ivs"); // CommonJS import + * const client = new IvsClient(config); + * const command = new CreateChannelCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreateChannelCommandInput} for command's `input` shape. + * @see {@link CreateChannelCommandOutput} for command's `response` shape. + * @see {@link IvsClientResolvedConfig | config} for command's `input` shape. + * */ export class CreateChannelCommand extends $Command< CreateChannelCommandInput, diff --git a/clients/client-ivs/commands/CreateRecordingConfigurationCommand.ts b/clients/client-ivs/commands/CreateRecordingConfigurationCommand.ts index d84b7e211211..833d065b76ab 100644 --- a/clients/client-ivs/commands/CreateRecordingConfigurationCommand.ts +++ b/clients/client-ivs/commands/CreateRecordingConfigurationCommand.ts @@ -35,6 +35,20 @@ export interface CreateRecordingConfigurationCommandOutput * 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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { IvsClient, CreateRecordingConfigurationCommand } from "@aws-sdk/client-ivs"; // ES Modules import + * // const { IvsClient, CreateRecordingConfigurationCommand } = require("@aws-sdk/client-ivs"); // CommonJS import + * const client = new IvsClient(config); + * const command = new CreateRecordingConfigurationCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreateRecordingConfigurationCommandInput} for command's `input` shape. + * @see {@link CreateRecordingConfigurationCommandOutput} for command's `response` shape. + * @see {@link IvsClientResolvedConfig | config} for command's `input` shape. + * */ export class CreateRecordingConfigurationCommand extends $Command< CreateRecordingConfigurationCommandInput, diff --git a/clients/client-ivs/commands/CreateStreamKeyCommand.ts b/clients/client-ivs/commands/CreateStreamKeyCommand.ts index 1b90c1772504..9c8d2158b7fa 100644 --- a/clients/client-ivs/commands/CreateStreamKeyCommand.ts +++ b/clients/client-ivs/commands/CreateStreamKeyCommand.ts @@ -25,6 +25,20 @@ export interface CreateStreamKeyCommandOutput extends CreateStreamKeyResponse, _ *

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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { IvsClient, CreateStreamKeyCommand } from "@aws-sdk/client-ivs"; // ES Modules import + * // const { IvsClient, CreateStreamKeyCommand } = require("@aws-sdk/client-ivs"); // CommonJS import + * const client = new IvsClient(config); + * const command = new CreateStreamKeyCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreateStreamKeyCommandInput} for command's `input` shape. + * @see {@link CreateStreamKeyCommandOutput} for command's `response` shape. + * @see {@link IvsClientResolvedConfig | config} for command's `input` shape. + * */ export class CreateStreamKeyCommand extends $Command< CreateStreamKeyCommandInput, diff --git a/clients/client-ivs/commands/DeleteChannelCommand.ts b/clients/client-ivs/commands/DeleteChannelCommand.ts index 4b75e0359d07..9a4647f2b2b2 100644 --- a/clients/client-ivs/commands/DeleteChannelCommand.ts +++ b/clients/client-ivs/commands/DeleteChannelCommand.ts @@ -26,6 +26,20 @@ export interface DeleteChannelCommandOutput extends __MetadataBearer {} * delete a channel that is live, call StopStream, wait for the Amazon * EventBridge "Stream End" event (to verify that the stream's state was changed from Live to * Offline), then call DeleteChannel. (See Using EventBridge with Amazon IVS.)

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { IvsClient, DeleteChannelCommand } from "@aws-sdk/client-ivs"; // ES Modules import + * // const { IvsClient, DeleteChannelCommand } = require("@aws-sdk/client-ivs"); // CommonJS import + * const client = new IvsClient(config); + * const command = new DeleteChannelCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteChannelCommandInput} for command's `input` shape. + * @see {@link DeleteChannelCommandOutput} for command's `response` shape. + * @see {@link IvsClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteChannelCommand extends $Command< DeleteChannelCommandInput, diff --git a/clients/client-ivs/commands/DeletePlaybackKeyPairCommand.ts b/clients/client-ivs/commands/DeletePlaybackKeyPairCommand.ts index 29fc61f5c13f..0bb712af7260 100644 --- a/clients/client-ivs/commands/DeletePlaybackKeyPairCommand.ts +++ b/clients/client-ivs/commands/DeletePlaybackKeyPairCommand.ts @@ -24,6 +24,20 @@ export interface DeletePlaybackKeyPairCommandOutput extends DeletePlaybackKeyPai *

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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { IvsClient, DeletePlaybackKeyPairCommand } from "@aws-sdk/client-ivs"; // ES Modules import + * // const { IvsClient, DeletePlaybackKeyPairCommand } = require("@aws-sdk/client-ivs"); // CommonJS import + * const client = new IvsClient(config); + * const command = new DeletePlaybackKeyPairCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeletePlaybackKeyPairCommandInput} for command's `input` shape. + * @see {@link DeletePlaybackKeyPairCommandOutput} for command's `response` shape. + * @see {@link IvsClientResolvedConfig | config} for command's `input` shape. + * */ export class DeletePlaybackKeyPairCommand extends $Command< DeletePlaybackKeyPairCommandInput, diff --git a/clients/client-ivs/commands/DeleteRecordingConfigurationCommand.ts b/clients/client-ivs/commands/DeleteRecordingConfigurationCommand.ts index f7d209d2e505..492c3e35703d 100644 --- a/clients/client-ivs/commands/DeleteRecordingConfigurationCommand.ts +++ b/clients/client-ivs/commands/DeleteRecordingConfigurationCommand.ts @@ -27,6 +27,20 @@ export interface DeleteRecordingConfigurationCommandOutput extends __MetadataBea * recording configuration, first use UpdateChannel to set the * recordingConfigurationArn field to an empty string, then use * DeleteRecordingConfiguration.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { IvsClient, DeleteRecordingConfigurationCommand } from "@aws-sdk/client-ivs"; // ES Modules import + * // const { IvsClient, DeleteRecordingConfigurationCommand } = require("@aws-sdk/client-ivs"); // CommonJS import + * const client = new IvsClient(config); + * const command = new DeleteRecordingConfigurationCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteRecordingConfigurationCommandInput} for command's `input` shape. + * @see {@link DeleteRecordingConfigurationCommandOutput} for command's `response` shape. + * @see {@link IvsClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteRecordingConfigurationCommand extends $Command< DeleteRecordingConfigurationCommandInput, diff --git a/clients/client-ivs/commands/DeleteStreamKeyCommand.ts b/clients/client-ivs/commands/DeleteStreamKeyCommand.ts index b243e4d6655d..577efaead5b7 100644 --- a/clients/client-ivs/commands/DeleteStreamKeyCommand.ts +++ b/clients/client-ivs/commands/DeleteStreamKeyCommand.ts @@ -23,6 +23,20 @@ export interface DeleteStreamKeyCommandOutput extends __MetadataBearer {} /** *

Deletes the stream key for the specified ARN, so it can no longer be used to * stream.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { IvsClient, DeleteStreamKeyCommand } from "@aws-sdk/client-ivs"; // ES Modules import + * // const { IvsClient, DeleteStreamKeyCommand } = require("@aws-sdk/client-ivs"); // CommonJS import + * const client = new IvsClient(config); + * const command = new DeleteStreamKeyCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteStreamKeyCommandInput} for command's `input` shape. + * @see {@link DeleteStreamKeyCommandOutput} for command's `response` shape. + * @see {@link IvsClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteStreamKeyCommand extends $Command< DeleteStreamKeyCommandInput, diff --git a/clients/client-ivs/commands/GetChannelCommand.ts b/clients/client-ivs/commands/GetChannelCommand.ts index 3fde1d1ad753..0458abc8a0b5 100644 --- a/clients/client-ivs/commands/GetChannelCommand.ts +++ b/clients/client-ivs/commands/GetChannelCommand.ts @@ -22,6 +22,20 @@ export interface GetChannelCommandOutput extends GetChannelResponse, __MetadataB /** *

Gets the channel configuration for the specified channel ARN. See also BatchGetChannel.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { IvsClient, GetChannelCommand } from "@aws-sdk/client-ivs"; // ES Modules import + * // const { IvsClient, GetChannelCommand } = require("@aws-sdk/client-ivs"); // CommonJS import + * const client = new IvsClient(config); + * const command = new GetChannelCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetChannelCommandInput} for command's `input` shape. + * @see {@link GetChannelCommandOutput} for command's `response` shape. + * @see {@link IvsClientResolvedConfig | config} for command's `input` shape. + * */ export class GetChannelCommand extends $Command< GetChannelCommandInput, diff --git a/clients/client-ivs/commands/GetPlaybackKeyPairCommand.ts b/clients/client-ivs/commands/GetPlaybackKeyPairCommand.ts index 207a070d0dc6..ac9c8fe8c081 100644 --- a/clients/client-ivs/commands/GetPlaybackKeyPairCommand.ts +++ b/clients/client-ivs/commands/GetPlaybackKeyPairCommand.ts @@ -26,6 +26,20 @@ export interface GetPlaybackKeyPairCommandOutput extends GetPlaybackKeyPairRespo * 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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { IvsClient, GetPlaybackKeyPairCommand } from "@aws-sdk/client-ivs"; // ES Modules import + * // const { IvsClient, GetPlaybackKeyPairCommand } = require("@aws-sdk/client-ivs"); // CommonJS import + * const client = new IvsClient(config); + * const command = new GetPlaybackKeyPairCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetPlaybackKeyPairCommandInput} for command's `input` shape. + * @see {@link GetPlaybackKeyPairCommandOutput} for command's `response` shape. + * @see {@link IvsClientResolvedConfig | config} for command's `input` shape. + * */ export class GetPlaybackKeyPairCommand extends $Command< GetPlaybackKeyPairCommandInput, diff --git a/clients/client-ivs/commands/GetRecordingConfigurationCommand.ts b/clients/client-ivs/commands/GetRecordingConfigurationCommand.ts index c7af1926a2e0..e1b431434225 100644 --- a/clients/client-ivs/commands/GetRecordingConfigurationCommand.ts +++ b/clients/client-ivs/commands/GetRecordingConfigurationCommand.ts @@ -22,6 +22,20 @@ export interface GetRecordingConfigurationCommandOutput extends GetRecordingConf /** *

Gets the recording configuration for the specified ARN.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { IvsClient, GetRecordingConfigurationCommand } from "@aws-sdk/client-ivs"; // ES Modules import + * // const { IvsClient, GetRecordingConfigurationCommand } = require("@aws-sdk/client-ivs"); // CommonJS import + * const client = new IvsClient(config); + * const command = new GetRecordingConfigurationCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetRecordingConfigurationCommandInput} for command's `input` shape. + * @see {@link GetRecordingConfigurationCommandOutput} for command's `response` shape. + * @see {@link IvsClientResolvedConfig | config} for command's `input` shape. + * */ export class GetRecordingConfigurationCommand extends $Command< GetRecordingConfigurationCommandInput, diff --git a/clients/client-ivs/commands/GetStreamCommand.ts b/clients/client-ivs/commands/GetStreamCommand.ts index 720d64fde2dc..3282b670e2e6 100644 --- a/clients/client-ivs/commands/GetStreamCommand.ts +++ b/clients/client-ivs/commands/GetStreamCommand.ts @@ -22,6 +22,20 @@ export interface GetStreamCommandOutput extends GetStreamResponse, __MetadataBea /** *

Gets information about the active (live) stream on a specified channel.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { IvsClient, GetStreamCommand } from "@aws-sdk/client-ivs"; // ES Modules import + * // const { IvsClient, GetStreamCommand } = require("@aws-sdk/client-ivs"); // CommonJS import + * const client = new IvsClient(config); + * const command = new GetStreamCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetStreamCommandInput} for command's `input` shape. + * @see {@link GetStreamCommandOutput} for command's `response` shape. + * @see {@link IvsClientResolvedConfig | config} for command's `input` shape. + * */ export class GetStreamCommand extends $Command { // Start section: command_properties diff --git a/clients/client-ivs/commands/GetStreamKeyCommand.ts b/clients/client-ivs/commands/GetStreamKeyCommand.ts index abb6b6ab1b18..c3c606991149 100644 --- a/clients/client-ivs/commands/GetStreamKeyCommand.ts +++ b/clients/client-ivs/commands/GetStreamKeyCommand.ts @@ -22,6 +22,20 @@ export interface GetStreamKeyCommandOutput extends GetStreamKeyResponse, __Metad /** *

Gets stream-key information for a specified ARN.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { IvsClient, GetStreamKeyCommand } from "@aws-sdk/client-ivs"; // ES Modules import + * // const { IvsClient, GetStreamKeyCommand } = require("@aws-sdk/client-ivs"); // CommonJS import + * const client = new IvsClient(config); + * const command = new GetStreamKeyCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetStreamKeyCommandInput} for command's `input` shape. + * @see {@link GetStreamKeyCommandOutput} for command's `response` shape. + * @see {@link IvsClientResolvedConfig | config} for command's `input` shape. + * */ export class GetStreamKeyCommand extends $Command< GetStreamKeyCommandInput, diff --git a/clients/client-ivs/commands/ImportPlaybackKeyPairCommand.ts b/clients/client-ivs/commands/ImportPlaybackKeyPairCommand.ts index 1eabfeb35447..7a12ec1ea49d 100644 --- a/clients/client-ivs/commands/ImportPlaybackKeyPairCommand.ts +++ b/clients/client-ivs/commands/ImportPlaybackKeyPairCommand.ts @@ -26,6 +26,20 @@ export interface ImportPlaybackKeyPairCommandOutput extends ImportPlaybackKeyPai * authorization tokens, to grant viewers access to private channels. For more information, see * Setting Up * Private Channels in the Amazon IVS User Guide.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { IvsClient, ImportPlaybackKeyPairCommand } from "@aws-sdk/client-ivs"; // ES Modules import + * // const { IvsClient, ImportPlaybackKeyPairCommand } = require("@aws-sdk/client-ivs"); // CommonJS import + * const client = new IvsClient(config); + * const command = new ImportPlaybackKeyPairCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ImportPlaybackKeyPairCommandInput} for command's `input` shape. + * @see {@link ImportPlaybackKeyPairCommandOutput} for command's `response` shape. + * @see {@link IvsClientResolvedConfig | config} for command's `input` shape. + * */ export class ImportPlaybackKeyPairCommand extends $Command< ImportPlaybackKeyPairCommandInput, diff --git a/clients/client-ivs/commands/ListChannelsCommand.ts b/clients/client-ivs/commands/ListChannelsCommand.ts index 124ea4b14a8f..bfc00e066844 100644 --- a/clients/client-ivs/commands/ListChannelsCommand.ts +++ b/clients/client-ivs/commands/ListChannelsCommand.ts @@ -25,6 +25,20 @@ export interface ListChannelsCommandOutput extends ListChannelsResponse, __Metad * 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).

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { IvsClient, ListChannelsCommand } from "@aws-sdk/client-ivs"; // ES Modules import + * // const { IvsClient, ListChannelsCommand } = require("@aws-sdk/client-ivs"); // CommonJS import + * const client = new IvsClient(config); + * const command = new ListChannelsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListChannelsCommandInput} for command's `input` shape. + * @see {@link ListChannelsCommandOutput} for command's `response` shape. + * @see {@link IvsClientResolvedConfig | config} for command's `input` shape. + * */ export class ListChannelsCommand extends $Command< ListChannelsCommandInput, diff --git a/clients/client-ivs/commands/ListPlaybackKeyPairsCommand.ts b/clients/client-ivs/commands/ListPlaybackKeyPairsCommand.ts index 0c56be87dd2c..000377fed5d5 100644 --- a/clients/client-ivs/commands/ListPlaybackKeyPairsCommand.ts +++ b/clients/client-ivs/commands/ListPlaybackKeyPairsCommand.ts @@ -23,6 +23,20 @@ export interface ListPlaybackKeyPairsCommandOutput extends ListPlaybackKeyPairsR /** *

Gets summary information about playback key pairs. For more information, see Setting Up Private * Channels in the Amazon IVS User Guide.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { IvsClient, ListPlaybackKeyPairsCommand } from "@aws-sdk/client-ivs"; // ES Modules import + * // const { IvsClient, ListPlaybackKeyPairsCommand } = require("@aws-sdk/client-ivs"); // CommonJS import + * const client = new IvsClient(config); + * const command = new ListPlaybackKeyPairsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListPlaybackKeyPairsCommandInput} for command's `input` shape. + * @see {@link ListPlaybackKeyPairsCommandOutput} for command's `response` shape. + * @see {@link IvsClientResolvedConfig | config} for command's `input` shape. + * */ export class ListPlaybackKeyPairsCommand extends $Command< ListPlaybackKeyPairsCommandInput, diff --git a/clients/client-ivs/commands/ListRecordingConfigurationsCommand.ts b/clients/client-ivs/commands/ListRecordingConfigurationsCommand.ts index c11dc6a86778..caa60b37041a 100644 --- a/clients/client-ivs/commands/ListRecordingConfigurationsCommand.ts +++ b/clients/client-ivs/commands/ListRecordingConfigurationsCommand.ts @@ -25,6 +25,20 @@ export interface ListRecordingConfigurationsCommandOutput /** *

Gets summary information about all recording configurations in your account, in the AWS * region where the API request is processed.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { IvsClient, ListRecordingConfigurationsCommand } from "@aws-sdk/client-ivs"; // ES Modules import + * // const { IvsClient, ListRecordingConfigurationsCommand } = require("@aws-sdk/client-ivs"); // CommonJS import + * const client = new IvsClient(config); + * const command = new ListRecordingConfigurationsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListRecordingConfigurationsCommandInput} for command's `input` shape. + * @see {@link ListRecordingConfigurationsCommandOutput} for command's `response` shape. + * @see {@link IvsClientResolvedConfig | config} for command's `input` shape. + * */ export class ListRecordingConfigurationsCommand extends $Command< ListRecordingConfigurationsCommandInput, diff --git a/clients/client-ivs/commands/ListStreamKeysCommand.ts b/clients/client-ivs/commands/ListStreamKeysCommand.ts index 2c3bbc6bdc12..19b3f5d27297 100644 --- a/clients/client-ivs/commands/ListStreamKeysCommand.ts +++ b/clients/client-ivs/commands/ListStreamKeysCommand.ts @@ -22,6 +22,20 @@ export interface ListStreamKeysCommandOutput extends ListStreamKeysResponse, __M /** *

Gets summary information about stream keys for the specified channel.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { IvsClient, ListStreamKeysCommand } from "@aws-sdk/client-ivs"; // ES Modules import + * // const { IvsClient, ListStreamKeysCommand } = require("@aws-sdk/client-ivs"); // CommonJS import + * const client = new IvsClient(config); + * const command = new ListStreamKeysCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListStreamKeysCommandInput} for command's `input` shape. + * @see {@link ListStreamKeysCommandOutput} for command's `response` shape. + * @see {@link IvsClientResolvedConfig | config} for command's `input` shape. + * */ export class ListStreamKeysCommand extends $Command< ListStreamKeysCommandInput, diff --git a/clients/client-ivs/commands/ListStreamsCommand.ts b/clients/client-ivs/commands/ListStreamsCommand.ts index 170d85fef7c3..a4d0fb94da30 100644 --- a/clients/client-ivs/commands/ListStreamsCommand.ts +++ b/clients/client-ivs/commands/ListStreamsCommand.ts @@ -23,6 +23,20 @@ export interface ListStreamsCommandOutput extends ListStreamsResponse, __Metadat /** *

Gets summary information about live streams in your account, in the AWS region where the * API request is processed.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { IvsClient, ListStreamsCommand } from "@aws-sdk/client-ivs"; // ES Modules import + * // const { IvsClient, ListStreamsCommand } = require("@aws-sdk/client-ivs"); // CommonJS import + * const client = new IvsClient(config); + * const command = new ListStreamsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListStreamsCommandInput} for command's `input` shape. + * @see {@link ListStreamsCommandOutput} for command's `response` shape. + * @see {@link IvsClientResolvedConfig | config} for command's `input` shape. + * */ export class ListStreamsCommand extends $Command< ListStreamsCommandInput, diff --git a/clients/client-ivs/commands/ListTagsForResourceCommand.ts b/clients/client-ivs/commands/ListTagsForResourceCommand.ts index d83aa70df09c..2852924d105d 100644 --- a/clients/client-ivs/commands/ListTagsForResourceCommand.ts +++ b/clients/client-ivs/commands/ListTagsForResourceCommand.ts @@ -22,6 +22,20 @@ export interface ListTagsForResourceCommandOutput extends ListTagsForResourceRes /** *

Gets information about AWS tags for the specified ARN.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { IvsClient, ListTagsForResourceCommand } from "@aws-sdk/client-ivs"; // ES Modules import + * // const { IvsClient, ListTagsForResourceCommand } = require("@aws-sdk/client-ivs"); // CommonJS import + * const client = new IvsClient(config); + * const command = new ListTagsForResourceCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListTagsForResourceCommandInput} for command's `input` shape. + * @see {@link ListTagsForResourceCommandOutput} for command's `response` shape. + * @see {@link IvsClientResolvedConfig | config} for command's `input` shape. + * */ export class ListTagsForResourceCommand extends $Command< ListTagsForResourceCommandInput, diff --git a/clients/client-ivs/commands/PutMetadataCommand.ts b/clients/client-ivs/commands/PutMetadataCommand.ts index f0cf0aaed448..760d6a8d3e82 100644 --- a/clients/client-ivs/commands/PutMetadataCommand.ts +++ b/clients/client-ivs/commands/PutMetadataCommand.ts @@ -28,6 +28,20 @@ export interface PutMetadataCommandOutput extends __MetadataBearer {} * Also see Embedding Metadata * * within a Video Stream in the Amazon IVS User Guide.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { IvsClient, PutMetadataCommand } from "@aws-sdk/client-ivs"; // ES Modules import + * // const { IvsClient, PutMetadataCommand } = require("@aws-sdk/client-ivs"); // CommonJS import + * const client = new IvsClient(config); + * const command = new PutMetadataCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link PutMetadataCommandInput} for command's `input` shape. + * @see {@link PutMetadataCommandOutput} for command's `response` shape. + * @see {@link IvsClientResolvedConfig | config} for command's `input` shape. + * */ export class PutMetadataCommand extends $Command< PutMetadataCommandInput, diff --git a/clients/client-ivs/commands/StopStreamCommand.ts b/clients/client-ivs/commands/StopStreamCommand.ts index 11020f7546ea..8ee035d72b72 100644 --- a/clients/client-ivs/commands/StopStreamCommand.ts +++ b/clients/client-ivs/commands/StopStreamCommand.ts @@ -29,6 +29,20 @@ export interface StopStreamCommandOutput extends StopStreamResponse, __MetadataB * session, so to stop the stream permanently, you may want to first revoke the * streamKey attached to the channel.

* + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { IvsClient, StopStreamCommand } from "@aws-sdk/client-ivs"; // ES Modules import + * // const { IvsClient, StopStreamCommand } = require("@aws-sdk/client-ivs"); // CommonJS import + * const client = new IvsClient(config); + * const command = new StopStreamCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link StopStreamCommandInput} for command's `input` shape. + * @see {@link StopStreamCommandOutput} for command's `response` shape. + * @see {@link IvsClientResolvedConfig | config} for command's `input` shape. + * */ export class StopStreamCommand extends $Command< StopStreamCommandInput, diff --git a/clients/client-ivs/commands/TagResourceCommand.ts b/clients/client-ivs/commands/TagResourceCommand.ts index 05a8657ea258..c379a4286a8f 100644 --- a/clients/client-ivs/commands/TagResourceCommand.ts +++ b/clients/client-ivs/commands/TagResourceCommand.ts @@ -22,6 +22,20 @@ export interface TagResourceCommandOutput extends TagResourceResponse, __Metadat /** *

Adds or updates tags for the AWS resource with the specified ARN.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { IvsClient, TagResourceCommand } from "@aws-sdk/client-ivs"; // ES Modules import + * // const { IvsClient, TagResourceCommand } = require("@aws-sdk/client-ivs"); // CommonJS import + * const client = new IvsClient(config); + * const command = new TagResourceCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link TagResourceCommandInput} for command's `input` shape. + * @see {@link TagResourceCommandOutput} for command's `response` shape. + * @see {@link IvsClientResolvedConfig | config} for command's `input` shape. + * */ export class TagResourceCommand extends $Command< TagResourceCommandInput, diff --git a/clients/client-ivs/commands/UntagResourceCommand.ts b/clients/client-ivs/commands/UntagResourceCommand.ts index a6063c01e27a..b24971a190fd 100644 --- a/clients/client-ivs/commands/UntagResourceCommand.ts +++ b/clients/client-ivs/commands/UntagResourceCommand.ts @@ -22,6 +22,20 @@ export interface UntagResourceCommandOutput extends UntagResourceResponse, __Met /** *

Removes tags from the resource with the specified ARN.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { IvsClient, UntagResourceCommand } from "@aws-sdk/client-ivs"; // ES Modules import + * // const { IvsClient, UntagResourceCommand } = require("@aws-sdk/client-ivs"); // CommonJS import + * const client = new IvsClient(config); + * const command = new UntagResourceCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link UntagResourceCommandInput} for command's `input` shape. + * @see {@link UntagResourceCommandOutput} for command's `response` shape. + * @see {@link IvsClientResolvedConfig | config} for command's `input` shape. + * */ export class UntagResourceCommand extends $Command< UntagResourceCommandInput, diff --git a/clients/client-ivs/commands/UpdateChannelCommand.ts b/clients/client-ivs/commands/UpdateChannelCommand.ts index 5b0d6217bc20..dedb4109ce48 100644 --- a/clients/client-ivs/commands/UpdateChannelCommand.ts +++ b/clients/client-ivs/commands/UpdateChannelCommand.ts @@ -23,6 +23,20 @@ export interface UpdateChannelCommandOutput extends UpdateChannelResponse, __Met /** *

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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { IvsClient, UpdateChannelCommand } from "@aws-sdk/client-ivs"; // ES Modules import + * // const { IvsClient, UpdateChannelCommand } = require("@aws-sdk/client-ivs"); // CommonJS import + * const client = new IvsClient(config); + * const command = new UpdateChannelCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link UpdateChannelCommandInput} for command's `input` shape. + * @see {@link UpdateChannelCommandOutput} for command's `response` shape. + * @see {@link IvsClientResolvedConfig | config} for command's `input` shape. + * */ export class UpdateChannelCommand extends $Command< UpdateChannelCommandInput, diff --git a/clients/client-ivs/models/models_0.ts b/clients/client-ivs/models/models_0.ts index d713888aac50..8d32b4926077 100644 --- a/clients/client-ivs/models/models_0.ts +++ b/clients/client-ivs/models/models_0.ts @@ -11,6 +11,9 @@ export interface AccessDeniedException extends __SmithyException, $MetadataBeare } export namespace AccessDeniedException { + /** + * @internal + */ export const filterSensitiveLog = (obj: AccessDeniedException): any => ({ ...obj, }); @@ -24,6 +27,9 @@ export interface BatchGetChannelRequest { } export namespace BatchGetChannelRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: BatchGetChannelRequest): any => ({ ...obj, }); @@ -111,6 +117,9 @@ export interface Channel { } export namespace Channel { + /** + * @internal + */ export const filterSensitiveLog = (obj: Channel): any => ({ ...obj, }); @@ -137,6 +146,9 @@ export interface BatchError { } export namespace BatchError { + /** + * @internal + */ export const filterSensitiveLog = (obj: BatchError): any => ({ ...obj, }); @@ -151,6 +163,9 @@ export interface BatchGetChannelResponse { } export namespace BatchGetChannelResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: BatchGetChannelResponse): any => ({ ...obj, }); @@ -164,6 +179,9 @@ export interface BatchGetStreamKeyRequest { } export namespace BatchGetStreamKeyRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: BatchGetStreamKeyRequest): any => ({ ...obj, }); @@ -195,6 +213,9 @@ export interface StreamKey { } export namespace StreamKey { + /** + * @internal + */ export const filterSensitiveLog = (obj: StreamKey): any => ({ ...obj, }); @@ -206,6 +227,9 @@ export interface BatchGetStreamKeyResponse { } export namespace BatchGetStreamKeyResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: BatchGetStreamKeyResponse): any => ({ ...obj, }); @@ -264,6 +288,9 @@ export interface CreateChannelRequest { } export namespace CreateChannelRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateChannelRequest): any => ({ ...obj, }); @@ -282,6 +309,9 @@ export interface CreateChannelResponse { } export namespace CreateChannelResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateChannelResponse): any => ({ ...obj, }); @@ -297,6 +327,9 @@ export interface PendingVerification extends __SmithyException, $MetadataBearer } export namespace PendingVerification { + /** + * @internal + */ export const filterSensitiveLog = (obj: PendingVerification): any => ({ ...obj, }); @@ -312,6 +345,9 @@ export interface ResourceNotFoundException extends __SmithyException, $MetadataB } export namespace ResourceNotFoundException { + /** + * @internal + */ export const filterSensitiveLog = (obj: ResourceNotFoundException): any => ({ ...obj, }); @@ -327,6 +363,9 @@ export interface ServiceQuotaExceededException extends __SmithyException, $Metad } export namespace ServiceQuotaExceededException { + /** + * @internal + */ export const filterSensitiveLog = (obj: ServiceQuotaExceededException): any => ({ ...obj, }); @@ -342,6 +381,9 @@ export interface ValidationException extends __SmithyException, $MetadataBearer } export namespace ValidationException { + /** + * @internal + */ export const filterSensitiveLog = (obj: ValidationException): any => ({ ...obj, }); @@ -357,6 +399,9 @@ export interface ConflictException extends __SmithyException, $MetadataBearer { } export namespace ConflictException { + /** + * @internal + */ export const filterSensitiveLog = (obj: ConflictException): any => ({ ...obj, }); @@ -373,6 +418,9 @@ export interface S3DestinationConfiguration { } export namespace S3DestinationConfiguration { + /** + * @internal + */ export const filterSensitiveLog = (obj: S3DestinationConfiguration): any => ({ ...obj, }); @@ -391,6 +439,9 @@ export interface DestinationConfiguration { } export namespace DestinationConfiguration { + /** + * @internal + */ export const filterSensitiveLog = (obj: DestinationConfiguration): any => ({ ...obj, }); @@ -416,6 +467,9 @@ export interface CreateRecordingConfigurationRequest { } export namespace CreateRecordingConfigurationRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateRecordingConfigurationRequest): any => ({ ...obj, }); @@ -460,6 +514,9 @@ export interface RecordingConfiguration { } export namespace RecordingConfiguration { + /** + * @internal + */ export const filterSensitiveLog = (obj: RecordingConfiguration): any => ({ ...obj, }); @@ -473,6 +530,9 @@ export interface CreateRecordingConfigurationResponse { } export namespace CreateRecordingConfigurationResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateRecordingConfigurationResponse): any => ({ ...obj, }); @@ -488,6 +548,9 @@ export interface InternalServerException extends __SmithyException, $MetadataBea } export namespace InternalServerException { + /** + * @internal + */ export const filterSensitiveLog = (obj: InternalServerException): any => ({ ...obj, }); @@ -506,6 +569,9 @@ export interface CreateStreamKeyRequest { } export namespace CreateStreamKeyRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateStreamKeyRequest): any => ({ ...obj, }); @@ -519,6 +585,9 @@ export interface CreateStreamKeyResponse { } export namespace CreateStreamKeyResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateStreamKeyResponse): any => ({ ...obj, }); @@ -532,6 +601,9 @@ export interface DeleteChannelRequest { } export namespace DeleteChannelRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteChannelRequest): any => ({ ...obj, }); @@ -545,6 +617,9 @@ export interface DeletePlaybackKeyPairRequest { } export namespace DeletePlaybackKeyPairRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeletePlaybackKeyPairRequest): any => ({ ...obj, }); @@ -553,6 +628,9 @@ export namespace DeletePlaybackKeyPairRequest { export interface DeletePlaybackKeyPairResponse {} export namespace DeletePlaybackKeyPairResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeletePlaybackKeyPairResponse): any => ({ ...obj, }); @@ -566,6 +644,9 @@ export interface DeleteRecordingConfigurationRequest { } export namespace DeleteRecordingConfigurationRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteRecordingConfigurationRequest): any => ({ ...obj, }); @@ -579,6 +660,9 @@ export interface DeleteStreamKeyRequest { } export namespace DeleteStreamKeyRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteStreamKeyRequest): any => ({ ...obj, }); @@ -592,6 +676,9 @@ export interface GetChannelRequest { } export namespace GetChannelRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetChannelRequest): any => ({ ...obj, }); @@ -605,6 +692,9 @@ export interface GetChannelResponse { } export namespace GetChannelResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetChannelResponse): any => ({ ...obj, }); @@ -618,6 +708,9 @@ export interface GetPlaybackKeyPairRequest { } export namespace GetPlaybackKeyPairRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetPlaybackKeyPairRequest): any => ({ ...obj, }); @@ -650,6 +743,9 @@ export interface PlaybackKeyPair { } export namespace PlaybackKeyPair { + /** + * @internal + */ export const filterSensitiveLog = (obj: PlaybackKeyPair): any => ({ ...obj, }); @@ -663,6 +759,9 @@ export interface GetPlaybackKeyPairResponse { } export namespace GetPlaybackKeyPairResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetPlaybackKeyPairResponse): any => ({ ...obj, }); @@ -676,6 +775,9 @@ export interface GetRecordingConfigurationRequest { } export namespace GetRecordingConfigurationRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetRecordingConfigurationRequest): any => ({ ...obj, }); @@ -689,6 +791,9 @@ export interface GetRecordingConfigurationResponse { } export namespace GetRecordingConfigurationResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetRecordingConfigurationResponse): any => ({ ...obj, }); @@ -704,6 +809,9 @@ export interface ChannelNotBroadcasting extends __SmithyException, $MetadataBear } export namespace ChannelNotBroadcasting { + /** + * @internal + */ export const filterSensitiveLog = (obj: ChannelNotBroadcasting): any => ({ ...obj, }); @@ -717,6 +825,9 @@ export interface GetStreamRequest { } export namespace GetStreamRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetStreamRequest): any => ({ ...obj, }); @@ -770,6 +881,9 @@ export interface _Stream { } export namespace _Stream { + /** + * @internal + */ export const filterSensitiveLog = (obj: _Stream): any => ({ ...obj, }); @@ -783,6 +897,9 @@ export interface GetStreamResponse { } export namespace GetStreamResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetStreamResponse): any => ({ ...obj, }); @@ -796,6 +913,9 @@ export interface GetStreamKeyRequest { } export namespace GetStreamKeyRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetStreamKeyRequest): any => ({ ...obj, }); @@ -809,6 +929,9 @@ export interface GetStreamKeyResponse { } export namespace GetStreamKeyResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetStreamKeyResponse): any => ({ ...obj, }); @@ -833,6 +956,9 @@ export interface ImportPlaybackKeyPairRequest { } export namespace ImportPlaybackKeyPairRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ImportPlaybackKeyPairRequest): any => ({ ...obj, }); @@ -846,6 +972,9 @@ export interface ImportPlaybackKeyPairResponse { } export namespace ImportPlaybackKeyPairResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ImportPlaybackKeyPairResponse): any => ({ ...obj, }); @@ -875,6 +1004,9 @@ export interface ListChannelsRequest { } export namespace ListChannelsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListChannelsRequest): any => ({ ...obj, }); @@ -919,6 +1051,9 @@ export interface ChannelSummary { } export namespace ChannelSummary { + /** + * @internal + */ export const filterSensitiveLog = (obj: ChannelSummary): any => ({ ...obj, }); @@ -938,6 +1073,9 @@ export interface ListChannelsResponse { } export namespace ListChannelsResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListChannelsResponse): any => ({ ...obj, }); @@ -957,6 +1095,9 @@ export interface ListPlaybackKeyPairsRequest { } export namespace ListPlaybackKeyPairsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListPlaybackKeyPairsRequest): any => ({ ...obj, }); @@ -984,6 +1125,9 @@ export interface PlaybackKeyPairSummary { } export namespace PlaybackKeyPairSummary { + /** + * @internal + */ export const filterSensitiveLog = (obj: PlaybackKeyPairSummary): any => ({ ...obj, }); @@ -1003,6 +1147,9 @@ export interface ListPlaybackKeyPairsResponse { } export namespace ListPlaybackKeyPairsResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListPlaybackKeyPairsResponse): any => ({ ...obj, }); @@ -1022,6 +1169,9 @@ export interface ListRecordingConfigurationsRequest { } export namespace ListRecordingConfigurationsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListRecordingConfigurationsRequest): any => ({ ...obj, }); @@ -1060,6 +1210,9 @@ export interface RecordingConfigurationSummary { } export namespace RecordingConfigurationSummary { + /** + * @internal + */ export const filterSensitiveLog = (obj: RecordingConfigurationSummary): any => ({ ...obj, }); @@ -1079,6 +1232,9 @@ export interface ListRecordingConfigurationsResponse { } export namespace ListRecordingConfigurationsResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListRecordingConfigurationsResponse): any => ({ ...obj, }); @@ -1103,6 +1259,9 @@ export interface ListStreamKeysRequest { } export namespace ListStreamKeysRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListStreamKeysRequest): any => ({ ...obj, }); @@ -1129,6 +1288,9 @@ export interface StreamKeySummary { } export namespace StreamKeySummary { + /** + * @internal + */ export const filterSensitiveLog = (obj: StreamKeySummary): any => ({ ...obj, }); @@ -1148,6 +1310,9 @@ export interface ListStreamKeysResponse { } export namespace ListStreamKeysResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListStreamKeysResponse): any => ({ ...obj, }); @@ -1167,6 +1332,9 @@ export interface ListStreamsRequest { } export namespace ListStreamsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListStreamsRequest): any => ({ ...obj, }); @@ -1204,6 +1372,9 @@ export interface StreamSummary { } export namespace StreamSummary { + /** + * @internal + */ export const filterSensitiveLog = (obj: StreamSummary): any => ({ ...obj, }); @@ -1223,6 +1394,9 @@ export interface ListStreamsResponse { } export namespace ListStreamsResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListStreamsResponse): any => ({ ...obj, }); @@ -1247,6 +1421,9 @@ export interface ListTagsForResourceRequest { } export namespace ListTagsForResourceRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListTagsForResourceRequest): any => ({ ...obj, }); @@ -1262,6 +1439,9 @@ export interface ListTagsForResourceResponse { } export namespace ListTagsForResourceResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListTagsForResourceResponse): any => ({ ...obj, }); @@ -1281,6 +1461,9 @@ export interface PutMetadataRequest { } export namespace PutMetadataRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: PutMetadataRequest): any => ({ ...obj, }); @@ -1296,6 +1479,9 @@ export interface ThrottlingException extends __SmithyException, $MetadataBearer } export namespace ThrottlingException { + /** + * @internal + */ export const filterSensitiveLog = (obj: ThrottlingException): any => ({ ...obj, }); @@ -1309,6 +1495,9 @@ export interface StopStreamRequest { } export namespace StopStreamRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: StopStreamRequest): any => ({ ...obj, }); @@ -1317,6 +1506,9 @@ export namespace StopStreamRequest { export interface StopStreamResponse {} export namespace StopStreamResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: StopStreamResponse): any => ({ ...obj, }); @@ -1332,6 +1524,9 @@ export interface StreamUnavailable extends __SmithyException, $MetadataBearer { } export namespace StreamUnavailable { + /** + * @internal + */ export const filterSensitiveLog = (obj: StreamUnavailable): any => ({ ...obj, }); @@ -1350,6 +1545,9 @@ export interface TagResourceRequest { } export namespace TagResourceRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: TagResourceRequest): any => ({ ...obj, }); @@ -1358,6 +1556,9 @@ export namespace TagResourceRequest { export interface TagResourceResponse {} export namespace TagResourceResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: TagResourceResponse): any => ({ ...obj, }); @@ -1376,6 +1577,9 @@ export interface UntagResourceRequest { } export namespace UntagResourceRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: UntagResourceRequest): any => ({ ...obj, }); @@ -1384,6 +1588,9 @@ export namespace UntagResourceRequest { export interface UntagResourceResponse {} export namespace UntagResourceResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: UntagResourceResponse): any => ({ ...obj, }); @@ -1442,6 +1649,9 @@ export interface UpdateChannelRequest { } export namespace UpdateChannelRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateChannelRequest): any => ({ ...obj, }); @@ -1455,6 +1665,9 @@ export interface UpdateChannelResponse { } export namespace UpdateChannelResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateChannelResponse): any => ({ ...obj, }); diff --git a/clients/client-kafka/commands/BatchAssociateScramSecretCommand.ts b/clients/client-kafka/commands/BatchAssociateScramSecretCommand.ts index 72cc9d0b340a..f26c4ee580e9 100644 --- a/clients/client-kafka/commands/BatchAssociateScramSecretCommand.ts +++ b/clients/client-kafka/commands/BatchAssociateScramSecretCommand.ts @@ -22,6 +22,20 @@ export interface BatchAssociateScramSecretCommandOutput extends BatchAssociateSc /** *

Associates one or more Scram Secrets with an Amazon MSK cluster.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { KafkaClient, BatchAssociateScramSecretCommand } from "@aws-sdk/client-kafka"; // ES Modules import + * // const { KafkaClient, BatchAssociateScramSecretCommand } = require("@aws-sdk/client-kafka"); // CommonJS import + * const client = new KafkaClient(config); + * const command = new BatchAssociateScramSecretCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link BatchAssociateScramSecretCommandInput} for command's `input` shape. + * @see {@link BatchAssociateScramSecretCommandOutput} for command's `response` shape. + * @see {@link KafkaClientResolvedConfig | config} for command's `input` shape. + * */ export class BatchAssociateScramSecretCommand extends $Command< BatchAssociateScramSecretCommandInput, diff --git a/clients/client-kafka/commands/BatchDisassociateScramSecretCommand.ts b/clients/client-kafka/commands/BatchDisassociateScramSecretCommand.ts index 30ca16fcd1ac..e25c783cff2b 100644 --- a/clients/client-kafka/commands/BatchDisassociateScramSecretCommand.ts +++ b/clients/client-kafka/commands/BatchDisassociateScramSecretCommand.ts @@ -24,6 +24,20 @@ export interface BatchDisassociateScramSecretCommandOutput /** *

Disassociates one or more Scram Secrets from an Amazon MSK cluster.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { KafkaClient, BatchDisassociateScramSecretCommand } from "@aws-sdk/client-kafka"; // ES Modules import + * // const { KafkaClient, BatchDisassociateScramSecretCommand } = require("@aws-sdk/client-kafka"); // CommonJS import + * const client = new KafkaClient(config); + * const command = new BatchDisassociateScramSecretCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link BatchDisassociateScramSecretCommandInput} for command's `input` shape. + * @see {@link BatchDisassociateScramSecretCommandOutput} for command's `response` shape. + * @see {@link KafkaClientResolvedConfig | config} for command's `input` shape. + * */ export class BatchDisassociateScramSecretCommand extends $Command< BatchDisassociateScramSecretCommandInput, diff --git a/clients/client-kafka/commands/CreateClusterCommand.ts b/clients/client-kafka/commands/CreateClusterCommand.ts index 43b6ce428a59..cb9a28140706 100644 --- a/clients/client-kafka/commands/CreateClusterCommand.ts +++ b/clients/client-kafka/commands/CreateClusterCommand.ts @@ -22,6 +22,20 @@ export interface CreateClusterCommandOutput extends CreateClusterResponse, __Met /** *

Creates a new MSK cluster.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { KafkaClient, CreateClusterCommand } from "@aws-sdk/client-kafka"; // ES Modules import + * // const { KafkaClient, CreateClusterCommand } = require("@aws-sdk/client-kafka"); // CommonJS import + * const client = new KafkaClient(config); + * const command = new CreateClusterCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreateClusterCommandInput} for command's `input` shape. + * @see {@link CreateClusterCommandOutput} for command's `response` shape. + * @see {@link KafkaClientResolvedConfig | config} for command's `input` shape. + * */ export class CreateClusterCommand extends $Command< CreateClusterCommandInput, diff --git a/clients/client-kafka/commands/CreateConfigurationCommand.ts b/clients/client-kafka/commands/CreateConfigurationCommand.ts index 8e9ce28b6ebd..5b24b495e7e5 100644 --- a/clients/client-kafka/commands/CreateConfigurationCommand.ts +++ b/clients/client-kafka/commands/CreateConfigurationCommand.ts @@ -22,6 +22,20 @@ export interface CreateConfigurationCommandOutput extends CreateConfigurationRes /** *

Creates a new MSK configuration.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { KafkaClient, CreateConfigurationCommand } from "@aws-sdk/client-kafka"; // ES Modules import + * // const { KafkaClient, CreateConfigurationCommand } = require("@aws-sdk/client-kafka"); // CommonJS import + * const client = new KafkaClient(config); + * const command = new CreateConfigurationCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreateConfigurationCommandInput} for command's `input` shape. + * @see {@link CreateConfigurationCommandOutput} for command's `response` shape. + * @see {@link KafkaClientResolvedConfig | config} for command's `input` shape. + * */ export class CreateConfigurationCommand extends $Command< CreateConfigurationCommandInput, diff --git a/clients/client-kafka/commands/DeleteClusterCommand.ts b/clients/client-kafka/commands/DeleteClusterCommand.ts index 6494c894347e..cb644bf0163e 100644 --- a/clients/client-kafka/commands/DeleteClusterCommand.ts +++ b/clients/client-kafka/commands/DeleteClusterCommand.ts @@ -22,6 +22,20 @@ export interface DeleteClusterCommandOutput extends DeleteClusterResponse, __Met /** *

Deletes the MSK cluster specified by the Amazon Resource Name (ARN) in the request.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { KafkaClient, DeleteClusterCommand } from "@aws-sdk/client-kafka"; // ES Modules import + * // const { KafkaClient, DeleteClusterCommand } = require("@aws-sdk/client-kafka"); // CommonJS import + * const client = new KafkaClient(config); + * const command = new DeleteClusterCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteClusterCommandInput} for command's `input` shape. + * @see {@link DeleteClusterCommandOutput} for command's `response` shape. + * @see {@link KafkaClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteClusterCommand extends $Command< DeleteClusterCommandInput, diff --git a/clients/client-kafka/commands/DeleteConfigurationCommand.ts b/clients/client-kafka/commands/DeleteConfigurationCommand.ts index 784cbd4098bd..23d482af0849 100644 --- a/clients/client-kafka/commands/DeleteConfigurationCommand.ts +++ b/clients/client-kafka/commands/DeleteConfigurationCommand.ts @@ -22,6 +22,20 @@ export interface DeleteConfigurationCommandOutput extends DeleteConfigurationRes /** *

Deletes an MSK Configuration.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { KafkaClient, DeleteConfigurationCommand } from "@aws-sdk/client-kafka"; // ES Modules import + * // const { KafkaClient, DeleteConfigurationCommand } = require("@aws-sdk/client-kafka"); // CommonJS import + * const client = new KafkaClient(config); + * const command = new DeleteConfigurationCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteConfigurationCommandInput} for command's `input` shape. + * @see {@link DeleteConfigurationCommandOutput} for command's `response` shape. + * @see {@link KafkaClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteConfigurationCommand extends $Command< DeleteConfigurationCommandInput, diff --git a/clients/client-kafka/commands/DescribeClusterCommand.ts b/clients/client-kafka/commands/DescribeClusterCommand.ts index 5217ff6023b0..6908b1718f6c 100644 --- a/clients/client-kafka/commands/DescribeClusterCommand.ts +++ b/clients/client-kafka/commands/DescribeClusterCommand.ts @@ -22,6 +22,20 @@ export interface DescribeClusterCommandOutput extends DescribeClusterResponse, _ /** *

Returns a description of the MSK cluster whose Amazon Resource Name (ARN) is specified in the request.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { KafkaClient, DescribeClusterCommand } from "@aws-sdk/client-kafka"; // ES Modules import + * // const { KafkaClient, DescribeClusterCommand } = require("@aws-sdk/client-kafka"); // CommonJS import + * const client = new KafkaClient(config); + * const command = new DescribeClusterCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeClusterCommandInput} for command's `input` shape. + * @see {@link DescribeClusterCommandOutput} for command's `response` shape. + * @see {@link KafkaClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeClusterCommand extends $Command< DescribeClusterCommandInput, diff --git a/clients/client-kafka/commands/DescribeClusterOperationCommand.ts b/clients/client-kafka/commands/DescribeClusterOperationCommand.ts index 7f98f3dc6ea0..6bbdf703162a 100644 --- a/clients/client-kafka/commands/DescribeClusterOperationCommand.ts +++ b/clients/client-kafka/commands/DescribeClusterOperationCommand.ts @@ -22,6 +22,20 @@ export interface DescribeClusterOperationCommandOutput extends DescribeClusterOp /** *

Returns a description of the cluster operation specified by the ARN.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { KafkaClient, DescribeClusterOperationCommand } from "@aws-sdk/client-kafka"; // ES Modules import + * // const { KafkaClient, DescribeClusterOperationCommand } = require("@aws-sdk/client-kafka"); // CommonJS import + * const client = new KafkaClient(config); + * const command = new DescribeClusterOperationCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeClusterOperationCommandInput} for command's `input` shape. + * @see {@link DescribeClusterOperationCommandOutput} for command's `response` shape. + * @see {@link KafkaClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeClusterOperationCommand extends $Command< DescribeClusterOperationCommandInput, diff --git a/clients/client-kafka/commands/DescribeConfigurationCommand.ts b/clients/client-kafka/commands/DescribeConfigurationCommand.ts index 2d5322a261f9..255f2b3cbda8 100644 --- a/clients/client-kafka/commands/DescribeConfigurationCommand.ts +++ b/clients/client-kafka/commands/DescribeConfigurationCommand.ts @@ -22,6 +22,20 @@ export interface DescribeConfigurationCommandOutput extends DescribeConfiguratio /** *

Returns a description of this MSK configuration.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { KafkaClient, DescribeConfigurationCommand } from "@aws-sdk/client-kafka"; // ES Modules import + * // const { KafkaClient, DescribeConfigurationCommand } = require("@aws-sdk/client-kafka"); // CommonJS import + * const client = new KafkaClient(config); + * const command = new DescribeConfigurationCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeConfigurationCommandInput} for command's `input` shape. + * @see {@link DescribeConfigurationCommandOutput} for command's `response` shape. + * @see {@link KafkaClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeConfigurationCommand extends $Command< DescribeConfigurationCommandInput, diff --git a/clients/client-kafka/commands/DescribeConfigurationRevisionCommand.ts b/clients/client-kafka/commands/DescribeConfigurationRevisionCommand.ts index a3672f13d4f8..02a4ed35ecbb 100644 --- a/clients/client-kafka/commands/DescribeConfigurationRevisionCommand.ts +++ b/clients/client-kafka/commands/DescribeConfigurationRevisionCommand.ts @@ -24,6 +24,20 @@ export interface DescribeConfigurationRevisionCommandOutput /** *

Returns a description of this revision of the configuration.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { KafkaClient, DescribeConfigurationRevisionCommand } from "@aws-sdk/client-kafka"; // ES Modules import + * // const { KafkaClient, DescribeConfigurationRevisionCommand } = require("@aws-sdk/client-kafka"); // CommonJS import + * const client = new KafkaClient(config); + * const command = new DescribeConfigurationRevisionCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeConfigurationRevisionCommandInput} for command's `input` shape. + * @see {@link DescribeConfigurationRevisionCommandOutput} for command's `response` shape. + * @see {@link KafkaClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeConfigurationRevisionCommand extends $Command< DescribeConfigurationRevisionCommandInput, diff --git a/clients/client-kafka/commands/GetBootstrapBrokersCommand.ts b/clients/client-kafka/commands/GetBootstrapBrokersCommand.ts index 346f53442d92..5d7ffe1e1864 100644 --- a/clients/client-kafka/commands/GetBootstrapBrokersCommand.ts +++ b/clients/client-kafka/commands/GetBootstrapBrokersCommand.ts @@ -22,6 +22,20 @@ export interface GetBootstrapBrokersCommandOutput extends GetBootstrapBrokersRes /** *

A list of brokers that a client application can use to bootstrap.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { KafkaClient, GetBootstrapBrokersCommand } from "@aws-sdk/client-kafka"; // ES Modules import + * // const { KafkaClient, GetBootstrapBrokersCommand } = require("@aws-sdk/client-kafka"); // CommonJS import + * const client = new KafkaClient(config); + * const command = new GetBootstrapBrokersCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetBootstrapBrokersCommandInput} for command's `input` shape. + * @see {@link GetBootstrapBrokersCommandOutput} for command's `response` shape. + * @see {@link KafkaClientResolvedConfig | config} for command's `input` shape. + * */ export class GetBootstrapBrokersCommand extends $Command< GetBootstrapBrokersCommandInput, diff --git a/clients/client-kafka/commands/GetCompatibleKafkaVersionsCommand.ts b/clients/client-kafka/commands/GetCompatibleKafkaVersionsCommand.ts index 56184ef5c69e..78afaeccc0a6 100644 --- a/clients/client-kafka/commands/GetCompatibleKafkaVersionsCommand.ts +++ b/clients/client-kafka/commands/GetCompatibleKafkaVersionsCommand.ts @@ -22,6 +22,20 @@ export interface GetCompatibleKafkaVersionsCommandOutput extends GetCompatibleKa /** *

Gets the Apache Kafka versions to which you can update the MSK cluster.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { KafkaClient, GetCompatibleKafkaVersionsCommand } from "@aws-sdk/client-kafka"; // ES Modules import + * // const { KafkaClient, GetCompatibleKafkaVersionsCommand } = require("@aws-sdk/client-kafka"); // CommonJS import + * const client = new KafkaClient(config); + * const command = new GetCompatibleKafkaVersionsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetCompatibleKafkaVersionsCommandInput} for command's `input` shape. + * @see {@link GetCompatibleKafkaVersionsCommandOutput} for command's `response` shape. + * @see {@link KafkaClientResolvedConfig | config} for command's `input` shape. + * */ export class GetCompatibleKafkaVersionsCommand extends $Command< GetCompatibleKafkaVersionsCommandInput, diff --git a/clients/client-kafka/commands/ListClusterOperationsCommand.ts b/clients/client-kafka/commands/ListClusterOperationsCommand.ts index d1461e93acd9..2c4440b69322 100644 --- a/clients/client-kafka/commands/ListClusterOperationsCommand.ts +++ b/clients/client-kafka/commands/ListClusterOperationsCommand.ts @@ -22,6 +22,20 @@ export interface ListClusterOperationsCommandOutput extends ListClusterOperation /** *

Returns a list of all the operations that have been performed on the specified MSK cluster.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { KafkaClient, ListClusterOperationsCommand } from "@aws-sdk/client-kafka"; // ES Modules import + * // const { KafkaClient, ListClusterOperationsCommand } = require("@aws-sdk/client-kafka"); // CommonJS import + * const client = new KafkaClient(config); + * const command = new ListClusterOperationsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListClusterOperationsCommandInput} for command's `input` shape. + * @see {@link ListClusterOperationsCommandOutput} for command's `response` shape. + * @see {@link KafkaClientResolvedConfig | config} for command's `input` shape. + * */ export class ListClusterOperationsCommand extends $Command< ListClusterOperationsCommandInput, diff --git a/clients/client-kafka/commands/ListClustersCommand.ts b/clients/client-kafka/commands/ListClustersCommand.ts index cab5a8a2dc8c..ef4bce4b2711 100644 --- a/clients/client-kafka/commands/ListClustersCommand.ts +++ b/clients/client-kafka/commands/ListClustersCommand.ts @@ -22,6 +22,20 @@ export interface ListClustersCommandOutput extends ListClustersResponse, __Metad /** *

Returns a list of all the MSK clusters in the current Region.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { KafkaClient, ListClustersCommand } from "@aws-sdk/client-kafka"; // ES Modules import + * // const { KafkaClient, ListClustersCommand } = require("@aws-sdk/client-kafka"); // CommonJS import + * const client = new KafkaClient(config); + * const command = new ListClustersCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListClustersCommandInput} for command's `input` shape. + * @see {@link ListClustersCommandOutput} for command's `response` shape. + * @see {@link KafkaClientResolvedConfig | config} for command's `input` shape. + * */ export class ListClustersCommand extends $Command< ListClustersCommandInput, diff --git a/clients/client-kafka/commands/ListConfigurationRevisionsCommand.ts b/clients/client-kafka/commands/ListConfigurationRevisionsCommand.ts index 49bcbcff7cf7..724e28ab7e67 100644 --- a/clients/client-kafka/commands/ListConfigurationRevisionsCommand.ts +++ b/clients/client-kafka/commands/ListConfigurationRevisionsCommand.ts @@ -22,6 +22,20 @@ export interface ListConfigurationRevisionsCommandOutput extends ListConfigurati /** *

Returns a list of all the MSK configurations in this Region.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { KafkaClient, ListConfigurationRevisionsCommand } from "@aws-sdk/client-kafka"; // ES Modules import + * // const { KafkaClient, ListConfigurationRevisionsCommand } = require("@aws-sdk/client-kafka"); // CommonJS import + * const client = new KafkaClient(config); + * const command = new ListConfigurationRevisionsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListConfigurationRevisionsCommandInput} for command's `input` shape. + * @see {@link ListConfigurationRevisionsCommandOutput} for command's `response` shape. + * @see {@link KafkaClientResolvedConfig | config} for command's `input` shape. + * */ export class ListConfigurationRevisionsCommand extends $Command< ListConfigurationRevisionsCommandInput, diff --git a/clients/client-kafka/commands/ListConfigurationsCommand.ts b/clients/client-kafka/commands/ListConfigurationsCommand.ts index f33785f52f2a..e415b08d8af2 100644 --- a/clients/client-kafka/commands/ListConfigurationsCommand.ts +++ b/clients/client-kafka/commands/ListConfigurationsCommand.ts @@ -22,6 +22,20 @@ export interface ListConfigurationsCommandOutput extends ListConfigurationsRespo /** *

Returns a list of all the MSK configurations in this Region.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { KafkaClient, ListConfigurationsCommand } from "@aws-sdk/client-kafka"; // ES Modules import + * // const { KafkaClient, ListConfigurationsCommand } = require("@aws-sdk/client-kafka"); // CommonJS import + * const client = new KafkaClient(config); + * const command = new ListConfigurationsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListConfigurationsCommandInput} for command's `input` shape. + * @see {@link ListConfigurationsCommandOutput} for command's `response` shape. + * @see {@link KafkaClientResolvedConfig | config} for command's `input` shape. + * */ export class ListConfigurationsCommand extends $Command< ListConfigurationsCommandInput, diff --git a/clients/client-kafka/commands/ListKafkaVersionsCommand.ts b/clients/client-kafka/commands/ListKafkaVersionsCommand.ts index e8b8db1c47f7..d3011781cc4e 100644 --- a/clients/client-kafka/commands/ListKafkaVersionsCommand.ts +++ b/clients/client-kafka/commands/ListKafkaVersionsCommand.ts @@ -22,6 +22,20 @@ export interface ListKafkaVersionsCommandOutput extends ListKafkaVersionsRespons /** *

Returns a list of Kafka versions.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { KafkaClient, ListKafkaVersionsCommand } from "@aws-sdk/client-kafka"; // ES Modules import + * // const { KafkaClient, ListKafkaVersionsCommand } = require("@aws-sdk/client-kafka"); // CommonJS import + * const client = new KafkaClient(config); + * const command = new ListKafkaVersionsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListKafkaVersionsCommandInput} for command's `input` shape. + * @see {@link ListKafkaVersionsCommandOutput} for command's `response` shape. + * @see {@link KafkaClientResolvedConfig | config} for command's `input` shape. + * */ export class ListKafkaVersionsCommand extends $Command< ListKafkaVersionsCommandInput, diff --git a/clients/client-kafka/commands/ListNodesCommand.ts b/clients/client-kafka/commands/ListNodesCommand.ts index 21af1be9b0a3..39f0f94103e8 100644 --- a/clients/client-kafka/commands/ListNodesCommand.ts +++ b/clients/client-kafka/commands/ListNodesCommand.ts @@ -22,6 +22,20 @@ export interface ListNodesCommandOutput extends ListNodesResponse, __MetadataBea /** *

Returns a list of the broker nodes in the cluster.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { KafkaClient, ListNodesCommand } from "@aws-sdk/client-kafka"; // ES Modules import + * // const { KafkaClient, ListNodesCommand } = require("@aws-sdk/client-kafka"); // CommonJS import + * const client = new KafkaClient(config); + * const command = new ListNodesCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListNodesCommandInput} for command's `input` shape. + * @see {@link ListNodesCommandOutput} for command's `response` shape. + * @see {@link KafkaClientResolvedConfig | config} for command's `input` shape. + * */ export class ListNodesCommand extends $Command< ListNodesCommandInput, diff --git a/clients/client-kafka/commands/ListScramSecretsCommand.ts b/clients/client-kafka/commands/ListScramSecretsCommand.ts index b0afabda66b7..bff195862501 100644 --- a/clients/client-kafka/commands/ListScramSecretsCommand.ts +++ b/clients/client-kafka/commands/ListScramSecretsCommand.ts @@ -22,6 +22,20 @@ export interface ListScramSecretsCommandOutput extends ListScramSecretsResponse, /** *

Returns a list of the Scram Secrets associated with an Amazon MSK cluster.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { KafkaClient, ListScramSecretsCommand } from "@aws-sdk/client-kafka"; // ES Modules import + * // const { KafkaClient, ListScramSecretsCommand } = require("@aws-sdk/client-kafka"); // CommonJS import + * const client = new KafkaClient(config); + * const command = new ListScramSecretsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListScramSecretsCommandInput} for command's `input` shape. + * @see {@link ListScramSecretsCommandOutput} for command's `response` shape. + * @see {@link KafkaClientResolvedConfig | config} for command's `input` shape. + * */ export class ListScramSecretsCommand extends $Command< ListScramSecretsCommandInput, diff --git a/clients/client-kafka/commands/ListTagsForResourceCommand.ts b/clients/client-kafka/commands/ListTagsForResourceCommand.ts index e40170b8c9b9..8eea94075b7d 100644 --- a/clients/client-kafka/commands/ListTagsForResourceCommand.ts +++ b/clients/client-kafka/commands/ListTagsForResourceCommand.ts @@ -22,6 +22,20 @@ export interface ListTagsForResourceCommandOutput extends ListTagsForResourceRes /** *

Returns a list of the tags associated with the specified resource.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { KafkaClient, ListTagsForResourceCommand } from "@aws-sdk/client-kafka"; // ES Modules import + * // const { KafkaClient, ListTagsForResourceCommand } = require("@aws-sdk/client-kafka"); // CommonJS import + * const client = new KafkaClient(config); + * const command = new ListTagsForResourceCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListTagsForResourceCommandInput} for command's `input` shape. + * @see {@link ListTagsForResourceCommandOutput} for command's `response` shape. + * @see {@link KafkaClientResolvedConfig | config} for command's `input` shape. + * */ export class ListTagsForResourceCommand extends $Command< ListTagsForResourceCommandInput, diff --git a/clients/client-kafka/commands/RebootBrokerCommand.ts b/clients/client-kafka/commands/RebootBrokerCommand.ts index 01b01bfead23..df346e89d600 100644 --- a/clients/client-kafka/commands/RebootBrokerCommand.ts +++ b/clients/client-kafka/commands/RebootBrokerCommand.ts @@ -22,6 +22,20 @@ export interface RebootBrokerCommandOutput extends RebootBrokerResponse, __Metad /** * Reboots brokers. + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { KafkaClient, RebootBrokerCommand } from "@aws-sdk/client-kafka"; // ES Modules import + * // const { KafkaClient, RebootBrokerCommand } = require("@aws-sdk/client-kafka"); // CommonJS import + * const client = new KafkaClient(config); + * const command = new RebootBrokerCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link RebootBrokerCommandInput} for command's `input` shape. + * @see {@link RebootBrokerCommandOutput} for command's `response` shape. + * @see {@link KafkaClientResolvedConfig | config} for command's `input` shape. + * */ export class RebootBrokerCommand extends $Command< RebootBrokerCommandInput, diff --git a/clients/client-kafka/commands/TagResourceCommand.ts b/clients/client-kafka/commands/TagResourceCommand.ts index 12d350691a0c..a199583d0dd1 100644 --- a/clients/client-kafka/commands/TagResourceCommand.ts +++ b/clients/client-kafka/commands/TagResourceCommand.ts @@ -22,6 +22,20 @@ export interface TagResourceCommandOutput extends __MetadataBearer {} /** *

Adds tags to the specified MSK resource.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { KafkaClient, TagResourceCommand } from "@aws-sdk/client-kafka"; // ES Modules import + * // const { KafkaClient, TagResourceCommand } = require("@aws-sdk/client-kafka"); // CommonJS import + * const client = new KafkaClient(config); + * const command = new TagResourceCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link TagResourceCommandInput} for command's `input` shape. + * @see {@link TagResourceCommandOutput} for command's `response` shape. + * @see {@link KafkaClientResolvedConfig | config} for command's `input` shape. + * */ export class TagResourceCommand extends $Command< TagResourceCommandInput, diff --git a/clients/client-kafka/commands/UntagResourceCommand.ts b/clients/client-kafka/commands/UntagResourceCommand.ts index d410c9fd7b24..d66eeeff78a2 100644 --- a/clients/client-kafka/commands/UntagResourceCommand.ts +++ b/clients/client-kafka/commands/UntagResourceCommand.ts @@ -22,6 +22,20 @@ export interface UntagResourceCommandOutput extends __MetadataBearer {} /** *

Removes the tags associated with the keys that are provided in the query.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { KafkaClient, UntagResourceCommand } from "@aws-sdk/client-kafka"; // ES Modules import + * // const { KafkaClient, UntagResourceCommand } = require("@aws-sdk/client-kafka"); // CommonJS import + * const client = new KafkaClient(config); + * const command = new UntagResourceCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link UntagResourceCommandInput} for command's `input` shape. + * @see {@link UntagResourceCommandOutput} for command's `response` shape. + * @see {@link KafkaClientResolvedConfig | config} for command's `input` shape. + * */ export class UntagResourceCommand extends $Command< UntagResourceCommandInput, diff --git a/clients/client-kafka/commands/UpdateBrokerCountCommand.ts b/clients/client-kafka/commands/UpdateBrokerCountCommand.ts index 5c92b26a2fd5..5d2c564795c8 100644 --- a/clients/client-kafka/commands/UpdateBrokerCountCommand.ts +++ b/clients/client-kafka/commands/UpdateBrokerCountCommand.ts @@ -22,6 +22,20 @@ export interface UpdateBrokerCountCommandOutput extends UpdateBrokerCountRespons /** *

Updates the number of broker nodes in the cluster.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { KafkaClient, UpdateBrokerCountCommand } from "@aws-sdk/client-kafka"; // ES Modules import + * // const { KafkaClient, UpdateBrokerCountCommand } = require("@aws-sdk/client-kafka"); // CommonJS import + * const client = new KafkaClient(config); + * const command = new UpdateBrokerCountCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link UpdateBrokerCountCommandInput} for command's `input` shape. + * @see {@link UpdateBrokerCountCommandOutput} for command's `response` shape. + * @see {@link KafkaClientResolvedConfig | config} for command's `input` shape. + * */ export class UpdateBrokerCountCommand extends $Command< UpdateBrokerCountCommandInput, diff --git a/clients/client-kafka/commands/UpdateBrokerStorageCommand.ts b/clients/client-kafka/commands/UpdateBrokerStorageCommand.ts index 8df0e7f12748..894ac919ff76 100644 --- a/clients/client-kafka/commands/UpdateBrokerStorageCommand.ts +++ b/clients/client-kafka/commands/UpdateBrokerStorageCommand.ts @@ -22,6 +22,20 @@ export interface UpdateBrokerStorageCommandOutput extends UpdateBrokerStorageRes /** *

Updates the EBS storage associated with MSK brokers.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { KafkaClient, UpdateBrokerStorageCommand } from "@aws-sdk/client-kafka"; // ES Modules import + * // const { KafkaClient, UpdateBrokerStorageCommand } = require("@aws-sdk/client-kafka"); // CommonJS import + * const client = new KafkaClient(config); + * const command = new UpdateBrokerStorageCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link UpdateBrokerStorageCommandInput} for command's `input` shape. + * @see {@link UpdateBrokerStorageCommandOutput} for command's `response` shape. + * @see {@link KafkaClientResolvedConfig | config} for command's `input` shape. + * */ export class UpdateBrokerStorageCommand extends $Command< UpdateBrokerStorageCommandInput, diff --git a/clients/client-kafka/commands/UpdateBrokerTypeCommand.ts b/clients/client-kafka/commands/UpdateBrokerTypeCommand.ts index ddf29bc8d2c6..b1f20969b00d 100644 --- a/clients/client-kafka/commands/UpdateBrokerTypeCommand.ts +++ b/clients/client-kafka/commands/UpdateBrokerTypeCommand.ts @@ -22,6 +22,20 @@ export interface UpdateBrokerTypeCommandOutput extends UpdateBrokerTypeResponse, /** *

Updates EC2 instance type.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { KafkaClient, UpdateBrokerTypeCommand } from "@aws-sdk/client-kafka"; // ES Modules import + * // const { KafkaClient, UpdateBrokerTypeCommand } = require("@aws-sdk/client-kafka"); // CommonJS import + * const client = new KafkaClient(config); + * const command = new UpdateBrokerTypeCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link UpdateBrokerTypeCommandInput} for command's `input` shape. + * @see {@link UpdateBrokerTypeCommandOutput} for command's `response` shape. + * @see {@link KafkaClientResolvedConfig | config} for command's `input` shape. + * */ export class UpdateBrokerTypeCommand extends $Command< UpdateBrokerTypeCommandInput, diff --git a/clients/client-kafka/commands/UpdateClusterConfigurationCommand.ts b/clients/client-kafka/commands/UpdateClusterConfigurationCommand.ts index 67358a8f9fa4..3a6590b205de 100644 --- a/clients/client-kafka/commands/UpdateClusterConfigurationCommand.ts +++ b/clients/client-kafka/commands/UpdateClusterConfigurationCommand.ts @@ -22,6 +22,20 @@ export interface UpdateClusterConfigurationCommandOutput extends UpdateClusterCo /** *

Updates the cluster with the configuration that is specified in the request body.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { KafkaClient, UpdateClusterConfigurationCommand } from "@aws-sdk/client-kafka"; // ES Modules import + * // const { KafkaClient, UpdateClusterConfigurationCommand } = require("@aws-sdk/client-kafka"); // CommonJS import + * const client = new KafkaClient(config); + * const command = new UpdateClusterConfigurationCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link UpdateClusterConfigurationCommandInput} for command's `input` shape. + * @see {@link UpdateClusterConfigurationCommandOutput} for command's `response` shape. + * @see {@link KafkaClientResolvedConfig | config} for command's `input` shape. + * */ export class UpdateClusterConfigurationCommand extends $Command< UpdateClusterConfigurationCommandInput, diff --git a/clients/client-kafka/commands/UpdateClusterKafkaVersionCommand.ts b/clients/client-kafka/commands/UpdateClusterKafkaVersionCommand.ts index 67ac8d1fe968..d05250c318fe 100644 --- a/clients/client-kafka/commands/UpdateClusterKafkaVersionCommand.ts +++ b/clients/client-kafka/commands/UpdateClusterKafkaVersionCommand.ts @@ -22,6 +22,20 @@ export interface UpdateClusterKafkaVersionCommandOutput extends UpdateClusterKaf /** *

Updates the Apache Kafka version for the cluster.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { KafkaClient, UpdateClusterKafkaVersionCommand } from "@aws-sdk/client-kafka"; // ES Modules import + * // const { KafkaClient, UpdateClusterKafkaVersionCommand } = require("@aws-sdk/client-kafka"); // CommonJS import + * const client = new KafkaClient(config); + * const command = new UpdateClusterKafkaVersionCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link UpdateClusterKafkaVersionCommandInput} for command's `input` shape. + * @see {@link UpdateClusterKafkaVersionCommandOutput} for command's `response` shape. + * @see {@link KafkaClientResolvedConfig | config} for command's `input` shape. + * */ export class UpdateClusterKafkaVersionCommand extends $Command< UpdateClusterKafkaVersionCommandInput, diff --git a/clients/client-kafka/commands/UpdateConfigurationCommand.ts b/clients/client-kafka/commands/UpdateConfigurationCommand.ts index 70673aca25b7..d1ed259583ee 100644 --- a/clients/client-kafka/commands/UpdateConfigurationCommand.ts +++ b/clients/client-kafka/commands/UpdateConfigurationCommand.ts @@ -22,6 +22,20 @@ export interface UpdateConfigurationCommandOutput extends UpdateConfigurationRes /** *

Updates an MSK configuration.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { KafkaClient, UpdateConfigurationCommand } from "@aws-sdk/client-kafka"; // ES Modules import + * // const { KafkaClient, UpdateConfigurationCommand } = require("@aws-sdk/client-kafka"); // CommonJS import + * const client = new KafkaClient(config); + * const command = new UpdateConfigurationCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link UpdateConfigurationCommandInput} for command's `input` shape. + * @see {@link UpdateConfigurationCommandOutput} for command's `response` shape. + * @see {@link KafkaClientResolvedConfig | config} for command's `input` shape. + * */ export class UpdateConfigurationCommand extends $Command< UpdateConfigurationCommandInput, diff --git a/clients/client-kafka/commands/UpdateMonitoringCommand.ts b/clients/client-kafka/commands/UpdateMonitoringCommand.ts index fa3244ffda88..be8860323bec 100644 --- a/clients/client-kafka/commands/UpdateMonitoringCommand.ts +++ b/clients/client-kafka/commands/UpdateMonitoringCommand.ts @@ -22,6 +22,20 @@ export interface UpdateMonitoringCommandOutput extends UpdateMonitoringResponse, /** *

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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { KafkaClient, UpdateMonitoringCommand } from "@aws-sdk/client-kafka"; // ES Modules import + * // const { KafkaClient, UpdateMonitoringCommand } = require("@aws-sdk/client-kafka"); // CommonJS import + * const client = new KafkaClient(config); + * const command = new UpdateMonitoringCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link UpdateMonitoringCommandInput} for command's `input` shape. + * @see {@link UpdateMonitoringCommandOutput} for command's `response` shape. + * @see {@link KafkaClientResolvedConfig | config} for command's `input` shape. + * */ export class UpdateMonitoringCommand extends $Command< UpdateMonitoringCommandInput, diff --git a/clients/client-kafka/models/models_0.ts b/clients/client-kafka/models/models_0.ts index a7d2c7ade8d6..c7b440bb1870 100644 --- a/clients/client-kafka/models/models_0.ts +++ b/clients/client-kafka/models/models_0.ts @@ -17,6 +17,9 @@ export interface BrokerEBSVolumeInfo { } export namespace BrokerEBSVolumeInfo { + /** + * @internal + */ export const filterSensitiveLog = (obj: BrokerEBSVolumeInfo): any => ({ ...obj, }); @@ -37,6 +40,9 @@ export interface EBSStorageInfo { } export namespace EBSStorageInfo { + /** + * @internal + */ export const filterSensitiveLog = (obj: EBSStorageInfo): any => ({ ...obj, }); @@ -53,6 +59,9 @@ export interface StorageInfo { } export namespace StorageInfo { + /** + * @internal + */ export const filterSensitiveLog = (obj: StorageInfo): any => ({ ...obj, }); @@ -91,6 +100,9 @@ export interface BrokerNodeGroupInfo { } export namespace BrokerNodeGroupInfo { + /** + * @internal + */ export const filterSensitiveLog = (obj: BrokerNodeGroupInfo): any => ({ ...obj, }); @@ -107,6 +119,9 @@ export interface Scram { } export namespace Scram { + /** + * @internal + */ export const filterSensitiveLog = (obj: Scram): any => ({ ...obj, }); @@ -123,6 +138,9 @@ export interface Sasl { } export namespace Sasl { + /** + * @internal + */ export const filterSensitiveLog = (obj: Sasl): any => ({ ...obj, }); @@ -139,6 +157,9 @@ export interface Tls { } export namespace Tls { + /** + * @internal + */ export const filterSensitiveLog = (obj: Tls): any => ({ ...obj, }); @@ -160,6 +181,9 @@ export interface ClientAuthentication { } export namespace ClientAuthentication { + /** + * @internal + */ export const filterSensitiveLog = (obj: ClientAuthentication): any => ({ ...obj, }); @@ -186,6 +210,9 @@ export interface BrokerSoftwareInfo { } export namespace BrokerSoftwareInfo { + /** + * @internal + */ export const filterSensitiveLog = (obj: BrokerSoftwareInfo): any => ({ ...obj, }); @@ -202,6 +229,9 @@ export interface EncryptionAtRest { } export namespace EncryptionAtRest { + /** + * @internal + */ export const filterSensitiveLog = (obj: EncryptionAtRest): any => ({ ...obj, }); @@ -237,6 +267,9 @@ export interface EncryptionInTransit { } export namespace EncryptionInTransit { + /** + * @internal + */ export const filterSensitiveLog = (obj: EncryptionInTransit): any => ({ ...obj, }); @@ -258,6 +291,9 @@ export interface EncryptionInfo { } export namespace EncryptionInfo { + /** + * @internal + */ export const filterSensitiveLog = (obj: EncryptionInfo): any => ({ ...obj, }); @@ -276,6 +312,9 @@ export interface CloudWatchLogs { } export namespace CloudWatchLogs { + /** + * @internal + */ export const filterSensitiveLog = (obj: CloudWatchLogs): any => ({ ...obj, }); @@ -287,6 +326,9 @@ export interface Firehose { } export namespace Firehose { + /** + * @internal + */ export const filterSensitiveLog = (obj: Firehose): any => ({ ...obj, }); @@ -299,6 +341,9 @@ export interface S3 { } export namespace S3 { + /** + * @internal + */ export const filterSensitiveLog = (obj: S3): any => ({ ...obj, }); @@ -311,6 +356,9 @@ export interface BrokerLogs { } export namespace BrokerLogs { + /** + * @internal + */ export const filterSensitiveLog = (obj: BrokerLogs): any => ({ ...obj, }); @@ -321,6 +369,9 @@ export interface LoggingInfo { } export namespace LoggingInfo { + /** + * @internal + */ export const filterSensitiveLog = (obj: LoggingInfo): any => ({ ...obj, }); @@ -337,6 +388,9 @@ export interface JmxExporter { } export namespace JmxExporter { + /** + * @internal + */ export const filterSensitiveLog = (obj: JmxExporter): any => ({ ...obj, }); @@ -353,6 +407,9 @@ export interface NodeExporter { } export namespace NodeExporter { + /** + * @internal + */ export const filterSensitiveLog = (obj: NodeExporter): any => ({ ...obj, }); @@ -374,6 +431,9 @@ export interface Prometheus { } export namespace Prometheus { + /** + * @internal + */ export const filterSensitiveLog = (obj: Prometheus): any => ({ ...obj, }); @@ -390,6 +450,9 @@ export interface OpenMonitoring { } export namespace OpenMonitoring { + /** + * @internal + */ export const filterSensitiveLog = (obj: OpenMonitoring): any => ({ ...obj, }); @@ -412,6 +475,9 @@ export interface StateInfo { } export namespace StateInfo { + /** + * @internal + */ export const filterSensitiveLog = (obj: StateInfo): any => ({ ...obj, }); @@ -505,6 +571,9 @@ export interface ClusterInfo { } export namespace ClusterInfo { + /** + * @internal + */ export const filterSensitiveLog = (obj: ClusterInfo): any => ({ ...obj, }); @@ -526,6 +595,9 @@ export interface ErrorInfo { } export namespace ErrorInfo { + /** + * @internal + */ export const filterSensitiveLog = (obj: ErrorInfo): any => ({ ...obj, }); @@ -542,6 +614,9 @@ export interface ClusterOperationStepInfo { } export namespace ClusterOperationStepInfo { + /** + * @internal + */ export const filterSensitiveLog = (obj: ClusterOperationStepInfo): any => ({ ...obj, }); @@ -563,6 +638,9 @@ export interface ClusterOperationStep { } export namespace ClusterOperationStep { + /** + * @internal + */ export const filterSensitiveLog = (obj: ClusterOperationStep): any => ({ ...obj, }); @@ -584,6 +662,9 @@ export interface ConfigurationInfo { } export namespace ConfigurationInfo { + /** + * @internal + */ export const filterSensitiveLog = (obj: ConfigurationInfo): any => ({ ...obj, }); @@ -631,6 +712,9 @@ export interface MutableClusterInfo { } export namespace MutableClusterInfo { + /** + * @internal + */ export const filterSensitiveLog = (obj: MutableClusterInfo): any => ({ ...obj, }); @@ -697,6 +781,9 @@ export interface ClusterOperationInfo { } export namespace ClusterOperationInfo { + /** + * @internal + */ export const filterSensitiveLog = (obj: ClusterOperationInfo): any => ({ ...obj, }); @@ -718,6 +805,9 @@ export interface CompatibleKafkaVersion { } export namespace CompatibleKafkaVersion { + /** + * @internal + */ export const filterSensitiveLog = (obj: CompatibleKafkaVersion): any => ({ ...obj, }); @@ -744,6 +834,9 @@ export interface ConfigurationRevision { } export namespace ConfigurationRevision { + /** + * @internal + */ export const filterSensitiveLog = (obj: ConfigurationRevision): any => ({ ...obj, }); @@ -796,6 +889,9 @@ export interface Configuration { } export namespace Configuration { + /** + * @internal + */ export const filterSensitiveLog = (obj: Configuration): any => ({ ...obj, }); @@ -812,6 +908,9 @@ export interface KafkaVersion { } export namespace KafkaVersion { + /** + * @internal + */ export const filterSensitiveLog = (obj: KafkaVersion): any => ({ ...obj, }); @@ -853,6 +952,9 @@ export interface BrokerNodeInfo { } export namespace BrokerNodeInfo { + /** + * @internal + */ export const filterSensitiveLog = (obj: BrokerNodeInfo): any => ({ ...obj, }); @@ -893,6 +995,9 @@ export interface ZookeeperNodeInfo { } export namespace ZookeeperNodeInfo { + /** + * @internal + */ export const filterSensitiveLog = (obj: ZookeeperNodeInfo): any => ({ ...obj, }); @@ -934,6 +1039,9 @@ export interface NodeInfo { } export namespace NodeInfo { + /** + * @internal + */ export const filterSensitiveLog = (obj: NodeInfo): any => ({ ...obj, }); @@ -960,6 +1068,9 @@ export interface UnprocessedScramSecret { } export namespace UnprocessedScramSecret { + /** + * @internal + */ export const filterSensitiveLog = (obj: UnprocessedScramSecret): any => ({ ...obj, }); @@ -983,6 +1094,9 @@ export interface BadRequestException extends __SmithyException, $MetadataBearer } export namespace BadRequestException { + /** + * @internal + */ export const filterSensitiveLog = (obj: BadRequestException): any => ({ ...obj, }); @@ -1004,6 +1118,9 @@ export interface BatchAssociateScramSecretRequest { } export namespace BatchAssociateScramSecretRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: BatchAssociateScramSecretRequest): any => ({ ...obj, }); @@ -1022,6 +1139,9 @@ export interface BatchAssociateScramSecretResponse { } export namespace BatchAssociateScramSecretResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: BatchAssociateScramSecretResponse): any => ({ ...obj, }); @@ -1045,6 +1165,9 @@ export interface ForbiddenException extends __SmithyException, $MetadataBearer { } export namespace ForbiddenException { + /** + * @internal + */ export const filterSensitiveLog = (obj: ForbiddenException): any => ({ ...obj, }); @@ -1068,6 +1191,9 @@ export interface InternalServerErrorException extends __SmithyException, $Metada } export namespace InternalServerErrorException { + /** + * @internal + */ export const filterSensitiveLog = (obj: InternalServerErrorException): any => ({ ...obj, }); @@ -1091,6 +1217,9 @@ export interface NotFoundException extends __SmithyException, $MetadataBearer { } export namespace NotFoundException { + /** + * @internal + */ export const filterSensitiveLog = (obj: NotFoundException): any => ({ ...obj, }); @@ -1114,6 +1243,9 @@ export interface ServiceUnavailableException extends __SmithyException, $Metadat } export namespace ServiceUnavailableException { + /** + * @internal + */ export const filterSensitiveLog = (obj: ServiceUnavailableException): any => ({ ...obj, }); @@ -1137,6 +1269,9 @@ export interface TooManyRequestsException extends __SmithyException, $MetadataBe } export namespace TooManyRequestsException { + /** + * @internal + */ export const filterSensitiveLog = (obj: TooManyRequestsException): any => ({ ...obj, }); @@ -1160,6 +1295,9 @@ export interface UnauthorizedException extends __SmithyException, $MetadataBeare } export namespace UnauthorizedException { + /** + * @internal + */ export const filterSensitiveLog = (obj: UnauthorizedException): any => ({ ...obj, }); @@ -1181,6 +1319,9 @@ export interface BatchDisassociateScramSecretRequest { } export namespace BatchDisassociateScramSecretRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: BatchDisassociateScramSecretRequest): any => ({ ...obj, }); @@ -1199,6 +1340,9 @@ export interface BatchDisassociateScramSecretResponse { } export namespace BatchDisassociateScramSecretResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: BatchDisassociateScramSecretResponse): any => ({ ...obj, }); @@ -1222,6 +1366,9 @@ export interface ConflictException extends __SmithyException, $MetadataBearer { } export namespace ConflictException { + /** + * @internal + */ export const filterSensitiveLog = (obj: ConflictException): any => ({ ...obj, }); @@ -1238,6 +1385,9 @@ export interface JmxExporterInfo { } export namespace JmxExporterInfo { + /** + * @internal + */ export const filterSensitiveLog = (obj: JmxExporterInfo): any => ({ ...obj, }); @@ -1254,6 +1404,9 @@ export interface NodeExporterInfo { } export namespace NodeExporterInfo { + /** + * @internal + */ export const filterSensitiveLog = (obj: NodeExporterInfo): any => ({ ...obj, }); @@ -1275,6 +1428,9 @@ export interface PrometheusInfo { } export namespace PrometheusInfo { + /** + * @internal + */ export const filterSensitiveLog = (obj: PrometheusInfo): any => ({ ...obj, }); @@ -1291,6 +1447,9 @@ export interface OpenMonitoringInfo { } export namespace OpenMonitoringInfo { + /** + * @internal + */ export const filterSensitiveLog = (obj: OpenMonitoringInfo): any => ({ ...obj, }); @@ -1350,6 +1509,9 @@ export interface CreateClusterRequest { } export namespace CreateClusterRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateClusterRequest): any => ({ ...obj, }); @@ -1373,6 +1535,9 @@ export interface CreateClusterResponse { } export namespace CreateClusterResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateClusterResponse): any => ({ ...obj, }); @@ -1402,6 +1567,9 @@ export interface CreateConfigurationRequest { } export namespace CreateConfigurationRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateConfigurationRequest): any => ({ ...obj, }); @@ -1435,6 +1603,9 @@ export interface CreateConfigurationResponse { } export namespace CreateConfigurationResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateConfigurationResponse): any => ({ ...obj, }); @@ -1453,6 +1624,9 @@ export interface DeleteClusterRequest { } export namespace DeleteClusterRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteClusterRequest): any => ({ ...obj, }); @@ -1471,6 +1645,9 @@ export interface DeleteClusterResponse { } export namespace DeleteClusterResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteClusterResponse): any => ({ ...obj, }); @@ -1484,6 +1661,9 @@ export interface DeleteConfigurationRequest { } export namespace DeleteConfigurationRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteConfigurationRequest): any => ({ ...obj, }); @@ -1502,6 +1682,9 @@ export interface DeleteConfigurationResponse { } export namespace DeleteConfigurationResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteConfigurationResponse): any => ({ ...obj, }); @@ -1515,6 +1698,9 @@ export interface DescribeClusterRequest { } export namespace DescribeClusterRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeClusterRequest): any => ({ ...obj, }); @@ -1528,6 +1714,9 @@ export interface DescribeClusterResponse { } export namespace DescribeClusterResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeClusterResponse): any => ({ ...obj, }); @@ -1541,6 +1730,9 @@ export interface DescribeClusterOperationRequest { } export namespace DescribeClusterOperationRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeClusterOperationRequest): any => ({ ...obj, }); @@ -1554,6 +1746,9 @@ export interface DescribeClusterOperationResponse { } export namespace DescribeClusterOperationResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeClusterOperationResponse): any => ({ ...obj, }); @@ -1567,6 +1762,9 @@ export interface DescribeConfigurationRequest { } export namespace DescribeConfigurationRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeConfigurationRequest): any => ({ ...obj, }); @@ -1610,6 +1808,9 @@ export interface DescribeConfigurationResponse { } export namespace DescribeConfigurationResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeConfigurationResponse): any => ({ ...obj, }); @@ -1628,6 +1829,9 @@ export interface DescribeConfigurationRevisionRequest { } export namespace DescribeConfigurationRevisionRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeConfigurationRevisionRequest): any => ({ ...obj, }); @@ -1662,6 +1866,9 @@ export interface DescribeConfigurationRevisionResponse { } export namespace DescribeConfigurationRevisionResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeConfigurationRevisionResponse): any => ({ ...obj, }); @@ -1675,6 +1882,9 @@ export interface GetBootstrapBrokersRequest { } export namespace GetBootstrapBrokersRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetBootstrapBrokersRequest): any => ({ ...obj, }); @@ -1698,6 +1908,9 @@ export interface GetBootstrapBrokersResponse { } export namespace GetBootstrapBrokersResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetBootstrapBrokersResponse): any => ({ ...obj, }); @@ -1711,6 +1924,9 @@ export interface GetCompatibleKafkaVersionsRequest { } export namespace GetCompatibleKafkaVersionsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetCompatibleKafkaVersionsRequest): any => ({ ...obj, }); @@ -1724,6 +1940,9 @@ export interface GetCompatibleKafkaVersionsResponse { } export namespace GetCompatibleKafkaVersionsResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetCompatibleKafkaVersionsResponse): any => ({ ...obj, }); @@ -1748,6 +1967,9 @@ export interface ListClusterOperationsRequest { } export namespace ListClusterOperationsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListClusterOperationsRequest): any => ({ ...obj, }); @@ -1766,6 +1988,9 @@ export interface ListClusterOperationsResponse { } export namespace ListClusterOperationsResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListClusterOperationsResponse): any => ({ ...obj, }); @@ -1790,6 +2015,9 @@ export interface ListClustersRequest { } export namespace ListClustersRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListClustersRequest): any => ({ ...obj, }); @@ -1809,6 +2037,9 @@ export interface ListClustersResponse { } export namespace ListClustersResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListClustersResponse): any => ({ ...obj, }); @@ -1833,6 +2064,9 @@ export interface ListConfigurationRevisionsRequest { } export namespace ListConfigurationRevisionsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListConfigurationRevisionsRequest): any => ({ ...obj, }); @@ -1851,6 +2085,9 @@ export interface ListConfigurationRevisionsResponse { } export namespace ListConfigurationRevisionsResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListConfigurationRevisionsResponse): any => ({ ...obj, }); @@ -1870,6 +2107,9 @@ export interface ListConfigurationsRequest { } export namespace ListConfigurationsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListConfigurationsRequest): any => ({ ...obj, }); @@ -1889,6 +2129,9 @@ export interface ListConfigurationsResponse { } export namespace ListConfigurationsResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListConfigurationsResponse): any => ({ ...obj, }); @@ -1907,6 +2150,9 @@ export interface ListKafkaVersionsRequest { } export namespace ListKafkaVersionsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListKafkaVersionsRequest): any => ({ ...obj, }); @@ -1918,6 +2164,9 @@ export interface ListKafkaVersionsResponse { } export namespace ListKafkaVersionsResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListKafkaVersionsResponse): any => ({ ...obj, }); @@ -1942,6 +2191,9 @@ export interface ListNodesRequest { } export namespace ListNodesRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListNodesRequest): any => ({ ...obj, }); @@ -1961,6 +2213,9 @@ export interface ListNodesResponse { } export namespace ListNodesResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListNodesResponse): any => ({ ...obj, }); @@ -1984,6 +2239,9 @@ export interface ListScramSecretsRequest { } export namespace ListScramSecretsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListScramSecretsRequest): any => ({ ...obj, }); @@ -2002,6 +2260,9 @@ export interface ListScramSecretsResponse { } export namespace ListScramSecretsResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListScramSecretsResponse): any => ({ ...obj, }); @@ -2015,6 +2276,9 @@ export interface ListTagsForResourceRequest { } export namespace ListTagsForResourceRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListTagsForResourceRequest): any => ({ ...obj, }); @@ -2028,6 +2292,9 @@ export interface ListTagsForResourceResponse { } export namespace ListTagsForResourceResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListTagsForResourceResponse): any => ({ ...obj, }); @@ -2049,6 +2316,9 @@ export interface RebootBrokerRequest { } export namespace RebootBrokerRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: RebootBrokerRequest): any => ({ ...obj, }); @@ -2067,6 +2337,9 @@ export interface RebootBrokerResponse { } export namespace RebootBrokerResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: RebootBrokerResponse): any => ({ ...obj, }); @@ -2085,6 +2358,9 @@ export interface TagResourceRequest { } export namespace TagResourceRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: TagResourceRequest): any => ({ ...obj, }); @@ -2122,6 +2398,9 @@ export interface UntagResourceRequest { } export namespace UntagResourceRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: UntagResourceRequest): any => ({ ...obj, }); @@ -2145,6 +2424,9 @@ export interface UpdateBrokerCountRequest { } export namespace UpdateBrokerCountRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateBrokerCountRequest): any => ({ ...obj, }); @@ -2163,6 +2445,9 @@ export interface UpdateBrokerCountResponse { } export namespace UpdateBrokerCountResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateBrokerCountResponse): any => ({ ...obj, }); @@ -2186,6 +2471,9 @@ export interface UpdateBrokerStorageRequest { } export namespace UpdateBrokerStorageRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateBrokerStorageRequest): any => ({ ...obj, }); @@ -2204,6 +2492,9 @@ export interface UpdateBrokerStorageResponse { } export namespace UpdateBrokerStorageResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateBrokerStorageResponse): any => ({ ...obj, }); @@ -2227,6 +2518,9 @@ export interface UpdateBrokerTypeRequest { } export namespace UpdateBrokerTypeRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateBrokerTypeRequest): any => ({ ...obj, }); @@ -2245,6 +2539,9 @@ export interface UpdateBrokerTypeResponse { } export namespace UpdateBrokerTypeResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateBrokerTypeResponse): any => ({ ...obj, }); @@ -2268,6 +2565,9 @@ export interface UpdateClusterConfigurationRequest { } export namespace UpdateClusterConfigurationRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateClusterConfigurationRequest): any => ({ ...obj, }); @@ -2286,6 +2586,9 @@ export interface UpdateClusterConfigurationResponse { } export namespace UpdateClusterConfigurationResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateClusterConfigurationResponse): any => ({ ...obj, }); @@ -2314,6 +2617,9 @@ export interface UpdateClusterKafkaVersionRequest { } export namespace UpdateClusterKafkaVersionRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateClusterKafkaVersionRequest): any => ({ ...obj, }); @@ -2332,6 +2638,9 @@ export interface UpdateClusterKafkaVersionResponse { } export namespace UpdateClusterKafkaVersionResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateClusterKafkaVersionResponse): any => ({ ...obj, }); @@ -2356,6 +2665,9 @@ export interface UpdateConfigurationRequest { } export namespace UpdateConfigurationRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateConfigurationRequest): any => ({ ...obj, }); @@ -2374,6 +2686,9 @@ export interface UpdateConfigurationResponse { } export namespace UpdateConfigurationResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateConfigurationResponse): any => ({ ...obj, }); @@ -2407,6 +2722,9 @@ export interface UpdateMonitoringRequest { } export namespace UpdateMonitoringRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateMonitoringRequest): any => ({ ...obj, }); @@ -2425,6 +2743,9 @@ export interface UpdateMonitoringResponse { } export namespace UpdateMonitoringResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateMonitoringResponse): any => ({ ...obj, }); diff --git a/clients/client-kendra/commands/BatchDeleteDocumentCommand.ts b/clients/client-kendra/commands/BatchDeleteDocumentCommand.ts index ee33fc658028..42d2ce046df6 100644 --- a/clients/client-kendra/commands/BatchDeleteDocumentCommand.ts +++ b/clients/client-kendra/commands/BatchDeleteDocumentCommand.ts @@ -26,6 +26,20 @@ export interface BatchDeleteDocumentCommandOutput extends BatchDeleteDocumentRes *

The documents are deleted asynchronously. You can see the progress of * the deletion by using AWS CloudWatch. Any error messages related to the * processing of the batch are sent to you CloudWatch log.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { KendraClient, BatchDeleteDocumentCommand } from "@aws-sdk/client-kendra"; // ES Modules import + * // const { KendraClient, BatchDeleteDocumentCommand } = require("@aws-sdk/client-kendra"); // CommonJS import + * const client = new KendraClient(config); + * const command = new BatchDeleteDocumentCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link BatchDeleteDocumentCommandInput} for command's `input` shape. + * @see {@link BatchDeleteDocumentCommandOutput} for command's `response` shape. + * @see {@link KendraClientResolvedConfig | config} for command's `input` shape. + * */ export class BatchDeleteDocumentCommand extends $Command< BatchDeleteDocumentCommandInput, diff --git a/clients/client-kendra/commands/BatchPutDocumentCommand.ts b/clients/client-kendra/commands/BatchPutDocumentCommand.ts index 583a6416a6a8..5894002d9176 100644 --- a/clients/client-kendra/commands/BatchPutDocumentCommand.ts +++ b/clients/client-kendra/commands/BatchPutDocumentCommand.ts @@ -30,6 +30,20 @@ export interface BatchPutDocumentCommandOutput extends BatchPutDocumentResponse, *

The documents are indexed asynchronously. You can see the progress of * the batch using AWS CloudWatch. Any error messages related to processing * the batch are sent to your AWS CloudWatch log.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { KendraClient, BatchPutDocumentCommand } from "@aws-sdk/client-kendra"; // ES Modules import + * // const { KendraClient, BatchPutDocumentCommand } = require("@aws-sdk/client-kendra"); // CommonJS import + * const client = new KendraClient(config); + * const command = new BatchPutDocumentCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link BatchPutDocumentCommandInput} for command's `input` shape. + * @see {@link BatchPutDocumentCommandOutput} for command's `response` shape. + * @see {@link KendraClientResolvedConfig | config} for command's `input` shape. + * */ export class BatchPutDocumentCommand extends $Command< BatchPutDocumentCommandInput, diff --git a/clients/client-kendra/commands/CreateDataSourceCommand.ts b/clients/client-kendra/commands/CreateDataSourceCommand.ts index 6722ee25e830..a2c82dfe1fea 100644 --- a/clients/client-kendra/commands/CreateDataSourceCommand.ts +++ b/clients/client-kendra/commands/CreateDataSourceCommand.ts @@ -30,6 +30,20 @@ export interface CreateDataSourceCommandOutput extends CreateDataSourceResponse, * CreateDataSource is a synchronous operation. The * operation returns 200 if the data source was successfully created. * Otherwise, an exception is raised.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { KendraClient, CreateDataSourceCommand } from "@aws-sdk/client-kendra"; // ES Modules import + * // const { KendraClient, CreateDataSourceCommand } = require("@aws-sdk/client-kendra"); // CommonJS import + * const client = new KendraClient(config); + * const command = new CreateDataSourceCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreateDataSourceCommandInput} for command's `input` shape. + * @see {@link CreateDataSourceCommandOutput} for command's `response` shape. + * @see {@link KendraClientResolvedConfig | config} for command's `input` shape. + * */ export class CreateDataSourceCommand extends $Command< CreateDataSourceCommandInput, diff --git a/clients/client-kendra/commands/CreateFaqCommand.ts b/clients/client-kendra/commands/CreateFaqCommand.ts index 2f70958aa5c4..e88a4d3f8c48 100644 --- a/clients/client-kendra/commands/CreateFaqCommand.ts +++ b/clients/client-kendra/commands/CreateFaqCommand.ts @@ -19,6 +19,20 @@ export interface CreateFaqCommandOutput extends CreateFaqResponse, __MetadataBea /** *

Creates an new set of frequently asked question (FAQ) questions and answers.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { KendraClient, CreateFaqCommand } from "@aws-sdk/client-kendra"; // ES Modules import + * // const { KendraClient, CreateFaqCommand } = require("@aws-sdk/client-kendra"); // CommonJS import + * const client = new KendraClient(config); + * const command = new CreateFaqCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreateFaqCommandInput} for command's `input` shape. + * @see {@link CreateFaqCommandOutput} for command's `response` shape. + * @see {@link KendraClientResolvedConfig | config} for command's `input` shape. + * */ export class CreateFaqCommand extends $Command< CreateFaqCommandInput, diff --git a/clients/client-kendra/commands/CreateIndexCommand.ts b/clients/client-kendra/commands/CreateIndexCommand.ts index 54d331b4cc3c..097bcc4804a0 100644 --- a/clients/client-kendra/commands/CreateIndexCommand.ts +++ b/clients/client-kendra/commands/CreateIndexCommand.ts @@ -29,6 +29,20 @@ export interface CreateIndexCommandOutput extends CreateIndexResponse, __Metadat *

Once the index is active you can index your documents using the * BatchPutDocument operation or using one of the supported * data sources.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { KendraClient, CreateIndexCommand } from "@aws-sdk/client-kendra"; // ES Modules import + * // const { KendraClient, CreateIndexCommand } = require("@aws-sdk/client-kendra"); // CommonJS import + * const client = new KendraClient(config); + * const command = new CreateIndexCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreateIndexCommandInput} for command's `input` shape. + * @see {@link CreateIndexCommandOutput} for command's `response` shape. + * @see {@link KendraClientResolvedConfig | config} for command's `input` shape. + * */ export class CreateIndexCommand extends $Command< CreateIndexCommandInput, diff --git a/clients/client-kendra/commands/CreateThesaurusCommand.ts b/clients/client-kendra/commands/CreateThesaurusCommand.ts index 40bf193438f4..6017002a3c82 100644 --- a/clients/client-kendra/commands/CreateThesaurusCommand.ts +++ b/clients/client-kendra/commands/CreateThesaurusCommand.ts @@ -23,6 +23,20 @@ export interface CreateThesaurusCommandOutput extends CreateThesaurusResponse, _ /** *

Creates a thesaurus for an index. The thesaurus * contains a list of synonyms in Solr format.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { KendraClient, CreateThesaurusCommand } from "@aws-sdk/client-kendra"; // ES Modules import + * // const { KendraClient, CreateThesaurusCommand } = require("@aws-sdk/client-kendra"); // CommonJS import + * const client = new KendraClient(config); + * const command = new CreateThesaurusCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreateThesaurusCommandInput} for command's `input` shape. + * @see {@link CreateThesaurusCommandOutput} for command's `response` shape. + * @see {@link KendraClientResolvedConfig | config} for command's `input` shape. + * */ export class CreateThesaurusCommand extends $Command< CreateThesaurusCommandInput, diff --git a/clients/client-kendra/commands/DeleteDataSourceCommand.ts b/clients/client-kendra/commands/DeleteDataSourceCommand.ts index 6ee1ef8c44a9..85053f6829c4 100644 --- a/clients/client-kendra/commands/DeleteDataSourceCommand.ts +++ b/clients/client-kendra/commands/DeleteDataSourceCommand.ts @@ -26,6 +26,20 @@ export interface DeleteDataSourceCommandOutput extends __MetadataBearer {} * deleted, the Status field returned by a call to the * DescribeDataSource operation is set to * DELETING. For more information, see Deleting Data Sources.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { KendraClient, DeleteDataSourceCommand } from "@aws-sdk/client-kendra"; // ES Modules import + * // const { KendraClient, DeleteDataSourceCommand } = require("@aws-sdk/client-kendra"); // CommonJS import + * const client = new KendraClient(config); + * const command = new DeleteDataSourceCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteDataSourceCommandInput} for command's `input` shape. + * @see {@link DeleteDataSourceCommandOutput} for command's `response` shape. + * @see {@link KendraClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteDataSourceCommand extends $Command< DeleteDataSourceCommandInput, diff --git a/clients/client-kendra/commands/DeleteFaqCommand.ts b/clients/client-kendra/commands/DeleteFaqCommand.ts index c658574f86fa..5cccac06ec78 100644 --- a/clients/client-kendra/commands/DeleteFaqCommand.ts +++ b/clients/client-kendra/commands/DeleteFaqCommand.ts @@ -19,6 +19,20 @@ export interface DeleteFaqCommandOutput extends __MetadataBearer {} /** *

Removes an FAQ from an index.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { KendraClient, DeleteFaqCommand } from "@aws-sdk/client-kendra"; // ES Modules import + * // const { KendraClient, DeleteFaqCommand } = require("@aws-sdk/client-kendra"); // CommonJS import + * const client = new KendraClient(config); + * const command = new DeleteFaqCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteFaqCommandInput} for command's `input` shape. + * @see {@link DeleteFaqCommandOutput} for command's `response` shape. + * @see {@link KendraClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteFaqCommand extends $Command< DeleteFaqCommandInput, diff --git a/clients/client-kendra/commands/DeleteIndexCommand.ts b/clients/client-kendra/commands/DeleteIndexCommand.ts index c6fc26409884..8caa5bcdda6b 100644 --- a/clients/client-kendra/commands/DeleteIndexCommand.ts +++ b/clients/client-kendra/commands/DeleteIndexCommand.ts @@ -26,6 +26,20 @@ export interface DeleteIndexCommandOutput extends __MetadataBearer {} * Status field returned by a call to the * DescribeIndex operation is set to * DELETING.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { KendraClient, DeleteIndexCommand } from "@aws-sdk/client-kendra"; // ES Modules import + * // const { KendraClient, DeleteIndexCommand } = require("@aws-sdk/client-kendra"); // CommonJS import + * const client = new KendraClient(config); + * const command = new DeleteIndexCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteIndexCommandInput} for command's `input` shape. + * @see {@link DeleteIndexCommandOutput} for command's `response` shape. + * @see {@link KendraClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteIndexCommand extends $Command< DeleteIndexCommandInput, diff --git a/clients/client-kendra/commands/DeleteThesaurusCommand.ts b/clients/client-kendra/commands/DeleteThesaurusCommand.ts index a1c10d116eb1..7d7da9e1fe3f 100644 --- a/clients/client-kendra/commands/DeleteThesaurusCommand.ts +++ b/clients/client-kendra/commands/DeleteThesaurusCommand.ts @@ -23,6 +23,20 @@ export interface DeleteThesaurusCommandOutput extends __MetadataBearer {} /** *

Deletes an existing Amazon Kendra thesaurus. *

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { KendraClient, DeleteThesaurusCommand } from "@aws-sdk/client-kendra"; // ES Modules import + * // const { KendraClient, DeleteThesaurusCommand } = require("@aws-sdk/client-kendra"); // CommonJS import + * const client = new KendraClient(config); + * const command = new DeleteThesaurusCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteThesaurusCommandInput} for command's `input` shape. + * @see {@link DeleteThesaurusCommandOutput} for command's `response` shape. + * @see {@link KendraClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteThesaurusCommand extends $Command< DeleteThesaurusCommandInput, diff --git a/clients/client-kendra/commands/DescribeDataSourceCommand.ts b/clients/client-kendra/commands/DescribeDataSourceCommand.ts index c5db792bb175..9a43d1c7c903 100644 --- a/clients/client-kendra/commands/DescribeDataSourceCommand.ts +++ b/clients/client-kendra/commands/DescribeDataSourceCommand.ts @@ -22,6 +22,20 @@ export interface DescribeDataSourceCommandOutput extends DescribeDataSourceRespo /** *

Gets information about a Amazon Kendra data source.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { KendraClient, DescribeDataSourceCommand } from "@aws-sdk/client-kendra"; // ES Modules import + * // const { KendraClient, DescribeDataSourceCommand } = require("@aws-sdk/client-kendra"); // CommonJS import + * const client = new KendraClient(config); + * const command = new DescribeDataSourceCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeDataSourceCommandInput} for command's `input` shape. + * @see {@link DescribeDataSourceCommandOutput} for command's `response` shape. + * @see {@link KendraClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeDataSourceCommand extends $Command< DescribeDataSourceCommandInput, diff --git a/clients/client-kendra/commands/DescribeFaqCommand.ts b/clients/client-kendra/commands/DescribeFaqCommand.ts index edffac96bc72..62a55d63daf5 100644 --- a/clients/client-kendra/commands/DescribeFaqCommand.ts +++ b/clients/client-kendra/commands/DescribeFaqCommand.ts @@ -22,6 +22,20 @@ export interface DescribeFaqCommandOutput extends DescribeFaqResponse, __Metadat /** *

Gets information about an FAQ list.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { KendraClient, DescribeFaqCommand } from "@aws-sdk/client-kendra"; // ES Modules import + * // const { KendraClient, DescribeFaqCommand } = require("@aws-sdk/client-kendra"); // CommonJS import + * const client = new KendraClient(config); + * const command = new DescribeFaqCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeFaqCommandInput} for command's `input` shape. + * @see {@link DescribeFaqCommandOutput} for command's `response` shape. + * @see {@link KendraClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeFaqCommand extends $Command< DescribeFaqCommandInput, diff --git a/clients/client-kendra/commands/DescribeIndexCommand.ts b/clients/client-kendra/commands/DescribeIndexCommand.ts index dbae4a364075..8c65d8bf6254 100644 --- a/clients/client-kendra/commands/DescribeIndexCommand.ts +++ b/clients/client-kendra/commands/DescribeIndexCommand.ts @@ -22,6 +22,20 @@ export interface DescribeIndexCommandOutput extends DescribeIndexResponse, __Met /** *

Describes an existing Amazon Kendra index

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { KendraClient, DescribeIndexCommand } from "@aws-sdk/client-kendra"; // ES Modules import + * // const { KendraClient, DescribeIndexCommand } = require("@aws-sdk/client-kendra"); // CommonJS import + * const client = new KendraClient(config); + * const command = new DescribeIndexCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeIndexCommandInput} for command's `input` shape. + * @see {@link DescribeIndexCommandOutput} for command's `response` shape. + * @see {@link KendraClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeIndexCommand extends $Command< DescribeIndexCommandInput, diff --git a/clients/client-kendra/commands/DescribeThesaurusCommand.ts b/clients/client-kendra/commands/DescribeThesaurusCommand.ts index bca24b2adfb5..0b3086924fe5 100644 --- a/clients/client-kendra/commands/DescribeThesaurusCommand.ts +++ b/clients/client-kendra/commands/DescribeThesaurusCommand.ts @@ -22,6 +22,20 @@ export interface DescribeThesaurusCommandOutput extends DescribeThesaurusRespons /** *

Describes an existing Amazon Kendra thesaurus.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { KendraClient, DescribeThesaurusCommand } from "@aws-sdk/client-kendra"; // ES Modules import + * // const { KendraClient, DescribeThesaurusCommand } = require("@aws-sdk/client-kendra"); // CommonJS import + * const client = new KendraClient(config); + * const command = new DescribeThesaurusCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeThesaurusCommandInput} for command's `input` shape. + * @see {@link DescribeThesaurusCommandOutput} for command's `response` shape. + * @see {@link KendraClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeThesaurusCommand extends $Command< DescribeThesaurusCommandInput, diff --git a/clients/client-kendra/commands/ListDataSourceSyncJobsCommand.ts b/clients/client-kendra/commands/ListDataSourceSyncJobsCommand.ts index 560132cd73ec..8522e3be1e23 100644 --- a/clients/client-kendra/commands/ListDataSourceSyncJobsCommand.ts +++ b/clients/client-kendra/commands/ListDataSourceSyncJobsCommand.ts @@ -23,6 +23,20 @@ export interface ListDataSourceSyncJobsCommandOutput extends ListDataSourceSyncJ /** *

Gets statistics about synchronizing Amazon Kendra with a data * source.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { KendraClient, ListDataSourceSyncJobsCommand } from "@aws-sdk/client-kendra"; // ES Modules import + * // const { KendraClient, ListDataSourceSyncJobsCommand } = require("@aws-sdk/client-kendra"); // CommonJS import + * const client = new KendraClient(config); + * const command = new ListDataSourceSyncJobsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListDataSourceSyncJobsCommandInput} for command's `input` shape. + * @see {@link ListDataSourceSyncJobsCommandOutput} for command's `response` shape. + * @see {@link KendraClientResolvedConfig | config} for command's `input` shape. + * */ export class ListDataSourceSyncJobsCommand extends $Command< ListDataSourceSyncJobsCommandInput, diff --git a/clients/client-kendra/commands/ListDataSourcesCommand.ts b/clients/client-kendra/commands/ListDataSourcesCommand.ts index 1da67e8e45ee..1c900648de2d 100644 --- a/clients/client-kendra/commands/ListDataSourcesCommand.ts +++ b/clients/client-kendra/commands/ListDataSourcesCommand.ts @@ -22,6 +22,20 @@ export interface ListDataSourcesCommandOutput extends ListDataSourcesResponse, _ /** *

Lists the data sources that you have created.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { KendraClient, ListDataSourcesCommand } from "@aws-sdk/client-kendra"; // ES Modules import + * // const { KendraClient, ListDataSourcesCommand } = require("@aws-sdk/client-kendra"); // CommonJS import + * const client = new KendraClient(config); + * const command = new ListDataSourcesCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListDataSourcesCommandInput} for command's `input` shape. + * @see {@link ListDataSourcesCommandOutput} for command's `response` shape. + * @see {@link KendraClientResolvedConfig | config} for command's `input` shape. + * */ export class ListDataSourcesCommand extends $Command< ListDataSourcesCommandInput, diff --git a/clients/client-kendra/commands/ListFaqsCommand.ts b/clients/client-kendra/commands/ListFaqsCommand.ts index aa3a5fe562a8..575f5db49133 100644 --- a/clients/client-kendra/commands/ListFaqsCommand.ts +++ b/clients/client-kendra/commands/ListFaqsCommand.ts @@ -19,6 +19,20 @@ export interface ListFaqsCommandOutput extends ListFaqsResponse, __MetadataBeare /** *

Gets a list of FAQ lists associated with an index.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { KendraClient, ListFaqsCommand } from "@aws-sdk/client-kendra"; // ES Modules import + * // const { KendraClient, ListFaqsCommand } = require("@aws-sdk/client-kendra"); // CommonJS import + * const client = new KendraClient(config); + * const command = new ListFaqsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListFaqsCommandInput} for command's `input` shape. + * @see {@link ListFaqsCommandOutput} for command's `response` shape. + * @see {@link KendraClientResolvedConfig | config} for command's `input` shape. + * */ export class ListFaqsCommand extends $Command { // Start section: command_properties diff --git a/clients/client-kendra/commands/ListIndicesCommand.ts b/clients/client-kendra/commands/ListIndicesCommand.ts index e996620debd8..0885b4ba6784 100644 --- a/clients/client-kendra/commands/ListIndicesCommand.ts +++ b/clients/client-kendra/commands/ListIndicesCommand.ts @@ -22,6 +22,20 @@ export interface ListIndicesCommandOutput extends ListIndicesResponse, __Metadat /** *

Lists the Amazon Kendra indexes that you have created.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { KendraClient, ListIndicesCommand } from "@aws-sdk/client-kendra"; // ES Modules import + * // const { KendraClient, ListIndicesCommand } = require("@aws-sdk/client-kendra"); // CommonJS import + * const client = new KendraClient(config); + * const command = new ListIndicesCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListIndicesCommandInput} for command's `input` shape. + * @see {@link ListIndicesCommandOutput} for command's `response` shape. + * @see {@link KendraClientResolvedConfig | config} for command's `input` shape. + * */ export class ListIndicesCommand extends $Command< ListIndicesCommandInput, diff --git a/clients/client-kendra/commands/ListTagsForResourceCommand.ts b/clients/client-kendra/commands/ListTagsForResourceCommand.ts index ecd79a74a470..efad5e89b27c 100644 --- a/clients/client-kendra/commands/ListTagsForResourceCommand.ts +++ b/clients/client-kendra/commands/ListTagsForResourceCommand.ts @@ -23,6 +23,20 @@ export interface ListTagsForResourceCommandOutput extends ListTagsForResourceRes /** *

Gets a list of tags associated with a specified resource. Indexes, * FAQs, and data sources can have tags associated with them.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { KendraClient, ListTagsForResourceCommand } from "@aws-sdk/client-kendra"; // ES Modules import + * // const { KendraClient, ListTagsForResourceCommand } = require("@aws-sdk/client-kendra"); // CommonJS import + * const client = new KendraClient(config); + * const command = new ListTagsForResourceCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListTagsForResourceCommandInput} for command's `input` shape. + * @see {@link ListTagsForResourceCommandOutput} for command's `response` shape. + * @see {@link KendraClientResolvedConfig | config} for command's `input` shape. + * */ export class ListTagsForResourceCommand extends $Command< ListTagsForResourceCommandInput, diff --git a/clients/client-kendra/commands/ListThesauriCommand.ts b/clients/client-kendra/commands/ListThesauriCommand.ts index 51ef69057390..1f835068d11f 100644 --- a/clients/client-kendra/commands/ListThesauriCommand.ts +++ b/clients/client-kendra/commands/ListThesauriCommand.ts @@ -22,6 +22,20 @@ export interface ListThesauriCommandOutput extends ListThesauriResponse, __Metad /** *

Lists the Amazon Kendra thesauri associated with an index.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { KendraClient, ListThesauriCommand } from "@aws-sdk/client-kendra"; // ES Modules import + * // const { KendraClient, ListThesauriCommand } = require("@aws-sdk/client-kendra"); // CommonJS import + * const client = new KendraClient(config); + * const command = new ListThesauriCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListThesauriCommandInput} for command's `input` shape. + * @see {@link ListThesauriCommandOutput} for command's `response` shape. + * @see {@link KendraClientResolvedConfig | config} for command's `input` shape. + * */ export class ListThesauriCommand extends $Command< ListThesauriCommandInput, diff --git a/clients/client-kendra/commands/QueryCommand.ts b/clients/client-kendra/commands/QueryCommand.ts index cd8897b2e399..d5d6e3796490 100644 --- a/clients/client-kendra/commands/QueryCommand.ts +++ b/clients/client-kendra/commands/QueryCommand.ts @@ -40,6 +40,20 @@ export interface QueryCommandOutput extends QueryResult, __MetadataBearer {} *

You can specify that the query return only one type of result using * the QueryResultTypeConfig parameter.

*

Each query returns the 100 most relevant results.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { KendraClient, QueryCommand } from "@aws-sdk/client-kendra"; // ES Modules import + * // const { KendraClient, QueryCommand } = require("@aws-sdk/client-kendra"); // CommonJS import + * const client = new KendraClient(config); + * const command = new QueryCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link QueryCommandInput} for command's `input` shape. + * @see {@link QueryCommandOutput} for command's `response` shape. + * @see {@link KendraClientResolvedConfig | config} for command's `input` shape. + * */ export class QueryCommand extends $Command { // Start section: command_properties diff --git a/clients/client-kendra/commands/StartDataSourceSyncJobCommand.ts b/clients/client-kendra/commands/StartDataSourceSyncJobCommand.ts index 8dfd571013cf..1a0645d2ec54 100644 --- a/clients/client-kendra/commands/StartDataSourceSyncJobCommand.ts +++ b/clients/client-kendra/commands/StartDataSourceSyncJobCommand.ts @@ -24,6 +24,20 @@ export interface StartDataSourceSyncJobCommandOutput extends StartDataSourceSync *

Starts a synchronization job for a data source. If a synchronization * job is already in progress, Amazon Kendra returns a * ResourceInUseException exception.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { KendraClient, StartDataSourceSyncJobCommand } from "@aws-sdk/client-kendra"; // ES Modules import + * // const { KendraClient, StartDataSourceSyncJobCommand } = require("@aws-sdk/client-kendra"); // CommonJS import + * const client = new KendraClient(config); + * const command = new StartDataSourceSyncJobCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link StartDataSourceSyncJobCommandInput} for command's `input` shape. + * @see {@link StartDataSourceSyncJobCommandOutput} for command's `response` shape. + * @see {@link KendraClientResolvedConfig | config} for command's `input` shape. + * */ export class StartDataSourceSyncJobCommand extends $Command< StartDataSourceSyncJobCommandInput, diff --git a/clients/client-kendra/commands/StopDataSourceSyncJobCommand.ts b/clients/client-kendra/commands/StopDataSourceSyncJobCommand.ts index cdf56160fdac..3ba285aafd06 100644 --- a/clients/client-kendra/commands/StopDataSourceSyncJobCommand.ts +++ b/clients/client-kendra/commands/StopDataSourceSyncJobCommand.ts @@ -23,6 +23,20 @@ export interface StopDataSourceSyncJobCommandOutput extends __MetadataBearer {} /** *

Stops a running synchronization job. You can't stop a scheduled * synchronization job.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { KendraClient, StopDataSourceSyncJobCommand } from "@aws-sdk/client-kendra"; // ES Modules import + * // const { KendraClient, StopDataSourceSyncJobCommand } = require("@aws-sdk/client-kendra"); // CommonJS import + * const client = new KendraClient(config); + * const command = new StopDataSourceSyncJobCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link StopDataSourceSyncJobCommandInput} for command's `input` shape. + * @see {@link StopDataSourceSyncJobCommandOutput} for command's `response` shape. + * @see {@link KendraClientResolvedConfig | config} for command's `input` shape. + * */ export class StopDataSourceSyncJobCommand extends $Command< StopDataSourceSyncJobCommandInput, diff --git a/clients/client-kendra/commands/SubmitFeedbackCommand.ts b/clients/client-kendra/commands/SubmitFeedbackCommand.ts index cddea36738f2..7ce8964e831e 100644 --- a/clients/client-kendra/commands/SubmitFeedbackCommand.ts +++ b/clients/client-kendra/commands/SubmitFeedbackCommand.ts @@ -23,6 +23,20 @@ export interface SubmitFeedbackCommandOutput extends __MetadataBearer {} /** *

Enables you to provide feedback to Amazon Kendra to improve the * performance of the service.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { KendraClient, SubmitFeedbackCommand } from "@aws-sdk/client-kendra"; // ES Modules import + * // const { KendraClient, SubmitFeedbackCommand } = require("@aws-sdk/client-kendra"); // CommonJS import + * const client = new KendraClient(config); + * const command = new SubmitFeedbackCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link SubmitFeedbackCommandInput} for command's `input` shape. + * @see {@link SubmitFeedbackCommandOutput} for command's `response` shape. + * @see {@link KendraClientResolvedConfig | config} for command's `input` shape. + * */ export class SubmitFeedbackCommand extends $Command< SubmitFeedbackCommandInput, diff --git a/clients/client-kendra/commands/TagResourceCommand.ts b/clients/client-kendra/commands/TagResourceCommand.ts index 020694775aa5..51551a5258c2 100644 --- a/clients/client-kendra/commands/TagResourceCommand.ts +++ b/clients/client-kendra/commands/TagResourceCommand.ts @@ -24,6 +24,20 @@ export interface TagResourceCommandOutput extends TagResourceResponse, __Metadat *

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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { KendraClient, TagResourceCommand } from "@aws-sdk/client-kendra"; // ES Modules import + * // const { KendraClient, TagResourceCommand } = require("@aws-sdk/client-kendra"); // CommonJS import + * const client = new KendraClient(config); + * const command = new TagResourceCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link TagResourceCommandInput} for command's `input` shape. + * @see {@link TagResourceCommandOutput} for command's `response` shape. + * @see {@link KendraClientResolvedConfig | config} for command's `input` shape. + * */ export class TagResourceCommand extends $Command< TagResourceCommandInput, diff --git a/clients/client-kendra/commands/UntagResourceCommand.ts b/clients/client-kendra/commands/UntagResourceCommand.ts index c7fec1fcb70b..c608624bfc4f 100644 --- a/clients/client-kendra/commands/UntagResourceCommand.ts +++ b/clients/client-kendra/commands/UntagResourceCommand.ts @@ -22,6 +22,20 @@ export interface UntagResourceCommandOutput extends UntagResourceResponse, __Met /** *

Removes a tag from an index, FAQ, or a data source.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { KendraClient, UntagResourceCommand } from "@aws-sdk/client-kendra"; // ES Modules import + * // const { KendraClient, UntagResourceCommand } = require("@aws-sdk/client-kendra"); // CommonJS import + * const client = new KendraClient(config); + * const command = new UntagResourceCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link UntagResourceCommandInput} for command's `input` shape. + * @see {@link UntagResourceCommandOutput} for command's `response` shape. + * @see {@link KendraClientResolvedConfig | config} for command's `input` shape. + * */ export class UntagResourceCommand extends $Command< UntagResourceCommandInput, diff --git a/clients/client-kendra/commands/UpdateDataSourceCommand.ts b/clients/client-kendra/commands/UpdateDataSourceCommand.ts index 6aeb0e43609e..a8f21e581f47 100644 --- a/clients/client-kendra/commands/UpdateDataSourceCommand.ts +++ b/clients/client-kendra/commands/UpdateDataSourceCommand.ts @@ -22,6 +22,20 @@ export interface UpdateDataSourceCommandOutput extends __MetadataBearer {} /** *

Updates an existing Amazon Kendra data source.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { KendraClient, UpdateDataSourceCommand } from "@aws-sdk/client-kendra"; // ES Modules import + * // const { KendraClient, UpdateDataSourceCommand } = require("@aws-sdk/client-kendra"); // CommonJS import + * const client = new KendraClient(config); + * const command = new UpdateDataSourceCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link UpdateDataSourceCommandInput} for command's `input` shape. + * @see {@link UpdateDataSourceCommandOutput} for command's `response` shape. + * @see {@link KendraClientResolvedConfig | config} for command's `input` shape. + * */ export class UpdateDataSourceCommand extends $Command< UpdateDataSourceCommandInput, diff --git a/clients/client-kendra/commands/UpdateIndexCommand.ts b/clients/client-kendra/commands/UpdateIndexCommand.ts index 5707e3e30978..6df57f3bb72e 100644 --- a/clients/client-kendra/commands/UpdateIndexCommand.ts +++ b/clients/client-kendra/commands/UpdateIndexCommand.ts @@ -22,6 +22,20 @@ export interface UpdateIndexCommandOutput extends __MetadataBearer {} /** *

Updates an existing Amazon Kendra index.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { KendraClient, UpdateIndexCommand } from "@aws-sdk/client-kendra"; // ES Modules import + * // const { KendraClient, UpdateIndexCommand } = require("@aws-sdk/client-kendra"); // CommonJS import + * const client = new KendraClient(config); + * const command = new UpdateIndexCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link UpdateIndexCommandInput} for command's `input` shape. + * @see {@link UpdateIndexCommandOutput} for command's `response` shape. + * @see {@link KendraClientResolvedConfig | config} for command's `input` shape. + * */ export class UpdateIndexCommand extends $Command< UpdateIndexCommandInput, diff --git a/clients/client-kendra/commands/UpdateThesaurusCommand.ts b/clients/client-kendra/commands/UpdateThesaurusCommand.ts index 7aead4857e9e..af8121127c65 100644 --- a/clients/client-kendra/commands/UpdateThesaurusCommand.ts +++ b/clients/client-kendra/commands/UpdateThesaurusCommand.ts @@ -22,6 +22,20 @@ export interface UpdateThesaurusCommandOutput extends __MetadataBearer {} /** *

Updates a thesaurus file associated with an index.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { KendraClient, UpdateThesaurusCommand } from "@aws-sdk/client-kendra"; // ES Modules import + * // const { KendraClient, UpdateThesaurusCommand } = require("@aws-sdk/client-kendra"); // CommonJS import + * const client = new KendraClient(config); + * const command = new UpdateThesaurusCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link UpdateThesaurusCommandInput} for command's `input` shape. + * @see {@link UpdateThesaurusCommandOutput} for command's `response` shape. + * @see {@link KendraClientResolvedConfig | config} for command's `input` shape. + * */ export class UpdateThesaurusCommand extends $Command< UpdateThesaurusCommandInput, diff --git a/clients/client-kendra/models/models_0.ts b/clients/client-kendra/models/models_0.ts index c33a4f6dc946..4519fa97a3a0 100644 --- a/clients/client-kendra/models/models_0.ts +++ b/clients/client-kendra/models/models_0.ts @@ -14,6 +14,9 @@ export interface AccessControlListConfiguration { } export namespace AccessControlListConfiguration { + /** + * @internal + */ export const filterSensitiveLog = (obj: AccessControlListConfiguration): any => ({ ...obj, }); @@ -29,6 +32,9 @@ export interface AccessDeniedException extends __SmithyException, $MetadataBeare } export namespace AccessDeniedException { + /** + * @internal + */ export const filterSensitiveLog = (obj: AccessDeniedException): any => ({ ...obj, }); @@ -50,6 +56,9 @@ export interface AclConfiguration { } export namespace AclConfiguration { + /** + * @internal + */ export const filterSensitiveLog = (obj: AclConfiguration): any => ({ ...obj, }); @@ -91,6 +100,9 @@ export interface Highlight { } export namespace Highlight { + /** + * @internal + */ export const filterSensitiveLog = (obj: Highlight): any => ({ ...obj, }); @@ -114,6 +126,9 @@ export interface TextWithHighlights { } export namespace TextWithHighlights { + /** + * @internal + */ export const filterSensitiveLog = (obj: TextWithHighlights): any => ({ ...obj, }); @@ -131,6 +146,9 @@ export interface AdditionalResultAttributeValue { } export namespace AdditionalResultAttributeValue { + /** + * @internal + */ export const filterSensitiveLog = (obj: AdditionalResultAttributeValue): any => ({ ...obj, }); @@ -161,6 +179,9 @@ export interface AdditionalResultAttribute { } export namespace AdditionalResultAttribute { + /** + * @internal + */ export const filterSensitiveLog = (obj: AdditionalResultAttribute): any => ({ ...obj, }); @@ -246,6 +267,9 @@ export namespace DocumentAttributeValue { return visitor._(value.$unknown[0], value.$unknown[1]); }; + /** + * @internal + */ export const filterSensitiveLog = (obj: DocumentAttributeValue): any => { if (obj.StringValue !== undefined) return { StringValue: obj.StringValue }; if (obj.StringListValue !== undefined) return { StringListValue: obj.StringListValue }; @@ -271,6 +295,9 @@ export interface DocumentAttribute { } export namespace DocumentAttribute { + /** + * @internal + */ export const filterSensitiveLog = (obj: DocumentAttribute): any => ({ ...obj, ...(obj.Value && { Value: DocumentAttributeValue.filterSensitiveLog(obj.Value) }), @@ -294,6 +321,9 @@ export interface DataSourceSyncJobMetricTarget { } export namespace DataSourceSyncJobMetricTarget { + /** + * @internal + */ export const filterSensitiveLog = (obj: DataSourceSyncJobMetricTarget): any => ({ ...obj, }); @@ -319,6 +349,9 @@ export interface BatchDeleteDocumentRequest { } export namespace BatchDeleteDocumentRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: BatchDeleteDocumentRequest): any => ({ ...obj, }); @@ -355,6 +388,9 @@ export interface BatchDeleteDocumentResponseFailedDocument { } export namespace BatchDeleteDocumentResponseFailedDocument { + /** + * @internal + */ export const filterSensitiveLog = (obj: BatchDeleteDocumentResponseFailedDocument): any => ({ ...obj, }); @@ -370,6 +406,9 @@ export interface BatchDeleteDocumentResponse { } export namespace BatchDeleteDocumentResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: BatchDeleteDocumentResponse): any => ({ ...obj, }); @@ -385,6 +424,9 @@ export interface ConflictException extends __SmithyException, $MetadataBearer { } export namespace ConflictException { + /** + * @internal + */ export const filterSensitiveLog = (obj: ConflictException): any => ({ ...obj, }); @@ -400,6 +442,9 @@ export interface InternalServerException extends __SmithyException, $MetadataBea } export namespace InternalServerException { + /** + * @internal + */ export const filterSensitiveLog = (obj: InternalServerException): any => ({ ...obj, }); @@ -415,6 +460,9 @@ export interface ResourceNotFoundException extends __SmithyException, $MetadataB } export namespace ResourceNotFoundException { + /** + * @internal + */ export const filterSensitiveLog = (obj: ResourceNotFoundException): any => ({ ...obj, }); @@ -430,6 +478,9 @@ export interface ThrottlingException extends __SmithyException, $MetadataBearer } export namespace ThrottlingException { + /** + * @internal + */ export const filterSensitiveLog = (obj: ThrottlingException): any => ({ ...obj, }); @@ -445,6 +496,9 @@ export interface ValidationException extends __SmithyException, $MetadataBearer } export namespace ValidationException { + /** + * @internal + */ export const filterSensitiveLog = (obj: ValidationException): any => ({ ...obj, }); @@ -482,6 +536,9 @@ export interface Principal { } export namespace Principal { + /** + * @internal + */ export const filterSensitiveLog = (obj: Principal): any => ({ ...obj, }); @@ -512,6 +569,9 @@ export interface S3Path { } export namespace S3Path { + /** + * @internal + */ export const filterSensitiveLog = (obj: S3Path): any => ({ ...obj, }); @@ -568,6 +628,9 @@ export interface Document { } export namespace Document { + /** + * @internal + */ export const filterSensitiveLog = (obj: Document): any => ({ ...obj, ...(obj.Attributes && { Attributes: obj.Attributes.map((item) => DocumentAttribute.filterSensitiveLog(item)) }), @@ -611,6 +674,9 @@ export interface BatchPutDocumentRequest { } export namespace BatchPutDocumentRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: BatchPutDocumentRequest): any => ({ ...obj, }); @@ -640,6 +706,9 @@ export interface BatchPutDocumentResponseFailedDocument { } export namespace BatchPutDocumentResponseFailedDocument { + /** + * @internal + */ export const filterSensitiveLog = (obj: BatchPutDocumentResponseFailedDocument): any => ({ ...obj, }); @@ -660,6 +729,9 @@ export interface BatchPutDocumentResponse { } export namespace BatchPutDocumentResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: BatchPutDocumentResponse): any => ({ ...obj, }); @@ -675,6 +747,9 @@ export interface ServiceQuotaExceededException extends __SmithyException, $Metad } export namespace ServiceQuotaExceededException { + /** + * @internal + */ export const filterSensitiveLog = (obj: ServiceQuotaExceededException): any => ({ ...obj, }); @@ -725,6 +800,9 @@ export interface ConfluenceAttachmentToIndexFieldMapping { } export namespace ConfluenceAttachmentToIndexFieldMapping { + /** + * @internal + */ export const filterSensitiveLog = (obj: ConfluenceAttachmentToIndexFieldMapping): any => ({ ...obj, }); @@ -754,6 +832,9 @@ export interface ConfluenceAttachmentConfiguration { } export namespace ConfluenceAttachmentConfiguration { + /** + * @internal + */ export const filterSensitiveLog = (obj: ConfluenceAttachmentConfiguration): any => ({ ...obj, }); @@ -800,6 +881,9 @@ export interface ConfluenceBlogToIndexFieldMapping { } export namespace ConfluenceBlogToIndexFieldMapping { + /** + * @internal + */ export const filterSensitiveLog = (obj: ConfluenceBlogToIndexFieldMapping): any => ({ ...obj, }); @@ -824,6 +908,9 @@ export interface ConfluenceBlogConfiguration { } export namespace ConfluenceBlogConfiguration { + /** + * @internal + */ export const filterSensitiveLog = (obj: ConfluenceBlogConfiguration): any => ({ ...obj, }); @@ -873,6 +960,9 @@ export interface ConfluencePageToIndexFieldMapping { } export namespace ConfluencePageToIndexFieldMapping { + /** + * @internal + */ export const filterSensitiveLog = (obj: ConfluencePageToIndexFieldMapping): any => ({ ...obj, }); @@ -894,6 +984,9 @@ export interface ConfluencePageConfiguration { } export namespace ConfluencePageConfiguration { + /** + * @internal + */ export const filterSensitiveLog = (obj: ConfluencePageConfiguration): any => ({ ...obj, }); @@ -935,6 +1028,9 @@ export interface ConfluenceSpaceToIndexFieldMapping { } export namespace ConfluenceSpaceToIndexFieldMapping { + /** + * @internal + */ export const filterSensitiveLog = (obj: ConfluenceSpaceToIndexFieldMapping): any => ({ ...obj, }); @@ -990,6 +1086,9 @@ export interface ConfluenceSpaceConfiguration { } export namespace ConfluenceSpaceConfiguration { + /** + * @internal + */ export const filterSensitiveLog = (obj: ConfluenceSpaceConfiguration): any => ({ ...obj, }); @@ -1021,6 +1120,9 @@ export interface DataSourceVpcConfiguration { } export namespace DataSourceVpcConfiguration { + /** + * @internal + */ export const filterSensitiveLog = (obj: DataSourceVpcConfiguration): any => ({ ...obj, }); @@ -1116,6 +1218,9 @@ export interface ConfluenceConfiguration { } export namespace ConfluenceConfiguration { + /** + * @internal + */ export const filterSensitiveLog = (obj: ConfluenceConfiguration): any => ({ ...obj, }); @@ -1144,6 +1249,9 @@ export interface DataSourceToIndexFieldMapping { } export namespace DataSourceToIndexFieldMapping { + /** + * @internal + */ export const filterSensitiveLog = (obj: DataSourceToIndexFieldMapping): any => ({ ...obj, }); @@ -1184,6 +1292,9 @@ export interface ColumnConfiguration { } export namespace ColumnConfiguration { + /** + * @internal + */ export const filterSensitiveLog = (obj: ColumnConfiguration): any => ({ ...obj, }); @@ -1228,6 +1339,9 @@ export interface ConnectionConfiguration { } export namespace ConnectionConfiguration { + /** + * @internal + */ export const filterSensitiveLog = (obj: ConnectionConfiguration): any => ({ ...obj, }); @@ -1268,6 +1382,9 @@ export interface SqlConfiguration { } export namespace SqlConfiguration { + /** + * @internal + */ export const filterSensitiveLog = (obj: SqlConfiguration): any => ({ ...obj, }); @@ -1313,6 +1430,9 @@ export interface DatabaseConfiguration { } export namespace DatabaseConfiguration { + /** + * @internal + */ export const filterSensitiveLog = (obj: DatabaseConfiguration): any => ({ ...obj, }); @@ -1385,6 +1505,9 @@ export interface GoogleDriveConfiguration { } export namespace GoogleDriveConfiguration { + /** + * @internal + */ export const filterSensitiveLog = (obj: GoogleDriveConfiguration): any => ({ ...obj, }); @@ -1412,6 +1535,9 @@ export interface OneDriveUsers { } export namespace OneDriveUsers { + /** + * @internal + */ export const filterSensitiveLog = (obj: OneDriveUsers): any => ({ ...obj, }); @@ -1477,6 +1603,9 @@ export interface OneDriveConfiguration { } export namespace OneDriveConfiguration { + /** + * @internal + */ export const filterSensitiveLog = (obj: OneDriveConfiguration): any => ({ ...obj, }); @@ -1499,6 +1628,9 @@ export interface DocumentsMetadataConfiguration { } export namespace DocumentsMetadataConfiguration { + /** + * @internal + */ export const filterSensitiveLog = (obj: DocumentsMetadataConfiguration): any => ({ ...obj, }); @@ -1556,6 +1688,9 @@ export interface S3DataSourceConfiguration { } export namespace S3DataSourceConfiguration { + /** + * @internal + */ export const filterSensitiveLog = (obj: S3DataSourceConfiguration): any => ({ ...obj, }); @@ -1603,6 +1738,9 @@ export interface SalesforceChatterFeedConfiguration { } export namespace SalesforceChatterFeedConfiguration { + /** + * @internal + */ export const filterSensitiveLog = (obj: SalesforceChatterFeedConfiguration): any => ({ ...obj, }); @@ -1638,6 +1776,9 @@ export interface SalesforceCustomKnowledgeArticleTypeConfiguration { } export namespace SalesforceCustomKnowledgeArticleTypeConfiguration { + /** + * @internal + */ export const filterSensitiveLog = (obj: SalesforceCustomKnowledgeArticleTypeConfiguration): any => ({ ...obj, }); @@ -1674,6 +1815,9 @@ export interface SalesforceStandardKnowledgeArticleTypeConfiguration { } export namespace SalesforceStandardKnowledgeArticleTypeConfiguration { + /** + * @internal + */ export const filterSensitiveLog = (obj: SalesforceStandardKnowledgeArticleTypeConfiguration): any => ({ ...obj, }); @@ -1707,6 +1851,9 @@ export interface SalesforceKnowledgeArticleConfiguration { } export namespace SalesforceKnowledgeArticleConfiguration { + /** + * @internal + */ export const filterSensitiveLog = (obj: SalesforceKnowledgeArticleConfiguration): any => ({ ...obj, }); @@ -1730,6 +1877,9 @@ export interface SalesforceStandardObjectAttachmentConfiguration { } export namespace SalesforceStandardObjectAttachmentConfiguration { + /** + * @internal + */ export const filterSensitiveLog = (obj: SalesforceStandardObjectAttachmentConfiguration): any => ({ ...obj, }); @@ -1786,6 +1936,9 @@ export interface SalesforceStandardObjectConfiguration { } export namespace SalesforceStandardObjectConfiguration { + /** + * @internal + */ export const filterSensitiveLog = (obj: SalesforceStandardObjectConfiguration): any => ({ ...obj, }); @@ -1890,6 +2043,9 @@ export interface SalesforceConfiguration { } export namespace SalesforceConfiguration { + /** + * @internal + */ export const filterSensitiveLog = (obj: SalesforceConfiguration): any => ({ ...obj, }); @@ -1958,6 +2114,9 @@ export interface ServiceNowKnowledgeArticleConfiguration { } export namespace ServiceNowKnowledgeArticleConfiguration { + /** + * @internal + */ export const filterSensitiveLog = (obj: ServiceNowKnowledgeArticleConfiguration): any => ({ ...obj, }); @@ -2014,6 +2173,9 @@ export interface ServiceNowServiceCatalogConfiguration { } export namespace ServiceNowServiceCatalogConfiguration { + /** + * @internal + */ export const filterSensitiveLog = (obj: ServiceNowServiceCatalogConfiguration): any => ({ ...obj, }); @@ -2081,6 +2243,9 @@ export interface ServiceNowConfiguration { } export namespace ServiceNowConfiguration { + /** + * @internal + */ export const filterSensitiveLog = (obj: ServiceNowConfiguration): any => ({ ...obj, }); @@ -2188,6 +2353,9 @@ export interface SharePointConfiguration { } export namespace SharePointConfiguration { + /** + * @internal + */ export const filterSensitiveLog = (obj: SharePointConfiguration): any => ({ ...obj, }); @@ -2247,6 +2415,9 @@ export interface DataSourceConfiguration { } export namespace DataSourceConfiguration { + /** + * @internal + */ export const filterSensitiveLog = (obj: DataSourceConfiguration): any => ({ ...obj, }); @@ -2272,6 +2443,9 @@ export interface Tag { } export namespace Tag { + /** + * @internal + */ export const filterSensitiveLog = (obj: Tag): any => ({ ...obj, }); @@ -2363,6 +2537,9 @@ export interface CreateDataSourceRequest { } export namespace CreateDataSourceRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateDataSourceRequest): any => ({ ...obj, }); @@ -2376,6 +2553,9 @@ export interface CreateDataSourceResponse { } export namespace CreateDataSourceResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateDataSourceResponse): any => ({ ...obj, }); @@ -2391,6 +2571,9 @@ export interface ResourceAlreadyExistException extends __SmithyException, $Metad } export namespace ResourceAlreadyExistException { + /** + * @internal + */ export const filterSensitiveLog = (obj: ResourceAlreadyExistException): any => ({ ...obj, }); @@ -2455,6 +2638,9 @@ export interface CreateFaqRequest { } export namespace CreateFaqRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateFaqRequest): any => ({ ...obj, }); @@ -2468,6 +2654,9 @@ export interface CreateFaqResponse { } export namespace CreateFaqResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateFaqResponse): any => ({ ...obj, }); @@ -2492,6 +2681,9 @@ export interface ServerSideEncryptionConfiguration { } export namespace ServerSideEncryptionConfiguration { + /** + * @internal + */ export const filterSensitiveLog = (obj: ServerSideEncryptionConfiguration): any => ({ ...obj, ...(obj.KmsKeyId && { KmsKeyId: SENSITIVE_STRING }), @@ -2519,6 +2711,9 @@ export interface JsonTokenTypeConfiguration { } export namespace JsonTokenTypeConfiguration { + /** + * @internal + */ export const filterSensitiveLog = (obj: JsonTokenTypeConfiguration): any => ({ ...obj, }); @@ -2570,6 +2765,9 @@ export interface JwtTokenTypeConfiguration { } export namespace JwtTokenTypeConfiguration { + /** + * @internal + */ export const filterSensitiveLog = (obj: JwtTokenTypeConfiguration): any => ({ ...obj, }); @@ -2591,6 +2789,9 @@ export interface UserTokenConfiguration { } export namespace UserTokenConfiguration { + /** + * @internal + */ export const filterSensitiveLog = (obj: UserTokenConfiguration): any => ({ ...obj, }); @@ -2677,6 +2878,9 @@ export interface CreateIndexRequest { } export namespace CreateIndexRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateIndexRequest): any => ({ ...obj, ...(obj.ServerSideEncryptionConfiguration && { @@ -2696,6 +2900,9 @@ export interface CreateIndexResponse { } export namespace CreateIndexResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateIndexResponse): any => ({ ...obj, }); @@ -2749,6 +2956,9 @@ export interface CreateThesaurusRequest { } export namespace CreateThesaurusRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateThesaurusRequest): any => ({ ...obj, }); @@ -2763,6 +2973,9 @@ export interface CreateThesaurusResponse { } export namespace CreateThesaurusResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateThesaurusResponse): any => ({ ...obj, }); @@ -2782,6 +2995,9 @@ export interface DeleteDataSourceRequest { } export namespace DeleteDataSourceRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteDataSourceRequest): any => ({ ...obj, }); @@ -2800,6 +3016,9 @@ export interface DeleteFaqRequest { } export namespace DeleteFaqRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteFaqRequest): any => ({ ...obj, }); @@ -2813,6 +3032,9 @@ export interface DeleteIndexRequest { } export namespace DeleteIndexRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteIndexRequest): any => ({ ...obj, }); @@ -2831,6 +3053,9 @@ export interface DeleteThesaurusRequest { } export namespace DeleteThesaurusRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteThesaurusRequest): any => ({ ...obj, }); @@ -2849,6 +3074,9 @@ export interface DescribeDataSourceRequest { } export namespace DescribeDataSourceRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeDataSourceRequest): any => ({ ...obj, }); @@ -2933,6 +3161,9 @@ export interface DescribeDataSourceResponse { } export namespace DescribeDataSourceResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeDataSourceResponse): any => ({ ...obj, }); @@ -2951,6 +3182,9 @@ export interface DescribeFaqRequest { } export namespace DescribeFaqRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeFaqRequest): any => ({ ...obj, }); @@ -3026,6 +3260,9 @@ export interface DescribeFaqResponse { } export namespace DescribeFaqResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeFaqResponse): any => ({ ...obj, }); @@ -3039,6 +3276,9 @@ export interface DescribeIndexRequest { } export namespace DescribeIndexRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeIndexRequest): any => ({ ...obj, }); @@ -3066,6 +3306,9 @@ export interface CapacityUnitsConfiguration { } export namespace CapacityUnitsConfiguration { + /** + * @internal + */ export const filterSensitiveLog = (obj: CapacityUnitsConfiguration): any => ({ ...obj, }); @@ -3143,6 +3386,9 @@ export interface Relevance { } export namespace Relevance { + /** + * @internal + */ export const filterSensitiveLog = (obj: Relevance): any => ({ ...obj, }); @@ -3185,6 +3431,9 @@ export interface Search { } export namespace Search { + /** + * @internal + */ export const filterSensitiveLog = (obj: Search): any => ({ ...obj, }); @@ -3225,6 +3474,9 @@ export interface DocumentMetadataConfiguration { } export namespace DocumentMetadataConfiguration { + /** + * @internal + */ export const filterSensitiveLog = (obj: DocumentMetadataConfiguration): any => ({ ...obj, }); @@ -3243,6 +3495,9 @@ export interface FaqStatistics { } export namespace FaqStatistics { + /** + * @internal + */ export const filterSensitiveLog = (obj: FaqStatistics): any => ({ ...obj, }); @@ -3265,6 +3520,9 @@ export interface TextDocumentStatistics { } export namespace TextDocumentStatistics { + /** + * @internal + */ export const filterSensitiveLog = (obj: TextDocumentStatistics): any => ({ ...obj, }); @@ -3287,6 +3545,9 @@ export interface IndexStatistics { } export namespace IndexStatistics { + /** + * @internal + */ export const filterSensitiveLog = (obj: IndexStatistics): any => ({ ...obj, }); @@ -3394,6 +3655,9 @@ export interface DescribeIndexResponse { } export namespace DescribeIndexResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeIndexResponse): any => ({ ...obj, ...(obj.ServerSideEncryptionConfiguration && { @@ -3417,6 +3681,9 @@ export interface DescribeThesaurusRequest { } export namespace DescribeThesaurusRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeThesaurusRequest): any => ({ ...obj, }); @@ -3515,6 +3782,9 @@ export interface DescribeThesaurusResponse { } export namespace DescribeThesaurusResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeThesaurusResponse): any => ({ ...obj, }); @@ -3541,6 +3811,9 @@ export interface ListDataSourcesRequest { } export namespace ListDataSourcesRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListDataSourcesRequest): any => ({ ...obj, }); @@ -3584,6 +3857,9 @@ export interface DataSourceSummary { } export namespace DataSourceSummary { + /** + * @internal + */ export const filterSensitiveLog = (obj: DataSourceSummary): any => ({ ...obj, }); @@ -3604,6 +3880,9 @@ export interface ListDataSourcesResponse { } export namespace ListDataSourcesResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListDataSourcesResponse): any => ({ ...obj, }); @@ -3625,6 +3904,9 @@ export interface TimeRange { } export namespace TimeRange { + /** + * @internal + */ export const filterSensitiveLog = (obj: TimeRange): any => ({ ...obj, }); @@ -3679,6 +3961,9 @@ export interface ListDataSourceSyncJobsRequest { } export namespace ListDataSourceSyncJobsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListDataSourceSyncJobsRequest): any => ({ ...obj, }); @@ -3722,6 +4007,9 @@ export interface DataSourceSyncJobMetrics { } export namespace DataSourceSyncJobMetrics { + /** + * @internal + */ export const filterSensitiveLog = (obj: DataSourceSyncJobMetrics): any => ({ ...obj, }); @@ -3787,6 +4075,9 @@ export interface DataSourceSyncJob { } export namespace DataSourceSyncJob { + /** + * @internal + */ export const filterSensitiveLog = (obj: DataSourceSyncJob): any => ({ ...obj, }); @@ -3810,6 +4101,9 @@ export interface ListDataSourceSyncJobsResponse { } export namespace ListDataSourceSyncJobsResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListDataSourceSyncJobsResponse): any => ({ ...obj, }); @@ -3835,6 +4129,9 @@ export interface ListFaqsRequest { } export namespace ListFaqsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListFaqsRequest): any => ({ ...obj, }); @@ -3879,6 +4176,9 @@ export interface FaqSummary { } export namespace FaqSummary { + /** + * @internal + */ export const filterSensitiveLog = (obj: FaqSummary): any => ({ ...obj, }); @@ -3901,6 +4201,9 @@ export interface ListFaqsResponse { } export namespace ListFaqsResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListFaqsResponse): any => ({ ...obj, }); @@ -3922,6 +4225,9 @@ export interface ListIndicesRequest { } export namespace ListIndicesRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListIndicesRequest): any => ({ ...obj, }); @@ -3969,6 +4275,9 @@ export interface IndexConfigurationSummary { } export namespace IndexConfigurationSummary { + /** + * @internal + */ export const filterSensitiveLog = (obj: IndexConfigurationSummary): any => ({ ...obj, }); @@ -3989,6 +4298,9 @@ export interface ListIndicesResponse { } export namespace ListIndicesResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListIndicesResponse): any => ({ ...obj, }); @@ -4003,6 +4315,9 @@ export interface ListTagsForResourceRequest { } export namespace ListTagsForResourceRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListTagsForResourceRequest): any => ({ ...obj, }); @@ -4016,6 +4331,9 @@ export interface ListTagsForResourceResponse { } export namespace ListTagsForResourceResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListTagsForResourceResponse): any => ({ ...obj, }); @@ -4031,6 +4349,9 @@ export interface ResourceUnavailableException extends __SmithyException, $Metada } export namespace ResourceUnavailableException { + /** + * @internal + */ export const filterSensitiveLog = (obj: ResourceUnavailableException): any => ({ ...obj, }); @@ -4057,6 +4378,9 @@ export interface ListThesauriRequest { } export namespace ListThesauriRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListThesauriRequest): any => ({ ...obj, }); @@ -4093,6 +4417,9 @@ export interface ThesaurusSummary { } export namespace ThesaurusSummary { + /** + * @internal + */ export const filterSensitiveLog = (obj: ThesaurusSummary): any => ({ ...obj, }); @@ -4114,6 +4441,9 @@ export interface ListThesauriResponse { } export namespace ListThesauriResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListThesauriResponse): any => ({ ...obj, }); @@ -4139,6 +4469,9 @@ export interface DocumentRelevanceConfiguration { } export namespace DocumentRelevanceConfiguration { + /** + * @internal + */ export const filterSensitiveLog = (obj: DocumentRelevanceConfiguration): any => ({ ...obj, }); @@ -4155,6 +4488,9 @@ export interface Facet { } export namespace Facet { + /** + * @internal + */ export const filterSensitiveLog = (obj: Facet): any => ({ ...obj, }); @@ -4231,6 +4567,9 @@ export interface SortingConfiguration { } export namespace SortingConfiguration { + /** + * @internal + */ export const filterSensitiveLog = (obj: SortingConfiguration): any => ({ ...obj, }); @@ -4247,6 +4586,9 @@ export interface UserContext { } export namespace UserContext { + /** + * @internal + */ export const filterSensitiveLog = (obj: UserContext): any => ({ ...obj, }); @@ -4270,6 +4612,9 @@ export interface DocumentAttributeValueCountPair { } export namespace DocumentAttributeValueCountPair { + /** + * @internal + */ export const filterSensitiveLog = (obj: DocumentAttributeValueCountPair): any => ({ ...obj, ...(obj.DocumentAttributeValue && { @@ -4303,6 +4648,9 @@ export interface FacetResult { } export namespace FacetResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: FacetResult): any => ({ ...obj, ...(obj.DocumentAttributeValueCountPairs && { @@ -4333,6 +4681,9 @@ export interface ScoreAttributes { } export namespace ScoreAttributes { + /** + * @internal + */ export const filterSensitiveLog = (obj: ScoreAttributes): any => ({ ...obj, }); @@ -4414,6 +4765,9 @@ export interface QueryResultItem { } export namespace QueryResultItem { + /** + * @internal + */ export const filterSensitiveLog = (obj: QueryResultItem): any => ({ ...obj, ...(obj.DocumentAttributes && { @@ -4450,6 +4804,9 @@ export interface QueryResult { } export namespace QueryResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: QueryResult): any => ({ ...obj, }); @@ -4465,6 +4822,9 @@ export interface ResourceInUseException extends __SmithyException, $MetadataBear } export namespace ResourceInUseException { + /** + * @internal + */ export const filterSensitiveLog = (obj: ResourceInUseException): any => ({ ...obj, }); @@ -4483,6 +4843,9 @@ export interface StartDataSourceSyncJobRequest { } export namespace StartDataSourceSyncJobRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: StartDataSourceSyncJobRequest): any => ({ ...obj, }); @@ -4496,6 +4859,9 @@ export interface StartDataSourceSyncJobResponse { } export namespace StartDataSourceSyncJobResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: StartDataSourceSyncJobResponse): any => ({ ...obj, }); @@ -4515,6 +4881,9 @@ export interface StopDataSourceSyncJobRequest { } export namespace StopDataSourceSyncJobRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: StopDataSourceSyncJobRequest): any => ({ ...obj, }); @@ -4540,6 +4909,9 @@ export interface ClickFeedback { } export namespace ClickFeedback { + /** + * @internal + */ export const filterSensitiveLog = (obj: ClickFeedback): any => ({ ...obj, }); @@ -4570,6 +4942,9 @@ export interface RelevanceFeedback { } export namespace RelevanceFeedback { + /** + * @internal + */ export const filterSensitiveLog = (obj: RelevanceFeedback): any => ({ ...obj, }); @@ -4602,6 +4977,9 @@ export interface SubmitFeedbackRequest { } export namespace SubmitFeedbackRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: SubmitFeedbackRequest): any => ({ ...obj, }); @@ -4622,6 +5000,9 @@ export interface TagResourceRequest { } export namespace TagResourceRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: TagResourceRequest): any => ({ ...obj, }); @@ -4630,6 +5011,9 @@ export namespace TagResourceRequest { export interface TagResourceResponse {} export namespace TagResourceResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: TagResourceResponse): any => ({ ...obj, }); @@ -4650,6 +5034,9 @@ export interface UntagResourceRequest { } export namespace UntagResourceRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: UntagResourceRequest): any => ({ ...obj, }); @@ -4658,6 +5045,9 @@ export namespace UntagResourceRequest { export interface UntagResourceResponse {} export namespace UntagResourceResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: UntagResourceResponse): any => ({ ...obj, }); @@ -4705,6 +5095,9 @@ export interface UpdateDataSourceRequest { } export namespace UpdateDataSourceRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateDataSourceRequest): any => ({ ...obj, }); @@ -4759,6 +5152,9 @@ export interface UpdateIndexRequest { } export namespace UpdateIndexRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateIndexRequest): any => ({ ...obj, }); @@ -4798,6 +5194,9 @@ export interface UpdateThesaurusRequest { } export namespace UpdateThesaurusRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateThesaurusRequest): any => ({ ...obj, }); @@ -4897,6 +5296,9 @@ export interface AttributeFilter { } export namespace AttributeFilter { + /** + * @internal + */ export const filterSensitiveLog = (obj: AttributeFilter): any => ({ ...obj, ...(obj.AndAllFilters && { @@ -5014,6 +5416,9 @@ export interface QueryRequest { } export namespace QueryRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: QueryRequest): any => ({ ...obj, ...(obj.AttributeFilter && { AttributeFilter: AttributeFilter.filterSensitiveLog(obj.AttributeFilter) }), diff --git a/clients/client-kinesis-analytics-v2/commands/AddApplicationCloudWatchLoggingOptionCommand.ts b/clients/client-kinesis-analytics-v2/commands/AddApplicationCloudWatchLoggingOptionCommand.ts index 700ddbf2a693..59fc6b2f3fa3 100644 --- a/clients/client-kinesis-analytics-v2/commands/AddApplicationCloudWatchLoggingOptionCommand.ts +++ b/clients/client-kinesis-analytics-v2/commands/AddApplicationCloudWatchLoggingOptionCommand.ts @@ -32,6 +32,20 @@ export interface AddApplicationCloudWatchLoggingOptionCommandOutput /** *

Adds an Amazon CloudWatch log stream to monitor application configuration errors.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { KinesisAnalyticsV2Client, AddApplicationCloudWatchLoggingOptionCommand } from "@aws-sdk/client-kinesis-analytics-v2"; // ES Modules import + * // const { KinesisAnalyticsV2Client, AddApplicationCloudWatchLoggingOptionCommand } = require("@aws-sdk/client-kinesis-analytics-v2"); // CommonJS import + * const client = new KinesisAnalyticsV2Client(config); + * const command = new AddApplicationCloudWatchLoggingOptionCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link AddApplicationCloudWatchLoggingOptionCommandInput} for command's `input` shape. + * @see {@link AddApplicationCloudWatchLoggingOptionCommandOutput} for command's `response` shape. + * @see {@link KinesisAnalyticsV2ClientResolvedConfig | config} for command's `input` shape. + * */ export class AddApplicationCloudWatchLoggingOptionCommand extends $Command< AddApplicationCloudWatchLoggingOptionCommandInput, diff --git a/clients/client-kinesis-analytics-v2/commands/AddApplicationInputCommand.ts b/clients/client-kinesis-analytics-v2/commands/AddApplicationInputCommand.ts index 0c924923028a..dfafa5f8f9de 100644 --- a/clients/client-kinesis-analytics-v2/commands/AddApplicationInputCommand.ts +++ b/clients/client-kinesis-analytics-v2/commands/AddApplicationInputCommand.ts @@ -35,6 +35,20 @@ export interface AddApplicationInputCommandOutput extends AddApplicationInputRes * results in a new version of the application. You can use the DescribeApplication operation * to find the current application version. *

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { KinesisAnalyticsV2Client, AddApplicationInputCommand } from "@aws-sdk/client-kinesis-analytics-v2"; // ES Modules import + * // const { KinesisAnalyticsV2Client, AddApplicationInputCommand } = require("@aws-sdk/client-kinesis-analytics-v2"); // CommonJS import + * const client = new KinesisAnalyticsV2Client(config); + * const command = new AddApplicationInputCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link AddApplicationInputCommandInput} for command's `input` shape. + * @see {@link AddApplicationInputCommandOutput} for command's `response` shape. + * @see {@link KinesisAnalyticsV2ClientResolvedConfig | config} for command's `input` shape. + * */ export class AddApplicationInputCommand extends $Command< AddApplicationInputCommandInput, diff --git a/clients/client-kinesis-analytics-v2/commands/AddApplicationInputProcessingConfigurationCommand.ts b/clients/client-kinesis-analytics-v2/commands/AddApplicationInputProcessingConfigurationCommand.ts index 69582c42b744..5a2e21e92b20 100644 --- a/clients/client-kinesis-analytics-v2/commands/AddApplicationInputProcessingConfigurationCommand.ts +++ b/clients/client-kinesis-analytics-v2/commands/AddApplicationInputProcessingConfigurationCommand.ts @@ -34,6 +34,20 @@ export interface AddApplicationInputProcessingConfigurationCommandOutput *

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 AWS Lambda.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { KinesisAnalyticsV2Client, AddApplicationInputProcessingConfigurationCommand } from "@aws-sdk/client-kinesis-analytics-v2"; // ES Modules import + * // const { KinesisAnalyticsV2Client, AddApplicationInputProcessingConfigurationCommand } = require("@aws-sdk/client-kinesis-analytics-v2"); // CommonJS import + * const client = new KinesisAnalyticsV2Client(config); + * const command = new AddApplicationInputProcessingConfigurationCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link AddApplicationInputProcessingConfigurationCommandInput} for command's `input` shape. + * @see {@link AddApplicationInputProcessingConfigurationCommandOutput} for command's `response` shape. + * @see {@link KinesisAnalyticsV2ClientResolvedConfig | config} for command's `input` shape. + * */ export class AddApplicationInputProcessingConfigurationCommand extends $Command< AddApplicationInputProcessingConfigurationCommandInput, diff --git a/clients/client-kinesis-analytics-v2/commands/AddApplicationOutputCommand.ts b/clients/client-kinesis-analytics-v2/commands/AddApplicationOutputCommand.ts index 32a841f94bc1..d31532a2ec64 100644 --- a/clients/client-kinesis-analytics-v2/commands/AddApplicationOutputCommand.ts +++ b/clients/client-kinesis-analytics-v2/commands/AddApplicationOutputCommand.ts @@ -38,6 +38,20 @@ export interface AddApplicationOutputCommandOutput extends AddApplicationOutputR *

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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { KinesisAnalyticsV2Client, AddApplicationOutputCommand } from "@aws-sdk/client-kinesis-analytics-v2"; // ES Modules import + * // const { KinesisAnalyticsV2Client, AddApplicationOutputCommand } = require("@aws-sdk/client-kinesis-analytics-v2"); // CommonJS import + * const client = new KinesisAnalyticsV2Client(config); + * const command = new AddApplicationOutputCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link AddApplicationOutputCommandInput} for command's `input` shape. + * @see {@link AddApplicationOutputCommandOutput} for command's `response` shape. + * @see {@link KinesisAnalyticsV2ClientResolvedConfig | config} for command's `input` shape. + * */ export class AddApplicationOutputCommand extends $Command< AddApplicationOutputCommandInput, diff --git a/clients/client-kinesis-analytics-v2/commands/AddApplicationReferenceDataSourceCommand.ts b/clients/client-kinesis-analytics-v2/commands/AddApplicationReferenceDataSourceCommand.ts index 819b85edaed8..d24473341be7 100644 --- a/clients/client-kinesis-analytics-v2/commands/AddApplicationReferenceDataSourceCommand.ts +++ b/clients/client-kinesis-analytics-v2/commands/AddApplicationReferenceDataSourceCommand.ts @@ -36,6 +36,20 @@ export interface AddApplicationReferenceDataSourceCommandOutput * 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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { KinesisAnalyticsV2Client, AddApplicationReferenceDataSourceCommand } from "@aws-sdk/client-kinesis-analytics-v2"; // ES Modules import + * // const { KinesisAnalyticsV2Client, AddApplicationReferenceDataSourceCommand } = require("@aws-sdk/client-kinesis-analytics-v2"); // CommonJS import + * const client = new KinesisAnalyticsV2Client(config); + * const command = new AddApplicationReferenceDataSourceCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link AddApplicationReferenceDataSourceCommandInput} for command's `input` shape. + * @see {@link AddApplicationReferenceDataSourceCommandOutput} for command's `response` shape. + * @see {@link KinesisAnalyticsV2ClientResolvedConfig | config} for command's `input` shape. + * */ export class AddApplicationReferenceDataSourceCommand extends $Command< AddApplicationReferenceDataSourceCommandInput, diff --git a/clients/client-kinesis-analytics-v2/commands/AddApplicationVpcConfigurationCommand.ts b/clients/client-kinesis-analytics-v2/commands/AddApplicationVpcConfigurationCommand.ts index 6d57d8dbaea1..f93edaf618e8 100644 --- a/clients/client-kinesis-analytics-v2/commands/AddApplicationVpcConfigurationCommand.ts +++ b/clients/client-kinesis-analytics-v2/commands/AddApplicationVpcConfigurationCommand.ts @@ -39,6 +39,20 @@ export interface AddApplicationVpcConfigurationCommandOutput * Internet directly. To enable Internet access to the application, add an Internet gateway to your VPC.

* * + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { KinesisAnalyticsV2Client, AddApplicationVpcConfigurationCommand } from "@aws-sdk/client-kinesis-analytics-v2"; // ES Modules import + * // const { KinesisAnalyticsV2Client, AddApplicationVpcConfigurationCommand } = require("@aws-sdk/client-kinesis-analytics-v2"); // CommonJS import + * const client = new KinesisAnalyticsV2Client(config); + * const command = new AddApplicationVpcConfigurationCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link AddApplicationVpcConfigurationCommandInput} for command's `input` shape. + * @see {@link AddApplicationVpcConfigurationCommandOutput} for command's `response` shape. + * @see {@link KinesisAnalyticsV2ClientResolvedConfig | config} for command's `input` shape. + * */ export class AddApplicationVpcConfigurationCommand extends $Command< AddApplicationVpcConfigurationCommandInput, diff --git a/clients/client-kinesis-analytics-v2/commands/CreateApplicationCommand.ts b/clients/client-kinesis-analytics-v2/commands/CreateApplicationCommand.ts index 057a1e976e7c..097802b6f807 100644 --- a/clients/client-kinesis-analytics-v2/commands/CreateApplicationCommand.ts +++ b/clients/client-kinesis-analytics-v2/commands/CreateApplicationCommand.ts @@ -28,6 +28,20 @@ export interface CreateApplicationCommandOutput extends CreateApplicationRespons *

Creates a Kinesis Data Analytics application. For information about creating a * Kinesis Data Analytics application, see Creating an * Application.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { KinesisAnalyticsV2Client, CreateApplicationCommand } from "@aws-sdk/client-kinesis-analytics-v2"; // ES Modules import + * // const { KinesisAnalyticsV2Client, CreateApplicationCommand } = require("@aws-sdk/client-kinesis-analytics-v2"); // CommonJS import + * const client = new KinesisAnalyticsV2Client(config); + * const command = new CreateApplicationCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreateApplicationCommandInput} for command's `input` shape. + * @see {@link CreateApplicationCommandOutput} for command's `response` shape. + * @see {@link KinesisAnalyticsV2ClientResolvedConfig | config} for command's `input` shape. + * */ export class CreateApplicationCommand extends $Command< CreateApplicationCommandInput, diff --git a/clients/client-kinesis-analytics-v2/commands/CreateApplicationPresignedUrlCommand.ts b/clients/client-kinesis-analytics-v2/commands/CreateApplicationPresignedUrlCommand.ts index e73b1939e19d..1c01bdbbd0e8 100644 --- a/clients/client-kinesis-analytics-v2/commands/CreateApplicationPresignedUrlCommand.ts +++ b/clients/client-kinesis-analytics-v2/commands/CreateApplicationPresignedUrlCommand.ts @@ -41,6 +41,20 @@ export interface CreateApplicationPresignedUrlCommandOutput * 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.

* + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { KinesisAnalyticsV2Client, CreateApplicationPresignedUrlCommand } from "@aws-sdk/client-kinesis-analytics-v2"; // ES Modules import + * // const { KinesisAnalyticsV2Client, CreateApplicationPresignedUrlCommand } = require("@aws-sdk/client-kinesis-analytics-v2"); // CommonJS import + * const client = new KinesisAnalyticsV2Client(config); + * const command = new CreateApplicationPresignedUrlCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreateApplicationPresignedUrlCommandInput} for command's `input` shape. + * @see {@link CreateApplicationPresignedUrlCommandOutput} for command's `response` shape. + * @see {@link KinesisAnalyticsV2ClientResolvedConfig | config} for command's `input` shape. + * */ export class CreateApplicationPresignedUrlCommand extends $Command< CreateApplicationPresignedUrlCommandInput, diff --git a/clients/client-kinesis-analytics-v2/commands/CreateApplicationSnapshotCommand.ts b/clients/client-kinesis-analytics-v2/commands/CreateApplicationSnapshotCommand.ts index 5a629c4963fa..56703866e4f2 100644 --- a/clients/client-kinesis-analytics-v2/commands/CreateApplicationSnapshotCommand.ts +++ b/clients/client-kinesis-analytics-v2/commands/CreateApplicationSnapshotCommand.ts @@ -26,6 +26,20 @@ export interface CreateApplicationSnapshotCommandOutput extends CreateApplicatio /** *

Creates a snapshot of the application's state data.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { KinesisAnalyticsV2Client, CreateApplicationSnapshotCommand } from "@aws-sdk/client-kinesis-analytics-v2"; // ES Modules import + * // const { KinesisAnalyticsV2Client, CreateApplicationSnapshotCommand } = require("@aws-sdk/client-kinesis-analytics-v2"); // CommonJS import + * const client = new KinesisAnalyticsV2Client(config); + * const command = new CreateApplicationSnapshotCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreateApplicationSnapshotCommandInput} for command's `input` shape. + * @see {@link CreateApplicationSnapshotCommandOutput} for command's `response` shape. + * @see {@link KinesisAnalyticsV2ClientResolvedConfig | config} for command's `input` shape. + * */ export class CreateApplicationSnapshotCommand extends $Command< CreateApplicationSnapshotCommandInput, diff --git a/clients/client-kinesis-analytics-v2/commands/DeleteApplicationCloudWatchLoggingOptionCommand.ts b/clients/client-kinesis-analytics-v2/commands/DeleteApplicationCloudWatchLoggingOptionCommand.ts index f8eb59460df2..ac285258167c 100644 --- a/clients/client-kinesis-analytics-v2/commands/DeleteApplicationCloudWatchLoggingOptionCommand.ts +++ b/clients/client-kinesis-analytics-v2/commands/DeleteApplicationCloudWatchLoggingOptionCommand.ts @@ -32,6 +32,20 @@ export interface DeleteApplicationCloudWatchLoggingOptionCommandOutput /** *

Deletes an Amazon CloudWatch log stream from an Kinesis Data Analytics application.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { KinesisAnalyticsV2Client, DeleteApplicationCloudWatchLoggingOptionCommand } from "@aws-sdk/client-kinesis-analytics-v2"; // ES Modules import + * // const { KinesisAnalyticsV2Client, DeleteApplicationCloudWatchLoggingOptionCommand } = require("@aws-sdk/client-kinesis-analytics-v2"); // CommonJS import + * const client = new KinesisAnalyticsV2Client(config); + * const command = new DeleteApplicationCloudWatchLoggingOptionCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteApplicationCloudWatchLoggingOptionCommandInput} for command's `input` shape. + * @see {@link DeleteApplicationCloudWatchLoggingOptionCommandOutput} for command's `response` shape. + * @see {@link KinesisAnalyticsV2ClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteApplicationCloudWatchLoggingOptionCommand extends $Command< DeleteApplicationCloudWatchLoggingOptionCommandInput, diff --git a/clients/client-kinesis-analytics-v2/commands/DeleteApplicationCommand.ts b/clients/client-kinesis-analytics-v2/commands/DeleteApplicationCommand.ts index 27bf958799fc..aedb428fac43 100644 --- a/clients/client-kinesis-analytics-v2/commands/DeleteApplicationCommand.ts +++ b/clients/client-kinesis-analytics-v2/commands/DeleteApplicationCommand.ts @@ -26,6 +26,20 @@ export interface DeleteApplicationCommandOutput extends DeleteApplicationRespons /** *

Deletes the specified application. Kinesis Data Analytics halts application execution and deletes the application.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { KinesisAnalyticsV2Client, DeleteApplicationCommand } from "@aws-sdk/client-kinesis-analytics-v2"; // ES Modules import + * // const { KinesisAnalyticsV2Client, DeleteApplicationCommand } = require("@aws-sdk/client-kinesis-analytics-v2"); // CommonJS import + * const client = new KinesisAnalyticsV2Client(config); + * const command = new DeleteApplicationCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteApplicationCommandInput} for command's `input` shape. + * @see {@link DeleteApplicationCommandOutput} for command's `response` shape. + * @see {@link KinesisAnalyticsV2ClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteApplicationCommand extends $Command< DeleteApplicationCommandInput, diff --git a/clients/client-kinesis-analytics-v2/commands/DeleteApplicationInputProcessingConfigurationCommand.ts b/clients/client-kinesis-analytics-v2/commands/DeleteApplicationInputProcessingConfigurationCommand.ts index 249f575b458f..a2aaaf5f6111 100644 --- a/clients/client-kinesis-analytics-v2/commands/DeleteApplicationInputProcessingConfigurationCommand.ts +++ b/clients/client-kinesis-analytics-v2/commands/DeleteApplicationInputProcessingConfigurationCommand.ts @@ -32,6 +32,20 @@ export interface DeleteApplicationInputProcessingConfigurationCommandOutput /** *

Deletes an InputProcessingConfiguration from an input.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { KinesisAnalyticsV2Client, DeleteApplicationInputProcessingConfigurationCommand } from "@aws-sdk/client-kinesis-analytics-v2"; // ES Modules import + * // const { KinesisAnalyticsV2Client, DeleteApplicationInputProcessingConfigurationCommand } = require("@aws-sdk/client-kinesis-analytics-v2"); // CommonJS import + * const client = new KinesisAnalyticsV2Client(config); + * const command = new DeleteApplicationInputProcessingConfigurationCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteApplicationInputProcessingConfigurationCommandInput} for command's `input` shape. + * @see {@link DeleteApplicationInputProcessingConfigurationCommandOutput} for command's `response` shape. + * @see {@link KinesisAnalyticsV2ClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteApplicationInputProcessingConfigurationCommand extends $Command< DeleteApplicationInputProcessingConfigurationCommandInput, diff --git a/clients/client-kinesis-analytics-v2/commands/DeleteApplicationOutputCommand.ts b/clients/client-kinesis-analytics-v2/commands/DeleteApplicationOutputCommand.ts index deb5c7ce6f7c..3219e2f0959d 100644 --- a/clients/client-kinesis-analytics-v2/commands/DeleteApplicationOutputCommand.ts +++ b/clients/client-kinesis-analytics-v2/commands/DeleteApplicationOutputCommand.ts @@ -28,6 +28,20 @@ export interface DeleteApplicationOutputCommandOutput extends DeleteApplicationO *

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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { KinesisAnalyticsV2Client, DeleteApplicationOutputCommand } from "@aws-sdk/client-kinesis-analytics-v2"; // ES Modules import + * // const { KinesisAnalyticsV2Client, DeleteApplicationOutputCommand } = require("@aws-sdk/client-kinesis-analytics-v2"); // CommonJS import + * const client = new KinesisAnalyticsV2Client(config); + * const command = new DeleteApplicationOutputCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteApplicationOutputCommandInput} for command's `input` shape. + * @see {@link DeleteApplicationOutputCommandOutput} for command's `response` shape. + * @see {@link KinesisAnalyticsV2ClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteApplicationOutputCommand extends $Command< DeleteApplicationOutputCommandInput, diff --git a/clients/client-kinesis-analytics-v2/commands/DeleteApplicationReferenceDataSourceCommand.ts b/clients/client-kinesis-analytics-v2/commands/DeleteApplicationReferenceDataSourceCommand.ts index ae3857d0f84d..92b7e3e5ab60 100644 --- a/clients/client-kinesis-analytics-v2/commands/DeleteApplicationReferenceDataSourceCommand.ts +++ b/clients/client-kinesis-analytics-v2/commands/DeleteApplicationReferenceDataSourceCommand.ts @@ -33,6 +33,20 @@ export interface DeleteApplicationReferenceDataSourceCommandOutput *

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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { KinesisAnalyticsV2Client, DeleteApplicationReferenceDataSourceCommand } from "@aws-sdk/client-kinesis-analytics-v2"; // ES Modules import + * // const { KinesisAnalyticsV2Client, DeleteApplicationReferenceDataSourceCommand } = require("@aws-sdk/client-kinesis-analytics-v2"); // CommonJS import + * const client = new KinesisAnalyticsV2Client(config); + * const command = new DeleteApplicationReferenceDataSourceCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteApplicationReferenceDataSourceCommandInput} for command's `input` shape. + * @see {@link DeleteApplicationReferenceDataSourceCommandOutput} for command's `response` shape. + * @see {@link KinesisAnalyticsV2ClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteApplicationReferenceDataSourceCommand extends $Command< DeleteApplicationReferenceDataSourceCommandInput, diff --git a/clients/client-kinesis-analytics-v2/commands/DeleteApplicationSnapshotCommand.ts b/clients/client-kinesis-analytics-v2/commands/DeleteApplicationSnapshotCommand.ts index 71fab54643a5..5c1736986bce 100644 --- a/clients/client-kinesis-analytics-v2/commands/DeleteApplicationSnapshotCommand.ts +++ b/clients/client-kinesis-analytics-v2/commands/DeleteApplicationSnapshotCommand.ts @@ -26,6 +26,20 @@ export interface DeleteApplicationSnapshotCommandOutput extends DeleteApplicatio /** *

Deletes a snapshot of application state.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { KinesisAnalyticsV2Client, DeleteApplicationSnapshotCommand } from "@aws-sdk/client-kinesis-analytics-v2"; // ES Modules import + * // const { KinesisAnalyticsV2Client, DeleteApplicationSnapshotCommand } = require("@aws-sdk/client-kinesis-analytics-v2"); // CommonJS import + * const client = new KinesisAnalyticsV2Client(config); + * const command = new DeleteApplicationSnapshotCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteApplicationSnapshotCommandInput} for command's `input` shape. + * @see {@link DeleteApplicationSnapshotCommandOutput} for command's `response` shape. + * @see {@link KinesisAnalyticsV2ClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteApplicationSnapshotCommand extends $Command< DeleteApplicationSnapshotCommandInput, diff --git a/clients/client-kinesis-analytics-v2/commands/DeleteApplicationVpcConfigurationCommand.ts b/clients/client-kinesis-analytics-v2/commands/DeleteApplicationVpcConfigurationCommand.ts index 65e680286758..8fbd91bec37e 100644 --- a/clients/client-kinesis-analytics-v2/commands/DeleteApplicationVpcConfigurationCommand.ts +++ b/clients/client-kinesis-analytics-v2/commands/DeleteApplicationVpcConfigurationCommand.ts @@ -31,6 +31,20 @@ export interface DeleteApplicationVpcConfigurationCommandOutput /** *

Removes a VPC configuration from a Kinesis Data Analytics application.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { KinesisAnalyticsV2Client, DeleteApplicationVpcConfigurationCommand } from "@aws-sdk/client-kinesis-analytics-v2"; // ES Modules import + * // const { KinesisAnalyticsV2Client, DeleteApplicationVpcConfigurationCommand } = require("@aws-sdk/client-kinesis-analytics-v2"); // CommonJS import + * const client = new KinesisAnalyticsV2Client(config); + * const command = new DeleteApplicationVpcConfigurationCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteApplicationVpcConfigurationCommandInput} for command's `input` shape. + * @see {@link DeleteApplicationVpcConfigurationCommandOutput} for command's `response` shape. + * @see {@link KinesisAnalyticsV2ClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteApplicationVpcConfigurationCommand extends $Command< DeleteApplicationVpcConfigurationCommandInput, diff --git a/clients/client-kinesis-analytics-v2/commands/DescribeApplicationCommand.ts b/clients/client-kinesis-analytics-v2/commands/DescribeApplicationCommand.ts index 771707e6cf34..bd1bc0ab43e4 100644 --- a/clients/client-kinesis-analytics-v2/commands/DescribeApplicationCommand.ts +++ b/clients/client-kinesis-analytics-v2/commands/DescribeApplicationCommand.ts @@ -28,6 +28,20 @@ export interface DescribeApplicationCommandOutput extends DescribeApplicationRes *

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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { KinesisAnalyticsV2Client, DescribeApplicationCommand } from "@aws-sdk/client-kinesis-analytics-v2"; // ES Modules import + * // const { KinesisAnalyticsV2Client, DescribeApplicationCommand } = require("@aws-sdk/client-kinesis-analytics-v2"); // CommonJS import + * const client = new KinesisAnalyticsV2Client(config); + * const command = new DescribeApplicationCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeApplicationCommandInput} for command's `input` shape. + * @see {@link DescribeApplicationCommandOutput} for command's `response` shape. + * @see {@link KinesisAnalyticsV2ClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeApplicationCommand extends $Command< DescribeApplicationCommandInput, diff --git a/clients/client-kinesis-analytics-v2/commands/DescribeApplicationSnapshotCommand.ts b/clients/client-kinesis-analytics-v2/commands/DescribeApplicationSnapshotCommand.ts index 00ff9017e18a..c8300fb9d386 100644 --- a/clients/client-kinesis-analytics-v2/commands/DescribeApplicationSnapshotCommand.ts +++ b/clients/client-kinesis-analytics-v2/commands/DescribeApplicationSnapshotCommand.ts @@ -28,6 +28,20 @@ export interface DescribeApplicationSnapshotCommandOutput /** *

Returns information about a snapshot of application state data.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { KinesisAnalyticsV2Client, DescribeApplicationSnapshotCommand } from "@aws-sdk/client-kinesis-analytics-v2"; // ES Modules import + * // const { KinesisAnalyticsV2Client, DescribeApplicationSnapshotCommand } = require("@aws-sdk/client-kinesis-analytics-v2"); // CommonJS import + * const client = new KinesisAnalyticsV2Client(config); + * const command = new DescribeApplicationSnapshotCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeApplicationSnapshotCommandInput} for command's `input` shape. + * @see {@link DescribeApplicationSnapshotCommandOutput} for command's `response` shape. + * @see {@link KinesisAnalyticsV2ClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeApplicationSnapshotCommand extends $Command< DescribeApplicationSnapshotCommandInput, diff --git a/clients/client-kinesis-analytics-v2/commands/DiscoverInputSchemaCommand.ts b/clients/client-kinesis-analytics-v2/commands/DiscoverInputSchemaCommand.ts index ecb6783dd801..46096ec3508c 100644 --- a/clients/client-kinesis-analytics-v2/commands/DiscoverInputSchemaCommand.ts +++ b/clients/client-kinesis-analytics-v2/commands/DiscoverInputSchemaCommand.ts @@ -32,6 +32,20 @@ export interface DiscoverInputSchemaCommandOutput extends DiscoverInputSchemaRes *

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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { KinesisAnalyticsV2Client, DiscoverInputSchemaCommand } from "@aws-sdk/client-kinesis-analytics-v2"; // ES Modules import + * // const { KinesisAnalyticsV2Client, DiscoverInputSchemaCommand } = require("@aws-sdk/client-kinesis-analytics-v2"); // CommonJS import + * const client = new KinesisAnalyticsV2Client(config); + * const command = new DiscoverInputSchemaCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DiscoverInputSchemaCommandInput} for command's `input` shape. + * @see {@link DiscoverInputSchemaCommandOutput} for command's `response` shape. + * @see {@link KinesisAnalyticsV2ClientResolvedConfig | config} for command's `input` shape. + * */ export class DiscoverInputSchemaCommand extends $Command< DiscoverInputSchemaCommandInput, diff --git a/clients/client-kinesis-analytics-v2/commands/ListApplicationSnapshotsCommand.ts b/clients/client-kinesis-analytics-v2/commands/ListApplicationSnapshotsCommand.ts index b0310e0c5bb5..ac4e5a556cb3 100644 --- a/clients/client-kinesis-analytics-v2/commands/ListApplicationSnapshotsCommand.ts +++ b/clients/client-kinesis-analytics-v2/commands/ListApplicationSnapshotsCommand.ts @@ -26,6 +26,20 @@ export interface ListApplicationSnapshotsCommandOutput extends ListApplicationSn /** *

Lists information about the current application snapshots.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { KinesisAnalyticsV2Client, ListApplicationSnapshotsCommand } from "@aws-sdk/client-kinesis-analytics-v2"; // ES Modules import + * // const { KinesisAnalyticsV2Client, ListApplicationSnapshotsCommand } = require("@aws-sdk/client-kinesis-analytics-v2"); // CommonJS import + * const client = new KinesisAnalyticsV2Client(config); + * const command = new ListApplicationSnapshotsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListApplicationSnapshotsCommandInput} for command's `input` shape. + * @see {@link ListApplicationSnapshotsCommandOutput} for command's `response` shape. + * @see {@link KinesisAnalyticsV2ClientResolvedConfig | config} for command's `input` shape. + * */ export class ListApplicationSnapshotsCommand extends $Command< ListApplicationSnapshotsCommandInput, diff --git a/clients/client-kinesis-analytics-v2/commands/ListApplicationsCommand.ts b/clients/client-kinesis-analytics-v2/commands/ListApplicationsCommand.ts index 0d8ea0a82622..690eb1903603 100644 --- a/clients/client-kinesis-analytics-v2/commands/ListApplicationsCommand.ts +++ b/clients/client-kinesis-analytics-v2/commands/ListApplicationsCommand.ts @@ -30,6 +30,20 @@ export interface ListApplicationsCommandOutput extends ListApplicationsResponse, * status.

*

If you want detailed information about a specific application, use * DescribeApplication.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { KinesisAnalyticsV2Client, ListApplicationsCommand } from "@aws-sdk/client-kinesis-analytics-v2"; // ES Modules import + * // const { KinesisAnalyticsV2Client, ListApplicationsCommand } = require("@aws-sdk/client-kinesis-analytics-v2"); // CommonJS import + * const client = new KinesisAnalyticsV2Client(config); + * const command = new ListApplicationsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListApplicationsCommandInput} for command's `input` shape. + * @see {@link ListApplicationsCommandOutput} for command's `response` shape. + * @see {@link KinesisAnalyticsV2ClientResolvedConfig | config} for command's `input` shape. + * */ export class ListApplicationsCommand extends $Command< ListApplicationsCommandInput, diff --git a/clients/client-kinesis-analytics-v2/commands/ListTagsForResourceCommand.ts b/clients/client-kinesis-analytics-v2/commands/ListTagsForResourceCommand.ts index 0e3c40fdd3cb..e46d8195d1b7 100644 --- a/clients/client-kinesis-analytics-v2/commands/ListTagsForResourceCommand.ts +++ b/clients/client-kinesis-analytics-v2/commands/ListTagsForResourceCommand.ts @@ -27,6 +27,20 @@ export interface ListTagsForResourceCommandOutput extends ListTagsForResourceRes /** *

Retrieves the list of key-value tags assigned to the application. For more information, see * Using Tagging.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { KinesisAnalyticsV2Client, ListTagsForResourceCommand } from "@aws-sdk/client-kinesis-analytics-v2"; // ES Modules import + * // const { KinesisAnalyticsV2Client, ListTagsForResourceCommand } = require("@aws-sdk/client-kinesis-analytics-v2"); // CommonJS import + * const client = new KinesisAnalyticsV2Client(config); + * const command = new ListTagsForResourceCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListTagsForResourceCommandInput} for command's `input` shape. + * @see {@link ListTagsForResourceCommandOutput} for command's `response` shape. + * @see {@link KinesisAnalyticsV2ClientResolvedConfig | config} for command's `input` shape. + * */ export class ListTagsForResourceCommand extends $Command< ListTagsForResourceCommandInput, diff --git a/clients/client-kinesis-analytics-v2/commands/StartApplicationCommand.ts b/clients/client-kinesis-analytics-v2/commands/StartApplicationCommand.ts index 99a9f90c6b20..17f7380d82db 100644 --- a/clients/client-kinesis-analytics-v2/commands/StartApplicationCommand.ts +++ b/clients/client-kinesis-analytics-v2/commands/StartApplicationCommand.ts @@ -27,6 +27,20 @@ export interface StartApplicationCommandOutput extends StartApplicationResponse, /** *

Starts the specified Kinesis Data Analytics application. After creating an application, you must exclusively call this operation to * start your application.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { KinesisAnalyticsV2Client, StartApplicationCommand } from "@aws-sdk/client-kinesis-analytics-v2"; // ES Modules import + * // const { KinesisAnalyticsV2Client, StartApplicationCommand } = require("@aws-sdk/client-kinesis-analytics-v2"); // CommonJS import + * const client = new KinesisAnalyticsV2Client(config); + * const command = new StartApplicationCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link StartApplicationCommandInput} for command's `input` shape. + * @see {@link StartApplicationCommandOutput} for command's `response` shape. + * @see {@link KinesisAnalyticsV2ClientResolvedConfig | config} for command's `input` shape. + * */ export class StartApplicationCommand extends $Command< StartApplicationCommandInput, diff --git a/clients/client-kinesis-analytics-v2/commands/StopApplicationCommand.ts b/clients/client-kinesis-analytics-v2/commands/StopApplicationCommand.ts index dfcd1c18617d..bd213d66c464 100644 --- a/clients/client-kinesis-analytics-v2/commands/StopApplicationCommand.ts +++ b/clients/client-kinesis-analytics-v2/commands/StopApplicationCommand.ts @@ -32,6 +32,20 @@ export interface StopApplicationCommandOutput extends StopApplicationResponse, _ *

*

Kinesis Data Analytics takes a snapshot when the application is stopped, unless Force is set * to true.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { KinesisAnalyticsV2Client, StopApplicationCommand } from "@aws-sdk/client-kinesis-analytics-v2"; // ES Modules import + * // const { KinesisAnalyticsV2Client, StopApplicationCommand } = require("@aws-sdk/client-kinesis-analytics-v2"); // CommonJS import + * const client = new KinesisAnalyticsV2Client(config); + * const command = new StopApplicationCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link StopApplicationCommandInput} for command's `input` shape. + * @see {@link StopApplicationCommandOutput} for command's `response` shape. + * @see {@link KinesisAnalyticsV2ClientResolvedConfig | config} for command's `input` shape. + * */ export class StopApplicationCommand extends $Command< StopApplicationCommandInput, diff --git a/clients/client-kinesis-analytics-v2/commands/TagResourceCommand.ts b/clients/client-kinesis-analytics-v2/commands/TagResourceCommand.ts index 941a5d2432b9..ffd98c332b26 100644 --- a/clients/client-kinesis-analytics-v2/commands/TagResourceCommand.ts +++ b/clients/client-kinesis-analytics-v2/commands/TagResourceCommand.ts @@ -28,6 +28,20 @@ export interface TagResourceCommandOutput extends TagResourceResponse, __Metadat *

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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { KinesisAnalyticsV2Client, TagResourceCommand } from "@aws-sdk/client-kinesis-analytics-v2"; // ES Modules import + * // const { KinesisAnalyticsV2Client, TagResourceCommand } = require("@aws-sdk/client-kinesis-analytics-v2"); // CommonJS import + * const client = new KinesisAnalyticsV2Client(config); + * const command = new TagResourceCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link TagResourceCommandInput} for command's `input` shape. + * @see {@link TagResourceCommandOutput} for command's `response` shape. + * @see {@link KinesisAnalyticsV2ClientResolvedConfig | config} for command's `input` shape. + * */ export class TagResourceCommand extends $Command< TagResourceCommandInput, diff --git a/clients/client-kinesis-analytics-v2/commands/UntagResourceCommand.ts b/clients/client-kinesis-analytics-v2/commands/UntagResourceCommand.ts index 9ef68da8a5b5..37fa77ac968f 100644 --- a/clients/client-kinesis-analytics-v2/commands/UntagResourceCommand.ts +++ b/clients/client-kinesis-analytics-v2/commands/UntagResourceCommand.ts @@ -27,6 +27,20 @@ export interface UntagResourceCommandOutput extends UntagResourceResponse, __Met /** *

Removes one or more tags from a Kinesis Data Analytics application. For more information, see * Using Tagging.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { KinesisAnalyticsV2Client, UntagResourceCommand } from "@aws-sdk/client-kinesis-analytics-v2"; // ES Modules import + * // const { KinesisAnalyticsV2Client, UntagResourceCommand } = require("@aws-sdk/client-kinesis-analytics-v2"); // CommonJS import + * const client = new KinesisAnalyticsV2Client(config); + * const command = new UntagResourceCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link UntagResourceCommandInput} for command's `input` shape. + * @see {@link UntagResourceCommandOutput} for command's `response` shape. + * @see {@link KinesisAnalyticsV2ClientResolvedConfig | config} for command's `input` shape. + * */ export class UntagResourceCommand extends $Command< UntagResourceCommandInput, diff --git a/clients/client-kinesis-analytics-v2/commands/UpdateApplicationCommand.ts b/clients/client-kinesis-analytics-v2/commands/UpdateApplicationCommand.ts index dd73870588c2..fa71e4da90c8 100644 --- a/clients/client-kinesis-analytics-v2/commands/UpdateApplicationCommand.ts +++ b/clients/client-kinesis-analytics-v2/commands/UpdateApplicationCommand.ts @@ -34,6 +34,20 @@ export interface UpdateApplicationCommandOutput extends UpdateApplicationRespons * need to update an application's RuntimeEnvironment, you must delete the application * and create it again.

* + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { KinesisAnalyticsV2Client, UpdateApplicationCommand } from "@aws-sdk/client-kinesis-analytics-v2"; // ES Modules import + * // const { KinesisAnalyticsV2Client, UpdateApplicationCommand } = require("@aws-sdk/client-kinesis-analytics-v2"); // CommonJS import + * const client = new KinesisAnalyticsV2Client(config); + * const command = new UpdateApplicationCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link UpdateApplicationCommandInput} for command's `input` shape. + * @see {@link UpdateApplicationCommandOutput} for command's `response` shape. + * @see {@link KinesisAnalyticsV2ClientResolvedConfig | config} for command's `input` shape. + * */ export class UpdateApplicationCommand extends $Command< UpdateApplicationCommandInput, diff --git a/clients/client-kinesis-analytics-v2/commands/UpdateApplicationMaintenanceConfigurationCommand.ts b/clients/client-kinesis-analytics-v2/commands/UpdateApplicationMaintenanceConfigurationCommand.ts index 12fb6c7d0ca9..758b90a147c9 100644 --- a/clients/client-kinesis-analytics-v2/commands/UpdateApplicationMaintenanceConfigurationCommand.ts +++ b/clients/client-kinesis-analytics-v2/commands/UpdateApplicationMaintenanceConfigurationCommand.ts @@ -32,6 +32,20 @@ export interface UpdateApplicationMaintenanceConfigurationCommandOutput /** *

Updates the configuration for the automatic maintenance that Kinesis Data Analytics performs on the application. For information about automatic application maintenance, see Kinesis Data Analytics for Apache Flink Maintenance.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { KinesisAnalyticsV2Client, UpdateApplicationMaintenanceConfigurationCommand } from "@aws-sdk/client-kinesis-analytics-v2"; // ES Modules import + * // const { KinesisAnalyticsV2Client, UpdateApplicationMaintenanceConfigurationCommand } = require("@aws-sdk/client-kinesis-analytics-v2"); // CommonJS import + * const client = new KinesisAnalyticsV2Client(config); + * const command = new UpdateApplicationMaintenanceConfigurationCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link UpdateApplicationMaintenanceConfigurationCommandInput} for command's `input` shape. + * @see {@link UpdateApplicationMaintenanceConfigurationCommandOutput} for command's `response` shape. + * @see {@link KinesisAnalyticsV2ClientResolvedConfig | config} for command's `input` shape. + * */ export class UpdateApplicationMaintenanceConfigurationCommand extends $Command< UpdateApplicationMaintenanceConfigurationCommandInput, diff --git a/clients/client-kinesis-analytics-v2/models/models_0.ts b/clients/client-kinesis-analytics-v2/models/models_0.ts index 71221d5eaf33..d2578704b919 100644 --- a/clients/client-kinesis-analytics-v2/models/models_0.ts +++ b/clients/client-kinesis-analytics-v2/models/models_0.ts @@ -13,6 +13,9 @@ export interface CloudWatchLoggingOption { } export namespace CloudWatchLoggingOption { + /** + * @internal + */ export const filterSensitiveLog = (obj: CloudWatchLoggingOption): any => ({ ...obj, }); @@ -37,6 +40,9 @@ export interface AddApplicationCloudWatchLoggingOptionRequest { } export namespace AddApplicationCloudWatchLoggingOptionRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: AddApplicationCloudWatchLoggingOptionRequest): any => ({ ...obj, }); @@ -68,6 +74,9 @@ export interface CloudWatchLoggingOptionDescription { } export namespace CloudWatchLoggingOptionDescription { + /** + * @internal + */ export const filterSensitiveLog = (obj: CloudWatchLoggingOptionDescription): any => ({ ...obj, }); @@ -93,6 +102,9 @@ export interface AddApplicationCloudWatchLoggingOptionResponse { } export namespace AddApplicationCloudWatchLoggingOptionResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: AddApplicationCloudWatchLoggingOptionResponse): any => ({ ...obj, }); @@ -110,6 +122,9 @@ export interface ConcurrentModificationException extends __SmithyException, $Met } export namespace ConcurrentModificationException { + /** + * @internal + */ export const filterSensitiveLog = (obj: ConcurrentModificationException): any => ({ ...obj, }); @@ -125,6 +140,9 @@ export interface InvalidApplicationConfigurationException extends __SmithyExcept } export namespace InvalidApplicationConfigurationException { + /** + * @internal + */ export const filterSensitiveLog = (obj: InvalidApplicationConfigurationException): any => ({ ...obj, }); @@ -140,6 +158,9 @@ export interface InvalidArgumentException extends __SmithyException, $MetadataBe } export namespace InvalidArgumentException { + /** + * @internal + */ export const filterSensitiveLog = (obj: InvalidArgumentException): any => ({ ...obj, }); @@ -155,6 +176,9 @@ export interface InvalidRequestException extends __SmithyException, $MetadataBea } export namespace InvalidRequestException { + /** + * @internal + */ export const filterSensitiveLog = (obj: InvalidRequestException): any => ({ ...obj, }); @@ -170,6 +194,9 @@ export interface ResourceInUseException extends __SmithyException, $MetadataBear } export namespace ResourceInUseException { + /** + * @internal + */ export const filterSensitiveLog = (obj: ResourceInUseException): any => ({ ...obj, }); @@ -185,6 +212,9 @@ export interface ResourceNotFoundException extends __SmithyException, $MetadataB } export namespace ResourceNotFoundException { + /** + * @internal + */ export const filterSensitiveLog = (obj: ResourceNotFoundException): any => ({ ...obj, }); @@ -202,6 +232,9 @@ export interface InputParallelism { } export namespace InputParallelism { + /** + * @internal + */ export const filterSensitiveLog = (obj: InputParallelism): any => ({ ...obj, }); @@ -223,6 +256,9 @@ export interface InputLambdaProcessor { } export namespace InputLambdaProcessor { + /** + * @internal + */ export const filterSensitiveLog = (obj: InputLambdaProcessor): any => ({ ...obj, }); @@ -242,6 +278,9 @@ export interface InputProcessingConfiguration { } export namespace InputProcessingConfiguration { + /** + * @internal + */ export const filterSensitiveLog = (obj: InputProcessingConfiguration): any => ({ ...obj, }); @@ -273,6 +312,9 @@ export interface RecordColumn { } export namespace RecordColumn { + /** + * @internal + */ export const filterSensitiveLog = (obj: RecordColumn): any => ({ ...obj, }); @@ -306,6 +348,9 @@ export interface CSVMappingParameters { } export namespace CSVMappingParameters { + /** + * @internal + */ export const filterSensitiveLog = (obj: CSVMappingParameters): any => ({ ...obj, }); @@ -323,6 +368,9 @@ export interface JSONMappingParameters { } export namespace JSONMappingParameters { + /** + * @internal + */ export const filterSensitiveLog = (obj: JSONMappingParameters): any => ({ ...obj, }); @@ -348,6 +396,9 @@ export interface MappingParameters { } export namespace MappingParameters { + /** + * @internal + */ export const filterSensitiveLog = (obj: MappingParameters): any => ({ ...obj, }); @@ -378,6 +429,9 @@ export interface RecordFormat { } export namespace RecordFormat { + /** + * @internal + */ export const filterSensitiveLog = (obj: RecordFormat): any => ({ ...obj, }); @@ -406,6 +460,9 @@ export interface SourceSchema { } export namespace SourceSchema { + /** + * @internal + */ export const filterSensitiveLog = (obj: SourceSchema): any => ({ ...obj, }); @@ -424,6 +481,9 @@ export interface KinesisFirehoseInput { } export namespace KinesisFirehoseInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: KinesisFirehoseInput): any => ({ ...obj, }); @@ -441,6 +501,9 @@ export interface KinesisStreamsInput { } export namespace KinesisStreamsInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: KinesisStreamsInput): any => ({ ...obj, }); @@ -492,6 +555,9 @@ export interface Input { } export namespace Input { + /** + * @internal + */ export const filterSensitiveLog = (obj: Input): any => ({ ...obj, }); @@ -516,6 +582,9 @@ export interface AddApplicationInputRequest { } export namespace AddApplicationInputRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: AddApplicationInputRequest): any => ({ ...obj, }); @@ -549,6 +618,9 @@ export interface InputLambdaProcessorDescription { } export namespace InputLambdaProcessorDescription { + /** + * @internal + */ export const filterSensitiveLog = (obj: InputLambdaProcessorDescription): any => ({ ...obj, }); @@ -567,6 +639,9 @@ export interface InputProcessingConfigurationDescription { } export namespace InputProcessingConfigurationDescription { + /** + * @internal + */ export const filterSensitiveLog = (obj: InputProcessingConfigurationDescription): any => ({ ...obj, }); @@ -609,6 +684,9 @@ export interface InputStartingPositionConfiguration { } export namespace InputStartingPositionConfiguration { + /** + * @internal + */ export const filterSensitiveLog = (obj: InputStartingPositionConfiguration): any => ({ ...obj, }); @@ -636,6 +714,9 @@ export interface KinesisFirehoseInputDescription { } export namespace KinesisFirehoseInputDescription { + /** + * @internal + */ export const filterSensitiveLog = (obj: KinesisFirehoseInputDescription): any => ({ ...obj, }); @@ -664,6 +745,9 @@ export interface KinesisStreamsInputDescription { } export namespace KinesisStreamsInputDescription { + /** + * @internal + */ export const filterSensitiveLog = (obj: KinesisStreamsInputDescription): any => ({ ...obj, }); @@ -723,6 +807,9 @@ export interface InputDescription { } export namespace InputDescription { + /** + * @internal + */ export const filterSensitiveLog = (obj: InputDescription): any => ({ ...obj, }); @@ -749,6 +836,9 @@ export interface AddApplicationInputResponse { } export namespace AddApplicationInputResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: AddApplicationInputResponse): any => ({ ...obj, }); @@ -765,6 +855,9 @@ export interface CodeValidationException extends __SmithyException, $MetadataBea } export namespace CodeValidationException { + /** + * @internal + */ export const filterSensitiveLog = (obj: CodeValidationException): any => ({ ...obj, }); @@ -798,6 +891,9 @@ export interface AddApplicationInputProcessingConfigurationRequest { } export namespace AddApplicationInputProcessingConfigurationRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: AddApplicationInputProcessingConfigurationRequest): any => ({ ...obj, }); @@ -828,6 +924,9 @@ export interface AddApplicationInputProcessingConfigurationResponse { } export namespace AddApplicationInputProcessingConfigurationResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: AddApplicationInputProcessingConfigurationResponse): any => ({ ...obj, }); @@ -844,6 +943,9 @@ export interface DestinationSchema { } export namespace DestinationSchema { + /** + * @internal + */ export const filterSensitiveLog = (obj: DestinationSchema): any => ({ ...obj, }); @@ -862,6 +964,9 @@ export interface KinesisFirehoseOutput { } export namespace KinesisFirehoseOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: KinesisFirehoseOutput): any => ({ ...obj, }); @@ -880,6 +985,9 @@ export interface KinesisStreamsOutput { } export namespace KinesisStreamsOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: KinesisStreamsOutput): any => ({ ...obj, }); @@ -902,6 +1010,9 @@ export interface LambdaOutput { } export namespace LambdaOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: LambdaOutput): any => ({ ...obj, }); @@ -945,6 +1056,9 @@ export interface Output { } export namespace Output { + /** + * @internal + */ export const filterSensitiveLog = (obj: Output): any => ({ ...obj, }); @@ -974,6 +1088,9 @@ export interface AddApplicationOutputRequest { } export namespace AddApplicationOutputRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: AddApplicationOutputRequest): any => ({ ...obj, }); @@ -1002,6 +1119,9 @@ export interface KinesisFirehoseOutputDescription { } export namespace KinesisFirehoseOutputDescription { + /** + * @internal + */ export const filterSensitiveLog = (obj: KinesisFirehoseOutputDescription): any => ({ ...obj, }); @@ -1030,6 +1150,9 @@ export interface KinesisStreamsOutputDescription { } export namespace KinesisStreamsOutputDescription { + /** + * @internal + */ export const filterSensitiveLog = (obj: KinesisStreamsOutputDescription): any => ({ ...obj, }); @@ -1058,6 +1181,9 @@ export interface LambdaOutputDescription { } export namespace LambdaOutputDescription { + /** + * @internal + */ export const filterSensitiveLog = (obj: LambdaOutputDescription): any => ({ ...obj, }); @@ -1105,6 +1231,9 @@ export interface OutputDescription { } export namespace OutputDescription { + /** + * @internal + */ export const filterSensitiveLog = (obj: OutputDescription): any => ({ ...obj, }); @@ -1133,6 +1262,9 @@ export interface AddApplicationOutputResponse { } export namespace AddApplicationOutputResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: AddApplicationOutputResponse): any => ({ ...obj, }); @@ -1158,6 +1290,9 @@ export interface S3ReferenceDataSource { } export namespace S3ReferenceDataSource { + /** + * @internal + */ export const filterSensitiveLog = (obj: S3ReferenceDataSource): any => ({ ...obj, }); @@ -1189,6 +1324,9 @@ export interface ReferenceDataSource { } export namespace ReferenceDataSource { + /** + * @internal + */ export const filterSensitiveLog = (obj: ReferenceDataSource): any => ({ ...obj, }); @@ -1218,6 +1356,9 @@ export interface AddApplicationReferenceDataSourceRequest { } export namespace AddApplicationReferenceDataSourceRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: AddApplicationReferenceDataSourceRequest): any => ({ ...obj, }); @@ -1251,6 +1392,9 @@ export interface S3ReferenceDataSourceDescription { } export namespace S3ReferenceDataSourceDescription { + /** + * @internal + */ export const filterSensitiveLog = (obj: S3ReferenceDataSourceDescription): any => ({ ...obj, }); @@ -1284,6 +1428,9 @@ export interface ReferenceDataSourceDescription { } export namespace ReferenceDataSourceDescription { + /** + * @internal + */ export const filterSensitiveLog = (obj: ReferenceDataSourceDescription): any => ({ ...obj, }); @@ -1312,6 +1459,9 @@ export interface AddApplicationReferenceDataSourceResponse { } export namespace AddApplicationReferenceDataSourceResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: AddApplicationReferenceDataSourceResponse): any => ({ ...obj, }); @@ -1335,6 +1485,9 @@ export interface VpcConfiguration { } export namespace VpcConfiguration { + /** + * @internal + */ export const filterSensitiveLog = (obj: VpcConfiguration): any => ({ ...obj, }); @@ -1361,6 +1514,9 @@ export interface AddApplicationVpcConfigurationRequest { } export namespace AddApplicationVpcConfigurationRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: AddApplicationVpcConfigurationRequest): any => ({ ...obj, }); @@ -1394,6 +1550,9 @@ export interface VpcConfigurationDescription { } export namespace VpcConfigurationDescription { + /** + * @internal + */ export const filterSensitiveLog = (obj: VpcConfigurationDescription): any => ({ ...obj, }); @@ -1417,6 +1576,9 @@ export interface AddApplicationVpcConfigurationResponse { } export namespace AddApplicationVpcConfigurationResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: AddApplicationVpcConfigurationResponse): any => ({ ...obj, }); @@ -1446,6 +1608,9 @@ export interface S3ContentLocation { } export namespace S3ContentLocation { + /** + * @internal + */ export const filterSensitiveLog = (obj: S3ContentLocation): any => ({ ...obj, }); @@ -1473,6 +1638,9 @@ export interface CodeContent { } export namespace CodeContent { + /** + * @internal + */ export const filterSensitiveLog = (obj: CodeContent): any => ({ ...obj, }); @@ -1499,6 +1667,9 @@ export interface ApplicationCodeConfiguration { } export namespace ApplicationCodeConfiguration { + /** + * @internal + */ export const filterSensitiveLog = (obj: ApplicationCodeConfiguration): any => ({ ...obj, }); @@ -1525,6 +1696,9 @@ export interface S3ApplicationCodeLocationDescription { } export namespace S3ApplicationCodeLocationDescription { + /** + * @internal + */ export const filterSensitiveLog = (obj: S3ApplicationCodeLocationDescription): any => ({ ...obj, }); @@ -1557,6 +1731,9 @@ export interface CodeContentDescription { } export namespace CodeContentDescription { + /** + * @internal + */ export const filterSensitiveLog = (obj: CodeContentDescription): any => ({ ...obj, }); @@ -1578,6 +1755,9 @@ export interface ApplicationCodeConfigurationDescription { } export namespace ApplicationCodeConfigurationDescription { + /** + * @internal + */ export const filterSensitiveLog = (obj: ApplicationCodeConfigurationDescription): any => ({ ...obj, }); @@ -1605,6 +1785,9 @@ export interface S3ContentLocationUpdate { } export namespace S3ContentLocationUpdate { + /** + * @internal + */ export const filterSensitiveLog = (obj: S3ContentLocationUpdate): any => ({ ...obj, }); @@ -1631,6 +1814,9 @@ export interface CodeContentUpdate { } export namespace CodeContentUpdate { + /** + * @internal + */ export const filterSensitiveLog = (obj: CodeContentUpdate): any => ({ ...obj, }); @@ -1652,6 +1838,9 @@ export interface ApplicationCodeConfigurationUpdate { } export namespace ApplicationCodeConfigurationUpdate { + /** + * @internal + */ export const filterSensitiveLog = (obj: ApplicationCodeConfigurationUpdate): any => ({ ...obj, }); @@ -1668,6 +1857,9 @@ export interface ApplicationSnapshotConfiguration { } export namespace ApplicationSnapshotConfiguration { + /** + * @internal + */ export const filterSensitiveLog = (obj: ApplicationSnapshotConfiguration): any => ({ ...obj, }); @@ -1689,6 +1881,9 @@ export interface PropertyGroup { } export namespace PropertyGroup { + /** + * @internal + */ export const filterSensitiveLog = (obj: PropertyGroup): any => ({ ...obj, }); @@ -1705,6 +1900,9 @@ export interface EnvironmentProperties { } export namespace EnvironmentProperties { + /** + * @internal + */ export const filterSensitiveLog = (obj: EnvironmentProperties): any => ({ ...obj, }); @@ -1785,6 +1983,9 @@ export interface CheckpointConfiguration { } export namespace CheckpointConfiguration { + /** + * @internal + */ export const filterSensitiveLog = (obj: CheckpointConfiguration): any => ({ ...obj, }); @@ -1829,6 +2030,9 @@ export interface MonitoringConfiguration { } export namespace MonitoringConfiguration { + /** + * @internal + */ export const filterSensitiveLog = (obj: MonitoringConfiguration): any => ({ ...obj, }); @@ -1872,6 +2076,9 @@ export interface ParallelismConfiguration { } export namespace ParallelismConfiguration { + /** + * @internal + */ export const filterSensitiveLog = (obj: ParallelismConfiguration): any => ({ ...obj, }); @@ -1904,6 +2111,9 @@ export interface FlinkApplicationConfiguration { } export namespace FlinkApplicationConfiguration { + /** + * @internal + */ export const filterSensitiveLog = (obj: FlinkApplicationConfiguration): any => ({ ...obj, }); @@ -1933,6 +2143,9 @@ export interface SqlApplicationConfiguration { } export namespace SqlApplicationConfiguration { + /** + * @internal + */ export const filterSensitiveLog = (obj: SqlApplicationConfiguration): any => ({ ...obj, }); @@ -1974,6 +2187,9 @@ export interface ApplicationConfiguration { } export namespace ApplicationConfiguration { + /** + * @internal + */ export const filterSensitiveLog = (obj: ApplicationConfiguration): any => ({ ...obj, }); @@ -1990,6 +2206,9 @@ export interface ApplicationSnapshotConfigurationDescription { } export namespace ApplicationSnapshotConfigurationDescription { + /** + * @internal + */ export const filterSensitiveLog = (obj: ApplicationSnapshotConfigurationDescription): any => ({ ...obj, }); @@ -2006,6 +2225,9 @@ export interface EnvironmentPropertyDescriptions { } export namespace EnvironmentPropertyDescriptions { + /** + * @internal + */ export const filterSensitiveLog = (obj: EnvironmentPropertyDescriptions): any => ({ ...obj, }); @@ -2072,6 +2294,9 @@ export interface CheckpointConfigurationDescription { } export namespace CheckpointConfigurationDescription { + /** + * @internal + */ export const filterSensitiveLog = (obj: CheckpointConfigurationDescription): any => ({ ...obj, }); @@ -2099,6 +2324,9 @@ export interface MonitoringConfigurationDescription { } export namespace MonitoringConfigurationDescription { + /** + * @internal + */ export const filterSensitiveLog = (obj: MonitoringConfigurationDescription): any => ({ ...obj, }); @@ -2145,6 +2373,9 @@ export interface ParallelismConfigurationDescription { } export namespace ParallelismConfigurationDescription { + /** + * @internal + */ export const filterSensitiveLog = (obj: ParallelismConfigurationDescription): any => ({ ...obj, }); @@ -2179,6 +2410,9 @@ export interface FlinkApplicationConfigurationDescription { } export namespace FlinkApplicationConfigurationDescription { + /** + * @internal + */ export const filterSensitiveLog = (obj: FlinkApplicationConfigurationDescription): any => ({ ...obj, }); @@ -2208,6 +2442,9 @@ export interface ApplicationRestoreConfiguration { } export namespace ApplicationRestoreConfiguration { + /** + * @internal + */ export const filterSensitiveLog = (obj: ApplicationRestoreConfiguration): any => ({ ...obj, }); @@ -2236,6 +2473,9 @@ export interface FlinkRunConfiguration { } export namespace FlinkRunConfiguration { + /** + * @internal + */ export const filterSensitiveLog = (obj: FlinkRunConfiguration): any => ({ ...obj, }); @@ -2257,6 +2497,9 @@ export interface RunConfigurationDescription { } export namespace RunConfigurationDescription { + /** + * @internal + */ export const filterSensitiveLog = (obj: RunConfigurationDescription): any => ({ ...obj, }); @@ -2286,6 +2529,9 @@ export interface SqlApplicationConfigurationDescription { } export namespace SqlApplicationConfigurationDescription { + /** + * @internal + */ export const filterSensitiveLog = (obj: SqlApplicationConfigurationDescription): any => ({ ...obj, }); @@ -2332,6 +2578,9 @@ export interface ApplicationConfigurationDescription { } export namespace ApplicationConfigurationDescription { + /** + * @internal + */ export const filterSensitiveLog = (obj: ApplicationConfigurationDescription): any => ({ ...obj, }); @@ -2348,6 +2597,9 @@ export interface ApplicationSnapshotConfigurationUpdate { } export namespace ApplicationSnapshotConfigurationUpdate { + /** + * @internal + */ export const filterSensitiveLog = (obj: ApplicationSnapshotConfigurationUpdate): any => ({ ...obj, }); @@ -2364,6 +2616,9 @@ export interface EnvironmentPropertyUpdates { } export namespace EnvironmentPropertyUpdates { + /** + * @internal + */ export const filterSensitiveLog = (obj: EnvironmentPropertyUpdates): any => ({ ...obj, }); @@ -2433,6 +2688,9 @@ export interface CheckpointConfigurationUpdate { } export namespace CheckpointConfigurationUpdate { + /** + * @internal + */ export const filterSensitiveLog = (obj: CheckpointConfigurationUpdate): any => ({ ...obj, }); @@ -2462,6 +2720,9 @@ export interface MonitoringConfigurationUpdate { } export namespace MonitoringConfigurationUpdate { + /** + * @internal + */ export const filterSensitiveLog = (obj: MonitoringConfigurationUpdate): any => ({ ...obj, }); @@ -2499,6 +2760,9 @@ export interface ParallelismConfigurationUpdate { } export namespace ParallelismConfigurationUpdate { + /** + * @internal + */ export const filterSensitiveLog = (obj: ParallelismConfigurationUpdate): any => ({ ...obj, }); @@ -2527,6 +2791,9 @@ export interface FlinkApplicationConfigurationUpdate { } export namespace FlinkApplicationConfigurationUpdate { + /** + * @internal + */ export const filterSensitiveLog = (obj: FlinkApplicationConfigurationUpdate): any => ({ ...obj, }); @@ -2544,6 +2811,9 @@ export interface InputParallelismUpdate { } export namespace InputParallelismUpdate { + /** + * @internal + */ export const filterSensitiveLog = (obj: InputParallelismUpdate): any => ({ ...obj, }); @@ -2567,6 +2837,9 @@ export interface InputLambdaProcessorUpdate { } export namespace InputLambdaProcessorUpdate { + /** + * @internal + */ export const filterSensitiveLog = (obj: InputLambdaProcessorUpdate): any => ({ ...obj, }); @@ -2583,6 +2856,9 @@ export interface InputProcessingConfigurationUpdate { } export namespace InputProcessingConfigurationUpdate { + /** + * @internal + */ export const filterSensitiveLog = (obj: InputProcessingConfigurationUpdate): any => ({ ...obj, }); @@ -2611,6 +2887,9 @@ export interface InputSchemaUpdate { } export namespace InputSchemaUpdate { + /** + * @internal + */ export const filterSensitiveLog = (obj: InputSchemaUpdate): any => ({ ...obj, }); @@ -2629,6 +2908,9 @@ export interface KinesisFirehoseInputUpdate { } export namespace KinesisFirehoseInputUpdate { + /** + * @internal + */ export const filterSensitiveLog = (obj: KinesisFirehoseInputUpdate): any => ({ ...obj, }); @@ -2647,6 +2929,9 @@ export interface KinesisStreamsInputUpdate { } export namespace KinesisStreamsInputUpdate { + /** + * @internal + */ export const filterSensitiveLog = (obj: KinesisStreamsInputUpdate): any => ({ ...obj, }); @@ -2698,6 +2983,9 @@ export interface InputUpdate { } export namespace InputUpdate { + /** + * @internal + */ export const filterSensitiveLog = (obj: InputUpdate): any => ({ ...obj, }); @@ -2716,6 +3004,9 @@ export interface KinesisFirehoseOutputUpdate { } export namespace KinesisFirehoseOutputUpdate { + /** + * @internal + */ export const filterSensitiveLog = (obj: KinesisFirehoseOutputUpdate): any => ({ ...obj, }); @@ -2735,6 +3026,9 @@ export interface KinesisStreamsOutputUpdate { } export namespace KinesisStreamsOutputUpdate { + /** + * @internal + */ export const filterSensitiveLog = (obj: KinesisStreamsOutputUpdate): any => ({ ...obj, }); @@ -2757,6 +3051,9 @@ export interface LambdaOutputUpdate { } export namespace LambdaOutputUpdate { + /** + * @internal + */ export const filterSensitiveLog = (obj: LambdaOutputUpdate): any => ({ ...obj, }); @@ -2803,6 +3100,9 @@ export interface OutputUpdate { } export namespace OutputUpdate { + /** + * @internal + */ export const filterSensitiveLog = (obj: OutputUpdate): any => ({ ...obj, }); @@ -2825,6 +3125,9 @@ export interface S3ReferenceDataSourceUpdate { } export namespace S3ReferenceDataSourceUpdate { + /** + * @internal + */ export const filterSensitiveLog = (obj: S3ReferenceDataSourceUpdate): any => ({ ...obj, }); @@ -2862,6 +3165,9 @@ export interface ReferenceDataSourceUpdate { } export namespace ReferenceDataSourceUpdate { + /** + * @internal + */ export const filterSensitiveLog = (obj: ReferenceDataSourceUpdate): any => ({ ...obj, }); @@ -2892,6 +3198,9 @@ export interface SqlApplicationConfigurationUpdate { } export namespace SqlApplicationConfigurationUpdate { + /** + * @internal + */ export const filterSensitiveLog = (obj: SqlApplicationConfigurationUpdate): any => ({ ...obj, }); @@ -2921,6 +3230,9 @@ export interface VpcConfigurationUpdate { } export namespace VpcConfigurationUpdate { + /** + * @internal + */ export const filterSensitiveLog = (obj: VpcConfigurationUpdate): any => ({ ...obj, }); @@ -2964,6 +3276,9 @@ export interface ApplicationConfigurationUpdate { } export namespace ApplicationConfigurationUpdate { + /** + * @internal + */ export const filterSensitiveLog = (obj: ApplicationConfigurationUpdate): any => ({ ...obj, }); @@ -2985,6 +3300,9 @@ export interface ApplicationMaintenanceConfigurationDescription { } export namespace ApplicationMaintenanceConfigurationDescription { + /** + * @internal + */ export const filterSensitiveLog = (obj: ApplicationMaintenanceConfigurationDescription): any => ({ ...obj, }); @@ -3077,6 +3395,9 @@ export interface ApplicationDetail { } export namespace ApplicationDetail { + /** + * @internal + */ export const filterSensitiveLog = (obj: ApplicationDetail): any => ({ ...obj, }); @@ -3093,6 +3414,9 @@ export interface ApplicationMaintenanceConfigurationUpdate { } export namespace ApplicationMaintenanceConfigurationUpdate { + /** + * @internal + */ export const filterSensitiveLog = (obj: ApplicationMaintenanceConfigurationUpdate): any => ({ ...obj, }); @@ -3129,6 +3453,9 @@ export interface ApplicationSummary { } export namespace ApplicationSummary { + /** + * @internal + */ export const filterSensitiveLog = (obj: ApplicationSummary): any => ({ ...obj, }); @@ -3151,6 +3478,9 @@ export interface CloudWatchLoggingOptionUpdate { } export namespace CloudWatchLoggingOptionUpdate { + /** + * @internal + */ export const filterSensitiveLog = (obj: CloudWatchLoggingOptionUpdate): any => ({ ...obj, }); @@ -3178,6 +3508,9 @@ export interface Tag { } export namespace Tag { + /** + * @internal + */ export const filterSensitiveLog = (obj: Tag): any => ({ ...obj, }); @@ -3228,6 +3561,9 @@ export interface CreateApplicationRequest { } export namespace CreateApplicationRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateApplicationRequest): any => ({ ...obj, }); @@ -3242,6 +3578,9 @@ export interface CreateApplicationResponse { } export namespace CreateApplicationResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateApplicationResponse): any => ({ ...obj, }); @@ -3257,6 +3596,9 @@ export interface LimitExceededException extends __SmithyException, $MetadataBear } export namespace LimitExceededException { + /** + * @internal + */ export const filterSensitiveLog = (obj: LimitExceededException): any => ({ ...obj, }); @@ -3273,6 +3615,9 @@ export interface TooManyTagsException extends __SmithyException, $MetadataBearer } export namespace TooManyTagsException { + /** + * @internal + */ export const filterSensitiveLog = (obj: TooManyTagsException): any => ({ ...obj, }); @@ -3301,6 +3646,9 @@ export interface CreateApplicationPresignedUrlRequest { } export namespace CreateApplicationPresignedUrlRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateApplicationPresignedUrlRequest): any => ({ ...obj, }); @@ -3314,6 +3662,9 @@ export interface CreateApplicationPresignedUrlResponse { } export namespace CreateApplicationPresignedUrlResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateApplicationPresignedUrlResponse): any => ({ ...obj, }); @@ -3332,6 +3683,9 @@ export interface CreateApplicationSnapshotRequest { } export namespace CreateApplicationSnapshotRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateApplicationSnapshotRequest): any => ({ ...obj, }); @@ -3340,6 +3694,9 @@ export namespace CreateApplicationSnapshotRequest { export interface CreateApplicationSnapshotResponse {} export namespace CreateApplicationSnapshotResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateApplicationSnapshotResponse): any => ({ ...obj, }); @@ -3356,6 +3713,9 @@ export interface UnsupportedOperationException extends __SmithyException, $Metad } export namespace UnsupportedOperationException { + /** + * @internal + */ export const filterSensitiveLog = (obj: UnsupportedOperationException): any => ({ ...obj, }); @@ -3374,6 +3734,9 @@ export interface DeleteApplicationRequest { } export namespace DeleteApplicationRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteApplicationRequest): any => ({ ...obj, }); @@ -3382,6 +3745,9 @@ export namespace DeleteApplicationRequest { export interface DeleteApplicationResponse {} export namespace DeleteApplicationResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteApplicationResponse): any => ({ ...obj, }); @@ -3407,6 +3773,9 @@ export interface DeleteApplicationCloudWatchLoggingOptionRequest { } export namespace DeleteApplicationCloudWatchLoggingOptionRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteApplicationCloudWatchLoggingOptionRequest): any => ({ ...obj, }); @@ -3432,6 +3801,9 @@ export interface DeleteApplicationCloudWatchLoggingOptionResponse { } export namespace DeleteApplicationCloudWatchLoggingOptionResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteApplicationCloudWatchLoggingOptionResponse): any => ({ ...obj, }); @@ -3460,6 +3832,9 @@ export interface DeleteApplicationInputProcessingConfigurationRequest { } export namespace DeleteApplicationInputProcessingConfigurationRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteApplicationInputProcessingConfigurationRequest): any => ({ ...obj, }); @@ -3478,6 +3853,9 @@ export interface DeleteApplicationInputProcessingConfigurationResponse { } export namespace DeleteApplicationInputProcessingConfigurationResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteApplicationInputProcessingConfigurationResponse): any => ({ ...obj, }); @@ -3509,6 +3887,9 @@ export interface DeleteApplicationOutputRequest { } export namespace DeleteApplicationOutputRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteApplicationOutputRequest): any => ({ ...obj, }); @@ -3527,6 +3908,9 @@ export interface DeleteApplicationOutputResponse { } export namespace DeleteApplicationOutputResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteApplicationOutputResponse): any => ({ ...obj, }); @@ -3556,6 +3940,9 @@ export interface DeleteApplicationReferenceDataSourceRequest { } export namespace DeleteApplicationReferenceDataSourceRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteApplicationReferenceDataSourceRequest): any => ({ ...obj, }); @@ -3574,6 +3961,9 @@ export interface DeleteApplicationReferenceDataSourceResponse { } export namespace DeleteApplicationReferenceDataSourceResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteApplicationReferenceDataSourceResponse): any => ({ ...obj, }); @@ -3599,6 +3989,9 @@ export interface DeleteApplicationSnapshotRequest { } export namespace DeleteApplicationSnapshotRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteApplicationSnapshotRequest): any => ({ ...obj, }); @@ -3607,6 +4000,9 @@ export namespace DeleteApplicationSnapshotRequest { export interface DeleteApplicationSnapshotResponse {} export namespace DeleteApplicationSnapshotResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteApplicationSnapshotResponse): any => ({ ...obj, }); @@ -3631,6 +4027,9 @@ export interface DeleteApplicationVpcConfigurationRequest { } export namespace DeleteApplicationVpcConfigurationRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteApplicationVpcConfigurationRequest): any => ({ ...obj, }); @@ -3649,6 +4048,9 @@ export interface DeleteApplicationVpcConfigurationResponse { } export namespace DeleteApplicationVpcConfigurationResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteApplicationVpcConfigurationResponse): any => ({ ...obj, }); @@ -3667,6 +4069,9 @@ export interface DescribeApplicationRequest { } export namespace DescribeApplicationRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeApplicationRequest): any => ({ ...obj, }); @@ -3681,6 +4086,9 @@ export interface DescribeApplicationResponse { } export namespace DescribeApplicationResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeApplicationResponse): any => ({ ...obj, }); @@ -3700,6 +4108,9 @@ export interface DescribeApplicationSnapshotRequest { } export namespace DescribeApplicationSnapshotRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeApplicationSnapshotRequest): any => ({ ...obj, }); @@ -3738,6 +4149,9 @@ export interface SnapshotDetails { } export namespace SnapshotDetails { + /** + * @internal + */ export const filterSensitiveLog = (obj: SnapshotDetails): any => ({ ...obj, }); @@ -3751,6 +4165,9 @@ export interface DescribeApplicationSnapshotResponse { } export namespace DescribeApplicationSnapshotResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeApplicationSnapshotResponse): any => ({ ...obj, }); @@ -3774,6 +4191,9 @@ export interface S3Configuration { } export namespace S3Configuration { + /** + * @internal + */ export const filterSensitiveLog = (obj: S3Configuration): any => ({ ...obj, }); @@ -3810,6 +4230,9 @@ export interface DiscoverInputSchemaRequest { } export namespace DiscoverInputSchemaRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DiscoverInputSchemaRequest): any => ({ ...obj, }); @@ -3842,6 +4265,9 @@ export interface DiscoverInputSchemaResponse { } export namespace DiscoverInputSchemaResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DiscoverInputSchemaResponse): any => ({ ...obj, }); @@ -3858,6 +4284,9 @@ export interface ResourceProvisionedThroughputExceededException extends __Smithy } export namespace ResourceProvisionedThroughputExceededException { + /** + * @internal + */ export const filterSensitiveLog = (obj: ResourceProvisionedThroughputExceededException): any => ({ ...obj, }); @@ -3873,6 +4302,9 @@ export interface ServiceUnavailableException extends __SmithyException, $Metadat } export namespace ServiceUnavailableException { + /** + * @internal + */ export const filterSensitiveLog = (obj: ServiceUnavailableException): any => ({ ...obj, }); @@ -3898,6 +4330,9 @@ export interface UnableToDetectSchemaException extends __SmithyException, $Metad } export namespace UnableToDetectSchemaException { + /** + * @internal + */ export const filterSensitiveLog = (obj: UnableToDetectSchemaException): any => ({ ...obj, }); @@ -3919,6 +4354,9 @@ export interface ListApplicationsRequest { } export namespace ListApplicationsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListApplicationsRequest): any => ({ ...obj, }); @@ -3940,6 +4378,9 @@ export interface ListApplicationsResponse { } export namespace ListApplicationsResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListApplicationsResponse): any => ({ ...obj, }); @@ -3965,6 +4406,9 @@ export interface ListApplicationSnapshotsRequest { } export namespace ListApplicationSnapshotsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListApplicationSnapshotsRequest): any => ({ ...obj, }); @@ -3983,6 +4427,9 @@ export interface ListApplicationSnapshotsResponse { } export namespace ListApplicationSnapshotsResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListApplicationSnapshotsResponse): any => ({ ...obj, }); @@ -3996,6 +4443,9 @@ export interface ListTagsForResourceRequest { } export namespace ListTagsForResourceRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListTagsForResourceRequest): any => ({ ...obj, }); @@ -4009,6 +4459,9 @@ export interface ListTagsForResourceResponse { } export namespace ListTagsForResourceResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListTagsForResourceResponse): any => ({ ...obj, }); @@ -4031,6 +4484,9 @@ export interface SqlRunConfiguration { } export namespace SqlRunConfiguration { + /** + * @internal + */ export const filterSensitiveLog = (obj: SqlRunConfiguration): any => ({ ...obj, }); @@ -4058,6 +4514,9 @@ export interface RunConfiguration { } export namespace RunConfiguration { + /** + * @internal + */ export const filterSensitiveLog = (obj: RunConfiguration): any => ({ ...obj, }); @@ -4076,6 +4535,9 @@ export interface StartApplicationRequest { } export namespace StartApplicationRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: StartApplicationRequest): any => ({ ...obj, }); @@ -4084,6 +4546,9 @@ export namespace StartApplicationRequest { export interface StartApplicationResponse {} export namespace StartApplicationResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: StartApplicationResponse): any => ({ ...obj, }); @@ -4113,6 +4578,9 @@ export interface StopApplicationRequest { } export namespace StopApplicationRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: StopApplicationRequest): any => ({ ...obj, }); @@ -4121,6 +4589,9 @@ export namespace StopApplicationRequest { export interface StopApplicationResponse {} export namespace StopApplicationResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: StopApplicationResponse): any => ({ ...obj, }); @@ -4139,6 +4610,9 @@ export interface TagResourceRequest { } export namespace TagResourceRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: TagResourceRequest): any => ({ ...obj, }); @@ -4147,6 +4621,9 @@ export namespace TagResourceRequest { export interface TagResourceResponse {} export namespace TagResourceResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: TagResourceResponse): any => ({ ...obj, }); @@ -4165,6 +4642,9 @@ export interface UntagResourceRequest { } export namespace UntagResourceRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: UntagResourceRequest): any => ({ ...obj, }); @@ -4173,6 +4653,9 @@ export namespace UntagResourceRequest { export interface UntagResourceResponse {} export namespace UntagResourceResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: UntagResourceResponse): any => ({ ...obj, }); @@ -4194,6 +4677,9 @@ export interface RunConfigurationUpdate { } export namespace RunConfigurationUpdate { + /** + * @internal + */ export const filterSensitiveLog = (obj: RunConfigurationUpdate): any => ({ ...obj, }); @@ -4235,6 +4721,9 @@ export interface UpdateApplicationRequest { } export namespace UpdateApplicationRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateApplicationRequest): any => ({ ...obj, }); @@ -4248,6 +4737,9 @@ export interface UpdateApplicationResponse { } export namespace UpdateApplicationResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateApplicationResponse): any => ({ ...obj, }); @@ -4266,6 +4758,9 @@ export interface UpdateApplicationMaintenanceConfigurationRequest { } export namespace UpdateApplicationMaintenanceConfigurationRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateApplicationMaintenanceConfigurationRequest): any => ({ ...obj, }); @@ -4284,6 +4779,9 @@ export interface UpdateApplicationMaintenanceConfigurationResponse { } export namespace UpdateApplicationMaintenanceConfigurationResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateApplicationMaintenanceConfigurationResponse): any => ({ ...obj, }); diff --git a/clients/client-kinesis-analytics/commands/AddApplicationCloudWatchLoggingOptionCommand.ts b/clients/client-kinesis-analytics/commands/AddApplicationCloudWatchLoggingOptionCommand.ts index e9330ae61ff2..51acc6297001 100644 --- a/clients/client-kinesis-analytics/commands/AddApplicationCloudWatchLoggingOptionCommand.ts +++ b/clients/client-kinesis-analytics/commands/AddApplicationCloudWatchLoggingOptionCommand.ts @@ -34,6 +34,20 @@ export interface AddApplicationCloudWatchLoggingOptionCommandOutput * information about using CloudWatch log streams with Amazon Kinesis Analytics * applications, see Working with Amazon * CloudWatch Logs.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { KinesisAnalyticsClient, AddApplicationCloudWatchLoggingOptionCommand } from "@aws-sdk/client-kinesis-analytics"; // ES Modules import + * // const { KinesisAnalyticsClient, AddApplicationCloudWatchLoggingOptionCommand } = require("@aws-sdk/client-kinesis-analytics"); // CommonJS import + * const client = new KinesisAnalyticsClient(config); + * const command = new AddApplicationCloudWatchLoggingOptionCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link AddApplicationCloudWatchLoggingOptionCommandInput} for command's `input` shape. + * @see {@link AddApplicationCloudWatchLoggingOptionCommandOutput} for command's `response` shape. + * @see {@link KinesisAnalyticsClientResolvedConfig | config} for command's `input` shape. + * */ export class AddApplicationCloudWatchLoggingOptionCommand extends $Command< AddApplicationCloudWatchLoggingOptionCommandInput, diff --git a/clients/client-kinesis-analytics/commands/AddApplicationInputCommand.ts b/clients/client-kinesis-analytics/commands/AddApplicationInputCommand.ts index 4b3c4b30aa46..0e1979e6b1f4 100644 --- a/clients/client-kinesis-analytics/commands/AddApplicationInputCommand.ts +++ b/clients/client-kinesis-analytics/commands/AddApplicationInputCommand.ts @@ -38,6 +38,20 @@ export interface AddApplicationInputCommandOutput extends AddApplicationInputRes *

*

This operation requires permissions to perform the * kinesisanalytics:AddApplicationInput action.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { KinesisAnalyticsClient, AddApplicationInputCommand } from "@aws-sdk/client-kinesis-analytics"; // ES Modules import + * // const { KinesisAnalyticsClient, AddApplicationInputCommand } = require("@aws-sdk/client-kinesis-analytics"); // CommonJS import + * const client = new KinesisAnalyticsClient(config); + * const command = new AddApplicationInputCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link AddApplicationInputCommandInput} for command's `input` shape. + * @see {@link AddApplicationInputCommandOutput} for command's `response` shape. + * @see {@link KinesisAnalyticsClientResolvedConfig | config} for command's `input` shape. + * */ export class AddApplicationInputCommand extends $Command< AddApplicationInputCommandInput, diff --git a/clients/client-kinesis-analytics/commands/AddApplicationInputProcessingConfigurationCommand.ts b/clients/client-kinesis-analytics/commands/AddApplicationInputProcessingConfigurationCommand.ts index d11ad9a3e410..ab2797e2abf1 100644 --- a/clients/client-kinesis-analytics/commands/AddApplicationInputProcessingConfigurationCommand.ts +++ b/clients/client-kinesis-analytics/commands/AddApplicationInputProcessingConfigurationCommand.ts @@ -33,6 +33,20 @@ export interface AddApplicationInputProcessingConfigurationCommandOutput *

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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { KinesisAnalyticsClient, AddApplicationInputProcessingConfigurationCommand } from "@aws-sdk/client-kinesis-analytics"; // ES Modules import + * // const { KinesisAnalyticsClient, AddApplicationInputProcessingConfigurationCommand } = require("@aws-sdk/client-kinesis-analytics"); // CommonJS import + * const client = new KinesisAnalyticsClient(config); + * const command = new AddApplicationInputProcessingConfigurationCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link AddApplicationInputProcessingConfigurationCommandInput} for command's `input` shape. + * @see {@link AddApplicationInputProcessingConfigurationCommandOutput} for command's `response` shape. + * @see {@link KinesisAnalyticsClientResolvedConfig | config} for command's `input` shape. + * */ export class AddApplicationInputProcessingConfigurationCommand extends $Command< AddApplicationInputProcessingConfigurationCommandInput, diff --git a/clients/client-kinesis-analytics/commands/AddApplicationOutputCommand.ts b/clients/client-kinesis-analytics/commands/AddApplicationOutputCommand.ts index 7ecca0338487..dbed3d0ff5e4 100644 --- a/clients/client-kinesis-analytics/commands/AddApplicationOutputCommand.ts +++ b/clients/client-kinesis-analytics/commands/AddApplicationOutputCommand.ts @@ -41,6 +41,20 @@ export interface AddApplicationOutputCommandOutput extends AddApplicationOutputR *

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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { KinesisAnalyticsClient, AddApplicationOutputCommand } from "@aws-sdk/client-kinesis-analytics"; // ES Modules import + * // const { KinesisAnalyticsClient, AddApplicationOutputCommand } = require("@aws-sdk/client-kinesis-analytics"); // CommonJS import + * const client = new KinesisAnalyticsClient(config); + * const command = new AddApplicationOutputCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link AddApplicationOutputCommandInput} for command's `input` shape. + * @see {@link AddApplicationOutputCommandOutput} for command's `response` shape. + * @see {@link KinesisAnalyticsClientResolvedConfig | config} for command's `input` shape. + * */ export class AddApplicationOutputCommand extends $Command< AddApplicationOutputCommandInput, diff --git a/clients/client-kinesis-analytics/commands/AddApplicationReferenceDataSourceCommand.ts b/clients/client-kinesis-analytics/commands/AddApplicationReferenceDataSourceCommand.ts index 6157ce171317..55f168d5b1ad 100644 --- a/clients/client-kinesis-analytics/commands/AddApplicationReferenceDataSourceCommand.ts +++ b/clients/client-kinesis-analytics/commands/AddApplicationReferenceDataSourceCommand.ts @@ -40,6 +40,20 @@ export interface AddApplicationReferenceDataSourceCommandOutput *

* This operation requires permissions to perform the kinesisanalytics:AddApplicationOutput action. *

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { KinesisAnalyticsClient, AddApplicationReferenceDataSourceCommand } from "@aws-sdk/client-kinesis-analytics"; // ES Modules import + * // const { KinesisAnalyticsClient, AddApplicationReferenceDataSourceCommand } = require("@aws-sdk/client-kinesis-analytics"); // CommonJS import + * const client = new KinesisAnalyticsClient(config); + * const command = new AddApplicationReferenceDataSourceCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link AddApplicationReferenceDataSourceCommandInput} for command's `input` shape. + * @see {@link AddApplicationReferenceDataSourceCommandOutput} for command's `response` shape. + * @see {@link KinesisAnalyticsClientResolvedConfig | config} for command's `input` shape. + * */ export class AddApplicationReferenceDataSourceCommand extends $Command< AddApplicationReferenceDataSourceCommandInput, diff --git a/clients/client-kinesis-analytics/commands/CreateApplicationCommand.ts b/clients/client-kinesis-analytics/commands/CreateApplicationCommand.ts index b5161f69001e..4b4c5431af5c 100644 --- a/clients/client-kinesis-analytics/commands/CreateApplicationCommand.ts +++ b/clients/client-kinesis-analytics/commands/CreateApplicationCommand.ts @@ -48,6 +48,20 @@ export interface CreateApplicationCommandOutput extends CreateApplicationRespons * For introductory exercises to create an Amazon Kinesis Analytics application, see * Getting Started. *

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { KinesisAnalyticsClient, CreateApplicationCommand } from "@aws-sdk/client-kinesis-analytics"; // ES Modules import + * // const { KinesisAnalyticsClient, CreateApplicationCommand } = require("@aws-sdk/client-kinesis-analytics"); // CommonJS import + * const client = new KinesisAnalyticsClient(config); + * const command = new CreateApplicationCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreateApplicationCommandInput} for command's `input` shape. + * @see {@link CreateApplicationCommandOutput} for command's `response` shape. + * @see {@link KinesisAnalyticsClientResolvedConfig | config} for command's `input` shape. + * */ export class CreateApplicationCommand extends $Command< CreateApplicationCommandInput, diff --git a/clients/client-kinesis-analytics/commands/DeleteApplicationCloudWatchLoggingOptionCommand.ts b/clients/client-kinesis-analytics/commands/DeleteApplicationCloudWatchLoggingOptionCommand.ts index f85df1039ac0..027791a4c61a 100644 --- a/clients/client-kinesis-analytics/commands/DeleteApplicationCloudWatchLoggingOptionCommand.ts +++ b/clients/client-kinesis-analytics/commands/DeleteApplicationCloudWatchLoggingOptionCommand.ts @@ -33,6 +33,20 @@ export interface DeleteApplicationCloudWatchLoggingOptionCommandOutput *

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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { KinesisAnalyticsClient, DeleteApplicationCloudWatchLoggingOptionCommand } from "@aws-sdk/client-kinesis-analytics"; // ES Modules import + * // const { KinesisAnalyticsClient, DeleteApplicationCloudWatchLoggingOptionCommand } = require("@aws-sdk/client-kinesis-analytics"); // CommonJS import + * const client = new KinesisAnalyticsClient(config); + * const command = new DeleteApplicationCloudWatchLoggingOptionCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteApplicationCloudWatchLoggingOptionCommandInput} for command's `input` shape. + * @see {@link DeleteApplicationCloudWatchLoggingOptionCommandOutput} for command's `response` shape. + * @see {@link KinesisAnalyticsClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteApplicationCloudWatchLoggingOptionCommand extends $Command< DeleteApplicationCloudWatchLoggingOptionCommandInput, diff --git a/clients/client-kinesis-analytics/commands/DeleteApplicationCommand.ts b/clients/client-kinesis-analytics/commands/DeleteApplicationCommand.ts index f6c10ecd2fa2..574f13fd5d9f 100644 --- a/clients/client-kinesis-analytics/commands/DeleteApplicationCommand.ts +++ b/clients/client-kinesis-analytics/commands/DeleteApplicationCommand.ts @@ -27,6 +27,20 @@ export interface DeleteApplicationCommandOutput extends DeleteApplicationRespons *

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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { KinesisAnalyticsClient, DeleteApplicationCommand } from "@aws-sdk/client-kinesis-analytics"; // ES Modules import + * // const { KinesisAnalyticsClient, DeleteApplicationCommand } = require("@aws-sdk/client-kinesis-analytics"); // CommonJS import + * const client = new KinesisAnalyticsClient(config); + * const command = new DeleteApplicationCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteApplicationCommandInput} for command's `input` shape. + * @see {@link DeleteApplicationCommandOutput} for command's `response` shape. + * @see {@link KinesisAnalyticsClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteApplicationCommand extends $Command< DeleteApplicationCommandInput, diff --git a/clients/client-kinesis-analytics/commands/DeleteApplicationInputProcessingConfigurationCommand.ts b/clients/client-kinesis-analytics/commands/DeleteApplicationInputProcessingConfigurationCommand.ts index 638d099b4af9..b57a6cdcbdba 100644 --- a/clients/client-kinesis-analytics/commands/DeleteApplicationInputProcessingConfigurationCommand.ts +++ b/clients/client-kinesis-analytics/commands/DeleteApplicationInputProcessingConfigurationCommand.ts @@ -31,6 +31,20 @@ export interface DeleteApplicationInputProcessingConfigurationCommandOutput *

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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { KinesisAnalyticsClient, DeleteApplicationInputProcessingConfigurationCommand } from "@aws-sdk/client-kinesis-analytics"; // ES Modules import + * // const { KinesisAnalyticsClient, DeleteApplicationInputProcessingConfigurationCommand } = require("@aws-sdk/client-kinesis-analytics"); // CommonJS import + * const client = new KinesisAnalyticsClient(config); + * const command = new DeleteApplicationInputProcessingConfigurationCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteApplicationInputProcessingConfigurationCommandInput} for command's `input` shape. + * @see {@link DeleteApplicationInputProcessingConfigurationCommandOutput} for command's `response` shape. + * @see {@link KinesisAnalyticsClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteApplicationInputProcessingConfigurationCommand extends $Command< DeleteApplicationInputProcessingConfigurationCommandInput, diff --git a/clients/client-kinesis-analytics/commands/DeleteApplicationOutputCommand.ts b/clients/client-kinesis-analytics/commands/DeleteApplicationOutputCommand.ts index 177868fed02d..d40e690cf079 100644 --- a/clients/client-kinesis-analytics/commands/DeleteApplicationOutputCommand.ts +++ b/clients/client-kinesis-analytics/commands/DeleteApplicationOutputCommand.ts @@ -27,6 +27,20 @@ export interface DeleteApplicationOutputCommandOutput extends DeleteApplicationO *

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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { KinesisAnalyticsClient, DeleteApplicationOutputCommand } from "@aws-sdk/client-kinesis-analytics"; // ES Modules import + * // const { KinesisAnalyticsClient, DeleteApplicationOutputCommand } = require("@aws-sdk/client-kinesis-analytics"); // CommonJS import + * const client = new KinesisAnalyticsClient(config); + * const command = new DeleteApplicationOutputCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteApplicationOutputCommandInput} for command's `input` shape. + * @see {@link DeleteApplicationOutputCommandOutput} for command's `response` shape. + * @see {@link KinesisAnalyticsClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteApplicationOutputCommand extends $Command< DeleteApplicationOutputCommandInput, diff --git a/clients/client-kinesis-analytics/commands/DeleteApplicationReferenceDataSourceCommand.ts b/clients/client-kinesis-analytics/commands/DeleteApplicationReferenceDataSourceCommand.ts index 56c38ba795b3..3eb7a4997855 100644 --- a/clients/client-kinesis-analytics/commands/DeleteApplicationReferenceDataSourceCommand.ts +++ b/clients/client-kinesis-analytics/commands/DeleteApplicationReferenceDataSourceCommand.ts @@ -35,6 +35,20 @@ export interface DeleteApplicationReferenceDataSourceCommandOutput * *

This operation requires permissions to perform the kinesisanalytics.DeleteApplicationReferenceDataSource * action.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { KinesisAnalyticsClient, DeleteApplicationReferenceDataSourceCommand } from "@aws-sdk/client-kinesis-analytics"; // ES Modules import + * // const { KinesisAnalyticsClient, DeleteApplicationReferenceDataSourceCommand } = require("@aws-sdk/client-kinesis-analytics"); // CommonJS import + * const client = new KinesisAnalyticsClient(config); + * const command = new DeleteApplicationReferenceDataSourceCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteApplicationReferenceDataSourceCommandInput} for command's `input` shape. + * @see {@link DeleteApplicationReferenceDataSourceCommandOutput} for command's `response` shape. + * @see {@link KinesisAnalyticsClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteApplicationReferenceDataSourceCommand extends $Command< DeleteApplicationReferenceDataSourceCommandInput, diff --git a/clients/client-kinesis-analytics/commands/DescribeApplicationCommand.ts b/clients/client-kinesis-analytics/commands/DescribeApplicationCommand.ts index 2084e60fb787..6370cd363022 100644 --- a/clients/client-kinesis-analytics/commands/DescribeApplicationCommand.ts +++ b/clients/client-kinesis-analytics/commands/DescribeApplicationCommand.ts @@ -31,6 +31,20 @@ export interface DescribeApplicationCommandOutput extends DescribeApplicationRes * action. You can use DescribeApplication to get the current application versionId, which you need to call other * operations such as Update. *

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { KinesisAnalyticsClient, DescribeApplicationCommand } from "@aws-sdk/client-kinesis-analytics"; // ES Modules import + * // const { KinesisAnalyticsClient, DescribeApplicationCommand } = require("@aws-sdk/client-kinesis-analytics"); // CommonJS import + * const client = new KinesisAnalyticsClient(config); + * const command = new DescribeApplicationCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeApplicationCommandInput} for command's `input` shape. + * @see {@link DescribeApplicationCommandOutput} for command's `response` shape. + * @see {@link KinesisAnalyticsClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeApplicationCommand extends $Command< DescribeApplicationCommandInput, diff --git a/clients/client-kinesis-analytics/commands/DiscoverInputSchemaCommand.ts b/clients/client-kinesis-analytics/commands/DiscoverInputSchemaCommand.ts index 4bc02a16fbf3..78fd6ee24ea7 100644 --- a/clients/client-kinesis-analytics/commands/DiscoverInputSchemaCommand.ts +++ b/clients/client-kinesis-analytics/commands/DiscoverInputSchemaCommand.ts @@ -36,6 +36,20 @@ export interface DiscoverInputSchemaCommandOutput extends DiscoverInputSchemaRes * This operation requires permissions to perform the * kinesisanalytics:DiscoverInputSchema action. *

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { KinesisAnalyticsClient, DiscoverInputSchemaCommand } from "@aws-sdk/client-kinesis-analytics"; // ES Modules import + * // const { KinesisAnalyticsClient, DiscoverInputSchemaCommand } = require("@aws-sdk/client-kinesis-analytics"); // CommonJS import + * const client = new KinesisAnalyticsClient(config); + * const command = new DiscoverInputSchemaCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DiscoverInputSchemaCommandInput} for command's `input` shape. + * @see {@link DiscoverInputSchemaCommandOutput} for command's `response` shape. + * @see {@link KinesisAnalyticsClientResolvedConfig | config} for command's `input` shape. + * */ export class DiscoverInputSchemaCommand extends $Command< DiscoverInputSchemaCommandInput, diff --git a/clients/client-kinesis-analytics/commands/ListApplicationsCommand.ts b/clients/client-kinesis-analytics/commands/ListApplicationsCommand.ts index b814402af5d1..5aea0b465068 100644 --- a/clients/client-kinesis-analytics/commands/ListApplicationsCommand.ts +++ b/clients/client-kinesis-analytics/commands/ListApplicationsCommand.ts @@ -38,6 +38,20 @@ export interface ListApplicationsCommandOutput extends ListApplicationsResponse, * DescribeApplication.

*

This operation requires permissions to perform the * kinesisanalytics:ListApplications action.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { KinesisAnalyticsClient, ListApplicationsCommand } from "@aws-sdk/client-kinesis-analytics"; // ES Modules import + * // const { KinesisAnalyticsClient, ListApplicationsCommand } = require("@aws-sdk/client-kinesis-analytics"); // CommonJS import + * const client = new KinesisAnalyticsClient(config); + * const command = new ListApplicationsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListApplicationsCommandInput} for command's `input` shape. + * @see {@link ListApplicationsCommandOutput} for command's `response` shape. + * @see {@link KinesisAnalyticsClientResolvedConfig | config} for command's `input` shape. + * */ export class ListApplicationsCommand extends $Command< ListApplicationsCommandInput, diff --git a/clients/client-kinesis-analytics/commands/ListTagsForResourceCommand.ts b/clients/client-kinesis-analytics/commands/ListTagsForResourceCommand.ts index 160a8cedb714..3b89c0be06ea 100644 --- a/clients/client-kinesis-analytics/commands/ListTagsForResourceCommand.ts +++ b/clients/client-kinesis-analytics/commands/ListTagsForResourceCommand.ts @@ -22,6 +22,20 @@ export interface ListTagsForResourceCommandOutput extends ListTagsForResourceRes /** *

Retrieves the list of key-value tags assigned to the application. For more information, see Using Tagging.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { KinesisAnalyticsClient, ListTagsForResourceCommand } from "@aws-sdk/client-kinesis-analytics"; // ES Modules import + * // const { KinesisAnalyticsClient, ListTagsForResourceCommand } = require("@aws-sdk/client-kinesis-analytics"); // CommonJS import + * const client = new KinesisAnalyticsClient(config); + * const command = new ListTagsForResourceCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListTagsForResourceCommandInput} for command's `input` shape. + * @see {@link ListTagsForResourceCommandOutput} for command's `response` shape. + * @see {@link KinesisAnalyticsClientResolvedConfig | config} for command's `input` shape. + * */ export class ListTagsForResourceCommand extends $Command< ListTagsForResourceCommandInput, diff --git a/clients/client-kinesis-analytics/commands/StartApplicationCommand.ts b/clients/client-kinesis-analytics/commands/StartApplicationCommand.ts index 012761a376bd..f6efedba03ff 100644 --- a/clients/client-kinesis-analytics/commands/StartApplicationCommand.ts +++ b/clients/client-kinesis-analytics/commands/StartApplicationCommand.ts @@ -33,6 +33,20 @@ export interface StartApplicationCommandOutput extends StartApplicationResponse, * the input by calling the StopApplication operation.

*

This operation requires permissions to perform the * kinesisanalytics:StartApplication action.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { KinesisAnalyticsClient, StartApplicationCommand } from "@aws-sdk/client-kinesis-analytics"; // ES Modules import + * // const { KinesisAnalyticsClient, StartApplicationCommand } = require("@aws-sdk/client-kinesis-analytics"); // CommonJS import + * const client = new KinesisAnalyticsClient(config); + * const command = new StartApplicationCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link StartApplicationCommandInput} for command's `input` shape. + * @see {@link StartApplicationCommandOutput} for command's `response` shape. + * @see {@link KinesisAnalyticsClientResolvedConfig | config} for command's `input` shape. + * */ export class StartApplicationCommand extends $Command< StartApplicationCommandInput, diff --git a/clients/client-kinesis-analytics/commands/StopApplicationCommand.ts b/clients/client-kinesis-analytics/commands/StopApplicationCommand.ts index de0757e3c338..161e59140c4d 100644 --- a/clients/client-kinesis-analytics/commands/StopApplicationCommand.ts +++ b/clients/client-kinesis-analytics/commands/StopApplicationCommand.ts @@ -32,6 +32,20 @@ export interface StopApplicationCommandOutput extends StopApplicationResponse, _ * application stops processing data, and there is no output written to the destination.

*

This operation requires permissions to perform the * kinesisanalytics:StopApplication action.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { KinesisAnalyticsClient, StopApplicationCommand } from "@aws-sdk/client-kinesis-analytics"; // ES Modules import + * // const { KinesisAnalyticsClient, StopApplicationCommand } = require("@aws-sdk/client-kinesis-analytics"); // CommonJS import + * const client = new KinesisAnalyticsClient(config); + * const command = new StopApplicationCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link StopApplicationCommandInput} for command's `input` shape. + * @see {@link StopApplicationCommandOutput} for command's `response` shape. + * @see {@link KinesisAnalyticsClientResolvedConfig | config} for command's `input` shape. + * */ export class StopApplicationCommand extends $Command< StopApplicationCommandInput, diff --git a/clients/client-kinesis-analytics/commands/TagResourceCommand.ts b/clients/client-kinesis-analytics/commands/TagResourceCommand.ts index c0c178e7a2f9..18824aa0ed9f 100644 --- a/clients/client-kinesis-analytics/commands/TagResourceCommand.ts +++ b/clients/client-kinesis-analytics/commands/TagResourceCommand.ts @@ -23,6 +23,20 @@ export interface TagResourceCommandOutput extends TagResourceResponse, __Metadat /** *

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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { KinesisAnalyticsClient, TagResourceCommand } from "@aws-sdk/client-kinesis-analytics"; // ES Modules import + * // const { KinesisAnalyticsClient, TagResourceCommand } = require("@aws-sdk/client-kinesis-analytics"); // CommonJS import + * const client = new KinesisAnalyticsClient(config); + * const command = new TagResourceCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link TagResourceCommandInput} for command's `input` shape. + * @see {@link TagResourceCommandOutput} for command's `response` shape. + * @see {@link KinesisAnalyticsClientResolvedConfig | config} for command's `input` shape. + * */ export class TagResourceCommand extends $Command< TagResourceCommandInput, diff --git a/clients/client-kinesis-analytics/commands/UntagResourceCommand.ts b/clients/client-kinesis-analytics/commands/UntagResourceCommand.ts index 1bc9715bd62e..f474ba38bb45 100644 --- a/clients/client-kinesis-analytics/commands/UntagResourceCommand.ts +++ b/clients/client-kinesis-analytics/commands/UntagResourceCommand.ts @@ -22,6 +22,20 @@ export interface UntagResourceCommandOutput extends UntagResourceResponse, __Met /** *

Removes one or more tags from a Kinesis Analytics application. For more information, see Using Tagging.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { KinesisAnalyticsClient, UntagResourceCommand } from "@aws-sdk/client-kinesis-analytics"; // ES Modules import + * // const { KinesisAnalyticsClient, UntagResourceCommand } = require("@aws-sdk/client-kinesis-analytics"); // CommonJS import + * const client = new KinesisAnalyticsClient(config); + * const command = new UntagResourceCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link UntagResourceCommandInput} for command's `input` shape. + * @see {@link UntagResourceCommandOutput} for command's `response` shape. + * @see {@link KinesisAnalyticsClientResolvedConfig | config} for command's `input` shape. + * */ export class UntagResourceCommand extends $Command< UntagResourceCommandInput, diff --git a/clients/client-kinesis-analytics/commands/UpdateApplicationCommand.ts b/clients/client-kinesis-analytics/commands/UpdateApplicationCommand.ts index 38949b3d1d29..17c4b7eb7d74 100644 --- a/clients/client-kinesis-analytics/commands/UpdateApplicationCommand.ts +++ b/clients/client-kinesis-analytics/commands/UpdateApplicationCommand.ts @@ -31,6 +31,20 @@ export interface UpdateApplicationCommandOutput extends UpdateApplicationRespons * each time you update your application.

*

This operation requires permission for the * kinesisanalytics:UpdateApplication action.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { KinesisAnalyticsClient, UpdateApplicationCommand } from "@aws-sdk/client-kinesis-analytics"; // ES Modules import + * // const { KinesisAnalyticsClient, UpdateApplicationCommand } = require("@aws-sdk/client-kinesis-analytics"); // CommonJS import + * const client = new KinesisAnalyticsClient(config); + * const command = new UpdateApplicationCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link UpdateApplicationCommandInput} for command's `input` shape. + * @see {@link UpdateApplicationCommandOutput} for command's `response` shape. + * @see {@link KinesisAnalyticsClientResolvedConfig | config} for command's `input` shape. + * */ export class UpdateApplicationCommand extends $Command< UpdateApplicationCommandInput, diff --git a/clients/client-kinesis-analytics/models/models_0.ts b/clients/client-kinesis-analytics/models/models_0.ts index 9413de6ea498..f4119ac629b7 100644 --- a/clients/client-kinesis-analytics/models/models_0.ts +++ b/clients/client-kinesis-analytics/models/models_0.ts @@ -20,6 +20,9 @@ export interface CloudWatchLoggingOption { } export namespace CloudWatchLoggingOption { + /** + * @internal + */ export const filterSensitiveLog = (obj: CloudWatchLoggingOption): any => ({ ...obj, }); @@ -45,6 +48,9 @@ export interface AddApplicationCloudWatchLoggingOptionRequest { } export namespace AddApplicationCloudWatchLoggingOptionRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: AddApplicationCloudWatchLoggingOptionRequest): any => ({ ...obj, }); @@ -53,6 +59,9 @@ export namespace AddApplicationCloudWatchLoggingOptionRequest { export interface AddApplicationCloudWatchLoggingOptionResponse {} export namespace AddApplicationCloudWatchLoggingOptionResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: AddApplicationCloudWatchLoggingOptionResponse): any => ({ ...obj, }); @@ -71,6 +80,9 @@ export interface ConcurrentModificationException extends __SmithyException, $Met } export namespace ConcurrentModificationException { + /** + * @internal + */ export const filterSensitiveLog = (obj: ConcurrentModificationException): any => ({ ...obj, }); @@ -89,6 +101,9 @@ export interface InvalidArgumentException extends __SmithyException, $MetadataBe } export namespace InvalidArgumentException { + /** + * @internal + */ export const filterSensitiveLog = (obj: InvalidArgumentException): any => ({ ...obj, }); @@ -107,6 +122,9 @@ export interface ResourceInUseException extends __SmithyException, $MetadataBear } export namespace ResourceInUseException { + /** + * @internal + */ export const filterSensitiveLog = (obj: ResourceInUseException): any => ({ ...obj, }); @@ -125,6 +143,9 @@ export interface ResourceNotFoundException extends __SmithyException, $MetadataB } export namespace ResourceNotFoundException { + /** + * @internal + */ export const filterSensitiveLog = (obj: ResourceNotFoundException): any => ({ ...obj, }); @@ -140,6 +161,9 @@ export interface UnsupportedOperationException extends __SmithyException, $Metad } export namespace UnsupportedOperationException { + /** + * @internal + */ export const filterSensitiveLog = (obj: UnsupportedOperationException): any => ({ ...obj, }); @@ -161,6 +185,9 @@ export interface InputParallelism { } export namespace InputParallelism { + /** + * @internal + */ export const filterSensitiveLog = (obj: InputParallelism): any => ({ ...obj, }); @@ -189,6 +216,9 @@ export interface InputLambdaProcessor { } export namespace InputLambdaProcessor { + /** + * @internal + */ export const filterSensitiveLog = (obj: InputLambdaProcessor): any => ({ ...obj, }); @@ -209,6 +239,9 @@ export interface InputProcessingConfiguration { } export namespace InputProcessingConfiguration { + /** + * @internal + */ export const filterSensitiveLog = (obj: InputProcessingConfiguration): any => ({ ...obj, }); @@ -238,6 +271,9 @@ export interface RecordColumn { } export namespace RecordColumn { + /** + * @internal + */ export const filterSensitiveLog = (obj: RecordColumn): any => ({ ...obj, }); @@ -269,6 +305,9 @@ export interface CSVMappingParameters { } export namespace CSVMappingParameters { + /** + * @internal + */ export const filterSensitiveLog = (obj: CSVMappingParameters): any => ({ ...obj, }); @@ -285,6 +324,9 @@ export interface JSONMappingParameters { } export namespace JSONMappingParameters { + /** + * @internal + */ export const filterSensitiveLog = (obj: JSONMappingParameters): any => ({ ...obj, }); @@ -311,6 +353,9 @@ export interface MappingParameters { } export namespace MappingParameters { + /** + * @internal + */ export const filterSensitiveLog = (obj: MappingParameters): any => ({ ...obj, }); @@ -340,6 +385,9 @@ export interface RecordFormat { } export namespace RecordFormat { + /** + * @internal + */ export const filterSensitiveLog = (obj: RecordFormat): any => ({ ...obj, }); @@ -366,6 +414,9 @@ export interface SourceSchema { } export namespace SourceSchema { + /** + * @internal + */ export const filterSensitiveLog = (obj: SourceSchema): any => ({ ...obj, }); @@ -391,6 +442,9 @@ export interface KinesisFirehoseInput { } export namespace KinesisFirehoseInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: KinesisFirehoseInput): any => ({ ...obj, }); @@ -414,6 +468,9 @@ export interface KinesisStreamsInput { } export namespace KinesisStreamsInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: KinesisStreamsInput): any => ({ ...obj, }); @@ -473,6 +530,9 @@ export interface Input { } export namespace Input { + /** + * @internal + */ export const filterSensitiveLog = (obj: Input): any => ({ ...obj, }); @@ -500,6 +560,9 @@ export interface AddApplicationInputRequest { } export namespace AddApplicationInputRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: AddApplicationInputRequest): any => ({ ...obj, }); @@ -511,6 +574,9 @@ export namespace AddApplicationInputRequest { export interface AddApplicationInputResponse {} export namespace AddApplicationInputResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: AddApplicationInputResponse): any => ({ ...obj, }); @@ -529,6 +595,9 @@ export interface CodeValidationException extends __SmithyException, $MetadataBea } export namespace CodeValidationException { + /** + * @internal + */ export const filterSensitiveLog = (obj: CodeValidationException): any => ({ ...obj, }); @@ -560,6 +629,9 @@ export interface AddApplicationInputProcessingConfigurationRequest { } export namespace AddApplicationInputProcessingConfigurationRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: AddApplicationInputProcessingConfigurationRequest): any => ({ ...obj, }); @@ -568,6 +640,9 @@ export namespace AddApplicationInputProcessingConfigurationRequest { export interface AddApplicationInputProcessingConfigurationResponse {} export namespace AddApplicationInputProcessingConfigurationResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: AddApplicationInputProcessingConfigurationResponse): any => ({ ...obj, }); @@ -589,6 +664,9 @@ export interface DestinationSchema { } export namespace DestinationSchema { + /** + * @internal + */ export const filterSensitiveLog = (obj: DestinationSchema): any => ({ ...obj, }); @@ -613,6 +691,9 @@ export interface KinesisFirehoseOutput { } export namespace KinesisFirehoseOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: KinesisFirehoseOutput): any => ({ ...obj, }); @@ -636,6 +717,9 @@ export interface KinesisStreamsOutput { } export namespace KinesisStreamsOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: KinesisStreamsOutput): any => ({ ...obj, }); @@ -664,6 +748,9 @@ export interface LambdaOutput { } export namespace LambdaOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: LambdaOutput): any => ({ ...obj, }); @@ -712,6 +799,9 @@ export interface Output { } export namespace Output { + /** + * @internal + */ export const filterSensitiveLog = (obj: Output): any => ({ ...obj, }); @@ -744,6 +834,9 @@ export interface AddApplicationOutputRequest { } export namespace AddApplicationOutputRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: AddApplicationOutputRequest): any => ({ ...obj, }); @@ -755,6 +848,9 @@ export namespace AddApplicationOutputRequest { export interface AddApplicationOutputResponse {} export namespace AddApplicationOutputResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: AddApplicationOutputResponse): any => ({ ...obj, }); @@ -784,6 +880,9 @@ export interface S3ReferenceDataSource { } export namespace S3ReferenceDataSource { + /** + * @internal + */ export const filterSensitiveLog = (obj: S3ReferenceDataSource): any => ({ ...obj, }); @@ -812,6 +911,9 @@ export interface ReferenceDataSource { } export namespace ReferenceDataSource { + /** + * @internal + */ export const filterSensitiveLog = (obj: ReferenceDataSource): any => ({ ...obj, }); @@ -841,6 +943,9 @@ export interface AddApplicationReferenceDataSourceRequest { } export namespace AddApplicationReferenceDataSourceRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: AddApplicationReferenceDataSourceRequest): any => ({ ...obj, }); @@ -852,6 +957,9 @@ export namespace AddApplicationReferenceDataSourceRequest { export interface AddApplicationReferenceDataSourceResponse {} export namespace AddApplicationReferenceDataSourceResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: AddApplicationReferenceDataSourceResponse): any => ({ ...obj, }); @@ -887,6 +995,9 @@ export interface CloudWatchLoggingOptionDescription { } export namespace CloudWatchLoggingOptionDescription { + /** + * @internal + */ export const filterSensitiveLog = (obj: CloudWatchLoggingOptionDescription): any => ({ ...obj, }); @@ -910,6 +1021,9 @@ export interface InputLambdaProcessorDescription { } export namespace InputLambdaProcessorDescription { + /** + * @internal + */ export const filterSensitiveLog = (obj: InputLambdaProcessorDescription): any => ({ ...obj, }); @@ -927,6 +1041,9 @@ export interface InputProcessingConfigurationDescription { } export namespace InputProcessingConfigurationDescription { + /** + * @internal + */ export const filterSensitiveLog = (obj: InputProcessingConfigurationDescription): any => ({ ...obj, }); @@ -969,6 +1086,9 @@ export interface InputStartingPositionConfiguration { } export namespace InputStartingPositionConfiguration { + /** + * @internal + */ export const filterSensitiveLog = (obj: InputStartingPositionConfiguration): any => ({ ...obj, }); @@ -993,6 +1113,9 @@ export interface KinesisFirehoseInputDescription { } export namespace KinesisFirehoseInputDescription { + /** + * @internal + */ export const filterSensitiveLog = (obj: KinesisFirehoseInputDescription): any => ({ ...obj, }); @@ -1017,6 +1140,9 @@ export interface KinesisStreamsInputDescription { } export namespace KinesisStreamsInputDescription { + /** + * @internal + */ export const filterSensitiveLog = (obj: KinesisStreamsInputDescription): any => ({ ...obj, }); @@ -1085,6 +1211,9 @@ export interface InputDescription { } export namespace InputDescription { + /** + * @internal + */ export const filterSensitiveLog = (obj: InputDescription): any => ({ ...obj, }); @@ -1109,6 +1238,9 @@ export interface KinesisFirehoseOutputDescription { } export namespace KinesisFirehoseOutputDescription { + /** + * @internal + */ export const filterSensitiveLog = (obj: KinesisFirehoseOutputDescription): any => ({ ...obj, }); @@ -1133,6 +1265,9 @@ export interface KinesisStreamsOutputDescription { } export namespace KinesisStreamsOutputDescription { + /** + * @internal + */ export const filterSensitiveLog = (obj: KinesisStreamsOutputDescription): any => ({ ...obj, }); @@ -1155,6 +1290,9 @@ export interface LambdaOutputDescription { } export namespace LambdaOutputDescription { + /** + * @internal + */ export const filterSensitiveLog = (obj: LambdaOutputDescription): any => ({ ...obj, }); @@ -1203,6 +1341,9 @@ export interface OutputDescription { } export namespace OutputDescription { + /** + * @internal + */ export const filterSensitiveLog = (obj: OutputDescription): any => ({ ...obj, }); @@ -1229,6 +1370,9 @@ export interface S3ReferenceDataSourceDescription { } export namespace S3ReferenceDataSourceDescription { + /** + * @internal + */ export const filterSensitiveLog = (obj: S3ReferenceDataSourceDescription): any => ({ ...obj, }); @@ -1262,6 +1406,9 @@ export interface ReferenceDataSourceDescription { } export namespace ReferenceDataSourceDescription { + /** + * @internal + */ export const filterSensitiveLog = (obj: ReferenceDataSourceDescription): any => ({ ...obj, }); @@ -1352,6 +1499,9 @@ export interface ApplicationDetail { } export namespace ApplicationDetail { + /** + * @internal + */ export const filterSensitiveLog = (obj: ApplicationDetail): any => ({ ...obj, }); @@ -1381,6 +1531,9 @@ export interface ApplicationSummary { } export namespace ApplicationSummary { + /** + * @internal + */ export const filterSensitiveLog = (obj: ApplicationSummary): any => ({ ...obj, }); @@ -1407,6 +1560,9 @@ export interface CloudWatchLoggingOptionUpdate { } export namespace CloudWatchLoggingOptionUpdate { + /** + * @internal + */ export const filterSensitiveLog = (obj: CloudWatchLoggingOptionUpdate): any => ({ ...obj, }); @@ -1424,6 +1580,9 @@ export interface InputParallelismUpdate { } export namespace InputParallelismUpdate { + /** + * @internal + */ export const filterSensitiveLog = (obj: InputParallelismUpdate): any => ({ ...obj, }); @@ -1451,6 +1610,9 @@ export interface InputLambdaProcessorUpdate { } export namespace InputLambdaProcessorUpdate { + /** + * @internal + */ export const filterSensitiveLog = (obj: InputLambdaProcessorUpdate): any => ({ ...obj, }); @@ -1467,6 +1629,9 @@ export interface InputProcessingConfigurationUpdate { } export namespace InputProcessingConfigurationUpdate { + /** + * @internal + */ export const filterSensitiveLog = (obj: InputProcessingConfigurationUpdate): any => ({ ...obj, }); @@ -1494,6 +1659,9 @@ export interface InputSchemaUpdate { } export namespace InputSchemaUpdate { + /** + * @internal + */ export const filterSensitiveLog = (obj: InputSchemaUpdate): any => ({ ...obj, }); @@ -1518,6 +1686,9 @@ export interface KinesisFirehoseInputUpdate { } export namespace KinesisFirehoseInputUpdate { + /** + * @internal + */ export const filterSensitiveLog = (obj: KinesisFirehoseInputUpdate): any => ({ ...obj, }); @@ -1540,6 +1711,9 @@ export interface KinesisStreamsInputUpdate { } export namespace KinesisStreamsInputUpdate { + /** + * @internal + */ export const filterSensitiveLog = (obj: KinesisStreamsInputUpdate): any => ({ ...obj, }); @@ -1592,6 +1766,9 @@ export interface InputUpdate { } export namespace InputUpdate { + /** + * @internal + */ export const filterSensitiveLog = (obj: InputUpdate): any => ({ ...obj, }); @@ -1619,6 +1796,9 @@ export interface KinesisFirehoseOutputUpdate { } export namespace KinesisFirehoseOutputUpdate { + /** + * @internal + */ export const filterSensitiveLog = (obj: KinesisFirehoseOutputUpdate): any => ({ ...obj, }); @@ -1645,6 +1825,9 @@ export interface KinesisStreamsOutputUpdate { } export namespace KinesisStreamsOutputUpdate { + /** + * @internal + */ export const filterSensitiveLog = (obj: KinesisStreamsOutputUpdate): any => ({ ...obj, }); @@ -1672,6 +1855,9 @@ export interface LambdaOutputUpdate { } export namespace LambdaOutputUpdate { + /** + * @internal + */ export const filterSensitiveLog = (obj: LambdaOutputUpdate): any => ({ ...obj, }); @@ -1719,6 +1905,9 @@ export interface OutputUpdate { } export namespace OutputUpdate { + /** + * @internal + */ export const filterSensitiveLog = (obj: OutputUpdate): any => ({ ...obj, }); @@ -1745,6 +1934,9 @@ export interface S3ReferenceDataSourceUpdate { } export namespace S3ReferenceDataSourceUpdate { + /** + * @internal + */ export const filterSensitiveLog = (obj: S3ReferenceDataSourceUpdate): any => ({ ...obj, }); @@ -1777,6 +1969,9 @@ export interface ReferenceDataSourceUpdate { } export namespace ReferenceDataSourceUpdate { + /** + * @internal + */ export const filterSensitiveLog = (obj: ReferenceDataSourceUpdate): any => ({ ...obj, }); @@ -1813,6 +2008,9 @@ export interface ApplicationUpdate { } export namespace ApplicationUpdate { + /** + * @internal + */ export const filterSensitiveLog = (obj: ApplicationUpdate): any => ({ ...obj, }); @@ -1836,6 +2034,9 @@ export interface Tag { } export namespace Tag { + /** + * @internal + */ export const filterSensitiveLog = (obj: Tag): any => ({ ...obj, }); @@ -1913,6 +2114,9 @@ export interface CreateApplicationRequest { } export namespace CreateApplicationRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateApplicationRequest): any => ({ ...obj, }); @@ -1931,6 +2135,9 @@ export interface CreateApplicationResponse { } export namespace CreateApplicationResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateApplicationResponse): any => ({ ...obj, }); @@ -1949,6 +2156,9 @@ export interface LimitExceededException extends __SmithyException, $MetadataBear } export namespace LimitExceededException { + /** + * @internal + */ export const filterSensitiveLog = (obj: LimitExceededException): any => ({ ...obj, }); @@ -1964,6 +2174,9 @@ export interface TooManyTagsException extends __SmithyException, $MetadataBearer } export namespace TooManyTagsException { + /** + * @internal + */ export const filterSensitiveLog = (obj: TooManyTagsException): any => ({ ...obj, }); @@ -1987,6 +2200,9 @@ export interface DeleteApplicationRequest { } export namespace DeleteApplicationRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteApplicationRequest): any => ({ ...obj, }); @@ -1998,6 +2214,9 @@ export namespace DeleteApplicationRequest { export interface DeleteApplicationResponse {} export namespace DeleteApplicationResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteApplicationResponse): any => ({ ...obj, }); @@ -2022,6 +2241,9 @@ export interface DeleteApplicationCloudWatchLoggingOptionRequest { } export namespace DeleteApplicationCloudWatchLoggingOptionRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteApplicationCloudWatchLoggingOptionRequest): any => ({ ...obj, }); @@ -2030,6 +2252,9 @@ export namespace DeleteApplicationCloudWatchLoggingOptionRequest { export interface DeleteApplicationCloudWatchLoggingOptionResponse {} export namespace DeleteApplicationCloudWatchLoggingOptionResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteApplicationCloudWatchLoggingOptionResponse): any => ({ ...obj, }); @@ -2054,6 +2279,9 @@ export interface DeleteApplicationInputProcessingConfigurationRequest { } export namespace DeleteApplicationInputProcessingConfigurationRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteApplicationInputProcessingConfigurationRequest): any => ({ ...obj, }); @@ -2062,6 +2290,9 @@ export namespace DeleteApplicationInputProcessingConfigurationRequest { export interface DeleteApplicationInputProcessingConfigurationResponse {} export namespace DeleteApplicationInputProcessingConfigurationResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteApplicationInputProcessingConfigurationResponse): any => ({ ...obj, }); @@ -2099,6 +2330,9 @@ export interface DeleteApplicationOutputRequest { } export namespace DeleteApplicationOutputRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteApplicationOutputRequest): any => ({ ...obj, }); @@ -2110,6 +2344,9 @@ export namespace DeleteApplicationOutputRequest { export interface DeleteApplicationOutputResponse {} export namespace DeleteApplicationOutputResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteApplicationOutputResponse): any => ({ ...obj, }); @@ -2140,6 +2377,9 @@ export interface DeleteApplicationReferenceDataSourceRequest { } export namespace DeleteApplicationReferenceDataSourceRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteApplicationReferenceDataSourceRequest): any => ({ ...obj, }); @@ -2148,6 +2388,9 @@ export namespace DeleteApplicationReferenceDataSourceRequest { export interface DeleteApplicationReferenceDataSourceResponse {} export namespace DeleteApplicationReferenceDataSourceResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteApplicationReferenceDataSourceResponse): any => ({ ...obj, }); @@ -2164,6 +2407,9 @@ export interface DescribeApplicationRequest { } export namespace DescribeApplicationRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeApplicationRequest): any => ({ ...obj, }); @@ -2180,6 +2426,9 @@ export interface DescribeApplicationResponse { } export namespace DescribeApplicationResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeApplicationResponse): any => ({ ...obj, }); @@ -2208,6 +2457,9 @@ export interface S3Configuration { } export namespace S3Configuration { + /** + * @internal + */ export const filterSensitiveLog = (obj: S3Configuration): any => ({ ...obj, }); @@ -2242,6 +2494,9 @@ export interface DiscoverInputSchemaRequest { } export namespace DiscoverInputSchemaRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DiscoverInputSchemaRequest): any => ({ ...obj, }); @@ -2273,6 +2528,9 @@ export interface DiscoverInputSchemaResponse { } export namespace DiscoverInputSchemaResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DiscoverInputSchemaResponse): any => ({ ...obj, }); @@ -2292,6 +2550,9 @@ export interface ResourceProvisionedThroughputExceededException extends __Smithy } export namespace ResourceProvisionedThroughputExceededException { + /** + * @internal + */ export const filterSensitiveLog = (obj: ResourceProvisionedThroughputExceededException): any => ({ ...obj, }); @@ -2307,6 +2568,9 @@ export interface ServiceUnavailableException extends __SmithyException, $Metadat } export namespace ServiceUnavailableException { + /** + * @internal + */ export const filterSensitiveLog = (obj: ServiceUnavailableException): any => ({ ...obj, }); @@ -2325,6 +2589,9 @@ export interface UnableToDetectSchemaException extends __SmithyException, $Metad } export namespace UnableToDetectSchemaException { + /** + * @internal + */ export const filterSensitiveLog = (obj: UnableToDetectSchemaException): any => ({ ...obj, }); @@ -2350,6 +2617,9 @@ export interface InputConfiguration { } export namespace InputConfiguration { + /** + * @internal + */ export const filterSensitiveLog = (obj: InputConfiguration): any => ({ ...obj, }); @@ -2368,6 +2638,9 @@ export interface InvalidApplicationConfigurationException extends __SmithyExcept } export namespace InvalidApplicationConfigurationException { + /** + * @internal + */ export const filterSensitiveLog = (obj: InvalidApplicationConfigurationException): any => ({ ...obj, }); @@ -2389,6 +2662,9 @@ export interface ListApplicationsRequest { } export namespace ListApplicationsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListApplicationsRequest): any => ({ ...obj, }); @@ -2410,6 +2686,9 @@ export interface ListApplicationsResponse { } export namespace ListApplicationsResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListApplicationsResponse): any => ({ ...obj, }); @@ -2423,6 +2702,9 @@ export interface ListTagsForResourceRequest { } export namespace ListTagsForResourceRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListTagsForResourceRequest): any => ({ ...obj, }); @@ -2436,6 +2718,9 @@ export interface ListTagsForResourceResponse { } export namespace ListTagsForResourceResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListTagsForResourceResponse): any => ({ ...obj, }); @@ -2457,6 +2742,9 @@ export interface StartApplicationRequest { } export namespace StartApplicationRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: StartApplicationRequest): any => ({ ...obj, }); @@ -2468,6 +2756,9 @@ export namespace StartApplicationRequest { export interface StartApplicationResponse {} export namespace StartApplicationResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: StartApplicationResponse): any => ({ ...obj, }); @@ -2484,6 +2775,9 @@ export interface StopApplicationRequest { } export namespace StopApplicationRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: StopApplicationRequest): any => ({ ...obj, }); @@ -2495,6 +2789,9 @@ export namespace StopApplicationRequest { export interface StopApplicationResponse {} export namespace StopApplicationResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: StopApplicationResponse): any => ({ ...obj, }); @@ -2513,6 +2810,9 @@ export interface TagResourceRequest { } export namespace TagResourceRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: TagResourceRequest): any => ({ ...obj, }); @@ -2521,6 +2821,9 @@ export namespace TagResourceRequest { export interface TagResourceResponse {} export namespace TagResourceResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: TagResourceResponse): any => ({ ...obj, }); @@ -2539,6 +2842,9 @@ export interface UntagResourceRequest { } export namespace UntagResourceRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: UntagResourceRequest): any => ({ ...obj, }); @@ -2547,6 +2853,9 @@ export namespace UntagResourceRequest { export interface UntagResourceResponse {} export namespace UntagResourceResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: UntagResourceResponse): any => ({ ...obj, }); @@ -2571,6 +2880,9 @@ export interface UpdateApplicationRequest { } export namespace UpdateApplicationRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateApplicationRequest): any => ({ ...obj, }); @@ -2579,6 +2891,9 @@ export namespace UpdateApplicationRequest { export interface UpdateApplicationResponse {} export namespace UpdateApplicationResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateApplicationResponse): any => ({ ...obj, }); diff --git a/clients/client-kinesis-video-archived-media/commands/GetClipCommand.ts b/clients/client-kinesis-video-archived-media/commands/GetClipCommand.ts index 0009fc7955d6..4d28527c20e9 100644 --- a/clients/client-kinesis-video-archived-media/commands/GetClipCommand.ts +++ b/clients/client-kinesis-video-archived-media/commands/GetClipCommand.ts @@ -66,6 +66,20 @@ export interface GetClipCommandOutput extends GetClipOutput, __MetadataBearer {} * 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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { KinesisVideoArchivedMediaClient, GetClipCommand } from "@aws-sdk/client-kinesis-video-archived-media"; // ES Modules import + * // const { KinesisVideoArchivedMediaClient, GetClipCommand } = require("@aws-sdk/client-kinesis-video-archived-media"); // CommonJS import + * const client = new KinesisVideoArchivedMediaClient(config); + * const command = new GetClipCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetClipCommandInput} for command's `input` shape. + * @see {@link GetClipCommandOutput} for command's `response` shape. + * @see {@link KinesisVideoArchivedMediaClientResolvedConfig | config} for command's `input` shape. + * */ export class GetClipCommand extends $Command< GetClipCommandInput, diff --git a/clients/client-kinesis-video-archived-media/commands/GetDASHStreamingSessionURLCommand.ts b/clients/client-kinesis-video-archived-media/commands/GetDASHStreamingSessionURLCommand.ts index 3d5d33aa0432..5eb57cbafc40 100644 --- a/clients/client-kinesis-video-archived-media/commands/GetDASHStreamingSessionURLCommand.ts +++ b/clients/client-kinesis-video-archived-media/commands/GetDASHStreamingSessionURLCommand.ts @@ -172,6 +172,20 @@ export interface GetDASHStreamingSessionURLCommandOutput extends GetDASHStreamin * the bottom of this topic, as well as Common Errors. *

* + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { KinesisVideoArchivedMediaClient, GetDASHStreamingSessionURLCommand } from "@aws-sdk/client-kinesis-video-archived-media"; // ES Modules import + * // const { KinesisVideoArchivedMediaClient, GetDASHStreamingSessionURLCommand } = require("@aws-sdk/client-kinesis-video-archived-media"); // CommonJS import + * const client = new KinesisVideoArchivedMediaClient(config); + * const command = new GetDASHStreamingSessionURLCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetDASHStreamingSessionURLCommandInput} for command's `input` shape. + * @see {@link GetDASHStreamingSessionURLCommandOutput} for command's `response` shape. + * @see {@link KinesisVideoArchivedMediaClientResolvedConfig | config} for command's `input` shape. + * */ export class GetDASHStreamingSessionURLCommand extends $Command< GetDASHStreamingSessionURLCommandInput, diff --git a/clients/client-kinesis-video-archived-media/commands/GetHLSStreamingSessionURLCommand.ts b/clients/client-kinesis-video-archived-media/commands/GetHLSStreamingSessionURLCommand.ts index 1d29f01a9a94..39d2b3059a42 100644 --- a/clients/client-kinesis-video-archived-media/commands/GetHLSStreamingSessionURLCommand.ts +++ b/clients/client-kinesis-video-archived-media/commands/GetHLSStreamingSessionURLCommand.ts @@ -205,6 +205,20 @@ export interface GetHLSStreamingSessionURLCommandOutput extends GetHLSStreamingS * the bottom of this topic, as well as Common Errors. *

* + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { KinesisVideoArchivedMediaClient, GetHLSStreamingSessionURLCommand } from "@aws-sdk/client-kinesis-video-archived-media"; // ES Modules import + * // const { KinesisVideoArchivedMediaClient, GetHLSStreamingSessionURLCommand } = require("@aws-sdk/client-kinesis-video-archived-media"); // CommonJS import + * const client = new KinesisVideoArchivedMediaClient(config); + * const command = new GetHLSStreamingSessionURLCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetHLSStreamingSessionURLCommandInput} for command's `input` shape. + * @see {@link GetHLSStreamingSessionURLCommandOutput} for command's `response` shape. + * @see {@link KinesisVideoArchivedMediaClientResolvedConfig | config} for command's `input` shape. + * */ export class GetHLSStreamingSessionURLCommand extends $Command< GetHLSStreamingSessionURLCommandInput, diff --git a/clients/client-kinesis-video-archived-media/commands/GetMediaForFragmentListCommand.ts b/clients/client-kinesis-video-archived-media/commands/GetMediaForFragmentListCommand.ts index 1ac1b46c9299..1dd1c0d07f81 100644 --- a/clients/client-kinesis-video-archived-media/commands/GetMediaForFragmentListCommand.ts +++ b/clients/client-kinesis-video-archived-media/commands/GetMediaForFragmentListCommand.ts @@ -62,6 +62,20 @@ export interface GetMediaForFragmentListCommandOutput extends GetMediaForFragmen * the bottom of this topic, as well as Common Errors. *

* + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { KinesisVideoArchivedMediaClient, GetMediaForFragmentListCommand } from "@aws-sdk/client-kinesis-video-archived-media"; // ES Modules import + * // const { KinesisVideoArchivedMediaClient, GetMediaForFragmentListCommand } = require("@aws-sdk/client-kinesis-video-archived-media"); // CommonJS import + * const client = new KinesisVideoArchivedMediaClient(config); + * const command = new GetMediaForFragmentListCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetMediaForFragmentListCommandInput} for command's `input` shape. + * @see {@link GetMediaForFragmentListCommandOutput} for command's `response` shape. + * @see {@link KinesisVideoArchivedMediaClientResolvedConfig | config} for command's `input` shape. + * */ export class GetMediaForFragmentListCommand extends $Command< GetMediaForFragmentListCommandInput, diff --git a/clients/client-kinesis-video-archived-media/commands/ListFragmentsCommand.ts b/clients/client-kinesis-video-archived-media/commands/ListFragmentsCommand.ts index 92d8c70aff70..87e1762ddf11 100644 --- a/clients/client-kinesis-video-archived-media/commands/ListFragmentsCommand.ts +++ b/clients/client-kinesis-video-archived-media/commands/ListFragmentsCommand.ts @@ -62,6 +62,20 @@ export interface ListFragmentsCommandOutput extends ListFragmentsOutput, __Metad * the bottom of this topic, as well as Common Errors. *

* + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { KinesisVideoArchivedMediaClient, ListFragmentsCommand } from "@aws-sdk/client-kinesis-video-archived-media"; // ES Modules import + * // const { KinesisVideoArchivedMediaClient, ListFragmentsCommand } = require("@aws-sdk/client-kinesis-video-archived-media"); // CommonJS import + * const client = new KinesisVideoArchivedMediaClient(config); + * const command = new ListFragmentsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListFragmentsCommandInput} for command's `input` shape. + * @see {@link ListFragmentsCommandOutput} for command's `response` shape. + * @see {@link KinesisVideoArchivedMediaClientResolvedConfig | config} for command's `input` shape. + * */ export class ListFragmentsCommand extends $Command< ListFragmentsCommandInput, diff --git a/clients/client-kinesis-video-archived-media/models/models_0.ts b/clients/client-kinesis-video-archived-media/models/models_0.ts index f5992ad9aec4..1631b9c7e02a 100644 --- a/clients/client-kinesis-video-archived-media/models/models_0.ts +++ b/clients/client-kinesis-video-archived-media/models/models_0.ts @@ -12,6 +12,9 @@ export interface ClientLimitExceededException extends __SmithyException, $Metada } export namespace ClientLimitExceededException { + /** + * @internal + */ export const filterSensitiveLog = (obj: ClientLimitExceededException): any => ({ ...obj, }); @@ -50,6 +53,9 @@ export interface ClipTimestampRange { } export namespace ClipTimestampRange { + /** + * @internal + */ export const filterSensitiveLog = (obj: ClipTimestampRange): any => ({ ...obj, }); @@ -77,6 +83,9 @@ export interface ClipFragmentSelector { } export namespace ClipFragmentSelector { + /** + * @internal + */ export const filterSensitiveLog = (obj: ClipFragmentSelector): any => ({ ...obj, }); @@ -102,6 +111,9 @@ export interface GetClipInput { } export namespace GetClipInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetClipInput): any => ({ ...obj, }); @@ -123,6 +135,9 @@ export interface GetClipOutput { } export namespace GetClipOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetClipOutput): any => ({ ...obj, }); @@ -139,6 +154,9 @@ export interface InvalidArgumentException extends __SmithyException, $MetadataBe } export namespace InvalidArgumentException { + /** + * @internal + */ export const filterSensitiveLog = (obj: InvalidArgumentException): any => ({ ...obj, }); @@ -155,6 +173,9 @@ export interface InvalidCodecPrivateDataException extends __SmithyException, $Me } export namespace InvalidCodecPrivateDataException { + /** + * @internal + */ export const filterSensitiveLog = (obj: InvalidCodecPrivateDataException): any => ({ ...obj, }); @@ -171,6 +192,9 @@ export interface InvalidMediaFrameException extends __SmithyException, $Metadata } export namespace InvalidMediaFrameException { + /** + * @internal + */ export const filterSensitiveLog = (obj: InvalidMediaFrameException): any => ({ ...obj, }); @@ -186,6 +210,9 @@ export interface MissingCodecPrivateDataException extends __SmithyException, $Me } export namespace MissingCodecPrivateDataException { + /** + * @internal + */ export const filterSensitiveLog = (obj: MissingCodecPrivateDataException): any => ({ ...obj, }); @@ -202,6 +229,9 @@ export interface NoDataRetentionException extends __SmithyException, $MetadataBe } export namespace NoDataRetentionException { + /** + * @internal + */ export const filterSensitiveLog = (obj: NoDataRetentionException): any => ({ ...obj, }); @@ -218,6 +248,9 @@ export interface NotAuthorizedException extends __SmithyException, $MetadataBear } export namespace NotAuthorizedException { + /** + * @internal + */ export const filterSensitiveLog = (obj: NotAuthorizedException): any => ({ ...obj, }); @@ -242,6 +275,9 @@ export interface ResourceNotFoundException extends __SmithyException, $MetadataB } export namespace ResourceNotFoundException { + /** + * @internal + */ export const filterSensitiveLog = (obj: ResourceNotFoundException): any => ({ ...obj, }); @@ -260,6 +296,9 @@ export interface UnsupportedStreamMediaTypeException extends __SmithyException, } export namespace UnsupportedStreamMediaTypeException { + /** + * @internal + */ export const filterSensitiveLog = (obj: UnsupportedStreamMediaTypeException): any => ({ ...obj, }); @@ -313,6 +352,9 @@ export interface DASHTimestampRange { } export namespace DASHTimestampRange { + /** + * @internal + */ export const filterSensitiveLog = (obj: DASHTimestampRange): any => ({ ...obj, }); @@ -357,6 +399,9 @@ export interface DASHFragmentSelector { } export namespace DASHFragmentSelector { + /** + * @internal + */ export const filterSensitiveLog = (obj: DASHFragmentSelector): any => ({ ...obj, }); @@ -531,6 +576,9 @@ export interface GetDASHStreamingSessionURLInput { } export namespace GetDASHStreamingSessionURLInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetDASHStreamingSessionURLInput): any => ({ ...obj, }); @@ -545,6 +593,9 @@ export interface GetDASHStreamingSessionURLOutput { } export namespace GetDASHStreamingSessionURLOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetDASHStreamingSessionURLOutput): any => ({ ...obj, }); @@ -610,6 +661,9 @@ export interface HLSTimestampRange { } export namespace HLSTimestampRange { + /** + * @internal + */ export const filterSensitiveLog = (obj: HLSTimestampRange): any => ({ ...obj, }); @@ -654,6 +708,9 @@ export interface HLSFragmentSelector { } export namespace HLSFragmentSelector { + /** + * @internal + */ export const filterSensitiveLog = (obj: HLSFragmentSelector): any => ({ ...obj, }); @@ -859,6 +916,9 @@ export interface GetHLSStreamingSessionURLInput { } export namespace GetHLSStreamingSessionURLInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetHLSStreamingSessionURLInput): any => ({ ...obj, }); @@ -873,6 +933,9 @@ export interface GetHLSStreamingSessionURLOutput { } export namespace GetHLSStreamingSessionURLOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetHLSStreamingSessionURLOutput): any => ({ ...obj, }); @@ -897,6 +960,9 @@ export interface GetMediaForFragmentListInput { } export namespace GetMediaForFragmentListInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetMediaForFragmentListInput): any => ({ ...obj, }); @@ -947,6 +1013,9 @@ export interface GetMediaForFragmentListOutput { } export namespace GetMediaForFragmentListOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetMediaForFragmentListOutput): any => ({ ...obj, }); @@ -974,6 +1043,9 @@ export interface TimestampRange { } export namespace TimestampRange { + /** + * @internal + */ export const filterSensitiveLog = (obj: TimestampRange): any => ({ ...obj, }); @@ -1014,6 +1086,9 @@ export interface FragmentSelector { } export namespace FragmentSelector { + /** + * @internal + */ export const filterSensitiveLog = (obj: FragmentSelector): any => ({ ...obj, }); @@ -1051,6 +1126,9 @@ export interface ListFragmentsInput { } export namespace ListFragmentsInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListFragmentsInput): any => ({ ...obj, }); @@ -1089,6 +1167,9 @@ export interface Fragment { } export namespace Fragment { + /** + * @internal + */ export const filterSensitiveLog = (obj: Fragment): any => ({ ...obj, }); @@ -1110,6 +1191,9 @@ export interface ListFragmentsOutput { } export namespace ListFragmentsOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListFragmentsOutput): any => ({ ...obj, }); diff --git a/clients/client-kinesis-video-media/commands/GetMediaCommand.ts b/clients/client-kinesis-video-media/commands/GetMediaCommand.ts index d05f3f7ea07c..d663680f6d01 100644 --- a/clients/client-kinesis-video-media/commands/GetMediaCommand.ts +++ b/clients/client-kinesis-video-media/commands/GetMediaCommand.ts @@ -71,6 +71,20 @@ export interface GetMediaCommandOutput extends GetMediaOutput, __MetadataBearer *

For more information, see the Errors section at the * bottom of this topic, as well as Common Errors.

* + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { KinesisVideoMediaClient, GetMediaCommand } from "@aws-sdk/client-kinesis-video-media"; // ES Modules import + * // const { KinesisVideoMediaClient, GetMediaCommand } = require("@aws-sdk/client-kinesis-video-media"); // CommonJS import + * const client = new KinesisVideoMediaClient(config); + * const command = new GetMediaCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetMediaCommandInput} for command's `input` shape. + * @see {@link GetMediaCommandOutput} for command's `response` shape. + * @see {@link KinesisVideoMediaClientResolvedConfig | config} for command's `input` shape. + * */ export class GetMediaCommand extends $Command< GetMediaCommandInput, diff --git a/clients/client-kinesis-video-media/models/models_0.ts b/clients/client-kinesis-video-media/models/models_0.ts index a854f6e071fc..953680b72e65 100644 --- a/clients/client-kinesis-video-media/models/models_0.ts +++ b/clients/client-kinesis-video-media/models/models_0.ts @@ -13,6 +13,9 @@ export interface ClientLimitExceededException extends __SmithyException, $Metada } export namespace ClientLimitExceededException { + /** + * @internal + */ export const filterSensitiveLog = (obj: ClientLimitExceededException): any => ({ ...obj, }); @@ -29,6 +32,9 @@ export interface ConnectionLimitExceededException extends __SmithyException, $Me } export namespace ConnectionLimitExceededException { + /** + * @internal + */ export const filterSensitiveLog = (obj: ConnectionLimitExceededException): any => ({ ...obj, }); @@ -118,6 +124,9 @@ export interface StartSelector { } export namespace StartSelector { + /** + * @internal + */ export const filterSensitiveLog = (obj: StartSelector): any => ({ ...obj, }); @@ -144,6 +153,9 @@ export interface GetMediaInput { } export namespace GetMediaInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetMediaInput): any => ({ ...obj, }); @@ -229,6 +241,9 @@ export interface GetMediaOutput { } export namespace GetMediaOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetMediaOutput): any => ({ ...obj, }); @@ -244,6 +259,9 @@ export interface InvalidArgumentException extends __SmithyException, $MetadataBe } export namespace InvalidArgumentException { + /** + * @internal + */ export const filterSensitiveLog = (obj: InvalidArgumentException): any => ({ ...obj, }); @@ -262,6 +280,9 @@ export interface InvalidEndpointException extends __SmithyException, $MetadataBe } export namespace InvalidEndpointException { + /** + * @internal + */ export const filterSensitiveLog = (obj: InvalidEndpointException): any => ({ ...obj, }); @@ -278,6 +299,9 @@ export interface NotAuthorizedException extends __SmithyException, $MetadataBear } export namespace NotAuthorizedException { + /** + * @internal + */ export const filterSensitiveLog = (obj: NotAuthorizedException): any => ({ ...obj, }); @@ -293,6 +317,9 @@ export interface ResourceNotFoundException extends __SmithyException, $MetadataB } export namespace ResourceNotFoundException { + /** + * @internal + */ export const filterSensitiveLog = (obj: ResourceNotFoundException): any => ({ ...obj, }); diff --git a/clients/client-kinesis-video-signaling/commands/GetIceServerConfigCommand.ts b/clients/client-kinesis-video-signaling/commands/GetIceServerConfigCommand.ts index 75d6f68db8eb..44054bcb2867 100644 --- a/clients/client-kinesis-video-signaling/commands/GetIceServerConfigCommand.ts +++ b/clients/client-kinesis-video-signaling/commands/GetIceServerConfigCommand.ts @@ -39,6 +39,20 @@ export interface GetIceServerConfigCommandOutput extends GetIceServerConfigRespo * 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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { KinesisVideoSignalingClient, GetIceServerConfigCommand } from "@aws-sdk/client-kinesis-video-signaling"; // ES Modules import + * // const { KinesisVideoSignalingClient, GetIceServerConfigCommand } = require("@aws-sdk/client-kinesis-video-signaling"); // CommonJS import + * const client = new KinesisVideoSignalingClient(config); + * const command = new GetIceServerConfigCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetIceServerConfigCommandInput} for command's `input` shape. + * @see {@link GetIceServerConfigCommandOutput} for command's `response` shape. + * @see {@link KinesisVideoSignalingClientResolvedConfig | config} for command's `input` shape. + * */ export class GetIceServerConfigCommand extends $Command< GetIceServerConfigCommandInput, diff --git a/clients/client-kinesis-video-signaling/commands/SendAlexaOfferToMasterCommand.ts b/clients/client-kinesis-video-signaling/commands/SendAlexaOfferToMasterCommand.ts index 1818922caf24..9df78b7f9cec 100644 --- a/clients/client-kinesis-video-signaling/commands/SendAlexaOfferToMasterCommand.ts +++ b/clients/client-kinesis-video-signaling/commands/SendAlexaOfferToMasterCommand.ts @@ -31,6 +31,20 @@ export interface SendAlexaOfferToMasterCommandOutput extends SendAlexaOfferToMas * 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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { KinesisVideoSignalingClient, SendAlexaOfferToMasterCommand } from "@aws-sdk/client-kinesis-video-signaling"; // ES Modules import + * // const { KinesisVideoSignalingClient, SendAlexaOfferToMasterCommand } = require("@aws-sdk/client-kinesis-video-signaling"); // CommonJS import + * const client = new KinesisVideoSignalingClient(config); + * const command = new SendAlexaOfferToMasterCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link SendAlexaOfferToMasterCommandInput} for command's `input` shape. + * @see {@link SendAlexaOfferToMasterCommandOutput} for command's `response` shape. + * @see {@link KinesisVideoSignalingClientResolvedConfig | config} for command's `input` shape. + * */ export class SendAlexaOfferToMasterCommand extends $Command< SendAlexaOfferToMasterCommandInput, diff --git a/clients/client-kinesis-video-signaling/models/models_0.ts b/clients/client-kinesis-video-signaling/models/models_0.ts index 3633024c33b0..b27867b7bdb3 100644 --- a/clients/client-kinesis-video-signaling/models/models_0.ts +++ b/clients/client-kinesis-video-signaling/models/models_0.ts @@ -12,6 +12,9 @@ export interface ClientLimitExceededException extends __SmithyException, $Metada } export namespace ClientLimitExceededException { + /** + * @internal + */ export const filterSensitiveLog = (obj: ClientLimitExceededException): any => ({ ...obj, }); @@ -46,6 +49,9 @@ export interface GetIceServerConfigRequest { } export namespace GetIceServerConfigRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetIceServerConfigRequest): any => ({ ...obj, }); @@ -79,6 +85,9 @@ export interface IceServer { } export namespace IceServer { + /** + * @internal + */ export const filterSensitiveLog = (obj: IceServer): any => ({ ...obj, }); @@ -92,6 +101,9 @@ export interface GetIceServerConfigResponse { } export namespace GetIceServerConfigResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetIceServerConfigResponse): any => ({ ...obj, }); @@ -107,6 +119,9 @@ export interface InvalidArgumentException extends __SmithyException, $MetadataBe } export namespace InvalidArgumentException { + /** + * @internal + */ export const filterSensitiveLog = (obj: InvalidArgumentException): any => ({ ...obj, }); @@ -122,6 +137,9 @@ export interface InvalidClientException extends __SmithyException, $MetadataBear } export namespace InvalidClientException { + /** + * @internal + */ export const filterSensitiveLog = (obj: InvalidClientException): any => ({ ...obj, }); @@ -137,6 +155,9 @@ export interface NotAuthorizedException extends __SmithyException, $MetadataBear } export namespace NotAuthorizedException { + /** + * @internal + */ export const filterSensitiveLog = (obj: NotAuthorizedException): any => ({ ...obj, }); @@ -152,6 +173,9 @@ export interface ResourceNotFoundException extends __SmithyException, $MetadataB } export namespace ResourceNotFoundException { + /** + * @internal + */ export const filterSensitiveLog = (obj: ResourceNotFoundException): any => ({ ...obj, }); @@ -169,6 +193,9 @@ export interface SessionExpiredException extends __SmithyException, $MetadataBea } export namespace SessionExpiredException { + /** + * @internal + */ export const filterSensitiveLog = (obj: SessionExpiredException): any => ({ ...obj, }); @@ -193,6 +220,9 @@ export interface SendAlexaOfferToMasterRequest { } export namespace SendAlexaOfferToMasterRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: SendAlexaOfferToMasterRequest): any => ({ ...obj, }); @@ -206,6 +236,9 @@ export interface SendAlexaOfferToMasterResponse { } export namespace SendAlexaOfferToMasterResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: SendAlexaOfferToMasterResponse): any => ({ ...obj, }); diff --git a/clients/client-kinesis-video/commands/CreateSignalingChannelCommand.ts b/clients/client-kinesis-video/commands/CreateSignalingChannelCommand.ts index 8ed53939f840..c0730df69a35 100644 --- a/clients/client-kinesis-video/commands/CreateSignalingChannelCommand.ts +++ b/clients/client-kinesis-video/commands/CreateSignalingChannelCommand.ts @@ -24,6 +24,20 @@ export interface CreateSignalingChannelCommandOutput extends CreateSignalingChan *

Creates a signaling channel.

*

* CreateSignalingChannel is an asynchronous operation.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { KinesisVideoClient, CreateSignalingChannelCommand } from "@aws-sdk/client-kinesis-video"; // ES Modules import + * // const { KinesisVideoClient, CreateSignalingChannelCommand } = require("@aws-sdk/client-kinesis-video"); // CommonJS import + * const client = new KinesisVideoClient(config); + * const command = new CreateSignalingChannelCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreateSignalingChannelCommandInput} for command's `input` shape. + * @see {@link CreateSignalingChannelCommandOutput} for command's `response` shape. + * @see {@link KinesisVideoClientResolvedConfig | config} for command's `input` shape. + * */ export class CreateSignalingChannelCommand extends $Command< CreateSignalingChannelCommandInput, diff --git a/clients/client-kinesis-video/commands/CreateStreamCommand.ts b/clients/client-kinesis-video/commands/CreateStreamCommand.ts index 6c37d4660577..a9d47a8c922a 100644 --- a/clients/client-kinesis-video/commands/CreateStreamCommand.ts +++ b/clients/client-kinesis-video/commands/CreateStreamCommand.ts @@ -30,6 +30,20 @@ export interface CreateStreamCommandOutput extends CreateStreamOutput, __Metadat *

For information about how the service works, see How it Works.

*

You must have permissions for the KinesisVideo:CreateStream * action.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { KinesisVideoClient, CreateStreamCommand } from "@aws-sdk/client-kinesis-video"; // ES Modules import + * // const { KinesisVideoClient, CreateStreamCommand } = require("@aws-sdk/client-kinesis-video"); // CommonJS import + * const client = new KinesisVideoClient(config); + * const command = new CreateStreamCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreateStreamCommandInput} for command's `input` shape. + * @see {@link CreateStreamCommandOutput} for command's `response` shape. + * @see {@link KinesisVideoClientResolvedConfig | config} for command's `input` shape. + * */ export class CreateStreamCommand extends $Command< CreateStreamCommandInput, diff --git a/clients/client-kinesis-video/commands/DeleteSignalingChannelCommand.ts b/clients/client-kinesis-video/commands/DeleteSignalingChannelCommand.ts index 883403437729..1dbfa20cfdca 100644 --- a/clients/client-kinesis-video/commands/DeleteSignalingChannelCommand.ts +++ b/clients/client-kinesis-video/commands/DeleteSignalingChannelCommand.ts @@ -24,6 +24,20 @@ export interface DeleteSignalingChannelCommandOutput extends DeleteSignalingChan *

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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { KinesisVideoClient, DeleteSignalingChannelCommand } from "@aws-sdk/client-kinesis-video"; // ES Modules import + * // const { KinesisVideoClient, DeleteSignalingChannelCommand } = require("@aws-sdk/client-kinesis-video"); // CommonJS import + * const client = new KinesisVideoClient(config); + * const command = new DeleteSignalingChannelCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteSignalingChannelCommandInput} for command's `input` shape. + * @see {@link DeleteSignalingChannelCommandOutput} for command's `response` shape. + * @see {@link KinesisVideoClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteSignalingChannelCommand extends $Command< DeleteSignalingChannelCommandInput, diff --git a/clients/client-kinesis-video/commands/DeleteStreamCommand.ts b/clients/client-kinesis-video/commands/DeleteStreamCommand.ts index 5a50f46bdfe2..514767b47142 100644 --- a/clients/client-kinesis-video/commands/DeleteStreamCommand.ts +++ b/clients/client-kinesis-video/commands/DeleteStreamCommand.ts @@ -31,6 +31,20 @@ export interface DeleteStreamCommandOutput extends DeleteStreamOutput, __Metadat * latest stream version, use the DescribeStream API.

*

This operation requires permission for the KinesisVideo:DeleteStream * action.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { KinesisVideoClient, DeleteStreamCommand } from "@aws-sdk/client-kinesis-video"; // ES Modules import + * // const { KinesisVideoClient, DeleteStreamCommand } = require("@aws-sdk/client-kinesis-video"); // CommonJS import + * const client = new KinesisVideoClient(config); + * const command = new DeleteStreamCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteStreamCommandInput} for command's `input` shape. + * @see {@link DeleteStreamCommandOutput} for command's `response` shape. + * @see {@link KinesisVideoClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteStreamCommand extends $Command< DeleteStreamCommandInput, diff --git a/clients/client-kinesis-video/commands/DescribeSignalingChannelCommand.ts b/clients/client-kinesis-video/commands/DescribeSignalingChannelCommand.ts index 2209fbbbe2b1..b10b7437c5bb 100644 --- a/clients/client-kinesis-video/commands/DescribeSignalingChannelCommand.ts +++ b/clients/client-kinesis-video/commands/DescribeSignalingChannelCommand.ts @@ -24,6 +24,20 @@ export interface DescribeSignalingChannelCommandOutput extends DescribeSignaling *

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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { KinesisVideoClient, DescribeSignalingChannelCommand } from "@aws-sdk/client-kinesis-video"; // ES Modules import + * // const { KinesisVideoClient, DescribeSignalingChannelCommand } = require("@aws-sdk/client-kinesis-video"); // CommonJS import + * const client = new KinesisVideoClient(config); + * const command = new DescribeSignalingChannelCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeSignalingChannelCommandInput} for command's `input` shape. + * @see {@link DescribeSignalingChannelCommandOutput} for command's `response` shape. + * @see {@link KinesisVideoClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeSignalingChannelCommand extends $Command< DescribeSignalingChannelCommandInput, diff --git a/clients/client-kinesis-video/commands/DescribeStreamCommand.ts b/clients/client-kinesis-video/commands/DescribeStreamCommand.ts index eaa3f13b4c8a..e1db1143b9e8 100644 --- a/clients/client-kinesis-video/commands/DescribeStreamCommand.ts +++ b/clients/client-kinesis-video/commands/DescribeStreamCommand.ts @@ -23,6 +23,20 @@ export interface DescribeStreamCommandOutput extends DescribeStreamOutput, __Met /** *

Returns the most current information about the specified stream. You must specify * either the StreamName or the StreamARN.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { KinesisVideoClient, DescribeStreamCommand } from "@aws-sdk/client-kinesis-video"; // ES Modules import + * // const { KinesisVideoClient, DescribeStreamCommand } = require("@aws-sdk/client-kinesis-video"); // CommonJS import + * const client = new KinesisVideoClient(config); + * const command = new DescribeStreamCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeStreamCommandInput} for command's `input` shape. + * @see {@link DescribeStreamCommandOutput} for command's `response` shape. + * @see {@link KinesisVideoClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeStreamCommand extends $Command< DescribeStreamCommandInput, diff --git a/clients/client-kinesis-video/commands/GetDataEndpointCommand.ts b/clients/client-kinesis-video/commands/GetDataEndpointCommand.ts index 9a22c2d8f7dd..44dbd806cacd 100644 --- a/clients/client-kinesis-video/commands/GetDataEndpointCommand.ts +++ b/clients/client-kinesis-video/commands/GetDataEndpointCommand.ts @@ -33,6 +33,20 @@ export interface GetDataEndpointCommandOutput extends GetDataEndpointOutput, __M * *

In the request, specify the stream either by StreamName or * StreamARN.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { KinesisVideoClient, GetDataEndpointCommand } from "@aws-sdk/client-kinesis-video"; // ES Modules import + * // const { KinesisVideoClient, GetDataEndpointCommand } = require("@aws-sdk/client-kinesis-video"); // CommonJS import + * const client = new KinesisVideoClient(config); + * const command = new GetDataEndpointCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetDataEndpointCommandInput} for command's `input` shape. + * @see {@link GetDataEndpointCommandOutput} for command's `response` shape. + * @see {@link KinesisVideoClientResolvedConfig | config} for command's `input` shape. + * */ export class GetDataEndpointCommand extends $Command< GetDataEndpointCommandInput, diff --git a/clients/client-kinesis-video/commands/GetSignalingChannelEndpointCommand.ts b/clients/client-kinesis-video/commands/GetSignalingChannelEndpointCommand.ts index 685b423cfc32..319955af1104 100644 --- a/clients/client-kinesis-video/commands/GetSignalingChannelEndpointCommand.ts +++ b/clients/client-kinesis-video/commands/GetSignalingChannelEndpointCommand.ts @@ -35,6 +35,20 @@ export interface GetSignalingChannelEndpointCommandOutput extends GetSignalingCh * 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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { KinesisVideoClient, GetSignalingChannelEndpointCommand } from "@aws-sdk/client-kinesis-video"; // ES Modules import + * // const { KinesisVideoClient, GetSignalingChannelEndpointCommand } = require("@aws-sdk/client-kinesis-video"); // CommonJS import + * const client = new KinesisVideoClient(config); + * const command = new GetSignalingChannelEndpointCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetSignalingChannelEndpointCommandInput} for command's `input` shape. + * @see {@link GetSignalingChannelEndpointCommandOutput} for command's `response` shape. + * @see {@link KinesisVideoClientResolvedConfig | config} for command's `input` shape. + * */ export class GetSignalingChannelEndpointCommand extends $Command< GetSignalingChannelEndpointCommandInput, diff --git a/clients/client-kinesis-video/commands/ListSignalingChannelsCommand.ts b/clients/client-kinesis-video/commands/ListSignalingChannelsCommand.ts index 668e596b1a76..0de7ae1424b6 100644 --- a/clients/client-kinesis-video/commands/ListSignalingChannelsCommand.ts +++ b/clients/client-kinesis-video/commands/ListSignalingChannelsCommand.ts @@ -24,6 +24,20 @@ export interface ListSignalingChannelsCommandOutput extends ListSignalingChannel *

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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { KinesisVideoClient, ListSignalingChannelsCommand } from "@aws-sdk/client-kinesis-video"; // ES Modules import + * // const { KinesisVideoClient, ListSignalingChannelsCommand } = require("@aws-sdk/client-kinesis-video"); // CommonJS import + * const client = new KinesisVideoClient(config); + * const command = new ListSignalingChannelsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListSignalingChannelsCommandInput} for command's `input` shape. + * @see {@link ListSignalingChannelsCommandOutput} for command's `response` shape. + * @see {@link KinesisVideoClientResolvedConfig | config} for command's `input` shape. + * */ export class ListSignalingChannelsCommand extends $Command< ListSignalingChannelsCommandInput, diff --git a/clients/client-kinesis-video/commands/ListStreamsCommand.ts b/clients/client-kinesis-video/commands/ListStreamsCommand.ts index 288b76bb22a0..3405baccb7b7 100644 --- a/clients/client-kinesis-video/commands/ListStreamsCommand.ts +++ b/clients/client-kinesis-video/commands/ListStreamsCommand.ts @@ -24,6 +24,20 @@ export interface ListStreamsCommandOutput extends ListStreamsOutput, __MetadataB *

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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { KinesisVideoClient, ListStreamsCommand } from "@aws-sdk/client-kinesis-video"; // ES Modules import + * // const { KinesisVideoClient, ListStreamsCommand } = require("@aws-sdk/client-kinesis-video"); // CommonJS import + * const client = new KinesisVideoClient(config); + * const command = new ListStreamsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListStreamsCommandInput} for command's `input` shape. + * @see {@link ListStreamsCommandOutput} for command's `response` shape. + * @see {@link KinesisVideoClientResolvedConfig | config} for command's `input` shape. + * */ export class ListStreamsCommand extends $Command< ListStreamsCommandInput, diff --git a/clients/client-kinesis-video/commands/ListTagsForResourceCommand.ts b/clients/client-kinesis-video/commands/ListTagsForResourceCommand.ts index c34c60607025..f4382e62311e 100644 --- a/clients/client-kinesis-video/commands/ListTagsForResourceCommand.ts +++ b/clients/client-kinesis-video/commands/ListTagsForResourceCommand.ts @@ -22,6 +22,20 @@ export interface ListTagsForResourceCommandOutput extends ListTagsForResourceOut /** *

Returns a list of tags associated with the specified signaling channel.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { KinesisVideoClient, ListTagsForResourceCommand } from "@aws-sdk/client-kinesis-video"; // ES Modules import + * // const { KinesisVideoClient, ListTagsForResourceCommand } = require("@aws-sdk/client-kinesis-video"); // CommonJS import + * const client = new KinesisVideoClient(config); + * const command = new ListTagsForResourceCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListTagsForResourceCommandInput} for command's `input` shape. + * @see {@link ListTagsForResourceCommandOutput} for command's `response` shape. + * @see {@link KinesisVideoClientResolvedConfig | config} for command's `input` shape. + * */ export class ListTagsForResourceCommand extends $Command< ListTagsForResourceCommandInput, diff --git a/clients/client-kinesis-video/commands/ListTagsForStreamCommand.ts b/clients/client-kinesis-video/commands/ListTagsForStreamCommand.ts index a8837e7e13e2..bc450bcc96e9 100644 --- a/clients/client-kinesis-video/commands/ListTagsForStreamCommand.ts +++ b/clients/client-kinesis-video/commands/ListTagsForStreamCommand.ts @@ -24,6 +24,20 @@ export interface ListTagsForStreamCommandOutput extends ListTagsForStreamOutput, *

Returns a list of tags associated with the specified stream.

*

In the request, you must specify either the StreamName or the * StreamARN.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { KinesisVideoClient, ListTagsForStreamCommand } from "@aws-sdk/client-kinesis-video"; // ES Modules import + * // const { KinesisVideoClient, ListTagsForStreamCommand } = require("@aws-sdk/client-kinesis-video"); // CommonJS import + * const client = new KinesisVideoClient(config); + * const command = new ListTagsForStreamCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListTagsForStreamCommandInput} for command's `input` shape. + * @see {@link ListTagsForStreamCommandOutput} for command's `response` shape. + * @see {@link KinesisVideoClientResolvedConfig | config} for command's `input` shape. + * */ export class ListTagsForStreamCommand extends $Command< ListTagsForStreamCommandInput, diff --git a/clients/client-kinesis-video/commands/TagResourceCommand.ts b/clients/client-kinesis-video/commands/TagResourceCommand.ts index e2642297d003..a464ccbd93bb 100644 --- a/clients/client-kinesis-video/commands/TagResourceCommand.ts +++ b/clients/client-kinesis-video/commands/TagResourceCommand.ts @@ -27,6 +27,20 @@ export interface TagResourceCommandOutput extends TagResourceOutput, __MetadataB * you specify in the request. For more information, see Using Cost Allocation * Tags in the AWS Billing and Cost Management User * Guide.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { KinesisVideoClient, TagResourceCommand } from "@aws-sdk/client-kinesis-video"; // ES Modules import + * // const { KinesisVideoClient, TagResourceCommand } = require("@aws-sdk/client-kinesis-video"); // CommonJS import + * const client = new KinesisVideoClient(config); + * const command = new TagResourceCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link TagResourceCommandInput} for command's `input` shape. + * @see {@link TagResourceCommandOutput} for command's `response` shape. + * @see {@link KinesisVideoClientResolvedConfig | config} for command's `input` shape. + * */ export class TagResourceCommand extends $Command< TagResourceCommandInput, diff --git a/clients/client-kinesis-video/commands/TagStreamCommand.ts b/clients/client-kinesis-video/commands/TagStreamCommand.ts index 9680749031a2..6ece384acf40 100644 --- a/clients/client-kinesis-video/commands/TagStreamCommand.ts +++ b/clients/client-kinesis-video/commands/TagStreamCommand.ts @@ -31,6 +31,20 @@ export interface TagStreamCommandOutput extends TagStreamOutput, __MetadataBeare *

This operation requires permission for the KinesisVideo:TagStream * action.

*

Kinesis video streams support up to 50 tags.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { KinesisVideoClient, TagStreamCommand } from "@aws-sdk/client-kinesis-video"; // ES Modules import + * // const { KinesisVideoClient, TagStreamCommand } = require("@aws-sdk/client-kinesis-video"); // CommonJS import + * const client = new KinesisVideoClient(config); + * const command = new TagStreamCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link TagStreamCommandInput} for command's `input` shape. + * @see {@link TagStreamCommandOutput} for command's `response` shape. + * @see {@link KinesisVideoClientResolvedConfig | config} for command's `input` shape. + * */ export class TagStreamCommand extends $Command< TagStreamCommandInput, diff --git a/clients/client-kinesis-video/commands/UntagResourceCommand.ts b/clients/client-kinesis-video/commands/UntagResourceCommand.ts index 92b91e6bb023..2fe33171a9f2 100644 --- a/clients/client-kinesis-video/commands/UntagResourceCommand.ts +++ b/clients/client-kinesis-video/commands/UntagResourceCommand.ts @@ -24,6 +24,20 @@ export interface UntagResourceCommandOutput extends UntagResourceOutput, __Metad *

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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { KinesisVideoClient, UntagResourceCommand } from "@aws-sdk/client-kinesis-video"; // ES Modules import + * // const { KinesisVideoClient, UntagResourceCommand } = require("@aws-sdk/client-kinesis-video"); // CommonJS import + * const client = new KinesisVideoClient(config); + * const command = new UntagResourceCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link UntagResourceCommandInput} for command's `input` shape. + * @see {@link UntagResourceCommandOutput} for command's `response` shape. + * @see {@link KinesisVideoClientResolvedConfig | config} for command's `input` shape. + * */ export class UntagResourceCommand extends $Command< UntagResourceCommandInput, diff --git a/clients/client-kinesis-video/commands/UntagStreamCommand.ts b/clients/client-kinesis-video/commands/UntagStreamCommand.ts index f0f747e24221..74cf9003add3 100644 --- a/clients/client-kinesis-video/commands/UntagStreamCommand.ts +++ b/clients/client-kinesis-video/commands/UntagStreamCommand.ts @@ -26,6 +26,20 @@ export interface UntagStreamCommandOutput extends UntagStreamOutput, __MetadataB * ignored.

*

In the request, you must provide the StreamName or * StreamARN.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { KinesisVideoClient, UntagStreamCommand } from "@aws-sdk/client-kinesis-video"; // ES Modules import + * // const { KinesisVideoClient, UntagStreamCommand } = require("@aws-sdk/client-kinesis-video"); // CommonJS import + * const client = new KinesisVideoClient(config); + * const command = new UntagStreamCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link UntagStreamCommandInput} for command's `input` shape. + * @see {@link UntagStreamCommandOutput} for command's `response` shape. + * @see {@link KinesisVideoClientResolvedConfig | config} for command's `input` shape. + * */ export class UntagStreamCommand extends $Command< UntagStreamCommandInput, diff --git a/clients/client-kinesis-video/commands/UpdateDataRetentionCommand.ts b/clients/client-kinesis-video/commands/UpdateDataRetentionCommand.ts index c0c4cd479de9..b30b36cc6efa 100644 --- a/clients/client-kinesis-video/commands/UpdateDataRetentionCommand.ts +++ b/clients/client-kinesis-video/commands/UpdateDataRetentionCommand.ts @@ -48,6 +48,20 @@ export interface UpdateDataRetentionCommandOutput extends UpdateDataRetentionOut * any data older than one hour is deleted immediately.

* * + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { KinesisVideoClient, UpdateDataRetentionCommand } from "@aws-sdk/client-kinesis-video"; // ES Modules import + * // const { KinesisVideoClient, UpdateDataRetentionCommand } = require("@aws-sdk/client-kinesis-video"); // CommonJS import + * const client = new KinesisVideoClient(config); + * const command = new UpdateDataRetentionCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link UpdateDataRetentionCommandInput} for command's `input` shape. + * @see {@link UpdateDataRetentionCommandOutput} for command's `response` shape. + * @see {@link KinesisVideoClientResolvedConfig | config} for command's `input` shape. + * */ export class UpdateDataRetentionCommand extends $Command< UpdateDataRetentionCommandInput, diff --git a/clients/client-kinesis-video/commands/UpdateSignalingChannelCommand.ts b/clients/client-kinesis-video/commands/UpdateSignalingChannelCommand.ts index b92a30216039..8e5bcd639837 100644 --- a/clients/client-kinesis-video/commands/UpdateSignalingChannelCommand.ts +++ b/clients/client-kinesis-video/commands/UpdateSignalingChannelCommand.ts @@ -27,6 +27,20 @@ export interface UpdateSignalingChannelCommandOutput extends UpdateSignalingChan * 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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { KinesisVideoClient, UpdateSignalingChannelCommand } from "@aws-sdk/client-kinesis-video"; // ES Modules import + * // const { KinesisVideoClient, UpdateSignalingChannelCommand } = require("@aws-sdk/client-kinesis-video"); // CommonJS import + * const client = new KinesisVideoClient(config); + * const command = new UpdateSignalingChannelCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link UpdateSignalingChannelCommandInput} for command's `input` shape. + * @see {@link UpdateSignalingChannelCommandOutput} for command's `response` shape. + * @see {@link KinesisVideoClientResolvedConfig | config} for command's `input` shape. + * */ export class UpdateSignalingChannelCommand extends $Command< UpdateSignalingChannelCommandInput, diff --git a/clients/client-kinesis-video/commands/UpdateStreamCommand.ts b/clients/client-kinesis-video/commands/UpdateStreamCommand.ts index 5b25718626e6..5e8361221a9e 100644 --- a/clients/client-kinesis-video/commands/UpdateStreamCommand.ts +++ b/clients/client-kinesis-video/commands/UpdateStreamCommand.ts @@ -31,6 +31,20 @@ export interface UpdateStreamCommandOutput extends UpdateStreamOutput, __Metadat *

* UpdateStream is an asynchronous operation, and takes time to * complete.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { KinesisVideoClient, UpdateStreamCommand } from "@aws-sdk/client-kinesis-video"; // ES Modules import + * // const { KinesisVideoClient, UpdateStreamCommand } = require("@aws-sdk/client-kinesis-video"); // CommonJS import + * const client = new KinesisVideoClient(config); + * const command = new UpdateStreamCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link UpdateStreamCommandInput} for command's `input` shape. + * @see {@link UpdateStreamCommandOutput} for command's `response` shape. + * @see {@link KinesisVideoClientResolvedConfig | config} for command's `input` shape. + * */ export class UpdateStreamCommand extends $Command< UpdateStreamCommandInput, diff --git a/clients/client-kinesis-video/models/models_0.ts b/clients/client-kinesis-video/models/models_0.ts index 4e14b81f1a4c..04f72f4b0667 100644 --- a/clients/client-kinesis-video/models/models_0.ts +++ b/clients/client-kinesis-video/models/models_0.ts @@ -11,6 +11,9 @@ export interface AccessDeniedException extends __SmithyException, $MetadataBeare } export namespace AccessDeniedException { + /** + * @internal + */ export const filterSensitiveLog = (obj: AccessDeniedException): any => ({ ...obj, }); @@ -27,6 +30,9 @@ export interface AccountChannelLimitExceededException extends __SmithyException, } export namespace AccountChannelLimitExceededException { + /** + * @internal + */ export const filterSensitiveLog = (obj: AccountChannelLimitExceededException): any => ({ ...obj, }); @@ -42,6 +48,9 @@ export interface AccountStreamLimitExceededException extends __SmithyException, } export namespace AccountStreamLimitExceededException { + /** + * @internal + */ export const filterSensitiveLog = (obj: AccountStreamLimitExceededException): any => ({ ...obj, }); @@ -81,6 +90,9 @@ export interface SingleMasterConfiguration { } export namespace SingleMasterConfiguration { + /** + * @internal + */ export const filterSensitiveLog = (obj: SingleMasterConfiguration): any => ({ ...obj, }); @@ -128,6 +140,9 @@ export interface ChannelInfo { } export namespace ChannelInfo { + /** + * @internal + */ export const filterSensitiveLog = (obj: ChannelInfo): any => ({ ...obj, }); @@ -157,6 +172,9 @@ export interface ChannelNameCondition { } export namespace ChannelNameCondition { + /** + * @internal + */ export const filterSensitiveLog = (obj: ChannelNameCondition): any => ({ ...obj, }); @@ -183,6 +201,9 @@ export interface ClientLimitExceededException extends __SmithyException, $Metada } export namespace ClientLimitExceededException { + /** + * @internal + */ export const filterSensitiveLog = (obj: ClientLimitExceededException): any => ({ ...obj, }); @@ -204,6 +225,9 @@ export interface Tag { } export namespace Tag { + /** + * @internal + */ export const filterSensitiveLog = (obj: Tag): any => ({ ...obj, }); @@ -235,6 +259,9 @@ export interface CreateSignalingChannelInput { } export namespace CreateSignalingChannelInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateSignalingChannelInput): any => ({ ...obj, }); @@ -248,6 +275,9 @@ export interface CreateSignalingChannelOutput { } export namespace CreateSignalingChannelOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateSignalingChannelOutput): any => ({ ...obj, }); @@ -263,6 +293,9 @@ export interface InvalidArgumentException extends __SmithyException, $MetadataBe } export namespace InvalidArgumentException { + /** + * @internal + */ export const filterSensitiveLog = (obj: InvalidArgumentException): any => ({ ...obj, }); @@ -278,6 +311,9 @@ export interface ResourceInUseException extends __SmithyException, $MetadataBear } export namespace ResourceInUseException { + /** + * @internal + */ export const filterSensitiveLog = (obj: ResourceInUseException): any => ({ ...obj, }); @@ -294,6 +330,9 @@ export interface TagsPerResourceExceededLimitException extends __SmithyException } export namespace TagsPerResourceExceededLimitException { + /** + * @internal + */ export const filterSensitiveLog = (obj: TagsPerResourceExceededLimitException): any => ({ ...obj, }); @@ -356,6 +395,9 @@ export interface CreateStreamInput { } export namespace CreateStreamInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateStreamInput): any => ({ ...obj, }); @@ -369,6 +411,9 @@ export interface CreateStreamOutput { } export namespace CreateStreamOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateStreamOutput): any => ({ ...obj, }); @@ -385,6 +430,9 @@ export interface DeviceStreamLimitExceededException extends __SmithyException, $ } export namespace DeviceStreamLimitExceededException { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeviceStreamLimitExceededException): any => ({ ...obj, }); @@ -400,6 +448,9 @@ export interface InvalidDeviceException extends __SmithyException, $MetadataBear } export namespace InvalidDeviceException { + /** + * @internal + */ export const filterSensitiveLog = (obj: InvalidDeviceException): any => ({ ...obj, }); @@ -421,6 +472,9 @@ export interface DeleteSignalingChannelInput { } export namespace DeleteSignalingChannelInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteSignalingChannelInput): any => ({ ...obj, }); @@ -429,6 +483,9 @@ export namespace DeleteSignalingChannelInput { export interface DeleteSignalingChannelOutput {} export namespace DeleteSignalingChannelOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteSignalingChannelOutput): any => ({ ...obj, }); @@ -444,6 +501,9 @@ export interface ResourceNotFoundException extends __SmithyException, $MetadataB } export namespace ResourceNotFoundException { + /** + * @internal + */ export const filterSensitiveLog = (obj: ResourceNotFoundException): any => ({ ...obj, }); @@ -461,6 +521,9 @@ export interface VersionMismatchException extends __SmithyException, $MetadataBe } export namespace VersionMismatchException { + /** + * @internal + */ export const filterSensitiveLog = (obj: VersionMismatchException): any => ({ ...obj, }); @@ -483,6 +546,9 @@ export interface DeleteStreamInput { } export namespace DeleteStreamInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteStreamInput): any => ({ ...obj, }); @@ -491,6 +557,9 @@ export namespace DeleteStreamInput { export interface DeleteStreamOutput {} export namespace DeleteStreamOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteStreamOutput): any => ({ ...obj, }); @@ -506,6 +575,9 @@ export interface NotAuthorizedException extends __SmithyException, $MetadataBear } export namespace NotAuthorizedException { + /** + * @internal + */ export const filterSensitiveLog = (obj: NotAuthorizedException): any => ({ ...obj, }); @@ -524,6 +596,9 @@ export interface DescribeSignalingChannelInput { } export namespace DescribeSignalingChannelInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeSignalingChannelInput): any => ({ ...obj, }); @@ -538,6 +613,9 @@ export interface DescribeSignalingChannelOutput { } export namespace DescribeSignalingChannelOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeSignalingChannelOutput): any => ({ ...obj, }); @@ -556,6 +634,9 @@ export interface DescribeStreamInput { } export namespace DescribeStreamInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeStreamInput): any => ({ ...obj, }); @@ -613,6 +694,9 @@ export interface StreamInfo { } export namespace StreamInfo { + /** + * @internal + */ export const filterSensitiveLog = (obj: StreamInfo): any => ({ ...obj, }); @@ -626,6 +710,9 @@ export interface DescribeStreamOutput { } export namespace DescribeStreamOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeStreamOutput): any => ({ ...obj, }); @@ -652,6 +739,9 @@ export interface GetDataEndpointInput { } export namespace GetDataEndpointInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetDataEndpointInput): any => ({ ...obj, }); @@ -666,6 +756,9 @@ export interface GetDataEndpointOutput { } export namespace GetDataEndpointOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetDataEndpointOutput): any => ({ ...obj, }); @@ -696,6 +789,9 @@ export interface SingleMasterChannelEndpointConfiguration { } export namespace SingleMasterChannelEndpointConfiguration { + /** + * @internal + */ export const filterSensitiveLog = (obj: SingleMasterChannelEndpointConfiguration): any => ({ ...obj, }); @@ -716,6 +812,9 @@ export interface GetSignalingChannelEndpointInput { } export namespace GetSignalingChannelEndpointInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetSignalingChannelEndpointInput): any => ({ ...obj, }); @@ -740,6 +839,9 @@ export interface ResourceEndpointListItem { } export namespace ResourceEndpointListItem { + /** + * @internal + */ export const filterSensitiveLog = (obj: ResourceEndpointListItem): any => ({ ...obj, }); @@ -753,6 +855,9 @@ export interface GetSignalingChannelEndpointOutput { } export namespace GetSignalingChannelEndpointOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetSignalingChannelEndpointOutput): any => ({ ...obj, }); @@ -768,6 +873,9 @@ export interface InvalidResourceFormatException extends __SmithyException, $Meta } export namespace InvalidResourceFormatException { + /** + * @internal + */ export const filterSensitiveLog = (obj: InvalidResourceFormatException): any => ({ ...obj, }); @@ -793,6 +901,9 @@ export interface ListSignalingChannelsInput { } export namespace ListSignalingChannelsInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListSignalingChannelsInput): any => ({ ...obj, }); @@ -812,6 +923,9 @@ export interface ListSignalingChannelsOutput { } export namespace ListSignalingChannelsOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListSignalingChannelsOutput): any => ({ ...obj, }); @@ -837,6 +951,9 @@ export interface StreamNameCondition { } export namespace StreamNameCondition { + /** + * @internal + */ export const filterSensitiveLog = (obj: StreamNameCondition): any => ({ ...obj, }); @@ -864,6 +981,9 @@ export interface ListStreamsInput { } export namespace ListStreamsInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListStreamsInput): any => ({ ...obj, }); @@ -883,6 +1003,9 @@ export interface ListStreamsOutput { } export namespace ListStreamsOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListStreamsOutput): any => ({ ...obj, }); @@ -904,6 +1027,9 @@ export interface ListTagsForResourceInput { } export namespace ListTagsForResourceInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListTagsForResourceInput): any => ({ ...obj, }); @@ -924,6 +1050,9 @@ export interface ListTagsForResourceOutput { } export namespace ListTagsForResourceOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListTagsForResourceOutput): any => ({ ...obj, }); @@ -950,6 +1079,9 @@ export interface ListTagsForStreamInput { } export namespace ListTagsForStreamInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListTagsForStreamInput): any => ({ ...obj, }); @@ -970,6 +1102,9 @@ export interface ListTagsForStreamOutput { } export namespace ListTagsForStreamOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListTagsForStreamOutput): any => ({ ...obj, }); @@ -990,6 +1125,9 @@ export interface TagResourceInput { } export namespace TagResourceInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: TagResourceInput): any => ({ ...obj, }); @@ -998,6 +1136,9 @@ export namespace TagResourceInput { export interface TagResourceOutput {} export namespace TagResourceOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: TagResourceOutput): any => ({ ...obj, }); @@ -1023,6 +1164,9 @@ export interface TagStreamInput { } export namespace TagStreamInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: TagStreamInput): any => ({ ...obj, }); @@ -1031,6 +1175,9 @@ export namespace TagStreamInput { export interface TagStreamOutput {} export namespace TagStreamOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: TagStreamOutput): any => ({ ...obj, }); @@ -1050,6 +1197,9 @@ export interface UntagResourceInput { } export namespace UntagResourceInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: UntagResourceInput): any => ({ ...obj, }); @@ -1058,6 +1208,9 @@ export namespace UntagResourceInput { export interface UntagResourceOutput {} export namespace UntagResourceOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: UntagResourceOutput): any => ({ ...obj, }); @@ -1082,6 +1235,9 @@ export interface UntagStreamInput { } export namespace UntagStreamInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: UntagStreamInput): any => ({ ...obj, }); @@ -1090,6 +1246,9 @@ export namespace UntagStreamInput { export interface UntagStreamOutput {} export namespace UntagStreamOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: UntagStreamOutput): any => ({ ...obj, }); @@ -1132,6 +1291,9 @@ export interface UpdateDataRetentionInput { } export namespace UpdateDataRetentionInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateDataRetentionInput): any => ({ ...obj, }); @@ -1140,6 +1302,9 @@ export namespace UpdateDataRetentionInput { export interface UpdateDataRetentionOutput {} export namespace UpdateDataRetentionOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateDataRetentionOutput): any => ({ ...obj, }); @@ -1165,6 +1330,9 @@ export interface UpdateSignalingChannelInput { } export namespace UpdateSignalingChannelInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateSignalingChannelInput): any => ({ ...obj, }); @@ -1173,6 +1341,9 @@ export namespace UpdateSignalingChannelInput { export interface UpdateSignalingChannelOutput {} export namespace UpdateSignalingChannelOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateSignalingChannelOutput): any => ({ ...obj, }); @@ -1219,6 +1390,9 @@ export interface UpdateStreamInput { } export namespace UpdateStreamInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateStreamInput): any => ({ ...obj, }); @@ -1227,6 +1401,9 @@ export namespace UpdateStreamInput { export interface UpdateStreamOutput {} export namespace UpdateStreamOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateStreamOutput): any => ({ ...obj, }); diff --git a/clients/client-kinesis/commands/AddTagsToStreamCommand.ts b/clients/client-kinesis/commands/AddTagsToStreamCommand.ts index c6146bc2fa53..b0d31ca07e54 100644 --- a/clients/client-kinesis/commands/AddTagsToStreamCommand.ts +++ b/clients/client-kinesis/commands/AddTagsToStreamCommand.ts @@ -30,6 +30,20 @@ export interface AddTagsToStreamCommandOutput extends __MetadataBearer {} *

* AddTagsToStream has a limit of five transactions per second per * account.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { KinesisClient, AddTagsToStreamCommand } from "@aws-sdk/client-kinesis"; // ES Modules import + * // const { KinesisClient, AddTagsToStreamCommand } = require("@aws-sdk/client-kinesis"); // CommonJS import + * const client = new KinesisClient(config); + * const command = new AddTagsToStreamCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link AddTagsToStreamCommandInput} for command's `input` shape. + * @see {@link AddTagsToStreamCommandOutput} for command's `response` shape. + * @see {@link KinesisClientResolvedConfig | config} for command's `input` shape. + * */ export class AddTagsToStreamCommand extends $Command< AddTagsToStreamCommandInput, diff --git a/clients/client-kinesis/commands/CreateStreamCommand.ts b/clients/client-kinesis/commands/CreateStreamCommand.ts index 8df6e846367a..a0d47bd23b97 100644 --- a/clients/client-kinesis/commands/CreateStreamCommand.ts +++ b/clients/client-kinesis/commands/CreateStreamCommand.ts @@ -62,6 +62,20 @@ export interface CreateStreamCommandOutput extends __MetadataBearer {} *

* CreateStream has a limit of five transactions per second per * account.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { KinesisClient, CreateStreamCommand } from "@aws-sdk/client-kinesis"; // ES Modules import + * // const { KinesisClient, CreateStreamCommand } = require("@aws-sdk/client-kinesis"); // CommonJS import + * const client = new KinesisClient(config); + * const command = new CreateStreamCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreateStreamCommandInput} for command's `input` shape. + * @see {@link CreateStreamCommandOutput} for command's `response` shape. + * @see {@link KinesisClientResolvedConfig | config} for command's `input` shape. + * */ export class CreateStreamCommand extends $Command< CreateStreamCommandInput, diff --git a/clients/client-kinesis/commands/DecreaseStreamRetentionPeriodCommand.ts b/clients/client-kinesis/commands/DecreaseStreamRetentionPeriodCommand.ts index 958de1c0073c..372ce89a9b4f 100644 --- a/clients/client-kinesis/commands/DecreaseStreamRetentionPeriodCommand.ts +++ b/clients/client-kinesis/commands/DecreaseStreamRetentionPeriodCommand.ts @@ -27,6 +27,20 @@ export interface DecreaseStreamRetentionPeriodCommandOutput extends __MetadataBe *

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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { KinesisClient, DecreaseStreamRetentionPeriodCommand } from "@aws-sdk/client-kinesis"; // ES Modules import + * // const { KinesisClient, DecreaseStreamRetentionPeriodCommand } = require("@aws-sdk/client-kinesis"); // CommonJS import + * const client = new KinesisClient(config); + * const command = new DecreaseStreamRetentionPeriodCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DecreaseStreamRetentionPeriodCommandInput} for command's `input` shape. + * @see {@link DecreaseStreamRetentionPeriodCommandOutput} for command's `response` shape. + * @see {@link KinesisClientResolvedConfig | config} for command's `input` shape. + * */ export class DecreaseStreamRetentionPeriodCommand extends $Command< DecreaseStreamRetentionPeriodCommandInput, diff --git a/clients/client-kinesis/commands/DeleteStreamCommand.ts b/clients/client-kinesis/commands/DeleteStreamCommand.ts index 317ec18ca7ac..2829ce7082f8 100644 --- a/clients/client-kinesis/commands/DeleteStreamCommand.ts +++ b/clients/client-kinesis/commands/DeleteStreamCommand.ts @@ -40,6 +40,20 @@ export interface DeleteStreamCommandOutput extends __MetadataBearer {} *

* DeleteStream has a limit of five transactions per second per * account.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { KinesisClient, DeleteStreamCommand } from "@aws-sdk/client-kinesis"; // ES Modules import + * // const { KinesisClient, DeleteStreamCommand } = require("@aws-sdk/client-kinesis"); // CommonJS import + * const client = new KinesisClient(config); + * const command = new DeleteStreamCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteStreamCommandInput} for command's `input` shape. + * @see {@link DeleteStreamCommandOutput} for command's `response` shape. + * @see {@link KinesisClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteStreamCommand extends $Command< DeleteStreamCommandInput, diff --git a/clients/client-kinesis/commands/DeregisterStreamConsumerCommand.ts b/clients/client-kinesis/commands/DeregisterStreamConsumerCommand.ts index 5651c2a612f1..b9e4fda816b9 100644 --- a/clients/client-kinesis/commands/DeregisterStreamConsumerCommand.ts +++ b/clients/client-kinesis/commands/DeregisterStreamConsumerCommand.ts @@ -29,6 +29,20 @@ export interface DeregisterStreamConsumerCommandOutput extends __MetadataBearer * 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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { KinesisClient, DeregisterStreamConsumerCommand } from "@aws-sdk/client-kinesis"; // ES Modules import + * // const { KinesisClient, DeregisterStreamConsumerCommand } = require("@aws-sdk/client-kinesis"); // CommonJS import + * const client = new KinesisClient(config); + * const command = new DeregisterStreamConsumerCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeregisterStreamConsumerCommandInput} for command's `input` shape. + * @see {@link DeregisterStreamConsumerCommandOutput} for command's `response` shape. + * @see {@link KinesisClientResolvedConfig | config} for command's `input` shape. + * */ export class DeregisterStreamConsumerCommand extends $Command< DeregisterStreamConsumerCommandInput, diff --git a/clients/client-kinesis/commands/DescribeLimitsCommand.ts b/clients/client-kinesis/commands/DescribeLimitsCommand.ts index c6cf83e90f16..83cf42a538d0 100644 --- a/clients/client-kinesis/commands/DescribeLimitsCommand.ts +++ b/clients/client-kinesis/commands/DescribeLimitsCommand.ts @@ -25,6 +25,20 @@ export interface DescribeLimitsCommandOutput extends DescribeLimitsOutput, __Met *

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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { KinesisClient, DescribeLimitsCommand } from "@aws-sdk/client-kinesis"; // ES Modules import + * // const { KinesisClient, DescribeLimitsCommand } = require("@aws-sdk/client-kinesis"); // CommonJS import + * const client = new KinesisClient(config); + * const command = new DescribeLimitsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeLimitsCommandInput} for command's `input` shape. + * @see {@link DescribeLimitsCommandOutput} for command's `response` shape. + * @see {@link KinesisClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeLimitsCommand extends $Command< DescribeLimitsCommandInput, diff --git a/clients/client-kinesis/commands/DescribeStreamCommand.ts b/clients/client-kinesis/commands/DescribeStreamCommand.ts index 54dc2f1c65db..4620dff68317 100644 --- a/clients/client-kinesis/commands/DescribeStreamCommand.ts +++ b/clients/client-kinesis/commands/DescribeStreamCommand.ts @@ -38,6 +38,20 @@ export interface DescribeStreamCommandOutput extends DescribeStreamOutput, __Met * 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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { KinesisClient, DescribeStreamCommand } from "@aws-sdk/client-kinesis"; // ES Modules import + * // const { KinesisClient, DescribeStreamCommand } = require("@aws-sdk/client-kinesis"); // CommonJS import + * const client = new KinesisClient(config); + * const command = new DescribeStreamCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeStreamCommandInput} for command's `input` shape. + * @see {@link DescribeStreamCommandOutput} for command's `response` shape. + * @see {@link KinesisClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeStreamCommand extends $Command< DescribeStreamCommandInput, diff --git a/clients/client-kinesis/commands/DescribeStreamConsumerCommand.ts b/clients/client-kinesis/commands/DescribeStreamConsumerCommand.ts index bf3689427529..b3dababacd35 100644 --- a/clients/client-kinesis/commands/DescribeStreamConsumerCommand.ts +++ b/clients/client-kinesis/commands/DescribeStreamConsumerCommand.ts @@ -29,6 +29,20 @@ export interface DescribeStreamConsumerCommandOutput extends DescribeStreamConsu * 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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { KinesisClient, DescribeStreamConsumerCommand } from "@aws-sdk/client-kinesis"; // ES Modules import + * // const { KinesisClient, DescribeStreamConsumerCommand } = require("@aws-sdk/client-kinesis"); // CommonJS import + * const client = new KinesisClient(config); + * const command = new DescribeStreamConsumerCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeStreamConsumerCommandInput} for command's `input` shape. + * @see {@link DescribeStreamConsumerCommandOutput} for command's `response` shape. + * @see {@link KinesisClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeStreamConsumerCommand extends $Command< DescribeStreamConsumerCommandInput, diff --git a/clients/client-kinesis/commands/DescribeStreamSummaryCommand.ts b/clients/client-kinesis/commands/DescribeStreamSummaryCommand.ts index 732d93d98002..5d780038f55c 100644 --- a/clients/client-kinesis/commands/DescribeStreamSummaryCommand.ts +++ b/clients/client-kinesis/commands/DescribeStreamSummaryCommand.ts @@ -29,6 +29,20 @@ export interface DescribeStreamSummaryCommandOutput extends DescribeStreamSummar *

* DescribeStreamSummary has a limit of 20 transactions per second * per account.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { KinesisClient, DescribeStreamSummaryCommand } from "@aws-sdk/client-kinesis"; // ES Modules import + * // const { KinesisClient, DescribeStreamSummaryCommand } = require("@aws-sdk/client-kinesis"); // CommonJS import + * const client = new KinesisClient(config); + * const command = new DescribeStreamSummaryCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeStreamSummaryCommandInput} for command's `input` shape. + * @see {@link DescribeStreamSummaryCommandOutput} for command's `response` shape. + * @see {@link KinesisClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeStreamSummaryCommand extends $Command< DescribeStreamSummaryCommandInput, diff --git a/clients/client-kinesis/commands/DisableEnhancedMonitoringCommand.ts b/clients/client-kinesis/commands/DisableEnhancedMonitoringCommand.ts index 70787fe05056..22ac7801a46e 100644 --- a/clients/client-kinesis/commands/DisableEnhancedMonitoringCommand.ts +++ b/clients/client-kinesis/commands/DisableEnhancedMonitoringCommand.ts @@ -22,6 +22,20 @@ export interface DisableEnhancedMonitoringCommandOutput extends EnhancedMonitori /** *

Disables enhanced monitoring.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { KinesisClient, DisableEnhancedMonitoringCommand } from "@aws-sdk/client-kinesis"; // ES Modules import + * // const { KinesisClient, DisableEnhancedMonitoringCommand } = require("@aws-sdk/client-kinesis"); // CommonJS import + * const client = new KinesisClient(config); + * const command = new DisableEnhancedMonitoringCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DisableEnhancedMonitoringCommandInput} for command's `input` shape. + * @see {@link DisableEnhancedMonitoringCommandOutput} for command's `response` shape. + * @see {@link KinesisClientResolvedConfig | config} for command's `input` shape. + * */ export class DisableEnhancedMonitoringCommand extends $Command< DisableEnhancedMonitoringCommandInput, diff --git a/clients/client-kinesis/commands/EnableEnhancedMonitoringCommand.ts b/clients/client-kinesis/commands/EnableEnhancedMonitoringCommand.ts index bf7e82e91550..ed81395cbb2d 100644 --- a/clients/client-kinesis/commands/EnableEnhancedMonitoringCommand.ts +++ b/clients/client-kinesis/commands/EnableEnhancedMonitoringCommand.ts @@ -22,6 +22,20 @@ export interface EnableEnhancedMonitoringCommandOutput extends EnhancedMonitorin /** *

Enables enhanced Kinesis data stream monitoring for shard-level metrics.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { KinesisClient, EnableEnhancedMonitoringCommand } from "@aws-sdk/client-kinesis"; // ES Modules import + * // const { KinesisClient, EnableEnhancedMonitoringCommand } = require("@aws-sdk/client-kinesis"); // CommonJS import + * const client = new KinesisClient(config); + * const command = new EnableEnhancedMonitoringCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link EnableEnhancedMonitoringCommandInput} for command's `input` shape. + * @see {@link EnableEnhancedMonitoringCommandOutput} for command's `response` shape. + * @see {@link KinesisClientResolvedConfig | config} for command's `input` shape. + * */ export class EnableEnhancedMonitoringCommand extends $Command< EnableEnhancedMonitoringCommandInput, diff --git a/clients/client-kinesis/commands/GetRecordsCommand.ts b/clients/client-kinesis/commands/GetRecordsCommand.ts index 69e0d46ea249..32424fe2a4fd 100644 --- a/clients/client-kinesis/commands/GetRecordsCommand.ts +++ b/clients/client-kinesis/commands/GetRecordsCommand.ts @@ -68,6 +68,20 @@ export interface GetRecordsCommandOutput extends GetRecordsOutput, __MetadataBea * 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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { KinesisClient, GetRecordsCommand } from "@aws-sdk/client-kinesis"; // ES Modules import + * // const { KinesisClient, GetRecordsCommand } = require("@aws-sdk/client-kinesis"); // CommonJS import + * const client = new KinesisClient(config); + * const command = new GetRecordsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetRecordsCommandInput} for command's `input` shape. + * @see {@link GetRecordsCommandOutput} for command's `response` shape. + * @see {@link KinesisClientResolvedConfig | config} for command's `input` shape. + * */ export class GetRecordsCommand extends $Command< GetRecordsCommandInput, diff --git a/clients/client-kinesis/commands/GetShardIteratorCommand.ts b/clients/client-kinesis/commands/GetShardIteratorCommand.ts index c6861f8d9861..4228c6a9109e 100644 --- a/clients/client-kinesis/commands/GetShardIteratorCommand.ts +++ b/clients/client-kinesis/commands/GetShardIteratorCommand.ts @@ -55,6 +55,20 @@ export interface GetShardIteratorCommandOutput extends GetShardIteratorOutput, _ *

* GetShardIterator has a limit of five transactions per second per * account per open shard.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { KinesisClient, GetShardIteratorCommand } from "@aws-sdk/client-kinesis"; // ES Modules import + * // const { KinesisClient, GetShardIteratorCommand } = require("@aws-sdk/client-kinesis"); // CommonJS import + * const client = new KinesisClient(config); + * const command = new GetShardIteratorCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetShardIteratorCommandInput} for command's `input` shape. + * @see {@link GetShardIteratorCommandOutput} for command's `response` shape. + * @see {@link KinesisClientResolvedConfig | config} for command's `input` shape. + * */ export class GetShardIteratorCommand extends $Command< GetShardIteratorCommandInput, diff --git a/clients/client-kinesis/commands/IncreaseStreamRetentionPeriodCommand.ts b/clients/client-kinesis/commands/IncreaseStreamRetentionPeriodCommand.ts index ef25400922e4..5faf82435e30 100644 --- a/clients/client-kinesis/commands/IncreaseStreamRetentionPeriodCommand.ts +++ b/clients/client-kinesis/commands/IncreaseStreamRetentionPeriodCommand.ts @@ -30,6 +30,20 @@ export interface IncreaseStreamRetentionPeriodCommandOutput extends __MetadataBe * 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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { KinesisClient, IncreaseStreamRetentionPeriodCommand } from "@aws-sdk/client-kinesis"; // ES Modules import + * // const { KinesisClient, IncreaseStreamRetentionPeriodCommand } = require("@aws-sdk/client-kinesis"); // CommonJS import + * const client = new KinesisClient(config); + * const command = new IncreaseStreamRetentionPeriodCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link IncreaseStreamRetentionPeriodCommandInput} for command's `input` shape. + * @see {@link IncreaseStreamRetentionPeriodCommandOutput} for command's `response` shape. + * @see {@link KinesisClientResolvedConfig | config} for command's `input` shape. + * */ export class IncreaseStreamRetentionPeriodCommand extends $Command< IncreaseStreamRetentionPeriodCommandInput, diff --git a/clients/client-kinesis/commands/ListShardsCommand.ts b/clients/client-kinesis/commands/ListShardsCommand.ts index e2b3eb2d6967..63cc499c9f35 100644 --- a/clients/client-kinesis/commands/ListShardsCommand.ts +++ b/clients/client-kinesis/commands/ListShardsCommand.ts @@ -30,6 +30,20 @@ export interface ListShardsCommandOutput extends ListShardsOutput, __MetadataBea * Controlling Access to Amazon Kinesis Data Streams Resources Using * IAM.

* + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { KinesisClient, ListShardsCommand } from "@aws-sdk/client-kinesis"; // ES Modules import + * // const { KinesisClient, ListShardsCommand } = require("@aws-sdk/client-kinesis"); // CommonJS import + * const client = new KinesisClient(config); + * const command = new ListShardsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListShardsCommandInput} for command's `input` shape. + * @see {@link ListShardsCommandOutput} for command's `response` shape. + * @see {@link KinesisClientResolvedConfig | config} for command's `input` shape. + * */ export class ListShardsCommand extends $Command< ListShardsCommandInput, diff --git a/clients/client-kinesis/commands/ListStreamConsumersCommand.ts b/clients/client-kinesis/commands/ListStreamConsumersCommand.ts index 881598fcdf83..6523e86763bb 100644 --- a/clients/client-kinesis/commands/ListStreamConsumersCommand.ts +++ b/clients/client-kinesis/commands/ListStreamConsumersCommand.ts @@ -24,6 +24,20 @@ export interface ListStreamConsumersCommandOutput extends ListStreamConsumersOut *

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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { KinesisClient, ListStreamConsumersCommand } from "@aws-sdk/client-kinesis"; // ES Modules import + * // const { KinesisClient, ListStreamConsumersCommand } = require("@aws-sdk/client-kinesis"); // CommonJS import + * const client = new KinesisClient(config); + * const command = new ListStreamConsumersCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListStreamConsumersCommandInput} for command's `input` shape. + * @see {@link ListStreamConsumersCommandOutput} for command's `response` shape. + * @see {@link KinesisClientResolvedConfig | config} for command's `input` shape. + * */ export class ListStreamConsumersCommand extends $Command< ListStreamConsumersCommandInput, diff --git a/clients/client-kinesis/commands/ListStreamsCommand.ts b/clients/client-kinesis/commands/ListStreamsCommand.ts index d536992e6fed..0df5ee9f488f 100644 --- a/clients/client-kinesis/commands/ListStreamsCommand.ts +++ b/clients/client-kinesis/commands/ListStreamsCommand.ts @@ -37,6 +37,20 @@ export interface ListStreamsCommandOutput extends ListStreamsOutput, __MetadataB *

* ListStreams has a limit of five transactions per second per * account.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { KinesisClient, ListStreamsCommand } from "@aws-sdk/client-kinesis"; // ES Modules import + * // const { KinesisClient, ListStreamsCommand } = require("@aws-sdk/client-kinesis"); // CommonJS import + * const client = new KinesisClient(config); + * const command = new ListStreamsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListStreamsCommandInput} for command's `input` shape. + * @see {@link ListStreamsCommandOutput} for command's `response` shape. + * @see {@link KinesisClientResolvedConfig | config} for command's `input` shape. + * */ export class ListStreamsCommand extends $Command< ListStreamsCommandInput, diff --git a/clients/client-kinesis/commands/ListTagsForStreamCommand.ts b/clients/client-kinesis/commands/ListTagsForStreamCommand.ts index 2757d342eb85..3e21fc71ded5 100644 --- a/clients/client-kinesis/commands/ListTagsForStreamCommand.ts +++ b/clients/client-kinesis/commands/ListTagsForStreamCommand.ts @@ -23,6 +23,20 @@ export interface ListTagsForStreamCommandOutput extends ListTagsForStreamOutput, /** *

Lists the tags for the specified Kinesis data stream. This operation has a limit of * five transactions per second per account.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { KinesisClient, ListTagsForStreamCommand } from "@aws-sdk/client-kinesis"; // ES Modules import + * // const { KinesisClient, ListTagsForStreamCommand } = require("@aws-sdk/client-kinesis"); // CommonJS import + * const client = new KinesisClient(config); + * const command = new ListTagsForStreamCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListTagsForStreamCommandInput} for command's `input` shape. + * @see {@link ListTagsForStreamCommandOutput} for command's `response` shape. + * @see {@link KinesisClientResolvedConfig | config} for command's `input` shape. + * */ export class ListTagsForStreamCommand extends $Command< ListTagsForStreamCommandInput, diff --git a/clients/client-kinesis/commands/MergeShardsCommand.ts b/clients/client-kinesis/commands/MergeShardsCommand.ts index ab8004e9c025..18b23d4098ed 100644 --- a/clients/client-kinesis/commands/MergeShardsCommand.ts +++ b/clients/client-kinesis/commands/MergeShardsCommand.ts @@ -57,6 +57,20 @@ export interface MergeShardsCommandOutput extends __MetadataBearer {} *

* MergeShards has a limit of five transactions per second per * account.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { KinesisClient, MergeShardsCommand } from "@aws-sdk/client-kinesis"; // ES Modules import + * // const { KinesisClient, MergeShardsCommand } = require("@aws-sdk/client-kinesis"); // CommonJS import + * const client = new KinesisClient(config); + * const command = new MergeShardsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link MergeShardsCommandInput} for command's `input` shape. + * @see {@link MergeShardsCommandOutput} for command's `response` shape. + * @see {@link KinesisClientResolvedConfig | config} for command's `input` shape. + * */ export class MergeShardsCommand extends $Command< MergeShardsCommandInput, diff --git a/clients/client-kinesis/commands/PutRecordCommand.ts b/clients/client-kinesis/commands/PutRecordCommand.ts index 1df9edf43dfe..7bdc440c75c1 100644 --- a/clients/client-kinesis/commands/PutRecordCommand.ts +++ b/clients/client-kinesis/commands/PutRecordCommand.ts @@ -54,6 +54,20 @@ export interface PutRecordCommandOutput extends PutRecordOutput, __MetadataBeare * 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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { KinesisClient, PutRecordCommand } from "@aws-sdk/client-kinesis"; // ES Modules import + * // const { KinesisClient, PutRecordCommand } = require("@aws-sdk/client-kinesis"); // CommonJS import + * const client = new KinesisClient(config); + * const command = new PutRecordCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link PutRecordCommandInput} for command's `input` shape. + * @see {@link PutRecordCommandOutput} for command's `response` shape. + * @see {@link KinesisClientResolvedConfig | config} for command's `input` shape. + * */ export class PutRecordCommand extends $Command< PutRecordCommandInput, diff --git a/clients/client-kinesis/commands/PutRecordsCommand.ts b/clients/client-kinesis/commands/PutRecordsCommand.ts index 3898ed8a4632..6ab5abbc08e8 100644 --- a/clients/client-kinesis/commands/PutRecordsCommand.ts +++ b/clients/client-kinesis/commands/PutRecordsCommand.ts @@ -77,6 +77,20 @@ export interface PutRecordsCommandOutput extends PutRecordsOutput, __MetadataBea * *

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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { KinesisClient, PutRecordsCommand } from "@aws-sdk/client-kinesis"; // ES Modules import + * // const { KinesisClient, PutRecordsCommand } = require("@aws-sdk/client-kinesis"); // CommonJS import + * const client = new KinesisClient(config); + * const command = new PutRecordsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link PutRecordsCommandInput} for command's `input` shape. + * @see {@link PutRecordsCommandOutput} for command's `response` shape. + * @see {@link KinesisClientResolvedConfig | config} for command's `input` shape. + * */ export class PutRecordsCommand extends $Command< PutRecordsCommandInput, diff --git a/clients/client-kinesis/commands/RegisterStreamConsumerCommand.ts b/clients/client-kinesis/commands/RegisterStreamConsumerCommand.ts index 0a0d4305e571..8360e2ff7c3c 100644 --- a/clients/client-kinesis/commands/RegisterStreamConsumerCommand.ts +++ b/clients/client-kinesis/commands/RegisterStreamConsumerCommand.ts @@ -35,6 +35,20 @@ export interface RegisterStreamConsumerCommandOutput extends RegisterStreamConsu * 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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { KinesisClient, RegisterStreamConsumerCommand } from "@aws-sdk/client-kinesis"; // ES Modules import + * // const { KinesisClient, RegisterStreamConsumerCommand } = require("@aws-sdk/client-kinesis"); // CommonJS import + * const client = new KinesisClient(config); + * const command = new RegisterStreamConsumerCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link RegisterStreamConsumerCommandInput} for command's `input` shape. + * @see {@link RegisterStreamConsumerCommandOutput} for command's `response` shape. + * @see {@link KinesisClientResolvedConfig | config} for command's `input` shape. + * */ export class RegisterStreamConsumerCommand extends $Command< RegisterStreamConsumerCommandInput, diff --git a/clients/client-kinesis/commands/RemoveTagsFromStreamCommand.ts b/clients/client-kinesis/commands/RemoveTagsFromStreamCommand.ts index f1ec7a18d67b..d8445e4fd873 100644 --- a/clients/client-kinesis/commands/RemoveTagsFromStreamCommand.ts +++ b/clients/client-kinesis/commands/RemoveTagsFromStreamCommand.ts @@ -27,6 +27,20 @@ export interface RemoveTagsFromStreamCommandOutput extends __MetadataBearer {} *

* RemoveTagsFromStream has a limit of five transactions per second per * account.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { KinesisClient, RemoveTagsFromStreamCommand } from "@aws-sdk/client-kinesis"; // ES Modules import + * // const { KinesisClient, RemoveTagsFromStreamCommand } = require("@aws-sdk/client-kinesis"); // CommonJS import + * const client = new KinesisClient(config); + * const command = new RemoveTagsFromStreamCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link RemoveTagsFromStreamCommandInput} for command's `input` shape. + * @see {@link RemoveTagsFromStreamCommandOutput} for command's `response` shape. + * @see {@link KinesisClientResolvedConfig | config} for command's `input` shape. + * */ export class RemoveTagsFromStreamCommand extends $Command< RemoveTagsFromStreamCommandInput, diff --git a/clients/client-kinesis/commands/SplitShardCommand.ts b/clients/client-kinesis/commands/SplitShardCommand.ts index 9fcf29c69841..9eac57983bbc 100644 --- a/clients/client-kinesis/commands/SplitShardCommand.ts +++ b/clients/client-kinesis/commands/SplitShardCommand.ts @@ -63,6 +63,20 @@ export interface SplitShardCommandOutput extends __MetadataBearer {} *

* SplitShard has a limit of five transactions per second per * account.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { KinesisClient, SplitShardCommand } from "@aws-sdk/client-kinesis"; // ES Modules import + * // const { KinesisClient, SplitShardCommand } = require("@aws-sdk/client-kinesis"); // CommonJS import + * const client = new KinesisClient(config); + * const command = new SplitShardCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link SplitShardCommandInput} for command's `input` shape. + * @see {@link SplitShardCommandOutput} for command's `response` shape. + * @see {@link KinesisClientResolvedConfig | config} for command's `input` shape. + * */ export class SplitShardCommand extends $Command< SplitShardCommandInput, diff --git a/clients/client-kinesis/commands/StartStreamEncryptionCommand.ts b/clients/client-kinesis/commands/StartStreamEncryptionCommand.ts index 72e057c836f3..9ea9fed80150 100644 --- a/clients/client-kinesis/commands/StartStreamEncryptionCommand.ts +++ b/clients/client-kinesis/commands/StartStreamEncryptionCommand.ts @@ -37,6 +37,20 @@ export interface StartStreamEncryptionCommandOutput extends __MetadataBearer {} * 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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { KinesisClient, StartStreamEncryptionCommand } from "@aws-sdk/client-kinesis"; // ES Modules import + * // const { KinesisClient, StartStreamEncryptionCommand } = require("@aws-sdk/client-kinesis"); // CommonJS import + * const client = new KinesisClient(config); + * const command = new StartStreamEncryptionCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link StartStreamEncryptionCommandInput} for command's `input` shape. + * @see {@link StartStreamEncryptionCommandOutput} for command's `response` shape. + * @see {@link KinesisClientResolvedConfig | config} for command's `input` shape. + * */ export class StartStreamEncryptionCommand extends $Command< StartStreamEncryptionCommandInput, diff --git a/clients/client-kinesis/commands/StopStreamEncryptionCommand.ts b/clients/client-kinesis/commands/StopStreamEncryptionCommand.ts index ab70f9a9126c..df02fac3eef4 100644 --- a/clients/client-kinesis/commands/StopStreamEncryptionCommand.ts +++ b/clients/client-kinesis/commands/StopStreamEncryptionCommand.ts @@ -37,6 +37,20 @@ export interface StopStreamEncryptionCommandOutput extends __MetadataBearer {} * After you disabled encryption, you can verify that encryption is not applied by * inspecting the API response from PutRecord or * PutRecords.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { KinesisClient, StopStreamEncryptionCommand } from "@aws-sdk/client-kinesis"; // ES Modules import + * // const { KinesisClient, StopStreamEncryptionCommand } = require("@aws-sdk/client-kinesis"); // CommonJS import + * const client = new KinesisClient(config); + * const command = new StopStreamEncryptionCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link StopStreamEncryptionCommandInput} for command's `input` shape. + * @see {@link StopStreamEncryptionCommandOutput} for command's `response` shape. + * @see {@link KinesisClientResolvedConfig | config} for command's `input` shape. + * */ export class StopStreamEncryptionCommand extends $Command< StopStreamEncryptionCommandInput, diff --git a/clients/client-kinesis/commands/SubscribeToShardCommand.ts b/clients/client-kinesis/commands/SubscribeToShardCommand.ts index 43b8a414f920..2a456db3a3a3 100644 --- a/clients/client-kinesis/commands/SubscribeToShardCommand.ts +++ b/clients/client-kinesis/commands/SubscribeToShardCommand.ts @@ -44,6 +44,20 @@ export interface SubscribeToShardCommandOutput extends SubscribeToShardOutput, _ * call will take over the subscription.

*

For an example of how to use this operations, see Enhanced Fan-Out * Using the Kinesis Data Streams API.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { KinesisClient, SubscribeToShardCommand } from "@aws-sdk/client-kinesis"; // ES Modules import + * // const { KinesisClient, SubscribeToShardCommand } = require("@aws-sdk/client-kinesis"); // CommonJS import + * const client = new KinesisClient(config); + * const command = new SubscribeToShardCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link SubscribeToShardCommandInput} for command's `input` shape. + * @see {@link SubscribeToShardCommandOutput} for command's `response` shape. + * @see {@link KinesisClientResolvedConfig | config} for command's `input` shape. + * */ export class SubscribeToShardCommand extends $Command< SubscribeToShardCommandInput, diff --git a/clients/client-kinesis/commands/UpdateShardCountCommand.ts b/clients/client-kinesis/commands/UpdateShardCountCommand.ts index b182d460aa1a..54a80ecaffde 100644 --- a/clients/client-kinesis/commands/UpdateShardCountCommand.ts +++ b/clients/client-kinesis/commands/UpdateShardCountCommand.ts @@ -65,6 +65,20 @@ export interface UpdateShardCountCommandOutput extends UpdateShardCountOutput, _ * 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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { KinesisClient, UpdateShardCountCommand } from "@aws-sdk/client-kinesis"; // ES Modules import + * // const { KinesisClient, UpdateShardCountCommand } = require("@aws-sdk/client-kinesis"); // CommonJS import + * const client = new KinesisClient(config); + * const command = new UpdateShardCountCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link UpdateShardCountCommandInput} for command's `input` shape. + * @see {@link UpdateShardCountCommandOutput} for command's `response` shape. + * @see {@link KinesisClientResolvedConfig | config} for command's `input` shape. + * */ export class UpdateShardCountCommand extends $Command< UpdateShardCountCommandInput, diff --git a/clients/client-kinesis/models/models_0.ts b/clients/client-kinesis/models/models_0.ts index 74549c75a558..7e60b40216f0 100644 --- a/clients/client-kinesis/models/models_0.ts +++ b/clients/client-kinesis/models/models_0.ts @@ -17,6 +17,9 @@ export interface AddTagsToStreamInput { } export namespace AddTagsToStreamInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: AddTagsToStreamInput): any => ({ ...obj, }); @@ -36,6 +39,9 @@ export interface InvalidArgumentException extends __SmithyException, $MetadataBe } export namespace InvalidArgumentException { + /** + * @internal + */ export const filterSensitiveLog = (obj: InvalidArgumentException): any => ({ ...obj, }); @@ -55,6 +61,9 @@ export interface LimitExceededException extends __SmithyException, $MetadataBear } export namespace LimitExceededException { + /** + * @internal + */ export const filterSensitiveLog = (obj: LimitExceededException): any => ({ ...obj, }); @@ -74,6 +83,9 @@ export interface ResourceInUseException extends __SmithyException, $MetadataBear } export namespace ResourceInUseException { + /** + * @internal + */ export const filterSensitiveLog = (obj: ResourceInUseException): any => ({ ...obj, }); @@ -93,6 +105,9 @@ export interface ResourceNotFoundException extends __SmithyException, $MetadataB } export namespace ResourceNotFoundException { + /** + * @internal + */ export const filterSensitiveLog = (obj: ResourceNotFoundException): any => ({ ...obj, }); @@ -115,6 +130,9 @@ export interface HashKeyRange { } export namespace HashKeyRange { + /** + * @internal + */ export const filterSensitiveLog = (obj: HashKeyRange): any => ({ ...obj, }); @@ -131,6 +149,9 @@ export interface ChildShard { } export namespace ChildShard { + /** + * @internal + */ export const filterSensitiveLog = (obj: ChildShard): any => ({ ...obj, }); @@ -175,6 +196,9 @@ export interface Consumer { } export namespace Consumer { + /** + * @internal + */ export const filterSensitiveLog = (obj: Consumer): any => ({ ...obj, }); @@ -218,6 +242,9 @@ export interface ConsumerDescription { } export namespace ConsumerDescription { + /** + * @internal + */ export const filterSensitiveLog = (obj: ConsumerDescription): any => ({ ...obj, }); @@ -244,6 +271,9 @@ export interface CreateStreamInput { } export namespace CreateStreamInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateStreamInput): any => ({ ...obj, }); @@ -266,6 +296,9 @@ export interface DecreaseStreamRetentionPeriodInput { } export namespace DecreaseStreamRetentionPeriodInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: DecreaseStreamRetentionPeriodInput): any => ({ ...obj, }); @@ -289,6 +322,9 @@ export interface DeleteStreamInput { } export namespace DeleteStreamInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteStreamInput): any => ({ ...obj, }); @@ -317,6 +353,9 @@ export interface DeregisterStreamConsumerInput { } export namespace DeregisterStreamConsumerInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeregisterStreamConsumerInput): any => ({ ...obj, }); @@ -325,6 +364,9 @@ export namespace DeregisterStreamConsumerInput { export interface DescribeLimitsInput {} export namespace DescribeLimitsInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeLimitsInput): any => ({ ...obj, }); @@ -343,6 +385,9 @@ export interface DescribeLimitsOutput { } export namespace DescribeLimitsOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeLimitsOutput): any => ({ ...obj, }); @@ -370,6 +415,9 @@ export interface DescribeStreamInput { } export namespace DescribeStreamInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeStreamInput): any => ({ ...obj, }); @@ -449,6 +497,9 @@ export interface EnhancedMetrics { } export namespace EnhancedMetrics { + /** + * @internal + */ export const filterSensitiveLog = (obj: EnhancedMetrics): any => ({ ...obj, }); @@ -471,6 +522,9 @@ export interface SequenceNumberRange { } export namespace SequenceNumberRange { + /** + * @internal + */ export const filterSensitiveLog = (obj: SequenceNumberRange): any => ({ ...obj, }); @@ -508,6 +562,9 @@ export interface Shard { } export namespace Shard { + /** + * @internal + */ export const filterSensitiveLog = (obj: Shard): any => ({ ...obj, }); @@ -646,6 +703,9 @@ export interface StreamDescription { } export namespace StreamDescription { + /** + * @internal + */ export const filterSensitiveLog = (obj: StreamDescription): any => ({ ...obj, }); @@ -664,6 +724,9 @@ export interface DescribeStreamOutput { } export namespace DescribeStreamOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeStreamOutput): any => ({ ...obj, }); @@ -688,6 +751,9 @@ export interface DescribeStreamConsumerInput { } export namespace DescribeStreamConsumerInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeStreamConsumerInput): any => ({ ...obj, }); @@ -701,6 +767,9 @@ export interface DescribeStreamConsumerOutput { } export namespace DescribeStreamConsumerOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeStreamConsumerOutput): any => ({ ...obj, }); @@ -714,6 +783,9 @@ export interface DescribeStreamSummaryInput { } export namespace DescribeStreamSummaryInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeStreamSummaryInput): any => ({ ...obj, }); @@ -844,6 +916,9 @@ export interface StreamDescriptionSummary { } export namespace StreamDescriptionSummary { + /** + * @internal + */ export const filterSensitiveLog = (obj: StreamDescriptionSummary): any => ({ ...obj, }); @@ -858,6 +933,9 @@ export interface DescribeStreamSummaryOutput { } export namespace DescribeStreamSummaryOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeStreamSummaryOutput): any => ({ ...obj, }); @@ -927,6 +1005,9 @@ export interface DisableEnhancedMonitoringInput { } export namespace DisableEnhancedMonitoringInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: DisableEnhancedMonitoringInput): any => ({ ...obj, }); @@ -955,6 +1036,9 @@ export interface EnhancedMonitoringOutput { } export namespace EnhancedMonitoringOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: EnhancedMonitoringOutput): any => ({ ...obj, }); @@ -1023,6 +1107,9 @@ export interface EnableEnhancedMonitoringInput { } export namespace EnableEnhancedMonitoringInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: EnableEnhancedMonitoringInput): any => ({ ...obj, }); @@ -1041,6 +1128,9 @@ export interface ExpiredIteratorException extends __SmithyException, $MetadataBe } export namespace ExpiredIteratorException { + /** + * @internal + */ export const filterSensitiveLog = (obj: ExpiredIteratorException): any => ({ ...obj, }); @@ -1056,6 +1146,9 @@ export interface ExpiredNextTokenException extends __SmithyException, $MetadataB } export namespace ExpiredNextTokenException { + /** + * @internal + */ export const filterSensitiveLog = (obj: ExpiredNextTokenException): any => ({ ...obj, }); @@ -1081,6 +1174,9 @@ export interface GetRecordsInput { } export namespace GetRecordsInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetRecordsInput): any => ({ ...obj, }); @@ -1133,6 +1229,9 @@ export interface _Record { } export namespace _Record { + /** + * @internal + */ export const filterSensitiveLog = (obj: _Record): any => ({ ...obj, }); @@ -1166,6 +1265,9 @@ export interface GetRecordsOutput { } export namespace GetRecordsOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetRecordsOutput): any => ({ ...obj, }); @@ -1185,6 +1287,9 @@ export interface KMSAccessDeniedException extends __SmithyException, $MetadataBe } export namespace KMSAccessDeniedException { + /** + * @internal + */ export const filterSensitiveLog = (obj: KMSAccessDeniedException): any => ({ ...obj, }); @@ -1204,6 +1309,9 @@ export interface KMSDisabledException extends __SmithyException, $MetadataBearer } export namespace KMSDisabledException { + /** + * @internal + */ export const filterSensitiveLog = (obj: KMSDisabledException): any => ({ ...obj, }); @@ -1225,6 +1333,9 @@ export interface KMSInvalidStateException extends __SmithyException, $MetadataBe } export namespace KMSInvalidStateException { + /** + * @internal + */ export const filterSensitiveLog = (obj: KMSInvalidStateException): any => ({ ...obj, }); @@ -1244,6 +1355,9 @@ export interface KMSNotFoundException extends __SmithyException, $MetadataBearer } export namespace KMSNotFoundException { + /** + * @internal + */ export const filterSensitiveLog = (obj: KMSNotFoundException): any => ({ ...obj, }); @@ -1262,6 +1376,9 @@ export interface KMSOptInRequired extends __SmithyException, $MetadataBearer { } export namespace KMSOptInRequired { + /** + * @internal + */ export const filterSensitiveLog = (obj: KMSOptInRequired): any => ({ ...obj, }); @@ -1282,6 +1399,9 @@ export interface KMSThrottlingException extends __SmithyException, $MetadataBear } export namespace KMSThrottlingException { + /** + * @internal + */ export const filterSensitiveLog = (obj: KMSThrottlingException): any => ({ ...obj, }); @@ -1305,6 +1425,9 @@ export interface ProvisionedThroughputExceededException extends __SmithyExceptio } export namespace ProvisionedThroughputExceededException { + /** + * @internal + */ export const filterSensitiveLog = (obj: ProvisionedThroughputExceededException): any => ({ ...obj, }); @@ -1387,6 +1510,9 @@ export interface GetShardIteratorInput { } export namespace GetShardIteratorInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetShardIteratorInput): any => ({ ...obj, }); @@ -1405,6 +1531,9 @@ export interface GetShardIteratorOutput { } export namespace GetShardIteratorOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetShardIteratorOutput): any => ({ ...obj, }); @@ -1427,6 +1556,9 @@ export interface IncreaseStreamRetentionPeriodInput { } export namespace IncreaseStreamRetentionPeriodInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: IncreaseStreamRetentionPeriodInput): any => ({ ...obj, }); @@ -1443,6 +1575,9 @@ export interface InternalFailureException extends __SmithyException { } export namespace InternalFailureException { + /** + * @internal + */ export const filterSensitiveLog = (obj: InternalFailureException): any => ({ ...obj, }); @@ -1464,6 +1599,9 @@ export interface ShardFilter { } export namespace ShardFilter { + /** + * @internal + */ export const filterSensitiveLog = (obj: ShardFilter): any => ({ ...obj, }); @@ -1538,6 +1676,9 @@ export interface ListShardsInput { } export namespace ListShardsInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListShardsInput): any => ({ ...obj, }); @@ -1572,6 +1713,9 @@ export interface ListShardsOutput { } export namespace ListShardsOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListShardsOutput): any => ({ ...obj, }); @@ -1628,6 +1772,9 @@ export interface ListStreamConsumersInput { } export namespace ListStreamConsumersInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListStreamConsumersInput): any => ({ ...obj, }); @@ -1660,6 +1807,9 @@ export interface ListStreamConsumersOutput { } export namespace ListStreamConsumersOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListStreamConsumersOutput): any => ({ ...obj, }); @@ -1681,6 +1831,9 @@ export interface ListStreamsInput { } export namespace ListStreamsInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListStreamsInput): any => ({ ...obj, }); @@ -1703,6 +1856,9 @@ export interface ListStreamsOutput { } export namespace ListStreamsOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListStreamsOutput): any => ({ ...obj, }); @@ -1734,6 +1890,9 @@ export interface ListTagsForStreamInput { } export namespace ListTagsForStreamInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListTagsForStreamInput): any => ({ ...obj, }); @@ -1758,6 +1917,9 @@ export interface Tag { } export namespace Tag { + /** + * @internal + */ export const filterSensitiveLog = (obj: Tag): any => ({ ...obj, }); @@ -1782,6 +1944,9 @@ export interface ListTagsForStreamOutput { } export namespace ListTagsForStreamOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListTagsForStreamOutput): any => ({ ...obj, }); @@ -1809,6 +1974,9 @@ export interface MergeShardsInput { } export namespace MergeShardsInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: MergeShardsInput): any => ({ ...obj, }); @@ -1859,6 +2027,9 @@ export interface PutRecordInput { } export namespace PutRecordInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: PutRecordInput): any => ({ ...obj, }); @@ -1899,6 +2070,9 @@ export interface PutRecordOutput { } export namespace PutRecordOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: PutRecordOutput): any => ({ ...obj, }); @@ -1935,6 +2109,9 @@ export interface PutRecordsRequestEntry { } export namespace PutRecordsRequestEntry { + /** + * @internal + */ export const filterSensitiveLog = (obj: PutRecordsRequestEntry): any => ({ ...obj, }); @@ -1956,6 +2133,9 @@ export interface PutRecordsInput { } export namespace PutRecordsInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: PutRecordsInput): any => ({ ...obj, }); @@ -1997,6 +2177,9 @@ export interface PutRecordsResultEntry { } export namespace PutRecordsResultEntry { + /** + * @internal + */ export const filterSensitiveLog = (obj: PutRecordsResultEntry): any => ({ ...obj, }); @@ -2041,6 +2224,9 @@ export interface PutRecordsOutput { } export namespace PutRecordsOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: PutRecordsOutput): any => ({ ...obj, }); @@ -2061,6 +2247,9 @@ export interface RegisterStreamConsumerInput { } export namespace RegisterStreamConsumerInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: RegisterStreamConsumerInput): any => ({ ...obj, }); @@ -2075,6 +2264,9 @@ export interface RegisterStreamConsumerOutput { } export namespace RegisterStreamConsumerOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: RegisterStreamConsumerOutput): any => ({ ...obj, }); @@ -2096,6 +2288,9 @@ export interface RemoveTagsFromStreamInput { } export namespace RemoveTagsFromStreamInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: RemoveTagsFromStreamInput): any => ({ ...obj, }); @@ -2128,6 +2323,9 @@ export interface SplitShardInput { } export namespace SplitShardInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: SplitShardInput): any => ({ ...obj, }); @@ -2181,6 +2379,9 @@ export interface StartStreamEncryptionInput { } export namespace StartStreamEncryptionInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: StartStreamEncryptionInput): any => ({ ...obj, }); @@ -2234,6 +2435,9 @@ export interface StopStreamEncryptionInput { } export namespace StopStreamEncryptionInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: StopStreamEncryptionInput): any => ({ ...obj, }); @@ -2283,6 +2487,9 @@ export interface StartingPosition { } export namespace StartingPosition { + /** + * @internal + */ export const filterSensitiveLog = (obj: StartingPosition): any => ({ ...obj, }); @@ -2307,6 +2514,9 @@ export interface SubscribeToShardInput { } export namespace SubscribeToShardInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: SubscribeToShardInput): any => ({ ...obj, }); @@ -2341,6 +2551,9 @@ export interface SubscribeToShardEvent { } export namespace SubscribeToShardEvent { + /** + * @internal + */ export const filterSensitiveLog = (obj: SubscribeToShardEvent): any => ({ ...obj, }); @@ -2593,6 +2806,9 @@ export namespace SubscribeToShardEventStream { return visitor._(value.$unknown[0], value.$unknown[1]); }; + /** + * @internal + */ export const filterSensitiveLog = (obj: SubscribeToShardEventStream): any => { if (obj.SubscribeToShardEvent !== undefined) return { SubscribeToShardEvent: SubscribeToShardEvent.filterSensitiveLog(obj.SubscribeToShardEvent) }; @@ -2626,6 +2842,9 @@ export interface SubscribeToShardOutput { } export namespace SubscribeToShardOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: SubscribeToShardOutput): any => ({ ...obj, ...(obj.EventStream && { EventStream: "STREAMING_CONTENT" }), @@ -2673,6 +2892,9 @@ export interface UpdateShardCountInput { } export namespace UpdateShardCountInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateShardCountInput): any => ({ ...obj, }); @@ -2696,6 +2918,9 @@ export interface UpdateShardCountOutput { } export namespace UpdateShardCountOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateShardCountOutput): any => ({ ...obj, }); diff --git a/clients/client-kms/commands/CancelKeyDeletionCommand.ts b/clients/client-kms/commands/CancelKeyDeletionCommand.ts index e39ea0ec33bb..6563d7d80c55 100644 --- a/clients/client-kms/commands/CancelKeyDeletionCommand.ts +++ b/clients/client-kms/commands/CancelKeyDeletionCommand.ts @@ -35,6 +35,20 @@ export interface CancelKeyDeletionCommandOutput extends CancelKeyDeletionRespons *

* Related operations: ScheduleKeyDeletion *

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { KMSClient, CancelKeyDeletionCommand } from "@aws-sdk/client-kms"; // ES Modules import + * // const { KMSClient, CancelKeyDeletionCommand } = require("@aws-sdk/client-kms"); // CommonJS import + * const client = new KMSClient(config); + * const command = new CancelKeyDeletionCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CancelKeyDeletionCommandInput} for command's `input` shape. + * @see {@link CancelKeyDeletionCommandOutput} for command's `response` shape. + * @see {@link KMSClientResolvedConfig | config} for command's `input` shape. + * */ export class CancelKeyDeletionCommand extends $Command< CancelKeyDeletionCommandInput, diff --git a/clients/client-kms/commands/ConnectCustomKeyStoreCommand.ts b/clients/client-kms/commands/ConnectCustomKeyStoreCommand.ts index c4be7aeb0534..289927ee9b39 100644 --- a/clients/client-kms/commands/ConnectCustomKeyStoreCommand.ts +++ b/clients/client-kms/commands/ConnectCustomKeyStoreCommand.ts @@ -83,6 +83,20 @@ export interface ConnectCustomKeyStoreCommandOutput extends ConnectCustomKeyStor *

* * + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { KMSClient, ConnectCustomKeyStoreCommand } from "@aws-sdk/client-kms"; // ES Modules import + * // const { KMSClient, ConnectCustomKeyStoreCommand } = require("@aws-sdk/client-kms"); // CommonJS import + * const client = new KMSClient(config); + * const command = new ConnectCustomKeyStoreCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ConnectCustomKeyStoreCommandInput} for command's `input` shape. + * @see {@link ConnectCustomKeyStoreCommandOutput} for command's `response` shape. + * @see {@link KMSClientResolvedConfig | config} for command's `input` shape. + * */ export class ConnectCustomKeyStoreCommand extends $Command< ConnectCustomKeyStoreCommandInput, diff --git a/clients/client-kms/commands/CreateAliasCommand.ts b/clients/client-kms/commands/CreateAliasCommand.ts index fb0a1d0821c6..61d4fd8e809e 100644 --- a/clients/client-kms/commands/CreateAliasCommand.ts +++ b/clients/client-kms/commands/CreateAliasCommand.ts @@ -74,6 +74,20 @@ export interface CreateAliasCommandOutput extends __MetadataBearer {} *

* * + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { KMSClient, CreateAliasCommand } from "@aws-sdk/client-kms"; // ES Modules import + * // const { KMSClient, CreateAliasCommand } = require("@aws-sdk/client-kms"); // CommonJS import + * const client = new KMSClient(config); + * const command = new CreateAliasCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreateAliasCommandInput} for command's `input` shape. + * @see {@link CreateAliasCommandOutput} for command's `response` shape. + * @see {@link KMSClientResolvedConfig | config} for command's `input` shape. + * */ export class CreateAliasCommand extends $Command< CreateAliasCommandInput, diff --git a/clients/client-kms/commands/CreateCustomKeyStoreCommand.ts b/clients/client-kms/commands/CreateCustomKeyStoreCommand.ts index a610c2c169f1..fde24c495f05 100644 --- a/clients/client-kms/commands/CreateCustomKeyStoreCommand.ts +++ b/clients/client-kms/commands/CreateCustomKeyStoreCommand.ts @@ -71,6 +71,20 @@ export interface CreateCustomKeyStoreCommandOutput extends CreateCustomKeyStoreR *

* * + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { KMSClient, CreateCustomKeyStoreCommand } from "@aws-sdk/client-kms"; // ES Modules import + * // const { KMSClient, CreateCustomKeyStoreCommand } = require("@aws-sdk/client-kms"); // CommonJS import + * const client = new KMSClient(config); + * const command = new CreateCustomKeyStoreCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreateCustomKeyStoreCommandInput} for command's `input` shape. + * @see {@link CreateCustomKeyStoreCommandOutput} for command's `response` shape. + * @see {@link KMSClientResolvedConfig | config} for command's `input` shape. + * */ export class CreateCustomKeyStoreCommand extends $Command< CreateCustomKeyStoreCommandInput, diff --git a/clients/client-kms/commands/CreateGrantCommand.ts b/clients/client-kms/commands/CreateGrantCommand.ts index 11d68ac6cf85..63f2dabd1cc4 100644 --- a/clients/client-kms/commands/CreateGrantCommand.ts +++ b/clients/client-kms/commands/CreateGrantCommand.ts @@ -91,6 +91,20 @@ export interface CreateGrantCommandOutput extends CreateGrantResponse, __Metadat *

* * + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { KMSClient, CreateGrantCommand } from "@aws-sdk/client-kms"; // ES Modules import + * // const { KMSClient, CreateGrantCommand } = require("@aws-sdk/client-kms"); // CommonJS import + * const client = new KMSClient(config); + * const command = new CreateGrantCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreateGrantCommandInput} for command's `input` shape. + * @see {@link CreateGrantCommandOutput} for command's `response` shape. + * @see {@link KMSClientResolvedConfig | config} for command's `input` shape. + * */ export class CreateGrantCommand extends $Command< CreateGrantCommandInput, diff --git a/clients/client-kms/commands/CreateKeyCommand.ts b/clients/client-kms/commands/CreateKeyCommand.ts index 742e0e0b7ea4..6df04ca4c834 100644 --- a/clients/client-kms/commands/CreateKeyCommand.ts +++ b/clients/client-kms/commands/CreateKeyCommand.ts @@ -122,6 +122,20 @@ export interface CreateKeyCommandOutput extends CreateKeyResponse, __MetadataBea *

* * + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { KMSClient, CreateKeyCommand } from "@aws-sdk/client-kms"; // ES Modules import + * // const { KMSClient, CreateKeyCommand } = require("@aws-sdk/client-kms"); // CommonJS import + * const client = new KMSClient(config); + * const command = new CreateKeyCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreateKeyCommandInput} for command's `input` shape. + * @see {@link CreateKeyCommandOutput} for command's `response` shape. + * @see {@link KMSClientResolvedConfig | config} for command's `input` shape. + * */ export class CreateKeyCommand extends $Command { // Start section: command_properties diff --git a/clients/client-kms/commands/DecryptCommand.ts b/clients/client-kms/commands/DecryptCommand.ts index f0b4c15c5804..e265eaf52767 100644 --- a/clients/client-kms/commands/DecryptCommand.ts +++ b/clients/client-kms/commands/DecryptCommand.ts @@ -104,6 +104,20 @@ export interface DecryptCommandOutput extends DecryptResponse, __MetadataBearer *

* * + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { KMSClient, DecryptCommand } from "@aws-sdk/client-kms"; // ES Modules import + * // const { KMSClient, DecryptCommand } = require("@aws-sdk/client-kms"); // CommonJS import + * const client = new KMSClient(config); + * const command = new DecryptCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DecryptCommandInput} for command's `input` shape. + * @see {@link DecryptCommandOutput} for command's `response` shape. + * @see {@link KMSClientResolvedConfig | config} for command's `input` shape. + * */ export class DecryptCommand extends $Command { // Start section: command_properties diff --git a/clients/client-kms/commands/DeleteAliasCommand.ts b/clients/client-kms/commands/DeleteAliasCommand.ts index 9c509fe0e784..e92d7d5e84c2 100644 --- a/clients/client-kms/commands/DeleteAliasCommand.ts +++ b/clients/client-kms/commands/DeleteAliasCommand.ts @@ -63,6 +63,20 @@ export interface DeleteAliasCommandOutput extends __MetadataBearer {} *

* * + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { KMSClient, DeleteAliasCommand } from "@aws-sdk/client-kms"; // ES Modules import + * // const { KMSClient, DeleteAliasCommand } = require("@aws-sdk/client-kms"); // CommonJS import + * const client = new KMSClient(config); + * const command = new DeleteAliasCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteAliasCommandInput} for command's `input` shape. + * @see {@link DeleteAliasCommandOutput} for command's `response` shape. + * @see {@link KMSClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteAliasCommand extends $Command< DeleteAliasCommandInput, diff --git a/clients/client-kms/commands/DeleteCustomKeyStoreCommand.ts b/clients/client-kms/commands/DeleteCustomKeyStoreCommand.ts index 089f9040a3fa..230e3f87a968 100644 --- a/clients/client-kms/commands/DeleteCustomKeyStoreCommand.ts +++ b/clients/client-kms/commands/DeleteCustomKeyStoreCommand.ts @@ -77,6 +77,20 @@ export interface DeleteCustomKeyStoreCommandOutput extends DeleteCustomKeyStoreR *

* * + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { KMSClient, DeleteCustomKeyStoreCommand } from "@aws-sdk/client-kms"; // ES Modules import + * // const { KMSClient, DeleteCustomKeyStoreCommand } = require("@aws-sdk/client-kms"); // CommonJS import + * const client = new KMSClient(config); + * const command = new DeleteCustomKeyStoreCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteCustomKeyStoreCommandInput} for command's `input` shape. + * @see {@link DeleteCustomKeyStoreCommandOutput} for command's `response` shape. + * @see {@link KMSClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteCustomKeyStoreCommand extends $Command< DeleteCustomKeyStoreCommandInput, diff --git a/clients/client-kms/commands/DeleteImportedKeyMaterialCommand.ts b/clients/client-kms/commands/DeleteImportedKeyMaterialCommand.ts index ec7531bbb4fe..668eb60637ad 100644 --- a/clients/client-kms/commands/DeleteImportedKeyMaterialCommand.ts +++ b/clients/client-kms/commands/DeleteImportedKeyMaterialCommand.ts @@ -53,6 +53,20 @@ export interface DeleteImportedKeyMaterialCommandOutput extends __MetadataBearer *

* * + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { KMSClient, DeleteImportedKeyMaterialCommand } from "@aws-sdk/client-kms"; // ES Modules import + * // const { KMSClient, DeleteImportedKeyMaterialCommand } = require("@aws-sdk/client-kms"); // CommonJS import + * const client = new KMSClient(config); + * const command = new DeleteImportedKeyMaterialCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteImportedKeyMaterialCommandInput} for command's `input` shape. + * @see {@link DeleteImportedKeyMaterialCommandOutput} for command's `response` shape. + * @see {@link KMSClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteImportedKeyMaterialCommand extends $Command< DeleteImportedKeyMaterialCommandInput, diff --git a/clients/client-kms/commands/DescribeCustomKeyStoresCommand.ts b/clients/client-kms/commands/DescribeCustomKeyStoresCommand.ts index d13f30bed9a1..132a42a29336 100644 --- a/clients/client-kms/commands/DescribeCustomKeyStoresCommand.ts +++ b/clients/client-kms/commands/DescribeCustomKeyStoresCommand.ts @@ -75,6 +75,20 @@ export interface DescribeCustomKeyStoresCommandOutput extends DescribeCustomKeyS *

* * + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { KMSClient, DescribeCustomKeyStoresCommand } from "@aws-sdk/client-kms"; // ES Modules import + * // const { KMSClient, DescribeCustomKeyStoresCommand } = require("@aws-sdk/client-kms"); // CommonJS import + * const client = new KMSClient(config); + * const command = new DescribeCustomKeyStoresCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeCustomKeyStoresCommandInput} for command's `input` shape. + * @see {@link DescribeCustomKeyStoresCommandOutput} for command's `response` shape. + * @see {@link KMSClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeCustomKeyStoresCommand extends $Command< DescribeCustomKeyStoresCommandInput, diff --git a/clients/client-kms/commands/DescribeKeyCommand.ts b/clients/client-kms/commands/DescribeKeyCommand.ts index 7df1b7201888..745f4891a981 100644 --- a/clients/client-kms/commands/DescribeKeyCommand.ts +++ b/clients/client-kms/commands/DescribeKeyCommand.ts @@ -100,6 +100,20 @@ export interface DescribeKeyCommandOutput extends DescribeKeyResponse, __Metadat *

* * + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { KMSClient, DescribeKeyCommand } from "@aws-sdk/client-kms"; // ES Modules import + * // const { KMSClient, DescribeKeyCommand } = require("@aws-sdk/client-kms"); // CommonJS import + * const client = new KMSClient(config); + * const command = new DescribeKeyCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeKeyCommandInput} for command's `input` shape. + * @see {@link DescribeKeyCommandOutput} for command's `response` shape. + * @see {@link KMSClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeKeyCommand extends $Command< DescribeKeyCommandInput, diff --git a/clients/client-kms/commands/DisableKeyCommand.ts b/clients/client-kms/commands/DisableKeyCommand.ts index 84dfcbc46b28..b4a1ac2903ac 100644 --- a/clients/client-kms/commands/DisableKeyCommand.ts +++ b/clients/client-kms/commands/DisableKeyCommand.ts @@ -38,6 +38,20 @@ export interface DisableKeyCommandOutput extends __MetadataBearer {} *

* Related operations: EnableKey *

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { KMSClient, DisableKeyCommand } from "@aws-sdk/client-kms"; // ES Modules import + * // const { KMSClient, DisableKeyCommand } = require("@aws-sdk/client-kms"); // CommonJS import + * const client = new KMSClient(config); + * const command = new DisableKeyCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DisableKeyCommandInput} for command's `input` shape. + * @see {@link DisableKeyCommandOutput} for command's `response` shape. + * @see {@link KMSClientResolvedConfig | config} for command's `input` shape. + * */ export class DisableKeyCommand extends $Command< DisableKeyCommandInput, diff --git a/clients/client-kms/commands/DisableKeyRotationCommand.ts b/clients/client-kms/commands/DisableKeyRotationCommand.ts index 12eab22e7d37..74e135f567dd 100644 --- a/clients/client-kms/commands/DisableKeyRotationCommand.ts +++ b/clients/client-kms/commands/DisableKeyRotationCommand.ts @@ -48,6 +48,20 @@ export interface DisableKeyRotationCommandOutput extends __MetadataBearer {} *

* * + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { KMSClient, DisableKeyRotationCommand } from "@aws-sdk/client-kms"; // ES Modules import + * // const { KMSClient, DisableKeyRotationCommand } = require("@aws-sdk/client-kms"); // CommonJS import + * const client = new KMSClient(config); + * const command = new DisableKeyRotationCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DisableKeyRotationCommandInput} for command's `input` shape. + * @see {@link DisableKeyRotationCommandOutput} for command's `response` shape. + * @see {@link KMSClientResolvedConfig | config} for command's `input` shape. + * */ export class DisableKeyRotationCommand extends $Command< DisableKeyRotationCommandInput, diff --git a/clients/client-kms/commands/DisconnectCustomKeyStoreCommand.ts b/clients/client-kms/commands/DisconnectCustomKeyStoreCommand.ts index 313c76ad5d00..021428f86435 100644 --- a/clients/client-kms/commands/DisconnectCustomKeyStoreCommand.ts +++ b/clients/client-kms/commands/DisconnectCustomKeyStoreCommand.ts @@ -74,6 +74,20 @@ export interface DisconnectCustomKeyStoreCommandOutput extends DisconnectCustomK *

* * + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { KMSClient, DisconnectCustomKeyStoreCommand } from "@aws-sdk/client-kms"; // ES Modules import + * // const { KMSClient, DisconnectCustomKeyStoreCommand } = require("@aws-sdk/client-kms"); // CommonJS import + * const client = new KMSClient(config); + * const command = new DisconnectCustomKeyStoreCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DisconnectCustomKeyStoreCommandInput} for command's `input` shape. + * @see {@link DisconnectCustomKeyStoreCommandOutput} for command's `response` shape. + * @see {@link KMSClientResolvedConfig | config} for command's `input` shape. + * */ export class DisconnectCustomKeyStoreCommand extends $Command< DisconnectCustomKeyStoreCommandInput, diff --git a/clients/client-kms/commands/EnableKeyCommand.ts b/clients/client-kms/commands/EnableKeyCommand.ts index 480c88f74c6c..c95576fa09b7 100644 --- a/clients/client-kms/commands/EnableKeyCommand.ts +++ b/clients/client-kms/commands/EnableKeyCommand.ts @@ -31,6 +31,20 @@ export interface EnableKeyCommandOutput extends __MetadataBearer {} *

* Related operations: DisableKey *

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { KMSClient, EnableKeyCommand } from "@aws-sdk/client-kms"; // ES Modules import + * // const { KMSClient, EnableKeyCommand } = require("@aws-sdk/client-kms"); // CommonJS import + * const client = new KMSClient(config); + * const command = new EnableKeyCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link EnableKeyCommandInput} for command's `input` shape. + * @see {@link EnableKeyCommandOutput} for command's `response` shape. + * @see {@link KMSClientResolvedConfig | config} for command's `input` shape. + * */ export class EnableKeyCommand extends $Command { // Start section: command_properties diff --git a/clients/client-kms/commands/EnableKeyRotationCommand.ts b/clients/client-kms/commands/EnableKeyRotationCommand.ts index 5b10caf207e2..f189896a2594 100644 --- a/clients/client-kms/commands/EnableKeyRotationCommand.ts +++ b/clients/client-kms/commands/EnableKeyRotationCommand.ts @@ -47,6 +47,20 @@ export interface EnableKeyRotationCommandOutput extends __MetadataBearer {} *

* * + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { KMSClient, EnableKeyRotationCommand } from "@aws-sdk/client-kms"; // ES Modules import + * // const { KMSClient, EnableKeyRotationCommand } = require("@aws-sdk/client-kms"); // CommonJS import + * const client = new KMSClient(config); + * const command = new EnableKeyRotationCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link EnableKeyRotationCommandInput} for command's `input` shape. + * @see {@link EnableKeyRotationCommandOutput} for command's `response` shape. + * @see {@link KMSClientResolvedConfig | config} for command's `input` shape. + * */ export class EnableKeyRotationCommand extends $Command< EnableKeyRotationCommandInput, diff --git a/clients/client-kms/commands/EncryptCommand.ts b/clients/client-kms/commands/EncryptCommand.ts index 5bd8923fffb9..e32a23e546e4 100644 --- a/clients/client-kms/commands/EncryptCommand.ts +++ b/clients/client-kms/commands/EncryptCommand.ts @@ -143,6 +143,20 @@ export interface EncryptCommandOutput extends EncryptResponse, __MetadataBearer *

* * + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { KMSClient, EncryptCommand } from "@aws-sdk/client-kms"; // ES Modules import + * // const { KMSClient, EncryptCommand } = require("@aws-sdk/client-kms"); // CommonJS import + * const client = new KMSClient(config); + * const command = new EncryptCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link EncryptCommandInput} for command's `input` shape. + * @see {@link EncryptCommandOutput} for command's `response` shape. + * @see {@link KMSClientResolvedConfig | config} for command's `input` shape. + * */ export class EncryptCommand extends $Command { // Start section: command_properties diff --git a/clients/client-kms/commands/GenerateDataKeyCommand.ts b/clients/client-kms/commands/GenerateDataKeyCommand.ts index bf075e6f390f..d2cf41f258fc 100644 --- a/clients/client-kms/commands/GenerateDataKeyCommand.ts +++ b/clients/client-kms/commands/GenerateDataKeyCommand.ts @@ -116,6 +116,20 @@ export interface GenerateDataKeyCommandOutput extends GenerateDataKeyResponse, _ *

* * + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { KMSClient, GenerateDataKeyCommand } from "@aws-sdk/client-kms"; // ES Modules import + * // const { KMSClient, GenerateDataKeyCommand } = require("@aws-sdk/client-kms"); // CommonJS import + * const client = new KMSClient(config); + * const command = new GenerateDataKeyCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GenerateDataKeyCommandInput} for command's `input` shape. + * @see {@link GenerateDataKeyCommandOutput} for command's `response` shape. + * @see {@link KMSClientResolvedConfig | config} for command's `input` shape. + * */ export class GenerateDataKeyCommand extends $Command< GenerateDataKeyCommandInput, diff --git a/clients/client-kms/commands/GenerateDataKeyPairCommand.ts b/clients/client-kms/commands/GenerateDataKeyPairCommand.ts index aac4fdb3fa16..2a47d5cbb02a 100644 --- a/clients/client-kms/commands/GenerateDataKeyPairCommand.ts +++ b/clients/client-kms/commands/GenerateDataKeyPairCommand.ts @@ -91,6 +91,20 @@ export interface GenerateDataKeyPairCommandOutput extends GenerateDataKeyPairRes *

* * + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { KMSClient, GenerateDataKeyPairCommand } from "@aws-sdk/client-kms"; // ES Modules import + * // const { KMSClient, GenerateDataKeyPairCommand } = require("@aws-sdk/client-kms"); // CommonJS import + * const client = new KMSClient(config); + * const command = new GenerateDataKeyPairCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GenerateDataKeyPairCommandInput} for command's `input` shape. + * @see {@link GenerateDataKeyPairCommandOutput} for command's `response` shape. + * @see {@link KMSClientResolvedConfig | config} for command's `input` shape. + * */ export class GenerateDataKeyPairCommand extends $Command< GenerateDataKeyPairCommandInput, diff --git a/clients/client-kms/commands/GenerateDataKeyPairWithoutPlaintextCommand.ts b/clients/client-kms/commands/GenerateDataKeyPairWithoutPlaintextCommand.ts index c63c63414170..9be1bc8166f5 100644 --- a/clients/client-kms/commands/GenerateDataKeyPairWithoutPlaintextCommand.ts +++ b/clients/client-kms/commands/GenerateDataKeyPairWithoutPlaintextCommand.ts @@ -87,6 +87,20 @@ export interface GenerateDataKeyPairWithoutPlaintextCommandOutput *

* * + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { KMSClient, GenerateDataKeyPairWithoutPlaintextCommand } from "@aws-sdk/client-kms"; // ES Modules import + * // const { KMSClient, GenerateDataKeyPairWithoutPlaintextCommand } = require("@aws-sdk/client-kms"); // CommonJS import + * const client = new KMSClient(config); + * const command = new GenerateDataKeyPairWithoutPlaintextCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GenerateDataKeyPairWithoutPlaintextCommandInput} for command's `input` shape. + * @see {@link GenerateDataKeyPairWithoutPlaintextCommandOutput} for command's `response` shape. + * @see {@link KMSClientResolvedConfig | config} for command's `input` shape. + * */ export class GenerateDataKeyPairWithoutPlaintextCommand extends $Command< GenerateDataKeyPairWithoutPlaintextCommandInput, diff --git a/clients/client-kms/commands/GenerateDataKeyWithoutPlaintextCommand.ts b/clients/client-kms/commands/GenerateDataKeyWithoutPlaintextCommand.ts index 851bf7c2b36e..95535df9e3c2 100644 --- a/clients/client-kms/commands/GenerateDataKeyWithoutPlaintextCommand.ts +++ b/clients/client-kms/commands/GenerateDataKeyWithoutPlaintextCommand.ts @@ -94,6 +94,20 @@ export interface GenerateDataKeyWithoutPlaintextCommandOutput *

* * + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { KMSClient, GenerateDataKeyWithoutPlaintextCommand } from "@aws-sdk/client-kms"; // ES Modules import + * // const { KMSClient, GenerateDataKeyWithoutPlaintextCommand } = require("@aws-sdk/client-kms"); // CommonJS import + * const client = new KMSClient(config); + * const command = new GenerateDataKeyWithoutPlaintextCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GenerateDataKeyWithoutPlaintextCommandInput} for command's `input` shape. + * @see {@link GenerateDataKeyWithoutPlaintextCommandOutput} for command's `response` shape. + * @see {@link KMSClientResolvedConfig | config} for command's `input` shape. + * */ export class GenerateDataKeyWithoutPlaintextCommand extends $Command< GenerateDataKeyWithoutPlaintextCommandInput, diff --git a/clients/client-kms/commands/GenerateRandomCommand.ts b/clients/client-kms/commands/GenerateRandomCommand.ts index 40bc20344cf0..a79a438d1a4c 100644 --- a/clients/client-kms/commands/GenerateRandomCommand.ts +++ b/clients/client-kms/commands/GenerateRandomCommand.ts @@ -30,6 +30,20 @@ export interface GenerateRandomCommandOutput extends GenerateRandomResponse, __M * *

* Required permissions: kms:GenerateRandom (IAM policy)

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { KMSClient, GenerateRandomCommand } from "@aws-sdk/client-kms"; // ES Modules import + * // const { KMSClient, GenerateRandomCommand } = require("@aws-sdk/client-kms"); // CommonJS import + * const client = new KMSClient(config); + * const command = new GenerateRandomCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GenerateRandomCommandInput} for command's `input` shape. + * @see {@link GenerateRandomCommandOutput} for command's `response` shape. + * @see {@link KMSClientResolvedConfig | config} for command's `input` shape. + * */ export class GenerateRandomCommand extends $Command< GenerateRandomCommandInput, diff --git a/clients/client-kms/commands/GetKeyPolicyCommand.ts b/clients/client-kms/commands/GetKeyPolicyCommand.ts index 0ea9d7b60ef0..87e33e468a22 100644 --- a/clients/client-kms/commands/GetKeyPolicyCommand.ts +++ b/clients/client-kms/commands/GetKeyPolicyCommand.ts @@ -30,6 +30,20 @@ export interface GetKeyPolicyCommandOutput extends GetKeyPolicyResponse, __Metad *

* Related operations: PutKeyPolicy *

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { KMSClient, GetKeyPolicyCommand } from "@aws-sdk/client-kms"; // ES Modules import + * // const { KMSClient, GetKeyPolicyCommand } = require("@aws-sdk/client-kms"); // CommonJS import + * const client = new KMSClient(config); + * const command = new GetKeyPolicyCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetKeyPolicyCommandInput} for command's `input` shape. + * @see {@link GetKeyPolicyCommandOutput} for command's `response` shape. + * @see {@link KMSClientResolvedConfig | config} for command's `input` shape. + * */ export class GetKeyPolicyCommand extends $Command< GetKeyPolicyCommandInput, diff --git a/clients/client-kms/commands/GetKeyRotationStatusCommand.ts b/clients/client-kms/commands/GetKeyRotationStatusCommand.ts index 070fb6803bf0..3916232c1889 100644 --- a/clients/client-kms/commands/GetKeyRotationStatusCommand.ts +++ b/clients/client-kms/commands/GetKeyRotationStatusCommand.ts @@ -59,6 +59,20 @@ export interface GetKeyRotationStatusCommandOutput extends GetKeyRotationStatusR *

* * + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { KMSClient, GetKeyRotationStatusCommand } from "@aws-sdk/client-kms"; // ES Modules import + * // const { KMSClient, GetKeyRotationStatusCommand } = require("@aws-sdk/client-kms"); // CommonJS import + * const client = new KMSClient(config); + * const command = new GetKeyRotationStatusCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetKeyRotationStatusCommandInput} for command's `input` shape. + * @see {@link GetKeyRotationStatusCommandOutput} for command's `response` shape. + * @see {@link KMSClientResolvedConfig | config} for command's `input` shape. + * */ export class GetKeyRotationStatusCommand extends $Command< GetKeyRotationStatusCommandInput, diff --git a/clients/client-kms/commands/GetParametersForImportCommand.ts b/clients/client-kms/commands/GetParametersForImportCommand.ts index 4c282864bd4d..db2f07f011ed 100644 --- a/clients/client-kms/commands/GetParametersForImportCommand.ts +++ b/clients/client-kms/commands/GetParametersForImportCommand.ts @@ -58,6 +58,20 @@ export interface GetParametersForImportCommandOutput extends GetParametersForImp *

* * + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { KMSClient, GetParametersForImportCommand } from "@aws-sdk/client-kms"; // ES Modules import + * // const { KMSClient, GetParametersForImportCommand } = require("@aws-sdk/client-kms"); // CommonJS import + * const client = new KMSClient(config); + * const command = new GetParametersForImportCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetParametersForImportCommandInput} for command's `input` shape. + * @see {@link GetParametersForImportCommandOutput} for command's `response` shape. + * @see {@link KMSClientResolvedConfig | config} for command's `input` shape. + * */ export class GetParametersForImportCommand extends $Command< GetParametersForImportCommandInput, diff --git a/clients/client-kms/commands/GetPublicKeyCommand.ts b/clients/client-kms/commands/GetPublicKeyCommand.ts index a4c9f5846158..fb466a652257 100644 --- a/clients/client-kms/commands/GetPublicKeyCommand.ts +++ b/clients/client-kms/commands/GetPublicKeyCommand.ts @@ -67,6 +67,20 @@ export interface GetPublicKeyCommandOutput extends GetPublicKeyResponse, __Metad *

* Related operations: CreateKey *

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { KMSClient, GetPublicKeyCommand } from "@aws-sdk/client-kms"; // ES Modules import + * // const { KMSClient, GetPublicKeyCommand } = require("@aws-sdk/client-kms"); // CommonJS import + * const client = new KMSClient(config); + * const command = new GetPublicKeyCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetPublicKeyCommandInput} for command's `input` shape. + * @see {@link GetPublicKeyCommandOutput} for command's `response` shape. + * @see {@link KMSClientResolvedConfig | config} for command's `input` shape. + * */ export class GetPublicKeyCommand extends $Command< GetPublicKeyCommandInput, diff --git a/clients/client-kms/commands/ImportKeyMaterialCommand.ts b/clients/client-kms/commands/ImportKeyMaterialCommand.ts index 114a3bc99351..7a82ae8eb2d2 100644 --- a/clients/client-kms/commands/ImportKeyMaterialCommand.ts +++ b/clients/client-kms/commands/ImportKeyMaterialCommand.ts @@ -86,6 +86,20 @@ export interface ImportKeyMaterialCommandOutput extends ImportKeyMaterialRespons *

* * + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { KMSClient, ImportKeyMaterialCommand } from "@aws-sdk/client-kms"; // ES Modules import + * // const { KMSClient, ImportKeyMaterialCommand } = require("@aws-sdk/client-kms"); // CommonJS import + * const client = new KMSClient(config); + * const command = new ImportKeyMaterialCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ImportKeyMaterialCommandInput} for command's `input` shape. + * @see {@link ImportKeyMaterialCommandOutput} for command's `response` shape. + * @see {@link KMSClientResolvedConfig | config} for command's `input` shape. + * */ export class ImportKeyMaterialCommand extends $Command< ImportKeyMaterialCommandInput, diff --git a/clients/client-kms/commands/ListAliasesCommand.ts b/clients/client-kms/commands/ListAliasesCommand.ts index cec7cbb474f7..36ac33bcb7b9 100644 --- a/clients/client-kms/commands/ListAliasesCommand.ts +++ b/clients/client-kms/commands/ListAliasesCommand.ts @@ -63,6 +63,20 @@ export interface ListAliasesCommandOutput extends ListAliasesResponse, __Metadat *

* * + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { KMSClient, ListAliasesCommand } from "@aws-sdk/client-kms"; // ES Modules import + * // const { KMSClient, ListAliasesCommand } = require("@aws-sdk/client-kms"); // CommonJS import + * const client = new KMSClient(config); + * const command = new ListAliasesCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListAliasesCommandInput} for command's `input` shape. + * @see {@link ListAliasesCommandOutput} for command's `response` shape. + * @see {@link KMSClientResolvedConfig | config} for command's `input` shape. + * */ export class ListAliasesCommand extends $Command< ListAliasesCommandInput, diff --git a/clients/client-kms/commands/ListGrantsCommand.ts b/clients/client-kms/commands/ListGrantsCommand.ts index 237b1c1711ec..d7d73916f1c4 100644 --- a/clients/client-kms/commands/ListGrantsCommand.ts +++ b/clients/client-kms/commands/ListGrantsCommand.ts @@ -62,6 +62,20 @@ export interface ListGrantsCommandOutput extends ListGrantsResponse, __MetadataB *

* * + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { KMSClient, ListGrantsCommand } from "@aws-sdk/client-kms"; // ES Modules import + * // const { KMSClient, ListGrantsCommand } = require("@aws-sdk/client-kms"); // CommonJS import + * const client = new KMSClient(config); + * const command = new ListGrantsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListGrantsCommandInput} for command's `input` shape. + * @see {@link ListGrantsCommandOutput} for command's `response` shape. + * @see {@link KMSClientResolvedConfig | config} for command's `input` shape. + * */ export class ListGrantsCommand extends $Command< ListGrantsCommandInput, diff --git a/clients/client-kms/commands/ListKeyPoliciesCommand.ts b/clients/client-kms/commands/ListKeyPoliciesCommand.ts index 173505df8556..c199384bc8b5 100644 --- a/clients/client-kms/commands/ListKeyPoliciesCommand.ts +++ b/clients/client-kms/commands/ListKeyPoliciesCommand.ts @@ -44,6 +44,20 @@ export interface ListKeyPoliciesCommandOutput extends ListKeyPoliciesResponse, _ *

* * + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { KMSClient, ListKeyPoliciesCommand } from "@aws-sdk/client-kms"; // ES Modules import + * // const { KMSClient, ListKeyPoliciesCommand } = require("@aws-sdk/client-kms"); // CommonJS import + * const client = new KMSClient(config); + * const command = new ListKeyPoliciesCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListKeyPoliciesCommandInput} for command's `input` shape. + * @see {@link ListKeyPoliciesCommandOutput} for command's `response` shape. + * @see {@link KMSClientResolvedConfig | config} for command's `input` shape. + * */ export class ListKeyPoliciesCommand extends $Command< ListKeyPoliciesCommandInput, diff --git a/clients/client-kms/commands/ListKeysCommand.ts b/clients/client-kms/commands/ListKeysCommand.ts index 20efa4487a28..581c3b228d91 100644 --- a/clients/client-kms/commands/ListKeysCommand.ts +++ b/clients/client-kms/commands/ListKeysCommand.ts @@ -50,6 +50,20 @@ export interface ListKeysCommandOutput extends ListKeysResponse, __MetadataBeare *

* * + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { KMSClient, ListKeysCommand } from "@aws-sdk/client-kms"; // ES Modules import + * // const { KMSClient, ListKeysCommand } = require("@aws-sdk/client-kms"); // CommonJS import + * const client = new KMSClient(config); + * const command = new ListKeysCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListKeysCommandInput} for command's `input` shape. + * @see {@link ListKeysCommandOutput} for command's `response` shape. + * @see {@link KMSClientResolvedConfig | config} for command's `input` shape. + * */ export class ListKeysCommand extends $Command { // Start section: command_properties diff --git a/clients/client-kms/commands/ListResourceTagsCommand.ts b/clients/client-kms/commands/ListResourceTagsCommand.ts index 17d804e92804..899a26f29022 100644 --- a/clients/client-kms/commands/ListResourceTagsCommand.ts +++ b/clients/client-kms/commands/ListResourceTagsCommand.ts @@ -46,6 +46,20 @@ export interface ListResourceTagsCommandOutput extends ListResourceTagsResponse, *

* * + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { KMSClient, ListResourceTagsCommand } from "@aws-sdk/client-kms"; // ES Modules import + * // const { KMSClient, ListResourceTagsCommand } = require("@aws-sdk/client-kms"); // CommonJS import + * const client = new KMSClient(config); + * const command = new ListResourceTagsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListResourceTagsCommandInput} for command's `input` shape. + * @see {@link ListResourceTagsCommandOutput} for command's `response` shape. + * @see {@link KMSClientResolvedConfig | config} for command's `input` shape. + * */ export class ListResourceTagsCommand extends $Command< ListResourceTagsCommandInput, diff --git a/clients/client-kms/commands/ListRetirableGrantsCommand.ts b/clients/client-kms/commands/ListRetirableGrantsCommand.ts index 8436a92c0cca..ad1de9979359 100644 --- a/clients/client-kms/commands/ListRetirableGrantsCommand.ts +++ b/clients/client-kms/commands/ListRetirableGrantsCommand.ts @@ -61,6 +61,20 @@ export interface ListRetirableGrantsCommandOutput extends ListGrantsResponse, __ *

* * + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { KMSClient, ListRetirableGrantsCommand } from "@aws-sdk/client-kms"; // ES Modules import + * // const { KMSClient, ListRetirableGrantsCommand } = require("@aws-sdk/client-kms"); // CommonJS import + * const client = new KMSClient(config); + * const command = new ListRetirableGrantsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListRetirableGrantsCommandInput} for command's `input` shape. + * @see {@link ListRetirableGrantsCommandOutput} for command's `response` shape. + * @see {@link KMSClientResolvedConfig | config} for command's `input` shape. + * */ export class ListRetirableGrantsCommand extends $Command< ListRetirableGrantsCommandInput, diff --git a/clients/client-kms/commands/PutKeyPolicyCommand.ts b/clients/client-kms/commands/PutKeyPolicyCommand.ts index fb9f5b00ea75..ff3a2ec79d69 100644 --- a/clients/client-kms/commands/PutKeyPolicyCommand.ts +++ b/clients/client-kms/commands/PutKeyPolicyCommand.ts @@ -35,6 +35,20 @@ export interface PutKeyPolicyCommandOutput extends __MetadataBearer {} *

* Related operations: GetKeyPolicy *

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { KMSClient, PutKeyPolicyCommand } from "@aws-sdk/client-kms"; // ES Modules import + * // const { KMSClient, PutKeyPolicyCommand } = require("@aws-sdk/client-kms"); // CommonJS import + * const client = new KMSClient(config); + * const command = new PutKeyPolicyCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link PutKeyPolicyCommandInput} for command's `input` shape. + * @see {@link PutKeyPolicyCommandOutput} for command's `response` shape. + * @see {@link KMSClientResolvedConfig | config} for command's `input` shape. + * */ export class PutKeyPolicyCommand extends $Command< PutKeyPolicyCommandInput, diff --git a/clients/client-kms/commands/ReEncryptCommand.ts b/clients/client-kms/commands/ReEncryptCommand.ts index a8b3c7265a5c..db1d8207297f 100644 --- a/clients/client-kms/commands/ReEncryptCommand.ts +++ b/clients/client-kms/commands/ReEncryptCommand.ts @@ -114,6 +114,20 @@ export interface ReEncryptCommandOutput extends ReEncryptResponse, __MetadataBea *

* * + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { KMSClient, ReEncryptCommand } from "@aws-sdk/client-kms"; // ES Modules import + * // const { KMSClient, ReEncryptCommand } = require("@aws-sdk/client-kms"); // CommonJS import + * const client = new KMSClient(config); + * const command = new ReEncryptCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ReEncryptCommandInput} for command's `input` shape. + * @see {@link ReEncryptCommandOutput} for command's `response` shape. + * @see {@link KMSClientResolvedConfig | config} for command's `input` shape. + * */ export class ReEncryptCommand extends $Command { // Start section: command_properties diff --git a/clients/client-kms/commands/RetireGrantCommand.ts b/clients/client-kms/commands/RetireGrantCommand.ts index c7922b01f2de..ff28a1bc8c45 100644 --- a/clients/client-kms/commands/RetireGrantCommand.ts +++ b/clients/client-kms/commands/RetireGrantCommand.ts @@ -74,6 +74,20 @@ export interface RetireGrantCommandOutput extends __MetadataBearer {} *

* * + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { KMSClient, RetireGrantCommand } from "@aws-sdk/client-kms"; // ES Modules import + * // const { KMSClient, RetireGrantCommand } = require("@aws-sdk/client-kms"); // CommonJS import + * const client = new KMSClient(config); + * const command = new RetireGrantCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link RetireGrantCommandInput} for command's `input` shape. + * @see {@link RetireGrantCommandOutput} for command's `response` shape. + * @see {@link KMSClientResolvedConfig | config} for command's `input` shape. + * */ export class RetireGrantCommand extends $Command< RetireGrantCommandInput, diff --git a/clients/client-kms/commands/RevokeGrantCommand.ts b/clients/client-kms/commands/RevokeGrantCommand.ts index a69e79098b60..6aa697dfc496 100644 --- a/clients/client-kms/commands/RevokeGrantCommand.ts +++ b/clients/client-kms/commands/RevokeGrantCommand.ts @@ -54,6 +54,20 @@ export interface RevokeGrantCommandOutput extends __MetadataBearer {} *

* * + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { KMSClient, RevokeGrantCommand } from "@aws-sdk/client-kms"; // ES Modules import + * // const { KMSClient, RevokeGrantCommand } = require("@aws-sdk/client-kms"); // CommonJS import + * const client = new KMSClient(config); + * const command = new RevokeGrantCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link RevokeGrantCommandInput} for command's `input` shape. + * @see {@link RevokeGrantCommandOutput} for command's `response` shape. + * @see {@link KMSClientResolvedConfig | config} for command's `input` shape. + * */ export class RevokeGrantCommand extends $Command< RevokeGrantCommandInput, diff --git a/clients/client-kms/commands/ScheduleKeyDeletionCommand.ts b/clients/client-kms/commands/ScheduleKeyDeletionCommand.ts index 3630e3b8f8db..cd81ac28617f 100644 --- a/clients/client-kms/commands/ScheduleKeyDeletionCommand.ts +++ b/clients/client-kms/commands/ScheduleKeyDeletionCommand.ts @@ -63,6 +63,20 @@ export interface ScheduleKeyDeletionCommandOutput extends ScheduleKeyDeletionRes *

* * + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { KMSClient, ScheduleKeyDeletionCommand } from "@aws-sdk/client-kms"; // ES Modules import + * // const { KMSClient, ScheduleKeyDeletionCommand } = require("@aws-sdk/client-kms"); // CommonJS import + * const client = new KMSClient(config); + * const command = new ScheduleKeyDeletionCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ScheduleKeyDeletionCommandInput} for command's `input` shape. + * @see {@link ScheduleKeyDeletionCommandOutput} for command's `response` shape. + * @see {@link KMSClientResolvedConfig | config} for command's `input` shape. + * */ export class ScheduleKeyDeletionCommand extends $Command< ScheduleKeyDeletionCommandInput, diff --git a/clients/client-kms/commands/SignCommand.ts b/clients/client-kms/commands/SignCommand.ts index 4c5958c3e1a1..3aabe9ae66d4 100644 --- a/clients/client-kms/commands/SignCommand.ts +++ b/clients/client-kms/commands/SignCommand.ts @@ -65,6 +65,20 @@ export interface SignCommandOutput extends SignResponse, __MetadataBearer {} *

* Related operations: Verify *

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { KMSClient, SignCommand } from "@aws-sdk/client-kms"; // ES Modules import + * // const { KMSClient, SignCommand } = require("@aws-sdk/client-kms"); // CommonJS import + * const client = new KMSClient(config); + * const command = new SignCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link SignCommandInput} for command's `input` shape. + * @see {@link SignCommandOutput} for command's `response` shape. + * @see {@link KMSClientResolvedConfig | config} for command's `input` shape. + * */ export class SignCommand extends $Command { // Start section: command_properties diff --git a/clients/client-kms/commands/TagResourceCommand.ts b/clients/client-kms/commands/TagResourceCommand.ts index 5f0f9691b286..a871850842e1 100644 --- a/clients/client-kms/commands/TagResourceCommand.ts +++ b/clients/client-kms/commands/TagResourceCommand.ts @@ -56,6 +56,20 @@ export interface TagResourceCommandOutput extends __MetadataBearer {} *

* * + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { KMSClient, TagResourceCommand } from "@aws-sdk/client-kms"; // ES Modules import + * // const { KMSClient, TagResourceCommand } = require("@aws-sdk/client-kms"); // CommonJS import + * const client = new KMSClient(config); + * const command = new TagResourceCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link TagResourceCommandInput} for command's `input` shape. + * @see {@link TagResourceCommandOutput} for command's `response` shape. + * @see {@link KMSClientResolvedConfig | config} for command's `input` shape. + * */ export class TagResourceCommand extends $Command< TagResourceCommandInput, diff --git a/clients/client-kms/commands/UntagResourceCommand.ts b/clients/client-kms/commands/UntagResourceCommand.ts index fecf04107b79..aebc0609fefc 100644 --- a/clients/client-kms/commands/UntagResourceCommand.ts +++ b/clients/client-kms/commands/UntagResourceCommand.ts @@ -54,6 +54,20 @@ export interface UntagResourceCommandOutput extends __MetadataBearer {} *

* * + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { KMSClient, UntagResourceCommand } from "@aws-sdk/client-kms"; // ES Modules import + * // const { KMSClient, UntagResourceCommand } = require("@aws-sdk/client-kms"); // CommonJS import + * const client = new KMSClient(config); + * const command = new UntagResourceCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link UntagResourceCommandInput} for command's `input` shape. + * @see {@link UntagResourceCommandOutput} for command's `response` shape. + * @see {@link KMSClientResolvedConfig | config} for command's `input` shape. + * */ export class UntagResourceCommand extends $Command< UntagResourceCommandInput, diff --git a/clients/client-kms/commands/UpdateAliasCommand.ts b/clients/client-kms/commands/UpdateAliasCommand.ts index 7c42a9da2c73..7177ca6aaf5d 100644 --- a/clients/client-kms/commands/UpdateAliasCommand.ts +++ b/clients/client-kms/commands/UpdateAliasCommand.ts @@ -78,6 +78,20 @@ export interface UpdateAliasCommandOutput extends __MetadataBearer {} *

* * + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { KMSClient, UpdateAliasCommand } from "@aws-sdk/client-kms"; // ES Modules import + * // const { KMSClient, UpdateAliasCommand } = require("@aws-sdk/client-kms"); // CommonJS import + * const client = new KMSClient(config); + * const command = new UpdateAliasCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link UpdateAliasCommandInput} for command's `input` shape. + * @see {@link UpdateAliasCommandOutput} for command's `response` shape. + * @see {@link KMSClientResolvedConfig | config} for command's `input` shape. + * */ export class UpdateAliasCommand extends $Command< UpdateAliasCommandInput, diff --git a/clients/client-kms/commands/UpdateCustomKeyStoreCommand.ts b/clients/client-kms/commands/UpdateCustomKeyStoreCommand.ts index 703afcdc0a0c..716dc816c233 100644 --- a/clients/client-kms/commands/UpdateCustomKeyStoreCommand.ts +++ b/clients/client-kms/commands/UpdateCustomKeyStoreCommand.ts @@ -94,6 +94,20 @@ export interface UpdateCustomKeyStoreCommandOutput extends UpdateCustomKeyStoreR *

* * + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { KMSClient, UpdateCustomKeyStoreCommand } from "@aws-sdk/client-kms"; // ES Modules import + * // const { KMSClient, UpdateCustomKeyStoreCommand } = require("@aws-sdk/client-kms"); // CommonJS import + * const client = new KMSClient(config); + * const command = new UpdateCustomKeyStoreCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link UpdateCustomKeyStoreCommandInput} for command's `input` shape. + * @see {@link UpdateCustomKeyStoreCommandOutput} for command's `response` shape. + * @see {@link KMSClientResolvedConfig | config} for command's `input` shape. + * */ export class UpdateCustomKeyStoreCommand extends $Command< UpdateCustomKeyStoreCommandInput, diff --git a/clients/client-kms/commands/UpdateKeyDescriptionCommand.ts b/clients/client-kms/commands/UpdateKeyDescriptionCommand.ts index c447a507d3f0..4499c60d7457 100644 --- a/clients/client-kms/commands/UpdateKeyDescriptionCommand.ts +++ b/clients/client-kms/commands/UpdateKeyDescriptionCommand.ts @@ -46,6 +46,20 @@ export interface UpdateKeyDescriptionCommandOutput extends __MetadataBearer {} *

* * + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { KMSClient, UpdateKeyDescriptionCommand } from "@aws-sdk/client-kms"; // ES Modules import + * // const { KMSClient, UpdateKeyDescriptionCommand } = require("@aws-sdk/client-kms"); // CommonJS import + * const client = new KMSClient(config); + * const command = new UpdateKeyDescriptionCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link UpdateKeyDescriptionCommandInput} for command's `input` shape. + * @see {@link UpdateKeyDescriptionCommandOutput} for command's `response` shape. + * @see {@link KMSClientResolvedConfig | config} for command's `input` shape. + * */ export class UpdateKeyDescriptionCommand extends $Command< UpdateKeyDescriptionCommandInput, diff --git a/clients/client-kms/commands/VerifyCommand.ts b/clients/client-kms/commands/VerifyCommand.ts index 7bf0a4beecf4..e46554a93269 100644 --- a/clients/client-kms/commands/VerifyCommand.ts +++ b/clients/client-kms/commands/VerifyCommand.ts @@ -50,6 +50,20 @@ export interface VerifyCommandOutput extends VerifyResponse, __MetadataBearer {} *

* Related operations: Sign *

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { KMSClient, VerifyCommand } from "@aws-sdk/client-kms"; // ES Modules import + * // const { KMSClient, VerifyCommand } = require("@aws-sdk/client-kms"); // CommonJS import + * const client = new KMSClient(config); + * const command = new VerifyCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link VerifyCommandInput} for command's `input` shape. + * @see {@link VerifyCommandOutput} for command's `response` shape. + * @see {@link KMSClientResolvedConfig | config} for command's `input` shape. + * */ export class VerifyCommand extends $Command { // Start section: command_properties diff --git a/clients/client-kms/models/models_0.ts b/clients/client-kms/models/models_0.ts index ceb86b91afd7..9d878f6c71fd 100644 --- a/clients/client-kms/models/models_0.ts +++ b/clients/client-kms/models/models_0.ts @@ -31,6 +31,9 @@ export interface AliasListEntry { } export namespace AliasListEntry { + /** + * @internal + */ export const filterSensitiveLog = (obj: AliasListEntry): any => ({ ...obj, }); @@ -47,6 +50,9 @@ export interface AlreadyExistsException extends __SmithyException, $MetadataBear } export namespace AlreadyExistsException { + /** + * @internal + */ export const filterSensitiveLog = (obj: AlreadyExistsException): any => ({ ...obj, }); @@ -74,6 +80,9 @@ export interface CancelKeyDeletionRequest { } export namespace CancelKeyDeletionRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: CancelKeyDeletionRequest): any => ({ ...obj, }); @@ -87,6 +96,9 @@ export interface CancelKeyDeletionResponse { } export namespace CancelKeyDeletionResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: CancelKeyDeletionResponse): any => ({ ...obj, }); @@ -103,6 +115,9 @@ export interface DependencyTimeoutException extends __SmithyException, $Metadata } export namespace DependencyTimeoutException { + /** + * @internal + */ export const filterSensitiveLog = (obj: DependencyTimeoutException): any => ({ ...obj, }); @@ -119,6 +134,9 @@ export interface InvalidArnException extends __SmithyException, $MetadataBearer } export namespace InvalidArnException { + /** + * @internal + */ export const filterSensitiveLog = (obj: InvalidArnException): any => ({ ...obj, }); @@ -135,6 +153,9 @@ export interface KMSInternalException extends __SmithyException, $MetadataBearer } export namespace KMSInternalException { + /** + * @internal + */ export const filterSensitiveLog = (obj: KMSInternalException): any => ({ ...obj, }); @@ -155,6 +176,9 @@ export interface KMSInvalidStateException extends __SmithyException, $MetadataBe } export namespace KMSInvalidStateException { + /** + * @internal + */ export const filterSensitiveLog = (obj: KMSInvalidStateException): any => ({ ...obj, }); @@ -171,6 +195,9 @@ export interface NotFoundException extends __SmithyException, $MetadataBearer { } export namespace NotFoundException { + /** + * @internal + */ export const filterSensitiveLog = (obj: NotFoundException): any => ({ ...obj, }); @@ -190,6 +217,9 @@ export interface CloudHsmClusterInUseException extends __SmithyException, $Metad } export namespace CloudHsmClusterInUseException { + /** + * @internal + */ export const filterSensitiveLog = (obj: CloudHsmClusterInUseException): any => ({ ...obj, }); @@ -237,6 +267,9 @@ export interface CloudHsmClusterInvalidConfigurationException extends __SmithyEx } export namespace CloudHsmClusterInvalidConfigurationException { + /** + * @internal + */ export const filterSensitiveLog = (obj: CloudHsmClusterInvalidConfigurationException): any => ({ ...obj, }); @@ -254,6 +287,9 @@ export interface CloudHsmClusterNotActiveException extends __SmithyException, $M } export namespace CloudHsmClusterNotActiveException { + /** + * @internal + */ export const filterSensitiveLog = (obj: CloudHsmClusterNotActiveException): any => ({ ...obj, }); @@ -270,6 +306,9 @@ export interface CloudHsmClusterNotFoundException extends __SmithyException, $Me } export namespace CloudHsmClusterNotFoundException { + /** + * @internal + */ export const filterSensitiveLog = (obj: CloudHsmClusterNotFoundException): any => ({ ...obj, }); @@ -292,6 +331,9 @@ export interface CloudHsmClusterNotRelatedException extends __SmithyException, $ } export namespace CloudHsmClusterNotRelatedException { + /** + * @internal + */ export const filterSensitiveLog = (obj: CloudHsmClusterNotRelatedException): any => ({ ...obj, }); @@ -306,6 +348,9 @@ export interface ConnectCustomKeyStoreRequest { } export namespace ConnectCustomKeyStoreRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ConnectCustomKeyStoreRequest): any => ({ ...obj, }); @@ -314,6 +359,9 @@ export namespace ConnectCustomKeyStoreRequest { export interface ConnectCustomKeyStoreResponse {} export namespace ConnectCustomKeyStoreResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ConnectCustomKeyStoreResponse): any => ({ ...obj, }); @@ -349,6 +397,9 @@ export interface CustomKeyStoreInvalidStateException extends __SmithyException, } export namespace CustomKeyStoreInvalidStateException { + /** + * @internal + */ export const filterSensitiveLog = (obj: CustomKeyStoreInvalidStateException): any => ({ ...obj, }); @@ -365,6 +416,9 @@ export interface CustomKeyStoreNotFoundException extends __SmithyException, $Met } export namespace CustomKeyStoreNotFoundException { + /** + * @internal + */ export const filterSensitiveLog = (obj: CustomKeyStoreNotFoundException): any => ({ ...obj, }); @@ -426,6 +480,9 @@ export interface CreateAliasRequest { } export namespace CreateAliasRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateAliasRequest): any => ({ ...obj, }); @@ -441,6 +498,9 @@ export interface InvalidAliasNameException extends __SmithyException, $MetadataB } export namespace InvalidAliasNameException { + /** + * @internal + */ export const filterSensitiveLog = (obj: InvalidAliasNameException): any => ({ ...obj, }); @@ -457,6 +517,9 @@ export interface LimitExceededException extends __SmithyException, $MetadataBear } export namespace LimitExceededException { + /** + * @internal + */ export const filterSensitiveLog = (obj: LimitExceededException): any => ({ ...obj, }); @@ -495,6 +558,9 @@ export interface CreateCustomKeyStoreRequest { } export namespace CreateCustomKeyStoreRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateCustomKeyStoreRequest): any => ({ ...obj, ...(obj.KeyStorePassword && { KeyStorePassword: SENSITIVE_STRING }), @@ -509,6 +575,9 @@ export interface CreateCustomKeyStoreResponse { } export namespace CreateCustomKeyStoreResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateCustomKeyStoreResponse): any => ({ ...obj, }); @@ -526,6 +595,9 @@ export interface CustomKeyStoreNameInUseException extends __SmithyException, $Me } export namespace CustomKeyStoreNameInUseException { + /** + * @internal + */ export const filterSensitiveLog = (obj: CustomKeyStoreNameInUseException): any => ({ ...obj, }); @@ -544,6 +616,9 @@ export interface IncorrectTrustAnchorException extends __SmithyException, $Metad } export namespace IncorrectTrustAnchorException { + /** + * @internal + */ export const filterSensitiveLog = (obj: IncorrectTrustAnchorException): any => ({ ...obj, }); @@ -587,6 +662,9 @@ export interface GrantConstraints { } export namespace GrantConstraints { + /** + * @internal + */ export const filterSensitiveLog = (obj: GrantConstraints): any => ({ ...obj, }); @@ -692,6 +770,9 @@ export interface CreateGrantRequest { } export namespace CreateGrantRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateGrantRequest): any => ({ ...obj, }); @@ -713,6 +794,9 @@ export interface CreateGrantResponse { } export namespace CreateGrantResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateGrantResponse): any => ({ ...obj, }); @@ -728,6 +812,9 @@ export interface DisabledException extends __SmithyException, $MetadataBearer { } export namespace DisabledException { + /** + * @internal + */ export const filterSensitiveLog = (obj: DisabledException): any => ({ ...obj, }); @@ -743,6 +830,9 @@ export interface InvalidGrantTokenException extends __SmithyException, $Metadata } export namespace InvalidGrantTokenException { + /** + * @internal + */ export const filterSensitiveLog = (obj: InvalidGrantTokenException): any => ({ ...obj, }); @@ -789,6 +879,9 @@ export interface Tag { } export namespace Tag { + /** + * @internal + */ export const filterSensitiveLog = (obj: Tag): any => ({ ...obj, }); @@ -995,6 +1088,9 @@ export interface CreateKeyRequest { } export namespace CreateKeyRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateKeyRequest): any => ({ ...obj, }); @@ -1158,6 +1254,9 @@ export interface KeyMetadata { } export namespace KeyMetadata { + /** + * @internal + */ export const filterSensitiveLog = (obj: KeyMetadata): any => ({ ...obj, }); @@ -1171,6 +1270,9 @@ export interface CreateKeyResponse { } export namespace CreateKeyResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateKeyResponse): any => ({ ...obj, }); @@ -1187,6 +1289,9 @@ export interface MalformedPolicyDocumentException extends __SmithyException, $Me } export namespace MalformedPolicyDocumentException { + /** + * @internal + */ export const filterSensitiveLog = (obj: MalformedPolicyDocumentException): any => ({ ...obj, }); @@ -1202,6 +1307,9 @@ export interface TagException extends __SmithyException, $MetadataBearer { } export namespace TagException { + /** + * @internal + */ export const filterSensitiveLog = (obj: TagException): any => ({ ...obj, }); @@ -1218,6 +1326,9 @@ export interface UnsupportedOperationException extends __SmithyException, $Metad } export namespace UnsupportedOperationException { + /** + * @internal + */ export const filterSensitiveLog = (obj: UnsupportedOperationException): any => ({ ...obj, }); @@ -1235,6 +1346,9 @@ export interface CustomKeyStoreHasCMKsException extends __SmithyException, $Meta } export namespace CustomKeyStoreHasCMKsException { + /** + * @internal + */ export const filterSensitiveLog = (obj: CustomKeyStoreHasCMKsException): any => ({ ...obj, }); @@ -1352,6 +1466,9 @@ export interface CustomKeyStoresListEntry { } export namespace CustomKeyStoresListEntry { + /** + * @internal + */ export const filterSensitiveLog = (obj: CustomKeyStoresListEntry): any => ({ ...obj, }); @@ -1439,6 +1556,9 @@ export interface DecryptRequest { } export namespace DecryptRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DecryptRequest): any => ({ ...obj, }); @@ -1462,6 +1582,9 @@ export interface DecryptResponse { } export namespace DecryptResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DecryptResponse): any => ({ ...obj, ...(obj.Plaintext && { Plaintext: SENSITIVE_STRING }), @@ -1481,6 +1604,9 @@ export interface IncorrectKeyException extends __SmithyException, $MetadataBeare } export namespace IncorrectKeyException { + /** + * @internal + */ export const filterSensitiveLog = (obj: IncorrectKeyException): any => ({ ...obj, }); @@ -1501,6 +1627,9 @@ export interface InvalidCiphertextException extends __SmithyException, $Metadata } export namespace InvalidCiphertextException { + /** + * @internal + */ export const filterSensitiveLog = (obj: InvalidCiphertextException): any => ({ ...obj, }); @@ -1532,6 +1661,9 @@ export interface InvalidKeyUsageException extends __SmithyException, $MetadataBe } export namespace InvalidKeyUsageException { + /** + * @internal + */ export const filterSensitiveLog = (obj: InvalidKeyUsageException): any => ({ ...obj, }); @@ -1548,6 +1680,9 @@ export interface KeyUnavailableException extends __SmithyException, $MetadataBea } export namespace KeyUnavailableException { + /** + * @internal + */ export const filterSensitiveLog = (obj: KeyUnavailableException): any => ({ ...obj, }); @@ -1562,6 +1697,9 @@ export interface DeleteAliasRequest { } export namespace DeleteAliasRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteAliasRequest): any => ({ ...obj, }); @@ -1575,6 +1713,9 @@ export interface DeleteCustomKeyStoreRequest { } export namespace DeleteCustomKeyStoreRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteCustomKeyStoreRequest): any => ({ ...obj, }); @@ -1583,6 +1724,9 @@ export namespace DeleteCustomKeyStoreRequest { export interface DeleteCustomKeyStoreResponse {} export namespace DeleteCustomKeyStoreResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteCustomKeyStoreResponse): any => ({ ...obj, }); @@ -1610,6 +1754,9 @@ export interface DeleteImportedKeyMaterialRequest { } export namespace DeleteImportedKeyMaterialRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteImportedKeyMaterialRequest): any => ({ ...obj, }); @@ -1651,6 +1798,9 @@ export interface DescribeCustomKeyStoresRequest { } export namespace DescribeCustomKeyStoresRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeCustomKeyStoresRequest): any => ({ ...obj, }); @@ -1678,6 +1828,9 @@ export interface DescribeCustomKeyStoresResponse { } export namespace DescribeCustomKeyStoresResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeCustomKeyStoresResponse): any => ({ ...obj, }); @@ -1723,6 +1876,9 @@ export interface DescribeKeyRequest { } export namespace DescribeKeyRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeKeyRequest): any => ({ ...obj, }); @@ -1736,6 +1892,9 @@ export interface DescribeKeyResponse { } export namespace DescribeKeyResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeKeyResponse): any => ({ ...obj, }); @@ -1762,6 +1921,9 @@ export interface DisableKeyRequest { } export namespace DisableKeyRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DisableKeyRequest): any => ({ ...obj, }); @@ -1791,6 +1953,9 @@ export interface DisableKeyRotationRequest { } export namespace DisableKeyRotationRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DisableKeyRotationRequest): any => ({ ...obj, }); @@ -1804,6 +1969,9 @@ export interface DisconnectCustomKeyStoreRequest { } export namespace DisconnectCustomKeyStoreRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DisconnectCustomKeyStoreRequest): any => ({ ...obj, }); @@ -1812,6 +1980,9 @@ export namespace DisconnectCustomKeyStoreRequest { export interface DisconnectCustomKeyStoreResponse {} export namespace DisconnectCustomKeyStoreResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DisconnectCustomKeyStoreResponse): any => ({ ...obj, }); @@ -1838,6 +2009,9 @@ export interface EnableKeyRequest { } export namespace EnableKeyRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: EnableKeyRequest): any => ({ ...obj, }); @@ -1865,6 +2039,9 @@ export interface EnableKeyRotationRequest { } export namespace EnableKeyRotationRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: EnableKeyRotationRequest): any => ({ ...obj, }); @@ -1930,6 +2107,9 @@ export interface EncryptRequest { } export namespace EncryptRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: EncryptRequest): any => ({ ...obj, ...(obj.Plaintext && { Plaintext: SENSITIVE_STRING }), @@ -1954,6 +2134,9 @@ export interface EncryptResponse { } export namespace EncryptResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: EncryptResponse): any => ({ ...obj, }); @@ -1970,6 +2153,9 @@ export interface ExpiredImportTokenException extends __SmithyException, $Metadat } export namespace ExpiredImportTokenException { + /** + * @internal + */ export const filterSensitiveLog = (obj: ExpiredImportTokenException): any => ({ ...obj, }); @@ -2038,6 +2224,9 @@ export interface GenerateDataKeyRequest { } export namespace GenerateDataKeyRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GenerateDataKeyRequest): any => ({ ...obj, }); @@ -2062,6 +2251,9 @@ export interface GenerateDataKeyResponse { } export namespace GenerateDataKeyResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: GenerateDataKeyResponse): any => ({ ...obj, ...(obj.Plaintext && { Plaintext: SENSITIVE_STRING }), @@ -2122,6 +2314,9 @@ export interface GenerateDataKeyPairRequest { } export namespace GenerateDataKeyPairRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GenerateDataKeyPairRequest): any => ({ ...obj, }); @@ -2155,6 +2350,9 @@ export interface GenerateDataKeyPairResponse { } export namespace GenerateDataKeyPairResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: GenerateDataKeyPairResponse): any => ({ ...obj, ...(obj.PrivateKeyPlaintext && { PrivateKeyPlaintext: SENSITIVE_STRING }), @@ -2215,6 +2413,9 @@ export interface GenerateDataKeyPairWithoutPlaintextRequest { } export namespace GenerateDataKeyPairWithoutPlaintextRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GenerateDataKeyPairWithoutPlaintextRequest): any => ({ ...obj, }); @@ -2243,6 +2444,9 @@ export interface GenerateDataKeyPairWithoutPlaintextResponse { } export namespace GenerateDataKeyPairWithoutPlaintextResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: GenerateDataKeyPairWithoutPlaintextResponse): any => ({ ...obj, }); @@ -2307,6 +2511,9 @@ export interface GenerateDataKeyWithoutPlaintextRequest { } export namespace GenerateDataKeyWithoutPlaintextRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GenerateDataKeyWithoutPlaintextRequest): any => ({ ...obj, }); @@ -2325,6 +2532,9 @@ export interface GenerateDataKeyWithoutPlaintextResponse { } export namespace GenerateDataKeyWithoutPlaintextResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: GenerateDataKeyWithoutPlaintextResponse): any => ({ ...obj, }); @@ -2344,6 +2554,9 @@ export interface GenerateRandomRequest { } export namespace GenerateRandomRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GenerateRandomRequest): any => ({ ...obj, }); @@ -2357,6 +2570,9 @@ export interface GenerateRandomResponse { } export namespace GenerateRandomResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: GenerateRandomResponse): any => ({ ...obj, ...(obj.Plaintext && { Plaintext: SENSITIVE_STRING }), @@ -2390,6 +2606,9 @@ export interface GetKeyPolicyRequest { } export namespace GetKeyPolicyRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetKeyPolicyRequest): any => ({ ...obj, }); @@ -2403,6 +2622,9 @@ export interface GetKeyPolicyResponse { } export namespace GetKeyPolicyResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetKeyPolicyResponse): any => ({ ...obj, }); @@ -2430,6 +2652,9 @@ export interface GetKeyRotationStatusRequest { } export namespace GetKeyRotationStatusRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetKeyRotationStatusRequest): any => ({ ...obj, }); @@ -2443,6 +2668,9 @@ export interface GetKeyRotationStatusResponse { } export namespace GetKeyRotationStatusResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetKeyRotationStatusResponse): any => ({ ...obj, }); @@ -2486,6 +2714,9 @@ export interface GetParametersForImportRequest { } export namespace GetParametersForImportRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetParametersForImportRequest): any => ({ ...obj, }); @@ -2519,6 +2750,9 @@ export interface GetParametersForImportResponse { } export namespace GetParametersForImportResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetParametersForImportResponse): any => ({ ...obj, ...(obj.PublicKey && { PublicKey: SENSITIVE_STRING }), @@ -2562,6 +2796,9 @@ export interface GetPublicKeyRequest { } export namespace GetPublicKeyRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetPublicKeyRequest): any => ({ ...obj, }); @@ -2612,6 +2849,9 @@ export interface GetPublicKeyResponse { } export namespace GetPublicKeyResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetPublicKeyResponse): any => ({ ...obj, }); @@ -2674,6 +2914,9 @@ export interface GrantListEntry { } export namespace GrantListEntry { + /** + * @internal + */ export const filterSensitiveLog = (obj: GrantListEntry): any => ({ ...obj, }); @@ -2732,6 +2975,9 @@ export interface ImportKeyMaterialRequest { } export namespace ImportKeyMaterialRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ImportKeyMaterialRequest): any => ({ ...obj, }); @@ -2740,6 +2986,9 @@ export namespace ImportKeyMaterialRequest { export interface ImportKeyMaterialResponse {} export namespace ImportKeyMaterialResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ImportKeyMaterialResponse): any => ({ ...obj, }); @@ -2757,6 +3006,9 @@ export interface IncorrectKeyMaterialException extends __SmithyException, $Metad } export namespace IncorrectKeyMaterialException { + /** + * @internal + */ export const filterSensitiveLog = (obj: IncorrectKeyMaterialException): any => ({ ...obj, }); @@ -2773,6 +3025,9 @@ export interface InvalidImportTokenException extends __SmithyException, $Metadat } export namespace InvalidImportTokenException { + /** + * @internal + */ export const filterSensitiveLog = (obj: InvalidImportTokenException): any => ({ ...obj, }); @@ -2788,6 +3043,9 @@ export interface InvalidGrantIdException extends __SmithyException, $MetadataBea } export namespace InvalidGrantIdException { + /** + * @internal + */ export const filterSensitiveLog = (obj: InvalidGrantIdException): any => ({ ...obj, }); @@ -2804,6 +3062,9 @@ export interface InvalidMarkerException extends __SmithyException, $MetadataBear } export namespace InvalidMarkerException { + /** + * @internal + */ export const filterSensitiveLog = (obj: InvalidMarkerException): any => ({ ...obj, }); @@ -2825,6 +3086,9 @@ export interface KeyListEntry { } export namespace KeyListEntry { + /** + * @internal + */ export const filterSensitiveLog = (obj: KeyListEntry): any => ({ ...obj, }); @@ -2842,6 +3106,9 @@ export interface KMSInvalidSignatureException extends __SmithyException, $Metada } export namespace KMSInvalidSignatureException { + /** + * @internal + */ export const filterSensitiveLog = (obj: KMSInvalidSignatureException): any => ({ ...obj, }); @@ -2888,6 +3155,9 @@ export interface ListAliasesRequest { } export namespace ListAliasesRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListAliasesRequest): any => ({ ...obj, }); @@ -2915,6 +3185,9 @@ export interface ListAliasesResponse { } export namespace ListAliasesResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListAliasesResponse): any => ({ ...obj, }); @@ -2971,6 +3244,9 @@ export interface ListGrantsRequest { } export namespace ListGrantsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListGrantsRequest): any => ({ ...obj, }); @@ -2998,6 +3274,9 @@ export interface ListGrantsResponse { } export namespace ListGrantsResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListGrantsResponse): any => ({ ...obj, }); @@ -3041,6 +3320,9 @@ export interface ListKeyPoliciesRequest { } export namespace ListKeyPoliciesRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListKeyPoliciesRequest): any => ({ ...obj, }); @@ -3068,6 +3350,9 @@ export interface ListKeyPoliciesResponse { } export namespace ListKeyPoliciesResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListKeyPoliciesResponse): any => ({ ...obj, }); @@ -3092,6 +3377,9 @@ export interface ListKeysRequest { } export namespace ListKeysRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListKeysRequest): any => ({ ...obj, }); @@ -3119,6 +3407,9 @@ export interface ListKeysResponse { } export namespace ListKeysResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListKeysResponse): any => ({ ...obj, }); @@ -3163,6 +3454,9 @@ export interface ListResourceTagsRequest { } export namespace ListResourceTagsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListResourceTagsRequest): any => ({ ...obj, }); @@ -3191,6 +3485,9 @@ export interface ListResourceTagsResponse { } export namespace ListResourceTagsResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListResourceTagsResponse): any => ({ ...obj, }); @@ -3226,6 +3523,9 @@ export interface ListRetirableGrantsRequest { } export namespace ListRetirableGrantsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListRetirableGrantsRequest): any => ({ ...obj, }); @@ -3298,6 +3598,9 @@ export interface PutKeyPolicyRequest { } export namespace PutKeyPolicyRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: PutKeyPolicyRequest): any => ({ ...obj, }); @@ -3421,6 +3724,9 @@ export interface ReEncryptRequest { } export namespace ReEncryptRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ReEncryptRequest): any => ({ ...obj, }); @@ -3455,6 +3761,9 @@ export interface ReEncryptResponse { } export namespace ReEncryptResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ReEncryptResponse): any => ({ ...obj, }); @@ -3487,6 +3796,9 @@ export interface RetireGrantRequest { } export namespace RetireGrantRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: RetireGrantRequest): any => ({ ...obj, }); @@ -3520,6 +3832,9 @@ export interface RevokeGrantRequest { } export namespace RevokeGrantRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: RevokeGrantRequest): any => ({ ...obj, }); @@ -3555,6 +3870,9 @@ export interface ScheduleKeyDeletionRequest { } export namespace ScheduleKeyDeletionRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ScheduleKeyDeletionRequest): any => ({ ...obj, }); @@ -3573,6 +3891,9 @@ export interface ScheduleKeyDeletionResponse { } export namespace ScheduleKeyDeletionResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ScheduleKeyDeletionResponse): any => ({ ...obj, }); @@ -3639,6 +3960,9 @@ export interface SignRequest { } export namespace SignRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: SignRequest): any => ({ ...obj, ...(obj.Message && { Message: SENSITIVE_STRING }), @@ -3679,6 +4003,9 @@ export interface SignResponse { } export namespace SignResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: SignResponse): any => ({ ...obj, }); @@ -3715,6 +4042,9 @@ export interface TagResourceRequest { } export namespace TagResourceRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: TagResourceRequest): any => ({ ...obj, }); @@ -3747,6 +4077,9 @@ export interface UntagResourceRequest { } export namespace UntagResourceRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: UntagResourceRequest): any => ({ ...obj, }); @@ -3786,6 +4119,9 @@ export interface UpdateAliasRequest { } export namespace UpdateAliasRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateAliasRequest): any => ({ ...obj, }); @@ -3825,6 +4161,9 @@ export interface UpdateCustomKeyStoreRequest { } export namespace UpdateCustomKeyStoreRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateCustomKeyStoreRequest): any => ({ ...obj, ...(obj.KeyStorePassword && { KeyStorePassword: SENSITIVE_STRING }), @@ -3834,6 +4173,9 @@ export namespace UpdateCustomKeyStoreRequest { export interface UpdateCustomKeyStoreResponse {} export namespace UpdateCustomKeyStoreResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateCustomKeyStoreResponse): any => ({ ...obj, }); @@ -3865,6 +4207,9 @@ export interface UpdateKeyDescriptionRequest { } export namespace UpdateKeyDescriptionRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateKeyDescriptionRequest): any => ({ ...obj, }); @@ -3942,6 +4287,9 @@ export interface VerifyRequest { } export namespace VerifyRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: VerifyRequest): any => ({ ...obj, ...(obj.Message && { Message: SENSITIVE_STRING }), @@ -3970,6 +4318,9 @@ export interface VerifyResponse { } export namespace VerifyResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: VerifyResponse): any => ({ ...obj, }); diff --git a/clients/client-lakeformation/commands/BatchGrantPermissionsCommand.ts b/clients/client-lakeformation/commands/BatchGrantPermissionsCommand.ts index 4f79a43be496..26fd1efce23c 100644 --- a/clients/client-lakeformation/commands/BatchGrantPermissionsCommand.ts +++ b/clients/client-lakeformation/commands/BatchGrantPermissionsCommand.ts @@ -22,6 +22,20 @@ export interface BatchGrantPermissionsCommandOutput extends BatchGrantPermission /** *

Batch operation to grant permissions to the principal.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { LakeFormationClient, BatchGrantPermissionsCommand } from "@aws-sdk/client-lakeformation"; // ES Modules import + * // const { LakeFormationClient, BatchGrantPermissionsCommand } = require("@aws-sdk/client-lakeformation"); // CommonJS import + * const client = new LakeFormationClient(config); + * const command = new BatchGrantPermissionsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link BatchGrantPermissionsCommandInput} for command's `input` shape. + * @see {@link BatchGrantPermissionsCommandOutput} for command's `response` shape. + * @see {@link LakeFormationClientResolvedConfig | config} for command's `input` shape. + * */ export class BatchGrantPermissionsCommand extends $Command< BatchGrantPermissionsCommandInput, diff --git a/clients/client-lakeformation/commands/BatchRevokePermissionsCommand.ts b/clients/client-lakeformation/commands/BatchRevokePermissionsCommand.ts index 2c3abadcf8c7..d8b18b765bb1 100644 --- a/clients/client-lakeformation/commands/BatchRevokePermissionsCommand.ts +++ b/clients/client-lakeformation/commands/BatchRevokePermissionsCommand.ts @@ -22,6 +22,20 @@ export interface BatchRevokePermissionsCommandOutput extends BatchRevokePermissi /** *

Batch operation to revoke permissions from the principal.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { LakeFormationClient, BatchRevokePermissionsCommand } from "@aws-sdk/client-lakeformation"; // ES Modules import + * // const { LakeFormationClient, BatchRevokePermissionsCommand } = require("@aws-sdk/client-lakeformation"); // CommonJS import + * const client = new LakeFormationClient(config); + * const command = new BatchRevokePermissionsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link BatchRevokePermissionsCommandInput} for command's `input` shape. + * @see {@link BatchRevokePermissionsCommandOutput} for command's `response` shape. + * @see {@link LakeFormationClientResolvedConfig | config} for command's `input` shape. + * */ export class BatchRevokePermissionsCommand extends $Command< BatchRevokePermissionsCommandInput, diff --git a/clients/client-lakeformation/commands/DeregisterResourceCommand.ts b/clients/client-lakeformation/commands/DeregisterResourceCommand.ts index 79237fba5fc9..03e279404e8b 100644 --- a/clients/client-lakeformation/commands/DeregisterResourceCommand.ts +++ b/clients/client-lakeformation/commands/DeregisterResourceCommand.ts @@ -24,6 +24,20 @@ export interface DeregisterResourceCommandOutput extends DeregisterResourceRespo *

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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { LakeFormationClient, DeregisterResourceCommand } from "@aws-sdk/client-lakeformation"; // ES Modules import + * // const { LakeFormationClient, DeregisterResourceCommand } = require("@aws-sdk/client-lakeformation"); // CommonJS import + * const client = new LakeFormationClient(config); + * const command = new DeregisterResourceCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeregisterResourceCommandInput} for command's `input` shape. + * @see {@link DeregisterResourceCommandOutput} for command's `response` shape. + * @see {@link LakeFormationClientResolvedConfig | config} for command's `input` shape. + * */ export class DeregisterResourceCommand extends $Command< DeregisterResourceCommandInput, diff --git a/clients/client-lakeformation/commands/DescribeResourceCommand.ts b/clients/client-lakeformation/commands/DescribeResourceCommand.ts index 37e809443aec..a8ff0a68201a 100644 --- a/clients/client-lakeformation/commands/DescribeResourceCommand.ts +++ b/clients/client-lakeformation/commands/DescribeResourceCommand.ts @@ -22,6 +22,20 @@ export interface DescribeResourceCommandOutput extends DescribeResourceResponse, /** *

Retrieves the current data access role for the given resource registered in AWS Lake Formation.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { LakeFormationClient, DescribeResourceCommand } from "@aws-sdk/client-lakeformation"; // ES Modules import + * // const { LakeFormationClient, DescribeResourceCommand } = require("@aws-sdk/client-lakeformation"); // CommonJS import + * const client = new LakeFormationClient(config); + * const command = new DescribeResourceCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeResourceCommandInput} for command's `input` shape. + * @see {@link DescribeResourceCommandOutput} for command's `response` shape. + * @see {@link LakeFormationClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeResourceCommand extends $Command< DescribeResourceCommandInput, diff --git a/clients/client-lakeformation/commands/GetDataLakeSettingsCommand.ts b/clients/client-lakeformation/commands/GetDataLakeSettingsCommand.ts index 6fbcaa8bd7fa..5e474207a2e8 100644 --- a/clients/client-lakeformation/commands/GetDataLakeSettingsCommand.ts +++ b/clients/client-lakeformation/commands/GetDataLakeSettingsCommand.ts @@ -22,6 +22,20 @@ export interface GetDataLakeSettingsCommandOutput extends GetDataLakeSettingsRes /** *

Retrieves the list of the data lake administrators of a Lake Formation-managed data lake.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { LakeFormationClient, GetDataLakeSettingsCommand } from "@aws-sdk/client-lakeformation"; // ES Modules import + * // const { LakeFormationClient, GetDataLakeSettingsCommand } = require("@aws-sdk/client-lakeformation"); // CommonJS import + * const client = new LakeFormationClient(config); + * const command = new GetDataLakeSettingsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetDataLakeSettingsCommandInput} for command's `input` shape. + * @see {@link GetDataLakeSettingsCommandOutput} for command's `response` shape. + * @see {@link LakeFormationClientResolvedConfig | config} for command's `input` shape. + * */ export class GetDataLakeSettingsCommand extends $Command< GetDataLakeSettingsCommandInput, diff --git a/clients/client-lakeformation/commands/GetEffectivePermissionsForPathCommand.ts b/clients/client-lakeformation/commands/GetEffectivePermissionsForPathCommand.ts index 8c7541fa32a7..a4d7d0b0be57 100644 --- a/clients/client-lakeformation/commands/GetEffectivePermissionsForPathCommand.ts +++ b/clients/client-lakeformation/commands/GetEffectivePermissionsForPathCommand.ts @@ -25,6 +25,20 @@ export interface GetEffectivePermissionsForPathCommandOutput /** *

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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { LakeFormationClient, GetEffectivePermissionsForPathCommand } from "@aws-sdk/client-lakeformation"; // ES Modules import + * // const { LakeFormationClient, GetEffectivePermissionsForPathCommand } = require("@aws-sdk/client-lakeformation"); // CommonJS import + * const client = new LakeFormationClient(config); + * const command = new GetEffectivePermissionsForPathCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetEffectivePermissionsForPathCommandInput} for command's `input` shape. + * @see {@link GetEffectivePermissionsForPathCommandOutput} for command's `response` shape. + * @see {@link LakeFormationClientResolvedConfig | config} for command's `input` shape. + * */ export class GetEffectivePermissionsForPathCommand extends $Command< GetEffectivePermissionsForPathCommandInput, diff --git a/clients/client-lakeformation/commands/GrantPermissionsCommand.ts b/clients/client-lakeformation/commands/GrantPermissionsCommand.ts index 3345ea272e79..0c8cfb1c29d3 100644 --- a/clients/client-lakeformation/commands/GrantPermissionsCommand.ts +++ b/clients/client-lakeformation/commands/GrantPermissionsCommand.ts @@ -23,6 +23,20 @@ export interface GrantPermissionsCommandOutput extends GrantPermissionsResponse, /** *

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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { LakeFormationClient, GrantPermissionsCommand } from "@aws-sdk/client-lakeformation"; // ES Modules import + * // const { LakeFormationClient, GrantPermissionsCommand } = require("@aws-sdk/client-lakeformation"); // CommonJS import + * const client = new LakeFormationClient(config); + * const command = new GrantPermissionsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GrantPermissionsCommandInput} for command's `input` shape. + * @see {@link GrantPermissionsCommandOutput} for command's `response` shape. + * @see {@link LakeFormationClientResolvedConfig | config} for command's `input` shape. + * */ export class GrantPermissionsCommand extends $Command< GrantPermissionsCommandInput, diff --git a/clients/client-lakeformation/commands/ListPermissionsCommand.ts b/clients/client-lakeformation/commands/ListPermissionsCommand.ts index f44248568cc4..8be995bd8bd4 100644 --- a/clients/client-lakeformation/commands/ListPermissionsCommand.ts +++ b/clients/client-lakeformation/commands/ListPermissionsCommand.ts @@ -24,6 +24,20 @@ export interface ListPermissionsCommandOutput extends ListPermissionsResponse, _ *

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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { LakeFormationClient, ListPermissionsCommand } from "@aws-sdk/client-lakeformation"; // ES Modules import + * // const { LakeFormationClient, ListPermissionsCommand } = require("@aws-sdk/client-lakeformation"); // CommonJS import + * const client = new LakeFormationClient(config); + * const command = new ListPermissionsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListPermissionsCommandInput} for command's `input` shape. + * @see {@link ListPermissionsCommandOutput} for command's `response` shape. + * @see {@link LakeFormationClientResolvedConfig | config} for command's `input` shape. + * */ export class ListPermissionsCommand extends $Command< ListPermissionsCommandInput, diff --git a/clients/client-lakeformation/commands/ListResourcesCommand.ts b/clients/client-lakeformation/commands/ListResourcesCommand.ts index 5172029c41a3..c3b511ea2e05 100644 --- a/clients/client-lakeformation/commands/ListResourcesCommand.ts +++ b/clients/client-lakeformation/commands/ListResourcesCommand.ts @@ -22,6 +22,20 @@ export interface ListResourcesCommandOutput extends ListResourcesResponse, __Met /** *

Lists the resources registered to be managed by the Data Catalog.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { LakeFormationClient, ListResourcesCommand } from "@aws-sdk/client-lakeformation"; // ES Modules import + * // const { LakeFormationClient, ListResourcesCommand } = require("@aws-sdk/client-lakeformation"); // CommonJS import + * const client = new LakeFormationClient(config); + * const command = new ListResourcesCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListResourcesCommandInput} for command's `input` shape. + * @see {@link ListResourcesCommandOutput} for command's `response` shape. + * @see {@link LakeFormationClientResolvedConfig | config} for command's `input` shape. + * */ export class ListResourcesCommand extends $Command< ListResourcesCommandInput, diff --git a/clients/client-lakeformation/commands/PutDataLakeSettingsCommand.ts b/clients/client-lakeformation/commands/PutDataLakeSettingsCommand.ts index 14dd938cca8e..ea334d5db2c4 100644 --- a/clients/client-lakeformation/commands/PutDataLakeSettingsCommand.ts +++ b/clients/client-lakeformation/commands/PutDataLakeSettingsCommand.ts @@ -24,6 +24,20 @@ export interface PutDataLakeSettingsCommandOutput extends PutDataLakeSettingsRes *

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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { LakeFormationClient, PutDataLakeSettingsCommand } from "@aws-sdk/client-lakeformation"; // ES Modules import + * // const { LakeFormationClient, PutDataLakeSettingsCommand } = require("@aws-sdk/client-lakeformation"); // CommonJS import + * const client = new LakeFormationClient(config); + * const command = new PutDataLakeSettingsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link PutDataLakeSettingsCommandInput} for command's `input` shape. + * @see {@link PutDataLakeSettingsCommandOutput} for command's `response` shape. + * @see {@link LakeFormationClientResolvedConfig | config} for command's `input` shape. + * */ export class PutDataLakeSettingsCommand extends $Command< PutDataLakeSettingsCommandInput, diff --git a/clients/client-lakeformation/commands/RegisterResourceCommand.ts b/clients/client-lakeformation/commands/RegisterResourceCommand.ts index d4f8983e6c78..134b8baf52bd 100644 --- a/clients/client-lakeformation/commands/RegisterResourceCommand.ts +++ b/clients/client-lakeformation/commands/RegisterResourceCommand.ts @@ -37,6 +37,20 @@ export interface RegisterResourceCommandOutput extends RegisterResourceResponse, *

* arn:aws:iam::12345:role/my-data-access-role *

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { LakeFormationClient, RegisterResourceCommand } from "@aws-sdk/client-lakeformation"; // ES Modules import + * // const { LakeFormationClient, RegisterResourceCommand } = require("@aws-sdk/client-lakeformation"); // CommonJS import + * const client = new LakeFormationClient(config); + * const command = new RegisterResourceCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link RegisterResourceCommandInput} for command's `input` shape. + * @see {@link RegisterResourceCommandOutput} for command's `response` shape. + * @see {@link LakeFormationClientResolvedConfig | config} for command's `input` shape. + * */ export class RegisterResourceCommand extends $Command< RegisterResourceCommandInput, diff --git a/clients/client-lakeformation/commands/RevokePermissionsCommand.ts b/clients/client-lakeformation/commands/RevokePermissionsCommand.ts index b3bc0942cea0..ab79ced77efa 100644 --- a/clients/client-lakeformation/commands/RevokePermissionsCommand.ts +++ b/clients/client-lakeformation/commands/RevokePermissionsCommand.ts @@ -22,6 +22,20 @@ export interface RevokePermissionsCommandOutput extends RevokePermissionsRespons /** *

Revokes permissions to the principal to access metadata in the Data Catalog and data organized in underlying data storage such as Amazon S3.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { LakeFormationClient, RevokePermissionsCommand } from "@aws-sdk/client-lakeformation"; // ES Modules import + * // const { LakeFormationClient, RevokePermissionsCommand } = require("@aws-sdk/client-lakeformation"); // CommonJS import + * const client = new LakeFormationClient(config); + * const command = new RevokePermissionsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link RevokePermissionsCommandInput} for command's `input` shape. + * @see {@link RevokePermissionsCommandOutput} for command's `response` shape. + * @see {@link LakeFormationClientResolvedConfig | config} for command's `input` shape. + * */ export class RevokePermissionsCommand extends $Command< RevokePermissionsCommandInput, diff --git a/clients/client-lakeformation/commands/UpdateResourceCommand.ts b/clients/client-lakeformation/commands/UpdateResourceCommand.ts index a8e303fe3596..2eab428dd2f2 100644 --- a/clients/client-lakeformation/commands/UpdateResourceCommand.ts +++ b/clients/client-lakeformation/commands/UpdateResourceCommand.ts @@ -22,6 +22,20 @@ export interface UpdateResourceCommandOutput extends UpdateResourceResponse, __M /** *

Updates the data access role used for vending access to the given (registered) resource in AWS Lake Formation.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { LakeFormationClient, UpdateResourceCommand } from "@aws-sdk/client-lakeformation"; // ES Modules import + * // const { LakeFormationClient, UpdateResourceCommand } = require("@aws-sdk/client-lakeformation"); // CommonJS import + * const client = new LakeFormationClient(config); + * const command = new UpdateResourceCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link UpdateResourceCommandInput} for command's `input` shape. + * @see {@link UpdateResourceCommandOutput} for command's `response` shape. + * @see {@link LakeFormationClientResolvedConfig | config} for command's `input` shape. + * */ export class UpdateResourceCommand extends $Command< UpdateResourceCommandInput, diff --git a/clients/client-lakeformation/models/models_0.ts b/clients/client-lakeformation/models/models_0.ts index d8101edda73f..510588e31574 100644 --- a/clients/client-lakeformation/models/models_0.ts +++ b/clients/client-lakeformation/models/models_0.ts @@ -14,6 +14,9 @@ export interface AlreadyExistsException extends __SmithyException, $MetadataBear } export namespace AlreadyExistsException { + /** + * @internal + */ export const filterSensitiveLog = (obj: AlreadyExistsException): any => ({ ...obj, }); @@ -43,6 +46,9 @@ export interface DataLakePrincipal { } export namespace DataLakePrincipal { + /** + * @internal + */ export const filterSensitiveLog = (obj: DataLakePrincipal): any => ({ ...obj, }); @@ -54,6 +60,9 @@ export namespace DataLakePrincipal { export interface CatalogResource {} export namespace CatalogResource { + /** + * @internal + */ export const filterSensitiveLog = (obj: CatalogResource): any => ({ ...obj, }); @@ -75,6 +84,9 @@ export interface DatabaseResource { } export namespace DatabaseResource { + /** + * @internal + */ export const filterSensitiveLog = (obj: DatabaseResource): any => ({ ...obj, }); @@ -96,6 +108,9 @@ export interface DataLocationResource { } export namespace DataLocationResource { + /** + * @internal + */ export const filterSensitiveLog = (obj: DataLocationResource): any => ({ ...obj, }); @@ -107,6 +122,9 @@ export namespace DataLocationResource { export interface TableWildcard {} export namespace TableWildcard { + /** + * @internal + */ export const filterSensitiveLog = (obj: TableWildcard): any => ({ ...obj, }); @@ -140,6 +158,9 @@ export interface TableResource { } export namespace TableResource { + /** + * @internal + */ export const filterSensitiveLog = (obj: TableResource): any => ({ ...obj, }); @@ -156,6 +177,9 @@ export interface ColumnWildcard { } export namespace ColumnWildcard { + /** + * @internal + */ export const filterSensitiveLog = (obj: ColumnWildcard): any => ({ ...obj, }); @@ -193,6 +217,9 @@ export interface TableWithColumnsResource { } export namespace TableWithColumnsResource { + /** + * @internal + */ export const filterSensitiveLog = (obj: TableWithColumnsResource): any => ({ ...obj, }); @@ -229,6 +256,9 @@ export interface Resource { } export namespace Resource { + /** + * @internal + */ export const filterSensitiveLog = (obj: Resource): any => ({ ...obj, }); @@ -265,6 +295,9 @@ export interface BatchPermissionsRequestEntry { } export namespace BatchPermissionsRequestEntry { + /** + * @internal + */ export const filterSensitiveLog = (obj: BatchPermissionsRequestEntry): any => ({ ...obj, }); @@ -283,6 +316,9 @@ export interface BatchGrantPermissionsRequest { } export namespace BatchGrantPermissionsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: BatchGrantPermissionsRequest): any => ({ ...obj, }); @@ -304,6 +340,9 @@ export interface ErrorDetail { } export namespace ErrorDetail { + /** + * @internal + */ export const filterSensitiveLog = (obj: ErrorDetail): any => ({ ...obj, }); @@ -325,6 +364,9 @@ export interface BatchPermissionsFailureEntry { } export namespace BatchPermissionsFailureEntry { + /** + * @internal + */ export const filterSensitiveLog = (obj: BatchPermissionsFailureEntry): any => ({ ...obj, }); @@ -338,6 +380,9 @@ export interface BatchGrantPermissionsResponse { } export namespace BatchGrantPermissionsResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: BatchGrantPermissionsResponse): any => ({ ...obj, }); @@ -356,6 +401,9 @@ export interface InvalidInputException extends __SmithyException, $MetadataBeare } export namespace InvalidInputException { + /** + * @internal + */ export const filterSensitiveLog = (obj: InvalidInputException): any => ({ ...obj, }); @@ -374,6 +422,9 @@ export interface OperationTimeoutException extends __SmithyException, $MetadataB } export namespace OperationTimeoutException { + /** + * @internal + */ export const filterSensitiveLog = (obj: OperationTimeoutException): any => ({ ...obj, }); @@ -392,6 +443,9 @@ export interface BatchRevokePermissionsRequest { } export namespace BatchRevokePermissionsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: BatchRevokePermissionsRequest): any => ({ ...obj, }); @@ -405,6 +459,9 @@ export interface BatchRevokePermissionsResponse { } export namespace BatchRevokePermissionsResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: BatchRevokePermissionsResponse): any => ({ ...obj, }); @@ -418,6 +475,9 @@ export interface DeregisterResourceRequest { } export namespace DeregisterResourceRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeregisterResourceRequest): any => ({ ...obj, }); @@ -426,6 +486,9 @@ export namespace DeregisterResourceRequest { export interface DeregisterResourceResponse {} export namespace DeregisterResourceResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeregisterResourceResponse): any => ({ ...obj, }); @@ -444,6 +507,9 @@ export interface EntityNotFoundException extends __SmithyException, $MetadataBea } export namespace EntityNotFoundException { + /** + * @internal + */ export const filterSensitiveLog = (obj: EntityNotFoundException): any => ({ ...obj, }); @@ -462,6 +528,9 @@ export interface InternalServiceException extends __SmithyException, $MetadataBe } export namespace InternalServiceException { + /** + * @internal + */ export const filterSensitiveLog = (obj: InternalServiceException): any => ({ ...obj, }); @@ -475,6 +544,9 @@ export interface DescribeResourceRequest { } export namespace DescribeResourceRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeResourceRequest): any => ({ ...obj, }); @@ -501,6 +573,9 @@ export interface ResourceInfo { } export namespace ResourceInfo { + /** + * @internal + */ export const filterSensitiveLog = (obj: ResourceInfo): any => ({ ...obj, }); @@ -514,6 +589,9 @@ export interface DescribeResourceResponse { } export namespace DescribeResourceResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeResourceResponse): any => ({ ...obj, }); @@ -527,6 +605,9 @@ export interface GetDataLakeSettingsRequest { } export namespace GetDataLakeSettingsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetDataLakeSettingsRequest): any => ({ ...obj, }); @@ -548,6 +629,9 @@ export interface PrincipalPermissions { } export namespace PrincipalPermissions { + /** + * @internal + */ export const filterSensitiveLog = (obj: PrincipalPermissions): any => ({ ...obj, }); @@ -581,6 +665,9 @@ export interface DataLakeSettings { } export namespace DataLakeSettings { + /** + * @internal + */ export const filterSensitiveLog = (obj: DataLakeSettings): any => ({ ...obj, }); @@ -594,6 +681,9 @@ export interface GetDataLakeSettingsResponse { } export namespace GetDataLakeSettingsResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetDataLakeSettingsResponse): any => ({ ...obj, }); @@ -622,6 +712,9 @@ export interface GetEffectivePermissionsForPathRequest { } export namespace GetEffectivePermissionsForPathRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetEffectivePermissionsForPathRequest): any => ({ ...obj, }); @@ -640,6 +733,9 @@ export interface DetailsMap { } export namespace DetailsMap { + /** + * @internal + */ export const filterSensitiveLog = (obj: DetailsMap): any => ({ ...obj, }); @@ -676,6 +772,9 @@ export interface PrincipalResourcePermissions { } export namespace PrincipalResourcePermissions { + /** + * @internal + */ export const filterSensitiveLog = (obj: PrincipalResourcePermissions): any => ({ ...obj, }); @@ -694,6 +793,9 @@ export interface GetEffectivePermissionsForPathResponse { } export namespace GetEffectivePermissionsForPathResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetEffectivePermissionsForPathResponse): any => ({ ...obj, }); @@ -712,6 +814,9 @@ export interface ConcurrentModificationException extends __SmithyException, $Met } export namespace ConcurrentModificationException { + /** + * @internal + */ export const filterSensitiveLog = (obj: ConcurrentModificationException): any => ({ ...obj, }); @@ -746,6 +851,9 @@ export interface GrantPermissionsRequest { } export namespace GrantPermissionsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GrantPermissionsRequest): any => ({ ...obj, }); @@ -754,6 +862,9 @@ export namespace GrantPermissionsRequest { export interface GrantPermissionsResponse {} export namespace GrantPermissionsResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: GrantPermissionsResponse): any => ({ ...obj, }); @@ -800,6 +911,9 @@ export interface ListPermissionsRequest { } export namespace ListPermissionsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListPermissionsRequest): any => ({ ...obj, }); @@ -818,6 +932,9 @@ export interface ListPermissionsResponse { } export namespace ListPermissionsResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListPermissionsResponse): any => ({ ...obj, }); @@ -864,6 +981,9 @@ export interface FilterCondition { } export namespace FilterCondition { + /** + * @internal + */ export const filterSensitiveLog = (obj: FilterCondition): any => ({ ...obj, }); @@ -887,6 +1007,9 @@ export interface ListResourcesRequest { } export namespace ListResourcesRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListResourcesRequest): any => ({ ...obj, }); @@ -905,6 +1028,9 @@ export interface ListResourcesResponse { } export namespace ListResourcesResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListResourcesResponse): any => ({ ...obj, }); @@ -923,6 +1049,9 @@ export interface PutDataLakeSettingsRequest { } export namespace PutDataLakeSettingsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: PutDataLakeSettingsRequest): any => ({ ...obj, }); @@ -931,6 +1060,9 @@ export namespace PutDataLakeSettingsRequest { export interface PutDataLakeSettingsResponse {} export namespace PutDataLakeSettingsResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: PutDataLakeSettingsResponse): any => ({ ...obj, }); @@ -956,6 +1088,9 @@ export interface RegisterResourceRequest { } export namespace RegisterResourceRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: RegisterResourceRequest): any => ({ ...obj, }); @@ -964,6 +1099,9 @@ export namespace RegisterResourceRequest { export interface RegisterResourceResponse {} export namespace RegisterResourceResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: RegisterResourceResponse): any => ({ ...obj, }); @@ -998,6 +1136,9 @@ export interface RevokePermissionsRequest { } export namespace RevokePermissionsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: RevokePermissionsRequest): any => ({ ...obj, }); @@ -1006,6 +1147,9 @@ export namespace RevokePermissionsRequest { export interface RevokePermissionsResponse {} export namespace RevokePermissionsResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: RevokePermissionsResponse): any => ({ ...obj, }); @@ -1024,6 +1168,9 @@ export interface UpdateResourceRequest { } export namespace UpdateResourceRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateResourceRequest): any => ({ ...obj, }); @@ -1032,6 +1179,9 @@ export namespace UpdateResourceRequest { export interface UpdateResourceResponse {} export namespace UpdateResourceResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateResourceResponse): any => ({ ...obj, }); diff --git a/clients/client-lambda/commands/AddLayerVersionPermissionCommand.ts b/clients/client-lambda/commands/AddLayerVersionPermissionCommand.ts index 4c5ffb1b54eb..2dd73bae4205 100644 --- a/clients/client-lambda/commands/AddLayerVersionPermissionCommand.ts +++ b/clients/client-lambda/commands/AddLayerVersionPermissionCommand.ts @@ -27,6 +27,20 @@ export interface AddLayerVersionPermissionCommandOutput extends AddLayerVersionP * accounts in an organization.

*

To revoke permission, call RemoveLayerVersionPermission with the statement ID that you * specified when you added it.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { LambdaClient, AddLayerVersionPermissionCommand } from "@aws-sdk/client-lambda"; // ES Modules import + * // const { LambdaClient, AddLayerVersionPermissionCommand } = require("@aws-sdk/client-lambda"); // CommonJS import + * const client = new LambdaClient(config); + * const command = new AddLayerVersionPermissionCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link AddLayerVersionPermissionCommandInput} for command's `input` shape. + * @see {@link AddLayerVersionPermissionCommandOutput} for command's `response` shape. + * @see {@link LambdaClientResolvedConfig | config} for command's `input` shape. + * */ export class AddLayerVersionPermissionCommand extends $Command< AddLayerVersionPermissionCommandInput, diff --git a/clients/client-lambda/commands/AddPermissionCommand.ts b/clients/client-lambda/commands/AddPermissionCommand.ts index c5e1eca6a5f7..8274ce61395d 100644 --- a/clients/client-lambda/commands/AddPermissionCommand.ts +++ b/clients/client-lambda/commands/AddPermissionCommand.ts @@ -33,6 +33,20 @@ export interface AddPermissionCommandOutput extends AddPermissionResponse, __Met * *

This action adds a statement to a resource-based permissions policy for the function. For more information * about function policies, see Lambda Function Policies.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { LambdaClient, AddPermissionCommand } from "@aws-sdk/client-lambda"; // ES Modules import + * // const { LambdaClient, AddPermissionCommand } = require("@aws-sdk/client-lambda"); // CommonJS import + * const client = new LambdaClient(config); + * const command = new AddPermissionCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link AddPermissionCommandInput} for command's `input` shape. + * @see {@link AddPermissionCommandOutput} for command's `response` shape. + * @see {@link LambdaClientResolvedConfig | config} for command's `input` shape. + * */ export class AddPermissionCommand extends $Command< AddPermissionCommandInput, diff --git a/clients/client-lambda/commands/CreateAliasCommand.ts b/clients/client-lambda/commands/CreateAliasCommand.ts index 2bb4db620a0c..dcd50182a3c7 100644 --- a/clients/client-lambda/commands/CreateAliasCommand.ts +++ b/clients/client-lambda/commands/CreateAliasCommand.ts @@ -27,6 +27,20 @@ export interface CreateAliasCommandOutput extends AliasConfiguration, __Metadata *

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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { LambdaClient, CreateAliasCommand } from "@aws-sdk/client-lambda"; // ES Modules import + * // const { LambdaClient, CreateAliasCommand } = require("@aws-sdk/client-lambda"); // CommonJS import + * const client = new LambdaClient(config); + * const command = new CreateAliasCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreateAliasCommandInput} for command's `input` shape. + * @see {@link CreateAliasCommandOutput} for command's `response` shape. + * @see {@link LambdaClientResolvedConfig | config} for command's `input` shape. + * */ export class CreateAliasCommand extends $Command< CreateAliasCommandInput, diff --git a/clients/client-lambda/commands/CreateCodeSigningConfigCommand.ts b/clients/client-lambda/commands/CreateCodeSigningConfigCommand.ts index b30bc1323da9..a2dbfef4491e 100644 --- a/clients/client-lambda/commands/CreateCodeSigningConfigCommand.ts +++ b/clients/client-lambda/commands/CreateCodeSigningConfigCommand.ts @@ -24,6 +24,20 @@ export interface CreateCodeSigningConfigCommandOutput extends CreateCodeSigningC *

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).

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { LambdaClient, CreateCodeSigningConfigCommand } from "@aws-sdk/client-lambda"; // ES Modules import + * // const { LambdaClient, CreateCodeSigningConfigCommand } = require("@aws-sdk/client-lambda"); // CommonJS import + * const client = new LambdaClient(config); + * const command = new CreateCodeSigningConfigCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreateCodeSigningConfigCommandInput} for command's `input` shape. + * @see {@link CreateCodeSigningConfigCommandOutput} for command's `response` shape. + * @see {@link LambdaClientResolvedConfig | config} for command's `input` shape. + * */ export class CreateCodeSigningConfigCommand extends $Command< CreateCodeSigningConfigCommandInput, diff --git a/clients/client-lambda/commands/CreateEventSourceMappingCommand.ts b/clients/client-lambda/commands/CreateEventSourceMappingCommand.ts index 55072db36cc0..9c2d1d702477 100644 --- a/clients/client-lambda/commands/CreateEventSourceMappingCommand.ts +++ b/clients/client-lambda/commands/CreateEventSourceMappingCommand.ts @@ -83,6 +83,20 @@ export interface CreateEventSourceMappingCommandOutput extends EventSourceMappin * ParallelizationFactor - Process multiple batches from each shard concurrently.

* * + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { LambdaClient, CreateEventSourceMappingCommand } from "@aws-sdk/client-lambda"; // ES Modules import + * // const { LambdaClient, CreateEventSourceMappingCommand } = require("@aws-sdk/client-lambda"); // CommonJS import + * const client = new LambdaClient(config); + * const command = new CreateEventSourceMappingCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreateEventSourceMappingCommandInput} for command's `input` shape. + * @see {@link CreateEventSourceMappingCommandOutput} for command's `response` shape. + * @see {@link LambdaClientResolvedConfig | config} for command's `input` shape. + * */ export class CreateEventSourceMappingCommand extends $Command< CreateEventSourceMappingCommandInput, diff --git a/clients/client-lambda/commands/CreateFunctionCommand.ts b/clients/client-lambda/commands/CreateFunctionCommand.ts index 226db22b22e3..7d9a3221ae59 100644 --- a/clients/client-lambda/commands/CreateFunctionCommand.ts +++ b/clients/client-lambda/commands/CreateFunctionCommand.ts @@ -56,6 +56,20 @@ export interface CreateFunctionCommandOutput extends FunctionConfiguration, __Me *

To invoke your function directly, use Invoke. To invoke your function in response to events * in other AWS services, create an event source mapping (CreateEventSourceMapping), or configure a * function trigger in the other service. For more information, see Invoking Functions.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { LambdaClient, CreateFunctionCommand } from "@aws-sdk/client-lambda"; // ES Modules import + * // const { LambdaClient, CreateFunctionCommand } = require("@aws-sdk/client-lambda"); // CommonJS import + * const client = new LambdaClient(config); + * const command = new CreateFunctionCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreateFunctionCommandInput} for command's `input` shape. + * @see {@link CreateFunctionCommandOutput} for command's `response` shape. + * @see {@link LambdaClientResolvedConfig | config} for command's `input` shape. + * */ export class CreateFunctionCommand extends $Command< CreateFunctionCommandInput, diff --git a/clients/client-lambda/commands/DeleteAliasCommand.ts b/clients/client-lambda/commands/DeleteAliasCommand.ts index 5ae15c0af909..5ca475a88697 100644 --- a/clients/client-lambda/commands/DeleteAliasCommand.ts +++ b/clients/client-lambda/commands/DeleteAliasCommand.ts @@ -22,6 +22,20 @@ export interface DeleteAliasCommandOutput extends __MetadataBearer {} /** *

Deletes a Lambda function alias.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { LambdaClient, DeleteAliasCommand } from "@aws-sdk/client-lambda"; // ES Modules import + * // const { LambdaClient, DeleteAliasCommand } = require("@aws-sdk/client-lambda"); // CommonJS import + * const client = new LambdaClient(config); + * const command = new DeleteAliasCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteAliasCommandInput} for command's `input` shape. + * @see {@link DeleteAliasCommandOutput} for command's `response` shape. + * @see {@link LambdaClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteAliasCommand extends $Command< DeleteAliasCommandInput, diff --git a/clients/client-lambda/commands/DeleteCodeSigningConfigCommand.ts b/clients/client-lambda/commands/DeleteCodeSigningConfigCommand.ts index 4c28ae7fc38c..8b5ae06186b2 100644 --- a/clients/client-lambda/commands/DeleteCodeSigningConfigCommand.ts +++ b/clients/client-lambda/commands/DeleteCodeSigningConfigCommand.ts @@ -23,6 +23,20 @@ export interface DeleteCodeSigningConfigCommandOutput extends DeleteCodeSigningC /** *

Deletes the code signing configuration. You can delete the code signing configuration only if no function is * using it.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { LambdaClient, DeleteCodeSigningConfigCommand } from "@aws-sdk/client-lambda"; // ES Modules import + * // const { LambdaClient, DeleteCodeSigningConfigCommand } = require("@aws-sdk/client-lambda"); // CommonJS import + * const client = new LambdaClient(config); + * const command = new DeleteCodeSigningConfigCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteCodeSigningConfigCommandInput} for command's `input` shape. + * @see {@link DeleteCodeSigningConfigCommandOutput} for command's `response` shape. + * @see {@link LambdaClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteCodeSigningConfigCommand extends $Command< DeleteCodeSigningConfigCommandInput, diff --git a/clients/client-lambda/commands/DeleteEventSourceMappingCommand.ts b/clients/client-lambda/commands/DeleteEventSourceMappingCommand.ts index d62cdada2e71..911d91e0fcaf 100644 --- a/clients/client-lambda/commands/DeleteEventSourceMappingCommand.ts +++ b/clients/client-lambda/commands/DeleteEventSourceMappingCommand.ts @@ -24,6 +24,20 @@ export interface DeleteEventSourceMappingCommandOutput extends EventSourceMappin *

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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { LambdaClient, DeleteEventSourceMappingCommand } from "@aws-sdk/client-lambda"; // ES Modules import + * // const { LambdaClient, DeleteEventSourceMappingCommand } = require("@aws-sdk/client-lambda"); // CommonJS import + * const client = new LambdaClient(config); + * const command = new DeleteEventSourceMappingCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteEventSourceMappingCommandInput} for command's `input` shape. + * @see {@link DeleteEventSourceMappingCommandOutput} for command's `response` shape. + * @see {@link LambdaClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteEventSourceMappingCommand extends $Command< DeleteEventSourceMappingCommandInput, diff --git a/clients/client-lambda/commands/DeleteFunctionCodeSigningConfigCommand.ts b/clients/client-lambda/commands/DeleteFunctionCodeSigningConfigCommand.ts index 321ed78ecd3a..9c1bb4058076 100644 --- a/clients/client-lambda/commands/DeleteFunctionCodeSigningConfigCommand.ts +++ b/clients/client-lambda/commands/DeleteFunctionCodeSigningConfigCommand.ts @@ -22,6 +22,20 @@ export interface DeleteFunctionCodeSigningConfigCommandOutput extends __Metadata /** *

Removes the code signing configuration from the function.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { LambdaClient, DeleteFunctionCodeSigningConfigCommand } from "@aws-sdk/client-lambda"; // ES Modules import + * // const { LambdaClient, DeleteFunctionCodeSigningConfigCommand } = require("@aws-sdk/client-lambda"); // CommonJS import + * const client = new LambdaClient(config); + * const command = new DeleteFunctionCodeSigningConfigCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteFunctionCodeSigningConfigCommandInput} for command's `input` shape. + * @see {@link DeleteFunctionCodeSigningConfigCommandOutput} for command's `response` shape. + * @see {@link LambdaClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteFunctionCodeSigningConfigCommand extends $Command< DeleteFunctionCodeSigningConfigCommandInput, diff --git a/clients/client-lambda/commands/DeleteFunctionCommand.ts b/clients/client-lambda/commands/DeleteFunctionCommand.ts index 88e76248ab53..16127a754600 100644 --- a/clients/client-lambda/commands/DeleteFunctionCommand.ts +++ b/clients/client-lambda/commands/DeleteFunctionCommand.ts @@ -27,6 +27,20 @@ export interface DeleteFunctionCommandOutput extends __MetadataBearer {} *

To delete Lambda event source mappings that invoke a function, use DeleteEventSourceMapping. * For AWS services and resources that invoke your function directly, delete the trigger in the service where you * originally configured it.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { LambdaClient, DeleteFunctionCommand } from "@aws-sdk/client-lambda"; // ES Modules import + * // const { LambdaClient, DeleteFunctionCommand } = require("@aws-sdk/client-lambda"); // CommonJS import + * const client = new LambdaClient(config); + * const command = new DeleteFunctionCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteFunctionCommandInput} for command's `input` shape. + * @see {@link DeleteFunctionCommandOutput} for command's `response` shape. + * @see {@link LambdaClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteFunctionCommand extends $Command< DeleteFunctionCommandInput, diff --git a/clients/client-lambda/commands/DeleteFunctionConcurrencyCommand.ts b/clients/client-lambda/commands/DeleteFunctionConcurrencyCommand.ts index 444db615da65..889108728abf 100644 --- a/clients/client-lambda/commands/DeleteFunctionConcurrencyCommand.ts +++ b/clients/client-lambda/commands/DeleteFunctionConcurrencyCommand.ts @@ -22,6 +22,20 @@ export interface DeleteFunctionConcurrencyCommandOutput extends __MetadataBearer /** *

Removes a concurrent execution limit from a function.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { LambdaClient, DeleteFunctionConcurrencyCommand } from "@aws-sdk/client-lambda"; // ES Modules import + * // const { LambdaClient, DeleteFunctionConcurrencyCommand } = require("@aws-sdk/client-lambda"); // CommonJS import + * const client = new LambdaClient(config); + * const command = new DeleteFunctionConcurrencyCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteFunctionConcurrencyCommandInput} for command's `input` shape. + * @see {@link DeleteFunctionConcurrencyCommandOutput} for command's `response` shape. + * @see {@link LambdaClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteFunctionConcurrencyCommand extends $Command< DeleteFunctionConcurrencyCommandInput, diff --git a/clients/client-lambda/commands/DeleteFunctionEventInvokeConfigCommand.ts b/clients/client-lambda/commands/DeleteFunctionEventInvokeConfigCommand.ts index c33d5bef7e0d..1611a0415ac1 100644 --- a/clients/client-lambda/commands/DeleteFunctionEventInvokeConfigCommand.ts +++ b/clients/client-lambda/commands/DeleteFunctionEventInvokeConfigCommand.ts @@ -23,6 +23,20 @@ export interface DeleteFunctionEventInvokeConfigCommandOutput extends __Metadata /** *

Deletes the configuration for asynchronous invocation for a function, version, or alias.

*

To configure options for asynchronous invocation, use PutFunctionEventInvokeConfig.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { LambdaClient, DeleteFunctionEventInvokeConfigCommand } from "@aws-sdk/client-lambda"; // ES Modules import + * // const { LambdaClient, DeleteFunctionEventInvokeConfigCommand } = require("@aws-sdk/client-lambda"); // CommonJS import + * const client = new LambdaClient(config); + * const command = new DeleteFunctionEventInvokeConfigCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteFunctionEventInvokeConfigCommandInput} for command's `input` shape. + * @see {@link DeleteFunctionEventInvokeConfigCommandOutput} for command's `response` shape. + * @see {@link LambdaClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteFunctionEventInvokeConfigCommand extends $Command< DeleteFunctionEventInvokeConfigCommandInput, diff --git a/clients/client-lambda/commands/DeleteLayerVersionCommand.ts b/clients/client-lambda/commands/DeleteLayerVersionCommand.ts index b5c1288b7a47..0b96f5fe578c 100644 --- a/clients/client-lambda/commands/DeleteLayerVersionCommand.ts +++ b/clients/client-lambda/commands/DeleteLayerVersionCommand.ts @@ -24,6 +24,20 @@ export interface DeleteLayerVersionCommandOutput extends __MetadataBearer {} *

Deletes a version of an AWS 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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { LambdaClient, DeleteLayerVersionCommand } from "@aws-sdk/client-lambda"; // ES Modules import + * // const { LambdaClient, DeleteLayerVersionCommand } = require("@aws-sdk/client-lambda"); // CommonJS import + * const client = new LambdaClient(config); + * const command = new DeleteLayerVersionCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteLayerVersionCommandInput} for command's `input` shape. + * @see {@link DeleteLayerVersionCommandOutput} for command's `response` shape. + * @see {@link LambdaClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteLayerVersionCommand extends $Command< DeleteLayerVersionCommandInput, diff --git a/clients/client-lambda/commands/DeleteProvisionedConcurrencyConfigCommand.ts b/clients/client-lambda/commands/DeleteProvisionedConcurrencyConfigCommand.ts index ea66f847a79c..38ad0ce47bfe 100644 --- a/clients/client-lambda/commands/DeleteProvisionedConcurrencyConfigCommand.ts +++ b/clients/client-lambda/commands/DeleteProvisionedConcurrencyConfigCommand.ts @@ -22,6 +22,20 @@ export interface DeleteProvisionedConcurrencyConfigCommandOutput extends __Metad /** *

Deletes the provisioned concurrency configuration for a function.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { LambdaClient, DeleteProvisionedConcurrencyConfigCommand } from "@aws-sdk/client-lambda"; // ES Modules import + * // const { LambdaClient, DeleteProvisionedConcurrencyConfigCommand } = require("@aws-sdk/client-lambda"); // CommonJS import + * const client = new LambdaClient(config); + * const command = new DeleteProvisionedConcurrencyConfigCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteProvisionedConcurrencyConfigCommandInput} for command's `input` shape. + * @see {@link DeleteProvisionedConcurrencyConfigCommandOutput} for command's `response` shape. + * @see {@link LambdaClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteProvisionedConcurrencyConfigCommand extends $Command< DeleteProvisionedConcurrencyConfigCommandInput, diff --git a/clients/client-lambda/commands/GetAccountSettingsCommand.ts b/clients/client-lambda/commands/GetAccountSettingsCommand.ts index ffd6cc1c18fc..abda3f475669 100644 --- a/clients/client-lambda/commands/GetAccountSettingsCommand.ts +++ b/clients/client-lambda/commands/GetAccountSettingsCommand.ts @@ -22,6 +22,20 @@ export interface GetAccountSettingsCommandOutput extends GetAccountSettingsRespo /** *

Retrieves details about your account's limits and usage in an AWS Region.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { LambdaClient, GetAccountSettingsCommand } from "@aws-sdk/client-lambda"; // ES Modules import + * // const { LambdaClient, GetAccountSettingsCommand } = require("@aws-sdk/client-lambda"); // CommonJS import + * const client = new LambdaClient(config); + * const command = new GetAccountSettingsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetAccountSettingsCommandInput} for command's `input` shape. + * @see {@link GetAccountSettingsCommandOutput} for command's `response` shape. + * @see {@link LambdaClientResolvedConfig | config} for command's `input` shape. + * */ export class GetAccountSettingsCommand extends $Command< GetAccountSettingsCommandInput, diff --git a/clients/client-lambda/commands/GetAliasCommand.ts b/clients/client-lambda/commands/GetAliasCommand.ts index 3354abbe37c9..d5bfc184f047 100644 --- a/clients/client-lambda/commands/GetAliasCommand.ts +++ b/clients/client-lambda/commands/GetAliasCommand.ts @@ -22,6 +22,20 @@ export interface GetAliasCommandOutput extends AliasConfiguration, __MetadataBea /** *

Returns details about a Lambda function alias.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { LambdaClient, GetAliasCommand } from "@aws-sdk/client-lambda"; // ES Modules import + * // const { LambdaClient, GetAliasCommand } = require("@aws-sdk/client-lambda"); // CommonJS import + * const client = new LambdaClient(config); + * const command = new GetAliasCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetAliasCommandInput} for command's `input` shape. + * @see {@link GetAliasCommandOutput} for command's `response` shape. + * @see {@link LambdaClientResolvedConfig | config} for command's `input` shape. + * */ export class GetAliasCommand extends $Command { // Start section: command_properties diff --git a/clients/client-lambda/commands/GetCodeSigningConfigCommand.ts b/clients/client-lambda/commands/GetCodeSigningConfigCommand.ts index 979914baf479..c9a497c37300 100644 --- a/clients/client-lambda/commands/GetCodeSigningConfigCommand.ts +++ b/clients/client-lambda/commands/GetCodeSigningConfigCommand.ts @@ -22,6 +22,20 @@ export interface GetCodeSigningConfigCommandOutput extends GetCodeSigningConfigR /** *

Returns information about the specified code signing configuration.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { LambdaClient, GetCodeSigningConfigCommand } from "@aws-sdk/client-lambda"; // ES Modules import + * // const { LambdaClient, GetCodeSigningConfigCommand } = require("@aws-sdk/client-lambda"); // CommonJS import + * const client = new LambdaClient(config); + * const command = new GetCodeSigningConfigCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetCodeSigningConfigCommandInput} for command's `input` shape. + * @see {@link GetCodeSigningConfigCommandOutput} for command's `response` shape. + * @see {@link LambdaClientResolvedConfig | config} for command's `input` shape. + * */ export class GetCodeSigningConfigCommand extends $Command< GetCodeSigningConfigCommandInput, diff --git a/clients/client-lambda/commands/GetEventSourceMappingCommand.ts b/clients/client-lambda/commands/GetEventSourceMappingCommand.ts index cc622f57bf7d..4266b689113c 100644 --- a/clients/client-lambda/commands/GetEventSourceMappingCommand.ts +++ b/clients/client-lambda/commands/GetEventSourceMappingCommand.ts @@ -22,6 +22,20 @@ export interface GetEventSourceMappingCommandOutput extends EventSourceMappingCo /** *

Returns details about an event source mapping. You can get the identifier of a mapping from the output of ListEventSourceMappings.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { LambdaClient, GetEventSourceMappingCommand } from "@aws-sdk/client-lambda"; // ES Modules import + * // const { LambdaClient, GetEventSourceMappingCommand } = require("@aws-sdk/client-lambda"); // CommonJS import + * const client = new LambdaClient(config); + * const command = new GetEventSourceMappingCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetEventSourceMappingCommandInput} for command's `input` shape. + * @see {@link GetEventSourceMappingCommandOutput} for command's `response` shape. + * @see {@link LambdaClientResolvedConfig | config} for command's `input` shape. + * */ export class GetEventSourceMappingCommand extends $Command< GetEventSourceMappingCommandInput, diff --git a/clients/client-lambda/commands/GetFunctionCodeSigningConfigCommand.ts b/clients/client-lambda/commands/GetFunctionCodeSigningConfigCommand.ts index 8f419b11b189..13f4a9e5e2ef 100644 --- a/clients/client-lambda/commands/GetFunctionCodeSigningConfigCommand.ts +++ b/clients/client-lambda/commands/GetFunctionCodeSigningConfigCommand.ts @@ -24,6 +24,20 @@ export interface GetFunctionCodeSigningConfigCommandOutput /** *

Returns the code signing configuration for the specified function.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { LambdaClient, GetFunctionCodeSigningConfigCommand } from "@aws-sdk/client-lambda"; // ES Modules import + * // const { LambdaClient, GetFunctionCodeSigningConfigCommand } = require("@aws-sdk/client-lambda"); // CommonJS import + * const client = new LambdaClient(config); + * const command = new GetFunctionCodeSigningConfigCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetFunctionCodeSigningConfigCommandInput} for command's `input` shape. + * @see {@link GetFunctionCodeSigningConfigCommandOutput} for command's `response` shape. + * @see {@link LambdaClientResolvedConfig | config} for command's `input` shape. + * */ export class GetFunctionCodeSigningConfigCommand extends $Command< GetFunctionCodeSigningConfigCommandInput, diff --git a/clients/client-lambda/commands/GetFunctionCommand.ts b/clients/client-lambda/commands/GetFunctionCommand.ts index 581bb947fac6..216c7b003be5 100644 --- a/clients/client-lambda/commands/GetFunctionCommand.ts +++ b/clients/client-lambda/commands/GetFunctionCommand.ts @@ -24,6 +24,20 @@ export interface GetFunctionCommandOutput extends GetFunctionResponse, __Metadat *

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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { LambdaClient, GetFunctionCommand } from "@aws-sdk/client-lambda"; // ES Modules import + * // const { LambdaClient, GetFunctionCommand } = require("@aws-sdk/client-lambda"); // CommonJS import + * const client = new LambdaClient(config); + * const command = new GetFunctionCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetFunctionCommandInput} for command's `input` shape. + * @see {@link GetFunctionCommandOutput} for command's `response` shape. + * @see {@link LambdaClientResolvedConfig | config} for command's `input` shape. + * */ export class GetFunctionCommand extends $Command< GetFunctionCommandInput, diff --git a/clients/client-lambda/commands/GetFunctionConcurrencyCommand.ts b/clients/client-lambda/commands/GetFunctionConcurrencyCommand.ts index f12be9ac8da0..0793878ecb1c 100644 --- a/clients/client-lambda/commands/GetFunctionConcurrencyCommand.ts +++ b/clients/client-lambda/commands/GetFunctionConcurrencyCommand.ts @@ -23,6 +23,20 @@ export interface GetFunctionConcurrencyCommandOutput extends GetFunctionConcurre /** *

Returns details about the reserved concurrency configuration for a function. To set a concurrency limit for a * function, use PutFunctionConcurrency.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { LambdaClient, GetFunctionConcurrencyCommand } from "@aws-sdk/client-lambda"; // ES Modules import + * // const { LambdaClient, GetFunctionConcurrencyCommand } = require("@aws-sdk/client-lambda"); // CommonJS import + * const client = new LambdaClient(config); + * const command = new GetFunctionConcurrencyCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetFunctionConcurrencyCommandInput} for command's `input` shape. + * @see {@link GetFunctionConcurrencyCommandOutput} for command's `response` shape. + * @see {@link LambdaClientResolvedConfig | config} for command's `input` shape. + * */ export class GetFunctionConcurrencyCommand extends $Command< GetFunctionConcurrencyCommandInput, diff --git a/clients/client-lambda/commands/GetFunctionConfigurationCommand.ts b/clients/client-lambda/commands/GetFunctionConfigurationCommand.ts index dfe156d30a4e..d5eae7eaa258 100644 --- a/clients/client-lambda/commands/GetFunctionConfigurationCommand.ts +++ b/clients/client-lambda/commands/GetFunctionConfigurationCommand.ts @@ -24,6 +24,20 @@ export interface GetFunctionConfigurationCommandOutput extends FunctionConfigura *

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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { LambdaClient, GetFunctionConfigurationCommand } from "@aws-sdk/client-lambda"; // ES Modules import + * // const { LambdaClient, GetFunctionConfigurationCommand } = require("@aws-sdk/client-lambda"); // CommonJS import + * const client = new LambdaClient(config); + * const command = new GetFunctionConfigurationCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetFunctionConfigurationCommandInput} for command's `input` shape. + * @see {@link GetFunctionConfigurationCommandOutput} for command's `response` shape. + * @see {@link LambdaClientResolvedConfig | config} for command's `input` shape. + * */ export class GetFunctionConfigurationCommand extends $Command< GetFunctionConfigurationCommandInput, diff --git a/clients/client-lambda/commands/GetFunctionEventInvokeConfigCommand.ts b/clients/client-lambda/commands/GetFunctionEventInvokeConfigCommand.ts index c61f7ba1ce25..061566ef7722 100644 --- a/clients/client-lambda/commands/GetFunctionEventInvokeConfigCommand.ts +++ b/clients/client-lambda/commands/GetFunctionEventInvokeConfigCommand.ts @@ -23,6 +23,20 @@ export interface GetFunctionEventInvokeConfigCommandOutput extends FunctionEvent /** *

Retrieves the configuration for asynchronous invocation for a function, version, or alias.

*

To configure options for asynchronous invocation, use PutFunctionEventInvokeConfig.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { LambdaClient, GetFunctionEventInvokeConfigCommand } from "@aws-sdk/client-lambda"; // ES Modules import + * // const { LambdaClient, GetFunctionEventInvokeConfigCommand } = require("@aws-sdk/client-lambda"); // CommonJS import + * const client = new LambdaClient(config); + * const command = new GetFunctionEventInvokeConfigCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetFunctionEventInvokeConfigCommandInput} for command's `input` shape. + * @see {@link GetFunctionEventInvokeConfigCommandOutput} for command's `response` shape. + * @see {@link LambdaClientResolvedConfig | config} for command's `input` shape. + * */ export class GetFunctionEventInvokeConfigCommand extends $Command< GetFunctionEventInvokeConfigCommandInput, diff --git a/clients/client-lambda/commands/GetLayerVersionByArnCommand.ts b/clients/client-lambda/commands/GetLayerVersionByArnCommand.ts index b9b4cce52b9e..06553e6223bf 100644 --- a/clients/client-lambda/commands/GetLayerVersionByArnCommand.ts +++ b/clients/client-lambda/commands/GetLayerVersionByArnCommand.ts @@ -24,6 +24,20 @@ export interface GetLayerVersionByArnCommandOutput extends GetLayerVersionRespon *

Returns information about a version of an AWS Lambda * layer, with a link to download the layer archive * that's valid for 10 minutes.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { LambdaClient, GetLayerVersionByArnCommand } from "@aws-sdk/client-lambda"; // ES Modules import + * // const { LambdaClient, GetLayerVersionByArnCommand } = require("@aws-sdk/client-lambda"); // CommonJS import + * const client = new LambdaClient(config); + * const command = new GetLayerVersionByArnCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetLayerVersionByArnCommandInput} for command's `input` shape. + * @see {@link GetLayerVersionByArnCommandOutput} for command's `response` shape. + * @see {@link LambdaClientResolvedConfig | config} for command's `input` shape. + * */ export class GetLayerVersionByArnCommand extends $Command< GetLayerVersionByArnCommandInput, diff --git a/clients/client-lambda/commands/GetLayerVersionCommand.ts b/clients/client-lambda/commands/GetLayerVersionCommand.ts index e764b09cb144..ac411ec1d8fa 100644 --- a/clients/client-lambda/commands/GetLayerVersionCommand.ts +++ b/clients/client-lambda/commands/GetLayerVersionCommand.ts @@ -24,6 +24,20 @@ export interface GetLayerVersionCommandOutput extends GetLayerVersionResponse, _ *

Returns information about a version of an AWS Lambda * layer, with a link to download the layer archive * that's valid for 10 minutes.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { LambdaClient, GetLayerVersionCommand } from "@aws-sdk/client-lambda"; // ES Modules import + * // const { LambdaClient, GetLayerVersionCommand } = require("@aws-sdk/client-lambda"); // CommonJS import + * const client = new LambdaClient(config); + * const command = new GetLayerVersionCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetLayerVersionCommandInput} for command's `input` shape. + * @see {@link GetLayerVersionCommandOutput} for command's `response` shape. + * @see {@link LambdaClientResolvedConfig | config} for command's `input` shape. + * */ export class GetLayerVersionCommand extends $Command< GetLayerVersionCommandInput, diff --git a/clients/client-lambda/commands/GetLayerVersionPolicyCommand.ts b/clients/client-lambda/commands/GetLayerVersionPolicyCommand.ts index 46cb37054cd3..c72b68c47bbc 100644 --- a/clients/client-lambda/commands/GetLayerVersionPolicyCommand.ts +++ b/clients/client-lambda/commands/GetLayerVersionPolicyCommand.ts @@ -23,6 +23,20 @@ export interface GetLayerVersionPolicyCommandOutput extends GetLayerVersionPolic /** *

Returns the permission policy for a version of an AWS Lambda * layer. For more information, see AddLayerVersionPermission.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { LambdaClient, GetLayerVersionPolicyCommand } from "@aws-sdk/client-lambda"; // ES Modules import + * // const { LambdaClient, GetLayerVersionPolicyCommand } = require("@aws-sdk/client-lambda"); // CommonJS import + * const client = new LambdaClient(config); + * const command = new GetLayerVersionPolicyCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetLayerVersionPolicyCommandInput} for command's `input` shape. + * @see {@link GetLayerVersionPolicyCommandOutput} for command's `response` shape. + * @see {@link LambdaClientResolvedConfig | config} for command's `input` shape. + * */ export class GetLayerVersionPolicyCommand extends $Command< GetLayerVersionPolicyCommandInput, diff --git a/clients/client-lambda/commands/GetPolicyCommand.ts b/clients/client-lambda/commands/GetPolicyCommand.ts index 377bac1f8f87..a4831e9a48ce 100644 --- a/clients/client-lambda/commands/GetPolicyCommand.ts +++ b/clients/client-lambda/commands/GetPolicyCommand.ts @@ -22,6 +22,20 @@ export interface GetPolicyCommandOutput extends GetPolicyResponse, __MetadataBea /** *

Returns the resource-based IAM policy for a function, version, or alias.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { LambdaClient, GetPolicyCommand } from "@aws-sdk/client-lambda"; // ES Modules import + * // const { LambdaClient, GetPolicyCommand } = require("@aws-sdk/client-lambda"); // CommonJS import + * const client = new LambdaClient(config); + * const command = new GetPolicyCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetPolicyCommandInput} for command's `input` shape. + * @see {@link GetPolicyCommandOutput} for command's `response` shape. + * @see {@link LambdaClientResolvedConfig | config} for command's `input` shape. + * */ export class GetPolicyCommand extends $Command< GetPolicyCommandInput, diff --git a/clients/client-lambda/commands/GetProvisionedConcurrencyConfigCommand.ts b/clients/client-lambda/commands/GetProvisionedConcurrencyConfigCommand.ts index b617b54191be..c678458c6cff 100644 --- a/clients/client-lambda/commands/GetProvisionedConcurrencyConfigCommand.ts +++ b/clients/client-lambda/commands/GetProvisionedConcurrencyConfigCommand.ts @@ -24,6 +24,20 @@ export interface GetProvisionedConcurrencyConfigCommandOutput /** *

Retrieves the provisioned concurrency configuration for a function's alias or version.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { LambdaClient, GetProvisionedConcurrencyConfigCommand } from "@aws-sdk/client-lambda"; // ES Modules import + * // const { LambdaClient, GetProvisionedConcurrencyConfigCommand } = require("@aws-sdk/client-lambda"); // CommonJS import + * const client = new LambdaClient(config); + * const command = new GetProvisionedConcurrencyConfigCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetProvisionedConcurrencyConfigCommandInput} for command's `input` shape. + * @see {@link GetProvisionedConcurrencyConfigCommandOutput} for command's `response` shape. + * @see {@link LambdaClientResolvedConfig | config} for command's `input` shape. + * */ export class GetProvisionedConcurrencyConfigCommand extends $Command< GetProvisionedConcurrencyConfigCommandInput, diff --git a/clients/client-lambda/commands/InvokeAsyncCommand.ts b/clients/client-lambda/commands/InvokeAsyncCommand.ts index ae53ebfa96f8..316b4ed66d88 100644 --- a/clients/client-lambda/commands/InvokeAsyncCommand.ts +++ b/clients/client-lambda/commands/InvokeAsyncCommand.ts @@ -36,6 +36,20 @@ export interface InvokeAsyncCommandOutput extends InvokeAsyncResponse, __Metadat *

For asynchronous function invocation, use Invoke.

* *

Invokes a function asynchronously.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { LambdaClient, InvokeAsyncCommand } from "@aws-sdk/client-lambda"; // ES Modules import + * // const { LambdaClient, InvokeAsyncCommand } = require("@aws-sdk/client-lambda"); // CommonJS import + * const client = new LambdaClient(config); + * const command = new InvokeAsyncCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link InvokeAsyncCommandInput} for command's `input` shape. + * @see {@link InvokeAsyncCommandOutput} for command's `response` shape. + * @see {@link LambdaClientResolvedConfig | config} for command's `input` shape. + * */ export class InvokeAsyncCommand extends $Command< InvokeAsyncCommandInput, diff --git a/clients/client-lambda/commands/InvokeCommand.ts b/clients/client-lambda/commands/InvokeCommand.ts index 84f2be09f418..846d4a390cdc 100644 --- a/clients/client-lambda/commands/InvokeCommand.ts +++ b/clients/client-lambda/commands/InvokeCommand.ts @@ -45,6 +45,20 @@ export interface InvokeCommandOutput extends InvocationResponse, __MetadataBeare * connections with timeout or keep-alive settings.

* *

This operation requires permission for the lambda:InvokeFunction action.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { LambdaClient, InvokeCommand } from "@aws-sdk/client-lambda"; // ES Modules import + * // const { LambdaClient, InvokeCommand } = require("@aws-sdk/client-lambda"); // CommonJS import + * const client = new LambdaClient(config); + * const command = new InvokeCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link InvokeCommandInput} for command's `input` shape. + * @see {@link InvokeCommandOutput} for command's `response` shape. + * @see {@link LambdaClientResolvedConfig | config} for command's `input` shape. + * */ export class InvokeCommand extends $Command { // Start section: command_properties diff --git a/clients/client-lambda/commands/ListAliasesCommand.ts b/clients/client-lambda/commands/ListAliasesCommand.ts index b2d5c3ae0876..81ed7022eabe 100644 --- a/clients/client-lambda/commands/ListAliasesCommand.ts +++ b/clients/client-lambda/commands/ListAliasesCommand.ts @@ -23,6 +23,20 @@ export interface ListAliasesCommandOutput extends ListAliasesResponse, __Metadat /** *

Returns a list of aliases * for a Lambda function.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { LambdaClient, ListAliasesCommand } from "@aws-sdk/client-lambda"; // ES Modules import + * // const { LambdaClient, ListAliasesCommand } = require("@aws-sdk/client-lambda"); // CommonJS import + * const client = new LambdaClient(config); + * const command = new ListAliasesCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListAliasesCommandInput} for command's `input` shape. + * @see {@link ListAliasesCommandOutput} for command's `response` shape. + * @see {@link LambdaClientResolvedConfig | config} for command's `input` shape. + * */ export class ListAliasesCommand extends $Command< ListAliasesCommandInput, diff --git a/clients/client-lambda/commands/ListCodeSigningConfigsCommand.ts b/clients/client-lambda/commands/ListCodeSigningConfigsCommand.ts index 632dce96d22b..eb6678b96879 100644 --- a/clients/client-lambda/commands/ListCodeSigningConfigsCommand.ts +++ b/clients/client-lambda/commands/ListCodeSigningConfigsCommand.ts @@ -24,6 +24,20 @@ export interface ListCodeSigningConfigsCommandOutput extends ListCodeSigningConf *

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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { LambdaClient, ListCodeSigningConfigsCommand } from "@aws-sdk/client-lambda"; // ES Modules import + * // const { LambdaClient, ListCodeSigningConfigsCommand } = require("@aws-sdk/client-lambda"); // CommonJS import + * const client = new LambdaClient(config); + * const command = new ListCodeSigningConfigsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListCodeSigningConfigsCommandInput} for command's `input` shape. + * @see {@link ListCodeSigningConfigsCommandOutput} for command's `response` shape. + * @see {@link LambdaClientResolvedConfig | config} for command's `input` shape. + * */ export class ListCodeSigningConfigsCommand extends $Command< ListCodeSigningConfigsCommandInput, diff --git a/clients/client-lambda/commands/ListEventSourceMappingsCommand.ts b/clients/client-lambda/commands/ListEventSourceMappingsCommand.ts index 136a01ffe13f..c8bd85d0d491 100644 --- a/clients/client-lambda/commands/ListEventSourceMappingsCommand.ts +++ b/clients/client-lambda/commands/ListEventSourceMappingsCommand.ts @@ -23,6 +23,20 @@ export interface ListEventSourceMappingsCommandOutput extends ListEventSourceMap /** *

Lists event source mappings. Specify an EventSourceArn to only show event source mappings for a * single event source.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { LambdaClient, ListEventSourceMappingsCommand } from "@aws-sdk/client-lambda"; // ES Modules import + * // const { LambdaClient, ListEventSourceMappingsCommand } = require("@aws-sdk/client-lambda"); // CommonJS import + * const client = new LambdaClient(config); + * const command = new ListEventSourceMappingsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListEventSourceMappingsCommandInput} for command's `input` shape. + * @see {@link ListEventSourceMappingsCommandOutput} for command's `response` shape. + * @see {@link LambdaClientResolvedConfig | config} for command's `input` shape. + * */ export class ListEventSourceMappingsCommand extends $Command< ListEventSourceMappingsCommandInput, diff --git a/clients/client-lambda/commands/ListFunctionEventInvokeConfigsCommand.ts b/clients/client-lambda/commands/ListFunctionEventInvokeConfigsCommand.ts index 5b7fe84a4417..ca63fd1c65f2 100644 --- a/clients/client-lambda/commands/ListFunctionEventInvokeConfigsCommand.ts +++ b/clients/client-lambda/commands/ListFunctionEventInvokeConfigsCommand.ts @@ -25,6 +25,20 @@ export interface ListFunctionEventInvokeConfigsCommandOutput /** *

Retrieves a list of configurations for asynchronous invocation for a function.

*

To configure options for asynchronous invocation, use PutFunctionEventInvokeConfig.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { LambdaClient, ListFunctionEventInvokeConfigsCommand } from "@aws-sdk/client-lambda"; // ES Modules import + * // const { LambdaClient, ListFunctionEventInvokeConfigsCommand } = require("@aws-sdk/client-lambda"); // CommonJS import + * const client = new LambdaClient(config); + * const command = new ListFunctionEventInvokeConfigsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListFunctionEventInvokeConfigsCommandInput} for command's `input` shape. + * @see {@link ListFunctionEventInvokeConfigsCommandOutput} for command's `response` shape. + * @see {@link LambdaClientResolvedConfig | config} for command's `input` shape. + * */ export class ListFunctionEventInvokeConfigsCommand extends $Command< ListFunctionEventInvokeConfigsCommandInput, diff --git a/clients/client-lambda/commands/ListFunctionsByCodeSigningConfigCommand.ts b/clients/client-lambda/commands/ListFunctionsByCodeSigningConfigCommand.ts index e4d30b0dff04..96d19f8c3b02 100644 --- a/clients/client-lambda/commands/ListFunctionsByCodeSigningConfigCommand.ts +++ b/clients/client-lambda/commands/ListFunctionsByCodeSigningConfigCommand.ts @@ -25,6 +25,20 @@ export interface ListFunctionsByCodeSigningConfigCommandOutput /** *

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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { LambdaClient, ListFunctionsByCodeSigningConfigCommand } from "@aws-sdk/client-lambda"; // ES Modules import + * // const { LambdaClient, ListFunctionsByCodeSigningConfigCommand } = require("@aws-sdk/client-lambda"); // CommonJS import + * const client = new LambdaClient(config); + * const command = new ListFunctionsByCodeSigningConfigCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListFunctionsByCodeSigningConfigCommandInput} for command's `input` shape. + * @see {@link ListFunctionsByCodeSigningConfigCommandOutput} for command's `response` shape. + * @see {@link LambdaClientResolvedConfig | config} for command's `input` shape. + * */ export class ListFunctionsByCodeSigningConfigCommand extends $Command< ListFunctionsByCodeSigningConfigCommandInput, diff --git a/clients/client-lambda/commands/ListFunctionsCommand.ts b/clients/client-lambda/commands/ListFunctionsCommand.ts index 4767bc990ed7..22d0d9a46ad8 100644 --- a/clients/client-lambda/commands/ListFunctionsCommand.ts +++ b/clients/client-lambda/commands/ListFunctionsCommand.ts @@ -30,6 +30,20 @@ export interface ListFunctionsCommandOutput extends ListFunctionsResponse, __Met * To get the additional fields (State, StateReasonCode, StateReason, LastUpdateStatus, LastUpdateStatusReason, LastUpdateStatusReasonCode) * for a function or version, use GetFunction.

* + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { LambdaClient, ListFunctionsCommand } from "@aws-sdk/client-lambda"; // ES Modules import + * // const { LambdaClient, ListFunctionsCommand } = require("@aws-sdk/client-lambda"); // CommonJS import + * const client = new LambdaClient(config); + * const command = new ListFunctionsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListFunctionsCommandInput} for command's `input` shape. + * @see {@link ListFunctionsCommandOutput} for command's `response` shape. + * @see {@link LambdaClientResolvedConfig | config} for command's `input` shape. + * */ export class ListFunctionsCommand extends $Command< ListFunctionsCommandInput, diff --git a/clients/client-lambda/commands/ListLayerVersionsCommand.ts b/clients/client-lambda/commands/ListLayerVersionsCommand.ts index 0b8786508df8..7383ab230823 100644 --- a/clients/client-lambda/commands/ListLayerVersionsCommand.ts +++ b/clients/client-lambda/commands/ListLayerVersionsCommand.ts @@ -24,6 +24,20 @@ export interface ListLayerVersionsCommandOutput extends ListLayerVersionsRespons *

Lists the versions of an AWS 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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { LambdaClient, ListLayerVersionsCommand } from "@aws-sdk/client-lambda"; // ES Modules import + * // const { LambdaClient, ListLayerVersionsCommand } = require("@aws-sdk/client-lambda"); // CommonJS import + * const client = new LambdaClient(config); + * const command = new ListLayerVersionsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListLayerVersionsCommandInput} for command's `input` shape. + * @see {@link ListLayerVersionsCommandOutput} for command's `response` shape. + * @see {@link LambdaClientResolvedConfig | config} for command's `input` shape. + * */ export class ListLayerVersionsCommand extends $Command< ListLayerVersionsCommandInput, diff --git a/clients/client-lambda/commands/ListLayersCommand.ts b/clients/client-lambda/commands/ListLayersCommand.ts index c6ff95564448..de3e0b4716f0 100644 --- a/clients/client-lambda/commands/ListLayersCommand.ts +++ b/clients/client-lambda/commands/ListLayersCommand.ts @@ -24,6 +24,20 @@ export interface ListLayersCommandOutput extends ListLayersResponse, __MetadataB *

Lists AWS 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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { LambdaClient, ListLayersCommand } from "@aws-sdk/client-lambda"; // ES Modules import + * // const { LambdaClient, ListLayersCommand } = require("@aws-sdk/client-lambda"); // CommonJS import + * const client = new LambdaClient(config); + * const command = new ListLayersCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListLayersCommandInput} for command's `input` shape. + * @see {@link ListLayersCommandOutput} for command's `response` shape. + * @see {@link LambdaClientResolvedConfig | config} for command's `input` shape. + * */ export class ListLayersCommand extends $Command< ListLayersCommandInput, diff --git a/clients/client-lambda/commands/ListProvisionedConcurrencyConfigsCommand.ts b/clients/client-lambda/commands/ListProvisionedConcurrencyConfigsCommand.ts index 9d8d68454937..4312d2fc62bf 100644 --- a/clients/client-lambda/commands/ListProvisionedConcurrencyConfigsCommand.ts +++ b/clients/client-lambda/commands/ListProvisionedConcurrencyConfigsCommand.ts @@ -27,6 +27,20 @@ export interface ListProvisionedConcurrencyConfigsCommandOutput /** *

Retrieves a list of provisioned concurrency configurations for a function.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { LambdaClient, ListProvisionedConcurrencyConfigsCommand } from "@aws-sdk/client-lambda"; // ES Modules import + * // const { LambdaClient, ListProvisionedConcurrencyConfigsCommand } = require("@aws-sdk/client-lambda"); // CommonJS import + * const client = new LambdaClient(config); + * const command = new ListProvisionedConcurrencyConfigsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListProvisionedConcurrencyConfigsCommandInput} for command's `input` shape. + * @see {@link ListProvisionedConcurrencyConfigsCommandOutput} for command's `response` shape. + * @see {@link LambdaClientResolvedConfig | config} for command's `input` shape. + * */ export class ListProvisionedConcurrencyConfigsCommand extends $Command< ListProvisionedConcurrencyConfigsCommandInput, diff --git a/clients/client-lambda/commands/ListTagsCommand.ts b/clients/client-lambda/commands/ListTagsCommand.ts index a2f02dcadae5..55c17bba68ac 100644 --- a/clients/client-lambda/commands/ListTagsCommand.ts +++ b/clients/client-lambda/commands/ListTagsCommand.ts @@ -23,6 +23,20 @@ export interface ListTagsCommandOutput extends ListTagsResponse, __MetadataBeare /** *

Returns a function's tags. You can * also view tags with GetFunction.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { LambdaClient, ListTagsCommand } from "@aws-sdk/client-lambda"; // ES Modules import + * // const { LambdaClient, ListTagsCommand } = require("@aws-sdk/client-lambda"); // CommonJS import + * const client = new LambdaClient(config); + * const command = new ListTagsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListTagsCommandInput} for command's `input` shape. + * @see {@link ListTagsCommandOutput} for command's `response` shape. + * @see {@link LambdaClientResolvedConfig | config} for command's `input` shape. + * */ export class ListTagsCommand extends $Command { // Start section: command_properties diff --git a/clients/client-lambda/commands/ListVersionsByFunctionCommand.ts b/clients/client-lambda/commands/ListVersionsByFunctionCommand.ts index 0fa70c116fb8..c4a69878d41e 100644 --- a/clients/client-lambda/commands/ListVersionsByFunctionCommand.ts +++ b/clients/client-lambda/commands/ListVersionsByFunctionCommand.ts @@ -23,6 +23,20 @@ export interface ListVersionsByFunctionCommandOutput extends ListVersionsByFunct /** *

Returns a list of versions, * with the version-specific configuration of each. Lambda returns up to 50 versions per call.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { LambdaClient, ListVersionsByFunctionCommand } from "@aws-sdk/client-lambda"; // ES Modules import + * // const { LambdaClient, ListVersionsByFunctionCommand } = require("@aws-sdk/client-lambda"); // CommonJS import + * const client = new LambdaClient(config); + * const command = new ListVersionsByFunctionCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListVersionsByFunctionCommandInput} for command's `input` shape. + * @see {@link ListVersionsByFunctionCommandOutput} for command's `response` shape. + * @see {@link LambdaClientResolvedConfig | config} for command's `input` shape. + * */ export class ListVersionsByFunctionCommand extends $Command< ListVersionsByFunctionCommandInput, diff --git a/clients/client-lambda/commands/PublishLayerVersionCommand.ts b/clients/client-lambda/commands/PublishLayerVersionCommand.ts index d52c90caab19..b9721c0741cb 100644 --- a/clients/client-lambda/commands/PublishLayerVersionCommand.ts +++ b/clients/client-lambda/commands/PublishLayerVersionCommand.ts @@ -25,6 +25,20 @@ export interface PublishLayerVersionCommandOutput extends PublishLayerVersionRes * 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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { LambdaClient, PublishLayerVersionCommand } from "@aws-sdk/client-lambda"; // ES Modules import + * // const { LambdaClient, PublishLayerVersionCommand } = require("@aws-sdk/client-lambda"); // CommonJS import + * const client = new LambdaClient(config); + * const command = new PublishLayerVersionCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link PublishLayerVersionCommandInput} for command's `input` shape. + * @see {@link PublishLayerVersionCommandOutput} for command's `response` shape. + * @see {@link LambdaClientResolvedConfig | config} for command's `input` shape. + * */ export class PublishLayerVersionCommand extends $Command< PublishLayerVersionCommandInput, diff --git a/clients/client-lambda/commands/PublishVersionCommand.ts b/clients/client-lambda/commands/PublishVersionCommand.ts index da328063f69b..732c678bd5e2 100644 --- a/clients/client-lambda/commands/PublishVersionCommand.ts +++ b/clients/client-lambda/commands/PublishVersionCommand.ts @@ -30,6 +30,20 @@ export interface PublishVersionCommandOutput extends FunctionConfiguration, __Me * function before publishing a version.

* *

Clients can invoke versions directly or with an alias. To create an alias, use CreateAlias.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { LambdaClient, PublishVersionCommand } from "@aws-sdk/client-lambda"; // ES Modules import + * // const { LambdaClient, PublishVersionCommand } = require("@aws-sdk/client-lambda"); // CommonJS import + * const client = new LambdaClient(config); + * const command = new PublishVersionCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link PublishVersionCommandInput} for command's `input` shape. + * @see {@link PublishVersionCommandOutput} for command's `response` shape. + * @see {@link LambdaClientResolvedConfig | config} for command's `input` shape. + * */ export class PublishVersionCommand extends $Command< PublishVersionCommandInput, diff --git a/clients/client-lambda/commands/PutFunctionCodeSigningConfigCommand.ts b/clients/client-lambda/commands/PutFunctionCodeSigningConfigCommand.ts index d3f2360f7ba9..9594151a15af 100644 --- a/clients/client-lambda/commands/PutFunctionCodeSigningConfigCommand.ts +++ b/clients/client-lambda/commands/PutFunctionCodeSigningConfigCommand.ts @@ -25,6 +25,20 @@ export interface PutFunctionCodeSigningConfigCommandOutput /** *

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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { LambdaClient, PutFunctionCodeSigningConfigCommand } from "@aws-sdk/client-lambda"; // ES Modules import + * // const { LambdaClient, PutFunctionCodeSigningConfigCommand } = require("@aws-sdk/client-lambda"); // CommonJS import + * const client = new LambdaClient(config); + * const command = new PutFunctionCodeSigningConfigCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link PutFunctionCodeSigningConfigCommandInput} for command's `input` shape. + * @see {@link PutFunctionCodeSigningConfigCommandOutput} for command's `response` shape. + * @see {@link LambdaClientResolvedConfig | config} for command's `input` shape. + * */ export class PutFunctionCodeSigningConfigCommand extends $Command< PutFunctionCodeSigningConfigCommandInput, diff --git a/clients/client-lambda/commands/PutFunctionConcurrencyCommand.ts b/clients/client-lambda/commands/PutFunctionConcurrencyCommand.ts index a520846982a9..cb96f4263f83 100644 --- a/clients/client-lambda/commands/PutFunctionConcurrencyCommand.ts +++ b/clients/client-lambda/commands/PutFunctionConcurrencyCommand.ts @@ -30,6 +30,20 @@ export interface PutFunctionConcurrencyCommandOutput extends Concurrency, __Meta *

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 Managing Concurrency.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { LambdaClient, PutFunctionConcurrencyCommand } from "@aws-sdk/client-lambda"; // ES Modules import + * // const { LambdaClient, PutFunctionConcurrencyCommand } = require("@aws-sdk/client-lambda"); // CommonJS import + * const client = new LambdaClient(config); + * const command = new PutFunctionConcurrencyCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link PutFunctionConcurrencyCommandInput} for command's `input` shape. + * @see {@link PutFunctionConcurrencyCommandOutput} for command's `response` shape. + * @see {@link LambdaClientResolvedConfig | config} for command's `input` shape. + * */ export class PutFunctionConcurrencyCommand extends $Command< PutFunctionConcurrencyCommandInput, diff --git a/clients/client-lambda/commands/PutFunctionEventInvokeConfigCommand.ts b/clients/client-lambda/commands/PutFunctionEventInvokeConfigCommand.ts index 9f07d69eff94..37c1acfe46a9 100644 --- a/clients/client-lambda/commands/PutFunctionEventInvokeConfigCommand.ts +++ b/clients/client-lambda/commands/PutFunctionEventInvokeConfigCommand.ts @@ -32,6 +32,20 @@ export interface PutFunctionEventInvokeConfigCommandOutput extends FunctionEvent *

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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { LambdaClient, PutFunctionEventInvokeConfigCommand } from "@aws-sdk/client-lambda"; // ES Modules import + * // const { LambdaClient, PutFunctionEventInvokeConfigCommand } = require("@aws-sdk/client-lambda"); // CommonJS import + * const client = new LambdaClient(config); + * const command = new PutFunctionEventInvokeConfigCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link PutFunctionEventInvokeConfigCommandInput} for command's `input` shape. + * @see {@link PutFunctionEventInvokeConfigCommandOutput} for command's `response` shape. + * @see {@link LambdaClientResolvedConfig | config} for command's `input` shape. + * */ export class PutFunctionEventInvokeConfigCommand extends $Command< PutFunctionEventInvokeConfigCommandInput, diff --git a/clients/client-lambda/commands/PutProvisionedConcurrencyConfigCommand.ts b/clients/client-lambda/commands/PutProvisionedConcurrencyConfigCommand.ts index 8b407b2a507a..9fc523882c17 100644 --- a/clients/client-lambda/commands/PutProvisionedConcurrencyConfigCommand.ts +++ b/clients/client-lambda/commands/PutProvisionedConcurrencyConfigCommand.ts @@ -24,6 +24,20 @@ export interface PutProvisionedConcurrencyConfigCommandOutput /** *

Adds a provisioned concurrency configuration to a function's alias or version.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { LambdaClient, PutProvisionedConcurrencyConfigCommand } from "@aws-sdk/client-lambda"; // ES Modules import + * // const { LambdaClient, PutProvisionedConcurrencyConfigCommand } = require("@aws-sdk/client-lambda"); // CommonJS import + * const client = new LambdaClient(config); + * const command = new PutProvisionedConcurrencyConfigCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link PutProvisionedConcurrencyConfigCommandInput} for command's `input` shape. + * @see {@link PutProvisionedConcurrencyConfigCommandOutput} for command's `response` shape. + * @see {@link LambdaClientResolvedConfig | config} for command's `input` shape. + * */ export class PutProvisionedConcurrencyConfigCommand extends $Command< PutProvisionedConcurrencyConfigCommandInput, diff --git a/clients/client-lambda/commands/RemoveLayerVersionPermissionCommand.ts b/clients/client-lambda/commands/RemoveLayerVersionPermissionCommand.ts index 8b20fd8ce11c..551ddc3e980b 100644 --- a/clients/client-lambda/commands/RemoveLayerVersionPermissionCommand.ts +++ b/clients/client-lambda/commands/RemoveLayerVersionPermissionCommand.ts @@ -24,6 +24,20 @@ export interface RemoveLayerVersionPermissionCommandOutput extends __MetadataBea *

Removes a statement from the permissions policy for a version of an AWS Lambda * layer. For more information, see * AddLayerVersionPermission.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { LambdaClient, RemoveLayerVersionPermissionCommand } from "@aws-sdk/client-lambda"; // ES Modules import + * // const { LambdaClient, RemoveLayerVersionPermissionCommand } = require("@aws-sdk/client-lambda"); // CommonJS import + * const client = new LambdaClient(config); + * const command = new RemoveLayerVersionPermissionCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link RemoveLayerVersionPermissionCommandInput} for command's `input` shape. + * @see {@link RemoveLayerVersionPermissionCommandOutput} for command's `response` shape. + * @see {@link LambdaClientResolvedConfig | config} for command's `input` shape. + * */ export class RemoveLayerVersionPermissionCommand extends $Command< RemoveLayerVersionPermissionCommandInput, diff --git a/clients/client-lambda/commands/RemovePermissionCommand.ts b/clients/client-lambda/commands/RemovePermissionCommand.ts index aabd45170f40..d98d12f757f5 100644 --- a/clients/client-lambda/commands/RemovePermissionCommand.ts +++ b/clients/client-lambda/commands/RemovePermissionCommand.ts @@ -23,6 +23,20 @@ export interface RemovePermissionCommandOutput extends __MetadataBearer {} /** *

Revokes function-use permission from an AWS service or another account. You can get the ID of the statement * from the output of GetPolicy.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { LambdaClient, RemovePermissionCommand } from "@aws-sdk/client-lambda"; // ES Modules import + * // const { LambdaClient, RemovePermissionCommand } = require("@aws-sdk/client-lambda"); // CommonJS import + * const client = new LambdaClient(config); + * const command = new RemovePermissionCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link RemovePermissionCommandInput} for command's `input` shape. + * @see {@link RemovePermissionCommandOutput} for command's `response` shape. + * @see {@link LambdaClientResolvedConfig | config} for command's `input` shape. + * */ export class RemovePermissionCommand extends $Command< RemovePermissionCommandInput, diff --git a/clients/client-lambda/commands/TagResourceCommand.ts b/clients/client-lambda/commands/TagResourceCommand.ts index c6d132251c1f..a1a6a0057837 100644 --- a/clients/client-lambda/commands/TagResourceCommand.ts +++ b/clients/client-lambda/commands/TagResourceCommand.ts @@ -22,6 +22,20 @@ export interface TagResourceCommandOutput extends __MetadataBearer {} /** *

Adds tags to a function.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { LambdaClient, TagResourceCommand } from "@aws-sdk/client-lambda"; // ES Modules import + * // const { LambdaClient, TagResourceCommand } = require("@aws-sdk/client-lambda"); // CommonJS import + * const client = new LambdaClient(config); + * const command = new TagResourceCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link TagResourceCommandInput} for command's `input` shape. + * @see {@link TagResourceCommandOutput} for command's `response` shape. + * @see {@link LambdaClientResolvedConfig | config} for command's `input` shape. + * */ export class TagResourceCommand extends $Command< TagResourceCommandInput, diff --git a/clients/client-lambda/commands/UntagResourceCommand.ts b/clients/client-lambda/commands/UntagResourceCommand.ts index 91a30a39f7cb..25621c8bcf7b 100644 --- a/clients/client-lambda/commands/UntagResourceCommand.ts +++ b/clients/client-lambda/commands/UntagResourceCommand.ts @@ -22,6 +22,20 @@ export interface UntagResourceCommandOutput extends __MetadataBearer {} /** *

Removes tags from a function.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { LambdaClient, UntagResourceCommand } from "@aws-sdk/client-lambda"; // ES Modules import + * // const { LambdaClient, UntagResourceCommand } = require("@aws-sdk/client-lambda"); // CommonJS import + * const client = new LambdaClient(config); + * const command = new UntagResourceCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link UntagResourceCommandInput} for command's `input` shape. + * @see {@link UntagResourceCommandOutput} for command's `response` shape. + * @see {@link LambdaClientResolvedConfig | config} for command's `input` shape. + * */ export class UntagResourceCommand extends $Command< UntagResourceCommandInput, diff --git a/clients/client-lambda/commands/UpdateAliasCommand.ts b/clients/client-lambda/commands/UpdateAliasCommand.ts index d7f35a32250e..374fa6b5506f 100644 --- a/clients/client-lambda/commands/UpdateAliasCommand.ts +++ b/clients/client-lambda/commands/UpdateAliasCommand.ts @@ -22,6 +22,20 @@ export interface UpdateAliasCommandOutput extends AliasConfiguration, __Metadata /** *

Updates the configuration of a Lambda function alias.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { LambdaClient, UpdateAliasCommand } from "@aws-sdk/client-lambda"; // ES Modules import + * // const { LambdaClient, UpdateAliasCommand } = require("@aws-sdk/client-lambda"); // CommonJS import + * const client = new LambdaClient(config); + * const command = new UpdateAliasCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link UpdateAliasCommandInput} for command's `input` shape. + * @see {@link UpdateAliasCommandOutput} for command's `response` shape. + * @see {@link LambdaClientResolvedConfig | config} for command's `input` shape. + * */ export class UpdateAliasCommand extends $Command< UpdateAliasCommandInput, diff --git a/clients/client-lambda/commands/UpdateCodeSigningConfigCommand.ts b/clients/client-lambda/commands/UpdateCodeSigningConfigCommand.ts index d90d42113a5e..1cb2a6b74924 100644 --- a/clients/client-lambda/commands/UpdateCodeSigningConfigCommand.ts +++ b/clients/client-lambda/commands/UpdateCodeSigningConfigCommand.ts @@ -23,6 +23,20 @@ export interface UpdateCodeSigningConfigCommandOutput extends UpdateCodeSigningC /** *

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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { LambdaClient, UpdateCodeSigningConfigCommand } from "@aws-sdk/client-lambda"; // ES Modules import + * // const { LambdaClient, UpdateCodeSigningConfigCommand } = require("@aws-sdk/client-lambda"); // CommonJS import + * const client = new LambdaClient(config); + * const command = new UpdateCodeSigningConfigCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link UpdateCodeSigningConfigCommandInput} for command's `input` shape. + * @see {@link UpdateCodeSigningConfigCommandOutput} for command's `response` shape. + * @see {@link LambdaClientResolvedConfig | config} for command's `input` shape. + * */ export class UpdateCodeSigningConfigCommand extends $Command< UpdateCodeSigningConfigCommandInput, diff --git a/clients/client-lambda/commands/UpdateEventSourceMappingCommand.ts b/clients/client-lambda/commands/UpdateEventSourceMappingCommand.ts index 558d3989a5f6..6021fc4ff867 100644 --- a/clients/client-lambda/commands/UpdateEventSourceMappingCommand.ts +++ b/clients/client-lambda/commands/UpdateEventSourceMappingCommand.ts @@ -45,6 +45,20 @@ export interface UpdateEventSourceMappingCommandOutput extends EventSourceMappin * ParallelizationFactor - Process multiple batches from each shard concurrently.

* * + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { LambdaClient, UpdateEventSourceMappingCommand } from "@aws-sdk/client-lambda"; // ES Modules import + * // const { LambdaClient, UpdateEventSourceMappingCommand } = require("@aws-sdk/client-lambda"); // CommonJS import + * const client = new LambdaClient(config); + * const command = new UpdateEventSourceMappingCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link UpdateEventSourceMappingCommandInput} for command's `input` shape. + * @see {@link UpdateEventSourceMappingCommandOutput} for command's `response` shape. + * @see {@link LambdaClientResolvedConfig | config} for command's `input` shape. + * */ export class UpdateEventSourceMappingCommand extends $Command< UpdateEventSourceMappingCommandInput, diff --git a/clients/client-lambda/commands/UpdateFunctionCodeCommand.ts b/clients/client-lambda/commands/UpdateFunctionCodeCommand.ts index a9f93f2895d6..803d2342e500 100644 --- a/clients/client-lambda/commands/UpdateFunctionCodeCommand.ts +++ b/clients/client-lambda/commands/UpdateFunctionCodeCommand.ts @@ -30,6 +30,20 @@ export interface UpdateFunctionCodeCommandOutput extends FunctionConfiguration, *

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.

* + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { LambdaClient, UpdateFunctionCodeCommand } from "@aws-sdk/client-lambda"; // ES Modules import + * // const { LambdaClient, UpdateFunctionCodeCommand } = require("@aws-sdk/client-lambda"); // CommonJS import + * const client = new LambdaClient(config); + * const command = new UpdateFunctionCodeCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link UpdateFunctionCodeCommandInput} for command's `input` shape. + * @see {@link UpdateFunctionCodeCommandOutput} for command's `response` shape. + * @see {@link LambdaClientResolvedConfig | config} for command's `input` shape. + * */ export class UpdateFunctionCodeCommand extends $Command< UpdateFunctionCodeCommandInput, diff --git a/clients/client-lambda/commands/UpdateFunctionConfigurationCommand.ts b/clients/client-lambda/commands/UpdateFunctionConfigurationCommand.ts index 6a467494e214..0e7b56cbdc9a 100644 --- a/clients/client-lambda/commands/UpdateFunctionConfigurationCommand.ts +++ b/clients/client-lambda/commands/UpdateFunctionConfigurationCommand.ts @@ -36,6 +36,20 @@ export interface UpdateFunctionConfigurationCommandOutput extends FunctionConfig * *

To configure function concurrency, use PutFunctionConcurrency. To grant invoke permissions * to an account or AWS service, use AddPermission.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { LambdaClient, UpdateFunctionConfigurationCommand } from "@aws-sdk/client-lambda"; // ES Modules import + * // const { LambdaClient, UpdateFunctionConfigurationCommand } = require("@aws-sdk/client-lambda"); // CommonJS import + * const client = new LambdaClient(config); + * const command = new UpdateFunctionConfigurationCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link UpdateFunctionConfigurationCommandInput} for command's `input` shape. + * @see {@link UpdateFunctionConfigurationCommandOutput} for command's `response` shape. + * @see {@link LambdaClientResolvedConfig | config} for command's `input` shape. + * */ export class UpdateFunctionConfigurationCommand extends $Command< UpdateFunctionConfigurationCommandInput, diff --git a/clients/client-lambda/commands/UpdateFunctionEventInvokeConfigCommand.ts b/clients/client-lambda/commands/UpdateFunctionEventInvokeConfigCommand.ts index 520b6fa7f36d..b2511ec4a367 100644 --- a/clients/client-lambda/commands/UpdateFunctionEventInvokeConfigCommand.ts +++ b/clients/client-lambda/commands/UpdateFunctionEventInvokeConfigCommand.ts @@ -23,6 +23,20 @@ export interface UpdateFunctionEventInvokeConfigCommandOutput extends FunctionEv /** *

Updates the configuration for asynchronous invocation for a function, version, or alias.

*

To configure options for asynchronous invocation, use PutFunctionEventInvokeConfig.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { LambdaClient, UpdateFunctionEventInvokeConfigCommand } from "@aws-sdk/client-lambda"; // ES Modules import + * // const { LambdaClient, UpdateFunctionEventInvokeConfigCommand } = require("@aws-sdk/client-lambda"); // CommonJS import + * const client = new LambdaClient(config); + * const command = new UpdateFunctionEventInvokeConfigCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link UpdateFunctionEventInvokeConfigCommandInput} for command's `input` shape. + * @see {@link UpdateFunctionEventInvokeConfigCommandOutput} for command's `response` shape. + * @see {@link LambdaClientResolvedConfig | config} for command's `input` shape. + * */ export class UpdateFunctionEventInvokeConfigCommand extends $Command< UpdateFunctionEventInvokeConfigCommandInput, diff --git a/clients/client-lambda/models/models_0.ts b/clients/client-lambda/models/models_0.ts index c2430e5c848b..b659190fa88d 100644 --- a/clients/client-lambda/models/models_0.ts +++ b/clients/client-lambda/models/models_0.ts @@ -35,6 +35,9 @@ export interface AccountLimit { } export namespace AccountLimit { + /** + * @internal + */ export const filterSensitiveLog = (obj: AccountLimit): any => ({ ...obj, }); @@ -56,6 +59,9 @@ export interface AccountUsage { } export namespace AccountUsage { + /** + * @internal + */ export const filterSensitiveLog = (obj: AccountUsage): any => ({ ...obj, }); @@ -101,6 +107,9 @@ export interface AddLayerVersionPermissionRequest { } export namespace AddLayerVersionPermissionRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: AddLayerVersionPermissionRequest): any => ({ ...obj, }); @@ -119,6 +128,9 @@ export interface AddLayerVersionPermissionResponse { } export namespace AddLayerVersionPermissionResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: AddLayerVersionPermissionResponse): any => ({ ...obj, }); @@ -142,6 +154,9 @@ export interface InvalidParameterValueException extends __SmithyException, $Meta } export namespace InvalidParameterValueException { + /** + * @internal + */ export const filterSensitiveLog = (obj: InvalidParameterValueException): any => ({ ...obj, }); @@ -159,6 +174,9 @@ export interface PolicyLengthExceededException extends __SmithyException, $Metad } export namespace PolicyLengthExceededException { + /** + * @internal + */ export const filterSensitiveLog = (obj: PolicyLengthExceededException): any => ({ ...obj, }); @@ -184,6 +202,9 @@ export interface PreconditionFailedException extends __SmithyException, $Metadat } export namespace PreconditionFailedException { + /** + * @internal + */ export const filterSensitiveLog = (obj: PreconditionFailedException): any => ({ ...obj, }); @@ -207,6 +228,9 @@ export interface ResourceConflictException extends __SmithyException, $MetadataB } export namespace ResourceConflictException { + /** + * @internal + */ export const filterSensitiveLog = (obj: ResourceConflictException): any => ({ ...obj, }); @@ -223,6 +247,9 @@ export interface ResourceNotFoundException extends __SmithyException, $MetadataB } export namespace ResourceNotFoundException { + /** + * @internal + */ export const filterSensitiveLog = (obj: ResourceNotFoundException): any => ({ ...obj, }); @@ -239,6 +266,9 @@ export interface ServiceException extends __SmithyException, $MetadataBearer { } export namespace ServiceException { + /** + * @internal + */ export const filterSensitiveLog = (obj: ServiceException): any => ({ ...obj, }); @@ -269,6 +299,9 @@ export interface TooManyRequestsException extends __SmithyException, $MetadataBe } export namespace TooManyRequestsException { + /** + * @internal + */ export const filterSensitiveLog = (obj: TooManyRequestsException): any => ({ ...obj, }); @@ -347,6 +380,9 @@ export interface AddPermissionRequest { } export namespace AddPermissionRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: AddPermissionRequest): any => ({ ...obj, }); @@ -360,6 +396,9 @@ export interface AddPermissionResponse { } export namespace AddPermissionResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: AddPermissionResponse): any => ({ ...obj, }); @@ -376,6 +415,9 @@ export interface AliasRoutingConfiguration { } export namespace AliasRoutingConfiguration { + /** + * @internal + */ export const filterSensitiveLog = (obj: AliasRoutingConfiguration): any => ({ ...obj, }); @@ -418,6 +460,9 @@ export interface AliasConfiguration { } export namespace AliasConfiguration { + /** + * @internal + */ export const filterSensitiveLog = (obj: AliasConfiguration): any => ({ ...obj, }); @@ -435,6 +480,9 @@ export interface AllowedPublishers { } export namespace AllowedPublishers { + /** + * @internal + */ export const filterSensitiveLog = (obj: AllowedPublishers): any => ({ ...obj, }); @@ -488,6 +536,9 @@ export interface CreateAliasRequest { } export namespace CreateAliasRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateAliasRequest): any => ({ ...obj, }); @@ -514,6 +565,9 @@ export interface CodeSigningPolicies { } export namespace CodeSigningPolicies { + /** + * @internal + */ export const filterSensitiveLog = (obj: CodeSigningPolicies): any => ({ ...obj, }); @@ -537,6 +591,9 @@ export interface CreateCodeSigningConfigRequest { } export namespace CreateCodeSigningConfigRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateCodeSigningConfigRequest): any => ({ ...obj, }); @@ -578,6 +635,9 @@ export interface CodeSigningConfig { } export namespace CodeSigningConfig { + /** + * @internal + */ export const filterSensitiveLog = (obj: CodeSigningConfig): any => ({ ...obj, }); @@ -591,6 +651,9 @@ export interface CreateCodeSigningConfigResponse { } export namespace CreateCodeSigningConfigResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateCodeSigningConfigResponse): any => ({ ...obj, }); @@ -607,6 +670,9 @@ export interface OnFailure { } export namespace OnFailure { + /** + * @internal + */ export const filterSensitiveLog = (obj: OnFailure): any => ({ ...obj, }); @@ -623,6 +689,9 @@ export interface OnSuccess { } export namespace OnSuccess { + /** + * @internal + */ export const filterSensitiveLog = (obj: OnSuccess): any => ({ ...obj, }); @@ -644,6 +713,9 @@ export interface DestinationConfig { } export namespace DestinationConfig { + /** + * @internal + */ export const filterSensitiveLog = (obj: DestinationConfig): any => ({ ...obj, }); @@ -668,6 +740,9 @@ export interface SelfManagedEventSource { } export namespace SelfManagedEventSource { + /** + * @internal + */ export const filterSensitiveLog = (obj: SelfManagedEventSource): any => ({ ...obj, }); @@ -719,6 +794,9 @@ export interface SourceAccessConfiguration { } export namespace SourceAccessConfiguration { + /** + * @internal + */ export const filterSensitiveLog = (obj: SourceAccessConfiguration): any => ({ ...obj, }); @@ -890,6 +968,9 @@ export interface CreateEventSourceMappingRequest { } export namespace CreateEventSourceMappingRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateEventSourceMappingRequest): any => ({ ...obj, }); @@ -1018,6 +1099,9 @@ export interface EventSourceMappingConfiguration { } export namespace EventSourceMappingConfiguration { + /** + * @internal + */ export const filterSensitiveLog = (obj: EventSourceMappingConfiguration): any => ({ ...obj, }); @@ -1034,6 +1118,9 @@ export interface CodeSigningConfigNotFoundException extends __SmithyException, $ } export namespace CodeSigningConfigNotFoundException { + /** + * @internal + */ export const filterSensitiveLog = (obj: CodeSigningConfigNotFoundException): any => ({ ...obj, }); @@ -1055,6 +1142,9 @@ export interface CodeStorageExceededException extends __SmithyException, $Metada } export namespace CodeStorageExceededException { + /** + * @internal + */ export const filterSensitiveLog = (obj: CodeStorageExceededException): any => ({ ...obj, }); @@ -1072,6 +1162,9 @@ export interface CodeVerificationFailedException extends __SmithyException, $Met } export namespace CodeVerificationFailedException { + /** + * @internal + */ export const filterSensitiveLog = (obj: CodeVerificationFailedException): any => ({ ...obj, }); @@ -1110,6 +1203,9 @@ export interface FunctionCode { } export namespace FunctionCode { + /** + * @internal + */ export const filterSensitiveLog = (obj: FunctionCode): any => ({ ...obj, ...(obj.ZipFile && { ZipFile: SENSITIVE_STRING }), @@ -1128,6 +1224,9 @@ export interface DeadLetterConfig { } export namespace DeadLetterConfig { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeadLetterConfig): any => ({ ...obj, }); @@ -1144,6 +1243,9 @@ export interface Environment { } export namespace Environment { + /** + * @internal + */ export const filterSensitiveLog = (obj: Environment): any => ({ ...obj, ...(obj.Variables && { Variables: SENSITIVE_STRING }), @@ -1166,6 +1268,9 @@ export interface FileSystemConfig { } export namespace FileSystemConfig { + /** + * @internal + */ export const filterSensitiveLog = (obj: FileSystemConfig): any => ({ ...obj, }); @@ -1194,6 +1299,9 @@ export interface ImageConfig { } export namespace ImageConfig { + /** + * @internal + */ export const filterSensitiveLog = (obj: ImageConfig): any => ({ ...obj, }); @@ -1248,6 +1356,9 @@ export interface TracingConfig { } export namespace TracingConfig { + /** + * @internal + */ export const filterSensitiveLog = (obj: TracingConfig): any => ({ ...obj, }); @@ -1269,6 +1380,9 @@ export interface VpcConfig { } export namespace VpcConfig { + /** + * @internal + */ export const filterSensitiveLog = (obj: VpcConfig): any => ({ ...obj, }); @@ -1410,6 +1524,9 @@ export interface CreateFunctionRequest { } export namespace CreateFunctionRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateFunctionRequest): any => ({ ...obj, ...(obj.Code && { Code: FunctionCode.filterSensitiveLog(obj.Code) }), @@ -1433,6 +1550,9 @@ export interface EnvironmentError { } export namespace EnvironmentError { + /** + * @internal + */ export const filterSensitiveLog = (obj: EnvironmentError): any => ({ ...obj, ...(obj.Message && { Message: SENSITIVE_STRING }), @@ -1456,6 +1576,9 @@ export interface EnvironmentResponse { } export namespace EnvironmentResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: EnvironmentResponse): any => ({ ...obj, ...(obj.Variables && { Variables: SENSITIVE_STRING }), @@ -1479,6 +1602,9 @@ export interface ImageConfigError { } export namespace ImageConfigError { + /** + * @internal + */ export const filterSensitiveLog = (obj: ImageConfigError): any => ({ ...obj, ...(obj.Message && { Message: SENSITIVE_STRING }), @@ -1501,6 +1627,9 @@ export interface ImageConfigResponse { } export namespace ImageConfigResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ImageConfigResponse): any => ({ ...obj, ...(obj.Error && { Error: ImageConfigError.filterSensitiveLog(obj.Error) }), @@ -1553,6 +1682,9 @@ export interface Layer { } export namespace Layer { + /** + * @internal + */ export const filterSensitiveLog = (obj: Layer): any => ({ ...obj, }); @@ -1592,6 +1724,9 @@ export interface TracingConfigResponse { } export namespace TracingConfigResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: TracingConfigResponse): any => ({ ...obj, }); @@ -1618,6 +1753,9 @@ export interface VpcConfigResponse { } export namespace VpcConfigResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: VpcConfigResponse): any => ({ ...obj, }); @@ -1789,6 +1927,9 @@ export interface FunctionConfiguration { } export namespace FunctionConfiguration { + /** + * @internal + */ export const filterSensitiveLog = (obj: FunctionConfiguration): any => ({ ...obj, ...(obj.Environment && { Environment: EnvironmentResponse.filterSensitiveLog(obj.Environment) }), @@ -1810,6 +1951,9 @@ export interface InvalidCodeSignatureException extends __SmithyException, $Metad } export namespace InvalidCodeSignatureException { + /** + * @internal + */ export const filterSensitiveLog = (obj: InvalidCodeSignatureException): any => ({ ...obj, }); @@ -1847,6 +1991,9 @@ export interface DeleteAliasRequest { } export namespace DeleteAliasRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteAliasRequest): any => ({ ...obj, }); @@ -1860,6 +2007,9 @@ export interface DeleteCodeSigningConfigRequest { } export namespace DeleteCodeSigningConfigRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteCodeSigningConfigRequest): any => ({ ...obj, }); @@ -1868,6 +2018,9 @@ export namespace DeleteCodeSigningConfigRequest { export interface DeleteCodeSigningConfigResponse {} export namespace DeleteCodeSigningConfigResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteCodeSigningConfigResponse): any => ({ ...obj, }); @@ -1881,6 +2034,9 @@ export interface DeleteEventSourceMappingRequest { } export namespace DeleteEventSourceMappingRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteEventSourceMappingRequest): any => ({ ...obj, }); @@ -1898,6 +2054,9 @@ export interface ResourceInUseException extends __SmithyException, $MetadataBear } export namespace ResourceInUseException { + /** + * @internal + */ export const filterSensitiveLog = (obj: ResourceInUseException): any => ({ ...obj, }); @@ -1935,6 +2094,9 @@ export interface DeleteFunctionRequest { } export namespace DeleteFunctionRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteFunctionRequest): any => ({ ...obj, }); @@ -1967,6 +2129,9 @@ export interface DeleteFunctionCodeSigningConfigRequest { } export namespace DeleteFunctionCodeSigningConfigRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteFunctionCodeSigningConfigRequest): any => ({ ...obj, }); @@ -1999,6 +2164,9 @@ export interface DeleteFunctionConcurrencyRequest { } export namespace DeleteFunctionConcurrencyRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteFunctionConcurrencyRequest): any => ({ ...obj, }); @@ -2036,6 +2204,9 @@ export interface DeleteFunctionEventInvokeConfigRequest { } export namespace DeleteFunctionEventInvokeConfigRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteFunctionEventInvokeConfigRequest): any => ({ ...obj, }); @@ -2054,6 +2225,9 @@ export interface DeleteLayerVersionRequest { } export namespace DeleteLayerVersionRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteLayerVersionRequest): any => ({ ...obj, }); @@ -2091,6 +2265,9 @@ export interface DeleteProvisionedConcurrencyConfigRequest { } export namespace DeleteProvisionedConcurrencyConfigRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteProvisionedConcurrencyConfigRequest): any => ({ ...obj, }); @@ -2099,6 +2276,9 @@ export namespace DeleteProvisionedConcurrencyConfigRequest { export interface GetAccountSettingsRequest {} export namespace GetAccountSettingsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetAccountSettingsRequest): any => ({ ...obj, }); @@ -2117,6 +2297,9 @@ export interface GetAccountSettingsResponse { } export namespace GetAccountSettingsResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetAccountSettingsResponse): any => ({ ...obj, }); @@ -2154,6 +2337,9 @@ export interface GetAliasRequest { } export namespace GetAliasRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetAliasRequest): any => ({ ...obj, }); @@ -2167,6 +2353,9 @@ export interface GetCodeSigningConfigRequest { } export namespace GetCodeSigningConfigRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetCodeSigningConfigRequest): any => ({ ...obj, }); @@ -2180,6 +2369,9 @@ export interface GetCodeSigningConfigResponse { } export namespace GetCodeSigningConfigResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetCodeSigningConfigResponse): any => ({ ...obj, }); @@ -2193,6 +2385,9 @@ export interface GetEventSourceMappingRequest { } export namespace GetEventSourceMappingRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetEventSourceMappingRequest): any => ({ ...obj, }); @@ -2230,6 +2425,9 @@ export interface GetFunctionRequest { } export namespace GetFunctionRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetFunctionRequest): any => ({ ...obj, }); @@ -2261,6 +2459,9 @@ export interface FunctionCodeLocation { } export namespace FunctionCodeLocation { + /** + * @internal + */ export const filterSensitiveLog = (obj: FunctionCodeLocation): any => ({ ...obj, }); @@ -2274,6 +2475,9 @@ export interface Concurrency { } export namespace Concurrency { + /** + * @internal + */ export const filterSensitiveLog = (obj: Concurrency): any => ({ ...obj, }); @@ -2303,6 +2507,9 @@ export interface GetFunctionResponse { } export namespace GetFunctionResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetFunctionResponse): any => ({ ...obj, ...(obj.Configuration && { Configuration: FunctionConfiguration.filterSensitiveLog(obj.Configuration) }), @@ -2336,6 +2543,9 @@ export interface GetFunctionCodeSigningConfigRequest { } export namespace GetFunctionCodeSigningConfigRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetFunctionCodeSigningConfigRequest): any => ({ ...obj, }); @@ -2373,6 +2583,9 @@ export interface GetFunctionCodeSigningConfigResponse { } export namespace GetFunctionCodeSigningConfigResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetFunctionCodeSigningConfigResponse): any => ({ ...obj, }); @@ -2405,6 +2618,9 @@ export interface GetFunctionConcurrencyRequest { } export namespace GetFunctionConcurrencyRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetFunctionConcurrencyRequest): any => ({ ...obj, }); @@ -2418,6 +2634,9 @@ export interface GetFunctionConcurrencyResponse { } export namespace GetFunctionConcurrencyResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetFunctionConcurrencyResponse): any => ({ ...obj, }); @@ -2455,6 +2674,9 @@ export interface GetFunctionConfigurationRequest { } export namespace GetFunctionConfigurationRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetFunctionConfigurationRequest): any => ({ ...obj, }); @@ -2509,6 +2731,9 @@ export interface FunctionEventInvokeConfig { } export namespace FunctionEventInvokeConfig { + /** + * @internal + */ export const filterSensitiveLog = (obj: FunctionEventInvokeConfig): any => ({ ...obj, }); @@ -2546,6 +2771,9 @@ export interface GetFunctionEventInvokeConfigRequest { } export namespace GetFunctionEventInvokeConfigRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetFunctionEventInvokeConfigRequest): any => ({ ...obj, }); @@ -2564,6 +2792,9 @@ export interface GetLayerVersionRequest { } export namespace GetLayerVersionRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetLayerVersionRequest): any => ({ ...obj, }); @@ -2601,6 +2832,9 @@ export interface LayerVersionContentOutput { } export namespace LayerVersionContentOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: LayerVersionContentOutput): any => ({ ...obj, }); @@ -2649,6 +2883,9 @@ export interface GetLayerVersionResponse { } export namespace GetLayerVersionResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetLayerVersionResponse): any => ({ ...obj, }); @@ -2662,6 +2899,9 @@ export interface GetLayerVersionByArnRequest { } export namespace GetLayerVersionByArnRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetLayerVersionByArnRequest): any => ({ ...obj, }); @@ -2680,6 +2920,9 @@ export interface GetLayerVersionPolicyRequest { } export namespace GetLayerVersionPolicyRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetLayerVersionPolicyRequest): any => ({ ...obj, }); @@ -2698,6 +2941,9 @@ export interface GetLayerVersionPolicyResponse { } export namespace GetLayerVersionPolicyResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetLayerVersionPolicyResponse): any => ({ ...obj, }); @@ -2735,6 +2981,9 @@ export interface GetPolicyRequest { } export namespace GetPolicyRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetPolicyRequest): any => ({ ...obj, }); @@ -2753,6 +3002,9 @@ export interface GetPolicyResponse { } export namespace GetPolicyResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetPolicyResponse): any => ({ ...obj, }); @@ -2790,6 +3042,9 @@ export interface GetProvisionedConcurrencyConfigRequest { } export namespace GetProvisionedConcurrencyConfigRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetProvisionedConcurrencyConfigRequest): any => ({ ...obj, }); @@ -2834,6 +3089,9 @@ export interface GetProvisionedConcurrencyConfigResponse { } export namespace GetProvisionedConcurrencyConfigResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetProvisionedConcurrencyConfigResponse): any => ({ ...obj, }); @@ -2850,6 +3108,9 @@ export interface ProvisionedConcurrencyConfigNotFoundException extends __SmithyE } export namespace ProvisionedConcurrencyConfigNotFoundException { + /** + * @internal + */ export const filterSensitiveLog = (obj: ProvisionedConcurrencyConfigNotFoundException): any => ({ ...obj, }); @@ -2866,6 +3127,9 @@ export interface EC2AccessDeniedException extends __SmithyException, $MetadataBe } export namespace EC2AccessDeniedException { + /** + * @internal + */ export const filterSensitiveLog = (obj: EC2AccessDeniedException): any => ({ ...obj, }); @@ -2883,6 +3147,9 @@ export interface EC2ThrottledException extends __SmithyException, $MetadataBeare } export namespace EC2ThrottledException { + /** + * @internal + */ export const filterSensitiveLog = (obj: EC2ThrottledException): any => ({ ...obj, }); @@ -2900,6 +3167,9 @@ export interface EC2UnexpectedException extends __SmithyException, $MetadataBear } export namespace EC2UnexpectedException { + /** + * @internal + */ export const filterSensitiveLog = (obj: EC2UnexpectedException): any => ({ ...obj, }); @@ -2916,6 +3186,9 @@ export interface EFSIOException extends __SmithyException, $MetadataBearer { } export namespace EFSIOException { + /** + * @internal + */ export const filterSensitiveLog = (obj: EFSIOException): any => ({ ...obj, }); @@ -2932,6 +3205,9 @@ export interface EFSMountConnectivityException extends __SmithyException, $Metad } export namespace EFSMountConnectivityException { + /** + * @internal + */ export const filterSensitiveLog = (obj: EFSMountConnectivityException): any => ({ ...obj, }); @@ -2948,6 +3224,9 @@ export interface EFSMountFailureException extends __SmithyException, $MetadataBe } export namespace EFSMountFailureException { + /** + * @internal + */ export const filterSensitiveLog = (obj: EFSMountFailureException): any => ({ ...obj, }); @@ -2965,6 +3244,9 @@ export interface EFSMountTimeoutException extends __SmithyException, $MetadataBe } export namespace EFSMountTimeoutException { + /** + * @internal + */ export const filterSensitiveLog = (obj: EFSMountTimeoutException): any => ({ ...obj, }); @@ -2982,6 +3264,9 @@ export interface ENILimitReachedException extends __SmithyException, $MetadataBe } export namespace ENILimitReachedException { + /** + * @internal + */ export const filterSensitiveLog = (obj: ENILimitReachedException): any => ({ ...obj, }); @@ -3005,6 +3290,9 @@ export interface InvalidRequestContentException extends __SmithyException, $Meta } export namespace InvalidRequestContentException { + /** + * @internal + */ export const filterSensitiveLog = (obj: InvalidRequestContentException): any => ({ ...obj, }); @@ -3021,6 +3309,9 @@ export interface InvalidRuntimeException extends __SmithyException, $MetadataBea } export namespace InvalidRuntimeException { + /** + * @internal + */ export const filterSensitiveLog = (obj: InvalidRuntimeException): any => ({ ...obj, }); @@ -3037,6 +3328,9 @@ export interface InvalidSecurityGroupIDException extends __SmithyException, $Met } export namespace InvalidSecurityGroupIDException { + /** + * @internal + */ export const filterSensitiveLog = (obj: InvalidSecurityGroupIDException): any => ({ ...obj, }); @@ -3053,6 +3347,9 @@ export interface InvalidSubnetIDException extends __SmithyException, $MetadataBe } export namespace InvalidSubnetIDException { + /** + * @internal + */ export const filterSensitiveLog = (obj: InvalidSubnetIDException): any => ({ ...obj, }); @@ -3069,6 +3366,9 @@ export interface InvalidZipFileException extends __SmithyException, $MetadataBea } export namespace InvalidZipFileException { + /** + * @internal + */ export const filterSensitiveLog = (obj: InvalidZipFileException): any => ({ ...obj, }); @@ -3156,6 +3456,9 @@ export interface InvocationRequest { } export namespace InvocationRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: InvocationRequest): any => ({ ...obj, ...(obj.Payload && { Payload: SENSITIVE_STRING }), @@ -3194,6 +3497,9 @@ export interface InvocationResponse { } export namespace InvocationResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: InvocationResponse): any => ({ ...obj, ...(obj.Payload && { Payload: SENSITIVE_STRING }), @@ -3212,6 +3518,9 @@ export interface KMSAccessDeniedException extends __SmithyException, $MetadataBe } export namespace KMSAccessDeniedException { + /** + * @internal + */ export const filterSensitiveLog = (obj: KMSAccessDeniedException): any => ({ ...obj, }); @@ -3229,6 +3538,9 @@ export interface KMSDisabledException extends __SmithyException, $MetadataBearer } export namespace KMSDisabledException { + /** + * @internal + */ export const filterSensitiveLog = (obj: KMSDisabledException): any => ({ ...obj, }); @@ -3246,6 +3558,9 @@ export interface KMSInvalidStateException extends __SmithyException, $MetadataBe } export namespace KMSInvalidStateException { + /** + * @internal + */ export const filterSensitiveLog = (obj: KMSInvalidStateException): any => ({ ...obj, }); @@ -3263,6 +3578,9 @@ export interface KMSNotFoundException extends __SmithyException, $MetadataBearer } export namespace KMSNotFoundException { + /** + * @internal + */ export const filterSensitiveLog = (obj: KMSNotFoundException): any => ({ ...obj, }); @@ -3280,6 +3598,9 @@ export interface RequestTooLargeException extends __SmithyException, $MetadataBe } export namespace RequestTooLargeException { + /** + * @internal + */ export const filterSensitiveLog = (obj: RequestTooLargeException): any => ({ ...obj, }); @@ -3304,6 +3625,9 @@ export interface ResourceNotReadyException extends __SmithyException, $MetadataB } export namespace ResourceNotReadyException { + /** + * @internal + */ export const filterSensitiveLog = (obj: ResourceNotReadyException): any => ({ ...obj, }); @@ -3321,6 +3645,9 @@ export interface SubnetIPAddressLimitReachedException extends __SmithyException, } export namespace SubnetIPAddressLimitReachedException { + /** + * @internal + */ export const filterSensitiveLog = (obj: SubnetIPAddressLimitReachedException): any => ({ ...obj, }); @@ -3337,6 +3664,9 @@ export interface UnsupportedMediaTypeException extends __SmithyException, $Metad } export namespace UnsupportedMediaTypeException { + /** + * @internal + */ export const filterSensitiveLog = (obj: UnsupportedMediaTypeException): any => ({ ...obj, }); @@ -3374,6 +3704,9 @@ export interface InvokeAsyncRequest { } export namespace InvokeAsyncRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: InvokeAsyncRequest): any => ({ ...obj, }); @@ -3392,6 +3725,9 @@ export interface InvokeAsyncResponse { } export namespace InvokeAsyncResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: InvokeAsyncResponse): any => ({ ...obj, }); @@ -3439,6 +3775,9 @@ export interface ListAliasesRequest { } export namespace ListAliasesRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListAliasesRequest): any => ({ ...obj, }); @@ -3457,6 +3796,9 @@ export interface ListAliasesResponse { } export namespace ListAliasesResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListAliasesResponse): any => ({ ...obj, }); @@ -3475,6 +3817,9 @@ export interface ListCodeSigningConfigsRequest { } export namespace ListCodeSigningConfigsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListCodeSigningConfigsRequest): any => ({ ...obj, }); @@ -3493,6 +3838,9 @@ export interface ListCodeSigningConfigsResponse { } export namespace ListCodeSigningConfigsResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListCodeSigningConfigsResponse): any => ({ ...obj, }); @@ -3562,6 +3910,9 @@ export interface ListEventSourceMappingsRequest { } export namespace ListEventSourceMappingsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListEventSourceMappingsRequest): any => ({ ...obj, }); @@ -3580,6 +3931,9 @@ export interface ListEventSourceMappingsResponse { } export namespace ListEventSourceMappingsResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListEventSourceMappingsResponse): any => ({ ...obj, }); @@ -3622,6 +3976,9 @@ export interface ListFunctionEventInvokeConfigsRequest { } export namespace ListFunctionEventInvokeConfigsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListFunctionEventInvokeConfigsRequest): any => ({ ...obj, }); @@ -3640,6 +3997,9 @@ export interface ListFunctionEventInvokeConfigsResponse { } export namespace ListFunctionEventInvokeConfigsResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListFunctionEventInvokeConfigsResponse): any => ({ ...obj, }); @@ -3675,6 +4035,9 @@ export interface ListFunctionsRequest { } export namespace ListFunctionsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListFunctionsRequest): any => ({ ...obj, }); @@ -3696,6 +4059,9 @@ export interface ListFunctionsResponse { } export namespace ListFunctionsResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListFunctionsResponse): any => ({ ...obj, ...(obj.Functions && { Functions: obj.Functions.map((item) => FunctionConfiguration.filterSensitiveLog(item)) }), @@ -3720,6 +4086,9 @@ export interface ListFunctionsByCodeSigningConfigRequest { } export namespace ListFunctionsByCodeSigningConfigRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListFunctionsByCodeSigningConfigRequest): any => ({ ...obj, }); @@ -3738,6 +4107,9 @@ export interface ListFunctionsByCodeSigningConfigResponse { } export namespace ListFunctionsByCodeSigningConfigResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListFunctionsByCodeSigningConfigResponse): any => ({ ...obj, }); @@ -3761,6 +4133,9 @@ export interface ListLayersRequest { } export namespace ListLayersRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListLayersRequest): any => ({ ...obj, }); @@ -3803,6 +4178,9 @@ export interface LayerVersionsListItem { } export namespace LayerVersionsListItem { + /** + * @internal + */ export const filterSensitiveLog = (obj: LayerVersionsListItem): any => ({ ...obj, }); @@ -3830,6 +4208,9 @@ export interface LayersListItem { } export namespace LayersListItem { + /** + * @internal + */ export const filterSensitiveLog = (obj: LayersListItem): any => ({ ...obj, }); @@ -3848,6 +4229,9 @@ export interface ListLayersResponse { } export namespace ListLayersResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListLayersResponse): any => ({ ...obj, }); @@ -3876,6 +4260,9 @@ export interface ListLayerVersionsRequest { } export namespace ListLayerVersionsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListLayerVersionsRequest): any => ({ ...obj, }); @@ -3894,6 +4281,9 @@ export interface ListLayerVersionsResponse { } export namespace ListLayerVersionsResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListLayerVersionsResponse): any => ({ ...obj, }); @@ -3936,6 +4326,9 @@ export interface ListProvisionedConcurrencyConfigsRequest { } export namespace ListProvisionedConcurrencyConfigsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListProvisionedConcurrencyConfigsRequest): any => ({ ...obj, }); @@ -3982,6 +4375,9 @@ export interface ProvisionedConcurrencyConfigListItem { } export namespace ProvisionedConcurrencyConfigListItem { + /** + * @internal + */ export const filterSensitiveLog = (obj: ProvisionedConcurrencyConfigListItem): any => ({ ...obj, }); @@ -4000,6 +4396,9 @@ export interface ListProvisionedConcurrencyConfigsResponse { } export namespace ListProvisionedConcurrencyConfigsResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListProvisionedConcurrencyConfigsResponse): any => ({ ...obj, }); @@ -4013,6 +4412,9 @@ export interface ListTagsRequest { } export namespace ListTagsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListTagsRequest): any => ({ ...obj, }); @@ -4026,6 +4428,9 @@ export interface ListTagsResponse { } export namespace ListTagsResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListTagsResponse): any => ({ ...obj, }); @@ -4068,6 +4473,9 @@ export interface ListVersionsByFunctionRequest { } export namespace ListVersionsByFunctionRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListVersionsByFunctionRequest): any => ({ ...obj, }); @@ -4086,6 +4494,9 @@ export interface ListVersionsByFunctionResponse { } export namespace ListVersionsByFunctionResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListVersionsByFunctionResponse): any => ({ ...obj, ...(obj.Versions && { Versions: obj.Versions.map((item) => FunctionConfiguration.filterSensitiveLog(item)) }), @@ -4121,6 +4532,9 @@ export interface LayerVersionContentInput { } export namespace LayerVersionContentInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: LayerVersionContentInput): any => ({ ...obj, ...(obj.ZipFile && { ZipFile: SENSITIVE_STRING }), @@ -4169,6 +4583,9 @@ export interface PublishLayerVersionRequest { } export namespace PublishLayerVersionRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: PublishLayerVersionRequest): any => ({ ...obj, ...(obj.Content && { Content: LayerVersionContentInput.filterSensitiveLog(obj.Content) }), @@ -4218,6 +4635,9 @@ export interface PublishLayerVersionResponse { } export namespace PublishLayerVersionResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: PublishLayerVersionResponse): any => ({ ...obj, }); @@ -4268,6 +4688,9 @@ export interface PublishVersionRequest { } export namespace PublishVersionRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: PublishVersionRequest): any => ({ ...obj, }); @@ -4305,6 +4728,9 @@ export interface PutFunctionCodeSigningConfigRequest { } export namespace PutFunctionCodeSigningConfigRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: PutFunctionCodeSigningConfigRequest): any => ({ ...obj, }); @@ -4342,6 +4768,9 @@ export interface PutFunctionCodeSigningConfigResponse { } export namespace PutFunctionCodeSigningConfigResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: PutFunctionCodeSigningConfigResponse): any => ({ ...obj, }); @@ -4379,6 +4808,9 @@ export interface PutFunctionConcurrencyRequest { } export namespace PutFunctionConcurrencyRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: PutFunctionConcurrencyRequest): any => ({ ...obj, }); @@ -4452,6 +4884,9 @@ export interface PutFunctionEventInvokeConfigRequest { } export namespace PutFunctionEventInvokeConfigRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: PutFunctionEventInvokeConfigRequest): any => ({ ...obj, }); @@ -4494,6 +4929,9 @@ export interface PutProvisionedConcurrencyConfigRequest { } export namespace PutProvisionedConcurrencyConfigRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: PutProvisionedConcurrencyConfigRequest): any => ({ ...obj, }); @@ -4532,6 +4970,9 @@ export interface PutProvisionedConcurrencyConfigResponse { } export namespace PutProvisionedConcurrencyConfigResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: PutProvisionedConcurrencyConfigResponse): any => ({ ...obj, }); @@ -4561,6 +5002,9 @@ export interface RemoveLayerVersionPermissionRequest { } export namespace RemoveLayerVersionPermissionRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: RemoveLayerVersionPermissionRequest): any => ({ ...obj, }); @@ -4609,6 +5053,9 @@ export interface RemovePermissionRequest { } export namespace RemovePermissionRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: RemovePermissionRequest): any => ({ ...obj, }); @@ -4627,6 +5074,9 @@ export interface TagResourceRequest { } export namespace TagResourceRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: TagResourceRequest): any => ({ ...obj, }); @@ -4645,6 +5095,9 @@ export interface UntagResourceRequest { } export namespace UntagResourceRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: UntagResourceRequest): any => ({ ...obj, }); @@ -4704,6 +5157,9 @@ export interface UpdateAliasRequest { } export namespace UpdateAliasRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateAliasRequest): any => ({ ...obj, }); @@ -4732,6 +5188,9 @@ export interface UpdateCodeSigningConfigRequest { } export namespace UpdateCodeSigningConfigRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateCodeSigningConfigRequest): any => ({ ...obj, }); @@ -4745,6 +5204,9 @@ export interface UpdateCodeSigningConfigResponse { } export namespace UpdateCodeSigningConfigResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateCodeSigningConfigResponse): any => ({ ...obj, }); @@ -4863,6 +5325,9 @@ export interface UpdateEventSourceMappingRequest { } export namespace UpdateEventSourceMappingRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateEventSourceMappingRequest): any => ({ ...obj, }); @@ -4939,6 +5404,9 @@ export interface UpdateFunctionCodeRequest { } export namespace UpdateFunctionCodeRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateFunctionCodeRequest): any => ({ ...obj, ...(obj.ZipFile && { ZipFile: SENSITIVE_STRING }), @@ -5060,6 +5528,9 @@ export interface UpdateFunctionConfigurationRequest { } export namespace UpdateFunctionConfigurationRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateFunctionConfigurationRequest): any => ({ ...obj, ...(obj.Environment && { Environment: Environment.filterSensitiveLog(obj.Environment) }), @@ -5134,6 +5605,9 @@ export interface UpdateFunctionEventInvokeConfigRequest { } export namespace UpdateFunctionEventInvokeConfigRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateFunctionEventInvokeConfigRequest): any => ({ ...obj, }); diff --git a/clients/client-lex-model-building-service/commands/CreateBotVersionCommand.ts b/clients/client-lex-model-building-service/commands/CreateBotVersionCommand.ts index 4b2598b6bc46..0d9ddf971266 100644 --- a/clients/client-lex-model-building-service/commands/CreateBotVersionCommand.ts +++ b/clients/client-lex-model-building-service/commands/CreateBotVersionCommand.ts @@ -38,6 +38,20 @@ export interface CreateBotVersionCommandOutput extends CreateBotVersionResponse, * to 1. Subsequent versions increment by 1. For more information, see versioning-intro.

*

This operation requires permission for the * lex:CreateBotVersion action.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { LexModelBuildingServiceClient, CreateBotVersionCommand } from "@aws-sdk/client-lex-model-building-service"; // ES Modules import + * // const { LexModelBuildingServiceClient, CreateBotVersionCommand } = require("@aws-sdk/client-lex-model-building-service"); // CommonJS import + * const client = new LexModelBuildingServiceClient(config); + * const command = new CreateBotVersionCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreateBotVersionCommandInput} for command's `input` shape. + * @see {@link CreateBotVersionCommandOutput} for command's `response` shape. + * @see {@link LexModelBuildingServiceClientResolvedConfig | config} for command's `input` shape. + * */ export class CreateBotVersionCommand extends $Command< CreateBotVersionCommandInput, diff --git a/clients/client-lex-model-building-service/commands/CreateIntentVersionCommand.ts b/clients/client-lex-model-building-service/commands/CreateIntentVersionCommand.ts index 42e52161eb5f..203117ed14e7 100644 --- a/clients/client-lex-model-building-service/commands/CreateIntentVersionCommand.ts +++ b/clients/client-lex-model-building-service/commands/CreateIntentVersionCommand.ts @@ -39,6 +39,20 @@ export interface CreateIntentVersionCommandOutput extends CreateIntentVersionRes * 1. Subsequent versions increment by 1. For more information, see versioning-intro.

*

This operation requires permissions to perform the * lex:CreateIntentVersion action.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { LexModelBuildingServiceClient, CreateIntentVersionCommand } from "@aws-sdk/client-lex-model-building-service"; // ES Modules import + * // const { LexModelBuildingServiceClient, CreateIntentVersionCommand } = require("@aws-sdk/client-lex-model-building-service"); // CommonJS import + * const client = new LexModelBuildingServiceClient(config); + * const command = new CreateIntentVersionCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreateIntentVersionCommandInput} for command's `input` shape. + * @see {@link CreateIntentVersionCommandOutput} for command's `response` shape. + * @see {@link LexModelBuildingServiceClientResolvedConfig | config} for command's `input` shape. + * */ export class CreateIntentVersionCommand extends $Command< CreateIntentVersionCommandInput, diff --git a/clients/client-lex-model-building-service/commands/CreateSlotTypeVersionCommand.ts b/clients/client-lex-model-building-service/commands/CreateSlotTypeVersionCommand.ts index 31f97efbfcbf..8636018464de 100644 --- a/clients/client-lex-model-building-service/commands/CreateSlotTypeVersionCommand.ts +++ b/clients/client-lex-model-building-service/commands/CreateSlotTypeVersionCommand.ts @@ -41,6 +41,20 @@ export interface CreateSlotTypeVersionCommandOutput extends CreateSlotTypeVersio * *

This operation requires permissions for the * lex:CreateSlotTypeVersion action.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { LexModelBuildingServiceClient, CreateSlotTypeVersionCommand } from "@aws-sdk/client-lex-model-building-service"; // ES Modules import + * // const { LexModelBuildingServiceClient, CreateSlotTypeVersionCommand } = require("@aws-sdk/client-lex-model-building-service"); // CommonJS import + * const client = new LexModelBuildingServiceClient(config); + * const command = new CreateSlotTypeVersionCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreateSlotTypeVersionCommandInput} for command's `input` shape. + * @see {@link CreateSlotTypeVersionCommandOutput} for command's `response` shape. + * @see {@link LexModelBuildingServiceClientResolvedConfig | config} for command's `input` shape. + * */ export class CreateSlotTypeVersionCommand extends $Command< CreateSlotTypeVersionCommandInput, diff --git a/clients/client-lex-model-building-service/commands/DeleteBotAliasCommand.ts b/clients/client-lex-model-building-service/commands/DeleteBotAliasCommand.ts index 7592cdeb0a3c..7bd0d97ed536 100644 --- a/clients/client-lex-model-building-service/commands/DeleteBotAliasCommand.ts +++ b/clients/client-lex-model-building-service/commands/DeleteBotAliasCommand.ts @@ -34,6 +34,20 @@ export interface DeleteBotAliasCommandOutput extends __MetadataBearer {} * 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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { LexModelBuildingServiceClient, DeleteBotAliasCommand } from "@aws-sdk/client-lex-model-building-service"; // ES Modules import + * // const { LexModelBuildingServiceClient, DeleteBotAliasCommand } = require("@aws-sdk/client-lex-model-building-service"); // CommonJS import + * const client = new LexModelBuildingServiceClient(config); + * const command = new DeleteBotAliasCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteBotAliasCommandInput} for command's `input` shape. + * @see {@link DeleteBotAliasCommandOutput} for command's `response` shape. + * @see {@link LexModelBuildingServiceClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteBotAliasCommand extends $Command< DeleteBotAliasCommandInput, diff --git a/clients/client-lex-model-building-service/commands/DeleteBotChannelAssociationCommand.ts b/clients/client-lex-model-building-service/commands/DeleteBotChannelAssociationCommand.ts index 3d395684bb98..2612c09d8744 100644 --- a/clients/client-lex-model-building-service/commands/DeleteBotChannelAssociationCommand.ts +++ b/clients/client-lex-model-building-service/commands/DeleteBotChannelAssociationCommand.ts @@ -29,6 +29,20 @@ export interface DeleteBotChannelAssociationCommandOutput extends __MetadataBear * platform.

*

This operation requires permission for the * lex:DeleteBotChannelAssociation action.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { LexModelBuildingServiceClient, DeleteBotChannelAssociationCommand } from "@aws-sdk/client-lex-model-building-service"; // ES Modules import + * // const { LexModelBuildingServiceClient, DeleteBotChannelAssociationCommand } = require("@aws-sdk/client-lex-model-building-service"); // CommonJS import + * const client = new LexModelBuildingServiceClient(config); + * const command = new DeleteBotChannelAssociationCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteBotChannelAssociationCommandInput} for command's `input` shape. + * @see {@link DeleteBotChannelAssociationCommandOutput} for command's `response` shape. + * @see {@link LexModelBuildingServiceClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteBotChannelAssociationCommand extends $Command< DeleteBotChannelAssociationCommandInput, diff --git a/clients/client-lex-model-building-service/commands/DeleteBotCommand.ts b/clients/client-lex-model-building-service/commands/DeleteBotCommand.ts index 01e0eb7f7b00..14f2f3f16271 100644 --- a/clients/client-lex-model-building-service/commands/DeleteBotCommand.ts +++ b/clients/client-lex-model-building-service/commands/DeleteBotCommand.ts @@ -42,6 +42,20 @@ export interface DeleteBotCommandOutput extends __MetadataBearer {} * *

This operation requires permissions for the * lex:DeleteBot action.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { LexModelBuildingServiceClient, DeleteBotCommand } from "@aws-sdk/client-lex-model-building-service"; // ES Modules import + * // const { LexModelBuildingServiceClient, DeleteBotCommand } = require("@aws-sdk/client-lex-model-building-service"); // CommonJS import + * const client = new LexModelBuildingServiceClient(config); + * const command = new DeleteBotCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteBotCommandInput} for command's `input` shape. + * @see {@link DeleteBotCommandOutput} for command's `response` shape. + * @see {@link LexModelBuildingServiceClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteBotCommand extends $Command< DeleteBotCommandInput, diff --git a/clients/client-lex-model-building-service/commands/DeleteBotVersionCommand.ts b/clients/client-lex-model-building-service/commands/DeleteBotVersionCommand.ts index b506a0eaaaac..3fda61bceefb 100644 --- a/clients/client-lex-model-building-service/commands/DeleteBotVersionCommand.ts +++ b/clients/client-lex-model-building-service/commands/DeleteBotVersionCommand.ts @@ -29,6 +29,20 @@ export interface DeleteBotVersionCommandOutput extends __MetadataBearer {} * bot, use the DeleteBot operation.

*

This operation requires permissions for the * lex:DeleteBotVersion action.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { LexModelBuildingServiceClient, DeleteBotVersionCommand } from "@aws-sdk/client-lex-model-building-service"; // ES Modules import + * // const { LexModelBuildingServiceClient, DeleteBotVersionCommand } = require("@aws-sdk/client-lex-model-building-service"); // CommonJS import + * const client = new LexModelBuildingServiceClient(config); + * const command = new DeleteBotVersionCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteBotVersionCommandInput} for command's `input` shape. + * @see {@link DeleteBotVersionCommandOutput} for command's `response` shape. + * @see {@link LexModelBuildingServiceClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteBotVersionCommand extends $Command< DeleteBotVersionCommandInput, diff --git a/clients/client-lex-model-building-service/commands/DeleteIntentCommand.ts b/clients/client-lex-model-building-service/commands/DeleteIntentCommand.ts index ed8de05cb037..084fd346446b 100644 --- a/clients/client-lex-model-building-service/commands/DeleteIntentCommand.ts +++ b/clients/client-lex-model-building-service/commands/DeleteIntentCommand.ts @@ -43,6 +43,20 @@ export interface DeleteIntentCommandOutput extends __MetadataBearer {} * *

This operation requires permission for the * lex:DeleteIntent action.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { LexModelBuildingServiceClient, DeleteIntentCommand } from "@aws-sdk/client-lex-model-building-service"; // ES Modules import + * // const { LexModelBuildingServiceClient, DeleteIntentCommand } = require("@aws-sdk/client-lex-model-building-service"); // CommonJS import + * const client = new LexModelBuildingServiceClient(config); + * const command = new DeleteIntentCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteIntentCommandInput} for command's `input` shape. + * @see {@link DeleteIntentCommandOutput} for command's `response` shape. + * @see {@link LexModelBuildingServiceClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteIntentCommand extends $Command< DeleteIntentCommandInput, diff --git a/clients/client-lex-model-building-service/commands/DeleteIntentVersionCommand.ts b/clients/client-lex-model-building-service/commands/DeleteIntentVersionCommand.ts index 250c55d5d534..6e507faa4edc 100644 --- a/clients/client-lex-model-building-service/commands/DeleteIntentVersionCommand.ts +++ b/clients/client-lex-model-building-service/commands/DeleteIntentVersionCommand.ts @@ -29,6 +29,20 @@ export interface DeleteIntentVersionCommandOutput extends __MetadataBearer {} * a intent, use the DeleteIntent operation.

*

This operation requires permissions for the * lex:DeleteIntentVersion action.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { LexModelBuildingServiceClient, DeleteIntentVersionCommand } from "@aws-sdk/client-lex-model-building-service"; // ES Modules import + * // const { LexModelBuildingServiceClient, DeleteIntentVersionCommand } = require("@aws-sdk/client-lex-model-building-service"); // CommonJS import + * const client = new LexModelBuildingServiceClient(config); + * const command = new DeleteIntentVersionCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteIntentVersionCommandInput} for command's `input` shape. + * @see {@link DeleteIntentVersionCommandOutput} for command's `response` shape. + * @see {@link LexModelBuildingServiceClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteIntentVersionCommand extends $Command< DeleteIntentVersionCommandInput, diff --git a/clients/client-lex-model-building-service/commands/DeleteSlotTypeCommand.ts b/clients/client-lex-model-building-service/commands/DeleteSlotTypeCommand.ts index c9272c4b016b..c2c5a073ffca 100644 --- a/clients/client-lex-model-building-service/commands/DeleteSlotTypeCommand.ts +++ b/clients/client-lex-model-building-service/commands/DeleteSlotTypeCommand.ts @@ -42,6 +42,20 @@ export interface DeleteSlotTypeCommandOutput extends __MetadataBearer {} * *

This operation requires permission for the * lex:DeleteSlotType action.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { LexModelBuildingServiceClient, DeleteSlotTypeCommand } from "@aws-sdk/client-lex-model-building-service"; // ES Modules import + * // const { LexModelBuildingServiceClient, DeleteSlotTypeCommand } = require("@aws-sdk/client-lex-model-building-service"); // CommonJS import + * const client = new LexModelBuildingServiceClient(config); + * const command = new DeleteSlotTypeCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteSlotTypeCommandInput} for command's `input` shape. + * @see {@link DeleteSlotTypeCommandOutput} for command's `response` shape. + * @see {@link LexModelBuildingServiceClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteSlotTypeCommand extends $Command< DeleteSlotTypeCommandInput, diff --git a/clients/client-lex-model-building-service/commands/DeleteSlotTypeVersionCommand.ts b/clients/client-lex-model-building-service/commands/DeleteSlotTypeVersionCommand.ts index f816c5c2749c..d1d06e465e29 100644 --- a/clients/client-lex-model-building-service/commands/DeleteSlotTypeVersionCommand.ts +++ b/clients/client-lex-model-building-service/commands/DeleteSlotTypeVersionCommand.ts @@ -29,6 +29,20 @@ export interface DeleteSlotTypeVersionCommandOutput extends __MetadataBearer {} * of a slot type, use the DeleteSlotType operation.

*

This operation requires permissions for the * lex:DeleteSlotTypeVersion action.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { LexModelBuildingServiceClient, DeleteSlotTypeVersionCommand } from "@aws-sdk/client-lex-model-building-service"; // ES Modules import + * // const { LexModelBuildingServiceClient, DeleteSlotTypeVersionCommand } = require("@aws-sdk/client-lex-model-building-service"); // CommonJS import + * const client = new LexModelBuildingServiceClient(config); + * const command = new DeleteSlotTypeVersionCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteSlotTypeVersionCommandInput} for command's `input` shape. + * @see {@link DeleteSlotTypeVersionCommandOutput} for command's `response` shape. + * @see {@link LexModelBuildingServiceClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteSlotTypeVersionCommand extends $Command< DeleteSlotTypeVersionCommandInput, diff --git a/clients/client-lex-model-building-service/commands/DeleteUtterancesCommand.ts b/clients/client-lex-model-building-service/commands/DeleteUtterancesCommand.ts index 159ea1407bb9..cea571575f2d 100644 --- a/clients/client-lex-model-building-service/commands/DeleteUtterancesCommand.ts +++ b/clients/client-lex-model-building-service/commands/DeleteUtterancesCommand.ts @@ -37,6 +37,20 @@ export interface DeleteUtterancesCommandOutput extends __MetadataBearer {} * operation are deleted after 15 days.

*

This operation requires permissions for the * lex:DeleteUtterances action.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { LexModelBuildingServiceClient, DeleteUtterancesCommand } from "@aws-sdk/client-lex-model-building-service"; // ES Modules import + * // const { LexModelBuildingServiceClient, DeleteUtterancesCommand } = require("@aws-sdk/client-lex-model-building-service"); // CommonJS import + * const client = new LexModelBuildingServiceClient(config); + * const command = new DeleteUtterancesCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteUtterancesCommandInput} for command's `input` shape. + * @see {@link DeleteUtterancesCommandOutput} for command's `response` shape. + * @see {@link LexModelBuildingServiceClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteUtterancesCommand extends $Command< DeleteUtterancesCommandInput, diff --git a/clients/client-lex-model-building-service/commands/GetBotAliasCommand.ts b/clients/client-lex-model-building-service/commands/GetBotAliasCommand.ts index 914301ea1df7..3fed19dc2ff5 100644 --- a/clients/client-lex-model-building-service/commands/GetBotAliasCommand.ts +++ b/clients/client-lex-model-building-service/commands/GetBotAliasCommand.ts @@ -29,6 +29,20 @@ export interface GetBotAliasCommandOutput extends GetBotAliasResponse, __Metadat * about aliases, see versioning-aliases.

*

This operation requires permissions for the * lex:GetBotAlias action.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { LexModelBuildingServiceClient, GetBotAliasCommand } from "@aws-sdk/client-lex-model-building-service"; // ES Modules import + * // const { LexModelBuildingServiceClient, GetBotAliasCommand } = require("@aws-sdk/client-lex-model-building-service"); // CommonJS import + * const client = new LexModelBuildingServiceClient(config); + * const command = new GetBotAliasCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetBotAliasCommandInput} for command's `input` shape. + * @see {@link GetBotAliasCommandOutput} for command's `response` shape. + * @see {@link LexModelBuildingServiceClientResolvedConfig | config} for command's `input` shape. + * */ export class GetBotAliasCommand extends $Command< GetBotAliasCommandInput, diff --git a/clients/client-lex-model-building-service/commands/GetBotAliasesCommand.ts b/clients/client-lex-model-building-service/commands/GetBotAliasesCommand.ts index a609c5c195f1..419acb19f29f 100644 --- a/clients/client-lex-model-building-service/commands/GetBotAliasesCommand.ts +++ b/clients/client-lex-model-building-service/commands/GetBotAliasesCommand.ts @@ -28,6 +28,20 @@ export interface GetBotAliasesCommandOutput extends GetBotAliasesResponse, __Met *

Returns a list of aliases for a specified Amazon Lex bot.

*

This operation requires permissions for the * lex:GetBotAliases action.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { LexModelBuildingServiceClient, GetBotAliasesCommand } from "@aws-sdk/client-lex-model-building-service"; // ES Modules import + * // const { LexModelBuildingServiceClient, GetBotAliasesCommand } = require("@aws-sdk/client-lex-model-building-service"); // CommonJS import + * const client = new LexModelBuildingServiceClient(config); + * const command = new GetBotAliasesCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetBotAliasesCommandInput} for command's `input` shape. + * @see {@link GetBotAliasesCommandOutput} for command's `response` shape. + * @see {@link LexModelBuildingServiceClientResolvedConfig | config} for command's `input` shape. + * */ export class GetBotAliasesCommand extends $Command< GetBotAliasesCommandInput, diff --git a/clients/client-lex-model-building-service/commands/GetBotChannelAssociationCommand.ts b/clients/client-lex-model-building-service/commands/GetBotChannelAssociationCommand.ts index 963769e05a87..043ab7d73386 100644 --- a/clients/client-lex-model-building-service/commands/GetBotChannelAssociationCommand.ts +++ b/clients/client-lex-model-building-service/commands/GetBotChannelAssociationCommand.ts @@ -29,6 +29,20 @@ export interface GetBotChannelAssociationCommandOutput extends GetBotChannelAsso * a messaging platform.

*

This operation requires permissions for the * lex:GetBotChannelAssociation action.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { LexModelBuildingServiceClient, GetBotChannelAssociationCommand } from "@aws-sdk/client-lex-model-building-service"; // ES Modules import + * // const { LexModelBuildingServiceClient, GetBotChannelAssociationCommand } = require("@aws-sdk/client-lex-model-building-service"); // CommonJS import + * const client = new LexModelBuildingServiceClient(config); + * const command = new GetBotChannelAssociationCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetBotChannelAssociationCommandInput} for command's `input` shape. + * @see {@link GetBotChannelAssociationCommandOutput} for command's `response` shape. + * @see {@link LexModelBuildingServiceClientResolvedConfig | config} for command's `input` shape. + * */ export class GetBotChannelAssociationCommand extends $Command< GetBotChannelAssociationCommandInput, diff --git a/clients/client-lex-model-building-service/commands/GetBotChannelAssociationsCommand.ts b/clients/client-lex-model-building-service/commands/GetBotChannelAssociationsCommand.ts index 6f6b302ad20a..d04b03d6f775 100644 --- a/clients/client-lex-model-building-service/commands/GetBotChannelAssociationsCommand.ts +++ b/clients/client-lex-model-building-service/commands/GetBotChannelAssociationsCommand.ts @@ -30,6 +30,20 @@ export interface GetBotChannelAssociationsCommandOutput extends GetBotChannelAss *

The GetBotChannelAssociations operation requires * permissions for the lex:GetBotChannelAssociations * action.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { LexModelBuildingServiceClient, GetBotChannelAssociationsCommand } from "@aws-sdk/client-lex-model-building-service"; // ES Modules import + * // const { LexModelBuildingServiceClient, GetBotChannelAssociationsCommand } = require("@aws-sdk/client-lex-model-building-service"); // CommonJS import + * const client = new LexModelBuildingServiceClient(config); + * const command = new GetBotChannelAssociationsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetBotChannelAssociationsCommandInput} for command's `input` shape. + * @see {@link GetBotChannelAssociationsCommandOutput} for command's `response` shape. + * @see {@link LexModelBuildingServiceClientResolvedConfig | config} for command's `input` shape. + * */ export class GetBotChannelAssociationsCommand extends $Command< GetBotChannelAssociationsCommandInput, diff --git a/clients/client-lex-model-building-service/commands/GetBotCommand.ts b/clients/client-lex-model-building-service/commands/GetBotCommand.ts index d6b1d62a9fd2..abe2a7979331 100644 --- a/clients/client-lex-model-building-service/commands/GetBotCommand.ts +++ b/clients/client-lex-model-building-service/commands/GetBotCommand.ts @@ -26,6 +26,20 @@ export interface GetBotCommandOutput extends GetBotResponse, __MetadataBearer {} * the bot name and the bot version or alias.

*

This operation requires permissions for the * lex:GetBot action.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { LexModelBuildingServiceClient, GetBotCommand } from "@aws-sdk/client-lex-model-building-service"; // ES Modules import + * // const { LexModelBuildingServiceClient, GetBotCommand } = require("@aws-sdk/client-lex-model-building-service"); // CommonJS import + * const client = new LexModelBuildingServiceClient(config); + * const command = new GetBotCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetBotCommandInput} for command's `input` shape. + * @see {@link GetBotCommandOutput} for command's `response` shape. + * @see {@link LexModelBuildingServiceClientResolvedConfig | config} for command's `input` shape. + * */ export class GetBotCommand extends $Command< GetBotCommandInput, diff --git a/clients/client-lex-model-building-service/commands/GetBotVersionsCommand.ts b/clients/client-lex-model-building-service/commands/GetBotVersionsCommand.ts index a525a6dde087..ec43f262ced9 100644 --- a/clients/client-lex-model-building-service/commands/GetBotVersionsCommand.ts +++ b/clients/client-lex-model-building-service/commands/GetBotVersionsCommand.ts @@ -36,6 +36,20 @@ export interface GetBotVersionsCommandOutput extends GetBotVersionsResponse, __M * one version, the $LATEST version.

*

This operation requires permissions for the * lex:GetBotVersions action.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { LexModelBuildingServiceClient, GetBotVersionsCommand } from "@aws-sdk/client-lex-model-building-service"; // ES Modules import + * // const { LexModelBuildingServiceClient, GetBotVersionsCommand } = require("@aws-sdk/client-lex-model-building-service"); // CommonJS import + * const client = new LexModelBuildingServiceClient(config); + * const command = new GetBotVersionsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetBotVersionsCommandInput} for command's `input` shape. + * @see {@link GetBotVersionsCommandOutput} for command's `response` shape. + * @see {@link LexModelBuildingServiceClientResolvedConfig | config} for command's `input` shape. + * */ export class GetBotVersionsCommand extends $Command< GetBotVersionsCommandInput, diff --git a/clients/client-lex-model-building-service/commands/GetBotsCommand.ts b/clients/client-lex-model-building-service/commands/GetBotsCommand.ts index 855daf9294bc..8fc1b570978c 100644 --- a/clients/client-lex-model-building-service/commands/GetBotsCommand.ts +++ b/clients/client-lex-model-building-service/commands/GetBotsCommand.ts @@ -40,6 +40,20 @@ export interface GetBotsCommandOutput extends GetBotsResponse, __MetadataBearer * *

This operation requires permission for the lex:GetBots * action.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { LexModelBuildingServiceClient, GetBotsCommand } from "@aws-sdk/client-lex-model-building-service"; // ES Modules import + * // const { LexModelBuildingServiceClient, GetBotsCommand } = require("@aws-sdk/client-lex-model-building-service"); // CommonJS import + * const client = new LexModelBuildingServiceClient(config); + * const command = new GetBotsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetBotsCommandInput} for command's `input` shape. + * @see {@link GetBotsCommandOutput} for command's `response` shape. + * @see {@link LexModelBuildingServiceClientResolvedConfig | config} for command's `input` shape. + * */ export class GetBotsCommand extends $Command< GetBotsCommandInput, diff --git a/clients/client-lex-model-building-service/commands/GetBuiltinIntentCommand.ts b/clients/client-lex-model-building-service/commands/GetBuiltinIntentCommand.ts index 41aff7f70959..05b515b98e3b 100644 --- a/clients/client-lex-model-building-service/commands/GetBuiltinIntentCommand.ts +++ b/clients/client-lex-model-building-service/commands/GetBuiltinIntentCommand.ts @@ -28,6 +28,20 @@ export interface GetBuiltinIntentCommandOutput extends GetBuiltinIntentResponse, *

Returns information about a built-in intent.

*

This operation requires permission for the * lex:GetBuiltinIntent action.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { LexModelBuildingServiceClient, GetBuiltinIntentCommand } from "@aws-sdk/client-lex-model-building-service"; // ES Modules import + * // const { LexModelBuildingServiceClient, GetBuiltinIntentCommand } = require("@aws-sdk/client-lex-model-building-service"); // CommonJS import + * const client = new LexModelBuildingServiceClient(config); + * const command = new GetBuiltinIntentCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetBuiltinIntentCommandInput} for command's `input` shape. + * @see {@link GetBuiltinIntentCommandOutput} for command's `response` shape. + * @see {@link LexModelBuildingServiceClientResolvedConfig | config} for command's `input` shape. + * */ export class GetBuiltinIntentCommand extends $Command< GetBuiltinIntentCommandInput, diff --git a/clients/client-lex-model-building-service/commands/GetBuiltinIntentsCommand.ts b/clients/client-lex-model-building-service/commands/GetBuiltinIntentsCommand.ts index ffca54d6ae53..b89679d84da5 100644 --- a/clients/client-lex-model-building-service/commands/GetBuiltinIntentsCommand.ts +++ b/clients/client-lex-model-building-service/commands/GetBuiltinIntentsCommand.ts @@ -29,6 +29,20 @@ export interface GetBuiltinIntentsCommandOutput extends GetBuiltinIntentsRespons * criteria.

*

This operation requires permission for the * lex:GetBuiltinIntents action.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { LexModelBuildingServiceClient, GetBuiltinIntentsCommand } from "@aws-sdk/client-lex-model-building-service"; // ES Modules import + * // const { LexModelBuildingServiceClient, GetBuiltinIntentsCommand } = require("@aws-sdk/client-lex-model-building-service"); // CommonJS import + * const client = new LexModelBuildingServiceClient(config); + * const command = new GetBuiltinIntentsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetBuiltinIntentsCommandInput} for command's `input` shape. + * @see {@link GetBuiltinIntentsCommandOutput} for command's `response` shape. + * @see {@link LexModelBuildingServiceClientResolvedConfig | config} for command's `input` shape. + * */ export class GetBuiltinIntentsCommand extends $Command< GetBuiltinIntentsCommandInput, diff --git a/clients/client-lex-model-building-service/commands/GetBuiltinSlotTypesCommand.ts b/clients/client-lex-model-building-service/commands/GetBuiltinSlotTypesCommand.ts index aca9f37a6121..ceabd662ebf8 100644 --- a/clients/client-lex-model-building-service/commands/GetBuiltinSlotTypesCommand.ts +++ b/clients/client-lex-model-building-service/commands/GetBuiltinSlotTypesCommand.ts @@ -32,6 +32,20 @@ export interface GetBuiltinSlotTypesCommandOutput extends GetBuiltinSlotTypesRes * *

This operation requires permission for the * lex:GetBuiltInSlotTypes action.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { LexModelBuildingServiceClient, GetBuiltinSlotTypesCommand } from "@aws-sdk/client-lex-model-building-service"; // ES Modules import + * // const { LexModelBuildingServiceClient, GetBuiltinSlotTypesCommand } = require("@aws-sdk/client-lex-model-building-service"); // CommonJS import + * const client = new LexModelBuildingServiceClient(config); + * const command = new GetBuiltinSlotTypesCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetBuiltinSlotTypesCommandInput} for command's `input` shape. + * @see {@link GetBuiltinSlotTypesCommandOutput} for command's `response` shape. + * @see {@link LexModelBuildingServiceClientResolvedConfig | config} for command's `input` shape. + * */ export class GetBuiltinSlotTypesCommand extends $Command< GetBuiltinSlotTypesCommandInput, diff --git a/clients/client-lex-model-building-service/commands/GetExportCommand.ts b/clients/client-lex-model-building-service/commands/GetExportCommand.ts index 0f259d5a58e0..1b5df692a45d 100644 --- a/clients/client-lex-model-building-service/commands/GetExportCommand.ts +++ b/clients/client-lex-model-building-service/commands/GetExportCommand.ts @@ -27,6 +27,20 @@ export interface GetExportCommandOutput extends GetExportResponse, __MetadataBea /** *

Exports the contents of a Amazon Lex resource in a specified format. *

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { LexModelBuildingServiceClient, GetExportCommand } from "@aws-sdk/client-lex-model-building-service"; // ES Modules import + * // const { LexModelBuildingServiceClient, GetExportCommand } = require("@aws-sdk/client-lex-model-building-service"); // CommonJS import + * const client = new LexModelBuildingServiceClient(config); + * const command = new GetExportCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetExportCommandInput} for command's `input` shape. + * @see {@link GetExportCommandOutput} for command's `response` shape. + * @see {@link LexModelBuildingServiceClientResolvedConfig | config} for command's `input` shape. + * */ export class GetExportCommand extends $Command< GetExportCommandInput, diff --git a/clients/client-lex-model-building-service/commands/GetImportCommand.ts b/clients/client-lex-model-building-service/commands/GetImportCommand.ts index 099cdc1b0ab1..7f1edb0c76c0 100644 --- a/clients/client-lex-model-building-service/commands/GetImportCommand.ts +++ b/clients/client-lex-model-building-service/commands/GetImportCommand.ts @@ -27,6 +27,20 @@ export interface GetImportCommandOutput extends GetImportResponse, __MetadataBea /** *

Gets information about an import job started with the * StartImport operation.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { LexModelBuildingServiceClient, GetImportCommand } from "@aws-sdk/client-lex-model-building-service"; // ES Modules import + * // const { LexModelBuildingServiceClient, GetImportCommand } = require("@aws-sdk/client-lex-model-building-service"); // CommonJS import + * const client = new LexModelBuildingServiceClient(config); + * const command = new GetImportCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetImportCommandInput} for command's `input` shape. + * @see {@link GetImportCommandOutput} for command's `response` shape. + * @see {@link LexModelBuildingServiceClientResolvedConfig | config} for command's `input` shape. + * */ export class GetImportCommand extends $Command< GetImportCommandInput, diff --git a/clients/client-lex-model-building-service/commands/GetIntentCommand.ts b/clients/client-lex-model-building-service/commands/GetIntentCommand.ts index e1be29fc5bb9..ac2a331c546f 100644 --- a/clients/client-lex-model-building-service/commands/GetIntentCommand.ts +++ b/clients/client-lex-model-building-service/commands/GetIntentCommand.ts @@ -29,6 +29,20 @@ export interface GetIntentCommandOutput extends GetIntentResponse, __MetadataBea * name, you must specify the intent version.

*

This operation requires permissions to perform the * lex:GetIntent action.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { LexModelBuildingServiceClient, GetIntentCommand } from "@aws-sdk/client-lex-model-building-service"; // ES Modules import + * // const { LexModelBuildingServiceClient, GetIntentCommand } = require("@aws-sdk/client-lex-model-building-service"); // CommonJS import + * const client = new LexModelBuildingServiceClient(config); + * const command = new GetIntentCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetIntentCommandInput} for command's `input` shape. + * @see {@link GetIntentCommandOutput} for command's `response` shape. + * @see {@link LexModelBuildingServiceClientResolvedConfig | config} for command's `input` shape. + * */ export class GetIntentCommand extends $Command< GetIntentCommandInput, diff --git a/clients/client-lex-model-building-service/commands/GetIntentVersionsCommand.ts b/clients/client-lex-model-building-service/commands/GetIntentVersionsCommand.ts index b87d9d6b4ee0..37557499486b 100644 --- a/clients/client-lex-model-building-service/commands/GetIntentVersionsCommand.ts +++ b/clients/client-lex-model-building-service/commands/GetIntentVersionsCommand.ts @@ -36,6 +36,20 @@ export interface GetIntentVersionsCommandOutput extends GetIntentVersionsRespons * least one version, the $LATEST version.

*

This operation requires permissions for the * lex:GetIntentVersions action.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { LexModelBuildingServiceClient, GetIntentVersionsCommand } from "@aws-sdk/client-lex-model-building-service"; // ES Modules import + * // const { LexModelBuildingServiceClient, GetIntentVersionsCommand } = require("@aws-sdk/client-lex-model-building-service"); // CommonJS import + * const client = new LexModelBuildingServiceClient(config); + * const command = new GetIntentVersionsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetIntentVersionsCommandInput} for command's `input` shape. + * @see {@link GetIntentVersionsCommandOutput} for command's `response` shape. + * @see {@link LexModelBuildingServiceClientResolvedConfig | config} for command's `input` shape. + * */ export class GetIntentVersionsCommand extends $Command< GetIntentVersionsCommandInput, diff --git a/clients/client-lex-model-building-service/commands/GetIntentsCommand.ts b/clients/client-lex-model-building-service/commands/GetIntentsCommand.ts index a470aa0dec05..16562a2c0708 100644 --- a/clients/client-lex-model-building-service/commands/GetIntentsCommand.ts +++ b/clients/client-lex-model-building-service/commands/GetIntentsCommand.ts @@ -40,6 +40,20 @@ export interface GetIntentsCommandOutput extends GetIntentsResponse, __MetadataB * *

The operation requires permission for the * lex:GetIntents action.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { LexModelBuildingServiceClient, GetIntentsCommand } from "@aws-sdk/client-lex-model-building-service"; // ES Modules import + * // const { LexModelBuildingServiceClient, GetIntentsCommand } = require("@aws-sdk/client-lex-model-building-service"); // CommonJS import + * const client = new LexModelBuildingServiceClient(config); + * const command = new GetIntentsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetIntentsCommandInput} for command's `input` shape. + * @see {@link GetIntentsCommandOutput} for command's `response` shape. + * @see {@link LexModelBuildingServiceClientResolvedConfig | config} for command's `input` shape. + * */ export class GetIntentsCommand extends $Command< GetIntentsCommandInput, diff --git a/clients/client-lex-model-building-service/commands/GetSlotTypeCommand.ts b/clients/client-lex-model-building-service/commands/GetSlotTypeCommand.ts index 13b411888a97..bbd00078387f 100644 --- a/clients/client-lex-model-building-service/commands/GetSlotTypeCommand.ts +++ b/clients/client-lex-model-building-service/commands/GetSlotTypeCommand.ts @@ -30,6 +30,20 @@ export interface GetSlotTypeCommandOutput extends GetSlotTypeResponse, __Metadat * version.

*

This operation requires permissions for the * lex:GetSlotType action.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { LexModelBuildingServiceClient, GetSlotTypeCommand } from "@aws-sdk/client-lex-model-building-service"; // ES Modules import + * // const { LexModelBuildingServiceClient, GetSlotTypeCommand } = require("@aws-sdk/client-lex-model-building-service"); // CommonJS import + * const client = new LexModelBuildingServiceClient(config); + * const command = new GetSlotTypeCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetSlotTypeCommandInput} for command's `input` shape. + * @see {@link GetSlotTypeCommandOutput} for command's `response` shape. + * @see {@link LexModelBuildingServiceClientResolvedConfig | config} for command's `input` shape. + * */ export class GetSlotTypeCommand extends $Command< GetSlotTypeCommandInput, diff --git a/clients/client-lex-model-building-service/commands/GetSlotTypeVersionsCommand.ts b/clients/client-lex-model-building-service/commands/GetSlotTypeVersionsCommand.ts index 98a19b5adf18..e851dadcc354 100644 --- a/clients/client-lex-model-building-service/commands/GetSlotTypeVersionsCommand.ts +++ b/clients/client-lex-model-building-service/commands/GetSlotTypeVersionsCommand.ts @@ -36,6 +36,20 @@ export interface GetSlotTypeVersionsCommandOutput extends GetSlotTypeVersionsRes * least one version, the $LATEST version.

*

This operation requires permissions for the * lex:GetSlotTypeVersions action.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { LexModelBuildingServiceClient, GetSlotTypeVersionsCommand } from "@aws-sdk/client-lex-model-building-service"; // ES Modules import + * // const { LexModelBuildingServiceClient, GetSlotTypeVersionsCommand } = require("@aws-sdk/client-lex-model-building-service"); // CommonJS import + * const client = new LexModelBuildingServiceClient(config); + * const command = new GetSlotTypeVersionsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetSlotTypeVersionsCommandInput} for command's `input` shape. + * @see {@link GetSlotTypeVersionsCommandOutput} for command's `response` shape. + * @see {@link LexModelBuildingServiceClientResolvedConfig | config} for command's `input` shape. + * */ export class GetSlotTypeVersionsCommand extends $Command< GetSlotTypeVersionsCommandInput, diff --git a/clients/client-lex-model-building-service/commands/GetSlotTypesCommand.ts b/clients/client-lex-model-building-service/commands/GetSlotTypesCommand.ts index bed769e43f66..48a96eff5366 100644 --- a/clients/client-lex-model-building-service/commands/GetSlotTypesCommand.ts +++ b/clients/client-lex-model-building-service/commands/GetSlotTypesCommand.ts @@ -40,6 +40,20 @@ export interface GetSlotTypesCommandOutput extends GetSlotTypesResponse, __Metad * *

The operation requires permission for the * lex:GetSlotTypes action.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { LexModelBuildingServiceClient, GetSlotTypesCommand } from "@aws-sdk/client-lex-model-building-service"; // ES Modules import + * // const { LexModelBuildingServiceClient, GetSlotTypesCommand } = require("@aws-sdk/client-lex-model-building-service"); // CommonJS import + * const client = new LexModelBuildingServiceClient(config); + * const command = new GetSlotTypesCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetSlotTypesCommandInput} for command's `input` shape. + * @see {@link GetSlotTypesCommandOutput} for command's `response` shape. + * @see {@link LexModelBuildingServiceClientResolvedConfig | config} for command's `input` shape. + * */ export class GetSlotTypesCommand extends $Command< GetSlotTypesCommandInput, diff --git a/clients/client-lex-model-building-service/commands/GetUtterancesViewCommand.ts b/clients/client-lex-model-building-service/commands/GetUtterancesViewCommand.ts index 1efb9ff8c72f..dcde42b2a5b2 100644 --- a/clients/client-lex-model-building-service/commands/GetUtterancesViewCommand.ts +++ b/clients/client-lex-model-building-service/commands/GetUtterancesViewCommand.ts @@ -48,6 +48,20 @@ export interface GetUtterancesViewCommandOutput extends GetUtterancesViewRespons * utterances are not available.

*

This operation requires permissions for the * lex:GetUtterancesView action.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { LexModelBuildingServiceClient, GetUtterancesViewCommand } from "@aws-sdk/client-lex-model-building-service"; // ES Modules import + * // const { LexModelBuildingServiceClient, GetUtterancesViewCommand } = require("@aws-sdk/client-lex-model-building-service"); // CommonJS import + * const client = new LexModelBuildingServiceClient(config); + * const command = new GetUtterancesViewCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetUtterancesViewCommandInput} for command's `input` shape. + * @see {@link GetUtterancesViewCommandOutput} for command's `response` shape. + * @see {@link LexModelBuildingServiceClientResolvedConfig | config} for command's `input` shape. + * */ export class GetUtterancesViewCommand extends $Command< GetUtterancesViewCommandInput, diff --git a/clients/client-lex-model-building-service/commands/ListTagsForResourceCommand.ts b/clients/client-lex-model-building-service/commands/ListTagsForResourceCommand.ts index 5bb190a1c0b1..134b1cb48134 100644 --- a/clients/client-lex-model-building-service/commands/ListTagsForResourceCommand.ts +++ b/clients/client-lex-model-building-service/commands/ListTagsForResourceCommand.ts @@ -27,6 +27,20 @@ export interface ListTagsForResourceCommandOutput extends ListTagsForResourceRes /** *

Gets a list of tags associated with the specified resource. Only bots, * bot aliases, and bot channels can have tags associated with them.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { LexModelBuildingServiceClient, ListTagsForResourceCommand } from "@aws-sdk/client-lex-model-building-service"; // ES Modules import + * // const { LexModelBuildingServiceClient, ListTagsForResourceCommand } = require("@aws-sdk/client-lex-model-building-service"); // CommonJS import + * const client = new LexModelBuildingServiceClient(config); + * const command = new ListTagsForResourceCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListTagsForResourceCommandInput} for command's `input` shape. + * @see {@link ListTagsForResourceCommandOutput} for command's `response` shape. + * @see {@link LexModelBuildingServiceClientResolvedConfig | config} for command's `input` shape. + * */ export class ListTagsForResourceCommand extends $Command< ListTagsForResourceCommandInput, diff --git a/clients/client-lex-model-building-service/commands/PutBotAliasCommand.ts b/clients/client-lex-model-building-service/commands/PutBotAliasCommand.ts index f5d974a69e5d..9eb85bac8e07 100644 --- a/clients/client-lex-model-building-service/commands/PutBotAliasCommand.ts +++ b/clients/client-lex-model-building-service/commands/PutBotAliasCommand.ts @@ -31,6 +31,20 @@ export interface PutBotAliasCommandOutput extends PutBotAliasResponse, __Metadat * see versioning-aliases.

*

This operation requires permissions for the * lex:PutBotAlias action.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { LexModelBuildingServiceClient, PutBotAliasCommand } from "@aws-sdk/client-lex-model-building-service"; // ES Modules import + * // const { LexModelBuildingServiceClient, PutBotAliasCommand } = require("@aws-sdk/client-lex-model-building-service"); // CommonJS import + * const client = new LexModelBuildingServiceClient(config); + * const command = new PutBotAliasCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link PutBotAliasCommandInput} for command's `input` shape. + * @see {@link PutBotAliasCommandOutput} for command's `response` shape. + * @see {@link LexModelBuildingServiceClientResolvedConfig | config} for command's `input` shape. + * */ export class PutBotAliasCommand extends $Command< PutBotAliasCommandInput, diff --git a/clients/client-lex-model-building-service/commands/PutBotCommand.ts b/clients/client-lex-model-building-service/commands/PutBotCommand.ts index 6348611db0aa..8edabd116851 100644 --- a/clients/client-lex-model-building-service/commands/PutBotCommand.ts +++ b/clients/client-lex-model-building-service/commands/PutBotCommand.ts @@ -40,6 +40,20 @@ export interface PutBotCommandOutput extends PutBotResponse, __MetadataBearer {} * *

This operation requires permissions for the lex:PutBot * action. For more information, see security-iam.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { LexModelBuildingServiceClient, PutBotCommand } from "@aws-sdk/client-lex-model-building-service"; // ES Modules import + * // const { LexModelBuildingServiceClient, PutBotCommand } = require("@aws-sdk/client-lex-model-building-service"); // CommonJS import + * const client = new LexModelBuildingServiceClient(config); + * const command = new PutBotCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link PutBotCommandInput} for command's `input` shape. + * @see {@link PutBotCommandOutput} for command's `response` shape. + * @see {@link LexModelBuildingServiceClientResolvedConfig | config} for command's `input` shape. + * */ export class PutBotCommand extends $Command< PutBotCommandInput, diff --git a/clients/client-lex-model-building-service/commands/PutIntentCommand.ts b/clients/client-lex-model-building-service/commands/PutIntentCommand.ts index c9a278031bf4..d4b941b31dbd 100644 --- a/clients/client-lex-model-building-service/commands/PutIntentCommand.ts +++ b/clients/client-lex-model-building-service/commands/PutIntentCommand.ts @@ -83,6 +83,20 @@ export interface PutIntentCommandOutput extends PutIntentResponse, __MetadataBea *

For more information, see how-it-works.

*

This operation requires permissions for the * lex:PutIntent action.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { LexModelBuildingServiceClient, PutIntentCommand } from "@aws-sdk/client-lex-model-building-service"; // ES Modules import + * // const { LexModelBuildingServiceClient, PutIntentCommand } = require("@aws-sdk/client-lex-model-building-service"); // CommonJS import + * const client = new LexModelBuildingServiceClient(config); + * const command = new PutIntentCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link PutIntentCommandInput} for command's `input` shape. + * @see {@link PutIntentCommandOutput} for command's `response` shape. + * @see {@link LexModelBuildingServiceClientResolvedConfig | config} for command's `input` shape. + * */ export class PutIntentCommand extends $Command< PutIntentCommandInput, diff --git a/clients/client-lex-model-building-service/commands/PutSlotTypeCommand.ts b/clients/client-lex-model-building-service/commands/PutSlotTypeCommand.ts index fa8d211cdf5d..7389f6067544 100644 --- a/clients/client-lex-model-building-service/commands/PutSlotTypeCommand.ts +++ b/clients/client-lex-model-building-service/commands/PutSlotTypeCommand.ts @@ -41,6 +41,20 @@ export interface PutSlotTypeCommandOutput extends PutSlotTypeResponse, __Metadat * *

This operation requires permissions for the * lex:PutSlotType action.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { LexModelBuildingServiceClient, PutSlotTypeCommand } from "@aws-sdk/client-lex-model-building-service"; // ES Modules import + * // const { LexModelBuildingServiceClient, PutSlotTypeCommand } = require("@aws-sdk/client-lex-model-building-service"); // CommonJS import + * const client = new LexModelBuildingServiceClient(config); + * const command = new PutSlotTypeCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link PutSlotTypeCommandInput} for command's `input` shape. + * @see {@link PutSlotTypeCommandOutput} for command's `response` shape. + * @see {@link LexModelBuildingServiceClientResolvedConfig | config} for command's `input` shape. + * */ export class PutSlotTypeCommand extends $Command< PutSlotTypeCommandInput, diff --git a/clients/client-lex-model-building-service/commands/StartImportCommand.ts b/clients/client-lex-model-building-service/commands/StartImportCommand.ts index 9ab01738b332..c6f3010f5fe2 100644 --- a/clients/client-lex-model-building-service/commands/StartImportCommand.ts +++ b/clients/client-lex-model-building-service/commands/StartImportCommand.ts @@ -26,6 +26,20 @@ export interface StartImportCommandOutput extends StartImportResponse, __Metadat /** *

Starts a job to import a resource to Amazon Lex.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { LexModelBuildingServiceClient, StartImportCommand } from "@aws-sdk/client-lex-model-building-service"; // ES Modules import + * // const { LexModelBuildingServiceClient, StartImportCommand } = require("@aws-sdk/client-lex-model-building-service"); // CommonJS import + * const client = new LexModelBuildingServiceClient(config); + * const command = new StartImportCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link StartImportCommandInput} for command's `input` shape. + * @see {@link StartImportCommandOutput} for command's `response` shape. + * @see {@link LexModelBuildingServiceClientResolvedConfig | config} for command's `input` shape. + * */ export class StartImportCommand extends $Command< StartImportCommandInput, diff --git a/clients/client-lex-model-building-service/commands/TagResourceCommand.ts b/clients/client-lex-model-building-service/commands/TagResourceCommand.ts index cdb33207a013..7d4a4bd65d5f 100644 --- a/clients/client-lex-model-building-service/commands/TagResourceCommand.ts +++ b/clients/client-lex-model-building-service/commands/TagResourceCommand.ts @@ -27,6 +27,20 @@ export interface TagResourceCommandOutput extends TagResourceResponse, __Metadat /** *

Adds the specified tags to the specified resource. If a tag key * already exists, the existing value is replaced with the new value.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { LexModelBuildingServiceClient, TagResourceCommand } from "@aws-sdk/client-lex-model-building-service"; // ES Modules import + * // const { LexModelBuildingServiceClient, TagResourceCommand } = require("@aws-sdk/client-lex-model-building-service"); // CommonJS import + * const client = new LexModelBuildingServiceClient(config); + * const command = new TagResourceCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link TagResourceCommandInput} for command's `input` shape. + * @see {@link TagResourceCommandOutput} for command's `response` shape. + * @see {@link LexModelBuildingServiceClientResolvedConfig | config} for command's `input` shape. + * */ export class TagResourceCommand extends $Command< TagResourceCommandInput, diff --git a/clients/client-lex-model-building-service/commands/UntagResourceCommand.ts b/clients/client-lex-model-building-service/commands/UntagResourceCommand.ts index 9dc3d20c1e60..5e026058dffb 100644 --- a/clients/client-lex-model-building-service/commands/UntagResourceCommand.ts +++ b/clients/client-lex-model-building-service/commands/UntagResourceCommand.ts @@ -26,6 +26,20 @@ export interface UntagResourceCommandOutput extends UntagResourceResponse, __Met /** *

Removes tags from a bot, bot alias or bot channel.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { LexModelBuildingServiceClient, UntagResourceCommand } from "@aws-sdk/client-lex-model-building-service"; // ES Modules import + * // const { LexModelBuildingServiceClient, UntagResourceCommand } = require("@aws-sdk/client-lex-model-building-service"); // CommonJS import + * const client = new LexModelBuildingServiceClient(config); + * const command = new UntagResourceCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link UntagResourceCommandInput} for command's `input` shape. + * @see {@link UntagResourceCommandOutput} for command's `response` shape. + * @see {@link LexModelBuildingServiceClientResolvedConfig | config} for command's `input` shape. + * */ export class UntagResourceCommand extends $Command< UntagResourceCommandInput, diff --git a/clients/client-lex-model-building-service/models/models_0.ts b/clients/client-lex-model-building-service/models/models_0.ts index 7c4a84d77053..003d854c9957 100644 --- a/clients/client-lex-model-building-service/models/models_0.ts +++ b/clients/client-lex-model-building-service/models/models_0.ts @@ -13,6 +13,9 @@ export interface BadRequestException extends __SmithyException, $MetadataBearer } export namespace BadRequestException { + /** + * @internal + */ export const filterSensitiveLog = (obj: BadRequestException): any => ({ ...obj, }); @@ -29,6 +32,9 @@ export interface ConflictException extends __SmithyException, $MetadataBearer { } export namespace ConflictException { + /** + * @internal + */ export const filterSensitiveLog = (obj: ConflictException): any => ({ ...obj, }); @@ -53,6 +59,9 @@ export interface CreateBotVersionRequest { } export namespace CreateBotVersionRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateBotVersionRequest): any => ({ ...obj, }); @@ -88,6 +97,9 @@ export interface Message { } export namespace Message { + /** + * @internal + */ export const filterSensitiveLog = (obj: Message): any => ({ ...obj, }); @@ -112,6 +124,9 @@ export interface Statement { } export namespace Statement { + /** + * @internal + */ export const filterSensitiveLog = (obj: Statement): any => ({ ...obj, }); @@ -146,6 +161,9 @@ export interface Prompt { } export namespace Prompt { + /** + * @internal + */ export const filterSensitiveLog = (obj: Prompt): any => ({ ...obj, }); @@ -167,6 +185,9 @@ export interface Intent { } export namespace Intent { + /** + * @internal + */ export const filterSensitiveLog = (obj: Intent): any => ({ ...obj, }); @@ -323,6 +344,9 @@ export interface CreateBotVersionResponse { } export namespace CreateBotVersionResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateBotVersionResponse): any => ({ ...obj, }); @@ -338,6 +362,9 @@ export interface InternalFailureException extends __SmithyException, $MetadataBe } export namespace InternalFailureException { + /** + * @internal + */ export const filterSensitiveLog = (obj: InternalFailureException): any => ({ ...obj, }); @@ -354,6 +381,9 @@ export interface LimitExceededException extends __SmithyException, $MetadataBear } export namespace LimitExceededException { + /** + * @internal + */ export const filterSensitiveLog = (obj: LimitExceededException): any => ({ ...obj, }); @@ -370,6 +400,9 @@ export interface NotFoundException extends __SmithyException, $MetadataBearer { } export namespace NotFoundException { + /** + * @internal + */ export const filterSensitiveLog = (obj: NotFoundException): any => ({ ...obj, }); @@ -387,6 +420,9 @@ export interface PreconditionFailedException extends __SmithyException, $Metadat } export namespace PreconditionFailedException { + /** + * @internal + */ export const filterSensitiveLog = (obj: PreconditionFailedException): any => ({ ...obj, }); @@ -411,6 +447,9 @@ export interface CreateIntentVersionRequest { } export namespace CreateIntentVersionRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateIntentVersionRequest): any => ({ ...obj, }); @@ -434,6 +473,9 @@ export interface CodeHook { } export namespace CodeHook { + /** + * @internal + */ export const filterSensitiveLog = (obj: CodeHook): any => ({ ...obj, }); @@ -460,6 +502,9 @@ export interface FollowUpPrompt { } export namespace FollowUpPrompt { + /** + * @internal + */ export const filterSensitiveLog = (obj: FollowUpPrompt): any => ({ ...obj, }); @@ -512,6 +557,9 @@ export interface FulfillmentActivity { } export namespace FulfillmentActivity { + /** + * @internal + */ export const filterSensitiveLog = (obj: FulfillmentActivity): any => ({ ...obj, }); @@ -529,6 +577,9 @@ export interface InputContext { } export namespace InputContext { + /** + * @internal + */ export const filterSensitiveLog = (obj: InputContext): any => ({ ...obj, }); @@ -571,6 +622,9 @@ export interface KendraConfiguration { } export namespace KendraConfiguration { + /** + * @internal + */ export const filterSensitiveLog = (obj: KendraConfiguration): any => ({ ...obj, }); @@ -603,6 +657,9 @@ export interface OutputContext { } export namespace OutputContext { + /** + * @internal + */ export const filterSensitiveLog = (obj: OutputContext): any => ({ ...obj, }); @@ -636,6 +693,9 @@ export interface SlotDefaultValue { } export namespace SlotDefaultValue { + /** + * @internal + */ export const filterSensitiveLog = (obj: SlotDefaultValue): any => ({ ...obj, }); @@ -659,6 +719,9 @@ export interface SlotDefaultValueSpec { } export namespace SlotDefaultValueSpec { + /** + * @internal + */ export const filterSensitiveLog = (obj: SlotDefaultValueSpec): any => ({ ...obj, }); @@ -753,6 +816,9 @@ export interface Slot { } export namespace Slot { + /** + * @internal + */ export const filterSensitiveLog = (obj: Slot): any => ({ ...obj, }); @@ -864,6 +930,9 @@ export interface CreateIntentVersionResponse { } export namespace CreateIntentVersionResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateIntentVersionResponse): any => ({ ...obj, }); @@ -888,6 +957,9 @@ export interface CreateSlotTypeVersionRequest { } export namespace CreateSlotTypeVersionRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateSlotTypeVersionRequest): any => ({ ...obj, }); @@ -924,6 +996,9 @@ export interface EnumerationValue { } export namespace EnumerationValue { + /** + * @internal + */ export const filterSensitiveLog = (obj: EnumerationValue): any => ({ ...obj, }); @@ -965,6 +1040,9 @@ export interface SlotTypeRegexConfiguration { } export namespace SlotTypeRegexConfiguration { + /** + * @internal + */ export const filterSensitiveLog = (obj: SlotTypeRegexConfiguration): any => ({ ...obj, }); @@ -981,6 +1059,9 @@ export interface SlotTypeConfiguration { } export namespace SlotTypeConfiguration { + /** + * @internal + */ export const filterSensitiveLog = (obj: SlotTypeConfiguration): any => ({ ...obj, }); @@ -1049,6 +1130,9 @@ export interface CreateSlotTypeVersionResponse { } export namespace CreateSlotTypeVersionResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateSlotTypeVersionResponse): any => ({ ...obj, }); @@ -1062,6 +1146,9 @@ export interface DeleteBotRequest { } export namespace DeleteBotRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteBotRequest): any => ({ ...obj, }); @@ -1087,6 +1174,9 @@ export interface ResourceReference { } export namespace ResourceReference { + /** + * @internal + */ export const filterSensitiveLog = (obj: ResourceReference): any => ({ ...obj, }); @@ -1130,6 +1220,9 @@ export interface ResourceInUseException extends __SmithyException, $MetadataBear } export namespace ResourceInUseException { + /** + * @internal + */ export const filterSensitiveLog = (obj: ResourceInUseException): any => ({ ...obj, }); @@ -1149,6 +1242,9 @@ export interface DeleteBotAliasRequest { } export namespace DeleteBotAliasRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteBotAliasRequest): any => ({ ...obj, }); @@ -1173,6 +1269,9 @@ export interface DeleteBotChannelAssociationRequest { } export namespace DeleteBotChannelAssociationRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteBotChannelAssociationRequest): any => ({ ...obj, }); @@ -1194,6 +1293,9 @@ export interface DeleteBotVersionRequest { } export namespace DeleteBotVersionRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteBotVersionRequest): any => ({ ...obj, }); @@ -1207,6 +1309,9 @@ export interface DeleteIntentRequest { } export namespace DeleteIntentRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteIntentRequest): any => ({ ...obj, }); @@ -1228,6 +1333,9 @@ export interface DeleteIntentVersionRequest { } export namespace DeleteIntentVersionRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteIntentVersionRequest): any => ({ ...obj, }); @@ -1241,6 +1349,9 @@ export interface DeleteSlotTypeRequest { } export namespace DeleteSlotTypeRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteSlotTypeRequest): any => ({ ...obj, }); @@ -1262,6 +1373,9 @@ export interface DeleteSlotTypeVersionRequest { } export namespace DeleteSlotTypeVersionRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteSlotTypeVersionRequest): any => ({ ...obj, }); @@ -1282,6 +1396,9 @@ export interface DeleteUtterancesRequest { } export namespace DeleteUtterancesRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteUtterancesRequest): any => ({ ...obj, }); @@ -1300,6 +1417,9 @@ export interface GetBotRequest { } export namespace GetBotRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetBotRequest): any => ({ ...obj, }); @@ -1454,6 +1574,9 @@ export interface GetBotResponse { } export namespace GetBotResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetBotResponse): any => ({ ...obj, }); @@ -1472,6 +1595,9 @@ export interface GetBotAliasRequest { } export namespace GetBotAliasRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetBotAliasRequest): any => ({ ...obj, }); @@ -1523,6 +1649,9 @@ export interface LogSettingsResponse { } export namespace LogSettingsResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: LogSettingsResponse): any => ({ ...obj, }); @@ -1546,6 +1675,9 @@ export interface ConversationLogsResponse { } export namespace ConversationLogsResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ConversationLogsResponse): any => ({ ...obj, }); @@ -1597,6 +1729,9 @@ export interface GetBotAliasResponse { } export namespace GetBotAliasResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetBotAliasResponse): any => ({ ...obj, }); @@ -1631,6 +1766,9 @@ export interface GetBotAliasesRequest { } export namespace GetBotAliasesRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetBotAliasesRequest): any => ({ ...obj, }); @@ -1684,6 +1822,9 @@ export interface BotAliasMetadata { } export namespace BotAliasMetadata { + /** + * @internal + */ export const filterSensitiveLog = (obj: BotAliasMetadata): any => ({ ...obj, }); @@ -1706,6 +1847,9 @@ export interface GetBotAliasesResponse { } export namespace GetBotAliasesResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetBotAliasesResponse): any => ({ ...obj, }); @@ -1731,6 +1875,9 @@ export interface GetBotChannelAssociationRequest { } export namespace GetBotChannelAssociationRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetBotChannelAssociationRequest): any => ({ ...obj, }); @@ -1821,6 +1968,9 @@ export interface GetBotChannelAssociationResponse { } export namespace GetBotChannelAssociationResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetBotChannelAssociationResponse): any => ({ ...obj, ...(obj.botConfiguration && { botConfiguration: SENSITIVE_STRING }), @@ -1864,6 +2014,9 @@ export interface GetBotChannelAssociationsRequest { } export namespace GetBotChannelAssociationsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetBotChannelAssociationsRequest): any => ({ ...obj, }); @@ -1951,6 +2104,9 @@ export interface BotChannelAssociation { } export namespace BotChannelAssociation { + /** + * @internal + */ export const filterSensitiveLog = (obj: BotChannelAssociation): any => ({ ...obj, ...(obj.botConfiguration && { botConfiguration: SENSITIVE_STRING }), @@ -1975,6 +2131,9 @@ export interface GetBotChannelAssociationsResponse { } export namespace GetBotChannelAssociationsResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetBotChannelAssociationsResponse): any => ({ ...obj, ...(obj.botChannelAssociations && { @@ -2007,6 +2166,9 @@ export interface GetBotsRequest { } export namespace GetBotsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetBotsRequest): any => ({ ...obj, }); @@ -2050,6 +2212,9 @@ export interface BotMetadata { } export namespace BotMetadata { + /** + * @internal + */ export const filterSensitiveLog = (obj: BotMetadata): any => ({ ...obj, }); @@ -2071,6 +2236,9 @@ export interface GetBotsResponse { } export namespace GetBotsResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetBotsResponse): any => ({ ...obj, }); @@ -2099,6 +2267,9 @@ export interface GetBotVersionsRequest { } export namespace GetBotVersionsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetBotVersionsRequest): any => ({ ...obj, }); @@ -2122,6 +2293,9 @@ export interface GetBotVersionsResponse { } export namespace GetBotVersionsResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetBotVersionsResponse): any => ({ ...obj, }); @@ -2137,6 +2311,9 @@ export interface GetBuiltinIntentRequest { } export namespace GetBuiltinIntentRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetBuiltinIntentRequest): any => ({ ...obj, }); @@ -2154,6 +2331,9 @@ export interface BuiltinIntentSlot { } export namespace BuiltinIntentSlot { + /** + * @internal + */ export const filterSensitiveLog = (obj: BuiltinIntentSlot): any => ({ ...obj, }); @@ -2178,6 +2358,9 @@ export interface GetBuiltinIntentResponse { } export namespace GetBuiltinIntentResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetBuiltinIntentResponse): any => ({ ...obj, }); @@ -2214,6 +2397,9 @@ export interface GetBuiltinIntentsRequest { } export namespace GetBuiltinIntentsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetBuiltinIntentsRequest): any => ({ ...obj, }); @@ -2238,6 +2424,9 @@ export interface BuiltinIntentMetadata { } export namespace BuiltinIntentMetadata { + /** + * @internal + */ export const filterSensitiveLog = (obj: BuiltinIntentMetadata): any => ({ ...obj, }); @@ -2260,6 +2449,9 @@ export interface GetBuiltinIntentsResponse { } export namespace GetBuiltinIntentsResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetBuiltinIntentsResponse): any => ({ ...obj, }); @@ -2294,6 +2486,9 @@ export interface GetBuiltinSlotTypesRequest { } export namespace GetBuiltinSlotTypesRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetBuiltinSlotTypesRequest): any => ({ ...obj, }); @@ -2317,6 +2512,9 @@ export interface BuiltinSlotTypeMetadata { } export namespace BuiltinSlotTypeMetadata { + /** + * @internal + */ export const filterSensitiveLog = (obj: BuiltinSlotTypeMetadata): any => ({ ...obj, }); @@ -2338,6 +2536,9 @@ export interface GetBuiltinSlotTypesResponse { } export namespace GetBuiltinSlotTypesResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetBuiltinSlotTypesResponse): any => ({ ...obj, }); @@ -2377,6 +2578,9 @@ export interface GetExportRequest { } export namespace GetExportRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetExportRequest): any => ({ ...obj, }); @@ -2445,6 +2649,9 @@ export interface GetExportResponse { } export namespace GetExportResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetExportResponse): any => ({ ...obj, }); @@ -2458,6 +2665,9 @@ export interface GetImportRequest { } export namespace GetImportRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetImportRequest): any => ({ ...obj, }); @@ -2517,6 +2727,9 @@ export interface GetImportResponse { } export namespace GetImportResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetImportResponse): any => ({ ...obj, }); @@ -2535,6 +2748,9 @@ export interface GetIntentRequest { } export namespace GetIntentRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetIntentRequest): any => ({ ...obj, }); @@ -2647,6 +2863,9 @@ export interface GetIntentResponse { } export namespace GetIntentResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetIntentResponse): any => ({ ...obj, }); @@ -2676,6 +2895,9 @@ export interface GetIntentsRequest { } export namespace GetIntentsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetIntentsRequest): any => ({ ...obj, }); @@ -2713,6 +2935,9 @@ export interface IntentMetadata { } export namespace IntentMetadata { + /** + * @internal + */ export const filterSensitiveLog = (obj: IntentMetadata): any => ({ ...obj, }); @@ -2734,6 +2959,9 @@ export interface GetIntentsResponse { } export namespace GetIntentsResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetIntentsResponse): any => ({ ...obj, }); @@ -2762,6 +2990,9 @@ export interface GetIntentVersionsRequest { } export namespace GetIntentVersionsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetIntentVersionsRequest): any => ({ ...obj, }); @@ -2785,6 +3016,9 @@ export interface GetIntentVersionsResponse { } export namespace GetIntentVersionsResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetIntentVersionsResponse): any => ({ ...obj, }); @@ -2803,6 +3037,9 @@ export interface GetSlotTypeRequest { } export namespace GetSlotTypeRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetSlotTypeRequest): any => ({ ...obj, }); @@ -2866,6 +3103,9 @@ export interface GetSlotTypeResponse { } export namespace GetSlotTypeResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetSlotTypeResponse): any => ({ ...obj, }); @@ -2895,6 +3135,9 @@ export interface GetSlotTypesRequest { } export namespace GetSlotTypesRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetSlotTypesRequest): any => ({ ...obj, }); @@ -2932,6 +3175,9 @@ export interface SlotTypeMetadata { } export namespace SlotTypeMetadata { + /** + * @internal + */ export const filterSensitiveLog = (obj: SlotTypeMetadata): any => ({ ...obj, }); @@ -2954,6 +3200,9 @@ export interface GetSlotTypesResponse { } export namespace GetSlotTypesResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetSlotTypesResponse): any => ({ ...obj, }); @@ -2982,6 +3231,9 @@ export interface GetSlotTypeVersionsRequest { } export namespace GetSlotTypeVersionsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetSlotTypeVersionsRequest): any => ({ ...obj, }); @@ -3005,6 +3257,9 @@ export interface GetSlotTypeVersionsResponse { } export namespace GetSlotTypeVersionsResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetSlotTypeVersionsResponse): any => ({ ...obj, }); @@ -3037,6 +3292,9 @@ export interface GetUtterancesViewRequest { } export namespace GetUtterancesViewRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetUtterancesViewRequest): any => ({ ...obj, }); @@ -3075,6 +3333,9 @@ export interface UtteranceData { } export namespace UtteranceData { + /** + * @internal + */ export const filterSensitiveLog = (obj: UtteranceData): any => ({ ...obj, }); @@ -3100,6 +3361,9 @@ export interface UtteranceList { } export namespace UtteranceList { + /** + * @internal + */ export const filterSensitiveLog = (obj: UtteranceList): any => ({ ...obj, }); @@ -3124,6 +3388,9 @@ export interface GetUtterancesViewResponse { } export namespace GetUtterancesViewResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetUtterancesViewResponse): any => ({ ...obj, }); @@ -3138,6 +3405,9 @@ export interface ListTagsForResourceRequest { } export namespace ListTagsForResourceRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListTagsForResourceRequest): any => ({ ...obj, }); @@ -3163,6 +3433,9 @@ export interface Tag { } export namespace Tag { + /** + * @internal + */ export const filterSensitiveLog = (obj: Tag): any => ({ ...obj, }); @@ -3176,6 +3449,9 @@ export interface ListTagsForResourceResponse { } export namespace ListTagsForResourceResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListTagsForResourceResponse): any => ({ ...obj, }); @@ -3465,6 +3741,9 @@ export interface PutBotRequest { } export namespace PutBotRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: PutBotRequest): any => ({ ...obj, }); @@ -3637,6 +3916,9 @@ export interface PutBotResponse { } export namespace PutBotResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: PutBotResponse): any => ({ ...obj, }); @@ -3675,6 +3957,9 @@ export interface LogSettingsRequest { } export namespace LogSettingsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: LogSettingsRequest): any => ({ ...obj, }); @@ -3702,6 +3987,9 @@ export interface ConversationLogsRequest { } export namespace ConversationLogsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ConversationLogsRequest): any => ({ ...obj, }); @@ -3759,6 +4047,9 @@ export interface PutBotAliasRequest { } export namespace PutBotAliasRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: PutBotAliasRequest): any => ({ ...obj, }); @@ -3815,6 +4106,9 @@ export interface PutBotAliasResponse { } export namespace PutBotAliasResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: PutBotAliasResponse): any => ({ ...obj, }); @@ -4004,6 +4298,9 @@ export interface PutIntentRequest { } export namespace PutIntentRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: PutIntentRequest): any => ({ ...obj, }); @@ -4131,6 +4428,9 @@ export interface PutIntentResponse { } export namespace PutIntentResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: PutIntentResponse): any => ({ ...obj, }); @@ -4234,6 +4534,9 @@ export interface PutSlotTypeRequest { } export namespace PutSlotTypeRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: PutSlotTypeRequest): any => ({ ...obj, }); @@ -4307,6 +4610,9 @@ export interface PutSlotTypeResponse { } export namespace PutSlotTypeResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: PutSlotTypeResponse): any => ({ ...obj, }); @@ -4362,6 +4668,9 @@ export interface StartImportRequest { } export namespace StartImportRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: StartImportRequest): any => ({ ...obj, }); @@ -4408,6 +4717,9 @@ export interface StartImportResponse { } export namespace StartImportResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: StartImportResponse): any => ({ ...obj, }); @@ -4428,6 +4740,9 @@ export interface TagResourceRequest { } export namespace TagResourceRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: TagResourceRequest): any => ({ ...obj, }); @@ -4436,6 +4751,9 @@ export namespace TagResourceRequest { export interface TagResourceResponse {} export namespace TagResourceResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: TagResourceResponse): any => ({ ...obj, }); @@ -4456,6 +4774,9 @@ export interface UntagResourceRequest { } export namespace UntagResourceRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: UntagResourceRequest): any => ({ ...obj, }); @@ -4464,6 +4785,9 @@ export namespace UntagResourceRequest { export interface UntagResourceResponse {} export namespace UntagResourceResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: UntagResourceResponse): any => ({ ...obj, }); diff --git a/clients/client-lex-models-v2/commands/BuildBotLocaleCommand.ts b/clients/client-lex-models-v2/commands/BuildBotLocaleCommand.ts index b375453a24b1..fe5eba0cbbcd 100644 --- a/clients/client-lex-models-v2/commands/BuildBotLocaleCommand.ts +++ b/clients/client-lex-models-v2/commands/BuildBotLocaleCommand.ts @@ -24,6 +24,20 @@ export interface BuildBotLocaleCommandOutput extends BuildBotLocaleResponse, __M *

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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { LexModelsV2Client, BuildBotLocaleCommand } from "@aws-sdk/client-lex-models-v2"; // ES Modules import + * // const { LexModelsV2Client, BuildBotLocaleCommand } = require("@aws-sdk/client-lex-models-v2"); // CommonJS import + * const client = new LexModelsV2Client(config); + * const command = new BuildBotLocaleCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link BuildBotLocaleCommandInput} for command's `input` shape. + * @see {@link BuildBotLocaleCommandOutput} for command's `response` shape. + * @see {@link LexModelsV2ClientResolvedConfig | config} for command's `input` shape. + * */ export class BuildBotLocaleCommand extends $Command< BuildBotLocaleCommandInput, diff --git a/clients/client-lex-models-v2/commands/CreateBotAliasCommand.ts b/clients/client-lex-models-v2/commands/CreateBotAliasCommand.ts index c754681df1da..d2c32f7bd962 100644 --- a/clients/client-lex-models-v2/commands/CreateBotAliasCommand.ts +++ b/clients/client-lex-models-v2/commands/CreateBotAliasCommand.ts @@ -26,6 +26,20 @@ export interface CreateBotAliasCommandOutput extends CreateBotAliasResponse, __M * that use the bot.

*

For example, you can create an alias called "PROD" that your * applications use to call the Amazon Lex bot.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { LexModelsV2Client, CreateBotAliasCommand } from "@aws-sdk/client-lex-models-v2"; // ES Modules import + * // const { LexModelsV2Client, CreateBotAliasCommand } = require("@aws-sdk/client-lex-models-v2"); // CommonJS import + * const client = new LexModelsV2Client(config); + * const command = new CreateBotAliasCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreateBotAliasCommandInput} for command's `input` shape. + * @see {@link CreateBotAliasCommandOutput} for command's `response` shape. + * @see {@link LexModelsV2ClientResolvedConfig | config} for command's `input` shape. + * */ export class CreateBotAliasCommand extends $Command< CreateBotAliasCommandInput, diff --git a/clients/client-lex-models-v2/commands/CreateBotCommand.ts b/clients/client-lex-models-v2/commands/CreateBotCommand.ts index d1cef0d252af..b9008db9f408 100644 --- a/clients/client-lex-models-v2/commands/CreateBotCommand.ts +++ b/clients/client-lex-models-v2/commands/CreateBotCommand.ts @@ -22,6 +22,20 @@ export interface CreateBotCommandOutput extends CreateBotResponse, __MetadataBea /** *

Creates an Amazon Lex conversational bot.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { LexModelsV2Client, CreateBotCommand } from "@aws-sdk/client-lex-models-v2"; // ES Modules import + * // const { LexModelsV2Client, CreateBotCommand } = require("@aws-sdk/client-lex-models-v2"); // CommonJS import + * const client = new LexModelsV2Client(config); + * const command = new CreateBotCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreateBotCommandInput} for command's `input` shape. + * @see {@link CreateBotCommandOutput} for command's `response` shape. + * @see {@link LexModelsV2ClientResolvedConfig | config} for command's `input` shape. + * */ export class CreateBotCommand extends $Command< CreateBotCommandInput, diff --git a/clients/client-lex-models-v2/commands/CreateBotLocaleCommand.ts b/clients/client-lex-models-v2/commands/CreateBotLocaleCommand.ts index 7f1d50f9b88b..a21b4b66a3cd 100644 --- a/clients/client-lex-models-v2/commands/CreateBotLocaleCommand.ts +++ b/clients/client-lex-models-v2/commands/CreateBotLocaleCommand.ts @@ -25,6 +25,20 @@ export interface CreateBotLocaleCommandOutput extends CreateBotLocaleResponse, _ * 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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { LexModelsV2Client, CreateBotLocaleCommand } from "@aws-sdk/client-lex-models-v2"; // ES Modules import + * // const { LexModelsV2Client, CreateBotLocaleCommand } = require("@aws-sdk/client-lex-models-v2"); // CommonJS import + * const client = new LexModelsV2Client(config); + * const command = new CreateBotLocaleCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreateBotLocaleCommandInput} for command's `input` shape. + * @see {@link CreateBotLocaleCommandOutput} for command's `response` shape. + * @see {@link LexModelsV2ClientResolvedConfig | config} for command's `input` shape. + * */ export class CreateBotLocaleCommand extends $Command< CreateBotLocaleCommandInput, diff --git a/clients/client-lex-models-v2/commands/CreateBotVersionCommand.ts b/clients/client-lex-models-v2/commands/CreateBotVersionCommand.ts index 2ab778f1adef..19832f2f6962 100644 --- a/clients/client-lex-models-v2/commands/CreateBotVersionCommand.ts +++ b/clients/client-lex-models-v2/commands/CreateBotVersionCommand.ts @@ -27,6 +27,20 @@ export interface CreateBotVersionCommandOutput extends CreateBotVersionResponse, * 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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { LexModelsV2Client, CreateBotVersionCommand } from "@aws-sdk/client-lex-models-v2"; // ES Modules import + * // const { LexModelsV2Client, CreateBotVersionCommand } = require("@aws-sdk/client-lex-models-v2"); // CommonJS import + * const client = new LexModelsV2Client(config); + * const command = new CreateBotVersionCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreateBotVersionCommandInput} for command's `input` shape. + * @see {@link CreateBotVersionCommandOutput} for command's `response` shape. + * @see {@link LexModelsV2ClientResolvedConfig | config} for command's `input` shape. + * */ export class CreateBotVersionCommand extends $Command< CreateBotVersionCommandInput, diff --git a/clients/client-lex-models-v2/commands/CreateIntentCommand.ts b/clients/client-lex-models-v2/commands/CreateIntentCommand.ts index 33bea568b638..2ced4d42840c 100644 --- a/clients/client-lex-models-v2/commands/CreateIntentCommand.ts +++ b/clients/client-lex-models-v2/commands/CreateIntentCommand.ts @@ -59,6 +59,20 @@ export interface CreateIntentCommandOutput extends CreateIntentResponse, __Metad * For example, "Do you want a drink with your pizza?"

* * + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { LexModelsV2Client, CreateIntentCommand } from "@aws-sdk/client-lex-models-v2"; // ES Modules import + * // const { LexModelsV2Client, CreateIntentCommand } = require("@aws-sdk/client-lex-models-v2"); // CommonJS import + * const client = new LexModelsV2Client(config); + * const command = new CreateIntentCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreateIntentCommandInput} for command's `input` shape. + * @see {@link CreateIntentCommandOutput} for command's `response` shape. + * @see {@link LexModelsV2ClientResolvedConfig | config} for command's `input` shape. + * */ export class CreateIntentCommand extends $Command< CreateIntentCommandInput, diff --git a/clients/client-lex-models-v2/commands/CreateSlotCommand.ts b/clients/client-lex-models-v2/commands/CreateSlotCommand.ts index 02eafc7eb13a..45a206f539f7 100644 --- a/clients/client-lex-models-v2/commands/CreateSlotCommand.ts +++ b/clients/client-lex-models-v2/commands/CreateSlotCommand.ts @@ -26,6 +26,20 @@ export interface CreateSlotCommandOutput extends CreateSlotResponse, __MetadataB * 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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { LexModelsV2Client, CreateSlotCommand } from "@aws-sdk/client-lex-models-v2"; // ES Modules import + * // const { LexModelsV2Client, CreateSlotCommand } = require("@aws-sdk/client-lex-models-v2"); // CommonJS import + * const client = new LexModelsV2Client(config); + * const command = new CreateSlotCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreateSlotCommandInput} for command's `input` shape. + * @see {@link CreateSlotCommandOutput} for command's `response` shape. + * @see {@link LexModelsV2ClientResolvedConfig | config} for command's `input` shape. + * */ export class CreateSlotCommand extends $Command< CreateSlotCommandInput, diff --git a/clients/client-lex-models-v2/commands/CreateSlotTypeCommand.ts b/clients/client-lex-models-v2/commands/CreateSlotTypeCommand.ts index 8af6a34f77c6..7bad2448b18e 100644 --- a/clients/client-lex-models-v2/commands/CreateSlotTypeCommand.ts +++ b/clients/client-lex-models-v2/commands/CreateSlotTypeCommand.ts @@ -25,6 +25,20 @@ export interface CreateSlotTypeCommandOutput extends CreateSlotTypeResponse, __M *

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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { LexModelsV2Client, CreateSlotTypeCommand } from "@aws-sdk/client-lex-models-v2"; // ES Modules import + * // const { LexModelsV2Client, CreateSlotTypeCommand } = require("@aws-sdk/client-lex-models-v2"); // CommonJS import + * const client = new LexModelsV2Client(config); + * const command = new CreateSlotTypeCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreateSlotTypeCommandInput} for command's `input` shape. + * @see {@link CreateSlotTypeCommandOutput} for command's `response` shape. + * @see {@link LexModelsV2ClientResolvedConfig | config} for command's `input` shape. + * */ export class CreateSlotTypeCommand extends $Command< CreateSlotTypeCommandInput, diff --git a/clients/client-lex-models-v2/commands/DeleteBotAliasCommand.ts b/clients/client-lex-models-v2/commands/DeleteBotAliasCommand.ts index 5c2a75277e33..69df8dcceff1 100644 --- a/clients/client-lex-models-v2/commands/DeleteBotAliasCommand.ts +++ b/clients/client-lex-models-v2/commands/DeleteBotAliasCommand.ts @@ -22,6 +22,20 @@ export interface DeleteBotAliasCommandOutput extends DeleteBotAliasResponse, __M /** *

Deletes the specified bot alias.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { LexModelsV2Client, DeleteBotAliasCommand } from "@aws-sdk/client-lex-models-v2"; // ES Modules import + * // const { LexModelsV2Client, DeleteBotAliasCommand } = require("@aws-sdk/client-lex-models-v2"); // CommonJS import + * const client = new LexModelsV2Client(config); + * const command = new DeleteBotAliasCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteBotAliasCommandInput} for command's `input` shape. + * @see {@link DeleteBotAliasCommandOutput} for command's `response` shape. + * @see {@link LexModelsV2ClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteBotAliasCommand extends $Command< DeleteBotAliasCommandInput, diff --git a/clients/client-lex-models-v2/commands/DeleteBotCommand.ts b/clients/client-lex-models-v2/commands/DeleteBotCommand.ts index 78ef3991e53a..c931d483f68f 100644 --- a/clients/client-lex-models-v2/commands/DeleteBotCommand.ts +++ b/clients/client-lex-models-v2/commands/DeleteBotCommand.ts @@ -31,6 +31,20 @@ export interface DeleteBotCommandOutput extends DeleteBotResponse, __MetadataBea * a ResourceInUseException exception. If you want to delete * the bot and the alias, set the skipResourceInUseCheck * parameter to true.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { LexModelsV2Client, DeleteBotCommand } from "@aws-sdk/client-lex-models-v2"; // ES Modules import + * // const { LexModelsV2Client, DeleteBotCommand } = require("@aws-sdk/client-lex-models-v2"); // CommonJS import + * const client = new LexModelsV2Client(config); + * const command = new DeleteBotCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteBotCommandInput} for command's `input` shape. + * @see {@link DeleteBotCommandOutput} for command's `response` shape. + * @see {@link LexModelsV2ClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteBotCommand extends $Command< DeleteBotCommandInput, diff --git a/clients/client-lex-models-v2/commands/DeleteBotLocaleCommand.ts b/clients/client-lex-models-v2/commands/DeleteBotLocaleCommand.ts index 0a72fc9adf13..e59ee0f9891c 100644 --- a/clients/client-lex-models-v2/commands/DeleteBotLocaleCommand.ts +++ b/clients/client-lex-models-v2/commands/DeleteBotLocaleCommand.ts @@ -24,6 +24,20 @@ export interface DeleteBotLocaleCommandOutput extends DeleteBotLocaleResponse, _ *

Removes a locale from a bot.

*

When you delete a locale, all intents, slots, and slot types defined * for the locale are also deleted.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { LexModelsV2Client, DeleteBotLocaleCommand } from "@aws-sdk/client-lex-models-v2"; // ES Modules import + * // const { LexModelsV2Client, DeleteBotLocaleCommand } = require("@aws-sdk/client-lex-models-v2"); // CommonJS import + * const client = new LexModelsV2Client(config); + * const command = new DeleteBotLocaleCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteBotLocaleCommandInput} for command's `input` shape. + * @see {@link DeleteBotLocaleCommandOutput} for command's `response` shape. + * @see {@link LexModelsV2ClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteBotLocaleCommand extends $Command< DeleteBotLocaleCommandInput, diff --git a/clients/client-lex-models-v2/commands/DeleteBotVersionCommand.ts b/clients/client-lex-models-v2/commands/DeleteBotVersionCommand.ts index 2643a809c042..fc6dd21dbf15 100644 --- a/clients/client-lex-models-v2/commands/DeleteBotVersionCommand.ts +++ b/clients/client-lex-models-v2/commands/DeleteBotVersionCommand.ts @@ -23,6 +23,20 @@ export interface DeleteBotVersionCommandOutput extends DeleteBotVersionResponse, /** *

Deletes a specific version of a bot. To delete all version of a bot, * use the DeleteBot operation.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { LexModelsV2Client, DeleteBotVersionCommand } from "@aws-sdk/client-lex-models-v2"; // ES Modules import + * // const { LexModelsV2Client, DeleteBotVersionCommand } = require("@aws-sdk/client-lex-models-v2"); // CommonJS import + * const client = new LexModelsV2Client(config); + * const command = new DeleteBotVersionCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteBotVersionCommandInput} for command's `input` shape. + * @see {@link DeleteBotVersionCommandOutput} for command's `response` shape. + * @see {@link LexModelsV2ClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteBotVersionCommand extends $Command< DeleteBotVersionCommandInput, diff --git a/clients/client-lex-models-v2/commands/DeleteIntentCommand.ts b/clients/client-lex-models-v2/commands/DeleteIntentCommand.ts index c9aa6daffe42..ffaad0900851 100644 --- a/clients/client-lex-models-v2/commands/DeleteIntentCommand.ts +++ b/clients/client-lex-models-v2/commands/DeleteIntentCommand.ts @@ -24,6 +24,20 @@ export interface DeleteIntentCommandOutput extends __MetadataBearer {} *

Removes the specified intent.

*

Deleting an intent also deletes the slots associated with the * intent.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { LexModelsV2Client, DeleteIntentCommand } from "@aws-sdk/client-lex-models-v2"; // ES Modules import + * // const { LexModelsV2Client, DeleteIntentCommand } = require("@aws-sdk/client-lex-models-v2"); // CommonJS import + * const client = new LexModelsV2Client(config); + * const command = new DeleteIntentCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteIntentCommandInput} for command's `input` shape. + * @see {@link DeleteIntentCommandOutput} for command's `response` shape. + * @see {@link LexModelsV2ClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteIntentCommand extends $Command< DeleteIntentCommandInput, diff --git a/clients/client-lex-models-v2/commands/DeleteSlotCommand.ts b/clients/client-lex-models-v2/commands/DeleteSlotCommand.ts index 2621e4cc8f41..3c3b9652ec09 100644 --- a/clients/client-lex-models-v2/commands/DeleteSlotCommand.ts +++ b/clients/client-lex-models-v2/commands/DeleteSlotCommand.ts @@ -22,6 +22,20 @@ export interface DeleteSlotCommandOutput extends __MetadataBearer {} /** *

Deletes the specified slot from an intent.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { LexModelsV2Client, DeleteSlotCommand } from "@aws-sdk/client-lex-models-v2"; // ES Modules import + * // const { LexModelsV2Client, DeleteSlotCommand } = require("@aws-sdk/client-lex-models-v2"); // CommonJS import + * const client = new LexModelsV2Client(config); + * const command = new DeleteSlotCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteSlotCommandInput} for command's `input` shape. + * @see {@link DeleteSlotCommandOutput} for command's `response` shape. + * @see {@link LexModelsV2ClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteSlotCommand extends $Command< DeleteSlotCommandInput, diff --git a/clients/client-lex-models-v2/commands/DeleteSlotTypeCommand.ts b/clients/client-lex-models-v2/commands/DeleteSlotTypeCommand.ts index 17839e426df8..d82ebdb36e1f 100644 --- a/clients/client-lex-models-v2/commands/DeleteSlotTypeCommand.ts +++ b/clients/client-lex-models-v2/commands/DeleteSlotTypeCommand.ts @@ -26,6 +26,20 @@ export interface DeleteSlotTypeCommandOutput extends __MetadataBearer {} * ResourceInUseException exception. To avoid the * exception, set the skipResourceInUseCheck parameter to * true.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { LexModelsV2Client, DeleteSlotTypeCommand } from "@aws-sdk/client-lex-models-v2"; // ES Modules import + * // const { LexModelsV2Client, DeleteSlotTypeCommand } = require("@aws-sdk/client-lex-models-v2"); // CommonJS import + * const client = new LexModelsV2Client(config); + * const command = new DeleteSlotTypeCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteSlotTypeCommandInput} for command's `input` shape. + * @see {@link DeleteSlotTypeCommandOutput} for command's `response` shape. + * @see {@link LexModelsV2ClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteSlotTypeCommand extends $Command< DeleteSlotTypeCommandInput, diff --git a/clients/client-lex-models-v2/commands/DescribeBotAliasCommand.ts b/clients/client-lex-models-v2/commands/DescribeBotAliasCommand.ts index d81613539e0b..17e1a280f958 100644 --- a/clients/client-lex-models-v2/commands/DescribeBotAliasCommand.ts +++ b/clients/client-lex-models-v2/commands/DescribeBotAliasCommand.ts @@ -22,6 +22,20 @@ export interface DescribeBotAliasCommandOutput extends DescribeBotAliasResponse, /** *

Get information about a specific bot alias.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { LexModelsV2Client, DescribeBotAliasCommand } from "@aws-sdk/client-lex-models-v2"; // ES Modules import + * // const { LexModelsV2Client, DescribeBotAliasCommand } = require("@aws-sdk/client-lex-models-v2"); // CommonJS import + * const client = new LexModelsV2Client(config); + * const command = new DescribeBotAliasCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeBotAliasCommandInput} for command's `input` shape. + * @see {@link DescribeBotAliasCommandOutput} for command's `response` shape. + * @see {@link LexModelsV2ClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeBotAliasCommand extends $Command< DescribeBotAliasCommandInput, diff --git a/clients/client-lex-models-v2/commands/DescribeBotCommand.ts b/clients/client-lex-models-v2/commands/DescribeBotCommand.ts index cc3a41496c67..489e9510bff5 100644 --- a/clients/client-lex-models-v2/commands/DescribeBotCommand.ts +++ b/clients/client-lex-models-v2/commands/DescribeBotCommand.ts @@ -22,6 +22,20 @@ export interface DescribeBotCommandOutput extends DescribeBotResponse, __Metadat /** *

Provides metadata information about a bot.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { LexModelsV2Client, DescribeBotCommand } from "@aws-sdk/client-lex-models-v2"; // ES Modules import + * // const { LexModelsV2Client, DescribeBotCommand } = require("@aws-sdk/client-lex-models-v2"); // CommonJS import + * const client = new LexModelsV2Client(config); + * const command = new DescribeBotCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeBotCommandInput} for command's `input` shape. + * @see {@link DescribeBotCommandOutput} for command's `response` shape. + * @see {@link LexModelsV2ClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeBotCommand extends $Command< DescribeBotCommandInput, diff --git a/clients/client-lex-models-v2/commands/DescribeBotLocaleCommand.ts b/clients/client-lex-models-v2/commands/DescribeBotLocaleCommand.ts index 6a38017abb94..ce9f4047bc64 100644 --- a/clients/client-lex-models-v2/commands/DescribeBotLocaleCommand.ts +++ b/clients/client-lex-models-v2/commands/DescribeBotLocaleCommand.ts @@ -22,6 +22,20 @@ export interface DescribeBotLocaleCommandOutput extends DescribeBotLocaleRespons /** *

Describes the settings that a bot has for a specific locale.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { LexModelsV2Client, DescribeBotLocaleCommand } from "@aws-sdk/client-lex-models-v2"; // ES Modules import + * // const { LexModelsV2Client, DescribeBotLocaleCommand } = require("@aws-sdk/client-lex-models-v2"); // CommonJS import + * const client = new LexModelsV2Client(config); + * const command = new DescribeBotLocaleCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeBotLocaleCommandInput} for command's `input` shape. + * @see {@link DescribeBotLocaleCommandOutput} for command's `response` shape. + * @see {@link LexModelsV2ClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeBotLocaleCommand extends $Command< DescribeBotLocaleCommandInput, diff --git a/clients/client-lex-models-v2/commands/DescribeBotVersionCommand.ts b/clients/client-lex-models-v2/commands/DescribeBotVersionCommand.ts index 7ba3fe32679a..c4cf2676aac3 100644 --- a/clients/client-lex-models-v2/commands/DescribeBotVersionCommand.ts +++ b/clients/client-lex-models-v2/commands/DescribeBotVersionCommand.ts @@ -22,6 +22,20 @@ export interface DescribeBotVersionCommandOutput extends DescribeBotVersionRespo /** *

Provides metadata about a version of a bot.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { LexModelsV2Client, DescribeBotVersionCommand } from "@aws-sdk/client-lex-models-v2"; // ES Modules import + * // const { LexModelsV2Client, DescribeBotVersionCommand } = require("@aws-sdk/client-lex-models-v2"); // CommonJS import + * const client = new LexModelsV2Client(config); + * const command = new DescribeBotVersionCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeBotVersionCommandInput} for command's `input` shape. + * @see {@link DescribeBotVersionCommandOutput} for command's `response` shape. + * @see {@link LexModelsV2ClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeBotVersionCommand extends $Command< DescribeBotVersionCommandInput, diff --git a/clients/client-lex-models-v2/commands/DescribeIntentCommand.ts b/clients/client-lex-models-v2/commands/DescribeIntentCommand.ts index 86b07d368ed8..763a7ac6dcd4 100644 --- a/clients/client-lex-models-v2/commands/DescribeIntentCommand.ts +++ b/clients/client-lex-models-v2/commands/DescribeIntentCommand.ts @@ -22,6 +22,20 @@ export interface DescribeIntentCommandOutput extends DescribeIntentResponse, __M /** *

Returns metadata about an intent.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { LexModelsV2Client, DescribeIntentCommand } from "@aws-sdk/client-lex-models-v2"; // ES Modules import + * // const { LexModelsV2Client, DescribeIntentCommand } = require("@aws-sdk/client-lex-models-v2"); // CommonJS import + * const client = new LexModelsV2Client(config); + * const command = new DescribeIntentCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeIntentCommandInput} for command's `input` shape. + * @see {@link DescribeIntentCommandOutput} for command's `response` shape. + * @see {@link LexModelsV2ClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeIntentCommand extends $Command< DescribeIntentCommandInput, diff --git a/clients/client-lex-models-v2/commands/DescribeSlotCommand.ts b/clients/client-lex-models-v2/commands/DescribeSlotCommand.ts index d51d25018c0b..1fc0e4e40f51 100644 --- a/clients/client-lex-models-v2/commands/DescribeSlotCommand.ts +++ b/clients/client-lex-models-v2/commands/DescribeSlotCommand.ts @@ -22,6 +22,20 @@ export interface DescribeSlotCommandOutput extends DescribeSlotResponse, __Metad /** *

Gets metadata information about a slot.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { LexModelsV2Client, DescribeSlotCommand } from "@aws-sdk/client-lex-models-v2"; // ES Modules import + * // const { LexModelsV2Client, DescribeSlotCommand } = require("@aws-sdk/client-lex-models-v2"); // CommonJS import + * const client = new LexModelsV2Client(config); + * const command = new DescribeSlotCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeSlotCommandInput} for command's `input` shape. + * @see {@link DescribeSlotCommandOutput} for command's `response` shape. + * @see {@link LexModelsV2ClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeSlotCommand extends $Command< DescribeSlotCommandInput, diff --git a/clients/client-lex-models-v2/commands/DescribeSlotTypeCommand.ts b/clients/client-lex-models-v2/commands/DescribeSlotTypeCommand.ts index f1cafd79aec8..9010cfa66663 100644 --- a/clients/client-lex-models-v2/commands/DescribeSlotTypeCommand.ts +++ b/clients/client-lex-models-v2/commands/DescribeSlotTypeCommand.ts @@ -22,6 +22,20 @@ export interface DescribeSlotTypeCommandOutput extends DescribeSlotTypeResponse, /** *

Gets metadata information about a slot type.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { LexModelsV2Client, DescribeSlotTypeCommand } from "@aws-sdk/client-lex-models-v2"; // ES Modules import + * // const { LexModelsV2Client, DescribeSlotTypeCommand } = require("@aws-sdk/client-lex-models-v2"); // CommonJS import + * const client = new LexModelsV2Client(config); + * const command = new DescribeSlotTypeCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeSlotTypeCommandInput} for command's `input` shape. + * @see {@link DescribeSlotTypeCommandOutput} for command's `response` shape. + * @see {@link LexModelsV2ClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeSlotTypeCommand extends $Command< DescribeSlotTypeCommandInput, diff --git a/clients/client-lex-models-v2/commands/ListBotAliasesCommand.ts b/clients/client-lex-models-v2/commands/ListBotAliasesCommand.ts index c7682ac6ddb6..25fe536f1233 100644 --- a/clients/client-lex-models-v2/commands/ListBotAliasesCommand.ts +++ b/clients/client-lex-models-v2/commands/ListBotAliasesCommand.ts @@ -22,6 +22,20 @@ export interface ListBotAliasesCommandOutput extends ListBotAliasesResponse, __M /** *

Gets a list of aliases for the specified bot.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { LexModelsV2Client, ListBotAliasesCommand } from "@aws-sdk/client-lex-models-v2"; // ES Modules import + * // const { LexModelsV2Client, ListBotAliasesCommand } = require("@aws-sdk/client-lex-models-v2"); // CommonJS import + * const client = new LexModelsV2Client(config); + * const command = new ListBotAliasesCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListBotAliasesCommandInput} for command's `input` shape. + * @see {@link ListBotAliasesCommandOutput} for command's `response` shape. + * @see {@link LexModelsV2ClientResolvedConfig | config} for command's `input` shape. + * */ export class ListBotAliasesCommand extends $Command< ListBotAliasesCommandInput, diff --git a/clients/client-lex-models-v2/commands/ListBotLocalesCommand.ts b/clients/client-lex-models-v2/commands/ListBotLocalesCommand.ts index b5361b62e7d0..63eb62f74635 100644 --- a/clients/client-lex-models-v2/commands/ListBotLocalesCommand.ts +++ b/clients/client-lex-models-v2/commands/ListBotLocalesCommand.ts @@ -22,6 +22,20 @@ export interface ListBotLocalesCommandOutput extends ListBotLocalesResponse, __M /** *

Gets a list of locales for the specified bot.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { LexModelsV2Client, ListBotLocalesCommand } from "@aws-sdk/client-lex-models-v2"; // ES Modules import + * // const { LexModelsV2Client, ListBotLocalesCommand } = require("@aws-sdk/client-lex-models-v2"); // CommonJS import + * const client = new LexModelsV2Client(config); + * const command = new ListBotLocalesCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListBotLocalesCommandInput} for command's `input` shape. + * @see {@link ListBotLocalesCommandOutput} for command's `response` shape. + * @see {@link LexModelsV2ClientResolvedConfig | config} for command's `input` shape. + * */ export class ListBotLocalesCommand extends $Command< ListBotLocalesCommandInput, diff --git a/clients/client-lex-models-v2/commands/ListBotVersionsCommand.ts b/clients/client-lex-models-v2/commands/ListBotVersionsCommand.ts index 044816fb4ff5..9d3253b9ee00 100644 --- a/clients/client-lex-models-v2/commands/ListBotVersionsCommand.ts +++ b/clients/client-lex-models-v2/commands/ListBotVersionsCommand.ts @@ -29,6 +29,20 @@ export interface ListBotVersionsCommandOutput extends ListBotVersionsResponse, _ * version.

*

The ListBotVersions operation always returns at least * one version, the DRAFT version.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { LexModelsV2Client, ListBotVersionsCommand } from "@aws-sdk/client-lex-models-v2"; // ES Modules import + * // const { LexModelsV2Client, ListBotVersionsCommand } = require("@aws-sdk/client-lex-models-v2"); // CommonJS import + * const client = new LexModelsV2Client(config); + * const command = new ListBotVersionsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListBotVersionsCommandInput} for command's `input` shape. + * @see {@link ListBotVersionsCommandOutput} for command's `response` shape. + * @see {@link LexModelsV2ClientResolvedConfig | config} for command's `input` shape. + * */ export class ListBotVersionsCommand extends $Command< ListBotVersionsCommandInput, diff --git a/clients/client-lex-models-v2/commands/ListBotsCommand.ts b/clients/client-lex-models-v2/commands/ListBotsCommand.ts index 85a8e2073548..f9ec1f0ccc29 100644 --- a/clients/client-lex-models-v2/commands/ListBotsCommand.ts +++ b/clients/client-lex-models-v2/commands/ListBotsCommand.ts @@ -22,6 +22,20 @@ export interface ListBotsCommandOutput extends ListBotsResponse, __MetadataBeare /** *

Gets a list of available bots.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { LexModelsV2Client, ListBotsCommand } from "@aws-sdk/client-lex-models-v2"; // ES Modules import + * // const { LexModelsV2Client, ListBotsCommand } = require("@aws-sdk/client-lex-models-v2"); // CommonJS import + * const client = new LexModelsV2Client(config); + * const command = new ListBotsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListBotsCommandInput} for command's `input` shape. + * @see {@link ListBotsCommandOutput} for command's `response` shape. + * @see {@link LexModelsV2ClientResolvedConfig | config} for command's `input` shape. + * */ export class ListBotsCommand extends $Command< ListBotsCommandInput, diff --git a/clients/client-lex-models-v2/commands/ListBuiltInIntentsCommand.ts b/clients/client-lex-models-v2/commands/ListBuiltInIntentsCommand.ts index 41cf43ce4f8f..97dd29bd85a3 100644 --- a/clients/client-lex-models-v2/commands/ListBuiltInIntentsCommand.ts +++ b/clients/client-lex-models-v2/commands/ListBuiltInIntentsCommand.ts @@ -27,6 +27,20 @@ export interface ListBuiltInIntentsCommandOutput extends ListBuiltInIntentsRespo * the built-in intent signature in the parentIntentSignature * parameter when you call the CreateIntent operation. For * more information, see CreateIntent.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { LexModelsV2Client, ListBuiltInIntentsCommand } from "@aws-sdk/client-lex-models-v2"; // ES Modules import + * // const { LexModelsV2Client, ListBuiltInIntentsCommand } = require("@aws-sdk/client-lex-models-v2"); // CommonJS import + * const client = new LexModelsV2Client(config); + * const command = new ListBuiltInIntentsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListBuiltInIntentsCommandInput} for command's `input` shape. + * @see {@link ListBuiltInIntentsCommandOutput} for command's `response` shape. + * @see {@link LexModelsV2ClientResolvedConfig | config} for command's `input` shape. + * */ export class ListBuiltInIntentsCommand extends $Command< ListBuiltInIntentsCommandInput, diff --git a/clients/client-lex-models-v2/commands/ListBuiltInSlotTypesCommand.ts b/clients/client-lex-models-v2/commands/ListBuiltInSlotTypesCommand.ts index 34a10126c078..27b432780994 100644 --- a/clients/client-lex-models-v2/commands/ListBuiltInSlotTypesCommand.ts +++ b/clients/client-lex-models-v2/commands/ListBuiltInSlotTypesCommand.ts @@ -23,6 +23,20 @@ export interface ListBuiltInSlotTypesCommandOutput extends ListBuiltInSlotTypesR /** *

Gets a list of built-in slot types that meet the specified * criteria.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { LexModelsV2Client, ListBuiltInSlotTypesCommand } from "@aws-sdk/client-lex-models-v2"; // ES Modules import + * // const { LexModelsV2Client, ListBuiltInSlotTypesCommand } = require("@aws-sdk/client-lex-models-v2"); // CommonJS import + * const client = new LexModelsV2Client(config); + * const command = new ListBuiltInSlotTypesCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListBuiltInSlotTypesCommandInput} for command's `input` shape. + * @see {@link ListBuiltInSlotTypesCommandOutput} for command's `response` shape. + * @see {@link LexModelsV2ClientResolvedConfig | config} for command's `input` shape. + * */ export class ListBuiltInSlotTypesCommand extends $Command< ListBuiltInSlotTypesCommandInput, diff --git a/clients/client-lex-models-v2/commands/ListIntentsCommand.ts b/clients/client-lex-models-v2/commands/ListIntentsCommand.ts index 09dae89fb51a..1d34ac938af8 100644 --- a/clients/client-lex-models-v2/commands/ListIntentsCommand.ts +++ b/clients/client-lex-models-v2/commands/ListIntentsCommand.ts @@ -22,6 +22,20 @@ export interface ListIntentsCommandOutput extends ListIntentsResponse, __Metadat /** *

Get a list of intents that meet the specified criteria.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { LexModelsV2Client, ListIntentsCommand } from "@aws-sdk/client-lex-models-v2"; // ES Modules import + * // const { LexModelsV2Client, ListIntentsCommand } = require("@aws-sdk/client-lex-models-v2"); // CommonJS import + * const client = new LexModelsV2Client(config); + * const command = new ListIntentsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListIntentsCommandInput} for command's `input` shape. + * @see {@link ListIntentsCommandOutput} for command's `response` shape. + * @see {@link LexModelsV2ClientResolvedConfig | config} for command's `input` shape. + * */ export class ListIntentsCommand extends $Command< ListIntentsCommandInput, diff --git a/clients/client-lex-models-v2/commands/ListSlotTypesCommand.ts b/clients/client-lex-models-v2/commands/ListSlotTypesCommand.ts index c640b04aee10..c3c9ff57f96e 100644 --- a/clients/client-lex-models-v2/commands/ListSlotTypesCommand.ts +++ b/clients/client-lex-models-v2/commands/ListSlotTypesCommand.ts @@ -22,6 +22,20 @@ export interface ListSlotTypesCommandOutput extends ListSlotTypesResponse, __Met /** *

Gets a list of slot types that match the specified criteria.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { LexModelsV2Client, ListSlotTypesCommand } from "@aws-sdk/client-lex-models-v2"; // ES Modules import + * // const { LexModelsV2Client, ListSlotTypesCommand } = require("@aws-sdk/client-lex-models-v2"); // CommonJS import + * const client = new LexModelsV2Client(config); + * const command = new ListSlotTypesCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListSlotTypesCommandInput} for command's `input` shape. + * @see {@link ListSlotTypesCommandOutput} for command's `response` shape. + * @see {@link LexModelsV2ClientResolvedConfig | config} for command's `input` shape. + * */ export class ListSlotTypesCommand extends $Command< ListSlotTypesCommandInput, diff --git a/clients/client-lex-models-v2/commands/ListSlotsCommand.ts b/clients/client-lex-models-v2/commands/ListSlotsCommand.ts index a3affb1c66a1..81c7918fec15 100644 --- a/clients/client-lex-models-v2/commands/ListSlotsCommand.ts +++ b/clients/client-lex-models-v2/commands/ListSlotsCommand.ts @@ -22,6 +22,20 @@ export interface ListSlotsCommandOutput extends ListSlotsResponse, __MetadataBea /** *

Gets a list of slots that match the specified criteria.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { LexModelsV2Client, ListSlotsCommand } from "@aws-sdk/client-lex-models-v2"; // ES Modules import + * // const { LexModelsV2Client, ListSlotsCommand } = require("@aws-sdk/client-lex-models-v2"); // CommonJS import + * const client = new LexModelsV2Client(config); + * const command = new ListSlotsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListSlotsCommandInput} for command's `input` shape. + * @see {@link ListSlotsCommandOutput} for command's `response` shape. + * @see {@link LexModelsV2ClientResolvedConfig | config} for command's `input` shape. + * */ export class ListSlotsCommand extends $Command< ListSlotsCommandInput, diff --git a/clients/client-lex-models-v2/commands/ListTagsForResourceCommand.ts b/clients/client-lex-models-v2/commands/ListTagsForResourceCommand.ts index 3082a1eafe55..a9fed67487b9 100644 --- a/clients/client-lex-models-v2/commands/ListTagsForResourceCommand.ts +++ b/clients/client-lex-models-v2/commands/ListTagsForResourceCommand.ts @@ -23,6 +23,20 @@ export interface ListTagsForResourceCommandOutput extends ListTagsForResourceRes /** *

Gets a list of tags associated with a resource. Only bots, bot * aliases, and bot channels can have tags associated with them.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { LexModelsV2Client, ListTagsForResourceCommand } from "@aws-sdk/client-lex-models-v2"; // ES Modules import + * // const { LexModelsV2Client, ListTagsForResourceCommand } = require("@aws-sdk/client-lex-models-v2"); // CommonJS import + * const client = new LexModelsV2Client(config); + * const command = new ListTagsForResourceCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListTagsForResourceCommandInput} for command's `input` shape. + * @see {@link ListTagsForResourceCommandOutput} for command's `response` shape. + * @see {@link LexModelsV2ClientResolvedConfig | config} for command's `input` shape. + * */ export class ListTagsForResourceCommand extends $Command< ListTagsForResourceCommandInput, diff --git a/clients/client-lex-models-v2/commands/TagResourceCommand.ts b/clients/client-lex-models-v2/commands/TagResourceCommand.ts index 200d7ea0bbd1..c23de38ad485 100644 --- a/clients/client-lex-models-v2/commands/TagResourceCommand.ts +++ b/clients/client-lex-models-v2/commands/TagResourceCommand.ts @@ -24,6 +24,20 @@ export interface TagResourceCommandOutput extends TagResourceResponse, __Metadat *

Adds the specified tags to the specified resource. If a tag key * already exists, the existing value is replaced with the new * value.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { LexModelsV2Client, TagResourceCommand } from "@aws-sdk/client-lex-models-v2"; // ES Modules import + * // const { LexModelsV2Client, TagResourceCommand } = require("@aws-sdk/client-lex-models-v2"); // CommonJS import + * const client = new LexModelsV2Client(config); + * const command = new TagResourceCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link TagResourceCommandInput} for command's `input` shape. + * @see {@link TagResourceCommandOutput} for command's `response` shape. + * @see {@link LexModelsV2ClientResolvedConfig | config} for command's `input` shape. + * */ export class TagResourceCommand extends $Command< TagResourceCommandInput, diff --git a/clients/client-lex-models-v2/commands/UntagResourceCommand.ts b/clients/client-lex-models-v2/commands/UntagResourceCommand.ts index 6a60a204b446..1412db6fa5e7 100644 --- a/clients/client-lex-models-v2/commands/UntagResourceCommand.ts +++ b/clients/client-lex-models-v2/commands/UntagResourceCommand.ts @@ -22,6 +22,20 @@ export interface UntagResourceCommandOutput extends UntagResourceResponse, __Met /** *

Removes tags from a bot, bot alias, or bot channel.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { LexModelsV2Client, UntagResourceCommand } from "@aws-sdk/client-lex-models-v2"; // ES Modules import + * // const { LexModelsV2Client, UntagResourceCommand } = require("@aws-sdk/client-lex-models-v2"); // CommonJS import + * const client = new LexModelsV2Client(config); + * const command = new UntagResourceCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link UntagResourceCommandInput} for command's `input` shape. + * @see {@link UntagResourceCommandOutput} for command's `response` shape. + * @see {@link LexModelsV2ClientResolvedConfig | config} for command's `input` shape. + * */ export class UntagResourceCommand extends $Command< UntagResourceCommandInput, diff --git a/clients/client-lex-models-v2/commands/UpdateBotAliasCommand.ts b/clients/client-lex-models-v2/commands/UpdateBotAliasCommand.ts index d9cf5fe01cdf..2993dad59077 100644 --- a/clients/client-lex-models-v2/commands/UpdateBotAliasCommand.ts +++ b/clients/client-lex-models-v2/commands/UpdateBotAliasCommand.ts @@ -22,6 +22,20 @@ export interface UpdateBotAliasCommandOutput extends UpdateBotAliasResponse, __M /** *

Updates the configuration of an existing bot alias.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { LexModelsV2Client, UpdateBotAliasCommand } from "@aws-sdk/client-lex-models-v2"; // ES Modules import + * // const { LexModelsV2Client, UpdateBotAliasCommand } = require("@aws-sdk/client-lex-models-v2"); // CommonJS import + * const client = new LexModelsV2Client(config); + * const command = new UpdateBotAliasCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link UpdateBotAliasCommandInput} for command's `input` shape. + * @see {@link UpdateBotAliasCommandOutput} for command's `response` shape. + * @see {@link LexModelsV2ClientResolvedConfig | config} for command's `input` shape. + * */ export class UpdateBotAliasCommand extends $Command< UpdateBotAliasCommandInput, diff --git a/clients/client-lex-models-v2/commands/UpdateBotCommand.ts b/clients/client-lex-models-v2/commands/UpdateBotCommand.ts index 0e0868f51ce1..c413468f7fb1 100644 --- a/clients/client-lex-models-v2/commands/UpdateBotCommand.ts +++ b/clients/client-lex-models-v2/commands/UpdateBotCommand.ts @@ -22,6 +22,20 @@ export interface UpdateBotCommandOutput extends UpdateBotResponse, __MetadataBea /** *

Updates the configuration of an existing bot.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { LexModelsV2Client, UpdateBotCommand } from "@aws-sdk/client-lex-models-v2"; // ES Modules import + * // const { LexModelsV2Client, UpdateBotCommand } = require("@aws-sdk/client-lex-models-v2"); // CommonJS import + * const client = new LexModelsV2Client(config); + * const command = new UpdateBotCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link UpdateBotCommandInput} for command's `input` shape. + * @see {@link UpdateBotCommandOutput} for command's `response` shape. + * @see {@link LexModelsV2ClientResolvedConfig | config} for command's `input` shape. + * */ export class UpdateBotCommand extends $Command< UpdateBotCommandInput, diff --git a/clients/client-lex-models-v2/commands/UpdateBotLocaleCommand.ts b/clients/client-lex-models-v2/commands/UpdateBotLocaleCommand.ts index 75ba7180c5e4..7360d342b445 100644 --- a/clients/client-lex-models-v2/commands/UpdateBotLocaleCommand.ts +++ b/clients/client-lex-models-v2/commands/UpdateBotLocaleCommand.ts @@ -22,6 +22,20 @@ export interface UpdateBotLocaleCommandOutput extends UpdateBotLocaleResponse, _ /** *

Updates the settings that a bot has for a specific locale.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { LexModelsV2Client, UpdateBotLocaleCommand } from "@aws-sdk/client-lex-models-v2"; // ES Modules import + * // const { LexModelsV2Client, UpdateBotLocaleCommand } = require("@aws-sdk/client-lex-models-v2"); // CommonJS import + * const client = new LexModelsV2Client(config); + * const command = new UpdateBotLocaleCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link UpdateBotLocaleCommandInput} for command's `input` shape. + * @see {@link UpdateBotLocaleCommandOutput} for command's `response` shape. + * @see {@link LexModelsV2ClientResolvedConfig | config} for command's `input` shape. + * */ export class UpdateBotLocaleCommand extends $Command< UpdateBotLocaleCommandInput, diff --git a/clients/client-lex-models-v2/commands/UpdateIntentCommand.ts b/clients/client-lex-models-v2/commands/UpdateIntentCommand.ts index 0c069c9ddc1b..29e8c215feb6 100644 --- a/clients/client-lex-models-v2/commands/UpdateIntentCommand.ts +++ b/clients/client-lex-models-v2/commands/UpdateIntentCommand.ts @@ -22,6 +22,20 @@ export interface UpdateIntentCommandOutput extends UpdateIntentResponse, __Metad /** *

Updates the settings for an intent.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { LexModelsV2Client, UpdateIntentCommand } from "@aws-sdk/client-lex-models-v2"; // ES Modules import + * // const { LexModelsV2Client, UpdateIntentCommand } = require("@aws-sdk/client-lex-models-v2"); // CommonJS import + * const client = new LexModelsV2Client(config); + * const command = new UpdateIntentCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link UpdateIntentCommandInput} for command's `input` shape. + * @see {@link UpdateIntentCommandOutput} for command's `response` shape. + * @see {@link LexModelsV2ClientResolvedConfig | config} for command's `input` shape. + * */ export class UpdateIntentCommand extends $Command< UpdateIntentCommandInput, diff --git a/clients/client-lex-models-v2/commands/UpdateSlotCommand.ts b/clients/client-lex-models-v2/commands/UpdateSlotCommand.ts index 1114ae9a9ef1..2d112fd539e7 100644 --- a/clients/client-lex-models-v2/commands/UpdateSlotCommand.ts +++ b/clients/client-lex-models-v2/commands/UpdateSlotCommand.ts @@ -22,6 +22,20 @@ export interface UpdateSlotCommandOutput extends UpdateSlotResponse, __MetadataB /** *

Updates the settings for a slot.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { LexModelsV2Client, UpdateSlotCommand } from "@aws-sdk/client-lex-models-v2"; // ES Modules import + * // const { LexModelsV2Client, UpdateSlotCommand } = require("@aws-sdk/client-lex-models-v2"); // CommonJS import + * const client = new LexModelsV2Client(config); + * const command = new UpdateSlotCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link UpdateSlotCommandInput} for command's `input` shape. + * @see {@link UpdateSlotCommandOutput} for command's `response` shape. + * @see {@link LexModelsV2ClientResolvedConfig | config} for command's `input` shape. + * */ export class UpdateSlotCommand extends $Command< UpdateSlotCommandInput, diff --git a/clients/client-lex-models-v2/commands/UpdateSlotTypeCommand.ts b/clients/client-lex-models-v2/commands/UpdateSlotTypeCommand.ts index 87648f072461..2c32f1256c70 100644 --- a/clients/client-lex-models-v2/commands/UpdateSlotTypeCommand.ts +++ b/clients/client-lex-models-v2/commands/UpdateSlotTypeCommand.ts @@ -22,6 +22,20 @@ export interface UpdateSlotTypeCommandOutput extends UpdateSlotTypeResponse, __M /** *

Updates the configuration of an existing slot type.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { LexModelsV2Client, UpdateSlotTypeCommand } from "@aws-sdk/client-lex-models-v2"; // ES Modules import + * // const { LexModelsV2Client, UpdateSlotTypeCommand } = require("@aws-sdk/client-lex-models-v2"); // CommonJS import + * const client = new LexModelsV2Client(config); + * const command = new UpdateSlotTypeCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link UpdateSlotTypeCommandInput} for command's `input` shape. + * @see {@link UpdateSlotTypeCommandOutput} for command's `response` shape. + * @see {@link LexModelsV2ClientResolvedConfig | config} for command's `input` shape. + * */ export class UpdateSlotTypeCommand extends $Command< UpdateSlotTypeCommandInput, diff --git a/clients/client-lex-models-v2/models/models_0.ts b/clients/client-lex-models-v2/models/models_0.ts index fd453423e6b6..bbfd10b00910 100644 --- a/clients/client-lex-models-v2/models/models_0.ts +++ b/clients/client-lex-models-v2/models/models_0.ts @@ -24,6 +24,9 @@ export interface S3BucketLogDestination { } export namespace S3BucketLogDestination { + /** + * @internal + */ export const filterSensitiveLog = (obj: S3BucketLogDestination): any => ({ ...obj, }); @@ -43,6 +46,9 @@ export interface AudioLogDestination { } export namespace AudioLogDestination { + /** + * @internal + */ export const filterSensitiveLog = (obj: AudioLogDestination): any => ({ ...obj, }); @@ -67,6 +73,9 @@ export interface AudioLogSetting { } export namespace AudioLogSetting { + /** + * @internal + */ export const filterSensitiveLog = (obj: AudioLogSetting): any => ({ ...obj, }); @@ -94,6 +103,9 @@ export interface BotAliasHistoryEvent { } export namespace BotAliasHistoryEvent { + /** + * @internal + */ export const filterSensitiveLog = (obj: BotAliasHistoryEvent): any => ({ ...obj, }); @@ -117,6 +129,9 @@ export interface LambdaCodeHook { } export namespace LambdaCodeHook { + /** + * @internal + */ export const filterSensitiveLog = (obj: LambdaCodeHook): any => ({ ...obj, }); @@ -135,6 +150,9 @@ export interface CodeHookSpecification { } export namespace CodeHookSpecification { + /** + * @internal + */ export const filterSensitiveLog = (obj: CodeHookSpecification): any => ({ ...obj, }); @@ -159,6 +177,9 @@ export interface BotAliasLocaleSettings { } export namespace BotAliasLocaleSettings { + /** + * @internal + */ export const filterSensitiveLog = (obj: BotAliasLocaleSettings): any => ({ ...obj, }); @@ -216,6 +237,9 @@ export interface BotAliasSummary { } export namespace BotAliasSummary { + /** + * @internal + */ export const filterSensitiveLog = (obj: BotAliasSummary): any => ({ ...obj, }); @@ -256,6 +280,9 @@ export interface BotFilter { } export namespace BotFilter { + /** + * @internal + */ export const filterSensitiveLog = (obj: BotFilter): any => ({ ...obj, }); @@ -296,6 +323,9 @@ export interface BotLocaleFilter { } export namespace BotLocaleFilter { + /** + * @internal + */ export const filterSensitiveLog = (obj: BotLocaleFilter): any => ({ ...obj, }); @@ -318,6 +348,9 @@ export interface BotLocaleHistoryEvent { } export namespace BotLocaleHistoryEvent { + /** + * @internal + */ export const filterSensitiveLog = (obj: BotLocaleHistoryEvent): any => ({ ...obj, }); @@ -349,6 +382,9 @@ export interface BotLocaleSortBy { } export namespace BotLocaleSortBy { + /** + * @internal + */ export const filterSensitiveLog = (obj: BotLocaleSortBy): any => ({ ...obj, }); @@ -403,6 +439,9 @@ export interface BotLocaleSummary { } export namespace BotLocaleSummary { + /** + * @internal + */ export const filterSensitiveLog = (obj: BotLocaleSummary): any => ({ ...obj, }); @@ -429,6 +468,9 @@ export interface BotSortBy { } export namespace BotSortBy { + /** + * @internal + */ export const filterSensitiveLog = (obj: BotSortBy): any => ({ ...obj, }); @@ -481,6 +523,9 @@ export interface BotSummary { } export namespace BotSummary { + /** + * @internal + */ export const filterSensitiveLog = (obj: BotSummary): any => ({ ...obj, }); @@ -497,6 +542,9 @@ export interface BotVersionLocaleDetails { } export namespace BotVersionLocaleDetails { + /** + * @internal + */ export const filterSensitiveLog = (obj: BotVersionLocaleDetails): any => ({ ...obj, }); @@ -523,6 +571,9 @@ export interface BotVersionSortBy { } export namespace BotVersionSortBy { + /** + * @internal + */ export const filterSensitiveLog = (obj: BotVersionSortBy): any => ({ ...obj, }); @@ -562,6 +613,9 @@ export interface BotVersionSummary { } export namespace BotVersionSummary { + /** + * @internal + */ export const filterSensitiveLog = (obj: BotVersionSummary): any => ({ ...obj, }); @@ -590,6 +644,9 @@ export interface BuildBotLocaleRequest { } export namespace BuildBotLocaleRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: BuildBotLocaleRequest): any => ({ ...obj, }); @@ -630,6 +687,9 @@ export interface BuildBotLocaleResponse { } export namespace BuildBotLocaleResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: BuildBotLocaleResponse): any => ({ ...obj, }); @@ -645,6 +705,9 @@ export interface ConflictException extends __SmithyException, $MetadataBearer { } export namespace ConflictException { + /** + * @internal + */ export const filterSensitiveLog = (obj: ConflictException): any => ({ ...obj, }); @@ -660,6 +723,9 @@ export interface InternalServerException extends __SmithyException, $MetadataBea } export namespace InternalServerException { + /** + * @internal + */ export const filterSensitiveLog = (obj: InternalServerException): any => ({ ...obj, }); @@ -675,6 +741,9 @@ export interface PreconditionFailedException extends __SmithyException, $Metadat } export namespace PreconditionFailedException { + /** + * @internal + */ export const filterSensitiveLog = (obj: PreconditionFailedException): any => ({ ...obj, }); @@ -690,6 +759,9 @@ export interface ServiceQuotaExceededException extends __SmithyException, $Metad } export namespace ServiceQuotaExceededException { + /** + * @internal + */ export const filterSensitiveLog = (obj: ServiceQuotaExceededException): any => ({ ...obj, }); @@ -706,6 +778,9 @@ export interface ThrottlingException extends __SmithyException, $MetadataBearer } export namespace ThrottlingException { + /** + * @internal + */ export const filterSensitiveLog = (obj: ThrottlingException): any => ({ ...obj, }); @@ -721,6 +796,9 @@ export interface ValidationException extends __SmithyException, $MetadataBearer } export namespace ValidationException { + /** + * @internal + */ export const filterSensitiveLog = (obj: ValidationException): any => ({ ...obj, }); @@ -747,6 +825,9 @@ export interface BuiltInIntentSortBy { } export namespace BuiltInIntentSortBy { + /** + * @internal + */ export const filterSensitiveLog = (obj: BuiltInIntentSortBy): any => ({ ...obj, }); @@ -769,6 +850,9 @@ export interface BuiltInIntentSummary { } export namespace BuiltInIntentSummary { + /** + * @internal + */ export const filterSensitiveLog = (obj: BuiltInIntentSummary): any => ({ ...obj, }); @@ -796,6 +880,9 @@ export interface BuiltInSlotTypeSortBy { } export namespace BuiltInSlotTypeSortBy { + /** + * @internal + */ export const filterSensitiveLog = (obj: BuiltInSlotTypeSortBy): any => ({ ...obj, }); @@ -819,6 +906,9 @@ export interface BuiltInSlotTypeSummary { } export namespace BuiltInSlotTypeSummary { + /** + * @internal + */ export const filterSensitiveLog = (obj: BuiltInSlotTypeSummary): any => ({ ...obj, }); @@ -843,6 +933,9 @@ export interface Button { } export namespace Button { + /** + * @internal + */ export const filterSensitiveLog = (obj: Button): any => ({ ...obj, }); @@ -867,6 +960,9 @@ export interface CloudWatchLogGroupLogDestination { } export namespace CloudWatchLogGroupLogDestination { + /** + * @internal + */ export const filterSensitiveLog = (obj: CloudWatchLogGroupLogDestination): any => ({ ...obj, }); @@ -885,6 +981,9 @@ export interface TextLogDestination { } export namespace TextLogDestination { + /** + * @internal + */ export const filterSensitiveLog = (obj: TextLogDestination): any => ({ ...obj, }); @@ -908,6 +1007,9 @@ export interface TextLogSetting { } export namespace TextLogSetting { + /** + * @internal + */ export const filterSensitiveLog = (obj: TextLogSetting): any => ({ ...obj, }); @@ -930,6 +1032,9 @@ export interface ConversationLogSettings { } export namespace ConversationLogSettings { + /** + * @internal + */ export const filterSensitiveLog = (obj: ConversationLogSettings): any => ({ ...obj, }); @@ -974,6 +1079,9 @@ export interface DataPrivacy { } export namespace DataPrivacy { + /** + * @internal + */ export const filterSensitiveLog = (obj: DataPrivacy): any => ({ ...obj, }); @@ -1033,6 +1141,9 @@ export interface CreateBotRequest { } export namespace CreateBotRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateBotRequest): any => ({ ...obj, }); @@ -1096,6 +1207,9 @@ export interface CreateBotResponse { } export namespace CreateBotResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateBotResponse): any => ({ ...obj, }); @@ -1114,6 +1228,9 @@ export interface SentimentAnalysisSettings { } export namespace SentimentAnalysisSettings { + /** + * @internal + */ export const filterSensitiveLog = (obj: SentimentAnalysisSettings): any => ({ ...obj, }); @@ -1174,6 +1291,9 @@ export interface CreateBotAliasRequest { } export namespace CreateBotAliasRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateBotAliasRequest): any => ({ ...obj, }); @@ -1243,6 +1363,9 @@ export interface CreateBotAliasResponse { } export namespace CreateBotAliasResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateBotAliasResponse): any => ({ ...obj, }); @@ -1260,6 +1383,9 @@ export interface VoiceSettings { } export namespace VoiceSettings { + /** + * @internal + */ export const filterSensitiveLog = (obj: VoiceSettings): any => ({ ...obj, }); @@ -1328,6 +1454,9 @@ export interface CreateBotLocaleRequest { } export namespace CreateBotLocaleRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateBotLocaleRequest): any => ({ ...obj, }); @@ -1395,6 +1524,9 @@ export interface CreateBotLocaleResponse { } export namespace CreateBotLocaleResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateBotLocaleResponse): any => ({ ...obj, }); @@ -1422,6 +1554,9 @@ export interface CreateBotVersionRequest { } export namespace CreateBotVersionRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateBotVersionRequest): any => ({ ...obj, }); @@ -1464,6 +1599,9 @@ export interface CreateBotVersionResponse { } export namespace CreateBotVersionResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateBotVersionResponse): any => ({ ...obj, }); @@ -1482,6 +1620,9 @@ export interface DialogCodeHookSettings { } export namespace DialogCodeHookSettings { + /** + * @internal + */ export const filterSensitiveLog = (obj: DialogCodeHookSettings): any => ({ ...obj, }); @@ -1500,6 +1641,9 @@ export interface FulfillmentCodeHookSettings { } export namespace FulfillmentCodeHookSettings { + /** + * @internal + */ export const filterSensitiveLog = (obj: FulfillmentCodeHookSettings): any => ({ ...obj, }); @@ -1517,6 +1661,9 @@ export interface InputContext { } export namespace InputContext { + /** + * @internal + */ export const filterSensitiveLog = (obj: InputContext): any => ({ ...obj, }); @@ -1534,6 +1681,9 @@ export interface CustomPayload { } export namespace CustomPayload { + /** + * @internal + */ export const filterSensitiveLog = (obj: CustomPayload): any => ({ ...obj, }); @@ -1575,6 +1725,9 @@ export interface ImageResponseCard { } export namespace ImageResponseCard { + /** + * @internal + */ export const filterSensitiveLog = (obj: ImageResponseCard): any => ({ ...obj, }); @@ -1591,6 +1744,9 @@ export interface PlainTextMessage { } export namespace PlainTextMessage { + /** + * @internal + */ export const filterSensitiveLog = (obj: PlainTextMessage): any => ({ ...obj, }); @@ -1607,6 +1763,9 @@ export interface SSMLMessage { } export namespace SSMLMessage { + /** + * @internal + */ export const filterSensitiveLog = (obj: SSMLMessage): any => ({ ...obj, }); @@ -1640,6 +1799,9 @@ export interface Message { } export namespace Message { + /** + * @internal + */ export const filterSensitiveLog = (obj: Message): any => ({ ...obj, }); @@ -1664,6 +1826,9 @@ export interface MessageGroup { } export namespace MessageGroup { + /** + * @internal + */ export const filterSensitiveLog = (obj: MessageGroup): any => ({ ...obj, }); @@ -1688,6 +1853,9 @@ export interface ResponseSpecification { } export namespace ResponseSpecification { + /** + * @internal + */ export const filterSensitiveLog = (obj: ResponseSpecification): any => ({ ...obj, }); @@ -1706,6 +1874,9 @@ export interface IntentClosingSetting { } export namespace IntentClosingSetting { + /** + * @internal + */ export const filterSensitiveLog = (obj: IntentClosingSetting): any => ({ ...obj, }); @@ -1736,6 +1907,9 @@ export interface PromptSpecification { } export namespace PromptSpecification { + /** + * @internal + */ export const filterSensitiveLog = (obj: PromptSpecification): any => ({ ...obj, }); @@ -1767,6 +1941,9 @@ export interface IntentConfirmationSetting { } export namespace IntentConfirmationSetting { + /** + * @internal + */ export const filterSensitiveLog = (obj: IntentConfirmationSetting): any => ({ ...obj, }); @@ -1802,6 +1979,9 @@ export interface KendraConfiguration { } export namespace KendraConfiguration { + /** + * @internal + */ export const filterSensitiveLog = (obj: KendraConfiguration): any => ({ ...obj, }); @@ -1833,6 +2013,9 @@ export interface OutputContext { } export namespace OutputContext { + /** + * @internal + */ export const filterSensitiveLog = (obj: OutputContext): any => ({ ...obj, }); @@ -1851,6 +2034,9 @@ export interface SampleUtterance { } export namespace SampleUtterance { + /** + * @internal + */ export const filterSensitiveLog = (obj: SampleUtterance): any => ({ ...obj, }); @@ -1982,6 +2168,9 @@ export interface CreateIntentRequest { } export namespace CreateIntentRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateIntentRequest): any => ({ ...obj, }); @@ -2072,6 +2261,9 @@ export interface CreateIntentResponse { } export namespace CreateIntentResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateIntentResponse): any => ({ ...obj, }); @@ -2095,6 +2287,9 @@ export interface ObfuscationSetting { } export namespace ObfuscationSetting { + /** + * @internal + */ export const filterSensitiveLog = (obj: ObfuscationSetting): any => ({ ...obj, }); @@ -2113,6 +2308,9 @@ export interface SlotDefaultValue { } export namespace SlotDefaultValue { + /** + * @internal + */ export const filterSensitiveLog = (obj: SlotDefaultValue): any => ({ ...obj, }); @@ -2131,6 +2329,9 @@ export interface SlotDefaultValueSpecification { } export namespace SlotDefaultValueSpecification { + /** + * @internal + */ export const filterSensitiveLog = (obj: SlotDefaultValueSpecification): any => ({ ...obj, }); @@ -2172,6 +2373,9 @@ export interface StillWaitingResponseSpecification { } export namespace StillWaitingResponseSpecification { + /** + * @internal + */ export const filterSensitiveLog = (obj: StillWaitingResponseSpecification): any => ({ ...obj, }); @@ -2202,6 +2406,9 @@ export interface WaitAndContinueSpecification { } export namespace WaitAndContinueSpecification { + /** + * @internal + */ export const filterSensitiveLog = (obj: WaitAndContinueSpecification): any => ({ ...obj, }); @@ -2246,6 +2453,9 @@ export interface SlotValueElicitationSetting { } export namespace SlotValueElicitationSetting { + /** + * @internal + */ export const filterSensitiveLog = (obj: SlotValueElicitationSetting): any => ({ ...obj, }); @@ -2312,6 +2522,9 @@ export interface CreateSlotRequest { } export namespace CreateSlotRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateSlotRequest): any => ({ ...obj, }); @@ -2378,6 +2591,9 @@ export interface CreateSlotResponse { } export namespace CreateSlotResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateSlotResponse): any => ({ ...obj, }); @@ -2394,6 +2610,9 @@ export interface SampleValue { } export namespace SampleValue { + /** + * @internal + */ export const filterSensitiveLog = (obj: SampleValue): any => ({ ...obj, }); @@ -2417,6 +2636,9 @@ export interface SlotTypeValue { } export namespace SlotTypeValue { + /** + * @internal + */ export const filterSensitiveLog = (obj: SlotTypeValue): any => ({ ...obj, }); @@ -2458,6 +2680,9 @@ export interface SlotValueRegexFilter { } export namespace SlotValueRegexFilter { + /** + * @internal + */ export const filterSensitiveLog = (obj: SlotValueRegexFilter): any => ({ ...obj, }); @@ -2501,6 +2726,9 @@ export interface SlotValueSelectionSetting { } export namespace SlotValueSelectionSetting { + /** + * @internal + */ export const filterSensitiveLog = (obj: SlotValueSelectionSetting): any => ({ ...obj, }); @@ -2578,6 +2806,9 @@ export interface CreateSlotTypeRequest { } export namespace CreateSlotTypeRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateSlotTypeRequest): any => ({ ...obj, }); @@ -2641,6 +2872,9 @@ export interface CreateSlotTypeResponse { } export namespace CreateSlotTypeResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateSlotTypeResponse): any => ({ ...obj, }); @@ -2661,6 +2895,9 @@ export interface DeleteBotRequest { } export namespace DeleteBotRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteBotRequest): any => ({ ...obj, }); @@ -2680,6 +2917,9 @@ export interface DeleteBotResponse { } export namespace DeleteBotResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteBotResponse): any => ({ ...obj, }); @@ -2705,6 +2945,9 @@ export interface DeleteBotAliasRequest { } export namespace DeleteBotAliasRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteBotAliasRequest): any => ({ ...obj, }); @@ -2732,6 +2975,9 @@ export interface DeleteBotAliasResponse { } export namespace DeleteBotAliasResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteBotAliasResponse): any => ({ ...obj, }); @@ -2757,6 +3003,9 @@ export interface DeleteBotLocaleRequest { } export namespace DeleteBotLocaleRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteBotLocaleRequest): any => ({ ...obj, }); @@ -2787,6 +3036,9 @@ export interface DeleteBotLocaleResponse { } export namespace DeleteBotLocaleResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteBotLocaleResponse): any => ({ ...obj, }); @@ -2815,6 +3067,9 @@ export interface DeleteBotVersionRequest { } export namespace DeleteBotVersionRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteBotVersionRequest): any => ({ ...obj, }); @@ -2838,6 +3093,9 @@ export interface DeleteBotVersionResponse { } export namespace DeleteBotVersionResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteBotVersionResponse): any => ({ ...obj, }); @@ -2868,6 +3126,9 @@ export interface DeleteIntentRequest { } export namespace DeleteIntentRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteIntentRequest): any => ({ ...obj, }); @@ -2903,6 +3164,9 @@ export interface DeleteSlotRequest { } export namespace DeleteSlotRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteSlotRequest): any => ({ ...obj, }); @@ -2942,6 +3206,9 @@ export interface DeleteSlotTypeRequest { } export namespace DeleteSlotTypeRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteSlotTypeRequest): any => ({ ...obj, }); @@ -2955,6 +3222,9 @@ export interface DescribeBotRequest { } export namespace DescribeBotRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeBotRequest): any => ({ ...obj, }); @@ -3014,6 +3284,9 @@ export interface DescribeBotResponse { } export namespace DescribeBotResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeBotResponse): any => ({ ...obj, }); @@ -3029,6 +3302,9 @@ export interface ResourceNotFoundException extends __SmithyException, $MetadataB } export namespace ResourceNotFoundException { + /** + * @internal + */ export const filterSensitiveLog = (obj: ResourceNotFoundException): any => ({ ...obj, }); @@ -3048,6 +3324,9 @@ export interface DescribeBotAliasRequest { } export namespace DescribeBotAliasRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeBotAliasRequest): any => ({ ...obj, }); @@ -3122,6 +3401,9 @@ export interface DescribeBotAliasResponse { } export namespace DescribeBotAliasResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeBotAliasResponse): any => ({ ...obj, }); @@ -3148,6 +3430,9 @@ export interface DescribeBotLocaleRequest { } export namespace DescribeBotLocaleRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeBotLocaleRequest): any => ({ ...obj, }); @@ -3241,6 +3526,9 @@ export interface DescribeBotLocaleResponse { } export namespace DescribeBotLocaleResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeBotLocaleResponse): any => ({ ...obj, }); @@ -3260,6 +3548,9 @@ export interface DescribeBotVersionRequest { } export namespace DescribeBotVersionRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeBotVersionRequest): any => ({ ...obj, }); @@ -3323,6 +3614,9 @@ export interface DescribeBotVersionResponse { } export namespace DescribeBotVersionResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeBotVersionResponse): any => ({ ...obj, }); @@ -3353,6 +3647,9 @@ export interface DescribeIntentRequest { } export namespace DescribeIntentRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeIntentRequest): any => ({ ...obj, }); @@ -3375,6 +3672,9 @@ export interface SlotPriority { } export namespace SlotPriority { + /** + * @internal + */ export const filterSensitiveLog = (obj: SlotPriority): any => ({ ...obj, }); @@ -3483,6 +3783,9 @@ export interface DescribeIntentResponse { } export namespace DescribeIntentResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeIntentResponse): any => ({ ...obj, }); @@ -3518,6 +3821,9 @@ export interface DescribeSlotRequest { } export namespace DescribeSlotRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeSlotRequest): any => ({ ...obj, }); @@ -3590,6 +3896,9 @@ export interface DescribeSlotResponse { } export namespace DescribeSlotResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeSlotResponse): any => ({ ...obj, }); @@ -3620,6 +3929,9 @@ export interface DescribeSlotTypeRequest { } export namespace DescribeSlotTypeRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeSlotTypeRequest): any => ({ ...obj, }); @@ -3687,6 +3999,9 @@ export interface DescribeSlotTypeResponse { } export namespace DescribeSlotTypeResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeSlotTypeResponse): any => ({ ...obj, }); @@ -3727,6 +4042,9 @@ export interface IntentFilter { } export namespace IntentFilter { + /** + * @internal + */ export const filterSensitiveLog = (obj: IntentFilter): any => ({ ...obj, }); @@ -3754,6 +4072,9 @@ export interface IntentSortBy { } export namespace IntentSortBy { + /** + * @internal + */ export const filterSensitiveLog = (obj: IntentSortBy): any => ({ ...obj, }); @@ -3807,6 +4128,9 @@ export interface IntentSummary { } export namespace IntentSummary { + /** + * @internal + */ export const filterSensitiveLog = (obj: IntentSummary): any => ({ ...obj, }); @@ -3836,6 +4160,9 @@ export interface ListBotAliasesRequest { } export namespace ListBotAliasesRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListBotAliasesRequest): any => ({ ...obj, }); @@ -3867,6 +4194,9 @@ export interface ListBotAliasesResponse { } export namespace ListBotAliasesResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListBotAliasesResponse): any => ({ ...obj, }); @@ -3914,6 +4244,9 @@ export interface ListBotLocalesRequest { } export namespace ListBotLocalesRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListBotLocalesRequest): any => ({ ...obj, }); @@ -3950,6 +4283,9 @@ export interface ListBotLocalesResponse { } export namespace ListBotLocalesResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListBotLocalesResponse): any => ({ ...obj, }); @@ -3988,6 +4324,9 @@ export interface ListBotsRequest { } export namespace ListBotsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListBotsRequest): any => ({ ...obj, }); @@ -4014,6 +4353,9 @@ export interface ListBotsResponse { } export namespace ListBotsResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListBotsResponse): any => ({ ...obj, }); @@ -4050,6 +4392,9 @@ export interface ListBotVersionsRequest { } export namespace ListBotVersionsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListBotVersionsRequest): any => ({ ...obj, }); @@ -4081,6 +4426,9 @@ export interface ListBotVersionsResponse { } export namespace ListBotVersionsResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListBotVersionsResponse): any => ({ ...obj, }); @@ -4119,6 +4467,9 @@ export interface ListBuiltInIntentsRequest { } export namespace ListBuiltInIntentsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListBuiltInIntentsRequest): any => ({ ...obj, }); @@ -4150,6 +4501,9 @@ export interface ListBuiltInIntentsResponse { } export namespace ListBuiltInIntentsResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListBuiltInIntentsResponse): any => ({ ...obj, }); @@ -4189,6 +4543,9 @@ export interface ListBuiltInSlotTypesRequest { } export namespace ListBuiltInSlotTypesRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListBuiltInSlotTypesRequest): any => ({ ...obj, }); @@ -4221,6 +4578,9 @@ export interface ListBuiltInSlotTypesResponse { } export namespace ListBuiltInSlotTypesResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListBuiltInSlotTypesResponse): any => ({ ...obj, }); @@ -4277,6 +4637,9 @@ export interface ListIntentsRequest { } export namespace ListIntentsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListIntentsRequest): any => ({ ...obj, }); @@ -4318,6 +4681,9 @@ export interface ListIntentsResponse { } export namespace ListIntentsResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListIntentsResponse): any => ({ ...obj, }); @@ -4358,6 +4724,9 @@ export interface SlotFilter { } export namespace SlotFilter { + /** + * @internal + */ export const filterSensitiveLog = (obj: SlotFilter): any => ({ ...obj, }); @@ -4385,6 +4754,9 @@ export interface SlotSortBy { } export namespace SlotSortBy { + /** + * @internal + */ export const filterSensitiveLog = (obj: SlotSortBy): any => ({ ...obj, }); @@ -4446,6 +4818,9 @@ export interface ListSlotsRequest { } export namespace ListSlotsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListSlotsRequest): any => ({ ...obj, }); @@ -4497,6 +4872,9 @@ export interface SlotSummary { } export namespace SlotSummary { + /** + * @internal + */ export const filterSensitiveLog = (obj: SlotSummary): any => ({ ...obj, }); @@ -4543,6 +4921,9 @@ export interface ListSlotsResponse { } export namespace ListSlotsResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListSlotsResponse): any => ({ ...obj, }); @@ -4583,6 +4964,9 @@ export interface SlotTypeFilter { } export namespace SlotTypeFilter { + /** + * @internal + */ export const filterSensitiveLog = (obj: SlotTypeFilter): any => ({ ...obj, }); @@ -4610,6 +4994,9 @@ export interface SlotTypeSortBy { } export namespace SlotTypeSortBy { + /** + * @internal + */ export const filterSensitiveLog = (obj: SlotTypeSortBy): any => ({ ...obj, }); @@ -4667,6 +5054,9 @@ export interface ListSlotTypesRequest { } export namespace ListSlotTypesRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListSlotTypesRequest): any => ({ ...obj, }); @@ -4705,6 +5095,9 @@ export interface SlotTypeSummary { } export namespace SlotTypeSummary { + /** + * @internal + */ export const filterSensitiveLog = (obj: SlotTypeSummary): any => ({ ...obj, }); @@ -4746,6 +5139,9 @@ export interface ListSlotTypesResponse { } export namespace ListSlotTypesResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListSlotTypesResponse): any => ({ ...obj, }); @@ -4760,6 +5156,9 @@ export interface ListTagsForResourceRequest { } export namespace ListTagsForResourceRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListTagsForResourceRequest): any => ({ ...obj, }); @@ -4773,6 +5172,9 @@ export interface ListTagsForResourceResponse { } export namespace ListTagsForResourceResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListTagsForResourceResponse): any => ({ ...obj, }); @@ -4793,6 +5195,9 @@ export interface TagResourceRequest { } export namespace TagResourceRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: TagResourceRequest): any => ({ ...obj, }); @@ -4801,6 +5206,9 @@ export namespace TagResourceRequest { export interface TagResourceResponse {} export namespace TagResourceResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: TagResourceResponse): any => ({ ...obj, }); @@ -4821,6 +5229,9 @@ export interface UntagResourceRequest { } export namespace UntagResourceRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: UntagResourceRequest): any => ({ ...obj, }); @@ -4829,6 +5240,9 @@ export namespace UntagResourceRequest { export interface UntagResourceResponse {} export namespace UntagResourceResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: UntagResourceResponse): any => ({ ...obj, }); @@ -4877,6 +5291,9 @@ export interface UpdateBotRequest { } export namespace UpdateBotRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateBotRequest): any => ({ ...obj, }); @@ -4936,6 +5353,9 @@ export interface UpdateBotResponse { } export namespace UpdateBotResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateBotResponse): any => ({ ...obj, }); @@ -4987,6 +5407,9 @@ export interface UpdateBotAliasRequest { } export namespace UpdateBotAliasRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateBotAliasRequest): any => ({ ...obj, }); @@ -5055,6 +5478,9 @@ export interface UpdateBotAliasResponse { } export namespace UpdateBotAliasResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateBotAliasResponse): any => ({ ...obj, }); @@ -5099,6 +5525,9 @@ export interface UpdateBotLocaleRequest { } export namespace UpdateBotLocaleRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateBotLocaleRequest): any => ({ ...obj, }); @@ -5170,6 +5599,9 @@ export interface UpdateBotLocaleResponse { } export namespace UpdateBotLocaleResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateBotLocaleResponse): any => ({ ...obj, }); @@ -5269,6 +5701,9 @@ export interface UpdateIntentRequest { } export namespace UpdateIntentRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateIntentRequest): any => ({ ...obj, }); @@ -5377,6 +5812,9 @@ export interface UpdateIntentResponse { } export namespace UpdateIntentResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateIntentResponse): any => ({ ...obj, }); @@ -5441,6 +5879,9 @@ export interface UpdateSlotRequest { } export namespace UpdateSlotRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateSlotRequest): any => ({ ...obj, }); @@ -5514,6 +5955,9 @@ export interface UpdateSlotResponse { } export namespace UpdateSlotResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateSlotResponse): any => ({ ...obj, }); @@ -5573,6 +6017,9 @@ export interface UpdateSlotTypeRequest { } export namespace UpdateSlotTypeRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateSlotTypeRequest): any => ({ ...obj, }); @@ -5641,6 +6088,9 @@ export interface UpdateSlotTypeResponse { } export namespace UpdateSlotTypeResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateSlotTypeResponse): any => ({ ...obj, }); diff --git a/clients/client-lex-runtime-service/commands/DeleteSessionCommand.ts b/clients/client-lex-runtime-service/commands/DeleteSessionCommand.ts index 2e35e7694033..6f89014241eb 100644 --- a/clients/client-lex-runtime-service/commands/DeleteSessionCommand.ts +++ b/clients/client-lex-runtime-service/commands/DeleteSessionCommand.ts @@ -27,6 +27,20 @@ export interface DeleteSessionCommandOutput extends DeleteSessionResponse, __Met /** *

Removes session information for a specified bot, alias, and user ID. *

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { LexRuntimeServiceClient, DeleteSessionCommand } from "@aws-sdk/client-lex-runtime-service"; // ES Modules import + * // const { LexRuntimeServiceClient, DeleteSessionCommand } = require("@aws-sdk/client-lex-runtime-service"); // CommonJS import + * const client = new LexRuntimeServiceClient(config); + * const command = new DeleteSessionCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteSessionCommandInput} for command's `input` shape. + * @see {@link DeleteSessionCommandOutput} for command's `response` shape. + * @see {@link LexRuntimeServiceClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteSessionCommand extends $Command< DeleteSessionCommandInput, diff --git a/clients/client-lex-runtime-service/commands/GetSessionCommand.ts b/clients/client-lex-runtime-service/commands/GetSessionCommand.ts index cd288725ab31..18cd30869877 100644 --- a/clients/client-lex-runtime-service/commands/GetSessionCommand.ts +++ b/clients/client-lex-runtime-service/commands/GetSessionCommand.ts @@ -27,6 +27,20 @@ export interface GetSessionCommandOutput extends GetSessionResponse, __MetadataB /** *

Returns session information for a specified bot, alias, and user * ID.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { LexRuntimeServiceClient, GetSessionCommand } from "@aws-sdk/client-lex-runtime-service"; // ES Modules import + * // const { LexRuntimeServiceClient, GetSessionCommand } = require("@aws-sdk/client-lex-runtime-service"); // CommonJS import + * const client = new LexRuntimeServiceClient(config); + * const command = new GetSessionCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetSessionCommandInput} for command's `input` shape. + * @see {@link GetSessionCommandOutput} for command's `response` shape. + * @see {@link LexRuntimeServiceClientResolvedConfig | config} for command's `input` shape. + * */ export class GetSessionCommand extends $Command< GetSessionCommandInput, diff --git a/clients/client-lex-runtime-service/commands/PostContentCommand.ts b/clients/client-lex-runtime-service/commands/PostContentCommand.ts index 500c15b23014..495c5ff5b398 100644 --- a/clients/client-lex-runtime-service/commands/PostContentCommand.ts +++ b/clients/client-lex-runtime-service/commands/PostContentCommand.ts @@ -111,6 +111,20 @@ export interface PostContentCommandOutput extends PostContentResponse, __Metadat *

In addition, Amazon Lex also returns your application-specific * sessionAttributes. For more information, see Managing * Conversation Context.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { LexRuntimeServiceClient, PostContentCommand } from "@aws-sdk/client-lex-runtime-service"; // ES Modules import + * // const { LexRuntimeServiceClient, PostContentCommand } = require("@aws-sdk/client-lex-runtime-service"); // CommonJS import + * const client = new LexRuntimeServiceClient(config); + * const command = new PostContentCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link PostContentCommandInput} for command's `input` shape. + * @see {@link PostContentCommandOutput} for command's `response` shape. + * @see {@link LexRuntimeServiceClientResolvedConfig | config} for command's `input` shape. + * */ export class PostContentCommand extends $Command< PostContentCommandInput, diff --git a/clients/client-lex-runtime-service/commands/PostTextCommand.ts b/clients/client-lex-runtime-service/commands/PostTextCommand.ts index d5eef8547f89..331c7fc336de 100644 --- a/clients/client-lex-runtime-service/commands/PostTextCommand.ts +++ b/clients/client-lex-runtime-service/commands/PostTextCommand.ts @@ -101,6 +101,20 @@ export interface PostTextCommandOutput extends PostTextResponse, __MetadataBeare *

In addition, Amazon Lex also returns your application-specific * sessionAttributes. For more information, see Managing * Conversation Context.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { LexRuntimeServiceClient, PostTextCommand } from "@aws-sdk/client-lex-runtime-service"; // ES Modules import + * // const { LexRuntimeServiceClient, PostTextCommand } = require("@aws-sdk/client-lex-runtime-service"); // CommonJS import + * const client = new LexRuntimeServiceClient(config); + * const command = new PostTextCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link PostTextCommandInput} for command's `input` shape. + * @see {@link PostTextCommandOutput} for command's `response` shape. + * @see {@link LexRuntimeServiceClientResolvedConfig | config} for command's `input` shape. + * */ export class PostTextCommand extends $Command< PostTextCommandInput, diff --git a/clients/client-lex-runtime-service/commands/PutSessionCommand.ts b/clients/client-lex-runtime-service/commands/PutSessionCommand.ts index ec311032d970..7e2e5cc0684f 100644 --- a/clients/client-lex-runtime-service/commands/PutSessionCommand.ts +++ b/clients/client-lex-runtime-service/commands/PutSessionCommand.ts @@ -30,6 +30,20 @@ export interface PutSessionCommandOutput extends PutSessionResponse, __MetadataB * bot.

*

For more information, see Managing * Sessions.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { LexRuntimeServiceClient, PutSessionCommand } from "@aws-sdk/client-lex-runtime-service"; // ES Modules import + * // const { LexRuntimeServiceClient, PutSessionCommand } = require("@aws-sdk/client-lex-runtime-service"); // CommonJS import + * const client = new LexRuntimeServiceClient(config); + * const command = new PutSessionCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link PutSessionCommandInput} for command's `input` shape. + * @see {@link PutSessionCommandOutput} for command's `response` shape. + * @see {@link LexRuntimeServiceClientResolvedConfig | config} for command's `input` shape. + * */ export class PutSessionCommand extends $Command< PutSessionCommandInput, diff --git a/clients/client-lex-runtime-service/models/models_0.ts b/clients/client-lex-runtime-service/models/models_0.ts index f4b713036f0b..fdf95c92a583 100644 --- a/clients/client-lex-runtime-service/models/models_0.ts +++ b/clients/client-lex-runtime-service/models/models_0.ts @@ -28,6 +28,9 @@ export interface ActiveContextTimeToLive { } export namespace ActiveContextTimeToLive { + /** + * @internal + */ export const filterSensitiveLog = (obj: ActiveContextTimeToLive): any => ({ ...obj, }); @@ -60,6 +63,9 @@ export interface ActiveContext { } export namespace ActiveContext { + /** + * @internal + */ export const filterSensitiveLog = (obj: ActiveContext): any => ({ ...obj, ...(obj.parameters && { parameters: SENSITIVE_STRING }), @@ -78,6 +84,9 @@ export interface BadRequestException extends __SmithyException, $MetadataBearer } export namespace BadRequestException { + /** + * @internal + */ export const filterSensitiveLog = (obj: BadRequestException): any => ({ ...obj, }); @@ -94,6 +103,9 @@ export interface ConflictException extends __SmithyException, $MetadataBearer { } export namespace ConflictException { + /** + * @internal + */ export const filterSensitiveLog = (obj: ConflictException): any => ({ ...obj, }); @@ -117,6 +129,9 @@ export interface DeleteSessionRequest { } export namespace DeleteSessionRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteSessionRequest): any => ({ ...obj, }); @@ -145,6 +160,9 @@ export interface DeleteSessionResponse { } export namespace DeleteSessionResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteSessionResponse): any => ({ ...obj, }); @@ -160,6 +178,9 @@ export interface InternalFailureException extends __SmithyException, $MetadataBe } export namespace InternalFailureException { + /** + * @internal + */ export const filterSensitiveLog = (obj: InternalFailureException): any => ({ ...obj, }); @@ -176,6 +197,9 @@ export interface LimitExceededException extends __SmithyException, $MetadataBear } export namespace LimitExceededException { + /** + * @internal + */ export const filterSensitiveLog = (obj: LimitExceededException): any => ({ ...obj, }); @@ -192,6 +216,9 @@ export interface NotFoundException extends __SmithyException, $MetadataBearer { } export namespace NotFoundException { + /** + * @internal + */ export const filterSensitiveLog = (obj: NotFoundException): any => ({ ...obj, }); @@ -225,6 +252,9 @@ export interface GetSessionRequest { } export namespace GetSessionRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetSessionRequest): any => ({ ...obj, }); @@ -367,6 +397,9 @@ export interface DialogAction { } export namespace DialogAction { + /** + * @internal + */ export const filterSensitiveLog = (obj: DialogAction): any => ({ ...obj, ...(obj.slots && { slots: SENSITIVE_STRING }), @@ -494,6 +527,9 @@ export interface IntentSummary { } export namespace IntentSummary { + /** + * @internal + */ export const filterSensitiveLog = (obj: IntentSummary): any => ({ ...obj, ...(obj.slots && { slots: SENSITIVE_STRING }), @@ -540,6 +576,9 @@ export interface GetSessionResponse { } export namespace GetSessionResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetSessionResponse): any => ({ ...obj, ...(obj.recentIntentSummaryView && { @@ -563,6 +602,9 @@ export interface BadGatewayException extends __SmithyException, $MetadataBearer } export namespace BadGatewayException { + /** + * @internal + */ export const filterSensitiveLog = (obj: BadGatewayException): any => ({ ...obj, }); @@ -593,6 +635,9 @@ export interface DependencyFailedException extends __SmithyException, $MetadataB } export namespace DependencyFailedException { + /** + * @internal + */ export const filterSensitiveLog = (obj: DependencyFailedException): any => ({ ...obj, }); @@ -608,6 +653,9 @@ export interface LoopDetectedException extends __SmithyException, $MetadataBeare } export namespace LoopDetectedException { + /** + * @internal + */ export const filterSensitiveLog = (obj: LoopDetectedException): any => ({ ...obj, }); @@ -623,6 +671,9 @@ export interface NotAcceptableException extends __SmithyException, $MetadataBear } export namespace NotAcceptableException { + /** + * @internal + */ export const filterSensitiveLog = (obj: NotAcceptableException): any => ({ ...obj, }); @@ -807,6 +858,9 @@ export interface PostContentRequest { } export namespace PostContentRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: PostContentRequest): any => ({ ...obj, ...(obj.sessionAttributes && { sessionAttributes: SENSITIVE_STRING }), @@ -1090,6 +1144,9 @@ export interface PostContentResponse { } export namespace PostContentResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: PostContentResponse): any => ({ ...obj, ...(obj.message && { message: SENSITIVE_STRING }), @@ -1109,6 +1166,9 @@ export interface RequestTimeoutException extends __SmithyException, $MetadataBea } export namespace RequestTimeoutException { + /** + * @internal + */ export const filterSensitiveLog = (obj: RequestTimeoutException): any => ({ ...obj, }); @@ -1125,6 +1185,9 @@ export interface UnsupportedMediaTypeException extends __SmithyException, $Metad } export namespace UnsupportedMediaTypeException { + /** + * @internal + */ export const filterSensitiveLog = (obj: UnsupportedMediaTypeException): any => ({ ...obj, }); @@ -1208,6 +1271,9 @@ export interface PostTextRequest { } export namespace PostTextRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: PostTextRequest): any => ({ ...obj, ...(obj.sessionAttributes && { sessionAttributes: SENSITIVE_STRING }), @@ -1231,6 +1297,9 @@ export interface IntentConfidence { } export namespace IntentConfidence { + /** + * @internal + */ export const filterSensitiveLog = (obj: IntentConfidence): any => ({ ...obj, }); @@ -1261,6 +1330,9 @@ export interface PredictedIntent { } export namespace PredictedIntent { + /** + * @internal + */ export const filterSensitiveLog = (obj: PredictedIntent): any => ({ ...obj, ...(obj.slots && { slots: SENSITIVE_STRING }), @@ -1290,6 +1362,9 @@ export interface Button { } export namespace Button { + /** + * @internal + */ export const filterSensitiveLog = (obj: Button): any => ({ ...obj, }); @@ -1327,6 +1402,9 @@ export interface GenericAttachment { } export namespace GenericAttachment { + /** + * @internal + */ export const filterSensitiveLog = (obj: GenericAttachment): any => ({ ...obj, }); @@ -1357,6 +1435,9 @@ export interface ResponseCard { } export namespace ResponseCard { + /** + * @internal + */ export const filterSensitiveLog = (obj: ResponseCard): any => ({ ...obj, }); @@ -1382,6 +1463,9 @@ export interface SentimentResponse { } export namespace SentimentResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: SentimentResponse): any => ({ ...obj, }); @@ -1587,6 +1671,9 @@ export interface PostTextResponse { } export namespace PostTextResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: PostTextResponse): any => ({ ...obj, ...(obj.alternativeIntents && { @@ -1725,6 +1812,9 @@ export interface PutSessionRequest { } export namespace PutSessionRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: PutSessionRequest): any => ({ ...obj, ...(obj.sessionAttributes && { sessionAttributes: SENSITIVE_STRING }), @@ -1880,6 +1970,9 @@ export interface PutSessionResponse { } export namespace PutSessionResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: PutSessionResponse): any => ({ ...obj, ...(obj.message && { message: SENSITIVE_STRING }), diff --git a/clients/client-lex-runtime-v2/commands/DeleteSessionCommand.ts b/clients/client-lex-runtime-v2/commands/DeleteSessionCommand.ts index ac20a93e44d0..3ee41d326915 100644 --- a/clients/client-lex-runtime-v2/commands/DeleteSessionCommand.ts +++ b/clients/client-lex-runtime-v2/commands/DeleteSessionCommand.ts @@ -35,6 +35,20 @@ export interface DeleteSessionCommandOutput extends DeleteSessionResponse, __Met *

If the locale doesn't exist in the bot, or if the locale hasn't been * enables for the alias, you receive a * BadRequestException.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { LexRuntimeV2Client, DeleteSessionCommand } from "@aws-sdk/client-lex-runtime-v2"; // ES Modules import + * // const { LexRuntimeV2Client, DeleteSessionCommand } = require("@aws-sdk/client-lex-runtime-v2"); // CommonJS import + * const client = new LexRuntimeV2Client(config); + * const command = new DeleteSessionCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteSessionCommandInput} for command's `input` shape. + * @see {@link DeleteSessionCommandOutput} for command's `response` shape. + * @see {@link LexRuntimeV2ClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteSessionCommand extends $Command< DeleteSessionCommandInput, diff --git a/clients/client-lex-runtime-v2/commands/GetSessionCommand.ts b/clients/client-lex-runtime-v2/commands/GetSessionCommand.ts index f99f9e093a8f..b3aa8e61a095 100644 --- a/clients/client-lex-runtime-v2/commands/GetSessionCommand.ts +++ b/clients/client-lex-runtime-v2/commands/GetSessionCommand.ts @@ -30,6 +30,20 @@ export interface GetSessionCommandOutput extends GetSessionResponse, __MetadataB * returns a BadRequestException. If the locale doesn't exist * or is not enabled for the alias, you receive a * BadRequestException.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { LexRuntimeV2Client, GetSessionCommand } from "@aws-sdk/client-lex-runtime-v2"; // ES Modules import + * // const { LexRuntimeV2Client, GetSessionCommand } = require("@aws-sdk/client-lex-runtime-v2"); // CommonJS import + * const client = new LexRuntimeV2Client(config); + * const command = new GetSessionCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetSessionCommandInput} for command's `input` shape. + * @see {@link GetSessionCommandOutput} for command's `response` shape. + * @see {@link LexRuntimeV2ClientResolvedConfig | config} for command's `input` shape. + * */ export class GetSessionCommand extends $Command< GetSessionCommandInput, diff --git a/clients/client-lex-runtime-v2/commands/PutSessionCommand.ts b/clients/client-lex-runtime-v2/commands/PutSessionCommand.ts index 8fbbb9dfa441..1e73bed76976 100644 --- a/clients/client-lex-runtime-v2/commands/PutSessionCommand.ts +++ b/clients/client-lex-runtime-v2/commands/PutSessionCommand.ts @@ -24,6 +24,20 @@ export interface PutSessionCommandOutput extends PutSessionResponse, __MetadataB *

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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { LexRuntimeV2Client, PutSessionCommand } from "@aws-sdk/client-lex-runtime-v2"; // ES Modules import + * // const { LexRuntimeV2Client, PutSessionCommand } = require("@aws-sdk/client-lex-runtime-v2"); // CommonJS import + * const client = new LexRuntimeV2Client(config); + * const command = new PutSessionCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link PutSessionCommandInput} for command's `input` shape. + * @see {@link PutSessionCommandOutput} for command's `response` shape. + * @see {@link LexRuntimeV2ClientResolvedConfig | config} for command's `input` shape. + * */ export class PutSessionCommand extends $Command< PutSessionCommandInput, diff --git a/clients/client-lex-runtime-v2/commands/RecognizeTextCommand.ts b/clients/client-lex-runtime-v2/commands/RecognizeTextCommand.ts index a27b93212044..6ca8d857119f 100644 --- a/clients/client-lex-runtime-v2/commands/RecognizeTextCommand.ts +++ b/clients/client-lex-runtime-v2/commands/RecognizeTextCommand.ts @@ -26,6 +26,20 @@ export interface RecognizeTextCommandOutput extends RecognizeTextResponse, __Met * using the machine learning model that it build for the bot.

*

In response, Amazon Lex returns the next message to convey to the user * and an optional response card to display.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { LexRuntimeV2Client, RecognizeTextCommand } from "@aws-sdk/client-lex-runtime-v2"; // ES Modules import + * // const { LexRuntimeV2Client, RecognizeTextCommand } = require("@aws-sdk/client-lex-runtime-v2"); // CommonJS import + * const client = new LexRuntimeV2Client(config); + * const command = new RecognizeTextCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link RecognizeTextCommandInput} for command's `input` shape. + * @see {@link RecognizeTextCommandOutput} for command's `response` shape. + * @see {@link LexRuntimeV2ClientResolvedConfig | config} for command's `input` shape. + * */ export class RecognizeTextCommand extends $Command< RecognizeTextCommandInput, diff --git a/clients/client-lex-runtime-v2/commands/RecognizeUtteranceCommand.ts b/clients/client-lex-runtime-v2/commands/RecognizeUtteranceCommand.ts index 511936179a7d..3ac53215bc97 100644 --- a/clients/client-lex-runtime-v2/commands/RecognizeUtteranceCommand.ts +++ b/clients/client-lex-runtime-v2/commands/RecognizeUtteranceCommand.ts @@ -34,6 +34,20 @@ export interface RecognizeUtteranceCommandOutput extends RecognizeUtteranceRespo * this API to send text and audio requests to Amazon Lex at runtime. Amazon Lex * interprets the user input using the machine learning model built for * the bot.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { LexRuntimeV2Client, RecognizeUtteranceCommand } from "@aws-sdk/client-lex-runtime-v2"; // ES Modules import + * // const { LexRuntimeV2Client, RecognizeUtteranceCommand } = require("@aws-sdk/client-lex-runtime-v2"); // CommonJS import + * const client = new LexRuntimeV2Client(config); + * const command = new RecognizeUtteranceCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link RecognizeUtteranceCommandInput} for command's `input` shape. + * @see {@link RecognizeUtteranceCommandOutput} for command's `response` shape. + * @see {@link LexRuntimeV2ClientResolvedConfig | config} for command's `input` shape. + * */ export class RecognizeUtteranceCommand extends $Command< RecognizeUtteranceCommandInput, diff --git a/clients/client-lex-runtime-v2/commands/StartConversationCommand.ts b/clients/client-lex-runtime-v2/commands/StartConversationCommand.ts index 7bed5fa57e34..74f49622e0a2 100644 --- a/clients/client-lex-runtime-v2/commands/StartConversationCommand.ts +++ b/clients/client-lex-runtime-v2/commands/StartConversationCommand.ts @@ -30,6 +30,20 @@ export interface StartConversationCommandOutput extends StartConversationRespons * events. *

*

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { LexRuntimeV2Client, StartConversationCommand } from "@aws-sdk/client-lex-runtime-v2"; // ES Modules import + * // const { LexRuntimeV2Client, StartConversationCommand } = require("@aws-sdk/client-lex-runtime-v2"); // CommonJS import + * const client = new LexRuntimeV2Client(config); + * const command = new StartConversationCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link StartConversationCommandInput} for command's `input` shape. + * @see {@link StartConversationCommandOutput} for command's `response` shape. + * @see {@link LexRuntimeV2ClientResolvedConfig | config} for command's `input` shape. + * */ export class StartConversationCommand extends $Command< StartConversationCommandInput, diff --git a/clients/client-lex-runtime-v2/models/models_0.ts b/clients/client-lex-runtime-v2/models/models_0.ts index 3c833a35c611..0f7c521b7a9f 100644 --- a/clients/client-lex-runtime-v2/models/models_0.ts +++ b/clients/client-lex-runtime-v2/models/models_0.ts @@ -12,6 +12,9 @@ export interface AccessDeniedException extends __SmithyException, $MetadataBeare } export namespace AccessDeniedException { + /** + * @internal + */ export const filterSensitiveLog = (obj: AccessDeniedException): any => ({ ...obj, }); @@ -36,6 +39,9 @@ export interface ActiveContextTimeToLive { } export namespace ActiveContextTimeToLive { + /** + * @internal + */ export const filterSensitiveLog = (obj: ActiveContextTimeToLive): any => ({ ...obj, }); @@ -76,6 +82,9 @@ export interface ActiveContext { } export namespace ActiveContext { + /** + * @internal + */ export const filterSensitiveLog = (obj: ActiveContext): any => ({ ...obj, ...(obj.contextAttributes && { contextAttributes: SENSITIVE_STRING }), @@ -119,6 +128,9 @@ export interface AudioInputEvent { } export namespace AudioInputEvent { + /** + * @internal + */ export const filterSensitiveLog = (obj: AudioInputEvent): any => ({ ...obj, }); @@ -151,6 +163,9 @@ export interface AudioResponseEvent { } export namespace AudioResponseEvent { + /** + * @internal + */ export const filterSensitiveLog = (obj: AudioResponseEvent): any => ({ ...obj, }); @@ -166,6 +181,9 @@ export interface ConflictException extends __SmithyException, $MetadataBearer { } export namespace ConflictException { + /** + * @internal + */ export const filterSensitiveLog = (obj: ConflictException): any => ({ ...obj, }); @@ -195,6 +213,9 @@ export interface DeleteSessionRequest { } export namespace DeleteSessionRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteSessionRequest): any => ({ ...obj, }); @@ -224,6 +245,9 @@ export interface DeleteSessionResponse { } export namespace DeleteSessionResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteSessionResponse): any => ({ ...obj, }); @@ -239,6 +263,9 @@ export interface InternalServerException extends __SmithyException, $MetadataBea } export namespace InternalServerException { + /** + * @internal + */ export const filterSensitiveLog = (obj: InternalServerException): any => ({ ...obj, }); @@ -254,6 +281,9 @@ export interface ResourceNotFoundException extends __SmithyException, $MetadataB } export namespace ResourceNotFoundException { + /** + * @internal + */ export const filterSensitiveLog = (obj: ResourceNotFoundException): any => ({ ...obj, }); @@ -269,6 +299,9 @@ export interface ThrottlingException extends __SmithyException, $MetadataBearer } export namespace ThrottlingException { + /** + * @internal + */ export const filterSensitiveLog = (obj: ThrottlingException): any => ({ ...obj, }); @@ -284,6 +317,9 @@ export interface ValidationException extends __SmithyException, $MetadataBearer } export namespace ValidationException { + /** + * @internal + */ export const filterSensitiveLog = (obj: ValidationException): any => ({ ...obj, }); @@ -313,6 +349,9 @@ export interface GetSessionRequest { } export namespace GetSessionRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetSessionRequest): any => ({ ...obj, }); @@ -350,6 +389,9 @@ export interface Value { } export namespace Value { + /** + * @internal + */ export const filterSensitiveLog = (obj: Value): any => ({ ...obj, }); @@ -366,6 +408,9 @@ export interface Slot { } export namespace Slot { + /** + * @internal + */ export const filterSensitiveLog = (obj: Slot): any => ({ ...obj, }); @@ -408,6 +453,9 @@ export interface Intent { } export namespace Intent { + /** + * @internal + */ export const filterSensitiveLog = (obj: Intent): any => ({ ...obj, }); @@ -427,6 +475,9 @@ export interface ConfidenceScore { } export namespace ConfidenceScore { + /** + * @internal + */ export const filterSensitiveLog = (obj: ConfidenceScore): any => ({ ...obj, }); @@ -469,6 +520,9 @@ export interface SentimentScore { } export namespace SentimentScore { + /** + * @internal + */ export const filterSensitiveLog = (obj: SentimentScore): any => ({ ...obj, }); @@ -498,6 +552,9 @@ export interface SentimentResponse { } export namespace SentimentResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: SentimentResponse): any => ({ ...obj, }); @@ -534,6 +591,9 @@ export interface Interpretation { } export namespace Interpretation { + /** + * @internal + */ export const filterSensitiveLog = (obj: Interpretation): any => ({ ...obj, }); @@ -562,6 +622,9 @@ export interface Button { } export namespace Button { + /** + * @internal + */ export const filterSensitiveLog = (obj: Button): any => ({ ...obj, }); @@ -603,6 +666,9 @@ export interface ImageResponseCard { } export namespace ImageResponseCard { + /** + * @internal + */ export const filterSensitiveLog = (obj: ImageResponseCard): any => ({ ...obj, }); @@ -632,6 +698,9 @@ export interface Message { } export namespace Message { + /** + * @internal + */ export const filterSensitiveLog = (obj: Message): any => ({ ...obj, ...(obj.content && { content: SENSITIVE_STRING }), @@ -687,6 +756,9 @@ export interface DialogAction { } export namespace DialogAction { + /** + * @internal + */ export const filterSensitiveLog = (obj: DialogAction): any => ({ ...obj, }); @@ -728,6 +800,9 @@ export interface SessionState { } export namespace SessionState { + /** + * @internal + */ export const filterSensitiveLog = (obj: SessionState): any => ({ ...obj, ...(obj.activeContexts && { @@ -770,6 +845,9 @@ export interface GetSessionResponse { } export namespace GetSessionResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetSessionResponse): any => ({ ...obj, ...(obj.messages && { messages: obj.messages.map((item) => Message.filterSensitiveLog(item)) }), @@ -787,6 +865,9 @@ export interface BadGatewayException extends __SmithyException, $MetadataBearer } export namespace BadGatewayException { + /** + * @internal + */ export const filterSensitiveLog = (obj: BadGatewayException): any => ({ ...obj, }); @@ -802,6 +883,9 @@ export interface DependencyFailedException extends __SmithyException, $MetadataB } export namespace DependencyFailedException { + /** + * @internal + */ export const filterSensitiveLog = (obj: DependencyFailedException): any => ({ ...obj, }); @@ -866,6 +950,9 @@ export interface PutSessionRequest { } export namespace PutSessionRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: PutSessionRequest): any => ({ ...obj, ...(obj.messages && { messages: obj.messages.map((item) => Message.filterSensitiveLog(item)) }), @@ -915,6 +1002,9 @@ export interface PutSessionResponse { } export namespace PutSessionResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: PutSessionResponse): any => ({ ...obj, }); @@ -964,6 +1054,9 @@ export interface RecognizeTextRequest { } export namespace RecognizeTextRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: RecognizeTextRequest): any => ({ ...obj, ...(obj.text && { text: SENSITIVE_STRING }), @@ -1009,6 +1102,9 @@ export interface RecognizeTextResponse { } export namespace RecognizeTextResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: RecognizeTextResponse): any => ({ ...obj, ...(obj.messages && { messages: obj.messages.map((item) => Message.filterSensitiveLog(item)) }), @@ -1148,6 +1244,9 @@ export interface RecognizeUtteranceRequest { } export namespace RecognizeUtteranceRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: RecognizeUtteranceRequest): any => ({ ...obj, ...(obj.sessionState && { sessionState: SENSITIVE_STRING }), @@ -1230,6 +1329,9 @@ export interface RecognizeUtteranceResponse { } export namespace RecognizeUtteranceResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: RecognizeUtteranceResponse): any => ({ ...obj, }); @@ -1332,6 +1434,9 @@ export interface ConfigurationEvent { } export namespace ConfigurationEvent { + /** + * @internal + */ export const filterSensitiveLog = (obj: ConfigurationEvent): any => ({ ...obj, ...(obj.sessionState && { sessionState: SessionState.filterSensitiveLog(obj.sessionState) }), @@ -1361,6 +1466,9 @@ export interface DisconnectionEvent { } export namespace DisconnectionEvent { + /** + * @internal + */ export const filterSensitiveLog = (obj: DisconnectionEvent): any => ({ ...obj, }); @@ -1393,6 +1501,9 @@ export interface DTMFInputEvent { } export namespace DTMFInputEvent { + /** + * @internal + */ export const filterSensitiveLog = (obj: DTMFInputEvent): any => ({ ...obj, ...(obj.inputCharacter && { inputCharacter: SENSITIVE_STRING }), @@ -1419,6 +1530,9 @@ export interface PlaybackCompletionEvent { } export namespace PlaybackCompletionEvent { + /** + * @internal + */ export const filterSensitiveLog = (obj: PlaybackCompletionEvent): any => ({ ...obj, }); @@ -1449,6 +1563,9 @@ export interface TextInputEvent { } export namespace TextInputEvent { + /** + * @internal + */ export const filterSensitiveLog = (obj: TextInputEvent): any => ({ ...obj, ...(obj.text && { text: SENSITIVE_STRING }), @@ -1601,6 +1718,9 @@ export namespace StartConversationRequestEventStream { return visitor._(value.$unknown[0], value.$unknown[1]); }; + /** + * @internal + */ export const filterSensitiveLog = (obj: StartConversationRequestEventStream): any => { if (obj.ConfigurationEvent !== undefined) return { ConfigurationEvent: ConfigurationEvent.filterSensitiveLog(obj.ConfigurationEvent) }; @@ -1657,6 +1777,9 @@ export interface StartConversationRequest { } export namespace StartConversationRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: StartConversationRequest): any => ({ ...obj, ...(obj.requestEventStream && { requestEventStream: "STREAMING_CONTENT" }), @@ -1678,6 +1801,9 @@ export interface HeartbeatEvent { } export namespace HeartbeatEvent { + /** + * @internal + */ export const filterSensitiveLog = (obj: HeartbeatEvent): any => ({ ...obj, }); @@ -1735,6 +1861,9 @@ export interface IntentResultEvent { } export namespace IntentResultEvent { + /** + * @internal + */ export const filterSensitiveLog = (obj: IntentResultEvent): any => ({ ...obj, ...(obj.sessionState && { sessionState: SessionState.filterSensitiveLog(obj.sessionState) }), @@ -1777,6 +1906,9 @@ export interface PlaybackInterruptionEvent { } export namespace PlaybackInterruptionEvent { + /** + * @internal + */ export const filterSensitiveLog = (obj: PlaybackInterruptionEvent): any => ({ ...obj, }); @@ -1804,6 +1936,9 @@ export interface TextResponseEvent { } export namespace TextResponseEvent { + /** + * @internal + */ export const filterSensitiveLog = (obj: TextResponseEvent): any => ({ ...obj, ...(obj.messages && { messages: obj.messages.map((item) => Message.filterSensitiveLog(item)) }), @@ -1830,6 +1965,9 @@ export interface TranscriptEvent { } export namespace TranscriptEvent { + /** + * @internal + */ export const filterSensitiveLog = (obj: TranscriptEvent): any => ({ ...obj, }); @@ -2228,6 +2366,9 @@ export namespace StartConversationResponseEventStream { return visitor._(value.$unknown[0], value.$unknown[1]); }; + /** + * @internal + */ export const filterSensitiveLog = (obj: StartConversationResponseEventStream): any => { if (obj.PlaybackInterruptionEvent !== undefined) return { PlaybackInterruptionEvent: PlaybackInterruptionEvent.filterSensitiveLog(obj.PlaybackInterruptionEvent) }; @@ -2270,6 +2411,9 @@ export interface StartConversationResponse { } export namespace StartConversationResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: StartConversationResponse): any => ({ ...obj, ...(obj.responseEventStream && { responseEventStream: "STREAMING_CONTENT" }), diff --git a/clients/client-license-manager/commands/AcceptGrantCommand.ts b/clients/client-license-manager/commands/AcceptGrantCommand.ts index 9cff8aab49c2..1394891a870e 100644 --- a/clients/client-license-manager/commands/AcceptGrantCommand.ts +++ b/clients/client-license-manager/commands/AcceptGrantCommand.ts @@ -22,6 +22,20 @@ export interface AcceptGrantCommandOutput extends AcceptGrantResponse, __Metadat /** *

Accepts the specified grant.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { LicenseManagerClient, AcceptGrantCommand } from "@aws-sdk/client-license-manager"; // ES Modules import + * // const { LicenseManagerClient, AcceptGrantCommand } = require("@aws-sdk/client-license-manager"); // CommonJS import + * const client = new LicenseManagerClient(config); + * const command = new AcceptGrantCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link AcceptGrantCommandInput} for command's `input` shape. + * @see {@link AcceptGrantCommandOutput} for command's `response` shape. + * @see {@link LicenseManagerClientResolvedConfig | config} for command's `input` shape. + * */ export class AcceptGrantCommand extends $Command< AcceptGrantCommandInput, diff --git a/clients/client-license-manager/commands/CheckInLicenseCommand.ts b/clients/client-license-manager/commands/CheckInLicenseCommand.ts index 5095e5cb2ca3..13a8d88c717a 100644 --- a/clients/client-license-manager/commands/CheckInLicenseCommand.ts +++ b/clients/client-license-manager/commands/CheckInLicenseCommand.ts @@ -22,6 +22,20 @@ export interface CheckInLicenseCommandOutput extends CheckInLicenseResponse, __M /** *

Checks in the specified license. Check in a license when it is no longer in use.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { LicenseManagerClient, CheckInLicenseCommand } from "@aws-sdk/client-license-manager"; // ES Modules import + * // const { LicenseManagerClient, CheckInLicenseCommand } = require("@aws-sdk/client-license-manager"); // CommonJS import + * const client = new LicenseManagerClient(config); + * const command = new CheckInLicenseCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CheckInLicenseCommandInput} for command's `input` shape. + * @see {@link CheckInLicenseCommandOutput} for command's `response` shape. + * @see {@link LicenseManagerClientResolvedConfig | config} for command's `input` shape. + * */ export class CheckInLicenseCommand extends $Command< CheckInLicenseCommandInput, diff --git a/clients/client-license-manager/commands/CheckoutBorrowLicenseCommand.ts b/clients/client-license-manager/commands/CheckoutBorrowLicenseCommand.ts index 29fea370f561..89f4d73abdbd 100644 --- a/clients/client-license-manager/commands/CheckoutBorrowLicenseCommand.ts +++ b/clients/client-license-manager/commands/CheckoutBorrowLicenseCommand.ts @@ -22,6 +22,20 @@ export interface CheckoutBorrowLicenseCommandOutput extends CheckoutBorrowLicens /** *

Checks out the specified license for offline use.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { LicenseManagerClient, CheckoutBorrowLicenseCommand } from "@aws-sdk/client-license-manager"; // ES Modules import + * // const { LicenseManagerClient, CheckoutBorrowLicenseCommand } = require("@aws-sdk/client-license-manager"); // CommonJS import + * const client = new LicenseManagerClient(config); + * const command = new CheckoutBorrowLicenseCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CheckoutBorrowLicenseCommandInput} for command's `input` shape. + * @see {@link CheckoutBorrowLicenseCommandOutput} for command's `response` shape. + * @see {@link LicenseManagerClientResolvedConfig | config} for command's `input` shape. + * */ export class CheckoutBorrowLicenseCommand extends $Command< CheckoutBorrowLicenseCommandInput, diff --git a/clients/client-license-manager/commands/CheckoutLicenseCommand.ts b/clients/client-license-manager/commands/CheckoutLicenseCommand.ts index 20fa625186f4..27d5aa8f144f 100644 --- a/clients/client-license-manager/commands/CheckoutLicenseCommand.ts +++ b/clients/client-license-manager/commands/CheckoutLicenseCommand.ts @@ -22,6 +22,20 @@ export interface CheckoutLicenseCommandOutput extends CheckoutLicenseResponse, _ /** *

Checks out the specified license.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { LicenseManagerClient, CheckoutLicenseCommand } from "@aws-sdk/client-license-manager"; // ES Modules import + * // const { LicenseManagerClient, CheckoutLicenseCommand } = require("@aws-sdk/client-license-manager"); // CommonJS import + * const client = new LicenseManagerClient(config); + * const command = new CheckoutLicenseCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CheckoutLicenseCommandInput} for command's `input` shape. + * @see {@link CheckoutLicenseCommandOutput} for command's `response` shape. + * @see {@link LicenseManagerClientResolvedConfig | config} for command's `input` shape. + * */ export class CheckoutLicenseCommand extends $Command< CheckoutLicenseCommandInput, diff --git a/clients/client-license-manager/commands/CreateGrantCommand.ts b/clients/client-license-manager/commands/CreateGrantCommand.ts index ca481228c19c..17a4a01f2f24 100644 --- a/clients/client-license-manager/commands/CreateGrantCommand.ts +++ b/clients/client-license-manager/commands/CreateGrantCommand.ts @@ -22,6 +22,20 @@ export interface CreateGrantCommandOutput extends CreateGrantResponse, __Metadat /** *

Creates a grant for the specified license. A grant shares the use of license entitlements with specific AWS accounts.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { LicenseManagerClient, CreateGrantCommand } from "@aws-sdk/client-license-manager"; // ES Modules import + * // const { LicenseManagerClient, CreateGrantCommand } = require("@aws-sdk/client-license-manager"); // CommonJS import + * const client = new LicenseManagerClient(config); + * const command = new CreateGrantCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreateGrantCommandInput} for command's `input` shape. + * @see {@link CreateGrantCommandOutput} for command's `response` shape. + * @see {@link LicenseManagerClientResolvedConfig | config} for command's `input` shape. + * */ export class CreateGrantCommand extends $Command< CreateGrantCommandInput, diff --git a/clients/client-license-manager/commands/CreateGrantVersionCommand.ts b/clients/client-license-manager/commands/CreateGrantVersionCommand.ts index 174231dda584..45f9c8cb29e8 100644 --- a/clients/client-license-manager/commands/CreateGrantVersionCommand.ts +++ b/clients/client-license-manager/commands/CreateGrantVersionCommand.ts @@ -22,6 +22,20 @@ export interface CreateGrantVersionCommandOutput extends CreateGrantVersionRespo /** *

Creates a new version of the specified grant.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { LicenseManagerClient, CreateGrantVersionCommand } from "@aws-sdk/client-license-manager"; // ES Modules import + * // const { LicenseManagerClient, CreateGrantVersionCommand } = require("@aws-sdk/client-license-manager"); // CommonJS import + * const client = new LicenseManagerClient(config); + * const command = new CreateGrantVersionCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreateGrantVersionCommandInput} for command's `input` shape. + * @see {@link CreateGrantVersionCommandOutput} for command's `response` shape. + * @see {@link LicenseManagerClientResolvedConfig | config} for command's `input` shape. + * */ export class CreateGrantVersionCommand extends $Command< CreateGrantVersionCommandInput, diff --git a/clients/client-license-manager/commands/CreateLicenseCommand.ts b/clients/client-license-manager/commands/CreateLicenseCommand.ts index 659bc8d80ff0..67c1291b894d 100644 --- a/clients/client-license-manager/commands/CreateLicenseCommand.ts +++ b/clients/client-license-manager/commands/CreateLicenseCommand.ts @@ -22,6 +22,20 @@ export interface CreateLicenseCommandOutput extends CreateLicenseResponse, __Met /** *

Creates a license.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { LicenseManagerClient, CreateLicenseCommand } from "@aws-sdk/client-license-manager"; // ES Modules import + * // const { LicenseManagerClient, CreateLicenseCommand } = require("@aws-sdk/client-license-manager"); // CommonJS import + * const client = new LicenseManagerClient(config); + * const command = new CreateLicenseCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreateLicenseCommandInput} for command's `input` shape. + * @see {@link CreateLicenseCommandOutput} for command's `response` shape. + * @see {@link LicenseManagerClientResolvedConfig | config} for command's `input` shape. + * */ export class CreateLicenseCommand extends $Command< CreateLicenseCommandInput, diff --git a/clients/client-license-manager/commands/CreateLicenseConfigurationCommand.ts b/clients/client-license-manager/commands/CreateLicenseConfigurationCommand.ts index 99dbf9719323..020c7914ebd3 100644 --- a/clients/client-license-manager/commands/CreateLicenseConfigurationCommand.ts +++ b/clients/client-license-manager/commands/CreateLicenseConfigurationCommand.ts @@ -27,6 +27,20 @@ export interface CreateLicenseConfigurationCommandOutput extends CreateLicenseCo * 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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { LicenseManagerClient, CreateLicenseConfigurationCommand } from "@aws-sdk/client-license-manager"; // ES Modules import + * // const { LicenseManagerClient, CreateLicenseConfigurationCommand } = require("@aws-sdk/client-license-manager"); // CommonJS import + * const client = new LicenseManagerClient(config); + * const command = new CreateLicenseConfigurationCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreateLicenseConfigurationCommandInput} for command's `input` shape. + * @see {@link CreateLicenseConfigurationCommandOutput} for command's `response` shape. + * @see {@link LicenseManagerClientResolvedConfig | config} for command's `input` shape. + * */ export class CreateLicenseConfigurationCommand extends $Command< CreateLicenseConfigurationCommandInput, diff --git a/clients/client-license-manager/commands/CreateLicenseVersionCommand.ts b/clients/client-license-manager/commands/CreateLicenseVersionCommand.ts index 693734c6f523..8ae99c51134b 100644 --- a/clients/client-license-manager/commands/CreateLicenseVersionCommand.ts +++ b/clients/client-license-manager/commands/CreateLicenseVersionCommand.ts @@ -22,6 +22,20 @@ export interface CreateLicenseVersionCommandOutput extends CreateLicenseVersionR /** *

Creates a new version of the specified license.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { LicenseManagerClient, CreateLicenseVersionCommand } from "@aws-sdk/client-license-manager"; // ES Modules import + * // const { LicenseManagerClient, CreateLicenseVersionCommand } = require("@aws-sdk/client-license-manager"); // CommonJS import + * const client = new LicenseManagerClient(config); + * const command = new CreateLicenseVersionCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreateLicenseVersionCommandInput} for command's `input` shape. + * @see {@link CreateLicenseVersionCommandOutput} for command's `response` shape. + * @see {@link LicenseManagerClientResolvedConfig | config} for command's `input` shape. + * */ export class CreateLicenseVersionCommand extends $Command< CreateLicenseVersionCommandInput, diff --git a/clients/client-license-manager/commands/CreateTokenCommand.ts b/clients/client-license-manager/commands/CreateTokenCommand.ts index 2b43cb3497db..f4045061194f 100644 --- a/clients/client-license-manager/commands/CreateTokenCommand.ts +++ b/clients/client-license-manager/commands/CreateTokenCommand.ts @@ -25,6 +25,20 @@ export interface CreateTokenCommandOutput extends CreateTokenResponse, __Metadat *

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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { LicenseManagerClient, CreateTokenCommand } from "@aws-sdk/client-license-manager"; // ES Modules import + * // const { LicenseManagerClient, CreateTokenCommand } = require("@aws-sdk/client-license-manager"); // CommonJS import + * const client = new LicenseManagerClient(config); + * const command = new CreateTokenCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreateTokenCommandInput} for command's `input` shape. + * @see {@link CreateTokenCommandOutput} for command's `response` shape. + * @see {@link LicenseManagerClientResolvedConfig | config} for command's `input` shape. + * */ export class CreateTokenCommand extends $Command< CreateTokenCommandInput, diff --git a/clients/client-license-manager/commands/DeleteGrantCommand.ts b/clients/client-license-manager/commands/DeleteGrantCommand.ts index 7cadbc6838a9..2936cdaaec65 100644 --- a/clients/client-license-manager/commands/DeleteGrantCommand.ts +++ b/clients/client-license-manager/commands/DeleteGrantCommand.ts @@ -22,6 +22,20 @@ export interface DeleteGrantCommandOutput extends DeleteGrantResponse, __Metadat /** *

Deletes the specified grant.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { LicenseManagerClient, DeleteGrantCommand } from "@aws-sdk/client-license-manager"; // ES Modules import + * // const { LicenseManagerClient, DeleteGrantCommand } = require("@aws-sdk/client-license-manager"); // CommonJS import + * const client = new LicenseManagerClient(config); + * const command = new DeleteGrantCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteGrantCommandInput} for command's `input` shape. + * @see {@link DeleteGrantCommandOutput} for command's `response` shape. + * @see {@link LicenseManagerClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteGrantCommand extends $Command< DeleteGrantCommandInput, diff --git a/clients/client-license-manager/commands/DeleteLicenseCommand.ts b/clients/client-license-manager/commands/DeleteLicenseCommand.ts index c35ace0fa2aa..b501098b77e0 100644 --- a/clients/client-license-manager/commands/DeleteLicenseCommand.ts +++ b/clients/client-license-manager/commands/DeleteLicenseCommand.ts @@ -22,6 +22,20 @@ export interface DeleteLicenseCommandOutput extends DeleteLicenseResponse, __Met /** *

Deletes the specified license.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { LicenseManagerClient, DeleteLicenseCommand } from "@aws-sdk/client-license-manager"; // ES Modules import + * // const { LicenseManagerClient, DeleteLicenseCommand } = require("@aws-sdk/client-license-manager"); // CommonJS import + * const client = new LicenseManagerClient(config); + * const command = new DeleteLicenseCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteLicenseCommandInput} for command's `input` shape. + * @see {@link DeleteLicenseCommandOutput} for command's `response` shape. + * @see {@link LicenseManagerClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteLicenseCommand extends $Command< DeleteLicenseCommandInput, diff --git a/clients/client-license-manager/commands/DeleteLicenseConfigurationCommand.ts b/clients/client-license-manager/commands/DeleteLicenseConfigurationCommand.ts index 6ea5c1393e8a..88135d27dabe 100644 --- a/clients/client-license-manager/commands/DeleteLicenseConfigurationCommand.ts +++ b/clients/client-license-manager/commands/DeleteLicenseConfigurationCommand.ts @@ -23,6 +23,20 @@ export interface DeleteLicenseConfigurationCommandOutput extends DeleteLicenseCo /** *

Deletes the specified license configuration.

*

You cannot delete a license configuration that is in use.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { LicenseManagerClient, DeleteLicenseConfigurationCommand } from "@aws-sdk/client-license-manager"; // ES Modules import + * // const { LicenseManagerClient, DeleteLicenseConfigurationCommand } = require("@aws-sdk/client-license-manager"); // CommonJS import + * const client = new LicenseManagerClient(config); + * const command = new DeleteLicenseConfigurationCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteLicenseConfigurationCommandInput} for command's `input` shape. + * @see {@link DeleteLicenseConfigurationCommandOutput} for command's `response` shape. + * @see {@link LicenseManagerClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteLicenseConfigurationCommand extends $Command< DeleteLicenseConfigurationCommandInput, diff --git a/clients/client-license-manager/commands/DeleteTokenCommand.ts b/clients/client-license-manager/commands/DeleteTokenCommand.ts index fc582ea2966c..faf4379c5b5d 100644 --- a/clients/client-license-manager/commands/DeleteTokenCommand.ts +++ b/clients/client-license-manager/commands/DeleteTokenCommand.ts @@ -22,6 +22,20 @@ export interface DeleteTokenCommandOutput extends DeleteTokenResponse, __Metadat /** *

Deletes the specified token. Must be called in the license home Region.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { LicenseManagerClient, DeleteTokenCommand } from "@aws-sdk/client-license-manager"; // ES Modules import + * // const { LicenseManagerClient, DeleteTokenCommand } = require("@aws-sdk/client-license-manager"); // CommonJS import + * const client = new LicenseManagerClient(config); + * const command = new DeleteTokenCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteTokenCommandInput} for command's `input` shape. + * @see {@link DeleteTokenCommandOutput} for command's `response` shape. + * @see {@link LicenseManagerClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteTokenCommand extends $Command< DeleteTokenCommandInput, diff --git a/clients/client-license-manager/commands/ExtendLicenseConsumptionCommand.ts b/clients/client-license-manager/commands/ExtendLicenseConsumptionCommand.ts index 5be61914bb49..f7c22ef96557 100644 --- a/clients/client-license-manager/commands/ExtendLicenseConsumptionCommand.ts +++ b/clients/client-license-manager/commands/ExtendLicenseConsumptionCommand.ts @@ -22,6 +22,20 @@ export interface ExtendLicenseConsumptionCommandOutput extends ExtendLicenseCons /** *

Extends the expiration date for license consumption.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { LicenseManagerClient, ExtendLicenseConsumptionCommand } from "@aws-sdk/client-license-manager"; // ES Modules import + * // const { LicenseManagerClient, ExtendLicenseConsumptionCommand } = require("@aws-sdk/client-license-manager"); // CommonJS import + * const client = new LicenseManagerClient(config); + * const command = new ExtendLicenseConsumptionCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ExtendLicenseConsumptionCommandInput} for command's `input` shape. + * @see {@link ExtendLicenseConsumptionCommandOutput} for command's `response` shape. + * @see {@link LicenseManagerClientResolvedConfig | config} for command's `input` shape. + * */ export class ExtendLicenseConsumptionCommand extends $Command< ExtendLicenseConsumptionCommandInput, diff --git a/clients/client-license-manager/commands/GetAccessTokenCommand.ts b/clients/client-license-manager/commands/GetAccessTokenCommand.ts index a9c4b52063e8..bf44a84adfdb 100644 --- a/clients/client-license-manager/commands/GetAccessTokenCommand.ts +++ b/clients/client-license-manager/commands/GetAccessTokenCommand.ts @@ -23,6 +23,20 @@ export interface GetAccessTokenCommandOutput extends GetAccessTokenResponse, __M /** *

Gets a temporary access token to use with AssumeRoleWithWebIdentity. Access tokens * are valid for one hour.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { LicenseManagerClient, GetAccessTokenCommand } from "@aws-sdk/client-license-manager"; // ES Modules import + * // const { LicenseManagerClient, GetAccessTokenCommand } = require("@aws-sdk/client-license-manager"); // CommonJS import + * const client = new LicenseManagerClient(config); + * const command = new GetAccessTokenCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetAccessTokenCommandInput} for command's `input` shape. + * @see {@link GetAccessTokenCommandOutput} for command's `response` shape. + * @see {@link LicenseManagerClientResolvedConfig | config} for command's `input` shape. + * */ export class GetAccessTokenCommand extends $Command< GetAccessTokenCommandInput, diff --git a/clients/client-license-manager/commands/GetGrantCommand.ts b/clients/client-license-manager/commands/GetGrantCommand.ts index 8f65453ae207..ad29974586d0 100644 --- a/clients/client-license-manager/commands/GetGrantCommand.ts +++ b/clients/client-license-manager/commands/GetGrantCommand.ts @@ -19,6 +19,20 @@ export interface GetGrantCommandOutput extends GetGrantResponse, __MetadataBeare /** *

Gets detailed information about the specified grant.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { LicenseManagerClient, GetGrantCommand } from "@aws-sdk/client-license-manager"; // ES Modules import + * // const { LicenseManagerClient, GetGrantCommand } = require("@aws-sdk/client-license-manager"); // CommonJS import + * const client = new LicenseManagerClient(config); + * const command = new GetGrantCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetGrantCommandInput} for command's `input` shape. + * @see {@link GetGrantCommandOutput} for command's `response` shape. + * @see {@link LicenseManagerClientResolvedConfig | config} for command's `input` shape. + * */ export class GetGrantCommand extends $Command< GetGrantCommandInput, diff --git a/clients/client-license-manager/commands/GetLicenseCommand.ts b/clients/client-license-manager/commands/GetLicenseCommand.ts index 93080a18d93c..eb3733091f93 100644 --- a/clients/client-license-manager/commands/GetLicenseCommand.ts +++ b/clients/client-license-manager/commands/GetLicenseCommand.ts @@ -22,6 +22,20 @@ export interface GetLicenseCommandOutput extends GetLicenseResponse, __MetadataB /** *

Gets detailed information about the specified license.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { LicenseManagerClient, GetLicenseCommand } from "@aws-sdk/client-license-manager"; // ES Modules import + * // const { LicenseManagerClient, GetLicenseCommand } = require("@aws-sdk/client-license-manager"); // CommonJS import + * const client = new LicenseManagerClient(config); + * const command = new GetLicenseCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetLicenseCommandInput} for command's `input` shape. + * @see {@link GetLicenseCommandOutput} for command's `response` shape. + * @see {@link LicenseManagerClientResolvedConfig | config} for command's `input` shape. + * */ export class GetLicenseCommand extends $Command< GetLicenseCommandInput, diff --git a/clients/client-license-manager/commands/GetLicenseConfigurationCommand.ts b/clients/client-license-manager/commands/GetLicenseConfigurationCommand.ts index f762ad7a9542..3facbc697a07 100644 --- a/clients/client-license-manager/commands/GetLicenseConfigurationCommand.ts +++ b/clients/client-license-manager/commands/GetLicenseConfigurationCommand.ts @@ -22,6 +22,20 @@ export interface GetLicenseConfigurationCommandOutput extends GetLicenseConfigur /** *

Gets detailed information about the specified license configuration.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { LicenseManagerClient, GetLicenseConfigurationCommand } from "@aws-sdk/client-license-manager"; // ES Modules import + * // const { LicenseManagerClient, GetLicenseConfigurationCommand } = require("@aws-sdk/client-license-manager"); // CommonJS import + * const client = new LicenseManagerClient(config); + * const command = new GetLicenseConfigurationCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetLicenseConfigurationCommandInput} for command's `input` shape. + * @see {@link GetLicenseConfigurationCommandOutput} for command's `response` shape. + * @see {@link LicenseManagerClientResolvedConfig | config} for command's `input` shape. + * */ export class GetLicenseConfigurationCommand extends $Command< GetLicenseConfigurationCommandInput, diff --git a/clients/client-license-manager/commands/GetLicenseUsageCommand.ts b/clients/client-license-manager/commands/GetLicenseUsageCommand.ts index 6293a3b7a7ae..9e19c4a1c6cb 100644 --- a/clients/client-license-manager/commands/GetLicenseUsageCommand.ts +++ b/clients/client-license-manager/commands/GetLicenseUsageCommand.ts @@ -22,6 +22,20 @@ export interface GetLicenseUsageCommandOutput extends GetLicenseUsageResponse, _ /** *

Gets detailed information about the usage of the specified license.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { LicenseManagerClient, GetLicenseUsageCommand } from "@aws-sdk/client-license-manager"; // ES Modules import + * // const { LicenseManagerClient, GetLicenseUsageCommand } = require("@aws-sdk/client-license-manager"); // CommonJS import + * const client = new LicenseManagerClient(config); + * const command = new GetLicenseUsageCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetLicenseUsageCommandInput} for command's `input` shape. + * @see {@link GetLicenseUsageCommandOutput} for command's `response` shape. + * @see {@link LicenseManagerClientResolvedConfig | config} for command's `input` shape. + * */ export class GetLicenseUsageCommand extends $Command< GetLicenseUsageCommandInput, diff --git a/clients/client-license-manager/commands/GetServiceSettingsCommand.ts b/clients/client-license-manager/commands/GetServiceSettingsCommand.ts index 4a5d75b3b44e..0362b8d29e12 100644 --- a/clients/client-license-manager/commands/GetServiceSettingsCommand.ts +++ b/clients/client-license-manager/commands/GetServiceSettingsCommand.ts @@ -22,6 +22,20 @@ export interface GetServiceSettingsCommandOutput extends GetServiceSettingsRespo /** *

Gets the License Manager settings for the current Region.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { LicenseManagerClient, GetServiceSettingsCommand } from "@aws-sdk/client-license-manager"; // ES Modules import + * // const { LicenseManagerClient, GetServiceSettingsCommand } = require("@aws-sdk/client-license-manager"); // CommonJS import + * const client = new LicenseManagerClient(config); + * const command = new GetServiceSettingsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetServiceSettingsCommandInput} for command's `input` shape. + * @see {@link GetServiceSettingsCommandOutput} for command's `response` shape. + * @see {@link LicenseManagerClientResolvedConfig | config} for command's `input` shape. + * */ export class GetServiceSettingsCommand extends $Command< GetServiceSettingsCommandInput, diff --git a/clients/client-license-manager/commands/ListAssociationsForLicenseConfigurationCommand.ts b/clients/client-license-manager/commands/ListAssociationsForLicenseConfigurationCommand.ts index d80c31755cc8..d3605110e360 100644 --- a/clients/client-license-manager/commands/ListAssociationsForLicenseConfigurationCommand.ts +++ b/clients/client-license-manager/commands/ListAssociationsForLicenseConfigurationCommand.ts @@ -31,6 +31,20 @@ export interface ListAssociationsForLicenseConfigurationCommandOutput *

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).

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { LicenseManagerClient, ListAssociationsForLicenseConfigurationCommand } from "@aws-sdk/client-license-manager"; // ES Modules import + * // const { LicenseManagerClient, ListAssociationsForLicenseConfigurationCommand } = require("@aws-sdk/client-license-manager"); // CommonJS import + * const client = new LicenseManagerClient(config); + * const command = new ListAssociationsForLicenseConfigurationCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListAssociationsForLicenseConfigurationCommandInput} for command's `input` shape. + * @see {@link ListAssociationsForLicenseConfigurationCommandOutput} for command's `response` shape. + * @see {@link LicenseManagerClientResolvedConfig | config} for command's `input` shape. + * */ export class ListAssociationsForLicenseConfigurationCommand extends $Command< ListAssociationsForLicenseConfigurationCommandInput, diff --git a/clients/client-license-manager/commands/ListDistributedGrantsCommand.ts b/clients/client-license-manager/commands/ListDistributedGrantsCommand.ts index d618c6214bda..404bc274e64b 100644 --- a/clients/client-license-manager/commands/ListDistributedGrantsCommand.ts +++ b/clients/client-license-manager/commands/ListDistributedGrantsCommand.ts @@ -22,6 +22,20 @@ export interface ListDistributedGrantsCommandOutput extends ListDistributedGrant /** *

Lists the grants distributed for the specified license.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { LicenseManagerClient, ListDistributedGrantsCommand } from "@aws-sdk/client-license-manager"; // ES Modules import + * // const { LicenseManagerClient, ListDistributedGrantsCommand } = require("@aws-sdk/client-license-manager"); // CommonJS import + * const client = new LicenseManagerClient(config); + * const command = new ListDistributedGrantsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListDistributedGrantsCommandInput} for command's `input` shape. + * @see {@link ListDistributedGrantsCommandOutput} for command's `response` shape. + * @see {@link LicenseManagerClientResolvedConfig | config} for command's `input` shape. + * */ export class ListDistributedGrantsCommand extends $Command< ListDistributedGrantsCommandInput, diff --git a/clients/client-license-manager/commands/ListFailuresForLicenseConfigurationOperationsCommand.ts b/clients/client-license-manager/commands/ListFailuresForLicenseConfigurationOperationsCommand.ts index 5eca36c4ef0f..f1b244a52842 100644 --- a/clients/client-license-manager/commands/ListFailuresForLicenseConfigurationOperationsCommand.ts +++ b/clients/client-license-manager/commands/ListFailuresForLicenseConfigurationOperationsCommand.ts @@ -28,6 +28,20 @@ export interface ListFailuresForLicenseConfigurationOperationsCommandOutput /** *

Lists the license configuration operations that failed.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { LicenseManagerClient, ListFailuresForLicenseConfigurationOperationsCommand } from "@aws-sdk/client-license-manager"; // ES Modules import + * // const { LicenseManagerClient, ListFailuresForLicenseConfigurationOperationsCommand } = require("@aws-sdk/client-license-manager"); // CommonJS import + * const client = new LicenseManagerClient(config); + * const command = new ListFailuresForLicenseConfigurationOperationsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListFailuresForLicenseConfigurationOperationsCommandInput} for command's `input` shape. + * @see {@link ListFailuresForLicenseConfigurationOperationsCommandOutput} for command's `response` shape. + * @see {@link LicenseManagerClientResolvedConfig | config} for command's `input` shape. + * */ export class ListFailuresForLicenseConfigurationOperationsCommand extends $Command< ListFailuresForLicenseConfigurationOperationsCommandInput, diff --git a/clients/client-license-manager/commands/ListLicenseConfigurationsCommand.ts b/clients/client-license-manager/commands/ListLicenseConfigurationsCommand.ts index d4ea4ef17c73..c56c86355a13 100644 --- a/clients/client-license-manager/commands/ListLicenseConfigurationsCommand.ts +++ b/clients/client-license-manager/commands/ListLicenseConfigurationsCommand.ts @@ -22,6 +22,20 @@ export interface ListLicenseConfigurationsCommandOutput extends ListLicenseConfi /** *

Lists the license configurations for your account.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { LicenseManagerClient, ListLicenseConfigurationsCommand } from "@aws-sdk/client-license-manager"; // ES Modules import + * // const { LicenseManagerClient, ListLicenseConfigurationsCommand } = require("@aws-sdk/client-license-manager"); // CommonJS import + * const client = new LicenseManagerClient(config); + * const command = new ListLicenseConfigurationsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListLicenseConfigurationsCommandInput} for command's `input` shape. + * @see {@link ListLicenseConfigurationsCommandOutput} for command's `response` shape. + * @see {@link LicenseManagerClientResolvedConfig | config} for command's `input` shape. + * */ export class ListLicenseConfigurationsCommand extends $Command< ListLicenseConfigurationsCommandInput, diff --git a/clients/client-license-manager/commands/ListLicenseSpecificationsForResourceCommand.ts b/clients/client-license-manager/commands/ListLicenseSpecificationsForResourceCommand.ts index 949e68c03b02..2a9d177bd2af 100644 --- a/clients/client-license-manager/commands/ListLicenseSpecificationsForResourceCommand.ts +++ b/clients/client-license-manager/commands/ListLicenseSpecificationsForResourceCommand.ts @@ -27,6 +27,20 @@ export interface ListLicenseSpecificationsForResourceCommandOutput /** *

Describes the license configurations for the specified resource.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { LicenseManagerClient, ListLicenseSpecificationsForResourceCommand } from "@aws-sdk/client-license-manager"; // ES Modules import + * // const { LicenseManagerClient, ListLicenseSpecificationsForResourceCommand } = require("@aws-sdk/client-license-manager"); // CommonJS import + * const client = new LicenseManagerClient(config); + * const command = new ListLicenseSpecificationsForResourceCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListLicenseSpecificationsForResourceCommandInput} for command's `input` shape. + * @see {@link ListLicenseSpecificationsForResourceCommandOutput} for command's `response` shape. + * @see {@link LicenseManagerClientResolvedConfig | config} for command's `input` shape. + * */ export class ListLicenseSpecificationsForResourceCommand extends $Command< ListLicenseSpecificationsForResourceCommandInput, diff --git a/clients/client-license-manager/commands/ListLicenseVersionsCommand.ts b/clients/client-license-manager/commands/ListLicenseVersionsCommand.ts index 084e8bb01b2d..313125384063 100644 --- a/clients/client-license-manager/commands/ListLicenseVersionsCommand.ts +++ b/clients/client-license-manager/commands/ListLicenseVersionsCommand.ts @@ -22,6 +22,20 @@ export interface ListLicenseVersionsCommandOutput extends ListLicenseVersionsRes /** *

Lists all versions of the specified license.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { LicenseManagerClient, ListLicenseVersionsCommand } from "@aws-sdk/client-license-manager"; // ES Modules import + * // const { LicenseManagerClient, ListLicenseVersionsCommand } = require("@aws-sdk/client-license-manager"); // CommonJS import + * const client = new LicenseManagerClient(config); + * const command = new ListLicenseVersionsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListLicenseVersionsCommandInput} for command's `input` shape. + * @see {@link ListLicenseVersionsCommandOutput} for command's `response` shape. + * @see {@link LicenseManagerClientResolvedConfig | config} for command's `input` shape. + * */ export class ListLicenseVersionsCommand extends $Command< ListLicenseVersionsCommandInput, diff --git a/clients/client-license-manager/commands/ListLicensesCommand.ts b/clients/client-license-manager/commands/ListLicensesCommand.ts index ef6b4af6d56e..12e611176bc8 100644 --- a/clients/client-license-manager/commands/ListLicensesCommand.ts +++ b/clients/client-license-manager/commands/ListLicensesCommand.ts @@ -22,6 +22,20 @@ export interface ListLicensesCommandOutput extends ListLicensesResponse, __Metad /** *

Lists the licenses for your account.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { LicenseManagerClient, ListLicensesCommand } from "@aws-sdk/client-license-manager"; // ES Modules import + * // const { LicenseManagerClient, ListLicensesCommand } = require("@aws-sdk/client-license-manager"); // CommonJS import + * const client = new LicenseManagerClient(config); + * const command = new ListLicensesCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListLicensesCommandInput} for command's `input` shape. + * @see {@link ListLicensesCommandOutput} for command's `response` shape. + * @see {@link LicenseManagerClientResolvedConfig | config} for command's `input` shape. + * */ export class ListLicensesCommand extends $Command< ListLicensesCommandInput, diff --git a/clients/client-license-manager/commands/ListReceivedGrantsCommand.ts b/clients/client-license-manager/commands/ListReceivedGrantsCommand.ts index f8c53dfd7cec..856625c43978 100644 --- a/clients/client-license-manager/commands/ListReceivedGrantsCommand.ts +++ b/clients/client-license-manager/commands/ListReceivedGrantsCommand.ts @@ -22,6 +22,20 @@ export interface ListReceivedGrantsCommandOutput extends ListReceivedGrantsRespo /** *

Lists grants that are received but not accepted.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { LicenseManagerClient, ListReceivedGrantsCommand } from "@aws-sdk/client-license-manager"; // ES Modules import + * // const { LicenseManagerClient, ListReceivedGrantsCommand } = require("@aws-sdk/client-license-manager"); // CommonJS import + * const client = new LicenseManagerClient(config); + * const command = new ListReceivedGrantsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListReceivedGrantsCommandInput} for command's `input` shape. + * @see {@link ListReceivedGrantsCommandOutput} for command's `response` shape. + * @see {@link LicenseManagerClientResolvedConfig | config} for command's `input` shape. + * */ export class ListReceivedGrantsCommand extends $Command< ListReceivedGrantsCommandInput, diff --git a/clients/client-license-manager/commands/ListReceivedLicensesCommand.ts b/clients/client-license-manager/commands/ListReceivedLicensesCommand.ts index 68979df4ce53..2ffc34a3fe00 100644 --- a/clients/client-license-manager/commands/ListReceivedLicensesCommand.ts +++ b/clients/client-license-manager/commands/ListReceivedLicensesCommand.ts @@ -22,6 +22,20 @@ export interface ListReceivedLicensesCommandOutput extends ListReceivedLicensesR /** *

Lists received licenses.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { LicenseManagerClient, ListReceivedLicensesCommand } from "@aws-sdk/client-license-manager"; // ES Modules import + * // const { LicenseManagerClient, ListReceivedLicensesCommand } = require("@aws-sdk/client-license-manager"); // CommonJS import + * const client = new LicenseManagerClient(config); + * const command = new ListReceivedLicensesCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListReceivedLicensesCommandInput} for command's `input` shape. + * @see {@link ListReceivedLicensesCommandOutput} for command's `response` shape. + * @see {@link LicenseManagerClientResolvedConfig | config} for command's `input` shape. + * */ export class ListReceivedLicensesCommand extends $Command< ListReceivedLicensesCommandInput, diff --git a/clients/client-license-manager/commands/ListResourceInventoryCommand.ts b/clients/client-license-manager/commands/ListResourceInventoryCommand.ts index 42469f683e2c..c257feef7af2 100644 --- a/clients/client-license-manager/commands/ListResourceInventoryCommand.ts +++ b/clients/client-license-manager/commands/ListResourceInventoryCommand.ts @@ -22,6 +22,20 @@ export interface ListResourceInventoryCommandOutput extends ListResourceInventor /** *

Lists resources managed using Systems Manager inventory.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { LicenseManagerClient, ListResourceInventoryCommand } from "@aws-sdk/client-license-manager"; // ES Modules import + * // const { LicenseManagerClient, ListResourceInventoryCommand } = require("@aws-sdk/client-license-manager"); // CommonJS import + * const client = new LicenseManagerClient(config); + * const command = new ListResourceInventoryCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListResourceInventoryCommandInput} for command's `input` shape. + * @see {@link ListResourceInventoryCommandOutput} for command's `response` shape. + * @see {@link LicenseManagerClientResolvedConfig | config} for command's `input` shape. + * */ export class ListResourceInventoryCommand extends $Command< ListResourceInventoryCommandInput, diff --git a/clients/client-license-manager/commands/ListTagsForResourceCommand.ts b/clients/client-license-manager/commands/ListTagsForResourceCommand.ts index 17344c30bdc7..d37910dec8a4 100644 --- a/clients/client-license-manager/commands/ListTagsForResourceCommand.ts +++ b/clients/client-license-manager/commands/ListTagsForResourceCommand.ts @@ -22,6 +22,20 @@ export interface ListTagsForResourceCommandOutput extends ListTagsForResourceRes /** *

Lists the tags for the specified license configuration.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { LicenseManagerClient, ListTagsForResourceCommand } from "@aws-sdk/client-license-manager"; // ES Modules import + * // const { LicenseManagerClient, ListTagsForResourceCommand } = require("@aws-sdk/client-license-manager"); // CommonJS import + * const client = new LicenseManagerClient(config); + * const command = new ListTagsForResourceCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListTagsForResourceCommandInput} for command's `input` shape. + * @see {@link ListTagsForResourceCommandOutput} for command's `response` shape. + * @see {@link LicenseManagerClientResolvedConfig | config} for command's `input` shape. + * */ export class ListTagsForResourceCommand extends $Command< ListTagsForResourceCommandInput, diff --git a/clients/client-license-manager/commands/ListTokensCommand.ts b/clients/client-license-manager/commands/ListTokensCommand.ts index e2a157ceeca8..1b839d67398b 100644 --- a/clients/client-license-manager/commands/ListTokensCommand.ts +++ b/clients/client-license-manager/commands/ListTokensCommand.ts @@ -22,6 +22,20 @@ export interface ListTokensCommandOutput extends ListTokensResponse, __MetadataB /** *

Lists your tokens.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { LicenseManagerClient, ListTokensCommand } from "@aws-sdk/client-license-manager"; // ES Modules import + * // const { LicenseManagerClient, ListTokensCommand } = require("@aws-sdk/client-license-manager"); // CommonJS import + * const client = new LicenseManagerClient(config); + * const command = new ListTokensCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListTokensCommandInput} for command's `input` shape. + * @see {@link ListTokensCommandOutput} for command's `response` shape. + * @see {@link LicenseManagerClientResolvedConfig | config} for command's `input` shape. + * */ export class ListTokensCommand extends $Command< ListTokensCommandInput, diff --git a/clients/client-license-manager/commands/ListUsageForLicenseConfigurationCommand.ts b/clients/client-license-manager/commands/ListUsageForLicenseConfigurationCommand.ts index 7c7b0c4c8fb4..08b893922b01 100644 --- a/clients/client-license-manager/commands/ListUsageForLicenseConfigurationCommand.ts +++ b/clients/client-license-manager/commands/ListUsageForLicenseConfigurationCommand.ts @@ -26,6 +26,20 @@ export interface ListUsageForLicenseConfigurationCommandOutput *

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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { LicenseManagerClient, ListUsageForLicenseConfigurationCommand } from "@aws-sdk/client-license-manager"; // ES Modules import + * // const { LicenseManagerClient, ListUsageForLicenseConfigurationCommand } = require("@aws-sdk/client-license-manager"); // CommonJS import + * const client = new LicenseManagerClient(config); + * const command = new ListUsageForLicenseConfigurationCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListUsageForLicenseConfigurationCommandInput} for command's `input` shape. + * @see {@link ListUsageForLicenseConfigurationCommandOutput} for command's `response` shape. + * @see {@link LicenseManagerClientResolvedConfig | config} for command's `input` shape. + * */ export class ListUsageForLicenseConfigurationCommand extends $Command< ListUsageForLicenseConfigurationCommandInput, diff --git a/clients/client-license-manager/commands/RejectGrantCommand.ts b/clients/client-license-manager/commands/RejectGrantCommand.ts index 7b4279b741c2..47b3862c8fdb 100644 --- a/clients/client-license-manager/commands/RejectGrantCommand.ts +++ b/clients/client-license-manager/commands/RejectGrantCommand.ts @@ -22,6 +22,20 @@ export interface RejectGrantCommandOutput extends RejectGrantResponse, __Metadat /** *

Rejects the specified grant.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { LicenseManagerClient, RejectGrantCommand } from "@aws-sdk/client-license-manager"; // ES Modules import + * // const { LicenseManagerClient, RejectGrantCommand } = require("@aws-sdk/client-license-manager"); // CommonJS import + * const client = new LicenseManagerClient(config); + * const command = new RejectGrantCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link RejectGrantCommandInput} for command's `input` shape. + * @see {@link RejectGrantCommandOutput} for command's `response` shape. + * @see {@link LicenseManagerClientResolvedConfig | config} for command's `input` shape. + * */ export class RejectGrantCommand extends $Command< RejectGrantCommandInput, diff --git a/clients/client-license-manager/commands/TagResourceCommand.ts b/clients/client-license-manager/commands/TagResourceCommand.ts index d113ffd49ac0..5dda053e9a10 100644 --- a/clients/client-license-manager/commands/TagResourceCommand.ts +++ b/clients/client-license-manager/commands/TagResourceCommand.ts @@ -22,6 +22,20 @@ export interface TagResourceCommandOutput extends TagResourceResponse, __Metadat /** *

Adds the specified tags to the specified license configuration.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { LicenseManagerClient, TagResourceCommand } from "@aws-sdk/client-license-manager"; // ES Modules import + * // const { LicenseManagerClient, TagResourceCommand } = require("@aws-sdk/client-license-manager"); // CommonJS import + * const client = new LicenseManagerClient(config); + * const command = new TagResourceCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link TagResourceCommandInput} for command's `input` shape. + * @see {@link TagResourceCommandOutput} for command's `response` shape. + * @see {@link LicenseManagerClientResolvedConfig | config} for command's `input` shape. + * */ export class TagResourceCommand extends $Command< TagResourceCommandInput, diff --git a/clients/client-license-manager/commands/UntagResourceCommand.ts b/clients/client-license-manager/commands/UntagResourceCommand.ts index 4a8a6e21d6c8..fd1843aa9df4 100644 --- a/clients/client-license-manager/commands/UntagResourceCommand.ts +++ b/clients/client-license-manager/commands/UntagResourceCommand.ts @@ -22,6 +22,20 @@ export interface UntagResourceCommandOutput extends UntagResourceResponse, __Met /** *

Removes the specified tags from the specified license configuration.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { LicenseManagerClient, UntagResourceCommand } from "@aws-sdk/client-license-manager"; // ES Modules import + * // const { LicenseManagerClient, UntagResourceCommand } = require("@aws-sdk/client-license-manager"); // CommonJS import + * const client = new LicenseManagerClient(config); + * const command = new UntagResourceCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link UntagResourceCommandInput} for command's `input` shape. + * @see {@link UntagResourceCommandOutput} for command's `response` shape. + * @see {@link LicenseManagerClientResolvedConfig | config} for command's `input` shape. + * */ export class UntagResourceCommand extends $Command< UntagResourceCommandInput, diff --git a/clients/client-license-manager/commands/UpdateLicenseConfigurationCommand.ts b/clients/client-license-manager/commands/UpdateLicenseConfigurationCommand.ts index 5124a3e8e77e..0259f66e7d10 100644 --- a/clients/client-license-manager/commands/UpdateLicenseConfigurationCommand.ts +++ b/clients/client-license-manager/commands/UpdateLicenseConfigurationCommand.ts @@ -22,6 +22,20 @@ export interface UpdateLicenseConfigurationCommandOutput extends UpdateLicenseCo /** *

Modifies the attributes of an existing license configuration.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { LicenseManagerClient, UpdateLicenseConfigurationCommand } from "@aws-sdk/client-license-manager"; // ES Modules import + * // const { LicenseManagerClient, UpdateLicenseConfigurationCommand } = require("@aws-sdk/client-license-manager"); // CommonJS import + * const client = new LicenseManagerClient(config); + * const command = new UpdateLicenseConfigurationCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link UpdateLicenseConfigurationCommandInput} for command's `input` shape. + * @see {@link UpdateLicenseConfigurationCommandOutput} for command's `response` shape. + * @see {@link LicenseManagerClientResolvedConfig | config} for command's `input` shape. + * */ export class UpdateLicenseConfigurationCommand extends $Command< UpdateLicenseConfigurationCommandInput, diff --git a/clients/client-license-manager/commands/UpdateLicenseSpecificationsForResourceCommand.ts b/clients/client-license-manager/commands/UpdateLicenseSpecificationsForResourceCommand.ts index ff840d5ddd89..2d22356de2df 100644 --- a/clients/client-license-manager/commands/UpdateLicenseSpecificationsForResourceCommand.ts +++ b/clients/client-license-manager/commands/UpdateLicenseSpecificationsForResourceCommand.ts @@ -31,6 +31,20 @@ export interface UpdateLicenseSpecificationsForResourceCommandOutput *

You can update the license specifications of AMIs, instances, and hosts. * You cannot update the license specifications for launch templates and AWS CloudFormation templates, * as they send license configurations to the operation that creates the resource.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { LicenseManagerClient, UpdateLicenseSpecificationsForResourceCommand } from "@aws-sdk/client-license-manager"; // ES Modules import + * // const { LicenseManagerClient, UpdateLicenseSpecificationsForResourceCommand } = require("@aws-sdk/client-license-manager"); // CommonJS import + * const client = new LicenseManagerClient(config); + * const command = new UpdateLicenseSpecificationsForResourceCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link UpdateLicenseSpecificationsForResourceCommandInput} for command's `input` shape. + * @see {@link UpdateLicenseSpecificationsForResourceCommandOutput} for command's `response` shape. + * @see {@link LicenseManagerClientResolvedConfig | config} for command's `input` shape. + * */ export class UpdateLicenseSpecificationsForResourceCommand extends $Command< UpdateLicenseSpecificationsForResourceCommandInput, diff --git a/clients/client-license-manager/commands/UpdateServiceSettingsCommand.ts b/clients/client-license-manager/commands/UpdateServiceSettingsCommand.ts index 303ce335caeb..7c3957dc1be2 100644 --- a/clients/client-license-manager/commands/UpdateServiceSettingsCommand.ts +++ b/clients/client-license-manager/commands/UpdateServiceSettingsCommand.ts @@ -22,6 +22,20 @@ export interface UpdateServiceSettingsCommandOutput extends UpdateServiceSetting /** *

Updates License Manager settings for the current Region.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { LicenseManagerClient, UpdateServiceSettingsCommand } from "@aws-sdk/client-license-manager"; // ES Modules import + * // const { LicenseManagerClient, UpdateServiceSettingsCommand } = require("@aws-sdk/client-license-manager"); // CommonJS import + * const client = new LicenseManagerClient(config); + * const command = new UpdateServiceSettingsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link UpdateServiceSettingsCommandInput} for command's `input` shape. + * @see {@link UpdateServiceSettingsCommandOutput} for command's `response` shape. + * @see {@link LicenseManagerClientResolvedConfig | config} for command's `input` shape. + * */ export class UpdateServiceSettingsCommand extends $Command< UpdateServiceSettingsCommandInput, diff --git a/clients/client-license-manager/models/models_0.ts b/clients/client-license-manager/models/models_0.ts index 758b590a8fff..6c390ce57dd8 100644 --- a/clients/client-license-manager/models/models_0.ts +++ b/clients/client-license-manager/models/models_0.ts @@ -9,6 +9,9 @@ export interface AcceptGrantRequest { } export namespace AcceptGrantRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: AcceptGrantRequest): any => ({ ...obj, }); @@ -43,6 +46,9 @@ export interface AcceptGrantResponse { } export namespace AcceptGrantResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: AcceptGrantResponse): any => ({ ...obj, }); @@ -58,6 +64,9 @@ export interface AccessDeniedException extends __SmithyException, $MetadataBeare } export namespace AccessDeniedException { + /** + * @internal + */ export const filterSensitiveLog = (obj: AccessDeniedException): any => ({ ...obj, }); @@ -74,6 +83,9 @@ export interface AuthorizationException extends __SmithyException, $MetadataBear } export namespace AuthorizationException { + /** + * @internal + */ export const filterSensitiveLog = (obj: AuthorizationException): any => ({ ...obj, }); @@ -89,6 +101,9 @@ export interface InvalidParameterValueException extends __SmithyException, $Meta } export namespace InvalidParameterValueException { + /** + * @internal + */ export const filterSensitiveLog = (obj: InvalidParameterValueException): any => ({ ...obj, }); @@ -104,6 +119,9 @@ export interface RateLimitExceededException extends __SmithyException, $Metadata } export namespace RateLimitExceededException { + /** + * @internal + */ export const filterSensitiveLog = (obj: RateLimitExceededException): any => ({ ...obj, }); @@ -119,6 +137,9 @@ export interface ResourceLimitExceededException extends __SmithyException, $Meta } export namespace ResourceLimitExceededException { + /** + * @internal + */ export const filterSensitiveLog = (obj: ResourceLimitExceededException): any => ({ ...obj, }); @@ -134,6 +155,9 @@ export interface ServerInternalException extends __SmithyException, $MetadataBea } export namespace ServerInternalException { + /** + * @internal + */ export const filterSensitiveLog = (obj: ServerInternalException): any => ({ ...obj, }); @@ -149,6 +173,9 @@ export interface ValidationException extends __SmithyException, $MetadataBearer } export namespace ValidationException { + /** + * @internal + */ export const filterSensitiveLog = (obj: ValidationException): any => ({ ...obj, }); @@ -175,6 +202,9 @@ export interface AutomatedDiscoveryInformation { } export namespace AutomatedDiscoveryInformation { + /** + * @internal + */ export const filterSensitiveLog = (obj: AutomatedDiscoveryInformation): any => ({ ...obj, }); @@ -193,6 +223,9 @@ export interface CheckInLicenseRequest { } export namespace CheckInLicenseRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: CheckInLicenseRequest): any => ({ ...obj, }); @@ -201,6 +234,9 @@ export namespace CheckInLicenseRequest { export interface CheckInLicenseResponse {} export namespace CheckInLicenseResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: CheckInLicenseResponse): any => ({ ...obj, }); @@ -216,6 +252,9 @@ export interface ConflictException extends __SmithyException, $MetadataBearer { } export namespace ConflictException { + /** + * @internal + */ export const filterSensitiveLog = (obj: ConflictException): any => ({ ...obj, }); @@ -231,6 +270,9 @@ export interface ResourceNotFoundException extends __SmithyException, $MetadataB } export namespace ResourceNotFoundException { + /** + * @internal + */ export const filterSensitiveLog = (obj: ResourceNotFoundException): any => ({ ...obj, }); @@ -252,6 +294,9 @@ export interface Metadata { } export namespace Metadata { + /** + * @internal + */ export const filterSensitiveLog = (obj: Metadata): any => ({ ...obj, }); @@ -312,6 +357,9 @@ export interface EntitlementData { } export namespace EntitlementData { + /** + * @internal + */ export const filterSensitiveLog = (obj: EntitlementData): any => ({ ...obj, }); @@ -351,6 +399,9 @@ export interface CheckoutBorrowLicenseRequest { } export namespace CheckoutBorrowLicenseRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: CheckoutBorrowLicenseRequest): any => ({ ...obj, }); @@ -399,6 +450,9 @@ export interface CheckoutBorrowLicenseResponse { } export namespace CheckoutBorrowLicenseResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: CheckoutBorrowLicenseResponse): any => ({ ...obj, }); @@ -414,6 +468,9 @@ export interface EntitlementNotAllowedException extends __SmithyException, $Meta } export namespace EntitlementNotAllowedException { + /** + * @internal + */ export const filterSensitiveLog = (obj: EntitlementNotAllowedException): any => ({ ...obj, }); @@ -429,6 +486,9 @@ export interface NoEntitlementsAllowedException extends __SmithyException, $Meta } export namespace NoEntitlementsAllowedException { + /** + * @internal + */ export const filterSensitiveLog = (obj: NoEntitlementsAllowedException): any => ({ ...obj, }); @@ -445,6 +505,9 @@ export interface RedirectException extends __SmithyException, $MetadataBearer { } export namespace RedirectException { + /** + * @internal + */ export const filterSensitiveLog = (obj: RedirectException): any => ({ ...obj, }); @@ -460,6 +523,9 @@ export interface UnsupportedDigitalSignatureMethodException extends __SmithyExce } export namespace UnsupportedDigitalSignatureMethodException { + /** + * @internal + */ export const filterSensitiveLog = (obj: UnsupportedDigitalSignatureMethodException): any => ({ ...obj, }); @@ -507,6 +573,9 @@ export interface CheckoutLicenseRequest { } export namespace CheckoutLicenseRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: CheckoutLicenseRequest): any => ({ ...obj, }); @@ -550,6 +619,9 @@ export interface CheckoutLicenseResponse { } export namespace CheckoutLicenseResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: CheckoutLicenseResponse): any => ({ ...obj, }); @@ -588,6 +660,9 @@ export interface CreateGrantRequest { } export namespace CreateGrantRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateGrantRequest): any => ({ ...obj, }); @@ -611,6 +686,9 @@ export interface CreateGrantResponse { } export namespace CreateGrantResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateGrantResponse): any => ({ ...obj, }); @@ -649,6 +727,9 @@ export interface CreateGrantVersionRequest { } export namespace CreateGrantVersionRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateGrantVersionRequest): any => ({ ...obj, }); @@ -672,6 +753,9 @@ export interface CreateGrantVersionResponse { } export namespace CreateGrantVersionResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateGrantVersionResponse): any => ({ ...obj, }); @@ -693,6 +777,9 @@ export interface BorrowConfiguration { } export namespace BorrowConfiguration { + /** + * @internal + */ export const filterSensitiveLog = (obj: BorrowConfiguration): any => ({ ...obj, }); @@ -709,6 +796,9 @@ export interface ProvisionalConfiguration { } export namespace ProvisionalConfiguration { + /** + * @internal + */ export const filterSensitiveLog = (obj: ProvisionalConfiguration): any => ({ ...obj, }); @@ -741,6 +831,9 @@ export interface ConsumptionConfiguration { } export namespace ConsumptionConfiguration { + /** + * @internal + */ export const filterSensitiveLog = (obj: ConsumptionConfiguration): any => ({ ...obj, }); @@ -812,6 +905,9 @@ export interface Entitlement { } export namespace Entitlement { + /** + * @internal + */ export const filterSensitiveLog = (obj: Entitlement): any => ({ ...obj, }); @@ -834,6 +930,9 @@ export interface Issuer { } export namespace Issuer { + /** + * @internal + */ export const filterSensitiveLog = (obj: Issuer): any => ({ ...obj, }); @@ -855,6 +954,9 @@ export interface DatetimeRange { } export namespace DatetimeRange { + /** + * @internal + */ export const filterSensitiveLog = (obj: DatetimeRange): any => ({ ...obj, }); @@ -920,6 +1022,9 @@ export interface CreateLicenseRequest { } export namespace CreateLicenseRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateLicenseRequest): any => ({ ...obj, }); @@ -953,6 +1058,9 @@ export interface CreateLicenseResponse { } export namespace CreateLicenseResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateLicenseResponse): any => ({ ...obj, }); @@ -986,6 +1094,9 @@ export interface ProductInformationFilter { } export namespace ProductInformationFilter { + /** + * @internal + */ export const filterSensitiveLog = (obj: ProductInformationFilter): any => ({ ...obj, }); @@ -1065,6 +1176,9 @@ export interface ProductInformation { } export namespace ProductInformation { + /** + * @internal + */ export const filterSensitiveLog = (obj: ProductInformation): any => ({ ...obj, }); @@ -1086,6 +1200,9 @@ export interface Tag { } export namespace Tag { + /** + * @internal + */ export const filterSensitiveLog = (obj: Tag): any => ({ ...obj, }); @@ -1176,6 +1293,9 @@ export interface CreateLicenseConfigurationRequest { } export namespace CreateLicenseConfigurationRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateLicenseConfigurationRequest): any => ({ ...obj, }); @@ -1189,6 +1309,9 @@ export interface CreateLicenseConfigurationResponse { } export namespace CreateLicenseConfigurationResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateLicenseConfigurationResponse): any => ({ ...obj, }); @@ -1259,6 +1382,9 @@ export interface CreateLicenseVersionRequest { } export namespace CreateLicenseVersionRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateLicenseVersionRequest): any => ({ ...obj, }); @@ -1282,6 +1408,9 @@ export interface CreateLicenseVersionResponse { } export namespace CreateLicenseVersionResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateLicenseVersionResponse): any => ({ ...obj, }); @@ -1318,6 +1447,9 @@ export interface CreateTokenRequest { } export namespace CreateTokenRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateTokenRequest): any => ({ ...obj, }); @@ -1345,6 +1477,9 @@ export interface CreateTokenResponse { } export namespace CreateTokenResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateTokenResponse): any => ({ ...obj, }); @@ -1363,6 +1498,9 @@ export interface DeleteGrantRequest { } export namespace DeleteGrantRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteGrantRequest): any => ({ ...obj, }); @@ -1386,6 +1524,9 @@ export interface DeleteGrantResponse { } export namespace DeleteGrantResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteGrantResponse): any => ({ ...obj, }); @@ -1404,6 +1545,9 @@ export interface DeleteLicenseRequest { } export namespace DeleteLicenseRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteLicenseRequest): any => ({ ...obj, }); @@ -1427,6 +1571,9 @@ export interface DeleteLicenseResponse { } export namespace DeleteLicenseResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteLicenseResponse): any => ({ ...obj, }); @@ -1440,6 +1587,9 @@ export interface DeleteLicenseConfigurationRequest { } export namespace DeleteLicenseConfigurationRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteLicenseConfigurationRequest): any => ({ ...obj, }); @@ -1448,6 +1598,9 @@ export namespace DeleteLicenseConfigurationRequest { export interface DeleteLicenseConfigurationResponse {} export namespace DeleteLicenseConfigurationResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteLicenseConfigurationResponse): any => ({ ...obj, }); @@ -1461,6 +1614,9 @@ export interface DeleteTokenRequest { } export namespace DeleteTokenRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteTokenRequest): any => ({ ...obj, }); @@ -1469,6 +1625,9 @@ export namespace DeleteTokenRequest { export interface DeleteTokenResponse {} export namespace DeleteTokenResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteTokenResponse): any => ({ ...obj, }); @@ -1487,6 +1646,9 @@ export interface ExtendLicenseConsumptionRequest { } export namespace ExtendLicenseConsumptionRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ExtendLicenseConsumptionRequest): any => ({ ...obj, }); @@ -1505,6 +1667,9 @@ export interface ExtendLicenseConsumptionResponse { } export namespace ExtendLicenseConsumptionResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ExtendLicenseConsumptionResponse): any => ({ ...obj, }); @@ -1523,6 +1688,9 @@ export interface GetAccessTokenRequest { } export namespace GetAccessTokenRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetAccessTokenRequest): any => ({ ...obj, }); @@ -1536,6 +1704,9 @@ export interface GetAccessTokenResponse { } export namespace GetAccessTokenResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetAccessTokenResponse): any => ({ ...obj, }); @@ -1554,6 +1725,9 @@ export interface GetGrantRequest { } export namespace GetGrantRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetGrantRequest): any => ({ ...obj, }); @@ -1615,6 +1789,9 @@ export interface Grant { } export namespace Grant { + /** + * @internal + */ export const filterSensitiveLog = (obj: Grant): any => ({ ...obj, }); @@ -1628,6 +1805,9 @@ export interface GetGrantResponse { } export namespace GetGrantResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetGrantResponse): any => ({ ...obj, }); @@ -1646,6 +1826,9 @@ export interface GetLicenseRequest { } export namespace GetLicenseRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetLicenseRequest): any => ({ ...obj, }); @@ -1673,6 +1856,9 @@ export interface IssuerDetails { } export namespace IssuerDetails { + /** + * @internal + */ export const filterSensitiveLog = (obj: IssuerDetails): any => ({ ...obj, }); @@ -1754,6 +1940,9 @@ export interface License { } export namespace License { + /** + * @internal + */ export const filterSensitiveLog = (obj: License): any => ({ ...obj, }); @@ -1767,6 +1956,9 @@ export interface GetLicenseResponse { } export namespace GetLicenseResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetLicenseResponse): any => ({ ...obj, }); @@ -1780,6 +1972,9 @@ export interface GetLicenseConfigurationRequest { } export namespace GetLicenseConfigurationRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetLicenseConfigurationRequest): any => ({ ...obj, }); @@ -1809,6 +2004,9 @@ export interface ConsumedLicenseSummary { } export namespace ConsumedLicenseSummary { + /** + * @internal + */ export const filterSensitiveLog = (obj: ConsumedLicenseSummary): any => ({ ...obj, }); @@ -1830,6 +2028,9 @@ export interface ManagedResourceSummary { } export namespace ManagedResourceSummary { + /** + * @internal + */ export const filterSensitiveLog = (obj: ManagedResourceSummary): any => ({ ...obj, }); @@ -1923,6 +2124,9 @@ export interface GetLicenseConfigurationResponse { } export namespace GetLicenseConfigurationResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetLicenseConfigurationResponse): any => ({ ...obj, }); @@ -1936,6 +2140,9 @@ export interface GetLicenseUsageRequest { } export namespace GetLicenseUsageRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetLicenseUsageRequest): any => ({ ...obj, }); @@ -1967,6 +2174,9 @@ export interface EntitlementUsage { } export namespace EntitlementUsage { + /** + * @internal + */ export const filterSensitiveLog = (obj: EntitlementUsage): any => ({ ...obj, }); @@ -1983,6 +2193,9 @@ export interface LicenseUsage { } export namespace LicenseUsage { + /** + * @internal + */ export const filterSensitiveLog = (obj: LicenseUsage): any => ({ ...obj, }); @@ -1996,6 +2209,9 @@ export interface GetLicenseUsageResponse { } export namespace GetLicenseUsageResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetLicenseUsageResponse): any => ({ ...obj, }); @@ -2004,6 +2220,9 @@ export namespace GetLicenseUsageResponse { export interface GetServiceSettingsRequest {} export namespace GetServiceSettingsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetServiceSettingsRequest): any => ({ ...obj, }); @@ -2020,6 +2239,9 @@ export interface OrganizationConfiguration { } export namespace OrganizationConfiguration { + /** + * @internal + */ export const filterSensitiveLog = (obj: OrganizationConfiguration): any => ({ ...obj, }); @@ -2056,6 +2278,9 @@ export interface GetServiceSettingsResponse { } export namespace GetServiceSettingsResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetServiceSettingsResponse): any => ({ ...obj, }); @@ -2071,6 +2296,9 @@ export interface FilterLimitExceededException extends __SmithyException, $Metada } export namespace FilterLimitExceededException { + /** + * @internal + */ export const filterSensitiveLog = (obj: FilterLimitExceededException): any => ({ ...obj, }); @@ -2094,6 +2322,9 @@ export interface ListAssociationsForLicenseConfigurationRequest { } export namespace ListAssociationsForLicenseConfigurationRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListAssociationsForLicenseConfigurationRequest): any => ({ ...obj, }); @@ -2130,6 +2361,9 @@ export interface LicenseConfigurationAssociation { } export namespace LicenseConfigurationAssociation { + /** + * @internal + */ export const filterSensitiveLog = (obj: LicenseConfigurationAssociation): any => ({ ...obj, }); @@ -2148,6 +2382,9 @@ export interface ListAssociationsForLicenseConfigurationResponse { } export namespace ListAssociationsForLicenseConfigurationResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListAssociationsForLicenseConfigurationResponse): any => ({ ...obj, }); @@ -2171,6 +2408,9 @@ export interface Filter { } export namespace Filter { + /** + * @internal + */ export const filterSensitiveLog = (obj: Filter): any => ({ ...obj, }); @@ -2221,6 +2461,9 @@ export interface ListDistributedGrantsRequest { } export namespace ListDistributedGrantsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListDistributedGrantsRequest): any => ({ ...obj, }); @@ -2239,6 +2482,9 @@ export interface ListDistributedGrantsResponse { } export namespace ListDistributedGrantsResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListDistributedGrantsResponse): any => ({ ...obj, }); @@ -2262,6 +2508,9 @@ export interface ListFailuresForLicenseConfigurationOperationsRequest { } export namespace ListFailuresForLicenseConfigurationOperationsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListFailuresForLicenseConfigurationOperationsRequest): any => ({ ...obj, }); @@ -2313,6 +2562,9 @@ export interface LicenseOperationFailure { } export namespace LicenseOperationFailure { + /** + * @internal + */ export const filterSensitiveLog = (obj: LicenseOperationFailure): any => ({ ...obj, }); @@ -2331,6 +2583,9 @@ export interface ListFailuresForLicenseConfigurationOperationsResponse { } export namespace ListFailuresForLicenseConfigurationOperationsResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListFailuresForLicenseConfigurationOperationsResponse): any => ({ ...obj, }); @@ -2378,6 +2633,9 @@ export interface ListLicenseConfigurationsRequest { } export namespace ListLicenseConfigurationsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListLicenseConfigurationsRequest): any => ({ ...obj, }); @@ -2473,6 +2731,9 @@ export interface LicenseConfiguration { } export namespace LicenseConfiguration { + /** + * @internal + */ export const filterSensitiveLog = (obj: LicenseConfiguration): any => ({ ...obj, }); @@ -2491,6 +2752,9 @@ export interface ListLicenseConfigurationsResponse { } export namespace ListLicenseConfigurationsResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListLicenseConfigurationsResponse): any => ({ ...obj, }); @@ -2541,6 +2805,9 @@ export interface ListLicensesRequest { } export namespace ListLicensesRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListLicensesRequest): any => ({ ...obj, }); @@ -2559,6 +2826,9 @@ export interface ListLicensesResponse { } export namespace ListLicensesResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListLicensesResponse): any => ({ ...obj, }); @@ -2582,6 +2852,9 @@ export interface ListLicenseSpecificationsForResourceRequest { } export namespace ListLicenseSpecificationsForResourceRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListLicenseSpecificationsForResourceRequest): any => ({ ...obj, }); @@ -2603,6 +2876,9 @@ export interface LicenseSpecification { } export namespace LicenseSpecification { + /** + * @internal + */ export const filterSensitiveLog = (obj: LicenseSpecification): any => ({ ...obj, }); @@ -2621,6 +2897,9 @@ export interface ListLicenseSpecificationsForResourceResponse { } export namespace ListLicenseSpecificationsForResourceResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListLicenseSpecificationsForResourceResponse): any => ({ ...obj, }); @@ -2644,6 +2923,9 @@ export interface ListLicenseVersionsRequest { } export namespace ListLicenseVersionsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListLicenseVersionsRequest): any => ({ ...obj, }); @@ -2662,6 +2944,9 @@ export interface ListLicenseVersionsResponse { } export namespace ListLicenseVersionsResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListLicenseVersionsResponse): any => ({ ...obj, }); @@ -2702,6 +2987,9 @@ export interface ListReceivedGrantsRequest { } export namespace ListReceivedGrantsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListReceivedGrantsRequest): any => ({ ...obj, }); @@ -2720,6 +3008,9 @@ export interface ListReceivedGrantsResponse { } export namespace ListReceivedGrantsResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListReceivedGrantsResponse): any => ({ ...obj, }); @@ -2770,6 +3061,9 @@ export interface ListReceivedLicensesRequest { } export namespace ListReceivedLicensesRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListReceivedLicensesRequest): any => ({ ...obj, }); @@ -2801,6 +3095,9 @@ export interface ReceivedMetadata { } export namespace ReceivedMetadata { + /** + * @internal + */ export const filterSensitiveLog = (obj: ReceivedMetadata): any => ({ ...obj, }); @@ -2887,6 +3184,9 @@ export interface GrantedLicense { } export namespace GrantedLicense { + /** + * @internal + */ export const filterSensitiveLog = (obj: GrantedLicense): any => ({ ...obj, }); @@ -2905,6 +3205,9 @@ export interface ListReceivedLicensesResponse { } export namespace ListReceivedLicensesResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListReceivedLicensesResponse): any => ({ ...obj, }); @@ -2921,6 +3224,9 @@ export interface FailedDependencyException extends __SmithyException, $MetadataB } export namespace FailedDependencyException { + /** + * @internal + */ export const filterSensitiveLog = (obj: FailedDependencyException): any => ({ ...obj, }); @@ -2954,6 +3260,9 @@ export interface InventoryFilter { } export namespace InventoryFilter { + /** + * @internal + */ export const filterSensitiveLog = (obj: InventoryFilter): any => ({ ...obj, }); @@ -3015,6 +3324,9 @@ export interface ListResourceInventoryRequest { } export namespace ListResourceInventoryRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListResourceInventoryRequest): any => ({ ...obj, }); @@ -3056,6 +3368,9 @@ export interface ResourceInventory { } export namespace ResourceInventory { + /** + * @internal + */ export const filterSensitiveLog = (obj: ResourceInventory): any => ({ ...obj, }); @@ -3074,6 +3389,9 @@ export interface ListResourceInventoryResponse { } export namespace ListResourceInventoryResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListResourceInventoryResponse): any => ({ ...obj, }); @@ -3087,6 +3405,9 @@ export interface ListTagsForResourceRequest { } export namespace ListTagsForResourceRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListTagsForResourceRequest): any => ({ ...obj, }); @@ -3100,6 +3421,9 @@ export interface ListTagsForResourceResponse { } export namespace ListTagsForResourceResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListTagsForResourceResponse): any => ({ ...obj, }); @@ -3135,6 +3459,9 @@ export interface ListTokensRequest { } export namespace ListTokensRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListTokensRequest): any => ({ ...obj, }); @@ -3181,6 +3508,9 @@ export interface TokenData { } export namespace TokenData { + /** + * @internal + */ export const filterSensitiveLog = (obj: TokenData): any => ({ ...obj, }); @@ -3199,6 +3529,9 @@ export interface ListTokensResponse { } export namespace ListTokensResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListTokensResponse): any => ({ ...obj, }); @@ -3245,6 +3578,9 @@ export interface ListUsageForLicenseConfigurationRequest { } export namespace ListUsageForLicenseConfigurationRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListUsageForLicenseConfigurationRequest): any => ({ ...obj, }); @@ -3286,6 +3622,9 @@ export interface LicenseConfigurationUsage { } export namespace LicenseConfigurationUsage { + /** + * @internal + */ export const filterSensitiveLog = (obj: LicenseConfigurationUsage): any => ({ ...obj, }); @@ -3304,6 +3643,9 @@ export interface ListUsageForLicenseConfigurationResponse { } export namespace ListUsageForLicenseConfigurationResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListUsageForLicenseConfigurationResponse): any => ({ ...obj, }); @@ -3317,6 +3659,9 @@ export interface RejectGrantRequest { } export namespace RejectGrantRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: RejectGrantRequest): any => ({ ...obj, }); @@ -3340,6 +3685,9 @@ export interface RejectGrantResponse { } export namespace RejectGrantResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: RejectGrantResponse): any => ({ ...obj, }); @@ -3358,6 +3706,9 @@ export interface TagResourceRequest { } export namespace TagResourceRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: TagResourceRequest): any => ({ ...obj, }); @@ -3366,6 +3717,9 @@ export namespace TagResourceRequest { export interface TagResourceResponse {} export namespace TagResourceResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: TagResourceResponse): any => ({ ...obj, }); @@ -3384,6 +3738,9 @@ export interface UntagResourceRequest { } export namespace UntagResourceRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: UntagResourceRequest): any => ({ ...obj, }); @@ -3392,6 +3749,9 @@ export namespace UntagResourceRequest { export interface UntagResourceResponse {} export namespace UntagResourceResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: UntagResourceResponse): any => ({ ...obj, }); @@ -3451,6 +3811,9 @@ export interface UpdateLicenseConfigurationRequest { } export namespace UpdateLicenseConfigurationRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateLicenseConfigurationRequest): any => ({ ...obj, }); @@ -3459,6 +3822,9 @@ export namespace UpdateLicenseConfigurationRequest { export interface UpdateLicenseConfigurationResponse {} export namespace UpdateLicenseConfigurationResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateLicenseConfigurationResponse): any => ({ ...obj, }); @@ -3476,6 +3842,9 @@ export interface InvalidResourceStateException extends __SmithyException, $Metad } export namespace InvalidResourceStateException { + /** + * @internal + */ export const filterSensitiveLog = (obj: InvalidResourceStateException): any => ({ ...obj, }); @@ -3491,6 +3860,9 @@ export interface LicenseUsageException extends __SmithyException, $MetadataBeare } export namespace LicenseUsageException { + /** + * @internal + */ export const filterSensitiveLog = (obj: LicenseUsageException): any => ({ ...obj, }); @@ -3514,6 +3886,9 @@ export interface UpdateLicenseSpecificationsForResourceRequest { } export namespace UpdateLicenseSpecificationsForResourceRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateLicenseSpecificationsForResourceRequest): any => ({ ...obj, }); @@ -3522,6 +3897,9 @@ export namespace UpdateLicenseSpecificationsForResourceRequest { export interface UpdateLicenseSpecificationsForResourceResponse {} export namespace UpdateLicenseSpecificationsForResourceResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateLicenseSpecificationsForResourceResponse): any => ({ ...obj, }); @@ -3550,6 +3928,9 @@ export interface UpdateServiceSettingsRequest { } export namespace UpdateServiceSettingsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateServiceSettingsRequest): any => ({ ...obj, }); @@ -3558,6 +3939,9 @@ export namespace UpdateServiceSettingsRequest { export interface UpdateServiceSettingsResponse {} export namespace UpdateServiceSettingsResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateServiceSettingsResponse): any => ({ ...obj, }); diff --git a/clients/client-lightsail/commands/AllocateStaticIpCommand.ts b/clients/client-lightsail/commands/AllocateStaticIpCommand.ts index dda161fba02d..9004ae2b61f7 100644 --- a/clients/client-lightsail/commands/AllocateStaticIpCommand.ts +++ b/clients/client-lightsail/commands/AllocateStaticIpCommand.ts @@ -22,6 +22,20 @@ export interface AllocateStaticIpCommandOutput extends AllocateStaticIpResult, _ /** *

Allocates a static IP address.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { LightsailClient, AllocateStaticIpCommand } from "@aws-sdk/client-lightsail"; // ES Modules import + * // const { LightsailClient, AllocateStaticIpCommand } = require("@aws-sdk/client-lightsail"); // CommonJS import + * const client = new LightsailClient(config); + * const command = new AllocateStaticIpCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link AllocateStaticIpCommandInput} for command's `input` shape. + * @see {@link AllocateStaticIpCommandOutput} for command's `response` shape. + * @see {@link LightsailClientResolvedConfig | config} for command's `input` shape. + * */ export class AllocateStaticIpCommand extends $Command< AllocateStaticIpCommandInput, diff --git a/clients/client-lightsail/commands/AttachCertificateToDistributionCommand.ts b/clients/client-lightsail/commands/AttachCertificateToDistributionCommand.ts index b955d95d6353..aebc31cb7455 100644 --- a/clients/client-lightsail/commands/AttachCertificateToDistributionCommand.ts +++ b/clients/client-lightsail/commands/AttachCertificateToDistributionCommand.ts @@ -35,6 +35,20 @@ export interface AttachCertificateToDistributionCommandOutput * an origin in any AWS Region, and distribute its content globally. However, all * distributions are located in the us-east-1 Region.

* + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { LightsailClient, AttachCertificateToDistributionCommand } from "@aws-sdk/client-lightsail"; // ES Modules import + * // const { LightsailClient, AttachCertificateToDistributionCommand } = require("@aws-sdk/client-lightsail"); // CommonJS import + * const client = new LightsailClient(config); + * const command = new AttachCertificateToDistributionCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link AttachCertificateToDistributionCommandInput} for command's `input` shape. + * @see {@link AttachCertificateToDistributionCommandOutput} for command's `response` shape. + * @see {@link LightsailClientResolvedConfig | config} for command's `input` shape. + * */ export class AttachCertificateToDistributionCommand extends $Command< AttachCertificateToDistributionCommandInput, diff --git a/clients/client-lightsail/commands/AttachDiskCommand.ts b/clients/client-lightsail/commands/AttachDiskCommand.ts index 163f340d0da3..beafbea31927 100644 --- a/clients/client-lightsail/commands/AttachDiskCommand.ts +++ b/clients/client-lightsail/commands/AttachDiskCommand.ts @@ -26,6 +26,20 @@ export interface AttachDiskCommandOutput extends AttachDiskResult, __MetadataBea *

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 * Lightsail Dev Guide.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { LightsailClient, AttachDiskCommand } from "@aws-sdk/client-lightsail"; // ES Modules import + * // const { LightsailClient, AttachDiskCommand } = require("@aws-sdk/client-lightsail"); // CommonJS import + * const client = new LightsailClient(config); + * const command = new AttachDiskCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link AttachDiskCommandInput} for command's `input` shape. + * @see {@link AttachDiskCommandOutput} for command's `response` shape. + * @see {@link LightsailClientResolvedConfig | config} for command's `input` shape. + * */ export class AttachDiskCommand extends $Command< AttachDiskCommandInput, diff --git a/clients/client-lightsail/commands/AttachInstancesToLoadBalancerCommand.ts b/clients/client-lightsail/commands/AttachInstancesToLoadBalancerCommand.ts index 35e4de69ca6a..1dc448953549 100644 --- a/clients/client-lightsail/commands/AttachInstancesToLoadBalancerCommand.ts +++ b/clients/client-lightsail/commands/AttachInstancesToLoadBalancerCommand.ts @@ -29,6 +29,20 @@ export interface AttachInstancesToLoadBalancerCommandOutput *

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 Dev Guide.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { LightsailClient, AttachInstancesToLoadBalancerCommand } from "@aws-sdk/client-lightsail"; // ES Modules import + * // const { LightsailClient, AttachInstancesToLoadBalancerCommand } = require("@aws-sdk/client-lightsail"); // CommonJS import + * const client = new LightsailClient(config); + * const command = new AttachInstancesToLoadBalancerCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link AttachInstancesToLoadBalancerCommandInput} for command's `input` shape. + * @see {@link AttachInstancesToLoadBalancerCommandOutput} for command's `response` shape. + * @see {@link LightsailClientResolvedConfig | config} for command's `input` shape. + * */ export class AttachInstancesToLoadBalancerCommand extends $Command< AttachInstancesToLoadBalancerCommandInput, diff --git a/clients/client-lightsail/commands/AttachLoadBalancerTlsCertificateCommand.ts b/clients/client-lightsail/commands/AttachLoadBalancerTlsCertificateCommand.ts index cc5548a75b89..a59755618d07 100644 --- a/clients/client-lightsail/commands/AttachLoadBalancerTlsCertificateCommand.ts +++ b/clients/client-lightsail/commands/AttachLoadBalancerTlsCertificateCommand.ts @@ -32,6 +32,20 @@ export interface AttachLoadBalancerTlsCertificateCommandOutput *

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 Lightsail Dev Guide.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { LightsailClient, AttachLoadBalancerTlsCertificateCommand } from "@aws-sdk/client-lightsail"; // ES Modules import + * // const { LightsailClient, AttachLoadBalancerTlsCertificateCommand } = require("@aws-sdk/client-lightsail"); // CommonJS import + * const client = new LightsailClient(config); + * const command = new AttachLoadBalancerTlsCertificateCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link AttachLoadBalancerTlsCertificateCommandInput} for command's `input` shape. + * @see {@link AttachLoadBalancerTlsCertificateCommandOutput} for command's `response` shape. + * @see {@link LightsailClientResolvedConfig | config} for command's `input` shape. + * */ export class AttachLoadBalancerTlsCertificateCommand extends $Command< AttachLoadBalancerTlsCertificateCommandInput, diff --git a/clients/client-lightsail/commands/AttachStaticIpCommand.ts b/clients/client-lightsail/commands/AttachStaticIpCommand.ts index 5069e82d8e02..b616161e607f 100644 --- a/clients/client-lightsail/commands/AttachStaticIpCommand.ts +++ b/clients/client-lightsail/commands/AttachStaticIpCommand.ts @@ -22,6 +22,20 @@ export interface AttachStaticIpCommandOutput extends AttachStaticIpResult, __Met /** *

Attaches a static IP address to a specific Amazon Lightsail instance.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { LightsailClient, AttachStaticIpCommand } from "@aws-sdk/client-lightsail"; // ES Modules import + * // const { LightsailClient, AttachStaticIpCommand } = require("@aws-sdk/client-lightsail"); // CommonJS import + * const client = new LightsailClient(config); + * const command = new AttachStaticIpCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link AttachStaticIpCommandInput} for command's `input` shape. + * @see {@link AttachStaticIpCommandOutput} for command's `response` shape. + * @see {@link LightsailClientResolvedConfig | config} for command's `input` shape. + * */ export class AttachStaticIpCommand extends $Command< AttachStaticIpCommandInput, diff --git a/clients/client-lightsail/commands/CloseInstancePublicPortsCommand.ts b/clients/client-lightsail/commands/CloseInstancePublicPortsCommand.ts index e1904f84a1f8..5a7a7a5e2e7f 100644 --- a/clients/client-lightsail/commands/CloseInstancePublicPortsCommand.ts +++ b/clients/client-lightsail/commands/CloseInstancePublicPortsCommand.ts @@ -25,6 +25,20 @@ export interface CloseInstancePublicPortsCommandOutput extends CloseInstancePubl *

The CloseInstancePublicPorts action supports tag-based access control via * resource tags applied to the resource identified by instanceName. For more * information, see the Lightsail Dev Guide.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { LightsailClient, CloseInstancePublicPortsCommand } from "@aws-sdk/client-lightsail"; // ES Modules import + * // const { LightsailClient, CloseInstancePublicPortsCommand } = require("@aws-sdk/client-lightsail"); // CommonJS import + * const client = new LightsailClient(config); + * const command = new CloseInstancePublicPortsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CloseInstancePublicPortsCommandInput} for command's `input` shape. + * @see {@link CloseInstancePublicPortsCommandOutput} for command's `response` shape. + * @see {@link LightsailClientResolvedConfig | config} for command's `input` shape. + * */ export class CloseInstancePublicPortsCommand extends $Command< CloseInstancePublicPortsCommandInput, diff --git a/clients/client-lightsail/commands/CopySnapshotCommand.ts b/clients/client-lightsail/commands/CopySnapshotCommand.ts index e7c50251d234..d314e46288ac 100644 --- a/clients/client-lightsail/commands/CopySnapshotCommand.ts +++ b/clients/client-lightsail/commands/CopySnapshotCommand.ts @@ -32,6 +32,20 @@ export interface CopySnapshotCommandOutput extends CopySnapshotResult, __Metadat * source region, source resource name, target snapshot * name, and either the restore date or the use latest restorable * auto snapshot parameters.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { LightsailClient, CopySnapshotCommand } from "@aws-sdk/client-lightsail"; // ES Modules import + * // const { LightsailClient, CopySnapshotCommand } = require("@aws-sdk/client-lightsail"); // CommonJS import + * const client = new LightsailClient(config); + * const command = new CopySnapshotCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CopySnapshotCommandInput} for command's `input` shape. + * @see {@link CopySnapshotCommandOutput} for command's `response` shape. + * @see {@link LightsailClientResolvedConfig | config} for command's `input` shape. + * */ export class CopySnapshotCommand extends $Command< CopySnapshotCommandInput, diff --git a/clients/client-lightsail/commands/CreateCertificateCommand.ts b/clients/client-lightsail/commands/CreateCertificateCommand.ts index 6b92b42e783f..daced401b1c5 100644 --- a/clients/client-lightsail/commands/CreateCertificateCommand.ts +++ b/clients/client-lightsail/commands/CreateCertificateCommand.ts @@ -33,6 +33,20 @@ export interface CreateCertificateCommandOutput extends CreateCertificateResult, * an origin in any AWS Region, and distribute its content globally. However, all * distributions are located in the us-east-1 Region.

* + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { LightsailClient, CreateCertificateCommand } from "@aws-sdk/client-lightsail"; // ES Modules import + * // const { LightsailClient, CreateCertificateCommand } = require("@aws-sdk/client-lightsail"); // CommonJS import + * const client = new LightsailClient(config); + * const command = new CreateCertificateCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreateCertificateCommandInput} for command's `input` shape. + * @see {@link CreateCertificateCommandOutput} for command's `response` shape. + * @see {@link LightsailClientResolvedConfig | config} for command's `input` shape. + * */ export class CreateCertificateCommand extends $Command< CreateCertificateCommandInput, diff --git a/clients/client-lightsail/commands/CreateCloudFormationStackCommand.ts b/clients/client-lightsail/commands/CreateCloudFormationStackCommand.ts index d11355c4dbfb..6d79dd53db85 100644 --- a/clients/client-lightsail/commands/CreateCloudFormationStackCommand.ts +++ b/clients/client-lightsail/commands/CreateCloudFormationStackCommand.ts @@ -29,6 +29,20 @@ export interface CreateCloudFormationStackCommandOutput extends CreateCloudForma *

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.

* + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { LightsailClient, CreateCloudFormationStackCommand } from "@aws-sdk/client-lightsail"; // ES Modules import + * // const { LightsailClient, CreateCloudFormationStackCommand } = require("@aws-sdk/client-lightsail"); // CommonJS import + * const client = new LightsailClient(config); + * const command = new CreateCloudFormationStackCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreateCloudFormationStackCommandInput} for command's `input` shape. + * @see {@link CreateCloudFormationStackCommandOutput} for command's `response` shape. + * @see {@link LightsailClientResolvedConfig | config} for command's `input` shape. + * */ export class CreateCloudFormationStackCommand extends $Command< CreateCloudFormationStackCommandInput, diff --git a/clients/client-lightsail/commands/CreateContactMethodCommand.ts b/clients/client-lightsail/commands/CreateContactMethodCommand.ts index 99901d7030a1..b0fc11d8a4f9 100644 --- a/clients/client-lightsail/commands/CreateContactMethodCommand.ts +++ b/clients/client-lightsail/commands/CreateContactMethodCommand.ts @@ -26,6 +26,20 @@ export interface CreateContactMethodCommandOutput extends CreateContactMethodRes * You can add one email address and one mobile phone number contact method in each AWS Region. * However, SMS text messaging is not supported in some AWS Regions, and SMS text messages * cannot be sent to some countries/regions. For more information, see Notifications in Amazon Lightsail.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { LightsailClient, CreateContactMethodCommand } from "@aws-sdk/client-lightsail"; // ES Modules import + * // const { LightsailClient, CreateContactMethodCommand } = require("@aws-sdk/client-lightsail"); // CommonJS import + * const client = new LightsailClient(config); + * const command = new CreateContactMethodCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreateContactMethodCommandInput} for command's `input` shape. + * @see {@link CreateContactMethodCommandOutput} for command's `response` shape. + * @see {@link LightsailClientResolvedConfig | config} for command's `input` shape. + * */ export class CreateContactMethodCommand extends $Command< CreateContactMethodCommandInput, diff --git a/clients/client-lightsail/commands/CreateContainerServiceCommand.ts b/clients/client-lightsail/commands/CreateContainerServiceCommand.ts index 790c9c954262..4a6d40e983eb 100644 --- a/clients/client-lightsail/commands/CreateContainerServiceCommand.ts +++ b/clients/client-lightsail/commands/CreateContainerServiceCommand.ts @@ -26,6 +26,20 @@ export interface CreateContainerServiceCommandOutput extends CreateContainerServ *

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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { LightsailClient, CreateContainerServiceCommand } from "@aws-sdk/client-lightsail"; // ES Modules import + * // const { LightsailClient, CreateContainerServiceCommand } = require("@aws-sdk/client-lightsail"); // CommonJS import + * const client = new LightsailClient(config); + * const command = new CreateContainerServiceCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreateContainerServiceCommandInput} for command's `input` shape. + * @see {@link CreateContainerServiceCommandOutput} for command's `response` shape. + * @see {@link LightsailClientResolvedConfig | config} for command's `input` shape. + * */ export class CreateContainerServiceCommand extends $Command< CreateContainerServiceCommandInput, diff --git a/clients/client-lightsail/commands/CreateContainerServiceDeploymentCommand.ts b/clients/client-lightsail/commands/CreateContainerServiceDeploymentCommand.ts index 4a57780ca1f4..88e45551fa1e 100644 --- a/clients/client-lightsail/commands/CreateContainerServiceDeploymentCommand.ts +++ b/clients/client-lightsail/commands/CreateContainerServiceDeploymentCommand.ts @@ -34,6 +34,20 @@ export interface CreateContainerServiceDeploymentCommandOutput *

You can deploy containers to your container service using container images from a public * registry like Docker Hub, or from your local machine. For more information, see Creating container images for your Amazon Lightsail container services in the * Lightsail Dev Guide.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { LightsailClient, CreateContainerServiceDeploymentCommand } from "@aws-sdk/client-lightsail"; // ES Modules import + * // const { LightsailClient, CreateContainerServiceDeploymentCommand } = require("@aws-sdk/client-lightsail"); // CommonJS import + * const client = new LightsailClient(config); + * const command = new CreateContainerServiceDeploymentCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreateContainerServiceDeploymentCommandInput} for command's `input` shape. + * @see {@link CreateContainerServiceDeploymentCommandOutput} for command's `response` shape. + * @see {@link LightsailClientResolvedConfig | config} for command's `input` shape. + * */ export class CreateContainerServiceDeploymentCommand extends $Command< CreateContainerServiceDeploymentCommandInput, diff --git a/clients/client-lightsail/commands/CreateContainerServiceRegistryLoginCommand.ts b/clients/client-lightsail/commands/CreateContainerServiceRegistryLoginCommand.ts index 6b8528c7d9ff..41ed7d8da115 100644 --- a/clients/client-lightsail/commands/CreateContainerServiceRegistryLoginCommand.ts +++ b/clients/client-lightsail/commands/CreateContainerServiceRegistryLoginCommand.ts @@ -49,6 +49,20 @@ export interface CreateContainerServiceRegistryLoginCommandOutput * more information, see Pushing and managing container images on your Amazon Lightsail container services * in the Lightsail Dev Guide.

* + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { LightsailClient, CreateContainerServiceRegistryLoginCommand } from "@aws-sdk/client-lightsail"; // ES Modules import + * // const { LightsailClient, CreateContainerServiceRegistryLoginCommand } = require("@aws-sdk/client-lightsail"); // CommonJS import + * const client = new LightsailClient(config); + * const command = new CreateContainerServiceRegistryLoginCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreateContainerServiceRegistryLoginCommandInput} for command's `input` shape. + * @see {@link CreateContainerServiceRegistryLoginCommandOutput} for command's `response` shape. + * @see {@link LightsailClientResolvedConfig | config} for command's `input` shape. + * */ export class CreateContainerServiceRegistryLoginCommand extends $Command< CreateContainerServiceRegistryLoginCommandInput, diff --git a/clients/client-lightsail/commands/CreateDiskCommand.ts b/clients/client-lightsail/commands/CreateDiskCommand.ts index fb5f5c5a64f0..7eaa0279e069 100644 --- a/clients/client-lightsail/commands/CreateDiskCommand.ts +++ b/clients/client-lightsail/commands/CreateDiskCommand.ts @@ -25,6 +25,20 @@ export interface CreateDiskCommandOutput extends CreateDiskResult, __MetadataBea * 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 Lightsail Dev Guide.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { LightsailClient, CreateDiskCommand } from "@aws-sdk/client-lightsail"; // ES Modules import + * // const { LightsailClient, CreateDiskCommand } = require("@aws-sdk/client-lightsail"); // CommonJS import + * const client = new LightsailClient(config); + * const command = new CreateDiskCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreateDiskCommandInput} for command's `input` shape. + * @see {@link CreateDiskCommandOutput} for command's `response` shape. + * @see {@link LightsailClientResolvedConfig | config} for command's `input` shape. + * */ export class CreateDiskCommand extends $Command< CreateDiskCommandInput, diff --git a/clients/client-lightsail/commands/CreateDiskFromSnapshotCommand.ts b/clients/client-lightsail/commands/CreateDiskFromSnapshotCommand.ts index ce774e02aa5f..77da3784d5a3 100644 --- a/clients/client-lightsail/commands/CreateDiskFromSnapshotCommand.ts +++ b/clients/client-lightsail/commands/CreateDiskFromSnapshotCommand.ts @@ -27,6 +27,20 @@ export interface CreateDiskFromSnapshotCommandOutput extends CreateDiskFromSnaps *

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 Lightsail Dev Guide.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { LightsailClient, CreateDiskFromSnapshotCommand } from "@aws-sdk/client-lightsail"; // ES Modules import + * // const { LightsailClient, CreateDiskFromSnapshotCommand } = require("@aws-sdk/client-lightsail"); // CommonJS import + * const client = new LightsailClient(config); + * const command = new CreateDiskFromSnapshotCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreateDiskFromSnapshotCommandInput} for command's `input` shape. + * @see {@link CreateDiskFromSnapshotCommandOutput} for command's `response` shape. + * @see {@link LightsailClientResolvedConfig | config} for command's `input` shape. + * */ export class CreateDiskFromSnapshotCommand extends $Command< CreateDiskFromSnapshotCommandInput, diff --git a/clients/client-lightsail/commands/CreateDiskSnapshotCommand.ts b/clients/client-lightsail/commands/CreateDiskSnapshotCommand.ts index c02ab6dd2252..70a71ff32b05 100644 --- a/clients/client-lightsail/commands/CreateDiskSnapshotCommand.ts +++ b/clients/client-lightsail/commands/CreateDiskSnapshotCommand.ts @@ -41,6 +41,20 @@ export interface CreateDiskSnapshotCommandOutput extends CreateDiskSnapshotResul * *

The create disk snapshot operation supports tag-based access control via * request tags. For more information, see the Lightsail Dev Guide.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { LightsailClient, CreateDiskSnapshotCommand } from "@aws-sdk/client-lightsail"; // ES Modules import + * // const { LightsailClient, CreateDiskSnapshotCommand } = require("@aws-sdk/client-lightsail"); // CommonJS import + * const client = new LightsailClient(config); + * const command = new CreateDiskSnapshotCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreateDiskSnapshotCommandInput} for command's `input` shape. + * @see {@link CreateDiskSnapshotCommandOutput} for command's `response` shape. + * @see {@link LightsailClientResolvedConfig | config} for command's `input` shape. + * */ export class CreateDiskSnapshotCommand extends $Command< CreateDiskSnapshotCommandInput, diff --git a/clients/client-lightsail/commands/CreateDistributionCommand.ts b/clients/client-lightsail/commands/CreateDistributionCommand.ts index f66022b09c49..511bfde06795 100644 --- a/clients/client-lightsail/commands/CreateDistributionCommand.ts +++ b/clients/client-lightsail/commands/CreateDistributionCommand.ts @@ -25,6 +25,20 @@ export interface CreateDistributionCommandOutput extends CreateDistributionResul *

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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { LightsailClient, CreateDistributionCommand } from "@aws-sdk/client-lightsail"; // ES Modules import + * // const { LightsailClient, CreateDistributionCommand } = require("@aws-sdk/client-lightsail"); // CommonJS import + * const client = new LightsailClient(config); + * const command = new CreateDistributionCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreateDistributionCommandInput} for command's `input` shape. + * @see {@link CreateDistributionCommandOutput} for command's `response` shape. + * @see {@link LightsailClientResolvedConfig | config} for command's `input` shape. + * */ export class CreateDistributionCommand extends $Command< CreateDistributionCommandInput, diff --git a/clients/client-lightsail/commands/CreateDomainCommand.ts b/clients/client-lightsail/commands/CreateDomainCommand.ts index 65671de169c9..c7cc8d655f95 100644 --- a/clients/client-lightsail/commands/CreateDomainCommand.ts +++ b/clients/client-lightsail/commands/CreateDomainCommand.ts @@ -24,6 +24,20 @@ export interface CreateDomainCommandOutput extends CreateDomainResult, __Metadat *

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 Lightsail Dev Guide.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { LightsailClient, CreateDomainCommand } from "@aws-sdk/client-lightsail"; // ES Modules import + * // const { LightsailClient, CreateDomainCommand } = require("@aws-sdk/client-lightsail"); // CommonJS import + * const client = new LightsailClient(config); + * const command = new CreateDomainCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreateDomainCommandInput} for command's `input` shape. + * @see {@link CreateDomainCommandOutput} for command's `response` shape. + * @see {@link LightsailClientResolvedConfig | config} for command's `input` shape. + * */ export class CreateDomainCommand extends $Command< CreateDomainCommandInput, diff --git a/clients/client-lightsail/commands/CreateDomainEntryCommand.ts b/clients/client-lightsail/commands/CreateDomainEntryCommand.ts index bc19ca4c6654..bfeb9f5b03b0 100644 --- a/clients/client-lightsail/commands/CreateDomainEntryCommand.ts +++ b/clients/client-lightsail/commands/CreateDomainEntryCommand.ts @@ -30,6 +30,20 @@ export interface CreateDomainEntryCommandOutput extends CreateDomainEntryResult, *

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 Lightsail Dev Guide.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { LightsailClient, CreateDomainEntryCommand } from "@aws-sdk/client-lightsail"; // ES Modules import + * // const { LightsailClient, CreateDomainEntryCommand } = require("@aws-sdk/client-lightsail"); // CommonJS import + * const client = new LightsailClient(config); + * const command = new CreateDomainEntryCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreateDomainEntryCommandInput} for command's `input` shape. + * @see {@link CreateDomainEntryCommandOutput} for command's `response` shape. + * @see {@link LightsailClientResolvedConfig | config} for command's `input` shape. + * */ export class CreateDomainEntryCommand extends $Command< CreateDomainEntryCommandInput, diff --git a/clients/client-lightsail/commands/CreateInstanceSnapshotCommand.ts b/clients/client-lightsail/commands/CreateInstanceSnapshotCommand.ts index 5722fff12c15..95bfd0662ba9 100644 --- a/clients/client-lightsail/commands/CreateInstanceSnapshotCommand.ts +++ b/clients/client-lightsail/commands/CreateInstanceSnapshotCommand.ts @@ -25,6 +25,20 @@ export interface CreateInstanceSnapshotCommandOutput extends CreateInstanceSnaps * 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 Lightsail Dev Guide.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { LightsailClient, CreateInstanceSnapshotCommand } from "@aws-sdk/client-lightsail"; // ES Modules import + * // const { LightsailClient, CreateInstanceSnapshotCommand } = require("@aws-sdk/client-lightsail"); // CommonJS import + * const client = new LightsailClient(config); + * const command = new CreateInstanceSnapshotCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreateInstanceSnapshotCommandInput} for command's `input` shape. + * @see {@link CreateInstanceSnapshotCommandOutput} for command's `response` shape. + * @see {@link LightsailClientResolvedConfig | config} for command's `input` shape. + * */ export class CreateInstanceSnapshotCommand extends $Command< CreateInstanceSnapshotCommandInput, diff --git a/clients/client-lightsail/commands/CreateInstancesCommand.ts b/clients/client-lightsail/commands/CreateInstancesCommand.ts index 6cd50318cf83..97f33e1b97f3 100644 --- a/clients/client-lightsail/commands/CreateInstancesCommand.ts +++ b/clients/client-lightsail/commands/CreateInstancesCommand.ts @@ -24,6 +24,20 @@ export interface CreateInstancesCommandOutput extends CreateInstancesResult, __M *

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 Dev Guide.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { LightsailClient, CreateInstancesCommand } from "@aws-sdk/client-lightsail"; // ES Modules import + * // const { LightsailClient, CreateInstancesCommand } = require("@aws-sdk/client-lightsail"); // CommonJS import + * const client = new LightsailClient(config); + * const command = new CreateInstancesCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreateInstancesCommandInput} for command's `input` shape. + * @see {@link CreateInstancesCommandOutput} for command's `response` shape. + * @see {@link LightsailClientResolvedConfig | config} for command's `input` shape. + * */ export class CreateInstancesCommand extends $Command< CreateInstancesCommandInput, diff --git a/clients/client-lightsail/commands/CreateInstancesFromSnapshotCommand.ts b/clients/client-lightsail/commands/CreateInstancesFromSnapshotCommand.ts index 06bc700be2f1..a8b71bd7909c 100644 --- a/clients/client-lightsail/commands/CreateInstancesFromSnapshotCommand.ts +++ b/clients/client-lightsail/commands/CreateInstancesFromSnapshotCommand.ts @@ -26,6 +26,20 @@ export interface CreateInstancesFromSnapshotCommandOutput extends CreateInstance *

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 Lightsail Dev Guide.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { LightsailClient, CreateInstancesFromSnapshotCommand } from "@aws-sdk/client-lightsail"; // ES Modules import + * // const { LightsailClient, CreateInstancesFromSnapshotCommand } = require("@aws-sdk/client-lightsail"); // CommonJS import + * const client = new LightsailClient(config); + * const command = new CreateInstancesFromSnapshotCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreateInstancesFromSnapshotCommandInput} for command's `input` shape. + * @see {@link CreateInstancesFromSnapshotCommandOutput} for command's `response` shape. + * @see {@link LightsailClientResolvedConfig | config} for command's `input` shape. + * */ export class CreateInstancesFromSnapshotCommand extends $Command< CreateInstancesFromSnapshotCommandInput, diff --git a/clients/client-lightsail/commands/CreateKeyPairCommand.ts b/clients/client-lightsail/commands/CreateKeyPairCommand.ts index a7835d649374..7c2751ab9678 100644 --- a/clients/client-lightsail/commands/CreateKeyPairCommand.ts +++ b/clients/client-lightsail/commands/CreateKeyPairCommand.ts @@ -24,6 +24,20 @@ export interface CreateKeyPairCommandOutput extends CreateKeyPairResult, __Metad *

Creates an SSH key pair.

*

The create key pair operation supports tag-based access control via request * tags. For more information, see the Lightsail Dev Guide.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { LightsailClient, CreateKeyPairCommand } from "@aws-sdk/client-lightsail"; // ES Modules import + * // const { LightsailClient, CreateKeyPairCommand } = require("@aws-sdk/client-lightsail"); // CommonJS import + * const client = new LightsailClient(config); + * const command = new CreateKeyPairCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreateKeyPairCommandInput} for command's `input` shape. + * @see {@link CreateKeyPairCommandOutput} for command's `response` shape. + * @see {@link LightsailClientResolvedConfig | config} for command's `input` shape. + * */ export class CreateKeyPairCommand extends $Command< CreateKeyPairCommandInput, diff --git a/clients/client-lightsail/commands/CreateLoadBalancerCommand.ts b/clients/client-lightsail/commands/CreateLoadBalancerCommand.ts index 9e6bbd73866a..8fd075a8b66c 100644 --- a/clients/client-lightsail/commands/CreateLoadBalancerCommand.ts +++ b/clients/client-lightsail/commands/CreateLoadBalancerCommand.ts @@ -29,6 +29,20 @@ export interface CreateLoadBalancerCommandOutput extends CreateLoadBalancerResul * operation.

*

The create load balancer operation supports tag-based access control via * request tags. For more information, see the Lightsail Dev Guide.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { LightsailClient, CreateLoadBalancerCommand } from "@aws-sdk/client-lightsail"; // ES Modules import + * // const { LightsailClient, CreateLoadBalancerCommand } = require("@aws-sdk/client-lightsail"); // CommonJS import + * const client = new LightsailClient(config); + * const command = new CreateLoadBalancerCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreateLoadBalancerCommandInput} for command's `input` shape. + * @see {@link CreateLoadBalancerCommandOutput} for command's `response` shape. + * @see {@link LightsailClientResolvedConfig | config} for command's `input` shape. + * */ export class CreateLoadBalancerCommand extends $Command< CreateLoadBalancerCommandInput, diff --git a/clients/client-lightsail/commands/CreateLoadBalancerTlsCertificateCommand.ts b/clients/client-lightsail/commands/CreateLoadBalancerTlsCertificateCommand.ts index a52dda7c5de6..c5414d8518e5 100644 --- a/clients/client-lightsail/commands/CreateLoadBalancerTlsCertificateCommand.ts +++ b/clients/client-lightsail/commands/CreateLoadBalancerTlsCertificateCommand.ts @@ -28,6 +28,20 @@ export interface CreateLoadBalancerTlsCertificateCommandOutput *

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 Lightsail Dev Guide.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { LightsailClient, CreateLoadBalancerTlsCertificateCommand } from "@aws-sdk/client-lightsail"; // ES Modules import + * // const { LightsailClient, CreateLoadBalancerTlsCertificateCommand } = require("@aws-sdk/client-lightsail"); // CommonJS import + * const client = new LightsailClient(config); + * const command = new CreateLoadBalancerTlsCertificateCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreateLoadBalancerTlsCertificateCommandInput} for command's `input` shape. + * @see {@link CreateLoadBalancerTlsCertificateCommandOutput} for command's `response` shape. + * @see {@link LightsailClientResolvedConfig | config} for command's `input` shape. + * */ export class CreateLoadBalancerTlsCertificateCommand extends $Command< CreateLoadBalancerTlsCertificateCommandInput, diff --git a/clients/client-lightsail/commands/CreateRelationalDatabaseCommand.ts b/clients/client-lightsail/commands/CreateRelationalDatabaseCommand.ts index ddc96357c5a6..b21dddb74aef 100644 --- a/clients/client-lightsail/commands/CreateRelationalDatabaseCommand.ts +++ b/clients/client-lightsail/commands/CreateRelationalDatabaseCommand.ts @@ -24,6 +24,20 @@ export interface CreateRelationalDatabaseCommandOutput extends CreateRelationalD *

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 Lightsail Dev Guide.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { LightsailClient, CreateRelationalDatabaseCommand } from "@aws-sdk/client-lightsail"; // ES Modules import + * // const { LightsailClient, CreateRelationalDatabaseCommand } = require("@aws-sdk/client-lightsail"); // CommonJS import + * const client = new LightsailClient(config); + * const command = new CreateRelationalDatabaseCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreateRelationalDatabaseCommandInput} for command's `input` shape. + * @see {@link CreateRelationalDatabaseCommandOutput} for command's `response` shape. + * @see {@link LightsailClientResolvedConfig | config} for command's `input` shape. + * */ export class CreateRelationalDatabaseCommand extends $Command< CreateRelationalDatabaseCommandInput, diff --git a/clients/client-lightsail/commands/CreateRelationalDatabaseFromSnapshotCommand.ts b/clients/client-lightsail/commands/CreateRelationalDatabaseFromSnapshotCommand.ts index a762477f646d..6a35594de791 100644 --- a/clients/client-lightsail/commands/CreateRelationalDatabaseFromSnapshotCommand.ts +++ b/clients/client-lightsail/commands/CreateRelationalDatabaseFromSnapshotCommand.ts @@ -33,6 +33,20 @@ export interface CreateRelationalDatabaseFromSnapshotCommandOutput *

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 Lightsail Dev Guide.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { LightsailClient, CreateRelationalDatabaseFromSnapshotCommand } from "@aws-sdk/client-lightsail"; // ES Modules import + * // const { LightsailClient, CreateRelationalDatabaseFromSnapshotCommand } = require("@aws-sdk/client-lightsail"); // CommonJS import + * const client = new LightsailClient(config); + * const command = new CreateRelationalDatabaseFromSnapshotCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreateRelationalDatabaseFromSnapshotCommandInput} for command's `input` shape. + * @see {@link CreateRelationalDatabaseFromSnapshotCommandOutput} for command's `response` shape. + * @see {@link LightsailClientResolvedConfig | config} for command's `input` shape. + * */ export class CreateRelationalDatabaseFromSnapshotCommand extends $Command< CreateRelationalDatabaseFromSnapshotCommandInput, diff --git a/clients/client-lightsail/commands/CreateRelationalDatabaseSnapshotCommand.ts b/clients/client-lightsail/commands/CreateRelationalDatabaseSnapshotCommand.ts index c0a2d42bc5c4..2a13a1b99f20 100644 --- a/clients/client-lightsail/commands/CreateRelationalDatabaseSnapshotCommand.ts +++ b/clients/client-lightsail/commands/CreateRelationalDatabaseSnapshotCommand.ts @@ -27,6 +27,20 @@ export interface CreateRelationalDatabaseSnapshotCommandOutput * 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 Lightsail Dev Guide.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { LightsailClient, CreateRelationalDatabaseSnapshotCommand } from "@aws-sdk/client-lightsail"; // ES Modules import + * // const { LightsailClient, CreateRelationalDatabaseSnapshotCommand } = require("@aws-sdk/client-lightsail"); // CommonJS import + * const client = new LightsailClient(config); + * const command = new CreateRelationalDatabaseSnapshotCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreateRelationalDatabaseSnapshotCommandInput} for command's `input` shape. + * @see {@link CreateRelationalDatabaseSnapshotCommandOutput} for command's `response` shape. + * @see {@link LightsailClientResolvedConfig | config} for command's `input` shape. + * */ export class CreateRelationalDatabaseSnapshotCommand extends $Command< CreateRelationalDatabaseSnapshotCommandInput, diff --git a/clients/client-lightsail/commands/DeleteAlarmCommand.ts b/clients/client-lightsail/commands/DeleteAlarmCommand.ts index a18bce3a92e0..dcd4f215efaf 100644 --- a/clients/client-lightsail/commands/DeleteAlarmCommand.ts +++ b/clients/client-lightsail/commands/DeleteAlarmCommand.ts @@ -26,6 +26,20 @@ export interface DeleteAlarmCommandOutput extends DeleteAlarmResult, __MetadataB * 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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { LightsailClient, DeleteAlarmCommand } from "@aws-sdk/client-lightsail"; // ES Modules import + * // const { LightsailClient, DeleteAlarmCommand } = require("@aws-sdk/client-lightsail"); // CommonJS import + * const client = new LightsailClient(config); + * const command = new DeleteAlarmCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteAlarmCommandInput} for command's `input` shape. + * @see {@link DeleteAlarmCommandOutput} for command's `response` shape. + * @see {@link LightsailClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteAlarmCommand extends $Command< DeleteAlarmCommandInput, diff --git a/clients/client-lightsail/commands/DeleteAutoSnapshotCommand.ts b/clients/client-lightsail/commands/DeleteAutoSnapshotCommand.ts index b43b9cf0bd30..8da4311681f7 100644 --- a/clients/client-lightsail/commands/DeleteAutoSnapshotCommand.ts +++ b/clients/client-lightsail/commands/DeleteAutoSnapshotCommand.ts @@ -22,6 +22,20 @@ export interface DeleteAutoSnapshotCommandOutput extends DeleteAutoSnapshotResul /** *

Deletes an automatic snapshot of an instance or disk. For more information, see the Lightsail Dev Guide.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { LightsailClient, DeleteAutoSnapshotCommand } from "@aws-sdk/client-lightsail"; // ES Modules import + * // const { LightsailClient, DeleteAutoSnapshotCommand } = require("@aws-sdk/client-lightsail"); // CommonJS import + * const client = new LightsailClient(config); + * const command = new DeleteAutoSnapshotCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteAutoSnapshotCommandInput} for command's `input` shape. + * @see {@link DeleteAutoSnapshotCommandOutput} for command's `response` shape. + * @see {@link LightsailClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteAutoSnapshotCommand extends $Command< DeleteAutoSnapshotCommandInput, diff --git a/clients/client-lightsail/commands/DeleteCertificateCommand.ts b/clients/client-lightsail/commands/DeleteCertificateCommand.ts index ffbe9d709134..a5d36724c76c 100644 --- a/clients/client-lightsail/commands/DeleteCertificateCommand.ts +++ b/clients/client-lightsail/commands/DeleteCertificateCommand.ts @@ -26,6 +26,20 @@ export interface DeleteCertificateCommandOutput extends DeleteCertificateResult, *

Certificates that are currently attached to a distribution cannot be deleted. Use the * DetachCertificateFromDistribution action to detach a certificate from a * distribution.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { LightsailClient, DeleteCertificateCommand } from "@aws-sdk/client-lightsail"; // ES Modules import + * // const { LightsailClient, DeleteCertificateCommand } = require("@aws-sdk/client-lightsail"); // CommonJS import + * const client = new LightsailClient(config); + * const command = new DeleteCertificateCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteCertificateCommandInput} for command's `input` shape. + * @see {@link DeleteCertificateCommandOutput} for command's `response` shape. + * @see {@link LightsailClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteCertificateCommand extends $Command< DeleteCertificateCommandInput, diff --git a/clients/client-lightsail/commands/DeleteContactMethodCommand.ts b/clients/client-lightsail/commands/DeleteContactMethodCommand.ts index be761021489a..5f592d3d44a0 100644 --- a/clients/client-lightsail/commands/DeleteContactMethodCommand.ts +++ b/clients/client-lightsail/commands/DeleteContactMethodCommand.ts @@ -26,6 +26,20 @@ export interface DeleteContactMethodCommandOutput extends DeleteContactMethodRes * You can add one email address and one mobile phone number contact method in each AWS Region. * However, SMS text messaging is not supported in some AWS Regions, and SMS text messages * cannot be sent to some countries/regions. For more information, see Notifications in Amazon Lightsail.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { LightsailClient, DeleteContactMethodCommand } from "@aws-sdk/client-lightsail"; // ES Modules import + * // const { LightsailClient, DeleteContactMethodCommand } = require("@aws-sdk/client-lightsail"); // CommonJS import + * const client = new LightsailClient(config); + * const command = new DeleteContactMethodCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteContactMethodCommandInput} for command's `input` shape. + * @see {@link DeleteContactMethodCommandOutput} for command's `response` shape. + * @see {@link LightsailClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteContactMethodCommand extends $Command< DeleteContactMethodCommandInput, diff --git a/clients/client-lightsail/commands/DeleteContainerImageCommand.ts b/clients/client-lightsail/commands/DeleteContainerImageCommand.ts index d356d0c02055..b2dca487add7 100644 --- a/clients/client-lightsail/commands/DeleteContainerImageCommand.ts +++ b/clients/client-lightsail/commands/DeleteContainerImageCommand.ts @@ -23,6 +23,20 @@ export interface DeleteContainerImageCommandOutput extends DeleteContainerImageR /** *

Deletes a container image that is registered to your Amazon Lightsail container * service.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { LightsailClient, DeleteContainerImageCommand } from "@aws-sdk/client-lightsail"; // ES Modules import + * // const { LightsailClient, DeleteContainerImageCommand } = require("@aws-sdk/client-lightsail"); // CommonJS import + * const client = new LightsailClient(config); + * const command = new DeleteContainerImageCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteContainerImageCommandInput} for command's `input` shape. + * @see {@link DeleteContainerImageCommandOutput} for command's `response` shape. + * @see {@link LightsailClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteContainerImageCommand extends $Command< DeleteContainerImageCommandInput, diff --git a/clients/client-lightsail/commands/DeleteContainerServiceCommand.ts b/clients/client-lightsail/commands/DeleteContainerServiceCommand.ts index 014393d642a4..af7e5f667bbb 100644 --- a/clients/client-lightsail/commands/DeleteContainerServiceCommand.ts +++ b/clients/client-lightsail/commands/DeleteContainerServiceCommand.ts @@ -22,6 +22,20 @@ export interface DeleteContainerServiceCommandOutput extends DeleteContainerServ /** *

Deletes your Amazon Lightsail container service.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { LightsailClient, DeleteContainerServiceCommand } from "@aws-sdk/client-lightsail"; // ES Modules import + * // const { LightsailClient, DeleteContainerServiceCommand } = require("@aws-sdk/client-lightsail"); // CommonJS import + * const client = new LightsailClient(config); + * const command = new DeleteContainerServiceCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteContainerServiceCommandInput} for command's `input` shape. + * @see {@link DeleteContainerServiceCommandOutput} for command's `response` shape. + * @see {@link LightsailClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteContainerServiceCommand extends $Command< DeleteContainerServiceCommandInput, diff --git a/clients/client-lightsail/commands/DeleteDiskCommand.ts b/clients/client-lightsail/commands/DeleteDiskCommand.ts index f35f2d486165..03ffb6cbe511 100644 --- a/clients/client-lightsail/commands/DeleteDiskCommand.ts +++ b/clients/client-lightsail/commands/DeleteDiskCommand.ts @@ -29,6 +29,20 @@ export interface DeleteDiskCommandOutput extends DeleteDiskResult, __MetadataBea *

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 * Lightsail Dev Guide.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { LightsailClient, DeleteDiskCommand } from "@aws-sdk/client-lightsail"; // ES Modules import + * // const { LightsailClient, DeleteDiskCommand } = require("@aws-sdk/client-lightsail"); // CommonJS import + * const client = new LightsailClient(config); + * const command = new DeleteDiskCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteDiskCommandInput} for command's `input` shape. + * @see {@link DeleteDiskCommandOutput} for command's `response` shape. + * @see {@link LightsailClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteDiskCommand extends $Command< DeleteDiskCommandInput, diff --git a/clients/client-lightsail/commands/DeleteDiskSnapshotCommand.ts b/clients/client-lightsail/commands/DeleteDiskSnapshotCommand.ts index 92c6a585d370..41c92b3ef6ef 100644 --- a/clients/client-lightsail/commands/DeleteDiskSnapshotCommand.ts +++ b/clients/client-lightsail/commands/DeleteDiskSnapshotCommand.ts @@ -30,6 +30,20 @@ export interface DeleteDiskSnapshotCommandOutput extends DeleteDiskSnapshotResul *

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 Lightsail Dev Guide.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { LightsailClient, DeleteDiskSnapshotCommand } from "@aws-sdk/client-lightsail"; // ES Modules import + * // const { LightsailClient, DeleteDiskSnapshotCommand } = require("@aws-sdk/client-lightsail"); // CommonJS import + * const client = new LightsailClient(config); + * const command = new DeleteDiskSnapshotCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteDiskSnapshotCommandInput} for command's `input` shape. + * @see {@link DeleteDiskSnapshotCommandOutput} for command's `response` shape. + * @see {@link LightsailClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteDiskSnapshotCommand extends $Command< DeleteDiskSnapshotCommandInput, diff --git a/clients/client-lightsail/commands/DeleteDistributionCommand.ts b/clients/client-lightsail/commands/DeleteDistributionCommand.ts index 8fe829bbb5e6..83b7022a3951 100644 --- a/clients/client-lightsail/commands/DeleteDistributionCommand.ts +++ b/clients/client-lightsail/commands/DeleteDistributionCommand.ts @@ -22,6 +22,20 @@ export interface DeleteDistributionCommandOutput extends DeleteDistributionResul /** *

Deletes your Amazon Lightsail content delivery network (CDN) distribution.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { LightsailClient, DeleteDistributionCommand } from "@aws-sdk/client-lightsail"; // ES Modules import + * // const { LightsailClient, DeleteDistributionCommand } = require("@aws-sdk/client-lightsail"); // CommonJS import + * const client = new LightsailClient(config); + * const command = new DeleteDistributionCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteDistributionCommandInput} for command's `input` shape. + * @see {@link DeleteDistributionCommandOutput} for command's `response` shape. + * @see {@link LightsailClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteDistributionCommand extends $Command< DeleteDistributionCommandInput, diff --git a/clients/client-lightsail/commands/DeleteDomainCommand.ts b/clients/client-lightsail/commands/DeleteDomainCommand.ts index 9baa6849f713..a2883ad5ac11 100644 --- a/clients/client-lightsail/commands/DeleteDomainCommand.ts +++ b/clients/client-lightsail/commands/DeleteDomainCommand.ts @@ -25,6 +25,20 @@ export interface DeleteDomainCommandOutput extends DeleteDomainResult, __Metadat *

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 Lightsail Dev Guide.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { LightsailClient, DeleteDomainCommand } from "@aws-sdk/client-lightsail"; // ES Modules import + * // const { LightsailClient, DeleteDomainCommand } = require("@aws-sdk/client-lightsail"); // CommonJS import + * const client = new LightsailClient(config); + * const command = new DeleteDomainCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteDomainCommandInput} for command's `input` shape. + * @see {@link DeleteDomainCommandOutput} for command's `response` shape. + * @see {@link LightsailClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteDomainCommand extends $Command< DeleteDomainCommandInput, diff --git a/clients/client-lightsail/commands/DeleteDomainEntryCommand.ts b/clients/client-lightsail/commands/DeleteDomainEntryCommand.ts index d1454c7f6709..3c5edc5280ac 100644 --- a/clients/client-lightsail/commands/DeleteDomainEntryCommand.ts +++ b/clients/client-lightsail/commands/DeleteDomainEntryCommand.ts @@ -25,6 +25,20 @@ export interface DeleteDomainEntryCommandOutput extends DeleteDomainEntryResult, *

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 Lightsail Dev Guide.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { LightsailClient, DeleteDomainEntryCommand } from "@aws-sdk/client-lightsail"; // ES Modules import + * // const { LightsailClient, DeleteDomainEntryCommand } = require("@aws-sdk/client-lightsail"); // CommonJS import + * const client = new LightsailClient(config); + * const command = new DeleteDomainEntryCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteDomainEntryCommandInput} for command's `input` shape. + * @see {@link DeleteDomainEntryCommandOutput} for command's `response` shape. + * @see {@link LightsailClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteDomainEntryCommand extends $Command< DeleteDomainEntryCommandInput, diff --git a/clients/client-lightsail/commands/DeleteInstanceCommand.ts b/clients/client-lightsail/commands/DeleteInstanceCommand.ts index 16c86004cfb5..f35ec5649852 100644 --- a/clients/client-lightsail/commands/DeleteInstanceCommand.ts +++ b/clients/client-lightsail/commands/DeleteInstanceCommand.ts @@ -25,6 +25,20 @@ export interface DeleteInstanceCommandOutput extends DeleteInstanceResult, __Met *

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 Lightsail Dev Guide.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { LightsailClient, DeleteInstanceCommand } from "@aws-sdk/client-lightsail"; // ES Modules import + * // const { LightsailClient, DeleteInstanceCommand } = require("@aws-sdk/client-lightsail"); // CommonJS import + * const client = new LightsailClient(config); + * const command = new DeleteInstanceCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteInstanceCommandInput} for command's `input` shape. + * @see {@link DeleteInstanceCommandOutput} for command's `response` shape. + * @see {@link LightsailClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteInstanceCommand extends $Command< DeleteInstanceCommandInput, diff --git a/clients/client-lightsail/commands/DeleteInstanceSnapshotCommand.ts b/clients/client-lightsail/commands/DeleteInstanceSnapshotCommand.ts index 215bf2f78fe3..5acb84803a08 100644 --- a/clients/client-lightsail/commands/DeleteInstanceSnapshotCommand.ts +++ b/clients/client-lightsail/commands/DeleteInstanceSnapshotCommand.ts @@ -26,6 +26,20 @@ export interface DeleteInstanceSnapshotCommandOutput extends DeleteInstanceSnaps *

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 Lightsail Dev Guide.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { LightsailClient, DeleteInstanceSnapshotCommand } from "@aws-sdk/client-lightsail"; // ES Modules import + * // const { LightsailClient, DeleteInstanceSnapshotCommand } = require("@aws-sdk/client-lightsail"); // CommonJS import + * const client = new LightsailClient(config); + * const command = new DeleteInstanceSnapshotCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteInstanceSnapshotCommandInput} for command's `input` shape. + * @see {@link DeleteInstanceSnapshotCommandOutput} for command's `response` shape. + * @see {@link LightsailClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteInstanceSnapshotCommand extends $Command< DeleteInstanceSnapshotCommandInput, diff --git a/clients/client-lightsail/commands/DeleteKeyPairCommand.ts b/clients/client-lightsail/commands/DeleteKeyPairCommand.ts index 84c8f74b38fb..3e3464e69ed4 100644 --- a/clients/client-lightsail/commands/DeleteKeyPairCommand.ts +++ b/clients/client-lightsail/commands/DeleteKeyPairCommand.ts @@ -25,6 +25,20 @@ export interface DeleteKeyPairCommandOutput extends DeleteKeyPairResult, __Metad *

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 Lightsail Dev Guide.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { LightsailClient, DeleteKeyPairCommand } from "@aws-sdk/client-lightsail"; // ES Modules import + * // const { LightsailClient, DeleteKeyPairCommand } = require("@aws-sdk/client-lightsail"); // CommonJS import + * const client = new LightsailClient(config); + * const command = new DeleteKeyPairCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteKeyPairCommandInput} for command's `input` shape. + * @see {@link DeleteKeyPairCommandOutput} for command's `response` shape. + * @see {@link LightsailClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteKeyPairCommand extends $Command< DeleteKeyPairCommandInput, diff --git a/clients/client-lightsail/commands/DeleteKnownHostKeysCommand.ts b/clients/client-lightsail/commands/DeleteKnownHostKeysCommand.ts index ba520621f907..42db1cac5dcd 100644 --- a/clients/client-lightsail/commands/DeleteKnownHostKeysCommand.ts +++ b/clients/client-lightsail/commands/DeleteKnownHostKeysCommand.ts @@ -30,6 +30,20 @@ export interface DeleteKnownHostKeysCommandOutput extends DeleteKnownHostKeysRes * information, see Troubleshooting connection issues when using the Amazon Lightsail browser-based SSH or RDP * client.

* + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { LightsailClient, DeleteKnownHostKeysCommand } from "@aws-sdk/client-lightsail"; // ES Modules import + * // const { LightsailClient, DeleteKnownHostKeysCommand } = require("@aws-sdk/client-lightsail"); // CommonJS import + * const client = new LightsailClient(config); + * const command = new DeleteKnownHostKeysCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteKnownHostKeysCommandInput} for command's `input` shape. + * @see {@link DeleteKnownHostKeysCommandOutput} for command's `response` shape. + * @see {@link LightsailClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteKnownHostKeysCommand extends $Command< DeleteKnownHostKeysCommandInput, diff --git a/clients/client-lightsail/commands/DeleteLoadBalancerCommand.ts b/clients/client-lightsail/commands/DeleteLoadBalancerCommand.ts index 62db420959eb..fcbe48947430 100644 --- a/clients/client-lightsail/commands/DeleteLoadBalancerCommand.ts +++ b/clients/client-lightsail/commands/DeleteLoadBalancerCommand.ts @@ -27,6 +27,20 @@ export interface DeleteLoadBalancerCommandOutput extends DeleteLoadBalancerResul *

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 Lightsail Dev Guide.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { LightsailClient, DeleteLoadBalancerCommand } from "@aws-sdk/client-lightsail"; // ES Modules import + * // const { LightsailClient, DeleteLoadBalancerCommand } = require("@aws-sdk/client-lightsail"); // CommonJS import + * const client = new LightsailClient(config); + * const command = new DeleteLoadBalancerCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteLoadBalancerCommandInput} for command's `input` shape. + * @see {@link DeleteLoadBalancerCommandOutput} for command's `response` shape. + * @see {@link LightsailClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteLoadBalancerCommand extends $Command< DeleteLoadBalancerCommandInput, diff --git a/clients/client-lightsail/commands/DeleteLoadBalancerTlsCertificateCommand.ts b/clients/client-lightsail/commands/DeleteLoadBalancerTlsCertificateCommand.ts index 5a4f22175824..cedd4d196042 100644 --- a/clients/client-lightsail/commands/DeleteLoadBalancerTlsCertificateCommand.ts +++ b/clients/client-lightsail/commands/DeleteLoadBalancerTlsCertificateCommand.ts @@ -27,6 +27,20 @@ export interface DeleteLoadBalancerTlsCertificateCommandOutput *

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 Lightsail Dev Guide.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { LightsailClient, DeleteLoadBalancerTlsCertificateCommand } from "@aws-sdk/client-lightsail"; // ES Modules import + * // const { LightsailClient, DeleteLoadBalancerTlsCertificateCommand } = require("@aws-sdk/client-lightsail"); // CommonJS import + * const client = new LightsailClient(config); + * const command = new DeleteLoadBalancerTlsCertificateCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteLoadBalancerTlsCertificateCommandInput} for command's `input` shape. + * @see {@link DeleteLoadBalancerTlsCertificateCommandOutput} for command's `response` shape. + * @see {@link LightsailClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteLoadBalancerTlsCertificateCommand extends $Command< DeleteLoadBalancerTlsCertificateCommandInput, diff --git a/clients/client-lightsail/commands/DeleteRelationalDatabaseCommand.ts b/clients/client-lightsail/commands/DeleteRelationalDatabaseCommand.ts index ece09b9023d0..59fa25961530 100644 --- a/clients/client-lightsail/commands/DeleteRelationalDatabaseCommand.ts +++ b/clients/client-lightsail/commands/DeleteRelationalDatabaseCommand.ts @@ -25,6 +25,20 @@ export interface DeleteRelationalDatabaseCommandOutput extends DeleteRelationalD *

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 Lightsail Dev Guide.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { LightsailClient, DeleteRelationalDatabaseCommand } from "@aws-sdk/client-lightsail"; // ES Modules import + * // const { LightsailClient, DeleteRelationalDatabaseCommand } = require("@aws-sdk/client-lightsail"); // CommonJS import + * const client = new LightsailClient(config); + * const command = new DeleteRelationalDatabaseCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteRelationalDatabaseCommandInput} for command's `input` shape. + * @see {@link DeleteRelationalDatabaseCommandOutput} for command's `response` shape. + * @see {@link LightsailClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteRelationalDatabaseCommand extends $Command< DeleteRelationalDatabaseCommandInput, diff --git a/clients/client-lightsail/commands/DeleteRelationalDatabaseSnapshotCommand.ts b/clients/client-lightsail/commands/DeleteRelationalDatabaseSnapshotCommand.ts index 997dbab3624a..600db96f7a24 100644 --- a/clients/client-lightsail/commands/DeleteRelationalDatabaseSnapshotCommand.ts +++ b/clients/client-lightsail/commands/DeleteRelationalDatabaseSnapshotCommand.ts @@ -27,6 +27,20 @@ export interface DeleteRelationalDatabaseSnapshotCommandOutput *

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 Lightsail Dev Guide.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { LightsailClient, DeleteRelationalDatabaseSnapshotCommand } from "@aws-sdk/client-lightsail"; // ES Modules import + * // const { LightsailClient, DeleteRelationalDatabaseSnapshotCommand } = require("@aws-sdk/client-lightsail"); // CommonJS import + * const client = new LightsailClient(config); + * const command = new DeleteRelationalDatabaseSnapshotCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteRelationalDatabaseSnapshotCommandInput} for command's `input` shape. + * @see {@link DeleteRelationalDatabaseSnapshotCommandOutput} for command's `response` shape. + * @see {@link LightsailClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteRelationalDatabaseSnapshotCommand extends $Command< DeleteRelationalDatabaseSnapshotCommandInput, diff --git a/clients/client-lightsail/commands/DetachCertificateFromDistributionCommand.ts b/clients/client-lightsail/commands/DetachCertificateFromDistributionCommand.ts index 0b3740bd8235..6cd8642d0998 100644 --- a/clients/client-lightsail/commands/DetachCertificateFromDistributionCommand.ts +++ b/clients/client-lightsail/commands/DetachCertificateFromDistributionCommand.ts @@ -27,6 +27,20 @@ export interface DetachCertificateFromDistributionCommandOutput * distribution.

*

After the certificate is detached, your distribution stops accepting traffic for all of * the domains that are associated with the certificate.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { LightsailClient, DetachCertificateFromDistributionCommand } from "@aws-sdk/client-lightsail"; // ES Modules import + * // const { LightsailClient, DetachCertificateFromDistributionCommand } = require("@aws-sdk/client-lightsail"); // CommonJS import + * const client = new LightsailClient(config); + * const command = new DetachCertificateFromDistributionCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DetachCertificateFromDistributionCommandInput} for command's `input` shape. + * @see {@link DetachCertificateFromDistributionCommandOutput} for command's `response` shape. + * @see {@link LightsailClientResolvedConfig | config} for command's `input` shape. + * */ export class DetachCertificateFromDistributionCommand extends $Command< DetachCertificateFromDistributionCommandInput, diff --git a/clients/client-lightsail/commands/DetachDiskCommand.ts b/clients/client-lightsail/commands/DetachDiskCommand.ts index cc57a5904879..f511a283d4c2 100644 --- a/clients/client-lightsail/commands/DetachDiskCommand.ts +++ b/clients/client-lightsail/commands/DetachDiskCommand.ts @@ -27,6 +27,20 @@ export interface DetachDiskCommandOutput extends DetachDiskResult, __MetadataBea *

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 * Lightsail Dev Guide.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { LightsailClient, DetachDiskCommand } from "@aws-sdk/client-lightsail"; // ES Modules import + * // const { LightsailClient, DetachDiskCommand } = require("@aws-sdk/client-lightsail"); // CommonJS import + * const client = new LightsailClient(config); + * const command = new DetachDiskCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DetachDiskCommandInput} for command's `input` shape. + * @see {@link DetachDiskCommandOutput} for command's `response` shape. + * @see {@link LightsailClientResolvedConfig | config} for command's `input` shape. + * */ export class DetachDiskCommand extends $Command< DetachDiskCommandInput, diff --git a/clients/client-lightsail/commands/DetachInstancesFromLoadBalancerCommand.ts b/clients/client-lightsail/commands/DetachInstancesFromLoadBalancerCommand.ts index 6c45385934f0..8b15c792229f 100644 --- a/clients/client-lightsail/commands/DetachInstancesFromLoadBalancerCommand.ts +++ b/clients/client-lightsail/commands/DetachInstancesFromLoadBalancerCommand.ts @@ -29,6 +29,20 @@ export interface DetachInstancesFromLoadBalancerCommandOutput *

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 Lightsail Dev Guide.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { LightsailClient, DetachInstancesFromLoadBalancerCommand } from "@aws-sdk/client-lightsail"; // ES Modules import + * // const { LightsailClient, DetachInstancesFromLoadBalancerCommand } = require("@aws-sdk/client-lightsail"); // CommonJS import + * const client = new LightsailClient(config); + * const command = new DetachInstancesFromLoadBalancerCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DetachInstancesFromLoadBalancerCommandInput} for command's `input` shape. + * @see {@link DetachInstancesFromLoadBalancerCommandOutput} for command's `response` shape. + * @see {@link LightsailClientResolvedConfig | config} for command's `input` shape. + * */ export class DetachInstancesFromLoadBalancerCommand extends $Command< DetachInstancesFromLoadBalancerCommandInput, diff --git a/clients/client-lightsail/commands/DetachStaticIpCommand.ts b/clients/client-lightsail/commands/DetachStaticIpCommand.ts index b7817e2b1f55..54cf21e3f266 100644 --- a/clients/client-lightsail/commands/DetachStaticIpCommand.ts +++ b/clients/client-lightsail/commands/DetachStaticIpCommand.ts @@ -22,6 +22,20 @@ export interface DetachStaticIpCommandOutput extends DetachStaticIpResult, __Met /** *

Detaches a static IP from the Amazon Lightsail instance to which it is attached.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { LightsailClient, DetachStaticIpCommand } from "@aws-sdk/client-lightsail"; // ES Modules import + * // const { LightsailClient, DetachStaticIpCommand } = require("@aws-sdk/client-lightsail"); // CommonJS import + * const client = new LightsailClient(config); + * const command = new DetachStaticIpCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DetachStaticIpCommandInput} for command's `input` shape. + * @see {@link DetachStaticIpCommandOutput} for command's `response` shape. + * @see {@link LightsailClientResolvedConfig | config} for command's `input` shape. + * */ export class DetachStaticIpCommand extends $Command< DetachStaticIpCommandInput, diff --git a/clients/client-lightsail/commands/DisableAddOnCommand.ts b/clients/client-lightsail/commands/DisableAddOnCommand.ts index 860a3605379e..46b967777f4d 100644 --- a/clients/client-lightsail/commands/DisableAddOnCommand.ts +++ b/clients/client-lightsail/commands/DisableAddOnCommand.ts @@ -22,6 +22,20 @@ export interface DisableAddOnCommandOutput extends DisableAddOnResult, __Metadat /** *

Disables an add-on for an Amazon Lightsail resource. For more information, see the Lightsail Dev Guide.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { LightsailClient, DisableAddOnCommand } from "@aws-sdk/client-lightsail"; // ES Modules import + * // const { LightsailClient, DisableAddOnCommand } = require("@aws-sdk/client-lightsail"); // CommonJS import + * const client = new LightsailClient(config); + * const command = new DisableAddOnCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DisableAddOnCommandInput} for command's `input` shape. + * @see {@link DisableAddOnCommandOutput} for command's `response` shape. + * @see {@link LightsailClientResolvedConfig | config} for command's `input` shape. + * */ export class DisableAddOnCommand extends $Command< DisableAddOnCommandInput, diff --git a/clients/client-lightsail/commands/DownloadDefaultKeyPairCommand.ts b/clients/client-lightsail/commands/DownloadDefaultKeyPairCommand.ts index f433bb276552..396c67cdb086 100644 --- a/clients/client-lightsail/commands/DownloadDefaultKeyPairCommand.ts +++ b/clients/client-lightsail/commands/DownloadDefaultKeyPairCommand.ts @@ -22,6 +22,20 @@ export interface DownloadDefaultKeyPairCommandOutput extends DownloadDefaultKeyP /** *

Downloads the default SSH key pair from the user's account.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { LightsailClient, DownloadDefaultKeyPairCommand } from "@aws-sdk/client-lightsail"; // ES Modules import + * // const { LightsailClient, DownloadDefaultKeyPairCommand } = require("@aws-sdk/client-lightsail"); // CommonJS import + * const client = new LightsailClient(config); + * const command = new DownloadDefaultKeyPairCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DownloadDefaultKeyPairCommandInput} for command's `input` shape. + * @see {@link DownloadDefaultKeyPairCommandOutput} for command's `response` shape. + * @see {@link LightsailClientResolvedConfig | config} for command's `input` shape. + * */ export class DownloadDefaultKeyPairCommand extends $Command< DownloadDefaultKeyPairCommandInput, diff --git a/clients/client-lightsail/commands/EnableAddOnCommand.ts b/clients/client-lightsail/commands/EnableAddOnCommand.ts index 705ee99e0353..de2b4e117e43 100644 --- a/clients/client-lightsail/commands/EnableAddOnCommand.ts +++ b/clients/client-lightsail/commands/EnableAddOnCommand.ts @@ -23,6 +23,20 @@ export interface EnableAddOnCommandOutput extends EnableAddOnResult, __MetadataB /** *

Enables or modifies an add-on for an Amazon Lightsail resource. For more information, see * the Lightsail Dev Guide.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { LightsailClient, EnableAddOnCommand } from "@aws-sdk/client-lightsail"; // ES Modules import + * // const { LightsailClient, EnableAddOnCommand } = require("@aws-sdk/client-lightsail"); // CommonJS import + * const client = new LightsailClient(config); + * const command = new EnableAddOnCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link EnableAddOnCommandInput} for command's `input` shape. + * @see {@link EnableAddOnCommandOutput} for command's `response` shape. + * @see {@link LightsailClientResolvedConfig | config} for command's `input` shape. + * */ export class EnableAddOnCommand extends $Command< EnableAddOnCommandInput, diff --git a/clients/client-lightsail/commands/ExportSnapshotCommand.ts b/clients/client-lightsail/commands/ExportSnapshotCommand.ts index 926f88811036..b2f944e08639 100644 --- a/clients/client-lightsail/commands/ExportSnapshotCommand.ts +++ b/clients/client-lightsail/commands/ExportSnapshotCommand.ts @@ -36,6 +36,20 @@ export interface ExportSnapshotCommandOutput extends ExportSnapshotResult, __Met *

Use the get instance snapshots or get disk snapshots * operations to get a list of snapshots that you can export to Amazon EC2.

* + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { LightsailClient, ExportSnapshotCommand } from "@aws-sdk/client-lightsail"; // ES Modules import + * // const { LightsailClient, ExportSnapshotCommand } = require("@aws-sdk/client-lightsail"); // CommonJS import + * const client = new LightsailClient(config); + * const command = new ExportSnapshotCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ExportSnapshotCommandInput} for command's `input` shape. + * @see {@link ExportSnapshotCommandOutput} for command's `response` shape. + * @see {@link LightsailClientResolvedConfig | config} for command's `input` shape. + * */ export class ExportSnapshotCommand extends $Command< ExportSnapshotCommandInput, diff --git a/clients/client-lightsail/commands/GetActiveNamesCommand.ts b/clients/client-lightsail/commands/GetActiveNamesCommand.ts index 6604c57d9dd1..a92a8d041aa1 100644 --- a/clients/client-lightsail/commands/GetActiveNamesCommand.ts +++ b/clients/client-lightsail/commands/GetActiveNamesCommand.ts @@ -22,6 +22,20 @@ export interface GetActiveNamesCommandOutput extends GetActiveNamesResult, __Met /** *

Returns the names of all active (not deleted) resources.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { LightsailClient, GetActiveNamesCommand } from "@aws-sdk/client-lightsail"; // ES Modules import + * // const { LightsailClient, GetActiveNamesCommand } = require("@aws-sdk/client-lightsail"); // CommonJS import + * const client = new LightsailClient(config); + * const command = new GetActiveNamesCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetActiveNamesCommandInput} for command's `input` shape. + * @see {@link GetActiveNamesCommandOutput} for command's `response` shape. + * @see {@link LightsailClientResolvedConfig | config} for command's `input` shape. + * */ export class GetActiveNamesCommand extends $Command< GetActiveNamesCommandInput, diff --git a/clients/client-lightsail/commands/GetAlarmsCommand.ts b/clients/client-lightsail/commands/GetAlarmsCommand.ts index 3a1f4e8f6d4a..56c153e50c15 100644 --- a/clients/client-lightsail/commands/GetAlarmsCommand.ts +++ b/clients/client-lightsail/commands/GetAlarmsCommand.ts @@ -25,6 +25,20 @@ export interface GetAlarmsCommandOutput extends GetAlarmsResult, __MetadataBeare * 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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { LightsailClient, GetAlarmsCommand } from "@aws-sdk/client-lightsail"; // ES Modules import + * // const { LightsailClient, GetAlarmsCommand } = require("@aws-sdk/client-lightsail"); // CommonJS import + * const client = new LightsailClient(config); + * const command = new GetAlarmsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetAlarmsCommandInput} for command's `input` shape. + * @see {@link GetAlarmsCommandOutput} for command's `response` shape. + * @see {@link LightsailClientResolvedConfig | config} for command's `input` shape. + * */ export class GetAlarmsCommand extends $Command< GetAlarmsCommandInput, diff --git a/clients/client-lightsail/commands/GetAutoSnapshotsCommand.ts b/clients/client-lightsail/commands/GetAutoSnapshotsCommand.ts index f033f3bba54c..54840a76ddb6 100644 --- a/clients/client-lightsail/commands/GetAutoSnapshotsCommand.ts +++ b/clients/client-lightsail/commands/GetAutoSnapshotsCommand.ts @@ -23,6 +23,20 @@ export interface GetAutoSnapshotsCommandOutput extends GetAutoSnapshotsResult, _ /** *

Returns the available automatic snapshots for an instance or disk. For more information, * see the Lightsail Dev Guide.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { LightsailClient, GetAutoSnapshotsCommand } from "@aws-sdk/client-lightsail"; // ES Modules import + * // const { LightsailClient, GetAutoSnapshotsCommand } = require("@aws-sdk/client-lightsail"); // CommonJS import + * const client = new LightsailClient(config); + * const command = new GetAutoSnapshotsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetAutoSnapshotsCommandInput} for command's `input` shape. + * @see {@link GetAutoSnapshotsCommandOutput} for command's `response` shape. + * @see {@link LightsailClientResolvedConfig | config} for command's `input` shape. + * */ export class GetAutoSnapshotsCommand extends $Command< GetAutoSnapshotsCommandInput, diff --git a/clients/client-lightsail/commands/GetBlueprintsCommand.ts b/clients/client-lightsail/commands/GetBlueprintsCommand.ts index d0734a55d331..d180ff831f38 100644 --- a/clients/client-lightsail/commands/GetBlueprintsCommand.ts +++ b/clients/client-lightsail/commands/GetBlueprintsCommand.ts @@ -31,6 +31,20 @@ export interface GetBlueprintsCommandOutput extends GetBlueprintsResult, __Metad * instances. Blueprints are marked inactive when they become outdated due to operating system * updates or new application releases.

* + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { LightsailClient, GetBlueprintsCommand } from "@aws-sdk/client-lightsail"; // ES Modules import + * // const { LightsailClient, GetBlueprintsCommand } = require("@aws-sdk/client-lightsail"); // CommonJS import + * const client = new LightsailClient(config); + * const command = new GetBlueprintsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetBlueprintsCommandInput} for command's `input` shape. + * @see {@link GetBlueprintsCommandOutput} for command's `response` shape. + * @see {@link LightsailClientResolvedConfig | config} for command's `input` shape. + * */ export class GetBlueprintsCommand extends $Command< GetBlueprintsCommandInput, diff --git a/clients/client-lightsail/commands/GetBundlesCommand.ts b/clients/client-lightsail/commands/GetBundlesCommand.ts index a3003d868aef..3e73b54abf3f 100644 --- a/clients/client-lightsail/commands/GetBundlesCommand.ts +++ b/clients/client-lightsail/commands/GetBundlesCommand.ts @@ -23,6 +23,20 @@ export interface GetBundlesCommandOutput extends GetBundlesResult, __MetadataBea /** *

Returns the list of bundles that are available for purchase. A bundle describes the specs * for your virtual private server (or instance).

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { LightsailClient, GetBundlesCommand } from "@aws-sdk/client-lightsail"; // ES Modules import + * // const { LightsailClient, GetBundlesCommand } = require("@aws-sdk/client-lightsail"); // CommonJS import + * const client = new LightsailClient(config); + * const command = new GetBundlesCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetBundlesCommandInput} for command's `input` shape. + * @see {@link GetBundlesCommandOutput} for command's `response` shape. + * @see {@link LightsailClientResolvedConfig | config} for command's `input` shape. + * */ export class GetBundlesCommand extends $Command< GetBundlesCommandInput, diff --git a/clients/client-lightsail/commands/GetCertificatesCommand.ts b/clients/client-lightsail/commands/GetCertificatesCommand.ts index 04cc1d0a5f74..04ca0742bfbd 100644 --- a/clients/client-lightsail/commands/GetCertificatesCommand.ts +++ b/clients/client-lightsail/commands/GetCertificatesCommand.ts @@ -27,6 +27,20 @@ export interface GetCertificatesCommandOutput extends GetCertificatesResult, __M * your request. The response will include only the certificate Amazon Resource Name (ARN), * certificate name, domain name, and tags.

* + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { LightsailClient, GetCertificatesCommand } from "@aws-sdk/client-lightsail"; // ES Modules import + * // const { LightsailClient, GetCertificatesCommand } = require("@aws-sdk/client-lightsail"); // CommonJS import + * const client = new LightsailClient(config); + * const command = new GetCertificatesCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetCertificatesCommandInput} for command's `input` shape. + * @see {@link GetCertificatesCommandOutput} for command's `response` shape. + * @see {@link LightsailClientResolvedConfig | config} for command's `input` shape. + * */ export class GetCertificatesCommand extends $Command< GetCertificatesCommandInput, diff --git a/clients/client-lightsail/commands/GetCloudFormationStackRecordsCommand.ts b/clients/client-lightsail/commands/GetCloudFormationStackRecordsCommand.ts index 0bc87dcf2ad6..090cee9f07fd 100644 --- a/clients/client-lightsail/commands/GetCloudFormationStackRecordsCommand.ts +++ b/clients/client-lightsail/commands/GetCloudFormationStackRecordsCommand.ts @@ -27,6 +27,20 @@ export interface GetCloudFormationStackRecordsCommandOutput * formation stack operation.

*

An AWS CloudFormation stack is used to create a new Amazon EC2 instance from an exported Lightsail * snapshot.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { LightsailClient, GetCloudFormationStackRecordsCommand } from "@aws-sdk/client-lightsail"; // ES Modules import + * // const { LightsailClient, GetCloudFormationStackRecordsCommand } = require("@aws-sdk/client-lightsail"); // CommonJS import + * const client = new LightsailClient(config); + * const command = new GetCloudFormationStackRecordsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetCloudFormationStackRecordsCommandInput} for command's `input` shape. + * @see {@link GetCloudFormationStackRecordsCommandOutput} for command's `response` shape. + * @see {@link LightsailClientResolvedConfig | config} for command's `input` shape. + * */ export class GetCloudFormationStackRecordsCommand extends $Command< GetCloudFormationStackRecordsCommandInput, diff --git a/clients/client-lightsail/commands/GetContactMethodsCommand.ts b/clients/client-lightsail/commands/GetContactMethodsCommand.ts index ab6702f635f2..fcba685a9a4b 100644 --- a/clients/client-lightsail/commands/GetContactMethodsCommand.ts +++ b/clients/client-lightsail/commands/GetContactMethodsCommand.ts @@ -27,6 +27,20 @@ export interface GetContactMethodsCommandOutput extends GetContactMethodsResult, * You can add one email address and one mobile phone number contact method in each AWS Region. * However, SMS text messaging is not supported in some AWS Regions, and SMS text messages * cannot be sent to some countries/regions. For more information, see Notifications in Amazon Lightsail.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { LightsailClient, GetContactMethodsCommand } from "@aws-sdk/client-lightsail"; // ES Modules import + * // const { LightsailClient, GetContactMethodsCommand } = require("@aws-sdk/client-lightsail"); // CommonJS import + * const client = new LightsailClient(config); + * const command = new GetContactMethodsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetContactMethodsCommandInput} for command's `input` shape. + * @see {@link GetContactMethodsCommandOutput} for command's `response` shape. + * @see {@link LightsailClientResolvedConfig | config} for command's `input` shape. + * */ export class GetContactMethodsCommand extends $Command< GetContactMethodsCommandInput, diff --git a/clients/client-lightsail/commands/GetContainerAPIMetadataCommand.ts b/clients/client-lightsail/commands/GetContainerAPIMetadataCommand.ts index 2c12242d6072..131317ed3fab 100644 --- a/clients/client-lightsail/commands/GetContainerAPIMetadataCommand.ts +++ b/clients/client-lightsail/commands/GetContainerAPIMetadataCommand.ts @@ -23,6 +23,20 @@ export interface GetContainerAPIMetadataCommandOutput extends GetContainerAPIMet /** *

Returns information about Amazon Lightsail containers, such as the current version of the * Lightsail Control (lightsailctl) plugin.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { LightsailClient, GetContainerAPIMetadataCommand } from "@aws-sdk/client-lightsail"; // ES Modules import + * // const { LightsailClient, GetContainerAPIMetadataCommand } = require("@aws-sdk/client-lightsail"); // CommonJS import + * const client = new LightsailClient(config); + * const command = new GetContainerAPIMetadataCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetContainerAPIMetadataCommandInput} for command's `input` shape. + * @see {@link GetContainerAPIMetadataCommandOutput} for command's `response` shape. + * @see {@link LightsailClientResolvedConfig | config} for command's `input` shape. + * */ export class GetContainerAPIMetadataCommand extends $Command< GetContainerAPIMetadataCommandInput, diff --git a/clients/client-lightsail/commands/GetContainerImagesCommand.ts b/clients/client-lightsail/commands/GetContainerImagesCommand.ts index 8302cbe728f0..e70cb5beb622 100644 --- a/clients/client-lightsail/commands/GetContainerImagesCommand.ts +++ b/clients/client-lightsail/commands/GetContainerImagesCommand.ts @@ -29,6 +29,20 @@ export interface GetContainerImagesCommandOutput extends GetContainerImagesResul * 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.

* + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { LightsailClient, GetContainerImagesCommand } from "@aws-sdk/client-lightsail"; // ES Modules import + * // const { LightsailClient, GetContainerImagesCommand } = require("@aws-sdk/client-lightsail"); // CommonJS import + * const client = new LightsailClient(config); + * const command = new GetContainerImagesCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetContainerImagesCommandInput} for command's `input` shape. + * @see {@link GetContainerImagesCommandOutput} for command's `response` shape. + * @see {@link LightsailClientResolvedConfig | config} for command's `input` shape. + * */ export class GetContainerImagesCommand extends $Command< GetContainerImagesCommandInput, diff --git a/clients/client-lightsail/commands/GetContainerLogCommand.ts b/clients/client-lightsail/commands/GetContainerLogCommand.ts index 36cb9ff88013..05fba619cbea 100644 --- a/clients/client-lightsail/commands/GetContainerLogCommand.ts +++ b/clients/client-lightsail/commands/GetContainerLogCommand.ts @@ -32,6 +32,20 @@ export interface GetContainerLogCommandOutput extends GetContainerLogResult, __M * Amazon Lightsail * endpoints and quotas in the AWS General Reference.

* + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { LightsailClient, GetContainerLogCommand } from "@aws-sdk/client-lightsail"; // ES Modules import + * // const { LightsailClient, GetContainerLogCommand } = require("@aws-sdk/client-lightsail"); // CommonJS import + * const client = new LightsailClient(config); + * const command = new GetContainerLogCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetContainerLogCommandInput} for command's `input` shape. + * @see {@link GetContainerLogCommandOutput} for command's `response` shape. + * @see {@link LightsailClientResolvedConfig | config} for command's `input` shape. + * */ export class GetContainerLogCommand extends $Command< GetContainerLogCommandInput, diff --git a/clients/client-lightsail/commands/GetContainerServiceDeploymentsCommand.ts b/clients/client-lightsail/commands/GetContainerServiceDeploymentsCommand.ts index 90e8f13f09a1..7a48304e751f 100644 --- a/clients/client-lightsail/commands/GetContainerServiceDeploymentsCommand.ts +++ b/clients/client-lightsail/commands/GetContainerServiceDeploymentsCommand.ts @@ -36,6 +36,20 @@ export interface GetContainerServiceDeploymentsCommandOutput * one. For more information, see Amazon Lightsail * endpoints and quotas in the AWS General Reference.

* + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { LightsailClient, GetContainerServiceDeploymentsCommand } from "@aws-sdk/client-lightsail"; // ES Modules import + * // const { LightsailClient, GetContainerServiceDeploymentsCommand } = require("@aws-sdk/client-lightsail"); // CommonJS import + * const client = new LightsailClient(config); + * const command = new GetContainerServiceDeploymentsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetContainerServiceDeploymentsCommandInput} for command's `input` shape. + * @see {@link GetContainerServiceDeploymentsCommandOutput} for command's `response` shape. + * @see {@link LightsailClientResolvedConfig | config} for command's `input` shape. + * */ export class GetContainerServiceDeploymentsCommand extends $Command< GetContainerServiceDeploymentsCommandInput, diff --git a/clients/client-lightsail/commands/GetContainerServiceMetricDataCommand.ts b/clients/client-lightsail/commands/GetContainerServiceMetricDataCommand.ts index ebad5a22be9f..35ab1441cb51 100644 --- a/clients/client-lightsail/commands/GetContainerServiceMetricDataCommand.ts +++ b/clients/client-lightsail/commands/GetContainerServiceMetricDataCommand.ts @@ -28,6 +28,20 @@ export interface GetContainerServiceMetricDataCommandOutput * *

Metrics report the utilization of your resources. Monitor and collect metric data * regularly to maintain the reliability, availability, and performance of your resources.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { LightsailClient, GetContainerServiceMetricDataCommand } from "@aws-sdk/client-lightsail"; // ES Modules import + * // const { LightsailClient, GetContainerServiceMetricDataCommand } = require("@aws-sdk/client-lightsail"); // CommonJS import + * const client = new LightsailClient(config); + * const command = new GetContainerServiceMetricDataCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetContainerServiceMetricDataCommandInput} for command's `input` shape. + * @see {@link GetContainerServiceMetricDataCommandOutput} for command's `response` shape. + * @see {@link LightsailClientResolvedConfig | config} for command's `input` shape. + * */ export class GetContainerServiceMetricDataCommand extends $Command< GetContainerServiceMetricDataCommandInput, diff --git a/clients/client-lightsail/commands/GetContainerServicePowersCommand.ts b/clients/client-lightsail/commands/GetContainerServicePowersCommand.ts index 8bff9afe6c5b..a41dba8760b5 100644 --- a/clients/client-lightsail/commands/GetContainerServicePowersCommand.ts +++ b/clients/client-lightsail/commands/GetContainerServicePowersCommand.ts @@ -26,6 +26,20 @@ export interface GetContainerServicePowersCommandOutput extends GetContainerServ * *

The power specifies the amount of memory, the number of vCPUs, and the base price of the * container service.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { LightsailClient, GetContainerServicePowersCommand } from "@aws-sdk/client-lightsail"; // ES Modules import + * // const { LightsailClient, GetContainerServicePowersCommand } = require("@aws-sdk/client-lightsail"); // CommonJS import + * const client = new LightsailClient(config); + * const command = new GetContainerServicePowersCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetContainerServicePowersCommandInput} for command's `input` shape. + * @see {@link GetContainerServicePowersCommandOutput} for command's `response` shape. + * @see {@link LightsailClientResolvedConfig | config} for command's `input` shape. + * */ export class GetContainerServicePowersCommand extends $Command< GetContainerServicePowersCommandInput, diff --git a/clients/client-lightsail/commands/GetContainerServicesCommand.ts b/clients/client-lightsail/commands/GetContainerServicesCommand.ts index 60cc6b3744e8..5dead63bf272 100644 --- a/clients/client-lightsail/commands/GetContainerServicesCommand.ts +++ b/clients/client-lightsail/commands/GetContainerServicesCommand.ts @@ -22,6 +22,20 @@ export interface GetContainerServicesCommandOutput extends ContainerServicesList /** *

Returns information about one or more of your Amazon Lightsail container services.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { LightsailClient, GetContainerServicesCommand } from "@aws-sdk/client-lightsail"; // ES Modules import + * // const { LightsailClient, GetContainerServicesCommand } = require("@aws-sdk/client-lightsail"); // CommonJS import + * const client = new LightsailClient(config); + * const command = new GetContainerServicesCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetContainerServicesCommandInput} for command's `input` shape. + * @see {@link GetContainerServicesCommandOutput} for command's `response` shape. + * @see {@link LightsailClientResolvedConfig | config} for command's `input` shape. + * */ export class GetContainerServicesCommand extends $Command< GetContainerServicesCommandInput, diff --git a/clients/client-lightsail/commands/GetDiskCommand.ts b/clients/client-lightsail/commands/GetDiskCommand.ts index 4091c1e78639..f26d5894a11b 100644 --- a/clients/client-lightsail/commands/GetDiskCommand.ts +++ b/clients/client-lightsail/commands/GetDiskCommand.ts @@ -19,6 +19,20 @@ export interface GetDiskCommandOutput extends GetDiskResult, __MetadataBearer {} /** *

Returns information about a specific block storage disk.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { LightsailClient, GetDiskCommand } from "@aws-sdk/client-lightsail"; // ES Modules import + * // const { LightsailClient, GetDiskCommand } = require("@aws-sdk/client-lightsail"); // CommonJS import + * const client = new LightsailClient(config); + * const command = new GetDiskCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetDiskCommandInput} for command's `input` shape. + * @see {@link GetDiskCommandOutput} for command's `response` shape. + * @see {@link LightsailClientResolvedConfig | config} for command's `input` shape. + * */ export class GetDiskCommand extends $Command { // Start section: command_properties diff --git a/clients/client-lightsail/commands/GetDiskSnapshotCommand.ts b/clients/client-lightsail/commands/GetDiskSnapshotCommand.ts index 0b9fb8375f9d..1ecb05fe40a4 100644 --- a/clients/client-lightsail/commands/GetDiskSnapshotCommand.ts +++ b/clients/client-lightsail/commands/GetDiskSnapshotCommand.ts @@ -22,6 +22,20 @@ export interface GetDiskSnapshotCommandOutput extends GetDiskSnapshotResult, __M /** *

Returns information about a specific block storage disk snapshot.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { LightsailClient, GetDiskSnapshotCommand } from "@aws-sdk/client-lightsail"; // ES Modules import + * // const { LightsailClient, GetDiskSnapshotCommand } = require("@aws-sdk/client-lightsail"); // CommonJS import + * const client = new LightsailClient(config); + * const command = new GetDiskSnapshotCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetDiskSnapshotCommandInput} for command's `input` shape. + * @see {@link GetDiskSnapshotCommandOutput} for command's `response` shape. + * @see {@link LightsailClientResolvedConfig | config} for command's `input` shape. + * */ export class GetDiskSnapshotCommand extends $Command< GetDiskSnapshotCommandInput, diff --git a/clients/client-lightsail/commands/GetDiskSnapshotsCommand.ts b/clients/client-lightsail/commands/GetDiskSnapshotsCommand.ts index 1b4356a51b3e..64a782a36de8 100644 --- a/clients/client-lightsail/commands/GetDiskSnapshotsCommand.ts +++ b/clients/client-lightsail/commands/GetDiskSnapshotsCommand.ts @@ -23,6 +23,20 @@ export interface GetDiskSnapshotsCommandOutput extends GetDiskSnapshotsResult, _ /** *

Returns information about all block storage disk snapshots in your AWS account and * region.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { LightsailClient, GetDiskSnapshotsCommand } from "@aws-sdk/client-lightsail"; // ES Modules import + * // const { LightsailClient, GetDiskSnapshotsCommand } = require("@aws-sdk/client-lightsail"); // CommonJS import + * const client = new LightsailClient(config); + * const command = new GetDiskSnapshotsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetDiskSnapshotsCommandInput} for command's `input` shape. + * @see {@link GetDiskSnapshotsCommandOutput} for command's `response` shape. + * @see {@link LightsailClientResolvedConfig | config} for command's `input` shape. + * */ export class GetDiskSnapshotsCommand extends $Command< GetDiskSnapshotsCommandInput, diff --git a/clients/client-lightsail/commands/GetDisksCommand.ts b/clients/client-lightsail/commands/GetDisksCommand.ts index 7dec13cc4dd4..28bcbf517980 100644 --- a/clients/client-lightsail/commands/GetDisksCommand.ts +++ b/clients/client-lightsail/commands/GetDisksCommand.ts @@ -19,6 +19,20 @@ export interface GetDisksCommandOutput extends GetDisksResult, __MetadataBearer /** *

Returns information about all block storage disks in your AWS account and region.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { LightsailClient, GetDisksCommand } from "@aws-sdk/client-lightsail"; // ES Modules import + * // const { LightsailClient, GetDisksCommand } = require("@aws-sdk/client-lightsail"); // CommonJS import + * const client = new LightsailClient(config); + * const command = new GetDisksCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetDisksCommandInput} for command's `input` shape. + * @see {@link GetDisksCommandOutput} for command's `response` shape. + * @see {@link LightsailClientResolvedConfig | config} for command's `input` shape. + * */ export class GetDisksCommand extends $Command< GetDisksCommandInput, diff --git a/clients/client-lightsail/commands/GetDistributionBundlesCommand.ts b/clients/client-lightsail/commands/GetDistributionBundlesCommand.ts index 28fa812bcc06..814a5e1c9d07 100644 --- a/clients/client-lightsail/commands/GetDistributionBundlesCommand.ts +++ b/clients/client-lightsail/commands/GetDistributionBundlesCommand.ts @@ -25,6 +25,20 @@ export interface GetDistributionBundlesCommandOutput extends GetDistributionBund * network (CDN) distributions.

*

A distribution bundle specifies the monthly network transfer quota and monthly cost of * your dsitribution.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { LightsailClient, GetDistributionBundlesCommand } from "@aws-sdk/client-lightsail"; // ES Modules import + * // const { LightsailClient, GetDistributionBundlesCommand } = require("@aws-sdk/client-lightsail"); // CommonJS import + * const client = new LightsailClient(config); + * const command = new GetDistributionBundlesCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetDistributionBundlesCommandInput} for command's `input` shape. + * @see {@link GetDistributionBundlesCommandOutput} for command's `response` shape. + * @see {@link LightsailClientResolvedConfig | config} for command's `input` shape. + * */ export class GetDistributionBundlesCommand extends $Command< GetDistributionBundlesCommandInput, diff --git a/clients/client-lightsail/commands/GetDistributionLatestCacheResetCommand.ts b/clients/client-lightsail/commands/GetDistributionLatestCacheResetCommand.ts index 8676d391d484..e7b060f0e447 100644 --- a/clients/client-lightsail/commands/GetDistributionLatestCacheResetCommand.ts +++ b/clients/client-lightsail/commands/GetDistributionLatestCacheResetCommand.ts @@ -25,6 +25,20 @@ export interface GetDistributionLatestCacheResetCommandOutput /** *

Returns the timestamp and status of the last cache reset of a specific Amazon Lightsail * content delivery network (CDN) distribution.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { LightsailClient, GetDistributionLatestCacheResetCommand } from "@aws-sdk/client-lightsail"; // ES Modules import + * // const { LightsailClient, GetDistributionLatestCacheResetCommand } = require("@aws-sdk/client-lightsail"); // CommonJS import + * const client = new LightsailClient(config); + * const command = new GetDistributionLatestCacheResetCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetDistributionLatestCacheResetCommandInput} for command's `input` shape. + * @see {@link GetDistributionLatestCacheResetCommandOutput} for command's `response` shape. + * @see {@link LightsailClientResolvedConfig | config} for command's `input` shape. + * */ export class GetDistributionLatestCacheResetCommand extends $Command< GetDistributionLatestCacheResetCommandInput, diff --git a/clients/client-lightsail/commands/GetDistributionMetricDataCommand.ts b/clients/client-lightsail/commands/GetDistributionMetricDataCommand.ts index 107c4bb3e4c6..bce74837eb36 100644 --- a/clients/client-lightsail/commands/GetDistributionMetricDataCommand.ts +++ b/clients/client-lightsail/commands/GetDistributionMetricDataCommand.ts @@ -26,6 +26,20 @@ export interface GetDistributionMetricDataCommandOutput extends GetDistributionM *

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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { LightsailClient, GetDistributionMetricDataCommand } from "@aws-sdk/client-lightsail"; // ES Modules import + * // const { LightsailClient, GetDistributionMetricDataCommand } = require("@aws-sdk/client-lightsail"); // CommonJS import + * const client = new LightsailClient(config); + * const command = new GetDistributionMetricDataCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetDistributionMetricDataCommandInput} for command's `input` shape. + * @see {@link GetDistributionMetricDataCommandOutput} for command's `response` shape. + * @see {@link LightsailClientResolvedConfig | config} for command's `input` shape. + * */ export class GetDistributionMetricDataCommand extends $Command< GetDistributionMetricDataCommandInput, diff --git a/clients/client-lightsail/commands/GetDistributionsCommand.ts b/clients/client-lightsail/commands/GetDistributionsCommand.ts index 41ee8c67d03b..bf1cf1d89b65 100644 --- a/clients/client-lightsail/commands/GetDistributionsCommand.ts +++ b/clients/client-lightsail/commands/GetDistributionsCommand.ts @@ -23,6 +23,20 @@ export interface GetDistributionsCommandOutput extends GetDistributionsResult, _ /** *

Returns information about one or more of your Amazon Lightsail content delivery network * (CDN) distributions.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { LightsailClient, GetDistributionsCommand } from "@aws-sdk/client-lightsail"; // ES Modules import + * // const { LightsailClient, GetDistributionsCommand } = require("@aws-sdk/client-lightsail"); // CommonJS import + * const client = new LightsailClient(config); + * const command = new GetDistributionsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetDistributionsCommandInput} for command's `input` shape. + * @see {@link GetDistributionsCommandOutput} for command's `response` shape. + * @see {@link LightsailClientResolvedConfig | config} for command's `input` shape. + * */ export class GetDistributionsCommand extends $Command< GetDistributionsCommandInput, diff --git a/clients/client-lightsail/commands/GetDomainCommand.ts b/clients/client-lightsail/commands/GetDomainCommand.ts index ba28341c92ec..30bafd05b573 100644 --- a/clients/client-lightsail/commands/GetDomainCommand.ts +++ b/clients/client-lightsail/commands/GetDomainCommand.ts @@ -19,6 +19,20 @@ export interface GetDomainCommandOutput extends GetDomainResult, __MetadataBeare /** *

Returns information about a specific domain recordset.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { LightsailClient, GetDomainCommand } from "@aws-sdk/client-lightsail"; // ES Modules import + * // const { LightsailClient, GetDomainCommand } = require("@aws-sdk/client-lightsail"); // CommonJS import + * const client = new LightsailClient(config); + * const command = new GetDomainCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetDomainCommandInput} for command's `input` shape. + * @see {@link GetDomainCommandOutput} for command's `response` shape. + * @see {@link LightsailClientResolvedConfig | config} for command's `input` shape. + * */ export class GetDomainCommand extends $Command< GetDomainCommandInput, diff --git a/clients/client-lightsail/commands/GetDomainsCommand.ts b/clients/client-lightsail/commands/GetDomainsCommand.ts index 74a6bba44254..c8d63de45e97 100644 --- a/clients/client-lightsail/commands/GetDomainsCommand.ts +++ b/clients/client-lightsail/commands/GetDomainsCommand.ts @@ -22,6 +22,20 @@ export interface GetDomainsCommandOutput extends GetDomainsResult, __MetadataBea /** *

Returns a list of all domains in the user's account.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { LightsailClient, GetDomainsCommand } from "@aws-sdk/client-lightsail"; // ES Modules import + * // const { LightsailClient, GetDomainsCommand } = require("@aws-sdk/client-lightsail"); // CommonJS import + * const client = new LightsailClient(config); + * const command = new GetDomainsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetDomainsCommandInput} for command's `input` shape. + * @see {@link GetDomainsCommandOutput} for command's `response` shape. + * @see {@link LightsailClientResolvedConfig | config} for command's `input` shape. + * */ export class GetDomainsCommand extends $Command< GetDomainsCommandInput, diff --git a/clients/client-lightsail/commands/GetExportSnapshotRecordsCommand.ts b/clients/client-lightsail/commands/GetExportSnapshotRecordsCommand.ts index 214b16a92aad..99cb97629471 100644 --- a/clients/client-lightsail/commands/GetExportSnapshotRecordsCommand.ts +++ b/clients/client-lightsail/commands/GetExportSnapshotRecordsCommand.ts @@ -25,6 +25,20 @@ export interface GetExportSnapshotRecordsCommandOutput extends GetExportSnapshot * operation.

*

An export snapshot record can be used to create a new Amazon EC2 instance and its related * resources with the create cloud formation stack operation.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { LightsailClient, GetExportSnapshotRecordsCommand } from "@aws-sdk/client-lightsail"; // ES Modules import + * // const { LightsailClient, GetExportSnapshotRecordsCommand } = require("@aws-sdk/client-lightsail"); // CommonJS import + * const client = new LightsailClient(config); + * const command = new GetExportSnapshotRecordsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetExportSnapshotRecordsCommandInput} for command's `input` shape. + * @see {@link GetExportSnapshotRecordsCommandOutput} for command's `response` shape. + * @see {@link LightsailClientResolvedConfig | config} for command's `input` shape. + * */ export class GetExportSnapshotRecordsCommand extends $Command< GetExportSnapshotRecordsCommandInput, diff --git a/clients/client-lightsail/commands/GetInstanceAccessDetailsCommand.ts b/clients/client-lightsail/commands/GetInstanceAccessDetailsCommand.ts index dfdab9a53a59..a8f2a3c8c089 100644 --- a/clients/client-lightsail/commands/GetInstanceAccessDetailsCommand.ts +++ b/clients/client-lightsail/commands/GetInstanceAccessDetailsCommand.ts @@ -26,6 +26,20 @@ export interface GetInstanceAccessDetailsCommandOutput extends GetInstanceAccess *

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 Lightsail Dev Guide.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { LightsailClient, GetInstanceAccessDetailsCommand } from "@aws-sdk/client-lightsail"; // ES Modules import + * // const { LightsailClient, GetInstanceAccessDetailsCommand } = require("@aws-sdk/client-lightsail"); // CommonJS import + * const client = new LightsailClient(config); + * const command = new GetInstanceAccessDetailsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetInstanceAccessDetailsCommandInput} for command's `input` shape. + * @see {@link GetInstanceAccessDetailsCommandOutput} for command's `response` shape. + * @see {@link LightsailClientResolvedConfig | config} for command's `input` shape. + * */ export class GetInstanceAccessDetailsCommand extends $Command< GetInstanceAccessDetailsCommandInput, diff --git a/clients/client-lightsail/commands/GetInstanceCommand.ts b/clients/client-lightsail/commands/GetInstanceCommand.ts index 824be4cae35e..d56c43e2700c 100644 --- a/clients/client-lightsail/commands/GetInstanceCommand.ts +++ b/clients/client-lightsail/commands/GetInstanceCommand.ts @@ -23,6 +23,20 @@ export interface GetInstanceCommandOutput extends GetInstanceResult, __MetadataB /** *

Returns information about a specific Amazon Lightsail instance, which is a virtual private * server.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { LightsailClient, GetInstanceCommand } from "@aws-sdk/client-lightsail"; // ES Modules import + * // const { LightsailClient, GetInstanceCommand } = require("@aws-sdk/client-lightsail"); // CommonJS import + * const client = new LightsailClient(config); + * const command = new GetInstanceCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetInstanceCommandInput} for command's `input` shape. + * @see {@link GetInstanceCommandOutput} for command's `response` shape. + * @see {@link LightsailClientResolvedConfig | config} for command's `input` shape. + * */ export class GetInstanceCommand extends $Command< GetInstanceCommandInput, diff --git a/clients/client-lightsail/commands/GetInstanceMetricDataCommand.ts b/clients/client-lightsail/commands/GetInstanceMetricDataCommand.ts index 8d6522b9d90c..7233699a421e 100644 --- a/clients/client-lightsail/commands/GetInstanceMetricDataCommand.ts +++ b/clients/client-lightsail/commands/GetInstanceMetricDataCommand.ts @@ -26,6 +26,20 @@ export interface GetInstanceMetricDataCommandOutput extends GetInstanceMetricDat *

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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { LightsailClient, GetInstanceMetricDataCommand } from "@aws-sdk/client-lightsail"; // ES Modules import + * // const { LightsailClient, GetInstanceMetricDataCommand } = require("@aws-sdk/client-lightsail"); // CommonJS import + * const client = new LightsailClient(config); + * const command = new GetInstanceMetricDataCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetInstanceMetricDataCommandInput} for command's `input` shape. + * @see {@link GetInstanceMetricDataCommandOutput} for command's `response` shape. + * @see {@link LightsailClientResolvedConfig | config} for command's `input` shape. + * */ export class GetInstanceMetricDataCommand extends $Command< GetInstanceMetricDataCommandInput, diff --git a/clients/client-lightsail/commands/GetInstancePortStatesCommand.ts b/clients/client-lightsail/commands/GetInstancePortStatesCommand.ts index 09d77e33b600..179dd9da3d22 100644 --- a/clients/client-lightsail/commands/GetInstancePortStatesCommand.ts +++ b/clients/client-lightsail/commands/GetInstancePortStatesCommand.ts @@ -23,6 +23,20 @@ export interface GetInstancePortStatesCommandOutput extends GetInstancePortState /** *

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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { LightsailClient, GetInstancePortStatesCommand } from "@aws-sdk/client-lightsail"; // ES Modules import + * // const { LightsailClient, GetInstancePortStatesCommand } = require("@aws-sdk/client-lightsail"); // CommonJS import + * const client = new LightsailClient(config); + * const command = new GetInstancePortStatesCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetInstancePortStatesCommandInput} for command's `input` shape. + * @see {@link GetInstancePortStatesCommandOutput} for command's `response` shape. + * @see {@link LightsailClientResolvedConfig | config} for command's `input` shape. + * */ export class GetInstancePortStatesCommand extends $Command< GetInstancePortStatesCommandInput, diff --git a/clients/client-lightsail/commands/GetInstanceSnapshotCommand.ts b/clients/client-lightsail/commands/GetInstanceSnapshotCommand.ts index d998b8c204e8..1c0ac2fbc09d 100644 --- a/clients/client-lightsail/commands/GetInstanceSnapshotCommand.ts +++ b/clients/client-lightsail/commands/GetInstanceSnapshotCommand.ts @@ -22,6 +22,20 @@ export interface GetInstanceSnapshotCommandOutput extends GetInstanceSnapshotRes /** *

Returns information about a specific instance snapshot.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { LightsailClient, GetInstanceSnapshotCommand } from "@aws-sdk/client-lightsail"; // ES Modules import + * // const { LightsailClient, GetInstanceSnapshotCommand } = require("@aws-sdk/client-lightsail"); // CommonJS import + * const client = new LightsailClient(config); + * const command = new GetInstanceSnapshotCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetInstanceSnapshotCommandInput} for command's `input` shape. + * @see {@link GetInstanceSnapshotCommandOutput} for command's `response` shape. + * @see {@link LightsailClientResolvedConfig | config} for command's `input` shape. + * */ export class GetInstanceSnapshotCommand extends $Command< GetInstanceSnapshotCommandInput, diff --git a/clients/client-lightsail/commands/GetInstanceSnapshotsCommand.ts b/clients/client-lightsail/commands/GetInstanceSnapshotsCommand.ts index 269f45d37219..90e6f920d664 100644 --- a/clients/client-lightsail/commands/GetInstanceSnapshotsCommand.ts +++ b/clients/client-lightsail/commands/GetInstanceSnapshotsCommand.ts @@ -22,6 +22,20 @@ export interface GetInstanceSnapshotsCommandOutput extends GetInstanceSnapshotsR /** *

Returns all instance snapshots for the user's account.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { LightsailClient, GetInstanceSnapshotsCommand } from "@aws-sdk/client-lightsail"; // ES Modules import + * // const { LightsailClient, GetInstanceSnapshotsCommand } = require("@aws-sdk/client-lightsail"); // CommonJS import + * const client = new LightsailClient(config); + * const command = new GetInstanceSnapshotsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetInstanceSnapshotsCommandInput} for command's `input` shape. + * @see {@link GetInstanceSnapshotsCommandOutput} for command's `response` shape. + * @see {@link LightsailClientResolvedConfig | config} for command's `input` shape. + * */ export class GetInstanceSnapshotsCommand extends $Command< GetInstanceSnapshotsCommandInput, diff --git a/clients/client-lightsail/commands/GetInstanceStateCommand.ts b/clients/client-lightsail/commands/GetInstanceStateCommand.ts index 2909f89d9314..e54bd1fb4d33 100644 --- a/clients/client-lightsail/commands/GetInstanceStateCommand.ts +++ b/clients/client-lightsail/commands/GetInstanceStateCommand.ts @@ -22,6 +22,20 @@ export interface GetInstanceStateCommandOutput extends GetInstanceStateResult, _ /** *

Returns the state of a specific instance. Works on one instance at a time.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { LightsailClient, GetInstanceStateCommand } from "@aws-sdk/client-lightsail"; // ES Modules import + * // const { LightsailClient, GetInstanceStateCommand } = require("@aws-sdk/client-lightsail"); // CommonJS import + * const client = new LightsailClient(config); + * const command = new GetInstanceStateCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetInstanceStateCommandInput} for command's `input` shape. + * @see {@link GetInstanceStateCommandOutput} for command's `response` shape. + * @see {@link LightsailClientResolvedConfig | config} for command's `input` shape. + * */ export class GetInstanceStateCommand extends $Command< GetInstanceStateCommandInput, diff --git a/clients/client-lightsail/commands/GetInstancesCommand.ts b/clients/client-lightsail/commands/GetInstancesCommand.ts index fdfdcbe242b5..66be49a30a4b 100644 --- a/clients/client-lightsail/commands/GetInstancesCommand.ts +++ b/clients/client-lightsail/commands/GetInstancesCommand.ts @@ -23,6 +23,20 @@ export interface GetInstancesCommandOutput extends GetInstancesResult, __Metadat /** *

Returns information about all Amazon Lightsail virtual private servers, or * instances.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { LightsailClient, GetInstancesCommand } from "@aws-sdk/client-lightsail"; // ES Modules import + * // const { LightsailClient, GetInstancesCommand } = require("@aws-sdk/client-lightsail"); // CommonJS import + * const client = new LightsailClient(config); + * const command = new GetInstancesCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetInstancesCommandInput} for command's `input` shape. + * @see {@link GetInstancesCommandOutput} for command's `response` shape. + * @see {@link LightsailClientResolvedConfig | config} for command's `input` shape. + * */ export class GetInstancesCommand extends $Command< GetInstancesCommandInput, diff --git a/clients/client-lightsail/commands/GetKeyPairCommand.ts b/clients/client-lightsail/commands/GetKeyPairCommand.ts index f774baf1fddf..d577a3663d24 100644 --- a/clients/client-lightsail/commands/GetKeyPairCommand.ts +++ b/clients/client-lightsail/commands/GetKeyPairCommand.ts @@ -22,6 +22,20 @@ export interface GetKeyPairCommandOutput extends GetKeyPairResult, __MetadataBea /** *

Returns information about a specific key pair.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { LightsailClient, GetKeyPairCommand } from "@aws-sdk/client-lightsail"; // ES Modules import + * // const { LightsailClient, GetKeyPairCommand } = require("@aws-sdk/client-lightsail"); // CommonJS import + * const client = new LightsailClient(config); + * const command = new GetKeyPairCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetKeyPairCommandInput} for command's `input` shape. + * @see {@link GetKeyPairCommandOutput} for command's `response` shape. + * @see {@link LightsailClientResolvedConfig | config} for command's `input` shape. + * */ export class GetKeyPairCommand extends $Command< GetKeyPairCommandInput, diff --git a/clients/client-lightsail/commands/GetKeyPairsCommand.ts b/clients/client-lightsail/commands/GetKeyPairsCommand.ts index 0934bef33605..a6745a4c1d78 100644 --- a/clients/client-lightsail/commands/GetKeyPairsCommand.ts +++ b/clients/client-lightsail/commands/GetKeyPairsCommand.ts @@ -22,6 +22,20 @@ export interface GetKeyPairsCommandOutput extends GetKeyPairsResult, __MetadataB /** *

Returns information about all key pairs in the user's account.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { LightsailClient, GetKeyPairsCommand } from "@aws-sdk/client-lightsail"; // ES Modules import + * // const { LightsailClient, GetKeyPairsCommand } = require("@aws-sdk/client-lightsail"); // CommonJS import + * const client = new LightsailClient(config); + * const command = new GetKeyPairsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetKeyPairsCommandInput} for command's `input` shape. + * @see {@link GetKeyPairsCommandOutput} for command's `response` shape. + * @see {@link LightsailClientResolvedConfig | config} for command's `input` shape. + * */ export class GetKeyPairsCommand extends $Command< GetKeyPairsCommandInput, diff --git a/clients/client-lightsail/commands/GetLoadBalancerCommand.ts b/clients/client-lightsail/commands/GetLoadBalancerCommand.ts index 3dc422f67d58..3fbe0ade04dc 100644 --- a/clients/client-lightsail/commands/GetLoadBalancerCommand.ts +++ b/clients/client-lightsail/commands/GetLoadBalancerCommand.ts @@ -22,6 +22,20 @@ export interface GetLoadBalancerCommandOutput extends GetLoadBalancerResult, __M /** *

Returns information about the specified Lightsail load balancer.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { LightsailClient, GetLoadBalancerCommand } from "@aws-sdk/client-lightsail"; // ES Modules import + * // const { LightsailClient, GetLoadBalancerCommand } = require("@aws-sdk/client-lightsail"); // CommonJS import + * const client = new LightsailClient(config); + * const command = new GetLoadBalancerCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetLoadBalancerCommandInput} for command's `input` shape. + * @see {@link GetLoadBalancerCommandOutput} for command's `response` shape. + * @see {@link LightsailClientResolvedConfig | config} for command's `input` shape. + * */ export class GetLoadBalancerCommand extends $Command< GetLoadBalancerCommandInput, diff --git a/clients/client-lightsail/commands/GetLoadBalancerMetricDataCommand.ts b/clients/client-lightsail/commands/GetLoadBalancerMetricDataCommand.ts index 359101f5d63c..d79b57712d54 100644 --- a/clients/client-lightsail/commands/GetLoadBalancerMetricDataCommand.ts +++ b/clients/client-lightsail/commands/GetLoadBalancerMetricDataCommand.ts @@ -25,6 +25,20 @@ export interface GetLoadBalancerMetricDataCommandOutput extends GetLoadBalancerM *

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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { LightsailClient, GetLoadBalancerMetricDataCommand } from "@aws-sdk/client-lightsail"; // ES Modules import + * // const { LightsailClient, GetLoadBalancerMetricDataCommand } = require("@aws-sdk/client-lightsail"); // CommonJS import + * const client = new LightsailClient(config); + * const command = new GetLoadBalancerMetricDataCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetLoadBalancerMetricDataCommandInput} for command's `input` shape. + * @see {@link GetLoadBalancerMetricDataCommandOutput} for command's `response` shape. + * @see {@link LightsailClientResolvedConfig | config} for command's `input` shape. + * */ export class GetLoadBalancerMetricDataCommand extends $Command< GetLoadBalancerMetricDataCommandInput, diff --git a/clients/client-lightsail/commands/GetLoadBalancerTlsCertificatesCommand.ts b/clients/client-lightsail/commands/GetLoadBalancerTlsCertificatesCommand.ts index 2d4222d2d6e5..7315c0d248c8 100644 --- a/clients/client-lightsail/commands/GetLoadBalancerTlsCertificatesCommand.ts +++ b/clients/client-lightsail/commands/GetLoadBalancerTlsCertificatesCommand.ts @@ -28,6 +28,20 @@ export interface GetLoadBalancerTlsCertificatesCommandOutput *

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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { LightsailClient, GetLoadBalancerTlsCertificatesCommand } from "@aws-sdk/client-lightsail"; // ES Modules import + * // const { LightsailClient, GetLoadBalancerTlsCertificatesCommand } = require("@aws-sdk/client-lightsail"); // CommonJS import + * const client = new LightsailClient(config); + * const command = new GetLoadBalancerTlsCertificatesCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetLoadBalancerTlsCertificatesCommandInput} for command's `input` shape. + * @see {@link GetLoadBalancerTlsCertificatesCommandOutput} for command's `response` shape. + * @see {@link LightsailClientResolvedConfig | config} for command's `input` shape. + * */ export class GetLoadBalancerTlsCertificatesCommand extends $Command< GetLoadBalancerTlsCertificatesCommandInput, diff --git a/clients/client-lightsail/commands/GetLoadBalancersCommand.ts b/clients/client-lightsail/commands/GetLoadBalancersCommand.ts index 2ef3189e29da..965674d79fe2 100644 --- a/clients/client-lightsail/commands/GetLoadBalancersCommand.ts +++ b/clients/client-lightsail/commands/GetLoadBalancersCommand.ts @@ -22,6 +22,20 @@ export interface GetLoadBalancersCommandOutput extends GetLoadBalancersResult, _ /** *

Returns information about all load balancers in an account.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { LightsailClient, GetLoadBalancersCommand } from "@aws-sdk/client-lightsail"; // ES Modules import + * // const { LightsailClient, GetLoadBalancersCommand } = require("@aws-sdk/client-lightsail"); // CommonJS import + * const client = new LightsailClient(config); + * const command = new GetLoadBalancersCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetLoadBalancersCommandInput} for command's `input` shape. + * @see {@link GetLoadBalancersCommandOutput} for command's `response` shape. + * @see {@link LightsailClientResolvedConfig | config} for command's `input` shape. + * */ export class GetLoadBalancersCommand extends $Command< GetLoadBalancersCommandInput, diff --git a/clients/client-lightsail/commands/GetOperationCommand.ts b/clients/client-lightsail/commands/GetOperationCommand.ts index 5e09deb577b7..9d57c3485b80 100644 --- a/clients/client-lightsail/commands/GetOperationCommand.ts +++ b/clients/client-lightsail/commands/GetOperationCommand.ts @@ -23,6 +23,20 @@ export interface GetOperationCommandOutput extends GetOperationResult, __Metadat /** *

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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { LightsailClient, GetOperationCommand } from "@aws-sdk/client-lightsail"; // ES Modules import + * // const { LightsailClient, GetOperationCommand } = require("@aws-sdk/client-lightsail"); // CommonJS import + * const client = new LightsailClient(config); + * const command = new GetOperationCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetOperationCommandInput} for command's `input` shape. + * @see {@link GetOperationCommandOutput} for command's `response` shape. + * @see {@link LightsailClientResolvedConfig | config} for command's `input` shape. + * */ export class GetOperationCommand extends $Command< GetOperationCommandInput, diff --git a/clients/client-lightsail/commands/GetOperationsCommand.ts b/clients/client-lightsail/commands/GetOperationsCommand.ts index 83cd7748e746..2b57949e93ce 100644 --- a/clients/client-lightsail/commands/GetOperationsCommand.ts +++ b/clients/client-lightsail/commands/GetOperationsCommand.ts @@ -25,6 +25,20 @@ export interface GetOperationsCommandOutput extends GetOperationsResult, __Metad *

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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { LightsailClient, GetOperationsCommand } from "@aws-sdk/client-lightsail"; // ES Modules import + * // const { LightsailClient, GetOperationsCommand } = require("@aws-sdk/client-lightsail"); // CommonJS import + * const client = new LightsailClient(config); + * const command = new GetOperationsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetOperationsCommandInput} for command's `input` shape. + * @see {@link GetOperationsCommandOutput} for command's `response` shape. + * @see {@link LightsailClientResolvedConfig | config} for command's `input` shape. + * */ export class GetOperationsCommand extends $Command< GetOperationsCommandInput, diff --git a/clients/client-lightsail/commands/GetOperationsForResourceCommand.ts b/clients/client-lightsail/commands/GetOperationsForResourceCommand.ts index ebee06693e2a..c205d3316777 100644 --- a/clients/client-lightsail/commands/GetOperationsForResourceCommand.ts +++ b/clients/client-lightsail/commands/GetOperationsForResourceCommand.ts @@ -22,6 +22,20 @@ export interface GetOperationsForResourceCommandOutput extends GetOperationsForR /** *

Gets operations for a specific resource (e.g., an instance or a static IP).

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { LightsailClient, GetOperationsForResourceCommand } from "@aws-sdk/client-lightsail"; // ES Modules import + * // const { LightsailClient, GetOperationsForResourceCommand } = require("@aws-sdk/client-lightsail"); // CommonJS import + * const client = new LightsailClient(config); + * const command = new GetOperationsForResourceCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetOperationsForResourceCommandInput} for command's `input` shape. + * @see {@link GetOperationsForResourceCommandOutput} for command's `response` shape. + * @see {@link LightsailClientResolvedConfig | config} for command's `input` shape. + * */ export class GetOperationsForResourceCommand extends $Command< GetOperationsForResourceCommandInput, diff --git a/clients/client-lightsail/commands/GetRegionsCommand.ts b/clients/client-lightsail/commands/GetRegionsCommand.ts index 0f31e422b1e1..60c0010b1a3f 100644 --- a/clients/client-lightsail/commands/GetRegionsCommand.ts +++ b/clients/client-lightsail/commands/GetRegionsCommand.ts @@ -24,6 +24,20 @@ export interface GetRegionsCommandOutput extends GetRegionsResult, __MetadataBea *

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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { LightsailClient, GetRegionsCommand } from "@aws-sdk/client-lightsail"; // ES Modules import + * // const { LightsailClient, GetRegionsCommand } = require("@aws-sdk/client-lightsail"); // CommonJS import + * const client = new LightsailClient(config); + * const command = new GetRegionsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetRegionsCommandInput} for command's `input` shape. + * @see {@link GetRegionsCommandOutput} for command's `response` shape. + * @see {@link LightsailClientResolvedConfig | config} for command's `input` shape. + * */ export class GetRegionsCommand extends $Command< GetRegionsCommandInput, diff --git a/clients/client-lightsail/commands/GetRelationalDatabaseBlueprintsCommand.ts b/clients/client-lightsail/commands/GetRelationalDatabaseBlueprintsCommand.ts index c78c616cea36..a87476a5ada3 100644 --- a/clients/client-lightsail/commands/GetRelationalDatabaseBlueprintsCommand.ts +++ b/clients/client-lightsail/commands/GetRelationalDatabaseBlueprintsCommand.ts @@ -27,6 +27,20 @@ export interface GetRelationalDatabaseBlueprintsCommandOutput * the major engine version of a database.

*

You can use a blueprint ID to create a new database that runs a specific database * engine.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { LightsailClient, GetRelationalDatabaseBlueprintsCommand } from "@aws-sdk/client-lightsail"; // ES Modules import + * // const { LightsailClient, GetRelationalDatabaseBlueprintsCommand } = require("@aws-sdk/client-lightsail"); // CommonJS import + * const client = new LightsailClient(config); + * const command = new GetRelationalDatabaseBlueprintsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetRelationalDatabaseBlueprintsCommandInput} for command's `input` shape. + * @see {@link GetRelationalDatabaseBlueprintsCommandOutput} for command's `response` shape. + * @see {@link LightsailClientResolvedConfig | config} for command's `input` shape. + * */ export class GetRelationalDatabaseBlueprintsCommand extends $Command< GetRelationalDatabaseBlueprintsCommandInput, diff --git a/clients/client-lightsail/commands/GetRelationalDatabaseBundlesCommand.ts b/clients/client-lightsail/commands/GetRelationalDatabaseBundlesCommand.ts index e93d0fbb3679..8343ec652cc8 100644 --- a/clients/client-lightsail/commands/GetRelationalDatabaseBundlesCommand.ts +++ b/clients/client-lightsail/commands/GetRelationalDatabaseBundlesCommand.ts @@ -27,6 +27,20 @@ export interface GetRelationalDatabaseBundlesCommandOutput * performance specifications for a database.

*

You can use a bundle ID to create a new database with explicit performance * specifications.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { LightsailClient, GetRelationalDatabaseBundlesCommand } from "@aws-sdk/client-lightsail"; // ES Modules import + * // const { LightsailClient, GetRelationalDatabaseBundlesCommand } = require("@aws-sdk/client-lightsail"); // CommonJS import + * const client = new LightsailClient(config); + * const command = new GetRelationalDatabaseBundlesCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetRelationalDatabaseBundlesCommandInput} for command's `input` shape. + * @see {@link GetRelationalDatabaseBundlesCommandOutput} for command's `response` shape. + * @see {@link LightsailClientResolvedConfig | config} for command's `input` shape. + * */ export class GetRelationalDatabaseBundlesCommand extends $Command< GetRelationalDatabaseBundlesCommandInput, diff --git a/clients/client-lightsail/commands/GetRelationalDatabaseCommand.ts b/clients/client-lightsail/commands/GetRelationalDatabaseCommand.ts index 3c281cede9d6..b0d1a692daa4 100644 --- a/clients/client-lightsail/commands/GetRelationalDatabaseCommand.ts +++ b/clients/client-lightsail/commands/GetRelationalDatabaseCommand.ts @@ -22,6 +22,20 @@ export interface GetRelationalDatabaseCommandOutput extends GetRelationalDatabas /** *

Returns information about a specific database in Amazon Lightsail.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { LightsailClient, GetRelationalDatabaseCommand } from "@aws-sdk/client-lightsail"; // ES Modules import + * // const { LightsailClient, GetRelationalDatabaseCommand } = require("@aws-sdk/client-lightsail"); // CommonJS import + * const client = new LightsailClient(config); + * const command = new GetRelationalDatabaseCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetRelationalDatabaseCommandInput} for command's `input` shape. + * @see {@link GetRelationalDatabaseCommandOutput} for command's `response` shape. + * @see {@link LightsailClientResolvedConfig | config} for command's `input` shape. + * */ export class GetRelationalDatabaseCommand extends $Command< GetRelationalDatabaseCommandInput, diff --git a/clients/client-lightsail/commands/GetRelationalDatabaseEventsCommand.ts b/clients/client-lightsail/commands/GetRelationalDatabaseEventsCommand.ts index 45c7460cfcda..c8b50c823d0c 100644 --- a/clients/client-lightsail/commands/GetRelationalDatabaseEventsCommand.ts +++ b/clients/client-lightsail/commands/GetRelationalDatabaseEventsCommand.ts @@ -22,6 +22,20 @@ export interface GetRelationalDatabaseEventsCommandOutput extends GetRelationalD /** *

Returns a list of events for a specific database in Amazon Lightsail.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { LightsailClient, GetRelationalDatabaseEventsCommand } from "@aws-sdk/client-lightsail"; // ES Modules import + * // const { LightsailClient, GetRelationalDatabaseEventsCommand } = require("@aws-sdk/client-lightsail"); // CommonJS import + * const client = new LightsailClient(config); + * const command = new GetRelationalDatabaseEventsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetRelationalDatabaseEventsCommandInput} for command's `input` shape. + * @see {@link GetRelationalDatabaseEventsCommandOutput} for command's `response` shape. + * @see {@link LightsailClientResolvedConfig | config} for command's `input` shape. + * */ export class GetRelationalDatabaseEventsCommand extends $Command< GetRelationalDatabaseEventsCommandInput, diff --git a/clients/client-lightsail/commands/GetRelationalDatabaseLogEventsCommand.ts b/clients/client-lightsail/commands/GetRelationalDatabaseLogEventsCommand.ts index 85582305b657..cb0af196db4b 100644 --- a/clients/client-lightsail/commands/GetRelationalDatabaseLogEventsCommand.ts +++ b/clients/client-lightsail/commands/GetRelationalDatabaseLogEventsCommand.ts @@ -24,6 +24,20 @@ export interface GetRelationalDatabaseLogEventsCommandOutput /** *

Returns a list of log events for a database in Amazon Lightsail.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { LightsailClient, GetRelationalDatabaseLogEventsCommand } from "@aws-sdk/client-lightsail"; // ES Modules import + * // const { LightsailClient, GetRelationalDatabaseLogEventsCommand } = require("@aws-sdk/client-lightsail"); // CommonJS import + * const client = new LightsailClient(config); + * const command = new GetRelationalDatabaseLogEventsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetRelationalDatabaseLogEventsCommandInput} for command's `input` shape. + * @see {@link GetRelationalDatabaseLogEventsCommandOutput} for command's `response` shape. + * @see {@link LightsailClientResolvedConfig | config} for command's `input` shape. + * */ export class GetRelationalDatabaseLogEventsCommand extends $Command< GetRelationalDatabaseLogEventsCommandInput, diff --git a/clients/client-lightsail/commands/GetRelationalDatabaseLogStreamsCommand.ts b/clients/client-lightsail/commands/GetRelationalDatabaseLogStreamsCommand.ts index 20935575448e..c858c7f4c511 100644 --- a/clients/client-lightsail/commands/GetRelationalDatabaseLogStreamsCommand.ts +++ b/clients/client-lightsail/commands/GetRelationalDatabaseLogStreamsCommand.ts @@ -24,6 +24,20 @@ export interface GetRelationalDatabaseLogStreamsCommandOutput /** *

Returns a list of available log streams for a specific database in Amazon Lightsail.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { LightsailClient, GetRelationalDatabaseLogStreamsCommand } from "@aws-sdk/client-lightsail"; // ES Modules import + * // const { LightsailClient, GetRelationalDatabaseLogStreamsCommand } = require("@aws-sdk/client-lightsail"); // CommonJS import + * const client = new LightsailClient(config); + * const command = new GetRelationalDatabaseLogStreamsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetRelationalDatabaseLogStreamsCommandInput} for command's `input` shape. + * @see {@link GetRelationalDatabaseLogStreamsCommandOutput} for command's `response` shape. + * @see {@link LightsailClientResolvedConfig | config} for command's `input` shape. + * */ export class GetRelationalDatabaseLogStreamsCommand extends $Command< GetRelationalDatabaseLogStreamsCommandInput, diff --git a/clients/client-lightsail/commands/GetRelationalDatabaseMasterUserPasswordCommand.ts b/clients/client-lightsail/commands/GetRelationalDatabaseMasterUserPasswordCommand.ts index efcc769f2ff4..015274adc639 100644 --- a/clients/client-lightsail/commands/GetRelationalDatabaseMasterUserPasswordCommand.ts +++ b/clients/client-lightsail/commands/GetRelationalDatabaseMasterUserPasswordCommand.ts @@ -32,6 +32,20 @@ export interface GetRelationalDatabaseMasterUserPasswordCommandOutput *

The GetRelationalDatabaseMasterUserPassword operation supports tag-based * access control via resource tags applied to the resource identified by * relationalDatabaseName.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { LightsailClient, GetRelationalDatabaseMasterUserPasswordCommand } from "@aws-sdk/client-lightsail"; // ES Modules import + * // const { LightsailClient, GetRelationalDatabaseMasterUserPasswordCommand } = require("@aws-sdk/client-lightsail"); // CommonJS import + * const client = new LightsailClient(config); + * const command = new GetRelationalDatabaseMasterUserPasswordCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetRelationalDatabaseMasterUserPasswordCommandInput} for command's `input` shape. + * @see {@link GetRelationalDatabaseMasterUserPasswordCommandOutput} for command's `response` shape. + * @see {@link LightsailClientResolvedConfig | config} for command's `input` shape. + * */ export class GetRelationalDatabaseMasterUserPasswordCommand extends $Command< GetRelationalDatabaseMasterUserPasswordCommandInput, diff --git a/clients/client-lightsail/commands/GetRelationalDatabaseMetricDataCommand.ts b/clients/client-lightsail/commands/GetRelationalDatabaseMetricDataCommand.ts index db9ed3e59f25..98e71b8c9e34 100644 --- a/clients/client-lightsail/commands/GetRelationalDatabaseMetricDataCommand.ts +++ b/clients/client-lightsail/commands/GetRelationalDatabaseMetricDataCommand.ts @@ -27,6 +27,20 @@ export interface GetRelationalDatabaseMetricDataCommandOutput *

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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { LightsailClient, GetRelationalDatabaseMetricDataCommand } from "@aws-sdk/client-lightsail"; // ES Modules import + * // const { LightsailClient, GetRelationalDatabaseMetricDataCommand } = require("@aws-sdk/client-lightsail"); // CommonJS import + * const client = new LightsailClient(config); + * const command = new GetRelationalDatabaseMetricDataCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetRelationalDatabaseMetricDataCommandInput} for command's `input` shape. + * @see {@link GetRelationalDatabaseMetricDataCommandOutput} for command's `response` shape. + * @see {@link LightsailClientResolvedConfig | config} for command's `input` shape. + * */ export class GetRelationalDatabaseMetricDataCommand extends $Command< GetRelationalDatabaseMetricDataCommandInput, diff --git a/clients/client-lightsail/commands/GetRelationalDatabaseParametersCommand.ts b/clients/client-lightsail/commands/GetRelationalDatabaseParametersCommand.ts index 0a01f29d6e41..e36e50acd717 100644 --- a/clients/client-lightsail/commands/GetRelationalDatabaseParametersCommand.ts +++ b/clients/client-lightsail/commands/GetRelationalDatabaseParametersCommand.ts @@ -28,6 +28,20 @@ export interface GetRelationalDatabaseParametersCommandOutput *

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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { LightsailClient, GetRelationalDatabaseParametersCommand } from "@aws-sdk/client-lightsail"; // ES Modules import + * // const { LightsailClient, GetRelationalDatabaseParametersCommand } = require("@aws-sdk/client-lightsail"); // CommonJS import + * const client = new LightsailClient(config); + * const command = new GetRelationalDatabaseParametersCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetRelationalDatabaseParametersCommandInput} for command's `input` shape. + * @see {@link GetRelationalDatabaseParametersCommandOutput} for command's `response` shape. + * @see {@link LightsailClientResolvedConfig | config} for command's `input` shape. + * */ export class GetRelationalDatabaseParametersCommand extends $Command< GetRelationalDatabaseParametersCommandInput, diff --git a/clients/client-lightsail/commands/GetRelationalDatabaseSnapshotCommand.ts b/clients/client-lightsail/commands/GetRelationalDatabaseSnapshotCommand.ts index 285597e5b62b..7c6ef3ab15ed 100644 --- a/clients/client-lightsail/commands/GetRelationalDatabaseSnapshotCommand.ts +++ b/clients/client-lightsail/commands/GetRelationalDatabaseSnapshotCommand.ts @@ -24,6 +24,20 @@ export interface GetRelationalDatabaseSnapshotCommandOutput /** *

Returns information about a specific database snapshot in Amazon Lightsail.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { LightsailClient, GetRelationalDatabaseSnapshotCommand } from "@aws-sdk/client-lightsail"; // ES Modules import + * // const { LightsailClient, GetRelationalDatabaseSnapshotCommand } = require("@aws-sdk/client-lightsail"); // CommonJS import + * const client = new LightsailClient(config); + * const command = new GetRelationalDatabaseSnapshotCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetRelationalDatabaseSnapshotCommandInput} for command's `input` shape. + * @see {@link GetRelationalDatabaseSnapshotCommandOutput} for command's `response` shape. + * @see {@link LightsailClientResolvedConfig | config} for command's `input` shape. + * */ export class GetRelationalDatabaseSnapshotCommand extends $Command< GetRelationalDatabaseSnapshotCommandInput, diff --git a/clients/client-lightsail/commands/GetRelationalDatabaseSnapshotsCommand.ts b/clients/client-lightsail/commands/GetRelationalDatabaseSnapshotsCommand.ts index 59d165258e31..6a15e637e122 100644 --- a/clients/client-lightsail/commands/GetRelationalDatabaseSnapshotsCommand.ts +++ b/clients/client-lightsail/commands/GetRelationalDatabaseSnapshotsCommand.ts @@ -24,6 +24,20 @@ export interface GetRelationalDatabaseSnapshotsCommandOutput /** *

Returns information about all of your database snapshots in Amazon Lightsail.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { LightsailClient, GetRelationalDatabaseSnapshotsCommand } from "@aws-sdk/client-lightsail"; // ES Modules import + * // const { LightsailClient, GetRelationalDatabaseSnapshotsCommand } = require("@aws-sdk/client-lightsail"); // CommonJS import + * const client = new LightsailClient(config); + * const command = new GetRelationalDatabaseSnapshotsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetRelationalDatabaseSnapshotsCommandInput} for command's `input` shape. + * @see {@link GetRelationalDatabaseSnapshotsCommandOutput} for command's `response` shape. + * @see {@link LightsailClientResolvedConfig | config} for command's `input` shape. + * */ export class GetRelationalDatabaseSnapshotsCommand extends $Command< GetRelationalDatabaseSnapshotsCommandInput, diff --git a/clients/client-lightsail/commands/GetRelationalDatabasesCommand.ts b/clients/client-lightsail/commands/GetRelationalDatabasesCommand.ts index fde7d0ceaf54..745fbb0a332e 100644 --- a/clients/client-lightsail/commands/GetRelationalDatabasesCommand.ts +++ b/clients/client-lightsail/commands/GetRelationalDatabasesCommand.ts @@ -22,6 +22,20 @@ export interface GetRelationalDatabasesCommandOutput extends GetRelationalDataba /** *

Returns information about all of your databases in Amazon Lightsail.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { LightsailClient, GetRelationalDatabasesCommand } from "@aws-sdk/client-lightsail"; // ES Modules import + * // const { LightsailClient, GetRelationalDatabasesCommand } = require("@aws-sdk/client-lightsail"); // CommonJS import + * const client = new LightsailClient(config); + * const command = new GetRelationalDatabasesCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetRelationalDatabasesCommandInput} for command's `input` shape. + * @see {@link GetRelationalDatabasesCommandOutput} for command's `response` shape. + * @see {@link LightsailClientResolvedConfig | config} for command's `input` shape. + * */ export class GetRelationalDatabasesCommand extends $Command< GetRelationalDatabasesCommandInput, diff --git a/clients/client-lightsail/commands/GetStaticIpCommand.ts b/clients/client-lightsail/commands/GetStaticIpCommand.ts index 951f49ce5b53..fef09860aa64 100644 --- a/clients/client-lightsail/commands/GetStaticIpCommand.ts +++ b/clients/client-lightsail/commands/GetStaticIpCommand.ts @@ -22,6 +22,20 @@ export interface GetStaticIpCommandOutput extends GetStaticIpResult, __MetadataB /** *

Returns information about a specific static IP.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { LightsailClient, GetStaticIpCommand } from "@aws-sdk/client-lightsail"; // ES Modules import + * // const { LightsailClient, GetStaticIpCommand } = require("@aws-sdk/client-lightsail"); // CommonJS import + * const client = new LightsailClient(config); + * const command = new GetStaticIpCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetStaticIpCommandInput} for command's `input` shape. + * @see {@link GetStaticIpCommandOutput} for command's `response` shape. + * @see {@link LightsailClientResolvedConfig | config} for command's `input` shape. + * */ export class GetStaticIpCommand extends $Command< GetStaticIpCommandInput, diff --git a/clients/client-lightsail/commands/GetStaticIpsCommand.ts b/clients/client-lightsail/commands/GetStaticIpsCommand.ts index 30976844de27..a86e930e1529 100644 --- a/clients/client-lightsail/commands/GetStaticIpsCommand.ts +++ b/clients/client-lightsail/commands/GetStaticIpsCommand.ts @@ -22,6 +22,20 @@ export interface GetStaticIpsCommandOutput extends GetStaticIpsResult, __Metadat /** *

Returns information about all static IPs in the user's account.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { LightsailClient, GetStaticIpsCommand } from "@aws-sdk/client-lightsail"; // ES Modules import + * // const { LightsailClient, GetStaticIpsCommand } = require("@aws-sdk/client-lightsail"); // CommonJS import + * const client = new LightsailClient(config); + * const command = new GetStaticIpsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetStaticIpsCommandInput} for command's `input` shape. + * @see {@link GetStaticIpsCommandOutput} for command's `response` shape. + * @see {@link LightsailClientResolvedConfig | config} for command's `input` shape. + * */ export class GetStaticIpsCommand extends $Command< GetStaticIpsCommandInput, diff --git a/clients/client-lightsail/commands/ImportKeyPairCommand.ts b/clients/client-lightsail/commands/ImportKeyPairCommand.ts index d213be1e2a72..fff030fd48aa 100644 --- a/clients/client-lightsail/commands/ImportKeyPairCommand.ts +++ b/clients/client-lightsail/commands/ImportKeyPairCommand.ts @@ -22,6 +22,20 @@ export interface ImportKeyPairCommandOutput extends ImportKeyPairResult, __Metad /** *

Imports a public SSH key from a specific key pair.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { LightsailClient, ImportKeyPairCommand } from "@aws-sdk/client-lightsail"; // ES Modules import + * // const { LightsailClient, ImportKeyPairCommand } = require("@aws-sdk/client-lightsail"); // CommonJS import + * const client = new LightsailClient(config); + * const command = new ImportKeyPairCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ImportKeyPairCommandInput} for command's `input` shape. + * @see {@link ImportKeyPairCommandOutput} for command's `response` shape. + * @see {@link LightsailClientResolvedConfig | config} for command's `input` shape. + * */ export class ImportKeyPairCommand extends $Command< ImportKeyPairCommandInput, diff --git a/clients/client-lightsail/commands/IsVpcPeeredCommand.ts b/clients/client-lightsail/commands/IsVpcPeeredCommand.ts index a219f1d09d32..62858f3c8eb0 100644 --- a/clients/client-lightsail/commands/IsVpcPeeredCommand.ts +++ b/clients/client-lightsail/commands/IsVpcPeeredCommand.ts @@ -22,6 +22,20 @@ export interface IsVpcPeeredCommandOutput extends IsVpcPeeredResult, __MetadataB /** *

Returns a Boolean value indicating whether your Lightsail VPC is peered.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { LightsailClient, IsVpcPeeredCommand } from "@aws-sdk/client-lightsail"; // ES Modules import + * // const { LightsailClient, IsVpcPeeredCommand } = require("@aws-sdk/client-lightsail"); // CommonJS import + * const client = new LightsailClient(config); + * const command = new IsVpcPeeredCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link IsVpcPeeredCommandInput} for command's `input` shape. + * @see {@link IsVpcPeeredCommandOutput} for command's `response` shape. + * @see {@link LightsailClientResolvedConfig | config} for command's `input` shape. + * */ export class IsVpcPeeredCommand extends $Command< IsVpcPeeredCommandInput, diff --git a/clients/client-lightsail/commands/OpenInstancePublicPortsCommand.ts b/clients/client-lightsail/commands/OpenInstancePublicPortsCommand.ts index 7f0bf192dda4..5307bf317b51 100644 --- a/clients/client-lightsail/commands/OpenInstancePublicPortsCommand.ts +++ b/clients/client-lightsail/commands/OpenInstancePublicPortsCommand.ts @@ -26,6 +26,20 @@ export interface OpenInstancePublicPortsCommandOutput extends OpenInstancePublic *

The OpenInstancePublicPorts action supports tag-based access control via * resource tags applied to the resource identified by instanceName. For more * information, see the Lightsail Dev Guide.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { LightsailClient, OpenInstancePublicPortsCommand } from "@aws-sdk/client-lightsail"; // ES Modules import + * // const { LightsailClient, OpenInstancePublicPortsCommand } = require("@aws-sdk/client-lightsail"); // CommonJS import + * const client = new LightsailClient(config); + * const command = new OpenInstancePublicPortsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link OpenInstancePublicPortsCommandInput} for command's `input` shape. + * @see {@link OpenInstancePublicPortsCommandOutput} for command's `response` shape. + * @see {@link LightsailClientResolvedConfig | config} for command's `input` shape. + * */ export class OpenInstancePublicPortsCommand extends $Command< OpenInstancePublicPortsCommandInput, diff --git a/clients/client-lightsail/commands/PeerVpcCommand.ts b/clients/client-lightsail/commands/PeerVpcCommand.ts index 15978c2e8514..41326a49f689 100644 --- a/clients/client-lightsail/commands/PeerVpcCommand.ts +++ b/clients/client-lightsail/commands/PeerVpcCommand.ts @@ -19,6 +19,20 @@ export interface PeerVpcCommandOutput extends PeerVpcResult, __MetadataBearer {} /** *

Tries to peer the Lightsail VPC with the user's default VPC.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { LightsailClient, PeerVpcCommand } from "@aws-sdk/client-lightsail"; // ES Modules import + * // const { LightsailClient, PeerVpcCommand } = require("@aws-sdk/client-lightsail"); // CommonJS import + * const client = new LightsailClient(config); + * const command = new PeerVpcCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link PeerVpcCommandInput} for command's `input` shape. + * @see {@link PeerVpcCommandOutput} for command's `response` shape. + * @see {@link LightsailClientResolvedConfig | config} for command's `input` shape. + * */ export class PeerVpcCommand extends $Command { // Start section: command_properties diff --git a/clients/client-lightsail/commands/PutAlarmCommand.ts b/clients/client-lightsail/commands/PutAlarmCommand.ts index 68223ab9e1d3..d65010077403 100644 --- a/clients/client-lightsail/commands/PutAlarmCommand.ts +++ b/clients/client-lightsail/commands/PutAlarmCommand.ts @@ -29,6 +29,20 @@ export interface PutAlarmCommandOutput extends PutAlarmResult, __MetadataBearer *

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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { LightsailClient, PutAlarmCommand } from "@aws-sdk/client-lightsail"; // ES Modules import + * // const { LightsailClient, PutAlarmCommand } = require("@aws-sdk/client-lightsail"); // CommonJS import + * const client = new LightsailClient(config); + * const command = new PutAlarmCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link PutAlarmCommandInput} for command's `input` shape. + * @see {@link PutAlarmCommandOutput} for command's `response` shape. + * @see {@link LightsailClientResolvedConfig | config} for command's `input` shape. + * */ export class PutAlarmCommand extends $Command< PutAlarmCommandInput, diff --git a/clients/client-lightsail/commands/PutInstancePublicPortsCommand.ts b/clients/client-lightsail/commands/PutInstancePublicPortsCommand.ts index a876ade3a34e..ebe76efffed1 100644 --- a/clients/client-lightsail/commands/PutInstancePublicPortsCommand.ts +++ b/clients/client-lightsail/commands/PutInstancePublicPortsCommand.ts @@ -30,6 +30,20 @@ export interface PutInstancePublicPortsCommandOutput extends PutInstancePublicPo *

The PutInstancePublicPorts action supports tag-based access control via * resource tags applied to the resource identified by instanceName. For more * information, see the Lightsail Dev Guide.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { LightsailClient, PutInstancePublicPortsCommand } from "@aws-sdk/client-lightsail"; // ES Modules import + * // const { LightsailClient, PutInstancePublicPortsCommand } = require("@aws-sdk/client-lightsail"); // CommonJS import + * const client = new LightsailClient(config); + * const command = new PutInstancePublicPortsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link PutInstancePublicPortsCommandInput} for command's `input` shape. + * @see {@link PutInstancePublicPortsCommandOutput} for command's `response` shape. + * @see {@link LightsailClientResolvedConfig | config} for command's `input` shape. + * */ export class PutInstancePublicPortsCommand extends $Command< PutInstancePublicPortsCommandInput, diff --git a/clients/client-lightsail/commands/RebootInstanceCommand.ts b/clients/client-lightsail/commands/RebootInstanceCommand.ts index 7c431540133b..602b40125b3d 100644 --- a/clients/client-lightsail/commands/RebootInstanceCommand.ts +++ b/clients/client-lightsail/commands/RebootInstanceCommand.ts @@ -25,6 +25,20 @@ export interface RebootInstanceCommandOutput extends RebootInstanceResult, __Met *

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 Lightsail Dev Guide.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { LightsailClient, RebootInstanceCommand } from "@aws-sdk/client-lightsail"; // ES Modules import + * // const { LightsailClient, RebootInstanceCommand } = require("@aws-sdk/client-lightsail"); // CommonJS import + * const client = new LightsailClient(config); + * const command = new RebootInstanceCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link RebootInstanceCommandInput} for command's `input` shape. + * @see {@link RebootInstanceCommandOutput} for command's `response` shape. + * @see {@link LightsailClientResolvedConfig | config} for command's `input` shape. + * */ export class RebootInstanceCommand extends $Command< RebootInstanceCommandInput, diff --git a/clients/client-lightsail/commands/RebootRelationalDatabaseCommand.ts b/clients/client-lightsail/commands/RebootRelationalDatabaseCommand.ts index 196b0e8b2d04..ba4da41a0348 100644 --- a/clients/client-lightsail/commands/RebootRelationalDatabaseCommand.ts +++ b/clients/client-lightsail/commands/RebootRelationalDatabaseCommand.ts @@ -25,6 +25,20 @@ export interface RebootRelationalDatabaseCommandOutput extends RebootRelationalD *

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 Lightsail Dev Guide.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { LightsailClient, RebootRelationalDatabaseCommand } from "@aws-sdk/client-lightsail"; // ES Modules import + * // const { LightsailClient, RebootRelationalDatabaseCommand } = require("@aws-sdk/client-lightsail"); // CommonJS import + * const client = new LightsailClient(config); + * const command = new RebootRelationalDatabaseCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link RebootRelationalDatabaseCommandInput} for command's `input` shape. + * @see {@link RebootRelationalDatabaseCommandOutput} for command's `response` shape. + * @see {@link LightsailClientResolvedConfig | config} for command's `input` shape. + * */ export class RebootRelationalDatabaseCommand extends $Command< RebootRelationalDatabaseCommandInput, diff --git a/clients/client-lightsail/commands/RegisterContainerImageCommand.ts b/clients/client-lightsail/commands/RegisterContainerImageCommand.ts index 84382e880ccd..f637f5f29978 100644 --- a/clients/client-lightsail/commands/RegisterContainerImageCommand.ts +++ b/clients/client-lightsail/commands/RegisterContainerImageCommand.ts @@ -29,6 +29,20 @@ export interface RegisterContainerImageCommandOutput extends RegisterContainerIm * more information, see Pushing and managing container images on your Amazon Lightsail container services * in the Lightsail Dev Guide.

* + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { LightsailClient, RegisterContainerImageCommand } from "@aws-sdk/client-lightsail"; // ES Modules import + * // const { LightsailClient, RegisterContainerImageCommand } = require("@aws-sdk/client-lightsail"); // CommonJS import + * const client = new LightsailClient(config); + * const command = new RegisterContainerImageCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link RegisterContainerImageCommandInput} for command's `input` shape. + * @see {@link RegisterContainerImageCommandOutput} for command's `response` shape. + * @see {@link LightsailClientResolvedConfig | config} for command's `input` shape. + * */ export class RegisterContainerImageCommand extends $Command< RegisterContainerImageCommandInput, diff --git a/clients/client-lightsail/commands/ReleaseStaticIpCommand.ts b/clients/client-lightsail/commands/ReleaseStaticIpCommand.ts index 2dcbcc1208a5..2128909eebef 100644 --- a/clients/client-lightsail/commands/ReleaseStaticIpCommand.ts +++ b/clients/client-lightsail/commands/ReleaseStaticIpCommand.ts @@ -22,6 +22,20 @@ export interface ReleaseStaticIpCommandOutput extends ReleaseStaticIpResult, __M /** *

Deletes a specific static IP from your account.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { LightsailClient, ReleaseStaticIpCommand } from "@aws-sdk/client-lightsail"; // ES Modules import + * // const { LightsailClient, ReleaseStaticIpCommand } = require("@aws-sdk/client-lightsail"); // CommonJS import + * const client = new LightsailClient(config); + * const command = new ReleaseStaticIpCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ReleaseStaticIpCommandInput} for command's `input` shape. + * @see {@link ReleaseStaticIpCommandOutput} for command's `response` shape. + * @see {@link LightsailClientResolvedConfig | config} for command's `input` shape. + * */ export class ReleaseStaticIpCommand extends $Command< ReleaseStaticIpCommandInput, diff --git a/clients/client-lightsail/commands/ResetDistributionCacheCommand.ts b/clients/client-lightsail/commands/ResetDistributionCacheCommand.ts index 1602401bbcde..df2b898d8d33 100644 --- a/clients/client-lightsail/commands/ResetDistributionCacheCommand.ts +++ b/clients/client-lightsail/commands/ResetDistributionCacheCommand.ts @@ -25,6 +25,20 @@ export interface ResetDistributionCacheCommandOutput extends ResetDistributionCa * distribution.

*

After resetting the cache, the next time a content request is made, your distribution * pulls, serves, and caches it from the origin.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { LightsailClient, ResetDistributionCacheCommand } from "@aws-sdk/client-lightsail"; // ES Modules import + * // const { LightsailClient, ResetDistributionCacheCommand } = require("@aws-sdk/client-lightsail"); // CommonJS import + * const client = new LightsailClient(config); + * const command = new ResetDistributionCacheCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ResetDistributionCacheCommandInput} for command's `input` shape. + * @see {@link ResetDistributionCacheCommandOutput} for command's `response` shape. + * @see {@link LightsailClientResolvedConfig | config} for command's `input` shape. + * */ export class ResetDistributionCacheCommand extends $Command< ResetDistributionCacheCommandInput, diff --git a/clients/client-lightsail/commands/SendContactMethodVerificationCommand.ts b/clients/client-lightsail/commands/SendContactMethodVerificationCommand.ts index 5fb64c8cec2c..498805a9a067 100644 --- a/clients/client-lightsail/commands/SendContactMethodVerificationCommand.ts +++ b/clients/client-lightsail/commands/SendContactMethodVerificationCommand.ts @@ -36,6 +36,20 @@ export interface SendContactMethodVerificationCommandOutput *

Notifications are not sent to an email contact method until after it is verified, and * confirmed as valid.

* + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { LightsailClient, SendContactMethodVerificationCommand } from "@aws-sdk/client-lightsail"; // ES Modules import + * // const { LightsailClient, SendContactMethodVerificationCommand } = require("@aws-sdk/client-lightsail"); // CommonJS import + * const client = new LightsailClient(config); + * const command = new SendContactMethodVerificationCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link SendContactMethodVerificationCommandInput} for command's `input` shape. + * @see {@link SendContactMethodVerificationCommandOutput} for command's `response` shape. + * @see {@link LightsailClientResolvedConfig | config} for command's `input` shape. + * */ export class SendContactMethodVerificationCommand extends $Command< SendContactMethodVerificationCommandInput, diff --git a/clients/client-lightsail/commands/SetIpAddressTypeCommand.ts b/clients/client-lightsail/commands/SetIpAddressTypeCommand.ts index 76475314c922..e5409bf6a0d8 100644 --- a/clients/client-lightsail/commands/SetIpAddressTypeCommand.ts +++ b/clients/client-lightsail/commands/SetIpAddressTypeCommand.ts @@ -26,6 +26,20 @@ export interface SetIpAddressTypeCommandOutput extends SetIpAddressTypeResult, _ *

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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { LightsailClient, SetIpAddressTypeCommand } from "@aws-sdk/client-lightsail"; // ES Modules import + * // const { LightsailClient, SetIpAddressTypeCommand } = require("@aws-sdk/client-lightsail"); // CommonJS import + * const client = new LightsailClient(config); + * const command = new SetIpAddressTypeCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link SetIpAddressTypeCommandInput} for command's `input` shape. + * @see {@link SetIpAddressTypeCommandOutput} for command's `response` shape. + * @see {@link LightsailClientResolvedConfig | config} for command's `input` shape. + * */ export class SetIpAddressTypeCommand extends $Command< SetIpAddressTypeCommandInput, diff --git a/clients/client-lightsail/commands/StartInstanceCommand.ts b/clients/client-lightsail/commands/StartInstanceCommand.ts index 4e5c0c3e5b7c..ca0394b85dac 100644 --- a/clients/client-lightsail/commands/StartInstanceCommand.ts +++ b/clients/client-lightsail/commands/StartInstanceCommand.ts @@ -31,6 +31,20 @@ export interface StartInstanceCommandOutput extends StartInstanceResult, __Metad *

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 Lightsail Dev Guide.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { LightsailClient, StartInstanceCommand } from "@aws-sdk/client-lightsail"; // ES Modules import + * // const { LightsailClient, StartInstanceCommand } = require("@aws-sdk/client-lightsail"); // CommonJS import + * const client = new LightsailClient(config); + * const command = new StartInstanceCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link StartInstanceCommandInput} for command's `input` shape. + * @see {@link StartInstanceCommandOutput} for command's `response` shape. + * @see {@link LightsailClientResolvedConfig | config} for command's `input` shape. + * */ export class StartInstanceCommand extends $Command< StartInstanceCommandInput, diff --git a/clients/client-lightsail/commands/StartRelationalDatabaseCommand.ts b/clients/client-lightsail/commands/StartRelationalDatabaseCommand.ts index 2bd7f3bc9884..370a086ddff5 100644 --- a/clients/client-lightsail/commands/StartRelationalDatabaseCommand.ts +++ b/clients/client-lightsail/commands/StartRelationalDatabaseCommand.ts @@ -26,6 +26,20 @@ export interface StartRelationalDatabaseCommandOutput extends StartRelationalDat *

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 Lightsail Dev Guide.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { LightsailClient, StartRelationalDatabaseCommand } from "@aws-sdk/client-lightsail"; // ES Modules import + * // const { LightsailClient, StartRelationalDatabaseCommand } = require("@aws-sdk/client-lightsail"); // CommonJS import + * const client = new LightsailClient(config); + * const command = new StartRelationalDatabaseCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link StartRelationalDatabaseCommandInput} for command's `input` shape. + * @see {@link StartRelationalDatabaseCommandOutput} for command's `response` shape. + * @see {@link LightsailClientResolvedConfig | config} for command's `input` shape. + * */ export class StartRelationalDatabaseCommand extends $Command< StartRelationalDatabaseCommandInput, diff --git a/clients/client-lightsail/commands/StopInstanceCommand.ts b/clients/client-lightsail/commands/StopInstanceCommand.ts index 516986d644f2..ab190358be54 100644 --- a/clients/client-lightsail/commands/StopInstanceCommand.ts +++ b/clients/client-lightsail/commands/StopInstanceCommand.ts @@ -30,6 +30,20 @@ export interface StopInstanceCommandOutput extends StopInstanceResult, __Metadat *

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 Lightsail Dev Guide.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { LightsailClient, StopInstanceCommand } from "@aws-sdk/client-lightsail"; // ES Modules import + * // const { LightsailClient, StopInstanceCommand } = require("@aws-sdk/client-lightsail"); // CommonJS import + * const client = new LightsailClient(config); + * const command = new StopInstanceCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link StopInstanceCommandInput} for command's `input` shape. + * @see {@link StopInstanceCommandOutput} for command's `response` shape. + * @see {@link LightsailClientResolvedConfig | config} for command's `input` shape. + * */ export class StopInstanceCommand extends $Command< StopInstanceCommandInput, diff --git a/clients/client-lightsail/commands/StopRelationalDatabaseCommand.ts b/clients/client-lightsail/commands/StopRelationalDatabaseCommand.ts index 14b911b27d30..b1c016707568 100644 --- a/clients/client-lightsail/commands/StopRelationalDatabaseCommand.ts +++ b/clients/client-lightsail/commands/StopRelationalDatabaseCommand.ts @@ -25,6 +25,20 @@ export interface StopRelationalDatabaseCommandOutput extends StopRelationalDatab *

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 Lightsail Dev Guide.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { LightsailClient, StopRelationalDatabaseCommand } from "@aws-sdk/client-lightsail"; // ES Modules import + * // const { LightsailClient, StopRelationalDatabaseCommand } = require("@aws-sdk/client-lightsail"); // CommonJS import + * const client = new LightsailClient(config); + * const command = new StopRelationalDatabaseCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link StopRelationalDatabaseCommandInput} for command's `input` shape. + * @see {@link StopRelationalDatabaseCommandOutput} for command's `response` shape. + * @see {@link LightsailClientResolvedConfig | config} for command's `input` shape. + * */ export class StopRelationalDatabaseCommand extends $Command< StopRelationalDatabaseCommandInput, diff --git a/clients/client-lightsail/commands/TagResourceCommand.ts b/clients/client-lightsail/commands/TagResourceCommand.ts index 156d6719c2ec..4d6833071d17 100644 --- a/clients/client-lightsail/commands/TagResourceCommand.ts +++ b/clients/client-lightsail/commands/TagResourceCommand.ts @@ -28,6 +28,20 @@ export interface TagResourceCommandOutput extends TagResourceResult, __MetadataB *

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 Lightsail Dev Guide.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { LightsailClient, TagResourceCommand } from "@aws-sdk/client-lightsail"; // ES Modules import + * // const { LightsailClient, TagResourceCommand } = require("@aws-sdk/client-lightsail"); // CommonJS import + * const client = new LightsailClient(config); + * const command = new TagResourceCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link TagResourceCommandInput} for command's `input` shape. + * @see {@link TagResourceCommandOutput} for command's `response` shape. + * @see {@link LightsailClientResolvedConfig | config} for command's `input` shape. + * */ export class TagResourceCommand extends $Command< TagResourceCommandInput, diff --git a/clients/client-lightsail/commands/TestAlarmCommand.ts b/clients/client-lightsail/commands/TestAlarmCommand.ts index 41efcaaeeef5..cdf6d7e87a07 100644 --- a/clients/client-lightsail/commands/TestAlarmCommand.ts +++ b/clients/client-lightsail/commands/TestAlarmCommand.ts @@ -26,6 +26,20 @@ export interface TestAlarmCommandOutput extends TestAlarmResult, __MetadataBeare * 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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { LightsailClient, TestAlarmCommand } from "@aws-sdk/client-lightsail"; // ES Modules import + * // const { LightsailClient, TestAlarmCommand } = require("@aws-sdk/client-lightsail"); // CommonJS import + * const client = new LightsailClient(config); + * const command = new TestAlarmCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link TestAlarmCommandInput} for command's `input` shape. + * @see {@link TestAlarmCommandOutput} for command's `response` shape. + * @see {@link LightsailClientResolvedConfig | config} for command's `input` shape. + * */ export class TestAlarmCommand extends $Command< TestAlarmCommandInput, diff --git a/clients/client-lightsail/commands/UnpeerVpcCommand.ts b/clients/client-lightsail/commands/UnpeerVpcCommand.ts index ddb0b52f8ca7..6445dd3aad46 100644 --- a/clients/client-lightsail/commands/UnpeerVpcCommand.ts +++ b/clients/client-lightsail/commands/UnpeerVpcCommand.ts @@ -19,6 +19,20 @@ export interface UnpeerVpcCommandOutput extends UnpeerVpcResult, __MetadataBeare /** *

Attempts to unpeer the Lightsail VPC from the user's default VPC.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { LightsailClient, UnpeerVpcCommand } from "@aws-sdk/client-lightsail"; // ES Modules import + * // const { LightsailClient, UnpeerVpcCommand } = require("@aws-sdk/client-lightsail"); // CommonJS import + * const client = new LightsailClient(config); + * const command = new UnpeerVpcCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link UnpeerVpcCommandInput} for command's `input` shape. + * @see {@link UnpeerVpcCommandOutput} for command's `response` shape. + * @see {@link LightsailClientResolvedConfig | config} for command's `input` shape. + * */ export class UnpeerVpcCommand extends $Command< UnpeerVpcCommandInput, diff --git a/clients/client-lightsail/commands/UntagResourceCommand.ts b/clients/client-lightsail/commands/UntagResourceCommand.ts index b4e8bbac5378..77372ca39bf0 100644 --- a/clients/client-lightsail/commands/UntagResourceCommand.ts +++ b/clients/client-lightsail/commands/UntagResourceCommand.ts @@ -26,6 +26,20 @@ export interface UntagResourceCommandOutput extends UntagResourceResult, __Metad *

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 Lightsail Dev Guide.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { LightsailClient, UntagResourceCommand } from "@aws-sdk/client-lightsail"; // ES Modules import + * // const { LightsailClient, UntagResourceCommand } = require("@aws-sdk/client-lightsail"); // CommonJS import + * const client = new LightsailClient(config); + * const command = new UntagResourceCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link UntagResourceCommandInput} for command's `input` shape. + * @see {@link UntagResourceCommandOutput} for command's `response` shape. + * @see {@link LightsailClientResolvedConfig | config} for command's `input` shape. + * */ export class UntagResourceCommand extends $Command< UntagResourceCommandInput, diff --git a/clients/client-lightsail/commands/UpdateContainerServiceCommand.ts b/clients/client-lightsail/commands/UpdateContainerServiceCommand.ts index 14d1832314be..64643fe86f11 100644 --- a/clients/client-lightsail/commands/UpdateContainerServiceCommand.ts +++ b/clients/client-lightsail/commands/UpdateContainerServiceCommand.ts @@ -23,6 +23,20 @@ export interface UpdateContainerServiceCommandOutput extends UpdateContainerServ /** *

Updates the configuration of your Amazon Lightsail container service, such as its power, * scale, and public domain names.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { LightsailClient, UpdateContainerServiceCommand } from "@aws-sdk/client-lightsail"; // ES Modules import + * // const { LightsailClient, UpdateContainerServiceCommand } = require("@aws-sdk/client-lightsail"); // CommonJS import + * const client = new LightsailClient(config); + * const command = new UpdateContainerServiceCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link UpdateContainerServiceCommandInput} for command's `input` shape. + * @see {@link UpdateContainerServiceCommandOutput} for command's `response` shape. + * @see {@link LightsailClientResolvedConfig | config} for command's `input` shape. + * */ export class UpdateContainerServiceCommand extends $Command< UpdateContainerServiceCommandInput, diff --git a/clients/client-lightsail/commands/UpdateDistributionBundleCommand.ts b/clients/client-lightsail/commands/UpdateDistributionBundleCommand.ts index 677ad5fd91e4..7ee85bf63188 100644 --- a/clients/client-lightsail/commands/UpdateDistributionBundleCommand.ts +++ b/clients/client-lightsail/commands/UpdateDistributionBundleCommand.ts @@ -31,6 +31,20 @@ export interface UpdateDistributionBundleCommandOutput extends UpdateDistributio * 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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { LightsailClient, UpdateDistributionBundleCommand } from "@aws-sdk/client-lightsail"; // ES Modules import + * // const { LightsailClient, UpdateDistributionBundleCommand } = require("@aws-sdk/client-lightsail"); // CommonJS import + * const client = new LightsailClient(config); + * const command = new UpdateDistributionBundleCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link UpdateDistributionBundleCommandInput} for command's `input` shape. + * @see {@link UpdateDistributionBundleCommandOutput} for command's `response` shape. + * @see {@link LightsailClientResolvedConfig | config} for command's `input` shape. + * */ export class UpdateDistributionBundleCommand extends $Command< UpdateDistributionBundleCommandInput, diff --git a/clients/client-lightsail/commands/UpdateDistributionCommand.ts b/clients/client-lightsail/commands/UpdateDistributionCommand.ts index 59ca78cb4d14..fc67701aefeb 100644 --- a/clients/client-lightsail/commands/UpdateDistributionCommand.ts +++ b/clients/client-lightsail/commands/UpdateDistributionCommand.ts @@ -23,6 +23,20 @@ export interface UpdateDistributionCommandOutput extends UpdateDistributionResul /** *

Updates an existing Amazon Lightsail content delivery network (CDN) distribution.

*

Use this action to update the configuration of your existing distribution

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { LightsailClient, UpdateDistributionCommand } from "@aws-sdk/client-lightsail"; // ES Modules import + * // const { LightsailClient, UpdateDistributionCommand } = require("@aws-sdk/client-lightsail"); // CommonJS import + * const client = new LightsailClient(config); + * const command = new UpdateDistributionCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link UpdateDistributionCommandInput} for command's `input` shape. + * @see {@link UpdateDistributionCommandOutput} for command's `response` shape. + * @see {@link LightsailClientResolvedConfig | config} for command's `input` shape. + * */ export class UpdateDistributionCommand extends $Command< UpdateDistributionCommandInput, diff --git a/clients/client-lightsail/commands/UpdateDomainEntryCommand.ts b/clients/client-lightsail/commands/UpdateDomainEntryCommand.ts index 9b75c1fef57b..dc91aa501764 100644 --- a/clients/client-lightsail/commands/UpdateDomainEntryCommand.ts +++ b/clients/client-lightsail/commands/UpdateDomainEntryCommand.ts @@ -25,6 +25,20 @@ export interface UpdateDomainEntryCommandOutput extends UpdateDomainEntryResult, *

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 Lightsail Dev Guide.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { LightsailClient, UpdateDomainEntryCommand } from "@aws-sdk/client-lightsail"; // ES Modules import + * // const { LightsailClient, UpdateDomainEntryCommand } = require("@aws-sdk/client-lightsail"); // CommonJS import + * const client = new LightsailClient(config); + * const command = new UpdateDomainEntryCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link UpdateDomainEntryCommandInput} for command's `input` shape. + * @see {@link UpdateDomainEntryCommandOutput} for command's `response` shape. + * @see {@link LightsailClientResolvedConfig | config} for command's `input` shape. + * */ export class UpdateDomainEntryCommand extends $Command< UpdateDomainEntryCommandInput, diff --git a/clients/client-lightsail/commands/UpdateLoadBalancerAttributeCommand.ts b/clients/client-lightsail/commands/UpdateLoadBalancerAttributeCommand.ts index 90dfbd13d4e3..0fe101a60a95 100644 --- a/clients/client-lightsail/commands/UpdateLoadBalancerAttributeCommand.ts +++ b/clients/client-lightsail/commands/UpdateLoadBalancerAttributeCommand.ts @@ -26,6 +26,20 @@ export interface UpdateLoadBalancerAttributeCommandOutput extends UpdateLoadBala *

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 Lightsail Dev Guide.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { LightsailClient, UpdateLoadBalancerAttributeCommand } from "@aws-sdk/client-lightsail"; // ES Modules import + * // const { LightsailClient, UpdateLoadBalancerAttributeCommand } = require("@aws-sdk/client-lightsail"); // CommonJS import + * const client = new LightsailClient(config); + * const command = new UpdateLoadBalancerAttributeCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link UpdateLoadBalancerAttributeCommandInput} for command's `input` shape. + * @see {@link UpdateLoadBalancerAttributeCommandOutput} for command's `response` shape. + * @see {@link LightsailClientResolvedConfig | config} for command's `input` shape. + * */ export class UpdateLoadBalancerAttributeCommand extends $Command< UpdateLoadBalancerAttributeCommandInput, diff --git a/clients/client-lightsail/commands/UpdateRelationalDatabaseCommand.ts b/clients/client-lightsail/commands/UpdateRelationalDatabaseCommand.ts index 1eda49089a24..3bd1d2b235a5 100644 --- a/clients/client-lightsail/commands/UpdateRelationalDatabaseCommand.ts +++ b/clients/client-lightsail/commands/UpdateRelationalDatabaseCommand.ts @@ -27,6 +27,20 @@ export interface UpdateRelationalDatabaseCommandOutput extends UpdateRelationalD *

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 Lightsail Dev Guide.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { LightsailClient, UpdateRelationalDatabaseCommand } from "@aws-sdk/client-lightsail"; // ES Modules import + * // const { LightsailClient, UpdateRelationalDatabaseCommand } = require("@aws-sdk/client-lightsail"); // CommonJS import + * const client = new LightsailClient(config); + * const command = new UpdateRelationalDatabaseCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link UpdateRelationalDatabaseCommandInput} for command's `input` shape. + * @see {@link UpdateRelationalDatabaseCommandOutput} for command's `response` shape. + * @see {@link LightsailClientResolvedConfig | config} for command's `input` shape. + * */ export class UpdateRelationalDatabaseCommand extends $Command< UpdateRelationalDatabaseCommandInput, diff --git a/clients/client-lightsail/commands/UpdateRelationalDatabaseParametersCommand.ts b/clients/client-lightsail/commands/UpdateRelationalDatabaseParametersCommand.ts index 11e61ef22ea9..79c76c881296 100644 --- a/clients/client-lightsail/commands/UpdateRelationalDatabaseParametersCommand.ts +++ b/clients/client-lightsail/commands/UpdateRelationalDatabaseParametersCommand.ts @@ -36,6 +36,20 @@ export interface UpdateRelationalDatabaseParametersCommandOutput *

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 Lightsail Dev Guide.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { LightsailClient, UpdateRelationalDatabaseParametersCommand } from "@aws-sdk/client-lightsail"; // ES Modules import + * // const { LightsailClient, UpdateRelationalDatabaseParametersCommand } = require("@aws-sdk/client-lightsail"); // CommonJS import + * const client = new LightsailClient(config); + * const command = new UpdateRelationalDatabaseParametersCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link UpdateRelationalDatabaseParametersCommandInput} for command's `input` shape. + * @see {@link UpdateRelationalDatabaseParametersCommandOutput} for command's `response` shape. + * @see {@link LightsailClientResolvedConfig | config} for command's `input` shape. + * */ export class UpdateRelationalDatabaseParametersCommand extends $Command< UpdateRelationalDatabaseParametersCommandInput, diff --git a/clients/client-lightsail/models/models_0.ts b/clients/client-lightsail/models/models_0.ts index 61f72baf8b97..c96bfc7f694b 100644 --- a/clients/client-lightsail/models/models_0.ts +++ b/clients/client-lightsail/models/models_0.ts @@ -15,6 +15,9 @@ export interface AccessDeniedException extends __SmithyException, $MetadataBeare } export namespace AccessDeniedException { + /** + * @internal + */ export const filterSensitiveLog = (obj: AccessDeniedException): any => ({ ...obj, }); @@ -39,6 +42,9 @@ export interface AccountSetupInProgressException extends __SmithyException, $Met } export namespace AccountSetupInProgressException { + /** + * @internal + */ export const filterSensitiveLog = (obj: AccountSetupInProgressException): any => ({ ...obj, }); @@ -78,6 +84,9 @@ export interface AddOn { } export namespace AddOn { + /** + * @internal + */ export const filterSensitiveLog = (obj: AddOn): any => ({ ...obj, }); @@ -143,6 +152,9 @@ export interface AutoSnapshotAddOnRequest { } export namespace AutoSnapshotAddOnRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: AutoSnapshotAddOnRequest): any => ({ ...obj, }); @@ -171,6 +183,9 @@ export interface AddOnRequest { } export namespace AddOnRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: AddOnRequest): any => ({ ...obj, }); @@ -221,6 +236,9 @@ export interface ResourceLocation { } export namespace ResourceLocation { + /** + * @internal + */ export const filterSensitiveLog = (obj: ResourceLocation): any => ({ ...obj, }); @@ -302,6 +320,9 @@ export interface MonitoredResourceInfo { } export namespace MonitoredResourceInfo { + /** + * @internal + */ export const filterSensitiveLog = (obj: MonitoredResourceInfo): any => ({ ...obj, }); @@ -541,6 +562,9 @@ export interface Alarm { } export namespace Alarm { + /** + * @internal + */ export const filterSensitiveLog = (obj: Alarm): any => ({ ...obj, }); @@ -554,6 +578,9 @@ export interface AllocateStaticIpRequest { } export namespace AllocateStaticIpRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: AllocateStaticIpRequest): any => ({ ...obj, }); @@ -709,6 +736,9 @@ export interface Operation { } export namespace Operation { + /** + * @internal + */ export const filterSensitiveLog = (obj: Operation): any => ({ ...obj, }); @@ -723,6 +753,9 @@ export interface AllocateStaticIpResult { } export namespace AllocateStaticIpResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: AllocateStaticIpResult): any => ({ ...obj, }); @@ -747,6 +780,9 @@ export interface InvalidInputException extends __SmithyException, $MetadataBeare } export namespace InvalidInputException { + /** + * @internal + */ export const filterSensitiveLog = (obj: InvalidInputException): any => ({ ...obj, }); @@ -765,6 +801,9 @@ export interface NotFoundException extends __SmithyException, $MetadataBearer { } export namespace NotFoundException { + /** + * @internal + */ export const filterSensitiveLog = (obj: NotFoundException): any => ({ ...obj, }); @@ -783,6 +822,9 @@ export interface OperationFailureException extends __SmithyException, $MetadataB } export namespace OperationFailureException { + /** + * @internal + */ export const filterSensitiveLog = (obj: OperationFailureException): any => ({ ...obj, }); @@ -801,6 +843,9 @@ export interface ServiceException extends __SmithyException, $MetadataBearer { } export namespace ServiceException { + /** + * @internal + */ export const filterSensitiveLog = (obj: ServiceException): any => ({ ...obj, }); @@ -819,6 +864,9 @@ export interface UnauthenticatedException extends __SmithyException, $MetadataBe } export namespace UnauthenticatedException { + /** + * @internal + */ export const filterSensitiveLog = (obj: UnauthenticatedException): any => ({ ...obj, }); @@ -850,6 +898,9 @@ export interface AttachCertificateToDistributionRequest { } export namespace AttachCertificateToDistributionRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: AttachCertificateToDistributionRequest): any => ({ ...obj, }); @@ -864,6 +915,9 @@ export interface AttachCertificateToDistributionResult { } export namespace AttachCertificateToDistributionResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: AttachCertificateToDistributionResult): any => ({ ...obj, }); @@ -887,6 +941,9 @@ export interface AttachDiskRequest { } export namespace AttachDiskRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: AttachDiskRequest): any => ({ ...obj, }); @@ -901,6 +958,9 @@ export interface AttachDiskResult { } export namespace AttachDiskResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: AttachDiskResult): any => ({ ...obj, }); @@ -923,6 +983,9 @@ export interface AttachedDisk { } export namespace AttachedDisk { + /** + * @internal + */ export const filterSensitiveLog = (obj: AttachedDisk): any => ({ ...obj, }); @@ -945,6 +1008,9 @@ export interface DiskMap { } export namespace DiskMap { + /** + * @internal + */ export const filterSensitiveLog = (obj: DiskMap): any => ({ ...obj, }); @@ -969,6 +1035,9 @@ export interface AttachInstancesToLoadBalancerRequest { } export namespace AttachInstancesToLoadBalancerRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: AttachInstancesToLoadBalancerRequest): any => ({ ...obj, }); @@ -983,6 +1052,9 @@ export interface AttachInstancesToLoadBalancerResult { } export namespace AttachInstancesToLoadBalancerResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: AttachInstancesToLoadBalancerResult): any => ({ ...obj, }); @@ -1002,6 +1074,9 @@ export interface AttachLoadBalancerTlsCertificateRequest { } export namespace AttachLoadBalancerTlsCertificateRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: AttachLoadBalancerTlsCertificateRequest): any => ({ ...obj, }); @@ -1018,6 +1093,9 @@ export interface AttachLoadBalancerTlsCertificateResult { } export namespace AttachLoadBalancerTlsCertificateResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: AttachLoadBalancerTlsCertificateResult): any => ({ ...obj, }); @@ -1036,6 +1114,9 @@ export interface AttachStaticIpRequest { } export namespace AttachStaticIpRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: AttachStaticIpRequest): any => ({ ...obj, }); @@ -1050,6 +1131,9 @@ export interface AttachStaticIpResult { } export namespace AttachStaticIpResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: AttachStaticIpResult): any => ({ ...obj, }); @@ -1089,6 +1173,9 @@ export interface AutoSnapshotDetails { } export namespace AutoSnapshotDetails { + /** + * @internal + */ export const filterSensitiveLog = (obj: AutoSnapshotDetails): any => ({ ...obj, }); @@ -1111,6 +1198,9 @@ export interface AvailabilityZone { } export namespace AvailabilityZone { + /** + * @internal + */ export const filterSensitiveLog = (obj: AvailabilityZone): any => ({ ...obj, }); @@ -1206,6 +1296,9 @@ export interface Blueprint { } export namespace Blueprint { + /** + * @internal + */ export const filterSensitiveLog = (obj: Blueprint): any => ({ ...obj, }); @@ -1280,6 +1373,9 @@ export interface Bundle { } export namespace Bundle { + /** + * @internal + */ export const filterSensitiveLog = (obj: Bundle): any => ({ ...obj, }); @@ -1321,6 +1417,9 @@ export interface CacheBehavior { } export namespace CacheBehavior { + /** + * @internal + */ export const filterSensitiveLog = (obj: CacheBehavior): any => ({ ...obj, }); @@ -1411,6 +1510,9 @@ export interface CacheBehaviorPerPath { } export namespace CacheBehaviorPerPath { + /** + * @internal + */ export const filterSensitiveLog = (obj: CacheBehaviorPerPath): any => ({ ...obj, }); @@ -1444,6 +1546,9 @@ export interface CookieObject { } export namespace CookieObject { + /** + * @internal + */ export const filterSensitiveLog = (obj: CookieObject): any => ({ ...obj, }); @@ -1516,6 +1621,9 @@ export interface HeaderObject { } export namespace HeaderObject { + /** + * @internal + */ export const filterSensitiveLog = (obj: HeaderObject): any => ({ ...obj, }); @@ -1545,6 +1653,9 @@ export interface QueryStringObject { } export namespace QueryStringObject { + /** + * @internal + */ export const filterSensitiveLog = (obj: QueryStringObject): any => ({ ...obj, }); @@ -1654,6 +1765,9 @@ export interface CacheSettings { } export namespace CacheSettings { + /** + * @internal + */ export const filterSensitiveLog = (obj: CacheSettings): any => ({ ...obj, }); @@ -1681,6 +1795,9 @@ export interface ResourceRecord { } export namespace ResourceRecord { + /** + * @internal + */ export const filterSensitiveLog = (obj: ResourceRecord): any => ({ ...obj, }); @@ -1704,6 +1821,9 @@ export interface DomainValidationRecord { } export namespace DomainValidationRecord { + /** + * @internal + */ export const filterSensitiveLog = (obj: DomainValidationRecord): any => ({ ...obj, }); @@ -1780,6 +1900,9 @@ export interface RenewalSummary { } export namespace RenewalSummary { + /** + * @internal + */ export const filterSensitiveLog = (obj: RenewalSummary): any => ({ ...obj, }); @@ -1817,6 +1940,9 @@ export interface Tag { } export namespace Tag { + /** + * @internal + */ export const filterSensitiveLog = (obj: Tag): any => ({ ...obj, }); @@ -2009,6 +2135,9 @@ export interface Certificate { } export namespace Certificate { + /** + * @internal + */ export const filterSensitiveLog = (obj: Certificate): any => ({ ...obj, }); @@ -2047,6 +2176,9 @@ export interface CertificateSummary { } export namespace CertificateSummary { + /** + * @internal + */ export const filterSensitiveLog = (obj: CertificateSummary): any => ({ ...obj, }); @@ -2195,6 +2327,9 @@ export interface PortInfo { } export namespace PortInfo { + /** + * @internal + */ export const filterSensitiveLog = (obj: PortInfo): any => ({ ...obj, }); @@ -2213,6 +2348,9 @@ export interface CloseInstancePublicPortsRequest { } export namespace CloseInstancePublicPortsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: CloseInstancePublicPortsRequest): any => ({ ...obj, }); @@ -2227,6 +2365,9 @@ export interface CloseInstancePublicPortsResult { } export namespace CloseInstancePublicPortsResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: CloseInstancePublicPortsResult): any => ({ ...obj, }); @@ -2248,6 +2389,9 @@ export interface DestinationInfo { } export namespace DestinationInfo { + /** + * @internal + */ export const filterSensitiveLog = (obj: DestinationInfo): any => ({ ...obj, }); @@ -2279,6 +2423,9 @@ export interface CloudFormationStackRecordSourceInfo { } export namespace CloudFormationStackRecordSourceInfo { + /** + * @internal + */ export const filterSensitiveLog = (obj: CloudFormationStackRecordSourceInfo): any => ({ ...obj, }); @@ -2342,6 +2489,9 @@ export interface CloudFormationStackRecord { } export namespace CloudFormationStackRecord { + /** + * @internal + */ export const filterSensitiveLog = (obj: CloudFormationStackRecord): any => ({ ...obj, }); @@ -2425,6 +2575,9 @@ export interface ContactMethod { } export namespace ContactMethod { + /** + * @internal + */ export const filterSensitiveLog = (obj: ContactMethod): any => ({ ...obj, }); @@ -2474,6 +2627,9 @@ export interface Container { } export namespace Container { + /** + * @internal + */ export const filterSensitiveLog = (obj: Container): any => ({ ...obj, }); @@ -2501,6 +2657,9 @@ export interface ContainerImage { } export namespace ContainerImage { + /** + * @internal + */ export const filterSensitiveLog = (obj: ContainerImage): any => ({ ...obj, }); @@ -2548,6 +2707,9 @@ export interface ContainerServiceHealthCheckConfig { } export namespace ContainerServiceHealthCheckConfig { + /** + * @internal + */ export const filterSensitiveLog = (obj: ContainerServiceHealthCheckConfig): any => ({ ...obj, }); @@ -2576,6 +2738,9 @@ export interface ContainerServiceEndpoint { } export namespace ContainerServiceEndpoint { + /** + * @internal + */ export const filterSensitiveLog = (obj: ContainerServiceEndpoint): any => ({ ...obj, }); @@ -2648,6 +2813,9 @@ export interface ContainerServiceDeployment { } export namespace ContainerServiceDeployment { + /** + * @internal + */ export const filterSensitiveLog = (obj: ContainerServiceDeployment): any => ({ ...obj, }); @@ -2764,6 +2932,9 @@ export interface ContainerServiceStateDetail { } export namespace ContainerServiceStateDetail { + /** + * @internal + */ export const filterSensitiveLog = (obj: ContainerServiceStateDetail): any => ({ ...obj, }); @@ -2945,6 +3116,9 @@ export interface ContainerService { } export namespace ContainerService { + /** + * @internal + */ export const filterSensitiveLog = (obj: ContainerService): any => ({ ...obj, }); @@ -2972,6 +3146,9 @@ export interface EndpointRequest { } export namespace EndpointRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: EndpointRequest): any => ({ ...obj, }); @@ -2997,6 +3174,9 @@ export interface ContainerServiceDeploymentRequest { } export namespace ContainerServiceDeploymentRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ContainerServiceDeploymentRequest): any => ({ ...obj, }); @@ -3018,6 +3198,9 @@ export interface ContainerServiceLogEvent { } export namespace ContainerServiceLogEvent { + /** + * @internal + */ export const filterSensitiveLog = (obj: ContainerServiceLogEvent): any => ({ ...obj, }); @@ -3069,6 +3252,9 @@ export interface ContainerServicePower { } export namespace ContainerServicePower { + /** + * @internal + */ export const filterSensitiveLog = (obj: ContainerServicePower): any => ({ ...obj, }); @@ -3108,6 +3294,9 @@ export interface ContainerServiceRegistryLogin { } export namespace ContainerServiceRegistryLogin { + /** + * @internal + */ export const filterSensitiveLog = (obj: ContainerServiceRegistryLogin): any => ({ ...obj, }); @@ -3121,6 +3310,9 @@ export interface ContainerServicesListResult { } export namespace ContainerServicesListResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: ContainerServicesListResult): any => ({ ...obj, }); @@ -3203,6 +3395,9 @@ export interface CopySnapshotRequest { } export namespace CopySnapshotRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: CopySnapshotRequest): any => ({ ...obj, }); @@ -3217,6 +3412,9 @@ export interface CopySnapshotResult { } export namespace CopySnapshotResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: CopySnapshotResult): any => ({ ...obj, }); @@ -3250,6 +3448,9 @@ export interface CreateCertificateRequest { } export namespace CreateCertificateRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateCertificateRequest): any => ({ ...obj, }); @@ -3269,6 +3470,9 @@ export interface CreateCertificateResult { } export namespace CreateCertificateResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateCertificateResult): any => ({ ...obj, }); @@ -3358,6 +3562,9 @@ export interface InstanceEntry { } export namespace InstanceEntry { + /** + * @internal + */ export const filterSensitiveLog = (obj: InstanceEntry): any => ({ ...obj, }); @@ -3373,6 +3580,9 @@ export interface CreateCloudFormationStackRequest { } export namespace CreateCloudFormationStackRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateCloudFormationStackRequest): any => ({ ...obj, }); @@ -3387,6 +3597,9 @@ export interface CreateCloudFormationStackResult { } export namespace CreateCloudFormationStackResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateCloudFormationStackResult): any => ({ ...obj, }); @@ -3437,6 +3650,9 @@ export interface CreateContactMethodRequest { } export namespace CreateContactMethodRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateContactMethodRequest): any => ({ ...obj, }); @@ -3451,6 +3667,9 @@ export interface CreateContactMethodResult { } export namespace CreateContactMethodResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateContactMethodResult): any => ({ ...obj, }); @@ -3556,6 +3775,9 @@ export interface CreateContainerServiceRequest { } export namespace CreateContainerServiceRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateContainerServiceRequest): any => ({ ...obj, }); @@ -3569,6 +3791,9 @@ export interface CreateContainerServiceResult { } export namespace CreateContainerServiceResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateContainerServiceResult): any => ({ ...obj, }); @@ -3594,6 +3819,9 @@ export interface CreateContainerServiceDeploymentRequest { } export namespace CreateContainerServiceDeploymentRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateContainerServiceDeploymentRequest): any => ({ ...obj, }); @@ -3607,6 +3835,9 @@ export interface CreateContainerServiceDeploymentResult { } export namespace CreateContainerServiceDeploymentResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateContainerServiceDeploymentResult): any => ({ ...obj, }); @@ -3615,6 +3846,9 @@ export namespace CreateContainerServiceDeploymentResult { export interface CreateContainerServiceRegistryLoginRequest {} export namespace CreateContainerServiceRegistryLoginRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateContainerServiceRegistryLoginRequest): any => ({ ...obj, }); @@ -3629,6 +3863,9 @@ export interface CreateContainerServiceRegistryLoginResult { } export namespace CreateContainerServiceRegistryLoginResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateContainerServiceRegistryLoginResult): any => ({ ...obj, }); @@ -3667,6 +3904,9 @@ export interface CreateDiskRequest { } export namespace CreateDiskRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateDiskRequest): any => ({ ...obj, }); @@ -3681,6 +3921,9 @@ export interface CreateDiskResult { } export namespace CreateDiskResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateDiskResult): any => ({ ...obj, }); @@ -3789,6 +4032,9 @@ export interface CreateDiskFromSnapshotRequest { } export namespace CreateDiskFromSnapshotRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateDiskFromSnapshotRequest): any => ({ ...obj, }); @@ -3803,6 +4049,9 @@ export interface CreateDiskFromSnapshotResult { } export namespace CreateDiskFromSnapshotResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateDiskFromSnapshotResult): any => ({ ...obj, }); @@ -3844,6 +4093,9 @@ export interface CreateDiskSnapshotRequest { } export namespace CreateDiskSnapshotRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateDiskSnapshotRequest): any => ({ ...obj, }); @@ -3858,6 +4110,9 @@ export interface CreateDiskSnapshotResult { } export namespace CreateDiskSnapshotResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateDiskSnapshotResult): any => ({ ...obj, }); @@ -3899,6 +4154,9 @@ export interface InputOrigin { } export namespace InputOrigin { + /** + * @internal + */ export const filterSensitiveLog = (obj: InputOrigin): any => ({ ...obj, }); @@ -3959,6 +4217,9 @@ export interface CreateDistributionRequest { } export namespace CreateDistributionRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateDistributionRequest): any => ({ ...obj, }); @@ -3995,6 +4256,9 @@ export interface Origin { } export namespace Origin { + /** + * @internal + */ export const filterSensitiveLog = (obj: Origin): any => ({ ...obj, }); @@ -4124,6 +4388,9 @@ export interface LightsailDistribution { } export namespace LightsailDistribution { + /** + * @internal + */ export const filterSensitiveLog = (obj: LightsailDistribution): any => ({ ...obj, }); @@ -4143,6 +4410,9 @@ export interface CreateDistributionResult { } export namespace CreateDistributionResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateDistributionResult): any => ({ ...obj, }); @@ -4168,6 +4438,9 @@ export interface CreateDomainRequest { } export namespace CreateDomainRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateDomainRequest): any => ({ ...obj, }); @@ -4182,6 +4455,9 @@ export interface CreateDomainResult { } export namespace CreateDomainResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateDomainResult): any => ({ ...obj, }); @@ -4274,6 +4550,9 @@ export interface DomainEntry { } export namespace DomainEntry { + /** + * @internal + */ export const filterSensitiveLog = (obj: DomainEntry): any => ({ ...obj, }); @@ -4293,6 +4572,9 @@ export interface CreateDomainEntryRequest { } export namespace CreateDomainEntryRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateDomainEntryRequest): any => ({ ...obj, }); @@ -4307,6 +4589,9 @@ export interface CreateDomainEntryResult { } export namespace CreateDomainEntryResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateDomainEntryResult): any => ({ ...obj, }); @@ -4401,6 +4686,9 @@ export interface CreateInstancesRequest { } export namespace CreateInstancesRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateInstancesRequest): any => ({ ...obj, }); @@ -4415,6 +4703,9 @@ export interface CreateInstancesResult { } export namespace CreateInstancesResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateInstancesResult): any => ({ ...obj, }); @@ -4558,6 +4849,9 @@ export interface CreateInstancesFromSnapshotRequest { } export namespace CreateInstancesFromSnapshotRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateInstancesFromSnapshotRequest): any => ({ ...obj, }); @@ -4572,6 +4866,9 @@ export interface CreateInstancesFromSnapshotResult { } export namespace CreateInstancesFromSnapshotResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateInstancesFromSnapshotResult): any => ({ ...obj, }); @@ -4596,6 +4893,9 @@ export interface CreateInstanceSnapshotRequest { } export namespace CreateInstanceSnapshotRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateInstanceSnapshotRequest): any => ({ ...obj, }); @@ -4610,6 +4910,9 @@ export interface CreateInstanceSnapshotResult { } export namespace CreateInstanceSnapshotResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateInstanceSnapshotResult): any => ({ ...obj, }); @@ -4629,6 +4932,9 @@ export interface CreateKeyPairRequest { } export namespace CreateKeyPairRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateKeyPairRequest): any => ({ ...obj, }); @@ -4685,6 +4991,9 @@ export interface KeyPair { } export namespace KeyPair { + /** + * @internal + */ export const filterSensitiveLog = (obj: KeyPair): any => ({ ...obj, }); @@ -4715,6 +5024,9 @@ export interface CreateKeyPairResult { } export namespace CreateKeyPairResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateKeyPairResult): any => ({ ...obj, }); @@ -4780,6 +5092,9 @@ export interface CreateLoadBalancerRequest { } export namespace CreateLoadBalancerRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateLoadBalancerRequest): any => ({ ...obj, }); @@ -4794,6 +5109,9 @@ export interface CreateLoadBalancerResult { } export namespace CreateLoadBalancerResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateLoadBalancerResult): any => ({ ...obj, }); @@ -4835,6 +5153,9 @@ export interface CreateLoadBalancerTlsCertificateRequest { } export namespace CreateLoadBalancerTlsCertificateRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateLoadBalancerTlsCertificateRequest): any => ({ ...obj, }); @@ -4849,6 +5170,9 @@ export interface CreateLoadBalancerTlsCertificateResult { } export namespace CreateLoadBalancerTlsCertificateResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateLoadBalancerTlsCertificateResult): any => ({ ...obj, }); @@ -5073,6 +5397,9 @@ export interface CreateRelationalDatabaseRequest { } export namespace CreateRelationalDatabaseRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateRelationalDatabaseRequest): any => ({ ...obj, ...(obj.masterUserPassword && { masterUserPassword: SENSITIVE_STRING }), @@ -5088,6 +5415,9 @@ export interface CreateRelationalDatabaseResult { } export namespace CreateRelationalDatabaseResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateRelationalDatabaseResult): any => ({ ...obj, }); @@ -5186,6 +5516,9 @@ export interface CreateRelationalDatabaseFromSnapshotRequest { } export namespace CreateRelationalDatabaseFromSnapshotRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateRelationalDatabaseFromSnapshotRequest): any => ({ ...obj, }); @@ -5200,6 +5533,9 @@ export interface CreateRelationalDatabaseFromSnapshotResult { } export namespace CreateRelationalDatabaseFromSnapshotResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateRelationalDatabaseFromSnapshotResult): any => ({ ...obj, }); @@ -5233,6 +5569,9 @@ export interface CreateRelationalDatabaseSnapshotRequest { } export namespace CreateRelationalDatabaseSnapshotRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateRelationalDatabaseSnapshotRequest): any => ({ ...obj, }); @@ -5247,6 +5586,9 @@ export interface CreateRelationalDatabaseSnapshotResult { } export namespace CreateRelationalDatabaseSnapshotResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateRelationalDatabaseSnapshotResult): any => ({ ...obj, }); @@ -5260,6 +5602,9 @@ export interface DeleteAlarmRequest { } export namespace DeleteAlarmRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteAlarmRequest): any => ({ ...obj, }); @@ -5274,6 +5619,9 @@ export interface DeleteAlarmResult { } export namespace DeleteAlarmResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteAlarmResult): any => ({ ...obj, }); @@ -5295,6 +5643,9 @@ export interface DeleteAutoSnapshotRequest { } export namespace DeleteAutoSnapshotRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteAutoSnapshotRequest): any => ({ ...obj, }); @@ -5309,6 +5660,9 @@ export interface DeleteAutoSnapshotResult { } export namespace DeleteAutoSnapshotResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteAutoSnapshotResult): any => ({ ...obj, }); @@ -5324,6 +5678,9 @@ export interface DeleteCertificateRequest { } export namespace DeleteCertificateRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteCertificateRequest): any => ({ ...obj, }); @@ -5338,6 +5695,9 @@ export interface DeleteCertificateResult { } export namespace DeleteCertificateResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteCertificateResult): any => ({ ...obj, }); @@ -5357,6 +5717,9 @@ export interface DeleteContactMethodRequest { } export namespace DeleteContactMethodRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteContactMethodRequest): any => ({ ...obj, }); @@ -5371,6 +5734,9 @@ export interface DeleteContactMethodResult { } export namespace DeleteContactMethodResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteContactMethodResult): any => ({ ...obj, }); @@ -5400,6 +5766,9 @@ export interface DeleteContainerImageRequest { } export namespace DeleteContainerImageRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteContainerImageRequest): any => ({ ...obj, }); @@ -5408,6 +5777,9 @@ export namespace DeleteContainerImageRequest { export interface DeleteContainerImageResult {} export namespace DeleteContainerImageResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteContainerImageResult): any => ({ ...obj, }); @@ -5421,6 +5793,9 @@ export interface DeleteContainerServiceRequest { } export namespace DeleteContainerServiceRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteContainerServiceRequest): any => ({ ...obj, }); @@ -5429,6 +5804,9 @@ export namespace DeleteContainerServiceRequest { export interface DeleteContainerServiceResult {} export namespace DeleteContainerServiceResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteContainerServiceResult): any => ({ ...obj, }); @@ -5447,6 +5825,9 @@ export interface DeleteDiskRequest { } export namespace DeleteDiskRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteDiskRequest): any => ({ ...obj, }); @@ -5461,6 +5842,9 @@ export interface DeleteDiskResult { } export namespace DeleteDiskResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteDiskResult): any => ({ ...obj, }); @@ -5475,6 +5859,9 @@ export interface DeleteDiskSnapshotRequest { } export namespace DeleteDiskSnapshotRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteDiskSnapshotRequest): any => ({ ...obj, }); @@ -5489,6 +5876,9 @@ export interface DeleteDiskSnapshotResult { } export namespace DeleteDiskSnapshotResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteDiskSnapshotResult): any => ({ ...obj, }); @@ -5504,6 +5894,9 @@ export interface DeleteDistributionRequest { } export namespace DeleteDistributionRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteDistributionRequest): any => ({ ...obj, }); @@ -5518,6 +5911,9 @@ export interface DeleteDistributionResult { } export namespace DeleteDistributionResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteDistributionResult): any => ({ ...obj, }); @@ -5531,6 +5927,9 @@ export interface DeleteDomainRequest { } export namespace DeleteDomainRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteDomainRequest): any => ({ ...obj, }); @@ -5545,6 +5944,9 @@ export interface DeleteDomainResult { } export namespace DeleteDomainResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteDomainResult): any => ({ ...obj, }); @@ -5563,6 +5965,9 @@ export interface DeleteDomainEntryRequest { } export namespace DeleteDomainEntryRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteDomainEntryRequest): any => ({ ...obj, }); @@ -5577,6 +5982,9 @@ export interface DeleteDomainEntryResult { } export namespace DeleteDomainEntryResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteDomainEntryResult): any => ({ ...obj, }); @@ -5595,6 +6003,9 @@ export interface DeleteInstanceRequest { } export namespace DeleteInstanceRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteInstanceRequest): any => ({ ...obj, }); @@ -5609,6 +6020,9 @@ export interface DeleteInstanceResult { } export namespace DeleteInstanceResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteInstanceResult): any => ({ ...obj, }); @@ -5622,6 +6036,9 @@ export interface DeleteInstanceSnapshotRequest { } export namespace DeleteInstanceSnapshotRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteInstanceSnapshotRequest): any => ({ ...obj, }); @@ -5636,6 +6053,9 @@ export interface DeleteInstanceSnapshotResult { } export namespace DeleteInstanceSnapshotResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteInstanceSnapshotResult): any => ({ ...obj, }); @@ -5649,6 +6069,9 @@ export interface DeleteKeyPairRequest { } export namespace DeleteKeyPairRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteKeyPairRequest): any => ({ ...obj, }); @@ -5663,6 +6086,9 @@ export interface DeleteKeyPairResult { } export namespace DeleteKeyPairResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteKeyPairResult): any => ({ ...obj, }); @@ -5676,6 +6102,9 @@ export interface DeleteKnownHostKeysRequest { } export namespace DeleteKnownHostKeysRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteKnownHostKeysRequest): any => ({ ...obj, }); @@ -5690,6 +6119,9 @@ export interface DeleteKnownHostKeysResult { } export namespace DeleteKnownHostKeysResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteKnownHostKeysResult): any => ({ ...obj, }); @@ -5703,6 +6135,9 @@ export interface DeleteLoadBalancerRequest { } export namespace DeleteLoadBalancerRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteLoadBalancerRequest): any => ({ ...obj, }); @@ -5717,6 +6152,9 @@ export interface DeleteLoadBalancerResult { } export namespace DeleteLoadBalancerResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteLoadBalancerResult): any => ({ ...obj, }); @@ -5743,6 +6181,9 @@ export interface DeleteLoadBalancerTlsCertificateRequest { } export namespace DeleteLoadBalancerTlsCertificateRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteLoadBalancerTlsCertificateRequest): any => ({ ...obj, }); @@ -5757,6 +6198,9 @@ export interface DeleteLoadBalancerTlsCertificateResult { } export namespace DeleteLoadBalancerTlsCertificateResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteLoadBalancerTlsCertificateResult): any => ({ ...obj, }); @@ -5800,6 +6244,9 @@ export interface DeleteRelationalDatabaseRequest { } export namespace DeleteRelationalDatabaseRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteRelationalDatabaseRequest): any => ({ ...obj, }); @@ -5814,6 +6261,9 @@ export interface DeleteRelationalDatabaseResult { } export namespace DeleteRelationalDatabaseResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteRelationalDatabaseResult): any => ({ ...obj, }); @@ -5827,6 +6277,9 @@ export interface DeleteRelationalDatabaseSnapshotRequest { } export namespace DeleteRelationalDatabaseSnapshotRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteRelationalDatabaseSnapshotRequest): any => ({ ...obj, }); @@ -5841,6 +6294,9 @@ export interface DeleteRelationalDatabaseSnapshotResult { } export namespace DeleteRelationalDatabaseSnapshotResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteRelationalDatabaseSnapshotResult): any => ({ ...obj, }); @@ -5856,6 +6312,9 @@ export interface DetachCertificateFromDistributionRequest { } export namespace DetachCertificateFromDistributionRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DetachCertificateFromDistributionRequest): any => ({ ...obj, }); @@ -5870,6 +6329,9 @@ export interface DetachCertificateFromDistributionResult { } export namespace DetachCertificateFromDistributionResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: DetachCertificateFromDistributionResult): any => ({ ...obj, }); @@ -5884,6 +6346,9 @@ export interface DetachDiskRequest { } export namespace DetachDiskRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DetachDiskRequest): any => ({ ...obj, }); @@ -5898,6 +6363,9 @@ export interface DetachDiskResult { } export namespace DetachDiskResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: DetachDiskResult): any => ({ ...obj, }); @@ -5917,6 +6385,9 @@ export interface DetachInstancesFromLoadBalancerRequest { } export namespace DetachInstancesFromLoadBalancerRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DetachInstancesFromLoadBalancerRequest): any => ({ ...obj, }); @@ -5931,6 +6402,9 @@ export interface DetachInstancesFromLoadBalancerResult { } export namespace DetachInstancesFromLoadBalancerResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: DetachInstancesFromLoadBalancerResult): any => ({ ...obj, }); @@ -5944,6 +6418,9 @@ export interface DetachStaticIpRequest { } export namespace DetachStaticIpRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DetachStaticIpRequest): any => ({ ...obj, }); @@ -5958,6 +6435,9 @@ export interface DetachStaticIpResult { } export namespace DetachStaticIpResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: DetachStaticIpResult): any => ({ ...obj, }); @@ -5976,6 +6456,9 @@ export interface DisableAddOnRequest { } export namespace DisableAddOnRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DisableAddOnRequest): any => ({ ...obj, }); @@ -5990,6 +6473,9 @@ export interface DisableAddOnResult { } export namespace DisableAddOnResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: DisableAddOnResult): any => ({ ...obj, }); @@ -6112,6 +6598,9 @@ export interface Disk { } export namespace Disk { + /** + * @internal + */ export const filterSensitiveLog = (obj: Disk): any => ({ ...obj, }); @@ -6144,6 +6633,9 @@ export interface DiskInfo { } export namespace DiskInfo { + /** + * @internal + */ export const filterSensitiveLog = (obj: DiskInfo): any => ({ ...obj, }); @@ -6245,6 +6737,9 @@ export interface DiskSnapshot { } export namespace DiskSnapshot { + /** + * @internal + */ export const filterSensitiveLog = (obj: DiskSnapshot): any => ({ ...obj, }); @@ -6261,6 +6756,9 @@ export interface DiskSnapshotInfo { } export namespace DiskSnapshotInfo { + /** + * @internal + */ export const filterSensitiveLog = (obj: DiskSnapshotInfo): any => ({ ...obj, }); @@ -6298,6 +6796,9 @@ export interface DistributionBundle { } export namespace DistributionBundle { + /** + * @internal + */ export const filterSensitiveLog = (obj: DistributionBundle): any => ({ ...obj, }); @@ -6363,6 +6864,9 @@ export interface Domain { } export namespace Domain { + /** + * @internal + */ export const filterSensitiveLog = (obj: Domain): any => ({ ...obj, }); @@ -6371,6 +6875,9 @@ export namespace Domain { export interface DownloadDefaultKeyPairRequest {} export namespace DownloadDefaultKeyPairRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DownloadDefaultKeyPairRequest): any => ({ ...obj, }); @@ -6389,6 +6896,9 @@ export interface DownloadDefaultKeyPairResult { } export namespace DownloadDefaultKeyPairResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: DownloadDefaultKeyPairResult): any => ({ ...obj, }); @@ -6407,6 +6917,9 @@ export interface EnableAddOnRequest { } export namespace EnableAddOnRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: EnableAddOnRequest): any => ({ ...obj, }); @@ -6421,6 +6934,9 @@ export interface EnableAddOnResult { } export namespace EnableAddOnResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: EnableAddOnResult): any => ({ ...obj, }); @@ -6434,6 +6950,9 @@ export interface ExportSnapshotRequest { } export namespace ExportSnapshotRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ExportSnapshotRequest): any => ({ ...obj, }); @@ -6448,6 +6967,9 @@ export interface ExportSnapshotResult { } export namespace ExportSnapshotResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: ExportSnapshotResult): any => ({ ...obj, }); @@ -6475,6 +6997,9 @@ export interface InstanceSnapshotInfo { } export namespace InstanceSnapshotInfo { + /** + * @internal + */ export const filterSensitiveLog = (obj: InstanceSnapshotInfo): any => ({ ...obj, }); @@ -6532,6 +7057,9 @@ export interface ExportSnapshotRecordSourceInfo { } export namespace ExportSnapshotRecordSourceInfo { + /** + * @internal + */ export const filterSensitiveLog = (obj: ExportSnapshotRecordSourceInfo): any => ({ ...obj, }); @@ -6583,6 +7111,9 @@ export interface ExportSnapshotRecord { } export namespace ExportSnapshotRecord { + /** + * @internal + */ export const filterSensitiveLog = (obj: ExportSnapshotRecord): any => ({ ...obj, }); @@ -6599,6 +7130,9 @@ export interface GetActiveNamesRequest { } export namespace GetActiveNamesRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetActiveNamesRequest): any => ({ ...obj, }); @@ -6620,6 +7154,9 @@ export interface GetActiveNamesResult { } export namespace GetActiveNamesResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetActiveNamesResult): any => ({ ...obj, }); @@ -6649,6 +7186,9 @@ export interface GetAlarmsRequest { } export namespace GetAlarmsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetAlarmsRequest): any => ({ ...obj, }); @@ -6670,6 +7210,9 @@ export interface GetAlarmsResult { } export namespace GetAlarmsResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetAlarmsResult): any => ({ ...obj, }); @@ -6684,6 +7227,9 @@ export interface GetAutoSnapshotsRequest { } export namespace GetAutoSnapshotsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetAutoSnapshotsRequest): any => ({ ...obj, }); @@ -6708,6 +7254,9 @@ export interface GetAutoSnapshotsResult { } export namespace GetAutoSnapshotsResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetAutoSnapshotsResult): any => ({ ...obj, }); @@ -6729,6 +7278,9 @@ export interface GetBlueprintsRequest { } export namespace GetBlueprintsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetBlueprintsRequest): any => ({ ...obj, }); @@ -6751,6 +7303,9 @@ export interface GetBlueprintsResult { } export namespace GetBlueprintsResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetBlueprintsResult): any => ({ ...obj, }); @@ -6773,6 +7328,9 @@ export interface GetBundlesRequest { } export namespace GetBundlesRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetBundlesRequest): any => ({ ...obj, }); @@ -6794,6 +7352,9 @@ export interface GetBundlesResult { } export namespace GetBundlesResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetBundlesResult): any => ({ ...obj, }); @@ -6826,6 +7387,9 @@ export interface GetCertificatesRequest { } export namespace GetCertificatesRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetCertificatesRequest): any => ({ ...obj, }); @@ -6839,6 +7403,9 @@ export interface GetCertificatesResult { } export namespace GetCertificatesResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetCertificatesResult): any => ({ ...obj, }); @@ -6855,6 +7422,9 @@ export interface GetCloudFormationStackRecordsRequest { } export namespace GetCloudFormationStackRecordsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetCloudFormationStackRecordsRequest): any => ({ ...obj, }); @@ -6877,6 +7447,9 @@ export interface GetCloudFormationStackRecordsResult { } export namespace GetCloudFormationStackRecordsResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetCloudFormationStackRecordsResult): any => ({ ...obj, }); @@ -6893,6 +7466,9 @@ export interface GetContactMethodsRequest { } export namespace GetContactMethodsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetContactMethodsRequest): any => ({ ...obj, }); @@ -6906,6 +7482,9 @@ export interface GetContactMethodsResult { } export namespace GetContactMethodsResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetContactMethodsResult): any => ({ ...obj, }); @@ -6914,6 +7493,9 @@ export namespace GetContactMethodsResult { export interface GetContainerAPIMetadataRequest {} export namespace GetContainerAPIMetadataRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetContainerAPIMetadataRequest): any => ({ ...obj, }); @@ -6928,6 +7510,9 @@ export interface GetContainerAPIMetadataResult { } export namespace GetContainerAPIMetadataResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetContainerAPIMetadataResult): any => ({ ...obj, }); @@ -6941,6 +7526,9 @@ export interface GetContainerImagesRequest { } export namespace GetContainerImagesRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetContainerImagesRequest): any => ({ ...obj, }); @@ -6955,6 +7543,9 @@ export interface GetContainerImagesResult { } export namespace GetContainerImagesResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetContainerImagesResult): any => ({ ...obj, }); @@ -7055,6 +7646,9 @@ export interface GetContainerLogRequest { } export namespace GetContainerLogRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetContainerLogRequest): any => ({ ...obj, }); @@ -7078,6 +7672,9 @@ export interface GetContainerLogResult { } export namespace GetContainerLogResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetContainerLogResult): any => ({ ...obj, }); @@ -7091,6 +7688,9 @@ export interface GetContainerServiceDeploymentsRequest { } export namespace GetContainerServiceDeploymentsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetContainerServiceDeploymentsRequest): any => ({ ...obj, }); @@ -7104,6 +7704,9 @@ export interface GetContainerServiceDeploymentsResult { } export namespace GetContainerServiceDeploymentsResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetContainerServiceDeploymentsResult): any => ({ ...obj, }); @@ -7202,6 +7805,9 @@ export interface GetContainerServiceMetricDataRequest { } export namespace GetContainerServiceMetricDataRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetContainerServiceMetricDataRequest): any => ({ ...obj, }); @@ -7248,6 +7854,9 @@ export interface MetricDatapoint { } export namespace MetricDatapoint { + /** + * @internal + */ export const filterSensitiveLog = (obj: MetricDatapoint): any => ({ ...obj, }); @@ -7266,6 +7875,9 @@ export interface GetContainerServiceMetricDataResult { } export namespace GetContainerServiceMetricDataResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetContainerServiceMetricDataResult): any => ({ ...obj, }); @@ -7274,6 +7886,9 @@ export namespace GetContainerServiceMetricDataResult { export interface GetContainerServicePowersRequest {} export namespace GetContainerServicePowersRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetContainerServicePowersRequest): any => ({ ...obj, }); @@ -7288,6 +7903,9 @@ export interface GetContainerServicePowersResult { } export namespace GetContainerServicePowersResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetContainerServicePowersResult): any => ({ ...obj, }); @@ -7304,6 +7922,9 @@ export interface GetContainerServicesRequest { } export namespace GetContainerServicesRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetContainerServicesRequest): any => ({ ...obj, }); @@ -7317,6 +7938,9 @@ export interface GetDiskRequest { } export namespace GetDiskRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetDiskRequest): any => ({ ...obj, }); @@ -7330,6 +7954,9 @@ export interface GetDiskResult { } export namespace GetDiskResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetDiskResult): any => ({ ...obj, }); @@ -7346,6 +7973,9 @@ export interface GetDisksRequest { } export namespace GetDisksRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetDisksRequest): any => ({ ...obj, }); @@ -7367,6 +7997,9 @@ export interface GetDisksResult { } export namespace GetDisksResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetDisksResult): any => ({ ...obj, }); @@ -7380,6 +8013,9 @@ export interface GetDiskSnapshotRequest { } export namespace GetDiskSnapshotRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetDiskSnapshotRequest): any => ({ ...obj, }); @@ -7393,6 +8029,9 @@ export interface GetDiskSnapshotResult { } export namespace GetDiskSnapshotResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetDiskSnapshotResult): any => ({ ...obj, }); @@ -7409,6 +8048,9 @@ export interface GetDiskSnapshotsRequest { } export namespace GetDiskSnapshotsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetDiskSnapshotsRequest): any => ({ ...obj, }); @@ -7430,6 +8072,9 @@ export interface GetDiskSnapshotsResult { } export namespace GetDiskSnapshotsResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetDiskSnapshotsResult): any => ({ ...obj, }); @@ -7438,6 +8083,9 @@ export namespace GetDiskSnapshotsResult { export interface GetDistributionBundlesRequest {} export namespace GetDistributionBundlesRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetDistributionBundlesRequest): any => ({ ...obj, }); @@ -7451,6 +8099,9 @@ export interface GetDistributionBundlesResult { } export namespace GetDistributionBundlesResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetDistributionBundlesResult): any => ({ ...obj, }); @@ -7469,6 +8120,9 @@ export interface GetDistributionLatestCacheResetRequest { } export namespace GetDistributionLatestCacheResetRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetDistributionLatestCacheResetRequest): any => ({ ...obj, }); @@ -7488,6 +8142,9 @@ export interface GetDistributionLatestCacheResetResult { } export namespace GetDistributionLatestCacheResetResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetDistributionLatestCacheResetResult): any => ({ ...obj, }); @@ -7666,6 +8323,9 @@ export interface GetDistributionMetricDataRequest { } export namespace GetDistributionMetricDataRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetDistributionMetricDataRequest): any => ({ ...obj, }); @@ -7684,6 +8344,9 @@ export interface GetDistributionMetricDataResult { } export namespace GetDistributionMetricDataResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetDistributionMetricDataResult): any => ({ ...obj, }); @@ -7709,6 +8372,9 @@ export interface GetDistributionsRequest { } export namespace GetDistributionsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetDistributionsRequest): any => ({ ...obj, }); @@ -7730,6 +8396,9 @@ export interface GetDistributionsResult { } export namespace GetDistributionsResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetDistributionsResult): any => ({ ...obj, }); @@ -7743,6 +8412,9 @@ export interface GetDomainRequest { } export namespace GetDomainRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetDomainRequest): any => ({ ...obj, }); @@ -7756,6 +8428,9 @@ export interface GetDomainResult { } export namespace GetDomainResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetDomainResult): any => ({ ...obj, }); @@ -7772,6 +8447,9 @@ export interface GetDomainsRequest { } export namespace GetDomainsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetDomainsRequest): any => ({ ...obj, }); @@ -7794,6 +8472,9 @@ export interface GetDomainsResult { } export namespace GetDomainsResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetDomainsResult): any => ({ ...obj, }); @@ -7810,6 +8491,9 @@ export interface GetExportSnapshotRecordsRequest { } export namespace GetExportSnapshotRecordsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetExportSnapshotRecordsRequest): any => ({ ...obj, }); @@ -7831,6 +8515,9 @@ export interface GetExportSnapshotRecordsResult { } export namespace GetExportSnapshotRecordsResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetExportSnapshotRecordsResult): any => ({ ...obj, }); @@ -7844,6 +8531,9 @@ export interface GetInstanceRequest { } export namespace GetInstanceRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetInstanceRequest): any => ({ ...obj, }); @@ -7870,6 +8560,9 @@ export interface InstanceHardware { } export namespace InstanceHardware { + /** + * @internal + */ export const filterSensitiveLog = (obj: InstanceHardware): any => ({ ...obj, }); @@ -7887,6 +8580,9 @@ export interface MonthlyTransfer { } export namespace MonthlyTransfer { + /** + * @internal + */ export const filterSensitiveLog = (obj: MonthlyTransfer): any => ({ ...obj, }); @@ -8045,6 +8741,9 @@ export interface InstancePortInfo { } export namespace InstancePortInfo { + /** + * @internal + */ export const filterSensitiveLog = (obj: InstancePortInfo): any => ({ ...obj, }); @@ -8066,6 +8765,9 @@ export interface InstanceNetworking { } export namespace InstanceNetworking { + /** + * @internal + */ export const filterSensitiveLog = (obj: InstanceNetworking): any => ({ ...obj, }); @@ -8087,6 +8789,9 @@ export interface InstanceState { } export namespace InstanceState { + /** + * @internal + */ export const filterSensitiveLog = (obj: InstanceState): any => ({ ...obj, }); @@ -8214,6 +8919,9 @@ export interface Instance { } export namespace Instance { + /** + * @internal + */ export const filterSensitiveLog = (obj: Instance): any => ({ ...obj, }); @@ -8227,6 +8935,9 @@ export interface GetInstanceResult { } export namespace GetInstanceResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetInstanceResult): any => ({ ...obj, }); @@ -8250,6 +8961,9 @@ export interface GetInstanceAccessDetailsRequest { } export namespace GetInstanceAccessDetailsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetInstanceAccessDetailsRequest): any => ({ ...obj, }); @@ -8329,6 +9043,9 @@ export interface HostKeyAttributes { } export namespace HostKeyAttributes { + /** + * @internal + */ export const filterSensitiveLog = (obj: HostKeyAttributes): any => ({ ...obj, }); @@ -8366,6 +9083,9 @@ export interface PasswordData { } export namespace PasswordData { + /** + * @internal + */ export const filterSensitiveLog = (obj: PasswordData): any => ({ ...obj, }); @@ -8443,6 +9163,9 @@ export interface InstanceAccessDetails { } export namespace InstanceAccessDetails { + /** + * @internal + */ export const filterSensitiveLog = (obj: InstanceAccessDetails): any => ({ ...obj, }); @@ -8457,6 +9180,9 @@ export interface GetInstanceAccessDetailsResult { } export namespace GetInstanceAccessDetailsResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetInstanceAccessDetailsResult): any => ({ ...obj, }); @@ -8668,6 +9394,9 @@ export interface GetInstanceMetricDataRequest { } export namespace GetInstanceMetricDataRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetInstanceMetricDataRequest): any => ({ ...obj, }); @@ -8686,6 +9415,9 @@ export interface GetInstanceMetricDataResult { } export namespace GetInstanceMetricDataResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetInstanceMetricDataResult): any => ({ ...obj, }); @@ -8699,6 +9431,9 @@ export interface GetInstancePortStatesRequest { } export namespace GetInstancePortStatesRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetInstancePortStatesRequest): any => ({ ...obj, }); @@ -8842,6 +9577,9 @@ export interface InstancePortState { } export namespace InstancePortState { + /** + * @internal + */ export const filterSensitiveLog = (obj: InstancePortState): any => ({ ...obj, }); @@ -8856,6 +9594,9 @@ export interface GetInstancePortStatesResult { } export namespace GetInstancePortStatesResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetInstancePortStatesResult): any => ({ ...obj, }); @@ -8872,6 +9613,9 @@ export interface GetInstancesRequest { } export namespace GetInstancesRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetInstancesRequest): any => ({ ...obj, }); @@ -8893,6 +9637,9 @@ export interface GetInstancesResult { } export namespace GetInstancesResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetInstancesResult): any => ({ ...obj, }); @@ -8906,6 +9653,9 @@ export interface GetInstanceSnapshotRequest { } export namespace GetInstanceSnapshotRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetInstanceSnapshotRequest): any => ({ ...obj, }); @@ -9016,6 +9766,9 @@ export interface InstanceSnapshot { } export namespace InstanceSnapshot { + /** + * @internal + */ export const filterSensitiveLog = (obj: InstanceSnapshot): any => ({ ...obj, }); @@ -9030,6 +9783,9 @@ export interface GetInstanceSnapshotResult { } export namespace GetInstanceSnapshotResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetInstanceSnapshotResult): any => ({ ...obj, }); @@ -9046,6 +9802,9 @@ export interface GetInstanceSnapshotsRequest { } export namespace GetInstanceSnapshotsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetInstanceSnapshotsRequest): any => ({ ...obj, }); @@ -9068,6 +9827,9 @@ export interface GetInstanceSnapshotsResult { } export namespace GetInstanceSnapshotsResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetInstanceSnapshotsResult): any => ({ ...obj, }); @@ -9081,6 +9843,9 @@ export interface GetInstanceStateRequest { } export namespace GetInstanceStateRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetInstanceStateRequest): any => ({ ...obj, }); @@ -9094,6 +9859,9 @@ export interface GetInstanceStateResult { } export namespace GetInstanceStateResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetInstanceStateResult): any => ({ ...obj, }); diff --git a/clients/client-lightsail/models/models_1.ts b/clients/client-lightsail/models/models_1.ts index 4a504152e4e9..13e59cf36b25 100644 --- a/clients/client-lightsail/models/models_1.ts +++ b/clients/client-lightsail/models/models_1.ts @@ -36,6 +36,9 @@ export interface GetKeyPairRequest { } export namespace GetKeyPairRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetKeyPairRequest): any => ({ ...obj, }); @@ -49,6 +52,9 @@ export interface GetKeyPairResult { } export namespace GetKeyPairResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetKeyPairResult): any => ({ ...obj, }); @@ -65,6 +71,9 @@ export interface GetKeyPairsRequest { } export namespace GetKeyPairsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetKeyPairsRequest): any => ({ ...obj, }); @@ -86,6 +95,9 @@ export interface GetKeyPairsResult { } export namespace GetKeyPairsResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetKeyPairsResult): any => ({ ...obj, }); @@ -99,6 +111,9 @@ export interface GetLoadBalancerRequest { } export namespace GetLoadBalancerRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetLoadBalancerRequest): any => ({ ...obj, }); @@ -275,6 +290,9 @@ export interface InstanceHealthSummary { } export namespace InstanceHealthSummary { + /** + * @internal + */ export const filterSensitiveLog = (obj: InstanceHealthSummary): any => ({ ...obj, }); @@ -310,6 +328,9 @@ export interface LoadBalancerTlsCertificateSummary { } export namespace LoadBalancerTlsCertificateSummary { + /** + * @internal + */ export const filterSensitiveLog = (obj: LoadBalancerTlsCertificateSummary): any => ({ ...obj, }); @@ -423,6 +444,9 @@ export interface LoadBalancer { } export namespace LoadBalancer { + /** + * @internal + */ export const filterSensitiveLog = (obj: LoadBalancer): any => ({ ...obj, }); @@ -436,6 +460,9 @@ export interface GetLoadBalancerResult { } export namespace GetLoadBalancerResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetLoadBalancerResult): any => ({ ...obj, }); @@ -694,6 +721,9 @@ export interface GetLoadBalancerMetricDataRequest { } export namespace GetLoadBalancerMetricDataRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetLoadBalancerMetricDataRequest): any => ({ ...obj, }); @@ -712,6 +742,9 @@ export interface GetLoadBalancerMetricDataResult { } export namespace GetLoadBalancerMetricDataResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetLoadBalancerMetricDataResult): any => ({ ...obj, }); @@ -728,6 +761,9 @@ export interface GetLoadBalancersRequest { } export namespace GetLoadBalancersRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetLoadBalancersRequest): any => ({ ...obj, }); @@ -749,6 +785,9 @@ export interface GetLoadBalancersResult { } export namespace GetLoadBalancersResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetLoadBalancersResult): any => ({ ...obj, }); @@ -762,6 +801,9 @@ export interface GetLoadBalancerTlsCertificatesRequest { } export namespace GetLoadBalancerTlsCertificatesRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetLoadBalancerTlsCertificatesRequest): any => ({ ...obj, }); @@ -806,6 +848,9 @@ export interface LoadBalancerTlsCertificateDomainValidationRecord { } export namespace LoadBalancerTlsCertificateDomainValidationRecord { + /** + * @internal + */ export const filterSensitiveLog = (obj: LoadBalancerTlsCertificateDomainValidationRecord): any => ({ ...obj, }); @@ -836,6 +881,9 @@ export interface LoadBalancerTlsCertificateDomainValidationOption { } export namespace LoadBalancerTlsCertificateDomainValidationOption { + /** + * @internal + */ export const filterSensitiveLog = (obj: LoadBalancerTlsCertificateDomainValidationOption): any => ({ ...obj, }); @@ -944,6 +992,9 @@ export interface LoadBalancerTlsCertificateRenewalSummary { } export namespace LoadBalancerTlsCertificateRenewalSummary { + /** + * @internal + */ export const filterSensitiveLog = (obj: LoadBalancerTlsCertificateRenewalSummary): any => ({ ...obj, }); @@ -1248,6 +1299,9 @@ export interface LoadBalancerTlsCertificate { } export namespace LoadBalancerTlsCertificate { + /** + * @internal + */ export const filterSensitiveLog = (obj: LoadBalancerTlsCertificate): any => ({ ...obj, }); @@ -1262,6 +1316,9 @@ export interface GetLoadBalancerTlsCertificatesResult { } export namespace GetLoadBalancerTlsCertificatesResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetLoadBalancerTlsCertificatesResult): any => ({ ...obj, }); @@ -1275,6 +1332,9 @@ export interface GetOperationRequest { } export namespace GetOperationRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetOperationRequest): any => ({ ...obj, }); @@ -1289,6 +1349,9 @@ export interface GetOperationResult { } export namespace GetOperationResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetOperationResult): any => ({ ...obj, }); @@ -1305,6 +1368,9 @@ export interface GetOperationsRequest { } export namespace GetOperationsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetOperationsRequest): any => ({ ...obj, }); @@ -1327,6 +1393,9 @@ export interface GetOperationsResult { } export namespace GetOperationsResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetOperationsResult): any => ({ ...obj, }); @@ -1348,6 +1417,9 @@ export interface GetOperationsForResourceRequest { } export namespace GetOperationsForResourceRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetOperationsForResourceRequest): any => ({ ...obj, }); @@ -1382,6 +1454,9 @@ export interface GetOperationsForResourceResult { } export namespace GetOperationsForResourceResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetOperationsForResourceResult): any => ({ ...obj, }); @@ -1403,6 +1478,9 @@ export interface GetRegionsRequest { } export namespace GetRegionsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetRegionsRequest): any => ({ ...obj, }); @@ -1447,6 +1525,9 @@ export interface Region { } export namespace Region { + /** + * @internal + */ export const filterSensitiveLog = (obj: Region): any => ({ ...obj, }); @@ -1460,6 +1541,9 @@ export interface GetRegionsResult { } export namespace GetRegionsResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetRegionsResult): any => ({ ...obj, }); @@ -1473,6 +1557,9 @@ export interface GetRelationalDatabaseRequest { } export namespace GetRelationalDatabaseRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetRelationalDatabaseRequest): any => ({ ...obj, }); @@ -1499,6 +1586,9 @@ export interface RelationalDatabaseHardware { } export namespace RelationalDatabaseHardware { + /** + * @internal + */ export const filterSensitiveLog = (obj: RelationalDatabaseHardware): any => ({ ...obj, }); @@ -1520,6 +1610,9 @@ export interface RelationalDatabaseEndpoint { } export namespace RelationalDatabaseEndpoint { + /** + * @internal + */ export const filterSensitiveLog = (obj: RelationalDatabaseEndpoint): any => ({ ...obj, }); @@ -1546,6 +1639,9 @@ export interface PendingMaintenanceAction { } export namespace PendingMaintenanceAction { + /** + * @internal + */ export const filterSensitiveLog = (obj: PendingMaintenanceAction): any => ({ ...obj, }); @@ -1572,6 +1668,9 @@ export interface PendingModifiedRelationalDatabaseValues { } export namespace PendingModifiedRelationalDatabaseValues { + /** + * @internal + */ export const filterSensitiveLog = (obj: PendingModifiedRelationalDatabaseValues): any => ({ ...obj, }); @@ -1728,6 +1827,9 @@ export interface RelationalDatabase { } export namespace RelationalDatabase { + /** + * @internal + */ export const filterSensitiveLog = (obj: RelationalDatabase): any => ({ ...obj, }); @@ -1741,6 +1843,9 @@ export interface GetRelationalDatabaseResult { } export namespace GetRelationalDatabaseResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetRelationalDatabaseResult): any => ({ ...obj, }); @@ -1757,6 +1862,9 @@ export interface GetRelationalDatabaseBlueprintsRequest { } export namespace GetRelationalDatabaseBlueprintsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetRelationalDatabaseBlueprintsRequest): any => ({ ...obj, }); @@ -1805,6 +1913,9 @@ export interface RelationalDatabaseBlueprint { } export namespace RelationalDatabaseBlueprint { + /** + * @internal + */ export const filterSensitiveLog = (obj: RelationalDatabaseBlueprint): any => ({ ...obj, }); @@ -1827,6 +1938,9 @@ export interface GetRelationalDatabaseBlueprintsResult { } export namespace GetRelationalDatabaseBlueprintsResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetRelationalDatabaseBlueprintsResult): any => ({ ...obj, }); @@ -1843,6 +1957,9 @@ export interface GetRelationalDatabaseBundlesRequest { } export namespace GetRelationalDatabaseBundlesRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetRelationalDatabaseBundlesRequest): any => ({ ...obj, }); @@ -1900,6 +2017,9 @@ export interface RelationalDatabaseBundle { } export namespace RelationalDatabaseBundle { + /** + * @internal + */ export const filterSensitiveLog = (obj: RelationalDatabaseBundle): any => ({ ...obj, }); @@ -1921,6 +2041,9 @@ export interface GetRelationalDatabaseBundlesResult { } export namespace GetRelationalDatabaseBundlesResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetRelationalDatabaseBundlesResult): any => ({ ...obj, }); @@ -1951,6 +2074,9 @@ export interface GetRelationalDatabaseEventsRequest { } export namespace GetRelationalDatabaseEventsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetRelationalDatabaseEventsRequest): any => ({ ...obj, }); @@ -1982,6 +2108,9 @@ export interface RelationalDatabaseEvent { } export namespace RelationalDatabaseEvent { + /** + * @internal + */ export const filterSensitiveLog = (obj: RelationalDatabaseEvent): any => ({ ...obj, }); @@ -2003,6 +2132,9 @@ export interface GetRelationalDatabaseEventsResult { } export namespace GetRelationalDatabaseEventsResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetRelationalDatabaseEventsResult): any => ({ ...obj, }); @@ -2075,6 +2207,9 @@ export interface GetRelationalDatabaseLogEventsRequest { } export namespace GetRelationalDatabaseLogEventsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetRelationalDatabaseLogEventsRequest): any => ({ ...obj, }); @@ -2096,6 +2231,9 @@ export interface LogEvent { } export namespace LogEvent { + /** + * @internal + */ export const filterSensitiveLog = (obj: LogEvent): any => ({ ...obj, }); @@ -2121,6 +2259,9 @@ export interface GetRelationalDatabaseLogEventsResult { } export namespace GetRelationalDatabaseLogEventsResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetRelationalDatabaseLogEventsResult): any => ({ ...obj, }); @@ -2134,6 +2275,9 @@ export interface GetRelationalDatabaseLogStreamsRequest { } export namespace GetRelationalDatabaseLogStreamsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetRelationalDatabaseLogStreamsRequest): any => ({ ...obj, }); @@ -2148,6 +2292,9 @@ export interface GetRelationalDatabaseLogStreamsResult { } export namespace GetRelationalDatabaseLogStreamsResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetRelationalDatabaseLogStreamsResult): any => ({ ...obj, }); @@ -2179,6 +2326,9 @@ export interface GetRelationalDatabaseMasterUserPasswordRequest { } export namespace GetRelationalDatabaseMasterUserPasswordRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetRelationalDatabaseMasterUserPasswordRequest): any => ({ ...obj, }); @@ -2197,6 +2347,9 @@ export interface GetRelationalDatabaseMasterUserPasswordResult { } export namespace GetRelationalDatabaseMasterUserPasswordResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetRelationalDatabaseMasterUserPasswordResult): any => ({ ...obj, ...(obj.masterUserPassword && { masterUserPassword: SENSITIVE_STRING }), @@ -2384,6 +2537,9 @@ export interface GetRelationalDatabaseMetricDataRequest { } export namespace GetRelationalDatabaseMetricDataRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetRelationalDatabaseMetricDataRequest): any => ({ ...obj, }); @@ -2402,6 +2558,9 @@ export interface GetRelationalDatabaseMetricDataResult { } export namespace GetRelationalDatabaseMetricDataResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetRelationalDatabaseMetricDataResult): any => ({ ...obj, }); @@ -2423,6 +2582,9 @@ export interface GetRelationalDatabaseParametersRequest { } export namespace GetRelationalDatabaseParametersRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetRelationalDatabaseParametersRequest): any => ({ ...obj, }); @@ -2475,6 +2637,9 @@ export interface RelationalDatabaseParameter { } export namespace RelationalDatabaseParameter { + /** + * @internal + */ export const filterSensitiveLog = (obj: RelationalDatabaseParameter): any => ({ ...obj, }); @@ -2497,6 +2662,9 @@ export interface GetRelationalDatabaseParametersResult { } export namespace GetRelationalDatabaseParametersResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetRelationalDatabaseParametersResult): any => ({ ...obj, }); @@ -2513,6 +2681,9 @@ export interface GetRelationalDatabasesRequest { } export namespace GetRelationalDatabasesRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetRelationalDatabasesRequest): any => ({ ...obj, }); @@ -2534,6 +2705,9 @@ export interface GetRelationalDatabasesResult { } export namespace GetRelationalDatabasesResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetRelationalDatabasesResult): any => ({ ...obj, }); @@ -2547,6 +2721,9 @@ export interface GetRelationalDatabaseSnapshotRequest { } export namespace GetRelationalDatabaseSnapshotRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetRelationalDatabaseSnapshotRequest): any => ({ ...obj, }); @@ -2641,6 +2818,9 @@ export interface RelationalDatabaseSnapshot { } export namespace RelationalDatabaseSnapshot { + /** + * @internal + */ export const filterSensitiveLog = (obj: RelationalDatabaseSnapshot): any => ({ ...obj, }); @@ -2654,6 +2834,9 @@ export interface GetRelationalDatabaseSnapshotResult { } export namespace GetRelationalDatabaseSnapshotResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetRelationalDatabaseSnapshotResult): any => ({ ...obj, }); @@ -2670,6 +2853,9 @@ export interface GetRelationalDatabaseSnapshotsRequest { } export namespace GetRelationalDatabaseSnapshotsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetRelationalDatabaseSnapshotsRequest): any => ({ ...obj, }); @@ -2692,6 +2878,9 @@ export interface GetRelationalDatabaseSnapshotsResult { } export namespace GetRelationalDatabaseSnapshotsResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetRelationalDatabaseSnapshotsResult): any => ({ ...obj, }); @@ -2705,6 +2894,9 @@ export interface GetStaticIpRequest { } export namespace GetStaticIpRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetStaticIpRequest): any => ({ ...obj, }); @@ -2765,6 +2957,9 @@ export interface StaticIp { } export namespace StaticIp { + /** + * @internal + */ export const filterSensitiveLog = (obj: StaticIp): any => ({ ...obj, }); @@ -2778,6 +2973,9 @@ export interface GetStaticIpResult { } export namespace GetStaticIpResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetStaticIpResult): any => ({ ...obj, }); @@ -2794,6 +2992,9 @@ export interface GetStaticIpsRequest { } export namespace GetStaticIpsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetStaticIpsRequest): any => ({ ...obj, }); @@ -2816,6 +3017,9 @@ export interface GetStaticIpsResult { } export namespace GetStaticIpsResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetStaticIpsResult): any => ({ ...obj, }); @@ -2834,6 +3038,9 @@ export interface ImportKeyPairRequest { } export namespace ImportKeyPairRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ImportKeyPairRequest): any => ({ ...obj, }); @@ -2848,6 +3055,9 @@ export interface ImportKeyPairResult { } export namespace ImportKeyPairResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: ImportKeyPairResult): any => ({ ...obj, }); @@ -2856,6 +3066,9 @@ export namespace ImportKeyPairResult { export interface IsVpcPeeredRequest {} export namespace IsVpcPeeredRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: IsVpcPeeredRequest): any => ({ ...obj, }); @@ -2870,6 +3083,9 @@ export interface IsVpcPeeredResult { } export namespace IsVpcPeeredResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: IsVpcPeeredResult): any => ({ ...obj, }); @@ -2888,6 +3104,9 @@ export interface OpenInstancePublicPortsRequest { } export namespace OpenInstancePublicPortsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: OpenInstancePublicPortsRequest): any => ({ ...obj, }); @@ -2902,6 +3121,9 @@ export interface OpenInstancePublicPortsResult { } export namespace OpenInstancePublicPortsResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: OpenInstancePublicPortsResult): any => ({ ...obj, }); @@ -2910,6 +3132,9 @@ export namespace OpenInstancePublicPortsResult { export interface PeerVpcRequest {} export namespace PeerVpcRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: PeerVpcRequest): any => ({ ...obj, }); @@ -2924,6 +3149,9 @@ export interface PeerVpcResult { } export namespace PeerVpcResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: PeerVpcResult): any => ({ ...obj, }); @@ -3101,6 +3329,9 @@ export interface PutAlarmRequest { } export namespace PutAlarmRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: PutAlarmRequest): any => ({ ...obj, }); @@ -3115,6 +3346,9 @@ export interface PutAlarmResult { } export namespace PutAlarmResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: PutAlarmResult): any => ({ ...obj, }); @@ -3133,6 +3367,9 @@ export interface PutInstancePublicPortsRequest { } export namespace PutInstancePublicPortsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: PutInstancePublicPortsRequest): any => ({ ...obj, }); @@ -3147,6 +3384,9 @@ export interface PutInstancePublicPortsResult { } export namespace PutInstancePublicPortsResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: PutInstancePublicPortsResult): any => ({ ...obj, }); @@ -3160,6 +3400,9 @@ export interface RebootInstanceRequest { } export namespace RebootInstanceRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: RebootInstanceRequest): any => ({ ...obj, }); @@ -3174,6 +3417,9 @@ export interface RebootInstanceResult { } export namespace RebootInstanceResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: RebootInstanceResult): any => ({ ...obj, }); @@ -3187,6 +3433,9 @@ export interface RebootRelationalDatabaseRequest { } export namespace RebootRelationalDatabaseRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: RebootRelationalDatabaseRequest): any => ({ ...obj, }); @@ -3201,6 +3450,9 @@ export interface RebootRelationalDatabaseResult { } export namespace RebootRelationalDatabaseResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: RebootRelationalDatabaseResult): any => ({ ...obj, }); @@ -3248,6 +3500,9 @@ export interface RegisterContainerImageRequest { } export namespace RegisterContainerImageRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: RegisterContainerImageRequest): any => ({ ...obj, }); @@ -3262,6 +3517,9 @@ export interface RegisterContainerImageResult { } export namespace RegisterContainerImageResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: RegisterContainerImageResult): any => ({ ...obj, }); @@ -3275,6 +3533,9 @@ export interface ReleaseStaticIpRequest { } export namespace ReleaseStaticIpRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ReleaseStaticIpRequest): any => ({ ...obj, }); @@ -3289,6 +3550,9 @@ export interface ReleaseStaticIpResult { } export namespace ReleaseStaticIpResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: ReleaseStaticIpResult): any => ({ ...obj, }); @@ -3304,6 +3568,9 @@ export interface ResetDistributionCacheRequest { } export namespace ResetDistributionCacheRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ResetDistributionCacheRequest): any => ({ ...obj, }); @@ -3329,6 +3596,9 @@ export interface ResetDistributionCacheResult { } export namespace ResetDistributionCacheResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: ResetDistributionCacheResult): any => ({ ...obj, }); @@ -3343,6 +3613,9 @@ export interface SendContactMethodVerificationRequest { } export namespace SendContactMethodVerificationRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: SendContactMethodVerificationRequest): any => ({ ...obj, }); @@ -3357,6 +3630,9 @@ export interface SendContactMethodVerificationResult { } export namespace SendContactMethodVerificationResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: SendContactMethodVerificationResult): any => ({ ...obj, }); @@ -3390,6 +3666,9 @@ export interface SetIpAddressTypeRequest { } export namespace SetIpAddressTypeRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: SetIpAddressTypeRequest): any => ({ ...obj, }); @@ -3404,6 +3683,9 @@ export interface SetIpAddressTypeResult { } export namespace SetIpAddressTypeResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: SetIpAddressTypeResult): any => ({ ...obj, }); @@ -3417,6 +3699,9 @@ export interface StartInstanceRequest { } export namespace StartInstanceRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: StartInstanceRequest): any => ({ ...obj, }); @@ -3431,6 +3716,9 @@ export interface StartInstanceResult { } export namespace StartInstanceResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: StartInstanceResult): any => ({ ...obj, }); @@ -3444,6 +3732,9 @@ export interface StartRelationalDatabaseRequest { } export namespace StartRelationalDatabaseRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: StartRelationalDatabaseRequest): any => ({ ...obj, }); @@ -3458,6 +3749,9 @@ export interface StartRelationalDatabaseResult { } export namespace StartRelationalDatabaseResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: StartRelationalDatabaseResult): any => ({ ...obj, }); @@ -3482,6 +3776,9 @@ export interface StopInstanceRequest { } export namespace StopInstanceRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: StopInstanceRequest): any => ({ ...obj, }); @@ -3496,6 +3793,9 @@ export interface StopInstanceResult { } export namespace StopInstanceResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: StopInstanceResult): any => ({ ...obj, }); @@ -3514,6 +3814,9 @@ export interface StopRelationalDatabaseRequest { } export namespace StopRelationalDatabaseRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: StopRelationalDatabaseRequest): any => ({ ...obj, }); @@ -3528,6 +3831,9 @@ export interface StopRelationalDatabaseResult { } export namespace StopRelationalDatabaseResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: StopRelationalDatabaseResult): any => ({ ...obj, }); @@ -3551,6 +3857,9 @@ export interface TagResourceRequest { } export namespace TagResourceRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: TagResourceRequest): any => ({ ...obj, }); @@ -3565,6 +3874,9 @@ export interface TagResourceResult { } export namespace TagResourceResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: TagResourceResult): any => ({ ...obj, }); @@ -3600,6 +3912,9 @@ export interface TestAlarmRequest { } export namespace TestAlarmRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: TestAlarmRequest): any => ({ ...obj, }); @@ -3614,6 +3929,9 @@ export interface TestAlarmResult { } export namespace TestAlarmResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: TestAlarmResult): any => ({ ...obj, }); @@ -3622,6 +3940,9 @@ export namespace TestAlarmResult { export interface UnpeerVpcRequest {} export namespace UnpeerVpcRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: UnpeerVpcRequest): any => ({ ...obj, }); @@ -3636,6 +3957,9 @@ export interface UnpeerVpcResult { } export namespace UnpeerVpcResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: UnpeerVpcResult): any => ({ ...obj, }); @@ -3659,6 +3983,9 @@ export interface UntagResourceRequest { } export namespace UntagResourceRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: UntagResourceRequest): any => ({ ...obj, }); @@ -3673,6 +4000,9 @@ export interface UntagResourceResult { } export namespace UntagResourceResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: UntagResourceResult): any => ({ ...obj, }); @@ -3738,6 +4068,9 @@ export interface UpdateContainerServiceRequest { } export namespace UpdateContainerServiceRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateContainerServiceRequest): any => ({ ...obj, }); @@ -3751,6 +4084,9 @@ export interface UpdateContainerServiceResult { } export namespace UpdateContainerServiceResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateContainerServiceResult): any => ({ ...obj, }); @@ -3798,6 +4134,9 @@ export interface UpdateDistributionRequest { } export namespace UpdateDistributionRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateDistributionRequest): any => ({ ...obj, }); @@ -3812,6 +4151,9 @@ export interface UpdateDistributionResult { } export namespace UpdateDistributionResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateDistributionResult): any => ({ ...obj, }); @@ -3834,6 +4176,9 @@ export interface UpdateDistributionBundleRequest { } export namespace UpdateDistributionBundleRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateDistributionBundleRequest): any => ({ ...obj, }); @@ -3847,6 +4192,9 @@ export interface UpdateDistributionBundleResult { } export namespace UpdateDistributionBundleResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateDistributionBundleResult): any => ({ ...obj, }); @@ -3865,6 +4213,9 @@ export interface UpdateDomainEntryRequest { } export namespace UpdateDomainEntryRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateDomainEntryRequest): any => ({ ...obj, }); @@ -3879,6 +4230,9 @@ export interface UpdateDomainEntryResult { } export namespace UpdateDomainEntryResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateDomainEntryResult): any => ({ ...obj, }); @@ -3903,6 +4257,9 @@ export interface UpdateLoadBalancerAttributeRequest { } export namespace UpdateLoadBalancerAttributeRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateLoadBalancerAttributeRequest): any => ({ ...obj, }); @@ -3917,6 +4274,9 @@ export interface UpdateLoadBalancerAttributeResult { } export namespace UpdateLoadBalancerAttributeResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateLoadBalancerAttributeResult): any => ({ ...obj, }); @@ -4038,6 +4398,9 @@ export interface UpdateRelationalDatabaseRequest { } export namespace UpdateRelationalDatabaseRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateRelationalDatabaseRequest): any => ({ ...obj, ...(obj.masterUserPassword && { masterUserPassword: SENSITIVE_STRING }), @@ -4053,6 +4416,9 @@ export interface UpdateRelationalDatabaseResult { } export namespace UpdateRelationalDatabaseResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateRelationalDatabaseResult): any => ({ ...obj, }); @@ -4071,6 +4437,9 @@ export interface UpdateRelationalDatabaseParametersRequest { } export namespace UpdateRelationalDatabaseParametersRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateRelationalDatabaseParametersRequest): any => ({ ...obj, }); @@ -4085,6 +4454,9 @@ export interface UpdateRelationalDatabaseParametersResult { } export namespace UpdateRelationalDatabaseParametersResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateRelationalDatabaseParametersResult): any => ({ ...obj, }); diff --git a/clients/client-location/commands/AssociateTrackerConsumerCommand.ts b/clients/client-location/commands/AssociateTrackerConsumerCommand.ts index 1e6e639ce71f..21439dcf0c89 100644 --- a/clients/client-location/commands/AssociateTrackerConsumerCommand.ts +++ b/clients/client-location/commands/AssociateTrackerConsumerCommand.ts @@ -27,6 +27,20 @@ export interface AssociateTrackerConsumerCommandOutput extends AssociateTrackerC * *

Currently not supported — Cross-account configurations, such as creating associations between a tracker resource in one account and a geofence collection in another account.

* + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { LocationClient, AssociateTrackerConsumerCommand } from "@aws-sdk/client-location"; // ES Modules import + * // const { LocationClient, AssociateTrackerConsumerCommand } = require("@aws-sdk/client-location"); // CommonJS import + * const client = new LocationClient(config); + * const command = new AssociateTrackerConsumerCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link AssociateTrackerConsumerCommandInput} for command's `input` shape. + * @see {@link AssociateTrackerConsumerCommandOutput} for command's `response` shape. + * @see {@link LocationClientResolvedConfig | config} for command's `input` shape. + * */ export class AssociateTrackerConsumerCommand extends $Command< AssociateTrackerConsumerCommandInput, diff --git a/clients/client-location/commands/BatchDeleteGeofenceCommand.ts b/clients/client-location/commands/BatchDeleteGeofenceCommand.ts index 174a690aca57..e108d0820c98 100644 --- a/clients/client-location/commands/BatchDeleteGeofenceCommand.ts +++ b/clients/client-location/commands/BatchDeleteGeofenceCommand.ts @@ -25,6 +25,20 @@ export interface BatchDeleteGeofenceCommandOutput extends BatchDeleteGeofenceRes * *

This action deletes the resource permanently. You can't undo this action.

* + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { LocationClient, BatchDeleteGeofenceCommand } from "@aws-sdk/client-location"; // ES Modules import + * // const { LocationClient, BatchDeleteGeofenceCommand } = require("@aws-sdk/client-location"); // CommonJS import + * const client = new LocationClient(config); + * const command = new BatchDeleteGeofenceCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link BatchDeleteGeofenceCommandInput} for command's `input` shape. + * @see {@link BatchDeleteGeofenceCommandOutput} for command's `response` shape. + * @see {@link LocationClientResolvedConfig | config} for command's `input` shape. + * */ export class BatchDeleteGeofenceCommand extends $Command< BatchDeleteGeofenceCommandInput, diff --git a/clients/client-location/commands/BatchEvaluateGeofencesCommand.ts b/clients/client-location/commands/BatchEvaluateGeofencesCommand.ts index c4ea94214000..a0f7ab7caca0 100644 --- a/clients/client-location/commands/BatchEvaluateGeofencesCommand.ts +++ b/clients/client-location/commands/BatchEvaluateGeofencesCommand.ts @@ -28,6 +28,20 @@ export interface BatchEvaluateGeofencesCommandOutput extends BatchEvaluateGeofen *

The last geofence that a device was observed within, if any, is tracked for 30 * days after the most recent device position update

* + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { LocationClient, BatchEvaluateGeofencesCommand } from "@aws-sdk/client-location"; // ES Modules import + * // const { LocationClient, BatchEvaluateGeofencesCommand } = require("@aws-sdk/client-location"); // CommonJS import + * const client = new LocationClient(config); + * const command = new BatchEvaluateGeofencesCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link BatchEvaluateGeofencesCommandInput} for command's `input` shape. + * @see {@link BatchEvaluateGeofencesCommandOutput} for command's `response` shape. + * @see {@link LocationClientResolvedConfig | config} for command's `input` shape. + * */ export class BatchEvaluateGeofencesCommand extends $Command< BatchEvaluateGeofencesCommandInput, diff --git a/clients/client-location/commands/BatchGetDevicePositionCommand.ts b/clients/client-location/commands/BatchGetDevicePositionCommand.ts index e8f4092e2fad..50dd62773814 100644 --- a/clients/client-location/commands/BatchGetDevicePositionCommand.ts +++ b/clients/client-location/commands/BatchGetDevicePositionCommand.ts @@ -22,6 +22,20 @@ export interface BatchGetDevicePositionCommandOutput extends BatchGetDevicePosit /** *

A batch request to retrieve all device positions.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { LocationClient, BatchGetDevicePositionCommand } from "@aws-sdk/client-location"; // ES Modules import + * // const { LocationClient, BatchGetDevicePositionCommand } = require("@aws-sdk/client-location"); // CommonJS import + * const client = new LocationClient(config); + * const command = new BatchGetDevicePositionCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link BatchGetDevicePositionCommandInput} for command's `input` shape. + * @see {@link BatchGetDevicePositionCommandOutput} for command's `response` shape. + * @see {@link LocationClientResolvedConfig | config} for command's `input` shape. + * */ export class BatchGetDevicePositionCommand extends $Command< BatchGetDevicePositionCommandInput, diff --git a/clients/client-location/commands/BatchPutGeofenceCommand.ts b/clients/client-location/commands/BatchPutGeofenceCommand.ts index 54fec82072ad..7d1b84a03c30 100644 --- a/clients/client-location/commands/BatchPutGeofenceCommand.ts +++ b/clients/client-location/commands/BatchPutGeofenceCommand.ts @@ -23,6 +23,20 @@ export interface BatchPutGeofenceCommandOutput extends BatchPutGeofenceResponse, /** *

A batch request for storing geofence geometries into a given geofence * collection.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { LocationClient, BatchPutGeofenceCommand } from "@aws-sdk/client-location"; // ES Modules import + * // const { LocationClient, BatchPutGeofenceCommand } = require("@aws-sdk/client-location"); // CommonJS import + * const client = new LocationClient(config); + * const command = new BatchPutGeofenceCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link BatchPutGeofenceCommandInput} for command's `input` shape. + * @see {@link BatchPutGeofenceCommandOutput} for command's `response` shape. + * @see {@link LocationClientResolvedConfig | config} for command's `input` shape. + * */ export class BatchPutGeofenceCommand extends $Command< BatchPutGeofenceCommandInput, diff --git a/clients/client-location/commands/BatchUpdateDevicePositionCommand.ts b/clients/client-location/commands/BatchUpdateDevicePositionCommand.ts index 72a1a5e5cf1a..2d352dc97c62 100644 --- a/clients/client-location/commands/BatchUpdateDevicePositionCommand.ts +++ b/clients/client-location/commands/BatchUpdateDevicePositionCommand.ts @@ -28,6 +28,20 @@ export interface BatchUpdateDevicePositionCommandOutput extends BatchUpdateDevic * fixed rate of one position per 30-second interval, and retained for one year before * it is deleted.

* + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { LocationClient, BatchUpdateDevicePositionCommand } from "@aws-sdk/client-location"; // ES Modules import + * // const { LocationClient, BatchUpdateDevicePositionCommand } = require("@aws-sdk/client-location"); // CommonJS import + * const client = new LocationClient(config); + * const command = new BatchUpdateDevicePositionCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link BatchUpdateDevicePositionCommandInput} for command's `input` shape. + * @see {@link BatchUpdateDevicePositionCommandOutput} for command's `response` shape. + * @see {@link LocationClientResolvedConfig | config} for command's `input` shape. + * */ export class BatchUpdateDevicePositionCommand extends $Command< BatchUpdateDevicePositionCommandInput, diff --git a/clients/client-location/commands/CreateGeofenceCollectionCommand.ts b/clients/client-location/commands/CreateGeofenceCollectionCommand.ts index 704b4bafb534..ca4438eb4b0f 100644 --- a/clients/client-location/commands/CreateGeofenceCollectionCommand.ts +++ b/clients/client-location/commands/CreateGeofenceCollectionCommand.ts @@ -22,6 +22,20 @@ export interface CreateGeofenceCollectionCommandOutput extends CreateGeofenceCol /** *

Creates a geofence collection, which manages and stores geofences.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { LocationClient, CreateGeofenceCollectionCommand } from "@aws-sdk/client-location"; // ES Modules import + * // const { LocationClient, CreateGeofenceCollectionCommand } = require("@aws-sdk/client-location"); // CommonJS import + * const client = new LocationClient(config); + * const command = new CreateGeofenceCollectionCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreateGeofenceCollectionCommandInput} for command's `input` shape. + * @see {@link CreateGeofenceCollectionCommandOutput} for command's `response` shape. + * @see {@link LocationClientResolvedConfig | config} for command's `input` shape. + * */ export class CreateGeofenceCollectionCommand extends $Command< CreateGeofenceCollectionCommandInput, diff --git a/clients/client-location/commands/CreateMapCommand.ts b/clients/client-location/commands/CreateMapCommand.ts index 6183a55dc27a..cc7ce6da9648 100644 --- a/clients/client-location/commands/CreateMapCommand.ts +++ b/clients/client-location/commands/CreateMapCommand.ts @@ -29,6 +29,20 @@ export interface CreateMapCommandOutput extends CreateMapResponse, __MetadataBea * currently using. For more information, see the AWS Service Terms for Amazon * Location Service.

* + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { LocationClient, CreateMapCommand } from "@aws-sdk/client-location"; // ES Modules import + * // const { LocationClient, CreateMapCommand } = require("@aws-sdk/client-location"); // CommonJS import + * const client = new LocationClient(config); + * const command = new CreateMapCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreateMapCommandInput} for command's `input` shape. + * @see {@link CreateMapCommandOutput} for command's `response` shape. + * @see {@link LocationClientResolvedConfig | config} for command's `input` shape. + * */ export class CreateMapCommand extends $Command< CreateMapCommandInput, diff --git a/clients/client-location/commands/CreatePlaceIndexCommand.ts b/clients/client-location/commands/CreatePlaceIndexCommand.ts index aa95249c73be..70c869b109b2 100644 --- a/clients/client-location/commands/CreatePlaceIndexCommand.ts +++ b/clients/client-location/commands/CreatePlaceIndexCommand.ts @@ -31,6 +31,20 @@ export interface CreatePlaceIndexCommandOutput extends CreatePlaceIndexResponse, * in Japan. For more information, see the AWS Service Terms for Amazon * Location Service.

* + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { LocationClient, CreatePlaceIndexCommand } from "@aws-sdk/client-location"; // ES Modules import + * // const { LocationClient, CreatePlaceIndexCommand } = require("@aws-sdk/client-location"); // CommonJS import + * const client = new LocationClient(config); + * const command = new CreatePlaceIndexCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreatePlaceIndexCommandInput} for command's `input` shape. + * @see {@link CreatePlaceIndexCommandOutput} for command's `response` shape. + * @see {@link LocationClientResolvedConfig | config} for command's `input` shape. + * */ export class CreatePlaceIndexCommand extends $Command< CreatePlaceIndexCommandInput, diff --git a/clients/client-location/commands/CreateTrackerCommand.ts b/clients/client-location/commands/CreateTrackerCommand.ts index 93da7e0635d2..2ae705a1969b 100644 --- a/clients/client-location/commands/CreateTrackerCommand.ts +++ b/clients/client-location/commands/CreateTrackerCommand.ts @@ -23,6 +23,20 @@ export interface CreateTrackerCommandOutput extends CreateTrackerResponse, __Met /** *

Creates a tracker resource in your AWS account, which lets you retrieve current and * historical location of devices.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { LocationClient, CreateTrackerCommand } from "@aws-sdk/client-location"; // ES Modules import + * // const { LocationClient, CreateTrackerCommand } = require("@aws-sdk/client-location"); // CommonJS import + * const client = new LocationClient(config); + * const command = new CreateTrackerCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreateTrackerCommandInput} for command's `input` shape. + * @see {@link CreateTrackerCommandOutput} for command's `response` shape. + * @see {@link LocationClientResolvedConfig | config} for command's `input` shape. + * */ export class CreateTrackerCommand extends $Command< CreateTrackerCommandInput, diff --git a/clients/client-location/commands/DeleteGeofenceCollectionCommand.ts b/clients/client-location/commands/DeleteGeofenceCollectionCommand.ts index c24b324d5bde..43f7e85a2821 100644 --- a/clients/client-location/commands/DeleteGeofenceCollectionCommand.ts +++ b/clients/client-location/commands/DeleteGeofenceCollectionCommand.ts @@ -27,6 +27,20 @@ export interface DeleteGeofenceCollectionCommandOutput extends DeleteGeofenceCol * geofence collection is the target of a tracker resource, the devices will no longer * be monitored.

* + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { LocationClient, DeleteGeofenceCollectionCommand } from "@aws-sdk/client-location"; // ES Modules import + * // const { LocationClient, DeleteGeofenceCollectionCommand } = require("@aws-sdk/client-location"); // CommonJS import + * const client = new LocationClient(config); + * const command = new DeleteGeofenceCollectionCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteGeofenceCollectionCommandInput} for command's `input` shape. + * @see {@link DeleteGeofenceCollectionCommandOutput} for command's `response` shape. + * @see {@link LocationClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteGeofenceCollectionCommand extends $Command< DeleteGeofenceCollectionCommandInput, diff --git a/clients/client-location/commands/DeleteMapCommand.ts b/clients/client-location/commands/DeleteMapCommand.ts index 5be20b958c60..d18fbeae6bf9 100644 --- a/clients/client-location/commands/DeleteMapCommand.ts +++ b/clients/client-location/commands/DeleteMapCommand.ts @@ -26,6 +26,20 @@ export interface DeleteMapCommandOutput extends DeleteMapResponse, __MetadataBea *

This action deletes the resource permanently. You cannot undo this action. If the map is being * used in an application, the map may not render.

* + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { LocationClient, DeleteMapCommand } from "@aws-sdk/client-location"; // ES Modules import + * // const { LocationClient, DeleteMapCommand } = require("@aws-sdk/client-location"); // CommonJS import + * const client = new LocationClient(config); + * const command = new DeleteMapCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteMapCommandInput} for command's `input` shape. + * @see {@link DeleteMapCommandOutput} for command's `response` shape. + * @see {@link LocationClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteMapCommand extends $Command< DeleteMapCommandInput, diff --git a/clients/client-location/commands/DeletePlaceIndexCommand.ts b/clients/client-location/commands/DeletePlaceIndexCommand.ts index fd75c6d38434..96bfd5d5c0ab 100644 --- a/clients/client-location/commands/DeletePlaceIndexCommand.ts +++ b/clients/client-location/commands/DeletePlaceIndexCommand.ts @@ -25,6 +25,20 @@ export interface DeletePlaceIndexCommandOutput extends DeletePlaceIndexResponse, * *

This action deletes the resource permanently. You cannot undo this action.

* + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { LocationClient, DeletePlaceIndexCommand } from "@aws-sdk/client-location"; // ES Modules import + * // const { LocationClient, DeletePlaceIndexCommand } = require("@aws-sdk/client-location"); // CommonJS import + * const client = new LocationClient(config); + * const command = new DeletePlaceIndexCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeletePlaceIndexCommandInput} for command's `input` shape. + * @see {@link DeletePlaceIndexCommandOutput} for command's `response` shape. + * @see {@link LocationClientResolvedConfig | config} for command's `input` shape. + * */ export class DeletePlaceIndexCommand extends $Command< DeletePlaceIndexCommandInput, diff --git a/clients/client-location/commands/DeleteTrackerCommand.ts b/clients/client-location/commands/DeleteTrackerCommand.ts index f622cf86e26a..245bf0b652f3 100644 --- a/clients/client-location/commands/DeleteTrackerCommand.ts +++ b/clients/client-location/commands/DeleteTrackerCommand.ts @@ -25,6 +25,20 @@ export interface DeleteTrackerCommandOutput extends DeleteTrackerResponse, __Met * *

This action deletes the resource permanently. You can't undo this action. If the tracker resource is in use, you may encounter an error. Make sure that the target resource is not a dependency for your applications.

* + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { LocationClient, DeleteTrackerCommand } from "@aws-sdk/client-location"; // ES Modules import + * // const { LocationClient, DeleteTrackerCommand } = require("@aws-sdk/client-location"); // CommonJS import + * const client = new LocationClient(config); + * const command = new DeleteTrackerCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteTrackerCommandInput} for command's `input` shape. + * @see {@link DeleteTrackerCommandOutput} for command's `response` shape. + * @see {@link LocationClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteTrackerCommand extends $Command< DeleteTrackerCommandInput, diff --git a/clients/client-location/commands/DescribeGeofenceCollectionCommand.ts b/clients/client-location/commands/DescribeGeofenceCollectionCommand.ts index 2348160e45ff..febe1652acef 100644 --- a/clients/client-location/commands/DescribeGeofenceCollectionCommand.ts +++ b/clients/client-location/commands/DescribeGeofenceCollectionCommand.ts @@ -22,6 +22,20 @@ export interface DescribeGeofenceCollectionCommandOutput extends DescribeGeofenc /** *

Retrieves the geofence collection details.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { LocationClient, DescribeGeofenceCollectionCommand } from "@aws-sdk/client-location"; // ES Modules import + * // const { LocationClient, DescribeGeofenceCollectionCommand } = require("@aws-sdk/client-location"); // CommonJS import + * const client = new LocationClient(config); + * const command = new DescribeGeofenceCollectionCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeGeofenceCollectionCommandInput} for command's `input` shape. + * @see {@link DescribeGeofenceCollectionCommandOutput} for command's `response` shape. + * @see {@link LocationClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeGeofenceCollectionCommand extends $Command< DescribeGeofenceCollectionCommandInput, diff --git a/clients/client-location/commands/DescribeMapCommand.ts b/clients/client-location/commands/DescribeMapCommand.ts index 25e18029c158..03f6309db62f 100644 --- a/clients/client-location/commands/DescribeMapCommand.ts +++ b/clients/client-location/commands/DescribeMapCommand.ts @@ -22,6 +22,20 @@ export interface DescribeMapCommandOutput extends DescribeMapResponse, __Metadat /** *

Retrieves the map resource details.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { LocationClient, DescribeMapCommand } from "@aws-sdk/client-location"; // ES Modules import + * // const { LocationClient, DescribeMapCommand } = require("@aws-sdk/client-location"); // CommonJS import + * const client = new LocationClient(config); + * const command = new DescribeMapCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeMapCommandInput} for command's `input` shape. + * @see {@link DescribeMapCommandOutput} for command's `response` shape. + * @see {@link LocationClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeMapCommand extends $Command< DescribeMapCommandInput, diff --git a/clients/client-location/commands/DescribePlaceIndexCommand.ts b/clients/client-location/commands/DescribePlaceIndexCommand.ts index 75740fd9db3f..aac276eb5f93 100644 --- a/clients/client-location/commands/DescribePlaceIndexCommand.ts +++ b/clients/client-location/commands/DescribePlaceIndexCommand.ts @@ -22,6 +22,20 @@ export interface DescribePlaceIndexCommandOutput extends DescribePlaceIndexRespo /** *

Retrieves the Place index resource details.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { LocationClient, DescribePlaceIndexCommand } from "@aws-sdk/client-location"; // ES Modules import + * // const { LocationClient, DescribePlaceIndexCommand } = require("@aws-sdk/client-location"); // CommonJS import + * const client = new LocationClient(config); + * const command = new DescribePlaceIndexCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribePlaceIndexCommandInput} for command's `input` shape. + * @see {@link DescribePlaceIndexCommandOutput} for command's `response` shape. + * @see {@link LocationClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribePlaceIndexCommand extends $Command< DescribePlaceIndexCommandInput, diff --git a/clients/client-location/commands/DescribeTrackerCommand.ts b/clients/client-location/commands/DescribeTrackerCommand.ts index dbcac8fee7a1..b32c557c77e2 100644 --- a/clients/client-location/commands/DescribeTrackerCommand.ts +++ b/clients/client-location/commands/DescribeTrackerCommand.ts @@ -22,6 +22,20 @@ export interface DescribeTrackerCommandOutput extends DescribeTrackerResponse, _ /** *

Retrieves the tracker resource details.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { LocationClient, DescribeTrackerCommand } from "@aws-sdk/client-location"; // ES Modules import + * // const { LocationClient, DescribeTrackerCommand } = require("@aws-sdk/client-location"); // CommonJS import + * const client = new LocationClient(config); + * const command = new DescribeTrackerCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeTrackerCommandInput} for command's `input` shape. + * @see {@link DescribeTrackerCommandOutput} for command's `response` shape. + * @see {@link LocationClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeTrackerCommand extends $Command< DescribeTrackerCommandInput, diff --git a/clients/client-location/commands/DisassociateTrackerConsumerCommand.ts b/clients/client-location/commands/DisassociateTrackerConsumerCommand.ts index eb929c59a129..e2d277bb286e 100644 --- a/clients/client-location/commands/DisassociateTrackerConsumerCommand.ts +++ b/clients/client-location/commands/DisassociateTrackerConsumerCommand.ts @@ -28,6 +28,20 @@ export interface DisassociateTrackerConsumerCommandOutput *

Once you unlink a tracker resource from a geofence collection, the tracker * positions will no longer be automatically evaluated against geofences.

* + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { LocationClient, DisassociateTrackerConsumerCommand } from "@aws-sdk/client-location"; // ES Modules import + * // const { LocationClient, DisassociateTrackerConsumerCommand } = require("@aws-sdk/client-location"); // CommonJS import + * const client = new LocationClient(config); + * const command = new DisassociateTrackerConsumerCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DisassociateTrackerConsumerCommandInput} for command's `input` shape. + * @see {@link DisassociateTrackerConsumerCommandOutput} for command's `response` shape. + * @see {@link LocationClientResolvedConfig | config} for command's `input` shape. + * */ export class DisassociateTrackerConsumerCommand extends $Command< DisassociateTrackerConsumerCommandInput, diff --git a/clients/client-location/commands/GetDevicePositionCommand.ts b/clients/client-location/commands/GetDevicePositionCommand.ts index cfcb9d65a7e5..baa31da1bec5 100644 --- a/clients/client-location/commands/GetDevicePositionCommand.ts +++ b/clients/client-location/commands/GetDevicePositionCommand.ts @@ -25,6 +25,20 @@ export interface GetDevicePositionCommandOutput extends GetDevicePositionRespons * *

Device positions are deleted after one year.

* + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { LocationClient, GetDevicePositionCommand } from "@aws-sdk/client-location"; // ES Modules import + * // const { LocationClient, GetDevicePositionCommand } = require("@aws-sdk/client-location"); // CommonJS import + * const client = new LocationClient(config); + * const command = new GetDevicePositionCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetDevicePositionCommandInput} for command's `input` shape. + * @see {@link GetDevicePositionCommandOutput} for command's `response` shape. + * @see {@link LocationClientResolvedConfig | config} for command's `input` shape. + * */ export class GetDevicePositionCommand extends $Command< GetDevicePositionCommandInput, diff --git a/clients/client-location/commands/GetDevicePositionHistoryCommand.ts b/clients/client-location/commands/GetDevicePositionHistoryCommand.ts index bd8a191b9bcb..dee6f366360d 100644 --- a/clients/client-location/commands/GetDevicePositionHistoryCommand.ts +++ b/clients/client-location/commands/GetDevicePositionHistoryCommand.ts @@ -26,6 +26,20 @@ export interface GetDevicePositionHistoryCommandOutput extends GetDevicePosition * *

Device positions are deleted after 1 year.

* + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { LocationClient, GetDevicePositionHistoryCommand } from "@aws-sdk/client-location"; // ES Modules import + * // const { LocationClient, GetDevicePositionHistoryCommand } = require("@aws-sdk/client-location"); // CommonJS import + * const client = new LocationClient(config); + * const command = new GetDevicePositionHistoryCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetDevicePositionHistoryCommandInput} for command's `input` shape. + * @see {@link GetDevicePositionHistoryCommandOutput} for command's `response` shape. + * @see {@link LocationClientResolvedConfig | config} for command's `input` shape. + * */ export class GetDevicePositionHistoryCommand extends $Command< GetDevicePositionHistoryCommandInput, diff --git a/clients/client-location/commands/GetGeofenceCommand.ts b/clients/client-location/commands/GetGeofenceCommand.ts index 233e5fb437ba..20e6e1bc0e4d 100644 --- a/clients/client-location/commands/GetGeofenceCommand.ts +++ b/clients/client-location/commands/GetGeofenceCommand.ts @@ -22,6 +22,20 @@ export interface GetGeofenceCommandOutput extends GetGeofenceResponse, __Metadat /** *

Retrieves the geofence details from a geofence collection.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { LocationClient, GetGeofenceCommand } from "@aws-sdk/client-location"; // ES Modules import + * // const { LocationClient, GetGeofenceCommand } = require("@aws-sdk/client-location"); // CommonJS import + * const client = new LocationClient(config); + * const command = new GetGeofenceCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetGeofenceCommandInput} for command's `input` shape. + * @see {@link GetGeofenceCommandOutput} for command's `response` shape. + * @see {@link LocationClientResolvedConfig | config} for command's `input` shape. + * */ export class GetGeofenceCommand extends $Command< GetGeofenceCommandInput, diff --git a/clients/client-location/commands/GetMapGlyphsCommand.ts b/clients/client-location/commands/GetMapGlyphsCommand.ts index 7092feaa1d5b..34e87099d3aa 100644 --- a/clients/client-location/commands/GetMapGlyphsCommand.ts +++ b/clients/client-location/commands/GetMapGlyphsCommand.ts @@ -22,6 +22,20 @@ export interface GetMapGlyphsCommandOutput extends GetMapGlyphsResponse, __Metad /** *

Retrieves glyphs used to display labels on a map.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { LocationClient, GetMapGlyphsCommand } from "@aws-sdk/client-location"; // ES Modules import + * // const { LocationClient, GetMapGlyphsCommand } = require("@aws-sdk/client-location"); // CommonJS import + * const client = new LocationClient(config); + * const command = new GetMapGlyphsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetMapGlyphsCommandInput} for command's `input` shape. + * @see {@link GetMapGlyphsCommandOutput} for command's `response` shape. + * @see {@link LocationClientResolvedConfig | config} for command's `input` shape. + * */ export class GetMapGlyphsCommand extends $Command< GetMapGlyphsCommandInput, diff --git a/clients/client-location/commands/GetMapSpritesCommand.ts b/clients/client-location/commands/GetMapSpritesCommand.ts index dc23e7a2d2fe..f56c1502c183 100644 --- a/clients/client-location/commands/GetMapSpritesCommand.ts +++ b/clients/client-location/commands/GetMapSpritesCommand.ts @@ -24,6 +24,20 @@ export interface GetMapSpritesCommandOutput extends GetMapSpritesResponse, __Met *

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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { LocationClient, GetMapSpritesCommand } from "@aws-sdk/client-location"; // ES Modules import + * // const { LocationClient, GetMapSpritesCommand } = require("@aws-sdk/client-location"); // CommonJS import + * const client = new LocationClient(config); + * const command = new GetMapSpritesCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetMapSpritesCommandInput} for command's `input` shape. + * @see {@link GetMapSpritesCommandOutput} for command's `response` shape. + * @see {@link LocationClientResolvedConfig | config} for command's `input` shape. + * */ export class GetMapSpritesCommand extends $Command< GetMapSpritesCommandInput, diff --git a/clients/client-location/commands/GetMapStyleDescriptorCommand.ts b/clients/client-location/commands/GetMapStyleDescriptorCommand.ts index cbbe49685b3e..2fac34046647 100644 --- a/clients/client-location/commands/GetMapStyleDescriptorCommand.ts +++ b/clients/client-location/commands/GetMapStyleDescriptorCommand.ts @@ -25,6 +25,20 @@ export interface GetMapStyleDescriptorCommandOutput extends GetMapStyleDescripto *

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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { LocationClient, GetMapStyleDescriptorCommand } from "@aws-sdk/client-location"; // ES Modules import + * // const { LocationClient, GetMapStyleDescriptorCommand } = require("@aws-sdk/client-location"); // CommonJS import + * const client = new LocationClient(config); + * const command = new GetMapStyleDescriptorCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetMapStyleDescriptorCommandInput} for command's `input` shape. + * @see {@link GetMapStyleDescriptorCommandOutput} for command's `response` shape. + * @see {@link LocationClientResolvedConfig | config} for command's `input` shape. + * */ export class GetMapStyleDescriptorCommand extends $Command< GetMapStyleDescriptorCommandInput, diff --git a/clients/client-location/commands/GetMapTileCommand.ts b/clients/client-location/commands/GetMapTileCommand.ts index 5ca3b36121d5..c7706c2b836e 100644 --- a/clients/client-location/commands/GetMapTileCommand.ts +++ b/clients/client-location/commands/GetMapTileCommand.ts @@ -27,6 +27,20 @@ export interface GetMapTileCommandOutput extends GetMapTileResponse, __MetadataB *

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).

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { LocationClient, GetMapTileCommand } from "@aws-sdk/client-location"; // ES Modules import + * // const { LocationClient, GetMapTileCommand } = require("@aws-sdk/client-location"); // CommonJS import + * const client = new LocationClient(config); + * const command = new GetMapTileCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetMapTileCommandInput} for command's `input` shape. + * @see {@link GetMapTileCommandOutput} for command's `response` shape. + * @see {@link LocationClientResolvedConfig | config} for command's `input` shape. + * */ export class GetMapTileCommand extends $Command< GetMapTileCommandInput, diff --git a/clients/client-location/commands/ListGeofenceCollectionsCommand.ts b/clients/client-location/commands/ListGeofenceCollectionsCommand.ts index 2b75e64b615c..f51830a59241 100644 --- a/clients/client-location/commands/ListGeofenceCollectionsCommand.ts +++ b/clients/client-location/commands/ListGeofenceCollectionsCommand.ts @@ -22,6 +22,20 @@ export interface ListGeofenceCollectionsCommandOutput extends ListGeofenceCollec /** *

Lists geofence collections in your AWS account.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { LocationClient, ListGeofenceCollectionsCommand } from "@aws-sdk/client-location"; // ES Modules import + * // const { LocationClient, ListGeofenceCollectionsCommand } = require("@aws-sdk/client-location"); // CommonJS import + * const client = new LocationClient(config); + * const command = new ListGeofenceCollectionsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListGeofenceCollectionsCommandInput} for command's `input` shape. + * @see {@link ListGeofenceCollectionsCommandOutput} for command's `response` shape. + * @see {@link LocationClientResolvedConfig | config} for command's `input` shape. + * */ export class ListGeofenceCollectionsCommand extends $Command< ListGeofenceCollectionsCommandInput, diff --git a/clients/client-location/commands/ListGeofencesCommand.ts b/clients/client-location/commands/ListGeofencesCommand.ts index 51cff755f80a..375efe1221c3 100644 --- a/clients/client-location/commands/ListGeofencesCommand.ts +++ b/clients/client-location/commands/ListGeofencesCommand.ts @@ -22,6 +22,20 @@ export interface ListGeofencesCommandOutput extends ListGeofencesResponse, __Met /** *

Lists geofences stored in a given geofence collection.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { LocationClient, ListGeofencesCommand } from "@aws-sdk/client-location"; // ES Modules import + * // const { LocationClient, ListGeofencesCommand } = require("@aws-sdk/client-location"); // CommonJS import + * const client = new LocationClient(config); + * const command = new ListGeofencesCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListGeofencesCommandInput} for command's `input` shape. + * @see {@link ListGeofencesCommandOutput} for command's `response` shape. + * @see {@link LocationClientResolvedConfig | config} for command's `input` shape. + * */ export class ListGeofencesCommand extends $Command< ListGeofencesCommandInput, diff --git a/clients/client-location/commands/ListMapsCommand.ts b/clients/client-location/commands/ListMapsCommand.ts index e06693793c7f..17b7f2c27c12 100644 --- a/clients/client-location/commands/ListMapsCommand.ts +++ b/clients/client-location/commands/ListMapsCommand.ts @@ -22,6 +22,20 @@ export interface ListMapsCommandOutput extends ListMapsResponse, __MetadataBeare /** *

Lists map resources in your AWS account.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { LocationClient, ListMapsCommand } from "@aws-sdk/client-location"; // ES Modules import + * // const { LocationClient, ListMapsCommand } = require("@aws-sdk/client-location"); // CommonJS import + * const client = new LocationClient(config); + * const command = new ListMapsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListMapsCommandInput} for command's `input` shape. + * @see {@link ListMapsCommandOutput} for command's `response` shape. + * @see {@link LocationClientResolvedConfig | config} for command's `input` shape. + * */ export class ListMapsCommand extends $Command< ListMapsCommandInput, diff --git a/clients/client-location/commands/ListPlaceIndexesCommand.ts b/clients/client-location/commands/ListPlaceIndexesCommand.ts index dfc05fb5c518..c7165e78b84a 100644 --- a/clients/client-location/commands/ListPlaceIndexesCommand.ts +++ b/clients/client-location/commands/ListPlaceIndexesCommand.ts @@ -22,6 +22,20 @@ export interface ListPlaceIndexesCommandOutput extends ListPlaceIndexesResponse, /** *

Lists Place index resources in your AWS account.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { LocationClient, ListPlaceIndexesCommand } from "@aws-sdk/client-location"; // ES Modules import + * // const { LocationClient, ListPlaceIndexesCommand } = require("@aws-sdk/client-location"); // CommonJS import + * const client = new LocationClient(config); + * const command = new ListPlaceIndexesCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListPlaceIndexesCommandInput} for command's `input` shape. + * @see {@link ListPlaceIndexesCommandOutput} for command's `response` shape. + * @see {@link LocationClientResolvedConfig | config} for command's `input` shape. + * */ export class ListPlaceIndexesCommand extends $Command< ListPlaceIndexesCommandInput, diff --git a/clients/client-location/commands/ListTrackerConsumersCommand.ts b/clients/client-location/commands/ListTrackerConsumersCommand.ts index 93ec098f9365..57184e58cb2d 100644 --- a/clients/client-location/commands/ListTrackerConsumersCommand.ts +++ b/clients/client-location/commands/ListTrackerConsumersCommand.ts @@ -22,6 +22,20 @@ export interface ListTrackerConsumersCommandOutput extends ListTrackerConsumersR /** *

Lists geofence collections currently associated to the given tracker resource.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { LocationClient, ListTrackerConsumersCommand } from "@aws-sdk/client-location"; // ES Modules import + * // const { LocationClient, ListTrackerConsumersCommand } = require("@aws-sdk/client-location"); // CommonJS import + * const client = new LocationClient(config); + * const command = new ListTrackerConsumersCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListTrackerConsumersCommandInput} for command's `input` shape. + * @see {@link ListTrackerConsumersCommandOutput} for command's `response` shape. + * @see {@link LocationClientResolvedConfig | config} for command's `input` shape. + * */ export class ListTrackerConsumersCommand extends $Command< ListTrackerConsumersCommandInput, diff --git a/clients/client-location/commands/ListTrackersCommand.ts b/clients/client-location/commands/ListTrackersCommand.ts index ff01b9327934..fae38021e987 100644 --- a/clients/client-location/commands/ListTrackersCommand.ts +++ b/clients/client-location/commands/ListTrackersCommand.ts @@ -22,6 +22,20 @@ export interface ListTrackersCommandOutput extends ListTrackersResponse, __Metad /** *

Lists tracker resources in your AWS account.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { LocationClient, ListTrackersCommand } from "@aws-sdk/client-location"; // ES Modules import + * // const { LocationClient, ListTrackersCommand } = require("@aws-sdk/client-location"); // CommonJS import + * const client = new LocationClient(config); + * const command = new ListTrackersCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListTrackersCommandInput} for command's `input` shape. + * @see {@link ListTrackersCommandOutput} for command's `response` shape. + * @see {@link LocationClientResolvedConfig | config} for command's `input` shape. + * */ export class ListTrackersCommand extends $Command< ListTrackersCommandInput, diff --git a/clients/client-location/commands/PutGeofenceCommand.ts b/clients/client-location/commands/PutGeofenceCommand.ts index e31648534950..743750dc1555 100644 --- a/clients/client-location/commands/PutGeofenceCommand.ts +++ b/clients/client-location/commands/PutGeofenceCommand.ts @@ -23,6 +23,20 @@ export interface PutGeofenceCommandOutput extends PutGeofenceResponse, __Metadat /** *

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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { LocationClient, PutGeofenceCommand } from "@aws-sdk/client-location"; // ES Modules import + * // const { LocationClient, PutGeofenceCommand } = require("@aws-sdk/client-location"); // CommonJS import + * const client = new LocationClient(config); + * const command = new PutGeofenceCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link PutGeofenceCommandInput} for command's `input` shape. + * @see {@link PutGeofenceCommandOutput} for command's `response` shape. + * @see {@link LocationClientResolvedConfig | config} for command's `input` shape. + * */ export class PutGeofenceCommand extends $Command< PutGeofenceCommandInput, diff --git a/clients/client-location/commands/SearchPlaceIndexForPositionCommand.ts b/clients/client-location/commands/SearchPlaceIndexForPositionCommand.ts index b5960c63fc56..98f84d1e43d0 100644 --- a/clients/client-location/commands/SearchPlaceIndexForPositionCommand.ts +++ b/clients/client-location/commands/SearchPlaceIndexForPositionCommand.ts @@ -33,6 +33,20 @@ export interface SearchPlaceIndexForPositionCommandOutput * in Japan. For more information, see the AWS Service Terms for Amazon * Location Service.

* + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { LocationClient, SearchPlaceIndexForPositionCommand } from "@aws-sdk/client-location"; // ES Modules import + * // const { LocationClient, SearchPlaceIndexForPositionCommand } = require("@aws-sdk/client-location"); // CommonJS import + * const client = new LocationClient(config); + * const command = new SearchPlaceIndexForPositionCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link SearchPlaceIndexForPositionCommandInput} for command's `input` shape. + * @see {@link SearchPlaceIndexForPositionCommandOutput} for command's `response` shape. + * @see {@link LocationClientResolvedConfig | config} for command's `input` shape. + * */ export class SearchPlaceIndexForPositionCommand extends $Command< SearchPlaceIndexForPositionCommandInput, diff --git a/clients/client-location/commands/SearchPlaceIndexForTextCommand.ts b/clients/client-location/commands/SearchPlaceIndexForTextCommand.ts index 37c1748302cd..f71837c9ff25 100644 --- a/clients/client-location/commands/SearchPlaceIndexForTextCommand.ts +++ b/clients/client-location/commands/SearchPlaceIndexForTextCommand.ts @@ -40,6 +40,20 @@ export interface SearchPlaceIndexForTextCommandOutput extends SearchPlaceIndexFo * information, see the AWS Service * Terms for Amazon Location Service.

* + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { LocationClient, SearchPlaceIndexForTextCommand } from "@aws-sdk/client-location"; // ES Modules import + * // const { LocationClient, SearchPlaceIndexForTextCommand } = require("@aws-sdk/client-location"); // CommonJS import + * const client = new LocationClient(config); + * const command = new SearchPlaceIndexForTextCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link SearchPlaceIndexForTextCommandInput} for command's `input` shape. + * @see {@link SearchPlaceIndexForTextCommandOutput} for command's `response` shape. + * @see {@link LocationClientResolvedConfig | config} for command's `input` shape. + * */ export class SearchPlaceIndexForTextCommand extends $Command< SearchPlaceIndexForTextCommandInput, diff --git a/clients/client-location/models/models_0.ts b/clients/client-location/models/models_0.ts index d65fda7ef91f..1ff0035e39dd 100644 --- a/clients/client-location/models/models_0.ts +++ b/clients/client-location/models/models_0.ts @@ -12,6 +12,9 @@ export interface AccessDeniedException extends __SmithyException, $MetadataBeare } export namespace AccessDeniedException { + /** + * @internal + */ export const filterSensitiveLog = (obj: AccessDeniedException): any => ({ ...obj, }); @@ -38,6 +41,9 @@ export interface AssociateTrackerConsumerRequest { } export namespace AssociateTrackerConsumerRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: AssociateTrackerConsumerRequest): any => ({ ...obj, }); @@ -46,6 +52,9 @@ export namespace AssociateTrackerConsumerRequest { export interface AssociateTrackerConsumerResponse {} export namespace AssociateTrackerConsumerResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: AssociateTrackerConsumerResponse): any => ({ ...obj, }); @@ -61,6 +70,9 @@ export interface ConflictException extends __SmithyException, $MetadataBearer { } export namespace ConflictException { + /** + * @internal + */ export const filterSensitiveLog = (obj: ConflictException): any => ({ ...obj, }); @@ -77,6 +89,9 @@ export interface InternalServerException extends __SmithyException, $MetadataBea } export namespace InternalServerException { + /** + * @internal + */ export const filterSensitiveLog = (obj: InternalServerException): any => ({ ...obj, }); @@ -92,6 +107,9 @@ export interface ResourceNotFoundException extends __SmithyException, $MetadataB } export namespace ResourceNotFoundException { + /** + * @internal + */ export const filterSensitiveLog = (obj: ResourceNotFoundException): any => ({ ...obj, }); @@ -108,6 +126,9 @@ export interface ThrottlingException extends __SmithyException, $MetadataBearer } export namespace ThrottlingException { + /** + * @internal + */ export const filterSensitiveLog = (obj: ThrottlingException): any => ({ ...obj, }); @@ -130,6 +151,9 @@ export interface ValidationExceptionField { } export namespace ValidationExceptionField { + /** + * @internal + */ export const filterSensitiveLog = (obj: ValidationExceptionField): any => ({ ...obj, }); @@ -161,6 +185,9 @@ export interface ValidationException extends __SmithyException, $MetadataBearer } export namespace ValidationException { + /** + * @internal + */ export const filterSensitiveLog = (obj: ValidationException): any => ({ ...obj, }); @@ -179,6 +206,9 @@ export interface BatchDeleteGeofenceRequest { } export namespace BatchDeleteGeofenceRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: BatchDeleteGeofenceRequest): any => ({ ...obj, }); @@ -208,6 +238,9 @@ export interface BatchItemError { } export namespace BatchItemError { + /** + * @internal + */ export const filterSensitiveLog = (obj: BatchItemError): any => ({ ...obj, }); @@ -230,6 +263,9 @@ export interface BatchDeleteGeofenceError { } export namespace BatchDeleteGeofenceError { + /** + * @internal + */ export const filterSensitiveLog = (obj: BatchDeleteGeofenceError): any => ({ ...obj, }); @@ -243,6 +279,9 @@ export interface BatchDeleteGeofenceResponse { } export namespace BatchDeleteGeofenceResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: BatchDeleteGeofenceResponse): any => ({ ...obj, }); @@ -272,6 +311,9 @@ export interface DevicePositionUpdate { } export namespace DevicePositionUpdate { + /** + * @internal + */ export const filterSensitiveLog = (obj: DevicePositionUpdate): any => ({ ...obj, ...(obj.Position && { Position: SENSITIVE_STRING }), @@ -293,6 +335,9 @@ export interface BatchEvaluateGeofencesRequest { } export namespace BatchEvaluateGeofencesRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: BatchEvaluateGeofencesRequest): any => ({ ...obj, ...(obj.DevicePositionUpdates && { @@ -325,6 +370,9 @@ export interface BatchEvaluateGeofencesError { } export namespace BatchEvaluateGeofencesError { + /** + * @internal + */ export const filterSensitiveLog = (obj: BatchEvaluateGeofencesError): any => ({ ...obj, }); @@ -339,6 +387,9 @@ export interface BatchEvaluateGeofencesResponse { } export namespace BatchEvaluateGeofencesResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: BatchEvaluateGeofencesResponse): any => ({ ...obj, }); @@ -364,6 +415,9 @@ export interface BatchGetDevicePositionRequest { } export namespace BatchGetDevicePositionRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: BatchGetDevicePositionRequest): any => ({ ...obj, }); @@ -397,6 +451,9 @@ export interface DevicePosition { } export namespace DevicePosition { + /** + * @internal + */ export const filterSensitiveLog = (obj: DevicePosition): any => ({ ...obj, ...(obj.Position && { Position: SENSITIVE_STRING }), @@ -419,6 +476,9 @@ export interface BatchGetDevicePositionError { } export namespace BatchGetDevicePositionError { + /** + * @internal + */ export const filterSensitiveLog = (obj: BatchGetDevicePositionError): any => ({ ...obj, }); @@ -439,6 +499,9 @@ export interface BatchGetDevicePositionResponse { } export namespace BatchGetDevicePositionResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: BatchGetDevicePositionResponse): any => ({ ...obj, ...(obj.DevicePositions && { @@ -469,6 +532,9 @@ export interface GeofenceGeometry { } export namespace GeofenceGeometry { + /** + * @internal + */ export const filterSensitiveLog = (obj: GeofenceGeometry): any => ({ ...obj, ...(obj.Polygon && { Polygon: obj.Polygon.map((item) => SENSITIVE_STRING) }), @@ -494,6 +560,9 @@ export interface BatchPutGeofenceRequestEntry { } export namespace BatchPutGeofenceRequestEntry { + /** + * @internal + */ export const filterSensitiveLog = (obj: BatchPutGeofenceRequestEntry): any => ({ ...obj, ...(obj.Geometry && { Geometry: GeofenceGeometry.filterSensitiveLog(obj.Geometry) }), @@ -513,6 +582,9 @@ export interface BatchPutGeofenceRequest { } export namespace BatchPutGeofenceRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: BatchPutGeofenceRequest): any => ({ ...obj, ...(obj.Entries && { Entries: obj.Entries.map((item) => BatchPutGeofenceRequestEntry.filterSensitiveLog(item)) }), @@ -536,6 +608,9 @@ export interface BatchPutGeofenceError { } export namespace BatchPutGeofenceError { + /** + * @internal + */ export const filterSensitiveLog = (obj: BatchPutGeofenceError): any => ({ ...obj, }); @@ -567,6 +642,9 @@ export interface BatchPutGeofenceSuccess { } export namespace BatchPutGeofenceSuccess { + /** + * @internal + */ export const filterSensitiveLog = (obj: BatchPutGeofenceSuccess): any => ({ ...obj, }); @@ -586,6 +664,9 @@ export interface BatchPutGeofenceResponse { } export namespace BatchPutGeofenceResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: BatchPutGeofenceResponse): any => ({ ...obj, }); @@ -604,6 +685,9 @@ export interface BatchUpdateDevicePositionRequest { } export namespace BatchUpdateDevicePositionRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: BatchUpdateDevicePositionRequest): any => ({ ...obj, ...(obj.Updates && { Updates: obj.Updates.map((item) => DevicePositionUpdate.filterSensitiveLog(item)) }), @@ -633,6 +717,9 @@ export interface BatchUpdateDevicePositionError { } export namespace BatchUpdateDevicePositionError { + /** + * @internal + */ export const filterSensitiveLog = (obj: BatchUpdateDevicePositionError): any => ({ ...obj, }); @@ -646,6 +733,9 @@ export interface BatchUpdateDevicePositionResponse { } export namespace BatchUpdateDevicePositionResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: BatchUpdateDevicePositionResponse): any => ({ ...obj, }); @@ -698,6 +788,9 @@ export interface CreateGeofenceCollectionRequest { } export namespace CreateGeofenceCollectionRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateGeofenceCollectionRequest): any => ({ ...obj, }); @@ -724,6 +817,9 @@ export interface CreateGeofenceCollectionResponse { } export namespace CreateGeofenceCollectionResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateGeofenceCollectionResponse): any => ({ ...obj, }); @@ -748,6 +844,9 @@ export interface MapConfiguration { } export namespace MapConfiguration { + /** + * @internal + */ export const filterSensitiveLog = (obj: MapConfiguration): any => ({ ...obj, }); @@ -790,6 +889,9 @@ export interface CreateMapRequest { } export namespace CreateMapRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateMapRequest): any => ({ ...obj, }); @@ -822,6 +924,9 @@ export interface CreateMapResponse { } export namespace CreateMapResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateMapResponse): any => ({ ...obj, }); @@ -863,6 +968,9 @@ export interface DataSourceConfiguration { } export namespace DataSourceConfiguration { + /** + * @internal + */ export const filterSensitiveLog = (obj: DataSourceConfiguration): any => ({ ...obj, }); @@ -928,6 +1036,9 @@ export interface CreatePlaceIndexRequest { } export namespace CreatePlaceIndexRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreatePlaceIndexRequest): any => ({ ...obj, }); @@ -953,6 +1064,9 @@ export interface CreatePlaceIndexResponse { } export namespace CreatePlaceIndexResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreatePlaceIndexResponse): any => ({ ...obj, }); @@ -1002,6 +1116,9 @@ export interface CreateTrackerRequest { } export namespace CreateTrackerRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateTrackerRequest): any => ({ ...obj, }); @@ -1027,6 +1144,9 @@ export interface CreateTrackerResponse { } export namespace CreateTrackerResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateTrackerResponse): any => ({ ...obj, }); @@ -1040,6 +1160,9 @@ export interface DeleteGeofenceCollectionRequest { } export namespace DeleteGeofenceCollectionRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteGeofenceCollectionRequest): any => ({ ...obj, }); @@ -1048,6 +1171,9 @@ export namespace DeleteGeofenceCollectionRequest { export interface DeleteGeofenceCollectionResponse {} export namespace DeleteGeofenceCollectionResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteGeofenceCollectionResponse): any => ({ ...obj, }); @@ -1061,6 +1187,9 @@ export interface DeleteMapRequest { } export namespace DeleteMapRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteMapRequest): any => ({ ...obj, }); @@ -1069,6 +1198,9 @@ export namespace DeleteMapRequest { export interface DeleteMapResponse {} export namespace DeleteMapResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteMapResponse): any => ({ ...obj, }); @@ -1082,6 +1214,9 @@ export interface DeletePlaceIndexRequest { } export namespace DeletePlaceIndexRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeletePlaceIndexRequest): any => ({ ...obj, }); @@ -1090,6 +1225,9 @@ export namespace DeletePlaceIndexRequest { export interface DeletePlaceIndexResponse {} export namespace DeletePlaceIndexResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeletePlaceIndexResponse): any => ({ ...obj, }); @@ -1103,6 +1241,9 @@ export interface DeleteTrackerRequest { } export namespace DeleteTrackerRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteTrackerRequest): any => ({ ...obj, }); @@ -1111,6 +1252,9 @@ export namespace DeleteTrackerRequest { export interface DeleteTrackerResponse {} export namespace DeleteTrackerResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteTrackerResponse): any => ({ ...obj, }); @@ -1124,6 +1268,9 @@ export interface DescribeGeofenceCollectionRequest { } export namespace DescribeGeofenceCollectionRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeGeofenceCollectionRequest): any => ({ ...obj, }); @@ -1175,6 +1322,9 @@ export interface DescribeGeofenceCollectionResponse { } export namespace DescribeGeofenceCollectionResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeGeofenceCollectionResponse): any => ({ ...obj, }); @@ -1188,6 +1338,9 @@ export interface DescribeMapRequest { } export namespace DescribeMapRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeMapRequest): any => ({ ...obj, }); @@ -1242,6 +1395,9 @@ export interface DescribeMapResponse { } export namespace DescribeMapResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeMapResponse): any => ({ ...obj, }); @@ -1255,6 +1411,9 @@ export interface DescribePlaceIndexRequest { } export namespace DescribePlaceIndexRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribePlaceIndexRequest): any => ({ ...obj, }); @@ -1322,6 +1481,9 @@ export interface DescribePlaceIndexResponse { } export namespace DescribePlaceIndexResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribePlaceIndexResponse): any => ({ ...obj, }); @@ -1335,6 +1497,9 @@ export interface DescribeTrackerRequest { } export namespace DescribeTrackerRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeTrackerRequest): any => ({ ...obj, }); @@ -1383,6 +1548,9 @@ export interface DescribeTrackerResponse { } export namespace DescribeTrackerResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeTrackerResponse): any => ({ ...obj, }); @@ -1409,6 +1577,9 @@ export interface DisassociateTrackerConsumerRequest { } export namespace DisassociateTrackerConsumerRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DisassociateTrackerConsumerRequest): any => ({ ...obj, }); @@ -1417,6 +1588,9 @@ export namespace DisassociateTrackerConsumerRequest { export interface DisassociateTrackerConsumerResponse {} export namespace DisassociateTrackerConsumerResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DisassociateTrackerConsumerResponse): any => ({ ...obj, }); @@ -1435,6 +1609,9 @@ export interface GetGeofenceRequest { } export namespace GetGeofenceRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetGeofenceRequest): any => ({ ...obj, }); @@ -1497,6 +1674,9 @@ export interface GetGeofenceResponse { } export namespace GetGeofenceResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetGeofenceResponse): any => ({ ...obj, ...(obj.Geometry && { Geometry: GeofenceGeometry.filterSensitiveLog(obj.Geometry) }), @@ -1521,6 +1701,9 @@ export interface ListGeofenceCollectionsRequest { } export namespace ListGeofenceCollectionsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListGeofenceCollectionsRequest): any => ({ ...obj, }); @@ -1569,6 +1752,9 @@ export interface ListGeofenceCollectionsResponseEntry { } export namespace ListGeofenceCollectionsResponseEntry { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListGeofenceCollectionsResponseEntry): any => ({ ...obj, }); @@ -1588,6 +1774,9 @@ export interface ListGeofenceCollectionsResponse { } export namespace ListGeofenceCollectionsResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListGeofenceCollectionsResponse): any => ({ ...obj, }); @@ -1609,6 +1798,9 @@ export interface ListGeofencesRequest { } export namespace ListGeofencesRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListGeofencesRequest): any => ({ ...obj, }); @@ -1674,6 +1866,9 @@ export interface ListGeofenceResponseEntry { } export namespace ListGeofenceResponseEntry { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListGeofenceResponseEntry): any => ({ ...obj, ...(obj.Geometry && { Geometry: GeofenceGeometry.filterSensitiveLog(obj.Geometry) }), @@ -1694,6 +1889,9 @@ export interface ListGeofencesResponse { } export namespace ListGeofencesResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListGeofencesResponse): any => ({ ...obj, ...(obj.Entries && { Entries: obj.Entries.map((item) => ListGeofenceResponseEntry.filterSensitiveLog(item)) }), @@ -1721,6 +1919,9 @@ export interface PutGeofenceRequest { } export namespace PutGeofenceRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: PutGeofenceRequest): any => ({ ...obj, ...(obj.Geometry && { Geometry: GeofenceGeometry.filterSensitiveLog(obj.Geometry) }), @@ -1749,6 +1950,9 @@ export interface PutGeofenceResponse { } export namespace PutGeofenceResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: PutGeofenceResponse): any => ({ ...obj, }); @@ -1767,6 +1971,9 @@ export interface GetDevicePositionRequest { } export namespace GetDevicePositionRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetDevicePositionRequest): any => ({ ...obj, }); @@ -1797,6 +2004,9 @@ export interface GetDevicePositionResponse { } export namespace GetDevicePositionResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetDevicePositionResponse): any => ({ ...obj, ...(obj.Position && { Position: SENSITIVE_STRING }), @@ -1852,6 +2062,9 @@ export interface GetDevicePositionHistoryRequest { } export namespace GetDevicePositionHistoryRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetDevicePositionHistoryRequest): any => ({ ...obj, }); @@ -1871,6 +2084,9 @@ export interface GetDevicePositionHistoryResponse { } export namespace GetDevicePositionHistoryResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetDevicePositionHistoryResponse): any => ({ ...obj, ...(obj.DevicePositions && { @@ -1900,6 +2116,9 @@ export interface GetMapGlyphsRequest { } export namespace GetMapGlyphsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetMapGlyphsRequest): any => ({ ...obj, }); @@ -1918,6 +2137,9 @@ export interface GetMapGlyphsResponse { } export namespace GetMapGlyphsResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetMapGlyphsResponse): any => ({ ...obj, }); @@ -1959,6 +2181,9 @@ export interface GetMapSpritesRequest { } export namespace GetMapSpritesRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetMapSpritesRequest): any => ({ ...obj, }); @@ -1979,6 +2204,9 @@ export interface GetMapSpritesResponse { } export namespace GetMapSpritesResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetMapSpritesResponse): any => ({ ...obj, }); @@ -1992,6 +2220,9 @@ export interface GetMapStyleDescriptorRequest { } export namespace GetMapStyleDescriptorRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetMapStyleDescriptorRequest): any => ({ ...obj, }); @@ -2011,6 +2242,9 @@ export interface GetMapStyleDescriptorResponse { } export namespace GetMapStyleDescriptorResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetMapStyleDescriptorResponse): any => ({ ...obj, }); @@ -2039,6 +2273,9 @@ export interface GetMapTileRequest { } export namespace GetMapTileRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetMapTileRequest): any => ({ ...obj, }); @@ -2058,6 +2295,9 @@ export interface GetMapTileResponse { } export namespace GetMapTileResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetMapTileResponse): any => ({ ...obj, }); @@ -2081,6 +2321,9 @@ export interface ListMapsRequest { } export namespace ListMapsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListMapsRequest): any => ({ ...obj, }); @@ -2126,6 +2369,9 @@ export interface ListMapsResponseEntry { } export namespace ListMapsResponseEntry { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListMapsResponseEntry): any => ({ ...obj, }); @@ -2144,6 +2390,9 @@ export interface ListMapsResponse { } export namespace ListMapsResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListMapsResponse): any => ({ ...obj, }); @@ -2167,6 +2416,9 @@ export interface ListPlaceIndexesRequest { } export namespace ListPlaceIndexesRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListPlaceIndexesRequest): any => ({ ...obj, }); @@ -2221,6 +2473,9 @@ export interface ListPlaceIndexesResponseEntry { } export namespace ListPlaceIndexesResponseEntry { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListPlaceIndexesResponseEntry): any => ({ ...obj, }); @@ -2240,6 +2495,9 @@ export interface ListPlaceIndexesResponse { } export namespace ListPlaceIndexesResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListPlaceIndexesResponse): any => ({ ...obj, }); @@ -2268,6 +2526,9 @@ export interface ListTrackerConsumersRequest { } export namespace ListTrackerConsumersRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListTrackerConsumersRequest): any => ({ ...obj, }); @@ -2287,6 +2548,9 @@ export interface ListTrackerConsumersResponse { } export namespace ListTrackerConsumersResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListTrackerConsumersResponse): any => ({ ...obj, }); @@ -2310,6 +2574,9 @@ export interface ListTrackersRequest { } export namespace ListTrackersRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListTrackersRequest): any => ({ ...obj, }); @@ -2355,6 +2622,9 @@ export interface ListTrackersResponseEntry { } export namespace ListTrackersResponseEntry { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListTrackersResponseEntry): any => ({ ...obj, }); @@ -2375,6 +2645,9 @@ export interface ListTrackersResponse { } export namespace ListTrackersResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListTrackersResponse): any => ({ ...obj, }); @@ -2409,6 +2682,9 @@ export interface SearchPlaceIndexForPositionRequest { } export namespace SearchPlaceIndexForPositionRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: SearchPlaceIndexForPositionRequest): any => ({ ...obj, ...(obj.Position && { Position: SENSITIVE_STRING }), @@ -2437,6 +2713,9 @@ export interface PlaceGeometry { } export namespace PlaceGeometry { + /** + * @internal + */ export const filterSensitiveLog = (obj: PlaceGeometry): any => ({ ...obj, ...(obj.Point && { Point: SENSITIVE_STRING }), @@ -2507,6 +2786,9 @@ export interface Place { } export namespace Place { + /** + * @internal + */ export const filterSensitiveLog = (obj: Place): any => ({ ...obj, ...(obj.Geometry && { Geometry: PlaceGeometry.filterSensitiveLog(obj.Geometry) }), @@ -2525,6 +2807,9 @@ export interface SearchForPositionResult { } export namespace SearchForPositionResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: SearchForPositionResult): any => ({ ...obj, ...(obj.Place && { Place: Place.filterSensitiveLog(obj.Place) }), @@ -2563,6 +2848,9 @@ export interface SearchPlaceIndexForPositionSummary { } export namespace SearchPlaceIndexForPositionSummary { + /** + * @internal + */ export const filterSensitiveLog = (obj: SearchPlaceIndexForPositionSummary): any => ({ ...obj, ...(obj.Position && { Position: SENSITIVE_STRING }), @@ -2583,6 +2871,9 @@ export interface SearchPlaceIndexForPositionResponse { } export namespace SearchPlaceIndexForPositionResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: SearchPlaceIndexForPositionResponse): any => ({ ...obj, ...(obj.Summary && { Summary: SearchPlaceIndexForPositionSummary.filterSensitiveLog(obj.Summary) }), @@ -2671,6 +2962,9 @@ export interface SearchPlaceIndexForTextRequest { } export namespace SearchPlaceIndexForTextRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: SearchPlaceIndexForTextRequest): any => ({ ...obj, ...(obj.Text && { Text: SENSITIVE_STRING }), @@ -2691,6 +2985,9 @@ export interface SearchForTextResult { } export namespace SearchForTextResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: SearchForTextResult): any => ({ ...obj, ...(obj.Place && { Place: Place.filterSensitiveLog(obj.Place) }), @@ -2751,6 +3048,9 @@ export interface SearchPlaceIndexForTextSummary { } export namespace SearchPlaceIndexForTextSummary { + /** + * @internal + */ export const filterSensitiveLog = (obj: SearchPlaceIndexForTextSummary): any => ({ ...obj, ...(obj.Text && { Text: SENSITIVE_STRING }), @@ -2776,6 +3076,9 @@ export interface SearchPlaceIndexForTextResponse { } export namespace SearchPlaceIndexForTextResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: SearchPlaceIndexForTextResponse): any => ({ ...obj, ...(obj.Summary && { Summary: SearchPlaceIndexForTextSummary.filterSensitiveLog(obj.Summary) }), diff --git a/clients/client-lookoutequipment/commands/CreateDatasetCommand.ts b/clients/client-lookoutequipment/commands/CreateDatasetCommand.ts index f9347ec7abe2..6355c68619ae 100644 --- a/clients/client-lookoutequipment/commands/CreateDatasetCommand.ts +++ b/clients/client-lookoutequipment/commands/CreateDatasetCommand.ts @@ -25,6 +25,20 @@ export interface CreateDatasetCommandOutput extends CreateDatasetResponse, __Met * 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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { LookoutEquipmentClient, CreateDatasetCommand } from "@aws-sdk/client-lookoutequipment"; // ES Modules import + * // const { LookoutEquipmentClient, CreateDatasetCommand } = require("@aws-sdk/client-lookoutequipment"); // CommonJS import + * const client = new LookoutEquipmentClient(config); + * const command = new CreateDatasetCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreateDatasetCommandInput} for command's `input` shape. + * @see {@link CreateDatasetCommandOutput} for command's `response` shape. + * @see {@link LookoutEquipmentClientResolvedConfig | config} for command's `input` shape. + * */ export class CreateDatasetCommand extends $Command< CreateDatasetCommandInput, diff --git a/clients/client-lookoutequipment/commands/CreateInferenceSchedulerCommand.ts b/clients/client-lookoutequipment/commands/CreateInferenceSchedulerCommand.ts index ad02d164d8be..6336247dcafe 100644 --- a/clients/client-lookoutequipment/commands/CreateInferenceSchedulerCommand.ts +++ b/clients/client-lookoutequipment/commands/CreateInferenceSchedulerCommand.ts @@ -26,6 +26,20 @@ export interface CreateInferenceSchedulerCommandOutput extends CreateInferenceSc * 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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { LookoutEquipmentClient, CreateInferenceSchedulerCommand } from "@aws-sdk/client-lookoutequipment"; // ES Modules import + * // const { LookoutEquipmentClient, CreateInferenceSchedulerCommand } = require("@aws-sdk/client-lookoutequipment"); // CommonJS import + * const client = new LookoutEquipmentClient(config); + * const command = new CreateInferenceSchedulerCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreateInferenceSchedulerCommandInput} for command's `input` shape. + * @see {@link CreateInferenceSchedulerCommandOutput} for command's `response` shape. + * @see {@link LookoutEquipmentClientResolvedConfig | config} for command's `input` shape. + * */ export class CreateInferenceSchedulerCommand extends $Command< CreateInferenceSchedulerCommandInput, diff --git a/clients/client-lookoutequipment/commands/CreateModelCommand.ts b/clients/client-lookoutequipment/commands/CreateModelCommand.ts index 9b4b585518b6..74d1ea4d776b 100644 --- a/clients/client-lookoutequipment/commands/CreateModelCommand.ts +++ b/clients/client-lookoutequipment/commands/CreateModelCommand.ts @@ -30,6 +30,20 @@ export interface CreateModelCommandOutput extends CreateModelResponse, __Metadat *

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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { LookoutEquipmentClient, CreateModelCommand } from "@aws-sdk/client-lookoutequipment"; // ES Modules import + * // const { LookoutEquipmentClient, CreateModelCommand } = require("@aws-sdk/client-lookoutequipment"); // CommonJS import + * const client = new LookoutEquipmentClient(config); + * const command = new CreateModelCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreateModelCommandInput} for command's `input` shape. + * @see {@link CreateModelCommandOutput} for command's `response` shape. + * @see {@link LookoutEquipmentClientResolvedConfig | config} for command's `input` shape. + * */ export class CreateModelCommand extends $Command< CreateModelCommandInput, diff --git a/clients/client-lookoutequipment/commands/DeleteDatasetCommand.ts b/clients/client-lookoutequipment/commands/DeleteDatasetCommand.ts index 9fa32a976ff8..48b3c38ec6da 100644 --- a/clients/client-lookoutequipment/commands/DeleteDatasetCommand.ts +++ b/clients/client-lookoutequipment/commands/DeleteDatasetCommand.ts @@ -26,6 +26,20 @@ export interface DeleteDatasetCommandOutput extends __MetadataBearer {} * 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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { LookoutEquipmentClient, DeleteDatasetCommand } from "@aws-sdk/client-lookoutequipment"; // ES Modules import + * // const { LookoutEquipmentClient, DeleteDatasetCommand } = require("@aws-sdk/client-lookoutequipment"); // CommonJS import + * const client = new LookoutEquipmentClient(config); + * const command = new DeleteDatasetCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteDatasetCommandInput} for command's `input` shape. + * @see {@link DeleteDatasetCommandOutput} for command's `response` shape. + * @see {@link LookoutEquipmentClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteDatasetCommand extends $Command< DeleteDatasetCommandInput, diff --git a/clients/client-lookoutequipment/commands/DeleteInferenceSchedulerCommand.ts b/clients/client-lookoutequipment/commands/DeleteInferenceSchedulerCommand.ts index ad15b5c51e22..ee3fd2e37c71 100644 --- a/clients/client-lookoutequipment/commands/DeleteInferenceSchedulerCommand.ts +++ b/clients/client-lookoutequipment/commands/DeleteInferenceSchedulerCommand.ts @@ -23,6 +23,20 @@ export interface DeleteInferenceSchedulerCommandOutput extends __MetadataBearer /** *

Deletes an inference scheduler that has been set up. Already processed output results * are not affected.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { LookoutEquipmentClient, DeleteInferenceSchedulerCommand } from "@aws-sdk/client-lookoutequipment"; // ES Modules import + * // const { LookoutEquipmentClient, DeleteInferenceSchedulerCommand } = require("@aws-sdk/client-lookoutequipment"); // CommonJS import + * const client = new LookoutEquipmentClient(config); + * const command = new DeleteInferenceSchedulerCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteInferenceSchedulerCommandInput} for command's `input` shape. + * @see {@link DeleteInferenceSchedulerCommandOutput} for command's `response` shape. + * @see {@link LookoutEquipmentClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteInferenceSchedulerCommand extends $Command< DeleteInferenceSchedulerCommandInput, diff --git a/clients/client-lookoutequipment/commands/DeleteModelCommand.ts b/clients/client-lookoutequipment/commands/DeleteModelCommand.ts index 2490e7053e58..d478d01926c0 100644 --- a/clients/client-lookoutequipment/commands/DeleteModelCommand.ts +++ b/clients/client-lookoutequipment/commands/DeleteModelCommand.ts @@ -23,6 +23,20 @@ export interface DeleteModelCommandOutput extends __MetadataBearer {} /** *

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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { LookoutEquipmentClient, DeleteModelCommand } from "@aws-sdk/client-lookoutequipment"; // ES Modules import + * // const { LookoutEquipmentClient, DeleteModelCommand } = require("@aws-sdk/client-lookoutequipment"); // CommonJS import + * const client = new LookoutEquipmentClient(config); + * const command = new DeleteModelCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteModelCommandInput} for command's `input` shape. + * @see {@link DeleteModelCommandOutput} for command's `response` shape. + * @see {@link LookoutEquipmentClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteModelCommand extends $Command< DeleteModelCommandInput, diff --git a/clients/client-lookoutequipment/commands/DescribeDataIngestionJobCommand.ts b/clients/client-lookoutequipment/commands/DescribeDataIngestionJobCommand.ts index 63c45d94ab1e..b3aab3751a66 100644 --- a/clients/client-lookoutequipment/commands/DescribeDataIngestionJobCommand.ts +++ b/clients/client-lookoutequipment/commands/DescribeDataIngestionJobCommand.ts @@ -23,6 +23,20 @@ export interface DescribeDataIngestionJobCommandOutput extends DescribeDataInges /** *

Provides information on a specific data ingestion job such as creation time, dataset * ARN, status, and so on.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { LookoutEquipmentClient, DescribeDataIngestionJobCommand } from "@aws-sdk/client-lookoutequipment"; // ES Modules import + * // const { LookoutEquipmentClient, DescribeDataIngestionJobCommand } = require("@aws-sdk/client-lookoutequipment"); // CommonJS import + * const client = new LookoutEquipmentClient(config); + * const command = new DescribeDataIngestionJobCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeDataIngestionJobCommandInput} for command's `input` shape. + * @see {@link DescribeDataIngestionJobCommandOutput} for command's `response` shape. + * @see {@link LookoutEquipmentClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeDataIngestionJobCommand extends $Command< DescribeDataIngestionJobCommandInput, diff --git a/clients/client-lookoutequipment/commands/DescribeDatasetCommand.ts b/clients/client-lookoutequipment/commands/DescribeDatasetCommand.ts index 940d3fdd8d3f..ef768e0ec665 100644 --- a/clients/client-lookoutequipment/commands/DescribeDatasetCommand.ts +++ b/clients/client-lookoutequipment/commands/DescribeDatasetCommand.ts @@ -23,6 +23,20 @@ export interface DescribeDatasetCommandOutput extends DescribeDatasetResponse, _ /** *

Provides information on a specified dataset such as the schema location, status, and so * on.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { LookoutEquipmentClient, DescribeDatasetCommand } from "@aws-sdk/client-lookoutequipment"; // ES Modules import + * // const { LookoutEquipmentClient, DescribeDatasetCommand } = require("@aws-sdk/client-lookoutequipment"); // CommonJS import + * const client = new LookoutEquipmentClient(config); + * const command = new DescribeDatasetCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeDatasetCommandInput} for command's `input` shape. + * @see {@link DescribeDatasetCommandOutput} for command's `response` shape. + * @see {@link LookoutEquipmentClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeDatasetCommand extends $Command< DescribeDatasetCommandInput, diff --git a/clients/client-lookoutequipment/commands/DescribeInferenceSchedulerCommand.ts b/clients/client-lookoutequipment/commands/DescribeInferenceSchedulerCommand.ts index 04e829cb01c8..2b2058cddec6 100644 --- a/clients/client-lookoutequipment/commands/DescribeInferenceSchedulerCommand.ts +++ b/clients/client-lookoutequipment/commands/DescribeInferenceSchedulerCommand.ts @@ -23,6 +23,20 @@ export interface DescribeInferenceSchedulerCommandOutput extends DescribeInferen /** *

Specifies information about the inference scheduler being used, including name, model, * status, and associated metadata

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { LookoutEquipmentClient, DescribeInferenceSchedulerCommand } from "@aws-sdk/client-lookoutequipment"; // ES Modules import + * // const { LookoutEquipmentClient, DescribeInferenceSchedulerCommand } = require("@aws-sdk/client-lookoutequipment"); // CommonJS import + * const client = new LookoutEquipmentClient(config); + * const command = new DescribeInferenceSchedulerCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeInferenceSchedulerCommandInput} for command's `input` shape. + * @see {@link DescribeInferenceSchedulerCommandOutput} for command's `response` shape. + * @see {@link LookoutEquipmentClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeInferenceSchedulerCommand extends $Command< DescribeInferenceSchedulerCommandInput, diff --git a/clients/client-lookoutequipment/commands/DescribeModelCommand.ts b/clients/client-lookoutequipment/commands/DescribeModelCommand.ts index 32b97e6c2c6b..57b1c82d2c6f 100644 --- a/clients/client-lookoutequipment/commands/DescribeModelCommand.ts +++ b/clients/client-lookoutequipment/commands/DescribeModelCommand.ts @@ -23,6 +23,20 @@ export interface DescribeModelCommandOutput extends DescribeModelResponse, __Met /** *

Provides overall information about a specific ML model, including model name and ARN, * dataset, training and evaluation information, status, and so on.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { LookoutEquipmentClient, DescribeModelCommand } from "@aws-sdk/client-lookoutequipment"; // ES Modules import + * // const { LookoutEquipmentClient, DescribeModelCommand } = require("@aws-sdk/client-lookoutequipment"); // CommonJS import + * const client = new LookoutEquipmentClient(config); + * const command = new DescribeModelCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeModelCommandInput} for command's `input` shape. + * @see {@link DescribeModelCommandOutput} for command's `response` shape. + * @see {@link LookoutEquipmentClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeModelCommand extends $Command< DescribeModelCommandInput, diff --git a/clients/client-lookoutequipment/commands/ListDataIngestionJobsCommand.ts b/clients/client-lookoutequipment/commands/ListDataIngestionJobsCommand.ts index 22c912f1cb55..786351e3b520 100644 --- a/clients/client-lookoutequipment/commands/ListDataIngestionJobsCommand.ts +++ b/clients/client-lookoutequipment/commands/ListDataIngestionJobsCommand.ts @@ -23,6 +23,20 @@ export interface ListDataIngestionJobsCommandOutput extends ListDataIngestionJob /** *

Provides a list of all data ingestion jobs, including dataset name and ARN, S3 location * of the input data, status, and so on.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { LookoutEquipmentClient, ListDataIngestionJobsCommand } from "@aws-sdk/client-lookoutequipment"; // ES Modules import + * // const { LookoutEquipmentClient, ListDataIngestionJobsCommand } = require("@aws-sdk/client-lookoutequipment"); // CommonJS import + * const client = new LookoutEquipmentClient(config); + * const command = new ListDataIngestionJobsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListDataIngestionJobsCommandInput} for command's `input` shape. + * @see {@link ListDataIngestionJobsCommandOutput} for command's `response` shape. + * @see {@link LookoutEquipmentClientResolvedConfig | config} for command's `input` shape. + * */ export class ListDataIngestionJobsCommand extends $Command< ListDataIngestionJobsCommandInput, diff --git a/clients/client-lookoutequipment/commands/ListDatasetsCommand.ts b/clients/client-lookoutequipment/commands/ListDatasetsCommand.ts index 02c59c08e334..763365868d5e 100644 --- a/clients/client-lookoutequipment/commands/ListDatasetsCommand.ts +++ b/clients/client-lookoutequipment/commands/ListDatasetsCommand.ts @@ -23,6 +23,20 @@ export interface ListDatasetsCommandOutput extends ListDatasetsResponse, __Metad /** *

Lists all datasets currently available in your account, filtering on the dataset name. *

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { LookoutEquipmentClient, ListDatasetsCommand } from "@aws-sdk/client-lookoutequipment"; // ES Modules import + * // const { LookoutEquipmentClient, ListDatasetsCommand } = require("@aws-sdk/client-lookoutequipment"); // CommonJS import + * const client = new LookoutEquipmentClient(config); + * const command = new ListDatasetsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListDatasetsCommandInput} for command's `input` shape. + * @see {@link ListDatasetsCommandOutput} for command's `response` shape. + * @see {@link LookoutEquipmentClientResolvedConfig | config} for command's `input` shape. + * */ export class ListDatasetsCommand extends $Command< ListDatasetsCommandInput, diff --git a/clients/client-lookoutequipment/commands/ListInferenceExecutionsCommand.ts b/clients/client-lookoutequipment/commands/ListInferenceExecutionsCommand.ts index fcfed284c4a1..a726fe8d6b7d 100644 --- a/clients/client-lookoutequipment/commands/ListInferenceExecutionsCommand.ts +++ b/clients/client-lookoutequipment/commands/ListInferenceExecutionsCommand.ts @@ -23,6 +23,20 @@ export interface ListInferenceExecutionsCommandOutput extends ListInferenceExecu /** *

Lists all inference executions that have been performed by the specified inference * scheduler.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { LookoutEquipmentClient, ListInferenceExecutionsCommand } from "@aws-sdk/client-lookoutequipment"; // ES Modules import + * // const { LookoutEquipmentClient, ListInferenceExecutionsCommand } = require("@aws-sdk/client-lookoutequipment"); // CommonJS import + * const client = new LookoutEquipmentClient(config); + * const command = new ListInferenceExecutionsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListInferenceExecutionsCommandInput} for command's `input` shape. + * @see {@link ListInferenceExecutionsCommandOutput} for command's `response` shape. + * @see {@link LookoutEquipmentClientResolvedConfig | config} for command's `input` shape. + * */ export class ListInferenceExecutionsCommand extends $Command< ListInferenceExecutionsCommandInput, diff --git a/clients/client-lookoutequipment/commands/ListInferenceSchedulersCommand.ts b/clients/client-lookoutequipment/commands/ListInferenceSchedulersCommand.ts index 2ea7cfe6895b..65130cf6d5fe 100644 --- a/clients/client-lookoutequipment/commands/ListInferenceSchedulersCommand.ts +++ b/clients/client-lookoutequipment/commands/ListInferenceSchedulersCommand.ts @@ -23,6 +23,20 @@ export interface ListInferenceSchedulersCommandOutput extends ListInferenceSched /** *

Retrieves a list of all inference schedulers currently available for your account. *

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { LookoutEquipmentClient, ListInferenceSchedulersCommand } from "@aws-sdk/client-lookoutequipment"; // ES Modules import + * // const { LookoutEquipmentClient, ListInferenceSchedulersCommand } = require("@aws-sdk/client-lookoutequipment"); // CommonJS import + * const client = new LookoutEquipmentClient(config); + * const command = new ListInferenceSchedulersCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListInferenceSchedulersCommandInput} for command's `input` shape. + * @see {@link ListInferenceSchedulersCommandOutput} for command's `response` shape. + * @see {@link LookoutEquipmentClientResolvedConfig | config} for command's `input` shape. + * */ export class ListInferenceSchedulersCommand extends $Command< ListInferenceSchedulersCommandInput, diff --git a/clients/client-lookoutequipment/commands/ListModelsCommand.ts b/clients/client-lookoutequipment/commands/ListModelsCommand.ts index 446718a22fb1..e7995251cee2 100644 --- a/clients/client-lookoutequipment/commands/ListModelsCommand.ts +++ b/clients/client-lookoutequipment/commands/ListModelsCommand.ts @@ -23,6 +23,20 @@ export interface ListModelsCommandOutput extends ListModelsResponse, __MetadataB /** *

Generates a list of all models in the account, including model name and ARN, dataset, * and status.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { LookoutEquipmentClient, ListModelsCommand } from "@aws-sdk/client-lookoutequipment"; // ES Modules import + * // const { LookoutEquipmentClient, ListModelsCommand } = require("@aws-sdk/client-lookoutequipment"); // CommonJS import + * const client = new LookoutEquipmentClient(config); + * const command = new ListModelsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListModelsCommandInput} for command's `input` shape. + * @see {@link ListModelsCommandOutput} for command's `response` shape. + * @see {@link LookoutEquipmentClientResolvedConfig | config} for command's `input` shape. + * */ export class ListModelsCommand extends $Command< ListModelsCommandInput, diff --git a/clients/client-lookoutequipment/commands/ListTagsForResourceCommand.ts b/clients/client-lookoutequipment/commands/ListTagsForResourceCommand.ts index b492610ed9cf..f53c37c297ce 100644 --- a/clients/client-lookoutequipment/commands/ListTagsForResourceCommand.ts +++ b/clients/client-lookoutequipment/commands/ListTagsForResourceCommand.ts @@ -22,6 +22,20 @@ export interface ListTagsForResourceCommandOutput extends ListTagsForResourceRes /** *

Lists all the tags for a specified resource, including key and value.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { LookoutEquipmentClient, ListTagsForResourceCommand } from "@aws-sdk/client-lookoutequipment"; // ES Modules import + * // const { LookoutEquipmentClient, ListTagsForResourceCommand } = require("@aws-sdk/client-lookoutequipment"); // CommonJS import + * const client = new LookoutEquipmentClient(config); + * const command = new ListTagsForResourceCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListTagsForResourceCommandInput} for command's `input` shape. + * @see {@link ListTagsForResourceCommandOutput} for command's `response` shape. + * @see {@link LookoutEquipmentClientResolvedConfig | config} for command's `input` shape. + * */ export class ListTagsForResourceCommand extends $Command< ListTagsForResourceCommandInput, diff --git a/clients/client-lookoutequipment/commands/StartDataIngestionJobCommand.ts b/clients/client-lookoutequipment/commands/StartDataIngestionJobCommand.ts index 5f850e0d0d9f..29ce2557a6fe 100644 --- a/clients/client-lookoutequipment/commands/StartDataIngestionJobCommand.ts +++ b/clients/client-lookoutequipment/commands/StartDataIngestionJobCommand.ts @@ -22,6 +22,20 @@ export interface StartDataIngestionJobCommandOutput extends StartDataIngestionJo /** *

Starts a data ingestion job. Amazon Lookout for Equipment returns the job status.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { LookoutEquipmentClient, StartDataIngestionJobCommand } from "@aws-sdk/client-lookoutequipment"; // ES Modules import + * // const { LookoutEquipmentClient, StartDataIngestionJobCommand } = require("@aws-sdk/client-lookoutequipment"); // CommonJS import + * const client = new LookoutEquipmentClient(config); + * const command = new StartDataIngestionJobCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link StartDataIngestionJobCommandInput} for command's `input` shape. + * @see {@link StartDataIngestionJobCommandOutput} for command's `response` shape. + * @see {@link LookoutEquipmentClientResolvedConfig | config} for command's `input` shape. + * */ export class StartDataIngestionJobCommand extends $Command< StartDataIngestionJobCommandInput, diff --git a/clients/client-lookoutequipment/commands/StartInferenceSchedulerCommand.ts b/clients/client-lookoutequipment/commands/StartInferenceSchedulerCommand.ts index 64977570c702..775a056ada07 100644 --- a/clients/client-lookoutequipment/commands/StartInferenceSchedulerCommand.ts +++ b/clients/client-lookoutequipment/commands/StartInferenceSchedulerCommand.ts @@ -22,6 +22,20 @@ export interface StartInferenceSchedulerCommandOutput extends StartInferenceSche /** *

Starts an inference scheduler.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { LookoutEquipmentClient, StartInferenceSchedulerCommand } from "@aws-sdk/client-lookoutequipment"; // ES Modules import + * // const { LookoutEquipmentClient, StartInferenceSchedulerCommand } = require("@aws-sdk/client-lookoutequipment"); // CommonJS import + * const client = new LookoutEquipmentClient(config); + * const command = new StartInferenceSchedulerCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link StartInferenceSchedulerCommandInput} for command's `input` shape. + * @see {@link StartInferenceSchedulerCommandOutput} for command's `response` shape. + * @see {@link LookoutEquipmentClientResolvedConfig | config} for command's `input` shape. + * */ export class StartInferenceSchedulerCommand extends $Command< StartInferenceSchedulerCommandInput, diff --git a/clients/client-lookoutequipment/commands/StopInferenceSchedulerCommand.ts b/clients/client-lookoutequipment/commands/StopInferenceSchedulerCommand.ts index 5a0b5fc330f4..c078bfb5e3c4 100644 --- a/clients/client-lookoutequipment/commands/StopInferenceSchedulerCommand.ts +++ b/clients/client-lookoutequipment/commands/StopInferenceSchedulerCommand.ts @@ -22,6 +22,20 @@ export interface StopInferenceSchedulerCommandOutput extends StopInferenceSchedu /** *

Stops an inference scheduler.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { LookoutEquipmentClient, StopInferenceSchedulerCommand } from "@aws-sdk/client-lookoutequipment"; // ES Modules import + * // const { LookoutEquipmentClient, StopInferenceSchedulerCommand } = require("@aws-sdk/client-lookoutequipment"); // CommonJS import + * const client = new LookoutEquipmentClient(config); + * const command = new StopInferenceSchedulerCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link StopInferenceSchedulerCommandInput} for command's `input` shape. + * @see {@link StopInferenceSchedulerCommandOutput} for command's `response` shape. + * @see {@link LookoutEquipmentClientResolvedConfig | config} for command's `input` shape. + * */ export class StopInferenceSchedulerCommand extends $Command< StopInferenceSchedulerCommandInput, diff --git a/clients/client-lookoutequipment/commands/TagResourceCommand.ts b/clients/client-lookoutequipment/commands/TagResourceCommand.ts index de37e82e3e2e..4d56ed5ad20f 100644 --- a/clients/client-lookoutequipment/commands/TagResourceCommand.ts +++ b/clients/client-lookoutequipment/commands/TagResourceCommand.ts @@ -26,6 +26,20 @@ export interface TagResourceCommandOutput extends TagResourceResponse, __Metadat * 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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { LookoutEquipmentClient, TagResourceCommand } from "@aws-sdk/client-lookoutequipment"; // ES Modules import + * // const { LookoutEquipmentClient, TagResourceCommand } = require("@aws-sdk/client-lookoutequipment"); // CommonJS import + * const client = new LookoutEquipmentClient(config); + * const command = new TagResourceCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link TagResourceCommandInput} for command's `input` shape. + * @see {@link TagResourceCommandOutput} for command's `response` shape. + * @see {@link LookoutEquipmentClientResolvedConfig | config} for command's `input` shape. + * */ export class TagResourceCommand extends $Command< TagResourceCommandInput, diff --git a/clients/client-lookoutequipment/commands/UntagResourceCommand.ts b/clients/client-lookoutequipment/commands/UntagResourceCommand.ts index cc7aee5ea439..fa669c1f5c8a 100644 --- a/clients/client-lookoutequipment/commands/UntagResourceCommand.ts +++ b/clients/client-lookoutequipment/commands/UntagResourceCommand.ts @@ -22,6 +22,20 @@ export interface UntagResourceCommandOutput extends UntagResourceResponse, __Met /** *

Removes a specific tag from a given resource. The tag is specified by its key.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { LookoutEquipmentClient, UntagResourceCommand } from "@aws-sdk/client-lookoutequipment"; // ES Modules import + * // const { LookoutEquipmentClient, UntagResourceCommand } = require("@aws-sdk/client-lookoutequipment"); // CommonJS import + * const client = new LookoutEquipmentClient(config); + * const command = new UntagResourceCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link UntagResourceCommandInput} for command's `input` shape. + * @see {@link UntagResourceCommandOutput} for command's `response` shape. + * @see {@link LookoutEquipmentClientResolvedConfig | config} for command's `input` shape. + * */ export class UntagResourceCommand extends $Command< UntagResourceCommandInput, diff --git a/clients/client-lookoutequipment/commands/UpdateInferenceSchedulerCommand.ts b/clients/client-lookoutequipment/commands/UpdateInferenceSchedulerCommand.ts index db9de23f4c9a..68daa42aa357 100644 --- a/clients/client-lookoutequipment/commands/UpdateInferenceSchedulerCommand.ts +++ b/clients/client-lookoutequipment/commands/UpdateInferenceSchedulerCommand.ts @@ -22,6 +22,20 @@ export interface UpdateInferenceSchedulerCommandOutput extends __MetadataBearer /** *

Updates an inference scheduler.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { LookoutEquipmentClient, UpdateInferenceSchedulerCommand } from "@aws-sdk/client-lookoutequipment"; // ES Modules import + * // const { LookoutEquipmentClient, UpdateInferenceSchedulerCommand } = require("@aws-sdk/client-lookoutequipment"); // CommonJS import + * const client = new LookoutEquipmentClient(config); + * const command = new UpdateInferenceSchedulerCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link UpdateInferenceSchedulerCommandInput} for command's `input` shape. + * @see {@link UpdateInferenceSchedulerCommandOutput} for command's `response` shape. + * @see {@link LookoutEquipmentClientResolvedConfig | config} for command's `input` shape. + * */ export class UpdateInferenceSchedulerCommand extends $Command< UpdateInferenceSchedulerCommandInput, diff --git a/clients/client-lookoutequipment/models/models_0.ts b/clients/client-lookoutequipment/models/models_0.ts index 908e7ff3eb4f..b84c4c0c8df9 100644 --- a/clients/client-lookoutequipment/models/models_0.ts +++ b/clients/client-lookoutequipment/models/models_0.ts @@ -12,6 +12,9 @@ export interface AccessDeniedException extends __SmithyException, $MetadataBeare } export namespace AccessDeniedException { + /** + * @internal + */ export const filterSensitiveLog = (obj: AccessDeniedException): any => ({ ...obj, }); @@ -28,6 +31,9 @@ export interface ConflictException extends __SmithyException, $MetadataBearer { } export namespace ConflictException { + /** + * @internal + */ export const filterSensitiveLog = (obj: ConflictException): any => ({ ...obj, }); @@ -45,6 +51,9 @@ export interface DatasetSchema { } export namespace DatasetSchema { + /** + * @internal + */ export const filterSensitiveLog = (obj: DatasetSchema): any => ({ ...obj, }); @@ -66,6 +75,9 @@ export interface Tag { } export namespace Tag { + /** + * @internal + */ export const filterSensitiveLog = (obj: Tag): any => ({ ...obj, }); @@ -101,6 +113,9 @@ export interface CreateDatasetRequest { } export namespace CreateDatasetRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateDatasetRequest): any => ({ ...obj, }); @@ -130,6 +145,9 @@ export interface CreateDatasetResponse { } export namespace CreateDatasetResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateDatasetResponse): any => ({ ...obj, }); @@ -146,6 +164,9 @@ export interface InternalServerException extends __SmithyException, $MetadataBea } export namespace InternalServerException { + /** + * @internal + */ export const filterSensitiveLog = (obj: InternalServerException): any => ({ ...obj, }); @@ -161,6 +182,9 @@ export interface ServiceQuotaExceededException extends __SmithyException, $Metad } export namespace ServiceQuotaExceededException { + /** + * @internal + */ export const filterSensitiveLog = (obj: ServiceQuotaExceededException): any => ({ ...obj, }); @@ -176,6 +200,9 @@ export interface ThrottlingException extends __SmithyException, $MetadataBearer } export namespace ThrottlingException { + /** + * @internal + */ export const filterSensitiveLog = (obj: ThrottlingException): any => ({ ...obj, }); @@ -192,6 +219,9 @@ export interface ValidationException extends __SmithyException, $MetadataBearer } export namespace ValidationException { + /** + * @internal + */ export const filterSensitiveLog = (obj: ValidationException): any => ({ ...obj, }); @@ -215,6 +245,9 @@ export interface InferenceInputNameConfiguration { } export namespace InferenceInputNameConfiguration { + /** + * @internal + */ export const filterSensitiveLog = (obj: InferenceInputNameConfiguration): any => ({ ...obj, }); @@ -237,6 +270,9 @@ export interface InferenceS3InputConfiguration { } export namespace InferenceS3InputConfiguration { + /** + * @internal + */ export const filterSensitiveLog = (obj: InferenceS3InputConfiguration): any => ({ ...obj, }); @@ -266,6 +302,9 @@ export interface InferenceInputConfiguration { } export namespace InferenceInputConfiguration { + /** + * @internal + */ export const filterSensitiveLog = (obj: InferenceInputConfiguration): any => ({ ...obj, }); @@ -288,6 +327,9 @@ export interface InferenceS3OutputConfiguration { } export namespace InferenceS3OutputConfiguration { + /** + * @internal + */ export const filterSensitiveLog = (obj: InferenceS3OutputConfiguration): any => ({ ...obj, }); @@ -311,6 +353,9 @@ export interface InferenceOutputConfiguration { } export namespace InferenceOutputConfiguration { + /** + * @internal + */ export const filterSensitiveLog = (obj: InferenceOutputConfiguration): any => ({ ...obj, }); @@ -391,6 +436,9 @@ export interface CreateInferenceSchedulerRequest { } export namespace CreateInferenceSchedulerRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateInferenceSchedulerRequest): any => ({ ...obj, }); @@ -421,6 +469,9 @@ export interface CreateInferenceSchedulerResponse { } export namespace CreateInferenceSchedulerResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateInferenceSchedulerResponse): any => ({ ...obj, }); @@ -437,6 +488,9 @@ export interface ResourceNotFoundException extends __SmithyException, $MetadataB } export namespace ResourceNotFoundException { + /** + * @internal + */ export const filterSensitiveLog = (obj: ResourceNotFoundException): any => ({ ...obj, }); @@ -486,6 +540,9 @@ export interface DataPreProcessingConfiguration { } export namespace DataPreProcessingConfiguration { + /** + * @internal + */ export const filterSensitiveLog = (obj: DataPreProcessingConfiguration): any => ({ ...obj, }); @@ -508,6 +565,9 @@ export interface LabelsS3InputConfiguration { } export namespace LabelsS3InputConfiguration { + /** + * @internal + */ export const filterSensitiveLog = (obj: LabelsS3InputConfiguration): any => ({ ...obj, }); @@ -525,6 +585,9 @@ export interface LabelsInputConfiguration { } export namespace LabelsInputConfiguration { + /** + * @internal + */ export const filterSensitiveLog = (obj: LabelsInputConfiguration): any => ({ ...obj, }); @@ -615,6 +678,9 @@ export interface CreateModelRequest { } export namespace CreateModelRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateModelRequest): any => ({ ...obj, }); @@ -639,6 +705,9 @@ export interface CreateModelResponse { } export namespace CreateModelResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateModelResponse): any => ({ ...obj, }); @@ -652,6 +721,9 @@ export interface DeleteDatasetRequest { } export namespace DeleteDatasetRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteDatasetRequest): any => ({ ...obj, }); @@ -665,6 +737,9 @@ export interface DeleteInferenceSchedulerRequest { } export namespace DeleteInferenceSchedulerRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteInferenceSchedulerRequest): any => ({ ...obj, }); @@ -678,6 +753,9 @@ export interface DeleteModelRequest { } export namespace DeleteModelRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteModelRequest): any => ({ ...obj, }); @@ -691,6 +769,9 @@ export interface DescribeDataIngestionJobRequest { } export namespace DescribeDataIngestionJobRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeDataIngestionJobRequest): any => ({ ...obj, }); @@ -714,6 +795,9 @@ export interface IngestionS3InputConfiguration { } export namespace IngestionS3InputConfiguration { + /** + * @internal + */ export const filterSensitiveLog = (obj: IngestionS3InputConfiguration): any => ({ ...obj, }); @@ -732,6 +816,9 @@ export interface IngestionInputConfiguration { } export namespace IngestionInputConfiguration { + /** + * @internal + */ export const filterSensitiveLog = (obj: IngestionInputConfiguration): any => ({ ...obj, }); @@ -784,6 +871,9 @@ export interface DescribeDataIngestionJobResponse { } export namespace DescribeDataIngestionJobResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeDataIngestionJobResponse): any => ({ ...obj, }); @@ -797,6 +887,9 @@ export interface DescribeDatasetRequest { } export namespace DescribeDatasetRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeDatasetRequest): any => ({ ...obj, }); @@ -846,6 +939,9 @@ export interface DescribeDatasetResponse { } export namespace DescribeDatasetResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeDatasetResponse): any => ({ ...obj, }); @@ -859,6 +955,9 @@ export interface DescribeInferenceSchedulerRequest { } export namespace DescribeInferenceSchedulerRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeInferenceSchedulerRequest): any => ({ ...obj, }); @@ -945,6 +1044,9 @@ export interface DescribeInferenceSchedulerResponse { } export namespace DescribeInferenceSchedulerResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeInferenceSchedulerResponse): any => ({ ...obj, }); @@ -958,6 +1060,9 @@ export interface DescribeModelRequest { } export namespace DescribeModelRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeModelRequest): any => ({ ...obj, }); @@ -1088,6 +1193,9 @@ export interface DescribeModelResponse { } export namespace DescribeModelResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeModelResponse): any => ({ ...obj, }); @@ -1117,6 +1225,9 @@ export interface ListDataIngestionJobsRequest { } export namespace ListDataIngestionJobsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListDataIngestionJobsRequest): any => ({ ...obj, }); @@ -1155,6 +1266,9 @@ export interface DataIngestionJobSummary { } export namespace DataIngestionJobSummary { + /** + * @internal + */ export const filterSensitiveLog = (obj: DataIngestionJobSummary): any => ({ ...obj, }); @@ -1175,6 +1289,9 @@ export interface ListDataIngestionJobsResponse { } export namespace ListDataIngestionJobsResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListDataIngestionJobsResponse): any => ({ ...obj, }); @@ -1199,6 +1316,9 @@ export interface ListDatasetsRequest { } export namespace ListDatasetsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListDatasetsRequest): any => ({ ...obj, }); @@ -1231,6 +1351,9 @@ export interface DatasetSummary { } export namespace DatasetSummary { + /** + * @internal + */ export const filterSensitiveLog = (obj: DatasetSummary): any => ({ ...obj, }); @@ -1251,6 +1374,9 @@ export interface ListDatasetsResponse { } export namespace ListDatasetsResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListDatasetsResponse): any => ({ ...obj, }); @@ -1298,6 +1424,9 @@ export interface ListInferenceExecutionsRequest { } export namespace ListInferenceExecutionsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListInferenceExecutionsRequest): any => ({ ...obj, }); @@ -1320,6 +1449,9 @@ export interface S3Object { } export namespace S3Object { + /** + * @internal + */ export const filterSensitiveLog = (obj: S3Object): any => ({ ...obj, }); @@ -1399,6 +1531,9 @@ export interface InferenceExecutionSummary { } export namespace InferenceExecutionSummary { + /** + * @internal + */ export const filterSensitiveLog = (obj: InferenceExecutionSummary): any => ({ ...obj, }); @@ -1420,6 +1555,9 @@ export interface ListInferenceExecutionsResponse { } export namespace ListInferenceExecutionsResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListInferenceExecutionsResponse): any => ({ ...obj, }); @@ -1449,6 +1587,9 @@ export interface ListInferenceSchedulersRequest { } export namespace ListInferenceSchedulersRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListInferenceSchedulersRequest): any => ({ ...obj, }); @@ -1506,6 +1647,9 @@ export interface InferenceSchedulerSummary { } export namespace InferenceSchedulerSummary { + /** + * @internal + */ export const filterSensitiveLog = (obj: InferenceSchedulerSummary): any => ({ ...obj, }); @@ -1526,6 +1670,9 @@ export interface ListInferenceSchedulersResponse { } export namespace ListInferenceSchedulersResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListInferenceSchedulersResponse): any => ({ ...obj, }); @@ -1560,6 +1707,9 @@ export interface ListModelsRequest { } export namespace ListModelsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListModelsRequest): any => ({ ...obj, }); @@ -1602,6 +1752,9 @@ export interface ModelSummary { } export namespace ModelSummary { + /** + * @internal + */ export const filterSensitiveLog = (obj: ModelSummary): any => ({ ...obj, }); @@ -1622,6 +1775,9 @@ export interface ListModelsResponse { } export namespace ListModelsResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListModelsResponse): any => ({ ...obj, }); @@ -1636,6 +1792,9 @@ export interface ListTagsForResourceRequest { } export namespace ListTagsForResourceRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListTagsForResourceRequest): any => ({ ...obj, }); @@ -1649,6 +1808,9 @@ export interface ListTagsForResourceResponse { } export namespace ListTagsForResourceResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListTagsForResourceResponse): any => ({ ...obj, }); @@ -1680,6 +1842,9 @@ export interface StartDataIngestionJobRequest { } export namespace StartDataIngestionJobRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: StartDataIngestionJobRequest): any => ({ ...obj, }); @@ -1698,6 +1863,9 @@ export interface StartDataIngestionJobResponse { } export namespace StartDataIngestionJobResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: StartDataIngestionJobResponse): any => ({ ...obj, }); @@ -1711,6 +1879,9 @@ export interface StartInferenceSchedulerRequest { } export namespace StartInferenceSchedulerRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: StartInferenceSchedulerRequest): any => ({ ...obj, }); @@ -1745,6 +1916,9 @@ export interface StartInferenceSchedulerResponse { } export namespace StartInferenceSchedulerResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: StartInferenceSchedulerResponse): any => ({ ...obj, }); @@ -1758,6 +1932,9 @@ export interface StopInferenceSchedulerRequest { } export namespace StopInferenceSchedulerRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: StopInferenceSchedulerRequest): any => ({ ...obj, }); @@ -1792,6 +1969,9 @@ export interface StopInferenceSchedulerResponse { } export namespace StopInferenceSchedulerResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: StopInferenceSchedulerResponse): any => ({ ...obj, }); @@ -1812,6 +1992,9 @@ export interface TagResourceRequest { } export namespace TagResourceRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: TagResourceRequest): any => ({ ...obj, }); @@ -1820,6 +2003,9 @@ export namespace TagResourceRequest { export interface TagResourceResponse {} export namespace TagResourceResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: TagResourceResponse): any => ({ ...obj, }); @@ -1839,6 +2025,9 @@ export interface UntagResourceRequest { } export namespace UntagResourceRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: UntagResourceRequest): any => ({ ...obj, }); @@ -1847,6 +2036,9 @@ export namespace UntagResourceRequest { export interface UntagResourceResponse {} export namespace UntagResourceResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: UntagResourceResponse): any => ({ ...obj, }); @@ -1896,6 +2088,9 @@ export interface UpdateInferenceSchedulerRequest { } export namespace UpdateInferenceSchedulerRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateInferenceSchedulerRequest): any => ({ ...obj, }); diff --git a/clients/client-lookoutmetrics/commands/ActivateAnomalyDetectorCommand.ts b/clients/client-lookoutmetrics/commands/ActivateAnomalyDetectorCommand.ts index f0a52e9ace56..9ae82a002aa5 100644 --- a/clients/client-lookoutmetrics/commands/ActivateAnomalyDetectorCommand.ts +++ b/clients/client-lookoutmetrics/commands/ActivateAnomalyDetectorCommand.ts @@ -22,6 +22,20 @@ export interface ActivateAnomalyDetectorCommandOutput extends ActivateAnomalyDet /** *

Activates an anomaly detector.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { LookoutMetricsClient, ActivateAnomalyDetectorCommand } from "@aws-sdk/client-lookoutmetrics"; // ES Modules import + * // const { LookoutMetricsClient, ActivateAnomalyDetectorCommand } = require("@aws-sdk/client-lookoutmetrics"); // CommonJS import + * const client = new LookoutMetricsClient(config); + * const command = new ActivateAnomalyDetectorCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ActivateAnomalyDetectorCommandInput} for command's `input` shape. + * @see {@link ActivateAnomalyDetectorCommandOutput} for command's `response` shape. + * @see {@link LookoutMetricsClientResolvedConfig | config} for command's `input` shape. + * */ export class ActivateAnomalyDetectorCommand extends $Command< ActivateAnomalyDetectorCommandInput, diff --git a/clients/client-lookoutmetrics/commands/BackTestAnomalyDetectorCommand.ts b/clients/client-lookoutmetrics/commands/BackTestAnomalyDetectorCommand.ts index 0fb0bee3d97c..f7c81ae5b29b 100644 --- a/clients/client-lookoutmetrics/commands/BackTestAnomalyDetectorCommand.ts +++ b/clients/client-lookoutmetrics/commands/BackTestAnomalyDetectorCommand.ts @@ -22,6 +22,20 @@ export interface BackTestAnomalyDetectorCommandOutput extends BackTestAnomalyDet /** *

Runs a backtest for anomaly detection for the specified resource.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { LookoutMetricsClient, BackTestAnomalyDetectorCommand } from "@aws-sdk/client-lookoutmetrics"; // ES Modules import + * // const { LookoutMetricsClient, BackTestAnomalyDetectorCommand } = require("@aws-sdk/client-lookoutmetrics"); // CommonJS import + * const client = new LookoutMetricsClient(config); + * const command = new BackTestAnomalyDetectorCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link BackTestAnomalyDetectorCommandInput} for command's `input` shape. + * @see {@link BackTestAnomalyDetectorCommandOutput} for command's `response` shape. + * @see {@link LookoutMetricsClientResolvedConfig | config} for command's `input` shape. + * */ export class BackTestAnomalyDetectorCommand extends $Command< BackTestAnomalyDetectorCommandInput, diff --git a/clients/client-lookoutmetrics/commands/CreateAlertCommand.ts b/clients/client-lookoutmetrics/commands/CreateAlertCommand.ts index ff10c8cf89e8..533fd30ccd81 100644 --- a/clients/client-lookoutmetrics/commands/CreateAlertCommand.ts +++ b/clients/client-lookoutmetrics/commands/CreateAlertCommand.ts @@ -22,6 +22,20 @@ export interface CreateAlertCommandOutput extends CreateAlertResponse, __Metadat /** *

Creates an alert for an anomaly detector.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { LookoutMetricsClient, CreateAlertCommand } from "@aws-sdk/client-lookoutmetrics"; // ES Modules import + * // const { LookoutMetricsClient, CreateAlertCommand } = require("@aws-sdk/client-lookoutmetrics"); // CommonJS import + * const client = new LookoutMetricsClient(config); + * const command = new CreateAlertCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreateAlertCommandInput} for command's `input` shape. + * @see {@link CreateAlertCommandOutput} for command's `response` shape. + * @see {@link LookoutMetricsClientResolvedConfig | config} for command's `input` shape. + * */ export class CreateAlertCommand extends $Command< CreateAlertCommandInput, diff --git a/clients/client-lookoutmetrics/commands/CreateAnomalyDetectorCommand.ts b/clients/client-lookoutmetrics/commands/CreateAnomalyDetectorCommand.ts index eb79f2a87439..3617bde7d02a 100644 --- a/clients/client-lookoutmetrics/commands/CreateAnomalyDetectorCommand.ts +++ b/clients/client-lookoutmetrics/commands/CreateAnomalyDetectorCommand.ts @@ -22,6 +22,20 @@ export interface CreateAnomalyDetectorCommandOutput extends CreateAnomalyDetecto /** *

Creates an anomaly detector.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { LookoutMetricsClient, CreateAnomalyDetectorCommand } from "@aws-sdk/client-lookoutmetrics"; // ES Modules import + * // const { LookoutMetricsClient, CreateAnomalyDetectorCommand } = require("@aws-sdk/client-lookoutmetrics"); // CommonJS import + * const client = new LookoutMetricsClient(config); + * const command = new CreateAnomalyDetectorCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreateAnomalyDetectorCommandInput} for command's `input` shape. + * @see {@link CreateAnomalyDetectorCommandOutput} for command's `response` shape. + * @see {@link LookoutMetricsClientResolvedConfig | config} for command's `input` shape. + * */ export class CreateAnomalyDetectorCommand extends $Command< CreateAnomalyDetectorCommandInput, diff --git a/clients/client-lookoutmetrics/commands/CreateMetricSetCommand.ts b/clients/client-lookoutmetrics/commands/CreateMetricSetCommand.ts index eb6dedeff9e4..0426459f520d 100644 --- a/clients/client-lookoutmetrics/commands/CreateMetricSetCommand.ts +++ b/clients/client-lookoutmetrics/commands/CreateMetricSetCommand.ts @@ -22,6 +22,20 @@ export interface CreateMetricSetCommandOutput extends CreateMetricSetResponse, _ /** *

Creates a dataset.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { LookoutMetricsClient, CreateMetricSetCommand } from "@aws-sdk/client-lookoutmetrics"; // ES Modules import + * // const { LookoutMetricsClient, CreateMetricSetCommand } = require("@aws-sdk/client-lookoutmetrics"); // CommonJS import + * const client = new LookoutMetricsClient(config); + * const command = new CreateMetricSetCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreateMetricSetCommandInput} for command's `input` shape. + * @see {@link CreateMetricSetCommandOutput} for command's `response` shape. + * @see {@link LookoutMetricsClientResolvedConfig | config} for command's `input` shape. + * */ export class CreateMetricSetCommand extends $Command< CreateMetricSetCommandInput, diff --git a/clients/client-lookoutmetrics/commands/DeleteAlertCommand.ts b/clients/client-lookoutmetrics/commands/DeleteAlertCommand.ts index 39c81abf0c99..9d23df361d1c 100644 --- a/clients/client-lookoutmetrics/commands/DeleteAlertCommand.ts +++ b/clients/client-lookoutmetrics/commands/DeleteAlertCommand.ts @@ -22,6 +22,20 @@ export interface DeleteAlertCommandOutput extends DeleteAlertResponse, __Metadat /** *

Deletes an alert.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { LookoutMetricsClient, DeleteAlertCommand } from "@aws-sdk/client-lookoutmetrics"; // ES Modules import + * // const { LookoutMetricsClient, DeleteAlertCommand } = require("@aws-sdk/client-lookoutmetrics"); // CommonJS import + * const client = new LookoutMetricsClient(config); + * const command = new DeleteAlertCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteAlertCommandInput} for command's `input` shape. + * @see {@link DeleteAlertCommandOutput} for command's `response` shape. + * @see {@link LookoutMetricsClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteAlertCommand extends $Command< DeleteAlertCommandInput, diff --git a/clients/client-lookoutmetrics/commands/DeleteAnomalyDetectorCommand.ts b/clients/client-lookoutmetrics/commands/DeleteAnomalyDetectorCommand.ts index c49a05289d2b..441d00a710d1 100644 --- a/clients/client-lookoutmetrics/commands/DeleteAnomalyDetectorCommand.ts +++ b/clients/client-lookoutmetrics/commands/DeleteAnomalyDetectorCommand.ts @@ -23,6 +23,20 @@ export interface DeleteAnomalyDetectorCommandOutput extends DeleteAnomalyDetecto /** *

Deletes a detector. Deleting an anomaly detector will delete all of its corresponding resources including any * configured datasets and alerts.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { LookoutMetricsClient, DeleteAnomalyDetectorCommand } from "@aws-sdk/client-lookoutmetrics"; // ES Modules import + * // const { LookoutMetricsClient, DeleteAnomalyDetectorCommand } = require("@aws-sdk/client-lookoutmetrics"); // CommonJS import + * const client = new LookoutMetricsClient(config); + * const command = new DeleteAnomalyDetectorCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteAnomalyDetectorCommandInput} for command's `input` shape. + * @see {@link DeleteAnomalyDetectorCommandOutput} for command's `response` shape. + * @see {@link LookoutMetricsClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteAnomalyDetectorCommand extends $Command< DeleteAnomalyDetectorCommandInput, diff --git a/clients/client-lookoutmetrics/commands/DescribeAlertCommand.ts b/clients/client-lookoutmetrics/commands/DescribeAlertCommand.ts index d8faa2cb0068..4fdc1c594205 100644 --- a/clients/client-lookoutmetrics/commands/DescribeAlertCommand.ts +++ b/clients/client-lookoutmetrics/commands/DescribeAlertCommand.ts @@ -22,6 +22,20 @@ export interface DescribeAlertCommandOutput extends DescribeAlertResponse, __Met /** *

Describes an alert.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { LookoutMetricsClient, DescribeAlertCommand } from "@aws-sdk/client-lookoutmetrics"; // ES Modules import + * // const { LookoutMetricsClient, DescribeAlertCommand } = require("@aws-sdk/client-lookoutmetrics"); // CommonJS import + * const client = new LookoutMetricsClient(config); + * const command = new DescribeAlertCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeAlertCommandInput} for command's `input` shape. + * @see {@link DescribeAlertCommandOutput} for command's `response` shape. + * @see {@link LookoutMetricsClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeAlertCommand extends $Command< DescribeAlertCommandInput, diff --git a/clients/client-lookoutmetrics/commands/DescribeAnomalyDetectionExecutionsCommand.ts b/clients/client-lookoutmetrics/commands/DescribeAnomalyDetectionExecutionsCommand.ts index 1d2b31836272..ce5d835011e0 100644 --- a/clients/client-lookoutmetrics/commands/DescribeAnomalyDetectionExecutionsCommand.ts +++ b/clients/client-lookoutmetrics/commands/DescribeAnomalyDetectionExecutionsCommand.ts @@ -27,6 +27,20 @@ export interface DescribeAnomalyDetectionExecutionsCommandOutput /** *

Returns information about the status of the specified anomaly detection jobs.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { LookoutMetricsClient, DescribeAnomalyDetectionExecutionsCommand } from "@aws-sdk/client-lookoutmetrics"; // ES Modules import + * // const { LookoutMetricsClient, DescribeAnomalyDetectionExecutionsCommand } = require("@aws-sdk/client-lookoutmetrics"); // CommonJS import + * const client = new LookoutMetricsClient(config); + * const command = new DescribeAnomalyDetectionExecutionsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeAnomalyDetectionExecutionsCommandInput} for command's `input` shape. + * @see {@link DescribeAnomalyDetectionExecutionsCommandOutput} for command's `response` shape. + * @see {@link LookoutMetricsClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeAnomalyDetectionExecutionsCommand extends $Command< DescribeAnomalyDetectionExecutionsCommandInput, diff --git a/clients/client-lookoutmetrics/commands/DescribeAnomalyDetectorCommand.ts b/clients/client-lookoutmetrics/commands/DescribeAnomalyDetectorCommand.ts index 40589d6ee921..180b987f970b 100644 --- a/clients/client-lookoutmetrics/commands/DescribeAnomalyDetectorCommand.ts +++ b/clients/client-lookoutmetrics/commands/DescribeAnomalyDetectorCommand.ts @@ -22,6 +22,20 @@ export interface DescribeAnomalyDetectorCommandOutput extends DescribeAnomalyDet /** *

Describes a detector.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { LookoutMetricsClient, DescribeAnomalyDetectorCommand } from "@aws-sdk/client-lookoutmetrics"; // ES Modules import + * // const { LookoutMetricsClient, DescribeAnomalyDetectorCommand } = require("@aws-sdk/client-lookoutmetrics"); // CommonJS import + * const client = new LookoutMetricsClient(config); + * const command = new DescribeAnomalyDetectorCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeAnomalyDetectorCommandInput} for command's `input` shape. + * @see {@link DescribeAnomalyDetectorCommandOutput} for command's `response` shape. + * @see {@link LookoutMetricsClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeAnomalyDetectorCommand extends $Command< DescribeAnomalyDetectorCommandInput, diff --git a/clients/client-lookoutmetrics/commands/DescribeMetricSetCommand.ts b/clients/client-lookoutmetrics/commands/DescribeMetricSetCommand.ts index fd85610c2aa2..cd817e7e6d00 100644 --- a/clients/client-lookoutmetrics/commands/DescribeMetricSetCommand.ts +++ b/clients/client-lookoutmetrics/commands/DescribeMetricSetCommand.ts @@ -22,6 +22,20 @@ export interface DescribeMetricSetCommandOutput extends DescribeMetricSetRespons /** *

Describes a dataset.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { LookoutMetricsClient, DescribeMetricSetCommand } from "@aws-sdk/client-lookoutmetrics"; // ES Modules import + * // const { LookoutMetricsClient, DescribeMetricSetCommand } = require("@aws-sdk/client-lookoutmetrics"); // CommonJS import + * const client = new LookoutMetricsClient(config); + * const command = new DescribeMetricSetCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeMetricSetCommandInput} for command's `input` shape. + * @see {@link DescribeMetricSetCommandOutput} for command's `response` shape. + * @see {@link LookoutMetricsClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeMetricSetCommand extends $Command< DescribeMetricSetCommandInput, diff --git a/clients/client-lookoutmetrics/commands/GetAnomalyGroupCommand.ts b/clients/client-lookoutmetrics/commands/GetAnomalyGroupCommand.ts index a950504f0cff..0c6bbdefc641 100644 --- a/clients/client-lookoutmetrics/commands/GetAnomalyGroupCommand.ts +++ b/clients/client-lookoutmetrics/commands/GetAnomalyGroupCommand.ts @@ -22,6 +22,20 @@ export interface GetAnomalyGroupCommandOutput extends GetAnomalyGroupResponse, _ /** *

Returns details about a group of anomalous metrics.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { LookoutMetricsClient, GetAnomalyGroupCommand } from "@aws-sdk/client-lookoutmetrics"; // ES Modules import + * // const { LookoutMetricsClient, GetAnomalyGroupCommand } = require("@aws-sdk/client-lookoutmetrics"); // CommonJS import + * const client = new LookoutMetricsClient(config); + * const command = new GetAnomalyGroupCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetAnomalyGroupCommandInput} for command's `input` shape. + * @see {@link GetAnomalyGroupCommandOutput} for command's `response` shape. + * @see {@link LookoutMetricsClientResolvedConfig | config} for command's `input` shape. + * */ export class GetAnomalyGroupCommand extends $Command< GetAnomalyGroupCommandInput, diff --git a/clients/client-lookoutmetrics/commands/GetFeedbackCommand.ts b/clients/client-lookoutmetrics/commands/GetFeedbackCommand.ts index 565469e3f4f1..61f8b77faed3 100644 --- a/clients/client-lookoutmetrics/commands/GetFeedbackCommand.ts +++ b/clients/client-lookoutmetrics/commands/GetFeedbackCommand.ts @@ -22,6 +22,20 @@ export interface GetFeedbackCommandOutput extends GetFeedbackResponse, __Metadat /** *

Get feedback for an anomaly group.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { LookoutMetricsClient, GetFeedbackCommand } from "@aws-sdk/client-lookoutmetrics"; // ES Modules import + * // const { LookoutMetricsClient, GetFeedbackCommand } = require("@aws-sdk/client-lookoutmetrics"); // CommonJS import + * const client = new LookoutMetricsClient(config); + * const command = new GetFeedbackCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetFeedbackCommandInput} for command's `input` shape. + * @see {@link GetFeedbackCommandOutput} for command's `response` shape. + * @see {@link LookoutMetricsClientResolvedConfig | config} for command's `input` shape. + * */ export class GetFeedbackCommand extends $Command< GetFeedbackCommandInput, diff --git a/clients/client-lookoutmetrics/commands/GetSampleDataCommand.ts b/clients/client-lookoutmetrics/commands/GetSampleDataCommand.ts index cc185d9ff17c..fc34feec1c7e 100644 --- a/clients/client-lookoutmetrics/commands/GetSampleDataCommand.ts +++ b/clients/client-lookoutmetrics/commands/GetSampleDataCommand.ts @@ -22,6 +22,20 @@ export interface GetSampleDataCommandOutput extends GetSampleDataResponse, __Met /** *

Returns a selection of sample records from an Amazon S3 datasource.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { LookoutMetricsClient, GetSampleDataCommand } from "@aws-sdk/client-lookoutmetrics"; // ES Modules import + * // const { LookoutMetricsClient, GetSampleDataCommand } = require("@aws-sdk/client-lookoutmetrics"); // CommonJS import + * const client = new LookoutMetricsClient(config); + * const command = new GetSampleDataCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetSampleDataCommandInput} for command's `input` shape. + * @see {@link GetSampleDataCommandOutput} for command's `response` shape. + * @see {@link LookoutMetricsClientResolvedConfig | config} for command's `input` shape. + * */ export class GetSampleDataCommand extends $Command< GetSampleDataCommandInput, diff --git a/clients/client-lookoutmetrics/commands/ListAlertsCommand.ts b/clients/client-lookoutmetrics/commands/ListAlertsCommand.ts index 670ce8c16bf3..c29d79f5bc9e 100644 --- a/clients/client-lookoutmetrics/commands/ListAlertsCommand.ts +++ b/clients/client-lookoutmetrics/commands/ListAlertsCommand.ts @@ -22,6 +22,20 @@ export interface ListAlertsCommandOutput extends ListAlertsResponse, __MetadataB /** *

Lists the alerts attached to a detector.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { LookoutMetricsClient, ListAlertsCommand } from "@aws-sdk/client-lookoutmetrics"; // ES Modules import + * // const { LookoutMetricsClient, ListAlertsCommand } = require("@aws-sdk/client-lookoutmetrics"); // CommonJS import + * const client = new LookoutMetricsClient(config); + * const command = new ListAlertsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListAlertsCommandInput} for command's `input` shape. + * @see {@link ListAlertsCommandOutput} for command's `response` shape. + * @see {@link LookoutMetricsClientResolvedConfig | config} for command's `input` shape. + * */ export class ListAlertsCommand extends $Command< ListAlertsCommandInput, diff --git a/clients/client-lookoutmetrics/commands/ListAnomalyDetectorsCommand.ts b/clients/client-lookoutmetrics/commands/ListAnomalyDetectorsCommand.ts index 81b46f385295..0dc6eb3024a8 100644 --- a/clients/client-lookoutmetrics/commands/ListAnomalyDetectorsCommand.ts +++ b/clients/client-lookoutmetrics/commands/ListAnomalyDetectorsCommand.ts @@ -22,6 +22,20 @@ export interface ListAnomalyDetectorsCommandOutput extends ListAnomalyDetectorsR /** *

Lists the detectors in the current AWS Region.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { LookoutMetricsClient, ListAnomalyDetectorsCommand } from "@aws-sdk/client-lookoutmetrics"; // ES Modules import + * // const { LookoutMetricsClient, ListAnomalyDetectorsCommand } = require("@aws-sdk/client-lookoutmetrics"); // CommonJS import + * const client = new LookoutMetricsClient(config); + * const command = new ListAnomalyDetectorsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListAnomalyDetectorsCommandInput} for command's `input` shape. + * @see {@link ListAnomalyDetectorsCommandOutput} for command's `response` shape. + * @see {@link LookoutMetricsClientResolvedConfig | config} for command's `input` shape. + * */ export class ListAnomalyDetectorsCommand extends $Command< ListAnomalyDetectorsCommandInput, diff --git a/clients/client-lookoutmetrics/commands/ListAnomalyGroupSummariesCommand.ts b/clients/client-lookoutmetrics/commands/ListAnomalyGroupSummariesCommand.ts index feaf178d5a22..5860e38e6d41 100644 --- a/clients/client-lookoutmetrics/commands/ListAnomalyGroupSummariesCommand.ts +++ b/clients/client-lookoutmetrics/commands/ListAnomalyGroupSummariesCommand.ts @@ -22,6 +22,20 @@ export interface ListAnomalyGroupSummariesCommandOutput extends ListAnomalyGroup /** *

Returns a list of anomaly groups.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { LookoutMetricsClient, ListAnomalyGroupSummariesCommand } from "@aws-sdk/client-lookoutmetrics"; // ES Modules import + * // const { LookoutMetricsClient, ListAnomalyGroupSummariesCommand } = require("@aws-sdk/client-lookoutmetrics"); // CommonJS import + * const client = new LookoutMetricsClient(config); + * const command = new ListAnomalyGroupSummariesCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListAnomalyGroupSummariesCommandInput} for command's `input` shape. + * @see {@link ListAnomalyGroupSummariesCommandOutput} for command's `response` shape. + * @see {@link LookoutMetricsClientResolvedConfig | config} for command's `input` shape. + * */ export class ListAnomalyGroupSummariesCommand extends $Command< ListAnomalyGroupSummariesCommandInput, diff --git a/clients/client-lookoutmetrics/commands/ListAnomalyGroupTimeSeriesCommand.ts b/clients/client-lookoutmetrics/commands/ListAnomalyGroupTimeSeriesCommand.ts index cf51af8ff24e..306cd95839ff 100644 --- a/clients/client-lookoutmetrics/commands/ListAnomalyGroupTimeSeriesCommand.ts +++ b/clients/client-lookoutmetrics/commands/ListAnomalyGroupTimeSeriesCommand.ts @@ -22,6 +22,20 @@ export interface ListAnomalyGroupTimeSeriesCommandOutput extends ListAnomalyGrou /** *

Gets a list of anomalous metrics for a measure in an anomaly group.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { LookoutMetricsClient, ListAnomalyGroupTimeSeriesCommand } from "@aws-sdk/client-lookoutmetrics"; // ES Modules import + * // const { LookoutMetricsClient, ListAnomalyGroupTimeSeriesCommand } = require("@aws-sdk/client-lookoutmetrics"); // CommonJS import + * const client = new LookoutMetricsClient(config); + * const command = new ListAnomalyGroupTimeSeriesCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListAnomalyGroupTimeSeriesCommandInput} for command's `input` shape. + * @see {@link ListAnomalyGroupTimeSeriesCommandOutput} for command's `response` shape. + * @see {@link LookoutMetricsClientResolvedConfig | config} for command's `input` shape. + * */ export class ListAnomalyGroupTimeSeriesCommand extends $Command< ListAnomalyGroupTimeSeriesCommandInput, diff --git a/clients/client-lookoutmetrics/commands/ListMetricSetsCommand.ts b/clients/client-lookoutmetrics/commands/ListMetricSetsCommand.ts index d4f30fb4c1ac..655d8643c1f3 100644 --- a/clients/client-lookoutmetrics/commands/ListMetricSetsCommand.ts +++ b/clients/client-lookoutmetrics/commands/ListMetricSetsCommand.ts @@ -22,6 +22,20 @@ export interface ListMetricSetsCommandOutput extends ListMetricSetsResponse, __M /** *

Lists the datasets in the current AWS Region.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { LookoutMetricsClient, ListMetricSetsCommand } from "@aws-sdk/client-lookoutmetrics"; // ES Modules import + * // const { LookoutMetricsClient, ListMetricSetsCommand } = require("@aws-sdk/client-lookoutmetrics"); // CommonJS import + * const client = new LookoutMetricsClient(config); + * const command = new ListMetricSetsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListMetricSetsCommandInput} for command's `input` shape. + * @see {@link ListMetricSetsCommandOutput} for command's `response` shape. + * @see {@link LookoutMetricsClientResolvedConfig | config} for command's `input` shape. + * */ export class ListMetricSetsCommand extends $Command< ListMetricSetsCommandInput, diff --git a/clients/client-lookoutmetrics/commands/ListTagsForResourceCommand.ts b/clients/client-lookoutmetrics/commands/ListTagsForResourceCommand.ts index 946e1730383c..ffd2c5076cfb 100644 --- a/clients/client-lookoutmetrics/commands/ListTagsForResourceCommand.ts +++ b/clients/client-lookoutmetrics/commands/ListTagsForResourceCommand.ts @@ -22,6 +22,20 @@ export interface ListTagsForResourceCommandOutput extends ListTagsForResourceRes /** *

Gets a list of tags for a detector, dataset, or alert.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { LookoutMetricsClient, ListTagsForResourceCommand } from "@aws-sdk/client-lookoutmetrics"; // ES Modules import + * // const { LookoutMetricsClient, ListTagsForResourceCommand } = require("@aws-sdk/client-lookoutmetrics"); // CommonJS import + * const client = new LookoutMetricsClient(config); + * const command = new ListTagsForResourceCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListTagsForResourceCommandInput} for command's `input` shape. + * @see {@link ListTagsForResourceCommandOutput} for command's `response` shape. + * @see {@link LookoutMetricsClientResolvedConfig | config} for command's `input` shape. + * */ export class ListTagsForResourceCommand extends $Command< ListTagsForResourceCommandInput, diff --git a/clients/client-lookoutmetrics/commands/PutFeedbackCommand.ts b/clients/client-lookoutmetrics/commands/PutFeedbackCommand.ts index 15498dafc42d..4fc2be898886 100644 --- a/clients/client-lookoutmetrics/commands/PutFeedbackCommand.ts +++ b/clients/client-lookoutmetrics/commands/PutFeedbackCommand.ts @@ -22,6 +22,20 @@ export interface PutFeedbackCommandOutput extends PutFeedbackResponse, __Metadat /** *

Add feedback for an anomalous metric.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { LookoutMetricsClient, PutFeedbackCommand } from "@aws-sdk/client-lookoutmetrics"; // ES Modules import + * // const { LookoutMetricsClient, PutFeedbackCommand } = require("@aws-sdk/client-lookoutmetrics"); // CommonJS import + * const client = new LookoutMetricsClient(config); + * const command = new PutFeedbackCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link PutFeedbackCommandInput} for command's `input` shape. + * @see {@link PutFeedbackCommandOutput} for command's `response` shape. + * @see {@link LookoutMetricsClientResolvedConfig | config} for command's `input` shape. + * */ export class PutFeedbackCommand extends $Command< PutFeedbackCommandInput, diff --git a/clients/client-lookoutmetrics/commands/TagResourceCommand.ts b/clients/client-lookoutmetrics/commands/TagResourceCommand.ts index 8950cd7513bf..09c028424a2b 100644 --- a/clients/client-lookoutmetrics/commands/TagResourceCommand.ts +++ b/clients/client-lookoutmetrics/commands/TagResourceCommand.ts @@ -22,6 +22,20 @@ export interface TagResourceCommandOutput extends TagResourceResponse, __Metadat /** *

Adds tags to a detector, dataset, or alert.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { LookoutMetricsClient, TagResourceCommand } from "@aws-sdk/client-lookoutmetrics"; // ES Modules import + * // const { LookoutMetricsClient, TagResourceCommand } = require("@aws-sdk/client-lookoutmetrics"); // CommonJS import + * const client = new LookoutMetricsClient(config); + * const command = new TagResourceCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link TagResourceCommandInput} for command's `input` shape. + * @see {@link TagResourceCommandOutput} for command's `response` shape. + * @see {@link LookoutMetricsClientResolvedConfig | config} for command's `input` shape. + * */ export class TagResourceCommand extends $Command< TagResourceCommandInput, diff --git a/clients/client-lookoutmetrics/commands/UntagResourceCommand.ts b/clients/client-lookoutmetrics/commands/UntagResourceCommand.ts index 1ff74b08034b..bd523f4f555b 100644 --- a/clients/client-lookoutmetrics/commands/UntagResourceCommand.ts +++ b/clients/client-lookoutmetrics/commands/UntagResourceCommand.ts @@ -22,6 +22,20 @@ export interface UntagResourceCommandOutput extends UntagResourceResponse, __Met /** *

Removes tags from a detector, dataset, or alert.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { LookoutMetricsClient, UntagResourceCommand } from "@aws-sdk/client-lookoutmetrics"; // ES Modules import + * // const { LookoutMetricsClient, UntagResourceCommand } = require("@aws-sdk/client-lookoutmetrics"); // CommonJS import + * const client = new LookoutMetricsClient(config); + * const command = new UntagResourceCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link UntagResourceCommandInput} for command's `input` shape. + * @see {@link UntagResourceCommandOutput} for command's `response` shape. + * @see {@link LookoutMetricsClientResolvedConfig | config} for command's `input` shape. + * */ export class UntagResourceCommand extends $Command< UntagResourceCommandInput, diff --git a/clients/client-lookoutmetrics/commands/UpdateAnomalyDetectorCommand.ts b/clients/client-lookoutmetrics/commands/UpdateAnomalyDetectorCommand.ts index 8712bbc52ef3..338c392ceaf9 100644 --- a/clients/client-lookoutmetrics/commands/UpdateAnomalyDetectorCommand.ts +++ b/clients/client-lookoutmetrics/commands/UpdateAnomalyDetectorCommand.ts @@ -22,6 +22,20 @@ export interface UpdateAnomalyDetectorCommandOutput extends UpdateAnomalyDetecto /** *

Updates a detector. After activation, you can only change a detector's ingestion delay and description.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { LookoutMetricsClient, UpdateAnomalyDetectorCommand } from "@aws-sdk/client-lookoutmetrics"; // ES Modules import + * // const { LookoutMetricsClient, UpdateAnomalyDetectorCommand } = require("@aws-sdk/client-lookoutmetrics"); // CommonJS import + * const client = new LookoutMetricsClient(config); + * const command = new UpdateAnomalyDetectorCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link UpdateAnomalyDetectorCommandInput} for command's `input` shape. + * @see {@link UpdateAnomalyDetectorCommandOutput} for command's `response` shape. + * @see {@link LookoutMetricsClientResolvedConfig | config} for command's `input` shape. + * */ export class UpdateAnomalyDetectorCommand extends $Command< UpdateAnomalyDetectorCommandInput, diff --git a/clients/client-lookoutmetrics/commands/UpdateMetricSetCommand.ts b/clients/client-lookoutmetrics/commands/UpdateMetricSetCommand.ts index 595180842b27..101de134a33d 100644 --- a/clients/client-lookoutmetrics/commands/UpdateMetricSetCommand.ts +++ b/clients/client-lookoutmetrics/commands/UpdateMetricSetCommand.ts @@ -22,6 +22,20 @@ export interface UpdateMetricSetCommandOutput extends UpdateMetricSetResponse, _ /** *

Updates a dataset.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { LookoutMetricsClient, UpdateMetricSetCommand } from "@aws-sdk/client-lookoutmetrics"; // ES Modules import + * // const { LookoutMetricsClient, UpdateMetricSetCommand } = require("@aws-sdk/client-lookoutmetrics"); // CommonJS import + * const client = new LookoutMetricsClient(config); + * const command = new UpdateMetricSetCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link UpdateMetricSetCommandInput} for command's `input` shape. + * @see {@link UpdateMetricSetCommandOutput} for command's `response` shape. + * @see {@link LookoutMetricsClientResolvedConfig | config} for command's `input` shape. + * */ export class UpdateMetricSetCommand extends $Command< UpdateMetricSetCommandInput, diff --git a/clients/client-lookoutmetrics/models/models_0.ts b/clients/client-lookoutmetrics/models/models_0.ts index ff4524e34826..b1e4833a6b88 100644 --- a/clients/client-lookoutmetrics/models/models_0.ts +++ b/clients/client-lookoutmetrics/models/models_0.ts @@ -11,6 +11,9 @@ export interface AccessDeniedException extends __SmithyException, $MetadataBeare } export namespace AccessDeniedException { + /** + * @internal + */ export const filterSensitiveLog = (obj: AccessDeniedException): any => ({ ...obj, }); @@ -32,6 +35,9 @@ export interface LambdaConfiguration { } export namespace LambdaConfiguration { + /** + * @internal + */ export const filterSensitiveLog = (obj: LambdaConfiguration): any => ({ ...obj, }); @@ -54,6 +60,9 @@ export interface SNSConfiguration { } export namespace SNSConfiguration { + /** + * @internal + */ export const filterSensitiveLog = (obj: SNSConfiguration): any => ({ ...obj, }); @@ -75,6 +84,9 @@ export interface Action { } export namespace Action { + /** + * @internal + */ export const filterSensitiveLog = (obj: Action): any => ({ ...obj, }); @@ -88,6 +100,9 @@ export interface ActivateAnomalyDetectorRequest { } export namespace ActivateAnomalyDetectorRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ActivateAnomalyDetectorRequest): any => ({ ...obj, }); @@ -96,6 +111,9 @@ export namespace ActivateAnomalyDetectorRequest { export interface ActivateAnomalyDetectorResponse {} export namespace ActivateAnomalyDetectorResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ActivateAnomalyDetectorResponse): any => ({ ...obj, }); @@ -120,6 +138,9 @@ export interface ConflictException extends __SmithyException, $MetadataBearer { } export namespace ConflictException { + /** + * @internal + */ export const filterSensitiveLog = (obj: ConflictException): any => ({ ...obj, }); @@ -135,6 +156,9 @@ export interface InternalServerException extends __SmithyException, $MetadataBea } export namespace InternalServerException { + /** + * @internal + */ export const filterSensitiveLog = (obj: InternalServerException): any => ({ ...obj, }); @@ -159,6 +183,9 @@ export interface ResourceNotFoundException extends __SmithyException, $MetadataB } export namespace ResourceNotFoundException { + /** + * @internal + */ export const filterSensitiveLog = (obj: ResourceNotFoundException): any => ({ ...obj, }); @@ -174,6 +201,9 @@ export interface TooManyRequestsException extends __SmithyException, $MetadataBe } export namespace TooManyRequestsException { + /** + * @internal + */ export const filterSensitiveLog = (obj: TooManyRequestsException): any => ({ ...obj, }); @@ -195,6 +225,9 @@ export interface ValidationExceptionField { } export namespace ValidationExceptionField { + /** + * @internal + */ export const filterSensitiveLog = (obj: ValidationExceptionField): any => ({ ...obj, }); @@ -227,6 +260,9 @@ export interface ValidationException extends __SmithyException, $MetadataBearer } export namespace ValidationException { + /** + * @internal + */ export const filterSensitiveLog = (obj: ValidationException): any => ({ ...obj, }); @@ -303,6 +339,9 @@ export interface Alert { } export namespace Alert { + /** + * @internal + */ export const filterSensitiveLog = (obj: Alert): any => ({ ...obj, }); @@ -359,6 +398,9 @@ export interface AlertSummary { } export namespace AlertSummary { + /** + * @internal + */ export const filterSensitiveLog = (obj: AlertSummary): any => ({ ...obj, }); @@ -390,6 +432,9 @@ export interface AnomalyDetectorConfig { } export namespace AnomalyDetectorConfig { + /** + * @internal + */ export const filterSensitiveLog = (obj: AnomalyDetectorConfig): any => ({ ...obj, }); @@ -406,6 +451,9 @@ export interface AnomalyDetectorConfigSummary { } export namespace AnomalyDetectorConfigSummary { + /** + * @internal + */ export const filterSensitiveLog = (obj: AnomalyDetectorConfigSummary): any => ({ ...obj, }); @@ -463,6 +511,9 @@ export interface AnomalyDetectorSummary { } export namespace AnomalyDetectorSummary { + /** + * @internal + */ export const filterSensitiveLog = (obj: AnomalyDetectorSummary): any => ({ ...obj, }); @@ -484,6 +535,9 @@ export interface DimensionValueContribution { } export namespace DimensionValueContribution { + /** + * @internal + */ export const filterSensitiveLog = (obj: DimensionValueContribution): any => ({ ...obj, }); @@ -505,6 +559,9 @@ export interface DimensionContribution { } export namespace DimensionContribution { + /** + * @internal + */ export const filterSensitiveLog = (obj: DimensionContribution): any => ({ ...obj, }); @@ -521,6 +578,9 @@ export interface ContributionMatrix { } export namespace ContributionMatrix { + /** + * @internal + */ export const filterSensitiveLog = (obj: ContributionMatrix): any => ({ ...obj, }); @@ -547,6 +607,9 @@ export interface MetricLevelImpact { } export namespace MetricLevelImpact { + /** + * @internal + */ export const filterSensitiveLog = (obj: MetricLevelImpact): any => ({ ...obj, }); @@ -588,6 +651,9 @@ export interface AnomalyGroup { } export namespace AnomalyGroup { + /** + * @internal + */ export const filterSensitiveLog = (obj: AnomalyGroup): any => ({ ...obj, }); @@ -609,6 +675,9 @@ export interface ItemizedMetricStats { } export namespace ItemizedMetricStats { + /** + * @internal + */ export const filterSensitiveLog = (obj: ItemizedMetricStats): any => ({ ...obj, }); @@ -635,6 +704,9 @@ export interface AnomalyGroupStatistics { } export namespace AnomalyGroupStatistics { + /** + * @internal + */ export const filterSensitiveLog = (obj: AnomalyGroupStatistics): any => ({ ...obj, }); @@ -671,6 +743,9 @@ export interface AnomalyGroupSummary { } export namespace AnomalyGroupSummary { + /** + * @internal + */ export const filterSensitiveLog = (obj: AnomalyGroupSummary): any => ({ ...obj, }); @@ -692,6 +767,9 @@ export interface AnomalyGroupTimeSeries { } export namespace AnomalyGroupTimeSeries { + /** + * @internal + */ export const filterSensitiveLog = (obj: AnomalyGroupTimeSeries): any => ({ ...obj, }); @@ -718,6 +796,9 @@ export interface AnomalyGroupTimeSeriesFeedback { } export namespace AnomalyGroupTimeSeriesFeedback { + /** + * @internal + */ export const filterSensitiveLog = (obj: AnomalyGroupTimeSeriesFeedback): any => ({ ...obj, }); @@ -739,6 +820,9 @@ export interface AppFlowConfig { } export namespace AppFlowConfig { + /** + * @internal + */ export const filterSensitiveLog = (obj: AppFlowConfig): any => ({ ...obj, }); @@ -752,6 +836,9 @@ export interface BackTestAnomalyDetectorRequest { } export namespace BackTestAnomalyDetectorRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: BackTestAnomalyDetectorRequest): any => ({ ...obj, }); @@ -760,6 +847,9 @@ export namespace BackTestAnomalyDetectorRequest { export interface BackTestAnomalyDetectorResponse {} export namespace BackTestAnomalyDetectorResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: BackTestAnomalyDetectorResponse): any => ({ ...obj, }); @@ -776,6 +866,9 @@ export interface CloudWatchConfig { } export namespace CloudWatchConfig { + /** + * @internal + */ export const filterSensitiveLog = (obj: CloudWatchConfig): any => ({ ...obj, }); @@ -814,6 +907,9 @@ export interface CreateAlertRequest { } export namespace CreateAlertRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateAlertRequest): any => ({ ...obj, }); @@ -827,6 +923,9 @@ export interface CreateAlertResponse { } export namespace CreateAlertResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateAlertResponse): any => ({ ...obj, }); @@ -861,6 +960,9 @@ export interface ServiceQuotaExceededException extends __SmithyException, $Metad } export namespace ServiceQuotaExceededException { + /** + * @internal + */ export const filterSensitiveLog = (obj: ServiceQuotaExceededException): any => ({ ...obj, }); @@ -894,6 +996,9 @@ export interface CreateAnomalyDetectorRequest { } export namespace CreateAnomalyDetectorRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateAnomalyDetectorRequest): any => ({ ...obj, }); @@ -907,6 +1012,9 @@ export interface CreateAnomalyDetectorResponse { } export namespace CreateAnomalyDetectorResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateAnomalyDetectorResponse): any => ({ ...obj, }); @@ -933,6 +1041,9 @@ export interface Metric { } export namespace Metric { + /** + * @internal + */ export const filterSensitiveLog = (obj: Metric): any => ({ ...obj, }); @@ -954,6 +1065,9 @@ export interface VpcConfiguration { } export namespace VpcConfiguration { + /** + * @internal + */ export const filterSensitiveLog = (obj: VpcConfiguration): any => ({ ...obj, }); @@ -1005,6 +1119,9 @@ export interface RDSSourceConfig { } export namespace RDSSourceConfig { + /** + * @internal + */ export const filterSensitiveLog = (obj: RDSSourceConfig): any => ({ ...obj, }); @@ -1056,6 +1173,9 @@ export interface RedshiftSourceConfig { } export namespace RedshiftSourceConfig { + /** + * @internal + */ export const filterSensitiveLog = (obj: RedshiftSourceConfig): any => ({ ...obj, }); @@ -1102,6 +1222,9 @@ export interface CsvFormatDescriptor { } export namespace CsvFormatDescriptor { + /** + * @internal + */ export const filterSensitiveLog = (obj: CsvFormatDescriptor): any => ({ ...obj, }); @@ -1128,6 +1251,9 @@ export interface JsonFormatDescriptor { } export namespace JsonFormatDescriptor { + /** + * @internal + */ export const filterSensitiveLog = (obj: JsonFormatDescriptor): any => ({ ...obj, }); @@ -1149,6 +1275,9 @@ export interface FileFormatDescriptor { } export namespace FileFormatDescriptor { + /** + * @internal + */ export const filterSensitiveLog = (obj: FileFormatDescriptor): any => ({ ...obj, }); @@ -1180,6 +1309,9 @@ export interface S3SourceConfig { } export namespace S3SourceConfig { + /** + * @internal + */ export const filterSensitiveLog = (obj: S3SourceConfig): any => ({ ...obj, }); @@ -1216,6 +1348,9 @@ export interface MetricSource { } export namespace MetricSource { + /** + * @internal + */ export const filterSensitiveLog = (obj: MetricSource): any => ({ ...obj, }); @@ -1237,6 +1372,9 @@ export interface TimestampColumn { } export namespace TimestampColumn { + /** + * @internal + */ export const filterSensitiveLog = (obj: TimestampColumn): any => ({ ...obj, }); @@ -1300,6 +1438,9 @@ export interface CreateMetricSetRequest { } export namespace CreateMetricSetRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateMetricSetRequest): any => ({ ...obj, }); @@ -1313,6 +1454,9 @@ export interface CreateMetricSetResponse { } export namespace CreateMetricSetResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateMetricSetResponse): any => ({ ...obj, }); @@ -1326,6 +1470,9 @@ export interface DeleteAlertRequest { } export namespace DeleteAlertRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteAlertRequest): any => ({ ...obj, }); @@ -1334,6 +1481,9 @@ export namespace DeleteAlertRequest { export interface DeleteAlertResponse {} export namespace DeleteAlertResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteAlertResponse): any => ({ ...obj, }); @@ -1347,6 +1497,9 @@ export interface DeleteAnomalyDetectorRequest { } export namespace DeleteAnomalyDetectorRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteAnomalyDetectorRequest): any => ({ ...obj, }); @@ -1355,6 +1508,9 @@ export namespace DeleteAnomalyDetectorRequest { export interface DeleteAnomalyDetectorResponse {} export namespace DeleteAnomalyDetectorResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteAnomalyDetectorResponse): any => ({ ...obj, }); @@ -1368,6 +1524,9 @@ export interface DescribeAlertRequest { } export namespace DescribeAlertRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeAlertRequest): any => ({ ...obj, }); @@ -1381,6 +1540,9 @@ export interface DescribeAlertResponse { } export namespace DescribeAlertResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeAlertResponse): any => ({ ...obj, }); @@ -1409,6 +1571,9 @@ export interface DescribeAnomalyDetectionExecutionsRequest { } export namespace DescribeAnomalyDetectionExecutionsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeAnomalyDetectionExecutionsRequest): any => ({ ...obj, }); @@ -1435,6 +1600,9 @@ export interface ExecutionStatus { } export namespace ExecutionStatus { + /** + * @internal + */ export const filterSensitiveLog = (obj: ExecutionStatus): any => ({ ...obj, }); @@ -1453,6 +1621,9 @@ export interface DescribeAnomalyDetectionExecutionsResponse { } export namespace DescribeAnomalyDetectionExecutionsResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeAnomalyDetectionExecutionsResponse): any => ({ ...obj, }); @@ -1466,6 +1637,9 @@ export interface DescribeAnomalyDetectorRequest { } export namespace DescribeAnomalyDetectorRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeAnomalyDetectorRequest): any => ({ ...obj, }); @@ -1519,6 +1693,9 @@ export interface DescribeAnomalyDetectorResponse { } export namespace DescribeAnomalyDetectorResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeAnomalyDetectorResponse): any => ({ ...obj, }); @@ -1532,6 +1709,9 @@ export interface DescribeMetricSetRequest { } export namespace DescribeMetricSetRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeMetricSetRequest): any => ({ ...obj, }); @@ -1605,6 +1785,9 @@ export interface DescribeMetricSetResponse { } export namespace DescribeMetricSetResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeMetricSetResponse): any => ({ ...obj, }); @@ -1626,6 +1809,9 @@ export interface DimensionNameValue { } export namespace DimensionNameValue { + /** + * @internal + */ export const filterSensitiveLog = (obj: DimensionNameValue): any => ({ ...obj, }); @@ -1644,6 +1830,9 @@ export interface GetAnomalyGroupRequest { } export namespace GetAnomalyGroupRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetAnomalyGroupRequest): any => ({ ...obj, }); @@ -1657,6 +1846,9 @@ export interface GetAnomalyGroupResponse { } export namespace GetAnomalyGroupResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetAnomalyGroupResponse): any => ({ ...obj, }); @@ -1685,6 +1877,9 @@ export interface GetFeedbackRequest { } export namespace GetFeedbackRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetFeedbackRequest): any => ({ ...obj, }); @@ -1706,6 +1901,9 @@ export interface TimeSeriesFeedback { } export namespace TimeSeriesFeedback { + /** + * @internal + */ export const filterSensitiveLog = (obj: TimeSeriesFeedback): any => ({ ...obj, }); @@ -1724,6 +1922,9 @@ export interface GetFeedbackResponse { } export namespace GetFeedbackResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetFeedbackResponse): any => ({ ...obj, }); @@ -1755,6 +1956,9 @@ export interface SampleDataS3SourceConfig { } export namespace SampleDataS3SourceConfig { + /** + * @internal + */ export const filterSensitiveLog = (obj: SampleDataS3SourceConfig): any => ({ ...obj, }); @@ -1768,6 +1972,9 @@ export interface GetSampleDataRequest { } export namespace GetSampleDataRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetSampleDataRequest): any => ({ ...obj, }); @@ -1786,6 +1993,9 @@ export interface GetSampleDataResponse { } export namespace GetSampleDataResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetSampleDataResponse): any => ({ ...obj, }); @@ -1810,6 +2020,9 @@ export interface ListAlertsRequest { } export namespace ListAlertsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListAlertsRequest): any => ({ ...obj, }); @@ -1829,6 +2042,9 @@ export interface ListAlertsResponse { } export namespace ListAlertsResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListAlertsResponse): any => ({ ...obj, }); @@ -1848,6 +2064,9 @@ export interface ListAnomalyDetectorsRequest { } export namespace ListAnomalyDetectorsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListAnomalyDetectorsRequest): any => ({ ...obj, }); @@ -1867,6 +2086,9 @@ export interface ListAnomalyDetectorsResponse { } export namespace ListAnomalyDetectorsResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListAnomalyDetectorsResponse): any => ({ ...obj, }); @@ -1895,6 +2117,9 @@ export interface ListAnomalyGroupSummariesRequest { } export namespace ListAnomalyGroupSummariesRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListAnomalyGroupSummariesRequest): any => ({ ...obj, }); @@ -1918,6 +2143,9 @@ export interface ListAnomalyGroupSummariesResponse { } export namespace ListAnomalyGroupSummariesResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListAnomalyGroupSummariesResponse): any => ({ ...obj, }); @@ -1951,6 +2179,9 @@ export interface ListAnomalyGroupTimeSeriesRequest { } export namespace ListAnomalyGroupTimeSeriesRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListAnomalyGroupTimeSeriesRequest): any => ({ ...obj, }); @@ -1978,6 +2209,9 @@ export interface TimeSeries { } export namespace TimeSeries { + /** + * @internal + */ export const filterSensitiveLog = (obj: TimeSeries): any => ({ ...obj, }); @@ -2011,6 +2245,9 @@ export interface ListAnomalyGroupTimeSeriesResponse { } export namespace ListAnomalyGroupTimeSeriesResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListAnomalyGroupTimeSeriesResponse): any => ({ ...obj, }); @@ -2035,6 +2272,9 @@ export interface ListMetricSetsRequest { } export namespace ListMetricSetsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListMetricSetsRequest): any => ({ ...obj, }); @@ -2081,6 +2321,9 @@ export interface MetricSetSummary { } export namespace MetricSetSummary { + /** + * @internal + */ export const filterSensitiveLog = (obj: MetricSetSummary): any => ({ ...obj, }); @@ -2100,6 +2343,9 @@ export interface ListMetricSetsResponse { } export namespace ListMetricSetsResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListMetricSetsResponse): any => ({ ...obj, }); @@ -2113,6 +2359,9 @@ export interface ListTagsForResourceRequest { } export namespace ListTagsForResourceRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListTagsForResourceRequest): any => ({ ...obj, }); @@ -2126,6 +2375,9 @@ export interface ListTagsForResourceResponse { } export namespace ListTagsForResourceResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListTagsForResourceResponse): any => ({ ...obj, }); @@ -2144,6 +2396,9 @@ export interface PutFeedbackRequest { } export namespace PutFeedbackRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: PutFeedbackRequest): any => ({ ...obj, }); @@ -2152,6 +2407,9 @@ export namespace PutFeedbackRequest { export interface PutFeedbackResponse {} export namespace PutFeedbackResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: PutFeedbackResponse): any => ({ ...obj, }); @@ -2172,6 +2430,9 @@ export interface TagResourceRequest { } export namespace TagResourceRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: TagResourceRequest): any => ({ ...obj, }); @@ -2180,6 +2441,9 @@ export namespace TagResourceRequest { export interface TagResourceResponse {} export namespace TagResourceResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: TagResourceResponse): any => ({ ...obj, }); @@ -2198,6 +2462,9 @@ export interface UntagResourceRequest { } export namespace UntagResourceRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: UntagResourceRequest): any => ({ ...obj, }); @@ -2206,6 +2473,9 @@ export namespace UntagResourceRequest { export interface UntagResourceResponse {} export namespace UntagResourceResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: UntagResourceResponse): any => ({ ...obj, }); @@ -2234,6 +2504,9 @@ export interface UpdateAnomalyDetectorRequest { } export namespace UpdateAnomalyDetectorRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateAnomalyDetectorRequest): any => ({ ...obj, }); @@ -2247,6 +2520,9 @@ export interface UpdateAnomalyDetectorResponse { } export namespace UpdateAnomalyDetectorResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateAnomalyDetectorResponse): any => ({ ...obj, }); @@ -2295,6 +2571,9 @@ export interface UpdateMetricSetRequest { } export namespace UpdateMetricSetRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateMetricSetRequest): any => ({ ...obj, }); @@ -2308,6 +2587,9 @@ export interface UpdateMetricSetResponse { } export namespace UpdateMetricSetResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateMetricSetResponse): any => ({ ...obj, }); diff --git a/clients/client-lookoutvision/commands/CreateDatasetCommand.ts b/clients/client-lookoutvision/commands/CreateDatasetCommand.ts index e51fff891441..abf66933a467 100644 --- a/clients/client-lookoutvision/commands/CreateDatasetCommand.ts +++ b/clients/client-lookoutvision/commands/CreateDatasetCommand.ts @@ -31,6 +31,20 @@ export interface CreateDatasetCommandOutput extends CreateDatasetResponse, __Met * DatasetType.

*

This operation requires permissions to perform the * lookoutvision:CreateDataset operation.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { LookoutVisionClient, CreateDatasetCommand } from "@aws-sdk/client-lookoutvision"; // ES Modules import + * // const { LookoutVisionClient, CreateDatasetCommand } = require("@aws-sdk/client-lookoutvision"); // CommonJS import + * const client = new LookoutVisionClient(config); + * const command = new CreateDatasetCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreateDatasetCommandInput} for command's `input` shape. + * @see {@link CreateDatasetCommandOutput} for command's `response` shape. + * @see {@link LookoutVisionClientResolvedConfig | config} for command's `input` shape. + * */ export class CreateDatasetCommand extends $Command< CreateDatasetCommandInput, diff --git a/clients/client-lookoutvision/commands/CreateModelCommand.ts b/clients/client-lookoutvision/commands/CreateModelCommand.ts index 8921d56f3c07..6aadd6486259 100644 --- a/clients/client-lookoutvision/commands/CreateModelCommand.ts +++ b/clients/client-lookoutvision/commands/CreateModelCommand.ts @@ -35,6 +35,20 @@ export interface CreateModelCommandOutput extends CreateModelResponse, __Metadat *

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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { LookoutVisionClient, CreateModelCommand } from "@aws-sdk/client-lookoutvision"; // ES Modules import + * // const { LookoutVisionClient, CreateModelCommand } = require("@aws-sdk/client-lookoutvision"); // CommonJS import + * const client = new LookoutVisionClient(config); + * const command = new CreateModelCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreateModelCommandInput} for command's `input` shape. + * @see {@link CreateModelCommandOutput} for command's `response` shape. + * @see {@link LookoutVisionClientResolvedConfig | config} for command's `input` shape. + * */ export class CreateModelCommand extends $Command< CreateModelCommandInput, diff --git a/clients/client-lookoutvision/commands/CreateProjectCommand.ts b/clients/client-lookoutvision/commands/CreateProjectCommand.ts index aefb92837dce..914ff82b92af 100644 --- a/clients/client-lookoutvision/commands/CreateProjectCommand.ts +++ b/clients/client-lookoutvision/commands/CreateProjectCommand.ts @@ -25,6 +25,20 @@ export interface CreateProjectCommandOutput extends CreateProjectResponse, __Met * CreateDataset.

*

This operation requires permissions to perform the * lookoutvision:CreateProject operation.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { LookoutVisionClient, CreateProjectCommand } from "@aws-sdk/client-lookoutvision"; // ES Modules import + * // const { LookoutVisionClient, CreateProjectCommand } = require("@aws-sdk/client-lookoutvision"); // CommonJS import + * const client = new LookoutVisionClient(config); + * const command = new CreateProjectCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreateProjectCommandInput} for command's `input` shape. + * @see {@link CreateProjectCommandOutput} for command's `response` shape. + * @see {@link LookoutVisionClientResolvedConfig | config} for command's `input` shape. + * */ export class CreateProjectCommand extends $Command< CreateProjectCommandInput, diff --git a/clients/client-lookoutvision/commands/DeleteDatasetCommand.ts b/clients/client-lookoutvision/commands/DeleteDatasetCommand.ts index 6c5a3fcda984..b2f5376857e2 100644 --- a/clients/client-lookoutvision/commands/DeleteDatasetCommand.ts +++ b/clients/client-lookoutvision/commands/DeleteDatasetCommand.ts @@ -36,6 +36,20 @@ export interface DeleteDatasetCommandOutput extends DeleteDatasetResponse, __Met * *

This operation requires permissions to perform the * lookoutvision:DeleteDataset operation.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { LookoutVisionClient, DeleteDatasetCommand } from "@aws-sdk/client-lookoutvision"; // ES Modules import + * // const { LookoutVisionClient, DeleteDatasetCommand } = require("@aws-sdk/client-lookoutvision"); // CommonJS import + * const client = new LookoutVisionClient(config); + * const command = new DeleteDatasetCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteDatasetCommandInput} for command's `input` shape. + * @see {@link DeleteDatasetCommandOutput} for command's `response` shape. + * @see {@link LookoutVisionClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteDatasetCommand extends $Command< DeleteDatasetCommandInput, diff --git a/clients/client-lookoutvision/commands/DeleteModelCommand.ts b/clients/client-lookoutvision/commands/DeleteModelCommand.ts index 57e733137ae0..5f78eadc63f1 100644 --- a/clients/client-lookoutvision/commands/DeleteModelCommand.ts +++ b/clients/client-lookoutvision/commands/DeleteModelCommand.ts @@ -28,6 +28,20 @@ export interface DeleteModelCommandOutput extends DeleteModelResponse, __Metadat * Models array.

*

This operation requires permissions to perform the * lookoutvision:DeleteModel operation.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { LookoutVisionClient, DeleteModelCommand } from "@aws-sdk/client-lookoutvision"; // ES Modules import + * // const { LookoutVisionClient, DeleteModelCommand } = require("@aws-sdk/client-lookoutvision"); // CommonJS import + * const client = new LookoutVisionClient(config); + * const command = new DeleteModelCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteModelCommandInput} for command's `input` shape. + * @see {@link DeleteModelCommandOutput} for command's `response` shape. + * @see {@link LookoutVisionClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteModelCommand extends $Command< DeleteModelCommandInput, diff --git a/clients/client-lookoutvision/commands/DeleteProjectCommand.ts b/clients/client-lookoutvision/commands/DeleteProjectCommand.ts index 24cec5a5d3fa..de801487da43 100644 --- a/clients/client-lookoutvision/commands/DeleteProjectCommand.ts +++ b/clients/client-lookoutvision/commands/DeleteProjectCommand.ts @@ -29,6 +29,20 @@ export interface DeleteProjectCommandOutput extends DeleteProjectResponse, __Met *

*

This operation requires permissions to perform the * lookoutvision:DeleteProject operation.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { LookoutVisionClient, DeleteProjectCommand } from "@aws-sdk/client-lookoutvision"; // ES Modules import + * // const { LookoutVisionClient, DeleteProjectCommand } = require("@aws-sdk/client-lookoutvision"); // CommonJS import + * const client = new LookoutVisionClient(config); + * const command = new DeleteProjectCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteProjectCommandInput} for command's `input` shape. + * @see {@link DeleteProjectCommandOutput} for command's `response` shape. + * @see {@link LookoutVisionClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteProjectCommand extends $Command< DeleteProjectCommandInput, diff --git a/clients/client-lookoutvision/commands/DescribeDatasetCommand.ts b/clients/client-lookoutvision/commands/DescribeDatasetCommand.ts index 45794cd8b30e..b386fa03ef16 100644 --- a/clients/client-lookoutvision/commands/DescribeDatasetCommand.ts +++ b/clients/client-lookoutvision/commands/DescribeDatasetCommand.ts @@ -24,6 +24,20 @@ export interface DescribeDatasetCommandOutput extends DescribeDatasetResponse, _ *

Describe an Amazon Lookout for Vision dataset.

*

This operation requires permissions to perform the * lookoutvision:DescribeDataset operation.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { LookoutVisionClient, DescribeDatasetCommand } from "@aws-sdk/client-lookoutvision"; // ES Modules import + * // const { LookoutVisionClient, DescribeDatasetCommand } = require("@aws-sdk/client-lookoutvision"); // CommonJS import + * const client = new LookoutVisionClient(config); + * const command = new DescribeDatasetCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeDatasetCommandInput} for command's `input` shape. + * @see {@link DescribeDatasetCommandOutput} for command's `response` shape. + * @see {@link LookoutVisionClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeDatasetCommand extends $Command< DescribeDatasetCommandInput, diff --git a/clients/client-lookoutvision/commands/DescribeModelCommand.ts b/clients/client-lookoutvision/commands/DescribeModelCommand.ts index effea55bf40e..bfbbe4c77e68 100644 --- a/clients/client-lookoutvision/commands/DescribeModelCommand.ts +++ b/clients/client-lookoutvision/commands/DescribeModelCommand.ts @@ -24,6 +24,20 @@ export interface DescribeModelCommandOutput extends DescribeModelResponse, __Met *

Describes a version of an Amazon Lookout for Vision model.

*

This operation requires permissions to perform the * lookoutvision:DescribeModel operation.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { LookoutVisionClient, DescribeModelCommand } from "@aws-sdk/client-lookoutvision"; // ES Modules import + * // const { LookoutVisionClient, DescribeModelCommand } = require("@aws-sdk/client-lookoutvision"); // CommonJS import + * const client = new LookoutVisionClient(config); + * const command = new DescribeModelCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeModelCommandInput} for command's `input` shape. + * @see {@link DescribeModelCommandOutput} for command's `response` shape. + * @see {@link LookoutVisionClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeModelCommand extends $Command< DescribeModelCommandInput, diff --git a/clients/client-lookoutvision/commands/DescribeProjectCommand.ts b/clients/client-lookoutvision/commands/DescribeProjectCommand.ts index 65ceb3c88387..a24ee3d5faf3 100644 --- a/clients/client-lookoutvision/commands/DescribeProjectCommand.ts +++ b/clients/client-lookoutvision/commands/DescribeProjectCommand.ts @@ -24,6 +24,20 @@ export interface DescribeProjectCommandOutput extends DescribeProjectResponse, _ *

Describes an Amazon Lookout for Vision project.

*

This operation requires permissions to perform the * lookoutvision:DescribeProject operation.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { LookoutVisionClient, DescribeProjectCommand } from "@aws-sdk/client-lookoutvision"; // ES Modules import + * // const { LookoutVisionClient, DescribeProjectCommand } = require("@aws-sdk/client-lookoutvision"); // CommonJS import + * const client = new LookoutVisionClient(config); + * const command = new DescribeProjectCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeProjectCommandInput} for command's `input` shape. + * @see {@link DescribeProjectCommandOutput} for command's `response` shape. + * @see {@link LookoutVisionClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeProjectCommand extends $Command< DescribeProjectCommandInput, diff --git a/clients/client-lookoutvision/commands/DetectAnomaliesCommand.ts b/clients/client-lookoutvision/commands/DetectAnomaliesCommand.ts index 1488b6968a4f..a0b9ce4f7c64 100644 --- a/clients/client-lookoutvision/commands/DetectAnomaliesCommand.ts +++ b/clients/client-lookoutvision/commands/DetectAnomaliesCommand.ts @@ -40,6 +40,20 @@ export interface DetectAnomaliesCommandOutput extends DetectAnomaliesResponse, _ * *

This operation requires permissions to perform the * lookoutvision:DetectAnomalies operation.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { LookoutVisionClient, DetectAnomaliesCommand } from "@aws-sdk/client-lookoutvision"; // ES Modules import + * // const { LookoutVisionClient, DetectAnomaliesCommand } = require("@aws-sdk/client-lookoutvision"); // CommonJS import + * const client = new LookoutVisionClient(config); + * const command = new DetectAnomaliesCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DetectAnomaliesCommandInput} for command's `input` shape. + * @see {@link DetectAnomaliesCommandOutput} for command's `response` shape. + * @see {@link LookoutVisionClientResolvedConfig | config} for command's `input` shape. + * */ export class DetectAnomaliesCommand extends $Command< DetectAnomaliesCommandInput, diff --git a/clients/client-lookoutvision/commands/ListDatasetEntriesCommand.ts b/clients/client-lookoutvision/commands/ListDatasetEntriesCommand.ts index db319b2780f8..4dd5e1ec6fd1 100644 --- a/clients/client-lookoutvision/commands/ListDatasetEntriesCommand.ts +++ b/clients/client-lookoutvision/commands/ListDatasetEntriesCommand.ts @@ -25,6 +25,20 @@ export interface ListDatasetEntriesCommandOutput extends ListDatasetEntriesRespo * information for a single image, including the image location and the assigned label.

*

This operation requires permissions to perform the * lookoutvision:ListDatasetEntries operation.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { LookoutVisionClient, ListDatasetEntriesCommand } from "@aws-sdk/client-lookoutvision"; // ES Modules import + * // const { LookoutVisionClient, ListDatasetEntriesCommand } = require("@aws-sdk/client-lookoutvision"); // CommonJS import + * const client = new LookoutVisionClient(config); + * const command = new ListDatasetEntriesCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListDatasetEntriesCommandInput} for command's `input` shape. + * @see {@link ListDatasetEntriesCommandOutput} for command's `response` shape. + * @see {@link LookoutVisionClientResolvedConfig | config} for command's `input` shape. + * */ export class ListDatasetEntriesCommand extends $Command< ListDatasetEntriesCommandInput, diff --git a/clients/client-lookoutvision/commands/ListModelsCommand.ts b/clients/client-lookoutvision/commands/ListModelsCommand.ts index b817def66b74..94166cfa5ef1 100644 --- a/clients/client-lookoutvision/commands/ListModelsCommand.ts +++ b/clients/client-lookoutvision/commands/ListModelsCommand.ts @@ -24,6 +24,20 @@ export interface ListModelsCommandOutput extends ListModelsResponse, __MetadataB *

Lists the versions of a model in an Amazon Lookout for Vision project.

*

This operation requires permissions to perform the * lookoutvision:ListModels operation.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { LookoutVisionClient, ListModelsCommand } from "@aws-sdk/client-lookoutvision"; // ES Modules import + * // const { LookoutVisionClient, ListModelsCommand } = require("@aws-sdk/client-lookoutvision"); // CommonJS import + * const client = new LookoutVisionClient(config); + * const command = new ListModelsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListModelsCommandInput} for command's `input` shape. + * @see {@link ListModelsCommandOutput} for command's `response` shape. + * @see {@link LookoutVisionClientResolvedConfig | config} for command's `input` shape. + * */ export class ListModelsCommand extends $Command< ListModelsCommandInput, diff --git a/clients/client-lookoutvision/commands/ListProjectsCommand.ts b/clients/client-lookoutvision/commands/ListProjectsCommand.ts index 9dc8642e8280..23495c401ef1 100644 --- a/clients/client-lookoutvision/commands/ListProjectsCommand.ts +++ b/clients/client-lookoutvision/commands/ListProjectsCommand.ts @@ -24,6 +24,20 @@ export interface ListProjectsCommandOutput extends ListProjectsResponse, __Metad *

Lists the Amazon Lookout for Vision projects in your AWS account.

*

This operation requires permissions to perform the * lookoutvision:ListProjects operation.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { LookoutVisionClient, ListProjectsCommand } from "@aws-sdk/client-lookoutvision"; // ES Modules import + * // const { LookoutVisionClient, ListProjectsCommand } = require("@aws-sdk/client-lookoutvision"); // CommonJS import + * const client = new LookoutVisionClient(config); + * const command = new ListProjectsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListProjectsCommandInput} for command's `input` shape. + * @see {@link ListProjectsCommandOutput} for command's `response` shape. + * @see {@link LookoutVisionClientResolvedConfig | config} for command's `input` shape. + * */ export class ListProjectsCommand extends $Command< ListProjectsCommandInput, diff --git a/clients/client-lookoutvision/commands/ListTagsForResourceCommand.ts b/clients/client-lookoutvision/commands/ListTagsForResourceCommand.ts index cb1512837976..8e17a4f60c5b 100644 --- a/clients/client-lookoutvision/commands/ListTagsForResourceCommand.ts +++ b/clients/client-lookoutvision/commands/ListTagsForResourceCommand.ts @@ -24,6 +24,20 @@ export interface ListTagsForResourceCommandOutput extends ListTagsForResourceRes *

Returns a list of tags attached to the specified Amazon Lookout for Vision model.

*

This operation requires permissions to perform the * lookoutvision:ListTagsForResource operation.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { LookoutVisionClient, ListTagsForResourceCommand } from "@aws-sdk/client-lookoutvision"; // ES Modules import + * // const { LookoutVisionClient, ListTagsForResourceCommand } = require("@aws-sdk/client-lookoutvision"); // CommonJS import + * const client = new LookoutVisionClient(config); + * const command = new ListTagsForResourceCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListTagsForResourceCommandInput} for command's `input` shape. + * @see {@link ListTagsForResourceCommandOutput} for command's `response` shape. + * @see {@link LookoutVisionClientResolvedConfig | config} for command's `input` shape. + * */ export class ListTagsForResourceCommand extends $Command< ListTagsForResourceCommandInput, diff --git a/clients/client-lookoutvision/commands/StartModelCommand.ts b/clients/client-lookoutvision/commands/StartModelCommand.ts index 86d094b1438e..1095119feb56 100644 --- a/clients/client-lookoutvision/commands/StartModelCommand.ts +++ b/clients/client-lookoutvision/commands/StartModelCommand.ts @@ -32,6 +32,20 @@ export interface StartModelCommandOutput extends StartModelResponse, __MetadataB * *

This operation requires permissions to perform the * lookoutvision:StartModel operation.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { LookoutVisionClient, StartModelCommand } from "@aws-sdk/client-lookoutvision"; // ES Modules import + * // const { LookoutVisionClient, StartModelCommand } = require("@aws-sdk/client-lookoutvision"); // CommonJS import + * const client = new LookoutVisionClient(config); + * const command = new StartModelCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link StartModelCommandInput} for command's `input` shape. + * @see {@link StartModelCommandOutput} for command's `response` shape. + * @see {@link LookoutVisionClientResolvedConfig | config} for command's `input` shape. + * */ export class StartModelCommand extends $Command< StartModelCommandInput, diff --git a/clients/client-lookoutvision/commands/StopModelCommand.ts b/clients/client-lookoutvision/commands/StopModelCommand.ts index 7f6d63c19e25..990a99e1067f 100644 --- a/clients/client-lookoutvision/commands/StopModelCommand.ts +++ b/clients/client-lookoutvision/commands/StopModelCommand.ts @@ -26,6 +26,20 @@ export interface StopModelCommandOutput extends StopModelResponse, __MetadataBea *

After the model hosting stops, the Status of the model is TRAINED.

*

This operation requires permissions to perform the * lookoutvision:StopModel operation.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { LookoutVisionClient, StopModelCommand } from "@aws-sdk/client-lookoutvision"; // ES Modules import + * // const { LookoutVisionClient, StopModelCommand } = require("@aws-sdk/client-lookoutvision"); // CommonJS import + * const client = new LookoutVisionClient(config); + * const command = new StopModelCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link StopModelCommandInput} for command's `input` shape. + * @see {@link StopModelCommandOutput} for command's `response` shape. + * @see {@link LookoutVisionClientResolvedConfig | config} for command's `input` shape. + * */ export class StopModelCommand extends $Command< StopModelCommandInput, diff --git a/clients/client-lookoutvision/commands/TagResourceCommand.ts b/clients/client-lookoutvision/commands/TagResourceCommand.ts index 5b6fc6f74241..52cffb1ce47f 100644 --- a/clients/client-lookoutvision/commands/TagResourceCommand.ts +++ b/clients/client-lookoutvision/commands/TagResourceCommand.ts @@ -25,6 +25,20 @@ export interface TagResourceCommandOutput extends TagResourceResponse, __Metadat * 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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { LookoutVisionClient, TagResourceCommand } from "@aws-sdk/client-lookoutvision"; // ES Modules import + * // const { LookoutVisionClient, TagResourceCommand } = require("@aws-sdk/client-lookoutvision"); // CommonJS import + * const client = new LookoutVisionClient(config); + * const command = new TagResourceCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link TagResourceCommandInput} for command's `input` shape. + * @see {@link TagResourceCommandOutput} for command's `response` shape. + * @see {@link LookoutVisionClientResolvedConfig | config} for command's `input` shape. + * */ export class TagResourceCommand extends $Command< TagResourceCommandInput, diff --git a/clients/client-lookoutvision/commands/UntagResourceCommand.ts b/clients/client-lookoutvision/commands/UntagResourceCommand.ts index 99bd54050355..e665e8174949 100644 --- a/clients/client-lookoutvision/commands/UntagResourceCommand.ts +++ b/clients/client-lookoutvision/commands/UntagResourceCommand.ts @@ -25,6 +25,20 @@ export interface UntagResourceCommandOutput extends UntagResourceResponse, __Met * Tagging a model in the Amazon Lookout for Vision Developer Guide.

*

This operation requires permissions to perform the * lookoutvision:UntagResource operation.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { LookoutVisionClient, UntagResourceCommand } from "@aws-sdk/client-lookoutvision"; // ES Modules import + * // const { LookoutVisionClient, UntagResourceCommand } = require("@aws-sdk/client-lookoutvision"); // CommonJS import + * const client = new LookoutVisionClient(config); + * const command = new UntagResourceCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link UntagResourceCommandInput} for command's `input` shape. + * @see {@link UntagResourceCommandOutput} for command's `response` shape. + * @see {@link LookoutVisionClientResolvedConfig | config} for command's `input` shape. + * */ export class UntagResourceCommand extends $Command< UntagResourceCommandInput, diff --git a/clients/client-lookoutvision/commands/UpdateDatasetEntriesCommand.ts b/clients/client-lookoutvision/commands/UpdateDatasetEntriesCommand.ts index 6789ee62c6a3..a693dd9c4f95 100644 --- a/clients/client-lookoutvision/commands/UpdateDatasetEntriesCommand.ts +++ b/clients/client-lookoutvision/commands/UpdateDatasetEntriesCommand.ts @@ -29,6 +29,20 @@ export interface UpdateDatasetEntriesCommandOutput extends UpdateDatasetEntriesR * check the Status field in the response.

*

This operation requires permissions to perform the * lookoutvision:UpdateDatasetEntries operation.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { LookoutVisionClient, UpdateDatasetEntriesCommand } from "@aws-sdk/client-lookoutvision"; // ES Modules import + * // const { LookoutVisionClient, UpdateDatasetEntriesCommand } = require("@aws-sdk/client-lookoutvision"); // CommonJS import + * const client = new LookoutVisionClient(config); + * const command = new UpdateDatasetEntriesCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link UpdateDatasetEntriesCommandInput} for command's `input` shape. + * @see {@link UpdateDatasetEntriesCommandOutput} for command's `response` shape. + * @see {@link LookoutVisionClientResolvedConfig | config} for command's `input` shape. + * */ export class UpdateDatasetEntriesCommand extends $Command< UpdateDatasetEntriesCommandInput, diff --git a/clients/client-lookoutvision/models/models_0.ts b/clients/client-lookoutvision/models/models_0.ts index 09d4c1398224..e30101501d42 100644 --- a/clients/client-lookoutvision/models/models_0.ts +++ b/clients/client-lookoutvision/models/models_0.ts @@ -12,6 +12,9 @@ export interface AccessDeniedException extends __SmithyException, $MetadataBeare } export namespace AccessDeniedException { + /** + * @internal + */ export const filterSensitiveLog = (obj: AccessDeniedException): any => ({ ...obj, }); @@ -43,6 +46,9 @@ export interface ConflictException extends __SmithyException, $MetadataBearer { } export namespace ConflictException { + /** + * @internal + */ export const filterSensitiveLog = (obj: ConflictException): any => ({ ...obj, }); @@ -69,6 +75,9 @@ export interface InputS3Object { } export namespace InputS3Object { + /** + * @internal + */ export const filterSensitiveLog = (obj: InputS3Object): any => ({ ...obj, }); @@ -86,6 +95,9 @@ export interface DatasetGroundTruthManifest { } export namespace DatasetGroundTruthManifest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DatasetGroundTruthManifest): any => ({ ...obj, }); @@ -102,6 +114,9 @@ export interface DatasetSource { } export namespace DatasetSource { + /** + * @internal + */ export const filterSensitiveLog = (obj: DatasetSource): any => ({ ...obj, }); @@ -146,6 +161,9 @@ export interface CreateDatasetRequest { } export namespace CreateDatasetRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateDatasetRequest): any => ({ ...obj, }); @@ -190,6 +208,9 @@ export interface DatasetMetadata { } export namespace DatasetMetadata { + /** + * @internal + */ export const filterSensitiveLog = (obj: DatasetMetadata): any => ({ ...obj, }); @@ -203,6 +224,9 @@ export interface CreateDatasetResponse { } export namespace CreateDatasetResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateDatasetResponse): any => ({ ...obj, }); @@ -222,6 +246,9 @@ export interface InternalServerException extends __SmithyException, $MetadataBea } export namespace InternalServerException { + /** + * @internal + */ export const filterSensitiveLog = (obj: InternalServerException): any => ({ ...obj, }); @@ -246,6 +273,9 @@ export interface ResourceNotFoundException extends __SmithyException, $MetadataB } export namespace ResourceNotFoundException { + /** + * @internal + */ export const filterSensitiveLog = (obj: ResourceNotFoundException): any => ({ ...obj, }); @@ -281,6 +311,9 @@ export interface ServiceQuotaExceededException extends __SmithyException, $Metad } export namespace ServiceQuotaExceededException { + /** + * @internal + */ export const filterSensitiveLog = (obj: ServiceQuotaExceededException): any => ({ ...obj, }); @@ -310,6 +343,9 @@ export interface ThrottlingException extends __SmithyException, $MetadataBearer } export namespace ThrottlingException { + /** + * @internal + */ export const filterSensitiveLog = (obj: ThrottlingException): any => ({ ...obj, }); @@ -326,6 +362,9 @@ export interface ValidationException extends __SmithyException, $MetadataBearer } export namespace ValidationException { + /** + * @internal + */ export const filterSensitiveLog = (obj: ValidationException): any => ({ ...obj, }); @@ -347,6 +386,9 @@ export interface S3Location { } export namespace S3Location { + /** + * @internal + */ export const filterSensitiveLog = (obj: S3Location): any => ({ ...obj, }); @@ -363,6 +405,9 @@ export interface OutputConfig { } export namespace OutputConfig { + /** + * @internal + */ export const filterSensitiveLog = (obj: OutputConfig): any => ({ ...obj, }); @@ -384,6 +429,9 @@ export interface Tag { } export namespace Tag { + /** + * @internal + */ export const filterSensitiveLog = (obj: Tag): any => ({ ...obj, }); @@ -432,6 +480,9 @@ export interface CreateModelRequest { } export namespace CreateModelRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateModelRequest): any => ({ ...obj, }); @@ -458,6 +509,9 @@ export interface ModelPerformance { } export namespace ModelPerformance { + /** + * @internal + */ export const filterSensitiveLog = (obj: ModelPerformance): any => ({ ...obj, }); @@ -516,6 +570,9 @@ export interface ModelMetadata { } export namespace ModelMetadata { + /** + * @internal + */ export const filterSensitiveLog = (obj: ModelMetadata): any => ({ ...obj, }); @@ -529,6 +586,9 @@ export interface CreateModelResponse { } export namespace CreateModelResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateModelResponse): any => ({ ...obj, }); @@ -554,6 +614,9 @@ export interface CreateProjectRequest { } export namespace CreateProjectRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateProjectRequest): any => ({ ...obj, }); @@ -580,6 +643,9 @@ export interface ProjectMetadata { } export namespace ProjectMetadata { + /** + * @internal + */ export const filterSensitiveLog = (obj: ProjectMetadata): any => ({ ...obj, }); @@ -593,6 +659,9 @@ export interface CreateProjectResponse { } export namespace CreateProjectResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateProjectResponse): any => ({ ...obj, }); @@ -624,6 +693,9 @@ export interface DatasetImageStats { } export namespace DatasetImageStats { + /** + * @internal + */ export const filterSensitiveLog = (obj: DatasetImageStats): any => ({ ...obj, }); @@ -671,6 +743,9 @@ export interface DatasetDescription { } export namespace DatasetDescription { + /** + * @internal + */ export const filterSensitiveLog = (obj: DatasetDescription): any => ({ ...obj, }); @@ -703,6 +778,9 @@ export interface DeleteDatasetRequest { } export namespace DeleteDatasetRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteDatasetRequest): any => ({ ...obj, }); @@ -711,6 +789,9 @@ export namespace DeleteDatasetRequest { export interface DeleteDatasetResponse {} export namespace DeleteDatasetResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteDatasetResponse): any => ({ ...obj, }); @@ -741,6 +822,9 @@ export interface DeleteModelRequest { } export namespace DeleteModelRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteModelRequest): any => ({ ...obj, }); @@ -754,6 +838,9 @@ export interface DeleteModelResponse { } export namespace DeleteModelResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteModelResponse): any => ({ ...obj, }); @@ -779,6 +866,9 @@ export interface DeleteProjectRequest { } export namespace DeleteProjectRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteProjectRequest): any => ({ ...obj, }); @@ -792,6 +882,9 @@ export interface DeleteProjectResponse { } export namespace DeleteProjectResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteProjectResponse): any => ({ ...obj, }); @@ -813,6 +906,9 @@ export interface DescribeDatasetRequest { } export namespace DescribeDatasetRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeDatasetRequest): any => ({ ...obj, }); @@ -826,6 +922,9 @@ export interface DescribeDatasetResponse { } export namespace DescribeDatasetResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeDatasetResponse): any => ({ ...obj, }); @@ -844,6 +943,9 @@ export interface DescribeModelRequest { } export namespace DescribeModelRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeModelRequest): any => ({ ...obj, }); @@ -865,6 +967,9 @@ export interface OutputS3Object { } export namespace OutputS3Object { + /** + * @internal + */ export const filterSensitiveLog = (obj: OutputS3Object): any => ({ ...obj, }); @@ -938,6 +1043,9 @@ export interface ModelDescription { } export namespace ModelDescription { + /** + * @internal + */ export const filterSensitiveLog = (obj: ModelDescription): any => ({ ...obj, }); @@ -951,6 +1059,9 @@ export interface DescribeModelResponse { } export namespace DescribeModelResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeModelResponse): any => ({ ...obj, }); @@ -964,6 +1075,9 @@ export interface DescribeProjectRequest { } export namespace DescribeProjectRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeProjectRequest): any => ({ ...obj, }); @@ -995,6 +1109,9 @@ export interface ProjectDescription { } export namespace ProjectDescription { + /** + * @internal + */ export const filterSensitiveLog = (obj: ProjectDescription): any => ({ ...obj, }); @@ -1008,6 +1125,9 @@ export interface DescribeProjectResponse { } export namespace DescribeProjectResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeProjectResponse): any => ({ ...obj, }); @@ -1037,6 +1157,9 @@ export interface DetectAnomaliesRequest { } export namespace DetectAnomaliesRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DetectAnomaliesRequest): any => ({ ...obj, }); @@ -1053,6 +1176,9 @@ export interface ImageSource { } export namespace ImageSource { + /** + * @internal + */ export const filterSensitiveLog = (obj: ImageSource): any => ({ ...obj, }); @@ -1080,6 +1206,9 @@ export interface DetectAnomalyResult { } export namespace DetectAnomalyResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: DetectAnomalyResult): any => ({ ...obj, }); @@ -1093,6 +1222,9 @@ export interface DetectAnomaliesResponse { } export namespace DetectAnomaliesResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DetectAnomaliesResponse): any => ({ ...obj, }); @@ -1155,6 +1287,9 @@ export interface ListDatasetEntriesRequest { } export namespace ListDatasetEntriesRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListDatasetEntriesRequest): any => ({ ...obj, }); @@ -1174,6 +1309,9 @@ export interface ListDatasetEntriesResponse { } export namespace ListDatasetEntriesResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListDatasetEntriesResponse): any => ({ ...obj, }); @@ -1201,6 +1339,9 @@ export interface ListModelsRequest { } export namespace ListModelsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListModelsRequest): any => ({ ...obj, }); @@ -1220,6 +1361,9 @@ export interface ListModelsResponse { } export namespace ListModelsResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListModelsResponse): any => ({ ...obj, }); @@ -1242,6 +1386,9 @@ export interface ListProjectsRequest { } export namespace ListProjectsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListProjectsRequest): any => ({ ...obj, }); @@ -1261,6 +1408,9 @@ export interface ListProjectsResponse { } export namespace ListProjectsResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListProjectsResponse): any => ({ ...obj, }); @@ -1274,6 +1424,9 @@ export interface ListTagsForResourceRequest { } export namespace ListTagsForResourceRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListTagsForResourceRequest): any => ({ ...obj, }); @@ -1287,6 +1440,9 @@ export interface ListTagsForResourceResponse { } export namespace ListTagsForResourceResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListTagsForResourceResponse): any => ({ ...obj, }); @@ -1327,6 +1483,9 @@ export interface StartModelRequest { } export namespace StartModelRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: StartModelRequest): any => ({ ...obj, }); @@ -1348,6 +1507,9 @@ export interface StartModelResponse { } export namespace StartModelResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: StartModelResponse): any => ({ ...obj, }); @@ -1381,6 +1543,9 @@ export interface StopModelRequest { } export namespace StopModelRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: StopModelRequest): any => ({ ...obj, }); @@ -1394,6 +1559,9 @@ export interface StopModelResponse { } export namespace StopModelResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: StopModelResponse): any => ({ ...obj, }); @@ -1412,6 +1580,9 @@ export interface TagResourceRequest { } export namespace TagResourceRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: TagResourceRequest): any => ({ ...obj, }); @@ -1420,6 +1591,9 @@ export namespace TagResourceRequest { export interface TagResourceResponse {} export namespace TagResourceResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: TagResourceResponse): any => ({ ...obj, }); @@ -1438,6 +1612,9 @@ export interface UntagResourceRequest { } export namespace UntagResourceRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: UntagResourceRequest): any => ({ ...obj, }); @@ -1446,6 +1623,9 @@ export namespace UntagResourceRequest { export interface UntagResourceResponse {} export namespace UntagResourceResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: UntagResourceResponse): any => ({ ...obj, }); @@ -1484,6 +1664,9 @@ export interface UpdateDatasetEntriesRequest { } export namespace UpdateDatasetEntriesRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateDatasetEntriesRequest): any => ({ ...obj, }); @@ -1497,6 +1680,9 @@ export interface UpdateDatasetEntriesResponse { } export namespace UpdateDatasetEntriesResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateDatasetEntriesResponse): any => ({ ...obj, }); diff --git a/clients/client-machine-learning/commands/AddTagsCommand.ts b/clients/client-machine-learning/commands/AddTagsCommand.ts index 00afbff3af37..a7a830b029dd 100644 --- a/clients/client-machine-learning/commands/AddTagsCommand.ts +++ b/clients/client-machine-learning/commands/AddTagsCommand.ts @@ -21,6 +21,20 @@ export interface AddTagsCommandOutput extends AddTagsOutput, __MetadataBearer {} *

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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { MachineLearningClient, AddTagsCommand } from "@aws-sdk/client-machine-learning"; // ES Modules import + * // const { MachineLearningClient, AddTagsCommand } = require("@aws-sdk/client-machine-learning"); // CommonJS import + * const client = new MachineLearningClient(config); + * const command = new AddTagsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link AddTagsCommandInput} for command's `input` shape. + * @see {@link AddTagsCommandOutput} for command's `response` shape. + * @see {@link MachineLearningClientResolvedConfig | config} for command's `input` shape. + * */ export class AddTagsCommand extends $Command< AddTagsCommandInput, diff --git a/clients/client-machine-learning/commands/CreateBatchPredictionCommand.ts b/clients/client-machine-learning/commands/CreateBatchPredictionCommand.ts index 117be29b644b..3e3fcc3a13ff 100644 --- a/clients/client-machine-learning/commands/CreateBatchPredictionCommand.ts +++ b/clients/client-machine-learning/commands/CreateBatchPredictionCommand.ts @@ -33,6 +33,20 @@ export interface CreateBatchPredictionCommandOutput extends CreateBatchPredictio *

*

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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { MachineLearningClient, CreateBatchPredictionCommand } from "@aws-sdk/client-machine-learning"; // ES Modules import + * // const { MachineLearningClient, CreateBatchPredictionCommand } = require("@aws-sdk/client-machine-learning"); // CommonJS import + * const client = new MachineLearningClient(config); + * const command = new CreateBatchPredictionCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreateBatchPredictionCommandInput} for command's `input` shape. + * @see {@link CreateBatchPredictionCommandOutput} for command's `response` shape. + * @see {@link MachineLearningClientResolvedConfig | config} for command's `input` shape. + * */ export class CreateBatchPredictionCommand extends $Command< CreateBatchPredictionCommandInput, diff --git a/clients/client-machine-learning/commands/CreateDataSourceFromRDSCommand.ts b/clients/client-machine-learning/commands/CreateDataSourceFromRDSCommand.ts index d4e189b3fb59..059365cb0831 100644 --- a/clients/client-machine-learning/commands/CreateDataSourceFromRDSCommand.ts +++ b/clients/client-machine-learning/commands/CreateDataSourceFromRDSCommand.ts @@ -33,6 +33,20 @@ export interface CreateDataSourceFromRDSCommandOutput extends CreateDataSourceFr *

* 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. *

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { MachineLearningClient, CreateDataSourceFromRDSCommand } from "@aws-sdk/client-machine-learning"; // ES Modules import + * // const { MachineLearningClient, CreateDataSourceFromRDSCommand } = require("@aws-sdk/client-machine-learning"); // CommonJS import + * const client = new MachineLearningClient(config); + * const command = new CreateDataSourceFromRDSCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreateDataSourceFromRDSCommandInput} for command's `input` shape. + * @see {@link CreateDataSourceFromRDSCommandOutput} for command's `response` shape. + * @see {@link MachineLearningClientResolvedConfig | config} for command's `input` shape. + * */ export class CreateDataSourceFromRDSCommand extends $Command< CreateDataSourceFromRDSCommandInput, diff --git a/clients/client-machine-learning/commands/CreateDataSourceFromRedshiftCommand.ts b/clients/client-machine-learning/commands/CreateDataSourceFromRedshiftCommand.ts index 79b27cc78ac4..f739eda84c5b 100644 --- a/clients/client-machine-learning/commands/CreateDataSourceFromRedshiftCommand.ts +++ b/clients/client-machine-learning/commands/CreateDataSourceFromRedshiftCommand.ts @@ -56,6 +56,20 @@ export interface CreateDataSourceFromRedshiftCommandOutput * 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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { MachineLearningClient, CreateDataSourceFromRedshiftCommand } from "@aws-sdk/client-machine-learning"; // ES Modules import + * // const { MachineLearningClient, CreateDataSourceFromRedshiftCommand } = require("@aws-sdk/client-machine-learning"); // CommonJS import + * const client = new MachineLearningClient(config); + * const command = new CreateDataSourceFromRedshiftCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreateDataSourceFromRedshiftCommandInput} for command's `input` shape. + * @see {@link CreateDataSourceFromRedshiftCommandOutput} for command's `response` shape. + * @see {@link MachineLearningClientResolvedConfig | config} for command's `input` shape. + * */ export class CreateDataSourceFromRedshiftCommand extends $Command< CreateDataSourceFromRedshiftCommandInput, diff --git a/clients/client-machine-learning/commands/CreateDataSourceFromS3Command.ts b/clients/client-machine-learning/commands/CreateDataSourceFromS3Command.ts index 13ec8d7cf89c..a97f60ff78fc 100644 --- a/clients/client-machine-learning/commands/CreateDataSourceFromS3Command.ts +++ b/clients/client-machine-learning/commands/CreateDataSourceFromS3Command.ts @@ -52,6 +52,20 @@ export interface CreateDataSourceFromS3CommandOutput extends CreateDataSourceFro * 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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { MachineLearningClient, CreateDataSourceFromS3Command } from "@aws-sdk/client-machine-learning"; // ES Modules import + * // const { MachineLearningClient, CreateDataSourceFromS3Command } = require("@aws-sdk/client-machine-learning"); // CommonJS import + * const client = new MachineLearningClient(config); + * const command = new CreateDataSourceFromS3Command(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreateDataSourceFromS3CommandInput} for command's `input` shape. + * @see {@link CreateDataSourceFromS3CommandOutput} for command's `response` shape. + * @see {@link MachineLearningClientResolvedConfig | config} for command's `input` shape. + * */ export class CreateDataSourceFromS3Command extends $Command< CreateDataSourceFromS3CommandInput, diff --git a/clients/client-machine-learning/commands/CreateEvaluationCommand.ts b/clients/client-machine-learning/commands/CreateEvaluationCommand.ts index c152a15d467d..15efb74ca25b 100644 --- a/clients/client-machine-learning/commands/CreateEvaluationCommand.ts +++ b/clients/client-machine-learning/commands/CreateEvaluationCommand.ts @@ -33,6 +33,20 @@ export interface CreateEvaluationCommandOutput extends CreateEvaluationOutput, _ * Amazon ML sets the status to COMPLETED. *

*

You can use the GetEvaluation operation to check progress of the evaluation during the creation operation.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { MachineLearningClient, CreateEvaluationCommand } from "@aws-sdk/client-machine-learning"; // ES Modules import + * // const { MachineLearningClient, CreateEvaluationCommand } = require("@aws-sdk/client-machine-learning"); // CommonJS import + * const client = new MachineLearningClient(config); + * const command = new CreateEvaluationCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreateEvaluationCommandInput} for command's `input` shape. + * @see {@link CreateEvaluationCommandOutput} for command's `response` shape. + * @see {@link MachineLearningClientResolvedConfig | config} for command's `input` shape. + * */ export class CreateEvaluationCommand extends $Command< CreateEvaluationCommandInput, diff --git a/clients/client-machine-learning/commands/CreateMLModelCommand.ts b/clients/client-machine-learning/commands/CreateMLModelCommand.ts index ea40d2618603..472042538e52 100644 --- a/clients/client-machine-learning/commands/CreateMLModelCommand.ts +++ b/clients/client-machine-learning/commands/CreateMLModelCommand.ts @@ -41,6 +41,20 @@ export interface CreateMLModelCommandOutput extends CreateMLModelOutput, __Metad * CreateDataSourceFromRDS, CreateDataSourceFromS3, or * CreateDataSourceFromRedshift operations. *

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { MachineLearningClient, CreateMLModelCommand } from "@aws-sdk/client-machine-learning"; // ES Modules import + * // const { MachineLearningClient, CreateMLModelCommand } = require("@aws-sdk/client-machine-learning"); // CommonJS import + * const client = new MachineLearningClient(config); + * const command = new CreateMLModelCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreateMLModelCommandInput} for command's `input` shape. + * @see {@link CreateMLModelCommandOutput} for command's `response` shape. + * @see {@link MachineLearningClientResolvedConfig | config} for command's `input` shape. + * */ export class CreateMLModelCommand extends $Command< CreateMLModelCommandInput, diff --git a/clients/client-machine-learning/commands/CreateRealtimeEndpointCommand.ts b/clients/client-machine-learning/commands/CreateRealtimeEndpointCommand.ts index 661f0759620e..fae8dbec046c 100644 --- a/clients/client-machine-learning/commands/CreateRealtimeEndpointCommand.ts +++ b/clients/client-machine-learning/commands/CreateRealtimeEndpointCommand.ts @@ -22,6 +22,20 @@ export interface CreateRealtimeEndpointCommandOutput extends CreateRealtimeEndpo /** *

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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { MachineLearningClient, CreateRealtimeEndpointCommand } from "@aws-sdk/client-machine-learning"; // ES Modules import + * // const { MachineLearningClient, CreateRealtimeEndpointCommand } = require("@aws-sdk/client-machine-learning"); // CommonJS import + * const client = new MachineLearningClient(config); + * const command = new CreateRealtimeEndpointCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreateRealtimeEndpointCommandInput} for command's `input` shape. + * @see {@link CreateRealtimeEndpointCommandOutput} for command's `response` shape. + * @see {@link MachineLearningClientResolvedConfig | config} for command's `input` shape. + * */ export class CreateRealtimeEndpointCommand extends $Command< CreateRealtimeEndpointCommandInput, diff --git a/clients/client-machine-learning/commands/DeleteBatchPredictionCommand.ts b/clients/client-machine-learning/commands/DeleteBatchPredictionCommand.ts index e324d36dcfc6..2392701665d9 100644 --- a/clients/client-machine-learning/commands/DeleteBatchPredictionCommand.ts +++ b/clients/client-machine-learning/commands/DeleteBatchPredictionCommand.ts @@ -27,6 +27,20 @@ export interface DeleteBatchPredictionCommandOutput extends DeleteBatchPredictio * *

* Caution: The result of the DeleteBatchPrediction operation is irreversible.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { MachineLearningClient, DeleteBatchPredictionCommand } from "@aws-sdk/client-machine-learning"; // ES Modules import + * // const { MachineLearningClient, DeleteBatchPredictionCommand } = require("@aws-sdk/client-machine-learning"); // CommonJS import + * const client = new MachineLearningClient(config); + * const command = new DeleteBatchPredictionCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteBatchPredictionCommandInput} for command's `input` shape. + * @see {@link DeleteBatchPredictionCommandOutput} for command's `response` shape. + * @see {@link MachineLearningClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteBatchPredictionCommand extends $Command< DeleteBatchPredictionCommandInput, diff --git a/clients/client-machine-learning/commands/DeleteDataSourceCommand.ts b/clients/client-machine-learning/commands/DeleteDataSourceCommand.ts index fd737415b44f..a65abdce3771 100644 --- a/clients/client-machine-learning/commands/DeleteDataSourceCommand.ts +++ b/clients/client-machine-learning/commands/DeleteDataSourceCommand.ts @@ -25,6 +25,20 @@ export interface DeleteDataSourceCommandOutput extends DeleteDataSourceOutput, _ *

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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { MachineLearningClient, DeleteDataSourceCommand } from "@aws-sdk/client-machine-learning"; // ES Modules import + * // const { MachineLearningClient, DeleteDataSourceCommand } = require("@aws-sdk/client-machine-learning"); // CommonJS import + * const client = new MachineLearningClient(config); + * const command = new DeleteDataSourceCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteDataSourceCommandInput} for command's `input` shape. + * @see {@link DeleteDataSourceCommandOutput} for command's `response` shape. + * @see {@link MachineLearningClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteDataSourceCommand extends $Command< DeleteDataSourceCommandInput, diff --git a/clients/client-machine-learning/commands/DeleteEvaluationCommand.ts b/clients/client-machine-learning/commands/DeleteEvaluationCommand.ts index 70c4ddded16c..8e7b48ccbebf 100644 --- a/clients/client-machine-learning/commands/DeleteEvaluationCommand.ts +++ b/clients/client-machine-learning/commands/DeleteEvaluationCommand.ts @@ -27,6 +27,20 @@ export interface DeleteEvaluationCommandOutput extends DeleteEvaluationOutput, _ * GetEvaluation operation to verify that the status of the Evaluation changed to DELETED.

*

* Caution: The results of the DeleteEvaluation operation are irreversible.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { MachineLearningClient, DeleteEvaluationCommand } from "@aws-sdk/client-machine-learning"; // ES Modules import + * // const { MachineLearningClient, DeleteEvaluationCommand } = require("@aws-sdk/client-machine-learning"); // CommonJS import + * const client = new MachineLearningClient(config); + * const command = new DeleteEvaluationCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteEvaluationCommandInput} for command's `input` shape. + * @see {@link DeleteEvaluationCommandOutput} for command's `response` shape. + * @see {@link MachineLearningClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteEvaluationCommand extends $Command< DeleteEvaluationCommandInput, diff --git a/clients/client-machine-learning/commands/DeleteMLModelCommand.ts b/clients/client-machine-learning/commands/DeleteMLModelCommand.ts index bb67d0aad120..6195578edbb1 100644 --- a/clients/client-machine-learning/commands/DeleteMLModelCommand.ts +++ b/clients/client-machine-learning/commands/DeleteMLModelCommand.ts @@ -27,6 +27,20 @@ export interface DeleteMLModelCommandOutput extends DeleteMLModelOutput, __Metad * *

* Caution: The result of the DeleteMLModel operation is irreversible.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { MachineLearningClient, DeleteMLModelCommand } from "@aws-sdk/client-machine-learning"; // ES Modules import + * // const { MachineLearningClient, DeleteMLModelCommand } = require("@aws-sdk/client-machine-learning"); // CommonJS import + * const client = new MachineLearningClient(config); + * const command = new DeleteMLModelCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteMLModelCommandInput} for command's `input` shape. + * @see {@link DeleteMLModelCommandOutput} for command's `response` shape. + * @see {@link MachineLearningClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteMLModelCommand extends $Command< DeleteMLModelCommandInput, diff --git a/clients/client-machine-learning/commands/DeleteRealtimeEndpointCommand.ts b/clients/client-machine-learning/commands/DeleteRealtimeEndpointCommand.ts index c69a6c863413..818d5e716dc1 100644 --- a/clients/client-machine-learning/commands/DeleteRealtimeEndpointCommand.ts +++ b/clients/client-machine-learning/commands/DeleteRealtimeEndpointCommand.ts @@ -22,6 +22,20 @@ export interface DeleteRealtimeEndpointCommandOutput extends DeleteRealtimeEndpo /** *

Deletes a real time endpoint of an MLModel.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { MachineLearningClient, DeleteRealtimeEndpointCommand } from "@aws-sdk/client-machine-learning"; // ES Modules import + * // const { MachineLearningClient, DeleteRealtimeEndpointCommand } = require("@aws-sdk/client-machine-learning"); // CommonJS import + * const client = new MachineLearningClient(config); + * const command = new DeleteRealtimeEndpointCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteRealtimeEndpointCommandInput} for command's `input` shape. + * @see {@link DeleteRealtimeEndpointCommandOutput} for command's `response` shape. + * @see {@link MachineLearningClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteRealtimeEndpointCommand extends $Command< DeleteRealtimeEndpointCommandInput, diff --git a/clients/client-machine-learning/commands/DeleteTagsCommand.ts b/clients/client-machine-learning/commands/DeleteTagsCommand.ts index 740a1b47c510..8515a2d9db6b 100644 --- a/clients/client-machine-learning/commands/DeleteTagsCommand.ts +++ b/clients/client-machine-learning/commands/DeleteTagsCommand.ts @@ -23,6 +23,20 @@ export interface DeleteTagsCommandOutput extends DeleteTagsOutput, __MetadataBea /** *

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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { MachineLearningClient, DeleteTagsCommand } from "@aws-sdk/client-machine-learning"; // ES Modules import + * // const { MachineLearningClient, DeleteTagsCommand } = require("@aws-sdk/client-machine-learning"); // CommonJS import + * const client = new MachineLearningClient(config); + * const command = new DeleteTagsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteTagsCommandInput} for command's `input` shape. + * @see {@link DeleteTagsCommandOutput} for command's `response` shape. + * @see {@link MachineLearningClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteTagsCommand extends $Command< DeleteTagsCommandInput, diff --git a/clients/client-machine-learning/commands/DescribeBatchPredictionsCommand.ts b/clients/client-machine-learning/commands/DescribeBatchPredictionsCommand.ts index 5376f67c99d2..c9044f6c3f1a 100644 --- a/clients/client-machine-learning/commands/DescribeBatchPredictionsCommand.ts +++ b/clients/client-machine-learning/commands/DescribeBatchPredictionsCommand.ts @@ -22,6 +22,20 @@ export interface DescribeBatchPredictionsCommandOutput extends DescribeBatchPred /** *

Returns a list of BatchPrediction operations that match the search criteria in the request.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { MachineLearningClient, DescribeBatchPredictionsCommand } from "@aws-sdk/client-machine-learning"; // ES Modules import + * // const { MachineLearningClient, DescribeBatchPredictionsCommand } = require("@aws-sdk/client-machine-learning"); // CommonJS import + * const client = new MachineLearningClient(config); + * const command = new DescribeBatchPredictionsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeBatchPredictionsCommandInput} for command's `input` shape. + * @see {@link DescribeBatchPredictionsCommandOutput} for command's `response` shape. + * @see {@link MachineLearningClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeBatchPredictionsCommand extends $Command< DescribeBatchPredictionsCommandInput, diff --git a/clients/client-machine-learning/commands/DescribeDataSourcesCommand.ts b/clients/client-machine-learning/commands/DescribeDataSourcesCommand.ts index 88767b09be85..bf062bc06a27 100644 --- a/clients/client-machine-learning/commands/DescribeDataSourcesCommand.ts +++ b/clients/client-machine-learning/commands/DescribeDataSourcesCommand.ts @@ -22,6 +22,20 @@ export interface DescribeDataSourcesCommandOutput extends DescribeDataSourcesOut /** *

Returns a list of DataSource that match the search criteria in the request.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { MachineLearningClient, DescribeDataSourcesCommand } from "@aws-sdk/client-machine-learning"; // ES Modules import + * // const { MachineLearningClient, DescribeDataSourcesCommand } = require("@aws-sdk/client-machine-learning"); // CommonJS import + * const client = new MachineLearningClient(config); + * const command = new DescribeDataSourcesCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeDataSourcesCommandInput} for command's `input` shape. + * @see {@link DescribeDataSourcesCommandOutput} for command's `response` shape. + * @see {@link MachineLearningClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeDataSourcesCommand extends $Command< DescribeDataSourcesCommandInput, diff --git a/clients/client-machine-learning/commands/DescribeEvaluationsCommand.ts b/clients/client-machine-learning/commands/DescribeEvaluationsCommand.ts index a5cd504c0302..2eab8ace4b03 100644 --- a/clients/client-machine-learning/commands/DescribeEvaluationsCommand.ts +++ b/clients/client-machine-learning/commands/DescribeEvaluationsCommand.ts @@ -22,6 +22,20 @@ export interface DescribeEvaluationsCommandOutput extends DescribeEvaluationsOut /** *

Returns a list of DescribeEvaluations that match the search criteria in the request.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { MachineLearningClient, DescribeEvaluationsCommand } from "@aws-sdk/client-machine-learning"; // ES Modules import + * // const { MachineLearningClient, DescribeEvaluationsCommand } = require("@aws-sdk/client-machine-learning"); // CommonJS import + * const client = new MachineLearningClient(config); + * const command = new DescribeEvaluationsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeEvaluationsCommandInput} for command's `input` shape. + * @see {@link DescribeEvaluationsCommandOutput} for command's `response` shape. + * @see {@link MachineLearningClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeEvaluationsCommand extends $Command< DescribeEvaluationsCommandInput, diff --git a/clients/client-machine-learning/commands/DescribeMLModelsCommand.ts b/clients/client-machine-learning/commands/DescribeMLModelsCommand.ts index 360dbd817e5c..34628dd91ff0 100644 --- a/clients/client-machine-learning/commands/DescribeMLModelsCommand.ts +++ b/clients/client-machine-learning/commands/DescribeMLModelsCommand.ts @@ -22,6 +22,20 @@ export interface DescribeMLModelsCommandOutput extends DescribeMLModelsOutput, _ /** *

Returns a list of MLModel that match the search criteria in the request.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { MachineLearningClient, DescribeMLModelsCommand } from "@aws-sdk/client-machine-learning"; // ES Modules import + * // const { MachineLearningClient, DescribeMLModelsCommand } = require("@aws-sdk/client-machine-learning"); // CommonJS import + * const client = new MachineLearningClient(config); + * const command = new DescribeMLModelsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeMLModelsCommandInput} for command's `input` shape. + * @see {@link DescribeMLModelsCommandOutput} for command's `response` shape. + * @see {@link MachineLearningClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeMLModelsCommand extends $Command< DescribeMLModelsCommandInput, diff --git a/clients/client-machine-learning/commands/DescribeTagsCommand.ts b/clients/client-machine-learning/commands/DescribeTagsCommand.ts index 78dccc728eb5..95898f5aef38 100644 --- a/clients/client-machine-learning/commands/DescribeTagsCommand.ts +++ b/clients/client-machine-learning/commands/DescribeTagsCommand.ts @@ -22,6 +22,20 @@ export interface DescribeTagsCommandOutput extends DescribeTagsOutput, __Metadat /** *

Describes one or more of the tags for your Amazon ML object.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { MachineLearningClient, DescribeTagsCommand } from "@aws-sdk/client-machine-learning"; // ES Modules import + * // const { MachineLearningClient, DescribeTagsCommand } = require("@aws-sdk/client-machine-learning"); // CommonJS import + * const client = new MachineLearningClient(config); + * const command = new DescribeTagsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeTagsCommandInput} for command's `input` shape. + * @see {@link DescribeTagsCommandOutput} for command's `response` shape. + * @see {@link MachineLearningClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeTagsCommand extends $Command< DescribeTagsCommandInput, diff --git a/clients/client-machine-learning/commands/GetBatchPredictionCommand.ts b/clients/client-machine-learning/commands/GetBatchPredictionCommand.ts index 00fcde83b6c4..4fc702ac5396 100644 --- a/clients/client-machine-learning/commands/GetBatchPredictionCommand.ts +++ b/clients/client-machine-learning/commands/GetBatchPredictionCommand.ts @@ -23,6 +23,20 @@ export interface GetBatchPredictionCommandOutput extends GetBatchPredictionOutpu /** *

Returns a BatchPrediction that includes detailed metadata, status, and data file information for a * Batch Prediction request.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { MachineLearningClient, GetBatchPredictionCommand } from "@aws-sdk/client-machine-learning"; // ES Modules import + * // const { MachineLearningClient, GetBatchPredictionCommand } = require("@aws-sdk/client-machine-learning"); // CommonJS import + * const client = new MachineLearningClient(config); + * const command = new GetBatchPredictionCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetBatchPredictionCommandInput} for command's `input` shape. + * @see {@link GetBatchPredictionCommandOutput} for command's `response` shape. + * @see {@link MachineLearningClientResolvedConfig | config} for command's `input` shape. + * */ export class GetBatchPredictionCommand extends $Command< GetBatchPredictionCommandInput, diff --git a/clients/client-machine-learning/commands/GetDataSourceCommand.ts b/clients/client-machine-learning/commands/GetDataSourceCommand.ts index f80eb4142b16..117c51ff6e29 100644 --- a/clients/client-machine-learning/commands/GetDataSourceCommand.ts +++ b/clients/client-machine-learning/commands/GetDataSourceCommand.ts @@ -25,6 +25,20 @@ export interface GetDataSourceCommandOutput extends GetDataSourceOutput, __Metad *

* 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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { MachineLearningClient, GetDataSourceCommand } from "@aws-sdk/client-machine-learning"; // ES Modules import + * // const { MachineLearningClient, GetDataSourceCommand } = require("@aws-sdk/client-machine-learning"); // CommonJS import + * const client = new MachineLearningClient(config); + * const command = new GetDataSourceCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetDataSourceCommandInput} for command's `input` shape. + * @see {@link GetDataSourceCommandOutput} for command's `response` shape. + * @see {@link MachineLearningClientResolvedConfig | config} for command's `input` shape. + * */ export class GetDataSourceCommand extends $Command< GetDataSourceCommandInput, diff --git a/clients/client-machine-learning/commands/GetEvaluationCommand.ts b/clients/client-machine-learning/commands/GetEvaluationCommand.ts index 76343c7ed136..0253ddd40b3e 100644 --- a/clients/client-machine-learning/commands/GetEvaluationCommand.ts +++ b/clients/client-machine-learning/commands/GetEvaluationCommand.ts @@ -22,6 +22,20 @@ export interface GetEvaluationCommandOutput extends GetEvaluationOutput, __Metad /** *

Returns an Evaluation that includes metadata as well as the current status of the Evaluation.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { MachineLearningClient, GetEvaluationCommand } from "@aws-sdk/client-machine-learning"; // ES Modules import + * // const { MachineLearningClient, GetEvaluationCommand } = require("@aws-sdk/client-machine-learning"); // CommonJS import + * const client = new MachineLearningClient(config); + * const command = new GetEvaluationCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetEvaluationCommandInput} for command's `input` shape. + * @see {@link GetEvaluationCommandOutput} for command's `response` shape. + * @see {@link MachineLearningClientResolvedConfig | config} for command's `input` shape. + * */ export class GetEvaluationCommand extends $Command< GetEvaluationCommandInput, diff --git a/clients/client-machine-learning/commands/GetMLModelCommand.ts b/clients/client-machine-learning/commands/GetMLModelCommand.ts index 744c6427b891..4f4595690c70 100644 --- a/clients/client-machine-learning/commands/GetMLModelCommand.ts +++ b/clients/client-machine-learning/commands/GetMLModelCommand.ts @@ -24,6 +24,20 @@ export interface GetMLModelCommandOutput extends GetMLModelOutput, __MetadataBea *

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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { MachineLearningClient, GetMLModelCommand } from "@aws-sdk/client-machine-learning"; // ES Modules import + * // const { MachineLearningClient, GetMLModelCommand } = require("@aws-sdk/client-machine-learning"); // CommonJS import + * const client = new MachineLearningClient(config); + * const command = new GetMLModelCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetMLModelCommandInput} for command's `input` shape. + * @see {@link GetMLModelCommandOutput} for command's `response` shape. + * @see {@link MachineLearningClientResolvedConfig | config} for command's `input` shape. + * */ export class GetMLModelCommand extends $Command< GetMLModelCommandInput, diff --git a/clients/client-machine-learning/commands/PredictCommand.ts b/clients/client-machine-learning/commands/PredictCommand.ts index 78240c9bd13b..bcae07dfa90e 100644 --- a/clients/client-machine-learning/commands/PredictCommand.ts +++ b/clients/client-machine-learning/commands/PredictCommand.ts @@ -23,6 +23,20 @@ export interface PredictCommandOutput extends PredictOutput, __MetadataBearer {} *

* Note: Not all response parameters will be populated. Whether a * response parameter is populated depends on the type of model requested.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { MachineLearningClient, PredictCommand } from "@aws-sdk/client-machine-learning"; // ES Modules import + * // const { MachineLearningClient, PredictCommand } = require("@aws-sdk/client-machine-learning"); // CommonJS import + * const client = new MachineLearningClient(config); + * const command = new PredictCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link PredictCommandInput} for command's `input` shape. + * @see {@link PredictCommandOutput} for command's `response` shape. + * @see {@link MachineLearningClientResolvedConfig | config} for command's `input` shape. + * */ export class PredictCommand extends $Command< PredictCommandInput, diff --git a/clients/client-machine-learning/commands/UpdateBatchPredictionCommand.ts b/clients/client-machine-learning/commands/UpdateBatchPredictionCommand.ts index ebaa2c52e8c3..eb66fb048dad 100644 --- a/clients/client-machine-learning/commands/UpdateBatchPredictionCommand.ts +++ b/clients/client-machine-learning/commands/UpdateBatchPredictionCommand.ts @@ -23,6 +23,20 @@ export interface UpdateBatchPredictionCommandOutput extends UpdateBatchPredictio /** *

Updates the BatchPredictionName of a BatchPrediction.

*

You can use the GetBatchPrediction operation to view the contents of the updated data element.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { MachineLearningClient, UpdateBatchPredictionCommand } from "@aws-sdk/client-machine-learning"; // ES Modules import + * // const { MachineLearningClient, UpdateBatchPredictionCommand } = require("@aws-sdk/client-machine-learning"); // CommonJS import + * const client = new MachineLearningClient(config); + * const command = new UpdateBatchPredictionCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link UpdateBatchPredictionCommandInput} for command's `input` shape. + * @see {@link UpdateBatchPredictionCommandOutput} for command's `response` shape. + * @see {@link MachineLearningClientResolvedConfig | config} for command's `input` shape. + * */ export class UpdateBatchPredictionCommand extends $Command< UpdateBatchPredictionCommandInput, diff --git a/clients/client-machine-learning/commands/UpdateDataSourceCommand.ts b/clients/client-machine-learning/commands/UpdateDataSourceCommand.ts index 6746ee5613d8..64e11da3a7d6 100644 --- a/clients/client-machine-learning/commands/UpdateDataSourceCommand.ts +++ b/clients/client-machine-learning/commands/UpdateDataSourceCommand.ts @@ -23,6 +23,20 @@ export interface UpdateDataSourceCommandOutput extends UpdateDataSourceOutput, _ /** *

Updates the DataSourceName of a DataSource.

*

You can use the GetDataSource operation to view the contents of the updated data element.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { MachineLearningClient, UpdateDataSourceCommand } from "@aws-sdk/client-machine-learning"; // ES Modules import + * // const { MachineLearningClient, UpdateDataSourceCommand } = require("@aws-sdk/client-machine-learning"); // CommonJS import + * const client = new MachineLearningClient(config); + * const command = new UpdateDataSourceCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link UpdateDataSourceCommandInput} for command's `input` shape. + * @see {@link UpdateDataSourceCommandOutput} for command's `response` shape. + * @see {@link MachineLearningClientResolvedConfig | config} for command's `input` shape. + * */ export class UpdateDataSourceCommand extends $Command< UpdateDataSourceCommandInput, diff --git a/clients/client-machine-learning/commands/UpdateEvaluationCommand.ts b/clients/client-machine-learning/commands/UpdateEvaluationCommand.ts index 93c04462da6a..3ef163dba1cc 100644 --- a/clients/client-machine-learning/commands/UpdateEvaluationCommand.ts +++ b/clients/client-machine-learning/commands/UpdateEvaluationCommand.ts @@ -23,6 +23,20 @@ export interface UpdateEvaluationCommandOutput extends UpdateEvaluationOutput, _ /** *

Updates the EvaluationName of an Evaluation.

*

You can use the GetEvaluation operation to view the contents of the updated data element.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { MachineLearningClient, UpdateEvaluationCommand } from "@aws-sdk/client-machine-learning"; // ES Modules import + * // const { MachineLearningClient, UpdateEvaluationCommand } = require("@aws-sdk/client-machine-learning"); // CommonJS import + * const client = new MachineLearningClient(config); + * const command = new UpdateEvaluationCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link UpdateEvaluationCommandInput} for command's `input` shape. + * @see {@link UpdateEvaluationCommandOutput} for command's `response` shape. + * @see {@link MachineLearningClientResolvedConfig | config} for command's `input` shape. + * */ export class UpdateEvaluationCommand extends $Command< UpdateEvaluationCommandInput, diff --git a/clients/client-machine-learning/commands/UpdateMLModelCommand.ts b/clients/client-machine-learning/commands/UpdateMLModelCommand.ts index f77fb21b908d..5fe8cbc61bff 100644 --- a/clients/client-machine-learning/commands/UpdateMLModelCommand.ts +++ b/clients/client-machine-learning/commands/UpdateMLModelCommand.ts @@ -23,6 +23,20 @@ export interface UpdateMLModelCommandOutput extends UpdateMLModelOutput, __Metad /** *

Updates the MLModelName and the ScoreThreshold of an MLModel.

*

You can use the GetMLModel operation to view the contents of the updated data element.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { MachineLearningClient, UpdateMLModelCommand } from "@aws-sdk/client-machine-learning"; // ES Modules import + * // const { MachineLearningClient, UpdateMLModelCommand } = require("@aws-sdk/client-machine-learning"); // CommonJS import + * const client = new MachineLearningClient(config); + * const command = new UpdateMLModelCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link UpdateMLModelCommandInput} for command's `input` shape. + * @see {@link UpdateMLModelCommandOutput} for command's `response` shape. + * @see {@link MachineLearningClientResolvedConfig | config} for command's `input` shape. + * */ export class UpdateMLModelCommand extends $Command< UpdateMLModelCommandInput, diff --git a/clients/client-machine-learning/models/models_0.ts b/clients/client-machine-learning/models/models_0.ts index 815177e953df..96b35c892b83 100644 --- a/clients/client-machine-learning/models/models_0.ts +++ b/clients/client-machine-learning/models/models_0.ts @@ -24,6 +24,9 @@ export interface Tag { } export namespace Tag { + /** + * @internal + */ export const filterSensitiveLog = (obj: Tag): any => ({ ...obj, }); @@ -47,6 +50,9 @@ export interface AddTagsInput { } export namespace AddTagsInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: AddTagsInput): any => ({ ...obj, }); @@ -68,6 +74,9 @@ export interface AddTagsOutput { } export namespace AddTagsOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: AddTagsOutput): any => ({ ...obj, }); @@ -84,6 +93,9 @@ export interface InternalServerException extends __SmithyException, $MetadataBea } export namespace InternalServerException { + /** + * @internal + */ export const filterSensitiveLog = (obj: InternalServerException): any => ({ ...obj, }); @@ -100,6 +112,9 @@ export interface InvalidInputException extends __SmithyException, $MetadataBeare } export namespace InvalidInputException { + /** + * @internal + */ export const filterSensitiveLog = (obj: InvalidInputException): any => ({ ...obj, }); @@ -112,6 +127,9 @@ export interface InvalidTagException extends __SmithyException, $MetadataBearer } export namespace InvalidTagException { + /** + * @internal + */ export const filterSensitiveLog = (obj: InvalidTagException): any => ({ ...obj, }); @@ -128,6 +146,9 @@ export interface ResourceNotFoundException extends __SmithyException, $MetadataB } export namespace ResourceNotFoundException { + /** + * @internal + */ export const filterSensitiveLog = (obj: ResourceNotFoundException): any => ({ ...obj, }); @@ -140,6 +161,9 @@ export interface TagLimitExceededException extends __SmithyException, $MetadataB } export namespace TagLimitExceededException { + /** + * @internal + */ export const filterSensitiveLog = (obj: TagLimitExceededException): any => ({ ...obj, }); @@ -179,6 +203,9 @@ export interface CreateBatchPredictionInput { } export namespace CreateBatchPredictionInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateBatchPredictionInput): any => ({ ...obj, }); @@ -199,6 +226,9 @@ export interface CreateBatchPredictionOutput { } export namespace CreateBatchPredictionOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateBatchPredictionOutput): any => ({ ...obj, }); @@ -215,6 +245,9 @@ export interface IdempotentParameterMismatchException extends __SmithyException, } export namespace IdempotentParameterMismatchException { + /** + * @internal + */ export const filterSensitiveLog = (obj: IdempotentParameterMismatchException): any => ({ ...obj, }); @@ -238,6 +271,9 @@ export interface RDSDatabaseCredentials { } export namespace RDSDatabaseCredentials { + /** + * @internal + */ export const filterSensitiveLog = (obj: RDSDatabaseCredentials): any => ({ ...obj, }); @@ -259,6 +295,9 @@ export interface RDSDatabase { } export namespace RDSDatabase { + /** + * @internal + */ export const filterSensitiveLog = (obj: RDSDatabase): any => ({ ...obj, }); @@ -428,6 +467,9 @@ export interface RDSDataSpec { } export namespace RDSDataSpec { + /** + * @internal + */ export const filterSensitiveLog = (obj: RDSDataSpec): any => ({ ...obj, }); @@ -514,6 +556,9 @@ export interface CreateDataSourceFromRDSInput { } export namespace CreateDataSourceFromRDSInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateDataSourceFromRDSInput): any => ({ ...obj, }); @@ -537,6 +582,9 @@ export interface CreateDataSourceFromRDSOutput { } export namespace CreateDataSourceFromRDSOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateDataSourceFromRDSOutput): any => ({ ...obj, }); @@ -560,6 +608,9 @@ export interface RedshiftDatabaseCredentials { } export namespace RedshiftDatabaseCredentials { + /** + * @internal + */ export const filterSensitiveLog = (obj: RedshiftDatabaseCredentials): any => ({ ...obj, }); @@ -581,6 +632,9 @@ export interface RedshiftDatabase { } export namespace RedshiftDatabase { + /** + * @internal + */ export const filterSensitiveLog = (obj: RedshiftDatabase): any => ({ ...obj, }); @@ -729,6 +783,9 @@ export interface RedshiftDataSpec { } export namespace RedshiftDataSpec { + /** + * @internal + */ export const filterSensitiveLog = (obj: RedshiftDataSpec): any => ({ ...obj, }); @@ -814,6 +871,9 @@ export interface CreateDataSourceFromRedshiftInput { } export namespace CreateDataSourceFromRedshiftInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateDataSourceFromRedshiftInput): any => ({ ...obj, }); @@ -834,6 +894,9 @@ export interface CreateDataSourceFromRedshiftOutput { } export namespace CreateDataSourceFromRedshiftOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateDataSourceFromRedshiftOutput): any => ({ ...obj, }); @@ -968,6 +1031,9 @@ export interface S3DataSpec { } export namespace S3DataSpec { + /** + * @internal + */ export const filterSensitiveLog = (obj: S3DataSpec): any => ({ ...obj, }); @@ -1015,6 +1081,9 @@ export interface CreateDataSourceFromS3Input { } export namespace CreateDataSourceFromS3Input { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateDataSourceFromS3Input): any => ({ ...obj, }); @@ -1035,6 +1104,9 @@ export interface CreateDataSourceFromS3Output { } export namespace CreateDataSourceFromS3Output { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateDataSourceFromS3Output): any => ({ ...obj, }); @@ -1065,6 +1137,9 @@ export interface CreateEvaluationInput { } export namespace CreateEvaluationInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateEvaluationInput): any => ({ ...obj, }); @@ -1087,6 +1162,9 @@ export interface CreateEvaluationOutput { } export namespace CreateEvaluationOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateEvaluationOutput): any => ({ ...obj, }); @@ -1193,6 +1271,9 @@ export interface CreateMLModelInput { } export namespace CreateMLModelInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateMLModelInput): any => ({ ...obj, }); @@ -1214,6 +1295,9 @@ export interface CreateMLModelOutput { } export namespace CreateMLModelOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateMLModelOutput): any => ({ ...obj, }); @@ -1227,6 +1311,9 @@ export interface CreateRealtimeEndpointInput { } export namespace CreateRealtimeEndpointInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateRealtimeEndpointInput): any => ({ ...obj, }); @@ -1281,6 +1368,9 @@ export interface RealtimeEndpointInfo { } export namespace RealtimeEndpointInfo { + /** + * @internal + */ export const filterSensitiveLog = (obj: RealtimeEndpointInfo): any => ({ ...obj, }); @@ -1307,6 +1397,9 @@ export interface CreateRealtimeEndpointOutput { } export namespace CreateRealtimeEndpointOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateRealtimeEndpointOutput): any => ({ ...obj, }); @@ -1320,6 +1413,9 @@ export interface DeleteBatchPredictionInput { } export namespace DeleteBatchPredictionInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteBatchPredictionInput): any => ({ ...obj, }); @@ -1338,6 +1434,9 @@ export interface DeleteBatchPredictionOutput { } export namespace DeleteBatchPredictionOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteBatchPredictionOutput): any => ({ ...obj, }); @@ -1351,6 +1450,9 @@ export interface DeleteDataSourceInput { } export namespace DeleteDataSourceInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteDataSourceInput): any => ({ ...obj, }); @@ -1367,6 +1469,9 @@ export interface DeleteDataSourceOutput { } export namespace DeleteDataSourceOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteDataSourceOutput): any => ({ ...obj, }); @@ -1380,6 +1485,9 @@ export interface DeleteEvaluationInput { } export namespace DeleteEvaluationInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteEvaluationInput): any => ({ ...obj, }); @@ -1398,6 +1506,9 @@ export interface DeleteEvaluationOutput { } export namespace DeleteEvaluationOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteEvaluationOutput): any => ({ ...obj, }); @@ -1411,6 +1522,9 @@ export interface DeleteMLModelInput { } export namespace DeleteMLModelInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteMLModelInput): any => ({ ...obj, }); @@ -1429,6 +1543,9 @@ export interface DeleteMLModelOutput { } export namespace DeleteMLModelOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteMLModelOutput): any => ({ ...obj, }); @@ -1442,6 +1559,9 @@ export interface DeleteRealtimeEndpointInput { } export namespace DeleteRealtimeEndpointInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteRealtimeEndpointInput): any => ({ ...obj, }); @@ -1466,6 +1586,9 @@ export interface DeleteRealtimeEndpointOutput { } export namespace DeleteRealtimeEndpointOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteRealtimeEndpointOutput): any => ({ ...obj, }); @@ -1489,6 +1612,9 @@ export interface DeleteTagsInput { } export namespace DeleteTagsInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteTagsInput): any => ({ ...obj, }); @@ -1510,6 +1636,9 @@ export interface DeleteTagsOutput { } export namespace DeleteTagsOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteTagsOutput): any => ({ ...obj, }); @@ -1653,6 +1782,9 @@ export interface DescribeBatchPredictionsInput { } export namespace DescribeBatchPredictionsInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeBatchPredictionsInput): any => ({ ...obj, }); @@ -1778,6 +1910,9 @@ export interface BatchPrediction { } export namespace BatchPrediction { + /** + * @internal + */ export const filterSensitiveLog = (obj: BatchPrediction): any => ({ ...obj, }); @@ -1800,6 +1935,9 @@ export interface DescribeBatchPredictionsOutput { } export namespace DescribeBatchPredictionsOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeBatchPredictionsOutput): any => ({ ...obj, }); @@ -1927,6 +2065,9 @@ export interface DescribeDataSourcesInput { } export namespace DescribeDataSourcesInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeDataSourcesInput): any => ({ ...obj, }); @@ -1969,6 +2110,9 @@ export interface RDSMetadata { } export namespace RDSMetadata { + /** + * @internal + */ export const filterSensitiveLog = (obj: RDSMetadata): any => ({ ...obj, }); @@ -1996,6 +2140,9 @@ export interface RedshiftMetadata { } export namespace RedshiftMetadata { + /** + * @internal + */ export const filterSensitiveLog = (obj: RedshiftMetadata): any => ({ ...obj, }); @@ -2119,6 +2266,9 @@ export interface DataSource { } export namespace DataSource { + /** + * @internal + */ export const filterSensitiveLog = (obj: DataSource): any => ({ ...obj, }); @@ -2141,6 +2291,9 @@ export interface DescribeDataSourcesOutput { } export namespace DescribeDataSourcesOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeDataSourcesOutput): any => ({ ...obj, }); @@ -2279,6 +2432,9 @@ export interface DescribeEvaluationsInput { } export namespace DescribeEvaluationsInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeEvaluationsInput): any => ({ ...obj, }); @@ -2307,6 +2463,9 @@ export interface PerformanceMetrics { } export namespace PerformanceMetrics { + /** + * @internal + */ export const filterSensitiveLog = (obj: PerformanceMetrics): any => ({ ...obj, }); @@ -2428,6 +2587,9 @@ export interface Evaluation { } export namespace Evaluation { + /** + * @internal + */ export const filterSensitiveLog = (obj: Evaluation): any => ({ ...obj, }); @@ -2450,6 +2612,9 @@ export interface DescribeEvaluationsOutput { } export namespace DescribeEvaluationsOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeEvaluationsOutput): any => ({ ...obj, }); @@ -2598,6 +2763,9 @@ export interface DescribeMLModelsInput { } export namespace DescribeMLModelsInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeMLModelsInput): any => ({ ...obj, }); @@ -2792,6 +2960,9 @@ export interface MLModel { } export namespace MLModel { + /** + * @internal + */ export const filterSensitiveLog = (obj: MLModel): any => ({ ...obj, }); @@ -2813,6 +2984,9 @@ export interface DescribeMLModelsOutput { } export namespace DescribeMLModelsOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeMLModelsOutput): any => ({ ...obj, }); @@ -2831,6 +3005,9 @@ export interface DescribeTagsInput { } export namespace DescribeTagsInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeTagsInput): any => ({ ...obj, }); @@ -2857,6 +3034,9 @@ export interface DescribeTagsOutput { } export namespace DescribeTagsOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeTagsOutput): any => ({ ...obj, }); @@ -2870,6 +3050,9 @@ export interface GetBatchPredictionInput { } export namespace GetBatchPredictionInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetBatchPredictionInput): any => ({ ...obj, }); @@ -2990,6 +3173,9 @@ export interface GetBatchPredictionOutput { } export namespace GetBatchPredictionOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetBatchPredictionOutput): any => ({ ...obj, }); @@ -3010,6 +3196,9 @@ export interface GetDataSourceInput { } export namespace GetDataSourceInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetDataSourceInput): any => ({ ...obj, }); @@ -3148,6 +3337,9 @@ export interface GetDataSourceOutput { } export namespace GetDataSourceOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetDataSourceOutput): any => ({ ...obj, }); @@ -3161,6 +3353,9 @@ export interface GetEvaluationInput { } export namespace GetEvaluationInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetEvaluationInput): any => ({ ...obj, }); @@ -3284,6 +3479,9 @@ export interface GetEvaluationOutput { } export namespace GetEvaluationOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetEvaluationOutput): any => ({ ...obj, }); @@ -3304,6 +3502,9 @@ export interface GetMLModelInput { } export namespace GetMLModelInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetMLModelInput): any => ({ ...obj, }); @@ -3512,6 +3713,9 @@ export interface GetMLModelOutput { } export namespace GetMLModelOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetMLModelOutput): any => ({ ...obj, }); @@ -3528,6 +3732,9 @@ export interface LimitExceededException extends __SmithyException, $MetadataBear } export namespace LimitExceededException { + /** + * @internal + */ export const filterSensitiveLog = (obj: LimitExceededException): any => ({ ...obj, }); @@ -3548,6 +3755,9 @@ export interface PredictInput { } export namespace PredictInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: PredictInput): any => ({ ...obj, }); @@ -3563,6 +3773,9 @@ export interface PredictorNotMountedException extends __SmithyException, $Metada } export namespace PredictorNotMountedException { + /** + * @internal + */ export const filterSensitiveLog = (obj: PredictorNotMountedException): any => ({ ...obj, }); @@ -3628,6 +3841,9 @@ export interface Prediction { } export namespace Prediction { + /** + * @internal + */ export const filterSensitiveLog = (obj: Prediction): any => ({ ...obj, }); @@ -3668,6 +3884,9 @@ export interface PredictOutput { } export namespace PredictOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: PredictOutput): any => ({ ...obj, }); @@ -3686,6 +3905,9 @@ export interface UpdateBatchPredictionInput { } export namespace UpdateBatchPredictionInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateBatchPredictionInput): any => ({ ...obj, }); @@ -3704,6 +3926,9 @@ export interface UpdateBatchPredictionOutput { } export namespace UpdateBatchPredictionOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateBatchPredictionOutput): any => ({ ...obj, }); @@ -3722,6 +3947,9 @@ export interface UpdateDataSourceInput { } export namespace UpdateDataSourceInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateDataSourceInput): any => ({ ...obj, }); @@ -3740,6 +3968,9 @@ export interface UpdateDataSourceOutput { } export namespace UpdateDataSourceOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateDataSourceOutput): any => ({ ...obj, }); @@ -3758,6 +3989,9 @@ export interface UpdateEvaluationInput { } export namespace UpdateEvaluationInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateEvaluationInput): any => ({ ...obj, }); @@ -3776,6 +4010,9 @@ export interface UpdateEvaluationOutput { } export namespace UpdateEvaluationOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateEvaluationOutput): any => ({ ...obj, }); @@ -3800,6 +4037,9 @@ export interface UpdateMLModelInput { } export namespace UpdateMLModelInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateMLModelInput): any => ({ ...obj, }); @@ -3818,6 +4058,9 @@ export interface UpdateMLModelOutput { } export namespace UpdateMLModelOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateMLModelOutput): any => ({ ...obj, }); diff --git a/clients/client-macie/commands/AssociateMemberAccountCommand.ts b/clients/client-macie/commands/AssociateMemberAccountCommand.ts index fdc7936f7cbe..f687b1dec976 100644 --- a/clients/client-macie/commands/AssociateMemberAccountCommand.ts +++ b/clients/client-macie/commands/AssociateMemberAccountCommand.ts @@ -23,6 +23,20 @@ export interface AssociateMemberAccountCommandOutput extends __MetadataBearer {} /** *

Associates a specified AWS account with Amazon Macie Classic as a member * account.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { MacieClient, AssociateMemberAccountCommand } from "@aws-sdk/client-macie"; // ES Modules import + * // const { MacieClient, AssociateMemberAccountCommand } = require("@aws-sdk/client-macie"); // CommonJS import + * const client = new MacieClient(config); + * const command = new AssociateMemberAccountCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link AssociateMemberAccountCommandInput} for command's `input` shape. + * @see {@link AssociateMemberAccountCommandOutput} for command's `response` shape. + * @see {@link MacieClientResolvedConfig | config} for command's `input` shape. + * */ export class AssociateMemberAccountCommand extends $Command< AssociateMemberAccountCommandInput, diff --git a/clients/client-macie/commands/AssociateS3ResourcesCommand.ts b/clients/client-macie/commands/AssociateS3ResourcesCommand.ts index 6aa333d0de6d..0932ac97b170 100644 --- a/clients/client-macie/commands/AssociateS3ResourcesCommand.ts +++ b/clients/client-macie/commands/AssociateS3ResourcesCommand.ts @@ -26,6 +26,20 @@ export interface AssociateS3ResourcesCommandOutput extends AssociateS3ResourcesR * 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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { MacieClient, AssociateS3ResourcesCommand } from "@aws-sdk/client-macie"; // ES Modules import + * // const { MacieClient, AssociateS3ResourcesCommand } = require("@aws-sdk/client-macie"); // CommonJS import + * const client = new MacieClient(config); + * const command = new AssociateS3ResourcesCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link AssociateS3ResourcesCommandInput} for command's `input` shape. + * @see {@link AssociateS3ResourcesCommandOutput} for command's `response` shape. + * @see {@link MacieClientResolvedConfig | config} for command's `input` shape. + * */ export class AssociateS3ResourcesCommand extends $Command< AssociateS3ResourcesCommandInput, diff --git a/clients/client-macie/commands/DisassociateMemberAccountCommand.ts b/clients/client-macie/commands/DisassociateMemberAccountCommand.ts index e769d791d627..658a73f95837 100644 --- a/clients/client-macie/commands/DisassociateMemberAccountCommand.ts +++ b/clients/client-macie/commands/DisassociateMemberAccountCommand.ts @@ -22,6 +22,20 @@ export interface DisassociateMemberAccountCommandOutput extends __MetadataBearer /** *

Removes the specified member account from Amazon Macie Classic.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { MacieClient, DisassociateMemberAccountCommand } from "@aws-sdk/client-macie"; // ES Modules import + * // const { MacieClient, DisassociateMemberAccountCommand } = require("@aws-sdk/client-macie"); // CommonJS import + * const client = new MacieClient(config); + * const command = new DisassociateMemberAccountCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DisassociateMemberAccountCommandInput} for command's `input` shape. + * @see {@link DisassociateMemberAccountCommandOutput} for command's `response` shape. + * @see {@link MacieClientResolvedConfig | config} for command's `input` shape. + * */ export class DisassociateMemberAccountCommand extends $Command< DisassociateMemberAccountCommandInput, diff --git a/clients/client-macie/commands/DisassociateS3ResourcesCommand.ts b/clients/client-macie/commands/DisassociateS3ResourcesCommand.ts index e88b4675711c..4c5d10985ade 100644 --- a/clients/client-macie/commands/DisassociateS3ResourcesCommand.ts +++ b/clients/client-macie/commands/DisassociateS3ResourcesCommand.ts @@ -25,6 +25,20 @@ export interface DisassociateS3ResourcesCommandOutput extends DisassociateS3Reso * 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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { MacieClient, DisassociateS3ResourcesCommand } from "@aws-sdk/client-macie"; // ES Modules import + * // const { MacieClient, DisassociateS3ResourcesCommand } = require("@aws-sdk/client-macie"); // CommonJS import + * const client = new MacieClient(config); + * const command = new DisassociateS3ResourcesCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DisassociateS3ResourcesCommandInput} for command's `input` shape. + * @see {@link DisassociateS3ResourcesCommandOutput} for command's `response` shape. + * @see {@link MacieClientResolvedConfig | config} for command's `input` shape. + * */ export class DisassociateS3ResourcesCommand extends $Command< DisassociateS3ResourcesCommandInput, diff --git a/clients/client-macie/commands/ListMemberAccountsCommand.ts b/clients/client-macie/commands/ListMemberAccountsCommand.ts index 323cabfa2cd9..937963eb9b8b 100644 --- a/clients/client-macie/commands/ListMemberAccountsCommand.ts +++ b/clients/client-macie/commands/ListMemberAccountsCommand.ts @@ -22,6 +22,20 @@ export interface ListMemberAccountsCommandOutput extends ListMemberAccountsResul /** *

Lists all Amazon Macie Classic member accounts for the current Macie Classic administrator account.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { MacieClient, ListMemberAccountsCommand } from "@aws-sdk/client-macie"; // ES Modules import + * // const { MacieClient, ListMemberAccountsCommand } = require("@aws-sdk/client-macie"); // CommonJS import + * const client = new MacieClient(config); + * const command = new ListMemberAccountsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListMemberAccountsCommandInput} for command's `input` shape. + * @see {@link ListMemberAccountsCommandOutput} for command's `response` shape. + * @see {@link MacieClientResolvedConfig | config} for command's `input` shape. + * */ export class ListMemberAccountsCommand extends $Command< ListMemberAccountsCommandInput, diff --git a/clients/client-macie/commands/ListS3ResourcesCommand.ts b/clients/client-macie/commands/ListS3ResourcesCommand.ts index 0b144beaf727..c16da6a21116 100644 --- a/clients/client-macie/commands/ListS3ResourcesCommand.ts +++ b/clients/client-macie/commands/ListS3ResourcesCommand.ts @@ -25,6 +25,20 @@ export interface ListS3ResourcesCommandOutput extends ListS3ResourcesResult, __M * 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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { MacieClient, ListS3ResourcesCommand } from "@aws-sdk/client-macie"; // ES Modules import + * // const { MacieClient, ListS3ResourcesCommand } = require("@aws-sdk/client-macie"); // CommonJS import + * const client = new MacieClient(config); + * const command = new ListS3ResourcesCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListS3ResourcesCommandInput} for command's `input` shape. + * @see {@link ListS3ResourcesCommandOutput} for command's `response` shape. + * @see {@link MacieClientResolvedConfig | config} for command's `input` shape. + * */ export class ListS3ResourcesCommand extends $Command< ListS3ResourcesCommandInput, diff --git a/clients/client-macie/commands/UpdateS3ResourcesCommand.ts b/clients/client-macie/commands/UpdateS3ResourcesCommand.ts index bad8bf8b8fd4..a2b4d5dd8831 100644 --- a/clients/client-macie/commands/UpdateS3ResourcesCommand.ts +++ b/clients/client-macie/commands/UpdateS3ResourcesCommand.ts @@ -26,6 +26,20 @@ export interface UpdateS3ResourcesCommandOutput extends UpdateS3ResourcesResult, * 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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { MacieClient, UpdateS3ResourcesCommand } from "@aws-sdk/client-macie"; // ES Modules import + * // const { MacieClient, UpdateS3ResourcesCommand } = require("@aws-sdk/client-macie"); // CommonJS import + * const client = new MacieClient(config); + * const command = new UpdateS3ResourcesCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link UpdateS3ResourcesCommandInput} for command's `input` shape. + * @see {@link UpdateS3ResourcesCommandOutput} for command's `response` shape. + * @see {@link MacieClientResolvedConfig | config} for command's `input` shape. + * */ export class UpdateS3ResourcesCommand extends $Command< UpdateS3ResourcesCommandInput, diff --git a/clients/client-macie/models/models_0.ts b/clients/client-macie/models/models_0.ts index fe9f5cd69c98..70a0df7bd228 100644 --- a/clients/client-macie/models/models_0.ts +++ b/clients/client-macie/models/models_0.ts @@ -15,6 +15,9 @@ export interface AccessDeniedException extends __SmithyException, $MetadataBeare } export namespace AccessDeniedException { + /** + * @internal + */ export const filterSensitiveLog = (obj: AccessDeniedException): any => ({ ...obj, }); @@ -29,6 +32,9 @@ export interface AssociateMemberAccountRequest { } export namespace AssociateMemberAccountRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: AssociateMemberAccountRequest): any => ({ ...obj, }); @@ -49,6 +55,9 @@ export interface InternalException extends __SmithyException, $MetadataBearer { } export namespace InternalException { + /** + * @internal + */ export const filterSensitiveLog = (obj: InternalException): any => ({ ...obj, }); @@ -74,6 +83,9 @@ export interface InvalidInputException extends __SmithyException, $MetadataBeare } export namespace InvalidInputException { + /** + * @internal + */ export const filterSensitiveLog = (obj: InvalidInputException): any => ({ ...obj, }); @@ -99,6 +111,9 @@ export interface LimitExceededException extends __SmithyException, $MetadataBear } export namespace LimitExceededException { + /** + * @internal + */ export const filterSensitiveLog = (obj: LimitExceededException): any => ({ ...obj, }); @@ -133,6 +148,9 @@ export interface ClassificationType { } export namespace ClassificationType { + /** + * @internal + */ export const filterSensitiveLog = (obj: ClassificationType): any => ({ ...obj, }); @@ -164,6 +182,9 @@ export interface S3ResourceClassification { } export namespace S3ResourceClassification { + /** + * @internal + */ export const filterSensitiveLog = (obj: S3ResourceClassification): any => ({ ...obj, }); @@ -184,6 +205,9 @@ export interface AssociateS3ResourcesRequest { } export namespace AssociateS3ResourcesRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: AssociateS3ResourcesRequest): any => ({ ...obj, }); @@ -207,6 +231,9 @@ export interface S3Resource { } export namespace S3Resource { + /** + * @internal + */ export const filterSensitiveLog = (obj: S3Resource): any => ({ ...obj, }); @@ -233,6 +260,9 @@ export interface FailedS3Resource { } export namespace FailedS3Resource { + /** + * @internal + */ export const filterSensitiveLog = (obj: FailedS3Resource): any => ({ ...obj, }); @@ -247,6 +277,9 @@ export interface AssociateS3ResourcesResult { } export namespace AssociateS3ResourcesResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: AssociateS3ResourcesResult): any => ({ ...obj, }); @@ -273,6 +306,9 @@ export interface ClassificationTypeUpdate { } export namespace ClassificationTypeUpdate { + /** + * @internal + */ export const filterSensitiveLog = (obj: ClassificationTypeUpdate): any => ({ ...obj, }); @@ -287,6 +323,9 @@ export interface DisassociateMemberAccountRequest { } export namespace DisassociateMemberAccountRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DisassociateMemberAccountRequest): any => ({ ...obj, }); @@ -307,6 +346,9 @@ export interface DisassociateS3ResourcesRequest { } export namespace DisassociateS3ResourcesRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DisassociateS3ResourcesRequest): any => ({ ...obj, }); @@ -322,6 +364,9 @@ export interface DisassociateS3ResourcesResult { } export namespace DisassociateS3ResourcesResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: DisassociateS3ResourcesResult): any => ({ ...obj, }); @@ -344,6 +389,9 @@ export interface ListMemberAccountsRequest { } export namespace ListMemberAccountsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListMemberAccountsRequest): any => ({ ...obj, }); @@ -360,6 +408,9 @@ export interface MemberAccount { } export namespace MemberAccount { + /** + * @internal + */ export const filterSensitiveLog = (obj: MemberAccount): any => ({ ...obj, }); @@ -382,6 +433,9 @@ export interface ListMemberAccountsResult { } export namespace ListMemberAccountsResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListMemberAccountsResult): any => ({ ...obj, }); @@ -409,6 +463,9 @@ export interface ListS3ResourcesRequest { } export namespace ListS3ResourcesRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListS3ResourcesRequest): any => ({ ...obj, }); @@ -430,6 +487,9 @@ export interface ListS3ResourcesResult { } export namespace ListS3ResourcesResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListS3ResourcesResult): any => ({ ...obj, }); @@ -458,6 +518,9 @@ export interface S3ResourceClassificationUpdate { } export namespace S3ResourceClassificationUpdate { + /** + * @internal + */ export const filterSensitiveLog = (obj: S3ResourceClassificationUpdate): any => ({ ...obj, }); @@ -477,6 +540,9 @@ export interface UpdateS3ResourcesRequest { } export namespace UpdateS3ResourcesRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateS3ResourcesRequest): any => ({ ...obj, }); @@ -491,6 +557,9 @@ export interface UpdateS3ResourcesResult { } export namespace UpdateS3ResourcesResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateS3ResourcesResult): any => ({ ...obj, }); diff --git a/clients/client-macie2/commands/AcceptInvitationCommand.ts b/clients/client-macie2/commands/AcceptInvitationCommand.ts index f91766d9b3c2..6dde4337ac97 100644 --- a/clients/client-macie2/commands/AcceptInvitationCommand.ts +++ b/clients/client-macie2/commands/AcceptInvitationCommand.ts @@ -22,6 +22,20 @@ export interface AcceptInvitationCommandOutput extends AcceptInvitationResponse, /** *

Accepts an Amazon Macie membership invitation that was received from a specific account.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { Macie2Client, AcceptInvitationCommand } from "@aws-sdk/client-macie2"; // ES Modules import + * // const { Macie2Client, AcceptInvitationCommand } = require("@aws-sdk/client-macie2"); // CommonJS import + * const client = new Macie2Client(config); + * const command = new AcceptInvitationCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link AcceptInvitationCommandInput} for command's `input` shape. + * @see {@link AcceptInvitationCommandOutput} for command's `response` shape. + * @see {@link Macie2ClientResolvedConfig | config} for command's `input` shape. + * */ export class AcceptInvitationCommand extends $Command< AcceptInvitationCommandInput, diff --git a/clients/client-macie2/commands/BatchGetCustomDataIdentifiersCommand.ts b/clients/client-macie2/commands/BatchGetCustomDataIdentifiersCommand.ts index b75157c2e83e..fa53f4c7d1ac 100644 --- a/clients/client-macie2/commands/BatchGetCustomDataIdentifiersCommand.ts +++ b/clients/client-macie2/commands/BatchGetCustomDataIdentifiersCommand.ts @@ -24,6 +24,20 @@ export interface BatchGetCustomDataIdentifiersCommandOutput /** *

Retrieves information about one or more custom data identifiers.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { Macie2Client, BatchGetCustomDataIdentifiersCommand } from "@aws-sdk/client-macie2"; // ES Modules import + * // const { Macie2Client, BatchGetCustomDataIdentifiersCommand } = require("@aws-sdk/client-macie2"); // CommonJS import + * const client = new Macie2Client(config); + * const command = new BatchGetCustomDataIdentifiersCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link BatchGetCustomDataIdentifiersCommandInput} for command's `input` shape. + * @see {@link BatchGetCustomDataIdentifiersCommandOutput} for command's `response` shape. + * @see {@link Macie2ClientResolvedConfig | config} for command's `input` shape. + * */ export class BatchGetCustomDataIdentifiersCommand extends $Command< BatchGetCustomDataIdentifiersCommandInput, diff --git a/clients/client-macie2/commands/CreateClassificationJobCommand.ts b/clients/client-macie2/commands/CreateClassificationJobCommand.ts index 160b820fe0e1..dfcfe0379e4a 100644 --- a/clients/client-macie2/commands/CreateClassificationJobCommand.ts +++ b/clients/client-macie2/commands/CreateClassificationJobCommand.ts @@ -22,6 +22,20 @@ export interface CreateClassificationJobCommandOutput extends CreateClassificati /** *

Creates and defines the settings for a classification job.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { Macie2Client, CreateClassificationJobCommand } from "@aws-sdk/client-macie2"; // ES Modules import + * // const { Macie2Client, CreateClassificationJobCommand } = require("@aws-sdk/client-macie2"); // CommonJS import + * const client = new Macie2Client(config); + * const command = new CreateClassificationJobCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreateClassificationJobCommandInput} for command's `input` shape. + * @see {@link CreateClassificationJobCommandOutput} for command's `response` shape. + * @see {@link Macie2ClientResolvedConfig | config} for command's `input` shape. + * */ export class CreateClassificationJobCommand extends $Command< CreateClassificationJobCommandInput, diff --git a/clients/client-macie2/commands/CreateCustomDataIdentifierCommand.ts b/clients/client-macie2/commands/CreateCustomDataIdentifierCommand.ts index f5a06069c7ab..8c9eb2bfe776 100644 --- a/clients/client-macie2/commands/CreateCustomDataIdentifierCommand.ts +++ b/clients/client-macie2/commands/CreateCustomDataIdentifierCommand.ts @@ -22,6 +22,20 @@ export interface CreateCustomDataIdentifierCommandOutput extends CreateCustomDat /** *

Creates and defines the criteria and other settings for a custom data identifier.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { Macie2Client, CreateCustomDataIdentifierCommand } from "@aws-sdk/client-macie2"; // ES Modules import + * // const { Macie2Client, CreateCustomDataIdentifierCommand } = require("@aws-sdk/client-macie2"); // CommonJS import + * const client = new Macie2Client(config); + * const command = new CreateCustomDataIdentifierCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreateCustomDataIdentifierCommandInput} for command's `input` shape. + * @see {@link CreateCustomDataIdentifierCommandOutput} for command's `response` shape. + * @see {@link Macie2ClientResolvedConfig | config} for command's `input` shape. + * */ export class CreateCustomDataIdentifierCommand extends $Command< CreateCustomDataIdentifierCommandInput, diff --git a/clients/client-macie2/commands/CreateFindingsFilterCommand.ts b/clients/client-macie2/commands/CreateFindingsFilterCommand.ts index a10fcc81b0e2..10f1d181c601 100644 --- a/clients/client-macie2/commands/CreateFindingsFilterCommand.ts +++ b/clients/client-macie2/commands/CreateFindingsFilterCommand.ts @@ -22,6 +22,20 @@ export interface CreateFindingsFilterCommandOutput extends CreateFindingsFilterR /** *

Creates and defines the criteria and other settings for a findings filter.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { Macie2Client, CreateFindingsFilterCommand } from "@aws-sdk/client-macie2"; // ES Modules import + * // const { Macie2Client, CreateFindingsFilterCommand } = require("@aws-sdk/client-macie2"); // CommonJS import + * const client = new Macie2Client(config); + * const command = new CreateFindingsFilterCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreateFindingsFilterCommandInput} for command's `input` shape. + * @see {@link CreateFindingsFilterCommandOutput} for command's `response` shape. + * @see {@link Macie2ClientResolvedConfig | config} for command's `input` shape. + * */ export class CreateFindingsFilterCommand extends $Command< CreateFindingsFilterCommandInput, diff --git a/clients/client-macie2/commands/CreateInvitationsCommand.ts b/clients/client-macie2/commands/CreateInvitationsCommand.ts index f6b05ee74164..fb28ac1e3d0d 100644 --- a/clients/client-macie2/commands/CreateInvitationsCommand.ts +++ b/clients/client-macie2/commands/CreateInvitationsCommand.ts @@ -22,6 +22,20 @@ export interface CreateInvitationsCommandOutput extends CreateInvitationsRespons /** *

Sends an Amazon Macie membership invitation to one or more accounts.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { Macie2Client, CreateInvitationsCommand } from "@aws-sdk/client-macie2"; // ES Modules import + * // const { Macie2Client, CreateInvitationsCommand } = require("@aws-sdk/client-macie2"); // CommonJS import + * const client = new Macie2Client(config); + * const command = new CreateInvitationsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreateInvitationsCommandInput} for command's `input` shape. + * @see {@link CreateInvitationsCommandOutput} for command's `response` shape. + * @see {@link Macie2ClientResolvedConfig | config} for command's `input` shape. + * */ export class CreateInvitationsCommand extends $Command< CreateInvitationsCommandInput, diff --git a/clients/client-macie2/commands/CreateMemberCommand.ts b/clients/client-macie2/commands/CreateMemberCommand.ts index 6f4f304ce78c..b9eb481e9dbc 100644 --- a/clients/client-macie2/commands/CreateMemberCommand.ts +++ b/clients/client-macie2/commands/CreateMemberCommand.ts @@ -22,6 +22,20 @@ export interface CreateMemberCommandOutput extends CreateMemberResponse, __Metad /** *

Associates an account with an Amazon Macie administrator account.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { Macie2Client, CreateMemberCommand } from "@aws-sdk/client-macie2"; // ES Modules import + * // const { Macie2Client, CreateMemberCommand } = require("@aws-sdk/client-macie2"); // CommonJS import + * const client = new Macie2Client(config); + * const command = new CreateMemberCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreateMemberCommandInput} for command's `input` shape. + * @see {@link CreateMemberCommandOutput} for command's `response` shape. + * @see {@link Macie2ClientResolvedConfig | config} for command's `input` shape. + * */ export class CreateMemberCommand extends $Command< CreateMemberCommandInput, diff --git a/clients/client-macie2/commands/CreateSampleFindingsCommand.ts b/clients/client-macie2/commands/CreateSampleFindingsCommand.ts index de29e3b49763..87aa112f1d5f 100644 --- a/clients/client-macie2/commands/CreateSampleFindingsCommand.ts +++ b/clients/client-macie2/commands/CreateSampleFindingsCommand.ts @@ -22,6 +22,20 @@ export interface CreateSampleFindingsCommandOutput extends CreateSampleFindingsR /** *

Creates sample findings.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { Macie2Client, CreateSampleFindingsCommand } from "@aws-sdk/client-macie2"; // ES Modules import + * // const { Macie2Client, CreateSampleFindingsCommand } = require("@aws-sdk/client-macie2"); // CommonJS import + * const client = new Macie2Client(config); + * const command = new CreateSampleFindingsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreateSampleFindingsCommandInput} for command's `input` shape. + * @see {@link CreateSampleFindingsCommandOutput} for command's `response` shape. + * @see {@link Macie2ClientResolvedConfig | config} for command's `input` shape. + * */ export class CreateSampleFindingsCommand extends $Command< CreateSampleFindingsCommandInput, diff --git a/clients/client-macie2/commands/DeclineInvitationsCommand.ts b/clients/client-macie2/commands/DeclineInvitationsCommand.ts index 74cb358b8a55..ff8a5356b8c1 100644 --- a/clients/client-macie2/commands/DeclineInvitationsCommand.ts +++ b/clients/client-macie2/commands/DeclineInvitationsCommand.ts @@ -22,6 +22,20 @@ export interface DeclineInvitationsCommandOutput extends DeclineInvitationsRespo /** *

Declines Amazon Macie membership invitations that were received from specific accounts.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { Macie2Client, DeclineInvitationsCommand } from "@aws-sdk/client-macie2"; // ES Modules import + * // const { Macie2Client, DeclineInvitationsCommand } = require("@aws-sdk/client-macie2"); // CommonJS import + * const client = new Macie2Client(config); + * const command = new DeclineInvitationsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeclineInvitationsCommandInput} for command's `input` shape. + * @see {@link DeclineInvitationsCommandOutput} for command's `response` shape. + * @see {@link Macie2ClientResolvedConfig | config} for command's `input` shape. + * */ export class DeclineInvitationsCommand extends $Command< DeclineInvitationsCommandInput, diff --git a/clients/client-macie2/commands/DeleteCustomDataIdentifierCommand.ts b/clients/client-macie2/commands/DeleteCustomDataIdentifierCommand.ts index 6eab6aeb9bf0..ec67258c9836 100644 --- a/clients/client-macie2/commands/DeleteCustomDataIdentifierCommand.ts +++ b/clients/client-macie2/commands/DeleteCustomDataIdentifierCommand.ts @@ -22,6 +22,20 @@ export interface DeleteCustomDataIdentifierCommandOutput extends DeleteCustomDat /** *

Soft deletes a custom data identifier.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { Macie2Client, DeleteCustomDataIdentifierCommand } from "@aws-sdk/client-macie2"; // ES Modules import + * // const { Macie2Client, DeleteCustomDataIdentifierCommand } = require("@aws-sdk/client-macie2"); // CommonJS import + * const client = new Macie2Client(config); + * const command = new DeleteCustomDataIdentifierCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteCustomDataIdentifierCommandInput} for command's `input` shape. + * @see {@link DeleteCustomDataIdentifierCommandOutput} for command's `response` shape. + * @see {@link Macie2ClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteCustomDataIdentifierCommand extends $Command< DeleteCustomDataIdentifierCommandInput, diff --git a/clients/client-macie2/commands/DeleteFindingsFilterCommand.ts b/clients/client-macie2/commands/DeleteFindingsFilterCommand.ts index fc9737b23c77..8e8e4f93518f 100644 --- a/clients/client-macie2/commands/DeleteFindingsFilterCommand.ts +++ b/clients/client-macie2/commands/DeleteFindingsFilterCommand.ts @@ -22,6 +22,20 @@ export interface DeleteFindingsFilterCommandOutput extends DeleteFindingsFilterR /** *

Deletes a findings filter.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { Macie2Client, DeleteFindingsFilterCommand } from "@aws-sdk/client-macie2"; // ES Modules import + * // const { Macie2Client, DeleteFindingsFilterCommand } = require("@aws-sdk/client-macie2"); // CommonJS import + * const client = new Macie2Client(config); + * const command = new DeleteFindingsFilterCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteFindingsFilterCommandInput} for command's `input` shape. + * @see {@link DeleteFindingsFilterCommandOutput} for command's `response` shape. + * @see {@link Macie2ClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteFindingsFilterCommand extends $Command< DeleteFindingsFilterCommandInput, diff --git a/clients/client-macie2/commands/DeleteInvitationsCommand.ts b/clients/client-macie2/commands/DeleteInvitationsCommand.ts index deebf0f72a66..fca01781afdf 100644 --- a/clients/client-macie2/commands/DeleteInvitationsCommand.ts +++ b/clients/client-macie2/commands/DeleteInvitationsCommand.ts @@ -22,6 +22,20 @@ export interface DeleteInvitationsCommandOutput extends DeleteInvitationsRespons /** *

Deletes Amazon Macie membership invitations that were received from specific accounts.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { Macie2Client, DeleteInvitationsCommand } from "@aws-sdk/client-macie2"; // ES Modules import + * // const { Macie2Client, DeleteInvitationsCommand } = require("@aws-sdk/client-macie2"); // CommonJS import + * const client = new Macie2Client(config); + * const command = new DeleteInvitationsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteInvitationsCommandInput} for command's `input` shape. + * @see {@link DeleteInvitationsCommandOutput} for command's `response` shape. + * @see {@link Macie2ClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteInvitationsCommand extends $Command< DeleteInvitationsCommandInput, diff --git a/clients/client-macie2/commands/DeleteMemberCommand.ts b/clients/client-macie2/commands/DeleteMemberCommand.ts index 65de7c0522e7..f9472d3e695f 100644 --- a/clients/client-macie2/commands/DeleteMemberCommand.ts +++ b/clients/client-macie2/commands/DeleteMemberCommand.ts @@ -22,6 +22,20 @@ export interface DeleteMemberCommandOutput extends DeleteMemberResponse, __Metad /** *

Deletes the association between an Amazon Macie administrator account and an account.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { Macie2Client, DeleteMemberCommand } from "@aws-sdk/client-macie2"; // ES Modules import + * // const { Macie2Client, DeleteMemberCommand } = require("@aws-sdk/client-macie2"); // CommonJS import + * const client = new Macie2Client(config); + * const command = new DeleteMemberCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteMemberCommandInput} for command's `input` shape. + * @see {@link DeleteMemberCommandOutput} for command's `response` shape. + * @see {@link Macie2ClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteMemberCommand extends $Command< DeleteMemberCommandInput, diff --git a/clients/client-macie2/commands/DescribeBucketsCommand.ts b/clients/client-macie2/commands/DescribeBucketsCommand.ts index 966694e770ac..1ce343de335a 100644 --- a/clients/client-macie2/commands/DescribeBucketsCommand.ts +++ b/clients/client-macie2/commands/DescribeBucketsCommand.ts @@ -22,6 +22,20 @@ export interface DescribeBucketsCommandOutput extends DescribeBucketsResponse, _ /** *

Retrieves (queries) statistical data and other information about one or more S3 buckets that Amazon Macie monitors and analyzes.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { Macie2Client, DescribeBucketsCommand } from "@aws-sdk/client-macie2"; // ES Modules import + * // const { Macie2Client, DescribeBucketsCommand } = require("@aws-sdk/client-macie2"); // CommonJS import + * const client = new Macie2Client(config); + * const command = new DescribeBucketsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeBucketsCommandInput} for command's `input` shape. + * @see {@link DescribeBucketsCommandOutput} for command's `response` shape. + * @see {@link Macie2ClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeBucketsCommand extends $Command< DescribeBucketsCommandInput, diff --git a/clients/client-macie2/commands/DescribeClassificationJobCommand.ts b/clients/client-macie2/commands/DescribeClassificationJobCommand.ts index 289eb764b160..f6527773f82c 100644 --- a/clients/client-macie2/commands/DescribeClassificationJobCommand.ts +++ b/clients/client-macie2/commands/DescribeClassificationJobCommand.ts @@ -22,6 +22,20 @@ export interface DescribeClassificationJobCommandOutput extends DescribeClassifi /** *

Retrieves the status and settings for a classification job.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { Macie2Client, DescribeClassificationJobCommand } from "@aws-sdk/client-macie2"; // ES Modules import + * // const { Macie2Client, DescribeClassificationJobCommand } = require("@aws-sdk/client-macie2"); // CommonJS import + * const client = new Macie2Client(config); + * const command = new DescribeClassificationJobCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeClassificationJobCommandInput} for command's `input` shape. + * @see {@link DescribeClassificationJobCommandOutput} for command's `response` shape. + * @see {@link Macie2ClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeClassificationJobCommand extends $Command< DescribeClassificationJobCommandInput, diff --git a/clients/client-macie2/commands/DescribeOrganizationConfigurationCommand.ts b/clients/client-macie2/commands/DescribeOrganizationConfigurationCommand.ts index 60e10320633c..09872066dec7 100644 --- a/clients/client-macie2/commands/DescribeOrganizationConfigurationCommand.ts +++ b/clients/client-macie2/commands/DescribeOrganizationConfigurationCommand.ts @@ -27,6 +27,20 @@ export interface DescribeOrganizationConfigurationCommandOutput /** *

Retrieves the Amazon Macie configuration settings for an AWS organization.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { Macie2Client, DescribeOrganizationConfigurationCommand } from "@aws-sdk/client-macie2"; // ES Modules import + * // const { Macie2Client, DescribeOrganizationConfigurationCommand } = require("@aws-sdk/client-macie2"); // CommonJS import + * const client = new Macie2Client(config); + * const command = new DescribeOrganizationConfigurationCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeOrganizationConfigurationCommandInput} for command's `input` shape. + * @see {@link DescribeOrganizationConfigurationCommandOutput} for command's `response` shape. + * @see {@link Macie2ClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeOrganizationConfigurationCommand extends $Command< DescribeOrganizationConfigurationCommandInput, diff --git a/clients/client-macie2/commands/DisableMacieCommand.ts b/clients/client-macie2/commands/DisableMacieCommand.ts index 7fa0bc8c1468..2d91fefbd7a7 100644 --- a/clients/client-macie2/commands/DisableMacieCommand.ts +++ b/clients/client-macie2/commands/DisableMacieCommand.ts @@ -22,6 +22,20 @@ export interface DisableMacieCommandOutput extends DisableMacieResponse, __Metad /** *

Disables an Amazon Macie account and deletes Macie resources for the account.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { Macie2Client, DisableMacieCommand } from "@aws-sdk/client-macie2"; // ES Modules import + * // const { Macie2Client, DisableMacieCommand } = require("@aws-sdk/client-macie2"); // CommonJS import + * const client = new Macie2Client(config); + * const command = new DisableMacieCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DisableMacieCommandInput} for command's `input` shape. + * @see {@link DisableMacieCommandOutput} for command's `response` shape. + * @see {@link Macie2ClientResolvedConfig | config} for command's `input` shape. + * */ export class DisableMacieCommand extends $Command< DisableMacieCommandInput, diff --git a/clients/client-macie2/commands/DisableOrganizationAdminAccountCommand.ts b/clients/client-macie2/commands/DisableOrganizationAdminAccountCommand.ts index 1da1bd1f8409..7e0b5b6b17a9 100644 --- a/clients/client-macie2/commands/DisableOrganizationAdminAccountCommand.ts +++ b/clients/client-macie2/commands/DisableOrganizationAdminAccountCommand.ts @@ -24,6 +24,20 @@ export interface DisableOrganizationAdminAccountCommandOutput /** *

Disables an account as the delegated Amazon Macie administrator account for an AWS organization.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { Macie2Client, DisableOrganizationAdminAccountCommand } from "@aws-sdk/client-macie2"; // ES Modules import + * // const { Macie2Client, DisableOrganizationAdminAccountCommand } = require("@aws-sdk/client-macie2"); // CommonJS import + * const client = new Macie2Client(config); + * const command = new DisableOrganizationAdminAccountCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DisableOrganizationAdminAccountCommandInput} for command's `input` shape. + * @see {@link DisableOrganizationAdminAccountCommandOutput} for command's `response` shape. + * @see {@link Macie2ClientResolvedConfig | config} for command's `input` shape. + * */ export class DisableOrganizationAdminAccountCommand extends $Command< DisableOrganizationAdminAccountCommandInput, diff --git a/clients/client-macie2/commands/DisassociateFromAdministratorAccountCommand.ts b/clients/client-macie2/commands/DisassociateFromAdministratorAccountCommand.ts index 6e1d858b9870..19ee72107c62 100644 --- a/clients/client-macie2/commands/DisassociateFromAdministratorAccountCommand.ts +++ b/clients/client-macie2/commands/DisassociateFromAdministratorAccountCommand.ts @@ -27,6 +27,20 @@ export interface DisassociateFromAdministratorAccountCommandOutput /** *

Disassociates a member account from its Amazon Macie administrator account.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { Macie2Client, DisassociateFromAdministratorAccountCommand } from "@aws-sdk/client-macie2"; // ES Modules import + * // const { Macie2Client, DisassociateFromAdministratorAccountCommand } = require("@aws-sdk/client-macie2"); // CommonJS import + * const client = new Macie2Client(config); + * const command = new DisassociateFromAdministratorAccountCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DisassociateFromAdministratorAccountCommandInput} for command's `input` shape. + * @see {@link DisassociateFromAdministratorAccountCommandOutput} for command's `response` shape. + * @see {@link Macie2ClientResolvedConfig | config} for command's `input` shape. + * */ export class DisassociateFromAdministratorAccountCommand extends $Command< DisassociateFromAdministratorAccountCommandInput, diff --git a/clients/client-macie2/commands/DisassociateFromMasterAccountCommand.ts b/clients/client-macie2/commands/DisassociateFromMasterAccountCommand.ts index 49e9937daaf5..b0ffea1d51a8 100644 --- a/clients/client-macie2/commands/DisassociateFromMasterAccountCommand.ts +++ b/clients/client-macie2/commands/DisassociateFromMasterAccountCommand.ts @@ -24,6 +24,20 @@ export interface DisassociateFromMasterAccountCommandOutput /** *

(Deprecated) Disassociates a member account from its Amazon Macie administrator account. This operation has been replaced by the DisassociateFromAdministratorAccount operation.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { Macie2Client, DisassociateFromMasterAccountCommand } from "@aws-sdk/client-macie2"; // ES Modules import + * // const { Macie2Client, DisassociateFromMasterAccountCommand } = require("@aws-sdk/client-macie2"); // CommonJS import + * const client = new Macie2Client(config); + * const command = new DisassociateFromMasterAccountCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DisassociateFromMasterAccountCommandInput} for command's `input` shape. + * @see {@link DisassociateFromMasterAccountCommandOutput} for command's `response` shape. + * @see {@link Macie2ClientResolvedConfig | config} for command's `input` shape. + * */ export class DisassociateFromMasterAccountCommand extends $Command< DisassociateFromMasterAccountCommandInput, diff --git a/clients/client-macie2/commands/DisassociateMemberCommand.ts b/clients/client-macie2/commands/DisassociateMemberCommand.ts index d3ab14488c33..8788d93f00ee 100644 --- a/clients/client-macie2/commands/DisassociateMemberCommand.ts +++ b/clients/client-macie2/commands/DisassociateMemberCommand.ts @@ -22,6 +22,20 @@ export interface DisassociateMemberCommandOutput extends DisassociateMemberRespo /** *

Disassociates an Amazon Macie administrator account from a member account.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { Macie2Client, DisassociateMemberCommand } from "@aws-sdk/client-macie2"; // ES Modules import + * // const { Macie2Client, DisassociateMemberCommand } = require("@aws-sdk/client-macie2"); // CommonJS import + * const client = new Macie2Client(config); + * const command = new DisassociateMemberCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DisassociateMemberCommandInput} for command's `input` shape. + * @see {@link DisassociateMemberCommandOutput} for command's `response` shape. + * @see {@link Macie2ClientResolvedConfig | config} for command's `input` shape. + * */ export class DisassociateMemberCommand extends $Command< DisassociateMemberCommandInput, diff --git a/clients/client-macie2/commands/EnableMacieCommand.ts b/clients/client-macie2/commands/EnableMacieCommand.ts index cccc73d3a916..3137992e2470 100644 --- a/clients/client-macie2/commands/EnableMacieCommand.ts +++ b/clients/client-macie2/commands/EnableMacieCommand.ts @@ -22,6 +22,20 @@ export interface EnableMacieCommandOutput extends EnableMacieResponse, __Metadat /** *

Enables Amazon Macie and specifies the configuration settings for a Macie account.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { Macie2Client, EnableMacieCommand } from "@aws-sdk/client-macie2"; // ES Modules import + * // const { Macie2Client, EnableMacieCommand } = require("@aws-sdk/client-macie2"); // CommonJS import + * const client = new Macie2Client(config); + * const command = new EnableMacieCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link EnableMacieCommandInput} for command's `input` shape. + * @see {@link EnableMacieCommandOutput} for command's `response` shape. + * @see {@link Macie2ClientResolvedConfig | config} for command's `input` shape. + * */ export class EnableMacieCommand extends $Command< EnableMacieCommandInput, diff --git a/clients/client-macie2/commands/EnableOrganizationAdminAccountCommand.ts b/clients/client-macie2/commands/EnableOrganizationAdminAccountCommand.ts index c9983cdc5f72..526c70df6a49 100644 --- a/clients/client-macie2/commands/EnableOrganizationAdminAccountCommand.ts +++ b/clients/client-macie2/commands/EnableOrganizationAdminAccountCommand.ts @@ -24,6 +24,20 @@ export interface EnableOrganizationAdminAccountCommandOutput /** *

Designates an account as the delegated Amazon Macie administrator account for an AWS organization.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { Macie2Client, EnableOrganizationAdminAccountCommand } from "@aws-sdk/client-macie2"; // ES Modules import + * // const { Macie2Client, EnableOrganizationAdminAccountCommand } = require("@aws-sdk/client-macie2"); // CommonJS import + * const client = new Macie2Client(config); + * const command = new EnableOrganizationAdminAccountCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link EnableOrganizationAdminAccountCommandInput} for command's `input` shape. + * @see {@link EnableOrganizationAdminAccountCommandOutput} for command's `response` shape. + * @see {@link Macie2ClientResolvedConfig | config} for command's `input` shape. + * */ export class EnableOrganizationAdminAccountCommand extends $Command< EnableOrganizationAdminAccountCommandInput, diff --git a/clients/client-macie2/commands/GetAdministratorAccountCommand.ts b/clients/client-macie2/commands/GetAdministratorAccountCommand.ts index 337fb8090b8f..199caae9f76c 100644 --- a/clients/client-macie2/commands/GetAdministratorAccountCommand.ts +++ b/clients/client-macie2/commands/GetAdministratorAccountCommand.ts @@ -22,6 +22,20 @@ export interface GetAdministratorAccountCommandOutput extends GetAdministratorAc /** *

Retrieves information about the Amazon Macie administrator account for an account.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { Macie2Client, GetAdministratorAccountCommand } from "@aws-sdk/client-macie2"; // ES Modules import + * // const { Macie2Client, GetAdministratorAccountCommand } = require("@aws-sdk/client-macie2"); // CommonJS import + * const client = new Macie2Client(config); + * const command = new GetAdministratorAccountCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetAdministratorAccountCommandInput} for command's `input` shape. + * @see {@link GetAdministratorAccountCommandOutput} for command's `response` shape. + * @see {@link Macie2ClientResolvedConfig | config} for command's `input` shape. + * */ export class GetAdministratorAccountCommand extends $Command< GetAdministratorAccountCommandInput, diff --git a/clients/client-macie2/commands/GetBucketStatisticsCommand.ts b/clients/client-macie2/commands/GetBucketStatisticsCommand.ts index 07aae3fafbfd..bb02dd55a9d6 100644 --- a/clients/client-macie2/commands/GetBucketStatisticsCommand.ts +++ b/clients/client-macie2/commands/GetBucketStatisticsCommand.ts @@ -22,6 +22,20 @@ export interface GetBucketStatisticsCommandOutput extends GetBucketStatisticsRes /** *

Retrieves (queries) aggregated statistical data for all the S3 buckets that Amazon Macie monitors and analyzes.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { Macie2Client, GetBucketStatisticsCommand } from "@aws-sdk/client-macie2"; // ES Modules import + * // const { Macie2Client, GetBucketStatisticsCommand } = require("@aws-sdk/client-macie2"); // CommonJS import + * const client = new Macie2Client(config); + * const command = new GetBucketStatisticsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetBucketStatisticsCommandInput} for command's `input` shape. + * @see {@link GetBucketStatisticsCommandOutput} for command's `response` shape. + * @see {@link Macie2ClientResolvedConfig | config} for command's `input` shape. + * */ export class GetBucketStatisticsCommand extends $Command< GetBucketStatisticsCommandInput, diff --git a/clients/client-macie2/commands/GetClassificationExportConfigurationCommand.ts b/clients/client-macie2/commands/GetClassificationExportConfigurationCommand.ts index befdd0d6f37b..52333250c944 100644 --- a/clients/client-macie2/commands/GetClassificationExportConfigurationCommand.ts +++ b/clients/client-macie2/commands/GetClassificationExportConfigurationCommand.ts @@ -27,6 +27,20 @@ export interface GetClassificationExportConfigurationCommandOutput /** *

Retrieves the configuration settings for storing data classification results.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { Macie2Client, GetClassificationExportConfigurationCommand } from "@aws-sdk/client-macie2"; // ES Modules import + * // const { Macie2Client, GetClassificationExportConfigurationCommand } = require("@aws-sdk/client-macie2"); // CommonJS import + * const client = new Macie2Client(config); + * const command = new GetClassificationExportConfigurationCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetClassificationExportConfigurationCommandInput} for command's `input` shape. + * @see {@link GetClassificationExportConfigurationCommandOutput} for command's `response` shape. + * @see {@link Macie2ClientResolvedConfig | config} for command's `input` shape. + * */ export class GetClassificationExportConfigurationCommand extends $Command< GetClassificationExportConfigurationCommandInput, diff --git a/clients/client-macie2/commands/GetCustomDataIdentifierCommand.ts b/clients/client-macie2/commands/GetCustomDataIdentifierCommand.ts index 97293124c38c..2a5253929b32 100644 --- a/clients/client-macie2/commands/GetCustomDataIdentifierCommand.ts +++ b/clients/client-macie2/commands/GetCustomDataIdentifierCommand.ts @@ -22,6 +22,20 @@ export interface GetCustomDataIdentifierCommandOutput extends GetCustomDataIdent /** *

Retrieves the criteria and other settings for a custom data identifier.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { Macie2Client, GetCustomDataIdentifierCommand } from "@aws-sdk/client-macie2"; // ES Modules import + * // const { Macie2Client, GetCustomDataIdentifierCommand } = require("@aws-sdk/client-macie2"); // CommonJS import + * const client = new Macie2Client(config); + * const command = new GetCustomDataIdentifierCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetCustomDataIdentifierCommandInput} for command's `input` shape. + * @see {@link GetCustomDataIdentifierCommandOutput} for command's `response` shape. + * @see {@link Macie2ClientResolvedConfig | config} for command's `input` shape. + * */ export class GetCustomDataIdentifierCommand extends $Command< GetCustomDataIdentifierCommandInput, diff --git a/clients/client-macie2/commands/GetFindingStatisticsCommand.ts b/clients/client-macie2/commands/GetFindingStatisticsCommand.ts index d93668913164..9155ac14f1e3 100644 --- a/clients/client-macie2/commands/GetFindingStatisticsCommand.ts +++ b/clients/client-macie2/commands/GetFindingStatisticsCommand.ts @@ -22,6 +22,20 @@ export interface GetFindingStatisticsCommandOutput extends GetFindingStatisticsR /** *

Retrieves (queries) aggregated statistical data about findings.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { Macie2Client, GetFindingStatisticsCommand } from "@aws-sdk/client-macie2"; // ES Modules import + * // const { Macie2Client, GetFindingStatisticsCommand } = require("@aws-sdk/client-macie2"); // CommonJS import + * const client = new Macie2Client(config); + * const command = new GetFindingStatisticsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetFindingStatisticsCommandInput} for command's `input` shape. + * @see {@link GetFindingStatisticsCommandOutput} for command's `response` shape. + * @see {@link Macie2ClientResolvedConfig | config} for command's `input` shape. + * */ export class GetFindingStatisticsCommand extends $Command< GetFindingStatisticsCommandInput, diff --git a/clients/client-macie2/commands/GetFindingsCommand.ts b/clients/client-macie2/commands/GetFindingsCommand.ts index 74bb0657cb35..28839e5c4cd5 100644 --- a/clients/client-macie2/commands/GetFindingsCommand.ts +++ b/clients/client-macie2/commands/GetFindingsCommand.ts @@ -22,6 +22,20 @@ export interface GetFindingsCommandOutput extends GetFindingsResponse, __Metadat /** *

Retrieves the details of one or more findings.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { Macie2Client, GetFindingsCommand } from "@aws-sdk/client-macie2"; // ES Modules import + * // const { Macie2Client, GetFindingsCommand } = require("@aws-sdk/client-macie2"); // CommonJS import + * const client = new Macie2Client(config); + * const command = new GetFindingsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetFindingsCommandInput} for command's `input` shape. + * @see {@link GetFindingsCommandOutput} for command's `response` shape. + * @see {@link Macie2ClientResolvedConfig | config} for command's `input` shape. + * */ export class GetFindingsCommand extends $Command< GetFindingsCommandInput, diff --git a/clients/client-macie2/commands/GetFindingsFilterCommand.ts b/clients/client-macie2/commands/GetFindingsFilterCommand.ts index 6f690178da0b..0ee9585bc2d1 100644 --- a/clients/client-macie2/commands/GetFindingsFilterCommand.ts +++ b/clients/client-macie2/commands/GetFindingsFilterCommand.ts @@ -22,6 +22,20 @@ export interface GetFindingsFilterCommandOutput extends GetFindingsFilterRespons /** *

Retrieves the criteria and other settings for a findings filter.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { Macie2Client, GetFindingsFilterCommand } from "@aws-sdk/client-macie2"; // ES Modules import + * // const { Macie2Client, GetFindingsFilterCommand } = require("@aws-sdk/client-macie2"); // CommonJS import + * const client = new Macie2Client(config); + * const command = new GetFindingsFilterCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetFindingsFilterCommandInput} for command's `input` shape. + * @see {@link GetFindingsFilterCommandOutput} for command's `response` shape. + * @see {@link Macie2ClientResolvedConfig | config} for command's `input` shape. + * */ export class GetFindingsFilterCommand extends $Command< GetFindingsFilterCommandInput, diff --git a/clients/client-macie2/commands/GetFindingsPublicationConfigurationCommand.ts b/clients/client-macie2/commands/GetFindingsPublicationConfigurationCommand.ts index 3de41a1ee02b..01d1b9ece1b1 100644 --- a/clients/client-macie2/commands/GetFindingsPublicationConfigurationCommand.ts +++ b/clients/client-macie2/commands/GetFindingsPublicationConfigurationCommand.ts @@ -27,6 +27,20 @@ export interface GetFindingsPublicationConfigurationCommandOutput /** *

Retrieves the configuration settings for publishing findings to AWS Security Hub.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { Macie2Client, GetFindingsPublicationConfigurationCommand } from "@aws-sdk/client-macie2"; // ES Modules import + * // const { Macie2Client, GetFindingsPublicationConfigurationCommand } = require("@aws-sdk/client-macie2"); // CommonJS import + * const client = new Macie2Client(config); + * const command = new GetFindingsPublicationConfigurationCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetFindingsPublicationConfigurationCommandInput} for command's `input` shape. + * @see {@link GetFindingsPublicationConfigurationCommandOutput} for command's `response` shape. + * @see {@link Macie2ClientResolvedConfig | config} for command's `input` shape. + * */ export class GetFindingsPublicationConfigurationCommand extends $Command< GetFindingsPublicationConfigurationCommandInput, diff --git a/clients/client-macie2/commands/GetInvitationsCountCommand.ts b/clients/client-macie2/commands/GetInvitationsCountCommand.ts index 54e52a05e708..866e23fdac89 100644 --- a/clients/client-macie2/commands/GetInvitationsCountCommand.ts +++ b/clients/client-macie2/commands/GetInvitationsCountCommand.ts @@ -22,6 +22,20 @@ export interface GetInvitationsCountCommandOutput extends GetInvitationsCountRes /** *

Retrieves the count of Amazon Macie membership invitations that were received by an account.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { Macie2Client, GetInvitationsCountCommand } from "@aws-sdk/client-macie2"; // ES Modules import + * // const { Macie2Client, GetInvitationsCountCommand } = require("@aws-sdk/client-macie2"); // CommonJS import + * const client = new Macie2Client(config); + * const command = new GetInvitationsCountCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetInvitationsCountCommandInput} for command's `input` shape. + * @see {@link GetInvitationsCountCommandOutput} for command's `response` shape. + * @see {@link Macie2ClientResolvedConfig | config} for command's `input` shape. + * */ export class GetInvitationsCountCommand extends $Command< GetInvitationsCountCommandInput, diff --git a/clients/client-macie2/commands/GetMacieSessionCommand.ts b/clients/client-macie2/commands/GetMacieSessionCommand.ts index bf260bc99745..d219ab8cb53c 100644 --- a/clients/client-macie2/commands/GetMacieSessionCommand.ts +++ b/clients/client-macie2/commands/GetMacieSessionCommand.ts @@ -22,6 +22,20 @@ export interface GetMacieSessionCommandOutput extends GetMacieSessionResponse, _ /** *

Retrieves the current status and configuration settings for an Amazon Macie account.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { Macie2Client, GetMacieSessionCommand } from "@aws-sdk/client-macie2"; // ES Modules import + * // const { Macie2Client, GetMacieSessionCommand } = require("@aws-sdk/client-macie2"); // CommonJS import + * const client = new Macie2Client(config); + * const command = new GetMacieSessionCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetMacieSessionCommandInput} for command's `input` shape. + * @see {@link GetMacieSessionCommandOutput} for command's `response` shape. + * @see {@link Macie2ClientResolvedConfig | config} for command's `input` shape. + * */ export class GetMacieSessionCommand extends $Command< GetMacieSessionCommandInput, diff --git a/clients/client-macie2/commands/GetMasterAccountCommand.ts b/clients/client-macie2/commands/GetMasterAccountCommand.ts index d94d8e0e9b98..2ae3fbeffdb9 100644 --- a/clients/client-macie2/commands/GetMasterAccountCommand.ts +++ b/clients/client-macie2/commands/GetMasterAccountCommand.ts @@ -22,6 +22,20 @@ export interface GetMasterAccountCommandOutput extends GetMasterAccountResponse, /** *

(Deprecated) Retrieves information about the Amazon Macie administrator account for an account. This operation has been replaced by the GetAdministratorAccount operation.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { Macie2Client, GetMasterAccountCommand } from "@aws-sdk/client-macie2"; // ES Modules import + * // const { Macie2Client, GetMasterAccountCommand } = require("@aws-sdk/client-macie2"); // CommonJS import + * const client = new Macie2Client(config); + * const command = new GetMasterAccountCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetMasterAccountCommandInput} for command's `input` shape. + * @see {@link GetMasterAccountCommandOutput} for command's `response` shape. + * @see {@link Macie2ClientResolvedConfig | config} for command's `input` shape. + * */ export class GetMasterAccountCommand extends $Command< GetMasterAccountCommandInput, diff --git a/clients/client-macie2/commands/GetMemberCommand.ts b/clients/client-macie2/commands/GetMemberCommand.ts index 572a653d491c..f03b9cdf0c6c 100644 --- a/clients/client-macie2/commands/GetMemberCommand.ts +++ b/clients/client-macie2/commands/GetMemberCommand.ts @@ -22,6 +22,20 @@ export interface GetMemberCommandOutput extends GetMemberResponse, __MetadataBea /** *

Retrieves information about an account that's associated with an Amazon Macie administrator account.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { Macie2Client, GetMemberCommand } from "@aws-sdk/client-macie2"; // ES Modules import + * // const { Macie2Client, GetMemberCommand } = require("@aws-sdk/client-macie2"); // CommonJS import + * const client = new Macie2Client(config); + * const command = new GetMemberCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetMemberCommandInput} for command's `input` shape. + * @see {@link GetMemberCommandOutput} for command's `response` shape. + * @see {@link Macie2ClientResolvedConfig | config} for command's `input` shape. + * */ export class GetMemberCommand extends $Command< GetMemberCommandInput, diff --git a/clients/client-macie2/commands/GetUsageStatisticsCommand.ts b/clients/client-macie2/commands/GetUsageStatisticsCommand.ts index 4c8337509e4f..ed8a1dbaee0e 100644 --- a/clients/client-macie2/commands/GetUsageStatisticsCommand.ts +++ b/clients/client-macie2/commands/GetUsageStatisticsCommand.ts @@ -22,6 +22,20 @@ export interface GetUsageStatisticsCommandOutput extends GetUsageStatisticsRespo /** *

Retrieves (queries) quotas and aggregated usage data for one or more accounts.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { Macie2Client, GetUsageStatisticsCommand } from "@aws-sdk/client-macie2"; // ES Modules import + * // const { Macie2Client, GetUsageStatisticsCommand } = require("@aws-sdk/client-macie2"); // CommonJS import + * const client = new Macie2Client(config); + * const command = new GetUsageStatisticsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetUsageStatisticsCommandInput} for command's `input` shape. + * @see {@link GetUsageStatisticsCommandOutput} for command's `response` shape. + * @see {@link Macie2ClientResolvedConfig | config} for command's `input` shape. + * */ export class GetUsageStatisticsCommand extends $Command< GetUsageStatisticsCommandInput, diff --git a/clients/client-macie2/commands/GetUsageTotalsCommand.ts b/clients/client-macie2/commands/GetUsageTotalsCommand.ts index a5d3155dbca5..4bb411e4601b 100644 --- a/clients/client-macie2/commands/GetUsageTotalsCommand.ts +++ b/clients/client-macie2/commands/GetUsageTotalsCommand.ts @@ -22,6 +22,20 @@ export interface GetUsageTotalsCommandOutput extends GetUsageTotalsResponse, __M /** *

Retrieves (queries) aggregated usage data for an account.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { Macie2Client, GetUsageTotalsCommand } from "@aws-sdk/client-macie2"; // ES Modules import + * // const { Macie2Client, GetUsageTotalsCommand } = require("@aws-sdk/client-macie2"); // CommonJS import + * const client = new Macie2Client(config); + * const command = new GetUsageTotalsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetUsageTotalsCommandInput} for command's `input` shape. + * @see {@link GetUsageTotalsCommandOutput} for command's `response` shape. + * @see {@link Macie2ClientResolvedConfig | config} for command's `input` shape. + * */ export class GetUsageTotalsCommand extends $Command< GetUsageTotalsCommandInput, diff --git a/clients/client-macie2/commands/ListClassificationJobsCommand.ts b/clients/client-macie2/commands/ListClassificationJobsCommand.ts index 655ad7ba7754..d1dcc6376353 100644 --- a/clients/client-macie2/commands/ListClassificationJobsCommand.ts +++ b/clients/client-macie2/commands/ListClassificationJobsCommand.ts @@ -22,6 +22,20 @@ export interface ListClassificationJobsCommandOutput extends ListClassificationJ /** *

Retrieves a subset of information about one or more classification jobs.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { Macie2Client, ListClassificationJobsCommand } from "@aws-sdk/client-macie2"; // ES Modules import + * // const { Macie2Client, ListClassificationJobsCommand } = require("@aws-sdk/client-macie2"); // CommonJS import + * const client = new Macie2Client(config); + * const command = new ListClassificationJobsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListClassificationJobsCommandInput} for command's `input` shape. + * @see {@link ListClassificationJobsCommandOutput} for command's `response` shape. + * @see {@link Macie2ClientResolvedConfig | config} for command's `input` shape. + * */ export class ListClassificationJobsCommand extends $Command< ListClassificationJobsCommandInput, diff --git a/clients/client-macie2/commands/ListCustomDataIdentifiersCommand.ts b/clients/client-macie2/commands/ListCustomDataIdentifiersCommand.ts index b34b04312b5a..f924580cb7d5 100644 --- a/clients/client-macie2/commands/ListCustomDataIdentifiersCommand.ts +++ b/clients/client-macie2/commands/ListCustomDataIdentifiersCommand.ts @@ -22,6 +22,20 @@ export interface ListCustomDataIdentifiersCommandOutput extends ListCustomDataId /** *

Retrieves a subset of information about all the custom data identifiers for an account.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { Macie2Client, ListCustomDataIdentifiersCommand } from "@aws-sdk/client-macie2"; // ES Modules import + * // const { Macie2Client, ListCustomDataIdentifiersCommand } = require("@aws-sdk/client-macie2"); // CommonJS import + * const client = new Macie2Client(config); + * const command = new ListCustomDataIdentifiersCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListCustomDataIdentifiersCommandInput} for command's `input` shape. + * @see {@link ListCustomDataIdentifiersCommandOutput} for command's `response` shape. + * @see {@link Macie2ClientResolvedConfig | config} for command's `input` shape. + * */ export class ListCustomDataIdentifiersCommand extends $Command< ListCustomDataIdentifiersCommandInput, diff --git a/clients/client-macie2/commands/ListFindingsCommand.ts b/clients/client-macie2/commands/ListFindingsCommand.ts index db85073e1e48..7a71bce34975 100644 --- a/clients/client-macie2/commands/ListFindingsCommand.ts +++ b/clients/client-macie2/commands/ListFindingsCommand.ts @@ -22,6 +22,20 @@ export interface ListFindingsCommandOutput extends ListFindingsResponse, __Metad /** *

Retrieves a subset of information about one or more findings.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { Macie2Client, ListFindingsCommand } from "@aws-sdk/client-macie2"; // ES Modules import + * // const { Macie2Client, ListFindingsCommand } = require("@aws-sdk/client-macie2"); // CommonJS import + * const client = new Macie2Client(config); + * const command = new ListFindingsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListFindingsCommandInput} for command's `input` shape. + * @see {@link ListFindingsCommandOutput} for command's `response` shape. + * @see {@link Macie2ClientResolvedConfig | config} for command's `input` shape. + * */ export class ListFindingsCommand extends $Command< ListFindingsCommandInput, diff --git a/clients/client-macie2/commands/ListFindingsFiltersCommand.ts b/clients/client-macie2/commands/ListFindingsFiltersCommand.ts index cd8fd402b807..6f635f84e169 100644 --- a/clients/client-macie2/commands/ListFindingsFiltersCommand.ts +++ b/clients/client-macie2/commands/ListFindingsFiltersCommand.ts @@ -22,6 +22,20 @@ export interface ListFindingsFiltersCommandOutput extends ListFindingsFiltersRes /** *

Retrieves a subset of information about all the findings filters for an account.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { Macie2Client, ListFindingsFiltersCommand } from "@aws-sdk/client-macie2"; // ES Modules import + * // const { Macie2Client, ListFindingsFiltersCommand } = require("@aws-sdk/client-macie2"); // CommonJS import + * const client = new Macie2Client(config); + * const command = new ListFindingsFiltersCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListFindingsFiltersCommandInput} for command's `input` shape. + * @see {@link ListFindingsFiltersCommandOutput} for command's `response` shape. + * @see {@link Macie2ClientResolvedConfig | config} for command's `input` shape. + * */ export class ListFindingsFiltersCommand extends $Command< ListFindingsFiltersCommandInput, diff --git a/clients/client-macie2/commands/ListInvitationsCommand.ts b/clients/client-macie2/commands/ListInvitationsCommand.ts index 10b75fb3b0f3..89b800f816c3 100644 --- a/clients/client-macie2/commands/ListInvitationsCommand.ts +++ b/clients/client-macie2/commands/ListInvitationsCommand.ts @@ -22,6 +22,20 @@ export interface ListInvitationsCommandOutput extends ListInvitationsResponse, _ /** *

Retrieves information about all the Amazon Macie membership invitations that were received by an account.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { Macie2Client, ListInvitationsCommand } from "@aws-sdk/client-macie2"; // ES Modules import + * // const { Macie2Client, ListInvitationsCommand } = require("@aws-sdk/client-macie2"); // CommonJS import + * const client = new Macie2Client(config); + * const command = new ListInvitationsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListInvitationsCommandInput} for command's `input` shape. + * @see {@link ListInvitationsCommandOutput} for command's `response` shape. + * @see {@link Macie2ClientResolvedConfig | config} for command's `input` shape. + * */ export class ListInvitationsCommand extends $Command< ListInvitationsCommandInput, diff --git a/clients/client-macie2/commands/ListMembersCommand.ts b/clients/client-macie2/commands/ListMembersCommand.ts index b00044f656c7..47be9d5c1e75 100644 --- a/clients/client-macie2/commands/ListMembersCommand.ts +++ b/clients/client-macie2/commands/ListMembersCommand.ts @@ -22,6 +22,20 @@ export interface ListMembersCommandOutput extends ListMembersResponse, __Metadat /** *

Retrieves information about the accounts that are associated with an Amazon Macie administrator account.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { Macie2Client, ListMembersCommand } from "@aws-sdk/client-macie2"; // ES Modules import + * // const { Macie2Client, ListMembersCommand } = require("@aws-sdk/client-macie2"); // CommonJS import + * const client = new Macie2Client(config); + * const command = new ListMembersCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListMembersCommandInput} for command's `input` shape. + * @see {@link ListMembersCommandOutput} for command's `response` shape. + * @see {@link Macie2ClientResolvedConfig | config} for command's `input` shape. + * */ export class ListMembersCommand extends $Command< ListMembersCommandInput, diff --git a/clients/client-macie2/commands/ListOrganizationAdminAccountsCommand.ts b/clients/client-macie2/commands/ListOrganizationAdminAccountsCommand.ts index 4cc2d81b5845..a577d76a19b8 100644 --- a/clients/client-macie2/commands/ListOrganizationAdminAccountsCommand.ts +++ b/clients/client-macie2/commands/ListOrganizationAdminAccountsCommand.ts @@ -24,6 +24,20 @@ export interface ListOrganizationAdminAccountsCommandOutput /** *

Retrieves information about the delegated Amazon Macie administrator account for an AWS organization.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { Macie2Client, ListOrganizationAdminAccountsCommand } from "@aws-sdk/client-macie2"; // ES Modules import + * // const { Macie2Client, ListOrganizationAdminAccountsCommand } = require("@aws-sdk/client-macie2"); // CommonJS import + * const client = new Macie2Client(config); + * const command = new ListOrganizationAdminAccountsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListOrganizationAdminAccountsCommandInput} for command's `input` shape. + * @see {@link ListOrganizationAdminAccountsCommandOutput} for command's `response` shape. + * @see {@link Macie2ClientResolvedConfig | config} for command's `input` shape. + * */ export class ListOrganizationAdminAccountsCommand extends $Command< ListOrganizationAdminAccountsCommandInput, diff --git a/clients/client-macie2/commands/ListTagsForResourceCommand.ts b/clients/client-macie2/commands/ListTagsForResourceCommand.ts index 529a726d0897..dff6e84e4982 100644 --- a/clients/client-macie2/commands/ListTagsForResourceCommand.ts +++ b/clients/client-macie2/commands/ListTagsForResourceCommand.ts @@ -22,6 +22,20 @@ export interface ListTagsForResourceCommandOutput extends ListTagsForResourceRes /** *

Retrieves the tags (keys and values) that are associated with a classification job, custom data identifier, findings filter, or member account.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { Macie2Client, ListTagsForResourceCommand } from "@aws-sdk/client-macie2"; // ES Modules import + * // const { Macie2Client, ListTagsForResourceCommand } = require("@aws-sdk/client-macie2"); // CommonJS import + * const client = new Macie2Client(config); + * const command = new ListTagsForResourceCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListTagsForResourceCommandInput} for command's `input` shape. + * @see {@link ListTagsForResourceCommandOutput} for command's `response` shape. + * @see {@link Macie2ClientResolvedConfig | config} for command's `input` shape. + * */ export class ListTagsForResourceCommand extends $Command< ListTagsForResourceCommandInput, diff --git a/clients/client-macie2/commands/PutClassificationExportConfigurationCommand.ts b/clients/client-macie2/commands/PutClassificationExportConfigurationCommand.ts index d0063de39692..28a8db7c93dd 100644 --- a/clients/client-macie2/commands/PutClassificationExportConfigurationCommand.ts +++ b/clients/client-macie2/commands/PutClassificationExportConfigurationCommand.ts @@ -27,6 +27,20 @@ export interface PutClassificationExportConfigurationCommandOutput /** *

Creates or updates the configuration settings for storing data classification results.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { Macie2Client, PutClassificationExportConfigurationCommand } from "@aws-sdk/client-macie2"; // ES Modules import + * // const { Macie2Client, PutClassificationExportConfigurationCommand } = require("@aws-sdk/client-macie2"); // CommonJS import + * const client = new Macie2Client(config); + * const command = new PutClassificationExportConfigurationCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link PutClassificationExportConfigurationCommandInput} for command's `input` shape. + * @see {@link PutClassificationExportConfigurationCommandOutput} for command's `response` shape. + * @see {@link Macie2ClientResolvedConfig | config} for command's `input` shape. + * */ export class PutClassificationExportConfigurationCommand extends $Command< PutClassificationExportConfigurationCommandInput, diff --git a/clients/client-macie2/commands/PutFindingsPublicationConfigurationCommand.ts b/clients/client-macie2/commands/PutFindingsPublicationConfigurationCommand.ts index 6b501945af34..8de09098c244 100644 --- a/clients/client-macie2/commands/PutFindingsPublicationConfigurationCommand.ts +++ b/clients/client-macie2/commands/PutFindingsPublicationConfigurationCommand.ts @@ -27,6 +27,20 @@ export interface PutFindingsPublicationConfigurationCommandOutput /** *

Updates the configuration settings for publishing findings to AWS Security Hub.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { Macie2Client, PutFindingsPublicationConfigurationCommand } from "@aws-sdk/client-macie2"; // ES Modules import + * // const { Macie2Client, PutFindingsPublicationConfigurationCommand } = require("@aws-sdk/client-macie2"); // CommonJS import + * const client = new Macie2Client(config); + * const command = new PutFindingsPublicationConfigurationCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link PutFindingsPublicationConfigurationCommandInput} for command's `input` shape. + * @see {@link PutFindingsPublicationConfigurationCommandOutput} for command's `response` shape. + * @see {@link Macie2ClientResolvedConfig | config} for command's `input` shape. + * */ export class PutFindingsPublicationConfigurationCommand extends $Command< PutFindingsPublicationConfigurationCommandInput, diff --git a/clients/client-macie2/commands/TagResourceCommand.ts b/clients/client-macie2/commands/TagResourceCommand.ts index de9fade4e9af..86f41cb9eea8 100644 --- a/clients/client-macie2/commands/TagResourceCommand.ts +++ b/clients/client-macie2/commands/TagResourceCommand.ts @@ -22,6 +22,20 @@ export interface TagResourceCommandOutput extends TagResourceResponse, __Metadat /** *

Adds or updates one or more tags (keys and values) that are associated with a classification job, custom data identifier, findings filter, or member account.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { Macie2Client, TagResourceCommand } from "@aws-sdk/client-macie2"; // ES Modules import + * // const { Macie2Client, TagResourceCommand } = require("@aws-sdk/client-macie2"); // CommonJS import + * const client = new Macie2Client(config); + * const command = new TagResourceCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link TagResourceCommandInput} for command's `input` shape. + * @see {@link TagResourceCommandOutput} for command's `response` shape. + * @see {@link Macie2ClientResolvedConfig | config} for command's `input` shape. + * */ export class TagResourceCommand extends $Command< TagResourceCommandInput, diff --git a/clients/client-macie2/commands/TestCustomDataIdentifierCommand.ts b/clients/client-macie2/commands/TestCustomDataIdentifierCommand.ts index d59b9a9828a6..00e4f7e18757 100644 --- a/clients/client-macie2/commands/TestCustomDataIdentifierCommand.ts +++ b/clients/client-macie2/commands/TestCustomDataIdentifierCommand.ts @@ -22,6 +22,20 @@ export interface TestCustomDataIdentifierCommandOutput extends TestCustomDataIde /** *

Tests a custom data identifier.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { Macie2Client, TestCustomDataIdentifierCommand } from "@aws-sdk/client-macie2"; // ES Modules import + * // const { Macie2Client, TestCustomDataIdentifierCommand } = require("@aws-sdk/client-macie2"); // CommonJS import + * const client = new Macie2Client(config); + * const command = new TestCustomDataIdentifierCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link TestCustomDataIdentifierCommandInput} for command's `input` shape. + * @see {@link TestCustomDataIdentifierCommandOutput} for command's `response` shape. + * @see {@link Macie2ClientResolvedConfig | config} for command's `input` shape. + * */ export class TestCustomDataIdentifierCommand extends $Command< TestCustomDataIdentifierCommandInput, diff --git a/clients/client-macie2/commands/UntagResourceCommand.ts b/clients/client-macie2/commands/UntagResourceCommand.ts index 1c616c0d8506..0bdaa3793842 100644 --- a/clients/client-macie2/commands/UntagResourceCommand.ts +++ b/clients/client-macie2/commands/UntagResourceCommand.ts @@ -22,6 +22,20 @@ export interface UntagResourceCommandOutput extends UntagResourceResponse, __Met /** *

Removes one or more tags (keys and values) from a classification job, custom data identifier, findings filter, or member account.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { Macie2Client, UntagResourceCommand } from "@aws-sdk/client-macie2"; // ES Modules import + * // const { Macie2Client, UntagResourceCommand } = require("@aws-sdk/client-macie2"); // CommonJS import + * const client = new Macie2Client(config); + * const command = new UntagResourceCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link UntagResourceCommandInput} for command's `input` shape. + * @see {@link UntagResourceCommandOutput} for command's `response` shape. + * @see {@link Macie2ClientResolvedConfig | config} for command's `input` shape. + * */ export class UntagResourceCommand extends $Command< UntagResourceCommandInput, diff --git a/clients/client-macie2/commands/UpdateClassificationJobCommand.ts b/clients/client-macie2/commands/UpdateClassificationJobCommand.ts index 5c196c16bba3..758cb80f1d01 100644 --- a/clients/client-macie2/commands/UpdateClassificationJobCommand.ts +++ b/clients/client-macie2/commands/UpdateClassificationJobCommand.ts @@ -22,6 +22,20 @@ export interface UpdateClassificationJobCommandOutput extends UpdateClassificati /** *

Changes the status of a classification job.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { Macie2Client, UpdateClassificationJobCommand } from "@aws-sdk/client-macie2"; // ES Modules import + * // const { Macie2Client, UpdateClassificationJobCommand } = require("@aws-sdk/client-macie2"); // CommonJS import + * const client = new Macie2Client(config); + * const command = new UpdateClassificationJobCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link UpdateClassificationJobCommandInput} for command's `input` shape. + * @see {@link UpdateClassificationJobCommandOutput} for command's `response` shape. + * @see {@link Macie2ClientResolvedConfig | config} for command's `input` shape. + * */ export class UpdateClassificationJobCommand extends $Command< UpdateClassificationJobCommandInput, diff --git a/clients/client-macie2/commands/UpdateFindingsFilterCommand.ts b/clients/client-macie2/commands/UpdateFindingsFilterCommand.ts index d679f7507e4c..aa961a6da7a8 100644 --- a/clients/client-macie2/commands/UpdateFindingsFilterCommand.ts +++ b/clients/client-macie2/commands/UpdateFindingsFilterCommand.ts @@ -22,6 +22,20 @@ export interface UpdateFindingsFilterCommandOutput extends UpdateFindingsFilterR /** *

Updates the criteria and other settings for a findings filter.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { Macie2Client, UpdateFindingsFilterCommand } from "@aws-sdk/client-macie2"; // ES Modules import + * // const { Macie2Client, UpdateFindingsFilterCommand } = require("@aws-sdk/client-macie2"); // CommonJS import + * const client = new Macie2Client(config); + * const command = new UpdateFindingsFilterCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link UpdateFindingsFilterCommandInput} for command's `input` shape. + * @see {@link UpdateFindingsFilterCommandOutput} for command's `response` shape. + * @see {@link Macie2ClientResolvedConfig | config} for command's `input` shape. + * */ export class UpdateFindingsFilterCommand extends $Command< UpdateFindingsFilterCommandInput, diff --git a/clients/client-macie2/commands/UpdateMacieSessionCommand.ts b/clients/client-macie2/commands/UpdateMacieSessionCommand.ts index 2ee73b043c65..676a00de7d43 100644 --- a/clients/client-macie2/commands/UpdateMacieSessionCommand.ts +++ b/clients/client-macie2/commands/UpdateMacieSessionCommand.ts @@ -22,6 +22,20 @@ export interface UpdateMacieSessionCommandOutput extends UpdateMacieSessionRespo /** *

Suspends or re-enables an Amazon Macie account, or updates the configuration settings for a Macie account.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { Macie2Client, UpdateMacieSessionCommand } from "@aws-sdk/client-macie2"; // ES Modules import + * // const { Macie2Client, UpdateMacieSessionCommand } = require("@aws-sdk/client-macie2"); // CommonJS import + * const client = new Macie2Client(config); + * const command = new UpdateMacieSessionCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link UpdateMacieSessionCommandInput} for command's `input` shape. + * @see {@link UpdateMacieSessionCommandOutput} for command's `response` shape. + * @see {@link Macie2ClientResolvedConfig | config} for command's `input` shape. + * */ export class UpdateMacieSessionCommand extends $Command< UpdateMacieSessionCommandInput, diff --git a/clients/client-macie2/commands/UpdateMemberSessionCommand.ts b/clients/client-macie2/commands/UpdateMemberSessionCommand.ts index 8223d563ecf2..d4938c87066e 100644 --- a/clients/client-macie2/commands/UpdateMemberSessionCommand.ts +++ b/clients/client-macie2/commands/UpdateMemberSessionCommand.ts @@ -22,6 +22,20 @@ export interface UpdateMemberSessionCommandOutput extends UpdateMemberSessionRes /** *

Enables an Amazon Macie administrator to suspend or re-enable a member account.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { Macie2Client, UpdateMemberSessionCommand } from "@aws-sdk/client-macie2"; // ES Modules import + * // const { Macie2Client, UpdateMemberSessionCommand } = require("@aws-sdk/client-macie2"); // CommonJS import + * const client = new Macie2Client(config); + * const command = new UpdateMemberSessionCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link UpdateMemberSessionCommandInput} for command's `input` shape. + * @see {@link UpdateMemberSessionCommandOutput} for command's `response` shape. + * @see {@link Macie2ClientResolvedConfig | config} for command's `input` shape. + * */ export class UpdateMemberSessionCommand extends $Command< UpdateMemberSessionCommandInput, diff --git a/clients/client-macie2/commands/UpdateOrganizationConfigurationCommand.ts b/clients/client-macie2/commands/UpdateOrganizationConfigurationCommand.ts index 8593845d4c2d..62f1673b2c53 100644 --- a/clients/client-macie2/commands/UpdateOrganizationConfigurationCommand.ts +++ b/clients/client-macie2/commands/UpdateOrganizationConfigurationCommand.ts @@ -24,6 +24,20 @@ export interface UpdateOrganizationConfigurationCommandOutput /** *

Updates the Amazon Macie configuration settings for an AWS organization.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { Macie2Client, UpdateOrganizationConfigurationCommand } from "@aws-sdk/client-macie2"; // ES Modules import + * // const { Macie2Client, UpdateOrganizationConfigurationCommand } = require("@aws-sdk/client-macie2"); // CommonJS import + * const client = new Macie2Client(config); + * const command = new UpdateOrganizationConfigurationCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link UpdateOrganizationConfigurationCommandInput} for command's `input` shape. + * @see {@link UpdateOrganizationConfigurationCommandOutput} for command's `response` shape. + * @see {@link Macie2ClientResolvedConfig | config} for command's `input` shape. + * */ export class UpdateOrganizationConfigurationCommand extends $Command< UpdateOrganizationConfigurationCommandInput, diff --git a/clients/client-macie2/models/models_0.ts b/clients/client-macie2/models/models_0.ts index f056a3832180..cca4194e8e10 100644 --- a/clients/client-macie2/models/models_0.ts +++ b/clients/client-macie2/models/models_0.ts @@ -22,6 +22,9 @@ export interface AdminAccount { } export namespace AdminAccount { + /** + * @internal + */ export const filterSensitiveLog = (obj: AdminAccount): any => ({ ...obj, }); @@ -63,6 +66,9 @@ export interface BatchGetCustomDataIdentifierSummary { } export namespace BatchGetCustomDataIdentifierSummary { + /** + * @internal + */ export const filterSensitiveLog = (obj: BatchGetCustomDataIdentifierSummary): any => ({ ...obj, }); @@ -112,6 +118,9 @@ export interface JobDetails { } export namespace JobDetails { + /** + * @internal + */ export const filterSensitiveLog = (obj: JobDetails): any => ({ ...obj, }); @@ -148,6 +157,9 @@ export interface ObjectCountByEncryptionType { } export namespace ObjectCountByEncryptionType { + /** + * @internal + */ export const filterSensitiveLog = (obj: ObjectCountByEncryptionType): any => ({ ...obj, }); @@ -185,6 +197,9 @@ export interface BlockPublicAccess { } export namespace BlockPublicAccess { + /** + * @internal + */ export const filterSensitiveLog = (obj: BlockPublicAccess): any => ({ ...obj, }); @@ -201,6 +216,9 @@ export interface AccountLevelPermissions { } export namespace AccountLevelPermissions { + /** + * @internal + */ export const filterSensitiveLog = (obj: AccountLevelPermissions): any => ({ ...obj, }); @@ -222,6 +240,9 @@ export interface AccessControlList { } export namespace AccessControlList { + /** + * @internal + */ export const filterSensitiveLog = (obj: AccessControlList): any => ({ ...obj, }); @@ -243,6 +264,9 @@ export interface BucketPolicy { } export namespace BucketPolicy { + /** + * @internal + */ export const filterSensitiveLog = (obj: BucketPolicy): any => ({ ...obj, }); @@ -269,6 +293,9 @@ export interface BucketLevelPermissions { } export namespace BucketLevelPermissions { + /** + * @internal + */ export const filterSensitiveLog = (obj: BucketLevelPermissions): any => ({ ...obj, }); @@ -290,6 +317,9 @@ export interface BucketPermissionConfiguration { } export namespace BucketPermissionConfiguration { + /** + * @internal + */ export const filterSensitiveLog = (obj: BucketPermissionConfiguration): any => ({ ...obj, }); @@ -311,6 +341,9 @@ export interface BucketPublicAccess { } export namespace BucketPublicAccess { + /** + * @internal + */ export const filterSensitiveLog = (obj: BucketPublicAccess): any => ({ ...obj, }); @@ -337,6 +370,9 @@ export interface ReplicationDetails { } export namespace ReplicationDetails { + /** + * @internal + */ export const filterSensitiveLog = (obj: ReplicationDetails): any => ({ ...obj, }); @@ -364,6 +400,9 @@ export interface BucketServerSideEncryption { } export namespace BucketServerSideEncryption { + /** + * @internal + */ export const filterSensitiveLog = (obj: BucketServerSideEncryption): any => ({ ...obj, }); @@ -392,6 +431,9 @@ export interface KeyValuePair { } export namespace KeyValuePair { + /** + * @internal + */ export const filterSensitiveLog = (obj: KeyValuePair): any => ({ ...obj, }); @@ -418,6 +460,9 @@ export interface ObjectLevelStatistics { } export namespace ObjectLevelStatistics { + /** + * @internal + */ export const filterSensitiveLog = (obj: ObjectLevelStatistics): any => ({ ...obj, }); @@ -539,6 +584,9 @@ export interface BucketMetadata { } export namespace BucketMetadata { + /** + * @internal + */ export const filterSensitiveLog = (obj: BucketMetadata): any => ({ ...obj, }); @@ -575,6 +623,9 @@ export interface CustomDataIdentifierSummary { } export namespace CustomDataIdentifierSummary { + /** + * @internal + */ export const filterSensitiveLog = (obj: CustomDataIdentifierSummary): any => ({ ...obj, }); @@ -611,6 +662,9 @@ export interface Cell { } export namespace Cell { + /** + * @internal + */ export const filterSensitiveLog = (obj: Cell): any => ({ ...obj, }); @@ -637,6 +691,9 @@ export interface Range { } export namespace Range { + /** + * @internal + */ export const filterSensitiveLog = (obj: Range): any => ({ ...obj, }); @@ -663,6 +720,9 @@ export interface Page { } export namespace Page { + /** + * @internal + */ export const filterSensitiveLog = (obj: Page): any => ({ ...obj, }); @@ -684,6 +744,9 @@ export interface _Record { } export namespace _Record { + /** + * @internal + */ export const filterSensitiveLog = (obj: _Record): any => ({ ...obj, }); @@ -720,6 +783,9 @@ export interface Occurrences { } export namespace Occurrences { + /** + * @internal + */ export const filterSensitiveLog = (obj: Occurrences): any => ({ ...obj, }); @@ -751,6 +817,9 @@ export interface CustomDetection { } export namespace CustomDetection { + /** + * @internal + */ export const filterSensitiveLog = (obj: CustomDetection): any => ({ ...obj, }); @@ -772,6 +841,9 @@ export interface CustomDataIdentifiers { } export namespace CustomDataIdentifiers { + /** + * @internal + */ export const filterSensitiveLog = (obj: CustomDataIdentifiers): any => ({ ...obj, }); @@ -805,6 +877,9 @@ export interface DefaultDetection { } export namespace DefaultDetection { + /** + * @internal + */ export const filterSensitiveLog = (obj: DefaultDetection): any => ({ ...obj, }); @@ -831,6 +906,9 @@ export interface SensitiveDataItem { } export namespace SensitiveDataItem { + /** + * @internal + */ export const filterSensitiveLog = (obj: SensitiveDataItem): any => ({ ...obj, }); @@ -852,6 +930,9 @@ export interface ClassificationResultStatus { } export namespace ClassificationResultStatus { + /** + * @internal + */ export const filterSensitiveLog = (obj: ClassificationResultStatus): any => ({ ...obj, }); @@ -893,6 +974,9 @@ export interface ClassificationResult { } export namespace ClassificationResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: ClassificationResult): any => ({ ...obj, }); @@ -924,6 +1008,9 @@ export interface ClassificationDetails { } export namespace ClassificationDetails { + /** + * @internal + */ export const filterSensitiveLog = (obj: ClassificationDetails): any => ({ ...obj, }); @@ -959,6 +1046,9 @@ export interface ApiCallDetails { } export namespace ApiCallDetails { + /** + * @internal + */ export const filterSensitiveLog = (obj: ApiCallDetails): any => ({ ...obj, }); @@ -980,6 +1070,9 @@ export interface FindingAction { } export namespace FindingAction { + /** + * @internal + */ export const filterSensitiveLog = (obj: FindingAction): any => ({ ...obj, }); @@ -996,6 +1089,9 @@ export interface DomainDetails { } export namespace DomainDetails { + /** + * @internal + */ export const filterSensitiveLog = (obj: DomainDetails): any => ({ ...obj, }); @@ -1012,6 +1108,9 @@ export interface IpCity { } export namespace IpCity { + /** + * @internal + */ export const filterSensitiveLog = (obj: IpCity): any => ({ ...obj, }); @@ -1033,6 +1132,9 @@ export interface IpCountry { } export namespace IpCountry { + /** + * @internal + */ export const filterSensitiveLog = (obj: IpCountry): any => ({ ...obj, }); @@ -1054,6 +1156,9 @@ export interface IpGeoLocation { } export namespace IpGeoLocation { + /** + * @internal + */ export const filterSensitiveLog = (obj: IpGeoLocation): any => ({ ...obj, }); @@ -1085,6 +1190,9 @@ export interface IpOwner { } export namespace IpOwner { + /** + * @internal + */ export const filterSensitiveLog = (obj: IpOwner): any => ({ ...obj, }); @@ -1121,6 +1229,9 @@ export interface IpAddressDetails { } export namespace IpAddressDetails { + /** + * @internal + */ export const filterSensitiveLog = (obj: IpAddressDetails): any => ({ ...obj, }); @@ -1142,6 +1253,9 @@ export interface SessionContextAttributes { } export namespace SessionContextAttributes { + /** + * @internal + */ export const filterSensitiveLog = (obj: SessionContextAttributes): any => ({ ...obj, }); @@ -1178,6 +1292,9 @@ export interface SessionIssuer { } export namespace SessionIssuer { + /** + * @internal + */ export const filterSensitiveLog = (obj: SessionIssuer): any => ({ ...obj, }); @@ -1199,6 +1316,9 @@ export interface SessionContext { } export namespace SessionContext { + /** + * @internal + */ export const filterSensitiveLog = (obj: SessionContext): any => ({ ...obj, }); @@ -1235,6 +1355,9 @@ export interface AssumedRole { } export namespace AssumedRole { + /** + * @internal + */ export const filterSensitiveLog = (obj: AssumedRole): any => ({ ...obj, }); @@ -1256,6 +1379,9 @@ export interface AwsAccount { } export namespace AwsAccount { + /** + * @internal + */ export const filterSensitiveLog = (obj: AwsAccount): any => ({ ...obj, }); @@ -1272,6 +1398,9 @@ export interface AwsService { } export namespace AwsService { + /** + * @internal + */ export const filterSensitiveLog = (obj: AwsService): any => ({ ...obj, }); @@ -1308,6 +1437,9 @@ export interface FederatedUser { } export namespace FederatedUser { + /** + * @internal + */ export const filterSensitiveLog = (obj: FederatedUser): any => ({ ...obj, }); @@ -1339,6 +1471,9 @@ export interface IamUser { } export namespace IamUser { + /** + * @internal + */ export const filterSensitiveLog = (obj: IamUser): any => ({ ...obj, }); @@ -1365,6 +1500,9 @@ export interface UserIdentityRoot { } export namespace UserIdentityRoot { + /** + * @internal + */ export const filterSensitiveLog = (obj: UserIdentityRoot): any => ({ ...obj, }); @@ -1420,6 +1558,9 @@ export interface UserIdentity { } export namespace UserIdentity { + /** + * @internal + */ export const filterSensitiveLog = (obj: UserIdentity): any => ({ ...obj, }); @@ -1446,6 +1587,9 @@ export interface FindingActor { } export namespace FindingActor { + /** + * @internal + */ export const filterSensitiveLog = (obj: FindingActor): any => ({ ...obj, }); @@ -1467,6 +1611,9 @@ export interface PolicyDetails { } export namespace PolicyDetails { + /** + * @internal + */ export const filterSensitiveLog = (obj: PolicyDetails): any => ({ ...obj, }); @@ -1495,6 +1642,9 @@ export interface ServerSideEncryption { } export namespace ServerSideEncryption { + /** + * @internal + */ export const filterSensitiveLog = (obj: ServerSideEncryption): any => ({ ...obj, }); @@ -1516,6 +1666,9 @@ export interface S3BucketOwner { } export namespace S3BucketOwner { + /** + * @internal + */ export const filterSensitiveLog = (obj: S3BucketOwner): any => ({ ...obj, }); @@ -1567,6 +1720,9 @@ export interface S3Bucket { } export namespace S3Bucket { + /** + * @internal + */ export const filterSensitiveLog = (obj: S3Bucket): any => ({ ...obj, }); @@ -1648,6 +1804,9 @@ export interface S3Object { } export namespace S3Object { + /** + * @internal + */ export const filterSensitiveLog = (obj: S3Object): any => ({ ...obj, }); @@ -1669,6 +1828,9 @@ export interface ResourcesAffected { } export namespace ResourcesAffected { + /** + * @internal + */ export const filterSensitiveLog = (obj: ResourcesAffected): any => ({ ...obj, }); @@ -1696,6 +1858,9 @@ export interface Severity { } export namespace Severity { + /** + * @internal + */ export const filterSensitiveLog = (obj: Severity): any => ({ ...obj, }); @@ -1810,6 +1975,9 @@ export interface Finding { } export namespace Finding { + /** + * @internal + */ export const filterSensitiveLog = (obj: Finding): any => ({ ...obj, }); @@ -1851,6 +2019,9 @@ export interface FindingsFilterListItem { } export namespace FindingsFilterListItem { + /** + * @internal + */ export const filterSensitiveLog = (obj: FindingsFilterListItem): any => ({ ...obj, }); @@ -1872,6 +2043,9 @@ export interface GroupCount { } export namespace GroupCount { + /** + * @internal + */ export const filterSensitiveLog = (obj: GroupCount): any => ({ ...obj, }); @@ -1916,6 +2090,9 @@ export interface Invitation { } export namespace Invitation { + /** + * @internal + */ export const filterSensitiveLog = (obj: Invitation): any => ({ ...obj, }); @@ -1962,6 +2139,9 @@ export interface SimpleScopeTerm { } export namespace SimpleScopeTerm { + /** + * @internal + */ export const filterSensitiveLog = (obj: SimpleScopeTerm): any => ({ ...obj, }); @@ -1983,6 +2163,9 @@ export interface TagValuePair { } export namespace TagValuePair { + /** + * @internal + */ export const filterSensitiveLog = (obj: TagValuePair): any => ({ ...obj, }); @@ -2018,6 +2201,9 @@ export interface TagScopeTerm { } export namespace TagScopeTerm { + /** + * @internal + */ export const filterSensitiveLog = (obj: TagScopeTerm): any => ({ ...obj, }); @@ -2039,6 +2225,9 @@ export interface JobScopeTerm { } export namespace JobScopeTerm { + /** + * @internal + */ export const filterSensitiveLog = (obj: JobScopeTerm): any => ({ ...obj, }); @@ -2060,6 +2249,9 @@ export interface S3BucketDefinitionForJob { } export namespace S3BucketDefinitionForJob { + /** + * @internal + */ export const filterSensitiveLog = (obj: S3BucketDefinitionForJob): any => ({ ...obj, }); @@ -2095,6 +2287,9 @@ export interface LastRunErrorStatus { } export namespace LastRunErrorStatus { + /** + * @internal + */ export const filterSensitiveLog = (obj: LastRunErrorStatus): any => ({ ...obj, }); @@ -2121,6 +2316,9 @@ export interface UserPausedDetails { } export namespace UserPausedDetails { + /** + * @internal + */ export const filterSensitiveLog = (obj: UserPausedDetails): any => ({ ...obj, }); @@ -2172,6 +2370,9 @@ export interface JobSummary { } export namespace JobSummary { + /** + * @internal + */ export const filterSensitiveLog = (obj: JobSummary): any => ({ ...obj, }); @@ -2205,6 +2406,9 @@ export interface ListJobsFilterTerm { } export namespace ListJobsFilterTerm { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListJobsFilterTerm): any => ({ ...obj, }); @@ -2261,6 +2465,9 @@ export interface Member { } export namespace Member { + /** + * @internal + */ export const filterSensitiveLog = (obj: Member): any => ({ ...obj, }); @@ -2292,6 +2499,9 @@ export interface UnprocessedAccount { } export namespace UnprocessedAccount { + /** + * @internal + */ export const filterSensitiveLog = (obj: UnprocessedAccount): any => ({ ...obj, }); @@ -2326,6 +2536,9 @@ export interface ServiceLimit { } export namespace ServiceLimit { + /** + * @internal + */ export const filterSensitiveLog = (obj: ServiceLimit): any => ({ ...obj, }); @@ -2362,6 +2575,9 @@ export interface UsageByAccount { } export namespace UsageByAccount { + /** + * @internal + */ export const filterSensitiveLog = (obj: UsageByAccount): any => ({ ...obj, }); @@ -2388,6 +2604,9 @@ export interface UsageRecord { } export namespace UsageRecord { + /** + * @internal + */ export const filterSensitiveLog = (obj: UsageRecord): any => ({ ...obj, }); @@ -2431,6 +2650,9 @@ export interface UsageStatisticsFilter { } export namespace UsageStatisticsFilter { + /** + * @internal + */ export const filterSensitiveLog = (obj: UsageStatisticsFilter): any => ({ ...obj, }); @@ -2457,6 +2679,9 @@ export interface UsageTotal { } export namespace UsageTotal { + /** + * @internal + */ export const filterSensitiveLog = (obj: UsageTotal): any => ({ ...obj, }); @@ -2480,6 +2705,9 @@ export interface AcceptInvitationRequest { } export namespace AcceptInvitationRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: AcceptInvitationRequest): any => ({ ...obj, }); @@ -2488,6 +2716,9 @@ export namespace AcceptInvitationRequest { export interface AcceptInvitationResponse {} export namespace AcceptInvitationResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: AcceptInvitationResponse): any => ({ ...obj, }); @@ -2506,6 +2737,9 @@ export interface AccessDeniedException extends __SmithyException, $MetadataBeare } export namespace AccessDeniedException { + /** + * @internal + */ export const filterSensitiveLog = (obj: AccessDeniedException): any => ({ ...obj, }); @@ -2524,6 +2758,9 @@ export interface ConflictException extends __SmithyException, $MetadataBearer { } export namespace ConflictException { + /** + * @internal + */ export const filterSensitiveLog = (obj: ConflictException): any => ({ ...obj, }); @@ -2542,6 +2779,9 @@ export interface InternalServerException extends __SmithyException, $MetadataBea } export namespace InternalServerException { + /** + * @internal + */ export const filterSensitiveLog = (obj: InternalServerException): any => ({ ...obj, }); @@ -2560,6 +2800,9 @@ export interface ResourceNotFoundException extends __SmithyException, $MetadataB } export namespace ResourceNotFoundException { + /** + * @internal + */ export const filterSensitiveLog = (obj: ResourceNotFoundException): any => ({ ...obj, }); @@ -2578,6 +2821,9 @@ export interface ServiceQuotaExceededException extends __SmithyException, $Metad } export namespace ServiceQuotaExceededException { + /** + * @internal + */ export const filterSensitiveLog = (obj: ServiceQuotaExceededException): any => ({ ...obj, }); @@ -2596,6 +2842,9 @@ export interface ThrottlingException extends __SmithyException, $MetadataBearer } export namespace ThrottlingException { + /** + * @internal + */ export const filterSensitiveLog = (obj: ThrottlingException): any => ({ ...obj, }); @@ -2614,6 +2863,9 @@ export interface ValidationException extends __SmithyException, $MetadataBearer } export namespace ValidationException { + /** + * @internal + */ export const filterSensitiveLog = (obj: ValidationException): any => ({ ...obj, }); @@ -2635,6 +2887,9 @@ export interface AccountDetail { } export namespace AccountDetail { + /** + * @internal + */ export const filterSensitiveLog = (obj: AccountDetail): any => ({ ...obj, }); @@ -2648,6 +2903,9 @@ export interface BatchGetCustomDataIdentifiersRequest { } export namespace BatchGetCustomDataIdentifiersRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: BatchGetCustomDataIdentifiersRequest): any => ({ ...obj, }); @@ -2666,6 +2924,9 @@ export interface BatchGetCustomDataIdentifiersResponse { } export namespace BatchGetCustomDataIdentifiersResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: BatchGetCustomDataIdentifiersResponse): any => ({ ...obj, }); @@ -2697,6 +2958,9 @@ export interface BucketCountByEffectivePermission { } export namespace BucketCountByEffectivePermission { + /** + * @internal + */ export const filterSensitiveLog = (obj: BucketCountByEffectivePermission): any => ({ ...obj, }); @@ -2728,6 +2992,9 @@ export interface BucketCountByEncryptionType { } export namespace BucketCountByEncryptionType { + /** + * @internal + */ export const filterSensitiveLog = (obj: BucketCountByEncryptionType): any => ({ ...obj, }); @@ -2759,6 +3026,9 @@ export interface BucketCountBySharedAccessType { } export namespace BucketCountBySharedAccessType { + /** + * @internal + */ export const filterSensitiveLog = (obj: BucketCountBySharedAccessType): any => ({ ...obj, }); @@ -2785,6 +3055,9 @@ export interface BucketCountPolicyAllowsUnencryptedObjectUploads { } export namespace BucketCountPolicyAllowsUnencryptedObjectUploads { + /** + * @internal + */ export const filterSensitiveLog = (obj: BucketCountPolicyAllowsUnencryptedObjectUploads): any => ({ ...obj, }); @@ -2831,6 +3104,9 @@ export interface BucketCriteriaAdditionalProperties { } export namespace BucketCriteriaAdditionalProperties { + /** + * @internal + */ export const filterSensitiveLog = (obj: BucketCriteriaAdditionalProperties): any => ({ ...obj, }); @@ -2857,6 +3133,9 @@ export interface BucketSortCriteria { } export namespace BucketSortCriteria { + /** + * @internal + */ export const filterSensitiveLog = (obj: BucketSortCriteria): any => ({ ...obj, }); @@ -2883,6 +3162,9 @@ export interface S3Destination { } export namespace S3Destination { + /** + * @internal + */ export const filterSensitiveLog = (obj: S3Destination): any => ({ ...obj, }); @@ -2899,6 +3181,9 @@ export interface ClassificationExportConfiguration { } export namespace ClassificationExportConfiguration { + /** + * @internal + */ export const filterSensitiveLog = (obj: ClassificationExportConfiguration): any => ({ ...obj, }); @@ -2915,6 +3200,9 @@ export interface JobScopingBlock { } export namespace JobScopingBlock { + /** + * @internal + */ export const filterSensitiveLog = (obj: JobScopingBlock): any => ({ ...obj, }); @@ -2936,6 +3224,9 @@ export interface Scoping { } export namespace Scoping { + /** + * @internal + */ export const filterSensitiveLog = (obj: Scoping): any => ({ ...obj, }); @@ -2957,6 +3248,9 @@ export interface S3JobDefinition { } export namespace S3JobDefinition { + /** + * @internal + */ export const filterSensitiveLog = (obj: S3JobDefinition): any => ({ ...obj, }); @@ -2968,6 +3262,9 @@ export namespace S3JobDefinition { export interface DailySchedule {} export namespace DailySchedule { + /** + * @internal + */ export const filterSensitiveLog = (obj: DailySchedule): any => ({ ...obj, }); @@ -2984,6 +3281,9 @@ export interface MonthlySchedule { } export namespace MonthlySchedule { + /** + * @internal + */ export const filterSensitiveLog = (obj: MonthlySchedule): any => ({ ...obj, }); @@ -3010,6 +3310,9 @@ export interface WeeklySchedule { } export namespace WeeklySchedule { + /** + * @internal + */ export const filterSensitiveLog = (obj: WeeklySchedule): any => ({ ...obj, }); @@ -3036,6 +3339,9 @@ export interface JobScheduleFrequency { } export namespace JobScheduleFrequency { + /** + * @internal + */ export const filterSensitiveLog = (obj: JobScheduleFrequency): any => ({ ...obj, }); @@ -3094,6 +3400,9 @@ export interface CreateClassificationJobRequest { } export namespace CreateClassificationJobRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateClassificationJobRequest): any => ({ ...obj, }); @@ -3112,6 +3421,9 @@ export interface CreateClassificationJobResponse { } export namespace CreateClassificationJobResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateClassificationJobResponse): any => ({ ...obj, }); @@ -3160,6 +3472,9 @@ export interface CreateCustomDataIdentifierRequest { } export namespace CreateCustomDataIdentifierRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateCustomDataIdentifierRequest): any => ({ ...obj, }); @@ -3173,6 +3488,9 @@ export interface CreateCustomDataIdentifierResponse { } export namespace CreateCustomDataIdentifierResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateCustomDataIdentifierResponse): any => ({ ...obj, }); @@ -3219,6 +3537,9 @@ export interface CriterionAdditionalProperties { } export namespace CriterionAdditionalProperties { + /** + * @internal + */ export const filterSensitiveLog = (obj: CriterionAdditionalProperties): any => ({ ...obj, }); @@ -3235,6 +3556,9 @@ export interface FindingCriteria { } export namespace FindingCriteria { + /** + * @internal + */ export const filterSensitiveLog = (obj: FindingCriteria): any => ({ ...obj, }); @@ -3278,6 +3602,9 @@ export interface CreateFindingsFilterRequest { } export namespace CreateFindingsFilterRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateFindingsFilterRequest): any => ({ ...obj, }); @@ -3296,6 +3623,9 @@ export interface CreateFindingsFilterResponse { } export namespace CreateFindingsFilterResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateFindingsFilterResponse): any => ({ ...obj, }); @@ -3319,6 +3649,9 @@ export interface CreateInvitationsRequest { } export namespace CreateInvitationsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateInvitationsRequest): any => ({ ...obj, }); @@ -3332,6 +3665,9 @@ export interface CreateInvitationsResponse { } export namespace CreateInvitationsResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateInvitationsResponse): any => ({ ...obj, }); @@ -3350,6 +3686,9 @@ export interface CreateMemberRequest { } export namespace CreateMemberRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateMemberRequest): any => ({ ...obj, }); @@ -3363,6 +3702,9 @@ export interface CreateMemberResponse { } export namespace CreateMemberResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateMemberResponse): any => ({ ...obj, }); @@ -3376,6 +3718,9 @@ export interface CreateSampleFindingsRequest { } export namespace CreateSampleFindingsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateSampleFindingsRequest): any => ({ ...obj, }); @@ -3384,6 +3729,9 @@ export namespace CreateSampleFindingsRequest { export interface CreateSampleFindingsResponse {} export namespace CreateSampleFindingsResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateSampleFindingsResponse): any => ({ ...obj, }); @@ -3397,6 +3745,9 @@ export interface DeclineInvitationsRequest { } export namespace DeclineInvitationsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeclineInvitationsRequest): any => ({ ...obj, }); @@ -3410,6 +3761,9 @@ export interface DeclineInvitationsResponse { } export namespace DeclineInvitationsResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeclineInvitationsResponse): any => ({ ...obj, }); @@ -3423,6 +3777,9 @@ export interface DeleteCustomDataIdentifierRequest { } export namespace DeleteCustomDataIdentifierRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteCustomDataIdentifierRequest): any => ({ ...obj, }); @@ -3431,6 +3788,9 @@ export namespace DeleteCustomDataIdentifierRequest { export interface DeleteCustomDataIdentifierResponse {} export namespace DeleteCustomDataIdentifierResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteCustomDataIdentifierResponse): any => ({ ...obj, }); @@ -3444,6 +3804,9 @@ export interface DeleteFindingsFilterRequest { } export namespace DeleteFindingsFilterRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteFindingsFilterRequest): any => ({ ...obj, }); @@ -3452,6 +3815,9 @@ export namespace DeleteFindingsFilterRequest { export interface DeleteFindingsFilterResponse {} export namespace DeleteFindingsFilterResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteFindingsFilterResponse): any => ({ ...obj, }); @@ -3465,6 +3831,9 @@ export interface DeleteInvitationsRequest { } export namespace DeleteInvitationsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteInvitationsRequest): any => ({ ...obj, }); @@ -3478,6 +3847,9 @@ export interface DeleteInvitationsResponse { } export namespace DeleteInvitationsResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteInvitationsResponse): any => ({ ...obj, }); @@ -3491,6 +3863,9 @@ export interface DeleteMemberRequest { } export namespace DeleteMemberRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteMemberRequest): any => ({ ...obj, }); @@ -3499,6 +3874,9 @@ export namespace DeleteMemberRequest { export interface DeleteMemberResponse {} export namespace DeleteMemberResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteMemberResponse): any => ({ ...obj, }); @@ -3527,6 +3905,9 @@ export interface DescribeBucketsRequest { } export namespace DescribeBucketsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeBucketsRequest): any => ({ ...obj, }); @@ -3545,6 +3926,9 @@ export interface DescribeBucketsResponse { } export namespace DescribeBucketsResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeBucketsResponse): any => ({ ...obj, }); @@ -3558,6 +3942,9 @@ export interface DescribeClassificationJobRequest { } export namespace DescribeClassificationJobRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeClassificationJobRequest): any => ({ ...obj, }); @@ -3579,6 +3966,9 @@ export interface Statistics { } export namespace Statistics { + /** + * @internal + */ export const filterSensitiveLog = (obj: Statistics): any => ({ ...obj, }); @@ -3677,6 +4067,9 @@ export interface DescribeClassificationJobResponse { } export namespace DescribeClassificationJobResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeClassificationJobResponse): any => ({ ...obj, }); @@ -3685,6 +4078,9 @@ export namespace DescribeClassificationJobResponse { export interface DescribeOrganizationConfigurationRequest {} export namespace DescribeOrganizationConfigurationRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeOrganizationConfigurationRequest): any => ({ ...obj, }); @@ -3703,6 +4099,9 @@ export interface DescribeOrganizationConfigurationResponse { } export namespace DescribeOrganizationConfigurationResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeOrganizationConfigurationResponse): any => ({ ...obj, }); @@ -3711,6 +4110,9 @@ export namespace DescribeOrganizationConfigurationResponse { export interface DisableMacieRequest {} export namespace DisableMacieRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DisableMacieRequest): any => ({ ...obj, }); @@ -3719,6 +4121,9 @@ export namespace DisableMacieRequest { export interface DisableMacieResponse {} export namespace DisableMacieResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DisableMacieResponse): any => ({ ...obj, }); @@ -3732,6 +4137,9 @@ export interface DisableOrganizationAdminAccountRequest { } export namespace DisableOrganizationAdminAccountRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DisableOrganizationAdminAccountRequest): any => ({ ...obj, }); @@ -3740,6 +4148,9 @@ export namespace DisableOrganizationAdminAccountRequest { export interface DisableOrganizationAdminAccountResponse {} export namespace DisableOrganizationAdminAccountResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DisableOrganizationAdminAccountResponse): any => ({ ...obj, }); @@ -3748,6 +4159,9 @@ export namespace DisableOrganizationAdminAccountResponse { export interface DisassociateFromAdministratorAccountRequest {} export namespace DisassociateFromAdministratorAccountRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DisassociateFromAdministratorAccountRequest): any => ({ ...obj, }); @@ -3756,6 +4170,9 @@ export namespace DisassociateFromAdministratorAccountRequest { export interface DisassociateFromAdministratorAccountResponse {} export namespace DisassociateFromAdministratorAccountResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DisassociateFromAdministratorAccountResponse): any => ({ ...obj, }); @@ -3764,6 +4181,9 @@ export namespace DisassociateFromAdministratorAccountResponse { export interface DisassociateFromMasterAccountRequest {} export namespace DisassociateFromMasterAccountRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DisassociateFromMasterAccountRequest): any => ({ ...obj, }); @@ -3772,6 +4192,9 @@ export namespace DisassociateFromMasterAccountRequest { export interface DisassociateFromMasterAccountResponse {} export namespace DisassociateFromMasterAccountResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DisassociateFromMasterAccountResponse): any => ({ ...obj, }); @@ -3785,6 +4208,9 @@ export interface DisassociateMemberRequest { } export namespace DisassociateMemberRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DisassociateMemberRequest): any => ({ ...obj, }); @@ -3793,6 +4219,9 @@ export namespace DisassociateMemberRequest { export interface DisassociateMemberResponse {} export namespace DisassociateMemberResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DisassociateMemberResponse): any => ({ ...obj, }); @@ -3827,6 +4256,9 @@ export interface EnableMacieRequest { } export namespace EnableMacieRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: EnableMacieRequest): any => ({ ...obj, }); @@ -3835,6 +4267,9 @@ export namespace EnableMacieRequest { export interface EnableMacieResponse {} export namespace EnableMacieResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: EnableMacieResponse): any => ({ ...obj, }); @@ -3853,6 +4288,9 @@ export interface EnableOrganizationAdminAccountRequest { } export namespace EnableOrganizationAdminAccountRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: EnableOrganizationAdminAccountRequest): any => ({ ...obj, }); @@ -3861,6 +4299,9 @@ export namespace EnableOrganizationAdminAccountRequest { export interface EnableOrganizationAdminAccountResponse {} export namespace EnableOrganizationAdminAccountResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: EnableOrganizationAdminAccountResponse): any => ({ ...obj, }); @@ -3887,6 +4328,9 @@ export interface FindingStatisticsSortCriteria { } export namespace FindingStatisticsSortCriteria { + /** + * @internal + */ export const filterSensitiveLog = (obj: FindingStatisticsSortCriteria): any => ({ ...obj, }); @@ -3895,6 +4339,9 @@ export namespace FindingStatisticsSortCriteria { export interface GetAdministratorAccountRequest {} export namespace GetAdministratorAccountRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetAdministratorAccountRequest): any => ({ ...obj, }); @@ -3908,6 +4355,9 @@ export interface GetAdministratorAccountResponse { } export namespace GetAdministratorAccountResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetAdministratorAccountResponse): any => ({ ...obj, }); @@ -3921,6 +4371,9 @@ export interface GetBucketStatisticsRequest { } export namespace GetBucketStatisticsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetBucketStatisticsRequest): any => ({ ...obj, }); @@ -3994,6 +4447,9 @@ export interface GetBucketStatisticsResponse { } export namespace GetBucketStatisticsResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetBucketStatisticsResponse): any => ({ ...obj, }); @@ -4002,6 +4458,9 @@ export namespace GetBucketStatisticsResponse { export interface GetClassificationExportConfigurationRequest {} export namespace GetClassificationExportConfigurationRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetClassificationExportConfigurationRequest): any => ({ ...obj, }); @@ -4015,6 +4474,9 @@ export interface GetClassificationExportConfigurationResponse { } export namespace GetClassificationExportConfigurationResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetClassificationExportConfigurationResponse): any => ({ ...obj, }); @@ -4028,6 +4490,9 @@ export interface GetCustomDataIdentifierRequest { } export namespace GetCustomDataIdentifierRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetCustomDataIdentifierRequest): any => ({ ...obj, }); @@ -4091,6 +4556,9 @@ export interface GetCustomDataIdentifierResponse { } export namespace GetCustomDataIdentifierResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetCustomDataIdentifierResponse): any => ({ ...obj, }); @@ -4112,6 +4580,9 @@ export interface SortCriteria { } export namespace SortCriteria { + /** + * @internal + */ export const filterSensitiveLog = (obj: SortCriteria): any => ({ ...obj, }); @@ -4130,6 +4601,9 @@ export interface GetFindingsRequest { } export namespace GetFindingsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetFindingsRequest): any => ({ ...obj, }); @@ -4143,6 +4617,9 @@ export interface GetFindingsResponse { } export namespace GetFindingsResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetFindingsResponse): any => ({ ...obj, }); @@ -4156,6 +4633,9 @@ export interface GetFindingsFilterRequest { } export namespace GetFindingsFilterRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetFindingsFilterRequest): any => ({ ...obj, }); @@ -4204,6 +4684,9 @@ export interface GetFindingsFilterResponse { } export namespace GetFindingsFilterResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetFindingsFilterResponse): any => ({ ...obj, }); @@ -4212,6 +4695,9 @@ export namespace GetFindingsFilterResponse { export interface GetFindingsPublicationConfigurationRequest {} export namespace GetFindingsPublicationConfigurationRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetFindingsPublicationConfigurationRequest): any => ({ ...obj, }); @@ -4233,6 +4719,9 @@ export interface SecurityHubConfiguration { } export namespace SecurityHubConfiguration { + /** + * @internal + */ export const filterSensitiveLog = (obj: SecurityHubConfiguration): any => ({ ...obj, }); @@ -4246,6 +4735,9 @@ export interface GetFindingsPublicationConfigurationResponse { } export namespace GetFindingsPublicationConfigurationResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetFindingsPublicationConfigurationResponse): any => ({ ...obj, }); @@ -4281,6 +4773,9 @@ export interface GetFindingStatisticsRequest { } export namespace GetFindingStatisticsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetFindingStatisticsRequest): any => ({ ...obj, }); @@ -4294,6 +4789,9 @@ export interface GetFindingStatisticsResponse { } export namespace GetFindingStatisticsResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetFindingStatisticsResponse): any => ({ ...obj, }); @@ -4302,6 +4800,9 @@ export namespace GetFindingStatisticsResponse { export interface GetInvitationsCountRequest {} export namespace GetInvitationsCountRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetInvitationsCountRequest): any => ({ ...obj, }); @@ -4315,6 +4816,9 @@ export interface GetInvitationsCountResponse { } export namespace GetInvitationsCountResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetInvitationsCountResponse): any => ({ ...obj, }); @@ -4323,6 +4827,9 @@ export namespace GetInvitationsCountResponse { export interface GetMacieSessionRequest {} export namespace GetMacieSessionRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetMacieSessionRequest): any => ({ ...obj, }); @@ -4356,6 +4863,9 @@ export interface GetMacieSessionResponse { } export namespace GetMacieSessionResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetMacieSessionResponse): any => ({ ...obj, }); @@ -4364,6 +4874,9 @@ export namespace GetMacieSessionResponse { export interface GetMasterAccountRequest {} export namespace GetMasterAccountRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetMasterAccountRequest): any => ({ ...obj, }); @@ -4377,6 +4890,9 @@ export interface GetMasterAccountResponse { } export namespace GetMasterAccountResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetMasterAccountResponse): any => ({ ...obj, }); @@ -4390,6 +4906,9 @@ export interface GetMemberRequest { } export namespace GetMemberRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetMemberRequest): any => ({ ...obj, }); @@ -4443,6 +4962,9 @@ export interface GetMemberResponse { } export namespace GetMemberResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetMemberResponse): any => ({ ...obj, }); @@ -4471,6 +4993,9 @@ export interface UsageStatisticsSortBy { } export namespace UsageStatisticsSortBy { + /** + * @internal + */ export const filterSensitiveLog = (obj: UsageStatisticsSortBy): any => ({ ...obj, }); @@ -4509,6 +5034,9 @@ export interface GetUsageStatisticsRequest { } export namespace GetUsageStatisticsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetUsageStatisticsRequest): any => ({ ...obj, }); @@ -4532,6 +5060,9 @@ export interface GetUsageStatisticsResponse { } export namespace GetUsageStatisticsResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetUsageStatisticsResponse): any => ({ ...obj, }); @@ -4545,6 +5076,9 @@ export interface GetUsageTotalsRequest { } export namespace GetUsageTotalsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetUsageTotalsRequest): any => ({ ...obj, }); @@ -4563,6 +5097,9 @@ export interface GetUsageTotalsResponse { } export namespace GetUsageTotalsResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetUsageTotalsResponse): any => ({ ...obj, }); @@ -4584,6 +5121,9 @@ export interface ListJobsFilterCriteria { } export namespace ListJobsFilterCriteria { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListJobsFilterCriteria): any => ({ ...obj, }); @@ -4612,6 +5152,9 @@ export interface ListJobsSortCriteria { } export namespace ListJobsSortCriteria { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListJobsSortCriteria): any => ({ ...obj, }); @@ -4640,6 +5183,9 @@ export interface ListClassificationJobsRequest { } export namespace ListClassificationJobsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListClassificationJobsRequest): any => ({ ...obj, }); @@ -4658,6 +5204,9 @@ export interface ListClassificationJobsResponse { } export namespace ListClassificationJobsResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListClassificationJobsResponse): any => ({ ...obj, }); @@ -4676,6 +5225,9 @@ export interface ListCustomDataIdentifiersRequest { } export namespace ListCustomDataIdentifiersRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListCustomDataIdentifiersRequest): any => ({ ...obj, }); @@ -4694,6 +5246,9 @@ export interface ListCustomDataIdentifiersResponse { } export namespace ListCustomDataIdentifiersResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListCustomDataIdentifiersResponse): any => ({ ...obj, }); @@ -4722,6 +5277,9 @@ export interface ListFindingsRequest { } export namespace ListFindingsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListFindingsRequest): any => ({ ...obj, }); @@ -4740,6 +5298,9 @@ export interface ListFindingsResponse { } export namespace ListFindingsResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListFindingsResponse): any => ({ ...obj, }); @@ -4758,6 +5319,9 @@ export interface ListFindingsFiltersRequest { } export namespace ListFindingsFiltersRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListFindingsFiltersRequest): any => ({ ...obj, }); @@ -4776,6 +5340,9 @@ export interface ListFindingsFiltersResponse { } export namespace ListFindingsFiltersResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListFindingsFiltersResponse): any => ({ ...obj, }); @@ -4794,6 +5361,9 @@ export interface ListInvitationsRequest { } export namespace ListInvitationsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListInvitationsRequest): any => ({ ...obj, }); @@ -4812,6 +5382,9 @@ export interface ListInvitationsResponse { } export namespace ListInvitationsResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListInvitationsResponse): any => ({ ...obj, }); @@ -4835,6 +5408,9 @@ export interface ListMembersRequest { } export namespace ListMembersRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListMembersRequest): any => ({ ...obj, }); @@ -4853,6 +5429,9 @@ export interface ListMembersResponse { } export namespace ListMembersResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListMembersResponse): any => ({ ...obj, }); @@ -4871,6 +5450,9 @@ export interface ListOrganizationAdminAccountsRequest { } export namespace ListOrganizationAdminAccountsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListOrganizationAdminAccountsRequest): any => ({ ...obj, }); @@ -4889,6 +5471,9 @@ export interface ListOrganizationAdminAccountsResponse { } export namespace ListOrganizationAdminAccountsResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListOrganizationAdminAccountsResponse): any => ({ ...obj, }); @@ -4902,6 +5487,9 @@ export interface ListTagsForResourceRequest { } export namespace ListTagsForResourceRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListTagsForResourceRequest): any => ({ ...obj, }); @@ -4915,6 +5503,9 @@ export interface ListTagsForResourceResponse { } export namespace ListTagsForResourceResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListTagsForResourceResponse): any => ({ ...obj, }); @@ -4928,6 +5519,9 @@ export interface PutClassificationExportConfigurationRequest { } export namespace PutClassificationExportConfigurationRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: PutClassificationExportConfigurationRequest): any => ({ ...obj, }); @@ -4941,6 +5535,9 @@ export interface PutClassificationExportConfigurationResponse { } export namespace PutClassificationExportConfigurationResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: PutClassificationExportConfigurationResponse): any => ({ ...obj, }); @@ -4959,6 +5556,9 @@ export interface PutFindingsPublicationConfigurationRequest { } export namespace PutFindingsPublicationConfigurationRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: PutFindingsPublicationConfigurationRequest): any => ({ ...obj, }); @@ -4967,6 +5567,9 @@ export namespace PutFindingsPublicationConfigurationRequest { export interface PutFindingsPublicationConfigurationResponse {} export namespace PutFindingsPublicationConfigurationResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: PutFindingsPublicationConfigurationResponse): any => ({ ...obj, }); @@ -4985,6 +5588,9 @@ export interface TagResourceRequest { } export namespace TagResourceRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: TagResourceRequest): any => ({ ...obj, }); @@ -4993,6 +5599,9 @@ export namespace TagResourceRequest { export interface TagResourceResponse {} export namespace TagResourceResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: TagResourceResponse): any => ({ ...obj, }); @@ -5026,6 +5635,9 @@ export interface TestCustomDataIdentifierRequest { } export namespace TestCustomDataIdentifierRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: TestCustomDataIdentifierRequest): any => ({ ...obj, }); @@ -5039,6 +5651,9 @@ export interface TestCustomDataIdentifierResponse { } export namespace TestCustomDataIdentifierResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: TestCustomDataIdentifierResponse): any => ({ ...obj, }); @@ -5057,6 +5672,9 @@ export interface UntagResourceRequest { } export namespace UntagResourceRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: UntagResourceRequest): any => ({ ...obj, }); @@ -5065,6 +5683,9 @@ export namespace UntagResourceRequest { export interface UntagResourceResponse {} export namespace UntagResourceResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: UntagResourceResponse): any => ({ ...obj, }); @@ -5083,6 +5704,9 @@ export interface UpdateClassificationJobRequest { } export namespace UpdateClassificationJobRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateClassificationJobRequest): any => ({ ...obj, }); @@ -5091,6 +5715,9 @@ export namespace UpdateClassificationJobRequest { export interface UpdateClassificationJobResponse {} export namespace UpdateClassificationJobResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateClassificationJobResponse): any => ({ ...obj, }); @@ -5129,6 +5756,9 @@ export interface UpdateFindingsFilterRequest { } export namespace UpdateFindingsFilterRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateFindingsFilterRequest): any => ({ ...obj, }); @@ -5147,6 +5777,9 @@ export interface UpdateFindingsFilterResponse { } export namespace UpdateFindingsFilterResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateFindingsFilterResponse): any => ({ ...obj, }); @@ -5165,6 +5798,9 @@ export interface UpdateMacieSessionRequest { } export namespace UpdateMacieSessionRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateMacieSessionRequest): any => ({ ...obj, }); @@ -5173,6 +5809,9 @@ export namespace UpdateMacieSessionRequest { export interface UpdateMacieSessionResponse {} export namespace UpdateMacieSessionResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateMacieSessionResponse): any => ({ ...obj, }); @@ -5191,6 +5830,9 @@ export interface UpdateMemberSessionRequest { } export namespace UpdateMemberSessionRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateMemberSessionRequest): any => ({ ...obj, }); @@ -5199,6 +5841,9 @@ export namespace UpdateMemberSessionRequest { export interface UpdateMemberSessionResponse {} export namespace UpdateMemberSessionResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateMemberSessionResponse): any => ({ ...obj, }); @@ -5212,6 +5857,9 @@ export interface UpdateOrganizationConfigurationRequest { } export namespace UpdateOrganizationConfigurationRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateOrganizationConfigurationRequest): any => ({ ...obj, }); @@ -5220,6 +5868,9 @@ export namespace UpdateOrganizationConfigurationRequest { export interface UpdateOrganizationConfigurationResponse {} export namespace UpdateOrganizationConfigurationResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateOrganizationConfigurationResponse): any => ({ ...obj, }); diff --git a/clients/client-managedblockchain/commands/CreateMemberCommand.ts b/clients/client-managedblockchain/commands/CreateMemberCommand.ts index 2add945ca626..bef00a73db83 100644 --- a/clients/client-managedblockchain/commands/CreateMemberCommand.ts +++ b/clients/client-managedblockchain/commands/CreateMemberCommand.ts @@ -27,6 +27,20 @@ export interface CreateMemberCommandOutput extends CreateMemberOutput, __Metadat /** *

Creates a member within a Managed Blockchain network.

*

Applies only to Hyperledger Fabric.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ManagedBlockchainClient, CreateMemberCommand } from "@aws-sdk/client-managedblockchain"; // ES Modules import + * // const { ManagedBlockchainClient, CreateMemberCommand } = require("@aws-sdk/client-managedblockchain"); // CommonJS import + * const client = new ManagedBlockchainClient(config); + * const command = new CreateMemberCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreateMemberCommandInput} for command's `input` shape. + * @see {@link CreateMemberCommandOutput} for command's `response` shape. + * @see {@link ManagedBlockchainClientResolvedConfig | config} for command's `input` shape. + * */ export class CreateMemberCommand extends $Command< CreateMemberCommandInput, diff --git a/clients/client-managedblockchain/commands/CreateNetworkCommand.ts b/clients/client-managedblockchain/commands/CreateNetworkCommand.ts index 79114eb669b6..51a4350a28b0 100644 --- a/clients/client-managedblockchain/commands/CreateNetworkCommand.ts +++ b/clients/client-managedblockchain/commands/CreateNetworkCommand.ts @@ -27,6 +27,20 @@ export interface CreateNetworkCommandOutput extends CreateNetworkOutput, __Metad /** *

Creates a new blockchain network using Amazon Managed Blockchain.

*

Applies only to Hyperledger Fabric.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ManagedBlockchainClient, CreateNetworkCommand } from "@aws-sdk/client-managedblockchain"; // ES Modules import + * // const { ManagedBlockchainClient, CreateNetworkCommand } = require("@aws-sdk/client-managedblockchain"); // CommonJS import + * const client = new ManagedBlockchainClient(config); + * const command = new CreateNetworkCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreateNetworkCommandInput} for command's `input` shape. + * @see {@link CreateNetworkCommandOutput} for command's `response` shape. + * @see {@link ManagedBlockchainClientResolvedConfig | config} for command's `input` shape. + * */ export class CreateNetworkCommand extends $Command< CreateNetworkCommandInput, diff --git a/clients/client-managedblockchain/commands/CreateNodeCommand.ts b/clients/client-managedblockchain/commands/CreateNodeCommand.ts index a117ad09960d..06d9ce65f656 100644 --- a/clients/client-managedblockchain/commands/CreateNodeCommand.ts +++ b/clients/client-managedblockchain/commands/CreateNodeCommand.ts @@ -27,6 +27,20 @@ export interface CreateNodeCommandOutput extends CreateNodeOutput, __MetadataBea /** *

Creates a node on the specified blockchain network.

*

Applies to Hyperledger Fabric and Ethereum.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ManagedBlockchainClient, CreateNodeCommand } from "@aws-sdk/client-managedblockchain"; // ES Modules import + * // const { ManagedBlockchainClient, CreateNodeCommand } = require("@aws-sdk/client-managedblockchain"); // CommonJS import + * const client = new ManagedBlockchainClient(config); + * const command = new CreateNodeCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreateNodeCommandInput} for command's `input` shape. + * @see {@link CreateNodeCommandOutput} for command's `response` shape. + * @see {@link ManagedBlockchainClientResolvedConfig | config} for command's `input` shape. + * */ export class CreateNodeCommand extends $Command< CreateNodeCommandInput, diff --git a/clients/client-managedblockchain/commands/CreateProposalCommand.ts b/clients/client-managedblockchain/commands/CreateProposalCommand.ts index febe989c315b..8dd9014bfaba 100644 --- a/clients/client-managedblockchain/commands/CreateProposalCommand.ts +++ b/clients/client-managedblockchain/commands/CreateProposalCommand.ts @@ -27,6 +27,20 @@ export interface CreateProposalCommandOutput extends CreateProposalOutput, __Met /** *

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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ManagedBlockchainClient, CreateProposalCommand } from "@aws-sdk/client-managedblockchain"; // ES Modules import + * // const { ManagedBlockchainClient, CreateProposalCommand } = require("@aws-sdk/client-managedblockchain"); // CommonJS import + * const client = new ManagedBlockchainClient(config); + * const command = new CreateProposalCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreateProposalCommandInput} for command's `input` shape. + * @see {@link CreateProposalCommandOutput} for command's `response` shape. + * @see {@link ManagedBlockchainClientResolvedConfig | config} for command's `input` shape. + * */ export class CreateProposalCommand extends $Command< CreateProposalCommandInput, diff --git a/clients/client-managedblockchain/commands/DeleteMemberCommand.ts b/clients/client-managedblockchain/commands/DeleteMemberCommand.ts index b818865563a3..ce7cf4c8a188 100644 --- a/clients/client-managedblockchain/commands/DeleteMemberCommand.ts +++ b/clients/client-managedblockchain/commands/DeleteMemberCommand.ts @@ -27,6 +27,20 @@ export interface DeleteMemberCommandOutput extends DeleteMemberOutput, __Metadat /** *

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 AWS 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 AWS account, the network is deleted also.

*

Applies only to Hyperledger Fabric.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ManagedBlockchainClient, DeleteMemberCommand } from "@aws-sdk/client-managedblockchain"; // ES Modules import + * // const { ManagedBlockchainClient, DeleteMemberCommand } = require("@aws-sdk/client-managedblockchain"); // CommonJS import + * const client = new ManagedBlockchainClient(config); + * const command = new DeleteMemberCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteMemberCommandInput} for command's `input` shape. + * @see {@link DeleteMemberCommandOutput} for command's `response` shape. + * @see {@link ManagedBlockchainClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteMemberCommand extends $Command< DeleteMemberCommandInput, diff --git a/clients/client-managedblockchain/commands/DeleteNodeCommand.ts b/clients/client-managedblockchain/commands/DeleteNodeCommand.ts index 6906284d7b72..cad47c4a79cc 100644 --- a/clients/client-managedblockchain/commands/DeleteNodeCommand.ts +++ b/clients/client-managedblockchain/commands/DeleteNodeCommand.ts @@ -27,6 +27,20 @@ export interface DeleteNodeCommandOutput extends DeleteNodeOutput, __MetadataBea /** *

Deletes a node that your AWS account owns. All data on the node is lost and cannot be recovered.

*

Applies to Hyperledger Fabric and Ethereum.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ManagedBlockchainClient, DeleteNodeCommand } from "@aws-sdk/client-managedblockchain"; // ES Modules import + * // const { ManagedBlockchainClient, DeleteNodeCommand } = require("@aws-sdk/client-managedblockchain"); // CommonJS import + * const client = new ManagedBlockchainClient(config); + * const command = new DeleteNodeCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteNodeCommandInput} for command's `input` shape. + * @see {@link DeleteNodeCommandOutput} for command's `response` shape. + * @see {@link ManagedBlockchainClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteNodeCommand extends $Command< DeleteNodeCommandInput, diff --git a/clients/client-managedblockchain/commands/GetMemberCommand.ts b/clients/client-managedblockchain/commands/GetMemberCommand.ts index eb876db4c8bf..2b1c60eda20a 100644 --- a/clients/client-managedblockchain/commands/GetMemberCommand.ts +++ b/clients/client-managedblockchain/commands/GetMemberCommand.ts @@ -27,6 +27,20 @@ export interface GetMemberCommandOutput extends GetMemberOutput, __MetadataBeare /** *

Returns detailed information about a member.

*

Applies only to Hyperledger Fabric.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ManagedBlockchainClient, GetMemberCommand } from "@aws-sdk/client-managedblockchain"; // ES Modules import + * // const { ManagedBlockchainClient, GetMemberCommand } = require("@aws-sdk/client-managedblockchain"); // CommonJS import + * const client = new ManagedBlockchainClient(config); + * const command = new GetMemberCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetMemberCommandInput} for command's `input` shape. + * @see {@link GetMemberCommandOutput} for command's `response` shape. + * @see {@link ManagedBlockchainClientResolvedConfig | config} for command's `input` shape. + * */ export class GetMemberCommand extends $Command< GetMemberCommandInput, diff --git a/clients/client-managedblockchain/commands/GetNetworkCommand.ts b/clients/client-managedblockchain/commands/GetNetworkCommand.ts index aa8cd3365cbf..5f7ec93c5a2d 100644 --- a/clients/client-managedblockchain/commands/GetNetworkCommand.ts +++ b/clients/client-managedblockchain/commands/GetNetworkCommand.ts @@ -27,6 +27,20 @@ export interface GetNetworkCommandOutput extends GetNetworkOutput, __MetadataBea /** *

Returns detailed information about a network.

*

Applies to Hyperledger Fabric and Ethereum.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ManagedBlockchainClient, GetNetworkCommand } from "@aws-sdk/client-managedblockchain"; // ES Modules import + * // const { ManagedBlockchainClient, GetNetworkCommand } = require("@aws-sdk/client-managedblockchain"); // CommonJS import + * const client = new ManagedBlockchainClient(config); + * const command = new GetNetworkCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetNetworkCommandInput} for command's `input` shape. + * @see {@link GetNetworkCommandOutput} for command's `response` shape. + * @see {@link ManagedBlockchainClientResolvedConfig | config} for command's `input` shape. + * */ export class GetNetworkCommand extends $Command< GetNetworkCommandInput, diff --git a/clients/client-managedblockchain/commands/GetNodeCommand.ts b/clients/client-managedblockchain/commands/GetNodeCommand.ts index 58a8de8dcab6..272ebae5147f 100644 --- a/clients/client-managedblockchain/commands/GetNodeCommand.ts +++ b/clients/client-managedblockchain/commands/GetNodeCommand.ts @@ -27,6 +27,20 @@ export interface GetNodeCommandOutput extends GetNodeOutput, __MetadataBearer {} /** *

Returns detailed information about a node.

*

Applies to Hyperledger Fabric and Ethereum.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ManagedBlockchainClient, GetNodeCommand } from "@aws-sdk/client-managedblockchain"; // ES Modules import + * // const { ManagedBlockchainClient, GetNodeCommand } = require("@aws-sdk/client-managedblockchain"); // CommonJS import + * const client = new ManagedBlockchainClient(config); + * const command = new GetNodeCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetNodeCommandInput} for command's `input` shape. + * @see {@link GetNodeCommandOutput} for command's `response` shape. + * @see {@link ManagedBlockchainClientResolvedConfig | config} for command's `input` shape. + * */ export class GetNodeCommand extends $Command< GetNodeCommandInput, diff --git a/clients/client-managedblockchain/commands/GetProposalCommand.ts b/clients/client-managedblockchain/commands/GetProposalCommand.ts index 00aa4c7eb38a..1fc923986b48 100644 --- a/clients/client-managedblockchain/commands/GetProposalCommand.ts +++ b/clients/client-managedblockchain/commands/GetProposalCommand.ts @@ -27,6 +27,20 @@ export interface GetProposalCommandOutput extends GetProposalOutput, __MetadataB /** *

Returns detailed information about a proposal.

*

Applies only to Hyperledger Fabric.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ManagedBlockchainClient, GetProposalCommand } from "@aws-sdk/client-managedblockchain"; // ES Modules import + * // const { ManagedBlockchainClient, GetProposalCommand } = require("@aws-sdk/client-managedblockchain"); // CommonJS import + * const client = new ManagedBlockchainClient(config); + * const command = new GetProposalCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetProposalCommandInput} for command's `input` shape. + * @see {@link GetProposalCommandOutput} for command's `response` shape. + * @see {@link ManagedBlockchainClientResolvedConfig | config} for command's `input` shape. + * */ export class GetProposalCommand extends $Command< GetProposalCommandInput, diff --git a/clients/client-managedblockchain/commands/ListInvitationsCommand.ts b/clients/client-managedblockchain/commands/ListInvitationsCommand.ts index 2d2bc17525f8..7a8fa8068957 100644 --- a/clients/client-managedblockchain/commands/ListInvitationsCommand.ts +++ b/clients/client-managedblockchain/commands/ListInvitationsCommand.ts @@ -27,6 +27,20 @@ export interface ListInvitationsCommandOutput extends ListInvitationsOutput, __M /** *

Returns a list of all invitations for the current AWS account.

*

Applies only to Hyperledger Fabric.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ManagedBlockchainClient, ListInvitationsCommand } from "@aws-sdk/client-managedblockchain"; // ES Modules import + * // const { ManagedBlockchainClient, ListInvitationsCommand } = require("@aws-sdk/client-managedblockchain"); // CommonJS import + * const client = new ManagedBlockchainClient(config); + * const command = new ListInvitationsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListInvitationsCommandInput} for command's `input` shape. + * @see {@link ListInvitationsCommandOutput} for command's `response` shape. + * @see {@link ManagedBlockchainClientResolvedConfig | config} for command's `input` shape. + * */ export class ListInvitationsCommand extends $Command< ListInvitationsCommandInput, diff --git a/clients/client-managedblockchain/commands/ListMembersCommand.ts b/clients/client-managedblockchain/commands/ListMembersCommand.ts index 46aaaa6c59d8..7123f736bd42 100644 --- a/clients/client-managedblockchain/commands/ListMembersCommand.ts +++ b/clients/client-managedblockchain/commands/ListMembersCommand.ts @@ -27,6 +27,20 @@ export interface ListMembersCommandOutput extends ListMembersOutput, __MetadataB /** *

Returns a list of the members in a network and properties of their configurations.

*

Applies only to Hyperledger Fabric.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ManagedBlockchainClient, ListMembersCommand } from "@aws-sdk/client-managedblockchain"; // ES Modules import + * // const { ManagedBlockchainClient, ListMembersCommand } = require("@aws-sdk/client-managedblockchain"); // CommonJS import + * const client = new ManagedBlockchainClient(config); + * const command = new ListMembersCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListMembersCommandInput} for command's `input` shape. + * @see {@link ListMembersCommandOutput} for command's `response` shape. + * @see {@link ManagedBlockchainClientResolvedConfig | config} for command's `input` shape. + * */ export class ListMembersCommand extends $Command< ListMembersCommandInput, diff --git a/clients/client-managedblockchain/commands/ListNetworksCommand.ts b/clients/client-managedblockchain/commands/ListNetworksCommand.ts index b230d195d25d..6862b3e34c09 100644 --- a/clients/client-managedblockchain/commands/ListNetworksCommand.ts +++ b/clients/client-managedblockchain/commands/ListNetworksCommand.ts @@ -27,6 +27,20 @@ export interface ListNetworksCommandOutput extends ListNetworksOutput, __Metadat /** *

Returns information about the networks in which the current AWS account participates.

*

Applies to Hyperledger Fabric and Ethereum.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ManagedBlockchainClient, ListNetworksCommand } from "@aws-sdk/client-managedblockchain"; // ES Modules import + * // const { ManagedBlockchainClient, ListNetworksCommand } = require("@aws-sdk/client-managedblockchain"); // CommonJS import + * const client = new ManagedBlockchainClient(config); + * const command = new ListNetworksCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListNetworksCommandInput} for command's `input` shape. + * @see {@link ListNetworksCommandOutput} for command's `response` shape. + * @see {@link ManagedBlockchainClientResolvedConfig | config} for command's `input` shape. + * */ export class ListNetworksCommand extends $Command< ListNetworksCommandInput, diff --git a/clients/client-managedblockchain/commands/ListNodesCommand.ts b/clients/client-managedblockchain/commands/ListNodesCommand.ts index 765a1bea55a0..0409130994ed 100644 --- a/clients/client-managedblockchain/commands/ListNodesCommand.ts +++ b/clients/client-managedblockchain/commands/ListNodesCommand.ts @@ -27,6 +27,20 @@ export interface ListNodesCommandOutput extends ListNodesOutput, __MetadataBeare /** *

Returns information about the nodes within a network.

*

Applies to Hyperledger Fabric and Ethereum.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ManagedBlockchainClient, ListNodesCommand } from "@aws-sdk/client-managedblockchain"; // ES Modules import + * // const { ManagedBlockchainClient, ListNodesCommand } = require("@aws-sdk/client-managedblockchain"); // CommonJS import + * const client = new ManagedBlockchainClient(config); + * const command = new ListNodesCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListNodesCommandInput} for command's `input` shape. + * @see {@link ListNodesCommandOutput} for command's `response` shape. + * @see {@link ManagedBlockchainClientResolvedConfig | config} for command's `input` shape. + * */ export class ListNodesCommand extends $Command< ListNodesCommandInput, diff --git a/clients/client-managedblockchain/commands/ListProposalVotesCommand.ts b/clients/client-managedblockchain/commands/ListProposalVotesCommand.ts index 9ab4bc2516b9..91575e342f1a 100644 --- a/clients/client-managedblockchain/commands/ListProposalVotesCommand.ts +++ b/clients/client-managedblockchain/commands/ListProposalVotesCommand.ts @@ -27,6 +27,20 @@ export interface ListProposalVotesCommandOutput extends ListProposalVotesOutput, /** *

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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ManagedBlockchainClient, ListProposalVotesCommand } from "@aws-sdk/client-managedblockchain"; // ES Modules import + * // const { ManagedBlockchainClient, ListProposalVotesCommand } = require("@aws-sdk/client-managedblockchain"); // CommonJS import + * const client = new ManagedBlockchainClient(config); + * const command = new ListProposalVotesCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListProposalVotesCommandInput} for command's `input` shape. + * @see {@link ListProposalVotesCommandOutput} for command's `response` shape. + * @see {@link ManagedBlockchainClientResolvedConfig | config} for command's `input` shape. + * */ export class ListProposalVotesCommand extends $Command< ListProposalVotesCommandInput, diff --git a/clients/client-managedblockchain/commands/ListProposalsCommand.ts b/clients/client-managedblockchain/commands/ListProposalsCommand.ts index f0162cd0e5e0..740188c488dd 100644 --- a/clients/client-managedblockchain/commands/ListProposalsCommand.ts +++ b/clients/client-managedblockchain/commands/ListProposalsCommand.ts @@ -27,6 +27,20 @@ export interface ListProposalsCommandOutput extends ListProposalsOutput, __Metad /** *

Returns a list of proposals for the network.

*

Applies only to Hyperledger Fabric.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ManagedBlockchainClient, ListProposalsCommand } from "@aws-sdk/client-managedblockchain"; // ES Modules import + * // const { ManagedBlockchainClient, ListProposalsCommand } = require("@aws-sdk/client-managedblockchain"); // CommonJS import + * const client = new ManagedBlockchainClient(config); + * const command = new ListProposalsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListProposalsCommandInput} for command's `input` shape. + * @see {@link ListProposalsCommandOutput} for command's `response` shape. + * @see {@link ManagedBlockchainClientResolvedConfig | config} for command's `input` shape. + * */ export class ListProposalsCommand extends $Command< ListProposalsCommandInput, diff --git a/clients/client-managedblockchain/commands/ListTagsForResourceCommand.ts b/clients/client-managedblockchain/commands/ListTagsForResourceCommand.ts index 54d3a1fae4e8..585b075a2577 100644 --- a/clients/client-managedblockchain/commands/ListTagsForResourceCommand.ts +++ b/clients/client-managedblockchain/commands/ListTagsForResourceCommand.ts @@ -27,6 +27,20 @@ export interface ListTagsForResourceCommandOutput extends ListTagsForResourceRes /** *

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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ManagedBlockchainClient, ListTagsForResourceCommand } from "@aws-sdk/client-managedblockchain"; // ES Modules import + * // const { ManagedBlockchainClient, ListTagsForResourceCommand } = require("@aws-sdk/client-managedblockchain"); // CommonJS import + * const client = new ManagedBlockchainClient(config); + * const command = new ListTagsForResourceCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListTagsForResourceCommandInput} for command's `input` shape. + * @see {@link ListTagsForResourceCommandOutput} for command's `response` shape. + * @see {@link ManagedBlockchainClientResolvedConfig | config} for command's `input` shape. + * */ export class ListTagsForResourceCommand extends $Command< ListTagsForResourceCommandInput, diff --git a/clients/client-managedblockchain/commands/RejectInvitationCommand.ts b/clients/client-managedblockchain/commands/RejectInvitationCommand.ts index 947682005f93..7a9b71b9a0b5 100644 --- a/clients/client-managedblockchain/commands/RejectInvitationCommand.ts +++ b/clients/client-managedblockchain/commands/RejectInvitationCommand.ts @@ -27,6 +27,20 @@ export interface RejectInvitationCommandOutput extends RejectInvitationOutput, _ /** *

Rejects an invitation to join a network. This action can be called by a principal in an AWS account that has received an invitation to create a member and join a network.

*

Applies only to Hyperledger Fabric.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ManagedBlockchainClient, RejectInvitationCommand } from "@aws-sdk/client-managedblockchain"; // ES Modules import + * // const { ManagedBlockchainClient, RejectInvitationCommand } = require("@aws-sdk/client-managedblockchain"); // CommonJS import + * const client = new ManagedBlockchainClient(config); + * const command = new RejectInvitationCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link RejectInvitationCommandInput} for command's `input` shape. + * @see {@link RejectInvitationCommandOutput} for command's `response` shape. + * @see {@link ManagedBlockchainClientResolvedConfig | config} for command's `input` shape. + * */ export class RejectInvitationCommand extends $Command< RejectInvitationCommandInput, diff --git a/clients/client-managedblockchain/commands/TagResourceCommand.ts b/clients/client-managedblockchain/commands/TagResourceCommand.ts index 472846cf20be..35bdcc497bbc 100644 --- a/clients/client-managedblockchain/commands/TagResourceCommand.ts +++ b/clients/client-managedblockchain/commands/TagResourceCommand.ts @@ -29,6 +29,20 @@ export interface TagResourceCommandOutput extends TagResourceResponse, __Metadat *

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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ManagedBlockchainClient, TagResourceCommand } from "@aws-sdk/client-managedblockchain"; // ES Modules import + * // const { ManagedBlockchainClient, TagResourceCommand } = require("@aws-sdk/client-managedblockchain"); // CommonJS import + * const client = new ManagedBlockchainClient(config); + * const command = new TagResourceCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link TagResourceCommandInput} for command's `input` shape. + * @see {@link TagResourceCommandOutput} for command's `response` shape. + * @see {@link ManagedBlockchainClientResolvedConfig | config} for command's `input` shape. + * */ export class TagResourceCommand extends $Command< TagResourceCommandInput, diff --git a/clients/client-managedblockchain/commands/UntagResourceCommand.ts b/clients/client-managedblockchain/commands/UntagResourceCommand.ts index aee74a756ada..ba44033bf19f 100644 --- a/clients/client-managedblockchain/commands/UntagResourceCommand.ts +++ b/clients/client-managedblockchain/commands/UntagResourceCommand.ts @@ -27,6 +27,20 @@ export interface UntagResourceCommandOutput extends UntagResourceResponse, __Met /** *

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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ManagedBlockchainClient, UntagResourceCommand } from "@aws-sdk/client-managedblockchain"; // ES Modules import + * // const { ManagedBlockchainClient, UntagResourceCommand } = require("@aws-sdk/client-managedblockchain"); // CommonJS import + * const client = new ManagedBlockchainClient(config); + * const command = new UntagResourceCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link UntagResourceCommandInput} for command's `input` shape. + * @see {@link UntagResourceCommandOutput} for command's `response` shape. + * @see {@link ManagedBlockchainClientResolvedConfig | config} for command's `input` shape. + * */ export class UntagResourceCommand extends $Command< UntagResourceCommandInput, diff --git a/clients/client-managedblockchain/commands/UpdateMemberCommand.ts b/clients/client-managedblockchain/commands/UpdateMemberCommand.ts index 44c4d7fd54b3..9a518becb15c 100644 --- a/clients/client-managedblockchain/commands/UpdateMemberCommand.ts +++ b/clients/client-managedblockchain/commands/UpdateMemberCommand.ts @@ -27,6 +27,20 @@ export interface UpdateMemberCommandOutput extends UpdateMemberOutput, __Metadat /** *

Updates a member configuration with new parameters.

*

Applies only to Hyperledger Fabric.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ManagedBlockchainClient, UpdateMemberCommand } from "@aws-sdk/client-managedblockchain"; // ES Modules import + * // const { ManagedBlockchainClient, UpdateMemberCommand } = require("@aws-sdk/client-managedblockchain"); // CommonJS import + * const client = new ManagedBlockchainClient(config); + * const command = new UpdateMemberCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link UpdateMemberCommandInput} for command's `input` shape. + * @see {@link UpdateMemberCommandOutput} for command's `response` shape. + * @see {@link ManagedBlockchainClientResolvedConfig | config} for command's `input` shape. + * */ export class UpdateMemberCommand extends $Command< UpdateMemberCommandInput, diff --git a/clients/client-managedblockchain/commands/UpdateNodeCommand.ts b/clients/client-managedblockchain/commands/UpdateNodeCommand.ts index 1f21f003a4e6..aff435ec3338 100644 --- a/clients/client-managedblockchain/commands/UpdateNodeCommand.ts +++ b/clients/client-managedblockchain/commands/UpdateNodeCommand.ts @@ -27,6 +27,20 @@ export interface UpdateNodeCommandOutput extends UpdateNodeOutput, __MetadataBea /** *

Updates a node configuration with new parameters.

*

Applies only to Hyperledger Fabric.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ManagedBlockchainClient, UpdateNodeCommand } from "@aws-sdk/client-managedblockchain"; // ES Modules import + * // const { ManagedBlockchainClient, UpdateNodeCommand } = require("@aws-sdk/client-managedblockchain"); // CommonJS import + * const client = new ManagedBlockchainClient(config); + * const command = new UpdateNodeCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link UpdateNodeCommandInput} for command's `input` shape. + * @see {@link UpdateNodeCommandOutput} for command's `response` shape. + * @see {@link ManagedBlockchainClientResolvedConfig | config} for command's `input` shape. + * */ export class UpdateNodeCommand extends $Command< UpdateNodeCommandInput, diff --git a/clients/client-managedblockchain/commands/VoteOnProposalCommand.ts b/clients/client-managedblockchain/commands/VoteOnProposalCommand.ts index e9018b831e6f..f0940226adab 100644 --- a/clients/client-managedblockchain/commands/VoteOnProposalCommand.ts +++ b/clients/client-managedblockchain/commands/VoteOnProposalCommand.ts @@ -27,6 +27,20 @@ export interface VoteOnProposalCommandOutput extends VoteOnProposalOutput, __Met /** *

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 AWS account as the principal that calls the action.

*

Applies only to Hyperledger Fabric.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ManagedBlockchainClient, VoteOnProposalCommand } from "@aws-sdk/client-managedblockchain"; // ES Modules import + * // const { ManagedBlockchainClient, VoteOnProposalCommand } = require("@aws-sdk/client-managedblockchain"); // CommonJS import + * const client = new ManagedBlockchainClient(config); + * const command = new VoteOnProposalCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link VoteOnProposalCommandInput} for command's `input` shape. + * @see {@link VoteOnProposalCommandOutput} for command's `response` shape. + * @see {@link ManagedBlockchainClientResolvedConfig | config} for command's `input` shape. + * */ export class VoteOnProposalCommand extends $Command< VoteOnProposalCommandInput, diff --git a/clients/client-managedblockchain/models/models_0.ts b/clients/client-managedblockchain/models/models_0.ts index ceada9d019dc..edf349a085a1 100644 --- a/clients/client-managedblockchain/models/models_0.ts +++ b/clients/client-managedblockchain/models/models_0.ts @@ -11,6 +11,9 @@ export interface AccessDeniedException extends __SmithyException, $MetadataBeare } export namespace AccessDeniedException { + /** + * @internal + */ export const filterSensitiveLog = (obj: AccessDeniedException): any => ({ ...obj, }); @@ -43,6 +46,9 @@ export interface ApprovalThresholdPolicy { } export namespace ApprovalThresholdPolicy { + /** + * @internal + */ export const filterSensitiveLog = (obj: ApprovalThresholdPolicy): any => ({ ...obj, }); @@ -64,6 +70,9 @@ export interface MemberFabricConfiguration { } export namespace MemberFabricConfiguration { + /** + * @internal + */ export const filterSensitiveLog = (obj: MemberFabricConfiguration): any => ({ ...obj, ...(obj.AdminPassword && { AdminPassword: SENSITIVE_STRING }), @@ -81,6 +90,9 @@ export interface MemberFrameworkConfiguration { } export namespace MemberFrameworkConfiguration { + /** + * @internal + */ export const filterSensitiveLog = (obj: MemberFrameworkConfiguration): any => ({ ...obj, ...(obj.Fabric && { Fabric: MemberFabricConfiguration.filterSensitiveLog(obj.Fabric) }), @@ -98,6 +110,9 @@ export interface LogConfiguration { } export namespace LogConfiguration { + /** + * @internal + */ export const filterSensitiveLog = (obj: LogConfiguration): any => ({ ...obj, }); @@ -114,6 +129,9 @@ export interface LogConfigurations { } export namespace LogConfigurations { + /** + * @internal + */ export const filterSensitiveLog = (obj: LogConfigurations): any => ({ ...obj, }); @@ -130,6 +148,9 @@ export interface MemberFabricLogPublishingConfiguration { } export namespace MemberFabricLogPublishingConfiguration { + /** + * @internal + */ export const filterSensitiveLog = (obj: MemberFabricLogPublishingConfiguration): any => ({ ...obj, }); @@ -146,6 +167,9 @@ export interface MemberLogPublishingConfiguration { } export namespace MemberLogPublishingConfiguration { + /** + * @internal + */ export const filterSensitiveLog = (obj: MemberLogPublishingConfiguration): any => ({ ...obj, }); @@ -184,6 +208,9 @@ export interface MemberConfiguration { } export namespace MemberConfiguration { + /** + * @internal + */ export const filterSensitiveLog = (obj: MemberConfiguration): any => ({ ...obj, ...(obj.FrameworkConfiguration && { @@ -215,6 +242,9 @@ export interface CreateMemberInput { } export namespace CreateMemberInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateMemberInput): any => ({ ...obj, ...(obj.MemberConfiguration && { @@ -231,6 +261,9 @@ export interface CreateMemberOutput { } export namespace CreateMemberOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateMemberOutput): any => ({ ...obj, }); @@ -245,6 +278,9 @@ export interface InternalServiceErrorException extends __SmithyException, $Metad } export namespace InternalServiceErrorException { + /** + * @internal + */ export const filterSensitiveLog = (obj: InternalServiceErrorException): any => ({ ...obj, }); @@ -260,6 +296,9 @@ export interface InvalidRequestException extends __SmithyException, $MetadataBea } export namespace InvalidRequestException { + /** + * @internal + */ export const filterSensitiveLog = (obj: InvalidRequestException): any => ({ ...obj, }); @@ -275,6 +314,9 @@ export interface ResourceAlreadyExistsException extends __SmithyException, $Meta } export namespace ResourceAlreadyExistsException { + /** + * @internal + */ export const filterSensitiveLog = (obj: ResourceAlreadyExistsException): any => ({ ...obj, }); @@ -290,6 +332,9 @@ export interface ResourceLimitExceededException extends __SmithyException, $Meta } export namespace ResourceLimitExceededException { + /** + * @internal + */ export const filterSensitiveLog = (obj: ResourceLimitExceededException): any => ({ ...obj, }); @@ -309,6 +354,9 @@ export interface ResourceNotFoundException extends __SmithyException, $MetadataB } export namespace ResourceNotFoundException { + /** + * @internal + */ export const filterSensitiveLog = (obj: ResourceNotFoundException): any => ({ ...obj, }); @@ -324,6 +372,9 @@ export interface ResourceNotReadyException extends __SmithyException, $MetadataB } export namespace ResourceNotReadyException { + /** + * @internal + */ export const filterSensitiveLog = (obj: ResourceNotReadyException): any => ({ ...obj, }); @@ -338,6 +389,9 @@ export interface ThrottlingException extends __SmithyException, $MetadataBearer } export namespace ThrottlingException { + /** + * @internal + */ export const filterSensitiveLog = (obj: ThrottlingException): any => ({ ...obj, }); @@ -357,6 +411,9 @@ export interface TooManyTagsException extends __SmithyException, $MetadataBearer } export namespace TooManyTagsException { + /** + * @internal + */ export const filterSensitiveLog = (obj: TooManyTagsException): any => ({ ...obj, }); @@ -383,6 +440,9 @@ export interface NetworkFabricConfiguration { } export namespace NetworkFabricConfiguration { + /** + * @internal + */ export const filterSensitiveLog = (obj: NetworkFabricConfiguration): any => ({ ...obj, }); @@ -403,6 +463,9 @@ export interface NetworkFrameworkConfiguration { } export namespace NetworkFrameworkConfiguration { + /** + * @internal + */ export const filterSensitiveLog = (obj: NetworkFrameworkConfiguration): any => ({ ...obj, }); @@ -422,6 +485,9 @@ export interface VotingPolicy { } export namespace VotingPolicy { + /** + * @internal + */ export const filterSensitiveLog = (obj: VotingPolicy): any => ({ ...obj, }); @@ -481,6 +547,9 @@ export interface CreateNetworkInput { } export namespace CreateNetworkInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateNetworkInput): any => ({ ...obj, ...(obj.MemberConfiguration && { @@ -502,6 +571,9 @@ export interface CreateNetworkOutput { } export namespace CreateNetworkOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateNetworkOutput): any => ({ ...obj, }); @@ -523,6 +595,9 @@ export interface NodeFabricLogPublishingConfiguration { } export namespace NodeFabricLogPublishingConfiguration { + /** + * @internal + */ export const filterSensitiveLog = (obj: NodeFabricLogPublishingConfiguration): any => ({ ...obj, }); @@ -539,6 +614,9 @@ export interface NodeLogPublishingConfiguration { } export namespace NodeLogPublishingConfiguration { + /** + * @internal + */ export const filterSensitiveLog = (obj: NodeLogPublishingConfiguration): any => ({ ...obj, }); @@ -577,6 +655,9 @@ export interface NodeConfiguration { } export namespace NodeConfiguration { + /** + * @internal + */ export const filterSensitiveLog = (obj: NodeConfiguration): any => ({ ...obj, }); @@ -631,6 +712,9 @@ export interface CreateNodeInput { } export namespace CreateNodeInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateNodeInput): any => ({ ...obj, }); @@ -644,6 +728,9 @@ export interface CreateNodeOutput { } export namespace CreateNodeOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateNodeOutput): any => ({ ...obj, }); @@ -661,6 +748,9 @@ export interface InviteAction { } export namespace InviteAction { + /** + * @internal + */ export const filterSensitiveLog = (obj: InviteAction): any => ({ ...obj, }); @@ -678,6 +768,9 @@ export interface RemoveAction { } export namespace RemoveAction { + /** + * @internal + */ export const filterSensitiveLog = (obj: RemoveAction): any => ({ ...obj, }); @@ -706,6 +799,9 @@ export interface ProposalActions { } export namespace ProposalActions { + /** + * @internal + */ export const filterSensitiveLog = (obj: ProposalActions): any => ({ ...obj, }); @@ -747,6 +843,9 @@ export interface CreateProposalInput { } export namespace CreateProposalInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateProposalInput): any => ({ ...obj, }); @@ -760,6 +859,9 @@ export interface CreateProposalOutput { } export namespace CreateProposalOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateProposalOutput): any => ({ ...obj, }); @@ -778,6 +880,9 @@ export interface DeleteMemberInput { } export namespace DeleteMemberInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteMemberInput): any => ({ ...obj, }); @@ -786,6 +891,9 @@ export namespace DeleteMemberInput { export interface DeleteMemberOutput {} export namespace DeleteMemberOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteMemberOutput): any => ({ ...obj, }); @@ -828,6 +936,9 @@ export interface DeleteNodeInput { } export namespace DeleteNodeInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteNodeInput): any => ({ ...obj, }); @@ -836,6 +947,9 @@ export namespace DeleteNodeInput { export interface DeleteNodeOutput {} export namespace DeleteNodeOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteNodeOutput): any => ({ ...obj, }); @@ -854,6 +968,9 @@ export interface GetMemberInput { } export namespace GetMemberInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetMemberInput): any => ({ ...obj, }); @@ -875,6 +992,9 @@ export interface MemberFabricAttributes { } export namespace MemberFabricAttributes { + /** + * @internal + */ export const filterSensitiveLog = (obj: MemberFabricAttributes): any => ({ ...obj, }); @@ -891,6 +1011,9 @@ export interface MemberFrameworkAttributes { } export namespace MemberFrameworkAttributes { + /** + * @internal + */ export const filterSensitiveLog = (obj: MemberFrameworkAttributes): any => ({ ...obj, }); @@ -986,6 +1109,9 @@ export interface Member { } export namespace Member { + /** + * @internal + */ export const filterSensitiveLog = (obj: Member): any => ({ ...obj, }); @@ -999,6 +1125,9 @@ export interface GetMemberOutput { } export namespace GetMemberOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetMemberOutput): any => ({ ...obj, }); @@ -1012,6 +1141,9 @@ export interface GetNetworkInput { } export namespace GetNetworkInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetNetworkInput): any => ({ ...obj, }); @@ -1042,6 +1174,9 @@ export interface NetworkEthereumAttributes { } export namespace NetworkEthereumAttributes { + /** + * @internal + */ export const filterSensitiveLog = (obj: NetworkEthereumAttributes): any => ({ ...obj, }); @@ -1063,6 +1198,9 @@ export interface NetworkFabricAttributes { } export namespace NetworkFabricAttributes { + /** + * @internal + */ export const filterSensitiveLog = (obj: NetworkFabricAttributes): any => ({ ...obj, }); @@ -1084,6 +1222,9 @@ export interface NetworkFrameworkAttributes { } export namespace NetworkFrameworkAttributes { + /** + * @internal + */ export const filterSensitiveLog = (obj: NetworkFrameworkAttributes): any => ({ ...obj, }); @@ -1164,6 +1305,9 @@ export interface Network { } export namespace Network { + /** + * @internal + */ export const filterSensitiveLog = (obj: Network): any => ({ ...obj, }); @@ -1177,6 +1321,9 @@ export interface GetNetworkOutput { } export namespace GetNetworkOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetNetworkOutput): any => ({ ...obj, }); @@ -1201,6 +1348,9 @@ export interface GetNodeInput { } export namespace GetNodeInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetNodeInput): any => ({ ...obj, }); @@ -1222,6 +1372,9 @@ export interface NodeEthereumAttributes { } export namespace NodeEthereumAttributes { + /** + * @internal + */ export const filterSensitiveLog = (obj: NodeEthereumAttributes): any => ({ ...obj, }); @@ -1243,6 +1396,9 @@ export interface NodeFabricAttributes { } export namespace NodeFabricAttributes { + /** + * @internal + */ export const filterSensitiveLog = (obj: NodeFabricAttributes): any => ({ ...obj, }); @@ -1264,6 +1420,9 @@ export interface NodeFrameworkAttributes { } export namespace NodeFrameworkAttributes { + /** + * @internal + */ export const filterSensitiveLog = (obj: NodeFrameworkAttributes): any => ({ ...obj, }); @@ -1349,6 +1508,9 @@ export interface Node { } export namespace Node { + /** + * @internal + */ export const filterSensitiveLog = (obj: Node): any => ({ ...obj, }); @@ -1362,6 +1524,9 @@ export interface GetNodeOutput { } export namespace GetNodeOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetNodeOutput): any => ({ ...obj, }); @@ -1380,6 +1545,9 @@ export interface GetProposalInput { } export namespace GetProposalInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetProposalInput): any => ({ ...obj, }); @@ -1503,6 +1671,9 @@ export interface Proposal { } export namespace Proposal { + /** + * @internal + */ export const filterSensitiveLog = (obj: Proposal): any => ({ ...obj, }); @@ -1516,6 +1687,9 @@ export interface GetProposalOutput { } export namespace GetProposalOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetProposalOutput): any => ({ ...obj, }); @@ -1531,6 +1705,9 @@ export interface IllegalActionException extends __SmithyException, $MetadataBear } export namespace IllegalActionException { + /** + * @internal + */ export const filterSensitiveLog = (obj: IllegalActionException): any => ({ ...obj, }); @@ -1582,6 +1759,9 @@ export interface NetworkSummary { } export namespace NetworkSummary { + /** + * @internal + */ export const filterSensitiveLog = (obj: NetworkSummary): any => ({ ...obj, }); @@ -1654,6 +1834,9 @@ export interface Invitation { } export namespace Invitation { + /** + * @internal + */ export const filterSensitiveLog = (obj: Invitation): any => ({ ...obj, }); @@ -1672,6 +1855,9 @@ export interface ListInvitationsInput { } export namespace ListInvitationsInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListInvitationsInput): any => ({ ...obj, }); @@ -1690,6 +1876,9 @@ export interface ListInvitationsOutput { } export namespace ListInvitationsOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListInvitationsOutput): any => ({ ...obj, }); @@ -1730,6 +1919,9 @@ export interface ListMembersInput { } export namespace ListMembersInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListMembersInput): any => ({ ...obj, }); @@ -1801,6 +1993,9 @@ export interface MemberSummary { } export namespace MemberSummary { + /** + * @internal + */ export const filterSensitiveLog = (obj: MemberSummary): any => ({ ...obj, }); @@ -1819,6 +2014,9 @@ export interface ListMembersOutput { } export namespace ListMembersOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListMembersOutput): any => ({ ...obj, }); @@ -1853,6 +2051,9 @@ export interface ListNetworksInput { } export namespace ListNetworksInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListNetworksInput): any => ({ ...obj, }); @@ -1871,6 +2072,9 @@ export interface ListNetworksOutput { } export namespace ListNetworksOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListNetworksOutput): any => ({ ...obj, }); @@ -1905,6 +2109,9 @@ export interface ListNodesInput { } export namespace ListNodesInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListNodesInput): any => ({ ...obj, }); @@ -1946,6 +2153,9 @@ export interface NodeSummary { } export namespace NodeSummary { + /** + * @internal + */ export const filterSensitiveLog = (obj: NodeSummary): any => ({ ...obj, }); @@ -1964,6 +2174,9 @@ export interface ListNodesOutput { } export namespace ListNodesOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListNodesOutput): any => ({ ...obj, }); @@ -1993,6 +2206,9 @@ export interface ListProposalsInput { } export namespace ListProposalsInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListProposalsInput): any => ({ ...obj, }); @@ -2079,6 +2295,9 @@ export interface ProposalSummary { } export namespace ProposalSummary { + /** + * @internal + */ export const filterSensitiveLog = (obj: ProposalSummary): any => ({ ...obj, }); @@ -2097,6 +2316,9 @@ export interface ListProposalsOutput { } export namespace ListProposalsOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListProposalsOutput): any => ({ ...obj, }); @@ -2133,6 +2355,9 @@ export interface ListProposalVotesInput { } export namespace ListProposalVotesInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListProposalVotesInput): any => ({ ...obj, }); @@ -2173,6 +2398,9 @@ export interface VoteSummary { } export namespace VoteSummary { + /** + * @internal + */ export const filterSensitiveLog = (obj: VoteSummary): any => ({ ...obj, }); @@ -2195,6 +2423,9 @@ export interface ListProposalVotesOutput { } export namespace ListProposalVotesOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListProposalVotesOutput): any => ({ ...obj, }); @@ -2208,6 +2439,9 @@ export interface ListTagsForResourceRequest { } export namespace ListTagsForResourceRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListTagsForResourceRequest): any => ({ ...obj, }); @@ -2221,6 +2455,9 @@ export interface ListTagsForResourceResponse { } export namespace ListTagsForResourceResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListTagsForResourceResponse): any => ({ ...obj, }); @@ -2234,6 +2471,9 @@ export interface RejectInvitationInput { } export namespace RejectInvitationInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: RejectInvitationInput): any => ({ ...obj, }); @@ -2242,6 +2482,9 @@ export namespace RejectInvitationInput { export interface RejectInvitationOutput {} export namespace RejectInvitationOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: RejectInvitationOutput): any => ({ ...obj, }); @@ -2260,6 +2503,9 @@ export interface TagResourceRequest { } export namespace TagResourceRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: TagResourceRequest): any => ({ ...obj, }); @@ -2268,6 +2514,9 @@ export namespace TagResourceRequest { export interface TagResourceResponse {} export namespace TagResourceResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: TagResourceResponse): any => ({ ...obj, }); @@ -2286,6 +2535,9 @@ export interface UntagResourceRequest { } export namespace UntagResourceRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: UntagResourceRequest): any => ({ ...obj, }); @@ -2294,6 +2546,9 @@ export namespace UntagResourceRequest { export interface UntagResourceResponse {} export namespace UntagResourceResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: UntagResourceResponse): any => ({ ...obj, }); @@ -2317,6 +2572,9 @@ export interface UpdateMemberInput { } export namespace UpdateMemberInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateMemberInput): any => ({ ...obj, }); @@ -2325,6 +2583,9 @@ export namespace UpdateMemberInput { export interface UpdateMemberOutput {} export namespace UpdateMemberOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateMemberOutput): any => ({ ...obj, }); @@ -2354,6 +2615,9 @@ export interface UpdateNodeInput { } export namespace UpdateNodeInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateNodeInput): any => ({ ...obj, }); @@ -2362,6 +2626,9 @@ export namespace UpdateNodeInput { export interface UpdateNodeOutput {} export namespace UpdateNodeOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateNodeOutput): any => ({ ...obj, }); @@ -2397,6 +2664,9 @@ export interface VoteOnProposalInput { } export namespace VoteOnProposalInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: VoteOnProposalInput): any => ({ ...obj, }); @@ -2405,6 +2675,9 @@ export namespace VoteOnProposalInput { export interface VoteOnProposalOutput {} export namespace VoteOnProposalOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: VoteOnProposalOutput): any => ({ ...obj, }); diff --git a/clients/client-marketplace-catalog/commands/CancelChangeSetCommand.ts b/clients/client-marketplace-catalog/commands/CancelChangeSetCommand.ts index b8e5e10c57d7..0bdccf2391a9 100644 --- a/clients/client-marketplace-catalog/commands/CancelChangeSetCommand.ts +++ b/clients/client-marketplace-catalog/commands/CancelChangeSetCommand.ts @@ -29,6 +29,20 @@ export interface CancelChangeSetCommandOutput extends CancelChangeSetResponse, _ * 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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { MarketplaceCatalogClient, CancelChangeSetCommand } from "@aws-sdk/client-marketplace-catalog"; // ES Modules import + * // const { MarketplaceCatalogClient, CancelChangeSetCommand } = require("@aws-sdk/client-marketplace-catalog"); // CommonJS import + * const client = new MarketplaceCatalogClient(config); + * const command = new CancelChangeSetCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CancelChangeSetCommandInput} for command's `input` shape. + * @see {@link CancelChangeSetCommandOutput} for command's `response` shape. + * @see {@link MarketplaceCatalogClientResolvedConfig | config} for command's `input` shape. + * */ export class CancelChangeSetCommand extends $Command< CancelChangeSetCommandInput, diff --git a/clients/client-marketplace-catalog/commands/DescribeChangeSetCommand.ts b/clients/client-marketplace-catalog/commands/DescribeChangeSetCommand.ts index f7c76ee7147e..a6345bdb71e2 100644 --- a/clients/client-marketplace-catalog/commands/DescribeChangeSetCommand.ts +++ b/clients/client-marketplace-catalog/commands/DescribeChangeSetCommand.ts @@ -26,6 +26,20 @@ export interface DescribeChangeSetCommandOutput extends DescribeChangeSetRespons /** *

Provides information about a given change set.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { MarketplaceCatalogClient, DescribeChangeSetCommand } from "@aws-sdk/client-marketplace-catalog"; // ES Modules import + * // const { MarketplaceCatalogClient, DescribeChangeSetCommand } = require("@aws-sdk/client-marketplace-catalog"); // CommonJS import + * const client = new MarketplaceCatalogClient(config); + * const command = new DescribeChangeSetCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeChangeSetCommandInput} for command's `input` shape. + * @see {@link DescribeChangeSetCommandOutput} for command's `response` shape. + * @see {@link MarketplaceCatalogClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeChangeSetCommand extends $Command< DescribeChangeSetCommandInput, diff --git a/clients/client-marketplace-catalog/commands/DescribeEntityCommand.ts b/clients/client-marketplace-catalog/commands/DescribeEntityCommand.ts index 021f5eb5ca9a..2f6e52215d38 100644 --- a/clients/client-marketplace-catalog/commands/DescribeEntityCommand.ts +++ b/clients/client-marketplace-catalog/commands/DescribeEntityCommand.ts @@ -26,6 +26,20 @@ export interface DescribeEntityCommandOutput extends DescribeEntityResponse, __M /** *

Returns the metadata and content of the entity.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { MarketplaceCatalogClient, DescribeEntityCommand } from "@aws-sdk/client-marketplace-catalog"; // ES Modules import + * // const { MarketplaceCatalogClient, DescribeEntityCommand } = require("@aws-sdk/client-marketplace-catalog"); // CommonJS import + * const client = new MarketplaceCatalogClient(config); + * const command = new DescribeEntityCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeEntityCommandInput} for command's `input` shape. + * @see {@link DescribeEntityCommandOutput} for command's `response` shape. + * @see {@link MarketplaceCatalogClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeEntityCommand extends $Command< DescribeEntityCommandInput, diff --git a/clients/client-marketplace-catalog/commands/ListChangeSetsCommand.ts b/clients/client-marketplace-catalog/commands/ListChangeSetsCommand.ts index f81c119d060b..ceb95ea6b2a4 100644 --- a/clients/client-marketplace-catalog/commands/ListChangeSetsCommand.ts +++ b/clients/client-marketplace-catalog/commands/ListChangeSetsCommand.ts @@ -32,6 +32,20 @@ export interface ListChangeSetsCommandOutput extends ListChangeSetsResponse, __M * *

You can describe a change during the 60-day request history retention period for API * calls.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { MarketplaceCatalogClient, ListChangeSetsCommand } from "@aws-sdk/client-marketplace-catalog"; // ES Modules import + * // const { MarketplaceCatalogClient, ListChangeSetsCommand } = require("@aws-sdk/client-marketplace-catalog"); // CommonJS import + * const client = new MarketplaceCatalogClient(config); + * const command = new ListChangeSetsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListChangeSetsCommandInput} for command's `input` shape. + * @see {@link ListChangeSetsCommandOutput} for command's `response` shape. + * @see {@link MarketplaceCatalogClientResolvedConfig | config} for command's `input` shape. + * */ export class ListChangeSetsCommand extends $Command< ListChangeSetsCommandInput, diff --git a/clients/client-marketplace-catalog/commands/ListEntitiesCommand.ts b/clients/client-marketplace-catalog/commands/ListEntitiesCommand.ts index d3f42e7cc1f5..b78b03e20753 100644 --- a/clients/client-marketplace-catalog/commands/ListEntitiesCommand.ts +++ b/clients/client-marketplace-catalog/commands/ListEntitiesCommand.ts @@ -26,6 +26,20 @@ export interface ListEntitiesCommandOutput extends ListEntitiesResponse, __Metad /** *

Provides the list of entities of a given type.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { MarketplaceCatalogClient, ListEntitiesCommand } from "@aws-sdk/client-marketplace-catalog"; // ES Modules import + * // const { MarketplaceCatalogClient, ListEntitiesCommand } = require("@aws-sdk/client-marketplace-catalog"); // CommonJS import + * const client = new MarketplaceCatalogClient(config); + * const command = new ListEntitiesCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListEntitiesCommandInput} for command's `input` shape. + * @see {@link ListEntitiesCommandOutput} for command's `response` shape. + * @see {@link MarketplaceCatalogClientResolvedConfig | config} for command's `input` shape. + * */ export class ListEntitiesCommand extends $Command< ListEntitiesCommandInput, diff --git a/clients/client-marketplace-catalog/commands/StartChangeSetCommand.ts b/clients/client-marketplace-catalog/commands/StartChangeSetCommand.ts index 72316b2e7d54..f5f070c93084 100644 --- a/clients/client-marketplace-catalog/commands/StartChangeSetCommand.ts +++ b/clients/client-marketplace-catalog/commands/StartChangeSetCommand.ts @@ -36,6 +36,20 @@ export interface StartChangeSetCommandOutput extends StartChangeSetResponse, __M *

For example, you cannot start the ChangeSet described in the example below because it contains two changes to execute the same change * type (AddRevisions) against the same entity * (entity-id@1).

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { MarketplaceCatalogClient, StartChangeSetCommand } from "@aws-sdk/client-marketplace-catalog"; // ES Modules import + * // const { MarketplaceCatalogClient, StartChangeSetCommand } = require("@aws-sdk/client-marketplace-catalog"); // CommonJS import + * const client = new MarketplaceCatalogClient(config); + * const command = new StartChangeSetCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link StartChangeSetCommandInput} for command's `input` shape. + * @see {@link StartChangeSetCommandOutput} for command's `response` shape. + * @see {@link MarketplaceCatalogClientResolvedConfig | config} for command's `input` shape. + * */ export class StartChangeSetCommand extends $Command< StartChangeSetCommandInput, diff --git a/clients/client-marketplace-catalog/models/models_0.ts b/clients/client-marketplace-catalog/models/models_0.ts index 44a6405e28f6..94b7406d6556 100644 --- a/clients/client-marketplace-catalog/models/models_0.ts +++ b/clients/client-marketplace-catalog/models/models_0.ts @@ -11,6 +11,9 @@ export interface AccessDeniedException extends __SmithyException, $MetadataBeare } export namespace AccessDeniedException { + /** + * @internal + */ export const filterSensitiveLog = (obj: AccessDeniedException): any => ({ ...obj, }); @@ -31,6 +34,9 @@ export interface CancelChangeSetRequest { } export namespace CancelChangeSetRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: CancelChangeSetRequest): any => ({ ...obj, }); @@ -49,6 +55,9 @@ export interface CancelChangeSetResponse { } export namespace CancelChangeSetResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: CancelChangeSetResponse): any => ({ ...obj, }); @@ -64,6 +73,9 @@ export interface InternalServiceException extends __SmithyException, $MetadataBe } export namespace InternalServiceException { + /** + * @internal + */ export const filterSensitiveLog = (obj: InternalServiceException): any => ({ ...obj, }); @@ -79,6 +91,9 @@ export interface ResourceInUseException extends __SmithyException, $MetadataBear } export namespace ResourceInUseException { + /** + * @internal + */ export const filterSensitiveLog = (obj: ResourceInUseException): any => ({ ...obj, }); @@ -94,6 +109,9 @@ export interface ResourceNotFoundException extends __SmithyException, $MetadataB } export namespace ResourceNotFoundException { + /** + * @internal + */ export const filterSensitiveLog = (obj: ResourceNotFoundException): any => ({ ...obj, }); @@ -109,6 +127,9 @@ export interface ThrottlingException extends __SmithyException, $MetadataBearer } export namespace ThrottlingException { + /** + * @internal + */ export const filterSensitiveLog = (obj: ThrottlingException): any => ({ ...obj, }); @@ -124,6 +145,9 @@ export interface ValidationException extends __SmithyException, $MetadataBearer } export namespace ValidationException { + /** + * @internal + */ export const filterSensitiveLog = (obj: ValidationException): any => ({ ...obj, }); @@ -145,6 +169,9 @@ export interface DescribeChangeSetRequest { } export namespace DescribeChangeSetRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeChangeSetRequest): any => ({ ...obj, }); @@ -167,6 +194,9 @@ export interface Entity { } export namespace Entity { + /** + * @internal + */ export const filterSensitiveLog = (obj: Entity): any => ({ ...obj, }); @@ -188,6 +218,9 @@ export interface ErrorDetail { } export namespace ErrorDetail { + /** + * @internal + */ export const filterSensitiveLog = (obj: ErrorDetail): any => ({ ...obj, }); @@ -221,6 +254,9 @@ export interface ChangeSummary { } export namespace ChangeSummary { + /** + * @internal + */ export const filterSensitiveLog = (obj: ChangeSummary): any => ({ ...obj, }); @@ -296,6 +332,9 @@ export interface DescribeChangeSetResponse { } export namespace DescribeChangeSetResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeChangeSetResponse): any => ({ ...obj, }); @@ -316,6 +355,9 @@ export interface DescribeEntityRequest { } export namespace DescribeEntityRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeEntityRequest): any => ({ ...obj, }); @@ -352,6 +394,9 @@ export interface DescribeEntityResponse { } export namespace DescribeEntityResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeEntityResponse): any => ({ ...obj, }); @@ -367,6 +412,9 @@ export interface ResourceNotSupportedException extends __SmithyException, $Metad } export namespace ResourceNotSupportedException { + /** + * @internal + */ export const filterSensitiveLog = (obj: ResourceNotSupportedException): any => ({ ...obj, }); @@ -434,6 +482,9 @@ export interface Filter { } export namespace Filter { + /** + * @internal + */ export const filterSensitiveLog = (obj: Filter): any => ({ ...obj, }); @@ -467,6 +518,9 @@ export interface Sort { } export namespace Sort { + /** + * @internal + */ export const filterSensitiveLog = (obj: Sort): any => ({ ...obj, }); @@ -505,6 +559,9 @@ export interface ListChangeSetsRequest { } export namespace ListChangeSetsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListChangeSetsRequest): any => ({ ...obj, }); @@ -564,6 +621,9 @@ export interface ChangeSetSummaryListItem { } export namespace ChangeSetSummaryListItem { + /** + * @internal + */ export const filterSensitiveLog = (obj: ChangeSetSummaryListItem): any => ({ ...obj, }); @@ -582,6 +642,9 @@ export interface ListChangeSetsResponse { } export namespace ListChangeSetsResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListChangeSetsResponse): any => ({ ...obj, }); @@ -624,6 +687,9 @@ export interface ListEntitiesRequest { } export namespace ListEntitiesRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListEntitiesRequest): any => ({ ...obj, }); @@ -676,6 +742,9 @@ export interface EntitySummary { } export namespace EntitySummary { + /** + * @internal + */ export const filterSensitiveLog = (obj: EntitySummary): any => ({ ...obj, }); @@ -694,6 +763,9 @@ export interface ListEntitiesResponse { } export namespace ListEntitiesResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListEntitiesResponse): any => ({ ...obj, }); @@ -709,6 +781,9 @@ export interface ServiceQuotaExceededException extends __SmithyException, $Metad } export namespace ServiceQuotaExceededException { + /** + * @internal + */ export const filterSensitiveLog = (obj: ServiceQuotaExceededException): any => ({ ...obj, }); @@ -739,6 +814,9 @@ export interface Change { } export namespace Change { + /** + * @internal + */ export const filterSensitiveLog = (obj: Change): any => ({ ...obj, }); @@ -769,6 +847,9 @@ export interface StartChangeSetRequest { } export namespace StartChangeSetRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: StartChangeSetRequest): any => ({ ...obj, }); @@ -787,6 +868,9 @@ export interface StartChangeSetResponse { } export namespace StartChangeSetResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: StartChangeSetResponse): any => ({ ...obj, }); diff --git a/clients/client-marketplace-commerce-analytics/commands/GenerateDataSetCommand.ts b/clients/client-marketplace-commerce-analytics/commands/GenerateDataSetCommand.ts index 3649c18245db..5c420e61ba83 100644 --- a/clients/client-marketplace-commerce-analytics/commands/GenerateDataSetCommand.ts +++ b/clients/client-marketplace-commerce-analytics/commands/GenerateDataSetCommand.ts @@ -33,6 +33,20 @@ export interface GenerateDataSetCommandOutput extends GenerateDataSetResult, __M * 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. + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { MarketplaceCommerceAnalyticsClient, GenerateDataSetCommand } from "@aws-sdk/client-marketplace-commerce-analytics"; // ES Modules import + * // const { MarketplaceCommerceAnalyticsClient, GenerateDataSetCommand } = require("@aws-sdk/client-marketplace-commerce-analytics"); // CommonJS import + * const client = new MarketplaceCommerceAnalyticsClient(config); + * const command = new GenerateDataSetCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GenerateDataSetCommandInput} for command's `input` shape. + * @see {@link GenerateDataSetCommandOutput} for command's `response` shape. + * @see {@link MarketplaceCommerceAnalyticsClientResolvedConfig | config} for command's `input` shape. + * */ export class GenerateDataSetCommand extends $Command< GenerateDataSetCommandInput, diff --git a/clients/client-marketplace-commerce-analytics/commands/StartSupportDataExportCommand.ts b/clients/client-marketplace-commerce-analytics/commands/StartSupportDataExportCommand.ts index c244df211bcf..3bc0c4a41761 100644 --- a/clients/client-marketplace-commerce-analytics/commands/StartSupportDataExportCommand.ts +++ b/clients/client-marketplace-commerce-analytics/commands/StartSupportDataExportCommand.ts @@ -33,6 +33,20 @@ export interface StartSupportDataExportCommandOutput extends StartSupportDataExp * 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. + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { MarketplaceCommerceAnalyticsClient, StartSupportDataExportCommand } from "@aws-sdk/client-marketplace-commerce-analytics"; // ES Modules import + * // const { MarketplaceCommerceAnalyticsClient, StartSupportDataExportCommand } = require("@aws-sdk/client-marketplace-commerce-analytics"); // CommonJS import + * const client = new MarketplaceCommerceAnalyticsClient(config); + * const command = new StartSupportDataExportCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link StartSupportDataExportCommandInput} for command's `input` shape. + * @see {@link StartSupportDataExportCommandOutput} for command's `response` shape. + * @see {@link MarketplaceCommerceAnalyticsClientResolvedConfig | config} for command's `input` shape. + * */ export class StartSupportDataExportCommand extends $Command< StartSupportDataExportCommandInput, diff --git a/clients/client-marketplace-commerce-analytics/models/models_0.ts b/clients/client-marketplace-commerce-analytics/models/models_0.ts index 0f46c008b113..45c2f72a7b16 100644 --- a/clients/client-marketplace-commerce-analytics/models/models_0.ts +++ b/clients/client-marketplace-commerce-analytics/models/models_0.ts @@ -186,6 +186,9 @@ export interface GenerateDataSetRequest { } export namespace GenerateDataSetRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GenerateDataSetRequest): any => ({ ...obj, }); @@ -203,6 +206,9 @@ export interface GenerateDataSetResult { } export namespace GenerateDataSetResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: GenerateDataSetResult): any => ({ ...obj, }); @@ -221,6 +227,9 @@ export interface MarketplaceCommerceAnalyticsException extends __SmithyException } export namespace MarketplaceCommerceAnalyticsException { + /** + * @internal + */ export const filterSensitiveLog = (obj: MarketplaceCommerceAnalyticsException): any => ({ ...obj, }); @@ -287,6 +296,9 @@ export interface StartSupportDataExportRequest { } export namespace StartSupportDataExportRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: StartSupportDataExportRequest): any => ({ ...obj, }); @@ -304,6 +316,9 @@ export interface StartSupportDataExportResult { } export namespace StartSupportDataExportResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: StartSupportDataExportResult): any => ({ ...obj, }); diff --git a/clients/client-marketplace-entitlement-service/commands/GetEntitlementsCommand.ts b/clients/client-marketplace-entitlement-service/commands/GetEntitlementsCommand.ts index 348993b6b229..75d9787cab18 100644 --- a/clients/client-marketplace-entitlement-service/commands/GetEntitlementsCommand.ts +++ b/clients/client-marketplace-entitlement-service/commands/GetEntitlementsCommand.ts @@ -27,6 +27,20 @@ export interface GetEntitlementsCommandOutput extends GetEntitlementsResult, __M /** *

GetEntitlements retrieves entitlement values for a given product. The results can be * filtered based on customer identifier or product dimensions.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { MarketplaceEntitlementServiceClient, GetEntitlementsCommand } from "@aws-sdk/client-marketplace-entitlement-service"; // ES Modules import + * // const { MarketplaceEntitlementServiceClient, GetEntitlementsCommand } = require("@aws-sdk/client-marketplace-entitlement-service"); // CommonJS import + * const client = new MarketplaceEntitlementServiceClient(config); + * const command = new GetEntitlementsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetEntitlementsCommandInput} for command's `input` shape. + * @see {@link GetEntitlementsCommandOutput} for command's `response` shape. + * @see {@link MarketplaceEntitlementServiceClientResolvedConfig | config} for command's `input` shape. + * */ export class GetEntitlementsCommand extends $Command< GetEntitlementsCommandInput, diff --git a/clients/client-marketplace-entitlement-service/models/models_0.ts b/clients/client-marketplace-entitlement-service/models/models_0.ts index 55c5d81b9774..c4edb76c8e30 100644 --- a/clients/client-marketplace-entitlement-service/models/models_0.ts +++ b/clients/client-marketplace-entitlement-service/models/models_0.ts @@ -39,6 +39,9 @@ export interface GetEntitlementsRequest { } export namespace GetEntitlementsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetEntitlementsRequest): any => ({ ...obj, }); @@ -128,6 +131,9 @@ export namespace EntitlementValue { return visitor._(value.$unknown[0], value.$unknown[1]); }; + /** + * @internal + */ export const filterSensitiveLog = (obj: EntitlementValue): any => { if (obj.IntegerValue !== undefined) return { IntegerValue: obj.IntegerValue }; if (obj.DoubleValue !== undefined) return { DoubleValue: obj.DoubleValue }; @@ -179,6 +185,9 @@ export interface Entitlement { } export namespace Entitlement { + /** + * @internal + */ export const filterSensitiveLog = (obj: Entitlement): any => ({ ...obj, ...(obj.Value && { Value: EntitlementValue.filterSensitiveLog(obj.Value) }), @@ -205,6 +214,9 @@ export interface GetEntitlementsResult { } export namespace GetEntitlementsResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetEntitlementsResult): any => ({ ...obj, ...(obj.Entitlements && { Entitlements: obj.Entitlements.map((item) => Entitlement.filterSensitiveLog(item)) }), @@ -222,6 +234,9 @@ export interface InternalServiceErrorException extends __SmithyException, $Metad } export namespace InternalServiceErrorException { + /** + * @internal + */ export const filterSensitiveLog = (obj: InternalServiceErrorException): any => ({ ...obj, }); @@ -237,6 +252,9 @@ export interface InvalidParameterException extends __SmithyException, $MetadataB } export namespace InvalidParameterException { + /** + * @internal + */ export const filterSensitiveLog = (obj: InvalidParameterException): any => ({ ...obj, }); @@ -252,6 +270,9 @@ export interface ThrottlingException extends __SmithyException, $MetadataBearer } export namespace ThrottlingException { + /** + * @internal + */ export const filterSensitiveLog = (obj: ThrottlingException): any => ({ ...obj, }); diff --git a/clients/client-marketplace-metering/commands/BatchMeterUsageCommand.ts b/clients/client-marketplace-metering/commands/BatchMeterUsageCommand.ts index f045b8012c6e..c9584c7fd1f4 100644 --- a/clients/client-marketplace-metering/commands/BatchMeterUsageCommand.ts +++ b/clients/client-marketplace-metering/commands/BatchMeterUsageCommand.ts @@ -36,6 +36,20 @@ export interface BatchMeterUsageCommandOutput extends BatchMeterUsageResult, __M * with usagedata split into buckets by tags that you define (or allow the customer to * define).

*

BatchMeterUsage requests must be less than 1MB in size.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { MarketplaceMeteringClient, BatchMeterUsageCommand } from "@aws-sdk/client-marketplace-metering"; // ES Modules import + * // const { MarketplaceMeteringClient, BatchMeterUsageCommand } = require("@aws-sdk/client-marketplace-metering"); // CommonJS import + * const client = new MarketplaceMeteringClient(config); + * const command = new BatchMeterUsageCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link BatchMeterUsageCommandInput} for command's `input` shape. + * @see {@link BatchMeterUsageCommandOutput} for command's `response` shape. + * @see {@link MarketplaceMeteringClientResolvedConfig | config} for command's `input` shape. + * */ export class BatchMeterUsageCommand extends $Command< BatchMeterUsageCommandInput, diff --git a/clients/client-marketplace-metering/commands/MeterUsageCommand.ts b/clients/client-marketplace-metering/commands/MeterUsageCommand.ts index f1a493ef0660..cf561294113c 100644 --- a/clients/client-marketplace-metering/commands/MeterUsageCommand.ts +++ b/clients/client-marketplace-metering/commands/MeterUsageCommand.ts @@ -32,6 +32,20 @@ export interface MeterUsageCommandOutput extends MeterUsageResult, __MetadataBea *

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).

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { MarketplaceMeteringClient, MeterUsageCommand } from "@aws-sdk/client-marketplace-metering"; // ES Modules import + * // const { MarketplaceMeteringClient, MeterUsageCommand } = require("@aws-sdk/client-marketplace-metering"); // CommonJS import + * const client = new MarketplaceMeteringClient(config); + * const command = new MeterUsageCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link MeterUsageCommandInput} for command's `input` shape. + * @see {@link MeterUsageCommandOutput} for command's `response` shape. + * @see {@link MarketplaceMeteringClientResolvedConfig | config} for command's `input` shape. + * */ export class MeterUsageCommand extends $Command< MeterUsageCommandInput, diff --git a/clients/client-marketplace-metering/commands/RegisterUsageCommand.ts b/clients/client-marketplace-metering/commands/RegisterUsageCommand.ts index 74fea1531ec2..7c8585caaaf1 100644 --- a/clients/client-marketplace-metering/commands/RegisterUsageCommand.ts +++ b/clients/client-marketplace-metering/commands/RegisterUsageCommand.ts @@ -64,6 +64,20 @@ export interface RegisterUsageCommandOutput extends RegisterUsageResult, __Metad * runtime.

* * + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { MarketplaceMeteringClient, RegisterUsageCommand } from "@aws-sdk/client-marketplace-metering"; // ES Modules import + * // const { MarketplaceMeteringClient, RegisterUsageCommand } = require("@aws-sdk/client-marketplace-metering"); // CommonJS import + * const client = new MarketplaceMeteringClient(config); + * const command = new RegisterUsageCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link RegisterUsageCommandInput} for command's `input` shape. + * @see {@link RegisterUsageCommandOutput} for command's `response` shape. + * @see {@link MarketplaceMeteringClientResolvedConfig | config} for command's `input` shape. + * */ export class RegisterUsageCommand extends $Command< RegisterUsageCommandInput, diff --git a/clients/client-marketplace-metering/commands/ResolveCustomerCommand.ts b/clients/client-marketplace-metering/commands/ResolveCustomerCommand.ts index b275490491b0..065959ffcdcb 100644 --- a/clients/client-marketplace-metering/commands/ResolveCustomerCommand.ts +++ b/clients/client-marketplace-metering/commands/ResolveCustomerCommand.ts @@ -29,6 +29,20 @@ export interface ResolveCustomerCommandOutput extends ResolveCustomerResult, __M * 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 and product code.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { MarketplaceMeteringClient, ResolveCustomerCommand } from "@aws-sdk/client-marketplace-metering"; // ES Modules import + * // const { MarketplaceMeteringClient, ResolveCustomerCommand } = require("@aws-sdk/client-marketplace-metering"); // CommonJS import + * const client = new MarketplaceMeteringClient(config); + * const command = new ResolveCustomerCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ResolveCustomerCommandInput} for command's `input` shape. + * @see {@link ResolveCustomerCommandOutput} for command's `response` shape. + * @see {@link MarketplaceMeteringClientResolvedConfig | config} for command's `input` shape. + * */ export class ResolveCustomerCommand extends $Command< ResolveCustomerCommandInput, diff --git a/clients/client-marketplace-metering/models/models_0.ts b/clients/client-marketplace-metering/models/models_0.ts index 6144814fdc16..fadf7c6ce364 100644 --- a/clients/client-marketplace-metering/models/models_0.ts +++ b/clients/client-marketplace-metering/models/models_0.ts @@ -19,6 +19,9 @@ export interface Tag { } export namespace Tag { + /** + * @internal + */ export const filterSensitiveLog = (obj: Tag): any => ({ ...obj, }); @@ -42,6 +45,9 @@ export interface UsageAllocation { } export namespace UsageAllocation { + /** + * @internal + */ export const filterSensitiveLog = (obj: UsageAllocation): any => ({ ...obj, }); @@ -88,6 +94,9 @@ export interface UsageRecord { } export namespace UsageRecord { + /** + * @internal + */ export const filterSensitiveLog = (obj: UsageRecord): any => ({ ...obj, }); @@ -113,6 +122,9 @@ export interface BatchMeterUsageRequest { } export namespace BatchMeterUsageRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: BatchMeterUsageRequest): any => ({ ...obj, }); @@ -167,6 +179,9 @@ export interface UsageRecordResult { } export namespace UsageRecordResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: UsageRecordResult): any => ({ ...obj, }); @@ -192,6 +207,9 @@ export interface BatchMeterUsageResult { } export namespace BatchMeterUsageResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: BatchMeterUsageResult): any => ({ ...obj, }); @@ -207,6 +225,9 @@ export interface DisabledApiException extends __SmithyException, $MetadataBearer } export namespace DisabledApiException { + /** + * @internal + */ export const filterSensitiveLog = (obj: DisabledApiException): any => ({ ...obj, }); @@ -223,6 +244,9 @@ export interface InternalServiceErrorException extends __SmithyException, $Metad } export namespace InternalServiceErrorException { + /** + * @internal + */ export const filterSensitiveLog = (obj: InternalServiceErrorException): any => ({ ...obj, }); @@ -238,6 +262,9 @@ export interface InvalidCustomerIdentifierException extends __SmithyException, $ } export namespace InvalidCustomerIdentifierException { + /** + * @internal + */ export const filterSensitiveLog = (obj: InvalidCustomerIdentifierException): any => ({ ...obj, }); @@ -254,6 +281,9 @@ export interface InvalidProductCodeException extends __SmithyException, $Metadat } export namespace InvalidProductCodeException { + /** + * @internal + */ export const filterSensitiveLog = (obj: InvalidProductCodeException): any => ({ ...obj, }); @@ -269,6 +299,9 @@ export interface InvalidTagException extends __SmithyException, $MetadataBearer } export namespace InvalidTagException { + /** + * @internal + */ export const filterSensitiveLog = (obj: InvalidTagException): any => ({ ...obj, }); @@ -285,6 +318,9 @@ export interface InvalidUsageAllocationsException extends __SmithyException, $Me } export namespace InvalidUsageAllocationsException { + /** + * @internal + */ export const filterSensitiveLog = (obj: InvalidUsageAllocationsException): any => ({ ...obj, }); @@ -301,6 +337,9 @@ export interface InvalidUsageDimensionException extends __SmithyException, $Meta } export namespace InvalidUsageDimensionException { + /** + * @internal + */ export const filterSensitiveLog = (obj: InvalidUsageDimensionException): any => ({ ...obj, }); @@ -316,6 +355,9 @@ export interface ThrottlingException extends __SmithyException, $MetadataBearer } export namespace ThrottlingException { + /** + * @internal + */ export const filterSensitiveLog = (obj: ThrottlingException): any => ({ ...obj, }); @@ -331,6 +373,9 @@ export interface TimestampOutOfBoundsException extends __SmithyException, $Metad } export namespace TimestampOutOfBoundsException { + /** + * @internal + */ export const filterSensitiveLog = (obj: TimestampOutOfBoundsException): any => ({ ...obj, }); @@ -347,6 +392,9 @@ export interface CustomerNotEntitledException extends __SmithyException, $Metada } export namespace CustomerNotEntitledException { + /** + * @internal + */ export const filterSensitiveLog = (obj: CustomerNotEntitledException): any => ({ ...obj, }); @@ -364,6 +412,9 @@ export interface DuplicateRequestException extends __SmithyException, $MetadataB } export namespace DuplicateRequestException { + /** + * @internal + */ export const filterSensitiveLog = (obj: DuplicateRequestException): any => ({ ...obj, }); @@ -381,6 +432,9 @@ export interface InvalidEndpointRegionException extends __SmithyException, $Meta } export namespace InvalidEndpointRegionException { + /** + * @internal + */ export const filterSensitiveLog = (obj: InvalidEndpointRegionException): any => ({ ...obj, }); @@ -431,6 +485,9 @@ export interface MeterUsageRequest { } export namespace MeterUsageRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: MeterUsageRequest): any => ({ ...obj, }); @@ -444,6 +501,9 @@ export interface MeterUsageResult { } export namespace MeterUsageResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: MeterUsageResult): any => ({ ...obj, }); @@ -459,6 +519,9 @@ export interface InvalidPublicKeyVersionException extends __SmithyException, $Me } export namespace InvalidPublicKeyVersionException { + /** + * @internal + */ export const filterSensitiveLog = (obj: InvalidPublicKeyVersionException): any => ({ ...obj, }); @@ -476,6 +539,9 @@ export interface InvalidRegionException extends __SmithyException, $MetadataBear } export namespace InvalidRegionException { + /** + * @internal + */ export const filterSensitiveLog = (obj: InvalidRegionException): any => ({ ...obj, }); @@ -492,6 +558,9 @@ export interface PlatformNotSupportedException extends __SmithyException, $Metad } export namespace PlatformNotSupportedException { + /** + * @internal + */ export const filterSensitiveLog = (obj: PlatformNotSupportedException): any => ({ ...obj, }); @@ -518,6 +587,9 @@ export interface RegisterUsageRequest { } export namespace RegisterUsageRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: RegisterUsageRequest): any => ({ ...obj, }); @@ -536,6 +608,9 @@ export interface RegisterUsageResult { } export namespace RegisterUsageResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: RegisterUsageResult): any => ({ ...obj, }); @@ -555,6 +630,9 @@ export interface ExpiredTokenException extends __SmithyException, $MetadataBeare } export namespace ExpiredTokenException { + /** + * @internal + */ export const filterSensitiveLog = (obj: ExpiredTokenException): any => ({ ...obj, }); @@ -570,6 +648,9 @@ export interface InvalidTokenException extends __SmithyException, $MetadataBeare } export namespace InvalidTokenException { + /** + * @internal + */ export const filterSensitiveLog = (obj: InvalidTokenException): any => ({ ...obj, }); @@ -588,6 +669,9 @@ export interface ResolveCustomerRequest { } export namespace ResolveCustomerRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ResolveCustomerRequest): any => ({ ...obj, }); @@ -614,6 +698,9 @@ export interface ResolveCustomerResult { } export namespace ResolveCustomerResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: ResolveCustomerResult): any => ({ ...obj, }); diff --git a/clients/client-mediaconnect/commands/AddFlowOutputsCommand.ts b/clients/client-mediaconnect/commands/AddFlowOutputsCommand.ts index ca2f754fdb5f..f0c9c91c41f0 100644 --- a/clients/client-mediaconnect/commands/AddFlowOutputsCommand.ts +++ b/clients/client-mediaconnect/commands/AddFlowOutputsCommand.ts @@ -22,6 +22,20 @@ export interface AddFlowOutputsCommandOutput extends AddFlowOutputsResponse, __M /** * Adds outputs to an existing flow. You can create up to 50 outputs per flow. + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { MediaConnectClient, AddFlowOutputsCommand } from "@aws-sdk/client-mediaconnect"; // ES Modules import + * // const { MediaConnectClient, AddFlowOutputsCommand } = require("@aws-sdk/client-mediaconnect"); // CommonJS import + * const client = new MediaConnectClient(config); + * const command = new AddFlowOutputsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link AddFlowOutputsCommandInput} for command's `input` shape. + * @see {@link AddFlowOutputsCommandOutput} for command's `response` shape. + * @see {@link MediaConnectClientResolvedConfig | config} for command's `input` shape. + * */ export class AddFlowOutputsCommand extends $Command< AddFlowOutputsCommandInput, diff --git a/clients/client-mediaconnect/commands/AddFlowSourcesCommand.ts b/clients/client-mediaconnect/commands/AddFlowSourcesCommand.ts index f7b0e0172dc9..04b421c5ed2b 100644 --- a/clients/client-mediaconnect/commands/AddFlowSourcesCommand.ts +++ b/clients/client-mediaconnect/commands/AddFlowSourcesCommand.ts @@ -22,6 +22,20 @@ export interface AddFlowSourcesCommandOutput extends AddFlowSourcesResponse, __M /** * Adds Sources to flow + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { MediaConnectClient, AddFlowSourcesCommand } from "@aws-sdk/client-mediaconnect"; // ES Modules import + * // const { MediaConnectClient, AddFlowSourcesCommand } = require("@aws-sdk/client-mediaconnect"); // CommonJS import + * const client = new MediaConnectClient(config); + * const command = new AddFlowSourcesCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link AddFlowSourcesCommandInput} for command's `input` shape. + * @see {@link AddFlowSourcesCommandOutput} for command's `response` shape. + * @see {@link MediaConnectClientResolvedConfig | config} for command's `input` shape. + * */ export class AddFlowSourcesCommand extends $Command< AddFlowSourcesCommandInput, diff --git a/clients/client-mediaconnect/commands/AddFlowVpcInterfacesCommand.ts b/clients/client-mediaconnect/commands/AddFlowVpcInterfacesCommand.ts index 15ddab87b4ce..5b6d70f72da1 100644 --- a/clients/client-mediaconnect/commands/AddFlowVpcInterfacesCommand.ts +++ b/clients/client-mediaconnect/commands/AddFlowVpcInterfacesCommand.ts @@ -22,6 +22,20 @@ export interface AddFlowVpcInterfacesCommandOutput extends AddFlowVpcInterfacesR /** * Adds VPC interfaces to flow + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { MediaConnectClient, AddFlowVpcInterfacesCommand } from "@aws-sdk/client-mediaconnect"; // ES Modules import + * // const { MediaConnectClient, AddFlowVpcInterfacesCommand } = require("@aws-sdk/client-mediaconnect"); // CommonJS import + * const client = new MediaConnectClient(config); + * const command = new AddFlowVpcInterfacesCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link AddFlowVpcInterfacesCommandInput} for command's `input` shape. + * @see {@link AddFlowVpcInterfacesCommandOutput} for command's `response` shape. + * @see {@link MediaConnectClientResolvedConfig | config} for command's `input` shape. + * */ export class AddFlowVpcInterfacesCommand extends $Command< AddFlowVpcInterfacesCommandInput, diff --git a/clients/client-mediaconnect/commands/CreateFlowCommand.ts b/clients/client-mediaconnect/commands/CreateFlowCommand.ts index 63ba335e79ab..faff2e7ee200 100644 --- a/clients/client-mediaconnect/commands/CreateFlowCommand.ts +++ b/clients/client-mediaconnect/commands/CreateFlowCommand.ts @@ -22,6 +22,20 @@ export interface CreateFlowCommandOutput extends CreateFlowResponse, __MetadataB /** * Creates a new flow. The request must include one source. The request optionally can include outputs (up to 50) and entitlements (up to 50). + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { MediaConnectClient, CreateFlowCommand } from "@aws-sdk/client-mediaconnect"; // ES Modules import + * // const { MediaConnectClient, CreateFlowCommand } = require("@aws-sdk/client-mediaconnect"); // CommonJS import + * const client = new MediaConnectClient(config); + * const command = new CreateFlowCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreateFlowCommandInput} for command's `input` shape. + * @see {@link CreateFlowCommandOutput} for command's `response` shape. + * @see {@link MediaConnectClientResolvedConfig | config} for command's `input` shape. + * */ export class CreateFlowCommand extends $Command< CreateFlowCommandInput, diff --git a/clients/client-mediaconnect/commands/DeleteFlowCommand.ts b/clients/client-mediaconnect/commands/DeleteFlowCommand.ts index 071ad55cd39a..c0f1f91007a6 100644 --- a/clients/client-mediaconnect/commands/DeleteFlowCommand.ts +++ b/clients/client-mediaconnect/commands/DeleteFlowCommand.ts @@ -22,6 +22,20 @@ export interface DeleteFlowCommandOutput extends DeleteFlowResponse, __MetadataB /** * Deletes a flow. Before you can delete a flow, you must stop the flow. + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { MediaConnectClient, DeleteFlowCommand } from "@aws-sdk/client-mediaconnect"; // ES Modules import + * // const { MediaConnectClient, DeleteFlowCommand } = require("@aws-sdk/client-mediaconnect"); // CommonJS import + * const client = new MediaConnectClient(config); + * const command = new DeleteFlowCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteFlowCommandInput} for command's `input` shape. + * @see {@link DeleteFlowCommandOutput} for command's `response` shape. + * @see {@link MediaConnectClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteFlowCommand extends $Command< DeleteFlowCommandInput, diff --git a/clients/client-mediaconnect/commands/DescribeFlowCommand.ts b/clients/client-mediaconnect/commands/DescribeFlowCommand.ts index 3fc8c7cf89e6..026bfe2fdee0 100644 --- a/clients/client-mediaconnect/commands/DescribeFlowCommand.ts +++ b/clients/client-mediaconnect/commands/DescribeFlowCommand.ts @@ -22,6 +22,20 @@ export interface DescribeFlowCommandOutput extends DescribeFlowResponse, __Metad /** * 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. + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { MediaConnectClient, DescribeFlowCommand } from "@aws-sdk/client-mediaconnect"; // ES Modules import + * // const { MediaConnectClient, DescribeFlowCommand } = require("@aws-sdk/client-mediaconnect"); // CommonJS import + * const client = new MediaConnectClient(config); + * const command = new DescribeFlowCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeFlowCommandInput} for command's `input` shape. + * @see {@link DescribeFlowCommandOutput} for command's `response` shape. + * @see {@link MediaConnectClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeFlowCommand extends $Command< DescribeFlowCommandInput, diff --git a/clients/client-mediaconnect/commands/DescribeOfferingCommand.ts b/clients/client-mediaconnect/commands/DescribeOfferingCommand.ts index 78b0c0e2f7dc..c61e57c52bb4 100644 --- a/clients/client-mediaconnect/commands/DescribeOfferingCommand.ts +++ b/clients/client-mediaconnect/commands/DescribeOfferingCommand.ts @@ -22,6 +22,20 @@ export interface DescribeOfferingCommandOutput extends DescribeOfferingResponse, /** * Displays the details of an offering. The response includes the offering description, duration, outbound bandwidth, price, and Amazon Resource Name (ARN). + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { MediaConnectClient, DescribeOfferingCommand } from "@aws-sdk/client-mediaconnect"; // ES Modules import + * // const { MediaConnectClient, DescribeOfferingCommand } = require("@aws-sdk/client-mediaconnect"); // CommonJS import + * const client = new MediaConnectClient(config); + * const command = new DescribeOfferingCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeOfferingCommandInput} for command's `input` shape. + * @see {@link DescribeOfferingCommandOutput} for command's `response` shape. + * @see {@link MediaConnectClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeOfferingCommand extends $Command< DescribeOfferingCommandInput, diff --git a/clients/client-mediaconnect/commands/DescribeReservationCommand.ts b/clients/client-mediaconnect/commands/DescribeReservationCommand.ts index 348fb5085ccf..9bb3fb622403 100644 --- a/clients/client-mediaconnect/commands/DescribeReservationCommand.ts +++ b/clients/client-mediaconnect/commands/DescribeReservationCommand.ts @@ -22,6 +22,20 @@ export interface DescribeReservationCommandOutput extends DescribeReservationRes /** * 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). + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { MediaConnectClient, DescribeReservationCommand } from "@aws-sdk/client-mediaconnect"; // ES Modules import + * // const { MediaConnectClient, DescribeReservationCommand } = require("@aws-sdk/client-mediaconnect"); // CommonJS import + * const client = new MediaConnectClient(config); + * const command = new DescribeReservationCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeReservationCommandInput} for command's `input` shape. + * @see {@link DescribeReservationCommandOutput} for command's `response` shape. + * @see {@link MediaConnectClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeReservationCommand extends $Command< DescribeReservationCommandInput, diff --git a/clients/client-mediaconnect/commands/GrantFlowEntitlementsCommand.ts b/clients/client-mediaconnect/commands/GrantFlowEntitlementsCommand.ts index 21fe25463d32..8e7540a9a291 100644 --- a/clients/client-mediaconnect/commands/GrantFlowEntitlementsCommand.ts +++ b/clients/client-mediaconnect/commands/GrantFlowEntitlementsCommand.ts @@ -22,6 +22,20 @@ export interface GrantFlowEntitlementsCommandOutput extends GrantFlowEntitlement /** * Grants entitlements to an existing flow. + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { MediaConnectClient, GrantFlowEntitlementsCommand } from "@aws-sdk/client-mediaconnect"; // ES Modules import + * // const { MediaConnectClient, GrantFlowEntitlementsCommand } = require("@aws-sdk/client-mediaconnect"); // CommonJS import + * const client = new MediaConnectClient(config); + * const command = new GrantFlowEntitlementsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GrantFlowEntitlementsCommandInput} for command's `input` shape. + * @see {@link GrantFlowEntitlementsCommandOutput} for command's `response` shape. + * @see {@link MediaConnectClientResolvedConfig | config} for command's `input` shape. + * */ export class GrantFlowEntitlementsCommand extends $Command< GrantFlowEntitlementsCommandInput, diff --git a/clients/client-mediaconnect/commands/ListEntitlementsCommand.ts b/clients/client-mediaconnect/commands/ListEntitlementsCommand.ts index ea7cfdd8c9b9..00e2656eb8a4 100644 --- a/clients/client-mediaconnect/commands/ListEntitlementsCommand.ts +++ b/clients/client-mediaconnect/commands/ListEntitlementsCommand.ts @@ -22,6 +22,20 @@ export interface ListEntitlementsCommandOutput extends ListEntitlementsResponse, /** * Displays a list of all entitlements that have been granted to this account. This request returns 20 results per page. + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { MediaConnectClient, ListEntitlementsCommand } from "@aws-sdk/client-mediaconnect"; // ES Modules import + * // const { MediaConnectClient, ListEntitlementsCommand } = require("@aws-sdk/client-mediaconnect"); // CommonJS import + * const client = new MediaConnectClient(config); + * const command = new ListEntitlementsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListEntitlementsCommandInput} for command's `input` shape. + * @see {@link ListEntitlementsCommandOutput} for command's `response` shape. + * @see {@link MediaConnectClientResolvedConfig | config} for command's `input` shape. + * */ export class ListEntitlementsCommand extends $Command< ListEntitlementsCommandInput, diff --git a/clients/client-mediaconnect/commands/ListFlowsCommand.ts b/clients/client-mediaconnect/commands/ListFlowsCommand.ts index 67a7f763570d..a418febe3d48 100644 --- a/clients/client-mediaconnect/commands/ListFlowsCommand.ts +++ b/clients/client-mediaconnect/commands/ListFlowsCommand.ts @@ -22,6 +22,20 @@ export interface ListFlowsCommandOutput extends ListFlowsResponse, __MetadataBea /** * Displays a list of flows that are associated with this account. This request returns a paginated result. + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { MediaConnectClient, ListFlowsCommand } from "@aws-sdk/client-mediaconnect"; // ES Modules import + * // const { MediaConnectClient, ListFlowsCommand } = require("@aws-sdk/client-mediaconnect"); // CommonJS import + * const client = new MediaConnectClient(config); + * const command = new ListFlowsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListFlowsCommandInput} for command's `input` shape. + * @see {@link ListFlowsCommandOutput} for command's `response` shape. + * @see {@link MediaConnectClientResolvedConfig | config} for command's `input` shape. + * */ export class ListFlowsCommand extends $Command< ListFlowsCommandInput, diff --git a/clients/client-mediaconnect/commands/ListOfferingsCommand.ts b/clients/client-mediaconnect/commands/ListOfferingsCommand.ts index ef70f944a8f2..416ddd370ff2 100644 --- a/clients/client-mediaconnect/commands/ListOfferingsCommand.ts +++ b/clients/client-mediaconnect/commands/ListOfferingsCommand.ts @@ -22,6 +22,20 @@ export interface ListOfferingsCommandOutput extends ListOfferingsResponse, __Met /** * 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. + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { MediaConnectClient, ListOfferingsCommand } from "@aws-sdk/client-mediaconnect"; // ES Modules import + * // const { MediaConnectClient, ListOfferingsCommand } = require("@aws-sdk/client-mediaconnect"); // CommonJS import + * const client = new MediaConnectClient(config); + * const command = new ListOfferingsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListOfferingsCommandInput} for command's `input` shape. + * @see {@link ListOfferingsCommandOutput} for command's `response` shape. + * @see {@link MediaConnectClientResolvedConfig | config} for command's `input` shape. + * */ export class ListOfferingsCommand extends $Command< ListOfferingsCommandInput, diff --git a/clients/client-mediaconnect/commands/ListReservationsCommand.ts b/clients/client-mediaconnect/commands/ListReservationsCommand.ts index e5d87dd5da49..790cd3b52059 100644 --- a/clients/client-mediaconnect/commands/ListReservationsCommand.ts +++ b/clients/client-mediaconnect/commands/ListReservationsCommand.ts @@ -22,6 +22,20 @@ export interface ListReservationsCommandOutput extends ListReservationsResponse, /** * 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). + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { MediaConnectClient, ListReservationsCommand } from "@aws-sdk/client-mediaconnect"; // ES Modules import + * // const { MediaConnectClient, ListReservationsCommand } = require("@aws-sdk/client-mediaconnect"); // CommonJS import + * const client = new MediaConnectClient(config); + * const command = new ListReservationsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListReservationsCommandInput} for command's `input` shape. + * @see {@link ListReservationsCommandOutput} for command's `response` shape. + * @see {@link MediaConnectClientResolvedConfig | config} for command's `input` shape. + * */ export class ListReservationsCommand extends $Command< ListReservationsCommandInput, diff --git a/clients/client-mediaconnect/commands/ListTagsForResourceCommand.ts b/clients/client-mediaconnect/commands/ListTagsForResourceCommand.ts index 2d7e8a6ae8cd..616c76ce2a29 100644 --- a/clients/client-mediaconnect/commands/ListTagsForResourceCommand.ts +++ b/clients/client-mediaconnect/commands/ListTagsForResourceCommand.ts @@ -22,6 +22,20 @@ export interface ListTagsForResourceCommandOutput extends ListTagsForResourceRes /** * List all tags on an AWS Elemental MediaConnect resource + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { MediaConnectClient, ListTagsForResourceCommand } from "@aws-sdk/client-mediaconnect"; // ES Modules import + * // const { MediaConnectClient, ListTagsForResourceCommand } = require("@aws-sdk/client-mediaconnect"); // CommonJS import + * const client = new MediaConnectClient(config); + * const command = new ListTagsForResourceCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListTagsForResourceCommandInput} for command's `input` shape. + * @see {@link ListTagsForResourceCommandOutput} for command's `response` shape. + * @see {@link MediaConnectClientResolvedConfig | config} for command's `input` shape. + * */ export class ListTagsForResourceCommand extends $Command< ListTagsForResourceCommandInput, diff --git a/clients/client-mediaconnect/commands/PurchaseOfferingCommand.ts b/clients/client-mediaconnect/commands/PurchaseOfferingCommand.ts index 1e7c006aebc1..b25f3b3f1c20 100644 --- a/clients/client-mediaconnect/commands/PurchaseOfferingCommand.ts +++ b/clients/client-mediaconnect/commands/PurchaseOfferingCommand.ts @@ -22,6 +22,20 @@ export interface PurchaseOfferingCommandOutput extends PurchaseOfferingResponse, /** * Submits a request to purchase an offering. If you already have an active reservation, you can't purchase another offering. + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { MediaConnectClient, PurchaseOfferingCommand } from "@aws-sdk/client-mediaconnect"; // ES Modules import + * // const { MediaConnectClient, PurchaseOfferingCommand } = require("@aws-sdk/client-mediaconnect"); // CommonJS import + * const client = new MediaConnectClient(config); + * const command = new PurchaseOfferingCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link PurchaseOfferingCommandInput} for command's `input` shape. + * @see {@link PurchaseOfferingCommandOutput} for command's `response` shape. + * @see {@link MediaConnectClientResolvedConfig | config} for command's `input` shape. + * */ export class PurchaseOfferingCommand extends $Command< PurchaseOfferingCommandInput, diff --git a/clients/client-mediaconnect/commands/RemoveFlowOutputCommand.ts b/clients/client-mediaconnect/commands/RemoveFlowOutputCommand.ts index e95bdcde3247..2a0a3f8929d9 100644 --- a/clients/client-mediaconnect/commands/RemoveFlowOutputCommand.ts +++ b/clients/client-mediaconnect/commands/RemoveFlowOutputCommand.ts @@ -22,6 +22,20 @@ export interface RemoveFlowOutputCommandOutput extends RemoveFlowOutputResponse, /** * 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. + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { MediaConnectClient, RemoveFlowOutputCommand } from "@aws-sdk/client-mediaconnect"; // ES Modules import + * // const { MediaConnectClient, RemoveFlowOutputCommand } = require("@aws-sdk/client-mediaconnect"); // CommonJS import + * const client = new MediaConnectClient(config); + * const command = new RemoveFlowOutputCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link RemoveFlowOutputCommandInput} for command's `input` shape. + * @see {@link RemoveFlowOutputCommandOutput} for command's `response` shape. + * @see {@link MediaConnectClientResolvedConfig | config} for command's `input` shape. + * */ export class RemoveFlowOutputCommand extends $Command< RemoveFlowOutputCommandInput, diff --git a/clients/client-mediaconnect/commands/RemoveFlowSourceCommand.ts b/clients/client-mediaconnect/commands/RemoveFlowSourceCommand.ts index 7802af1f1fa5..f4fb18b2e42c 100644 --- a/clients/client-mediaconnect/commands/RemoveFlowSourceCommand.ts +++ b/clients/client-mediaconnect/commands/RemoveFlowSourceCommand.ts @@ -22,6 +22,20 @@ export interface RemoveFlowSourceCommandOutput extends RemoveFlowSourceResponse, /** * Removes a source from an existing flow. This request can be made only if there is more than one source on the flow. + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { MediaConnectClient, RemoveFlowSourceCommand } from "@aws-sdk/client-mediaconnect"; // ES Modules import + * // const { MediaConnectClient, RemoveFlowSourceCommand } = require("@aws-sdk/client-mediaconnect"); // CommonJS import + * const client = new MediaConnectClient(config); + * const command = new RemoveFlowSourceCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link RemoveFlowSourceCommandInput} for command's `input` shape. + * @see {@link RemoveFlowSourceCommandOutput} for command's `response` shape. + * @see {@link MediaConnectClientResolvedConfig | config} for command's `input` shape. + * */ export class RemoveFlowSourceCommand extends $Command< RemoveFlowSourceCommandInput, diff --git a/clients/client-mediaconnect/commands/RemoveFlowVpcInterfaceCommand.ts b/clients/client-mediaconnect/commands/RemoveFlowVpcInterfaceCommand.ts index 1ab4c0c3c478..c1ee23cc1669 100644 --- a/clients/client-mediaconnect/commands/RemoveFlowVpcInterfaceCommand.ts +++ b/clients/client-mediaconnect/commands/RemoveFlowVpcInterfaceCommand.ts @@ -22,6 +22,20 @@ export interface RemoveFlowVpcInterfaceCommandOutput extends RemoveFlowVpcInterf /** * 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. + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { MediaConnectClient, RemoveFlowVpcInterfaceCommand } from "@aws-sdk/client-mediaconnect"; // ES Modules import + * // const { MediaConnectClient, RemoveFlowVpcInterfaceCommand } = require("@aws-sdk/client-mediaconnect"); // CommonJS import + * const client = new MediaConnectClient(config); + * const command = new RemoveFlowVpcInterfaceCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link RemoveFlowVpcInterfaceCommandInput} for command's `input` shape. + * @see {@link RemoveFlowVpcInterfaceCommandOutput} for command's `response` shape. + * @see {@link MediaConnectClientResolvedConfig | config} for command's `input` shape. + * */ export class RemoveFlowVpcInterfaceCommand extends $Command< RemoveFlowVpcInterfaceCommandInput, diff --git a/clients/client-mediaconnect/commands/RevokeFlowEntitlementCommand.ts b/clients/client-mediaconnect/commands/RevokeFlowEntitlementCommand.ts index 990e296ed9f6..39ab2cc56b78 100644 --- a/clients/client-mediaconnect/commands/RevokeFlowEntitlementCommand.ts +++ b/clients/client-mediaconnect/commands/RevokeFlowEntitlementCommand.ts @@ -22,6 +22,20 @@ export interface RevokeFlowEntitlementCommandOutput extends RevokeFlowEntitlemen /** * Revokes an entitlement from a flow. Once an entitlement is revoked, the content becomes unavailable to the subscriber and the associated output is removed. + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { MediaConnectClient, RevokeFlowEntitlementCommand } from "@aws-sdk/client-mediaconnect"; // ES Modules import + * // const { MediaConnectClient, RevokeFlowEntitlementCommand } = require("@aws-sdk/client-mediaconnect"); // CommonJS import + * const client = new MediaConnectClient(config); + * const command = new RevokeFlowEntitlementCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link RevokeFlowEntitlementCommandInput} for command's `input` shape. + * @see {@link RevokeFlowEntitlementCommandOutput} for command's `response` shape. + * @see {@link MediaConnectClientResolvedConfig | config} for command's `input` shape. + * */ export class RevokeFlowEntitlementCommand extends $Command< RevokeFlowEntitlementCommandInput, diff --git a/clients/client-mediaconnect/commands/StartFlowCommand.ts b/clients/client-mediaconnect/commands/StartFlowCommand.ts index 4d8721ab34e6..fed5d6ad248e 100644 --- a/clients/client-mediaconnect/commands/StartFlowCommand.ts +++ b/clients/client-mediaconnect/commands/StartFlowCommand.ts @@ -22,6 +22,20 @@ export interface StartFlowCommandOutput extends StartFlowResponse, __MetadataBea /** * Starts a flow. + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { MediaConnectClient, StartFlowCommand } from "@aws-sdk/client-mediaconnect"; // ES Modules import + * // const { MediaConnectClient, StartFlowCommand } = require("@aws-sdk/client-mediaconnect"); // CommonJS import + * const client = new MediaConnectClient(config); + * const command = new StartFlowCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link StartFlowCommandInput} for command's `input` shape. + * @see {@link StartFlowCommandOutput} for command's `response` shape. + * @see {@link MediaConnectClientResolvedConfig | config} for command's `input` shape. + * */ export class StartFlowCommand extends $Command< StartFlowCommandInput, diff --git a/clients/client-mediaconnect/commands/StopFlowCommand.ts b/clients/client-mediaconnect/commands/StopFlowCommand.ts index 03469570dccf..6a1c0b7056be 100644 --- a/clients/client-mediaconnect/commands/StopFlowCommand.ts +++ b/clients/client-mediaconnect/commands/StopFlowCommand.ts @@ -22,6 +22,20 @@ export interface StopFlowCommandOutput extends StopFlowResponse, __MetadataBeare /** * Stops a flow. + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { MediaConnectClient, StopFlowCommand } from "@aws-sdk/client-mediaconnect"; // ES Modules import + * // const { MediaConnectClient, StopFlowCommand } = require("@aws-sdk/client-mediaconnect"); // CommonJS import + * const client = new MediaConnectClient(config); + * const command = new StopFlowCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link StopFlowCommandInput} for command's `input` shape. + * @see {@link StopFlowCommandOutput} for command's `response` shape. + * @see {@link MediaConnectClientResolvedConfig | config} for command's `input` shape. + * */ export class StopFlowCommand extends $Command< StopFlowCommandInput, diff --git a/clients/client-mediaconnect/commands/TagResourceCommand.ts b/clients/client-mediaconnect/commands/TagResourceCommand.ts index e90407eb71aa..62d4eb636d20 100644 --- a/clients/client-mediaconnect/commands/TagResourceCommand.ts +++ b/clients/client-mediaconnect/commands/TagResourceCommand.ts @@ -22,6 +22,20 @@ export interface TagResourceCommandOutput extends __MetadataBearer {} /** * 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. + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { MediaConnectClient, TagResourceCommand } from "@aws-sdk/client-mediaconnect"; // ES Modules import + * // const { MediaConnectClient, TagResourceCommand } = require("@aws-sdk/client-mediaconnect"); // CommonJS import + * const client = new MediaConnectClient(config); + * const command = new TagResourceCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link TagResourceCommandInput} for command's `input` shape. + * @see {@link TagResourceCommandOutput} for command's `response` shape. + * @see {@link MediaConnectClientResolvedConfig | config} for command's `input` shape. + * */ export class TagResourceCommand extends $Command< TagResourceCommandInput, diff --git a/clients/client-mediaconnect/commands/UntagResourceCommand.ts b/clients/client-mediaconnect/commands/UntagResourceCommand.ts index 42b9a11a0e9e..25cc1e12f32c 100644 --- a/clients/client-mediaconnect/commands/UntagResourceCommand.ts +++ b/clients/client-mediaconnect/commands/UntagResourceCommand.ts @@ -22,6 +22,20 @@ export interface UntagResourceCommandOutput extends __MetadataBearer {} /** * Deletes specified tags from a resource. + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { MediaConnectClient, UntagResourceCommand } from "@aws-sdk/client-mediaconnect"; // ES Modules import + * // const { MediaConnectClient, UntagResourceCommand } = require("@aws-sdk/client-mediaconnect"); // CommonJS import + * const client = new MediaConnectClient(config); + * const command = new UntagResourceCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link UntagResourceCommandInput} for command's `input` shape. + * @see {@link UntagResourceCommandOutput} for command's `response` shape. + * @see {@link MediaConnectClientResolvedConfig | config} for command's `input` shape. + * */ export class UntagResourceCommand extends $Command< UntagResourceCommandInput, diff --git a/clients/client-mediaconnect/commands/UpdateFlowCommand.ts b/clients/client-mediaconnect/commands/UpdateFlowCommand.ts index e53f95ada790..09dbb55ab623 100644 --- a/clients/client-mediaconnect/commands/UpdateFlowCommand.ts +++ b/clients/client-mediaconnect/commands/UpdateFlowCommand.ts @@ -22,6 +22,20 @@ export interface UpdateFlowCommandOutput extends UpdateFlowResponse, __MetadataB /** * Updates flow + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { MediaConnectClient, UpdateFlowCommand } from "@aws-sdk/client-mediaconnect"; // ES Modules import + * // const { MediaConnectClient, UpdateFlowCommand } = require("@aws-sdk/client-mediaconnect"); // CommonJS import + * const client = new MediaConnectClient(config); + * const command = new UpdateFlowCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link UpdateFlowCommandInput} for command's `input` shape. + * @see {@link UpdateFlowCommandOutput} for command's `response` shape. + * @see {@link MediaConnectClientResolvedConfig | config} for command's `input` shape. + * */ export class UpdateFlowCommand extends $Command< UpdateFlowCommandInput, diff --git a/clients/client-mediaconnect/commands/UpdateFlowEntitlementCommand.ts b/clients/client-mediaconnect/commands/UpdateFlowEntitlementCommand.ts index 729b6a895be1..5bde63881d1f 100644 --- a/clients/client-mediaconnect/commands/UpdateFlowEntitlementCommand.ts +++ b/clients/client-mediaconnect/commands/UpdateFlowEntitlementCommand.ts @@ -22,6 +22,20 @@ export interface UpdateFlowEntitlementCommandOutput extends UpdateFlowEntitlemen /** * 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. + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { MediaConnectClient, UpdateFlowEntitlementCommand } from "@aws-sdk/client-mediaconnect"; // ES Modules import + * // const { MediaConnectClient, UpdateFlowEntitlementCommand } = require("@aws-sdk/client-mediaconnect"); // CommonJS import + * const client = new MediaConnectClient(config); + * const command = new UpdateFlowEntitlementCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link UpdateFlowEntitlementCommandInput} for command's `input` shape. + * @see {@link UpdateFlowEntitlementCommandOutput} for command's `response` shape. + * @see {@link MediaConnectClientResolvedConfig | config} for command's `input` shape. + * */ export class UpdateFlowEntitlementCommand extends $Command< UpdateFlowEntitlementCommandInput, diff --git a/clients/client-mediaconnect/commands/UpdateFlowOutputCommand.ts b/clients/client-mediaconnect/commands/UpdateFlowOutputCommand.ts index 42258b52adcb..6a82bd2b267e 100644 --- a/clients/client-mediaconnect/commands/UpdateFlowOutputCommand.ts +++ b/clients/client-mediaconnect/commands/UpdateFlowOutputCommand.ts @@ -22,6 +22,20 @@ export interface UpdateFlowOutputCommandOutput extends UpdateFlowOutputResponse, /** * Updates an existing flow output. + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { MediaConnectClient, UpdateFlowOutputCommand } from "@aws-sdk/client-mediaconnect"; // ES Modules import + * // const { MediaConnectClient, UpdateFlowOutputCommand } = require("@aws-sdk/client-mediaconnect"); // CommonJS import + * const client = new MediaConnectClient(config); + * const command = new UpdateFlowOutputCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link UpdateFlowOutputCommandInput} for command's `input` shape. + * @see {@link UpdateFlowOutputCommandOutput} for command's `response` shape. + * @see {@link MediaConnectClientResolvedConfig | config} for command's `input` shape. + * */ export class UpdateFlowOutputCommand extends $Command< UpdateFlowOutputCommandInput, diff --git a/clients/client-mediaconnect/commands/UpdateFlowSourceCommand.ts b/clients/client-mediaconnect/commands/UpdateFlowSourceCommand.ts index 6e38f6720d7c..e7acbdc3dc17 100644 --- a/clients/client-mediaconnect/commands/UpdateFlowSourceCommand.ts +++ b/clients/client-mediaconnect/commands/UpdateFlowSourceCommand.ts @@ -22,6 +22,20 @@ export interface UpdateFlowSourceCommandOutput extends UpdateFlowSourceResponse, /** * Updates the source of a flow. + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { MediaConnectClient, UpdateFlowSourceCommand } from "@aws-sdk/client-mediaconnect"; // ES Modules import + * // const { MediaConnectClient, UpdateFlowSourceCommand } = require("@aws-sdk/client-mediaconnect"); // CommonJS import + * const client = new MediaConnectClient(config); + * const command = new UpdateFlowSourceCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link UpdateFlowSourceCommandInput} for command's `input` shape. + * @see {@link UpdateFlowSourceCommandOutput} for command's `response` shape. + * @see {@link MediaConnectClientResolvedConfig | config} for command's `input` shape. + * */ export class UpdateFlowSourceCommand extends $Command< UpdateFlowSourceCommandInput, diff --git a/clients/client-mediaconnect/models/models_0.ts b/clients/client-mediaconnect/models/models_0.ts index c06348dfb9ab..d1001b0e1855 100644 --- a/clients/client-mediaconnect/models/models_0.ts +++ b/clients/client-mediaconnect/models/models_0.ts @@ -64,6 +64,9 @@ export interface Encryption { } export namespace Encryption { + /** + * @internal + */ export const filterSensitiveLog = (obj: Encryption): any => ({ ...obj, }); @@ -89,6 +92,9 @@ export interface VpcInterfaceAttachment { } export namespace VpcInterfaceAttachment { + /** + * @internal + */ export const filterSensitiveLog = (obj: VpcInterfaceAttachment): any => ({ ...obj, }); @@ -165,6 +171,9 @@ export interface AddOutputRequest { } export namespace AddOutputRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: AddOutputRequest): any => ({ ...obj, }); @@ -216,6 +225,9 @@ export interface Entitlement { } export namespace Entitlement { + /** + * @internal + */ export const filterSensitiveLog = (obj: Entitlement): any => ({ ...obj, }); @@ -257,6 +269,9 @@ export interface GrantEntitlementRequest { } export namespace GrantEntitlementRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GrantEntitlementRequest): any => ({ ...obj, }); @@ -283,6 +298,9 @@ export interface ListedEntitlement { } export namespace ListedEntitlement { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListedEntitlement): any => ({ ...obj, }); @@ -339,6 +357,9 @@ export interface ListedFlow { } export namespace ListedFlow { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListedFlow): any => ({ ...obj, }); @@ -372,6 +393,9 @@ export interface ResourceSpecification { } export namespace ResourceSpecification { + /** + * @internal + */ export const filterSensitiveLog = (obj: ResourceSpecification): any => ({ ...obj, }); @@ -423,6 +447,9 @@ export interface Offering { } export namespace Offering { + /** + * @internal + */ export const filterSensitiveLog = (obj: Offering): any => ({ ...obj, }); @@ -474,6 +501,9 @@ export interface Transport { } export namespace Transport { + /** + * @internal + */ export const filterSensitiveLog = (obj: Transport): any => ({ ...obj, }); @@ -545,6 +575,9 @@ export interface Output { } export namespace Output { + /** + * @internal + */ export const filterSensitiveLog = (obj: Output): any => ({ ...obj, }); @@ -628,6 +661,9 @@ export interface Reservation { } export namespace Reservation { + /** + * @internal + */ export const filterSensitiveLog = (obj: Reservation): any => ({ ...obj, }); @@ -699,6 +735,9 @@ export interface SetSourceRequest { } export namespace SetSourceRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: SetSourceRequest): any => ({ ...obj, }); @@ -765,6 +804,9 @@ export interface Source { } export namespace Source { + /** + * @internal + */ export const filterSensitiveLog = (obj: Source): any => ({ ...obj, }); @@ -801,6 +843,9 @@ export interface VpcInterface { } export namespace VpcInterface { + /** + * @internal + */ export const filterSensitiveLog = (obj: VpcInterface): any => ({ ...obj, }); @@ -832,6 +877,9 @@ export interface VpcInterfaceRequest { } export namespace VpcInterfaceRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: VpcInterfaceRequest): any => ({ ...obj, }); @@ -850,6 +898,9 @@ export interface AddFlowOutputs420Exception extends __SmithyException, $Metadata } export namespace AddFlowOutputs420Exception { + /** + * @internal + */ export const filterSensitiveLog = (obj: AddFlowOutputs420Exception): any => ({ ...obj, }); @@ -871,6 +922,9 @@ export interface AddFlowOutputsRequest { } export namespace AddFlowOutputsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: AddFlowOutputsRequest): any => ({ ...obj, }); @@ -889,6 +943,9 @@ export interface AddFlowOutputsResponse { } export namespace AddFlowOutputsResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: AddFlowOutputsResponse): any => ({ ...obj, }); @@ -907,6 +964,9 @@ export interface BadRequestException extends __SmithyException, $MetadataBearer } export namespace BadRequestException { + /** + * @internal + */ export const filterSensitiveLog = (obj: BadRequestException): any => ({ ...obj, }); @@ -925,6 +985,9 @@ export interface ForbiddenException extends __SmithyException, $MetadataBearer { } export namespace ForbiddenException { + /** + * @internal + */ export const filterSensitiveLog = (obj: ForbiddenException): any => ({ ...obj, }); @@ -943,6 +1006,9 @@ export interface InternalServerErrorException extends __SmithyException, $Metada } export namespace InternalServerErrorException { + /** + * @internal + */ export const filterSensitiveLog = (obj: InternalServerErrorException): any => ({ ...obj, }); @@ -961,6 +1027,9 @@ export interface NotFoundException extends __SmithyException, $MetadataBearer { } export namespace NotFoundException { + /** + * @internal + */ export const filterSensitiveLog = (obj: NotFoundException): any => ({ ...obj, }); @@ -979,6 +1048,9 @@ export interface ServiceUnavailableException extends __SmithyException, $Metadat } export namespace ServiceUnavailableException { + /** + * @internal + */ export const filterSensitiveLog = (obj: ServiceUnavailableException): any => ({ ...obj, }); @@ -997,6 +1069,9 @@ export interface TooManyRequestsException extends __SmithyException, $MetadataBe } export namespace TooManyRequestsException { + /** + * @internal + */ export const filterSensitiveLog = (obj: TooManyRequestsException): any => ({ ...obj, }); @@ -1018,6 +1093,9 @@ export interface AddFlowSourcesRequest { } export namespace AddFlowSourcesRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: AddFlowSourcesRequest): any => ({ ...obj, }); @@ -1036,6 +1114,9 @@ export interface AddFlowSourcesResponse { } export namespace AddFlowSourcesResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: AddFlowSourcesResponse): any => ({ ...obj, }); @@ -1057,6 +1138,9 @@ export interface AddFlowVpcInterfacesRequest { } export namespace AddFlowVpcInterfacesRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: AddFlowVpcInterfacesRequest): any => ({ ...obj, }); @@ -1075,6 +1159,9 @@ export interface AddFlowVpcInterfacesResponse { } export namespace AddFlowVpcInterfacesResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: AddFlowVpcInterfacesResponse): any => ({ ...obj, }); @@ -1093,6 +1180,9 @@ export interface CreateFlow420Exception extends __SmithyException, $MetadataBear } export namespace CreateFlow420Exception { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateFlow420Exception): any => ({ ...obj, }); @@ -1116,6 +1206,9 @@ export interface FailoverConfig { } export namespace FailoverConfig { + /** + * @internal + */ export const filterSensitiveLog = (obj: FailoverConfig): any => ({ ...obj, }); @@ -1163,6 +1256,9 @@ export interface CreateFlowRequest { } export namespace CreateFlowRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateFlowRequest): any => ({ ...obj, }); @@ -1230,6 +1326,9 @@ export interface Flow { } export namespace Flow { + /** + * @internal + */ export const filterSensitiveLog = (obj: Flow): any => ({ ...obj, }); @@ -1243,6 +1342,9 @@ export interface CreateFlowResponse { } export namespace CreateFlowResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateFlowResponse): any => ({ ...obj, }); @@ -1256,6 +1358,9 @@ export interface DeleteFlowRequest { } export namespace DeleteFlowRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteFlowRequest): any => ({ ...obj, }); @@ -1274,6 +1379,9 @@ export interface DeleteFlowResponse { } export namespace DeleteFlowResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteFlowResponse): any => ({ ...obj, }); @@ -1287,6 +1395,9 @@ export interface DescribeFlowRequest { } export namespace DescribeFlowRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeFlowRequest): any => ({ ...obj, }); @@ -1303,6 +1414,9 @@ export interface Messages { } export namespace Messages { + /** + * @internal + */ export const filterSensitiveLog = (obj: Messages): any => ({ ...obj, }); @@ -1321,6 +1435,9 @@ export interface DescribeFlowResponse { } export namespace DescribeFlowResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeFlowResponse): any => ({ ...obj, }); @@ -1334,6 +1451,9 @@ export interface DescribeOfferingRequest { } export namespace DescribeOfferingRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeOfferingRequest): any => ({ ...obj, }); @@ -1347,6 +1467,9 @@ export interface DescribeOfferingResponse { } export namespace DescribeOfferingResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeOfferingResponse): any => ({ ...obj, }); @@ -1360,6 +1483,9 @@ export interface DescribeReservationRequest { } export namespace DescribeReservationRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeReservationRequest): any => ({ ...obj, }); @@ -1373,6 +1499,9 @@ export interface DescribeReservationResponse { } export namespace DescribeReservationResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeReservationResponse): any => ({ ...obj, }); @@ -1391,6 +1520,9 @@ export interface GrantFlowEntitlements420Exception extends __SmithyException, $M } export namespace GrantFlowEntitlements420Exception { + /** + * @internal + */ export const filterSensitiveLog = (obj: GrantFlowEntitlements420Exception): any => ({ ...obj, }); @@ -1412,6 +1544,9 @@ export interface GrantFlowEntitlementsRequest { } export namespace GrantFlowEntitlementsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GrantFlowEntitlementsRequest): any => ({ ...obj, }); @@ -1430,6 +1565,9 @@ export interface GrantFlowEntitlementsResponse { } export namespace GrantFlowEntitlementsResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: GrantFlowEntitlementsResponse): any => ({ ...obj, }); @@ -1448,6 +1586,9 @@ export interface ListEntitlementsRequest { } export namespace ListEntitlementsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListEntitlementsRequest): any => ({ ...obj, }); @@ -1466,6 +1607,9 @@ export interface ListEntitlementsResponse { } export namespace ListEntitlementsResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListEntitlementsResponse): any => ({ ...obj, }); @@ -1484,6 +1628,9 @@ export interface ListFlowsRequest { } export namespace ListFlowsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListFlowsRequest): any => ({ ...obj, }); @@ -1502,6 +1649,9 @@ export interface ListFlowsResponse { } export namespace ListFlowsResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListFlowsResponse): any => ({ ...obj, }); @@ -1520,6 +1670,9 @@ export interface ListOfferingsRequest { } export namespace ListOfferingsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListOfferingsRequest): any => ({ ...obj, }); @@ -1538,6 +1691,9 @@ export interface ListOfferingsResponse { } export namespace ListOfferingsResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListOfferingsResponse): any => ({ ...obj, }); @@ -1556,6 +1712,9 @@ export interface ListReservationsRequest { } export namespace ListReservationsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListReservationsRequest): any => ({ ...obj, }); @@ -1574,6 +1733,9 @@ export interface ListReservationsResponse { } export namespace ListReservationsResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListReservationsResponse): any => ({ ...obj, }); @@ -1587,6 +1749,9 @@ export interface ListTagsForResourceRequest { } export namespace ListTagsForResourceRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListTagsForResourceRequest): any => ({ ...obj, }); @@ -1600,6 +1765,9 @@ export interface ListTagsForResourceResponse { } export namespace ListTagsForResourceResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListTagsForResourceResponse): any => ({ ...obj, }); @@ -1626,6 +1794,9 @@ export interface PurchaseOfferingRequest { } export namespace PurchaseOfferingRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: PurchaseOfferingRequest): any => ({ ...obj, }); @@ -1639,6 +1810,9 @@ export interface PurchaseOfferingResponse { } export namespace PurchaseOfferingResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: PurchaseOfferingResponse): any => ({ ...obj, }); @@ -1657,6 +1831,9 @@ export interface RemoveFlowOutputRequest { } export namespace RemoveFlowOutputRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: RemoveFlowOutputRequest): any => ({ ...obj, }); @@ -1675,6 +1852,9 @@ export interface RemoveFlowOutputResponse { } export namespace RemoveFlowOutputResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: RemoveFlowOutputResponse): any => ({ ...obj, }); @@ -1693,6 +1873,9 @@ export interface RemoveFlowSourceRequest { } export namespace RemoveFlowSourceRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: RemoveFlowSourceRequest): any => ({ ...obj, }); @@ -1711,6 +1894,9 @@ export interface RemoveFlowSourceResponse { } export namespace RemoveFlowSourceResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: RemoveFlowSourceResponse): any => ({ ...obj, }); @@ -1729,6 +1915,9 @@ export interface RemoveFlowVpcInterfaceRequest { } export namespace RemoveFlowVpcInterfaceRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: RemoveFlowVpcInterfaceRequest): any => ({ ...obj, }); @@ -1752,6 +1941,9 @@ export interface RemoveFlowVpcInterfaceResponse { } export namespace RemoveFlowVpcInterfaceResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: RemoveFlowVpcInterfaceResponse): any => ({ ...obj, }); @@ -1770,6 +1962,9 @@ export interface RevokeFlowEntitlementRequest { } export namespace RevokeFlowEntitlementRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: RevokeFlowEntitlementRequest): any => ({ ...obj, }); @@ -1788,6 +1983,9 @@ export interface RevokeFlowEntitlementResponse { } export namespace RevokeFlowEntitlementResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: RevokeFlowEntitlementResponse): any => ({ ...obj, }); @@ -1801,6 +1999,9 @@ export interface StartFlowRequest { } export namespace StartFlowRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: StartFlowRequest): any => ({ ...obj, }); @@ -1819,6 +2020,9 @@ export interface StartFlowResponse { } export namespace StartFlowResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: StartFlowResponse): any => ({ ...obj, }); @@ -1832,6 +2036,9 @@ export interface StopFlowRequest { } export namespace StopFlowRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: StopFlowRequest): any => ({ ...obj, }); @@ -1850,6 +2057,9 @@ export interface StopFlowResponse { } export namespace StopFlowResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: StopFlowResponse): any => ({ ...obj, }); @@ -1871,6 +2081,9 @@ export interface TagResourceRequest { } export namespace TagResourceRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: TagResourceRequest): any => ({ ...obj, }); @@ -1889,6 +2102,9 @@ export interface UntagResourceRequest { } export namespace UntagResourceRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: UntagResourceRequest): any => ({ ...obj, }); @@ -1907,6 +2123,9 @@ export interface UpdateFailoverConfig { } export namespace UpdateFailoverConfig { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateFailoverConfig): any => ({ ...obj, }); @@ -1928,6 +2147,9 @@ export interface UpdateFlowRequest { } export namespace UpdateFlowRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateFlowRequest): any => ({ ...obj, }); @@ -1941,6 +2163,9 @@ export interface UpdateFlowResponse { } export namespace UpdateFlowResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateFlowResponse): any => ({ ...obj, }); @@ -1997,6 +2222,9 @@ export interface UpdateEncryption { } export namespace UpdateEncryption { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateEncryption): any => ({ ...obj, }); @@ -2038,6 +2266,9 @@ export interface UpdateFlowEntitlementRequest { } export namespace UpdateFlowEntitlementRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateFlowEntitlementRequest): any => ({ ...obj, }); @@ -2056,6 +2287,9 @@ export interface UpdateFlowEntitlementResponse { } export namespace UpdateFlowEntitlementResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateFlowEntitlementResponse): any => ({ ...obj, }); @@ -2137,6 +2371,9 @@ export interface UpdateFlowOutputRequest { } export namespace UpdateFlowOutputRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateFlowOutputRequest): any => ({ ...obj, }); @@ -2155,6 +2392,9 @@ export interface UpdateFlowOutputResponse { } export namespace UpdateFlowOutputResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateFlowOutputResponse): any => ({ ...obj, }); @@ -2231,6 +2471,9 @@ export interface UpdateFlowSourceRequest { } export namespace UpdateFlowSourceRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateFlowSourceRequest): any => ({ ...obj, }); @@ -2249,6 +2492,9 @@ export interface UpdateFlowSourceResponse { } export namespace UpdateFlowSourceResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateFlowSourceResponse): any => ({ ...obj, }); diff --git a/clients/client-mediaconvert/commands/AssociateCertificateCommand.ts b/clients/client-mediaconvert/commands/AssociateCertificateCommand.ts index e1a9a5f3b7a4..83e080a9a084 100644 --- a/clients/client-mediaconvert/commands/AssociateCertificateCommand.ts +++ b/clients/client-mediaconvert/commands/AssociateCertificateCommand.ts @@ -22,6 +22,20 @@ export interface AssociateCertificateCommandOutput extends AssociateCertificateR /** * Associates an AWS Certificate Manager (ACM) Amazon Resource Name (ARN) with AWS Elemental MediaConvert. + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { MediaConvertClient, AssociateCertificateCommand } from "@aws-sdk/client-mediaconvert"; // ES Modules import + * // const { MediaConvertClient, AssociateCertificateCommand } = require("@aws-sdk/client-mediaconvert"); // CommonJS import + * const client = new MediaConvertClient(config); + * const command = new AssociateCertificateCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link AssociateCertificateCommandInput} for command's `input` shape. + * @see {@link AssociateCertificateCommandOutput} for command's `response` shape. + * @see {@link MediaConvertClientResolvedConfig | config} for command's `input` shape. + * */ export class AssociateCertificateCommand extends $Command< AssociateCertificateCommandInput, diff --git a/clients/client-mediaconvert/commands/CancelJobCommand.ts b/clients/client-mediaconvert/commands/CancelJobCommand.ts index 8e09e1eb83be..ffc53d01cfef 100644 --- a/clients/client-mediaconvert/commands/CancelJobCommand.ts +++ b/clients/client-mediaconvert/commands/CancelJobCommand.ts @@ -22,6 +22,20 @@ export interface CancelJobCommandOutput extends CancelJobResponse, __MetadataBea /** * Permanently cancel a job. Once you have canceled a job, you can't start it again. + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { MediaConvertClient, CancelJobCommand } from "@aws-sdk/client-mediaconvert"; // ES Modules import + * // const { MediaConvertClient, CancelJobCommand } = require("@aws-sdk/client-mediaconvert"); // CommonJS import + * const client = new MediaConvertClient(config); + * const command = new CancelJobCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CancelJobCommandInput} for command's `input` shape. + * @see {@link CancelJobCommandOutput} for command's `response` shape. + * @see {@link MediaConvertClientResolvedConfig | config} for command's `input` shape. + * */ export class CancelJobCommand extends $Command< CancelJobCommandInput, diff --git a/clients/client-mediaconvert/commands/CreateJobCommand.ts b/clients/client-mediaconvert/commands/CreateJobCommand.ts index af0800a5d05f..818d8c2abb6d 100644 --- a/clients/client-mediaconvert/commands/CreateJobCommand.ts +++ b/clients/client-mediaconvert/commands/CreateJobCommand.ts @@ -22,6 +22,20 @@ export interface CreateJobCommandOutput extends CreateJobResponse, __MetadataBea /** * 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 + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { MediaConvertClient, CreateJobCommand } from "@aws-sdk/client-mediaconvert"; // ES Modules import + * // const { MediaConvertClient, CreateJobCommand } = require("@aws-sdk/client-mediaconvert"); // CommonJS import + * const client = new MediaConvertClient(config); + * const command = new CreateJobCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreateJobCommandInput} for command's `input` shape. + * @see {@link CreateJobCommandOutput} for command's `response` shape. + * @see {@link MediaConvertClientResolvedConfig | config} for command's `input` shape. + * */ export class CreateJobCommand extends $Command< CreateJobCommandInput, diff --git a/clients/client-mediaconvert/commands/CreateJobTemplateCommand.ts b/clients/client-mediaconvert/commands/CreateJobTemplateCommand.ts index c82f15047792..3971f8f3a78b 100644 --- a/clients/client-mediaconvert/commands/CreateJobTemplateCommand.ts +++ b/clients/client-mediaconvert/commands/CreateJobTemplateCommand.ts @@ -22,6 +22,20 @@ export interface CreateJobTemplateCommandOutput extends CreateJobTemplateRespons /** * 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 + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { MediaConvertClient, CreateJobTemplateCommand } from "@aws-sdk/client-mediaconvert"; // ES Modules import + * // const { MediaConvertClient, CreateJobTemplateCommand } = require("@aws-sdk/client-mediaconvert"); // CommonJS import + * const client = new MediaConvertClient(config); + * const command = new CreateJobTemplateCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreateJobTemplateCommandInput} for command's `input` shape. + * @see {@link CreateJobTemplateCommandOutput} for command's `response` shape. + * @see {@link MediaConvertClientResolvedConfig | config} for command's `input` shape. + * */ export class CreateJobTemplateCommand extends $Command< CreateJobTemplateCommandInput, diff --git a/clients/client-mediaconvert/commands/CreatePresetCommand.ts b/clients/client-mediaconvert/commands/CreatePresetCommand.ts index 8ea6c7471a2e..cdaac7f3b742 100644 --- a/clients/client-mediaconvert/commands/CreatePresetCommand.ts +++ b/clients/client-mediaconvert/commands/CreatePresetCommand.ts @@ -22,6 +22,20 @@ export interface CreatePresetCommandOutput extends CreatePresetResponse, __Metad /** * 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 + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { MediaConvertClient, CreatePresetCommand } from "@aws-sdk/client-mediaconvert"; // ES Modules import + * // const { MediaConvertClient, CreatePresetCommand } = require("@aws-sdk/client-mediaconvert"); // CommonJS import + * const client = new MediaConvertClient(config); + * const command = new CreatePresetCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreatePresetCommandInput} for command's `input` shape. + * @see {@link CreatePresetCommandOutput} for command's `response` shape. + * @see {@link MediaConvertClientResolvedConfig | config} for command's `input` shape. + * */ export class CreatePresetCommand extends $Command< CreatePresetCommandInput, diff --git a/clients/client-mediaconvert/commands/CreateQueueCommand.ts b/clients/client-mediaconvert/commands/CreateQueueCommand.ts index 85284a375df6..22360424edee 100644 --- a/clients/client-mediaconvert/commands/CreateQueueCommand.ts +++ b/clients/client-mediaconvert/commands/CreateQueueCommand.ts @@ -22,6 +22,20 @@ export interface CreateQueueCommandOutput extends CreateQueueResponse, __Metadat /** * 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 + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { MediaConvertClient, CreateQueueCommand } from "@aws-sdk/client-mediaconvert"; // ES Modules import + * // const { MediaConvertClient, CreateQueueCommand } = require("@aws-sdk/client-mediaconvert"); // CommonJS import + * const client = new MediaConvertClient(config); + * const command = new CreateQueueCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreateQueueCommandInput} for command's `input` shape. + * @see {@link CreateQueueCommandOutput} for command's `response` shape. + * @see {@link MediaConvertClientResolvedConfig | config} for command's `input` shape. + * */ export class CreateQueueCommand extends $Command< CreateQueueCommandInput, diff --git a/clients/client-mediaconvert/commands/DeleteJobTemplateCommand.ts b/clients/client-mediaconvert/commands/DeleteJobTemplateCommand.ts index ced88b79562e..128cf7fb7b70 100644 --- a/clients/client-mediaconvert/commands/DeleteJobTemplateCommand.ts +++ b/clients/client-mediaconvert/commands/DeleteJobTemplateCommand.ts @@ -22,6 +22,20 @@ export interface DeleteJobTemplateCommandOutput extends DeleteJobTemplateRespons /** * Permanently delete a job template you have created. + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { MediaConvertClient, DeleteJobTemplateCommand } from "@aws-sdk/client-mediaconvert"; // ES Modules import + * // const { MediaConvertClient, DeleteJobTemplateCommand } = require("@aws-sdk/client-mediaconvert"); // CommonJS import + * const client = new MediaConvertClient(config); + * const command = new DeleteJobTemplateCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteJobTemplateCommandInput} for command's `input` shape. + * @see {@link DeleteJobTemplateCommandOutput} for command's `response` shape. + * @see {@link MediaConvertClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteJobTemplateCommand extends $Command< DeleteJobTemplateCommandInput, diff --git a/clients/client-mediaconvert/commands/DeletePresetCommand.ts b/clients/client-mediaconvert/commands/DeletePresetCommand.ts index 19f7a3357332..f39dc2c41722 100644 --- a/clients/client-mediaconvert/commands/DeletePresetCommand.ts +++ b/clients/client-mediaconvert/commands/DeletePresetCommand.ts @@ -22,6 +22,20 @@ export interface DeletePresetCommandOutput extends DeletePresetResponse, __Metad /** * Permanently delete a preset you have created. + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { MediaConvertClient, DeletePresetCommand } from "@aws-sdk/client-mediaconvert"; // ES Modules import + * // const { MediaConvertClient, DeletePresetCommand } = require("@aws-sdk/client-mediaconvert"); // CommonJS import + * const client = new MediaConvertClient(config); + * const command = new DeletePresetCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeletePresetCommandInput} for command's `input` shape. + * @see {@link DeletePresetCommandOutput} for command's `response` shape. + * @see {@link MediaConvertClientResolvedConfig | config} for command's `input` shape. + * */ export class DeletePresetCommand extends $Command< DeletePresetCommandInput, diff --git a/clients/client-mediaconvert/commands/DeleteQueueCommand.ts b/clients/client-mediaconvert/commands/DeleteQueueCommand.ts index 4a65e0ca769f..e4cc82c34aac 100644 --- a/clients/client-mediaconvert/commands/DeleteQueueCommand.ts +++ b/clients/client-mediaconvert/commands/DeleteQueueCommand.ts @@ -22,6 +22,20 @@ export interface DeleteQueueCommandOutput extends DeleteQueueResponse, __Metadat /** * Permanently delete a queue you have created. + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { MediaConvertClient, DeleteQueueCommand } from "@aws-sdk/client-mediaconvert"; // ES Modules import + * // const { MediaConvertClient, DeleteQueueCommand } = require("@aws-sdk/client-mediaconvert"); // CommonJS import + * const client = new MediaConvertClient(config); + * const command = new DeleteQueueCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteQueueCommandInput} for command's `input` shape. + * @see {@link DeleteQueueCommandOutput} for command's `response` shape. + * @see {@link MediaConvertClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteQueueCommand extends $Command< DeleteQueueCommandInput, diff --git a/clients/client-mediaconvert/commands/DescribeEndpointsCommand.ts b/clients/client-mediaconvert/commands/DescribeEndpointsCommand.ts index 97f0ff8b474a..68d2f1e26a2d 100644 --- a/clients/client-mediaconvert/commands/DescribeEndpointsCommand.ts +++ b/clients/client-mediaconvert/commands/DescribeEndpointsCommand.ts @@ -22,6 +22,20 @@ export interface DescribeEndpointsCommandOutput extends DescribeEndpointsRespons /** * Send an request with an empty body to the regional API endpoint to get your account API endpoint. + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { MediaConvertClient, DescribeEndpointsCommand } from "@aws-sdk/client-mediaconvert"; // ES Modules import + * // const { MediaConvertClient, DescribeEndpointsCommand } = require("@aws-sdk/client-mediaconvert"); // CommonJS import + * const client = new MediaConvertClient(config); + * const command = new DescribeEndpointsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeEndpointsCommandInput} for command's `input` shape. + * @see {@link DescribeEndpointsCommandOutput} for command's `response` shape. + * @see {@link MediaConvertClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeEndpointsCommand extends $Command< DescribeEndpointsCommandInput, diff --git a/clients/client-mediaconvert/commands/DisassociateCertificateCommand.ts b/clients/client-mediaconvert/commands/DisassociateCertificateCommand.ts index 8d2d997566b9..9ed171a79694 100644 --- a/clients/client-mediaconvert/commands/DisassociateCertificateCommand.ts +++ b/clients/client-mediaconvert/commands/DisassociateCertificateCommand.ts @@ -22,6 +22,20 @@ export interface DisassociateCertificateCommandOutput extends DisassociateCertif /** * Removes an association between the Amazon Resource Name (ARN) of an AWS Certificate Manager (ACM) certificate and an AWS Elemental MediaConvert resource. + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { MediaConvertClient, DisassociateCertificateCommand } from "@aws-sdk/client-mediaconvert"; // ES Modules import + * // const { MediaConvertClient, DisassociateCertificateCommand } = require("@aws-sdk/client-mediaconvert"); // CommonJS import + * const client = new MediaConvertClient(config); + * const command = new DisassociateCertificateCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DisassociateCertificateCommandInput} for command's `input` shape. + * @see {@link DisassociateCertificateCommandOutput} for command's `response` shape. + * @see {@link MediaConvertClientResolvedConfig | config} for command's `input` shape. + * */ export class DisassociateCertificateCommand extends $Command< DisassociateCertificateCommandInput, diff --git a/clients/client-mediaconvert/commands/GetJobCommand.ts b/clients/client-mediaconvert/commands/GetJobCommand.ts index b3e5748d0252..c58fd3634cd7 100644 --- a/clients/client-mediaconvert/commands/GetJobCommand.ts +++ b/clients/client-mediaconvert/commands/GetJobCommand.ts @@ -19,6 +19,20 @@ export interface GetJobCommandOutput extends GetJobResponse, __MetadataBearer {} /** * Retrieve the JSON for a specific completed transcoding job. + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { MediaConvertClient, GetJobCommand } from "@aws-sdk/client-mediaconvert"; // ES Modules import + * // const { MediaConvertClient, GetJobCommand } = require("@aws-sdk/client-mediaconvert"); // CommonJS import + * const client = new MediaConvertClient(config); + * const command = new GetJobCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetJobCommandInput} for command's `input` shape. + * @see {@link GetJobCommandOutput} for command's `response` shape. + * @see {@link MediaConvertClientResolvedConfig | config} for command's `input` shape. + * */ export class GetJobCommand extends $Command { // Start section: command_properties diff --git a/clients/client-mediaconvert/commands/GetJobTemplateCommand.ts b/clients/client-mediaconvert/commands/GetJobTemplateCommand.ts index bd03033db717..4df57f26f4e8 100644 --- a/clients/client-mediaconvert/commands/GetJobTemplateCommand.ts +++ b/clients/client-mediaconvert/commands/GetJobTemplateCommand.ts @@ -22,6 +22,20 @@ export interface GetJobTemplateCommandOutput extends GetJobTemplateResponse, __M /** * Retrieve the JSON for a specific job template. + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { MediaConvertClient, GetJobTemplateCommand } from "@aws-sdk/client-mediaconvert"; // ES Modules import + * // const { MediaConvertClient, GetJobTemplateCommand } = require("@aws-sdk/client-mediaconvert"); // CommonJS import + * const client = new MediaConvertClient(config); + * const command = new GetJobTemplateCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetJobTemplateCommandInput} for command's `input` shape. + * @see {@link GetJobTemplateCommandOutput} for command's `response` shape. + * @see {@link MediaConvertClientResolvedConfig | config} for command's `input` shape. + * */ export class GetJobTemplateCommand extends $Command< GetJobTemplateCommandInput, diff --git a/clients/client-mediaconvert/commands/GetPresetCommand.ts b/clients/client-mediaconvert/commands/GetPresetCommand.ts index fe6dc4b08e0d..dafb0dba3538 100644 --- a/clients/client-mediaconvert/commands/GetPresetCommand.ts +++ b/clients/client-mediaconvert/commands/GetPresetCommand.ts @@ -22,6 +22,20 @@ export interface GetPresetCommandOutput extends GetPresetResponse, __MetadataBea /** * Retrieve the JSON for a specific preset. + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { MediaConvertClient, GetPresetCommand } from "@aws-sdk/client-mediaconvert"; // ES Modules import + * // const { MediaConvertClient, GetPresetCommand } = require("@aws-sdk/client-mediaconvert"); // CommonJS import + * const client = new MediaConvertClient(config); + * const command = new GetPresetCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetPresetCommandInput} for command's `input` shape. + * @see {@link GetPresetCommandOutput} for command's `response` shape. + * @see {@link MediaConvertClientResolvedConfig | config} for command's `input` shape. + * */ export class GetPresetCommand extends $Command< GetPresetCommandInput, diff --git a/clients/client-mediaconvert/commands/GetQueueCommand.ts b/clients/client-mediaconvert/commands/GetQueueCommand.ts index 6f93a77b2774..b18ed923f144 100644 --- a/clients/client-mediaconvert/commands/GetQueueCommand.ts +++ b/clients/client-mediaconvert/commands/GetQueueCommand.ts @@ -22,6 +22,20 @@ export interface GetQueueCommandOutput extends GetQueueResponse, __MetadataBeare /** * Retrieve the JSON for a specific queue. + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { MediaConvertClient, GetQueueCommand } from "@aws-sdk/client-mediaconvert"; // ES Modules import + * // const { MediaConvertClient, GetQueueCommand } = require("@aws-sdk/client-mediaconvert"); // CommonJS import + * const client = new MediaConvertClient(config); + * const command = new GetQueueCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetQueueCommandInput} for command's `input` shape. + * @see {@link GetQueueCommandOutput} for command's `response` shape. + * @see {@link MediaConvertClientResolvedConfig | config} for command's `input` shape. + * */ export class GetQueueCommand extends $Command< GetQueueCommandInput, diff --git a/clients/client-mediaconvert/commands/ListJobTemplatesCommand.ts b/clients/client-mediaconvert/commands/ListJobTemplatesCommand.ts index 24d92934bbfd..1a0b931d63ec 100644 --- a/clients/client-mediaconvert/commands/ListJobTemplatesCommand.ts +++ b/clients/client-mediaconvert/commands/ListJobTemplatesCommand.ts @@ -22,6 +22,20 @@ export interface ListJobTemplatesCommandOutput extends ListJobTemplatesResponse, /** * 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 + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { MediaConvertClient, ListJobTemplatesCommand } from "@aws-sdk/client-mediaconvert"; // ES Modules import + * // const { MediaConvertClient, ListJobTemplatesCommand } = require("@aws-sdk/client-mediaconvert"); // CommonJS import + * const client = new MediaConvertClient(config); + * const command = new ListJobTemplatesCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListJobTemplatesCommandInput} for command's `input` shape. + * @see {@link ListJobTemplatesCommandOutput} for command's `response` shape. + * @see {@link MediaConvertClientResolvedConfig | config} for command's `input` shape. + * */ export class ListJobTemplatesCommand extends $Command< ListJobTemplatesCommandInput, diff --git a/clients/client-mediaconvert/commands/ListJobsCommand.ts b/clients/client-mediaconvert/commands/ListJobsCommand.ts index c3ab3f08782e..e7b5c45b8050 100644 --- a/clients/client-mediaconvert/commands/ListJobsCommand.ts +++ b/clients/client-mediaconvert/commands/ListJobsCommand.ts @@ -22,6 +22,20 @@ export interface ListJobsCommandOutput extends ListJobsResponse, __MetadataBeare /** * 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. + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { MediaConvertClient, ListJobsCommand } from "@aws-sdk/client-mediaconvert"; // ES Modules import + * // const { MediaConvertClient, ListJobsCommand } = require("@aws-sdk/client-mediaconvert"); // CommonJS import + * const client = new MediaConvertClient(config); + * const command = new ListJobsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListJobsCommandInput} for command's `input` shape. + * @see {@link ListJobsCommandOutput} for command's `response` shape. + * @see {@link MediaConvertClientResolvedConfig | config} for command's `input` shape. + * */ export class ListJobsCommand extends $Command< ListJobsCommandInput, diff --git a/clients/client-mediaconvert/commands/ListPresetsCommand.ts b/clients/client-mediaconvert/commands/ListPresetsCommand.ts index e34f3554d045..b6e8f7714014 100644 --- a/clients/client-mediaconvert/commands/ListPresetsCommand.ts +++ b/clients/client-mediaconvert/commands/ListPresetsCommand.ts @@ -22,6 +22,20 @@ export interface ListPresetsCommandOutput extends ListPresetsResponse, __Metadat /** * 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. + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { MediaConvertClient, ListPresetsCommand } from "@aws-sdk/client-mediaconvert"; // ES Modules import + * // const { MediaConvertClient, ListPresetsCommand } = require("@aws-sdk/client-mediaconvert"); // CommonJS import + * const client = new MediaConvertClient(config); + * const command = new ListPresetsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListPresetsCommandInput} for command's `input` shape. + * @see {@link ListPresetsCommandOutput} for command's `response` shape. + * @see {@link MediaConvertClientResolvedConfig | config} for command's `input` shape. + * */ export class ListPresetsCommand extends $Command< ListPresetsCommandInput, diff --git a/clients/client-mediaconvert/commands/ListQueuesCommand.ts b/clients/client-mediaconvert/commands/ListQueuesCommand.ts index 22d42901848b..65d958498231 100644 --- a/clients/client-mediaconvert/commands/ListQueuesCommand.ts +++ b/clients/client-mediaconvert/commands/ListQueuesCommand.ts @@ -22,6 +22,20 @@ export interface ListQueuesCommandOutput extends ListQueuesResponse, __MetadataB /** * 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. + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { MediaConvertClient, ListQueuesCommand } from "@aws-sdk/client-mediaconvert"; // ES Modules import + * // const { MediaConvertClient, ListQueuesCommand } = require("@aws-sdk/client-mediaconvert"); // CommonJS import + * const client = new MediaConvertClient(config); + * const command = new ListQueuesCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListQueuesCommandInput} for command's `input` shape. + * @see {@link ListQueuesCommandOutput} for command's `response` shape. + * @see {@link MediaConvertClientResolvedConfig | config} for command's `input` shape. + * */ export class ListQueuesCommand extends $Command< ListQueuesCommandInput, diff --git a/clients/client-mediaconvert/commands/ListTagsForResourceCommand.ts b/clients/client-mediaconvert/commands/ListTagsForResourceCommand.ts index 158c273ed723..5ce380d8c462 100644 --- a/clients/client-mediaconvert/commands/ListTagsForResourceCommand.ts +++ b/clients/client-mediaconvert/commands/ListTagsForResourceCommand.ts @@ -22,6 +22,20 @@ export interface ListTagsForResourceCommandOutput extends ListTagsForResourceRes /** * Retrieve the tags for a MediaConvert resource. + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { MediaConvertClient, ListTagsForResourceCommand } from "@aws-sdk/client-mediaconvert"; // ES Modules import + * // const { MediaConvertClient, ListTagsForResourceCommand } = require("@aws-sdk/client-mediaconvert"); // CommonJS import + * const client = new MediaConvertClient(config); + * const command = new ListTagsForResourceCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListTagsForResourceCommandInput} for command's `input` shape. + * @see {@link ListTagsForResourceCommandOutput} for command's `response` shape. + * @see {@link MediaConvertClientResolvedConfig | config} for command's `input` shape. + * */ export class ListTagsForResourceCommand extends $Command< ListTagsForResourceCommandInput, diff --git a/clients/client-mediaconvert/commands/TagResourceCommand.ts b/clients/client-mediaconvert/commands/TagResourceCommand.ts index 494ddc63a7f7..5084778a8149 100644 --- a/clients/client-mediaconvert/commands/TagResourceCommand.ts +++ b/clients/client-mediaconvert/commands/TagResourceCommand.ts @@ -22,6 +22,20 @@ export interface TagResourceCommandOutput extends TagResourceResponse, __Metadat /** * 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 + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { MediaConvertClient, TagResourceCommand } from "@aws-sdk/client-mediaconvert"; // ES Modules import + * // const { MediaConvertClient, TagResourceCommand } = require("@aws-sdk/client-mediaconvert"); // CommonJS import + * const client = new MediaConvertClient(config); + * const command = new TagResourceCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link TagResourceCommandInput} for command's `input` shape. + * @see {@link TagResourceCommandOutput} for command's `response` shape. + * @see {@link MediaConvertClientResolvedConfig | config} for command's `input` shape. + * */ export class TagResourceCommand extends $Command< TagResourceCommandInput, diff --git a/clients/client-mediaconvert/commands/UntagResourceCommand.ts b/clients/client-mediaconvert/commands/UntagResourceCommand.ts index 78470ccb0ee8..9e1b2ff511e2 100644 --- a/clients/client-mediaconvert/commands/UntagResourceCommand.ts +++ b/clients/client-mediaconvert/commands/UntagResourceCommand.ts @@ -22,6 +22,20 @@ export interface UntagResourceCommandOutput extends UntagResourceResponse, __Met /** * 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 + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { MediaConvertClient, UntagResourceCommand } from "@aws-sdk/client-mediaconvert"; // ES Modules import + * // const { MediaConvertClient, UntagResourceCommand } = require("@aws-sdk/client-mediaconvert"); // CommonJS import + * const client = new MediaConvertClient(config); + * const command = new UntagResourceCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link UntagResourceCommandInput} for command's `input` shape. + * @see {@link UntagResourceCommandOutput} for command's `response` shape. + * @see {@link MediaConvertClientResolvedConfig | config} for command's `input` shape. + * */ export class UntagResourceCommand extends $Command< UntagResourceCommandInput, diff --git a/clients/client-mediaconvert/commands/UpdateJobTemplateCommand.ts b/clients/client-mediaconvert/commands/UpdateJobTemplateCommand.ts index 078b78bd9fa2..acb26606d92c 100644 --- a/clients/client-mediaconvert/commands/UpdateJobTemplateCommand.ts +++ b/clients/client-mediaconvert/commands/UpdateJobTemplateCommand.ts @@ -22,6 +22,20 @@ export interface UpdateJobTemplateCommandOutput extends UpdateJobTemplateRespons /** * Modify one of your existing job templates. + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { MediaConvertClient, UpdateJobTemplateCommand } from "@aws-sdk/client-mediaconvert"; // ES Modules import + * // const { MediaConvertClient, UpdateJobTemplateCommand } = require("@aws-sdk/client-mediaconvert"); // CommonJS import + * const client = new MediaConvertClient(config); + * const command = new UpdateJobTemplateCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link UpdateJobTemplateCommandInput} for command's `input` shape. + * @see {@link UpdateJobTemplateCommandOutput} for command's `response` shape. + * @see {@link MediaConvertClientResolvedConfig | config} for command's `input` shape. + * */ export class UpdateJobTemplateCommand extends $Command< UpdateJobTemplateCommandInput, diff --git a/clients/client-mediaconvert/commands/UpdatePresetCommand.ts b/clients/client-mediaconvert/commands/UpdatePresetCommand.ts index 0e4455b69741..0bf7c7796694 100644 --- a/clients/client-mediaconvert/commands/UpdatePresetCommand.ts +++ b/clients/client-mediaconvert/commands/UpdatePresetCommand.ts @@ -22,6 +22,20 @@ export interface UpdatePresetCommandOutput extends UpdatePresetResponse, __Metad /** * Modify one of your existing presets. + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { MediaConvertClient, UpdatePresetCommand } from "@aws-sdk/client-mediaconvert"; // ES Modules import + * // const { MediaConvertClient, UpdatePresetCommand } = require("@aws-sdk/client-mediaconvert"); // CommonJS import + * const client = new MediaConvertClient(config); + * const command = new UpdatePresetCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link UpdatePresetCommandInput} for command's `input` shape. + * @see {@link UpdatePresetCommandOutput} for command's `response` shape. + * @see {@link MediaConvertClientResolvedConfig | config} for command's `input` shape. + * */ export class UpdatePresetCommand extends $Command< UpdatePresetCommandInput, diff --git a/clients/client-mediaconvert/commands/UpdateQueueCommand.ts b/clients/client-mediaconvert/commands/UpdateQueueCommand.ts index db400e9cc95f..67c1e11db3b7 100644 --- a/clients/client-mediaconvert/commands/UpdateQueueCommand.ts +++ b/clients/client-mediaconvert/commands/UpdateQueueCommand.ts @@ -22,6 +22,20 @@ export interface UpdateQueueCommandOutput extends UpdateQueueResponse, __Metadat /** * Modify one of your existing queues. + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { MediaConvertClient, UpdateQueueCommand } from "@aws-sdk/client-mediaconvert"; // ES Modules import + * // const { MediaConvertClient, UpdateQueueCommand } = require("@aws-sdk/client-mediaconvert"); // CommonJS import + * const client = new MediaConvertClient(config); + * const command = new UpdateQueueCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link UpdateQueueCommandInput} for command's `input` shape. + * @see {@link UpdateQueueCommandOutput} for command's `response` shape. + * @see {@link MediaConvertClientResolvedConfig | config} for command's `input` shape. + * */ export class UpdateQueueCommand extends $Command< UpdateQueueCommandInput, diff --git a/clients/client-mediaconvert/models/models_0.ts b/clients/client-mediaconvert/models/models_0.ts index a75c9e370633..6c09ea79bbfd 100644 --- a/clients/client-mediaconvert/models/models_0.ts +++ b/clients/client-mediaconvert/models/models_0.ts @@ -27,6 +27,9 @@ export interface AudioChannelTaggingSettings { } export namespace AudioChannelTaggingSettings { + /** + * @internal + */ export const filterSensitiveLog = (obj: AudioChannelTaggingSettings): any => ({ ...obj, }); @@ -90,6 +93,9 @@ export interface AudioNormalizationSettings { } export namespace AudioNormalizationSettings { + /** + * @internal + */ export const filterSensitiveLog = (obj: AudioNormalizationSettings): any => ({ ...obj, }); @@ -192,6 +198,9 @@ export interface AacSettings { } export namespace AacSettings { + /** + * @internal + */ export const filterSensitiveLog = (obj: AacSettings): any => ({ ...obj, }); @@ -304,6 +313,9 @@ export interface Ac3Settings { } export namespace Ac3Settings { + /** + * @internal + */ export const filterSensitiveLog = (obj: Ac3Settings): any => ({ ...obj, }); @@ -330,6 +342,9 @@ export interface AiffSettings { } export namespace AiffSettings { + /** + * @internal + */ export const filterSensitiveLog = (obj: AiffSettings): any => ({ ...obj, }); @@ -486,6 +501,9 @@ export interface Eac3AtmosSettings { } export namespace Eac3AtmosSettings { + /** + * @internal + */ export const filterSensitiveLog = (obj: Eac3AtmosSettings): any => ({ ...obj, }); @@ -688,6 +706,9 @@ export interface Eac3Settings { } export namespace Eac3Settings { + /** + * @internal + */ export const filterSensitiveLog = (obj: Eac3Settings): any => ({ ...obj, }); @@ -714,6 +735,9 @@ export interface Mp2Settings { } export namespace Mp2Settings { + /** + * @internal + */ export const filterSensitiveLog = (obj: Mp2Settings): any => ({ ...obj, }); @@ -755,6 +779,9 @@ export interface Mp3Settings { } export namespace Mp3Settings { + /** + * @internal + */ export const filterSensitiveLog = (obj: Mp3Settings): any => ({ ...obj, }); @@ -781,6 +808,9 @@ export interface OpusSettings { } export namespace OpusSettings { + /** + * @internal + */ export const filterSensitiveLog = (obj: OpusSettings): any => ({ ...obj, }); @@ -807,6 +837,9 @@ export interface VorbisSettings { } export namespace VorbisSettings { + /** + * @internal + */ export const filterSensitiveLog = (obj: VorbisSettings): any => ({ ...obj, }); @@ -843,6 +876,9 @@ export interface WavSettings { } export namespace WavSettings { + /** + * @internal + */ export const filterSensitiveLog = (obj: WavSettings): any => ({ ...obj, }); @@ -909,6 +945,9 @@ export interface AudioCodecSettings { } export namespace AudioCodecSettings { + /** + * @internal + */ export const filterSensitiveLog = (obj: AudioCodecSettings): any => ({ ...obj, }); @@ -1129,6 +1168,9 @@ export interface OutputChannelMapping { } export namespace OutputChannelMapping { + /** + * @internal + */ export const filterSensitiveLog = (obj: OutputChannelMapping): any => ({ ...obj, }); @@ -1145,6 +1187,9 @@ export interface ChannelMapping { } export namespace ChannelMapping { + /** + * @internal + */ export const filterSensitiveLog = (obj: ChannelMapping): any => ({ ...obj, }); @@ -1171,6 +1216,9 @@ export interface RemixSettings { } export namespace RemixSettings { + /** + * @internal + */ export const filterSensitiveLog = (obj: RemixSettings): any => ({ ...obj, }); @@ -1237,6 +1285,9 @@ export interface AudioDescription { } export namespace AudioDescription { + /** + * @internal + */ export const filterSensitiveLog = (obj: AudioDescription): any => ({ ...obj, }); @@ -1383,6 +1434,9 @@ export interface BurninDestinationSettings { } export namespace BurninDestinationSettings { + /** + * @internal + */ export const filterSensitiveLog = (obj: BurninDestinationSettings): any => ({ ...obj, }); @@ -1548,6 +1602,9 @@ export interface DvbSubDestinationSettings { } export namespace DvbSubDestinationSettings { + /** + * @internal + */ export const filterSensitiveLog = (obj: DvbSubDestinationSettings): any => ({ ...obj, }); @@ -1569,6 +1626,9 @@ export interface EmbeddedDestinationSettings { } export namespace EmbeddedDestinationSettings { + /** + * @internal + */ export const filterSensitiveLog = (obj: EmbeddedDestinationSettings): any => ({ ...obj, }); @@ -1590,6 +1650,9 @@ export interface ImscDestinationSettings { } export namespace ImscDestinationSettings { + /** + * @internal + */ export const filterSensitiveLog = (obj: ImscDestinationSettings): any => ({ ...obj, }); @@ -1614,6 +1677,9 @@ export interface SccDestinationSettings { } export namespace SccDestinationSettings { + /** + * @internal + */ export const filterSensitiveLog = (obj: SccDestinationSettings): any => ({ ...obj, }); @@ -1643,6 +1709,9 @@ export interface TeletextDestinationSettings { } export namespace TeletextDestinationSettings { + /** + * @internal + */ export const filterSensitiveLog = (obj: TeletextDestinationSettings): any => ({ ...obj, }); @@ -1664,6 +1733,9 @@ export interface TtmlDestinationSettings { } export namespace TtmlDestinationSettings { + /** + * @internal + */ export const filterSensitiveLog = (obj: TtmlDestinationSettings): any => ({ ...obj, }); @@ -1685,6 +1757,9 @@ export interface WebvttDestinationSettings { } export namespace WebvttDestinationSettings { + /** + * @internal + */ export const filterSensitiveLog = (obj: WebvttDestinationSettings): any => ({ ...obj, }); @@ -1741,6 +1816,9 @@ export interface CaptionDestinationSettings { } export namespace CaptionDestinationSettings { + /** + * @internal + */ export const filterSensitiveLog = (obj: CaptionDestinationSettings): any => ({ ...obj, }); @@ -1777,6 +1855,9 @@ export interface CaptionDescription { } export namespace CaptionDescription { + /** + * @internal + */ export const filterSensitiveLog = (obj: CaptionDescription): any => ({ ...obj, }); @@ -1808,6 +1889,9 @@ export interface CaptionDescriptionPreset { } export namespace CaptionDescriptionPreset { + /** + * @internal + */ export const filterSensitiveLog = (obj: CaptionDescriptionPreset): any => ({ ...obj, }); @@ -1829,6 +1913,9 @@ export interface CmafAdditionalManifest { } export namespace CmafAdditionalManifest { + /** + * @internal + */ export const filterSensitiveLog = (obj: CmafAdditionalManifest): any => ({ ...obj, }); @@ -1850,6 +1937,9 @@ export interface DashAdditionalManifest { } export namespace DashAdditionalManifest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DashAdditionalManifest): any => ({ ...obj, }); @@ -1866,6 +1956,9 @@ export interface Endpoint { } export namespace Endpoint { + /** + * @internal + */ export const filterSensitiveLog = (obj: Endpoint): any => ({ ...obj, }); @@ -1887,6 +1980,9 @@ export interface HlsAdditionalManifest { } export namespace HlsAdditionalManifest { + /** + * @internal + */ export const filterSensitiveLog = (obj: HlsAdditionalManifest): any => ({ ...obj, }); @@ -1923,6 +2019,9 @@ export interface HlsCaptionLanguageMapping { } export namespace HlsCaptionLanguageMapping { + /** + * @internal + */ export const filterSensitiveLog = (obj: HlsCaptionLanguageMapping): any => ({ ...obj, }); @@ -1949,6 +2048,9 @@ export interface HopDestination { } export namespace HopDestination { + /** + * @internal + */ export const filterSensitiveLog = (obj: HopDestination): any => ({ ...obj, }); @@ -1970,6 +2072,9 @@ export interface Id3Insertion { } export namespace Id3Insertion { + /** + * @internal + */ export const filterSensitiveLog = (obj: Id3Insertion): any => ({ ...obj, }); @@ -1986,6 +2091,9 @@ export interface AudioSelectorGroup { } export namespace AudioSelectorGroup { + /** + * @internal + */ export const filterSensitiveLog = (obj: AudioSelectorGroup): any => ({ ...obj, }); @@ -2058,6 +2166,9 @@ export interface AudioSelector { } export namespace AudioSelector { + /** + * @internal + */ export const filterSensitiveLog = (obj: AudioSelector): any => ({ ...obj, }); @@ -2094,6 +2205,9 @@ export interface AncillarySourceSettings { } export namespace AncillarySourceSettings { + /** + * @internal + */ export const filterSensitiveLog = (obj: AncillarySourceSettings): any => ({ ...obj, }); @@ -2110,6 +2224,9 @@ export interface DvbSubSourceSettings { } export namespace DvbSubSourceSettings { + /** + * @internal + */ export const filterSensitiveLog = (obj: DvbSubSourceSettings): any => ({ ...obj, }); @@ -2151,6 +2268,9 @@ export interface EmbeddedSourceSettings { } export namespace EmbeddedSourceSettings { + /** + * @internal + */ export const filterSensitiveLog = (obj: EmbeddedSourceSettings): any => ({ ...obj, }); @@ -2177,6 +2297,9 @@ export interface CaptionSourceFramerate { } export namespace CaptionSourceFramerate { + /** + * @internal + */ export const filterSensitiveLog = (obj: CaptionSourceFramerate): any => ({ ...obj, }); @@ -2208,6 +2331,9 @@ export interface FileSourceSettings { } export namespace FileSourceSettings { + /** + * @internal + */ export const filterSensitiveLog = (obj: FileSourceSettings): any => ({ ...obj, }); @@ -2241,6 +2367,9 @@ export interface TeletextSourceSettings { } export namespace TeletextSourceSettings { + /** + * @internal + */ export const filterSensitiveLog = (obj: TeletextSourceSettings): any => ({ ...obj, }); @@ -2257,6 +2386,9 @@ export interface TrackSourceSettings { } export namespace TrackSourceSettings { + /** + * @internal + */ export const filterSensitiveLog = (obj: TrackSourceSettings): any => ({ ...obj, }); @@ -2303,6 +2435,9 @@ export interface CaptionSourceSettings { } export namespace CaptionSourceSettings { + /** + * @internal + */ export const filterSensitiveLog = (obj: CaptionSourceSettings): any => ({ ...obj, }); @@ -2329,6 +2464,9 @@ export interface CaptionSelector { } export namespace CaptionSelector { + /** + * @internal + */ export const filterSensitiveLog = (obj: CaptionSelector): any => ({ ...obj, }); @@ -2360,6 +2498,9 @@ export interface Rectangle { } export namespace Rectangle { + /** + * @internal + */ export const filterSensitiveLog = (obj: Rectangle): any => ({ ...obj, }); @@ -2402,6 +2543,9 @@ export interface InputDecryptionSettings { } export namespace InputDecryptionSettings { + /** + * @internal + */ export const filterSensitiveLog = (obj: InputDecryptionSettings): any => ({ ...obj, }); @@ -2479,6 +2623,9 @@ export interface InsertableImage { } export namespace InsertableImage { + /** + * @internal + */ export const filterSensitiveLog = (obj: InsertableImage): any => ({ ...obj, }); @@ -2495,6 +2642,9 @@ export interface ImageInserter { } export namespace ImageInserter { + /** + * @internal + */ export const filterSensitiveLog = (obj: ImageInserter): any => ({ ...obj, }); @@ -2516,6 +2666,9 @@ export interface InputClipping { } export namespace InputClipping { + /** + * @internal + */ export const filterSensitiveLog = (obj: InputClipping): any => ({ ...obj, }); @@ -2621,6 +2774,9 @@ export interface Hdr10Metadata { } export namespace Hdr10Metadata { + /** + * @internal + */ export const filterSensitiveLog = (obj: Hdr10Metadata): any => ({ ...obj, }); @@ -2675,6 +2831,9 @@ export interface VideoSelector { } export namespace VideoSelector { + /** + * @internal + */ export const filterSensitiveLog = (obj: VideoSelector): any => ({ ...obj, }); @@ -2786,6 +2945,9 @@ export interface Input { } export namespace Input { + /** + * @internal + */ export const filterSensitiveLog = (obj: Input): any => ({ ...obj, }); @@ -2882,6 +3044,9 @@ export interface InputTemplate { } export namespace InputTemplate { + /** + * @internal + */ export const filterSensitiveLog = (obj: InputTemplate): any => ({ ...obj, }); @@ -2904,6 +3069,9 @@ export interface AccelerationSettings { } export namespace AccelerationSettings { + /** + * @internal + */ export const filterSensitiveLog = (obj: AccelerationSettings): any => ({ ...obj, }); @@ -2945,6 +3113,9 @@ export interface JobMessages { } export namespace JobMessages { + /** + * @internal + */ export const filterSensitiveLog = (obj: JobMessages): any => ({ ...obj, }); @@ -2966,6 +3137,9 @@ export interface VideoDetail { } export namespace VideoDetail { + /** + * @internal + */ export const filterSensitiveLog = (obj: VideoDetail): any => ({ ...obj, }); @@ -2987,6 +3161,9 @@ export interface OutputDetail { } export namespace OutputDetail { + /** + * @internal + */ export const filterSensitiveLog = (obj: OutputDetail): any => ({ ...obj, }); @@ -3003,6 +3180,9 @@ export interface OutputGroupDetail { } export namespace OutputGroupDetail { + /** + * @internal + */ export const filterSensitiveLog = (obj: OutputGroupDetail): any => ({ ...obj, }); @@ -3029,6 +3209,9 @@ export interface QueueTransition { } export namespace QueueTransition { + /** + * @internal + */ export const filterSensitiveLog = (obj: QueueTransition): any => ({ ...obj, }); @@ -3045,6 +3228,9 @@ export interface AvailBlanking { } export namespace AvailBlanking { + /** + * @internal + */ export const filterSensitiveLog = (obj: AvailBlanking): any => ({ ...obj, }); @@ -3061,6 +3247,9 @@ export interface EsamManifestConfirmConditionNotification { } export namespace EsamManifestConfirmConditionNotification { + /** + * @internal + */ export const filterSensitiveLog = (obj: EsamManifestConfirmConditionNotification): any => ({ ...obj, }); @@ -3077,6 +3266,9 @@ export interface EsamSignalProcessingNotification { } export namespace EsamSignalProcessingNotification { + /** + * @internal + */ export const filterSensitiveLog = (obj: EsamSignalProcessingNotification): any => ({ ...obj, }); @@ -3103,6 +3295,9 @@ export interface EsamSettings { } export namespace EsamSettings { + /** + * @internal + */ export const filterSensitiveLog = (obj: EsamSettings): any => ({ ...obj, }); @@ -3124,6 +3319,9 @@ export interface MotionImageInsertionFramerate { } export namespace MotionImageInsertionFramerate { + /** + * @internal + */ export const filterSensitiveLog = (obj: MotionImageInsertionFramerate): any => ({ ...obj, }); @@ -3150,6 +3348,9 @@ export interface MotionImageInsertionOffset { } export namespace MotionImageInsertionOffset { + /** + * @internal + */ export const filterSensitiveLog = (obj: MotionImageInsertionOffset): any => ({ ...obj, }); @@ -3196,6 +3397,9 @@ export interface MotionImageInserter { } export namespace MotionImageInserter { + /** + * @internal + */ export const filterSensitiveLog = (obj: MotionImageInserter): any => ({ ...obj, }); @@ -3217,6 +3421,9 @@ export interface NielsenConfiguration { } export namespace NielsenConfiguration { + /** + * @internal + */ export const filterSensitiveLog = (obj: NielsenConfiguration): any => ({ ...obj, }); @@ -3299,6 +3506,9 @@ export interface NielsenNonLinearWatermarkSettings { } export namespace NielsenNonLinearWatermarkSettings { + /** + * @internal + */ export const filterSensitiveLog = (obj: NielsenNonLinearWatermarkSettings): any => ({ ...obj, }); @@ -3325,6 +3535,9 @@ export interface AutomatedAbrSettings { } export namespace AutomatedAbrSettings { + /** + * @internal + */ export const filterSensitiveLog = (obj: AutomatedAbrSettings): any => ({ ...obj, }); @@ -3341,6 +3554,9 @@ export interface AutomatedEncodingSettings { } export namespace AutomatedEncodingSettings { + /** + * @internal + */ export const filterSensitiveLog = (obj: AutomatedEncodingSettings): any => ({ ...obj, }); @@ -3374,6 +3590,9 @@ export interface S3DestinationAccessControl { } export namespace S3DestinationAccessControl { + /** + * @internal + */ export const filterSensitiveLog = (obj: S3DestinationAccessControl): any => ({ ...obj, }); @@ -3400,6 +3619,9 @@ export interface S3EncryptionSettings { } export namespace S3EncryptionSettings { + /** + * @internal + */ export const filterSensitiveLog = (obj: S3EncryptionSettings): any => ({ ...obj, }); @@ -3421,6 +3643,9 @@ export interface S3DestinationSettings { } export namespace S3DestinationSettings { + /** + * @internal + */ export const filterSensitiveLog = (obj: S3DestinationSettings): any => ({ ...obj, }); @@ -3437,6 +3662,9 @@ export interface DestinationSettings { } export namespace DestinationSettings { + /** + * @internal + */ export const filterSensitiveLog = (obj: DestinationSettings): any => ({ ...obj, }); @@ -3483,6 +3711,9 @@ export interface SpekeKeyProviderCmaf { } export namespace SpekeKeyProviderCmaf { + /** + * @internal + */ export const filterSensitiveLog = (obj: SpekeKeyProviderCmaf): any => ({ ...obj, }); @@ -3514,6 +3745,9 @@ export interface StaticKeyProvider { } export namespace StaticKeyProvider { + /** + * @internal + */ export const filterSensitiveLog = (obj: StaticKeyProvider): any => ({ ...obj, }); @@ -3560,6 +3794,9 @@ export interface CmafEncryptionSettings { } export namespace CmafEncryptionSettings { + /** + * @internal + */ export const filterSensitiveLog = (obj: CmafEncryptionSettings): any => ({ ...obj, }); @@ -3716,6 +3953,9 @@ export interface CmafGroupSettings { } export namespace CmafGroupSettings { + /** + * @internal + */ export const filterSensitiveLog = (obj: CmafGroupSettings): any => ({ ...obj, }); @@ -3758,6 +3998,9 @@ export interface SpekeKeyProvider { } export namespace SpekeKeyProvider { + /** + * @internal + */ export const filterSensitiveLog = (obj: SpekeKeyProvider): any => ({ ...obj, }); @@ -3779,6 +4022,9 @@ export interface DashIsoEncryptionSettings { } export namespace DashIsoEncryptionSettings { + /** + * @internal + */ export const filterSensitiveLog = (obj: DashIsoEncryptionSettings): any => ({ ...obj, }); @@ -3890,6 +4136,9 @@ export interface DashIsoGroupSettings { } export namespace DashIsoGroupSettings { + /** + * @internal + */ export const filterSensitiveLog = (obj: DashIsoGroupSettings): any => ({ ...obj, }); @@ -3911,6 +4160,9 @@ export interface FileGroupSettings { } export namespace FileGroupSettings { + /** + * @internal + */ export const filterSensitiveLog = (obj: FileGroupSettings): any => ({ ...obj, }); @@ -4003,6 +4255,9 @@ export interface HlsEncryptionSettings { } export namespace HlsEncryptionSettings { + /** + * @internal + */ export const filterSensitiveLog = (obj: HlsEncryptionSettings): any => ({ ...obj, }); @@ -4180,6 +4435,9 @@ export interface HlsGroupSettings { } export namespace HlsGroupSettings { + /** + * @internal + */ export const filterSensitiveLog = (obj: HlsGroupSettings): any => ({ ...obj, }); @@ -4201,6 +4459,9 @@ export interface MsSmoothAdditionalManifest { } export namespace MsSmoothAdditionalManifest { + /** + * @internal + */ export const filterSensitiveLog = (obj: MsSmoothAdditionalManifest): any => ({ ...obj, }); @@ -4222,6 +4483,9 @@ export interface MsSmoothEncryptionSettings { } export namespace MsSmoothEncryptionSettings { + /** + * @internal + */ export const filterSensitiveLog = (obj: MsSmoothEncryptionSettings): any => ({ ...obj, }); @@ -4273,6 +4537,9 @@ export interface MsSmoothGroupSettings { } export namespace MsSmoothGroupSettings { + /** + * @internal + */ export const filterSensitiveLog = (obj: MsSmoothGroupSettings): any => ({ ...obj, }); @@ -4322,6 +4589,9 @@ export interface OutputGroupSettings { } export namespace OutputGroupSettings { + /** + * @internal + */ export const filterSensitiveLog = (obj: OutputGroupSettings): any => ({ ...obj, }); @@ -4404,6 +4674,9 @@ export interface CmfcSettings { } export namespace CmfcSettings { + /** + * @internal + */ export const filterSensitiveLog = (obj: CmfcSettings): any => ({ ...obj, }); @@ -4439,6 +4712,9 @@ export interface F4vSettings { } export namespace F4vSettings { + /** + * @internal + */ export const filterSensitiveLog = (obj: F4vSettings): any => ({ ...obj, }); @@ -4480,6 +4756,9 @@ export interface DvbNitSettings { } export namespace DvbNitSettings { + /** + * @internal + */ export const filterSensitiveLog = (obj: DvbNitSettings): any => ({ ...obj, }); @@ -4518,6 +4797,9 @@ export interface DvbSdtSettings { } export namespace DvbSdtSettings { + /** + * @internal + */ export const filterSensitiveLog = (obj: DvbSdtSettings): any => ({ ...obj, }); @@ -4534,6 +4816,9 @@ export interface DvbTdtSettings { } export namespace DvbTdtSettings { + /** + * @internal + */ export const filterSensitiveLog = (obj: DvbTdtSettings): any => ({ ...obj, }); @@ -4585,6 +4870,9 @@ export interface M2tsScte35Esam { } export namespace M2tsScte35Esam { + /** + * @internal + */ export const filterSensitiveLog = (obj: M2tsScte35Esam): any => ({ ...obj, }); @@ -4800,6 +5088,9 @@ export interface M2tsSettings { } export namespace M2tsSettings { + /** + * @internal + */ export const filterSensitiveLog = (obj: M2tsSettings): any => ({ ...obj, }); @@ -4921,6 +5212,9 @@ export interface M3u8Settings { } export namespace M3u8Settings { + /** + * @internal + */ export const filterSensitiveLog = (obj: M3u8Settings): any => ({ ...obj, }); @@ -4982,6 +5276,9 @@ export interface MovSettings { } export namespace MovSettings { + /** + * @internal + */ export const filterSensitiveLog = (obj: MovSettings): any => ({ ...obj, }); @@ -5038,6 +5335,9 @@ export interface Mp4Settings { } export namespace Mp4Settings { + /** + * @internal + */ export const filterSensitiveLog = (obj: Mp4Settings): any => ({ ...obj, }); @@ -5099,6 +5399,9 @@ export interface MpdSettings { } export namespace MpdSettings { + /** + * @internal + */ export const filterSensitiveLog = (obj: MpdSettings): any => ({ ...obj, }); @@ -5131,6 +5434,9 @@ export interface MxfSettings { } export namespace MxfSettings { + /** + * @internal + */ export const filterSensitiveLog = (obj: MxfSettings): any => ({ ...obj, }); @@ -5187,6 +5493,9 @@ export interface ContainerSettings { } export namespace ContainerSettings { + /** + * @internal + */ export const filterSensitiveLog = (obj: ContainerSettings): any => ({ ...obj, }); @@ -5255,6 +5564,9 @@ export interface HlsSettings { } export namespace HlsSettings { + /** + * @internal + */ export const filterSensitiveLog = (obj: HlsSettings): any => ({ ...obj, }); @@ -5271,6 +5583,9 @@ export interface OutputSettings { } export namespace OutputSettings { + /** + * @internal + */ export const filterSensitiveLog = (obj: OutputSettings): any => ({ ...obj, }); @@ -5323,6 +5638,9 @@ export interface Av1QvbrSettings { } export namespace Av1QvbrSettings { + /** + * @internal + */ export const filterSensitiveLog = (obj: Av1QvbrSettings): any => ({ ...obj, }); @@ -5403,6 +5721,9 @@ export interface Av1Settings { } export namespace Av1Settings { + /** + * @internal + */ export const filterSensitiveLog = (obj: Av1Settings): any => ({ ...obj, }); diff --git a/clients/client-mediaconvert/models/models_1.ts b/clients/client-mediaconvert/models/models_1.ts index 8a4f63f0becf..22f8a652ad48 100644 --- a/clients/client-mediaconvert/models/models_1.ts +++ b/clients/client-mediaconvert/models/models_1.ts @@ -46,6 +46,9 @@ export interface AvcIntraUhdSettings { } export namespace AvcIntraUhdSettings { + /** + * @internal + */ export const filterSensitiveLog = (obj: AvcIntraUhdSettings): any => ({ ...obj, }); @@ -141,6 +144,9 @@ export interface AvcIntraSettings { } export namespace AvcIntraSettings { + /** + * @internal + */ export const filterSensitiveLog = (obj: AvcIntraSettings): any => ({ ...obj, }); @@ -185,6 +191,9 @@ export interface FrameCaptureSettings { } export namespace FrameCaptureSettings { + /** + * @internal + */ export const filterSensitiveLog = (obj: FrameCaptureSettings): any => ({ ...obj, }); @@ -310,6 +319,9 @@ export interface H264QvbrSettings { } export namespace H264QvbrSettings { + /** + * @internal + */ export const filterSensitiveLog = (obj: H264QvbrSettings): any => ({ ...obj, }); @@ -574,6 +586,9 @@ export interface H264Settings { } export namespace H264Settings { + /** + * @internal + */ export const filterSensitiveLog = (obj: H264Settings): any => ({ ...obj, }); @@ -692,6 +707,9 @@ export interface H265QvbrSettings { } export namespace H265QvbrSettings { + /** + * @internal + */ export const filterSensitiveLog = (obj: H265QvbrSettings): any => ({ ...obj, }); @@ -967,6 +985,9 @@ export interface H265Settings { } export namespace H265Settings { + /** + * @internal + */ export const filterSensitiveLog = (obj: H265Settings): any => ({ ...obj, }); @@ -1246,6 +1267,9 @@ export interface Mpeg2Settings { } export namespace Mpeg2Settings { + /** + * @internal + */ export const filterSensitiveLog = (obj: Mpeg2Settings): any => ({ ...obj, }); @@ -1363,6 +1387,9 @@ export interface ProresSettings { } export namespace ProresSettings { + /** + * @internal + */ export const filterSensitiveLog = (obj: ProresSettings): any => ({ ...obj, }); @@ -1456,6 +1483,9 @@ export interface Vc3Settings { } export namespace Vc3Settings { + /** + * @internal + */ export const filterSensitiveLog = (obj: Vc3Settings): any => ({ ...obj, }); @@ -1557,6 +1587,9 @@ export interface Vp8Settings { } export namespace Vp8Settings { + /** + * @internal + */ export const filterSensitiveLog = (obj: Vp8Settings): any => ({ ...obj, }); @@ -1658,6 +1691,9 @@ export interface Vp9Settings { } export namespace Vp9Settings { + /** + * @internal + */ export const filterSensitiveLog = (obj: Vp9Settings): any => ({ ...obj, }); @@ -1724,6 +1760,9 @@ export interface VideoCodecSettings { } export namespace VideoCodecSettings { + /** + * @internal + */ export const filterSensitiveLog = (obj: VideoCodecSettings): any => ({ ...obj, }); @@ -1799,6 +1838,9 @@ export interface ColorCorrector { } export namespace ColorCorrector { + /** + * @internal + */ export const filterSensitiveLog = (obj: ColorCorrector): any => ({ ...obj, }); @@ -1843,6 +1885,9 @@ export interface Deinterlacer { } export namespace Deinterlacer { + /** + * @internal + */ export const filterSensitiveLog = (obj: Deinterlacer): any => ({ ...obj, }); @@ -1864,6 +1909,9 @@ export interface DolbyVisionLevel6Metadata { } export namespace DolbyVisionLevel6Metadata { + /** + * @internal + */ export const filterSensitiveLog = (obj: DolbyVisionLevel6Metadata): any => ({ ...obj, }); @@ -1900,6 +1948,9 @@ export interface DolbyVision { } export namespace DolbyVision { + /** + * @internal + */ export const filterSensitiveLog = (obj: DolbyVision): any => ({ ...obj, }); @@ -1927,6 +1978,9 @@ export interface NoiseReducerFilterSettings { } export namespace NoiseReducerFilterSettings { + /** + * @internal + */ export const filterSensitiveLog = (obj: NoiseReducerFilterSettings): any => ({ ...obj, }); @@ -1953,6 +2007,9 @@ export interface NoiseReducerSpatialFilterSettings { } export namespace NoiseReducerSpatialFilterSettings { + /** + * @internal + */ export const filterSensitiveLog = (obj: NoiseReducerSpatialFilterSettings): any => ({ ...obj, }); @@ -1990,6 +2047,9 @@ export interface NoiseReducerTemporalFilterSettings { } export namespace NoiseReducerTemporalFilterSettings { + /** + * @internal + */ export const filterSensitiveLog = (obj: NoiseReducerTemporalFilterSettings): any => ({ ...obj, }); @@ -2021,6 +2081,9 @@ export interface NoiseReducer { } export namespace NoiseReducer { + /** + * @internal + */ export const filterSensitiveLog = (obj: NoiseReducer): any => ({ ...obj, }); @@ -2060,6 +2123,9 @@ export interface NexGuardFileMarkerSettings { } export namespace NexGuardFileMarkerSettings { + /** + * @internal + */ export const filterSensitiveLog = (obj: NexGuardFileMarkerSettings): any => ({ ...obj, }); @@ -2076,6 +2142,9 @@ export interface PartnerWatermarking { } export namespace PartnerWatermarking { + /** + * @internal + */ export const filterSensitiveLog = (obj: PartnerWatermarking): any => ({ ...obj, }); @@ -2114,6 +2183,9 @@ export interface TimecodeBurnin { } export namespace TimecodeBurnin { + /** + * @internal + */ export const filterSensitiveLog = (obj: TimecodeBurnin): any => ({ ...obj, }); @@ -2160,6 +2232,9 @@ export interface VideoPreprocessor { } export namespace VideoPreprocessor { + /** + * @internal + */ export const filterSensitiveLog = (obj: VideoPreprocessor): any => ({ ...obj, }); @@ -2246,6 +2321,9 @@ export interface VideoDescription { } export namespace VideoDescription { + /** + * @internal + */ export const filterSensitiveLog = (obj: VideoDescription): any => ({ ...obj, }); @@ -2297,6 +2375,9 @@ export interface Output { } export namespace Output { + /** + * @internal + */ export const filterSensitiveLog = (obj: Output): any => ({ ...obj, }); @@ -2333,6 +2414,9 @@ export interface OutputGroup { } export namespace OutputGroup { + /** + * @internal + */ export const filterSensitiveLog = (obj: OutputGroup): any => ({ ...obj, }); @@ -2370,6 +2454,9 @@ export interface TimecodeConfig { } export namespace TimecodeConfig { + /** + * @internal + */ export const filterSensitiveLog = (obj: TimecodeConfig): any => ({ ...obj, }); @@ -2386,6 +2473,9 @@ export interface TimedMetadataInsertion { } export namespace TimedMetadataInsertion { + /** + * @internal + */ export const filterSensitiveLog = (obj: TimedMetadataInsertion): any => ({ ...obj, }); @@ -2447,6 +2537,9 @@ export interface JobSettings { } export namespace JobSettings { + /** + * @internal + */ export const filterSensitiveLog = (obj: JobSettings): any => ({ ...obj, }); @@ -2504,6 +2597,9 @@ export interface Timing { } export namespace Timing { + /** + * @internal + */ export const filterSensitiveLog = (obj: Timing): any => ({ ...obj, }); @@ -2640,6 +2736,9 @@ export interface Job { } export namespace Job { + /** + * @internal + */ export const filterSensitiveLog = (obj: Job): any => ({ ...obj, }); @@ -2701,6 +2800,9 @@ export interface JobTemplateSettings { } export namespace JobTemplateSettings { + /** + * @internal + */ export const filterSensitiveLog = (obj: JobTemplateSettings): any => ({ ...obj, }); @@ -2782,6 +2884,9 @@ export interface JobTemplate { } export namespace JobTemplate { + /** + * @internal + */ export const filterSensitiveLog = (obj: JobTemplate): any => ({ ...obj, }); @@ -2813,6 +2918,9 @@ export interface PresetSettings { } export namespace PresetSettings { + /** + * @internal + */ export const filterSensitiveLog = (obj: PresetSettings): any => ({ ...obj, }); @@ -2864,6 +2972,9 @@ export interface Preset { } export namespace Preset { + /** + * @internal + */ export const filterSensitiveLog = (obj: Preset): any => ({ ...obj, }); @@ -2924,6 +3035,9 @@ export interface ReservationPlan { } export namespace ReservationPlan { + /** + * @internal + */ export const filterSensitiveLog = (obj: ReservationPlan): any => ({ ...obj, }); @@ -2995,6 +3109,9 @@ export interface Queue { } export namespace Queue { + /** + * @internal + */ export const filterSensitiveLog = (obj: Queue): any => ({ ...obj, }); @@ -3008,6 +3125,9 @@ export interface AssociateCertificateRequest { } export namespace AssociateCertificateRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: AssociateCertificateRequest): any => ({ ...obj, }); @@ -3016,6 +3136,9 @@ export namespace AssociateCertificateRequest { export interface AssociateCertificateResponse {} export namespace AssociateCertificateResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: AssociateCertificateResponse): any => ({ ...obj, }); @@ -3031,6 +3154,9 @@ export interface BadRequestException extends __SmithyException, $MetadataBearer } export namespace BadRequestException { + /** + * @internal + */ export const filterSensitiveLog = (obj: BadRequestException): any => ({ ...obj, }); @@ -3046,6 +3172,9 @@ export interface ConflictException extends __SmithyException, $MetadataBearer { } export namespace ConflictException { + /** + * @internal + */ export const filterSensitiveLog = (obj: ConflictException): any => ({ ...obj, }); @@ -3061,6 +3190,9 @@ export interface ForbiddenException extends __SmithyException, $MetadataBearer { } export namespace ForbiddenException { + /** + * @internal + */ export const filterSensitiveLog = (obj: ForbiddenException): any => ({ ...obj, }); @@ -3076,6 +3208,9 @@ export interface InternalServerErrorException extends __SmithyException, $Metada } export namespace InternalServerErrorException { + /** + * @internal + */ export const filterSensitiveLog = (obj: InternalServerErrorException): any => ({ ...obj, }); @@ -3091,6 +3226,9 @@ export interface NotFoundException extends __SmithyException, $MetadataBearer { } export namespace NotFoundException { + /** + * @internal + */ export const filterSensitiveLog = (obj: NotFoundException): any => ({ ...obj, }); @@ -3106,6 +3244,9 @@ export interface TooManyRequestsException extends __SmithyException, $MetadataBe } export namespace TooManyRequestsException { + /** + * @internal + */ export const filterSensitiveLog = (obj: TooManyRequestsException): any => ({ ...obj, }); @@ -3119,6 +3260,9 @@ export interface CancelJobRequest { } export namespace CancelJobRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: CancelJobRequest): any => ({ ...obj, }); @@ -3127,6 +3271,9 @@ export namespace CancelJobRequest { export interface CancelJobResponse {} export namespace CancelJobResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: CancelJobResponse): any => ({ ...obj, }); @@ -3200,6 +3347,9 @@ export interface CreateJobRequest { } export namespace CreateJobRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateJobRequest): any => ({ ...obj, }); @@ -3213,6 +3363,9 @@ export interface CreateJobResponse { } export namespace CreateJobResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateJobResponse): any => ({ ...obj, }); @@ -3271,6 +3424,9 @@ export interface CreateJobTemplateRequest { } export namespace CreateJobTemplateRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateJobTemplateRequest): any => ({ ...obj, }); @@ -3284,6 +3440,9 @@ export interface CreateJobTemplateResponse { } export namespace CreateJobTemplateResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateJobTemplateResponse): any => ({ ...obj, }); @@ -3317,6 +3476,9 @@ export interface CreatePresetRequest { } export namespace CreatePresetRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreatePresetRequest): any => ({ ...obj, }); @@ -3330,6 +3492,9 @@ export interface CreatePresetResponse { } export namespace CreatePresetResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreatePresetResponse): any => ({ ...obj, }); @@ -3356,6 +3521,9 @@ export interface ReservationPlanSettings { } export namespace ReservationPlanSettings { + /** + * @internal + */ export const filterSensitiveLog = (obj: ReservationPlanSettings): any => ({ ...obj, }); @@ -3394,6 +3562,9 @@ export interface CreateQueueRequest { } export namespace CreateQueueRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateQueueRequest): any => ({ ...obj, }); @@ -3407,6 +3578,9 @@ export interface CreateQueueResponse { } export namespace CreateQueueResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateQueueResponse): any => ({ ...obj, }); @@ -3420,6 +3594,9 @@ export interface DeleteJobTemplateRequest { } export namespace DeleteJobTemplateRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteJobTemplateRequest): any => ({ ...obj, }); @@ -3428,6 +3605,9 @@ export namespace DeleteJobTemplateRequest { export interface DeleteJobTemplateResponse {} export namespace DeleteJobTemplateResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteJobTemplateResponse): any => ({ ...obj, }); @@ -3441,6 +3621,9 @@ export interface DeletePresetRequest { } export namespace DeletePresetRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeletePresetRequest): any => ({ ...obj, }); @@ -3449,6 +3632,9 @@ export namespace DeletePresetRequest { export interface DeletePresetResponse {} export namespace DeletePresetResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeletePresetResponse): any => ({ ...obj, }); @@ -3462,6 +3648,9 @@ export interface DeleteQueueRequest { } export namespace DeleteQueueRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteQueueRequest): any => ({ ...obj, }); @@ -3470,6 +3659,9 @@ export namespace DeleteQueueRequest { export interface DeleteQueueResponse {} export namespace DeleteQueueResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteQueueResponse): any => ({ ...obj, }); @@ -3501,6 +3693,9 @@ export interface DescribeEndpointsRequest { } export namespace DescribeEndpointsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeEndpointsRequest): any => ({ ...obj, }); @@ -3519,6 +3714,9 @@ export interface DescribeEndpointsResponse { } export namespace DescribeEndpointsResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeEndpointsResponse): any => ({ ...obj, }); @@ -3532,6 +3730,9 @@ export interface DisassociateCertificateRequest { } export namespace DisassociateCertificateRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DisassociateCertificateRequest): any => ({ ...obj, }); @@ -3540,6 +3741,9 @@ export namespace DisassociateCertificateRequest { export interface DisassociateCertificateResponse {} export namespace DisassociateCertificateResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DisassociateCertificateResponse): any => ({ ...obj, }); @@ -3553,6 +3757,9 @@ export interface GetJobRequest { } export namespace GetJobRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetJobRequest): any => ({ ...obj, }); @@ -3566,6 +3773,9 @@ export interface GetJobResponse { } export namespace GetJobResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetJobResponse): any => ({ ...obj, }); @@ -3579,6 +3789,9 @@ export interface GetJobTemplateRequest { } export namespace GetJobTemplateRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetJobTemplateRequest): any => ({ ...obj, }); @@ -3592,6 +3805,9 @@ export interface GetJobTemplateResponse { } export namespace GetJobTemplateResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetJobTemplateResponse): any => ({ ...obj, }); @@ -3605,6 +3821,9 @@ export interface GetPresetRequest { } export namespace GetPresetRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetPresetRequest): any => ({ ...obj, }); @@ -3618,6 +3837,9 @@ export interface GetPresetResponse { } export namespace GetPresetResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetPresetResponse): any => ({ ...obj, }); @@ -3631,6 +3853,9 @@ export interface GetQueueRequest { } export namespace GetQueueRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetQueueRequest): any => ({ ...obj, }); @@ -3644,6 +3869,9 @@ export interface GetQueueResponse { } export namespace GetQueueResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetQueueResponse): any => ({ ...obj, }); @@ -3688,6 +3916,9 @@ export interface ListJobsRequest { } export namespace ListJobsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListJobsRequest): any => ({ ...obj, }); @@ -3706,6 +3937,9 @@ export interface ListJobsResponse { } export namespace ListJobsResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListJobsResponse): any => ({ ...obj, }); @@ -3739,6 +3973,9 @@ export interface ListJobTemplatesRequest { } export namespace ListJobTemplatesRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListJobTemplatesRequest): any => ({ ...obj, }); @@ -3757,6 +3994,9 @@ export interface ListJobTemplatesResponse { } export namespace ListJobTemplatesResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListJobTemplatesResponse): any => ({ ...obj, }); @@ -3796,6 +4036,9 @@ export interface ListPresetsRequest { } export namespace ListPresetsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListPresetsRequest): any => ({ ...obj, }); @@ -3814,6 +4057,9 @@ export interface ListPresetsResponse { } export namespace ListPresetsResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListPresetsResponse): any => ({ ...obj, }); @@ -3847,6 +4093,9 @@ export interface ListQueuesRequest { } export namespace ListQueuesRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListQueuesRequest): any => ({ ...obj, }); @@ -3865,6 +4114,9 @@ export interface ListQueuesResponse { } export namespace ListQueuesResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListQueuesResponse): any => ({ ...obj, }); @@ -3878,6 +4130,9 @@ export interface ListTagsForResourceRequest { } export namespace ListTagsForResourceRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListTagsForResourceRequest): any => ({ ...obj, }); @@ -3899,6 +4154,9 @@ export interface ResourceTags { } export namespace ResourceTags { + /** + * @internal + */ export const filterSensitiveLog = (obj: ResourceTags): any => ({ ...obj, }); @@ -3912,6 +4170,9 @@ export interface ListTagsForResourceResponse { } export namespace ListTagsForResourceResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListTagsForResourceResponse): any => ({ ...obj, }); @@ -3930,6 +4191,9 @@ export interface TagResourceRequest { } export namespace TagResourceRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: TagResourceRequest): any => ({ ...obj, }); @@ -3938,6 +4202,9 @@ export namespace TagResourceRequest { export interface TagResourceResponse {} export namespace TagResourceResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: TagResourceResponse): any => ({ ...obj, }); @@ -3956,6 +4223,9 @@ export interface UntagResourceRequest { } export namespace UntagResourceRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: UntagResourceRequest): any => ({ ...obj, }); @@ -3964,6 +4234,9 @@ export namespace UntagResourceRequest { export interface UntagResourceResponse {} export namespace UntagResourceResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: UntagResourceResponse): any => ({ ...obj, }); @@ -4017,6 +4290,9 @@ export interface UpdateJobTemplateRequest { } export namespace UpdateJobTemplateRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateJobTemplateRequest): any => ({ ...obj, }); @@ -4030,6 +4306,9 @@ export interface UpdateJobTemplateResponse { } export namespace UpdateJobTemplateResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateJobTemplateResponse): any => ({ ...obj, }); @@ -4058,6 +4337,9 @@ export interface UpdatePresetRequest { } export namespace UpdatePresetRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdatePresetRequest): any => ({ ...obj, }); @@ -4071,6 +4353,9 @@ export interface UpdatePresetResponse { } export namespace UpdatePresetResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdatePresetResponse): any => ({ ...obj, }); @@ -4099,6 +4384,9 @@ export interface UpdateQueueRequest { } export namespace UpdateQueueRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateQueueRequest): any => ({ ...obj, }); @@ -4112,6 +4400,9 @@ export interface UpdateQueueResponse { } export namespace UpdateQueueResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateQueueResponse): any => ({ ...obj, }); diff --git a/clients/client-medialive/commands/AcceptInputDeviceTransferCommand.ts b/clients/client-medialive/commands/AcceptInputDeviceTransferCommand.ts index 0fb8c75727eb..bbf60c5ee19c 100644 --- a/clients/client-medialive/commands/AcceptInputDeviceTransferCommand.ts +++ b/clients/client-medialive/commands/AcceptInputDeviceTransferCommand.ts @@ -22,6 +22,20 @@ export interface AcceptInputDeviceTransferCommandOutput extends AcceptInputDevic /** * Accept an incoming input device transfer. The ownership of the device will transfer to your AWS account. + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { MediaLiveClient, AcceptInputDeviceTransferCommand } from "@aws-sdk/client-medialive"; // ES Modules import + * // const { MediaLiveClient, AcceptInputDeviceTransferCommand } = require("@aws-sdk/client-medialive"); // CommonJS import + * const client = new MediaLiveClient(config); + * const command = new AcceptInputDeviceTransferCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link AcceptInputDeviceTransferCommandInput} for command's `input` shape. + * @see {@link AcceptInputDeviceTransferCommandOutput} for command's `response` shape. + * @see {@link MediaLiveClientResolvedConfig | config} for command's `input` shape. + * */ export class AcceptInputDeviceTransferCommand extends $Command< AcceptInputDeviceTransferCommandInput, diff --git a/clients/client-medialive/commands/BatchDeleteCommand.ts b/clients/client-medialive/commands/BatchDeleteCommand.ts index 3c45ee8644a6..66426c4a89db 100644 --- a/clients/client-medialive/commands/BatchDeleteCommand.ts +++ b/clients/client-medialive/commands/BatchDeleteCommand.ts @@ -22,6 +22,20 @@ export interface BatchDeleteCommandOutput extends BatchDeleteResponse, __Metadat /** * Starts delete of resources. + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { MediaLiveClient, BatchDeleteCommand } from "@aws-sdk/client-medialive"; // ES Modules import + * // const { MediaLiveClient, BatchDeleteCommand } = require("@aws-sdk/client-medialive"); // CommonJS import + * const client = new MediaLiveClient(config); + * const command = new BatchDeleteCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link BatchDeleteCommandInput} for command's `input` shape. + * @see {@link BatchDeleteCommandOutput} for command's `response` shape. + * @see {@link MediaLiveClientResolvedConfig | config} for command's `input` shape. + * */ export class BatchDeleteCommand extends $Command< BatchDeleteCommandInput, diff --git a/clients/client-medialive/commands/BatchStartCommand.ts b/clients/client-medialive/commands/BatchStartCommand.ts index dbdd6c1bc155..7024bb1ac19c 100644 --- a/clients/client-medialive/commands/BatchStartCommand.ts +++ b/clients/client-medialive/commands/BatchStartCommand.ts @@ -22,6 +22,20 @@ export interface BatchStartCommandOutput extends BatchStartResponse, __MetadataB /** * Starts existing resources + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { MediaLiveClient, BatchStartCommand } from "@aws-sdk/client-medialive"; // ES Modules import + * // const { MediaLiveClient, BatchStartCommand } = require("@aws-sdk/client-medialive"); // CommonJS import + * const client = new MediaLiveClient(config); + * const command = new BatchStartCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link BatchStartCommandInput} for command's `input` shape. + * @see {@link BatchStartCommandOutput} for command's `response` shape. + * @see {@link MediaLiveClientResolvedConfig | config} for command's `input` shape. + * */ export class BatchStartCommand extends $Command< BatchStartCommandInput, diff --git a/clients/client-medialive/commands/BatchStopCommand.ts b/clients/client-medialive/commands/BatchStopCommand.ts index 58d7038fd432..8417f0304742 100644 --- a/clients/client-medialive/commands/BatchStopCommand.ts +++ b/clients/client-medialive/commands/BatchStopCommand.ts @@ -22,6 +22,20 @@ export interface BatchStopCommandOutput extends BatchStopResponse, __MetadataBea /** * Stops running resources + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { MediaLiveClient, BatchStopCommand } from "@aws-sdk/client-medialive"; // ES Modules import + * // const { MediaLiveClient, BatchStopCommand } = require("@aws-sdk/client-medialive"); // CommonJS import + * const client = new MediaLiveClient(config); + * const command = new BatchStopCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link BatchStopCommandInput} for command's `input` shape. + * @see {@link BatchStopCommandOutput} for command's `response` shape. + * @see {@link MediaLiveClientResolvedConfig | config} for command's `input` shape. + * */ export class BatchStopCommand extends $Command< BatchStopCommandInput, diff --git a/clients/client-medialive/commands/BatchUpdateScheduleCommand.ts b/clients/client-medialive/commands/BatchUpdateScheduleCommand.ts index e589a45680d2..119a07d6d41e 100644 --- a/clients/client-medialive/commands/BatchUpdateScheduleCommand.ts +++ b/clients/client-medialive/commands/BatchUpdateScheduleCommand.ts @@ -22,6 +22,20 @@ export interface BatchUpdateScheduleCommandOutput extends BatchUpdateScheduleRes /** * Update a channel schedule + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { MediaLiveClient, BatchUpdateScheduleCommand } from "@aws-sdk/client-medialive"; // ES Modules import + * // const { MediaLiveClient, BatchUpdateScheduleCommand } = require("@aws-sdk/client-medialive"); // CommonJS import + * const client = new MediaLiveClient(config); + * const command = new BatchUpdateScheduleCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link BatchUpdateScheduleCommandInput} for command's `input` shape. + * @see {@link BatchUpdateScheduleCommandOutput} for command's `response` shape. + * @see {@link MediaLiveClientResolvedConfig | config} for command's `input` shape. + * */ export class BatchUpdateScheduleCommand extends $Command< BatchUpdateScheduleCommandInput, diff --git a/clients/client-medialive/commands/CancelInputDeviceTransferCommand.ts b/clients/client-medialive/commands/CancelInputDeviceTransferCommand.ts index 1449b650fcc9..53ec96caec59 100644 --- a/clients/client-medialive/commands/CancelInputDeviceTransferCommand.ts +++ b/clients/client-medialive/commands/CancelInputDeviceTransferCommand.ts @@ -22,6 +22,20 @@ export interface CancelInputDeviceTransferCommandOutput extends CancelInputDevic /** * Cancel an input device transfer that you have requested. + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { MediaLiveClient, CancelInputDeviceTransferCommand } from "@aws-sdk/client-medialive"; // ES Modules import + * // const { MediaLiveClient, CancelInputDeviceTransferCommand } = require("@aws-sdk/client-medialive"); // CommonJS import + * const client = new MediaLiveClient(config); + * const command = new CancelInputDeviceTransferCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CancelInputDeviceTransferCommandInput} for command's `input` shape. + * @see {@link CancelInputDeviceTransferCommandOutput} for command's `response` shape. + * @see {@link MediaLiveClientResolvedConfig | config} for command's `input` shape. + * */ export class CancelInputDeviceTransferCommand extends $Command< CancelInputDeviceTransferCommandInput, diff --git a/clients/client-medialive/commands/CreateChannelCommand.ts b/clients/client-medialive/commands/CreateChannelCommand.ts index 914a0f7891fe..d0a2a627b41b 100644 --- a/clients/client-medialive/commands/CreateChannelCommand.ts +++ b/clients/client-medialive/commands/CreateChannelCommand.ts @@ -22,6 +22,20 @@ export interface CreateChannelCommandOutput extends CreateChannelResponse, __Met /** * Creates a new channel + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { MediaLiveClient, CreateChannelCommand } from "@aws-sdk/client-medialive"; // ES Modules import + * // const { MediaLiveClient, CreateChannelCommand } = require("@aws-sdk/client-medialive"); // CommonJS import + * const client = new MediaLiveClient(config); + * const command = new CreateChannelCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreateChannelCommandInput} for command's `input` shape. + * @see {@link CreateChannelCommandOutput} for command's `response` shape. + * @see {@link MediaLiveClientResolvedConfig | config} for command's `input` shape. + * */ export class CreateChannelCommand extends $Command< CreateChannelCommandInput, diff --git a/clients/client-medialive/commands/CreateInputCommand.ts b/clients/client-medialive/commands/CreateInputCommand.ts index e5f91fca032b..9750ef7684cc 100644 --- a/clients/client-medialive/commands/CreateInputCommand.ts +++ b/clients/client-medialive/commands/CreateInputCommand.ts @@ -22,6 +22,20 @@ export interface CreateInputCommandOutput extends CreateInputResponse, __Metadat /** * Create an input + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { MediaLiveClient, CreateInputCommand } from "@aws-sdk/client-medialive"; // ES Modules import + * // const { MediaLiveClient, CreateInputCommand } = require("@aws-sdk/client-medialive"); // CommonJS import + * const client = new MediaLiveClient(config); + * const command = new CreateInputCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreateInputCommandInput} for command's `input` shape. + * @see {@link CreateInputCommandOutput} for command's `response` shape. + * @see {@link MediaLiveClientResolvedConfig | config} for command's `input` shape. + * */ export class CreateInputCommand extends $Command< CreateInputCommandInput, diff --git a/clients/client-medialive/commands/CreateInputSecurityGroupCommand.ts b/clients/client-medialive/commands/CreateInputSecurityGroupCommand.ts index 2957a3030d85..e5320d19483a 100644 --- a/clients/client-medialive/commands/CreateInputSecurityGroupCommand.ts +++ b/clients/client-medialive/commands/CreateInputSecurityGroupCommand.ts @@ -22,6 +22,20 @@ export interface CreateInputSecurityGroupCommandOutput extends CreateInputSecuri /** * Creates a Input Security Group + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { MediaLiveClient, CreateInputSecurityGroupCommand } from "@aws-sdk/client-medialive"; // ES Modules import + * // const { MediaLiveClient, CreateInputSecurityGroupCommand } = require("@aws-sdk/client-medialive"); // CommonJS import + * const client = new MediaLiveClient(config); + * const command = new CreateInputSecurityGroupCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreateInputSecurityGroupCommandInput} for command's `input` shape. + * @see {@link CreateInputSecurityGroupCommandOutput} for command's `response` shape. + * @see {@link MediaLiveClientResolvedConfig | config} for command's `input` shape. + * */ export class CreateInputSecurityGroupCommand extends $Command< CreateInputSecurityGroupCommandInput, diff --git a/clients/client-medialive/commands/CreateMultiplexCommand.ts b/clients/client-medialive/commands/CreateMultiplexCommand.ts index 731b67729274..67103dc4e683 100644 --- a/clients/client-medialive/commands/CreateMultiplexCommand.ts +++ b/clients/client-medialive/commands/CreateMultiplexCommand.ts @@ -22,6 +22,20 @@ export interface CreateMultiplexCommandOutput extends CreateMultiplexResponse, _ /** * Create a new multiplex. + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { MediaLiveClient, CreateMultiplexCommand } from "@aws-sdk/client-medialive"; // ES Modules import + * // const { MediaLiveClient, CreateMultiplexCommand } = require("@aws-sdk/client-medialive"); // CommonJS import + * const client = new MediaLiveClient(config); + * const command = new CreateMultiplexCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreateMultiplexCommandInput} for command's `input` shape. + * @see {@link CreateMultiplexCommandOutput} for command's `response` shape. + * @see {@link MediaLiveClientResolvedConfig | config} for command's `input` shape. + * */ export class CreateMultiplexCommand extends $Command< CreateMultiplexCommandInput, diff --git a/clients/client-medialive/commands/CreateMultiplexProgramCommand.ts b/clients/client-medialive/commands/CreateMultiplexProgramCommand.ts index 8daabeaa7ed0..d3a0f41fbde7 100644 --- a/clients/client-medialive/commands/CreateMultiplexProgramCommand.ts +++ b/clients/client-medialive/commands/CreateMultiplexProgramCommand.ts @@ -22,6 +22,20 @@ export interface CreateMultiplexProgramCommandOutput extends CreateMultiplexProg /** * Create a new program in the multiplex. + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { MediaLiveClient, CreateMultiplexProgramCommand } from "@aws-sdk/client-medialive"; // ES Modules import + * // const { MediaLiveClient, CreateMultiplexProgramCommand } = require("@aws-sdk/client-medialive"); // CommonJS import + * const client = new MediaLiveClient(config); + * const command = new CreateMultiplexProgramCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreateMultiplexProgramCommandInput} for command's `input` shape. + * @see {@link CreateMultiplexProgramCommandOutput} for command's `response` shape. + * @see {@link MediaLiveClientResolvedConfig | config} for command's `input` shape. + * */ export class CreateMultiplexProgramCommand extends $Command< CreateMultiplexProgramCommandInput, diff --git a/clients/client-medialive/commands/CreatePartnerInputCommand.ts b/clients/client-medialive/commands/CreatePartnerInputCommand.ts index a67fae24c973..bcb75de6960d 100644 --- a/clients/client-medialive/commands/CreatePartnerInputCommand.ts +++ b/clients/client-medialive/commands/CreatePartnerInputCommand.ts @@ -22,6 +22,20 @@ export interface CreatePartnerInputCommandOutput extends CreatePartnerInputRespo /** * Create a partner input + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { MediaLiveClient, CreatePartnerInputCommand } from "@aws-sdk/client-medialive"; // ES Modules import + * // const { MediaLiveClient, CreatePartnerInputCommand } = require("@aws-sdk/client-medialive"); // CommonJS import + * const client = new MediaLiveClient(config); + * const command = new CreatePartnerInputCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreatePartnerInputCommandInput} for command's `input` shape. + * @see {@link CreatePartnerInputCommandOutput} for command's `response` shape. + * @see {@link MediaLiveClientResolvedConfig | config} for command's `input` shape. + * */ export class CreatePartnerInputCommand extends $Command< CreatePartnerInputCommandInput, diff --git a/clients/client-medialive/commands/CreateTagsCommand.ts b/clients/client-medialive/commands/CreateTagsCommand.ts index 70973a89518a..1bf1868466b9 100644 --- a/clients/client-medialive/commands/CreateTagsCommand.ts +++ b/clients/client-medialive/commands/CreateTagsCommand.ts @@ -22,6 +22,20 @@ export interface CreateTagsCommandOutput extends __MetadataBearer {} /** * Create tags for a resource + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { MediaLiveClient, CreateTagsCommand } from "@aws-sdk/client-medialive"; // ES Modules import + * // const { MediaLiveClient, CreateTagsCommand } = require("@aws-sdk/client-medialive"); // CommonJS import + * const client = new MediaLiveClient(config); + * const command = new CreateTagsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreateTagsCommandInput} for command's `input` shape. + * @see {@link CreateTagsCommandOutput} for command's `response` shape. + * @see {@link MediaLiveClientResolvedConfig | config} for command's `input` shape. + * */ export class CreateTagsCommand extends $Command< CreateTagsCommandInput, diff --git a/clients/client-medialive/commands/DeleteChannelCommand.ts b/clients/client-medialive/commands/DeleteChannelCommand.ts index 800436b332bd..2bd5e9db5937 100644 --- a/clients/client-medialive/commands/DeleteChannelCommand.ts +++ b/clients/client-medialive/commands/DeleteChannelCommand.ts @@ -22,6 +22,20 @@ export interface DeleteChannelCommandOutput extends DeleteChannelResponse, __Met /** * Starts deletion of channel. The associated outputs are also deleted. + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { MediaLiveClient, DeleteChannelCommand } from "@aws-sdk/client-medialive"; // ES Modules import + * // const { MediaLiveClient, DeleteChannelCommand } = require("@aws-sdk/client-medialive"); // CommonJS import + * const client = new MediaLiveClient(config); + * const command = new DeleteChannelCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteChannelCommandInput} for command's `input` shape. + * @see {@link DeleteChannelCommandOutput} for command's `response` shape. + * @see {@link MediaLiveClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteChannelCommand extends $Command< DeleteChannelCommandInput, diff --git a/clients/client-medialive/commands/DeleteInputCommand.ts b/clients/client-medialive/commands/DeleteInputCommand.ts index a745ac490396..c7eb0ba8910f 100644 --- a/clients/client-medialive/commands/DeleteInputCommand.ts +++ b/clients/client-medialive/commands/DeleteInputCommand.ts @@ -22,6 +22,20 @@ export interface DeleteInputCommandOutput extends DeleteInputResponse, __Metadat /** * Deletes the input end point + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { MediaLiveClient, DeleteInputCommand } from "@aws-sdk/client-medialive"; // ES Modules import + * // const { MediaLiveClient, DeleteInputCommand } = require("@aws-sdk/client-medialive"); // CommonJS import + * const client = new MediaLiveClient(config); + * const command = new DeleteInputCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteInputCommandInput} for command's `input` shape. + * @see {@link DeleteInputCommandOutput} for command's `response` shape. + * @see {@link MediaLiveClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteInputCommand extends $Command< DeleteInputCommandInput, diff --git a/clients/client-medialive/commands/DeleteInputSecurityGroupCommand.ts b/clients/client-medialive/commands/DeleteInputSecurityGroupCommand.ts index 7f0e42b7229f..728d1fb83bef 100644 --- a/clients/client-medialive/commands/DeleteInputSecurityGroupCommand.ts +++ b/clients/client-medialive/commands/DeleteInputSecurityGroupCommand.ts @@ -22,6 +22,20 @@ export interface DeleteInputSecurityGroupCommandOutput extends DeleteInputSecuri /** * Deletes an Input Security Group + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { MediaLiveClient, DeleteInputSecurityGroupCommand } from "@aws-sdk/client-medialive"; // ES Modules import + * // const { MediaLiveClient, DeleteInputSecurityGroupCommand } = require("@aws-sdk/client-medialive"); // CommonJS import + * const client = new MediaLiveClient(config); + * const command = new DeleteInputSecurityGroupCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteInputSecurityGroupCommandInput} for command's `input` shape. + * @see {@link DeleteInputSecurityGroupCommandOutput} for command's `response` shape. + * @see {@link MediaLiveClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteInputSecurityGroupCommand extends $Command< DeleteInputSecurityGroupCommandInput, diff --git a/clients/client-medialive/commands/DeleteMultiplexCommand.ts b/clients/client-medialive/commands/DeleteMultiplexCommand.ts index 73b48c6a516a..b39ebd950a9d 100644 --- a/clients/client-medialive/commands/DeleteMultiplexCommand.ts +++ b/clients/client-medialive/commands/DeleteMultiplexCommand.ts @@ -22,6 +22,20 @@ export interface DeleteMultiplexCommandOutput extends DeleteMultiplexResponse, _ /** * Delete a multiplex. The multiplex must be idle. + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { MediaLiveClient, DeleteMultiplexCommand } from "@aws-sdk/client-medialive"; // ES Modules import + * // const { MediaLiveClient, DeleteMultiplexCommand } = require("@aws-sdk/client-medialive"); // CommonJS import + * const client = new MediaLiveClient(config); + * const command = new DeleteMultiplexCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteMultiplexCommandInput} for command's `input` shape. + * @see {@link DeleteMultiplexCommandOutput} for command's `response` shape. + * @see {@link MediaLiveClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteMultiplexCommand extends $Command< DeleteMultiplexCommandInput, diff --git a/clients/client-medialive/commands/DeleteMultiplexProgramCommand.ts b/clients/client-medialive/commands/DeleteMultiplexProgramCommand.ts index e6f7cb5dec4b..b92d6d73459f 100644 --- a/clients/client-medialive/commands/DeleteMultiplexProgramCommand.ts +++ b/clients/client-medialive/commands/DeleteMultiplexProgramCommand.ts @@ -22,6 +22,20 @@ export interface DeleteMultiplexProgramCommandOutput extends DeleteMultiplexProg /** * Delete a program from a multiplex. + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { MediaLiveClient, DeleteMultiplexProgramCommand } from "@aws-sdk/client-medialive"; // ES Modules import + * // const { MediaLiveClient, DeleteMultiplexProgramCommand } = require("@aws-sdk/client-medialive"); // CommonJS import + * const client = new MediaLiveClient(config); + * const command = new DeleteMultiplexProgramCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteMultiplexProgramCommandInput} for command's `input` shape. + * @see {@link DeleteMultiplexProgramCommandOutput} for command's `response` shape. + * @see {@link MediaLiveClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteMultiplexProgramCommand extends $Command< DeleteMultiplexProgramCommandInput, diff --git a/clients/client-medialive/commands/DeleteReservationCommand.ts b/clients/client-medialive/commands/DeleteReservationCommand.ts index e5f503f452a6..d41627a7970b 100644 --- a/clients/client-medialive/commands/DeleteReservationCommand.ts +++ b/clients/client-medialive/commands/DeleteReservationCommand.ts @@ -22,6 +22,20 @@ export interface DeleteReservationCommandOutput extends DeleteReservationRespons /** * Delete an expired reservation. + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { MediaLiveClient, DeleteReservationCommand } from "@aws-sdk/client-medialive"; // ES Modules import + * // const { MediaLiveClient, DeleteReservationCommand } = require("@aws-sdk/client-medialive"); // CommonJS import + * const client = new MediaLiveClient(config); + * const command = new DeleteReservationCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteReservationCommandInput} for command's `input` shape. + * @see {@link DeleteReservationCommandOutput} for command's `response` shape. + * @see {@link MediaLiveClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteReservationCommand extends $Command< DeleteReservationCommandInput, diff --git a/clients/client-medialive/commands/DeleteScheduleCommand.ts b/clients/client-medialive/commands/DeleteScheduleCommand.ts index cd8fb1c20095..08eebf56fc9c 100644 --- a/clients/client-medialive/commands/DeleteScheduleCommand.ts +++ b/clients/client-medialive/commands/DeleteScheduleCommand.ts @@ -22,6 +22,20 @@ export interface DeleteScheduleCommandOutput extends DeleteScheduleResponse, __M /** * Delete all schedule actions on a channel. + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { MediaLiveClient, DeleteScheduleCommand } from "@aws-sdk/client-medialive"; // ES Modules import + * // const { MediaLiveClient, DeleteScheduleCommand } = require("@aws-sdk/client-medialive"); // CommonJS import + * const client = new MediaLiveClient(config); + * const command = new DeleteScheduleCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteScheduleCommandInput} for command's `input` shape. + * @see {@link DeleteScheduleCommandOutput} for command's `response` shape. + * @see {@link MediaLiveClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteScheduleCommand extends $Command< DeleteScheduleCommandInput, diff --git a/clients/client-medialive/commands/DeleteTagsCommand.ts b/clients/client-medialive/commands/DeleteTagsCommand.ts index 2cdec21805e9..b0ab95a768c2 100644 --- a/clients/client-medialive/commands/DeleteTagsCommand.ts +++ b/clients/client-medialive/commands/DeleteTagsCommand.ts @@ -22,6 +22,20 @@ export interface DeleteTagsCommandOutput extends __MetadataBearer {} /** * Removes tags for a resource + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { MediaLiveClient, DeleteTagsCommand } from "@aws-sdk/client-medialive"; // ES Modules import + * // const { MediaLiveClient, DeleteTagsCommand } = require("@aws-sdk/client-medialive"); // CommonJS import + * const client = new MediaLiveClient(config); + * const command = new DeleteTagsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteTagsCommandInput} for command's `input` shape. + * @see {@link DeleteTagsCommandOutput} for command's `response` shape. + * @see {@link MediaLiveClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteTagsCommand extends $Command< DeleteTagsCommandInput, diff --git a/clients/client-medialive/commands/DescribeChannelCommand.ts b/clients/client-medialive/commands/DescribeChannelCommand.ts index f311947223b4..edf0bbbdc328 100644 --- a/clients/client-medialive/commands/DescribeChannelCommand.ts +++ b/clients/client-medialive/commands/DescribeChannelCommand.ts @@ -22,6 +22,20 @@ export interface DescribeChannelCommandOutput extends DescribeChannelResponse, _ /** * Gets details about a channel + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { MediaLiveClient, DescribeChannelCommand } from "@aws-sdk/client-medialive"; // ES Modules import + * // const { MediaLiveClient, DescribeChannelCommand } = require("@aws-sdk/client-medialive"); // CommonJS import + * const client = new MediaLiveClient(config); + * const command = new DescribeChannelCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeChannelCommandInput} for command's `input` shape. + * @see {@link DescribeChannelCommandOutput} for command's `response` shape. + * @see {@link MediaLiveClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeChannelCommand extends $Command< DescribeChannelCommandInput, diff --git a/clients/client-medialive/commands/DescribeInputCommand.ts b/clients/client-medialive/commands/DescribeInputCommand.ts index 2e65ee5a79c0..80ea1757498b 100644 --- a/clients/client-medialive/commands/DescribeInputCommand.ts +++ b/clients/client-medialive/commands/DescribeInputCommand.ts @@ -22,6 +22,20 @@ export interface DescribeInputCommandOutput extends DescribeInputResponse, __Met /** * Produces details about an input + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { MediaLiveClient, DescribeInputCommand } from "@aws-sdk/client-medialive"; // ES Modules import + * // const { MediaLiveClient, DescribeInputCommand } = require("@aws-sdk/client-medialive"); // CommonJS import + * const client = new MediaLiveClient(config); + * const command = new DescribeInputCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeInputCommandInput} for command's `input` shape. + * @see {@link DescribeInputCommandOutput} for command's `response` shape. + * @see {@link MediaLiveClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeInputCommand extends $Command< DescribeInputCommandInput, diff --git a/clients/client-medialive/commands/DescribeInputDeviceCommand.ts b/clients/client-medialive/commands/DescribeInputDeviceCommand.ts index b22967cc2493..02e6c0912b9d 100644 --- a/clients/client-medialive/commands/DescribeInputDeviceCommand.ts +++ b/clients/client-medialive/commands/DescribeInputDeviceCommand.ts @@ -22,6 +22,20 @@ export interface DescribeInputDeviceCommandOutput extends DescribeInputDeviceRes /** * Gets the details for the input device + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { MediaLiveClient, DescribeInputDeviceCommand } from "@aws-sdk/client-medialive"; // ES Modules import + * // const { MediaLiveClient, DescribeInputDeviceCommand } = require("@aws-sdk/client-medialive"); // CommonJS import + * const client = new MediaLiveClient(config); + * const command = new DescribeInputDeviceCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeInputDeviceCommandInput} for command's `input` shape. + * @see {@link DescribeInputDeviceCommandOutput} for command's `response` shape. + * @see {@link MediaLiveClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeInputDeviceCommand extends $Command< DescribeInputDeviceCommandInput, diff --git a/clients/client-medialive/commands/DescribeInputDeviceThumbnailCommand.ts b/clients/client-medialive/commands/DescribeInputDeviceThumbnailCommand.ts index 128cbcda97fb..d2be225e469c 100644 --- a/clients/client-medialive/commands/DescribeInputDeviceThumbnailCommand.ts +++ b/clients/client-medialive/commands/DescribeInputDeviceThumbnailCommand.ts @@ -24,6 +24,20 @@ export interface DescribeInputDeviceThumbnailCommandOutput /** * Get the latest thumbnail data for the input device. + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { MediaLiveClient, DescribeInputDeviceThumbnailCommand } from "@aws-sdk/client-medialive"; // ES Modules import + * // const { MediaLiveClient, DescribeInputDeviceThumbnailCommand } = require("@aws-sdk/client-medialive"); // CommonJS import + * const client = new MediaLiveClient(config); + * const command = new DescribeInputDeviceThumbnailCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeInputDeviceThumbnailCommandInput} for command's `input` shape. + * @see {@link DescribeInputDeviceThumbnailCommandOutput} for command's `response` shape. + * @see {@link MediaLiveClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeInputDeviceThumbnailCommand extends $Command< DescribeInputDeviceThumbnailCommandInput, diff --git a/clients/client-medialive/commands/DescribeInputSecurityGroupCommand.ts b/clients/client-medialive/commands/DescribeInputSecurityGroupCommand.ts index 1e45f0fed6ae..6ee3ef90f35c 100644 --- a/clients/client-medialive/commands/DescribeInputSecurityGroupCommand.ts +++ b/clients/client-medialive/commands/DescribeInputSecurityGroupCommand.ts @@ -22,6 +22,20 @@ export interface DescribeInputSecurityGroupCommandOutput extends DescribeInputSe /** * Produces a summary of an Input Security Group + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { MediaLiveClient, DescribeInputSecurityGroupCommand } from "@aws-sdk/client-medialive"; // ES Modules import + * // const { MediaLiveClient, DescribeInputSecurityGroupCommand } = require("@aws-sdk/client-medialive"); // CommonJS import + * const client = new MediaLiveClient(config); + * const command = new DescribeInputSecurityGroupCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeInputSecurityGroupCommandInput} for command's `input` shape. + * @see {@link DescribeInputSecurityGroupCommandOutput} for command's `response` shape. + * @see {@link MediaLiveClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeInputSecurityGroupCommand extends $Command< DescribeInputSecurityGroupCommandInput, diff --git a/clients/client-medialive/commands/DescribeMultiplexCommand.ts b/clients/client-medialive/commands/DescribeMultiplexCommand.ts index 70be8e299e04..d9dbd82cab03 100644 --- a/clients/client-medialive/commands/DescribeMultiplexCommand.ts +++ b/clients/client-medialive/commands/DescribeMultiplexCommand.ts @@ -22,6 +22,20 @@ export interface DescribeMultiplexCommandOutput extends DescribeMultiplexRespons /** * Gets details about a multiplex. + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { MediaLiveClient, DescribeMultiplexCommand } from "@aws-sdk/client-medialive"; // ES Modules import + * // const { MediaLiveClient, DescribeMultiplexCommand } = require("@aws-sdk/client-medialive"); // CommonJS import + * const client = new MediaLiveClient(config); + * const command = new DescribeMultiplexCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeMultiplexCommandInput} for command's `input` shape. + * @see {@link DescribeMultiplexCommandOutput} for command's `response` shape. + * @see {@link MediaLiveClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeMultiplexCommand extends $Command< DescribeMultiplexCommandInput, diff --git a/clients/client-medialive/commands/DescribeMultiplexProgramCommand.ts b/clients/client-medialive/commands/DescribeMultiplexProgramCommand.ts index 4d2002452032..c2fcceb1efd2 100644 --- a/clients/client-medialive/commands/DescribeMultiplexProgramCommand.ts +++ b/clients/client-medialive/commands/DescribeMultiplexProgramCommand.ts @@ -22,6 +22,20 @@ export interface DescribeMultiplexProgramCommandOutput extends DescribeMultiplex /** * Get the details for a program in a multiplex. + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { MediaLiveClient, DescribeMultiplexProgramCommand } from "@aws-sdk/client-medialive"; // ES Modules import + * // const { MediaLiveClient, DescribeMultiplexProgramCommand } = require("@aws-sdk/client-medialive"); // CommonJS import + * const client = new MediaLiveClient(config); + * const command = new DescribeMultiplexProgramCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeMultiplexProgramCommandInput} for command's `input` shape. + * @see {@link DescribeMultiplexProgramCommandOutput} for command's `response` shape. + * @see {@link MediaLiveClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeMultiplexProgramCommand extends $Command< DescribeMultiplexProgramCommandInput, diff --git a/clients/client-medialive/commands/DescribeOfferingCommand.ts b/clients/client-medialive/commands/DescribeOfferingCommand.ts index aed1d5507463..e949a9f99db5 100644 --- a/clients/client-medialive/commands/DescribeOfferingCommand.ts +++ b/clients/client-medialive/commands/DescribeOfferingCommand.ts @@ -22,6 +22,20 @@ export interface DescribeOfferingCommandOutput extends DescribeOfferingResponse, /** * Get details for an offering. + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { MediaLiveClient, DescribeOfferingCommand } from "@aws-sdk/client-medialive"; // ES Modules import + * // const { MediaLiveClient, DescribeOfferingCommand } = require("@aws-sdk/client-medialive"); // CommonJS import + * const client = new MediaLiveClient(config); + * const command = new DescribeOfferingCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeOfferingCommandInput} for command's `input` shape. + * @see {@link DescribeOfferingCommandOutput} for command's `response` shape. + * @see {@link MediaLiveClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeOfferingCommand extends $Command< DescribeOfferingCommandInput, diff --git a/clients/client-medialive/commands/DescribeReservationCommand.ts b/clients/client-medialive/commands/DescribeReservationCommand.ts index f0ef37488ede..525d33b9c495 100644 --- a/clients/client-medialive/commands/DescribeReservationCommand.ts +++ b/clients/client-medialive/commands/DescribeReservationCommand.ts @@ -22,6 +22,20 @@ export interface DescribeReservationCommandOutput extends DescribeReservationRes /** * Get details for a reservation. + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { MediaLiveClient, DescribeReservationCommand } from "@aws-sdk/client-medialive"; // ES Modules import + * // const { MediaLiveClient, DescribeReservationCommand } = require("@aws-sdk/client-medialive"); // CommonJS import + * const client = new MediaLiveClient(config); + * const command = new DescribeReservationCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeReservationCommandInput} for command's `input` shape. + * @see {@link DescribeReservationCommandOutput} for command's `response` shape. + * @see {@link MediaLiveClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeReservationCommand extends $Command< DescribeReservationCommandInput, diff --git a/clients/client-medialive/commands/DescribeScheduleCommand.ts b/clients/client-medialive/commands/DescribeScheduleCommand.ts index 649b0f34462b..53f5498ca4ca 100644 --- a/clients/client-medialive/commands/DescribeScheduleCommand.ts +++ b/clients/client-medialive/commands/DescribeScheduleCommand.ts @@ -22,6 +22,20 @@ export interface DescribeScheduleCommandOutput extends DescribeScheduleResponse, /** * Get a channel schedule + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { MediaLiveClient, DescribeScheduleCommand } from "@aws-sdk/client-medialive"; // ES Modules import + * // const { MediaLiveClient, DescribeScheduleCommand } = require("@aws-sdk/client-medialive"); // CommonJS import + * const client = new MediaLiveClient(config); + * const command = new DescribeScheduleCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeScheduleCommandInput} for command's `input` shape. + * @see {@link DescribeScheduleCommandOutput} for command's `response` shape. + * @see {@link MediaLiveClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeScheduleCommand extends $Command< DescribeScheduleCommandInput, diff --git a/clients/client-medialive/commands/ListChannelsCommand.ts b/clients/client-medialive/commands/ListChannelsCommand.ts index 5a3f5487bac8..ffba03ea21bc 100644 --- a/clients/client-medialive/commands/ListChannelsCommand.ts +++ b/clients/client-medialive/commands/ListChannelsCommand.ts @@ -22,6 +22,20 @@ export interface ListChannelsCommandOutput extends ListChannelsResponse, __Metad /** * Produces list of channels that have been created + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { MediaLiveClient, ListChannelsCommand } from "@aws-sdk/client-medialive"; // ES Modules import + * // const { MediaLiveClient, ListChannelsCommand } = require("@aws-sdk/client-medialive"); // CommonJS import + * const client = new MediaLiveClient(config); + * const command = new ListChannelsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListChannelsCommandInput} for command's `input` shape. + * @see {@link ListChannelsCommandOutput} for command's `response` shape. + * @see {@link MediaLiveClientResolvedConfig | config} for command's `input` shape. + * */ export class ListChannelsCommand extends $Command< ListChannelsCommandInput, diff --git a/clients/client-medialive/commands/ListInputDeviceTransfersCommand.ts b/clients/client-medialive/commands/ListInputDeviceTransfersCommand.ts index 83ee4dc47146..3b94df097179 100644 --- a/clients/client-medialive/commands/ListInputDeviceTransfersCommand.ts +++ b/clients/client-medialive/commands/ListInputDeviceTransfersCommand.ts @@ -22,6 +22,20 @@ export interface ListInputDeviceTransfersCommandOutput extends ListInputDeviceTr /** * 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. + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { MediaLiveClient, ListInputDeviceTransfersCommand } from "@aws-sdk/client-medialive"; // ES Modules import + * // const { MediaLiveClient, ListInputDeviceTransfersCommand } = require("@aws-sdk/client-medialive"); // CommonJS import + * const client = new MediaLiveClient(config); + * const command = new ListInputDeviceTransfersCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListInputDeviceTransfersCommandInput} for command's `input` shape. + * @see {@link ListInputDeviceTransfersCommandOutput} for command's `response` shape. + * @see {@link MediaLiveClientResolvedConfig | config} for command's `input` shape. + * */ export class ListInputDeviceTransfersCommand extends $Command< ListInputDeviceTransfersCommandInput, diff --git a/clients/client-medialive/commands/ListInputDevicesCommand.ts b/clients/client-medialive/commands/ListInputDevicesCommand.ts index 41c15f96a0e3..e15737484a39 100644 --- a/clients/client-medialive/commands/ListInputDevicesCommand.ts +++ b/clients/client-medialive/commands/ListInputDevicesCommand.ts @@ -22,6 +22,20 @@ export interface ListInputDevicesCommandOutput extends ListInputDevicesResponse, /** * List input devices + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { MediaLiveClient, ListInputDevicesCommand } from "@aws-sdk/client-medialive"; // ES Modules import + * // const { MediaLiveClient, ListInputDevicesCommand } = require("@aws-sdk/client-medialive"); // CommonJS import + * const client = new MediaLiveClient(config); + * const command = new ListInputDevicesCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListInputDevicesCommandInput} for command's `input` shape. + * @see {@link ListInputDevicesCommandOutput} for command's `response` shape. + * @see {@link MediaLiveClientResolvedConfig | config} for command's `input` shape. + * */ export class ListInputDevicesCommand extends $Command< ListInputDevicesCommandInput, diff --git a/clients/client-medialive/commands/ListInputSecurityGroupsCommand.ts b/clients/client-medialive/commands/ListInputSecurityGroupsCommand.ts index af526433350d..a299d697dedd 100644 --- a/clients/client-medialive/commands/ListInputSecurityGroupsCommand.ts +++ b/clients/client-medialive/commands/ListInputSecurityGroupsCommand.ts @@ -22,6 +22,20 @@ export interface ListInputSecurityGroupsCommandOutput extends ListInputSecurityG /** * Produces a list of Input Security Groups for an account + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { MediaLiveClient, ListInputSecurityGroupsCommand } from "@aws-sdk/client-medialive"; // ES Modules import + * // const { MediaLiveClient, ListInputSecurityGroupsCommand } = require("@aws-sdk/client-medialive"); // CommonJS import + * const client = new MediaLiveClient(config); + * const command = new ListInputSecurityGroupsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListInputSecurityGroupsCommandInput} for command's `input` shape. + * @see {@link ListInputSecurityGroupsCommandOutput} for command's `response` shape. + * @see {@link MediaLiveClientResolvedConfig | config} for command's `input` shape. + * */ export class ListInputSecurityGroupsCommand extends $Command< ListInputSecurityGroupsCommandInput, diff --git a/clients/client-medialive/commands/ListInputsCommand.ts b/clients/client-medialive/commands/ListInputsCommand.ts index 651652deeefd..10cf1844b5b5 100644 --- a/clients/client-medialive/commands/ListInputsCommand.ts +++ b/clients/client-medialive/commands/ListInputsCommand.ts @@ -22,6 +22,20 @@ export interface ListInputsCommandOutput extends ListInputsResponse, __MetadataB /** * Produces list of inputs that have been created + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { MediaLiveClient, ListInputsCommand } from "@aws-sdk/client-medialive"; // ES Modules import + * // const { MediaLiveClient, ListInputsCommand } = require("@aws-sdk/client-medialive"); // CommonJS import + * const client = new MediaLiveClient(config); + * const command = new ListInputsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListInputsCommandInput} for command's `input` shape. + * @see {@link ListInputsCommandOutput} for command's `response` shape. + * @see {@link MediaLiveClientResolvedConfig | config} for command's `input` shape. + * */ export class ListInputsCommand extends $Command< ListInputsCommandInput, diff --git a/clients/client-medialive/commands/ListMultiplexProgramsCommand.ts b/clients/client-medialive/commands/ListMultiplexProgramsCommand.ts index f06aa5c1892d..705a6497d749 100644 --- a/clients/client-medialive/commands/ListMultiplexProgramsCommand.ts +++ b/clients/client-medialive/commands/ListMultiplexProgramsCommand.ts @@ -22,6 +22,20 @@ export interface ListMultiplexProgramsCommandOutput extends ListMultiplexProgram /** * List the programs that currently exist for a specific multiplex. + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { MediaLiveClient, ListMultiplexProgramsCommand } from "@aws-sdk/client-medialive"; // ES Modules import + * // const { MediaLiveClient, ListMultiplexProgramsCommand } = require("@aws-sdk/client-medialive"); // CommonJS import + * const client = new MediaLiveClient(config); + * const command = new ListMultiplexProgramsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListMultiplexProgramsCommandInput} for command's `input` shape. + * @see {@link ListMultiplexProgramsCommandOutput} for command's `response` shape. + * @see {@link MediaLiveClientResolvedConfig | config} for command's `input` shape. + * */ export class ListMultiplexProgramsCommand extends $Command< ListMultiplexProgramsCommandInput, diff --git a/clients/client-medialive/commands/ListMultiplexesCommand.ts b/clients/client-medialive/commands/ListMultiplexesCommand.ts index 53c905539a72..b19c67700045 100644 --- a/clients/client-medialive/commands/ListMultiplexesCommand.ts +++ b/clients/client-medialive/commands/ListMultiplexesCommand.ts @@ -22,6 +22,20 @@ export interface ListMultiplexesCommandOutput extends ListMultiplexesResponse, _ /** * Retrieve a list of the existing multiplexes. + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { MediaLiveClient, ListMultiplexesCommand } from "@aws-sdk/client-medialive"; // ES Modules import + * // const { MediaLiveClient, ListMultiplexesCommand } = require("@aws-sdk/client-medialive"); // CommonJS import + * const client = new MediaLiveClient(config); + * const command = new ListMultiplexesCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListMultiplexesCommandInput} for command's `input` shape. + * @see {@link ListMultiplexesCommandOutput} for command's `response` shape. + * @see {@link MediaLiveClientResolvedConfig | config} for command's `input` shape. + * */ export class ListMultiplexesCommand extends $Command< ListMultiplexesCommandInput, diff --git a/clients/client-medialive/commands/ListOfferingsCommand.ts b/clients/client-medialive/commands/ListOfferingsCommand.ts index 842a155034d4..778c3843baba 100644 --- a/clients/client-medialive/commands/ListOfferingsCommand.ts +++ b/clients/client-medialive/commands/ListOfferingsCommand.ts @@ -22,6 +22,20 @@ export interface ListOfferingsCommandOutput extends ListOfferingsResponse, __Met /** * List offerings available for purchase. + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { MediaLiveClient, ListOfferingsCommand } from "@aws-sdk/client-medialive"; // ES Modules import + * // const { MediaLiveClient, ListOfferingsCommand } = require("@aws-sdk/client-medialive"); // CommonJS import + * const client = new MediaLiveClient(config); + * const command = new ListOfferingsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListOfferingsCommandInput} for command's `input` shape. + * @see {@link ListOfferingsCommandOutput} for command's `response` shape. + * @see {@link MediaLiveClientResolvedConfig | config} for command's `input` shape. + * */ export class ListOfferingsCommand extends $Command< ListOfferingsCommandInput, diff --git a/clients/client-medialive/commands/ListReservationsCommand.ts b/clients/client-medialive/commands/ListReservationsCommand.ts index 349c5661575e..4171b10fafac 100644 --- a/clients/client-medialive/commands/ListReservationsCommand.ts +++ b/clients/client-medialive/commands/ListReservationsCommand.ts @@ -22,6 +22,20 @@ export interface ListReservationsCommandOutput extends ListReservationsResponse, /** * List purchased reservations. + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { MediaLiveClient, ListReservationsCommand } from "@aws-sdk/client-medialive"; // ES Modules import + * // const { MediaLiveClient, ListReservationsCommand } = require("@aws-sdk/client-medialive"); // CommonJS import + * const client = new MediaLiveClient(config); + * const command = new ListReservationsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListReservationsCommandInput} for command's `input` shape. + * @see {@link ListReservationsCommandOutput} for command's `response` shape. + * @see {@link MediaLiveClientResolvedConfig | config} for command's `input` shape. + * */ export class ListReservationsCommand extends $Command< ListReservationsCommandInput, diff --git a/clients/client-medialive/commands/ListTagsForResourceCommand.ts b/clients/client-medialive/commands/ListTagsForResourceCommand.ts index 04e207496a74..c70dba3113f2 100644 --- a/clients/client-medialive/commands/ListTagsForResourceCommand.ts +++ b/clients/client-medialive/commands/ListTagsForResourceCommand.ts @@ -22,6 +22,20 @@ export interface ListTagsForResourceCommandOutput extends ListTagsForResourceRes /** * Produces list of tags that have been created for a resource + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { MediaLiveClient, ListTagsForResourceCommand } from "@aws-sdk/client-medialive"; // ES Modules import + * // const { MediaLiveClient, ListTagsForResourceCommand } = require("@aws-sdk/client-medialive"); // CommonJS import + * const client = new MediaLiveClient(config); + * const command = new ListTagsForResourceCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListTagsForResourceCommandInput} for command's `input` shape. + * @see {@link ListTagsForResourceCommandOutput} for command's `response` shape. + * @see {@link MediaLiveClientResolvedConfig | config} for command's `input` shape. + * */ export class ListTagsForResourceCommand extends $Command< ListTagsForResourceCommandInput, diff --git a/clients/client-medialive/commands/PurchaseOfferingCommand.ts b/clients/client-medialive/commands/PurchaseOfferingCommand.ts index aee503206729..d788b01c4204 100644 --- a/clients/client-medialive/commands/PurchaseOfferingCommand.ts +++ b/clients/client-medialive/commands/PurchaseOfferingCommand.ts @@ -22,6 +22,20 @@ export interface PurchaseOfferingCommandOutput extends PurchaseOfferingResponse, /** * Purchase an offering and create a reservation. + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { MediaLiveClient, PurchaseOfferingCommand } from "@aws-sdk/client-medialive"; // ES Modules import + * // const { MediaLiveClient, PurchaseOfferingCommand } = require("@aws-sdk/client-medialive"); // CommonJS import + * const client = new MediaLiveClient(config); + * const command = new PurchaseOfferingCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link PurchaseOfferingCommandInput} for command's `input` shape. + * @see {@link PurchaseOfferingCommandOutput} for command's `response` shape. + * @see {@link MediaLiveClientResolvedConfig | config} for command's `input` shape. + * */ export class PurchaseOfferingCommand extends $Command< PurchaseOfferingCommandInput, diff --git a/clients/client-medialive/commands/RejectInputDeviceTransferCommand.ts b/clients/client-medialive/commands/RejectInputDeviceTransferCommand.ts index 44f6dd5c0b8a..9a99e173a072 100644 --- a/clients/client-medialive/commands/RejectInputDeviceTransferCommand.ts +++ b/clients/client-medialive/commands/RejectInputDeviceTransferCommand.ts @@ -22,6 +22,20 @@ export interface RejectInputDeviceTransferCommandOutput extends RejectInputDevic /** * Reject the transfer of the specified input device to your AWS account. + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { MediaLiveClient, RejectInputDeviceTransferCommand } from "@aws-sdk/client-medialive"; // ES Modules import + * // const { MediaLiveClient, RejectInputDeviceTransferCommand } = require("@aws-sdk/client-medialive"); // CommonJS import + * const client = new MediaLiveClient(config); + * const command = new RejectInputDeviceTransferCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link RejectInputDeviceTransferCommandInput} for command's `input` shape. + * @see {@link RejectInputDeviceTransferCommandOutput} for command's `response` shape. + * @see {@link MediaLiveClientResolvedConfig | config} for command's `input` shape. + * */ export class RejectInputDeviceTransferCommand extends $Command< RejectInputDeviceTransferCommandInput, diff --git a/clients/client-medialive/commands/StartChannelCommand.ts b/clients/client-medialive/commands/StartChannelCommand.ts index 91c6cfaf24aa..b68a83d43ac1 100644 --- a/clients/client-medialive/commands/StartChannelCommand.ts +++ b/clients/client-medialive/commands/StartChannelCommand.ts @@ -22,6 +22,20 @@ export interface StartChannelCommandOutput extends StartChannelResponse, __Metad /** * Starts an existing channel + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { MediaLiveClient, StartChannelCommand } from "@aws-sdk/client-medialive"; // ES Modules import + * // const { MediaLiveClient, StartChannelCommand } = require("@aws-sdk/client-medialive"); // CommonJS import + * const client = new MediaLiveClient(config); + * const command = new StartChannelCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link StartChannelCommandInput} for command's `input` shape. + * @see {@link StartChannelCommandOutput} for command's `response` shape. + * @see {@link MediaLiveClientResolvedConfig | config} for command's `input` shape. + * */ export class StartChannelCommand extends $Command< StartChannelCommandInput, diff --git a/clients/client-medialive/commands/StartMultiplexCommand.ts b/clients/client-medialive/commands/StartMultiplexCommand.ts index dcc46db23b3f..a5efd8fee061 100644 --- a/clients/client-medialive/commands/StartMultiplexCommand.ts +++ b/clients/client-medialive/commands/StartMultiplexCommand.ts @@ -22,6 +22,20 @@ export interface StartMultiplexCommandOutput extends StartMultiplexResponse, __M /** * Start (run) the multiplex. Starting the multiplex does not start the channels. You must explicitly start each channel. + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { MediaLiveClient, StartMultiplexCommand } from "@aws-sdk/client-medialive"; // ES Modules import + * // const { MediaLiveClient, StartMultiplexCommand } = require("@aws-sdk/client-medialive"); // CommonJS import + * const client = new MediaLiveClient(config); + * const command = new StartMultiplexCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link StartMultiplexCommandInput} for command's `input` shape. + * @see {@link StartMultiplexCommandOutput} for command's `response` shape. + * @see {@link MediaLiveClientResolvedConfig | config} for command's `input` shape. + * */ export class StartMultiplexCommand extends $Command< StartMultiplexCommandInput, diff --git a/clients/client-medialive/commands/StopChannelCommand.ts b/clients/client-medialive/commands/StopChannelCommand.ts index 1c9c7f538785..1c7efd28dc19 100644 --- a/clients/client-medialive/commands/StopChannelCommand.ts +++ b/clients/client-medialive/commands/StopChannelCommand.ts @@ -22,6 +22,20 @@ export interface StopChannelCommandOutput extends StopChannelResponse, __Metadat /** * Stops a running channel + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { MediaLiveClient, StopChannelCommand } from "@aws-sdk/client-medialive"; // ES Modules import + * // const { MediaLiveClient, StopChannelCommand } = require("@aws-sdk/client-medialive"); // CommonJS import + * const client = new MediaLiveClient(config); + * const command = new StopChannelCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link StopChannelCommandInput} for command's `input` shape. + * @see {@link StopChannelCommandOutput} for command's `response` shape. + * @see {@link MediaLiveClientResolvedConfig | config} for command's `input` shape. + * */ export class StopChannelCommand extends $Command< StopChannelCommandInput, diff --git a/clients/client-medialive/commands/StopMultiplexCommand.ts b/clients/client-medialive/commands/StopMultiplexCommand.ts index 29e9e4f52907..1971e54368c9 100644 --- a/clients/client-medialive/commands/StopMultiplexCommand.ts +++ b/clients/client-medialive/commands/StopMultiplexCommand.ts @@ -22,6 +22,20 @@ export interface StopMultiplexCommandOutput extends StopMultiplexResponse, __Met /** * Stops a running multiplex. If the multiplex isn't running, this action has no effect. + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { MediaLiveClient, StopMultiplexCommand } from "@aws-sdk/client-medialive"; // ES Modules import + * // const { MediaLiveClient, StopMultiplexCommand } = require("@aws-sdk/client-medialive"); // CommonJS import + * const client = new MediaLiveClient(config); + * const command = new StopMultiplexCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link StopMultiplexCommandInput} for command's `input` shape. + * @see {@link StopMultiplexCommandOutput} for command's `response` shape. + * @see {@link MediaLiveClientResolvedConfig | config} for command's `input` shape. + * */ export class StopMultiplexCommand extends $Command< StopMultiplexCommandInput, diff --git a/clients/client-medialive/commands/TransferInputDeviceCommand.ts b/clients/client-medialive/commands/TransferInputDeviceCommand.ts index 56fa67197e24..c308915d76cd 100644 --- a/clients/client-medialive/commands/TransferInputDeviceCommand.ts +++ b/clients/client-medialive/commands/TransferInputDeviceCommand.ts @@ -22,6 +22,20 @@ export interface TransferInputDeviceCommandOutput extends TransferInputDeviceRes /** * Start an input device transfer to another AWS account. After you make the request, the other account must accept or reject the transfer. + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { MediaLiveClient, TransferInputDeviceCommand } from "@aws-sdk/client-medialive"; // ES Modules import + * // const { MediaLiveClient, TransferInputDeviceCommand } = require("@aws-sdk/client-medialive"); // CommonJS import + * const client = new MediaLiveClient(config); + * const command = new TransferInputDeviceCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link TransferInputDeviceCommandInput} for command's `input` shape. + * @see {@link TransferInputDeviceCommandOutput} for command's `response` shape. + * @see {@link MediaLiveClientResolvedConfig | config} for command's `input` shape. + * */ export class TransferInputDeviceCommand extends $Command< TransferInputDeviceCommandInput, diff --git a/clients/client-medialive/commands/UpdateChannelClassCommand.ts b/clients/client-medialive/commands/UpdateChannelClassCommand.ts index 63c828f213fa..48f33c38c152 100644 --- a/clients/client-medialive/commands/UpdateChannelClassCommand.ts +++ b/clients/client-medialive/commands/UpdateChannelClassCommand.ts @@ -22,6 +22,20 @@ export interface UpdateChannelClassCommandOutput extends UpdateChannelClassRespo /** * Changes the class of the channel. + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { MediaLiveClient, UpdateChannelClassCommand } from "@aws-sdk/client-medialive"; // ES Modules import + * // const { MediaLiveClient, UpdateChannelClassCommand } = require("@aws-sdk/client-medialive"); // CommonJS import + * const client = new MediaLiveClient(config); + * const command = new UpdateChannelClassCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link UpdateChannelClassCommandInput} for command's `input` shape. + * @see {@link UpdateChannelClassCommandOutput} for command's `response` shape. + * @see {@link MediaLiveClientResolvedConfig | config} for command's `input` shape. + * */ export class UpdateChannelClassCommand extends $Command< UpdateChannelClassCommandInput, diff --git a/clients/client-medialive/commands/UpdateChannelCommand.ts b/clients/client-medialive/commands/UpdateChannelCommand.ts index fe5e9713dd1c..50d0ea9dfa9d 100644 --- a/clients/client-medialive/commands/UpdateChannelCommand.ts +++ b/clients/client-medialive/commands/UpdateChannelCommand.ts @@ -22,6 +22,20 @@ export interface UpdateChannelCommandOutput extends UpdateChannelResponse, __Met /** * Updates a channel. + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { MediaLiveClient, UpdateChannelCommand } from "@aws-sdk/client-medialive"; // ES Modules import + * // const { MediaLiveClient, UpdateChannelCommand } = require("@aws-sdk/client-medialive"); // CommonJS import + * const client = new MediaLiveClient(config); + * const command = new UpdateChannelCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link UpdateChannelCommandInput} for command's `input` shape. + * @see {@link UpdateChannelCommandOutput} for command's `response` shape. + * @see {@link MediaLiveClientResolvedConfig | config} for command's `input` shape. + * */ export class UpdateChannelCommand extends $Command< UpdateChannelCommandInput, diff --git a/clients/client-medialive/commands/UpdateInputCommand.ts b/clients/client-medialive/commands/UpdateInputCommand.ts index faa256a4fe56..3f22ccdd1119 100644 --- a/clients/client-medialive/commands/UpdateInputCommand.ts +++ b/clients/client-medialive/commands/UpdateInputCommand.ts @@ -22,6 +22,20 @@ export interface UpdateInputCommandOutput extends UpdateInputResponse, __Metadat /** * Updates an input. + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { MediaLiveClient, UpdateInputCommand } from "@aws-sdk/client-medialive"; // ES Modules import + * // const { MediaLiveClient, UpdateInputCommand } = require("@aws-sdk/client-medialive"); // CommonJS import + * const client = new MediaLiveClient(config); + * const command = new UpdateInputCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link UpdateInputCommandInput} for command's `input` shape. + * @see {@link UpdateInputCommandOutput} for command's `response` shape. + * @see {@link MediaLiveClientResolvedConfig | config} for command's `input` shape. + * */ export class UpdateInputCommand extends $Command< UpdateInputCommandInput, diff --git a/clients/client-medialive/commands/UpdateInputDeviceCommand.ts b/clients/client-medialive/commands/UpdateInputDeviceCommand.ts index 98be693aa318..7dc5e4bfe8fe 100644 --- a/clients/client-medialive/commands/UpdateInputDeviceCommand.ts +++ b/clients/client-medialive/commands/UpdateInputDeviceCommand.ts @@ -22,6 +22,20 @@ export interface UpdateInputDeviceCommandOutput extends UpdateInputDeviceRespons /** * Updates the parameters for the input device. + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { MediaLiveClient, UpdateInputDeviceCommand } from "@aws-sdk/client-medialive"; // ES Modules import + * // const { MediaLiveClient, UpdateInputDeviceCommand } = require("@aws-sdk/client-medialive"); // CommonJS import + * const client = new MediaLiveClient(config); + * const command = new UpdateInputDeviceCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link UpdateInputDeviceCommandInput} for command's `input` shape. + * @see {@link UpdateInputDeviceCommandOutput} for command's `response` shape. + * @see {@link MediaLiveClientResolvedConfig | config} for command's `input` shape. + * */ export class UpdateInputDeviceCommand extends $Command< UpdateInputDeviceCommandInput, diff --git a/clients/client-medialive/commands/UpdateInputSecurityGroupCommand.ts b/clients/client-medialive/commands/UpdateInputSecurityGroupCommand.ts index 965f18570a60..5d8eb2d89d09 100644 --- a/clients/client-medialive/commands/UpdateInputSecurityGroupCommand.ts +++ b/clients/client-medialive/commands/UpdateInputSecurityGroupCommand.ts @@ -22,6 +22,20 @@ export interface UpdateInputSecurityGroupCommandOutput extends UpdateInputSecuri /** * Update an Input Security Group's Whilelists. + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { MediaLiveClient, UpdateInputSecurityGroupCommand } from "@aws-sdk/client-medialive"; // ES Modules import + * // const { MediaLiveClient, UpdateInputSecurityGroupCommand } = require("@aws-sdk/client-medialive"); // CommonJS import + * const client = new MediaLiveClient(config); + * const command = new UpdateInputSecurityGroupCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link UpdateInputSecurityGroupCommandInput} for command's `input` shape. + * @see {@link UpdateInputSecurityGroupCommandOutput} for command's `response` shape. + * @see {@link MediaLiveClientResolvedConfig | config} for command's `input` shape. + * */ export class UpdateInputSecurityGroupCommand extends $Command< UpdateInputSecurityGroupCommandInput, diff --git a/clients/client-medialive/commands/UpdateMultiplexCommand.ts b/clients/client-medialive/commands/UpdateMultiplexCommand.ts index d611b3e74e0a..c6ad434c88f7 100644 --- a/clients/client-medialive/commands/UpdateMultiplexCommand.ts +++ b/clients/client-medialive/commands/UpdateMultiplexCommand.ts @@ -22,6 +22,20 @@ export interface UpdateMultiplexCommandOutput extends UpdateMultiplexResponse, _ /** * Updates a multiplex. + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { MediaLiveClient, UpdateMultiplexCommand } from "@aws-sdk/client-medialive"; // ES Modules import + * // const { MediaLiveClient, UpdateMultiplexCommand } = require("@aws-sdk/client-medialive"); // CommonJS import + * const client = new MediaLiveClient(config); + * const command = new UpdateMultiplexCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link UpdateMultiplexCommandInput} for command's `input` shape. + * @see {@link UpdateMultiplexCommandOutput} for command's `response` shape. + * @see {@link MediaLiveClientResolvedConfig | config} for command's `input` shape. + * */ export class UpdateMultiplexCommand extends $Command< UpdateMultiplexCommandInput, diff --git a/clients/client-medialive/commands/UpdateMultiplexProgramCommand.ts b/clients/client-medialive/commands/UpdateMultiplexProgramCommand.ts index 98cec59e7971..67f7bf5ea6e8 100644 --- a/clients/client-medialive/commands/UpdateMultiplexProgramCommand.ts +++ b/clients/client-medialive/commands/UpdateMultiplexProgramCommand.ts @@ -22,6 +22,20 @@ export interface UpdateMultiplexProgramCommandOutput extends UpdateMultiplexProg /** * Update a program in a multiplex. + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { MediaLiveClient, UpdateMultiplexProgramCommand } from "@aws-sdk/client-medialive"; // ES Modules import + * // const { MediaLiveClient, UpdateMultiplexProgramCommand } = require("@aws-sdk/client-medialive"); // CommonJS import + * const client = new MediaLiveClient(config); + * const command = new UpdateMultiplexProgramCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link UpdateMultiplexProgramCommandInput} for command's `input` shape. + * @see {@link UpdateMultiplexProgramCommandOutput} for command's `response` shape. + * @see {@link MediaLiveClientResolvedConfig | config} for command's `input` shape. + * */ export class UpdateMultiplexProgramCommand extends $Command< UpdateMultiplexProgramCommandInput, diff --git a/clients/client-medialive/commands/UpdateReservationCommand.ts b/clients/client-medialive/commands/UpdateReservationCommand.ts index 1599c8c29ff9..e823de8ab1f8 100644 --- a/clients/client-medialive/commands/UpdateReservationCommand.ts +++ b/clients/client-medialive/commands/UpdateReservationCommand.ts @@ -22,6 +22,20 @@ export interface UpdateReservationCommandOutput extends UpdateReservationRespons /** * Update reservation. + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { MediaLiveClient, UpdateReservationCommand } from "@aws-sdk/client-medialive"; // ES Modules import + * // const { MediaLiveClient, UpdateReservationCommand } = require("@aws-sdk/client-medialive"); // CommonJS import + * const client = new MediaLiveClient(config); + * const command = new UpdateReservationCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link UpdateReservationCommandInput} for command's `input` shape. + * @see {@link UpdateReservationCommandOutput} for command's `response` shape. + * @see {@link MediaLiveClientResolvedConfig | config} for command's `input` shape. + * */ export class UpdateReservationCommand extends $Command< UpdateReservationCommandInput, diff --git a/clients/client-medialive/models/models_0.ts b/clients/client-medialive/models/models_0.ts index ddece9f1b068..66a397e46062 100644 --- a/clients/client-medialive/models/models_0.ts +++ b/clients/client-medialive/models/models_0.ts @@ -14,6 +14,9 @@ export interface InputChannelLevel { } export namespace InputChannelLevel { + /** + * @internal + */ export const filterSensitiveLog = (obj: InputChannelLevel): any => ({ ...obj, }); @@ -35,6 +38,9 @@ export interface AudioChannelMapping { } export namespace AudioChannelMapping { + /** + * @internal + */ export const filterSensitiveLog = (obj: AudioChannelMapping): any => ({ ...obj, }); @@ -70,6 +76,9 @@ export interface AudioNormalizationSettings { } export namespace AudioNormalizationSettings { + /** + * @internal + */ export const filterSensitiveLog = (obj: AudioNormalizationSettings): any => ({ ...obj, }); @@ -181,6 +190,9 @@ export interface AacSettings { } export namespace AacSettings { + /** + * @internal + */ export const filterSensitiveLog = (obj: AacSettings): any => ({ ...obj, }); @@ -260,6 +272,9 @@ export interface Ac3Settings { } export namespace Ac3Settings { + /** + * @internal + */ export const filterSensitiveLog = (obj: Ac3Settings): any => ({ ...obj, }); @@ -457,6 +472,9 @@ export interface Eac3Settings { } export namespace Eac3Settings { + /** + * @internal + */ export const filterSensitiveLog = (obj: Eac3Settings): any => ({ ...obj, }); @@ -488,6 +506,9 @@ export interface Mp2Settings { } export namespace Mp2Settings { + /** + * @internal + */ export const filterSensitiveLog = (obj: Mp2Settings): any => ({ ...obj, }); @@ -499,6 +520,9 @@ export namespace Mp2Settings { export interface PassThroughSettings {} export namespace PassThroughSettings { + /** + * @internal + */ export const filterSensitiveLog = (obj: PassThroughSettings): any => ({ ...obj, }); @@ -532,6 +556,9 @@ export interface WavSettings { } export namespace WavSettings { + /** + * @internal + */ export const filterSensitiveLog = (obj: WavSettings): any => ({ ...obj, }); @@ -573,6 +600,9 @@ export interface AudioCodecSettings { } export namespace AudioCodecSettings { + /** + * @internal + */ export const filterSensitiveLog = (obj: AudioCodecSettings): any => ({ ...obj, }); @@ -605,6 +635,9 @@ export interface RemixSettings { } export namespace RemixSettings { + /** + * @internal + */ export const filterSensitiveLog = (obj: RemixSettings): any => ({ ...obj, }); @@ -669,6 +702,9 @@ export interface AudioDescription { } export namespace AudioDescription { + /** + * @internal + */ export const filterSensitiveLog = (obj: AudioDescription): any => ({ ...obj, }); @@ -695,6 +731,9 @@ export interface AudioLanguageSelection { } export namespace AudioLanguageSelection { + /** + * @internal + */ export const filterSensitiveLog = (obj: AudioLanguageSelection): any => ({ ...obj, }); @@ -711,6 +750,9 @@ export interface AudioPidSelection { } export namespace AudioPidSelection { + /** + * @internal + */ export const filterSensitiveLog = (obj: AudioPidSelection): any => ({ ...obj, }); @@ -727,6 +769,9 @@ export interface AudioTrack { } export namespace AudioTrack { + /** + * @internal + */ export const filterSensitiveLog = (obj: AudioTrack): any => ({ ...obj, }); @@ -743,6 +788,9 @@ export interface AudioTrackSelection { } export namespace AudioTrackSelection { + /** + * @internal + */ export const filterSensitiveLog = (obj: AudioTrackSelection): any => ({ ...obj, }); @@ -769,6 +817,9 @@ export interface AudioSelectorSettings { } export namespace AudioSelectorSettings { + /** + * @internal + */ export const filterSensitiveLog = (obj: AudioSelectorSettings): any => ({ ...obj, }); @@ -790,6 +841,9 @@ export interface AudioSelector { } export namespace AudioSelector { + /** + * @internal + */ export const filterSensitiveLog = (obj: AudioSelector): any => ({ ...obj, }); @@ -821,6 +875,9 @@ export interface BatchFailedResultModel { } export namespace BatchFailedResultModel { + /** + * @internal + */ export const filterSensitiveLog = (obj: BatchFailedResultModel): any => ({ ...obj, }); @@ -847,6 +904,9 @@ export interface BatchSuccessfulResultModel { } export namespace BatchSuccessfulResultModel { + /** + * @internal + */ export const filterSensitiveLog = (obj: BatchSuccessfulResultModel): any => ({ ...obj, }); @@ -858,6 +918,9 @@ export namespace BatchSuccessfulResultModel { export interface AribDestinationSettings {} export namespace AribDestinationSettings { + /** + * @internal + */ export const filterSensitiveLog = (obj: AribDestinationSettings): any => ({ ...obj, }); @@ -896,6 +959,9 @@ export interface InputLocation { } export namespace InputLocation { + /** + * @internal + */ export const filterSensitiveLog = (obj: InputLocation): any => ({ ...obj, }); @@ -1021,6 +1087,9 @@ export interface BurnInDestinationSettings { } export namespace BurnInDestinationSettings { + /** + * @internal + */ export const filterSensitiveLog = (obj: BurnInDestinationSettings): any => ({ ...obj, }); @@ -1158,6 +1227,9 @@ export interface DvbSubDestinationSettings { } export namespace DvbSubDestinationSettings { + /** + * @internal + */ export const filterSensitiveLog = (obj: DvbSubDestinationSettings): any => ({ ...obj, }); @@ -1210,6 +1282,9 @@ export interface EbuTtDDestinationSettings { } export namespace EbuTtDDestinationSettings { + /** + * @internal + */ export const filterSensitiveLog = (obj: EbuTtDDestinationSettings): any => ({ ...obj, }); @@ -1221,6 +1296,9 @@ export namespace EbuTtDDestinationSettings { export interface EmbeddedDestinationSettings {} export namespace EmbeddedDestinationSettings { + /** + * @internal + */ export const filterSensitiveLog = (obj: EmbeddedDestinationSettings): any => ({ ...obj, }); @@ -1232,6 +1310,9 @@ export namespace EmbeddedDestinationSettings { export interface EmbeddedPlusScte20DestinationSettings {} export namespace EmbeddedPlusScte20DestinationSettings { + /** + * @internal + */ export const filterSensitiveLog = (obj: EmbeddedPlusScte20DestinationSettings): any => ({ ...obj, }); @@ -1243,6 +1324,9 @@ export namespace EmbeddedPlusScte20DestinationSettings { export interface RtmpCaptionInfoDestinationSettings {} export namespace RtmpCaptionInfoDestinationSettings { + /** + * @internal + */ export const filterSensitiveLog = (obj: RtmpCaptionInfoDestinationSettings): any => ({ ...obj, }); @@ -1254,6 +1338,9 @@ export namespace RtmpCaptionInfoDestinationSettings { export interface Scte20PlusEmbeddedDestinationSettings {} export namespace Scte20PlusEmbeddedDestinationSettings { + /** + * @internal + */ export const filterSensitiveLog = (obj: Scte20PlusEmbeddedDestinationSettings): any => ({ ...obj, }); @@ -1265,6 +1352,9 @@ export namespace Scte20PlusEmbeddedDestinationSettings { export interface Scte27DestinationSettings {} export namespace Scte27DestinationSettings { + /** + * @internal + */ export const filterSensitiveLog = (obj: Scte27DestinationSettings): any => ({ ...obj, }); @@ -1276,6 +1366,9 @@ export namespace Scte27DestinationSettings { export interface SmpteTtDestinationSettings {} export namespace SmpteTtDestinationSettings { + /** + * @internal + */ export const filterSensitiveLog = (obj: SmpteTtDestinationSettings): any => ({ ...obj, }); @@ -1287,6 +1380,9 @@ export namespace SmpteTtDestinationSettings { export interface TeletextDestinationSettings {} export namespace TeletextDestinationSettings { + /** + * @internal + */ export const filterSensitiveLog = (obj: TeletextDestinationSettings): any => ({ ...obj, }); @@ -1308,6 +1404,9 @@ export interface TtmlDestinationSettings { } export namespace TtmlDestinationSettings { + /** + * @internal + */ export const filterSensitiveLog = (obj: TtmlDestinationSettings): any => ({ ...obj, }); @@ -1319,6 +1418,9 @@ export namespace TtmlDestinationSettings { export interface WebvttDestinationSettings {} export namespace WebvttDestinationSettings { + /** + * @internal + */ export const filterSensitiveLog = (obj: WebvttDestinationSettings): any => ({ ...obj, }); @@ -1395,6 +1497,9 @@ export interface CaptionDestinationSettings { } export namespace CaptionDestinationSettings { + /** + * @internal + */ export const filterSensitiveLog = (obj: CaptionDestinationSettings): any => ({ ...obj, }); @@ -1431,6 +1536,9 @@ export interface CaptionDescription { } export namespace CaptionDescription { + /** + * @internal + */ export const filterSensitiveLog = (obj: CaptionDescription): any => ({ ...obj, }); @@ -1457,6 +1565,9 @@ export interface CaptionLanguageMapping { } export namespace CaptionLanguageMapping { + /** + * @internal + */ export const filterSensitiveLog = (obj: CaptionLanguageMapping): any => ({ ...obj, }); @@ -1473,6 +1584,9 @@ export interface AncillarySourceSettings { } export namespace AncillarySourceSettings { + /** + * @internal + */ export const filterSensitiveLog = (obj: AncillarySourceSettings): any => ({ ...obj, }); @@ -1484,6 +1598,9 @@ export namespace AncillarySourceSettings { export interface AribSourceSettings {} export namespace AribSourceSettings { + /** + * @internal + */ export const filterSensitiveLog = (obj: AribSourceSettings): any => ({ ...obj, }); @@ -1500,6 +1617,9 @@ export interface DvbSubSourceSettings { } export namespace DvbSubSourceSettings { + /** + * @internal + */ export const filterSensitiveLog = (obj: DvbSubSourceSettings): any => ({ ...obj, }); @@ -1541,6 +1661,9 @@ export interface EmbeddedSourceSettings { } export namespace EmbeddedSourceSettings { + /** + * @internal + */ export const filterSensitiveLog = (obj: EmbeddedSourceSettings): any => ({ ...obj, }); @@ -1567,6 +1690,9 @@ export interface Scte20SourceSettings { } export namespace Scte20SourceSettings { + /** + * @internal + */ export const filterSensitiveLog = (obj: Scte20SourceSettings): any => ({ ...obj, }); @@ -1587,6 +1713,9 @@ export interface Scte27SourceSettings { } export namespace Scte27SourceSettings { + /** + * @internal + */ export const filterSensitiveLog = (obj: Scte27SourceSettings): any => ({ ...obj, }); @@ -1627,6 +1756,9 @@ export interface CaptionRectangle { } export namespace CaptionRectangle { + /** + * @internal + */ export const filterSensitiveLog = (obj: CaptionRectangle): any => ({ ...obj, }); @@ -1648,6 +1780,9 @@ export interface TeletextSourceSettings { } export namespace TeletextSourceSettings { + /** + * @internal + */ export const filterSensitiveLog = (obj: TeletextSourceSettings): any => ({ ...obj, }); @@ -1694,6 +1829,9 @@ export interface CaptionSelectorSettings { } export namespace CaptionSelectorSettings { + /** + * @internal + */ export const filterSensitiveLog = (obj: CaptionSelectorSettings): any => ({ ...obj, }); @@ -1720,6 +1858,9 @@ export interface CaptionSelector { } export namespace CaptionSelector { + /** + * @internal + */ export const filterSensitiveLog = (obj: CaptionSelector): any => ({ ...obj, }); @@ -1736,6 +1877,9 @@ export interface ChannelEgressEndpoint { } export namespace ChannelEgressEndpoint { + /** + * @internal + */ export const filterSensitiveLog = (obj: ChannelEgressEndpoint): any => ({ ...obj, }); @@ -1759,6 +1903,9 @@ export interface CdiInputSpecification { } export namespace CdiInputSpecification { + /** + * @internal + */ export const filterSensitiveLog = (obj: CdiInputSpecification): any => ({ ...obj, }); @@ -1780,6 +1927,9 @@ export interface MediaPackageOutputDestinationSettings { } export namespace MediaPackageOutputDestinationSettings { + /** + * @internal + */ export const filterSensitiveLog = (obj: MediaPackageOutputDestinationSettings): any => ({ ...obj, }); @@ -1802,6 +1952,9 @@ export interface MultiplexProgramChannelDestinationSettings { } export namespace MultiplexProgramChannelDestinationSettings { + /** + * @internal + */ export const filterSensitiveLog = (obj: MultiplexProgramChannelDestinationSettings): any => ({ ...obj, }); @@ -1833,6 +1986,9 @@ export interface OutputDestinationSettings { } export namespace OutputDestinationSettings { + /** + * @internal + */ export const filterSensitiveLog = (obj: OutputDestinationSettings): any => ({ ...obj, }); @@ -1864,6 +2020,9 @@ export interface OutputDestination { } export namespace OutputDestination { + /** + * @internal + */ export const filterSensitiveLog = (obj: OutputDestination): any => ({ ...obj, }); @@ -1885,6 +2044,9 @@ export interface AudioSilenceFailoverSettings { } export namespace AudioSilenceFailoverSettings { + /** + * @internal + */ export const filterSensitiveLog = (obj: AudioSilenceFailoverSettings): any => ({ ...obj, }); @@ -1901,6 +2063,9 @@ export interface InputLossFailoverSettings { } export namespace InputLossFailoverSettings { + /** + * @internal + */ export const filterSensitiveLog = (obj: InputLossFailoverSettings): any => ({ ...obj, }); @@ -1922,6 +2087,9 @@ export interface VideoBlackFailoverSettings { } export namespace VideoBlackFailoverSettings { + /** + * @internal + */ export const filterSensitiveLog = (obj: VideoBlackFailoverSettings): any => ({ ...obj, }); @@ -1948,6 +2116,9 @@ export interface FailoverConditionSettings { } export namespace FailoverConditionSettings { + /** + * @internal + */ export const filterSensitiveLog = (obj: FailoverConditionSettings): any => ({ ...obj, }); @@ -1964,6 +2135,9 @@ export interface FailoverCondition { } export namespace FailoverCondition { + /** + * @internal + */ export const filterSensitiveLog = (obj: FailoverCondition): any => ({ ...obj, }); @@ -2000,6 +2174,9 @@ export interface AutomaticInputFailoverSettings { } export namespace AutomaticInputFailoverSettings { + /** + * @internal + */ export const filterSensitiveLog = (obj: AutomaticInputFailoverSettings): any => ({ ...obj, }); @@ -2047,6 +2224,9 @@ export interface HlsInputSettings { } export namespace HlsInputSettings { + /** + * @internal + */ export const filterSensitiveLog = (obj: HlsInputSettings): any => ({ ...obj, }); @@ -2073,6 +2253,9 @@ export interface NetworkInputSettings { } export namespace NetworkInputSettings { + /** + * @internal + */ export const filterSensitiveLog = (obj: NetworkInputSettings): any => ({ ...obj, }); @@ -2116,6 +2299,9 @@ export interface Hdr10Settings { } export namespace Hdr10Settings { + /** + * @internal + */ export const filterSensitiveLog = (obj: Hdr10Settings): any => ({ ...obj, }); @@ -2132,6 +2318,9 @@ export interface VideoSelectorColorSpaceSettings { } export namespace VideoSelectorColorSpaceSettings { + /** + * @internal + */ export const filterSensitiveLog = (obj: VideoSelectorColorSpaceSettings): any => ({ ...obj, }); @@ -2153,6 +2342,9 @@ export interface VideoSelectorPid { } export namespace VideoSelectorPid { + /** + * @internal + */ export const filterSensitiveLog = (obj: VideoSelectorPid): any => ({ ...obj, }); @@ -2169,6 +2361,9 @@ export interface VideoSelectorProgramId { } export namespace VideoSelectorProgramId { + /** + * @internal + */ export const filterSensitiveLog = (obj: VideoSelectorProgramId): any => ({ ...obj, }); @@ -2190,6 +2385,9 @@ export interface VideoSelectorSettings { } export namespace VideoSelectorSettings { + /** + * @internal + */ export const filterSensitiveLog = (obj: VideoSelectorSettings): any => ({ ...obj, }); @@ -2221,6 +2419,9 @@ export interface VideoSelector { } export namespace VideoSelector { + /** + * @internal + */ export const filterSensitiveLog = (obj: VideoSelector): any => ({ ...obj, }); @@ -2287,6 +2488,9 @@ export interface InputSettings { } export namespace InputSettings { + /** + * @internal + */ export const filterSensitiveLog = (obj: InputSettings): any => ({ ...obj, }); @@ -2318,6 +2522,9 @@ export interface InputAttachment { } export namespace InputAttachment { + /** + * @internal + */ export const filterSensitiveLog = (obj: InputAttachment): any => ({ ...obj, }); @@ -2362,6 +2569,9 @@ export interface InputSpecification { } export namespace InputSpecification { + /** + * @internal + */ export const filterSensitiveLog = (obj: InputSpecification): any => ({ ...obj, }); @@ -2418,6 +2628,9 @@ export interface VpcOutputSettingsDescription { } export namespace VpcOutputSettingsDescription { + /** + * @internal + */ export const filterSensitiveLog = (obj: VpcOutputSettingsDescription): any => ({ ...obj, }); @@ -2506,6 +2719,9 @@ export interface ChannelSummary { } export namespace ChannelSummary { + /** + * @internal + */ export const filterSensitiveLog = (obj: ChannelSummary): any => ({ ...obj, }); @@ -2533,6 +2749,9 @@ export interface InputDestinationVpc { } export namespace InputDestinationVpc { + /** + * @internal + */ export const filterSensitiveLog = (obj: InputDestinationVpc): any => ({ ...obj, }); @@ -2566,6 +2785,9 @@ export interface InputDestination { } export namespace InputDestination { + /** + * @internal + */ export const filterSensitiveLog = (obj: InputDestination): any => ({ ...obj, }); @@ -2587,6 +2809,9 @@ export interface InputDeviceSettings { } export namespace InputDeviceSettings { + /** + * @internal + */ export const filterSensitiveLog = (obj: InputDeviceSettings): any => ({ ...obj, }); @@ -2608,6 +2833,9 @@ export interface MediaConnectFlow { } export namespace MediaConnectFlow { + /** + * @internal + */ export const filterSensitiveLog = (obj: MediaConnectFlow): any => ({ ...obj, }); @@ -2635,6 +2863,9 @@ export interface InputSource { } export namespace InputSource { + /** + * @internal + */ export const filterSensitiveLog = (obj: InputSource): any => ({ ...obj, }); @@ -2748,6 +2979,9 @@ export interface Input { } export namespace Input { + /** + * @internal + */ export const filterSensitiveLog = (obj: Input): any => ({ ...obj, }); @@ -2765,6 +2999,9 @@ export interface InputDestinationRequest { } export namespace InputDestinationRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: InputDestinationRequest): any => ({ ...obj, }); @@ -2781,6 +3018,9 @@ export interface InputDeviceRequest { } export namespace InputDeviceRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: InputDeviceRequest): any => ({ ...obj, }); @@ -2868,6 +3108,9 @@ export interface InputDeviceHdSettings { } export namespace InputDeviceHdSettings { + /** + * @internal + */ export const filterSensitiveLog = (obj: InputDeviceHdSettings): any => ({ ...obj, }); @@ -2909,6 +3152,9 @@ export interface InputDeviceNetworkSettings { } export namespace InputDeviceNetworkSettings { + /** + * @internal + */ export const filterSensitiveLog = (obj: InputDeviceNetworkSettings): any => ({ ...obj, }); @@ -2964,6 +3210,9 @@ export interface InputDeviceUhdSettings { } export namespace InputDeviceUhdSettings { + /** + * @internal + */ export const filterSensitiveLog = (obj: InputDeviceUhdSettings): any => ({ ...obj, }); @@ -3035,6 +3284,9 @@ export interface InputDeviceSummary { } export namespace InputDeviceSummary { + /** + * @internal + */ export const filterSensitiveLog = (obj: InputDeviceSummary): any => ({ ...obj, }); @@ -3058,6 +3310,9 @@ export interface InputWhitelistRule { } export namespace InputWhitelistRule { + /** + * @internal + */ export const filterSensitiveLog = (obj: InputWhitelistRule): any => ({ ...obj, }); @@ -3099,6 +3354,9 @@ export interface InputSecurityGroup { } export namespace InputSecurityGroup { + /** + * @internal + */ export const filterSensitiveLog = (obj: InputSecurityGroup): any => ({ ...obj, }); @@ -3126,6 +3384,9 @@ export interface InputSourceRequest { } export namespace InputSourceRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: InputSourceRequest): any => ({ ...obj, }); @@ -3142,6 +3403,9 @@ export interface InputWhitelistRuleCidr { } export namespace InputWhitelistRuleCidr { + /** + * @internal + */ export const filterSensitiveLog = (obj: InputWhitelistRuleCidr): any => ({ ...obj, }); @@ -3158,6 +3422,9 @@ export interface MediaConnectFlowRequest { } export namespace MediaConnectFlowRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: MediaConnectFlowRequest): any => ({ ...obj, }); @@ -3174,6 +3441,9 @@ export interface MultiplexMediaConnectOutputDestinationSettings { } export namespace MultiplexMediaConnectOutputDestinationSettings { + /** + * @internal + */ export const filterSensitiveLog = (obj: MultiplexMediaConnectOutputDestinationSettings): any => ({ ...obj, }); @@ -3190,6 +3460,9 @@ export interface MultiplexOutputDestination { } export namespace MultiplexOutputDestination { + /** + * @internal + */ export const filterSensitiveLog = (obj: MultiplexOutputDestination): any => ({ ...obj, }); @@ -3211,6 +3484,9 @@ export interface MultiplexProgramPipelineDetail { } export namespace MultiplexProgramPipelineDetail { + /** + * @internal + */ export const filterSensitiveLog = (obj: MultiplexProgramPipelineDetail): any => ({ ...obj, }); @@ -3232,6 +3508,9 @@ export interface MultiplexProgramSummary { } export namespace MultiplexProgramSummary { + /** + * @internal + */ export const filterSensitiveLog = (obj: MultiplexProgramSummary): any => ({ ...obj, }); @@ -3248,6 +3527,9 @@ export interface MultiplexSettingsSummary { } export namespace MultiplexSettingsSummary { + /** + * @internal + */ export const filterSensitiveLog = (obj: MultiplexSettingsSummary): any => ({ ...obj, }); @@ -3316,6 +3598,9 @@ export interface MultiplexSummary { } export namespace MultiplexSummary { + /** + * @internal + */ export const filterSensitiveLog = (obj: MultiplexSummary): any => ({ ...obj, }); @@ -3419,6 +3704,9 @@ export interface ReservationResourceSpecification { } export namespace ReservationResourceSpecification { + /** + * @internal + */ export const filterSensitiveLog = (obj: ReservationResourceSpecification): any => ({ ...obj, }); @@ -3485,6 +3773,9 @@ export interface Offering { } export namespace Offering { + /** + * @internal + */ export const filterSensitiveLog = (obj: Offering): any => ({ ...obj, }); @@ -3546,6 +3837,9 @@ export interface DvbNitSettings { } export namespace DvbNitSettings { + /** + * @internal + */ export const filterSensitiveLog = (obj: DvbNitSettings): any => ({ ...obj, }); @@ -3584,6 +3878,9 @@ export interface DvbSdtSettings { } export namespace DvbSdtSettings { + /** + * @internal + */ export const filterSensitiveLog = (obj: DvbSdtSettings): any => ({ ...obj, }); @@ -3600,6 +3897,9 @@ export interface DvbTdtSettings { } export namespace DvbTdtSettings { + /** + * @internal + */ export const filterSensitiveLog = (obj: DvbTdtSettings): any => ({ ...obj, }); @@ -3914,6 +4214,9 @@ export interface M2tsSettings { } export namespace M2tsSettings { + /** + * @internal + */ export const filterSensitiveLog = (obj: M2tsSettings): any => ({ ...obj, }); @@ -3925,6 +4228,9 @@ export namespace M2tsSettings { export interface RawSettings {} export namespace RawSettings { + /** + * @internal + */ export const filterSensitiveLog = (obj: RawSettings): any => ({ ...obj, }); @@ -3946,6 +4252,9 @@ export interface ArchiveContainerSettings { } export namespace ArchiveContainerSettings { + /** + * @internal + */ export const filterSensitiveLog = (obj: ArchiveContainerSettings): any => ({ ...obj, }); @@ -3972,6 +4281,9 @@ export interface ArchiveOutputSettings { } export namespace ArchiveOutputSettings { + /** + * @internal + */ export const filterSensitiveLog = (obj: ArchiveOutputSettings): any => ({ ...obj, }); @@ -3988,6 +4300,9 @@ export interface FrameCaptureOutputSettings { } export namespace FrameCaptureOutputSettings { + /** + * @internal + */ export const filterSensitiveLog = (obj: FrameCaptureOutputSettings): any => ({ ...obj, }); @@ -4050,6 +4365,9 @@ export interface AudioOnlyHlsSettings { } export namespace AudioOnlyHlsSettings { + /** + * @internal + */ export const filterSensitiveLog = (obj: AudioOnlyHlsSettings): any => ({ ...obj, }); @@ -4086,6 +4404,9 @@ export interface Fmp4HlsSettings { } export namespace Fmp4HlsSettings { + /** + * @internal + */ export const filterSensitiveLog = (obj: Fmp4HlsSettings): any => ({ ...obj, }); @@ -4097,6 +4418,9 @@ export namespace Fmp4HlsSettings { export interface FrameCaptureHlsSettings {} export namespace FrameCaptureHlsSettings { + /** + * @internal + */ export const filterSensitiveLog = (obj: FrameCaptureHlsSettings): any => ({ ...obj, }); @@ -4213,6 +4537,9 @@ export interface M3u8Settings { } export namespace M3u8Settings { + /** + * @internal + */ export const filterSensitiveLog = (obj: M3u8Settings): any => ({ ...obj, }); @@ -4234,6 +4561,9 @@ export interface StandardHlsSettings { } export namespace StandardHlsSettings { + /** + * @internal + */ export const filterSensitiveLog = (obj: StandardHlsSettings): any => ({ ...obj, }); @@ -4265,6 +4595,9 @@ export interface HlsSettings { } export namespace HlsSettings { + /** + * @internal + */ export const filterSensitiveLog = (obj: HlsSettings): any => ({ ...obj, }); @@ -4297,6 +4630,9 @@ export interface HlsOutputSettings { } export namespace HlsOutputSettings { + /** + * @internal + */ export const filterSensitiveLog = (obj: HlsOutputSettings): any => ({ ...obj, }); @@ -4308,6 +4644,9 @@ export namespace HlsOutputSettings { export interface MediaPackageOutputSettings {} export namespace MediaPackageOutputSettings { + /** + * @internal + */ export const filterSensitiveLog = (obj: MediaPackageOutputSettings): any => ({ ...obj, }); @@ -4335,6 +4674,9 @@ export interface MsSmoothOutputSettings { } export namespace MsSmoothOutputSettings { + /** + * @internal + */ export const filterSensitiveLog = (obj: MsSmoothOutputSettings): any => ({ ...obj, }); @@ -4351,6 +4693,9 @@ export interface OutputLocationRef { } export namespace OutputLocationRef { + /** + * @internal + */ export const filterSensitiveLog = (obj: OutputLocationRef): any => ({ ...obj, }); @@ -4367,6 +4712,9 @@ export interface MultiplexOutputSettings { } export namespace MultiplexOutputSettings { + /** + * @internal + */ export const filterSensitiveLog = (obj: MultiplexOutputSettings): any => ({ ...obj, }); @@ -4403,6 +4751,9 @@ export interface RtmpOutputSettings { } export namespace RtmpOutputSettings { + /** + * @internal + */ export const filterSensitiveLog = (obj: RtmpOutputSettings): any => ({ ...obj, }); @@ -4419,6 +4770,9 @@ export interface UdpContainerSettings { } export namespace UdpContainerSettings { + /** + * @internal + */ export const filterSensitiveLog = (obj: UdpContainerSettings): any => ({ ...obj, }); @@ -4450,6 +4804,9 @@ export interface FecOutputSettings { } export namespace FecOutputSettings { + /** + * @internal + */ export const filterSensitiveLog = (obj: FecOutputSettings): any => ({ ...obj, }); @@ -4481,6 +4838,9 @@ export interface UdpOutputSettings { } export namespace UdpOutputSettings { + /** + * @internal + */ export const filterSensitiveLog = (obj: UdpOutputSettings): any => ({ ...obj, }); @@ -4532,6 +4892,9 @@ export interface OutputSettings { } export namespace OutputSettings { + /** + * @internal + */ export const filterSensitiveLog = (obj: OutputSettings): any => ({ ...obj, }); @@ -4568,6 +4931,9 @@ export interface Output { } export namespace Output { + /** + * @internal + */ export const filterSensitiveLog = (obj: Output): any => ({ ...obj, }); @@ -4591,6 +4957,9 @@ export interface ArchiveS3Settings { } export namespace ArchiveS3Settings { + /** + * @internal + */ export const filterSensitiveLog = (obj: ArchiveS3Settings): any => ({ ...obj, }); @@ -4607,6 +4976,9 @@ export interface ArchiveCdnSettings { } export namespace ArchiveCdnSettings { + /** + * @internal + */ export const filterSensitiveLog = (obj: ArchiveCdnSettings): any => ({ ...obj, }); @@ -4633,6 +5005,9 @@ export interface ArchiveGroupSettings { } export namespace ArchiveGroupSettings { + /** + * @internal + */ export const filterSensitiveLog = (obj: ArchiveGroupSettings): any => ({ ...obj, }); @@ -4649,6 +5024,9 @@ export interface FrameCaptureS3Settings { } export namespace FrameCaptureS3Settings { + /** + * @internal + */ export const filterSensitiveLog = (obj: FrameCaptureS3Settings): any => ({ ...obj, }); @@ -4665,6 +5043,9 @@ export interface FrameCaptureCdnSettings { } export namespace FrameCaptureCdnSettings { + /** + * @internal + */ export const filterSensitiveLog = (obj: FrameCaptureCdnSettings): any => ({ ...obj, }); @@ -4686,6 +5067,9 @@ export interface FrameCaptureGroupSettings { } export namespace FrameCaptureGroupSettings { + /** + * @internal + */ export const filterSensitiveLog = (obj: FrameCaptureGroupSettings): any => ({ ...obj, }); @@ -4768,6 +5152,9 @@ export interface HlsAkamaiSettings { } export namespace HlsAkamaiSettings { + /** + * @internal + */ export const filterSensitiveLog = (obj: HlsAkamaiSettings): any => ({ ...obj, }); @@ -4799,6 +5186,9 @@ export interface HlsBasicPutSettings { } export namespace HlsBasicPutSettings { + /** + * @internal + */ export const filterSensitiveLog = (obj: HlsBasicPutSettings): any => ({ ...obj, }); @@ -4839,6 +5229,9 @@ export interface HlsMediaStoreSettings { } export namespace HlsMediaStoreSettings { + /** + * @internal + */ export const filterSensitiveLog = (obj: HlsMediaStoreSettings): any => ({ ...obj, }); @@ -4855,6 +5248,9 @@ export interface HlsS3Settings { } export namespace HlsS3Settings { + /** + * @internal + */ export const filterSensitiveLog = (obj: HlsS3Settings): any => ({ ...obj, }); @@ -4896,6 +5292,9 @@ export interface HlsWebdavSettings { } export namespace HlsWebdavSettings { + /** + * @internal + */ export const filterSensitiveLog = (obj: HlsWebdavSettings): any => ({ ...obj, }); @@ -4932,6 +5331,9 @@ export interface HlsCdnSettings { } export namespace HlsCdnSettings { + /** + * @internal + */ export const filterSensitiveLog = (obj: HlsCdnSettings): any => ({ ...obj, }); @@ -4983,6 +5385,9 @@ export interface StaticKeySettings { } export namespace StaticKeySettings { + /** + * @internal + */ export const filterSensitiveLog = (obj: StaticKeySettings): any => ({ ...obj, }); @@ -4999,6 +5404,9 @@ export interface KeyProviderSettings { } export namespace KeyProviderSettings { + /** + * @internal + */ export const filterSensitiveLog = (obj: KeyProviderSettings): any => ({ ...obj, }); @@ -5303,6 +5711,9 @@ export interface HlsGroupSettings { } export namespace HlsGroupSettings { + /** + * @internal + */ export const filterSensitiveLog = (obj: HlsGroupSettings): any => ({ ...obj, }); @@ -5319,6 +5730,9 @@ export interface MediaPackageGroupSettings { } export namespace MediaPackageGroupSettings { + /** + * @internal + */ export const filterSensitiveLog = (obj: MediaPackageGroupSettings): any => ({ ...obj, }); @@ -5484,6 +5898,9 @@ export interface MsSmoothGroupSettings { } export namespace MsSmoothGroupSettings { + /** + * @internal + */ export const filterSensitiveLog = (obj: MsSmoothGroupSettings): any => ({ ...obj, }); @@ -5495,6 +5912,9 @@ export namespace MsSmoothGroupSettings { export interface MultiplexGroupSettings {} export namespace MultiplexGroupSettings { + /** + * @internal + */ export const filterSensitiveLog = (obj: MultiplexGroupSettings): any => ({ ...obj, }); diff --git a/clients/client-medialive/models/models_1.ts b/clients/client-medialive/models/models_1.ts index 53fdbb140d22..ac7c2122fabb 100644 --- a/clients/client-medialive/models/models_1.ts +++ b/clients/client-medialive/models/models_1.ts @@ -131,6 +131,9 @@ export interface RtmpGroupSettings { } export namespace RtmpGroupSettings { + /** + * @internal + */ export const filterSensitiveLog = (obj: RtmpGroupSettings): any => ({ ...obj, }); @@ -169,6 +172,9 @@ export interface UdpGroupSettings { } export namespace UdpGroupSettings { + /** + * @internal + */ export const filterSensitiveLog = (obj: UdpGroupSettings): any => ({ ...obj, }); @@ -220,6 +226,9 @@ export interface OutputGroupSettings { } export namespace OutputGroupSettings { + /** + * @internal + */ export const filterSensitiveLog = (obj: OutputGroupSettings): any => ({ ...obj, }); @@ -246,6 +255,9 @@ export interface OutputGroup { } export namespace OutputGroup { + /** + * @internal + */ export const filterSensitiveLog = (obj: OutputGroup): any => ({ ...obj, }); @@ -282,6 +294,9 @@ export interface PipelineDetail { } export namespace PipelineDetail { + /** + * @internal + */ export const filterSensitiveLog = (obj: PipelineDetail): any => ({ ...obj, }); @@ -303,6 +318,9 @@ export interface PipelinePauseStateSettings { } export namespace PipelinePauseStateSettings { + /** + * @internal + */ export const filterSensitiveLog = (obj: PipelinePauseStateSettings): any => ({ ...obj, }); @@ -411,6 +429,9 @@ export interface Reservation { } export namespace Reservation { + /** + * @internal + */ export const filterSensitiveLog = (obj: Reservation): any => ({ ...obj, }); @@ -427,6 +448,9 @@ export interface HlsId3SegmentTaggingScheduleActionSettings { } export namespace HlsId3SegmentTaggingScheduleActionSettings { + /** + * @internal + */ export const filterSensitiveLog = (obj: HlsId3SegmentTaggingScheduleActionSettings): any => ({ ...obj, }); @@ -443,6 +467,9 @@ export interface HlsTimedMetadataScheduleActionSettings { } export namespace HlsTimedMetadataScheduleActionSettings { + /** + * @internal + */ export const filterSensitiveLog = (obj: HlsTimedMetadataScheduleActionSettings): any => ({ ...obj, }); @@ -464,6 +491,9 @@ export interface StartTimecode { } export namespace StartTimecode { + /** + * @internal + */ export const filterSensitiveLog = (obj: StartTimecode): any => ({ ...obj, }); @@ -490,6 +520,9 @@ export interface StopTimecode { } export namespace StopTimecode { + /** + * @internal + */ export const filterSensitiveLog = (obj: StopTimecode): any => ({ ...obj, }); @@ -516,6 +549,9 @@ export interface InputClippingSettings { } export namespace InputClippingSettings { + /** + * @internal + */ export const filterSensitiveLog = (obj: InputClippingSettings): any => ({ ...obj, }); @@ -542,6 +578,9 @@ export interface InputPrepareScheduleActionSettings { } export namespace InputPrepareScheduleActionSettings { + /** + * @internal + */ export const filterSensitiveLog = (obj: InputPrepareScheduleActionSettings): any => ({ ...obj, }); @@ -568,6 +607,9 @@ export interface InputSwitchScheduleActionSettings { } export namespace InputSwitchScheduleActionSettings { + /** + * @internal + */ export const filterSensitiveLog = (obj: InputSwitchScheduleActionSettings): any => ({ ...obj, }); @@ -599,6 +641,9 @@ export interface MotionGraphicsActivateScheduleActionSettings { } export namespace MotionGraphicsActivateScheduleActionSettings { + /** + * @internal + */ export const filterSensitiveLog = (obj: MotionGraphicsActivateScheduleActionSettings): any => ({ ...obj, }); @@ -610,6 +655,9 @@ export namespace MotionGraphicsActivateScheduleActionSettings { export interface MotionGraphicsDeactivateScheduleActionSettings {} export namespace MotionGraphicsDeactivateScheduleActionSettings { + /** + * @internal + */ export const filterSensitiveLog = (obj: MotionGraphicsDeactivateScheduleActionSettings): any => ({ ...obj, }); @@ -626,6 +674,9 @@ export interface PauseStateScheduleActionSettings { } export namespace PauseStateScheduleActionSettings { + /** + * @internal + */ export const filterSensitiveLog = (obj: PauseStateScheduleActionSettings): any => ({ ...obj, }); @@ -642,6 +693,9 @@ export interface Scte35ReturnToNetworkScheduleActionSettings { } export namespace Scte35ReturnToNetworkScheduleActionSettings { + /** + * @internal + */ export const filterSensitiveLog = (obj: Scte35ReturnToNetworkScheduleActionSettings): any => ({ ...obj, }); @@ -663,6 +717,9 @@ export interface Scte35SpliceInsertScheduleActionSettings { } export namespace Scte35SpliceInsertScheduleActionSettings { + /** + * @internal + */ export const filterSensitiveLog = (obj: Scte35SpliceInsertScheduleActionSettings): any => ({ ...obj, }); @@ -716,6 +773,9 @@ export interface Scte35DeliveryRestrictions { } export namespace Scte35DeliveryRestrictions { + /** + * @internal + */ export const filterSensitiveLog = (obj: Scte35DeliveryRestrictions): any => ({ ...obj, }); @@ -787,6 +847,9 @@ export interface Scte35SegmentationDescriptor { } export namespace Scte35SegmentationDescriptor { + /** + * @internal + */ export const filterSensitiveLog = (obj: Scte35SegmentationDescriptor): any => ({ ...obj, }); @@ -803,6 +866,9 @@ export interface Scte35DescriptorSettings { } export namespace Scte35DescriptorSettings { + /** + * @internal + */ export const filterSensitiveLog = (obj: Scte35DescriptorSettings): any => ({ ...obj, }); @@ -819,6 +885,9 @@ export interface Scte35Descriptor { } export namespace Scte35Descriptor { + /** + * @internal + */ export const filterSensitiveLog = (obj: Scte35Descriptor): any => ({ ...obj, }); @@ -835,6 +904,9 @@ export interface Scte35TimeSignalScheduleActionSettings { } export namespace Scte35TimeSignalScheduleActionSettings { + /** + * @internal + */ export const filterSensitiveLog = (obj: Scte35TimeSignalScheduleActionSettings): any => ({ ...obj, }); @@ -896,6 +968,9 @@ export interface StaticImageActivateScheduleActionSettings { } export namespace StaticImageActivateScheduleActionSettings { + /** + * @internal + */ export const filterSensitiveLog = (obj: StaticImageActivateScheduleActionSettings): any => ({ ...obj, }); @@ -917,6 +992,9 @@ export interface StaticImageDeactivateScheduleActionSettings { } export namespace StaticImageDeactivateScheduleActionSettings { + /** + * @internal + */ export const filterSensitiveLog = (obj: StaticImageDeactivateScheduleActionSettings): any => ({ ...obj, }); @@ -988,6 +1066,9 @@ export interface ScheduleActionSettings { } export namespace ScheduleActionSettings { + /** + * @internal + */ export const filterSensitiveLog = (obj: ScheduleActionSettings): any => ({ ...obj, }); @@ -1004,6 +1085,9 @@ export interface FixedModeScheduleActionStartSettings { } export namespace FixedModeScheduleActionStartSettings { + /** + * @internal + */ export const filterSensitiveLog = (obj: FixedModeScheduleActionStartSettings): any => ({ ...obj, }); @@ -1030,6 +1114,9 @@ export interface FollowModeScheduleActionStartSettings { } export namespace FollowModeScheduleActionStartSettings { + /** + * @internal + */ export const filterSensitiveLog = (obj: FollowModeScheduleActionStartSettings): any => ({ ...obj, }); @@ -1041,6 +1128,9 @@ export namespace FollowModeScheduleActionStartSettings { export interface ImmediateModeScheduleActionStartSettings {} export namespace ImmediateModeScheduleActionStartSettings { + /** + * @internal + */ export const filterSensitiveLog = (obj: ImmediateModeScheduleActionStartSettings): any => ({ ...obj, }); @@ -1067,6 +1157,9 @@ export interface ScheduleActionStartSettings { } export namespace ScheduleActionStartSettings { + /** + * @internal + */ export const filterSensitiveLog = (obj: ScheduleActionStartSettings): any => ({ ...obj, }); @@ -1093,6 +1186,9 @@ export interface ScheduleAction { } export namespace ScheduleAction { + /** + * @internal + */ export const filterSensitiveLog = (obj: ScheduleAction): any => ({ ...obj, }); @@ -1129,6 +1225,9 @@ export interface TransferringInputDeviceSummary { } export namespace TransferringInputDeviceSummary { + /** + * @internal + */ export const filterSensitiveLog = (obj: TransferringInputDeviceSummary): any => ({ ...obj, }); @@ -1150,6 +1249,9 @@ export interface ValidationError { } export namespace ValidationError { + /** + * @internal + */ export const filterSensitiveLog = (obj: ValidationError): any => ({ ...obj, }); @@ -1176,6 +1278,9 @@ export interface FrameCaptureSettings { } export namespace FrameCaptureSettings { + /** + * @internal + */ export const filterSensitiveLog = (obj: FrameCaptureSettings): any => ({ ...obj, }); @@ -1207,6 +1312,9 @@ export enum H264ColorMetadata { export interface ColorSpacePassthroughSettings {} export namespace ColorSpacePassthroughSettings { + /** + * @internal + */ export const filterSensitiveLog = (obj: ColorSpacePassthroughSettings): any => ({ ...obj, }); @@ -1218,6 +1326,9 @@ export namespace ColorSpacePassthroughSettings { export interface Rec601Settings {} export namespace Rec601Settings { + /** + * @internal + */ export const filterSensitiveLog = (obj: Rec601Settings): any => ({ ...obj, }); @@ -1229,6 +1340,9 @@ export namespace Rec601Settings { export interface Rec709Settings {} export namespace Rec709Settings { + /** + * @internal + */ export const filterSensitiveLog = (obj: Rec709Settings): any => ({ ...obj, }); @@ -1255,6 +1369,9 @@ export interface H264ColorSpaceSettings { } export namespace H264ColorSpaceSettings { + /** + * @internal + */ export const filterSensitiveLog = (obj: H264ColorSpaceSettings): any => ({ ...obj, }); @@ -1309,6 +1426,9 @@ export interface TemporalFilterSettings { } export namespace TemporalFilterSettings { + /** + * @internal + */ export const filterSensitiveLog = (obj: TemporalFilterSettings): any => ({ ...obj, }); @@ -1325,6 +1445,9 @@ export interface H264FilterSettings { } export namespace H264FilterSettings { + /** + * @internal + */ export const filterSensitiveLog = (obj: H264FilterSettings): any => ({ ...obj, }); @@ -1697,6 +1820,9 @@ export interface H264Settings { } export namespace H264Settings { + /** + * @internal + */ export const filterSensitiveLog = (obj: H264Settings): any => ({ ...obj, }); @@ -1747,6 +1873,9 @@ export interface H265ColorSpaceSettings { } export namespace H265ColorSpaceSettings { + /** + * @internal + */ export const filterSensitiveLog = (obj: H265ColorSpaceSettings): any => ({ ...obj, }); @@ -1763,6 +1892,9 @@ export interface H265FilterSettings { } export namespace H265FilterSettings { + /** + * @internal + */ export const filterSensitiveLog = (obj: H265FilterSettings): any => ({ ...obj, }); @@ -2001,6 +2133,9 @@ export interface H265Settings { } export namespace H265Settings { + /** + * @internal + */ export const filterSensitiveLog = (obj: H265Settings): any => ({ ...obj, }); @@ -2040,6 +2175,9 @@ export interface Mpeg2FilterSettings { } export namespace Mpeg2FilterSettings { + /** + * @internal + */ export const filterSensitiveLog = (obj: Mpeg2FilterSettings): any => ({ ...obj, }); @@ -2164,6 +2302,9 @@ export interface Mpeg2Settings { } export namespace Mpeg2Settings { + /** + * @internal + */ export const filterSensitiveLog = (obj: Mpeg2Settings): any => ({ ...obj, }); @@ -2195,6 +2336,9 @@ export interface VideoCodecSettings { } export namespace VideoCodecSettings { + /** + * @internal + */ export const filterSensitiveLog = (obj: VideoCodecSettings): any => ({ ...obj, }); @@ -2255,6 +2399,9 @@ export interface VideoDescription { } export namespace VideoDescription { + /** + * @internal + */ export const filterSensitiveLog = (obj: VideoDescription): any => ({ ...obj, }); @@ -2275,6 +2422,9 @@ export interface AcceptInputDeviceTransferRequest { } export namespace AcceptInputDeviceTransferRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: AcceptInputDeviceTransferRequest): any => ({ ...obj, }); @@ -2286,6 +2436,9 @@ export namespace AcceptInputDeviceTransferRequest { export interface AcceptInputDeviceTransferResponse {} export namespace AcceptInputDeviceTransferResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: AcceptInputDeviceTransferResponse): any => ({ ...obj, }); @@ -2304,6 +2457,9 @@ export interface BadGatewayException extends __SmithyException, $MetadataBearer } export namespace BadGatewayException { + /** + * @internal + */ export const filterSensitiveLog = (obj: BadGatewayException): any => ({ ...obj, }); @@ -2322,6 +2478,9 @@ export interface BadRequestException extends __SmithyException, $MetadataBearer } export namespace BadRequestException { + /** + * @internal + */ export const filterSensitiveLog = (obj: BadRequestException): any => ({ ...obj, }); @@ -2340,6 +2499,9 @@ export interface ConflictException extends __SmithyException, $MetadataBearer { } export namespace ConflictException { + /** + * @internal + */ export const filterSensitiveLog = (obj: ConflictException): any => ({ ...obj, }); @@ -2358,6 +2520,9 @@ export interface ForbiddenException extends __SmithyException, $MetadataBearer { } export namespace ForbiddenException { + /** + * @internal + */ export const filterSensitiveLog = (obj: ForbiddenException): any => ({ ...obj, }); @@ -2376,6 +2541,9 @@ export interface GatewayTimeoutException extends __SmithyException, $MetadataBea } export namespace GatewayTimeoutException { + /** + * @internal + */ export const filterSensitiveLog = (obj: GatewayTimeoutException): any => ({ ...obj, }); @@ -2394,6 +2562,9 @@ export interface InternalServerErrorException extends __SmithyException, $Metada } export namespace InternalServerErrorException { + /** + * @internal + */ export const filterSensitiveLog = (obj: InternalServerErrorException): any => ({ ...obj, }); @@ -2412,6 +2583,9 @@ export interface NotFoundException extends __SmithyException, $MetadataBearer { } export namespace NotFoundException { + /** + * @internal + */ export const filterSensitiveLog = (obj: NotFoundException): any => ({ ...obj, }); @@ -2430,6 +2604,9 @@ export interface TooManyRequestsException extends __SmithyException, $MetadataBe } export namespace TooManyRequestsException { + /** + * @internal + */ export const filterSensitiveLog = (obj: TooManyRequestsException): any => ({ ...obj, }); @@ -2453,6 +2630,9 @@ export interface UnprocessableEntityException extends __SmithyException, $Metada } export namespace UnprocessableEntityException { + /** + * @internal + */ export const filterSensitiveLog = (obj: UnprocessableEntityException): any => ({ ...obj, }); @@ -2479,6 +2659,9 @@ export interface AvailBlanking { } export namespace AvailBlanking { + /** + * @internal + */ export const filterSensitiveLog = (obj: AvailBlanking): any => ({ ...obj, }); @@ -2515,6 +2698,9 @@ export interface Scte35SpliceInsert { } export namespace Scte35SpliceInsert { + /** + * @internal + */ export const filterSensitiveLog = (obj: Scte35SpliceInsert): any => ({ ...obj, }); @@ -2551,6 +2737,9 @@ export interface Scte35TimeSignalApos { } export namespace Scte35TimeSignalApos { + /** + * @internal + */ export const filterSensitiveLog = (obj: Scte35TimeSignalApos): any => ({ ...obj, }); @@ -2572,6 +2761,9 @@ export interface AvailSettings { } export namespace AvailSettings { + /** + * @internal + */ export const filterSensitiveLog = (obj: AvailSettings): any => ({ ...obj, }); @@ -2588,6 +2780,9 @@ export interface AvailConfiguration { } export namespace AvailConfiguration { + /** + * @internal + */ export const filterSensitiveLog = (obj: AvailConfiguration): any => ({ ...obj, }); @@ -2619,6 +2814,9 @@ export interface BatchDeleteRequest { } export namespace BatchDeleteRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: BatchDeleteRequest): any => ({ ...obj, }); @@ -2640,6 +2838,9 @@ export interface BatchDeleteResponse { } export namespace BatchDeleteResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: BatchDeleteResponse): any => ({ ...obj, }); @@ -2656,6 +2857,9 @@ export interface BatchScheduleActionCreateRequest { } export namespace BatchScheduleActionCreateRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: BatchScheduleActionCreateRequest): any => ({ ...obj, }); @@ -2672,6 +2876,9 @@ export interface BatchScheduleActionCreateResult { } export namespace BatchScheduleActionCreateResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: BatchScheduleActionCreateResult): any => ({ ...obj, }); @@ -2688,6 +2895,9 @@ export interface BatchScheduleActionDeleteRequest { } export namespace BatchScheduleActionDeleteRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: BatchScheduleActionDeleteRequest): any => ({ ...obj, }); @@ -2704,6 +2914,9 @@ export interface BatchScheduleActionDeleteResult { } export namespace BatchScheduleActionDeleteResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: BatchScheduleActionDeleteResult): any => ({ ...obj, }); @@ -2725,6 +2938,9 @@ export interface BatchStartRequest { } export namespace BatchStartRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: BatchStartRequest): any => ({ ...obj, }); @@ -2746,6 +2962,9 @@ export interface BatchStartResponse { } export namespace BatchStartResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: BatchStartResponse): any => ({ ...obj, }); @@ -2767,6 +2986,9 @@ export interface BatchStopRequest { } export namespace BatchStopRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: BatchStopRequest): any => ({ ...obj, }); @@ -2788,6 +3010,9 @@ export interface BatchStopResponse { } export namespace BatchStopResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: BatchStopResponse): any => ({ ...obj, }); @@ -2814,6 +3039,9 @@ export interface BatchUpdateScheduleRequest { } export namespace BatchUpdateScheduleRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: BatchUpdateScheduleRequest): any => ({ ...obj, }); @@ -2835,6 +3063,9 @@ export interface BatchUpdateScheduleResponse { } export namespace BatchUpdateScheduleResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: BatchUpdateScheduleResponse): any => ({ ...obj, }); @@ -2881,6 +3112,9 @@ export interface BlackoutSlate { } export namespace BlackoutSlate { + /** + * @internal + */ export const filterSensitiveLog = (obj: BlackoutSlate): any => ({ ...obj, }); @@ -2897,6 +3131,9 @@ export interface CancelInputDeviceTransferRequest { } export namespace CancelInputDeviceTransferRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: CancelInputDeviceTransferRequest): any => ({ ...obj, }); @@ -2908,6 +3145,9 @@ export namespace CancelInputDeviceTransferRequest { export interface CancelInputDeviceTransferResponse {} export namespace CancelInputDeviceTransferResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: CancelInputDeviceTransferResponse): any => ({ ...obj, }); @@ -2930,6 +3170,9 @@ export interface FeatureActivations { } export namespace FeatureActivations { + /** + * @internal + */ export const filterSensitiveLog = (obj: FeatureActivations): any => ({ ...obj, }); @@ -2976,6 +3219,9 @@ export interface InputLossBehavior { } export namespace InputLossBehavior { + /** + * @internal + */ export const filterSensitiveLog = (obj: InputLossBehavior): any => ({ ...obj, }); @@ -3035,6 +3281,9 @@ export interface GlobalConfiguration { } export namespace GlobalConfiguration { + /** + * @internal + */ export const filterSensitiveLog = (obj: GlobalConfiguration): any => ({ ...obj, }); @@ -3051,6 +3300,9 @@ export enum MotionGraphicsInsertion { export interface HtmlMotionGraphicsSettings {} export namespace HtmlMotionGraphicsSettings { + /** + * @internal + */ export const filterSensitiveLog = (obj: HtmlMotionGraphicsSettings): any => ({ ...obj, }); @@ -3067,6 +3319,9 @@ export interface MotionGraphicsSettings { } export namespace MotionGraphicsSettings { + /** + * @internal + */ export const filterSensitiveLog = (obj: MotionGraphicsSettings): any => ({ ...obj, }); @@ -3088,6 +3343,9 @@ export interface MotionGraphicsConfiguration { } export namespace MotionGraphicsConfiguration { + /** + * @internal + */ export const filterSensitiveLog = (obj: MotionGraphicsConfiguration): any => ({ ...obj, }); @@ -3114,6 +3372,9 @@ export interface NielsenConfiguration { } export namespace NielsenConfiguration { + /** + * @internal + */ export const filterSensitiveLog = (obj: NielsenConfiguration): any => ({ ...obj, }); @@ -3144,6 +3405,9 @@ export interface TimecodeConfig { } export namespace TimecodeConfig { + /** + * @internal + */ export const filterSensitiveLog = (obj: TimecodeConfig): any => ({ ...obj, }); @@ -3215,6 +3479,9 @@ export interface EncoderSettings { } export namespace EncoderSettings { + /** + * @internal + */ export const filterSensitiveLog = (obj: EncoderSettings): any => ({ ...obj, }); @@ -3313,6 +3580,9 @@ export interface Channel { } export namespace Channel { + /** + * @internal + */ export const filterSensitiveLog = (obj: Channel): any => ({ ...obj, }); @@ -3347,6 +3617,9 @@ export interface VpcOutputSettings { } export namespace VpcOutputSettings { + /** + * @internal + */ export const filterSensitiveLog = (obj: VpcOutputSettings): any => ({ ...obj, }); @@ -3426,6 +3699,9 @@ export interface CreateChannelRequest { } export namespace CreateChannelRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateChannelRequest): any => ({ ...obj, }); @@ -3442,6 +3718,9 @@ export interface CreateChannelResponse { } export namespace CreateChannelResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateChannelResponse): any => ({ ...obj, }); @@ -3468,6 +3747,9 @@ export interface InputVpcRequest { } export namespace InputVpcRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: InputVpcRequest): any => ({ ...obj, }); @@ -3542,6 +3824,9 @@ export interface CreateInputRequest { } export namespace CreateInputRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateInputRequest): any => ({ ...obj, }); @@ -3558,6 +3843,9 @@ export interface CreateInputResponse { } export namespace CreateInputResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateInputResponse): any => ({ ...obj, }); @@ -3579,6 +3867,9 @@ export interface CreateInputSecurityGroupRequest { } export namespace CreateInputSecurityGroupRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateInputSecurityGroupRequest): any => ({ ...obj, }); @@ -3595,6 +3886,9 @@ export interface CreateInputSecurityGroupResponse { } export namespace CreateInputSecurityGroupResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateInputSecurityGroupResponse): any => ({ ...obj, }); @@ -3626,6 +3920,9 @@ export interface MultiplexSettings { } export namespace MultiplexSettings { + /** + * @internal + */ export const filterSensitiveLog = (obj: MultiplexSettings): any => ({ ...obj, }); @@ -3663,6 +3960,9 @@ export interface CreateMultiplexRequest { } export namespace CreateMultiplexRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateMultiplexRequest): any => ({ ...obj, }); @@ -3724,6 +4024,9 @@ export interface Multiplex { } export namespace Multiplex { + /** + * @internal + */ export const filterSensitiveLog = (obj: Multiplex): any => ({ ...obj, }); @@ -3740,6 +4043,9 @@ export interface CreateMultiplexResponse { } export namespace CreateMultiplexResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateMultiplexResponse): any => ({ ...obj, }); @@ -3767,6 +4073,9 @@ export interface MultiplexProgramServiceDescriptor { } export namespace MultiplexProgramServiceDescriptor { + /** + * @internal + */ export const filterSensitiveLog = (obj: MultiplexProgramServiceDescriptor): any => ({ ...obj, }); @@ -3793,6 +4102,9 @@ export interface MultiplexStatmuxVideoSettings { } export namespace MultiplexStatmuxVideoSettings { + /** + * @internal + */ export const filterSensitiveLog = (obj: MultiplexStatmuxVideoSettings): any => ({ ...obj, }); @@ -3816,6 +4128,9 @@ export interface MultiplexVideoSettings { } export namespace MultiplexVideoSettings { + /** + * @internal + */ export const filterSensitiveLog = (obj: MultiplexVideoSettings): any => ({ ...obj, }); @@ -3847,6 +4162,9 @@ export interface MultiplexProgramSettings { } export namespace MultiplexProgramSettings { + /** + * @internal + */ export const filterSensitiveLog = (obj: MultiplexProgramSettings): any => ({ ...obj, }); @@ -3879,6 +4197,9 @@ export interface CreateMultiplexProgramRequest { } export namespace CreateMultiplexProgramRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateMultiplexProgramRequest): any => ({ ...obj, }); @@ -3955,6 +4276,9 @@ export interface MultiplexProgramPacketIdentifiersMap { } export namespace MultiplexProgramPacketIdentifiersMap { + /** + * @internal + */ export const filterSensitiveLog = (obj: MultiplexProgramPacketIdentifiersMap): any => ({ ...obj, }); @@ -3991,6 +4315,9 @@ export interface MultiplexProgram { } export namespace MultiplexProgram { + /** + * @internal + */ export const filterSensitiveLog = (obj: MultiplexProgram): any => ({ ...obj, }); @@ -4007,6 +4334,9 @@ export interface CreateMultiplexProgramResponse { } export namespace CreateMultiplexProgramResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateMultiplexProgramResponse): any => ({ ...obj, }); @@ -4034,6 +4364,9 @@ export interface CreatePartnerInputRequest { } export namespace CreatePartnerInputRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreatePartnerInputRequest): any => ({ ...obj, }); @@ -4050,6 +4383,9 @@ export interface CreatePartnerInputResponse { } export namespace CreatePartnerInputResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreatePartnerInputResponse): any => ({ ...obj, }); @@ -4071,6 +4407,9 @@ export interface CreateTagsRequest { } export namespace CreateTagsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateTagsRequest): any => ({ ...obj, }); @@ -4087,6 +4426,9 @@ export interface DeleteChannelRequest { } export namespace DeleteChannelRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteChannelRequest): any => ({ ...obj, }); @@ -4185,6 +4527,9 @@ export interface DeleteChannelResponse { } export namespace DeleteChannelResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteChannelResponse): any => ({ ...obj, }); @@ -4201,6 +4546,9 @@ export interface DeleteInputRequest { } export namespace DeleteInputRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteInputRequest): any => ({ ...obj, }); @@ -4212,6 +4560,9 @@ export namespace DeleteInputRequest { export interface DeleteInputResponse {} export namespace DeleteInputResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteInputResponse): any => ({ ...obj, }); @@ -4228,6 +4579,9 @@ export interface DeleteInputSecurityGroupRequest { } export namespace DeleteInputSecurityGroupRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteInputSecurityGroupRequest): any => ({ ...obj, }); @@ -4239,6 +4593,9 @@ export namespace DeleteInputSecurityGroupRequest { export interface DeleteInputSecurityGroupResponse {} export namespace DeleteInputSecurityGroupResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteInputSecurityGroupResponse): any => ({ ...obj, }); @@ -4255,6 +4612,9 @@ export interface DeleteMultiplexRequest { } export namespace DeleteMultiplexRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteMultiplexRequest): any => ({ ...obj, }); @@ -4316,6 +4676,9 @@ export interface DeleteMultiplexResponse { } export namespace DeleteMultiplexResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteMultiplexResponse): any => ({ ...obj, }); @@ -4337,6 +4700,9 @@ export interface DeleteMultiplexProgramRequest { } export namespace DeleteMultiplexProgramRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteMultiplexProgramRequest): any => ({ ...obj, }); @@ -4373,6 +4739,9 @@ export interface DeleteMultiplexProgramResponse { } export namespace DeleteMultiplexProgramResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteMultiplexProgramResponse): any => ({ ...obj, }); @@ -4389,6 +4758,9 @@ export interface DeleteReservationRequest { } export namespace DeleteReservationRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteReservationRequest): any => ({ ...obj, }); @@ -4490,6 +4862,9 @@ export interface DeleteReservationResponse { } export namespace DeleteReservationResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteReservationResponse): any => ({ ...obj, }); @@ -4506,6 +4881,9 @@ export interface DeleteScheduleRequest { } export namespace DeleteScheduleRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteScheduleRequest): any => ({ ...obj, }); @@ -4517,6 +4895,9 @@ export namespace DeleteScheduleRequest { export interface DeleteScheduleResponse {} export namespace DeleteScheduleResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteScheduleResponse): any => ({ ...obj, }); @@ -4538,6 +4919,9 @@ export interface DeleteTagsRequest { } export namespace DeleteTagsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteTagsRequest): any => ({ ...obj, }); @@ -4554,6 +4938,9 @@ export interface DescribeChannelRequest { } export namespace DescribeChannelRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeChannelRequest): any => ({ ...obj, }); @@ -4652,6 +5039,9 @@ export interface DescribeChannelResponse { } export namespace DescribeChannelResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeChannelResponse): any => ({ ...obj, }); @@ -4668,6 +5058,9 @@ export interface DescribeInputRequest { } export namespace DescribeInputRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeInputRequest): any => ({ ...obj, }); @@ -4761,6 +5154,9 @@ export interface DescribeInputResponse { } export namespace DescribeInputResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeInputResponse): any => ({ ...obj, }); @@ -4777,6 +5173,9 @@ export interface DescribeInputDeviceRequest { } export namespace DescribeInputDeviceRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeInputDeviceRequest): any => ({ ...obj, }); @@ -4848,6 +5247,9 @@ export interface DescribeInputDeviceResponse { } export namespace DescribeInputDeviceResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeInputDeviceResponse): any => ({ ...obj, }); @@ -4869,6 +5271,9 @@ export interface DescribeInputDeviceThumbnailRequest { } export namespace DescribeInputDeviceThumbnailRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeInputDeviceThumbnailRequest): any => ({ ...obj, }); @@ -4905,6 +5310,9 @@ export interface DescribeInputDeviceThumbnailResponse { } export namespace DescribeInputDeviceThumbnailResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeInputDeviceThumbnailResponse): any => ({ ...obj, }); @@ -4921,6 +5329,9 @@ export interface DescribeInputSecurityGroupRequest { } export namespace DescribeInputSecurityGroupRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeInputSecurityGroupRequest): any => ({ ...obj, }); @@ -4962,6 +5373,9 @@ export interface DescribeInputSecurityGroupResponse { } export namespace DescribeInputSecurityGroupResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeInputSecurityGroupResponse): any => ({ ...obj, }); @@ -4978,6 +5392,9 @@ export interface DescribeMultiplexRequest { } export namespace DescribeMultiplexRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeMultiplexRequest): any => ({ ...obj, }); @@ -5039,6 +5456,9 @@ export interface DescribeMultiplexResponse { } export namespace DescribeMultiplexResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeMultiplexResponse): any => ({ ...obj, }); @@ -5060,6 +5480,9 @@ export interface DescribeMultiplexProgramRequest { } export namespace DescribeMultiplexProgramRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeMultiplexProgramRequest): any => ({ ...obj, }); @@ -5096,6 +5519,9 @@ export interface DescribeMultiplexProgramResponse { } export namespace DescribeMultiplexProgramResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeMultiplexProgramResponse): any => ({ ...obj, }); @@ -5112,6 +5538,9 @@ export interface DescribeOfferingRequest { } export namespace DescribeOfferingRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeOfferingRequest): any => ({ ...obj, }); @@ -5178,6 +5607,9 @@ export interface DescribeOfferingResponse { } export namespace DescribeOfferingResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeOfferingResponse): any => ({ ...obj, }); @@ -5194,6 +5626,9 @@ export interface DescribeReservationRequest { } export namespace DescribeReservationRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeReservationRequest): any => ({ ...obj, }); @@ -5295,6 +5730,9 @@ export interface DescribeReservationResponse { } export namespace DescribeReservationResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeReservationResponse): any => ({ ...obj, }); @@ -5321,6 +5759,9 @@ export interface DescribeScheduleRequest { } export namespace DescribeScheduleRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeScheduleRequest): any => ({ ...obj, }); @@ -5342,6 +5783,9 @@ export interface DescribeScheduleResponse { } export namespace DescribeScheduleResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeScheduleResponse): any => ({ ...obj, }); @@ -5363,6 +5807,9 @@ export interface InputDeviceConfigurableSettings { } export namespace InputDeviceConfigurableSettings { + /** + * @internal + */ export const filterSensitiveLog = (obj: InputDeviceConfigurableSettings): any => ({ ...obj, }); @@ -5384,6 +5831,9 @@ export interface ListChannelsRequest { } export namespace ListChannelsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListChannelsRequest): any => ({ ...obj, }); @@ -5405,6 +5855,9 @@ export interface ListChannelsResponse { } export namespace ListChannelsResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListChannelsResponse): any => ({ ...obj, }); @@ -5426,6 +5879,9 @@ export interface ListInputDevicesRequest { } export namespace ListInputDevicesRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListInputDevicesRequest): any => ({ ...obj, }); @@ -5447,6 +5903,9 @@ export interface ListInputDevicesResponse { } export namespace ListInputDevicesResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListInputDevicesResponse): any => ({ ...obj, }); @@ -5473,6 +5932,9 @@ export interface ListInputDeviceTransfersRequest { } export namespace ListInputDeviceTransfersRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListInputDeviceTransfersRequest): any => ({ ...obj, }); @@ -5494,6 +5956,9 @@ export interface ListInputDeviceTransfersResponse { } export namespace ListInputDeviceTransfersResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListInputDeviceTransfersResponse): any => ({ ...obj, }); @@ -5515,6 +5980,9 @@ export interface ListInputsRequest { } export namespace ListInputsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListInputsRequest): any => ({ ...obj, }); @@ -5536,6 +6004,9 @@ export interface ListInputsResponse { } export namespace ListInputsResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListInputsResponse): any => ({ ...obj, }); @@ -5557,6 +6028,9 @@ export interface ListInputSecurityGroupsRequest { } export namespace ListInputSecurityGroupsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListInputSecurityGroupsRequest): any => ({ ...obj, }); @@ -5578,6 +6052,9 @@ export interface ListInputSecurityGroupsResponse { } export namespace ListInputSecurityGroupsResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListInputSecurityGroupsResponse): any => ({ ...obj, }); @@ -5599,6 +6076,9 @@ export interface ListMultiplexesRequest { } export namespace ListMultiplexesRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListMultiplexesRequest): any => ({ ...obj, }); @@ -5620,6 +6100,9 @@ export interface ListMultiplexesResponse { } export namespace ListMultiplexesResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListMultiplexesResponse): any => ({ ...obj, }); @@ -5646,6 +6129,9 @@ export interface ListMultiplexProgramsRequest { } export namespace ListMultiplexProgramsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListMultiplexProgramsRequest): any => ({ ...obj, }); @@ -5667,6 +6153,9 @@ export interface ListMultiplexProgramsResponse { } export namespace ListMultiplexProgramsResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListMultiplexProgramsResponse): any => ({ ...obj, }); @@ -5738,6 +6227,9 @@ export interface ListOfferingsRequest { } export namespace ListOfferingsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListOfferingsRequest): any => ({ ...obj, }); @@ -5759,6 +6251,9 @@ export interface ListOfferingsResponse { } export namespace ListOfferingsResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListOfferingsResponse): any => ({ ...obj, }); @@ -5820,6 +6315,9 @@ export interface ListReservationsRequest { } export namespace ListReservationsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListReservationsRequest): any => ({ ...obj, }); @@ -5841,6 +6339,9 @@ export interface ListReservationsResponse { } export namespace ListReservationsResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListReservationsResponse): any => ({ ...obj, }); @@ -5857,6 +6358,9 @@ export interface ListTagsForResourceRequest { } export namespace ListTagsForResourceRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListTagsForResourceRequest): any => ({ ...obj, }); @@ -5873,6 +6377,9 @@ export interface ListTagsForResourceResponse { } export namespace ListTagsForResourceResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListTagsForResourceResponse): any => ({ ...obj, }); @@ -5914,6 +6421,9 @@ export interface PurchaseOfferingRequest { } export namespace PurchaseOfferingRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: PurchaseOfferingRequest): any => ({ ...obj, }); @@ -5930,6 +6440,9 @@ export interface PurchaseOfferingResponse { } export namespace PurchaseOfferingResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: PurchaseOfferingResponse): any => ({ ...obj, }); @@ -5946,6 +6459,9 @@ export interface RejectInputDeviceTransferRequest { } export namespace RejectInputDeviceTransferRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: RejectInputDeviceTransferRequest): any => ({ ...obj, }); @@ -5957,6 +6473,9 @@ export namespace RejectInputDeviceTransferRequest { export interface RejectInputDeviceTransferResponse {} export namespace RejectInputDeviceTransferResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: RejectInputDeviceTransferResponse): any => ({ ...obj, }); @@ -5973,6 +6492,9 @@ export interface StartChannelRequest { } export namespace StartChannelRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: StartChannelRequest): any => ({ ...obj, }); @@ -6071,6 +6593,9 @@ export interface StartChannelResponse { } export namespace StartChannelResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: StartChannelResponse): any => ({ ...obj, }); @@ -6087,6 +6612,9 @@ export interface StartMultiplexRequest { } export namespace StartMultiplexRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: StartMultiplexRequest): any => ({ ...obj, }); @@ -6148,6 +6676,9 @@ export interface StartMultiplexResponse { } export namespace StartMultiplexResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: StartMultiplexResponse): any => ({ ...obj, }); @@ -6164,6 +6695,9 @@ export interface StopChannelRequest { } export namespace StopChannelRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: StopChannelRequest): any => ({ ...obj, }); @@ -6262,6 +6796,9 @@ export interface StopChannelResponse { } export namespace StopChannelResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: StopChannelResponse): any => ({ ...obj, }); @@ -6278,6 +6815,9 @@ export interface StopMultiplexRequest { } export namespace StopMultiplexRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: StopMultiplexRequest): any => ({ ...obj, }); @@ -6339,6 +6879,9 @@ export interface StopMultiplexResponse { } export namespace StopMultiplexResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: StopMultiplexResponse): any => ({ ...obj, }); @@ -6370,6 +6913,9 @@ export interface TransferInputDeviceRequest { } export namespace TransferInputDeviceRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: TransferInputDeviceRequest): any => ({ ...obj, }); @@ -6381,6 +6927,9 @@ export namespace TransferInputDeviceRequest { export interface TransferInputDeviceResponse {} export namespace TransferInputDeviceResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: TransferInputDeviceResponse): any => ({ ...obj, }); @@ -6437,6 +6986,9 @@ export interface UpdateChannelRequest { } export namespace UpdateChannelRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateChannelRequest): any => ({ ...obj, }); @@ -6453,6 +7005,9 @@ export interface UpdateChannelResponse { } export namespace UpdateChannelResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateChannelResponse): any => ({ ...obj, }); @@ -6479,6 +7034,9 @@ export interface UpdateChannelClassRequest { } export namespace UpdateChannelClassRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateChannelClassRequest): any => ({ ...obj, }); @@ -6495,6 +7053,9 @@ export interface UpdateChannelClassResponse { } export namespace UpdateChannelClassResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateChannelClassResponse): any => ({ ...obj, }); @@ -6550,6 +7111,9 @@ export interface UpdateInputRequest { } export namespace UpdateInputRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateInputRequest): any => ({ ...obj, }); @@ -6566,6 +7130,9 @@ export interface UpdateInputResponse { } export namespace UpdateInputResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateInputResponse): any => ({ ...obj, }); @@ -6597,6 +7164,9 @@ export interface UpdateInputDeviceRequest { } export namespace UpdateInputDeviceRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateInputDeviceRequest): any => ({ ...obj, }); @@ -6668,6 +7238,9 @@ export interface UpdateInputDeviceResponse { } export namespace UpdateInputDeviceResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateInputDeviceResponse): any => ({ ...obj, }); @@ -6694,6 +7267,9 @@ export interface UpdateInputSecurityGroupRequest { } export namespace UpdateInputSecurityGroupRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateInputSecurityGroupRequest): any => ({ ...obj, }); @@ -6710,6 +7286,9 @@ export interface UpdateInputSecurityGroupResponse { } export namespace UpdateInputSecurityGroupResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateInputSecurityGroupResponse): any => ({ ...obj, }); @@ -6736,6 +7315,9 @@ export interface UpdateMultiplexRequest { } export namespace UpdateMultiplexRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateMultiplexRequest): any => ({ ...obj, }); @@ -6752,6 +7334,9 @@ export interface UpdateMultiplexResponse { } export namespace UpdateMultiplexResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateMultiplexResponse): any => ({ ...obj, }); @@ -6778,6 +7363,9 @@ export interface UpdateMultiplexProgramRequest { } export namespace UpdateMultiplexProgramRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateMultiplexProgramRequest): any => ({ ...obj, }); @@ -6794,6 +7382,9 @@ export interface UpdateMultiplexProgramResponse { } export namespace UpdateMultiplexProgramResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateMultiplexProgramResponse): any => ({ ...obj, }); @@ -6815,6 +7406,9 @@ export interface UpdateReservationRequest { } export namespace UpdateReservationRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateReservationRequest): any => ({ ...obj, }); @@ -6831,6 +7425,9 @@ export interface UpdateReservationResponse { } export namespace UpdateReservationResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateReservationResponse): any => ({ ...obj, }); diff --git a/clients/client-mediapackage-vod/commands/ConfigureLogsCommand.ts b/clients/client-mediapackage-vod/commands/ConfigureLogsCommand.ts index d8be0aab2936..8d7a3a0ebdff 100644 --- a/clients/client-mediapackage-vod/commands/ConfigureLogsCommand.ts +++ b/clients/client-mediapackage-vod/commands/ConfigureLogsCommand.ts @@ -22,6 +22,20 @@ export interface ConfigureLogsCommandOutput extends ConfigureLogsResponse, __Met /** * Changes the packaging group's properities to configure log subscription + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { MediaPackageVodClient, ConfigureLogsCommand } from "@aws-sdk/client-mediapackage-vod"; // ES Modules import + * // const { MediaPackageVodClient, ConfigureLogsCommand } = require("@aws-sdk/client-mediapackage-vod"); // CommonJS import + * const client = new MediaPackageVodClient(config); + * const command = new ConfigureLogsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ConfigureLogsCommandInput} for command's `input` shape. + * @see {@link ConfigureLogsCommandOutput} for command's `response` shape. + * @see {@link MediaPackageVodClientResolvedConfig | config} for command's `input` shape. + * */ export class ConfigureLogsCommand extends $Command< ConfigureLogsCommandInput, diff --git a/clients/client-mediapackage-vod/commands/CreateAssetCommand.ts b/clients/client-mediapackage-vod/commands/CreateAssetCommand.ts index b85fb301a84b..1c943e4a6d37 100644 --- a/clients/client-mediapackage-vod/commands/CreateAssetCommand.ts +++ b/clients/client-mediapackage-vod/commands/CreateAssetCommand.ts @@ -22,6 +22,20 @@ export interface CreateAssetCommandOutput extends CreateAssetResponse, __Metadat /** * Creates a new MediaPackage VOD Asset resource. + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { MediaPackageVodClient, CreateAssetCommand } from "@aws-sdk/client-mediapackage-vod"; // ES Modules import + * // const { MediaPackageVodClient, CreateAssetCommand } = require("@aws-sdk/client-mediapackage-vod"); // CommonJS import + * const client = new MediaPackageVodClient(config); + * const command = new CreateAssetCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreateAssetCommandInput} for command's `input` shape. + * @see {@link CreateAssetCommandOutput} for command's `response` shape. + * @see {@link MediaPackageVodClientResolvedConfig | config} for command's `input` shape. + * */ export class CreateAssetCommand extends $Command< CreateAssetCommandInput, diff --git a/clients/client-mediapackage-vod/commands/CreatePackagingConfigurationCommand.ts b/clients/client-mediapackage-vod/commands/CreatePackagingConfigurationCommand.ts index 27a41d76f81d..e6fe2c753873 100644 --- a/clients/client-mediapackage-vod/commands/CreatePackagingConfigurationCommand.ts +++ b/clients/client-mediapackage-vod/commands/CreatePackagingConfigurationCommand.ts @@ -24,6 +24,20 @@ export interface CreatePackagingConfigurationCommandOutput /** * Creates a new MediaPackage VOD PackagingConfiguration resource. + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { MediaPackageVodClient, CreatePackagingConfigurationCommand } from "@aws-sdk/client-mediapackage-vod"; // ES Modules import + * // const { MediaPackageVodClient, CreatePackagingConfigurationCommand } = require("@aws-sdk/client-mediapackage-vod"); // CommonJS import + * const client = new MediaPackageVodClient(config); + * const command = new CreatePackagingConfigurationCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreatePackagingConfigurationCommandInput} for command's `input` shape. + * @see {@link CreatePackagingConfigurationCommandOutput} for command's `response` shape. + * @see {@link MediaPackageVodClientResolvedConfig | config} for command's `input` shape. + * */ export class CreatePackagingConfigurationCommand extends $Command< CreatePackagingConfigurationCommandInput, diff --git a/clients/client-mediapackage-vod/commands/CreatePackagingGroupCommand.ts b/clients/client-mediapackage-vod/commands/CreatePackagingGroupCommand.ts index d0e9be5d8f22..6ea063bd4630 100644 --- a/clients/client-mediapackage-vod/commands/CreatePackagingGroupCommand.ts +++ b/clients/client-mediapackage-vod/commands/CreatePackagingGroupCommand.ts @@ -22,6 +22,20 @@ export interface CreatePackagingGroupCommandOutput extends CreatePackagingGroupR /** * Creates a new MediaPackage VOD PackagingGroup resource. + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { MediaPackageVodClient, CreatePackagingGroupCommand } from "@aws-sdk/client-mediapackage-vod"; // ES Modules import + * // const { MediaPackageVodClient, CreatePackagingGroupCommand } = require("@aws-sdk/client-mediapackage-vod"); // CommonJS import + * const client = new MediaPackageVodClient(config); + * const command = new CreatePackagingGroupCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreatePackagingGroupCommandInput} for command's `input` shape. + * @see {@link CreatePackagingGroupCommandOutput} for command's `response` shape. + * @see {@link MediaPackageVodClientResolvedConfig | config} for command's `input` shape. + * */ export class CreatePackagingGroupCommand extends $Command< CreatePackagingGroupCommandInput, diff --git a/clients/client-mediapackage-vod/commands/DeleteAssetCommand.ts b/clients/client-mediapackage-vod/commands/DeleteAssetCommand.ts index 0e2b67d5c5bc..7c990667ab7a 100644 --- a/clients/client-mediapackage-vod/commands/DeleteAssetCommand.ts +++ b/clients/client-mediapackage-vod/commands/DeleteAssetCommand.ts @@ -22,6 +22,20 @@ export interface DeleteAssetCommandOutput extends DeleteAssetResponse, __Metadat /** * Deletes an existing MediaPackage VOD Asset resource. + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { MediaPackageVodClient, DeleteAssetCommand } from "@aws-sdk/client-mediapackage-vod"; // ES Modules import + * // const { MediaPackageVodClient, DeleteAssetCommand } = require("@aws-sdk/client-mediapackage-vod"); // CommonJS import + * const client = new MediaPackageVodClient(config); + * const command = new DeleteAssetCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteAssetCommandInput} for command's `input` shape. + * @see {@link DeleteAssetCommandOutput} for command's `response` shape. + * @see {@link MediaPackageVodClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteAssetCommand extends $Command< DeleteAssetCommandInput, diff --git a/clients/client-mediapackage-vod/commands/DeletePackagingConfigurationCommand.ts b/clients/client-mediapackage-vod/commands/DeletePackagingConfigurationCommand.ts index 4b3816034bd1..6fd1412bb707 100644 --- a/clients/client-mediapackage-vod/commands/DeletePackagingConfigurationCommand.ts +++ b/clients/client-mediapackage-vod/commands/DeletePackagingConfigurationCommand.ts @@ -24,6 +24,20 @@ export interface DeletePackagingConfigurationCommandOutput /** * Deletes a MediaPackage VOD PackagingConfiguration resource. + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { MediaPackageVodClient, DeletePackagingConfigurationCommand } from "@aws-sdk/client-mediapackage-vod"; // ES Modules import + * // const { MediaPackageVodClient, DeletePackagingConfigurationCommand } = require("@aws-sdk/client-mediapackage-vod"); // CommonJS import + * const client = new MediaPackageVodClient(config); + * const command = new DeletePackagingConfigurationCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeletePackagingConfigurationCommandInput} for command's `input` shape. + * @see {@link DeletePackagingConfigurationCommandOutput} for command's `response` shape. + * @see {@link MediaPackageVodClientResolvedConfig | config} for command's `input` shape. + * */ export class DeletePackagingConfigurationCommand extends $Command< DeletePackagingConfigurationCommandInput, diff --git a/clients/client-mediapackage-vod/commands/DeletePackagingGroupCommand.ts b/clients/client-mediapackage-vod/commands/DeletePackagingGroupCommand.ts index a48fae88e9cc..c08311d1da2e 100644 --- a/clients/client-mediapackage-vod/commands/DeletePackagingGroupCommand.ts +++ b/clients/client-mediapackage-vod/commands/DeletePackagingGroupCommand.ts @@ -22,6 +22,20 @@ export interface DeletePackagingGroupCommandOutput extends DeletePackagingGroupR /** * Deletes a MediaPackage VOD PackagingGroup resource. + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { MediaPackageVodClient, DeletePackagingGroupCommand } from "@aws-sdk/client-mediapackage-vod"; // ES Modules import + * // const { MediaPackageVodClient, DeletePackagingGroupCommand } = require("@aws-sdk/client-mediapackage-vod"); // CommonJS import + * const client = new MediaPackageVodClient(config); + * const command = new DeletePackagingGroupCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeletePackagingGroupCommandInput} for command's `input` shape. + * @see {@link DeletePackagingGroupCommandOutput} for command's `response` shape. + * @see {@link MediaPackageVodClientResolvedConfig | config} for command's `input` shape. + * */ export class DeletePackagingGroupCommand extends $Command< DeletePackagingGroupCommandInput, diff --git a/clients/client-mediapackage-vod/commands/DescribeAssetCommand.ts b/clients/client-mediapackage-vod/commands/DescribeAssetCommand.ts index 2d9917eca319..aa2365f11660 100644 --- a/clients/client-mediapackage-vod/commands/DescribeAssetCommand.ts +++ b/clients/client-mediapackage-vod/commands/DescribeAssetCommand.ts @@ -22,6 +22,20 @@ export interface DescribeAssetCommandOutput extends DescribeAssetResponse, __Met /** * Returns a description of a MediaPackage VOD Asset resource. + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { MediaPackageVodClient, DescribeAssetCommand } from "@aws-sdk/client-mediapackage-vod"; // ES Modules import + * // const { MediaPackageVodClient, DescribeAssetCommand } = require("@aws-sdk/client-mediapackage-vod"); // CommonJS import + * const client = new MediaPackageVodClient(config); + * const command = new DescribeAssetCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeAssetCommandInput} for command's `input` shape. + * @see {@link DescribeAssetCommandOutput} for command's `response` shape. + * @see {@link MediaPackageVodClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeAssetCommand extends $Command< DescribeAssetCommandInput, diff --git a/clients/client-mediapackage-vod/commands/DescribePackagingConfigurationCommand.ts b/clients/client-mediapackage-vod/commands/DescribePackagingConfigurationCommand.ts index 7b0bca8ebeaf..1088e855b30a 100644 --- a/clients/client-mediapackage-vod/commands/DescribePackagingConfigurationCommand.ts +++ b/clients/client-mediapackage-vod/commands/DescribePackagingConfigurationCommand.ts @@ -24,6 +24,20 @@ export interface DescribePackagingConfigurationCommandOutput /** * Returns a description of a MediaPackage VOD PackagingConfiguration resource. + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { MediaPackageVodClient, DescribePackagingConfigurationCommand } from "@aws-sdk/client-mediapackage-vod"; // ES Modules import + * // const { MediaPackageVodClient, DescribePackagingConfigurationCommand } = require("@aws-sdk/client-mediapackage-vod"); // CommonJS import + * const client = new MediaPackageVodClient(config); + * const command = new DescribePackagingConfigurationCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribePackagingConfigurationCommandInput} for command's `input` shape. + * @see {@link DescribePackagingConfigurationCommandOutput} for command's `response` shape. + * @see {@link MediaPackageVodClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribePackagingConfigurationCommand extends $Command< DescribePackagingConfigurationCommandInput, diff --git a/clients/client-mediapackage-vod/commands/DescribePackagingGroupCommand.ts b/clients/client-mediapackage-vod/commands/DescribePackagingGroupCommand.ts index 531bb8f663b0..26fa58b12273 100644 --- a/clients/client-mediapackage-vod/commands/DescribePackagingGroupCommand.ts +++ b/clients/client-mediapackage-vod/commands/DescribePackagingGroupCommand.ts @@ -22,6 +22,20 @@ export interface DescribePackagingGroupCommandOutput extends DescribePackagingGr /** * Returns a description of a MediaPackage VOD PackagingGroup resource. + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { MediaPackageVodClient, DescribePackagingGroupCommand } from "@aws-sdk/client-mediapackage-vod"; // ES Modules import + * // const { MediaPackageVodClient, DescribePackagingGroupCommand } = require("@aws-sdk/client-mediapackage-vod"); // CommonJS import + * const client = new MediaPackageVodClient(config); + * const command = new DescribePackagingGroupCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribePackagingGroupCommandInput} for command's `input` shape. + * @see {@link DescribePackagingGroupCommandOutput} for command's `response` shape. + * @see {@link MediaPackageVodClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribePackagingGroupCommand extends $Command< DescribePackagingGroupCommandInput, diff --git a/clients/client-mediapackage-vod/commands/ListAssetsCommand.ts b/clients/client-mediapackage-vod/commands/ListAssetsCommand.ts index df5fcf2cf4b4..34c37f7b8cfd 100644 --- a/clients/client-mediapackage-vod/commands/ListAssetsCommand.ts +++ b/clients/client-mediapackage-vod/commands/ListAssetsCommand.ts @@ -22,6 +22,20 @@ export interface ListAssetsCommandOutput extends ListAssetsResponse, __MetadataB /** * Returns a collection of MediaPackage VOD Asset resources. + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { MediaPackageVodClient, ListAssetsCommand } from "@aws-sdk/client-mediapackage-vod"; // ES Modules import + * // const { MediaPackageVodClient, ListAssetsCommand } = require("@aws-sdk/client-mediapackage-vod"); // CommonJS import + * const client = new MediaPackageVodClient(config); + * const command = new ListAssetsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListAssetsCommandInput} for command's `input` shape. + * @see {@link ListAssetsCommandOutput} for command's `response` shape. + * @see {@link MediaPackageVodClientResolvedConfig | config} for command's `input` shape. + * */ export class ListAssetsCommand extends $Command< ListAssetsCommandInput, diff --git a/clients/client-mediapackage-vod/commands/ListPackagingConfigurationsCommand.ts b/clients/client-mediapackage-vod/commands/ListPackagingConfigurationsCommand.ts index 327e25eb9482..4416451ced98 100644 --- a/clients/client-mediapackage-vod/commands/ListPackagingConfigurationsCommand.ts +++ b/clients/client-mediapackage-vod/commands/ListPackagingConfigurationsCommand.ts @@ -24,6 +24,20 @@ export interface ListPackagingConfigurationsCommandOutput /** * Returns a collection of MediaPackage VOD PackagingConfiguration resources. + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { MediaPackageVodClient, ListPackagingConfigurationsCommand } from "@aws-sdk/client-mediapackage-vod"; // ES Modules import + * // const { MediaPackageVodClient, ListPackagingConfigurationsCommand } = require("@aws-sdk/client-mediapackage-vod"); // CommonJS import + * const client = new MediaPackageVodClient(config); + * const command = new ListPackagingConfigurationsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListPackagingConfigurationsCommandInput} for command's `input` shape. + * @see {@link ListPackagingConfigurationsCommandOutput} for command's `response` shape. + * @see {@link MediaPackageVodClientResolvedConfig | config} for command's `input` shape. + * */ export class ListPackagingConfigurationsCommand extends $Command< ListPackagingConfigurationsCommandInput, diff --git a/clients/client-mediapackage-vod/commands/ListPackagingGroupsCommand.ts b/clients/client-mediapackage-vod/commands/ListPackagingGroupsCommand.ts index 1e4b38eb6c41..6a1a8aebc50c 100644 --- a/clients/client-mediapackage-vod/commands/ListPackagingGroupsCommand.ts +++ b/clients/client-mediapackage-vod/commands/ListPackagingGroupsCommand.ts @@ -22,6 +22,20 @@ export interface ListPackagingGroupsCommandOutput extends ListPackagingGroupsRes /** * Returns a collection of MediaPackage VOD PackagingGroup resources. + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { MediaPackageVodClient, ListPackagingGroupsCommand } from "@aws-sdk/client-mediapackage-vod"; // ES Modules import + * // const { MediaPackageVodClient, ListPackagingGroupsCommand } = require("@aws-sdk/client-mediapackage-vod"); // CommonJS import + * const client = new MediaPackageVodClient(config); + * const command = new ListPackagingGroupsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListPackagingGroupsCommandInput} for command's `input` shape. + * @see {@link ListPackagingGroupsCommandOutput} for command's `response` shape. + * @see {@link MediaPackageVodClientResolvedConfig | config} for command's `input` shape. + * */ export class ListPackagingGroupsCommand extends $Command< ListPackagingGroupsCommandInput, diff --git a/clients/client-mediapackage-vod/commands/ListTagsForResourceCommand.ts b/clients/client-mediapackage-vod/commands/ListTagsForResourceCommand.ts index 587fa126c687..ddd1b1279b58 100644 --- a/clients/client-mediapackage-vod/commands/ListTagsForResourceCommand.ts +++ b/clients/client-mediapackage-vod/commands/ListTagsForResourceCommand.ts @@ -22,6 +22,20 @@ export interface ListTagsForResourceCommandOutput extends ListTagsForResourceRes /** * Returns a list of the tags assigned to the specified resource. + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { MediaPackageVodClient, ListTagsForResourceCommand } from "@aws-sdk/client-mediapackage-vod"; // ES Modules import + * // const { MediaPackageVodClient, ListTagsForResourceCommand } = require("@aws-sdk/client-mediapackage-vod"); // CommonJS import + * const client = new MediaPackageVodClient(config); + * const command = new ListTagsForResourceCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListTagsForResourceCommandInput} for command's `input` shape. + * @see {@link ListTagsForResourceCommandOutput} for command's `response` shape. + * @see {@link MediaPackageVodClientResolvedConfig | config} for command's `input` shape. + * */ export class ListTagsForResourceCommand extends $Command< ListTagsForResourceCommandInput, diff --git a/clients/client-mediapackage-vod/commands/TagResourceCommand.ts b/clients/client-mediapackage-vod/commands/TagResourceCommand.ts index ed16d3e74e32..806837ac977f 100644 --- a/clients/client-mediapackage-vod/commands/TagResourceCommand.ts +++ b/clients/client-mediapackage-vod/commands/TagResourceCommand.ts @@ -22,6 +22,20 @@ export interface TagResourceCommandOutput extends __MetadataBearer {} /** * Adds tags to the specified resource. You can specify one or more tags to add. + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { MediaPackageVodClient, TagResourceCommand } from "@aws-sdk/client-mediapackage-vod"; // ES Modules import + * // const { MediaPackageVodClient, TagResourceCommand } = require("@aws-sdk/client-mediapackage-vod"); // CommonJS import + * const client = new MediaPackageVodClient(config); + * const command = new TagResourceCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link TagResourceCommandInput} for command's `input` shape. + * @see {@link TagResourceCommandOutput} for command's `response` shape. + * @see {@link MediaPackageVodClientResolvedConfig | config} for command's `input` shape. + * */ export class TagResourceCommand extends $Command< TagResourceCommandInput, diff --git a/clients/client-mediapackage-vod/commands/UntagResourceCommand.ts b/clients/client-mediapackage-vod/commands/UntagResourceCommand.ts index 628b2b4e5e1e..b3d5871f62b6 100644 --- a/clients/client-mediapackage-vod/commands/UntagResourceCommand.ts +++ b/clients/client-mediapackage-vod/commands/UntagResourceCommand.ts @@ -22,6 +22,20 @@ export interface UntagResourceCommandOutput extends __MetadataBearer {} /** * Removes tags from the specified resource. You can specify one or more tags to remove. + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { MediaPackageVodClient, UntagResourceCommand } from "@aws-sdk/client-mediapackage-vod"; // ES Modules import + * // const { MediaPackageVodClient, UntagResourceCommand } = require("@aws-sdk/client-mediapackage-vod"); // CommonJS import + * const client = new MediaPackageVodClient(config); + * const command = new UntagResourceCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link UntagResourceCommandInput} for command's `input` shape. + * @see {@link UntagResourceCommandOutput} for command's `response` shape. + * @see {@link MediaPackageVodClientResolvedConfig | config} for command's `input` shape. + * */ export class UntagResourceCommand extends $Command< UntagResourceCommandInput, diff --git a/clients/client-mediapackage-vod/commands/UpdatePackagingGroupCommand.ts b/clients/client-mediapackage-vod/commands/UpdatePackagingGroupCommand.ts index 279ccc7a2136..6222a8e34379 100644 --- a/clients/client-mediapackage-vod/commands/UpdatePackagingGroupCommand.ts +++ b/clients/client-mediapackage-vod/commands/UpdatePackagingGroupCommand.ts @@ -22,6 +22,20 @@ export interface UpdatePackagingGroupCommandOutput extends UpdatePackagingGroupR /** * Updates a specific packaging group. You can't change the id attribute or any other system-generated attributes. + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { MediaPackageVodClient, UpdatePackagingGroupCommand } from "@aws-sdk/client-mediapackage-vod"; // ES Modules import + * // const { MediaPackageVodClient, UpdatePackagingGroupCommand } = require("@aws-sdk/client-mediapackage-vod"); // CommonJS import + * const client = new MediaPackageVodClient(config); + * const command = new UpdatePackagingGroupCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link UpdatePackagingGroupCommandInput} for command's `input` shape. + * @see {@link UpdatePackagingGroupCommandOutput} for command's `response` shape. + * @see {@link MediaPackageVodClientResolvedConfig | config} for command's `input` shape. + * */ export class UpdatePackagingGroupCommand extends $Command< UpdatePackagingGroupCommandInput, diff --git a/clients/client-mediapackage-vod/models/models_0.ts b/clients/client-mediapackage-vod/models/models_0.ts index f7cf7ffbe771..b47cc06d8753 100644 --- a/clients/client-mediapackage-vod/models/models_0.ts +++ b/clients/client-mediapackage-vod/models/models_0.ts @@ -51,6 +51,9 @@ export interface AssetShallow { } export namespace AssetShallow { + /** + * @internal + */ export const filterSensitiveLog = (obj: AssetShallow): any => ({ ...obj, }); @@ -93,6 +96,9 @@ export interface StreamSelection { } export namespace StreamSelection { + /** + * @internal + */ export const filterSensitiveLog = (obj: StreamSelection): any => ({ ...obj, }); @@ -129,6 +135,9 @@ export interface DashManifest { } export namespace DashManifest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DashManifest): any => ({ ...obj, }); @@ -150,6 +159,9 @@ export interface EgressEndpoint { } export namespace EgressEndpoint { + /** + * @internal + */ export const filterSensitiveLog = (obj: EgressEndpoint): any => ({ ...obj, }); @@ -210,6 +222,9 @@ export interface HlsManifest { } export namespace HlsManifest { + /** + * @internal + */ export const filterSensitiveLog = (obj: HlsManifest): any => ({ ...obj, }); @@ -231,6 +246,9 @@ export interface MssManifest { } export namespace MssManifest { + /** + * @internal + */ export const filterSensitiveLog = (obj: MssManifest): any => ({ ...obj, }); @@ -258,6 +276,9 @@ export interface SpekeKeyProvider { } export namespace SpekeKeyProvider { + /** + * @internal + */ export const filterSensitiveLog = (obj: SpekeKeyProvider): any => ({ ...obj, }); @@ -274,6 +295,9 @@ export interface CmafEncryption { } export namespace CmafEncryption { + /** + * @internal + */ export const filterSensitiveLog = (obj: CmafEncryption): any => ({ ...obj, }); @@ -306,6 +330,9 @@ export interface CmafPackage { } export namespace CmafPackage { + /** + * @internal + */ export const filterSensitiveLog = (obj: CmafPackage): any => ({ ...obj, }); @@ -322,6 +349,9 @@ export interface DashEncryption { } export namespace DashEncryption { + /** + * @internal + */ export const filterSensitiveLog = (obj: DashEncryption): any => ({ ...obj, }); @@ -373,6 +403,9 @@ export interface DashPackage { } export namespace DashPackage { + /** + * @internal + */ export const filterSensitiveLog = (obj: DashPackage): any => ({ ...obj, }); @@ -405,6 +438,9 @@ export interface HlsEncryption { } export namespace HlsEncryption { + /** + * @internal + */ export const filterSensitiveLog = (obj: HlsEncryption): any => ({ ...obj, }); @@ -437,6 +473,9 @@ export interface HlsPackage { } export namespace HlsPackage { + /** + * @internal + */ export const filterSensitiveLog = (obj: HlsPackage): any => ({ ...obj, }); @@ -453,6 +492,9 @@ export interface MssEncryption { } export namespace MssEncryption { + /** + * @internal + */ export const filterSensitiveLog = (obj: MssEncryption): any => ({ ...obj, }); @@ -479,6 +521,9 @@ export interface MssPackage { } export namespace MssPackage { + /** + * @internal + */ export const filterSensitiveLog = (obj: MssPackage): any => ({ ...obj, }); @@ -530,6 +575,9 @@ export interface PackagingConfiguration { } export namespace PackagingConfiguration { + /** + * @internal + */ export const filterSensitiveLog = (obj: PackagingConfiguration): any => ({ ...obj, }); @@ -551,6 +599,9 @@ export interface Authorization { } export namespace Authorization { + /** + * @internal + */ export const filterSensitiveLog = (obj: Authorization): any => ({ ...obj, }); @@ -567,6 +618,9 @@ export interface EgressAccessLogs { } export namespace EgressAccessLogs { + /** + * @internal + */ export const filterSensitiveLog = (obj: EgressAccessLogs): any => ({ ...obj, }); @@ -608,6 +662,9 @@ export interface PackagingGroup { } export namespace PackagingGroup { + /** + * @internal + */ export const filterSensitiveLog = (obj: PackagingGroup): any => ({ ...obj, }); @@ -629,6 +686,9 @@ export interface ConfigureLogsRequest { } export namespace ConfigureLogsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ConfigureLogsRequest): any => ({ ...obj, }); @@ -667,6 +727,9 @@ export interface ConfigureLogsResponse { } export namespace ConfigureLogsResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ConfigureLogsResponse): any => ({ ...obj, }); @@ -682,6 +745,9 @@ export interface ForbiddenException extends __SmithyException, $MetadataBearer { } export namespace ForbiddenException { + /** + * @internal + */ export const filterSensitiveLog = (obj: ForbiddenException): any => ({ ...obj, }); @@ -697,6 +763,9 @@ export interface InternalServerErrorException extends __SmithyException, $Metada } export namespace InternalServerErrorException { + /** + * @internal + */ export const filterSensitiveLog = (obj: InternalServerErrorException): any => ({ ...obj, }); @@ -712,6 +781,9 @@ export interface NotFoundException extends __SmithyException, $MetadataBearer { } export namespace NotFoundException { + /** + * @internal + */ export const filterSensitiveLog = (obj: NotFoundException): any => ({ ...obj, }); @@ -727,6 +799,9 @@ export interface ServiceUnavailableException extends __SmithyException, $Metadat } export namespace ServiceUnavailableException { + /** + * @internal + */ export const filterSensitiveLog = (obj: ServiceUnavailableException): any => ({ ...obj, }); @@ -742,6 +817,9 @@ export interface TooManyRequestsException extends __SmithyException, $MetadataBe } export namespace TooManyRequestsException { + /** + * @internal + */ export const filterSensitiveLog = (obj: TooManyRequestsException): any => ({ ...obj, }); @@ -757,6 +835,9 @@ export interface UnprocessableEntityException extends __SmithyException, $Metada } export namespace UnprocessableEntityException { + /** + * @internal + */ export const filterSensitiveLog = (obj: UnprocessableEntityException): any => ({ ...obj, }); @@ -798,6 +879,9 @@ export interface CreateAssetRequest { } export namespace CreateAssetRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateAssetRequest): any => ({ ...obj, }); @@ -851,6 +935,9 @@ export interface CreateAssetResponse { } export namespace CreateAssetResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateAssetResponse): any => ({ ...obj, }); @@ -897,6 +984,9 @@ export interface CreatePackagingConfigurationRequest { } export namespace CreatePackagingConfigurationRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreatePackagingConfigurationRequest): any => ({ ...obj, }); @@ -945,6 +1035,9 @@ export interface CreatePackagingConfigurationResponse { } export namespace CreatePackagingConfigurationResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreatePackagingConfigurationResponse): any => ({ ...obj, }); @@ -976,6 +1069,9 @@ export interface CreatePackagingGroupRequest { } export namespace CreatePackagingGroupRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreatePackagingGroupRequest): any => ({ ...obj, }); @@ -1014,6 +1110,9 @@ export interface CreatePackagingGroupResponse { } export namespace CreatePackagingGroupResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreatePackagingGroupResponse): any => ({ ...obj, }); @@ -1027,6 +1126,9 @@ export interface DeleteAssetRequest { } export namespace DeleteAssetRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteAssetRequest): any => ({ ...obj, }); @@ -1035,6 +1137,9 @@ export namespace DeleteAssetRequest { export interface DeleteAssetResponse {} export namespace DeleteAssetResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteAssetResponse): any => ({ ...obj, }); @@ -1048,6 +1153,9 @@ export interface DeletePackagingConfigurationRequest { } export namespace DeletePackagingConfigurationRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeletePackagingConfigurationRequest): any => ({ ...obj, }); @@ -1056,6 +1164,9 @@ export namespace DeletePackagingConfigurationRequest { export interface DeletePackagingConfigurationResponse {} export namespace DeletePackagingConfigurationResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeletePackagingConfigurationResponse): any => ({ ...obj, }); @@ -1069,6 +1180,9 @@ export interface DeletePackagingGroupRequest { } export namespace DeletePackagingGroupRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeletePackagingGroupRequest): any => ({ ...obj, }); @@ -1077,6 +1191,9 @@ export namespace DeletePackagingGroupRequest { export interface DeletePackagingGroupResponse {} export namespace DeletePackagingGroupResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeletePackagingGroupResponse): any => ({ ...obj, }); @@ -1090,6 +1207,9 @@ export interface DescribeAssetRequest { } export namespace DescribeAssetRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeAssetRequest): any => ({ ...obj, }); @@ -1143,6 +1263,9 @@ export interface DescribeAssetResponse { } export namespace DescribeAssetResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeAssetResponse): any => ({ ...obj, }); @@ -1156,6 +1279,9 @@ export interface DescribePackagingConfigurationRequest { } export namespace DescribePackagingConfigurationRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribePackagingConfigurationRequest): any => ({ ...obj, }); @@ -1204,6 +1330,9 @@ export interface DescribePackagingConfigurationResponse { } export namespace DescribePackagingConfigurationResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribePackagingConfigurationResponse): any => ({ ...obj, }); @@ -1217,6 +1346,9 @@ export interface DescribePackagingGroupRequest { } export namespace DescribePackagingGroupRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribePackagingGroupRequest): any => ({ ...obj, }); @@ -1255,6 +1387,9 @@ export interface DescribePackagingGroupResponse { } export namespace DescribePackagingGroupResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribePackagingGroupResponse): any => ({ ...obj, }); @@ -1278,6 +1413,9 @@ export interface ListAssetsRequest { } export namespace ListAssetsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListAssetsRequest): any => ({ ...obj, }); @@ -1296,6 +1434,9 @@ export interface ListAssetsResponse { } export namespace ListAssetsResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListAssetsResponse): any => ({ ...obj, }); @@ -1319,6 +1460,9 @@ export interface ListPackagingConfigurationsRequest { } export namespace ListPackagingConfigurationsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListPackagingConfigurationsRequest): any => ({ ...obj, }); @@ -1337,6 +1481,9 @@ export interface ListPackagingConfigurationsResponse { } export namespace ListPackagingConfigurationsResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListPackagingConfigurationsResponse): any => ({ ...obj, }); @@ -1355,6 +1502,9 @@ export interface ListPackagingGroupsRequest { } export namespace ListPackagingGroupsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListPackagingGroupsRequest): any => ({ ...obj, }); @@ -1373,6 +1523,9 @@ export interface ListPackagingGroupsResponse { } export namespace ListPackagingGroupsResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListPackagingGroupsResponse): any => ({ ...obj, }); @@ -1386,6 +1539,9 @@ export interface ListTagsForResourceRequest { } export namespace ListTagsForResourceRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListTagsForResourceRequest): any => ({ ...obj, }); @@ -1399,6 +1555,9 @@ export interface ListTagsForResourceResponse { } export namespace ListTagsForResourceResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListTagsForResourceResponse): any => ({ ...obj, }); @@ -1417,6 +1576,9 @@ export interface TagResourceRequest { } export namespace TagResourceRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: TagResourceRequest): any => ({ ...obj, }); @@ -1435,6 +1597,9 @@ export interface UntagResourceRequest { } export namespace UntagResourceRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: UntagResourceRequest): any => ({ ...obj, }); @@ -1456,6 +1621,9 @@ export interface UpdatePackagingGroupRequest { } export namespace UpdatePackagingGroupRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdatePackagingGroupRequest): any => ({ ...obj, }); @@ -1494,6 +1662,9 @@ export interface UpdatePackagingGroupResponse { } export namespace UpdatePackagingGroupResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdatePackagingGroupResponse): any => ({ ...obj, }); diff --git a/clients/client-mediapackage/commands/ConfigureLogsCommand.ts b/clients/client-mediapackage/commands/ConfigureLogsCommand.ts index 677370ed5ce7..9584e3a443f8 100644 --- a/clients/client-mediapackage/commands/ConfigureLogsCommand.ts +++ b/clients/client-mediapackage/commands/ConfigureLogsCommand.ts @@ -22,6 +22,20 @@ export interface ConfigureLogsCommandOutput extends ConfigureLogsResponse, __Met /** * Changes the Channel's properities to configure log subscription + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { MediaPackageClient, ConfigureLogsCommand } from "@aws-sdk/client-mediapackage"; // ES Modules import + * // const { MediaPackageClient, ConfigureLogsCommand } = require("@aws-sdk/client-mediapackage"); // CommonJS import + * const client = new MediaPackageClient(config); + * const command = new ConfigureLogsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ConfigureLogsCommandInput} for command's `input` shape. + * @see {@link ConfigureLogsCommandOutput} for command's `response` shape. + * @see {@link MediaPackageClientResolvedConfig | config} for command's `input` shape. + * */ export class ConfigureLogsCommand extends $Command< ConfigureLogsCommandInput, diff --git a/clients/client-mediapackage/commands/CreateChannelCommand.ts b/clients/client-mediapackage/commands/CreateChannelCommand.ts index 76171e9832c9..62dbcc88745a 100644 --- a/clients/client-mediapackage/commands/CreateChannelCommand.ts +++ b/clients/client-mediapackage/commands/CreateChannelCommand.ts @@ -22,6 +22,20 @@ export interface CreateChannelCommandOutput extends CreateChannelResponse, __Met /** * Creates a new Channel. + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { MediaPackageClient, CreateChannelCommand } from "@aws-sdk/client-mediapackage"; // ES Modules import + * // const { MediaPackageClient, CreateChannelCommand } = require("@aws-sdk/client-mediapackage"); // CommonJS import + * const client = new MediaPackageClient(config); + * const command = new CreateChannelCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreateChannelCommandInput} for command's `input` shape. + * @see {@link CreateChannelCommandOutput} for command's `response` shape. + * @see {@link MediaPackageClientResolvedConfig | config} for command's `input` shape. + * */ export class CreateChannelCommand extends $Command< CreateChannelCommandInput, diff --git a/clients/client-mediapackage/commands/CreateHarvestJobCommand.ts b/clients/client-mediapackage/commands/CreateHarvestJobCommand.ts index 3d16e6fffa77..b2c0bc80778c 100644 --- a/clients/client-mediapackage/commands/CreateHarvestJobCommand.ts +++ b/clients/client-mediapackage/commands/CreateHarvestJobCommand.ts @@ -22,6 +22,20 @@ export interface CreateHarvestJobCommandOutput extends CreateHarvestJobResponse, /** * Creates a new HarvestJob record. + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { MediaPackageClient, CreateHarvestJobCommand } from "@aws-sdk/client-mediapackage"; // ES Modules import + * // const { MediaPackageClient, CreateHarvestJobCommand } = require("@aws-sdk/client-mediapackage"); // CommonJS import + * const client = new MediaPackageClient(config); + * const command = new CreateHarvestJobCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreateHarvestJobCommandInput} for command's `input` shape. + * @see {@link CreateHarvestJobCommandOutput} for command's `response` shape. + * @see {@link MediaPackageClientResolvedConfig | config} for command's `input` shape. + * */ export class CreateHarvestJobCommand extends $Command< CreateHarvestJobCommandInput, diff --git a/clients/client-mediapackage/commands/CreateOriginEndpointCommand.ts b/clients/client-mediapackage/commands/CreateOriginEndpointCommand.ts index 61d326a35b43..4590a1fe7e49 100644 --- a/clients/client-mediapackage/commands/CreateOriginEndpointCommand.ts +++ b/clients/client-mediapackage/commands/CreateOriginEndpointCommand.ts @@ -22,6 +22,20 @@ export interface CreateOriginEndpointCommandOutput extends CreateOriginEndpointR /** * Creates a new OriginEndpoint record. + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { MediaPackageClient, CreateOriginEndpointCommand } from "@aws-sdk/client-mediapackage"; // ES Modules import + * // const { MediaPackageClient, CreateOriginEndpointCommand } = require("@aws-sdk/client-mediapackage"); // CommonJS import + * const client = new MediaPackageClient(config); + * const command = new CreateOriginEndpointCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreateOriginEndpointCommandInput} for command's `input` shape. + * @see {@link CreateOriginEndpointCommandOutput} for command's `response` shape. + * @see {@link MediaPackageClientResolvedConfig | config} for command's `input` shape. + * */ export class CreateOriginEndpointCommand extends $Command< CreateOriginEndpointCommandInput, diff --git a/clients/client-mediapackage/commands/DeleteChannelCommand.ts b/clients/client-mediapackage/commands/DeleteChannelCommand.ts index 5cac9b3945a6..eb13da7faa7f 100644 --- a/clients/client-mediapackage/commands/DeleteChannelCommand.ts +++ b/clients/client-mediapackage/commands/DeleteChannelCommand.ts @@ -22,6 +22,20 @@ export interface DeleteChannelCommandOutput extends DeleteChannelResponse, __Met /** * Deletes an existing Channel. + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { MediaPackageClient, DeleteChannelCommand } from "@aws-sdk/client-mediapackage"; // ES Modules import + * // const { MediaPackageClient, DeleteChannelCommand } = require("@aws-sdk/client-mediapackage"); // CommonJS import + * const client = new MediaPackageClient(config); + * const command = new DeleteChannelCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteChannelCommandInput} for command's `input` shape. + * @see {@link DeleteChannelCommandOutput} for command's `response` shape. + * @see {@link MediaPackageClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteChannelCommand extends $Command< DeleteChannelCommandInput, diff --git a/clients/client-mediapackage/commands/DeleteOriginEndpointCommand.ts b/clients/client-mediapackage/commands/DeleteOriginEndpointCommand.ts index 314b658c3c5d..3d7875841d4f 100644 --- a/clients/client-mediapackage/commands/DeleteOriginEndpointCommand.ts +++ b/clients/client-mediapackage/commands/DeleteOriginEndpointCommand.ts @@ -22,6 +22,20 @@ export interface DeleteOriginEndpointCommandOutput extends DeleteOriginEndpointR /** * Deletes an existing OriginEndpoint. + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { MediaPackageClient, DeleteOriginEndpointCommand } from "@aws-sdk/client-mediapackage"; // ES Modules import + * // const { MediaPackageClient, DeleteOriginEndpointCommand } = require("@aws-sdk/client-mediapackage"); // CommonJS import + * const client = new MediaPackageClient(config); + * const command = new DeleteOriginEndpointCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteOriginEndpointCommandInput} for command's `input` shape. + * @see {@link DeleteOriginEndpointCommandOutput} for command's `response` shape. + * @see {@link MediaPackageClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteOriginEndpointCommand extends $Command< DeleteOriginEndpointCommandInput, diff --git a/clients/client-mediapackage/commands/DescribeChannelCommand.ts b/clients/client-mediapackage/commands/DescribeChannelCommand.ts index bdffa089dd8d..bfed2f3bfdcb 100644 --- a/clients/client-mediapackage/commands/DescribeChannelCommand.ts +++ b/clients/client-mediapackage/commands/DescribeChannelCommand.ts @@ -22,6 +22,20 @@ export interface DescribeChannelCommandOutput extends DescribeChannelResponse, _ /** * Gets details about a Channel. + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { MediaPackageClient, DescribeChannelCommand } from "@aws-sdk/client-mediapackage"; // ES Modules import + * // const { MediaPackageClient, DescribeChannelCommand } = require("@aws-sdk/client-mediapackage"); // CommonJS import + * const client = new MediaPackageClient(config); + * const command = new DescribeChannelCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeChannelCommandInput} for command's `input` shape. + * @see {@link DescribeChannelCommandOutput} for command's `response` shape. + * @see {@link MediaPackageClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeChannelCommand extends $Command< DescribeChannelCommandInput, diff --git a/clients/client-mediapackage/commands/DescribeHarvestJobCommand.ts b/clients/client-mediapackage/commands/DescribeHarvestJobCommand.ts index 59f541a61542..fd7d8ebc9eec 100644 --- a/clients/client-mediapackage/commands/DescribeHarvestJobCommand.ts +++ b/clients/client-mediapackage/commands/DescribeHarvestJobCommand.ts @@ -22,6 +22,20 @@ export interface DescribeHarvestJobCommandOutput extends DescribeHarvestJobRespo /** * Gets details about an existing HarvestJob. + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { MediaPackageClient, DescribeHarvestJobCommand } from "@aws-sdk/client-mediapackage"; // ES Modules import + * // const { MediaPackageClient, DescribeHarvestJobCommand } = require("@aws-sdk/client-mediapackage"); // CommonJS import + * const client = new MediaPackageClient(config); + * const command = new DescribeHarvestJobCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeHarvestJobCommandInput} for command's `input` shape. + * @see {@link DescribeHarvestJobCommandOutput} for command's `response` shape. + * @see {@link MediaPackageClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeHarvestJobCommand extends $Command< DescribeHarvestJobCommandInput, diff --git a/clients/client-mediapackage/commands/DescribeOriginEndpointCommand.ts b/clients/client-mediapackage/commands/DescribeOriginEndpointCommand.ts index 8970afbd58b4..fe3f6d147f02 100644 --- a/clients/client-mediapackage/commands/DescribeOriginEndpointCommand.ts +++ b/clients/client-mediapackage/commands/DescribeOriginEndpointCommand.ts @@ -22,6 +22,20 @@ export interface DescribeOriginEndpointCommandOutput extends DescribeOriginEndpo /** * Gets details about an existing OriginEndpoint. + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { MediaPackageClient, DescribeOriginEndpointCommand } from "@aws-sdk/client-mediapackage"; // ES Modules import + * // const { MediaPackageClient, DescribeOriginEndpointCommand } = require("@aws-sdk/client-mediapackage"); // CommonJS import + * const client = new MediaPackageClient(config); + * const command = new DescribeOriginEndpointCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeOriginEndpointCommandInput} for command's `input` shape. + * @see {@link DescribeOriginEndpointCommandOutput} for command's `response` shape. + * @see {@link MediaPackageClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeOriginEndpointCommand extends $Command< DescribeOriginEndpointCommandInput, diff --git a/clients/client-mediapackage/commands/ListChannelsCommand.ts b/clients/client-mediapackage/commands/ListChannelsCommand.ts index 9dd558f666d4..667e1d2de58b 100644 --- a/clients/client-mediapackage/commands/ListChannelsCommand.ts +++ b/clients/client-mediapackage/commands/ListChannelsCommand.ts @@ -22,6 +22,20 @@ export interface ListChannelsCommandOutput extends ListChannelsResponse, __Metad /** * Returns a collection of Channels. + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { MediaPackageClient, ListChannelsCommand } from "@aws-sdk/client-mediapackage"; // ES Modules import + * // const { MediaPackageClient, ListChannelsCommand } = require("@aws-sdk/client-mediapackage"); // CommonJS import + * const client = new MediaPackageClient(config); + * const command = new ListChannelsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListChannelsCommandInput} for command's `input` shape. + * @see {@link ListChannelsCommandOutput} for command's `response` shape. + * @see {@link MediaPackageClientResolvedConfig | config} for command's `input` shape. + * */ export class ListChannelsCommand extends $Command< ListChannelsCommandInput, diff --git a/clients/client-mediapackage/commands/ListHarvestJobsCommand.ts b/clients/client-mediapackage/commands/ListHarvestJobsCommand.ts index 5dcd22370c53..893ad1ba41d3 100644 --- a/clients/client-mediapackage/commands/ListHarvestJobsCommand.ts +++ b/clients/client-mediapackage/commands/ListHarvestJobsCommand.ts @@ -22,6 +22,20 @@ export interface ListHarvestJobsCommandOutput extends ListHarvestJobsResponse, _ /** * Returns a collection of HarvestJob records. + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { MediaPackageClient, ListHarvestJobsCommand } from "@aws-sdk/client-mediapackage"; // ES Modules import + * // const { MediaPackageClient, ListHarvestJobsCommand } = require("@aws-sdk/client-mediapackage"); // CommonJS import + * const client = new MediaPackageClient(config); + * const command = new ListHarvestJobsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListHarvestJobsCommandInput} for command's `input` shape. + * @see {@link ListHarvestJobsCommandOutput} for command's `response` shape. + * @see {@link MediaPackageClientResolvedConfig | config} for command's `input` shape. + * */ export class ListHarvestJobsCommand extends $Command< ListHarvestJobsCommandInput, diff --git a/clients/client-mediapackage/commands/ListOriginEndpointsCommand.ts b/clients/client-mediapackage/commands/ListOriginEndpointsCommand.ts index c4bc462e91ad..78da9494ed0f 100644 --- a/clients/client-mediapackage/commands/ListOriginEndpointsCommand.ts +++ b/clients/client-mediapackage/commands/ListOriginEndpointsCommand.ts @@ -22,6 +22,20 @@ export interface ListOriginEndpointsCommandOutput extends ListOriginEndpointsRes /** * Returns a collection of OriginEndpoint records. + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { MediaPackageClient, ListOriginEndpointsCommand } from "@aws-sdk/client-mediapackage"; // ES Modules import + * // const { MediaPackageClient, ListOriginEndpointsCommand } = require("@aws-sdk/client-mediapackage"); // CommonJS import + * const client = new MediaPackageClient(config); + * const command = new ListOriginEndpointsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListOriginEndpointsCommandInput} for command's `input` shape. + * @see {@link ListOriginEndpointsCommandOutput} for command's `response` shape. + * @see {@link MediaPackageClientResolvedConfig | config} for command's `input` shape. + * */ export class ListOriginEndpointsCommand extends $Command< ListOriginEndpointsCommandInput, diff --git a/clients/client-mediapackage/commands/RotateChannelCredentialsCommand.ts b/clients/client-mediapackage/commands/RotateChannelCredentialsCommand.ts index 081414ad1d70..515c9fce6956 100644 --- a/clients/client-mediapackage/commands/RotateChannelCredentialsCommand.ts +++ b/clients/client-mediapackage/commands/RotateChannelCredentialsCommand.ts @@ -24,6 +24,20 @@ export interface RotateChannelCredentialsCommandOutput extends RotateChannelCred * @deprecated * * Changes the Channel's first IngestEndpoint's username and password. WARNING - This API is deprecated. Please use RotateIngestEndpointCredentials instead + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { MediaPackageClient, RotateChannelCredentialsCommand } from "@aws-sdk/client-mediapackage"; // ES Modules import + * // const { MediaPackageClient, RotateChannelCredentialsCommand } = require("@aws-sdk/client-mediapackage"); // CommonJS import + * const client = new MediaPackageClient(config); + * const command = new RotateChannelCredentialsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link RotateChannelCredentialsCommandInput} for command's `input` shape. + * @see {@link RotateChannelCredentialsCommandOutput} for command's `response` shape. + * @see {@link MediaPackageClientResolvedConfig | config} for command's `input` shape. + * */ export class RotateChannelCredentialsCommand extends $Command< RotateChannelCredentialsCommandInput, diff --git a/clients/client-mediapackage/commands/RotateIngestEndpointCredentialsCommand.ts b/clients/client-mediapackage/commands/RotateIngestEndpointCredentialsCommand.ts index c3520dce2cc4..2a607478b666 100644 --- a/clients/client-mediapackage/commands/RotateIngestEndpointCredentialsCommand.ts +++ b/clients/client-mediapackage/commands/RotateIngestEndpointCredentialsCommand.ts @@ -24,6 +24,20 @@ export interface RotateIngestEndpointCredentialsCommandOutput /** * Rotate the IngestEndpoint's username and password, as specified by the IngestEndpoint's id. + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { MediaPackageClient, RotateIngestEndpointCredentialsCommand } from "@aws-sdk/client-mediapackage"; // ES Modules import + * // const { MediaPackageClient, RotateIngestEndpointCredentialsCommand } = require("@aws-sdk/client-mediapackage"); // CommonJS import + * const client = new MediaPackageClient(config); + * const command = new RotateIngestEndpointCredentialsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link RotateIngestEndpointCredentialsCommandInput} for command's `input` shape. + * @see {@link RotateIngestEndpointCredentialsCommandOutput} for command's `response` shape. + * @see {@link MediaPackageClientResolvedConfig | config} for command's `input` shape. + * */ export class RotateIngestEndpointCredentialsCommand extends $Command< RotateIngestEndpointCredentialsCommandInput, diff --git a/clients/client-mediapackage/commands/UpdateChannelCommand.ts b/clients/client-mediapackage/commands/UpdateChannelCommand.ts index fafd7f1626c2..8a7250c93d88 100644 --- a/clients/client-mediapackage/commands/UpdateChannelCommand.ts +++ b/clients/client-mediapackage/commands/UpdateChannelCommand.ts @@ -22,6 +22,20 @@ export interface UpdateChannelCommandOutput extends UpdateChannelResponse, __Met /** * Updates an existing Channel. + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { MediaPackageClient, UpdateChannelCommand } from "@aws-sdk/client-mediapackage"; // ES Modules import + * // const { MediaPackageClient, UpdateChannelCommand } = require("@aws-sdk/client-mediapackage"); // CommonJS import + * const client = new MediaPackageClient(config); + * const command = new UpdateChannelCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link UpdateChannelCommandInput} for command's `input` shape. + * @see {@link UpdateChannelCommandOutput} for command's `response` shape. + * @see {@link MediaPackageClientResolvedConfig | config} for command's `input` shape. + * */ export class UpdateChannelCommand extends $Command< UpdateChannelCommandInput, diff --git a/clients/client-mediapackage/commands/UpdateOriginEndpointCommand.ts b/clients/client-mediapackage/commands/UpdateOriginEndpointCommand.ts index 05e3f4aa4800..13e4ccfdcab7 100644 --- a/clients/client-mediapackage/commands/UpdateOriginEndpointCommand.ts +++ b/clients/client-mediapackage/commands/UpdateOriginEndpointCommand.ts @@ -22,6 +22,20 @@ export interface UpdateOriginEndpointCommandOutput extends UpdateOriginEndpointR /** * Updates an existing OriginEndpoint. + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { MediaPackageClient, UpdateOriginEndpointCommand } from "@aws-sdk/client-mediapackage"; // ES Modules import + * // const { MediaPackageClient, UpdateOriginEndpointCommand } = require("@aws-sdk/client-mediapackage"); // CommonJS import + * const client = new MediaPackageClient(config); + * const command = new UpdateOriginEndpointCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link UpdateOriginEndpointCommandInput} for command's `input` shape. + * @see {@link UpdateOriginEndpointCommandOutput} for command's `response` shape. + * @see {@link MediaPackageClientResolvedConfig | config} for command's `input` shape. + * */ export class UpdateOriginEndpointCommand extends $Command< UpdateOriginEndpointCommandInput, diff --git a/clients/client-mediapackage/models/models_0.ts b/clients/client-mediapackage/models/models_0.ts index 2404a2fc7077..d110c00ebdcb 100644 --- a/clients/client-mediapackage/models/models_0.ts +++ b/clients/client-mediapackage/models/models_0.ts @@ -27,6 +27,9 @@ export interface EgressAccessLogs { } export namespace EgressAccessLogs { + /** + * @internal + */ export const filterSensitiveLog = (obj: EgressAccessLogs): any => ({ ...obj, }); @@ -58,6 +61,9 @@ export interface IngestEndpoint { } export namespace IngestEndpoint { + /** + * @internal + */ export const filterSensitiveLog = (obj: IngestEndpoint): any => ({ ...obj, }); @@ -74,6 +80,9 @@ export interface HlsIngest { } export namespace HlsIngest { + /** + * @internal + */ export const filterSensitiveLog = (obj: HlsIngest): any => ({ ...obj, }); @@ -90,6 +99,9 @@ export interface IngressAccessLogs { } export namespace IngressAccessLogs { + /** + * @internal + */ export const filterSensitiveLog = (obj: IngressAccessLogs): any => ({ ...obj, }); @@ -136,6 +148,9 @@ export interface Channel { } export namespace Channel { + /** + * @internal + */ export const filterSensitiveLog = (obj: Channel): any => ({ ...obj, }); @@ -162,6 +177,9 @@ export interface S3Destination { } export namespace S3Destination { + /** + * @internal + */ export const filterSensitiveLog = (obj: S3Destination): any => ({ ...obj, }); @@ -228,6 +246,9 @@ export interface HarvestJob { } export namespace HarvestJob { + /** + * @internal + */ export const filterSensitiveLog = (obj: HarvestJob): any => ({ ...obj, }); @@ -310,6 +331,9 @@ export interface HlsManifest { } export namespace HlsManifest { + /** + * @internal + */ export const filterSensitiveLog = (obj: HlsManifest): any => ({ ...obj, }); @@ -400,6 +424,9 @@ export interface HlsManifestCreateOrUpdateParameters { } export namespace HlsManifestCreateOrUpdateParameters { + /** + * @internal + */ export const filterSensitiveLog = (obj: HlsManifestCreateOrUpdateParameters): any => ({ ...obj, }); @@ -421,6 +448,9 @@ export interface Authorization { } export namespace Authorization { + /** + * @internal + */ export const filterSensitiveLog = (obj: Authorization): any => ({ ...obj, }); @@ -455,6 +485,9 @@ export interface EncryptionContractConfiguration { } export namespace EncryptionContractConfiguration { + /** + * @internal + */ export const filterSensitiveLog = (obj: EncryptionContractConfiguration): any => ({ ...obj, }); @@ -504,6 +537,9 @@ export interface SpekeKeyProvider { } export namespace SpekeKeyProvider { + /** + * @internal + */ export const filterSensitiveLog = (obj: SpekeKeyProvider): any => ({ ...obj, }); @@ -530,6 +566,9 @@ export interface CmafEncryption { } export namespace CmafEncryption { + /** + * @internal + */ export const filterSensitiveLog = (obj: CmafEncryption): any => ({ ...obj, }); @@ -562,6 +601,9 @@ export interface StreamSelection { } export namespace StreamSelection { + /** + * @internal + */ export const filterSensitiveLog = (obj: StreamSelection): any => ({ ...obj, }); @@ -599,6 +641,9 @@ export interface CmafPackage { } export namespace CmafPackage { + /** + * @internal + */ export const filterSensitiveLog = (obj: CmafPackage): any => ({ ...obj, }); @@ -620,6 +665,9 @@ export interface DashEncryption { } export namespace DashEncryption { + /** + * @internal + */ export const filterSensitiveLog = (obj: DashEncryption): any => ({ ...obj, }); @@ -741,6 +789,9 @@ export interface DashPackage { } export namespace DashPackage { + /** + * @internal + */ export const filterSensitiveLog = (obj: DashPackage): any => ({ ...obj, }); @@ -783,6 +834,9 @@ export interface HlsEncryption { } export namespace HlsEncryption { + /** + * @internal + */ export const filterSensitiveLog = (obj: HlsEncryption): any => ({ ...obj, }); @@ -877,6 +931,9 @@ export interface HlsPackage { } export namespace HlsPackage { + /** + * @internal + */ export const filterSensitiveLog = (obj: HlsPackage): any => ({ ...obj, }); @@ -893,6 +950,9 @@ export interface MssEncryption { } export namespace MssEncryption { + /** + * @internal + */ export const filterSensitiveLog = (obj: MssEncryption): any => ({ ...obj, }); @@ -924,6 +984,9 @@ export interface MssPackage { } export namespace MssPackage { + /** + * @internal + */ export const filterSensitiveLog = (obj: MssPackage): any => ({ ...obj, }); @@ -1024,6 +1087,9 @@ export interface OriginEndpoint { } export namespace OriginEndpoint { + /** + * @internal + */ export const filterSensitiveLog = (obj: OriginEndpoint): any => ({ ...obj, }); @@ -1061,6 +1127,9 @@ export interface CmafPackageCreateOrUpdateParameters { } export namespace CmafPackageCreateOrUpdateParameters { + /** + * @internal + */ export const filterSensitiveLog = (obj: CmafPackageCreateOrUpdateParameters): any => ({ ...obj, }); @@ -1087,6 +1156,9 @@ export interface ConfigureLogsRequest { } export namespace ConfigureLogsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ConfigureLogsRequest): any => ({ ...obj, }); @@ -1130,6 +1202,9 @@ export interface ConfigureLogsResponse { } export namespace ConfigureLogsResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ConfigureLogsResponse): any => ({ ...obj, }); @@ -1145,6 +1220,9 @@ export interface ForbiddenException extends __SmithyException, $MetadataBearer { } export namespace ForbiddenException { + /** + * @internal + */ export const filterSensitiveLog = (obj: ForbiddenException): any => ({ ...obj, }); @@ -1160,6 +1238,9 @@ export interface InternalServerErrorException extends __SmithyException, $Metada } export namespace InternalServerErrorException { + /** + * @internal + */ export const filterSensitiveLog = (obj: InternalServerErrorException): any => ({ ...obj, }); @@ -1175,6 +1256,9 @@ export interface NotFoundException extends __SmithyException, $MetadataBearer { } export namespace NotFoundException { + /** + * @internal + */ export const filterSensitiveLog = (obj: NotFoundException): any => ({ ...obj, }); @@ -1190,6 +1274,9 @@ export interface ServiceUnavailableException extends __SmithyException, $Metadat } export namespace ServiceUnavailableException { + /** + * @internal + */ export const filterSensitiveLog = (obj: ServiceUnavailableException): any => ({ ...obj, }); @@ -1205,6 +1292,9 @@ export interface TooManyRequestsException extends __SmithyException, $MetadataBe } export namespace TooManyRequestsException { + /** + * @internal + */ export const filterSensitiveLog = (obj: TooManyRequestsException): any => ({ ...obj, }); @@ -1220,6 +1310,9 @@ export interface UnprocessableEntityException extends __SmithyException, $Metada } export namespace UnprocessableEntityException { + /** + * @internal + */ export const filterSensitiveLog = (obj: UnprocessableEntityException): any => ({ ...obj, }); @@ -1247,6 +1340,9 @@ export interface CreateChannelRequest { } export namespace CreateChannelRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateChannelRequest): any => ({ ...obj, }); @@ -1290,6 +1386,9 @@ export interface CreateChannelResponse { } export namespace CreateChannelResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateChannelResponse): any => ({ ...obj, }); @@ -1328,6 +1427,9 @@ export interface CreateHarvestJobRequest { } export namespace CreateHarvestJobRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateHarvestJobRequest): any => ({ ...obj, }); @@ -1385,6 +1487,9 @@ export interface CreateHarvestJobResponse { } export namespace CreateHarvestJobResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateHarvestJobResponse): any => ({ ...obj, }); @@ -1472,6 +1577,9 @@ export interface CreateOriginEndpointRequest { } export namespace CreateOriginEndpointRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateOriginEndpointRequest): any => ({ ...obj, }); @@ -1564,6 +1672,9 @@ export interface CreateOriginEndpointResponse { } export namespace CreateOriginEndpointResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateOriginEndpointResponse): any => ({ ...obj, }); @@ -1577,6 +1688,9 @@ export interface DeleteChannelRequest { } export namespace DeleteChannelRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteChannelRequest): any => ({ ...obj, }); @@ -1585,6 +1699,9 @@ export namespace DeleteChannelRequest { export interface DeleteChannelResponse {} export namespace DeleteChannelResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteChannelResponse): any => ({ ...obj, }); @@ -1598,6 +1715,9 @@ export interface DeleteOriginEndpointRequest { } export namespace DeleteOriginEndpointRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteOriginEndpointRequest): any => ({ ...obj, }); @@ -1606,6 +1726,9 @@ export namespace DeleteOriginEndpointRequest { export interface DeleteOriginEndpointResponse {} export namespace DeleteOriginEndpointResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteOriginEndpointResponse): any => ({ ...obj, }); @@ -1619,6 +1742,9 @@ export interface DescribeChannelRequest { } export namespace DescribeChannelRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeChannelRequest): any => ({ ...obj, }); @@ -1662,6 +1788,9 @@ export interface DescribeChannelResponse { } export namespace DescribeChannelResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeChannelResponse): any => ({ ...obj, }); @@ -1675,6 +1804,9 @@ export interface DescribeHarvestJobRequest { } export namespace DescribeHarvestJobRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeHarvestJobRequest): any => ({ ...obj, }); @@ -1732,6 +1864,9 @@ export interface DescribeHarvestJobResponse { } export namespace DescribeHarvestJobResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeHarvestJobResponse): any => ({ ...obj, }); @@ -1745,6 +1880,9 @@ export interface DescribeOriginEndpointRequest { } export namespace DescribeOriginEndpointRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeOriginEndpointRequest): any => ({ ...obj, }); @@ -1837,6 +1975,9 @@ export interface DescribeOriginEndpointResponse { } export namespace DescribeOriginEndpointResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeOriginEndpointResponse): any => ({ ...obj, }); @@ -1855,6 +1996,9 @@ export interface ListChannelsRequest { } export namespace ListChannelsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListChannelsRequest): any => ({ ...obj, }); @@ -1873,6 +2017,9 @@ export interface ListChannelsResponse { } export namespace ListChannelsResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListChannelsResponse): any => ({ ...obj, }); @@ -1901,6 +2048,9 @@ export interface ListHarvestJobsRequest { } export namespace ListHarvestJobsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListHarvestJobsRequest): any => ({ ...obj, }); @@ -1919,6 +2069,9 @@ export interface ListHarvestJobsResponse { } export namespace ListHarvestJobsResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListHarvestJobsResponse): any => ({ ...obj, }); @@ -1942,6 +2095,9 @@ export interface ListOriginEndpointsRequest { } export namespace ListOriginEndpointsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListOriginEndpointsRequest): any => ({ ...obj, }); @@ -1960,6 +2116,9 @@ export interface ListOriginEndpointsResponse { } export namespace ListOriginEndpointsResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListOriginEndpointsResponse): any => ({ ...obj, }); @@ -1970,6 +2129,9 @@ export interface ListTagsForResourceRequest { } export namespace ListTagsForResourceRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListTagsForResourceRequest): any => ({ ...obj, }); @@ -1980,6 +2142,9 @@ export interface ListTagsForResourceResponse { } export namespace ListTagsForResourceResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListTagsForResourceResponse): any => ({ ...obj, }); @@ -1993,6 +2158,9 @@ export interface RotateChannelCredentialsRequest { } export namespace RotateChannelCredentialsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: RotateChannelCredentialsRequest): any => ({ ...obj, }); @@ -2036,6 +2204,9 @@ export interface RotateChannelCredentialsResponse { } export namespace RotateChannelCredentialsResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: RotateChannelCredentialsResponse): any => ({ ...obj, }); @@ -2054,6 +2225,9 @@ export interface RotateIngestEndpointCredentialsRequest { } export namespace RotateIngestEndpointCredentialsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: RotateIngestEndpointCredentialsRequest): any => ({ ...obj, }); @@ -2097,6 +2271,9 @@ export interface RotateIngestEndpointCredentialsResponse { } export namespace RotateIngestEndpointCredentialsResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: RotateIngestEndpointCredentialsResponse): any => ({ ...obj, }); @@ -2108,6 +2285,9 @@ export interface TagResourceRequest { } export namespace TagResourceRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: TagResourceRequest): any => ({ ...obj, }); @@ -2122,6 +2302,9 @@ export interface UntagResourceRequest { } export namespace UntagResourceRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: UntagResourceRequest): any => ({ ...obj, }); @@ -2143,6 +2326,9 @@ export interface UpdateChannelRequest { } export namespace UpdateChannelRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateChannelRequest): any => ({ ...obj, }); @@ -2186,6 +2372,9 @@ export interface UpdateChannelResponse { } export namespace UpdateChannelResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateChannelResponse): any => ({ ...obj, }); @@ -2261,6 +2450,9 @@ export interface UpdateOriginEndpointRequest { } export namespace UpdateOriginEndpointRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateOriginEndpointRequest): any => ({ ...obj, }); @@ -2353,6 +2545,9 @@ export interface UpdateOriginEndpointResponse { } export namespace UpdateOriginEndpointResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateOriginEndpointResponse): any => ({ ...obj, }); diff --git a/clients/client-mediastore-data/commands/DeleteObjectCommand.ts b/clients/client-mediastore-data/commands/DeleteObjectCommand.ts index 52fe6ad218c5..af8ce772eecf 100644 --- a/clients/client-mediastore-data/commands/DeleteObjectCommand.ts +++ b/clients/client-mediastore-data/commands/DeleteObjectCommand.ts @@ -22,6 +22,20 @@ export interface DeleteObjectCommandOutput extends DeleteObjectResponse, __Metad /** *

Deletes an object at the specified path.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { MediaStoreDataClient, DeleteObjectCommand } from "@aws-sdk/client-mediastore-data"; // ES Modules import + * // const { MediaStoreDataClient, DeleteObjectCommand } = require("@aws-sdk/client-mediastore-data"); // CommonJS import + * const client = new MediaStoreDataClient(config); + * const command = new DeleteObjectCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteObjectCommandInput} for command's `input` shape. + * @see {@link DeleteObjectCommandOutput} for command's `response` shape. + * @see {@link MediaStoreDataClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteObjectCommand extends $Command< DeleteObjectCommandInput, diff --git a/clients/client-mediastore-data/commands/DescribeObjectCommand.ts b/clients/client-mediastore-data/commands/DescribeObjectCommand.ts index 73bf1b4756f0..62c0d5e1e6c2 100644 --- a/clients/client-mediastore-data/commands/DescribeObjectCommand.ts +++ b/clients/client-mediastore-data/commands/DescribeObjectCommand.ts @@ -22,6 +22,20 @@ export interface DescribeObjectCommandOutput extends DescribeObjectResponse, __M /** *

Gets the headers for an object at the specified path.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { MediaStoreDataClient, DescribeObjectCommand } from "@aws-sdk/client-mediastore-data"; // ES Modules import + * // const { MediaStoreDataClient, DescribeObjectCommand } = require("@aws-sdk/client-mediastore-data"); // CommonJS import + * const client = new MediaStoreDataClient(config); + * const command = new DescribeObjectCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeObjectCommandInput} for command's `input` shape. + * @see {@link DescribeObjectCommandOutput} for command's `response` shape. + * @see {@link MediaStoreDataClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeObjectCommand extends $Command< DescribeObjectCommandInput, diff --git a/clients/client-mediastore-data/commands/GetObjectCommand.ts b/clients/client-mediastore-data/commands/GetObjectCommand.ts index 244a820d63c0..a2e5e37dc2fd 100644 --- a/clients/client-mediastore-data/commands/GetObjectCommand.ts +++ b/clients/client-mediastore-data/commands/GetObjectCommand.ts @@ -22,6 +22,20 @@ export interface GetObjectCommandOutput extends GetObjectResponse, __MetadataBea /** *

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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { MediaStoreDataClient, GetObjectCommand } from "@aws-sdk/client-mediastore-data"; // ES Modules import + * // const { MediaStoreDataClient, GetObjectCommand } = require("@aws-sdk/client-mediastore-data"); // CommonJS import + * const client = new MediaStoreDataClient(config); + * const command = new GetObjectCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetObjectCommandInput} for command's `input` shape. + * @see {@link GetObjectCommandOutput} for command's `response` shape. + * @see {@link MediaStoreDataClientResolvedConfig | config} for command's `input` shape. + * */ export class GetObjectCommand extends $Command< GetObjectCommandInput, diff --git a/clients/client-mediastore-data/commands/ListItemsCommand.ts b/clients/client-mediastore-data/commands/ListItemsCommand.ts index ac6a6f2c3ced..c9dc60a1f3f3 100644 --- a/clients/client-mediastore-data/commands/ListItemsCommand.ts +++ b/clients/client-mediastore-data/commands/ListItemsCommand.ts @@ -23,6 +23,20 @@ export interface ListItemsCommandOutput extends ListItemsResponse, __MetadataBea /** *

Provides a list of metadata entries about folders and objects in the specified * folder.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { MediaStoreDataClient, ListItemsCommand } from "@aws-sdk/client-mediastore-data"; // ES Modules import + * // const { MediaStoreDataClient, ListItemsCommand } = require("@aws-sdk/client-mediastore-data"); // CommonJS import + * const client = new MediaStoreDataClient(config); + * const command = new ListItemsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListItemsCommandInput} for command's `input` shape. + * @see {@link ListItemsCommandOutput} for command's `response` shape. + * @see {@link MediaStoreDataClientResolvedConfig | config} for command's `input` shape. + * */ export class ListItemsCommand extends $Command< ListItemsCommandInput, diff --git a/clients/client-mediastore-data/commands/PutObjectCommand.ts b/clients/client-mediastore-data/commands/PutObjectCommand.ts index a02f668b671b..6d3b3ca4d57d 100644 --- a/clients/client-mediastore-data/commands/PutObjectCommand.ts +++ b/clients/client-mediastore-data/commands/PutObjectCommand.ts @@ -31,6 +31,20 @@ export interface PutObjectCommandOutput extends PutObjectResponse, __MetadataBea /** *

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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { MediaStoreDataClient, PutObjectCommand } from "@aws-sdk/client-mediastore-data"; // ES Modules import + * // const { MediaStoreDataClient, PutObjectCommand } = require("@aws-sdk/client-mediastore-data"); // CommonJS import + * const client = new MediaStoreDataClient(config); + * const command = new PutObjectCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link PutObjectCommandInput} for command's `input` shape. + * @see {@link PutObjectCommandOutput} for command's `response` shape. + * @see {@link MediaStoreDataClientResolvedConfig | config} for command's `input` shape. + * */ export class PutObjectCommand extends $Command< PutObjectCommandInput, diff --git a/clients/client-mediastore-data/models/models_0.ts b/clients/client-mediastore-data/models/models_0.ts index 5d3ba44e6f4d..0144e03e13ab 100644 --- a/clients/client-mediastore-data/models/models_0.ts +++ b/clients/client-mediastore-data/models/models_0.ts @@ -12,6 +12,9 @@ export interface ContainerNotFoundException extends __SmithyException, $Metadata } export namespace ContainerNotFoundException { + /** + * @internal + */ export const filterSensitiveLog = (obj: ContainerNotFoundException): any => ({ ...obj, }); @@ -26,6 +29,9 @@ export interface DeleteObjectRequest { } export namespace DeleteObjectRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteObjectRequest): any => ({ ...obj, }); @@ -34,6 +40,9 @@ export namespace DeleteObjectRequest { export interface DeleteObjectResponse {} export namespace DeleteObjectResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteObjectResponse): any => ({ ...obj, }); @@ -49,6 +58,9 @@ export interface InternalServerError extends __SmithyException, $MetadataBearer } export namespace InternalServerError { + /** + * @internal + */ export const filterSensitiveLog = (obj: InternalServerError): any => ({ ...obj, }); @@ -64,6 +76,9 @@ export interface ObjectNotFoundException extends __SmithyException, $MetadataBea } export namespace ObjectNotFoundException { + /** + * @internal + */ export const filterSensitiveLog = (obj: ObjectNotFoundException): any => ({ ...obj, }); @@ -78,6 +93,9 @@ export interface DescribeObjectRequest { } export namespace DescribeObjectRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeObjectRequest): any => ({ ...obj, }); @@ -113,6 +131,9 @@ export interface DescribeObjectResponse { } export namespace DescribeObjectResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeObjectResponse): any => ({ ...obj, }); @@ -149,6 +170,9 @@ export interface GetObjectRequest { } export namespace GetObjectRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetObjectRequest): any => ({ ...obj, }); @@ -200,6 +224,9 @@ export interface GetObjectResponse { } export namespace GetObjectResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetObjectResponse): any => ({ ...obj, }); @@ -215,6 +242,9 @@ export interface RequestedRangeNotSatisfiableException extends __SmithyException } export namespace RequestedRangeNotSatisfiableException { + /** + * @internal + */ export const filterSensitiveLog = (obj: RequestedRangeNotSatisfiableException): any => ({ ...obj, }); @@ -261,6 +291,9 @@ export interface Item { } export namespace Item { + /** + * @internal + */ export const filterSensitiveLog = (obj: Item): any => ({ ...obj, }); @@ -297,6 +330,9 @@ export interface ListItemsRequest { } export namespace ListItemsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListItemsRequest): any => ({ ...obj, }); @@ -319,6 +355,9 @@ export interface ListItemsResponse { } export namespace ListItemsResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListItemsResponse): any => ({ ...obj, }); @@ -390,6 +429,9 @@ export interface PutObjectRequest { } export namespace PutObjectRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: PutObjectRequest): any => ({ ...obj, }); @@ -414,6 +456,9 @@ export interface PutObjectResponse { } export namespace PutObjectResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: PutObjectResponse): any => ({ ...obj, }); diff --git a/clients/client-mediastore/commands/CreateContainerCommand.ts b/clients/client-mediastore/commands/CreateContainerCommand.ts index 6ba035014bbd..6bbfc6341c75 100644 --- a/clients/client-mediastore/commands/CreateContainerCommand.ts +++ b/clients/client-mediastore/commands/CreateContainerCommand.ts @@ -23,6 +23,20 @@ export interface CreateContainerCommandOutput extends CreateContainerOutput, __M /** *

Creates a storage container to hold objects. A container is similar to a bucket in * the Amazon S3 service.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { MediaStoreClient, CreateContainerCommand } from "@aws-sdk/client-mediastore"; // ES Modules import + * // const { MediaStoreClient, CreateContainerCommand } = require("@aws-sdk/client-mediastore"); // CommonJS import + * const client = new MediaStoreClient(config); + * const command = new CreateContainerCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreateContainerCommandInput} for command's `input` shape. + * @see {@link CreateContainerCommandOutput} for command's `response` shape. + * @see {@link MediaStoreClientResolvedConfig | config} for command's `input` shape. + * */ export class CreateContainerCommand extends $Command< CreateContainerCommandInput, diff --git a/clients/client-mediastore/commands/DeleteContainerCommand.ts b/clients/client-mediastore/commands/DeleteContainerCommand.ts index e8c8c94fbb9d..a8f27b354bc3 100644 --- a/clients/client-mediastore/commands/DeleteContainerCommand.ts +++ b/clients/client-mediastore/commands/DeleteContainerCommand.ts @@ -24,6 +24,20 @@ export interface DeleteContainerCommandOutput extends DeleteContainerOutput, __M *

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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { MediaStoreClient, DeleteContainerCommand } from "@aws-sdk/client-mediastore"; // ES Modules import + * // const { MediaStoreClient, DeleteContainerCommand } = require("@aws-sdk/client-mediastore"); // CommonJS import + * const client = new MediaStoreClient(config); + * const command = new DeleteContainerCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteContainerCommandInput} for command's `input` shape. + * @see {@link DeleteContainerCommandOutput} for command's `response` shape. + * @see {@link MediaStoreClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteContainerCommand extends $Command< DeleteContainerCommandInput, diff --git a/clients/client-mediastore/commands/DeleteContainerPolicyCommand.ts b/clients/client-mediastore/commands/DeleteContainerPolicyCommand.ts index d9a875755a36..bb7ddde12d0d 100644 --- a/clients/client-mediastore/commands/DeleteContainerPolicyCommand.ts +++ b/clients/client-mediastore/commands/DeleteContainerPolicyCommand.ts @@ -22,6 +22,20 @@ export interface DeleteContainerPolicyCommandOutput extends DeleteContainerPolic /** *

Deletes the access policy that is associated with the specified container.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { MediaStoreClient, DeleteContainerPolicyCommand } from "@aws-sdk/client-mediastore"; // ES Modules import + * // const { MediaStoreClient, DeleteContainerPolicyCommand } = require("@aws-sdk/client-mediastore"); // CommonJS import + * const client = new MediaStoreClient(config); + * const command = new DeleteContainerPolicyCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteContainerPolicyCommandInput} for command's `input` shape. + * @see {@link DeleteContainerPolicyCommandOutput} for command's `response` shape. + * @see {@link MediaStoreClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteContainerPolicyCommand extends $Command< DeleteContainerPolicyCommandInput, diff --git a/clients/client-mediastore/commands/DeleteCorsPolicyCommand.ts b/clients/client-mediastore/commands/DeleteCorsPolicyCommand.ts index a8158f2bf1ee..02788e0b7190 100644 --- a/clients/client-mediastore/commands/DeleteCorsPolicyCommand.ts +++ b/clients/client-mediastore/commands/DeleteCorsPolicyCommand.ts @@ -26,6 +26,20 @@ export interface DeleteCorsPolicyCommandOutput extends DeleteCorsPolicyOutput, _ *

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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { MediaStoreClient, DeleteCorsPolicyCommand } from "@aws-sdk/client-mediastore"; // ES Modules import + * // const { MediaStoreClient, DeleteCorsPolicyCommand } = require("@aws-sdk/client-mediastore"); // CommonJS import + * const client = new MediaStoreClient(config); + * const command = new DeleteCorsPolicyCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteCorsPolicyCommandInput} for command's `input` shape. + * @see {@link DeleteCorsPolicyCommandOutput} for command's `response` shape. + * @see {@link MediaStoreClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteCorsPolicyCommand extends $Command< DeleteCorsPolicyCommandInput, diff --git a/clients/client-mediastore/commands/DeleteLifecyclePolicyCommand.ts b/clients/client-mediastore/commands/DeleteLifecyclePolicyCommand.ts index d016351b95c6..f216c98d3ba4 100644 --- a/clients/client-mediastore/commands/DeleteLifecyclePolicyCommand.ts +++ b/clients/client-mediastore/commands/DeleteLifecyclePolicyCommand.ts @@ -22,6 +22,20 @@ export interface DeleteLifecyclePolicyCommandOutput extends DeleteLifecyclePolic /** *

Removes an object lifecycle policy from a container. It takes up to 20 minutes for the change to take effect.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { MediaStoreClient, DeleteLifecyclePolicyCommand } from "@aws-sdk/client-mediastore"; // ES Modules import + * // const { MediaStoreClient, DeleteLifecyclePolicyCommand } = require("@aws-sdk/client-mediastore"); // CommonJS import + * const client = new MediaStoreClient(config); + * const command = new DeleteLifecyclePolicyCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteLifecyclePolicyCommandInput} for command's `input` shape. + * @see {@link DeleteLifecyclePolicyCommandOutput} for command's `response` shape. + * @see {@link MediaStoreClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteLifecyclePolicyCommand extends $Command< DeleteLifecyclePolicyCommandInput, diff --git a/clients/client-mediastore/commands/DeleteMetricPolicyCommand.ts b/clients/client-mediastore/commands/DeleteMetricPolicyCommand.ts index 268213e6a4f0..e6f60e2f160e 100644 --- a/clients/client-mediastore/commands/DeleteMetricPolicyCommand.ts +++ b/clients/client-mediastore/commands/DeleteMetricPolicyCommand.ts @@ -22,6 +22,20 @@ export interface DeleteMetricPolicyCommandOutput extends DeleteMetricPolicyOutpu /** *

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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { MediaStoreClient, DeleteMetricPolicyCommand } from "@aws-sdk/client-mediastore"; // ES Modules import + * // const { MediaStoreClient, DeleteMetricPolicyCommand } = require("@aws-sdk/client-mediastore"); // CommonJS import + * const client = new MediaStoreClient(config); + * const command = new DeleteMetricPolicyCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteMetricPolicyCommandInput} for command's `input` shape. + * @see {@link DeleteMetricPolicyCommandOutput} for command's `response` shape. + * @see {@link MediaStoreClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteMetricPolicyCommand extends $Command< DeleteMetricPolicyCommandInput, diff --git a/clients/client-mediastore/commands/DescribeContainerCommand.ts b/clients/client-mediastore/commands/DescribeContainerCommand.ts index a5dd950b5560..5880ea630fe9 100644 --- a/clients/client-mediastore/commands/DescribeContainerCommand.ts +++ b/clients/client-mediastore/commands/DescribeContainerCommand.ts @@ -28,6 +28,20 @@ export interface DescribeContainerCommandOutput extends DescribeContainerOutput, * Container object based on ContainerName. To return all * Container objects that are associated with a specified AWS account, use * ListContainers.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { MediaStoreClient, DescribeContainerCommand } from "@aws-sdk/client-mediastore"; // ES Modules import + * // const { MediaStoreClient, DescribeContainerCommand } = require("@aws-sdk/client-mediastore"); // CommonJS import + * const client = new MediaStoreClient(config); + * const command = new DescribeContainerCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeContainerCommandInput} for command's `input` shape. + * @see {@link DescribeContainerCommandOutput} for command's `response` shape. + * @see {@link MediaStoreClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeContainerCommand extends $Command< DescribeContainerCommandInput, diff --git a/clients/client-mediastore/commands/GetContainerPolicyCommand.ts b/clients/client-mediastore/commands/GetContainerPolicyCommand.ts index 566622015618..1b539b2fc9fe 100644 --- a/clients/client-mediastore/commands/GetContainerPolicyCommand.ts +++ b/clients/client-mediastore/commands/GetContainerPolicyCommand.ts @@ -24,6 +24,20 @@ export interface GetContainerPolicyCommandOutput extends GetContainerPolicyOutpu *

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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { MediaStoreClient, GetContainerPolicyCommand } from "@aws-sdk/client-mediastore"; // ES Modules import + * // const { MediaStoreClient, GetContainerPolicyCommand } = require("@aws-sdk/client-mediastore"); // CommonJS import + * const client = new MediaStoreClient(config); + * const command = new GetContainerPolicyCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetContainerPolicyCommandInput} for command's `input` shape. + * @see {@link GetContainerPolicyCommandOutput} for command's `response` shape. + * @see {@link MediaStoreClientResolvedConfig | config} for command's `input` shape. + * */ export class GetContainerPolicyCommand extends $Command< GetContainerPolicyCommandInput, diff --git a/clients/client-mediastore/commands/GetCorsPolicyCommand.ts b/clients/client-mediastore/commands/GetCorsPolicyCommand.ts index f96395a2b8ae..b538bcec8521 100644 --- a/clients/client-mediastore/commands/GetCorsPolicyCommand.ts +++ b/clients/client-mediastore/commands/GetCorsPolicyCommand.ts @@ -26,6 +26,20 @@ export interface GetCorsPolicyCommandOutput extends GetCorsPolicyOutput, __Metad *

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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { MediaStoreClient, GetCorsPolicyCommand } from "@aws-sdk/client-mediastore"; // ES Modules import + * // const { MediaStoreClient, GetCorsPolicyCommand } = require("@aws-sdk/client-mediastore"); // CommonJS import + * const client = new MediaStoreClient(config); + * const command = new GetCorsPolicyCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetCorsPolicyCommandInput} for command's `input` shape. + * @see {@link GetCorsPolicyCommandOutput} for command's `response` shape. + * @see {@link MediaStoreClientResolvedConfig | config} for command's `input` shape. + * */ export class GetCorsPolicyCommand extends $Command< GetCorsPolicyCommandInput, diff --git a/clients/client-mediastore/commands/GetLifecyclePolicyCommand.ts b/clients/client-mediastore/commands/GetLifecyclePolicyCommand.ts index 3dd656e8cb9f..9c4876c10cce 100644 --- a/clients/client-mediastore/commands/GetLifecyclePolicyCommand.ts +++ b/clients/client-mediastore/commands/GetLifecyclePolicyCommand.ts @@ -22,6 +22,20 @@ export interface GetLifecyclePolicyCommandOutput extends GetLifecyclePolicyOutpu /** *

Retrieves the object lifecycle policy that is assigned to a container.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { MediaStoreClient, GetLifecyclePolicyCommand } from "@aws-sdk/client-mediastore"; // ES Modules import + * // const { MediaStoreClient, GetLifecyclePolicyCommand } = require("@aws-sdk/client-mediastore"); // CommonJS import + * const client = new MediaStoreClient(config); + * const command = new GetLifecyclePolicyCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetLifecyclePolicyCommandInput} for command's `input` shape. + * @see {@link GetLifecyclePolicyCommandOutput} for command's `response` shape. + * @see {@link MediaStoreClientResolvedConfig | config} for command's `input` shape. + * */ export class GetLifecyclePolicyCommand extends $Command< GetLifecyclePolicyCommandInput, diff --git a/clients/client-mediastore/commands/GetMetricPolicyCommand.ts b/clients/client-mediastore/commands/GetMetricPolicyCommand.ts index ebdcc332446b..2762303d6bbe 100644 --- a/clients/client-mediastore/commands/GetMetricPolicyCommand.ts +++ b/clients/client-mediastore/commands/GetMetricPolicyCommand.ts @@ -22,6 +22,20 @@ export interface GetMetricPolicyCommandOutput extends GetMetricPolicyOutput, __M /** *

Returns the metric policy for the specified container.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { MediaStoreClient, GetMetricPolicyCommand } from "@aws-sdk/client-mediastore"; // ES Modules import + * // const { MediaStoreClient, GetMetricPolicyCommand } = require("@aws-sdk/client-mediastore"); // CommonJS import + * const client = new MediaStoreClient(config); + * const command = new GetMetricPolicyCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetMetricPolicyCommandInput} for command's `input` shape. + * @see {@link GetMetricPolicyCommandOutput} for command's `response` shape. + * @see {@link MediaStoreClientResolvedConfig | config} for command's `input` shape. + * */ export class GetMetricPolicyCommand extends $Command< GetMetricPolicyCommandInput, diff --git a/clients/client-mediastore/commands/ListContainersCommand.ts b/clients/client-mediastore/commands/ListContainersCommand.ts index 02aaa4b791c3..e4d01c672d4d 100644 --- a/clients/client-mediastore/commands/ListContainersCommand.ts +++ b/clients/client-mediastore/commands/ListContainersCommand.ts @@ -30,6 +30,20 @@ export interface ListContainersCommandOutput extends ListContainersOutput, __Met * still more containers to receive.

*

See also DescribeContainer, which gets the properties of one * container.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { MediaStoreClient, ListContainersCommand } from "@aws-sdk/client-mediastore"; // ES Modules import + * // const { MediaStoreClient, ListContainersCommand } = require("@aws-sdk/client-mediastore"); // CommonJS import + * const client = new MediaStoreClient(config); + * const command = new ListContainersCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListContainersCommandInput} for command's `input` shape. + * @see {@link ListContainersCommandOutput} for command's `response` shape. + * @see {@link MediaStoreClientResolvedConfig | config} for command's `input` shape. + * */ export class ListContainersCommand extends $Command< ListContainersCommandInput, diff --git a/clients/client-mediastore/commands/ListTagsForResourceCommand.ts b/clients/client-mediastore/commands/ListTagsForResourceCommand.ts index 29a3e3ea5969..cd6cf6448665 100644 --- a/clients/client-mediastore/commands/ListTagsForResourceCommand.ts +++ b/clients/client-mediastore/commands/ListTagsForResourceCommand.ts @@ -22,6 +22,20 @@ export interface ListTagsForResourceCommandOutput extends ListTagsForResourceOut /** *

Returns a list of the tags assigned to the specified container.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { MediaStoreClient, ListTagsForResourceCommand } from "@aws-sdk/client-mediastore"; // ES Modules import + * // const { MediaStoreClient, ListTagsForResourceCommand } = require("@aws-sdk/client-mediastore"); // CommonJS import + * const client = new MediaStoreClient(config); + * const command = new ListTagsForResourceCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListTagsForResourceCommandInput} for command's `input` shape. + * @see {@link ListTagsForResourceCommandOutput} for command's `response` shape. + * @see {@link MediaStoreClientResolvedConfig | config} for command's `input` shape. + * */ export class ListTagsForResourceCommand extends $Command< ListTagsForResourceCommandInput, diff --git a/clients/client-mediastore/commands/PutContainerPolicyCommand.ts b/clients/client-mediastore/commands/PutContainerPolicyCommand.ts index c5f10ae91f61..f0c8d551c745 100644 --- a/clients/client-mediastore/commands/PutContainerPolicyCommand.ts +++ b/clients/client-mediastore/commands/PutContainerPolicyCommand.ts @@ -28,6 +28,20 @@ export interface PutContainerPolicyCommandOutput extends PutContainerPolicyOutpu *

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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { MediaStoreClient, PutContainerPolicyCommand } from "@aws-sdk/client-mediastore"; // ES Modules import + * // const { MediaStoreClient, PutContainerPolicyCommand } = require("@aws-sdk/client-mediastore"); // CommonJS import + * const client = new MediaStoreClient(config); + * const command = new PutContainerPolicyCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link PutContainerPolicyCommandInput} for command's `input` shape. + * @see {@link PutContainerPolicyCommandOutput} for command's `response` shape. + * @see {@link MediaStoreClientResolvedConfig | config} for command's `input` shape. + * */ export class PutContainerPolicyCommand extends $Command< PutContainerPolicyCommandInput, diff --git a/clients/client-mediastore/commands/PutCorsPolicyCommand.ts b/clients/client-mediastore/commands/PutCorsPolicyCommand.ts index 39afc9bc62f7..53db617d33ed 100644 --- a/clients/client-mediastore/commands/PutCorsPolicyCommand.ts +++ b/clients/client-mediastore/commands/PutCorsPolicyCommand.ts @@ -32,6 +32,20 @@ export interface PutCorsPolicyCommandOutput extends PutCorsPolicyOutput, __Metad * 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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { MediaStoreClient, PutCorsPolicyCommand } from "@aws-sdk/client-mediastore"; // ES Modules import + * // const { MediaStoreClient, PutCorsPolicyCommand } = require("@aws-sdk/client-mediastore"); // CommonJS import + * const client = new MediaStoreClient(config); + * const command = new PutCorsPolicyCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link PutCorsPolicyCommandInput} for command's `input` shape. + * @see {@link PutCorsPolicyCommandOutput} for command's `response` shape. + * @see {@link MediaStoreClientResolvedConfig | config} for command's `input` shape. + * */ export class PutCorsPolicyCommand extends $Command< PutCorsPolicyCommandInput, diff --git a/clients/client-mediastore/commands/PutLifecyclePolicyCommand.ts b/clients/client-mediastore/commands/PutLifecyclePolicyCommand.ts index 464112f7274f..78832c959888 100644 --- a/clients/client-mediastore/commands/PutLifecyclePolicyCommand.ts +++ b/clients/client-mediastore/commands/PutLifecyclePolicyCommand.ts @@ -23,6 +23,20 @@ export interface PutLifecyclePolicyCommandOutput extends PutLifecyclePolicyOutpu /** *

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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { MediaStoreClient, PutLifecyclePolicyCommand } from "@aws-sdk/client-mediastore"; // ES Modules import + * // const { MediaStoreClient, PutLifecyclePolicyCommand } = require("@aws-sdk/client-mediastore"); // CommonJS import + * const client = new MediaStoreClient(config); + * const command = new PutLifecyclePolicyCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link PutLifecyclePolicyCommandInput} for command's `input` shape. + * @see {@link PutLifecyclePolicyCommandOutput} for command's `response` shape. + * @see {@link MediaStoreClientResolvedConfig | config} for command's `input` shape. + * */ export class PutLifecyclePolicyCommand extends $Command< PutLifecyclePolicyCommandInput, diff --git a/clients/client-mediastore/commands/PutMetricPolicyCommand.ts b/clients/client-mediastore/commands/PutMetricPolicyCommand.ts index 56085a151f04..8ed7ac35c24c 100644 --- a/clients/client-mediastore/commands/PutMetricPolicyCommand.ts +++ b/clients/client-mediastore/commands/PutMetricPolicyCommand.ts @@ -22,6 +22,20 @@ export interface PutMetricPolicyCommandOutput extends PutMetricPolicyOutput, __M /** *

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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { MediaStoreClient, PutMetricPolicyCommand } from "@aws-sdk/client-mediastore"; // ES Modules import + * // const { MediaStoreClient, PutMetricPolicyCommand } = require("@aws-sdk/client-mediastore"); // CommonJS import + * const client = new MediaStoreClient(config); + * const command = new PutMetricPolicyCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link PutMetricPolicyCommandInput} for command's `input` shape. + * @see {@link PutMetricPolicyCommandOutput} for command's `response` shape. + * @see {@link MediaStoreClientResolvedConfig | config} for command's `input` shape. + * */ export class PutMetricPolicyCommand extends $Command< PutMetricPolicyCommandInput, diff --git a/clients/client-mediastore/commands/StartAccessLoggingCommand.ts b/clients/client-mediastore/commands/StartAccessLoggingCommand.ts index d588a05147a3..d9e089141046 100644 --- a/clients/client-mediastore/commands/StartAccessLoggingCommand.ts +++ b/clients/client-mediastore/commands/StartAccessLoggingCommand.ts @@ -22,6 +22,20 @@ export interface StartAccessLoggingCommandOutput extends StartAccessLoggingOutpu /** *

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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { MediaStoreClient, StartAccessLoggingCommand } from "@aws-sdk/client-mediastore"; // ES Modules import + * // const { MediaStoreClient, StartAccessLoggingCommand } = require("@aws-sdk/client-mediastore"); // CommonJS import + * const client = new MediaStoreClient(config); + * const command = new StartAccessLoggingCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link StartAccessLoggingCommandInput} for command's `input` shape. + * @see {@link StartAccessLoggingCommandOutput} for command's `response` shape. + * @see {@link MediaStoreClientResolvedConfig | config} for command's `input` shape. + * */ export class StartAccessLoggingCommand extends $Command< StartAccessLoggingCommandInput, diff --git a/clients/client-mediastore/commands/StopAccessLoggingCommand.ts b/clients/client-mediastore/commands/StopAccessLoggingCommand.ts index 2dc1fe4e5cb4..992c8aa77c6b 100644 --- a/clients/client-mediastore/commands/StopAccessLoggingCommand.ts +++ b/clients/client-mediastore/commands/StopAccessLoggingCommand.ts @@ -22,6 +22,20 @@ export interface StopAccessLoggingCommandOutput extends StopAccessLoggingOutput, /** *

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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { MediaStoreClient, StopAccessLoggingCommand } from "@aws-sdk/client-mediastore"; // ES Modules import + * // const { MediaStoreClient, StopAccessLoggingCommand } = require("@aws-sdk/client-mediastore"); // CommonJS import + * const client = new MediaStoreClient(config); + * const command = new StopAccessLoggingCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link StopAccessLoggingCommandInput} for command's `input` shape. + * @see {@link StopAccessLoggingCommandOutput} for command's `response` shape. + * @see {@link MediaStoreClientResolvedConfig | config} for command's `input` shape. + * */ export class StopAccessLoggingCommand extends $Command< StopAccessLoggingCommandInput, diff --git a/clients/client-mediastore/commands/TagResourceCommand.ts b/clients/client-mediastore/commands/TagResourceCommand.ts index b42b8a913546..90a32dc8560b 100644 --- a/clients/client-mediastore/commands/TagResourceCommand.ts +++ b/clients/client-mediastore/commands/TagResourceCommand.ts @@ -24,6 +24,20 @@ export interface TagResourceCommandOutput extends TagResourceOutput, __MetadataB *

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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { MediaStoreClient, TagResourceCommand } from "@aws-sdk/client-mediastore"; // ES Modules import + * // const { MediaStoreClient, TagResourceCommand } = require("@aws-sdk/client-mediastore"); // CommonJS import + * const client = new MediaStoreClient(config); + * const command = new TagResourceCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link TagResourceCommandInput} for command's `input` shape. + * @see {@link TagResourceCommandOutput} for command's `response` shape. + * @see {@link MediaStoreClientResolvedConfig | config} for command's `input` shape. + * */ export class TagResourceCommand extends $Command< TagResourceCommandInput, diff --git a/clients/client-mediastore/commands/UntagResourceCommand.ts b/clients/client-mediastore/commands/UntagResourceCommand.ts index 87e31a76cfd9..8a57472966dc 100644 --- a/clients/client-mediastore/commands/UntagResourceCommand.ts +++ b/clients/client-mediastore/commands/UntagResourceCommand.ts @@ -22,6 +22,20 @@ export interface UntagResourceCommandOutput extends UntagResourceOutput, __Metad /** *

Removes tags from the specified container. You can specify one or more tags to remove.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { MediaStoreClient, UntagResourceCommand } from "@aws-sdk/client-mediastore"; // ES Modules import + * // const { MediaStoreClient, UntagResourceCommand } = require("@aws-sdk/client-mediastore"); // CommonJS import + * const client = new MediaStoreClient(config); + * const command = new UntagResourceCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link UntagResourceCommandInput} for command's `input` shape. + * @see {@link UntagResourceCommandOutput} for command's `response` shape. + * @see {@link MediaStoreClientResolvedConfig | config} for command's `input` shape. + * */ export class UntagResourceCommand extends $Command< UntagResourceCommandInput, diff --git a/clients/client-mediastore/models/models_0.ts b/clients/client-mediastore/models/models_0.ts index 3321f098d5ff..9d6142193766 100644 --- a/clients/client-mediastore/models/models_0.ts +++ b/clients/client-mediastore/models/models_0.ts @@ -60,6 +60,9 @@ export interface Container { } export namespace Container { + /** + * @internal + */ export const filterSensitiveLog = (obj: Container): any => ({ ...obj, }); @@ -76,6 +79,9 @@ export interface ContainerInUseException extends __SmithyException, $MetadataBea } export namespace ContainerInUseException { + /** + * @internal + */ export const filterSensitiveLog = (obj: ContainerInUseException): any => ({ ...obj, }); @@ -96,6 +102,9 @@ export interface ContainerNotFoundException extends __SmithyException, $Metadata } export namespace ContainerNotFoundException { + /** + * @internal + */ export const filterSensitiveLog = (obj: ContainerNotFoundException): any => ({ ...obj, }); @@ -150,6 +159,9 @@ export interface CorsRule { } export namespace CorsRule { + /** + * @internal + */ export const filterSensitiveLog = (obj: CorsRule): any => ({ ...obj, }); @@ -165,6 +177,9 @@ export interface CorsPolicyNotFoundException extends __SmithyException, $Metadat } export namespace CorsPolicyNotFoundException { + /** + * @internal + */ export const filterSensitiveLog = (obj: CorsPolicyNotFoundException): any => ({ ...obj, }); @@ -191,6 +206,9 @@ export interface Tag { } export namespace Tag { + /** + * @internal + */ export const filterSensitiveLog = (obj: Tag): any => ({ ...obj, }); @@ -214,6 +232,9 @@ export interface CreateContainerInput { } export namespace CreateContainerInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateContainerInput): any => ({ ...obj, }); @@ -238,6 +259,9 @@ export interface CreateContainerOutput { } export namespace CreateContainerOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateContainerOutput): any => ({ ...obj, }); @@ -253,6 +277,9 @@ export interface InternalServerError extends __SmithyException, $MetadataBearer } export namespace InternalServerError { + /** + * @internal + */ export const filterSensitiveLog = (obj: InternalServerError): any => ({ ...obj, }); @@ -268,6 +295,9 @@ export interface LimitExceededException extends __SmithyException, $MetadataBear } export namespace LimitExceededException { + /** + * @internal + */ export const filterSensitiveLog = (obj: LimitExceededException): any => ({ ...obj, }); @@ -281,6 +311,9 @@ export interface DeleteContainerInput { } export namespace DeleteContainerInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteContainerInput): any => ({ ...obj, }); @@ -289,6 +322,9 @@ export namespace DeleteContainerInput { export interface DeleteContainerOutput {} export namespace DeleteContainerOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteContainerOutput): any => ({ ...obj, }); @@ -302,6 +338,9 @@ export interface DeleteContainerPolicyInput { } export namespace DeleteContainerPolicyInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteContainerPolicyInput): any => ({ ...obj, }); @@ -310,6 +349,9 @@ export namespace DeleteContainerPolicyInput { export interface DeleteContainerPolicyOutput {} export namespace DeleteContainerPolicyOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteContainerPolicyOutput): any => ({ ...obj, }); @@ -325,6 +367,9 @@ export interface PolicyNotFoundException extends __SmithyException, $MetadataBea } export namespace PolicyNotFoundException { + /** + * @internal + */ export const filterSensitiveLog = (obj: PolicyNotFoundException): any => ({ ...obj, }); @@ -338,6 +383,9 @@ export interface DeleteCorsPolicyInput { } export namespace DeleteCorsPolicyInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteCorsPolicyInput): any => ({ ...obj, }); @@ -346,6 +394,9 @@ export namespace DeleteCorsPolicyInput { export interface DeleteCorsPolicyOutput {} export namespace DeleteCorsPolicyOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteCorsPolicyOutput): any => ({ ...obj, }); @@ -359,6 +410,9 @@ export interface DeleteLifecyclePolicyInput { } export namespace DeleteLifecyclePolicyInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteLifecyclePolicyInput): any => ({ ...obj, }); @@ -367,6 +421,9 @@ export namespace DeleteLifecyclePolicyInput { export interface DeleteLifecyclePolicyOutput {} export namespace DeleteLifecyclePolicyOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteLifecyclePolicyOutput): any => ({ ...obj, }); @@ -380,6 +437,9 @@ export interface DeleteMetricPolicyInput { } export namespace DeleteMetricPolicyInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteMetricPolicyInput): any => ({ ...obj, }); @@ -388,6 +448,9 @@ export namespace DeleteMetricPolicyInput { export interface DeleteMetricPolicyOutput {} export namespace DeleteMetricPolicyOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteMetricPolicyOutput): any => ({ ...obj, }); @@ -401,6 +464,9 @@ export interface DescribeContainerInput { } export namespace DescribeContainerInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeContainerInput): any => ({ ...obj, }); @@ -414,6 +480,9 @@ export interface DescribeContainerOutput { } export namespace DescribeContainerOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeContainerOutput): any => ({ ...obj, }); @@ -427,6 +496,9 @@ export interface GetContainerPolicyInput { } export namespace GetContainerPolicyInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetContainerPolicyInput): any => ({ ...obj, }); @@ -440,6 +512,9 @@ export interface GetContainerPolicyOutput { } export namespace GetContainerPolicyOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetContainerPolicyOutput): any => ({ ...obj, }); @@ -453,6 +528,9 @@ export interface GetCorsPolicyInput { } export namespace GetCorsPolicyInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetCorsPolicyInput): any => ({ ...obj, }); @@ -466,6 +544,9 @@ export interface GetCorsPolicyOutput { } export namespace GetCorsPolicyOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetCorsPolicyOutput): any => ({ ...obj, }); @@ -479,6 +560,9 @@ export interface GetLifecyclePolicyInput { } export namespace GetLifecyclePolicyInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetLifecyclePolicyInput): any => ({ ...obj, }); @@ -492,6 +576,9 @@ export interface GetLifecyclePolicyOutput { } export namespace GetLifecyclePolicyOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetLifecyclePolicyOutput): any => ({ ...obj, }); @@ -505,6 +592,9 @@ export interface GetMetricPolicyInput { } export namespace GetMetricPolicyInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetMetricPolicyInput): any => ({ ...obj, }); @@ -526,6 +616,9 @@ export interface MetricPolicyRule { } export namespace MetricPolicyRule { + /** + * @internal + */ export const filterSensitiveLog = (obj: MetricPolicyRule): any => ({ ...obj, }); @@ -548,6 +641,9 @@ export interface MetricPolicy { } export namespace MetricPolicy { + /** + * @internal + */ export const filterSensitiveLog = (obj: MetricPolicy): any => ({ ...obj, }); @@ -561,6 +657,9 @@ export interface GetMetricPolicyOutput { } export namespace GetMetricPolicyOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetMetricPolicyOutput): any => ({ ...obj, }); @@ -582,6 +681,9 @@ export interface ListContainersInput { } export namespace ListContainersInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListContainersInput): any => ({ ...obj, }); @@ -603,6 +705,9 @@ export interface ListContainersOutput { } export namespace ListContainersOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListContainersOutput): any => ({ ...obj, }); @@ -616,6 +721,9 @@ export interface ListTagsForResourceInput { } export namespace ListTagsForResourceInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListTagsForResourceInput): any => ({ ...obj, }); @@ -629,6 +737,9 @@ export interface ListTagsForResourceOutput { } export namespace ListTagsForResourceOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListTagsForResourceOutput): any => ({ ...obj, }); @@ -656,6 +767,9 @@ export interface PutContainerPolicyInput { } export namespace PutContainerPolicyInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: PutContainerPolicyInput): any => ({ ...obj, }); @@ -664,6 +778,9 @@ export namespace PutContainerPolicyInput { export interface PutContainerPolicyOutput {} export namespace PutContainerPolicyOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: PutContainerPolicyOutput): any => ({ ...obj, }); @@ -682,6 +799,9 @@ export interface PutCorsPolicyInput { } export namespace PutCorsPolicyInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: PutCorsPolicyInput): any => ({ ...obj, }); @@ -690,6 +810,9 @@ export namespace PutCorsPolicyInput { export interface PutCorsPolicyOutput {} export namespace PutCorsPolicyOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: PutCorsPolicyOutput): any => ({ ...obj, }); @@ -708,6 +831,9 @@ export interface PutLifecyclePolicyInput { } export namespace PutLifecyclePolicyInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: PutLifecyclePolicyInput): any => ({ ...obj, }); @@ -716,6 +842,9 @@ export namespace PutLifecyclePolicyInput { export interface PutLifecyclePolicyOutput {} export namespace PutLifecyclePolicyOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: PutLifecyclePolicyOutput): any => ({ ...obj, }); @@ -742,6 +871,9 @@ export interface PutMetricPolicyInput { } export namespace PutMetricPolicyInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: PutMetricPolicyInput): any => ({ ...obj, }); @@ -750,6 +882,9 @@ export namespace PutMetricPolicyInput { export interface PutMetricPolicyOutput {} export namespace PutMetricPolicyOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: PutMetricPolicyOutput): any => ({ ...obj, }); @@ -763,6 +898,9 @@ export interface StartAccessLoggingInput { } export namespace StartAccessLoggingInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: StartAccessLoggingInput): any => ({ ...obj, }); @@ -771,6 +909,9 @@ export namespace StartAccessLoggingInput { export interface StartAccessLoggingOutput {} export namespace StartAccessLoggingOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: StartAccessLoggingOutput): any => ({ ...obj, }); @@ -784,6 +925,9 @@ export interface StopAccessLoggingInput { } export namespace StopAccessLoggingInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: StopAccessLoggingInput): any => ({ ...obj, }); @@ -792,6 +936,9 @@ export namespace StopAccessLoggingInput { export interface StopAccessLoggingOutput {} export namespace StopAccessLoggingOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: StopAccessLoggingOutput): any => ({ ...obj, }); @@ -813,6 +960,9 @@ export interface TagResourceInput { } export namespace TagResourceInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: TagResourceInput): any => ({ ...obj, }); @@ -821,6 +971,9 @@ export namespace TagResourceInput { export interface TagResourceOutput {} export namespace TagResourceOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: TagResourceOutput): any => ({ ...obj, }); @@ -841,6 +994,9 @@ export interface UntagResourceInput { } export namespace UntagResourceInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: UntagResourceInput): any => ({ ...obj, }); @@ -849,6 +1005,9 @@ export namespace UntagResourceInput { export interface UntagResourceOutput {} export namespace UntagResourceOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: UntagResourceOutput): any => ({ ...obj, }); diff --git a/clients/client-mediatailor/commands/CreateChannelCommand.ts b/clients/client-mediatailor/commands/CreateChannelCommand.ts index ae78ac108fb3..8fc059972e1a 100644 --- a/clients/client-mediatailor/commands/CreateChannelCommand.ts +++ b/clients/client-mediatailor/commands/CreateChannelCommand.ts @@ -22,6 +22,20 @@ export interface CreateChannelCommandOutput extends CreateChannelResponse, __Met /** *

Creates a channel.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { MediaTailorClient, CreateChannelCommand } from "@aws-sdk/client-mediatailor"; // ES Modules import + * // const { MediaTailorClient, CreateChannelCommand } = require("@aws-sdk/client-mediatailor"); // CommonJS import + * const client = new MediaTailorClient(config); + * const command = new CreateChannelCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreateChannelCommandInput} for command's `input` shape. + * @see {@link CreateChannelCommandOutput} for command's `response` shape. + * @see {@link MediaTailorClientResolvedConfig | config} for command's `input` shape. + * */ export class CreateChannelCommand extends $Command< CreateChannelCommandInput, diff --git a/clients/client-mediatailor/commands/CreateProgramCommand.ts b/clients/client-mediatailor/commands/CreateProgramCommand.ts index 3cc1113fdb57..ca2e2461f725 100644 --- a/clients/client-mediatailor/commands/CreateProgramCommand.ts +++ b/clients/client-mediatailor/commands/CreateProgramCommand.ts @@ -22,6 +22,20 @@ export interface CreateProgramCommandOutput extends CreateProgramResponse, __Met /** *

Creates a program.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { MediaTailorClient, CreateProgramCommand } from "@aws-sdk/client-mediatailor"; // ES Modules import + * // const { MediaTailorClient, CreateProgramCommand } = require("@aws-sdk/client-mediatailor"); // CommonJS import + * const client = new MediaTailorClient(config); + * const command = new CreateProgramCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreateProgramCommandInput} for command's `input` shape. + * @see {@link CreateProgramCommandOutput} for command's `response` shape. + * @see {@link MediaTailorClientResolvedConfig | config} for command's `input` shape. + * */ export class CreateProgramCommand extends $Command< CreateProgramCommandInput, diff --git a/clients/client-mediatailor/commands/CreateSourceLocationCommand.ts b/clients/client-mediatailor/commands/CreateSourceLocationCommand.ts index 55e101a305fb..e0280be4f225 100644 --- a/clients/client-mediatailor/commands/CreateSourceLocationCommand.ts +++ b/clients/client-mediatailor/commands/CreateSourceLocationCommand.ts @@ -22,6 +22,20 @@ export interface CreateSourceLocationCommandOutput extends CreateSourceLocationR /** *

Creates a source location on a specific channel.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { MediaTailorClient, CreateSourceLocationCommand } from "@aws-sdk/client-mediatailor"; // ES Modules import + * // const { MediaTailorClient, CreateSourceLocationCommand } = require("@aws-sdk/client-mediatailor"); // CommonJS import + * const client = new MediaTailorClient(config); + * const command = new CreateSourceLocationCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreateSourceLocationCommandInput} for command's `input` shape. + * @see {@link CreateSourceLocationCommandOutput} for command's `response` shape. + * @see {@link MediaTailorClientResolvedConfig | config} for command's `input` shape. + * */ export class CreateSourceLocationCommand extends $Command< CreateSourceLocationCommandInput, diff --git a/clients/client-mediatailor/commands/CreateVodSourceCommand.ts b/clients/client-mediatailor/commands/CreateVodSourceCommand.ts index ff72ac8352ff..bbde1d87faf1 100644 --- a/clients/client-mediatailor/commands/CreateVodSourceCommand.ts +++ b/clients/client-mediatailor/commands/CreateVodSourceCommand.ts @@ -22,6 +22,20 @@ export interface CreateVodSourceCommandOutput extends CreateVodSourceResponse, _ /** *

Creates name for a specific VOD source in a source location.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { MediaTailorClient, CreateVodSourceCommand } from "@aws-sdk/client-mediatailor"; // ES Modules import + * // const { MediaTailorClient, CreateVodSourceCommand } = require("@aws-sdk/client-mediatailor"); // CommonJS import + * const client = new MediaTailorClient(config); + * const command = new CreateVodSourceCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreateVodSourceCommandInput} for command's `input` shape. + * @see {@link CreateVodSourceCommandOutput} for command's `response` shape. + * @see {@link MediaTailorClientResolvedConfig | config} for command's `input` shape. + * */ export class CreateVodSourceCommand extends $Command< CreateVodSourceCommandInput, diff --git a/clients/client-mediatailor/commands/DeleteChannelCommand.ts b/clients/client-mediatailor/commands/DeleteChannelCommand.ts index fe8db9cdc034..eab4c9772940 100644 --- a/clients/client-mediatailor/commands/DeleteChannelCommand.ts +++ b/clients/client-mediatailor/commands/DeleteChannelCommand.ts @@ -22,6 +22,20 @@ export interface DeleteChannelCommandOutput extends DeleteChannelResponse, __Met /** *

Deletes a channel. You must stop the channel before it can be deleted.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { MediaTailorClient, DeleteChannelCommand } from "@aws-sdk/client-mediatailor"; // ES Modules import + * // const { MediaTailorClient, DeleteChannelCommand } = require("@aws-sdk/client-mediatailor"); // CommonJS import + * const client = new MediaTailorClient(config); + * const command = new DeleteChannelCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteChannelCommandInput} for command's `input` shape. + * @see {@link DeleteChannelCommandOutput} for command's `response` shape. + * @see {@link MediaTailorClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteChannelCommand extends $Command< DeleteChannelCommandInput, diff --git a/clients/client-mediatailor/commands/DeleteChannelPolicyCommand.ts b/clients/client-mediatailor/commands/DeleteChannelPolicyCommand.ts index ff00343dca8f..2a1db5366929 100644 --- a/clients/client-mediatailor/commands/DeleteChannelPolicyCommand.ts +++ b/clients/client-mediatailor/commands/DeleteChannelPolicyCommand.ts @@ -22,6 +22,20 @@ export interface DeleteChannelPolicyCommandOutput extends DeleteChannelPolicyRes /** *

Deletes a channel's IAM policy.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { MediaTailorClient, DeleteChannelPolicyCommand } from "@aws-sdk/client-mediatailor"; // ES Modules import + * // const { MediaTailorClient, DeleteChannelPolicyCommand } = require("@aws-sdk/client-mediatailor"); // CommonJS import + * const client = new MediaTailorClient(config); + * const command = new DeleteChannelPolicyCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteChannelPolicyCommandInput} for command's `input` shape. + * @see {@link DeleteChannelPolicyCommandOutput} for command's `response` shape. + * @see {@link MediaTailorClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteChannelPolicyCommand extends $Command< DeleteChannelPolicyCommandInput, diff --git a/clients/client-mediatailor/commands/DeletePlaybackConfigurationCommand.ts b/clients/client-mediatailor/commands/DeletePlaybackConfigurationCommand.ts index 513d3df275e5..ddc6e464687a 100644 --- a/clients/client-mediatailor/commands/DeletePlaybackConfigurationCommand.ts +++ b/clients/client-mediatailor/commands/DeletePlaybackConfigurationCommand.ts @@ -24,6 +24,20 @@ export interface DeletePlaybackConfigurationCommandOutput /** *

Deletes the playback configuration for the specified name.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { MediaTailorClient, DeletePlaybackConfigurationCommand } from "@aws-sdk/client-mediatailor"; // ES Modules import + * // const { MediaTailorClient, DeletePlaybackConfigurationCommand } = require("@aws-sdk/client-mediatailor"); // CommonJS import + * const client = new MediaTailorClient(config); + * const command = new DeletePlaybackConfigurationCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeletePlaybackConfigurationCommandInput} for command's `input` shape. + * @see {@link DeletePlaybackConfigurationCommandOutput} for command's `response` shape. + * @see {@link MediaTailorClientResolvedConfig | config} for command's `input` shape. + * */ export class DeletePlaybackConfigurationCommand extends $Command< DeletePlaybackConfigurationCommandInput, diff --git a/clients/client-mediatailor/commands/DeleteProgramCommand.ts b/clients/client-mediatailor/commands/DeleteProgramCommand.ts index c99955c98265..103506671c2e 100644 --- a/clients/client-mediatailor/commands/DeleteProgramCommand.ts +++ b/clients/client-mediatailor/commands/DeleteProgramCommand.ts @@ -22,6 +22,20 @@ export interface DeleteProgramCommandOutput extends DeleteProgramResponse, __Met /** *

Deletes a specific program on a specific channel.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { MediaTailorClient, DeleteProgramCommand } from "@aws-sdk/client-mediatailor"; // ES Modules import + * // const { MediaTailorClient, DeleteProgramCommand } = require("@aws-sdk/client-mediatailor"); // CommonJS import + * const client = new MediaTailorClient(config); + * const command = new DeleteProgramCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteProgramCommandInput} for command's `input` shape. + * @see {@link DeleteProgramCommandOutput} for command's `response` shape. + * @see {@link MediaTailorClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteProgramCommand extends $Command< DeleteProgramCommandInput, diff --git a/clients/client-mediatailor/commands/DeleteSourceLocationCommand.ts b/clients/client-mediatailor/commands/DeleteSourceLocationCommand.ts index a3689d4757a4..e0e70b5aede2 100644 --- a/clients/client-mediatailor/commands/DeleteSourceLocationCommand.ts +++ b/clients/client-mediatailor/commands/DeleteSourceLocationCommand.ts @@ -22,6 +22,20 @@ export interface DeleteSourceLocationCommandOutput extends DeleteSourceLocationR /** *

Deletes a source location on a specific channel.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { MediaTailorClient, DeleteSourceLocationCommand } from "@aws-sdk/client-mediatailor"; // ES Modules import + * // const { MediaTailorClient, DeleteSourceLocationCommand } = require("@aws-sdk/client-mediatailor"); // CommonJS import + * const client = new MediaTailorClient(config); + * const command = new DeleteSourceLocationCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteSourceLocationCommandInput} for command's `input` shape. + * @see {@link DeleteSourceLocationCommandOutput} for command's `response` shape. + * @see {@link MediaTailorClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteSourceLocationCommand extends $Command< DeleteSourceLocationCommandInput, diff --git a/clients/client-mediatailor/commands/DeleteVodSourceCommand.ts b/clients/client-mediatailor/commands/DeleteVodSourceCommand.ts index fcaa67c29799..0d36d952e3d2 100644 --- a/clients/client-mediatailor/commands/DeleteVodSourceCommand.ts +++ b/clients/client-mediatailor/commands/DeleteVodSourceCommand.ts @@ -22,6 +22,20 @@ export interface DeleteVodSourceCommandOutput extends DeleteVodSourceResponse, _ /** *

Deletes a specific VOD source in a specific source location.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { MediaTailorClient, DeleteVodSourceCommand } from "@aws-sdk/client-mediatailor"; // ES Modules import + * // const { MediaTailorClient, DeleteVodSourceCommand } = require("@aws-sdk/client-mediatailor"); // CommonJS import + * const client = new MediaTailorClient(config); + * const command = new DeleteVodSourceCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteVodSourceCommandInput} for command's `input` shape. + * @see {@link DeleteVodSourceCommandOutput} for command's `response` shape. + * @see {@link MediaTailorClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteVodSourceCommand extends $Command< DeleteVodSourceCommandInput, diff --git a/clients/client-mediatailor/commands/DescribeChannelCommand.ts b/clients/client-mediatailor/commands/DescribeChannelCommand.ts index 57f130e2e8d2..efb3d8b96296 100644 --- a/clients/client-mediatailor/commands/DescribeChannelCommand.ts +++ b/clients/client-mediatailor/commands/DescribeChannelCommand.ts @@ -22,6 +22,20 @@ export interface DescribeChannelCommandOutput extends DescribeChannelResponse, _ /** *

Describes the properties of a specific channel.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { MediaTailorClient, DescribeChannelCommand } from "@aws-sdk/client-mediatailor"; // ES Modules import + * // const { MediaTailorClient, DescribeChannelCommand } = require("@aws-sdk/client-mediatailor"); // CommonJS import + * const client = new MediaTailorClient(config); + * const command = new DescribeChannelCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeChannelCommandInput} for command's `input` shape. + * @see {@link DescribeChannelCommandOutput} for command's `response` shape. + * @see {@link MediaTailorClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeChannelCommand extends $Command< DescribeChannelCommandInput, diff --git a/clients/client-mediatailor/commands/DescribeProgramCommand.ts b/clients/client-mediatailor/commands/DescribeProgramCommand.ts index d77fcf3b8078..4f4c20262808 100644 --- a/clients/client-mediatailor/commands/DescribeProgramCommand.ts +++ b/clients/client-mediatailor/commands/DescribeProgramCommand.ts @@ -22,6 +22,20 @@ export interface DescribeProgramCommandOutput extends DescribeProgramResponse, _ /** *

Retrieves the properties of the requested program.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { MediaTailorClient, DescribeProgramCommand } from "@aws-sdk/client-mediatailor"; // ES Modules import + * // const { MediaTailorClient, DescribeProgramCommand } = require("@aws-sdk/client-mediatailor"); // CommonJS import + * const client = new MediaTailorClient(config); + * const command = new DescribeProgramCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeProgramCommandInput} for command's `input` shape. + * @see {@link DescribeProgramCommandOutput} for command's `response` shape. + * @see {@link MediaTailorClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeProgramCommand extends $Command< DescribeProgramCommandInput, diff --git a/clients/client-mediatailor/commands/DescribeSourceLocationCommand.ts b/clients/client-mediatailor/commands/DescribeSourceLocationCommand.ts index 0fcc557a88db..ea4a141cd412 100644 --- a/clients/client-mediatailor/commands/DescribeSourceLocationCommand.ts +++ b/clients/client-mediatailor/commands/DescribeSourceLocationCommand.ts @@ -22,6 +22,20 @@ export interface DescribeSourceLocationCommandOutput extends DescribeSourceLocat /** *

Retrieves the properties of the requested source location.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { MediaTailorClient, DescribeSourceLocationCommand } from "@aws-sdk/client-mediatailor"; // ES Modules import + * // const { MediaTailorClient, DescribeSourceLocationCommand } = require("@aws-sdk/client-mediatailor"); // CommonJS import + * const client = new MediaTailorClient(config); + * const command = new DescribeSourceLocationCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeSourceLocationCommandInput} for command's `input` shape. + * @see {@link DescribeSourceLocationCommandOutput} for command's `response` shape. + * @see {@link MediaTailorClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeSourceLocationCommand extends $Command< DescribeSourceLocationCommandInput, diff --git a/clients/client-mediatailor/commands/DescribeVodSourceCommand.ts b/clients/client-mediatailor/commands/DescribeVodSourceCommand.ts index 1e1d7cf6a999..ebec1b5d9af4 100644 --- a/clients/client-mediatailor/commands/DescribeVodSourceCommand.ts +++ b/clients/client-mediatailor/commands/DescribeVodSourceCommand.ts @@ -22,6 +22,20 @@ export interface DescribeVodSourceCommandOutput extends DescribeVodSourceRespons /** *

Provides details about a specific VOD source in a specific source location.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { MediaTailorClient, DescribeVodSourceCommand } from "@aws-sdk/client-mediatailor"; // ES Modules import + * // const { MediaTailorClient, DescribeVodSourceCommand } = require("@aws-sdk/client-mediatailor"); // CommonJS import + * const client = new MediaTailorClient(config); + * const command = new DescribeVodSourceCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeVodSourceCommandInput} for command's `input` shape. + * @see {@link DescribeVodSourceCommandOutput} for command's `response` shape. + * @see {@link MediaTailorClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeVodSourceCommand extends $Command< DescribeVodSourceCommandInput, diff --git a/clients/client-mediatailor/commands/GetChannelPolicyCommand.ts b/clients/client-mediatailor/commands/GetChannelPolicyCommand.ts index 6a6f8ac17185..2a611ac5502b 100644 --- a/clients/client-mediatailor/commands/GetChannelPolicyCommand.ts +++ b/clients/client-mediatailor/commands/GetChannelPolicyCommand.ts @@ -22,6 +22,20 @@ export interface GetChannelPolicyCommandOutput extends GetChannelPolicyResponse, /** *

Retrieves information about a channel's IAM policy.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { MediaTailorClient, GetChannelPolicyCommand } from "@aws-sdk/client-mediatailor"; // ES Modules import + * // const { MediaTailorClient, GetChannelPolicyCommand } = require("@aws-sdk/client-mediatailor"); // CommonJS import + * const client = new MediaTailorClient(config); + * const command = new GetChannelPolicyCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetChannelPolicyCommandInput} for command's `input` shape. + * @see {@link GetChannelPolicyCommandOutput} for command's `response` shape. + * @see {@link MediaTailorClientResolvedConfig | config} for command's `input` shape. + * */ export class GetChannelPolicyCommand extends $Command< GetChannelPolicyCommandInput, diff --git a/clients/client-mediatailor/commands/GetChannelScheduleCommand.ts b/clients/client-mediatailor/commands/GetChannelScheduleCommand.ts index 9eaa67b07fb0..a9f5a86847c5 100644 --- a/clients/client-mediatailor/commands/GetChannelScheduleCommand.ts +++ b/clients/client-mediatailor/commands/GetChannelScheduleCommand.ts @@ -22,6 +22,20 @@ export interface GetChannelScheduleCommandOutput extends GetChannelScheduleRespo /** *

Retrieves information about your channel's schedule.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { MediaTailorClient, GetChannelScheduleCommand } from "@aws-sdk/client-mediatailor"; // ES Modules import + * // const { MediaTailorClient, GetChannelScheduleCommand } = require("@aws-sdk/client-mediatailor"); // CommonJS import + * const client = new MediaTailorClient(config); + * const command = new GetChannelScheduleCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetChannelScheduleCommandInput} for command's `input` shape. + * @see {@link GetChannelScheduleCommandOutput} for command's `response` shape. + * @see {@link MediaTailorClientResolvedConfig | config} for command's `input` shape. + * */ export class GetChannelScheduleCommand extends $Command< GetChannelScheduleCommandInput, diff --git a/clients/client-mediatailor/commands/GetPlaybackConfigurationCommand.ts b/clients/client-mediatailor/commands/GetPlaybackConfigurationCommand.ts index 64bebb709f6b..b8eeb62f40fc 100644 --- a/clients/client-mediatailor/commands/GetPlaybackConfigurationCommand.ts +++ b/clients/client-mediatailor/commands/GetPlaybackConfigurationCommand.ts @@ -22,6 +22,20 @@ export interface GetPlaybackConfigurationCommandOutput extends GetPlaybackConfig /** *

Returns the playback configuration for the specified name.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { MediaTailorClient, GetPlaybackConfigurationCommand } from "@aws-sdk/client-mediatailor"; // ES Modules import + * // const { MediaTailorClient, GetPlaybackConfigurationCommand } = require("@aws-sdk/client-mediatailor"); // CommonJS import + * const client = new MediaTailorClient(config); + * const command = new GetPlaybackConfigurationCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetPlaybackConfigurationCommandInput} for command's `input` shape. + * @see {@link GetPlaybackConfigurationCommandOutput} for command's `response` shape. + * @see {@link MediaTailorClientResolvedConfig | config} for command's `input` shape. + * */ export class GetPlaybackConfigurationCommand extends $Command< GetPlaybackConfigurationCommandInput, diff --git a/clients/client-mediatailor/commands/ListChannelsCommand.ts b/clients/client-mediatailor/commands/ListChannelsCommand.ts index 6ebd3834cf40..ce8f6866485c 100644 --- a/clients/client-mediatailor/commands/ListChannelsCommand.ts +++ b/clients/client-mediatailor/commands/ListChannelsCommand.ts @@ -22,6 +22,20 @@ export interface ListChannelsCommandOutput extends ListChannelsResponse, __Metad /** *

Retrieves a list of channels that are associated with this account.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { MediaTailorClient, ListChannelsCommand } from "@aws-sdk/client-mediatailor"; // ES Modules import + * // const { MediaTailorClient, ListChannelsCommand } = require("@aws-sdk/client-mediatailor"); // CommonJS import + * const client = new MediaTailorClient(config); + * const command = new ListChannelsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListChannelsCommandInput} for command's `input` shape. + * @see {@link ListChannelsCommandOutput} for command's `response` shape. + * @see {@link MediaTailorClientResolvedConfig | config} for command's `input` shape. + * */ export class ListChannelsCommand extends $Command< ListChannelsCommandInput, diff --git a/clients/client-mediatailor/commands/ListPlaybackConfigurationsCommand.ts b/clients/client-mediatailor/commands/ListPlaybackConfigurationsCommand.ts index 45f595c3af5f..d7b4dbf5ed58 100644 --- a/clients/client-mediatailor/commands/ListPlaybackConfigurationsCommand.ts +++ b/clients/client-mediatailor/commands/ListPlaybackConfigurationsCommand.ts @@ -22,6 +22,20 @@ export interface ListPlaybackConfigurationsCommandOutput extends ListPlaybackCon /** *

Returns a list of the playback configurations defined in AWS Elemental MediaTailor. You can specify a maximum number of configurations to return at a time. The default maximum is 50. Results are returned in pagefuls. If MediaTailor has more configurations than the specified maximum, it provides parameters in the response that you can use to retrieve the next pageful.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { MediaTailorClient, ListPlaybackConfigurationsCommand } from "@aws-sdk/client-mediatailor"; // ES Modules import + * // const { MediaTailorClient, ListPlaybackConfigurationsCommand } = require("@aws-sdk/client-mediatailor"); // CommonJS import + * const client = new MediaTailorClient(config); + * const command = new ListPlaybackConfigurationsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListPlaybackConfigurationsCommandInput} for command's `input` shape. + * @see {@link ListPlaybackConfigurationsCommandOutput} for command's `response` shape. + * @see {@link MediaTailorClientResolvedConfig | config} for command's `input` shape. + * */ export class ListPlaybackConfigurationsCommand extends $Command< ListPlaybackConfigurationsCommandInput, diff --git a/clients/client-mediatailor/commands/ListSourceLocationsCommand.ts b/clients/client-mediatailor/commands/ListSourceLocationsCommand.ts index 33a9e6152871..fd530c1a5cfd 100644 --- a/clients/client-mediatailor/commands/ListSourceLocationsCommand.ts +++ b/clients/client-mediatailor/commands/ListSourceLocationsCommand.ts @@ -22,6 +22,20 @@ export interface ListSourceLocationsCommandOutput extends ListSourceLocationsRes /** *

Retrieves a list of source locations.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { MediaTailorClient, ListSourceLocationsCommand } from "@aws-sdk/client-mediatailor"; // ES Modules import + * // const { MediaTailorClient, ListSourceLocationsCommand } = require("@aws-sdk/client-mediatailor"); // CommonJS import + * const client = new MediaTailorClient(config); + * const command = new ListSourceLocationsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListSourceLocationsCommandInput} for command's `input` shape. + * @see {@link ListSourceLocationsCommandOutput} for command's `response` shape. + * @see {@link MediaTailorClientResolvedConfig | config} for command's `input` shape. + * */ export class ListSourceLocationsCommand extends $Command< ListSourceLocationsCommandInput, diff --git a/clients/client-mediatailor/commands/ListTagsForResourceCommand.ts b/clients/client-mediatailor/commands/ListTagsForResourceCommand.ts index d36c2607730e..608f4a1c8daf 100644 --- a/clients/client-mediatailor/commands/ListTagsForResourceCommand.ts +++ b/clients/client-mediatailor/commands/ListTagsForResourceCommand.ts @@ -22,6 +22,20 @@ export interface ListTagsForResourceCommandOutput extends ListTagsForResourceRes /** *

Returns a list of the tags assigned to the specified playback configuration resource.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { MediaTailorClient, ListTagsForResourceCommand } from "@aws-sdk/client-mediatailor"; // ES Modules import + * // const { MediaTailorClient, ListTagsForResourceCommand } = require("@aws-sdk/client-mediatailor"); // CommonJS import + * const client = new MediaTailorClient(config); + * const command = new ListTagsForResourceCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListTagsForResourceCommandInput} for command's `input` shape. + * @see {@link ListTagsForResourceCommandOutput} for command's `response` shape. + * @see {@link MediaTailorClientResolvedConfig | config} for command's `input` shape. + * */ export class ListTagsForResourceCommand extends $Command< ListTagsForResourceCommandInput, diff --git a/clients/client-mediatailor/commands/ListVodSourcesCommand.ts b/clients/client-mediatailor/commands/ListVodSourcesCommand.ts index ccfd4b1d884f..7c4835abe007 100644 --- a/clients/client-mediatailor/commands/ListVodSourcesCommand.ts +++ b/clients/client-mediatailor/commands/ListVodSourcesCommand.ts @@ -22,6 +22,20 @@ export interface ListVodSourcesCommandOutput extends ListVodSourcesResponse, __M /** *

Lists all the VOD sources in a source location.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { MediaTailorClient, ListVodSourcesCommand } from "@aws-sdk/client-mediatailor"; // ES Modules import + * // const { MediaTailorClient, ListVodSourcesCommand } = require("@aws-sdk/client-mediatailor"); // CommonJS import + * const client = new MediaTailorClient(config); + * const command = new ListVodSourcesCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListVodSourcesCommandInput} for command's `input` shape. + * @see {@link ListVodSourcesCommandOutput} for command's `response` shape. + * @see {@link MediaTailorClientResolvedConfig | config} for command's `input` shape. + * */ export class ListVodSourcesCommand extends $Command< ListVodSourcesCommandInput, diff --git a/clients/client-mediatailor/commands/PutChannelPolicyCommand.ts b/clients/client-mediatailor/commands/PutChannelPolicyCommand.ts index 029241738d46..12346021d567 100644 --- a/clients/client-mediatailor/commands/PutChannelPolicyCommand.ts +++ b/clients/client-mediatailor/commands/PutChannelPolicyCommand.ts @@ -22,6 +22,20 @@ export interface PutChannelPolicyCommandOutput extends PutChannelPolicyResponse, /** *

Creates an IAM policy for the channel.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { MediaTailorClient, PutChannelPolicyCommand } from "@aws-sdk/client-mediatailor"; // ES Modules import + * // const { MediaTailorClient, PutChannelPolicyCommand } = require("@aws-sdk/client-mediatailor"); // CommonJS import + * const client = new MediaTailorClient(config); + * const command = new PutChannelPolicyCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link PutChannelPolicyCommandInput} for command's `input` shape. + * @see {@link PutChannelPolicyCommandOutput} for command's `response` shape. + * @see {@link MediaTailorClientResolvedConfig | config} for command's `input` shape. + * */ export class PutChannelPolicyCommand extends $Command< PutChannelPolicyCommandInput, diff --git a/clients/client-mediatailor/commands/PutPlaybackConfigurationCommand.ts b/clients/client-mediatailor/commands/PutPlaybackConfigurationCommand.ts index 518da9082538..9e883ba497cb 100644 --- a/clients/client-mediatailor/commands/PutPlaybackConfigurationCommand.ts +++ b/clients/client-mediatailor/commands/PutPlaybackConfigurationCommand.ts @@ -22,6 +22,20 @@ export interface PutPlaybackConfigurationCommandOutput extends PutPlaybackConfig /** *

Adds a new playback configuration to AWS Elemental MediaTailor.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { MediaTailorClient, PutPlaybackConfigurationCommand } from "@aws-sdk/client-mediatailor"; // ES Modules import + * // const { MediaTailorClient, PutPlaybackConfigurationCommand } = require("@aws-sdk/client-mediatailor"); // CommonJS import + * const client = new MediaTailorClient(config); + * const command = new PutPlaybackConfigurationCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link PutPlaybackConfigurationCommandInput} for command's `input` shape. + * @see {@link PutPlaybackConfigurationCommandOutput} for command's `response` shape. + * @see {@link MediaTailorClientResolvedConfig | config} for command's `input` shape. + * */ export class PutPlaybackConfigurationCommand extends $Command< PutPlaybackConfigurationCommandInput, diff --git a/clients/client-mediatailor/commands/StartChannelCommand.ts b/clients/client-mediatailor/commands/StartChannelCommand.ts index a231d5b3bb17..3fca7e63931d 100644 --- a/clients/client-mediatailor/commands/StartChannelCommand.ts +++ b/clients/client-mediatailor/commands/StartChannelCommand.ts @@ -22,6 +22,20 @@ export interface StartChannelCommandOutput extends StartChannelResponse, __Metad /** *

Starts a specific channel.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { MediaTailorClient, StartChannelCommand } from "@aws-sdk/client-mediatailor"; // ES Modules import + * // const { MediaTailorClient, StartChannelCommand } = require("@aws-sdk/client-mediatailor"); // CommonJS import + * const client = new MediaTailorClient(config); + * const command = new StartChannelCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link StartChannelCommandInput} for command's `input` shape. + * @see {@link StartChannelCommandOutput} for command's `response` shape. + * @see {@link MediaTailorClientResolvedConfig | config} for command's `input` shape. + * */ export class StartChannelCommand extends $Command< StartChannelCommandInput, diff --git a/clients/client-mediatailor/commands/StopChannelCommand.ts b/clients/client-mediatailor/commands/StopChannelCommand.ts index 93fef2acd835..d56377bc14bf 100644 --- a/clients/client-mediatailor/commands/StopChannelCommand.ts +++ b/clients/client-mediatailor/commands/StopChannelCommand.ts @@ -22,6 +22,20 @@ export interface StopChannelCommandOutput extends StopChannelResponse, __Metadat /** *

Stops a specific channel.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { MediaTailorClient, StopChannelCommand } from "@aws-sdk/client-mediatailor"; // ES Modules import + * // const { MediaTailorClient, StopChannelCommand } = require("@aws-sdk/client-mediatailor"); // CommonJS import + * const client = new MediaTailorClient(config); + * const command = new StopChannelCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link StopChannelCommandInput} for command's `input` shape. + * @see {@link StopChannelCommandOutput} for command's `response` shape. + * @see {@link MediaTailorClientResolvedConfig | config} for command's `input` shape. + * */ export class StopChannelCommand extends $Command< StopChannelCommandInput, diff --git a/clients/client-mediatailor/commands/TagResourceCommand.ts b/clients/client-mediatailor/commands/TagResourceCommand.ts index 3481b88d54ea..82637ed2bbb5 100644 --- a/clients/client-mediatailor/commands/TagResourceCommand.ts +++ b/clients/client-mediatailor/commands/TagResourceCommand.ts @@ -22,6 +22,20 @@ export interface TagResourceCommandOutput extends __MetadataBearer {} /** *

Adds tags to the specified playback configuration resource. You can specify one or more tags to add.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { MediaTailorClient, TagResourceCommand } from "@aws-sdk/client-mediatailor"; // ES Modules import + * // const { MediaTailorClient, TagResourceCommand } = require("@aws-sdk/client-mediatailor"); // CommonJS import + * const client = new MediaTailorClient(config); + * const command = new TagResourceCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link TagResourceCommandInput} for command's `input` shape. + * @see {@link TagResourceCommandOutput} for command's `response` shape. + * @see {@link MediaTailorClientResolvedConfig | config} for command's `input` shape. + * */ export class TagResourceCommand extends $Command< TagResourceCommandInput, diff --git a/clients/client-mediatailor/commands/UntagResourceCommand.ts b/clients/client-mediatailor/commands/UntagResourceCommand.ts index 3c22feca081a..a60f6d6a203e 100644 --- a/clients/client-mediatailor/commands/UntagResourceCommand.ts +++ b/clients/client-mediatailor/commands/UntagResourceCommand.ts @@ -22,6 +22,20 @@ export interface UntagResourceCommandOutput extends __MetadataBearer {} /** *

Removes tags from the specified playback configuration resource. You can specify one or more tags to remove.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { MediaTailorClient, UntagResourceCommand } from "@aws-sdk/client-mediatailor"; // ES Modules import + * // const { MediaTailorClient, UntagResourceCommand } = require("@aws-sdk/client-mediatailor"); // CommonJS import + * const client = new MediaTailorClient(config); + * const command = new UntagResourceCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link UntagResourceCommandInput} for command's `input` shape. + * @see {@link UntagResourceCommandOutput} for command's `response` shape. + * @see {@link MediaTailorClientResolvedConfig | config} for command's `input` shape. + * */ export class UntagResourceCommand extends $Command< UntagResourceCommandInput, diff --git a/clients/client-mediatailor/commands/UpdateChannelCommand.ts b/clients/client-mediatailor/commands/UpdateChannelCommand.ts index 7dc8e9393fda..ebd325206d05 100644 --- a/clients/client-mediatailor/commands/UpdateChannelCommand.ts +++ b/clients/client-mediatailor/commands/UpdateChannelCommand.ts @@ -22,6 +22,20 @@ export interface UpdateChannelCommandOutput extends UpdateChannelResponse, __Met /** *

Updates an existing channel.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { MediaTailorClient, UpdateChannelCommand } from "@aws-sdk/client-mediatailor"; // ES Modules import + * // const { MediaTailorClient, UpdateChannelCommand } = require("@aws-sdk/client-mediatailor"); // CommonJS import + * const client = new MediaTailorClient(config); + * const command = new UpdateChannelCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link UpdateChannelCommandInput} for command's `input` shape. + * @see {@link UpdateChannelCommandOutput} for command's `response` shape. + * @see {@link MediaTailorClientResolvedConfig | config} for command's `input` shape. + * */ export class UpdateChannelCommand extends $Command< UpdateChannelCommandInput, diff --git a/clients/client-mediatailor/commands/UpdateSourceLocationCommand.ts b/clients/client-mediatailor/commands/UpdateSourceLocationCommand.ts index 6680c6438eae..c42b21616dfb 100644 --- a/clients/client-mediatailor/commands/UpdateSourceLocationCommand.ts +++ b/clients/client-mediatailor/commands/UpdateSourceLocationCommand.ts @@ -22,6 +22,20 @@ export interface UpdateSourceLocationCommandOutput extends UpdateSourceLocationR /** *

Updates a source location on a specific channel.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { MediaTailorClient, UpdateSourceLocationCommand } from "@aws-sdk/client-mediatailor"; // ES Modules import + * // const { MediaTailorClient, UpdateSourceLocationCommand } = require("@aws-sdk/client-mediatailor"); // CommonJS import + * const client = new MediaTailorClient(config); + * const command = new UpdateSourceLocationCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link UpdateSourceLocationCommandInput} for command's `input` shape. + * @see {@link UpdateSourceLocationCommandOutput} for command's `response` shape. + * @see {@link MediaTailorClientResolvedConfig | config} for command's `input` shape. + * */ export class UpdateSourceLocationCommand extends $Command< UpdateSourceLocationCommandInput, diff --git a/clients/client-mediatailor/commands/UpdateVodSourceCommand.ts b/clients/client-mediatailor/commands/UpdateVodSourceCommand.ts index 8e2c5a6293e4..52145b2994a0 100644 --- a/clients/client-mediatailor/commands/UpdateVodSourceCommand.ts +++ b/clients/client-mediatailor/commands/UpdateVodSourceCommand.ts @@ -22,6 +22,20 @@ export interface UpdateVodSourceCommandOutput extends UpdateVodSourceResponse, _ /** *

Updates a specific VOD source in a specific source location.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { MediaTailorClient, UpdateVodSourceCommand } from "@aws-sdk/client-mediatailor"; // ES Modules import + * // const { MediaTailorClient, UpdateVodSourceCommand } = require("@aws-sdk/client-mediatailor"); // CommonJS import + * const client = new MediaTailorClient(config); + * const command = new UpdateVodSourceCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link UpdateVodSourceCommandInput} for command's `input` shape. + * @see {@link UpdateVodSourceCommandOutput} for command's `response` shape. + * @see {@link MediaTailorClientResolvedConfig | config} for command's `input` shape. + * */ export class UpdateVodSourceCommand extends $Command< UpdateVodSourceCommandInput, diff --git a/clients/client-mediatailor/models/models_0.ts b/clients/client-mediatailor/models/models_0.ts index 624085ee1da6..6d353ff0af9e 100644 --- a/clients/client-mediatailor/models/models_0.ts +++ b/clients/client-mediatailor/models/models_0.ts @@ -21,6 +21,9 @@ export interface SlateSource { } export namespace SlateSource { + /** + * @internal + */ export const filterSensitiveLog = (obj: SlateSource): any => ({ ...obj, }); @@ -52,6 +55,9 @@ export interface SpliceInsertMessage { } export namespace SpliceInsertMessage { + /** + * @internal + */ export const filterSensitiveLog = (obj: SpliceInsertMessage): any => ({ ...obj, }); @@ -83,6 +89,9 @@ export interface AdBreak { } export namespace AdBreak { + /** + * @internal + */ export const filterSensitiveLog = (obj: AdBreak): any => ({ ...obj, }); @@ -114,6 +123,9 @@ export interface DashPlaylistSettings { } export namespace DashPlaylistSettings { + /** + * @internal + */ export const filterSensitiveLog = (obj: DashPlaylistSettings): any => ({ ...obj, }); @@ -130,6 +142,9 @@ export interface HlsPlaylistSettings { } export namespace HlsPlaylistSettings { + /** + * @internal + */ export const filterSensitiveLog = (obj: HlsPlaylistSettings): any => ({ ...obj, }); @@ -166,6 +181,9 @@ export interface ResponseOutputItem { } export namespace ResponseOutputItem { + /** + * @internal + */ export const filterSensitiveLog = (obj: ResponseOutputItem): any => ({ ...obj, }); @@ -217,6 +235,9 @@ export interface Channel { } export namespace Channel { + /** + * @internal + */ export const filterSensitiveLog = (obj: Channel): any => ({ ...obj, }); @@ -243,6 +264,9 @@ export interface AvailSuppression { } export namespace AvailSuppression { + /** + * @internal + */ export const filterSensitiveLog = (obj: AvailSuppression): any => ({ ...obj, }); @@ -264,6 +288,9 @@ export interface Bumper { } export namespace Bumper { + /** + * @internal + */ export const filterSensitiveLog = (obj: Bumper): any => ({ ...obj, }); @@ -285,6 +312,9 @@ export interface CdnConfiguration { } export namespace CdnConfiguration { + /** + * @internal + */ export const filterSensitiveLog = (obj: CdnConfiguration): any => ({ ...obj, }); @@ -316,6 +346,9 @@ export interface DashConfiguration { } export namespace DashConfiguration { + /** + * @internal + */ export const filterSensitiveLog = (obj: DashConfiguration): any => ({ ...obj, }); @@ -332,6 +365,9 @@ export interface HlsConfiguration { } export namespace HlsConfiguration { + /** + * @internal + */ export const filterSensitiveLog = (obj: HlsConfiguration): any => ({ ...obj, }); @@ -353,6 +389,9 @@ export interface LivePreRollConfiguration { } export namespace LivePreRollConfiguration { + /** + * @internal + */ export const filterSensitiveLog = (obj: LivePreRollConfiguration): any => ({ ...obj, }); @@ -369,6 +408,9 @@ export interface AdMarkerPassthrough { } export namespace AdMarkerPassthrough { + /** + * @internal + */ export const filterSensitiveLog = (obj: AdMarkerPassthrough): any => ({ ...obj, }); @@ -385,6 +427,9 @@ export interface ManifestProcessingRules { } export namespace ManifestProcessingRules { + /** + * @internal + */ export const filterSensitiveLog = (obj: ManifestProcessingRules): any => ({ ...obj, }); @@ -486,6 +531,9 @@ export interface PlaybackConfiguration { } export namespace PlaybackConfiguration { + /** + * @internal + */ export const filterSensitiveLog = (obj: PlaybackConfiguration): any => ({ ...obj, }); @@ -532,6 +580,9 @@ export interface ScheduleEntry { } export namespace ScheduleEntry { + /** + * @internal + */ export const filterSensitiveLog = (obj: ScheduleEntry): any => ({ ...obj, }); @@ -552,6 +603,9 @@ export interface AccessConfiguration { } export namespace AccessConfiguration { + /** + * @internal + */ export const filterSensitiveLog = (obj: AccessConfiguration): any => ({ ...obj, }); @@ -568,6 +622,9 @@ export interface DefaultSegmentDeliveryConfiguration { } export namespace DefaultSegmentDeliveryConfiguration { + /** + * @internal + */ export const filterSensitiveLog = (obj: DefaultSegmentDeliveryConfiguration): any => ({ ...obj, }); @@ -584,6 +641,9 @@ export interface HttpConfiguration { } export namespace HttpConfiguration { + /** + * @internal + */ export const filterSensitiveLog = (obj: HttpConfiguration): any => ({ ...obj, }); @@ -635,6 +695,9 @@ export interface SourceLocation { } export namespace SourceLocation { + /** + * @internal + */ export const filterSensitiveLog = (obj: SourceLocation): any => ({ ...obj, }); @@ -666,6 +729,9 @@ export interface HttpPackageConfiguration { } export namespace HttpPackageConfiguration { + /** + * @internal + */ export const filterSensitiveLog = (obj: HttpPackageConfiguration): any => ({ ...obj, }); @@ -712,6 +778,9 @@ export interface VodSource { } export namespace VodSource { + /** + * @internal + */ export const filterSensitiveLog = (obj: VodSource): any => ({ ...obj, }); @@ -727,6 +796,9 @@ export interface BadRequestException extends __SmithyException, $MetadataBearer } export namespace BadRequestException { + /** + * @internal + */ export const filterSensitiveLog = (obj: BadRequestException): any => ({ ...obj, }); @@ -763,6 +835,9 @@ export interface RequestOutputItem { } export namespace RequestOutputItem { + /** + * @internal + */ export const filterSensitiveLog = (obj: RequestOutputItem): any => ({ ...obj, }); @@ -795,6 +870,9 @@ export interface CreateChannelRequest { } export namespace CreateChannelRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateChannelRequest): any => ({ ...obj, }); @@ -843,6 +921,9 @@ export interface CreateChannelResponse { } export namespace CreateChannelResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateChannelResponse): any => ({ ...obj, }); @@ -874,6 +955,9 @@ export interface Transition { } export namespace Transition { + /** + * @internal + */ export const filterSensitiveLog = (obj: Transition): any => ({ ...obj, }); @@ -890,6 +974,9 @@ export interface ScheduleConfiguration { } export namespace ScheduleConfiguration { + /** + * @internal + */ export const filterSensitiveLog = (obj: ScheduleConfiguration): any => ({ ...obj, }); @@ -928,6 +1015,9 @@ export interface CreateProgramRequest { } export namespace CreateProgramRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateProgramRequest): any => ({ ...obj, }); @@ -971,6 +1061,9 @@ export interface CreateProgramResponse { } export namespace CreateProgramResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateProgramResponse): any => ({ ...obj, }); @@ -1004,6 +1097,9 @@ export interface CreateSourceLocationRequest { } export namespace CreateSourceLocationRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateSourceLocationRequest): any => ({ ...obj, }); @@ -1052,6 +1148,9 @@ export interface CreateSourceLocationResponse { } export namespace CreateSourceLocationResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateSourceLocationResponse): any => ({ ...obj, }); @@ -1080,6 +1179,9 @@ export interface CreateVodSourceRequest { } export namespace CreateVodSourceRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateVodSourceRequest): any => ({ ...obj, }); @@ -1123,6 +1225,9 @@ export interface CreateVodSourceResponse { } export namespace CreateVodSourceResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateVodSourceResponse): any => ({ ...obj, }); @@ -1144,6 +1249,9 @@ export interface DashConfigurationForPut { } export namespace DashConfigurationForPut { + /** + * @internal + */ export const filterSensitiveLog = (obj: DashConfigurationForPut): any => ({ ...obj, }); @@ -1157,6 +1265,9 @@ export interface DeleteChannelRequest { } export namespace DeleteChannelRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteChannelRequest): any => ({ ...obj, }); @@ -1165,6 +1276,9 @@ export namespace DeleteChannelRequest { export interface DeleteChannelResponse {} export namespace DeleteChannelResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteChannelResponse): any => ({ ...obj, }); @@ -1178,6 +1292,9 @@ export interface DeleteChannelPolicyRequest { } export namespace DeleteChannelPolicyRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteChannelPolicyRequest): any => ({ ...obj, }); @@ -1186,6 +1303,9 @@ export namespace DeleteChannelPolicyRequest { export interface DeleteChannelPolicyResponse {} export namespace DeleteChannelPolicyResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteChannelPolicyResponse): any => ({ ...obj, }); @@ -1199,6 +1319,9 @@ export interface DeletePlaybackConfigurationRequest { } export namespace DeletePlaybackConfigurationRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeletePlaybackConfigurationRequest): any => ({ ...obj, }); @@ -1207,6 +1330,9 @@ export namespace DeletePlaybackConfigurationRequest { export interface DeletePlaybackConfigurationResponse {} export namespace DeletePlaybackConfigurationResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeletePlaybackConfigurationResponse): any => ({ ...obj, }); @@ -1225,6 +1351,9 @@ export interface DeleteProgramRequest { } export namespace DeleteProgramRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteProgramRequest): any => ({ ...obj, }); @@ -1233,6 +1362,9 @@ export namespace DeleteProgramRequest { export interface DeleteProgramResponse {} export namespace DeleteProgramResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteProgramResponse): any => ({ ...obj, }); @@ -1246,6 +1378,9 @@ export interface DeleteSourceLocationRequest { } export namespace DeleteSourceLocationRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteSourceLocationRequest): any => ({ ...obj, }); @@ -1254,6 +1389,9 @@ export namespace DeleteSourceLocationRequest { export interface DeleteSourceLocationResponse {} export namespace DeleteSourceLocationResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteSourceLocationResponse): any => ({ ...obj, }); @@ -1272,6 +1410,9 @@ export interface DeleteVodSourceRequest { } export namespace DeleteVodSourceRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteVodSourceRequest): any => ({ ...obj, }); @@ -1280,6 +1421,9 @@ export namespace DeleteVodSourceRequest { export interface DeleteVodSourceResponse {} export namespace DeleteVodSourceResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteVodSourceResponse): any => ({ ...obj, }); @@ -1293,6 +1437,9 @@ export interface DescribeChannelRequest { } export namespace DescribeChannelRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeChannelRequest): any => ({ ...obj, }); @@ -1341,6 +1488,9 @@ export interface DescribeChannelResponse { } export namespace DescribeChannelResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeChannelResponse): any => ({ ...obj, }); @@ -1359,6 +1509,9 @@ export interface DescribeProgramRequest { } export namespace DescribeProgramRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeProgramRequest): any => ({ ...obj, }); @@ -1402,6 +1555,9 @@ export interface DescribeProgramResponse { } export namespace DescribeProgramResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeProgramResponse): any => ({ ...obj, }); @@ -1415,6 +1571,9 @@ export interface DescribeSourceLocationRequest { } export namespace DescribeSourceLocationRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeSourceLocationRequest): any => ({ ...obj, }); @@ -1463,6 +1622,9 @@ export interface DescribeSourceLocationResponse { } export namespace DescribeSourceLocationResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeSourceLocationResponse): any => ({ ...obj, }); @@ -1481,6 +1643,9 @@ export interface DescribeVodSourceRequest { } export namespace DescribeVodSourceRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeVodSourceRequest): any => ({ ...obj, }); @@ -1524,6 +1689,9 @@ export interface DescribeVodSourceResponse { } export namespace DescribeVodSourceResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeVodSourceResponse): any => ({ ...obj, }); @@ -1537,6 +1705,9 @@ export interface GetChannelPolicyRequest { } export namespace GetChannelPolicyRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetChannelPolicyRequest): any => ({ ...obj, }); @@ -1550,6 +1721,9 @@ export interface GetChannelPolicyResponse { } export namespace GetChannelPolicyResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetChannelPolicyResponse): any => ({ ...obj, }); @@ -1578,6 +1752,9 @@ export interface GetChannelScheduleRequest { } export namespace GetChannelScheduleRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetChannelScheduleRequest): any => ({ ...obj, }); @@ -1596,6 +1773,9 @@ export interface GetChannelScheduleResponse { } export namespace GetChannelScheduleResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetChannelScheduleResponse): any => ({ ...obj, }); @@ -1609,6 +1789,9 @@ export interface GetPlaybackConfigurationRequest { } export namespace GetPlaybackConfigurationRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetPlaybackConfigurationRequest): any => ({ ...obj, }); @@ -1707,6 +1890,9 @@ export interface GetPlaybackConfigurationResponse { } export namespace GetPlaybackConfigurationResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetPlaybackConfigurationResponse): any => ({ ...obj, }); @@ -1725,6 +1911,9 @@ export interface ListChannelsRequest { } export namespace ListChannelsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListChannelsRequest): any => ({ ...obj, }); @@ -1743,6 +1932,9 @@ export interface ListChannelsResponse { } export namespace ListChannelsResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListChannelsResponse): any => ({ ...obj, }); @@ -1761,6 +1953,9 @@ export interface ListPlaybackConfigurationsRequest { } export namespace ListPlaybackConfigurationsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListPlaybackConfigurationsRequest): any => ({ ...obj, }); @@ -1779,6 +1974,9 @@ export interface ListPlaybackConfigurationsResponse { } export namespace ListPlaybackConfigurationsResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListPlaybackConfigurationsResponse): any => ({ ...obj, }); @@ -1797,6 +1995,9 @@ export interface ListSourceLocationsRequest { } export namespace ListSourceLocationsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListSourceLocationsRequest): any => ({ ...obj, }); @@ -1815,6 +2016,9 @@ export interface ListSourceLocationsResponse { } export namespace ListSourceLocationsResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListSourceLocationsResponse): any => ({ ...obj, }); @@ -1828,6 +2032,9 @@ export interface ListTagsForResourceRequest { } export namespace ListTagsForResourceRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListTagsForResourceRequest): any => ({ ...obj, }); @@ -1841,6 +2048,9 @@ export interface ListTagsForResourceResponse { } export namespace ListTagsForResourceResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListTagsForResourceResponse): any => ({ ...obj, }); @@ -1864,6 +2074,9 @@ export interface ListVodSourcesRequest { } export namespace ListVodSourcesRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListVodSourcesRequest): any => ({ ...obj, }); @@ -1882,6 +2095,9 @@ export interface ListVodSourcesResponse { } export namespace ListVodSourcesResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListVodSourcesResponse): any => ({ ...obj, }); @@ -1900,6 +2116,9 @@ export interface PutChannelPolicyRequest { } export namespace PutChannelPolicyRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: PutChannelPolicyRequest): any => ({ ...obj, }); @@ -1908,6 +2127,9 @@ export namespace PutChannelPolicyRequest { export interface PutChannelPolicyResponse {} export namespace PutChannelPolicyResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: PutChannelPolicyResponse): any => ({ ...obj, }); @@ -1986,6 +2208,9 @@ export interface PutPlaybackConfigurationRequest { } export namespace PutPlaybackConfigurationRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: PutPlaybackConfigurationRequest): any => ({ ...obj, }); @@ -2084,6 +2309,9 @@ export interface PutPlaybackConfigurationResponse { } export namespace PutPlaybackConfigurationResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: PutPlaybackConfigurationResponse): any => ({ ...obj, }); @@ -2097,6 +2325,9 @@ export interface StartChannelRequest { } export namespace StartChannelRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: StartChannelRequest): any => ({ ...obj, }); @@ -2105,6 +2336,9 @@ export namespace StartChannelRequest { export interface StartChannelResponse {} export namespace StartChannelResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: StartChannelResponse): any => ({ ...obj, }); @@ -2118,6 +2352,9 @@ export interface StopChannelRequest { } export namespace StopChannelRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: StopChannelRequest): any => ({ ...obj, }); @@ -2126,6 +2363,9 @@ export namespace StopChannelRequest { export interface StopChannelResponse {} export namespace StopChannelResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: StopChannelResponse): any => ({ ...obj, }); @@ -2144,6 +2384,9 @@ export interface TagResourceRequest { } export namespace TagResourceRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: TagResourceRequest): any => ({ ...obj, }); @@ -2162,6 +2405,9 @@ export interface UntagResourceRequest { } export namespace UntagResourceRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: UntagResourceRequest): any => ({ ...obj, }); @@ -2180,6 +2426,9 @@ export interface UpdateChannelRequest { } export namespace UpdateChannelRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateChannelRequest): any => ({ ...obj, }); @@ -2228,6 +2477,9 @@ export interface UpdateChannelResponse { } export namespace UpdateChannelResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateChannelResponse): any => ({ ...obj, }); @@ -2256,6 +2508,9 @@ export interface UpdateSourceLocationRequest { } export namespace UpdateSourceLocationRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateSourceLocationRequest): any => ({ ...obj, }); @@ -2304,6 +2559,9 @@ export interface UpdateSourceLocationResponse { } export namespace UpdateSourceLocationResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateSourceLocationResponse): any => ({ ...obj, }); @@ -2327,6 +2585,9 @@ export interface UpdateVodSourceRequest { } export namespace UpdateVodSourceRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateVodSourceRequest): any => ({ ...obj, }); @@ -2370,6 +2631,9 @@ export interface UpdateVodSourceResponse { } export namespace UpdateVodSourceResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateVodSourceResponse): any => ({ ...obj, }); diff --git a/clients/client-mgn/commands/ChangeServerLifeCycleStateCommand.ts b/clients/client-mgn/commands/ChangeServerLifeCycleStateCommand.ts index 67be3af25186..75747e1e0085 100644 --- a/clients/client-mgn/commands/ChangeServerLifeCycleStateCommand.ts +++ b/clients/client-mgn/commands/ChangeServerLifeCycleStateCommand.ts @@ -22,6 +22,20 @@ export interface ChangeServerLifeCycleStateCommandOutput extends SourceServer, _ /** *

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.)

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { MgnClient, ChangeServerLifeCycleStateCommand } from "@aws-sdk/client-mgn"; // ES Modules import + * // const { MgnClient, ChangeServerLifeCycleStateCommand } = require("@aws-sdk/client-mgn"); // CommonJS import + * const client = new MgnClient(config); + * const command = new ChangeServerLifeCycleStateCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ChangeServerLifeCycleStateCommandInput} for command's `input` shape. + * @see {@link ChangeServerLifeCycleStateCommandOutput} for command's `response` shape. + * @see {@link MgnClientResolvedConfig | config} for command's `input` shape. + * */ export class ChangeServerLifeCycleStateCommand extends $Command< ChangeServerLifeCycleStateCommandInput, diff --git a/clients/client-mgn/commands/CreateReplicationConfigurationTemplateCommand.ts b/clients/client-mgn/commands/CreateReplicationConfigurationTemplateCommand.ts index f1df6eb10769..d560bed05253 100644 --- a/clients/client-mgn/commands/CreateReplicationConfigurationTemplateCommand.ts +++ b/clients/client-mgn/commands/CreateReplicationConfigurationTemplateCommand.ts @@ -25,6 +25,20 @@ export interface CreateReplicationConfigurationTemplateCommandOutput /** *

Creates a new ReplicationConfigurationTemplate.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { MgnClient, CreateReplicationConfigurationTemplateCommand } from "@aws-sdk/client-mgn"; // ES Modules import + * // const { MgnClient, CreateReplicationConfigurationTemplateCommand } = require("@aws-sdk/client-mgn"); // CommonJS import + * const client = new MgnClient(config); + * const command = new CreateReplicationConfigurationTemplateCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreateReplicationConfigurationTemplateCommandInput} for command's `input` shape. + * @see {@link CreateReplicationConfigurationTemplateCommandOutput} for command's `response` shape. + * @see {@link MgnClientResolvedConfig | config} for command's `input` shape. + * */ export class CreateReplicationConfigurationTemplateCommand extends $Command< CreateReplicationConfigurationTemplateCommandInput, diff --git a/clients/client-mgn/commands/DeleteJobCommand.ts b/clients/client-mgn/commands/DeleteJobCommand.ts index 6b291d0a1902..8b5d5a126e21 100644 --- a/clients/client-mgn/commands/DeleteJobCommand.ts +++ b/clients/client-mgn/commands/DeleteJobCommand.ts @@ -22,6 +22,20 @@ export interface DeleteJobCommandOutput extends DeleteJobResponse, __MetadataBea /** *

Deletes a single Job by ID.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { MgnClient, DeleteJobCommand } from "@aws-sdk/client-mgn"; // ES Modules import + * // const { MgnClient, DeleteJobCommand } = require("@aws-sdk/client-mgn"); // CommonJS import + * const client = new MgnClient(config); + * const command = new DeleteJobCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteJobCommandInput} for command's `input` shape. + * @see {@link DeleteJobCommandOutput} for command's `response` shape. + * @see {@link MgnClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteJobCommand extends $Command { // Start section: command_properties diff --git a/clients/client-mgn/commands/DeleteReplicationConfigurationTemplateCommand.ts b/clients/client-mgn/commands/DeleteReplicationConfigurationTemplateCommand.ts index d9a002806a0e..adcc0e914e7e 100644 --- a/clients/client-mgn/commands/DeleteReplicationConfigurationTemplateCommand.ts +++ b/clients/client-mgn/commands/DeleteReplicationConfigurationTemplateCommand.ts @@ -28,6 +28,20 @@ export interface DeleteReplicationConfigurationTemplateCommandOutput /** *

Deletes a single Replication Configuration Template by ID

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { MgnClient, DeleteReplicationConfigurationTemplateCommand } from "@aws-sdk/client-mgn"; // ES Modules import + * // const { MgnClient, DeleteReplicationConfigurationTemplateCommand } = require("@aws-sdk/client-mgn"); // CommonJS import + * const client = new MgnClient(config); + * const command = new DeleteReplicationConfigurationTemplateCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteReplicationConfigurationTemplateCommandInput} for command's `input` shape. + * @see {@link DeleteReplicationConfigurationTemplateCommandOutput} for command's `response` shape. + * @see {@link MgnClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteReplicationConfigurationTemplateCommand extends $Command< DeleteReplicationConfigurationTemplateCommandInput, diff --git a/clients/client-mgn/commands/DeleteSourceServerCommand.ts b/clients/client-mgn/commands/DeleteSourceServerCommand.ts index a0426c38f182..679ce483ece1 100644 --- a/clients/client-mgn/commands/DeleteSourceServerCommand.ts +++ b/clients/client-mgn/commands/DeleteSourceServerCommand.ts @@ -22,6 +22,20 @@ export interface DeleteSourceServerCommandOutput extends DeleteSourceServerRespo /** *

Deletes a single source server by ID.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { MgnClient, DeleteSourceServerCommand } from "@aws-sdk/client-mgn"; // ES Modules import + * // const { MgnClient, DeleteSourceServerCommand } = require("@aws-sdk/client-mgn"); // CommonJS import + * const client = new MgnClient(config); + * const command = new DeleteSourceServerCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteSourceServerCommandInput} for command's `input` shape. + * @see {@link DeleteSourceServerCommandOutput} for command's `response` shape. + * @see {@link MgnClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteSourceServerCommand extends $Command< DeleteSourceServerCommandInput, diff --git a/clients/client-mgn/commands/DescribeJobLogItemsCommand.ts b/clients/client-mgn/commands/DescribeJobLogItemsCommand.ts index f0ec9dbe7d2d..e64fe180811b 100644 --- a/clients/client-mgn/commands/DescribeJobLogItemsCommand.ts +++ b/clients/client-mgn/commands/DescribeJobLogItemsCommand.ts @@ -22,6 +22,20 @@ export interface DescribeJobLogItemsCommandOutput extends DescribeJobLogItemsRes /** *

Retrieves detailed Job log with paging.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { MgnClient, DescribeJobLogItemsCommand } from "@aws-sdk/client-mgn"; // ES Modules import + * // const { MgnClient, DescribeJobLogItemsCommand } = require("@aws-sdk/client-mgn"); // CommonJS import + * const client = new MgnClient(config); + * const command = new DescribeJobLogItemsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeJobLogItemsCommandInput} for command's `input` shape. + * @see {@link DescribeJobLogItemsCommandOutput} for command's `response` shape. + * @see {@link MgnClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeJobLogItemsCommand extends $Command< DescribeJobLogItemsCommandInput, diff --git a/clients/client-mgn/commands/DescribeJobsCommand.ts b/clients/client-mgn/commands/DescribeJobsCommand.ts index 899097b2b0d7..2c51ed542b51 100644 --- a/clients/client-mgn/commands/DescribeJobsCommand.ts +++ b/clients/client-mgn/commands/DescribeJobsCommand.ts @@ -22,6 +22,20 @@ export interface DescribeJobsCommandOutput extends DescribeJobsResponse, __Metad /** *

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 normaly 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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { MgnClient, DescribeJobsCommand } from "@aws-sdk/client-mgn"; // ES Modules import + * // const { MgnClient, DescribeJobsCommand } = require("@aws-sdk/client-mgn"); // CommonJS import + * const client = new MgnClient(config); + * const command = new DescribeJobsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeJobsCommandInput} for command's `input` shape. + * @see {@link DescribeJobsCommandOutput} for command's `response` shape. + * @see {@link MgnClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeJobsCommand extends $Command< DescribeJobsCommandInput, diff --git a/clients/client-mgn/commands/DescribeReplicationConfigurationTemplatesCommand.ts b/clients/client-mgn/commands/DescribeReplicationConfigurationTemplatesCommand.ts index 5b727349508d..55cdd91c550c 100644 --- a/clients/client-mgn/commands/DescribeReplicationConfigurationTemplatesCommand.ts +++ b/clients/client-mgn/commands/DescribeReplicationConfigurationTemplatesCommand.ts @@ -28,6 +28,20 @@ export interface DescribeReplicationConfigurationTemplatesCommandOutput /** *

Lists all ReplicationConfigurationTemplates, filtered by Source Server IDs.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { MgnClient, DescribeReplicationConfigurationTemplatesCommand } from "@aws-sdk/client-mgn"; // ES Modules import + * // const { MgnClient, DescribeReplicationConfigurationTemplatesCommand } = require("@aws-sdk/client-mgn"); // CommonJS import + * const client = new MgnClient(config); + * const command = new DescribeReplicationConfigurationTemplatesCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeReplicationConfigurationTemplatesCommandInput} for command's `input` shape. + * @see {@link DescribeReplicationConfigurationTemplatesCommandOutput} for command's `response` shape. + * @see {@link MgnClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeReplicationConfigurationTemplatesCommand extends $Command< DescribeReplicationConfigurationTemplatesCommandInput, diff --git a/clients/client-mgn/commands/DescribeSourceServersCommand.ts b/clients/client-mgn/commands/DescribeSourceServersCommand.ts index 2518218fced9..575a8f4699c0 100644 --- a/clients/client-mgn/commands/DescribeSourceServersCommand.ts +++ b/clients/client-mgn/commands/DescribeSourceServersCommand.ts @@ -22,6 +22,20 @@ export interface DescribeSourceServersCommandOutput extends DescribeSourceServer /** *

Retrieves all SourceServers or multiple SourceServers by ID.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { MgnClient, DescribeSourceServersCommand } from "@aws-sdk/client-mgn"; // ES Modules import + * // const { MgnClient, DescribeSourceServersCommand } = require("@aws-sdk/client-mgn"); // CommonJS import + * const client = new MgnClient(config); + * const command = new DescribeSourceServersCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeSourceServersCommandInput} for command's `input` shape. + * @see {@link DescribeSourceServersCommandOutput} for command's `response` shape. + * @see {@link MgnClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeSourceServersCommand extends $Command< DescribeSourceServersCommandInput, diff --git a/clients/client-mgn/commands/DisconnectFromServiceCommand.ts b/clients/client-mgn/commands/DisconnectFromServiceCommand.ts index bf78abbdf8ba..933b97b1cceb 100644 --- a/clients/client-mgn/commands/DisconnectFromServiceCommand.ts +++ b/clients/client-mgn/commands/DisconnectFromServiceCommand.ts @@ -22,6 +22,20 @@ export interface DisconnectFromServiceCommandOutput extends SourceServer, __Meta /** *

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 communciating 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.lagDurationwill be nullified.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { MgnClient, DisconnectFromServiceCommand } from "@aws-sdk/client-mgn"; // ES Modules import + * // const { MgnClient, DisconnectFromServiceCommand } = require("@aws-sdk/client-mgn"); // CommonJS import + * const client = new MgnClient(config); + * const command = new DisconnectFromServiceCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DisconnectFromServiceCommandInput} for command's `input` shape. + * @see {@link DisconnectFromServiceCommandOutput} for command's `response` shape. + * @see {@link MgnClientResolvedConfig | config} for command's `input` shape. + * */ export class DisconnectFromServiceCommand extends $Command< DisconnectFromServiceCommandInput, diff --git a/clients/client-mgn/commands/FinalizeCutoverCommand.ts b/clients/client-mgn/commands/FinalizeCutoverCommand.ts index 3b63db74f78d..e8159c37b313 100644 --- a/clients/client-mgn/commands/FinalizeCutoverCommand.ts +++ b/clients/client-mgn/commands/FinalizeCutoverCommand.ts @@ -22,6 +22,20 @@ export interface FinalizeCutoverCommandOutput extends SourceServer, __MetadataBe /** *

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 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.lagDurationwill be nullified.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { MgnClient, FinalizeCutoverCommand } from "@aws-sdk/client-mgn"; // ES Modules import + * // const { MgnClient, FinalizeCutoverCommand } = require("@aws-sdk/client-mgn"); // CommonJS import + * const client = new MgnClient(config); + * const command = new FinalizeCutoverCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link FinalizeCutoverCommandInput} for command's `input` shape. + * @see {@link FinalizeCutoverCommandOutput} for command's `response` shape. + * @see {@link MgnClientResolvedConfig | config} for command's `input` shape. + * */ export class FinalizeCutoverCommand extends $Command< FinalizeCutoverCommandInput, diff --git a/clients/client-mgn/commands/GetLaunchConfigurationCommand.ts b/clients/client-mgn/commands/GetLaunchConfigurationCommand.ts index 9bab8d2cdebc..a2684fa37902 100644 --- a/clients/client-mgn/commands/GetLaunchConfigurationCommand.ts +++ b/clients/client-mgn/commands/GetLaunchConfigurationCommand.ts @@ -22,6 +22,20 @@ export interface GetLaunchConfigurationCommandOutput extends LaunchConfiguration /** *

Lists all LaunchConfigurations available, filtered by Source Server IDs.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { MgnClient, GetLaunchConfigurationCommand } from "@aws-sdk/client-mgn"; // ES Modules import + * // const { MgnClient, GetLaunchConfigurationCommand } = require("@aws-sdk/client-mgn"); // CommonJS import + * const client = new MgnClient(config); + * const command = new GetLaunchConfigurationCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetLaunchConfigurationCommandInput} for command's `input` shape. + * @see {@link GetLaunchConfigurationCommandOutput} for command's `response` shape. + * @see {@link MgnClientResolvedConfig | config} for command's `input` shape. + * */ export class GetLaunchConfigurationCommand extends $Command< GetLaunchConfigurationCommandInput, diff --git a/clients/client-mgn/commands/GetReplicationConfigurationCommand.ts b/clients/client-mgn/commands/GetReplicationConfigurationCommand.ts index b5669223df03..b58f0f1632b8 100644 --- a/clients/client-mgn/commands/GetReplicationConfigurationCommand.ts +++ b/clients/client-mgn/commands/GetReplicationConfigurationCommand.ts @@ -22,6 +22,20 @@ export interface GetReplicationConfigurationCommandOutput extends ReplicationCon /** *

Lists all ReplicationConfigurations, filtered by Source Server ID.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { MgnClient, GetReplicationConfigurationCommand } from "@aws-sdk/client-mgn"; // ES Modules import + * // const { MgnClient, GetReplicationConfigurationCommand } = require("@aws-sdk/client-mgn"); // CommonJS import + * const client = new MgnClient(config); + * const command = new GetReplicationConfigurationCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetReplicationConfigurationCommandInput} for command's `input` shape. + * @see {@link GetReplicationConfigurationCommandOutput} for command's `response` shape. + * @see {@link MgnClientResolvedConfig | config} for command's `input` shape. + * */ export class GetReplicationConfigurationCommand extends $Command< GetReplicationConfigurationCommandInput, diff --git a/clients/client-mgn/commands/InitializeServiceCommand.ts b/clients/client-mgn/commands/InitializeServiceCommand.ts index 7f5e40bd5b9f..7ac47bf66077 100644 --- a/clients/client-mgn/commands/InitializeServiceCommand.ts +++ b/clients/client-mgn/commands/InitializeServiceCommand.ts @@ -22,6 +22,20 @@ export interface InitializeServiceCommandOutput extends InitializeServiceRespons /** *

Initialize Application Migration Service.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { MgnClient, InitializeServiceCommand } from "@aws-sdk/client-mgn"; // ES Modules import + * // const { MgnClient, InitializeServiceCommand } = require("@aws-sdk/client-mgn"); // CommonJS import + * const client = new MgnClient(config); + * const command = new InitializeServiceCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link InitializeServiceCommandInput} for command's `input` shape. + * @see {@link InitializeServiceCommandOutput} for command's `response` shape. + * @see {@link MgnClientResolvedConfig | config} for command's `input` shape. + * */ export class InitializeServiceCommand extends $Command< InitializeServiceCommandInput, diff --git a/clients/client-mgn/commands/ListTagsForResourceCommand.ts b/clients/client-mgn/commands/ListTagsForResourceCommand.ts index a364a40c7acb..c44334b53a97 100644 --- a/clients/client-mgn/commands/ListTagsForResourceCommand.ts +++ b/clients/client-mgn/commands/ListTagsForResourceCommand.ts @@ -22,6 +22,20 @@ export interface ListTagsForResourceCommandOutput extends ListTagsForResourceRes /** *

List all tags for your Application Migration Service resources.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { MgnClient, ListTagsForResourceCommand } from "@aws-sdk/client-mgn"; // ES Modules import + * // const { MgnClient, ListTagsForResourceCommand } = require("@aws-sdk/client-mgn"); // CommonJS import + * const client = new MgnClient(config); + * const command = new ListTagsForResourceCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListTagsForResourceCommandInput} for command's `input` shape. + * @see {@link ListTagsForResourceCommandOutput} for command's `response` shape. + * @see {@link MgnClientResolvedConfig | config} for command's `input` shape. + * */ export class ListTagsForResourceCommand extends $Command< ListTagsForResourceCommandInput, diff --git a/clients/client-mgn/commands/MarkAsArchivedCommand.ts b/clients/client-mgn/commands/MarkAsArchivedCommand.ts index 813abc3d84e4..2e2b92398b76 100644 --- a/clients/client-mgn/commands/MarkAsArchivedCommand.ts +++ b/clients/client-mgn/commands/MarkAsArchivedCommand.ts @@ -22,6 +22,20 @@ export interface MarkAsArchivedCommandOutput extends SourceServer, __MetadataBea /** *

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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { MgnClient, MarkAsArchivedCommand } from "@aws-sdk/client-mgn"; // ES Modules import + * // const { MgnClient, MarkAsArchivedCommand } = require("@aws-sdk/client-mgn"); // CommonJS import + * const client = new MgnClient(config); + * const command = new MarkAsArchivedCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link MarkAsArchivedCommandInput} for command's `input` shape. + * @see {@link MarkAsArchivedCommandOutput} for command's `response` shape. + * @see {@link MgnClientResolvedConfig | config} for command's `input` shape. + * */ export class MarkAsArchivedCommand extends $Command< MarkAsArchivedCommandInput, diff --git a/clients/client-mgn/commands/RetryDataReplicationCommand.ts b/clients/client-mgn/commands/RetryDataReplicationCommand.ts index 19f85eb8d907..4989cba77dd5 100644 --- a/clients/client-mgn/commands/RetryDataReplicationCommand.ts +++ b/clients/client-mgn/commands/RetryDataReplicationCommand.ts @@ -22,6 +22,20 @@ export interface RetryDataReplicationCommandOutput extends SourceServer, __Metad /** *

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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { MgnClient, RetryDataReplicationCommand } from "@aws-sdk/client-mgn"; // ES Modules import + * // const { MgnClient, RetryDataReplicationCommand } = require("@aws-sdk/client-mgn"); // CommonJS import + * const client = new MgnClient(config); + * const command = new RetryDataReplicationCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link RetryDataReplicationCommandInput} for command's `input` shape. + * @see {@link RetryDataReplicationCommandOutput} for command's `response` shape. + * @see {@link MgnClientResolvedConfig | config} for command's `input` shape. + * */ export class RetryDataReplicationCommand extends $Command< RetryDataReplicationCommandInput, diff --git a/clients/client-mgn/commands/StartCutoverCommand.ts b/clients/client-mgn/commands/StartCutoverCommand.ts index 2c6e8b722571..754f5224419d 100644 --- a/clients/client-mgn/commands/StartCutoverCommand.ts +++ b/clients/client-mgn/commands/StartCutoverCommand.ts @@ -22,6 +22,20 @@ export interface StartCutoverCommandOutput extends StartCutoverResponse, __Metad /** *

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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { MgnClient, StartCutoverCommand } from "@aws-sdk/client-mgn"; // ES Modules import + * // const { MgnClient, StartCutoverCommand } = require("@aws-sdk/client-mgn"); // CommonJS import + * const client = new MgnClient(config); + * const command = new StartCutoverCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link StartCutoverCommandInput} for command's `input` shape. + * @see {@link StartCutoverCommandOutput} for command's `response` shape. + * @see {@link MgnClientResolvedConfig | config} for command's `input` shape. + * */ export class StartCutoverCommand extends $Command< StartCutoverCommandInput, diff --git a/clients/client-mgn/commands/StartTestCommand.ts b/clients/client-mgn/commands/StartTestCommand.ts index 9df7b8e9c877..5ca64c53a095 100644 --- a/clients/client-mgn/commands/StartTestCommand.ts +++ b/clients/client-mgn/commands/StartTestCommand.ts @@ -22,6 +22,20 @@ export interface StartTestCommandOutput extends StartTestResponse, __MetadataBea /** *

Lauches 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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { MgnClient, StartTestCommand } from "@aws-sdk/client-mgn"; // ES Modules import + * // const { MgnClient, StartTestCommand } = require("@aws-sdk/client-mgn"); // CommonJS import + * const client = new MgnClient(config); + * const command = new StartTestCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link StartTestCommandInput} for command's `input` shape. + * @see {@link StartTestCommandOutput} for command's `response` shape. + * @see {@link MgnClientResolvedConfig | config} for command's `input` shape. + * */ export class StartTestCommand extends $Command { // Start section: command_properties diff --git a/clients/client-mgn/commands/TagResourceCommand.ts b/clients/client-mgn/commands/TagResourceCommand.ts index 0465bcbb685f..d7ac232edaa8 100644 --- a/clients/client-mgn/commands/TagResourceCommand.ts +++ b/clients/client-mgn/commands/TagResourceCommand.ts @@ -22,6 +22,20 @@ export interface TagResourceCommandOutput extends __MetadataBearer {} /** *

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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { MgnClient, TagResourceCommand } from "@aws-sdk/client-mgn"; // ES Modules import + * // const { MgnClient, TagResourceCommand } = require("@aws-sdk/client-mgn"); // CommonJS import + * const client = new MgnClient(config); + * const command = new TagResourceCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link TagResourceCommandInput} for command's `input` shape. + * @see {@link TagResourceCommandOutput} for command's `response` shape. + * @see {@link MgnClientResolvedConfig | config} for command's `input` shape. + * */ export class TagResourceCommand extends $Command< TagResourceCommandInput, diff --git a/clients/client-mgn/commands/TerminateTargetInstancesCommand.ts b/clients/client-mgn/commands/TerminateTargetInstancesCommand.ts index 6e41d815148c..553ae41d1c7a 100644 --- a/clients/client-mgn/commands/TerminateTargetInstancesCommand.ts +++ b/clients/client-mgn/commands/TerminateTargetInstancesCommand.ts @@ -22,6 +22,20 @@ export interface TerminateTargetInstancesCommandOutput extends TerminateTargetIn /** *

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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { MgnClient, TerminateTargetInstancesCommand } from "@aws-sdk/client-mgn"; // ES Modules import + * // const { MgnClient, TerminateTargetInstancesCommand } = require("@aws-sdk/client-mgn"); // CommonJS import + * const client = new MgnClient(config); + * const command = new TerminateTargetInstancesCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link TerminateTargetInstancesCommandInput} for command's `input` shape. + * @see {@link TerminateTargetInstancesCommandOutput} for command's `response` shape. + * @see {@link MgnClientResolvedConfig | config} for command's `input` shape. + * */ export class TerminateTargetInstancesCommand extends $Command< TerminateTargetInstancesCommandInput, diff --git a/clients/client-mgn/commands/UntagResourceCommand.ts b/clients/client-mgn/commands/UntagResourceCommand.ts index 29b0cebbbc3a..8416e1c78c1b 100644 --- a/clients/client-mgn/commands/UntagResourceCommand.ts +++ b/clients/client-mgn/commands/UntagResourceCommand.ts @@ -22,6 +22,20 @@ export interface UntagResourceCommandOutput extends __MetadataBearer {} /** *

Deletes the specified set of tags from the specified set of Application Migration Service resources.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { MgnClient, UntagResourceCommand } from "@aws-sdk/client-mgn"; // ES Modules import + * // const { MgnClient, UntagResourceCommand } = require("@aws-sdk/client-mgn"); // CommonJS import + * const client = new MgnClient(config); + * const command = new UntagResourceCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link UntagResourceCommandInput} for command's `input` shape. + * @see {@link UntagResourceCommandOutput} for command's `response` shape. + * @see {@link MgnClientResolvedConfig | config} for command's `input` shape. + * */ export class UntagResourceCommand extends $Command< UntagResourceCommandInput, diff --git a/clients/client-mgn/commands/UpdateLaunchConfigurationCommand.ts b/clients/client-mgn/commands/UpdateLaunchConfigurationCommand.ts index c4cadf67c95d..78bf12d71f55 100644 --- a/clients/client-mgn/commands/UpdateLaunchConfigurationCommand.ts +++ b/clients/client-mgn/commands/UpdateLaunchConfigurationCommand.ts @@ -22,6 +22,20 @@ export interface UpdateLaunchConfigurationCommandOutput extends LaunchConfigurat /** *

Updates multiple LaunchConfigurations by Source Server ID.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { MgnClient, UpdateLaunchConfigurationCommand } from "@aws-sdk/client-mgn"; // ES Modules import + * // const { MgnClient, UpdateLaunchConfigurationCommand } = require("@aws-sdk/client-mgn"); // CommonJS import + * const client = new MgnClient(config); + * const command = new UpdateLaunchConfigurationCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link UpdateLaunchConfigurationCommandInput} for command's `input` shape. + * @see {@link UpdateLaunchConfigurationCommandOutput} for command's `response` shape. + * @see {@link MgnClientResolvedConfig | config} for command's `input` shape. + * */ export class UpdateLaunchConfigurationCommand extends $Command< UpdateLaunchConfigurationCommandInput, diff --git a/clients/client-mgn/commands/UpdateReplicationConfigurationCommand.ts b/clients/client-mgn/commands/UpdateReplicationConfigurationCommand.ts index 91e46365effb..8116b8460143 100644 --- a/clients/client-mgn/commands/UpdateReplicationConfigurationCommand.ts +++ b/clients/client-mgn/commands/UpdateReplicationConfigurationCommand.ts @@ -22,6 +22,20 @@ export interface UpdateReplicationConfigurationCommandOutput extends Replication /** *

Allows you to update multiple ReplicationConfigurations by Source Server ID.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { MgnClient, UpdateReplicationConfigurationCommand } from "@aws-sdk/client-mgn"; // ES Modules import + * // const { MgnClient, UpdateReplicationConfigurationCommand } = require("@aws-sdk/client-mgn"); // CommonJS import + * const client = new MgnClient(config); + * const command = new UpdateReplicationConfigurationCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link UpdateReplicationConfigurationCommandInput} for command's `input` shape. + * @see {@link UpdateReplicationConfigurationCommandOutput} for command's `response` shape. + * @see {@link MgnClientResolvedConfig | config} for command's `input` shape. + * */ export class UpdateReplicationConfigurationCommand extends $Command< UpdateReplicationConfigurationCommandInput, diff --git a/clients/client-mgn/commands/UpdateReplicationConfigurationTemplateCommand.ts b/clients/client-mgn/commands/UpdateReplicationConfigurationTemplateCommand.ts index ce564618ad37..f82513f90ab2 100644 --- a/clients/client-mgn/commands/UpdateReplicationConfigurationTemplateCommand.ts +++ b/clients/client-mgn/commands/UpdateReplicationConfigurationTemplateCommand.ts @@ -25,6 +25,20 @@ export interface UpdateReplicationConfigurationTemplateCommandOutput /** *

Updates multiple ReplicationConfigurationTemplates by ID.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { MgnClient, UpdateReplicationConfigurationTemplateCommand } from "@aws-sdk/client-mgn"; // ES Modules import + * // const { MgnClient, UpdateReplicationConfigurationTemplateCommand } = require("@aws-sdk/client-mgn"); // CommonJS import + * const client = new MgnClient(config); + * const command = new UpdateReplicationConfigurationTemplateCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link UpdateReplicationConfigurationTemplateCommandInput} for command's `input` shape. + * @see {@link UpdateReplicationConfigurationTemplateCommandOutput} for command's `response` shape. + * @see {@link MgnClientResolvedConfig | config} for command's `input` shape. + * */ export class UpdateReplicationConfigurationTemplateCommand extends $Command< UpdateReplicationConfigurationTemplateCommandInput, diff --git a/clients/client-mgn/models/models_0.ts b/clients/client-mgn/models/models_0.ts index 4a0f87b84760..0166acd598a4 100644 --- a/clients/client-mgn/models/models_0.ts +++ b/clients/client-mgn/models/models_0.ts @@ -12,6 +12,9 @@ export interface AccessDeniedException extends __SmithyException, $MetadataBeare } export namespace AccessDeniedException { + /** + * @internal + */ export const filterSensitiveLog = (obj: AccessDeniedException): any => ({ ...obj, }); @@ -20,6 +23,9 @@ export namespace AccessDeniedException { export interface InitializeServiceRequest {} export namespace InitializeServiceRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: InitializeServiceRequest): any => ({ ...obj, }); @@ -28,6 +34,9 @@ export namespace InitializeServiceRequest { export interface InitializeServiceResponse {} export namespace InitializeServiceResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: InitializeServiceResponse): any => ({ ...obj, }); @@ -49,6 +58,9 @@ export interface ValidationExceptionField { } export namespace ValidationExceptionField { + /** + * @internal + */ export const filterSensitiveLog = (obj: ValidationExceptionField): any => ({ ...obj, }); @@ -81,6 +93,9 @@ export interface ValidationException extends __SmithyException, $MetadataBearer } export namespace ValidationException { + /** + * @internal + */ export const filterSensitiveLog = (obj: ValidationException): any => ({ ...obj, }); @@ -106,6 +121,9 @@ export interface ConflictException extends __SmithyException, $MetadataBearer { } export namespace ConflictException { + /** + * @internal + */ export const filterSensitiveLog = (obj: ConflictException): any => ({ ...obj, }); @@ -119,6 +137,9 @@ export interface DeleteJobRequest { } export namespace DeleteJobRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteJobRequest): any => ({ ...obj, }); @@ -127,6 +148,9 @@ export namespace DeleteJobRequest { export interface DeleteJobResponse {} export namespace DeleteJobResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteJobResponse): any => ({ ...obj, }); @@ -152,6 +176,9 @@ export interface ResourceNotFoundException extends __SmithyException, $MetadataB } export namespace ResourceNotFoundException { + /** + * @internal + */ export const filterSensitiveLog = (obj: ResourceNotFoundException): any => ({ ...obj, }); @@ -168,6 +195,9 @@ export interface UninitializedAccountException extends __SmithyException, $Metad } export namespace UninitializedAccountException { + /** + * @internal + */ export const filterSensitiveLog = (obj: UninitializedAccountException): any => ({ ...obj, }); @@ -191,6 +221,9 @@ export interface DescribeJobLogItemsRequest { } export namespace DescribeJobLogItemsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeJobLogItemsRequest): any => ({ ...obj, }); @@ -241,6 +274,9 @@ export interface JobLogEventData { } export namespace JobLogEventData { + /** + * @internal + */ export const filterSensitiveLog = (obj: JobLogEventData): any => ({ ...obj, }); @@ -267,6 +303,9 @@ export interface JobLog { } export namespace JobLog { + /** + * @internal + */ export const filterSensitiveLog = (obj: JobLog): any => ({ ...obj, }); @@ -285,6 +324,9 @@ export interface DescribeJobLogItemsResponse { } export namespace DescribeJobLogItemsResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeJobLogItemsResponse): any => ({ ...obj, }); @@ -311,6 +353,9 @@ export interface DescribeJobsRequestFilters { } export namespace DescribeJobsRequestFilters { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeJobsRequestFilters): any => ({ ...obj, }); @@ -334,6 +379,9 @@ export interface DescribeJobsRequest { } export namespace DescribeJobsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeJobsRequest): any => ({ ...obj, }); @@ -370,6 +418,9 @@ export interface ParticipatingServer { } export namespace ParticipatingServer { + /** + * @internal + */ export const filterSensitiveLog = (obj: ParticipatingServer): any => ({ ...obj, }); @@ -437,6 +488,9 @@ export interface Job { } export namespace Job { + /** + * @internal + */ export const filterSensitiveLog = (obj: Job): any => ({ ...obj, ...(obj.tags && { tags: SENSITIVE_STRING }), @@ -456,6 +510,9 @@ export interface DescribeJobsResponse { } export namespace DescribeJobsResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeJobsResponse): any => ({ ...obj, ...(obj.items && { items: obj.items.map((item) => Job.filterSensitiveLog(item)) }), @@ -476,6 +533,9 @@ export interface InternalServerException extends __SmithyException, $MetadataBea } export namespace InternalServerException { + /** + * @internal + */ export const filterSensitiveLog = (obj: InternalServerException): any => ({ ...obj, }); @@ -489,6 +549,9 @@ export interface ListTagsForResourceRequest { } export namespace ListTagsForResourceRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListTagsForResourceRequest): any => ({ ...obj, }); @@ -502,6 +565,9 @@ export interface ListTagsForResourceResponse { } export namespace ListTagsForResourceResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListTagsForResourceResponse): any => ({ ...obj, ...(obj.tags && { tags: SENSITIVE_STRING }), @@ -532,6 +598,9 @@ export interface ThrottlingException extends __SmithyException, $MetadataBearer } export namespace ThrottlingException { + /** + * @internal + */ export const filterSensitiveLog = (obj: ThrottlingException): any => ({ ...obj, }); @@ -621,6 +690,9 @@ export interface CreateReplicationConfigurationTemplateRequest { } export namespace CreateReplicationConfigurationTemplateRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateReplicationConfigurationTemplateRequest): any => ({ ...obj, ...(obj.stagingAreaTags && { stagingAreaTags: SENSITIVE_STRING }), @@ -706,6 +778,9 @@ export interface ReplicationConfigurationTemplate { } export namespace ReplicationConfigurationTemplate { + /** + * @internal + */ export const filterSensitiveLog = (obj: ReplicationConfigurationTemplate): any => ({ ...obj, ...(obj.stagingAreaTags && { stagingAreaTags: SENSITIVE_STRING }), @@ -721,6 +796,9 @@ export interface DeleteReplicationConfigurationTemplateRequest { } export namespace DeleteReplicationConfigurationTemplateRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteReplicationConfigurationTemplateRequest): any => ({ ...obj, }); @@ -729,6 +807,9 @@ export namespace DeleteReplicationConfigurationTemplateRequest { export interface DeleteReplicationConfigurationTemplateResponse {} export namespace DeleteReplicationConfigurationTemplateResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteReplicationConfigurationTemplateResponse): any => ({ ...obj, }); @@ -752,6 +833,9 @@ export interface DescribeReplicationConfigurationTemplatesRequest { } export namespace DescribeReplicationConfigurationTemplatesRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeReplicationConfigurationTemplatesRequest): any => ({ ...obj, }); @@ -770,6 +854,9 @@ export interface DescribeReplicationConfigurationTemplatesResponse { } export namespace DescribeReplicationConfigurationTemplatesResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeReplicationConfigurationTemplatesResponse): any => ({ ...obj, ...(obj.items && { items: obj.items.map((item) => ReplicationConfigurationTemplate.filterSensitiveLog(item)) }), @@ -849,6 +936,9 @@ export interface UpdateReplicationConfigurationTemplateRequest { } export namespace UpdateReplicationConfigurationTemplateRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateReplicationConfigurationTemplateRequest): any => ({ ...obj, ...(obj.stagingAreaTags && { stagingAreaTags: SENSITIVE_STRING }), @@ -872,6 +962,9 @@ export interface ChangeServerLifeCycleStateSourceServerLifecycle { } export namespace ChangeServerLifeCycleStateSourceServerLifecycle { + /** + * @internal + */ export const filterSensitiveLog = (obj: ChangeServerLifeCycleStateSourceServerLifecycle): any => ({ ...obj, }); @@ -890,6 +983,9 @@ export interface ChangeServerLifeCycleStateRequest { } export namespace ChangeServerLifeCycleStateRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ChangeServerLifeCycleStateRequest): any => ({ ...obj, }); @@ -928,6 +1024,9 @@ export interface DataReplicationError { } export namespace DataReplicationError { + /** + * @internal + */ export const filterSensitiveLog = (obj: DataReplicationError): any => ({ ...obj, }); @@ -971,6 +1070,9 @@ export interface DataReplicationInitiationStep { } export namespace DataReplicationInitiationStep { + /** + * @internal + */ export const filterSensitiveLog = (obj: DataReplicationInitiationStep): any => ({ ...obj, }); @@ -997,6 +1099,9 @@ export interface DataReplicationInitiation { } export namespace DataReplicationInitiation { + /** + * @internal + */ export const filterSensitiveLog = (obj: DataReplicationInitiation): any => ({ ...obj, }); @@ -1046,6 +1151,9 @@ export interface DataReplicationInfoReplicatedDisk { } export namespace DataReplicationInfoReplicatedDisk { + /** + * @internal + */ export const filterSensitiveLog = (obj: DataReplicationInfoReplicatedDisk): any => ({ ...obj, }); @@ -1087,6 +1195,9 @@ export interface DataReplicationInfo { } export namespace DataReplicationInfo { + /** + * @internal + */ export const filterSensitiveLog = (obj: DataReplicationInfo): any => ({ ...obj, }); @@ -1120,6 +1231,9 @@ export interface LaunchedInstance { } export namespace LaunchedInstance { + /** + * @internal + */ export const filterSensitiveLog = (obj: LaunchedInstance): any => ({ ...obj, }); @@ -1136,6 +1250,9 @@ export interface LifeCycleLastCutoverFinalized { } export namespace LifeCycleLastCutoverFinalized { + /** + * @internal + */ export const filterSensitiveLog = (obj: LifeCycleLastCutoverFinalized): any => ({ ...obj, }); @@ -1157,6 +1274,9 @@ export interface LifeCycleLastCutoverInitiated { } export namespace LifeCycleLastCutoverInitiated { + /** + * @internal + */ export const filterSensitiveLog = (obj: LifeCycleLastCutoverInitiated): any => ({ ...obj, }); @@ -1173,6 +1293,9 @@ export interface LifeCycleLastCutoverReverted { } export namespace LifeCycleLastCutoverReverted { + /** + * @internal + */ export const filterSensitiveLog = (obj: LifeCycleLastCutoverReverted): any => ({ ...obj, }); @@ -1199,6 +1322,9 @@ export interface LifeCycleLastCutover { } export namespace LifeCycleLastCutover { + /** + * @internal + */ export const filterSensitiveLog = (obj: LifeCycleLastCutover): any => ({ ...obj, }); @@ -1215,6 +1341,9 @@ export interface LifeCycleLastTestFinalized { } export namespace LifeCycleLastTestFinalized { + /** + * @internal + */ export const filterSensitiveLog = (obj: LifeCycleLastTestFinalized): any => ({ ...obj, }); @@ -1236,6 +1365,9 @@ export interface LifeCycleLastTestInitiated { } export namespace LifeCycleLastTestInitiated { + /** + * @internal + */ export const filterSensitiveLog = (obj: LifeCycleLastTestInitiated): any => ({ ...obj, }); @@ -1252,6 +1384,9 @@ export interface LifeCycleLastTestReverted { } export namespace LifeCycleLastTestReverted { + /** + * @internal + */ export const filterSensitiveLog = (obj: LifeCycleLastTestReverted): any => ({ ...obj, }); @@ -1278,6 +1413,9 @@ export interface LifeCycleLastTest { } export namespace LifeCycleLastTest { + /** + * @internal + */ export const filterSensitiveLog = (obj: LifeCycleLastTest): any => ({ ...obj, }); @@ -1335,6 +1473,9 @@ export interface LifeCycle { } export namespace LifeCycle { + /** + * @internal + */ export const filterSensitiveLog = (obj: LifeCycle): any => ({ ...obj, }); @@ -1356,6 +1497,9 @@ export interface CPU { } export namespace CPU { + /** + * @internal + */ export const filterSensitiveLog = (obj: CPU): any => ({ ...obj, }); @@ -1377,6 +1521,9 @@ export interface Disk { } export namespace Disk { + /** + * @internal + */ export const filterSensitiveLog = (obj: Disk): any => ({ ...obj, }); @@ -1408,6 +1555,9 @@ export interface IdentificationHints { } export namespace IdentificationHints { + /** + * @internal + */ export const filterSensitiveLog = (obj: IdentificationHints): any => ({ ...obj, }); @@ -1434,6 +1584,9 @@ export interface NetworkInterface { } export namespace NetworkInterface { + /** + * @internal + */ export const filterSensitiveLog = (obj: NetworkInterface): any => ({ ...obj, }); @@ -1450,6 +1603,9 @@ export interface OS { } export namespace OS { + /** + * @internal + */ export const filterSensitiveLog = (obj: OS): any => ({ ...obj, }); @@ -1501,6 +1657,9 @@ export interface SourceProperties { } export namespace SourceProperties { + /** + * @internal + */ export const filterSensitiveLog = (obj: SourceProperties): any => ({ ...obj, }); @@ -1549,6 +1708,9 @@ export interface SourceServer { } export namespace SourceServer { + /** + * @internal + */ export const filterSensitiveLog = (obj: SourceServer): any => ({ ...obj, ...(obj.tags && { tags: SENSITIVE_STRING }), @@ -1563,6 +1725,9 @@ export interface DeleteSourceServerRequest { } export namespace DeleteSourceServerRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteSourceServerRequest): any => ({ ...obj, }); @@ -1571,6 +1736,9 @@ export namespace DeleteSourceServerRequest { export interface DeleteSourceServerResponse {} export namespace DeleteSourceServerResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteSourceServerResponse): any => ({ ...obj, }); @@ -1592,6 +1760,9 @@ export interface DescribeSourceServersRequestFilters { } export namespace DescribeSourceServersRequestFilters { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeSourceServersRequestFilters): any => ({ ...obj, }); @@ -1615,6 +1786,9 @@ export interface DescribeSourceServersRequest { } export namespace DescribeSourceServersRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeSourceServersRequest): any => ({ ...obj, }); @@ -1633,6 +1807,9 @@ export interface DescribeSourceServersResponse { } export namespace DescribeSourceServersResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeSourceServersResponse): any => ({ ...obj, ...(obj.items && { items: obj.items.map((item) => SourceServer.filterSensitiveLog(item)) }), @@ -1647,6 +1824,9 @@ export interface DisconnectFromServiceRequest { } export namespace DisconnectFromServiceRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DisconnectFromServiceRequest): any => ({ ...obj, }); @@ -1660,6 +1840,9 @@ export interface FinalizeCutoverRequest { } export namespace FinalizeCutoverRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: FinalizeCutoverRequest): any => ({ ...obj, }); @@ -1673,6 +1856,9 @@ export interface GetLaunchConfigurationRequest { } export namespace GetLaunchConfigurationRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetLaunchConfigurationRequest): any => ({ ...obj, }); @@ -1694,6 +1880,9 @@ export interface Licensing { } export namespace Licensing { + /** + * @internal + */ export const filterSensitiveLog = (obj: Licensing): any => ({ ...obj, }); @@ -1747,6 +1936,9 @@ export interface LaunchConfiguration { } export namespace LaunchConfiguration { + /** + * @internal + */ export const filterSensitiveLog = (obj: LaunchConfiguration): any => ({ ...obj, }); @@ -1760,6 +1952,9 @@ export interface GetReplicationConfigurationRequest { } export namespace GetReplicationConfigurationRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetReplicationConfigurationRequest): any => ({ ...obj, }); @@ -1800,6 +1995,9 @@ export interface ReplicationConfigurationReplicatedDisk { } export namespace ReplicationConfigurationReplicatedDisk { + /** + * @internal + */ export const filterSensitiveLog = (obj: ReplicationConfigurationReplicatedDisk): any => ({ ...obj, }); @@ -1883,6 +2081,9 @@ export interface ReplicationConfiguration { } export namespace ReplicationConfiguration { + /** + * @internal + */ export const filterSensitiveLog = (obj: ReplicationConfiguration): any => ({ ...obj, ...(obj.stagingAreaTags && { stagingAreaTags: SENSITIVE_STRING }), @@ -1897,6 +2098,9 @@ export interface MarkAsArchivedRequest { } export namespace MarkAsArchivedRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: MarkAsArchivedRequest): any => ({ ...obj, }); @@ -1910,6 +2114,9 @@ export interface RetryDataReplicationRequest { } export namespace RetryDataReplicationRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: RetryDataReplicationRequest): any => ({ ...obj, }); @@ -1928,6 +2135,9 @@ export interface StartCutoverRequest { } export namespace StartCutoverRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: StartCutoverRequest): any => ({ ...obj, ...(obj.tags && { tags: SENSITIVE_STRING }), @@ -1942,6 +2152,9 @@ export interface StartCutoverResponse { } export namespace StartCutoverResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: StartCutoverResponse): any => ({ ...obj, ...(obj.job && { job: Job.filterSensitiveLog(obj.job) }), @@ -1961,6 +2174,9 @@ export interface StartTestRequest { } export namespace StartTestRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: StartTestRequest): any => ({ ...obj, ...(obj.tags && { tags: SENSITIVE_STRING }), @@ -1975,6 +2191,9 @@ export interface StartTestResponse { } export namespace StartTestResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: StartTestResponse): any => ({ ...obj, ...(obj.job && { job: Job.filterSensitiveLog(obj.job) }), @@ -1994,6 +2213,9 @@ export interface TerminateTargetInstancesRequest { } export namespace TerminateTargetInstancesRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: TerminateTargetInstancesRequest): any => ({ ...obj, ...(obj.tags && { tags: SENSITIVE_STRING }), @@ -2008,6 +2230,9 @@ export interface TerminateTargetInstancesResponse { } export namespace TerminateTargetInstancesResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: TerminateTargetInstancesResponse): any => ({ ...obj, ...(obj.job && { job: Job.filterSensitiveLog(obj.job) }), @@ -2052,6 +2277,9 @@ export interface UpdateLaunchConfigurationRequest { } export namespace UpdateLaunchConfigurationRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateLaunchConfigurationRequest): any => ({ ...obj, }); @@ -2135,6 +2363,9 @@ export interface UpdateReplicationConfigurationRequest { } export namespace UpdateReplicationConfigurationRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateReplicationConfigurationRequest): any => ({ ...obj, ...(obj.stagingAreaTags && { stagingAreaTags: SENSITIVE_STRING }), @@ -2154,6 +2385,9 @@ export interface TagResourceRequest { } export namespace TagResourceRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: TagResourceRequest): any => ({ ...obj, ...(obj.tags && { tags: SENSITIVE_STRING }), @@ -2173,6 +2407,9 @@ export interface UntagResourceRequest { } export namespace UntagResourceRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: UntagResourceRequest): any => ({ ...obj, ...(obj.tagKeys && { tagKeys: SENSITIVE_STRING }), diff --git a/clients/client-migration-hub/commands/AssociateCreatedArtifactCommand.ts b/clients/client-migration-hub/commands/AssociateCreatedArtifactCommand.ts index dd2696d3ab20..b35aef28d537 100644 --- a/clients/client-migration-hub/commands/AssociateCreatedArtifactCommand.ts +++ b/clients/client-migration-hub/commands/AssociateCreatedArtifactCommand.ts @@ -39,6 +39,20 @@ export interface AssociateCreatedArtifactCommandOutput extends AssociateCreatedA * or DMS endpoint, etc.

* * + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { MigrationHubClient, AssociateCreatedArtifactCommand } from "@aws-sdk/client-migration-hub"; // ES Modules import + * // const { MigrationHubClient, AssociateCreatedArtifactCommand } = require("@aws-sdk/client-migration-hub"); // CommonJS import + * const client = new MigrationHubClient(config); + * const command = new AssociateCreatedArtifactCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link AssociateCreatedArtifactCommandInput} for command's `input` shape. + * @see {@link AssociateCreatedArtifactCommandOutput} for command's `response` shape. + * @see {@link MigrationHubClientResolvedConfig | config} for command's `input` shape. + * */ export class AssociateCreatedArtifactCommand extends $Command< AssociateCreatedArtifactCommandInput, diff --git a/clients/client-migration-hub/commands/AssociateDiscoveredResourceCommand.ts b/clients/client-migration-hub/commands/AssociateDiscoveredResourceCommand.ts index fbdd6f7d46f0..607835bfb67c 100644 --- a/clients/client-migration-hub/commands/AssociateDiscoveredResourceCommand.ts +++ b/clients/client-migration-hub/commands/AssociateDiscoveredResourceCommand.ts @@ -23,6 +23,20 @@ export interface AssociateDiscoveredResourceCommandOutput extends AssociateDisco /** *

Associates a discovered resource ID from Application Discovery Service with a migration * task.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { MigrationHubClient, AssociateDiscoveredResourceCommand } from "@aws-sdk/client-migration-hub"; // ES Modules import + * // const { MigrationHubClient, AssociateDiscoveredResourceCommand } = require("@aws-sdk/client-migration-hub"); // CommonJS import + * const client = new MigrationHubClient(config); + * const command = new AssociateDiscoveredResourceCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link AssociateDiscoveredResourceCommandInput} for command's `input` shape. + * @see {@link AssociateDiscoveredResourceCommandOutput} for command's `response` shape. + * @see {@link MigrationHubClientResolvedConfig | config} for command's `input` shape. + * */ export class AssociateDiscoveredResourceCommand extends $Command< AssociateDiscoveredResourceCommandInput, diff --git a/clients/client-migration-hub/commands/CreateProgressUpdateStreamCommand.ts b/clients/client-migration-hub/commands/CreateProgressUpdateStreamCommand.ts index bdee11bcf6f3..783c936dc8e4 100644 --- a/clients/client-migration-hub/commands/CreateProgressUpdateStreamCommand.ts +++ b/clients/client-migration-hub/commands/CreateProgressUpdateStreamCommand.ts @@ -26,6 +26,20 @@ export interface CreateProgressUpdateStreamCommandOutput extends CreateProgressU * 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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { MigrationHubClient, CreateProgressUpdateStreamCommand } from "@aws-sdk/client-migration-hub"; // ES Modules import + * // const { MigrationHubClient, CreateProgressUpdateStreamCommand } = require("@aws-sdk/client-migration-hub"); // CommonJS import + * const client = new MigrationHubClient(config); + * const command = new CreateProgressUpdateStreamCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreateProgressUpdateStreamCommandInput} for command's `input` shape. + * @see {@link CreateProgressUpdateStreamCommandOutput} for command's `response` shape. + * @see {@link MigrationHubClientResolvedConfig | config} for command's `input` shape. + * */ export class CreateProgressUpdateStreamCommand extends $Command< CreateProgressUpdateStreamCommandInput, diff --git a/clients/client-migration-hub/commands/DeleteProgressUpdateStreamCommand.ts b/clients/client-migration-hub/commands/DeleteProgressUpdateStreamCommand.ts index 232c9e0477a8..18f90c032e37 100644 --- a/clients/client-migration-hub/commands/DeleteProgressUpdateStreamCommand.ts +++ b/clients/client-migration-hub/commands/DeleteProgressUpdateStreamCommand.ts @@ -52,6 +52,20 @@ export interface DeleteProgressUpdateStreamCommandOutput extends DeleteProgressU * resources associated with the old stream).

* * + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { MigrationHubClient, DeleteProgressUpdateStreamCommand } from "@aws-sdk/client-migration-hub"; // ES Modules import + * // const { MigrationHubClient, DeleteProgressUpdateStreamCommand } = require("@aws-sdk/client-migration-hub"); // CommonJS import + * const client = new MigrationHubClient(config); + * const command = new DeleteProgressUpdateStreamCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteProgressUpdateStreamCommandInput} for command's `input` shape. + * @see {@link DeleteProgressUpdateStreamCommandOutput} for command's `response` shape. + * @see {@link MigrationHubClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteProgressUpdateStreamCommand extends $Command< DeleteProgressUpdateStreamCommandInput, diff --git a/clients/client-migration-hub/commands/DescribeApplicationStateCommand.ts b/clients/client-migration-hub/commands/DescribeApplicationStateCommand.ts index dd956901d1b9..b4a14a2007c6 100644 --- a/clients/client-migration-hub/commands/DescribeApplicationStateCommand.ts +++ b/clients/client-migration-hub/commands/DescribeApplicationStateCommand.ts @@ -22,6 +22,20 @@ export interface DescribeApplicationStateCommandOutput extends DescribeApplicati /** *

Gets the migration status of an application.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { MigrationHubClient, DescribeApplicationStateCommand } from "@aws-sdk/client-migration-hub"; // ES Modules import + * // const { MigrationHubClient, DescribeApplicationStateCommand } = require("@aws-sdk/client-migration-hub"); // CommonJS import + * const client = new MigrationHubClient(config); + * const command = new DescribeApplicationStateCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeApplicationStateCommandInput} for command's `input` shape. + * @see {@link DescribeApplicationStateCommandOutput} for command's `response` shape. + * @see {@link MigrationHubClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeApplicationStateCommand extends $Command< DescribeApplicationStateCommandInput, diff --git a/clients/client-migration-hub/commands/DescribeMigrationTaskCommand.ts b/clients/client-migration-hub/commands/DescribeMigrationTaskCommand.ts index d810c2ac8f11..84682581d9df 100644 --- a/clients/client-migration-hub/commands/DescribeMigrationTaskCommand.ts +++ b/clients/client-migration-hub/commands/DescribeMigrationTaskCommand.ts @@ -22,6 +22,20 @@ export interface DescribeMigrationTaskCommandOutput extends DescribeMigrationTas /** *

Retrieves a list of all attributes associated with a specific migration task.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { MigrationHubClient, DescribeMigrationTaskCommand } from "@aws-sdk/client-migration-hub"; // ES Modules import + * // const { MigrationHubClient, DescribeMigrationTaskCommand } = require("@aws-sdk/client-migration-hub"); // CommonJS import + * const client = new MigrationHubClient(config); + * const command = new DescribeMigrationTaskCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeMigrationTaskCommandInput} for command's `input` shape. + * @see {@link DescribeMigrationTaskCommandOutput} for command's `response` shape. + * @see {@link MigrationHubClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeMigrationTaskCommand extends $Command< DescribeMigrationTaskCommandInput, diff --git a/clients/client-migration-hub/commands/DisassociateCreatedArtifactCommand.ts b/clients/client-migration-hub/commands/DisassociateCreatedArtifactCommand.ts index 8df68b82c594..f6dda1c0ba67 100644 --- a/clients/client-migration-hub/commands/DisassociateCreatedArtifactCommand.ts +++ b/clients/client-migration-hub/commands/DisassociateCreatedArtifactCommand.ts @@ -38,6 +38,20 @@ export interface DisassociateCreatedArtifactCommandOutput extends DisassociateCr * or RDS instance, etc.

* * + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { MigrationHubClient, DisassociateCreatedArtifactCommand } from "@aws-sdk/client-migration-hub"; // ES Modules import + * // const { MigrationHubClient, DisassociateCreatedArtifactCommand } = require("@aws-sdk/client-migration-hub"); // CommonJS import + * const client = new MigrationHubClient(config); + * const command = new DisassociateCreatedArtifactCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DisassociateCreatedArtifactCommandInput} for command's `input` shape. + * @see {@link DisassociateCreatedArtifactCommandOutput} for command's `response` shape. + * @see {@link MigrationHubClientResolvedConfig | config} for command's `input` shape. + * */ export class DisassociateCreatedArtifactCommand extends $Command< DisassociateCreatedArtifactCommandInput, diff --git a/clients/client-migration-hub/commands/DisassociateDiscoveredResourceCommand.ts b/clients/client-migration-hub/commands/DisassociateDiscoveredResourceCommand.ts index 4ed479d938cb..590617294f04 100644 --- a/clients/client-migration-hub/commands/DisassociateDiscoveredResourceCommand.ts +++ b/clients/client-migration-hub/commands/DisassociateDiscoveredResourceCommand.ts @@ -25,6 +25,20 @@ export interface DisassociateDiscoveredResourceCommandOutput /** *

Disassociate an Application Discovery Service discovered resource from a migration * task.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { MigrationHubClient, DisassociateDiscoveredResourceCommand } from "@aws-sdk/client-migration-hub"; // ES Modules import + * // const { MigrationHubClient, DisassociateDiscoveredResourceCommand } = require("@aws-sdk/client-migration-hub"); // CommonJS import + * const client = new MigrationHubClient(config); + * const command = new DisassociateDiscoveredResourceCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DisassociateDiscoveredResourceCommandInput} for command's `input` shape. + * @see {@link DisassociateDiscoveredResourceCommandOutput} for command's `response` shape. + * @see {@link MigrationHubClientResolvedConfig | config} for command's `input` shape. + * */ export class DisassociateDiscoveredResourceCommand extends $Command< DisassociateDiscoveredResourceCommandInput, diff --git a/clients/client-migration-hub/commands/ImportMigrationTaskCommand.ts b/clients/client-migration-hub/commands/ImportMigrationTaskCommand.ts index b512f6ba1f54..f09765f43515 100644 --- a/clients/client-migration-hub/commands/ImportMigrationTaskCommand.ts +++ b/clients/client-migration-hub/commands/ImportMigrationTaskCommand.ts @@ -25,6 +25,20 @@ export interface ImportMigrationTaskCommandOutput extends ImportMigrationTaskRes * 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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { MigrationHubClient, ImportMigrationTaskCommand } from "@aws-sdk/client-migration-hub"; // ES Modules import + * // const { MigrationHubClient, ImportMigrationTaskCommand } = require("@aws-sdk/client-migration-hub"); // CommonJS import + * const client = new MigrationHubClient(config); + * const command = new ImportMigrationTaskCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ImportMigrationTaskCommandInput} for command's `input` shape. + * @see {@link ImportMigrationTaskCommandOutput} for command's `response` shape. + * @see {@link MigrationHubClientResolvedConfig | config} for command's `input` shape. + * */ export class ImportMigrationTaskCommand extends $Command< ImportMigrationTaskCommandInput, diff --git a/clients/client-migration-hub/commands/ListApplicationStatesCommand.ts b/clients/client-migration-hub/commands/ListApplicationStatesCommand.ts index d1456afe6d10..5e8234e78e44 100644 --- a/clients/client-migration-hub/commands/ListApplicationStatesCommand.ts +++ b/clients/client-migration-hub/commands/ListApplicationStatesCommand.ts @@ -24,6 +24,20 @@ export interface ListApplicationStatesCommandOutput extends ListApplicationState *

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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { MigrationHubClient, ListApplicationStatesCommand } from "@aws-sdk/client-migration-hub"; // ES Modules import + * // const { MigrationHubClient, ListApplicationStatesCommand } = require("@aws-sdk/client-migration-hub"); // CommonJS import + * const client = new MigrationHubClient(config); + * const command = new ListApplicationStatesCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListApplicationStatesCommandInput} for command's `input` shape. + * @see {@link ListApplicationStatesCommandOutput} for command's `response` shape. + * @see {@link MigrationHubClientResolvedConfig | config} for command's `input` shape. + * */ export class ListApplicationStatesCommand extends $Command< ListApplicationStatesCommandInput, diff --git a/clients/client-migration-hub/commands/ListCreatedArtifactsCommand.ts b/clients/client-migration-hub/commands/ListCreatedArtifactsCommand.ts index 5608de2dca6c..c99457e60ce1 100644 --- a/clients/client-migration-hub/commands/ListCreatedArtifactsCommand.ts +++ b/clients/client-migration-hub/commands/ListCreatedArtifactsCommand.ts @@ -36,6 +36,20 @@ export interface ListCreatedArtifactsCommandOutput extends ListCreatedArtifactsR *

Lists created artifacts in a paginated interface.

* * + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { MigrationHubClient, ListCreatedArtifactsCommand } from "@aws-sdk/client-migration-hub"; // ES Modules import + * // const { MigrationHubClient, ListCreatedArtifactsCommand } = require("@aws-sdk/client-migration-hub"); // CommonJS import + * const client = new MigrationHubClient(config); + * const command = new ListCreatedArtifactsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListCreatedArtifactsCommandInput} for command's `input` shape. + * @see {@link ListCreatedArtifactsCommandOutput} for command's `response` shape. + * @see {@link MigrationHubClientResolvedConfig | config} for command's `input` shape. + * */ export class ListCreatedArtifactsCommand extends $Command< ListCreatedArtifactsCommandInput, diff --git a/clients/client-migration-hub/commands/ListDiscoveredResourcesCommand.ts b/clients/client-migration-hub/commands/ListDiscoveredResourcesCommand.ts index 8ac91c7eb036..e062653a3236 100644 --- a/clients/client-migration-hub/commands/ListDiscoveredResourcesCommand.ts +++ b/clients/client-migration-hub/commands/ListDiscoveredResourcesCommand.ts @@ -22,6 +22,20 @@ export interface ListDiscoveredResourcesCommandOutput extends ListDiscoveredReso /** *

Lists discovered resources associated with the given MigrationTask.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { MigrationHubClient, ListDiscoveredResourcesCommand } from "@aws-sdk/client-migration-hub"; // ES Modules import + * // const { MigrationHubClient, ListDiscoveredResourcesCommand } = require("@aws-sdk/client-migration-hub"); // CommonJS import + * const client = new MigrationHubClient(config); + * const command = new ListDiscoveredResourcesCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListDiscoveredResourcesCommandInput} for command's `input` shape. + * @see {@link ListDiscoveredResourcesCommandOutput} for command's `response` shape. + * @see {@link MigrationHubClientResolvedConfig | config} for command's `input` shape. + * */ export class ListDiscoveredResourcesCommand extends $Command< ListDiscoveredResourcesCommandInput, diff --git a/clients/client-migration-hub/commands/ListMigrationTasksCommand.ts b/clients/client-migration-hub/commands/ListMigrationTasksCommand.ts index 044605457201..3153e18dd2ef 100644 --- a/clients/client-migration-hub/commands/ListMigrationTasksCommand.ts +++ b/clients/client-migration-hub/commands/ListMigrationTasksCommand.ts @@ -35,6 +35,20 @@ export interface ListMigrationTasksCommandOutput extends ListMigrationTasksResul *

Lists migration tasks in a paginated interface.

* * + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { MigrationHubClient, ListMigrationTasksCommand } from "@aws-sdk/client-migration-hub"; // ES Modules import + * // const { MigrationHubClient, ListMigrationTasksCommand } = require("@aws-sdk/client-migration-hub"); // CommonJS import + * const client = new MigrationHubClient(config); + * const command = new ListMigrationTasksCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListMigrationTasksCommandInput} for command's `input` shape. + * @see {@link ListMigrationTasksCommandOutput} for command's `response` shape. + * @see {@link MigrationHubClientResolvedConfig | config} for command's `input` shape. + * */ export class ListMigrationTasksCommand extends $Command< ListMigrationTasksCommandInput, diff --git a/clients/client-migration-hub/commands/ListProgressUpdateStreamsCommand.ts b/clients/client-migration-hub/commands/ListProgressUpdateStreamsCommand.ts index 89f523c3bc29..3cd7ce1b15fd 100644 --- a/clients/client-migration-hub/commands/ListProgressUpdateStreamsCommand.ts +++ b/clients/client-migration-hub/commands/ListProgressUpdateStreamsCommand.ts @@ -22,6 +22,20 @@ export interface ListProgressUpdateStreamsCommandOutput extends ListProgressUpda /** *

Lists progress update streams associated with the user account making this call.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { MigrationHubClient, ListProgressUpdateStreamsCommand } from "@aws-sdk/client-migration-hub"; // ES Modules import + * // const { MigrationHubClient, ListProgressUpdateStreamsCommand } = require("@aws-sdk/client-migration-hub"); // CommonJS import + * const client = new MigrationHubClient(config); + * const command = new ListProgressUpdateStreamsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListProgressUpdateStreamsCommandInput} for command's `input` shape. + * @see {@link ListProgressUpdateStreamsCommandOutput} for command's `response` shape. + * @see {@link MigrationHubClientResolvedConfig | config} for command's `input` shape. + * */ export class ListProgressUpdateStreamsCommand extends $Command< ListProgressUpdateStreamsCommandInput, diff --git a/clients/client-migration-hub/commands/NotifyApplicationStateCommand.ts b/clients/client-migration-hub/commands/NotifyApplicationStateCommand.ts index d9fa00c2580c..91fff0fc54f0 100644 --- a/clients/client-migration-hub/commands/NotifyApplicationStateCommand.ts +++ b/clients/client-migration-hub/commands/NotifyApplicationStateCommand.ts @@ -25,6 +25,20 @@ export interface NotifyApplicationStateCommandOutput extends NotifyApplicationSt * value passed to ApplicationId, its status is set or updated by passing one of * three values to Status: NOT_STARTED | IN_PROGRESS | * COMPLETED.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { MigrationHubClient, NotifyApplicationStateCommand } from "@aws-sdk/client-migration-hub"; // ES Modules import + * // const { MigrationHubClient, NotifyApplicationStateCommand } = require("@aws-sdk/client-migration-hub"); // CommonJS import + * const client = new MigrationHubClient(config); + * const command = new NotifyApplicationStateCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link NotifyApplicationStateCommandInput} for command's `input` shape. + * @see {@link NotifyApplicationStateCommandOutput} for command's `response` shape. + * @see {@link MigrationHubClientResolvedConfig | config} for command's `input` shape. + * */ export class NotifyApplicationStateCommand extends $Command< NotifyApplicationStateCommandInput, diff --git a/clients/client-migration-hub/commands/NotifyMigrationTaskStateCommand.ts b/clients/client-migration-hub/commands/NotifyMigrationTaskStateCommand.ts index 02f449c782a9..5d03b7bf4a81 100644 --- a/clients/client-migration-hub/commands/NotifyMigrationTaskStateCommand.ts +++ b/clients/client-migration-hub/commands/NotifyMigrationTaskStateCommand.ts @@ -39,6 +39,20 @@ export interface NotifyMigrationTaskStateCommandOutput extends NotifyMigrationTa * namespace for each migration tool.

* * + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { MigrationHubClient, NotifyMigrationTaskStateCommand } from "@aws-sdk/client-migration-hub"; // ES Modules import + * // const { MigrationHubClient, NotifyMigrationTaskStateCommand } = require("@aws-sdk/client-migration-hub"); // CommonJS import + * const client = new MigrationHubClient(config); + * const command = new NotifyMigrationTaskStateCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link NotifyMigrationTaskStateCommandInput} for command's `input` shape. + * @see {@link NotifyMigrationTaskStateCommandOutput} for command's `response` shape. + * @see {@link MigrationHubClientResolvedConfig | config} for command's `input` shape. + * */ export class NotifyMigrationTaskStateCommand extends $Command< NotifyMigrationTaskStateCommandInput, diff --git a/clients/client-migration-hub/commands/PutResourceAttributesCommand.ts b/clients/client-migration-hub/commands/PutResourceAttributesCommand.ts index e0f01e890023..df4169dff221 100644 --- a/clients/client-migration-hub/commands/PutResourceAttributesCommand.ts +++ b/clients/client-migration-hub/commands/PutResourceAttributesCommand.ts @@ -47,6 +47,20 @@ export interface PutResourceAttributesCommandOutput extends PutResourceAttribute * association occurs or not. To confirm if an association was found based on the provided * details, call ListDiscoveredResources.

* + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { MigrationHubClient, PutResourceAttributesCommand } from "@aws-sdk/client-migration-hub"; // ES Modules import + * // const { MigrationHubClient, PutResourceAttributesCommand } = require("@aws-sdk/client-migration-hub"); // CommonJS import + * const client = new MigrationHubClient(config); + * const command = new PutResourceAttributesCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link PutResourceAttributesCommandInput} for command's `input` shape. + * @see {@link PutResourceAttributesCommandOutput} for command's `response` shape. + * @see {@link MigrationHubClientResolvedConfig | config} for command's `input` shape. + * */ export class PutResourceAttributesCommand extends $Command< PutResourceAttributesCommandInput, diff --git a/clients/client-migration-hub/models/models_0.ts b/clients/client-migration-hub/models/models_0.ts index 3660e1317b17..e13610d1a854 100644 --- a/clients/client-migration-hub/models/models_0.ts +++ b/clients/client-migration-hub/models/models_0.ts @@ -11,6 +11,9 @@ export interface AccessDeniedException extends __SmithyException, $MetadataBeare } export namespace AccessDeniedException { + /** + * @internal + */ export const filterSensitiveLog = (obj: AccessDeniedException): any => ({ ...obj, }); @@ -45,6 +48,9 @@ export interface ApplicationState { } export namespace ApplicationState { + /** + * @internal + */ export const filterSensitiveLog = (obj: ApplicationState): any => ({ ...obj, }); @@ -68,6 +74,9 @@ export interface CreatedArtifact { } export namespace CreatedArtifact { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreatedArtifact): any => ({ ...obj, }); @@ -100,6 +109,9 @@ export interface AssociateCreatedArtifactRequest { } export namespace AssociateCreatedArtifactRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: AssociateCreatedArtifactRequest): any => ({ ...obj, }); @@ -108,6 +120,9 @@ export namespace AssociateCreatedArtifactRequest { export interface AssociateCreatedArtifactResult {} export namespace AssociateCreatedArtifactResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: AssociateCreatedArtifactResult): any => ({ ...obj, }); @@ -124,6 +139,9 @@ export interface DryRunOperation extends __SmithyException, $MetadataBearer { } export namespace DryRunOperation { + /** + * @internal + */ export const filterSensitiveLog = (obj: DryRunOperation): any => ({ ...obj, }); @@ -139,6 +157,9 @@ export interface HomeRegionNotSetException extends __SmithyException, $MetadataB } export namespace HomeRegionNotSetException { + /** + * @internal + */ export const filterSensitiveLog = (obj: HomeRegionNotSetException): any => ({ ...obj, }); @@ -155,6 +176,9 @@ export interface InternalServerError extends __SmithyException, $MetadataBearer } export namespace InternalServerError { + /** + * @internal + */ export const filterSensitiveLog = (obj: InternalServerError): any => ({ ...obj, }); @@ -171,6 +195,9 @@ export interface InvalidInputException extends __SmithyException, $MetadataBeare } export namespace InvalidInputException { + /** + * @internal + */ export const filterSensitiveLog = (obj: InvalidInputException): any => ({ ...obj, }); @@ -188,6 +215,9 @@ export interface ResourceNotFoundException extends __SmithyException, $MetadataB } export namespace ResourceNotFoundException { + /** + * @internal + */ export const filterSensitiveLog = (obj: ResourceNotFoundException): any => ({ ...obj, }); @@ -204,6 +234,9 @@ export interface ServiceUnavailableException extends __SmithyException, $Metadat } export namespace ServiceUnavailableException { + /** + * @internal + */ export const filterSensitiveLog = (obj: ServiceUnavailableException): any => ({ ...obj, }); @@ -227,6 +260,9 @@ export interface ThrottlingException extends __SmithyException, $MetadataBearer } export namespace ThrottlingException { + /** + * @internal + */ export const filterSensitiveLog = (obj: ThrottlingException): any => ({ ...obj, }); @@ -243,6 +279,9 @@ export interface UnauthorizedOperation extends __SmithyException, $MetadataBeare } export namespace UnauthorizedOperation { + /** + * @internal + */ export const filterSensitiveLog = (obj: UnauthorizedOperation): any => ({ ...obj, }); @@ -266,6 +305,9 @@ export interface DiscoveredResource { } export namespace DiscoveredResource { + /** + * @internal + */ export const filterSensitiveLog = (obj: DiscoveredResource): any => ({ ...obj, }); @@ -297,6 +339,9 @@ export interface AssociateDiscoveredResourceRequest { } export namespace AssociateDiscoveredResourceRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: AssociateDiscoveredResourceRequest): any => ({ ...obj, }); @@ -305,6 +350,9 @@ export namespace AssociateDiscoveredResourceRequest { export interface AssociateDiscoveredResourceResult {} export namespace AssociateDiscoveredResourceResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: AssociateDiscoveredResourceResult): any => ({ ...obj, }); @@ -322,6 +370,9 @@ export interface PolicyErrorException extends __SmithyException, $MetadataBearer } export namespace PolicyErrorException { + /** + * @internal + */ export const filterSensitiveLog = (obj: PolicyErrorException): any => ({ ...obj, }); @@ -343,6 +394,9 @@ export interface CreateProgressUpdateStreamRequest { } export namespace CreateProgressUpdateStreamRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateProgressUpdateStreamRequest): any => ({ ...obj, }); @@ -351,6 +405,9 @@ export namespace CreateProgressUpdateStreamRequest { export interface CreateProgressUpdateStreamResult {} export namespace CreateProgressUpdateStreamResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateProgressUpdateStreamResult): any => ({ ...obj, }); @@ -372,6 +429,9 @@ export interface DeleteProgressUpdateStreamRequest { } export namespace DeleteProgressUpdateStreamRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteProgressUpdateStreamRequest): any => ({ ...obj, }); @@ -380,6 +440,9 @@ export namespace DeleteProgressUpdateStreamRequest { export interface DeleteProgressUpdateStreamResult {} export namespace DeleteProgressUpdateStreamResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteProgressUpdateStreamResult): any => ({ ...obj, }); @@ -394,6 +457,9 @@ export interface DescribeApplicationStateRequest { } export namespace DescribeApplicationStateRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeApplicationStateRequest): any => ({ ...obj, }); @@ -412,6 +478,9 @@ export interface DescribeApplicationStateResult { } export namespace DescribeApplicationStateResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeApplicationStateResult): any => ({ ...obj, }); @@ -432,6 +501,9 @@ export interface DescribeMigrationTaskRequest { } export namespace DescribeMigrationTaskRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeMigrationTaskRequest): any => ({ ...obj, }); @@ -502,6 +574,9 @@ export interface ResourceAttribute { } export namespace ResourceAttribute { + /** + * @internal + */ export const filterSensitiveLog = (obj: ResourceAttribute): any => ({ ...obj, }); @@ -537,6 +612,9 @@ export interface Task { } export namespace Task { + /** + * @internal + */ export const filterSensitiveLog = (obj: Task): any => ({ ...obj, }); @@ -576,6 +654,9 @@ export interface MigrationTask { } export namespace MigrationTask { + /** + * @internal + */ export const filterSensitiveLog = (obj: MigrationTask): any => ({ ...obj, }); @@ -589,6 +670,9 @@ export interface DescribeMigrationTaskResult { } export namespace DescribeMigrationTaskResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeMigrationTaskResult): any => ({ ...obj, }); @@ -621,6 +705,9 @@ export interface DisassociateCreatedArtifactRequest { } export namespace DisassociateCreatedArtifactRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DisassociateCreatedArtifactRequest): any => ({ ...obj, }); @@ -629,6 +716,9 @@ export namespace DisassociateCreatedArtifactRequest { export interface DisassociateCreatedArtifactResult {} export namespace DisassociateCreatedArtifactResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: DisassociateCreatedArtifactResult): any => ({ ...obj, }); @@ -661,6 +751,9 @@ export interface DisassociateDiscoveredResourceRequest { } export namespace DisassociateDiscoveredResourceRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DisassociateDiscoveredResourceRequest): any => ({ ...obj, }); @@ -669,6 +762,9 @@ export namespace DisassociateDiscoveredResourceRequest { export interface DisassociateDiscoveredResourceResult {} export namespace DisassociateDiscoveredResourceResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: DisassociateDiscoveredResourceResult): any => ({ ...obj, }); @@ -695,6 +791,9 @@ export interface ImportMigrationTaskRequest { } export namespace ImportMigrationTaskRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ImportMigrationTaskRequest): any => ({ ...obj, }); @@ -703,6 +802,9 @@ export namespace ImportMigrationTaskRequest { export interface ImportMigrationTaskResult {} export namespace ImportMigrationTaskResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: ImportMigrationTaskResult): any => ({ ...obj, }); @@ -729,6 +831,9 @@ export interface ListApplicationStatesRequest { } export namespace ListApplicationStatesRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListApplicationStatesRequest): any => ({ ...obj, }); @@ -749,6 +854,9 @@ export interface ListApplicationStatesResult { } export namespace ListApplicationStatesResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListApplicationStatesResult): any => ({ ...obj, }); @@ -781,6 +889,9 @@ export interface ListCreatedArtifactsRequest { } export namespace ListCreatedArtifactsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListCreatedArtifactsRequest): any => ({ ...obj, }); @@ -801,6 +912,9 @@ export interface ListCreatedArtifactsResult { } export namespace ListCreatedArtifactsResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListCreatedArtifactsResult): any => ({ ...obj, }); @@ -833,6 +947,9 @@ export interface ListDiscoveredResourcesRequest { } export namespace ListDiscoveredResourcesRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListDiscoveredResourcesRequest): any => ({ ...obj, }); @@ -852,6 +969,9 @@ export interface ListDiscoveredResourcesResult { } export namespace ListDiscoveredResourcesResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListDiscoveredResourcesResult): any => ({ ...obj, }); @@ -877,6 +997,9 @@ export interface ListMigrationTasksRequest { } export namespace ListMigrationTasksRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListMigrationTasksRequest): any => ({ ...obj, }); @@ -923,6 +1046,9 @@ export interface MigrationTaskSummary { } export namespace MigrationTaskSummary { + /** + * @internal + */ export const filterSensitiveLog = (obj: MigrationTaskSummary): any => ({ ...obj, }); @@ -944,6 +1070,9 @@ export interface ListMigrationTasksResult { } export namespace ListMigrationTasksResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListMigrationTasksResult): any => ({ ...obj, }); @@ -964,6 +1093,9 @@ export interface ListProgressUpdateStreamsRequest { } export namespace ListProgressUpdateStreamsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListProgressUpdateStreamsRequest): any => ({ ...obj, }); @@ -983,6 +1115,9 @@ export interface ProgressUpdateStreamSummary { } export namespace ProgressUpdateStreamSummary { + /** + * @internal + */ export const filterSensitiveLog = (obj: ProgressUpdateStreamSummary): any => ({ ...obj, }); @@ -1003,6 +1138,9 @@ export interface ListProgressUpdateStreamsResult { } export namespace ListProgressUpdateStreamsResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListProgressUpdateStreamsResult): any => ({ ...obj, }); @@ -1033,6 +1171,9 @@ export interface NotifyApplicationStateRequest { } export namespace NotifyApplicationStateRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: NotifyApplicationStateRequest): any => ({ ...obj, }); @@ -1041,6 +1182,9 @@ export namespace NotifyApplicationStateRequest { export interface NotifyApplicationStateResult {} export namespace NotifyApplicationStateResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: NotifyApplicationStateResult): any => ({ ...obj, }); @@ -1084,6 +1228,9 @@ export interface NotifyMigrationTaskStateRequest { } export namespace NotifyMigrationTaskStateRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: NotifyMigrationTaskStateRequest): any => ({ ...obj, }); @@ -1092,6 +1239,9 @@ export namespace NotifyMigrationTaskStateRequest { export interface NotifyMigrationTaskStateResult {} export namespace NotifyMigrationTaskStateResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: NotifyMigrationTaskStateResult): any => ({ ...obj, }); @@ -1150,6 +1300,9 @@ export interface PutResourceAttributesRequest { } export namespace PutResourceAttributesRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: PutResourceAttributesRequest): any => ({ ...obj, }); @@ -1158,6 +1311,9 @@ export namespace PutResourceAttributesRequest { export interface PutResourceAttributesResult {} export namespace PutResourceAttributesResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: PutResourceAttributesResult): any => ({ ...obj, }); diff --git a/clients/client-migrationhub-config/commands/CreateHomeRegionControlCommand.ts b/clients/client-migrationhub-config/commands/CreateHomeRegionControlCommand.ts index d5a53ff7e64b..42355ded5e25 100644 --- a/clients/client-migrationhub-config/commands/CreateHomeRegionControlCommand.ts +++ b/clients/client-migrationhub-config/commands/CreateHomeRegionControlCommand.ts @@ -26,6 +26,20 @@ export interface CreateHomeRegionControlCommandOutput extends CreateHomeRegionCo /** *

This API sets up the home region for the calling account only.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { MigrationHubConfigClient, CreateHomeRegionControlCommand } from "@aws-sdk/client-migrationhub-config"; // ES Modules import + * // const { MigrationHubConfigClient, CreateHomeRegionControlCommand } = require("@aws-sdk/client-migrationhub-config"); // CommonJS import + * const client = new MigrationHubConfigClient(config); + * const command = new CreateHomeRegionControlCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreateHomeRegionControlCommandInput} for command's `input` shape. + * @see {@link CreateHomeRegionControlCommandOutput} for command's `response` shape. + * @see {@link MigrationHubConfigClientResolvedConfig | config} for command's `input` shape. + * */ export class CreateHomeRegionControlCommand extends $Command< CreateHomeRegionControlCommandInput, diff --git a/clients/client-migrationhub-config/commands/DescribeHomeRegionControlsCommand.ts b/clients/client-migrationhub-config/commands/DescribeHomeRegionControlsCommand.ts index 8fc5630a4f90..6aa43a459d1d 100644 --- a/clients/client-migrationhub-config/commands/DescribeHomeRegionControlsCommand.ts +++ b/clients/client-migrationhub-config/commands/DescribeHomeRegionControlsCommand.ts @@ -27,6 +27,20 @@ export interface DescribeHomeRegionControlsCommandOutput extends DescribeHomeReg /** *

This API permits filtering on the ControlId and HomeRegion * fields.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { MigrationHubConfigClient, DescribeHomeRegionControlsCommand } from "@aws-sdk/client-migrationhub-config"; // ES Modules import + * // const { MigrationHubConfigClient, DescribeHomeRegionControlsCommand } = require("@aws-sdk/client-migrationhub-config"); // CommonJS import + * const client = new MigrationHubConfigClient(config); + * const command = new DescribeHomeRegionControlsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeHomeRegionControlsCommandInput} for command's `input` shape. + * @see {@link DescribeHomeRegionControlsCommandOutput} for command's `response` shape. + * @see {@link MigrationHubConfigClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeHomeRegionControlsCommand extends $Command< DescribeHomeRegionControlsCommandInput, diff --git a/clients/client-migrationhub-config/commands/GetHomeRegionCommand.ts b/clients/client-migrationhub-config/commands/GetHomeRegionCommand.ts index c818d77b657d..91d8146e5d62 100644 --- a/clients/client-migrationhub-config/commands/GetHomeRegionCommand.ts +++ b/clients/client-migrationhub-config/commands/GetHomeRegionCommand.ts @@ -30,6 +30,20 @@ export interface GetHomeRegionCommandOutput extends GetHomeRegionResult, __Metad * 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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { MigrationHubConfigClient, GetHomeRegionCommand } from "@aws-sdk/client-migrationhub-config"; // ES Modules import + * // const { MigrationHubConfigClient, GetHomeRegionCommand } = require("@aws-sdk/client-migrationhub-config"); // CommonJS import + * const client = new MigrationHubConfigClient(config); + * const command = new GetHomeRegionCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetHomeRegionCommandInput} for command's `input` shape. + * @see {@link GetHomeRegionCommandOutput} for command's `response` shape. + * @see {@link MigrationHubConfigClientResolvedConfig | config} for command's `input` shape. + * */ export class GetHomeRegionCommand extends $Command< GetHomeRegionCommandInput, diff --git a/clients/client-migrationhub-config/models/models_0.ts b/clients/client-migrationhub-config/models/models_0.ts index 22821ad85dae..7d071061a6b8 100644 --- a/clients/client-migrationhub-config/models/models_0.ts +++ b/clients/client-migrationhub-config/models/models_0.ts @@ -11,6 +11,9 @@ export interface AccessDeniedException extends __SmithyException, $MetadataBeare } export namespace AccessDeniedException { + /** + * @internal + */ export const filterSensitiveLog = (obj: AccessDeniedException): any => ({ ...obj, }); @@ -39,6 +42,9 @@ export interface Target { } export namespace Target { + /** + * @internal + */ export const filterSensitiveLog = (obj: Target): any => ({ ...obj, }); @@ -64,6 +70,9 @@ export interface CreateHomeRegionControlRequest { } export namespace CreateHomeRegionControlRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateHomeRegionControlRequest): any => ({ ...obj, }); @@ -102,6 +111,9 @@ export interface HomeRegionControl { } export namespace HomeRegionControl { + /** + * @internal + */ export const filterSensitiveLog = (obj: HomeRegionControl): any => ({ ...obj, }); @@ -116,6 +128,9 @@ export interface CreateHomeRegionControlResult { } export namespace CreateHomeRegionControlResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateHomeRegionControlResult): any => ({ ...obj, }); @@ -132,6 +147,9 @@ export interface DryRunOperation extends __SmithyException, $MetadataBearer { } export namespace DryRunOperation { + /** + * @internal + */ export const filterSensitiveLog = (obj: DryRunOperation): any => ({ ...obj, }); @@ -148,6 +166,9 @@ export interface InternalServerError extends __SmithyException, $MetadataBearer } export namespace InternalServerError { + /** + * @internal + */ export const filterSensitiveLog = (obj: InternalServerError): any => ({ ...obj, }); @@ -164,6 +185,9 @@ export interface InvalidInputException extends __SmithyException, $MetadataBeare } export namespace InvalidInputException { + /** + * @internal + */ export const filterSensitiveLog = (obj: InvalidInputException): any => ({ ...obj, }); @@ -180,6 +204,9 @@ export interface ServiceUnavailableException extends __SmithyException, $Metadat } export namespace ServiceUnavailableException { + /** + * @internal + */ export const filterSensitiveLog = (obj: ServiceUnavailableException): any => ({ ...obj, }); @@ -199,6 +226,9 @@ export interface ThrottlingException extends __SmithyException, $MetadataBearer } export namespace ThrottlingException { + /** + * @internal + */ export const filterSensitiveLog = (obj: ThrottlingException): any => ({ ...obj, }); @@ -237,6 +267,9 @@ export interface DescribeHomeRegionControlsRequest { } export namespace DescribeHomeRegionControlsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeHomeRegionControlsRequest): any => ({ ...obj, }); @@ -257,6 +290,9 @@ export interface DescribeHomeRegionControlsResult { } export namespace DescribeHomeRegionControlsResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeHomeRegionControlsResult): any => ({ ...obj, }); @@ -265,6 +301,9 @@ export namespace DescribeHomeRegionControlsResult { export interface GetHomeRegionRequest {} export namespace GetHomeRegionRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetHomeRegionRequest): any => ({ ...obj, }); @@ -278,6 +317,9 @@ export interface GetHomeRegionResult { } export namespace GetHomeRegionResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetHomeRegionResult): any => ({ ...obj, }); diff --git a/clients/client-mobile/commands/CreateProjectCommand.ts b/clients/client-mobile/commands/CreateProjectCommand.ts index ea946c23452b..790a7169b4da 100644 --- a/clients/client-mobile/commands/CreateProjectCommand.ts +++ b/clients/client-mobile/commands/CreateProjectCommand.ts @@ -24,6 +24,20 @@ export interface CreateProjectCommandOutput extends CreateProjectResult, __Metad *

* Creates an AWS Mobile Hub project. *

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { MobileClient, CreateProjectCommand } from "@aws-sdk/client-mobile"; // ES Modules import + * // const { MobileClient, CreateProjectCommand } = require("@aws-sdk/client-mobile"); // CommonJS import + * const client = new MobileClient(config); + * const command = new CreateProjectCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreateProjectCommandInput} for command's `input` shape. + * @see {@link CreateProjectCommandOutput} for command's `response` shape. + * @see {@link MobileClientResolvedConfig | config} for command's `input` shape. + * */ export class CreateProjectCommand extends $Command< CreateProjectCommandInput, diff --git a/clients/client-mobile/commands/DeleteProjectCommand.ts b/clients/client-mobile/commands/DeleteProjectCommand.ts index 6121b05e6b3d..b31be4e41095 100644 --- a/clients/client-mobile/commands/DeleteProjectCommand.ts +++ b/clients/client-mobile/commands/DeleteProjectCommand.ts @@ -24,6 +24,20 @@ export interface DeleteProjectCommandOutput extends DeleteProjectResult, __Metad *

* Delets a project in AWS Mobile Hub. *

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { MobileClient, DeleteProjectCommand } from "@aws-sdk/client-mobile"; // ES Modules import + * // const { MobileClient, DeleteProjectCommand } = require("@aws-sdk/client-mobile"); // CommonJS import + * const client = new MobileClient(config); + * const command = new DeleteProjectCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteProjectCommandInput} for command's `input` shape. + * @see {@link DeleteProjectCommandOutput} for command's `response` shape. + * @see {@link MobileClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteProjectCommand extends $Command< DeleteProjectCommandInput, diff --git a/clients/client-mobile/commands/DescribeBundleCommand.ts b/clients/client-mobile/commands/DescribeBundleCommand.ts index 9b587f460c2e..e839020108f0 100644 --- a/clients/client-mobile/commands/DescribeBundleCommand.ts +++ b/clients/client-mobile/commands/DescribeBundleCommand.ts @@ -24,6 +24,20 @@ export interface DescribeBundleCommandOutput extends DescribeBundleResult, __Met *

* Get the bundle details for the requested bundle id. *

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { MobileClient, DescribeBundleCommand } from "@aws-sdk/client-mobile"; // ES Modules import + * // const { MobileClient, DescribeBundleCommand } = require("@aws-sdk/client-mobile"); // CommonJS import + * const client = new MobileClient(config); + * const command = new DescribeBundleCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeBundleCommandInput} for command's `input` shape. + * @see {@link DescribeBundleCommandOutput} for command's `response` shape. + * @see {@link MobileClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeBundleCommand extends $Command< DescribeBundleCommandInput, diff --git a/clients/client-mobile/commands/DescribeProjectCommand.ts b/clients/client-mobile/commands/DescribeProjectCommand.ts index 8dbbedd23019..cf8381101b21 100644 --- a/clients/client-mobile/commands/DescribeProjectCommand.ts +++ b/clients/client-mobile/commands/DescribeProjectCommand.ts @@ -24,6 +24,20 @@ export interface DescribeProjectCommandOutput extends DescribeProjectResult, __M *

* Gets details about a project in AWS Mobile Hub. *

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { MobileClient, DescribeProjectCommand } from "@aws-sdk/client-mobile"; // ES Modules import + * // const { MobileClient, DescribeProjectCommand } = require("@aws-sdk/client-mobile"); // CommonJS import + * const client = new MobileClient(config); + * const command = new DescribeProjectCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeProjectCommandInput} for command's `input` shape. + * @see {@link DescribeProjectCommandOutput} for command's `response` shape. + * @see {@link MobileClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeProjectCommand extends $Command< DescribeProjectCommandInput, diff --git a/clients/client-mobile/commands/ExportBundleCommand.ts b/clients/client-mobile/commands/ExportBundleCommand.ts index cf43453f86d2..f54af605d4d3 100644 --- a/clients/client-mobile/commands/ExportBundleCommand.ts +++ b/clients/client-mobile/commands/ExportBundleCommand.ts @@ -25,6 +25,20 @@ export interface ExportBundleCommandOutput extends ExportBundleResult, __Metadat * Generates customized software development kit (SDK) and or tool packages * used to integrate mobile web or mobile app clients with backend AWS resources. *

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { MobileClient, ExportBundleCommand } from "@aws-sdk/client-mobile"; // ES Modules import + * // const { MobileClient, ExportBundleCommand } = require("@aws-sdk/client-mobile"); // CommonJS import + * const client = new MobileClient(config); + * const command = new ExportBundleCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ExportBundleCommandInput} for command's `input` shape. + * @see {@link ExportBundleCommandOutput} for command's `response` shape. + * @see {@link MobileClientResolvedConfig | config} for command's `input` shape. + * */ export class ExportBundleCommand extends $Command< ExportBundleCommandInput, diff --git a/clients/client-mobile/commands/ExportProjectCommand.ts b/clients/client-mobile/commands/ExportProjectCommand.ts index 5a32f72c0ddf..e2e86c7852a5 100644 --- a/clients/client-mobile/commands/ExportProjectCommand.ts +++ b/clients/client-mobile/commands/ExportProjectCommand.ts @@ -26,6 +26,20 @@ export interface ExportProjectCommandOutput extends ExportProjectResult, __Metad * Note that mobile app push credentials are encrypted in exported projects, so they * can only be shared successfully within the same AWS account. *

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { MobileClient, ExportProjectCommand } from "@aws-sdk/client-mobile"; // ES Modules import + * // const { MobileClient, ExportProjectCommand } = require("@aws-sdk/client-mobile"); // CommonJS import + * const client = new MobileClient(config); + * const command = new ExportProjectCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ExportProjectCommandInput} for command's `input` shape. + * @see {@link ExportProjectCommandOutput} for command's `response` shape. + * @see {@link MobileClientResolvedConfig | config} for command's `input` shape. + * */ export class ExportProjectCommand extends $Command< ExportProjectCommandInput, diff --git a/clients/client-mobile/commands/ListBundlesCommand.ts b/clients/client-mobile/commands/ListBundlesCommand.ts index f33c20b6c47e..b1d11c7bd0d5 100644 --- a/clients/client-mobile/commands/ListBundlesCommand.ts +++ b/clients/client-mobile/commands/ListBundlesCommand.ts @@ -24,6 +24,20 @@ export interface ListBundlesCommandOutput extends ListBundlesResult, __MetadataB *

* List all available bundles. *

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { MobileClient, ListBundlesCommand } from "@aws-sdk/client-mobile"; // ES Modules import + * // const { MobileClient, ListBundlesCommand } = require("@aws-sdk/client-mobile"); // CommonJS import + * const client = new MobileClient(config); + * const command = new ListBundlesCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListBundlesCommandInput} for command's `input` shape. + * @see {@link ListBundlesCommandOutput} for command's `response` shape. + * @see {@link MobileClientResolvedConfig | config} for command's `input` shape. + * */ export class ListBundlesCommand extends $Command< ListBundlesCommandInput, diff --git a/clients/client-mobile/commands/ListProjectsCommand.ts b/clients/client-mobile/commands/ListProjectsCommand.ts index bd6b53d299d6..740904d791a7 100644 --- a/clients/client-mobile/commands/ListProjectsCommand.ts +++ b/clients/client-mobile/commands/ListProjectsCommand.ts @@ -24,6 +24,20 @@ export interface ListProjectsCommandOutput extends ListProjectsResult, __Metadat *

* Lists projects in AWS Mobile Hub. *

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { MobileClient, ListProjectsCommand } from "@aws-sdk/client-mobile"; // ES Modules import + * // const { MobileClient, ListProjectsCommand } = require("@aws-sdk/client-mobile"); // CommonJS import + * const client = new MobileClient(config); + * const command = new ListProjectsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListProjectsCommandInput} for command's `input` shape. + * @see {@link ListProjectsCommandOutput} for command's `response` shape. + * @see {@link MobileClientResolvedConfig | config} for command's `input` shape. + * */ export class ListProjectsCommand extends $Command< ListProjectsCommandInput, diff --git a/clients/client-mobile/commands/UpdateProjectCommand.ts b/clients/client-mobile/commands/UpdateProjectCommand.ts index 086f26e33c73..7db78a48b11e 100644 --- a/clients/client-mobile/commands/UpdateProjectCommand.ts +++ b/clients/client-mobile/commands/UpdateProjectCommand.ts @@ -24,6 +24,20 @@ export interface UpdateProjectCommandOutput extends UpdateProjectResult, __Metad *

* Update an existing project. *

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { MobileClient, UpdateProjectCommand } from "@aws-sdk/client-mobile"; // ES Modules import + * // const { MobileClient, UpdateProjectCommand } = require("@aws-sdk/client-mobile"); // CommonJS import + * const client = new MobileClient(config); + * const command = new UpdateProjectCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link UpdateProjectCommandInput} for command's `input` shape. + * @see {@link UpdateProjectCommandOutput} for command's `response` shape. + * @see {@link MobileClientResolvedConfig | config} for command's `input` shape. + * */ export class UpdateProjectCommand extends $Command< UpdateProjectCommandInput, diff --git a/clients/client-mobile/models/models_0.ts b/clients/client-mobile/models/models_0.ts index a346ec881690..6359ae5c0b3a 100644 --- a/clients/client-mobile/models/models_0.ts +++ b/clients/client-mobile/models/models_0.ts @@ -18,6 +18,9 @@ export interface AccountActionRequiredException extends __SmithyException, $Meta } export namespace AccountActionRequiredException { + /** + * @internal + */ export const filterSensitiveLog = (obj: AccountActionRequiredException): any => ({ ...obj, }); @@ -41,6 +44,9 @@ export interface BadRequestException extends __SmithyException, $MetadataBearer } export namespace BadRequestException { + /** + * @internal + */ export const filterSensitiveLog = (obj: BadRequestException): any => ({ ...obj, }); @@ -85,6 +91,9 @@ export interface CreateProjectRequest { } export namespace CreateProjectRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateProjectRequest): any => ({ ...obj, }); @@ -133,6 +142,9 @@ export interface Resource { } export namespace Resource { + /** + * @internal + */ export const filterSensitiveLog = (obj: Resource): any => ({ ...obj, }); @@ -208,6 +220,9 @@ export interface ProjectDetails { } export namespace ProjectDetails { + /** + * @internal + */ export const filterSensitiveLog = (obj: ProjectDetails): any => ({ ...obj, }); @@ -228,6 +243,9 @@ export interface CreateProjectResult { } export namespace CreateProjectResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateProjectResult): any => ({ ...obj, }); @@ -251,6 +269,9 @@ export interface InternalFailureException extends __SmithyException, $MetadataBe } export namespace InternalFailureException { + /** + * @internal + */ export const filterSensitiveLog = (obj: InternalFailureException): any => ({ ...obj, }); @@ -283,6 +304,9 @@ export interface LimitExceededException extends __SmithyException, $MetadataBear } export namespace LimitExceededException { + /** + * @internal + */ export const filterSensitiveLog = (obj: LimitExceededException): any => ({ ...obj, }); @@ -305,6 +329,9 @@ export interface NotFoundException extends __SmithyException, $MetadataBearer { } export namespace NotFoundException { + /** + * @internal + */ export const filterSensitiveLog = (obj: NotFoundException): any => ({ ...obj, }); @@ -335,6 +362,9 @@ export interface ServiceUnavailableException extends __SmithyException, $Metadat } export namespace ServiceUnavailableException { + /** + * @internal + */ export const filterSensitiveLog = (obj: ServiceUnavailableException): any => ({ ...obj, }); @@ -365,6 +395,9 @@ export interface TooManyRequestsException extends __SmithyException, $MetadataBe } export namespace TooManyRequestsException { + /** + * @internal + */ export const filterSensitiveLog = (obj: TooManyRequestsException): any => ({ ...obj, }); @@ -387,6 +420,9 @@ export interface UnauthorizedException extends __SmithyException, $MetadataBeare } export namespace UnauthorizedException { + /** + * @internal + */ export const filterSensitiveLog = (obj: UnauthorizedException): any => ({ ...obj, }); @@ -407,6 +443,9 @@ export interface DeleteProjectRequest { } export namespace DeleteProjectRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteProjectRequest): any => ({ ...obj, }); @@ -435,6 +474,9 @@ export interface DeleteProjectResult { } export namespace DeleteProjectResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteProjectResult): any => ({ ...obj, }); @@ -455,6 +497,9 @@ export interface DescribeBundleRequest { } export namespace DescribeBundleRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeBundleRequest): any => ({ ...obj, }); @@ -520,6 +565,9 @@ export interface BundleDetails { } export namespace BundleDetails { + /** + * @internal + */ export const filterSensitiveLog = (obj: BundleDetails): any => ({ ...obj, }); @@ -540,6 +588,9 @@ export interface DescribeBundleResult { } export namespace DescribeBundleResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeBundleResult): any => ({ ...obj, }); @@ -567,6 +618,9 @@ export interface DescribeProjectRequest { } export namespace DescribeProjectRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeProjectRequest): any => ({ ...obj, }); @@ -587,6 +641,9 @@ export interface DescribeProjectResult { } export namespace DescribeProjectResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeProjectResult): any => ({ ...obj, }); @@ -622,6 +679,9 @@ export interface ExportBundleRequest { } export namespace ExportBundleRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ExportBundleRequest): any => ({ ...obj, }); @@ -646,6 +706,9 @@ export interface ExportBundleResult { } export namespace ExportBundleResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: ExportBundleResult): any => ({ ...obj, }); @@ -666,6 +729,9 @@ export interface ExportProjectRequest { } export namespace ExportProjectRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ExportProjectRequest): any => ({ ...obj, }); @@ -706,6 +772,9 @@ export interface ExportProjectResult { } export namespace ExportProjectResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: ExportProjectResult): any => ({ ...obj, }); @@ -735,6 +804,9 @@ export interface ListBundlesRequest { } export namespace ListBundlesRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListBundlesRequest): any => ({ ...obj, }); @@ -763,6 +835,9 @@ export interface ListBundlesResult { } export namespace ListBundlesResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListBundlesResult): any => ({ ...obj, }); @@ -792,6 +867,9 @@ export interface ListProjectsRequest { } export namespace ListProjectsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListProjectsRequest): any => ({ ...obj, }); @@ -819,6 +897,9 @@ export interface ProjectSummary { } export namespace ProjectSummary { + /** + * @internal + */ export const filterSensitiveLog = (obj: ProjectSummary): any => ({ ...obj, }); @@ -848,6 +929,9 @@ export interface ListProjectsResult { } export namespace ListProjectsResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListProjectsResult): any => ({ ...obj, }); @@ -877,6 +961,9 @@ export interface UpdateProjectRequest { } export namespace UpdateProjectRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateProjectRequest): any => ({ ...obj, }); @@ -897,6 +984,9 @@ export interface UpdateProjectResult { } export namespace UpdateProjectResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateProjectResult): any => ({ ...obj, }); diff --git a/clients/client-mq/commands/CreateBrokerCommand.ts b/clients/client-mq/commands/CreateBrokerCommand.ts index 6cb0417e8ac1..948e2acffa32 100644 --- a/clients/client-mq/commands/CreateBrokerCommand.ts +++ b/clients/client-mq/commands/CreateBrokerCommand.ts @@ -22,6 +22,20 @@ export interface CreateBrokerCommandOutput extends CreateBrokerResponse, __Metad /** * Creates a broker. Note: This API is asynchronous. + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { MqClient, CreateBrokerCommand } from "@aws-sdk/client-mq"; // ES Modules import + * // const { MqClient, CreateBrokerCommand } = require("@aws-sdk/client-mq"); // CommonJS import + * const client = new MqClient(config); + * const command = new CreateBrokerCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreateBrokerCommandInput} for command's `input` shape. + * @see {@link CreateBrokerCommandOutput} for command's `response` shape. + * @see {@link MqClientResolvedConfig | config} for command's `input` shape. + * */ export class CreateBrokerCommand extends $Command< CreateBrokerCommandInput, diff --git a/clients/client-mq/commands/CreateConfigurationCommand.ts b/clients/client-mq/commands/CreateConfigurationCommand.ts index ae833c63ee5b..5dde610b10b9 100644 --- a/clients/client-mq/commands/CreateConfigurationCommand.ts +++ b/clients/client-mq/commands/CreateConfigurationCommand.ts @@ -22,6 +22,20 @@ export interface CreateConfigurationCommandOutput extends CreateConfigurationRes /** * Creates a new configuration for the specified configuration name. Amazon MQ uses the default configuration (the engine type and version). + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { MqClient, CreateConfigurationCommand } from "@aws-sdk/client-mq"; // ES Modules import + * // const { MqClient, CreateConfigurationCommand } = require("@aws-sdk/client-mq"); // CommonJS import + * const client = new MqClient(config); + * const command = new CreateConfigurationCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreateConfigurationCommandInput} for command's `input` shape. + * @see {@link CreateConfigurationCommandOutput} for command's `response` shape. + * @see {@link MqClientResolvedConfig | config} for command's `input` shape. + * */ export class CreateConfigurationCommand extends $Command< CreateConfigurationCommandInput, diff --git a/clients/client-mq/commands/CreateTagsCommand.ts b/clients/client-mq/commands/CreateTagsCommand.ts index 5b7b871bd0b4..3f52af857f2d 100644 --- a/clients/client-mq/commands/CreateTagsCommand.ts +++ b/clients/client-mq/commands/CreateTagsCommand.ts @@ -22,6 +22,20 @@ export interface CreateTagsCommandOutput extends __MetadataBearer {} /** * Add a tag to a resource. + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { MqClient, CreateTagsCommand } from "@aws-sdk/client-mq"; // ES Modules import + * // const { MqClient, CreateTagsCommand } = require("@aws-sdk/client-mq"); // CommonJS import + * const client = new MqClient(config); + * const command = new CreateTagsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreateTagsCommandInput} for command's `input` shape. + * @see {@link CreateTagsCommandOutput} for command's `response` shape. + * @see {@link MqClientResolvedConfig | config} for command's `input` shape. + * */ export class CreateTagsCommand extends $Command< CreateTagsCommandInput, diff --git a/clients/client-mq/commands/CreateUserCommand.ts b/clients/client-mq/commands/CreateUserCommand.ts index 53f225206355..fcd49846c069 100644 --- a/clients/client-mq/commands/CreateUserCommand.ts +++ b/clients/client-mq/commands/CreateUserCommand.ts @@ -22,6 +22,20 @@ export interface CreateUserCommandOutput extends CreateUserResponse, __MetadataB /** * Creates an ActiveMQ user. + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { MqClient, CreateUserCommand } from "@aws-sdk/client-mq"; // ES Modules import + * // const { MqClient, CreateUserCommand } = require("@aws-sdk/client-mq"); // CommonJS import + * const client = new MqClient(config); + * const command = new CreateUserCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreateUserCommandInput} for command's `input` shape. + * @see {@link CreateUserCommandOutput} for command's `response` shape. + * @see {@link MqClientResolvedConfig | config} for command's `input` shape. + * */ export class CreateUserCommand extends $Command< CreateUserCommandInput, diff --git a/clients/client-mq/commands/DeleteBrokerCommand.ts b/clients/client-mq/commands/DeleteBrokerCommand.ts index 0316e87767c7..926e3620181e 100644 --- a/clients/client-mq/commands/DeleteBrokerCommand.ts +++ b/clients/client-mq/commands/DeleteBrokerCommand.ts @@ -22,6 +22,20 @@ export interface DeleteBrokerCommandOutput extends DeleteBrokerResponse, __Metad /** * Deletes a broker. Note: This API is asynchronous. + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { MqClient, DeleteBrokerCommand } from "@aws-sdk/client-mq"; // ES Modules import + * // const { MqClient, DeleteBrokerCommand } = require("@aws-sdk/client-mq"); // CommonJS import + * const client = new MqClient(config); + * const command = new DeleteBrokerCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteBrokerCommandInput} for command's `input` shape. + * @see {@link DeleteBrokerCommandOutput} for command's `response` shape. + * @see {@link MqClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteBrokerCommand extends $Command< DeleteBrokerCommandInput, diff --git a/clients/client-mq/commands/DeleteTagsCommand.ts b/clients/client-mq/commands/DeleteTagsCommand.ts index 6d9f6adbd800..87c8ac4bbf14 100644 --- a/clients/client-mq/commands/DeleteTagsCommand.ts +++ b/clients/client-mq/commands/DeleteTagsCommand.ts @@ -22,6 +22,20 @@ export interface DeleteTagsCommandOutput extends __MetadataBearer {} /** * Removes a tag from a resource. + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { MqClient, DeleteTagsCommand } from "@aws-sdk/client-mq"; // ES Modules import + * // const { MqClient, DeleteTagsCommand } = require("@aws-sdk/client-mq"); // CommonJS import + * const client = new MqClient(config); + * const command = new DeleteTagsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteTagsCommandInput} for command's `input` shape. + * @see {@link DeleteTagsCommandOutput} for command's `response` shape. + * @see {@link MqClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteTagsCommand extends $Command< DeleteTagsCommandInput, diff --git a/clients/client-mq/commands/DeleteUserCommand.ts b/clients/client-mq/commands/DeleteUserCommand.ts index c05c18cf6f7b..9348db6bceb9 100644 --- a/clients/client-mq/commands/DeleteUserCommand.ts +++ b/clients/client-mq/commands/DeleteUserCommand.ts @@ -22,6 +22,20 @@ export interface DeleteUserCommandOutput extends DeleteUserResponse, __MetadataB /** * Deletes an ActiveMQ user. + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { MqClient, DeleteUserCommand } from "@aws-sdk/client-mq"; // ES Modules import + * // const { MqClient, DeleteUserCommand } = require("@aws-sdk/client-mq"); // CommonJS import + * const client = new MqClient(config); + * const command = new DeleteUserCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteUserCommandInput} for command's `input` shape. + * @see {@link DeleteUserCommandOutput} for command's `response` shape. + * @see {@link MqClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteUserCommand extends $Command< DeleteUserCommandInput, diff --git a/clients/client-mq/commands/DescribeBrokerCommand.ts b/clients/client-mq/commands/DescribeBrokerCommand.ts index d2956587d8f1..4510d96cdfa0 100644 --- a/clients/client-mq/commands/DescribeBrokerCommand.ts +++ b/clients/client-mq/commands/DescribeBrokerCommand.ts @@ -22,6 +22,20 @@ export interface DescribeBrokerCommandOutput extends DescribeBrokerResponse, __M /** * Returns information about the specified broker. + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { MqClient, DescribeBrokerCommand } from "@aws-sdk/client-mq"; // ES Modules import + * // const { MqClient, DescribeBrokerCommand } = require("@aws-sdk/client-mq"); // CommonJS import + * const client = new MqClient(config); + * const command = new DescribeBrokerCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeBrokerCommandInput} for command's `input` shape. + * @see {@link DescribeBrokerCommandOutput} for command's `response` shape. + * @see {@link MqClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeBrokerCommand extends $Command< DescribeBrokerCommandInput, diff --git a/clients/client-mq/commands/DescribeBrokerEngineTypesCommand.ts b/clients/client-mq/commands/DescribeBrokerEngineTypesCommand.ts index 57d9ffa5f6f9..a4e82e77463d 100644 --- a/clients/client-mq/commands/DescribeBrokerEngineTypesCommand.ts +++ b/clients/client-mq/commands/DescribeBrokerEngineTypesCommand.ts @@ -22,6 +22,20 @@ export interface DescribeBrokerEngineTypesCommandOutput extends DescribeBrokerEn /** * Describe available engine types and versions. + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { MqClient, DescribeBrokerEngineTypesCommand } from "@aws-sdk/client-mq"; // ES Modules import + * // const { MqClient, DescribeBrokerEngineTypesCommand } = require("@aws-sdk/client-mq"); // CommonJS import + * const client = new MqClient(config); + * const command = new DescribeBrokerEngineTypesCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeBrokerEngineTypesCommandInput} for command's `input` shape. + * @see {@link DescribeBrokerEngineTypesCommandOutput} for command's `response` shape. + * @see {@link MqClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeBrokerEngineTypesCommand extends $Command< DescribeBrokerEngineTypesCommandInput, diff --git a/clients/client-mq/commands/DescribeBrokerInstanceOptionsCommand.ts b/clients/client-mq/commands/DescribeBrokerInstanceOptionsCommand.ts index 28380b379eb0..fd59d905938c 100644 --- a/clients/client-mq/commands/DescribeBrokerInstanceOptionsCommand.ts +++ b/clients/client-mq/commands/DescribeBrokerInstanceOptionsCommand.ts @@ -24,6 +24,20 @@ export interface DescribeBrokerInstanceOptionsCommandOutput /** * Describe available broker instance options. + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { MqClient, DescribeBrokerInstanceOptionsCommand } from "@aws-sdk/client-mq"; // ES Modules import + * // const { MqClient, DescribeBrokerInstanceOptionsCommand } = require("@aws-sdk/client-mq"); // CommonJS import + * const client = new MqClient(config); + * const command = new DescribeBrokerInstanceOptionsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeBrokerInstanceOptionsCommandInput} for command's `input` shape. + * @see {@link DescribeBrokerInstanceOptionsCommandOutput} for command's `response` shape. + * @see {@link MqClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeBrokerInstanceOptionsCommand extends $Command< DescribeBrokerInstanceOptionsCommandInput, diff --git a/clients/client-mq/commands/DescribeConfigurationCommand.ts b/clients/client-mq/commands/DescribeConfigurationCommand.ts index a3191986ba84..bf529bafc1d3 100644 --- a/clients/client-mq/commands/DescribeConfigurationCommand.ts +++ b/clients/client-mq/commands/DescribeConfigurationCommand.ts @@ -22,6 +22,20 @@ export interface DescribeConfigurationCommandOutput extends DescribeConfiguratio /** * Returns information about the specified configuration. + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { MqClient, DescribeConfigurationCommand } from "@aws-sdk/client-mq"; // ES Modules import + * // const { MqClient, DescribeConfigurationCommand } = require("@aws-sdk/client-mq"); // CommonJS import + * const client = new MqClient(config); + * const command = new DescribeConfigurationCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeConfigurationCommandInput} for command's `input` shape. + * @see {@link DescribeConfigurationCommandOutput} for command's `response` shape. + * @see {@link MqClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeConfigurationCommand extends $Command< DescribeConfigurationCommandInput, diff --git a/clients/client-mq/commands/DescribeConfigurationRevisionCommand.ts b/clients/client-mq/commands/DescribeConfigurationRevisionCommand.ts index 2f98cfc437f8..bc620c72386a 100644 --- a/clients/client-mq/commands/DescribeConfigurationRevisionCommand.ts +++ b/clients/client-mq/commands/DescribeConfigurationRevisionCommand.ts @@ -24,6 +24,20 @@ export interface DescribeConfigurationRevisionCommandOutput /** * Returns the specified configuration revision for the specified configuration. + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { MqClient, DescribeConfigurationRevisionCommand } from "@aws-sdk/client-mq"; // ES Modules import + * // const { MqClient, DescribeConfigurationRevisionCommand } = require("@aws-sdk/client-mq"); // CommonJS import + * const client = new MqClient(config); + * const command = new DescribeConfigurationRevisionCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeConfigurationRevisionCommandInput} for command's `input` shape. + * @see {@link DescribeConfigurationRevisionCommandOutput} for command's `response` shape. + * @see {@link MqClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeConfigurationRevisionCommand extends $Command< DescribeConfigurationRevisionCommandInput, diff --git a/clients/client-mq/commands/DescribeUserCommand.ts b/clients/client-mq/commands/DescribeUserCommand.ts index 53c9bbd2ed12..53ff7b5b33ba 100644 --- a/clients/client-mq/commands/DescribeUserCommand.ts +++ b/clients/client-mq/commands/DescribeUserCommand.ts @@ -22,6 +22,20 @@ export interface DescribeUserCommandOutput extends DescribeUserResponse, __Metad /** * Returns information about an ActiveMQ user. + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { MqClient, DescribeUserCommand } from "@aws-sdk/client-mq"; // ES Modules import + * // const { MqClient, DescribeUserCommand } = require("@aws-sdk/client-mq"); // CommonJS import + * const client = new MqClient(config); + * const command = new DescribeUserCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeUserCommandInput} for command's `input` shape. + * @see {@link DescribeUserCommandOutput} for command's `response` shape. + * @see {@link MqClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeUserCommand extends $Command< DescribeUserCommandInput, diff --git a/clients/client-mq/commands/ListBrokersCommand.ts b/clients/client-mq/commands/ListBrokersCommand.ts index 5f3216e2d663..cdb89ace808a 100644 --- a/clients/client-mq/commands/ListBrokersCommand.ts +++ b/clients/client-mq/commands/ListBrokersCommand.ts @@ -22,6 +22,20 @@ export interface ListBrokersCommandOutput extends ListBrokersResponse, __Metadat /** * Returns a list of all brokers. + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { MqClient, ListBrokersCommand } from "@aws-sdk/client-mq"; // ES Modules import + * // const { MqClient, ListBrokersCommand } = require("@aws-sdk/client-mq"); // CommonJS import + * const client = new MqClient(config); + * const command = new ListBrokersCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListBrokersCommandInput} for command's `input` shape. + * @see {@link ListBrokersCommandOutput} for command's `response` shape. + * @see {@link MqClientResolvedConfig | config} for command's `input` shape. + * */ export class ListBrokersCommand extends $Command< ListBrokersCommandInput, diff --git a/clients/client-mq/commands/ListConfigurationRevisionsCommand.ts b/clients/client-mq/commands/ListConfigurationRevisionsCommand.ts index 830f1e3dccd7..ea1091b3958c 100644 --- a/clients/client-mq/commands/ListConfigurationRevisionsCommand.ts +++ b/clients/client-mq/commands/ListConfigurationRevisionsCommand.ts @@ -22,6 +22,20 @@ export interface ListConfigurationRevisionsCommandOutput extends ListConfigurati /** * Returns a list of all revisions for the specified configuration. + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { MqClient, ListConfigurationRevisionsCommand } from "@aws-sdk/client-mq"; // ES Modules import + * // const { MqClient, ListConfigurationRevisionsCommand } = require("@aws-sdk/client-mq"); // CommonJS import + * const client = new MqClient(config); + * const command = new ListConfigurationRevisionsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListConfigurationRevisionsCommandInput} for command's `input` shape. + * @see {@link ListConfigurationRevisionsCommandOutput} for command's `response` shape. + * @see {@link MqClientResolvedConfig | config} for command's `input` shape. + * */ export class ListConfigurationRevisionsCommand extends $Command< ListConfigurationRevisionsCommandInput, diff --git a/clients/client-mq/commands/ListConfigurationsCommand.ts b/clients/client-mq/commands/ListConfigurationsCommand.ts index 34890cef1798..130521ed5405 100644 --- a/clients/client-mq/commands/ListConfigurationsCommand.ts +++ b/clients/client-mq/commands/ListConfigurationsCommand.ts @@ -22,6 +22,20 @@ export interface ListConfigurationsCommandOutput extends ListConfigurationsRespo /** * Returns a list of all configurations. + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { MqClient, ListConfigurationsCommand } from "@aws-sdk/client-mq"; // ES Modules import + * // const { MqClient, ListConfigurationsCommand } = require("@aws-sdk/client-mq"); // CommonJS import + * const client = new MqClient(config); + * const command = new ListConfigurationsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListConfigurationsCommandInput} for command's `input` shape. + * @see {@link ListConfigurationsCommandOutput} for command's `response` shape. + * @see {@link MqClientResolvedConfig | config} for command's `input` shape. + * */ export class ListConfigurationsCommand extends $Command< ListConfigurationsCommandInput, diff --git a/clients/client-mq/commands/ListTagsCommand.ts b/clients/client-mq/commands/ListTagsCommand.ts index 9fb4f7ab41dd..893de7272632 100644 --- a/clients/client-mq/commands/ListTagsCommand.ts +++ b/clients/client-mq/commands/ListTagsCommand.ts @@ -22,6 +22,20 @@ export interface ListTagsCommandOutput extends ListTagsResponse, __MetadataBeare /** * Lists tags for a resource. + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { MqClient, ListTagsCommand } from "@aws-sdk/client-mq"; // ES Modules import + * // const { MqClient, ListTagsCommand } = require("@aws-sdk/client-mq"); // CommonJS import + * const client = new MqClient(config); + * const command = new ListTagsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListTagsCommandInput} for command's `input` shape. + * @see {@link ListTagsCommandOutput} for command's `response` shape. + * @see {@link MqClientResolvedConfig | config} for command's `input` shape. + * */ export class ListTagsCommand extends $Command { // Start section: command_properties diff --git a/clients/client-mq/commands/ListUsersCommand.ts b/clients/client-mq/commands/ListUsersCommand.ts index 022c8435f93f..f95dbf433381 100644 --- a/clients/client-mq/commands/ListUsersCommand.ts +++ b/clients/client-mq/commands/ListUsersCommand.ts @@ -22,6 +22,20 @@ export interface ListUsersCommandOutput extends ListUsersResponse, __MetadataBea /** * Returns a list of all ActiveMQ users. + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { MqClient, ListUsersCommand } from "@aws-sdk/client-mq"; // ES Modules import + * // const { MqClient, ListUsersCommand } = require("@aws-sdk/client-mq"); // CommonJS import + * const client = new MqClient(config); + * const command = new ListUsersCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListUsersCommandInput} for command's `input` shape. + * @see {@link ListUsersCommandOutput} for command's `response` shape. + * @see {@link MqClientResolvedConfig | config} for command's `input` shape. + * */ export class ListUsersCommand extends $Command { // Start section: command_properties diff --git a/clients/client-mq/commands/RebootBrokerCommand.ts b/clients/client-mq/commands/RebootBrokerCommand.ts index 85005e2622d8..048231cbc33e 100644 --- a/clients/client-mq/commands/RebootBrokerCommand.ts +++ b/clients/client-mq/commands/RebootBrokerCommand.ts @@ -22,6 +22,20 @@ export interface RebootBrokerCommandOutput extends RebootBrokerResponse, __Metad /** * Reboots a broker. Note: This API is asynchronous. + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { MqClient, RebootBrokerCommand } from "@aws-sdk/client-mq"; // ES Modules import + * // const { MqClient, RebootBrokerCommand } = require("@aws-sdk/client-mq"); // CommonJS import + * const client = new MqClient(config); + * const command = new RebootBrokerCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link RebootBrokerCommandInput} for command's `input` shape. + * @see {@link RebootBrokerCommandOutput} for command's `response` shape. + * @see {@link MqClientResolvedConfig | config} for command's `input` shape. + * */ export class RebootBrokerCommand extends $Command< RebootBrokerCommandInput, diff --git a/clients/client-mq/commands/UpdateBrokerCommand.ts b/clients/client-mq/commands/UpdateBrokerCommand.ts index 9eb7fbecdb1f..81f6f7bc210f 100644 --- a/clients/client-mq/commands/UpdateBrokerCommand.ts +++ b/clients/client-mq/commands/UpdateBrokerCommand.ts @@ -22,6 +22,20 @@ export interface UpdateBrokerCommandOutput extends UpdateBrokerResponse, __Metad /** * Adds a pending configuration change to a broker. + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { MqClient, UpdateBrokerCommand } from "@aws-sdk/client-mq"; // ES Modules import + * // const { MqClient, UpdateBrokerCommand } = require("@aws-sdk/client-mq"); // CommonJS import + * const client = new MqClient(config); + * const command = new UpdateBrokerCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link UpdateBrokerCommandInput} for command's `input` shape. + * @see {@link UpdateBrokerCommandOutput} for command's `response` shape. + * @see {@link MqClientResolvedConfig | config} for command's `input` shape. + * */ export class UpdateBrokerCommand extends $Command< UpdateBrokerCommandInput, diff --git a/clients/client-mq/commands/UpdateConfigurationCommand.ts b/clients/client-mq/commands/UpdateConfigurationCommand.ts index 7281c378cc05..2039ddb6a265 100644 --- a/clients/client-mq/commands/UpdateConfigurationCommand.ts +++ b/clients/client-mq/commands/UpdateConfigurationCommand.ts @@ -22,6 +22,20 @@ export interface UpdateConfigurationCommandOutput extends UpdateConfigurationRes /** * Updates the specified configuration. + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { MqClient, UpdateConfigurationCommand } from "@aws-sdk/client-mq"; // ES Modules import + * // const { MqClient, UpdateConfigurationCommand } = require("@aws-sdk/client-mq"); // CommonJS import + * const client = new MqClient(config); + * const command = new UpdateConfigurationCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link UpdateConfigurationCommandInput} for command's `input` shape. + * @see {@link UpdateConfigurationCommandOutput} for command's `response` shape. + * @see {@link MqClientResolvedConfig | config} for command's `input` shape. + * */ export class UpdateConfigurationCommand extends $Command< UpdateConfigurationCommandInput, diff --git a/clients/client-mq/commands/UpdateUserCommand.ts b/clients/client-mq/commands/UpdateUserCommand.ts index c12bc2b8b860..16176fa64cdb 100644 --- a/clients/client-mq/commands/UpdateUserCommand.ts +++ b/clients/client-mq/commands/UpdateUserCommand.ts @@ -22,6 +22,20 @@ export interface UpdateUserCommandOutput extends UpdateUserResponse, __MetadataB /** * Updates the information for an ActiveMQ user. + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { MqClient, UpdateUserCommand } from "@aws-sdk/client-mq"; // ES Modules import + * // const { MqClient, UpdateUserCommand } = require("@aws-sdk/client-mq"); // CommonJS import + * const client = new MqClient(config); + * const command = new UpdateUserCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link UpdateUserCommandInput} for command's `input` shape. + * @see {@link UpdateUserCommandOutput} for command's `response` shape. + * @see {@link MqClientResolvedConfig | config} for command's `input` shape. + * */ export class UpdateUserCommand extends $Command< UpdateUserCommandInput, diff --git a/clients/client-mq/models/models_0.ts b/clients/client-mq/models/models_0.ts index 86556a96c621..5de495e44044 100644 --- a/clients/client-mq/models/models_0.ts +++ b/clients/client-mq/models/models_0.ts @@ -12,6 +12,9 @@ export interface AvailabilityZone { } export namespace AvailabilityZone { + /** + * @internal + */ export const filterSensitiveLog = (obj: AvailabilityZone): any => ({ ...obj, }); @@ -33,6 +36,9 @@ export interface EngineVersion { } export namespace EngineVersion { + /** + * @internal + */ export const filterSensitiveLog = (obj: EngineVersion): any => ({ ...obj, }); @@ -54,6 +60,9 @@ export interface BrokerEngineType { } export namespace BrokerEngineType { + /** + * @internal + */ export const filterSensitiveLog = (obj: BrokerEngineType): any => ({ ...obj, }); @@ -80,6 +89,9 @@ export interface BrokerInstance { } export namespace BrokerInstance { + /** + * @internal + */ export const filterSensitiveLog = (obj: BrokerInstance): any => ({ ...obj, }); @@ -132,6 +144,9 @@ export interface BrokerInstanceOption { } export namespace BrokerInstanceOption { + /** + * @internal + */ export const filterSensitiveLog = (obj: BrokerInstanceOption): any => ({ ...obj, }); @@ -191,6 +206,9 @@ export interface BrokerSummary { } export namespace BrokerSummary { + /** + * @internal + */ export const filterSensitiveLog = (obj: BrokerSummary): any => ({ ...obj, }); @@ -222,6 +240,9 @@ export interface ConfigurationRevision { } export namespace ConfigurationRevision { + /** + * @internal + */ export const filterSensitiveLog = (obj: ConfigurationRevision): any => ({ ...obj, }); @@ -283,6 +304,9 @@ export interface Configuration { } export namespace Configuration { + /** + * @internal + */ export const filterSensitiveLog = (obj: Configuration): any => ({ ...obj, }); @@ -304,6 +328,9 @@ export interface ConfigurationId { } export namespace ConfigurationId { + /** + * @internal + */ export const filterSensitiveLog = (obj: ConfigurationId): any => ({ ...obj, }); @@ -336,6 +363,9 @@ export interface SanitizationWarning { } export namespace SanitizationWarning { + /** + * @internal + */ export const filterSensitiveLog = (obj: SanitizationWarning): any => ({ ...obj, }); @@ -367,6 +397,9 @@ export interface User { } export namespace User { + /** + * @internal + */ export const filterSensitiveLog = (obj: User): any => ({ ...obj, }); @@ -394,6 +427,9 @@ export interface UserSummary { } export namespace UserSummary { + /** + * @internal + */ export const filterSensitiveLog = (obj: UserSummary): any => ({ ...obj, }); @@ -417,6 +453,9 @@ export interface BadRequestException extends __SmithyException, $MetadataBearer } export namespace BadRequestException { + /** + * @internal + */ export const filterSensitiveLog = (obj: BadRequestException): any => ({ ...obj, }); @@ -443,6 +482,9 @@ export interface Configurations { } export namespace Configurations { + /** + * @internal + */ export const filterSensitiveLog = (obj: Configurations): any => ({ ...obj, }); @@ -466,6 +508,9 @@ export interface ConflictException extends __SmithyException, $MetadataBearer { } export namespace ConflictException { + /** + * @internal + */ export const filterSensitiveLog = (obj: ConflictException): any => ({ ...obj, }); @@ -487,6 +532,9 @@ export interface EncryptionOptions { } export namespace EncryptionOptions { + /** + * @internal + */ export const filterSensitiveLog = (obj: EncryptionOptions): any => ({ ...obj, }); @@ -553,6 +601,9 @@ export interface LdapServerMetadataInput { } export namespace LdapServerMetadataInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: LdapServerMetadataInput): any => ({ ...obj, }); @@ -574,6 +625,9 @@ export interface Logs { } export namespace Logs { + /** + * @internal + */ export const filterSensitiveLog = (obj: Logs): any => ({ ...obj, }); @@ -610,6 +664,9 @@ export interface WeeklyStartTime { } export namespace WeeklyStartTime { + /** + * @internal + */ export const filterSensitiveLog = (obj: WeeklyStartTime): any => ({ ...obj, }); @@ -716,6 +773,9 @@ export interface CreateBrokerRequest { } export namespace CreateBrokerRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateBrokerRequest): any => ({ ...obj, }); @@ -734,6 +794,9 @@ export interface CreateBrokerResponse { } export namespace CreateBrokerResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateBrokerResponse): any => ({ ...obj, }); @@ -757,6 +820,9 @@ export interface ForbiddenException extends __SmithyException, $MetadataBearer { } export namespace ForbiddenException { + /** + * @internal + */ export const filterSensitiveLog = (obj: ForbiddenException): any => ({ ...obj, }); @@ -780,6 +846,9 @@ export interface InternalServerErrorException extends __SmithyException, $Metada } export namespace InternalServerErrorException { + /** + * @internal + */ export const filterSensitiveLog = (obj: InternalServerErrorException): any => ({ ...obj, }); @@ -803,6 +872,9 @@ export interface UnauthorizedException extends __SmithyException, $MetadataBeare } export namespace UnauthorizedException { + /** + * @internal + */ export const filterSensitiveLog = (obj: UnauthorizedException): any => ({ ...obj, }); @@ -839,6 +911,9 @@ export interface CreateConfigurationRequest { } export namespace CreateConfigurationRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateConfigurationRequest): any => ({ ...obj, }); @@ -877,6 +952,9 @@ export interface CreateConfigurationResponse { } export namespace CreateConfigurationResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateConfigurationResponse): any => ({ ...obj, }); @@ -898,6 +976,9 @@ export interface CreateTagsRequest { } export namespace CreateTagsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateTagsRequest): any => ({ ...obj, }); @@ -921,6 +1002,9 @@ export interface NotFoundException extends __SmithyException, $MetadataBearer { } export namespace NotFoundException { + /** + * @internal + */ export const filterSensitiveLog = (obj: NotFoundException): any => ({ ...obj, }); @@ -957,6 +1041,9 @@ export interface CreateUserRequest { } export namespace CreateUserRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateUserRequest): any => ({ ...obj, }); @@ -965,6 +1052,9 @@ export namespace CreateUserRequest { export interface CreateUserResponse {} export namespace CreateUserResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateUserResponse): any => ({ ...obj, }); @@ -978,6 +1068,9 @@ export interface DeleteBrokerRequest { } export namespace DeleteBrokerRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteBrokerRequest): any => ({ ...obj, }); @@ -991,6 +1084,9 @@ export interface DeleteBrokerResponse { } export namespace DeleteBrokerResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteBrokerResponse): any => ({ ...obj, }); @@ -1009,6 +1105,9 @@ export interface DeleteTagsRequest { } export namespace DeleteTagsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteTagsRequest): any => ({ ...obj, }); @@ -1027,6 +1126,9 @@ export interface DeleteUserRequest { } export namespace DeleteUserRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteUserRequest): any => ({ ...obj, }); @@ -1035,6 +1137,9 @@ export namespace DeleteUserRequest { export interface DeleteUserResponse {} export namespace DeleteUserResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteUserResponse): any => ({ ...obj, }); @@ -1048,6 +1153,9 @@ export interface DescribeBrokerRequest { } export namespace DescribeBrokerRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeBrokerRequest): any => ({ ...obj, }); @@ -1109,6 +1217,9 @@ export interface LdapServerMetadataOutput { } export namespace LdapServerMetadataOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: LdapServerMetadataOutput): any => ({ ...obj, }); @@ -1130,6 +1241,9 @@ export interface PendingLogs { } export namespace PendingLogs { + /** + * @internal + */ export const filterSensitiveLog = (obj: PendingLogs): any => ({ ...obj, }); @@ -1166,6 +1280,9 @@ export interface LogsSummary { } export namespace LogsSummary { + /** + * @internal + */ export const filterSensitiveLog = (obj: LogsSummary): any => ({ ...obj, }); @@ -1314,6 +1431,9 @@ export interface DescribeBrokerResponse { } export namespace DescribeBrokerResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeBrokerResponse): any => ({ ...obj, }); @@ -1337,6 +1457,9 @@ export interface DescribeBrokerEngineTypesRequest { } export namespace DescribeBrokerEngineTypesRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeBrokerEngineTypesRequest): any => ({ ...obj, }); @@ -1360,6 +1483,9 @@ export interface DescribeBrokerEngineTypesResponse { } export namespace DescribeBrokerEngineTypesResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeBrokerEngineTypesResponse): any => ({ ...obj, }); @@ -1393,6 +1519,9 @@ export interface DescribeBrokerInstanceOptionsRequest { } export namespace DescribeBrokerInstanceOptionsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeBrokerInstanceOptionsRequest): any => ({ ...obj, }); @@ -1416,6 +1545,9 @@ export interface DescribeBrokerInstanceOptionsResponse { } export namespace DescribeBrokerInstanceOptionsResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeBrokerInstanceOptionsResponse): any => ({ ...obj, }); @@ -1429,6 +1561,9 @@ export interface DescribeConfigurationRequest { } export namespace DescribeConfigurationRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeConfigurationRequest): any => ({ ...obj, }); @@ -1487,6 +1622,9 @@ export interface DescribeConfigurationResponse { } export namespace DescribeConfigurationResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeConfigurationResponse): any => ({ ...obj, }); @@ -1505,6 +1643,9 @@ export interface DescribeConfigurationRevisionRequest { } export namespace DescribeConfigurationRevisionRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeConfigurationRevisionRequest): any => ({ ...obj, }); @@ -1533,6 +1674,9 @@ export interface DescribeConfigurationRevisionResponse { } export namespace DescribeConfigurationRevisionResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeConfigurationRevisionResponse): any => ({ ...obj, }); @@ -1551,6 +1695,9 @@ export interface DescribeUserRequest { } export namespace DescribeUserRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeUserRequest): any => ({ ...obj, }); @@ -1577,6 +1724,9 @@ export interface UserPendingChanges { } export namespace UserPendingChanges { + /** + * @internal + */ export const filterSensitiveLog = (obj: UserPendingChanges): any => ({ ...obj, }); @@ -1610,6 +1760,9 @@ export interface DescribeUserResponse { } export namespace DescribeUserResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeUserResponse): any => ({ ...obj, }); @@ -1628,6 +1781,9 @@ export interface ListBrokersRequest { } export namespace ListBrokersRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListBrokersRequest): any => ({ ...obj, }); @@ -1646,6 +1802,9 @@ export interface ListBrokersResponse { } export namespace ListBrokersResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListBrokersResponse): any => ({ ...obj, }); @@ -1669,6 +1828,9 @@ export interface ListConfigurationRevisionsRequest { } export namespace ListConfigurationRevisionsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListConfigurationRevisionsRequest): any => ({ ...obj, }); @@ -1697,6 +1859,9 @@ export interface ListConfigurationRevisionsResponse { } export namespace ListConfigurationRevisionsResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListConfigurationRevisionsResponse): any => ({ ...obj, }); @@ -1715,6 +1880,9 @@ export interface ListConfigurationsRequest { } export namespace ListConfigurationsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListConfigurationsRequest): any => ({ ...obj, }); @@ -1738,6 +1906,9 @@ export interface ListConfigurationsResponse { } export namespace ListConfigurationsResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListConfigurationsResponse): any => ({ ...obj, }); @@ -1751,6 +1922,9 @@ export interface ListTagsRequest { } export namespace ListTagsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListTagsRequest): any => ({ ...obj, }); @@ -1764,6 +1938,9 @@ export interface ListTagsResponse { } export namespace ListTagsResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListTagsResponse): any => ({ ...obj, }); @@ -1787,6 +1964,9 @@ export interface ListUsersRequest { } export namespace ListUsersRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListUsersRequest): any => ({ ...obj, }); @@ -1815,6 +1995,9 @@ export interface ListUsersResponse { } export namespace ListUsersResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListUsersResponse): any => ({ ...obj, }); @@ -1828,6 +2011,9 @@ export interface RebootBrokerRequest { } export namespace RebootBrokerRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: RebootBrokerRequest): any => ({ ...obj, }); @@ -1836,6 +2022,9 @@ export namespace RebootBrokerRequest { export interface RebootBrokerResponse {} export namespace RebootBrokerResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: RebootBrokerResponse): any => ({ ...obj, }); @@ -1892,6 +2081,9 @@ export interface UpdateBrokerRequest { } export namespace UpdateBrokerRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateBrokerRequest): any => ({ ...obj, }); @@ -1945,6 +2137,9 @@ export interface UpdateBrokerResponse { } export namespace UpdateBrokerResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateBrokerResponse): any => ({ ...obj, }); @@ -1971,6 +2166,9 @@ export interface UpdateConfigurationRequest { } export namespace UpdateConfigurationRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateConfigurationRequest): any => ({ ...obj, }); @@ -2009,6 +2207,9 @@ export interface UpdateConfigurationResponse { } export namespace UpdateConfigurationResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateConfigurationResponse): any => ({ ...obj, }); @@ -2045,6 +2246,9 @@ export interface UpdateUserRequest { } export namespace UpdateUserRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateUserRequest): any => ({ ...obj, }); @@ -2053,6 +2257,9 @@ export namespace UpdateUserRequest { export interface UpdateUserResponse {} export namespace UpdateUserResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateUserResponse): any => ({ ...obj, }); diff --git a/clients/client-mturk/commands/AcceptQualificationRequestCommand.ts b/clients/client-mturk/commands/AcceptQualificationRequestCommand.ts index e2b266f34a72..552ac396c8f4 100644 --- a/clients/client-mturk/commands/AcceptQualificationRequestCommand.ts +++ b/clients/client-mturk/commands/AcceptQualificationRequestCommand.ts @@ -31,6 +31,20 @@ export interface AcceptQualificationRequestCommandOutput extends AcceptQualifica * A successful request for the AcceptQualificationRequest operation * returns with no errors and an empty body. *

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { MTurkClient, AcceptQualificationRequestCommand } from "@aws-sdk/client-mturk"; // ES Modules import + * // const { MTurkClient, AcceptQualificationRequestCommand } = require("@aws-sdk/client-mturk"); // CommonJS import + * const client = new MTurkClient(config); + * const command = new AcceptQualificationRequestCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link AcceptQualificationRequestCommandInput} for command's `input` shape. + * @see {@link AcceptQualificationRequestCommandOutput} for command's `response` shape. + * @see {@link MTurkClientResolvedConfig | config} for command's `input` shape. + * */ export class AcceptQualificationRequestCommand extends $Command< AcceptQualificationRequestCommandInput, diff --git a/clients/client-mturk/commands/ApproveAssignmentCommand.ts b/clients/client-mturk/commands/ApproveAssignmentCommand.ts index 9a454216c2e5..77efe509020b 100644 --- a/clients/client-mturk/commands/ApproveAssignmentCommand.ts +++ b/clients/client-mturk/commands/ApproveAssignmentCommand.ts @@ -51,6 +51,20 @@ export interface ApproveAssignmentCommandOutput extends ApproveAssignmentRespons * 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. *

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { MTurkClient, ApproveAssignmentCommand } from "@aws-sdk/client-mturk"; // ES Modules import + * // const { MTurkClient, ApproveAssignmentCommand } = require("@aws-sdk/client-mturk"); // CommonJS import + * const client = new MTurkClient(config); + * const command = new ApproveAssignmentCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ApproveAssignmentCommandInput} for command's `input` shape. + * @see {@link ApproveAssignmentCommandOutput} for command's `response` shape. + * @see {@link MTurkClientResolvedConfig | config} for command's `input` shape. + * */ export class ApproveAssignmentCommand extends $Command< ApproveAssignmentCommandInput, diff --git a/clients/client-mturk/commands/AssociateQualificationWithWorkerCommand.ts b/clients/client-mturk/commands/AssociateQualificationWithWorkerCommand.ts index 357b4c8e2ecb..c389039d8a42 100644 --- a/clients/client-mturk/commands/AssociateQualificationWithWorkerCommand.ts +++ b/clients/client-mturk/commands/AssociateQualificationWithWorkerCommand.ts @@ -44,6 +44,20 @@ export interface AssociateQualificationWithWorkerCommandOutput * request with the RejectQualificationRequest operation. *

* + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { MTurkClient, AssociateQualificationWithWorkerCommand } from "@aws-sdk/client-mturk"; // ES Modules import + * // const { MTurkClient, AssociateQualificationWithWorkerCommand } = require("@aws-sdk/client-mturk"); // CommonJS import + * const client = new MTurkClient(config); + * const command = new AssociateQualificationWithWorkerCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link AssociateQualificationWithWorkerCommandInput} for command's `input` shape. + * @see {@link AssociateQualificationWithWorkerCommandOutput} for command's `response` shape. + * @see {@link MTurkClientResolvedConfig | config} for command's `input` shape. + * */ export class AssociateQualificationWithWorkerCommand extends $Command< AssociateQualificationWithWorkerCommandInput, diff --git a/clients/client-mturk/commands/CreateAdditionalAssignmentsForHITCommand.ts b/clients/client-mturk/commands/CreateAdditionalAssignmentsForHITCommand.ts index ab5f3354a241..b33dedeb928e 100644 --- a/clients/client-mturk/commands/CreateAdditionalAssignmentsForHITCommand.ts +++ b/clients/client-mturk/commands/CreateAdditionalAssignmentsForHITCommand.ts @@ -49,6 +49,20 @@ export interface CreateAdditionalAssignmentsForHITCommandOutput * * * + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { MTurkClient, CreateAdditionalAssignmentsForHITCommand } from "@aws-sdk/client-mturk"; // ES Modules import + * // const { MTurkClient, CreateAdditionalAssignmentsForHITCommand } = require("@aws-sdk/client-mturk"); // CommonJS import + * const client = new MTurkClient(config); + * const command = new CreateAdditionalAssignmentsForHITCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreateAdditionalAssignmentsForHITCommandInput} for command's `input` shape. + * @see {@link CreateAdditionalAssignmentsForHITCommandOutput} for command's `response` shape. + * @see {@link MTurkClientResolvedConfig | config} for command's `input` shape. + * */ export class CreateAdditionalAssignmentsForHITCommand extends $Command< CreateAdditionalAssignmentsForHITCommandInput, diff --git a/clients/client-mturk/commands/CreateHITCommand.ts b/clients/client-mturk/commands/CreateHITCommand.ts index 7cd8b5451ab0..d21a2edcbacc 100644 --- a/clients/client-mturk/commands/CreateHITCommand.ts +++ b/clients/client-mturk/commands/CreateHITCommand.ts @@ -35,6 +35,20 @@ export interface CreateHITCommandOutput extends CreateHITResponse, __MetadataBea *

If a HIT is created with 10 or more maximum assignments, there is an additional fee. For more information, see * Amazon Mechanical Turk Pricing.

* + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { MTurkClient, CreateHITCommand } from "@aws-sdk/client-mturk"; // ES Modules import + * // const { MTurkClient, CreateHITCommand } = require("@aws-sdk/client-mturk"); // CommonJS import + * const client = new MTurkClient(config); + * const command = new CreateHITCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreateHITCommandInput} for command's `input` shape. + * @see {@link CreateHITCommandOutput} for command's `response` shape. + * @see {@link MTurkClientResolvedConfig | config} for command's `input` shape. + * */ export class CreateHITCommand extends $Command< CreateHITCommandInput, diff --git a/clients/client-mturk/commands/CreateHITTypeCommand.ts b/clients/client-mturk/commands/CreateHITTypeCommand.ts index 9ba9903e952b..831e73337018 100644 --- a/clients/client-mturk/commands/CreateHITTypeCommand.ts +++ b/clients/client-mturk/commands/CreateHITTypeCommand.ts @@ -27,6 +27,20 @@ export interface CreateHITTypeCommandOutput extends CreateHITTypeResponse, __Met * 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. *

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { MTurkClient, CreateHITTypeCommand } from "@aws-sdk/client-mturk"; // ES Modules import + * // const { MTurkClient, CreateHITTypeCommand } = require("@aws-sdk/client-mturk"); // CommonJS import + * const client = new MTurkClient(config); + * const command = new CreateHITTypeCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreateHITTypeCommandInput} for command's `input` shape. + * @see {@link CreateHITTypeCommandOutput} for command's `response` shape. + * @see {@link MTurkClientResolvedConfig | config} for command's `input` shape. + * */ export class CreateHITTypeCommand extends $Command< CreateHITTypeCommandInput, diff --git a/clients/client-mturk/commands/CreateHITWithHITTypeCommand.ts b/clients/client-mturk/commands/CreateHITWithHITTypeCommand.ts index 284a27a1bcb4..b33a95ffa4d1 100644 --- a/clients/client-mturk/commands/CreateHITWithHITTypeCommand.ts +++ b/clients/client-mturk/commands/CreateHITWithHITTypeCommand.ts @@ -39,6 +39,20 @@ export interface CreateHITWithHITTypeCommandOutput extends CreateHITWithHITTypeR * For more information, see Amazon Mechanical Turk Pricing. *

* + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { MTurkClient, CreateHITWithHITTypeCommand } from "@aws-sdk/client-mturk"; // ES Modules import + * // const { MTurkClient, CreateHITWithHITTypeCommand } = require("@aws-sdk/client-mturk"); // CommonJS import + * const client = new MTurkClient(config); + * const command = new CreateHITWithHITTypeCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreateHITWithHITTypeCommandInput} for command's `input` shape. + * @see {@link CreateHITWithHITTypeCommandOutput} for command's `response` shape. + * @see {@link MTurkClientResolvedConfig | config} for command's `input` shape. + * */ export class CreateHITWithHITTypeCommand extends $Command< CreateHITWithHITTypeCommandInput, diff --git a/clients/client-mturk/commands/CreateQualificationTypeCommand.ts b/clients/client-mturk/commands/CreateQualificationTypeCommand.ts index ce9b08a0bb40..8349cc4437a5 100644 --- a/clients/client-mturk/commands/CreateQualificationTypeCommand.ts +++ b/clients/client-mturk/commands/CreateQualificationTypeCommand.ts @@ -28,6 +28,20 @@ export interface CreateQualificationTypeCommandOutput extends CreateQualificatio * QualificationType * data structure. *

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { MTurkClient, CreateQualificationTypeCommand } from "@aws-sdk/client-mturk"; // ES Modules import + * // const { MTurkClient, CreateQualificationTypeCommand } = require("@aws-sdk/client-mturk"); // CommonJS import + * const client = new MTurkClient(config); + * const command = new CreateQualificationTypeCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreateQualificationTypeCommandInput} for command's `input` shape. + * @see {@link CreateQualificationTypeCommandOutput} for command's `response` shape. + * @see {@link MTurkClientResolvedConfig | config} for command's `input` shape. + * */ export class CreateQualificationTypeCommand extends $Command< CreateQualificationTypeCommandInput, diff --git a/clients/client-mturk/commands/CreateWorkerBlockCommand.ts b/clients/client-mturk/commands/CreateWorkerBlockCommand.ts index 12e42abf250f..c951348fbf9a 100644 --- a/clients/client-mturk/commands/CreateWorkerBlockCommand.ts +++ b/clients/client-mturk/commands/CreateWorkerBlockCommand.ts @@ -22,6 +22,20 @@ export interface CreateWorkerBlockCommandOutput extends CreateWorkerBlockRespons /** *

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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { MTurkClient, CreateWorkerBlockCommand } from "@aws-sdk/client-mturk"; // ES Modules import + * // const { MTurkClient, CreateWorkerBlockCommand } = require("@aws-sdk/client-mturk"); // CommonJS import + * const client = new MTurkClient(config); + * const command = new CreateWorkerBlockCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreateWorkerBlockCommandInput} for command's `input` shape. + * @see {@link CreateWorkerBlockCommandOutput} for command's `response` shape. + * @see {@link MTurkClientResolvedConfig | config} for command's `input` shape. + * */ export class CreateWorkerBlockCommand extends $Command< CreateWorkerBlockCommandInput, diff --git a/clients/client-mturk/commands/DeleteHITCommand.ts b/clients/client-mturk/commands/DeleteHITCommand.ts index 5c70eeb13506..ca250d08d6a2 100644 --- a/clients/client-mturk/commands/DeleteHITCommand.ts +++ b/clients/client-mturk/commands/DeleteHITCommand.ts @@ -54,6 +54,20 @@ export interface DeleteHITCommandOutput extends DeleteHITResponse, __MetadataBea * * * + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { MTurkClient, DeleteHITCommand } from "@aws-sdk/client-mturk"; // ES Modules import + * // const { MTurkClient, DeleteHITCommand } = require("@aws-sdk/client-mturk"); // CommonJS import + * const client = new MTurkClient(config); + * const command = new DeleteHITCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteHITCommandInput} for command's `input` shape. + * @see {@link DeleteHITCommandOutput} for command's `response` shape. + * @see {@link MTurkClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteHITCommand extends $Command< DeleteHITCommandInput, diff --git a/clients/client-mturk/commands/DeleteQualificationTypeCommand.ts b/clients/client-mturk/commands/DeleteQualificationTypeCommand.ts index 8b79716d7178..63845c38b37f 100644 --- a/clients/client-mturk/commands/DeleteQualificationTypeCommand.ts +++ b/clients/client-mturk/commands/DeleteQualificationTypeCommand.ts @@ -40,6 +40,20 @@ export interface DeleteQualificationTypeCommandOutput extends DeleteQualificatio * the unique name of the Qualification type is available for reuse with * CreateQualificationType.

* + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { MTurkClient, DeleteQualificationTypeCommand } from "@aws-sdk/client-mturk"; // ES Modules import + * // const { MTurkClient, DeleteQualificationTypeCommand } = require("@aws-sdk/client-mturk"); // CommonJS import + * const client = new MTurkClient(config); + * const command = new DeleteQualificationTypeCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteQualificationTypeCommandInput} for command's `input` shape. + * @see {@link DeleteQualificationTypeCommandOutput} for command's `response` shape. + * @see {@link MTurkClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteQualificationTypeCommand extends $Command< DeleteQualificationTypeCommandInput, diff --git a/clients/client-mturk/commands/DeleteWorkerBlockCommand.ts b/clients/client-mturk/commands/DeleteWorkerBlockCommand.ts index caadd670e8c2..eb52de1a5fa1 100644 --- a/clients/client-mturk/commands/DeleteWorkerBlockCommand.ts +++ b/clients/client-mturk/commands/DeleteWorkerBlockCommand.ts @@ -22,6 +22,20 @@ export interface DeleteWorkerBlockCommandOutput extends DeleteWorkerBlockRespons /** *

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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { MTurkClient, DeleteWorkerBlockCommand } from "@aws-sdk/client-mturk"; // ES Modules import + * // const { MTurkClient, DeleteWorkerBlockCommand } = require("@aws-sdk/client-mturk"); // CommonJS import + * const client = new MTurkClient(config); + * const command = new DeleteWorkerBlockCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteWorkerBlockCommandInput} for command's `input` shape. + * @see {@link DeleteWorkerBlockCommandOutput} for command's `response` shape. + * @see {@link MTurkClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteWorkerBlockCommand extends $Command< DeleteWorkerBlockCommandInput, diff --git a/clients/client-mturk/commands/DisassociateQualificationFromWorkerCommand.ts b/clients/client-mturk/commands/DisassociateQualificationFromWorkerCommand.ts index bb6d35e57ba5..644f47032cc8 100644 --- a/clients/client-mturk/commands/DisassociateQualificationFromWorkerCommand.ts +++ b/clients/client-mturk/commands/DisassociateQualificationFromWorkerCommand.ts @@ -34,6 +34,20 @@ export interface DisassociateQualificationFromWorkerCommandOutput * You can provide a text message explaining why the Qualification was * revoked. The user who had the Qualification can see this message. *

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { MTurkClient, DisassociateQualificationFromWorkerCommand } from "@aws-sdk/client-mturk"; // ES Modules import + * // const { MTurkClient, DisassociateQualificationFromWorkerCommand } = require("@aws-sdk/client-mturk"); // CommonJS import + * const client = new MTurkClient(config); + * const command = new DisassociateQualificationFromWorkerCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DisassociateQualificationFromWorkerCommandInput} for command's `input` shape. + * @see {@link DisassociateQualificationFromWorkerCommandOutput} for command's `response` shape. + * @see {@link MTurkClientResolvedConfig | config} for command's `input` shape. + * */ export class DisassociateQualificationFromWorkerCommand extends $Command< DisassociateQualificationFromWorkerCommandInput, diff --git a/clients/client-mturk/commands/GetAccountBalanceCommand.ts b/clients/client-mturk/commands/GetAccountBalanceCommand.ts index c98f1977a269..695dd8587aa5 100644 --- a/clients/client-mturk/commands/GetAccountBalanceCommand.ts +++ b/clients/client-mturk/commands/GetAccountBalanceCommand.ts @@ -22,6 +22,20 @@ export interface GetAccountBalanceCommandOutput extends GetAccountBalanceRespons /** *

The GetAccountBalance operation retrieves the amount of money in your Amazon Mechanical Turk account.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { MTurkClient, GetAccountBalanceCommand } from "@aws-sdk/client-mturk"; // ES Modules import + * // const { MTurkClient, GetAccountBalanceCommand } = require("@aws-sdk/client-mturk"); // CommonJS import + * const client = new MTurkClient(config); + * const command = new GetAccountBalanceCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetAccountBalanceCommandInput} for command's `input` shape. + * @see {@link GetAccountBalanceCommandOutput} for command's `response` shape. + * @see {@link MTurkClientResolvedConfig | config} for command's `input` shape. + * */ export class GetAccountBalanceCommand extends $Command< GetAccountBalanceCommandInput, diff --git a/clients/client-mturk/commands/GetAssignmentCommand.ts b/clients/client-mturk/commands/GetAssignmentCommand.ts index c0e298e88a16..ca704f961627 100644 --- a/clients/client-mturk/commands/GetAssignmentCommand.ts +++ b/clients/client-mturk/commands/GetAssignmentCommand.ts @@ -24,6 +24,20 @@ export interface GetAssignmentCommandOutput extends GetAssignmentResponse, __Met *

* The GetAssignment operation retrieves the details of the specified Assignment. *

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { MTurkClient, GetAssignmentCommand } from "@aws-sdk/client-mturk"; // ES Modules import + * // const { MTurkClient, GetAssignmentCommand } = require("@aws-sdk/client-mturk"); // CommonJS import + * const client = new MTurkClient(config); + * const command = new GetAssignmentCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetAssignmentCommandInput} for command's `input` shape. + * @see {@link GetAssignmentCommandOutput} for command's `response` shape. + * @see {@link MTurkClientResolvedConfig | config} for command's `input` shape. + * */ export class GetAssignmentCommand extends $Command< GetAssignmentCommandInput, diff --git a/clients/client-mturk/commands/GetFileUploadURLCommand.ts b/clients/client-mturk/commands/GetFileUploadURLCommand.ts index 79b991e719ea..c906f96482df 100644 --- a/clients/client-mturk/commands/GetFileUploadURLCommand.ts +++ b/clients/client-mturk/commands/GetFileUploadURLCommand.ts @@ -39,6 +39,20 @@ export interface GetFileUploadURLCommandOutput extends GetFileUploadURLResponse, * Workers to upload files to use Amazon S3. * *

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { MTurkClient, GetFileUploadURLCommand } from "@aws-sdk/client-mturk"; // ES Modules import + * // const { MTurkClient, GetFileUploadURLCommand } = require("@aws-sdk/client-mturk"); // CommonJS import + * const client = new MTurkClient(config); + * const command = new GetFileUploadURLCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetFileUploadURLCommandInput} for command's `input` shape. + * @see {@link GetFileUploadURLCommandOutput} for command's `response` shape. + * @see {@link MTurkClientResolvedConfig | config} for command's `input` shape. + * */ export class GetFileUploadURLCommand extends $Command< GetFileUploadURLCommandInput, diff --git a/clients/client-mturk/commands/GetHITCommand.ts b/clients/client-mturk/commands/GetHITCommand.ts index dcd518466dab..2475886ad1e1 100644 --- a/clients/client-mturk/commands/GetHITCommand.ts +++ b/clients/client-mturk/commands/GetHITCommand.ts @@ -21,6 +21,20 @@ export interface GetHITCommandOutput extends GetHITResponse, __MetadataBearer {} *

* The GetHIT operation retrieves the details of the specified HIT. *

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { MTurkClient, GetHITCommand } from "@aws-sdk/client-mturk"; // ES Modules import + * // const { MTurkClient, GetHITCommand } = require("@aws-sdk/client-mturk"); // CommonJS import + * const client = new MTurkClient(config); + * const command = new GetHITCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetHITCommandInput} for command's `input` shape. + * @see {@link GetHITCommandOutput} for command's `response` shape. + * @see {@link MTurkClientResolvedConfig | config} for command's `input` shape. + * */ export class GetHITCommand extends $Command { // Start section: command_properties diff --git a/clients/client-mturk/commands/GetQualificationScoreCommand.ts b/clients/client-mturk/commands/GetQualificationScoreCommand.ts index 17e16ba113d3..c1b5c2302ee5 100644 --- a/clients/client-mturk/commands/GetQualificationScoreCommand.ts +++ b/clients/client-mturk/commands/GetQualificationScoreCommand.ts @@ -35,6 +35,20 @@ export interface GetQualificationScoreCommandOutput extends GetQualificationScor *

*

Only the owner of a Qualification type can query the value of * a Worker's Qualification of that type.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { MTurkClient, GetQualificationScoreCommand } from "@aws-sdk/client-mturk"; // ES Modules import + * // const { MTurkClient, GetQualificationScoreCommand } = require("@aws-sdk/client-mturk"); // CommonJS import + * const client = new MTurkClient(config); + * const command = new GetQualificationScoreCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetQualificationScoreCommandInput} for command's `input` shape. + * @see {@link GetQualificationScoreCommandOutput} for command's `response` shape. + * @see {@link MTurkClientResolvedConfig | config} for command's `input` shape. + * */ export class GetQualificationScoreCommand extends $Command< GetQualificationScoreCommandInput, diff --git a/clients/client-mturk/commands/GetQualificationTypeCommand.ts b/clients/client-mturk/commands/GetQualificationTypeCommand.ts index 91341163998d..e73ff2de261e 100644 --- a/clients/client-mturk/commands/GetQualificationTypeCommand.ts +++ b/clients/client-mturk/commands/GetQualificationTypeCommand.ts @@ -24,6 +24,20 @@ export interface GetQualificationTypeCommandOutput extends GetQualificationTypeR *

* The GetQualificationTypeoperation retrieves information about a Qualification type using its ID. *

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { MTurkClient, GetQualificationTypeCommand } from "@aws-sdk/client-mturk"; // ES Modules import + * // const { MTurkClient, GetQualificationTypeCommand } = require("@aws-sdk/client-mturk"); // CommonJS import + * const client = new MTurkClient(config); + * const command = new GetQualificationTypeCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetQualificationTypeCommandInput} for command's `input` shape. + * @see {@link GetQualificationTypeCommandOutput} for command's `response` shape. + * @see {@link MTurkClientResolvedConfig | config} for command's `input` shape. + * */ export class GetQualificationTypeCommand extends $Command< GetQualificationTypeCommandInput, diff --git a/clients/client-mturk/commands/ListAssignmentsForHITCommand.ts b/clients/client-mturk/commands/ListAssignmentsForHITCommand.ts index 520fed9f4d62..06002431ac85 100644 --- a/clients/client-mturk/commands/ListAssignmentsForHITCommand.ts +++ b/clients/client-mturk/commands/ListAssignmentsForHITCommand.ts @@ -48,6 +48,20 @@ export interface ListAssignmentsForHITCommandOutput extends ListAssignmentsForHI * parameters * of the operation to control sorting and pagination. *

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { MTurkClient, ListAssignmentsForHITCommand } from "@aws-sdk/client-mturk"; // ES Modules import + * // const { MTurkClient, ListAssignmentsForHITCommand } = require("@aws-sdk/client-mturk"); // CommonJS import + * const client = new MTurkClient(config); + * const command = new ListAssignmentsForHITCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListAssignmentsForHITCommandInput} for command's `input` shape. + * @see {@link ListAssignmentsForHITCommandOutput} for command's `response` shape. + * @see {@link MTurkClientResolvedConfig | config} for command's `input` shape. + * */ export class ListAssignmentsForHITCommand extends $Command< ListAssignmentsForHITCommandInput, diff --git a/clients/client-mturk/commands/ListBonusPaymentsCommand.ts b/clients/client-mturk/commands/ListBonusPaymentsCommand.ts index fde3787cc655..0a9a7f06d745 100644 --- a/clients/client-mturk/commands/ListBonusPaymentsCommand.ts +++ b/clients/client-mturk/commands/ListBonusPaymentsCommand.ts @@ -27,6 +27,20 @@ export interface ListBonusPaymentsCommandOutput extends ListBonusPaymentsRespons * operation retrieves the amounts of bonuses you have paid to Workers * for a given HIT or assignment. *

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { MTurkClient, ListBonusPaymentsCommand } from "@aws-sdk/client-mturk"; // ES Modules import + * // const { MTurkClient, ListBonusPaymentsCommand } = require("@aws-sdk/client-mturk"); // CommonJS import + * const client = new MTurkClient(config); + * const command = new ListBonusPaymentsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListBonusPaymentsCommandInput} for command's `input` shape. + * @see {@link ListBonusPaymentsCommandOutput} for command's `response` shape. + * @see {@link MTurkClientResolvedConfig | config} for command's `input` shape. + * */ export class ListBonusPaymentsCommand extends $Command< ListBonusPaymentsCommandInput, diff --git a/clients/client-mturk/commands/ListHITsCommand.ts b/clients/client-mturk/commands/ListHITsCommand.ts index d723a81b4a02..0d4a7a1822d3 100644 --- a/clients/client-mturk/commands/ListHITsCommand.ts +++ b/clients/client-mturk/commands/ListHITsCommand.ts @@ -25,6 +25,20 @@ export interface ListHITsCommandOutput extends ListHITsResponse, __MetadataBeare * HITs of any status, except for HITs that have been deleted of with * the DeleteHIT operation or that have been auto-deleted. *

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { MTurkClient, ListHITsCommand } from "@aws-sdk/client-mturk"; // ES Modules import + * // const { MTurkClient, ListHITsCommand } = require("@aws-sdk/client-mturk"); // CommonJS import + * const client = new MTurkClient(config); + * const command = new ListHITsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListHITsCommandInput} for command's `input` shape. + * @see {@link ListHITsCommandOutput} for command's `response` shape. + * @see {@link MTurkClientResolvedConfig | config} for command's `input` shape. + * */ export class ListHITsCommand extends $Command { // Start section: command_properties diff --git a/clients/client-mturk/commands/ListHITsForQualificationTypeCommand.ts b/clients/client-mturk/commands/ListHITsForQualificationTypeCommand.ts index d994a57e7c40..00e62271f8e2 100644 --- a/clients/client-mturk/commands/ListHITsForQualificationTypeCommand.ts +++ b/clients/client-mturk/commands/ListHITsForQualificationTypeCommand.ts @@ -29,6 +29,20 @@ export interface ListHITsForQualificationTypeCommandOutput * The operation returns HITs of any status, except for HITs that have been deleted * with the DeleteHIT operation or that have been auto-deleted. *

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { MTurkClient, ListHITsForQualificationTypeCommand } from "@aws-sdk/client-mturk"; // ES Modules import + * // const { MTurkClient, ListHITsForQualificationTypeCommand } = require("@aws-sdk/client-mturk"); // CommonJS import + * const client = new MTurkClient(config); + * const command = new ListHITsForQualificationTypeCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListHITsForQualificationTypeCommandInput} for command's `input` shape. + * @see {@link ListHITsForQualificationTypeCommandOutput} for command's `response` shape. + * @see {@link MTurkClientResolvedConfig | config} for command's `input` shape. + * */ export class ListHITsForQualificationTypeCommand extends $Command< ListHITsForQualificationTypeCommandInput, diff --git a/clients/client-mturk/commands/ListQualificationRequestsCommand.ts b/clients/client-mturk/commands/ListQualificationRequestsCommand.ts index 225f8943b1b3..f257495239f9 100644 --- a/clients/client-mturk/commands/ListQualificationRequestsCommand.ts +++ b/clients/client-mturk/commands/ListQualificationRequestsCommand.ts @@ -29,6 +29,20 @@ export interface ListQualificationRequestsCommandOutput extends ListQualificatio * operation to poll for pending requests, and accepts them using the * AcceptQualification operation. *

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { MTurkClient, ListQualificationRequestsCommand } from "@aws-sdk/client-mturk"; // ES Modules import + * // const { MTurkClient, ListQualificationRequestsCommand } = require("@aws-sdk/client-mturk"); // CommonJS import + * const client = new MTurkClient(config); + * const command = new ListQualificationRequestsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListQualificationRequestsCommandInput} for command's `input` shape. + * @see {@link ListQualificationRequestsCommandOutput} for command's `response` shape. + * @see {@link MTurkClientResolvedConfig | config} for command's `input` shape. + * */ export class ListQualificationRequestsCommand extends $Command< ListQualificationRequestsCommandInput, diff --git a/clients/client-mturk/commands/ListQualificationTypesCommand.ts b/clients/client-mturk/commands/ListQualificationTypesCommand.ts index 52d4d82974d5..71d87d2773fa 100644 --- a/clients/client-mturk/commands/ListQualificationTypesCommand.ts +++ b/clients/client-mturk/commands/ListQualificationTypesCommand.ts @@ -27,6 +27,20 @@ export interface ListQualificationTypesCommandOutput extends ListQualificationTy * operation returns a list of Qualification types, filtered by * an optional search term. *

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { MTurkClient, ListQualificationTypesCommand } from "@aws-sdk/client-mturk"; // ES Modules import + * // const { MTurkClient, ListQualificationTypesCommand } = require("@aws-sdk/client-mturk"); // CommonJS import + * const client = new MTurkClient(config); + * const command = new ListQualificationTypesCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListQualificationTypesCommandInput} for command's `input` shape. + * @see {@link ListQualificationTypesCommandOutput} for command's `response` shape. + * @see {@link MTurkClientResolvedConfig | config} for command's `input` shape. + * */ export class ListQualificationTypesCommand extends $Command< ListQualificationTypesCommandInput, diff --git a/clients/client-mturk/commands/ListReviewPolicyResultsForHITCommand.ts b/clients/client-mturk/commands/ListReviewPolicyResultsForHITCommand.ts index c43510bcb615..41751f7b1b1a 100644 --- a/clients/client-mturk/commands/ListReviewPolicyResultsForHITCommand.ts +++ b/clients/client-mturk/commands/ListReviewPolicyResultsForHITCommand.ts @@ -30,6 +30,20 @@ export interface ListReviewPolicyResultsForHITCommandOutput * see Review Policies. The ListReviewPolicyResultsForHIT operation can return results for both * Assignment-level and HIT-level review results. *

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { MTurkClient, ListReviewPolicyResultsForHITCommand } from "@aws-sdk/client-mturk"; // ES Modules import + * // const { MTurkClient, ListReviewPolicyResultsForHITCommand } = require("@aws-sdk/client-mturk"); // CommonJS import + * const client = new MTurkClient(config); + * const command = new ListReviewPolicyResultsForHITCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListReviewPolicyResultsForHITCommandInput} for command's `input` shape. + * @see {@link ListReviewPolicyResultsForHITCommandOutput} for command's `response` shape. + * @see {@link MTurkClientResolvedConfig | config} for command's `input` shape. + * */ export class ListReviewPolicyResultsForHITCommand extends $Command< ListReviewPolicyResultsForHITCommandInput, diff --git a/clients/client-mturk/commands/ListReviewableHITsCommand.ts b/clients/client-mturk/commands/ListReviewableHITsCommand.ts index 50a06abdc0ba..a2999af1f9f4 100644 --- a/clients/client-mturk/commands/ListReviewableHITsCommand.ts +++ b/clients/client-mturk/commands/ListReviewableHITsCommand.ts @@ -25,6 +25,20 @@ export interface ListReviewableHITsCommandOutput extends ListReviewableHITsRespo * The ListReviewableHITs operation retrieves the HITs with Status equal to * Reviewable or Status equal to Reviewing that belong to the Requester calling the operation. *

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { MTurkClient, ListReviewableHITsCommand } from "@aws-sdk/client-mturk"; // ES Modules import + * // const { MTurkClient, ListReviewableHITsCommand } = require("@aws-sdk/client-mturk"); // CommonJS import + * const client = new MTurkClient(config); + * const command = new ListReviewableHITsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListReviewableHITsCommandInput} for command's `input` shape. + * @see {@link ListReviewableHITsCommandOutput} for command's `response` shape. + * @see {@link MTurkClientResolvedConfig | config} for command's `input` shape. + * */ export class ListReviewableHITsCommand extends $Command< ListReviewableHITsCommandInput, diff --git a/clients/client-mturk/commands/ListWorkerBlocksCommand.ts b/clients/client-mturk/commands/ListWorkerBlocksCommand.ts index 26966fe7f7ec..1b338999eb1d 100644 --- a/clients/client-mturk/commands/ListWorkerBlocksCommand.ts +++ b/clients/client-mturk/commands/ListWorkerBlocksCommand.ts @@ -22,6 +22,20 @@ export interface ListWorkerBlocksCommandOutput extends ListWorkerBlocksResponse, /** *

The ListWorkersBlocks operation retrieves a list of Workers who are blocked from working on your HITs.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { MTurkClient, ListWorkerBlocksCommand } from "@aws-sdk/client-mturk"; // ES Modules import + * // const { MTurkClient, ListWorkerBlocksCommand } = require("@aws-sdk/client-mturk"); // CommonJS import + * const client = new MTurkClient(config); + * const command = new ListWorkerBlocksCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListWorkerBlocksCommandInput} for command's `input` shape. + * @see {@link ListWorkerBlocksCommandOutput} for command's `response` shape. + * @see {@link MTurkClientResolvedConfig | config} for command's `input` shape. + * */ export class ListWorkerBlocksCommand extends $Command< ListWorkerBlocksCommandInput, diff --git a/clients/client-mturk/commands/ListWorkersWithQualificationTypeCommand.ts b/clients/client-mturk/commands/ListWorkersWithQualificationTypeCommand.ts index 11ac37a6b5df..1299da7e10da 100644 --- a/clients/client-mturk/commands/ListWorkersWithQualificationTypeCommand.ts +++ b/clients/client-mturk/commands/ListWorkersWithQualificationTypeCommand.ts @@ -27,6 +27,20 @@ export interface ListWorkersWithQualificationTypeCommandOutput * The ListWorkersWithQualificationType operation returns all of the Workers * that have been associated with a given Qualification type. *

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { MTurkClient, ListWorkersWithQualificationTypeCommand } from "@aws-sdk/client-mturk"; // ES Modules import + * // const { MTurkClient, ListWorkersWithQualificationTypeCommand } = require("@aws-sdk/client-mturk"); // CommonJS import + * const client = new MTurkClient(config); + * const command = new ListWorkersWithQualificationTypeCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListWorkersWithQualificationTypeCommandInput} for command's `input` shape. + * @see {@link ListWorkersWithQualificationTypeCommandOutput} for command's `response` shape. + * @see {@link MTurkClientResolvedConfig | config} for command's `input` shape. + * */ export class ListWorkersWithQualificationTypeCommand extends $Command< ListWorkersWithQualificationTypeCommandInput, diff --git a/clients/client-mturk/commands/NotifyWorkersCommand.ts b/clients/client-mturk/commands/NotifyWorkersCommand.ts index 8433ff128b5d..ce5c43af5873 100644 --- a/clients/client-mturk/commands/NotifyWorkersCommand.ts +++ b/clients/client-mturk/commands/NotifyWorkersCommand.ts @@ -31,6 +31,20 @@ export interface NotifyWorkersCommandOutput extends NotifyWorkersResponse, __Met * only if you have previously approved or rejected work from the * Worker. *

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { MTurkClient, NotifyWorkersCommand } from "@aws-sdk/client-mturk"; // ES Modules import + * // const { MTurkClient, NotifyWorkersCommand } = require("@aws-sdk/client-mturk"); // CommonJS import + * const client = new MTurkClient(config); + * const command = new NotifyWorkersCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link NotifyWorkersCommandInput} for command's `input` shape. + * @see {@link NotifyWorkersCommandOutput} for command's `response` shape. + * @see {@link MTurkClientResolvedConfig | config} for command's `input` shape. + * */ export class NotifyWorkersCommand extends $Command< NotifyWorkersCommandInput, diff --git a/clients/client-mturk/commands/RejectAssignmentCommand.ts b/clients/client-mturk/commands/RejectAssignmentCommand.ts index 3d62ce971eac..3f41488080a7 100644 --- a/clients/client-mturk/commands/RejectAssignmentCommand.ts +++ b/clients/client-mturk/commands/RejectAssignmentCommand.ts @@ -34,6 +34,20 @@ export interface RejectAssignmentCommandOutput extends RejectAssignmentResponse, *

* Only the Requester who created the HIT can reject an assignment for the HIT. *

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { MTurkClient, RejectAssignmentCommand } from "@aws-sdk/client-mturk"; // ES Modules import + * // const { MTurkClient, RejectAssignmentCommand } = require("@aws-sdk/client-mturk"); // CommonJS import + * const client = new MTurkClient(config); + * const command = new RejectAssignmentCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link RejectAssignmentCommandInput} for command's `input` shape. + * @see {@link RejectAssignmentCommandOutput} for command's `response` shape. + * @see {@link MTurkClientResolvedConfig | config} for command's `input` shape. + * */ export class RejectAssignmentCommand extends $Command< RejectAssignmentCommandInput, diff --git a/clients/client-mturk/commands/RejectQualificationRequestCommand.ts b/clients/client-mturk/commands/RejectQualificationRequestCommand.ts index 122666c015ce..061b9484cc13 100644 --- a/clients/client-mturk/commands/RejectQualificationRequestCommand.ts +++ b/clients/client-mturk/commands/RejectQualificationRequestCommand.ts @@ -28,6 +28,20 @@ export interface RejectQualificationRequestCommandOutput extends RejectQualifica *

*

You can provide a text message explaining why the request was * rejected. The Worker who made the request can see this message.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { MTurkClient, RejectQualificationRequestCommand } from "@aws-sdk/client-mturk"; // ES Modules import + * // const { MTurkClient, RejectQualificationRequestCommand } = require("@aws-sdk/client-mturk"); // CommonJS import + * const client = new MTurkClient(config); + * const command = new RejectQualificationRequestCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link RejectQualificationRequestCommandInput} for command's `input` shape. + * @see {@link RejectQualificationRequestCommandOutput} for command's `response` shape. + * @see {@link MTurkClientResolvedConfig | config} for command's `input` shape. + * */ export class RejectQualificationRequestCommand extends $Command< RejectQualificationRequestCommandInput, diff --git a/clients/client-mturk/commands/SendBonusCommand.ts b/clients/client-mturk/commands/SendBonusCommand.ts index 65b2a8370e6a..693120b24bfd 100644 --- a/clients/client-mturk/commands/SendBonusCommand.ts +++ b/clients/client-mturk/commands/SendBonusCommand.ts @@ -32,6 +32,20 @@ export interface SendBonusCommandOutput extends SendBonusResponse, __MetadataBea * if your account does not have enough funds to pay for both the bonus * and the fees. *

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { MTurkClient, SendBonusCommand } from "@aws-sdk/client-mturk"; // ES Modules import + * // const { MTurkClient, SendBonusCommand } = require("@aws-sdk/client-mturk"); // CommonJS import + * const client = new MTurkClient(config); + * const command = new SendBonusCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link SendBonusCommandInput} for command's `input` shape. + * @see {@link SendBonusCommandOutput} for command's `response` shape. + * @see {@link MTurkClientResolvedConfig | config} for command's `input` shape. + * */ export class SendBonusCommand extends $Command< SendBonusCommandInput, diff --git a/clients/client-mturk/commands/SendTestEventNotificationCommand.ts b/clients/client-mturk/commands/SendTestEventNotificationCommand.ts index 8fcc74d16a78..b7b0f8d2e20c 100644 --- a/clients/client-mturk/commands/SendTestEventNotificationCommand.ts +++ b/clients/client-mturk/commands/SendTestEventNotificationCommand.ts @@ -28,6 +28,20 @@ export interface SendTestEventNotificationCommandOutput extends SendTestEventNot * 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. *

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { MTurkClient, SendTestEventNotificationCommand } from "@aws-sdk/client-mturk"; // ES Modules import + * // const { MTurkClient, SendTestEventNotificationCommand } = require("@aws-sdk/client-mturk"); // CommonJS import + * const client = new MTurkClient(config); + * const command = new SendTestEventNotificationCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link SendTestEventNotificationCommandInput} for command's `input` shape. + * @see {@link SendTestEventNotificationCommandOutput} for command's `response` shape. + * @see {@link MTurkClientResolvedConfig | config} for command's `input` shape. + * */ export class SendTestEventNotificationCommand extends $Command< SendTestEventNotificationCommandInput, diff --git a/clients/client-mturk/commands/UpdateExpirationForHITCommand.ts b/clients/client-mturk/commands/UpdateExpirationForHITCommand.ts index 909776f7628c..f9b71bf6b14c 100644 --- a/clients/client-mturk/commands/UpdateExpirationForHITCommand.ts +++ b/clients/client-mturk/commands/UpdateExpirationForHITCommand.ts @@ -25,6 +25,20 @@ export interface UpdateExpirationForHITCommandOutput extends UpdateExpirationFor * 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. *

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { MTurkClient, UpdateExpirationForHITCommand } from "@aws-sdk/client-mturk"; // ES Modules import + * // const { MTurkClient, UpdateExpirationForHITCommand } = require("@aws-sdk/client-mturk"); // CommonJS import + * const client = new MTurkClient(config); + * const command = new UpdateExpirationForHITCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link UpdateExpirationForHITCommandInput} for command's `input` shape. + * @see {@link UpdateExpirationForHITCommandOutput} for command's `response` shape. + * @see {@link MTurkClientResolvedConfig | config} for command's `input` shape. + * */ export class UpdateExpirationForHITCommand extends $Command< UpdateExpirationForHITCommandInput, diff --git a/clients/client-mturk/commands/UpdateHITReviewStatusCommand.ts b/clients/client-mturk/commands/UpdateHITReviewStatusCommand.ts index 8615e6ffc811..b33e41290252 100644 --- a/clients/client-mturk/commands/UpdateHITReviewStatusCommand.ts +++ b/clients/client-mturk/commands/UpdateHITReviewStatusCommand.ts @@ -26,6 +26,20 @@ export interface UpdateHITReviewStatusCommandOutput extends UpdateHITReviewStatu * 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. *

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { MTurkClient, UpdateHITReviewStatusCommand } from "@aws-sdk/client-mturk"; // ES Modules import + * // const { MTurkClient, UpdateHITReviewStatusCommand } = require("@aws-sdk/client-mturk"); // CommonJS import + * const client = new MTurkClient(config); + * const command = new UpdateHITReviewStatusCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link UpdateHITReviewStatusCommandInput} for command's `input` shape. + * @see {@link UpdateHITReviewStatusCommandOutput} for command's `response` shape. + * @see {@link MTurkClientResolvedConfig | config} for command's `input` shape. + * */ export class UpdateHITReviewStatusCommand extends $Command< UpdateHITReviewStatusCommandInput, diff --git a/clients/client-mturk/commands/UpdateHITTypeOfHITCommand.ts b/clients/client-mturk/commands/UpdateHITTypeOfHITCommand.ts index c86893308bb6..b91050040f82 100644 --- a/clients/client-mturk/commands/UpdateHITTypeOfHITCommand.ts +++ b/clients/client-mturk/commands/UpdateHITTypeOfHITCommand.ts @@ -29,6 +29,20 @@ export interface UpdateHITTypeOfHITCommandOutput extends UpdateHITTypeOfHITRespo * associates it with the new HITType properties. The HIT takes on the * properties of the new HITType in place of the old ones. *

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { MTurkClient, UpdateHITTypeOfHITCommand } from "@aws-sdk/client-mturk"; // ES Modules import + * // const { MTurkClient, UpdateHITTypeOfHITCommand } = require("@aws-sdk/client-mturk"); // CommonJS import + * const client = new MTurkClient(config); + * const command = new UpdateHITTypeOfHITCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link UpdateHITTypeOfHITCommandInput} for command's `input` shape. + * @see {@link UpdateHITTypeOfHITCommandOutput} for command's `response` shape. + * @see {@link MTurkClientResolvedConfig | config} for command's `input` shape. + * */ export class UpdateHITTypeOfHITCommand extends $Command< UpdateHITTypeOfHITCommandInput, diff --git a/clients/client-mturk/commands/UpdateNotificationSettingsCommand.ts b/clients/client-mturk/commands/UpdateNotificationSettingsCommand.ts index 11b32d1cd97b..9b8bd6a709f4 100644 --- a/clients/client-mturk/commands/UpdateNotificationSettingsCommand.ts +++ b/clients/client-mturk/commands/UpdateNotificationSettingsCommand.ts @@ -33,6 +33,20 @@ export interface UpdateNotificationSettingsCommandOutput extends UpdateNotificat * the HIT type must already have a notification specification, * or one must be provided in the same call to UpdateNotificationSettings. *

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { MTurkClient, UpdateNotificationSettingsCommand } from "@aws-sdk/client-mturk"; // ES Modules import + * // const { MTurkClient, UpdateNotificationSettingsCommand } = require("@aws-sdk/client-mturk"); // CommonJS import + * const client = new MTurkClient(config); + * const command = new UpdateNotificationSettingsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link UpdateNotificationSettingsCommandInput} for command's `input` shape. + * @see {@link UpdateNotificationSettingsCommandOutput} for command's `response` shape. + * @see {@link MTurkClientResolvedConfig | config} for command's `input` shape. + * */ export class UpdateNotificationSettingsCommand extends $Command< UpdateNotificationSettingsCommandInput, diff --git a/clients/client-mturk/commands/UpdateQualificationTypeCommand.ts b/clients/client-mturk/commands/UpdateQualificationTypeCommand.ts index fe506f8a8924..f278599d08a1 100644 --- a/clients/client-mturk/commands/UpdateQualificationTypeCommand.ts +++ b/clients/client-mturk/commands/UpdateQualificationTypeCommand.ts @@ -54,6 +54,20 @@ export interface UpdateQualificationTypeCommandOutput extends UpdateQualificatio * granted manually.

*

You can also update the AutoGranted and AutoGrantedValue * attributes of the Qualification type.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { MTurkClient, UpdateQualificationTypeCommand } from "@aws-sdk/client-mturk"; // ES Modules import + * // const { MTurkClient, UpdateQualificationTypeCommand } = require("@aws-sdk/client-mturk"); // CommonJS import + * const client = new MTurkClient(config); + * const command = new UpdateQualificationTypeCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link UpdateQualificationTypeCommandInput} for command's `input` shape. + * @see {@link UpdateQualificationTypeCommandOutput} for command's `response` shape. + * @see {@link MTurkClientResolvedConfig | config} for command's `input` shape. + * */ export class UpdateQualificationTypeCommand extends $Command< UpdateQualificationTypeCommandInput, diff --git a/clients/client-mturk/models/models_0.ts b/clients/client-mturk/models/models_0.ts index 0c0269ab1600..5b7ae83378e8 100644 --- a/clients/client-mturk/models/models_0.ts +++ b/clients/client-mturk/models/models_0.ts @@ -17,6 +17,9 @@ export interface AcceptQualificationRequestRequest { } export namespace AcceptQualificationRequestRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: AcceptQualificationRequestRequest): any => ({ ...obj, }); @@ -25,6 +28,9 @@ export namespace AcceptQualificationRequestRequest { export interface AcceptQualificationRequestResponse {} export namespace AcceptQualificationRequestResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: AcceptQualificationRequestResponse): any => ({ ...obj, }); @@ -41,6 +47,9 @@ export interface RequestError extends __SmithyException, $MetadataBearer { } export namespace RequestError { + /** + * @internal + */ export const filterSensitiveLog = (obj: RequestError): any => ({ ...obj, }); @@ -57,6 +66,9 @@ export interface ServiceFault extends __SmithyException, $MetadataBearer { } export namespace ServiceFault { + /** + * @internal + */ export const filterSensitiveLog = (obj: ServiceFault): any => ({ ...obj, }); @@ -86,6 +98,9 @@ export interface ApproveAssignmentRequest { } export namespace ApproveAssignmentRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ApproveAssignmentRequest): any => ({ ...obj, }); @@ -94,6 +109,9 @@ export namespace ApproveAssignmentRequest { export interface ApproveAssignmentResponse {} export namespace ApproveAssignmentResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ApproveAssignmentResponse): any => ({ ...obj, }); @@ -194,6 +212,9 @@ export interface Assignment { } export namespace Assignment { + /** + * @internal + */ export const filterSensitiveLog = (obj: Assignment): any => ({ ...obj, }); @@ -229,6 +250,9 @@ export interface AssociateQualificationWithWorkerRequest { } export namespace AssociateQualificationWithWorkerRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: AssociateQualificationWithWorkerRequest): any => ({ ...obj, }); @@ -237,6 +261,9 @@ export namespace AssociateQualificationWithWorkerRequest { export interface AssociateQualificationWithWorkerResponse {} export namespace AssociateQualificationWithWorkerResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: AssociateQualificationWithWorkerResponse): any => ({ ...obj, }); @@ -273,6 +300,9 @@ export interface BonusPayment { } export namespace BonusPayment { + /** + * @internal + */ export const filterSensitiveLog = (obj: BonusPayment): any => ({ ...obj, }); @@ -316,6 +346,9 @@ export interface CreateAdditionalAssignmentsForHITRequest { } export namespace CreateAdditionalAssignmentsForHITRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateAdditionalAssignmentsForHITRequest): any => ({ ...obj, }); @@ -324,6 +357,9 @@ export namespace CreateAdditionalAssignmentsForHITRequest { export interface CreateAdditionalAssignmentsForHITResponse {} export namespace CreateAdditionalAssignmentsForHITResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateAdditionalAssignmentsForHITResponse): any => ({ ...obj, }); @@ -353,6 +389,9 @@ export interface ParameterMapEntry { } export namespace ParameterMapEntry { + /** + * @internal + */ export const filterSensitiveLog = (obj: ParameterMapEntry): any => ({ ...obj, }); @@ -382,6 +421,9 @@ export interface PolicyParameter { } export namespace PolicyParameter { + /** + * @internal + */ export const filterSensitiveLog = (obj: PolicyParameter): any => ({ ...obj, }); @@ -407,6 +449,9 @@ export interface ReviewPolicy { } export namespace ReviewPolicy { + /** + * @internal + */ export const filterSensitiveLog = (obj: ReviewPolicy): any => ({ ...obj, }); @@ -435,6 +480,9 @@ export interface HITLayoutParameter { } export namespace HITLayoutParameter { + /** + * @internal + */ export const filterSensitiveLog = (obj: HITLayoutParameter): any => ({ ...obj, }); @@ -467,6 +515,9 @@ export interface Locale { } export namespace Locale { + /** + * @internal + */ export const filterSensitiveLog = (obj: Locale): any => ({ ...obj, }); @@ -566,6 +617,9 @@ export interface QualificationRequirement { } export namespace QualificationRequirement { + /** + * @internal + */ export const filterSensitiveLog = (obj: QualificationRequirement): any => ({ ...obj, }); @@ -743,6 +797,9 @@ export interface CreateHITRequest { } export namespace CreateHITRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateHITRequest): any => ({ ...obj, }); @@ -904,6 +961,9 @@ export interface HIT { } export namespace HIT { + /** + * @internal + */ export const filterSensitiveLog = (obj: HIT): any => ({ ...obj, }); @@ -920,6 +980,9 @@ export interface CreateHITResponse { } export namespace CreateHITResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateHITResponse): any => ({ ...obj, }); @@ -994,6 +1057,9 @@ export interface CreateHITTypeRequest { } export namespace CreateHITTypeRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateHITTypeRequest): any => ({ ...obj, }); @@ -1007,6 +1073,9 @@ export interface CreateHITTypeResponse { } export namespace CreateHITTypeResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateHITTypeResponse): any => ({ ...obj, }); @@ -1123,6 +1192,9 @@ export interface CreateHITWithHITTypeRequest { } export namespace CreateHITWithHITTypeRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateHITWithHITTypeRequest): any => ({ ...obj, }); @@ -1139,6 +1211,9 @@ export interface CreateHITWithHITTypeResponse { } export namespace CreateHITWithHITTypeResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateHITWithHITTypeResponse): any => ({ ...obj, }); @@ -1242,6 +1317,9 @@ export interface CreateQualificationTypeRequest { } export namespace CreateQualificationTypeRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateQualificationTypeRequest): any => ({ ...obj, }); @@ -1362,6 +1440,9 @@ export interface QualificationType { } export namespace QualificationType { + /** + * @internal + */ export const filterSensitiveLog = (obj: QualificationType): any => ({ ...obj, }); @@ -1376,6 +1457,9 @@ export interface CreateQualificationTypeResponse { } export namespace CreateQualificationTypeResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateQualificationTypeResponse): any => ({ ...obj, }); @@ -1394,6 +1478,9 @@ export interface CreateWorkerBlockRequest { } export namespace CreateWorkerBlockRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateWorkerBlockRequest): any => ({ ...obj, }); @@ -1402,6 +1489,9 @@ export namespace CreateWorkerBlockRequest { export interface CreateWorkerBlockResponse {} export namespace CreateWorkerBlockResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateWorkerBlockResponse): any => ({ ...obj, }); @@ -1415,6 +1505,9 @@ export interface DeleteHITRequest { } export namespace DeleteHITRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteHITRequest): any => ({ ...obj, }); @@ -1423,6 +1516,9 @@ export namespace DeleteHITRequest { export interface DeleteHITResponse {} export namespace DeleteHITResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteHITResponse): any => ({ ...obj, }); @@ -1436,6 +1532,9 @@ export interface DeleteQualificationTypeRequest { } export namespace DeleteQualificationTypeRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteQualificationTypeRequest): any => ({ ...obj, }); @@ -1444,6 +1543,9 @@ export namespace DeleteQualificationTypeRequest { export interface DeleteQualificationTypeResponse {} export namespace DeleteQualificationTypeResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteQualificationTypeResponse): any => ({ ...obj, }); @@ -1462,6 +1564,9 @@ export interface DeleteWorkerBlockRequest { } export namespace DeleteWorkerBlockRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteWorkerBlockRequest): any => ({ ...obj, }); @@ -1470,6 +1575,9 @@ export namespace DeleteWorkerBlockRequest { export interface DeleteWorkerBlockResponse {} export namespace DeleteWorkerBlockResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteWorkerBlockResponse): any => ({ ...obj, }); @@ -1493,6 +1601,9 @@ export interface DisassociateQualificationFromWorkerRequest { } export namespace DisassociateQualificationFromWorkerRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DisassociateQualificationFromWorkerRequest): any => ({ ...obj, }); @@ -1501,6 +1612,9 @@ export namespace DisassociateQualificationFromWorkerRequest { export interface DisassociateQualificationFromWorkerResponse {} export namespace DisassociateQualificationFromWorkerResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DisassociateQualificationFromWorkerResponse): any => ({ ...obj, }); @@ -1524,6 +1638,9 @@ export enum EventType { export interface GetAccountBalanceRequest {} export namespace GetAccountBalanceRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetAccountBalanceRequest): any => ({ ...obj, }); @@ -1542,6 +1659,9 @@ export interface GetAccountBalanceResponse { } export namespace GetAccountBalanceResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetAccountBalanceResponse): any => ({ ...obj, }); @@ -1555,6 +1675,9 @@ export interface GetAssignmentRequest { } export namespace GetAssignmentRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetAssignmentRequest): any => ({ ...obj, }); @@ -1576,6 +1699,9 @@ export interface GetAssignmentResponse { } export namespace GetAssignmentResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetAssignmentResponse): any => ({ ...obj, }); @@ -1596,6 +1722,9 @@ export interface GetFileUploadURLRequest { } export namespace GetFileUploadURLRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetFileUploadURLRequest): any => ({ ...obj, }); @@ -1611,6 +1740,9 @@ export interface GetFileUploadURLResponse { } export namespace GetFileUploadURLResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetFileUploadURLResponse): any => ({ ...obj, }); @@ -1624,6 +1756,9 @@ export interface GetHITRequest { } export namespace GetHITRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetHITRequest): any => ({ ...obj, }); @@ -1637,6 +1772,9 @@ export interface GetHITResponse { } export namespace GetHITResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetHITResponse): any => ({ ...obj, }); @@ -1655,6 +1793,9 @@ export interface GetQualificationScoreRequest { } export namespace GetQualificationScoreRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetQualificationScoreRequest): any => ({ ...obj, }); @@ -1710,6 +1851,9 @@ export interface Qualification { } export namespace Qualification { + /** + * @internal + */ export const filterSensitiveLog = (obj: Qualification): any => ({ ...obj, }); @@ -1726,6 +1870,9 @@ export interface GetQualificationScoreResponse { } export namespace GetQualificationScoreResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetQualificationScoreResponse): any => ({ ...obj, }); @@ -1739,6 +1886,9 @@ export interface GetQualificationTypeRequest { } export namespace GetQualificationTypeRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetQualificationTypeRequest): any => ({ ...obj, }); @@ -1752,6 +1902,9 @@ export interface GetQualificationTypeResponse { } export namespace GetQualificationTypeResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetQualificationTypeResponse): any => ({ ...obj, }); @@ -1777,6 +1930,9 @@ export interface ListAssignmentsForHITRequest { } export namespace ListAssignmentsForHITRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListAssignmentsForHITRequest): any => ({ ...obj, }); @@ -1806,6 +1962,9 @@ export interface ListAssignmentsForHITResponse { } export namespace ListAssignmentsForHITResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListAssignmentsForHITResponse): any => ({ ...obj, }); @@ -1837,6 +1996,9 @@ export interface ListBonusPaymentsRequest { } export namespace ListBonusPaymentsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListBonusPaymentsRequest): any => ({ ...obj, }); @@ -1868,6 +2030,9 @@ export interface ListBonusPaymentsResponse { } export namespace ListBonusPaymentsResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListBonusPaymentsResponse): any => ({ ...obj, }); @@ -1883,6 +2048,9 @@ export interface ListHITsRequest { } export namespace ListHITsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListHITsRequest): any => ({ ...obj, }); @@ -1910,6 +2078,9 @@ export interface ListHITsResponse { } export namespace ListHITsResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListHITsResponse): any => ({ ...obj, }); @@ -1937,6 +2108,9 @@ export interface ListHITsForQualificationTypeRequest { } export namespace ListHITsForQualificationTypeRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListHITsForQualificationTypeRequest): any => ({ ...obj, }); @@ -1964,6 +2138,9 @@ export interface ListHITsForQualificationTypeResponse { } export namespace ListHITsForQualificationTypeResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListHITsForQualificationTypeResponse): any => ({ ...obj, }); @@ -1991,6 +2168,9 @@ export interface ListQualificationRequestsRequest { } export namespace ListQualificationRequestsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListQualificationRequestsRequest): any => ({ ...obj, }); @@ -2051,6 +2231,9 @@ export interface QualificationRequest { } export namespace QualificationRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: QualificationRequest): any => ({ ...obj, }); @@ -2081,6 +2264,9 @@ export interface ListQualificationRequestsResponse { } export namespace ListQualificationRequestsResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListQualificationRequestsResponse): any => ({ ...obj, }); @@ -2130,6 +2316,9 @@ export interface ListQualificationTypesRequest { } export namespace ListQualificationTypesRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListQualificationTypesRequest): any => ({ ...obj, }); @@ -2161,6 +2350,9 @@ export interface ListQualificationTypesResponse { } export namespace ListQualificationTypesResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListQualificationTypesResponse): any => ({ ...obj, }); @@ -2202,6 +2394,9 @@ export interface ListReviewableHITsRequest { } export namespace ListReviewableHITsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListReviewableHITsRequest): any => ({ ...obj, }); @@ -2230,6 +2425,9 @@ export interface ListReviewableHITsResponse { } export namespace ListReviewableHITsResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListReviewableHITsResponse): any => ({ ...obj, }); @@ -2282,6 +2480,9 @@ export interface ListReviewPolicyResultsForHITRequest { } export namespace ListReviewPolicyResultsForHITRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListReviewPolicyResultsForHITRequest): any => ({ ...obj, }); @@ -2348,6 +2549,9 @@ export interface ReviewActionDetail { } export namespace ReviewActionDetail { + /** + * @internal + */ export const filterSensitiveLog = (obj: ReviewActionDetail): any => ({ ...obj, }); @@ -2407,6 +2611,9 @@ export interface ReviewResultDetail { } export namespace ReviewResultDetail { + /** + * @internal + */ export const filterSensitiveLog = (obj: ReviewResultDetail): any => ({ ...obj, }); @@ -2434,6 +2641,9 @@ export interface ReviewReport { } export namespace ReviewReport { + /** + * @internal + */ export const filterSensitiveLog = (obj: ReviewReport): any => ({ ...obj, }); @@ -2481,6 +2691,9 @@ export interface ListReviewPolicyResultsForHITResponse { } export namespace ListReviewPolicyResultsForHITResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListReviewPolicyResultsForHITResponse): any => ({ ...obj, }); @@ -2496,6 +2709,9 @@ export interface ListWorkerBlocksRequest { } export namespace ListWorkerBlocksRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListWorkerBlocksRequest): any => ({ ...obj, }); @@ -2521,6 +2737,9 @@ export interface WorkerBlock { } export namespace WorkerBlock { + /** + * @internal + */ export const filterSensitiveLog = (obj: WorkerBlock): any => ({ ...obj, }); @@ -2550,6 +2769,9 @@ export interface ListWorkerBlocksResponse { } export namespace ListWorkerBlocksResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListWorkerBlocksResponse): any => ({ ...obj, }); @@ -2584,6 +2806,9 @@ export interface ListWorkersWithQualificationTypeRequest { } export namespace ListWorkersWithQualificationTypeRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListWorkersWithQualificationTypeRequest): any => ({ ...obj, }); @@ -2613,6 +2838,9 @@ export interface ListWorkersWithQualificationTypeResponse { } export namespace ListWorkersWithQualificationTypeResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListWorkersWithQualificationTypeResponse): any => ({ ...obj, }); @@ -2640,6 +2868,9 @@ export interface NotifyWorkersRequest { } export namespace NotifyWorkersRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: NotifyWorkersRequest): any => ({ ...obj, }); @@ -2676,6 +2907,9 @@ export interface NotifyWorkersFailureStatus { } export namespace NotifyWorkersFailureStatus { + /** + * @internal + */ export const filterSensitiveLog = (obj: NotifyWorkersFailureStatus): any => ({ ...obj, }); @@ -2692,6 +2926,9 @@ export interface NotifyWorkersResponse { } export namespace NotifyWorkersResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: NotifyWorkersResponse): any => ({ ...obj, }); @@ -2714,6 +2951,9 @@ export interface RejectAssignmentRequest { } export namespace RejectAssignmentRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: RejectAssignmentRequest): any => ({ ...obj, }); @@ -2722,6 +2962,9 @@ export namespace RejectAssignmentRequest { export interface RejectAssignmentResponse {} export namespace RejectAssignmentResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: RejectAssignmentResponse): any => ({ ...obj, }); @@ -2745,6 +2988,9 @@ export interface RejectQualificationRequestRequest { } export namespace RejectQualificationRequestRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: RejectQualificationRequestRequest): any => ({ ...obj, }); @@ -2753,6 +2999,9 @@ export namespace RejectQualificationRequestRequest { export interface RejectQualificationRequestResponse {} export namespace RejectQualificationRequestResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: RejectQualificationRequestResponse): any => ({ ...obj, }); @@ -2796,6 +3045,9 @@ export interface SendBonusRequest { } export namespace SendBonusRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: SendBonusRequest): any => ({ ...obj, }); @@ -2804,6 +3056,9 @@ export namespace SendBonusRequest { export interface SendBonusResponse {} export namespace SendBonusResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: SendBonusResponse): any => ({ ...obj, }); @@ -2864,6 +3119,9 @@ export interface NotificationSpecification { } export namespace NotificationSpecification { + /** + * @internal + */ export const filterSensitiveLog = (obj: NotificationSpecification): any => ({ ...obj, }); @@ -2891,6 +3149,9 @@ export interface SendTestEventNotificationRequest { } export namespace SendTestEventNotificationRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: SendTestEventNotificationRequest): any => ({ ...obj, }); @@ -2899,6 +3160,9 @@ export namespace SendTestEventNotificationRequest { export interface SendTestEventNotificationResponse {} export namespace SendTestEventNotificationResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: SendTestEventNotificationResponse): any => ({ ...obj, }); @@ -2921,6 +3185,9 @@ export interface UpdateExpirationForHITRequest { } export namespace UpdateExpirationForHITRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateExpirationForHITRequest): any => ({ ...obj, }); @@ -2929,6 +3196,9 @@ export namespace UpdateExpirationForHITRequest { export interface UpdateExpirationForHITResponse {} export namespace UpdateExpirationForHITResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateExpirationForHITResponse): any => ({ ...obj, }); @@ -2963,6 +3233,9 @@ export interface UpdateHITReviewStatusRequest { } export namespace UpdateHITReviewStatusRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateHITReviewStatusRequest): any => ({ ...obj, }); @@ -2971,6 +3244,9 @@ export namespace UpdateHITReviewStatusRequest { export interface UpdateHITReviewStatusResponse {} export namespace UpdateHITReviewStatusResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateHITReviewStatusResponse): any => ({ ...obj, }); @@ -2989,6 +3265,9 @@ export interface UpdateHITTypeOfHITRequest { } export namespace UpdateHITTypeOfHITRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateHITTypeOfHITRequest): any => ({ ...obj, }); @@ -2997,6 +3276,9 @@ export namespace UpdateHITTypeOfHITRequest { export interface UpdateHITTypeOfHITResponse {} export namespace UpdateHITTypeOfHITResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateHITTypeOfHITResponse): any => ({ ...obj, }); @@ -3029,6 +3311,9 @@ export interface UpdateNotificationSettingsRequest { } export namespace UpdateNotificationSettingsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateNotificationSettingsRequest): any => ({ ...obj, }); @@ -3037,6 +3322,9 @@ export namespace UpdateNotificationSettingsRequest { export interface UpdateNotificationSettingsResponse {} export namespace UpdateNotificationSettingsResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateNotificationSettingsResponse): any => ({ ...obj, }); @@ -3100,6 +3388,9 @@ export interface UpdateQualificationTypeRequest { } export namespace UpdateQualificationTypeRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateQualificationTypeRequest): any => ({ ...obj, }); @@ -3113,6 +3404,9 @@ export interface UpdateQualificationTypeResponse { } export namespace UpdateQualificationTypeResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateQualificationTypeResponse): any => ({ ...obj, }); diff --git a/clients/client-mwaa/commands/CreateCliTokenCommand.ts b/clients/client-mwaa/commands/CreateCliTokenCommand.ts index 5ec0eeb9a2a2..28919d02e25f 100644 --- a/clients/client-mwaa/commands/CreateCliTokenCommand.ts +++ b/clients/client-mwaa/commands/CreateCliTokenCommand.ts @@ -22,6 +22,20 @@ export interface CreateCliTokenCommandOutput extends CreateCliTokenResponse, __M /** *

Create a CLI token to use Airflow CLI.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { MWAAClient, CreateCliTokenCommand } from "@aws-sdk/client-mwaa"; // ES Modules import + * // const { MWAAClient, CreateCliTokenCommand } = require("@aws-sdk/client-mwaa"); // CommonJS import + * const client = new MWAAClient(config); + * const command = new CreateCliTokenCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreateCliTokenCommandInput} for command's `input` shape. + * @see {@link CreateCliTokenCommandOutput} for command's `response` shape. + * @see {@link MWAAClientResolvedConfig | config} for command's `input` shape. + * */ export class CreateCliTokenCommand extends $Command< CreateCliTokenCommandInput, diff --git a/clients/client-mwaa/commands/CreateEnvironmentCommand.ts b/clients/client-mwaa/commands/CreateEnvironmentCommand.ts index d434d2a90dd7..3f330fd10f40 100644 --- a/clients/client-mwaa/commands/CreateEnvironmentCommand.ts +++ b/clients/client-mwaa/commands/CreateEnvironmentCommand.ts @@ -22,6 +22,20 @@ export interface CreateEnvironmentCommandOutput extends CreateEnvironmentOutput, /** *

JSON blob that describes the environment to create.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { MWAAClient, CreateEnvironmentCommand } from "@aws-sdk/client-mwaa"; // ES Modules import + * // const { MWAAClient, CreateEnvironmentCommand } = require("@aws-sdk/client-mwaa"); // CommonJS import + * const client = new MWAAClient(config); + * const command = new CreateEnvironmentCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreateEnvironmentCommandInput} for command's `input` shape. + * @see {@link CreateEnvironmentCommandOutput} for command's `response` shape. + * @see {@link MWAAClientResolvedConfig | config} for command's `input` shape. + * */ export class CreateEnvironmentCommand extends $Command< CreateEnvironmentCommandInput, diff --git a/clients/client-mwaa/commands/CreateWebLoginTokenCommand.ts b/clients/client-mwaa/commands/CreateWebLoginTokenCommand.ts index 90ef7db88014..1535cab3aa2f 100644 --- a/clients/client-mwaa/commands/CreateWebLoginTokenCommand.ts +++ b/clients/client-mwaa/commands/CreateWebLoginTokenCommand.ts @@ -22,6 +22,20 @@ export interface CreateWebLoginTokenCommandOutput extends CreateWebLoginTokenRes /** *

Create a JWT token to be used to login to Airflow Web UI with claims based Authentication.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { MWAAClient, CreateWebLoginTokenCommand } from "@aws-sdk/client-mwaa"; // ES Modules import + * // const { MWAAClient, CreateWebLoginTokenCommand } = require("@aws-sdk/client-mwaa"); // CommonJS import + * const client = new MWAAClient(config); + * const command = new CreateWebLoginTokenCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreateWebLoginTokenCommandInput} for command's `input` shape. + * @see {@link CreateWebLoginTokenCommandOutput} for command's `response` shape. + * @see {@link MWAAClientResolvedConfig | config} for command's `input` shape. + * */ export class CreateWebLoginTokenCommand extends $Command< CreateWebLoginTokenCommandInput, diff --git a/clients/client-mwaa/commands/DeleteEnvironmentCommand.ts b/clients/client-mwaa/commands/DeleteEnvironmentCommand.ts index 29107571a2e2..157bcbf2ed3b 100644 --- a/clients/client-mwaa/commands/DeleteEnvironmentCommand.ts +++ b/clients/client-mwaa/commands/DeleteEnvironmentCommand.ts @@ -22,6 +22,20 @@ export interface DeleteEnvironmentCommandOutput extends DeleteEnvironmentOutput, /** *

Delete an existing environment.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { MWAAClient, DeleteEnvironmentCommand } from "@aws-sdk/client-mwaa"; // ES Modules import + * // const { MWAAClient, DeleteEnvironmentCommand } = require("@aws-sdk/client-mwaa"); // CommonJS import + * const client = new MWAAClient(config); + * const command = new DeleteEnvironmentCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteEnvironmentCommandInput} for command's `input` shape. + * @see {@link DeleteEnvironmentCommandOutput} for command's `response` shape. + * @see {@link MWAAClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteEnvironmentCommand extends $Command< DeleteEnvironmentCommandInput, diff --git a/clients/client-mwaa/commands/GetEnvironmentCommand.ts b/clients/client-mwaa/commands/GetEnvironmentCommand.ts index a2c45e547b91..2894024ffdcd 100644 --- a/clients/client-mwaa/commands/GetEnvironmentCommand.ts +++ b/clients/client-mwaa/commands/GetEnvironmentCommand.ts @@ -22,6 +22,20 @@ export interface GetEnvironmentCommandOutput extends GetEnvironmentOutput, __Met /** *

Get details of an existing environment.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { MWAAClient, GetEnvironmentCommand } from "@aws-sdk/client-mwaa"; // ES Modules import + * // const { MWAAClient, GetEnvironmentCommand } = require("@aws-sdk/client-mwaa"); // CommonJS import + * const client = new MWAAClient(config); + * const command = new GetEnvironmentCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetEnvironmentCommandInput} for command's `input` shape. + * @see {@link GetEnvironmentCommandOutput} for command's `response` shape. + * @see {@link MWAAClientResolvedConfig | config} for command's `input` shape. + * */ export class GetEnvironmentCommand extends $Command< GetEnvironmentCommandInput, diff --git a/clients/client-mwaa/commands/ListEnvironmentsCommand.ts b/clients/client-mwaa/commands/ListEnvironmentsCommand.ts index 91d34a3844a8..d94b6d20fa72 100644 --- a/clients/client-mwaa/commands/ListEnvironmentsCommand.ts +++ b/clients/client-mwaa/commands/ListEnvironmentsCommand.ts @@ -22,6 +22,20 @@ export interface ListEnvironmentsCommandOutput extends ListEnvironmentsOutput, _ /** *

List Amazon MWAA Environments.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { MWAAClient, ListEnvironmentsCommand } from "@aws-sdk/client-mwaa"; // ES Modules import + * // const { MWAAClient, ListEnvironmentsCommand } = require("@aws-sdk/client-mwaa"); // CommonJS import + * const client = new MWAAClient(config); + * const command = new ListEnvironmentsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListEnvironmentsCommandInput} for command's `input` shape. + * @see {@link ListEnvironmentsCommandOutput} for command's `response` shape. + * @see {@link MWAAClientResolvedConfig | config} for command's `input` shape. + * */ export class ListEnvironmentsCommand extends $Command< ListEnvironmentsCommandInput, diff --git a/clients/client-mwaa/commands/ListTagsForResourceCommand.ts b/clients/client-mwaa/commands/ListTagsForResourceCommand.ts index 45880d73f584..9253c0b176a4 100644 --- a/clients/client-mwaa/commands/ListTagsForResourceCommand.ts +++ b/clients/client-mwaa/commands/ListTagsForResourceCommand.ts @@ -22,6 +22,20 @@ export interface ListTagsForResourceCommandOutput extends ListTagsForResourceOut /** *

List the tags for MWAA environments.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { MWAAClient, ListTagsForResourceCommand } from "@aws-sdk/client-mwaa"; // ES Modules import + * // const { MWAAClient, ListTagsForResourceCommand } = require("@aws-sdk/client-mwaa"); // CommonJS import + * const client = new MWAAClient(config); + * const command = new ListTagsForResourceCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListTagsForResourceCommandInput} for command's `input` shape. + * @see {@link ListTagsForResourceCommandOutput} for command's `response` shape. + * @see {@link MWAAClientResolvedConfig | config} for command's `input` shape. + * */ export class ListTagsForResourceCommand extends $Command< ListTagsForResourceCommandInput, diff --git a/clients/client-mwaa/commands/PublishMetricsCommand.ts b/clients/client-mwaa/commands/PublishMetricsCommand.ts index baf3421f8b1d..b2c1434252b7 100644 --- a/clients/client-mwaa/commands/PublishMetricsCommand.ts +++ b/clients/client-mwaa/commands/PublishMetricsCommand.ts @@ -22,6 +22,20 @@ export interface PublishMetricsCommandOutput extends PublishMetricsOutput, __Met /** * An operation for publishing metrics from the customers to the Ops plane. + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { MWAAClient, PublishMetricsCommand } from "@aws-sdk/client-mwaa"; // ES Modules import + * // const { MWAAClient, PublishMetricsCommand } = require("@aws-sdk/client-mwaa"); // CommonJS import + * const client = new MWAAClient(config); + * const command = new PublishMetricsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link PublishMetricsCommandInput} for command's `input` shape. + * @see {@link PublishMetricsCommandOutput} for command's `response` shape. + * @see {@link MWAAClientResolvedConfig | config} for command's `input` shape. + * */ export class PublishMetricsCommand extends $Command< PublishMetricsCommandInput, diff --git a/clients/client-mwaa/commands/TagResourceCommand.ts b/clients/client-mwaa/commands/TagResourceCommand.ts index ee3a73ae7add..982062f25a60 100644 --- a/clients/client-mwaa/commands/TagResourceCommand.ts +++ b/clients/client-mwaa/commands/TagResourceCommand.ts @@ -22,6 +22,20 @@ export interface TagResourceCommandOutput extends TagResourceOutput, __MetadataB /** *

Add tag to the MWAA environments.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { MWAAClient, TagResourceCommand } from "@aws-sdk/client-mwaa"; // ES Modules import + * // const { MWAAClient, TagResourceCommand } = require("@aws-sdk/client-mwaa"); // CommonJS import + * const client = new MWAAClient(config); + * const command = new TagResourceCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link TagResourceCommandInput} for command's `input` shape. + * @see {@link TagResourceCommandOutput} for command's `response` shape. + * @see {@link MWAAClientResolvedConfig | config} for command's `input` shape. + * */ export class TagResourceCommand extends $Command< TagResourceCommandInput, diff --git a/clients/client-mwaa/commands/UntagResourceCommand.ts b/clients/client-mwaa/commands/UntagResourceCommand.ts index 7bdadf385a8b..84bccb8d9686 100644 --- a/clients/client-mwaa/commands/UntagResourceCommand.ts +++ b/clients/client-mwaa/commands/UntagResourceCommand.ts @@ -22,6 +22,20 @@ export interface UntagResourceCommandOutput extends UntagResourceOutput, __Metad /** *

Remove a tag from the MWAA environments.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { MWAAClient, UntagResourceCommand } from "@aws-sdk/client-mwaa"; // ES Modules import + * // const { MWAAClient, UntagResourceCommand } = require("@aws-sdk/client-mwaa"); // CommonJS import + * const client = new MWAAClient(config); + * const command = new UntagResourceCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link UntagResourceCommandInput} for command's `input` shape. + * @see {@link UntagResourceCommandOutput} for command's `response` shape. + * @see {@link MWAAClientResolvedConfig | config} for command's `input` shape. + * */ export class UntagResourceCommand extends $Command< UntagResourceCommandInput, diff --git a/clients/client-mwaa/commands/UpdateEnvironmentCommand.ts b/clients/client-mwaa/commands/UpdateEnvironmentCommand.ts index 68f9140ef4bc..425f94dbbcf9 100644 --- a/clients/client-mwaa/commands/UpdateEnvironmentCommand.ts +++ b/clients/client-mwaa/commands/UpdateEnvironmentCommand.ts @@ -22,6 +22,20 @@ export interface UpdateEnvironmentCommandOutput extends UpdateEnvironmentOutput, /** *

Update an MWAA environment.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { MWAAClient, UpdateEnvironmentCommand } from "@aws-sdk/client-mwaa"; // ES Modules import + * // const { MWAAClient, UpdateEnvironmentCommand } = require("@aws-sdk/client-mwaa"); // CommonJS import + * const client = new MWAAClient(config); + * const command = new UpdateEnvironmentCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link UpdateEnvironmentCommandInput} for command's `input` shape. + * @see {@link UpdateEnvironmentCommandOutput} for command's `response` shape. + * @see {@link MWAAClientResolvedConfig | config} for command's `input` shape. + * */ export class UpdateEnvironmentCommand extends $Command< UpdateEnvironmentCommandInput, diff --git a/clients/client-mwaa/models/models_0.ts b/clients/client-mwaa/models/models_0.ts index fecab7c7f0bf..b4fe9cc1b0fa 100644 --- a/clients/client-mwaa/models/models_0.ts +++ b/clients/client-mwaa/models/models_0.ts @@ -11,6 +11,9 @@ export interface AccessDeniedException extends __SmithyException, $MetadataBeare } export namespace AccessDeniedException { + /** + * @internal + */ export const filterSensitiveLog = (obj: AccessDeniedException): any => ({ ...obj, }); @@ -24,6 +27,9 @@ export interface CreateCliTokenRequest { } export namespace CreateCliTokenRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateCliTokenRequest): any => ({ ...obj, }); @@ -42,6 +48,9 @@ export interface CreateCliTokenResponse { } export namespace CreateCliTokenResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateCliTokenResponse): any => ({ ...obj, ...(obj.CliToken && { CliToken: SENSITIVE_STRING }), @@ -58,6 +67,9 @@ export interface ResourceNotFoundException extends __SmithyException, $MetadataB } export namespace ResourceNotFoundException { + /** + * @internal + */ export const filterSensitiveLog = (obj: ResourceNotFoundException): any => ({ ...obj, }); @@ -88,6 +100,9 @@ export interface ModuleLoggingConfigurationInput { } export namespace ModuleLoggingConfigurationInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: ModuleLoggingConfigurationInput): any => ({ ...obj, }); @@ -129,6 +144,9 @@ export interface LoggingConfigurationInput { } export namespace LoggingConfigurationInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: LoggingConfigurationInput): any => ({ ...obj, }); @@ -150,6 +168,9 @@ export interface NetworkConfiguration { } export namespace NetworkConfiguration { + /** + * @internal + */ export const filterSensitiveLog = (obj: NetworkConfiguration): any => ({ ...obj, }); @@ -261,6 +282,9 @@ export interface CreateEnvironmentInput { } export namespace CreateEnvironmentInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateEnvironmentInput): any => ({ ...obj, ...(obj.AirflowConfigurationOptions && { AirflowConfigurationOptions: SENSITIVE_STRING }), @@ -275,6 +299,9 @@ export interface CreateEnvironmentOutput { } export namespace CreateEnvironmentOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateEnvironmentOutput): any => ({ ...obj, }); @@ -290,6 +317,9 @@ export interface InternalServerException extends __SmithyException, $MetadataBea } export namespace InternalServerException { + /** + * @internal + */ export const filterSensitiveLog = (obj: InternalServerException): any => ({ ...obj, }); @@ -305,6 +335,9 @@ export interface ValidationException extends __SmithyException, $MetadataBearer } export namespace ValidationException { + /** + * @internal + */ export const filterSensitiveLog = (obj: ValidationException): any => ({ ...obj, }); @@ -318,6 +351,9 @@ export interface CreateWebLoginTokenRequest { } export namespace CreateWebLoginTokenRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateWebLoginTokenRequest): any => ({ ...obj, }); @@ -336,6 +372,9 @@ export interface CreateWebLoginTokenResponse { } export namespace CreateWebLoginTokenResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateWebLoginTokenResponse): any => ({ ...obj, ...(obj.WebToken && { WebToken: SENSITIVE_STRING }), @@ -350,6 +389,9 @@ export interface DeleteEnvironmentInput { } export namespace DeleteEnvironmentInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteEnvironmentInput): any => ({ ...obj, }); @@ -358,6 +400,9 @@ export namespace DeleteEnvironmentInput { export interface DeleteEnvironmentOutput {} export namespace DeleteEnvironmentOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteEnvironmentOutput): any => ({ ...obj, }); @@ -371,6 +416,9 @@ export interface GetEnvironmentInput { } export namespace GetEnvironmentInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetEnvironmentInput): any => ({ ...obj, }); @@ -392,6 +440,9 @@ export interface UpdateError { } export namespace UpdateError { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateError): any => ({ ...obj, }); @@ -424,6 +475,9 @@ export interface LastUpdate { } export namespace LastUpdate { + /** + * @internal + */ export const filterSensitiveLog = (obj: LastUpdate): any => ({ ...obj, }); @@ -451,6 +505,9 @@ export interface ModuleLoggingConfiguration { } export namespace ModuleLoggingConfiguration { + /** + * @internal + */ export const filterSensitiveLog = (obj: ModuleLoggingConfiguration): any => ({ ...obj, }); @@ -492,6 +549,9 @@ export interface LoggingConfiguration { } export namespace LoggingConfiguration { + /** + * @internal + */ export const filterSensitiveLog = (obj: LoggingConfiguration): any => ({ ...obj, }); @@ -639,6 +699,9 @@ export interface Environment { } export namespace Environment { + /** + * @internal + */ export const filterSensitiveLog = (obj: Environment): any => ({ ...obj, }); @@ -652,6 +715,9 @@ export interface GetEnvironmentOutput { } export namespace GetEnvironmentOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetEnvironmentOutput): any => ({ ...obj, }); @@ -670,6 +736,9 @@ export interface ListEnvironmentsInput { } export namespace ListEnvironmentsInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListEnvironmentsInput): any => ({ ...obj, }); @@ -688,6 +757,9 @@ export interface ListEnvironmentsOutput { } export namespace ListEnvironmentsOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListEnvironmentsOutput): any => ({ ...obj, }); @@ -701,6 +773,9 @@ export interface ListTagsForResourceInput { } export namespace ListTagsForResourceInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListTagsForResourceInput): any => ({ ...obj, }); @@ -714,6 +789,9 @@ export interface ListTagsForResourceOutput { } export namespace ListTagsForResourceOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListTagsForResourceOutput): any => ({ ...obj, }); @@ -735,6 +813,9 @@ export interface Dimension { } export namespace Dimension { + /** + * @internal + */ export const filterSensitiveLog = (obj: Dimension): any => ({ ...obj, }); @@ -766,6 +847,9 @@ export interface StatisticSet { } export namespace StatisticSet { + /** + * @internal + */ export const filterSensitiveLog = (obj: StatisticSet): any => ({ ...obj, }); @@ -837,6 +921,9 @@ export interface MetricDatum { } export namespace MetricDatum { + /** + * @internal + */ export const filterSensitiveLog = (obj: MetricDatum): any => ({ ...obj, }); @@ -855,6 +942,9 @@ export interface PublishMetricsInput { } export namespace PublishMetricsInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: PublishMetricsInput): any => ({ ...obj, }); @@ -863,6 +953,9 @@ export namespace PublishMetricsInput { export interface PublishMetricsOutput {} export namespace PublishMetricsOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: PublishMetricsOutput): any => ({ ...obj, }); @@ -881,6 +974,9 @@ export interface TagResourceInput { } export namespace TagResourceInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: TagResourceInput): any => ({ ...obj, }); @@ -889,6 +985,9 @@ export namespace TagResourceInput { export interface TagResourceOutput {} export namespace TagResourceOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: TagResourceOutput): any => ({ ...obj, }); @@ -907,6 +1006,9 @@ export interface UntagResourceInput { } export namespace UntagResourceInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: UntagResourceInput): any => ({ ...obj, }); @@ -915,6 +1017,9 @@ export namespace UntagResourceInput { export interface UntagResourceOutput {} export namespace UntagResourceOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: UntagResourceOutput): any => ({ ...obj, }); @@ -931,6 +1036,9 @@ export interface UpdateNetworkConfigurationInput { } export namespace UpdateNetworkConfigurationInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateNetworkConfigurationInput): any => ({ ...obj, }); @@ -1024,6 +1132,9 @@ export interface UpdateEnvironmentInput { } export namespace UpdateEnvironmentInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateEnvironmentInput): any => ({ ...obj, ...(obj.AirflowConfigurationOptions && { AirflowConfigurationOptions: SENSITIVE_STRING }), @@ -1038,6 +1149,9 @@ export interface UpdateEnvironmentOutput { } export namespace UpdateEnvironmentOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateEnvironmentOutput): any => ({ ...obj, }); diff --git a/clients/client-neptune/commands/AddRoleToDBClusterCommand.ts b/clients/client-neptune/commands/AddRoleToDBClusterCommand.ts index 8839a8b3a3f6..b937bde880c8 100644 --- a/clients/client-neptune/commands/AddRoleToDBClusterCommand.ts +++ b/clients/client-neptune/commands/AddRoleToDBClusterCommand.ts @@ -23,6 +23,20 @@ export interface AddRoleToDBClusterCommandOutput extends __MetadataBearer {} /** *

Associates an Identity and Access Management (IAM) role from an * Neptune DB cluster.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { NeptuneClient, AddRoleToDBClusterCommand } from "@aws-sdk/client-neptune"; // ES Modules import + * // const { NeptuneClient, AddRoleToDBClusterCommand } = require("@aws-sdk/client-neptune"); // CommonJS import + * const client = new NeptuneClient(config); + * const command = new AddRoleToDBClusterCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link AddRoleToDBClusterCommandInput} for command's `input` shape. + * @see {@link AddRoleToDBClusterCommandOutput} for command's `response` shape. + * @see {@link NeptuneClientResolvedConfig | config} for command's `input` shape. + * */ export class AddRoleToDBClusterCommand extends $Command< AddRoleToDBClusterCommandInput, diff --git a/clients/client-neptune/commands/AddSourceIdentifierToSubscriptionCommand.ts b/clients/client-neptune/commands/AddSourceIdentifierToSubscriptionCommand.ts index 686b099f2d2a..36b57c1c0e55 100644 --- a/clients/client-neptune/commands/AddSourceIdentifierToSubscriptionCommand.ts +++ b/clients/client-neptune/commands/AddSourceIdentifierToSubscriptionCommand.ts @@ -24,6 +24,20 @@ export interface AddSourceIdentifierToSubscriptionCommandOutput /** *

Adds a source identifier to an existing event notification subscription.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { NeptuneClient, AddSourceIdentifierToSubscriptionCommand } from "@aws-sdk/client-neptune"; // ES Modules import + * // const { NeptuneClient, AddSourceIdentifierToSubscriptionCommand } = require("@aws-sdk/client-neptune"); // CommonJS import + * const client = new NeptuneClient(config); + * const command = new AddSourceIdentifierToSubscriptionCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link AddSourceIdentifierToSubscriptionCommandInput} for command's `input` shape. + * @see {@link AddSourceIdentifierToSubscriptionCommandOutput} for command's `response` shape. + * @see {@link NeptuneClientResolvedConfig | config} for command's `input` shape. + * */ export class AddSourceIdentifierToSubscriptionCommand extends $Command< AddSourceIdentifierToSubscriptionCommandInput, diff --git a/clients/client-neptune/commands/AddTagsToResourceCommand.ts b/clients/client-neptune/commands/AddTagsToResourceCommand.ts index 50a4f50f8165..6384130316ac 100644 --- a/clients/client-neptune/commands/AddTagsToResourceCommand.ts +++ b/clients/client-neptune/commands/AddTagsToResourceCommand.ts @@ -24,6 +24,20 @@ export interface AddTagsToResourceCommandOutput extends __MetadataBearer {} *

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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { NeptuneClient, AddTagsToResourceCommand } from "@aws-sdk/client-neptune"; // ES Modules import + * // const { NeptuneClient, AddTagsToResourceCommand } = require("@aws-sdk/client-neptune"); // CommonJS import + * const client = new NeptuneClient(config); + * const command = new AddTagsToResourceCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link AddTagsToResourceCommandInput} for command's `input` shape. + * @see {@link AddTagsToResourceCommandOutput} for command's `response` shape. + * @see {@link NeptuneClientResolvedConfig | config} for command's `input` shape. + * */ export class AddTagsToResourceCommand extends $Command< AddTagsToResourceCommandInput, diff --git a/clients/client-neptune/commands/ApplyPendingMaintenanceActionCommand.ts b/clients/client-neptune/commands/ApplyPendingMaintenanceActionCommand.ts index e45b324cc7f1..35e496b5ce24 100644 --- a/clients/client-neptune/commands/ApplyPendingMaintenanceActionCommand.ts +++ b/clients/client-neptune/commands/ApplyPendingMaintenanceActionCommand.ts @@ -24,6 +24,20 @@ export interface ApplyPendingMaintenanceActionCommandOutput /** *

Applies a pending maintenance action to a resource (for example, to a DB instance).

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { NeptuneClient, ApplyPendingMaintenanceActionCommand } from "@aws-sdk/client-neptune"; // ES Modules import + * // const { NeptuneClient, ApplyPendingMaintenanceActionCommand } = require("@aws-sdk/client-neptune"); // CommonJS import + * const client = new NeptuneClient(config); + * const command = new ApplyPendingMaintenanceActionCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ApplyPendingMaintenanceActionCommandInput} for command's `input` shape. + * @see {@link ApplyPendingMaintenanceActionCommandOutput} for command's `response` shape. + * @see {@link NeptuneClientResolvedConfig | config} for command's `input` shape. + * */ export class ApplyPendingMaintenanceActionCommand extends $Command< ApplyPendingMaintenanceActionCommandInput, diff --git a/clients/client-neptune/commands/CopyDBClusterParameterGroupCommand.ts b/clients/client-neptune/commands/CopyDBClusterParameterGroupCommand.ts index 4287fb99aa9e..0b4343802dab 100644 --- a/clients/client-neptune/commands/CopyDBClusterParameterGroupCommand.ts +++ b/clients/client-neptune/commands/CopyDBClusterParameterGroupCommand.ts @@ -22,6 +22,20 @@ export interface CopyDBClusterParameterGroupCommandOutput extends CopyDBClusterP /** *

Copies the specified DB cluster parameter group.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { NeptuneClient, CopyDBClusterParameterGroupCommand } from "@aws-sdk/client-neptune"; // ES Modules import + * // const { NeptuneClient, CopyDBClusterParameterGroupCommand } = require("@aws-sdk/client-neptune"); // CommonJS import + * const client = new NeptuneClient(config); + * const command = new CopyDBClusterParameterGroupCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CopyDBClusterParameterGroupCommandInput} for command's `input` shape. + * @see {@link CopyDBClusterParameterGroupCommandOutput} for command's `response` shape. + * @see {@link NeptuneClientResolvedConfig | config} for command's `input` shape. + * */ export class CopyDBClusterParameterGroupCommand extends $Command< CopyDBClusterParameterGroupCommandInput, diff --git a/clients/client-neptune/commands/CopyDBClusterSnapshotCommand.ts b/clients/client-neptune/commands/CopyDBClusterSnapshotCommand.ts index fb230499bcf1..63a9f43076a3 100644 --- a/clients/client-neptune/commands/CopyDBClusterSnapshotCommand.ts +++ b/clients/client-neptune/commands/CopyDBClusterSnapshotCommand.ts @@ -26,6 +26,20 @@ export interface CopyDBClusterSnapshotCommandOutput extends CopyDBClusterSnapsho *

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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { NeptuneClient, CopyDBClusterSnapshotCommand } from "@aws-sdk/client-neptune"; // ES Modules import + * // const { NeptuneClient, CopyDBClusterSnapshotCommand } = require("@aws-sdk/client-neptune"); // CommonJS import + * const client = new NeptuneClient(config); + * const command = new CopyDBClusterSnapshotCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CopyDBClusterSnapshotCommandInput} for command's `input` shape. + * @see {@link CopyDBClusterSnapshotCommandOutput} for command's `response` shape. + * @see {@link NeptuneClientResolvedConfig | config} for command's `input` shape. + * */ export class CopyDBClusterSnapshotCommand extends $Command< CopyDBClusterSnapshotCommandInput, diff --git a/clients/client-neptune/commands/CopyDBParameterGroupCommand.ts b/clients/client-neptune/commands/CopyDBParameterGroupCommand.ts index 0adb5565b444..ea65c4ad4857 100644 --- a/clients/client-neptune/commands/CopyDBParameterGroupCommand.ts +++ b/clients/client-neptune/commands/CopyDBParameterGroupCommand.ts @@ -22,6 +22,20 @@ export interface CopyDBParameterGroupCommandOutput extends CopyDBParameterGroupR /** *

Copies the specified DB parameter group.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { NeptuneClient, CopyDBParameterGroupCommand } from "@aws-sdk/client-neptune"; // ES Modules import + * // const { NeptuneClient, CopyDBParameterGroupCommand } = require("@aws-sdk/client-neptune"); // CommonJS import + * const client = new NeptuneClient(config); + * const command = new CopyDBParameterGroupCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CopyDBParameterGroupCommandInput} for command's `input` shape. + * @see {@link CopyDBParameterGroupCommandOutput} for command's `response` shape. + * @see {@link NeptuneClientResolvedConfig | config} for command's `input` shape. + * */ export class CopyDBParameterGroupCommand extends $Command< CopyDBParameterGroupCommandInput, diff --git a/clients/client-neptune/commands/CreateDBClusterCommand.ts b/clients/client-neptune/commands/CreateDBClusterCommand.ts index 46c2a266cbcb..c15be9a76503 100644 --- a/clients/client-neptune/commands/CreateDBClusterCommand.ts +++ b/clients/client-neptune/commands/CreateDBClusterCommand.ts @@ -29,6 +29,20 @@ export interface CreateDBClusterCommandOutput extends CreateDBClusterResult, __M * 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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { NeptuneClient, CreateDBClusterCommand } from "@aws-sdk/client-neptune"; // ES Modules import + * // const { NeptuneClient, CreateDBClusterCommand } = require("@aws-sdk/client-neptune"); // CommonJS import + * const client = new NeptuneClient(config); + * const command = new CreateDBClusterCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreateDBClusterCommandInput} for command's `input` shape. + * @see {@link CreateDBClusterCommandOutput} for command's `response` shape. + * @see {@link NeptuneClientResolvedConfig | config} for command's `input` shape. + * */ export class CreateDBClusterCommand extends $Command< CreateDBClusterCommandInput, diff --git a/clients/client-neptune/commands/CreateDBClusterEndpointCommand.ts b/clients/client-neptune/commands/CreateDBClusterEndpointCommand.ts index 741008ab838a..747195087db5 100644 --- a/clients/client-neptune/commands/CreateDBClusterEndpointCommand.ts +++ b/clients/client-neptune/commands/CreateDBClusterEndpointCommand.ts @@ -22,6 +22,20 @@ export interface CreateDBClusterEndpointCommandOutput extends CreateDBClusterEnd /** *

Creates a new custom endpoint and associates it with an Amazon Neptune DB cluster.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { NeptuneClient, CreateDBClusterEndpointCommand } from "@aws-sdk/client-neptune"; // ES Modules import + * // const { NeptuneClient, CreateDBClusterEndpointCommand } = require("@aws-sdk/client-neptune"); // CommonJS import + * const client = new NeptuneClient(config); + * const command = new CreateDBClusterEndpointCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreateDBClusterEndpointCommandInput} for command's `input` shape. + * @see {@link CreateDBClusterEndpointCommandOutput} for command's `response` shape. + * @see {@link NeptuneClientResolvedConfig | config} for command's `input` shape. + * */ export class CreateDBClusterEndpointCommand extends $Command< CreateDBClusterEndpointCommandInput, diff --git a/clients/client-neptune/commands/CreateDBClusterParameterGroupCommand.ts b/clients/client-neptune/commands/CreateDBClusterParameterGroupCommand.ts index 3c9b0da33207..08858b4753ea 100644 --- a/clients/client-neptune/commands/CreateDBClusterParameterGroupCommand.ts +++ b/clients/client-neptune/commands/CreateDBClusterParameterGroupCommand.ts @@ -48,6 +48,20 @@ export interface CreateDBClusterParameterGroupCommandOutput * console or the DescribeDBClusterParameters * command to verify that your DB cluster parameter group has been created or modified.

* + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { NeptuneClient, CreateDBClusterParameterGroupCommand } from "@aws-sdk/client-neptune"; // ES Modules import + * // const { NeptuneClient, CreateDBClusterParameterGroupCommand } = require("@aws-sdk/client-neptune"); // CommonJS import + * const client = new NeptuneClient(config); + * const command = new CreateDBClusterParameterGroupCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreateDBClusterParameterGroupCommandInput} for command's `input` shape. + * @see {@link CreateDBClusterParameterGroupCommandOutput} for command's `response` shape. + * @see {@link NeptuneClientResolvedConfig | config} for command's `input` shape. + * */ export class CreateDBClusterParameterGroupCommand extends $Command< CreateDBClusterParameterGroupCommandInput, diff --git a/clients/client-neptune/commands/CreateDBClusterSnapshotCommand.ts b/clients/client-neptune/commands/CreateDBClusterSnapshotCommand.ts index 008fdfa092ba..6cd4d44ffaeb 100644 --- a/clients/client-neptune/commands/CreateDBClusterSnapshotCommand.ts +++ b/clients/client-neptune/commands/CreateDBClusterSnapshotCommand.ts @@ -22,6 +22,20 @@ export interface CreateDBClusterSnapshotCommandOutput extends CreateDBClusterSna /** *

Creates a snapshot of a DB cluster.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { NeptuneClient, CreateDBClusterSnapshotCommand } from "@aws-sdk/client-neptune"; // ES Modules import + * // const { NeptuneClient, CreateDBClusterSnapshotCommand } = require("@aws-sdk/client-neptune"); // CommonJS import + * const client = new NeptuneClient(config); + * const command = new CreateDBClusterSnapshotCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreateDBClusterSnapshotCommandInput} for command's `input` shape. + * @see {@link CreateDBClusterSnapshotCommandOutput} for command's `response` shape. + * @see {@link NeptuneClientResolvedConfig | config} for command's `input` shape. + * */ export class CreateDBClusterSnapshotCommand extends $Command< CreateDBClusterSnapshotCommandInput, diff --git a/clients/client-neptune/commands/CreateDBInstanceCommand.ts b/clients/client-neptune/commands/CreateDBInstanceCommand.ts index af1b80c54a72..5c743dd7a9ce 100644 --- a/clients/client-neptune/commands/CreateDBInstanceCommand.ts +++ b/clients/client-neptune/commands/CreateDBInstanceCommand.ts @@ -22,6 +22,20 @@ export interface CreateDBInstanceCommandOutput extends CreateDBInstanceResult, _ /** *

Creates a new DB instance.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { NeptuneClient, CreateDBInstanceCommand } from "@aws-sdk/client-neptune"; // ES Modules import + * // const { NeptuneClient, CreateDBInstanceCommand } = require("@aws-sdk/client-neptune"); // CommonJS import + * const client = new NeptuneClient(config); + * const command = new CreateDBInstanceCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreateDBInstanceCommandInput} for command's `input` shape. + * @see {@link CreateDBInstanceCommandOutput} for command's `response` shape. + * @see {@link NeptuneClientResolvedConfig | config} for command's `input` shape. + * */ export class CreateDBInstanceCommand extends $Command< CreateDBInstanceCommandInput, diff --git a/clients/client-neptune/commands/CreateDBParameterGroupCommand.ts b/clients/client-neptune/commands/CreateDBParameterGroupCommand.ts index 2631ea369390..2febc0e3df3c 100644 --- a/clients/client-neptune/commands/CreateDBParameterGroupCommand.ts +++ b/clients/client-neptune/commands/CreateDBParameterGroupCommand.ts @@ -43,6 +43,20 @@ export interface CreateDBParameterGroupCommandOutput extends CreateDBParameterGr * DescribeDBParameters command to verify that your DB parameter group has * been created or modified.

* + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { NeptuneClient, CreateDBParameterGroupCommand } from "@aws-sdk/client-neptune"; // ES Modules import + * // const { NeptuneClient, CreateDBParameterGroupCommand } = require("@aws-sdk/client-neptune"); // CommonJS import + * const client = new NeptuneClient(config); + * const command = new CreateDBParameterGroupCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreateDBParameterGroupCommandInput} for command's `input` shape. + * @see {@link CreateDBParameterGroupCommandOutput} for command's `response` shape. + * @see {@link NeptuneClientResolvedConfig | config} for command's `input` shape. + * */ export class CreateDBParameterGroupCommand extends $Command< CreateDBParameterGroupCommandInput, diff --git a/clients/client-neptune/commands/CreateDBSubnetGroupCommand.ts b/clients/client-neptune/commands/CreateDBSubnetGroupCommand.ts index 1e3a17acdd2f..851c3ceec4cf 100644 --- a/clients/client-neptune/commands/CreateDBSubnetGroupCommand.ts +++ b/clients/client-neptune/commands/CreateDBSubnetGroupCommand.ts @@ -23,6 +23,20 @@ export interface CreateDBSubnetGroupCommandOutput extends CreateDBSubnetGroupRes /** *

Creates a new DB subnet group. DB subnet groups must contain at least one subnet in at * least two AZs in the AWS Region.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { NeptuneClient, CreateDBSubnetGroupCommand } from "@aws-sdk/client-neptune"; // ES Modules import + * // const { NeptuneClient, CreateDBSubnetGroupCommand } = require("@aws-sdk/client-neptune"); // CommonJS import + * const client = new NeptuneClient(config); + * const command = new CreateDBSubnetGroupCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreateDBSubnetGroupCommandInput} for command's `input` shape. + * @see {@link CreateDBSubnetGroupCommandOutput} for command's `response` shape. + * @see {@link NeptuneClientResolvedConfig | config} for command's `input` shape. + * */ export class CreateDBSubnetGroupCommand extends $Command< CreateDBSubnetGroupCommandInput, diff --git a/clients/client-neptune/commands/CreateEventSubscriptionCommand.ts b/clients/client-neptune/commands/CreateEventSubscriptionCommand.ts index d54256193b89..b419b1514025 100644 --- a/clients/client-neptune/commands/CreateEventSubscriptionCommand.ts +++ b/clients/client-neptune/commands/CreateEventSubscriptionCommand.ts @@ -36,6 +36,20 @@ export interface CreateEventSubscriptionCommandOutput extends CreateEventSubscri * 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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { NeptuneClient, CreateEventSubscriptionCommand } from "@aws-sdk/client-neptune"; // ES Modules import + * // const { NeptuneClient, CreateEventSubscriptionCommand } = require("@aws-sdk/client-neptune"); // CommonJS import + * const client = new NeptuneClient(config); + * const command = new CreateEventSubscriptionCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreateEventSubscriptionCommandInput} for command's `input` shape. + * @see {@link CreateEventSubscriptionCommandOutput} for command's `response` shape. + * @see {@link NeptuneClientResolvedConfig | config} for command's `input` shape. + * */ export class CreateEventSubscriptionCommand extends $Command< CreateEventSubscriptionCommandInput, diff --git a/clients/client-neptune/commands/DeleteDBClusterCommand.ts b/clients/client-neptune/commands/DeleteDBClusterCommand.ts index 924edbeae2a5..1b342899e46e 100644 --- a/clients/client-neptune/commands/DeleteDBClusterCommand.ts +++ b/clients/client-neptune/commands/DeleteDBClusterCommand.ts @@ -28,6 +28,20 @@ export interface DeleteDBClusterCommandOutput extends DeleteDBClusterResult, __M *

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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { NeptuneClient, DeleteDBClusterCommand } from "@aws-sdk/client-neptune"; // ES Modules import + * // const { NeptuneClient, DeleteDBClusterCommand } = require("@aws-sdk/client-neptune"); // CommonJS import + * const client = new NeptuneClient(config); + * const command = new DeleteDBClusterCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteDBClusterCommandInput} for command's `input` shape. + * @see {@link DeleteDBClusterCommandOutput} for command's `response` shape. + * @see {@link NeptuneClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteDBClusterCommand extends $Command< DeleteDBClusterCommandInput, diff --git a/clients/client-neptune/commands/DeleteDBClusterEndpointCommand.ts b/clients/client-neptune/commands/DeleteDBClusterEndpointCommand.ts index 0cb2a05d5f40..16b70576298e 100644 --- a/clients/client-neptune/commands/DeleteDBClusterEndpointCommand.ts +++ b/clients/client-neptune/commands/DeleteDBClusterEndpointCommand.ts @@ -22,6 +22,20 @@ export interface DeleteDBClusterEndpointCommandOutput extends DeleteDBClusterEnd /** *

Deletes a custom endpoint and removes it from an Amazon Neptune DB cluster.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { NeptuneClient, DeleteDBClusterEndpointCommand } from "@aws-sdk/client-neptune"; // ES Modules import + * // const { NeptuneClient, DeleteDBClusterEndpointCommand } = require("@aws-sdk/client-neptune"); // CommonJS import + * const client = new NeptuneClient(config); + * const command = new DeleteDBClusterEndpointCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteDBClusterEndpointCommandInput} for command's `input` shape. + * @see {@link DeleteDBClusterEndpointCommandOutput} for command's `response` shape. + * @see {@link NeptuneClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteDBClusterEndpointCommand extends $Command< DeleteDBClusterEndpointCommandInput, diff --git a/clients/client-neptune/commands/DeleteDBClusterParameterGroupCommand.ts b/clients/client-neptune/commands/DeleteDBClusterParameterGroupCommand.ts index fad40251528b..cd20b0be28ae 100644 --- a/clients/client-neptune/commands/DeleteDBClusterParameterGroupCommand.ts +++ b/clients/client-neptune/commands/DeleteDBClusterParameterGroupCommand.ts @@ -23,6 +23,20 @@ export interface DeleteDBClusterParameterGroupCommandOutput extends __MetadataBe /** *

Deletes a specified DB cluster parameter group. The DB cluster parameter group to be * deleted can't be associated with any DB clusters.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { NeptuneClient, DeleteDBClusterParameterGroupCommand } from "@aws-sdk/client-neptune"; // ES Modules import + * // const { NeptuneClient, DeleteDBClusterParameterGroupCommand } = require("@aws-sdk/client-neptune"); // CommonJS import + * const client = new NeptuneClient(config); + * const command = new DeleteDBClusterParameterGroupCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteDBClusterParameterGroupCommandInput} for command's `input` shape. + * @see {@link DeleteDBClusterParameterGroupCommandOutput} for command's `response` shape. + * @see {@link NeptuneClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteDBClusterParameterGroupCommand extends $Command< DeleteDBClusterParameterGroupCommandInput, diff --git a/clients/client-neptune/commands/DeleteDBClusterSnapshotCommand.ts b/clients/client-neptune/commands/DeleteDBClusterSnapshotCommand.ts index bacbe9a5bbe4..e515914e7e71 100644 --- a/clients/client-neptune/commands/DeleteDBClusterSnapshotCommand.ts +++ b/clients/client-neptune/commands/DeleteDBClusterSnapshotCommand.ts @@ -27,6 +27,20 @@ export interface DeleteDBClusterSnapshotCommandOutput extends DeleteDBClusterSna *

The DB cluster snapshot must be in the available state to be * deleted.

* + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { NeptuneClient, DeleteDBClusterSnapshotCommand } from "@aws-sdk/client-neptune"; // ES Modules import + * // const { NeptuneClient, DeleteDBClusterSnapshotCommand } = require("@aws-sdk/client-neptune"); // CommonJS import + * const client = new NeptuneClient(config); + * const command = new DeleteDBClusterSnapshotCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteDBClusterSnapshotCommandInput} for command's `input` shape. + * @see {@link DeleteDBClusterSnapshotCommandOutput} for command's `response` shape. + * @see {@link NeptuneClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteDBClusterSnapshotCommand extends $Command< DeleteDBClusterSnapshotCommandInput, diff --git a/clients/client-neptune/commands/DeleteDBInstanceCommand.ts b/clients/client-neptune/commands/DeleteDBInstanceCommand.ts index b8d79c780af9..c179135737f1 100644 --- a/clients/client-neptune/commands/DeleteDBInstanceCommand.ts +++ b/clients/client-neptune/commands/DeleteDBInstanceCommand.ts @@ -35,6 +35,20 @@ export interface DeleteDBInstanceCommandOutput extends DeleteDBInstanceResult, _ * 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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { NeptuneClient, DeleteDBInstanceCommand } from "@aws-sdk/client-neptune"; // ES Modules import + * // const { NeptuneClient, DeleteDBInstanceCommand } = require("@aws-sdk/client-neptune"); // CommonJS import + * const client = new NeptuneClient(config); + * const command = new DeleteDBInstanceCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteDBInstanceCommandInput} for command's `input` shape. + * @see {@link DeleteDBInstanceCommandOutput} for command's `response` shape. + * @see {@link NeptuneClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteDBInstanceCommand extends $Command< DeleteDBInstanceCommandInput, diff --git a/clients/client-neptune/commands/DeleteDBParameterGroupCommand.ts b/clients/client-neptune/commands/DeleteDBParameterGroupCommand.ts index ab6e82b8ac78..9b59be1361d0 100644 --- a/clients/client-neptune/commands/DeleteDBParameterGroupCommand.ts +++ b/clients/client-neptune/commands/DeleteDBParameterGroupCommand.ts @@ -23,6 +23,20 @@ export interface DeleteDBParameterGroupCommandOutput extends __MetadataBearer {} /** *

Deletes a specified DBParameterGroup. The DBParameterGroup to be deleted can't be * associated with any DB instances.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { NeptuneClient, DeleteDBParameterGroupCommand } from "@aws-sdk/client-neptune"; // ES Modules import + * // const { NeptuneClient, DeleteDBParameterGroupCommand } = require("@aws-sdk/client-neptune"); // CommonJS import + * const client = new NeptuneClient(config); + * const command = new DeleteDBParameterGroupCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteDBParameterGroupCommandInput} for command's `input` shape. + * @see {@link DeleteDBParameterGroupCommandOutput} for command's `response` shape. + * @see {@link NeptuneClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteDBParameterGroupCommand extends $Command< DeleteDBParameterGroupCommandInput, diff --git a/clients/client-neptune/commands/DeleteDBSubnetGroupCommand.ts b/clients/client-neptune/commands/DeleteDBSubnetGroupCommand.ts index 506ce089201a..bd8afe259c5b 100644 --- a/clients/client-neptune/commands/DeleteDBSubnetGroupCommand.ts +++ b/clients/client-neptune/commands/DeleteDBSubnetGroupCommand.ts @@ -25,6 +25,20 @@ export interface DeleteDBSubnetGroupCommandOutput extends __MetadataBearer {} * *

The specified database subnet group must not be associated with any DB instances.

* + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { NeptuneClient, DeleteDBSubnetGroupCommand } from "@aws-sdk/client-neptune"; // ES Modules import + * // const { NeptuneClient, DeleteDBSubnetGroupCommand } = require("@aws-sdk/client-neptune"); // CommonJS import + * const client = new NeptuneClient(config); + * const command = new DeleteDBSubnetGroupCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteDBSubnetGroupCommandInput} for command's `input` shape. + * @see {@link DeleteDBSubnetGroupCommandOutput} for command's `response` shape. + * @see {@link NeptuneClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteDBSubnetGroupCommand extends $Command< DeleteDBSubnetGroupCommandInput, diff --git a/clients/client-neptune/commands/DeleteEventSubscriptionCommand.ts b/clients/client-neptune/commands/DeleteEventSubscriptionCommand.ts index b8c480f96513..acbcc6881a9d 100644 --- a/clients/client-neptune/commands/DeleteEventSubscriptionCommand.ts +++ b/clients/client-neptune/commands/DeleteEventSubscriptionCommand.ts @@ -22,6 +22,20 @@ export interface DeleteEventSubscriptionCommandOutput extends DeleteEventSubscri /** *

Deletes an event notification subscription.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { NeptuneClient, DeleteEventSubscriptionCommand } from "@aws-sdk/client-neptune"; // ES Modules import + * // const { NeptuneClient, DeleteEventSubscriptionCommand } = require("@aws-sdk/client-neptune"); // CommonJS import + * const client = new NeptuneClient(config); + * const command = new DeleteEventSubscriptionCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteEventSubscriptionCommandInput} for command's `input` shape. + * @see {@link DeleteEventSubscriptionCommandOutput} for command's `response` shape. + * @see {@link NeptuneClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteEventSubscriptionCommand extends $Command< DeleteEventSubscriptionCommandInput, diff --git a/clients/client-neptune/commands/DescribeDBClusterEndpointsCommand.ts b/clients/client-neptune/commands/DescribeDBClusterEndpointsCommand.ts index d1bf69cd482f..24cfdb2dab81 100644 --- a/clients/client-neptune/commands/DescribeDBClusterEndpointsCommand.ts +++ b/clients/client-neptune/commands/DescribeDBClusterEndpointsCommand.ts @@ -26,6 +26,20 @@ export interface DescribeDBClusterEndpointsCommandOutput extends DBClusterEndpoi *

This operation can also return information for Amazon RDS clusters * and Amazon DocDB clusters.

* + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { NeptuneClient, DescribeDBClusterEndpointsCommand } from "@aws-sdk/client-neptune"; // ES Modules import + * // const { NeptuneClient, DescribeDBClusterEndpointsCommand } = require("@aws-sdk/client-neptune"); // CommonJS import + * const client = new NeptuneClient(config); + * const command = new DescribeDBClusterEndpointsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeDBClusterEndpointsCommandInput} for command's `input` shape. + * @see {@link DescribeDBClusterEndpointsCommandOutput} for command's `response` shape. + * @see {@link NeptuneClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeDBClusterEndpointsCommand extends $Command< DescribeDBClusterEndpointsCommandInput, diff --git a/clients/client-neptune/commands/DescribeDBClusterParameterGroupsCommand.ts b/clients/client-neptune/commands/DescribeDBClusterParameterGroupsCommand.ts index 686561708ca7..e6d6ebe06a36 100644 --- a/clients/client-neptune/commands/DescribeDBClusterParameterGroupsCommand.ts +++ b/clients/client-neptune/commands/DescribeDBClusterParameterGroupsCommand.ts @@ -26,6 +26,20 @@ export interface DescribeDBClusterParameterGroupsCommandOutput *

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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { NeptuneClient, DescribeDBClusterParameterGroupsCommand } from "@aws-sdk/client-neptune"; // ES Modules import + * // const { NeptuneClient, DescribeDBClusterParameterGroupsCommand } = require("@aws-sdk/client-neptune"); // CommonJS import + * const client = new NeptuneClient(config); + * const command = new DescribeDBClusterParameterGroupsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeDBClusterParameterGroupsCommandInput} for command's `input` shape. + * @see {@link DescribeDBClusterParameterGroupsCommandOutput} for command's `response` shape. + * @see {@link NeptuneClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeDBClusterParameterGroupsCommand extends $Command< DescribeDBClusterParameterGroupsCommandInput, diff --git a/clients/client-neptune/commands/DescribeDBClusterParametersCommand.ts b/clients/client-neptune/commands/DescribeDBClusterParametersCommand.ts index d99b289bbed7..d2021f5b6686 100644 --- a/clients/client-neptune/commands/DescribeDBClusterParametersCommand.ts +++ b/clients/client-neptune/commands/DescribeDBClusterParametersCommand.ts @@ -22,6 +22,20 @@ export interface DescribeDBClusterParametersCommandOutput extends DBClusterParam /** *

Returns the detailed parameter list for a particular DB cluster parameter group.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { NeptuneClient, DescribeDBClusterParametersCommand } from "@aws-sdk/client-neptune"; // ES Modules import + * // const { NeptuneClient, DescribeDBClusterParametersCommand } = require("@aws-sdk/client-neptune"); // CommonJS import + * const client = new NeptuneClient(config); + * const command = new DescribeDBClusterParametersCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeDBClusterParametersCommandInput} for command's `input` shape. + * @see {@link DescribeDBClusterParametersCommandOutput} for command's `response` shape. + * @see {@link NeptuneClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeDBClusterParametersCommand extends $Command< DescribeDBClusterParametersCommandInput, diff --git a/clients/client-neptune/commands/DescribeDBClusterSnapshotAttributesCommand.ts b/clients/client-neptune/commands/DescribeDBClusterSnapshotAttributesCommand.ts index 599e56662c1d..ff38d7d27ded 100644 --- a/clients/client-neptune/commands/DescribeDBClusterSnapshotAttributesCommand.ts +++ b/clients/client-neptune/commands/DescribeDBClusterSnapshotAttributesCommand.ts @@ -36,6 +36,20 @@ export interface DescribeDBClusterSnapshotAttributesCommandOutput * copied or restored by all AWS accounts.

*

To add or remove access for an AWS 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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { NeptuneClient, DescribeDBClusterSnapshotAttributesCommand } from "@aws-sdk/client-neptune"; // ES Modules import + * // const { NeptuneClient, DescribeDBClusterSnapshotAttributesCommand } = require("@aws-sdk/client-neptune"); // CommonJS import + * const client = new NeptuneClient(config); + * const command = new DescribeDBClusterSnapshotAttributesCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeDBClusterSnapshotAttributesCommandInput} for command's `input` shape. + * @see {@link DescribeDBClusterSnapshotAttributesCommandOutput} for command's `response` shape. + * @see {@link NeptuneClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeDBClusterSnapshotAttributesCommand extends $Command< DescribeDBClusterSnapshotAttributesCommandInput, diff --git a/clients/client-neptune/commands/DescribeDBClusterSnapshotsCommand.ts b/clients/client-neptune/commands/DescribeDBClusterSnapshotsCommand.ts index 55c68623cef1..b3998123705a 100644 --- a/clients/client-neptune/commands/DescribeDBClusterSnapshotsCommand.ts +++ b/clients/client-neptune/commands/DescribeDBClusterSnapshotsCommand.ts @@ -23,6 +23,20 @@ export interface DescribeDBClusterSnapshotsCommandOutput extends DBClusterSnapsh /** *

Returns information about DB cluster snapshots. This API action supports * pagination.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { NeptuneClient, DescribeDBClusterSnapshotsCommand } from "@aws-sdk/client-neptune"; // ES Modules import + * // const { NeptuneClient, DescribeDBClusterSnapshotsCommand } = require("@aws-sdk/client-neptune"); // CommonJS import + * const client = new NeptuneClient(config); + * const command = new DescribeDBClusterSnapshotsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeDBClusterSnapshotsCommandInput} for command's `input` shape. + * @see {@link DescribeDBClusterSnapshotsCommandOutput} for command's `response` shape. + * @see {@link NeptuneClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeDBClusterSnapshotsCommand extends $Command< DescribeDBClusterSnapshotsCommandInput, diff --git a/clients/client-neptune/commands/DescribeDBClustersCommand.ts b/clients/client-neptune/commands/DescribeDBClustersCommand.ts index a7cb14228434..fddfb9d36be5 100644 --- a/clients/client-neptune/commands/DescribeDBClustersCommand.ts +++ b/clients/client-neptune/commands/DescribeDBClustersCommand.ts @@ -28,6 +28,20 @@ export interface DescribeDBClustersCommandOutput extends DBClusterMessage, __Met *

This operation can also return information for Amazon RDS clusters * and Amazon DocDB clusters.

* + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { NeptuneClient, DescribeDBClustersCommand } from "@aws-sdk/client-neptune"; // ES Modules import + * // const { NeptuneClient, DescribeDBClustersCommand } = require("@aws-sdk/client-neptune"); // CommonJS import + * const client = new NeptuneClient(config); + * const command = new DescribeDBClustersCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeDBClustersCommandInput} for command's `input` shape. + * @see {@link DescribeDBClustersCommandOutput} for command's `response` shape. + * @see {@link NeptuneClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeDBClustersCommand extends $Command< DescribeDBClustersCommandInput, diff --git a/clients/client-neptune/commands/DescribeDBEngineVersionsCommand.ts b/clients/client-neptune/commands/DescribeDBEngineVersionsCommand.ts index 4f109d3ffda8..15296279fb7e 100644 --- a/clients/client-neptune/commands/DescribeDBEngineVersionsCommand.ts +++ b/clients/client-neptune/commands/DescribeDBEngineVersionsCommand.ts @@ -22,6 +22,20 @@ export interface DescribeDBEngineVersionsCommandOutput extends DBEngineVersionMe /** *

Returns a list of the available DB engines.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { NeptuneClient, DescribeDBEngineVersionsCommand } from "@aws-sdk/client-neptune"; // ES Modules import + * // const { NeptuneClient, DescribeDBEngineVersionsCommand } = require("@aws-sdk/client-neptune"); // CommonJS import + * const client = new NeptuneClient(config); + * const command = new DescribeDBEngineVersionsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeDBEngineVersionsCommandInput} for command's `input` shape. + * @see {@link DescribeDBEngineVersionsCommandOutput} for command's `response` shape. + * @see {@link NeptuneClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeDBEngineVersionsCommand extends $Command< DescribeDBEngineVersionsCommandInput, diff --git a/clients/client-neptune/commands/DescribeDBInstancesCommand.ts b/clients/client-neptune/commands/DescribeDBInstancesCommand.ts index 6ccb29335533..086bd1a0c688 100644 --- a/clients/client-neptune/commands/DescribeDBInstancesCommand.ts +++ b/clients/client-neptune/commands/DescribeDBInstancesCommand.ts @@ -27,6 +27,20 @@ export interface DescribeDBInstancesCommandOutput extends DBInstanceMessage, __M *

This operation can also return information for Amazon RDS instances * and Amazon DocDB instances.

* + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { NeptuneClient, DescribeDBInstancesCommand } from "@aws-sdk/client-neptune"; // ES Modules import + * // const { NeptuneClient, DescribeDBInstancesCommand } = require("@aws-sdk/client-neptune"); // CommonJS import + * const client = new NeptuneClient(config); + * const command = new DescribeDBInstancesCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeDBInstancesCommandInput} for command's `input` shape. + * @see {@link DescribeDBInstancesCommandOutput} for command's `response` shape. + * @see {@link NeptuneClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeDBInstancesCommand extends $Command< DescribeDBInstancesCommandInput, diff --git a/clients/client-neptune/commands/DescribeDBParameterGroupsCommand.ts b/clients/client-neptune/commands/DescribeDBParameterGroupsCommand.ts index 1b8d3182caba..ccad29cf81fe 100644 --- a/clients/client-neptune/commands/DescribeDBParameterGroupsCommand.ts +++ b/clients/client-neptune/commands/DescribeDBParameterGroupsCommand.ts @@ -24,6 +24,20 @@ export interface DescribeDBParameterGroupsCommandOutput extends DBParameterGroup *

Returns a list of DBParameterGroup descriptions. If a * DBParameterGroupName is specified, the list will contain only the description of * the specified DB parameter group.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { NeptuneClient, DescribeDBParameterGroupsCommand } from "@aws-sdk/client-neptune"; // ES Modules import + * // const { NeptuneClient, DescribeDBParameterGroupsCommand } = require("@aws-sdk/client-neptune"); // CommonJS import + * const client = new NeptuneClient(config); + * const command = new DescribeDBParameterGroupsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeDBParameterGroupsCommandInput} for command's `input` shape. + * @see {@link DescribeDBParameterGroupsCommandOutput} for command's `response` shape. + * @see {@link NeptuneClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeDBParameterGroupsCommand extends $Command< DescribeDBParameterGroupsCommandInput, diff --git a/clients/client-neptune/commands/DescribeDBParametersCommand.ts b/clients/client-neptune/commands/DescribeDBParametersCommand.ts index 2f7e0e6f2a5e..06be502c18f5 100644 --- a/clients/client-neptune/commands/DescribeDBParametersCommand.ts +++ b/clients/client-neptune/commands/DescribeDBParametersCommand.ts @@ -22,6 +22,20 @@ export interface DescribeDBParametersCommandOutput extends DBParameterGroupDetai /** *

Returns the detailed parameter list for a particular DB parameter group.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { NeptuneClient, DescribeDBParametersCommand } from "@aws-sdk/client-neptune"; // ES Modules import + * // const { NeptuneClient, DescribeDBParametersCommand } = require("@aws-sdk/client-neptune"); // CommonJS import + * const client = new NeptuneClient(config); + * const command = new DescribeDBParametersCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeDBParametersCommandInput} for command's `input` shape. + * @see {@link DescribeDBParametersCommandOutput} for command's `response` shape. + * @see {@link NeptuneClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeDBParametersCommand extends $Command< DescribeDBParametersCommandInput, diff --git a/clients/client-neptune/commands/DescribeDBSubnetGroupsCommand.ts b/clients/client-neptune/commands/DescribeDBSubnetGroupsCommand.ts index 6cb846a7842e..3ad06882e6eb 100644 --- a/clients/client-neptune/commands/DescribeDBSubnetGroupsCommand.ts +++ b/clients/client-neptune/commands/DescribeDBSubnetGroupsCommand.ts @@ -24,6 +24,20 @@ export interface DescribeDBSubnetGroupsCommandOutput extends DBSubnetGroupMessag *

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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { NeptuneClient, DescribeDBSubnetGroupsCommand } from "@aws-sdk/client-neptune"; // ES Modules import + * // const { NeptuneClient, DescribeDBSubnetGroupsCommand } = require("@aws-sdk/client-neptune"); // CommonJS import + * const client = new NeptuneClient(config); + * const command = new DescribeDBSubnetGroupsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeDBSubnetGroupsCommandInput} for command's `input` shape. + * @see {@link DescribeDBSubnetGroupsCommandOutput} for command's `response` shape. + * @see {@link NeptuneClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeDBSubnetGroupsCommand extends $Command< DescribeDBSubnetGroupsCommandInput, diff --git a/clients/client-neptune/commands/DescribeEngineDefaultClusterParametersCommand.ts b/clients/client-neptune/commands/DescribeEngineDefaultClusterParametersCommand.ts index 4012beaa8ece..6ef2ae45e76f 100644 --- a/clients/client-neptune/commands/DescribeEngineDefaultClusterParametersCommand.ts +++ b/clients/client-neptune/commands/DescribeEngineDefaultClusterParametersCommand.ts @@ -29,6 +29,20 @@ export interface DescribeEngineDefaultClusterParametersCommandOutput /** *

Returns the default engine and system parameter information for the cluster database * engine.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { NeptuneClient, DescribeEngineDefaultClusterParametersCommand } from "@aws-sdk/client-neptune"; // ES Modules import + * // const { NeptuneClient, DescribeEngineDefaultClusterParametersCommand } = require("@aws-sdk/client-neptune"); // CommonJS import + * const client = new NeptuneClient(config); + * const command = new DescribeEngineDefaultClusterParametersCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeEngineDefaultClusterParametersCommandInput} for command's `input` shape. + * @see {@link DescribeEngineDefaultClusterParametersCommandOutput} for command's `response` shape. + * @see {@link NeptuneClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeEngineDefaultClusterParametersCommand extends $Command< DescribeEngineDefaultClusterParametersCommandInput, diff --git a/clients/client-neptune/commands/DescribeEngineDefaultParametersCommand.ts b/clients/client-neptune/commands/DescribeEngineDefaultParametersCommand.ts index 965ec07904cf..bffb06193206 100644 --- a/clients/client-neptune/commands/DescribeEngineDefaultParametersCommand.ts +++ b/clients/client-neptune/commands/DescribeEngineDefaultParametersCommand.ts @@ -25,6 +25,20 @@ export interface DescribeEngineDefaultParametersCommandOutput /** *

Returns the default engine and system parameter information for the specified database * engine.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { NeptuneClient, DescribeEngineDefaultParametersCommand } from "@aws-sdk/client-neptune"; // ES Modules import + * // const { NeptuneClient, DescribeEngineDefaultParametersCommand } = require("@aws-sdk/client-neptune"); // CommonJS import + * const client = new NeptuneClient(config); + * const command = new DescribeEngineDefaultParametersCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeEngineDefaultParametersCommandInput} for command's `input` shape. + * @see {@link DescribeEngineDefaultParametersCommandOutput} for command's `response` shape. + * @see {@link NeptuneClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeEngineDefaultParametersCommand extends $Command< DescribeEngineDefaultParametersCommandInput, diff --git a/clients/client-neptune/commands/DescribeEventCategoriesCommand.ts b/clients/client-neptune/commands/DescribeEventCategoriesCommand.ts index cbc7ad2e5a48..8f1c8f4b3cb5 100644 --- a/clients/client-neptune/commands/DescribeEventCategoriesCommand.ts +++ b/clients/client-neptune/commands/DescribeEventCategoriesCommand.ts @@ -23,6 +23,20 @@ export interface DescribeEventCategoriesCommandOutput extends EventCategoriesMes /** *

Displays a list of categories for all event source types, or, if specified, for a * specified source type.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { NeptuneClient, DescribeEventCategoriesCommand } from "@aws-sdk/client-neptune"; // ES Modules import + * // const { NeptuneClient, DescribeEventCategoriesCommand } = require("@aws-sdk/client-neptune"); // CommonJS import + * const client = new NeptuneClient(config); + * const command = new DescribeEventCategoriesCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeEventCategoriesCommandInput} for command's `input` shape. + * @see {@link DescribeEventCategoriesCommandOutput} for command's `response` shape. + * @see {@link NeptuneClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeEventCategoriesCommand extends $Command< DescribeEventCategoriesCommandInput, diff --git a/clients/client-neptune/commands/DescribeEventSubscriptionsCommand.ts b/clients/client-neptune/commands/DescribeEventSubscriptionsCommand.ts index ea58ae4a1187..bd8b60c47daa 100644 --- a/clients/client-neptune/commands/DescribeEventSubscriptionsCommand.ts +++ b/clients/client-neptune/commands/DescribeEventSubscriptionsCommand.ts @@ -25,6 +25,20 @@ export interface DescribeEventSubscriptionsCommandOutput extends EventSubscripti * subscription includes SubscriptionName, SNSTopicARN, CustomerID, SourceType, SourceID, * CreationTime, and Status.

*

If you specify a SubscriptionName, lists the description for that subscription.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { NeptuneClient, DescribeEventSubscriptionsCommand } from "@aws-sdk/client-neptune"; // ES Modules import + * // const { NeptuneClient, DescribeEventSubscriptionsCommand } = require("@aws-sdk/client-neptune"); // CommonJS import + * const client = new NeptuneClient(config); + * const command = new DescribeEventSubscriptionsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeEventSubscriptionsCommandInput} for command's `input` shape. + * @see {@link DescribeEventSubscriptionsCommandOutput} for command's `response` shape. + * @see {@link NeptuneClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeEventSubscriptionsCommand extends $Command< DescribeEventSubscriptionsCommandInput, diff --git a/clients/client-neptune/commands/DescribeEventsCommand.ts b/clients/client-neptune/commands/DescribeEventsCommand.ts index 52677e920cc5..84a08a0ce310 100644 --- a/clients/client-neptune/commands/DescribeEventsCommand.ts +++ b/clients/client-neptune/commands/DescribeEventsCommand.ts @@ -25,6 +25,20 @@ export interface DescribeEventsCommandOutput extends EventsMessage, __MetadataBe * 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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { NeptuneClient, DescribeEventsCommand } from "@aws-sdk/client-neptune"; // ES Modules import + * // const { NeptuneClient, DescribeEventsCommand } = require("@aws-sdk/client-neptune"); // CommonJS import + * const client = new NeptuneClient(config); + * const command = new DescribeEventsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeEventsCommandInput} for command's `input` shape. + * @see {@link DescribeEventsCommandOutput} for command's `response` shape. + * @see {@link NeptuneClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeEventsCommand extends $Command< DescribeEventsCommandInput, diff --git a/clients/client-neptune/commands/DescribeOrderableDBInstanceOptionsCommand.ts b/clients/client-neptune/commands/DescribeOrderableDBInstanceOptionsCommand.ts index e948943b7848..93c26f087dd0 100644 --- a/clients/client-neptune/commands/DescribeOrderableDBInstanceOptionsCommand.ts +++ b/clients/client-neptune/commands/DescribeOrderableDBInstanceOptionsCommand.ts @@ -24,6 +24,20 @@ export interface DescribeOrderableDBInstanceOptionsCommandOutput /** *

Returns a list of orderable DB instance options for the specified engine.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { NeptuneClient, DescribeOrderableDBInstanceOptionsCommand } from "@aws-sdk/client-neptune"; // ES Modules import + * // const { NeptuneClient, DescribeOrderableDBInstanceOptionsCommand } = require("@aws-sdk/client-neptune"); // CommonJS import + * const client = new NeptuneClient(config); + * const command = new DescribeOrderableDBInstanceOptionsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeOrderableDBInstanceOptionsCommandInput} for command's `input` shape. + * @see {@link DescribeOrderableDBInstanceOptionsCommandOutput} for command's `response` shape. + * @see {@link NeptuneClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeOrderableDBInstanceOptionsCommand extends $Command< DescribeOrderableDBInstanceOptionsCommandInput, diff --git a/clients/client-neptune/commands/DescribePendingMaintenanceActionsCommand.ts b/clients/client-neptune/commands/DescribePendingMaintenanceActionsCommand.ts index c285491d67f0..de356faaaa50 100644 --- a/clients/client-neptune/commands/DescribePendingMaintenanceActionsCommand.ts +++ b/clients/client-neptune/commands/DescribePendingMaintenanceActionsCommand.ts @@ -25,6 +25,20 @@ export interface DescribePendingMaintenanceActionsCommandOutput /** *

Returns a list of resources (for example, DB instances) that have at least one pending * maintenance action.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { NeptuneClient, DescribePendingMaintenanceActionsCommand } from "@aws-sdk/client-neptune"; // ES Modules import + * // const { NeptuneClient, DescribePendingMaintenanceActionsCommand } = require("@aws-sdk/client-neptune"); // CommonJS import + * const client = new NeptuneClient(config); + * const command = new DescribePendingMaintenanceActionsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribePendingMaintenanceActionsCommandInput} for command's `input` shape. + * @see {@link DescribePendingMaintenanceActionsCommandOutput} for command's `response` shape. + * @see {@link NeptuneClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribePendingMaintenanceActionsCommand extends $Command< DescribePendingMaintenanceActionsCommandInput, diff --git a/clients/client-neptune/commands/DescribeValidDBInstanceModificationsCommand.ts b/clients/client-neptune/commands/DescribeValidDBInstanceModificationsCommand.ts index 6e4ed6dd81fb..e713d088c2d6 100644 --- a/clients/client-neptune/commands/DescribeValidDBInstanceModificationsCommand.ts +++ b/clients/client-neptune/commands/DescribeValidDBInstanceModificationsCommand.ts @@ -29,6 +29,20 @@ export interface DescribeValidDBInstanceModificationsCommandOutput *

You can call DescribeValidDBInstanceModifications * to learn what modifications you can make to your DB instance. You can use this * information when you call ModifyDBInstance.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { NeptuneClient, DescribeValidDBInstanceModificationsCommand } from "@aws-sdk/client-neptune"; // ES Modules import + * // const { NeptuneClient, DescribeValidDBInstanceModificationsCommand } = require("@aws-sdk/client-neptune"); // CommonJS import + * const client = new NeptuneClient(config); + * const command = new DescribeValidDBInstanceModificationsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeValidDBInstanceModificationsCommandInput} for command's `input` shape. + * @see {@link DescribeValidDBInstanceModificationsCommandOutput} for command's `response` shape. + * @see {@link NeptuneClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeValidDBInstanceModificationsCommand extends $Command< DescribeValidDBInstanceModificationsCommandInput, diff --git a/clients/client-neptune/commands/FailoverDBClusterCommand.ts b/clients/client-neptune/commands/FailoverDBClusterCommand.ts index 178128febc3e..ad9594c23325 100644 --- a/clients/client-neptune/commands/FailoverDBClusterCommand.ts +++ b/clients/client-neptune/commands/FailoverDBClusterCommand.ts @@ -29,6 +29,20 @@ export interface FailoverDBClusterCommandOutput extends FailoverDBClusterResult, * 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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { NeptuneClient, FailoverDBClusterCommand } from "@aws-sdk/client-neptune"; // ES Modules import + * // const { NeptuneClient, FailoverDBClusterCommand } = require("@aws-sdk/client-neptune"); // CommonJS import + * const client = new NeptuneClient(config); + * const command = new FailoverDBClusterCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link FailoverDBClusterCommandInput} for command's `input` shape. + * @see {@link FailoverDBClusterCommandOutput} for command's `response` shape. + * @see {@link NeptuneClientResolvedConfig | config} for command's `input` shape. + * */ export class FailoverDBClusterCommand extends $Command< FailoverDBClusterCommandInput, diff --git a/clients/client-neptune/commands/ListTagsForResourceCommand.ts b/clients/client-neptune/commands/ListTagsForResourceCommand.ts index ec2ec4dfc385..540994d69886 100644 --- a/clients/client-neptune/commands/ListTagsForResourceCommand.ts +++ b/clients/client-neptune/commands/ListTagsForResourceCommand.ts @@ -22,6 +22,20 @@ export interface ListTagsForResourceCommandOutput extends TagListMessage, __Meta /** *

Lists all tags on an Amazon Neptune resource.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { NeptuneClient, ListTagsForResourceCommand } from "@aws-sdk/client-neptune"; // ES Modules import + * // const { NeptuneClient, ListTagsForResourceCommand } = require("@aws-sdk/client-neptune"); // CommonJS import + * const client = new NeptuneClient(config); + * const command = new ListTagsForResourceCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListTagsForResourceCommandInput} for command's `input` shape. + * @see {@link ListTagsForResourceCommandOutput} for command's `response` shape. + * @see {@link NeptuneClientResolvedConfig | config} for command's `input` shape. + * */ export class ListTagsForResourceCommand extends $Command< ListTagsForResourceCommandInput, diff --git a/clients/client-neptune/commands/ModifyDBClusterCommand.ts b/clients/client-neptune/commands/ModifyDBClusterCommand.ts index 31a91e1413c2..d6679917369e 100644 --- a/clients/client-neptune/commands/ModifyDBClusterCommand.ts +++ b/clients/client-neptune/commands/ModifyDBClusterCommand.ts @@ -23,6 +23,20 @@ export interface ModifyDBClusterCommandOutput extends ModifyDBClusterResult, __M /** *

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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { NeptuneClient, ModifyDBClusterCommand } from "@aws-sdk/client-neptune"; // ES Modules import + * // const { NeptuneClient, ModifyDBClusterCommand } = require("@aws-sdk/client-neptune"); // CommonJS import + * const client = new NeptuneClient(config); + * const command = new ModifyDBClusterCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ModifyDBClusterCommandInput} for command's `input` shape. + * @see {@link ModifyDBClusterCommandOutput} for command's `response` shape. + * @see {@link NeptuneClientResolvedConfig | config} for command's `input` shape. + * */ export class ModifyDBClusterCommand extends $Command< ModifyDBClusterCommandInput, diff --git a/clients/client-neptune/commands/ModifyDBClusterEndpointCommand.ts b/clients/client-neptune/commands/ModifyDBClusterEndpointCommand.ts index e7c54965abd0..d30150b59552 100644 --- a/clients/client-neptune/commands/ModifyDBClusterEndpointCommand.ts +++ b/clients/client-neptune/commands/ModifyDBClusterEndpointCommand.ts @@ -22,6 +22,20 @@ export interface ModifyDBClusterEndpointCommandOutput extends ModifyDBClusterEnd /** *

Modifies the properties of an endpoint in an Amazon Neptune DB cluster.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { NeptuneClient, ModifyDBClusterEndpointCommand } from "@aws-sdk/client-neptune"; // ES Modules import + * // const { NeptuneClient, ModifyDBClusterEndpointCommand } = require("@aws-sdk/client-neptune"); // CommonJS import + * const client = new NeptuneClient(config); + * const command = new ModifyDBClusterEndpointCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ModifyDBClusterEndpointCommandInput} for command's `input` shape. + * @see {@link ModifyDBClusterEndpointCommandOutput} for command's `response` shape. + * @see {@link NeptuneClientResolvedConfig | config} for command's `input` shape. + * */ export class ModifyDBClusterEndpointCommand extends $Command< ModifyDBClusterEndpointCommandInput, diff --git a/clients/client-neptune/commands/ModifyDBClusterParameterGroupCommand.ts b/clients/client-neptune/commands/ModifyDBClusterParameterGroupCommand.ts index f7f2104c9676..158150640396 100644 --- a/clients/client-neptune/commands/ModifyDBClusterParameterGroupCommand.ts +++ b/clients/client-neptune/commands/ModifyDBClusterParameterGroupCommand.ts @@ -44,6 +44,20 @@ export interface ModifyDBClusterParameterGroupCommandOutput * Groups option of the Amazon Neptune console or the DescribeDBClusterParameters command to verify that your DB cluster parameter * group has been created or modified.

* + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { NeptuneClient, ModifyDBClusterParameterGroupCommand } from "@aws-sdk/client-neptune"; // ES Modules import + * // const { NeptuneClient, ModifyDBClusterParameterGroupCommand } = require("@aws-sdk/client-neptune"); // CommonJS import + * const client = new NeptuneClient(config); + * const command = new ModifyDBClusterParameterGroupCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ModifyDBClusterParameterGroupCommandInput} for command's `input` shape. + * @see {@link ModifyDBClusterParameterGroupCommandOutput} for command's `response` shape. + * @see {@link NeptuneClientResolvedConfig | config} for command's `input` shape. + * */ export class ModifyDBClusterParameterGroupCommand extends $Command< ModifyDBClusterParameterGroupCommandInput, diff --git a/clients/client-neptune/commands/ModifyDBClusterSnapshotAttributeCommand.ts b/clients/client-neptune/commands/ModifyDBClusterSnapshotAttributeCommand.ts index 48e779b1778c..f92524fd0d38 100644 --- a/clients/client-neptune/commands/ModifyDBClusterSnapshotAttributeCommand.ts +++ b/clients/client-neptune/commands/ModifyDBClusterSnapshotAttributeCommand.ts @@ -37,6 +37,20 @@ export interface ModifyDBClusterSnapshotAttributeCommandOutput * parameter in this case.

*

To view which AWS 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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { NeptuneClient, ModifyDBClusterSnapshotAttributeCommand } from "@aws-sdk/client-neptune"; // ES Modules import + * // const { NeptuneClient, ModifyDBClusterSnapshotAttributeCommand } = require("@aws-sdk/client-neptune"); // CommonJS import + * const client = new NeptuneClient(config); + * const command = new ModifyDBClusterSnapshotAttributeCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ModifyDBClusterSnapshotAttributeCommandInput} for command's `input` shape. + * @see {@link ModifyDBClusterSnapshotAttributeCommandOutput} for command's `response` shape. + * @see {@link NeptuneClientResolvedConfig | config} for command's `input` shape. + * */ export class ModifyDBClusterSnapshotAttributeCommand extends $Command< ModifyDBClusterSnapshotAttributeCommandInput, diff --git a/clients/client-neptune/commands/ModifyDBInstanceCommand.ts b/clients/client-neptune/commands/ModifyDBInstanceCommand.ts index 8e9c482e755d..3a3e990bf507 100644 --- a/clients/client-neptune/commands/ModifyDBInstanceCommand.ts +++ b/clients/client-neptune/commands/ModifyDBInstanceCommand.ts @@ -24,6 +24,20 @@ export interface ModifyDBInstanceCommandOutput extends ModifyDBInstanceResult, _ *

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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { NeptuneClient, ModifyDBInstanceCommand } from "@aws-sdk/client-neptune"; // ES Modules import + * // const { NeptuneClient, ModifyDBInstanceCommand } = require("@aws-sdk/client-neptune"); // CommonJS import + * const client = new NeptuneClient(config); + * const command = new ModifyDBInstanceCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ModifyDBInstanceCommandInput} for command's `input` shape. + * @see {@link ModifyDBInstanceCommandOutput} for command's `response` shape. + * @see {@link NeptuneClientResolvedConfig | config} for command's `input` shape. + * */ export class ModifyDBInstanceCommand extends $Command< ModifyDBInstanceCommandInput, diff --git a/clients/client-neptune/commands/ModifyDBParameterGroupCommand.ts b/clients/client-neptune/commands/ModifyDBParameterGroupCommand.ts index 969814212ea5..6378924c5fd8 100644 --- a/clients/client-neptune/commands/ModifyDBParameterGroupCommand.ts +++ b/clients/client-neptune/commands/ModifyDBParameterGroupCommand.ts @@ -41,6 +41,20 @@ export interface ModifyDBParameterGroupCommandOutput extends DBParameterGroupNam * DescribeDBParameters command to verify that your DB parameter group has * been created or modified.

* + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { NeptuneClient, ModifyDBParameterGroupCommand } from "@aws-sdk/client-neptune"; // ES Modules import + * // const { NeptuneClient, ModifyDBParameterGroupCommand } = require("@aws-sdk/client-neptune"); // CommonJS import + * const client = new NeptuneClient(config); + * const command = new ModifyDBParameterGroupCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ModifyDBParameterGroupCommandInput} for command's `input` shape. + * @see {@link ModifyDBParameterGroupCommandOutput} for command's `response` shape. + * @see {@link NeptuneClientResolvedConfig | config} for command's `input` shape. + * */ export class ModifyDBParameterGroupCommand extends $Command< ModifyDBParameterGroupCommandInput, diff --git a/clients/client-neptune/commands/ModifyDBSubnetGroupCommand.ts b/clients/client-neptune/commands/ModifyDBSubnetGroupCommand.ts index 15ba032464bc..ca8159dcb184 100644 --- a/clients/client-neptune/commands/ModifyDBSubnetGroupCommand.ts +++ b/clients/client-neptune/commands/ModifyDBSubnetGroupCommand.ts @@ -23,6 +23,20 @@ export interface ModifyDBSubnetGroupCommandOutput extends ModifyDBSubnetGroupRes /** *

Modifies an existing DB subnet group. DB subnet groups must contain at least one subnet in * at least two AZs in the AWS Region.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { NeptuneClient, ModifyDBSubnetGroupCommand } from "@aws-sdk/client-neptune"; // ES Modules import + * // const { NeptuneClient, ModifyDBSubnetGroupCommand } = require("@aws-sdk/client-neptune"); // CommonJS import + * const client = new NeptuneClient(config); + * const command = new ModifyDBSubnetGroupCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ModifyDBSubnetGroupCommandInput} for command's `input` shape. + * @see {@link ModifyDBSubnetGroupCommandOutput} for command's `response` shape. + * @see {@link NeptuneClientResolvedConfig | config} for command's `input` shape. + * */ export class ModifyDBSubnetGroupCommand extends $Command< ModifyDBSubnetGroupCommandInput, diff --git a/clients/client-neptune/commands/ModifyEventSubscriptionCommand.ts b/clients/client-neptune/commands/ModifyEventSubscriptionCommand.ts index 43e7e0b1e0a5..6cd5fe4c5efd 100644 --- a/clients/client-neptune/commands/ModifyEventSubscriptionCommand.ts +++ b/clients/client-neptune/commands/ModifyEventSubscriptionCommand.ts @@ -26,6 +26,20 @@ export interface ModifyEventSubscriptionCommandOutput extends ModifyEventSubscri * AddSourceIdentifierToSubscription and RemoveSourceIdentifierFromSubscription calls.

*

You can see a list of the event categories for a given SourceType * by using the DescribeEventCategories action.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { NeptuneClient, ModifyEventSubscriptionCommand } from "@aws-sdk/client-neptune"; // ES Modules import + * // const { NeptuneClient, ModifyEventSubscriptionCommand } = require("@aws-sdk/client-neptune"); // CommonJS import + * const client = new NeptuneClient(config); + * const command = new ModifyEventSubscriptionCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ModifyEventSubscriptionCommandInput} for command's `input` shape. + * @see {@link ModifyEventSubscriptionCommandOutput} for command's `response` shape. + * @see {@link NeptuneClientResolvedConfig | config} for command's `input` shape. + * */ export class ModifyEventSubscriptionCommand extends $Command< ModifyEventSubscriptionCommandInput, diff --git a/clients/client-neptune/commands/PromoteReadReplicaDBClusterCommand.ts b/clients/client-neptune/commands/PromoteReadReplicaDBClusterCommand.ts index f6abd4bd3c90..cbface40f1ed 100644 --- a/clients/client-neptune/commands/PromoteReadReplicaDBClusterCommand.ts +++ b/clients/client-neptune/commands/PromoteReadReplicaDBClusterCommand.ts @@ -22,6 +22,20 @@ export interface PromoteReadReplicaDBClusterCommandOutput extends PromoteReadRep /** *

Not supported.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { NeptuneClient, PromoteReadReplicaDBClusterCommand } from "@aws-sdk/client-neptune"; // ES Modules import + * // const { NeptuneClient, PromoteReadReplicaDBClusterCommand } = require("@aws-sdk/client-neptune"); // CommonJS import + * const client = new NeptuneClient(config); + * const command = new PromoteReadReplicaDBClusterCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link PromoteReadReplicaDBClusterCommandInput} for command's `input` shape. + * @see {@link PromoteReadReplicaDBClusterCommandOutput} for command's `response` shape. + * @see {@link NeptuneClientResolvedConfig | config} for command's `input` shape. + * */ export class PromoteReadReplicaDBClusterCommand extends $Command< PromoteReadReplicaDBClusterCommandInput, diff --git a/clients/client-neptune/commands/RebootDBInstanceCommand.ts b/clients/client-neptune/commands/RebootDBInstanceCommand.ts index 496eb2217861..1e699f738259 100644 --- a/clients/client-neptune/commands/RebootDBInstanceCommand.ts +++ b/clients/client-neptune/commands/RebootDBInstanceCommand.ts @@ -26,6 +26,20 @@ export interface RebootDBInstanceCommandOutput extends RebootDBInstanceResult, _ * 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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { NeptuneClient, RebootDBInstanceCommand } from "@aws-sdk/client-neptune"; // ES Modules import + * // const { NeptuneClient, RebootDBInstanceCommand } = require("@aws-sdk/client-neptune"); // CommonJS import + * const client = new NeptuneClient(config); + * const command = new RebootDBInstanceCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link RebootDBInstanceCommandInput} for command's `input` shape. + * @see {@link RebootDBInstanceCommandOutput} for command's `response` shape. + * @see {@link NeptuneClientResolvedConfig | config} for command's `input` shape. + * */ export class RebootDBInstanceCommand extends $Command< RebootDBInstanceCommandInput, diff --git a/clients/client-neptune/commands/RemoveRoleFromDBClusterCommand.ts b/clients/client-neptune/commands/RemoveRoleFromDBClusterCommand.ts index 3d45c4c1a7c8..331e1c2cb747 100644 --- a/clients/client-neptune/commands/RemoveRoleFromDBClusterCommand.ts +++ b/clients/client-neptune/commands/RemoveRoleFromDBClusterCommand.ts @@ -22,6 +22,20 @@ export interface RemoveRoleFromDBClusterCommandOutput extends __MetadataBearer { /** *

Disassociates an Identity and Access Management (IAM) role from a DB cluster.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { NeptuneClient, RemoveRoleFromDBClusterCommand } from "@aws-sdk/client-neptune"; // ES Modules import + * // const { NeptuneClient, RemoveRoleFromDBClusterCommand } = require("@aws-sdk/client-neptune"); // CommonJS import + * const client = new NeptuneClient(config); + * const command = new RemoveRoleFromDBClusterCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link RemoveRoleFromDBClusterCommandInput} for command's `input` shape. + * @see {@link RemoveRoleFromDBClusterCommandOutput} for command's `response` shape. + * @see {@link NeptuneClientResolvedConfig | config} for command's `input` shape. + * */ export class RemoveRoleFromDBClusterCommand extends $Command< RemoveRoleFromDBClusterCommandInput, diff --git a/clients/client-neptune/commands/RemoveSourceIdentifierFromSubscriptionCommand.ts b/clients/client-neptune/commands/RemoveSourceIdentifierFromSubscriptionCommand.ts index b0c5c1637ced..67408ae703ce 100644 --- a/clients/client-neptune/commands/RemoveSourceIdentifierFromSubscriptionCommand.ts +++ b/clients/client-neptune/commands/RemoveSourceIdentifierFromSubscriptionCommand.ts @@ -28,6 +28,20 @@ export interface RemoveSourceIdentifierFromSubscriptionCommandOutput /** *

Removes a source identifier from an existing event notification subscription.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { NeptuneClient, RemoveSourceIdentifierFromSubscriptionCommand } from "@aws-sdk/client-neptune"; // ES Modules import + * // const { NeptuneClient, RemoveSourceIdentifierFromSubscriptionCommand } = require("@aws-sdk/client-neptune"); // CommonJS import + * const client = new NeptuneClient(config); + * const command = new RemoveSourceIdentifierFromSubscriptionCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link RemoveSourceIdentifierFromSubscriptionCommandInput} for command's `input` shape. + * @see {@link RemoveSourceIdentifierFromSubscriptionCommandOutput} for command's `response` shape. + * @see {@link NeptuneClientResolvedConfig | config} for command's `input` shape. + * */ export class RemoveSourceIdentifierFromSubscriptionCommand extends $Command< RemoveSourceIdentifierFromSubscriptionCommandInput, diff --git a/clients/client-neptune/commands/RemoveTagsFromResourceCommand.ts b/clients/client-neptune/commands/RemoveTagsFromResourceCommand.ts index 5b530b705f21..8b8953d5c246 100644 --- a/clients/client-neptune/commands/RemoveTagsFromResourceCommand.ts +++ b/clients/client-neptune/commands/RemoveTagsFromResourceCommand.ts @@ -22,6 +22,20 @@ export interface RemoveTagsFromResourceCommandOutput extends __MetadataBearer {} /** *

Removes metadata tags from an Amazon Neptune resource.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { NeptuneClient, RemoveTagsFromResourceCommand } from "@aws-sdk/client-neptune"; // ES Modules import + * // const { NeptuneClient, RemoveTagsFromResourceCommand } = require("@aws-sdk/client-neptune"); // CommonJS import + * const client = new NeptuneClient(config); + * const command = new RemoveTagsFromResourceCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link RemoveTagsFromResourceCommandInput} for command's `input` shape. + * @see {@link RemoveTagsFromResourceCommandOutput} for command's `response` shape. + * @see {@link NeptuneClientResolvedConfig | config} for command's `input` shape. + * */ export class RemoveTagsFromResourceCommand extends $Command< RemoveTagsFromResourceCommandInput, diff --git a/clients/client-neptune/commands/ResetDBClusterParameterGroupCommand.ts b/clients/client-neptune/commands/ResetDBClusterParameterGroupCommand.ts index caaea1c7e563..789f0a023002 100644 --- a/clients/client-neptune/commands/ResetDBClusterParameterGroupCommand.ts +++ b/clients/client-neptune/commands/ResetDBClusterParameterGroupCommand.ts @@ -31,6 +31,20 @@ export interface ResetDBClusterParameterGroupCommandOutput * 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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { NeptuneClient, ResetDBClusterParameterGroupCommand } from "@aws-sdk/client-neptune"; // ES Modules import + * // const { NeptuneClient, ResetDBClusterParameterGroupCommand } = require("@aws-sdk/client-neptune"); // CommonJS import + * const client = new NeptuneClient(config); + * const command = new ResetDBClusterParameterGroupCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ResetDBClusterParameterGroupCommandInput} for command's `input` shape. + * @see {@link ResetDBClusterParameterGroupCommandOutput} for command's `response` shape. + * @see {@link NeptuneClientResolvedConfig | config} for command's `input` shape. + * */ export class ResetDBClusterParameterGroupCommand extends $Command< ResetDBClusterParameterGroupCommandInput, diff --git a/clients/client-neptune/commands/ResetDBParameterGroupCommand.ts b/clients/client-neptune/commands/ResetDBParameterGroupCommand.ts index 56600d88f3a3..1cd128ec00b0 100644 --- a/clients/client-neptune/commands/ResetDBParameterGroupCommand.ts +++ b/clients/client-neptune/commands/ResetDBParameterGroupCommand.ts @@ -28,6 +28,20 @@ export interface ResetDBParameterGroupCommandOutput extends DBParameterGroupName * 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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { NeptuneClient, ResetDBParameterGroupCommand } from "@aws-sdk/client-neptune"; // ES Modules import + * // const { NeptuneClient, ResetDBParameterGroupCommand } = require("@aws-sdk/client-neptune"); // CommonJS import + * const client = new NeptuneClient(config); + * const command = new ResetDBParameterGroupCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ResetDBParameterGroupCommandInput} for command's `input` shape. + * @see {@link ResetDBParameterGroupCommandOutput} for command's `response` shape. + * @see {@link NeptuneClientResolvedConfig | config} for command's `input` shape. + * */ export class ResetDBParameterGroupCommand extends $Command< ResetDBParameterGroupCommandInput, diff --git a/clients/client-neptune/commands/RestoreDBClusterFromSnapshotCommand.ts b/clients/client-neptune/commands/RestoreDBClusterFromSnapshotCommand.ts index b25445d4cd42..bdb9b317a521 100644 --- a/clients/client-neptune/commands/RestoreDBClusterFromSnapshotCommand.ts +++ b/clients/client-neptune/commands/RestoreDBClusterFromSnapshotCommand.ts @@ -29,6 +29,20 @@ export interface RestoreDBClusterFromSnapshotCommandOutput *

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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { NeptuneClient, RestoreDBClusterFromSnapshotCommand } from "@aws-sdk/client-neptune"; // ES Modules import + * // const { NeptuneClient, RestoreDBClusterFromSnapshotCommand } = require("@aws-sdk/client-neptune"); // CommonJS import + * const client = new NeptuneClient(config); + * const command = new RestoreDBClusterFromSnapshotCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link RestoreDBClusterFromSnapshotCommandInput} for command's `input` shape. + * @see {@link RestoreDBClusterFromSnapshotCommandOutput} for command's `response` shape. + * @see {@link NeptuneClientResolvedConfig | config} for command's `input` shape. + * */ export class RestoreDBClusterFromSnapshotCommand extends $Command< RestoreDBClusterFromSnapshotCommandInput, diff --git a/clients/client-neptune/commands/RestoreDBClusterToPointInTimeCommand.ts b/clients/client-neptune/commands/RestoreDBClusterToPointInTimeCommand.ts index a7ecd22a2135..4604ec0d7457 100644 --- a/clients/client-neptune/commands/RestoreDBClusterToPointInTimeCommand.ts +++ b/clients/client-neptune/commands/RestoreDBClusterToPointInTimeCommand.ts @@ -36,6 +36,20 @@ export interface RestoreDBClusterToPointInTimeCommandOutput * RestoreDBClusterToPointInTime action has completed and the DB cluster is * available.

* + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { NeptuneClient, RestoreDBClusterToPointInTimeCommand } from "@aws-sdk/client-neptune"; // ES Modules import + * // const { NeptuneClient, RestoreDBClusterToPointInTimeCommand } = require("@aws-sdk/client-neptune"); // CommonJS import + * const client = new NeptuneClient(config); + * const command = new RestoreDBClusterToPointInTimeCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link RestoreDBClusterToPointInTimeCommandInput} for command's `input` shape. + * @see {@link RestoreDBClusterToPointInTimeCommandOutput} for command's `response` shape. + * @see {@link NeptuneClientResolvedConfig | config} for command's `input` shape. + * */ export class RestoreDBClusterToPointInTimeCommand extends $Command< RestoreDBClusterToPointInTimeCommandInput, diff --git a/clients/client-neptune/commands/StartDBClusterCommand.ts b/clients/client-neptune/commands/StartDBClusterCommand.ts index cef40ef14661..985dce647647 100644 --- a/clients/client-neptune/commands/StartDBClusterCommand.ts +++ b/clients/client-neptune/commands/StartDBClusterCommand.ts @@ -23,6 +23,20 @@ export interface StartDBClusterCommandOutput extends StartDBClusterResult, __Met /** *

Starts an Amazon Neptune DB cluster that was stopped using the AWS * console, the AWS CLI stop-db-cluster command, or the StopDBCluster API.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { NeptuneClient, StartDBClusterCommand } from "@aws-sdk/client-neptune"; // ES Modules import + * // const { NeptuneClient, StartDBClusterCommand } = require("@aws-sdk/client-neptune"); // CommonJS import + * const client = new NeptuneClient(config); + * const command = new StartDBClusterCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link StartDBClusterCommandInput} for command's `input` shape. + * @see {@link StartDBClusterCommandOutput} for command's `response` shape. + * @see {@link NeptuneClientResolvedConfig | config} for command's `input` shape. + * */ export class StartDBClusterCommand extends $Command< StartDBClusterCommandInput, diff --git a/clients/client-neptune/commands/StopDBClusterCommand.ts b/clients/client-neptune/commands/StopDBClusterCommand.ts index b8e246e055b1..87986b6ab420 100644 --- a/clients/client-neptune/commands/StopDBClusterCommand.ts +++ b/clients/client-neptune/commands/StopDBClusterCommand.ts @@ -27,6 +27,20 @@ export interface StopDBClusterCommandOutput extends StopDBClusterResult, __Metad * *

Neptune also retains the transaction logs so you can do a point-in-time * restore if necessary.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { NeptuneClient, StopDBClusterCommand } from "@aws-sdk/client-neptune"; // ES Modules import + * // const { NeptuneClient, StopDBClusterCommand } = require("@aws-sdk/client-neptune"); // CommonJS import + * const client = new NeptuneClient(config); + * const command = new StopDBClusterCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link StopDBClusterCommandInput} for command's `input` shape. + * @see {@link StopDBClusterCommandOutput} for command's `response` shape. + * @see {@link NeptuneClientResolvedConfig | config} for command's `input` shape. + * */ export class StopDBClusterCommand extends $Command< StopDBClusterCommandInput, diff --git a/clients/client-neptune/models/models_0.ts b/clients/client-neptune/models/models_0.ts index 96476c4f3866..014f27c7da5f 100644 --- a/clients/client-neptune/models/models_0.ts +++ b/clients/client-neptune/models/models_0.ts @@ -21,6 +21,9 @@ export interface AddRoleToDBClusterMessage { } export namespace AddRoleToDBClusterMessage { + /** + * @internal + */ export const filterSensitiveLog = (obj: AddRoleToDBClusterMessage): any => ({ ...obj, }); @@ -40,6 +43,9 @@ export interface DBClusterNotFoundFault extends __SmithyException, $MetadataBear } export namespace DBClusterNotFoundFault { + /** + * @internal + */ export const filterSensitiveLog = (obj: DBClusterNotFoundFault): any => ({ ...obj, }); @@ -58,6 +64,9 @@ export interface DBClusterRoleAlreadyExistsFault extends __SmithyException, $Met } export namespace DBClusterRoleAlreadyExistsFault { + /** + * @internal + */ export const filterSensitiveLog = (obj: DBClusterRoleAlreadyExistsFault): any => ({ ...obj, }); @@ -76,6 +85,9 @@ export interface DBClusterRoleQuotaExceededFault extends __SmithyException, $Met } export namespace DBClusterRoleQuotaExceededFault { + /** + * @internal + */ export const filterSensitiveLog = (obj: DBClusterRoleQuotaExceededFault): any => ({ ...obj, }); @@ -94,6 +106,9 @@ export interface InvalidDBClusterStateFault extends __SmithyException, $Metadata } export namespace InvalidDBClusterStateFault { + /** + * @internal + */ export const filterSensitiveLog = (obj: InvalidDBClusterStateFault): any => ({ ...obj, }); @@ -132,6 +147,9 @@ export interface AddSourceIdentifierToSubscriptionMessage { } export namespace AddSourceIdentifierToSubscriptionMessage { + /** + * @internal + */ export const filterSensitiveLog = (obj: AddSourceIdentifierToSubscriptionMessage): any => ({ ...obj, }); @@ -200,6 +218,9 @@ export interface EventSubscription { } export namespace EventSubscription { + /** + * @internal + */ export const filterSensitiveLog = (obj: EventSubscription): any => ({ ...obj, }); @@ -213,6 +234,9 @@ export interface AddSourceIdentifierToSubscriptionResult { } export namespace AddSourceIdentifierToSubscriptionResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: AddSourceIdentifierToSubscriptionResult): any => ({ ...obj, }); @@ -231,6 +255,9 @@ export interface SourceNotFoundFault extends __SmithyException, $MetadataBearer } export namespace SourceNotFoundFault { + /** + * @internal + */ export const filterSensitiveLog = (obj: SourceNotFoundFault): any => ({ ...obj, }); @@ -249,6 +276,9 @@ export interface SubscriptionNotFoundFault extends __SmithyException, $MetadataB } export namespace SubscriptionNotFoundFault { + /** + * @internal + */ export const filterSensitiveLog = (obj: SubscriptionNotFoundFault): any => ({ ...obj, }); @@ -276,6 +306,9 @@ export interface Tag { } export namespace Tag { + /** + * @internal + */ export const filterSensitiveLog = (obj: Tag): any => ({ ...obj, }); @@ -296,6 +329,9 @@ export interface AddTagsToResourceMessage { } export namespace AddTagsToResourceMessage { + /** + * @internal + */ export const filterSensitiveLog = (obj: AddTagsToResourceMessage): any => ({ ...obj, }); @@ -315,6 +351,9 @@ export interface DBInstanceNotFoundFault extends __SmithyException, $MetadataBea } export namespace DBInstanceNotFoundFault { + /** + * @internal + */ export const filterSensitiveLog = (obj: DBInstanceNotFoundFault): any => ({ ...obj, }); @@ -334,6 +373,9 @@ export interface DBSnapshotNotFoundFault extends __SmithyException, $MetadataBea } export namespace DBSnapshotNotFoundFault { + /** + * @internal + */ export const filterSensitiveLog = (obj: DBSnapshotNotFoundFault): any => ({ ...obj, }); @@ -379,6 +421,9 @@ export interface ApplyPendingMaintenanceActionMessage { } export namespace ApplyPendingMaintenanceActionMessage { + /** + * @internal + */ export const filterSensitiveLog = (obj: ApplyPendingMaintenanceActionMessage): any => ({ ...obj, }); @@ -428,6 +473,9 @@ export interface PendingMaintenanceAction { } export namespace PendingMaintenanceAction { + /** + * @internal + */ export const filterSensitiveLog = (obj: PendingMaintenanceAction): any => ({ ...obj, }); @@ -450,6 +498,9 @@ export interface ResourcePendingMaintenanceActions { } export namespace ResourcePendingMaintenanceActions { + /** + * @internal + */ export const filterSensitiveLog = (obj: ResourcePendingMaintenanceActions): any => ({ ...obj, }); @@ -463,6 +514,9 @@ export interface ApplyPendingMaintenanceActionResult { } export namespace ApplyPendingMaintenanceActionResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: ApplyPendingMaintenanceActionResult): any => ({ ...obj, }); @@ -481,6 +535,9 @@ export interface ResourceNotFoundFault extends __SmithyException, $MetadataBeare } export namespace ResourceNotFoundFault { + /** + * @internal + */ export const filterSensitiveLog = (obj: ResourceNotFoundFault): any => ({ ...obj, }); @@ -544,6 +601,9 @@ export interface CopyDBClusterParameterGroupMessage { } export namespace CopyDBClusterParameterGroupMessage { + /** + * @internal + */ export const filterSensitiveLog = (obj: CopyDBClusterParameterGroupMessage): any => ({ ...obj, }); @@ -577,6 +637,9 @@ export interface DBClusterParameterGroup { } export namespace DBClusterParameterGroup { + /** + * @internal + */ export const filterSensitiveLog = (obj: DBClusterParameterGroup): any => ({ ...obj, }); @@ -591,6 +654,9 @@ export interface CopyDBClusterParameterGroupResult { } export namespace CopyDBClusterParameterGroupResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: CopyDBClusterParameterGroupResult): any => ({ ...obj, }); @@ -609,6 +675,9 @@ export interface DBParameterGroupAlreadyExistsFault extends __SmithyException, $ } export namespace DBParameterGroupAlreadyExistsFault { + /** + * @internal + */ export const filterSensitiveLog = (obj: DBParameterGroupAlreadyExistsFault): any => ({ ...obj, }); @@ -629,6 +698,9 @@ export interface DBParameterGroupNotFoundFault extends __SmithyException, $Metad } export namespace DBParameterGroupNotFoundFault { + /** + * @internal + */ export const filterSensitiveLog = (obj: DBParameterGroupNotFoundFault): any => ({ ...obj, }); @@ -647,6 +719,9 @@ export interface DBParameterGroupQuotaExceededFault extends __SmithyException, $ } export namespace DBParameterGroupQuotaExceededFault { + /** + * @internal + */ export const filterSensitiveLog = (obj: DBParameterGroupQuotaExceededFault): any => ({ ...obj, }); @@ -729,6 +804,9 @@ export interface CopyDBClusterSnapshotMessage { } export namespace CopyDBClusterSnapshotMessage { + /** + * @internal + */ export const filterSensitiveLog = (obj: CopyDBClusterSnapshotMessage): any => ({ ...obj, }); @@ -861,6 +939,9 @@ export interface DBClusterSnapshot { } export namespace DBClusterSnapshot { + /** + * @internal + */ export const filterSensitiveLog = (obj: DBClusterSnapshot): any => ({ ...obj, }); @@ -875,6 +956,9 @@ export interface CopyDBClusterSnapshotResult { } export namespace CopyDBClusterSnapshotResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: CopyDBClusterSnapshotResult): any => ({ ...obj, }); @@ -893,6 +977,9 @@ export interface DBClusterSnapshotAlreadyExistsFault extends __SmithyException, } export namespace DBClusterSnapshotAlreadyExistsFault { + /** + * @internal + */ export const filterSensitiveLog = (obj: DBClusterSnapshotAlreadyExistsFault): any => ({ ...obj, }); @@ -913,6 +1000,9 @@ export interface DBClusterSnapshotNotFoundFault extends __SmithyException, $Meta } export namespace DBClusterSnapshotNotFoundFault { + /** + * @internal + */ export const filterSensitiveLog = (obj: DBClusterSnapshotNotFoundFault): any => ({ ...obj, }); @@ -931,6 +1021,9 @@ export interface InvalidDBClusterSnapshotStateFault extends __SmithyException, $ } export namespace InvalidDBClusterSnapshotStateFault { + /** + * @internal + */ export const filterSensitiveLog = (obj: InvalidDBClusterSnapshotStateFault): any => ({ ...obj, }); @@ -949,6 +1042,9 @@ export interface KMSKeyNotAccessibleFault extends __SmithyException, $MetadataBe } export namespace KMSKeyNotAccessibleFault { + /** + * @internal + */ export const filterSensitiveLog = (obj: KMSKeyNotAccessibleFault): any => ({ ...obj, }); @@ -967,6 +1063,9 @@ export interface SnapshotQuotaExceededFault extends __SmithyException, $Metadata } export namespace SnapshotQuotaExceededFault { + /** + * @internal + */ export const filterSensitiveLog = (obj: SnapshotQuotaExceededFault): any => ({ ...obj, }); @@ -1027,6 +1126,9 @@ export interface CopyDBParameterGroupMessage { } export namespace CopyDBParameterGroupMessage { + /** + * @internal + */ export const filterSensitiveLog = (obj: CopyDBParameterGroupMessage): any => ({ ...obj, }); @@ -1060,6 +1162,9 @@ export interface DBParameterGroup { } export namespace DBParameterGroup { + /** + * @internal + */ export const filterSensitiveLog = (obj: DBParameterGroup): any => ({ ...obj, }); @@ -1074,6 +1179,9 @@ export interface CopyDBParameterGroupResult { } export namespace CopyDBParameterGroupResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: CopyDBParameterGroupResult): any => ({ ...obj, }); @@ -1315,6 +1423,9 @@ export interface CreateDBClusterMessage { } export namespace CreateDBClusterMessage { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateDBClusterMessage): any => ({ ...obj, }); @@ -1364,6 +1475,9 @@ export interface DBClusterRole { } export namespace DBClusterRole { + /** + * @internal + */ export const filterSensitiveLog = (obj: DBClusterRole): any => ({ ...obj, }); @@ -1398,6 +1512,9 @@ export interface DBClusterMember { } export namespace DBClusterMember { + /** + * @internal + */ export const filterSensitiveLog = (obj: DBClusterMember): any => ({ ...obj, }); @@ -1419,6 +1536,9 @@ export interface DBClusterOptionGroupStatus { } export namespace DBClusterOptionGroupStatus { + /** + * @internal + */ export const filterSensitiveLog = (obj: DBClusterOptionGroupStatus): any => ({ ...obj, }); @@ -1441,6 +1561,9 @@ export interface VpcSecurityGroupMembership { } export namespace VpcSecurityGroupMembership { + /** + * @internal + */ export const filterSensitiveLog = (obj: VpcSecurityGroupMembership): any => ({ ...obj, }); @@ -1668,6 +1791,9 @@ export interface DBCluster { } export namespace DBCluster { + /** + * @internal + */ export const filterSensitiveLog = (obj: DBCluster): any => ({ ...obj, }); @@ -1682,6 +1808,9 @@ export interface CreateDBClusterResult { } export namespace CreateDBClusterResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateDBClusterResult): any => ({ ...obj, }); @@ -1700,6 +1829,9 @@ export interface DBClusterAlreadyExistsFault extends __SmithyException, $Metadat } export namespace DBClusterAlreadyExistsFault { + /** + * @internal + */ export const filterSensitiveLog = (obj: DBClusterAlreadyExistsFault): any => ({ ...obj, }); @@ -1720,6 +1852,9 @@ export interface DBClusterParameterGroupNotFoundFault extends __SmithyException, } export namespace DBClusterParameterGroupNotFoundFault { + /** + * @internal + */ export const filterSensitiveLog = (obj: DBClusterParameterGroupNotFoundFault): any => ({ ...obj, }); @@ -1738,6 +1873,9 @@ export interface DBClusterQuotaExceededFault extends __SmithyException, $Metadat } export namespace DBClusterQuotaExceededFault { + /** + * @internal + */ export const filterSensitiveLog = (obj: DBClusterQuotaExceededFault): any => ({ ...obj, }); @@ -1757,6 +1895,9 @@ export interface DBSubnetGroupDoesNotCoverEnoughAZs extends __SmithyException, $ } export namespace DBSubnetGroupDoesNotCoverEnoughAZs { + /** + * @internal + */ export const filterSensitiveLog = (obj: DBSubnetGroupDoesNotCoverEnoughAZs): any => ({ ...obj, }); @@ -1777,6 +1918,9 @@ export interface DBSubnetGroupNotFoundFault extends __SmithyException, $Metadata } export namespace DBSubnetGroupNotFoundFault { + /** + * @internal + */ export const filterSensitiveLog = (obj: DBSubnetGroupNotFoundFault): any => ({ ...obj, }); @@ -1797,6 +1941,9 @@ export interface InsufficientStorageClusterCapacityFault extends __SmithyExcepti } export namespace InsufficientStorageClusterCapacityFault { + /** + * @internal + */ export const filterSensitiveLog = (obj: InsufficientStorageClusterCapacityFault): any => ({ ...obj, }); @@ -1815,6 +1962,9 @@ export interface InvalidDBInstanceStateFault extends __SmithyException, $Metadat } export namespace InvalidDBInstanceStateFault { + /** + * @internal + */ export const filterSensitiveLog = (obj: InvalidDBInstanceStateFault): any => ({ ...obj, }); @@ -1833,6 +1983,9 @@ export interface InvalidDBSubnetGroupStateFault extends __SmithyException, $Meta } export namespace InvalidDBSubnetGroupStateFault { + /** + * @internal + */ export const filterSensitiveLog = (obj: InvalidDBSubnetGroupStateFault): any => ({ ...obj, }); @@ -1852,6 +2005,9 @@ export interface InvalidSubnet extends __SmithyException, $MetadataBearer { } export namespace InvalidSubnet { + /** + * @internal + */ export const filterSensitiveLog = (obj: InvalidSubnet): any => ({ ...obj, }); @@ -1871,6 +2027,9 @@ export interface InvalidVPCNetworkStateFault extends __SmithyException, $Metadat } export namespace InvalidVPCNetworkStateFault { + /** + * @internal + */ export const filterSensitiveLog = (obj: InvalidVPCNetworkStateFault): any => ({ ...obj, }); @@ -1889,6 +2048,9 @@ export interface StorageQuotaExceededFault extends __SmithyException, $MetadataB } export namespace StorageQuotaExceededFault { + /** + * @internal + */ export const filterSensitiveLog = (obj: StorageQuotaExceededFault): any => ({ ...obj, }); @@ -1930,6 +2092,9 @@ export interface CreateDBClusterEndpointMessage { } export namespace CreateDBClusterEndpointMessage { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateDBClusterEndpointMessage): any => ({ ...obj, }); @@ -2021,6 +2186,9 @@ export interface CreateDBClusterEndpointOutput { } export namespace CreateDBClusterEndpointOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateDBClusterEndpointOutput): any => ({ ...obj, }); @@ -2039,6 +2207,9 @@ export interface DBClusterEndpointAlreadyExistsFault extends __SmithyException, } export namespace DBClusterEndpointAlreadyExistsFault { + /** + * @internal + */ export const filterSensitiveLog = (obj: DBClusterEndpointAlreadyExistsFault): any => ({ ...obj, }); @@ -2057,6 +2228,9 @@ export interface DBClusterEndpointQuotaExceededFault extends __SmithyException, } export namespace DBClusterEndpointQuotaExceededFault { + /** + * @internal + */ export const filterSensitiveLog = (obj: DBClusterEndpointQuotaExceededFault): any => ({ ...obj, }); @@ -2097,6 +2271,9 @@ export interface CreateDBClusterParameterGroupMessage { } export namespace CreateDBClusterParameterGroupMessage { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateDBClusterParameterGroupMessage): any => ({ ...obj, }); @@ -2111,6 +2288,9 @@ export interface CreateDBClusterParameterGroupResult { } export namespace CreateDBClusterParameterGroupResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateDBClusterParameterGroupResult): any => ({ ...obj, }); @@ -2158,6 +2338,9 @@ export interface CreateDBClusterSnapshotMessage { } export namespace CreateDBClusterSnapshotMessage { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateDBClusterSnapshotMessage): any => ({ ...obj, }); @@ -2172,6 +2355,9 @@ export interface CreateDBClusterSnapshotResult { } export namespace CreateDBClusterSnapshotResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateDBClusterSnapshotResult): any => ({ ...obj, }); @@ -2191,6 +2377,9 @@ export interface AuthorizationNotFoundFault extends __SmithyException, $Metadata } export namespace AuthorizationNotFoundFault { + /** + * @internal + */ export const filterSensitiveLog = (obj: AuthorizationNotFoundFault): any => ({ ...obj, }); @@ -2546,6 +2735,9 @@ export interface CreateDBInstanceMessage { } export namespace CreateDBInstanceMessage { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateDBInstanceMessage): any => ({ ...obj, }); @@ -2590,6 +2782,9 @@ export interface DBParameterGroupStatus { } export namespace DBParameterGroupStatus { + /** + * @internal + */ export const filterSensitiveLog = (obj: DBParameterGroupStatus): any => ({ ...obj, }); @@ -2611,6 +2806,9 @@ export interface DBSecurityGroupMembership { } export namespace DBSecurityGroupMembership { + /** + * @internal + */ export const filterSensitiveLog = (obj: DBSecurityGroupMembership): any => ({ ...obj, }); @@ -2627,6 +2825,9 @@ export interface AvailabilityZone { } export namespace AvailabilityZone { + /** + * @internal + */ export const filterSensitiveLog = (obj: AvailabilityZone): any => ({ ...obj, }); @@ -2654,6 +2855,9 @@ export interface Subnet { } export namespace Subnet { + /** + * @internal + */ export const filterSensitiveLog = (obj: Subnet): any => ({ ...obj, }); @@ -2696,6 +2900,9 @@ export interface DBSubnetGroup { } export namespace DBSubnetGroup { + /** + * @internal + */ export const filterSensitiveLog = (obj: DBSubnetGroup): any => ({ ...obj, }); @@ -2728,6 +2935,9 @@ export interface DomainMembership { } export namespace DomainMembership { + /** + * @internal + */ export const filterSensitiveLog = (obj: DomainMembership): any => ({ ...obj, }); @@ -2757,6 +2967,9 @@ export interface Endpoint { } export namespace Endpoint { + /** + * @internal + */ export const filterSensitiveLog = (obj: Endpoint): any => ({ ...obj, }); @@ -2781,6 +2994,9 @@ export interface OptionGroupMembership { } export namespace OptionGroupMembership { + /** + * @internal + */ export const filterSensitiveLog = (obj: OptionGroupMembership): any => ({ ...obj, }); @@ -2805,6 +3021,9 @@ export interface PendingCloudwatchLogsExports { } export namespace PendingCloudwatchLogsExports { + /** + * @internal + */ export const filterSensitiveLog = (obj: PendingCloudwatchLogsExports): any => ({ ...obj, }); @@ -2896,6 +3115,9 @@ export interface PendingModifiedValues { } export namespace PendingModifiedValues { + /** + * @internal + */ export const filterSensitiveLog = (obj: PendingModifiedValues): any => ({ ...obj, }); @@ -2930,6 +3152,9 @@ export interface DBInstanceStatusInfo { } export namespace DBInstanceStatusInfo { + /** + * @internal + */ export const filterSensitiveLog = (obj: DBInstanceStatusInfo): any => ({ ...obj, }); @@ -3242,6 +3467,9 @@ export interface DBInstance { } export namespace DBInstance { + /** + * @internal + */ export const filterSensitiveLog = (obj: DBInstance): any => ({ ...obj, }); @@ -3256,6 +3484,9 @@ export interface CreateDBInstanceResult { } export namespace CreateDBInstanceResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateDBInstanceResult): any => ({ ...obj, }); @@ -3274,6 +3505,9 @@ export interface DBInstanceAlreadyExistsFault extends __SmithyException, $Metada } export namespace DBInstanceAlreadyExistsFault { + /** + * @internal + */ export const filterSensitiveLog = (obj: DBInstanceAlreadyExistsFault): any => ({ ...obj, }); @@ -3294,6 +3528,9 @@ export interface DBSecurityGroupNotFoundFault extends __SmithyException, $Metada } export namespace DBSecurityGroupNotFoundFault { + /** + * @internal + */ export const filterSensitiveLog = (obj: DBSecurityGroupNotFoundFault): any => ({ ...obj, }); @@ -3313,6 +3550,9 @@ export interface DomainNotFoundFault extends __SmithyException, $MetadataBearer } export namespace DomainNotFoundFault { + /** + * @internal + */ export const filterSensitiveLog = (obj: DomainNotFoundFault): any => ({ ...obj, }); @@ -3331,6 +3571,9 @@ export interface InstanceQuotaExceededFault extends __SmithyException, $Metadata } export namespace InstanceQuotaExceededFault { + /** + * @internal + */ export const filterSensitiveLog = (obj: InstanceQuotaExceededFault): any => ({ ...obj, }); @@ -3349,6 +3592,9 @@ export interface InsufficientDBInstanceCapacityFault extends __SmithyException, } export namespace InsufficientDBInstanceCapacityFault { + /** + * @internal + */ export const filterSensitiveLog = (obj: InsufficientDBInstanceCapacityFault): any => ({ ...obj, }); @@ -3367,6 +3613,9 @@ export interface OptionGroupNotFoundFault extends __SmithyException, $MetadataBe } export namespace OptionGroupNotFoundFault { + /** + * @internal + */ export const filterSensitiveLog = (obj: OptionGroupNotFoundFault): any => ({ ...obj, }); @@ -3385,6 +3634,9 @@ export interface ProvisionedIopsNotAvailableInAZFault extends __SmithyException, } export namespace ProvisionedIopsNotAvailableInAZFault { + /** + * @internal + */ export const filterSensitiveLog = (obj: ProvisionedIopsNotAvailableInAZFault): any => ({ ...obj, }); @@ -3404,6 +3656,9 @@ export interface StorageTypeNotSupportedFault extends __SmithyException, $Metada } export namespace StorageTypeNotSupportedFault { + /** + * @internal + */ export const filterSensitiveLog = (obj: StorageTypeNotSupportedFault): any => ({ ...obj, }); @@ -3449,6 +3704,9 @@ export interface CreateDBParameterGroupMessage { } export namespace CreateDBParameterGroupMessage { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateDBParameterGroupMessage): any => ({ ...obj, }); @@ -3463,6 +3721,9 @@ export interface CreateDBParameterGroupResult { } export namespace CreateDBParameterGroupResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateDBParameterGroupResult): any => ({ ...obj, }); @@ -3495,6 +3756,9 @@ export interface CreateDBSubnetGroupMessage { } export namespace CreateDBSubnetGroupMessage { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateDBSubnetGroupMessage): any => ({ ...obj, }); @@ -3509,6 +3773,9 @@ export interface CreateDBSubnetGroupResult { } export namespace CreateDBSubnetGroupResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateDBSubnetGroupResult): any => ({ ...obj, }); @@ -3528,6 +3795,9 @@ export interface DBSubnetGroupAlreadyExistsFault extends __SmithyException, $Met } export namespace DBSubnetGroupAlreadyExistsFault { + /** + * @internal + */ export const filterSensitiveLog = (obj: DBSubnetGroupAlreadyExistsFault): any => ({ ...obj, }); @@ -3546,6 +3816,9 @@ export interface DBSubnetGroupQuotaExceededFault extends __SmithyException, $Met } export namespace DBSubnetGroupQuotaExceededFault { + /** + * @internal + */ export const filterSensitiveLog = (obj: DBSubnetGroupQuotaExceededFault): any => ({ ...obj, }); @@ -3564,6 +3837,9 @@ export interface DBSubnetQuotaExceededFault extends __SmithyException, $Metadata } export namespace DBSubnetQuotaExceededFault { + /** + * @internal + */ export const filterSensitiveLog = (obj: DBSubnetQuotaExceededFault): any => ({ ...obj, }); @@ -3644,6 +3920,9 @@ export interface CreateEventSubscriptionMessage { } export namespace CreateEventSubscriptionMessage { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateEventSubscriptionMessage): any => ({ ...obj, }); @@ -3657,6 +3936,9 @@ export interface CreateEventSubscriptionResult { } export namespace CreateEventSubscriptionResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateEventSubscriptionResult): any => ({ ...obj, }); @@ -3675,6 +3957,9 @@ export interface EventSubscriptionQuotaExceededFault extends __SmithyException, } export namespace EventSubscriptionQuotaExceededFault { + /** + * @internal + */ export const filterSensitiveLog = (obj: EventSubscriptionQuotaExceededFault): any => ({ ...obj, }); @@ -3693,6 +3978,9 @@ export interface SNSInvalidTopicFault extends __SmithyException, $MetadataBearer } export namespace SNSInvalidTopicFault { + /** + * @internal + */ export const filterSensitiveLog = (obj: SNSInvalidTopicFault): any => ({ ...obj, }); @@ -3711,6 +3999,9 @@ export interface SNSNoAuthorizationFault extends __SmithyException, $MetadataBea } export namespace SNSNoAuthorizationFault { + /** + * @internal + */ export const filterSensitiveLog = (obj: SNSNoAuthorizationFault): any => ({ ...obj, }); @@ -3729,6 +4020,9 @@ export interface SNSTopicArnNotFoundFault extends __SmithyException, $MetadataBe } export namespace SNSTopicArnNotFoundFault { + /** + * @internal + */ export const filterSensitiveLog = (obj: SNSTopicArnNotFoundFault): any => ({ ...obj, }); @@ -3747,6 +4041,9 @@ export interface SubscriptionAlreadyExistFault extends __SmithyException, $Metad } export namespace SubscriptionAlreadyExistFault { + /** + * @internal + */ export const filterSensitiveLog = (obj: SubscriptionAlreadyExistFault): any => ({ ...obj, }); @@ -3765,6 +4062,9 @@ export interface SubscriptionCategoryNotFoundFault extends __SmithyException, $M } export namespace SubscriptionCategoryNotFoundFault { + /** + * @internal + */ export const filterSensitiveLog = (obj: SubscriptionCategoryNotFoundFault): any => ({ ...obj, }); @@ -3821,6 +4121,9 @@ export interface DeleteDBClusterMessage { } export namespace DeleteDBClusterMessage { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteDBClusterMessage): any => ({ ...obj, }); @@ -3835,6 +4138,9 @@ export interface DeleteDBClusterResult { } export namespace DeleteDBClusterResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteDBClusterResult): any => ({ ...obj, }); @@ -3853,6 +4159,9 @@ export interface DBClusterEndpointNotFoundFault extends __SmithyException, $Meta } export namespace DBClusterEndpointNotFoundFault { + /** + * @internal + */ export const filterSensitiveLog = (obj: DBClusterEndpointNotFoundFault): any => ({ ...obj, }); @@ -3866,6 +4175,9 @@ export interface DeleteDBClusterEndpointMessage { } export namespace DeleteDBClusterEndpointMessage { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteDBClusterEndpointMessage): any => ({ ...obj, }); @@ -3957,6 +4269,9 @@ export interface DeleteDBClusterEndpointOutput { } export namespace DeleteDBClusterEndpointOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteDBClusterEndpointOutput): any => ({ ...obj, }); @@ -3975,6 +4290,9 @@ export interface InvalidDBClusterEndpointStateFault extends __SmithyException, $ } export namespace InvalidDBClusterEndpointStateFault { + /** + * @internal + */ export const filterSensitiveLog = (obj: InvalidDBClusterEndpointStateFault): any => ({ ...obj, }); @@ -4000,6 +4318,9 @@ export interface DeleteDBClusterParameterGroupMessage { } export namespace DeleteDBClusterParameterGroupMessage { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteDBClusterParameterGroupMessage): any => ({ ...obj, }); @@ -4019,6 +4340,9 @@ export interface InvalidDBParameterGroupStateFault extends __SmithyException, $M } export namespace InvalidDBParameterGroupStateFault { + /** + * @internal + */ export const filterSensitiveLog = (obj: InvalidDBParameterGroupStateFault): any => ({ ...obj, }); @@ -4034,6 +4358,9 @@ export interface DeleteDBClusterSnapshotMessage { } export namespace DeleteDBClusterSnapshotMessage { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteDBClusterSnapshotMessage): any => ({ ...obj, }); @@ -4048,6 +4375,9 @@ export interface DeleteDBClusterSnapshotResult { } export namespace DeleteDBClusterSnapshotResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteDBClusterSnapshotResult): any => ({ ...obj, }); @@ -4067,6 +4397,9 @@ export interface DBSnapshotAlreadyExistsFault extends __SmithyException, $Metada } export namespace DBSnapshotAlreadyExistsFault { + /** + * @internal + */ export const filterSensitiveLog = (obj: DBSnapshotAlreadyExistsFault): any => ({ ...obj, }); @@ -4129,6 +4462,9 @@ export interface DeleteDBInstanceMessage { } export namespace DeleteDBInstanceMessage { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteDBInstanceMessage): any => ({ ...obj, }); @@ -4143,6 +4479,9 @@ export interface DeleteDBInstanceResult { } export namespace DeleteDBInstanceResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteDBInstanceResult): any => ({ ...obj, }); @@ -4168,6 +4507,9 @@ export interface DeleteDBParameterGroupMessage { } export namespace DeleteDBParameterGroupMessage { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteDBParameterGroupMessage): any => ({ ...obj, }); @@ -4188,6 +4530,9 @@ export interface DeleteDBSubnetGroupMessage { } export namespace DeleteDBSubnetGroupMessage { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteDBSubnetGroupMessage): any => ({ ...obj, }); @@ -4206,6 +4551,9 @@ export interface InvalidDBSubnetStateFault extends __SmithyException, $MetadataB } export namespace InvalidDBSubnetStateFault { + /** + * @internal + */ export const filterSensitiveLog = (obj: InvalidDBSubnetStateFault): any => ({ ...obj, }); @@ -4219,6 +4567,9 @@ export interface DeleteEventSubscriptionMessage { } export namespace DeleteEventSubscriptionMessage { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteEventSubscriptionMessage): any => ({ ...obj, }); @@ -4232,6 +4583,9 @@ export interface DeleteEventSubscriptionResult { } export namespace DeleteEventSubscriptionResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteEventSubscriptionResult): any => ({ ...obj, }); @@ -4250,6 +4604,9 @@ export interface InvalidEventSubscriptionStateFault extends __SmithyException, $ } export namespace InvalidEventSubscriptionStateFault { + /** + * @internal + */ export const filterSensitiveLog = (obj: InvalidEventSubscriptionStateFault): any => ({ ...obj, }); @@ -4341,6 +4698,9 @@ export interface DBClusterEndpoint { } export namespace DBClusterEndpoint { + /** + * @internal + */ export const filterSensitiveLog = (obj: DBClusterEndpoint): any => ({ ...obj, }); @@ -4365,6 +4725,9 @@ export interface DBClusterEndpointMessage { } export namespace DBClusterEndpointMessage { + /** + * @internal + */ export const filterSensitiveLog = (obj: DBClusterEndpointMessage): any => ({ ...obj, }); @@ -4386,6 +4749,9 @@ export interface Filter { } export namespace Filter { + /** + * @internal + */ export const filterSensitiveLog = (obj: Filter): any => ({ ...obj, }); @@ -4437,6 +4803,9 @@ export interface DescribeDBClusterEndpointsMessage { } export namespace DescribeDBClusterEndpointsMessage { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeDBClusterEndpointsMessage): any => ({ ...obj, }); @@ -4458,6 +4827,9 @@ export interface DBClusterParameterGroupsMessage { } export namespace DBClusterParameterGroupsMessage { + /** + * @internal + */ export const filterSensitiveLog = (obj: DBClusterParameterGroupsMessage): any => ({ ...obj, }); @@ -4499,6 +4871,9 @@ export interface DescribeDBClusterParameterGroupsMessage { } export namespace DescribeDBClusterParameterGroupsMessage { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeDBClusterParameterGroupsMessage): any => ({ ...obj, }); @@ -4564,6 +4939,9 @@ export interface Parameter { } export namespace Parameter { + /** + * @internal + */ export const filterSensitiveLog = (obj: Parameter): any => ({ ...obj, }); @@ -4584,6 +4962,9 @@ export interface DBClusterParameterGroupDetails { } export namespace DBClusterParameterGroupDetails { + /** + * @internal + */ export const filterSensitiveLog = (obj: DBClusterParameterGroupDetails): any => ({ ...obj, }); @@ -4631,6 +5012,9 @@ export interface DescribeDBClusterParametersMessage { } export namespace DescribeDBClusterParametersMessage { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeDBClusterParametersMessage): any => ({ ...obj, }); @@ -4649,6 +5033,9 @@ export interface DBClusterMessage { } export namespace DBClusterMessage { + /** + * @internal + */ export const filterSensitiveLog = (obj: DBClusterMessage): any => ({ ...obj, }); @@ -4707,6 +5094,9 @@ export interface DescribeDBClustersMessage { } export namespace DescribeDBClustersMessage { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeDBClustersMessage): any => ({ ...obj, }); @@ -4720,6 +5110,9 @@ export interface DescribeDBClusterSnapshotAttributesMessage { } export namespace DescribeDBClusterSnapshotAttributesMessage { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeDBClusterSnapshotAttributesMessage): any => ({ ...obj, }); @@ -4750,6 +5143,9 @@ export interface DBClusterSnapshotAttribute { } export namespace DBClusterSnapshotAttribute { + /** + * @internal + */ export const filterSensitiveLog = (obj: DBClusterSnapshotAttribute): any => ({ ...obj, }); @@ -4773,6 +5169,9 @@ export interface DBClusterSnapshotAttributesResult { } export namespace DBClusterSnapshotAttributesResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: DBClusterSnapshotAttributesResult): any => ({ ...obj, }); @@ -4788,6 +5187,9 @@ export interface DescribeDBClusterSnapshotAttributesResult { } export namespace DescribeDBClusterSnapshotAttributesResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeDBClusterSnapshotAttributesResult): any => ({ ...obj, }); @@ -4808,6 +5210,9 @@ export interface DBClusterSnapshotMessage { } export namespace DBClusterSnapshotMessage { + /** + * @internal + */ export const filterSensitiveLog = (obj: DBClusterSnapshotMessage): any => ({ ...obj, }); @@ -4924,6 +5329,9 @@ export interface DescribeDBClusterSnapshotsMessage { } export namespace DescribeDBClusterSnapshotsMessage { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeDBClusterSnapshotsMessage): any => ({ ...obj, }); @@ -4945,6 +5353,9 @@ export interface CharacterSet { } export namespace CharacterSet { + /** + * @internal + */ export const filterSensitiveLog = (obj: CharacterSet): any => ({ ...obj, }); @@ -4961,6 +5372,9 @@ export interface Timezone { } export namespace Timezone { + /** + * @internal + */ export const filterSensitiveLog = (obj: Timezone): any => ({ ...obj, }); @@ -4998,6 +5412,9 @@ export interface UpgradeTarget { } export namespace UpgradeTarget { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpgradeTarget): any => ({ ...obj, }); @@ -5076,6 +5493,9 @@ export interface DBEngineVersion { } export namespace DBEngineVersion { + /** + * @internal + */ export const filterSensitiveLog = (obj: DBEngineVersion): any => ({ ...obj, }); @@ -5096,6 +5516,9 @@ export interface DBEngineVersionMessage { } export namespace DBEngineVersionMessage { + /** + * @internal + */ export const filterSensitiveLog = (obj: DBEngineVersionMessage): any => ({ ...obj, }); @@ -5168,6 +5591,9 @@ export interface DescribeDBEngineVersionsMessage { } export namespace DescribeDBEngineVersionsMessage { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeDBEngineVersionsMessage): any => ({ ...obj, }); @@ -5188,6 +5614,9 @@ export interface DBInstanceMessage { } export namespace DBInstanceMessage { + /** + * @internal + */ export const filterSensitiveLog = (obj: DBInstanceMessage): any => ({ ...obj, }); @@ -5246,6 +5675,9 @@ export interface DescribeDBInstancesMessage { } export namespace DescribeDBInstancesMessage { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeDBInstancesMessage): any => ({ ...obj, }); @@ -5266,6 +5698,9 @@ export interface DBParameterGroupsMessage { } export namespace DBParameterGroupsMessage { + /** + * @internal + */ export const filterSensitiveLog = (obj: DBParameterGroupsMessage): any => ({ ...obj, }); @@ -5306,6 +5741,9 @@ export interface DescribeDBParameterGroupsMessage { } export namespace DescribeDBParameterGroupsMessage { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeDBParameterGroupsMessage): any => ({ ...obj, }); @@ -5326,6 +5764,9 @@ export interface DBParameterGroupDetails { } export namespace DBParameterGroupDetails { + /** + * @internal + */ export const filterSensitiveLog = (obj: DBParameterGroupDetails): any => ({ ...obj, }); @@ -5374,6 +5815,9 @@ export interface DescribeDBParametersMessage { } export namespace DescribeDBParametersMessage { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeDBParametersMessage): any => ({ ...obj, }); @@ -5394,6 +5838,9 @@ export interface DBSubnetGroupMessage { } export namespace DBSubnetGroupMessage { + /** + * @internal + */ export const filterSensitiveLog = (obj: DBSubnetGroupMessage): any => ({ ...obj, }); @@ -5428,6 +5875,9 @@ export interface DescribeDBSubnetGroupsMessage { } export namespace DescribeDBSubnetGroupsMessage { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeDBSubnetGroupsMessage): any => ({ ...obj, }); @@ -5464,6 +5914,9 @@ export interface DescribeEngineDefaultClusterParametersMessage { } export namespace DescribeEngineDefaultClusterParametersMessage { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeEngineDefaultClusterParametersMessage): any => ({ ...obj, }); @@ -5493,6 +5946,9 @@ export interface EngineDefaults { } export namespace EngineDefaults { + /** + * @internal + */ export const filterSensitiveLog = (obj: EngineDefaults): any => ({ ...obj, }); @@ -5506,6 +5962,9 @@ export interface DescribeEngineDefaultClusterParametersResult { } export namespace DescribeEngineDefaultClusterParametersResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeEngineDefaultClusterParametersResult): any => ({ ...obj, }); @@ -5541,6 +6000,9 @@ export interface DescribeEngineDefaultParametersMessage { } export namespace DescribeEngineDefaultParametersMessage { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeEngineDefaultParametersMessage): any => ({ ...obj, }); @@ -5554,6 +6016,9 @@ export interface DescribeEngineDefaultParametersResult { } export namespace DescribeEngineDefaultParametersResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeEngineDefaultParametersResult): any => ({ ...obj, }); @@ -5573,6 +6038,9 @@ export interface DescribeEventCategoriesMessage { } export namespace DescribeEventCategoriesMessage { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeEventCategoriesMessage): any => ({ ...obj, }); @@ -5594,6 +6062,9 @@ export interface EventCategoriesMap { } export namespace EventCategoriesMap { + /** + * @internal + */ export const filterSensitiveLog = (obj: EventCategoriesMap): any => ({ ...obj, }); @@ -5607,6 +6078,9 @@ export interface EventCategoriesMessage { } export namespace EventCategoriesMessage { + /** + * @internal + */ export const filterSensitiveLog = (obj: EventCategoriesMessage): any => ({ ...obj, }); @@ -5709,6 +6183,9 @@ export interface DescribeEventsMessage { } export namespace DescribeEventsMessage { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeEventsMessage): any => ({ ...obj, }); @@ -5751,6 +6228,9 @@ export interface Event { } export namespace Event { + /** + * @internal + */ export const filterSensitiveLog = (obj: Event): any => ({ ...obj, }); @@ -5771,6 +6251,9 @@ export interface EventsMessage { } export namespace EventsMessage { + /** + * @internal + */ export const filterSensitiveLog = (obj: EventsMessage): any => ({ ...obj, }); @@ -5805,6 +6288,9 @@ export interface DescribeEventSubscriptionsMessage { } export namespace DescribeEventSubscriptionsMessage { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeEventSubscriptionsMessage): any => ({ ...obj, }); @@ -5825,6 +6311,9 @@ export interface EventSubscriptionsMessage { } export namespace EventSubscriptionsMessage { + /** + * @internal + */ export const filterSensitiveLog = (obj: EventSubscriptionsMessage): any => ({ ...obj, }); @@ -5883,6 +6372,9 @@ export interface DescribeOrderableDBInstanceOptionsMessage { } export namespace DescribeOrderableDBInstanceOptionsMessage { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeOrderableDBInstanceOptionsMessage): any => ({ ...obj, }); @@ -5998,6 +6490,9 @@ export interface OrderableDBInstanceOption { } export namespace OrderableDBInstanceOption { + /** + * @internal + */ export const filterSensitiveLog = (obj: OrderableDBInstanceOption): any => ({ ...obj, }); @@ -6019,6 +6514,9 @@ export interface OrderableDBInstanceOptionsMessage { } export namespace OrderableDBInstanceOptionsMessage { + /** + * @internal + */ export const filterSensitiveLog = (obj: OrderableDBInstanceOptionsMessage): any => ({ ...obj, }); @@ -6070,6 +6568,9 @@ export interface DescribePendingMaintenanceActionsMessage { } export namespace DescribePendingMaintenanceActionsMessage { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribePendingMaintenanceActionsMessage): any => ({ ...obj, }); @@ -6091,6 +6592,9 @@ export interface PendingMaintenanceActionsMessage { } export namespace PendingMaintenanceActionsMessage { + /** + * @internal + */ export const filterSensitiveLog = (obj: PendingMaintenanceActionsMessage): any => ({ ...obj, }); @@ -6104,6 +6608,9 @@ export interface DescribeValidDBInstanceModificationsMessage { } export namespace DescribeValidDBInstanceModificationsMessage { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeValidDBInstanceModificationsMessage): any => ({ ...obj, }); @@ -6125,6 +6632,9 @@ export interface DoubleRange { } export namespace DoubleRange { + /** + * @internal + */ export const filterSensitiveLog = (obj: DoubleRange): any => ({ ...obj, }); @@ -6154,6 +6664,9 @@ export interface Range { } export namespace Range { + /** + * @internal + */ export const filterSensitiveLog = (obj: Range): any => ({ ...obj, }); @@ -6188,6 +6701,9 @@ export interface ValidStorageOptions { } export namespace ValidStorageOptions { + /** + * @internal + */ export const filterSensitiveLog = (obj: ValidStorageOptions): any => ({ ...obj, }); @@ -6207,6 +6723,9 @@ export interface ValidDBInstanceModificationsMessage { } export namespace ValidDBInstanceModificationsMessage { + /** + * @internal + */ export const filterSensitiveLog = (obj: ValidDBInstanceModificationsMessage): any => ({ ...obj, }); @@ -6223,6 +6742,9 @@ export interface DescribeValidDBInstanceModificationsResult { } export namespace DescribeValidDBInstanceModificationsResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeValidDBInstanceModificationsResult): any => ({ ...obj, }); @@ -6250,6 +6772,9 @@ export interface FailoverDBClusterMessage { } export namespace FailoverDBClusterMessage { + /** + * @internal + */ export const filterSensitiveLog = (obj: FailoverDBClusterMessage): any => ({ ...obj, }); @@ -6264,6 +6789,9 @@ export interface FailoverDBClusterResult { } export namespace FailoverDBClusterResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: FailoverDBClusterResult): any => ({ ...obj, }); @@ -6284,6 +6812,9 @@ export interface ListTagsForResourceMessage { } export namespace ListTagsForResourceMessage { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListTagsForResourceMessage): any => ({ ...obj, }); @@ -6297,6 +6828,9 @@ export interface TagListMessage { } export namespace TagListMessage { + /** + * @internal + */ export const filterSensitiveLog = (obj: TagListMessage): any => ({ ...obj, }); @@ -6315,6 +6849,9 @@ export interface InvalidDBSecurityGroupStateFault extends __SmithyException, $Me } export namespace InvalidDBSecurityGroupStateFault { + /** + * @internal + */ export const filterSensitiveLog = (obj: InvalidDBSecurityGroupStateFault): any => ({ ...obj, }); @@ -6340,6 +6877,9 @@ export interface CloudwatchLogsExportConfiguration { } export namespace CloudwatchLogsExportConfiguration { + /** + * @internal + */ export const filterSensitiveLog = (obj: CloudwatchLogsExportConfiguration): any => ({ ...obj, }); @@ -6508,6 +7048,9 @@ export interface ModifyDBClusterMessage { } export namespace ModifyDBClusterMessage { + /** + * @internal + */ export const filterSensitiveLog = (obj: ModifyDBClusterMessage): any => ({ ...obj, }); @@ -6522,6 +7065,9 @@ export interface ModifyDBClusterResult { } export namespace ModifyDBClusterResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: ModifyDBClusterResult): any => ({ ...obj, }); @@ -6552,6 +7098,9 @@ export interface ModifyDBClusterEndpointMessage { } export namespace ModifyDBClusterEndpointMessage { + /** + * @internal + */ export const filterSensitiveLog = (obj: ModifyDBClusterEndpointMessage): any => ({ ...obj, }); @@ -6643,6 +7192,9 @@ export interface ModifyDBClusterEndpointOutput { } export namespace ModifyDBClusterEndpointOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: ModifyDBClusterEndpointOutput): any => ({ ...obj, }); @@ -6671,6 +7223,9 @@ export interface DBClusterParameterGroupNameMessage { } export namespace DBClusterParameterGroupNameMessage { + /** + * @internal + */ export const filterSensitiveLog = (obj: DBClusterParameterGroupNameMessage): any => ({ ...obj, }); @@ -6689,6 +7244,9 @@ export interface ModifyDBClusterParameterGroupMessage { } export namespace ModifyDBClusterParameterGroupMessage { + /** + * @internal + */ export const filterSensitiveLog = (obj: ModifyDBClusterParameterGroupMessage): any => ({ ...obj, }); @@ -6731,6 +7289,9 @@ export interface ModifyDBClusterSnapshotAttributeMessage { } export namespace ModifyDBClusterSnapshotAttributeMessage { + /** + * @internal + */ export const filterSensitiveLog = (obj: ModifyDBClusterSnapshotAttributeMessage): any => ({ ...obj, }); @@ -6746,6 +7307,9 @@ export interface ModifyDBClusterSnapshotAttributeResult { } export namespace ModifyDBClusterSnapshotAttributeResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: ModifyDBClusterSnapshotAttributeResult): any => ({ ...obj, }); @@ -6764,6 +7328,9 @@ export interface SharedSnapshotQuotaExceededFault extends __SmithyException, $Me } export namespace SharedSnapshotQuotaExceededFault { + /** + * @internal + */ export const filterSensitiveLog = (obj: SharedSnapshotQuotaExceededFault): any => ({ ...obj, }); @@ -6783,6 +7350,9 @@ export interface CertificateNotFoundFault extends __SmithyException, $MetadataBe } export namespace CertificateNotFoundFault { + /** + * @internal + */ export const filterSensitiveLog = (obj: CertificateNotFoundFault): any => ({ ...obj, }); @@ -6801,6 +7371,9 @@ export interface DBUpgradeDependencyFailureFault extends __SmithyException, $Met } export namespace DBUpgradeDependencyFailureFault { + /** + * @internal + */ export const filterSensitiveLog = (obj: DBUpgradeDependencyFailureFault): any => ({ ...obj, }); @@ -7144,6 +7717,9 @@ export interface ModifyDBInstanceMessage { } export namespace ModifyDBInstanceMessage { + /** + * @internal + */ export const filterSensitiveLog = (obj: ModifyDBInstanceMessage): any => ({ ...obj, }); @@ -7158,6 +7734,9 @@ export interface ModifyDBInstanceResult { } export namespace ModifyDBInstanceResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: ModifyDBInstanceResult): any => ({ ...obj, }); @@ -7171,6 +7750,9 @@ export interface DBParameterGroupNameMessage { } export namespace DBParameterGroupNameMessage { + /** + * @internal + */ export const filterSensitiveLog = (obj: DBParameterGroupNameMessage): any => ({ ...obj, }); @@ -7204,6 +7786,9 @@ export interface ModifyDBParameterGroupMessage { } export namespace ModifyDBParameterGroupMessage { + /** + * @internal + */ export const filterSensitiveLog = (obj: ModifyDBParameterGroupMessage): any => ({ ...obj, }); @@ -7231,6 +7816,9 @@ export interface ModifyDBSubnetGroupMessage { } export namespace ModifyDBSubnetGroupMessage { + /** + * @internal + */ export const filterSensitiveLog = (obj: ModifyDBSubnetGroupMessage): any => ({ ...obj, }); @@ -7245,6 +7833,9 @@ export interface ModifyDBSubnetGroupResult { } export namespace ModifyDBSubnetGroupResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: ModifyDBSubnetGroupResult): any => ({ ...obj, }); @@ -7263,6 +7854,9 @@ export interface SubnetAlreadyInUse extends __SmithyException, $MetadataBearer { } export namespace SubnetAlreadyInUse { + /** + * @internal + */ export const filterSensitiveLog = (obj: SubnetAlreadyInUse): any => ({ ...obj, }); @@ -7304,6 +7898,9 @@ export interface ModifyEventSubscriptionMessage { } export namespace ModifyEventSubscriptionMessage { + /** + * @internal + */ export const filterSensitiveLog = (obj: ModifyEventSubscriptionMessage): any => ({ ...obj, }); @@ -7317,6 +7914,9 @@ export interface ModifyEventSubscriptionResult { } export namespace ModifyEventSubscriptionResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: ModifyEventSubscriptionResult): any => ({ ...obj, }); @@ -7330,6 +7930,9 @@ export interface PromoteReadReplicaDBClusterMessage { } export namespace PromoteReadReplicaDBClusterMessage { + /** + * @internal + */ export const filterSensitiveLog = (obj: PromoteReadReplicaDBClusterMessage): any => ({ ...obj, }); @@ -7344,6 +7947,9 @@ export interface PromoteReadReplicaDBClusterResult { } export namespace PromoteReadReplicaDBClusterResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: PromoteReadReplicaDBClusterResult): any => ({ ...obj, }); @@ -7370,6 +7976,9 @@ export interface RebootDBInstanceMessage { } export namespace RebootDBInstanceMessage { + /** + * @internal + */ export const filterSensitiveLog = (obj: RebootDBInstanceMessage): any => ({ ...obj, }); @@ -7384,6 +7993,9 @@ export interface RebootDBInstanceResult { } export namespace RebootDBInstanceResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: RebootDBInstanceResult): any => ({ ...obj, }); @@ -7402,6 +8014,9 @@ export interface DBClusterRoleNotFoundFault extends __SmithyException, $Metadata } export namespace DBClusterRoleNotFoundFault { + /** + * @internal + */ export const filterSensitiveLog = (obj: DBClusterRoleNotFoundFault): any => ({ ...obj, }); @@ -7427,6 +8042,9 @@ export interface RemoveRoleFromDBClusterMessage { } export namespace RemoveRoleFromDBClusterMessage { + /** + * @internal + */ export const filterSensitiveLog = (obj: RemoveRoleFromDBClusterMessage): any => ({ ...obj, }); @@ -7447,6 +8065,9 @@ export interface RemoveSourceIdentifierFromSubscriptionMessage { } export namespace RemoveSourceIdentifierFromSubscriptionMessage { + /** + * @internal + */ export const filterSensitiveLog = (obj: RemoveSourceIdentifierFromSubscriptionMessage): any => ({ ...obj, }); @@ -7460,6 +8081,9 @@ export interface RemoveSourceIdentifierFromSubscriptionResult { } export namespace RemoveSourceIdentifierFromSubscriptionResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: RemoveSourceIdentifierFromSubscriptionResult): any => ({ ...obj, }); @@ -7480,6 +8104,9 @@ export interface RemoveTagsFromResourceMessage { } export namespace RemoveTagsFromResourceMessage { + /** + * @internal + */ export const filterSensitiveLog = (obj: RemoveTagsFromResourceMessage): any => ({ ...obj, }); @@ -7508,6 +8135,9 @@ export interface ResetDBClusterParameterGroupMessage { } export namespace ResetDBClusterParameterGroupMessage { + /** + * @internal + */ export const filterSensitiveLog = (obj: ResetDBClusterParameterGroupMessage): any => ({ ...obj, }); @@ -7545,6 +8175,9 @@ export interface ResetDBParameterGroupMessage { } export namespace ResetDBParameterGroupMessage { + /** + * @internal + */ export const filterSensitiveLog = (obj: ResetDBParameterGroupMessage): any => ({ ...obj, }); @@ -7563,6 +8196,9 @@ export interface InsufficientDBClusterCapacityFault extends __SmithyException, $ } export namespace InsufficientDBClusterCapacityFault { + /** + * @internal + */ export const filterSensitiveLog = (obj: InsufficientDBClusterCapacityFault): any => ({ ...obj, }); @@ -7581,6 +8217,9 @@ export interface InvalidDBSnapshotStateFault extends __SmithyException, $Metadat } export namespace InvalidDBSnapshotStateFault { + /** + * @internal + */ export const filterSensitiveLog = (obj: InvalidDBSnapshotStateFault): any => ({ ...obj, }); @@ -7599,6 +8238,9 @@ export interface InvalidRestoreFault extends __SmithyException, $MetadataBearer } export namespace InvalidRestoreFault { + /** + * @internal + */ export const filterSensitiveLog = (obj: InvalidRestoreFault): any => ({ ...obj, }); @@ -7751,6 +8393,9 @@ export interface RestoreDBClusterFromSnapshotMessage { } export namespace RestoreDBClusterFromSnapshotMessage { + /** + * @internal + */ export const filterSensitiveLog = (obj: RestoreDBClusterFromSnapshotMessage): any => ({ ...obj, }); @@ -7765,6 +8410,9 @@ export interface RestoreDBClusterFromSnapshotResult { } export namespace RestoreDBClusterFromSnapshotResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: RestoreDBClusterFromSnapshotResult): any => ({ ...obj, }); @@ -7948,6 +8596,9 @@ export interface RestoreDBClusterToPointInTimeMessage { } export namespace RestoreDBClusterToPointInTimeMessage { + /** + * @internal + */ export const filterSensitiveLog = (obj: RestoreDBClusterToPointInTimeMessage): any => ({ ...obj, }); @@ -7962,6 +8613,9 @@ export interface RestoreDBClusterToPointInTimeResult { } export namespace RestoreDBClusterToPointInTimeResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: RestoreDBClusterToPointInTimeResult): any => ({ ...obj, }); @@ -7976,6 +8630,9 @@ export interface StartDBClusterMessage { } export namespace StartDBClusterMessage { + /** + * @internal + */ export const filterSensitiveLog = (obj: StartDBClusterMessage): any => ({ ...obj, }); @@ -7990,6 +8647,9 @@ export interface StartDBClusterResult { } export namespace StartDBClusterResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: StartDBClusterResult): any => ({ ...obj, }); @@ -8004,6 +8664,9 @@ export interface StopDBClusterMessage { } export namespace StopDBClusterMessage { + /** + * @internal + */ export const filterSensitiveLog = (obj: StopDBClusterMessage): any => ({ ...obj, }); @@ -8018,6 +8681,9 @@ export interface StopDBClusterResult { } export namespace StopDBClusterResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: StopDBClusterResult): any => ({ ...obj, }); diff --git a/clients/client-network-firewall/commands/AssociateFirewallPolicyCommand.ts b/clients/client-network-firewall/commands/AssociateFirewallPolicyCommand.ts index 70922c1a702c..c92bdbef644f 100644 --- a/clients/client-network-firewall/commands/AssociateFirewallPolicyCommand.ts +++ b/clients/client-network-firewall/commands/AssociateFirewallPolicyCommand.ts @@ -26,6 +26,20 @@ export interface AssociateFirewallPolicyCommandOutput extends AssociateFirewallP * 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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { NetworkFirewallClient, AssociateFirewallPolicyCommand } from "@aws-sdk/client-network-firewall"; // ES Modules import + * // const { NetworkFirewallClient, AssociateFirewallPolicyCommand } = require("@aws-sdk/client-network-firewall"); // CommonJS import + * const client = new NetworkFirewallClient(config); + * const command = new AssociateFirewallPolicyCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link AssociateFirewallPolicyCommandInput} for command's `input` shape. + * @see {@link AssociateFirewallPolicyCommandOutput} for command's `response` shape. + * @see {@link NetworkFirewallClientResolvedConfig | config} for command's `input` shape. + * */ export class AssociateFirewallPolicyCommand extends $Command< AssociateFirewallPolicyCommandInput, diff --git a/clients/client-network-firewall/commands/AssociateSubnetsCommand.ts b/clients/client-network-firewall/commands/AssociateSubnetsCommand.ts index b00f487e9006..202bc046fc5e 100644 --- a/clients/client-network-firewall/commands/AssociateSubnetsCommand.ts +++ b/clients/client-network-firewall/commands/AssociateSubnetsCommand.ts @@ -27,6 +27,20 @@ export interface AssociateSubnetsCommandOutput extends AssociateSubnetsResponse, * 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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { NetworkFirewallClient, AssociateSubnetsCommand } from "@aws-sdk/client-network-firewall"; // ES Modules import + * // const { NetworkFirewallClient, AssociateSubnetsCommand } = require("@aws-sdk/client-network-firewall"); // CommonJS import + * const client = new NetworkFirewallClient(config); + * const command = new AssociateSubnetsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link AssociateSubnetsCommandInput} for command's `input` shape. + * @see {@link AssociateSubnetsCommandOutput} for command's `response` shape. + * @see {@link NetworkFirewallClientResolvedConfig | config} for command's `input` shape. + * */ export class AssociateSubnetsCommand extends $Command< AssociateSubnetsCommandInput, diff --git a/clients/client-network-firewall/commands/CreateFirewallCommand.ts b/clients/client-network-firewall/commands/CreateFirewallCommand.ts index 942930d2b0ce..f1cc68fa73c2 100644 --- a/clients/client-network-firewall/commands/CreateFirewallCommand.ts +++ b/clients/client-network-firewall/commands/CreateFirewallCommand.ts @@ -28,6 +28,20 @@ export interface CreateFirewallCommandOutput extends CreateFirewallResponse, __M * themselves, for example UpdateLoggingConfiguration, AssociateSubnets, and UpdateFirewallDeleteProtection.

*

To manage a firewall's tags, use the standard AWS resource tagging operations, ListTagsForResource, TagResource, and UntagResource.

*

To retrieve information about firewalls, use ListFirewalls and DescribeFirewall.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { NetworkFirewallClient, CreateFirewallCommand } from "@aws-sdk/client-network-firewall"; // ES Modules import + * // const { NetworkFirewallClient, CreateFirewallCommand } = require("@aws-sdk/client-network-firewall"); // CommonJS import + * const client = new NetworkFirewallClient(config); + * const command = new CreateFirewallCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreateFirewallCommandInput} for command's `input` shape. + * @see {@link CreateFirewallCommandOutput} for command's `response` shape. + * @see {@link NetworkFirewallClientResolvedConfig | config} for command's `input` shape. + * */ export class CreateFirewallCommand extends $Command< CreateFirewallCommandInput, diff --git a/clients/client-network-firewall/commands/CreateFirewallPolicyCommand.ts b/clients/client-network-firewall/commands/CreateFirewallPolicyCommand.ts index 2c147dc833fa..72df6c1921be 100644 --- a/clients/client-network-firewall/commands/CreateFirewallPolicyCommand.ts +++ b/clients/client-network-firewall/commands/CreateFirewallPolicyCommand.ts @@ -25,6 +25,20 @@ export interface CreateFirewallPolicyCommandOutput extends CreateFirewallPolicyR *

An AWS 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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { NetworkFirewallClient, CreateFirewallPolicyCommand } from "@aws-sdk/client-network-firewall"; // ES Modules import + * // const { NetworkFirewallClient, CreateFirewallPolicyCommand } = require("@aws-sdk/client-network-firewall"); // CommonJS import + * const client = new NetworkFirewallClient(config); + * const command = new CreateFirewallPolicyCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreateFirewallPolicyCommandInput} for command's `input` shape. + * @see {@link CreateFirewallPolicyCommandOutput} for command's `response` shape. + * @see {@link NetworkFirewallClientResolvedConfig | config} for command's `input` shape. + * */ export class CreateFirewallPolicyCommand extends $Command< CreateFirewallPolicyCommandInput, diff --git a/clients/client-network-firewall/commands/CreateRuleGroupCommand.ts b/clients/client-network-firewall/commands/CreateRuleGroupCommand.ts index 89957634c2cb..2409ec5bc4c9 100644 --- a/clients/client-network-firewall/commands/CreateRuleGroupCommand.ts +++ b/clients/client-network-firewall/commands/CreateRuleGroupCommand.ts @@ -25,6 +25,20 @@ export interface CreateRuleGroupCommandOutput extends CreateRuleGroupResponse, _ * network traffic inspection, a capacity setting, and tags.

*

You provide your rule group specification in your request using either * RuleGroup or Rules.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { NetworkFirewallClient, CreateRuleGroupCommand } from "@aws-sdk/client-network-firewall"; // ES Modules import + * // const { NetworkFirewallClient, CreateRuleGroupCommand } = require("@aws-sdk/client-network-firewall"); // CommonJS import + * const client = new NetworkFirewallClient(config); + * const command = new CreateRuleGroupCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreateRuleGroupCommandInput} for command's `input` shape. + * @see {@link CreateRuleGroupCommandOutput} for command's `response` shape. + * @see {@link NetworkFirewallClientResolvedConfig | config} for command's `input` shape. + * */ export class CreateRuleGroupCommand extends $Command< CreateRuleGroupCommandInput, diff --git a/clients/client-network-firewall/commands/DeleteFirewallCommand.ts b/clients/client-network-firewall/commands/DeleteFirewallCommand.ts index 3a2ea337e0d3..ff4253ade65e 100644 --- a/clients/client-network-firewall/commands/DeleteFirewallCommand.ts +++ b/clients/client-network-firewall/commands/DeleteFirewallCommand.ts @@ -31,6 +31,20 @@ export interface DeleteFirewallCommandOutput extends DeleteFirewallResponse, __M * 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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { NetworkFirewallClient, DeleteFirewallCommand } from "@aws-sdk/client-network-firewall"; // ES Modules import + * // const { NetworkFirewallClient, DeleteFirewallCommand } = require("@aws-sdk/client-network-firewall"); // CommonJS import + * const client = new NetworkFirewallClient(config); + * const command = new DeleteFirewallCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteFirewallCommandInput} for command's `input` shape. + * @see {@link DeleteFirewallCommandOutput} for command's `response` shape. + * @see {@link NetworkFirewallClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteFirewallCommand extends $Command< DeleteFirewallCommandInput, diff --git a/clients/client-network-firewall/commands/DeleteFirewallPolicyCommand.ts b/clients/client-network-firewall/commands/DeleteFirewallPolicyCommand.ts index 242d2142741f..863708b7db98 100644 --- a/clients/client-network-firewall/commands/DeleteFirewallPolicyCommand.ts +++ b/clients/client-network-firewall/commands/DeleteFirewallPolicyCommand.ts @@ -22,6 +22,20 @@ export interface DeleteFirewallPolicyCommandOutput extends DeleteFirewallPolicyR /** *

Deletes the specified FirewallPolicy.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { NetworkFirewallClient, DeleteFirewallPolicyCommand } from "@aws-sdk/client-network-firewall"; // ES Modules import + * // const { NetworkFirewallClient, DeleteFirewallPolicyCommand } = require("@aws-sdk/client-network-firewall"); // CommonJS import + * const client = new NetworkFirewallClient(config); + * const command = new DeleteFirewallPolicyCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteFirewallPolicyCommandInput} for command's `input` shape. + * @see {@link DeleteFirewallPolicyCommandOutput} for command's `response` shape. + * @see {@link NetworkFirewallClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteFirewallPolicyCommand extends $Command< DeleteFirewallPolicyCommandInput, diff --git a/clients/client-network-firewall/commands/DeleteResourcePolicyCommand.ts b/clients/client-network-firewall/commands/DeleteResourcePolicyCommand.ts index 767f023bdf39..23bd0a1c3249 100644 --- a/clients/client-network-firewall/commands/DeleteResourcePolicyCommand.ts +++ b/clients/client-network-firewall/commands/DeleteResourcePolicyCommand.ts @@ -22,6 +22,20 @@ export interface DeleteResourcePolicyCommandOutput extends DeleteResourcePolicyR /** *

Deletes a resource policy that you created in a PutResourcePolicy request.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { NetworkFirewallClient, DeleteResourcePolicyCommand } from "@aws-sdk/client-network-firewall"; // ES Modules import + * // const { NetworkFirewallClient, DeleteResourcePolicyCommand } = require("@aws-sdk/client-network-firewall"); // CommonJS import + * const client = new NetworkFirewallClient(config); + * const command = new DeleteResourcePolicyCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteResourcePolicyCommandInput} for command's `input` shape. + * @see {@link DeleteResourcePolicyCommandOutput} for command's `response` shape. + * @see {@link NetworkFirewallClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteResourcePolicyCommand extends $Command< DeleteResourcePolicyCommandInput, diff --git a/clients/client-network-firewall/commands/DeleteRuleGroupCommand.ts b/clients/client-network-firewall/commands/DeleteRuleGroupCommand.ts index c3e7255ca91a..3f3e148f2f8c 100644 --- a/clients/client-network-firewall/commands/DeleteRuleGroupCommand.ts +++ b/clients/client-network-firewall/commands/DeleteRuleGroupCommand.ts @@ -22,6 +22,20 @@ export interface DeleteRuleGroupCommandOutput extends DeleteRuleGroupResponse, _ /** *

Deletes the specified RuleGroup.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { NetworkFirewallClient, DeleteRuleGroupCommand } from "@aws-sdk/client-network-firewall"; // ES Modules import + * // const { NetworkFirewallClient, DeleteRuleGroupCommand } = require("@aws-sdk/client-network-firewall"); // CommonJS import + * const client = new NetworkFirewallClient(config); + * const command = new DeleteRuleGroupCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteRuleGroupCommandInput} for command's `input` shape. + * @see {@link DeleteRuleGroupCommandOutput} for command's `response` shape. + * @see {@link NetworkFirewallClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteRuleGroupCommand extends $Command< DeleteRuleGroupCommandInput, diff --git a/clients/client-network-firewall/commands/DescribeFirewallCommand.ts b/clients/client-network-firewall/commands/DescribeFirewallCommand.ts index 9466bbed8db9..9f7274b73ec3 100644 --- a/clients/client-network-firewall/commands/DescribeFirewallCommand.ts +++ b/clients/client-network-firewall/commands/DescribeFirewallCommand.ts @@ -22,6 +22,20 @@ export interface DescribeFirewallCommandOutput extends DescribeFirewallResponse, /** *

Returns the data objects for the specified firewall.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { NetworkFirewallClient, DescribeFirewallCommand } from "@aws-sdk/client-network-firewall"; // ES Modules import + * // const { NetworkFirewallClient, DescribeFirewallCommand } = require("@aws-sdk/client-network-firewall"); // CommonJS import + * const client = new NetworkFirewallClient(config); + * const command = new DescribeFirewallCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeFirewallCommandInput} for command's `input` shape. + * @see {@link DescribeFirewallCommandOutput} for command's `response` shape. + * @see {@link NetworkFirewallClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeFirewallCommand extends $Command< DescribeFirewallCommandInput, diff --git a/clients/client-network-firewall/commands/DescribeFirewallPolicyCommand.ts b/clients/client-network-firewall/commands/DescribeFirewallPolicyCommand.ts index 5aec8e5aa6e6..1d541c010e75 100644 --- a/clients/client-network-firewall/commands/DescribeFirewallPolicyCommand.ts +++ b/clients/client-network-firewall/commands/DescribeFirewallPolicyCommand.ts @@ -22,6 +22,20 @@ export interface DescribeFirewallPolicyCommandOutput extends DescribeFirewallPol /** *

Returns the data objects for the specified firewall policy.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { NetworkFirewallClient, DescribeFirewallPolicyCommand } from "@aws-sdk/client-network-firewall"; // ES Modules import + * // const { NetworkFirewallClient, DescribeFirewallPolicyCommand } = require("@aws-sdk/client-network-firewall"); // CommonJS import + * const client = new NetworkFirewallClient(config); + * const command = new DescribeFirewallPolicyCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeFirewallPolicyCommandInput} for command's `input` shape. + * @see {@link DescribeFirewallPolicyCommandOutput} for command's `response` shape. + * @see {@link NetworkFirewallClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeFirewallPolicyCommand extends $Command< DescribeFirewallPolicyCommandInput, diff --git a/clients/client-network-firewall/commands/DescribeLoggingConfigurationCommand.ts b/clients/client-network-firewall/commands/DescribeLoggingConfigurationCommand.ts index 275e4d388d4a..9760ca0a7abf 100644 --- a/clients/client-network-firewall/commands/DescribeLoggingConfigurationCommand.ts +++ b/clients/client-network-firewall/commands/DescribeLoggingConfigurationCommand.ts @@ -24,6 +24,20 @@ export interface DescribeLoggingConfigurationCommandOutput /** *

Returns the logging configuration for the specified firewall.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { NetworkFirewallClient, DescribeLoggingConfigurationCommand } from "@aws-sdk/client-network-firewall"; // ES Modules import + * // const { NetworkFirewallClient, DescribeLoggingConfigurationCommand } = require("@aws-sdk/client-network-firewall"); // CommonJS import + * const client = new NetworkFirewallClient(config); + * const command = new DescribeLoggingConfigurationCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeLoggingConfigurationCommandInput} for command's `input` shape. + * @see {@link DescribeLoggingConfigurationCommandOutput} for command's `response` shape. + * @see {@link NetworkFirewallClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeLoggingConfigurationCommand extends $Command< DescribeLoggingConfigurationCommandInput, diff --git a/clients/client-network-firewall/commands/DescribeResourcePolicyCommand.ts b/clients/client-network-firewall/commands/DescribeResourcePolicyCommand.ts index 7cdc67e86732..b2ec4ca58cd3 100644 --- a/clients/client-network-firewall/commands/DescribeResourcePolicyCommand.ts +++ b/clients/client-network-firewall/commands/DescribeResourcePolicyCommand.ts @@ -22,6 +22,20 @@ export interface DescribeResourcePolicyCommandOutput extends DescribeResourcePol /** *

Retrieves a resource policy that you created in a PutResourcePolicy request.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { NetworkFirewallClient, DescribeResourcePolicyCommand } from "@aws-sdk/client-network-firewall"; // ES Modules import + * // const { NetworkFirewallClient, DescribeResourcePolicyCommand } = require("@aws-sdk/client-network-firewall"); // CommonJS import + * const client = new NetworkFirewallClient(config); + * const command = new DescribeResourcePolicyCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeResourcePolicyCommandInput} for command's `input` shape. + * @see {@link DescribeResourcePolicyCommandOutput} for command's `response` shape. + * @see {@link NetworkFirewallClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeResourcePolicyCommand extends $Command< DescribeResourcePolicyCommandInput, diff --git a/clients/client-network-firewall/commands/DescribeRuleGroupCommand.ts b/clients/client-network-firewall/commands/DescribeRuleGroupCommand.ts index e6b5fea8ec87..50f90a5264dd 100644 --- a/clients/client-network-firewall/commands/DescribeRuleGroupCommand.ts +++ b/clients/client-network-firewall/commands/DescribeRuleGroupCommand.ts @@ -22,6 +22,20 @@ export interface DescribeRuleGroupCommandOutput extends DescribeRuleGroupRespons /** *

Returns the data objects for the specified rule group.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { NetworkFirewallClient, DescribeRuleGroupCommand } from "@aws-sdk/client-network-firewall"; // ES Modules import + * // const { NetworkFirewallClient, DescribeRuleGroupCommand } = require("@aws-sdk/client-network-firewall"); // CommonJS import + * const client = new NetworkFirewallClient(config); + * const command = new DescribeRuleGroupCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeRuleGroupCommandInput} for command's `input` shape. + * @see {@link DescribeRuleGroupCommandOutput} for command's `response` shape. + * @see {@link NetworkFirewallClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeRuleGroupCommand extends $Command< DescribeRuleGroupCommandInput, diff --git a/clients/client-network-firewall/commands/DisassociateSubnetsCommand.ts b/clients/client-network-firewall/commands/DisassociateSubnetsCommand.ts index 85e1ccae393d..67c49cd0dc31 100644 --- a/clients/client-network-firewall/commands/DisassociateSubnetsCommand.ts +++ b/clients/client-network-firewall/commands/DisassociateSubnetsCommand.ts @@ -25,6 +25,20 @@ export interface DisassociateSubnetsCommandOutput extends DisassociateSubnetsRes * firewall endpoints from the subnets and removes any network filtering protections that the endpoints * were providing. *

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { NetworkFirewallClient, DisassociateSubnetsCommand } from "@aws-sdk/client-network-firewall"; // ES Modules import + * // const { NetworkFirewallClient, DisassociateSubnetsCommand } = require("@aws-sdk/client-network-firewall"); // CommonJS import + * const client = new NetworkFirewallClient(config); + * const command = new DisassociateSubnetsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DisassociateSubnetsCommandInput} for command's `input` shape. + * @see {@link DisassociateSubnetsCommandOutput} for command's `response` shape. + * @see {@link NetworkFirewallClientResolvedConfig | config} for command's `input` shape. + * */ export class DisassociateSubnetsCommand extends $Command< DisassociateSubnetsCommandInput, diff --git a/clients/client-network-firewall/commands/ListFirewallPoliciesCommand.ts b/clients/client-network-firewall/commands/ListFirewallPoliciesCommand.ts index 6f26a1e16f41..07fe10305ec0 100644 --- a/clients/client-network-firewall/commands/ListFirewallPoliciesCommand.ts +++ b/clients/client-network-firewall/commands/ListFirewallPoliciesCommand.ts @@ -24,6 +24,20 @@ export interface ListFirewallPoliciesCommandOutput extends ListFirewallPoliciesR *

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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { NetworkFirewallClient, ListFirewallPoliciesCommand } from "@aws-sdk/client-network-firewall"; // ES Modules import + * // const { NetworkFirewallClient, ListFirewallPoliciesCommand } = require("@aws-sdk/client-network-firewall"); // CommonJS import + * const client = new NetworkFirewallClient(config); + * const command = new ListFirewallPoliciesCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListFirewallPoliciesCommandInput} for command's `input` shape. + * @see {@link ListFirewallPoliciesCommandOutput} for command's `response` shape. + * @see {@link NetworkFirewallClientResolvedConfig | config} for command's `input` shape. + * */ export class ListFirewallPoliciesCommand extends $Command< ListFirewallPoliciesCommandInput, diff --git a/clients/client-network-firewall/commands/ListFirewallsCommand.ts b/clients/client-network-firewall/commands/ListFirewallsCommand.ts index 080ea1dac16f..54e282f73925 100644 --- a/clients/client-network-firewall/commands/ListFirewallsCommand.ts +++ b/clients/client-network-firewall/commands/ListFirewallsCommand.ts @@ -25,6 +25,20 @@ export interface ListFirewallsCommandOutput extends ListFirewallsResponse, __Met * 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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { NetworkFirewallClient, ListFirewallsCommand } from "@aws-sdk/client-network-firewall"; // ES Modules import + * // const { NetworkFirewallClient, ListFirewallsCommand } = require("@aws-sdk/client-network-firewall"); // CommonJS import + * const client = new NetworkFirewallClient(config); + * const command = new ListFirewallsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListFirewallsCommandInput} for command's `input` shape. + * @see {@link ListFirewallsCommandOutput} for command's `response` shape. + * @see {@link NetworkFirewallClientResolvedConfig | config} for command's `input` shape. + * */ export class ListFirewallsCommand extends $Command< ListFirewallsCommandInput, diff --git a/clients/client-network-firewall/commands/ListRuleGroupsCommand.ts b/clients/client-network-firewall/commands/ListRuleGroupsCommand.ts index 29f31a655ac2..e98842fd3172 100644 --- a/clients/client-network-firewall/commands/ListRuleGroupsCommand.ts +++ b/clients/client-network-firewall/commands/ListRuleGroupsCommand.ts @@ -24,6 +24,20 @@ export interface ListRuleGroupsCommandOutput extends ListRuleGroupsResponse, __M *

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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { NetworkFirewallClient, ListRuleGroupsCommand } from "@aws-sdk/client-network-firewall"; // ES Modules import + * // const { NetworkFirewallClient, ListRuleGroupsCommand } = require("@aws-sdk/client-network-firewall"); // CommonJS import + * const client = new NetworkFirewallClient(config); + * const command = new ListRuleGroupsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListRuleGroupsCommandInput} for command's `input` shape. + * @see {@link ListRuleGroupsCommandOutput} for command's `response` shape. + * @see {@link NetworkFirewallClientResolvedConfig | config} for command's `input` shape. + * */ export class ListRuleGroupsCommand extends $Command< ListRuleGroupsCommandInput, diff --git a/clients/client-network-firewall/commands/ListTagsForResourceCommand.ts b/clients/client-network-firewall/commands/ListTagsForResourceCommand.ts index a1319bec12e3..e562afe99d9d 100644 --- a/clients/client-network-firewall/commands/ListTagsForResourceCommand.ts +++ b/clients/client-network-firewall/commands/ListTagsForResourceCommand.ts @@ -28,6 +28,20 @@ export interface ListTagsForResourceCommandOutput extends ListTagsForResourceRes * resource.

*

You can tag the AWS resources that you manage through AWS Network Firewall: firewalls, firewall * policies, and rule groups.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { NetworkFirewallClient, ListTagsForResourceCommand } from "@aws-sdk/client-network-firewall"; // ES Modules import + * // const { NetworkFirewallClient, ListTagsForResourceCommand } = require("@aws-sdk/client-network-firewall"); // CommonJS import + * const client = new NetworkFirewallClient(config); + * const command = new ListTagsForResourceCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListTagsForResourceCommandInput} for command's `input` shape. + * @see {@link ListTagsForResourceCommandOutput} for command's `response` shape. + * @see {@link NetworkFirewallClientResolvedConfig | config} for command's `input` shape. + * */ export class ListTagsForResourceCommand extends $Command< ListTagsForResourceCommandInput, diff --git a/clients/client-network-firewall/commands/PutResourcePolicyCommand.ts b/clients/client-network-firewall/commands/PutResourcePolicyCommand.ts index b588a38c7c68..998e03299cea 100644 --- a/clients/client-network-firewall/commands/PutResourcePolicyCommand.ts +++ b/clients/client-network-firewall/commands/PutResourcePolicyCommand.ts @@ -36,6 +36,20 @@ export interface PutResourcePolicyCommandOutput extends PutResourcePolicyRespons * * *

For additional information about resource sharing using RAM, see AWS Resource Access Manager User Guide.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { NetworkFirewallClient, PutResourcePolicyCommand } from "@aws-sdk/client-network-firewall"; // ES Modules import + * // const { NetworkFirewallClient, PutResourcePolicyCommand } = require("@aws-sdk/client-network-firewall"); // CommonJS import + * const client = new NetworkFirewallClient(config); + * const command = new PutResourcePolicyCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link PutResourcePolicyCommandInput} for command's `input` shape. + * @see {@link PutResourcePolicyCommandOutput} for command's `response` shape. + * @see {@link NetworkFirewallClientResolvedConfig | config} for command's `input` shape. + * */ export class PutResourcePolicyCommand extends $Command< PutResourcePolicyCommandInput, diff --git a/clients/client-network-firewall/commands/TagResourceCommand.ts b/clients/client-network-firewall/commands/TagResourceCommand.ts index a6e47fe0c6a1..bc3af252b3a9 100644 --- a/clients/client-network-firewall/commands/TagResourceCommand.ts +++ b/clients/client-network-firewall/commands/TagResourceCommand.ts @@ -27,6 +27,20 @@ export interface TagResourceCommandOutput extends TagResourceResponse, __Metadat * specify one or more tags to add to each AWS resource, up to 50 tags for a resource.

*

You can tag the AWS resources that you manage through AWS Network Firewall: firewalls, firewall * policies, and rule groups.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { NetworkFirewallClient, TagResourceCommand } from "@aws-sdk/client-network-firewall"; // ES Modules import + * // const { NetworkFirewallClient, TagResourceCommand } = require("@aws-sdk/client-network-firewall"); // CommonJS import + * const client = new NetworkFirewallClient(config); + * const command = new TagResourceCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link TagResourceCommandInput} for command's `input` shape. + * @see {@link TagResourceCommandOutput} for command's `response` shape. + * @see {@link NetworkFirewallClientResolvedConfig | config} for command's `input` shape. + * */ export class TagResourceCommand extends $Command< TagResourceCommandInput, diff --git a/clients/client-network-firewall/commands/UntagResourceCommand.ts b/clients/client-network-firewall/commands/UntagResourceCommand.ts index 1799e7b6ea6c..a5fb8aace0f1 100644 --- a/clients/client-network-firewall/commands/UntagResourceCommand.ts +++ b/clients/client-network-firewall/commands/UntagResourceCommand.ts @@ -28,6 +28,20 @@ export interface UntagResourceCommandOutput extends UntagResourceResponse, __Met * resource.

*

You can manage tags for the AWS resources that you manage through AWS Network Firewall: * firewalls, firewall policies, and rule groups.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { NetworkFirewallClient, UntagResourceCommand } from "@aws-sdk/client-network-firewall"; // ES Modules import + * // const { NetworkFirewallClient, UntagResourceCommand } = require("@aws-sdk/client-network-firewall"); // CommonJS import + * const client = new NetworkFirewallClient(config); + * const command = new UntagResourceCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link UntagResourceCommandInput} for command's `input` shape. + * @see {@link UntagResourceCommandOutput} for command's `response` shape. + * @see {@link NetworkFirewallClientResolvedConfig | config} for command's `input` shape. + * */ export class UntagResourceCommand extends $Command< UntagResourceCommandInput, diff --git a/clients/client-network-firewall/commands/UpdateFirewallDeleteProtectionCommand.ts b/clients/client-network-firewall/commands/UpdateFirewallDeleteProtectionCommand.ts index 1bb9deacdc37..b7241ec15ab2 100644 --- a/clients/client-network-firewall/commands/UpdateFirewallDeleteProtectionCommand.ts +++ b/clients/client-network-firewall/commands/UpdateFirewallDeleteProtectionCommand.ts @@ -27,6 +27,20 @@ export interface UpdateFirewallDeleteProtectionCommandOutput * 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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { NetworkFirewallClient, UpdateFirewallDeleteProtectionCommand } from "@aws-sdk/client-network-firewall"; // ES Modules import + * // const { NetworkFirewallClient, UpdateFirewallDeleteProtectionCommand } = require("@aws-sdk/client-network-firewall"); // CommonJS import + * const client = new NetworkFirewallClient(config); + * const command = new UpdateFirewallDeleteProtectionCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link UpdateFirewallDeleteProtectionCommandInput} for command's `input` shape. + * @see {@link UpdateFirewallDeleteProtectionCommandOutput} for command's `response` shape. + * @see {@link NetworkFirewallClientResolvedConfig | config} for command's `input` shape. + * */ export class UpdateFirewallDeleteProtectionCommand extends $Command< UpdateFirewallDeleteProtectionCommandInput, diff --git a/clients/client-network-firewall/commands/UpdateFirewallDescriptionCommand.ts b/clients/client-network-firewall/commands/UpdateFirewallDescriptionCommand.ts index f28e882ca244..9643661609f2 100644 --- a/clients/client-network-firewall/commands/UpdateFirewallDescriptionCommand.ts +++ b/clients/client-network-firewall/commands/UpdateFirewallDescriptionCommand.ts @@ -23,6 +23,20 @@ export interface UpdateFirewallDescriptionCommandOutput extends UpdateFirewallDe /** *

Modifies the description for the specified firewall. Use the description to help you * identify the firewall when you're working with it.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { NetworkFirewallClient, UpdateFirewallDescriptionCommand } from "@aws-sdk/client-network-firewall"; // ES Modules import + * // const { NetworkFirewallClient, UpdateFirewallDescriptionCommand } = require("@aws-sdk/client-network-firewall"); // CommonJS import + * const client = new NetworkFirewallClient(config); + * const command = new UpdateFirewallDescriptionCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link UpdateFirewallDescriptionCommandInput} for command's `input` shape. + * @see {@link UpdateFirewallDescriptionCommandOutput} for command's `response` shape. + * @see {@link NetworkFirewallClientResolvedConfig | config} for command's `input` shape. + * */ export class UpdateFirewallDescriptionCommand extends $Command< UpdateFirewallDescriptionCommandInput, diff --git a/clients/client-network-firewall/commands/UpdateFirewallPolicyChangeProtectionCommand.ts b/clients/client-network-firewall/commands/UpdateFirewallPolicyChangeProtectionCommand.ts index 8136c4fbbd5d..5f56a0abf010 100644 --- a/clients/client-network-firewall/commands/UpdateFirewallPolicyChangeProtectionCommand.ts +++ b/clients/client-network-firewall/commands/UpdateFirewallPolicyChangeProtectionCommand.ts @@ -27,6 +27,20 @@ export interface UpdateFirewallPolicyChangeProtectionCommandOutput /** *

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { NetworkFirewallClient, UpdateFirewallPolicyChangeProtectionCommand } from "@aws-sdk/client-network-firewall"; // ES Modules import + * // const { NetworkFirewallClient, UpdateFirewallPolicyChangeProtectionCommand } = require("@aws-sdk/client-network-firewall"); // CommonJS import + * const client = new NetworkFirewallClient(config); + * const command = new UpdateFirewallPolicyChangeProtectionCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link UpdateFirewallPolicyChangeProtectionCommandInput} for command's `input` shape. + * @see {@link UpdateFirewallPolicyChangeProtectionCommandOutput} for command's `response` shape. + * @see {@link NetworkFirewallClientResolvedConfig | config} for command's `input` shape. + * */ export class UpdateFirewallPolicyChangeProtectionCommand extends $Command< UpdateFirewallPolicyChangeProtectionCommandInput, diff --git a/clients/client-network-firewall/commands/UpdateFirewallPolicyCommand.ts b/clients/client-network-firewall/commands/UpdateFirewallPolicyCommand.ts index b1b166999051..d40ea749f96f 100644 --- a/clients/client-network-firewall/commands/UpdateFirewallPolicyCommand.ts +++ b/clients/client-network-firewall/commands/UpdateFirewallPolicyCommand.ts @@ -22,6 +22,20 @@ export interface UpdateFirewallPolicyCommandOutput extends UpdateFirewallPolicyR /** *

Updates the properties of the specified firewall policy.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { NetworkFirewallClient, UpdateFirewallPolicyCommand } from "@aws-sdk/client-network-firewall"; // ES Modules import + * // const { NetworkFirewallClient, UpdateFirewallPolicyCommand } = require("@aws-sdk/client-network-firewall"); // CommonJS import + * const client = new NetworkFirewallClient(config); + * const command = new UpdateFirewallPolicyCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link UpdateFirewallPolicyCommandInput} for command's `input` shape. + * @see {@link UpdateFirewallPolicyCommandOutput} for command's `response` shape. + * @see {@link NetworkFirewallClientResolvedConfig | config} for command's `input` shape. + * */ export class UpdateFirewallPolicyCommand extends $Command< UpdateFirewallPolicyCommandInput, diff --git a/clients/client-network-firewall/commands/UpdateLoggingConfigurationCommand.ts b/clients/client-network-firewall/commands/UpdateLoggingConfigurationCommand.ts index 5d9411e568b1..e76da5d8261e 100644 --- a/clients/client-network-firewall/commands/UpdateLoggingConfigurationCommand.ts +++ b/clients/client-network-firewall/commands/UpdateLoggingConfigurationCommand.ts @@ -47,6 +47,20 @@ export interface UpdateLoggingConfigurationCommandOutput extends UpdateLoggingCo * LogDestinationConfig. To change these settings, delete the existing * LogDestinationConfig object and create a new one, using two separate calls * to this update operation.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { NetworkFirewallClient, UpdateLoggingConfigurationCommand } from "@aws-sdk/client-network-firewall"; // ES Modules import + * // const { NetworkFirewallClient, UpdateLoggingConfigurationCommand } = require("@aws-sdk/client-network-firewall"); // CommonJS import + * const client = new NetworkFirewallClient(config); + * const command = new UpdateLoggingConfigurationCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link UpdateLoggingConfigurationCommandInput} for command's `input` shape. + * @see {@link UpdateLoggingConfigurationCommandOutput} for command's `response` shape. + * @see {@link NetworkFirewallClientResolvedConfig | config} for command's `input` shape. + * */ export class UpdateLoggingConfigurationCommand extends $Command< UpdateLoggingConfigurationCommandInput, diff --git a/clients/client-network-firewall/commands/UpdateRuleGroupCommand.ts b/clients/client-network-firewall/commands/UpdateRuleGroupCommand.ts index 39344f7befd2..80467265a9c7 100644 --- a/clients/client-network-firewall/commands/UpdateRuleGroupCommand.ts +++ b/clients/client-network-firewall/commands/UpdateRuleGroupCommand.ts @@ -27,6 +27,20 @@ export interface UpdateRuleGroupCommandOutput extends UpdateRuleGroupResponse, _ *

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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { NetworkFirewallClient, UpdateRuleGroupCommand } from "@aws-sdk/client-network-firewall"; // ES Modules import + * // const { NetworkFirewallClient, UpdateRuleGroupCommand } = require("@aws-sdk/client-network-firewall"); // CommonJS import + * const client = new NetworkFirewallClient(config); + * const command = new UpdateRuleGroupCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link UpdateRuleGroupCommandInput} for command's `input` shape. + * @see {@link UpdateRuleGroupCommandOutput} for command's `response` shape. + * @see {@link NetworkFirewallClientResolvedConfig | config} for command's `input` shape. + * */ export class UpdateRuleGroupCommand extends $Command< UpdateRuleGroupCommandInput, diff --git a/clients/client-network-firewall/commands/UpdateSubnetChangeProtectionCommand.ts b/clients/client-network-firewall/commands/UpdateSubnetChangeProtectionCommand.ts index 1298e38f5ae6..3e8dccd7ad8c 100644 --- a/clients/client-network-firewall/commands/UpdateSubnetChangeProtectionCommand.ts +++ b/clients/client-network-firewall/commands/UpdateSubnetChangeProtectionCommand.ts @@ -24,6 +24,20 @@ export interface UpdateSubnetChangeProtectionCommandOutput /** *

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { NetworkFirewallClient, UpdateSubnetChangeProtectionCommand } from "@aws-sdk/client-network-firewall"; // ES Modules import + * // const { NetworkFirewallClient, UpdateSubnetChangeProtectionCommand } = require("@aws-sdk/client-network-firewall"); // CommonJS import + * const client = new NetworkFirewallClient(config); + * const command = new UpdateSubnetChangeProtectionCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link UpdateSubnetChangeProtectionCommandInput} for command's `input` shape. + * @see {@link UpdateSubnetChangeProtectionCommandOutput} for command's `response` shape. + * @see {@link NetworkFirewallClientResolvedConfig | config} for command's `input` shape. + * */ export class UpdateSubnetChangeProtectionCommand extends $Command< UpdateSubnetChangeProtectionCommandInput, diff --git a/clients/client-network-firewall/models/models_0.ts b/clients/client-network-firewall/models/models_0.ts index 59d2bc0a2e47..d750f1342b1f 100644 --- a/clients/client-network-firewall/models/models_0.ts +++ b/clients/client-network-firewall/models/models_0.ts @@ -19,6 +19,9 @@ export interface Dimension { } export namespace Dimension { + /** + * @internal + */ export const filterSensitiveLog = (obj: Dimension): any => ({ ...obj, }); @@ -36,6 +39,9 @@ export interface PublishMetricAction { } export namespace PublishMetricAction { + /** + * @internal + */ export const filterSensitiveLog = (obj: PublishMetricAction): any => ({ ...obj, }); @@ -57,6 +63,9 @@ export interface ActionDefinition { } export namespace ActionDefinition { + /** + * @internal + */ export const filterSensitiveLog = (obj: ActionDefinition): any => ({ ...obj, }); @@ -85,6 +94,9 @@ export interface Address { } export namespace Address { + /** + * @internal + */ export const filterSensitiveLog = (obj: Address): any => ({ ...obj, }); @@ -117,6 +129,9 @@ export interface AssociateFirewallPolicyRequest { } export namespace AssociateFirewallPolicyRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: AssociateFirewallPolicyRequest): any => ({ ...obj, }); @@ -147,6 +162,9 @@ export interface AssociateFirewallPolicyResponse { } export namespace AssociateFirewallPolicyResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: AssociateFirewallPolicyResponse): any => ({ ...obj, }); @@ -163,6 +181,9 @@ export interface InternalServerError extends __SmithyException, $MetadataBearer } export namespace InternalServerError { + /** + * @internal + */ export const filterSensitiveLog = (obj: InternalServerError): any => ({ ...obj, }); @@ -179,6 +200,9 @@ export interface InvalidOperationException extends __SmithyException, $MetadataB } export namespace InvalidOperationException { + /** + * @internal + */ export const filterSensitiveLog = (obj: InvalidOperationException): any => ({ ...obj, }); @@ -207,6 +231,9 @@ export interface InvalidRequestException extends __SmithyException, $MetadataBea } export namespace InvalidRequestException { + /** + * @internal + */ export const filterSensitiveLog = (obj: InvalidRequestException): any => ({ ...obj, }); @@ -222,6 +249,9 @@ export interface InvalidTokenException extends __SmithyException, $MetadataBeare } export namespace InvalidTokenException { + /** + * @internal + */ export const filterSensitiveLog = (obj: InvalidTokenException): any => ({ ...obj, }); @@ -237,6 +267,9 @@ export interface ResourceNotFoundException extends __SmithyException, $MetadataB } export namespace ResourceNotFoundException { + /** + * @internal + */ export const filterSensitiveLog = (obj: ResourceNotFoundException): any => ({ ...obj, }); @@ -252,6 +285,9 @@ export interface ThrottlingException extends __SmithyException, $MetadataBearer } export namespace ThrottlingException { + /** + * @internal + */ export const filterSensitiveLog = (obj: ThrottlingException): any => ({ ...obj, }); @@ -271,6 +307,9 @@ export interface SubnetMapping { } export namespace SubnetMapping { + /** + * @internal + */ export const filterSensitiveLog = (obj: SubnetMapping): any => ({ ...obj, }); @@ -303,6 +342,9 @@ export interface AssociateSubnetsRequest { } export namespace AssociateSubnetsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: AssociateSubnetsRequest): any => ({ ...obj, }); @@ -333,6 +375,9 @@ export interface AssociateSubnetsResponse { } export namespace AssociateSubnetsResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: AssociateSubnetsResponse): any => ({ ...obj, }); @@ -349,6 +394,9 @@ export interface InsufficientCapacityException extends __SmithyException, $Metad } export namespace InsufficientCapacityException { + /** + * @internal + */ export const filterSensitiveLog = (obj: InsufficientCapacityException): any => ({ ...obj, }); @@ -391,6 +439,9 @@ export interface Attachment { } export namespace Attachment { + /** + * @internal + */ export const filterSensitiveLog = (obj: Attachment): any => ({ ...obj, }); @@ -423,6 +474,9 @@ export interface Tag { } export namespace Tag { + /** + * @internal + */ export const filterSensitiveLog = (obj: Tag): any => ({ ...obj, }); @@ -486,6 +540,9 @@ export interface CreateFirewallRequest { } export namespace CreateFirewallRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateFirewallRequest): any => ({ ...obj, }); @@ -565,6 +622,9 @@ export interface Firewall { } export namespace Firewall { + /** + * @internal + */ export const filterSensitiveLog = (obj: Firewall): any => ({ ...obj, }); @@ -600,6 +660,9 @@ export interface PerObjectStatus { } export namespace PerObjectStatus { + /** + * @internal + */ export const filterSensitiveLog = (obj: PerObjectStatus): any => ({ ...obj, }); @@ -641,6 +704,9 @@ export interface SyncState { } export namespace SyncState { + /** + * @internal + */ export const filterSensitiveLog = (obj: SyncState): any => ({ ...obj, }); @@ -685,6 +751,9 @@ export interface FirewallStatus { } export namespace FirewallStatus { + /** + * @internal + */ export const filterSensitiveLog = (obj: FirewallStatus): any => ({ ...obj, }); @@ -703,6 +772,9 @@ export interface CreateFirewallResponse { } export namespace CreateFirewallResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateFirewallResponse): any => ({ ...obj, }); @@ -718,6 +790,9 @@ export interface LimitExceededException extends __SmithyException, $MetadataBear } export namespace LimitExceededException { + /** + * @internal + */ export const filterSensitiveLog = (obj: LimitExceededException): any => ({ ...obj, }); @@ -735,6 +810,9 @@ export interface StatefulRuleGroupReference { } export namespace StatefulRuleGroupReference { + /** + * @internal + */ export const filterSensitiveLog = (obj: StatefulRuleGroupReference): any => ({ ...obj, }); @@ -776,6 +854,9 @@ export interface CustomAction { } export namespace CustomAction { + /** + * @internal + */ export const filterSensitiveLog = (obj: CustomAction): any => ({ ...obj, }); @@ -801,6 +882,9 @@ export interface StatelessRuleGroupReference { } export namespace StatelessRuleGroupReference { + /** + * @internal + */ export const filterSensitiveLog = (obj: StatelessRuleGroupReference): any => ({ ...obj, }); @@ -862,6 +946,9 @@ export interface FirewallPolicy { } export namespace FirewallPolicy { + /** + * @internal + */ export const filterSensitiveLog = (obj: FirewallPolicy): any => ({ ...obj, }); @@ -900,6 +987,9 @@ export interface CreateFirewallPolicyRequest { } export namespace CreateFirewallPolicyRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateFirewallPolicyRequest): any => ({ ...obj, }); @@ -953,6 +1043,9 @@ export interface FirewallPolicyResponse { } export namespace FirewallPolicyResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: FirewallPolicyResponse): any => ({ ...obj, }); @@ -972,6 +1065,9 @@ export interface CreateFirewallPolicyResponse { } export namespace CreateFirewallPolicyResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateFirewallPolicyResponse): any => ({ ...obj, }); @@ -1020,6 +1116,9 @@ export interface RulesSourceList { } export namespace RulesSourceList { + /** + * @internal + */ export const filterSensitiveLog = (obj: RulesSourceList): any => ({ ...obj, }); @@ -1131,6 +1230,9 @@ export interface Header { } export namespace Header { + /** + * @internal + */ export const filterSensitiveLog = (obj: Header): any => ({ ...obj, }); @@ -1152,6 +1254,9 @@ export interface RuleOption { } export namespace RuleOption { + /** + * @internal + */ export const filterSensitiveLog = (obj: RuleOption): any => ({ ...obj, }); @@ -1204,6 +1309,9 @@ export interface StatefulRule { } export namespace StatefulRule { + /** + * @internal + */ export const filterSensitiveLog = (obj: StatefulRule): any => ({ ...obj, }); @@ -1229,6 +1337,9 @@ export interface PortRange { } export namespace PortRange { + /** + * @internal + */ export const filterSensitiveLog = (obj: PortRange): any => ({ ...obj, }); @@ -1270,6 +1381,9 @@ export interface TCPFlagField { } export namespace TCPFlagField { + /** + * @internal + */ export const filterSensitiveLog = (obj: TCPFlagField): any => ({ ...obj, }); @@ -1321,6 +1435,9 @@ export interface MatchAttributes { } export namespace MatchAttributes { + /** + * @internal + */ export const filterSensitiveLog = (obj: MatchAttributes): any => ({ ...obj, }); @@ -1380,6 +1497,9 @@ export interface RuleDefinition { } export namespace RuleDefinition { + /** + * @internal + */ export const filterSensitiveLog = (obj: RuleDefinition): any => ({ ...obj, }); @@ -1413,6 +1533,9 @@ export interface StatelessRule { } export namespace StatelessRule { + /** + * @internal + */ export const filterSensitiveLog = (obj: StatelessRule): any => ({ ...obj, }); @@ -1439,6 +1562,9 @@ export interface StatelessRulesAndCustomActions { } export namespace StatelessRulesAndCustomActions { + /** + * @internal + */ export const filterSensitiveLog = (obj: StatelessRulesAndCustomActions): any => ({ ...obj, }); @@ -1478,6 +1604,9 @@ export interface RulesSource { } export namespace RulesSource { + /** + * @internal + */ export const filterSensitiveLog = (obj: RulesSource): any => ({ ...obj, }); @@ -1496,6 +1625,9 @@ export interface IPSet { } export namespace IPSet { + /** + * @internal + */ export const filterSensitiveLog = (obj: IPSet): any => ({ ...obj, }); @@ -1513,6 +1645,9 @@ export interface PortSet { } export namespace PortSet { + /** + * @internal + */ export const filterSensitiveLog = (obj: PortSet): any => ({ ...obj, }); @@ -1535,6 +1670,9 @@ export interface RuleVariables { } export namespace RuleVariables { + /** + * @internal + */ export const filterSensitiveLog = (obj: RuleVariables): any => ({ ...obj, }); @@ -1562,6 +1700,9 @@ export interface RuleGroup { } export namespace RuleGroup { + /** + * @internal + */ export const filterSensitiveLog = (obj: RuleGroup): any => ({ ...obj, }); @@ -1670,6 +1811,9 @@ export interface CreateRuleGroupRequest { } export namespace CreateRuleGroupRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateRuleGroupRequest): any => ({ ...obj, }); @@ -1731,6 +1875,9 @@ export interface RuleGroupResponse { } export namespace RuleGroupResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: RuleGroupResponse): any => ({ ...obj, }); @@ -1750,6 +1897,9 @@ export interface CreateRuleGroupResponse { } export namespace CreateRuleGroupResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateRuleGroupResponse): any => ({ ...obj, }); @@ -1770,6 +1920,9 @@ export interface DeleteFirewallRequest { } export namespace DeleteFirewallRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteFirewallRequest): any => ({ ...obj, }); @@ -1791,6 +1944,9 @@ export interface DeleteFirewallResponse { } export namespace DeleteFirewallResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteFirewallResponse): any => ({ ...obj, }); @@ -1806,6 +1962,9 @@ export interface UnsupportedOperationException extends __SmithyException, $Metad } export namespace UnsupportedOperationException { + /** + * @internal + */ export const filterSensitiveLog = (obj: UnsupportedOperationException): any => ({ ...obj, }); @@ -1826,6 +1985,9 @@ export interface DeleteFirewallPolicyRequest { } export namespace DeleteFirewallPolicyRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteFirewallPolicyRequest): any => ({ ...obj, }); @@ -1840,6 +2002,9 @@ export interface DeleteFirewallPolicyResponse { } export namespace DeleteFirewallPolicyResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteFirewallPolicyResponse): any => ({ ...obj, }); @@ -1853,6 +2018,9 @@ export interface DeleteResourcePolicyRequest { } export namespace DeleteResourcePolicyRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteResourcePolicyRequest): any => ({ ...obj, }); @@ -1861,6 +2029,9 @@ export namespace DeleteResourcePolicyRequest { export interface DeleteResourcePolicyResponse {} export namespace DeleteResourcePolicyResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteResourcePolicyResponse): any => ({ ...obj, }); @@ -1890,6 +2061,9 @@ export interface DeleteRuleGroupRequest { } export namespace DeleteRuleGroupRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteRuleGroupRequest): any => ({ ...obj, }); @@ -1903,6 +2077,9 @@ export interface DeleteRuleGroupResponse { } export namespace DeleteRuleGroupResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteRuleGroupResponse): any => ({ ...obj, }); @@ -1923,6 +2100,9 @@ export interface DescribeFirewallRequest { } export namespace DescribeFirewallRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeFirewallRequest): any => ({ ...obj, }); @@ -1948,6 +2128,9 @@ export interface DescribeFirewallResponse { } export namespace DescribeFirewallResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeFirewallResponse): any => ({ ...obj, }); @@ -1968,6 +2151,9 @@ export interface DescribeFirewallPolicyRequest { } export namespace DescribeFirewallPolicyRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeFirewallPolicyRequest): any => ({ ...obj, }); @@ -1992,6 +2178,9 @@ export interface DescribeFirewallPolicyResponse { } export namespace DescribeFirewallPolicyResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeFirewallPolicyResponse): any => ({ ...obj, }); @@ -2012,6 +2201,9 @@ export interface DescribeLoggingConfigurationRequest { } export namespace DescribeLoggingConfigurationRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeLoggingConfigurationRequest): any => ({ ...obj, }); @@ -2086,6 +2278,9 @@ export interface LogDestinationConfig { } export namespace LogDestinationConfig { + /** + * @internal + */ export const filterSensitiveLog = (obj: LogDestinationConfig): any => ({ ...obj, }); @@ -2103,6 +2298,9 @@ export interface LoggingConfiguration { } export namespace LoggingConfiguration { + /** + * @internal + */ export const filterSensitiveLog = (obj: LoggingConfiguration): any => ({ ...obj, }); @@ -2121,6 +2319,9 @@ export interface DescribeLoggingConfigurationResponse { } export namespace DescribeLoggingConfigurationResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeLoggingConfigurationResponse): any => ({ ...obj, }); @@ -2134,6 +2335,9 @@ export interface DescribeResourcePolicyRequest { } export namespace DescribeResourcePolicyRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeResourcePolicyRequest): any => ({ ...obj, }); @@ -2147,6 +2351,9 @@ export interface DescribeResourcePolicyResponse { } export namespace DescribeResourcePolicyResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeResourcePolicyResponse): any => ({ ...obj, }); @@ -2176,6 +2383,9 @@ export interface DescribeRuleGroupRequest { } export namespace DescribeRuleGroupRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeRuleGroupRequest): any => ({ ...obj, }); @@ -2205,6 +2415,9 @@ export interface DescribeRuleGroupResponse { } export namespace DescribeRuleGroupResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeRuleGroupResponse): any => ({ ...obj, }); @@ -2237,6 +2450,9 @@ export interface DisassociateSubnetsRequest { } export namespace DisassociateSubnetsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DisassociateSubnetsRequest): any => ({ ...obj, }); @@ -2267,6 +2483,9 @@ export interface DisassociateSubnetsResponse { } export namespace DisassociateSubnetsResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DisassociateSubnetsResponse): any => ({ ...obj, }); @@ -2290,6 +2509,9 @@ export interface FirewallMetadata { } export namespace FirewallMetadata { + /** + * @internal + */ export const filterSensitiveLog = (obj: FirewallMetadata): any => ({ ...obj, }); @@ -2313,6 +2535,9 @@ export interface FirewallPolicyMetadata { } export namespace FirewallPolicyMetadata { + /** + * @internal + */ export const filterSensitiveLog = (obj: FirewallPolicyMetadata): any => ({ ...obj, }); @@ -2328,6 +2553,9 @@ export interface InvalidResourcePolicyException extends __SmithyException, $Meta } export namespace InvalidResourcePolicyException { + /** + * @internal + */ export const filterSensitiveLog = (obj: InvalidResourcePolicyException): any => ({ ...obj, }); @@ -2350,6 +2578,9 @@ export interface ListFirewallPoliciesRequest { } export namespace ListFirewallPoliciesRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListFirewallPoliciesRequest): any => ({ ...obj, }); @@ -2371,6 +2602,9 @@ export interface ListFirewallPoliciesResponse { } export namespace ListFirewallPoliciesResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListFirewallPoliciesResponse): any => ({ ...obj, }); @@ -2399,6 +2633,9 @@ export interface ListFirewallsRequest { } export namespace ListFirewallsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListFirewallsRequest): any => ({ ...obj, }); @@ -2421,6 +2658,9 @@ export interface ListFirewallsResponse { } export namespace ListFirewallsResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListFirewallsResponse): any => ({ ...obj, }); @@ -2443,6 +2683,9 @@ export interface ListRuleGroupsRequest { } export namespace ListRuleGroupsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListRuleGroupsRequest): any => ({ ...obj, }); @@ -2466,6 +2709,9 @@ export interface RuleGroupMetadata { } export namespace RuleGroupMetadata { + /** + * @internal + */ export const filterSensitiveLog = (obj: RuleGroupMetadata): any => ({ ...obj, }); @@ -2487,6 +2733,9 @@ export interface ListRuleGroupsResponse { } export namespace ListRuleGroupsResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListRuleGroupsResponse): any => ({ ...obj, }); @@ -2514,6 +2763,9 @@ export interface ListTagsForResourceRequest { } export namespace ListTagsForResourceRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListTagsForResourceRequest): any => ({ ...obj, }); @@ -2534,6 +2786,9 @@ export interface ListTagsForResourceResponse { } export namespace ListTagsForResourceResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListTagsForResourceResponse): any => ({ ...obj, }); @@ -2549,6 +2804,9 @@ export interface LogDestinationPermissionException extends __SmithyException, $M } export namespace LogDestinationPermissionException { + /** + * @internal + */ export const filterSensitiveLog = (obj: LogDestinationPermissionException): any => ({ ...obj, }); @@ -2596,6 +2854,9 @@ export interface PutResourcePolicyRequest { } export namespace PutResourcePolicyRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: PutResourcePolicyRequest): any => ({ ...obj, }); @@ -2604,6 +2865,9 @@ export namespace PutResourcePolicyRequest { export interface PutResourcePolicyResponse {} export namespace PutResourcePolicyResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: PutResourcePolicyResponse): any => ({ ...obj, }); @@ -2622,6 +2886,9 @@ export interface TagResourceRequest { } export namespace TagResourceRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: TagResourceRequest): any => ({ ...obj, }); @@ -2630,6 +2897,9 @@ export namespace TagResourceRequest { export interface TagResourceResponse {} export namespace TagResourceResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: TagResourceResponse): any => ({ ...obj, }); @@ -2648,6 +2918,9 @@ export interface UntagResourceRequest { } export namespace UntagResourceRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: UntagResourceRequest): any => ({ ...obj, }); @@ -2656,6 +2929,9 @@ export namespace UntagResourceRequest { export interface UntagResourceResponse {} export namespace UntagResourceResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: UntagResourceResponse): any => ({ ...obj, }); @@ -2671,6 +2947,9 @@ export interface ResourceOwnerCheckException extends __SmithyException, $Metadat } export namespace ResourceOwnerCheckException { + /** + * @internal + */ export const filterSensitiveLog = (obj: ResourceOwnerCheckException): any => ({ ...obj, }); @@ -2705,6 +2984,9 @@ export interface UpdateFirewallDeleteProtectionRequest { } export namespace UpdateFirewallDeleteProtectionRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateFirewallDeleteProtectionRequest): any => ({ ...obj, }); @@ -2735,6 +3017,9 @@ export interface UpdateFirewallDeleteProtectionResponse { } export namespace UpdateFirewallDeleteProtectionResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateFirewallDeleteProtectionResponse): any => ({ ...obj, }); @@ -2768,6 +3053,9 @@ export interface UpdateFirewallDescriptionRequest { } export namespace UpdateFirewallDescriptionRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateFirewallDescriptionRequest): any => ({ ...obj, }); @@ -2798,6 +3086,9 @@ export interface UpdateFirewallDescriptionResponse { } export namespace UpdateFirewallDescriptionResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateFirewallDescriptionResponse): any => ({ ...obj, }); @@ -2844,6 +3135,9 @@ export interface UpdateFirewallPolicyRequest { } export namespace UpdateFirewallPolicyRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateFirewallPolicyRequest): any => ({ ...obj, }); @@ -2863,6 +3157,9 @@ export interface UpdateFirewallPolicyResponse { } export namespace UpdateFirewallPolicyResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateFirewallPolicyResponse): any => ({ ...obj, }); @@ -2897,6 +3194,9 @@ export interface UpdateFirewallPolicyChangeProtectionRequest { } export namespace UpdateFirewallPolicyChangeProtectionRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateFirewallPolicyChangeProtectionRequest): any => ({ ...obj, }); @@ -2929,6 +3229,9 @@ export interface UpdateFirewallPolicyChangeProtectionResponse { } export namespace UpdateFirewallPolicyChangeProtectionResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateFirewallPolicyChangeProtectionResponse): any => ({ ...obj, }); @@ -2955,6 +3258,9 @@ export interface UpdateLoggingConfigurationRequest { } export namespace UpdateLoggingConfigurationRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateLoggingConfigurationRequest): any => ({ ...obj, }); @@ -2978,6 +3284,9 @@ export interface UpdateLoggingConfigurationResponse { } export namespace UpdateLoggingConfigurationResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateLoggingConfigurationResponse): any => ({ ...obj, }); @@ -3047,6 +3356,9 @@ export interface UpdateRuleGroupRequest { } export namespace UpdateRuleGroupRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateRuleGroupRequest): any => ({ ...obj, }); @@ -3066,6 +3378,9 @@ export interface UpdateRuleGroupResponse { } export namespace UpdateRuleGroupResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateRuleGroupResponse): any => ({ ...obj, }); @@ -3100,6 +3415,9 @@ export interface UpdateSubnetChangeProtectionRequest { } export namespace UpdateSubnetChangeProtectionRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateSubnetChangeProtectionRequest): any => ({ ...obj, }); @@ -3132,6 +3450,9 @@ export interface UpdateSubnetChangeProtectionResponse { } export namespace UpdateSubnetChangeProtectionResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateSubnetChangeProtectionResponse): any => ({ ...obj, }); diff --git a/clients/client-networkmanager/commands/AssociateCustomerGatewayCommand.ts b/clients/client-networkmanager/commands/AssociateCustomerGatewayCommand.ts index 5f3ad46dde43..5000274acaf0 100644 --- a/clients/client-networkmanager/commands/AssociateCustomerGatewayCommand.ts +++ b/clients/client-networkmanager/commands/AssociateCustomerGatewayCommand.ts @@ -30,6 +30,20 @@ export interface AssociateCustomerGatewayCommandOutput extends AssociateCustomer * 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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { NetworkManagerClient, AssociateCustomerGatewayCommand } from "@aws-sdk/client-networkmanager"; // ES Modules import + * // const { NetworkManagerClient, AssociateCustomerGatewayCommand } = require("@aws-sdk/client-networkmanager"); // CommonJS import + * const client = new NetworkManagerClient(config); + * const command = new AssociateCustomerGatewayCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link AssociateCustomerGatewayCommandInput} for command's `input` shape. + * @see {@link AssociateCustomerGatewayCommandOutput} for command's `response` shape. + * @see {@link NetworkManagerClientResolvedConfig | config} for command's `input` shape. + * */ export class AssociateCustomerGatewayCommand extends $Command< AssociateCustomerGatewayCommandInput, diff --git a/clients/client-networkmanager/commands/AssociateLinkCommand.ts b/clients/client-networkmanager/commands/AssociateLinkCommand.ts index a5924eac1382..664ae2cb74c5 100644 --- a/clients/client-networkmanager/commands/AssociateLinkCommand.ts +++ b/clients/client-networkmanager/commands/AssociateLinkCommand.ts @@ -22,6 +22,20 @@ export interface AssociateLinkCommandOutput extends AssociateLinkResponse, __Met /** *

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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { NetworkManagerClient, AssociateLinkCommand } from "@aws-sdk/client-networkmanager"; // ES Modules import + * // const { NetworkManagerClient, AssociateLinkCommand } = require("@aws-sdk/client-networkmanager"); // CommonJS import + * const client = new NetworkManagerClient(config); + * const command = new AssociateLinkCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link AssociateLinkCommandInput} for command's `input` shape. + * @see {@link AssociateLinkCommandOutput} for command's `response` shape. + * @see {@link NetworkManagerClientResolvedConfig | config} for command's `input` shape. + * */ export class AssociateLinkCommand extends $Command< AssociateLinkCommandInput, diff --git a/clients/client-networkmanager/commands/AssociateTransitGatewayConnectPeerCommand.ts b/clients/client-networkmanager/commands/AssociateTransitGatewayConnectPeerCommand.ts index e79e0184796f..269526675e17 100644 --- a/clients/client-networkmanager/commands/AssociateTransitGatewayConnectPeerCommand.ts +++ b/clients/client-networkmanager/commands/AssociateTransitGatewayConnectPeerCommand.ts @@ -31,6 +31,20 @@ export interface AssociateTransitGatewayConnectPeerCommandOutput *

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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { NetworkManagerClient, AssociateTransitGatewayConnectPeerCommand } from "@aws-sdk/client-networkmanager"; // ES Modules import + * // const { NetworkManagerClient, AssociateTransitGatewayConnectPeerCommand } = require("@aws-sdk/client-networkmanager"); // CommonJS import + * const client = new NetworkManagerClient(config); + * const command = new AssociateTransitGatewayConnectPeerCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link AssociateTransitGatewayConnectPeerCommandInput} for command's `input` shape. + * @see {@link AssociateTransitGatewayConnectPeerCommandOutput} for command's `response` shape. + * @see {@link NetworkManagerClientResolvedConfig | config} for command's `input` shape. + * */ export class AssociateTransitGatewayConnectPeerCommand extends $Command< AssociateTransitGatewayConnectPeerCommandInput, diff --git a/clients/client-networkmanager/commands/CreateConnectionCommand.ts b/clients/client-networkmanager/commands/CreateConnectionCommand.ts index b19004339165..f7ab2bbde905 100644 --- a/clients/client-networkmanager/commands/CreateConnectionCommand.ts +++ b/clients/client-networkmanager/commands/CreateConnectionCommand.ts @@ -22,6 +22,20 @@ export interface CreateConnectionCommandOutput extends CreateConnectionResponse, /** *

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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { NetworkManagerClient, CreateConnectionCommand } from "@aws-sdk/client-networkmanager"; // ES Modules import + * // const { NetworkManagerClient, CreateConnectionCommand } = require("@aws-sdk/client-networkmanager"); // CommonJS import + * const client = new NetworkManagerClient(config); + * const command = new CreateConnectionCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreateConnectionCommandInput} for command's `input` shape. + * @see {@link CreateConnectionCommandOutput} for command's `response` shape. + * @see {@link NetworkManagerClientResolvedConfig | config} for command's `input` shape. + * */ export class CreateConnectionCommand extends $Command< CreateConnectionCommandInput, diff --git a/clients/client-networkmanager/commands/CreateDeviceCommand.ts b/clients/client-networkmanager/commands/CreateDeviceCommand.ts index 61489fd98698..3383dec4db22 100644 --- a/clients/client-networkmanager/commands/CreateDeviceCommand.ts +++ b/clients/client-networkmanager/commands/CreateDeviceCommand.ts @@ -23,6 +23,20 @@ export interface CreateDeviceCommandOutput extends CreateDeviceResponse, __Metad /** *

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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { NetworkManagerClient, CreateDeviceCommand } from "@aws-sdk/client-networkmanager"; // ES Modules import + * // const { NetworkManagerClient, CreateDeviceCommand } = require("@aws-sdk/client-networkmanager"); // CommonJS import + * const client = new NetworkManagerClient(config); + * const command = new CreateDeviceCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreateDeviceCommandInput} for command's `input` shape. + * @see {@link CreateDeviceCommandOutput} for command's `response` shape. + * @see {@link NetworkManagerClientResolvedConfig | config} for command's `input` shape. + * */ export class CreateDeviceCommand extends $Command< CreateDeviceCommandInput, diff --git a/clients/client-networkmanager/commands/CreateGlobalNetworkCommand.ts b/clients/client-networkmanager/commands/CreateGlobalNetworkCommand.ts index bb383a84c91d..a75b2f191c00 100644 --- a/clients/client-networkmanager/commands/CreateGlobalNetworkCommand.ts +++ b/clients/client-networkmanager/commands/CreateGlobalNetworkCommand.ts @@ -22,6 +22,20 @@ export interface CreateGlobalNetworkCommandOutput extends CreateGlobalNetworkRes /** *

Creates a new, empty global network.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { NetworkManagerClient, CreateGlobalNetworkCommand } from "@aws-sdk/client-networkmanager"; // ES Modules import + * // const { NetworkManagerClient, CreateGlobalNetworkCommand } = require("@aws-sdk/client-networkmanager"); // CommonJS import + * const client = new NetworkManagerClient(config); + * const command = new CreateGlobalNetworkCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreateGlobalNetworkCommandInput} for command's `input` shape. + * @see {@link CreateGlobalNetworkCommandOutput} for command's `response` shape. + * @see {@link NetworkManagerClientResolvedConfig | config} for command's `input` shape. + * */ export class CreateGlobalNetworkCommand extends $Command< CreateGlobalNetworkCommandInput, diff --git a/clients/client-networkmanager/commands/CreateLinkCommand.ts b/clients/client-networkmanager/commands/CreateLinkCommand.ts index b6937d94aa1e..aa4115ce10f9 100644 --- a/clients/client-networkmanager/commands/CreateLinkCommand.ts +++ b/clients/client-networkmanager/commands/CreateLinkCommand.ts @@ -22,6 +22,20 @@ export interface CreateLinkCommandOutput extends CreateLinkResponse, __MetadataB /** *

Creates a new link for a specified site.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { NetworkManagerClient, CreateLinkCommand } from "@aws-sdk/client-networkmanager"; // ES Modules import + * // const { NetworkManagerClient, CreateLinkCommand } = require("@aws-sdk/client-networkmanager"); // CommonJS import + * const client = new NetworkManagerClient(config); + * const command = new CreateLinkCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreateLinkCommandInput} for command's `input` shape. + * @see {@link CreateLinkCommandOutput} for command's `response` shape. + * @see {@link NetworkManagerClientResolvedConfig | config} for command's `input` shape. + * */ export class CreateLinkCommand extends $Command< CreateLinkCommandInput, diff --git a/clients/client-networkmanager/commands/CreateSiteCommand.ts b/clients/client-networkmanager/commands/CreateSiteCommand.ts index 16dcd403d73f..06be973cfe1f 100644 --- a/clients/client-networkmanager/commands/CreateSiteCommand.ts +++ b/clients/client-networkmanager/commands/CreateSiteCommand.ts @@ -22,6 +22,20 @@ export interface CreateSiteCommandOutput extends CreateSiteResponse, __MetadataB /** *

Creates a new site in a global network.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { NetworkManagerClient, CreateSiteCommand } from "@aws-sdk/client-networkmanager"; // ES Modules import + * // const { NetworkManagerClient, CreateSiteCommand } = require("@aws-sdk/client-networkmanager"); // CommonJS import + * const client = new NetworkManagerClient(config); + * const command = new CreateSiteCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreateSiteCommandInput} for command's `input` shape. + * @see {@link CreateSiteCommandOutput} for command's `response` shape. + * @see {@link NetworkManagerClientResolvedConfig | config} for command's `input` shape. + * */ export class CreateSiteCommand extends $Command< CreateSiteCommandInput, diff --git a/clients/client-networkmanager/commands/DeleteConnectionCommand.ts b/clients/client-networkmanager/commands/DeleteConnectionCommand.ts index af081182d70b..49ae82bc94ba 100644 --- a/clients/client-networkmanager/commands/DeleteConnectionCommand.ts +++ b/clients/client-networkmanager/commands/DeleteConnectionCommand.ts @@ -22,6 +22,20 @@ export interface DeleteConnectionCommandOutput extends DeleteConnectionResponse, /** *

Deletes the specified connection in your global network.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { NetworkManagerClient, DeleteConnectionCommand } from "@aws-sdk/client-networkmanager"; // ES Modules import + * // const { NetworkManagerClient, DeleteConnectionCommand } = require("@aws-sdk/client-networkmanager"); // CommonJS import + * const client = new NetworkManagerClient(config); + * const command = new DeleteConnectionCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteConnectionCommandInput} for command's `input` shape. + * @see {@link DeleteConnectionCommandOutput} for command's `response` shape. + * @see {@link NetworkManagerClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteConnectionCommand extends $Command< DeleteConnectionCommandInput, diff --git a/clients/client-networkmanager/commands/DeleteDeviceCommand.ts b/clients/client-networkmanager/commands/DeleteDeviceCommand.ts index cf7779568b89..b1199cdc9b5f 100644 --- a/clients/client-networkmanager/commands/DeleteDeviceCommand.ts +++ b/clients/client-networkmanager/commands/DeleteDeviceCommand.ts @@ -23,6 +23,20 @@ export interface DeleteDeviceCommandOutput extends DeleteDeviceResponse, __Metad /** *

Deletes an existing device. You must first disassociate the device from any links and * customer gateways.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { NetworkManagerClient, DeleteDeviceCommand } from "@aws-sdk/client-networkmanager"; // ES Modules import + * // const { NetworkManagerClient, DeleteDeviceCommand } = require("@aws-sdk/client-networkmanager"); // CommonJS import + * const client = new NetworkManagerClient(config); + * const command = new DeleteDeviceCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteDeviceCommandInput} for command's `input` shape. + * @see {@link DeleteDeviceCommandOutput} for command's `response` shape. + * @see {@link NetworkManagerClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteDeviceCommand extends $Command< DeleteDeviceCommandInput, diff --git a/clients/client-networkmanager/commands/DeleteGlobalNetworkCommand.ts b/clients/client-networkmanager/commands/DeleteGlobalNetworkCommand.ts index 356b879d2d88..14c45af3fe3d 100644 --- a/clients/client-networkmanager/commands/DeleteGlobalNetworkCommand.ts +++ b/clients/client-networkmanager/commands/DeleteGlobalNetworkCommand.ts @@ -23,6 +23,20 @@ export interface DeleteGlobalNetworkCommandOutput extends DeleteGlobalNetworkRes /** *

Deletes an existing global network. You must first delete all global network objects * (devices, links, and sites) and deregister all transit gateways.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { NetworkManagerClient, DeleteGlobalNetworkCommand } from "@aws-sdk/client-networkmanager"; // ES Modules import + * // const { NetworkManagerClient, DeleteGlobalNetworkCommand } = require("@aws-sdk/client-networkmanager"); // CommonJS import + * const client = new NetworkManagerClient(config); + * const command = new DeleteGlobalNetworkCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteGlobalNetworkCommandInput} for command's `input` shape. + * @see {@link DeleteGlobalNetworkCommandOutput} for command's `response` shape. + * @see {@link NetworkManagerClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteGlobalNetworkCommand extends $Command< DeleteGlobalNetworkCommandInput, diff --git a/clients/client-networkmanager/commands/DeleteLinkCommand.ts b/clients/client-networkmanager/commands/DeleteLinkCommand.ts index 1ef46ba16273..ef5d75a23ff1 100644 --- a/clients/client-networkmanager/commands/DeleteLinkCommand.ts +++ b/clients/client-networkmanager/commands/DeleteLinkCommand.ts @@ -23,6 +23,20 @@ export interface DeleteLinkCommandOutput extends DeleteLinkResponse, __MetadataB /** *

Deletes an existing link. You must first disassociate the link from any devices and * customer gateways.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { NetworkManagerClient, DeleteLinkCommand } from "@aws-sdk/client-networkmanager"; // ES Modules import + * // const { NetworkManagerClient, DeleteLinkCommand } = require("@aws-sdk/client-networkmanager"); // CommonJS import + * const client = new NetworkManagerClient(config); + * const command = new DeleteLinkCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteLinkCommandInput} for command's `input` shape. + * @see {@link DeleteLinkCommandOutput} for command's `response` shape. + * @see {@link NetworkManagerClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteLinkCommand extends $Command< DeleteLinkCommandInput, diff --git a/clients/client-networkmanager/commands/DeleteSiteCommand.ts b/clients/client-networkmanager/commands/DeleteSiteCommand.ts index e51de01cc95d..eb700616e19a 100644 --- a/clients/client-networkmanager/commands/DeleteSiteCommand.ts +++ b/clients/client-networkmanager/commands/DeleteSiteCommand.ts @@ -22,6 +22,20 @@ export interface DeleteSiteCommandOutput extends DeleteSiteResponse, __MetadataB /** *

Deletes an existing site. The site cannot be associated with any device or link.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { NetworkManagerClient, DeleteSiteCommand } from "@aws-sdk/client-networkmanager"; // ES Modules import + * // const { NetworkManagerClient, DeleteSiteCommand } = require("@aws-sdk/client-networkmanager"); // CommonJS import + * const client = new NetworkManagerClient(config); + * const command = new DeleteSiteCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteSiteCommandInput} for command's `input` shape. + * @see {@link DeleteSiteCommandOutput} for command's `response` shape. + * @see {@link NetworkManagerClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteSiteCommand extends $Command< DeleteSiteCommandInput, diff --git a/clients/client-networkmanager/commands/DeregisterTransitGatewayCommand.ts b/clients/client-networkmanager/commands/DeregisterTransitGatewayCommand.ts index 52aa9d9dfd45..85f8900a00b2 100644 --- a/clients/client-networkmanager/commands/DeregisterTransitGatewayCommand.ts +++ b/clients/client-networkmanager/commands/DeregisterTransitGatewayCommand.ts @@ -23,6 +23,20 @@ export interface DeregisterTransitGatewayCommandOutput extends DeregisterTransit /** *

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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { NetworkManagerClient, DeregisterTransitGatewayCommand } from "@aws-sdk/client-networkmanager"; // ES Modules import + * // const { NetworkManagerClient, DeregisterTransitGatewayCommand } = require("@aws-sdk/client-networkmanager"); // CommonJS import + * const client = new NetworkManagerClient(config); + * const command = new DeregisterTransitGatewayCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeregisterTransitGatewayCommandInput} for command's `input` shape. + * @see {@link DeregisterTransitGatewayCommandOutput} for command's `response` shape. + * @see {@link NetworkManagerClientResolvedConfig | config} for command's `input` shape. + * */ export class DeregisterTransitGatewayCommand extends $Command< DeregisterTransitGatewayCommandInput, diff --git a/clients/client-networkmanager/commands/DescribeGlobalNetworksCommand.ts b/clients/client-networkmanager/commands/DescribeGlobalNetworksCommand.ts index 4037b0a6ff20..1b29793aa47d 100644 --- a/clients/client-networkmanager/commands/DescribeGlobalNetworksCommand.ts +++ b/clients/client-networkmanager/commands/DescribeGlobalNetworksCommand.ts @@ -25,6 +25,20 @@ export interface DescribeGlobalNetworksCommandOutput extends DescribeGlobalNetwo * 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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { NetworkManagerClient, DescribeGlobalNetworksCommand } from "@aws-sdk/client-networkmanager"; // ES Modules import + * // const { NetworkManagerClient, DescribeGlobalNetworksCommand } = require("@aws-sdk/client-networkmanager"); // CommonJS import + * const client = new NetworkManagerClient(config); + * const command = new DescribeGlobalNetworksCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeGlobalNetworksCommandInput} for command's `input` shape. + * @see {@link DescribeGlobalNetworksCommandOutput} for command's `response` shape. + * @see {@link NetworkManagerClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeGlobalNetworksCommand extends $Command< DescribeGlobalNetworksCommandInput, diff --git a/clients/client-networkmanager/commands/DisassociateCustomerGatewayCommand.ts b/clients/client-networkmanager/commands/DisassociateCustomerGatewayCommand.ts index f7b7625d6732..e1bca44993b1 100644 --- a/clients/client-networkmanager/commands/DisassociateCustomerGatewayCommand.ts +++ b/clients/client-networkmanager/commands/DisassociateCustomerGatewayCommand.ts @@ -24,6 +24,20 @@ export interface DisassociateCustomerGatewayCommandOutput /** *

Disassociates a customer gateway from a device and a link.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { NetworkManagerClient, DisassociateCustomerGatewayCommand } from "@aws-sdk/client-networkmanager"; // ES Modules import + * // const { NetworkManagerClient, DisassociateCustomerGatewayCommand } = require("@aws-sdk/client-networkmanager"); // CommonJS import + * const client = new NetworkManagerClient(config); + * const command = new DisassociateCustomerGatewayCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DisassociateCustomerGatewayCommandInput} for command's `input` shape. + * @see {@link DisassociateCustomerGatewayCommandOutput} for command's `response` shape. + * @see {@link NetworkManagerClientResolvedConfig | config} for command's `input` shape. + * */ export class DisassociateCustomerGatewayCommand extends $Command< DisassociateCustomerGatewayCommandInput, diff --git a/clients/client-networkmanager/commands/DisassociateLinkCommand.ts b/clients/client-networkmanager/commands/DisassociateLinkCommand.ts index 428fba7345eb..bd63b4af7f2f 100644 --- a/clients/client-networkmanager/commands/DisassociateLinkCommand.ts +++ b/clients/client-networkmanager/commands/DisassociateLinkCommand.ts @@ -23,6 +23,20 @@ export interface DisassociateLinkCommandOutput extends DisassociateLinkResponse, /** *

Disassociates an existing device from a link. You must first disassociate any customer * gateways that are associated with the link.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { NetworkManagerClient, DisassociateLinkCommand } from "@aws-sdk/client-networkmanager"; // ES Modules import + * // const { NetworkManagerClient, DisassociateLinkCommand } = require("@aws-sdk/client-networkmanager"); // CommonJS import + * const client = new NetworkManagerClient(config); + * const command = new DisassociateLinkCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DisassociateLinkCommandInput} for command's `input` shape. + * @see {@link DisassociateLinkCommandOutput} for command's `response` shape. + * @see {@link NetworkManagerClientResolvedConfig | config} for command's `input` shape. + * */ export class DisassociateLinkCommand extends $Command< DisassociateLinkCommandInput, diff --git a/clients/client-networkmanager/commands/DisassociateTransitGatewayConnectPeerCommand.ts b/clients/client-networkmanager/commands/DisassociateTransitGatewayConnectPeerCommand.ts index dfe45318c33b..3cb567dda2c0 100644 --- a/clients/client-networkmanager/commands/DisassociateTransitGatewayConnectPeerCommand.ts +++ b/clients/client-networkmanager/commands/DisassociateTransitGatewayConnectPeerCommand.ts @@ -28,6 +28,20 @@ export interface DisassociateTransitGatewayConnectPeerCommandOutput /** *

Disassociates a transit gateway Connect peer from a device and link.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { NetworkManagerClient, DisassociateTransitGatewayConnectPeerCommand } from "@aws-sdk/client-networkmanager"; // ES Modules import + * // const { NetworkManagerClient, DisassociateTransitGatewayConnectPeerCommand } = require("@aws-sdk/client-networkmanager"); // CommonJS import + * const client = new NetworkManagerClient(config); + * const command = new DisassociateTransitGatewayConnectPeerCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DisassociateTransitGatewayConnectPeerCommandInput} for command's `input` shape. + * @see {@link DisassociateTransitGatewayConnectPeerCommandOutput} for command's `response` shape. + * @see {@link NetworkManagerClientResolvedConfig | config} for command's `input` shape. + * */ export class DisassociateTransitGatewayConnectPeerCommand extends $Command< DisassociateTransitGatewayConnectPeerCommandInput, diff --git a/clients/client-networkmanager/commands/GetConnectionsCommand.ts b/clients/client-networkmanager/commands/GetConnectionsCommand.ts index 1e459ec10a03..8f0b147dc71c 100644 --- a/clients/client-networkmanager/commands/GetConnectionsCommand.ts +++ b/clients/client-networkmanager/commands/GetConnectionsCommand.ts @@ -22,6 +22,20 @@ export interface GetConnectionsCommandOutput extends GetConnectionsResponse, __M /** *

Gets information about one or more of your connections in a global network.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { NetworkManagerClient, GetConnectionsCommand } from "@aws-sdk/client-networkmanager"; // ES Modules import + * // const { NetworkManagerClient, GetConnectionsCommand } = require("@aws-sdk/client-networkmanager"); // CommonJS import + * const client = new NetworkManagerClient(config); + * const command = new GetConnectionsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetConnectionsCommandInput} for command's `input` shape. + * @see {@link GetConnectionsCommandOutput} for command's `response` shape. + * @see {@link NetworkManagerClientResolvedConfig | config} for command's `input` shape. + * */ export class GetConnectionsCommand extends $Command< GetConnectionsCommandInput, diff --git a/clients/client-networkmanager/commands/GetCustomerGatewayAssociationsCommand.ts b/clients/client-networkmanager/commands/GetCustomerGatewayAssociationsCommand.ts index 5b1fba60ef96..fb9c11d579c2 100644 --- a/clients/client-networkmanager/commands/GetCustomerGatewayAssociationsCommand.ts +++ b/clients/client-networkmanager/commands/GetCustomerGatewayAssociationsCommand.ts @@ -25,6 +25,20 @@ export interface GetCustomerGatewayAssociationsCommandOutput /** *

Gets the association information for customer gateways that are associated with * devices and links in your global network.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { NetworkManagerClient, GetCustomerGatewayAssociationsCommand } from "@aws-sdk/client-networkmanager"; // ES Modules import + * // const { NetworkManagerClient, GetCustomerGatewayAssociationsCommand } = require("@aws-sdk/client-networkmanager"); // CommonJS import + * const client = new NetworkManagerClient(config); + * const command = new GetCustomerGatewayAssociationsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetCustomerGatewayAssociationsCommandInput} for command's `input` shape. + * @see {@link GetCustomerGatewayAssociationsCommandOutput} for command's `response` shape. + * @see {@link NetworkManagerClientResolvedConfig | config} for command's `input` shape. + * */ export class GetCustomerGatewayAssociationsCommand extends $Command< GetCustomerGatewayAssociationsCommandInput, diff --git a/clients/client-networkmanager/commands/GetDevicesCommand.ts b/clients/client-networkmanager/commands/GetDevicesCommand.ts index afb2d6f0adc3..b9ccb88ce5a9 100644 --- a/clients/client-networkmanager/commands/GetDevicesCommand.ts +++ b/clients/client-networkmanager/commands/GetDevicesCommand.ts @@ -22,6 +22,20 @@ export interface GetDevicesCommandOutput extends GetDevicesResponse, __MetadataB /** *

Gets information about one or more of your devices in a global network.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { NetworkManagerClient, GetDevicesCommand } from "@aws-sdk/client-networkmanager"; // ES Modules import + * // const { NetworkManagerClient, GetDevicesCommand } = require("@aws-sdk/client-networkmanager"); // CommonJS import + * const client = new NetworkManagerClient(config); + * const command = new GetDevicesCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetDevicesCommandInput} for command's `input` shape. + * @see {@link GetDevicesCommandOutput} for command's `response` shape. + * @see {@link NetworkManagerClientResolvedConfig | config} for command's `input` shape. + * */ export class GetDevicesCommand extends $Command< GetDevicesCommandInput, diff --git a/clients/client-networkmanager/commands/GetLinkAssociationsCommand.ts b/clients/client-networkmanager/commands/GetLinkAssociationsCommand.ts index ee7cc0604715..511776790dfd 100644 --- a/clients/client-networkmanager/commands/GetLinkAssociationsCommand.ts +++ b/clients/client-networkmanager/commands/GetLinkAssociationsCommand.ts @@ -23,6 +23,20 @@ export interface GetLinkAssociationsCommandOutput extends GetLinkAssociationsRes /** *

Gets the link associations for a device or a link. Either the device ID or the link ID * must be specified.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { NetworkManagerClient, GetLinkAssociationsCommand } from "@aws-sdk/client-networkmanager"; // ES Modules import + * // const { NetworkManagerClient, GetLinkAssociationsCommand } = require("@aws-sdk/client-networkmanager"); // CommonJS import + * const client = new NetworkManagerClient(config); + * const command = new GetLinkAssociationsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetLinkAssociationsCommandInput} for command's `input` shape. + * @see {@link GetLinkAssociationsCommandOutput} for command's `response` shape. + * @see {@link NetworkManagerClientResolvedConfig | config} for command's `input` shape. + * */ export class GetLinkAssociationsCommand extends $Command< GetLinkAssociationsCommandInput, diff --git a/clients/client-networkmanager/commands/GetLinksCommand.ts b/clients/client-networkmanager/commands/GetLinksCommand.ts index 3cf6156f9aca..6b7bd43b452b 100644 --- a/clients/client-networkmanager/commands/GetLinksCommand.ts +++ b/clients/client-networkmanager/commands/GetLinksCommand.ts @@ -23,6 +23,20 @@ export interface GetLinksCommandOutput extends GetLinksResponse, __MetadataBeare /** *

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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { NetworkManagerClient, GetLinksCommand } from "@aws-sdk/client-networkmanager"; // ES Modules import + * // const { NetworkManagerClient, GetLinksCommand } = require("@aws-sdk/client-networkmanager"); // CommonJS import + * const client = new NetworkManagerClient(config); + * const command = new GetLinksCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetLinksCommandInput} for command's `input` shape. + * @see {@link GetLinksCommandOutput} for command's `response` shape. + * @see {@link NetworkManagerClientResolvedConfig | config} for command's `input` shape. + * */ export class GetLinksCommand extends $Command< GetLinksCommandInput, diff --git a/clients/client-networkmanager/commands/GetSitesCommand.ts b/clients/client-networkmanager/commands/GetSitesCommand.ts index dd770e5f4842..7750af82af39 100644 --- a/clients/client-networkmanager/commands/GetSitesCommand.ts +++ b/clients/client-networkmanager/commands/GetSitesCommand.ts @@ -22,6 +22,20 @@ export interface GetSitesCommandOutput extends GetSitesResponse, __MetadataBeare /** *

Gets information about one or more of your sites in a global network.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { NetworkManagerClient, GetSitesCommand } from "@aws-sdk/client-networkmanager"; // ES Modules import + * // const { NetworkManagerClient, GetSitesCommand } = require("@aws-sdk/client-networkmanager"); // CommonJS import + * const client = new NetworkManagerClient(config); + * const command = new GetSitesCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetSitesCommandInput} for command's `input` shape. + * @see {@link GetSitesCommandOutput} for command's `response` shape. + * @see {@link NetworkManagerClientResolvedConfig | config} for command's `input` shape. + * */ export class GetSitesCommand extends $Command< GetSitesCommandInput, diff --git a/clients/client-networkmanager/commands/GetTransitGatewayConnectPeerAssociationsCommand.ts b/clients/client-networkmanager/commands/GetTransitGatewayConnectPeerAssociationsCommand.ts index 451f274ea2bf..1523a218d406 100644 --- a/clients/client-networkmanager/commands/GetTransitGatewayConnectPeerAssociationsCommand.ts +++ b/clients/client-networkmanager/commands/GetTransitGatewayConnectPeerAssociationsCommand.ts @@ -28,6 +28,20 @@ export interface GetTransitGatewayConnectPeerAssociationsCommandOutput /** *

Gets information about one or more of your transit gateway Connect peer associations in a global network.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { NetworkManagerClient, GetTransitGatewayConnectPeerAssociationsCommand } from "@aws-sdk/client-networkmanager"; // ES Modules import + * // const { NetworkManagerClient, GetTransitGatewayConnectPeerAssociationsCommand } = require("@aws-sdk/client-networkmanager"); // CommonJS import + * const client = new NetworkManagerClient(config); + * const command = new GetTransitGatewayConnectPeerAssociationsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetTransitGatewayConnectPeerAssociationsCommandInput} for command's `input` shape. + * @see {@link GetTransitGatewayConnectPeerAssociationsCommandOutput} for command's `response` shape. + * @see {@link NetworkManagerClientResolvedConfig | config} for command's `input` shape. + * */ export class GetTransitGatewayConnectPeerAssociationsCommand extends $Command< GetTransitGatewayConnectPeerAssociationsCommandInput, diff --git a/clients/client-networkmanager/commands/GetTransitGatewayRegistrationsCommand.ts b/clients/client-networkmanager/commands/GetTransitGatewayRegistrationsCommand.ts index 24699237e421..a69b6193923b 100644 --- a/clients/client-networkmanager/commands/GetTransitGatewayRegistrationsCommand.ts +++ b/clients/client-networkmanager/commands/GetTransitGatewayRegistrationsCommand.ts @@ -25,6 +25,20 @@ export interface GetTransitGatewayRegistrationsCommandOutput /** *

Gets information about the transit gateway registrations in a specified * global network.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { NetworkManagerClient, GetTransitGatewayRegistrationsCommand } from "@aws-sdk/client-networkmanager"; // ES Modules import + * // const { NetworkManagerClient, GetTransitGatewayRegistrationsCommand } = require("@aws-sdk/client-networkmanager"); // CommonJS import + * const client = new NetworkManagerClient(config); + * const command = new GetTransitGatewayRegistrationsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetTransitGatewayRegistrationsCommandInput} for command's `input` shape. + * @see {@link GetTransitGatewayRegistrationsCommandOutput} for command's `response` shape. + * @see {@link NetworkManagerClientResolvedConfig | config} for command's `input` shape. + * */ export class GetTransitGatewayRegistrationsCommand extends $Command< GetTransitGatewayRegistrationsCommandInput, diff --git a/clients/client-networkmanager/commands/ListTagsForResourceCommand.ts b/clients/client-networkmanager/commands/ListTagsForResourceCommand.ts index fe63f99bb7fa..21f4adb46988 100644 --- a/clients/client-networkmanager/commands/ListTagsForResourceCommand.ts +++ b/clients/client-networkmanager/commands/ListTagsForResourceCommand.ts @@ -22,6 +22,20 @@ export interface ListTagsForResourceCommandOutput extends ListTagsForResourceRes /** *

Lists the tags for a specified resource.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { NetworkManagerClient, ListTagsForResourceCommand } from "@aws-sdk/client-networkmanager"; // ES Modules import + * // const { NetworkManagerClient, ListTagsForResourceCommand } = require("@aws-sdk/client-networkmanager"); // CommonJS import + * const client = new NetworkManagerClient(config); + * const command = new ListTagsForResourceCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListTagsForResourceCommandInput} for command's `input` shape. + * @see {@link ListTagsForResourceCommandOutput} for command's `response` shape. + * @see {@link NetworkManagerClientResolvedConfig | config} for command's `input` shape. + * */ export class ListTagsForResourceCommand extends $Command< ListTagsForResourceCommandInput, diff --git a/clients/client-networkmanager/commands/RegisterTransitGatewayCommand.ts b/clients/client-networkmanager/commands/RegisterTransitGatewayCommand.ts index e77b571d6dbe..3b2ec023202f 100644 --- a/clients/client-networkmanager/commands/RegisterTransitGatewayCommand.ts +++ b/clients/client-networkmanager/commands/RegisterTransitGatewayCommand.ts @@ -24,6 +24,20 @@ export interface RegisterTransitGatewayCommandOutput extends RegisterTransitGate *

Registers a transit gateway in your global network. The transit gateway can be in any * AWS Region, but it must be owned by the same AWS account that owns the global network. * You cannot register a transit gateway in more than one global network.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { NetworkManagerClient, RegisterTransitGatewayCommand } from "@aws-sdk/client-networkmanager"; // ES Modules import + * // const { NetworkManagerClient, RegisterTransitGatewayCommand } = require("@aws-sdk/client-networkmanager"); // CommonJS import + * const client = new NetworkManagerClient(config); + * const command = new RegisterTransitGatewayCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link RegisterTransitGatewayCommandInput} for command's `input` shape. + * @see {@link RegisterTransitGatewayCommandOutput} for command's `response` shape. + * @see {@link NetworkManagerClientResolvedConfig | config} for command's `input` shape. + * */ export class RegisterTransitGatewayCommand extends $Command< RegisterTransitGatewayCommandInput, diff --git a/clients/client-networkmanager/commands/TagResourceCommand.ts b/clients/client-networkmanager/commands/TagResourceCommand.ts index df5559ebe037..4b383ae717d3 100644 --- a/clients/client-networkmanager/commands/TagResourceCommand.ts +++ b/clients/client-networkmanager/commands/TagResourceCommand.ts @@ -22,6 +22,20 @@ export interface TagResourceCommandOutput extends TagResourceResponse, __Metadat /** *

Tags a specified resource.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { NetworkManagerClient, TagResourceCommand } from "@aws-sdk/client-networkmanager"; // ES Modules import + * // const { NetworkManagerClient, TagResourceCommand } = require("@aws-sdk/client-networkmanager"); // CommonJS import + * const client = new NetworkManagerClient(config); + * const command = new TagResourceCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link TagResourceCommandInput} for command's `input` shape. + * @see {@link TagResourceCommandOutput} for command's `response` shape. + * @see {@link NetworkManagerClientResolvedConfig | config} for command's `input` shape. + * */ export class TagResourceCommand extends $Command< TagResourceCommandInput, diff --git a/clients/client-networkmanager/commands/UntagResourceCommand.ts b/clients/client-networkmanager/commands/UntagResourceCommand.ts index 1dc2478ff9e2..5920c31c6f19 100644 --- a/clients/client-networkmanager/commands/UntagResourceCommand.ts +++ b/clients/client-networkmanager/commands/UntagResourceCommand.ts @@ -22,6 +22,20 @@ export interface UntagResourceCommandOutput extends UntagResourceResponse, __Met /** *

Removes tags from a specified resource.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { NetworkManagerClient, UntagResourceCommand } from "@aws-sdk/client-networkmanager"; // ES Modules import + * // const { NetworkManagerClient, UntagResourceCommand } = require("@aws-sdk/client-networkmanager"); // CommonJS import + * const client = new NetworkManagerClient(config); + * const command = new UntagResourceCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link UntagResourceCommandInput} for command's `input` shape. + * @see {@link UntagResourceCommandOutput} for command's `response` shape. + * @see {@link NetworkManagerClientResolvedConfig | config} for command's `input` shape. + * */ export class UntagResourceCommand extends $Command< UntagResourceCommandInput, diff --git a/clients/client-networkmanager/commands/UpdateConnectionCommand.ts b/clients/client-networkmanager/commands/UpdateConnectionCommand.ts index 1e15bacfd0e4..49797b567859 100644 --- a/clients/client-networkmanager/commands/UpdateConnectionCommand.ts +++ b/clients/client-networkmanager/commands/UpdateConnectionCommand.ts @@ -23,6 +23,20 @@ export interface UpdateConnectionCommandOutput extends UpdateConnectionResponse, /** *

Updates the information for an existing connection. To remove information for any of the parameters, * specify an empty string.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { NetworkManagerClient, UpdateConnectionCommand } from "@aws-sdk/client-networkmanager"; // ES Modules import + * // const { NetworkManagerClient, UpdateConnectionCommand } = require("@aws-sdk/client-networkmanager"); // CommonJS import + * const client = new NetworkManagerClient(config); + * const command = new UpdateConnectionCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link UpdateConnectionCommandInput} for command's `input` shape. + * @see {@link UpdateConnectionCommandOutput} for command's `response` shape. + * @see {@link NetworkManagerClientResolvedConfig | config} for command's `input` shape. + * */ export class UpdateConnectionCommand extends $Command< UpdateConnectionCommandInput, diff --git a/clients/client-networkmanager/commands/UpdateDeviceCommand.ts b/clients/client-networkmanager/commands/UpdateDeviceCommand.ts index 3738aa5ccd5f..ccd6e33535bd 100644 --- a/clients/client-networkmanager/commands/UpdateDeviceCommand.ts +++ b/clients/client-networkmanager/commands/UpdateDeviceCommand.ts @@ -23,6 +23,20 @@ export interface UpdateDeviceCommandOutput extends UpdateDeviceResponse, __Metad /** *

Updates the details for an existing device. To remove information for any of the * parameters, specify an empty string.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { NetworkManagerClient, UpdateDeviceCommand } from "@aws-sdk/client-networkmanager"; // ES Modules import + * // const { NetworkManagerClient, UpdateDeviceCommand } = require("@aws-sdk/client-networkmanager"); // CommonJS import + * const client = new NetworkManagerClient(config); + * const command = new UpdateDeviceCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link UpdateDeviceCommandInput} for command's `input` shape. + * @see {@link UpdateDeviceCommandOutput} for command's `response` shape. + * @see {@link NetworkManagerClientResolvedConfig | config} for command's `input` shape. + * */ export class UpdateDeviceCommand extends $Command< UpdateDeviceCommandInput, diff --git a/clients/client-networkmanager/commands/UpdateGlobalNetworkCommand.ts b/clients/client-networkmanager/commands/UpdateGlobalNetworkCommand.ts index 826c393e5416..ce178377d49f 100644 --- a/clients/client-networkmanager/commands/UpdateGlobalNetworkCommand.ts +++ b/clients/client-networkmanager/commands/UpdateGlobalNetworkCommand.ts @@ -23,6 +23,20 @@ export interface UpdateGlobalNetworkCommandOutput extends UpdateGlobalNetworkRes /** *

Updates an existing global network. To remove information for any of the parameters, * specify an empty string.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { NetworkManagerClient, UpdateGlobalNetworkCommand } from "@aws-sdk/client-networkmanager"; // ES Modules import + * // const { NetworkManagerClient, UpdateGlobalNetworkCommand } = require("@aws-sdk/client-networkmanager"); // CommonJS import + * const client = new NetworkManagerClient(config); + * const command = new UpdateGlobalNetworkCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link UpdateGlobalNetworkCommandInput} for command's `input` shape. + * @see {@link UpdateGlobalNetworkCommandOutput} for command's `response` shape. + * @see {@link NetworkManagerClientResolvedConfig | config} for command's `input` shape. + * */ export class UpdateGlobalNetworkCommand extends $Command< UpdateGlobalNetworkCommandInput, diff --git a/clients/client-networkmanager/commands/UpdateLinkCommand.ts b/clients/client-networkmanager/commands/UpdateLinkCommand.ts index 78208dde7840..ea653cabdaa5 100644 --- a/clients/client-networkmanager/commands/UpdateLinkCommand.ts +++ b/clients/client-networkmanager/commands/UpdateLinkCommand.ts @@ -23,6 +23,20 @@ export interface UpdateLinkCommandOutput extends UpdateLinkResponse, __MetadataB /** *

Updates the details for an existing link. To remove information for any of the * parameters, specify an empty string.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { NetworkManagerClient, UpdateLinkCommand } from "@aws-sdk/client-networkmanager"; // ES Modules import + * // const { NetworkManagerClient, UpdateLinkCommand } = require("@aws-sdk/client-networkmanager"); // CommonJS import + * const client = new NetworkManagerClient(config); + * const command = new UpdateLinkCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link UpdateLinkCommandInput} for command's `input` shape. + * @see {@link UpdateLinkCommandOutput} for command's `response` shape. + * @see {@link NetworkManagerClientResolvedConfig | config} for command's `input` shape. + * */ export class UpdateLinkCommand extends $Command< UpdateLinkCommandInput, diff --git a/clients/client-networkmanager/commands/UpdateSiteCommand.ts b/clients/client-networkmanager/commands/UpdateSiteCommand.ts index 9f6550bc2f6a..7e5fa9dd504b 100644 --- a/clients/client-networkmanager/commands/UpdateSiteCommand.ts +++ b/clients/client-networkmanager/commands/UpdateSiteCommand.ts @@ -23,6 +23,20 @@ export interface UpdateSiteCommandOutput extends UpdateSiteResponse, __MetadataB /** *

Updates the information for an existing site. To remove information for any of the * parameters, specify an empty string.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { NetworkManagerClient, UpdateSiteCommand } from "@aws-sdk/client-networkmanager"; // ES Modules import + * // const { NetworkManagerClient, UpdateSiteCommand } = require("@aws-sdk/client-networkmanager"); // CommonJS import + * const client = new NetworkManagerClient(config); + * const command = new UpdateSiteCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link UpdateSiteCommandInput} for command's `input` shape. + * @see {@link UpdateSiteCommandOutput} for command's `response` shape. + * @see {@link NetworkManagerClientResolvedConfig | config} for command's `input` shape. + * */ export class UpdateSiteCommand extends $Command< UpdateSiteCommandInput, diff --git a/clients/client-networkmanager/models/models_0.ts b/clients/client-networkmanager/models/models_0.ts index 9180b538c117..9d9dd8c13436 100644 --- a/clients/client-networkmanager/models/models_0.ts +++ b/clients/client-networkmanager/models/models_0.ts @@ -11,6 +11,9 @@ export interface AccessDeniedException extends __SmithyException, $MetadataBeare } export namespace AccessDeniedException { + /** + * @internal + */ export const filterSensitiveLog = (obj: AccessDeniedException): any => ({ ...obj, }); @@ -40,6 +43,9 @@ export interface AssociateCustomerGatewayRequest { } export namespace AssociateCustomerGatewayRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: AssociateCustomerGatewayRequest): any => ({ ...obj, }); @@ -83,6 +89,9 @@ export interface CustomerGatewayAssociation { } export namespace CustomerGatewayAssociation { + /** + * @internal + */ export const filterSensitiveLog = (obj: CustomerGatewayAssociation): any => ({ ...obj, }); @@ -96,6 +105,9 @@ export interface AssociateCustomerGatewayResponse { } export namespace AssociateCustomerGatewayResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: AssociateCustomerGatewayResponse): any => ({ ...obj, }); @@ -121,6 +133,9 @@ export interface ConflictException extends __SmithyException, $MetadataBearer { } export namespace ConflictException { + /** + * @internal + */ export const filterSensitiveLog = (obj: ConflictException): any => ({ ...obj, }); @@ -140,6 +155,9 @@ export interface InternalServerException extends __SmithyException, $MetadataBea } export namespace InternalServerException { + /** + * @internal + */ export const filterSensitiveLog = (obj: InternalServerException): any => ({ ...obj, }); @@ -164,6 +182,9 @@ export interface ResourceNotFoundException extends __SmithyException, $MetadataB } export namespace ResourceNotFoundException { + /** + * @internal + */ export const filterSensitiveLog = (obj: ResourceNotFoundException): any => ({ ...obj, }); @@ -202,6 +223,9 @@ export interface ServiceQuotaExceededException extends __SmithyException, $Metad } export namespace ServiceQuotaExceededException { + /** + * @internal + */ export const filterSensitiveLog = (obj: ServiceQuotaExceededException): any => ({ ...obj, }); @@ -221,6 +245,9 @@ export interface ThrottlingException extends __SmithyException, $MetadataBearer } export namespace ThrottlingException { + /** + * @internal + */ export const filterSensitiveLog = (obj: ThrottlingException): any => ({ ...obj, }); @@ -242,6 +269,9 @@ export interface ValidationExceptionField { } export namespace ValidationExceptionField { + /** + * @internal + */ export const filterSensitiveLog = (obj: ValidationExceptionField): any => ({ ...obj, }); @@ -273,6 +303,9 @@ export interface ValidationException extends __SmithyException, $MetadataBearer } export namespace ValidationException { + /** + * @internal + */ export const filterSensitiveLog = (obj: ValidationException): any => ({ ...obj, }); @@ -296,6 +329,9 @@ export interface AssociateLinkRequest { } export namespace AssociateLinkRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: AssociateLinkRequest): any => ({ ...obj, }); @@ -334,6 +370,9 @@ export interface LinkAssociation { } export namespace LinkAssociation { + /** + * @internal + */ export const filterSensitiveLog = (obj: LinkAssociation): any => ({ ...obj, }); @@ -347,6 +386,9 @@ export interface AssociateLinkResponse { } export namespace AssociateLinkResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: AssociateLinkResponse): any => ({ ...obj, }); @@ -375,6 +417,9 @@ export interface AssociateTransitGatewayConnectPeerRequest { } export namespace AssociateTransitGatewayConnectPeerRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: AssociateTransitGatewayConnectPeerRequest): any => ({ ...obj, }); @@ -418,6 +463,9 @@ export interface TransitGatewayConnectPeerAssociation { } export namespace TransitGatewayConnectPeerAssociation { + /** + * @internal + */ export const filterSensitiveLog = (obj: TransitGatewayConnectPeerAssociation): any => ({ ...obj, }); @@ -431,6 +479,9 @@ export interface AssociateTransitGatewayConnectPeerResponse { } export namespace AssociateTransitGatewayConnectPeerResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: AssociateTransitGatewayConnectPeerResponse): any => ({ ...obj, }); @@ -452,6 +503,9 @@ export interface AWSLocation { } export namespace AWSLocation { + /** + * @internal + */ export const filterSensitiveLog = (obj: AWSLocation): any => ({ ...obj, }); @@ -473,6 +527,9 @@ export interface Bandwidth { } export namespace Bandwidth { + /** + * @internal + */ export const filterSensitiveLog = (obj: Bandwidth): any => ({ ...obj, }); @@ -503,6 +560,9 @@ export interface Tag { } export namespace Tag { + /** + * @internal + */ export const filterSensitiveLog = (obj: Tag): any => ({ ...obj, }); @@ -569,6 +629,9 @@ export interface Connection { } export namespace Connection { + /** + * @internal + */ export const filterSensitiveLog = (obj: Connection): any => ({ ...obj, }); @@ -613,6 +676,9 @@ export interface CreateConnectionRequest { } export namespace CreateConnectionRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateConnectionRequest): any => ({ ...obj, }); @@ -626,6 +692,9 @@ export interface CreateConnectionResponse { } export namespace CreateConnectionResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateConnectionResponse): any => ({ ...obj, }); @@ -652,6 +721,9 @@ export interface Location { } export namespace Location { + /** + * @internal + */ export const filterSensitiveLog = (obj: Location): any => ({ ...obj, }); @@ -714,6 +786,9 @@ export interface CreateDeviceRequest { } export namespace CreateDeviceRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateDeviceRequest): any => ({ ...obj, ...(obj.Location && { Location: SENSITIVE_STRING }), @@ -803,6 +878,9 @@ export interface Device { } export namespace Device { + /** + * @internal + */ export const filterSensitiveLog = (obj: Device): any => ({ ...obj, ...(obj.Location && { Location: SENSITIVE_STRING }), @@ -817,6 +895,9 @@ export interface CreateDeviceResponse { } export namespace CreateDeviceResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateDeviceResponse): any => ({ ...obj, ...(obj.Device && { Device: Device.filterSensitiveLog(obj.Device) }), @@ -837,6 +918,9 @@ export interface CreateGlobalNetworkRequest { } export namespace CreateGlobalNetworkRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateGlobalNetworkRequest): any => ({ ...obj, }); @@ -885,6 +969,9 @@ export interface GlobalNetwork { } export namespace GlobalNetwork { + /** + * @internal + */ export const filterSensitiveLog = (obj: GlobalNetwork): any => ({ ...obj, }); @@ -898,6 +985,9 @@ export interface CreateGlobalNetworkResponse { } export namespace CreateGlobalNetworkResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateGlobalNetworkResponse): any => ({ ...obj, }); @@ -946,6 +1036,9 @@ export interface CreateLinkRequest { } export namespace CreateLinkRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateLinkRequest): any => ({ ...obj, }); @@ -1019,6 +1112,9 @@ export interface Link { } export namespace Link { + /** + * @internal + */ export const filterSensitiveLog = (obj: Link): any => ({ ...obj, }); @@ -1032,6 +1128,9 @@ export interface CreateLinkResponse { } export namespace CreateLinkResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateLinkResponse): any => ({ ...obj, }); @@ -1075,6 +1174,9 @@ export interface CreateSiteRequest { } export namespace CreateSiteRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateSiteRequest): any => ({ ...obj, ...(obj.Location && { Location: SENSITIVE_STRING }), @@ -1134,6 +1236,9 @@ export interface Site { } export namespace Site { + /** + * @internal + */ export const filterSensitiveLog = (obj: Site): any => ({ ...obj, ...(obj.Location && { Location: SENSITIVE_STRING }), @@ -1148,6 +1253,9 @@ export interface CreateSiteResponse { } export namespace CreateSiteResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateSiteResponse): any => ({ ...obj, ...(obj.Site && { Site: Site.filterSensitiveLog(obj.Site) }), @@ -1167,6 +1275,9 @@ export interface DeleteConnectionRequest { } export namespace DeleteConnectionRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteConnectionRequest): any => ({ ...obj, }); @@ -1180,6 +1291,9 @@ export interface DeleteConnectionResponse { } export namespace DeleteConnectionResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteConnectionResponse): any => ({ ...obj, }); @@ -1198,6 +1312,9 @@ export interface DeleteDeviceRequest { } export namespace DeleteDeviceRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteDeviceRequest): any => ({ ...obj, }); @@ -1211,6 +1328,9 @@ export interface DeleteDeviceResponse { } export namespace DeleteDeviceResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteDeviceResponse): any => ({ ...obj, ...(obj.Device && { Device: Device.filterSensitiveLog(obj.Device) }), @@ -1225,6 +1345,9 @@ export interface DeleteGlobalNetworkRequest { } export namespace DeleteGlobalNetworkRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteGlobalNetworkRequest): any => ({ ...obj, }); @@ -1238,6 +1361,9 @@ export interface DeleteGlobalNetworkResponse { } export namespace DeleteGlobalNetworkResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteGlobalNetworkResponse): any => ({ ...obj, }); @@ -1256,6 +1382,9 @@ export interface DeleteLinkRequest { } export namespace DeleteLinkRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteLinkRequest): any => ({ ...obj, }); @@ -1269,6 +1398,9 @@ export interface DeleteLinkResponse { } export namespace DeleteLinkResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteLinkResponse): any => ({ ...obj, }); @@ -1287,6 +1419,9 @@ export interface DeleteSiteRequest { } export namespace DeleteSiteRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteSiteRequest): any => ({ ...obj, }); @@ -1300,6 +1435,9 @@ export interface DeleteSiteResponse { } export namespace DeleteSiteResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteSiteResponse): any => ({ ...obj, ...(obj.Site && { Site: Site.filterSensitiveLog(obj.Site) }), @@ -1319,6 +1457,9 @@ export interface DeregisterTransitGatewayRequest { } export namespace DeregisterTransitGatewayRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeregisterTransitGatewayRequest): any => ({ ...obj, }); @@ -1348,6 +1489,9 @@ export interface TransitGatewayRegistrationStateReason { } export namespace TransitGatewayRegistrationStateReason { + /** + * @internal + */ export const filterSensitiveLog = (obj: TransitGatewayRegistrationStateReason): any => ({ ...obj, }); @@ -1374,6 +1518,9 @@ export interface TransitGatewayRegistration { } export namespace TransitGatewayRegistration { + /** + * @internal + */ export const filterSensitiveLog = (obj: TransitGatewayRegistration): any => ({ ...obj, }); @@ -1387,6 +1534,9 @@ export interface DeregisterTransitGatewayResponse { } export namespace DeregisterTransitGatewayResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeregisterTransitGatewayResponse): any => ({ ...obj, }); @@ -1410,6 +1560,9 @@ export interface DescribeGlobalNetworksRequest { } export namespace DescribeGlobalNetworksRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeGlobalNetworksRequest): any => ({ ...obj, }); @@ -1428,6 +1581,9 @@ export interface DescribeGlobalNetworksResponse { } export namespace DescribeGlobalNetworksResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeGlobalNetworksResponse): any => ({ ...obj, }); @@ -1447,6 +1603,9 @@ export interface DisassociateCustomerGatewayRequest { } export namespace DisassociateCustomerGatewayRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DisassociateCustomerGatewayRequest): any => ({ ...obj, }); @@ -1460,6 +1619,9 @@ export interface DisassociateCustomerGatewayResponse { } export namespace DisassociateCustomerGatewayResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DisassociateCustomerGatewayResponse): any => ({ ...obj, }); @@ -1483,6 +1645,9 @@ export interface DisassociateLinkRequest { } export namespace DisassociateLinkRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DisassociateLinkRequest): any => ({ ...obj, }); @@ -1496,6 +1661,9 @@ export interface DisassociateLinkResponse { } export namespace DisassociateLinkResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DisassociateLinkResponse): any => ({ ...obj, }); @@ -1514,6 +1682,9 @@ export interface DisassociateTransitGatewayConnectPeerRequest { } export namespace DisassociateTransitGatewayConnectPeerRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DisassociateTransitGatewayConnectPeerRequest): any => ({ ...obj, }); @@ -1527,6 +1698,9 @@ export interface DisassociateTransitGatewayConnectPeerResponse { } export namespace DisassociateTransitGatewayConnectPeerResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DisassociateTransitGatewayConnectPeerResponse): any => ({ ...obj, }); @@ -1560,6 +1734,9 @@ export interface GetConnectionsRequest { } export namespace GetConnectionsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetConnectionsRequest): any => ({ ...obj, }); @@ -1578,6 +1755,9 @@ export interface GetConnectionsResponse { } export namespace GetConnectionsResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetConnectionsResponse): any => ({ ...obj, }); @@ -1607,6 +1787,9 @@ export interface GetCustomerGatewayAssociationsRequest { } export namespace GetCustomerGatewayAssociationsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetCustomerGatewayAssociationsRequest): any => ({ ...obj, }); @@ -1625,6 +1808,9 @@ export interface GetCustomerGatewayAssociationsResponse { } export namespace GetCustomerGatewayAssociationsResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetCustomerGatewayAssociationsResponse): any => ({ ...obj, }); @@ -1658,6 +1844,9 @@ export interface GetDevicesRequest { } export namespace GetDevicesRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetDevicesRequest): any => ({ ...obj, }); @@ -1676,6 +1865,9 @@ export interface GetDevicesResponse { } export namespace GetDevicesResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetDevicesResponse): any => ({ ...obj, ...(obj.Devices && { Devices: obj.Devices.map((item) => Device.filterSensitiveLog(item)) }), @@ -1710,6 +1902,9 @@ export interface GetLinkAssociationsRequest { } export namespace GetLinkAssociationsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetLinkAssociationsRequest): any => ({ ...obj, }); @@ -1728,6 +1923,9 @@ export interface GetLinkAssociationsResponse { } export namespace GetLinkAssociationsResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetLinkAssociationsResponse): any => ({ ...obj, }); @@ -1771,6 +1969,9 @@ export interface GetLinksRequest { } export namespace GetLinksRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetLinksRequest): any => ({ ...obj, }); @@ -1789,6 +1990,9 @@ export interface GetLinksResponse { } export namespace GetLinksResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetLinksResponse): any => ({ ...obj, }); @@ -1817,6 +2021,9 @@ export interface GetSitesRequest { } export namespace GetSitesRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetSitesRequest): any => ({ ...obj, }); @@ -1835,6 +2042,9 @@ export interface GetSitesResponse { } export namespace GetSitesResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetSitesResponse): any => ({ ...obj, ...(obj.Sites && { Sites: obj.Sites.map((item) => Site.filterSensitiveLog(item)) }), @@ -1864,6 +2074,9 @@ export interface GetTransitGatewayConnectPeerAssociationsRequest { } export namespace GetTransitGatewayConnectPeerAssociationsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetTransitGatewayConnectPeerAssociationsRequest): any => ({ ...obj, }); @@ -1882,6 +2095,9 @@ export interface GetTransitGatewayConnectPeerAssociationsResponse { } export namespace GetTransitGatewayConnectPeerAssociationsResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetTransitGatewayConnectPeerAssociationsResponse): any => ({ ...obj, }); @@ -1911,6 +2127,9 @@ export interface GetTransitGatewayRegistrationsRequest { } export namespace GetTransitGatewayRegistrationsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetTransitGatewayRegistrationsRequest): any => ({ ...obj, }); @@ -1929,6 +2148,9 @@ export interface GetTransitGatewayRegistrationsResponse { } export namespace GetTransitGatewayRegistrationsResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetTransitGatewayRegistrationsResponse): any => ({ ...obj, }); @@ -1942,6 +2164,9 @@ export interface ListTagsForResourceRequest { } export namespace ListTagsForResourceRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListTagsForResourceRequest): any => ({ ...obj, }); @@ -1955,6 +2180,9 @@ export interface ListTagsForResourceResponse { } export namespace ListTagsForResourceResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListTagsForResourceResponse): any => ({ ...obj, }); @@ -1974,6 +2202,9 @@ export interface RegisterTransitGatewayRequest { } export namespace RegisterTransitGatewayRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: RegisterTransitGatewayRequest): any => ({ ...obj, }); @@ -1987,6 +2218,9 @@ export interface RegisterTransitGatewayResponse { } export namespace RegisterTransitGatewayResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: RegisterTransitGatewayResponse): any => ({ ...obj, }); @@ -2005,6 +2239,9 @@ export interface TagResourceRequest { } export namespace TagResourceRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: TagResourceRequest): any => ({ ...obj, }); @@ -2013,6 +2250,9 @@ export namespace TagResourceRequest { export interface TagResourceResponse {} export namespace TagResourceResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: TagResourceResponse): any => ({ ...obj, }); @@ -2031,6 +2271,9 @@ export interface UntagResourceRequest { } export namespace UntagResourceRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: UntagResourceRequest): any => ({ ...obj, }); @@ -2039,6 +2282,9 @@ export namespace UntagResourceRequest { export interface UntagResourceResponse {} export namespace UntagResourceResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: UntagResourceResponse): any => ({ ...obj, }); @@ -2073,6 +2319,9 @@ export interface UpdateConnectionRequest { } export namespace UpdateConnectionRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateConnectionRequest): any => ({ ...obj, }); @@ -2086,6 +2335,9 @@ export interface UpdateConnectionResponse { } export namespace UpdateConnectionResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateConnectionResponse): any => ({ ...obj, }); @@ -2148,6 +2400,9 @@ export interface UpdateDeviceRequest { } export namespace UpdateDeviceRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateDeviceRequest): any => ({ ...obj, ...(obj.Location && { Location: SENSITIVE_STRING }), @@ -2162,6 +2417,9 @@ export interface UpdateDeviceResponse { } export namespace UpdateDeviceResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateDeviceResponse): any => ({ ...obj, ...(obj.Device && { Device: Device.filterSensitiveLog(obj.Device) }), @@ -2182,6 +2440,9 @@ export interface UpdateGlobalNetworkRequest { } export namespace UpdateGlobalNetworkRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateGlobalNetworkRequest): any => ({ ...obj, }); @@ -2195,6 +2456,9 @@ export interface UpdateGlobalNetworkResponse { } export namespace UpdateGlobalNetworkResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateGlobalNetworkResponse): any => ({ ...obj, }); @@ -2236,6 +2500,9 @@ export interface UpdateLinkRequest { } export namespace UpdateLinkRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateLinkRequest): any => ({ ...obj, }); @@ -2249,6 +2516,9 @@ export interface UpdateLinkResponse { } export namespace UpdateLinkResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateLinkResponse): any => ({ ...obj, }); @@ -2292,6 +2562,9 @@ export interface UpdateSiteRequest { } export namespace UpdateSiteRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateSiteRequest): any => ({ ...obj, ...(obj.Location && { Location: SENSITIVE_STRING }), @@ -2306,6 +2579,9 @@ export interface UpdateSiteResponse { } export namespace UpdateSiteResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateSiteResponse): any => ({ ...obj, ...(obj.Site && { Site: Site.filterSensitiveLog(obj.Site) }), diff --git a/clients/client-nimble/commands/AcceptEulasCommand.ts b/clients/client-nimble/commands/AcceptEulasCommand.ts index c79f42a413d6..ca91c18309a5 100644 --- a/clients/client-nimble/commands/AcceptEulasCommand.ts +++ b/clients/client-nimble/commands/AcceptEulasCommand.ts @@ -22,6 +22,20 @@ export interface AcceptEulasCommandOutput extends AcceptEulasResponse, __Metadat /** *

Accept EULAs.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { NimbleClient, AcceptEulasCommand } from "@aws-sdk/client-nimble"; // ES Modules import + * // const { NimbleClient, AcceptEulasCommand } = require("@aws-sdk/client-nimble"); // CommonJS import + * const client = new NimbleClient(config); + * const command = new AcceptEulasCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link AcceptEulasCommandInput} for command's `input` shape. + * @see {@link AcceptEulasCommandOutput} for command's `response` shape. + * @see {@link NimbleClientResolvedConfig | config} for command's `input` shape. + * */ export class AcceptEulasCommand extends $Command< AcceptEulasCommandInput, diff --git a/clients/client-nimble/commands/CreateLaunchProfileCommand.ts b/clients/client-nimble/commands/CreateLaunchProfileCommand.ts index 8885b954dd4c..c8842a875091 100644 --- a/clients/client-nimble/commands/CreateLaunchProfileCommand.ts +++ b/clients/client-nimble/commands/CreateLaunchProfileCommand.ts @@ -22,6 +22,20 @@ export interface CreateLaunchProfileCommandOutput extends CreateLaunchProfileRes /** *

Create a launch profile.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { NimbleClient, CreateLaunchProfileCommand } from "@aws-sdk/client-nimble"; // ES Modules import + * // const { NimbleClient, CreateLaunchProfileCommand } = require("@aws-sdk/client-nimble"); // CommonJS import + * const client = new NimbleClient(config); + * const command = new CreateLaunchProfileCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreateLaunchProfileCommandInput} for command's `input` shape. + * @see {@link CreateLaunchProfileCommandOutput} for command's `response` shape. + * @see {@link NimbleClientResolvedConfig | config} for command's `input` shape. + * */ export class CreateLaunchProfileCommand extends $Command< CreateLaunchProfileCommandInput, diff --git a/clients/client-nimble/commands/CreateStreamingImageCommand.ts b/clients/client-nimble/commands/CreateStreamingImageCommand.ts index da9e53481b36..524c512cb27a 100644 --- a/clients/client-nimble/commands/CreateStreamingImageCommand.ts +++ b/clients/client-nimble/commands/CreateStreamingImageCommand.ts @@ -22,6 +22,20 @@ export interface CreateStreamingImageCommandOutput extends CreateStreamingImageR /** *

Creates a streaming image resource in a studio.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { NimbleClient, CreateStreamingImageCommand } from "@aws-sdk/client-nimble"; // ES Modules import + * // const { NimbleClient, CreateStreamingImageCommand } = require("@aws-sdk/client-nimble"); // CommonJS import + * const client = new NimbleClient(config); + * const command = new CreateStreamingImageCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreateStreamingImageCommandInput} for command's `input` shape. + * @see {@link CreateStreamingImageCommandOutput} for command's `response` shape. + * @see {@link NimbleClientResolvedConfig | config} for command's `input` shape. + * */ export class CreateStreamingImageCommand extends $Command< CreateStreamingImageCommandInput, diff --git a/clients/client-nimble/commands/CreateStreamingSessionCommand.ts b/clients/client-nimble/commands/CreateStreamingSessionCommand.ts index 5472f0cad9a6..d72904af8853 100644 --- a/clients/client-nimble/commands/CreateStreamingSessionCommand.ts +++ b/clients/client-nimble/commands/CreateStreamingSessionCommand.ts @@ -22,6 +22,20 @@ export interface CreateStreamingSessionCommandOutput extends CreateStreamingSess /** *

Creates a streaming session in a studio.

After invoking this operation, you must poll GetStreamingSession until the streaming session is in state READY.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { NimbleClient, CreateStreamingSessionCommand } from "@aws-sdk/client-nimble"; // ES Modules import + * // const { NimbleClient, CreateStreamingSessionCommand } = require("@aws-sdk/client-nimble"); // CommonJS import + * const client = new NimbleClient(config); + * const command = new CreateStreamingSessionCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreateStreamingSessionCommandInput} for command's `input` shape. + * @see {@link CreateStreamingSessionCommandOutput} for command's `response` shape. + * @see {@link NimbleClientResolvedConfig | config} for command's `input` shape. + * */ export class CreateStreamingSessionCommand extends $Command< CreateStreamingSessionCommandInput, diff --git a/clients/client-nimble/commands/CreateStreamingSessionStreamCommand.ts b/clients/client-nimble/commands/CreateStreamingSessionStreamCommand.ts index 5e6ea02f4507..05ae0387f721 100644 --- a/clients/client-nimble/commands/CreateStreamingSessionStreamCommand.ts +++ b/clients/client-nimble/commands/CreateStreamingSessionStreamCommand.ts @@ -24,6 +24,20 @@ export interface CreateStreamingSessionStreamCommandOutput /** *

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 state READY.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { NimbleClient, CreateStreamingSessionStreamCommand } from "@aws-sdk/client-nimble"; // ES Modules import + * // const { NimbleClient, CreateStreamingSessionStreamCommand } = require("@aws-sdk/client-nimble"); // CommonJS import + * const client = new NimbleClient(config); + * const command = new CreateStreamingSessionStreamCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreateStreamingSessionStreamCommandInput} for command's `input` shape. + * @see {@link CreateStreamingSessionStreamCommandOutput} for command's `response` shape. + * @see {@link NimbleClientResolvedConfig | config} for command's `input` shape. + * */ export class CreateStreamingSessionStreamCommand extends $Command< CreateStreamingSessionStreamCommandInput, diff --git a/clients/client-nimble/commands/CreateStudioCommand.ts b/clients/client-nimble/commands/CreateStudioCommand.ts index 35de64b31a05..3f0e484a2ed0 100644 --- a/clients/client-nimble/commands/CreateStudioCommand.ts +++ b/clients/client-nimble/commands/CreateStudioCommand.ts @@ -22,6 +22,20 @@ export interface CreateStudioCommandOutput extends CreateStudioResponse, __Metad /** *

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 AWS KMS key. By default, this key is owned by AWS and managed on your behalf. You may provide your own AWS KMS key when calling CreateStudio to encrypt this data using a key you own and manage.

When providing an AWS 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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { NimbleClient, CreateStudioCommand } from "@aws-sdk/client-nimble"; // ES Modules import + * // const { NimbleClient, CreateStudioCommand } = require("@aws-sdk/client-nimble"); // CommonJS import + * const client = new NimbleClient(config); + * const command = new CreateStudioCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreateStudioCommandInput} for command's `input` shape. + * @see {@link CreateStudioCommandOutput} for command's `response` shape. + * @see {@link NimbleClientResolvedConfig | config} for command's `input` shape. + * */ export class CreateStudioCommand extends $Command< CreateStudioCommandInput, diff --git a/clients/client-nimble/commands/CreateStudioComponentCommand.ts b/clients/client-nimble/commands/CreateStudioComponentCommand.ts index a236d7ae926c..78f03469c76c 100644 --- a/clients/client-nimble/commands/CreateStudioComponentCommand.ts +++ b/clients/client-nimble/commands/CreateStudioComponentCommand.ts @@ -22,6 +22,20 @@ export interface CreateStudioComponentCommandOutput extends CreateStudioComponen /** *

Creates a studio component resource.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { NimbleClient, CreateStudioComponentCommand } from "@aws-sdk/client-nimble"; // ES Modules import + * // const { NimbleClient, CreateStudioComponentCommand } = require("@aws-sdk/client-nimble"); // CommonJS import + * const client = new NimbleClient(config); + * const command = new CreateStudioComponentCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreateStudioComponentCommandInput} for command's `input` shape. + * @see {@link CreateStudioComponentCommandOutput} for command's `response` shape. + * @see {@link NimbleClientResolvedConfig | config} for command's `input` shape. + * */ export class CreateStudioComponentCommand extends $Command< CreateStudioComponentCommandInput, diff --git a/clients/client-nimble/commands/DeleteLaunchProfileCommand.ts b/clients/client-nimble/commands/DeleteLaunchProfileCommand.ts index 3a8757da79e0..6f3f6dff09ab 100644 --- a/clients/client-nimble/commands/DeleteLaunchProfileCommand.ts +++ b/clients/client-nimble/commands/DeleteLaunchProfileCommand.ts @@ -22,6 +22,20 @@ export interface DeleteLaunchProfileCommandOutput extends DeleteLaunchProfileRes /** *

Permanently delete a launch profile.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { NimbleClient, DeleteLaunchProfileCommand } from "@aws-sdk/client-nimble"; // ES Modules import + * // const { NimbleClient, DeleteLaunchProfileCommand } = require("@aws-sdk/client-nimble"); // CommonJS import + * const client = new NimbleClient(config); + * const command = new DeleteLaunchProfileCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteLaunchProfileCommandInput} for command's `input` shape. + * @see {@link DeleteLaunchProfileCommandOutput} for command's `response` shape. + * @see {@link NimbleClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteLaunchProfileCommand extends $Command< DeleteLaunchProfileCommandInput, diff --git a/clients/client-nimble/commands/DeleteLaunchProfileMemberCommand.ts b/clients/client-nimble/commands/DeleteLaunchProfileMemberCommand.ts index 6c0338b18723..63b3f9090bfa 100644 --- a/clients/client-nimble/commands/DeleteLaunchProfileMemberCommand.ts +++ b/clients/client-nimble/commands/DeleteLaunchProfileMemberCommand.ts @@ -22,6 +22,20 @@ export interface DeleteLaunchProfileMemberCommandOutput extends DeleteLaunchProf /** *

Delete a user from launch profile membership.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { NimbleClient, DeleteLaunchProfileMemberCommand } from "@aws-sdk/client-nimble"; // ES Modules import + * // const { NimbleClient, DeleteLaunchProfileMemberCommand } = require("@aws-sdk/client-nimble"); // CommonJS import + * const client = new NimbleClient(config); + * const command = new DeleteLaunchProfileMemberCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteLaunchProfileMemberCommandInput} for command's `input` shape. + * @see {@link DeleteLaunchProfileMemberCommandOutput} for command's `response` shape. + * @see {@link NimbleClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteLaunchProfileMemberCommand extends $Command< DeleteLaunchProfileMemberCommandInput, diff --git a/clients/client-nimble/commands/DeleteStreamingImageCommand.ts b/clients/client-nimble/commands/DeleteStreamingImageCommand.ts index 29a80aa4adf5..0d6e85187e61 100644 --- a/clients/client-nimble/commands/DeleteStreamingImageCommand.ts +++ b/clients/client-nimble/commands/DeleteStreamingImageCommand.ts @@ -22,6 +22,20 @@ export interface DeleteStreamingImageCommandOutput extends DeleteStreamingImageR /** *

Delete streaming image.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { NimbleClient, DeleteStreamingImageCommand } from "@aws-sdk/client-nimble"; // ES Modules import + * // const { NimbleClient, DeleteStreamingImageCommand } = require("@aws-sdk/client-nimble"); // CommonJS import + * const client = new NimbleClient(config); + * const command = new DeleteStreamingImageCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteStreamingImageCommandInput} for command's `input` shape. + * @see {@link DeleteStreamingImageCommandOutput} for command's `response` shape. + * @see {@link NimbleClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteStreamingImageCommand extends $Command< DeleteStreamingImageCommandInput, diff --git a/clients/client-nimble/commands/DeleteStreamingSessionCommand.ts b/clients/client-nimble/commands/DeleteStreamingSessionCommand.ts index db5c43e05336..4fc0e9f354c4 100644 --- a/clients/client-nimble/commands/DeleteStreamingSessionCommand.ts +++ b/clients/client-nimble/commands/DeleteStreamingSessionCommand.ts @@ -22,6 +22,20 @@ export interface DeleteStreamingSessionCommandOutput extends DeleteStreamingSess /** *

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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { NimbleClient, DeleteStreamingSessionCommand } from "@aws-sdk/client-nimble"; // ES Modules import + * // const { NimbleClient, DeleteStreamingSessionCommand } = require("@aws-sdk/client-nimble"); // CommonJS import + * const client = new NimbleClient(config); + * const command = new DeleteStreamingSessionCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteStreamingSessionCommandInput} for command's `input` shape. + * @see {@link DeleteStreamingSessionCommandOutput} for command's `response` shape. + * @see {@link NimbleClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteStreamingSessionCommand extends $Command< DeleteStreamingSessionCommandInput, diff --git a/clients/client-nimble/commands/DeleteStudioCommand.ts b/clients/client-nimble/commands/DeleteStudioCommand.ts index 298714775ca7..ed16db847dec 100644 --- a/clients/client-nimble/commands/DeleteStudioCommand.ts +++ b/clients/client-nimble/commands/DeleteStudioCommand.ts @@ -22,6 +22,20 @@ export interface DeleteStudioCommandOutput extends DeleteStudioResponse, __Metad /** *

Delete a studio resource.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { NimbleClient, DeleteStudioCommand } from "@aws-sdk/client-nimble"; // ES Modules import + * // const { NimbleClient, DeleteStudioCommand } = require("@aws-sdk/client-nimble"); // CommonJS import + * const client = new NimbleClient(config); + * const command = new DeleteStudioCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteStudioCommandInput} for command's `input` shape. + * @see {@link DeleteStudioCommandOutput} for command's `response` shape. + * @see {@link NimbleClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteStudioCommand extends $Command< DeleteStudioCommandInput, diff --git a/clients/client-nimble/commands/DeleteStudioComponentCommand.ts b/clients/client-nimble/commands/DeleteStudioComponentCommand.ts index 4ae6cfd08b4f..8125b7a509a9 100644 --- a/clients/client-nimble/commands/DeleteStudioComponentCommand.ts +++ b/clients/client-nimble/commands/DeleteStudioComponentCommand.ts @@ -22,6 +22,20 @@ export interface DeleteStudioComponentCommandOutput extends DeleteStudioComponen /** *

Deletes a studio component resource.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { NimbleClient, DeleteStudioComponentCommand } from "@aws-sdk/client-nimble"; // ES Modules import + * // const { NimbleClient, DeleteStudioComponentCommand } = require("@aws-sdk/client-nimble"); // CommonJS import + * const client = new NimbleClient(config); + * const command = new DeleteStudioComponentCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteStudioComponentCommandInput} for command's `input` shape. + * @see {@link DeleteStudioComponentCommandOutput} for command's `response` shape. + * @see {@link NimbleClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteStudioComponentCommand extends $Command< DeleteStudioComponentCommandInput, diff --git a/clients/client-nimble/commands/DeleteStudioMemberCommand.ts b/clients/client-nimble/commands/DeleteStudioMemberCommand.ts index f0132dce2c37..7550de836847 100644 --- a/clients/client-nimble/commands/DeleteStudioMemberCommand.ts +++ b/clients/client-nimble/commands/DeleteStudioMemberCommand.ts @@ -22,6 +22,20 @@ export interface DeleteStudioMemberCommandOutput extends DeleteStudioMemberRespo /** *

Delete a user from studio membership.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { NimbleClient, DeleteStudioMemberCommand } from "@aws-sdk/client-nimble"; // ES Modules import + * // const { NimbleClient, DeleteStudioMemberCommand } = require("@aws-sdk/client-nimble"); // CommonJS import + * const client = new NimbleClient(config); + * const command = new DeleteStudioMemberCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteStudioMemberCommandInput} for command's `input` shape. + * @see {@link DeleteStudioMemberCommandOutput} for command's `response` shape. + * @see {@link NimbleClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteStudioMemberCommand extends $Command< DeleteStudioMemberCommandInput, diff --git a/clients/client-nimble/commands/GetEulaCommand.ts b/clients/client-nimble/commands/GetEulaCommand.ts index 990c56987a4b..094da14b1199 100644 --- a/clients/client-nimble/commands/GetEulaCommand.ts +++ b/clients/client-nimble/commands/GetEulaCommand.ts @@ -22,6 +22,20 @@ export interface GetEulaCommandOutput extends GetEulaResponse, __MetadataBearer /** *

Get Eula.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { NimbleClient, GetEulaCommand } from "@aws-sdk/client-nimble"; // ES Modules import + * // const { NimbleClient, GetEulaCommand } = require("@aws-sdk/client-nimble"); // CommonJS import + * const client = new NimbleClient(config); + * const command = new GetEulaCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetEulaCommandInput} for command's `input` shape. + * @see {@link GetEulaCommandOutput} for command's `response` shape. + * @see {@link NimbleClientResolvedConfig | config} for command's `input` shape. + * */ export class GetEulaCommand extends $Command { // Start section: command_properties diff --git a/clients/client-nimble/commands/GetLaunchProfileCommand.ts b/clients/client-nimble/commands/GetLaunchProfileCommand.ts index 45c8786fb0c5..a45f411b336e 100644 --- a/clients/client-nimble/commands/GetLaunchProfileCommand.ts +++ b/clients/client-nimble/commands/GetLaunchProfileCommand.ts @@ -22,6 +22,20 @@ export interface GetLaunchProfileCommandOutput extends GetLaunchProfileResponse, /** *

Get a launch profile.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { NimbleClient, GetLaunchProfileCommand } from "@aws-sdk/client-nimble"; // ES Modules import + * // const { NimbleClient, GetLaunchProfileCommand } = require("@aws-sdk/client-nimble"); // CommonJS import + * const client = new NimbleClient(config); + * const command = new GetLaunchProfileCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetLaunchProfileCommandInput} for command's `input` shape. + * @see {@link GetLaunchProfileCommandOutput} for command's `response` shape. + * @see {@link NimbleClientResolvedConfig | config} for command's `input` shape. + * */ export class GetLaunchProfileCommand extends $Command< GetLaunchProfileCommandInput, diff --git a/clients/client-nimble/commands/GetLaunchProfileDetailsCommand.ts b/clients/client-nimble/commands/GetLaunchProfileDetailsCommand.ts index 7f6cd0a2788f..31076a23ebc1 100644 --- a/clients/client-nimble/commands/GetLaunchProfileDetailsCommand.ts +++ b/clients/client-nimble/commands/GetLaunchProfileDetailsCommand.ts @@ -22,6 +22,20 @@ export interface GetLaunchProfileDetailsCommandOutput extends GetLaunchProfileDe /** *

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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { NimbleClient, GetLaunchProfileDetailsCommand } from "@aws-sdk/client-nimble"; // ES Modules import + * // const { NimbleClient, GetLaunchProfileDetailsCommand } = require("@aws-sdk/client-nimble"); // CommonJS import + * const client = new NimbleClient(config); + * const command = new GetLaunchProfileDetailsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetLaunchProfileDetailsCommandInput} for command's `input` shape. + * @see {@link GetLaunchProfileDetailsCommandOutput} for command's `response` shape. + * @see {@link NimbleClientResolvedConfig | config} for command's `input` shape. + * */ export class GetLaunchProfileDetailsCommand extends $Command< GetLaunchProfileDetailsCommandInput, diff --git a/clients/client-nimble/commands/GetLaunchProfileInitializationCommand.ts b/clients/client-nimble/commands/GetLaunchProfileInitializationCommand.ts index 4bf407c0f1a4..da4bd0cc6fb5 100644 --- a/clients/client-nimble/commands/GetLaunchProfileInitializationCommand.ts +++ b/clients/client-nimble/commands/GetLaunchProfileInitializationCommand.ts @@ -24,6 +24,20 @@ export interface GetLaunchProfileInitializationCommandOutput /** *

Get a launch profile initialization.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { NimbleClient, GetLaunchProfileInitializationCommand } from "@aws-sdk/client-nimble"; // ES Modules import + * // const { NimbleClient, GetLaunchProfileInitializationCommand } = require("@aws-sdk/client-nimble"); // CommonJS import + * const client = new NimbleClient(config); + * const command = new GetLaunchProfileInitializationCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetLaunchProfileInitializationCommandInput} for command's `input` shape. + * @see {@link GetLaunchProfileInitializationCommandOutput} for command's `response` shape. + * @see {@link NimbleClientResolvedConfig | config} for command's `input` shape. + * */ export class GetLaunchProfileInitializationCommand extends $Command< GetLaunchProfileInitializationCommandInput, diff --git a/clients/client-nimble/commands/GetLaunchProfileMemberCommand.ts b/clients/client-nimble/commands/GetLaunchProfileMemberCommand.ts index ce3fc1b2ee35..a293f8f2b410 100644 --- a/clients/client-nimble/commands/GetLaunchProfileMemberCommand.ts +++ b/clients/client-nimble/commands/GetLaunchProfileMemberCommand.ts @@ -22,6 +22,20 @@ export interface GetLaunchProfileMemberCommandOutput extends GetLaunchProfileMem /** *

Get a user persona in launch profile membership.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { NimbleClient, GetLaunchProfileMemberCommand } from "@aws-sdk/client-nimble"; // ES Modules import + * // const { NimbleClient, GetLaunchProfileMemberCommand } = require("@aws-sdk/client-nimble"); // CommonJS import + * const client = new NimbleClient(config); + * const command = new GetLaunchProfileMemberCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetLaunchProfileMemberCommandInput} for command's `input` shape. + * @see {@link GetLaunchProfileMemberCommandOutput} for command's `response` shape. + * @see {@link NimbleClientResolvedConfig | config} for command's `input` shape. + * */ export class GetLaunchProfileMemberCommand extends $Command< GetLaunchProfileMemberCommandInput, diff --git a/clients/client-nimble/commands/GetStreamingImageCommand.ts b/clients/client-nimble/commands/GetStreamingImageCommand.ts index 02b2223a0f78..60da204838b8 100644 --- a/clients/client-nimble/commands/GetStreamingImageCommand.ts +++ b/clients/client-nimble/commands/GetStreamingImageCommand.ts @@ -22,6 +22,20 @@ export interface GetStreamingImageCommandOutput extends GetStreamingImageRespons /** *

Get streaming image.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { NimbleClient, GetStreamingImageCommand } from "@aws-sdk/client-nimble"; // ES Modules import + * // const { NimbleClient, GetStreamingImageCommand } = require("@aws-sdk/client-nimble"); // CommonJS import + * const client = new NimbleClient(config); + * const command = new GetStreamingImageCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetStreamingImageCommandInput} for command's `input` shape. + * @see {@link GetStreamingImageCommandOutput} for command's `response` shape. + * @see {@link NimbleClientResolvedConfig | config} for command's `input` shape. + * */ export class GetStreamingImageCommand extends $Command< GetStreamingImageCommandInput, diff --git a/clients/client-nimble/commands/GetStreamingSessionCommand.ts b/clients/client-nimble/commands/GetStreamingSessionCommand.ts index 6d27d6d786e5..88c91ac73c2c 100644 --- a/clients/client-nimble/commands/GetStreamingSessionCommand.ts +++ b/clients/client-nimble/commands/GetStreamingSessionCommand.ts @@ -22,6 +22,20 @@ export interface GetStreamingSessionCommandOutput extends GetStreamingSessionRes /** *

Gets StreamingSession resource.

Invoke this operation to poll for a streaming session state while creating or deleting a session.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { NimbleClient, GetStreamingSessionCommand } from "@aws-sdk/client-nimble"; // ES Modules import + * // const { NimbleClient, GetStreamingSessionCommand } = require("@aws-sdk/client-nimble"); // CommonJS import + * const client = new NimbleClient(config); + * const command = new GetStreamingSessionCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetStreamingSessionCommandInput} for command's `input` shape. + * @see {@link GetStreamingSessionCommandOutput} for command's `response` shape. + * @see {@link NimbleClientResolvedConfig | config} for command's `input` shape. + * */ export class GetStreamingSessionCommand extends $Command< GetStreamingSessionCommandInput, diff --git a/clients/client-nimble/commands/GetStreamingSessionStreamCommand.ts b/clients/client-nimble/commands/GetStreamingSessionStreamCommand.ts index 5ee90b1020f2..64bd55261821 100644 --- a/clients/client-nimble/commands/GetStreamingSessionStreamCommand.ts +++ b/clients/client-nimble/commands/GetStreamingSessionStreamCommand.ts @@ -22,6 +22,20 @@ export interface GetStreamingSessionStreamCommandOutput extends GetStreamingSess /** *

Gets a StreamingSessionStream for a streaming session.

Invoke this operation to poll the resource after invoking CreateStreamingSessionStream.

After the StreamingSessionStream changes to the state READY, the url property will contain a stream to be used with the DCV streaming client.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { NimbleClient, GetStreamingSessionStreamCommand } from "@aws-sdk/client-nimble"; // ES Modules import + * // const { NimbleClient, GetStreamingSessionStreamCommand } = require("@aws-sdk/client-nimble"); // CommonJS import + * const client = new NimbleClient(config); + * const command = new GetStreamingSessionStreamCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetStreamingSessionStreamCommandInput} for command's `input` shape. + * @see {@link GetStreamingSessionStreamCommandOutput} for command's `response` shape. + * @see {@link NimbleClientResolvedConfig | config} for command's `input` shape. + * */ export class GetStreamingSessionStreamCommand extends $Command< GetStreamingSessionStreamCommandInput, diff --git a/clients/client-nimble/commands/GetStudioCommand.ts b/clients/client-nimble/commands/GetStudioCommand.ts index f458e88f880c..9f02207c0a2a 100644 --- a/clients/client-nimble/commands/GetStudioCommand.ts +++ b/clients/client-nimble/commands/GetStudioCommand.ts @@ -22,6 +22,20 @@ export interface GetStudioCommandOutput extends GetStudioResponse, __MetadataBea /** *

Get a Studio resource.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { NimbleClient, GetStudioCommand } from "@aws-sdk/client-nimble"; // ES Modules import + * // const { NimbleClient, GetStudioCommand } = require("@aws-sdk/client-nimble"); // CommonJS import + * const client = new NimbleClient(config); + * const command = new GetStudioCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetStudioCommandInput} for command's `input` shape. + * @see {@link GetStudioCommandOutput} for command's `response` shape. + * @see {@link NimbleClientResolvedConfig | config} for command's `input` shape. + * */ export class GetStudioCommand extends $Command< GetStudioCommandInput, diff --git a/clients/client-nimble/commands/GetStudioComponentCommand.ts b/clients/client-nimble/commands/GetStudioComponentCommand.ts index 6bd49931ce02..015f882bd3fb 100644 --- a/clients/client-nimble/commands/GetStudioComponentCommand.ts +++ b/clients/client-nimble/commands/GetStudioComponentCommand.ts @@ -22,6 +22,20 @@ export interface GetStudioComponentCommandOutput extends GetStudioComponentRespo /** *

Gets a studio component resource.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { NimbleClient, GetStudioComponentCommand } from "@aws-sdk/client-nimble"; // ES Modules import + * // const { NimbleClient, GetStudioComponentCommand } = require("@aws-sdk/client-nimble"); // CommonJS import + * const client = new NimbleClient(config); + * const command = new GetStudioComponentCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetStudioComponentCommandInput} for command's `input` shape. + * @see {@link GetStudioComponentCommandOutput} for command's `response` shape. + * @see {@link NimbleClientResolvedConfig | config} for command's `input` shape. + * */ export class GetStudioComponentCommand extends $Command< GetStudioComponentCommandInput, diff --git a/clients/client-nimble/commands/GetStudioMemberCommand.ts b/clients/client-nimble/commands/GetStudioMemberCommand.ts index fe57c48aa451..51f0f32a3c29 100644 --- a/clients/client-nimble/commands/GetStudioMemberCommand.ts +++ b/clients/client-nimble/commands/GetStudioMemberCommand.ts @@ -22,6 +22,20 @@ export interface GetStudioMemberCommandOutput extends GetStudioMemberResponse, _ /** *

Get a user's membership in a studio.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { NimbleClient, GetStudioMemberCommand } from "@aws-sdk/client-nimble"; // ES Modules import + * // const { NimbleClient, GetStudioMemberCommand } = require("@aws-sdk/client-nimble"); // CommonJS import + * const client = new NimbleClient(config); + * const command = new GetStudioMemberCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetStudioMemberCommandInput} for command's `input` shape. + * @see {@link GetStudioMemberCommandOutput} for command's `response` shape. + * @see {@link NimbleClientResolvedConfig | config} for command's `input` shape. + * */ export class GetStudioMemberCommand extends $Command< GetStudioMemberCommandInput, diff --git a/clients/client-nimble/commands/ListEulaAcceptancesCommand.ts b/clients/client-nimble/commands/ListEulaAcceptancesCommand.ts index 933c1d7a4099..f2268c4308f6 100644 --- a/clients/client-nimble/commands/ListEulaAcceptancesCommand.ts +++ b/clients/client-nimble/commands/ListEulaAcceptancesCommand.ts @@ -22,6 +22,20 @@ export interface ListEulaAcceptancesCommandOutput extends ListEulaAcceptancesRes /** *

List Eula Acceptances.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { NimbleClient, ListEulaAcceptancesCommand } from "@aws-sdk/client-nimble"; // ES Modules import + * // const { NimbleClient, ListEulaAcceptancesCommand } = require("@aws-sdk/client-nimble"); // CommonJS import + * const client = new NimbleClient(config); + * const command = new ListEulaAcceptancesCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListEulaAcceptancesCommandInput} for command's `input` shape. + * @see {@link ListEulaAcceptancesCommandOutput} for command's `response` shape. + * @see {@link NimbleClientResolvedConfig | config} for command's `input` shape. + * */ export class ListEulaAcceptancesCommand extends $Command< ListEulaAcceptancesCommandInput, diff --git a/clients/client-nimble/commands/ListEulasCommand.ts b/clients/client-nimble/commands/ListEulasCommand.ts index 7806fe023631..11e1471667c9 100644 --- a/clients/client-nimble/commands/ListEulasCommand.ts +++ b/clients/client-nimble/commands/ListEulasCommand.ts @@ -22,6 +22,20 @@ export interface ListEulasCommandOutput extends ListEulasResponse, __MetadataBea /** *

List Eulas.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { NimbleClient, ListEulasCommand } from "@aws-sdk/client-nimble"; // ES Modules import + * // const { NimbleClient, ListEulasCommand } = require("@aws-sdk/client-nimble"); // CommonJS import + * const client = new NimbleClient(config); + * const command = new ListEulasCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListEulasCommandInput} for command's `input` shape. + * @see {@link ListEulasCommandOutput} for command's `response` shape. + * @see {@link NimbleClientResolvedConfig | config} for command's `input` shape. + * */ export class ListEulasCommand extends $Command< ListEulasCommandInput, diff --git a/clients/client-nimble/commands/ListLaunchProfileMembersCommand.ts b/clients/client-nimble/commands/ListLaunchProfileMembersCommand.ts index 73e2fbe07c3a..ee8852777ee2 100644 --- a/clients/client-nimble/commands/ListLaunchProfileMembersCommand.ts +++ b/clients/client-nimble/commands/ListLaunchProfileMembersCommand.ts @@ -22,6 +22,20 @@ export interface ListLaunchProfileMembersCommandOutput extends ListLaunchProfile /** *

Get all users in a given launch profile membership.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { NimbleClient, ListLaunchProfileMembersCommand } from "@aws-sdk/client-nimble"; // ES Modules import + * // const { NimbleClient, ListLaunchProfileMembersCommand } = require("@aws-sdk/client-nimble"); // CommonJS import + * const client = new NimbleClient(config); + * const command = new ListLaunchProfileMembersCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListLaunchProfileMembersCommandInput} for command's `input` shape. + * @see {@link ListLaunchProfileMembersCommandOutput} for command's `response` shape. + * @see {@link NimbleClientResolvedConfig | config} for command's `input` shape. + * */ export class ListLaunchProfileMembersCommand extends $Command< ListLaunchProfileMembersCommandInput, diff --git a/clients/client-nimble/commands/ListLaunchProfilesCommand.ts b/clients/client-nimble/commands/ListLaunchProfilesCommand.ts index e00c7720d45f..24d642ce4558 100644 --- a/clients/client-nimble/commands/ListLaunchProfilesCommand.ts +++ b/clients/client-nimble/commands/ListLaunchProfilesCommand.ts @@ -22,6 +22,20 @@ export interface ListLaunchProfilesCommandOutput extends ListLaunchProfilesRespo /** *

List all the launch profiles a studio.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { NimbleClient, ListLaunchProfilesCommand } from "@aws-sdk/client-nimble"; // ES Modules import + * // const { NimbleClient, ListLaunchProfilesCommand } = require("@aws-sdk/client-nimble"); // CommonJS import + * const client = new NimbleClient(config); + * const command = new ListLaunchProfilesCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListLaunchProfilesCommandInput} for command's `input` shape. + * @see {@link ListLaunchProfilesCommandOutput} for command's `response` shape. + * @see {@link NimbleClientResolvedConfig | config} for command's `input` shape. + * */ export class ListLaunchProfilesCommand extends $Command< ListLaunchProfilesCommandInput, diff --git a/clients/client-nimble/commands/ListStreamingImagesCommand.ts b/clients/client-nimble/commands/ListStreamingImagesCommand.ts index c424ec1e36e1..f6af37d4d6ca 100644 --- a/clients/client-nimble/commands/ListStreamingImagesCommand.ts +++ b/clients/client-nimble/commands/ListStreamingImagesCommand.ts @@ -22,6 +22,20 @@ export interface ListStreamingImagesCommandOutput extends ListStreamingImagesRes /** *

List the streaming image resources available to this studio.

This list will contain both images provided by AWS, as well as streaming images that you have created in your studio.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { NimbleClient, ListStreamingImagesCommand } from "@aws-sdk/client-nimble"; // ES Modules import + * // const { NimbleClient, ListStreamingImagesCommand } = require("@aws-sdk/client-nimble"); // CommonJS import + * const client = new NimbleClient(config); + * const command = new ListStreamingImagesCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListStreamingImagesCommandInput} for command's `input` shape. + * @see {@link ListStreamingImagesCommandOutput} for command's `response` shape. + * @see {@link NimbleClientResolvedConfig | config} for command's `input` shape. + * */ export class ListStreamingImagesCommand extends $Command< ListStreamingImagesCommandInput, diff --git a/clients/client-nimble/commands/ListStreamingSessionsCommand.ts b/clients/client-nimble/commands/ListStreamingSessionsCommand.ts index 631393f01a30..7dead6fd9278 100644 --- a/clients/client-nimble/commands/ListStreamingSessionsCommand.ts +++ b/clients/client-nimble/commands/ListStreamingSessionsCommand.ts @@ -22,6 +22,20 @@ export interface ListStreamingSessionsCommandOutput extends ListStreamingSession /** *

Lists the streaming image resources in a studio.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { NimbleClient, ListStreamingSessionsCommand } from "@aws-sdk/client-nimble"; // ES Modules import + * // const { NimbleClient, ListStreamingSessionsCommand } = require("@aws-sdk/client-nimble"); // CommonJS import + * const client = new NimbleClient(config); + * const command = new ListStreamingSessionsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListStreamingSessionsCommandInput} for command's `input` shape. + * @see {@link ListStreamingSessionsCommandOutput} for command's `response` shape. + * @see {@link NimbleClientResolvedConfig | config} for command's `input` shape. + * */ export class ListStreamingSessionsCommand extends $Command< ListStreamingSessionsCommandInput, diff --git a/clients/client-nimble/commands/ListStudioComponentsCommand.ts b/clients/client-nimble/commands/ListStudioComponentsCommand.ts index 2d827010dbf2..2b23499bf865 100644 --- a/clients/client-nimble/commands/ListStudioComponentsCommand.ts +++ b/clients/client-nimble/commands/ListStudioComponentsCommand.ts @@ -22,6 +22,20 @@ export interface ListStudioComponentsCommandOutput extends ListStudioComponentsR /** *

Lists the StudioComponents in a studio.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { NimbleClient, ListStudioComponentsCommand } from "@aws-sdk/client-nimble"; // ES Modules import + * // const { NimbleClient, ListStudioComponentsCommand } = require("@aws-sdk/client-nimble"); // CommonJS import + * const client = new NimbleClient(config); + * const command = new ListStudioComponentsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListStudioComponentsCommandInput} for command's `input` shape. + * @see {@link ListStudioComponentsCommandOutput} for command's `response` shape. + * @see {@link NimbleClientResolvedConfig | config} for command's `input` shape. + * */ export class ListStudioComponentsCommand extends $Command< ListStudioComponentsCommandInput, diff --git a/clients/client-nimble/commands/ListStudioMembersCommand.ts b/clients/client-nimble/commands/ListStudioMembersCommand.ts index 8936539687d0..1622f364cb7b 100644 --- a/clients/client-nimble/commands/ListStudioMembersCommand.ts +++ b/clients/client-nimble/commands/ListStudioMembersCommand.ts @@ -22,6 +22,20 @@ export interface ListStudioMembersCommandOutput extends ListStudioMembersRespons /** *

Get all users in a given studio membership.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { NimbleClient, ListStudioMembersCommand } from "@aws-sdk/client-nimble"; // ES Modules import + * // const { NimbleClient, ListStudioMembersCommand } = require("@aws-sdk/client-nimble"); // CommonJS import + * const client = new NimbleClient(config); + * const command = new ListStudioMembersCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListStudioMembersCommandInput} for command's `input` shape. + * @see {@link ListStudioMembersCommandOutput} for command's `response` shape. + * @see {@link NimbleClientResolvedConfig | config} for command's `input` shape. + * */ export class ListStudioMembersCommand extends $Command< ListStudioMembersCommandInput, diff --git a/clients/client-nimble/commands/ListStudiosCommand.ts b/clients/client-nimble/commands/ListStudiosCommand.ts index ae45158d8a03..4af31ee272d6 100644 --- a/clients/client-nimble/commands/ListStudiosCommand.ts +++ b/clients/client-nimble/commands/ListStudiosCommand.ts @@ -22,6 +22,20 @@ export interface ListStudiosCommandOutput extends ListStudiosResponse, __Metadat /** *

List studios in your AWS account in the requested AWS Region.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { NimbleClient, ListStudiosCommand } from "@aws-sdk/client-nimble"; // ES Modules import + * // const { NimbleClient, ListStudiosCommand } = require("@aws-sdk/client-nimble"); // CommonJS import + * const client = new NimbleClient(config); + * const command = new ListStudiosCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListStudiosCommandInput} for command's `input` shape. + * @see {@link ListStudiosCommandOutput} for command's `response` shape. + * @see {@link NimbleClientResolvedConfig | config} for command's `input` shape. + * */ export class ListStudiosCommand extends $Command< ListStudiosCommandInput, diff --git a/clients/client-nimble/commands/ListTagsForResourceCommand.ts b/clients/client-nimble/commands/ListTagsForResourceCommand.ts index 5bc5d7834976..89c57108ee21 100644 --- a/clients/client-nimble/commands/ListTagsForResourceCommand.ts +++ b/clients/client-nimble/commands/ListTagsForResourceCommand.ts @@ -22,6 +22,20 @@ export interface ListTagsForResourceCommandOutput extends ListTagsForResourceRes /** *

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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { NimbleClient, ListTagsForResourceCommand } from "@aws-sdk/client-nimble"; // ES Modules import + * // const { NimbleClient, ListTagsForResourceCommand } = require("@aws-sdk/client-nimble"); // CommonJS import + * const client = new NimbleClient(config); + * const command = new ListTagsForResourceCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListTagsForResourceCommandInput} for command's `input` shape. + * @see {@link ListTagsForResourceCommandOutput} for command's `response` shape. + * @see {@link NimbleClientResolvedConfig | config} for command's `input` shape. + * */ export class ListTagsForResourceCommand extends $Command< ListTagsForResourceCommandInput, diff --git a/clients/client-nimble/commands/PutLaunchProfileMembersCommand.ts b/clients/client-nimble/commands/PutLaunchProfileMembersCommand.ts index a8a8518fa5dd..e062fa462daf 100644 --- a/clients/client-nimble/commands/PutLaunchProfileMembersCommand.ts +++ b/clients/client-nimble/commands/PutLaunchProfileMembersCommand.ts @@ -22,6 +22,20 @@ export interface PutLaunchProfileMembersCommandOutput extends PutLaunchProfileMe /** *

Add/update users with given persona to launch profile membership.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { NimbleClient, PutLaunchProfileMembersCommand } from "@aws-sdk/client-nimble"; // ES Modules import + * // const { NimbleClient, PutLaunchProfileMembersCommand } = require("@aws-sdk/client-nimble"); // CommonJS import + * const client = new NimbleClient(config); + * const command = new PutLaunchProfileMembersCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link PutLaunchProfileMembersCommandInput} for command's `input` shape. + * @see {@link PutLaunchProfileMembersCommandOutput} for command's `response` shape. + * @see {@link NimbleClientResolvedConfig | config} for command's `input` shape. + * */ export class PutLaunchProfileMembersCommand extends $Command< PutLaunchProfileMembersCommandInput, diff --git a/clients/client-nimble/commands/PutStudioMembersCommand.ts b/clients/client-nimble/commands/PutStudioMembersCommand.ts index 7584e6af0f9f..8dec94e56b83 100644 --- a/clients/client-nimble/commands/PutStudioMembersCommand.ts +++ b/clients/client-nimble/commands/PutStudioMembersCommand.ts @@ -22,6 +22,20 @@ export interface PutStudioMembersCommandOutput extends PutStudioMembersResponse, /** *

Add/update users with given persona to studio membership.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { NimbleClient, PutStudioMembersCommand } from "@aws-sdk/client-nimble"; // ES Modules import + * // const { NimbleClient, PutStudioMembersCommand } = require("@aws-sdk/client-nimble"); // CommonJS import + * const client = new NimbleClient(config); + * const command = new PutStudioMembersCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link PutStudioMembersCommandInput} for command's `input` shape. + * @see {@link PutStudioMembersCommandOutput} for command's `response` shape. + * @see {@link NimbleClientResolvedConfig | config} for command's `input` shape. + * */ export class PutStudioMembersCommand extends $Command< PutStudioMembersCommandInput, diff --git a/clients/client-nimble/commands/StartStudioSSOConfigurationRepairCommand.ts b/clients/client-nimble/commands/StartStudioSSOConfigurationRepairCommand.ts index 64a8f9622e39..4aef409c88ce 100644 --- a/clients/client-nimble/commands/StartStudioSSOConfigurationRepairCommand.ts +++ b/clients/client-nimble/commands/StartStudioSSOConfigurationRepairCommand.ts @@ -27,6 +27,20 @@ export interface StartStudioSSOConfigurationRepairCommandOutput /** *

Repairs the SSO configuration for a given studio.

If the studio has a valid AWS SSO configuration currently associated with it, this operation will fail with a validation error.

If the studio does not have a valid AWS SSO configuration currently associated with it, then a new AWS SSO application is created for the studio and the studio is changed to the READY state.

After the AWS SSO application is repaired, you must use the Amazon Nimble Studio console to add administrators and users to your studio.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { NimbleClient, StartStudioSSOConfigurationRepairCommand } from "@aws-sdk/client-nimble"; // ES Modules import + * // const { NimbleClient, StartStudioSSOConfigurationRepairCommand } = require("@aws-sdk/client-nimble"); // CommonJS import + * const client = new NimbleClient(config); + * const command = new StartStudioSSOConfigurationRepairCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link StartStudioSSOConfigurationRepairCommandInput} for command's `input` shape. + * @see {@link StartStudioSSOConfigurationRepairCommandOutput} for command's `response` shape. + * @see {@link NimbleClientResolvedConfig | config} for command's `input` shape. + * */ export class StartStudioSSOConfigurationRepairCommand extends $Command< StartStudioSSOConfigurationRepairCommandInput, diff --git a/clients/client-nimble/commands/TagResourceCommand.ts b/clients/client-nimble/commands/TagResourceCommand.ts index 05b72e3314b1..763d0159733e 100644 --- a/clients/client-nimble/commands/TagResourceCommand.ts +++ b/clients/client-nimble/commands/TagResourceCommand.ts @@ -22,6 +22,20 @@ export interface TagResourceCommandOutput extends TagResourceResponse, __Metadat /** *

Creates tags for a resource, given its ARN.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { NimbleClient, TagResourceCommand } from "@aws-sdk/client-nimble"; // ES Modules import + * // const { NimbleClient, TagResourceCommand } = require("@aws-sdk/client-nimble"); // CommonJS import + * const client = new NimbleClient(config); + * const command = new TagResourceCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link TagResourceCommandInput} for command's `input` shape. + * @see {@link TagResourceCommandOutput} for command's `response` shape. + * @see {@link NimbleClientResolvedConfig | config} for command's `input` shape. + * */ export class TagResourceCommand extends $Command< TagResourceCommandInput, diff --git a/clients/client-nimble/commands/UntagResourceCommand.ts b/clients/client-nimble/commands/UntagResourceCommand.ts index bb421f689475..958d8ab73833 100644 --- a/clients/client-nimble/commands/UntagResourceCommand.ts +++ b/clients/client-nimble/commands/UntagResourceCommand.ts @@ -22,6 +22,20 @@ export interface UntagResourceCommandOutput extends UntagResourceResponse, __Met /** *

Deletes the tags for a resource.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { NimbleClient, UntagResourceCommand } from "@aws-sdk/client-nimble"; // ES Modules import + * // const { NimbleClient, UntagResourceCommand } = require("@aws-sdk/client-nimble"); // CommonJS import + * const client = new NimbleClient(config); + * const command = new UntagResourceCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link UntagResourceCommandInput} for command's `input` shape. + * @see {@link UntagResourceCommandOutput} for command's `response` shape. + * @see {@link NimbleClientResolvedConfig | config} for command's `input` shape. + * */ export class UntagResourceCommand extends $Command< UntagResourceCommandInput, diff --git a/clients/client-nimble/commands/UpdateLaunchProfileCommand.ts b/clients/client-nimble/commands/UpdateLaunchProfileCommand.ts index e0782eb67ffa..c5f62303f337 100644 --- a/clients/client-nimble/commands/UpdateLaunchProfileCommand.ts +++ b/clients/client-nimble/commands/UpdateLaunchProfileCommand.ts @@ -22,6 +22,20 @@ export interface UpdateLaunchProfileCommandOutput extends UpdateLaunchProfileRes /** *

Update a launch profile.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { NimbleClient, UpdateLaunchProfileCommand } from "@aws-sdk/client-nimble"; // ES Modules import + * // const { NimbleClient, UpdateLaunchProfileCommand } = require("@aws-sdk/client-nimble"); // CommonJS import + * const client = new NimbleClient(config); + * const command = new UpdateLaunchProfileCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link UpdateLaunchProfileCommandInput} for command's `input` shape. + * @see {@link UpdateLaunchProfileCommandOutput} for command's `response` shape. + * @see {@link NimbleClientResolvedConfig | config} for command's `input` shape. + * */ export class UpdateLaunchProfileCommand extends $Command< UpdateLaunchProfileCommandInput, diff --git a/clients/client-nimble/commands/UpdateLaunchProfileMemberCommand.ts b/clients/client-nimble/commands/UpdateLaunchProfileMemberCommand.ts index d4d570278cb1..a3466bc49429 100644 --- a/clients/client-nimble/commands/UpdateLaunchProfileMemberCommand.ts +++ b/clients/client-nimble/commands/UpdateLaunchProfileMemberCommand.ts @@ -22,6 +22,20 @@ export interface UpdateLaunchProfileMemberCommandOutput extends UpdateLaunchProf /** *

Update a user persona in launch profile membership.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { NimbleClient, UpdateLaunchProfileMemberCommand } from "@aws-sdk/client-nimble"; // ES Modules import + * // const { NimbleClient, UpdateLaunchProfileMemberCommand } = require("@aws-sdk/client-nimble"); // CommonJS import + * const client = new NimbleClient(config); + * const command = new UpdateLaunchProfileMemberCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link UpdateLaunchProfileMemberCommandInput} for command's `input` shape. + * @see {@link UpdateLaunchProfileMemberCommandOutput} for command's `response` shape. + * @see {@link NimbleClientResolvedConfig | config} for command's `input` shape. + * */ export class UpdateLaunchProfileMemberCommand extends $Command< UpdateLaunchProfileMemberCommandInput, diff --git a/clients/client-nimble/commands/UpdateStreamingImageCommand.ts b/clients/client-nimble/commands/UpdateStreamingImageCommand.ts index 3c9e5b7be3d5..762ca13de5d1 100644 --- a/clients/client-nimble/commands/UpdateStreamingImageCommand.ts +++ b/clients/client-nimble/commands/UpdateStreamingImageCommand.ts @@ -22,6 +22,20 @@ export interface UpdateStreamingImageCommandOutput extends UpdateStreamingImageR /** *

Update streaming image.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { NimbleClient, UpdateStreamingImageCommand } from "@aws-sdk/client-nimble"; // ES Modules import + * // const { NimbleClient, UpdateStreamingImageCommand } = require("@aws-sdk/client-nimble"); // CommonJS import + * const client = new NimbleClient(config); + * const command = new UpdateStreamingImageCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link UpdateStreamingImageCommandInput} for command's `input` shape. + * @see {@link UpdateStreamingImageCommandOutput} for command's `response` shape. + * @see {@link NimbleClientResolvedConfig | config} for command's `input` shape. + * */ export class UpdateStreamingImageCommand extends $Command< UpdateStreamingImageCommandInput, diff --git a/clients/client-nimble/commands/UpdateStudioCommand.ts b/clients/client-nimble/commands/UpdateStudioCommand.ts index 148d8ac19306..b2bbffbe137a 100644 --- a/clients/client-nimble/commands/UpdateStudioCommand.ts +++ b/clients/client-nimble/commands/UpdateStudioCommand.ts @@ -22,6 +22,20 @@ export interface UpdateStudioCommandOutput extends UpdateStudioResponse, __Metad /** *

Update a Studio resource.

Currently, this operation only supports updating the displayName of your studio.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { NimbleClient, UpdateStudioCommand } from "@aws-sdk/client-nimble"; // ES Modules import + * // const { NimbleClient, UpdateStudioCommand } = require("@aws-sdk/client-nimble"); // CommonJS import + * const client = new NimbleClient(config); + * const command = new UpdateStudioCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link UpdateStudioCommandInput} for command's `input` shape. + * @see {@link UpdateStudioCommandOutput} for command's `response` shape. + * @see {@link NimbleClientResolvedConfig | config} for command's `input` shape. + * */ export class UpdateStudioCommand extends $Command< UpdateStudioCommandInput, diff --git a/clients/client-nimble/commands/UpdateStudioComponentCommand.ts b/clients/client-nimble/commands/UpdateStudioComponentCommand.ts index 56cb8109eb6c..2cc09e107e4d 100644 --- a/clients/client-nimble/commands/UpdateStudioComponentCommand.ts +++ b/clients/client-nimble/commands/UpdateStudioComponentCommand.ts @@ -22,6 +22,20 @@ export interface UpdateStudioComponentCommandOutput extends UpdateStudioComponen /** *

Updates a studio component resource.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { NimbleClient, UpdateStudioComponentCommand } from "@aws-sdk/client-nimble"; // ES Modules import + * // const { NimbleClient, UpdateStudioComponentCommand } = require("@aws-sdk/client-nimble"); // CommonJS import + * const client = new NimbleClient(config); + * const command = new UpdateStudioComponentCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link UpdateStudioComponentCommandInput} for command's `input` shape. + * @see {@link UpdateStudioComponentCommandOutput} for command's `response` shape. + * @see {@link NimbleClientResolvedConfig | config} for command's `input` shape. + * */ export class UpdateStudioComponentCommand extends $Command< UpdateStudioComponentCommandInput, diff --git a/clients/client-nimble/models/models_0.ts b/clients/client-nimble/models/models_0.ts index fef24405612b..922b18f17a7b 100644 --- a/clients/client-nimble/models/models_0.ts +++ b/clients/client-nimble/models/models_0.ts @@ -22,6 +22,9 @@ export interface AcceptEulasRequest { } export namespace AcceptEulasRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: AcceptEulasRequest): any => ({ ...obj, }); @@ -55,6 +58,9 @@ export interface EulaAcceptance { } export namespace EulaAcceptance { + /** + * @internal + */ export const filterSensitiveLog = (obj: EulaAcceptance): any => ({ ...obj, }); @@ -68,6 +74,9 @@ export interface AcceptEulasResponse { } export namespace AcceptEulasResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: AcceptEulasResponse): any => ({ ...obj, }); @@ -93,6 +102,9 @@ export interface AccessDeniedException extends __SmithyException, $MetadataBeare } export namespace AccessDeniedException { + /** + * @internal + */ export const filterSensitiveLog = (obj: AccessDeniedException): any => ({ ...obj, }); @@ -118,6 +130,9 @@ export interface ConflictException extends __SmithyException, $MetadataBearer { } export namespace ConflictException { + /** + * @internal + */ export const filterSensitiveLog = (obj: ConflictException): any => ({ ...obj, }); @@ -143,6 +158,9 @@ export interface InternalServerErrorException extends __SmithyException, $Metada } export namespace InternalServerErrorException { + /** + * @internal + */ export const filterSensitiveLog = (obj: InternalServerErrorException): any => ({ ...obj, }); @@ -168,6 +186,9 @@ export interface ResourceNotFoundException extends __SmithyException, $MetadataB } export namespace ResourceNotFoundException { + /** + * @internal + */ export const filterSensitiveLog = (obj: ResourceNotFoundException): any => ({ ...obj, }); @@ -193,6 +214,9 @@ export interface ServiceQuotaExceededException extends __SmithyException, $Metad } export namespace ServiceQuotaExceededException { + /** + * @internal + */ export const filterSensitiveLog = (obj: ServiceQuotaExceededException): any => ({ ...obj, }); @@ -218,6 +242,9 @@ export interface ThrottlingException extends __SmithyException, $MetadataBearer } export namespace ThrottlingException { + /** + * @internal + */ export const filterSensitiveLog = (obj: ThrottlingException): any => ({ ...obj, }); @@ -243,6 +270,9 @@ export interface ValidationException extends __SmithyException, $MetadataBearer } export namespace ValidationException { + /** + * @internal + */ export const filterSensitiveLog = (obj: ValidationException): any => ({ ...obj, }); @@ -264,6 +294,9 @@ export interface ActiveDirectoryComputerAttribute { } export namespace ActiveDirectoryComputerAttribute { + /** + * @internal + */ export const filterSensitiveLog = (obj: ActiveDirectoryComputerAttribute): any => ({ ...obj, }); @@ -290,6 +323,9 @@ export interface ActiveDirectoryConfiguration { } export namespace ActiveDirectoryConfiguration { + /** + * @internal + */ export const filterSensitiveLog = (obj: ActiveDirectoryConfiguration): any => ({ ...obj, }); @@ -311,6 +347,9 @@ export interface ComputeFarmConfiguration { } export namespace ComputeFarmConfiguration { + /** + * @internal + */ export const filterSensitiveLog = (obj: ComputeFarmConfiguration): any => ({ ...obj, }); @@ -353,6 +392,9 @@ export interface StreamConfigurationCreate { } export namespace StreamConfigurationCreate { + /** + * @internal + */ export const filterSensitiveLog = (obj: StreamConfigurationCreate): any => ({ ...obj, }); @@ -405,6 +447,9 @@ export interface CreateLaunchProfileRequest { } export namespace CreateLaunchProfileRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateLaunchProfileRequest): any => ({ ...obj, }); @@ -463,6 +508,9 @@ export interface StreamConfiguration { } export namespace StreamConfiguration { + /** + * @internal + */ export const filterSensitiveLog = (obj: StreamConfiguration): any => ({ ...obj, }); @@ -551,6 +599,9 @@ export interface LaunchProfile { } export namespace LaunchProfile { + /** + * @internal + */ export const filterSensitiveLog = (obj: LaunchProfile): any => ({ ...obj, }); @@ -564,6 +615,9 @@ export interface CreateLaunchProfileResponse { } export namespace CreateLaunchProfileResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateLaunchProfileResponse): any => ({ ...obj, }); @@ -605,6 +659,9 @@ export interface CreateStreamingImageRequest { } export namespace CreateStreamingImageRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateStreamingImageRequest): any => ({ ...obj, }); @@ -627,6 +684,9 @@ export interface StreamingImageEncryptionConfiguration { } export namespace StreamingImageEncryptionConfiguration { + /** + * @internal + */ export const filterSensitiveLog = (obj: StreamingImageEncryptionConfiguration): any => ({ ...obj, }); @@ -720,6 +780,9 @@ export interface StreamingImage { } export namespace StreamingImage { + /** + * @internal + */ export const filterSensitiveLog = (obj: StreamingImage): any => ({ ...obj, }); @@ -730,6 +793,9 @@ export interface CreateStreamingImageResponse { } export namespace CreateStreamingImageResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateStreamingImageResponse): any => ({ ...obj, }); @@ -771,6 +837,9 @@ export interface CreateStreamingSessionRequest { } export namespace CreateStreamingSessionRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateStreamingSessionRequest): any => ({ ...obj, }); @@ -872,6 +941,9 @@ export interface StreamingSession { } export namespace StreamingSession { + /** + * @internal + */ export const filterSensitiveLog = (obj: StreamingSession): any => ({ ...obj, }); @@ -885,6 +957,9 @@ export interface CreateStreamingSessionResponse { } export namespace CreateStreamingSessionResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateStreamingSessionResponse): any => ({ ...obj, }); @@ -916,6 +991,9 @@ export interface CreateStreamingSessionStreamRequest { } export namespace CreateStreamingSessionStreamRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateStreamingSessionStreamRequest): any => ({ ...obj, }); @@ -977,6 +1055,9 @@ export interface StreamingSessionStream { } export namespace StreamingSessionStream { + /** + * @internal + */ export const filterSensitiveLog = (obj: StreamingSessionStream): any => ({ ...obj, }); @@ -990,6 +1071,9 @@ export interface CreateStreamingSessionStreamResponse { } export namespace CreateStreamingSessionStreamResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateStreamingSessionStreamResponse): any => ({ ...obj, }); @@ -1016,6 +1100,9 @@ export interface StudioEncryptionConfiguration { } export namespace StudioEncryptionConfiguration { + /** + * @internal + */ export const filterSensitiveLog = (obj: StudioEncryptionConfiguration): any => ({ ...obj, }); @@ -1062,6 +1149,9 @@ export interface CreateStudioRequest { } export namespace CreateStudioRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateStudioRequest): any => ({ ...obj, }); @@ -1182,6 +1272,9 @@ export interface Studio { } export namespace Studio { + /** + * @internal + */ export const filterSensitiveLog = (obj: Studio): any => ({ ...obj, }); @@ -1195,6 +1288,9 @@ export interface CreateStudioResponse { } export namespace CreateStudioResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateStudioResponse): any => ({ ...obj, }); @@ -1211,6 +1307,9 @@ export interface LicenseServiceConfiguration { } export namespace LicenseServiceConfiguration { + /** + * @internal + */ export const filterSensitiveLog = (obj: LicenseServiceConfiguration): any => ({ ...obj, }); @@ -1247,6 +1346,9 @@ export interface SharedFileSystemConfiguration { } export namespace SharedFileSystemConfiguration { + /** + * @internal + */ export const filterSensitiveLog = (obj: SharedFileSystemConfiguration): any => ({ ...obj, }); @@ -1278,6 +1380,9 @@ export interface StudioComponentConfiguration { } export namespace StudioComponentConfiguration { + /** + * @internal + */ export const filterSensitiveLog = (obj: StudioComponentConfiguration): any => ({ ...obj, }); @@ -1319,6 +1424,9 @@ export interface StudioComponentInitializationScript { } export namespace StudioComponentInitializationScript { + /** + * @internal + */ export const filterSensitiveLog = (obj: StudioComponentInitializationScript): any => ({ ...obj, }); @@ -1340,6 +1448,9 @@ export interface ScriptParameterKeyValue { } export namespace ScriptParameterKeyValue { + /** + * @internal + */ export const filterSensitiveLog = (obj: ScriptParameterKeyValue): any => ({ ...obj, }); @@ -1421,6 +1532,9 @@ export interface CreateStudioComponentRequest { } export namespace CreateStudioComponentRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateStudioComponentRequest): any => ({ ...obj, }); @@ -1546,6 +1660,9 @@ export interface StudioComponent { } export namespace StudioComponent { + /** + * @internal + */ export const filterSensitiveLog = (obj: StudioComponent): any => ({ ...obj, }); @@ -1559,6 +1676,9 @@ export interface CreateStudioComponentResponse { } export namespace CreateStudioComponentResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateStudioComponentResponse): any => ({ ...obj, }); @@ -1582,6 +1702,9 @@ export interface DeleteLaunchProfileRequest { } export namespace DeleteLaunchProfileRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteLaunchProfileRequest): any => ({ ...obj, }); @@ -1595,6 +1718,9 @@ export interface DeleteLaunchProfileResponse { } export namespace DeleteLaunchProfileResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteLaunchProfileResponse): any => ({ ...obj, }); @@ -1623,6 +1749,9 @@ export interface DeleteLaunchProfileMemberRequest { } export namespace DeleteLaunchProfileMemberRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteLaunchProfileMemberRequest): any => ({ ...obj, }); @@ -1631,6 +1760,9 @@ export namespace DeleteLaunchProfileMemberRequest { export interface DeleteLaunchProfileMemberResponse {} export namespace DeleteLaunchProfileMemberResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteLaunchProfileMemberResponse): any => ({ ...obj, }); @@ -1654,6 +1786,9 @@ export interface DeleteStreamingImageRequest { } export namespace DeleteStreamingImageRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteStreamingImageRequest): any => ({ ...obj, }); @@ -1667,6 +1802,9 @@ export interface DeleteStreamingImageResponse { } export namespace DeleteStreamingImageResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteStreamingImageResponse): any => ({ ...obj, }); @@ -1690,6 +1828,9 @@ export interface DeleteStreamingSessionRequest { } export namespace DeleteStreamingSessionRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteStreamingSessionRequest): any => ({ ...obj, }); @@ -1703,6 +1844,9 @@ export interface DeleteStreamingSessionResponse { } export namespace DeleteStreamingSessionResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteStreamingSessionResponse): any => ({ ...obj, }); @@ -1721,6 +1865,9 @@ export interface DeleteStudioRequest { } export namespace DeleteStudioRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteStudioRequest): any => ({ ...obj, }); @@ -1734,6 +1881,9 @@ export interface DeleteStudioResponse { } export namespace DeleteStudioResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteStudioResponse): any => ({ ...obj, }); @@ -1757,6 +1907,9 @@ export interface DeleteStudioComponentRequest { } export namespace DeleteStudioComponentRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteStudioComponentRequest): any => ({ ...obj, }); @@ -1770,6 +1923,9 @@ export interface DeleteStudioComponentResponse { } export namespace DeleteStudioComponentResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteStudioComponentResponse): any => ({ ...obj, }); @@ -1793,6 +1949,9 @@ export interface DeleteStudioMemberRequest { } export namespace DeleteStudioMemberRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteStudioMemberRequest): any => ({ ...obj, }); @@ -1801,6 +1960,9 @@ export namespace DeleteStudioMemberRequest { export interface DeleteStudioMemberResponse {} export namespace DeleteStudioMemberResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteStudioMemberResponse): any => ({ ...obj, }); @@ -1837,6 +1999,9 @@ export interface Eula { } export namespace Eula { + /** + * @internal + */ export const filterSensitiveLog = (obj: Eula): any => ({ ...obj, }); @@ -1850,6 +2015,9 @@ export interface GetEulaRequest { } export namespace GetEulaRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetEulaRequest): any => ({ ...obj, }); @@ -1863,6 +2031,9 @@ export interface GetEulaResponse { } export namespace GetEulaResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetEulaResponse): any => ({ ...obj, }); @@ -1881,6 +2052,9 @@ export interface GetLaunchProfileRequest { } export namespace GetLaunchProfileRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetLaunchProfileRequest): any => ({ ...obj, }); @@ -1894,6 +2068,9 @@ export interface GetLaunchProfileResponse { } export namespace GetLaunchProfileResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetLaunchProfileResponse): any => ({ ...obj, }); @@ -1912,6 +2089,9 @@ export interface GetLaunchProfileDetailsRequest { } export namespace GetLaunchProfileDetailsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetLaunchProfileDetailsRequest): any => ({ ...obj, }); @@ -1968,6 +2148,9 @@ export interface StudioComponentSummary { } export namespace StudioComponentSummary { + /** + * @internal + */ export const filterSensitiveLog = (obj: StudioComponentSummary): any => ({ ...obj, }); @@ -1991,6 +2174,9 @@ export interface GetLaunchProfileDetailsResponse { } export namespace GetLaunchProfileDetailsResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetLaunchProfileDetailsResponse): any => ({ ...obj, }); @@ -2024,6 +2210,9 @@ export interface GetLaunchProfileInitializationRequest { } export namespace GetLaunchProfileInitializationRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetLaunchProfileInitializationRequest): any => ({ ...obj, }); @@ -2067,6 +2256,9 @@ export interface LaunchProfileInitializationActiveDirectory { } export namespace LaunchProfileInitializationActiveDirectory { + /** + * @internal + */ export const filterSensitiveLog = (obj: LaunchProfileInitializationActiveDirectory): any => ({ ...obj, }); @@ -2090,6 +2282,9 @@ export interface LaunchProfileInitializationScript { } export namespace LaunchProfileInitializationScript { + /** + * @internal + */ export const filterSensitiveLog = (obj: LaunchProfileInitializationScript): any => ({ ...obj, }); @@ -2143,6 +2338,9 @@ export interface LaunchProfileInitialization { } export namespace LaunchProfileInitialization { + /** + * @internal + */ export const filterSensitiveLog = (obj: LaunchProfileInitialization): any => ({ ...obj, }); @@ -2156,6 +2354,9 @@ export interface GetLaunchProfileInitializationResponse { } export namespace GetLaunchProfileInitializationResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetLaunchProfileInitializationResponse): any => ({ ...obj, }); @@ -2179,6 +2380,9 @@ export interface GetLaunchProfileMemberRequest { } export namespace GetLaunchProfileMemberRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetLaunchProfileMemberRequest): any => ({ ...obj, }); @@ -2206,6 +2410,9 @@ export interface LaunchProfileMembership { } export namespace LaunchProfileMembership { + /** + * @internal + */ export const filterSensitiveLog = (obj: LaunchProfileMembership): any => ({ ...obj, }); @@ -2219,6 +2426,9 @@ export interface GetLaunchProfileMemberResponse { } export namespace GetLaunchProfileMemberResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetLaunchProfileMemberResponse): any => ({ ...obj, }); @@ -2237,6 +2447,9 @@ export interface GetStreamingImageRequest { } export namespace GetStreamingImageRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetStreamingImageRequest): any => ({ ...obj, }); @@ -2250,6 +2463,9 @@ export interface GetStreamingImageResponse { } export namespace GetStreamingImageResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetStreamingImageResponse): any => ({ ...obj, }); @@ -2268,6 +2484,9 @@ export interface GetStreamingSessionRequest { } export namespace GetStreamingSessionRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetStreamingSessionRequest): any => ({ ...obj, }); @@ -2281,6 +2500,9 @@ export interface GetStreamingSessionResponse { } export namespace GetStreamingSessionResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetStreamingSessionResponse): any => ({ ...obj, }); @@ -2304,6 +2526,9 @@ export interface GetStreamingSessionStreamRequest { } export namespace GetStreamingSessionStreamRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetStreamingSessionStreamRequest): any => ({ ...obj, }); @@ -2317,6 +2542,9 @@ export interface GetStreamingSessionStreamResponse { } export namespace GetStreamingSessionStreamResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetStreamingSessionStreamResponse): any => ({ ...obj, }); @@ -2330,6 +2558,9 @@ export interface GetStudioRequest { } export namespace GetStudioRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetStudioRequest): any => ({ ...obj, }); @@ -2343,6 +2574,9 @@ export interface GetStudioResponse { } export namespace GetStudioResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetStudioResponse): any => ({ ...obj, }); @@ -2361,6 +2595,9 @@ export interface GetStudioComponentRequest { } export namespace GetStudioComponentRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetStudioComponentRequest): any => ({ ...obj, }); @@ -2374,6 +2611,9 @@ export interface GetStudioComponentResponse { } export namespace GetStudioComponentResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetStudioComponentResponse): any => ({ ...obj, }); @@ -2392,6 +2632,9 @@ export interface GetStudioMemberRequest { } export namespace GetStudioMemberRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetStudioMemberRequest): any => ({ ...obj, }); @@ -2419,6 +2662,9 @@ export interface StudioMembership { } export namespace StudioMembership { + /** + * @internal + */ export const filterSensitiveLog = (obj: StudioMembership): any => ({ ...obj, }); @@ -2432,6 +2678,9 @@ export interface GetStudioMemberResponse { } export namespace GetStudioMemberResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetStudioMemberResponse): any => ({ ...obj, }); @@ -2455,6 +2704,9 @@ export interface ListEulaAcceptancesRequest { } export namespace ListEulaAcceptancesRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListEulaAcceptancesRequest): any => ({ ...obj, }); @@ -2473,6 +2725,9 @@ export interface ListEulaAcceptancesResponse { } export namespace ListEulaAcceptancesResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListEulaAcceptancesResponse): any => ({ ...obj, }); @@ -2491,6 +2746,9 @@ export interface ListEulasRequest { } export namespace ListEulasRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListEulasRequest): any => ({ ...obj, }); @@ -2509,6 +2767,9 @@ export interface ListEulasResponse { } export namespace ListEulasResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListEulasResponse): any => ({ ...obj, }); @@ -2537,6 +2798,9 @@ export interface ListLaunchProfileMembersRequest { } export namespace ListLaunchProfileMembersRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListLaunchProfileMembersRequest): any => ({ ...obj, }); @@ -2555,6 +2819,9 @@ export interface ListLaunchProfileMembersResponse { } export namespace ListLaunchProfileMembersResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListLaunchProfileMembersResponse): any => ({ ...obj, }); @@ -2588,6 +2855,9 @@ export interface ListLaunchProfilesRequest { } export namespace ListLaunchProfilesRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListLaunchProfilesRequest): any => ({ ...obj, }); @@ -2606,6 +2876,9 @@ export interface ListLaunchProfilesResponse { } export namespace ListLaunchProfilesResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListLaunchProfilesResponse): any => ({ ...obj, }); @@ -2629,6 +2902,9 @@ export interface ListStreamingImagesRequest { } export namespace ListStreamingImagesRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListStreamingImagesRequest): any => ({ ...obj, }); @@ -2647,6 +2923,9 @@ export interface ListStreamingImagesResponse { } export namespace ListStreamingImagesResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListStreamingImagesResponse): any => ({ ...obj, }); @@ -2675,6 +2954,9 @@ export interface ListStreamingSessionsRequest { } export namespace ListStreamingSessionsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListStreamingSessionsRequest): any => ({ ...obj, }); @@ -2693,6 +2975,9 @@ export interface ListStreamingSessionsResponse { } export namespace ListStreamingSessionsResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListStreamingSessionsResponse): any => ({ ...obj, }); @@ -2726,6 +3011,9 @@ export interface ListStudioComponentsRequest { } export namespace ListStudioComponentsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListStudioComponentsRequest): any => ({ ...obj, }); @@ -2744,6 +3032,9 @@ export interface ListStudioComponentsResponse { } export namespace ListStudioComponentsResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListStudioComponentsResponse): any => ({ ...obj, }); @@ -2767,6 +3058,9 @@ export interface ListStudioMembersRequest { } export namespace ListStudioMembersRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListStudioMembersRequest): any => ({ ...obj, }); @@ -2785,6 +3079,9 @@ export interface ListStudioMembersResponse { } export namespace ListStudioMembersResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListStudioMembersResponse): any => ({ ...obj, }); @@ -2798,6 +3095,9 @@ export interface ListStudiosRequest { } export namespace ListStudiosRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListStudiosRequest): any => ({ ...obj, }); @@ -2816,6 +3116,9 @@ export interface ListStudiosResponse { } export namespace ListStudiosResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListStudiosResponse): any => ({ ...obj, }); @@ -2829,6 +3132,9 @@ export interface ListTagsForResourceRequest { } export namespace ListTagsForResourceRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListTagsForResourceRequest): any => ({ ...obj, }); @@ -2842,6 +3148,9 @@ export interface ListTagsForResourceResponse { } export namespace ListTagsForResourceResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListTagsForResourceResponse): any => ({ ...obj, }); @@ -2860,6 +3169,9 @@ export interface NewLaunchProfileMember { } export namespace NewLaunchProfileMember { + /** + * @internal + */ export const filterSensitiveLog = (obj: NewLaunchProfileMember): any => ({ ...obj, }); @@ -2878,6 +3190,9 @@ export interface NewStudioMember { } export namespace NewStudioMember { + /** + * @internal + */ export const filterSensitiveLog = (obj: NewStudioMember): any => ({ ...obj, }); @@ -2914,6 +3229,9 @@ export interface PutLaunchProfileMembersRequest { } export namespace PutLaunchProfileMembersRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: PutLaunchProfileMembersRequest): any => ({ ...obj, }); @@ -2922,6 +3240,9 @@ export namespace PutLaunchProfileMembersRequest { export interface PutLaunchProfileMembersResponse {} export namespace PutLaunchProfileMembersResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: PutLaunchProfileMembersResponse): any => ({ ...obj, }); @@ -2953,6 +3274,9 @@ export interface PutStudioMembersRequest { } export namespace PutStudioMembersRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: PutStudioMembersRequest): any => ({ ...obj, }); @@ -2961,6 +3285,9 @@ export namespace PutStudioMembersRequest { export interface PutStudioMembersResponse {} export namespace PutStudioMembersResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: PutStudioMembersResponse): any => ({ ...obj, }); @@ -2979,6 +3306,9 @@ export interface StartStudioSSOConfigurationRepairRequest { } export namespace StartStudioSSOConfigurationRepairRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: StartStudioSSOConfigurationRepairRequest): any => ({ ...obj, }); @@ -2992,6 +3322,9 @@ export interface StartStudioSSOConfigurationRepairResponse { } export namespace StartStudioSSOConfigurationRepairResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: StartStudioSSOConfigurationRepairResponse): any => ({ ...obj, }); @@ -3013,6 +3346,9 @@ export interface TagResourceRequest { } export namespace TagResourceRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: TagResourceRequest): any => ({ ...obj, }); @@ -3021,6 +3357,9 @@ export namespace TagResourceRequest { export interface TagResourceResponse {} export namespace TagResourceResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: TagResourceResponse): any => ({ ...obj, }); @@ -3039,6 +3378,9 @@ export interface UntagResourceRequest { } export namespace UntagResourceRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: UntagResourceRequest): any => ({ ...obj, }); @@ -3047,6 +3389,9 @@ export namespace UntagResourceRequest { export interface UntagResourceResponse {} export namespace UntagResourceResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: UntagResourceResponse): any => ({ ...obj, }); @@ -3098,6 +3443,9 @@ export interface UpdateLaunchProfileRequest { } export namespace UpdateLaunchProfileRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateLaunchProfileRequest): any => ({ ...obj, }); @@ -3111,6 +3459,9 @@ export interface UpdateLaunchProfileResponse { } export namespace UpdateLaunchProfileResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateLaunchProfileResponse): any => ({ ...obj, }); @@ -3147,6 +3498,9 @@ export interface UpdateLaunchProfileMemberRequest { } export namespace UpdateLaunchProfileMemberRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateLaunchProfileMemberRequest): any => ({ ...obj, }); @@ -3160,6 +3514,9 @@ export interface UpdateLaunchProfileMemberResponse { } export namespace UpdateLaunchProfileMemberResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateLaunchProfileMemberResponse): any => ({ ...obj, }); @@ -3196,6 +3553,9 @@ export interface UpdateStreamingImageRequest { } export namespace UpdateStreamingImageRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateStreamingImageRequest): any => ({ ...obj, }); @@ -3209,6 +3569,9 @@ export interface UpdateStreamingImageResponse { } export namespace UpdateStreamingImageResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateStreamingImageResponse): any => ({ ...obj, }); @@ -3245,6 +3608,9 @@ export interface UpdateStudioRequest { } export namespace UpdateStudioRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateStudioRequest): any => ({ ...obj, }); @@ -3258,6 +3624,9 @@ export interface UpdateStudioResponse { } export namespace UpdateStudioResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateStudioResponse): any => ({ ...obj, }); @@ -3324,6 +3693,9 @@ export interface UpdateStudioComponentRequest { } export namespace UpdateStudioComponentRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateStudioComponentRequest): any => ({ ...obj, }); @@ -3337,6 +3709,9 @@ export interface UpdateStudioComponentResponse { } export namespace UpdateStudioComponentResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateStudioComponentResponse): any => ({ ...obj, }); diff --git a/clients/client-opsworks/commands/AssignInstanceCommand.ts b/clients/client-opsworks/commands/AssignInstanceCommand.ts index 763d808da5db..a8739a324163 100644 --- a/clients/client-opsworks/commands/AssignInstanceCommand.ts +++ b/clients/client-opsworks/commands/AssignInstanceCommand.ts @@ -39,6 +39,20 @@ export interface AssignInstanceCommandOutput extends __MetadataBearer {} * level for the stack or an attached policy that explicitly grants permissions. For more * information on user permissions, see Managing User * Permissions.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { OpsWorksClient, AssignInstanceCommand } from "@aws-sdk/client-opsworks"; // ES Modules import + * // const { OpsWorksClient, AssignInstanceCommand } = require("@aws-sdk/client-opsworks"); // CommonJS import + * const client = new OpsWorksClient(config); + * const command = new AssignInstanceCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link AssignInstanceCommandInput} for command's `input` shape. + * @see {@link AssignInstanceCommandOutput} for command's `response` shape. + * @see {@link OpsWorksClientResolvedConfig | config} for command's `input` shape. + * */ export class AssignInstanceCommand extends $Command< AssignInstanceCommandInput, diff --git a/clients/client-opsworks/commands/AssignVolumeCommand.ts b/clients/client-opsworks/commands/AssignVolumeCommand.ts index 2e5639baa4de..a542ce1f3318 100644 --- a/clients/client-opsworks/commands/AssignVolumeCommand.ts +++ b/clients/client-opsworks/commands/AssignVolumeCommand.ts @@ -30,6 +30,20 @@ export interface AssignVolumeCommandOutput extends __MetadataBearer {} * level for the stack, or an attached policy that explicitly grants permissions. For more * information on user permissions, see Managing User * Permissions.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { OpsWorksClient, AssignVolumeCommand } from "@aws-sdk/client-opsworks"; // ES Modules import + * // const { OpsWorksClient, AssignVolumeCommand } = require("@aws-sdk/client-opsworks"); // CommonJS import + * const client = new OpsWorksClient(config); + * const command = new AssignVolumeCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link AssignVolumeCommandInput} for command's `input` shape. + * @see {@link AssignVolumeCommandOutput} for command's `response` shape. + * @see {@link OpsWorksClientResolvedConfig | config} for command's `input` shape. + * */ export class AssignVolumeCommand extends $Command< AssignVolumeCommandInput, diff --git a/clients/client-opsworks/commands/AssociateElasticIpCommand.ts b/clients/client-opsworks/commands/AssociateElasticIpCommand.ts index 64a169cc7186..3703e359a949 100644 --- a/clients/client-opsworks/commands/AssociateElasticIpCommand.ts +++ b/clients/client-opsworks/commands/AssociateElasticIpCommand.ts @@ -30,6 +30,20 @@ export interface AssociateElasticIpCommandOutput extends __MetadataBearer {} * level for the stack, or an attached policy that explicitly grants permissions. For more * information on user permissions, see Managing User * Permissions.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { OpsWorksClient, AssociateElasticIpCommand } from "@aws-sdk/client-opsworks"; // ES Modules import + * // const { OpsWorksClient, AssociateElasticIpCommand } = require("@aws-sdk/client-opsworks"); // CommonJS import + * const client = new OpsWorksClient(config); + * const command = new AssociateElasticIpCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link AssociateElasticIpCommandInput} for command's `input` shape. + * @see {@link AssociateElasticIpCommandOutput} for command's `response` shape. + * @see {@link OpsWorksClientResolvedConfig | config} for command's `input` shape. + * */ export class AssociateElasticIpCommand extends $Command< AssociateElasticIpCommandInput, diff --git a/clients/client-opsworks/commands/AttachElasticLoadBalancerCommand.ts b/clients/client-opsworks/commands/AttachElasticLoadBalancerCommand.ts index 0d945497dacf..ecb7b2c64621 100644 --- a/clients/client-opsworks/commands/AttachElasticLoadBalancerCommand.ts +++ b/clients/client-opsworks/commands/AttachElasticLoadBalancerCommand.ts @@ -35,6 +35,20 @@ export interface AttachElasticLoadBalancerCommandOutput extends __MetadataBearer * level for the stack, or an attached policy that explicitly grants permissions. For more * information on user permissions, see Managing User * Permissions.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { OpsWorksClient, AttachElasticLoadBalancerCommand } from "@aws-sdk/client-opsworks"; // ES Modules import + * // const { OpsWorksClient, AttachElasticLoadBalancerCommand } = require("@aws-sdk/client-opsworks"); // CommonJS import + * const client = new OpsWorksClient(config); + * const command = new AttachElasticLoadBalancerCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link AttachElasticLoadBalancerCommandInput} for command's `input` shape. + * @see {@link AttachElasticLoadBalancerCommandOutput} for command's `response` shape. + * @see {@link OpsWorksClientResolvedConfig | config} for command's `input` shape. + * */ export class AttachElasticLoadBalancerCommand extends $Command< AttachElasticLoadBalancerCommandInput, diff --git a/clients/client-opsworks/commands/CloneStackCommand.ts b/clients/client-opsworks/commands/CloneStackCommand.ts index bd2dc42db83c..16e3248313dd 100644 --- a/clients/client-opsworks/commands/CloneStackCommand.ts +++ b/clients/client-opsworks/commands/CloneStackCommand.ts @@ -27,6 +27,20 @@ export interface CloneStackCommandOutput extends CloneStackResult, __MetadataBea * 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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { OpsWorksClient, CloneStackCommand } from "@aws-sdk/client-opsworks"; // ES Modules import + * // const { OpsWorksClient, CloneStackCommand } = require("@aws-sdk/client-opsworks"); // CommonJS import + * const client = new OpsWorksClient(config); + * const command = new CloneStackCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CloneStackCommandInput} for command's `input` shape. + * @see {@link CloneStackCommandOutput} for command's `response` shape. + * @see {@link OpsWorksClientResolvedConfig | config} for command's `input` shape. + * */ export class CloneStackCommand extends $Command< CloneStackCommandInput, diff --git a/clients/client-opsworks/commands/CreateAppCommand.ts b/clients/client-opsworks/commands/CreateAppCommand.ts index 595d245cdb1d..51f037f87c7b 100644 --- a/clients/client-opsworks/commands/CreateAppCommand.ts +++ b/clients/client-opsworks/commands/CreateAppCommand.ts @@ -25,6 +25,20 @@ export interface CreateAppCommandOutput extends CreateAppResult, __MetadataBeare * level for the stack, or an attached policy that explicitly grants permissions. For more * information on user permissions, see Managing User * Permissions.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { OpsWorksClient, CreateAppCommand } from "@aws-sdk/client-opsworks"; // ES Modules import + * // const { OpsWorksClient, CreateAppCommand } = require("@aws-sdk/client-opsworks"); // CommonJS import + * const client = new OpsWorksClient(config); + * const command = new CreateAppCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreateAppCommandInput} for command's `input` shape. + * @see {@link CreateAppCommandOutput} for command's `response` shape. + * @see {@link OpsWorksClientResolvedConfig | config} for command's `input` shape. + * */ export class CreateAppCommand extends $Command< CreateAppCommandInput, diff --git a/clients/client-opsworks/commands/CreateDeploymentCommand.ts b/clients/client-opsworks/commands/CreateDeploymentCommand.ts index 4ae0e8c92a83..24494d347c52 100644 --- a/clients/client-opsworks/commands/CreateDeploymentCommand.ts +++ b/clients/client-opsworks/commands/CreateDeploymentCommand.ts @@ -28,6 +28,20 @@ export interface CreateDeploymentCommandOutput extends CreateDeploymentResult, _ * permissions level for the stack, or an attached policy that explicitly grants permissions. For * more information on user permissions, see Managing User * Permissions.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { OpsWorksClient, CreateDeploymentCommand } from "@aws-sdk/client-opsworks"; // ES Modules import + * // const { OpsWorksClient, CreateDeploymentCommand } = require("@aws-sdk/client-opsworks"); // CommonJS import + * const client = new OpsWorksClient(config); + * const command = new CreateDeploymentCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreateDeploymentCommandInput} for command's `input` shape. + * @see {@link CreateDeploymentCommandOutput} for command's `response` shape. + * @see {@link OpsWorksClientResolvedConfig | config} for command's `input` shape. + * */ export class CreateDeploymentCommand extends $Command< CreateDeploymentCommandInput, diff --git a/clients/client-opsworks/commands/CreateInstanceCommand.ts b/clients/client-opsworks/commands/CreateInstanceCommand.ts index b9e44e47537a..8c21db78b405 100644 --- a/clients/client-opsworks/commands/CreateInstanceCommand.ts +++ b/clients/client-opsworks/commands/CreateInstanceCommand.ts @@ -28,6 +28,20 @@ export interface CreateInstanceCommandOutput extends CreateInstanceResult, __Met * level for the stack, or an attached policy that explicitly grants permissions. For more * information on user permissions, see Managing User * Permissions.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { OpsWorksClient, CreateInstanceCommand } from "@aws-sdk/client-opsworks"; // ES Modules import + * // const { OpsWorksClient, CreateInstanceCommand } = require("@aws-sdk/client-opsworks"); // CommonJS import + * const client = new OpsWorksClient(config); + * const command = new CreateInstanceCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreateInstanceCommandInput} for command's `input` shape. + * @see {@link CreateInstanceCommandOutput} for command's `response` shape. + * @see {@link OpsWorksClientResolvedConfig | config} for command's `input` shape. + * */ export class CreateInstanceCommand extends $Command< CreateInstanceCommandInput, diff --git a/clients/client-opsworks/commands/CreateLayerCommand.ts b/clients/client-opsworks/commands/CreateLayerCommand.ts index f62c598301e1..57d4e424ea5c 100644 --- a/clients/client-opsworks/commands/CreateLayerCommand.ts +++ b/clients/client-opsworks/commands/CreateLayerCommand.ts @@ -35,6 +35,20 @@ export interface CreateLayerCommandOutput extends CreateLayerResult, __MetadataB * level for the stack, or an attached policy that explicitly grants permissions. For more * information on user permissions, see Managing User * Permissions.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { OpsWorksClient, CreateLayerCommand } from "@aws-sdk/client-opsworks"; // ES Modules import + * // const { OpsWorksClient, CreateLayerCommand } = require("@aws-sdk/client-opsworks"); // CommonJS import + * const client = new OpsWorksClient(config); + * const command = new CreateLayerCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreateLayerCommandInput} for command's `input` shape. + * @see {@link CreateLayerCommandOutput} for command's `response` shape. + * @see {@link OpsWorksClientResolvedConfig | config} for command's `input` shape. + * */ export class CreateLayerCommand extends $Command< CreateLayerCommandInput, diff --git a/clients/client-opsworks/commands/CreateStackCommand.ts b/clients/client-opsworks/commands/CreateStackCommand.ts index 932aed38f2f8..fb40a06af958 100644 --- a/clients/client-opsworks/commands/CreateStackCommand.ts +++ b/clients/client-opsworks/commands/CreateStackCommand.ts @@ -27,6 +27,20 @@ export interface CreateStackCommandOutput extends CreateStackResult, __MetadataB * 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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { OpsWorksClient, CreateStackCommand } from "@aws-sdk/client-opsworks"; // ES Modules import + * // const { OpsWorksClient, CreateStackCommand } = require("@aws-sdk/client-opsworks"); // CommonJS import + * const client = new OpsWorksClient(config); + * const command = new CreateStackCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreateStackCommandInput} for command's `input` shape. + * @see {@link CreateStackCommandOutput} for command's `response` shape. + * @see {@link OpsWorksClientResolvedConfig | config} for command's `input` shape. + * */ export class CreateStackCommand extends $Command< CreateStackCommandInput, diff --git a/clients/client-opsworks/commands/CreateUserProfileCommand.ts b/clients/client-opsworks/commands/CreateUserProfileCommand.ts index e5963b2838b4..3b5fb45a0dcd 100644 --- a/clients/client-opsworks/commands/CreateUserProfileCommand.ts +++ b/clients/client-opsworks/commands/CreateUserProfileCommand.ts @@ -26,6 +26,20 @@ export interface CreateUserProfileCommandOutput extends CreateUserProfileResult, * 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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { OpsWorksClient, CreateUserProfileCommand } from "@aws-sdk/client-opsworks"; // ES Modules import + * // const { OpsWorksClient, CreateUserProfileCommand } = require("@aws-sdk/client-opsworks"); // CommonJS import + * const client = new OpsWorksClient(config); + * const command = new CreateUserProfileCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreateUserProfileCommandInput} for command's `input` shape. + * @see {@link CreateUserProfileCommandOutput} for command's `response` shape. + * @see {@link OpsWorksClientResolvedConfig | config} for command's `input` shape. + * */ export class CreateUserProfileCommand extends $Command< CreateUserProfileCommandInput, diff --git a/clients/client-opsworks/commands/DeleteAppCommand.ts b/clients/client-opsworks/commands/DeleteAppCommand.ts index fb81b169994d..c33db084c37f 100644 --- a/clients/client-opsworks/commands/DeleteAppCommand.ts +++ b/clients/client-opsworks/commands/DeleteAppCommand.ts @@ -24,6 +24,20 @@ export interface DeleteAppCommandOutput extends __MetadataBearer {} * level for the stack, or an attached policy that explicitly grants permissions. For more * information on user permissions, see Managing User * Permissions.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { OpsWorksClient, DeleteAppCommand } from "@aws-sdk/client-opsworks"; // ES Modules import + * // const { OpsWorksClient, DeleteAppCommand } = require("@aws-sdk/client-opsworks"); // CommonJS import + * const client = new OpsWorksClient(config); + * const command = new DeleteAppCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteAppCommandInput} for command's `input` shape. + * @see {@link DeleteAppCommandOutput} for command's `response` shape. + * @see {@link OpsWorksClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteAppCommand extends $Command< DeleteAppCommandInput, diff --git a/clients/client-opsworks/commands/DeleteInstanceCommand.ts b/clients/client-opsworks/commands/DeleteInstanceCommand.ts index ba478f6a174f..450b886d73d5 100644 --- a/clients/client-opsworks/commands/DeleteInstanceCommand.ts +++ b/clients/client-opsworks/commands/DeleteInstanceCommand.ts @@ -29,6 +29,20 @@ export interface DeleteInstanceCommandOutput extends __MetadataBearer {} * level for the stack, or an attached policy that explicitly grants permissions. For more * information on user permissions, see Managing User * Permissions.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { OpsWorksClient, DeleteInstanceCommand } from "@aws-sdk/client-opsworks"; // ES Modules import + * // const { OpsWorksClient, DeleteInstanceCommand } = require("@aws-sdk/client-opsworks"); // CommonJS import + * const client = new OpsWorksClient(config); + * const command = new DeleteInstanceCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteInstanceCommandInput} for command's `input` shape. + * @see {@link DeleteInstanceCommandOutput} for command's `response` shape. + * @see {@link OpsWorksClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteInstanceCommand extends $Command< DeleteInstanceCommandInput, diff --git a/clients/client-opsworks/commands/DeleteLayerCommand.ts b/clients/client-opsworks/commands/DeleteLayerCommand.ts index a4f0a22706cc..e726adce3124 100644 --- a/clients/client-opsworks/commands/DeleteLayerCommand.ts +++ b/clients/client-opsworks/commands/DeleteLayerCommand.ts @@ -29,6 +29,20 @@ export interface DeleteLayerCommandOutput extends __MetadataBearer {} * level for the stack, or an attached policy that explicitly grants permissions. For more * information on user permissions, see Managing User * Permissions.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { OpsWorksClient, DeleteLayerCommand } from "@aws-sdk/client-opsworks"; // ES Modules import + * // const { OpsWorksClient, DeleteLayerCommand } = require("@aws-sdk/client-opsworks"); // CommonJS import + * const client = new OpsWorksClient(config); + * const command = new DeleteLayerCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteLayerCommandInput} for command's `input` shape. + * @see {@link DeleteLayerCommandOutput} for command's `response` shape. + * @see {@link OpsWorksClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteLayerCommand extends $Command< DeleteLayerCommandInput, diff --git a/clients/client-opsworks/commands/DeleteStackCommand.ts b/clients/client-opsworks/commands/DeleteStackCommand.ts index 072d4d7bcc8b..76205f24440b 100644 --- a/clients/client-opsworks/commands/DeleteStackCommand.ts +++ b/clients/client-opsworks/commands/DeleteStackCommand.ts @@ -29,6 +29,20 @@ export interface DeleteStackCommandOutput extends __MetadataBearer {} * level for the stack, or an attached policy that explicitly grants permissions. For more * information on user permissions, see Managing User * Permissions.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { OpsWorksClient, DeleteStackCommand } from "@aws-sdk/client-opsworks"; // ES Modules import + * // const { OpsWorksClient, DeleteStackCommand } = require("@aws-sdk/client-opsworks"); // CommonJS import + * const client = new OpsWorksClient(config); + * const command = new DeleteStackCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteStackCommandInput} for command's `input` shape. + * @see {@link DeleteStackCommandOutput} for command's `response` shape. + * @see {@link OpsWorksClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteStackCommand extends $Command< DeleteStackCommandInput, diff --git a/clients/client-opsworks/commands/DeleteUserProfileCommand.ts b/clients/client-opsworks/commands/DeleteUserProfileCommand.ts index 7982f234e11a..0606c7fdc6d2 100644 --- a/clients/client-opsworks/commands/DeleteUserProfileCommand.ts +++ b/clients/client-opsworks/commands/DeleteUserProfileCommand.ts @@ -26,6 +26,20 @@ export interface DeleteUserProfileCommandOutput extends __MetadataBearer {} * 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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { OpsWorksClient, DeleteUserProfileCommand } from "@aws-sdk/client-opsworks"; // ES Modules import + * // const { OpsWorksClient, DeleteUserProfileCommand } = require("@aws-sdk/client-opsworks"); // CommonJS import + * const client = new OpsWorksClient(config); + * const command = new DeleteUserProfileCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteUserProfileCommandInput} for command's `input` shape. + * @see {@link DeleteUserProfileCommandOutput} for command's `response` shape. + * @see {@link OpsWorksClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteUserProfileCommand extends $Command< DeleteUserProfileCommandInput, diff --git a/clients/client-opsworks/commands/DeregisterEcsClusterCommand.ts b/clients/client-opsworks/commands/DeregisterEcsClusterCommand.ts index 7ec82ffd5ade..27bdeaab382d 100644 --- a/clients/client-opsworks/commands/DeregisterEcsClusterCommand.ts +++ b/clients/client-opsworks/commands/DeregisterEcsClusterCommand.ts @@ -30,6 +30,20 @@ export interface DeregisterEcsClusterCommandOutput extends __MetadataBearer {} * 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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { OpsWorksClient, DeregisterEcsClusterCommand } from "@aws-sdk/client-opsworks"; // ES Modules import + * // const { OpsWorksClient, DeregisterEcsClusterCommand } = require("@aws-sdk/client-opsworks"); // CommonJS import + * const client = new OpsWorksClient(config); + * const command = new DeregisterEcsClusterCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeregisterEcsClusterCommandInput} for command's `input` shape. + * @see {@link DeregisterEcsClusterCommandOutput} for command's `response` shape. + * @see {@link OpsWorksClientResolvedConfig | config} for command's `input` shape. + * */ export class DeregisterEcsClusterCommand extends $Command< DeregisterEcsClusterCommandInput, diff --git a/clients/client-opsworks/commands/DeregisterElasticIpCommand.ts b/clients/client-opsworks/commands/DeregisterElasticIpCommand.ts index e4c0b596fee0..bf8d1b9cc85c 100644 --- a/clients/client-opsworks/commands/DeregisterElasticIpCommand.ts +++ b/clients/client-opsworks/commands/DeregisterElasticIpCommand.ts @@ -28,6 +28,20 @@ export interface DeregisterElasticIpCommandOutput extends __MetadataBearer {} * level for the stack, or an attached policy that explicitly grants permissions. For more * information on user permissions, see Managing User * Permissions.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { OpsWorksClient, DeregisterElasticIpCommand } from "@aws-sdk/client-opsworks"; // ES Modules import + * // const { OpsWorksClient, DeregisterElasticIpCommand } = require("@aws-sdk/client-opsworks"); // CommonJS import + * const client = new OpsWorksClient(config); + * const command = new DeregisterElasticIpCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeregisterElasticIpCommandInput} for command's `input` shape. + * @see {@link DeregisterElasticIpCommandOutput} for command's `response` shape. + * @see {@link OpsWorksClientResolvedConfig | config} for command's `input` shape. + * */ export class DeregisterElasticIpCommand extends $Command< DeregisterElasticIpCommandInput, diff --git a/clients/client-opsworks/commands/DeregisterInstanceCommand.ts b/clients/client-opsworks/commands/DeregisterInstanceCommand.ts index 58b2feb7b9c3..f683bbca0a78 100644 --- a/clients/client-opsworks/commands/DeregisterInstanceCommand.ts +++ b/clients/client-opsworks/commands/DeregisterInstanceCommand.ts @@ -29,6 +29,20 @@ export interface DeregisterInstanceCommandOutput extends __MetadataBearer {} * level for the stack or an attached policy that explicitly grants permissions. For more * information on user permissions, see Managing User * Permissions.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { OpsWorksClient, DeregisterInstanceCommand } from "@aws-sdk/client-opsworks"; // ES Modules import + * // const { OpsWorksClient, DeregisterInstanceCommand } = require("@aws-sdk/client-opsworks"); // CommonJS import + * const client = new OpsWorksClient(config); + * const command = new DeregisterInstanceCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeregisterInstanceCommandInput} for command's `input` shape. + * @see {@link DeregisterInstanceCommandOutput} for command's `response` shape. + * @see {@link OpsWorksClientResolvedConfig | config} for command's `input` shape. + * */ export class DeregisterInstanceCommand extends $Command< DeregisterInstanceCommandInput, diff --git a/clients/client-opsworks/commands/DeregisterRdsDbInstanceCommand.ts b/clients/client-opsworks/commands/DeregisterRdsDbInstanceCommand.ts index 6d4d00142a4f..b988711cd49d 100644 --- a/clients/client-opsworks/commands/DeregisterRdsDbInstanceCommand.ts +++ b/clients/client-opsworks/commands/DeregisterRdsDbInstanceCommand.ts @@ -27,6 +27,20 @@ export interface DeregisterRdsDbInstanceCommandOutput extends __MetadataBearer { * level for the stack, or an attached policy that explicitly grants permissions. For more * information on user permissions, see Managing User * Permissions.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { OpsWorksClient, DeregisterRdsDbInstanceCommand } from "@aws-sdk/client-opsworks"; // ES Modules import + * // const { OpsWorksClient, DeregisterRdsDbInstanceCommand } = require("@aws-sdk/client-opsworks"); // CommonJS import + * const client = new OpsWorksClient(config); + * const command = new DeregisterRdsDbInstanceCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeregisterRdsDbInstanceCommandInput} for command's `input` shape. + * @see {@link DeregisterRdsDbInstanceCommandOutput} for command's `response` shape. + * @see {@link OpsWorksClientResolvedConfig | config} for command's `input` shape. + * */ export class DeregisterRdsDbInstanceCommand extends $Command< DeregisterRdsDbInstanceCommandInput, diff --git a/clients/client-opsworks/commands/DeregisterVolumeCommand.ts b/clients/client-opsworks/commands/DeregisterVolumeCommand.ts index 93469acb005e..97843474ca30 100644 --- a/clients/client-opsworks/commands/DeregisterVolumeCommand.ts +++ b/clients/client-opsworks/commands/DeregisterVolumeCommand.ts @@ -29,6 +29,20 @@ export interface DeregisterVolumeCommandOutput extends __MetadataBearer {} * level for the stack, or an attached policy that explicitly grants permissions. For more * information on user permissions, see Managing User * Permissions.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { OpsWorksClient, DeregisterVolumeCommand } from "@aws-sdk/client-opsworks"; // ES Modules import + * // const { OpsWorksClient, DeregisterVolumeCommand } = require("@aws-sdk/client-opsworks"); // CommonJS import + * const client = new OpsWorksClient(config); + * const command = new DeregisterVolumeCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeregisterVolumeCommandInput} for command's `input` shape. + * @see {@link DeregisterVolumeCommandOutput} for command's `response` shape. + * @see {@link OpsWorksClientResolvedConfig | config} for command's `input` shape. + * */ export class DeregisterVolumeCommand extends $Command< DeregisterVolumeCommandInput, diff --git a/clients/client-opsworks/commands/DescribeAgentVersionsCommand.ts b/clients/client-opsworks/commands/DescribeAgentVersionsCommand.ts index 56f077fcc400..332886cb209c 100644 --- a/clients/client-opsworks/commands/DescribeAgentVersionsCommand.ts +++ b/clients/client-opsworks/commands/DescribeAgentVersionsCommand.ts @@ -24,6 +24,20 @@ export interface DescribeAgentVersionsCommandOutput extends DescribeAgentVersion *

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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { OpsWorksClient, DescribeAgentVersionsCommand } from "@aws-sdk/client-opsworks"; // ES Modules import + * // const { OpsWorksClient, DescribeAgentVersionsCommand } = require("@aws-sdk/client-opsworks"); // CommonJS import + * const client = new OpsWorksClient(config); + * const command = new DescribeAgentVersionsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeAgentVersionsCommandInput} for command's `input` shape. + * @see {@link DescribeAgentVersionsCommandOutput} for command's `response` shape. + * @see {@link OpsWorksClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeAgentVersionsCommand extends $Command< DescribeAgentVersionsCommandInput, diff --git a/clients/client-opsworks/commands/DescribeAppsCommand.ts b/clients/client-opsworks/commands/DescribeAppsCommand.ts index c59fac1b18fe..7344e8245f64 100644 --- a/clients/client-opsworks/commands/DescribeAppsCommand.ts +++ b/clients/client-opsworks/commands/DescribeAppsCommand.ts @@ -30,6 +30,20 @@ export interface DescribeAppsCommandOutput extends DescribeAppsResult, __Metadat * Manage permissions level for the stack, or an attached policy that explicitly grants * permissions. For more information about user permissions, see Managing User * Permissions.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { OpsWorksClient, DescribeAppsCommand } from "@aws-sdk/client-opsworks"; // ES Modules import + * // const { OpsWorksClient, DescribeAppsCommand } = require("@aws-sdk/client-opsworks"); // CommonJS import + * const client = new OpsWorksClient(config); + * const command = new DescribeAppsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeAppsCommandInput} for command's `input` shape. + * @see {@link DescribeAppsCommandOutput} for command's `response` shape. + * @see {@link OpsWorksClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeAppsCommand extends $Command< DescribeAppsCommandInput, diff --git a/clients/client-opsworks/commands/DescribeCommandsCommand.ts b/clients/client-opsworks/commands/DescribeCommandsCommand.ts index 7ea485cd82f9..0bd69475af42 100644 --- a/clients/client-opsworks/commands/DescribeCommandsCommand.ts +++ b/clients/client-opsworks/commands/DescribeCommandsCommand.ts @@ -30,6 +30,20 @@ export interface DescribeCommandsCommandOutput extends DescribeCommandsResult, _ * Manage permissions level for the stack, or an attached policy that explicitly grants * permissions. For more information about user permissions, see Managing User * Permissions.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { OpsWorksClient, DescribeCommandsCommand } from "@aws-sdk/client-opsworks"; // ES Modules import + * // const { OpsWorksClient, DescribeCommandsCommand } = require("@aws-sdk/client-opsworks"); // CommonJS import + * const client = new OpsWorksClient(config); + * const command = new DescribeCommandsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeCommandsCommandInput} for command's `input` shape. + * @see {@link DescribeCommandsCommandOutput} for command's `response` shape. + * @see {@link OpsWorksClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeCommandsCommand extends $Command< DescribeCommandsCommandInput, diff --git a/clients/client-opsworks/commands/DescribeDeploymentsCommand.ts b/clients/client-opsworks/commands/DescribeDeploymentsCommand.ts index 43e79c55ac8c..95b80c9fd210 100644 --- a/clients/client-opsworks/commands/DescribeDeploymentsCommand.ts +++ b/clients/client-opsworks/commands/DescribeDeploymentsCommand.ts @@ -30,6 +30,20 @@ export interface DescribeDeploymentsCommandOutput extends DescribeDeploymentsRes * Manage permissions level for the stack, or an attached policy that explicitly grants * permissions. For more information about user permissions, see Managing User * Permissions.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { OpsWorksClient, DescribeDeploymentsCommand } from "@aws-sdk/client-opsworks"; // ES Modules import + * // const { OpsWorksClient, DescribeDeploymentsCommand } = require("@aws-sdk/client-opsworks"); // CommonJS import + * const client = new OpsWorksClient(config); + * const command = new DescribeDeploymentsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeDeploymentsCommandInput} for command's `input` shape. + * @see {@link DescribeDeploymentsCommandOutput} for command's `response` shape. + * @see {@link OpsWorksClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeDeploymentsCommand extends $Command< DescribeDeploymentsCommandInput, diff --git a/clients/client-opsworks/commands/DescribeEcsClustersCommand.ts b/clients/client-opsworks/commands/DescribeEcsClustersCommand.ts index 3eefd330031f..ffef26da129f 100644 --- a/clients/client-opsworks/commands/DescribeEcsClustersCommand.ts +++ b/clients/client-opsworks/commands/DescribeEcsClustersCommand.ts @@ -31,6 +31,20 @@ export interface DescribeEcsClustersCommandOutput extends DescribeEcsClustersRes * permission. For more information about user permissions, see Managing User * Permissions.

*

This call accepts only one resource-identifying parameter.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { OpsWorksClient, DescribeEcsClustersCommand } from "@aws-sdk/client-opsworks"; // ES Modules import + * // const { OpsWorksClient, DescribeEcsClustersCommand } = require("@aws-sdk/client-opsworks"); // CommonJS import + * const client = new OpsWorksClient(config); + * const command = new DescribeEcsClustersCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeEcsClustersCommandInput} for command's `input` shape. + * @see {@link DescribeEcsClustersCommandOutput} for command's `response` shape. + * @see {@link OpsWorksClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeEcsClustersCommand extends $Command< DescribeEcsClustersCommandInput, diff --git a/clients/client-opsworks/commands/DescribeElasticIpsCommand.ts b/clients/client-opsworks/commands/DescribeElasticIpsCommand.ts index 1870a0d9be19..6a9e647dc39e 100644 --- a/clients/client-opsworks/commands/DescribeElasticIpsCommand.ts +++ b/clients/client-opsworks/commands/DescribeElasticIpsCommand.ts @@ -30,6 +30,20 @@ export interface DescribeElasticIpsCommandOutput extends DescribeElasticIpsResul * Manage permissions level for the stack, or an attached policy that explicitly grants * permissions. For more information about user permissions, see Managing User * Permissions.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { OpsWorksClient, DescribeElasticIpsCommand } from "@aws-sdk/client-opsworks"; // ES Modules import + * // const { OpsWorksClient, DescribeElasticIpsCommand } = require("@aws-sdk/client-opsworks"); // CommonJS import + * const client = new OpsWorksClient(config); + * const command = new DescribeElasticIpsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeElasticIpsCommandInput} for command's `input` shape. + * @see {@link DescribeElasticIpsCommandOutput} for command's `response` shape. + * @see {@link OpsWorksClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeElasticIpsCommand extends $Command< DescribeElasticIpsCommandInput, diff --git a/clients/client-opsworks/commands/DescribeElasticLoadBalancersCommand.ts b/clients/client-opsworks/commands/DescribeElasticLoadBalancersCommand.ts index e715784add7f..48162e29a556 100644 --- a/clients/client-opsworks/commands/DescribeElasticLoadBalancersCommand.ts +++ b/clients/client-opsworks/commands/DescribeElasticLoadBalancersCommand.ts @@ -32,6 +32,20 @@ export interface DescribeElasticLoadBalancersCommandOutput * Manage permissions level for the stack, or an attached policy that explicitly grants * permissions. For more information about user permissions, see Managing User * Permissions.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { OpsWorksClient, DescribeElasticLoadBalancersCommand } from "@aws-sdk/client-opsworks"; // ES Modules import + * // const { OpsWorksClient, DescribeElasticLoadBalancersCommand } = require("@aws-sdk/client-opsworks"); // CommonJS import + * const client = new OpsWorksClient(config); + * const command = new DescribeElasticLoadBalancersCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeElasticLoadBalancersCommandInput} for command's `input` shape. + * @see {@link DescribeElasticLoadBalancersCommandOutput} for command's `response` shape. + * @see {@link OpsWorksClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeElasticLoadBalancersCommand extends $Command< DescribeElasticLoadBalancersCommandInput, diff --git a/clients/client-opsworks/commands/DescribeInstancesCommand.ts b/clients/client-opsworks/commands/DescribeInstancesCommand.ts index 522202beaf03..de90cefd4aa1 100644 --- a/clients/client-opsworks/commands/DescribeInstancesCommand.ts +++ b/clients/client-opsworks/commands/DescribeInstancesCommand.ts @@ -30,6 +30,20 @@ export interface DescribeInstancesCommandOutput extends DescribeInstancesResult, * Manage permissions level for the stack, or an attached policy that explicitly grants * permissions. For more information about user permissions, see Managing User * Permissions.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { OpsWorksClient, DescribeInstancesCommand } from "@aws-sdk/client-opsworks"; // ES Modules import + * // const { OpsWorksClient, DescribeInstancesCommand } = require("@aws-sdk/client-opsworks"); // CommonJS import + * const client = new OpsWorksClient(config); + * const command = new DescribeInstancesCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeInstancesCommandInput} for command's `input` shape. + * @see {@link DescribeInstancesCommandOutput} for command's `response` shape. + * @see {@link OpsWorksClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeInstancesCommand extends $Command< DescribeInstancesCommandInput, diff --git a/clients/client-opsworks/commands/DescribeLayersCommand.ts b/clients/client-opsworks/commands/DescribeLayersCommand.ts index 1c5ddb6bddc0..54226711bf06 100644 --- a/clients/client-opsworks/commands/DescribeLayersCommand.ts +++ b/clients/client-opsworks/commands/DescribeLayersCommand.ts @@ -30,6 +30,20 @@ export interface DescribeLayersCommandOutput extends DescribeLayersResult, __Met * Manage permissions level for the stack, or an attached policy that explicitly grants * permissions. For more information about user permissions, see Managing User * Permissions.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { OpsWorksClient, DescribeLayersCommand } from "@aws-sdk/client-opsworks"; // ES Modules import + * // const { OpsWorksClient, DescribeLayersCommand } = require("@aws-sdk/client-opsworks"); // CommonJS import + * const client = new OpsWorksClient(config); + * const command = new DescribeLayersCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeLayersCommandInput} for command's `input` shape. + * @see {@link DescribeLayersCommandOutput} for command's `response` shape. + * @see {@link OpsWorksClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeLayersCommand extends $Command< DescribeLayersCommandInput, diff --git a/clients/client-opsworks/commands/DescribeLoadBasedAutoScalingCommand.ts b/clients/client-opsworks/commands/DescribeLoadBasedAutoScalingCommand.ts index fb9d643264d8..73123c0dc1c2 100644 --- a/clients/client-opsworks/commands/DescribeLoadBasedAutoScalingCommand.ts +++ b/clients/client-opsworks/commands/DescribeLoadBasedAutoScalingCommand.ts @@ -32,6 +32,20 @@ export interface DescribeLoadBasedAutoScalingCommandOutput * Manage permissions level for the stack, or an attached policy that explicitly grants * permissions. For more information about user permissions, see Managing User * Permissions.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { OpsWorksClient, DescribeLoadBasedAutoScalingCommand } from "@aws-sdk/client-opsworks"; // ES Modules import + * // const { OpsWorksClient, DescribeLoadBasedAutoScalingCommand } = require("@aws-sdk/client-opsworks"); // CommonJS import + * const client = new OpsWorksClient(config); + * const command = new DescribeLoadBasedAutoScalingCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeLoadBasedAutoScalingCommandInput} for command's `input` shape. + * @see {@link DescribeLoadBasedAutoScalingCommandOutput} for command's `response` shape. + * @see {@link OpsWorksClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeLoadBasedAutoScalingCommand extends $Command< DescribeLoadBasedAutoScalingCommandInput, diff --git a/clients/client-opsworks/commands/DescribeMyUserProfileCommand.ts b/clients/client-opsworks/commands/DescribeMyUserProfileCommand.ts index abc8535b53f7..d451b598edb5 100644 --- a/clients/client-opsworks/commands/DescribeMyUserProfileCommand.ts +++ b/clients/client-opsworks/commands/DescribeMyUserProfileCommand.ts @@ -27,6 +27,20 @@ export interface DescribeMyUserProfileCommandOutput extends DescribeMyUserProfil * enabled or an attached policy that explicitly grants permissions. For more information about user * permissions, see Managing User * Permissions.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { OpsWorksClient, DescribeMyUserProfileCommand } from "@aws-sdk/client-opsworks"; // ES Modules import + * // const { OpsWorksClient, DescribeMyUserProfileCommand } = require("@aws-sdk/client-opsworks"); // CommonJS import + * const client = new OpsWorksClient(config); + * const command = new DescribeMyUserProfileCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeMyUserProfileCommandInput} for command's `input` shape. + * @see {@link DescribeMyUserProfileCommandOutput} for command's `response` shape. + * @see {@link OpsWorksClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeMyUserProfileCommand extends $Command< DescribeMyUserProfileCommandInput, diff --git a/clients/client-opsworks/commands/DescribeOperatingSystemsCommand.ts b/clients/client-opsworks/commands/DescribeOperatingSystemsCommand.ts index 52508710dab5..cbfff0911dba 100644 --- a/clients/client-opsworks/commands/DescribeOperatingSystemsCommand.ts +++ b/clients/client-opsworks/commands/DescribeOperatingSystemsCommand.ts @@ -22,6 +22,20 @@ export interface DescribeOperatingSystemsCommandOutput extends DescribeOperating /** *

Describes the operating systems that are supported by AWS OpsWorks Stacks.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { OpsWorksClient, DescribeOperatingSystemsCommand } from "@aws-sdk/client-opsworks"; // ES Modules import + * // const { OpsWorksClient, DescribeOperatingSystemsCommand } = require("@aws-sdk/client-opsworks"); // CommonJS import + * const client = new OpsWorksClient(config); + * const command = new DescribeOperatingSystemsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeOperatingSystemsCommandInput} for command's `input` shape. + * @see {@link DescribeOperatingSystemsCommandOutput} for command's `response` shape. + * @see {@link OpsWorksClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeOperatingSystemsCommand extends $Command< DescribeOperatingSystemsCommandInput, diff --git a/clients/client-opsworks/commands/DescribePermissionsCommand.ts b/clients/client-opsworks/commands/DescribePermissionsCommand.ts index 65526d48efa8..ceebede7bfee 100644 --- a/clients/client-opsworks/commands/DescribePermissionsCommand.ts +++ b/clients/client-opsworks/commands/DescribePermissionsCommand.ts @@ -27,6 +27,20 @@ export interface DescribePermissionsCommandOutput extends DescribePermissionsRes * level for the stack, or an attached policy that explicitly grants permissions. For more * information on user permissions, see Managing User * Permissions.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { OpsWorksClient, DescribePermissionsCommand } from "@aws-sdk/client-opsworks"; // ES Modules import + * // const { OpsWorksClient, DescribePermissionsCommand } = require("@aws-sdk/client-opsworks"); // CommonJS import + * const client = new OpsWorksClient(config); + * const command = new DescribePermissionsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribePermissionsCommandInput} for command's `input` shape. + * @see {@link DescribePermissionsCommandOutput} for command's `response` shape. + * @see {@link OpsWorksClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribePermissionsCommand extends $Command< DescribePermissionsCommandInput, diff --git a/clients/client-opsworks/commands/DescribeRaidArraysCommand.ts b/clients/client-opsworks/commands/DescribeRaidArraysCommand.ts index 579d77b62981..d7727f27cf74 100644 --- a/clients/client-opsworks/commands/DescribeRaidArraysCommand.ts +++ b/clients/client-opsworks/commands/DescribeRaidArraysCommand.ts @@ -30,6 +30,20 @@ export interface DescribeRaidArraysCommandOutput extends DescribeRaidArraysResul * Manage permissions level for the stack, or an attached policy that explicitly grants * permissions. For more information about user permissions, see Managing User * Permissions.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { OpsWorksClient, DescribeRaidArraysCommand } from "@aws-sdk/client-opsworks"; // ES Modules import + * // const { OpsWorksClient, DescribeRaidArraysCommand } = require("@aws-sdk/client-opsworks"); // CommonJS import + * const client = new OpsWorksClient(config); + * const command = new DescribeRaidArraysCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeRaidArraysCommandInput} for command's `input` shape. + * @see {@link DescribeRaidArraysCommandOutput} for command's `response` shape. + * @see {@link OpsWorksClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeRaidArraysCommand extends $Command< DescribeRaidArraysCommandInput, diff --git a/clients/client-opsworks/commands/DescribeRdsDbInstancesCommand.ts b/clients/client-opsworks/commands/DescribeRdsDbInstancesCommand.ts index 74f1a827b426..653d01425a3c 100644 --- a/clients/client-opsworks/commands/DescribeRdsDbInstancesCommand.ts +++ b/clients/client-opsworks/commands/DescribeRdsDbInstancesCommand.ts @@ -28,6 +28,20 @@ export interface DescribeRdsDbInstancesCommandOutput extends DescribeRdsDbInstan * permissions. For more information about user permissions, see Managing User * Permissions.

*

This call accepts only one resource-identifying parameter.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { OpsWorksClient, DescribeRdsDbInstancesCommand } from "@aws-sdk/client-opsworks"; // ES Modules import + * // const { OpsWorksClient, DescribeRdsDbInstancesCommand } = require("@aws-sdk/client-opsworks"); // CommonJS import + * const client = new OpsWorksClient(config); + * const command = new DescribeRdsDbInstancesCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeRdsDbInstancesCommandInput} for command's `input` shape. + * @see {@link DescribeRdsDbInstancesCommandOutput} for command's `response` shape. + * @see {@link OpsWorksClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeRdsDbInstancesCommand extends $Command< DescribeRdsDbInstancesCommandInput, diff --git a/clients/client-opsworks/commands/DescribeServiceErrorsCommand.ts b/clients/client-opsworks/commands/DescribeServiceErrorsCommand.ts index 94f40409d187..18406b263891 100644 --- a/clients/client-opsworks/commands/DescribeServiceErrorsCommand.ts +++ b/clients/client-opsworks/commands/DescribeServiceErrorsCommand.ts @@ -28,6 +28,20 @@ export interface DescribeServiceErrorsCommandOutput extends DescribeServiceError * permissions. For more information about user permissions, see Managing User * Permissions.

*

This call accepts only one resource-identifying parameter.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { OpsWorksClient, DescribeServiceErrorsCommand } from "@aws-sdk/client-opsworks"; // ES Modules import + * // const { OpsWorksClient, DescribeServiceErrorsCommand } = require("@aws-sdk/client-opsworks"); // CommonJS import + * const client = new OpsWorksClient(config); + * const command = new DescribeServiceErrorsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeServiceErrorsCommandInput} for command's `input` shape. + * @see {@link DescribeServiceErrorsCommandOutput} for command's `response` shape. + * @see {@link OpsWorksClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeServiceErrorsCommand extends $Command< DescribeServiceErrorsCommandInput, diff --git a/clients/client-opsworks/commands/DescribeStackProvisioningParametersCommand.ts b/clients/client-opsworks/commands/DescribeStackProvisioningParametersCommand.ts index ad1dff26eca0..fefef78dd5ad 100644 --- a/clients/client-opsworks/commands/DescribeStackProvisioningParametersCommand.ts +++ b/clients/client-opsworks/commands/DescribeStackProvisioningParametersCommand.ts @@ -32,6 +32,20 @@ export interface DescribeStackProvisioningParametersCommandOutput * Manage permissions level for the stack or an attached policy that explicitly grants * permissions. For more information about user permissions, see Managing User * Permissions.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { OpsWorksClient, DescribeStackProvisioningParametersCommand } from "@aws-sdk/client-opsworks"; // ES Modules import + * // const { OpsWorksClient, DescribeStackProvisioningParametersCommand } = require("@aws-sdk/client-opsworks"); // CommonJS import + * const client = new OpsWorksClient(config); + * const command = new DescribeStackProvisioningParametersCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeStackProvisioningParametersCommandInput} for command's `input` shape. + * @see {@link DescribeStackProvisioningParametersCommandOutput} for command's `response` shape. + * @see {@link OpsWorksClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeStackProvisioningParametersCommand extends $Command< DescribeStackProvisioningParametersCommandInput, diff --git a/clients/client-opsworks/commands/DescribeStackSummaryCommand.ts b/clients/client-opsworks/commands/DescribeStackSummaryCommand.ts index ec10e092ed92..6f707a2d0c4d 100644 --- a/clients/client-opsworks/commands/DescribeStackSummaryCommand.ts +++ b/clients/client-opsworks/commands/DescribeStackSummaryCommand.ts @@ -28,6 +28,20 @@ export interface DescribeStackSummaryCommandOutput extends DescribeStackSummaryR * Manage permissions level for the stack, or an attached policy that explicitly grants * permissions. For more information about user permissions, see Managing User * Permissions.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { OpsWorksClient, DescribeStackSummaryCommand } from "@aws-sdk/client-opsworks"; // ES Modules import + * // const { OpsWorksClient, DescribeStackSummaryCommand } = require("@aws-sdk/client-opsworks"); // CommonJS import + * const client = new OpsWorksClient(config); + * const command = new DescribeStackSummaryCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeStackSummaryCommandInput} for command's `input` shape. + * @see {@link DescribeStackSummaryCommandOutput} for command's `response` shape. + * @see {@link OpsWorksClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeStackSummaryCommand extends $Command< DescribeStackSummaryCommandInput, diff --git a/clients/client-opsworks/commands/DescribeStacksCommand.ts b/clients/client-opsworks/commands/DescribeStacksCommand.ts index c05ddf03e6c6..8ca79e26f4e0 100644 --- a/clients/client-opsworks/commands/DescribeStacksCommand.ts +++ b/clients/client-opsworks/commands/DescribeStacksCommand.ts @@ -27,6 +27,20 @@ export interface DescribeStacksCommandOutput extends DescribeStacksResult, __Met * Manage permissions level for the stack, or an attached policy that explicitly grants * permissions. For more information about user permissions, see Managing User * Permissions.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { OpsWorksClient, DescribeStacksCommand } from "@aws-sdk/client-opsworks"; // ES Modules import + * // const { OpsWorksClient, DescribeStacksCommand } = require("@aws-sdk/client-opsworks"); // CommonJS import + * const client = new OpsWorksClient(config); + * const command = new DescribeStacksCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeStacksCommandInput} for command's `input` shape. + * @see {@link DescribeStacksCommandOutput} for command's `response` shape. + * @see {@link OpsWorksClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeStacksCommand extends $Command< DescribeStacksCommandInput, diff --git a/clients/client-opsworks/commands/DescribeTimeBasedAutoScalingCommand.ts b/clients/client-opsworks/commands/DescribeTimeBasedAutoScalingCommand.ts index cfa968530c20..1f6c4bc7d4cd 100644 --- a/clients/client-opsworks/commands/DescribeTimeBasedAutoScalingCommand.ts +++ b/clients/client-opsworks/commands/DescribeTimeBasedAutoScalingCommand.ts @@ -32,6 +32,20 @@ export interface DescribeTimeBasedAutoScalingCommandOutput * Manage permissions level for the stack, or an attached policy that explicitly grants * permissions. For more information about user permissions, see Managing User * Permissions.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { OpsWorksClient, DescribeTimeBasedAutoScalingCommand } from "@aws-sdk/client-opsworks"; // ES Modules import + * // const { OpsWorksClient, DescribeTimeBasedAutoScalingCommand } = require("@aws-sdk/client-opsworks"); // CommonJS import + * const client = new OpsWorksClient(config); + * const command = new DescribeTimeBasedAutoScalingCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeTimeBasedAutoScalingCommandInput} for command's `input` shape. + * @see {@link DescribeTimeBasedAutoScalingCommandOutput} for command's `response` shape. + * @see {@link OpsWorksClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeTimeBasedAutoScalingCommand extends $Command< DescribeTimeBasedAutoScalingCommandInput, diff --git a/clients/client-opsworks/commands/DescribeUserProfilesCommand.ts b/clients/client-opsworks/commands/DescribeUserProfilesCommand.ts index 14901b793960..b6df92163aff 100644 --- a/clients/client-opsworks/commands/DescribeUserProfilesCommand.ts +++ b/clients/client-opsworks/commands/DescribeUserProfilesCommand.ts @@ -26,6 +26,20 @@ export interface DescribeUserProfilesCommandOutput extends DescribeUserProfilesR * 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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { OpsWorksClient, DescribeUserProfilesCommand } from "@aws-sdk/client-opsworks"; // ES Modules import + * // const { OpsWorksClient, DescribeUserProfilesCommand } = require("@aws-sdk/client-opsworks"); // CommonJS import + * const client = new OpsWorksClient(config); + * const command = new DescribeUserProfilesCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeUserProfilesCommandInput} for command's `input` shape. + * @see {@link DescribeUserProfilesCommandOutput} for command's `response` shape. + * @see {@link OpsWorksClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeUserProfilesCommand extends $Command< DescribeUserProfilesCommandInput, diff --git a/clients/client-opsworks/commands/DescribeVolumesCommand.ts b/clients/client-opsworks/commands/DescribeVolumesCommand.ts index ca389f7fedc4..dc05269481c4 100644 --- a/clients/client-opsworks/commands/DescribeVolumesCommand.ts +++ b/clients/client-opsworks/commands/DescribeVolumesCommand.ts @@ -30,6 +30,20 @@ export interface DescribeVolumesCommandOutput extends DescribeVolumesResult, __M * Manage permissions level for the stack, or an attached policy that explicitly grants * permissions. For more information about user permissions, see Managing User * Permissions.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { OpsWorksClient, DescribeVolumesCommand } from "@aws-sdk/client-opsworks"; // ES Modules import + * // const { OpsWorksClient, DescribeVolumesCommand } = require("@aws-sdk/client-opsworks"); // CommonJS import + * const client = new OpsWorksClient(config); + * const command = new DescribeVolumesCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeVolumesCommandInput} for command's `input` shape. + * @see {@link DescribeVolumesCommandOutput} for command's `response` shape. + * @see {@link OpsWorksClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeVolumesCommand extends $Command< DescribeVolumesCommandInput, diff --git a/clients/client-opsworks/commands/DetachElasticLoadBalancerCommand.ts b/clients/client-opsworks/commands/DetachElasticLoadBalancerCommand.ts index c40f0595189a..cb11b5d321d2 100644 --- a/clients/client-opsworks/commands/DetachElasticLoadBalancerCommand.ts +++ b/clients/client-opsworks/commands/DetachElasticLoadBalancerCommand.ts @@ -27,6 +27,20 @@ export interface DetachElasticLoadBalancerCommandOutput extends __MetadataBearer * level for the stack, or an attached policy that explicitly grants permissions. For more * information on user permissions, see Managing User * Permissions.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { OpsWorksClient, DetachElasticLoadBalancerCommand } from "@aws-sdk/client-opsworks"; // ES Modules import + * // const { OpsWorksClient, DetachElasticLoadBalancerCommand } = require("@aws-sdk/client-opsworks"); // CommonJS import + * const client = new OpsWorksClient(config); + * const command = new DetachElasticLoadBalancerCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DetachElasticLoadBalancerCommandInput} for command's `input` shape. + * @see {@link DetachElasticLoadBalancerCommandOutput} for command's `response` shape. + * @see {@link OpsWorksClientResolvedConfig | config} for command's `input` shape. + * */ export class DetachElasticLoadBalancerCommand extends $Command< DetachElasticLoadBalancerCommandInput, diff --git a/clients/client-opsworks/commands/DisassociateElasticIpCommand.ts b/clients/client-opsworks/commands/DisassociateElasticIpCommand.ts index 7168618e3d0a..2a28e3d2301e 100644 --- a/clients/client-opsworks/commands/DisassociateElasticIpCommand.ts +++ b/clients/client-opsworks/commands/DisassociateElasticIpCommand.ts @@ -28,6 +28,20 @@ export interface DisassociateElasticIpCommandOutput extends __MetadataBearer {} * level for the stack, or an attached policy that explicitly grants permissions. For more * information on user permissions, see Managing User * Permissions.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { OpsWorksClient, DisassociateElasticIpCommand } from "@aws-sdk/client-opsworks"; // ES Modules import + * // const { OpsWorksClient, DisassociateElasticIpCommand } = require("@aws-sdk/client-opsworks"); // CommonJS import + * const client = new OpsWorksClient(config); + * const command = new DisassociateElasticIpCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DisassociateElasticIpCommandInput} for command's `input` shape. + * @see {@link DisassociateElasticIpCommandOutput} for command's `response` shape. + * @see {@link OpsWorksClientResolvedConfig | config} for command's `input` shape. + * */ export class DisassociateElasticIpCommand extends $Command< DisassociateElasticIpCommandInput, diff --git a/clients/client-opsworks/commands/GetHostnameSuggestionCommand.ts b/clients/client-opsworks/commands/GetHostnameSuggestionCommand.ts index 8b41d2ce6747..c900d4625ad5 100644 --- a/clients/client-opsworks/commands/GetHostnameSuggestionCommand.ts +++ b/clients/client-opsworks/commands/GetHostnameSuggestionCommand.ts @@ -27,6 +27,20 @@ export interface GetHostnameSuggestionCommandOutput extends GetHostnameSuggestio * level for the stack, or an attached policy that explicitly grants permissions. For more * information on user permissions, see Managing User * Permissions.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { OpsWorksClient, GetHostnameSuggestionCommand } from "@aws-sdk/client-opsworks"; // ES Modules import + * // const { OpsWorksClient, GetHostnameSuggestionCommand } = require("@aws-sdk/client-opsworks"); // CommonJS import + * const client = new OpsWorksClient(config); + * const command = new GetHostnameSuggestionCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetHostnameSuggestionCommandInput} for command's `input` shape. + * @see {@link GetHostnameSuggestionCommandOutput} for command's `response` shape. + * @see {@link OpsWorksClientResolvedConfig | config} for command's `input` shape. + * */ export class GetHostnameSuggestionCommand extends $Command< GetHostnameSuggestionCommandInput, diff --git a/clients/client-opsworks/commands/GrantAccessCommand.ts b/clients/client-opsworks/commands/GrantAccessCommand.ts index 4ed215d9e94c..3b33cd41afeb 100644 --- a/clients/client-opsworks/commands/GrantAccessCommand.ts +++ b/clients/client-opsworks/commands/GrantAccessCommand.ts @@ -25,6 +25,20 @@ export interface GrantAccessCommandOutput extends GrantAccessResult, __MetadataB *

This action can be used only with Windows stacks.

* *

Grants RDP access to a Windows instance for a specified time period.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { OpsWorksClient, GrantAccessCommand } from "@aws-sdk/client-opsworks"; // ES Modules import + * // const { OpsWorksClient, GrantAccessCommand } = require("@aws-sdk/client-opsworks"); // CommonJS import + * const client = new OpsWorksClient(config); + * const command = new GrantAccessCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GrantAccessCommandInput} for command's `input` shape. + * @see {@link GrantAccessCommandOutput} for command's `response` shape. + * @see {@link OpsWorksClientResolvedConfig | config} for command's `input` shape. + * */ export class GrantAccessCommand extends $Command< GrantAccessCommandInput, diff --git a/clients/client-opsworks/commands/ListTagsCommand.ts b/clients/client-opsworks/commands/ListTagsCommand.ts index 976403a6b995..aeabb906bd11 100644 --- a/clients/client-opsworks/commands/ListTagsCommand.ts +++ b/clients/client-opsworks/commands/ListTagsCommand.ts @@ -19,6 +19,20 @@ export interface ListTagsCommandOutput extends ListTagsResult, __MetadataBearer /** *

Returns a list of tags that are applied to the specified stack or layer.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { OpsWorksClient, ListTagsCommand } from "@aws-sdk/client-opsworks"; // ES Modules import + * // const { OpsWorksClient, ListTagsCommand } = require("@aws-sdk/client-opsworks"); // CommonJS import + * const client = new OpsWorksClient(config); + * const command = new ListTagsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListTagsCommandInput} for command's `input` shape. + * @see {@link ListTagsCommandOutput} for command's `response` shape. + * @see {@link OpsWorksClientResolvedConfig | config} for command's `input` shape. + * */ export class ListTagsCommand extends $Command< ListTagsCommandInput, diff --git a/clients/client-opsworks/commands/RebootInstanceCommand.ts b/clients/client-opsworks/commands/RebootInstanceCommand.ts index 993f7a8f1133..0549882d2ed7 100644 --- a/clients/client-opsworks/commands/RebootInstanceCommand.ts +++ b/clients/client-opsworks/commands/RebootInstanceCommand.ts @@ -28,6 +28,20 @@ export interface RebootInstanceCommandOutput extends __MetadataBearer {} * level for the stack, or an attached policy that explicitly grants permissions. For more * information on user permissions, see Managing User * Permissions.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { OpsWorksClient, RebootInstanceCommand } from "@aws-sdk/client-opsworks"; // ES Modules import + * // const { OpsWorksClient, RebootInstanceCommand } = require("@aws-sdk/client-opsworks"); // CommonJS import + * const client = new OpsWorksClient(config); + * const command = new RebootInstanceCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link RebootInstanceCommandInput} for command's `input` shape. + * @see {@link RebootInstanceCommandOutput} for command's `response` shape. + * @see {@link OpsWorksClientResolvedConfig | config} for command's `input` shape. + * */ export class RebootInstanceCommand extends $Command< RebootInstanceCommandInput, diff --git a/clients/client-opsworks/commands/RegisterEcsClusterCommand.ts b/clients/client-opsworks/commands/RegisterEcsClusterCommand.ts index eda671fdf325..6c5876be5396 100644 --- a/clients/client-opsworks/commands/RegisterEcsClusterCommand.ts +++ b/clients/client-opsworks/commands/RegisterEcsClusterCommand.ts @@ -32,6 +32,20 @@ export interface RegisterEcsClusterCommandOutput extends RegisterEcsClusterResul * information on user permissions, see * * Managing User Permissions.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { OpsWorksClient, RegisterEcsClusterCommand } from "@aws-sdk/client-opsworks"; // ES Modules import + * // const { OpsWorksClient, RegisterEcsClusterCommand } = require("@aws-sdk/client-opsworks"); // CommonJS import + * const client = new OpsWorksClient(config); + * const command = new RegisterEcsClusterCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link RegisterEcsClusterCommandInput} for command's `input` shape. + * @see {@link RegisterEcsClusterCommandOutput} for command's `response` shape. + * @see {@link OpsWorksClientResolvedConfig | config} for command's `input` shape. + * */ export class RegisterEcsClusterCommand extends $Command< RegisterEcsClusterCommandInput, diff --git a/clients/client-opsworks/commands/RegisterElasticIpCommand.ts b/clients/client-opsworks/commands/RegisterElasticIpCommand.ts index da97f5579849..24d6f75ab676 100644 --- a/clients/client-opsworks/commands/RegisterElasticIpCommand.ts +++ b/clients/client-opsworks/commands/RegisterElasticIpCommand.ts @@ -29,6 +29,20 @@ export interface RegisterElasticIpCommandOutput extends RegisterElasticIpResult, * level for the stack, or an attached policy that explicitly grants permissions. For more * information on user permissions, see Managing User * Permissions.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { OpsWorksClient, RegisterElasticIpCommand } from "@aws-sdk/client-opsworks"; // ES Modules import + * // const { OpsWorksClient, RegisterElasticIpCommand } = require("@aws-sdk/client-opsworks"); // CommonJS import + * const client = new OpsWorksClient(config); + * const command = new RegisterElasticIpCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link RegisterElasticIpCommandInput} for command's `input` shape. + * @see {@link RegisterElasticIpCommandOutput} for command's `response` shape. + * @see {@link OpsWorksClientResolvedConfig | config} for command's `input` shape. + * */ export class RegisterElasticIpCommand extends $Command< RegisterElasticIpCommandInput, diff --git a/clients/client-opsworks/commands/RegisterInstanceCommand.ts b/clients/client-opsworks/commands/RegisterInstanceCommand.ts index bcdc618e141a..b1ea4faa71ad 100644 --- a/clients/client-opsworks/commands/RegisterInstanceCommand.ts +++ b/clients/client-opsworks/commands/RegisterInstanceCommand.ts @@ -40,6 +40,20 @@ export interface RegisterInstanceCommandOutput extends RegisterInstanceResult, _ * level for the stack or an attached policy that explicitly grants permissions. For more * information on user permissions, see Managing User * Permissions.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { OpsWorksClient, RegisterInstanceCommand } from "@aws-sdk/client-opsworks"; // ES Modules import + * // const { OpsWorksClient, RegisterInstanceCommand } = require("@aws-sdk/client-opsworks"); // CommonJS import + * const client = new OpsWorksClient(config); + * const command = new RegisterInstanceCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link RegisterInstanceCommandInput} for command's `input` shape. + * @see {@link RegisterInstanceCommandOutput} for command's `response` shape. + * @see {@link OpsWorksClientResolvedConfig | config} for command's `input` shape. + * */ export class RegisterInstanceCommand extends $Command< RegisterInstanceCommandInput, diff --git a/clients/client-opsworks/commands/RegisterRdsDbInstanceCommand.ts b/clients/client-opsworks/commands/RegisterRdsDbInstanceCommand.ts index 7af67e746a05..b0b9370b8edb 100644 --- a/clients/client-opsworks/commands/RegisterRdsDbInstanceCommand.ts +++ b/clients/client-opsworks/commands/RegisterRdsDbInstanceCommand.ts @@ -27,6 +27,20 @@ export interface RegisterRdsDbInstanceCommandOutput extends __MetadataBearer {} * level for the stack, or an attached policy that explicitly grants permissions. For more * information on user permissions, see Managing User * Permissions.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { OpsWorksClient, RegisterRdsDbInstanceCommand } from "@aws-sdk/client-opsworks"; // ES Modules import + * // const { OpsWorksClient, RegisterRdsDbInstanceCommand } = require("@aws-sdk/client-opsworks"); // CommonJS import + * const client = new OpsWorksClient(config); + * const command = new RegisterRdsDbInstanceCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link RegisterRdsDbInstanceCommandInput} for command's `input` shape. + * @see {@link RegisterRdsDbInstanceCommandOutput} for command's `response` shape. + * @see {@link OpsWorksClientResolvedConfig | config} for command's `input` shape. + * */ export class RegisterRdsDbInstanceCommand extends $Command< RegisterRdsDbInstanceCommandInput, diff --git a/clients/client-opsworks/commands/RegisterVolumeCommand.ts b/clients/client-opsworks/commands/RegisterVolumeCommand.ts index 832e6d968669..f6b07d36512f 100644 --- a/clients/client-opsworks/commands/RegisterVolumeCommand.ts +++ b/clients/client-opsworks/commands/RegisterVolumeCommand.ts @@ -29,6 +29,20 @@ export interface RegisterVolumeCommandOutput extends RegisterVolumeResult, __Met * level for the stack, or an attached policy that explicitly grants permissions. For more * information on user permissions, see Managing User * Permissions.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { OpsWorksClient, RegisterVolumeCommand } from "@aws-sdk/client-opsworks"; // ES Modules import + * // const { OpsWorksClient, RegisterVolumeCommand } = require("@aws-sdk/client-opsworks"); // CommonJS import + * const client = new OpsWorksClient(config); + * const command = new RegisterVolumeCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link RegisterVolumeCommandInput} for command's `input` shape. + * @see {@link RegisterVolumeCommandOutput} for command's `response` shape. + * @see {@link OpsWorksClientResolvedConfig | config} for command's `input` shape. + * */ export class RegisterVolumeCommand extends $Command< RegisterVolumeCommandInput, diff --git a/clients/client-opsworks/commands/SetLoadBasedAutoScalingCommand.ts b/clients/client-opsworks/commands/SetLoadBasedAutoScalingCommand.ts index eb40fd19adc3..e9fef59185fc 100644 --- a/clients/client-opsworks/commands/SetLoadBasedAutoScalingCommand.ts +++ b/clients/client-opsworks/commands/SetLoadBasedAutoScalingCommand.ts @@ -32,6 +32,20 @@ export interface SetLoadBasedAutoScalingCommandOutput extends __MetadataBearer { * level for the stack, or an attached policy that explicitly grants permissions. For more * information on user permissions, see Managing User * Permissions.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { OpsWorksClient, SetLoadBasedAutoScalingCommand } from "@aws-sdk/client-opsworks"; // ES Modules import + * // const { OpsWorksClient, SetLoadBasedAutoScalingCommand } = require("@aws-sdk/client-opsworks"); // CommonJS import + * const client = new OpsWorksClient(config); + * const command = new SetLoadBasedAutoScalingCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link SetLoadBasedAutoScalingCommandInput} for command's `input` shape. + * @see {@link SetLoadBasedAutoScalingCommandOutput} for command's `response` shape. + * @see {@link OpsWorksClientResolvedConfig | config} for command's `input` shape. + * */ export class SetLoadBasedAutoScalingCommand extends $Command< SetLoadBasedAutoScalingCommandInput, diff --git a/clients/client-opsworks/commands/SetPermissionCommand.ts b/clients/client-opsworks/commands/SetPermissionCommand.ts index 8a684d68edc7..48afd03a6f5b 100644 --- a/clients/client-opsworks/commands/SetPermissionCommand.ts +++ b/clients/client-opsworks/commands/SetPermissionCommand.ts @@ -28,6 +28,20 @@ export interface SetPermissionCommandOutput extends __MetadataBearer {} * level for the stack, or an attached policy that explicitly grants permissions. For more * information on user permissions, see Managing User * Permissions.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { OpsWorksClient, SetPermissionCommand } from "@aws-sdk/client-opsworks"; // ES Modules import + * // const { OpsWorksClient, SetPermissionCommand } = require("@aws-sdk/client-opsworks"); // CommonJS import + * const client = new OpsWorksClient(config); + * const command = new SetPermissionCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link SetPermissionCommandInput} for command's `input` shape. + * @see {@link SetPermissionCommandOutput} for command's `response` shape. + * @see {@link OpsWorksClientResolvedConfig | config} for command's `input` shape. + * */ export class SetPermissionCommand extends $Command< SetPermissionCommandInput, diff --git a/clients/client-opsworks/commands/SetTimeBasedAutoScalingCommand.ts b/clients/client-opsworks/commands/SetTimeBasedAutoScalingCommand.ts index fe7411d6e5c3..1f019ff5dc99 100644 --- a/clients/client-opsworks/commands/SetTimeBasedAutoScalingCommand.ts +++ b/clients/client-opsworks/commands/SetTimeBasedAutoScalingCommand.ts @@ -29,6 +29,20 @@ export interface SetTimeBasedAutoScalingCommandOutput extends __MetadataBearer { * level for the stack, or an attached policy that explicitly grants permissions. For more * information on user permissions, see Managing User * Permissions.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { OpsWorksClient, SetTimeBasedAutoScalingCommand } from "@aws-sdk/client-opsworks"; // ES Modules import + * // const { OpsWorksClient, SetTimeBasedAutoScalingCommand } = require("@aws-sdk/client-opsworks"); // CommonJS import + * const client = new OpsWorksClient(config); + * const command = new SetTimeBasedAutoScalingCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link SetTimeBasedAutoScalingCommandInput} for command's `input` shape. + * @see {@link SetTimeBasedAutoScalingCommandOutput} for command's `response` shape. + * @see {@link OpsWorksClientResolvedConfig | config} for command's `input` shape. + * */ export class SetTimeBasedAutoScalingCommand extends $Command< SetTimeBasedAutoScalingCommandInput, diff --git a/clients/client-opsworks/commands/StartInstanceCommand.ts b/clients/client-opsworks/commands/StartInstanceCommand.ts index 14576d648302..d657c48b692f 100644 --- a/clients/client-opsworks/commands/StartInstanceCommand.ts +++ b/clients/client-opsworks/commands/StartInstanceCommand.ts @@ -28,6 +28,20 @@ export interface StartInstanceCommandOutput extends __MetadataBearer {} * level for the stack, or an attached policy that explicitly grants permissions. For more * information on user permissions, see Managing User * Permissions.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { OpsWorksClient, StartInstanceCommand } from "@aws-sdk/client-opsworks"; // ES Modules import + * // const { OpsWorksClient, StartInstanceCommand } = require("@aws-sdk/client-opsworks"); // CommonJS import + * const client = new OpsWorksClient(config); + * const command = new StartInstanceCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link StartInstanceCommandInput} for command's `input` shape. + * @see {@link StartInstanceCommandOutput} for command's `response` shape. + * @see {@link OpsWorksClientResolvedConfig | config} for command's `input` shape. + * */ export class StartInstanceCommand extends $Command< StartInstanceCommandInput, diff --git a/clients/client-opsworks/commands/StartStackCommand.ts b/clients/client-opsworks/commands/StartStackCommand.ts index 90d03f2565c0..b7a9139999a3 100644 --- a/clients/client-opsworks/commands/StartStackCommand.ts +++ b/clients/client-opsworks/commands/StartStackCommand.ts @@ -27,6 +27,20 @@ export interface StartStackCommandOutput extends __MetadataBearer {} * level for the stack, or an attached policy that explicitly grants permissions. For more * information on user permissions, see Managing User * Permissions.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { OpsWorksClient, StartStackCommand } from "@aws-sdk/client-opsworks"; // ES Modules import + * // const { OpsWorksClient, StartStackCommand } = require("@aws-sdk/client-opsworks"); // CommonJS import + * const client = new OpsWorksClient(config); + * const command = new StartStackCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link StartStackCommandInput} for command's `input` shape. + * @see {@link StartStackCommandOutput} for command's `response` shape. + * @see {@link OpsWorksClientResolvedConfig | config} for command's `input` shape. + * */ export class StartStackCommand extends $Command< StartStackCommandInput, diff --git a/clients/client-opsworks/commands/StopInstanceCommand.ts b/clients/client-opsworks/commands/StopInstanceCommand.ts index 6799f5bb1d2d..d810f56a0bab 100644 --- a/clients/client-opsworks/commands/StopInstanceCommand.ts +++ b/clients/client-opsworks/commands/StopInstanceCommand.ts @@ -30,6 +30,20 @@ export interface StopInstanceCommandOutput extends __MetadataBearer {} * level for the stack, or an attached policy that explicitly grants permissions. For more * information on user permissions, see Managing User * Permissions.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { OpsWorksClient, StopInstanceCommand } from "@aws-sdk/client-opsworks"; // ES Modules import + * // const { OpsWorksClient, StopInstanceCommand } = require("@aws-sdk/client-opsworks"); // CommonJS import + * const client = new OpsWorksClient(config); + * const command = new StopInstanceCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link StopInstanceCommandInput} for command's `input` shape. + * @see {@link StopInstanceCommandOutput} for command's `response` shape. + * @see {@link OpsWorksClientResolvedConfig | config} for command's `input` shape. + * */ export class StopInstanceCommand extends $Command< StopInstanceCommandInput, diff --git a/clients/client-opsworks/commands/StopStackCommand.ts b/clients/client-opsworks/commands/StopStackCommand.ts index fb9d17b87b4f..5472693d6502 100644 --- a/clients/client-opsworks/commands/StopStackCommand.ts +++ b/clients/client-opsworks/commands/StopStackCommand.ts @@ -24,6 +24,20 @@ export interface StopStackCommandOutput extends __MetadataBearer {} * level for the stack, or an attached policy that explicitly grants permissions. For more * information on user permissions, see Managing User * Permissions.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { OpsWorksClient, StopStackCommand } from "@aws-sdk/client-opsworks"; // ES Modules import + * // const { OpsWorksClient, StopStackCommand } = require("@aws-sdk/client-opsworks"); // CommonJS import + * const client = new OpsWorksClient(config); + * const command = new StopStackCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link StopStackCommandInput} for command's `input` shape. + * @see {@link StopStackCommandOutput} for command's `response` shape. + * @see {@link OpsWorksClientResolvedConfig | config} for command's `input` shape. + * */ export class StopStackCommand extends $Command< StopStackCommandInput, diff --git a/clients/client-opsworks/commands/TagResourceCommand.ts b/clients/client-opsworks/commands/TagResourceCommand.ts index 4434c5190663..357e9188002b 100644 --- a/clients/client-opsworks/commands/TagResourceCommand.ts +++ b/clients/client-opsworks/commands/TagResourceCommand.ts @@ -22,6 +22,20 @@ export interface TagResourceCommandOutput extends __MetadataBearer {} /** *

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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { OpsWorksClient, TagResourceCommand } from "@aws-sdk/client-opsworks"; // ES Modules import + * // const { OpsWorksClient, TagResourceCommand } = require("@aws-sdk/client-opsworks"); // CommonJS import + * const client = new OpsWorksClient(config); + * const command = new TagResourceCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link TagResourceCommandInput} for command's `input` shape. + * @see {@link TagResourceCommandOutput} for command's `response` shape. + * @see {@link OpsWorksClientResolvedConfig | config} for command's `input` shape. + * */ export class TagResourceCommand extends $Command< TagResourceCommandInput, diff --git a/clients/client-opsworks/commands/UnassignInstanceCommand.ts b/clients/client-opsworks/commands/UnassignInstanceCommand.ts index 27a8e1d877bc..9e7547ade967 100644 --- a/clients/client-opsworks/commands/UnassignInstanceCommand.ts +++ b/clients/client-opsworks/commands/UnassignInstanceCommand.ts @@ -30,6 +30,20 @@ export interface UnassignInstanceCommandOutput extends __MetadataBearer {} * 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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { OpsWorksClient, UnassignInstanceCommand } from "@aws-sdk/client-opsworks"; // ES Modules import + * // const { OpsWorksClient, UnassignInstanceCommand } = require("@aws-sdk/client-opsworks"); // CommonJS import + * const client = new OpsWorksClient(config); + * const command = new UnassignInstanceCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link UnassignInstanceCommandInput} for command's `input` shape. + * @see {@link UnassignInstanceCommandOutput} for command's `response` shape. + * @see {@link OpsWorksClientResolvedConfig | config} for command's `input` shape. + * */ export class UnassignInstanceCommand extends $Command< UnassignInstanceCommandInput, diff --git a/clients/client-opsworks/commands/UnassignVolumeCommand.ts b/clients/client-opsworks/commands/UnassignVolumeCommand.ts index 93c463698178..2558a7af5177 100644 --- a/clients/client-opsworks/commands/UnassignVolumeCommand.ts +++ b/clients/client-opsworks/commands/UnassignVolumeCommand.ts @@ -29,6 +29,20 @@ export interface UnassignVolumeCommandOutput extends __MetadataBearer {} * level for the stack, or an attached policy that explicitly grants permissions. For more * information on user permissions, see Managing User * Permissions.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { OpsWorksClient, UnassignVolumeCommand } from "@aws-sdk/client-opsworks"; // ES Modules import + * // const { OpsWorksClient, UnassignVolumeCommand } = require("@aws-sdk/client-opsworks"); // CommonJS import + * const client = new OpsWorksClient(config); + * const command = new UnassignVolumeCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link UnassignVolumeCommandInput} for command's `input` shape. + * @see {@link UnassignVolumeCommandOutput} for command's `response` shape. + * @see {@link OpsWorksClientResolvedConfig | config} for command's `input` shape. + * */ export class UnassignVolumeCommand extends $Command< UnassignVolumeCommandInput, diff --git a/clients/client-opsworks/commands/UntagResourceCommand.ts b/clients/client-opsworks/commands/UntagResourceCommand.ts index 5316f4c61dcb..233c2e45ba92 100644 --- a/clients/client-opsworks/commands/UntagResourceCommand.ts +++ b/clients/client-opsworks/commands/UntagResourceCommand.ts @@ -22,6 +22,20 @@ export interface UntagResourceCommandOutput extends __MetadataBearer {} /** *

Removes tags from a specified stack or layer.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { OpsWorksClient, UntagResourceCommand } from "@aws-sdk/client-opsworks"; // ES Modules import + * // const { OpsWorksClient, UntagResourceCommand } = require("@aws-sdk/client-opsworks"); // CommonJS import + * const client = new OpsWorksClient(config); + * const command = new UntagResourceCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link UntagResourceCommandInput} for command's `input` shape. + * @see {@link UntagResourceCommandOutput} for command's `response` shape. + * @see {@link OpsWorksClientResolvedConfig | config} for command's `input` shape. + * */ export class UntagResourceCommand extends $Command< UntagResourceCommandInput, diff --git a/clients/client-opsworks/commands/UpdateAppCommand.ts b/clients/client-opsworks/commands/UpdateAppCommand.ts index 250b621031a5..ee8559567db5 100644 --- a/clients/client-opsworks/commands/UpdateAppCommand.ts +++ b/clients/client-opsworks/commands/UpdateAppCommand.ts @@ -24,6 +24,20 @@ export interface UpdateAppCommandOutput extends __MetadataBearer {} * permissions level for the stack, or an attached policy that explicitly grants permissions. For * more information on user permissions, see Managing User * Permissions.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { OpsWorksClient, UpdateAppCommand } from "@aws-sdk/client-opsworks"; // ES Modules import + * // const { OpsWorksClient, UpdateAppCommand } = require("@aws-sdk/client-opsworks"); // CommonJS import + * const client = new OpsWorksClient(config); + * const command = new UpdateAppCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link UpdateAppCommandInput} for command's `input` shape. + * @see {@link UpdateAppCommandOutput} for command's `response` shape. + * @see {@link OpsWorksClientResolvedConfig | config} for command's `input` shape. + * */ export class UpdateAppCommand extends $Command< UpdateAppCommandInput, diff --git a/clients/client-opsworks/commands/UpdateElasticIpCommand.ts b/clients/client-opsworks/commands/UpdateElasticIpCommand.ts index 1654f8319593..647189087ab9 100644 --- a/clients/client-opsworks/commands/UpdateElasticIpCommand.ts +++ b/clients/client-opsworks/commands/UpdateElasticIpCommand.ts @@ -27,6 +27,20 @@ export interface UpdateElasticIpCommandOutput extends __MetadataBearer {} * level for the stack, or an attached policy that explicitly grants permissions. For more * information on user permissions, see Managing User * Permissions.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { OpsWorksClient, UpdateElasticIpCommand } from "@aws-sdk/client-opsworks"; // ES Modules import + * // const { OpsWorksClient, UpdateElasticIpCommand } = require("@aws-sdk/client-opsworks"); // CommonJS import + * const client = new OpsWorksClient(config); + * const command = new UpdateElasticIpCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link UpdateElasticIpCommandInput} for command's `input` shape. + * @see {@link UpdateElasticIpCommandOutput} for command's `response` shape. + * @see {@link OpsWorksClientResolvedConfig | config} for command's `input` shape. + * */ export class UpdateElasticIpCommand extends $Command< UpdateElasticIpCommandInput, diff --git a/clients/client-opsworks/commands/UpdateInstanceCommand.ts b/clients/client-opsworks/commands/UpdateInstanceCommand.ts index 1a9a3431c426..43d4c5e1697f 100644 --- a/clients/client-opsworks/commands/UpdateInstanceCommand.ts +++ b/clients/client-opsworks/commands/UpdateInstanceCommand.ts @@ -27,6 +27,20 @@ export interface UpdateInstanceCommandOutput extends __MetadataBearer {} * level for the stack, or an attached policy that explicitly grants permissions. For more * information on user permissions, see Managing User * Permissions.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { OpsWorksClient, UpdateInstanceCommand } from "@aws-sdk/client-opsworks"; // ES Modules import + * // const { OpsWorksClient, UpdateInstanceCommand } = require("@aws-sdk/client-opsworks"); // CommonJS import + * const client = new OpsWorksClient(config); + * const command = new UpdateInstanceCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link UpdateInstanceCommandInput} for command's `input` shape. + * @see {@link UpdateInstanceCommandOutput} for command's `response` shape. + * @see {@link OpsWorksClientResolvedConfig | config} for command's `input` shape. + * */ export class UpdateInstanceCommand extends $Command< UpdateInstanceCommandInput, diff --git a/clients/client-opsworks/commands/UpdateLayerCommand.ts b/clients/client-opsworks/commands/UpdateLayerCommand.ts index d1256602ad30..21876c3eff21 100644 --- a/clients/client-opsworks/commands/UpdateLayerCommand.ts +++ b/clients/client-opsworks/commands/UpdateLayerCommand.ts @@ -27,6 +27,20 @@ export interface UpdateLayerCommandOutput extends __MetadataBearer {} * level for the stack, or an attached policy that explicitly grants permissions. For more * information on user permissions, see Managing User * Permissions.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { OpsWorksClient, UpdateLayerCommand } from "@aws-sdk/client-opsworks"; // ES Modules import + * // const { OpsWorksClient, UpdateLayerCommand } = require("@aws-sdk/client-opsworks"); // CommonJS import + * const client = new OpsWorksClient(config); + * const command = new UpdateLayerCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link UpdateLayerCommandInput} for command's `input` shape. + * @see {@link UpdateLayerCommandOutput} for command's `response` shape. + * @see {@link OpsWorksClientResolvedConfig | config} for command's `input` shape. + * */ export class UpdateLayerCommand extends $Command< UpdateLayerCommandInput, diff --git a/clients/client-opsworks/commands/UpdateMyUserProfileCommand.ts b/clients/client-opsworks/commands/UpdateMyUserProfileCommand.ts index f7fc4edcf3a5..1a50cbfdd776 100644 --- a/clients/client-opsworks/commands/UpdateMyUserProfileCommand.ts +++ b/clients/client-opsworks/commands/UpdateMyUserProfileCommand.ts @@ -27,6 +27,20 @@ export interface UpdateMyUserProfileCommandOutput extends __MetadataBearer {} * enabled or an attached policy that explicitly grants permissions. For more information about user * permissions, see Managing User * Permissions.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { OpsWorksClient, UpdateMyUserProfileCommand } from "@aws-sdk/client-opsworks"; // ES Modules import + * // const { OpsWorksClient, UpdateMyUserProfileCommand } = require("@aws-sdk/client-opsworks"); // CommonJS import + * const client = new OpsWorksClient(config); + * const command = new UpdateMyUserProfileCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link UpdateMyUserProfileCommandInput} for command's `input` shape. + * @see {@link UpdateMyUserProfileCommandOutput} for command's `response` shape. + * @see {@link OpsWorksClientResolvedConfig | config} for command's `input` shape. + * */ export class UpdateMyUserProfileCommand extends $Command< UpdateMyUserProfileCommandInput, diff --git a/clients/client-opsworks/commands/UpdateRdsDbInstanceCommand.ts b/clients/client-opsworks/commands/UpdateRdsDbInstanceCommand.ts index a285e8892077..0d5d68976184 100644 --- a/clients/client-opsworks/commands/UpdateRdsDbInstanceCommand.ts +++ b/clients/client-opsworks/commands/UpdateRdsDbInstanceCommand.ts @@ -27,6 +27,20 @@ export interface UpdateRdsDbInstanceCommandOutput extends __MetadataBearer {} * level for the stack, or an attached policy that explicitly grants permissions. For more * information on user permissions, see Managing User * Permissions.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { OpsWorksClient, UpdateRdsDbInstanceCommand } from "@aws-sdk/client-opsworks"; // ES Modules import + * // const { OpsWorksClient, UpdateRdsDbInstanceCommand } = require("@aws-sdk/client-opsworks"); // CommonJS import + * const client = new OpsWorksClient(config); + * const command = new UpdateRdsDbInstanceCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link UpdateRdsDbInstanceCommandInput} for command's `input` shape. + * @see {@link UpdateRdsDbInstanceCommandOutput} for command's `response` shape. + * @see {@link OpsWorksClientResolvedConfig | config} for command's `input` shape. + * */ export class UpdateRdsDbInstanceCommand extends $Command< UpdateRdsDbInstanceCommandInput, diff --git a/clients/client-opsworks/commands/UpdateStackCommand.ts b/clients/client-opsworks/commands/UpdateStackCommand.ts index 4aa0df577e08..1a23437b51d4 100644 --- a/clients/client-opsworks/commands/UpdateStackCommand.ts +++ b/clients/client-opsworks/commands/UpdateStackCommand.ts @@ -27,6 +27,20 @@ export interface UpdateStackCommandOutput extends __MetadataBearer {} * level for the stack, or an attached policy that explicitly grants permissions. For more * information on user permissions, see Managing User * Permissions.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { OpsWorksClient, UpdateStackCommand } from "@aws-sdk/client-opsworks"; // ES Modules import + * // const { OpsWorksClient, UpdateStackCommand } = require("@aws-sdk/client-opsworks"); // CommonJS import + * const client = new OpsWorksClient(config); + * const command = new UpdateStackCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link UpdateStackCommandInput} for command's `input` shape. + * @see {@link UpdateStackCommandOutput} for command's `response` shape. + * @see {@link OpsWorksClientResolvedConfig | config} for command's `input` shape. + * */ export class UpdateStackCommand extends $Command< UpdateStackCommandInput, diff --git a/clients/client-opsworks/commands/UpdateUserProfileCommand.ts b/clients/client-opsworks/commands/UpdateUserProfileCommand.ts index 894e36fd26de..3f027df7efd7 100644 --- a/clients/client-opsworks/commands/UpdateUserProfileCommand.ts +++ b/clients/client-opsworks/commands/UpdateUserProfileCommand.ts @@ -26,6 +26,20 @@ export interface UpdateUserProfileCommandOutput extends __MetadataBearer {} * 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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { OpsWorksClient, UpdateUserProfileCommand } from "@aws-sdk/client-opsworks"; // ES Modules import + * // const { OpsWorksClient, UpdateUserProfileCommand } = require("@aws-sdk/client-opsworks"); // CommonJS import + * const client = new OpsWorksClient(config); + * const command = new UpdateUserProfileCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link UpdateUserProfileCommandInput} for command's `input` shape. + * @see {@link UpdateUserProfileCommandOutput} for command's `response` shape. + * @see {@link OpsWorksClientResolvedConfig | config} for command's `input` shape. + * */ export class UpdateUserProfileCommand extends $Command< UpdateUserProfileCommandInput, diff --git a/clients/client-opsworks/commands/UpdateVolumeCommand.ts b/clients/client-opsworks/commands/UpdateVolumeCommand.ts index 3dc6c604bc10..c90086d4c89c 100644 --- a/clients/client-opsworks/commands/UpdateVolumeCommand.ts +++ b/clients/client-opsworks/commands/UpdateVolumeCommand.ts @@ -27,6 +27,20 @@ export interface UpdateVolumeCommandOutput extends __MetadataBearer {} * level for the stack, or an attached policy that explicitly grants permissions. For more * information on user permissions, see Managing User * Permissions.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { OpsWorksClient, UpdateVolumeCommand } from "@aws-sdk/client-opsworks"; // ES Modules import + * // const { OpsWorksClient, UpdateVolumeCommand } = require("@aws-sdk/client-opsworks"); // CommonJS import + * const client = new OpsWorksClient(config); + * const command = new UpdateVolumeCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link UpdateVolumeCommandInput} for command's `input` shape. + * @see {@link UpdateVolumeCommandOutput} for command's `response` shape. + * @see {@link OpsWorksClientResolvedConfig | config} for command's `input` shape. + * */ export class UpdateVolumeCommand extends $Command< UpdateVolumeCommandInput, diff --git a/clients/client-opsworks/models/models_0.ts b/clients/client-opsworks/models/models_0.ts index cccf49062118..0df7c922c2c0 100644 --- a/clients/client-opsworks/models/models_0.ts +++ b/clients/client-opsworks/models/models_0.ts @@ -17,6 +17,9 @@ export interface StackConfigurationManager { } export namespace StackConfigurationManager { + /** + * @internal + */ export const filterSensitiveLog = (obj: StackConfigurationManager): any => ({ ...obj, }); @@ -38,6 +41,9 @@ export interface AgentVersion { } export namespace AgentVersion { + /** + * @internal + */ export const filterSensitiveLog = (obj: AgentVersion): any => ({ ...obj, }); @@ -106,6 +112,9 @@ export interface Source { } export namespace Source { + /** + * @internal + */ export const filterSensitiveLog = (obj: Source): any => ({ ...obj, }); @@ -135,6 +144,9 @@ export interface DataSource { } export namespace DataSource { + /** + * @internal + */ export const filterSensitiveLog = (obj: DataSource): any => ({ ...obj, }); @@ -164,6 +176,9 @@ export interface EnvironmentVariable { } export namespace EnvironmentVariable { + /** + * @internal + */ export const filterSensitiveLog = (obj: EnvironmentVariable): any => ({ ...obj, }); @@ -190,6 +205,9 @@ export interface SslConfiguration { } export namespace SslConfiguration { + /** + * @internal + */ export const filterSensitiveLog = (obj: SslConfiguration): any => ({ ...obj, }); @@ -280,6 +298,9 @@ export interface App { } export namespace App { + /** + * @internal + */ export const filterSensitiveLog = (obj: App): any => ({ ...obj, }); @@ -300,6 +321,9 @@ export interface AssignInstanceRequest { } export namespace AssignInstanceRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: AssignInstanceRequest): any => ({ ...obj, }); @@ -318,6 +342,9 @@ export interface ResourceNotFoundException extends __SmithyException, $MetadataB } export namespace ResourceNotFoundException { + /** + * @internal + */ export const filterSensitiveLog = (obj: ResourceNotFoundException): any => ({ ...obj, }); @@ -336,6 +363,9 @@ export interface ValidationException extends __SmithyException, $MetadataBearer } export namespace ValidationException { + /** + * @internal + */ export const filterSensitiveLog = (obj: ValidationException): any => ({ ...obj, }); @@ -354,6 +384,9 @@ export interface AssignVolumeRequest { } export namespace AssignVolumeRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: AssignVolumeRequest): any => ({ ...obj, }); @@ -372,6 +405,9 @@ export interface AssociateElasticIpRequest { } export namespace AssociateElasticIpRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: AssociateElasticIpRequest): any => ({ ...obj, }); @@ -390,6 +426,9 @@ export interface AttachElasticLoadBalancerRequest { } export namespace AttachElasticLoadBalancerRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: AttachElasticLoadBalancerRequest): any => ({ ...obj, }); @@ -448,6 +487,9 @@ export interface AutoScalingThresholds { } export namespace AutoScalingThresholds { + /** + * @internal + */ export const filterSensitiveLog = (obj: AutoScalingThresholds): any => ({ ...obj, }); @@ -494,6 +536,9 @@ export interface EbsBlockDevice { } export namespace EbsBlockDevice { + /** + * @internal + */ export const filterSensitiveLog = (obj: EbsBlockDevice): any => ({ ...obj, }); @@ -528,6 +573,9 @@ export interface BlockDeviceMapping { } export namespace BlockDeviceMapping { + /** + * @internal + */ export const filterSensitiveLog = (obj: BlockDeviceMapping): any => ({ ...obj, }); @@ -549,6 +597,9 @@ export interface ChefConfiguration { } export namespace ChefConfiguration { + /** + * @internal + */ export const filterSensitiveLog = (obj: ChefConfiguration): any => ({ ...obj, }); @@ -861,6 +912,9 @@ export interface CloneStackRequest { } export namespace CloneStackRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: CloneStackRequest): any => ({ ...obj, }); @@ -877,6 +931,9 @@ export interface CloneStackResult { } export namespace CloneStackResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: CloneStackResult): any => ({ ...obj, }); @@ -1058,6 +1115,9 @@ export interface CloudWatchLogsLogStream { } export namespace CloudWatchLogsLogStream { + /** + * @internal + */ export const filterSensitiveLog = (obj: CloudWatchLogsLogStream): any => ({ ...obj, }); @@ -1079,6 +1139,9 @@ export interface CloudWatchLogsConfiguration { } export namespace CloudWatchLogsConfiguration { + /** + * @internal + */ export const filterSensitiveLog = (obj: CloudWatchLogsConfiguration): any => ({ ...obj, }); @@ -1216,6 +1279,9 @@ export interface Command { } export namespace Command { + /** + * @internal + */ export const filterSensitiveLog = (obj: Command): any => ({ ...obj, }); @@ -1295,6 +1361,9 @@ export interface CreateAppRequest { } export namespace CreateAppRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateAppRequest): any => ({ ...obj, }); @@ -1311,6 +1380,9 @@ export interface CreateAppResult { } export namespace CreateAppResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateAppResult): any => ({ ...obj, }); @@ -1426,6 +1498,9 @@ export interface DeploymentCommand { } export namespace DeploymentCommand { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeploymentCommand): any => ({ ...obj, }); @@ -1476,6 +1551,9 @@ export interface CreateDeploymentRequest { } export namespace CreateDeploymentRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateDeploymentRequest): any => ({ ...obj, }); @@ -1492,6 +1570,9 @@ export interface CreateDeploymentResult { } export namespace CreateDeploymentResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateDeploymentResult): any => ({ ...obj, }); @@ -1664,6 +1745,9 @@ export interface CreateInstanceRequest { } export namespace CreateInstanceRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateInstanceRequest): any => ({ ...obj, }); @@ -1680,6 +1764,9 @@ export interface CreateInstanceResult { } export namespace CreateInstanceResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateInstanceResult): any => ({ ...obj, }); @@ -1751,6 +1838,9 @@ export interface Recipes { } export namespace Recipes { + /** + * @internal + */ export const filterSensitiveLog = (obj: Recipes): any => ({ ...obj, }); @@ -1773,6 +1863,9 @@ export interface ShutdownEventConfiguration { } export namespace ShutdownEventConfiguration { + /** + * @internal + */ export const filterSensitiveLog = (obj: ShutdownEventConfiguration): any => ({ ...obj, }); @@ -1790,6 +1883,9 @@ export interface LifecycleEventConfiguration { } export namespace LifecycleEventConfiguration { + /** + * @internal + */ export const filterSensitiveLog = (obj: LifecycleEventConfiguration): any => ({ ...obj, }); @@ -1874,6 +1970,9 @@ export interface VolumeConfiguration { } export namespace VolumeConfiguration { + /** + * @internal + */ export const filterSensitiveLog = (obj: VolumeConfiguration): any => ({ ...obj, }); @@ -1994,6 +2093,9 @@ export interface CreateLayerRequest { } export namespace CreateLayerRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateLayerRequest): any => ({ ...obj, }); @@ -2010,6 +2112,9 @@ export interface CreateLayerResult { } export namespace CreateLayerResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateLayerResult): any => ({ ...obj, }); @@ -2315,6 +2420,9 @@ export interface CreateStackRequest { } export namespace CreateStackRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateStackRequest): any => ({ ...obj, }); @@ -2332,6 +2440,9 @@ export interface CreateStackResult { } export namespace CreateStackResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateStackResult): any => ({ ...obj, }); @@ -2365,6 +2476,9 @@ export interface CreateUserProfileRequest { } export namespace CreateUserProfileRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateUserProfileRequest): any => ({ ...obj, }); @@ -2381,6 +2495,9 @@ export interface CreateUserProfileResult { } export namespace CreateUserProfileResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateUserProfileResult): any => ({ ...obj, }); @@ -2394,6 +2511,9 @@ export interface DeleteAppRequest { } export namespace DeleteAppRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteAppRequest): any => ({ ...obj, }); @@ -2417,6 +2537,9 @@ export interface DeleteInstanceRequest { } export namespace DeleteInstanceRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteInstanceRequest): any => ({ ...obj, }); @@ -2430,6 +2553,9 @@ export interface DeleteLayerRequest { } export namespace DeleteLayerRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteLayerRequest): any => ({ ...obj, }); @@ -2443,6 +2569,9 @@ export interface DeleteStackRequest { } export namespace DeleteStackRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteStackRequest): any => ({ ...obj, }); @@ -2456,6 +2585,9 @@ export interface DeleteUserProfileRequest { } export namespace DeleteUserProfileRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteUserProfileRequest): any => ({ ...obj, }); @@ -2543,6 +2675,9 @@ export interface Deployment { } export namespace Deployment { + /** + * @internal + */ export const filterSensitiveLog = (obj: Deployment): any => ({ ...obj, }); @@ -2556,6 +2691,9 @@ export interface DeregisterEcsClusterRequest { } export namespace DeregisterEcsClusterRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeregisterEcsClusterRequest): any => ({ ...obj, }); @@ -2569,6 +2707,9 @@ export interface DeregisterElasticIpRequest { } export namespace DeregisterElasticIpRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeregisterElasticIpRequest): any => ({ ...obj, }); @@ -2582,6 +2723,9 @@ export interface DeregisterInstanceRequest { } export namespace DeregisterInstanceRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeregisterInstanceRequest): any => ({ ...obj, }); @@ -2595,6 +2739,9 @@ export interface DeregisterRdsDbInstanceRequest { } export namespace DeregisterRdsDbInstanceRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeregisterRdsDbInstanceRequest): any => ({ ...obj, }); @@ -2608,6 +2755,9 @@ export interface DeregisterVolumeRequest { } export namespace DeregisterVolumeRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeregisterVolumeRequest): any => ({ ...obj, }); @@ -2626,6 +2776,9 @@ export interface DescribeAgentVersionsRequest { } export namespace DescribeAgentVersionsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeAgentVersionsRequest): any => ({ ...obj, }); @@ -2642,6 +2795,9 @@ export interface DescribeAgentVersionsResult { } export namespace DescribeAgentVersionsResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeAgentVersionsResult): any => ({ ...obj, }); @@ -2663,6 +2819,9 @@ export interface DescribeAppsRequest { } export namespace DescribeAppsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeAppsRequest): any => ({ ...obj, }); @@ -2679,6 +2838,9 @@ export interface DescribeAppsResult { } export namespace DescribeAppsResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeAppsResult): any => ({ ...obj, }); @@ -2706,6 +2868,9 @@ export interface DescribeCommandsRequest { } export namespace DescribeCommandsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeCommandsRequest): any => ({ ...obj, }); @@ -2722,6 +2887,9 @@ export interface DescribeCommandsResult { } export namespace DescribeCommandsResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeCommandsResult): any => ({ ...obj, }); @@ -2749,6 +2917,9 @@ export interface DescribeDeploymentsRequest { } export namespace DescribeDeploymentsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeDeploymentsRequest): any => ({ ...obj, }); @@ -2765,6 +2936,9 @@ export interface DescribeDeploymentsResult { } export namespace DescribeDeploymentsResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeDeploymentsResult): any => ({ ...obj, }); @@ -2802,6 +2976,9 @@ export interface DescribeEcsClustersRequest { } export namespace DescribeEcsClustersRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeEcsClustersRequest): any => ({ ...obj, }); @@ -2833,6 +3010,9 @@ export interface EcsCluster { } export namespace EcsCluster { + /** + * @internal + */ export const filterSensitiveLog = (obj: EcsCluster): any => ({ ...obj, }); @@ -2857,6 +3037,9 @@ export interface DescribeEcsClustersResult { } export namespace DescribeEcsClustersResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeEcsClustersResult): any => ({ ...obj, }); @@ -2884,6 +3067,9 @@ export interface DescribeElasticIpsRequest { } export namespace DescribeElasticIpsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeElasticIpsRequest): any => ({ ...obj, }); @@ -2920,6 +3106,9 @@ export interface ElasticIp { } export namespace ElasticIp { + /** + * @internal + */ export const filterSensitiveLog = (obj: ElasticIp): any => ({ ...obj, }); @@ -2936,6 +3125,9 @@ export interface DescribeElasticIpsResult { } export namespace DescribeElasticIpsResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeElasticIpsResult): any => ({ ...obj, }); @@ -2954,6 +3146,9 @@ export interface DescribeElasticLoadBalancersRequest { } export namespace DescribeElasticLoadBalancersRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeElasticLoadBalancersRequest): any => ({ ...obj, }); @@ -3010,6 +3205,9 @@ export interface ElasticLoadBalancer { } export namespace ElasticLoadBalancer { + /** + * @internal + */ export const filterSensitiveLog = (obj: ElasticLoadBalancer): any => ({ ...obj, }); @@ -3027,6 +3225,9 @@ export interface DescribeElasticLoadBalancersResult { } export namespace DescribeElasticLoadBalancersResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeElasticLoadBalancersResult): any => ({ ...obj, }); @@ -3054,6 +3255,9 @@ export interface DescribeInstancesRequest { } export namespace DescribeInstancesRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeInstancesRequest): any => ({ ...obj, }); @@ -3080,6 +3284,9 @@ export interface ReportedOs { } export namespace ReportedOs { + /** + * @internal + */ export const filterSensitiveLog = (obj: ReportedOs): any => ({ ...obj, }); @@ -3392,6 +3599,9 @@ export interface Instance { } export namespace Instance { + /** + * @internal + */ export const filterSensitiveLog = (obj: Instance): any => ({ ...obj, }); @@ -3408,6 +3618,9 @@ export interface DescribeInstancesResult { } export namespace DescribeInstancesResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeInstancesResult): any => ({ ...obj, }); @@ -3427,6 +3640,9 @@ export interface DescribeLayersRequest { } export namespace DescribeLayersRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeLayersRequest): any => ({ ...obj, }); @@ -3580,6 +3796,9 @@ export interface Layer { } export namespace Layer { + /** + * @internal + */ export const filterSensitiveLog = (obj: Layer): any => ({ ...obj, }); @@ -3596,6 +3815,9 @@ export interface DescribeLayersResult { } export namespace DescribeLayersResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeLayersResult): any => ({ ...obj, }); @@ -3609,6 +3831,9 @@ export interface DescribeLoadBasedAutoScalingRequest { } export namespace DescribeLoadBasedAutoScalingRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeLoadBasedAutoScalingRequest): any => ({ ...obj, }); @@ -3642,6 +3867,9 @@ export interface LoadBasedAutoScalingConfiguration { } export namespace LoadBasedAutoScalingConfiguration { + /** + * @internal + */ export const filterSensitiveLog = (obj: LoadBasedAutoScalingConfiguration): any => ({ ...obj, }); @@ -3659,6 +3887,9 @@ export interface DescribeLoadBasedAutoScalingResult { } export namespace DescribeLoadBasedAutoScalingResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeLoadBasedAutoScalingResult): any => ({ ...obj, }); @@ -3690,6 +3921,9 @@ export interface SelfUserProfile { } export namespace SelfUserProfile { + /** + * @internal + */ export const filterSensitiveLog = (obj: SelfUserProfile): any => ({ ...obj, }); @@ -3706,6 +3940,9 @@ export interface DescribeMyUserProfileResult { } export namespace DescribeMyUserProfileResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeMyUserProfileResult): any => ({ ...obj, }); @@ -3727,6 +3964,9 @@ export interface OperatingSystemConfigurationManager { } export namespace OperatingSystemConfigurationManager { + /** + * @internal + */ export const filterSensitiveLog = (obj: OperatingSystemConfigurationManager): any => ({ ...obj, }); @@ -3773,6 +4013,9 @@ export interface OperatingSystem { } export namespace OperatingSystem { + /** + * @internal + */ export const filterSensitiveLog = (obj: OperatingSystem): any => ({ ...obj, }); @@ -3789,6 +4032,9 @@ export interface DescribeOperatingSystemsResponse { } export namespace DescribeOperatingSystemsResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeOperatingSystemsResponse): any => ({ ...obj, }); @@ -3808,6 +4054,9 @@ export interface DescribePermissionsRequest { } export namespace DescribePermissionsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribePermissionsRequest): any => ({ ...obj, }); @@ -3875,6 +4124,9 @@ export interface Permission { } export namespace Permission { + /** + * @internal + */ export const filterSensitiveLog = (obj: Permission): any => ({ ...obj, }); @@ -3905,6 +4157,9 @@ export interface DescribePermissionsResult { } export namespace DescribePermissionsResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribePermissionsResult): any => ({ ...obj, }); @@ -3931,6 +4186,9 @@ export interface DescribeRaidArraysRequest { } export namespace DescribeRaidArraysRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeRaidArraysRequest): any => ({ ...obj, }); @@ -4007,6 +4265,9 @@ export interface RaidArray { } export namespace RaidArray { + /** + * @internal + */ export const filterSensitiveLog = (obj: RaidArray): any => ({ ...obj, }); @@ -4023,6 +4284,9 @@ export interface DescribeRaidArraysResult { } export namespace DescribeRaidArraysResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeRaidArraysResult): any => ({ ...obj, }); @@ -4041,6 +4305,9 @@ export interface DescribeRdsDbInstancesRequest { } export namespace DescribeRdsDbInstancesRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeRdsDbInstancesRequest): any => ({ ...obj, }); @@ -4099,6 +4366,9 @@ export interface RdsDbInstance { } export namespace RdsDbInstance { + /** + * @internal + */ export const filterSensitiveLog = (obj: RdsDbInstance): any => ({ ...obj, }); @@ -4115,6 +4385,9 @@ export interface DescribeRdsDbInstancesResult { } export namespace DescribeRdsDbInstancesResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeRdsDbInstancesResult): any => ({ ...obj, }); @@ -4142,6 +4415,9 @@ export interface DescribeServiceErrorsRequest { } export namespace DescribeServiceErrorsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeServiceErrorsRequest): any => ({ ...obj, }); @@ -4183,6 +4459,9 @@ export interface ServiceError { } export namespace ServiceError { + /** + * @internal + */ export const filterSensitiveLog = (obj: ServiceError): any => ({ ...obj, }); @@ -4199,6 +4478,9 @@ export interface DescribeServiceErrorsResult { } export namespace DescribeServiceErrorsResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeServiceErrorsResult): any => ({ ...obj, }); @@ -4212,6 +4494,9 @@ export interface DescribeStackProvisioningParametersRequest { } export namespace DescribeStackProvisioningParametersRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeStackProvisioningParametersRequest): any => ({ ...obj, }); @@ -4233,6 +4518,9 @@ export interface DescribeStackProvisioningParametersResult { } export namespace DescribeStackProvisioningParametersResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeStackProvisioningParametersResult): any => ({ ...obj, }); @@ -4247,6 +4535,9 @@ export interface DescribeStacksRequest { } export namespace DescribeStacksRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeStacksRequest): any => ({ ...obj, }); @@ -4380,6 +4671,9 @@ export interface Stack { } export namespace Stack { + /** + * @internal + */ export const filterSensitiveLog = (obj: Stack): any => ({ ...obj, }); @@ -4396,6 +4690,9 @@ export interface DescribeStacksResult { } export namespace DescribeStacksResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeStacksResult): any => ({ ...obj, }); @@ -4409,6 +4706,9 @@ export interface DescribeStackSummaryRequest { } export namespace DescribeStackSummaryRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeStackSummaryRequest): any => ({ ...obj, }); @@ -4520,6 +4820,9 @@ export interface InstancesCount { } export namespace InstancesCount { + /** + * @internal + */ export const filterSensitiveLog = (obj: InstancesCount): any => ({ ...obj, }); @@ -4561,6 +4864,9 @@ export interface StackSummary { } export namespace StackSummary { + /** + * @internal + */ export const filterSensitiveLog = (obj: StackSummary): any => ({ ...obj, }); @@ -4577,6 +4883,9 @@ export interface DescribeStackSummaryResult { } export namespace DescribeStackSummaryResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeStackSummaryResult): any => ({ ...obj, }); @@ -4590,6 +4899,9 @@ export interface DescribeTimeBasedAutoScalingRequest { } export namespace DescribeTimeBasedAutoScalingRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeTimeBasedAutoScalingRequest): any => ({ ...obj, }); @@ -4649,6 +4961,9 @@ export interface WeeklyAutoScalingSchedule { } export namespace WeeklyAutoScalingSchedule { + /** + * @internal + */ export const filterSensitiveLog = (obj: WeeklyAutoScalingSchedule): any => ({ ...obj, }); @@ -4670,6 +4985,9 @@ export interface TimeBasedAutoScalingConfiguration { } export namespace TimeBasedAutoScalingConfiguration { + /** + * @internal + */ export const filterSensitiveLog = (obj: TimeBasedAutoScalingConfiguration): any => ({ ...obj, }); @@ -4687,6 +5005,9 @@ export interface DescribeTimeBasedAutoScalingResult { } export namespace DescribeTimeBasedAutoScalingResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeTimeBasedAutoScalingResult): any => ({ ...obj, }); @@ -4700,6 +5021,9 @@ export interface DescribeUserProfilesRequest { } export namespace DescribeUserProfilesRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeUserProfilesRequest): any => ({ ...obj, }); @@ -4738,6 +5062,9 @@ export interface UserProfile { } export namespace UserProfile { + /** + * @internal + */ export const filterSensitiveLog = (obj: UserProfile): any => ({ ...obj, }); @@ -4754,6 +5081,9 @@ export interface DescribeUserProfilesResult { } export namespace DescribeUserProfilesResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeUserProfilesResult): any => ({ ...obj, }); @@ -4786,6 +5116,9 @@ export interface DescribeVolumesRequest { } export namespace DescribeVolumesRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeVolumesRequest): any => ({ ...obj, }); @@ -4891,6 +5224,9 @@ export interface Volume { } export namespace Volume { + /** + * @internal + */ export const filterSensitiveLog = (obj: Volume): any => ({ ...obj, }); @@ -4907,6 +5243,9 @@ export interface DescribeVolumesResult { } export namespace DescribeVolumesResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeVolumesResult): any => ({ ...obj, }); @@ -4925,6 +5264,9 @@ export interface DetachElasticLoadBalancerRequest { } export namespace DetachElasticLoadBalancerRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DetachElasticLoadBalancerRequest): any => ({ ...obj, }); @@ -4938,6 +5280,9 @@ export interface DisassociateElasticIpRequest { } export namespace DisassociateElasticIpRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DisassociateElasticIpRequest): any => ({ ...obj, }); @@ -4951,6 +5296,9 @@ export interface GetHostnameSuggestionRequest { } export namespace GetHostnameSuggestionRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetHostnameSuggestionRequest): any => ({ ...obj, }); @@ -4972,6 +5320,9 @@ export interface GetHostnameSuggestionResult { } export namespace GetHostnameSuggestionResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetHostnameSuggestionResult): any => ({ ...obj, }); @@ -4990,6 +5341,9 @@ export interface GrantAccessRequest { } export namespace GrantAccessRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GrantAccessRequest): any => ({ ...obj, }); @@ -5021,6 +5375,9 @@ export interface TemporaryCredential { } export namespace TemporaryCredential { + /** + * @internal + */ export const filterSensitiveLog = (obj: TemporaryCredential): any => ({ ...obj, }); @@ -5038,6 +5395,9 @@ export interface GrantAccessResult { } export namespace GrantAccessResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: GrantAccessResult): any => ({ ...obj, }); @@ -5060,6 +5420,9 @@ export interface InstanceIdentity { } export namespace InstanceIdentity { + /** + * @internal + */ export const filterSensitiveLog = (obj: InstanceIdentity): any => ({ ...obj, }); @@ -5085,6 +5448,9 @@ export interface ListTagsRequest { } export namespace ListTagsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListTagsRequest): any => ({ ...obj, }); @@ -5110,6 +5476,9 @@ export interface ListTagsResult { } export namespace ListTagsResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListTagsResult): any => ({ ...obj, }); @@ -5123,6 +5492,9 @@ export interface RebootInstanceRequest { } export namespace RebootInstanceRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: RebootInstanceRequest): any => ({ ...obj, }); @@ -5141,6 +5513,9 @@ export interface RegisterEcsClusterRequest { } export namespace RegisterEcsClusterRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: RegisterEcsClusterRequest): any => ({ ...obj, }); @@ -5157,6 +5532,9 @@ export interface RegisterEcsClusterResult { } export namespace RegisterEcsClusterResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: RegisterEcsClusterResult): any => ({ ...obj, }); @@ -5175,6 +5553,9 @@ export interface RegisterElasticIpRequest { } export namespace RegisterElasticIpRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: RegisterElasticIpRequest): any => ({ ...obj, }); @@ -5191,6 +5572,9 @@ export interface RegisterElasticIpResult { } export namespace RegisterElasticIpResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: RegisterElasticIpResult): any => ({ ...obj, }); @@ -5234,6 +5618,9 @@ export interface RegisterInstanceRequest { } export namespace RegisterInstanceRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: RegisterInstanceRequest): any => ({ ...obj, }); @@ -5250,6 +5637,9 @@ export interface RegisterInstanceResult { } export namespace RegisterInstanceResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: RegisterInstanceResult): any => ({ ...obj, }); @@ -5278,6 +5668,9 @@ export interface RegisterRdsDbInstanceRequest { } export namespace RegisterRdsDbInstanceRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: RegisterRdsDbInstanceRequest): any => ({ ...obj, }); @@ -5296,6 +5689,9 @@ export interface RegisterVolumeRequest { } export namespace RegisterVolumeRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: RegisterVolumeRequest): any => ({ ...obj, }); @@ -5312,6 +5708,9 @@ export interface RegisterVolumeResult { } export namespace RegisterVolumeResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: RegisterVolumeResult): any => ({ ...obj, }); @@ -5344,6 +5743,9 @@ export interface SetLoadBasedAutoScalingRequest { } export namespace SetLoadBasedAutoScalingRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: SetLoadBasedAutoScalingRequest): any => ({ ...obj, }); @@ -5405,6 +5807,9 @@ export interface SetPermissionRequest { } export namespace SetPermissionRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: SetPermissionRequest): any => ({ ...obj, }); @@ -5423,6 +5828,9 @@ export interface SetTimeBasedAutoScalingRequest { } export namespace SetTimeBasedAutoScalingRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: SetTimeBasedAutoScalingRequest): any => ({ ...obj, }); @@ -5436,6 +5844,9 @@ export interface StartInstanceRequest { } export namespace StartInstanceRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: StartInstanceRequest): any => ({ ...obj, }); @@ -5449,6 +5860,9 @@ export interface StartStackRequest { } export namespace StartStackRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: StartStackRequest): any => ({ ...obj, }); @@ -5469,6 +5883,9 @@ export interface StopInstanceRequest { } export namespace StopInstanceRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: StopInstanceRequest): any => ({ ...obj, }); @@ -5482,6 +5899,9 @@ export interface StopStackRequest { } export namespace StopStackRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: StopStackRequest): any => ({ ...obj, }); @@ -5519,6 +5939,9 @@ export interface TagResourceRequest { } export namespace TagResourceRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: TagResourceRequest): any => ({ ...obj, }); @@ -5532,6 +5955,9 @@ export interface UnassignInstanceRequest { } export namespace UnassignInstanceRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: UnassignInstanceRequest): any => ({ ...obj, }); @@ -5545,6 +5971,9 @@ export interface UnassignVolumeRequest { } export namespace UnassignVolumeRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: UnassignVolumeRequest): any => ({ ...obj, }); @@ -5563,6 +5992,9 @@ export interface UntagResourceRequest { } export namespace UntagResourceRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: UntagResourceRequest): any => ({ ...obj, }); @@ -5634,6 +6066,9 @@ export interface UpdateAppRequest { } export namespace UpdateAppRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateAppRequest): any => ({ ...obj, }); @@ -5652,6 +6087,9 @@ export interface UpdateElasticIpRequest { } export namespace UpdateElasticIpRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateElasticIpRequest): any => ({ ...obj, }); @@ -5788,6 +6226,9 @@ export interface UpdateInstanceRequest { } export namespace UpdateInstanceRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateInstanceRequest): any => ({ ...obj, }); @@ -5902,6 +6343,9 @@ export interface UpdateLayerRequest { } export namespace UpdateLayerRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateLayerRequest): any => ({ ...obj, }); @@ -5915,6 +6359,9 @@ export interface UpdateMyUserProfileRequest { } export namespace UpdateMyUserProfileRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateMyUserProfileRequest): any => ({ ...obj, }); @@ -5938,6 +6385,9 @@ export interface UpdateRdsDbInstanceRequest { } export namespace UpdateRdsDbInstanceRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateRdsDbInstanceRequest): any => ({ ...obj, }); @@ -6187,6 +6637,9 @@ export interface UpdateStackRequest { } export namespace UpdateStackRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateStackRequest): any => ({ ...obj, }); @@ -6220,6 +6673,9 @@ export interface UpdateUserProfileRequest { } export namespace UpdateUserProfileRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateUserProfileRequest): any => ({ ...obj, }); @@ -6243,6 +6699,9 @@ export interface UpdateVolumeRequest { } export namespace UpdateVolumeRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateVolumeRequest): any => ({ ...obj, }); diff --git a/clients/client-opsworkscm/commands/AssociateNodeCommand.ts b/clients/client-opsworkscm/commands/AssociateNodeCommand.ts index 71a43fd2dc8c..790a12a6cf31 100644 --- a/clients/client-opsworkscm/commands/AssociateNodeCommand.ts +++ b/clients/client-opsworkscm/commands/AssociateNodeCommand.ts @@ -38,6 +38,20 @@ export interface AssociateNodeCommandOutput extends AssociateNodeResponse, __Met * 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. *

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { OpsWorksCMClient, AssociateNodeCommand } from "@aws-sdk/client-opsworkscm"; // ES Modules import + * // const { OpsWorksCMClient, AssociateNodeCommand } = require("@aws-sdk/client-opsworkscm"); // CommonJS import + * const client = new OpsWorksCMClient(config); + * const command = new AssociateNodeCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link AssociateNodeCommandInput} for command's `input` shape. + * @see {@link AssociateNodeCommandOutput} for command's `response` shape. + * @see {@link OpsWorksCMClientResolvedConfig | config} for command's `input` shape. + * */ export class AssociateNodeCommand extends $Command< AssociateNodeCommandInput, diff --git a/clients/client-opsworkscm/commands/CreateBackupCommand.ts b/clients/client-opsworkscm/commands/CreateBackupCommand.ts index ea8740df7fe9..4208c28fb04c 100644 --- a/clients/client-opsworkscm/commands/CreateBackupCommand.ts +++ b/clients/client-opsworkscm/commands/CreateBackupCommand.ts @@ -39,6 +39,20 @@ export interface CreateBackupCommandOutput extends CreateBackupResponse, __Metad * A ResourceNotFoundException is thrown when the server is not found. * A ValidationException is thrown when parameters of the request are not valid. *

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { OpsWorksCMClient, CreateBackupCommand } from "@aws-sdk/client-opsworkscm"; // ES Modules import + * // const { OpsWorksCMClient, CreateBackupCommand } = require("@aws-sdk/client-opsworkscm"); // CommonJS import + * const client = new OpsWorksCMClient(config); + * const command = new CreateBackupCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreateBackupCommandInput} for command's `input` shape. + * @see {@link CreateBackupCommandOutput} for command's `response` shape. + * @see {@link OpsWorksCMClientResolvedConfig | config} for command's `input` shape. + * */ export class CreateBackupCommand extends $Command< CreateBackupCommandInput, diff --git a/clients/client-opsworkscm/commands/CreateServerCommand.ts b/clients/client-opsworkscm/commands/CreateServerCommand.ts index cd50b902354c..9736da0f7bba 100644 --- a/clients/client-opsworkscm/commands/CreateServerCommand.ts +++ b/clients/client-opsworkscm/commands/CreateServerCommand.ts @@ -49,6 +49,20 @@ export interface CreateServerCommandOutput extends CreateServerResponse, __Metad *

*

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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { OpsWorksCMClient, CreateServerCommand } from "@aws-sdk/client-opsworkscm"; // ES Modules import + * // const { OpsWorksCMClient, CreateServerCommand } = require("@aws-sdk/client-opsworkscm"); // CommonJS import + * const client = new OpsWorksCMClient(config); + * const command = new CreateServerCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreateServerCommandInput} for command's `input` shape. + * @see {@link CreateServerCommandOutput} for command's `response` shape. + * @see {@link OpsWorksCMClientResolvedConfig | config} for command's `input` shape. + * */ export class CreateServerCommand extends $Command< CreateServerCommandInput, diff --git a/clients/client-opsworkscm/commands/DeleteBackupCommand.ts b/clients/client-opsworkscm/commands/DeleteBackupCommand.ts index fc4aa89fb3a8..b2164c9bb372 100644 --- a/clients/client-opsworkscm/commands/DeleteBackupCommand.ts +++ b/clients/client-opsworkscm/commands/DeleteBackupCommand.ts @@ -29,6 +29,20 @@ export interface DeleteBackupCommandOutput extends DeleteBackupResponse, __Metad * A ResourceNotFoundException is thrown when the backup does not exist. * A ValidationException is thrown when parameters of the request are not valid. *

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { OpsWorksCMClient, DeleteBackupCommand } from "@aws-sdk/client-opsworkscm"; // ES Modules import + * // const { OpsWorksCMClient, DeleteBackupCommand } = require("@aws-sdk/client-opsworkscm"); // CommonJS import + * const client = new OpsWorksCMClient(config); + * const command = new DeleteBackupCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteBackupCommandInput} for command's `input` shape. + * @see {@link DeleteBackupCommandOutput} for command's `response` shape. + * @see {@link OpsWorksCMClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteBackupCommand extends $Command< DeleteBackupCommandInput, diff --git a/clients/client-opsworkscm/commands/DeleteServerCommand.ts b/clients/client-opsworkscm/commands/DeleteServerCommand.ts index 7c6055926f4f..079201cb6e30 100644 --- a/clients/client-opsworkscm/commands/DeleteServerCommand.ts +++ b/clients/client-opsworkscm/commands/DeleteServerCommand.ts @@ -37,6 +37,20 @@ export interface DeleteServerCommandOutput extends DeleteServerResponse, __Metad *

*

*

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { OpsWorksCMClient, DeleteServerCommand } from "@aws-sdk/client-opsworkscm"; // ES Modules import + * // const { OpsWorksCMClient, DeleteServerCommand } = require("@aws-sdk/client-opsworkscm"); // CommonJS import + * const client = new OpsWorksCMClient(config); + * const command = new DeleteServerCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteServerCommandInput} for command's `input` shape. + * @see {@link DeleteServerCommandOutput} for command's `response` shape. + * @see {@link OpsWorksCMClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteServerCommand extends $Command< DeleteServerCommandInput, diff --git a/clients/client-opsworkscm/commands/DescribeAccountAttributesCommand.ts b/clients/client-opsworkscm/commands/DescribeAccountAttributesCommand.ts index a0ef43e600d3..9077cfd7a315 100644 --- a/clients/client-opsworkscm/commands/DescribeAccountAttributesCommand.ts +++ b/clients/client-opsworkscm/commands/DescribeAccountAttributesCommand.ts @@ -27,6 +27,20 @@ export interface DescribeAccountAttributesCommandOutput extends DescribeAccountA *

* This operation is synchronous. *

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { OpsWorksCMClient, DescribeAccountAttributesCommand } from "@aws-sdk/client-opsworkscm"; // ES Modules import + * // const { OpsWorksCMClient, DescribeAccountAttributesCommand } = require("@aws-sdk/client-opsworkscm"); // CommonJS import + * const client = new OpsWorksCMClient(config); + * const command = new DescribeAccountAttributesCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeAccountAttributesCommandInput} for command's `input` shape. + * @see {@link DescribeAccountAttributesCommandOutput} for command's `response` shape. + * @see {@link OpsWorksCMClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeAccountAttributesCommand extends $Command< DescribeAccountAttributesCommandInput, diff --git a/clients/client-opsworkscm/commands/DescribeBackupsCommand.ts b/clients/client-opsworkscm/commands/DescribeBackupsCommand.ts index 9fb7adc4c625..bd1be8d9d84c 100644 --- a/clients/client-opsworkscm/commands/DescribeBackupsCommand.ts +++ b/clients/client-opsworkscm/commands/DescribeBackupsCommand.ts @@ -32,6 +32,20 @@ export interface DescribeBackupsCommandOutput extends DescribeBackupsResponse, _ * A ResourceNotFoundException is thrown when the backup does not exist. * A ValidationException is raised when parameters of the request are not valid. *

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { OpsWorksCMClient, DescribeBackupsCommand } from "@aws-sdk/client-opsworkscm"; // ES Modules import + * // const { OpsWorksCMClient, DescribeBackupsCommand } = require("@aws-sdk/client-opsworkscm"); // CommonJS import + * const client = new OpsWorksCMClient(config); + * const command = new DescribeBackupsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeBackupsCommandInput} for command's `input` shape. + * @see {@link DescribeBackupsCommandOutput} for command's `response` shape. + * @see {@link OpsWorksCMClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeBackupsCommand extends $Command< DescribeBackupsCommandInput, diff --git a/clients/client-opsworkscm/commands/DescribeEventsCommand.ts b/clients/client-opsworkscm/commands/DescribeEventsCommand.ts index af28a7eba53e..26d0d739b6fc 100644 --- a/clients/client-opsworkscm/commands/DescribeEventsCommand.ts +++ b/clients/client-opsworkscm/commands/DescribeEventsCommand.ts @@ -31,6 +31,20 @@ export interface DescribeEventsCommandOutput extends DescribeEventsResponse, __M * A ResourceNotFoundException is thrown when the server does not exist. * A ValidationException is raised when parameters of the request are not valid. *

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { OpsWorksCMClient, DescribeEventsCommand } from "@aws-sdk/client-opsworkscm"; // ES Modules import + * // const { OpsWorksCMClient, DescribeEventsCommand } = require("@aws-sdk/client-opsworkscm"); // CommonJS import + * const client = new OpsWorksCMClient(config); + * const command = new DescribeEventsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeEventsCommandInput} for command's `input` shape. + * @see {@link DescribeEventsCommandOutput} for command's `response` shape. + * @see {@link OpsWorksCMClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeEventsCommand extends $Command< DescribeEventsCommandInput, diff --git a/clients/client-opsworkscm/commands/DescribeNodeAssociationStatusCommand.ts b/clients/client-opsworkscm/commands/DescribeNodeAssociationStatusCommand.ts index 78f27f6c3340..a33ccd089d0f 100644 --- a/clients/client-opsworkscm/commands/DescribeNodeAssociationStatusCommand.ts +++ b/clients/client-opsworkscm/commands/DescribeNodeAssociationStatusCommand.ts @@ -30,6 +30,20 @@ export interface DescribeNodeAssociationStatusCommandOutput * 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. *

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { OpsWorksCMClient, DescribeNodeAssociationStatusCommand } from "@aws-sdk/client-opsworkscm"; // ES Modules import + * // const { OpsWorksCMClient, DescribeNodeAssociationStatusCommand } = require("@aws-sdk/client-opsworkscm"); // CommonJS import + * const client = new OpsWorksCMClient(config); + * const command = new DescribeNodeAssociationStatusCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeNodeAssociationStatusCommandInput} for command's `input` shape. + * @see {@link DescribeNodeAssociationStatusCommandOutput} for command's `response` shape. + * @see {@link OpsWorksCMClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeNodeAssociationStatusCommand extends $Command< DescribeNodeAssociationStatusCommandInput, diff --git a/clients/client-opsworkscm/commands/DescribeServersCommand.ts b/clients/client-opsworkscm/commands/DescribeServersCommand.ts index 82559f5e976e..a8e475b94b0f 100644 --- a/clients/client-opsworkscm/commands/DescribeServersCommand.ts +++ b/clients/client-opsworkscm/commands/DescribeServersCommand.ts @@ -33,6 +33,20 @@ export interface DescribeServersCommandOutput extends DescribeServersResponse, _ * A ResourceNotFoundException is thrown when the server does not exist. * A ValidationException is raised when parameters of the request are not valid. *

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { OpsWorksCMClient, DescribeServersCommand } from "@aws-sdk/client-opsworkscm"; // ES Modules import + * // const { OpsWorksCMClient, DescribeServersCommand } = require("@aws-sdk/client-opsworkscm"); // CommonJS import + * const client = new OpsWorksCMClient(config); + * const command = new DescribeServersCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeServersCommandInput} for command's `input` shape. + * @see {@link DescribeServersCommandOutput} for command's `response` shape. + * @see {@link OpsWorksCMClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeServersCommand extends $Command< DescribeServersCommandInput, diff --git a/clients/client-opsworkscm/commands/DisassociateNodeCommand.ts b/clients/client-opsworkscm/commands/DisassociateNodeCommand.ts index e8779d42a483..22950b67f7d4 100644 --- a/clients/client-opsworkscm/commands/DisassociateNodeCommand.ts +++ b/clients/client-opsworkscm/commands/DisassociateNodeCommand.ts @@ -29,6 +29,20 @@ export interface DisassociateNodeCommandOutput extends DisassociateNodeResponse, * A ResourceNotFoundException is thrown when the server does not exist. * A ValidationException is raised when parameters of the request are not valid. *

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { OpsWorksCMClient, DisassociateNodeCommand } from "@aws-sdk/client-opsworkscm"; // ES Modules import + * // const { OpsWorksCMClient, DisassociateNodeCommand } = require("@aws-sdk/client-opsworkscm"); // CommonJS import + * const client = new OpsWorksCMClient(config); + * const command = new DisassociateNodeCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DisassociateNodeCommandInput} for command's `input` shape. + * @see {@link DisassociateNodeCommandOutput} for command's `response` shape. + * @see {@link OpsWorksCMClientResolvedConfig | config} for command's `input` shape. + * */ export class DisassociateNodeCommand extends $Command< DisassociateNodeCommandInput, diff --git a/clients/client-opsworkscm/commands/ExportServerEngineAttributeCommand.ts b/clients/client-opsworkscm/commands/ExportServerEngineAttributeCommand.ts index ba8fb89187d2..58314dd522c0 100644 --- a/clients/client-opsworkscm/commands/ExportServerEngineAttributeCommand.ts +++ b/clients/client-opsworkscm/commands/ExportServerEngineAttributeCommand.ts @@ -35,6 +35,20 @@ export interface ExportServerEngineAttributeCommandOutput * An InvalidStateException is thrown when the server is in any of the following states: CREATING, TERMINATED, * FAILED or DELETING. *

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { OpsWorksCMClient, ExportServerEngineAttributeCommand } from "@aws-sdk/client-opsworkscm"; // ES Modules import + * // const { OpsWorksCMClient, ExportServerEngineAttributeCommand } = require("@aws-sdk/client-opsworkscm"); // CommonJS import + * const client = new OpsWorksCMClient(config); + * const command = new ExportServerEngineAttributeCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ExportServerEngineAttributeCommandInput} for command's `input` shape. + * @see {@link ExportServerEngineAttributeCommandOutput} for command's `response` shape. + * @see {@link OpsWorksCMClientResolvedConfig | config} for command's `input` shape. + * */ export class ExportServerEngineAttributeCommand extends $Command< ExportServerEngineAttributeCommandInput, diff --git a/clients/client-opsworkscm/commands/ListTagsForResourceCommand.ts b/clients/client-opsworkscm/commands/ListTagsForResourceCommand.ts index 5bb678848284..d486d8f33652 100644 --- a/clients/client-opsworkscm/commands/ListTagsForResourceCommand.ts +++ b/clients/client-opsworkscm/commands/ListTagsForResourceCommand.ts @@ -23,6 +23,20 @@ export interface ListTagsForResourceCommandOutput extends ListTagsForResourceRes /** *

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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { OpsWorksCMClient, ListTagsForResourceCommand } from "@aws-sdk/client-opsworkscm"; // ES Modules import + * // const { OpsWorksCMClient, ListTagsForResourceCommand } = require("@aws-sdk/client-opsworkscm"); // CommonJS import + * const client = new OpsWorksCMClient(config); + * const command = new ListTagsForResourceCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListTagsForResourceCommandInput} for command's `input` shape. + * @see {@link ListTagsForResourceCommandOutput} for command's `response` shape. + * @see {@link OpsWorksCMClientResolvedConfig | config} for command's `input` shape. + * */ export class ListTagsForResourceCommand extends $Command< ListTagsForResourceCommandInput, diff --git a/clients/client-opsworkscm/commands/RestoreServerCommand.ts b/clients/client-opsworkscm/commands/RestoreServerCommand.ts index ed68a4e51e24..6c17c386e592 100644 --- a/clients/client-opsworkscm/commands/RestoreServerCommand.ts +++ b/clients/client-opsworkscm/commands/RestoreServerCommand.ts @@ -36,6 +36,20 @@ export interface RestoreServerCommandOutput extends RestoreServerResponse, __Met * 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. *

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { OpsWorksCMClient, RestoreServerCommand } from "@aws-sdk/client-opsworkscm"; // ES Modules import + * // const { OpsWorksCMClient, RestoreServerCommand } = require("@aws-sdk/client-opsworkscm"); // CommonJS import + * const client = new OpsWorksCMClient(config); + * const command = new RestoreServerCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link RestoreServerCommandInput} for command's `input` shape. + * @see {@link RestoreServerCommandOutput} for command's `response` shape. + * @see {@link OpsWorksCMClientResolvedConfig | config} for command's `input` shape. + * */ export class RestoreServerCommand extends $Command< RestoreServerCommandInput, diff --git a/clients/client-opsworkscm/commands/StartMaintenanceCommand.ts b/clients/client-opsworkscm/commands/StartMaintenanceCommand.ts index ed4037bca029..81c8a4ecbd47 100644 --- a/clients/client-opsworkscm/commands/StartMaintenanceCommand.ts +++ b/clients/client-opsworkscm/commands/StartMaintenanceCommand.ts @@ -29,6 +29,20 @@ export interface StartMaintenanceCommandOutput extends StartMaintenanceResponse, * 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. *

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { OpsWorksCMClient, StartMaintenanceCommand } from "@aws-sdk/client-opsworkscm"; // ES Modules import + * // const { OpsWorksCMClient, StartMaintenanceCommand } = require("@aws-sdk/client-opsworkscm"); // CommonJS import + * const client = new OpsWorksCMClient(config); + * const command = new StartMaintenanceCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link StartMaintenanceCommandInput} for command's `input` shape. + * @see {@link StartMaintenanceCommandOutput} for command's `response` shape. + * @see {@link OpsWorksCMClientResolvedConfig | config} for command's `input` shape. + * */ export class StartMaintenanceCommand extends $Command< StartMaintenanceCommandInput, diff --git a/clients/client-opsworkscm/commands/TagResourceCommand.ts b/clients/client-opsworkscm/commands/TagResourceCommand.ts index 419f54d1d694..769d346928d5 100644 --- a/clients/client-opsworkscm/commands/TagResourceCommand.ts +++ b/clients/client-opsworkscm/commands/TagResourceCommand.ts @@ -22,6 +22,20 @@ export interface TagResourceCommandOutput extends TagResourceResponse, __Metadat /** *

Applies tags to an AWS OpsWorks for Chef Automate or AWS OpsWorks for Puppet Enterprise server, or to server backups.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { OpsWorksCMClient, TagResourceCommand } from "@aws-sdk/client-opsworkscm"; // ES Modules import + * // const { OpsWorksCMClient, TagResourceCommand } = require("@aws-sdk/client-opsworkscm"); // CommonJS import + * const client = new OpsWorksCMClient(config); + * const command = new TagResourceCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link TagResourceCommandInput} for command's `input` shape. + * @see {@link TagResourceCommandOutput} for command's `response` shape. + * @see {@link OpsWorksCMClientResolvedConfig | config} for command's `input` shape. + * */ export class TagResourceCommand extends $Command< TagResourceCommandInput, diff --git a/clients/client-opsworkscm/commands/UntagResourceCommand.ts b/clients/client-opsworkscm/commands/UntagResourceCommand.ts index e9f184de9544..5b2da2609ea5 100644 --- a/clients/client-opsworkscm/commands/UntagResourceCommand.ts +++ b/clients/client-opsworkscm/commands/UntagResourceCommand.ts @@ -22,6 +22,20 @@ export interface UntagResourceCommandOutput extends UntagResourceResponse, __Met /** *

Removes specified tags from an AWS OpsWorks-CM server or backup.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { OpsWorksCMClient, UntagResourceCommand } from "@aws-sdk/client-opsworkscm"; // ES Modules import + * // const { OpsWorksCMClient, UntagResourceCommand } = require("@aws-sdk/client-opsworkscm"); // CommonJS import + * const client = new OpsWorksCMClient(config); + * const command = new UntagResourceCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link UntagResourceCommandInput} for command's `input` shape. + * @see {@link UntagResourceCommandOutput} for command's `response` shape. + * @see {@link OpsWorksCMClientResolvedConfig | config} for command's `input` shape. + * */ export class UntagResourceCommand extends $Command< UntagResourceCommandInput, diff --git a/clients/client-opsworkscm/commands/UpdateServerCommand.ts b/clients/client-opsworkscm/commands/UpdateServerCommand.ts index 392599aa480c..28dc9798d159 100644 --- a/clients/client-opsworkscm/commands/UpdateServerCommand.ts +++ b/clients/client-opsworkscm/commands/UpdateServerCommand.ts @@ -27,6 +27,20 @@ export interface UpdateServerCommandOutput extends UpdateServerResponse, __Metad *

* This operation is synchronous. *

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { OpsWorksCMClient, UpdateServerCommand } from "@aws-sdk/client-opsworkscm"; // ES Modules import + * // const { OpsWorksCMClient, UpdateServerCommand } = require("@aws-sdk/client-opsworkscm"); // CommonJS import + * const client = new OpsWorksCMClient(config); + * const command = new UpdateServerCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link UpdateServerCommandInput} for command's `input` shape. + * @see {@link UpdateServerCommandOutput} for command's `response` shape. + * @see {@link OpsWorksCMClientResolvedConfig | config} for command's `input` shape. + * */ export class UpdateServerCommand extends $Command< UpdateServerCommandInput, diff --git a/clients/client-opsworkscm/commands/UpdateServerEngineAttributesCommand.ts b/clients/client-opsworkscm/commands/UpdateServerEngineAttributesCommand.ts index 2faeab9c5a0f..c34e8446dcb3 100644 --- a/clients/client-opsworkscm/commands/UpdateServerEngineAttributesCommand.ts +++ b/clients/client-opsworkscm/commands/UpdateServerEngineAttributesCommand.ts @@ -37,6 +37,20 @@ export interface UpdateServerEngineAttributesCommandOutput * 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. *

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { OpsWorksCMClient, UpdateServerEngineAttributesCommand } from "@aws-sdk/client-opsworkscm"; // ES Modules import + * // const { OpsWorksCMClient, UpdateServerEngineAttributesCommand } = require("@aws-sdk/client-opsworkscm"); // CommonJS import + * const client = new OpsWorksCMClient(config); + * const command = new UpdateServerEngineAttributesCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link UpdateServerEngineAttributesCommandInput} for command's `input` shape. + * @see {@link UpdateServerEngineAttributesCommandOutput} for command's `response` shape. + * @see {@link OpsWorksCMClientResolvedConfig | config} for command's `input` shape. + * */ export class UpdateServerEngineAttributesCommand extends $Command< UpdateServerEngineAttributesCommandInput, diff --git a/clients/client-opsworkscm/models/models_0.ts b/clients/client-opsworkscm/models/models_0.ts index d4c650a80d9f..4a8c8ae7a5d6 100644 --- a/clients/client-opsworkscm/models/models_0.ts +++ b/clients/client-opsworkscm/models/models_0.ts @@ -42,6 +42,9 @@ export interface AccountAttribute { } export namespace AccountAttribute { + /** + * @internal + */ export const filterSensitiveLog = (obj: AccountAttribute): any => ({ ...obj, }); @@ -66,6 +69,9 @@ export interface EngineAttribute { } export namespace EngineAttribute { + /** + * @internal + */ export const filterSensitiveLog = (obj: EngineAttribute): any => ({ ...obj, ...(obj.Value && { Value: SENSITIVE_STRING }), @@ -120,6 +126,9 @@ export interface AssociateNodeRequest { } export namespace AssociateNodeRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: AssociateNodeRequest): any => ({ ...obj, ...(obj.EngineAttributes && { @@ -137,6 +146,9 @@ export interface AssociateNodeResponse { } export namespace AssociateNodeResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: AssociateNodeResponse): any => ({ ...obj, }); @@ -158,6 +170,9 @@ export interface InvalidStateException extends __SmithyException, $MetadataBeare } export namespace InvalidStateException { + /** + * @internal + */ export const filterSensitiveLog = (obj: InvalidStateException): any => ({ ...obj, }); @@ -178,6 +193,9 @@ export interface ResourceNotFoundException extends __SmithyException, $MetadataB } export namespace ResourceNotFoundException { + /** + * @internal + */ export const filterSensitiveLog = (obj: ResourceNotFoundException): any => ({ ...obj, }); @@ -198,6 +216,9 @@ export interface ValidationException extends __SmithyException, $MetadataBearer } export namespace ValidationException { + /** + * @internal + */ export const filterSensitiveLog = (obj: ValidationException): any => ({ ...obj, }); @@ -393,6 +414,9 @@ export interface Backup { } export namespace Backup { + /** + * @internal + */ export const filterSensitiveLog = (obj: Backup): any => ({ ...obj, }); @@ -420,6 +444,9 @@ export interface Tag { } export namespace Tag { + /** + * @internal + */ export const filterSensitiveLog = (obj: Tag): any => ({ ...obj, }); @@ -465,6 +492,9 @@ export interface CreateBackupRequest { } export namespace CreateBackupRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateBackupRequest): any => ({ ...obj, }); @@ -478,6 +508,9 @@ export interface CreateBackupResponse { } export namespace CreateBackupResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateBackupResponse): any => ({ ...obj, }); @@ -498,6 +531,9 @@ export interface LimitExceededException extends __SmithyException, $MetadataBear } export namespace LimitExceededException { + /** + * @internal + */ export const filterSensitiveLog = (obj: LimitExceededException): any => ({ ...obj, }); @@ -777,6 +813,9 @@ export interface CreateServerRequest { } export namespace CreateServerRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateServerRequest): any => ({ ...obj, ...(obj.CustomPrivateKey && { CustomPrivateKey: SENSITIVE_STRING }), @@ -1005,6 +1044,9 @@ export interface Server { } export namespace Server { + /** + * @internal + */ export const filterSensitiveLog = (obj: Server): any => ({ ...obj, ...(obj.EngineAttributes && { @@ -1022,6 +1064,9 @@ export interface CreateServerResponse { } export namespace CreateServerResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateServerResponse): any => ({ ...obj, ...(obj.Server && { Server: Server.filterSensitiveLog(obj.Server) }), @@ -1043,6 +1088,9 @@ export interface ResourceAlreadyExistsException extends __SmithyException, $Meta } export namespace ResourceAlreadyExistsException { + /** + * @internal + */ export const filterSensitiveLog = (obj: ResourceAlreadyExistsException): any => ({ ...obj, }); @@ -1058,6 +1106,9 @@ export interface DeleteBackupRequest { } export namespace DeleteBackupRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteBackupRequest): any => ({ ...obj, }); @@ -1066,6 +1117,9 @@ export namespace DeleteBackupRequest { export interface DeleteBackupResponse {} export namespace DeleteBackupResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteBackupResponse): any => ({ ...obj, }); @@ -1079,6 +1133,9 @@ export interface DeleteServerRequest { } export namespace DeleteServerRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteServerRequest): any => ({ ...obj, }); @@ -1087,6 +1144,9 @@ export namespace DeleteServerRequest { export interface DeleteServerResponse {} export namespace DeleteServerResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteServerResponse): any => ({ ...obj, }); @@ -1095,6 +1155,9 @@ export namespace DeleteServerResponse { export interface DescribeAccountAttributesRequest {} export namespace DescribeAccountAttributesRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeAccountAttributesRequest): any => ({ ...obj, }); @@ -1110,6 +1173,9 @@ export interface DescribeAccountAttributesResponse { } export namespace DescribeAccountAttributesResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeAccountAttributesResponse): any => ({ ...obj, }); @@ -1140,6 +1206,9 @@ export interface DescribeBackupsRequest { } export namespace DescribeBackupsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeBackupsRequest): any => ({ ...obj, }); @@ -1159,6 +1228,9 @@ export interface DescribeBackupsResponse { } export namespace DescribeBackupsResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeBackupsResponse): any => ({ ...obj, }); @@ -1179,6 +1251,9 @@ export interface InvalidNextTokenException extends __SmithyException, $MetadataB } export namespace InvalidNextTokenException { + /** + * @internal + */ export const filterSensitiveLog = (obj: InvalidNextTokenException): any => ({ ...obj, }); @@ -1213,6 +1288,9 @@ export interface DescribeEventsRequest { } export namespace DescribeEventsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeEventsRequest): any => ({ ...obj, }); @@ -1247,6 +1325,9 @@ export interface ServerEvent { } export namespace ServerEvent { + /** + * @internal + */ export const filterSensitiveLog = (obj: ServerEvent): any => ({ ...obj, }); @@ -1273,6 +1354,9 @@ export interface DescribeEventsResponse { } export namespace DescribeEventsResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeEventsResponse): any => ({ ...obj, }); @@ -1293,6 +1377,9 @@ export interface DescribeNodeAssociationStatusRequest { } export namespace DescribeNodeAssociationStatusRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeNodeAssociationStatusRequest): any => ({ ...obj, }); @@ -1340,6 +1427,9 @@ export interface DescribeNodeAssociationStatusResponse { } export namespace DescribeNodeAssociationStatusResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeNodeAssociationStatusResponse): any => ({ ...obj, ...(obj.EngineAttributes && { @@ -1368,6 +1458,9 @@ export interface DescribeServersRequest { } export namespace DescribeServersRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeServersRequest): any => ({ ...obj, }); @@ -1396,6 +1489,9 @@ export interface DescribeServersResponse { } export namespace DescribeServersResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeServersResponse): any => ({ ...obj, }); @@ -1434,6 +1530,9 @@ export interface DisassociateNodeRequest { } export namespace DisassociateNodeRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DisassociateNodeRequest): any => ({ ...obj, ...(obj.EngineAttributes && { @@ -1453,6 +1552,9 @@ export interface DisassociateNodeResponse { } export namespace DisassociateNodeResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DisassociateNodeResponse): any => ({ ...obj, }); @@ -1502,6 +1604,9 @@ export interface ExportServerEngineAttributeRequest { } export namespace ExportServerEngineAttributeRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ExportServerEngineAttributeRequest): any => ({ ...obj, ...(obj.InputAttributes && { @@ -1523,6 +1628,9 @@ export interface ExportServerEngineAttributeResponse { } export namespace ExportServerEngineAttributeResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ExportServerEngineAttributeResponse): any => ({ ...obj, ...(obj.EngineAttribute && { EngineAttribute: EngineAttribute.filterSensitiveLog(obj.EngineAttribute) }), @@ -1557,6 +1665,9 @@ export interface ListTagsForResourceRequest { } export namespace ListTagsForResourceRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListTagsForResourceRequest): any => ({ ...obj, }); @@ -1575,6 +1686,9 @@ export interface ListTagsForResourceResponse { } export namespace ListTagsForResourceResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListTagsForResourceResponse): any => ({ ...obj, }); @@ -1610,6 +1724,9 @@ export interface RestoreServerRequest { } export namespace RestoreServerRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: RestoreServerRequest): any => ({ ...obj, }); @@ -1618,6 +1735,9 @@ export namespace RestoreServerRequest { export interface RestoreServerResponse {} export namespace RestoreServerResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: RestoreServerResponse): any => ({ ...obj, }); @@ -1649,6 +1769,9 @@ export interface StartMaintenanceRequest { } export namespace StartMaintenanceRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: StartMaintenanceRequest): any => ({ ...obj, ...(obj.EngineAttributes && { @@ -1666,6 +1789,9 @@ export interface StartMaintenanceResponse { } export namespace StartMaintenanceResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: StartMaintenanceResponse): any => ({ ...obj, ...(obj.Server && { Server: Server.filterSensitiveLog(obj.Server) }), @@ -1705,6 +1831,9 @@ export interface TagResourceRequest { } export namespace TagResourceRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: TagResourceRequest): any => ({ ...obj, }); @@ -1713,6 +1842,9 @@ export namespace TagResourceRequest { export interface TagResourceResponse {} export namespace TagResourceResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: TagResourceResponse): any => ({ ...obj, }); @@ -1732,6 +1864,9 @@ export interface UntagResourceRequest { } export namespace UntagResourceRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: UntagResourceRequest): any => ({ ...obj, }); @@ -1740,6 +1875,9 @@ export namespace UntagResourceRequest { export interface UntagResourceResponse {} export namespace UntagResourceResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: UntagResourceResponse): any => ({ ...obj, }); @@ -1788,6 +1926,9 @@ export interface UpdateServerRequest { } export namespace UpdateServerRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateServerRequest): any => ({ ...obj, }); @@ -1802,6 +1943,9 @@ export interface UpdateServerResponse { } export namespace UpdateServerResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateServerResponse): any => ({ ...obj, ...(obj.Server && { Server: Server.filterSensitiveLog(obj.Server) }), @@ -1829,6 +1973,9 @@ export interface UpdateServerEngineAttributesRequest { } export namespace UpdateServerEngineAttributesRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateServerEngineAttributesRequest): any => ({ ...obj, }); @@ -1843,6 +1990,9 @@ export interface UpdateServerEngineAttributesResponse { } export namespace UpdateServerEngineAttributesResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateServerEngineAttributesResponse): any => ({ ...obj, ...(obj.Server && { Server: Server.filterSensitiveLog(obj.Server) }), diff --git a/clients/client-organizations/commands/AcceptHandshakeCommand.ts b/clients/client-organizations/commands/AcceptHandshakeCommand.ts index 0bec3e318c4e..b21be0e41f33 100644 --- a/clients/client-organizations/commands/AcceptHandshakeCommand.ts +++ b/clients/client-organizations/commands/AcceptHandshakeCommand.ts @@ -51,6 +51,20 @@ export interface AcceptHandshakeCommandOutput extends AcceptHandshakeResponse, _ * *

After you accept a handshake, it continues to appear in the results of relevant APIs * for only 30 days. After that, it's deleted.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { OrganizationsClient, AcceptHandshakeCommand } from "@aws-sdk/client-organizations"; // ES Modules import + * // const { OrganizationsClient, AcceptHandshakeCommand } = require("@aws-sdk/client-organizations"); // CommonJS import + * const client = new OrganizationsClient(config); + * const command = new AcceptHandshakeCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link AcceptHandshakeCommandInput} for command's `input` shape. + * @see {@link AcceptHandshakeCommandOutput} for command's `response` shape. + * @see {@link OrganizationsClientResolvedConfig | config} for command's `input` shape. + * */ export class AcceptHandshakeCommand extends $Command< AcceptHandshakeCommandInput, diff --git a/clients/client-organizations/commands/AttachPolicyCommand.ts b/clients/client-organizations/commands/AttachPolicyCommand.ts index 0080a0af5ce3..5f287e012a9b 100644 --- a/clients/client-organizations/commands/AttachPolicyCommand.ts +++ b/clients/client-organizations/commands/AttachPolicyCommand.ts @@ -47,6 +47,20 @@ export interface AttachPolicyCommandOutput extends __MetadataBearer {} * * *

This operation can be called only from the organization's management account.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { OrganizationsClient, AttachPolicyCommand } from "@aws-sdk/client-organizations"; // ES Modules import + * // const { OrganizationsClient, AttachPolicyCommand } = require("@aws-sdk/client-organizations"); // CommonJS import + * const client = new OrganizationsClient(config); + * const command = new AttachPolicyCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link AttachPolicyCommandInput} for command's `input` shape. + * @see {@link AttachPolicyCommandOutput} for command's `response` shape. + * @see {@link OrganizationsClientResolvedConfig | config} for command's `input` shape. + * */ export class AttachPolicyCommand extends $Command< AttachPolicyCommandInput, diff --git a/clients/client-organizations/commands/CancelHandshakeCommand.ts b/clients/client-organizations/commands/CancelHandshakeCommand.ts index 1ab6f091be56..89ebda709d39 100644 --- a/clients/client-organizations/commands/CancelHandshakeCommand.ts +++ b/clients/client-organizations/commands/CancelHandshakeCommand.ts @@ -27,6 +27,20 @@ export interface CancelHandshakeCommandOutput extends CancelHandshakeResponse, _ * 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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { OrganizationsClient, CancelHandshakeCommand } from "@aws-sdk/client-organizations"; // ES Modules import + * // const { OrganizationsClient, CancelHandshakeCommand } = require("@aws-sdk/client-organizations"); // CommonJS import + * const client = new OrganizationsClient(config); + * const command = new CancelHandshakeCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CancelHandshakeCommandInput} for command's `input` shape. + * @see {@link CancelHandshakeCommandOutput} for command's `response` shape. + * @see {@link OrganizationsClientResolvedConfig | config} for command's `input` shape. + * */ export class CancelHandshakeCommand extends $Command< CancelHandshakeCommandInput, diff --git a/clients/client-organizations/commands/CreateAccountCommand.ts b/clients/client-organizations/commands/CreateAccountCommand.ts index 94f4247660fd..350f7a05fef0 100644 --- a/clients/client-organizations/commands/CreateAccountCommand.ts +++ b/clients/client-organizations/commands/CreateAccountCommand.ts @@ -99,6 +99,20 @@ export interface CreateAccountCommandOutput extends CreateAccountResponse, __Met * Granting * Access to Your Billing Information and Tools.

* + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { OrganizationsClient, CreateAccountCommand } from "@aws-sdk/client-organizations"; // ES Modules import + * // const { OrganizationsClient, CreateAccountCommand } = require("@aws-sdk/client-organizations"); // CommonJS import + * const client = new OrganizationsClient(config); + * const command = new CreateAccountCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreateAccountCommandInput} for command's `input` shape. + * @see {@link CreateAccountCommandOutput} for command's `response` shape. + * @see {@link OrganizationsClientResolvedConfig | config} for command's `input` shape. + * */ export class CreateAccountCommand extends $Command< CreateAccountCommandInput, diff --git a/clients/client-organizations/commands/CreateGovCloudAccountCommand.ts b/clients/client-organizations/commands/CreateGovCloudAccountCommand.ts index 700cdb950ad5..33774d3be26d 100644 --- a/clients/client-organizations/commands/CreateGovCloudAccountCommand.ts +++ b/clients/client-organizations/commands/CreateGovCloudAccountCommand.ts @@ -155,6 +155,20 @@ export interface CreateGovCloudAccountCommandOutput extends CreateGovCloudAccoun * Granting * Access to Your Billing Information and Tools.

* + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { OrganizationsClient, CreateGovCloudAccountCommand } from "@aws-sdk/client-organizations"; // ES Modules import + * // const { OrganizationsClient, CreateGovCloudAccountCommand } = require("@aws-sdk/client-organizations"); // CommonJS import + * const client = new OrganizationsClient(config); + * const command = new CreateGovCloudAccountCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreateGovCloudAccountCommandInput} for command's `input` shape. + * @see {@link CreateGovCloudAccountCommandOutput} for command's `response` shape. + * @see {@link OrganizationsClientResolvedConfig | config} for command's `input` shape. + * */ export class CreateGovCloudAccountCommand extends $Command< CreateGovCloudAccountCommandInput, diff --git a/clients/client-organizations/commands/CreateOrganizationCommand.ts b/clients/client-organizations/commands/CreateOrganizationCommand.ts index 3fe1a664e293..af460dff98f3 100644 --- a/clients/client-organizations/commands/CreateOrganizationCommand.ts +++ b/clients/client-organizations/commands/CreateOrganizationCommand.ts @@ -32,6 +32,20 @@ export interface CreateOrganizationCommandOutput extends CreateOrganizationRespo * 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

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { OrganizationsClient, CreateOrganizationCommand } from "@aws-sdk/client-organizations"; // ES Modules import + * // const { OrganizationsClient, CreateOrganizationCommand } = require("@aws-sdk/client-organizations"); // CommonJS import + * const client = new OrganizationsClient(config); + * const command = new CreateOrganizationCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreateOrganizationCommandInput} for command's `input` shape. + * @see {@link CreateOrganizationCommandOutput} for command's `response` shape. + * @see {@link OrganizationsClientResolvedConfig | config} for command's `input` shape. + * */ export class CreateOrganizationCommand extends $Command< CreateOrganizationCommandInput, diff --git a/clients/client-organizations/commands/CreateOrganizationalUnitCommand.ts b/clients/client-organizations/commands/CreateOrganizationalUnitCommand.ts index 1b7c62b93f65..72400150114d 100644 --- a/clients/client-organizations/commands/CreateOrganizationalUnitCommand.ts +++ b/clients/client-organizations/commands/CreateOrganizationalUnitCommand.ts @@ -32,6 +32,20 @@ export interface CreateOrganizationalUnitCommandOutput extends CreateOrganizatio *

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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { OrganizationsClient, CreateOrganizationalUnitCommand } from "@aws-sdk/client-organizations"; // ES Modules import + * // const { OrganizationsClient, CreateOrganizationalUnitCommand } = require("@aws-sdk/client-organizations"); // CommonJS import + * const client = new OrganizationsClient(config); + * const command = new CreateOrganizationalUnitCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreateOrganizationalUnitCommandInput} for command's `input` shape. + * @see {@link CreateOrganizationalUnitCommandOutput} for command's `response` shape. + * @see {@link OrganizationsClientResolvedConfig | config} for command's `input` shape. + * */ export class CreateOrganizationalUnitCommand extends $Command< CreateOrganizationalUnitCommandInput, diff --git a/clients/client-organizations/commands/CreatePolicyCommand.ts b/clients/client-organizations/commands/CreatePolicyCommand.ts index ce460871cca3..4f9b172faf6b 100644 --- a/clients/client-organizations/commands/CreatePolicyCommand.ts +++ b/clients/client-organizations/commands/CreatePolicyCommand.ts @@ -28,6 +28,20 @@ export interface CreatePolicyCommandOutput extends CreatePolicyResponse, __Metad *

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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { OrganizationsClient, CreatePolicyCommand } from "@aws-sdk/client-organizations"; // ES Modules import + * // const { OrganizationsClient, CreatePolicyCommand } = require("@aws-sdk/client-organizations"); // CommonJS import + * const client = new OrganizationsClient(config); + * const command = new CreatePolicyCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreatePolicyCommandInput} for command's `input` shape. + * @see {@link CreatePolicyCommandOutput} for command's `response` shape. + * @see {@link OrganizationsClientResolvedConfig | config} for command's `input` shape. + * */ export class CreatePolicyCommand extends $Command< CreatePolicyCommandInput, diff --git a/clients/client-organizations/commands/DeclineHandshakeCommand.ts b/clients/client-organizations/commands/DeclineHandshakeCommand.ts index a8f4323c45c2..896d63fb2952 100644 --- a/clients/client-organizations/commands/DeclineHandshakeCommand.ts +++ b/clients/client-organizations/commands/DeclineHandshakeCommand.ts @@ -28,6 +28,20 @@ export interface DeclineHandshakeCommandOutput extends DeclineHandshakeResponse, * 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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { OrganizationsClient, DeclineHandshakeCommand } from "@aws-sdk/client-organizations"; // ES Modules import + * // const { OrganizationsClient, DeclineHandshakeCommand } = require("@aws-sdk/client-organizations"); // CommonJS import + * const client = new OrganizationsClient(config); + * const command = new DeclineHandshakeCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeclineHandshakeCommandInput} for command's `input` shape. + * @see {@link DeclineHandshakeCommandOutput} for command's `response` shape. + * @see {@link OrganizationsClientResolvedConfig | config} for command's `input` shape. + * */ export class DeclineHandshakeCommand extends $Command< DeclineHandshakeCommandInput, diff --git a/clients/client-organizations/commands/DeleteOrganizationCommand.ts b/clients/client-organizations/commands/DeleteOrganizationCommand.ts index b6921cfe656e..5e89d0d336f2 100644 --- a/clients/client-organizations/commands/DeleteOrganizationCommand.ts +++ b/clients/client-organizations/commands/DeleteOrganizationCommand.ts @@ -22,6 +22,20 @@ export interface DeleteOrganizationCommandOutput extends __MetadataBearer {} /** *

Deletes the organization. You can delete an organization only by using credentials * from the management account. The organization must be empty of member accounts.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { OrganizationsClient, DeleteOrganizationCommand } from "@aws-sdk/client-organizations"; // ES Modules import + * // const { OrganizationsClient, DeleteOrganizationCommand } = require("@aws-sdk/client-organizations"); // CommonJS import + * const client = new OrganizationsClient(config); + * const command = new DeleteOrganizationCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteOrganizationCommandInput} for command's `input` shape. + * @see {@link DeleteOrganizationCommandOutput} for command's `response` shape. + * @see {@link OrganizationsClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteOrganizationCommand extends $Command< DeleteOrganizationCommandInput, diff --git a/clients/client-organizations/commands/DeleteOrganizationalUnitCommand.ts b/clients/client-organizations/commands/DeleteOrganizationalUnitCommand.ts index 99acb73197d1..f5a536fdd669 100644 --- a/clients/client-organizations/commands/DeleteOrganizationalUnitCommand.ts +++ b/clients/client-organizations/commands/DeleteOrganizationalUnitCommand.ts @@ -24,6 +24,20 @@ export interface DeleteOrganizationalUnitCommandOutput extends __MetadataBearer *

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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { OrganizationsClient, DeleteOrganizationalUnitCommand } from "@aws-sdk/client-organizations"; // ES Modules import + * // const { OrganizationsClient, DeleteOrganizationalUnitCommand } = require("@aws-sdk/client-organizations"); // CommonJS import + * const client = new OrganizationsClient(config); + * const command = new DeleteOrganizationalUnitCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteOrganizationalUnitCommandInput} for command's `input` shape. + * @see {@link DeleteOrganizationalUnitCommandOutput} for command's `response` shape. + * @see {@link OrganizationsClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteOrganizationalUnitCommand extends $Command< DeleteOrganizationalUnitCommandInput, diff --git a/clients/client-organizations/commands/DeletePolicyCommand.ts b/clients/client-organizations/commands/DeletePolicyCommand.ts index e8b2aaff4454..9c1c750e185b 100644 --- a/clients/client-organizations/commands/DeletePolicyCommand.ts +++ b/clients/client-organizations/commands/DeletePolicyCommand.ts @@ -25,6 +25,20 @@ export interface DeletePolicyCommandOutput extends __MetadataBearer {} * 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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { OrganizationsClient, DeletePolicyCommand } from "@aws-sdk/client-organizations"; // ES Modules import + * // const { OrganizationsClient, DeletePolicyCommand } = require("@aws-sdk/client-organizations"); // CommonJS import + * const client = new OrganizationsClient(config); + * const command = new DeletePolicyCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeletePolicyCommandInput} for command's `input` shape. + * @see {@link DeletePolicyCommandOutput} for command's `response` shape. + * @see {@link OrganizationsClientResolvedConfig | config} for command's `input` shape. + * */ export class DeletePolicyCommand extends $Command< DeletePolicyCommandInput, diff --git a/clients/client-organizations/commands/DeregisterDelegatedAdministratorCommand.ts b/clients/client-organizations/commands/DeregisterDelegatedAdministratorCommand.ts index d332931d7d39..f917fdbe024e 100644 --- a/clients/client-organizations/commands/DeregisterDelegatedAdministratorCommand.ts +++ b/clients/client-organizations/commands/DeregisterDelegatedAdministratorCommand.ts @@ -35,6 +35,20 @@ export interface DeregisterDelegatedAdministratorCommandOutput extends __Metadat * AWS Organizations in the AWS Organizations User Guide. *

*

This operation can be called only from the organization's management account.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { OrganizationsClient, DeregisterDelegatedAdministratorCommand } from "@aws-sdk/client-organizations"; // ES Modules import + * // const { OrganizationsClient, DeregisterDelegatedAdministratorCommand } = require("@aws-sdk/client-organizations"); // CommonJS import + * const client = new OrganizationsClient(config); + * const command = new DeregisterDelegatedAdministratorCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeregisterDelegatedAdministratorCommandInput} for command's `input` shape. + * @see {@link DeregisterDelegatedAdministratorCommandOutput} for command's `response` shape. + * @see {@link OrganizationsClientResolvedConfig | config} for command's `input` shape. + * */ export class DeregisterDelegatedAdministratorCommand extends $Command< DeregisterDelegatedAdministratorCommandInput, diff --git a/clients/client-organizations/commands/DescribeAccountCommand.ts b/clients/client-organizations/commands/DescribeAccountCommand.ts index b2f6a103c957..4a153a0d788f 100644 --- a/clients/client-organizations/commands/DescribeAccountCommand.ts +++ b/clients/client-organizations/commands/DescribeAccountCommand.ts @@ -24,6 +24,20 @@ export interface DescribeAccountCommandOutput extends DescribeAccountResponse, _ *

Retrieves AWS 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 AWS service.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { OrganizationsClient, DescribeAccountCommand } from "@aws-sdk/client-organizations"; // ES Modules import + * // const { OrganizationsClient, DescribeAccountCommand } = require("@aws-sdk/client-organizations"); // CommonJS import + * const client = new OrganizationsClient(config); + * const command = new DescribeAccountCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeAccountCommandInput} for command's `input` shape. + * @see {@link DescribeAccountCommandOutput} for command's `response` shape. + * @see {@link OrganizationsClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeAccountCommand extends $Command< DescribeAccountCommandInput, diff --git a/clients/client-organizations/commands/DescribeCreateAccountStatusCommand.ts b/clients/client-organizations/commands/DescribeCreateAccountStatusCommand.ts index 131a512beeeb..e0709e343e09 100644 --- a/clients/client-organizations/commands/DescribeCreateAccountStatusCommand.ts +++ b/clients/client-organizations/commands/DescribeCreateAccountStatusCommand.ts @@ -26,6 +26,20 @@ export interface DescribeCreateAccountStatusCommandOutput *

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 AWS service.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { OrganizationsClient, DescribeCreateAccountStatusCommand } from "@aws-sdk/client-organizations"; // ES Modules import + * // const { OrganizationsClient, DescribeCreateAccountStatusCommand } = require("@aws-sdk/client-organizations"); // CommonJS import + * const client = new OrganizationsClient(config); + * const command = new DescribeCreateAccountStatusCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeCreateAccountStatusCommandInput} for command's `input` shape. + * @see {@link DescribeCreateAccountStatusCommandOutput} for command's `response` shape. + * @see {@link OrganizationsClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeCreateAccountStatusCommand extends $Command< DescribeCreateAccountStatusCommandInput, diff --git a/clients/client-organizations/commands/DescribeEffectivePolicyCommand.ts b/clients/client-organizations/commands/DescribeEffectivePolicyCommand.ts index 73b0002e8820..5dd411242bb8 100644 --- a/clients/client-organizations/commands/DescribeEffectivePolicyCommand.ts +++ b/clients/client-organizations/commands/DescribeEffectivePolicyCommand.ts @@ -31,6 +31,20 @@ export interface DescribeEffectivePolicyCommandOutput extends DescribeEffectiveP * Works in the AWS 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 AWS service.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { OrganizationsClient, DescribeEffectivePolicyCommand } from "@aws-sdk/client-organizations"; // ES Modules import + * // const { OrganizationsClient, DescribeEffectivePolicyCommand } = require("@aws-sdk/client-organizations"); // CommonJS import + * const client = new OrganizationsClient(config); + * const command = new DescribeEffectivePolicyCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeEffectivePolicyCommandInput} for command's `input` shape. + * @see {@link DescribeEffectivePolicyCommandOutput} for command's `response` shape. + * @see {@link OrganizationsClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeEffectivePolicyCommand extends $Command< DescribeEffectivePolicyCommandInput, diff --git a/clients/client-organizations/commands/DescribeHandshakeCommand.ts b/clients/client-organizations/commands/DescribeHandshakeCommand.ts index b56c9c26dcee..7cc37b3f40ec 100644 --- a/clients/client-organizations/commands/DescribeHandshakeCommand.ts +++ b/clients/client-organizations/commands/DescribeHandshakeCommand.ts @@ -28,6 +28,20 @@ export interface DescribeHandshakeCommandOutput extends DescribeHandshakeRespons * 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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { OrganizationsClient, DescribeHandshakeCommand } from "@aws-sdk/client-organizations"; // ES Modules import + * // const { OrganizationsClient, DescribeHandshakeCommand } = require("@aws-sdk/client-organizations"); // CommonJS import + * const client = new OrganizationsClient(config); + * const command = new DescribeHandshakeCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeHandshakeCommandInput} for command's `input` shape. + * @see {@link DescribeHandshakeCommandOutput} for command's `response` shape. + * @see {@link OrganizationsClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeHandshakeCommand extends $Command< DescribeHandshakeCommandInput, diff --git a/clients/client-organizations/commands/DescribeOrganizationCommand.ts b/clients/client-organizations/commands/DescribeOrganizationCommand.ts index 29267d8653ac..3d338425e1ec 100644 --- a/clients/client-organizations/commands/DescribeOrganizationCommand.ts +++ b/clients/client-organizations/commands/DescribeOrganizationCommand.ts @@ -29,6 +29,20 @@ export interface DescribeOrganizationCommandOutput extends DescribeOrganizationR * it separately at the root level with DisablePolicyType. Use ListRoots to see the status of policy types for a specified * root.

* + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { OrganizationsClient, DescribeOrganizationCommand } from "@aws-sdk/client-organizations"; // ES Modules import + * // const { OrganizationsClient, DescribeOrganizationCommand } = require("@aws-sdk/client-organizations"); // CommonJS import + * const client = new OrganizationsClient(config); + * const command = new DescribeOrganizationCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeOrganizationCommandInput} for command's `input` shape. + * @see {@link DescribeOrganizationCommandOutput} for command's `response` shape. + * @see {@link OrganizationsClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeOrganizationCommand extends $Command< DescribeOrganizationCommandInput, diff --git a/clients/client-organizations/commands/DescribeOrganizationalUnitCommand.ts b/clients/client-organizations/commands/DescribeOrganizationalUnitCommand.ts index e554cd420c4f..034da16c11e0 100644 --- a/clients/client-organizations/commands/DescribeOrganizationalUnitCommand.ts +++ b/clients/client-organizations/commands/DescribeOrganizationalUnitCommand.ts @@ -24,6 +24,20 @@ export interface DescribeOrganizationalUnitCommandOutput extends DescribeOrganiz *

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 AWS service.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { OrganizationsClient, DescribeOrganizationalUnitCommand } from "@aws-sdk/client-organizations"; // ES Modules import + * // const { OrganizationsClient, DescribeOrganizationalUnitCommand } = require("@aws-sdk/client-organizations"); // CommonJS import + * const client = new OrganizationsClient(config); + * const command = new DescribeOrganizationalUnitCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeOrganizationalUnitCommandInput} for command's `input` shape. + * @see {@link DescribeOrganizationalUnitCommandOutput} for command's `response` shape. + * @see {@link OrganizationsClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeOrganizationalUnitCommand extends $Command< DescribeOrganizationalUnitCommandInput, diff --git a/clients/client-organizations/commands/DescribePolicyCommand.ts b/clients/client-organizations/commands/DescribePolicyCommand.ts index 0d35888dabeb..18e258d31689 100644 --- a/clients/client-organizations/commands/DescribePolicyCommand.ts +++ b/clients/client-organizations/commands/DescribePolicyCommand.ts @@ -24,6 +24,20 @@ export interface DescribePolicyCommandOutput extends DescribePolicyResponse, __M *

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 AWS service.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { OrganizationsClient, DescribePolicyCommand } from "@aws-sdk/client-organizations"; // ES Modules import + * // const { OrganizationsClient, DescribePolicyCommand } = require("@aws-sdk/client-organizations"); // CommonJS import + * const client = new OrganizationsClient(config); + * const command = new DescribePolicyCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribePolicyCommandInput} for command's `input` shape. + * @see {@link DescribePolicyCommandOutput} for command's `response` shape. + * @see {@link OrganizationsClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribePolicyCommand extends $Command< DescribePolicyCommandInput, diff --git a/clients/client-organizations/commands/DetachPolicyCommand.ts b/clients/client-organizations/commands/DetachPolicyCommand.ts index 5c7eb59c10f7..44e606c45bf9 100644 --- a/clients/client-organizations/commands/DetachPolicyCommand.ts +++ b/clients/client-organizations/commands/DetachPolicyCommand.ts @@ -36,6 +36,20 @@ export interface DetachPolicyCommandOutput extends __MetadataBearer {} * 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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { OrganizationsClient, DetachPolicyCommand } from "@aws-sdk/client-organizations"; // ES Modules import + * // const { OrganizationsClient, DetachPolicyCommand } = require("@aws-sdk/client-organizations"); // CommonJS import + * const client = new OrganizationsClient(config); + * const command = new DetachPolicyCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DetachPolicyCommandInput} for command's `input` shape. + * @see {@link DetachPolicyCommandOutput} for command's `response` shape. + * @see {@link OrganizationsClientResolvedConfig | config} for command's `input` shape. + * */ export class DetachPolicyCommand extends $Command< DetachPolicyCommandInput, diff --git a/clients/client-organizations/commands/DisableAWSServiceAccessCommand.ts b/clients/client-organizations/commands/DisableAWSServiceAccessCommand.ts index 2d20e9e1870b..74a2207014ac 100644 --- a/clients/client-organizations/commands/DisableAWSServiceAccessCommand.ts +++ b/clients/client-organizations/commands/DisableAWSServiceAccessCommand.ts @@ -77,6 +77,20 @@ export interface DisableAWSServiceAccessCommandOutput extends __MetadataBearer { * AWS Services in the AWS Organizations User Guide. *

*

This operation can be called only from the organization's management account.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { OrganizationsClient, DisableAWSServiceAccessCommand } from "@aws-sdk/client-organizations"; // ES Modules import + * // const { OrganizationsClient, DisableAWSServiceAccessCommand } = require("@aws-sdk/client-organizations"); // CommonJS import + * const client = new OrganizationsClient(config); + * const command = new DisableAWSServiceAccessCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DisableAWSServiceAccessCommandInput} for command's `input` shape. + * @see {@link DisableAWSServiceAccessCommandOutput} for command's `response` shape. + * @see {@link OrganizationsClientResolvedConfig | config} for command's `input` shape. + * */ export class DisableAWSServiceAccessCommand extends $Command< DisableAWSServiceAccessCommandInput, diff --git a/clients/client-organizations/commands/DisablePolicyTypeCommand.ts b/clients/client-organizations/commands/DisablePolicyTypeCommand.ts index 9e48c4570276..6bbe0f4f2c94 100644 --- a/clients/client-organizations/commands/DisablePolicyTypeCommand.ts +++ b/clients/client-organizations/commands/DisablePolicyTypeCommand.ts @@ -32,6 +32,20 @@ export interface DisablePolicyTypeCommandOutput extends DisablePolicyTypeRespons * 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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { OrganizationsClient, DisablePolicyTypeCommand } from "@aws-sdk/client-organizations"; // ES Modules import + * // const { OrganizationsClient, DisablePolicyTypeCommand } = require("@aws-sdk/client-organizations"); // CommonJS import + * const client = new OrganizationsClient(config); + * const command = new DisablePolicyTypeCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DisablePolicyTypeCommandInput} for command's `input` shape. + * @see {@link DisablePolicyTypeCommandOutput} for command's `response` shape. + * @see {@link OrganizationsClientResolvedConfig | config} for command's `input` shape. + * */ export class DisablePolicyTypeCommand extends $Command< DisablePolicyTypeCommandInput, diff --git a/clients/client-organizations/commands/EnableAWSServiceAccessCommand.ts b/clients/client-organizations/commands/EnableAWSServiceAccessCommand.ts index b2f04bb4d161..a47781897e8d 100644 --- a/clients/client-organizations/commands/EnableAWSServiceAccessCommand.ts +++ b/clients/client-organizations/commands/EnableAWSServiceAccessCommand.ts @@ -40,6 +40,20 @@ export interface EnableAWSServiceAccessCommandOutput extends __MetadataBearer {} *

This operation can be called only from the organization's management account and only * if the organization has enabled all * features.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { OrganizationsClient, EnableAWSServiceAccessCommand } from "@aws-sdk/client-organizations"; // ES Modules import + * // const { OrganizationsClient, EnableAWSServiceAccessCommand } = require("@aws-sdk/client-organizations"); // CommonJS import + * const client = new OrganizationsClient(config); + * const command = new EnableAWSServiceAccessCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link EnableAWSServiceAccessCommandInput} for command's `input` shape. + * @see {@link EnableAWSServiceAccessCommandOutput} for command's `response` shape. + * @see {@link OrganizationsClientResolvedConfig | config} for command's `input` shape. + * */ export class EnableAWSServiceAccessCommand extends $Command< EnableAWSServiceAccessCommandInput, diff --git a/clients/client-organizations/commands/EnableAllFeaturesCommand.ts b/clients/client-organizations/commands/EnableAllFeaturesCommand.ts index 3efd44f53863..6313c2cc4cc3 100644 --- a/clients/client-organizations/commands/EnableAllFeaturesCommand.ts +++ b/clients/client-organizations/commands/EnableAllFeaturesCommand.ts @@ -47,6 +47,20 @@ export interface EnableAllFeaturesCommandOutput extends EnableAllFeaturesRespons * 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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { OrganizationsClient, EnableAllFeaturesCommand } from "@aws-sdk/client-organizations"; // ES Modules import + * // const { OrganizationsClient, EnableAllFeaturesCommand } = require("@aws-sdk/client-organizations"); // CommonJS import + * const client = new OrganizationsClient(config); + * const command = new EnableAllFeaturesCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link EnableAllFeaturesCommandInput} for command's `input` shape. + * @see {@link EnableAllFeaturesCommandOutput} for command's `response` shape. + * @see {@link OrganizationsClientResolvedConfig | config} for command's `input` shape. + * */ export class EnableAllFeaturesCommand extends $Command< EnableAllFeaturesCommandInput, diff --git a/clients/client-organizations/commands/EnablePolicyTypeCommand.ts b/clients/client-organizations/commands/EnablePolicyTypeCommand.ts index acb695f32037..9a86ee63fad0 100644 --- a/clients/client-organizations/commands/EnablePolicyTypeCommand.ts +++ b/clients/client-organizations/commands/EnablePolicyTypeCommand.ts @@ -32,6 +32,20 @@ export interface EnablePolicyTypeCommandOutput extends EnablePolicyTypeResponse, *

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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { OrganizationsClient, EnablePolicyTypeCommand } from "@aws-sdk/client-organizations"; // ES Modules import + * // const { OrganizationsClient, EnablePolicyTypeCommand } = require("@aws-sdk/client-organizations"); // CommonJS import + * const client = new OrganizationsClient(config); + * const command = new EnablePolicyTypeCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link EnablePolicyTypeCommandInput} for command's `input` shape. + * @see {@link EnablePolicyTypeCommandOutput} for command's `response` shape. + * @see {@link OrganizationsClientResolvedConfig | config} for command's `input` shape. + * */ export class EnablePolicyTypeCommand extends $Command< EnablePolicyTypeCommandInput, diff --git a/clients/client-organizations/commands/InviteAccountToOrganizationCommand.ts b/clients/client-organizations/commands/InviteAccountToOrganizationCommand.ts index c46cb275226e..8a51a34fee1c 100644 --- a/clients/client-organizations/commands/InviteAccountToOrganizationCommand.ts +++ b/clients/client-organizations/commands/InviteAccountToOrganizationCommand.ts @@ -49,6 +49,20 @@ export interface InviteAccountToOrganizationCommandOutput *

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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { OrganizationsClient, InviteAccountToOrganizationCommand } from "@aws-sdk/client-organizations"; // ES Modules import + * // const { OrganizationsClient, InviteAccountToOrganizationCommand } = require("@aws-sdk/client-organizations"); // CommonJS import + * const client = new OrganizationsClient(config); + * const command = new InviteAccountToOrganizationCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link InviteAccountToOrganizationCommandInput} for command's `input` shape. + * @see {@link InviteAccountToOrganizationCommandOutput} for command's `response` shape. + * @see {@link OrganizationsClientResolvedConfig | config} for command's `input` shape. + * */ export class InviteAccountToOrganizationCommand extends $Command< InviteAccountToOrganizationCommandInput, diff --git a/clients/client-organizations/commands/LeaveOrganizationCommand.ts b/clients/client-organizations/commands/LeaveOrganizationCommand.ts index 678465c01777..28609c436848 100644 --- a/clients/client-organizations/commands/LeaveOrganizationCommand.ts +++ b/clients/client-organizations/commands/LeaveOrganizationCommand.ts @@ -85,6 +85,20 @@ export interface LeaveOrganizationCommandOutput extends __MetadataBearer {} * * * + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { OrganizationsClient, LeaveOrganizationCommand } from "@aws-sdk/client-organizations"; // ES Modules import + * // const { OrganizationsClient, LeaveOrganizationCommand } = require("@aws-sdk/client-organizations"); // CommonJS import + * const client = new OrganizationsClient(config); + * const command = new LeaveOrganizationCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link LeaveOrganizationCommandInput} for command's `input` shape. + * @see {@link LeaveOrganizationCommandOutput} for command's `response` shape. + * @see {@link OrganizationsClientResolvedConfig | config} for command's `input` shape. + * */ export class LeaveOrganizationCommand extends $Command< LeaveOrganizationCommandInput, diff --git a/clients/client-organizations/commands/ListAWSServiceAccessForOrganizationCommand.ts b/clients/client-organizations/commands/ListAWSServiceAccessForOrganizationCommand.ts index 5f0ee12c78a2..9429984345f2 100644 --- a/clients/client-organizations/commands/ListAWSServiceAccessForOrganizationCommand.ts +++ b/clients/client-organizations/commands/ListAWSServiceAccessForOrganizationCommand.ts @@ -35,6 +35,20 @@ export interface ListAWSServiceAccessForOrganizationCommandOutput *

*

This operation can be called only from the organization's * management account or by a member account that is a delegated administrator for an AWS service.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { OrganizationsClient, ListAWSServiceAccessForOrganizationCommand } from "@aws-sdk/client-organizations"; // ES Modules import + * // const { OrganizationsClient, ListAWSServiceAccessForOrganizationCommand } = require("@aws-sdk/client-organizations"); // CommonJS import + * const client = new OrganizationsClient(config); + * const command = new ListAWSServiceAccessForOrganizationCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListAWSServiceAccessForOrganizationCommandInput} for command's `input` shape. + * @see {@link ListAWSServiceAccessForOrganizationCommandOutput} for command's `response` shape. + * @see {@link OrganizationsClientResolvedConfig | config} for command's `input` shape. + * */ export class ListAWSServiceAccessForOrganizationCommand extends $Command< ListAWSServiceAccessForOrganizationCommandInput, diff --git a/clients/client-organizations/commands/ListAccountsCommand.ts b/clients/client-organizations/commands/ListAccountsCommand.ts index 609d6d9bdbdd..1e6ec5737390 100644 --- a/clients/client-organizations/commands/ListAccountsCommand.ts +++ b/clients/client-organizations/commands/ListAccountsCommand.ts @@ -33,6 +33,20 @@ export interface ListAccountsCommandOutput extends ListAccountsResponse, __Metad * *

This operation can be called only from the organization's * management account or by a member account that is a delegated administrator for an AWS service.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { OrganizationsClient, ListAccountsCommand } from "@aws-sdk/client-organizations"; // ES Modules import + * // const { OrganizationsClient, ListAccountsCommand } = require("@aws-sdk/client-organizations"); // CommonJS import + * const client = new OrganizationsClient(config); + * const command = new ListAccountsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListAccountsCommandInput} for command's `input` shape. + * @see {@link ListAccountsCommandOutput} for command's `response` shape. + * @see {@link OrganizationsClientResolvedConfig | config} for command's `input` shape. + * */ export class ListAccountsCommand extends $Command< ListAccountsCommandInput, diff --git a/clients/client-organizations/commands/ListAccountsForParentCommand.ts b/clients/client-organizations/commands/ListAccountsForParentCommand.ts index 995ba6ab29f6..a95854a9218c 100644 --- a/clients/client-organizations/commands/ListAccountsForParentCommand.ts +++ b/clients/client-organizations/commands/ListAccountsForParentCommand.ts @@ -36,6 +36,20 @@ export interface ListAccountsForParentCommandOutput extends ListAccountsForParen * *

This operation can be called only from the organization's * management account or by a member account that is a delegated administrator for an AWS service.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { OrganizationsClient, ListAccountsForParentCommand } from "@aws-sdk/client-organizations"; // ES Modules import + * // const { OrganizationsClient, ListAccountsForParentCommand } = require("@aws-sdk/client-organizations"); // CommonJS import + * const client = new OrganizationsClient(config); + * const command = new ListAccountsForParentCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListAccountsForParentCommandInput} for command's `input` shape. + * @see {@link ListAccountsForParentCommandOutput} for command's `response` shape. + * @see {@link OrganizationsClientResolvedConfig | config} for command's `input` shape. + * */ export class ListAccountsForParentCommand extends $Command< ListAccountsForParentCommandInput, diff --git a/clients/client-organizations/commands/ListChildrenCommand.ts b/clients/client-organizations/commands/ListChildrenCommand.ts index 662923fd0713..188895d031d9 100644 --- a/clients/client-organizations/commands/ListChildrenCommand.ts +++ b/clients/client-organizations/commands/ListChildrenCommand.ts @@ -34,6 +34,20 @@ export interface ListChildrenCommandOutput extends ListChildrenResponse, __Metad * *

This operation can be called only from the organization's * management account or by a member account that is a delegated administrator for an AWS service.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { OrganizationsClient, ListChildrenCommand } from "@aws-sdk/client-organizations"; // ES Modules import + * // const { OrganizationsClient, ListChildrenCommand } = require("@aws-sdk/client-organizations"); // CommonJS import + * const client = new OrganizationsClient(config); + * const command = new ListChildrenCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListChildrenCommandInput} for command's `input` shape. + * @see {@link ListChildrenCommandOutput} for command's `response` shape. + * @see {@link OrganizationsClientResolvedConfig | config} for command's `input` shape. + * */ export class ListChildrenCommand extends $Command< ListChildrenCommandInput, diff --git a/clients/client-organizations/commands/ListCreateAccountStatusCommand.ts b/clients/client-organizations/commands/ListCreateAccountStatusCommand.ts index 6e5b3bb87f44..67bbbd0155d2 100644 --- a/clients/client-organizations/commands/ListCreateAccountStatusCommand.ts +++ b/clients/client-organizations/commands/ListCreateAccountStatusCommand.ts @@ -33,6 +33,20 @@ export interface ListCreateAccountStatusCommandOutput extends ListCreateAccountS * *

This operation can be called only from the organization's * management account or by a member account that is a delegated administrator for an AWS service.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { OrganizationsClient, ListCreateAccountStatusCommand } from "@aws-sdk/client-organizations"; // ES Modules import + * // const { OrganizationsClient, ListCreateAccountStatusCommand } = require("@aws-sdk/client-organizations"); // CommonJS import + * const client = new OrganizationsClient(config); + * const command = new ListCreateAccountStatusCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListCreateAccountStatusCommandInput} for command's `input` shape. + * @see {@link ListCreateAccountStatusCommandOutput} for command's `response` shape. + * @see {@link OrganizationsClientResolvedConfig | config} for command's `input` shape. + * */ export class ListCreateAccountStatusCommand extends $Command< ListCreateAccountStatusCommandInput, diff --git a/clients/client-organizations/commands/ListDelegatedAdministratorsCommand.ts b/clients/client-organizations/commands/ListDelegatedAdministratorsCommand.ts index b733dd2ddeac..f0c36cdeea95 100644 --- a/clients/client-organizations/commands/ListDelegatedAdministratorsCommand.ts +++ b/clients/client-organizations/commands/ListDelegatedAdministratorsCommand.ts @@ -27,6 +27,20 @@ export interface ListDelegatedAdministratorsCommandOutput * 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 AWS service.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { OrganizationsClient, ListDelegatedAdministratorsCommand } from "@aws-sdk/client-organizations"; // ES Modules import + * // const { OrganizationsClient, ListDelegatedAdministratorsCommand } = require("@aws-sdk/client-organizations"); // CommonJS import + * const client = new OrganizationsClient(config); + * const command = new ListDelegatedAdministratorsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListDelegatedAdministratorsCommandInput} for command's `input` shape. + * @see {@link ListDelegatedAdministratorsCommandOutput} for command's `response` shape. + * @see {@link OrganizationsClientResolvedConfig | config} for command's `input` shape. + * */ export class ListDelegatedAdministratorsCommand extends $Command< ListDelegatedAdministratorsCommandInput, diff --git a/clients/client-organizations/commands/ListDelegatedServicesForAccountCommand.ts b/clients/client-organizations/commands/ListDelegatedServicesForAccountCommand.ts index aee6c1db5c0c..57f68031a9b1 100644 --- a/clients/client-organizations/commands/ListDelegatedServicesForAccountCommand.ts +++ b/clients/client-organizations/commands/ListDelegatedServicesForAccountCommand.ts @@ -27,6 +27,20 @@ export interface ListDelegatedServicesForAccountCommandOutput * 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 AWS service.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { OrganizationsClient, ListDelegatedServicesForAccountCommand } from "@aws-sdk/client-organizations"; // ES Modules import + * // const { OrganizationsClient, ListDelegatedServicesForAccountCommand } = require("@aws-sdk/client-organizations"); // CommonJS import + * const client = new OrganizationsClient(config); + * const command = new ListDelegatedServicesForAccountCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListDelegatedServicesForAccountCommandInput} for command's `input` shape. + * @see {@link ListDelegatedServicesForAccountCommandOutput} for command's `response` shape. + * @see {@link OrganizationsClientResolvedConfig | config} for command's `input` shape. + * */ export class ListDelegatedServicesForAccountCommand extends $Command< ListDelegatedServicesForAccountCommandInput, diff --git a/clients/client-organizations/commands/ListHandshakesForAccountCommand.ts b/clients/client-organizations/commands/ListHandshakesForAccountCommand.ts index 6ab12185c8b2..d518f4bed822 100644 --- a/clients/client-organizations/commands/ListHandshakesForAccountCommand.ts +++ b/clients/client-organizations/commands/ListHandshakesForAccountCommand.ts @@ -35,6 +35,20 @@ export interface ListHandshakesForAccountCommandOutput extends ListHandshakesFor * when there are no more results to display.

* *

This operation can be called from any account in the organization.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { OrganizationsClient, ListHandshakesForAccountCommand } from "@aws-sdk/client-organizations"; // ES Modules import + * // const { OrganizationsClient, ListHandshakesForAccountCommand } = require("@aws-sdk/client-organizations"); // CommonJS import + * const client = new OrganizationsClient(config); + * const command = new ListHandshakesForAccountCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListHandshakesForAccountCommandInput} for command's `input` shape. + * @see {@link ListHandshakesForAccountCommandOutput} for command's `response` shape. + * @see {@link OrganizationsClientResolvedConfig | config} for command's `input` shape. + * */ export class ListHandshakesForAccountCommand extends $Command< ListHandshakesForAccountCommandInput, diff --git a/clients/client-organizations/commands/ListHandshakesForOrganizationCommand.ts b/clients/client-organizations/commands/ListHandshakesForOrganizationCommand.ts index f912ecf2e2e1..21cad777235f 100644 --- a/clients/client-organizations/commands/ListHandshakesForOrganizationCommand.ts +++ b/clients/client-organizations/commands/ListHandshakesForOrganizationCommand.ts @@ -40,6 +40,20 @@ export interface ListHandshakesForOrganizationCommandOutput * *

This operation can be called only from the organization's * management account or by a member account that is a delegated administrator for an AWS service.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { OrganizationsClient, ListHandshakesForOrganizationCommand } from "@aws-sdk/client-organizations"; // ES Modules import + * // const { OrganizationsClient, ListHandshakesForOrganizationCommand } = require("@aws-sdk/client-organizations"); // CommonJS import + * const client = new OrganizationsClient(config); + * const command = new ListHandshakesForOrganizationCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListHandshakesForOrganizationCommandInput} for command's `input` shape. + * @see {@link ListHandshakesForOrganizationCommandOutput} for command's `response` shape. + * @see {@link OrganizationsClientResolvedConfig | config} for command's `input` shape. + * */ export class ListHandshakesForOrganizationCommand extends $Command< ListHandshakesForOrganizationCommandInput, diff --git a/clients/client-organizations/commands/ListOrganizationalUnitsForParentCommand.ts b/clients/client-organizations/commands/ListOrganizationalUnitsForParentCommand.ts index 3b0a48458613..a817b9cbc810 100644 --- a/clients/client-organizations/commands/ListOrganizationalUnitsForParentCommand.ts +++ b/clients/client-organizations/commands/ListOrganizationalUnitsForParentCommand.ts @@ -34,6 +34,20 @@ export interface ListOrganizationalUnitsForParentCommandOutput * *

This operation can be called only from the organization's * management account or by a member account that is a delegated administrator for an AWS service.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { OrganizationsClient, ListOrganizationalUnitsForParentCommand } from "@aws-sdk/client-organizations"; // ES Modules import + * // const { OrganizationsClient, ListOrganizationalUnitsForParentCommand } = require("@aws-sdk/client-organizations"); // CommonJS import + * const client = new OrganizationsClient(config); + * const command = new ListOrganizationalUnitsForParentCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListOrganizationalUnitsForParentCommandInput} for command's `input` shape. + * @see {@link ListOrganizationalUnitsForParentCommandOutput} for command's `response` shape. + * @see {@link OrganizationsClientResolvedConfig | config} for command's `input` shape. + * */ export class ListOrganizationalUnitsForParentCommand extends $Command< ListOrganizationalUnitsForParentCommandInput, diff --git a/clients/client-organizations/commands/ListParentsCommand.ts b/clients/client-organizations/commands/ListParentsCommand.ts index 987863d3651e..c3321d601a70 100644 --- a/clients/client-organizations/commands/ListParentsCommand.ts +++ b/clients/client-organizations/commands/ListParentsCommand.ts @@ -37,6 +37,20 @@ export interface ListParentsCommandOutput extends ListParentsResponse, __Metadat * *

In the current release, a child can have only a single parent.

* + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { OrganizationsClient, ListParentsCommand } from "@aws-sdk/client-organizations"; // ES Modules import + * // const { OrganizationsClient, ListParentsCommand } = require("@aws-sdk/client-organizations"); // CommonJS import + * const client = new OrganizationsClient(config); + * const command = new ListParentsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListParentsCommandInput} for command's `input` shape. + * @see {@link ListParentsCommandOutput} for command's `response` shape. + * @see {@link OrganizationsClientResolvedConfig | config} for command's `input` shape. + * */ export class ListParentsCommand extends $Command< ListParentsCommandInput, diff --git a/clients/client-organizations/commands/ListPoliciesCommand.ts b/clients/client-organizations/commands/ListPoliciesCommand.ts index 10aa37373c2c..f1a76dce52b9 100644 --- a/clients/client-organizations/commands/ListPoliciesCommand.ts +++ b/clients/client-organizations/commands/ListPoliciesCommand.ts @@ -32,6 +32,20 @@ export interface ListPoliciesCommandOutput extends ListPoliciesResponse, __Metad * *

This operation can be called only from the organization's * management account or by a member account that is a delegated administrator for an AWS service.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { OrganizationsClient, ListPoliciesCommand } from "@aws-sdk/client-organizations"; // ES Modules import + * // const { OrganizationsClient, ListPoliciesCommand } = require("@aws-sdk/client-organizations"); // CommonJS import + * const client = new OrganizationsClient(config); + * const command = new ListPoliciesCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListPoliciesCommandInput} for command's `input` shape. + * @see {@link ListPoliciesCommandOutput} for command's `response` shape. + * @see {@link OrganizationsClientResolvedConfig | config} for command's `input` shape. + * */ export class ListPoliciesCommand extends $Command< ListPoliciesCommandInput, diff --git a/clients/client-organizations/commands/ListPoliciesForTargetCommand.ts b/clients/client-organizations/commands/ListPoliciesForTargetCommand.ts index ab0ba0dd5dce..ab85b9adaee9 100644 --- a/clients/client-organizations/commands/ListPoliciesForTargetCommand.ts +++ b/clients/client-organizations/commands/ListPoliciesForTargetCommand.ts @@ -34,6 +34,20 @@ export interface ListPoliciesForTargetCommandOutput extends ListPoliciesForTarge * *

This operation can be called only from the organization's * management account or by a member account that is a delegated administrator for an AWS service.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { OrganizationsClient, ListPoliciesForTargetCommand } from "@aws-sdk/client-organizations"; // ES Modules import + * // const { OrganizationsClient, ListPoliciesForTargetCommand } = require("@aws-sdk/client-organizations"); // CommonJS import + * const client = new OrganizationsClient(config); + * const command = new ListPoliciesForTargetCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListPoliciesForTargetCommandInput} for command's `input` shape. + * @see {@link ListPoliciesForTargetCommandOutput} for command's `response` shape. + * @see {@link OrganizationsClientResolvedConfig | config} for command's `input` shape. + * */ export class ListPoliciesForTargetCommand extends $Command< ListPoliciesForTargetCommandInput, diff --git a/clients/client-organizations/commands/ListRootsCommand.ts b/clients/client-organizations/commands/ListRootsCommand.ts index daea25a93a91..1019db524043 100644 --- a/clients/client-organizations/commands/ListRootsCommand.ts +++ b/clients/client-organizations/commands/ListRootsCommand.ts @@ -36,6 +36,20 @@ export interface ListRootsCommandOutput extends ListRootsResponse, __MetadataBea * enabled and disabled in a root. To see the availability of a policy type in an * organization, use DescribeOrganization.

* + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { OrganizationsClient, ListRootsCommand } from "@aws-sdk/client-organizations"; // ES Modules import + * // const { OrganizationsClient, ListRootsCommand } = require("@aws-sdk/client-organizations"); // CommonJS import + * const client = new OrganizationsClient(config); + * const command = new ListRootsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListRootsCommandInput} for command's `input` shape. + * @see {@link ListRootsCommandOutput} for command's `response` shape. + * @see {@link OrganizationsClientResolvedConfig | config} for command's `input` shape. + * */ export class ListRootsCommand extends $Command< ListRootsCommandInput, diff --git a/clients/client-organizations/commands/ListTagsForResourceCommand.ts b/clients/client-organizations/commands/ListTagsForResourceCommand.ts index 0903dfddb65b..b1b5b262323b 100644 --- a/clients/client-organizations/commands/ListTagsForResourceCommand.ts +++ b/clients/client-organizations/commands/ListTagsForResourceCommand.ts @@ -39,6 +39,20 @@ export interface ListTagsForResourceCommandOutput extends ListTagsForResourceRes * *

This operation can be called only from the organization's * management account or by a member account that is a delegated administrator for an AWS service.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { OrganizationsClient, ListTagsForResourceCommand } from "@aws-sdk/client-organizations"; // ES Modules import + * // const { OrganizationsClient, ListTagsForResourceCommand } = require("@aws-sdk/client-organizations"); // CommonJS import + * const client = new OrganizationsClient(config); + * const command = new ListTagsForResourceCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListTagsForResourceCommandInput} for command's `input` shape. + * @see {@link ListTagsForResourceCommandOutput} for command's `response` shape. + * @see {@link OrganizationsClientResolvedConfig | config} for command's `input` shape. + * */ export class ListTagsForResourceCommand extends $Command< ListTagsForResourceCommandInput, diff --git a/clients/client-organizations/commands/ListTargetsForPolicyCommand.ts b/clients/client-organizations/commands/ListTargetsForPolicyCommand.ts index 25726cf12ff7..a14e9e3eaeb2 100644 --- a/clients/client-organizations/commands/ListTargetsForPolicyCommand.ts +++ b/clients/client-organizations/commands/ListTargetsForPolicyCommand.ts @@ -33,6 +33,20 @@ export interface ListTargetsForPolicyCommandOutput extends ListTargetsForPolicyR * *

This operation can be called only from the organization's * management account or by a member account that is a delegated administrator for an AWS service.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { OrganizationsClient, ListTargetsForPolicyCommand } from "@aws-sdk/client-organizations"; // ES Modules import + * // const { OrganizationsClient, ListTargetsForPolicyCommand } = require("@aws-sdk/client-organizations"); // CommonJS import + * const client = new OrganizationsClient(config); + * const command = new ListTargetsForPolicyCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListTargetsForPolicyCommandInput} for command's `input` shape. + * @see {@link ListTargetsForPolicyCommandOutput} for command's `response` shape. + * @see {@link OrganizationsClientResolvedConfig | config} for command's `input` shape. + * */ export class ListTargetsForPolicyCommand extends $Command< ListTargetsForPolicyCommandInput, diff --git a/clients/client-organizations/commands/MoveAccountCommand.ts b/clients/client-organizations/commands/MoveAccountCommand.ts index d2754fadd355..c5c356c50942 100644 --- a/clients/client-organizations/commands/MoveAccountCommand.ts +++ b/clients/client-organizations/commands/MoveAccountCommand.ts @@ -24,6 +24,20 @@ export interface MoveAccountCommandOutput extends __MetadataBearer {} *

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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { OrganizationsClient, MoveAccountCommand } from "@aws-sdk/client-organizations"; // ES Modules import + * // const { OrganizationsClient, MoveAccountCommand } = require("@aws-sdk/client-organizations"); // CommonJS import + * const client = new OrganizationsClient(config); + * const command = new MoveAccountCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link MoveAccountCommandInput} for command's `input` shape. + * @see {@link MoveAccountCommandOutput} for command's `response` shape. + * @see {@link OrganizationsClientResolvedConfig | config} for command's `input` shape. + * */ export class MoveAccountCommand extends $Command< MoveAccountCommandInput, diff --git a/clients/client-organizations/commands/RegisterDelegatedAdministratorCommand.ts b/clients/client-organizations/commands/RegisterDelegatedAdministratorCommand.ts index 1d45399bba96..ceaa67f657b0 100644 --- a/clients/client-organizations/commands/RegisterDelegatedAdministratorCommand.ts +++ b/clients/client-organizations/commands/RegisterDelegatedAdministratorCommand.ts @@ -30,6 +30,20 @@ export interface RegisterDelegatedAdministratorCommandOutput extends __MetadataB * AWS Organizations in the AWS Organizations User Guide. *

*

This operation can be called only from the organization's management account.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { OrganizationsClient, RegisterDelegatedAdministratorCommand } from "@aws-sdk/client-organizations"; // ES Modules import + * // const { OrganizationsClient, RegisterDelegatedAdministratorCommand } = require("@aws-sdk/client-organizations"); // CommonJS import + * const client = new OrganizationsClient(config); + * const command = new RegisterDelegatedAdministratorCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link RegisterDelegatedAdministratorCommandInput} for command's `input` shape. + * @see {@link RegisterDelegatedAdministratorCommandOutput} for command's `response` shape. + * @see {@link OrganizationsClientResolvedConfig | config} for command's `input` shape. + * */ export class RegisterDelegatedAdministratorCommand extends $Command< RegisterDelegatedAdministratorCommandInput, diff --git a/clients/client-organizations/commands/RemoveAccountFromOrganizationCommand.ts b/clients/client-organizations/commands/RemoveAccountFromOrganizationCommand.ts index 2395802493cc..7915c7bb773c 100644 --- a/clients/client-organizations/commands/RemoveAccountFromOrganizationCommand.ts +++ b/clients/client-organizations/commands/RemoveAccountFromOrganizationCommand.ts @@ -59,6 +59,20 @@ export interface RemoveAccountFromOrganizationCommandOutput extends __MetadataBe * * * + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { OrganizationsClient, RemoveAccountFromOrganizationCommand } from "@aws-sdk/client-organizations"; // ES Modules import + * // const { OrganizationsClient, RemoveAccountFromOrganizationCommand } = require("@aws-sdk/client-organizations"); // CommonJS import + * const client = new OrganizationsClient(config); + * const command = new RemoveAccountFromOrganizationCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link RemoveAccountFromOrganizationCommandInput} for command's `input` shape. + * @see {@link RemoveAccountFromOrganizationCommandOutput} for command's `response` shape. + * @see {@link OrganizationsClientResolvedConfig | config} for command's `input` shape. + * */ export class RemoveAccountFromOrganizationCommand extends $Command< RemoveAccountFromOrganizationCommandInput, diff --git a/clients/client-organizations/commands/TagResourceCommand.ts b/clients/client-organizations/commands/TagResourceCommand.ts index fbdacc9fca61..a95414b24f29 100644 --- a/clients/client-organizations/commands/TagResourceCommand.ts +++ b/clients/client-organizations/commands/TagResourceCommand.ts @@ -38,6 +38,20 @@ export interface TagResourceCommandOutput extends __MetadataBearer {} * * *

This operation can be called only from the organization's management account.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { OrganizationsClient, TagResourceCommand } from "@aws-sdk/client-organizations"; // ES Modules import + * // const { OrganizationsClient, TagResourceCommand } = require("@aws-sdk/client-organizations"); // CommonJS import + * const client = new OrganizationsClient(config); + * const command = new TagResourceCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link TagResourceCommandInput} for command's `input` shape. + * @see {@link TagResourceCommandOutput} for command's `response` shape. + * @see {@link OrganizationsClientResolvedConfig | config} for command's `input` shape. + * */ export class TagResourceCommand extends $Command< TagResourceCommandInput, diff --git a/clients/client-organizations/commands/UntagResourceCommand.ts b/clients/client-organizations/commands/UntagResourceCommand.ts index b0e089d3c52e..8490c086d9f1 100644 --- a/clients/client-organizations/commands/UntagResourceCommand.ts +++ b/clients/client-organizations/commands/UntagResourceCommand.ts @@ -38,6 +38,20 @@ export interface UntagResourceCommandOutput extends __MetadataBearer {} * * *

This operation can be called only from the organization's management account.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { OrganizationsClient, UntagResourceCommand } from "@aws-sdk/client-organizations"; // ES Modules import + * // const { OrganizationsClient, UntagResourceCommand } = require("@aws-sdk/client-organizations"); // CommonJS import + * const client = new OrganizationsClient(config); + * const command = new UntagResourceCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link UntagResourceCommandInput} for command's `input` shape. + * @see {@link UntagResourceCommandOutput} for command's `response` shape. + * @see {@link OrganizationsClientResolvedConfig | config} for command's `input` shape. + * */ export class UntagResourceCommand extends $Command< UntagResourceCommandInput, diff --git a/clients/client-organizations/commands/UpdateOrganizationalUnitCommand.ts b/clients/client-organizations/commands/UpdateOrganizationalUnitCommand.ts index 159cfb7e89c1..2c3934717537 100644 --- a/clients/client-organizations/commands/UpdateOrganizationalUnitCommand.ts +++ b/clients/client-organizations/commands/UpdateOrganizationalUnitCommand.ts @@ -25,6 +25,20 @@ export interface UpdateOrganizationalUnitCommandOutput extends UpdateOrganizatio * 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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { OrganizationsClient, UpdateOrganizationalUnitCommand } from "@aws-sdk/client-organizations"; // ES Modules import + * // const { OrganizationsClient, UpdateOrganizationalUnitCommand } = require("@aws-sdk/client-organizations"); // CommonJS import + * const client = new OrganizationsClient(config); + * const command = new UpdateOrganizationalUnitCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link UpdateOrganizationalUnitCommandInput} for command's `input` shape. + * @see {@link UpdateOrganizationalUnitCommandOutput} for command's `response` shape. + * @see {@link OrganizationsClientResolvedConfig | config} for command's `input` shape. + * */ export class UpdateOrganizationalUnitCommand extends $Command< UpdateOrganizationalUnitCommandInput, diff --git a/clients/client-organizations/commands/UpdatePolicyCommand.ts b/clients/client-organizations/commands/UpdatePolicyCommand.ts index f4ecfdd0372d..08f14bc0a5b7 100644 --- a/clients/client-organizations/commands/UpdatePolicyCommand.ts +++ b/clients/client-organizations/commands/UpdatePolicyCommand.ts @@ -25,6 +25,20 @@ export interface UpdatePolicyCommandOutput extends UpdatePolicyResponse, __Metad * 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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { OrganizationsClient, UpdatePolicyCommand } from "@aws-sdk/client-organizations"; // ES Modules import + * // const { OrganizationsClient, UpdatePolicyCommand } = require("@aws-sdk/client-organizations"); // CommonJS import + * const client = new OrganizationsClient(config); + * const command = new UpdatePolicyCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link UpdatePolicyCommandInput} for command's `input` shape. + * @see {@link UpdatePolicyCommandOutput} for command's `response` shape. + * @see {@link OrganizationsClientResolvedConfig | config} for command's `input` shape. + * */ export class UpdatePolicyCommand extends $Command< UpdatePolicyCommandInput, diff --git a/clients/client-organizations/models/models_0.ts b/clients/client-organizations/models/models_0.ts index 327b4d7ba365..e30211c524d7 100644 --- a/clients/client-organizations/models/models_0.ts +++ b/clients/client-organizations/models/models_0.ts @@ -11,6 +11,9 @@ export interface AcceptHandshakeRequest { } export namespace AcceptHandshakeRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: AcceptHandshakeRequest): any => ({ ...obj, }); @@ -47,6 +50,9 @@ export interface HandshakeParty { } export namespace HandshakeParty { + /** + * @internal + */ export const filterSensitiveLog = (obj: HandshakeParty): any => ({ ...obj, ...(obj.Id && { Id: SENSITIVE_STRING }), @@ -87,6 +93,9 @@ export interface AccessDeniedException extends __SmithyException, $MetadataBeare } export namespace AccessDeniedException { + /** + * @internal + */ export const filterSensitiveLog = (obj: AccessDeniedException): any => ({ ...obj, }); @@ -110,6 +119,9 @@ export interface AccessDeniedForDependencyException extends __SmithyException, $ } export namespace AccessDeniedForDependencyException { + /** + * @internal + */ export const filterSensitiveLog = (obj: AccessDeniedForDependencyException): any => ({ ...obj, }); @@ -126,6 +138,9 @@ export interface AWSOrganizationsNotInUseException extends __SmithyException, $M } export namespace AWSOrganizationsNotInUseException { + /** + * @internal + */ export const filterSensitiveLog = (obj: AWSOrganizationsNotInUseException): any => ({ ...obj, }); @@ -142,6 +157,9 @@ export interface ConcurrentModificationException extends __SmithyException, $Met } export namespace ConcurrentModificationException { + /** + * @internal + */ export const filterSensitiveLog = (obj: ConcurrentModificationException): any => ({ ...obj, }); @@ -158,6 +176,9 @@ export interface HandshakeAlreadyInStateException extends __SmithyException, $Me } export namespace HandshakeAlreadyInStateException { + /** + * @internal + */ export const filterSensitiveLog = (obj: HandshakeAlreadyInStateException): any => ({ ...obj, }); @@ -243,6 +264,9 @@ export interface HandshakeConstraintViolationException extends __SmithyException } export namespace HandshakeConstraintViolationException { + /** + * @internal + */ export const filterSensitiveLog = (obj: HandshakeConstraintViolationException): any => ({ ...obj, }); @@ -258,6 +282,9 @@ export interface HandshakeNotFoundException extends __SmithyException, $Metadata } export namespace HandshakeNotFoundException { + /** + * @internal + */ export const filterSensitiveLog = (obj: HandshakeNotFoundException): any => ({ ...obj, }); @@ -275,6 +302,9 @@ export interface InvalidHandshakeTransitionException extends __SmithyException, } export namespace InvalidHandshakeTransitionException { + /** + * @internal + */ export const filterSensitiveLog = (obj: InvalidHandshakeTransitionException): any => ({ ...obj, }); @@ -419,6 +449,9 @@ export interface InvalidInputException extends __SmithyException, $MetadataBeare } export namespace InvalidInputException { + /** + * @internal + */ export const filterSensitiveLog = (obj: InvalidInputException): any => ({ ...obj, }); @@ -435,6 +468,9 @@ export interface ServiceException extends __SmithyException, $MetadataBearer { } export namespace ServiceException { + /** + * @internal + */ export const filterSensitiveLog = (obj: ServiceException): any => ({ ...obj, }); @@ -455,6 +491,9 @@ export interface TooManyRequestsException extends __SmithyException, $MetadataBe } export namespace TooManyRequestsException { + /** + * @internal + */ export const filterSensitiveLog = (obj: TooManyRequestsException): any => ({ ...obj, }); @@ -521,6 +560,9 @@ export interface Account { } export namespace Account { + /** + * @internal + */ export const filterSensitiveLog = (obj: Account): any => ({ ...obj, ...(obj.Email && { Email: SENSITIVE_STRING }), @@ -539,6 +581,9 @@ export interface AccountAlreadyRegisteredException extends __SmithyException, $M } export namespace AccountAlreadyRegisteredException { + /** + * @internal + */ export const filterSensitiveLog = (obj: AccountAlreadyRegisteredException): any => ({ ...obj, }); @@ -556,6 +601,9 @@ export interface AccountNotFoundException extends __SmithyException, $MetadataBe } export namespace AccountNotFoundException { + /** + * @internal + */ export const filterSensitiveLog = (obj: AccountNotFoundException): any => ({ ...obj, }); @@ -571,6 +619,9 @@ export interface AccountNotRegisteredException extends __SmithyException, $Metad } export namespace AccountNotRegisteredException { + /** + * @internal + */ export const filterSensitiveLog = (obj: AccountNotRegisteredException): any => ({ ...obj, }); @@ -590,6 +641,9 @@ export interface AccountOwnerNotVerifiedException extends __SmithyException, $Me } export namespace AccountOwnerNotVerifiedException { + /** + * @internal + */ export const filterSensitiveLog = (obj: AccountOwnerNotVerifiedException): any => ({ ...obj, }); @@ -606,6 +660,9 @@ export interface AlreadyInOrganizationException extends __SmithyException, $Meta } export namespace AlreadyInOrganizationException { + /** + * @internal + */ export const filterSensitiveLog = (obj: AlreadyInOrganizationException): any => ({ ...obj, }); @@ -649,6 +706,9 @@ export interface AttachPolicyRequest { } export namespace AttachPolicyRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: AttachPolicyRequest): any => ({ ...obj, }); @@ -863,6 +923,9 @@ export interface ConstraintViolationException extends __SmithyException, $Metada } export namespace ConstraintViolationException { + /** + * @internal + */ export const filterSensitiveLog = (obj: ConstraintViolationException): any => ({ ...obj, }); @@ -878,6 +941,9 @@ export interface DuplicatePolicyAttachmentException extends __SmithyException, $ } export namespace DuplicatePolicyAttachmentException { + /** + * @internal + */ export const filterSensitiveLog = (obj: DuplicatePolicyAttachmentException): any => ({ ...obj, }); @@ -894,6 +960,9 @@ export interface PolicyChangesInProgressException extends __SmithyException, $Me } export namespace PolicyChangesInProgressException { + /** + * @internal + */ export const filterSensitiveLog = (obj: PolicyChangesInProgressException): any => ({ ...obj, }); @@ -909,6 +978,9 @@ export interface PolicyNotFoundException extends __SmithyException, $MetadataBea } export namespace PolicyNotFoundException { + /** + * @internal + */ export const filterSensitiveLog = (obj: PolicyNotFoundException): any => ({ ...obj, }); @@ -928,6 +1000,9 @@ export interface PolicyTypeNotEnabledException extends __SmithyException, $Metad } export namespace PolicyTypeNotEnabledException { + /** + * @internal + */ export const filterSensitiveLog = (obj: PolicyTypeNotEnabledException): any => ({ ...obj, }); @@ -944,6 +1019,9 @@ export interface TargetNotFoundException extends __SmithyException, $MetadataBea } export namespace TargetNotFoundException { + /** + * @internal + */ export const filterSensitiveLog = (obj: TargetNotFoundException): any => ({ ...obj, }); @@ -959,6 +1037,9 @@ export interface UnsupportedAPIEndpointException extends __SmithyException, $Met } export namespace UnsupportedAPIEndpointException { + /** + * @internal + */ export const filterSensitiveLog = (obj: UnsupportedAPIEndpointException): any => ({ ...obj, }); @@ -975,6 +1056,9 @@ export interface CancelHandshakeRequest { } export namespace CancelHandshakeRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: CancelHandshakeRequest): any => ({ ...obj, }); @@ -1017,6 +1101,9 @@ export interface Tag { } export namespace Tag { + /** + * @internal + */ export const filterSensitiveLog = (obj: Tag): any => ({ ...obj, }); @@ -1094,6 +1181,9 @@ export interface CreateAccountRequest { } export namespace CreateAccountRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateAccountRequest): any => ({ ...obj, ...(obj.Email && { Email: SENSITIVE_STRING }), @@ -1235,6 +1325,9 @@ export interface CreateAccountStatus { } export namespace CreateAccountStatus { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateAccountStatus): any => ({ ...obj, ...(obj.AccountName && { AccountName: SENSITIVE_STRING }), @@ -1255,6 +1348,9 @@ export interface CreateAccountResponse { } export namespace CreateAccountResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateAccountResponse): any => ({ ...obj, ...(obj.CreateAccountStatus && { @@ -1276,6 +1372,9 @@ export interface FinalizingOrganizationException extends __SmithyException, $Met } export namespace FinalizingOrganizationException { + /** + * @internal + */ export const filterSensitiveLog = (obj: FinalizingOrganizationException): any => ({ ...obj, }); @@ -1350,6 +1449,9 @@ export interface CreateGovCloudAccountRequest { } export namespace CreateGovCloudAccountRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateGovCloudAccountRequest): any => ({ ...obj, ...(obj.Email && { Email: SENSITIVE_STRING }), @@ -1366,6 +1468,9 @@ export interface CreateGovCloudAccountResponse { } export namespace CreateGovCloudAccountResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateGovCloudAccountResponse): any => ({ ...obj, ...(obj.CreateAccountStatus && { @@ -1409,6 +1514,9 @@ export interface CreateOrganizationRequest { } export namespace CreateOrganizationRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateOrganizationRequest): any => ({ ...obj, }); @@ -1445,6 +1553,9 @@ export interface PolicyTypeSummary { } export namespace PolicyTypeSummary { + /** + * @internal + */ export const filterSensitiveLog = (obj: PolicyTypeSummary): any => ({ ...obj, }); @@ -1512,6 +1623,9 @@ export interface Organization { } export namespace Organization { + /** + * @internal + */ export const filterSensitiveLog = (obj: Organization): any => ({ ...obj, ...(obj.MasterAccountEmail && { MasterAccountEmail: SENSITIVE_STRING }), @@ -1526,6 +1640,9 @@ export interface CreateOrganizationResponse { } export namespace CreateOrganizationResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateOrganizationResponse): any => ({ ...obj, ...(obj.Organization && { Organization: Organization.filterSensitiveLog(obj.Organization) }), @@ -1574,6 +1691,9 @@ export interface CreateOrganizationalUnitRequest { } export namespace CreateOrganizationalUnitRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateOrganizationalUnitRequest): any => ({ ...obj, }); @@ -1611,6 +1731,9 @@ export interface OrganizationalUnit { } export namespace OrganizationalUnit { + /** + * @internal + */ export const filterSensitiveLog = (obj: OrganizationalUnit): any => ({ ...obj, }); @@ -1624,6 +1747,9 @@ export interface CreateOrganizationalUnitResponse { } export namespace CreateOrganizationalUnitResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateOrganizationalUnitResponse): any => ({ ...obj, }); @@ -1639,6 +1765,9 @@ export interface DuplicateOrganizationalUnitException extends __SmithyException, } export namespace DuplicateOrganizationalUnitException { + /** + * @internal + */ export const filterSensitiveLog = (obj: DuplicateOrganizationalUnitException): any => ({ ...obj, }); @@ -1654,6 +1783,9 @@ export interface ParentNotFoundException extends __SmithyException, $MetadataBea } export namespace ParentNotFoundException { + /** + * @internal + */ export const filterSensitiveLog = (obj: ParentNotFoundException): any => ({ ...obj, }); @@ -1721,6 +1853,9 @@ export interface CreatePolicyRequest { } export namespace CreatePolicyRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreatePolicyRequest): any => ({ ...obj, }); @@ -1772,6 +1907,9 @@ export interface PolicySummary { } export namespace PolicySummary { + /** + * @internal + */ export const filterSensitiveLog = (obj: PolicySummary): any => ({ ...obj, }); @@ -1795,6 +1933,9 @@ export interface Policy { } export namespace Policy { + /** + * @internal + */ export const filterSensitiveLog = (obj: Policy): any => ({ ...obj, }); @@ -1808,6 +1949,9 @@ export interface CreatePolicyResponse { } export namespace CreatePolicyResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreatePolicyResponse): any => ({ ...obj, }); @@ -1823,6 +1967,9 @@ export interface DuplicatePolicyException extends __SmithyException, $MetadataBe } export namespace DuplicatePolicyException { + /** + * @internal + */ export const filterSensitiveLog = (obj: DuplicatePolicyException): any => ({ ...obj, }); @@ -1842,6 +1989,9 @@ export interface MalformedPolicyDocumentException extends __SmithyException, $Me } export namespace MalformedPolicyDocumentException { + /** + * @internal + */ export const filterSensitiveLog = (obj: MalformedPolicyDocumentException): any => ({ ...obj, }); @@ -1861,6 +2011,9 @@ export interface PolicyTypeNotAvailableForOrganizationException extends __Smithy } export namespace PolicyTypeNotAvailableForOrganizationException { + /** + * @internal + */ export const filterSensitiveLog = (obj: PolicyTypeNotAvailableForOrganizationException): any => ({ ...obj, }); @@ -1877,6 +2030,9 @@ export interface DeclineHandshakeRequest { } export namespace DeclineHandshakeRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeclineHandshakeRequest): any => ({ ...obj, }); @@ -1893,6 +2049,9 @@ export interface OrganizationNotEmptyException extends __SmithyException, $Metad } export namespace OrganizationNotEmptyException { + /** + * @internal + */ export const filterSensitiveLog = (obj: OrganizationNotEmptyException): any => ({ ...obj, }); @@ -1911,6 +2070,9 @@ export interface DeleteOrganizationalUnitRequest { } export namespace DeleteOrganizationalUnitRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteOrganizationalUnitRequest): any => ({ ...obj, }); @@ -1927,6 +2089,9 @@ export interface OrganizationalUnitNotEmptyException extends __SmithyException, } export namespace OrganizationalUnitNotEmptyException { + /** + * @internal + */ export const filterSensitiveLog = (obj: OrganizationalUnitNotEmptyException): any => ({ ...obj, }); @@ -1943,6 +2108,9 @@ export interface OrganizationalUnitNotFoundException extends __SmithyException, } export namespace OrganizationalUnitNotFoundException { + /** + * @internal + */ export const filterSensitiveLog = (obj: OrganizationalUnitNotFoundException): any => ({ ...obj, }); @@ -1960,6 +2128,9 @@ export interface DeletePolicyRequest { } export namespace DeletePolicyRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeletePolicyRequest): any => ({ ...obj, }); @@ -1976,6 +2147,9 @@ export interface PolicyInUseException extends __SmithyException, $MetadataBearer } export namespace PolicyInUseException { + /** + * @internal + */ export const filterSensitiveLog = (obj: PolicyInUseException): any => ({ ...obj, }); @@ -2000,6 +2174,9 @@ export interface DeregisterDelegatedAdministratorRequest { } export namespace DeregisterDelegatedAdministratorRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeregisterDelegatedAdministratorRequest): any => ({ ...obj, }); @@ -2016,6 +2193,9 @@ export interface DescribeAccountRequest { } export namespace DescribeAccountRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeAccountRequest): any => ({ ...obj, }); @@ -2029,6 +2209,9 @@ export interface DescribeAccountResponse { } export namespace DescribeAccountResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeAccountResponse): any => ({ ...obj, ...(obj.Account && { Account: Account.filterSensitiveLog(obj.Account) }), @@ -2046,6 +2229,9 @@ export interface CreateAccountStatusNotFoundException extends __SmithyException, } export namespace CreateAccountStatusNotFoundException { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateAccountStatusNotFoundException): any => ({ ...obj, }); @@ -2063,6 +2249,9 @@ export interface DescribeCreateAccountStatusRequest { } export namespace DescribeCreateAccountStatusRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeCreateAccountStatusRequest): any => ({ ...obj, }); @@ -2076,6 +2265,9 @@ export interface DescribeCreateAccountStatusResponse { } export namespace DescribeCreateAccountStatusResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeCreateAccountStatusResponse): any => ({ ...obj, ...(obj.CreateAccountStatus && { @@ -2123,6 +2315,9 @@ export interface DescribeEffectivePolicyRequest { } export namespace DescribeEffectivePolicyRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeEffectivePolicyRequest): any => ({ ...obj, }); @@ -2156,6 +2351,9 @@ export interface EffectivePolicy { } export namespace EffectivePolicy { + /** + * @internal + */ export const filterSensitiveLog = (obj: EffectivePolicy): any => ({ ...obj, }); @@ -2169,6 +2367,9 @@ export interface DescribeEffectivePolicyResponse { } export namespace DescribeEffectivePolicyResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeEffectivePolicyResponse): any => ({ ...obj, }); @@ -2187,6 +2388,9 @@ export interface EffectivePolicyNotFoundException extends __SmithyException, $Me } export namespace EffectivePolicyNotFoundException { + /** + * @internal + */ export const filterSensitiveLog = (obj: EffectivePolicyNotFoundException): any => ({ ...obj, }); @@ -2204,6 +2408,9 @@ export interface DescribeHandshakeRequest { } export namespace DescribeHandshakeRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeHandshakeRequest): any => ({ ...obj, }); @@ -2225,6 +2432,9 @@ export interface DescribeOrganizationResponse { } export namespace DescribeOrganizationResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeOrganizationResponse): any => ({ ...obj, ...(obj.Organization && { Organization: Organization.filterSensitiveLog(obj.Organization) }), @@ -2245,6 +2455,9 @@ export interface DescribeOrganizationalUnitRequest { } export namespace DescribeOrganizationalUnitRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeOrganizationalUnitRequest): any => ({ ...obj, }); @@ -2258,6 +2471,9 @@ export interface DescribeOrganizationalUnitResponse { } export namespace DescribeOrganizationalUnitResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeOrganizationalUnitResponse): any => ({ ...obj, }); @@ -2275,6 +2491,9 @@ export interface DescribePolicyRequest { } export namespace DescribePolicyRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribePolicyRequest): any => ({ ...obj, }); @@ -2288,6 +2507,9 @@ export interface DescribePolicyResponse { } export namespace DescribePolicyResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribePolicyResponse): any => ({ ...obj, }); @@ -2331,6 +2553,9 @@ export interface DetachPolicyRequest { } export namespace DetachPolicyRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DetachPolicyRequest): any => ({ ...obj, }); @@ -2346,6 +2571,9 @@ export interface PolicyNotAttachedException extends __SmithyException, $Metadata } export namespace PolicyNotAttachedException { + /** + * @internal + */ export const filterSensitiveLog = (obj: PolicyNotAttachedException): any => ({ ...obj, }); @@ -2362,6 +2590,9 @@ export interface DisableAWSServiceAccessRequest { } export namespace DisableAWSServiceAccessRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DisableAWSServiceAccessRequest): any => ({ ...obj, }); @@ -2406,6 +2637,9 @@ export interface DisablePolicyTypeRequest { } export namespace DisablePolicyTypeRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DisablePolicyTypeRequest): any => ({ ...obj, }); @@ -2453,6 +2687,9 @@ export interface Root { } export namespace Root { + /** + * @internal + */ export const filterSensitiveLog = (obj: Root): any => ({ ...obj, }); @@ -2466,6 +2703,9 @@ export interface DisablePolicyTypeResponse { } export namespace DisablePolicyTypeResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DisablePolicyTypeResponse): any => ({ ...obj, }); @@ -2481,6 +2721,9 @@ export interface RootNotFoundException extends __SmithyException, $MetadataBeare } export namespace RootNotFoundException { + /** + * @internal + */ export const filterSensitiveLog = (obj: RootNotFoundException): any => ({ ...obj, }); @@ -2489,6 +2732,9 @@ export namespace RootNotFoundException { export interface EnableAllFeaturesRequest {} export namespace EnableAllFeaturesRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: EnableAllFeaturesRequest): any => ({ ...obj, }); @@ -2505,6 +2751,9 @@ export interface EnableAWSServiceAccessRequest { } export namespace EnableAWSServiceAccessRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: EnableAWSServiceAccessRequest): any => ({ ...obj, }); @@ -2549,6 +2798,9 @@ export interface EnablePolicyTypeRequest { } export namespace EnablePolicyTypeRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: EnablePolicyTypeRequest): any => ({ ...obj, }); @@ -2562,6 +2814,9 @@ export interface EnablePolicyTypeResponse { } export namespace EnablePolicyTypeResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: EnablePolicyTypeResponse): any => ({ ...obj, }); @@ -2577,6 +2832,9 @@ export interface PolicyTypeAlreadyEnabledException extends __SmithyException, $M } export namespace PolicyTypeAlreadyEnabledException { + /** + * @internal + */ export const filterSensitiveLog = (obj: PolicyTypeAlreadyEnabledException): any => ({ ...obj, }); @@ -2596,6 +2854,9 @@ export interface DuplicateHandshakeException extends __SmithyException, $Metadat } export namespace DuplicateHandshakeException { + /** + * @internal + */ export const filterSensitiveLog = (obj: DuplicateHandshakeException): any => ({ ...obj, }); @@ -2657,6 +2918,9 @@ export interface InviteAccountToOrganizationRequest { } export namespace InviteAccountToOrganizationRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: InviteAccountToOrganizationRequest): any => ({ ...obj, ...(obj.Target && { Target: HandshakeParty.filterSensitiveLog(obj.Target) }), @@ -2676,6 +2940,9 @@ export interface MasterCannotLeaveOrganizationException extends __SmithyExceptio } export namespace MasterCannotLeaveOrganizationException { + /** + * @internal + */ export const filterSensitiveLog = (obj: MasterCannotLeaveOrganizationException): any => ({ ...obj, }); @@ -2705,6 +2972,9 @@ export interface ListAccountsRequest { } export namespace ListAccountsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListAccountsRequest): any => ({ ...obj, }); @@ -2726,6 +2996,9 @@ export interface ListAccountsResponse { } export namespace ListAccountsResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListAccountsResponse): any => ({ ...obj, ...(obj.Accounts && { Accounts: obj.Accounts.map((item) => Account.filterSensitiveLog(item)) }), @@ -2762,6 +3035,9 @@ export interface ListAccountsForParentRequest { } export namespace ListAccountsForParentRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListAccountsForParentRequest): any => ({ ...obj, }); @@ -2783,6 +3059,9 @@ export interface ListAccountsForParentResponse { } export namespace ListAccountsForParentResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListAccountsForParentResponse): any => ({ ...obj, ...(obj.Accounts && { Accounts: obj.Accounts.map((item) => Account.filterSensitiveLog(item)) }), @@ -2813,6 +3092,9 @@ export interface ListAWSServiceAccessForOrganizationRequest { } export namespace ListAWSServiceAccessForOrganizationRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListAWSServiceAccessForOrganizationRequest): any => ({ ...obj, }); @@ -2837,6 +3119,9 @@ export interface EnabledServicePrincipal { } export namespace EnabledServicePrincipal { + /** + * @internal + */ export const filterSensitiveLog = (obj: EnabledServicePrincipal): any => ({ ...obj, }); @@ -2860,6 +3145,9 @@ export interface ListAWSServiceAccessForOrganizationResponse { } export namespace ListAWSServiceAccessForOrganizationResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListAWSServiceAccessForOrganizationResponse): any => ({ ...obj, }); @@ -2920,6 +3208,9 @@ export interface ListChildrenRequest { } export namespace ListChildrenRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListChildrenRequest): any => ({ ...obj, }); @@ -2956,6 +3247,9 @@ export interface Child { } export namespace Child { + /** + * @internal + */ export const filterSensitiveLog = (obj: Child): any => ({ ...obj, }); @@ -2977,6 +3271,9 @@ export interface ListChildrenResponse { } export namespace ListChildrenResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListChildrenResponse): any => ({ ...obj, }); @@ -3012,6 +3309,9 @@ export interface ListCreateAccountStatusRequest { } export namespace ListCreateAccountStatusRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListCreateAccountStatusRequest): any => ({ ...obj, }); @@ -3035,6 +3335,9 @@ export interface ListCreateAccountStatusResponse { } export namespace ListCreateAccountStatusResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListCreateAccountStatusResponse): any => ({ ...obj, ...(obj.CreateAccountStatuses && { @@ -3075,6 +3378,9 @@ export interface ListDelegatedAdministratorsRequest { } export namespace ListDelegatedAdministratorsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListDelegatedAdministratorsRequest): any => ({ ...obj, }); @@ -3129,6 +3435,9 @@ export interface DelegatedAdministrator { } export namespace DelegatedAdministrator { + /** + * @internal + */ export const filterSensitiveLog = (obj: DelegatedAdministrator): any => ({ ...obj, ...(obj.Email && { Email: SENSITIVE_STRING }), @@ -3152,6 +3461,9 @@ export interface ListDelegatedAdministratorsResponse { } export namespace ListDelegatedAdministratorsResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListDelegatedAdministratorsResponse): any => ({ ...obj, ...(obj.DelegatedAdministrators && { @@ -3191,6 +3503,9 @@ export interface ListDelegatedServicesForAccountRequest { } export namespace ListDelegatedServicesForAccountRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListDelegatedServicesForAccountRequest): any => ({ ...obj, }); @@ -3216,6 +3531,9 @@ export interface DelegatedService { } export namespace DelegatedService { + /** + * @internal + */ export const filterSensitiveLog = (obj: DelegatedService): any => ({ ...obj, }); @@ -3237,6 +3555,9 @@ export interface ListDelegatedServicesForAccountResponse { } export namespace ListDelegatedServicesForAccountResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListDelegatedServicesForAccountResponse): any => ({ ...obj, }); @@ -3266,6 +3587,9 @@ export interface HandshakeFilter { } export namespace HandshakeFilter { + /** + * @internal + */ export const filterSensitiveLog = (obj: HandshakeFilter): any => ({ ...obj, }); @@ -3306,6 +3630,9 @@ export interface ListHandshakesForAccountRequest { } export namespace ListHandshakesForAccountRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListHandshakesForAccountRequest): any => ({ ...obj, }); @@ -3346,6 +3673,9 @@ export interface ListHandshakesForOrganizationRequest { } export namespace ListHandshakesForOrganizationRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListHandshakesForOrganizationRequest): any => ({ ...obj, }); @@ -3395,6 +3725,9 @@ export interface ListOrganizationalUnitsForParentRequest { } export namespace ListOrganizationalUnitsForParentRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListOrganizationalUnitsForParentRequest): any => ({ ...obj, }); @@ -3416,6 +3749,9 @@ export interface ListOrganizationalUnitsForParentResponse { } export namespace ListOrganizationalUnitsForParentResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListOrganizationalUnitsForParentResponse): any => ({ ...obj, }); @@ -3432,6 +3768,9 @@ export interface ChildNotFoundException extends __SmithyException, $MetadataBear } export namespace ChildNotFoundException { + /** + * @internal + */ export const filterSensitiveLog = (obj: ChildNotFoundException): any => ({ ...obj, }); @@ -3482,6 +3821,9 @@ export interface ListParentsRequest { } export namespace ListParentsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListParentsRequest): any => ({ ...obj, }); @@ -3524,6 +3866,9 @@ export interface Parent { } export namespace Parent { + /** + * @internal + */ export const filterSensitiveLog = (obj: Parent): any => ({ ...obj, }); @@ -3545,6 +3890,9 @@ export interface ListParentsResponse { } export namespace ListParentsResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListParentsResponse): any => ({ ...obj, }); @@ -3602,6 +3950,9 @@ export interface ListPoliciesRequest { } export namespace ListPoliciesRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListPoliciesRequest): any => ({ ...obj, }); @@ -3624,6 +3975,9 @@ export interface ListPoliciesResponse { } export namespace ListPoliciesResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListPoliciesResponse): any => ({ ...obj, }); @@ -3706,6 +4060,9 @@ export interface ListPoliciesForTargetRequest { } export namespace ListPoliciesForTargetRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListPoliciesForTargetRequest): any => ({ ...obj, }); @@ -3727,6 +4084,9 @@ export interface ListPoliciesForTargetResponse { } export namespace ListPoliciesForTargetResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListPoliciesForTargetResponse): any => ({ ...obj, }); @@ -3756,6 +4116,9 @@ export interface ListRootsRequest { } export namespace ListRootsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListRootsRequest): any => ({ ...obj, }); @@ -3777,6 +4140,9 @@ export interface ListRootsResponse { } export namespace ListRootsResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListRootsResponse): any => ({ ...obj, }); @@ -3823,6 +4189,9 @@ export interface ListTagsForResourceRequest { } export namespace ListTagsForResourceRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListTagsForResourceRequest): any => ({ ...obj, }); @@ -3844,6 +4213,9 @@ export interface ListTagsForResourceResponse { } export namespace ListTagsForResourceResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListTagsForResourceResponse): any => ({ ...obj, }); @@ -3880,6 +4252,9 @@ export interface ListTargetsForPolicyRequest { } export namespace ListTargetsForPolicyRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListTargetsForPolicyRequest): any => ({ ...obj, }); @@ -3941,6 +4316,9 @@ export interface PolicyTargetSummary { } export namespace PolicyTargetSummary { + /** + * @internal + */ export const filterSensitiveLog = (obj: PolicyTargetSummary): any => ({ ...obj, }); @@ -3963,6 +4341,9 @@ export interface ListTargetsForPolicyResponse { } export namespace ListTargetsForPolicyResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListTargetsForPolicyResponse): any => ({ ...obj, }); @@ -3979,6 +4360,9 @@ export interface DestinationParentNotFoundException extends __SmithyException, $ } export namespace DestinationParentNotFoundException { + /** + * @internal + */ export const filterSensitiveLog = (obj: DestinationParentNotFoundException): any => ({ ...obj, }); @@ -3994,6 +4378,9 @@ export interface DuplicateAccountException extends __SmithyException, $MetadataB } export namespace DuplicateAccountException { + /** + * @internal + */ export const filterSensitiveLog = (obj: DuplicateAccountException): any => ({ ...obj, }); @@ -4051,6 +4438,9 @@ export interface MoveAccountRequest { } export namespace MoveAccountRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: MoveAccountRequest): any => ({ ...obj, }); @@ -4067,6 +4457,9 @@ export interface SourceParentNotFoundException extends __SmithyException, $Metad } export namespace SourceParentNotFoundException { + /** + * @internal + */ export const filterSensitiveLog = (obj: SourceParentNotFoundException): any => ({ ...obj, }); @@ -4087,6 +4480,9 @@ export interface RegisterDelegatedAdministratorRequest { } export namespace RegisterDelegatedAdministratorRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: RegisterDelegatedAdministratorRequest): any => ({ ...obj, }); @@ -4103,6 +4499,9 @@ export interface RemoveAccountFromOrganizationRequest { } export namespace RemoveAccountFromOrganizationRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: RemoveAccountFromOrganizationRequest): any => ({ ...obj, }); @@ -4152,6 +4551,9 @@ export interface TagResourceRequest { } export namespace TagResourceRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: TagResourceRequest): any => ({ ...obj, }); @@ -4194,6 +4596,9 @@ export interface UntagResourceRequest { } export namespace UntagResourceRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: UntagResourceRequest): any => ({ ...obj, }); @@ -4220,6 +4625,9 @@ export interface UpdateOrganizationalUnitRequest { } export namespace UpdateOrganizationalUnitRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateOrganizationalUnitRequest): any => ({ ...obj, }); @@ -4234,6 +4642,9 @@ export interface UpdateOrganizationalUnitResponse { } export namespace UpdateOrganizationalUnitResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateOrganizationalUnitResponse): any => ({ ...obj, }); @@ -4270,6 +4681,9 @@ export interface UpdatePolicyRequest { } export namespace UpdatePolicyRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdatePolicyRequest): any => ({ ...obj, }); @@ -4284,6 +4698,9 @@ export interface UpdatePolicyResponse { } export namespace UpdatePolicyResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdatePolicyResponse): any => ({ ...obj, }); @@ -4343,6 +4760,9 @@ export interface HandshakeResource { } export namespace HandshakeResource { + /** + * @internal + */ export const filterSensitiveLog = (obj: HandshakeResource): any => ({ ...obj, ...(obj.Value && { Value: SENSITIVE_STRING }), @@ -4475,6 +4895,9 @@ export interface Handshake { } export namespace Handshake { + /** + * @internal + */ export const filterSensitiveLog = (obj: Handshake): any => ({ ...obj, ...(obj.Parties && { Parties: obj.Parties.map((item) => HandshakeParty.filterSensitiveLog(item)) }), @@ -4490,6 +4913,9 @@ export interface AcceptHandshakeResponse { } export namespace AcceptHandshakeResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: AcceptHandshakeResponse): any => ({ ...obj, ...(obj.Handshake && { Handshake: Handshake.filterSensitiveLog(obj.Handshake) }), @@ -4504,6 +4930,9 @@ export interface CancelHandshakeResponse { } export namespace CancelHandshakeResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: CancelHandshakeResponse): any => ({ ...obj, ...(obj.Handshake && { Handshake: Handshake.filterSensitiveLog(obj.Handshake) }), @@ -4519,6 +4948,9 @@ export interface DeclineHandshakeResponse { } export namespace DeclineHandshakeResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeclineHandshakeResponse): any => ({ ...obj, ...(obj.Handshake && { Handshake: Handshake.filterSensitiveLog(obj.Handshake) }), @@ -4533,6 +4965,9 @@ export interface DescribeHandshakeResponse { } export namespace DescribeHandshakeResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeHandshakeResponse): any => ({ ...obj, ...(obj.Handshake && { Handshake: Handshake.filterSensitiveLog(obj.Handshake) }), @@ -4548,6 +4983,9 @@ export interface EnableAllFeaturesResponse { } export namespace EnableAllFeaturesResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: EnableAllFeaturesResponse): any => ({ ...obj, ...(obj.Handshake && { Handshake: Handshake.filterSensitiveLog(obj.Handshake) }), @@ -4563,6 +5001,9 @@ export interface InviteAccountToOrganizationResponse { } export namespace InviteAccountToOrganizationResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: InviteAccountToOrganizationResponse): any => ({ ...obj, ...(obj.Handshake && { Handshake: Handshake.filterSensitiveLog(obj.Handshake) }), @@ -4586,6 +5027,9 @@ export interface ListHandshakesForAccountResponse { } export namespace ListHandshakesForAccountResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListHandshakesForAccountResponse): any => ({ ...obj, }); @@ -4608,6 +5052,9 @@ export interface ListHandshakesForOrganizationResponse { } export namespace ListHandshakesForOrganizationResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListHandshakesForOrganizationResponse): any => ({ ...obj, }); diff --git a/clients/client-outposts/commands/CreateOutpostCommand.ts b/clients/client-outposts/commands/CreateOutpostCommand.ts index 48af597b7ada..d83cff1fb212 100644 --- a/clients/client-outposts/commands/CreateOutpostCommand.ts +++ b/clients/client-outposts/commands/CreateOutpostCommand.ts @@ -22,6 +22,20 @@ export interface CreateOutpostCommandOutput extends CreateOutpostOutput, __Metad /** *

Creates an Outpost.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { OutpostsClient, CreateOutpostCommand } from "@aws-sdk/client-outposts"; // ES Modules import + * // const { OutpostsClient, CreateOutpostCommand } = require("@aws-sdk/client-outposts"); // CommonJS import + * const client = new OutpostsClient(config); + * const command = new CreateOutpostCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreateOutpostCommandInput} for command's `input` shape. + * @see {@link CreateOutpostCommandOutput} for command's `response` shape. + * @see {@link OutpostsClientResolvedConfig | config} for command's `input` shape. + * */ export class CreateOutpostCommand extends $Command< CreateOutpostCommandInput, diff --git a/clients/client-outposts/commands/DeleteOutpostCommand.ts b/clients/client-outposts/commands/DeleteOutpostCommand.ts index bf6f3d2bd5f5..38428386e58d 100644 --- a/clients/client-outposts/commands/DeleteOutpostCommand.ts +++ b/clients/client-outposts/commands/DeleteOutpostCommand.ts @@ -22,6 +22,20 @@ export interface DeleteOutpostCommandOutput extends DeleteOutpostOutput, __Metad /** *

Deletes the Outpost.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { OutpostsClient, DeleteOutpostCommand } from "@aws-sdk/client-outposts"; // ES Modules import + * // const { OutpostsClient, DeleteOutpostCommand } = require("@aws-sdk/client-outposts"); // CommonJS import + * const client = new OutpostsClient(config); + * const command = new DeleteOutpostCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteOutpostCommandInput} for command's `input` shape. + * @see {@link DeleteOutpostCommandOutput} for command's `response` shape. + * @see {@link OutpostsClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteOutpostCommand extends $Command< DeleteOutpostCommandInput, diff --git a/clients/client-outposts/commands/DeleteSiteCommand.ts b/clients/client-outposts/commands/DeleteSiteCommand.ts index c8fc3754da51..af47e006079f 100644 --- a/clients/client-outposts/commands/DeleteSiteCommand.ts +++ b/clients/client-outposts/commands/DeleteSiteCommand.ts @@ -22,6 +22,20 @@ export interface DeleteSiteCommandOutput extends DeleteSiteOutput, __MetadataBea /** *

Deletes the site.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { OutpostsClient, DeleteSiteCommand } from "@aws-sdk/client-outposts"; // ES Modules import + * // const { OutpostsClient, DeleteSiteCommand } = require("@aws-sdk/client-outposts"); // CommonJS import + * const client = new OutpostsClient(config); + * const command = new DeleteSiteCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteSiteCommandInput} for command's `input` shape. + * @see {@link DeleteSiteCommandOutput} for command's `response` shape. + * @see {@link OutpostsClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteSiteCommand extends $Command< DeleteSiteCommandInput, diff --git a/clients/client-outposts/commands/GetOutpostCommand.ts b/clients/client-outposts/commands/GetOutpostCommand.ts index 7e24adfb33f9..a24e05cba413 100644 --- a/clients/client-outposts/commands/GetOutpostCommand.ts +++ b/clients/client-outposts/commands/GetOutpostCommand.ts @@ -22,6 +22,20 @@ export interface GetOutpostCommandOutput extends GetOutpostOutput, __MetadataBea /** *

Gets information about the specified Outpost.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { OutpostsClient, GetOutpostCommand } from "@aws-sdk/client-outposts"; // ES Modules import + * // const { OutpostsClient, GetOutpostCommand } = require("@aws-sdk/client-outposts"); // CommonJS import + * const client = new OutpostsClient(config); + * const command = new GetOutpostCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetOutpostCommandInput} for command's `input` shape. + * @see {@link GetOutpostCommandOutput} for command's `response` shape. + * @see {@link OutpostsClientResolvedConfig | config} for command's `input` shape. + * */ export class GetOutpostCommand extends $Command< GetOutpostCommandInput, diff --git a/clients/client-outposts/commands/GetOutpostInstanceTypesCommand.ts b/clients/client-outposts/commands/GetOutpostInstanceTypesCommand.ts index a67834adc2ea..24729f4d534d 100644 --- a/clients/client-outposts/commands/GetOutpostInstanceTypesCommand.ts +++ b/clients/client-outposts/commands/GetOutpostInstanceTypesCommand.ts @@ -22,6 +22,20 @@ export interface GetOutpostInstanceTypesCommandOutput extends GetOutpostInstance /** *

Lists the instance types for the specified Outpost.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { OutpostsClient, GetOutpostInstanceTypesCommand } from "@aws-sdk/client-outposts"; // ES Modules import + * // const { OutpostsClient, GetOutpostInstanceTypesCommand } = require("@aws-sdk/client-outposts"); // CommonJS import + * const client = new OutpostsClient(config); + * const command = new GetOutpostInstanceTypesCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetOutpostInstanceTypesCommandInput} for command's `input` shape. + * @see {@link GetOutpostInstanceTypesCommandOutput} for command's `response` shape. + * @see {@link OutpostsClientResolvedConfig | config} for command's `input` shape. + * */ export class GetOutpostInstanceTypesCommand extends $Command< GetOutpostInstanceTypesCommandInput, diff --git a/clients/client-outposts/commands/ListOutpostsCommand.ts b/clients/client-outposts/commands/ListOutpostsCommand.ts index fbea3bcaf1be..03430c9b9071 100644 --- a/clients/client-outposts/commands/ListOutpostsCommand.ts +++ b/clients/client-outposts/commands/ListOutpostsCommand.ts @@ -22,6 +22,20 @@ export interface ListOutpostsCommandOutput extends ListOutpostsOutput, __Metadat /** *

List the Outposts for your AWS account.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { OutpostsClient, ListOutpostsCommand } from "@aws-sdk/client-outposts"; // ES Modules import + * // const { OutpostsClient, ListOutpostsCommand } = require("@aws-sdk/client-outposts"); // CommonJS import + * const client = new OutpostsClient(config); + * const command = new ListOutpostsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListOutpostsCommandInput} for command's `input` shape. + * @see {@link ListOutpostsCommandOutput} for command's `response` shape. + * @see {@link OutpostsClientResolvedConfig | config} for command's `input` shape. + * */ export class ListOutpostsCommand extends $Command< ListOutpostsCommandInput, diff --git a/clients/client-outposts/commands/ListSitesCommand.ts b/clients/client-outposts/commands/ListSitesCommand.ts index 2de3e9093c88..5c9d648d7032 100644 --- a/clients/client-outposts/commands/ListSitesCommand.ts +++ b/clients/client-outposts/commands/ListSitesCommand.ts @@ -22,6 +22,20 @@ export interface ListSitesCommandOutput extends ListSitesOutput, __MetadataBeare /** *

Lists the sites for the specified AWS account.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { OutpostsClient, ListSitesCommand } from "@aws-sdk/client-outposts"; // ES Modules import + * // const { OutpostsClient, ListSitesCommand } = require("@aws-sdk/client-outposts"); // CommonJS import + * const client = new OutpostsClient(config); + * const command = new ListSitesCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListSitesCommandInput} for command's `input` shape. + * @see {@link ListSitesCommandOutput} for command's `response` shape. + * @see {@link OutpostsClientResolvedConfig | config} for command's `input` shape. + * */ export class ListSitesCommand extends $Command< ListSitesCommandInput, diff --git a/clients/client-outposts/commands/ListTagsForResourceCommand.ts b/clients/client-outposts/commands/ListTagsForResourceCommand.ts index 693f84d7b6fc..dd75c09a35b1 100644 --- a/clients/client-outposts/commands/ListTagsForResourceCommand.ts +++ b/clients/client-outposts/commands/ListTagsForResourceCommand.ts @@ -22,6 +22,20 @@ export interface ListTagsForResourceCommandOutput extends ListTagsForResourceRes /** *

Lists the tags for the specified resource.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { OutpostsClient, ListTagsForResourceCommand } from "@aws-sdk/client-outposts"; // ES Modules import + * // const { OutpostsClient, ListTagsForResourceCommand } = require("@aws-sdk/client-outposts"); // CommonJS import + * const client = new OutpostsClient(config); + * const command = new ListTagsForResourceCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListTagsForResourceCommandInput} for command's `input` shape. + * @see {@link ListTagsForResourceCommandOutput} for command's `response` shape. + * @see {@link OutpostsClientResolvedConfig | config} for command's `input` shape. + * */ export class ListTagsForResourceCommand extends $Command< ListTagsForResourceCommandInput, diff --git a/clients/client-outposts/commands/TagResourceCommand.ts b/clients/client-outposts/commands/TagResourceCommand.ts index a3e2fe779070..5d38c411ae46 100644 --- a/clients/client-outposts/commands/TagResourceCommand.ts +++ b/clients/client-outposts/commands/TagResourceCommand.ts @@ -22,6 +22,20 @@ export interface TagResourceCommandOutput extends TagResourceResponse, __Metadat /** *

Adds tags to the specified resource.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { OutpostsClient, TagResourceCommand } from "@aws-sdk/client-outposts"; // ES Modules import + * // const { OutpostsClient, TagResourceCommand } = require("@aws-sdk/client-outposts"); // CommonJS import + * const client = new OutpostsClient(config); + * const command = new TagResourceCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link TagResourceCommandInput} for command's `input` shape. + * @see {@link TagResourceCommandOutput} for command's `response` shape. + * @see {@link OutpostsClientResolvedConfig | config} for command's `input` shape. + * */ export class TagResourceCommand extends $Command< TagResourceCommandInput, diff --git a/clients/client-outposts/commands/UntagResourceCommand.ts b/clients/client-outposts/commands/UntagResourceCommand.ts index 19904da90e71..a876c2a9d9c3 100644 --- a/clients/client-outposts/commands/UntagResourceCommand.ts +++ b/clients/client-outposts/commands/UntagResourceCommand.ts @@ -22,6 +22,20 @@ export interface UntagResourceCommandOutput extends UntagResourceResponse, __Met /** *

Removes tags from the specified resource.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { OutpostsClient, UntagResourceCommand } from "@aws-sdk/client-outposts"; // ES Modules import + * // const { OutpostsClient, UntagResourceCommand } = require("@aws-sdk/client-outposts"); // CommonJS import + * const client = new OutpostsClient(config); + * const command = new UntagResourceCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link UntagResourceCommandInput} for command's `input` shape. + * @see {@link UntagResourceCommandOutput} for command's `response` shape. + * @see {@link OutpostsClientResolvedConfig | config} for command's `input` shape. + * */ export class UntagResourceCommand extends $Command< UntagResourceCommandInput, diff --git a/clients/client-outposts/models/models_0.ts b/clients/client-outposts/models/models_0.ts index 798c78ebcca9..fb572d64576b 100644 --- a/clients/client-outposts/models/models_0.ts +++ b/clients/client-outposts/models/models_0.ts @@ -11,6 +11,9 @@ export interface AccessDeniedException extends __SmithyException, $MetadataBeare } export namespace AccessDeniedException { + /** + * @internal + */ export const filterSensitiveLog = (obj: AccessDeniedException): any => ({ ...obj, }); @@ -51,6 +54,9 @@ export interface CreateOutpostInput { } export namespace CreateOutpostInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateOutpostInput): any => ({ ...obj, }); @@ -114,6 +120,9 @@ export interface Outpost { } export namespace Outpost { + /** + * @internal + */ export const filterSensitiveLog = (obj: Outpost): any => ({ ...obj, }); @@ -127,6 +136,9 @@ export interface CreateOutpostOutput { } export namespace CreateOutpostOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateOutpostOutput): any => ({ ...obj, }); @@ -142,6 +154,9 @@ export interface InternalServerException extends __SmithyException, $MetadataBea } export namespace InternalServerException { + /** + * @internal + */ export const filterSensitiveLog = (obj: InternalServerException): any => ({ ...obj, }); @@ -157,6 +172,9 @@ export interface NotFoundException extends __SmithyException, $MetadataBearer { } export namespace NotFoundException { + /** + * @internal + */ export const filterSensitiveLog = (obj: NotFoundException): any => ({ ...obj, }); @@ -172,6 +190,9 @@ export interface ServiceQuotaExceededException extends __SmithyException, $Metad } export namespace ServiceQuotaExceededException { + /** + * @internal + */ export const filterSensitiveLog = (obj: ServiceQuotaExceededException): any => ({ ...obj, }); @@ -187,6 +208,9 @@ export interface ValidationException extends __SmithyException, $MetadataBearer } export namespace ValidationException { + /** + * @internal + */ export const filterSensitiveLog = (obj: ValidationException): any => ({ ...obj, }); @@ -200,6 +224,9 @@ export interface DeleteOutpostInput { } export namespace DeleteOutpostInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteOutpostInput): any => ({ ...obj, }); @@ -208,6 +235,9 @@ export namespace DeleteOutpostInput { export interface DeleteOutpostOutput {} export namespace DeleteOutpostOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteOutpostOutput): any => ({ ...obj, }); @@ -221,6 +251,9 @@ export interface DeleteSiteInput { } export namespace DeleteSiteInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteSiteInput): any => ({ ...obj, }); @@ -229,6 +262,9 @@ export namespace DeleteSiteInput { export interface DeleteSiteOutput {} export namespace DeleteSiteOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteSiteOutput): any => ({ ...obj, }); @@ -242,6 +278,9 @@ export interface GetOutpostInput { } export namespace GetOutpostInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetOutpostInput): any => ({ ...obj, }); @@ -255,6 +294,9 @@ export interface GetOutpostOutput { } export namespace GetOutpostOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetOutpostOutput): any => ({ ...obj, }); @@ -278,6 +320,9 @@ export interface GetOutpostInstanceTypesInput { } export namespace GetOutpostInstanceTypesInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetOutpostInstanceTypesInput): any => ({ ...obj, }); @@ -294,6 +339,9 @@ export interface InstanceTypeItem { } export namespace InstanceTypeItem { + /** + * @internal + */ export const filterSensitiveLog = (obj: InstanceTypeItem): any => ({ ...obj, }); @@ -322,6 +370,9 @@ export interface GetOutpostInstanceTypesOutput { } export namespace GetOutpostInstanceTypesOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetOutpostInstanceTypesOutput): any => ({ ...obj, }); @@ -340,6 +391,9 @@ export interface ListOutpostsInput { } export namespace ListOutpostsInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListOutpostsInput): any => ({ ...obj, }); @@ -358,6 +412,9 @@ export interface ListOutpostsOutput { } export namespace ListOutpostsOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListOutpostsOutput): any => ({ ...obj, }); @@ -376,6 +433,9 @@ export interface ListSitesInput { } export namespace ListSitesInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListSitesInput): any => ({ ...obj, }); @@ -412,6 +472,9 @@ export interface Site { } export namespace Site { + /** + * @internal + */ export const filterSensitiveLog = (obj: Site): any => ({ ...obj, }); @@ -430,6 +493,9 @@ export interface ListSitesOutput { } export namespace ListSitesOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListSitesOutput): any => ({ ...obj, }); @@ -443,6 +509,9 @@ export interface ListTagsForResourceRequest { } export namespace ListTagsForResourceRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListTagsForResourceRequest): any => ({ ...obj, }); @@ -456,6 +525,9 @@ export interface ListTagsForResourceResponse { } export namespace ListTagsForResourceResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListTagsForResourceResponse): any => ({ ...obj, }); @@ -474,6 +546,9 @@ export interface TagResourceRequest { } export namespace TagResourceRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: TagResourceRequest): any => ({ ...obj, }); @@ -482,6 +557,9 @@ export namespace TagResourceRequest { export interface TagResourceResponse {} export namespace TagResourceResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: TagResourceResponse): any => ({ ...obj, }); @@ -500,6 +578,9 @@ export interface UntagResourceRequest { } export namespace UntagResourceRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: UntagResourceRequest): any => ({ ...obj, }); @@ -508,6 +589,9 @@ export namespace UntagResourceRequest { export interface UntagResourceResponse {} export namespace UntagResourceResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: UntagResourceResponse): any => ({ ...obj, }); diff --git a/clients/client-personalize-events/commands/PutEventsCommand.ts b/clients/client-personalize-events/commands/PutEventsCommand.ts index 73257701cb61..5d2fcd6effc6 100644 --- a/clients/client-personalize-events/commands/PutEventsCommand.ts +++ b/clients/client-personalize-events/commands/PutEventsCommand.ts @@ -27,6 +27,20 @@ export interface PutEventsCommandOutput extends __MetadataBearer {} /** *

Records user interaction event data. For more information see * Recording Events.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { PersonalizeEventsClient, PutEventsCommand } from "@aws-sdk/client-personalize-events"; // ES Modules import + * // const { PersonalizeEventsClient, PutEventsCommand } = require("@aws-sdk/client-personalize-events"); // CommonJS import + * const client = new PersonalizeEventsClient(config); + * const command = new PutEventsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link PutEventsCommandInput} for command's `input` shape. + * @see {@link PutEventsCommandOutput} for command's `response` shape. + * @see {@link PersonalizeEventsClientResolvedConfig | config} for command's `input` shape. + * */ export class PutEventsCommand extends $Command< PutEventsCommandInput, diff --git a/clients/client-personalize-events/commands/PutItemsCommand.ts b/clients/client-personalize-events/commands/PutItemsCommand.ts index c87fecbf4c39..5761e6a4fb79 100644 --- a/clients/client-personalize-events/commands/PutItemsCommand.ts +++ b/clients/client-personalize-events/commands/PutItemsCommand.ts @@ -28,6 +28,20 @@ export interface PutItemsCommandOutput extends __MetadataBearer {} *

Adds one or more items to an Items dataset. For more information see * Importing Items Incrementally. *

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { PersonalizeEventsClient, PutItemsCommand } from "@aws-sdk/client-personalize-events"; // ES Modules import + * // const { PersonalizeEventsClient, PutItemsCommand } = require("@aws-sdk/client-personalize-events"); // CommonJS import + * const client = new PersonalizeEventsClient(config); + * const command = new PutItemsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link PutItemsCommandInput} for command's `input` shape. + * @see {@link PutItemsCommandOutput} for command's `response` shape. + * @see {@link PersonalizeEventsClientResolvedConfig | config} for command's `input` shape. + * */ export class PutItemsCommand extends $Command< PutItemsCommandInput, diff --git a/clients/client-personalize-events/commands/PutUsersCommand.ts b/clients/client-personalize-events/commands/PutUsersCommand.ts index d2cd005663e0..5037c1cf1921 100644 --- a/clients/client-personalize-events/commands/PutUsersCommand.ts +++ b/clients/client-personalize-events/commands/PutUsersCommand.ts @@ -27,6 +27,20 @@ export interface PutUsersCommandOutput extends __MetadataBearer {} /** *

Adds one or more users to a Users dataset. For more information see * Importing Users Incrementally.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { PersonalizeEventsClient, PutUsersCommand } from "@aws-sdk/client-personalize-events"; // ES Modules import + * // const { PersonalizeEventsClient, PutUsersCommand } = require("@aws-sdk/client-personalize-events"); // CommonJS import + * const client = new PersonalizeEventsClient(config); + * const command = new PutUsersCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link PutUsersCommandInput} for command's `input` shape. + * @see {@link PutUsersCommandOutput} for command's `response` shape. + * @see {@link PersonalizeEventsClientResolvedConfig | config} for command's `input` shape. + * */ export class PutUsersCommand extends $Command< PutUsersCommandInput, diff --git a/clients/client-personalize-events/models/models_0.ts b/clients/client-personalize-events/models/models_0.ts index 9e5011b583c3..5eabfcde031d 100644 --- a/clients/client-personalize-events/models/models_0.ts +++ b/clients/client-personalize-events/models/models_0.ts @@ -11,6 +11,9 @@ export interface InvalidInputException extends __SmithyException, $MetadataBeare } export namespace InvalidInputException { + /** + * @internal + */ export const filterSensitiveLog = (obj: InvalidInputException): any => ({ ...obj, }); @@ -77,6 +80,9 @@ export interface Event { } export namespace Event { + /** + * @internal + */ export const filterSensitiveLog = (obj: Event): any => ({ ...obj, }); @@ -109,6 +115,9 @@ export interface PutEventsRequest { } export namespace PutEventsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: PutEventsRequest): any => ({ ...obj, }); @@ -138,6 +147,9 @@ export interface Item { } export namespace Item { + /** + * @internal + */ export const filterSensitiveLog = (obj: Item): any => ({ ...obj, }); @@ -156,6 +168,9 @@ export interface PutItemsRequest { } export namespace PutItemsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: PutItemsRequest): any => ({ ...obj, }); @@ -171,6 +186,9 @@ export interface ResourceInUseException extends __SmithyException, $MetadataBear } export namespace ResourceInUseException { + /** + * @internal + */ export const filterSensitiveLog = (obj: ResourceInUseException): any => ({ ...obj, }); @@ -186,6 +204,9 @@ export interface ResourceNotFoundException extends __SmithyException, $MetadataB } export namespace ResourceNotFoundException { + /** + * @internal + */ export const filterSensitiveLog = (obj: ResourceNotFoundException): any => ({ ...obj, }); @@ -215,6 +236,9 @@ export interface User { } export namespace User { + /** + * @internal + */ export const filterSensitiveLog = (obj: User): any => ({ ...obj, }); @@ -233,6 +257,9 @@ export interface PutUsersRequest { } export namespace PutUsersRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: PutUsersRequest): any => ({ ...obj, }); diff --git a/clients/client-personalize-runtime/commands/GetPersonalizedRankingCommand.ts b/clients/client-personalize-runtime/commands/GetPersonalizedRankingCommand.ts index 4bf92f559198..f5248fc1d229 100644 --- a/clients/client-personalize-runtime/commands/GetPersonalizedRankingCommand.ts +++ b/clients/client-personalize-runtime/commands/GetPersonalizedRankingCommand.ts @@ -31,6 +31,20 @@ export interface GetPersonalizedRankingCommandOutput extends GetPersonalizedRank *

The solution backing the campaign must have been created using a recipe of type * PERSONALIZED_RANKING.

* + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { PersonalizeRuntimeClient, GetPersonalizedRankingCommand } from "@aws-sdk/client-personalize-runtime"; // ES Modules import + * // const { PersonalizeRuntimeClient, GetPersonalizedRankingCommand } = require("@aws-sdk/client-personalize-runtime"); // CommonJS import + * const client = new PersonalizeRuntimeClient(config); + * const command = new GetPersonalizedRankingCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetPersonalizedRankingCommandInput} for command's `input` shape. + * @see {@link GetPersonalizedRankingCommandOutput} for command's `response` shape. + * @see {@link PersonalizeRuntimeClientResolvedConfig | config} for command's `input` shape. + * */ export class GetPersonalizedRankingCommand extends $Command< GetPersonalizedRankingCommandInput, diff --git a/clients/client-personalize-runtime/commands/GetRecommendationsCommand.ts b/clients/client-personalize-runtime/commands/GetRecommendationsCommand.ts index b2c9276bafbc..2b549cf75762 100644 --- a/clients/client-personalize-runtime/commands/GetRecommendationsCommand.ts +++ b/clients/client-personalize-runtime/commands/GetRecommendationsCommand.ts @@ -40,6 +40,20 @@ export interface GetRecommendationsCommandOutput extends GetRecommendationsRespo *

Campaigns that are backed by a solution created using a recipe of type * PERSONALIZED_RANKING use the API.

* + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { PersonalizeRuntimeClient, GetRecommendationsCommand } from "@aws-sdk/client-personalize-runtime"; // ES Modules import + * // const { PersonalizeRuntimeClient, GetRecommendationsCommand } = require("@aws-sdk/client-personalize-runtime"); // CommonJS import + * const client = new PersonalizeRuntimeClient(config); + * const command = new GetRecommendationsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetRecommendationsCommandInput} for command's `input` shape. + * @see {@link GetRecommendationsCommandOutput} for command's `response` shape. + * @see {@link PersonalizeRuntimeClientResolvedConfig | config} for command's `input` shape. + * */ export class GetRecommendationsCommand extends $Command< GetRecommendationsCommandInput, diff --git a/clients/client-personalize-runtime/models/models_0.ts b/clients/client-personalize-runtime/models/models_0.ts index 0f650c5482b5..03a47657b6b0 100644 --- a/clients/client-personalize-runtime/models/models_0.ts +++ b/clients/client-personalize-runtime/models/models_0.ts @@ -49,6 +49,9 @@ export interface GetPersonalizedRankingRequest { } export namespace GetPersonalizedRankingRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetPersonalizedRankingRequest): any => ({ ...obj, ...(obj.context && { context: SENSITIVE_STRING }), @@ -75,6 +78,9 @@ export interface PredictedItem { } export namespace PredictedItem { + /** + * @internal + */ export const filterSensitiveLog = (obj: PredictedItem): any => ({ ...obj, }); @@ -93,6 +99,9 @@ export interface GetPersonalizedRankingResponse { } export namespace GetPersonalizedRankingResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetPersonalizedRankingResponse): any => ({ ...obj, }); @@ -108,6 +117,9 @@ export interface InvalidInputException extends __SmithyException, $MetadataBeare } export namespace InvalidInputException { + /** + * @internal + */ export const filterSensitiveLog = (obj: InvalidInputException): any => ({ ...obj, }); @@ -123,6 +135,9 @@ export interface ResourceNotFoundException extends __SmithyException, $MetadataB } export namespace ResourceNotFoundException { + /** + * @internal + */ export const filterSensitiveLog = (obj: ResourceNotFoundException): any => ({ ...obj, }); @@ -181,6 +196,9 @@ export interface GetRecommendationsRequest { } export namespace GetRecommendationsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetRecommendationsRequest): any => ({ ...obj, ...(obj.context && { context: SENSITIVE_STRING }), @@ -202,6 +220,9 @@ export interface GetRecommendationsResponse { } export namespace GetRecommendationsResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetRecommendationsResponse): any => ({ ...obj, }); diff --git a/clients/client-personalize/commands/CreateBatchInferenceJobCommand.ts b/clients/client-personalize/commands/CreateBatchInferenceJobCommand.ts index 7b5e4860f1eb..8c52d3872c29 100644 --- a/clients/client-personalize/commands/CreateBatchInferenceJobCommand.ts +++ b/clients/client-personalize/commands/CreateBatchInferenceJobCommand.ts @@ -23,6 +23,20 @@ export interface CreateBatchInferenceJobCommandOutput extends CreateBatchInferen /** *

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 recommendations-batch.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { PersonalizeClient, CreateBatchInferenceJobCommand } from "@aws-sdk/client-personalize"; // ES Modules import + * // const { PersonalizeClient, CreateBatchInferenceJobCommand } = require("@aws-sdk/client-personalize"); // CommonJS import + * const client = new PersonalizeClient(config); + * const command = new CreateBatchInferenceJobCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreateBatchInferenceJobCommandInput} for command's `input` shape. + * @see {@link CreateBatchInferenceJobCommandOutput} for command's `response` shape. + * @see {@link PersonalizeClientResolvedConfig | config} for command's `input` shape. + * */ export class CreateBatchInferenceJobCommand extends $Command< CreateBatchInferenceJobCommandInput, diff --git a/clients/client-personalize/commands/CreateCampaignCommand.ts b/clients/client-personalize/commands/CreateCampaignCommand.ts index 148fbf034477..e8ac7887c291 100644 --- a/clients/client-personalize/commands/CreateCampaignCommand.ts +++ b/clients/client-personalize/commands/CreateCampaignCommand.ts @@ -92,6 +92,20 @@ export interface CreateCampaignCommandOutput extends CreateCampaignResponse, __M *

* * + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { PersonalizeClient, CreateCampaignCommand } from "@aws-sdk/client-personalize"; // ES Modules import + * // const { PersonalizeClient, CreateCampaignCommand } = require("@aws-sdk/client-personalize"); // CommonJS import + * const client = new PersonalizeClient(config); + * const command = new CreateCampaignCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreateCampaignCommandInput} for command's `input` shape. + * @see {@link CreateCampaignCommandOutput} for command's `response` shape. + * @see {@link PersonalizeClientResolvedConfig | config} for command's `input` shape. + * */ export class CreateCampaignCommand extends $Command< CreateCampaignCommandInput, diff --git a/clients/client-personalize/commands/CreateDatasetCommand.ts b/clients/client-personalize/commands/CreateDatasetCommand.ts index 818deb4294f5..54c84fc71fea 100644 --- a/clients/client-personalize/commands/CreateDatasetCommand.ts +++ b/clients/client-personalize/commands/CreateDatasetCommand.ts @@ -72,6 +72,20 @@ export interface CreateDatasetCommandOutput extends CreateDatasetResponse, __Met *

* * + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { PersonalizeClient, CreateDatasetCommand } from "@aws-sdk/client-personalize"; // ES Modules import + * // const { PersonalizeClient, CreateDatasetCommand } = require("@aws-sdk/client-personalize"); // CommonJS import + * const client = new PersonalizeClient(config); + * const command = new CreateDatasetCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreateDatasetCommandInput} for command's `input` shape. + * @see {@link CreateDatasetCommandOutput} for command's `response` shape. + * @see {@link PersonalizeClientResolvedConfig | config} for command's `input` shape. + * */ export class CreateDatasetCommand extends $Command< CreateDatasetCommandInput, diff --git a/clients/client-personalize/commands/CreateDatasetExportJobCommand.ts b/clients/client-personalize/commands/CreateDatasetExportJobCommand.ts index 61a450cc7271..d669dd27f90a 100644 --- a/clients/client-personalize/commands/CreateDatasetExportJobCommand.ts +++ b/clients/client-personalize/commands/CreateDatasetExportJobCommand.ts @@ -43,6 +43,20 @@ export interface CreateDatasetExportJobCommandOutput extends CreateDatasetExport * 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. *

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { PersonalizeClient, CreateDatasetExportJobCommand } from "@aws-sdk/client-personalize"; // ES Modules import + * // const { PersonalizeClient, CreateDatasetExportJobCommand } = require("@aws-sdk/client-personalize"); // CommonJS import + * const client = new PersonalizeClient(config); + * const command = new CreateDatasetExportJobCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreateDatasetExportJobCommandInput} for command's `input` shape. + * @see {@link CreateDatasetExportJobCommandOutput} for command's `response` shape. + * @see {@link PersonalizeClientResolvedConfig | config} for command's `input` shape. + * */ export class CreateDatasetExportJobCommand extends $Command< CreateDatasetExportJobCommandInput, diff --git a/clients/client-personalize/commands/CreateDatasetGroupCommand.ts b/clients/client-personalize/commands/CreateDatasetGroupCommand.ts index fb2412e7e3e3..821f31dd5e2a 100644 --- a/clients/client-personalize/commands/CreateDatasetGroupCommand.ts +++ b/clients/client-personalize/commands/CreateDatasetGroupCommand.ts @@ -97,6 +97,20 @@ export interface CreateDatasetGroupCommandOutput extends CreateDatasetGroupRespo *

* * + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { PersonalizeClient, CreateDatasetGroupCommand } from "@aws-sdk/client-personalize"; // ES Modules import + * // const { PersonalizeClient, CreateDatasetGroupCommand } = require("@aws-sdk/client-personalize"); // CommonJS import + * const client = new PersonalizeClient(config); + * const command = new CreateDatasetGroupCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreateDatasetGroupCommandInput} for command's `input` shape. + * @see {@link CreateDatasetGroupCommandOutput} for command's `response` shape. + * @see {@link PersonalizeClientResolvedConfig | config} for command's `input` shape. + * */ export class CreateDatasetGroupCommand extends $Command< CreateDatasetGroupCommandInput, diff --git a/clients/client-personalize/commands/CreateDatasetImportJobCommand.ts b/clients/client-personalize/commands/CreateDatasetImportJobCommand.ts index bdda237e955d..281c237f7669 100644 --- a/clients/client-personalize/commands/CreateDatasetImportJobCommand.ts +++ b/clients/client-personalize/commands/CreateDatasetImportJobCommand.ts @@ -63,6 +63,20 @@ export interface CreateDatasetImportJobCommandOutput extends CreateDatasetImport *

* * + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { PersonalizeClient, CreateDatasetImportJobCommand } from "@aws-sdk/client-personalize"; // ES Modules import + * // const { PersonalizeClient, CreateDatasetImportJobCommand } = require("@aws-sdk/client-personalize"); // CommonJS import + * const client = new PersonalizeClient(config); + * const command = new CreateDatasetImportJobCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreateDatasetImportJobCommandInput} for command's `input` shape. + * @see {@link CreateDatasetImportJobCommandOutput} for command's `response` shape. + * @see {@link PersonalizeClientResolvedConfig | config} for command's `input` shape. + * */ export class CreateDatasetImportJobCommand extends $Command< CreateDatasetImportJobCommandInput, diff --git a/clients/client-personalize/commands/CreateEventTrackerCommand.ts b/clients/client-personalize/commands/CreateEventTrackerCommand.ts index 2924ce57c5b5..c32f24a06cff 100644 --- a/clients/client-personalize/commands/CreateEventTrackerCommand.ts +++ b/clients/client-personalize/commands/CreateEventTrackerCommand.ts @@ -67,6 +67,20 @@ export interface CreateEventTrackerCommandOutput extends CreateEventTrackerRespo *

* * + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { PersonalizeClient, CreateEventTrackerCommand } from "@aws-sdk/client-personalize"; // ES Modules import + * // const { PersonalizeClient, CreateEventTrackerCommand } = require("@aws-sdk/client-personalize"); // CommonJS import + * const client = new PersonalizeClient(config); + * const command = new CreateEventTrackerCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreateEventTrackerCommandInput} for command's `input` shape. + * @see {@link CreateEventTrackerCommandOutput} for command's `response` shape. + * @see {@link PersonalizeClientResolvedConfig | config} for command's `input` shape. + * */ export class CreateEventTrackerCommand extends $Command< CreateEventTrackerCommandInput, diff --git a/clients/client-personalize/commands/CreateFilterCommand.ts b/clients/client-personalize/commands/CreateFilterCommand.ts index d05bea208cb7..1701e5a142fc 100644 --- a/clients/client-personalize/commands/CreateFilterCommand.ts +++ b/clients/client-personalize/commands/CreateFilterCommand.ts @@ -22,6 +22,20 @@ export interface CreateFilterCommandOutput extends CreateFilterResponse, __Metad /** *

Creates a recommendation filter. For more information, see filter.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { PersonalizeClient, CreateFilterCommand } from "@aws-sdk/client-personalize"; // ES Modules import + * // const { PersonalizeClient, CreateFilterCommand } = require("@aws-sdk/client-personalize"); // CommonJS import + * const client = new PersonalizeClient(config); + * const command = new CreateFilterCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreateFilterCommandInput} for command's `input` shape. + * @see {@link CreateFilterCommandOutput} for command's `response` shape. + * @see {@link PersonalizeClientResolvedConfig | config} for command's `input` shape. + * */ export class CreateFilterCommand extends $Command< CreateFilterCommandInput, diff --git a/clients/client-personalize/commands/CreateSchemaCommand.ts b/clients/client-personalize/commands/CreateSchemaCommand.ts index a71a37a6ce5a..117eaecab316 100644 --- a/clients/client-personalize/commands/CreateSchemaCommand.ts +++ b/clients/client-personalize/commands/CreateSchemaCommand.ts @@ -47,6 +47,20 @@ export interface CreateSchemaCommandOutput extends CreateSchemaResponse, __Metad *

* * + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { PersonalizeClient, CreateSchemaCommand } from "@aws-sdk/client-personalize"; // ES Modules import + * // const { PersonalizeClient, CreateSchemaCommand } = require("@aws-sdk/client-personalize"); // CommonJS import + * const client = new PersonalizeClient(config); + * const command = new CreateSchemaCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreateSchemaCommandInput} for command's `input` shape. + * @see {@link CreateSchemaCommandOutput} for command's `response` shape. + * @see {@link PersonalizeClientResolvedConfig | config} for command's `input` shape. + * */ export class CreateSchemaCommand extends $Command< CreateSchemaCommandInput, diff --git a/clients/client-personalize/commands/CreateSolutionCommand.ts b/clients/client-personalize/commands/CreateSolutionCommand.ts index a9bcdf8b6f61..0e02b9d4754f 100644 --- a/clients/client-personalize/commands/CreateSolutionCommand.ts +++ b/clients/client-personalize/commands/CreateSolutionCommand.ts @@ -94,6 +94,20 @@ export interface CreateSolutionCommandOutput extends CreateSolutionResponse, __M *

* * + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { PersonalizeClient, CreateSolutionCommand } from "@aws-sdk/client-personalize"; // ES Modules import + * // const { PersonalizeClient, CreateSolutionCommand } = require("@aws-sdk/client-personalize"); // CommonJS import + * const client = new PersonalizeClient(config); + * const command = new CreateSolutionCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreateSolutionCommandInput} for command's `input` shape. + * @see {@link CreateSolutionCommandOutput} for command's `response` shape. + * @see {@link PersonalizeClientResolvedConfig | config} for command's `input` shape. + * */ export class CreateSolutionCommand extends $Command< CreateSolutionCommandInput, diff --git a/clients/client-personalize/commands/CreateSolutionVersionCommand.ts b/clients/client-personalize/commands/CreateSolutionVersionCommand.ts index 4138112576fd..85b2ff377d38 100644 --- a/clients/client-personalize/commands/CreateSolutionVersionCommand.ts +++ b/clients/client-personalize/commands/CreateSolutionVersionCommand.ts @@ -74,6 +74,20 @@ export interface CreateSolutionVersionCommandOutput extends CreateSolutionVersio *

* * + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { PersonalizeClient, CreateSolutionVersionCommand } from "@aws-sdk/client-personalize"; // ES Modules import + * // const { PersonalizeClient, CreateSolutionVersionCommand } = require("@aws-sdk/client-personalize"); // CommonJS import + * const client = new PersonalizeClient(config); + * const command = new CreateSolutionVersionCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreateSolutionVersionCommandInput} for command's `input` shape. + * @see {@link CreateSolutionVersionCommandOutput} for command's `response` shape. + * @see {@link PersonalizeClientResolvedConfig | config} for command's `input` shape. + * */ export class CreateSolutionVersionCommand extends $Command< CreateSolutionVersionCommandInput, diff --git a/clients/client-personalize/commands/DeleteCampaignCommand.ts b/clients/client-personalize/commands/DeleteCampaignCommand.ts index 5104a2776a25..3445937f4ec4 100644 --- a/clients/client-personalize/commands/DeleteCampaignCommand.ts +++ b/clients/client-personalize/commands/DeleteCampaignCommand.ts @@ -27,6 +27,20 @@ export interface DeleteCampaignCommandOutput extends __MetadataBearer {} * GetRecommendations * request. * For more information on campaigns, see CreateCampaign.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { PersonalizeClient, DeleteCampaignCommand } from "@aws-sdk/client-personalize"; // ES Modules import + * // const { PersonalizeClient, DeleteCampaignCommand } = require("@aws-sdk/client-personalize"); // CommonJS import + * const client = new PersonalizeClient(config); + * const command = new DeleteCampaignCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteCampaignCommandInput} for command's `input` shape. + * @see {@link DeleteCampaignCommandOutput} for command's `response` shape. + * @see {@link PersonalizeClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteCampaignCommand extends $Command< DeleteCampaignCommandInput, diff --git a/clients/client-personalize/commands/DeleteDatasetCommand.ts b/clients/client-personalize/commands/DeleteDatasetCommand.ts index 54c4a014978a..246c0b32f9b6 100644 --- a/clients/client-personalize/commands/DeleteDatasetCommand.ts +++ b/clients/client-personalize/commands/DeleteDatasetCommand.ts @@ -24,6 +24,20 @@ export interface DeleteDatasetCommandOutput extends __MetadataBearer {} *

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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { PersonalizeClient, DeleteDatasetCommand } from "@aws-sdk/client-personalize"; // ES Modules import + * // const { PersonalizeClient, DeleteDatasetCommand } = require("@aws-sdk/client-personalize"); // CommonJS import + * const client = new PersonalizeClient(config); + * const command = new DeleteDatasetCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteDatasetCommandInput} for command's `input` shape. + * @see {@link DeleteDatasetCommandOutput} for command's `response` shape. + * @see {@link PersonalizeClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteDatasetCommand extends $Command< DeleteDatasetCommandInput, diff --git a/clients/client-personalize/commands/DeleteDatasetGroupCommand.ts b/clients/client-personalize/commands/DeleteDatasetGroupCommand.ts index 7bd14290198d..5119a81052eb 100644 --- a/clients/client-personalize/commands/DeleteDatasetGroupCommand.ts +++ b/clients/client-personalize/commands/DeleteDatasetGroupCommand.ts @@ -34,6 +34,20 @@ export interface DeleteDatasetGroupCommandOutput extends __MetadataBearer {} *

All datasets in the dataset group.

* * + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { PersonalizeClient, DeleteDatasetGroupCommand } from "@aws-sdk/client-personalize"; // ES Modules import + * // const { PersonalizeClient, DeleteDatasetGroupCommand } = require("@aws-sdk/client-personalize"); // CommonJS import + * const client = new PersonalizeClient(config); + * const command = new DeleteDatasetGroupCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteDatasetGroupCommandInput} for command's `input` shape. + * @see {@link DeleteDatasetGroupCommandOutput} for command's `response` shape. + * @see {@link PersonalizeClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteDatasetGroupCommand extends $Command< DeleteDatasetGroupCommandInput, diff --git a/clients/client-personalize/commands/DeleteEventTrackerCommand.ts b/clients/client-personalize/commands/DeleteEventTrackerCommand.ts index 0908c065e200..2eb11675ba36 100644 --- a/clients/client-personalize/commands/DeleteEventTrackerCommand.ts +++ b/clients/client-personalize/commands/DeleteEventTrackerCommand.ts @@ -24,6 +24,20 @@ export interface DeleteEventTrackerCommandOutput extends __MetadataBearer {} *

Deletes the event tracker. Does not delete the event-interactions dataset from * the associated dataset group. For more * information on event trackers, see CreateEventTracker.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { PersonalizeClient, DeleteEventTrackerCommand } from "@aws-sdk/client-personalize"; // ES Modules import + * // const { PersonalizeClient, DeleteEventTrackerCommand } = require("@aws-sdk/client-personalize"); // CommonJS import + * const client = new PersonalizeClient(config); + * const command = new DeleteEventTrackerCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteEventTrackerCommandInput} for command's `input` shape. + * @see {@link DeleteEventTrackerCommandOutput} for command's `response` shape. + * @see {@link PersonalizeClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteEventTrackerCommand extends $Command< DeleteEventTrackerCommandInput, diff --git a/clients/client-personalize/commands/DeleteFilterCommand.ts b/clients/client-personalize/commands/DeleteFilterCommand.ts index d3d2ac70d70a..10841020da6d 100644 --- a/clients/client-personalize/commands/DeleteFilterCommand.ts +++ b/clients/client-personalize/commands/DeleteFilterCommand.ts @@ -22,6 +22,20 @@ export interface DeleteFilterCommandOutput extends __MetadataBearer {} /** *

Deletes a filter.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { PersonalizeClient, DeleteFilterCommand } from "@aws-sdk/client-personalize"; // ES Modules import + * // const { PersonalizeClient, DeleteFilterCommand } = require("@aws-sdk/client-personalize"); // CommonJS import + * const client = new PersonalizeClient(config); + * const command = new DeleteFilterCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteFilterCommandInput} for command's `input` shape. + * @see {@link DeleteFilterCommandOutput} for command's `response` shape. + * @see {@link PersonalizeClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteFilterCommand extends $Command< DeleteFilterCommandInput, diff --git a/clients/client-personalize/commands/DeleteSchemaCommand.ts b/clients/client-personalize/commands/DeleteSchemaCommand.ts index cad33f896177..09048d6778a8 100644 --- a/clients/client-personalize/commands/DeleteSchemaCommand.ts +++ b/clients/client-personalize/commands/DeleteSchemaCommand.ts @@ -24,6 +24,20 @@ export interface DeleteSchemaCommandOutput extends __MetadataBearer {} *

Deletes a schema. Before deleting a schema, you must delete all * datasets referencing the schema. For more information on schemas, see * CreateSchema.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { PersonalizeClient, DeleteSchemaCommand } from "@aws-sdk/client-personalize"; // ES Modules import + * // const { PersonalizeClient, DeleteSchemaCommand } = require("@aws-sdk/client-personalize"); // CommonJS import + * const client = new PersonalizeClient(config); + * const command = new DeleteSchemaCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteSchemaCommandInput} for command's `input` shape. + * @see {@link DeleteSchemaCommandOutput} for command's `response` shape. + * @see {@link PersonalizeClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteSchemaCommand extends $Command< DeleteSchemaCommandInput, diff --git a/clients/client-personalize/commands/DeleteSolutionCommand.ts b/clients/client-personalize/commands/DeleteSolutionCommand.ts index 9c56963e7a52..23297dbf5ffe 100644 --- a/clients/client-personalize/commands/DeleteSolutionCommand.ts +++ b/clients/client-personalize/commands/DeleteSolutionCommand.ts @@ -28,6 +28,20 @@ export interface DeleteSolutionCommandOutput extends __MetadataBearer {} * 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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { PersonalizeClient, DeleteSolutionCommand } from "@aws-sdk/client-personalize"; // ES Modules import + * // const { PersonalizeClient, DeleteSolutionCommand } = require("@aws-sdk/client-personalize"); // CommonJS import + * const client = new PersonalizeClient(config); + * const command = new DeleteSolutionCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteSolutionCommandInput} for command's `input` shape. + * @see {@link DeleteSolutionCommandOutput} for command's `response` shape. + * @see {@link PersonalizeClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteSolutionCommand extends $Command< DeleteSolutionCommandInput, diff --git a/clients/client-personalize/commands/DescribeAlgorithmCommand.ts b/clients/client-personalize/commands/DescribeAlgorithmCommand.ts index c8cc3090342e..f56c3b7c1bdb 100644 --- a/clients/client-personalize/commands/DescribeAlgorithmCommand.ts +++ b/clients/client-personalize/commands/DescribeAlgorithmCommand.ts @@ -22,6 +22,20 @@ export interface DescribeAlgorithmCommandOutput extends DescribeAlgorithmRespons /** *

Describes the given algorithm.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { PersonalizeClient, DescribeAlgorithmCommand } from "@aws-sdk/client-personalize"; // ES Modules import + * // const { PersonalizeClient, DescribeAlgorithmCommand } = require("@aws-sdk/client-personalize"); // CommonJS import + * const client = new PersonalizeClient(config); + * const command = new DescribeAlgorithmCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeAlgorithmCommandInput} for command's `input` shape. + * @see {@link DescribeAlgorithmCommandOutput} for command's `response` shape. + * @see {@link PersonalizeClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeAlgorithmCommand extends $Command< DescribeAlgorithmCommandInput, diff --git a/clients/client-personalize/commands/DescribeBatchInferenceJobCommand.ts b/clients/client-personalize/commands/DescribeBatchInferenceJobCommand.ts index 0ad0fd1f1ce0..a3cfaab2c6c7 100644 --- a/clients/client-personalize/commands/DescribeBatchInferenceJobCommand.ts +++ b/clients/client-personalize/commands/DescribeBatchInferenceJobCommand.ts @@ -24,6 +24,20 @@ export interface DescribeBatchInferenceJobCommandOutput extends DescribeBatchInf *

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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { PersonalizeClient, DescribeBatchInferenceJobCommand } from "@aws-sdk/client-personalize"; // ES Modules import + * // const { PersonalizeClient, DescribeBatchInferenceJobCommand } = require("@aws-sdk/client-personalize"); // CommonJS import + * const client = new PersonalizeClient(config); + * const command = new DescribeBatchInferenceJobCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeBatchInferenceJobCommandInput} for command's `input` shape. + * @see {@link DescribeBatchInferenceJobCommandOutput} for command's `response` shape. + * @see {@link PersonalizeClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeBatchInferenceJobCommand extends $Command< DescribeBatchInferenceJobCommandInput, diff --git a/clients/client-personalize/commands/DescribeCampaignCommand.ts b/clients/client-personalize/commands/DescribeCampaignCommand.ts index 2979aae076c4..caf27568bc64 100644 --- a/clients/client-personalize/commands/DescribeCampaignCommand.ts +++ b/clients/client-personalize/commands/DescribeCampaignCommand.ts @@ -34,6 +34,20 @@ export interface DescribeCampaignCommandOutput extends DescribeCampaignResponse, *

When the status is CREATE FAILED, the response includes the * failureReason key, which describes why.

*

For more information on campaigns, see CreateCampaign.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { PersonalizeClient, DescribeCampaignCommand } from "@aws-sdk/client-personalize"; // ES Modules import + * // const { PersonalizeClient, DescribeCampaignCommand } = require("@aws-sdk/client-personalize"); // CommonJS import + * const client = new PersonalizeClient(config); + * const command = new DescribeCampaignCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeCampaignCommandInput} for command's `input` shape. + * @see {@link DescribeCampaignCommandOutput} for command's `response` shape. + * @see {@link PersonalizeClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeCampaignCommand extends $Command< DescribeCampaignCommandInput, diff --git a/clients/client-personalize/commands/DescribeDatasetCommand.ts b/clients/client-personalize/commands/DescribeDatasetCommand.ts index 3470778abd42..a34b87195312 100644 --- a/clients/client-personalize/commands/DescribeDatasetCommand.ts +++ b/clients/client-personalize/commands/DescribeDatasetCommand.ts @@ -22,6 +22,20 @@ export interface DescribeDatasetCommandOutput extends DescribeDatasetResponse, _ /** *

Describes the given dataset. For more information on datasets, see CreateDataset.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { PersonalizeClient, DescribeDatasetCommand } from "@aws-sdk/client-personalize"; // ES Modules import + * // const { PersonalizeClient, DescribeDatasetCommand } = require("@aws-sdk/client-personalize"); // CommonJS import + * const client = new PersonalizeClient(config); + * const command = new DescribeDatasetCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeDatasetCommandInput} for command's `input` shape. + * @see {@link DescribeDatasetCommandOutput} for command's `response` shape. + * @see {@link PersonalizeClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeDatasetCommand extends $Command< DescribeDatasetCommandInput, diff --git a/clients/client-personalize/commands/DescribeDatasetExportJobCommand.ts b/clients/client-personalize/commands/DescribeDatasetExportJobCommand.ts index ca4f232503a4..153286b47adc 100644 --- a/clients/client-personalize/commands/DescribeDatasetExportJobCommand.ts +++ b/clients/client-personalize/commands/DescribeDatasetExportJobCommand.ts @@ -23,6 +23,20 @@ export interface DescribeDatasetExportJobCommandOutput extends DescribeDatasetEx /** *

Describes the dataset export job created by CreateDatasetExportJob, * including the export job status.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { PersonalizeClient, DescribeDatasetExportJobCommand } from "@aws-sdk/client-personalize"; // ES Modules import + * // const { PersonalizeClient, DescribeDatasetExportJobCommand } = require("@aws-sdk/client-personalize"); // CommonJS import + * const client = new PersonalizeClient(config); + * const command = new DescribeDatasetExportJobCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeDatasetExportJobCommandInput} for command's `input` shape. + * @see {@link DescribeDatasetExportJobCommandOutput} for command's `response` shape. + * @see {@link PersonalizeClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeDatasetExportJobCommand extends $Command< DescribeDatasetExportJobCommandInput, diff --git a/clients/client-personalize/commands/DescribeDatasetGroupCommand.ts b/clients/client-personalize/commands/DescribeDatasetGroupCommand.ts index 18a145e96460..1471c18e4b60 100644 --- a/clients/client-personalize/commands/DescribeDatasetGroupCommand.ts +++ b/clients/client-personalize/commands/DescribeDatasetGroupCommand.ts @@ -22,6 +22,20 @@ export interface DescribeDatasetGroupCommandOutput extends DescribeDatasetGroupR /** *

Describes the given dataset group. For more information on dataset groups, see CreateDatasetGroup.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { PersonalizeClient, DescribeDatasetGroupCommand } from "@aws-sdk/client-personalize"; // ES Modules import + * // const { PersonalizeClient, DescribeDatasetGroupCommand } = require("@aws-sdk/client-personalize"); // CommonJS import + * const client = new PersonalizeClient(config); + * const command = new DescribeDatasetGroupCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeDatasetGroupCommandInput} for command's `input` shape. + * @see {@link DescribeDatasetGroupCommandOutput} for command's `response` shape. + * @see {@link PersonalizeClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeDatasetGroupCommand extends $Command< DescribeDatasetGroupCommandInput, diff --git a/clients/client-personalize/commands/DescribeDatasetImportJobCommand.ts b/clients/client-personalize/commands/DescribeDatasetImportJobCommand.ts index e145e38facd8..34e603f07458 100644 --- a/clients/client-personalize/commands/DescribeDatasetImportJobCommand.ts +++ b/clients/client-personalize/commands/DescribeDatasetImportJobCommand.ts @@ -23,6 +23,20 @@ export interface DescribeDatasetImportJobCommandOutput extends DescribeDatasetIm /** *

Describes the dataset import job created by CreateDatasetImportJob, * including the import job status.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { PersonalizeClient, DescribeDatasetImportJobCommand } from "@aws-sdk/client-personalize"; // ES Modules import + * // const { PersonalizeClient, DescribeDatasetImportJobCommand } = require("@aws-sdk/client-personalize"); // CommonJS import + * const client = new PersonalizeClient(config); + * const command = new DescribeDatasetImportJobCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeDatasetImportJobCommandInput} for command's `input` shape. + * @see {@link DescribeDatasetImportJobCommandOutput} for command's `response` shape. + * @see {@link PersonalizeClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeDatasetImportJobCommand extends $Command< DescribeDatasetImportJobCommandInput, diff --git a/clients/client-personalize/commands/DescribeEventTrackerCommand.ts b/clients/client-personalize/commands/DescribeEventTrackerCommand.ts index bb30691e3905..be38edd18b54 100644 --- a/clients/client-personalize/commands/DescribeEventTrackerCommand.ts +++ b/clients/client-personalize/commands/DescribeEventTrackerCommand.ts @@ -24,6 +24,20 @@ export interface DescribeEventTrackerCommandOutput extends DescribeEventTrackerR *

Describes an event tracker. The response includes the trackingId and * status of the event tracker. * For more information on event trackers, see CreateEventTracker.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { PersonalizeClient, DescribeEventTrackerCommand } from "@aws-sdk/client-personalize"; // ES Modules import + * // const { PersonalizeClient, DescribeEventTrackerCommand } = require("@aws-sdk/client-personalize"); // CommonJS import + * const client = new PersonalizeClient(config); + * const command = new DescribeEventTrackerCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeEventTrackerCommandInput} for command's `input` shape. + * @see {@link DescribeEventTrackerCommandOutput} for command's `response` shape. + * @see {@link PersonalizeClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeEventTrackerCommand extends $Command< DescribeEventTrackerCommandInput, diff --git a/clients/client-personalize/commands/DescribeFeatureTransformationCommand.ts b/clients/client-personalize/commands/DescribeFeatureTransformationCommand.ts index 325adce5156f..241fc2433433 100644 --- a/clients/client-personalize/commands/DescribeFeatureTransformationCommand.ts +++ b/clients/client-personalize/commands/DescribeFeatureTransformationCommand.ts @@ -24,6 +24,20 @@ export interface DescribeFeatureTransformationCommandOutput /** *

Describes the given feature transformation.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { PersonalizeClient, DescribeFeatureTransformationCommand } from "@aws-sdk/client-personalize"; // ES Modules import + * // const { PersonalizeClient, DescribeFeatureTransformationCommand } = require("@aws-sdk/client-personalize"); // CommonJS import + * const client = new PersonalizeClient(config); + * const command = new DescribeFeatureTransformationCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeFeatureTransformationCommandInput} for command's `input` shape. + * @see {@link DescribeFeatureTransformationCommandOutput} for command's `response` shape. + * @see {@link PersonalizeClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeFeatureTransformationCommand extends $Command< DescribeFeatureTransformationCommandInput, diff --git a/clients/client-personalize/commands/DescribeFilterCommand.ts b/clients/client-personalize/commands/DescribeFilterCommand.ts index cb35c6a584f5..54738cfaff3a 100644 --- a/clients/client-personalize/commands/DescribeFilterCommand.ts +++ b/clients/client-personalize/commands/DescribeFilterCommand.ts @@ -22,6 +22,20 @@ export interface DescribeFilterCommandOutput extends DescribeFilterResponse, __M /** *

Describes a filter's properties.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { PersonalizeClient, DescribeFilterCommand } from "@aws-sdk/client-personalize"; // ES Modules import + * // const { PersonalizeClient, DescribeFilterCommand } = require("@aws-sdk/client-personalize"); // CommonJS import + * const client = new PersonalizeClient(config); + * const command = new DescribeFilterCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeFilterCommandInput} for command's `input` shape. + * @see {@link DescribeFilterCommandOutput} for command's `response` shape. + * @see {@link PersonalizeClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeFilterCommand extends $Command< DescribeFilterCommandInput, diff --git a/clients/client-personalize/commands/DescribeRecipeCommand.ts b/clients/client-personalize/commands/DescribeRecipeCommand.ts index ec97a611b995..07276d159c27 100644 --- a/clients/client-personalize/commands/DescribeRecipeCommand.ts +++ b/clients/client-personalize/commands/DescribeRecipeCommand.ts @@ -40,6 +40,20 @@ export interface DescribeRecipeCommandOutput extends DescribeRecipeResponse, __M * in the specified recipe and a training dataset. The solution, when deployed as a campaign, * can provide recommendations using the * GetRecommendations API.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { PersonalizeClient, DescribeRecipeCommand } from "@aws-sdk/client-personalize"; // ES Modules import + * // const { PersonalizeClient, DescribeRecipeCommand } = require("@aws-sdk/client-personalize"); // CommonJS import + * const client = new PersonalizeClient(config); + * const command = new DescribeRecipeCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeRecipeCommandInput} for command's `input` shape. + * @see {@link DescribeRecipeCommandOutput} for command's `response` shape. + * @see {@link PersonalizeClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeRecipeCommand extends $Command< DescribeRecipeCommandInput, diff --git a/clients/client-personalize/commands/DescribeSchemaCommand.ts b/clients/client-personalize/commands/DescribeSchemaCommand.ts index c97837e9dcf6..e0dd680c6007 100644 --- a/clients/client-personalize/commands/DescribeSchemaCommand.ts +++ b/clients/client-personalize/commands/DescribeSchemaCommand.ts @@ -23,6 +23,20 @@ export interface DescribeSchemaCommandOutput extends DescribeSchemaResponse, __M /** *

Describes a schema. For more information on schemas, see * CreateSchema.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { PersonalizeClient, DescribeSchemaCommand } from "@aws-sdk/client-personalize"; // ES Modules import + * // const { PersonalizeClient, DescribeSchemaCommand } = require("@aws-sdk/client-personalize"); // CommonJS import + * const client = new PersonalizeClient(config); + * const command = new DescribeSchemaCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeSchemaCommandInput} for command's `input` shape. + * @see {@link DescribeSchemaCommandOutput} for command's `response` shape. + * @see {@link PersonalizeClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeSchemaCommand extends $Command< DescribeSchemaCommandInput, diff --git a/clients/client-personalize/commands/DescribeSolutionCommand.ts b/clients/client-personalize/commands/DescribeSolutionCommand.ts index 471635ce8905..26d84d6826c8 100644 --- a/clients/client-personalize/commands/DescribeSolutionCommand.ts +++ b/clients/client-personalize/commands/DescribeSolutionCommand.ts @@ -23,6 +23,20 @@ export interface DescribeSolutionCommandOutput extends DescribeSolutionResponse, /** *

Describes a solution. * For more information on solutions, see CreateSolution.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { PersonalizeClient, DescribeSolutionCommand } from "@aws-sdk/client-personalize"; // ES Modules import + * // const { PersonalizeClient, DescribeSolutionCommand } = require("@aws-sdk/client-personalize"); // CommonJS import + * const client = new PersonalizeClient(config); + * const command = new DescribeSolutionCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeSolutionCommandInput} for command's `input` shape. + * @see {@link DescribeSolutionCommandOutput} for command's `response` shape. + * @see {@link PersonalizeClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeSolutionCommand extends $Command< DescribeSolutionCommandInput, diff --git a/clients/client-personalize/commands/DescribeSolutionVersionCommand.ts b/clients/client-personalize/commands/DescribeSolutionVersionCommand.ts index fbf7ef4e11cd..4472d5078f06 100644 --- a/clients/client-personalize/commands/DescribeSolutionVersionCommand.ts +++ b/clients/client-personalize/commands/DescribeSolutionVersionCommand.ts @@ -22,6 +22,20 @@ export interface DescribeSolutionVersionCommandOutput extends DescribeSolutionVe /** *

Describes a specific version of a solution. For more information on solutions, see CreateSolution.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { PersonalizeClient, DescribeSolutionVersionCommand } from "@aws-sdk/client-personalize"; // ES Modules import + * // const { PersonalizeClient, DescribeSolutionVersionCommand } = require("@aws-sdk/client-personalize"); // CommonJS import + * const client = new PersonalizeClient(config); + * const command = new DescribeSolutionVersionCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeSolutionVersionCommandInput} for command's `input` shape. + * @see {@link DescribeSolutionVersionCommandOutput} for command's `response` shape. + * @see {@link PersonalizeClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeSolutionVersionCommand extends $Command< DescribeSolutionVersionCommandInput, diff --git a/clients/client-personalize/commands/GetSolutionMetricsCommand.ts b/clients/client-personalize/commands/GetSolutionMetricsCommand.ts index 0adefd232f07..e6fae8d17fdc 100644 --- a/clients/client-personalize/commands/GetSolutionMetricsCommand.ts +++ b/clients/client-personalize/commands/GetSolutionMetricsCommand.ts @@ -22,6 +22,20 @@ export interface GetSolutionMetricsCommandOutput extends GetSolutionMetricsRespo /** *

Gets the metrics for the specified solution version.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { PersonalizeClient, GetSolutionMetricsCommand } from "@aws-sdk/client-personalize"; // ES Modules import + * // const { PersonalizeClient, GetSolutionMetricsCommand } = require("@aws-sdk/client-personalize"); // CommonJS import + * const client = new PersonalizeClient(config); + * const command = new GetSolutionMetricsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetSolutionMetricsCommandInput} for command's `input` shape. + * @see {@link GetSolutionMetricsCommandOutput} for command's `response` shape. + * @see {@link PersonalizeClientResolvedConfig | config} for command's `input` shape. + * */ export class GetSolutionMetricsCommand extends $Command< GetSolutionMetricsCommandInput, diff --git a/clients/client-personalize/commands/ListBatchInferenceJobsCommand.ts b/clients/client-personalize/commands/ListBatchInferenceJobsCommand.ts index 37045158e726..a2236308056f 100644 --- a/clients/client-personalize/commands/ListBatchInferenceJobsCommand.ts +++ b/clients/client-personalize/commands/ListBatchInferenceJobsCommand.ts @@ -23,6 +23,20 @@ export interface ListBatchInferenceJobsCommandOutput extends ListBatchInferenceJ /** *

Gets a list of the batch inference jobs that have been performed off of a solution * version.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { PersonalizeClient, ListBatchInferenceJobsCommand } from "@aws-sdk/client-personalize"; // ES Modules import + * // const { PersonalizeClient, ListBatchInferenceJobsCommand } = require("@aws-sdk/client-personalize"); // CommonJS import + * const client = new PersonalizeClient(config); + * const command = new ListBatchInferenceJobsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListBatchInferenceJobsCommandInput} for command's `input` shape. + * @see {@link ListBatchInferenceJobsCommandOutput} for command's `response` shape. + * @see {@link PersonalizeClientResolvedConfig | config} for command's `input` shape. + * */ export class ListBatchInferenceJobsCommand extends $Command< ListBatchInferenceJobsCommandInput, diff --git a/clients/client-personalize/commands/ListCampaignsCommand.ts b/clients/client-personalize/commands/ListCampaignsCommand.ts index f9255b0a2a47..bb842309b4bb 100644 --- a/clients/client-personalize/commands/ListCampaignsCommand.ts +++ b/clients/client-personalize/commands/ListCampaignsCommand.ts @@ -25,6 +25,20 @@ export interface ListCampaignsCommandOutput extends ListCampaignsResponse, __Met * 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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { PersonalizeClient, ListCampaignsCommand } from "@aws-sdk/client-personalize"; // ES Modules import + * // const { PersonalizeClient, ListCampaignsCommand } = require("@aws-sdk/client-personalize"); // CommonJS import + * const client = new PersonalizeClient(config); + * const command = new ListCampaignsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListCampaignsCommandInput} for command's `input` shape. + * @see {@link ListCampaignsCommandOutput} for command's `response` shape. + * @see {@link PersonalizeClientResolvedConfig | config} for command's `input` shape. + * */ export class ListCampaignsCommand extends $Command< ListCampaignsCommandInput, diff --git a/clients/client-personalize/commands/ListDatasetExportJobsCommand.ts b/clients/client-personalize/commands/ListDatasetExportJobsCommand.ts index a4554befde8d..95e4ef811622 100644 --- a/clients/client-personalize/commands/ListDatasetExportJobsCommand.ts +++ b/clients/client-personalize/commands/ListDatasetExportJobsCommand.ts @@ -26,6 +26,20 @@ export interface ListDatasetExportJobsCommandOutput extends ListDatasetExportJob * 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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { PersonalizeClient, ListDatasetExportJobsCommand } from "@aws-sdk/client-personalize"; // ES Modules import + * // const { PersonalizeClient, ListDatasetExportJobsCommand } = require("@aws-sdk/client-personalize"); // CommonJS import + * const client = new PersonalizeClient(config); + * const command = new ListDatasetExportJobsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListDatasetExportJobsCommandInput} for command's `input` shape. + * @see {@link ListDatasetExportJobsCommandOutput} for command's `response` shape. + * @see {@link PersonalizeClientResolvedConfig | config} for command's `input` shape. + * */ export class ListDatasetExportJobsCommand extends $Command< ListDatasetExportJobsCommandInput, diff --git a/clients/client-personalize/commands/ListDatasetGroupsCommand.ts b/clients/client-personalize/commands/ListDatasetGroupsCommand.ts index da7a5af6a1b3..95cdaeaeaa31 100644 --- a/clients/client-personalize/commands/ListDatasetGroupsCommand.ts +++ b/clients/client-personalize/commands/ListDatasetGroupsCommand.ts @@ -24,6 +24,20 @@ export interface ListDatasetGroupsCommandOutput extends ListDatasetGroupsRespons *

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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { PersonalizeClient, ListDatasetGroupsCommand } from "@aws-sdk/client-personalize"; // ES Modules import + * // const { PersonalizeClient, ListDatasetGroupsCommand } = require("@aws-sdk/client-personalize"); // CommonJS import + * const client = new PersonalizeClient(config); + * const command = new ListDatasetGroupsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListDatasetGroupsCommandInput} for command's `input` shape. + * @see {@link ListDatasetGroupsCommandOutput} for command's `response` shape. + * @see {@link PersonalizeClientResolvedConfig | config} for command's `input` shape. + * */ export class ListDatasetGroupsCommand extends $Command< ListDatasetGroupsCommandInput, diff --git a/clients/client-personalize/commands/ListDatasetImportJobsCommand.ts b/clients/client-personalize/commands/ListDatasetImportJobsCommand.ts index 5b41707ae59b..6105ab72565d 100644 --- a/clients/client-personalize/commands/ListDatasetImportJobsCommand.ts +++ b/clients/client-personalize/commands/ListDatasetImportJobsCommand.ts @@ -26,6 +26,20 @@ export interface ListDatasetImportJobsCommandOutput extends ListDatasetImportJob * 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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { PersonalizeClient, ListDatasetImportJobsCommand } from "@aws-sdk/client-personalize"; // ES Modules import + * // const { PersonalizeClient, ListDatasetImportJobsCommand } = require("@aws-sdk/client-personalize"); // CommonJS import + * const client = new PersonalizeClient(config); + * const command = new ListDatasetImportJobsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListDatasetImportJobsCommandInput} for command's `input` shape. + * @see {@link ListDatasetImportJobsCommandOutput} for command's `response` shape. + * @see {@link PersonalizeClientResolvedConfig | config} for command's `input` shape. + * */ export class ListDatasetImportJobsCommand extends $Command< ListDatasetImportJobsCommandInput, diff --git a/clients/client-personalize/commands/ListDatasetsCommand.ts b/clients/client-personalize/commands/ListDatasetsCommand.ts index e88c7ba35278..b311c8f5455a 100644 --- a/clients/client-personalize/commands/ListDatasetsCommand.ts +++ b/clients/client-personalize/commands/ListDatasetsCommand.ts @@ -24,6 +24,20 @@ export interface ListDatasetsCommandOutput extends ListDatasetsResponse, __Metad *

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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { PersonalizeClient, ListDatasetsCommand } from "@aws-sdk/client-personalize"; // ES Modules import + * // const { PersonalizeClient, ListDatasetsCommand } = require("@aws-sdk/client-personalize"); // CommonJS import + * const client = new PersonalizeClient(config); + * const command = new ListDatasetsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListDatasetsCommandInput} for command's `input` shape. + * @see {@link ListDatasetsCommandOutput} for command's `response` shape. + * @see {@link PersonalizeClientResolvedConfig | config} for command's `input` shape. + * */ export class ListDatasetsCommand extends $Command< ListDatasetsCommandInput, diff --git a/clients/client-personalize/commands/ListEventTrackersCommand.ts b/clients/client-personalize/commands/ListEventTrackersCommand.ts index e783ae820b75..a87e732832cb 100644 --- a/clients/client-personalize/commands/ListEventTrackersCommand.ts +++ b/clients/client-personalize/commands/ListEventTrackersCommand.ts @@ -25,6 +25,20 @@ export interface ListEventTrackersCommandOutput extends ListEventTrackersRespons * 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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { PersonalizeClient, ListEventTrackersCommand } from "@aws-sdk/client-personalize"; // ES Modules import + * // const { PersonalizeClient, ListEventTrackersCommand } = require("@aws-sdk/client-personalize"); // CommonJS import + * const client = new PersonalizeClient(config); + * const command = new ListEventTrackersCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListEventTrackersCommandInput} for command's `input` shape. + * @see {@link ListEventTrackersCommandOutput} for command's `response` shape. + * @see {@link PersonalizeClientResolvedConfig | config} for command's `input` shape. + * */ export class ListEventTrackersCommand extends $Command< ListEventTrackersCommandInput, diff --git a/clients/client-personalize/commands/ListFiltersCommand.ts b/clients/client-personalize/commands/ListFiltersCommand.ts index dd1ad3a251d7..7edc28e98664 100644 --- a/clients/client-personalize/commands/ListFiltersCommand.ts +++ b/clients/client-personalize/commands/ListFiltersCommand.ts @@ -22,6 +22,20 @@ export interface ListFiltersCommandOutput extends ListFiltersResponse, __Metadat /** *

Lists all filters that belong to a given dataset group.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { PersonalizeClient, ListFiltersCommand } from "@aws-sdk/client-personalize"; // ES Modules import + * // const { PersonalizeClient, ListFiltersCommand } = require("@aws-sdk/client-personalize"); // CommonJS import + * const client = new PersonalizeClient(config); + * const command = new ListFiltersCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListFiltersCommandInput} for command's `input` shape. + * @see {@link ListFiltersCommandOutput} for command's `response` shape. + * @see {@link PersonalizeClientResolvedConfig | config} for command's `input` shape. + * */ export class ListFiltersCommand extends $Command< ListFiltersCommandInput, diff --git a/clients/client-personalize/commands/ListRecipesCommand.ts b/clients/client-personalize/commands/ListRecipesCommand.ts index caa815f38338..3271541d4f7d 100644 --- a/clients/client-personalize/commands/ListRecipesCommand.ts +++ b/clients/client-personalize/commands/ListRecipesCommand.ts @@ -23,6 +23,20 @@ export interface ListRecipesCommandOutput extends ListRecipesResponse, __Metadat /** *

Returns a list of available recipes. The response provides the properties * for each recipe, including the recipe's Amazon Resource Name (ARN).

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { PersonalizeClient, ListRecipesCommand } from "@aws-sdk/client-personalize"; // ES Modules import + * // const { PersonalizeClient, ListRecipesCommand } = require("@aws-sdk/client-personalize"); // CommonJS import + * const client = new PersonalizeClient(config); + * const command = new ListRecipesCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListRecipesCommandInput} for command's `input` shape. + * @see {@link ListRecipesCommandOutput} for command's `response` shape. + * @see {@link PersonalizeClientResolvedConfig | config} for command's `input` shape. + * */ export class ListRecipesCommand extends $Command< ListRecipesCommandInput, diff --git a/clients/client-personalize/commands/ListSchemasCommand.ts b/clients/client-personalize/commands/ListSchemasCommand.ts index 7e516004f05d..f6da9f2daaf3 100644 --- a/clients/client-personalize/commands/ListSchemasCommand.ts +++ b/clients/client-personalize/commands/ListSchemasCommand.ts @@ -24,6 +24,20 @@ export interface ListSchemasCommandOutput extends ListSchemasResponse, __Metadat *

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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { PersonalizeClient, ListSchemasCommand } from "@aws-sdk/client-personalize"; // ES Modules import + * // const { PersonalizeClient, ListSchemasCommand } = require("@aws-sdk/client-personalize"); // CommonJS import + * const client = new PersonalizeClient(config); + * const command = new ListSchemasCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListSchemasCommandInput} for command's `input` shape. + * @see {@link ListSchemasCommandOutput} for command's `response` shape. + * @see {@link PersonalizeClientResolvedConfig | config} for command's `input` shape. + * */ export class ListSchemasCommand extends $Command< ListSchemasCommandInput, diff --git a/clients/client-personalize/commands/ListSolutionVersionsCommand.ts b/clients/client-personalize/commands/ListSolutionVersionsCommand.ts index e6e996a27e49..d98745759433 100644 --- a/clients/client-personalize/commands/ListSolutionVersionsCommand.ts +++ b/clients/client-personalize/commands/ListSolutionVersionsCommand.ts @@ -25,6 +25,20 @@ export interface ListSolutionVersionsCommandOutput extends ListSolutionVersionsR * 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). * For more information on solutions, see CreateSolution.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { PersonalizeClient, ListSolutionVersionsCommand } from "@aws-sdk/client-personalize"; // ES Modules import + * // const { PersonalizeClient, ListSolutionVersionsCommand } = require("@aws-sdk/client-personalize"); // CommonJS import + * const client = new PersonalizeClient(config); + * const command = new ListSolutionVersionsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListSolutionVersionsCommandInput} for command's `input` shape. + * @see {@link ListSolutionVersionsCommandOutput} for command's `response` shape. + * @see {@link PersonalizeClientResolvedConfig | config} for command's `input` shape. + * */ export class ListSolutionVersionsCommand extends $Command< ListSolutionVersionsCommandInput, diff --git a/clients/client-personalize/commands/ListSolutionsCommand.ts b/clients/client-personalize/commands/ListSolutionsCommand.ts index c225743859de..3e14dfb595d2 100644 --- a/clients/client-personalize/commands/ListSolutionsCommand.ts +++ b/clients/client-personalize/commands/ListSolutionsCommand.ts @@ -25,6 +25,20 @@ export interface ListSolutionsCommandOutput extends ListSolutionsResponse, __Met * 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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { PersonalizeClient, ListSolutionsCommand } from "@aws-sdk/client-personalize"; // ES Modules import + * // const { PersonalizeClient, ListSolutionsCommand } = require("@aws-sdk/client-personalize"); // CommonJS import + * const client = new PersonalizeClient(config); + * const command = new ListSolutionsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListSolutionsCommandInput} for command's `input` shape. + * @see {@link ListSolutionsCommandOutput} for command's `response` shape. + * @see {@link PersonalizeClientResolvedConfig | config} for command's `input` shape. + * */ export class ListSolutionsCommand extends $Command< ListSolutionsCommandInput, diff --git a/clients/client-personalize/commands/UpdateCampaignCommand.ts b/clients/client-personalize/commands/UpdateCampaignCommand.ts index 9bdacd1e536e..e5eaa0797cf7 100644 --- a/clients/client-personalize/commands/UpdateCampaignCommand.ts +++ b/clients/client-personalize/commands/UpdateCampaignCommand.ts @@ -30,6 +30,20 @@ export interface UpdateCampaignCommandOutput extends UpdateCampaignResponse, __M * updated campaign is ACTIVE before asking the campaign for recommendations.

* *

For more information on campaigns, see CreateCampaign.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { PersonalizeClient, UpdateCampaignCommand } from "@aws-sdk/client-personalize"; // ES Modules import + * // const { PersonalizeClient, UpdateCampaignCommand } = require("@aws-sdk/client-personalize"); // CommonJS import + * const client = new PersonalizeClient(config); + * const command = new UpdateCampaignCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link UpdateCampaignCommandInput} for command's `input` shape. + * @see {@link UpdateCampaignCommandOutput} for command's `response` shape. + * @see {@link PersonalizeClientResolvedConfig | config} for command's `input` shape. + * */ export class UpdateCampaignCommand extends $Command< UpdateCampaignCommandInput, diff --git a/clients/client-personalize/models/models_0.ts b/clients/client-personalize/models/models_0.ts index b6b7aa089651..5f40057c8052 100644 --- a/clients/client-personalize/models/models_0.ts +++ b/clients/client-personalize/models/models_0.ts @@ -17,6 +17,9 @@ export interface AlgorithmImage { } export namespace AlgorithmImage { + /** + * @internal + */ export const filterSensitiveLog = (obj: AlgorithmImage): any => ({ ...obj, }); @@ -45,6 +48,9 @@ export interface DefaultCategoricalHyperParameterRange { } export namespace DefaultCategoricalHyperParameterRange { + /** + * @internal + */ export const filterSensitiveLog = (obj: DefaultCategoricalHyperParameterRange): any => ({ ...obj, }); @@ -78,6 +84,9 @@ export interface DefaultContinuousHyperParameterRange { } export namespace DefaultContinuousHyperParameterRange { + /** + * @internal + */ export const filterSensitiveLog = (obj: DefaultContinuousHyperParameterRange): any => ({ ...obj, }); @@ -111,6 +120,9 @@ export interface DefaultIntegerHyperParameterRange { } export namespace DefaultIntegerHyperParameterRange { + /** + * @internal + */ export const filterSensitiveLog = (obj: DefaultIntegerHyperParameterRange): any => ({ ...obj, }); @@ -138,6 +150,9 @@ export interface DefaultHyperParameterRanges { } export namespace DefaultHyperParameterRanges { + /** + * @internal + */ export const filterSensitiveLog = (obj: DefaultHyperParameterRanges): any => ({ ...obj, }); @@ -201,6 +216,9 @@ export interface Algorithm { } export namespace Algorithm { + /** + * @internal + */ export const filterSensitiveLog = (obj: Algorithm): any => ({ ...obj, }); @@ -220,6 +238,9 @@ export interface BatchInferenceJobConfig { } export namespace BatchInferenceJobConfig { + /** + * @internal + */ export const filterSensitiveLog = (obj: BatchInferenceJobConfig): any => ({ ...obj, }); @@ -242,6 +263,9 @@ export interface S3DataConfig { } export namespace S3DataConfig { + /** + * @internal + */ export const filterSensitiveLog = (obj: S3DataConfig): any => ({ ...obj, }); @@ -259,6 +283,9 @@ export interface BatchInferenceJobInput { } export namespace BatchInferenceJobInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: BatchInferenceJobInput): any => ({ ...obj, }); @@ -275,6 +302,9 @@ export interface BatchInferenceJobOutput { } export namespace BatchInferenceJobOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: BatchInferenceJobOutput): any => ({ ...obj, }); @@ -328,6 +358,9 @@ export interface CreateBatchInferenceJobRequest { } export namespace CreateBatchInferenceJobRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateBatchInferenceJobRequest): any => ({ ...obj, }); @@ -341,6 +374,9 @@ export interface CreateBatchInferenceJobResponse { } export namespace CreateBatchInferenceJobResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateBatchInferenceJobResponse): any => ({ ...obj, }); @@ -356,6 +392,9 @@ export interface InvalidInputException extends __SmithyException, $MetadataBeare } export namespace InvalidInputException { + /** + * @internal + */ export const filterSensitiveLog = (obj: InvalidInputException): any => ({ ...obj, }); @@ -371,6 +410,9 @@ export interface LimitExceededException extends __SmithyException, $MetadataBear } export namespace LimitExceededException { + /** + * @internal + */ export const filterSensitiveLog = (obj: LimitExceededException): any => ({ ...obj, }); @@ -386,6 +428,9 @@ export interface ResourceAlreadyExistsException extends __SmithyException, $Meta } export namespace ResourceAlreadyExistsException { + /** + * @internal + */ export const filterSensitiveLog = (obj: ResourceAlreadyExistsException): any => ({ ...obj, }); @@ -401,6 +446,9 @@ export interface ResourceInUseException extends __SmithyException, $MetadataBear } export namespace ResourceInUseException { + /** + * @internal + */ export const filterSensitiveLog = (obj: ResourceInUseException): any => ({ ...obj, }); @@ -416,6 +464,9 @@ export interface ResourceNotFoundException extends __SmithyException, $MetadataB } export namespace ResourceNotFoundException { + /** + * @internal + */ export const filterSensitiveLog = (obj: ResourceNotFoundException): any => ({ ...obj, }); @@ -435,6 +486,9 @@ export interface CampaignConfig { } export namespace CampaignConfig { + /** + * @internal + */ export const filterSensitiveLog = (obj: CampaignConfig): any => ({ ...obj, }); @@ -464,6 +518,9 @@ export interface CreateCampaignRequest { } export namespace CreateCampaignRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateCampaignRequest): any => ({ ...obj, }); @@ -477,6 +534,9 @@ export interface CreateCampaignResponse { } export namespace CreateCampaignResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateCampaignResponse): any => ({ ...obj, }); @@ -518,6 +578,9 @@ export interface CreateDatasetRequest { } export namespace CreateDatasetRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateDatasetRequest): any => ({ ...obj, }); @@ -531,6 +594,9 @@ export interface CreateDatasetResponse { } export namespace CreateDatasetResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateDatasetResponse): any => ({ ...obj, }); @@ -553,6 +619,9 @@ export interface DatasetExportJobOutput { } export namespace DatasetExportJobOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: DatasetExportJobOutput): any => ({ ...obj, }); @@ -590,6 +659,9 @@ export interface CreateDatasetExportJobRequest { } export namespace CreateDatasetExportJobRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateDatasetExportJobRequest): any => ({ ...obj, }); @@ -603,6 +675,9 @@ export interface CreateDatasetExportJobResponse { } export namespace CreateDatasetExportJobResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateDatasetExportJobResponse): any => ({ ...obj, }); @@ -627,6 +702,9 @@ export interface CreateDatasetGroupRequest { } export namespace CreateDatasetGroupRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateDatasetGroupRequest): any => ({ ...obj, }); @@ -640,6 +718,9 @@ export interface CreateDatasetGroupResponse { } export namespace CreateDatasetGroupResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateDatasetGroupResponse): any => ({ ...obj, }); @@ -660,6 +741,9 @@ export interface DataSource { } export namespace DataSource { + /** + * @internal + */ export const filterSensitiveLog = (obj: DataSource): any => ({ ...obj, }); @@ -688,6 +772,9 @@ export interface CreateDatasetImportJobRequest { } export namespace CreateDatasetImportJobRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateDatasetImportJobRequest): any => ({ ...obj, }); @@ -701,6 +788,9 @@ export interface CreateDatasetImportJobResponse { } export namespace CreateDatasetImportJobResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateDatasetImportJobResponse): any => ({ ...obj, }); @@ -719,6 +809,9 @@ export interface CreateEventTrackerRequest { } export namespace CreateEventTrackerRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateEventTrackerRequest): any => ({ ...obj, }); @@ -738,6 +831,9 @@ export interface CreateEventTrackerResponse { } export namespace CreateEventTrackerResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateEventTrackerResponse): any => ({ ...obj, }); @@ -763,6 +859,9 @@ export interface CreateFilterRequest { } export namespace CreateFilterRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateFilterRequest): any => ({ ...obj, ...(obj.filterExpression && { filterExpression: SENSITIVE_STRING }), @@ -777,6 +876,9 @@ export interface CreateFilterResponse { } export namespace CreateFilterResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateFilterResponse): any => ({ ...obj, }); @@ -795,6 +897,9 @@ export interface CreateSchemaRequest { } export namespace CreateSchemaRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateSchemaRequest): any => ({ ...obj, }); @@ -808,6 +913,9 @@ export interface CreateSchemaResponse { } export namespace CreateSchemaResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateSchemaResponse): any => ({ ...obj, }); @@ -832,6 +940,9 @@ export interface AutoMLConfig { } export namespace AutoMLConfig { + /** + * @internal + */ export const filterSensitiveLog = (obj: AutoMLConfig): any => ({ ...obj, }); @@ -853,6 +964,9 @@ export interface CategoricalHyperParameterRange { } export namespace CategoricalHyperParameterRange { + /** + * @internal + */ export const filterSensitiveLog = (obj: CategoricalHyperParameterRange): any => ({ ...obj, }); @@ -879,6 +993,9 @@ export interface ContinuousHyperParameterRange { } export namespace ContinuousHyperParameterRange { + /** + * @internal + */ export const filterSensitiveLog = (obj: ContinuousHyperParameterRange): any => ({ ...obj, }); @@ -905,6 +1022,9 @@ export interface IntegerHyperParameterRange { } export namespace IntegerHyperParameterRange { + /** + * @internal + */ export const filterSensitiveLog = (obj: IntegerHyperParameterRange): any => ({ ...obj, }); @@ -932,6 +1052,9 @@ export interface HyperParameterRanges { } export namespace HyperParameterRanges { + /** + * @internal + */ export const filterSensitiveLog = (obj: HyperParameterRanges): any => ({ ...obj, }); @@ -962,6 +1085,9 @@ export interface HPOObjective { } export namespace HPOObjective { + /** + * @internal + */ export const filterSensitiveLog = (obj: HPOObjective): any => ({ ...obj, }); @@ -993,6 +1119,9 @@ export interface HPOResourceConfig { } export namespace HPOResourceConfig { + /** + * @internal + */ export const filterSensitiveLog = (obj: HPOResourceConfig): any => ({ ...obj, }); @@ -1023,6 +1152,9 @@ export interface HPOConfig { } export namespace HPOConfig { + /** + * @internal + */ export const filterSensitiveLog = (obj: HPOConfig): any => ({ ...obj, }); @@ -1061,6 +1193,9 @@ export interface SolutionConfig { } export namespace SolutionConfig { + /** + * @internal + */ export const filterSensitiveLog = (obj: SolutionConfig): any => ({ ...obj, }); @@ -1124,6 +1259,9 @@ export interface CreateSolutionRequest { } export namespace CreateSolutionRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateSolutionRequest): any => ({ ...obj, }); @@ -1137,6 +1275,9 @@ export interface CreateSolutionResponse { } export namespace CreateSolutionResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateSolutionResponse): any => ({ ...obj, }); @@ -1173,6 +1314,9 @@ export interface CreateSolutionVersionRequest { } export namespace CreateSolutionVersionRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateSolutionVersionRequest): any => ({ ...obj, }); @@ -1186,6 +1330,9 @@ export interface CreateSolutionVersionResponse { } export namespace CreateSolutionVersionResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateSolutionVersionResponse): any => ({ ...obj, }); @@ -1199,6 +1346,9 @@ export interface DeleteCampaignRequest { } export namespace DeleteCampaignRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteCampaignRequest): any => ({ ...obj, }); @@ -1212,6 +1362,9 @@ export interface DeleteDatasetRequest { } export namespace DeleteDatasetRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteDatasetRequest): any => ({ ...obj, }); @@ -1225,6 +1378,9 @@ export interface DeleteDatasetGroupRequest { } export namespace DeleteDatasetGroupRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteDatasetGroupRequest): any => ({ ...obj, }); @@ -1238,6 +1394,9 @@ export interface DeleteEventTrackerRequest { } export namespace DeleteEventTrackerRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteEventTrackerRequest): any => ({ ...obj, }); @@ -1251,6 +1410,9 @@ export interface DeleteFilterRequest { } export namespace DeleteFilterRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteFilterRequest): any => ({ ...obj, }); @@ -1264,6 +1426,9 @@ export interface DeleteSchemaRequest { } export namespace DeleteSchemaRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteSchemaRequest): any => ({ ...obj, }); @@ -1277,6 +1442,9 @@ export interface DeleteSolutionRequest { } export namespace DeleteSolutionRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteSolutionRequest): any => ({ ...obj, }); @@ -1290,6 +1458,9 @@ export interface DescribeAlgorithmRequest { } export namespace DescribeAlgorithmRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeAlgorithmRequest): any => ({ ...obj, }); @@ -1303,6 +1474,9 @@ export interface DescribeAlgorithmResponse { } export namespace DescribeAlgorithmResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeAlgorithmResponse): any => ({ ...obj, }); @@ -1316,6 +1490,9 @@ export interface DescribeBatchInferenceJobRequest { } export namespace DescribeBatchInferenceJobRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeBatchInferenceJobRequest): any => ({ ...obj, }); @@ -1409,6 +1586,9 @@ export interface BatchInferenceJob { } export namespace BatchInferenceJob { + /** + * @internal + */ export const filterSensitiveLog = (obj: BatchInferenceJob): any => ({ ...obj, }); @@ -1422,6 +1602,9 @@ export interface DescribeBatchInferenceJobResponse { } export namespace DescribeBatchInferenceJobResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeBatchInferenceJobResponse): any => ({ ...obj, }); @@ -1435,6 +1618,9 @@ export interface DescribeCampaignRequest { } export namespace DescribeCampaignRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeCampaignRequest): any => ({ ...obj, }); @@ -1492,6 +1678,9 @@ export interface CampaignUpdateSummary { } export namespace CampaignUpdateSummary { + /** + * @internal + */ export const filterSensitiveLog = (obj: CampaignUpdateSummary): any => ({ ...obj, }); @@ -1564,6 +1753,9 @@ export interface Campaign { } export namespace Campaign { + /** + * @internal + */ export const filterSensitiveLog = (obj: Campaign): any => ({ ...obj, }); @@ -1577,6 +1769,9 @@ export interface DescribeCampaignResponse { } export namespace DescribeCampaignResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeCampaignResponse): any => ({ ...obj, }); @@ -1590,6 +1785,9 @@ export interface DescribeDatasetRequest { } export namespace DescribeDatasetRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeDatasetRequest): any => ({ ...obj, }); @@ -1661,6 +1859,9 @@ export interface Dataset { } export namespace Dataset { + /** + * @internal + */ export const filterSensitiveLog = (obj: Dataset): any => ({ ...obj, }); @@ -1674,6 +1875,9 @@ export interface DescribeDatasetResponse { } export namespace DescribeDatasetResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeDatasetResponse): any => ({ ...obj, }); @@ -1687,6 +1891,9 @@ export interface DescribeDatasetExportJobRequest { } export namespace DescribeDatasetExportJobRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeDatasetExportJobRequest): any => ({ ...obj, }); @@ -1767,6 +1974,9 @@ export interface DatasetExportJob { } export namespace DatasetExportJob { + /** + * @internal + */ export const filterSensitiveLog = (obj: DatasetExportJob): any => ({ ...obj, }); @@ -1795,6 +2005,9 @@ export interface DescribeDatasetExportJobResponse { } export namespace DescribeDatasetExportJobResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeDatasetExportJobResponse): any => ({ ...obj, }); @@ -1808,6 +2021,9 @@ export interface DescribeDatasetGroupRequest { } export namespace DescribeDatasetGroupRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeDatasetGroupRequest): any => ({ ...obj, }); @@ -1873,6 +2089,9 @@ export interface DatasetGroup { } export namespace DatasetGroup { + /** + * @internal + */ export const filterSensitiveLog = (obj: DatasetGroup): any => ({ ...obj, }); @@ -1886,6 +2105,9 @@ export interface DescribeDatasetGroupResponse { } export namespace DescribeDatasetGroupResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeDatasetGroupResponse): any => ({ ...obj, }); @@ -1899,6 +2121,9 @@ export interface DescribeDatasetImportJobRequest { } export namespace DescribeDatasetImportJobRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeDatasetImportJobRequest): any => ({ ...obj, }); @@ -1969,6 +2194,9 @@ export interface DatasetImportJob { } export namespace DatasetImportJob { + /** + * @internal + */ export const filterSensitiveLog = (obj: DatasetImportJob): any => ({ ...obj, }); @@ -1997,6 +2225,9 @@ export interface DescribeDatasetImportJobResponse { } export namespace DescribeDatasetImportJobResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeDatasetImportJobResponse): any => ({ ...obj, }); @@ -2010,6 +2241,9 @@ export interface DescribeEventTrackerRequest { } export namespace DescribeEventTrackerRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeEventTrackerRequest): any => ({ ...obj, }); @@ -2071,6 +2305,9 @@ export interface EventTracker { } export namespace EventTracker { + /** + * @internal + */ export const filterSensitiveLog = (obj: EventTracker): any => ({ ...obj, }); @@ -2084,6 +2321,9 @@ export interface DescribeEventTrackerResponse { } export namespace DescribeEventTrackerResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeEventTrackerResponse): any => ({ ...obj, }); @@ -2097,6 +2337,9 @@ export interface DescribeFeatureTransformationRequest { } export namespace DescribeFeatureTransformationRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeFeatureTransformationRequest): any => ({ ...obj, }); @@ -2145,6 +2388,9 @@ export interface FeatureTransformation { } export namespace FeatureTransformation { + /** + * @internal + */ export const filterSensitiveLog = (obj: FeatureTransformation): any => ({ ...obj, }); @@ -2158,6 +2404,9 @@ export interface DescribeFeatureTransformationResponse { } export namespace DescribeFeatureTransformationResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeFeatureTransformationResponse): any => ({ ...obj, }); @@ -2171,6 +2420,9 @@ export interface DescribeFilterRequest { } export namespace DescribeFilterRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeFilterRequest): any => ({ ...obj, }); @@ -2225,6 +2477,9 @@ export interface Filter { } export namespace Filter { + /** + * @internal + */ export const filterSensitiveLog = (obj: Filter): any => ({ ...obj, ...(obj.filterExpression && { filterExpression: SENSITIVE_STRING }), @@ -2239,6 +2494,9 @@ export interface DescribeFilterResponse { } export namespace DescribeFilterResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeFilterResponse): any => ({ ...obj, ...(obj.filter && { filter: Filter.filterSensitiveLog(obj.filter) }), @@ -2253,6 +2511,9 @@ export interface DescribeRecipeRequest { } export namespace DescribeRecipeRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeRecipeRequest): any => ({ ...obj, }); @@ -2323,6 +2584,9 @@ export interface Recipe { } export namespace Recipe { + /** + * @internal + */ export const filterSensitiveLog = (obj: Recipe): any => ({ ...obj, }); @@ -2336,6 +2600,9 @@ export interface DescribeRecipeResponse { } export namespace DescribeRecipeResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeRecipeResponse): any => ({ ...obj, }); @@ -2349,6 +2616,9 @@ export interface DescribeSchemaRequest { } export namespace DescribeSchemaRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeSchemaRequest): any => ({ ...obj, }); @@ -2386,6 +2656,9 @@ export interface DatasetSchema { } export namespace DatasetSchema { + /** + * @internal + */ export const filterSensitiveLog = (obj: DatasetSchema): any => ({ ...obj, }); @@ -2399,6 +2672,9 @@ export interface DescribeSchemaResponse { } export namespace DescribeSchemaResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeSchemaResponse): any => ({ ...obj, }); @@ -2412,6 +2688,9 @@ export interface DescribeSolutionRequest { } export namespace DescribeSolutionRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeSolutionRequest): any => ({ ...obj, }); @@ -2430,6 +2709,9 @@ export interface AutoMLResult { } export namespace AutoMLResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: AutoMLResult): any => ({ ...obj, }); @@ -2473,6 +2755,9 @@ export interface SolutionVersionSummary { } export namespace SolutionVersionSummary { + /** + * @internal + */ export const filterSensitiveLog = (obj: SolutionVersionSummary): any => ({ ...obj, }); @@ -2564,6 +2849,9 @@ export interface Solution { } export namespace Solution { + /** + * @internal + */ export const filterSensitiveLog = (obj: Solution): any => ({ ...obj, }); @@ -2577,6 +2865,9 @@ export interface DescribeSolutionResponse { } export namespace DescribeSolutionResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeSolutionResponse): any => ({ ...obj, }); @@ -2590,6 +2881,9 @@ export interface DescribeSolutionVersionRequest { } export namespace DescribeSolutionVersionRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeSolutionVersionRequest): any => ({ ...obj, }); @@ -2607,6 +2901,9 @@ export interface TunedHPOParams { } export namespace TunedHPOParams { + /** + * @internal + */ export const filterSensitiveLog = (obj: TunedHPOParams): any => ({ ...obj, }); @@ -2729,6 +3026,9 @@ export interface SolutionVersion { } export namespace SolutionVersion { + /** + * @internal + */ export const filterSensitiveLog = (obj: SolutionVersion): any => ({ ...obj, }); @@ -2742,6 +3042,9 @@ export interface DescribeSolutionVersionResponse { } export namespace DescribeSolutionVersionResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeSolutionVersionResponse): any => ({ ...obj, }); @@ -2755,6 +3058,9 @@ export interface GetSolutionMetricsRequest { } export namespace GetSolutionMetricsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetSolutionMetricsRequest): any => ({ ...obj, }); @@ -2773,6 +3079,9 @@ export interface GetSolutionMetricsResponse { } export namespace GetSolutionMetricsResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetSolutionMetricsResponse): any => ({ ...obj, }); @@ -2788,6 +3097,9 @@ export interface InvalidNextTokenException extends __SmithyException, $MetadataB } export namespace InvalidNextTokenException { + /** + * @internal + */ export const filterSensitiveLog = (obj: InvalidNextTokenException): any => ({ ...obj, }); @@ -2813,6 +3125,9 @@ export interface ListBatchInferenceJobsRequest { } export namespace ListBatchInferenceJobsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListBatchInferenceJobsRequest): any => ({ ...obj, }); @@ -2874,6 +3189,9 @@ export interface BatchInferenceJobSummary { } export namespace BatchInferenceJobSummary { + /** + * @internal + */ export const filterSensitiveLog = (obj: BatchInferenceJobSummary): any => ({ ...obj, }); @@ -2893,6 +3211,9 @@ export interface ListBatchInferenceJobsResponse { } export namespace ListBatchInferenceJobsResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListBatchInferenceJobsResponse): any => ({ ...obj, }); @@ -2918,6 +3239,9 @@ export interface ListCampaignsRequest { } export namespace ListCampaignsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListCampaignsRequest): any => ({ ...obj, }); @@ -2969,6 +3293,9 @@ export interface CampaignSummary { } export namespace CampaignSummary { + /** + * @internal + */ export const filterSensitiveLog = (obj: CampaignSummary): any => ({ ...obj, }); @@ -2987,6 +3314,9 @@ export interface ListCampaignsResponse { } export namespace ListCampaignsResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListCampaignsResponse): any => ({ ...obj, }); @@ -3011,6 +3341,9 @@ export interface ListDatasetExportJobsRequest { } export namespace ListDatasetExportJobsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListDatasetExportJobsRequest): any => ({ ...obj, }); @@ -3059,6 +3392,9 @@ export interface DatasetExportJobSummary { } export namespace DatasetExportJobSummary { + /** + * @internal + */ export const filterSensitiveLog = (obj: DatasetExportJobSummary): any => ({ ...obj, }); @@ -3077,6 +3413,9 @@ export interface ListDatasetExportJobsResponse { } export namespace ListDatasetExportJobsResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListDatasetExportJobsResponse): any => ({ ...obj, }); @@ -3096,6 +3435,9 @@ export interface ListDatasetGroupsRequest { } export namespace ListDatasetGroupsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListDatasetGroupsRequest): any => ({ ...obj, }); @@ -3147,6 +3489,9 @@ export interface DatasetGroupSummary { } export namespace DatasetGroupSummary { + /** + * @internal + */ export const filterSensitiveLog = (obj: DatasetGroupSummary): any => ({ ...obj, }); @@ -3165,6 +3510,9 @@ export interface ListDatasetGroupsResponse { } export namespace ListDatasetGroupsResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListDatasetGroupsResponse): any => ({ ...obj, }); @@ -3189,6 +3537,9 @@ export interface ListDatasetImportJobsRequest { } export namespace ListDatasetImportJobsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListDatasetImportJobsRequest): any => ({ ...obj, }); @@ -3237,6 +3588,9 @@ export interface DatasetImportJobSummary { } export namespace DatasetImportJobSummary { + /** + * @internal + */ export const filterSensitiveLog = (obj: DatasetImportJobSummary): any => ({ ...obj, }); @@ -3255,6 +3609,9 @@ export interface ListDatasetImportJobsResponse { } export namespace ListDatasetImportJobsResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListDatasetImportJobsResponse): any => ({ ...obj, }); @@ -3280,6 +3637,9 @@ export interface ListDatasetsRequest { } export namespace ListDatasetsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListDatasetsRequest): any => ({ ...obj, }); @@ -3345,6 +3705,9 @@ export interface DatasetSummary { } export namespace DatasetSummary { + /** + * @internal + */ export const filterSensitiveLog = (obj: DatasetSummary): any => ({ ...obj, }); @@ -3364,6 +3727,9 @@ export interface ListDatasetsResponse { } export namespace ListDatasetsResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListDatasetsResponse): any => ({ ...obj, }); @@ -3388,6 +3754,9 @@ export interface ListEventTrackersRequest { } export namespace ListEventTrackersRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListEventTrackersRequest): any => ({ ...obj, }); @@ -3434,6 +3803,9 @@ export interface EventTrackerSummary { } export namespace EventTrackerSummary { + /** + * @internal + */ export const filterSensitiveLog = (obj: EventTrackerSummary): any => ({ ...obj, }); @@ -3452,6 +3824,9 @@ export interface ListEventTrackersResponse { } export namespace ListEventTrackersResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListEventTrackersResponse): any => ({ ...obj, }); @@ -3476,6 +3851,9 @@ export interface ListFiltersRequest { } export namespace ListFiltersRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListFiltersRequest): any => ({ ...obj, }); @@ -3522,6 +3900,9 @@ export interface FilterSummary { } export namespace FilterSummary { + /** + * @internal + */ export const filterSensitiveLog = (obj: FilterSummary): any => ({ ...obj, }); @@ -3540,6 +3921,9 @@ export interface ListFiltersResponse { } export namespace ListFiltersResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListFiltersResponse): any => ({ ...obj, }); @@ -3568,6 +3952,9 @@ export interface ListRecipesRequest { } export namespace ListRecipesRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListRecipesRequest): any => ({ ...obj, }); @@ -3605,6 +3992,9 @@ export interface RecipeSummary { } export namespace RecipeSummary { + /** + * @internal + */ export const filterSensitiveLog = (obj: RecipeSummary): any => ({ ...obj, }); @@ -3623,6 +4013,9 @@ export interface ListRecipesResponse { } export namespace ListRecipesResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListRecipesResponse): any => ({ ...obj, }); @@ -3642,6 +4035,9 @@ export interface ListSchemasRequest { } export namespace ListSchemasRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListSchemasRequest): any => ({ ...obj, }); @@ -3674,6 +4070,9 @@ export interface DatasetSchemaSummary { } export namespace DatasetSchemaSummary { + /** + * @internal + */ export const filterSensitiveLog = (obj: DatasetSchemaSummary): any => ({ ...obj, }); @@ -3692,6 +4091,9 @@ export interface ListSchemasResponse { } export namespace ListSchemasResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListSchemasResponse): any => ({ ...obj, }); @@ -3716,6 +4118,9 @@ export interface ListSolutionsRequest { } export namespace ListSolutionsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListSolutionsRequest): any => ({ ...obj, }); @@ -3762,6 +4167,9 @@ export interface SolutionSummary { } export namespace SolutionSummary { + /** + * @internal + */ export const filterSensitiveLog = (obj: SolutionSummary): any => ({ ...obj, }); @@ -3780,6 +4188,9 @@ export interface ListSolutionsResponse { } export namespace ListSolutionsResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListSolutionsResponse): any => ({ ...obj, }); @@ -3804,6 +4215,9 @@ export interface ListSolutionVersionsRequest { } export namespace ListSolutionVersionsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListSolutionVersionsRequest): any => ({ ...obj, }); @@ -3822,6 +4236,9 @@ export interface ListSolutionVersionsResponse { } export namespace ListSolutionVersionsResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListSolutionVersionsResponse): any => ({ ...obj, }); @@ -3851,6 +4268,9 @@ export interface UpdateCampaignRequest { } export namespace UpdateCampaignRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateCampaignRequest): any => ({ ...obj, }); @@ -3864,6 +4284,9 @@ export interface UpdateCampaignResponse { } export namespace UpdateCampaignResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateCampaignResponse): any => ({ ...obj, }); diff --git a/clients/client-pi/commands/DescribeDimensionKeysCommand.ts b/clients/client-pi/commands/DescribeDimensionKeysCommand.ts index d3242b550e29..9190c9e4bc95 100644 --- a/clients/client-pi/commands/DescribeDimensionKeysCommand.ts +++ b/clients/client-pi/commands/DescribeDimensionKeysCommand.ts @@ -27,6 +27,20 @@ export interface DescribeDimensionKeysCommandOutput extends DescribeDimensionKey *

Each response element returns a maximum of 500 bytes. For larger elements, such as SQL statements, * only the first 500 bytes are returned.

* + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { PIClient, DescribeDimensionKeysCommand } from "@aws-sdk/client-pi"; // ES Modules import + * // const { PIClient, DescribeDimensionKeysCommand } = require("@aws-sdk/client-pi"); // CommonJS import + * const client = new PIClient(config); + * const command = new DescribeDimensionKeysCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeDimensionKeysCommandInput} for command's `input` shape. + * @see {@link DescribeDimensionKeysCommandOutput} for command's `response` shape. + * @see {@link PIClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeDimensionKeysCommand extends $Command< DescribeDimensionKeysCommandInput, diff --git a/clients/client-pi/commands/GetResourceMetricsCommand.ts b/clients/client-pi/commands/GetResourceMetricsCommand.ts index 02c8e4448344..f55991ee5699 100644 --- a/clients/client-pi/commands/GetResourceMetricsCommand.ts +++ b/clients/client-pi/commands/GetResourceMetricsCommand.ts @@ -28,6 +28,20 @@ export interface GetResourceMetricsCommandOutput extends GetResourceMetricsRespo *

Each response element returns a maximum of 500 bytes. For larger elements, such as SQL statements, * only the first 500 bytes are returned.

* + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { PIClient, GetResourceMetricsCommand } from "@aws-sdk/client-pi"; // ES Modules import + * // const { PIClient, GetResourceMetricsCommand } = require("@aws-sdk/client-pi"); // CommonJS import + * const client = new PIClient(config); + * const command = new GetResourceMetricsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetResourceMetricsCommandInput} for command's `input` shape. + * @see {@link GetResourceMetricsCommandOutput} for command's `response` shape. + * @see {@link PIClientResolvedConfig | config} for command's `input` shape. + * */ export class GetResourceMetricsCommand extends $Command< GetResourceMetricsCommandInput, diff --git a/clients/client-pi/models/models_0.ts b/clients/client-pi/models/models_0.ts index 39006070dd08..4ad7f5b36c60 100644 --- a/clients/client-pi/models/models_0.ts +++ b/clients/client-pi/models/models_0.ts @@ -17,6 +17,9 @@ export interface DataPoint { } export namespace DataPoint { + /** + * @internal + */ export const filterSensitiveLog = (obj: DataPoint): any => ({ ...obj, }); @@ -169,6 +172,9 @@ export interface DimensionGroup { } export namespace DimensionGroup { + /** + * @internal + */ export const filterSensitiveLog = (obj: DimensionGroup): any => ({ ...obj, }); @@ -312,6 +318,9 @@ export interface DescribeDimensionKeysRequest { } export namespace DescribeDimensionKeysRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeDimensionKeysRequest): any => ({ ...obj, }); @@ -339,6 +348,9 @@ export interface DimensionKeyDescription { } export namespace DimensionKeyDescription { + /** + * @internal + */ export const filterSensitiveLog = (obj: DimensionKeyDescription): any => ({ ...obj, }); @@ -357,6 +369,9 @@ export interface ResponsePartitionKey { } export namespace ResponsePartitionKey { + /** + * @internal + */ export const filterSensitiveLog = (obj: ResponsePartitionKey): any => ({ ...obj, }); @@ -396,6 +411,9 @@ export interface DescribeDimensionKeysResponse { } export namespace DescribeDimensionKeysResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeDimensionKeysResponse): any => ({ ...obj, }); @@ -411,6 +429,9 @@ export interface InternalServiceError extends __SmithyException, $MetadataBearer } export namespace InternalServiceError { + /** + * @internal + */ export const filterSensitiveLog = (obj: InternalServiceError): any => ({ ...obj, }); @@ -426,6 +447,9 @@ export interface InvalidArgumentException extends __SmithyException, $MetadataBe } export namespace InvalidArgumentException { + /** + * @internal + */ export const filterSensitiveLog = (obj: InvalidArgumentException): any => ({ ...obj, }); @@ -441,6 +465,9 @@ export interface NotAuthorizedException extends __SmithyException, $MetadataBear } export namespace NotAuthorizedException { + /** + * @internal + */ export const filterSensitiveLog = (obj: NotAuthorizedException): any => ({ ...obj, }); @@ -499,6 +526,9 @@ export interface MetricQuery { } export namespace MetricQuery { + /** + * @internal + */ export const filterSensitiveLog = (obj: MetricQuery): any => ({ ...obj, }); @@ -591,6 +621,9 @@ export interface GetResourceMetricsRequest { } export namespace GetResourceMetricsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetResourceMetricsRequest): any => ({ ...obj, }); @@ -630,6 +663,9 @@ export interface ResponseResourceMetricKey { } export namespace ResponseResourceMetricKey { + /** + * @internal + */ export const filterSensitiveLog = (obj: ResponseResourceMetricKey): any => ({ ...obj, }); @@ -652,6 +688,9 @@ export interface MetricKeyDataPoints { } export namespace MetricKeyDataPoints { + /** + * @internal + */ export const filterSensitiveLog = (obj: MetricKeyDataPoints): any => ({ ...obj, }); @@ -696,6 +735,9 @@ export interface GetResourceMetricsResponse { } export namespace GetResourceMetricsResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetResourceMetricsResponse): any => ({ ...obj, }); diff --git a/clients/client-pinpoint-email/commands/CreateConfigurationSetCommand.ts b/clients/client-pinpoint-email/commands/CreateConfigurationSetCommand.ts index b60d2e998468..a89cd8452ae0 100644 --- a/clients/client-pinpoint-email/commands/CreateConfigurationSetCommand.ts +++ b/clients/client-pinpoint-email/commands/CreateConfigurationSetCommand.ts @@ -26,6 +26,20 @@ export interface CreateConfigurationSetCommandOutput extends CreateConfiguration * 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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { PinpointEmailClient, CreateConfigurationSetCommand } from "@aws-sdk/client-pinpoint-email"; // ES Modules import + * // const { PinpointEmailClient, CreateConfigurationSetCommand } = require("@aws-sdk/client-pinpoint-email"); // CommonJS import + * const client = new PinpointEmailClient(config); + * const command = new CreateConfigurationSetCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreateConfigurationSetCommandInput} for command's `input` shape. + * @see {@link CreateConfigurationSetCommandOutput} for command's `response` shape. + * @see {@link PinpointEmailClientResolvedConfig | config} for command's `input` shape. + * */ export class CreateConfigurationSetCommand extends $Command< CreateConfigurationSetCommandInput, diff --git a/clients/client-pinpoint-email/commands/CreateConfigurationSetEventDestinationCommand.ts b/clients/client-pinpoint-email/commands/CreateConfigurationSetEventDestinationCommand.ts index cc785d65f4af..52dd778b3f2a 100644 --- a/clients/client-pinpoint-email/commands/CreateConfigurationSetEventDestinationCommand.ts +++ b/clients/client-pinpoint-email/commands/CreateConfigurationSetEventDestinationCommand.ts @@ -34,6 +34,20 @@ export interface CreateConfigurationSetEventDestinationCommandOutput * 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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { PinpointEmailClient, CreateConfigurationSetEventDestinationCommand } from "@aws-sdk/client-pinpoint-email"; // ES Modules import + * // const { PinpointEmailClient, CreateConfigurationSetEventDestinationCommand } = require("@aws-sdk/client-pinpoint-email"); // CommonJS import + * const client = new PinpointEmailClient(config); + * const command = new CreateConfigurationSetEventDestinationCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreateConfigurationSetEventDestinationCommandInput} for command's `input` shape. + * @see {@link CreateConfigurationSetEventDestinationCommandOutput} for command's `response` shape. + * @see {@link PinpointEmailClientResolvedConfig | config} for command's `input` shape. + * */ export class CreateConfigurationSetEventDestinationCommand extends $Command< CreateConfigurationSetEventDestinationCommandInput, diff --git a/clients/client-pinpoint-email/commands/CreateDedicatedIpPoolCommand.ts b/clients/client-pinpoint-email/commands/CreateDedicatedIpPoolCommand.ts index 764a509a6a2f..fdc5c489bb2d 100644 --- a/clients/client-pinpoint-email/commands/CreateDedicatedIpPoolCommand.ts +++ b/clients/client-pinpoint-email/commands/CreateDedicatedIpPoolCommand.ts @@ -25,6 +25,20 @@ export interface CreateDedicatedIpPoolCommandOutput extends CreateDedicatedIpPoo * 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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { PinpointEmailClient, CreateDedicatedIpPoolCommand } from "@aws-sdk/client-pinpoint-email"; // ES Modules import + * // const { PinpointEmailClient, CreateDedicatedIpPoolCommand } = require("@aws-sdk/client-pinpoint-email"); // CommonJS import + * const client = new PinpointEmailClient(config); + * const command = new CreateDedicatedIpPoolCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreateDedicatedIpPoolCommandInput} for command's `input` shape. + * @see {@link CreateDedicatedIpPoolCommandOutput} for command's `response` shape. + * @see {@link PinpointEmailClientResolvedConfig | config} for command's `input` shape. + * */ export class CreateDedicatedIpPoolCommand extends $Command< CreateDedicatedIpPoolCommandInput, diff --git a/clients/client-pinpoint-email/commands/CreateDeliverabilityTestReportCommand.ts b/clients/client-pinpoint-email/commands/CreateDeliverabilityTestReportCommand.ts index 2fde309a0468..acc2a53da32f 100644 --- a/clients/client-pinpoint-email/commands/CreateDeliverabilityTestReportCommand.ts +++ b/clients/client-pinpoint-email/commands/CreateDeliverabilityTestReportCommand.ts @@ -30,6 +30,20 @@ export interface CreateDeliverabilityTestReportCommandOutput * providers. After about 24 hours, the test is complete, and you can use the * GetDeliverabilityTestReport operation to view the results of the * test.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { PinpointEmailClient, CreateDeliverabilityTestReportCommand } from "@aws-sdk/client-pinpoint-email"; // ES Modules import + * // const { PinpointEmailClient, CreateDeliverabilityTestReportCommand } = require("@aws-sdk/client-pinpoint-email"); // CommonJS import + * const client = new PinpointEmailClient(config); + * const command = new CreateDeliverabilityTestReportCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreateDeliverabilityTestReportCommandInput} for command's `input` shape. + * @see {@link CreateDeliverabilityTestReportCommandOutput} for command's `response` shape. + * @see {@link PinpointEmailClientResolvedConfig | config} for command's `input` shape. + * */ export class CreateDeliverabilityTestReportCommand extends $Command< CreateDeliverabilityTestReportCommandInput, diff --git a/clients/client-pinpoint-email/commands/CreateEmailIdentityCommand.ts b/clients/client-pinpoint-email/commands/CreateEmailIdentityCommand.ts index 95114364ff1a..114fe15ccfe1 100644 --- a/clients/client-pinpoint-email/commands/CreateEmailIdentityCommand.ts +++ b/clients/client-pinpoint-email/commands/CreateEmailIdentityCommand.ts @@ -35,6 +35,20 @@ export interface CreateEmailIdentityCommandOutput extends CreateEmailIdentityRes * 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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { PinpointEmailClient, CreateEmailIdentityCommand } from "@aws-sdk/client-pinpoint-email"; // ES Modules import + * // const { PinpointEmailClient, CreateEmailIdentityCommand } = require("@aws-sdk/client-pinpoint-email"); // CommonJS import + * const client = new PinpointEmailClient(config); + * const command = new CreateEmailIdentityCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreateEmailIdentityCommandInput} for command's `input` shape. + * @see {@link CreateEmailIdentityCommandOutput} for command's `response` shape. + * @see {@link PinpointEmailClientResolvedConfig | config} for command's `input` shape. + * */ export class CreateEmailIdentityCommand extends $Command< CreateEmailIdentityCommandInput, diff --git a/clients/client-pinpoint-email/commands/DeleteConfigurationSetCommand.ts b/clients/client-pinpoint-email/commands/DeleteConfigurationSetCommand.ts index 95b57c2fb204..9c5519abf150 100644 --- a/clients/client-pinpoint-email/commands/DeleteConfigurationSetCommand.ts +++ b/clients/client-pinpoint-email/commands/DeleteConfigurationSetCommand.ts @@ -27,6 +27,20 @@ export interface DeleteConfigurationSetCommandOutput extends DeleteConfiguration * 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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { PinpointEmailClient, DeleteConfigurationSetCommand } from "@aws-sdk/client-pinpoint-email"; // ES Modules import + * // const { PinpointEmailClient, DeleteConfigurationSetCommand } = require("@aws-sdk/client-pinpoint-email"); // CommonJS import + * const client = new PinpointEmailClient(config); + * const command = new DeleteConfigurationSetCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteConfigurationSetCommandInput} for command's `input` shape. + * @see {@link DeleteConfigurationSetCommandOutput} for command's `response` shape. + * @see {@link PinpointEmailClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteConfigurationSetCommand extends $Command< DeleteConfigurationSetCommandInput, diff --git a/clients/client-pinpoint-email/commands/DeleteConfigurationSetEventDestinationCommand.ts b/clients/client-pinpoint-email/commands/DeleteConfigurationSetEventDestinationCommand.ts index 9f3c5160ceb3..2a8bfca7c0a0 100644 --- a/clients/client-pinpoint-email/commands/DeleteConfigurationSetEventDestinationCommand.ts +++ b/clients/client-pinpoint-email/commands/DeleteConfigurationSetEventDestinationCommand.ts @@ -33,6 +33,20 @@ export interface DeleteConfigurationSetEventDestinationCommandOutput * 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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { PinpointEmailClient, DeleteConfigurationSetEventDestinationCommand } from "@aws-sdk/client-pinpoint-email"; // ES Modules import + * // const { PinpointEmailClient, DeleteConfigurationSetEventDestinationCommand } = require("@aws-sdk/client-pinpoint-email"); // CommonJS import + * const client = new PinpointEmailClient(config); + * const command = new DeleteConfigurationSetEventDestinationCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteConfigurationSetEventDestinationCommandInput} for command's `input` shape. + * @see {@link DeleteConfigurationSetEventDestinationCommandOutput} for command's `response` shape. + * @see {@link PinpointEmailClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteConfigurationSetEventDestinationCommand extends $Command< DeleteConfigurationSetEventDestinationCommandInput, diff --git a/clients/client-pinpoint-email/commands/DeleteDedicatedIpPoolCommand.ts b/clients/client-pinpoint-email/commands/DeleteDedicatedIpPoolCommand.ts index 4224a2c254ac..6cd0c4f4ecd1 100644 --- a/clients/client-pinpoint-email/commands/DeleteDedicatedIpPoolCommand.ts +++ b/clients/client-pinpoint-email/commands/DeleteDedicatedIpPoolCommand.ts @@ -22,6 +22,20 @@ export interface DeleteDedicatedIpPoolCommandOutput extends DeleteDedicatedIpPoo /** *

Delete a dedicated IP pool.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { PinpointEmailClient, DeleteDedicatedIpPoolCommand } from "@aws-sdk/client-pinpoint-email"; // ES Modules import + * // const { PinpointEmailClient, DeleteDedicatedIpPoolCommand } = require("@aws-sdk/client-pinpoint-email"); // CommonJS import + * const client = new PinpointEmailClient(config); + * const command = new DeleteDedicatedIpPoolCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteDedicatedIpPoolCommandInput} for command's `input` shape. + * @see {@link DeleteDedicatedIpPoolCommandOutput} for command's `response` shape. + * @see {@link PinpointEmailClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteDedicatedIpPoolCommand extends $Command< DeleteDedicatedIpPoolCommandInput, diff --git a/clients/client-pinpoint-email/commands/DeleteEmailIdentityCommand.ts b/clients/client-pinpoint-email/commands/DeleteEmailIdentityCommand.ts index b9f3c6d92a86..4fedb0726ac8 100644 --- a/clients/client-pinpoint-email/commands/DeleteEmailIdentityCommand.ts +++ b/clients/client-pinpoint-email/commands/DeleteEmailIdentityCommand.ts @@ -23,6 +23,20 @@ export interface DeleteEmailIdentityCommandOutput extends DeleteEmailIdentityRes /** *

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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { PinpointEmailClient, DeleteEmailIdentityCommand } from "@aws-sdk/client-pinpoint-email"; // ES Modules import + * // const { PinpointEmailClient, DeleteEmailIdentityCommand } = require("@aws-sdk/client-pinpoint-email"); // CommonJS import + * const client = new PinpointEmailClient(config); + * const command = new DeleteEmailIdentityCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteEmailIdentityCommandInput} for command's `input` shape. + * @see {@link DeleteEmailIdentityCommandOutput} for command's `response` shape. + * @see {@link PinpointEmailClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteEmailIdentityCommand extends $Command< DeleteEmailIdentityCommandInput, diff --git a/clients/client-pinpoint-email/commands/GetAccountCommand.ts b/clients/client-pinpoint-email/commands/GetAccountCommand.ts index f2ea18a2063f..3e50d48a6db0 100644 --- a/clients/client-pinpoint-email/commands/GetAccountCommand.ts +++ b/clients/client-pinpoint-email/commands/GetAccountCommand.ts @@ -23,6 +23,20 @@ export interface GetAccountCommandOutput extends GetAccountResponse, __MetadataB /** *

Obtain information about the email-sending status and capabilities of your Amazon Pinpoint * account in the current AWS Region.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { PinpointEmailClient, GetAccountCommand } from "@aws-sdk/client-pinpoint-email"; // ES Modules import + * // const { PinpointEmailClient, GetAccountCommand } = require("@aws-sdk/client-pinpoint-email"); // CommonJS import + * const client = new PinpointEmailClient(config); + * const command = new GetAccountCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetAccountCommandInput} for command's `input` shape. + * @see {@link GetAccountCommandOutput} for command's `response` shape. + * @see {@link PinpointEmailClientResolvedConfig | config} for command's `input` shape. + * */ export class GetAccountCommand extends $Command< GetAccountCommandInput, diff --git a/clients/client-pinpoint-email/commands/GetBlacklistReportsCommand.ts b/clients/client-pinpoint-email/commands/GetBlacklistReportsCommand.ts index c1a3cdca051e..b88dab6beb8d 100644 --- a/clients/client-pinpoint-email/commands/GetBlacklistReportsCommand.ts +++ b/clients/client-pinpoint-email/commands/GetBlacklistReportsCommand.ts @@ -22,6 +22,20 @@ export interface GetBlacklistReportsCommandOutput extends GetBlacklistReportsRes /** *

Retrieve a list of the blacklists that your dedicated IP addresses appear on.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { PinpointEmailClient, GetBlacklistReportsCommand } from "@aws-sdk/client-pinpoint-email"; // ES Modules import + * // const { PinpointEmailClient, GetBlacklistReportsCommand } = require("@aws-sdk/client-pinpoint-email"); // CommonJS import + * const client = new PinpointEmailClient(config); + * const command = new GetBlacklistReportsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetBlacklistReportsCommandInput} for command's `input` shape. + * @see {@link GetBlacklistReportsCommandOutput} for command's `response` shape. + * @see {@link PinpointEmailClientResolvedConfig | config} for command's `input` shape. + * */ export class GetBlacklistReportsCommand extends $Command< GetBlacklistReportsCommandInput, diff --git a/clients/client-pinpoint-email/commands/GetConfigurationSetCommand.ts b/clients/client-pinpoint-email/commands/GetConfigurationSetCommand.ts index 1b3edca9e6b5..ed12e9ad0bbe 100644 --- a/clients/client-pinpoint-email/commands/GetConfigurationSetCommand.ts +++ b/clients/client-pinpoint-email/commands/GetConfigurationSetCommand.ts @@ -29,6 +29,20 @@ export interface GetConfigurationSetCommandOutput extends GetConfigurationSetRes * 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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { PinpointEmailClient, GetConfigurationSetCommand } from "@aws-sdk/client-pinpoint-email"; // ES Modules import + * // const { PinpointEmailClient, GetConfigurationSetCommand } = require("@aws-sdk/client-pinpoint-email"); // CommonJS import + * const client = new PinpointEmailClient(config); + * const command = new GetConfigurationSetCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetConfigurationSetCommandInput} for command's `input` shape. + * @see {@link GetConfigurationSetCommandOutput} for command's `response` shape. + * @see {@link PinpointEmailClientResolvedConfig | config} for command's `input` shape. + * */ export class GetConfigurationSetCommand extends $Command< GetConfigurationSetCommandInput, diff --git a/clients/client-pinpoint-email/commands/GetConfigurationSetEventDestinationsCommand.ts b/clients/client-pinpoint-email/commands/GetConfigurationSetEventDestinationsCommand.ts index afb8aa7a79b0..671452d6ff8f 100644 --- a/clients/client-pinpoint-email/commands/GetConfigurationSetEventDestinationsCommand.ts +++ b/clients/client-pinpoint-email/commands/GetConfigurationSetEventDestinationsCommand.ts @@ -33,6 +33,20 @@ export interface GetConfigurationSetEventDestinationsCommandOutput * 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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { PinpointEmailClient, GetConfigurationSetEventDestinationsCommand } from "@aws-sdk/client-pinpoint-email"; // ES Modules import + * // const { PinpointEmailClient, GetConfigurationSetEventDestinationsCommand } = require("@aws-sdk/client-pinpoint-email"); // CommonJS import + * const client = new PinpointEmailClient(config); + * const command = new GetConfigurationSetEventDestinationsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetConfigurationSetEventDestinationsCommandInput} for command's `input` shape. + * @see {@link GetConfigurationSetEventDestinationsCommandOutput} for command's `response` shape. + * @see {@link PinpointEmailClientResolvedConfig | config} for command's `input` shape. + * */ export class GetConfigurationSetEventDestinationsCommand extends $Command< GetConfigurationSetEventDestinationsCommandInput, diff --git a/clients/client-pinpoint-email/commands/GetDedicatedIpCommand.ts b/clients/client-pinpoint-email/commands/GetDedicatedIpCommand.ts index 4105ffb0b086..da1c61a2bbb8 100644 --- a/clients/client-pinpoint-email/commands/GetDedicatedIpCommand.ts +++ b/clients/client-pinpoint-email/commands/GetDedicatedIpCommand.ts @@ -24,6 +24,20 @@ export interface GetDedicatedIpCommandOutput extends GetDedicatedIpResponse, __M *

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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { PinpointEmailClient, GetDedicatedIpCommand } from "@aws-sdk/client-pinpoint-email"; // ES Modules import + * // const { PinpointEmailClient, GetDedicatedIpCommand } = require("@aws-sdk/client-pinpoint-email"); // CommonJS import + * const client = new PinpointEmailClient(config); + * const command = new GetDedicatedIpCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetDedicatedIpCommandInput} for command's `input` shape. + * @see {@link GetDedicatedIpCommandOutput} for command's `response` shape. + * @see {@link PinpointEmailClientResolvedConfig | config} for command's `input` shape. + * */ export class GetDedicatedIpCommand extends $Command< GetDedicatedIpCommandInput, diff --git a/clients/client-pinpoint-email/commands/GetDedicatedIpsCommand.ts b/clients/client-pinpoint-email/commands/GetDedicatedIpsCommand.ts index dea4ae92b77d..66d582300135 100644 --- a/clients/client-pinpoint-email/commands/GetDedicatedIpsCommand.ts +++ b/clients/client-pinpoint-email/commands/GetDedicatedIpsCommand.ts @@ -23,6 +23,20 @@ export interface GetDedicatedIpsCommandOutput extends GetDedicatedIpsResponse, _ /** *

List the dedicated IP addresses that are associated with your Amazon Pinpoint * account.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { PinpointEmailClient, GetDedicatedIpsCommand } from "@aws-sdk/client-pinpoint-email"; // ES Modules import + * // const { PinpointEmailClient, GetDedicatedIpsCommand } = require("@aws-sdk/client-pinpoint-email"); // CommonJS import + * const client = new PinpointEmailClient(config); + * const command = new GetDedicatedIpsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetDedicatedIpsCommandInput} for command's `input` shape. + * @see {@link GetDedicatedIpsCommandOutput} for command's `response` shape. + * @see {@link PinpointEmailClientResolvedConfig | config} for command's `input` shape. + * */ export class GetDedicatedIpsCommand extends $Command< GetDedicatedIpsCommandInput, diff --git a/clients/client-pinpoint-email/commands/GetDeliverabilityDashboardOptionsCommand.ts b/clients/client-pinpoint-email/commands/GetDeliverabilityDashboardOptionsCommand.ts index 7d610c6296d4..0233b4bf2af8 100644 --- a/clients/client-pinpoint-email/commands/GetDeliverabilityDashboardOptionsCommand.ts +++ b/clients/client-pinpoint-email/commands/GetDeliverabilityDashboardOptionsCommand.ts @@ -33,6 +33,20 @@ export interface GetDeliverabilityDashboardOptionsCommandOutput *

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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { PinpointEmailClient, GetDeliverabilityDashboardOptionsCommand } from "@aws-sdk/client-pinpoint-email"; // ES Modules import + * // const { PinpointEmailClient, GetDeliverabilityDashboardOptionsCommand } = require("@aws-sdk/client-pinpoint-email"); // CommonJS import + * const client = new PinpointEmailClient(config); + * const command = new GetDeliverabilityDashboardOptionsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetDeliverabilityDashboardOptionsCommandInput} for command's `input` shape. + * @see {@link GetDeliverabilityDashboardOptionsCommandOutput} for command's `response` shape. + * @see {@link PinpointEmailClientResolvedConfig | config} for command's `input` shape. + * */ export class GetDeliverabilityDashboardOptionsCommand extends $Command< GetDeliverabilityDashboardOptionsCommandInput, diff --git a/clients/client-pinpoint-email/commands/GetDeliverabilityTestReportCommand.ts b/clients/client-pinpoint-email/commands/GetDeliverabilityTestReportCommand.ts index 343d14d4be99..6c66eb4908a1 100644 --- a/clients/client-pinpoint-email/commands/GetDeliverabilityTestReportCommand.ts +++ b/clients/client-pinpoint-email/commands/GetDeliverabilityTestReportCommand.ts @@ -24,6 +24,20 @@ export interface GetDeliverabilityTestReportCommandOutput /** *

Retrieve the results of a predictive inbox placement test.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { PinpointEmailClient, GetDeliverabilityTestReportCommand } from "@aws-sdk/client-pinpoint-email"; // ES Modules import + * // const { PinpointEmailClient, GetDeliverabilityTestReportCommand } = require("@aws-sdk/client-pinpoint-email"); // CommonJS import + * const client = new PinpointEmailClient(config); + * const command = new GetDeliverabilityTestReportCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetDeliverabilityTestReportCommandInput} for command's `input` shape. + * @see {@link GetDeliverabilityTestReportCommandOutput} for command's `response` shape. + * @see {@link PinpointEmailClientResolvedConfig | config} for command's `input` shape. + * */ export class GetDeliverabilityTestReportCommand extends $Command< GetDeliverabilityTestReportCommandInput, diff --git a/clients/client-pinpoint-email/commands/GetDomainDeliverabilityCampaignCommand.ts b/clients/client-pinpoint-email/commands/GetDomainDeliverabilityCampaignCommand.ts index ed75f23c4622..3f2d49d024e8 100644 --- a/clients/client-pinpoint-email/commands/GetDomainDeliverabilityCampaignCommand.ts +++ b/clients/client-pinpoint-email/commands/GetDomainDeliverabilityCampaignCommand.ts @@ -27,6 +27,20 @@ export interface GetDomainDeliverabilityCampaignCommandOutput * for a campaign only if the campaign sent email by using a domain that the * Deliverability dashboard is enabled for (PutDeliverabilityDashboardOption * operation).

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { PinpointEmailClient, GetDomainDeliverabilityCampaignCommand } from "@aws-sdk/client-pinpoint-email"; // ES Modules import + * // const { PinpointEmailClient, GetDomainDeliverabilityCampaignCommand } = require("@aws-sdk/client-pinpoint-email"); // CommonJS import + * const client = new PinpointEmailClient(config); + * const command = new GetDomainDeliverabilityCampaignCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetDomainDeliverabilityCampaignCommandInput} for command's `input` shape. + * @see {@link GetDomainDeliverabilityCampaignCommandOutput} for command's `response` shape. + * @see {@link PinpointEmailClientResolvedConfig | config} for command's `input` shape. + * */ export class GetDomainDeliverabilityCampaignCommand extends $Command< GetDomainDeliverabilityCampaignCommandInput, diff --git a/clients/client-pinpoint-email/commands/GetDomainStatisticsReportCommand.ts b/clients/client-pinpoint-email/commands/GetDomainStatisticsReportCommand.ts index 2869e29693a2..60b7e4039189 100644 --- a/clients/client-pinpoint-email/commands/GetDomainStatisticsReportCommand.ts +++ b/clients/client-pinpoint-email/commands/GetDomainStatisticsReportCommand.ts @@ -23,6 +23,20 @@ export interface GetDomainStatisticsReportCommandOutput extends GetDomainStatist /** *

Retrieve inbox placement and engagement rates for the domains that you use to send * email.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { PinpointEmailClient, GetDomainStatisticsReportCommand } from "@aws-sdk/client-pinpoint-email"; // ES Modules import + * // const { PinpointEmailClient, GetDomainStatisticsReportCommand } = require("@aws-sdk/client-pinpoint-email"); // CommonJS import + * const client = new PinpointEmailClient(config); + * const command = new GetDomainStatisticsReportCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetDomainStatisticsReportCommandInput} for command's `input` shape. + * @see {@link GetDomainStatisticsReportCommandOutput} for command's `response` shape. + * @see {@link PinpointEmailClientResolvedConfig | config} for command's `input` shape. + * */ export class GetDomainStatisticsReportCommand extends $Command< GetDomainStatisticsReportCommandInput, diff --git a/clients/client-pinpoint-email/commands/GetEmailIdentityCommand.ts b/clients/client-pinpoint-email/commands/GetEmailIdentityCommand.ts index b0a1b1f7ea6f..fa4530867219 100644 --- a/clients/client-pinpoint-email/commands/GetEmailIdentityCommand.ts +++ b/clients/client-pinpoint-email/commands/GetEmailIdentityCommand.ts @@ -24,6 +24,20 @@ export interface GetEmailIdentityCommandOutput extends GetEmailIdentityResponse, *

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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { PinpointEmailClient, GetEmailIdentityCommand } from "@aws-sdk/client-pinpoint-email"; // ES Modules import + * // const { PinpointEmailClient, GetEmailIdentityCommand } = require("@aws-sdk/client-pinpoint-email"); // CommonJS import + * const client = new PinpointEmailClient(config); + * const command = new GetEmailIdentityCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetEmailIdentityCommandInput} for command's `input` shape. + * @see {@link GetEmailIdentityCommandOutput} for command's `response` shape. + * @see {@link PinpointEmailClientResolvedConfig | config} for command's `input` shape. + * */ export class GetEmailIdentityCommand extends $Command< GetEmailIdentityCommandInput, diff --git a/clients/client-pinpoint-email/commands/ListConfigurationSetsCommand.ts b/clients/client-pinpoint-email/commands/ListConfigurationSetsCommand.ts index b2a67014c408..70a610832b9f 100644 --- a/clients/client-pinpoint-email/commands/ListConfigurationSetsCommand.ts +++ b/clients/client-pinpoint-email/commands/ListConfigurationSetsCommand.ts @@ -28,6 +28,20 @@ export interface ListConfigurationSetsCommandOutput extends ListConfigurationSet * 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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { PinpointEmailClient, ListConfigurationSetsCommand } from "@aws-sdk/client-pinpoint-email"; // ES Modules import + * // const { PinpointEmailClient, ListConfigurationSetsCommand } = require("@aws-sdk/client-pinpoint-email"); // CommonJS import + * const client = new PinpointEmailClient(config); + * const command = new ListConfigurationSetsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListConfigurationSetsCommandInput} for command's `input` shape. + * @see {@link ListConfigurationSetsCommandOutput} for command's `response` shape. + * @see {@link PinpointEmailClientResolvedConfig | config} for command's `input` shape. + * */ export class ListConfigurationSetsCommand extends $Command< ListConfigurationSetsCommandInput, diff --git a/clients/client-pinpoint-email/commands/ListDedicatedIpPoolsCommand.ts b/clients/client-pinpoint-email/commands/ListDedicatedIpPoolsCommand.ts index 7120a97a5f59..5366c0caecc9 100644 --- a/clients/client-pinpoint-email/commands/ListDedicatedIpPoolsCommand.ts +++ b/clients/client-pinpoint-email/commands/ListDedicatedIpPoolsCommand.ts @@ -23,6 +23,20 @@ export interface ListDedicatedIpPoolsCommandOutput extends ListDedicatedIpPoolsR /** *

List all of the dedicated IP pools that exist in your Amazon Pinpoint account in the current * AWS Region.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { PinpointEmailClient, ListDedicatedIpPoolsCommand } from "@aws-sdk/client-pinpoint-email"; // ES Modules import + * // const { PinpointEmailClient, ListDedicatedIpPoolsCommand } = require("@aws-sdk/client-pinpoint-email"); // CommonJS import + * const client = new PinpointEmailClient(config); + * const command = new ListDedicatedIpPoolsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListDedicatedIpPoolsCommandInput} for command's `input` shape. + * @see {@link ListDedicatedIpPoolsCommandOutput} for command's `response` shape. + * @see {@link PinpointEmailClientResolvedConfig | config} for command's `input` shape. + * */ export class ListDedicatedIpPoolsCommand extends $Command< ListDedicatedIpPoolsCommandInput, diff --git a/clients/client-pinpoint-email/commands/ListDeliverabilityTestReportsCommand.ts b/clients/client-pinpoint-email/commands/ListDeliverabilityTestReportsCommand.ts index f6c1659273fb..a238e5eee16a 100644 --- a/clients/client-pinpoint-email/commands/ListDeliverabilityTestReportsCommand.ts +++ b/clients/client-pinpoint-email/commands/ListDeliverabilityTestReportsCommand.ts @@ -26,6 +26,20 @@ export interface ListDeliverabilityTestReportsCommandOutput *

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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { PinpointEmailClient, ListDeliverabilityTestReportsCommand } from "@aws-sdk/client-pinpoint-email"; // ES Modules import + * // const { PinpointEmailClient, ListDeliverabilityTestReportsCommand } = require("@aws-sdk/client-pinpoint-email"); // CommonJS import + * const client = new PinpointEmailClient(config); + * const command = new ListDeliverabilityTestReportsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListDeliverabilityTestReportsCommandInput} for command's `input` shape. + * @see {@link ListDeliverabilityTestReportsCommandOutput} for command's `response` shape. + * @see {@link PinpointEmailClientResolvedConfig | config} for command's `input` shape. + * */ export class ListDeliverabilityTestReportsCommand extends $Command< ListDeliverabilityTestReportsCommandInput, diff --git a/clients/client-pinpoint-email/commands/ListDomainDeliverabilityCampaignsCommand.ts b/clients/client-pinpoint-email/commands/ListDomainDeliverabilityCampaignsCommand.ts index f82426afb7a1..f62d5d791599 100644 --- a/clients/client-pinpoint-email/commands/ListDomainDeliverabilityCampaignsCommand.ts +++ b/clients/client-pinpoint-email/commands/ListDomainDeliverabilityCampaignsCommand.ts @@ -30,6 +30,20 @@ export interface ListDomainDeliverabilityCampaignsCommandOutput * 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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { PinpointEmailClient, ListDomainDeliverabilityCampaignsCommand } from "@aws-sdk/client-pinpoint-email"; // ES Modules import + * // const { PinpointEmailClient, ListDomainDeliverabilityCampaignsCommand } = require("@aws-sdk/client-pinpoint-email"); // CommonJS import + * const client = new PinpointEmailClient(config); + * const command = new ListDomainDeliverabilityCampaignsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListDomainDeliverabilityCampaignsCommandInput} for command's `input` shape. + * @see {@link ListDomainDeliverabilityCampaignsCommandOutput} for command's `response` shape. + * @see {@link PinpointEmailClientResolvedConfig | config} for command's `input` shape. + * */ export class ListDomainDeliverabilityCampaignsCommand extends $Command< ListDomainDeliverabilityCampaignsCommandInput, diff --git a/clients/client-pinpoint-email/commands/ListEmailIdentitiesCommand.ts b/clients/client-pinpoint-email/commands/ListEmailIdentitiesCommand.ts index 64f88403cc17..db23468a82cb 100644 --- a/clients/client-pinpoint-email/commands/ListEmailIdentitiesCommand.ts +++ b/clients/client-pinpoint-email/commands/ListEmailIdentitiesCommand.ts @@ -24,6 +24,20 @@ export interface ListEmailIdentitiesCommandOutput extends ListEmailIdentitiesRes *

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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { PinpointEmailClient, ListEmailIdentitiesCommand } from "@aws-sdk/client-pinpoint-email"; // ES Modules import + * // const { PinpointEmailClient, ListEmailIdentitiesCommand } = require("@aws-sdk/client-pinpoint-email"); // CommonJS import + * const client = new PinpointEmailClient(config); + * const command = new ListEmailIdentitiesCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListEmailIdentitiesCommandInput} for command's `input` shape. + * @see {@link ListEmailIdentitiesCommandOutput} for command's `response` shape. + * @see {@link PinpointEmailClientResolvedConfig | config} for command's `input` shape. + * */ export class ListEmailIdentitiesCommand extends $Command< ListEmailIdentitiesCommandInput, diff --git a/clients/client-pinpoint-email/commands/ListTagsForResourceCommand.ts b/clients/client-pinpoint-email/commands/ListTagsForResourceCommand.ts index 76b857ac83db..5a792e071498 100644 --- a/clients/client-pinpoint-email/commands/ListTagsForResourceCommand.ts +++ b/clients/client-pinpoint-email/commands/ListTagsForResourceCommand.ts @@ -27,6 +27,20 @@ export interface ListTagsForResourceCommandOutput extends ListTagsForResourceRes * 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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { PinpointEmailClient, ListTagsForResourceCommand } from "@aws-sdk/client-pinpoint-email"; // ES Modules import + * // const { PinpointEmailClient, ListTagsForResourceCommand } = require("@aws-sdk/client-pinpoint-email"); // CommonJS import + * const client = new PinpointEmailClient(config); + * const command = new ListTagsForResourceCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListTagsForResourceCommandInput} for command's `input` shape. + * @see {@link ListTagsForResourceCommandOutput} for command's `response` shape. + * @see {@link PinpointEmailClientResolvedConfig | config} for command's `input` shape. + * */ export class ListTagsForResourceCommand extends $Command< ListTagsForResourceCommandInput, diff --git a/clients/client-pinpoint-email/commands/PutAccountDedicatedIpWarmupAttributesCommand.ts b/clients/client-pinpoint-email/commands/PutAccountDedicatedIpWarmupAttributesCommand.ts index 9e814f426d4c..369da1eb94a6 100644 --- a/clients/client-pinpoint-email/commands/PutAccountDedicatedIpWarmupAttributesCommand.ts +++ b/clients/client-pinpoint-email/commands/PutAccountDedicatedIpWarmupAttributesCommand.ts @@ -28,6 +28,20 @@ export interface PutAccountDedicatedIpWarmupAttributesCommandOutput /** *

Enable or disable the automatic warm-up feature for dedicated IP addresses.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { PinpointEmailClient, PutAccountDedicatedIpWarmupAttributesCommand } from "@aws-sdk/client-pinpoint-email"; // ES Modules import + * // const { PinpointEmailClient, PutAccountDedicatedIpWarmupAttributesCommand } = require("@aws-sdk/client-pinpoint-email"); // CommonJS import + * const client = new PinpointEmailClient(config); + * const command = new PutAccountDedicatedIpWarmupAttributesCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link PutAccountDedicatedIpWarmupAttributesCommandInput} for command's `input` shape. + * @see {@link PutAccountDedicatedIpWarmupAttributesCommandOutput} for command's `response` shape. + * @see {@link PinpointEmailClientResolvedConfig | config} for command's `input` shape. + * */ export class PutAccountDedicatedIpWarmupAttributesCommand extends $Command< PutAccountDedicatedIpWarmupAttributesCommandInput, diff --git a/clients/client-pinpoint-email/commands/PutAccountSendingAttributesCommand.ts b/clients/client-pinpoint-email/commands/PutAccountSendingAttributesCommand.ts index 876f52f985f9..5361e007f0cf 100644 --- a/clients/client-pinpoint-email/commands/PutAccountSendingAttributesCommand.ts +++ b/clients/client-pinpoint-email/commands/PutAccountSendingAttributesCommand.ts @@ -24,6 +24,20 @@ export interface PutAccountSendingAttributesCommandOutput /** *

Enable or disable the ability of your account to send email.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { PinpointEmailClient, PutAccountSendingAttributesCommand } from "@aws-sdk/client-pinpoint-email"; // ES Modules import + * // const { PinpointEmailClient, PutAccountSendingAttributesCommand } = require("@aws-sdk/client-pinpoint-email"); // CommonJS import + * const client = new PinpointEmailClient(config); + * const command = new PutAccountSendingAttributesCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link PutAccountSendingAttributesCommandInput} for command's `input` shape. + * @see {@link PutAccountSendingAttributesCommandOutput} for command's `response` shape. + * @see {@link PinpointEmailClientResolvedConfig | config} for command's `input` shape. + * */ export class PutAccountSendingAttributesCommand extends $Command< PutAccountSendingAttributesCommandInput, diff --git a/clients/client-pinpoint-email/commands/PutConfigurationSetDeliveryOptionsCommand.ts b/clients/client-pinpoint-email/commands/PutConfigurationSetDeliveryOptionsCommand.ts index a4e31b521175..395954603ba1 100644 --- a/clients/client-pinpoint-email/commands/PutConfigurationSetDeliveryOptionsCommand.ts +++ b/clients/client-pinpoint-email/commands/PutConfigurationSetDeliveryOptionsCommand.ts @@ -28,6 +28,20 @@ export interface PutConfigurationSetDeliveryOptionsCommandOutput /** *

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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { PinpointEmailClient, PutConfigurationSetDeliveryOptionsCommand } from "@aws-sdk/client-pinpoint-email"; // ES Modules import + * // const { PinpointEmailClient, PutConfigurationSetDeliveryOptionsCommand } = require("@aws-sdk/client-pinpoint-email"); // CommonJS import + * const client = new PinpointEmailClient(config); + * const command = new PutConfigurationSetDeliveryOptionsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link PutConfigurationSetDeliveryOptionsCommandInput} for command's `input` shape. + * @see {@link PutConfigurationSetDeliveryOptionsCommandOutput} for command's `response` shape. + * @see {@link PinpointEmailClientResolvedConfig | config} for command's `input` shape. + * */ export class PutConfigurationSetDeliveryOptionsCommand extends $Command< PutConfigurationSetDeliveryOptionsCommandInput, diff --git a/clients/client-pinpoint-email/commands/PutConfigurationSetReputationOptionsCommand.ts b/clients/client-pinpoint-email/commands/PutConfigurationSetReputationOptionsCommand.ts index fb0ad13fe6df..ad393c12c018 100644 --- a/clients/client-pinpoint-email/commands/PutConfigurationSetReputationOptionsCommand.ts +++ b/clients/client-pinpoint-email/commands/PutConfigurationSetReputationOptionsCommand.ts @@ -28,6 +28,20 @@ export interface PutConfigurationSetReputationOptionsCommandOutput /** *

Enable or disable collection of reputation metrics for emails that you send using a * particular configuration set in a specific AWS Region.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { PinpointEmailClient, PutConfigurationSetReputationOptionsCommand } from "@aws-sdk/client-pinpoint-email"; // ES Modules import + * // const { PinpointEmailClient, PutConfigurationSetReputationOptionsCommand } = require("@aws-sdk/client-pinpoint-email"); // CommonJS import + * const client = new PinpointEmailClient(config); + * const command = new PutConfigurationSetReputationOptionsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link PutConfigurationSetReputationOptionsCommandInput} for command's `input` shape. + * @see {@link PutConfigurationSetReputationOptionsCommandOutput} for command's `response` shape. + * @see {@link PinpointEmailClientResolvedConfig | config} for command's `input` shape. + * */ export class PutConfigurationSetReputationOptionsCommand extends $Command< PutConfigurationSetReputationOptionsCommandInput, diff --git a/clients/client-pinpoint-email/commands/PutConfigurationSetSendingOptionsCommand.ts b/clients/client-pinpoint-email/commands/PutConfigurationSetSendingOptionsCommand.ts index 91ffccd27deb..b66d462461d5 100644 --- a/clients/client-pinpoint-email/commands/PutConfigurationSetSendingOptionsCommand.ts +++ b/clients/client-pinpoint-email/commands/PutConfigurationSetSendingOptionsCommand.ts @@ -28,6 +28,20 @@ export interface PutConfigurationSetSendingOptionsCommandOutput /** *

Enable or disable email sending for messages that use a particular configuration set * in a specific AWS Region.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { PinpointEmailClient, PutConfigurationSetSendingOptionsCommand } from "@aws-sdk/client-pinpoint-email"; // ES Modules import + * // const { PinpointEmailClient, PutConfigurationSetSendingOptionsCommand } = require("@aws-sdk/client-pinpoint-email"); // CommonJS import + * const client = new PinpointEmailClient(config); + * const command = new PutConfigurationSetSendingOptionsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link PutConfigurationSetSendingOptionsCommandInput} for command's `input` shape. + * @see {@link PutConfigurationSetSendingOptionsCommandOutput} for command's `response` shape. + * @see {@link PinpointEmailClientResolvedConfig | config} for command's `input` shape. + * */ export class PutConfigurationSetSendingOptionsCommand extends $Command< PutConfigurationSetSendingOptionsCommandInput, diff --git a/clients/client-pinpoint-email/commands/PutConfigurationSetTrackingOptionsCommand.ts b/clients/client-pinpoint-email/commands/PutConfigurationSetTrackingOptionsCommand.ts index 9ce5f6dfe123..0f651a428621 100644 --- a/clients/client-pinpoint-email/commands/PutConfigurationSetTrackingOptionsCommand.ts +++ b/clients/client-pinpoint-email/commands/PutConfigurationSetTrackingOptionsCommand.ts @@ -28,6 +28,20 @@ export interface PutConfigurationSetTrackingOptionsCommandOutput /** *

Specify a custom domain to use for open and click tracking elements in email that you * send using Amazon Pinpoint.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { PinpointEmailClient, PutConfigurationSetTrackingOptionsCommand } from "@aws-sdk/client-pinpoint-email"; // ES Modules import + * // const { PinpointEmailClient, PutConfigurationSetTrackingOptionsCommand } = require("@aws-sdk/client-pinpoint-email"); // CommonJS import + * const client = new PinpointEmailClient(config); + * const command = new PutConfigurationSetTrackingOptionsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link PutConfigurationSetTrackingOptionsCommandInput} for command's `input` shape. + * @see {@link PutConfigurationSetTrackingOptionsCommandOutput} for command's `response` shape. + * @see {@link PinpointEmailClientResolvedConfig | config} for command's `input` shape. + * */ export class PutConfigurationSetTrackingOptionsCommand extends $Command< PutConfigurationSetTrackingOptionsCommandInput, diff --git a/clients/client-pinpoint-email/commands/PutDedicatedIpInPoolCommand.ts b/clients/client-pinpoint-email/commands/PutDedicatedIpInPoolCommand.ts index 6379419696d5..7e6ad0cfe065 100644 --- a/clients/client-pinpoint-email/commands/PutDedicatedIpInPoolCommand.ts +++ b/clients/client-pinpoint-email/commands/PutDedicatedIpInPoolCommand.ts @@ -31,6 +31,20 @@ export interface PutDedicatedIpInPoolCommandOutput extends PutDedicatedIpInPoolR * using the CreateDedicatedIpPool operation.

* * + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { PinpointEmailClient, PutDedicatedIpInPoolCommand } from "@aws-sdk/client-pinpoint-email"; // ES Modules import + * // const { PinpointEmailClient, PutDedicatedIpInPoolCommand } = require("@aws-sdk/client-pinpoint-email"); // CommonJS import + * const client = new PinpointEmailClient(config); + * const command = new PutDedicatedIpInPoolCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link PutDedicatedIpInPoolCommandInput} for command's `input` shape. + * @see {@link PutDedicatedIpInPoolCommandOutput} for command's `response` shape. + * @see {@link PinpointEmailClientResolvedConfig | config} for command's `input` shape. + * */ export class PutDedicatedIpInPoolCommand extends $Command< PutDedicatedIpInPoolCommandInput, diff --git a/clients/client-pinpoint-email/commands/PutDedicatedIpWarmupAttributesCommand.ts b/clients/client-pinpoint-email/commands/PutDedicatedIpWarmupAttributesCommand.ts index 61941dfb4c96..af671933909a 100644 --- a/clients/client-pinpoint-email/commands/PutDedicatedIpWarmupAttributesCommand.ts +++ b/clients/client-pinpoint-email/commands/PutDedicatedIpWarmupAttributesCommand.ts @@ -24,6 +24,20 @@ export interface PutDedicatedIpWarmupAttributesCommandOutput /** *

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { PinpointEmailClient, PutDedicatedIpWarmupAttributesCommand } from "@aws-sdk/client-pinpoint-email"; // ES Modules import + * // const { PinpointEmailClient, PutDedicatedIpWarmupAttributesCommand } = require("@aws-sdk/client-pinpoint-email"); // CommonJS import + * const client = new PinpointEmailClient(config); + * const command = new PutDedicatedIpWarmupAttributesCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link PutDedicatedIpWarmupAttributesCommandInput} for command's `input` shape. + * @see {@link PutDedicatedIpWarmupAttributesCommandOutput} for command's `response` shape. + * @see {@link PinpointEmailClientResolvedConfig | config} for command's `input` shape. + * */ export class PutDedicatedIpWarmupAttributesCommand extends $Command< PutDedicatedIpWarmupAttributesCommandInput, diff --git a/clients/client-pinpoint-email/commands/PutDeliverabilityDashboardOptionCommand.ts b/clients/client-pinpoint-email/commands/PutDeliverabilityDashboardOptionCommand.ts index fca0f3b90f94..0aa8c5cbc637 100644 --- a/clients/client-pinpoint-email/commands/PutDeliverabilityDashboardOptionCommand.ts +++ b/clients/client-pinpoint-email/commands/PutDeliverabilityDashboardOptionCommand.ts @@ -30,6 +30,20 @@ export interface PutDeliverabilityDashboardOptionCommandOutput *

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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { PinpointEmailClient, PutDeliverabilityDashboardOptionCommand } from "@aws-sdk/client-pinpoint-email"; // ES Modules import + * // const { PinpointEmailClient, PutDeliverabilityDashboardOptionCommand } = require("@aws-sdk/client-pinpoint-email"); // CommonJS import + * const client = new PinpointEmailClient(config); + * const command = new PutDeliverabilityDashboardOptionCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link PutDeliverabilityDashboardOptionCommandInput} for command's `input` shape. + * @see {@link PutDeliverabilityDashboardOptionCommandOutput} for command's `response` shape. + * @see {@link PinpointEmailClientResolvedConfig | config} for command's `input` shape. + * */ export class PutDeliverabilityDashboardOptionCommand extends $Command< PutDeliverabilityDashboardOptionCommandInput, diff --git a/clients/client-pinpoint-email/commands/PutEmailIdentityDkimAttributesCommand.ts b/clients/client-pinpoint-email/commands/PutEmailIdentityDkimAttributesCommand.ts index c2ed551c1c23..10c962c6c3a2 100644 --- a/clients/client-pinpoint-email/commands/PutEmailIdentityDkimAttributesCommand.ts +++ b/clients/client-pinpoint-email/commands/PutEmailIdentityDkimAttributesCommand.ts @@ -24,6 +24,20 @@ export interface PutEmailIdentityDkimAttributesCommandOutput /** *

Used to enable or disable DKIM authentication for an email identity.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { PinpointEmailClient, PutEmailIdentityDkimAttributesCommand } from "@aws-sdk/client-pinpoint-email"; // ES Modules import + * // const { PinpointEmailClient, PutEmailIdentityDkimAttributesCommand } = require("@aws-sdk/client-pinpoint-email"); // CommonJS import + * const client = new PinpointEmailClient(config); + * const command = new PutEmailIdentityDkimAttributesCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link PutEmailIdentityDkimAttributesCommandInput} for command's `input` shape. + * @see {@link PutEmailIdentityDkimAttributesCommandOutput} for command's `response` shape. + * @see {@link PinpointEmailClientResolvedConfig | config} for command's `input` shape. + * */ export class PutEmailIdentityDkimAttributesCommand extends $Command< PutEmailIdentityDkimAttributesCommandInput, diff --git a/clients/client-pinpoint-email/commands/PutEmailIdentityFeedbackAttributesCommand.ts b/clients/client-pinpoint-email/commands/PutEmailIdentityFeedbackAttributesCommand.ts index 27de9f52276a..bb67858f6767 100644 --- a/clients/client-pinpoint-email/commands/PutEmailIdentityFeedbackAttributesCommand.ts +++ b/clients/client-pinpoint-email/commands/PutEmailIdentityFeedbackAttributesCommand.ts @@ -37,6 +37,20 @@ export interface PutEmailIdentityFeedbackAttributesCommandOutput * 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).

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { PinpointEmailClient, PutEmailIdentityFeedbackAttributesCommand } from "@aws-sdk/client-pinpoint-email"; // ES Modules import + * // const { PinpointEmailClient, PutEmailIdentityFeedbackAttributesCommand } = require("@aws-sdk/client-pinpoint-email"); // CommonJS import + * const client = new PinpointEmailClient(config); + * const command = new PutEmailIdentityFeedbackAttributesCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link PutEmailIdentityFeedbackAttributesCommandInput} for command's `input` shape. + * @see {@link PutEmailIdentityFeedbackAttributesCommandOutput} for command's `response` shape. + * @see {@link PinpointEmailClientResolvedConfig | config} for command's `input` shape. + * */ export class PutEmailIdentityFeedbackAttributesCommand extends $Command< PutEmailIdentityFeedbackAttributesCommandInput, diff --git a/clients/client-pinpoint-email/commands/PutEmailIdentityMailFromAttributesCommand.ts b/clients/client-pinpoint-email/commands/PutEmailIdentityMailFromAttributesCommand.ts index 6c37c4f17d85..868e207c7ee5 100644 --- a/clients/client-pinpoint-email/commands/PutEmailIdentityMailFromAttributesCommand.ts +++ b/clients/client-pinpoint-email/commands/PutEmailIdentityMailFromAttributesCommand.ts @@ -28,6 +28,20 @@ export interface PutEmailIdentityMailFromAttributesCommandOutput /** *

Used to enable or disable the custom Mail-From domain configuration for an email * identity.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { PinpointEmailClient, PutEmailIdentityMailFromAttributesCommand } from "@aws-sdk/client-pinpoint-email"; // ES Modules import + * // const { PinpointEmailClient, PutEmailIdentityMailFromAttributesCommand } = require("@aws-sdk/client-pinpoint-email"); // CommonJS import + * const client = new PinpointEmailClient(config); + * const command = new PutEmailIdentityMailFromAttributesCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link PutEmailIdentityMailFromAttributesCommandInput} for command's `input` shape. + * @see {@link PutEmailIdentityMailFromAttributesCommandOutput} for command's `response` shape. + * @see {@link PinpointEmailClientResolvedConfig | config} for command's `input` shape. + * */ export class PutEmailIdentityMailFromAttributesCommand extends $Command< PutEmailIdentityMailFromAttributesCommandInput, diff --git a/clients/client-pinpoint-email/commands/SendEmailCommand.ts b/clients/client-pinpoint-email/commands/SendEmailCommand.ts index 2714f480dc27..ef8a98d9f9c9 100644 --- a/clients/client-pinpoint-email/commands/SendEmailCommand.ts +++ b/clients/client-pinpoint-email/commands/SendEmailCommand.ts @@ -39,6 +39,20 @@ export interface SendEmailCommandOutput extends SendEmailResponse, __MetadataBea * valid MIME message.

* * + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { PinpointEmailClient, SendEmailCommand } from "@aws-sdk/client-pinpoint-email"; // ES Modules import + * // const { PinpointEmailClient, SendEmailCommand } = require("@aws-sdk/client-pinpoint-email"); // CommonJS import + * const client = new PinpointEmailClient(config); + * const command = new SendEmailCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link SendEmailCommandInput} for command's `input` shape. + * @see {@link SendEmailCommandOutput} for command's `response` shape. + * @see {@link PinpointEmailClientResolvedConfig | config} for command's `input` shape. + * */ export class SendEmailCommand extends $Command< SendEmailCommandInput, diff --git a/clients/client-pinpoint-email/commands/TagResourceCommand.ts b/clients/client-pinpoint-email/commands/TagResourceCommand.ts index cdf6fab78338..4c763055571a 100644 --- a/clients/client-pinpoint-email/commands/TagResourceCommand.ts +++ b/clients/client-pinpoint-email/commands/TagResourceCommand.ts @@ -30,6 +30,20 @@ export interface TagResourceCommandOutput extends TagResourceResponse, __Metadat * 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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { PinpointEmailClient, TagResourceCommand } from "@aws-sdk/client-pinpoint-email"; // ES Modules import + * // const { PinpointEmailClient, TagResourceCommand } = require("@aws-sdk/client-pinpoint-email"); // CommonJS import + * const client = new PinpointEmailClient(config); + * const command = new TagResourceCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link TagResourceCommandInput} for command's `input` shape. + * @see {@link TagResourceCommandOutput} for command's `response` shape. + * @see {@link PinpointEmailClientResolvedConfig | config} for command's `input` shape. + * */ export class TagResourceCommand extends $Command< TagResourceCommandInput, diff --git a/clients/client-pinpoint-email/commands/UntagResourceCommand.ts b/clients/client-pinpoint-email/commands/UntagResourceCommand.ts index c372118c0557..84a3c80af44c 100644 --- a/clients/client-pinpoint-email/commands/UntagResourceCommand.ts +++ b/clients/client-pinpoint-email/commands/UntagResourceCommand.ts @@ -22,6 +22,20 @@ export interface UntagResourceCommandOutput extends UntagResourceResponse, __Met /** *

Remove one or more tags (keys and values) from a specified resource.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { PinpointEmailClient, UntagResourceCommand } from "@aws-sdk/client-pinpoint-email"; // ES Modules import + * // const { PinpointEmailClient, UntagResourceCommand } = require("@aws-sdk/client-pinpoint-email"); // CommonJS import + * const client = new PinpointEmailClient(config); + * const command = new UntagResourceCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link UntagResourceCommandInput} for command's `input` shape. + * @see {@link UntagResourceCommandOutput} for command's `response` shape. + * @see {@link PinpointEmailClientResolvedConfig | config} for command's `input` shape. + * */ export class UntagResourceCommand extends $Command< UntagResourceCommandInput, diff --git a/clients/client-pinpoint-email/commands/UpdateConfigurationSetEventDestinationCommand.ts b/clients/client-pinpoint-email/commands/UpdateConfigurationSetEventDestinationCommand.ts index 819031e929de..ccd0864df6c5 100644 --- a/clients/client-pinpoint-email/commands/UpdateConfigurationSetEventDestinationCommand.ts +++ b/clients/client-pinpoint-email/commands/UpdateConfigurationSetEventDestinationCommand.ts @@ -33,6 +33,20 @@ export interface UpdateConfigurationSetEventDestinationCommandOutput * 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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { PinpointEmailClient, UpdateConfigurationSetEventDestinationCommand } from "@aws-sdk/client-pinpoint-email"; // ES Modules import + * // const { PinpointEmailClient, UpdateConfigurationSetEventDestinationCommand } = require("@aws-sdk/client-pinpoint-email"); // CommonJS import + * const client = new PinpointEmailClient(config); + * const command = new UpdateConfigurationSetEventDestinationCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link UpdateConfigurationSetEventDestinationCommandInput} for command's `input` shape. + * @see {@link UpdateConfigurationSetEventDestinationCommandOutput} for command's `response` shape. + * @see {@link PinpointEmailClientResolvedConfig | config} for command's `input` shape. + * */ export class UpdateConfigurationSetEventDestinationCommand extends $Command< UpdateConfigurationSetEventDestinationCommandInput, diff --git a/clients/client-pinpoint-email/models/models_0.ts b/clients/client-pinpoint-email/models/models_0.ts index e2c823bdf3c5..4a0be7983f66 100644 --- a/clients/client-pinpoint-email/models/models_0.ts +++ b/clients/client-pinpoint-email/models/models_0.ts @@ -12,6 +12,9 @@ export interface AccountSuspendedException extends __SmithyException, $MetadataB } export namespace AccountSuspendedException { + /** + * @internal + */ export const filterSensitiveLog = (obj: AccountSuspendedException): any => ({ ...obj, }); @@ -27,6 +30,9 @@ export interface AlreadyExistsException extends __SmithyException, $MetadataBear } export namespace AlreadyExistsException { + /** + * @internal + */ export const filterSensitiveLog = (obj: AlreadyExistsException): any => ({ ...obj, }); @@ -42,6 +48,9 @@ export interface BadRequestException extends __SmithyException, $MetadataBearer } export namespace BadRequestException { + /** + * @internal + */ export const filterSensitiveLog = (obj: BadRequestException): any => ({ ...obj, }); @@ -57,6 +66,9 @@ export interface ConcurrentModificationException extends __SmithyException, $Met } export namespace ConcurrentModificationException { + /** + * @internal + */ export const filterSensitiveLog = (obj: ConcurrentModificationException): any => ({ ...obj, }); @@ -87,6 +99,9 @@ export interface DeliveryOptions { } export namespace DeliveryOptions { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeliveryOptions): any => ({ ...obj, }); @@ -113,6 +128,9 @@ export interface ReputationOptions { } export namespace ReputationOptions { + /** + * @internal + */ export const filterSensitiveLog = (obj: ReputationOptions): any => ({ ...obj, }); @@ -131,6 +149,9 @@ export interface SendingOptions { } export namespace SendingOptions { + /** + * @internal + */ export const filterSensitiveLog = (obj: SendingOptions): any => ({ ...obj, }); @@ -188,6 +209,9 @@ export interface Tag { } export namespace Tag { + /** + * @internal + */ export const filterSensitiveLog = (obj: Tag): any => ({ ...obj, }); @@ -210,6 +234,9 @@ export interface TrackingOptions { } export namespace TrackingOptions { + /** + * @internal + */ export const filterSensitiveLog = (obj: TrackingOptions): any => ({ ...obj, }); @@ -256,6 +283,9 @@ export interface CreateConfigurationSetRequest { } export namespace CreateConfigurationSetRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateConfigurationSetRequest): any => ({ ...obj, }); @@ -268,6 +298,9 @@ export namespace CreateConfigurationSetRequest { export interface CreateConfigurationSetResponse {} export namespace CreateConfigurationSetResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateConfigurationSetResponse): any => ({ ...obj, }); @@ -283,6 +316,9 @@ export interface LimitExceededException extends __SmithyException, $MetadataBear } export namespace LimitExceededException { + /** + * @internal + */ export const filterSensitiveLog = (obj: LimitExceededException): any => ({ ...obj, }); @@ -298,6 +334,9 @@ export interface NotFoundException extends __SmithyException, $MetadataBearer { } export namespace NotFoundException { + /** + * @internal + */ export const filterSensitiveLog = (obj: NotFoundException): any => ({ ...obj, }); @@ -313,6 +352,9 @@ export interface TooManyRequestsException extends __SmithyException, $MetadataBe } export namespace TooManyRequestsException { + /** + * @internal + */ export const filterSensitiveLog = (obj: TooManyRequestsException): any => ({ ...obj, }); @@ -371,6 +413,9 @@ export interface CloudWatchDimensionConfiguration { } export namespace CloudWatchDimensionConfiguration { + /** + * @internal + */ export const filterSensitiveLog = (obj: CloudWatchDimensionConfiguration): any => ({ ...obj, }); @@ -389,6 +434,9 @@ export interface CloudWatchDestination { } export namespace CloudWatchDestination { + /** + * @internal + */ export const filterSensitiveLog = (obj: CloudWatchDestination): any => ({ ...obj, }); @@ -413,6 +461,9 @@ export interface KinesisFirehoseDestination { } export namespace KinesisFirehoseDestination { + /** + * @internal + */ export const filterSensitiveLog = (obj: KinesisFirehoseDestination): any => ({ ...obj, }); @@ -443,6 +494,9 @@ export interface PinpointDestination { } export namespace PinpointDestination { + /** + * @internal + */ export const filterSensitiveLog = (obj: PinpointDestination): any => ({ ...obj, }); @@ -462,6 +516,9 @@ export interface SnsDestination { } export namespace SnsDestination { + /** + * @internal + */ export const filterSensitiveLog = (obj: SnsDestination): any => ({ ...obj, }); @@ -516,6 +573,9 @@ export interface EventDestinationDefinition { } export namespace EventDestinationDefinition { + /** + * @internal + */ export const filterSensitiveLog = (obj: EventDestinationDefinition): any => ({ ...obj, }); @@ -542,6 +602,9 @@ export interface CreateConfigurationSetEventDestinationRequest { } export namespace CreateConfigurationSetEventDestinationRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateConfigurationSetEventDestinationRequest): any => ({ ...obj, }); @@ -554,6 +617,9 @@ export namespace CreateConfigurationSetEventDestinationRequest { export interface CreateConfigurationSetEventDestinationResponse {} export namespace CreateConfigurationSetEventDestinationResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateConfigurationSetEventDestinationResponse): any => ({ ...obj, }); @@ -576,6 +642,9 @@ export interface CreateDedicatedIpPoolRequest { } export namespace CreateDedicatedIpPoolRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateDedicatedIpPoolRequest): any => ({ ...obj, }); @@ -588,6 +657,9 @@ export namespace CreateDedicatedIpPoolRequest { export interface CreateDedicatedIpPoolResponse {} export namespace CreateDedicatedIpPoolResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateDedicatedIpPoolResponse): any => ({ ...obj, }); @@ -632,6 +704,9 @@ export interface RawMessage { } export namespace RawMessage { + /** + * @internal + */ export const filterSensitiveLog = (obj: RawMessage): any => ({ ...obj, }); @@ -657,6 +732,9 @@ export interface Content { } export namespace Content { + /** + * @internal + */ export const filterSensitiveLog = (obj: Content): any => ({ ...obj, }); @@ -682,6 +760,9 @@ export interface Body { } export namespace Body { + /** + * @internal + */ export const filterSensitiveLog = (obj: Body): any => ({ ...obj, }); @@ -707,6 +788,9 @@ export interface Message { } export namespace Message { + /** + * @internal + */ export const filterSensitiveLog = (obj: Message): any => ({ ...obj, }); @@ -725,6 +809,9 @@ export interface Template { } export namespace Template { + /** + * @internal + */ export const filterSensitiveLog = (obj: Template): any => ({ ...obj, }); @@ -783,6 +870,9 @@ export interface EmailContent { } export namespace EmailContent { + /** + * @internal + */ export const filterSensitiveLog = (obj: EmailContent): any => ({ ...obj, }); @@ -822,6 +912,9 @@ export interface CreateDeliverabilityTestReportRequest { } export namespace CreateDeliverabilityTestReportRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateDeliverabilityTestReportRequest): any => ({ ...obj, }); @@ -851,6 +944,9 @@ export interface CreateDeliverabilityTestReportResponse { } export namespace CreateDeliverabilityTestReportResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateDeliverabilityTestReportResponse): any => ({ ...obj, }); @@ -866,6 +962,9 @@ export interface MailFromDomainNotVerifiedException extends __SmithyException, $ } export namespace MailFromDomainNotVerifiedException { + /** + * @internal + */ export const filterSensitiveLog = (obj: MailFromDomainNotVerifiedException): any => ({ ...obj, }); @@ -881,6 +980,9 @@ export interface MessageRejected extends __SmithyException, $MetadataBearer { } export namespace MessageRejected { + /** + * @internal + */ export const filterSensitiveLog = (obj: MessageRejected): any => ({ ...obj, }); @@ -897,6 +999,9 @@ export interface SendingPausedException extends __SmithyException, $MetadataBear } export namespace SendingPausedException { + /** + * @internal + */ export const filterSensitiveLog = (obj: SendingPausedException): any => ({ ...obj, }); @@ -920,6 +1025,9 @@ export interface CreateEmailIdentityRequest { } export namespace CreateEmailIdentityRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateEmailIdentityRequest): any => ({ ...obj, }); @@ -991,6 +1099,9 @@ export interface DkimAttributes { } export namespace DkimAttributes { + /** + * @internal + */ export const filterSensitiveLog = (obj: DkimAttributes): any => ({ ...obj, }); @@ -1030,6 +1141,9 @@ export interface CreateEmailIdentityResponse { } export namespace CreateEmailIdentityResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateEmailIdentityResponse): any => ({ ...obj, }); @@ -1046,6 +1160,9 @@ export interface DeleteConfigurationSetRequest { } export namespace DeleteConfigurationSetRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteConfigurationSetRequest): any => ({ ...obj, }); @@ -1058,6 +1175,9 @@ export namespace DeleteConfigurationSetRequest { export interface DeleteConfigurationSetResponse {} export namespace DeleteConfigurationSetResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteConfigurationSetResponse): any => ({ ...obj, }); @@ -1080,6 +1200,9 @@ export interface DeleteConfigurationSetEventDestinationRequest { } export namespace DeleteConfigurationSetEventDestinationRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteConfigurationSetEventDestinationRequest): any => ({ ...obj, }); @@ -1092,6 +1215,9 @@ export namespace DeleteConfigurationSetEventDestinationRequest { export interface DeleteConfigurationSetEventDestinationResponse {} export namespace DeleteConfigurationSetEventDestinationResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteConfigurationSetEventDestinationResponse): any => ({ ...obj, }); @@ -1108,6 +1234,9 @@ export interface DeleteDedicatedIpPoolRequest { } export namespace DeleteDedicatedIpPoolRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteDedicatedIpPoolRequest): any => ({ ...obj, }); @@ -1120,6 +1249,9 @@ export namespace DeleteDedicatedIpPoolRequest { export interface DeleteDedicatedIpPoolResponse {} export namespace DeleteDedicatedIpPoolResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteDedicatedIpPoolResponse): any => ({ ...obj, }); @@ -1139,6 +1271,9 @@ export interface DeleteEmailIdentityRequest { } export namespace DeleteEmailIdentityRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteEmailIdentityRequest): any => ({ ...obj, }); @@ -1151,6 +1286,9 @@ export namespace DeleteEmailIdentityRequest { export interface DeleteEmailIdentityResponse {} export namespace DeleteEmailIdentityResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteEmailIdentityResponse): any => ({ ...obj, }); @@ -1163,6 +1301,9 @@ export namespace DeleteEmailIdentityResponse { export interface GetAccountRequest {} export namespace GetAccountRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetAccountRequest): any => ({ ...obj, }); @@ -1195,6 +1336,9 @@ export interface SendQuota { } export namespace SendQuota { + /** + * @internal + */ export const filterSensitiveLog = (obj: SendQuota): any => ({ ...obj, }); @@ -1265,6 +1409,9 @@ export interface GetAccountResponse { } export namespace GetAccountResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetAccountResponse): any => ({ ...obj, }); @@ -1284,6 +1431,9 @@ export interface GetBlacklistReportsRequest { } export namespace GetBlacklistReportsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetBlacklistReportsRequest): any => ({ ...obj, }); @@ -1312,6 +1462,9 @@ export interface BlacklistEntry { } export namespace BlacklistEntry { + /** + * @internal + */ export const filterSensitiveLog = (obj: BlacklistEntry): any => ({ ...obj, }); @@ -1329,6 +1482,9 @@ export interface GetBlacklistReportsResponse { } export namespace GetBlacklistReportsResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetBlacklistReportsResponse): any => ({ ...obj, }); @@ -1346,6 +1502,9 @@ export interface GetConfigurationSetRequest { } export namespace GetConfigurationSetRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetConfigurationSetRequest): any => ({ ...obj, }); @@ -1392,6 +1551,9 @@ export interface GetConfigurationSetResponse { } export namespace GetConfigurationSetResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetConfigurationSetResponse): any => ({ ...obj, }); @@ -1409,6 +1571,9 @@ export interface GetConfigurationSetEventDestinationsRequest { } export namespace GetConfigurationSetEventDestinationsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetConfigurationSetEventDestinationsRequest): any => ({ ...obj, }); @@ -1468,6 +1633,9 @@ export interface EventDestination { } export namespace EventDestination { + /** + * @internal + */ export const filterSensitiveLog = (obj: EventDestination): any => ({ ...obj, }); @@ -1485,6 +1653,9 @@ export interface GetConfigurationSetEventDestinationsResponse { } export namespace GetConfigurationSetEventDestinationsResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetConfigurationSetEventDestinationsResponse): any => ({ ...obj, }); @@ -1502,6 +1673,9 @@ export interface GetDedicatedIpRequest { } export namespace GetDedicatedIpRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetDedicatedIpRequest): any => ({ ...obj, }); @@ -1554,6 +1728,9 @@ export interface DedicatedIp { } export namespace DedicatedIp { + /** + * @internal + */ export const filterSensitiveLog = (obj: DedicatedIp): any => ({ ...obj, }); @@ -1570,6 +1747,9 @@ export interface GetDedicatedIpResponse { } export namespace GetDedicatedIpResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetDedicatedIpResponse): any => ({ ...obj, }); @@ -1600,6 +1780,9 @@ export interface GetDedicatedIpsRequest { } export namespace GetDedicatedIpsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetDedicatedIpsRequest): any => ({ ...obj, }); @@ -1625,6 +1808,9 @@ export interface GetDedicatedIpsResponse { } export namespace GetDedicatedIpsResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetDedicatedIpsResponse): any => ({ ...obj, }); @@ -1642,6 +1828,9 @@ export namespace GetDedicatedIpsResponse { export interface GetDeliverabilityDashboardOptionsRequest {} export namespace GetDeliverabilityDashboardOptionsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetDeliverabilityDashboardOptionsRequest): any => ({ ...obj, }); @@ -1673,6 +1862,9 @@ export interface InboxPlacementTrackingOption { } export namespace InboxPlacementTrackingOption { + /** + * @internal + */ export const filterSensitiveLog = (obj: InboxPlacementTrackingOption): any => ({ ...obj, }); @@ -1705,6 +1897,9 @@ export interface DomainDeliverabilityTrackingOption { } export namespace DomainDeliverabilityTrackingOption { + /** + * @internal + */ export const filterSensitiveLog = (obj: DomainDeliverabilityTrackingOption): any => ({ ...obj, }); @@ -1751,6 +1946,9 @@ export interface GetDeliverabilityDashboardOptionsResponse { } export namespace GetDeliverabilityDashboardOptionsResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetDeliverabilityDashboardOptionsResponse): any => ({ ...obj, }); @@ -1767,6 +1965,9 @@ export interface GetDeliverabilityTestReportRequest { } export namespace GetDeliverabilityTestReportRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetDeliverabilityTestReportRequest): any => ({ ...obj, }); @@ -1811,6 +2012,9 @@ export interface DeliverabilityTestReport { } export namespace DeliverabilityTestReport { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeliverabilityTestReport): any => ({ ...obj, }); @@ -1851,6 +2055,9 @@ export interface PlacementStatistics { } export namespace PlacementStatistics { + /** + * @internal + */ export const filterSensitiveLog = (obj: PlacementStatistics): any => ({ ...obj, }); @@ -1873,6 +2080,9 @@ export interface IspPlacement { } export namespace IspPlacement { + /** + * @internal + */ export const filterSensitiveLog = (obj: IspPlacement): any => ({ ...obj, }); @@ -1914,6 +2124,9 @@ export interface GetDeliverabilityTestReportResponse { } export namespace GetDeliverabilityTestReportResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetDeliverabilityTestReportResponse): any => ({ ...obj, }); @@ -1936,6 +2149,9 @@ export interface GetDomainDeliverabilityCampaignRequest { } export namespace GetDomainDeliverabilityCampaignRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetDomainDeliverabilityCampaignRequest): any => ({ ...obj, }); @@ -2035,6 +2251,9 @@ export interface DomainDeliverabilityCampaign { } export namespace DomainDeliverabilityCampaign { + /** + * @internal + */ export const filterSensitiveLog = (obj: DomainDeliverabilityCampaign): any => ({ ...obj, }); @@ -2054,6 +2273,9 @@ export interface GetDomainDeliverabilityCampaignResponse { } export namespace GetDomainDeliverabilityCampaignResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetDomainDeliverabilityCampaignResponse): any => ({ ...obj, }); @@ -2083,6 +2305,9 @@ export interface GetDomainStatisticsReportRequest { } export namespace GetDomainStatisticsReportRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetDomainStatisticsReportRequest): any => ({ ...obj, }); @@ -2124,6 +2349,9 @@ export interface DomainIspPlacement { } export namespace DomainIspPlacement { + /** + * @internal + */ export const filterSensitiveLog = (obj: DomainIspPlacement): any => ({ ...obj, }); @@ -2159,6 +2387,9 @@ export interface VolumeStatistics { } export namespace VolumeStatistics { + /** + * @internal + */ export const filterSensitiveLog = (obj: VolumeStatistics): any => ({ ...obj, }); @@ -2188,6 +2419,9 @@ export interface DailyVolume { } export namespace DailyVolume { + /** + * @internal + */ export const filterSensitiveLog = (obj: DailyVolume): any => ({ ...obj, }); @@ -2218,6 +2452,9 @@ export interface OverallVolume { } export namespace OverallVolume { + /** + * @internal + */ export const filterSensitiveLog = (obj: OverallVolume): any => ({ ...obj, }); @@ -2244,6 +2481,9 @@ export interface GetDomainStatisticsReportResponse { } export namespace GetDomainStatisticsReportResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetDomainStatisticsReportResponse): any => ({ ...obj, }); @@ -2260,6 +2500,9 @@ export interface GetEmailIdentityRequest { } export namespace GetEmailIdentityRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetEmailIdentityRequest): any => ({ ...obj, }); @@ -2327,6 +2570,9 @@ export interface MailFromAttributes { } export namespace MailFromAttributes { + /** + * @internal + */ export const filterSensitiveLog = (obj: MailFromAttributes): any => ({ ...obj, }); @@ -2382,6 +2628,9 @@ export interface GetEmailIdentityResponse { } export namespace GetEmailIdentityResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetEmailIdentityResponse): any => ({ ...obj, }); @@ -2408,6 +2657,9 @@ export interface ListConfigurationSetsRequest { } export namespace ListConfigurationSetsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListConfigurationSetsRequest): any => ({ ...obj, }); @@ -2433,6 +2685,9 @@ export interface ListConfigurationSetsResponse { } export namespace ListConfigurationSetsResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListConfigurationSetsResponse): any => ({ ...obj, }); @@ -2458,6 +2713,9 @@ export interface ListDedicatedIpPoolsRequest { } export namespace ListDedicatedIpPoolsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListDedicatedIpPoolsRequest): any => ({ ...obj, }); @@ -2482,6 +2740,9 @@ export interface ListDedicatedIpPoolsResponse { } export namespace ListDedicatedIpPoolsResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListDedicatedIpPoolsResponse): any => ({ ...obj, }); @@ -2509,6 +2770,9 @@ export interface ListDeliverabilityTestReportsRequest { } export namespace ListDeliverabilityTestReportsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListDeliverabilityTestReportsRequest): any => ({ ...obj, }); @@ -2533,6 +2797,9 @@ export interface ListDeliverabilityTestReportsResponse { } export namespace ListDeliverabilityTestReportsResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListDeliverabilityTestReportsResponse): any => ({ ...obj, }); @@ -2581,6 +2848,9 @@ export interface ListDomainDeliverabilityCampaignsRequest { } export namespace ListDomainDeliverabilityCampaignsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListDomainDeliverabilityCampaignsRequest): any => ({ ...obj, }); @@ -2608,6 +2878,9 @@ export interface ListDomainDeliverabilityCampaignsResponse { } export namespace ListDomainDeliverabilityCampaignsResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListDomainDeliverabilityCampaignsResponse): any => ({ ...obj, }); @@ -2636,6 +2909,9 @@ export interface ListEmailIdentitiesRequest { } export namespace ListEmailIdentitiesRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListEmailIdentitiesRequest): any => ({ ...obj, }); @@ -2680,6 +2956,9 @@ export interface IdentityInfo { } export namespace IdentityInfo { + /** + * @internal + */ export const filterSensitiveLog = (obj: IdentityInfo): any => ({ ...obj, }); @@ -2706,6 +2985,9 @@ export interface ListEmailIdentitiesResponse { } export namespace ListEmailIdentitiesResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListEmailIdentitiesResponse): any => ({ ...obj, }); @@ -2720,6 +3002,9 @@ export interface ListTagsForResourceRequest { } export namespace ListTagsForResourceRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListTagsForResourceRequest): any => ({ ...obj, }); @@ -2735,6 +3020,9 @@ export interface ListTagsForResourceResponse { } export namespace ListTagsForResourceResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListTagsForResourceResponse): any => ({ ...obj, }); @@ -2754,6 +3042,9 @@ export interface PutAccountDedicatedIpWarmupAttributesRequest { } export namespace PutAccountDedicatedIpWarmupAttributesRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: PutAccountDedicatedIpWarmupAttributesRequest): any => ({ ...obj, }); @@ -2766,6 +3057,9 @@ export namespace PutAccountDedicatedIpWarmupAttributesRequest { export interface PutAccountDedicatedIpWarmupAttributesResponse {} export namespace PutAccountDedicatedIpWarmupAttributesResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: PutAccountDedicatedIpWarmupAttributesResponse): any => ({ ...obj, }); @@ -2787,6 +3081,9 @@ export interface PutAccountSendingAttributesRequest { } export namespace PutAccountSendingAttributesRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: PutAccountSendingAttributesRequest): any => ({ ...obj, }); @@ -2799,6 +3096,9 @@ export namespace PutAccountSendingAttributesRequest { export interface PutAccountSendingAttributesResponse {} export namespace PutAccountSendingAttributesResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: PutAccountSendingAttributesResponse): any => ({ ...obj, }); @@ -2830,6 +3130,9 @@ export interface PutConfigurationSetDeliveryOptionsRequest { } export namespace PutConfigurationSetDeliveryOptionsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: PutConfigurationSetDeliveryOptionsRequest): any => ({ ...obj, }); @@ -2842,6 +3145,9 @@ export namespace PutConfigurationSetDeliveryOptionsRequest { export interface PutConfigurationSetDeliveryOptionsResponse {} export namespace PutConfigurationSetDeliveryOptionsResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: PutConfigurationSetDeliveryOptionsResponse): any => ({ ...obj, }); @@ -2867,6 +3173,9 @@ export interface PutConfigurationSetReputationOptionsRequest { } export namespace PutConfigurationSetReputationOptionsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: PutConfigurationSetReputationOptionsRequest): any => ({ ...obj, }); @@ -2879,6 +3188,9 @@ export namespace PutConfigurationSetReputationOptionsRequest { export interface PutConfigurationSetReputationOptionsResponse {} export namespace PutConfigurationSetReputationOptionsResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: PutConfigurationSetReputationOptionsResponse): any => ({ ...obj, }); @@ -2903,6 +3215,9 @@ export interface PutConfigurationSetSendingOptionsRequest { } export namespace PutConfigurationSetSendingOptionsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: PutConfigurationSetSendingOptionsRequest): any => ({ ...obj, }); @@ -2915,6 +3230,9 @@ export namespace PutConfigurationSetSendingOptionsRequest { export interface PutConfigurationSetSendingOptionsResponse {} export namespace PutConfigurationSetSendingOptionsResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: PutConfigurationSetSendingOptionsResponse): any => ({ ...obj, }); @@ -2938,6 +3256,9 @@ export interface PutConfigurationSetTrackingOptionsRequest { } export namespace PutConfigurationSetTrackingOptionsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: PutConfigurationSetTrackingOptionsRequest): any => ({ ...obj, }); @@ -2950,6 +3271,9 @@ export namespace PutConfigurationSetTrackingOptionsRequest { export interface PutConfigurationSetTrackingOptionsResponse {} export namespace PutConfigurationSetTrackingOptionsResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: PutConfigurationSetTrackingOptionsResponse): any => ({ ...obj, }); @@ -2973,6 +3297,9 @@ export interface PutDedicatedIpInPoolRequest { } export namespace PutDedicatedIpInPoolRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: PutDedicatedIpInPoolRequest): any => ({ ...obj, }); @@ -2985,6 +3312,9 @@ export namespace PutDedicatedIpInPoolRequest { export interface PutDedicatedIpInPoolResponse {} export namespace PutDedicatedIpInPoolResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: PutDedicatedIpInPoolResponse): any => ({ ...obj, }); @@ -3008,6 +3338,9 @@ export interface PutDedicatedIpWarmupAttributesRequest { } export namespace PutDedicatedIpWarmupAttributesRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: PutDedicatedIpWarmupAttributesRequest): any => ({ ...obj, }); @@ -3020,6 +3353,9 @@ export namespace PutDedicatedIpWarmupAttributesRequest { export interface PutDedicatedIpWarmupAttributesResponse {} export namespace PutDedicatedIpWarmupAttributesResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: PutDedicatedIpWarmupAttributesResponse): any => ({ ...obj, }); @@ -3049,6 +3385,9 @@ export interface PutDeliverabilityDashboardOptionRequest { } export namespace PutDeliverabilityDashboardOptionRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: PutDeliverabilityDashboardOptionRequest): any => ({ ...obj, }); @@ -3061,6 +3400,9 @@ export namespace PutDeliverabilityDashboardOptionRequest { export interface PutDeliverabilityDashboardOptionResponse {} export namespace PutDeliverabilityDashboardOptionResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: PutDeliverabilityDashboardOptionResponse): any => ({ ...obj, }); @@ -3086,6 +3428,9 @@ export interface PutEmailIdentityDkimAttributesRequest { } export namespace PutEmailIdentityDkimAttributesRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: PutEmailIdentityDkimAttributesRequest): any => ({ ...obj, }); @@ -3098,6 +3443,9 @@ export namespace PutEmailIdentityDkimAttributesRequest { export interface PutEmailIdentityDkimAttributesResponse {} export namespace PutEmailIdentityDkimAttributesResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: PutEmailIdentityDkimAttributesResponse): any => ({ ...obj, }); @@ -3129,6 +3477,9 @@ export interface PutEmailIdentityFeedbackAttributesRequest { } export namespace PutEmailIdentityFeedbackAttributesRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: PutEmailIdentityFeedbackAttributesRequest): any => ({ ...obj, }); @@ -3141,6 +3492,9 @@ export namespace PutEmailIdentityFeedbackAttributesRequest { export interface PutEmailIdentityFeedbackAttributesResponse {} export namespace PutEmailIdentityFeedbackAttributesResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: PutEmailIdentityFeedbackAttributesResponse): any => ({ ...obj, }); @@ -3188,6 +3542,9 @@ export interface PutEmailIdentityMailFromAttributesRequest { } export namespace PutEmailIdentityMailFromAttributesRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: PutEmailIdentityMailFromAttributesRequest): any => ({ ...obj, }); @@ -3200,6 +3557,9 @@ export namespace PutEmailIdentityMailFromAttributesRequest { export interface PutEmailIdentityMailFromAttributesResponse {} export namespace PutEmailIdentityMailFromAttributesResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: PutEmailIdentityMailFromAttributesResponse): any => ({ ...obj, }); @@ -3229,6 +3589,9 @@ export interface Destination { } export namespace Destination { + /** + * @internal + */ export const filterSensitiveLog = (obj: Destination): any => ({ ...obj, }); @@ -3272,6 +3635,9 @@ export interface MessageTag { } export namespace MessageTag { + /** + * @internal + */ export const filterSensitiveLog = (obj: MessageTag): any => ({ ...obj, }); @@ -3324,6 +3690,9 @@ export interface SendEmailRequest { } export namespace SendEmailRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: SendEmailRequest): any => ({ ...obj, }); @@ -3347,6 +3716,9 @@ export interface SendEmailResponse { } export namespace SendEmailResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: SendEmailResponse): any => ({ ...obj, }); @@ -3369,6 +3741,9 @@ export interface TagResourceRequest { } export namespace TagResourceRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: TagResourceRequest): any => ({ ...obj, }); @@ -3377,6 +3752,9 @@ export namespace TagResourceRequest { export interface TagResourceResponse {} export namespace TagResourceResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: TagResourceResponse): any => ({ ...obj, }); @@ -3402,6 +3780,9 @@ export interface UntagResourceRequest { } export namespace UntagResourceRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: UntagResourceRequest): any => ({ ...obj, }); @@ -3410,6 +3791,9 @@ export namespace UntagResourceRequest { export interface UntagResourceResponse {} export namespace UntagResourceResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: UntagResourceResponse): any => ({ ...obj, }); @@ -3438,6 +3822,9 @@ export interface UpdateConfigurationSetEventDestinationRequest { } export namespace UpdateConfigurationSetEventDestinationRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateConfigurationSetEventDestinationRequest): any => ({ ...obj, }); @@ -3450,6 +3837,9 @@ export namespace UpdateConfigurationSetEventDestinationRequest { export interface UpdateConfigurationSetEventDestinationResponse {} export namespace UpdateConfigurationSetEventDestinationResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateConfigurationSetEventDestinationResponse): any => ({ ...obj, }); diff --git a/clients/client-pinpoint-sms-voice/commands/CreateConfigurationSetCommand.ts b/clients/client-pinpoint-sms-voice/commands/CreateConfigurationSetCommand.ts index 80ad6c5063ca..890ec0fb7b0d 100644 --- a/clients/client-pinpoint-sms-voice/commands/CreateConfigurationSetCommand.ts +++ b/clients/client-pinpoint-sms-voice/commands/CreateConfigurationSetCommand.ts @@ -22,6 +22,20 @@ export interface CreateConfigurationSetCommandOutput extends CreateConfiguration /** * Create a new configuration set. After you create the configuration set, you can add one or more event destinations to it. + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { PinpointSMSVoiceClient, CreateConfigurationSetCommand } from "@aws-sdk/client-pinpoint-sms-voice"; // ES Modules import + * // const { PinpointSMSVoiceClient, CreateConfigurationSetCommand } = require("@aws-sdk/client-pinpoint-sms-voice"); // CommonJS import + * const client = new PinpointSMSVoiceClient(config); + * const command = new CreateConfigurationSetCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreateConfigurationSetCommandInput} for command's `input` shape. + * @see {@link CreateConfigurationSetCommandOutput} for command's `response` shape. + * @see {@link PinpointSMSVoiceClientResolvedConfig | config} for command's `input` shape. + * */ export class CreateConfigurationSetCommand extends $Command< CreateConfigurationSetCommandInput, diff --git a/clients/client-pinpoint-sms-voice/commands/CreateConfigurationSetEventDestinationCommand.ts b/clients/client-pinpoint-sms-voice/commands/CreateConfigurationSetEventDestinationCommand.ts index 7ae61ffccbc1..e81695d47c59 100644 --- a/clients/client-pinpoint-sms-voice/commands/CreateConfigurationSetEventDestinationCommand.ts +++ b/clients/client-pinpoint-sms-voice/commands/CreateConfigurationSetEventDestinationCommand.ts @@ -28,6 +28,20 @@ export interface CreateConfigurationSetEventDestinationCommandOutput /** * Create a new event destination in a configuration set. + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { PinpointSMSVoiceClient, CreateConfigurationSetEventDestinationCommand } from "@aws-sdk/client-pinpoint-sms-voice"; // ES Modules import + * // const { PinpointSMSVoiceClient, CreateConfigurationSetEventDestinationCommand } = require("@aws-sdk/client-pinpoint-sms-voice"); // CommonJS import + * const client = new PinpointSMSVoiceClient(config); + * const command = new CreateConfigurationSetEventDestinationCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreateConfigurationSetEventDestinationCommandInput} for command's `input` shape. + * @see {@link CreateConfigurationSetEventDestinationCommandOutput} for command's `response` shape. + * @see {@link PinpointSMSVoiceClientResolvedConfig | config} for command's `input` shape. + * */ export class CreateConfigurationSetEventDestinationCommand extends $Command< CreateConfigurationSetEventDestinationCommandInput, diff --git a/clients/client-pinpoint-sms-voice/commands/DeleteConfigurationSetCommand.ts b/clients/client-pinpoint-sms-voice/commands/DeleteConfigurationSetCommand.ts index d88c1806d934..98ead047f6c1 100644 --- a/clients/client-pinpoint-sms-voice/commands/DeleteConfigurationSetCommand.ts +++ b/clients/client-pinpoint-sms-voice/commands/DeleteConfigurationSetCommand.ts @@ -22,6 +22,20 @@ export interface DeleteConfigurationSetCommandOutput extends DeleteConfiguration /** * Deletes an existing configuration set. + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { PinpointSMSVoiceClient, DeleteConfigurationSetCommand } from "@aws-sdk/client-pinpoint-sms-voice"; // ES Modules import + * // const { PinpointSMSVoiceClient, DeleteConfigurationSetCommand } = require("@aws-sdk/client-pinpoint-sms-voice"); // CommonJS import + * const client = new PinpointSMSVoiceClient(config); + * const command = new DeleteConfigurationSetCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteConfigurationSetCommandInput} for command's `input` shape. + * @see {@link DeleteConfigurationSetCommandOutput} for command's `response` shape. + * @see {@link PinpointSMSVoiceClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteConfigurationSetCommand extends $Command< DeleteConfigurationSetCommandInput, diff --git a/clients/client-pinpoint-sms-voice/commands/DeleteConfigurationSetEventDestinationCommand.ts b/clients/client-pinpoint-sms-voice/commands/DeleteConfigurationSetEventDestinationCommand.ts index 88f3a8a8e158..e4172fddc7f8 100644 --- a/clients/client-pinpoint-sms-voice/commands/DeleteConfigurationSetEventDestinationCommand.ts +++ b/clients/client-pinpoint-sms-voice/commands/DeleteConfigurationSetEventDestinationCommand.ts @@ -28,6 +28,20 @@ export interface DeleteConfigurationSetEventDestinationCommandOutput /** * Deletes an event destination in a configuration set. + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { PinpointSMSVoiceClient, DeleteConfigurationSetEventDestinationCommand } from "@aws-sdk/client-pinpoint-sms-voice"; // ES Modules import + * // const { PinpointSMSVoiceClient, DeleteConfigurationSetEventDestinationCommand } = require("@aws-sdk/client-pinpoint-sms-voice"); // CommonJS import + * const client = new PinpointSMSVoiceClient(config); + * const command = new DeleteConfigurationSetEventDestinationCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteConfigurationSetEventDestinationCommandInput} for command's `input` shape. + * @see {@link DeleteConfigurationSetEventDestinationCommandOutput} for command's `response` shape. + * @see {@link PinpointSMSVoiceClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteConfigurationSetEventDestinationCommand extends $Command< DeleteConfigurationSetEventDestinationCommandInput, diff --git a/clients/client-pinpoint-sms-voice/commands/GetConfigurationSetEventDestinationsCommand.ts b/clients/client-pinpoint-sms-voice/commands/GetConfigurationSetEventDestinationsCommand.ts index 26fbfb59803c..f5a7cffbddf9 100644 --- a/clients/client-pinpoint-sms-voice/commands/GetConfigurationSetEventDestinationsCommand.ts +++ b/clients/client-pinpoint-sms-voice/commands/GetConfigurationSetEventDestinationsCommand.ts @@ -27,6 +27,20 @@ export interface GetConfigurationSetEventDestinationsCommandOutput /** * 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. + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { PinpointSMSVoiceClient, GetConfigurationSetEventDestinationsCommand } from "@aws-sdk/client-pinpoint-sms-voice"; // ES Modules import + * // const { PinpointSMSVoiceClient, GetConfigurationSetEventDestinationsCommand } = require("@aws-sdk/client-pinpoint-sms-voice"); // CommonJS import + * const client = new PinpointSMSVoiceClient(config); + * const command = new GetConfigurationSetEventDestinationsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetConfigurationSetEventDestinationsCommandInput} for command's `input` shape. + * @see {@link GetConfigurationSetEventDestinationsCommandOutput} for command's `response` shape. + * @see {@link PinpointSMSVoiceClientResolvedConfig | config} for command's `input` shape. + * */ export class GetConfigurationSetEventDestinationsCommand extends $Command< GetConfigurationSetEventDestinationsCommandInput, diff --git a/clients/client-pinpoint-sms-voice/commands/ListConfigurationSetsCommand.ts b/clients/client-pinpoint-sms-voice/commands/ListConfigurationSetsCommand.ts index 99e7146c08ef..d5b49cdefc46 100644 --- a/clients/client-pinpoint-sms-voice/commands/ListConfigurationSetsCommand.ts +++ b/clients/client-pinpoint-sms-voice/commands/ListConfigurationSetsCommand.ts @@ -22,6 +22,20 @@ export interface ListConfigurationSetsCommandOutput extends ListConfigurationSet /** * List all of the configuration sets associated with your Amazon Pinpoint account in the current region. + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { PinpointSMSVoiceClient, ListConfigurationSetsCommand } from "@aws-sdk/client-pinpoint-sms-voice"; // ES Modules import + * // const { PinpointSMSVoiceClient, ListConfigurationSetsCommand } = require("@aws-sdk/client-pinpoint-sms-voice"); // CommonJS import + * const client = new PinpointSMSVoiceClient(config); + * const command = new ListConfigurationSetsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListConfigurationSetsCommandInput} for command's `input` shape. + * @see {@link ListConfigurationSetsCommandOutput} for command's `response` shape. + * @see {@link PinpointSMSVoiceClientResolvedConfig | config} for command's `input` shape. + * */ export class ListConfigurationSetsCommand extends $Command< ListConfigurationSetsCommandInput, diff --git a/clients/client-pinpoint-sms-voice/commands/SendVoiceMessageCommand.ts b/clients/client-pinpoint-sms-voice/commands/SendVoiceMessageCommand.ts index 1cfc80b148b5..e67b6eb6aa60 100644 --- a/clients/client-pinpoint-sms-voice/commands/SendVoiceMessageCommand.ts +++ b/clients/client-pinpoint-sms-voice/commands/SendVoiceMessageCommand.ts @@ -22,6 +22,20 @@ export interface SendVoiceMessageCommandOutput extends SendVoiceMessageResponse, /** * Create a new voice message and send it to a recipient's phone number. + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { PinpointSMSVoiceClient, SendVoiceMessageCommand } from "@aws-sdk/client-pinpoint-sms-voice"; // ES Modules import + * // const { PinpointSMSVoiceClient, SendVoiceMessageCommand } = require("@aws-sdk/client-pinpoint-sms-voice"); // CommonJS import + * const client = new PinpointSMSVoiceClient(config); + * const command = new SendVoiceMessageCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link SendVoiceMessageCommandInput} for command's `input` shape. + * @see {@link SendVoiceMessageCommandOutput} for command's `response` shape. + * @see {@link PinpointSMSVoiceClientResolvedConfig | config} for command's `input` shape. + * */ export class SendVoiceMessageCommand extends $Command< SendVoiceMessageCommandInput, diff --git a/clients/client-pinpoint-sms-voice/commands/UpdateConfigurationSetEventDestinationCommand.ts b/clients/client-pinpoint-sms-voice/commands/UpdateConfigurationSetEventDestinationCommand.ts index 25a5ab9d20aa..4534f71c556a 100644 --- a/clients/client-pinpoint-sms-voice/commands/UpdateConfigurationSetEventDestinationCommand.ts +++ b/clients/client-pinpoint-sms-voice/commands/UpdateConfigurationSetEventDestinationCommand.ts @@ -28,6 +28,20 @@ export interface UpdateConfigurationSetEventDestinationCommandOutput /** * 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. + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { PinpointSMSVoiceClient, UpdateConfigurationSetEventDestinationCommand } from "@aws-sdk/client-pinpoint-sms-voice"; // ES Modules import + * // const { PinpointSMSVoiceClient, UpdateConfigurationSetEventDestinationCommand } = require("@aws-sdk/client-pinpoint-sms-voice"); // CommonJS import + * const client = new PinpointSMSVoiceClient(config); + * const command = new UpdateConfigurationSetEventDestinationCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link UpdateConfigurationSetEventDestinationCommandInput} for command's `input` shape. + * @see {@link UpdateConfigurationSetEventDestinationCommandOutput} for command's `response` shape. + * @see {@link PinpointSMSVoiceClientResolvedConfig | config} for command's `input` shape. + * */ export class UpdateConfigurationSetEventDestinationCommand extends $Command< UpdateConfigurationSetEventDestinationCommandInput, diff --git a/clients/client-pinpoint-sms-voice/models/models_0.ts b/clients/client-pinpoint-sms-voice/models/models_0.ts index a0f70e4fc68e..ef8011fb0ff9 100644 --- a/clients/client-pinpoint-sms-voice/models/models_0.ts +++ b/clients/client-pinpoint-sms-voice/models/models_0.ts @@ -11,6 +11,9 @@ export interface AlreadyExistsException extends __SmithyException, $MetadataBear } export namespace AlreadyExistsException { + /** + * @internal + */ export const filterSensitiveLog = (obj: AlreadyExistsException): any => ({ ...obj, }); @@ -26,6 +29,9 @@ export interface BadRequestException extends __SmithyException, $MetadataBearer } export namespace BadRequestException { + /** + * @internal + */ export const filterSensitiveLog = (obj: BadRequestException): any => ({ ...obj, }); @@ -42,6 +48,9 @@ export interface CallInstructionsMessageType { } export namespace CallInstructionsMessageType { + /** + * @internal + */ export const filterSensitiveLog = (obj: CallInstructionsMessageType): any => ({ ...obj, }); @@ -63,6 +72,9 @@ export interface CloudWatchLogsDestination { } export namespace CloudWatchLogsDestination { + /** + * @internal + */ export const filterSensitiveLog = (obj: CloudWatchLogsDestination): any => ({ ...obj, }); @@ -79,6 +91,9 @@ export interface CreateConfigurationSetRequest { } export namespace CreateConfigurationSetRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateConfigurationSetRequest): any => ({ ...obj, }); @@ -90,6 +105,9 @@ export namespace CreateConfigurationSetRequest { export interface CreateConfigurationSetResponse {} export namespace CreateConfigurationSetResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateConfigurationSetResponse): any => ({ ...obj, }); @@ -105,6 +123,9 @@ export interface InternalServiceErrorException extends __SmithyException, $Metad } export namespace InternalServiceErrorException { + /** + * @internal + */ export const filterSensitiveLog = (obj: InternalServiceErrorException): any => ({ ...obj, }); @@ -120,6 +141,9 @@ export interface LimitExceededException extends __SmithyException, $MetadataBear } export namespace LimitExceededException { + /** + * @internal + */ export const filterSensitiveLog = (obj: LimitExceededException): any => ({ ...obj, }); @@ -135,6 +159,9 @@ export interface TooManyRequestsException extends __SmithyException, $MetadataBe } export namespace TooManyRequestsException { + /** + * @internal + */ export const filterSensitiveLog = (obj: TooManyRequestsException): any => ({ ...obj, }); @@ -156,6 +183,9 @@ export interface KinesisFirehoseDestination { } export namespace KinesisFirehoseDestination { + /** + * @internal + */ export const filterSensitiveLog = (obj: KinesisFirehoseDestination): any => ({ ...obj, }); @@ -182,6 +212,9 @@ export interface SnsDestination { } export namespace SnsDestination { + /** + * @internal + */ export const filterSensitiveLog = (obj: SnsDestination): any => ({ ...obj, }); @@ -218,6 +251,9 @@ export interface EventDestinationDefinition { } export namespace EventDestinationDefinition { + /** + * @internal + */ export const filterSensitiveLog = (obj: EventDestinationDefinition): any => ({ ...obj, }); @@ -244,6 +280,9 @@ export interface CreateConfigurationSetEventDestinationRequest { } export namespace CreateConfigurationSetEventDestinationRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateConfigurationSetEventDestinationRequest): any => ({ ...obj, }); @@ -255,6 +294,9 @@ export namespace CreateConfigurationSetEventDestinationRequest { export interface CreateConfigurationSetEventDestinationResponse {} export namespace CreateConfigurationSetEventDestinationResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateConfigurationSetEventDestinationResponse): any => ({ ...obj, }); @@ -270,6 +312,9 @@ export interface NotFoundException extends __SmithyException, $MetadataBearer { } export namespace NotFoundException { + /** + * @internal + */ export const filterSensitiveLog = (obj: NotFoundException): any => ({ ...obj, }); @@ -283,6 +328,9 @@ export interface DeleteConfigurationSetRequest { } export namespace DeleteConfigurationSetRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteConfigurationSetRequest): any => ({ ...obj, }); @@ -294,6 +342,9 @@ export namespace DeleteConfigurationSetRequest { export interface DeleteConfigurationSetResponse {} export namespace DeleteConfigurationSetResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteConfigurationSetResponse): any => ({ ...obj, }); @@ -312,6 +363,9 @@ export interface DeleteConfigurationSetEventDestinationRequest { } export namespace DeleteConfigurationSetEventDestinationRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteConfigurationSetEventDestinationRequest): any => ({ ...obj, }); @@ -323,6 +377,9 @@ export namespace DeleteConfigurationSetEventDestinationRequest { export interface DeleteConfigurationSetEventDestinationResponse {} export namespace DeleteConfigurationSetEventDestinationResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteConfigurationSetEventDestinationResponse): any => ({ ...obj, }); @@ -364,6 +421,9 @@ export interface EventDestination { } export namespace EventDestination { + /** + * @internal + */ export const filterSensitiveLog = (obj: EventDestination): any => ({ ...obj, }); @@ -377,6 +437,9 @@ export interface GetConfigurationSetEventDestinationsRequest { } export namespace GetConfigurationSetEventDestinationsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetConfigurationSetEventDestinationsRequest): any => ({ ...obj, }); @@ -393,6 +456,9 @@ export interface GetConfigurationSetEventDestinationsResponse { } export namespace GetConfigurationSetEventDestinationsResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetConfigurationSetEventDestinationsResponse): any => ({ ...obj, }); @@ -411,6 +477,9 @@ export interface ListConfigurationSetsRequest { } export namespace ListConfigurationSetsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListConfigurationSetsRequest): any => ({ ...obj, }); @@ -432,6 +501,9 @@ export interface ListConfigurationSetsResponse { } export namespace ListConfigurationSetsResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListConfigurationSetsResponse): any => ({ ...obj, }); @@ -458,6 +530,9 @@ export interface PlainTextMessageType { } export namespace PlainTextMessageType { + /** + * @internal + */ export const filterSensitiveLog = (obj: PlainTextMessageType): any => ({ ...obj, }); @@ -484,6 +559,9 @@ export interface SSMLMessageType { } export namespace SSMLMessageType { + /** + * @internal + */ export const filterSensitiveLog = (obj: SSMLMessageType): any => ({ ...obj, }); @@ -510,6 +588,9 @@ export interface VoiceMessageContent { } export namespace VoiceMessageContent { + /** + * @internal + */ export const filterSensitiveLog = (obj: VoiceMessageContent): any => ({ ...obj, }); @@ -546,6 +627,9 @@ export interface SendVoiceMessageRequest { } export namespace SendVoiceMessageRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: SendVoiceMessageRequest): any => ({ ...obj, }); @@ -562,6 +646,9 @@ export interface SendVoiceMessageResponse { } export namespace SendVoiceMessageResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: SendVoiceMessageResponse): any => ({ ...obj, }); @@ -588,6 +675,9 @@ export interface UpdateConfigurationSetEventDestinationRequest { } export namespace UpdateConfigurationSetEventDestinationRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateConfigurationSetEventDestinationRequest): any => ({ ...obj, }); @@ -599,6 +689,9 @@ export namespace UpdateConfigurationSetEventDestinationRequest { export interface UpdateConfigurationSetEventDestinationResponse {} export namespace UpdateConfigurationSetEventDestinationResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateConfigurationSetEventDestinationResponse): any => ({ ...obj, }); diff --git a/clients/client-pinpoint/commands/CreateAppCommand.ts b/clients/client-pinpoint/commands/CreateAppCommand.ts index 9ef6383c237d..c899f2950e95 100644 --- a/clients/client-pinpoint/commands/CreateAppCommand.ts +++ b/clients/client-pinpoint/commands/CreateAppCommand.ts @@ -22,6 +22,20 @@ export interface CreateAppCommandOutput extends CreateAppResponse, __MetadataBea /** *

Creates an application.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { PinpointClient, CreateAppCommand } from "@aws-sdk/client-pinpoint"; // ES Modules import + * // const { PinpointClient, CreateAppCommand } = require("@aws-sdk/client-pinpoint"); // CommonJS import + * const client = new PinpointClient(config); + * const command = new CreateAppCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreateAppCommandInput} for command's `input` shape. + * @see {@link CreateAppCommandOutput} for command's `response` shape. + * @see {@link PinpointClientResolvedConfig | config} for command's `input` shape. + * */ export class CreateAppCommand extends $Command< CreateAppCommandInput, diff --git a/clients/client-pinpoint/commands/CreateCampaignCommand.ts b/clients/client-pinpoint/commands/CreateCampaignCommand.ts index a0956c5f059a..de2ad560f3bd 100644 --- a/clients/client-pinpoint/commands/CreateCampaignCommand.ts +++ b/clients/client-pinpoint/commands/CreateCampaignCommand.ts @@ -22,6 +22,20 @@ export interface CreateCampaignCommandOutput extends CreateCampaignResponse, __M /** *

Creates a new campaign for an application or updates the settings of an existing campaign for an application.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { PinpointClient, CreateCampaignCommand } from "@aws-sdk/client-pinpoint"; // ES Modules import + * // const { PinpointClient, CreateCampaignCommand } = require("@aws-sdk/client-pinpoint"); // CommonJS import + * const client = new PinpointClient(config); + * const command = new CreateCampaignCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreateCampaignCommandInput} for command's `input` shape. + * @see {@link CreateCampaignCommandOutput} for command's `response` shape. + * @see {@link PinpointClientResolvedConfig | config} for command's `input` shape. + * */ export class CreateCampaignCommand extends $Command< CreateCampaignCommandInput, diff --git a/clients/client-pinpoint/commands/CreateEmailTemplateCommand.ts b/clients/client-pinpoint/commands/CreateEmailTemplateCommand.ts index 8095a4555e3a..3741afe29a20 100644 --- a/clients/client-pinpoint/commands/CreateEmailTemplateCommand.ts +++ b/clients/client-pinpoint/commands/CreateEmailTemplateCommand.ts @@ -22,6 +22,20 @@ export interface CreateEmailTemplateCommandOutput extends CreateEmailTemplateRes /** *

Creates a message template for messages that are sent through the email channel.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { PinpointClient, CreateEmailTemplateCommand } from "@aws-sdk/client-pinpoint"; // ES Modules import + * // const { PinpointClient, CreateEmailTemplateCommand } = require("@aws-sdk/client-pinpoint"); // CommonJS import + * const client = new PinpointClient(config); + * const command = new CreateEmailTemplateCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreateEmailTemplateCommandInput} for command's `input` shape. + * @see {@link CreateEmailTemplateCommandOutput} for command's `response` shape. + * @see {@link PinpointClientResolvedConfig | config} for command's `input` shape. + * */ export class CreateEmailTemplateCommand extends $Command< CreateEmailTemplateCommandInput, diff --git a/clients/client-pinpoint/commands/CreateExportJobCommand.ts b/clients/client-pinpoint/commands/CreateExportJobCommand.ts index 0e9f71889449..39a23876bd6c 100644 --- a/clients/client-pinpoint/commands/CreateExportJobCommand.ts +++ b/clients/client-pinpoint/commands/CreateExportJobCommand.ts @@ -22,6 +22,20 @@ export interface CreateExportJobCommandOutput extends CreateExportJobResponse, _ /** *

Creates an export job for an application.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { PinpointClient, CreateExportJobCommand } from "@aws-sdk/client-pinpoint"; // ES Modules import + * // const { PinpointClient, CreateExportJobCommand } = require("@aws-sdk/client-pinpoint"); // CommonJS import + * const client = new PinpointClient(config); + * const command = new CreateExportJobCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreateExportJobCommandInput} for command's `input` shape. + * @see {@link CreateExportJobCommandOutput} for command's `response` shape. + * @see {@link PinpointClientResolvedConfig | config} for command's `input` shape. + * */ export class CreateExportJobCommand extends $Command< CreateExportJobCommandInput, diff --git a/clients/client-pinpoint/commands/CreateImportJobCommand.ts b/clients/client-pinpoint/commands/CreateImportJobCommand.ts index a81295e459fe..15c55cb88c64 100644 --- a/clients/client-pinpoint/commands/CreateImportJobCommand.ts +++ b/clients/client-pinpoint/commands/CreateImportJobCommand.ts @@ -22,6 +22,20 @@ export interface CreateImportJobCommandOutput extends CreateImportJobResponse, _ /** *

Creates an import job for an application.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { PinpointClient, CreateImportJobCommand } from "@aws-sdk/client-pinpoint"; // ES Modules import + * // const { PinpointClient, CreateImportJobCommand } = require("@aws-sdk/client-pinpoint"); // CommonJS import + * const client = new PinpointClient(config); + * const command = new CreateImportJobCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreateImportJobCommandInput} for command's `input` shape. + * @see {@link CreateImportJobCommandOutput} for command's `response` shape. + * @see {@link PinpointClientResolvedConfig | config} for command's `input` shape. + * */ export class CreateImportJobCommand extends $Command< CreateImportJobCommandInput, diff --git a/clients/client-pinpoint/commands/CreateJourneyCommand.ts b/clients/client-pinpoint/commands/CreateJourneyCommand.ts index 08b9b841a3ae..481b68ba08ed 100644 --- a/clients/client-pinpoint/commands/CreateJourneyCommand.ts +++ b/clients/client-pinpoint/commands/CreateJourneyCommand.ts @@ -22,6 +22,20 @@ export interface CreateJourneyCommandOutput extends CreateJourneyResponse, __Met /** *

Creates a journey for an application.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { PinpointClient, CreateJourneyCommand } from "@aws-sdk/client-pinpoint"; // ES Modules import + * // const { PinpointClient, CreateJourneyCommand } = require("@aws-sdk/client-pinpoint"); // CommonJS import + * const client = new PinpointClient(config); + * const command = new CreateJourneyCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreateJourneyCommandInput} for command's `input` shape. + * @see {@link CreateJourneyCommandOutput} for command's `response` shape. + * @see {@link PinpointClientResolvedConfig | config} for command's `input` shape. + * */ export class CreateJourneyCommand extends $Command< CreateJourneyCommandInput, diff --git a/clients/client-pinpoint/commands/CreatePushTemplateCommand.ts b/clients/client-pinpoint/commands/CreatePushTemplateCommand.ts index d915c47265b1..f0d5fea8b222 100644 --- a/clients/client-pinpoint/commands/CreatePushTemplateCommand.ts +++ b/clients/client-pinpoint/commands/CreatePushTemplateCommand.ts @@ -22,6 +22,20 @@ export interface CreatePushTemplateCommandOutput extends CreatePushTemplateRespo /** *

Creates a message template for messages that are sent through a push notification channel.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { PinpointClient, CreatePushTemplateCommand } from "@aws-sdk/client-pinpoint"; // ES Modules import + * // const { PinpointClient, CreatePushTemplateCommand } = require("@aws-sdk/client-pinpoint"); // CommonJS import + * const client = new PinpointClient(config); + * const command = new CreatePushTemplateCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreatePushTemplateCommandInput} for command's `input` shape. + * @see {@link CreatePushTemplateCommandOutput} for command's `response` shape. + * @see {@link PinpointClientResolvedConfig | config} for command's `input` shape. + * */ export class CreatePushTemplateCommand extends $Command< CreatePushTemplateCommandInput, diff --git a/clients/client-pinpoint/commands/CreateRecommenderConfigurationCommand.ts b/clients/client-pinpoint/commands/CreateRecommenderConfigurationCommand.ts index 123dd7eaba04..ff2eac3bd875 100644 --- a/clients/client-pinpoint/commands/CreateRecommenderConfigurationCommand.ts +++ b/clients/client-pinpoint/commands/CreateRecommenderConfigurationCommand.ts @@ -24,6 +24,20 @@ export interface CreateRecommenderConfigurationCommandOutput /** *

Creates an Amazon Pinpoint configuration for a recommender model.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { PinpointClient, CreateRecommenderConfigurationCommand } from "@aws-sdk/client-pinpoint"; // ES Modules import + * // const { PinpointClient, CreateRecommenderConfigurationCommand } = require("@aws-sdk/client-pinpoint"); // CommonJS import + * const client = new PinpointClient(config); + * const command = new CreateRecommenderConfigurationCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreateRecommenderConfigurationCommandInput} for command's `input` shape. + * @see {@link CreateRecommenderConfigurationCommandOutput} for command's `response` shape. + * @see {@link PinpointClientResolvedConfig | config} for command's `input` shape. + * */ export class CreateRecommenderConfigurationCommand extends $Command< CreateRecommenderConfigurationCommandInput, diff --git a/clients/client-pinpoint/commands/CreateSegmentCommand.ts b/clients/client-pinpoint/commands/CreateSegmentCommand.ts index fa75770c7161..04fa967cadef 100644 --- a/clients/client-pinpoint/commands/CreateSegmentCommand.ts +++ b/clients/client-pinpoint/commands/CreateSegmentCommand.ts @@ -22,6 +22,20 @@ export interface CreateSegmentCommandOutput extends CreateSegmentResponse, __Met /** *

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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { PinpointClient, CreateSegmentCommand } from "@aws-sdk/client-pinpoint"; // ES Modules import + * // const { PinpointClient, CreateSegmentCommand } = require("@aws-sdk/client-pinpoint"); // CommonJS import + * const client = new PinpointClient(config); + * const command = new CreateSegmentCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreateSegmentCommandInput} for command's `input` shape. + * @see {@link CreateSegmentCommandOutput} for command's `response` shape. + * @see {@link PinpointClientResolvedConfig | config} for command's `input` shape. + * */ export class CreateSegmentCommand extends $Command< CreateSegmentCommandInput, diff --git a/clients/client-pinpoint/commands/CreateSmsTemplateCommand.ts b/clients/client-pinpoint/commands/CreateSmsTemplateCommand.ts index 6c6b9b0039e8..0aae927f42af 100644 --- a/clients/client-pinpoint/commands/CreateSmsTemplateCommand.ts +++ b/clients/client-pinpoint/commands/CreateSmsTemplateCommand.ts @@ -22,6 +22,20 @@ export interface CreateSmsTemplateCommandOutput extends CreateSmsTemplateRespons /** *

Creates a message template for messages that are sent through the SMS channel.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { PinpointClient, CreateSmsTemplateCommand } from "@aws-sdk/client-pinpoint"; // ES Modules import + * // const { PinpointClient, CreateSmsTemplateCommand } = require("@aws-sdk/client-pinpoint"); // CommonJS import + * const client = new PinpointClient(config); + * const command = new CreateSmsTemplateCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreateSmsTemplateCommandInput} for command's `input` shape. + * @see {@link CreateSmsTemplateCommandOutput} for command's `response` shape. + * @see {@link PinpointClientResolvedConfig | config} for command's `input` shape. + * */ export class CreateSmsTemplateCommand extends $Command< CreateSmsTemplateCommandInput, diff --git a/clients/client-pinpoint/commands/CreateVoiceTemplateCommand.ts b/clients/client-pinpoint/commands/CreateVoiceTemplateCommand.ts index f78bb91acc90..71d4abe59be8 100644 --- a/clients/client-pinpoint/commands/CreateVoiceTemplateCommand.ts +++ b/clients/client-pinpoint/commands/CreateVoiceTemplateCommand.ts @@ -22,6 +22,20 @@ export interface CreateVoiceTemplateCommandOutput extends CreateVoiceTemplateRes /** *

Creates a message template for messages that are sent through the voice channel.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { PinpointClient, CreateVoiceTemplateCommand } from "@aws-sdk/client-pinpoint"; // ES Modules import + * // const { PinpointClient, CreateVoiceTemplateCommand } = require("@aws-sdk/client-pinpoint"); // CommonJS import + * const client = new PinpointClient(config); + * const command = new CreateVoiceTemplateCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreateVoiceTemplateCommandInput} for command's `input` shape. + * @see {@link CreateVoiceTemplateCommandOutput} for command's `response` shape. + * @see {@link PinpointClientResolvedConfig | config} for command's `input` shape. + * */ export class CreateVoiceTemplateCommand extends $Command< CreateVoiceTemplateCommandInput, diff --git a/clients/client-pinpoint/commands/DeleteAdmChannelCommand.ts b/clients/client-pinpoint/commands/DeleteAdmChannelCommand.ts index fb13a1bb29f4..8d9e827269b4 100644 --- a/clients/client-pinpoint/commands/DeleteAdmChannelCommand.ts +++ b/clients/client-pinpoint/commands/DeleteAdmChannelCommand.ts @@ -22,6 +22,20 @@ export interface DeleteAdmChannelCommandOutput extends DeleteAdmChannelResponse, /** *

Disables the ADM channel for an application and deletes any existing settings for the channel.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { PinpointClient, DeleteAdmChannelCommand } from "@aws-sdk/client-pinpoint"; // ES Modules import + * // const { PinpointClient, DeleteAdmChannelCommand } = require("@aws-sdk/client-pinpoint"); // CommonJS import + * const client = new PinpointClient(config); + * const command = new DeleteAdmChannelCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteAdmChannelCommandInput} for command's `input` shape. + * @see {@link DeleteAdmChannelCommandOutput} for command's `response` shape. + * @see {@link PinpointClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteAdmChannelCommand extends $Command< DeleteAdmChannelCommandInput, diff --git a/clients/client-pinpoint/commands/DeleteApnsChannelCommand.ts b/clients/client-pinpoint/commands/DeleteApnsChannelCommand.ts index afef5f9a20fa..6203965d9091 100644 --- a/clients/client-pinpoint/commands/DeleteApnsChannelCommand.ts +++ b/clients/client-pinpoint/commands/DeleteApnsChannelCommand.ts @@ -22,6 +22,20 @@ export interface DeleteApnsChannelCommandOutput extends DeleteApnsChannelRespons /** *

Disables the APNs channel for an application and deletes any existing settings for the channel.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { PinpointClient, DeleteApnsChannelCommand } from "@aws-sdk/client-pinpoint"; // ES Modules import + * // const { PinpointClient, DeleteApnsChannelCommand } = require("@aws-sdk/client-pinpoint"); // CommonJS import + * const client = new PinpointClient(config); + * const command = new DeleteApnsChannelCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteApnsChannelCommandInput} for command's `input` shape. + * @see {@link DeleteApnsChannelCommandOutput} for command's `response` shape. + * @see {@link PinpointClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteApnsChannelCommand extends $Command< DeleteApnsChannelCommandInput, diff --git a/clients/client-pinpoint/commands/DeleteApnsSandboxChannelCommand.ts b/clients/client-pinpoint/commands/DeleteApnsSandboxChannelCommand.ts index 145f4ea87670..5918f71ca5cf 100644 --- a/clients/client-pinpoint/commands/DeleteApnsSandboxChannelCommand.ts +++ b/clients/client-pinpoint/commands/DeleteApnsSandboxChannelCommand.ts @@ -22,6 +22,20 @@ export interface DeleteApnsSandboxChannelCommandOutput extends DeleteApnsSandbox /** *

Disables the APNs sandbox channel for an application and deletes any existing settings for the channel.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { PinpointClient, DeleteApnsSandboxChannelCommand } from "@aws-sdk/client-pinpoint"; // ES Modules import + * // const { PinpointClient, DeleteApnsSandboxChannelCommand } = require("@aws-sdk/client-pinpoint"); // CommonJS import + * const client = new PinpointClient(config); + * const command = new DeleteApnsSandboxChannelCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteApnsSandboxChannelCommandInput} for command's `input` shape. + * @see {@link DeleteApnsSandboxChannelCommandOutput} for command's `response` shape. + * @see {@link PinpointClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteApnsSandboxChannelCommand extends $Command< DeleteApnsSandboxChannelCommandInput, diff --git a/clients/client-pinpoint/commands/DeleteApnsVoipChannelCommand.ts b/clients/client-pinpoint/commands/DeleteApnsVoipChannelCommand.ts index 84481052e532..9ac752ff1dfd 100644 --- a/clients/client-pinpoint/commands/DeleteApnsVoipChannelCommand.ts +++ b/clients/client-pinpoint/commands/DeleteApnsVoipChannelCommand.ts @@ -22,6 +22,20 @@ export interface DeleteApnsVoipChannelCommandOutput extends DeleteApnsVoipChanne /** *

Disables the APNs VoIP channel for an application and deletes any existing settings for the channel.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { PinpointClient, DeleteApnsVoipChannelCommand } from "@aws-sdk/client-pinpoint"; // ES Modules import + * // const { PinpointClient, DeleteApnsVoipChannelCommand } = require("@aws-sdk/client-pinpoint"); // CommonJS import + * const client = new PinpointClient(config); + * const command = new DeleteApnsVoipChannelCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteApnsVoipChannelCommandInput} for command's `input` shape. + * @see {@link DeleteApnsVoipChannelCommandOutput} for command's `response` shape. + * @see {@link PinpointClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteApnsVoipChannelCommand extends $Command< DeleteApnsVoipChannelCommandInput, diff --git a/clients/client-pinpoint/commands/DeleteApnsVoipSandboxChannelCommand.ts b/clients/client-pinpoint/commands/DeleteApnsVoipSandboxChannelCommand.ts index ba92e2134db1..e25d4f2c8c05 100644 --- a/clients/client-pinpoint/commands/DeleteApnsVoipSandboxChannelCommand.ts +++ b/clients/client-pinpoint/commands/DeleteApnsVoipSandboxChannelCommand.ts @@ -24,6 +24,20 @@ export interface DeleteApnsVoipSandboxChannelCommandOutput /** *

Disables the APNs VoIP sandbox channel for an application and deletes any existing settings for the channel.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { PinpointClient, DeleteApnsVoipSandboxChannelCommand } from "@aws-sdk/client-pinpoint"; // ES Modules import + * // const { PinpointClient, DeleteApnsVoipSandboxChannelCommand } = require("@aws-sdk/client-pinpoint"); // CommonJS import + * const client = new PinpointClient(config); + * const command = new DeleteApnsVoipSandboxChannelCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteApnsVoipSandboxChannelCommandInput} for command's `input` shape. + * @see {@link DeleteApnsVoipSandboxChannelCommandOutput} for command's `response` shape. + * @see {@link PinpointClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteApnsVoipSandboxChannelCommand extends $Command< DeleteApnsVoipSandboxChannelCommandInput, diff --git a/clients/client-pinpoint/commands/DeleteAppCommand.ts b/clients/client-pinpoint/commands/DeleteAppCommand.ts index 68c9b6266704..574e3fd19b5d 100644 --- a/clients/client-pinpoint/commands/DeleteAppCommand.ts +++ b/clients/client-pinpoint/commands/DeleteAppCommand.ts @@ -22,6 +22,20 @@ export interface DeleteAppCommandOutput extends DeleteAppResponse, __MetadataBea /** *

Deletes an application.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { PinpointClient, DeleteAppCommand } from "@aws-sdk/client-pinpoint"; // ES Modules import + * // const { PinpointClient, DeleteAppCommand } = require("@aws-sdk/client-pinpoint"); // CommonJS import + * const client = new PinpointClient(config); + * const command = new DeleteAppCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteAppCommandInput} for command's `input` shape. + * @see {@link DeleteAppCommandOutput} for command's `response` shape. + * @see {@link PinpointClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteAppCommand extends $Command< DeleteAppCommandInput, diff --git a/clients/client-pinpoint/commands/DeleteBaiduChannelCommand.ts b/clients/client-pinpoint/commands/DeleteBaiduChannelCommand.ts index 7ad07774e514..ec608764bd1b 100644 --- a/clients/client-pinpoint/commands/DeleteBaiduChannelCommand.ts +++ b/clients/client-pinpoint/commands/DeleteBaiduChannelCommand.ts @@ -22,6 +22,20 @@ export interface DeleteBaiduChannelCommandOutput extends DeleteBaiduChannelRespo /** *

Disables the Baidu channel for an application and deletes any existing settings for the channel.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { PinpointClient, DeleteBaiduChannelCommand } from "@aws-sdk/client-pinpoint"; // ES Modules import + * // const { PinpointClient, DeleteBaiduChannelCommand } = require("@aws-sdk/client-pinpoint"); // CommonJS import + * const client = new PinpointClient(config); + * const command = new DeleteBaiduChannelCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteBaiduChannelCommandInput} for command's `input` shape. + * @see {@link DeleteBaiduChannelCommandOutput} for command's `response` shape. + * @see {@link PinpointClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteBaiduChannelCommand extends $Command< DeleteBaiduChannelCommandInput, diff --git a/clients/client-pinpoint/commands/DeleteCampaignCommand.ts b/clients/client-pinpoint/commands/DeleteCampaignCommand.ts index 05b202626262..a2e45f0679fb 100644 --- a/clients/client-pinpoint/commands/DeleteCampaignCommand.ts +++ b/clients/client-pinpoint/commands/DeleteCampaignCommand.ts @@ -22,6 +22,20 @@ export interface DeleteCampaignCommandOutput extends DeleteCampaignResponse, __M /** *

Deletes a campaign from an application.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { PinpointClient, DeleteCampaignCommand } from "@aws-sdk/client-pinpoint"; // ES Modules import + * // const { PinpointClient, DeleteCampaignCommand } = require("@aws-sdk/client-pinpoint"); // CommonJS import + * const client = new PinpointClient(config); + * const command = new DeleteCampaignCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteCampaignCommandInput} for command's `input` shape. + * @see {@link DeleteCampaignCommandOutput} for command's `response` shape. + * @see {@link PinpointClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteCampaignCommand extends $Command< DeleteCampaignCommandInput, diff --git a/clients/client-pinpoint/commands/DeleteEmailChannelCommand.ts b/clients/client-pinpoint/commands/DeleteEmailChannelCommand.ts index 177873ab2de7..c9ff2608251b 100644 --- a/clients/client-pinpoint/commands/DeleteEmailChannelCommand.ts +++ b/clients/client-pinpoint/commands/DeleteEmailChannelCommand.ts @@ -22,6 +22,20 @@ export interface DeleteEmailChannelCommandOutput extends DeleteEmailChannelRespo /** *

Disables the email channel for an application and deletes any existing settings for the channel.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { PinpointClient, DeleteEmailChannelCommand } from "@aws-sdk/client-pinpoint"; // ES Modules import + * // const { PinpointClient, DeleteEmailChannelCommand } = require("@aws-sdk/client-pinpoint"); // CommonJS import + * const client = new PinpointClient(config); + * const command = new DeleteEmailChannelCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteEmailChannelCommandInput} for command's `input` shape. + * @see {@link DeleteEmailChannelCommandOutput} for command's `response` shape. + * @see {@link PinpointClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteEmailChannelCommand extends $Command< DeleteEmailChannelCommandInput, diff --git a/clients/client-pinpoint/commands/DeleteEmailTemplateCommand.ts b/clients/client-pinpoint/commands/DeleteEmailTemplateCommand.ts index 6aeda202e48d..ba1d4d006893 100644 --- a/clients/client-pinpoint/commands/DeleteEmailTemplateCommand.ts +++ b/clients/client-pinpoint/commands/DeleteEmailTemplateCommand.ts @@ -22,6 +22,20 @@ export interface DeleteEmailTemplateCommandOutput extends DeleteEmailTemplateRes /** *

Deletes a message template for messages that were sent through the email channel.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { PinpointClient, DeleteEmailTemplateCommand } from "@aws-sdk/client-pinpoint"; // ES Modules import + * // const { PinpointClient, DeleteEmailTemplateCommand } = require("@aws-sdk/client-pinpoint"); // CommonJS import + * const client = new PinpointClient(config); + * const command = new DeleteEmailTemplateCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteEmailTemplateCommandInput} for command's `input` shape. + * @see {@link DeleteEmailTemplateCommandOutput} for command's `response` shape. + * @see {@link PinpointClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteEmailTemplateCommand extends $Command< DeleteEmailTemplateCommandInput, diff --git a/clients/client-pinpoint/commands/DeleteEndpointCommand.ts b/clients/client-pinpoint/commands/DeleteEndpointCommand.ts index d3b593a5b7ba..f5ca2a307490 100644 --- a/clients/client-pinpoint/commands/DeleteEndpointCommand.ts +++ b/clients/client-pinpoint/commands/DeleteEndpointCommand.ts @@ -22,6 +22,20 @@ export interface DeleteEndpointCommandOutput extends DeleteEndpointResponse, __M /** *

Deletes an endpoint from an application.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { PinpointClient, DeleteEndpointCommand } from "@aws-sdk/client-pinpoint"; // ES Modules import + * // const { PinpointClient, DeleteEndpointCommand } = require("@aws-sdk/client-pinpoint"); // CommonJS import + * const client = new PinpointClient(config); + * const command = new DeleteEndpointCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteEndpointCommandInput} for command's `input` shape. + * @see {@link DeleteEndpointCommandOutput} for command's `response` shape. + * @see {@link PinpointClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteEndpointCommand extends $Command< DeleteEndpointCommandInput, diff --git a/clients/client-pinpoint/commands/DeleteEventStreamCommand.ts b/clients/client-pinpoint/commands/DeleteEventStreamCommand.ts index 09978408fd09..08668bb573fd 100644 --- a/clients/client-pinpoint/commands/DeleteEventStreamCommand.ts +++ b/clients/client-pinpoint/commands/DeleteEventStreamCommand.ts @@ -22,6 +22,20 @@ export interface DeleteEventStreamCommandOutput extends DeleteEventStreamRespons /** *

Deletes the event stream for an application.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { PinpointClient, DeleteEventStreamCommand } from "@aws-sdk/client-pinpoint"; // ES Modules import + * // const { PinpointClient, DeleteEventStreamCommand } = require("@aws-sdk/client-pinpoint"); // CommonJS import + * const client = new PinpointClient(config); + * const command = new DeleteEventStreamCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteEventStreamCommandInput} for command's `input` shape. + * @see {@link DeleteEventStreamCommandOutput} for command's `response` shape. + * @see {@link PinpointClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteEventStreamCommand extends $Command< DeleteEventStreamCommandInput, diff --git a/clients/client-pinpoint/commands/DeleteGcmChannelCommand.ts b/clients/client-pinpoint/commands/DeleteGcmChannelCommand.ts index c2c5b4502991..8835a23f44e9 100644 --- a/clients/client-pinpoint/commands/DeleteGcmChannelCommand.ts +++ b/clients/client-pinpoint/commands/DeleteGcmChannelCommand.ts @@ -22,6 +22,20 @@ export interface DeleteGcmChannelCommandOutput extends DeleteGcmChannelResponse, /** *

Disables the GCM channel for an application and deletes any existing settings for the channel.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { PinpointClient, DeleteGcmChannelCommand } from "@aws-sdk/client-pinpoint"; // ES Modules import + * // const { PinpointClient, DeleteGcmChannelCommand } = require("@aws-sdk/client-pinpoint"); // CommonJS import + * const client = new PinpointClient(config); + * const command = new DeleteGcmChannelCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteGcmChannelCommandInput} for command's `input` shape. + * @see {@link DeleteGcmChannelCommandOutput} for command's `response` shape. + * @see {@link PinpointClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteGcmChannelCommand extends $Command< DeleteGcmChannelCommandInput, diff --git a/clients/client-pinpoint/commands/DeleteJourneyCommand.ts b/clients/client-pinpoint/commands/DeleteJourneyCommand.ts index 4c4b7668f66f..0d587cdadd70 100644 --- a/clients/client-pinpoint/commands/DeleteJourneyCommand.ts +++ b/clients/client-pinpoint/commands/DeleteJourneyCommand.ts @@ -22,6 +22,20 @@ export interface DeleteJourneyCommandOutput extends DeleteJourneyResponse, __Met /** *

Deletes a journey from an application.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { PinpointClient, DeleteJourneyCommand } from "@aws-sdk/client-pinpoint"; // ES Modules import + * // const { PinpointClient, DeleteJourneyCommand } = require("@aws-sdk/client-pinpoint"); // CommonJS import + * const client = new PinpointClient(config); + * const command = new DeleteJourneyCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteJourneyCommandInput} for command's `input` shape. + * @see {@link DeleteJourneyCommandOutput} for command's `response` shape. + * @see {@link PinpointClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteJourneyCommand extends $Command< DeleteJourneyCommandInput, diff --git a/clients/client-pinpoint/commands/DeletePushTemplateCommand.ts b/clients/client-pinpoint/commands/DeletePushTemplateCommand.ts index 0993d0f80802..4db29a29ce8e 100644 --- a/clients/client-pinpoint/commands/DeletePushTemplateCommand.ts +++ b/clients/client-pinpoint/commands/DeletePushTemplateCommand.ts @@ -22,6 +22,20 @@ export interface DeletePushTemplateCommandOutput extends DeletePushTemplateRespo /** *

Deletes a message template for messages that were sent through a push notification channel.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { PinpointClient, DeletePushTemplateCommand } from "@aws-sdk/client-pinpoint"; // ES Modules import + * // const { PinpointClient, DeletePushTemplateCommand } = require("@aws-sdk/client-pinpoint"); // CommonJS import + * const client = new PinpointClient(config); + * const command = new DeletePushTemplateCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeletePushTemplateCommandInput} for command's `input` shape. + * @see {@link DeletePushTemplateCommandOutput} for command's `response` shape. + * @see {@link PinpointClientResolvedConfig | config} for command's `input` shape. + * */ export class DeletePushTemplateCommand extends $Command< DeletePushTemplateCommandInput, diff --git a/clients/client-pinpoint/commands/DeleteRecommenderConfigurationCommand.ts b/clients/client-pinpoint/commands/DeleteRecommenderConfigurationCommand.ts index c6741dfc46eb..43dd63793539 100644 --- a/clients/client-pinpoint/commands/DeleteRecommenderConfigurationCommand.ts +++ b/clients/client-pinpoint/commands/DeleteRecommenderConfigurationCommand.ts @@ -24,6 +24,20 @@ export interface DeleteRecommenderConfigurationCommandOutput /** *

Deletes an Amazon Pinpoint configuration for a recommender model.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { PinpointClient, DeleteRecommenderConfigurationCommand } from "@aws-sdk/client-pinpoint"; // ES Modules import + * // const { PinpointClient, DeleteRecommenderConfigurationCommand } = require("@aws-sdk/client-pinpoint"); // CommonJS import + * const client = new PinpointClient(config); + * const command = new DeleteRecommenderConfigurationCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteRecommenderConfigurationCommandInput} for command's `input` shape. + * @see {@link DeleteRecommenderConfigurationCommandOutput} for command's `response` shape. + * @see {@link PinpointClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteRecommenderConfigurationCommand extends $Command< DeleteRecommenderConfigurationCommandInput, diff --git a/clients/client-pinpoint/commands/DeleteSegmentCommand.ts b/clients/client-pinpoint/commands/DeleteSegmentCommand.ts index 6636dddab12e..b11cdf08eb66 100644 --- a/clients/client-pinpoint/commands/DeleteSegmentCommand.ts +++ b/clients/client-pinpoint/commands/DeleteSegmentCommand.ts @@ -22,6 +22,20 @@ export interface DeleteSegmentCommandOutput extends DeleteSegmentResponse, __Met /** *

Deletes a segment from an application.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { PinpointClient, DeleteSegmentCommand } from "@aws-sdk/client-pinpoint"; // ES Modules import + * // const { PinpointClient, DeleteSegmentCommand } = require("@aws-sdk/client-pinpoint"); // CommonJS import + * const client = new PinpointClient(config); + * const command = new DeleteSegmentCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteSegmentCommandInput} for command's `input` shape. + * @see {@link DeleteSegmentCommandOutput} for command's `response` shape. + * @see {@link PinpointClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteSegmentCommand extends $Command< DeleteSegmentCommandInput, diff --git a/clients/client-pinpoint/commands/DeleteSmsChannelCommand.ts b/clients/client-pinpoint/commands/DeleteSmsChannelCommand.ts index 4e8cbc85df6d..fd7be1c5556f 100644 --- a/clients/client-pinpoint/commands/DeleteSmsChannelCommand.ts +++ b/clients/client-pinpoint/commands/DeleteSmsChannelCommand.ts @@ -22,6 +22,20 @@ export interface DeleteSmsChannelCommandOutput extends DeleteSmsChannelResponse, /** *

Disables the SMS channel for an application and deletes any existing settings for the channel.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { PinpointClient, DeleteSmsChannelCommand } from "@aws-sdk/client-pinpoint"; // ES Modules import + * // const { PinpointClient, DeleteSmsChannelCommand } = require("@aws-sdk/client-pinpoint"); // CommonJS import + * const client = new PinpointClient(config); + * const command = new DeleteSmsChannelCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteSmsChannelCommandInput} for command's `input` shape. + * @see {@link DeleteSmsChannelCommandOutput} for command's `response` shape. + * @see {@link PinpointClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteSmsChannelCommand extends $Command< DeleteSmsChannelCommandInput, diff --git a/clients/client-pinpoint/commands/DeleteSmsTemplateCommand.ts b/clients/client-pinpoint/commands/DeleteSmsTemplateCommand.ts index 10c439359a20..328ba516449d 100644 --- a/clients/client-pinpoint/commands/DeleteSmsTemplateCommand.ts +++ b/clients/client-pinpoint/commands/DeleteSmsTemplateCommand.ts @@ -22,6 +22,20 @@ export interface DeleteSmsTemplateCommandOutput extends DeleteSmsTemplateRespons /** *

Deletes a message template for messages that were sent through the SMS channel.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { PinpointClient, DeleteSmsTemplateCommand } from "@aws-sdk/client-pinpoint"; // ES Modules import + * // const { PinpointClient, DeleteSmsTemplateCommand } = require("@aws-sdk/client-pinpoint"); // CommonJS import + * const client = new PinpointClient(config); + * const command = new DeleteSmsTemplateCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteSmsTemplateCommandInput} for command's `input` shape. + * @see {@link DeleteSmsTemplateCommandOutput} for command's `response` shape. + * @see {@link PinpointClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteSmsTemplateCommand extends $Command< DeleteSmsTemplateCommandInput, diff --git a/clients/client-pinpoint/commands/DeleteUserEndpointsCommand.ts b/clients/client-pinpoint/commands/DeleteUserEndpointsCommand.ts index 432d99bcdc51..4c05971c9b87 100644 --- a/clients/client-pinpoint/commands/DeleteUserEndpointsCommand.ts +++ b/clients/client-pinpoint/commands/DeleteUserEndpointsCommand.ts @@ -22,6 +22,20 @@ export interface DeleteUserEndpointsCommandOutput extends DeleteUserEndpointsRes /** *

Deletes all the endpoints that are associated with a specific user ID.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { PinpointClient, DeleteUserEndpointsCommand } from "@aws-sdk/client-pinpoint"; // ES Modules import + * // const { PinpointClient, DeleteUserEndpointsCommand } = require("@aws-sdk/client-pinpoint"); // CommonJS import + * const client = new PinpointClient(config); + * const command = new DeleteUserEndpointsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteUserEndpointsCommandInput} for command's `input` shape. + * @see {@link DeleteUserEndpointsCommandOutput} for command's `response` shape. + * @see {@link PinpointClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteUserEndpointsCommand extends $Command< DeleteUserEndpointsCommandInput, diff --git a/clients/client-pinpoint/commands/DeleteVoiceChannelCommand.ts b/clients/client-pinpoint/commands/DeleteVoiceChannelCommand.ts index e84b445b9aa2..7a8022badef8 100644 --- a/clients/client-pinpoint/commands/DeleteVoiceChannelCommand.ts +++ b/clients/client-pinpoint/commands/DeleteVoiceChannelCommand.ts @@ -22,6 +22,20 @@ export interface DeleteVoiceChannelCommandOutput extends DeleteVoiceChannelRespo /** *

Disables the voice channel for an application and deletes any existing settings for the channel.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { PinpointClient, DeleteVoiceChannelCommand } from "@aws-sdk/client-pinpoint"; // ES Modules import + * // const { PinpointClient, DeleteVoiceChannelCommand } = require("@aws-sdk/client-pinpoint"); // CommonJS import + * const client = new PinpointClient(config); + * const command = new DeleteVoiceChannelCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteVoiceChannelCommandInput} for command's `input` shape. + * @see {@link DeleteVoiceChannelCommandOutput} for command's `response` shape. + * @see {@link PinpointClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteVoiceChannelCommand extends $Command< DeleteVoiceChannelCommandInput, diff --git a/clients/client-pinpoint/commands/DeleteVoiceTemplateCommand.ts b/clients/client-pinpoint/commands/DeleteVoiceTemplateCommand.ts index 2068bb9fc1b4..90c71f389a23 100644 --- a/clients/client-pinpoint/commands/DeleteVoiceTemplateCommand.ts +++ b/clients/client-pinpoint/commands/DeleteVoiceTemplateCommand.ts @@ -22,6 +22,20 @@ export interface DeleteVoiceTemplateCommandOutput extends DeleteVoiceTemplateRes /** *

Deletes a message template for messages that were sent through the voice channel.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { PinpointClient, DeleteVoiceTemplateCommand } from "@aws-sdk/client-pinpoint"; // ES Modules import + * // const { PinpointClient, DeleteVoiceTemplateCommand } = require("@aws-sdk/client-pinpoint"); // CommonJS import + * const client = new PinpointClient(config); + * const command = new DeleteVoiceTemplateCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteVoiceTemplateCommandInput} for command's `input` shape. + * @see {@link DeleteVoiceTemplateCommandOutput} for command's `response` shape. + * @see {@link PinpointClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteVoiceTemplateCommand extends $Command< DeleteVoiceTemplateCommandInput, diff --git a/clients/client-pinpoint/commands/GetAdmChannelCommand.ts b/clients/client-pinpoint/commands/GetAdmChannelCommand.ts index 4e40e97752c5..bfa2862f21be 100644 --- a/clients/client-pinpoint/commands/GetAdmChannelCommand.ts +++ b/clients/client-pinpoint/commands/GetAdmChannelCommand.ts @@ -22,6 +22,20 @@ export interface GetAdmChannelCommandOutput extends GetAdmChannelResponse, __Met /** *

Retrieves information about the status and settings of the ADM channel for an application.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { PinpointClient, GetAdmChannelCommand } from "@aws-sdk/client-pinpoint"; // ES Modules import + * // const { PinpointClient, GetAdmChannelCommand } = require("@aws-sdk/client-pinpoint"); // CommonJS import + * const client = new PinpointClient(config); + * const command = new GetAdmChannelCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetAdmChannelCommandInput} for command's `input` shape. + * @see {@link GetAdmChannelCommandOutput} for command's `response` shape. + * @see {@link PinpointClientResolvedConfig | config} for command's `input` shape. + * */ export class GetAdmChannelCommand extends $Command< GetAdmChannelCommandInput, diff --git a/clients/client-pinpoint/commands/GetApnsChannelCommand.ts b/clients/client-pinpoint/commands/GetApnsChannelCommand.ts index f252b42ebcee..835dbbb523b8 100644 --- a/clients/client-pinpoint/commands/GetApnsChannelCommand.ts +++ b/clients/client-pinpoint/commands/GetApnsChannelCommand.ts @@ -22,6 +22,20 @@ export interface GetApnsChannelCommandOutput extends GetApnsChannelResponse, __M /** *

Retrieves information about the status and settings of the APNs channel for an application.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { PinpointClient, GetApnsChannelCommand } from "@aws-sdk/client-pinpoint"; // ES Modules import + * // const { PinpointClient, GetApnsChannelCommand } = require("@aws-sdk/client-pinpoint"); // CommonJS import + * const client = new PinpointClient(config); + * const command = new GetApnsChannelCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetApnsChannelCommandInput} for command's `input` shape. + * @see {@link GetApnsChannelCommandOutput} for command's `response` shape. + * @see {@link PinpointClientResolvedConfig | config} for command's `input` shape. + * */ export class GetApnsChannelCommand extends $Command< GetApnsChannelCommandInput, diff --git a/clients/client-pinpoint/commands/GetApnsSandboxChannelCommand.ts b/clients/client-pinpoint/commands/GetApnsSandboxChannelCommand.ts index dd4f7d318c2b..bab201571fdb 100644 --- a/clients/client-pinpoint/commands/GetApnsSandboxChannelCommand.ts +++ b/clients/client-pinpoint/commands/GetApnsSandboxChannelCommand.ts @@ -22,6 +22,20 @@ export interface GetApnsSandboxChannelCommandOutput extends GetApnsSandboxChanne /** *

Retrieves information about the status and settings of the APNs sandbox channel for an application.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { PinpointClient, GetApnsSandboxChannelCommand } from "@aws-sdk/client-pinpoint"; // ES Modules import + * // const { PinpointClient, GetApnsSandboxChannelCommand } = require("@aws-sdk/client-pinpoint"); // CommonJS import + * const client = new PinpointClient(config); + * const command = new GetApnsSandboxChannelCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetApnsSandboxChannelCommandInput} for command's `input` shape. + * @see {@link GetApnsSandboxChannelCommandOutput} for command's `response` shape. + * @see {@link PinpointClientResolvedConfig | config} for command's `input` shape. + * */ export class GetApnsSandboxChannelCommand extends $Command< GetApnsSandboxChannelCommandInput, diff --git a/clients/client-pinpoint/commands/GetApnsVoipChannelCommand.ts b/clients/client-pinpoint/commands/GetApnsVoipChannelCommand.ts index 0b1dc10156e6..05909b7b6a00 100644 --- a/clients/client-pinpoint/commands/GetApnsVoipChannelCommand.ts +++ b/clients/client-pinpoint/commands/GetApnsVoipChannelCommand.ts @@ -22,6 +22,20 @@ export interface GetApnsVoipChannelCommandOutput extends GetApnsVoipChannelRespo /** *

Retrieves information about the status and settings of the APNs VoIP channel for an application.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { PinpointClient, GetApnsVoipChannelCommand } from "@aws-sdk/client-pinpoint"; // ES Modules import + * // const { PinpointClient, GetApnsVoipChannelCommand } = require("@aws-sdk/client-pinpoint"); // CommonJS import + * const client = new PinpointClient(config); + * const command = new GetApnsVoipChannelCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetApnsVoipChannelCommandInput} for command's `input` shape. + * @see {@link GetApnsVoipChannelCommandOutput} for command's `response` shape. + * @see {@link PinpointClientResolvedConfig | config} for command's `input` shape. + * */ export class GetApnsVoipChannelCommand extends $Command< GetApnsVoipChannelCommandInput, diff --git a/clients/client-pinpoint/commands/GetApnsVoipSandboxChannelCommand.ts b/clients/client-pinpoint/commands/GetApnsVoipSandboxChannelCommand.ts index ff98082bec12..c388e29fdf14 100644 --- a/clients/client-pinpoint/commands/GetApnsVoipSandboxChannelCommand.ts +++ b/clients/client-pinpoint/commands/GetApnsVoipSandboxChannelCommand.ts @@ -22,6 +22,20 @@ export interface GetApnsVoipSandboxChannelCommandOutput extends GetApnsVoipSandb /** *

Retrieves information about the status and settings of the APNs VoIP sandbox channel for an application.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { PinpointClient, GetApnsVoipSandboxChannelCommand } from "@aws-sdk/client-pinpoint"; // ES Modules import + * // const { PinpointClient, GetApnsVoipSandboxChannelCommand } = require("@aws-sdk/client-pinpoint"); // CommonJS import + * const client = new PinpointClient(config); + * const command = new GetApnsVoipSandboxChannelCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetApnsVoipSandboxChannelCommandInput} for command's `input` shape. + * @see {@link GetApnsVoipSandboxChannelCommandOutput} for command's `response` shape. + * @see {@link PinpointClientResolvedConfig | config} for command's `input` shape. + * */ export class GetApnsVoipSandboxChannelCommand extends $Command< GetApnsVoipSandboxChannelCommandInput, diff --git a/clients/client-pinpoint/commands/GetAppCommand.ts b/clients/client-pinpoint/commands/GetAppCommand.ts index 10a46f06237a..c99459adb2e7 100644 --- a/clients/client-pinpoint/commands/GetAppCommand.ts +++ b/clients/client-pinpoint/commands/GetAppCommand.ts @@ -19,6 +19,20 @@ export interface GetAppCommandOutput extends GetAppResponse, __MetadataBearer {} /** *

Retrieves information about an application.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { PinpointClient, GetAppCommand } from "@aws-sdk/client-pinpoint"; // ES Modules import + * // const { PinpointClient, GetAppCommand } = require("@aws-sdk/client-pinpoint"); // CommonJS import + * const client = new PinpointClient(config); + * const command = new GetAppCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetAppCommandInput} for command's `input` shape. + * @see {@link GetAppCommandOutput} for command's `response` shape. + * @see {@link PinpointClientResolvedConfig | config} for command's `input` shape. + * */ export class GetAppCommand extends $Command { // Start section: command_properties diff --git a/clients/client-pinpoint/commands/GetApplicationDateRangeKpiCommand.ts b/clients/client-pinpoint/commands/GetApplicationDateRangeKpiCommand.ts index a3b1d7007859..b79cd8d69773 100644 --- a/clients/client-pinpoint/commands/GetApplicationDateRangeKpiCommand.ts +++ b/clients/client-pinpoint/commands/GetApplicationDateRangeKpiCommand.ts @@ -22,6 +22,20 @@ export interface GetApplicationDateRangeKpiCommandOutput extends GetApplicationD /** *

Retrieves (queries) pre-aggregated data for a standard metric that applies to an application.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { PinpointClient, GetApplicationDateRangeKpiCommand } from "@aws-sdk/client-pinpoint"; // ES Modules import + * // const { PinpointClient, GetApplicationDateRangeKpiCommand } = require("@aws-sdk/client-pinpoint"); // CommonJS import + * const client = new PinpointClient(config); + * const command = new GetApplicationDateRangeKpiCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetApplicationDateRangeKpiCommandInput} for command's `input` shape. + * @see {@link GetApplicationDateRangeKpiCommandOutput} for command's `response` shape. + * @see {@link PinpointClientResolvedConfig | config} for command's `input` shape. + * */ export class GetApplicationDateRangeKpiCommand extends $Command< GetApplicationDateRangeKpiCommandInput, diff --git a/clients/client-pinpoint/commands/GetApplicationSettingsCommand.ts b/clients/client-pinpoint/commands/GetApplicationSettingsCommand.ts index 13b7c1676e59..dbae0c16e4de 100644 --- a/clients/client-pinpoint/commands/GetApplicationSettingsCommand.ts +++ b/clients/client-pinpoint/commands/GetApplicationSettingsCommand.ts @@ -22,6 +22,20 @@ export interface GetApplicationSettingsCommandOutput extends GetApplicationSetti /** *

Retrieves information about the settings for an application.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { PinpointClient, GetApplicationSettingsCommand } from "@aws-sdk/client-pinpoint"; // ES Modules import + * // const { PinpointClient, GetApplicationSettingsCommand } = require("@aws-sdk/client-pinpoint"); // CommonJS import + * const client = new PinpointClient(config); + * const command = new GetApplicationSettingsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetApplicationSettingsCommandInput} for command's `input` shape. + * @see {@link GetApplicationSettingsCommandOutput} for command's `response` shape. + * @see {@link PinpointClientResolvedConfig | config} for command's `input` shape. + * */ export class GetApplicationSettingsCommand extends $Command< GetApplicationSettingsCommandInput, diff --git a/clients/client-pinpoint/commands/GetAppsCommand.ts b/clients/client-pinpoint/commands/GetAppsCommand.ts index 6ae38c26f970..2dbd82caf181 100644 --- a/clients/client-pinpoint/commands/GetAppsCommand.ts +++ b/clients/client-pinpoint/commands/GetAppsCommand.ts @@ -22,6 +22,20 @@ export interface GetAppsCommandOutput extends GetAppsResponse, __MetadataBearer /** *

Retrieves information about all the applications that are associated with your Amazon Pinpoint account.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { PinpointClient, GetAppsCommand } from "@aws-sdk/client-pinpoint"; // ES Modules import + * // const { PinpointClient, GetAppsCommand } = require("@aws-sdk/client-pinpoint"); // CommonJS import + * const client = new PinpointClient(config); + * const command = new GetAppsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetAppsCommandInput} for command's `input` shape. + * @see {@link GetAppsCommandOutput} for command's `response` shape. + * @see {@link PinpointClientResolvedConfig | config} for command's `input` shape. + * */ export class GetAppsCommand extends $Command { // Start section: command_properties diff --git a/clients/client-pinpoint/commands/GetBaiduChannelCommand.ts b/clients/client-pinpoint/commands/GetBaiduChannelCommand.ts index 23850a714736..599965310b37 100644 --- a/clients/client-pinpoint/commands/GetBaiduChannelCommand.ts +++ b/clients/client-pinpoint/commands/GetBaiduChannelCommand.ts @@ -22,6 +22,20 @@ export interface GetBaiduChannelCommandOutput extends GetBaiduChannelResponse, _ /** *

Retrieves information about the status and settings of the Baidu channel for an application.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { PinpointClient, GetBaiduChannelCommand } from "@aws-sdk/client-pinpoint"; // ES Modules import + * // const { PinpointClient, GetBaiduChannelCommand } = require("@aws-sdk/client-pinpoint"); // CommonJS import + * const client = new PinpointClient(config); + * const command = new GetBaiduChannelCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetBaiduChannelCommandInput} for command's `input` shape. + * @see {@link GetBaiduChannelCommandOutput} for command's `response` shape. + * @see {@link PinpointClientResolvedConfig | config} for command's `input` shape. + * */ export class GetBaiduChannelCommand extends $Command< GetBaiduChannelCommandInput, diff --git a/clients/client-pinpoint/commands/GetCampaignActivitiesCommand.ts b/clients/client-pinpoint/commands/GetCampaignActivitiesCommand.ts index f8b2356e624d..e93304247fbf 100644 --- a/clients/client-pinpoint/commands/GetCampaignActivitiesCommand.ts +++ b/clients/client-pinpoint/commands/GetCampaignActivitiesCommand.ts @@ -22,6 +22,20 @@ export interface GetCampaignActivitiesCommandOutput extends GetCampaignActivitie /** *

Retrieves information about all the activities for a campaign.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { PinpointClient, GetCampaignActivitiesCommand } from "@aws-sdk/client-pinpoint"; // ES Modules import + * // const { PinpointClient, GetCampaignActivitiesCommand } = require("@aws-sdk/client-pinpoint"); // CommonJS import + * const client = new PinpointClient(config); + * const command = new GetCampaignActivitiesCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetCampaignActivitiesCommandInput} for command's `input` shape. + * @see {@link GetCampaignActivitiesCommandOutput} for command's `response` shape. + * @see {@link PinpointClientResolvedConfig | config} for command's `input` shape. + * */ export class GetCampaignActivitiesCommand extends $Command< GetCampaignActivitiesCommandInput, diff --git a/clients/client-pinpoint/commands/GetCampaignCommand.ts b/clients/client-pinpoint/commands/GetCampaignCommand.ts index 6474c135f767..0c3addec6f03 100644 --- a/clients/client-pinpoint/commands/GetCampaignCommand.ts +++ b/clients/client-pinpoint/commands/GetCampaignCommand.ts @@ -22,6 +22,20 @@ export interface GetCampaignCommandOutput extends GetCampaignResponse, __Metadat /** *

Retrieves information about the status, configuration, and other settings for a campaign.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { PinpointClient, GetCampaignCommand } from "@aws-sdk/client-pinpoint"; // ES Modules import + * // const { PinpointClient, GetCampaignCommand } = require("@aws-sdk/client-pinpoint"); // CommonJS import + * const client = new PinpointClient(config); + * const command = new GetCampaignCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetCampaignCommandInput} for command's `input` shape. + * @see {@link GetCampaignCommandOutput} for command's `response` shape. + * @see {@link PinpointClientResolvedConfig | config} for command's `input` shape. + * */ export class GetCampaignCommand extends $Command< GetCampaignCommandInput, diff --git a/clients/client-pinpoint/commands/GetCampaignDateRangeKpiCommand.ts b/clients/client-pinpoint/commands/GetCampaignDateRangeKpiCommand.ts index 1cef365b42ed..e5c969215da3 100644 --- a/clients/client-pinpoint/commands/GetCampaignDateRangeKpiCommand.ts +++ b/clients/client-pinpoint/commands/GetCampaignDateRangeKpiCommand.ts @@ -22,6 +22,20 @@ export interface GetCampaignDateRangeKpiCommandOutput extends GetCampaignDateRan /** *

Retrieves (queries) pre-aggregated data for a standard metric that applies to a campaign.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { PinpointClient, GetCampaignDateRangeKpiCommand } from "@aws-sdk/client-pinpoint"; // ES Modules import + * // const { PinpointClient, GetCampaignDateRangeKpiCommand } = require("@aws-sdk/client-pinpoint"); // CommonJS import + * const client = new PinpointClient(config); + * const command = new GetCampaignDateRangeKpiCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetCampaignDateRangeKpiCommandInput} for command's `input` shape. + * @see {@link GetCampaignDateRangeKpiCommandOutput} for command's `response` shape. + * @see {@link PinpointClientResolvedConfig | config} for command's `input` shape. + * */ export class GetCampaignDateRangeKpiCommand extends $Command< GetCampaignDateRangeKpiCommandInput, diff --git a/clients/client-pinpoint/commands/GetCampaignVersionCommand.ts b/clients/client-pinpoint/commands/GetCampaignVersionCommand.ts index 0b9eaa9ccddb..46ca346198cb 100644 --- a/clients/client-pinpoint/commands/GetCampaignVersionCommand.ts +++ b/clients/client-pinpoint/commands/GetCampaignVersionCommand.ts @@ -22,6 +22,20 @@ export interface GetCampaignVersionCommandOutput extends GetCampaignVersionRespo /** *

Retrieves information about the status, configuration, and other settings for a specific version of a campaign.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { PinpointClient, GetCampaignVersionCommand } from "@aws-sdk/client-pinpoint"; // ES Modules import + * // const { PinpointClient, GetCampaignVersionCommand } = require("@aws-sdk/client-pinpoint"); // CommonJS import + * const client = new PinpointClient(config); + * const command = new GetCampaignVersionCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetCampaignVersionCommandInput} for command's `input` shape. + * @see {@link GetCampaignVersionCommandOutput} for command's `response` shape. + * @see {@link PinpointClientResolvedConfig | config} for command's `input` shape. + * */ export class GetCampaignVersionCommand extends $Command< GetCampaignVersionCommandInput, diff --git a/clients/client-pinpoint/commands/GetCampaignVersionsCommand.ts b/clients/client-pinpoint/commands/GetCampaignVersionsCommand.ts index bec5dd452117..f3bd00192a46 100644 --- a/clients/client-pinpoint/commands/GetCampaignVersionsCommand.ts +++ b/clients/client-pinpoint/commands/GetCampaignVersionsCommand.ts @@ -22,6 +22,20 @@ export interface GetCampaignVersionsCommandOutput extends GetCampaignVersionsRes /** *

Retrieves information about the status, configuration, and other settings for all versions of a campaign.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { PinpointClient, GetCampaignVersionsCommand } from "@aws-sdk/client-pinpoint"; // ES Modules import + * // const { PinpointClient, GetCampaignVersionsCommand } = require("@aws-sdk/client-pinpoint"); // CommonJS import + * const client = new PinpointClient(config); + * const command = new GetCampaignVersionsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetCampaignVersionsCommandInput} for command's `input` shape. + * @see {@link GetCampaignVersionsCommandOutput} for command's `response` shape. + * @see {@link PinpointClientResolvedConfig | config} for command's `input` shape. + * */ export class GetCampaignVersionsCommand extends $Command< GetCampaignVersionsCommandInput, diff --git a/clients/client-pinpoint/commands/GetCampaignsCommand.ts b/clients/client-pinpoint/commands/GetCampaignsCommand.ts index e0f3941ab660..797f1035ddf5 100644 --- a/clients/client-pinpoint/commands/GetCampaignsCommand.ts +++ b/clients/client-pinpoint/commands/GetCampaignsCommand.ts @@ -22,6 +22,20 @@ export interface GetCampaignsCommandOutput extends GetCampaignsResponse, __Metad /** *

Retrieves information about the status, configuration, and other settings for all the campaigns that are associated with an application.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { PinpointClient, GetCampaignsCommand } from "@aws-sdk/client-pinpoint"; // ES Modules import + * // const { PinpointClient, GetCampaignsCommand } = require("@aws-sdk/client-pinpoint"); // CommonJS import + * const client = new PinpointClient(config); + * const command = new GetCampaignsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetCampaignsCommandInput} for command's `input` shape. + * @see {@link GetCampaignsCommandOutput} for command's `response` shape. + * @see {@link PinpointClientResolvedConfig | config} for command's `input` shape. + * */ export class GetCampaignsCommand extends $Command< GetCampaignsCommandInput, diff --git a/clients/client-pinpoint/commands/GetChannelsCommand.ts b/clients/client-pinpoint/commands/GetChannelsCommand.ts index eec37b203ddd..c261f1c6e3dd 100644 --- a/clients/client-pinpoint/commands/GetChannelsCommand.ts +++ b/clients/client-pinpoint/commands/GetChannelsCommand.ts @@ -22,6 +22,20 @@ export interface GetChannelsCommandOutput extends GetChannelsResponse, __Metadat /** *

Retrieves information about the history and status of each channel for an application.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { PinpointClient, GetChannelsCommand } from "@aws-sdk/client-pinpoint"; // ES Modules import + * // const { PinpointClient, GetChannelsCommand } = require("@aws-sdk/client-pinpoint"); // CommonJS import + * const client = new PinpointClient(config); + * const command = new GetChannelsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetChannelsCommandInput} for command's `input` shape. + * @see {@link GetChannelsCommandOutput} for command's `response` shape. + * @see {@link PinpointClientResolvedConfig | config} for command's `input` shape. + * */ export class GetChannelsCommand extends $Command< GetChannelsCommandInput, diff --git a/clients/client-pinpoint/commands/GetEmailChannelCommand.ts b/clients/client-pinpoint/commands/GetEmailChannelCommand.ts index 1fcbf88e4356..3e1443c92253 100644 --- a/clients/client-pinpoint/commands/GetEmailChannelCommand.ts +++ b/clients/client-pinpoint/commands/GetEmailChannelCommand.ts @@ -22,6 +22,20 @@ export interface GetEmailChannelCommandOutput extends GetEmailChannelResponse, _ /** *

Retrieves information about the status and settings of the email channel for an application.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { PinpointClient, GetEmailChannelCommand } from "@aws-sdk/client-pinpoint"; // ES Modules import + * // const { PinpointClient, GetEmailChannelCommand } = require("@aws-sdk/client-pinpoint"); // CommonJS import + * const client = new PinpointClient(config); + * const command = new GetEmailChannelCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetEmailChannelCommandInput} for command's `input` shape. + * @see {@link GetEmailChannelCommandOutput} for command's `response` shape. + * @see {@link PinpointClientResolvedConfig | config} for command's `input` shape. + * */ export class GetEmailChannelCommand extends $Command< GetEmailChannelCommandInput, diff --git a/clients/client-pinpoint/commands/GetEmailTemplateCommand.ts b/clients/client-pinpoint/commands/GetEmailTemplateCommand.ts index 27727e9b16ed..eeadc279ba8c 100644 --- a/clients/client-pinpoint/commands/GetEmailTemplateCommand.ts +++ b/clients/client-pinpoint/commands/GetEmailTemplateCommand.ts @@ -22,6 +22,20 @@ export interface GetEmailTemplateCommandOutput extends GetEmailTemplateResponse, /** *

Retrieves the content and settings of a message template for messages that are sent through the email channel.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { PinpointClient, GetEmailTemplateCommand } from "@aws-sdk/client-pinpoint"; // ES Modules import + * // const { PinpointClient, GetEmailTemplateCommand } = require("@aws-sdk/client-pinpoint"); // CommonJS import + * const client = new PinpointClient(config); + * const command = new GetEmailTemplateCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetEmailTemplateCommandInput} for command's `input` shape. + * @see {@link GetEmailTemplateCommandOutput} for command's `response` shape. + * @see {@link PinpointClientResolvedConfig | config} for command's `input` shape. + * */ export class GetEmailTemplateCommand extends $Command< GetEmailTemplateCommandInput, diff --git a/clients/client-pinpoint/commands/GetEndpointCommand.ts b/clients/client-pinpoint/commands/GetEndpointCommand.ts index 47c5765c9ca6..fc7b23458ad6 100644 --- a/clients/client-pinpoint/commands/GetEndpointCommand.ts +++ b/clients/client-pinpoint/commands/GetEndpointCommand.ts @@ -22,6 +22,20 @@ export interface GetEndpointCommandOutput extends GetEndpointResponse, __Metadat /** *

Retrieves information about the settings and attributes of a specific endpoint for an application.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { PinpointClient, GetEndpointCommand } from "@aws-sdk/client-pinpoint"; // ES Modules import + * // const { PinpointClient, GetEndpointCommand } = require("@aws-sdk/client-pinpoint"); // CommonJS import + * const client = new PinpointClient(config); + * const command = new GetEndpointCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetEndpointCommandInput} for command's `input` shape. + * @see {@link GetEndpointCommandOutput} for command's `response` shape. + * @see {@link PinpointClientResolvedConfig | config} for command's `input` shape. + * */ export class GetEndpointCommand extends $Command< GetEndpointCommandInput, diff --git a/clients/client-pinpoint/commands/GetEventStreamCommand.ts b/clients/client-pinpoint/commands/GetEventStreamCommand.ts index a0143bb39bcb..cee3d779fbce 100644 --- a/clients/client-pinpoint/commands/GetEventStreamCommand.ts +++ b/clients/client-pinpoint/commands/GetEventStreamCommand.ts @@ -22,6 +22,20 @@ export interface GetEventStreamCommandOutput extends GetEventStreamResponse, __M /** *

Retrieves information about the event stream settings for an application.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { PinpointClient, GetEventStreamCommand } from "@aws-sdk/client-pinpoint"; // ES Modules import + * // const { PinpointClient, GetEventStreamCommand } = require("@aws-sdk/client-pinpoint"); // CommonJS import + * const client = new PinpointClient(config); + * const command = new GetEventStreamCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetEventStreamCommandInput} for command's `input` shape. + * @see {@link GetEventStreamCommandOutput} for command's `response` shape. + * @see {@link PinpointClientResolvedConfig | config} for command's `input` shape. + * */ export class GetEventStreamCommand extends $Command< GetEventStreamCommandInput, diff --git a/clients/client-pinpoint/commands/GetExportJobCommand.ts b/clients/client-pinpoint/commands/GetExportJobCommand.ts index 8d8a16b2dc96..312be0f9dcf0 100644 --- a/clients/client-pinpoint/commands/GetExportJobCommand.ts +++ b/clients/client-pinpoint/commands/GetExportJobCommand.ts @@ -22,6 +22,20 @@ export interface GetExportJobCommandOutput extends GetExportJobResponse, __Metad /** *

Retrieves information about the status and settings of a specific export job for an application.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { PinpointClient, GetExportJobCommand } from "@aws-sdk/client-pinpoint"; // ES Modules import + * // const { PinpointClient, GetExportJobCommand } = require("@aws-sdk/client-pinpoint"); // CommonJS import + * const client = new PinpointClient(config); + * const command = new GetExportJobCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetExportJobCommandInput} for command's `input` shape. + * @see {@link GetExportJobCommandOutput} for command's `response` shape. + * @see {@link PinpointClientResolvedConfig | config} for command's `input` shape. + * */ export class GetExportJobCommand extends $Command< GetExportJobCommandInput, diff --git a/clients/client-pinpoint/commands/GetExportJobsCommand.ts b/clients/client-pinpoint/commands/GetExportJobsCommand.ts index 4fc983dc0d7d..d3271f7c96d1 100644 --- a/clients/client-pinpoint/commands/GetExportJobsCommand.ts +++ b/clients/client-pinpoint/commands/GetExportJobsCommand.ts @@ -22,6 +22,20 @@ export interface GetExportJobsCommandOutput extends GetExportJobsResponse, __Met /** *

Retrieves information about the status and settings of all the export jobs for an application.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { PinpointClient, GetExportJobsCommand } from "@aws-sdk/client-pinpoint"; // ES Modules import + * // const { PinpointClient, GetExportJobsCommand } = require("@aws-sdk/client-pinpoint"); // CommonJS import + * const client = new PinpointClient(config); + * const command = new GetExportJobsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetExportJobsCommandInput} for command's `input` shape. + * @see {@link GetExportJobsCommandOutput} for command's `response` shape. + * @see {@link PinpointClientResolvedConfig | config} for command's `input` shape. + * */ export class GetExportJobsCommand extends $Command< GetExportJobsCommandInput, diff --git a/clients/client-pinpoint/commands/GetGcmChannelCommand.ts b/clients/client-pinpoint/commands/GetGcmChannelCommand.ts index 3ea811514730..93736f422c27 100644 --- a/clients/client-pinpoint/commands/GetGcmChannelCommand.ts +++ b/clients/client-pinpoint/commands/GetGcmChannelCommand.ts @@ -22,6 +22,20 @@ export interface GetGcmChannelCommandOutput extends GetGcmChannelResponse, __Met /** *

Retrieves information about the status and settings of the GCM channel for an application.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { PinpointClient, GetGcmChannelCommand } from "@aws-sdk/client-pinpoint"; // ES Modules import + * // const { PinpointClient, GetGcmChannelCommand } = require("@aws-sdk/client-pinpoint"); // CommonJS import + * const client = new PinpointClient(config); + * const command = new GetGcmChannelCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetGcmChannelCommandInput} for command's `input` shape. + * @see {@link GetGcmChannelCommandOutput} for command's `response` shape. + * @see {@link PinpointClientResolvedConfig | config} for command's `input` shape. + * */ export class GetGcmChannelCommand extends $Command< GetGcmChannelCommandInput, diff --git a/clients/client-pinpoint/commands/GetImportJobCommand.ts b/clients/client-pinpoint/commands/GetImportJobCommand.ts index 9a3e9f8ea942..6178d234345b 100644 --- a/clients/client-pinpoint/commands/GetImportJobCommand.ts +++ b/clients/client-pinpoint/commands/GetImportJobCommand.ts @@ -22,6 +22,20 @@ export interface GetImportJobCommandOutput extends GetImportJobResponse, __Metad /** *

Retrieves information about the status and settings of a specific import job for an application.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { PinpointClient, GetImportJobCommand } from "@aws-sdk/client-pinpoint"; // ES Modules import + * // const { PinpointClient, GetImportJobCommand } = require("@aws-sdk/client-pinpoint"); // CommonJS import + * const client = new PinpointClient(config); + * const command = new GetImportJobCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetImportJobCommandInput} for command's `input` shape. + * @see {@link GetImportJobCommandOutput} for command's `response` shape. + * @see {@link PinpointClientResolvedConfig | config} for command's `input` shape. + * */ export class GetImportJobCommand extends $Command< GetImportJobCommandInput, diff --git a/clients/client-pinpoint/commands/GetImportJobsCommand.ts b/clients/client-pinpoint/commands/GetImportJobsCommand.ts index b4c956579b66..acf956f73883 100644 --- a/clients/client-pinpoint/commands/GetImportJobsCommand.ts +++ b/clients/client-pinpoint/commands/GetImportJobsCommand.ts @@ -22,6 +22,20 @@ export interface GetImportJobsCommandOutput extends GetImportJobsResponse, __Met /** *

Retrieves information about the status and settings of all the import jobs for an application.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { PinpointClient, GetImportJobsCommand } from "@aws-sdk/client-pinpoint"; // ES Modules import + * // const { PinpointClient, GetImportJobsCommand } = require("@aws-sdk/client-pinpoint"); // CommonJS import + * const client = new PinpointClient(config); + * const command = new GetImportJobsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetImportJobsCommandInput} for command's `input` shape. + * @see {@link GetImportJobsCommandOutput} for command's `response` shape. + * @see {@link PinpointClientResolvedConfig | config} for command's `input` shape. + * */ export class GetImportJobsCommand extends $Command< GetImportJobsCommandInput, diff --git a/clients/client-pinpoint/commands/GetJourneyCommand.ts b/clients/client-pinpoint/commands/GetJourneyCommand.ts index f08d541d7a0d..ccebef6a3cc8 100644 --- a/clients/client-pinpoint/commands/GetJourneyCommand.ts +++ b/clients/client-pinpoint/commands/GetJourneyCommand.ts @@ -22,6 +22,20 @@ export interface GetJourneyCommandOutput extends GetJourneyResponse, __MetadataB /** *

Retrieves information about the status, configuration, and other settings for a journey.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { PinpointClient, GetJourneyCommand } from "@aws-sdk/client-pinpoint"; // ES Modules import + * // const { PinpointClient, GetJourneyCommand } = require("@aws-sdk/client-pinpoint"); // CommonJS import + * const client = new PinpointClient(config); + * const command = new GetJourneyCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetJourneyCommandInput} for command's `input` shape. + * @see {@link GetJourneyCommandOutput} for command's `response` shape. + * @see {@link PinpointClientResolvedConfig | config} for command's `input` shape. + * */ export class GetJourneyCommand extends $Command< GetJourneyCommandInput, diff --git a/clients/client-pinpoint/commands/GetJourneyDateRangeKpiCommand.ts b/clients/client-pinpoint/commands/GetJourneyDateRangeKpiCommand.ts index d0487ddbb205..ac7c0155d2ec 100644 --- a/clients/client-pinpoint/commands/GetJourneyDateRangeKpiCommand.ts +++ b/clients/client-pinpoint/commands/GetJourneyDateRangeKpiCommand.ts @@ -22,6 +22,20 @@ export interface GetJourneyDateRangeKpiCommandOutput extends GetJourneyDateRange /** *

Retrieves (queries) pre-aggregated data for a standard engagement metric that applies to a journey.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { PinpointClient, GetJourneyDateRangeKpiCommand } from "@aws-sdk/client-pinpoint"; // ES Modules import + * // const { PinpointClient, GetJourneyDateRangeKpiCommand } = require("@aws-sdk/client-pinpoint"); // CommonJS import + * const client = new PinpointClient(config); + * const command = new GetJourneyDateRangeKpiCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetJourneyDateRangeKpiCommandInput} for command's `input` shape. + * @see {@link GetJourneyDateRangeKpiCommandOutput} for command's `response` shape. + * @see {@link PinpointClientResolvedConfig | config} for command's `input` shape. + * */ export class GetJourneyDateRangeKpiCommand extends $Command< GetJourneyDateRangeKpiCommandInput, diff --git a/clients/client-pinpoint/commands/GetJourneyExecutionActivityMetricsCommand.ts b/clients/client-pinpoint/commands/GetJourneyExecutionActivityMetricsCommand.ts index dd81f718c48d..6453b31c15a9 100644 --- a/clients/client-pinpoint/commands/GetJourneyExecutionActivityMetricsCommand.ts +++ b/clients/client-pinpoint/commands/GetJourneyExecutionActivityMetricsCommand.ts @@ -27,6 +27,20 @@ export interface GetJourneyExecutionActivityMetricsCommandOutput /** *

Retrieves (queries) pre-aggregated data for a standard execution metric that applies to a journey activity.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { PinpointClient, GetJourneyExecutionActivityMetricsCommand } from "@aws-sdk/client-pinpoint"; // ES Modules import + * // const { PinpointClient, GetJourneyExecutionActivityMetricsCommand } = require("@aws-sdk/client-pinpoint"); // CommonJS import + * const client = new PinpointClient(config); + * const command = new GetJourneyExecutionActivityMetricsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetJourneyExecutionActivityMetricsCommandInput} for command's `input` shape. + * @see {@link GetJourneyExecutionActivityMetricsCommandOutput} for command's `response` shape. + * @see {@link PinpointClientResolvedConfig | config} for command's `input` shape. + * */ export class GetJourneyExecutionActivityMetricsCommand extends $Command< GetJourneyExecutionActivityMetricsCommandInput, diff --git a/clients/client-pinpoint/commands/GetJourneyExecutionMetricsCommand.ts b/clients/client-pinpoint/commands/GetJourneyExecutionMetricsCommand.ts index 398b48e2a682..d1c78f63e6cc 100644 --- a/clients/client-pinpoint/commands/GetJourneyExecutionMetricsCommand.ts +++ b/clients/client-pinpoint/commands/GetJourneyExecutionMetricsCommand.ts @@ -22,6 +22,20 @@ export interface GetJourneyExecutionMetricsCommandOutput extends GetJourneyExecu /** *

Retrieves (queries) pre-aggregated data for a standard execution metric that applies to a journey.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { PinpointClient, GetJourneyExecutionMetricsCommand } from "@aws-sdk/client-pinpoint"; // ES Modules import + * // const { PinpointClient, GetJourneyExecutionMetricsCommand } = require("@aws-sdk/client-pinpoint"); // CommonJS import + * const client = new PinpointClient(config); + * const command = new GetJourneyExecutionMetricsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetJourneyExecutionMetricsCommandInput} for command's `input` shape. + * @see {@link GetJourneyExecutionMetricsCommandOutput} for command's `response` shape. + * @see {@link PinpointClientResolvedConfig | config} for command's `input` shape. + * */ export class GetJourneyExecutionMetricsCommand extends $Command< GetJourneyExecutionMetricsCommandInput, diff --git a/clients/client-pinpoint/commands/GetPushTemplateCommand.ts b/clients/client-pinpoint/commands/GetPushTemplateCommand.ts index df640a6ffbe1..75dbfcc93fec 100644 --- a/clients/client-pinpoint/commands/GetPushTemplateCommand.ts +++ b/clients/client-pinpoint/commands/GetPushTemplateCommand.ts @@ -22,6 +22,20 @@ export interface GetPushTemplateCommandOutput extends GetPushTemplateResponse, _ /** *

Retrieves the content and settings of a message template for messages that are sent through a push notification channel.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { PinpointClient, GetPushTemplateCommand } from "@aws-sdk/client-pinpoint"; // ES Modules import + * // const { PinpointClient, GetPushTemplateCommand } = require("@aws-sdk/client-pinpoint"); // CommonJS import + * const client = new PinpointClient(config); + * const command = new GetPushTemplateCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetPushTemplateCommandInput} for command's `input` shape. + * @see {@link GetPushTemplateCommandOutput} for command's `response` shape. + * @see {@link PinpointClientResolvedConfig | config} for command's `input` shape. + * */ export class GetPushTemplateCommand extends $Command< GetPushTemplateCommandInput, diff --git a/clients/client-pinpoint/commands/GetRecommenderConfigurationCommand.ts b/clients/client-pinpoint/commands/GetRecommenderConfigurationCommand.ts index accf22ae9dae..06658fda4bd3 100644 --- a/clients/client-pinpoint/commands/GetRecommenderConfigurationCommand.ts +++ b/clients/client-pinpoint/commands/GetRecommenderConfigurationCommand.ts @@ -24,6 +24,20 @@ export interface GetRecommenderConfigurationCommandOutput /** *

Retrieves information about an Amazon Pinpoint configuration for a recommender model.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { PinpointClient, GetRecommenderConfigurationCommand } from "@aws-sdk/client-pinpoint"; // ES Modules import + * // const { PinpointClient, GetRecommenderConfigurationCommand } = require("@aws-sdk/client-pinpoint"); // CommonJS import + * const client = new PinpointClient(config); + * const command = new GetRecommenderConfigurationCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetRecommenderConfigurationCommandInput} for command's `input` shape. + * @see {@link GetRecommenderConfigurationCommandOutput} for command's `response` shape. + * @see {@link PinpointClientResolvedConfig | config} for command's `input` shape. + * */ export class GetRecommenderConfigurationCommand extends $Command< GetRecommenderConfigurationCommandInput, diff --git a/clients/client-pinpoint/commands/GetRecommenderConfigurationsCommand.ts b/clients/client-pinpoint/commands/GetRecommenderConfigurationsCommand.ts index e45ca7c1fc08..2b6d9564553a 100644 --- a/clients/client-pinpoint/commands/GetRecommenderConfigurationsCommand.ts +++ b/clients/client-pinpoint/commands/GetRecommenderConfigurationsCommand.ts @@ -24,6 +24,20 @@ export interface GetRecommenderConfigurationsCommandOutput /** *

Retrieves information about all the recommender model configurations that are associated with your Amazon Pinpoint account.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { PinpointClient, GetRecommenderConfigurationsCommand } from "@aws-sdk/client-pinpoint"; // ES Modules import + * // const { PinpointClient, GetRecommenderConfigurationsCommand } = require("@aws-sdk/client-pinpoint"); // CommonJS import + * const client = new PinpointClient(config); + * const command = new GetRecommenderConfigurationsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetRecommenderConfigurationsCommandInput} for command's `input` shape. + * @see {@link GetRecommenderConfigurationsCommandOutput} for command's `response` shape. + * @see {@link PinpointClientResolvedConfig | config} for command's `input` shape. + * */ export class GetRecommenderConfigurationsCommand extends $Command< GetRecommenderConfigurationsCommandInput, diff --git a/clients/client-pinpoint/commands/GetSegmentCommand.ts b/clients/client-pinpoint/commands/GetSegmentCommand.ts index 194f409fcf4d..f3b2df91e583 100644 --- a/clients/client-pinpoint/commands/GetSegmentCommand.ts +++ b/clients/client-pinpoint/commands/GetSegmentCommand.ts @@ -22,6 +22,20 @@ export interface GetSegmentCommandOutput extends GetSegmentResponse, __MetadataB /** *

Retrieves information about the configuration, dimension, and other settings for a specific segment that's associated with an application.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { PinpointClient, GetSegmentCommand } from "@aws-sdk/client-pinpoint"; // ES Modules import + * // const { PinpointClient, GetSegmentCommand } = require("@aws-sdk/client-pinpoint"); // CommonJS import + * const client = new PinpointClient(config); + * const command = new GetSegmentCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetSegmentCommandInput} for command's `input` shape. + * @see {@link GetSegmentCommandOutput} for command's `response` shape. + * @see {@link PinpointClientResolvedConfig | config} for command's `input` shape. + * */ export class GetSegmentCommand extends $Command< GetSegmentCommandInput, diff --git a/clients/client-pinpoint/commands/GetSegmentExportJobsCommand.ts b/clients/client-pinpoint/commands/GetSegmentExportJobsCommand.ts index f74aa92c6cdb..fd1fda684827 100644 --- a/clients/client-pinpoint/commands/GetSegmentExportJobsCommand.ts +++ b/clients/client-pinpoint/commands/GetSegmentExportJobsCommand.ts @@ -22,6 +22,20 @@ export interface GetSegmentExportJobsCommandOutput extends GetSegmentExportJobsR /** *

Retrieves information about the status and settings of the export jobs for a segment.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { PinpointClient, GetSegmentExportJobsCommand } from "@aws-sdk/client-pinpoint"; // ES Modules import + * // const { PinpointClient, GetSegmentExportJobsCommand } = require("@aws-sdk/client-pinpoint"); // CommonJS import + * const client = new PinpointClient(config); + * const command = new GetSegmentExportJobsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetSegmentExportJobsCommandInput} for command's `input` shape. + * @see {@link GetSegmentExportJobsCommandOutput} for command's `response` shape. + * @see {@link PinpointClientResolvedConfig | config} for command's `input` shape. + * */ export class GetSegmentExportJobsCommand extends $Command< GetSegmentExportJobsCommandInput, diff --git a/clients/client-pinpoint/commands/GetSegmentImportJobsCommand.ts b/clients/client-pinpoint/commands/GetSegmentImportJobsCommand.ts index 9c64a4d739b0..dd3940c27490 100644 --- a/clients/client-pinpoint/commands/GetSegmentImportJobsCommand.ts +++ b/clients/client-pinpoint/commands/GetSegmentImportJobsCommand.ts @@ -22,6 +22,20 @@ export interface GetSegmentImportJobsCommandOutput extends GetSegmentImportJobsR /** *

Retrieves information about the status and settings of the import jobs for a segment.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { PinpointClient, GetSegmentImportJobsCommand } from "@aws-sdk/client-pinpoint"; // ES Modules import + * // const { PinpointClient, GetSegmentImportJobsCommand } = require("@aws-sdk/client-pinpoint"); // CommonJS import + * const client = new PinpointClient(config); + * const command = new GetSegmentImportJobsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetSegmentImportJobsCommandInput} for command's `input` shape. + * @see {@link GetSegmentImportJobsCommandOutput} for command's `response` shape. + * @see {@link PinpointClientResolvedConfig | config} for command's `input` shape. + * */ export class GetSegmentImportJobsCommand extends $Command< GetSegmentImportJobsCommandInput, diff --git a/clients/client-pinpoint/commands/GetSegmentVersionCommand.ts b/clients/client-pinpoint/commands/GetSegmentVersionCommand.ts index 5cbac8e8d7a7..d9f60cddb7e2 100644 --- a/clients/client-pinpoint/commands/GetSegmentVersionCommand.ts +++ b/clients/client-pinpoint/commands/GetSegmentVersionCommand.ts @@ -22,6 +22,20 @@ export interface GetSegmentVersionCommandOutput extends GetSegmentVersionRespons /** *

Retrieves information about the configuration, dimension, and other settings for a specific version of a segment that's associated with an application.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { PinpointClient, GetSegmentVersionCommand } from "@aws-sdk/client-pinpoint"; // ES Modules import + * // const { PinpointClient, GetSegmentVersionCommand } = require("@aws-sdk/client-pinpoint"); // CommonJS import + * const client = new PinpointClient(config); + * const command = new GetSegmentVersionCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetSegmentVersionCommandInput} for command's `input` shape. + * @see {@link GetSegmentVersionCommandOutput} for command's `response` shape. + * @see {@link PinpointClientResolvedConfig | config} for command's `input` shape. + * */ export class GetSegmentVersionCommand extends $Command< GetSegmentVersionCommandInput, diff --git a/clients/client-pinpoint/commands/GetSegmentVersionsCommand.ts b/clients/client-pinpoint/commands/GetSegmentVersionsCommand.ts index a8fc9cdf5800..60e28bc10c90 100644 --- a/clients/client-pinpoint/commands/GetSegmentVersionsCommand.ts +++ b/clients/client-pinpoint/commands/GetSegmentVersionsCommand.ts @@ -22,6 +22,20 @@ export interface GetSegmentVersionsCommandOutput extends GetSegmentVersionsRespo /** *

Retrieves information about the configuration, dimension, and other settings for all the versions of a specific segment that's associated with an application.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { PinpointClient, GetSegmentVersionsCommand } from "@aws-sdk/client-pinpoint"; // ES Modules import + * // const { PinpointClient, GetSegmentVersionsCommand } = require("@aws-sdk/client-pinpoint"); // CommonJS import + * const client = new PinpointClient(config); + * const command = new GetSegmentVersionsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetSegmentVersionsCommandInput} for command's `input` shape. + * @see {@link GetSegmentVersionsCommandOutput} for command's `response` shape. + * @see {@link PinpointClientResolvedConfig | config} for command's `input` shape. + * */ export class GetSegmentVersionsCommand extends $Command< GetSegmentVersionsCommandInput, diff --git a/clients/client-pinpoint/commands/GetSegmentsCommand.ts b/clients/client-pinpoint/commands/GetSegmentsCommand.ts index e9a0f6e9bd59..124c0f77d88a 100644 --- a/clients/client-pinpoint/commands/GetSegmentsCommand.ts +++ b/clients/client-pinpoint/commands/GetSegmentsCommand.ts @@ -22,6 +22,20 @@ export interface GetSegmentsCommandOutput extends GetSegmentsResponse, __Metadat /** *

Retrieves information about the configuration, dimension, and other settings for all the segments that are associated with an application.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { PinpointClient, GetSegmentsCommand } from "@aws-sdk/client-pinpoint"; // ES Modules import + * // const { PinpointClient, GetSegmentsCommand } = require("@aws-sdk/client-pinpoint"); // CommonJS import + * const client = new PinpointClient(config); + * const command = new GetSegmentsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetSegmentsCommandInput} for command's `input` shape. + * @see {@link GetSegmentsCommandOutput} for command's `response` shape. + * @see {@link PinpointClientResolvedConfig | config} for command's `input` shape. + * */ export class GetSegmentsCommand extends $Command< GetSegmentsCommandInput, diff --git a/clients/client-pinpoint/commands/GetSmsChannelCommand.ts b/clients/client-pinpoint/commands/GetSmsChannelCommand.ts index caad31e3ce77..11e0d0f5fbed 100644 --- a/clients/client-pinpoint/commands/GetSmsChannelCommand.ts +++ b/clients/client-pinpoint/commands/GetSmsChannelCommand.ts @@ -22,6 +22,20 @@ export interface GetSmsChannelCommandOutput extends GetSmsChannelResponse, __Met /** *

Retrieves information about the status and settings of the SMS channel for an application.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { PinpointClient, GetSmsChannelCommand } from "@aws-sdk/client-pinpoint"; // ES Modules import + * // const { PinpointClient, GetSmsChannelCommand } = require("@aws-sdk/client-pinpoint"); // CommonJS import + * const client = new PinpointClient(config); + * const command = new GetSmsChannelCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetSmsChannelCommandInput} for command's `input` shape. + * @see {@link GetSmsChannelCommandOutput} for command's `response` shape. + * @see {@link PinpointClientResolvedConfig | config} for command's `input` shape. + * */ export class GetSmsChannelCommand extends $Command< GetSmsChannelCommandInput, diff --git a/clients/client-pinpoint/commands/GetSmsTemplateCommand.ts b/clients/client-pinpoint/commands/GetSmsTemplateCommand.ts index eefd96d50320..8c9719366a0c 100644 --- a/clients/client-pinpoint/commands/GetSmsTemplateCommand.ts +++ b/clients/client-pinpoint/commands/GetSmsTemplateCommand.ts @@ -22,6 +22,20 @@ export interface GetSmsTemplateCommandOutput extends GetSmsTemplateResponse, __M /** *

Retrieves the content and settings of a message template for messages that are sent through the SMS channel.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { PinpointClient, GetSmsTemplateCommand } from "@aws-sdk/client-pinpoint"; // ES Modules import + * // const { PinpointClient, GetSmsTemplateCommand } = require("@aws-sdk/client-pinpoint"); // CommonJS import + * const client = new PinpointClient(config); + * const command = new GetSmsTemplateCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetSmsTemplateCommandInput} for command's `input` shape. + * @see {@link GetSmsTemplateCommandOutput} for command's `response` shape. + * @see {@link PinpointClientResolvedConfig | config} for command's `input` shape. + * */ export class GetSmsTemplateCommand extends $Command< GetSmsTemplateCommandInput, diff --git a/clients/client-pinpoint/commands/GetUserEndpointsCommand.ts b/clients/client-pinpoint/commands/GetUserEndpointsCommand.ts index 18a4648c4ef2..af3dcb4101c9 100644 --- a/clients/client-pinpoint/commands/GetUserEndpointsCommand.ts +++ b/clients/client-pinpoint/commands/GetUserEndpointsCommand.ts @@ -22,6 +22,20 @@ export interface GetUserEndpointsCommandOutput extends GetUserEndpointsResponse, /** *

Retrieves information about all the endpoints that are associated with a specific user ID.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { PinpointClient, GetUserEndpointsCommand } from "@aws-sdk/client-pinpoint"; // ES Modules import + * // const { PinpointClient, GetUserEndpointsCommand } = require("@aws-sdk/client-pinpoint"); // CommonJS import + * const client = new PinpointClient(config); + * const command = new GetUserEndpointsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetUserEndpointsCommandInput} for command's `input` shape. + * @see {@link GetUserEndpointsCommandOutput} for command's `response` shape. + * @see {@link PinpointClientResolvedConfig | config} for command's `input` shape. + * */ export class GetUserEndpointsCommand extends $Command< GetUserEndpointsCommandInput, diff --git a/clients/client-pinpoint/commands/GetVoiceChannelCommand.ts b/clients/client-pinpoint/commands/GetVoiceChannelCommand.ts index e57f7cbbe8e5..84e317a7ced9 100644 --- a/clients/client-pinpoint/commands/GetVoiceChannelCommand.ts +++ b/clients/client-pinpoint/commands/GetVoiceChannelCommand.ts @@ -22,6 +22,20 @@ export interface GetVoiceChannelCommandOutput extends GetVoiceChannelResponse, _ /** *

Retrieves information about the status and settings of the voice channel for an application.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { PinpointClient, GetVoiceChannelCommand } from "@aws-sdk/client-pinpoint"; // ES Modules import + * // const { PinpointClient, GetVoiceChannelCommand } = require("@aws-sdk/client-pinpoint"); // CommonJS import + * const client = new PinpointClient(config); + * const command = new GetVoiceChannelCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetVoiceChannelCommandInput} for command's `input` shape. + * @see {@link GetVoiceChannelCommandOutput} for command's `response` shape. + * @see {@link PinpointClientResolvedConfig | config} for command's `input` shape. + * */ export class GetVoiceChannelCommand extends $Command< GetVoiceChannelCommandInput, diff --git a/clients/client-pinpoint/commands/GetVoiceTemplateCommand.ts b/clients/client-pinpoint/commands/GetVoiceTemplateCommand.ts index 78b5a4e7384d..9f9a7c8c4e03 100644 --- a/clients/client-pinpoint/commands/GetVoiceTemplateCommand.ts +++ b/clients/client-pinpoint/commands/GetVoiceTemplateCommand.ts @@ -22,6 +22,20 @@ export interface GetVoiceTemplateCommandOutput extends GetVoiceTemplateResponse, /** *

Retrieves the content and settings of a message template for messages that are sent through the voice channel.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { PinpointClient, GetVoiceTemplateCommand } from "@aws-sdk/client-pinpoint"; // ES Modules import + * // const { PinpointClient, GetVoiceTemplateCommand } = require("@aws-sdk/client-pinpoint"); // CommonJS import + * const client = new PinpointClient(config); + * const command = new GetVoiceTemplateCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetVoiceTemplateCommandInput} for command's `input` shape. + * @see {@link GetVoiceTemplateCommandOutput} for command's `response` shape. + * @see {@link PinpointClientResolvedConfig | config} for command's `input` shape. + * */ export class GetVoiceTemplateCommand extends $Command< GetVoiceTemplateCommandInput, diff --git a/clients/client-pinpoint/commands/ListJourneysCommand.ts b/clients/client-pinpoint/commands/ListJourneysCommand.ts index c2c61407ff0f..038ec847dcc0 100644 --- a/clients/client-pinpoint/commands/ListJourneysCommand.ts +++ b/clients/client-pinpoint/commands/ListJourneysCommand.ts @@ -22,6 +22,20 @@ export interface ListJourneysCommandOutput extends ListJourneysResponse, __Metad /** *

Retrieves information about the status, configuration, and other settings for all the journeys that are associated with an application.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { PinpointClient, ListJourneysCommand } from "@aws-sdk/client-pinpoint"; // ES Modules import + * // const { PinpointClient, ListJourneysCommand } = require("@aws-sdk/client-pinpoint"); // CommonJS import + * const client = new PinpointClient(config); + * const command = new ListJourneysCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListJourneysCommandInput} for command's `input` shape. + * @see {@link ListJourneysCommandOutput} for command's `response` shape. + * @see {@link PinpointClientResolvedConfig | config} for command's `input` shape. + * */ export class ListJourneysCommand extends $Command< ListJourneysCommandInput, diff --git a/clients/client-pinpoint/commands/ListTagsForResourceCommand.ts b/clients/client-pinpoint/commands/ListTagsForResourceCommand.ts index 22888bdc7751..dce56dfda475 100644 --- a/clients/client-pinpoint/commands/ListTagsForResourceCommand.ts +++ b/clients/client-pinpoint/commands/ListTagsForResourceCommand.ts @@ -22,6 +22,20 @@ export interface ListTagsForResourceCommandOutput extends ListTagsForResourceRes /** *

Retrieves all the tags (keys and values) that are associated with an application, campaign, message template, or segment.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { PinpointClient, ListTagsForResourceCommand } from "@aws-sdk/client-pinpoint"; // ES Modules import + * // const { PinpointClient, ListTagsForResourceCommand } = require("@aws-sdk/client-pinpoint"); // CommonJS import + * const client = new PinpointClient(config); + * const command = new ListTagsForResourceCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListTagsForResourceCommandInput} for command's `input` shape. + * @see {@link ListTagsForResourceCommandOutput} for command's `response` shape. + * @see {@link PinpointClientResolvedConfig | config} for command's `input` shape. + * */ export class ListTagsForResourceCommand extends $Command< ListTagsForResourceCommandInput, diff --git a/clients/client-pinpoint/commands/ListTemplateVersionsCommand.ts b/clients/client-pinpoint/commands/ListTemplateVersionsCommand.ts index 39a61bb28182..6e5273a2054c 100644 --- a/clients/client-pinpoint/commands/ListTemplateVersionsCommand.ts +++ b/clients/client-pinpoint/commands/ListTemplateVersionsCommand.ts @@ -22,6 +22,20 @@ export interface ListTemplateVersionsCommandOutput extends ListTemplateVersionsR /** *

Retrieves information about all the versions of a specific message template.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { PinpointClient, ListTemplateVersionsCommand } from "@aws-sdk/client-pinpoint"; // ES Modules import + * // const { PinpointClient, ListTemplateVersionsCommand } = require("@aws-sdk/client-pinpoint"); // CommonJS import + * const client = new PinpointClient(config); + * const command = new ListTemplateVersionsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListTemplateVersionsCommandInput} for command's `input` shape. + * @see {@link ListTemplateVersionsCommandOutput} for command's `response` shape. + * @see {@link PinpointClientResolvedConfig | config} for command's `input` shape. + * */ export class ListTemplateVersionsCommand extends $Command< ListTemplateVersionsCommandInput, diff --git a/clients/client-pinpoint/commands/ListTemplatesCommand.ts b/clients/client-pinpoint/commands/ListTemplatesCommand.ts index facc267d20cf..7fdf13f1f45d 100644 --- a/clients/client-pinpoint/commands/ListTemplatesCommand.ts +++ b/clients/client-pinpoint/commands/ListTemplatesCommand.ts @@ -22,6 +22,20 @@ export interface ListTemplatesCommandOutput extends ListTemplatesResponse, __Met /** *

Retrieves information about all the message templates that are associated with your Amazon Pinpoint account.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { PinpointClient, ListTemplatesCommand } from "@aws-sdk/client-pinpoint"; // ES Modules import + * // const { PinpointClient, ListTemplatesCommand } = require("@aws-sdk/client-pinpoint"); // CommonJS import + * const client = new PinpointClient(config); + * const command = new ListTemplatesCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListTemplatesCommandInput} for command's `input` shape. + * @see {@link ListTemplatesCommandOutput} for command's `response` shape. + * @see {@link PinpointClientResolvedConfig | config} for command's `input` shape. + * */ export class ListTemplatesCommand extends $Command< ListTemplatesCommandInput, diff --git a/clients/client-pinpoint/commands/PhoneNumberValidateCommand.ts b/clients/client-pinpoint/commands/PhoneNumberValidateCommand.ts index 66d62c0d6871..a586b029f418 100644 --- a/clients/client-pinpoint/commands/PhoneNumberValidateCommand.ts +++ b/clients/client-pinpoint/commands/PhoneNumberValidateCommand.ts @@ -22,6 +22,20 @@ export interface PhoneNumberValidateCommandOutput extends PhoneNumberValidateRes /** *

Retrieves information about a phone number.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { PinpointClient, PhoneNumberValidateCommand } from "@aws-sdk/client-pinpoint"; // ES Modules import + * // const { PinpointClient, PhoneNumberValidateCommand } = require("@aws-sdk/client-pinpoint"); // CommonJS import + * const client = new PinpointClient(config); + * const command = new PhoneNumberValidateCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link PhoneNumberValidateCommandInput} for command's `input` shape. + * @see {@link PhoneNumberValidateCommandOutput} for command's `response` shape. + * @see {@link PinpointClientResolvedConfig | config} for command's `input` shape. + * */ export class PhoneNumberValidateCommand extends $Command< PhoneNumberValidateCommandInput, diff --git a/clients/client-pinpoint/commands/PutEventStreamCommand.ts b/clients/client-pinpoint/commands/PutEventStreamCommand.ts index cb98cace77a4..cdf4be6ab1cc 100644 --- a/clients/client-pinpoint/commands/PutEventStreamCommand.ts +++ b/clients/client-pinpoint/commands/PutEventStreamCommand.ts @@ -22,6 +22,20 @@ export interface PutEventStreamCommandOutput extends PutEventStreamResponse, __M /** *

Creates a new event stream for an application or updates the settings of an existing event stream for an application.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { PinpointClient, PutEventStreamCommand } from "@aws-sdk/client-pinpoint"; // ES Modules import + * // const { PinpointClient, PutEventStreamCommand } = require("@aws-sdk/client-pinpoint"); // CommonJS import + * const client = new PinpointClient(config); + * const command = new PutEventStreamCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link PutEventStreamCommandInput} for command's `input` shape. + * @see {@link PutEventStreamCommandOutput} for command's `response` shape. + * @see {@link PinpointClientResolvedConfig | config} for command's `input` shape. + * */ export class PutEventStreamCommand extends $Command< PutEventStreamCommandInput, diff --git a/clients/client-pinpoint/commands/PutEventsCommand.ts b/clients/client-pinpoint/commands/PutEventsCommand.ts index 5ccc4186d3d0..a77eff08ea4d 100644 --- a/clients/client-pinpoint/commands/PutEventsCommand.ts +++ b/clients/client-pinpoint/commands/PutEventsCommand.ts @@ -22,6 +22,20 @@ export interface PutEventsCommandOutput extends PutEventsResponse, __MetadataBea /** *

Creates a new event to record for endpoints, or creates or updates endpoint data that existing events are associated with.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { PinpointClient, PutEventsCommand } from "@aws-sdk/client-pinpoint"; // ES Modules import + * // const { PinpointClient, PutEventsCommand } = require("@aws-sdk/client-pinpoint"); // CommonJS import + * const client = new PinpointClient(config); + * const command = new PutEventsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link PutEventsCommandInput} for command's `input` shape. + * @see {@link PutEventsCommandOutput} for command's `response` shape. + * @see {@link PinpointClientResolvedConfig | config} for command's `input` shape. + * */ export class PutEventsCommand extends $Command< PutEventsCommandInput, diff --git a/clients/client-pinpoint/commands/RemoveAttributesCommand.ts b/clients/client-pinpoint/commands/RemoveAttributesCommand.ts index 5f04fca64306..90990d4d4e43 100644 --- a/clients/client-pinpoint/commands/RemoveAttributesCommand.ts +++ b/clients/client-pinpoint/commands/RemoveAttributesCommand.ts @@ -22,6 +22,20 @@ export interface RemoveAttributesCommandOutput extends RemoveAttributesResponse, /** *

Removes one or more attributes, of the same attribute type, from all the endpoints that are associated with an application.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { PinpointClient, RemoveAttributesCommand } from "@aws-sdk/client-pinpoint"; // ES Modules import + * // const { PinpointClient, RemoveAttributesCommand } = require("@aws-sdk/client-pinpoint"); // CommonJS import + * const client = new PinpointClient(config); + * const command = new RemoveAttributesCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link RemoveAttributesCommandInput} for command's `input` shape. + * @see {@link RemoveAttributesCommandOutput} for command's `response` shape. + * @see {@link PinpointClientResolvedConfig | config} for command's `input` shape. + * */ export class RemoveAttributesCommand extends $Command< RemoveAttributesCommandInput, diff --git a/clients/client-pinpoint/commands/SendMessagesCommand.ts b/clients/client-pinpoint/commands/SendMessagesCommand.ts index 8e0d9de0667a..1097ff8455af 100644 --- a/clients/client-pinpoint/commands/SendMessagesCommand.ts +++ b/clients/client-pinpoint/commands/SendMessagesCommand.ts @@ -22,6 +22,20 @@ export interface SendMessagesCommandOutput extends SendMessagesResponse, __Metad /** *

Creates and sends a direct message.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { PinpointClient, SendMessagesCommand } from "@aws-sdk/client-pinpoint"; // ES Modules import + * // const { PinpointClient, SendMessagesCommand } = require("@aws-sdk/client-pinpoint"); // CommonJS import + * const client = new PinpointClient(config); + * const command = new SendMessagesCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link SendMessagesCommandInput} for command's `input` shape. + * @see {@link SendMessagesCommandOutput} for command's `response` shape. + * @see {@link PinpointClientResolvedConfig | config} for command's `input` shape. + * */ export class SendMessagesCommand extends $Command< SendMessagesCommandInput, diff --git a/clients/client-pinpoint/commands/SendUsersMessagesCommand.ts b/clients/client-pinpoint/commands/SendUsersMessagesCommand.ts index 816aadd953bb..c36ce6ae7a53 100644 --- a/clients/client-pinpoint/commands/SendUsersMessagesCommand.ts +++ b/clients/client-pinpoint/commands/SendUsersMessagesCommand.ts @@ -22,6 +22,20 @@ export interface SendUsersMessagesCommandOutput extends SendUsersMessagesRespons /** *

Creates and sends a message to a list of users.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { PinpointClient, SendUsersMessagesCommand } from "@aws-sdk/client-pinpoint"; // ES Modules import + * // const { PinpointClient, SendUsersMessagesCommand } = require("@aws-sdk/client-pinpoint"); // CommonJS import + * const client = new PinpointClient(config); + * const command = new SendUsersMessagesCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link SendUsersMessagesCommandInput} for command's `input` shape. + * @see {@link SendUsersMessagesCommandOutput} for command's `response` shape. + * @see {@link PinpointClientResolvedConfig | config} for command's `input` shape. + * */ export class SendUsersMessagesCommand extends $Command< SendUsersMessagesCommandInput, diff --git a/clients/client-pinpoint/commands/TagResourceCommand.ts b/clients/client-pinpoint/commands/TagResourceCommand.ts index 127434e3a10a..84b0db93cdf4 100644 --- a/clients/client-pinpoint/commands/TagResourceCommand.ts +++ b/clients/client-pinpoint/commands/TagResourceCommand.ts @@ -22,6 +22,20 @@ export interface TagResourceCommandOutput extends __MetadataBearer {} /** *

Adds one or more tags (keys and values) to an application, campaign, message template, or segment.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { PinpointClient, TagResourceCommand } from "@aws-sdk/client-pinpoint"; // ES Modules import + * // const { PinpointClient, TagResourceCommand } = require("@aws-sdk/client-pinpoint"); // CommonJS import + * const client = new PinpointClient(config); + * const command = new TagResourceCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link TagResourceCommandInput} for command's `input` shape. + * @see {@link TagResourceCommandOutput} for command's `response` shape. + * @see {@link PinpointClientResolvedConfig | config} for command's `input` shape. + * */ export class TagResourceCommand extends $Command< TagResourceCommandInput, diff --git a/clients/client-pinpoint/commands/UntagResourceCommand.ts b/clients/client-pinpoint/commands/UntagResourceCommand.ts index de020ddde26a..796a27619f29 100644 --- a/clients/client-pinpoint/commands/UntagResourceCommand.ts +++ b/clients/client-pinpoint/commands/UntagResourceCommand.ts @@ -22,6 +22,20 @@ export interface UntagResourceCommandOutput extends __MetadataBearer {} /** *

Removes one or more tags (keys and values) from an application, campaign, message template, or segment.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { PinpointClient, UntagResourceCommand } from "@aws-sdk/client-pinpoint"; // ES Modules import + * // const { PinpointClient, UntagResourceCommand } = require("@aws-sdk/client-pinpoint"); // CommonJS import + * const client = new PinpointClient(config); + * const command = new UntagResourceCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link UntagResourceCommandInput} for command's `input` shape. + * @see {@link UntagResourceCommandOutput} for command's `response` shape. + * @see {@link PinpointClientResolvedConfig | config} for command's `input` shape. + * */ export class UntagResourceCommand extends $Command< UntagResourceCommandInput, diff --git a/clients/client-pinpoint/commands/UpdateAdmChannelCommand.ts b/clients/client-pinpoint/commands/UpdateAdmChannelCommand.ts index 14bd03d67458..4ed6d6ddf912 100644 --- a/clients/client-pinpoint/commands/UpdateAdmChannelCommand.ts +++ b/clients/client-pinpoint/commands/UpdateAdmChannelCommand.ts @@ -22,6 +22,20 @@ export interface UpdateAdmChannelCommandOutput extends UpdateAdmChannelResponse, /** *

Enables the ADM channel for an application or updates the status and settings of the ADM channel for an application.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { PinpointClient, UpdateAdmChannelCommand } from "@aws-sdk/client-pinpoint"; // ES Modules import + * // const { PinpointClient, UpdateAdmChannelCommand } = require("@aws-sdk/client-pinpoint"); // CommonJS import + * const client = new PinpointClient(config); + * const command = new UpdateAdmChannelCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link UpdateAdmChannelCommandInput} for command's `input` shape. + * @see {@link UpdateAdmChannelCommandOutput} for command's `response` shape. + * @see {@link PinpointClientResolvedConfig | config} for command's `input` shape. + * */ export class UpdateAdmChannelCommand extends $Command< UpdateAdmChannelCommandInput, diff --git a/clients/client-pinpoint/commands/UpdateApnsChannelCommand.ts b/clients/client-pinpoint/commands/UpdateApnsChannelCommand.ts index bcb58a392d99..1f570bd3ae60 100644 --- a/clients/client-pinpoint/commands/UpdateApnsChannelCommand.ts +++ b/clients/client-pinpoint/commands/UpdateApnsChannelCommand.ts @@ -22,6 +22,20 @@ export interface UpdateApnsChannelCommandOutput extends UpdateApnsChannelRespons /** *

Enables the APNs channel for an application or updates the status and settings of the APNs channel for an application.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { PinpointClient, UpdateApnsChannelCommand } from "@aws-sdk/client-pinpoint"; // ES Modules import + * // const { PinpointClient, UpdateApnsChannelCommand } = require("@aws-sdk/client-pinpoint"); // CommonJS import + * const client = new PinpointClient(config); + * const command = new UpdateApnsChannelCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link UpdateApnsChannelCommandInput} for command's `input` shape. + * @see {@link UpdateApnsChannelCommandOutput} for command's `response` shape. + * @see {@link PinpointClientResolvedConfig | config} for command's `input` shape. + * */ export class UpdateApnsChannelCommand extends $Command< UpdateApnsChannelCommandInput, diff --git a/clients/client-pinpoint/commands/UpdateApnsSandboxChannelCommand.ts b/clients/client-pinpoint/commands/UpdateApnsSandboxChannelCommand.ts index 41131f5d985f..1414d858f47b 100644 --- a/clients/client-pinpoint/commands/UpdateApnsSandboxChannelCommand.ts +++ b/clients/client-pinpoint/commands/UpdateApnsSandboxChannelCommand.ts @@ -22,6 +22,20 @@ export interface UpdateApnsSandboxChannelCommandOutput extends UpdateApnsSandbox /** *

Enables the APNs sandbox channel for an application or updates the status and settings of the APNs sandbox channel for an application.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { PinpointClient, UpdateApnsSandboxChannelCommand } from "@aws-sdk/client-pinpoint"; // ES Modules import + * // const { PinpointClient, UpdateApnsSandboxChannelCommand } = require("@aws-sdk/client-pinpoint"); // CommonJS import + * const client = new PinpointClient(config); + * const command = new UpdateApnsSandboxChannelCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link UpdateApnsSandboxChannelCommandInput} for command's `input` shape. + * @see {@link UpdateApnsSandboxChannelCommandOutput} for command's `response` shape. + * @see {@link PinpointClientResolvedConfig | config} for command's `input` shape. + * */ export class UpdateApnsSandboxChannelCommand extends $Command< UpdateApnsSandboxChannelCommandInput, diff --git a/clients/client-pinpoint/commands/UpdateApnsVoipChannelCommand.ts b/clients/client-pinpoint/commands/UpdateApnsVoipChannelCommand.ts index 4fa19c7cd5f6..0c32c3b53403 100644 --- a/clients/client-pinpoint/commands/UpdateApnsVoipChannelCommand.ts +++ b/clients/client-pinpoint/commands/UpdateApnsVoipChannelCommand.ts @@ -22,6 +22,20 @@ export interface UpdateApnsVoipChannelCommandOutput extends UpdateApnsVoipChanne /** *

Enables the APNs VoIP channel for an application or updates the status and settings of the APNs VoIP channel for an application.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { PinpointClient, UpdateApnsVoipChannelCommand } from "@aws-sdk/client-pinpoint"; // ES Modules import + * // const { PinpointClient, UpdateApnsVoipChannelCommand } = require("@aws-sdk/client-pinpoint"); // CommonJS import + * const client = new PinpointClient(config); + * const command = new UpdateApnsVoipChannelCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link UpdateApnsVoipChannelCommandInput} for command's `input` shape. + * @see {@link UpdateApnsVoipChannelCommandOutput} for command's `response` shape. + * @see {@link PinpointClientResolvedConfig | config} for command's `input` shape. + * */ export class UpdateApnsVoipChannelCommand extends $Command< UpdateApnsVoipChannelCommandInput, diff --git a/clients/client-pinpoint/commands/UpdateApnsVoipSandboxChannelCommand.ts b/clients/client-pinpoint/commands/UpdateApnsVoipSandboxChannelCommand.ts index b4a9c61e2d6f..8b3a393606b3 100644 --- a/clients/client-pinpoint/commands/UpdateApnsVoipSandboxChannelCommand.ts +++ b/clients/client-pinpoint/commands/UpdateApnsVoipSandboxChannelCommand.ts @@ -24,6 +24,20 @@ export interface UpdateApnsVoipSandboxChannelCommandOutput /** *

Enables the APNs VoIP sandbox channel for an application or updates the status and settings of the APNs VoIP sandbox channel for an application.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { PinpointClient, UpdateApnsVoipSandboxChannelCommand } from "@aws-sdk/client-pinpoint"; // ES Modules import + * // const { PinpointClient, UpdateApnsVoipSandboxChannelCommand } = require("@aws-sdk/client-pinpoint"); // CommonJS import + * const client = new PinpointClient(config); + * const command = new UpdateApnsVoipSandboxChannelCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link UpdateApnsVoipSandboxChannelCommandInput} for command's `input` shape. + * @see {@link UpdateApnsVoipSandboxChannelCommandOutput} for command's `response` shape. + * @see {@link PinpointClientResolvedConfig | config} for command's `input` shape. + * */ export class UpdateApnsVoipSandboxChannelCommand extends $Command< UpdateApnsVoipSandboxChannelCommandInput, diff --git a/clients/client-pinpoint/commands/UpdateApplicationSettingsCommand.ts b/clients/client-pinpoint/commands/UpdateApplicationSettingsCommand.ts index 0f2f486c8bd9..f1cbda05d4ef 100644 --- a/clients/client-pinpoint/commands/UpdateApplicationSettingsCommand.ts +++ b/clients/client-pinpoint/commands/UpdateApplicationSettingsCommand.ts @@ -22,6 +22,20 @@ export interface UpdateApplicationSettingsCommandOutput extends UpdateApplicatio /** *

Updates the settings for an application.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { PinpointClient, UpdateApplicationSettingsCommand } from "@aws-sdk/client-pinpoint"; // ES Modules import + * // const { PinpointClient, UpdateApplicationSettingsCommand } = require("@aws-sdk/client-pinpoint"); // CommonJS import + * const client = new PinpointClient(config); + * const command = new UpdateApplicationSettingsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link UpdateApplicationSettingsCommandInput} for command's `input` shape. + * @see {@link UpdateApplicationSettingsCommandOutput} for command's `response` shape. + * @see {@link PinpointClientResolvedConfig | config} for command's `input` shape. + * */ export class UpdateApplicationSettingsCommand extends $Command< UpdateApplicationSettingsCommandInput, diff --git a/clients/client-pinpoint/commands/UpdateBaiduChannelCommand.ts b/clients/client-pinpoint/commands/UpdateBaiduChannelCommand.ts index 5f0de164a3d5..e79dff06aa35 100644 --- a/clients/client-pinpoint/commands/UpdateBaiduChannelCommand.ts +++ b/clients/client-pinpoint/commands/UpdateBaiduChannelCommand.ts @@ -22,6 +22,20 @@ export interface UpdateBaiduChannelCommandOutput extends UpdateBaiduChannelRespo /** *

Enables the Baidu channel for an application or updates the status and settings of the Baidu channel for an application.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { PinpointClient, UpdateBaiduChannelCommand } from "@aws-sdk/client-pinpoint"; // ES Modules import + * // const { PinpointClient, UpdateBaiduChannelCommand } = require("@aws-sdk/client-pinpoint"); // CommonJS import + * const client = new PinpointClient(config); + * const command = new UpdateBaiduChannelCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link UpdateBaiduChannelCommandInput} for command's `input` shape. + * @see {@link UpdateBaiduChannelCommandOutput} for command's `response` shape. + * @see {@link PinpointClientResolvedConfig | config} for command's `input` shape. + * */ export class UpdateBaiduChannelCommand extends $Command< UpdateBaiduChannelCommandInput, diff --git a/clients/client-pinpoint/commands/UpdateCampaignCommand.ts b/clients/client-pinpoint/commands/UpdateCampaignCommand.ts index 28c7afdee1b6..fd5b42d758aa 100644 --- a/clients/client-pinpoint/commands/UpdateCampaignCommand.ts +++ b/clients/client-pinpoint/commands/UpdateCampaignCommand.ts @@ -22,6 +22,20 @@ export interface UpdateCampaignCommandOutput extends UpdateCampaignResponse, __M /** *

Updates the configuration and other settings for a campaign.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { PinpointClient, UpdateCampaignCommand } from "@aws-sdk/client-pinpoint"; // ES Modules import + * // const { PinpointClient, UpdateCampaignCommand } = require("@aws-sdk/client-pinpoint"); // CommonJS import + * const client = new PinpointClient(config); + * const command = new UpdateCampaignCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link UpdateCampaignCommandInput} for command's `input` shape. + * @see {@link UpdateCampaignCommandOutput} for command's `response` shape. + * @see {@link PinpointClientResolvedConfig | config} for command's `input` shape. + * */ export class UpdateCampaignCommand extends $Command< UpdateCampaignCommandInput, diff --git a/clients/client-pinpoint/commands/UpdateEmailChannelCommand.ts b/clients/client-pinpoint/commands/UpdateEmailChannelCommand.ts index 14fa1bb04246..0d60db361d9d 100644 --- a/clients/client-pinpoint/commands/UpdateEmailChannelCommand.ts +++ b/clients/client-pinpoint/commands/UpdateEmailChannelCommand.ts @@ -22,6 +22,20 @@ export interface UpdateEmailChannelCommandOutput extends UpdateEmailChannelRespo /** *

Enables the email channel for an application or updates the status and settings of the email channel for an application.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { PinpointClient, UpdateEmailChannelCommand } from "@aws-sdk/client-pinpoint"; // ES Modules import + * // const { PinpointClient, UpdateEmailChannelCommand } = require("@aws-sdk/client-pinpoint"); // CommonJS import + * const client = new PinpointClient(config); + * const command = new UpdateEmailChannelCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link UpdateEmailChannelCommandInput} for command's `input` shape. + * @see {@link UpdateEmailChannelCommandOutput} for command's `response` shape. + * @see {@link PinpointClientResolvedConfig | config} for command's `input` shape. + * */ export class UpdateEmailChannelCommand extends $Command< UpdateEmailChannelCommandInput, diff --git a/clients/client-pinpoint/commands/UpdateEmailTemplateCommand.ts b/clients/client-pinpoint/commands/UpdateEmailTemplateCommand.ts index 6dbfdb89afb9..ad20c52fbd77 100644 --- a/clients/client-pinpoint/commands/UpdateEmailTemplateCommand.ts +++ b/clients/client-pinpoint/commands/UpdateEmailTemplateCommand.ts @@ -22,6 +22,20 @@ export interface UpdateEmailTemplateCommandOutput extends UpdateEmailTemplateRes /** *

Updates an existing message template for messages that are sent through the email channel.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { PinpointClient, UpdateEmailTemplateCommand } from "@aws-sdk/client-pinpoint"; // ES Modules import + * // const { PinpointClient, UpdateEmailTemplateCommand } = require("@aws-sdk/client-pinpoint"); // CommonJS import + * const client = new PinpointClient(config); + * const command = new UpdateEmailTemplateCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link UpdateEmailTemplateCommandInput} for command's `input` shape. + * @see {@link UpdateEmailTemplateCommandOutput} for command's `response` shape. + * @see {@link PinpointClientResolvedConfig | config} for command's `input` shape. + * */ export class UpdateEmailTemplateCommand extends $Command< UpdateEmailTemplateCommandInput, diff --git a/clients/client-pinpoint/commands/UpdateEndpointCommand.ts b/clients/client-pinpoint/commands/UpdateEndpointCommand.ts index 0b02bc3d3d34..019901665caf 100644 --- a/clients/client-pinpoint/commands/UpdateEndpointCommand.ts +++ b/clients/client-pinpoint/commands/UpdateEndpointCommand.ts @@ -22,6 +22,20 @@ export interface UpdateEndpointCommandOutput extends UpdateEndpointResponse, __M /** *

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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { PinpointClient, UpdateEndpointCommand } from "@aws-sdk/client-pinpoint"; // ES Modules import + * // const { PinpointClient, UpdateEndpointCommand } = require("@aws-sdk/client-pinpoint"); // CommonJS import + * const client = new PinpointClient(config); + * const command = new UpdateEndpointCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link UpdateEndpointCommandInput} for command's `input` shape. + * @see {@link UpdateEndpointCommandOutput} for command's `response` shape. + * @see {@link PinpointClientResolvedConfig | config} for command's `input` shape. + * */ export class UpdateEndpointCommand extends $Command< UpdateEndpointCommandInput, diff --git a/clients/client-pinpoint/commands/UpdateEndpointsBatchCommand.ts b/clients/client-pinpoint/commands/UpdateEndpointsBatchCommand.ts index 7c1f821bbcfc..2418b30e5fb3 100644 --- a/clients/client-pinpoint/commands/UpdateEndpointsBatchCommand.ts +++ b/clients/client-pinpoint/commands/UpdateEndpointsBatchCommand.ts @@ -22,6 +22,20 @@ export interface UpdateEndpointsBatchCommandOutput extends UpdateEndpointsBatchR /** *

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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { PinpointClient, UpdateEndpointsBatchCommand } from "@aws-sdk/client-pinpoint"; // ES Modules import + * // const { PinpointClient, UpdateEndpointsBatchCommand } = require("@aws-sdk/client-pinpoint"); // CommonJS import + * const client = new PinpointClient(config); + * const command = new UpdateEndpointsBatchCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link UpdateEndpointsBatchCommandInput} for command's `input` shape. + * @see {@link UpdateEndpointsBatchCommandOutput} for command's `response` shape. + * @see {@link PinpointClientResolvedConfig | config} for command's `input` shape. + * */ export class UpdateEndpointsBatchCommand extends $Command< UpdateEndpointsBatchCommandInput, diff --git a/clients/client-pinpoint/commands/UpdateGcmChannelCommand.ts b/clients/client-pinpoint/commands/UpdateGcmChannelCommand.ts index 10a2beb6d839..9e6f0970a624 100644 --- a/clients/client-pinpoint/commands/UpdateGcmChannelCommand.ts +++ b/clients/client-pinpoint/commands/UpdateGcmChannelCommand.ts @@ -22,6 +22,20 @@ export interface UpdateGcmChannelCommandOutput extends UpdateGcmChannelResponse, /** *

Enables the GCM channel for an application or updates the status and settings of the GCM channel for an application.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { PinpointClient, UpdateGcmChannelCommand } from "@aws-sdk/client-pinpoint"; // ES Modules import + * // const { PinpointClient, UpdateGcmChannelCommand } = require("@aws-sdk/client-pinpoint"); // CommonJS import + * const client = new PinpointClient(config); + * const command = new UpdateGcmChannelCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link UpdateGcmChannelCommandInput} for command's `input` shape. + * @see {@link UpdateGcmChannelCommandOutput} for command's `response` shape. + * @see {@link PinpointClientResolvedConfig | config} for command's `input` shape. + * */ export class UpdateGcmChannelCommand extends $Command< UpdateGcmChannelCommandInput, diff --git a/clients/client-pinpoint/commands/UpdateJourneyCommand.ts b/clients/client-pinpoint/commands/UpdateJourneyCommand.ts index 4196e451106f..d3f27dc5f1f9 100644 --- a/clients/client-pinpoint/commands/UpdateJourneyCommand.ts +++ b/clients/client-pinpoint/commands/UpdateJourneyCommand.ts @@ -22,6 +22,20 @@ export interface UpdateJourneyCommandOutput extends UpdateJourneyResponse, __Met /** *

Updates the configuration and other settings for a journey.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { PinpointClient, UpdateJourneyCommand } from "@aws-sdk/client-pinpoint"; // ES Modules import + * // const { PinpointClient, UpdateJourneyCommand } = require("@aws-sdk/client-pinpoint"); // CommonJS import + * const client = new PinpointClient(config); + * const command = new UpdateJourneyCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link UpdateJourneyCommandInput} for command's `input` shape. + * @see {@link UpdateJourneyCommandOutput} for command's `response` shape. + * @see {@link PinpointClientResolvedConfig | config} for command's `input` shape. + * */ export class UpdateJourneyCommand extends $Command< UpdateJourneyCommandInput, diff --git a/clients/client-pinpoint/commands/UpdateJourneyStateCommand.ts b/clients/client-pinpoint/commands/UpdateJourneyStateCommand.ts index 0ba956ca8faf..199cbc66dfd7 100644 --- a/clients/client-pinpoint/commands/UpdateJourneyStateCommand.ts +++ b/clients/client-pinpoint/commands/UpdateJourneyStateCommand.ts @@ -22,6 +22,20 @@ export interface UpdateJourneyStateCommandOutput extends UpdateJourneyStateRespo /** *

Cancels (stops) an active journey.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { PinpointClient, UpdateJourneyStateCommand } from "@aws-sdk/client-pinpoint"; // ES Modules import + * // const { PinpointClient, UpdateJourneyStateCommand } = require("@aws-sdk/client-pinpoint"); // CommonJS import + * const client = new PinpointClient(config); + * const command = new UpdateJourneyStateCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link UpdateJourneyStateCommandInput} for command's `input` shape. + * @see {@link UpdateJourneyStateCommandOutput} for command's `response` shape. + * @see {@link PinpointClientResolvedConfig | config} for command's `input` shape. + * */ export class UpdateJourneyStateCommand extends $Command< UpdateJourneyStateCommandInput, diff --git a/clients/client-pinpoint/commands/UpdatePushTemplateCommand.ts b/clients/client-pinpoint/commands/UpdatePushTemplateCommand.ts index 885cd56de19a..e315c778c3b1 100644 --- a/clients/client-pinpoint/commands/UpdatePushTemplateCommand.ts +++ b/clients/client-pinpoint/commands/UpdatePushTemplateCommand.ts @@ -22,6 +22,20 @@ export interface UpdatePushTemplateCommandOutput extends UpdatePushTemplateRespo /** *

Updates an existing message template for messages that are sent through a push notification channel.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { PinpointClient, UpdatePushTemplateCommand } from "@aws-sdk/client-pinpoint"; // ES Modules import + * // const { PinpointClient, UpdatePushTemplateCommand } = require("@aws-sdk/client-pinpoint"); // CommonJS import + * const client = new PinpointClient(config); + * const command = new UpdatePushTemplateCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link UpdatePushTemplateCommandInput} for command's `input` shape. + * @see {@link UpdatePushTemplateCommandOutput} for command's `response` shape. + * @see {@link PinpointClientResolvedConfig | config} for command's `input` shape. + * */ export class UpdatePushTemplateCommand extends $Command< UpdatePushTemplateCommandInput, diff --git a/clients/client-pinpoint/commands/UpdateRecommenderConfigurationCommand.ts b/clients/client-pinpoint/commands/UpdateRecommenderConfigurationCommand.ts index 52ecbf5fcfb7..a7422c0d29df 100644 --- a/clients/client-pinpoint/commands/UpdateRecommenderConfigurationCommand.ts +++ b/clients/client-pinpoint/commands/UpdateRecommenderConfigurationCommand.ts @@ -24,6 +24,20 @@ export interface UpdateRecommenderConfigurationCommandOutput /** *

Updates an Amazon Pinpoint configuration for a recommender model.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { PinpointClient, UpdateRecommenderConfigurationCommand } from "@aws-sdk/client-pinpoint"; // ES Modules import + * // const { PinpointClient, UpdateRecommenderConfigurationCommand } = require("@aws-sdk/client-pinpoint"); // CommonJS import + * const client = new PinpointClient(config); + * const command = new UpdateRecommenderConfigurationCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link UpdateRecommenderConfigurationCommandInput} for command's `input` shape. + * @see {@link UpdateRecommenderConfigurationCommandOutput} for command's `response` shape. + * @see {@link PinpointClientResolvedConfig | config} for command's `input` shape. + * */ export class UpdateRecommenderConfigurationCommand extends $Command< UpdateRecommenderConfigurationCommandInput, diff --git a/clients/client-pinpoint/commands/UpdateSegmentCommand.ts b/clients/client-pinpoint/commands/UpdateSegmentCommand.ts index 73b77d8d0aaa..95bbe2dcf896 100644 --- a/clients/client-pinpoint/commands/UpdateSegmentCommand.ts +++ b/clients/client-pinpoint/commands/UpdateSegmentCommand.ts @@ -22,6 +22,20 @@ export interface UpdateSegmentCommandOutput extends UpdateSegmentResponse, __Met /** *

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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { PinpointClient, UpdateSegmentCommand } from "@aws-sdk/client-pinpoint"; // ES Modules import + * // const { PinpointClient, UpdateSegmentCommand } = require("@aws-sdk/client-pinpoint"); // CommonJS import + * const client = new PinpointClient(config); + * const command = new UpdateSegmentCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link UpdateSegmentCommandInput} for command's `input` shape. + * @see {@link UpdateSegmentCommandOutput} for command's `response` shape. + * @see {@link PinpointClientResolvedConfig | config} for command's `input` shape. + * */ export class UpdateSegmentCommand extends $Command< UpdateSegmentCommandInput, diff --git a/clients/client-pinpoint/commands/UpdateSmsChannelCommand.ts b/clients/client-pinpoint/commands/UpdateSmsChannelCommand.ts index b26cb91da9ae..dd56b1369f8a 100644 --- a/clients/client-pinpoint/commands/UpdateSmsChannelCommand.ts +++ b/clients/client-pinpoint/commands/UpdateSmsChannelCommand.ts @@ -22,6 +22,20 @@ export interface UpdateSmsChannelCommandOutput extends UpdateSmsChannelResponse, /** *

Enables the SMS channel for an application or updates the status and settings of the SMS channel for an application.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { PinpointClient, UpdateSmsChannelCommand } from "@aws-sdk/client-pinpoint"; // ES Modules import + * // const { PinpointClient, UpdateSmsChannelCommand } = require("@aws-sdk/client-pinpoint"); // CommonJS import + * const client = new PinpointClient(config); + * const command = new UpdateSmsChannelCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link UpdateSmsChannelCommandInput} for command's `input` shape. + * @see {@link UpdateSmsChannelCommandOutput} for command's `response` shape. + * @see {@link PinpointClientResolvedConfig | config} for command's `input` shape. + * */ export class UpdateSmsChannelCommand extends $Command< UpdateSmsChannelCommandInput, diff --git a/clients/client-pinpoint/commands/UpdateSmsTemplateCommand.ts b/clients/client-pinpoint/commands/UpdateSmsTemplateCommand.ts index 849d443ae075..b0760ec9cb93 100644 --- a/clients/client-pinpoint/commands/UpdateSmsTemplateCommand.ts +++ b/clients/client-pinpoint/commands/UpdateSmsTemplateCommand.ts @@ -22,6 +22,20 @@ export interface UpdateSmsTemplateCommandOutput extends UpdateSmsTemplateRespons /** *

Updates an existing message template for messages that are sent through the SMS channel.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { PinpointClient, UpdateSmsTemplateCommand } from "@aws-sdk/client-pinpoint"; // ES Modules import + * // const { PinpointClient, UpdateSmsTemplateCommand } = require("@aws-sdk/client-pinpoint"); // CommonJS import + * const client = new PinpointClient(config); + * const command = new UpdateSmsTemplateCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link UpdateSmsTemplateCommandInput} for command's `input` shape. + * @see {@link UpdateSmsTemplateCommandOutput} for command's `response` shape. + * @see {@link PinpointClientResolvedConfig | config} for command's `input` shape. + * */ export class UpdateSmsTemplateCommand extends $Command< UpdateSmsTemplateCommandInput, diff --git a/clients/client-pinpoint/commands/UpdateTemplateActiveVersionCommand.ts b/clients/client-pinpoint/commands/UpdateTemplateActiveVersionCommand.ts index 62bb5a1dcb44..4c7fe7f641fd 100644 --- a/clients/client-pinpoint/commands/UpdateTemplateActiveVersionCommand.ts +++ b/clients/client-pinpoint/commands/UpdateTemplateActiveVersionCommand.ts @@ -24,6 +24,20 @@ export interface UpdateTemplateActiveVersionCommandOutput /** *

Changes the status of a specific version of a message template to active.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { PinpointClient, UpdateTemplateActiveVersionCommand } from "@aws-sdk/client-pinpoint"; // ES Modules import + * // const { PinpointClient, UpdateTemplateActiveVersionCommand } = require("@aws-sdk/client-pinpoint"); // CommonJS import + * const client = new PinpointClient(config); + * const command = new UpdateTemplateActiveVersionCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link UpdateTemplateActiveVersionCommandInput} for command's `input` shape. + * @see {@link UpdateTemplateActiveVersionCommandOutput} for command's `response` shape. + * @see {@link PinpointClientResolvedConfig | config} for command's `input` shape. + * */ export class UpdateTemplateActiveVersionCommand extends $Command< UpdateTemplateActiveVersionCommandInput, diff --git a/clients/client-pinpoint/commands/UpdateVoiceChannelCommand.ts b/clients/client-pinpoint/commands/UpdateVoiceChannelCommand.ts index 195ee042483e..958304517014 100644 --- a/clients/client-pinpoint/commands/UpdateVoiceChannelCommand.ts +++ b/clients/client-pinpoint/commands/UpdateVoiceChannelCommand.ts @@ -22,6 +22,20 @@ export interface UpdateVoiceChannelCommandOutput extends UpdateVoiceChannelRespo /** *

Enables the voice channel for an application or updates the status and settings of the voice channel for an application.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { PinpointClient, UpdateVoiceChannelCommand } from "@aws-sdk/client-pinpoint"; // ES Modules import + * // const { PinpointClient, UpdateVoiceChannelCommand } = require("@aws-sdk/client-pinpoint"); // CommonJS import + * const client = new PinpointClient(config); + * const command = new UpdateVoiceChannelCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link UpdateVoiceChannelCommandInput} for command's `input` shape. + * @see {@link UpdateVoiceChannelCommandOutput} for command's `response` shape. + * @see {@link PinpointClientResolvedConfig | config} for command's `input` shape. + * */ export class UpdateVoiceChannelCommand extends $Command< UpdateVoiceChannelCommandInput, diff --git a/clients/client-pinpoint/commands/UpdateVoiceTemplateCommand.ts b/clients/client-pinpoint/commands/UpdateVoiceTemplateCommand.ts index 164392ec3ac9..225b31d19997 100644 --- a/clients/client-pinpoint/commands/UpdateVoiceTemplateCommand.ts +++ b/clients/client-pinpoint/commands/UpdateVoiceTemplateCommand.ts @@ -22,6 +22,20 @@ export interface UpdateVoiceTemplateCommandOutput extends UpdateVoiceTemplateRes /** *

Updates an existing message template for messages that are sent through the voice channel.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { PinpointClient, UpdateVoiceTemplateCommand } from "@aws-sdk/client-pinpoint"; // ES Modules import + * // const { PinpointClient, UpdateVoiceTemplateCommand } = require("@aws-sdk/client-pinpoint"); // CommonJS import + * const client = new PinpointClient(config); + * const command = new UpdateVoiceTemplateCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link UpdateVoiceTemplateCommandInput} for command's `input` shape. + * @see {@link UpdateVoiceTemplateCommandOutput} for command's `response` shape. + * @see {@link PinpointClientResolvedConfig | config} for command's `input` shape. + * */ export class UpdateVoiceTemplateCommand extends $Command< UpdateVoiceTemplateCommandInput, diff --git a/clients/client-pinpoint/models/models_0.ts b/clients/client-pinpoint/models/models_0.ts index 362f6cc29e42..a0a07769693f 100644 --- a/clients/client-pinpoint/models/models_0.ts +++ b/clients/client-pinpoint/models/models_0.ts @@ -93,6 +93,9 @@ export interface ActivityResponse { } export namespace ActivityResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ActivityResponse): any => ({ ...obj, }); @@ -114,6 +117,9 @@ export interface ActivitiesResponse { } export namespace ActivitiesResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ActivitiesResponse): any => ({ ...obj, }); @@ -145,6 +151,9 @@ export interface AttributeDimension { } export namespace AttributeDimension { + /** + * @internal + */ export const filterSensitiveLog = (obj: AttributeDimension): any => ({ ...obj, }); @@ -171,6 +180,9 @@ export interface SetDimension { } export namespace SetDimension { + /** + * @internal + */ export const filterSensitiveLog = (obj: SetDimension): any => ({ ...obj, }); @@ -192,6 +204,9 @@ export interface MetricDimension { } export namespace MetricDimension { + /** + * @internal + */ export const filterSensitiveLog = (obj: MetricDimension): any => ({ ...obj, }); @@ -218,6 +233,9 @@ export interface EventDimensions { } export namespace EventDimensions { + /** + * @internal + */ export const filterSensitiveLog = (obj: EventDimensions): any => ({ ...obj, }); @@ -239,6 +257,9 @@ export interface EventCondition { } export namespace EventCondition { + /** + * @internal + */ export const filterSensitiveLog = (obj: EventCondition): any => ({ ...obj, }); @@ -255,6 +276,9 @@ export interface SegmentCondition { } export namespace SegmentCondition { + /** + * @internal + */ export const filterSensitiveLog = (obj: SegmentCondition): any => ({ ...obj, }); @@ -288,6 +312,9 @@ export interface RecencyDimension { } export namespace RecencyDimension { + /** + * @internal + */ export const filterSensitiveLog = (obj: RecencyDimension): any => ({ ...obj, }); @@ -304,6 +331,9 @@ export interface SegmentBehaviors { } export namespace SegmentBehaviors { + /** + * @internal + */ export const filterSensitiveLog = (obj: SegmentBehaviors): any => ({ ...obj, }); @@ -345,6 +375,9 @@ export interface SegmentDemographics { } export namespace SegmentDemographics { + /** + * @internal + */ export const filterSensitiveLog = (obj: SegmentDemographics): any => ({ ...obj, }); @@ -366,6 +399,9 @@ export interface GPSCoordinates { } export namespace GPSCoordinates { + /** + * @internal + */ export const filterSensitiveLog = (obj: GPSCoordinates): any => ({ ...obj, }); @@ -387,6 +423,9 @@ export interface GPSPointDimension { } export namespace GPSPointDimension { + /** + * @internal + */ export const filterSensitiveLog = (obj: GPSPointDimension): any => ({ ...obj, }); @@ -408,6 +447,9 @@ export interface SegmentLocation { } export namespace SegmentLocation { + /** + * @internal + */ export const filterSensitiveLog = (obj: SegmentLocation): any => ({ ...obj, }); @@ -449,6 +491,9 @@ export interface SegmentDimensions { } export namespace SegmentDimensions { + /** + * @internal + */ export const filterSensitiveLog = (obj: SegmentDimensions): any => ({ ...obj, }); @@ -475,6 +520,9 @@ export interface SimpleCondition { } export namespace SimpleCondition { + /** + * @internal + */ export const filterSensitiveLog = (obj: SimpleCondition): any => ({ ...obj, }); @@ -501,6 +549,9 @@ export interface Condition { } export namespace Condition { + /** + * @internal + */ export const filterSensitiveLog = (obj: Condition): any => ({ ...obj, }); @@ -522,6 +573,9 @@ export interface WaitTime { } export namespace WaitTime { + /** + * @internal + */ export const filterSensitiveLog = (obj: WaitTime): any => ({ ...obj, }); @@ -553,6 +607,9 @@ export interface ConditionalSplitActivity { } export namespace ConditionalSplitActivity { + /** + * @internal + */ export const filterSensitiveLog = (obj: ConditionalSplitActivity): any => ({ ...obj, }); @@ -569,6 +626,9 @@ export interface JourneyCustomMessage { } export namespace JourneyCustomMessage { + /** + * @internal + */ export const filterSensitiveLog = (obj: JourneyCustomMessage): any => ({ ...obj, }); @@ -610,6 +670,9 @@ export interface CustomMessageActivity { } export namespace CustomMessageActivity { + /** + * @internal + */ export const filterSensitiveLog = (obj: CustomMessageActivity): any => ({ ...obj, }); @@ -626,6 +689,9 @@ export interface JourneyEmailMessage { } export namespace JourneyEmailMessage { + /** + * @internal + */ export const filterSensitiveLog = (obj: JourneyEmailMessage): any => ({ ...obj, }); @@ -657,6 +723,9 @@ export interface EmailMessageActivity { } export namespace EmailMessageActivity { + /** + * @internal + */ export const filterSensitiveLog = (obj: EmailMessageActivity): any => ({ ...obj, }); @@ -678,6 +747,9 @@ export interface HoldoutActivity { } export namespace HoldoutActivity { + /** + * @internal + */ export const filterSensitiveLog = (obj: HoldoutActivity): any => ({ ...obj, }); @@ -699,6 +771,9 @@ export interface MultiConditionalBranch { } export namespace MultiConditionalBranch { + /** + * @internal + */ export const filterSensitiveLog = (obj: MultiConditionalBranch): any => ({ ...obj, }); @@ -725,6 +800,9 @@ export interface MultiConditionalSplitActivity { } export namespace MultiConditionalSplitActivity { + /** + * @internal + */ export const filterSensitiveLog = (obj: MultiConditionalSplitActivity): any => ({ ...obj, }); @@ -741,6 +819,9 @@ export interface JourneyPushMessage { } export namespace JourneyPushMessage { + /** + * @internal + */ export const filterSensitiveLog = (obj: JourneyPushMessage): any => ({ ...obj, }); @@ -772,6 +853,9 @@ export interface PushMessageActivity { } export namespace PushMessageActivity { + /** + * @internal + */ export const filterSensitiveLog = (obj: PushMessageActivity): any => ({ ...obj, }); @@ -793,6 +877,9 @@ export interface RandomSplitEntry { } export namespace RandomSplitEntry { + /** + * @internal + */ export const filterSensitiveLog = (obj: RandomSplitEntry): any => ({ ...obj, }); @@ -809,6 +896,9 @@ export interface RandomSplitActivity { } export namespace RandomSplitActivity { + /** + * @internal + */ export const filterSensitiveLog = (obj: RandomSplitActivity): any => ({ ...obj, }); @@ -850,6 +940,9 @@ export interface JourneySMSMessage { } export namespace JourneySMSMessage { + /** + * @internal + */ export const filterSensitiveLog = (obj: JourneySMSMessage): any => ({ ...obj, }); @@ -881,6 +974,9 @@ export interface SMSMessageActivity { } export namespace SMSMessageActivity { + /** + * @internal + */ export const filterSensitiveLog = (obj: SMSMessageActivity): any => ({ ...obj, }); @@ -902,6 +998,9 @@ export interface WaitActivity { } export namespace WaitActivity { + /** + * @internal + */ export const filterSensitiveLog = (obj: WaitActivity): any => ({ ...obj, }); @@ -963,6 +1062,9 @@ export interface Activity { } export namespace Activity { + /** + * @internal + */ export const filterSensitiveLog = (obj: Activity): any => ({ ...obj, }); @@ -1019,6 +1121,9 @@ export interface AddressConfiguration { } export namespace AddressConfiguration { + /** + * @internal + */ export const filterSensitiveLog = (obj: AddressConfiguration): any => ({ ...obj, }); @@ -1045,6 +1150,9 @@ export interface ADMChannelRequest { } export namespace ADMChannelRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ADMChannelRequest): any => ({ ...obj, }); @@ -1106,6 +1214,9 @@ export interface ADMChannelResponse { } export namespace ADMChannelResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ADMChannelResponse): any => ({ ...obj, }); @@ -1197,6 +1308,9 @@ export interface ADMMessage { } export namespace ADMMessage { + /** + * @internal + */ export const filterSensitiveLog = (obj: ADMMessage): any => ({ ...obj, }); @@ -1253,6 +1367,9 @@ export interface AndroidPushNotificationTemplate { } export namespace AndroidPushNotificationTemplate { + /** + * @internal + */ export const filterSensitiveLog = (obj: AndroidPushNotificationTemplate): any => ({ ...obj, }); @@ -1304,6 +1421,9 @@ export interface APNSChannelRequest { } export namespace APNSChannelRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: APNSChannelRequest): any => ({ ...obj, }); @@ -1375,6 +1495,9 @@ export interface APNSChannelResponse { } export namespace APNSChannelResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: APNSChannelResponse): any => ({ ...obj, }); @@ -1476,6 +1599,9 @@ export interface APNSMessage { } export namespace APNSMessage { + /** + * @internal + */ export const filterSensitiveLog = (obj: APNSMessage): any => ({ ...obj, }); @@ -1522,6 +1648,9 @@ export interface APNSPushNotificationTemplate { } export namespace APNSPushNotificationTemplate { + /** + * @internal + */ export const filterSensitiveLog = (obj: APNSPushNotificationTemplate): any => ({ ...obj, }); @@ -1573,6 +1702,9 @@ export interface APNSSandboxChannelRequest { } export namespace APNSSandboxChannelRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: APNSSandboxChannelRequest): any => ({ ...obj, }); @@ -1644,6 +1776,9 @@ export interface APNSSandboxChannelResponse { } export namespace APNSSandboxChannelResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: APNSSandboxChannelResponse): any => ({ ...obj, }); @@ -1695,6 +1830,9 @@ export interface APNSVoipChannelRequest { } export namespace APNSVoipChannelRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: APNSVoipChannelRequest): any => ({ ...obj, }); @@ -1766,6 +1904,9 @@ export interface APNSVoipChannelResponse { } export namespace APNSVoipChannelResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: APNSVoipChannelResponse): any => ({ ...obj, }); @@ -1817,6 +1958,9 @@ export interface APNSVoipSandboxChannelRequest { } export namespace APNSVoipSandboxChannelRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: APNSVoipSandboxChannelRequest): any => ({ ...obj, }); @@ -1888,6 +2032,9 @@ export interface APNSVoipSandboxChannelResponse { } export namespace APNSVoipSandboxChannelResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: APNSVoipSandboxChannelResponse): any => ({ ...obj, }); @@ -1914,6 +2061,9 @@ export interface ResultRowValue { } export namespace ResultRowValue { + /** + * @internal + */ export const filterSensitiveLog = (obj: ResultRowValue): any => ({ ...obj, }); @@ -1935,6 +2085,9 @@ export interface ResultRow { } export namespace ResultRow { + /** + * @internal + */ export const filterSensitiveLog = (obj: ResultRow): any => ({ ...obj, }); @@ -1951,6 +2104,9 @@ export interface BaseKpiResult { } export namespace BaseKpiResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: BaseKpiResult): any => ({ ...obj, }); @@ -1992,6 +2148,9 @@ export interface ApplicationDateRangeKpiResponse { } export namespace ApplicationDateRangeKpiResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ApplicationDateRangeKpiResponse): any => ({ ...obj, }); @@ -2023,6 +2182,9 @@ export interface ApplicationResponse { } export namespace ApplicationResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ApplicationResponse): any => ({ ...obj, }); @@ -2054,6 +2216,9 @@ export interface CampaignHook { } export namespace CampaignHook { + /** + * @internal + */ export const filterSensitiveLog = (obj: CampaignHook): any => ({ ...obj, }); @@ -2085,6 +2250,9 @@ export interface CampaignLimits { } export namespace CampaignLimits { + /** + * @internal + */ export const filterSensitiveLog = (obj: CampaignLimits): any => ({ ...obj, }); @@ -2106,6 +2274,9 @@ export interface QuietTime { } export namespace QuietTime { + /** + * @internal + */ export const filterSensitiveLog = (obj: QuietTime): any => ({ ...obj, }); @@ -2142,6 +2313,9 @@ export interface ApplicationSettingsResource { } export namespace ApplicationSettingsResource { + /** + * @internal + */ export const filterSensitiveLog = (obj: ApplicationSettingsResource): any => ({ ...obj, }); @@ -2163,6 +2337,9 @@ export interface ApplicationsResponse { } export namespace ApplicationsResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ApplicationsResponse): any => ({ ...obj, }); @@ -2189,6 +2366,9 @@ export interface AttributesResource { } export namespace AttributesResource { + /** + * @internal + */ export const filterSensitiveLog = (obj: AttributesResource): any => ({ ...obj, }); @@ -2212,6 +2392,9 @@ export interface BadRequestException extends __SmithyException, $MetadataBearer } export namespace BadRequestException { + /** + * @internal + */ export const filterSensitiveLog = (obj: BadRequestException): any => ({ ...obj, }); @@ -2238,6 +2421,9 @@ export interface BaiduChannelRequest { } export namespace BaiduChannelRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: BaiduChannelRequest): any => ({ ...obj, }); @@ -2304,6 +2490,9 @@ export interface BaiduChannelResponse { } export namespace BaiduChannelResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: BaiduChannelResponse): any => ({ ...obj, }); @@ -2385,6 +2574,9 @@ export interface BaiduMessage { } export namespace BaiduMessage { + /** + * @internal + */ export const filterSensitiveLog = (obj: BaiduMessage): any => ({ ...obj, }); @@ -2401,6 +2593,9 @@ export interface CampaignCustomMessage { } export namespace CampaignCustomMessage { + /** + * @internal + */ export const filterSensitiveLog = (obj: CampaignCustomMessage): any => ({ ...obj, }); @@ -2447,6 +2642,9 @@ export interface CampaignDateRangeKpiResponse { } export namespace CampaignDateRangeKpiResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: CampaignDateRangeKpiResponse): any => ({ ...obj, }); @@ -2478,6 +2676,9 @@ export interface CampaignEmailMessage { } export namespace CampaignEmailMessage { + /** + * @internal + */ export const filterSensitiveLog = (obj: CampaignEmailMessage): any => ({ ...obj, }); @@ -2504,6 +2705,9 @@ export interface CampaignEventFilter { } export namespace CampaignEventFilter { + /** + * @internal + */ export const filterSensitiveLog = (obj: CampaignEventFilter): any => ({ ...obj, }); @@ -2525,6 +2729,9 @@ export interface CustomDeliveryConfiguration { } export namespace CustomDeliveryConfiguration { + /** + * @internal + */ export const filterSensitiveLog = (obj: CustomDeliveryConfiguration): any => ({ ...obj, }); @@ -2596,6 +2803,9 @@ export interface Message { } export namespace Message { + /** + * @internal + */ export const filterSensitiveLog = (obj: Message): any => ({ ...obj, }); @@ -2637,6 +2847,9 @@ export interface CampaignSmsMessage { } export namespace CampaignSmsMessage { + /** + * @internal + */ export const filterSensitiveLog = (obj: CampaignSmsMessage): any => ({ ...obj, }); @@ -2688,6 +2901,9 @@ export interface MessageConfiguration { } export namespace MessageConfiguration { + /** + * @internal + */ export const filterSensitiveLog = (obj: MessageConfiguration): any => ({ ...obj, }); @@ -2746,6 +2962,9 @@ export interface Schedule { } export namespace Schedule { + /** + * @internal + */ export const filterSensitiveLog = (obj: Schedule): any => ({ ...obj, }); @@ -2772,6 +2991,9 @@ export interface CampaignState { } export namespace CampaignState { + /** + * @internal + */ export const filterSensitiveLog = (obj: CampaignState): any => ({ ...obj, }); @@ -2793,6 +3015,9 @@ export interface Template { } export namespace Template { + /** + * @internal + */ export const filterSensitiveLog = (obj: Template): any => ({ ...obj, }); @@ -2824,6 +3049,9 @@ export interface TemplateConfiguration { } export namespace TemplateConfiguration { + /** + * @internal + */ export const filterSensitiveLog = (obj: TemplateConfiguration): any => ({ ...obj, }); @@ -2880,6 +3108,9 @@ export interface TreatmentResource { } export namespace TreatmentResource { + /** + * @internal + */ export const filterSensitiveLog = (obj: TreatmentResource): any => ({ ...obj, }); @@ -3011,6 +3242,9 @@ export interface CampaignResponse { } export namespace CampaignResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: CampaignResponse): any => ({ ...obj, }); @@ -3032,6 +3266,9 @@ export interface CampaignsResponse { } export namespace CampaignsResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: CampaignsResponse): any => ({ ...obj, }); @@ -3088,6 +3325,9 @@ export interface ChannelResponse { } export namespace ChannelResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ChannelResponse): any => ({ ...obj, }); @@ -3104,6 +3344,9 @@ export interface ChannelsResponse { } export namespace ChannelsResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ChannelsResponse): any => ({ ...obj, }); @@ -3127,6 +3370,9 @@ export interface ConflictException extends __SmithyException, $MetadataBearer { } export namespace ConflictException { + /** + * @internal + */ export const filterSensitiveLog = (obj: ConflictException): any => ({ ...obj, }); @@ -3148,6 +3394,9 @@ export interface CreateApplicationRequest { } export namespace CreateApplicationRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateApplicationRequest): any => ({ ...obj, }); @@ -3161,6 +3410,9 @@ export interface CreateAppRequest { } export namespace CreateAppRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateAppRequest): any => ({ ...obj, }); @@ -3174,6 +3426,9 @@ export interface CreateAppResponse { } export namespace CreateAppResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateAppResponse): any => ({ ...obj, }); @@ -3197,6 +3452,9 @@ export interface ForbiddenException extends __SmithyException, $MetadataBearer { } export namespace ForbiddenException { + /** + * @internal + */ export const filterSensitiveLog = (obj: ForbiddenException): any => ({ ...obj, }); @@ -3220,6 +3478,9 @@ export interface InternalServerErrorException extends __SmithyException, $Metada } export namespace InternalServerErrorException { + /** + * @internal + */ export const filterSensitiveLog = (obj: InternalServerErrorException): any => ({ ...obj, }); @@ -3243,6 +3504,9 @@ export interface MethodNotAllowedException extends __SmithyException, $MetadataB } export namespace MethodNotAllowedException { + /** + * @internal + */ export const filterSensitiveLog = (obj: MethodNotAllowedException): any => ({ ...obj, }); @@ -3266,6 +3530,9 @@ export interface NotFoundException extends __SmithyException, $MetadataBearer { } export namespace NotFoundException { + /** + * @internal + */ export const filterSensitiveLog = (obj: NotFoundException): any => ({ ...obj, }); @@ -3289,6 +3556,9 @@ export interface PayloadTooLargeException extends __SmithyException, $MetadataBe } export namespace PayloadTooLargeException { + /** + * @internal + */ export const filterSensitiveLog = (obj: PayloadTooLargeException): any => ({ ...obj, }); @@ -3312,6 +3582,9 @@ export interface TooManyRequestsException extends __SmithyException, $MetadataBe } export namespace TooManyRequestsException { + /** + * @internal + */ export const filterSensitiveLog = (obj: TooManyRequestsException): any => ({ ...obj, }); @@ -3358,6 +3631,9 @@ export interface WriteTreatmentResource { } export namespace WriteTreatmentResource { + /** + * @internal + */ export const filterSensitiveLog = (obj: WriteTreatmentResource): any => ({ ...obj, }); @@ -3449,6 +3725,9 @@ export interface WriteCampaignRequest { } export namespace WriteCampaignRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: WriteCampaignRequest): any => ({ ...obj, }); @@ -3467,6 +3746,9 @@ export interface CreateCampaignRequest { } export namespace CreateCampaignRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateCampaignRequest): any => ({ ...obj, }); @@ -3480,6 +3762,9 @@ export interface CreateCampaignResponse { } export namespace CreateCampaignResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateCampaignResponse): any => ({ ...obj, }); @@ -3526,6 +3811,9 @@ export interface EmailTemplateRequest { } export namespace EmailTemplateRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: EmailTemplateRequest): any => ({ ...obj, }); @@ -3544,6 +3832,9 @@ export interface CreateEmailTemplateRequest { } export namespace CreateEmailTemplateRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateEmailTemplateRequest): any => ({ ...obj, }); @@ -3570,6 +3861,9 @@ export interface CreateTemplateMessageBody { } export namespace CreateTemplateMessageBody { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateTemplateMessageBody): any => ({ ...obj, }); @@ -3583,6 +3877,9 @@ export interface CreateEmailTemplateResponse { } export namespace CreateEmailTemplateResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateEmailTemplateResponse): any => ({ ...obj, }); @@ -3614,6 +3911,9 @@ export interface ExportJobRequest { } export namespace ExportJobRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ExportJobRequest): any => ({ ...obj, }); @@ -3632,6 +3932,9 @@ export interface CreateExportJobRequest { } export namespace CreateExportJobRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateExportJobRequest): any => ({ ...obj, }); @@ -3663,6 +3966,9 @@ export interface ExportJobResource { } export namespace ExportJobResource { + /** + * @internal + */ export const filterSensitiveLog = (obj: ExportJobResource): any => ({ ...obj, }); @@ -3751,6 +4057,9 @@ export interface ExportJobResponse { } export namespace ExportJobResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ExportJobResponse): any => ({ ...obj, }); @@ -3764,6 +4073,9 @@ export interface CreateExportJobResponse { } export namespace CreateExportJobResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateExportJobResponse): any => ({ ...obj, }); @@ -3820,6 +4132,9 @@ export interface ImportJobRequest { } export namespace ImportJobRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ImportJobRequest): any => ({ ...obj, }); @@ -3838,6 +4153,9 @@ export interface CreateImportJobRequest { } export namespace CreateImportJobRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateImportJobRequest): any => ({ ...obj, }); @@ -3889,6 +4207,9 @@ export interface ImportJobResource { } export namespace ImportJobResource { + /** + * @internal + */ export const filterSensitiveLog = (obj: ImportJobResource): any => ({ ...obj, }); @@ -3965,6 +4286,9 @@ export interface ImportJobResponse { } export namespace ImportJobResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ImportJobResponse): any => ({ ...obj, }); @@ -3978,6 +4302,9 @@ export interface CreateImportJobResponse { } export namespace CreateImportJobResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateImportJobResponse): any => ({ ...obj, }); @@ -4009,6 +4336,9 @@ export interface JourneyLimits { } export namespace JourneyLimits { + /** + * @internal + */ export const filterSensitiveLog = (obj: JourneyLimits): any => ({ ...obj, }); @@ -4040,6 +4370,9 @@ export interface JourneySchedule { } export namespace JourneySchedule { + /** + * @internal + */ export const filterSensitiveLog = (obj: JourneySchedule): any => ({ ...obj, }); @@ -4061,6 +4394,9 @@ export interface EventFilter { } export namespace EventFilter { + /** + * @internal + */ export const filterSensitiveLog = (obj: EventFilter): any => ({ ...obj, }); @@ -4079,6 +4415,9 @@ export interface EventStartCondition { } export namespace EventStartCondition { + /** + * @internal + */ export const filterSensitiveLog = (obj: EventStartCondition): any => ({ ...obj, }); @@ -4105,6 +4444,9 @@ export interface StartCondition { } export namespace StartCondition { + /** + * @internal + */ export const filterSensitiveLog = (obj: StartCondition): any => ({ ...obj, }); @@ -4195,6 +4537,9 @@ export interface WriteJourneyRequest { } export namespace WriteJourneyRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: WriteJourneyRequest): any => ({ ...obj, }); @@ -4213,6 +4558,9 @@ export interface CreateJourneyRequest { } export namespace CreateJourneyRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateJourneyRequest): any => ({ ...obj, }); @@ -4309,6 +4657,9 @@ export interface JourneyResponse { } export namespace JourneyResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: JourneyResponse): any => ({ ...obj, }); @@ -4322,6 +4673,9 @@ export interface CreateJourneyResponse { } export namespace CreateJourneyResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateJourneyResponse): any => ({ ...obj, }); @@ -4358,6 +4712,9 @@ export interface DefaultPushNotificationTemplate { } export namespace DefaultPushNotificationTemplate { + /** + * @internal + */ export const filterSensitiveLog = (obj: DefaultPushNotificationTemplate): any => ({ ...obj, }); @@ -4414,6 +4771,9 @@ export interface PushNotificationTemplateRequest { } export namespace PushNotificationTemplateRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: PushNotificationTemplateRequest): any => ({ ...obj, }); @@ -4432,6 +4792,9 @@ export interface CreatePushTemplateRequest { } export namespace CreatePushTemplateRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreatePushTemplateRequest): any => ({ ...obj, }); @@ -4445,6 +4808,9 @@ export interface CreatePushTemplateResponse { } export namespace CreatePushTemplateResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreatePushTemplateResponse): any => ({ ...obj, }); @@ -4501,6 +4867,9 @@ export interface CreateRecommenderConfigurationShape { } export namespace CreateRecommenderConfigurationShape { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateRecommenderConfigurationShape): any => ({ ...obj, }); @@ -4514,6 +4883,9 @@ export interface CreateRecommenderConfigurationRequest { } export namespace CreateRecommenderConfigurationRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateRecommenderConfigurationRequest): any => ({ ...obj, }); @@ -4585,6 +4957,9 @@ export interface RecommenderConfigurationResponse { } export namespace RecommenderConfigurationResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: RecommenderConfigurationResponse): any => ({ ...obj, }); @@ -4598,6 +4973,9 @@ export interface CreateRecommenderConfigurationResponse { } export namespace CreateRecommenderConfigurationResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateRecommenderConfigurationResponse): any => ({ ...obj, }); @@ -4619,6 +4997,9 @@ export interface SegmentReference { } export namespace SegmentReference { + /** + * @internal + */ export const filterSensitiveLog = (obj: SegmentReference): any => ({ ...obj, }); @@ -4662,6 +5043,9 @@ export interface SegmentGroup { } export namespace SegmentGroup { + /** + * @internal + */ export const filterSensitiveLog = (obj: SegmentGroup): any => ({ ...obj, }); @@ -4689,6 +5073,9 @@ export interface SegmentGroupList { } export namespace SegmentGroupList { + /** + * @internal + */ export const filterSensitiveLog = (obj: SegmentGroupList): any => ({ ...obj, }); @@ -4720,6 +5107,9 @@ export interface WriteSegmentRequest { } export namespace WriteSegmentRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: WriteSegmentRequest): any => ({ ...obj, }); @@ -4738,6 +5128,9 @@ export interface CreateSegmentRequest { } export namespace CreateSegmentRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateSegmentRequest): any => ({ ...obj, }); @@ -4779,6 +5172,9 @@ export interface SegmentImportResource { } export namespace SegmentImportResource { + /** + * @internal + */ export const filterSensitiveLog = (obj: SegmentImportResource): any => ({ ...obj, }); @@ -4855,6 +5251,9 @@ export interface SegmentResponse { } export namespace SegmentResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: SegmentResponse): any => ({ ...obj, }); @@ -4868,6 +5267,9 @@ export interface CreateSegmentResponse { } export namespace CreateSegmentResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateSegmentResponse): any => ({ ...obj, }); @@ -4904,6 +5306,9 @@ export interface SMSTemplateRequest { } export namespace SMSTemplateRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: SMSTemplateRequest): any => ({ ...obj, }); @@ -4922,6 +5327,9 @@ export interface CreateSmsTemplateRequest { } export namespace CreateSmsTemplateRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateSmsTemplateRequest): any => ({ ...obj, }); @@ -4935,6 +5343,9 @@ export interface CreateSmsTemplateResponse { } export namespace CreateSmsTemplateResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateSmsTemplateResponse): any => ({ ...obj, }); @@ -4976,6 +5387,9 @@ export interface VoiceTemplateRequest { } export namespace VoiceTemplateRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: VoiceTemplateRequest): any => ({ ...obj, }); @@ -4994,6 +5408,9 @@ export interface CreateVoiceTemplateRequest { } export namespace CreateVoiceTemplateRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateVoiceTemplateRequest): any => ({ ...obj, }); @@ -5007,6 +5424,9 @@ export interface CreateVoiceTemplateResponse { } export namespace CreateVoiceTemplateResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateVoiceTemplateResponse): any => ({ ...obj, }); @@ -5028,6 +5448,9 @@ export interface DefaultMessage { } export namespace DefaultMessage { + /** + * @internal + */ export const filterSensitiveLog = (obj: DefaultMessage): any => ({ ...obj, }); @@ -5074,6 +5497,9 @@ export interface DefaultPushNotificationMessage { } export namespace DefaultPushNotificationMessage { + /** + * @internal + */ export const filterSensitiveLog = (obj: DefaultPushNotificationMessage): any => ({ ...obj, }); @@ -5087,6 +5513,9 @@ export interface DeleteAdmChannelRequest { } export namespace DeleteAdmChannelRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteAdmChannelRequest): any => ({ ...obj, }); @@ -5100,6 +5529,9 @@ export interface DeleteAdmChannelResponse { } export namespace DeleteAdmChannelResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteAdmChannelResponse): any => ({ ...obj, }); @@ -5113,6 +5545,9 @@ export interface DeleteApnsChannelRequest { } export namespace DeleteApnsChannelRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteApnsChannelRequest): any => ({ ...obj, }); @@ -5126,6 +5561,9 @@ export interface DeleteApnsChannelResponse { } export namespace DeleteApnsChannelResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteApnsChannelResponse): any => ({ ...obj, }); @@ -5139,6 +5577,9 @@ export interface DeleteApnsSandboxChannelRequest { } export namespace DeleteApnsSandboxChannelRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteApnsSandboxChannelRequest): any => ({ ...obj, }); @@ -5152,6 +5593,9 @@ export interface DeleteApnsSandboxChannelResponse { } export namespace DeleteApnsSandboxChannelResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteApnsSandboxChannelResponse): any => ({ ...obj, }); @@ -5165,6 +5609,9 @@ export interface DeleteApnsVoipChannelRequest { } export namespace DeleteApnsVoipChannelRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteApnsVoipChannelRequest): any => ({ ...obj, }); @@ -5178,6 +5625,9 @@ export interface DeleteApnsVoipChannelResponse { } export namespace DeleteApnsVoipChannelResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteApnsVoipChannelResponse): any => ({ ...obj, }); @@ -5191,6 +5641,9 @@ export interface DeleteApnsVoipSandboxChannelRequest { } export namespace DeleteApnsVoipSandboxChannelRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteApnsVoipSandboxChannelRequest): any => ({ ...obj, }); @@ -5204,6 +5657,9 @@ export interface DeleteApnsVoipSandboxChannelResponse { } export namespace DeleteApnsVoipSandboxChannelResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteApnsVoipSandboxChannelResponse): any => ({ ...obj, }); @@ -5217,6 +5673,9 @@ export interface DeleteAppRequest { } export namespace DeleteAppRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteAppRequest): any => ({ ...obj, }); @@ -5230,6 +5689,9 @@ export interface DeleteAppResponse { } export namespace DeleteAppResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteAppResponse): any => ({ ...obj, }); @@ -5243,6 +5705,9 @@ export interface DeleteBaiduChannelRequest { } export namespace DeleteBaiduChannelRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteBaiduChannelRequest): any => ({ ...obj, }); @@ -5256,6 +5721,9 @@ export interface DeleteBaiduChannelResponse { } export namespace DeleteBaiduChannelResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteBaiduChannelResponse): any => ({ ...obj, }); @@ -5274,6 +5742,9 @@ export interface DeleteCampaignRequest { } export namespace DeleteCampaignRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteCampaignRequest): any => ({ ...obj, }); @@ -5287,6 +5758,9 @@ export interface DeleteCampaignResponse { } export namespace DeleteCampaignResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteCampaignResponse): any => ({ ...obj, }); @@ -5300,6 +5774,9 @@ export interface DeleteEmailChannelRequest { } export namespace DeleteEmailChannelRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteEmailChannelRequest): any => ({ ...obj, }); @@ -5386,6 +5863,9 @@ export interface EmailChannelResponse { } export namespace EmailChannelResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: EmailChannelResponse): any => ({ ...obj, }); @@ -5399,6 +5879,9 @@ export interface DeleteEmailChannelResponse { } export namespace DeleteEmailChannelResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteEmailChannelResponse): any => ({ ...obj, }); @@ -5417,6 +5900,9 @@ export interface DeleteEmailTemplateRequest { } export namespace DeleteEmailTemplateRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteEmailTemplateRequest): any => ({ ...obj, }); @@ -5438,6 +5924,9 @@ export interface MessageBody { } export namespace MessageBody { + /** + * @internal + */ export const filterSensitiveLog = (obj: MessageBody): any => ({ ...obj, }); @@ -5451,6 +5940,9 @@ export interface DeleteEmailTemplateResponse { } export namespace DeleteEmailTemplateResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteEmailTemplateResponse): any => ({ ...obj, }); @@ -5469,6 +5961,9 @@ export interface DeleteEndpointRequest { } export namespace DeleteEndpointRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteEndpointRequest): any => ({ ...obj, }); @@ -5520,6 +6015,9 @@ export interface EndpointDemographic { } export namespace EndpointDemographic { + /** + * @internal + */ export const filterSensitiveLog = (obj: EndpointDemographic): any => ({ ...obj, }); @@ -5561,6 +6059,9 @@ export interface EndpointLocation { } export namespace EndpointLocation { + /** + * @internal + */ export const filterSensitiveLog = (obj: EndpointLocation): any => ({ ...obj, }); @@ -5582,6 +6083,9 @@ export interface EndpointUser { } export namespace EndpointUser { + /** + * @internal + */ export const filterSensitiveLog = (obj: EndpointUser): any => ({ ...obj, }); @@ -5668,6 +6172,9 @@ export interface EndpointResponse { } export namespace EndpointResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: EndpointResponse): any => ({ ...obj, }); @@ -5681,6 +6188,9 @@ export interface DeleteEndpointResponse { } export namespace DeleteEndpointResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteEndpointResponse): any => ({ ...obj, }); @@ -5694,6 +6204,9 @@ export interface DeleteEventStreamRequest { } export namespace DeleteEventStreamRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteEventStreamRequest): any => ({ ...obj, }); @@ -5737,6 +6250,9 @@ export interface EventStream { } export namespace EventStream { + /** + * @internal + */ export const filterSensitiveLog = (obj: EventStream): any => ({ ...obj, }); @@ -5750,6 +6266,9 @@ export interface DeleteEventStreamResponse { } export namespace DeleteEventStreamResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteEventStreamResponse): any => ({ ...obj, }); @@ -5763,6 +6282,9 @@ export interface DeleteGcmChannelRequest { } export namespace DeleteGcmChannelRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteGcmChannelRequest): any => ({ ...obj, }); @@ -5829,6 +6351,9 @@ export interface GCMChannelResponse { } export namespace GCMChannelResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: GCMChannelResponse): any => ({ ...obj, }); @@ -5842,6 +6367,9 @@ export interface DeleteGcmChannelResponse { } export namespace DeleteGcmChannelResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteGcmChannelResponse): any => ({ ...obj, }); @@ -5860,6 +6388,9 @@ export interface DeleteJourneyRequest { } export namespace DeleteJourneyRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteJourneyRequest): any => ({ ...obj, }); @@ -5873,6 +6404,9 @@ export interface DeleteJourneyResponse { } export namespace DeleteJourneyResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteJourneyResponse): any => ({ ...obj, }); @@ -5891,6 +6425,9 @@ export interface DeletePushTemplateRequest { } export namespace DeletePushTemplateRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeletePushTemplateRequest): any => ({ ...obj, }); @@ -5904,6 +6441,9 @@ export interface DeletePushTemplateResponse { } export namespace DeletePushTemplateResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeletePushTemplateResponse): any => ({ ...obj, }); @@ -5917,6 +6457,9 @@ export interface DeleteRecommenderConfigurationRequest { } export namespace DeleteRecommenderConfigurationRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteRecommenderConfigurationRequest): any => ({ ...obj, }); @@ -5930,6 +6473,9 @@ export interface DeleteRecommenderConfigurationResponse { } export namespace DeleteRecommenderConfigurationResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteRecommenderConfigurationResponse): any => ({ ...obj, }); @@ -5948,6 +6494,9 @@ export interface DeleteSegmentRequest { } export namespace DeleteSegmentRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteSegmentRequest): any => ({ ...obj, }); @@ -5961,6 +6510,9 @@ export interface DeleteSegmentResponse { } export namespace DeleteSegmentResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteSegmentResponse): any => ({ ...obj, }); @@ -5974,6 +6526,9 @@ export interface DeleteSmsChannelRequest { } export namespace DeleteSmsChannelRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteSmsChannelRequest): any => ({ ...obj, }); @@ -6055,6 +6610,9 @@ export interface SMSChannelResponse { } export namespace SMSChannelResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: SMSChannelResponse): any => ({ ...obj, }); @@ -6068,6 +6626,9 @@ export interface DeleteSmsChannelResponse { } export namespace DeleteSmsChannelResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteSmsChannelResponse): any => ({ ...obj, }); @@ -6086,6 +6647,9 @@ export interface DeleteSmsTemplateRequest { } export namespace DeleteSmsTemplateRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteSmsTemplateRequest): any => ({ ...obj, }); @@ -6099,6 +6663,9 @@ export interface DeleteSmsTemplateResponse { } export namespace DeleteSmsTemplateResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteSmsTemplateResponse): any => ({ ...obj, }); @@ -6117,6 +6684,9 @@ export interface DeleteUserEndpointsRequest { } export namespace DeleteUserEndpointsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteUserEndpointsRequest): any => ({ ...obj, }); @@ -6133,6 +6703,9 @@ export interface EndpointsResponse { } export namespace EndpointsResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: EndpointsResponse): any => ({ ...obj, }); @@ -6146,6 +6719,9 @@ export interface DeleteUserEndpointsResponse { } export namespace DeleteUserEndpointsResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteUserEndpointsResponse): any => ({ ...obj, }); @@ -6159,6 +6735,9 @@ export interface DeleteVoiceChannelRequest { } export namespace DeleteVoiceChannelRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteVoiceChannelRequest): any => ({ ...obj, }); @@ -6220,6 +6799,9 @@ export interface VoiceChannelResponse { } export namespace VoiceChannelResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: VoiceChannelResponse): any => ({ ...obj, }); @@ -6233,6 +6815,9 @@ export interface DeleteVoiceChannelResponse { } export namespace DeleteVoiceChannelResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteVoiceChannelResponse): any => ({ ...obj, }); @@ -6251,6 +6836,9 @@ export interface DeleteVoiceTemplateRequest { } export namespace DeleteVoiceTemplateRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteVoiceTemplateRequest): any => ({ ...obj, }); @@ -6264,6 +6852,9 @@ export interface DeleteVoiceTemplateResponse { } export namespace DeleteVoiceTemplateResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteVoiceTemplateResponse): any => ({ ...obj, }); @@ -6290,6 +6881,9 @@ export interface RawEmail { } export namespace RawEmail { + /** + * @internal + */ export const filterSensitiveLog = (obj: RawEmail): any => ({ ...obj, }); @@ -6311,6 +6905,9 @@ export interface SimpleEmailPart { } export namespace SimpleEmailPart { + /** + * @internal + */ export const filterSensitiveLog = (obj: SimpleEmailPart): any => ({ ...obj, }); @@ -6337,6 +6934,9 @@ export interface SimpleEmail { } export namespace SimpleEmail { + /** + * @internal + */ export const filterSensitiveLog = (obj: SimpleEmail): any => ({ ...obj, }); @@ -6383,6 +6983,9 @@ export interface EmailMessage { } export namespace EmailMessage { + /** + * @internal + */ export const filterSensitiveLog = (obj: EmailMessage): any => ({ ...obj, }); @@ -6479,6 +7082,9 @@ export interface GCMMessage { } export namespace GCMMessage { + /** + * @internal + */ export const filterSensitiveLog = (obj: GCMMessage): any => ({ ...obj, }); @@ -6535,6 +7141,9 @@ export interface SMSMessage { } export namespace SMSMessage { + /** + * @internal + */ export const filterSensitiveLog = (obj: SMSMessage): any => ({ ...obj, }); @@ -6571,6 +7180,9 @@ export interface VoiceMessage { } export namespace VoiceMessage { + /** + * @internal + */ export const filterSensitiveLog = (obj: VoiceMessage): any => ({ ...obj, }); @@ -6627,6 +7239,9 @@ export interface DirectMessageConfiguration { } export namespace DirectMessageConfiguration { + /** + * @internal + */ export const filterSensitiveLog = (obj: DirectMessageConfiguration): any => ({ ...obj, }); @@ -6663,6 +7278,9 @@ export interface EmailChannelRequest { } export namespace EmailChannelRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: EmailChannelRequest): any => ({ ...obj, }); @@ -6746,6 +7364,9 @@ export interface EmailTemplateResponse { } export namespace EmailTemplateResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: EmailTemplateResponse): any => ({ ...obj, }); @@ -6817,6 +7438,9 @@ export interface EndpointBatchItem { } export namespace EndpointBatchItem { + /** + * @internal + */ export const filterSensitiveLog = (obj: EndpointBatchItem): any => ({ ...obj, }); @@ -6833,6 +7457,9 @@ export interface EndpointBatchRequest { } export namespace EndpointBatchRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: EndpointBatchRequest): any => ({ ...obj, }); @@ -6854,6 +7481,9 @@ export interface EndpointItemResponse { } export namespace EndpointItemResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: EndpointItemResponse): any => ({ ...obj, }); @@ -6895,6 +7525,9 @@ export interface EndpointMessageResult { } export namespace EndpointMessageResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: EndpointMessageResult): any => ({ ...obj, }); @@ -6961,6 +7594,9 @@ export interface EndpointRequest { } export namespace EndpointRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: EndpointRequest): any => ({ ...obj, }); @@ -6997,6 +7633,9 @@ export interface EndpointSendConfiguration { } export namespace EndpointSendConfiguration { + /** + * @internal + */ export const filterSensitiveLog = (obj: EndpointSendConfiguration): any => ({ ...obj, }); @@ -7028,6 +7667,9 @@ export interface Session { } export namespace Session { + /** + * @internal + */ export const filterSensitiveLog = (obj: Session): any => ({ ...obj, }); @@ -7089,6 +7731,9 @@ export interface Event { } export namespace Event { + /** + * @internal + */ export const filterSensitiveLog = (obj: Event): any => ({ ...obj, }); @@ -7110,6 +7755,9 @@ export interface EventItemResponse { } export namespace EventItemResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: EventItemResponse): any => ({ ...obj, }); @@ -7176,6 +7824,9 @@ export interface PublicEndpoint { } export namespace PublicEndpoint { + /** + * @internal + */ export const filterSensitiveLog = (obj: PublicEndpoint): any => ({ ...obj, }); @@ -7197,6 +7848,9 @@ export interface EventsBatch { } export namespace EventsBatch { + /** + * @internal + */ export const filterSensitiveLog = (obj: EventsBatch): any => ({ ...obj, }); @@ -7213,6 +7867,9 @@ export interface EventsRequest { } export namespace EventsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: EventsRequest): any => ({ ...obj, }); @@ -7234,6 +7891,9 @@ export interface ItemResponse { } export namespace ItemResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ItemResponse): any => ({ ...obj, }); @@ -7250,6 +7910,9 @@ export interface EventsResponse { } export namespace EventsResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: EventsResponse): any => ({ ...obj, }); @@ -7271,6 +7934,9 @@ export interface ExportJobsResponse { } export namespace ExportJobsResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ExportJobsResponse): any => ({ ...obj, }); @@ -7292,6 +7958,9 @@ export interface GCMChannelRequest { } export namespace GCMChannelRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GCMChannelRequest): any => ({ ...obj, }); @@ -7305,6 +7974,9 @@ export interface GetAdmChannelRequest { } export namespace GetAdmChannelRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetAdmChannelRequest): any => ({ ...obj, }); @@ -7318,6 +7990,9 @@ export interface GetAdmChannelResponse { } export namespace GetAdmChannelResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetAdmChannelResponse): any => ({ ...obj, }); @@ -7331,6 +8006,9 @@ export interface GetApnsChannelRequest { } export namespace GetApnsChannelRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetApnsChannelRequest): any => ({ ...obj, }); @@ -7344,6 +8022,9 @@ export interface GetApnsChannelResponse { } export namespace GetApnsChannelResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetApnsChannelResponse): any => ({ ...obj, }); @@ -7357,6 +8038,9 @@ export interface GetApnsSandboxChannelRequest { } export namespace GetApnsSandboxChannelRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetApnsSandboxChannelRequest): any => ({ ...obj, }); @@ -7370,6 +8054,9 @@ export interface GetApnsSandboxChannelResponse { } export namespace GetApnsSandboxChannelResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetApnsSandboxChannelResponse): any => ({ ...obj, }); @@ -7383,6 +8070,9 @@ export interface GetApnsVoipChannelRequest { } export namespace GetApnsVoipChannelRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetApnsVoipChannelRequest): any => ({ ...obj, }); @@ -7396,6 +8086,9 @@ export interface GetApnsVoipChannelResponse { } export namespace GetApnsVoipChannelResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetApnsVoipChannelResponse): any => ({ ...obj, }); @@ -7409,6 +8102,9 @@ export interface GetApnsVoipSandboxChannelRequest { } export namespace GetApnsVoipSandboxChannelRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetApnsVoipSandboxChannelRequest): any => ({ ...obj, }); @@ -7422,6 +8118,9 @@ export interface GetApnsVoipSandboxChannelResponse { } export namespace GetApnsVoipSandboxChannelResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetApnsVoipSandboxChannelResponse): any => ({ ...obj, }); @@ -7435,6 +8134,9 @@ export interface GetAppRequest { } export namespace GetAppRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetAppRequest): any => ({ ...obj, }); @@ -7448,6 +8150,9 @@ export interface GetAppResponse { } export namespace GetAppResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetAppResponse): any => ({ ...obj, }); @@ -7486,6 +8191,9 @@ export interface GetApplicationDateRangeKpiRequest { } export namespace GetApplicationDateRangeKpiRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetApplicationDateRangeKpiRequest): any => ({ ...obj, }); @@ -7499,6 +8207,9 @@ export interface GetApplicationDateRangeKpiResponse { } export namespace GetApplicationDateRangeKpiResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetApplicationDateRangeKpiResponse): any => ({ ...obj, }); @@ -7512,6 +8223,9 @@ export interface GetApplicationSettingsRequest { } export namespace GetApplicationSettingsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetApplicationSettingsRequest): any => ({ ...obj, }); @@ -7525,6 +8239,9 @@ export interface GetApplicationSettingsResponse { } export namespace GetApplicationSettingsResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetApplicationSettingsResponse): any => ({ ...obj, }); @@ -7543,6 +8260,9 @@ export interface GetAppsRequest { } export namespace GetAppsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetAppsRequest): any => ({ ...obj, }); @@ -7556,6 +8276,9 @@ export interface GetAppsResponse { } export namespace GetAppsResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetAppsResponse): any => ({ ...obj, }); @@ -7569,6 +8292,9 @@ export interface GetBaiduChannelRequest { } export namespace GetBaiduChannelRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetBaiduChannelRequest): any => ({ ...obj, }); @@ -7582,6 +8308,9 @@ export interface GetBaiduChannelResponse { } export namespace GetBaiduChannelResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetBaiduChannelResponse): any => ({ ...obj, }); @@ -7600,6 +8329,9 @@ export interface GetCampaignRequest { } export namespace GetCampaignRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetCampaignRequest): any => ({ ...obj, }); @@ -7613,6 +8345,9 @@ export interface GetCampaignResponse { } export namespace GetCampaignResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetCampaignResponse): any => ({ ...obj, }); @@ -7641,6 +8376,9 @@ export interface GetCampaignActivitiesRequest { } export namespace GetCampaignActivitiesRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetCampaignActivitiesRequest): any => ({ ...obj, }); @@ -7654,6 +8392,9 @@ export interface GetCampaignActivitiesResponse { } export namespace GetCampaignActivitiesResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetCampaignActivitiesResponse): any => ({ ...obj, }); @@ -7697,6 +8438,9 @@ export interface GetCampaignDateRangeKpiRequest { } export namespace GetCampaignDateRangeKpiRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetCampaignDateRangeKpiRequest): any => ({ ...obj, }); @@ -7710,6 +8454,9 @@ export interface GetCampaignDateRangeKpiResponse { } export namespace GetCampaignDateRangeKpiResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetCampaignDateRangeKpiResponse): any => ({ ...obj, }); @@ -7733,6 +8480,9 @@ export interface GetCampaignsRequest { } export namespace GetCampaignsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetCampaignsRequest): any => ({ ...obj, }); @@ -7746,6 +8496,9 @@ export interface GetCampaignsResponse { } export namespace GetCampaignsResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetCampaignsResponse): any => ({ ...obj, }); @@ -7769,6 +8522,9 @@ export interface GetCampaignVersionRequest { } export namespace GetCampaignVersionRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetCampaignVersionRequest): any => ({ ...obj, }); @@ -7782,6 +8538,9 @@ export interface GetCampaignVersionResponse { } export namespace GetCampaignVersionResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetCampaignVersionResponse): any => ({ ...obj, }); @@ -7810,6 +8569,9 @@ export interface GetCampaignVersionsRequest { } export namespace GetCampaignVersionsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetCampaignVersionsRequest): any => ({ ...obj, }); @@ -7823,6 +8585,9 @@ export interface GetCampaignVersionsResponse { } export namespace GetCampaignVersionsResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetCampaignVersionsResponse): any => ({ ...obj, }); @@ -7836,6 +8601,9 @@ export interface GetChannelsRequest { } export namespace GetChannelsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetChannelsRequest): any => ({ ...obj, }); @@ -7849,6 +8617,9 @@ export interface GetChannelsResponse { } export namespace GetChannelsResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetChannelsResponse): any => ({ ...obj, }); @@ -7862,6 +8633,9 @@ export interface GetEmailChannelRequest { } export namespace GetEmailChannelRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetEmailChannelRequest): any => ({ ...obj, }); @@ -7875,6 +8649,9 @@ export interface GetEmailChannelResponse { } export namespace GetEmailChannelResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetEmailChannelResponse): any => ({ ...obj, }); @@ -7893,6 +8670,9 @@ export interface GetEmailTemplateRequest { } export namespace GetEmailTemplateRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetEmailTemplateRequest): any => ({ ...obj, }); @@ -7906,6 +8686,9 @@ export interface GetEmailTemplateResponse { } export namespace GetEmailTemplateResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetEmailTemplateResponse): any => ({ ...obj, }); @@ -7924,6 +8707,9 @@ export interface GetEndpointRequest { } export namespace GetEndpointRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetEndpointRequest): any => ({ ...obj, }); @@ -7937,6 +8723,9 @@ export interface GetEndpointResponse { } export namespace GetEndpointResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetEndpointResponse): any => ({ ...obj, }); @@ -7950,6 +8739,9 @@ export interface GetEventStreamRequest { } export namespace GetEventStreamRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetEventStreamRequest): any => ({ ...obj, }); @@ -7963,6 +8755,9 @@ export interface GetEventStreamResponse { } export namespace GetEventStreamResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetEventStreamResponse): any => ({ ...obj, }); @@ -7981,6 +8776,9 @@ export interface GetExportJobRequest { } export namespace GetExportJobRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetExportJobRequest): any => ({ ...obj, }); @@ -7994,6 +8792,9 @@ export interface GetExportJobResponse { } export namespace GetExportJobResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetExportJobResponse): any => ({ ...obj, }); @@ -8017,6 +8818,9 @@ export interface GetExportJobsRequest { } export namespace GetExportJobsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetExportJobsRequest): any => ({ ...obj, }); @@ -8030,6 +8834,9 @@ export interface GetExportJobsResponse { } export namespace GetExportJobsResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetExportJobsResponse): any => ({ ...obj, }); @@ -8043,6 +8850,9 @@ export interface GetGcmChannelRequest { } export namespace GetGcmChannelRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetGcmChannelRequest): any => ({ ...obj, }); @@ -8056,6 +8866,9 @@ export interface GetGcmChannelResponse { } export namespace GetGcmChannelResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetGcmChannelResponse): any => ({ ...obj, }); @@ -8074,6 +8887,9 @@ export interface GetImportJobRequest { } export namespace GetImportJobRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetImportJobRequest): any => ({ ...obj, }); @@ -8087,6 +8903,9 @@ export interface GetImportJobResponse { } export namespace GetImportJobResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetImportJobResponse): any => ({ ...obj, }); @@ -8110,6 +8929,9 @@ export interface GetImportJobsRequest { } export namespace GetImportJobsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetImportJobsRequest): any => ({ ...obj, }); @@ -8131,6 +8953,9 @@ export interface ImportJobsResponse { } export namespace ImportJobsResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ImportJobsResponse): any => ({ ...obj, }); @@ -8144,6 +8969,9 @@ export interface GetImportJobsResponse { } export namespace GetImportJobsResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetImportJobsResponse): any => ({ ...obj, }); @@ -8162,6 +8990,9 @@ export interface GetJourneyRequest { } export namespace GetJourneyRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetJourneyRequest): any => ({ ...obj, }); @@ -8175,6 +9006,9 @@ export interface GetJourneyResponse { } export namespace GetJourneyResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetJourneyResponse): any => ({ ...obj, }); diff --git a/clients/client-pinpoint/models/models_1.ts b/clients/client-pinpoint/models/models_1.ts index 9c2cf40ef8e8..e5f90420a968 100644 --- a/clients/client-pinpoint/models/models_1.ts +++ b/clients/client-pinpoint/models/models_1.ts @@ -94,6 +94,9 @@ export interface GetJourneyDateRangeKpiRequest { } export namespace GetJourneyDateRangeKpiRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetJourneyDateRangeKpiRequest): any => ({ ...obj, }); @@ -140,6 +143,9 @@ export interface JourneyDateRangeKpiResponse { } export namespace JourneyDateRangeKpiResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: JourneyDateRangeKpiResponse): any => ({ ...obj, }); @@ -153,6 +159,9 @@ export interface GetJourneyDateRangeKpiResponse { } export namespace GetJourneyDateRangeKpiResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetJourneyDateRangeKpiResponse): any => ({ ...obj, }); @@ -186,6 +195,9 @@ export interface GetJourneyExecutionActivityMetricsRequest { } export namespace GetJourneyExecutionActivityMetricsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetJourneyExecutionActivityMetricsRequest): any => ({ ...obj, }); @@ -227,6 +239,9 @@ export interface JourneyExecutionActivityMetricsResponse { } export namespace JourneyExecutionActivityMetricsResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: JourneyExecutionActivityMetricsResponse): any => ({ ...obj, }); @@ -240,6 +255,9 @@ export interface GetJourneyExecutionActivityMetricsResponse { } export namespace GetJourneyExecutionActivityMetricsResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetJourneyExecutionActivityMetricsResponse): any => ({ ...obj, }); @@ -268,6 +286,9 @@ export interface GetJourneyExecutionMetricsRequest { } export namespace GetJourneyExecutionMetricsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetJourneyExecutionMetricsRequest): any => ({ ...obj, }); @@ -299,6 +320,9 @@ export interface JourneyExecutionMetricsResponse { } export namespace JourneyExecutionMetricsResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: JourneyExecutionMetricsResponse): any => ({ ...obj, }); @@ -312,6 +336,9 @@ export interface GetJourneyExecutionMetricsResponse { } export namespace GetJourneyExecutionMetricsResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetJourneyExecutionMetricsResponse): any => ({ ...obj, }); @@ -330,6 +357,9 @@ export interface GetPushTemplateRequest { } export namespace GetPushTemplateRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetPushTemplateRequest): any => ({ ...obj, }); @@ -416,6 +446,9 @@ export interface PushNotificationTemplateResponse { } export namespace PushNotificationTemplateResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: PushNotificationTemplateResponse): any => ({ ...obj, }); @@ -429,6 +462,9 @@ export interface GetPushTemplateResponse { } export namespace GetPushTemplateResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetPushTemplateResponse): any => ({ ...obj, }); @@ -442,6 +478,9 @@ export interface GetRecommenderConfigurationRequest { } export namespace GetRecommenderConfigurationRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetRecommenderConfigurationRequest): any => ({ ...obj, }); @@ -455,6 +494,9 @@ export interface GetRecommenderConfigurationResponse { } export namespace GetRecommenderConfigurationResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetRecommenderConfigurationResponse): any => ({ ...obj, }); @@ -473,6 +515,9 @@ export interface GetRecommenderConfigurationsRequest { } export namespace GetRecommenderConfigurationsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetRecommenderConfigurationsRequest): any => ({ ...obj, }); @@ -494,6 +539,9 @@ export interface ListRecommenderConfigurationsResponse { } export namespace ListRecommenderConfigurationsResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListRecommenderConfigurationsResponse): any => ({ ...obj, }); @@ -507,6 +555,9 @@ export interface GetRecommenderConfigurationsResponse { } export namespace GetRecommenderConfigurationsResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetRecommenderConfigurationsResponse): any => ({ ...obj, }); @@ -525,6 +576,9 @@ export interface GetSegmentRequest { } export namespace GetSegmentRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetSegmentRequest): any => ({ ...obj, }); @@ -538,6 +592,9 @@ export interface GetSegmentResponse { } export namespace GetSegmentResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetSegmentResponse): any => ({ ...obj, }); @@ -566,6 +623,9 @@ export interface GetSegmentExportJobsRequest { } export namespace GetSegmentExportJobsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetSegmentExportJobsRequest): any => ({ ...obj, }); @@ -579,6 +639,9 @@ export interface GetSegmentExportJobsResponse { } export namespace GetSegmentExportJobsResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetSegmentExportJobsResponse): any => ({ ...obj, }); @@ -607,6 +670,9 @@ export interface GetSegmentImportJobsRequest { } export namespace GetSegmentImportJobsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetSegmentImportJobsRequest): any => ({ ...obj, }); @@ -620,6 +686,9 @@ export interface GetSegmentImportJobsResponse { } export namespace GetSegmentImportJobsResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetSegmentImportJobsResponse): any => ({ ...obj, }); @@ -643,6 +712,9 @@ export interface GetSegmentsRequest { } export namespace GetSegmentsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetSegmentsRequest): any => ({ ...obj, }); @@ -664,6 +736,9 @@ export interface SegmentsResponse { } export namespace SegmentsResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: SegmentsResponse): any => ({ ...obj, }); @@ -677,6 +752,9 @@ export interface GetSegmentsResponse { } export namespace GetSegmentsResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetSegmentsResponse): any => ({ ...obj, }); @@ -700,6 +778,9 @@ export interface GetSegmentVersionRequest { } export namespace GetSegmentVersionRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetSegmentVersionRequest): any => ({ ...obj, }); @@ -713,6 +794,9 @@ export interface GetSegmentVersionResponse { } export namespace GetSegmentVersionResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetSegmentVersionResponse): any => ({ ...obj, }); @@ -741,6 +825,9 @@ export interface GetSegmentVersionsRequest { } export namespace GetSegmentVersionsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetSegmentVersionsRequest): any => ({ ...obj, }); @@ -754,6 +841,9 @@ export interface GetSegmentVersionsResponse { } export namespace GetSegmentVersionsResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetSegmentVersionsResponse): any => ({ ...obj, }); @@ -767,6 +857,9 @@ export interface GetSmsChannelRequest { } export namespace GetSmsChannelRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetSmsChannelRequest): any => ({ ...obj, }); @@ -780,6 +873,9 @@ export interface GetSmsChannelResponse { } export namespace GetSmsChannelResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetSmsChannelResponse): any => ({ ...obj, }); @@ -798,6 +894,9 @@ export interface GetSmsTemplateRequest { } export namespace GetSmsTemplateRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetSmsTemplateRequest): any => ({ ...obj, }); @@ -864,6 +963,9 @@ export interface SMSTemplateResponse { } export namespace SMSTemplateResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: SMSTemplateResponse): any => ({ ...obj, }); @@ -877,6 +979,9 @@ export interface GetSmsTemplateResponse { } export namespace GetSmsTemplateResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetSmsTemplateResponse): any => ({ ...obj, }); @@ -895,6 +1000,9 @@ export interface GetUserEndpointsRequest { } export namespace GetUserEndpointsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetUserEndpointsRequest): any => ({ ...obj, }); @@ -908,6 +1016,9 @@ export interface GetUserEndpointsResponse { } export namespace GetUserEndpointsResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetUserEndpointsResponse): any => ({ ...obj, }); @@ -921,6 +1032,9 @@ export interface GetVoiceChannelRequest { } export namespace GetVoiceChannelRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetVoiceChannelRequest): any => ({ ...obj, }); @@ -934,6 +1048,9 @@ export interface GetVoiceChannelResponse { } export namespace GetVoiceChannelResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetVoiceChannelResponse): any => ({ ...obj, }); @@ -952,6 +1069,9 @@ export interface GetVoiceTemplateRequest { } export namespace GetVoiceTemplateRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetVoiceTemplateRequest): any => ({ ...obj, }); @@ -1023,6 +1143,9 @@ export interface VoiceTemplateResponse { } export namespace VoiceTemplateResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: VoiceTemplateResponse): any => ({ ...obj, }); @@ -1036,6 +1159,9 @@ export interface GetVoiceTemplateResponse { } export namespace GetVoiceTemplateResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetVoiceTemplateResponse): any => ({ ...obj, }); @@ -1057,6 +1183,9 @@ export interface JourneysResponse { } export namespace JourneysResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: JourneysResponse): any => ({ ...obj, }); @@ -1073,6 +1202,9 @@ export interface JourneyStateRequest { } export namespace JourneyStateRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: JourneyStateRequest): any => ({ ...obj, }); @@ -1096,6 +1228,9 @@ export interface ListJourneysRequest { } export namespace ListJourneysRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListJourneysRequest): any => ({ ...obj, }); @@ -1109,6 +1244,9 @@ export interface ListJourneysResponse { } export namespace ListJourneysResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListJourneysResponse): any => ({ ...obj, }); @@ -1165,6 +1303,9 @@ export interface TemplateResponse { } export namespace TemplateResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: TemplateResponse): any => ({ ...obj, }); @@ -1211,6 +1352,9 @@ export interface TemplateVersionResponse { } export namespace TemplateVersionResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: TemplateVersionResponse): any => ({ ...obj, }); @@ -1224,6 +1368,9 @@ export interface ListTagsForResourceRequest { } export namespace ListTagsForResourceRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListTagsForResourceRequest): any => ({ ...obj, }); @@ -1240,6 +1387,9 @@ export interface TagsModel { } export namespace TagsModel { + /** + * @internal + */ export const filterSensitiveLog = (obj: TagsModel): any => ({ ...obj, }); @@ -1253,6 +1403,9 @@ export interface ListTagsForResourceResponse { } export namespace ListTagsForResourceResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListTagsForResourceResponse): any => ({ ...obj, }); @@ -1281,6 +1434,9 @@ export interface ListTemplatesRequest { } export namespace ListTemplatesRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListTemplatesRequest): any => ({ ...obj, }); @@ -1302,6 +1458,9 @@ export interface TemplatesResponse { } export namespace TemplatesResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: TemplatesResponse): any => ({ ...obj, }); @@ -1315,6 +1474,9 @@ export interface ListTemplatesResponse { } export namespace ListTemplatesResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListTemplatesResponse): any => ({ ...obj, }); @@ -1343,6 +1505,9 @@ export interface ListTemplateVersionsRequest { } export namespace ListTemplateVersionsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListTemplateVersionsRequest): any => ({ ...obj, }); @@ -1374,6 +1539,9 @@ export interface TemplateVersionsResponse { } export namespace TemplateVersionsResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: TemplateVersionsResponse): any => ({ ...obj, }); @@ -1387,6 +1555,9 @@ export interface ListTemplateVersionsResponse { } export namespace ListTemplateVersionsResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListTemplateVersionsResponse): any => ({ ...obj, }); @@ -1423,6 +1594,9 @@ export interface MessageResult { } export namespace MessageResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: MessageResult): any => ({ ...obj, }); @@ -1464,6 +1638,9 @@ export interface MessageRequest { } export namespace MessageRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: MessageRequest): any => ({ ...obj, }); @@ -1495,6 +1672,9 @@ export interface MessageResponse { } export namespace MessageResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: MessageResponse): any => ({ ...obj, }); @@ -1516,6 +1696,9 @@ export interface NumberValidateRequest { } export namespace NumberValidateRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: NumberValidateRequest): any => ({ ...obj, }); @@ -1598,6 +1781,9 @@ export interface NumberValidateResponse { } export namespace NumberValidateResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: NumberValidateResponse): any => ({ ...obj, }); @@ -1611,6 +1797,9 @@ export interface PhoneNumberValidateRequest { } export namespace PhoneNumberValidateRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: PhoneNumberValidateRequest): any => ({ ...obj, }); @@ -1624,6 +1813,9 @@ export interface PhoneNumberValidateResponse { } export namespace PhoneNumberValidateResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: PhoneNumberValidateResponse): any => ({ ...obj, }); @@ -1642,6 +1834,9 @@ export interface PutEventsRequest { } export namespace PutEventsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: PutEventsRequest): any => ({ ...obj, }); @@ -1655,6 +1850,9 @@ export interface PutEventsResponse { } export namespace PutEventsResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: PutEventsResponse): any => ({ ...obj, }); @@ -1678,6 +1876,9 @@ export interface WriteEventStream { } export namespace WriteEventStream { + /** + * @internal + */ export const filterSensitiveLog = (obj: WriteEventStream): any => ({ ...obj, }); @@ -1696,6 +1897,9 @@ export interface PutEventStreamRequest { } export namespace PutEventStreamRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: PutEventStreamRequest): any => ({ ...obj, }); @@ -1709,6 +1913,9 @@ export interface PutEventStreamResponse { } export namespace PutEventStreamResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: PutEventStreamResponse): any => ({ ...obj, }); @@ -1725,6 +1932,9 @@ export interface UpdateAttributesRequest { } export namespace UpdateAttributesRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateAttributesRequest): any => ({ ...obj, }); @@ -1748,6 +1958,9 @@ export interface RemoveAttributesRequest { } export namespace RemoveAttributesRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: RemoveAttributesRequest): any => ({ ...obj, }); @@ -1761,6 +1974,9 @@ export interface RemoveAttributesResponse { } export namespace RemoveAttributesResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: RemoveAttributesResponse): any => ({ ...obj, }); @@ -1779,6 +1995,9 @@ export interface SendMessagesRequest { } export namespace SendMessagesRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: SendMessagesRequest): any => ({ ...obj, }); @@ -1792,6 +2011,9 @@ export interface SendMessagesResponse { } export namespace SendMessagesResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: SendMessagesResponse): any => ({ ...obj, }); @@ -1828,6 +2050,9 @@ export interface SendUsersMessageRequest { } export namespace SendUsersMessageRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: SendUsersMessageRequest): any => ({ ...obj, }); @@ -1846,6 +2071,9 @@ export interface SendUsersMessagesRequest { } export namespace SendUsersMessagesRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: SendUsersMessagesRequest): any => ({ ...obj, }); @@ -1872,6 +2100,9 @@ export interface SendUsersMessageResponse { } export namespace SendUsersMessageResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: SendUsersMessageResponse): any => ({ ...obj, }); @@ -1885,6 +2116,9 @@ export interface SendUsersMessagesResponse { } export namespace SendUsersMessagesResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: SendUsersMessagesResponse): any => ({ ...obj, }); @@ -1903,6 +2137,9 @@ export interface TagResourceRequest { } export namespace TagResourceRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: TagResourceRequest): any => ({ ...obj, }); @@ -1921,6 +2158,9 @@ export interface UntagResourceRequest { } export namespace UntagResourceRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: UntagResourceRequest): any => ({ ...obj, }); @@ -1939,6 +2179,9 @@ export interface UpdateAdmChannelRequest { } export namespace UpdateAdmChannelRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateAdmChannelRequest): any => ({ ...obj, }); @@ -1952,6 +2195,9 @@ export interface UpdateAdmChannelResponse { } export namespace UpdateAdmChannelResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateAdmChannelResponse): any => ({ ...obj, }); @@ -1970,6 +2216,9 @@ export interface UpdateApnsChannelRequest { } export namespace UpdateApnsChannelRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateApnsChannelRequest): any => ({ ...obj, }); @@ -1983,6 +2232,9 @@ export interface UpdateApnsChannelResponse { } export namespace UpdateApnsChannelResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateApnsChannelResponse): any => ({ ...obj, }); @@ -2001,6 +2253,9 @@ export interface UpdateApnsSandboxChannelRequest { } export namespace UpdateApnsSandboxChannelRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateApnsSandboxChannelRequest): any => ({ ...obj, }); @@ -2014,6 +2269,9 @@ export interface UpdateApnsSandboxChannelResponse { } export namespace UpdateApnsSandboxChannelResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateApnsSandboxChannelResponse): any => ({ ...obj, }); @@ -2032,6 +2290,9 @@ export interface UpdateApnsVoipChannelRequest { } export namespace UpdateApnsVoipChannelRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateApnsVoipChannelRequest): any => ({ ...obj, }); @@ -2045,6 +2306,9 @@ export interface UpdateApnsVoipChannelResponse { } export namespace UpdateApnsVoipChannelResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateApnsVoipChannelResponse): any => ({ ...obj, }); @@ -2063,6 +2327,9 @@ export interface UpdateApnsVoipSandboxChannelRequest { } export namespace UpdateApnsVoipSandboxChannelRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateApnsVoipSandboxChannelRequest): any => ({ ...obj, }); @@ -2076,6 +2343,9 @@ export interface UpdateApnsVoipSandboxChannelResponse { } export namespace UpdateApnsVoipSandboxChannelResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateApnsVoipSandboxChannelResponse): any => ({ ...obj, }); @@ -2108,6 +2378,9 @@ export interface WriteApplicationSettingsRequest { } export namespace WriteApplicationSettingsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: WriteApplicationSettingsRequest): any => ({ ...obj, }); @@ -2126,6 +2399,9 @@ export interface UpdateApplicationSettingsRequest { } export namespace UpdateApplicationSettingsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateApplicationSettingsRequest): any => ({ ...obj, }); @@ -2139,6 +2415,9 @@ export interface UpdateApplicationSettingsResponse { } export namespace UpdateApplicationSettingsResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateApplicationSettingsResponse): any => ({ ...obj, }); @@ -2157,6 +2436,9 @@ export interface UpdateBaiduChannelRequest { } export namespace UpdateBaiduChannelRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateBaiduChannelRequest): any => ({ ...obj, }); @@ -2170,6 +2452,9 @@ export interface UpdateBaiduChannelResponse { } export namespace UpdateBaiduChannelResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateBaiduChannelResponse): any => ({ ...obj, }); @@ -2193,6 +2478,9 @@ export interface UpdateCampaignRequest { } export namespace UpdateCampaignRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateCampaignRequest): any => ({ ...obj, }); @@ -2206,6 +2494,9 @@ export interface UpdateCampaignResponse { } export namespace UpdateCampaignResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateCampaignResponse): any => ({ ...obj, }); @@ -2224,6 +2515,9 @@ export interface UpdateEmailChannelRequest { } export namespace UpdateEmailChannelRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateEmailChannelRequest): any => ({ ...obj, }); @@ -2237,6 +2531,9 @@ export interface UpdateEmailChannelResponse { } export namespace UpdateEmailChannelResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateEmailChannelResponse): any => ({ ...obj, }); @@ -2265,6 +2562,9 @@ export interface UpdateEmailTemplateRequest { } export namespace UpdateEmailTemplateRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateEmailTemplateRequest): any => ({ ...obj, }); @@ -2278,6 +2578,9 @@ export interface UpdateEmailTemplateResponse { } export namespace UpdateEmailTemplateResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateEmailTemplateResponse): any => ({ ...obj, }); @@ -2301,6 +2604,9 @@ export interface UpdateEndpointRequest { } export namespace UpdateEndpointRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateEndpointRequest): any => ({ ...obj, }); @@ -2314,6 +2620,9 @@ export interface UpdateEndpointResponse { } export namespace UpdateEndpointResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateEndpointResponse): any => ({ ...obj, }); @@ -2332,6 +2641,9 @@ export interface UpdateEndpointsBatchRequest { } export namespace UpdateEndpointsBatchRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateEndpointsBatchRequest): any => ({ ...obj, }); @@ -2345,6 +2657,9 @@ export interface UpdateEndpointsBatchResponse { } export namespace UpdateEndpointsBatchResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateEndpointsBatchResponse): any => ({ ...obj, }); @@ -2363,6 +2678,9 @@ export interface UpdateGcmChannelRequest { } export namespace UpdateGcmChannelRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateGcmChannelRequest): any => ({ ...obj, }); @@ -2376,6 +2694,9 @@ export interface UpdateGcmChannelResponse { } export namespace UpdateGcmChannelResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateGcmChannelResponse): any => ({ ...obj, }); @@ -2399,6 +2720,9 @@ export interface UpdateJourneyRequest { } export namespace UpdateJourneyRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateJourneyRequest): any => ({ ...obj, }); @@ -2412,6 +2736,9 @@ export interface UpdateJourneyResponse { } export namespace UpdateJourneyResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateJourneyResponse): any => ({ ...obj, }); @@ -2435,6 +2762,9 @@ export interface UpdateJourneyStateRequest { } export namespace UpdateJourneyStateRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateJourneyStateRequest): any => ({ ...obj, }); @@ -2448,6 +2778,9 @@ export interface UpdateJourneyStateResponse { } export namespace UpdateJourneyStateResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateJourneyStateResponse): any => ({ ...obj, }); @@ -2476,6 +2809,9 @@ export interface UpdatePushTemplateRequest { } export namespace UpdatePushTemplateRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdatePushTemplateRequest): any => ({ ...obj, }); @@ -2489,6 +2825,9 @@ export interface UpdatePushTemplateResponse { } export namespace UpdatePushTemplateResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdatePushTemplateResponse): any => ({ ...obj, }); @@ -2545,6 +2884,9 @@ export interface UpdateRecommenderConfigurationShape { } export namespace UpdateRecommenderConfigurationShape { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateRecommenderConfigurationShape): any => ({ ...obj, }); @@ -2563,6 +2905,9 @@ export interface UpdateRecommenderConfigurationRequest { } export namespace UpdateRecommenderConfigurationRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateRecommenderConfigurationRequest): any => ({ ...obj, }); @@ -2576,6 +2921,9 @@ export interface UpdateRecommenderConfigurationResponse { } export namespace UpdateRecommenderConfigurationResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateRecommenderConfigurationResponse): any => ({ ...obj, }); @@ -2599,6 +2947,9 @@ export interface UpdateSegmentRequest { } export namespace UpdateSegmentRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateSegmentRequest): any => ({ ...obj, }); @@ -2612,6 +2963,9 @@ export interface UpdateSegmentResponse { } export namespace UpdateSegmentResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateSegmentResponse): any => ({ ...obj, }); @@ -2638,6 +2992,9 @@ export interface SMSChannelRequest { } export namespace SMSChannelRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: SMSChannelRequest): any => ({ ...obj, }); @@ -2656,6 +3013,9 @@ export interface UpdateSmsChannelRequest { } export namespace UpdateSmsChannelRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateSmsChannelRequest): any => ({ ...obj, }); @@ -2669,6 +3029,9 @@ export interface UpdateSmsChannelResponse { } export namespace UpdateSmsChannelResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateSmsChannelResponse): any => ({ ...obj, }); @@ -2697,6 +3060,9 @@ export interface UpdateSmsTemplateRequest { } export namespace UpdateSmsTemplateRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateSmsTemplateRequest): any => ({ ...obj, }); @@ -2710,6 +3076,9 @@ export interface UpdateSmsTemplateResponse { } export namespace UpdateSmsTemplateResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateSmsTemplateResponse): any => ({ ...obj, }); @@ -2726,6 +3095,9 @@ export interface TemplateActiveVersionRequest { } export namespace TemplateActiveVersionRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: TemplateActiveVersionRequest): any => ({ ...obj, }); @@ -2749,6 +3121,9 @@ export interface UpdateTemplateActiveVersionRequest { } export namespace UpdateTemplateActiveVersionRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateTemplateActiveVersionRequest): any => ({ ...obj, }); @@ -2762,6 +3137,9 @@ export interface UpdateTemplateActiveVersionResponse { } export namespace UpdateTemplateActiveVersionResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateTemplateActiveVersionResponse): any => ({ ...obj, }); @@ -2778,6 +3156,9 @@ export interface VoiceChannelRequest { } export namespace VoiceChannelRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: VoiceChannelRequest): any => ({ ...obj, }); @@ -2796,6 +3177,9 @@ export interface UpdateVoiceChannelRequest { } export namespace UpdateVoiceChannelRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateVoiceChannelRequest): any => ({ ...obj, }); @@ -2809,6 +3193,9 @@ export interface UpdateVoiceChannelResponse { } export namespace UpdateVoiceChannelResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateVoiceChannelResponse): any => ({ ...obj, }); @@ -2837,6 +3224,9 @@ export interface UpdateVoiceTemplateRequest { } export namespace UpdateVoiceTemplateRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateVoiceTemplateRequest): any => ({ ...obj, }); @@ -2850,6 +3240,9 @@ export interface UpdateVoiceTemplateResponse { } export namespace UpdateVoiceTemplateResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateVoiceTemplateResponse): any => ({ ...obj, }); diff --git a/clients/client-polly/commands/DeleteLexiconCommand.ts b/clients/client-polly/commands/DeleteLexiconCommand.ts index d5cb1c854ed3..0a06936e3dd2 100644 --- a/clients/client-polly/commands/DeleteLexiconCommand.ts +++ b/clients/client-polly/commands/DeleteLexiconCommand.ts @@ -26,6 +26,20 @@ export interface DeleteLexiconCommandOutput extends DeleteLexiconOutput, __Metad * using either the GetLexicon or ListLexicon APIs.

*

For more information, see Managing * Lexicons.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { PollyClient, DeleteLexiconCommand } from "@aws-sdk/client-polly"; // ES Modules import + * // const { PollyClient, DeleteLexiconCommand } = require("@aws-sdk/client-polly"); // CommonJS import + * const client = new PollyClient(config); + * const command = new DeleteLexiconCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteLexiconCommandInput} for command's `input` shape. + * @see {@link DeleteLexiconCommandOutput} for command's `response` shape. + * @see {@link PollyClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteLexiconCommand extends $Command< DeleteLexiconCommandInput, diff --git a/clients/client-polly/commands/DescribeVoicesCommand.ts b/clients/client-polly/commands/DescribeVoicesCommand.ts index e5ec27fdffbc..d48cfd3c5ca3 100644 --- a/clients/client-polly/commands/DescribeVoicesCommand.ts +++ b/clients/client-polly/commands/DescribeVoicesCommand.ts @@ -38,6 +38,20 @@ export interface DescribeVoicesCommandOutput extends DescribeVoicesOutput, __Met * English voices.

*

This operation requires permissions to perform the polly:DescribeVoices * action.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { PollyClient, DescribeVoicesCommand } from "@aws-sdk/client-polly"; // ES Modules import + * // const { PollyClient, DescribeVoicesCommand } = require("@aws-sdk/client-polly"); // CommonJS import + * const client = new PollyClient(config); + * const command = new DescribeVoicesCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeVoicesCommandInput} for command's `input` shape. + * @see {@link DescribeVoicesCommandOutput} for command's `response` shape. + * @see {@link PollyClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeVoicesCommand extends $Command< DescribeVoicesCommandInput, diff --git a/clients/client-polly/commands/GetLexiconCommand.ts b/clients/client-polly/commands/GetLexiconCommand.ts index 19003d8143e5..9e8a93b57a68 100644 --- a/clients/client-polly/commands/GetLexiconCommand.ts +++ b/clients/client-polly/commands/GetLexiconCommand.ts @@ -24,6 +24,20 @@ export interface GetLexiconCommandOutput extends GetLexiconOutput, __MetadataBea *

Returns the content of the specified pronunciation lexicon stored in an AWS Region. For * more information, see Managing * Lexicons.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { PollyClient, GetLexiconCommand } from "@aws-sdk/client-polly"; // ES Modules import + * // const { PollyClient, GetLexiconCommand } = require("@aws-sdk/client-polly"); // CommonJS import + * const client = new PollyClient(config); + * const command = new GetLexiconCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetLexiconCommandInput} for command's `input` shape. + * @see {@link GetLexiconCommandOutput} for command's `response` shape. + * @see {@link PollyClientResolvedConfig | config} for command's `input` shape. + * */ export class GetLexiconCommand extends $Command< GetLexiconCommandInput, diff --git a/clients/client-polly/commands/GetSpeechSynthesisTaskCommand.ts b/clients/client-polly/commands/GetSpeechSynthesisTaskCommand.ts index a860c3c85e3c..86bdd8d89678 100644 --- a/clients/client-polly/commands/GetSpeechSynthesisTaskCommand.ts +++ b/clients/client-polly/commands/GetSpeechSynthesisTaskCommand.ts @@ -24,6 +24,20 @@ export interface GetSpeechSynthesisTaskCommandOutput extends GetSpeechSynthesisT *

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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { PollyClient, GetSpeechSynthesisTaskCommand } from "@aws-sdk/client-polly"; // ES Modules import + * // const { PollyClient, GetSpeechSynthesisTaskCommand } = require("@aws-sdk/client-polly"); // CommonJS import + * const client = new PollyClient(config); + * const command = new GetSpeechSynthesisTaskCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetSpeechSynthesisTaskCommandInput} for command's `input` shape. + * @see {@link GetSpeechSynthesisTaskCommandOutput} for command's `response` shape. + * @see {@link PollyClientResolvedConfig | config} for command's `input` shape. + * */ export class GetSpeechSynthesisTaskCommand extends $Command< GetSpeechSynthesisTaskCommandInput, diff --git a/clients/client-polly/commands/ListLexiconsCommand.ts b/clients/client-polly/commands/ListLexiconsCommand.ts index 09d728f4438a..4a89430054b8 100644 --- a/clients/client-polly/commands/ListLexiconsCommand.ts +++ b/clients/client-polly/commands/ListLexiconsCommand.ts @@ -24,6 +24,20 @@ export interface ListLexiconsCommandOutput extends ListLexiconsOutput, __Metadat *

Returns a list of pronunciation lexicons stored in an AWS Region. For more information, * see Managing * Lexicons.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { PollyClient, ListLexiconsCommand } from "@aws-sdk/client-polly"; // ES Modules import + * // const { PollyClient, ListLexiconsCommand } = require("@aws-sdk/client-polly"); // CommonJS import + * const client = new PollyClient(config); + * const command = new ListLexiconsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListLexiconsCommandInput} for command's `input` shape. + * @see {@link ListLexiconsCommandOutput} for command's `response` shape. + * @see {@link PollyClientResolvedConfig | config} for command's `input` shape. + * */ export class ListLexiconsCommand extends $Command< ListLexiconsCommandInput, diff --git a/clients/client-polly/commands/ListSpeechSynthesisTasksCommand.ts b/clients/client-polly/commands/ListSpeechSynthesisTasksCommand.ts index 63344bcb186c..c7eeb3cc590d 100644 --- a/clients/client-polly/commands/ListSpeechSynthesisTasksCommand.ts +++ b/clients/client-polly/commands/ListSpeechSynthesisTasksCommand.ts @@ -24,6 +24,20 @@ export interface ListSpeechSynthesisTasksCommandOutput extends ListSpeechSynthes *

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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { PollyClient, ListSpeechSynthesisTasksCommand } from "@aws-sdk/client-polly"; // ES Modules import + * // const { PollyClient, ListSpeechSynthesisTasksCommand } = require("@aws-sdk/client-polly"); // CommonJS import + * const client = new PollyClient(config); + * const command = new ListSpeechSynthesisTasksCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListSpeechSynthesisTasksCommandInput} for command's `input` shape. + * @see {@link ListSpeechSynthesisTasksCommandOutput} for command's `response` shape. + * @see {@link PollyClientResolvedConfig | config} for command's `input` shape. + * */ export class ListSpeechSynthesisTasksCommand extends $Command< ListSpeechSynthesisTasksCommandInput, diff --git a/clients/client-polly/commands/PutLexiconCommand.ts b/clients/client-polly/commands/PutLexiconCommand.ts index 49d5579ac25b..b9dbf6c1ed41 100644 --- a/clients/client-polly/commands/PutLexiconCommand.ts +++ b/clients/client-polly/commands/PutLexiconCommand.ts @@ -27,6 +27,20 @@ export interface PutLexiconCommandOutput extends PutLexiconOutput, __MetadataBea * the SynthesizeSpeech operation.

*

For more information, see Managing * Lexicons.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { PollyClient, PutLexiconCommand } from "@aws-sdk/client-polly"; // ES Modules import + * // const { PollyClient, PutLexiconCommand } = require("@aws-sdk/client-polly"); // CommonJS import + * const client = new PollyClient(config); + * const command = new PutLexiconCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link PutLexiconCommandInput} for command's `input` shape. + * @see {@link PutLexiconCommandOutput} for command's `response` shape. + * @see {@link PollyClientResolvedConfig | config} for command's `input` shape. + * */ export class PutLexiconCommand extends $Command< PutLexiconCommandInput, diff --git a/clients/client-polly/commands/StartSpeechSynthesisTaskCommand.ts b/clients/client-polly/commands/StartSpeechSynthesisTaskCommand.ts index a367578beed6..640ee7abb726 100644 --- a/clients/client-polly/commands/StartSpeechSynthesisTaskCommand.ts +++ b/clients/client-polly/commands/StartSpeechSynthesisTaskCommand.ts @@ -27,6 +27,20 @@ export interface StartSpeechSynthesisTaskCommandOutput extends StartSpeechSynthe * 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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { PollyClient, StartSpeechSynthesisTaskCommand } from "@aws-sdk/client-polly"; // ES Modules import + * // const { PollyClient, StartSpeechSynthesisTaskCommand } = require("@aws-sdk/client-polly"); // CommonJS import + * const client = new PollyClient(config); + * const command = new StartSpeechSynthesisTaskCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link StartSpeechSynthesisTaskCommandInput} for command's `input` shape. + * @see {@link StartSpeechSynthesisTaskCommandOutput} for command's `response` shape. + * @see {@link PollyClientResolvedConfig | config} for command's `input` shape. + * */ export class StartSpeechSynthesisTaskCommand extends $Command< StartSpeechSynthesisTaskCommandInput, diff --git a/clients/client-polly/commands/SynthesizeSpeechCommand.ts b/clients/client-polly/commands/SynthesizeSpeechCommand.ts index 92ac51499361..a5ee4e6f2dba 100644 --- a/clients/client-polly/commands/SynthesizeSpeechCommand.ts +++ b/clients/client-polly/commands/SynthesizeSpeechCommand.ts @@ -26,6 +26,20 @@ export interface SynthesizeSpeechCommandOutput extends SynthesizeSpeechOutput, _ * example, Cyrillic might not be read at all by English voices) unless phoneme mapping is used. * For more information, see How it * Works.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { PollyClient, SynthesizeSpeechCommand } from "@aws-sdk/client-polly"; // ES Modules import + * // const { PollyClient, SynthesizeSpeechCommand } = require("@aws-sdk/client-polly"); // CommonJS import + * const client = new PollyClient(config); + * const command = new SynthesizeSpeechCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link SynthesizeSpeechCommandInput} for command's `input` shape. + * @see {@link SynthesizeSpeechCommandOutput} for command's `response` shape. + * @see {@link PollyClientResolvedConfig | config} for command's `input` shape. + * */ export class SynthesizeSpeechCommand extends $Command< SynthesizeSpeechCommandInput, diff --git a/clients/client-polly/models/models_0.ts b/clients/client-polly/models/models_0.ts index 045e63d52113..7ad290b99da2 100644 --- a/clients/client-polly/models/models_0.ts +++ b/clients/client-polly/models/models_0.ts @@ -10,6 +10,9 @@ export interface DeleteLexiconInput { } export namespace DeleteLexiconInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteLexiconInput): any => ({ ...obj, }); @@ -18,6 +21,9 @@ export namespace DeleteLexiconInput { export interface DeleteLexiconOutput {} export namespace DeleteLexiconOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteLexiconOutput): any => ({ ...obj, }); @@ -37,6 +43,9 @@ export interface LexiconNotFoundException extends __SmithyException, $MetadataBe } export namespace LexiconNotFoundException { + /** + * @internal + */ export const filterSensitiveLog = (obj: LexiconNotFoundException): any => ({ ...obj, }); @@ -52,6 +61,9 @@ export interface ServiceFailureException extends __SmithyException, $MetadataBea } export namespace ServiceFailureException { + /** + * @internal + */ export const filterSensitiveLog = (obj: ServiceFailureException): any => ({ ...obj, }); @@ -124,6 +136,9 @@ export interface DescribeVoicesInput { } export namespace DescribeVoicesInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeVoicesInput): any => ({ ...obj, }); @@ -243,6 +258,9 @@ export interface Voice { } export namespace Voice { + /** + * @internal + */ export const filterSensitiveLog = (obj: Voice): any => ({ ...obj, }); @@ -262,6 +280,9 @@ export interface DescribeVoicesOutput { } export namespace DescribeVoicesOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeVoicesOutput): any => ({ ...obj, }); @@ -278,6 +299,9 @@ export interface InvalidNextTokenException extends __SmithyException, $MetadataB } export namespace InvalidNextTokenException { + /** + * @internal + */ export const filterSensitiveLog = (obj: InvalidNextTokenException): any => ({ ...obj, }); @@ -294,6 +318,9 @@ export interface EngineNotSupportedException extends __SmithyException, $Metadat } export namespace EngineNotSupportedException { + /** + * @internal + */ export const filterSensitiveLog = (obj: EngineNotSupportedException): any => ({ ...obj, }); @@ -307,6 +334,9 @@ export interface GetLexiconInput { } export namespace GetLexiconInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetLexiconInput): any => ({ ...obj, }); @@ -331,6 +361,9 @@ export interface Lexicon { } export namespace Lexicon { + /** + * @internal + */ export const filterSensitiveLog = (obj: Lexicon): any => ({ ...obj, ...(obj.Content && { Content: SENSITIVE_STRING }), @@ -377,6 +410,9 @@ export interface LexiconAttributes { } export namespace LexiconAttributes { + /** + * @internal + */ export const filterSensitiveLog = (obj: LexiconAttributes): any => ({ ...obj, }); @@ -396,6 +432,9 @@ export interface GetLexiconOutput { } export namespace GetLexiconOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetLexiconOutput): any => ({ ...obj, ...(obj.Lexicon && { Lexicon: Lexicon.filterSensitiveLog(obj.Lexicon) }), @@ -410,6 +449,9 @@ export interface GetSpeechSynthesisTaskInput { } export namespace GetSpeechSynthesisTaskInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetSpeechSynthesisTaskInput): any => ({ ...obj, }); @@ -539,6 +581,9 @@ export interface SynthesisTask { } export namespace SynthesisTask { + /** + * @internal + */ export const filterSensitiveLog = (obj: SynthesisTask): any => ({ ...obj, }); @@ -553,6 +598,9 @@ export interface GetSpeechSynthesisTaskOutput { } export namespace GetSpeechSynthesisTaskOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetSpeechSynthesisTaskOutput): any => ({ ...obj, }); @@ -568,6 +616,9 @@ export interface InvalidTaskIdException extends __SmithyException, $MetadataBear } export namespace InvalidTaskIdException { + /** + * @internal + */ export const filterSensitiveLog = (obj: InvalidTaskIdException): any => ({ ...obj, }); @@ -583,6 +634,9 @@ export interface SynthesisTaskNotFoundException extends __SmithyException, $Meta } export namespace SynthesisTaskNotFoundException { + /** + * @internal + */ export const filterSensitiveLog = (obj: SynthesisTaskNotFoundException): any => ({ ...obj, }); @@ -599,6 +653,9 @@ export interface InvalidLexiconException extends __SmithyException, $MetadataBea } export namespace InvalidLexiconException { + /** + * @internal + */ export const filterSensitiveLog = (obj: InvalidLexiconException): any => ({ ...obj, }); @@ -615,6 +672,9 @@ export interface InvalidS3BucketException extends __SmithyException, $MetadataBe } export namespace InvalidS3BucketException { + /** + * @internal + */ export const filterSensitiveLog = (obj: InvalidS3BucketException): any => ({ ...obj, }); @@ -631,6 +691,9 @@ export interface InvalidS3KeyException extends __SmithyException, $MetadataBeare } export namespace InvalidS3KeyException { + /** + * @internal + */ export const filterSensitiveLog = (obj: InvalidS3KeyException): any => ({ ...obj, }); @@ -646,6 +709,9 @@ export interface InvalidSampleRateException extends __SmithyException, $Metadata } export namespace InvalidSampleRateException { + /** + * @internal + */ export const filterSensitiveLog = (obj: InvalidSampleRateException): any => ({ ...obj, }); @@ -662,6 +728,9 @@ export interface InvalidSnsTopicArnException extends __SmithyException, $Metadat } export namespace InvalidSnsTopicArnException { + /** + * @internal + */ export const filterSensitiveLog = (obj: InvalidSnsTopicArnException): any => ({ ...obj, }); @@ -678,6 +747,9 @@ export interface InvalidSsmlException extends __SmithyException, $MetadataBearer } export namespace InvalidSsmlException { + /** + * @internal + */ export const filterSensitiveLog = (obj: InvalidSsmlException): any => ({ ...obj, }); @@ -693,6 +765,9 @@ export interface LanguageNotSupportedException extends __SmithyException, $Metad } export namespace LanguageNotSupportedException { + /** + * @internal + */ export const filterSensitiveLog = (obj: LanguageNotSupportedException): any => ({ ...obj, }); @@ -714,6 +789,9 @@ export interface LexiconDescription { } export namespace LexiconDescription { + /** + * @internal + */ export const filterSensitiveLog = (obj: LexiconDescription): any => ({ ...obj, }); @@ -730,6 +808,9 @@ export interface LexiconSizeExceededException extends __SmithyException, $Metada } export namespace LexiconSizeExceededException { + /** + * @internal + */ export const filterSensitiveLog = (obj: LexiconSizeExceededException): any => ({ ...obj, }); @@ -744,6 +825,9 @@ export interface ListLexiconsInput { } export namespace ListLexiconsInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListLexiconsInput): any => ({ ...obj, }); @@ -763,6 +847,9 @@ export interface ListLexiconsOutput { } export namespace ListLexiconsOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListLexiconsOutput): any => ({ ...obj, }); @@ -787,6 +874,9 @@ export interface ListSpeechSynthesisTasksInput { } export namespace ListSpeechSynthesisTasksInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListSpeechSynthesisTasksInput): any => ({ ...obj, }); @@ -807,6 +897,9 @@ export interface ListSpeechSynthesisTasksOutput { } export namespace ListSpeechSynthesisTasksOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListSpeechSynthesisTasksOutput): any => ({ ...obj, }); @@ -823,6 +916,9 @@ export interface MarksNotSupportedForFormatException extends __SmithyException, } export namespace MarksNotSupportedForFormatException { + /** + * @internal + */ export const filterSensitiveLog = (obj: MarksNotSupportedForFormatException): any => ({ ...obj, }); @@ -838,6 +934,9 @@ export interface MaxLexemeLengthExceededException extends __SmithyException, $Me } export namespace MaxLexemeLengthExceededException { + /** + * @internal + */ export const filterSensitiveLog = (obj: MaxLexemeLengthExceededException): any => ({ ...obj, }); @@ -853,6 +952,9 @@ export interface MaxLexiconsNumberExceededException extends __SmithyException, $ } export namespace MaxLexiconsNumberExceededException { + /** + * @internal + */ export const filterSensitiveLog = (obj: MaxLexiconsNumberExceededException): any => ({ ...obj, }); @@ -872,6 +974,9 @@ export interface PutLexiconInput { } export namespace PutLexiconInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: PutLexiconInput): any => ({ ...obj, ...(obj.Content && { Content: SENSITIVE_STRING }), @@ -881,6 +986,9 @@ export namespace PutLexiconInput { export interface PutLexiconOutput {} export namespace PutLexiconOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: PutLexiconOutput): any => ({ ...obj, }); @@ -897,6 +1005,9 @@ export interface UnsupportedPlsAlphabetException extends __SmithyException, $Met } export namespace UnsupportedPlsAlphabetException { + /** + * @internal + */ export const filterSensitiveLog = (obj: UnsupportedPlsAlphabetException): any => ({ ...obj, }); @@ -914,6 +1025,9 @@ export interface UnsupportedPlsLanguageException extends __SmithyException, $Met } export namespace UnsupportedPlsLanguageException { + /** + * @internal + */ export const filterSensitiveLog = (obj: UnsupportedPlsLanguageException): any => ({ ...obj, }); @@ -929,6 +1043,9 @@ export interface SsmlMarksNotSupportedForTextTypeException extends __SmithyExcep } export namespace SsmlMarksNotSupportedForTextTypeException { + /** + * @internal + */ export const filterSensitiveLog = (obj: SsmlMarksNotSupportedForTextTypeException): any => ({ ...obj, }); @@ -1015,6 +1132,9 @@ export interface StartSpeechSynthesisTaskInput { } export namespace StartSpeechSynthesisTaskInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: StartSpeechSynthesisTaskInput): any => ({ ...obj, }); @@ -1029,6 +1149,9 @@ export interface StartSpeechSynthesisTaskOutput { } export namespace StartSpeechSynthesisTaskOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: StartSpeechSynthesisTaskOutput): any => ({ ...obj, }); @@ -1049,6 +1172,9 @@ export interface TextLengthExceededException extends __SmithyException, $Metadat } export namespace TextLengthExceededException { + /** + * @internal + */ export const filterSensitiveLog = (obj: TextLengthExceededException): any => ({ ...obj, }); @@ -1139,6 +1265,9 @@ export interface SynthesizeSpeechInput { } export namespace SynthesizeSpeechInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: SynthesizeSpeechInput): any => ({ ...obj, }); @@ -1183,6 +1312,9 @@ export interface SynthesizeSpeechOutput { } export namespace SynthesizeSpeechOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: SynthesizeSpeechOutput): any => ({ ...obj, }); diff --git a/clients/client-pricing/commands/DescribeServicesCommand.ts b/clients/client-pricing/commands/DescribeServicesCommand.ts index a9c595baa7c4..9ea1bfbdf383 100644 --- a/clients/client-pricing/commands/DescribeServicesCommand.ts +++ b/clients/client-pricing/commands/DescribeServicesCommand.ts @@ -28,6 +28,20 @@ export interface DescribeServicesCommandOutput extends DescribeServicesResponse, * names available for that service. For example, some of the attribute names available for EC2 are * volumeType, maxIopsVolume, operation, * locationType, and instanceCapacity10xlarge.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { PricingClient, DescribeServicesCommand } from "@aws-sdk/client-pricing"; // ES Modules import + * // const { PricingClient, DescribeServicesCommand } = require("@aws-sdk/client-pricing"); // CommonJS import + * const client = new PricingClient(config); + * const command = new DescribeServicesCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeServicesCommandInput} for command's `input` shape. + * @see {@link DescribeServicesCommandOutput} for command's `response` shape. + * @see {@link PricingClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeServicesCommand extends $Command< DescribeServicesCommandInput, diff --git a/clients/client-pricing/commands/GetAttributeValuesCommand.ts b/clients/client-pricing/commands/GetAttributeValuesCommand.ts index 75a96b981e5e..435734cbac3c 100644 --- a/clients/client-pricing/commands/GetAttributeValuesCommand.ts +++ b/clients/client-pricing/commands/GetAttributeValuesCommand.ts @@ -25,6 +25,20 @@ export interface GetAttributeValuesCommandOutput extends GetAttributeValuesRespo * in a Price List API offer file. For a list of available attributes, see * Offer File Definitions * in the AWS Billing and Cost Management User Guide.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { PricingClient, GetAttributeValuesCommand } from "@aws-sdk/client-pricing"; // ES Modules import + * // const { PricingClient, GetAttributeValuesCommand } = require("@aws-sdk/client-pricing"); // CommonJS import + * const client = new PricingClient(config); + * const command = new GetAttributeValuesCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetAttributeValuesCommandInput} for command's `input` shape. + * @see {@link GetAttributeValuesCommandOutput} for command's `response` shape. + * @see {@link PricingClientResolvedConfig | config} for command's `input` shape. + * */ export class GetAttributeValuesCommand extends $Command< GetAttributeValuesCommandInput, diff --git a/clients/client-pricing/commands/GetProductsCommand.ts b/clients/client-pricing/commands/GetProductsCommand.ts index 2ca37a732183..1cd8b16a319b 100644 --- a/clients/client-pricing/commands/GetProductsCommand.ts +++ b/clients/client-pricing/commands/GetProductsCommand.ts @@ -22,6 +22,20 @@ export interface GetProductsCommandOutput extends GetProductsResponse, __Metadat /** *

Returns a list of all products that match the filter criteria.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { PricingClient, GetProductsCommand } from "@aws-sdk/client-pricing"; // ES Modules import + * // const { PricingClient, GetProductsCommand } = require("@aws-sdk/client-pricing"); // CommonJS import + * const client = new PricingClient(config); + * const command = new GetProductsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetProductsCommandInput} for command's `input` shape. + * @see {@link GetProductsCommandOutput} for command's `response` shape. + * @see {@link PricingClientResolvedConfig | config} for command's `input` shape. + * */ export class GetProductsCommand extends $Command< GetProductsCommandInput, diff --git a/clients/client-pricing/models/models_0.ts b/clients/client-pricing/models/models_0.ts index 10e0d74503fb..16d3e109664c 100644 --- a/clients/client-pricing/models/models_0.ts +++ b/clients/client-pricing/models/models_0.ts @@ -14,6 +14,9 @@ export interface AttributeValue { } export namespace AttributeValue { + /** + * @internal + */ export const filterSensitiveLog = (obj: AttributeValue): any => ({ ...obj, }); @@ -47,6 +50,9 @@ export interface DescribeServicesRequest { } export namespace DescribeServicesRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeServicesRequest): any => ({ ...obj, }); @@ -68,6 +74,9 @@ export interface Service { } export namespace Service { + /** + * @internal + */ export const filterSensitiveLog = (obj: Service): any => ({ ...obj, }); @@ -91,6 +100,9 @@ export interface DescribeServicesResponse { } export namespace DescribeServicesResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeServicesResponse): any => ({ ...obj, }); @@ -106,6 +118,9 @@ export interface ExpiredNextTokenException extends __SmithyException, $MetadataB } export namespace ExpiredNextTokenException { + /** + * @internal + */ export const filterSensitiveLog = (obj: ExpiredNextTokenException): any => ({ ...obj, }); @@ -121,6 +136,9 @@ export interface InternalErrorException extends __SmithyException, $MetadataBear } export namespace InternalErrorException { + /** + * @internal + */ export const filterSensitiveLog = (obj: InternalErrorException): any => ({ ...obj, }); @@ -136,6 +154,9 @@ export interface InvalidNextTokenException extends __SmithyException, $MetadataB } export namespace InvalidNextTokenException { + /** + * @internal + */ export const filterSensitiveLog = (obj: InvalidNextTokenException): any => ({ ...obj, }); @@ -151,6 +172,9 @@ export interface InvalidParameterException extends __SmithyException, $MetadataB } export namespace InvalidParameterException { + /** + * @internal + */ export const filterSensitiveLog = (obj: InvalidParameterException): any => ({ ...obj, }); @@ -166,6 +190,9 @@ export interface NotFoundException extends __SmithyException, $MetadataBearer { } export namespace NotFoundException { + /** + * @internal + */ export const filterSensitiveLog = (obj: NotFoundException): any => ({ ...obj, }); @@ -195,6 +222,9 @@ export interface GetAttributeValuesRequest { } export namespace GetAttributeValuesRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetAttributeValuesRequest): any => ({ ...obj, }); @@ -215,6 +245,9 @@ export interface GetAttributeValuesResponse { } export namespace GetAttributeValuesResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetAttributeValuesResponse): any => ({ ...obj, }); @@ -257,6 +290,9 @@ export interface Filter { } export namespace Filter { + /** + * @internal + */ export const filterSensitiveLog = (obj: Filter): any => ({ ...obj, }); @@ -293,6 +329,9 @@ export interface GetProductsRequest { } export namespace GetProductsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetProductsRequest): any => ({ ...obj, }); @@ -317,6 +356,9 @@ export interface GetProductsResponse { } export namespace GetProductsResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetProductsResponse): any => ({ ...obj, }); diff --git a/clients/client-qldb-session/commands/SendCommandCommand.ts b/clients/client-qldb-session/commands/SendCommandCommand.ts index 827a4c0187b1..7284ccb1a9af 100644 --- a/clients/client-qldb-session/commands/SendCommandCommand.ts +++ b/clients/client-qldb-session/commands/SendCommandCommand.ts @@ -42,6 +42,20 @@ export interface SendCommandCommandOutput extends SendCommandResult, __MetadataB * * * + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { QLDBSessionClient, SendCommandCommand } from "@aws-sdk/client-qldb-session"; // ES Modules import + * // const { QLDBSessionClient, SendCommandCommand } = require("@aws-sdk/client-qldb-session"); // CommonJS import + * const client = new QLDBSessionClient(config); + * const command = new SendCommandCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link SendCommandCommandInput} for command's `input` shape. + * @see {@link SendCommandCommandOutput} for command's `response` shape. + * @see {@link QLDBSessionClientResolvedConfig | config} for command's `input` shape. + * */ export class SendCommandCommand extends $Command< SendCommandCommandInput, diff --git a/clients/client-qldb-session/models/models_0.ts b/clients/client-qldb-session/models/models_0.ts index c629572859e2..112b52eb38df 100644 --- a/clients/client-qldb-session/models/models_0.ts +++ b/clients/client-qldb-session/models/models_0.ts @@ -7,6 +7,9 @@ import { MetadataBearer as $MetadataBearer } from "@aws-sdk/types"; export interface AbortTransactionRequest {} export namespace AbortTransactionRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: AbortTransactionRequest): any => ({ ...obj, }); @@ -26,6 +29,9 @@ export interface TimingInformation { } export namespace TimingInformation { + /** + * @internal + */ export const filterSensitiveLog = (obj: TimingInformation): any => ({ ...obj, }); @@ -42,6 +48,9 @@ export interface AbortTransactionResult { } export namespace AbortTransactionResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: AbortTransactionResult): any => ({ ...obj, }); @@ -59,6 +68,9 @@ export interface BadRequestException extends __SmithyException, $MetadataBearer } export namespace BadRequestException { + /** + * @internal + */ export const filterSensitiveLog = (obj: BadRequestException): any => ({ ...obj, }); @@ -74,6 +86,9 @@ export interface CapacityExceededException extends __SmithyException, $MetadataB } export namespace CapacityExceededException { + /** + * @internal + */ export const filterSensitiveLog = (obj: CapacityExceededException): any => ({ ...obj, }); @@ -101,6 +116,9 @@ export interface CommitTransactionRequest { } export namespace CommitTransactionRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: CommitTransactionRequest): any => ({ ...obj, }); @@ -122,6 +140,9 @@ export interface IOUsage { } export namespace IOUsage { + /** + * @internal + */ export const filterSensitiveLog = (obj: IOUsage): any => ({ ...obj, }); @@ -153,6 +174,9 @@ export interface CommitTransactionResult { } export namespace CommitTransactionResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: CommitTransactionResult): any => ({ ...obj, }); @@ -164,6 +188,9 @@ export namespace CommitTransactionResult { export interface EndSessionRequest {} export namespace EndSessionRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: EndSessionRequest): any => ({ ...obj, }); @@ -180,6 +207,9 @@ export interface EndSessionResult { } export namespace EndSessionResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: EndSessionResult): any => ({ ...obj, }); @@ -201,6 +231,9 @@ export interface ValueHolder { } export namespace ValueHolder { + /** + * @internal + */ export const filterSensitiveLog = (obj: ValueHolder): any => ({ ...obj, }); @@ -227,6 +260,9 @@ export interface ExecuteStatementRequest { } export namespace ExecuteStatementRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ExecuteStatementRequest): any => ({ ...obj, }); @@ -248,6 +284,9 @@ export interface Page { } export namespace Page { + /** + * @internal + */ export const filterSensitiveLog = (obj: Page): any => ({ ...obj, }); @@ -274,6 +313,9 @@ export interface ExecuteStatementResult { } export namespace ExecuteStatementResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: ExecuteStatementResult): any => ({ ...obj, }); @@ -295,6 +337,9 @@ export interface FetchPageRequest { } export namespace FetchPageRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: FetchPageRequest): any => ({ ...obj, }); @@ -321,6 +366,9 @@ export interface FetchPageResult { } export namespace FetchPageResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: FetchPageResult): any => ({ ...obj, }); @@ -337,6 +385,9 @@ export interface InvalidSessionException extends __SmithyException, $MetadataBea } export namespace InvalidSessionException { + /** + * @internal + */ export const filterSensitiveLog = (obj: InvalidSessionException): any => ({ ...obj, }); @@ -352,6 +403,9 @@ export interface LimitExceededException extends __SmithyException, $MetadataBear } export namespace LimitExceededException { + /** + * @internal + */ export const filterSensitiveLog = (obj: LimitExceededException): any => ({ ...obj, }); @@ -368,6 +422,9 @@ export interface OccConflictException extends __SmithyException, $MetadataBearer } export namespace OccConflictException { + /** + * @internal + */ export const filterSensitiveLog = (obj: OccConflictException): any => ({ ...obj, }); @@ -383,6 +440,9 @@ export interface RateExceededException extends __SmithyException, $MetadataBeare } export namespace RateExceededException { + /** + * @internal + */ export const filterSensitiveLog = (obj: RateExceededException): any => ({ ...obj, }); @@ -399,6 +459,9 @@ export interface StartSessionRequest { } export namespace StartSessionRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: StartSessionRequest): any => ({ ...obj, }); @@ -410,6 +473,9 @@ export namespace StartSessionRequest { export interface StartTransactionRequest {} export namespace StartTransactionRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: StartTransactionRequest): any => ({ ...obj, }); @@ -463,6 +529,9 @@ export interface SendCommandRequest { } export namespace SendCommandRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: SendCommandRequest): any => ({ ...obj, }); @@ -485,6 +554,9 @@ export interface StartSessionResult { } export namespace StartSessionResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: StartSessionResult): any => ({ ...obj, }); @@ -506,6 +578,9 @@ export interface StartTransactionResult { } export namespace StartTransactionResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: StartTransactionResult): any => ({ ...obj, }); @@ -551,6 +626,9 @@ export interface SendCommandResult { } export namespace SendCommandResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: SendCommandResult): any => ({ ...obj, }); diff --git a/clients/client-qldb/commands/CancelJournalKinesisStreamCommand.ts b/clients/client-qldb/commands/CancelJournalKinesisStreamCommand.ts index c52b1902ee10..c25dd2bee011 100644 --- a/clients/client-qldb/commands/CancelJournalKinesisStreamCommand.ts +++ b/clients/client-qldb/commands/CancelJournalKinesisStreamCommand.ts @@ -26,6 +26,20 @@ export interface CancelJournalKinesisStreamCommandOutput extends CancelJournalKi *

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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { QLDBClient, CancelJournalKinesisStreamCommand } from "@aws-sdk/client-qldb"; // ES Modules import + * // const { QLDBClient, CancelJournalKinesisStreamCommand } = require("@aws-sdk/client-qldb"); // CommonJS import + * const client = new QLDBClient(config); + * const command = new CancelJournalKinesisStreamCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CancelJournalKinesisStreamCommandInput} for command's `input` shape. + * @see {@link CancelJournalKinesisStreamCommandOutput} for command's `response` shape. + * @see {@link QLDBClientResolvedConfig | config} for command's `input` shape. + * */ export class CancelJournalKinesisStreamCommand extends $Command< CancelJournalKinesisStreamCommandInput, diff --git a/clients/client-qldb/commands/CreateLedgerCommand.ts b/clients/client-qldb/commands/CreateLedgerCommand.ts index 353a44245ab0..551c02d8238d 100644 --- a/clients/client-qldb/commands/CreateLedgerCommand.ts +++ b/clients/client-qldb/commands/CreateLedgerCommand.ts @@ -22,6 +22,20 @@ export interface CreateLedgerCommandOutput extends CreateLedgerResponse, __Metad /** *

Creates a new ledger in your AWS account.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { QLDBClient, CreateLedgerCommand } from "@aws-sdk/client-qldb"; // ES Modules import + * // const { QLDBClient, CreateLedgerCommand } = require("@aws-sdk/client-qldb"); // CommonJS import + * const client = new QLDBClient(config); + * const command = new CreateLedgerCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreateLedgerCommandInput} for command's `input` shape. + * @see {@link CreateLedgerCommandOutput} for command's `response` shape. + * @see {@link QLDBClientResolvedConfig | config} for command's `input` shape. + * */ export class CreateLedgerCommand extends $Command< CreateLedgerCommandInput, diff --git a/clients/client-qldb/commands/DeleteLedgerCommand.ts b/clients/client-qldb/commands/DeleteLedgerCommand.ts index f5a4f92ceb22..9fbecda00076 100644 --- a/clients/client-qldb/commands/DeleteLedgerCommand.ts +++ b/clients/client-qldb/commands/DeleteLedgerCommand.ts @@ -26,6 +26,20 @@ export interface DeleteLedgerCommandOutput extends __MetadataBearer {} * ledger using the QLDB API or the AWS Command Line Interface (AWS CLI). You can disable it by calling the * UpdateLedger operation to set the flag to false. The QLDB * console disables deletion protection for you when you use it to delete a ledger.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { QLDBClient, DeleteLedgerCommand } from "@aws-sdk/client-qldb"; // ES Modules import + * // const { QLDBClient, DeleteLedgerCommand } = require("@aws-sdk/client-qldb"); // CommonJS import + * const client = new QLDBClient(config); + * const command = new DeleteLedgerCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteLedgerCommandInput} for command's `input` shape. + * @see {@link DeleteLedgerCommandOutput} for command's `response` shape. + * @see {@link QLDBClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteLedgerCommand extends $Command< DeleteLedgerCommandInput, diff --git a/clients/client-qldb/commands/DescribeJournalKinesisStreamCommand.ts b/clients/client-qldb/commands/DescribeJournalKinesisStreamCommand.ts index 9f36c3bdc2e5..00bd3d3fff93 100644 --- a/clients/client-qldb/commands/DescribeJournalKinesisStreamCommand.ts +++ b/clients/client-qldb/commands/DescribeJournalKinesisStreamCommand.ts @@ -26,6 +26,20 @@ export interface DescribeJournalKinesisStreamCommandOutput *

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 your original stream creation request.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { QLDBClient, DescribeJournalKinesisStreamCommand } from "@aws-sdk/client-qldb"; // ES Modules import + * // const { QLDBClient, DescribeJournalKinesisStreamCommand } = require("@aws-sdk/client-qldb"); // CommonJS import + * const client = new QLDBClient(config); + * const command = new DescribeJournalKinesisStreamCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeJournalKinesisStreamCommandInput} for command's `input` shape. + * @see {@link DescribeJournalKinesisStreamCommandOutput} for command's `response` shape. + * @see {@link QLDBClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeJournalKinesisStreamCommand extends $Command< DescribeJournalKinesisStreamCommandInput, diff --git a/clients/client-qldb/commands/DescribeJournalS3ExportCommand.ts b/clients/client-qldb/commands/DescribeJournalS3ExportCommand.ts index 5505071ef7fc..c497328b50eb 100644 --- a/clients/client-qldb/commands/DescribeJournalS3ExportCommand.ts +++ b/clients/client-qldb/commands/DescribeJournalS3ExportCommand.ts @@ -29,6 +29,20 @@ export interface DescribeJournalS3ExportCommandOutput extends DescribeJournalS3E * ResourceNotFoundException.

*

If the ledger with the given Name doesn't exist, then throws * ResourceNotFoundException.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { QLDBClient, DescribeJournalS3ExportCommand } from "@aws-sdk/client-qldb"; // ES Modules import + * // const { QLDBClient, DescribeJournalS3ExportCommand } = require("@aws-sdk/client-qldb"); // CommonJS import + * const client = new QLDBClient(config); + * const command = new DescribeJournalS3ExportCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeJournalS3ExportCommandInput} for command's `input` shape. + * @see {@link DescribeJournalS3ExportCommandOutput} for command's `response` shape. + * @see {@link QLDBClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeJournalS3ExportCommand extends $Command< DescribeJournalS3ExportCommandInput, diff --git a/clients/client-qldb/commands/DescribeLedgerCommand.ts b/clients/client-qldb/commands/DescribeLedgerCommand.ts index 70ab80fca30e..cb69b1c7b300 100644 --- a/clients/client-qldb/commands/DescribeLedgerCommand.ts +++ b/clients/client-qldb/commands/DescribeLedgerCommand.ts @@ -22,6 +22,20 @@ export interface DescribeLedgerCommandOutput extends DescribeLedgerResponse, __M /** *

Returns information about a ledger, including its state and when it was created.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { QLDBClient, DescribeLedgerCommand } from "@aws-sdk/client-qldb"; // ES Modules import + * // const { QLDBClient, DescribeLedgerCommand } = require("@aws-sdk/client-qldb"); // CommonJS import + * const client = new QLDBClient(config); + * const command = new DescribeLedgerCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeLedgerCommandInput} for command's `input` shape. + * @see {@link DescribeLedgerCommandOutput} for command's `response` shape. + * @see {@link QLDBClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeLedgerCommand extends $Command< DescribeLedgerCommandInput, diff --git a/clients/client-qldb/commands/ExportJournalToS3Command.ts b/clients/client-qldb/commands/ExportJournalToS3Command.ts index a25fa659d526..976b109d2345 100644 --- a/clients/client-qldb/commands/ExportJournalToS3Command.ts +++ b/clients/client-qldb/commands/ExportJournalToS3Command.ts @@ -29,6 +29,20 @@ export interface ExportJournalToS3CommandOutput extends ExportJournalToS3Respons * throws ResourcePreconditionNotMetException.

*

You can initiate up to two concurrent journal export requests for each ledger. Beyond * this limit, journal export requests throw LimitExceededException.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { QLDBClient, ExportJournalToS3Command } from "@aws-sdk/client-qldb"; // ES Modules import + * // const { QLDBClient, ExportJournalToS3Command } = require("@aws-sdk/client-qldb"); // CommonJS import + * const client = new QLDBClient(config); + * const command = new ExportJournalToS3Command(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ExportJournalToS3CommandInput} for command's `input` shape. + * @see {@link ExportJournalToS3CommandOutput} for command's `response` shape. + * @see {@link QLDBClientResolvedConfig | config} for command's `input` shape. + * */ export class ExportJournalToS3Command extends $Command< ExportJournalToS3CommandInput, diff --git a/clients/client-qldb/commands/GetBlockCommand.ts b/clients/client-qldb/commands/GetBlockCommand.ts index 5a632af13833..ac6b8a71eaaf 100644 --- a/clients/client-qldb/commands/GetBlockCommand.ts +++ b/clients/client-qldb/commands/GetBlockCommand.ts @@ -31,6 +31,20 @@ export interface GetBlockCommandOutput extends GetBlockResponse, __MetadataBeare * ResourcePreconditionNotMetException.

*

If no block exists with the specified address, then throws * InvalidParameterException.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { QLDBClient, GetBlockCommand } from "@aws-sdk/client-qldb"; // ES Modules import + * // const { QLDBClient, GetBlockCommand } = require("@aws-sdk/client-qldb"); // CommonJS import + * const client = new QLDBClient(config); + * const command = new GetBlockCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetBlockCommandInput} for command's `input` shape. + * @see {@link GetBlockCommandOutput} for command's `response` shape. + * @see {@link QLDBClientResolvedConfig | config} for command's `input` shape. + * */ export class GetBlockCommand extends $Command { // Start section: command_properties diff --git a/clients/client-qldb/commands/GetDigestCommand.ts b/clients/client-qldb/commands/GetDigestCommand.ts index ba059f429465..2791f2d1e100 100644 --- a/clients/client-qldb/commands/GetDigestCommand.ts +++ b/clients/client-qldb/commands/GetDigestCommand.ts @@ -23,6 +23,20 @@ export interface GetDigestCommandOutput extends GetDigestResponse, __MetadataBea /** *

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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { QLDBClient, GetDigestCommand } from "@aws-sdk/client-qldb"; // ES Modules import + * // const { QLDBClient, GetDigestCommand } = require("@aws-sdk/client-qldb"); // CommonJS import + * const client = new QLDBClient(config); + * const command = new GetDigestCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetDigestCommandInput} for command's `input` shape. + * @see {@link GetDigestCommandOutput} for command's `response` shape. + * @see {@link QLDBClientResolvedConfig | config} for command's `input` shape. + * */ export class GetDigestCommand extends $Command< GetDigestCommandInput, diff --git a/clients/client-qldb/commands/GetRevisionCommand.ts b/clients/client-qldb/commands/GetRevisionCommand.ts index a32f9d0a086f..0ae72cde24c5 100644 --- a/clients/client-qldb/commands/GetRevisionCommand.ts +++ b/clients/client-qldb/commands/GetRevisionCommand.ts @@ -24,6 +24,20 @@ export interface GetRevisionCommandOutput extends GetRevisionResponse, __Metadat *

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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { QLDBClient, GetRevisionCommand } from "@aws-sdk/client-qldb"; // ES Modules import + * // const { QLDBClient, GetRevisionCommand } = require("@aws-sdk/client-qldb"); // CommonJS import + * const client = new QLDBClient(config); + * const command = new GetRevisionCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetRevisionCommandInput} for command's `input` shape. + * @see {@link GetRevisionCommandOutput} for command's `response` shape. + * @see {@link QLDBClientResolvedConfig | config} for command's `input` shape. + * */ export class GetRevisionCommand extends $Command< GetRevisionCommandInput, diff --git a/clients/client-qldb/commands/ListJournalKinesisStreamsForLedgerCommand.ts b/clients/client-qldb/commands/ListJournalKinesisStreamsForLedgerCommand.ts index 45b19eae0028..97eb5693956b 100644 --- a/clients/client-qldb/commands/ListJournalKinesisStreamsForLedgerCommand.ts +++ b/clients/client-qldb/commands/ListJournalKinesisStreamsForLedgerCommand.ts @@ -32,6 +32,20 @@ export interface ListJournalKinesisStreamsForLedgerCommandOutput *

This action returns a maximum of MaxResults items. It is paginated so that * you can retrieve all the items by calling ListJournalKinesisStreamsForLedger * multiple times.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { QLDBClient, ListJournalKinesisStreamsForLedgerCommand } from "@aws-sdk/client-qldb"; // ES Modules import + * // const { QLDBClient, ListJournalKinesisStreamsForLedgerCommand } = require("@aws-sdk/client-qldb"); // CommonJS import + * const client = new QLDBClient(config); + * const command = new ListJournalKinesisStreamsForLedgerCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListJournalKinesisStreamsForLedgerCommandInput} for command's `input` shape. + * @see {@link ListJournalKinesisStreamsForLedgerCommandOutput} for command's `response` shape. + * @see {@link QLDBClientResolvedConfig | config} for command's `input` shape. + * */ export class ListJournalKinesisStreamsForLedgerCommand extends $Command< ListJournalKinesisStreamsForLedgerCommandInput, diff --git a/clients/client-qldb/commands/ListJournalS3ExportsCommand.ts b/clients/client-qldb/commands/ListJournalS3ExportsCommand.ts index a547a6cf196d..dafc34607466 100644 --- a/clients/client-qldb/commands/ListJournalS3ExportsCommand.ts +++ b/clients/client-qldb/commands/ListJournalS3ExportsCommand.ts @@ -28,6 +28,20 @@ export interface ListJournalS3ExportsCommandOutput extends ListJournalS3ExportsR * times.

*

This action does not return any expired export jobs. For more information, see Export Job Expiration in the Amazon QLDB Developer * Guide.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { QLDBClient, ListJournalS3ExportsCommand } from "@aws-sdk/client-qldb"; // ES Modules import + * // const { QLDBClient, ListJournalS3ExportsCommand } = require("@aws-sdk/client-qldb"); // CommonJS import + * const client = new QLDBClient(config); + * const command = new ListJournalS3ExportsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListJournalS3ExportsCommandInput} for command's `input` shape. + * @see {@link ListJournalS3ExportsCommandOutput} for command's `response` shape. + * @see {@link QLDBClientResolvedConfig | config} for command's `input` shape. + * */ export class ListJournalS3ExportsCommand extends $Command< ListJournalS3ExportsCommandInput, diff --git a/clients/client-qldb/commands/ListJournalS3ExportsForLedgerCommand.ts b/clients/client-qldb/commands/ListJournalS3ExportsForLedgerCommand.ts index 992ccc89e978..8cd603675bbd 100644 --- a/clients/client-qldb/commands/ListJournalS3ExportsForLedgerCommand.ts +++ b/clients/client-qldb/commands/ListJournalS3ExportsForLedgerCommand.ts @@ -29,6 +29,20 @@ export interface ListJournalS3ExportsForLedgerCommandOutput * multiple times.

*

This action does not return any expired export jobs. For more information, see Export Job Expiration in the Amazon QLDB Developer * Guide.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { QLDBClient, ListJournalS3ExportsForLedgerCommand } from "@aws-sdk/client-qldb"; // ES Modules import + * // const { QLDBClient, ListJournalS3ExportsForLedgerCommand } = require("@aws-sdk/client-qldb"); // CommonJS import + * const client = new QLDBClient(config); + * const command = new ListJournalS3ExportsForLedgerCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListJournalS3ExportsForLedgerCommandInput} for command's `input` shape. + * @see {@link ListJournalS3ExportsForLedgerCommandOutput} for command's `response` shape. + * @see {@link QLDBClientResolvedConfig | config} for command's `input` shape. + * */ export class ListJournalS3ExportsForLedgerCommand extends $Command< ListJournalS3ExportsForLedgerCommandInput, diff --git a/clients/client-qldb/commands/ListLedgersCommand.ts b/clients/client-qldb/commands/ListLedgersCommand.ts index af15abc3990f..152df5bc47a3 100644 --- a/clients/client-qldb/commands/ListLedgersCommand.ts +++ b/clients/client-qldb/commands/ListLedgersCommand.ts @@ -25,6 +25,20 @@ export interface ListLedgersCommandOutput extends ListLedgersResponse, __Metadat * 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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { QLDBClient, ListLedgersCommand } from "@aws-sdk/client-qldb"; // ES Modules import + * // const { QLDBClient, ListLedgersCommand } = require("@aws-sdk/client-qldb"); // CommonJS import + * const client = new QLDBClient(config); + * const command = new ListLedgersCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListLedgersCommandInput} for command's `input` shape. + * @see {@link ListLedgersCommandOutput} for command's `response` shape. + * @see {@link QLDBClientResolvedConfig | config} for command's `input` shape. + * */ export class ListLedgersCommand extends $Command< ListLedgersCommandInput, diff --git a/clients/client-qldb/commands/ListTagsForResourceCommand.ts b/clients/client-qldb/commands/ListTagsForResourceCommand.ts index 9056d6df446f..281f76ee51ef 100644 --- a/clients/client-qldb/commands/ListTagsForResourceCommand.ts +++ b/clients/client-qldb/commands/ListTagsForResourceCommand.ts @@ -22,6 +22,20 @@ export interface ListTagsForResourceCommandOutput extends ListTagsForResourceRes /** *

Returns all tags for a specified Amazon QLDB resource.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { QLDBClient, ListTagsForResourceCommand } from "@aws-sdk/client-qldb"; // ES Modules import + * // const { QLDBClient, ListTagsForResourceCommand } = require("@aws-sdk/client-qldb"); // CommonJS import + * const client = new QLDBClient(config); + * const command = new ListTagsForResourceCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListTagsForResourceCommandInput} for command's `input` shape. + * @see {@link ListTagsForResourceCommandOutput} for command's `response` shape. + * @see {@link QLDBClientResolvedConfig | config} for command's `input` shape. + * */ export class ListTagsForResourceCommand extends $Command< ListTagsForResourceCommandInput, diff --git a/clients/client-qldb/commands/StreamJournalToKinesisCommand.ts b/clients/client-qldb/commands/StreamJournalToKinesisCommand.ts index 02474882c55a..b5113eaf8771 100644 --- a/clients/client-qldb/commands/StreamJournalToKinesisCommand.ts +++ b/clients/client-qldb/commands/StreamJournalToKinesisCommand.ts @@ -24,6 +24,20 @@ export interface StreamJournalToKinesisCommandOutput extends StreamJournalToKine *

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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { QLDBClient, StreamJournalToKinesisCommand } from "@aws-sdk/client-qldb"; // ES Modules import + * // const { QLDBClient, StreamJournalToKinesisCommand } = require("@aws-sdk/client-qldb"); // CommonJS import + * const client = new QLDBClient(config); + * const command = new StreamJournalToKinesisCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link StreamJournalToKinesisCommandInput} for command's `input` shape. + * @see {@link StreamJournalToKinesisCommandOutput} for command's `response` shape. + * @see {@link QLDBClientResolvedConfig | config} for command's `input` shape. + * */ export class StreamJournalToKinesisCommand extends $Command< StreamJournalToKinesisCommandInput, diff --git a/clients/client-qldb/commands/TagResourceCommand.ts b/clients/client-qldb/commands/TagResourceCommand.ts index b77f6821c1b7..1c9d19562866 100644 --- a/clients/client-qldb/commands/TagResourceCommand.ts +++ b/clients/client-qldb/commands/TagResourceCommand.ts @@ -24,6 +24,20 @@ export interface TagResourceCommandOutput extends TagResourceResponse, __Metadat *

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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { QLDBClient, TagResourceCommand } from "@aws-sdk/client-qldb"; // ES Modules import + * // const { QLDBClient, TagResourceCommand } = require("@aws-sdk/client-qldb"); // CommonJS import + * const client = new QLDBClient(config); + * const command = new TagResourceCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link TagResourceCommandInput} for command's `input` shape. + * @see {@link TagResourceCommandOutput} for command's `response` shape. + * @see {@link QLDBClientResolvedConfig | config} for command's `input` shape. + * */ export class TagResourceCommand extends $Command< TagResourceCommandInput, diff --git a/clients/client-qldb/commands/UntagResourceCommand.ts b/clients/client-qldb/commands/UntagResourceCommand.ts index 75eb237a5b70..6881f724bf28 100644 --- a/clients/client-qldb/commands/UntagResourceCommand.ts +++ b/clients/client-qldb/commands/UntagResourceCommand.ts @@ -23,6 +23,20 @@ export interface UntagResourceCommandOutput extends UntagResourceResponse, __Met /** *

Removes one or more tags from a specified Amazon QLDB resource. You can specify up to 50 * tag keys to remove.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { QLDBClient, UntagResourceCommand } from "@aws-sdk/client-qldb"; // ES Modules import + * // const { QLDBClient, UntagResourceCommand } = require("@aws-sdk/client-qldb"); // CommonJS import + * const client = new QLDBClient(config); + * const command = new UntagResourceCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link UntagResourceCommandInput} for command's `input` shape. + * @see {@link UntagResourceCommandOutput} for command's `response` shape. + * @see {@link QLDBClientResolvedConfig | config} for command's `input` shape. + * */ export class UntagResourceCommand extends $Command< UntagResourceCommandInput, diff --git a/clients/client-qldb/commands/UpdateLedgerCommand.ts b/clients/client-qldb/commands/UpdateLedgerCommand.ts index b23d4dec2ac5..292b20922765 100644 --- a/clients/client-qldb/commands/UpdateLedgerCommand.ts +++ b/clients/client-qldb/commands/UpdateLedgerCommand.ts @@ -22,6 +22,20 @@ export interface UpdateLedgerCommandOutput extends UpdateLedgerResponse, __Metad /** *

Updates properties on a ledger.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { QLDBClient, UpdateLedgerCommand } from "@aws-sdk/client-qldb"; // ES Modules import + * // const { QLDBClient, UpdateLedgerCommand } = require("@aws-sdk/client-qldb"); // CommonJS import + * const client = new QLDBClient(config); + * const command = new UpdateLedgerCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link UpdateLedgerCommandInput} for command's `input` shape. + * @see {@link UpdateLedgerCommandOutput} for command's `response` shape. + * @see {@link QLDBClientResolvedConfig | config} for command's `input` shape. + * */ export class UpdateLedgerCommand extends $Command< UpdateLedgerCommandInput, diff --git a/clients/client-qldb/models/models_0.ts b/clients/client-qldb/models/models_0.ts index 89ea40833b4a..10872f2cbf56 100644 --- a/clients/client-qldb/models/models_0.ts +++ b/clients/client-qldb/models/models_0.ts @@ -14,6 +14,9 @@ export interface CancelJournalKinesisStreamRequest { } export namespace CancelJournalKinesisStreamRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: CancelJournalKinesisStreamRequest): any => ({ ...obj, }); @@ -27,6 +30,9 @@ export interface CancelJournalKinesisStreamResponse { } export namespace CancelJournalKinesisStreamResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: CancelJournalKinesisStreamResponse): any => ({ ...obj, }); @@ -46,6 +52,9 @@ export interface InvalidParameterException extends __SmithyException, $MetadataB } export namespace InvalidParameterException { + /** + * @internal + */ export const filterSensitiveLog = (obj: InvalidParameterException): any => ({ ...obj, }); @@ -70,6 +79,9 @@ export interface ResourceNotFoundException extends __SmithyException, $MetadataB } export namespace ResourceNotFoundException { + /** + * @internal + */ export const filterSensitiveLog = (obj: ResourceNotFoundException): any => ({ ...obj, }); @@ -94,6 +106,9 @@ export interface ResourcePreconditionNotMetException extends __SmithyException, } export namespace ResourcePreconditionNotMetException { + /** + * @internal + */ export const filterSensitiveLog = (obj: ResourcePreconditionNotMetException): any => ({ ...obj, }); @@ -135,6 +150,9 @@ export interface CreateLedgerRequest { } export namespace CreateLedgerRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateLedgerRequest): any => ({ ...obj, }); @@ -181,6 +199,9 @@ export interface CreateLedgerResponse { } export namespace CreateLedgerResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateLedgerResponse): any => ({ ...obj, }); @@ -200,6 +221,9 @@ export interface LimitExceededException extends __SmithyException, $MetadataBear } export namespace LimitExceededException { + /** + * @internal + */ export const filterSensitiveLog = (obj: LimitExceededException): any => ({ ...obj, }); @@ -224,6 +248,9 @@ export interface ResourceAlreadyExistsException extends __SmithyException, $Meta } export namespace ResourceAlreadyExistsException { + /** + * @internal + */ export const filterSensitiveLog = (obj: ResourceAlreadyExistsException): any => ({ ...obj, }); @@ -248,6 +275,9 @@ export interface ResourceInUseException extends __SmithyException, $MetadataBear } export namespace ResourceInUseException { + /** + * @internal + */ export const filterSensitiveLog = (obj: ResourceInUseException): any => ({ ...obj, }); @@ -261,6 +291,9 @@ export interface DeleteLedgerRequest { } export namespace DeleteLedgerRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteLedgerRequest): any => ({ ...obj, }); @@ -279,6 +312,9 @@ export interface DescribeJournalKinesisStreamRequest { } export namespace DescribeJournalKinesisStreamRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeJournalKinesisStreamRequest): any => ({ ...obj, }); @@ -308,6 +344,9 @@ export interface KinesisConfiguration { } export namespace KinesisConfiguration { + /** + * @internal + */ export const filterSensitiveLog = (obj: KinesisConfiguration): any => ({ ...obj, }); @@ -391,6 +430,9 @@ export interface JournalKinesisStreamDescription { } export namespace JournalKinesisStreamDescription { + /** + * @internal + */ export const filterSensitiveLog = (obj: JournalKinesisStreamDescription): any => ({ ...obj, }); @@ -405,6 +447,9 @@ export interface DescribeJournalKinesisStreamResponse { } export namespace DescribeJournalKinesisStreamResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeJournalKinesisStreamResponse): any => ({ ...obj, }); @@ -423,6 +468,9 @@ export interface DescribeJournalS3ExportRequest { } export namespace DescribeJournalS3ExportRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeJournalS3ExportRequest): any => ({ ...obj, }); @@ -460,6 +508,9 @@ export interface S3EncryptionConfiguration { } export namespace S3EncryptionConfiguration { + /** + * @internal + */ export const filterSensitiveLog = (obj: S3EncryptionConfiguration): any => ({ ...obj, }); @@ -513,6 +564,9 @@ export interface S3ExportConfiguration { } export namespace S3ExportConfiguration { + /** + * @internal + */ export const filterSensitiveLog = (obj: S3ExportConfiguration): any => ({ ...obj, }); @@ -585,6 +639,9 @@ export interface JournalS3ExportDescription { } export namespace JournalS3ExportDescription { + /** + * @internal + */ export const filterSensitiveLog = (obj: JournalS3ExportDescription): any => ({ ...obj, }); @@ -599,6 +656,9 @@ export interface DescribeJournalS3ExportResponse { } export namespace DescribeJournalS3ExportResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeJournalS3ExportResponse): any => ({ ...obj, }); @@ -612,6 +672,9 @@ export interface DescribeLedgerRequest { } export namespace DescribeLedgerRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeLedgerRequest): any => ({ ...obj, }); @@ -651,6 +714,9 @@ export interface DescribeLedgerResponse { } export namespace DescribeLedgerResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeLedgerResponse): any => ({ ...obj, }); @@ -711,6 +777,9 @@ export interface ExportJournalToS3Request { } export namespace ExportJournalToS3Request { + /** + * @internal + */ export const filterSensitiveLog = (obj: ExportJournalToS3Request): any => ({ ...obj, }); @@ -726,6 +795,9 @@ export interface ExportJournalToS3Response { } export namespace ExportJournalToS3Response { + /** + * @internal + */ export const filterSensitiveLog = (obj: ExportJournalToS3Response): any => ({ ...obj, }); @@ -742,6 +814,9 @@ export interface ValueHolder { } export namespace ValueHolder { + /** + * @internal + */ export const filterSensitiveLog = (obj: ValueHolder): any => ({ ...obj, ...(obj.IonText && { IonText: SENSITIVE_STRING }), @@ -773,6 +848,9 @@ export interface GetBlockRequest { } export namespace GetBlockRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetBlockRequest): any => ({ ...obj, ...(obj.BlockAddress && { BlockAddress: SENSITIVE_STRING }), @@ -795,6 +873,9 @@ export interface GetBlockResponse { } export namespace GetBlockResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetBlockResponse): any => ({ ...obj, ...(obj.Block && { Block: SENSITIVE_STRING }), @@ -810,6 +891,9 @@ export interface GetDigestRequest { } export namespace GetDigestRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetDigestRequest): any => ({ ...obj, }); @@ -831,6 +915,9 @@ export interface GetDigestResponse { } export namespace GetDigestResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetDigestResponse): any => ({ ...obj, ...(obj.DigestTipAddress && { DigestTipAddress: SENSITIVE_STRING }), @@ -867,6 +954,9 @@ export interface GetRevisionRequest { } export namespace GetRevisionRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetRevisionRequest): any => ({ ...obj, ...(obj.BlockAddress && { BlockAddress: SENSITIVE_STRING }), @@ -889,6 +979,9 @@ export interface GetRevisionResponse { } export namespace GetRevisionResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetRevisionResponse): any => ({ ...obj, ...(obj.Proof && { Proof: SENSITIVE_STRING }), @@ -919,6 +1012,9 @@ export interface ListJournalKinesisStreamsForLedgerRequest { } export namespace ListJournalKinesisStreamsForLedgerRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListJournalKinesisStreamsForLedgerRequest): any => ({ ...obj, }); @@ -949,6 +1045,9 @@ export interface ListJournalKinesisStreamsForLedgerResponse { } export namespace ListJournalKinesisStreamsForLedgerResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListJournalKinesisStreamsForLedgerResponse): any => ({ ...obj, }); @@ -971,6 +1070,9 @@ export interface ListJournalS3ExportsRequest { } export namespace ListJournalS3ExportsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListJournalS3ExportsRequest): any => ({ ...obj, }); @@ -1001,6 +1103,9 @@ export interface ListJournalS3ExportsResponse { } export namespace ListJournalS3ExportsResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListJournalS3ExportsResponse): any => ({ ...obj, }); @@ -1029,6 +1134,9 @@ export interface ListJournalS3ExportsForLedgerRequest { } export namespace ListJournalS3ExportsForLedgerRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListJournalS3ExportsForLedgerRequest): any => ({ ...obj, }); @@ -1059,6 +1167,9 @@ export interface ListJournalS3ExportsForLedgerResponse { } export namespace ListJournalS3ExportsForLedgerResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListJournalS3ExportsForLedgerResponse): any => ({ ...obj, }); @@ -1080,6 +1191,9 @@ export interface ListLedgersRequest { } export namespace ListLedgersRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListLedgersRequest): any => ({ ...obj, }); @@ -1107,6 +1221,9 @@ export interface LedgerSummary { } export namespace LedgerSummary { + /** + * @internal + */ export const filterSensitiveLog = (obj: LedgerSummary): any => ({ ...obj, }); @@ -1137,6 +1254,9 @@ export interface ListLedgersResponse { } export namespace ListLedgersResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListLedgersResponse): any => ({ ...obj, }); @@ -1153,6 +1273,9 @@ export interface ListTagsForResourceRequest { } export namespace ListTagsForResourceRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListTagsForResourceRequest): any => ({ ...obj, }); @@ -1166,6 +1289,9 @@ export interface ListTagsForResourceResponse { } export namespace ListTagsForResourceResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListTagsForResourceResponse): any => ({ ...obj, }); @@ -1229,6 +1355,9 @@ export interface StreamJournalToKinesisRequest { } export namespace StreamJournalToKinesisRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: StreamJournalToKinesisRequest): any => ({ ...obj, }); @@ -1242,6 +1371,9 @@ export interface StreamJournalToKinesisResponse { } export namespace StreamJournalToKinesisResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: StreamJournalToKinesisResponse): any => ({ ...obj, }); @@ -1265,6 +1397,9 @@ export interface TagResourceRequest { } export namespace TagResourceRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: TagResourceRequest): any => ({ ...obj, }); @@ -1273,6 +1408,9 @@ export namespace TagResourceRequest { export interface TagResourceResponse {} export namespace TagResourceResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: TagResourceResponse): any => ({ ...obj, }); @@ -1295,6 +1433,9 @@ export interface UntagResourceRequest { } export namespace UntagResourceRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: UntagResourceRequest): any => ({ ...obj, }); @@ -1303,6 +1444,9 @@ export namespace UntagResourceRequest { export interface UntagResourceResponse {} export namespace UntagResourceResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: UntagResourceResponse): any => ({ ...obj, }); @@ -1326,6 +1470,9 @@ export interface UpdateLedgerRequest { } export namespace UpdateLedgerRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateLedgerRequest): any => ({ ...obj, }); @@ -1365,6 +1512,9 @@ export interface UpdateLedgerResponse { } export namespace UpdateLedgerResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateLedgerResponse): any => ({ ...obj, }); diff --git a/clients/client-quicksight/commands/CancelIngestionCommand.ts b/clients/client-quicksight/commands/CancelIngestionCommand.ts index 23cce8164301..50e2c27f0a8a 100644 --- a/clients/client-quicksight/commands/CancelIngestionCommand.ts +++ b/clients/client-quicksight/commands/CancelIngestionCommand.ts @@ -22,6 +22,20 @@ export interface CancelIngestionCommandOutput extends CancelIngestionResponse, _ /** *

Cancels an ongoing ingestion of data into SPICE.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { QuickSightClient, CancelIngestionCommand } from "@aws-sdk/client-quicksight"; // ES Modules import + * // const { QuickSightClient, CancelIngestionCommand } = require("@aws-sdk/client-quicksight"); // CommonJS import + * const client = new QuickSightClient(config); + * const command = new CancelIngestionCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CancelIngestionCommandInput} for command's `input` shape. + * @see {@link CancelIngestionCommandOutput} for command's `response` shape. + * @see {@link QuickSightClientResolvedConfig | config} for command's `input` shape. + * */ export class CancelIngestionCommand extends $Command< CancelIngestionCommandInput, diff --git a/clients/client-quicksight/commands/CreateAccountCustomizationCommand.ts b/clients/client-quicksight/commands/CreateAccountCustomizationCommand.ts index 7dc5ebee16db..b252d2d43d75 100644 --- a/clients/client-quicksight/commands/CreateAccountCustomizationCommand.ts +++ b/clients/client-quicksight/commands/CreateAccountCustomizationCommand.ts @@ -43,6 +43,20 @@ export interface CreateAccountCustomizationCommandOutput extends CreateAccountCu * * UpdateThemePermissions * API operation.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { QuickSightClient, CreateAccountCustomizationCommand } from "@aws-sdk/client-quicksight"; // ES Modules import + * // const { QuickSightClient, CreateAccountCustomizationCommand } = require("@aws-sdk/client-quicksight"); // CommonJS import + * const client = new QuickSightClient(config); + * const command = new CreateAccountCustomizationCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreateAccountCustomizationCommandInput} for command's `input` shape. + * @see {@link CreateAccountCustomizationCommandOutput} for command's `response` shape. + * @see {@link QuickSightClientResolvedConfig | config} for command's `input` shape. + * */ export class CreateAccountCustomizationCommand extends $Command< CreateAccountCustomizationCommandInput, diff --git a/clients/client-quicksight/commands/CreateAnalysisCommand.ts b/clients/client-quicksight/commands/CreateAnalysisCommand.ts index ce4352ee8be2..5ed3d0fccef5 100644 --- a/clients/client-quicksight/commands/CreateAnalysisCommand.ts +++ b/clients/client-quicksight/commands/CreateAnalysisCommand.ts @@ -22,6 +22,20 @@ export interface CreateAnalysisCommandOutput extends CreateAnalysisResponse, __M /** *

Creates an analysis in Amazon QuickSight.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { QuickSightClient, CreateAnalysisCommand } from "@aws-sdk/client-quicksight"; // ES Modules import + * // const { QuickSightClient, CreateAnalysisCommand } = require("@aws-sdk/client-quicksight"); // CommonJS import + * const client = new QuickSightClient(config); + * const command = new CreateAnalysisCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreateAnalysisCommandInput} for command's `input` shape. + * @see {@link CreateAnalysisCommandOutput} for command's `response` shape. + * @see {@link QuickSightClientResolvedConfig | config} for command's `input` shape. + * */ export class CreateAnalysisCommand extends $Command< CreateAnalysisCommandInput, diff --git a/clients/client-quicksight/commands/CreateDashboardCommand.ts b/clients/client-quicksight/commands/CreateDashboardCommand.ts index 8025f42d541e..2a7eca868753 100644 --- a/clients/client-quicksight/commands/CreateDashboardCommand.ts +++ b/clients/client-quicksight/commands/CreateDashboardCommand.ts @@ -28,6 +28,20 @@ export interface CreateDashboardCommandOutput extends CreateDashboardResponse, _ * from analyses. You can share 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 AWS account.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { QuickSightClient, CreateDashboardCommand } from "@aws-sdk/client-quicksight"; // ES Modules import + * // const { QuickSightClient, CreateDashboardCommand } = require("@aws-sdk/client-quicksight"); // CommonJS import + * const client = new QuickSightClient(config); + * const command = new CreateDashboardCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreateDashboardCommandInput} for command's `input` shape. + * @see {@link CreateDashboardCommandOutput} for command's `response` shape. + * @see {@link QuickSightClientResolvedConfig | config} for command's `input` shape. + * */ export class CreateDashboardCommand extends $Command< CreateDashboardCommandInput, diff --git a/clients/client-quicksight/commands/CreateDataSetCommand.ts b/clients/client-quicksight/commands/CreateDataSetCommand.ts index 03bf23d40ac8..e9f81c3e20c2 100644 --- a/clients/client-quicksight/commands/CreateDataSetCommand.ts +++ b/clients/client-quicksight/commands/CreateDataSetCommand.ts @@ -22,6 +22,20 @@ export interface CreateDataSetCommandOutput extends CreateDataSetResponse, __Met /** *

Creates a dataset.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { QuickSightClient, CreateDataSetCommand } from "@aws-sdk/client-quicksight"; // ES Modules import + * // const { QuickSightClient, CreateDataSetCommand } = require("@aws-sdk/client-quicksight"); // CommonJS import + * const client = new QuickSightClient(config); + * const command = new CreateDataSetCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreateDataSetCommandInput} for command's `input` shape. + * @see {@link CreateDataSetCommandOutput} for command's `response` shape. + * @see {@link QuickSightClientResolvedConfig | config} for command's `input` shape. + * */ export class CreateDataSetCommand extends $Command< CreateDataSetCommandInput, diff --git a/clients/client-quicksight/commands/CreateDataSourceCommand.ts b/clients/client-quicksight/commands/CreateDataSourceCommand.ts index 070bd19dc40b..586d8bb2aa15 100644 --- a/clients/client-quicksight/commands/CreateDataSourceCommand.ts +++ b/clients/client-quicksight/commands/CreateDataSourceCommand.ts @@ -22,6 +22,20 @@ export interface CreateDataSourceCommandOutput extends CreateDataSourceResponse, /** *

Creates a data source.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { QuickSightClient, CreateDataSourceCommand } from "@aws-sdk/client-quicksight"; // ES Modules import + * // const { QuickSightClient, CreateDataSourceCommand } = require("@aws-sdk/client-quicksight"); // CommonJS import + * const client = new QuickSightClient(config); + * const command = new CreateDataSourceCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreateDataSourceCommandInput} for command's `input` shape. + * @see {@link CreateDataSourceCommandOutput} for command's `response` shape. + * @see {@link QuickSightClientResolvedConfig | config} for command's `input` shape. + * */ export class CreateDataSourceCommand extends $Command< CreateDataSourceCommandInput, diff --git a/clients/client-quicksight/commands/CreateGroupCommand.ts b/clients/client-quicksight/commands/CreateGroupCommand.ts index 317a44ddfed8..bb7da3abca7f 100644 --- a/clients/client-quicksight/commands/CreateGroupCommand.ts +++ b/clients/client-quicksight/commands/CreateGroupCommand.ts @@ -26,6 +26,20 @@ export interface CreateGroupCommandOutput extends CreateGroupResponse, __Metadat * arn:aws:quicksight:us-east-1::group/default/ * .

*

The response is a group object.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { QuickSightClient, CreateGroupCommand } from "@aws-sdk/client-quicksight"; // ES Modules import + * // const { QuickSightClient, CreateGroupCommand } = require("@aws-sdk/client-quicksight"); // CommonJS import + * const client = new QuickSightClient(config); + * const command = new CreateGroupCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreateGroupCommandInput} for command's `input` shape. + * @see {@link CreateGroupCommandOutput} for command's `response` shape. + * @see {@link QuickSightClientResolvedConfig | config} for command's `input` shape. + * */ export class CreateGroupCommand extends $Command< CreateGroupCommandInput, diff --git a/clients/client-quicksight/commands/CreateGroupMembershipCommand.ts b/clients/client-quicksight/commands/CreateGroupMembershipCommand.ts index 18001cab051e..4aa7d88ec7ef 100644 --- a/clients/client-quicksight/commands/CreateGroupMembershipCommand.ts +++ b/clients/client-quicksight/commands/CreateGroupMembershipCommand.ts @@ -22,6 +22,20 @@ export interface CreateGroupMembershipCommandOutput extends CreateGroupMembershi /** *

Adds an Amazon QuickSight user to an Amazon QuickSight group.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { QuickSightClient, CreateGroupMembershipCommand } from "@aws-sdk/client-quicksight"; // ES Modules import + * // const { QuickSightClient, CreateGroupMembershipCommand } = require("@aws-sdk/client-quicksight"); // CommonJS import + * const client = new QuickSightClient(config); + * const command = new CreateGroupMembershipCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreateGroupMembershipCommandInput} for command's `input` shape. + * @see {@link CreateGroupMembershipCommandOutput} for command's `response` shape. + * @see {@link QuickSightClientResolvedConfig | config} for command's `input` shape. + * */ export class CreateGroupMembershipCommand extends $Command< CreateGroupMembershipCommandInput, diff --git a/clients/client-quicksight/commands/CreateIAMPolicyAssignmentCommand.ts b/clients/client-quicksight/commands/CreateIAMPolicyAssignmentCommand.ts index a0a2bb5fa395..43d849bd1c79 100644 --- a/clients/client-quicksight/commands/CreateIAMPolicyAssignmentCommand.ts +++ b/clients/client-quicksight/commands/CreateIAMPolicyAssignmentCommand.ts @@ -25,6 +25,20 @@ export interface CreateIAMPolicyAssignmentCommandOutput extends CreateIAMPolicyA * (ARN). This policy assignment is attached to the specified groups or users of Amazon QuickSight. * Assignment names are unique per AWS account. To avoid overwriting rules in other namespaces, * use assignment names that are unique.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { QuickSightClient, CreateIAMPolicyAssignmentCommand } from "@aws-sdk/client-quicksight"; // ES Modules import + * // const { QuickSightClient, CreateIAMPolicyAssignmentCommand } = require("@aws-sdk/client-quicksight"); // CommonJS import + * const client = new QuickSightClient(config); + * const command = new CreateIAMPolicyAssignmentCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreateIAMPolicyAssignmentCommandInput} for command's `input` shape. + * @see {@link CreateIAMPolicyAssignmentCommandOutput} for command's `response` shape. + * @see {@link QuickSightClientResolvedConfig | config} for command's `input` shape. + * */ export class CreateIAMPolicyAssignmentCommand extends $Command< CreateIAMPolicyAssignmentCommandInput, diff --git a/clients/client-quicksight/commands/CreateIngestionCommand.ts b/clients/client-quicksight/commands/CreateIngestionCommand.ts index 17b8cbcec965..8d9946563711 100644 --- a/clients/client-quicksight/commands/CreateIngestionCommand.ts +++ b/clients/client-quicksight/commands/CreateIngestionCommand.ts @@ -26,6 +26,20 @@ export interface CreateIngestionCommandOutput extends CreateIngestionResponse, _ *

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 AWS Knowledge Center. Tags are visible on the tagged dataset, but not on the ingestion resource.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { QuickSightClient, CreateIngestionCommand } from "@aws-sdk/client-quicksight"; // ES Modules import + * // const { QuickSightClient, CreateIngestionCommand } = require("@aws-sdk/client-quicksight"); // CommonJS import + * const client = new QuickSightClient(config); + * const command = new CreateIngestionCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreateIngestionCommandInput} for command's `input` shape. + * @see {@link CreateIngestionCommandOutput} for command's `response` shape. + * @see {@link QuickSightClientResolvedConfig | config} for command's `input` shape. + * */ export class CreateIngestionCommand extends $Command< CreateIngestionCommandInput, diff --git a/clients/client-quicksight/commands/CreateNamespaceCommand.ts b/clients/client-quicksight/commands/CreateNamespaceCommand.ts index a71f9b53ce03..4a927f057a37 100644 --- a/clients/client-quicksight/commands/CreateNamespaceCommand.ts +++ b/clients/client-quicksight/commands/CreateNamespaceCommand.ts @@ -29,6 +29,20 @@ export interface CreateNamespaceCommandOutput extends CreateNamespaceResponse, _ * QuickSight. The namespace must be unique within the AWS account. By default, there is a * limit of 100 namespaces per AWS account. To increase your limit, create a ticket with * AWS Support.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { QuickSightClient, CreateNamespaceCommand } from "@aws-sdk/client-quicksight"; // ES Modules import + * // const { QuickSightClient, CreateNamespaceCommand } = require("@aws-sdk/client-quicksight"); // CommonJS import + * const client = new QuickSightClient(config); + * const command = new CreateNamespaceCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreateNamespaceCommandInput} for command's `input` shape. + * @see {@link CreateNamespaceCommandOutput} for command's `response` shape. + * @see {@link QuickSightClientResolvedConfig | config} for command's `input` shape. + * */ export class CreateNamespaceCommand extends $Command< CreateNamespaceCommandInput, diff --git a/clients/client-quicksight/commands/CreateTemplateAliasCommand.ts b/clients/client-quicksight/commands/CreateTemplateAliasCommand.ts index 0087944c3103..25ccbc420140 100644 --- a/clients/client-quicksight/commands/CreateTemplateAliasCommand.ts +++ b/clients/client-quicksight/commands/CreateTemplateAliasCommand.ts @@ -22,6 +22,20 @@ export interface CreateTemplateAliasCommandOutput extends CreateTemplateAliasRes /** *

Creates a template alias for a template.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { QuickSightClient, CreateTemplateAliasCommand } from "@aws-sdk/client-quicksight"; // ES Modules import + * // const { QuickSightClient, CreateTemplateAliasCommand } = require("@aws-sdk/client-quicksight"); // CommonJS import + * const client = new QuickSightClient(config); + * const command = new CreateTemplateAliasCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreateTemplateAliasCommandInput} for command's `input` shape. + * @see {@link CreateTemplateAliasCommandOutput} for command's `response` shape. + * @see {@link QuickSightClientResolvedConfig | config} for command's `input` shape. + * */ export class CreateTemplateAliasCommand extends $Command< CreateTemplateAliasCommandInput, diff --git a/clients/client-quicksight/commands/CreateTemplateCommand.ts b/clients/client-quicksight/commands/CreateTemplateCommand.ts index e39ac5fe6218..44243da4db59 100644 --- a/clients/client-quicksight/commands/CreateTemplateCommand.ts +++ b/clients/client-quicksight/commands/CreateTemplateCommand.ts @@ -29,6 +29,20 @@ export interface CreateTemplateCommandOutput extends CreateTemplateResponse, __M * 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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { QuickSightClient, CreateTemplateCommand } from "@aws-sdk/client-quicksight"; // ES Modules import + * // const { QuickSightClient, CreateTemplateCommand } = require("@aws-sdk/client-quicksight"); // CommonJS import + * const client = new QuickSightClient(config); + * const command = new CreateTemplateCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreateTemplateCommandInput} for command's `input` shape. + * @see {@link CreateTemplateCommandOutput} for command's `response` shape. + * @see {@link QuickSightClientResolvedConfig | config} for command's `input` shape. + * */ export class CreateTemplateCommand extends $Command< CreateTemplateCommandInput, diff --git a/clients/client-quicksight/commands/CreateThemeAliasCommand.ts b/clients/client-quicksight/commands/CreateThemeAliasCommand.ts index f2b7784d2840..6a55494f32f2 100644 --- a/clients/client-quicksight/commands/CreateThemeAliasCommand.ts +++ b/clients/client-quicksight/commands/CreateThemeAliasCommand.ts @@ -22,6 +22,20 @@ export interface CreateThemeAliasCommandOutput extends CreateThemeAliasResponse, /** *

Creates a theme alias for a theme.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { QuickSightClient, CreateThemeAliasCommand } from "@aws-sdk/client-quicksight"; // ES Modules import + * // const { QuickSightClient, CreateThemeAliasCommand } = require("@aws-sdk/client-quicksight"); // CommonJS import + * const client = new QuickSightClient(config); + * const command = new CreateThemeAliasCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreateThemeAliasCommandInput} for command's `input` shape. + * @see {@link CreateThemeAliasCommandOutput} for command's `response` shape. + * @see {@link QuickSightClientResolvedConfig | config} for command's `input` shape. + * */ export class CreateThemeAliasCommand extends $Command< CreateThemeAliasCommandInput, diff --git a/clients/client-quicksight/commands/CreateThemeCommand.ts b/clients/client-quicksight/commands/CreateThemeCommand.ts index 0e8ab6f4747a..850960faddf3 100644 --- a/clients/client-quicksight/commands/CreateThemeCommand.ts +++ b/clients/client-quicksight/commands/CreateThemeCommand.ts @@ -25,6 +25,20 @@ export interface CreateThemeCommandOutput extends CreateThemeResponse, __Metadat *

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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { QuickSightClient, CreateThemeCommand } from "@aws-sdk/client-quicksight"; // ES Modules import + * // const { QuickSightClient, CreateThemeCommand } = require("@aws-sdk/client-quicksight"); // CommonJS import + * const client = new QuickSightClient(config); + * const command = new CreateThemeCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreateThemeCommandInput} for command's `input` shape. + * @see {@link CreateThemeCommandOutput} for command's `response` shape. + * @see {@link QuickSightClientResolvedConfig | config} for command's `input` shape. + * */ export class CreateThemeCommand extends $Command< CreateThemeCommandInput, diff --git a/clients/client-quicksight/commands/DeleteAccountCustomizationCommand.ts b/clients/client-quicksight/commands/DeleteAccountCustomizationCommand.ts index bafdb4a43e89..4b603885dbc6 100644 --- a/clients/client-quicksight/commands/DeleteAccountCustomizationCommand.ts +++ b/clients/client-quicksight/commands/DeleteAccountCustomizationCommand.ts @@ -23,6 +23,20 @@ export interface DeleteAccountCustomizationCommandOutput extends DeleteAccountCu /** *

Deletes all Amazon QuickSight customizations in this AWS Region for the specified AWS * account and QuickSight namespace.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { QuickSightClient, DeleteAccountCustomizationCommand } from "@aws-sdk/client-quicksight"; // ES Modules import + * // const { QuickSightClient, DeleteAccountCustomizationCommand } = require("@aws-sdk/client-quicksight"); // CommonJS import + * const client = new QuickSightClient(config); + * const command = new DeleteAccountCustomizationCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteAccountCustomizationCommandInput} for command's `input` shape. + * @see {@link DeleteAccountCustomizationCommandOutput} for command's `response` shape. + * @see {@link QuickSightClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteAccountCustomizationCommand extends $Command< DeleteAccountCustomizationCommandInput, diff --git a/clients/client-quicksight/commands/DeleteAnalysisCommand.ts b/clients/client-quicksight/commands/DeleteAnalysisCommand.ts index 2a58c8a68075..fe5bf53ae2df 100644 --- a/clients/client-quicksight/commands/DeleteAnalysisCommand.ts +++ b/clients/client-quicksight/commands/DeleteAnalysisCommand.ts @@ -33,6 +33,20 @@ export interface DeleteAnalysisCommandOutput extends DeleteAnalysisResponse, __M *

An analysis that's scheduled for deletion isn't accessible in the QuickSight console. * To access it in the console, restore it. Deleting an analysis doesn't delete the * dashboards that you publish from it.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { QuickSightClient, DeleteAnalysisCommand } from "@aws-sdk/client-quicksight"; // ES Modules import + * // const { QuickSightClient, DeleteAnalysisCommand } = require("@aws-sdk/client-quicksight"); // CommonJS import + * const client = new QuickSightClient(config); + * const command = new DeleteAnalysisCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteAnalysisCommandInput} for command's `input` shape. + * @see {@link DeleteAnalysisCommandOutput} for command's `response` shape. + * @see {@link QuickSightClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteAnalysisCommand extends $Command< DeleteAnalysisCommandInput, diff --git a/clients/client-quicksight/commands/DeleteDashboardCommand.ts b/clients/client-quicksight/commands/DeleteDashboardCommand.ts index 81e3ff342956..d4eb64162b38 100644 --- a/clients/client-quicksight/commands/DeleteDashboardCommand.ts +++ b/clients/client-quicksight/commands/DeleteDashboardCommand.ts @@ -22,6 +22,20 @@ export interface DeleteDashboardCommandOutput extends DeleteDashboardResponse, _ /** *

Deletes a dashboard.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { QuickSightClient, DeleteDashboardCommand } from "@aws-sdk/client-quicksight"; // ES Modules import + * // const { QuickSightClient, DeleteDashboardCommand } = require("@aws-sdk/client-quicksight"); // CommonJS import + * const client = new QuickSightClient(config); + * const command = new DeleteDashboardCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteDashboardCommandInput} for command's `input` shape. + * @see {@link DeleteDashboardCommandOutput} for command's `response` shape. + * @see {@link QuickSightClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteDashboardCommand extends $Command< DeleteDashboardCommandInput, diff --git a/clients/client-quicksight/commands/DeleteDataSetCommand.ts b/clients/client-quicksight/commands/DeleteDataSetCommand.ts index 88716d11f075..40f1f62ef83d 100644 --- a/clients/client-quicksight/commands/DeleteDataSetCommand.ts +++ b/clients/client-quicksight/commands/DeleteDataSetCommand.ts @@ -22,6 +22,20 @@ export interface DeleteDataSetCommandOutput extends DeleteDataSetResponse, __Met /** *

Deletes a dataset.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { QuickSightClient, DeleteDataSetCommand } from "@aws-sdk/client-quicksight"; // ES Modules import + * // const { QuickSightClient, DeleteDataSetCommand } = require("@aws-sdk/client-quicksight"); // CommonJS import + * const client = new QuickSightClient(config); + * const command = new DeleteDataSetCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteDataSetCommandInput} for command's `input` shape. + * @see {@link DeleteDataSetCommandOutput} for command's `response` shape. + * @see {@link QuickSightClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteDataSetCommand extends $Command< DeleteDataSetCommandInput, diff --git a/clients/client-quicksight/commands/DeleteDataSourceCommand.ts b/clients/client-quicksight/commands/DeleteDataSourceCommand.ts index aac87289d4ed..6eeddf90deef 100644 --- a/clients/client-quicksight/commands/DeleteDataSourceCommand.ts +++ b/clients/client-quicksight/commands/DeleteDataSourceCommand.ts @@ -23,6 +23,20 @@ export interface DeleteDataSourceCommandOutput extends DeleteDataSourceResponse, /** *

Deletes the data source permanently. This operation breaks * all the datasets that reference the deleted data source.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { QuickSightClient, DeleteDataSourceCommand } from "@aws-sdk/client-quicksight"; // ES Modules import + * // const { QuickSightClient, DeleteDataSourceCommand } = require("@aws-sdk/client-quicksight"); // CommonJS import + * const client = new QuickSightClient(config); + * const command = new DeleteDataSourceCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteDataSourceCommandInput} for command's `input` shape. + * @see {@link DeleteDataSourceCommandOutput} for command's `response` shape. + * @see {@link QuickSightClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteDataSourceCommand extends $Command< DeleteDataSourceCommandInput, diff --git a/clients/client-quicksight/commands/DeleteGroupCommand.ts b/clients/client-quicksight/commands/DeleteGroupCommand.ts index 1287eaf7ae27..edb872d4c4d8 100644 --- a/clients/client-quicksight/commands/DeleteGroupCommand.ts +++ b/clients/client-quicksight/commands/DeleteGroupCommand.ts @@ -22,6 +22,20 @@ export interface DeleteGroupCommandOutput extends DeleteGroupResponse, __Metadat /** *

Removes a user group from Amazon QuickSight.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { QuickSightClient, DeleteGroupCommand } from "@aws-sdk/client-quicksight"; // ES Modules import + * // const { QuickSightClient, DeleteGroupCommand } = require("@aws-sdk/client-quicksight"); // CommonJS import + * const client = new QuickSightClient(config); + * const command = new DeleteGroupCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteGroupCommandInput} for command's `input` shape. + * @see {@link DeleteGroupCommandOutput} for command's `response` shape. + * @see {@link QuickSightClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteGroupCommand extends $Command< DeleteGroupCommandInput, diff --git a/clients/client-quicksight/commands/DeleteGroupMembershipCommand.ts b/clients/client-quicksight/commands/DeleteGroupMembershipCommand.ts index 7fd00f7a300f..2f3d9b312432 100644 --- a/clients/client-quicksight/commands/DeleteGroupMembershipCommand.ts +++ b/clients/client-quicksight/commands/DeleteGroupMembershipCommand.ts @@ -22,6 +22,20 @@ export interface DeleteGroupMembershipCommandOutput extends DeleteGroupMembershi /** *

Removes a user from a group so that the user is no longer a member of the group.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { QuickSightClient, DeleteGroupMembershipCommand } from "@aws-sdk/client-quicksight"; // ES Modules import + * // const { QuickSightClient, DeleteGroupMembershipCommand } = require("@aws-sdk/client-quicksight"); // CommonJS import + * const client = new QuickSightClient(config); + * const command = new DeleteGroupMembershipCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteGroupMembershipCommandInput} for command's `input` shape. + * @see {@link DeleteGroupMembershipCommandOutput} for command's `response` shape. + * @see {@link QuickSightClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteGroupMembershipCommand extends $Command< DeleteGroupMembershipCommandInput, diff --git a/clients/client-quicksight/commands/DeleteIAMPolicyAssignmentCommand.ts b/clients/client-quicksight/commands/DeleteIAMPolicyAssignmentCommand.ts index ef4134009e78..2bafe5236fb3 100644 --- a/clients/client-quicksight/commands/DeleteIAMPolicyAssignmentCommand.ts +++ b/clients/client-quicksight/commands/DeleteIAMPolicyAssignmentCommand.ts @@ -22,6 +22,20 @@ export interface DeleteIAMPolicyAssignmentCommandOutput extends DeleteIAMPolicyA /** *

Deletes an existing IAM policy assignment.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { QuickSightClient, DeleteIAMPolicyAssignmentCommand } from "@aws-sdk/client-quicksight"; // ES Modules import + * // const { QuickSightClient, DeleteIAMPolicyAssignmentCommand } = require("@aws-sdk/client-quicksight"); // CommonJS import + * const client = new QuickSightClient(config); + * const command = new DeleteIAMPolicyAssignmentCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteIAMPolicyAssignmentCommandInput} for command's `input` shape. + * @see {@link DeleteIAMPolicyAssignmentCommandOutput} for command's `response` shape. + * @see {@link QuickSightClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteIAMPolicyAssignmentCommand extends $Command< DeleteIAMPolicyAssignmentCommandInput, diff --git a/clients/client-quicksight/commands/DeleteNamespaceCommand.ts b/clients/client-quicksight/commands/DeleteNamespaceCommand.ts index f8695d0bd69b..e8ebae070122 100644 --- a/clients/client-quicksight/commands/DeleteNamespaceCommand.ts +++ b/clients/client-quicksight/commands/DeleteNamespaceCommand.ts @@ -24,6 +24,20 @@ export interface DeleteNamespaceCommandOutput extends DeleteNamespaceResponse, _ *

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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { QuickSightClient, DeleteNamespaceCommand } from "@aws-sdk/client-quicksight"; // ES Modules import + * // const { QuickSightClient, DeleteNamespaceCommand } = require("@aws-sdk/client-quicksight"); // CommonJS import + * const client = new QuickSightClient(config); + * const command = new DeleteNamespaceCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteNamespaceCommandInput} for command's `input` shape. + * @see {@link DeleteNamespaceCommandOutput} for command's `response` shape. + * @see {@link QuickSightClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteNamespaceCommand extends $Command< DeleteNamespaceCommandInput, diff --git a/clients/client-quicksight/commands/DeleteTemplateAliasCommand.ts b/clients/client-quicksight/commands/DeleteTemplateAliasCommand.ts index a14674f149e9..30df42b7da5e 100644 --- a/clients/client-quicksight/commands/DeleteTemplateAliasCommand.ts +++ b/clients/client-quicksight/commands/DeleteTemplateAliasCommand.ts @@ -23,6 +23,20 @@ export interface DeleteTemplateAliasCommandOutput extends DeleteTemplateAliasRes /** *

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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { QuickSightClient, DeleteTemplateAliasCommand } from "@aws-sdk/client-quicksight"; // ES Modules import + * // const { QuickSightClient, DeleteTemplateAliasCommand } = require("@aws-sdk/client-quicksight"); // CommonJS import + * const client = new QuickSightClient(config); + * const command = new DeleteTemplateAliasCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteTemplateAliasCommandInput} for command's `input` shape. + * @see {@link DeleteTemplateAliasCommandOutput} for command's `response` shape. + * @see {@link QuickSightClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteTemplateAliasCommand extends $Command< DeleteTemplateAliasCommandInput, diff --git a/clients/client-quicksight/commands/DeleteTemplateCommand.ts b/clients/client-quicksight/commands/DeleteTemplateCommand.ts index 5b13a1208bcd..cb0d28e7bed9 100644 --- a/clients/client-quicksight/commands/DeleteTemplateCommand.ts +++ b/clients/client-quicksight/commands/DeleteTemplateCommand.ts @@ -22,6 +22,20 @@ export interface DeleteTemplateCommandOutput extends DeleteTemplateResponse, __M /** *

Deletes a template.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { QuickSightClient, DeleteTemplateCommand } from "@aws-sdk/client-quicksight"; // ES Modules import + * // const { QuickSightClient, DeleteTemplateCommand } = require("@aws-sdk/client-quicksight"); // CommonJS import + * const client = new QuickSightClient(config); + * const command = new DeleteTemplateCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteTemplateCommandInput} for command's `input` shape. + * @see {@link DeleteTemplateCommandOutput} for command's `response` shape. + * @see {@link QuickSightClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteTemplateCommand extends $Command< DeleteTemplateCommandInput, diff --git a/clients/client-quicksight/commands/DeleteThemeAliasCommand.ts b/clients/client-quicksight/commands/DeleteThemeAliasCommand.ts index bde7a141f2ef..9ce79aaf7e8f 100644 --- a/clients/client-quicksight/commands/DeleteThemeAliasCommand.ts +++ b/clients/client-quicksight/commands/DeleteThemeAliasCommand.ts @@ -24,6 +24,20 @@ export interface DeleteThemeAliasCommandOutput extends DeleteThemeAliasResponse, *

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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { QuickSightClient, DeleteThemeAliasCommand } from "@aws-sdk/client-quicksight"; // ES Modules import + * // const { QuickSightClient, DeleteThemeAliasCommand } = require("@aws-sdk/client-quicksight"); // CommonJS import + * const client = new QuickSightClient(config); + * const command = new DeleteThemeAliasCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteThemeAliasCommandInput} for command's `input` shape. + * @see {@link DeleteThemeAliasCommandOutput} for command's `response` shape. + * @see {@link QuickSightClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteThemeAliasCommand extends $Command< DeleteThemeAliasCommandInput, diff --git a/clients/client-quicksight/commands/DeleteThemeCommand.ts b/clients/client-quicksight/commands/DeleteThemeCommand.ts index f213858f29e3..ec8626b2487b 100644 --- a/clients/client-quicksight/commands/DeleteThemeCommand.ts +++ b/clients/client-quicksight/commands/DeleteThemeCommand.ts @@ -22,6 +22,20 @@ export interface DeleteThemeCommandOutput extends DeleteThemeResponse, __Metadat /** *

Deletes a theme.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { QuickSightClient, DeleteThemeCommand } from "@aws-sdk/client-quicksight"; // ES Modules import + * // const { QuickSightClient, DeleteThemeCommand } = require("@aws-sdk/client-quicksight"); // CommonJS import + * const client = new QuickSightClient(config); + * const command = new DeleteThemeCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteThemeCommandInput} for command's `input` shape. + * @see {@link DeleteThemeCommandOutput} for command's `response` shape. + * @see {@link QuickSightClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteThemeCommand extends $Command< DeleteThemeCommandInput, diff --git a/clients/client-quicksight/commands/DeleteUserByPrincipalIdCommand.ts b/clients/client-quicksight/commands/DeleteUserByPrincipalIdCommand.ts index bbd19ae7e877..5e77e03f8584 100644 --- a/clients/client-quicksight/commands/DeleteUserByPrincipalIdCommand.ts +++ b/clients/client-quicksight/commands/DeleteUserByPrincipalIdCommand.ts @@ -22,6 +22,20 @@ export interface DeleteUserByPrincipalIdCommandOutput extends DeleteUserByPrinci /** *

Deletes a user identified by its principal ID.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { QuickSightClient, DeleteUserByPrincipalIdCommand } from "@aws-sdk/client-quicksight"; // ES Modules import + * // const { QuickSightClient, DeleteUserByPrincipalIdCommand } = require("@aws-sdk/client-quicksight"); // CommonJS import + * const client = new QuickSightClient(config); + * const command = new DeleteUserByPrincipalIdCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteUserByPrincipalIdCommandInput} for command's `input` shape. + * @see {@link DeleteUserByPrincipalIdCommandOutput} for command's `response` shape. + * @see {@link QuickSightClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteUserByPrincipalIdCommand extends $Command< DeleteUserByPrincipalIdCommandInput, diff --git a/clients/client-quicksight/commands/DeleteUserCommand.ts b/clients/client-quicksight/commands/DeleteUserCommand.ts index 5ce946463697..45e11ecf34e0 100644 --- a/clients/client-quicksight/commands/DeleteUserCommand.ts +++ b/clients/client-quicksight/commands/DeleteUserCommand.ts @@ -24,6 +24,20 @@ export interface DeleteUserCommandOutput extends DeleteUserResponse, __MetadataB *

Deletes the Amazon QuickSight user that is associated with the identity of the AWS * Identity and Access Management (IAM) user or role that's making the call. The IAM user * isn't deleted as a result of this call.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { QuickSightClient, DeleteUserCommand } from "@aws-sdk/client-quicksight"; // ES Modules import + * // const { QuickSightClient, DeleteUserCommand } = require("@aws-sdk/client-quicksight"); // CommonJS import + * const client = new QuickSightClient(config); + * const command = new DeleteUserCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteUserCommandInput} for command's `input` shape. + * @see {@link DeleteUserCommandOutput} for command's `response` shape. + * @see {@link QuickSightClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteUserCommand extends $Command< DeleteUserCommandInput, diff --git a/clients/client-quicksight/commands/DescribeAccountCustomizationCommand.ts b/clients/client-quicksight/commands/DescribeAccountCustomizationCommand.ts index e86ff9d8b6f5..0f739780975a 100644 --- a/clients/client-quicksight/commands/DescribeAccountCustomizationCommand.ts +++ b/clients/client-quicksight/commands/DescribeAccountCustomizationCommand.ts @@ -80,6 +80,20 @@ export interface DescribeAccountCustomizationCommandOutput * each AWS Region where you want to apply the same customizations.

* * + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { QuickSightClient, DescribeAccountCustomizationCommand } from "@aws-sdk/client-quicksight"; // ES Modules import + * // const { QuickSightClient, DescribeAccountCustomizationCommand } = require("@aws-sdk/client-quicksight"); // CommonJS import + * const client = new QuickSightClient(config); + * const command = new DescribeAccountCustomizationCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeAccountCustomizationCommandInput} for command's `input` shape. + * @see {@link DescribeAccountCustomizationCommandOutput} for command's `response` shape. + * @see {@link QuickSightClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeAccountCustomizationCommand extends $Command< DescribeAccountCustomizationCommandInput, diff --git a/clients/client-quicksight/commands/DescribeAccountSettingsCommand.ts b/clients/client-quicksight/commands/DescribeAccountSettingsCommand.ts index 46e7ac56fc49..c0e7e21b1674 100644 --- a/clients/client-quicksight/commands/DescribeAccountSettingsCommand.ts +++ b/clients/client-quicksight/commands/DescribeAccountSettingsCommand.ts @@ -23,6 +23,20 @@ export interface DescribeAccountSettingsCommandOutput extends DescribeAccountSet /** *

Describes the settings that were used when your QuickSight subscription was first * created in this AWS account.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { QuickSightClient, DescribeAccountSettingsCommand } from "@aws-sdk/client-quicksight"; // ES Modules import + * // const { QuickSightClient, DescribeAccountSettingsCommand } = require("@aws-sdk/client-quicksight"); // CommonJS import + * const client = new QuickSightClient(config); + * const command = new DescribeAccountSettingsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeAccountSettingsCommandInput} for command's `input` shape. + * @see {@link DescribeAccountSettingsCommandOutput} for command's `response` shape. + * @see {@link QuickSightClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeAccountSettingsCommand extends $Command< DescribeAccountSettingsCommandInput, diff --git a/clients/client-quicksight/commands/DescribeAnalysisCommand.ts b/clients/client-quicksight/commands/DescribeAnalysisCommand.ts index 4056a426daa5..5627892aa63f 100644 --- a/clients/client-quicksight/commands/DescribeAnalysisCommand.ts +++ b/clients/client-quicksight/commands/DescribeAnalysisCommand.ts @@ -22,6 +22,20 @@ export interface DescribeAnalysisCommandOutput extends DescribeAnalysisResponse, /** *

Provides a summary of the metadata for an analysis.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { QuickSightClient, DescribeAnalysisCommand } from "@aws-sdk/client-quicksight"; // ES Modules import + * // const { QuickSightClient, DescribeAnalysisCommand } = require("@aws-sdk/client-quicksight"); // CommonJS import + * const client = new QuickSightClient(config); + * const command = new DescribeAnalysisCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeAnalysisCommandInput} for command's `input` shape. + * @see {@link DescribeAnalysisCommandOutput} for command's `response` shape. + * @see {@link QuickSightClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeAnalysisCommand extends $Command< DescribeAnalysisCommandInput, diff --git a/clients/client-quicksight/commands/DescribeAnalysisPermissionsCommand.ts b/clients/client-quicksight/commands/DescribeAnalysisPermissionsCommand.ts index 196c77d43764..68c6c24cfb88 100644 --- a/clients/client-quicksight/commands/DescribeAnalysisPermissionsCommand.ts +++ b/clients/client-quicksight/commands/DescribeAnalysisPermissionsCommand.ts @@ -24,6 +24,20 @@ export interface DescribeAnalysisPermissionsCommandOutput /** *

Provides the read and write permissions for an analysis.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { QuickSightClient, DescribeAnalysisPermissionsCommand } from "@aws-sdk/client-quicksight"; // ES Modules import + * // const { QuickSightClient, DescribeAnalysisPermissionsCommand } = require("@aws-sdk/client-quicksight"); // CommonJS import + * const client = new QuickSightClient(config); + * const command = new DescribeAnalysisPermissionsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeAnalysisPermissionsCommandInput} for command's `input` shape. + * @see {@link DescribeAnalysisPermissionsCommandOutput} for command's `response` shape. + * @see {@link QuickSightClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeAnalysisPermissionsCommand extends $Command< DescribeAnalysisPermissionsCommandInput, diff --git a/clients/client-quicksight/commands/DescribeDashboardCommand.ts b/clients/client-quicksight/commands/DescribeDashboardCommand.ts index 92ff03d6864f..383cc503e427 100644 --- a/clients/client-quicksight/commands/DescribeDashboardCommand.ts +++ b/clients/client-quicksight/commands/DescribeDashboardCommand.ts @@ -22,6 +22,20 @@ export interface DescribeDashboardCommandOutput extends DescribeDashboardRespons /** *

Provides a summary for a dashboard.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { QuickSightClient, DescribeDashboardCommand } from "@aws-sdk/client-quicksight"; // ES Modules import + * // const { QuickSightClient, DescribeDashboardCommand } = require("@aws-sdk/client-quicksight"); // CommonJS import + * const client = new QuickSightClient(config); + * const command = new DescribeDashboardCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeDashboardCommandInput} for command's `input` shape. + * @see {@link DescribeDashboardCommandOutput} for command's `response` shape. + * @see {@link QuickSightClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeDashboardCommand extends $Command< DescribeDashboardCommandInput, diff --git a/clients/client-quicksight/commands/DescribeDashboardPermissionsCommand.ts b/clients/client-quicksight/commands/DescribeDashboardPermissionsCommand.ts index 27693e779d3d..d30f59aec049 100644 --- a/clients/client-quicksight/commands/DescribeDashboardPermissionsCommand.ts +++ b/clients/client-quicksight/commands/DescribeDashboardPermissionsCommand.ts @@ -24,6 +24,20 @@ export interface DescribeDashboardPermissionsCommandOutput /** *

Describes read and write permissions for a dashboard.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { QuickSightClient, DescribeDashboardPermissionsCommand } from "@aws-sdk/client-quicksight"; // ES Modules import + * // const { QuickSightClient, DescribeDashboardPermissionsCommand } = require("@aws-sdk/client-quicksight"); // CommonJS import + * const client = new QuickSightClient(config); + * const command = new DescribeDashboardPermissionsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeDashboardPermissionsCommandInput} for command's `input` shape. + * @see {@link DescribeDashboardPermissionsCommandOutput} for command's `response` shape. + * @see {@link QuickSightClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeDashboardPermissionsCommand extends $Command< DescribeDashboardPermissionsCommandInput, diff --git a/clients/client-quicksight/commands/DescribeDataSetCommand.ts b/clients/client-quicksight/commands/DescribeDataSetCommand.ts index eb7872f98124..3329ce822758 100644 --- a/clients/client-quicksight/commands/DescribeDataSetCommand.ts +++ b/clients/client-quicksight/commands/DescribeDataSetCommand.ts @@ -22,6 +22,20 @@ export interface DescribeDataSetCommandOutput extends DescribeDataSetResponse, _ /** *

Describes a dataset.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { QuickSightClient, DescribeDataSetCommand } from "@aws-sdk/client-quicksight"; // ES Modules import + * // const { QuickSightClient, DescribeDataSetCommand } = require("@aws-sdk/client-quicksight"); // CommonJS import + * const client = new QuickSightClient(config); + * const command = new DescribeDataSetCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeDataSetCommandInput} for command's `input` shape. + * @see {@link DescribeDataSetCommandOutput} for command's `response` shape. + * @see {@link QuickSightClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeDataSetCommand extends $Command< DescribeDataSetCommandInput, diff --git a/clients/client-quicksight/commands/DescribeDataSetPermissionsCommand.ts b/clients/client-quicksight/commands/DescribeDataSetPermissionsCommand.ts index b61b4146bc3c..087f9b3f68fd 100644 --- a/clients/client-quicksight/commands/DescribeDataSetPermissionsCommand.ts +++ b/clients/client-quicksight/commands/DescribeDataSetPermissionsCommand.ts @@ -23,6 +23,20 @@ export interface DescribeDataSetPermissionsCommandOutput extends DescribeDataSet /** *

Describes the permissions on a dataset.

*

The permissions resource is arn:aws:quicksight:region:aws-account-id:dataset/data-set-id.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { QuickSightClient, DescribeDataSetPermissionsCommand } from "@aws-sdk/client-quicksight"; // ES Modules import + * // const { QuickSightClient, DescribeDataSetPermissionsCommand } = require("@aws-sdk/client-quicksight"); // CommonJS import + * const client = new QuickSightClient(config); + * const command = new DescribeDataSetPermissionsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeDataSetPermissionsCommandInput} for command's `input` shape. + * @see {@link DescribeDataSetPermissionsCommandOutput} for command's `response` shape. + * @see {@link QuickSightClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeDataSetPermissionsCommand extends $Command< DescribeDataSetPermissionsCommandInput, diff --git a/clients/client-quicksight/commands/DescribeDataSourceCommand.ts b/clients/client-quicksight/commands/DescribeDataSourceCommand.ts index e8cab0acda73..9ca386807098 100644 --- a/clients/client-quicksight/commands/DescribeDataSourceCommand.ts +++ b/clients/client-quicksight/commands/DescribeDataSourceCommand.ts @@ -22,6 +22,20 @@ export interface DescribeDataSourceCommandOutput extends DescribeDataSourceRespo /** *

Describes a data source.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { QuickSightClient, DescribeDataSourceCommand } from "@aws-sdk/client-quicksight"; // ES Modules import + * // const { QuickSightClient, DescribeDataSourceCommand } = require("@aws-sdk/client-quicksight"); // CommonJS import + * const client = new QuickSightClient(config); + * const command = new DescribeDataSourceCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeDataSourceCommandInput} for command's `input` shape. + * @see {@link DescribeDataSourceCommandOutput} for command's `response` shape. + * @see {@link QuickSightClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeDataSourceCommand extends $Command< DescribeDataSourceCommandInput, diff --git a/clients/client-quicksight/commands/DescribeDataSourcePermissionsCommand.ts b/clients/client-quicksight/commands/DescribeDataSourcePermissionsCommand.ts index d623567aaf98..462a07559914 100644 --- a/clients/client-quicksight/commands/DescribeDataSourcePermissionsCommand.ts +++ b/clients/client-quicksight/commands/DescribeDataSourcePermissionsCommand.ts @@ -24,6 +24,20 @@ export interface DescribeDataSourcePermissionsCommandOutput /** *

Describes the resource permissions for a data source.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { QuickSightClient, DescribeDataSourcePermissionsCommand } from "@aws-sdk/client-quicksight"; // ES Modules import + * // const { QuickSightClient, DescribeDataSourcePermissionsCommand } = require("@aws-sdk/client-quicksight"); // CommonJS import + * const client = new QuickSightClient(config); + * const command = new DescribeDataSourcePermissionsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeDataSourcePermissionsCommandInput} for command's `input` shape. + * @see {@link DescribeDataSourcePermissionsCommandOutput} for command's `response` shape. + * @see {@link QuickSightClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeDataSourcePermissionsCommand extends $Command< DescribeDataSourcePermissionsCommandInput, diff --git a/clients/client-quicksight/commands/DescribeGroupCommand.ts b/clients/client-quicksight/commands/DescribeGroupCommand.ts index 3692bd6a64bb..738b53bb0de8 100644 --- a/clients/client-quicksight/commands/DescribeGroupCommand.ts +++ b/clients/client-quicksight/commands/DescribeGroupCommand.ts @@ -22,6 +22,20 @@ export interface DescribeGroupCommandOutput extends DescribeGroupResponse, __Met /** *

Returns an Amazon QuickSight group's description and Amazon Resource Name (ARN).

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { QuickSightClient, DescribeGroupCommand } from "@aws-sdk/client-quicksight"; // ES Modules import + * // const { QuickSightClient, DescribeGroupCommand } = require("@aws-sdk/client-quicksight"); // CommonJS import + * const client = new QuickSightClient(config); + * const command = new DescribeGroupCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeGroupCommandInput} for command's `input` shape. + * @see {@link DescribeGroupCommandOutput} for command's `response` shape. + * @see {@link QuickSightClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeGroupCommand extends $Command< DescribeGroupCommandInput, diff --git a/clients/client-quicksight/commands/DescribeIAMPolicyAssignmentCommand.ts b/clients/client-quicksight/commands/DescribeIAMPolicyAssignmentCommand.ts index d8fcc585a1dd..4be2a3b01de5 100644 --- a/clients/client-quicksight/commands/DescribeIAMPolicyAssignmentCommand.ts +++ b/clients/client-quicksight/commands/DescribeIAMPolicyAssignmentCommand.ts @@ -24,6 +24,20 @@ export interface DescribeIAMPolicyAssignmentCommandOutput /** *

Describes an existing IAM policy assignment, as specified by the assignment name.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { QuickSightClient, DescribeIAMPolicyAssignmentCommand } from "@aws-sdk/client-quicksight"; // ES Modules import + * // const { QuickSightClient, DescribeIAMPolicyAssignmentCommand } = require("@aws-sdk/client-quicksight"); // CommonJS import + * const client = new QuickSightClient(config); + * const command = new DescribeIAMPolicyAssignmentCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeIAMPolicyAssignmentCommandInput} for command's `input` shape. + * @see {@link DescribeIAMPolicyAssignmentCommandOutput} for command's `response` shape. + * @see {@link QuickSightClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeIAMPolicyAssignmentCommand extends $Command< DescribeIAMPolicyAssignmentCommandInput, diff --git a/clients/client-quicksight/commands/DescribeIngestionCommand.ts b/clients/client-quicksight/commands/DescribeIngestionCommand.ts index f1b0f7a8972a..6eeaec62ac1d 100644 --- a/clients/client-quicksight/commands/DescribeIngestionCommand.ts +++ b/clients/client-quicksight/commands/DescribeIngestionCommand.ts @@ -22,6 +22,20 @@ export interface DescribeIngestionCommandOutput extends DescribeIngestionRespons /** *

Describes a SPICE ingestion.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { QuickSightClient, DescribeIngestionCommand } from "@aws-sdk/client-quicksight"; // ES Modules import + * // const { QuickSightClient, DescribeIngestionCommand } = require("@aws-sdk/client-quicksight"); // CommonJS import + * const client = new QuickSightClient(config); + * const command = new DescribeIngestionCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeIngestionCommandInput} for command's `input` shape. + * @see {@link DescribeIngestionCommandOutput} for command's `response` shape. + * @see {@link QuickSightClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeIngestionCommand extends $Command< DescribeIngestionCommandInput, diff --git a/clients/client-quicksight/commands/DescribeNamespaceCommand.ts b/clients/client-quicksight/commands/DescribeNamespaceCommand.ts index 8a5eb7b0e10f..e370064ac075 100644 --- a/clients/client-quicksight/commands/DescribeNamespaceCommand.ts +++ b/clients/client-quicksight/commands/DescribeNamespaceCommand.ts @@ -22,6 +22,20 @@ export interface DescribeNamespaceCommandOutput extends DescribeNamespaceRespons /** *

Describes the current namespace.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { QuickSightClient, DescribeNamespaceCommand } from "@aws-sdk/client-quicksight"; // ES Modules import + * // const { QuickSightClient, DescribeNamespaceCommand } = require("@aws-sdk/client-quicksight"); // CommonJS import + * const client = new QuickSightClient(config); + * const command = new DescribeNamespaceCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeNamespaceCommandInput} for command's `input` shape. + * @see {@link DescribeNamespaceCommandOutput} for command's `response` shape. + * @see {@link QuickSightClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeNamespaceCommand extends $Command< DescribeNamespaceCommandInput, diff --git a/clients/client-quicksight/commands/DescribeTemplateAliasCommand.ts b/clients/client-quicksight/commands/DescribeTemplateAliasCommand.ts index 72239ecd4243..4962af8bc890 100644 --- a/clients/client-quicksight/commands/DescribeTemplateAliasCommand.ts +++ b/clients/client-quicksight/commands/DescribeTemplateAliasCommand.ts @@ -22,6 +22,20 @@ export interface DescribeTemplateAliasCommandOutput extends DescribeTemplateAlia /** *

Describes the template alias for a template.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { QuickSightClient, DescribeTemplateAliasCommand } from "@aws-sdk/client-quicksight"; // ES Modules import + * // const { QuickSightClient, DescribeTemplateAliasCommand } = require("@aws-sdk/client-quicksight"); // CommonJS import + * const client = new QuickSightClient(config); + * const command = new DescribeTemplateAliasCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeTemplateAliasCommandInput} for command's `input` shape. + * @see {@link DescribeTemplateAliasCommandOutput} for command's `response` shape. + * @see {@link QuickSightClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeTemplateAliasCommand extends $Command< DescribeTemplateAliasCommandInput, diff --git a/clients/client-quicksight/commands/DescribeTemplateCommand.ts b/clients/client-quicksight/commands/DescribeTemplateCommand.ts index ed9f4fc7a5a2..a673698cf822 100644 --- a/clients/client-quicksight/commands/DescribeTemplateCommand.ts +++ b/clients/client-quicksight/commands/DescribeTemplateCommand.ts @@ -22,6 +22,20 @@ export interface DescribeTemplateCommandOutput extends DescribeTemplateResponse, /** *

Describes a template's metadata.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { QuickSightClient, DescribeTemplateCommand } from "@aws-sdk/client-quicksight"; // ES Modules import + * // const { QuickSightClient, DescribeTemplateCommand } = require("@aws-sdk/client-quicksight"); // CommonJS import + * const client = new QuickSightClient(config); + * const command = new DescribeTemplateCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeTemplateCommandInput} for command's `input` shape. + * @see {@link DescribeTemplateCommandOutput} for command's `response` shape. + * @see {@link QuickSightClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeTemplateCommand extends $Command< DescribeTemplateCommandInput, diff --git a/clients/client-quicksight/commands/DescribeTemplatePermissionsCommand.ts b/clients/client-quicksight/commands/DescribeTemplatePermissionsCommand.ts index 9740539ae70a..2e00b673967b 100644 --- a/clients/client-quicksight/commands/DescribeTemplatePermissionsCommand.ts +++ b/clients/client-quicksight/commands/DescribeTemplatePermissionsCommand.ts @@ -24,6 +24,20 @@ export interface DescribeTemplatePermissionsCommandOutput /** *

Describes read and write permissions on a template.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { QuickSightClient, DescribeTemplatePermissionsCommand } from "@aws-sdk/client-quicksight"; // ES Modules import + * // const { QuickSightClient, DescribeTemplatePermissionsCommand } = require("@aws-sdk/client-quicksight"); // CommonJS import + * const client = new QuickSightClient(config); + * const command = new DescribeTemplatePermissionsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeTemplatePermissionsCommandInput} for command's `input` shape. + * @see {@link DescribeTemplatePermissionsCommandOutput} for command's `response` shape. + * @see {@link QuickSightClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeTemplatePermissionsCommand extends $Command< DescribeTemplatePermissionsCommandInput, diff --git a/clients/client-quicksight/commands/DescribeThemeAliasCommand.ts b/clients/client-quicksight/commands/DescribeThemeAliasCommand.ts index edef95e0fc4b..6bddbfa185a2 100644 --- a/clients/client-quicksight/commands/DescribeThemeAliasCommand.ts +++ b/clients/client-quicksight/commands/DescribeThemeAliasCommand.ts @@ -22,6 +22,20 @@ export interface DescribeThemeAliasCommandOutput extends DescribeThemeAliasRespo /** *

Describes the alias for a theme.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { QuickSightClient, DescribeThemeAliasCommand } from "@aws-sdk/client-quicksight"; // ES Modules import + * // const { QuickSightClient, DescribeThemeAliasCommand } = require("@aws-sdk/client-quicksight"); // CommonJS import + * const client = new QuickSightClient(config); + * const command = new DescribeThemeAliasCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeThemeAliasCommandInput} for command's `input` shape. + * @see {@link DescribeThemeAliasCommandOutput} for command's `response` shape. + * @see {@link QuickSightClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeThemeAliasCommand extends $Command< DescribeThemeAliasCommandInput, diff --git a/clients/client-quicksight/commands/DescribeThemeCommand.ts b/clients/client-quicksight/commands/DescribeThemeCommand.ts index c2fb1d291c19..69cb922a9962 100644 --- a/clients/client-quicksight/commands/DescribeThemeCommand.ts +++ b/clients/client-quicksight/commands/DescribeThemeCommand.ts @@ -22,6 +22,20 @@ export interface DescribeThemeCommandOutput extends DescribeThemeResponse, __Met /** *

Describes a theme.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { QuickSightClient, DescribeThemeCommand } from "@aws-sdk/client-quicksight"; // ES Modules import + * // const { QuickSightClient, DescribeThemeCommand } = require("@aws-sdk/client-quicksight"); // CommonJS import + * const client = new QuickSightClient(config); + * const command = new DescribeThemeCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeThemeCommandInput} for command's `input` shape. + * @see {@link DescribeThemeCommandOutput} for command's `response` shape. + * @see {@link QuickSightClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeThemeCommand extends $Command< DescribeThemeCommandInput, diff --git a/clients/client-quicksight/commands/DescribeThemePermissionsCommand.ts b/clients/client-quicksight/commands/DescribeThemePermissionsCommand.ts index 53438850ec89..cf0330a58c8c 100644 --- a/clients/client-quicksight/commands/DescribeThemePermissionsCommand.ts +++ b/clients/client-quicksight/commands/DescribeThemePermissionsCommand.ts @@ -22,6 +22,20 @@ export interface DescribeThemePermissionsCommandOutput extends DescribeThemePerm /** *

Describes the read and write permissions for a theme.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { QuickSightClient, DescribeThemePermissionsCommand } from "@aws-sdk/client-quicksight"; // ES Modules import + * // const { QuickSightClient, DescribeThemePermissionsCommand } = require("@aws-sdk/client-quicksight"); // CommonJS import + * const client = new QuickSightClient(config); + * const command = new DescribeThemePermissionsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeThemePermissionsCommandInput} for command's `input` shape. + * @see {@link DescribeThemePermissionsCommandOutput} for command's `response` shape. + * @see {@link QuickSightClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeThemePermissionsCommand extends $Command< DescribeThemePermissionsCommandInput, diff --git a/clients/client-quicksight/commands/DescribeUserCommand.ts b/clients/client-quicksight/commands/DescribeUserCommand.ts index e4e3d42fc92f..3f9e20cad6d0 100644 --- a/clients/client-quicksight/commands/DescribeUserCommand.ts +++ b/clients/client-quicksight/commands/DescribeUserCommand.ts @@ -22,6 +22,20 @@ export interface DescribeUserCommandOutput extends DescribeUserResponse, __Metad /** *

Returns information about a user, given the user name.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { QuickSightClient, DescribeUserCommand } from "@aws-sdk/client-quicksight"; // ES Modules import + * // const { QuickSightClient, DescribeUserCommand } = require("@aws-sdk/client-quicksight"); // CommonJS import + * const client = new QuickSightClient(config); + * const command = new DescribeUserCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeUserCommandInput} for command's `input` shape. + * @see {@link DescribeUserCommandOutput} for command's `response` shape. + * @see {@link QuickSightClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeUserCommand extends $Command< DescribeUserCommandInput, diff --git a/clients/client-quicksight/commands/GetDashboardEmbedUrlCommand.ts b/clients/client-quicksight/commands/GetDashboardEmbedUrlCommand.ts index f83285224187..850106c472e2 100644 --- a/clients/client-quicksight/commands/GetDashboardEmbedUrlCommand.ts +++ b/clients/client-quicksight/commands/GetDashboardEmbedUrlCommand.ts @@ -43,6 +43,20 @@ export interface GetDashboardEmbedUrlCommandOutput extends GetDashboardEmbedUrlR * *

For more information, see Embedded Analytics in the Amazon QuickSight User * Guide.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { QuickSightClient, GetDashboardEmbedUrlCommand } from "@aws-sdk/client-quicksight"; // ES Modules import + * // const { QuickSightClient, GetDashboardEmbedUrlCommand } = require("@aws-sdk/client-quicksight"); // CommonJS import + * const client = new QuickSightClient(config); + * const command = new GetDashboardEmbedUrlCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetDashboardEmbedUrlCommandInput} for command's `input` shape. + * @see {@link GetDashboardEmbedUrlCommandOutput} for command's `response` shape. + * @see {@link QuickSightClientResolvedConfig | config} for command's `input` shape. + * */ export class GetDashboardEmbedUrlCommand extends $Command< GetDashboardEmbedUrlCommandInput, diff --git a/clients/client-quicksight/commands/GetSessionEmbedUrlCommand.ts b/clients/client-quicksight/commands/GetSessionEmbedUrlCommand.ts index 4441d6d247b9..47b398440a3d 100644 --- a/clients/client-quicksight/commands/GetSessionEmbedUrlCommand.ts +++ b/clients/client-quicksight/commands/GetSessionEmbedUrlCommand.ts @@ -46,6 +46,20 @@ export interface GetSessionEmbedUrlCommandOutput extends GetSessionEmbedUrlRespo *

* * + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { QuickSightClient, GetSessionEmbedUrlCommand } from "@aws-sdk/client-quicksight"; // ES Modules import + * // const { QuickSightClient, GetSessionEmbedUrlCommand } = require("@aws-sdk/client-quicksight"); // CommonJS import + * const client = new QuickSightClient(config); + * const command = new GetSessionEmbedUrlCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetSessionEmbedUrlCommandInput} for command's `input` shape. + * @see {@link GetSessionEmbedUrlCommandOutput} for command's `response` shape. + * @see {@link QuickSightClientResolvedConfig | config} for command's `input` shape. + * */ export class GetSessionEmbedUrlCommand extends $Command< GetSessionEmbedUrlCommandInput, diff --git a/clients/client-quicksight/commands/ListAnalysesCommand.ts b/clients/client-quicksight/commands/ListAnalysesCommand.ts index cc969e7ad135..721aa517640b 100644 --- a/clients/client-quicksight/commands/ListAnalysesCommand.ts +++ b/clients/client-quicksight/commands/ListAnalysesCommand.ts @@ -22,6 +22,20 @@ export interface ListAnalysesCommandOutput extends ListAnalysesResponse, __Metad /** *

Lists Amazon QuickSight analyses that exist in the specified AWS account.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { QuickSightClient, ListAnalysesCommand } from "@aws-sdk/client-quicksight"; // ES Modules import + * // const { QuickSightClient, ListAnalysesCommand } = require("@aws-sdk/client-quicksight"); // CommonJS import + * const client = new QuickSightClient(config); + * const command = new ListAnalysesCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListAnalysesCommandInput} for command's `input` shape. + * @see {@link ListAnalysesCommandOutput} for command's `response` shape. + * @see {@link QuickSightClientResolvedConfig | config} for command's `input` shape. + * */ export class ListAnalysesCommand extends $Command< ListAnalysesCommandInput, diff --git a/clients/client-quicksight/commands/ListDashboardVersionsCommand.ts b/clients/client-quicksight/commands/ListDashboardVersionsCommand.ts index 3bf290908c3e..72b14608dde2 100644 --- a/clients/client-quicksight/commands/ListDashboardVersionsCommand.ts +++ b/clients/client-quicksight/commands/ListDashboardVersionsCommand.ts @@ -22,6 +22,20 @@ export interface ListDashboardVersionsCommandOutput extends ListDashboardVersion /** *

Lists all the versions of the dashboards in the QuickSight subscription.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { QuickSightClient, ListDashboardVersionsCommand } from "@aws-sdk/client-quicksight"; // ES Modules import + * // const { QuickSightClient, ListDashboardVersionsCommand } = require("@aws-sdk/client-quicksight"); // CommonJS import + * const client = new QuickSightClient(config); + * const command = new ListDashboardVersionsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListDashboardVersionsCommandInput} for command's `input` shape. + * @see {@link ListDashboardVersionsCommandOutput} for command's `response` shape. + * @see {@link QuickSightClientResolvedConfig | config} for command's `input` shape. + * */ export class ListDashboardVersionsCommand extends $Command< ListDashboardVersionsCommandInput, diff --git a/clients/client-quicksight/commands/ListDashboardsCommand.ts b/clients/client-quicksight/commands/ListDashboardsCommand.ts index add88ffa7ab7..245032b632d8 100644 --- a/clients/client-quicksight/commands/ListDashboardsCommand.ts +++ b/clients/client-quicksight/commands/ListDashboardsCommand.ts @@ -22,6 +22,20 @@ export interface ListDashboardsCommandOutput extends ListDashboardsResponse, __M /** *

Lists dashboards in an AWS account.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { QuickSightClient, ListDashboardsCommand } from "@aws-sdk/client-quicksight"; // ES Modules import + * // const { QuickSightClient, ListDashboardsCommand } = require("@aws-sdk/client-quicksight"); // CommonJS import + * const client = new QuickSightClient(config); + * const command = new ListDashboardsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListDashboardsCommandInput} for command's `input` shape. + * @see {@link ListDashboardsCommandOutput} for command's `response` shape. + * @see {@link QuickSightClientResolvedConfig | config} for command's `input` shape. + * */ export class ListDashboardsCommand extends $Command< ListDashboardsCommandInput, diff --git a/clients/client-quicksight/commands/ListDataSetsCommand.ts b/clients/client-quicksight/commands/ListDataSetsCommand.ts index cfa7209e0103..7632456ad17d 100644 --- a/clients/client-quicksight/commands/ListDataSetsCommand.ts +++ b/clients/client-quicksight/commands/ListDataSetsCommand.ts @@ -23,6 +23,20 @@ export interface ListDataSetsCommandOutput extends ListDataSetsResponse, __Metad /** *

Lists all of the datasets belonging to the current AWS account in an AWS Region.

*

The permissions resource is arn:aws:quicksight:region:aws-account-id:dataset/*.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { QuickSightClient, ListDataSetsCommand } from "@aws-sdk/client-quicksight"; // ES Modules import + * // const { QuickSightClient, ListDataSetsCommand } = require("@aws-sdk/client-quicksight"); // CommonJS import + * const client = new QuickSightClient(config); + * const command = new ListDataSetsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListDataSetsCommandInput} for command's `input` shape. + * @see {@link ListDataSetsCommandOutput} for command's `response` shape. + * @see {@link QuickSightClientResolvedConfig | config} for command's `input` shape. + * */ export class ListDataSetsCommand extends $Command< ListDataSetsCommandInput, diff --git a/clients/client-quicksight/commands/ListDataSourcesCommand.ts b/clients/client-quicksight/commands/ListDataSourcesCommand.ts index b9c674a55c6c..aa2fd716aff9 100644 --- a/clients/client-quicksight/commands/ListDataSourcesCommand.ts +++ b/clients/client-quicksight/commands/ListDataSourcesCommand.ts @@ -22,6 +22,20 @@ export interface ListDataSourcesCommandOutput extends ListDataSourcesResponse, _ /** *

Lists data sources in current AWS Region that belong to this AWS account.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { QuickSightClient, ListDataSourcesCommand } from "@aws-sdk/client-quicksight"; // ES Modules import + * // const { QuickSightClient, ListDataSourcesCommand } = require("@aws-sdk/client-quicksight"); // CommonJS import + * const client = new QuickSightClient(config); + * const command = new ListDataSourcesCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListDataSourcesCommandInput} for command's `input` shape. + * @see {@link ListDataSourcesCommandOutput} for command's `response` shape. + * @see {@link QuickSightClientResolvedConfig | config} for command's `input` shape. + * */ export class ListDataSourcesCommand extends $Command< ListDataSourcesCommandInput, diff --git a/clients/client-quicksight/commands/ListGroupMembershipsCommand.ts b/clients/client-quicksight/commands/ListGroupMembershipsCommand.ts index f4d428d405a7..a2b8a1932705 100644 --- a/clients/client-quicksight/commands/ListGroupMembershipsCommand.ts +++ b/clients/client-quicksight/commands/ListGroupMembershipsCommand.ts @@ -22,6 +22,20 @@ export interface ListGroupMembershipsCommandOutput extends ListGroupMembershipsR /** *

Lists member users in a group.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { QuickSightClient, ListGroupMembershipsCommand } from "@aws-sdk/client-quicksight"; // ES Modules import + * // const { QuickSightClient, ListGroupMembershipsCommand } = require("@aws-sdk/client-quicksight"); // CommonJS import + * const client = new QuickSightClient(config); + * const command = new ListGroupMembershipsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListGroupMembershipsCommandInput} for command's `input` shape. + * @see {@link ListGroupMembershipsCommandOutput} for command's `response` shape. + * @see {@link QuickSightClientResolvedConfig | config} for command's `input` shape. + * */ export class ListGroupMembershipsCommand extends $Command< ListGroupMembershipsCommandInput, diff --git a/clients/client-quicksight/commands/ListGroupsCommand.ts b/clients/client-quicksight/commands/ListGroupsCommand.ts index 4fb62c608b1b..45555d6e2297 100644 --- a/clients/client-quicksight/commands/ListGroupsCommand.ts +++ b/clients/client-quicksight/commands/ListGroupsCommand.ts @@ -22,6 +22,20 @@ export interface ListGroupsCommandOutput extends ListGroupsResponse, __MetadataB /** *

Lists all user groups in Amazon QuickSight.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { QuickSightClient, ListGroupsCommand } from "@aws-sdk/client-quicksight"; // ES Modules import + * // const { QuickSightClient, ListGroupsCommand } = require("@aws-sdk/client-quicksight"); // CommonJS import + * const client = new QuickSightClient(config); + * const command = new ListGroupsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListGroupsCommandInput} for command's `input` shape. + * @see {@link ListGroupsCommandOutput} for command's `response` shape. + * @see {@link QuickSightClientResolvedConfig | config} for command's `input` shape. + * */ export class ListGroupsCommand extends $Command< ListGroupsCommandInput, diff --git a/clients/client-quicksight/commands/ListIAMPolicyAssignmentsCommand.ts b/clients/client-quicksight/commands/ListIAMPolicyAssignmentsCommand.ts index d61dc850643d..b4689504f87e 100644 --- a/clients/client-quicksight/commands/ListIAMPolicyAssignmentsCommand.ts +++ b/clients/client-quicksight/commands/ListIAMPolicyAssignmentsCommand.ts @@ -22,6 +22,20 @@ export interface ListIAMPolicyAssignmentsCommandOutput extends ListIAMPolicyAssi /** *

Lists IAM policy assignments in the current Amazon QuickSight account.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { QuickSightClient, ListIAMPolicyAssignmentsCommand } from "@aws-sdk/client-quicksight"; // ES Modules import + * // const { QuickSightClient, ListIAMPolicyAssignmentsCommand } = require("@aws-sdk/client-quicksight"); // CommonJS import + * const client = new QuickSightClient(config); + * const command = new ListIAMPolicyAssignmentsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListIAMPolicyAssignmentsCommandInput} for command's `input` shape. + * @see {@link ListIAMPolicyAssignmentsCommandOutput} for command's `response` shape. + * @see {@link QuickSightClientResolvedConfig | config} for command's `input` shape. + * */ export class ListIAMPolicyAssignmentsCommand extends $Command< ListIAMPolicyAssignmentsCommandInput, diff --git a/clients/client-quicksight/commands/ListIAMPolicyAssignmentsForUserCommand.ts b/clients/client-quicksight/commands/ListIAMPolicyAssignmentsForUserCommand.ts index 8cb3f5445ef4..dce2744635b6 100644 --- a/clients/client-quicksight/commands/ListIAMPolicyAssignmentsForUserCommand.ts +++ b/clients/client-quicksight/commands/ListIAMPolicyAssignmentsForUserCommand.ts @@ -26,6 +26,20 @@ export interface ListIAMPolicyAssignmentsForUserCommandOutput *

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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { QuickSightClient, ListIAMPolicyAssignmentsForUserCommand } from "@aws-sdk/client-quicksight"; // ES Modules import + * // const { QuickSightClient, ListIAMPolicyAssignmentsForUserCommand } = require("@aws-sdk/client-quicksight"); // CommonJS import + * const client = new QuickSightClient(config); + * const command = new ListIAMPolicyAssignmentsForUserCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListIAMPolicyAssignmentsForUserCommandInput} for command's `input` shape. + * @see {@link ListIAMPolicyAssignmentsForUserCommandOutput} for command's `response` shape. + * @see {@link QuickSightClientResolvedConfig | config} for command's `input` shape. + * */ export class ListIAMPolicyAssignmentsForUserCommand extends $Command< ListIAMPolicyAssignmentsForUserCommandInput, diff --git a/clients/client-quicksight/commands/ListIngestionsCommand.ts b/clients/client-quicksight/commands/ListIngestionsCommand.ts index 3a589b86e7b2..f2c0a50a3a8f 100644 --- a/clients/client-quicksight/commands/ListIngestionsCommand.ts +++ b/clients/client-quicksight/commands/ListIngestionsCommand.ts @@ -23,6 +23,20 @@ export interface ListIngestionsCommandOutput extends ListIngestionsResponse, __M /** *

Lists the history of SPICE ingestions for a dataset.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { QuickSightClient, ListIngestionsCommand } from "@aws-sdk/client-quicksight"; // ES Modules import + * // const { QuickSightClient, ListIngestionsCommand } = require("@aws-sdk/client-quicksight"); // CommonJS import + * const client = new QuickSightClient(config); + * const command = new ListIngestionsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListIngestionsCommandInput} for command's `input` shape. + * @see {@link ListIngestionsCommandOutput} for command's `response` shape. + * @see {@link QuickSightClientResolvedConfig | config} for command's `input` shape. + * */ export class ListIngestionsCommand extends $Command< ListIngestionsCommandInput, diff --git a/clients/client-quicksight/commands/ListNamespacesCommand.ts b/clients/client-quicksight/commands/ListNamespacesCommand.ts index e30c618122a4..0b92526372b1 100644 --- a/clients/client-quicksight/commands/ListNamespacesCommand.ts +++ b/clients/client-quicksight/commands/ListNamespacesCommand.ts @@ -22,6 +22,20 @@ export interface ListNamespacesCommandOutput extends ListNamespacesResponse, __M /** *

Lists the namespaces for the specified AWS account.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { QuickSightClient, ListNamespacesCommand } from "@aws-sdk/client-quicksight"; // ES Modules import + * // const { QuickSightClient, ListNamespacesCommand } = require("@aws-sdk/client-quicksight"); // CommonJS import + * const client = new QuickSightClient(config); + * const command = new ListNamespacesCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListNamespacesCommandInput} for command's `input` shape. + * @see {@link ListNamespacesCommandOutput} for command's `response` shape. + * @see {@link QuickSightClientResolvedConfig | config} for command's `input` shape. + * */ export class ListNamespacesCommand extends $Command< ListNamespacesCommandInput, diff --git a/clients/client-quicksight/commands/ListTagsForResourceCommand.ts b/clients/client-quicksight/commands/ListTagsForResourceCommand.ts index 6bfe8b88714c..476410fb466c 100644 --- a/clients/client-quicksight/commands/ListTagsForResourceCommand.ts +++ b/clients/client-quicksight/commands/ListTagsForResourceCommand.ts @@ -22,6 +22,20 @@ export interface ListTagsForResourceCommandOutput extends ListTagsForResourceRes /** *

Lists the tags assigned to a resource.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { QuickSightClient, ListTagsForResourceCommand } from "@aws-sdk/client-quicksight"; // ES Modules import + * // const { QuickSightClient, ListTagsForResourceCommand } = require("@aws-sdk/client-quicksight"); // CommonJS import + * const client = new QuickSightClient(config); + * const command = new ListTagsForResourceCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListTagsForResourceCommandInput} for command's `input` shape. + * @see {@link ListTagsForResourceCommandOutput} for command's `response` shape. + * @see {@link QuickSightClientResolvedConfig | config} for command's `input` shape. + * */ export class ListTagsForResourceCommand extends $Command< ListTagsForResourceCommandInput, diff --git a/clients/client-quicksight/commands/ListTemplateAliasesCommand.ts b/clients/client-quicksight/commands/ListTemplateAliasesCommand.ts index 806d98e5dd57..bf21ffdc3d3c 100644 --- a/clients/client-quicksight/commands/ListTemplateAliasesCommand.ts +++ b/clients/client-quicksight/commands/ListTemplateAliasesCommand.ts @@ -22,6 +22,20 @@ export interface ListTemplateAliasesCommandOutput extends ListTemplateAliasesRes /** *

Lists all the aliases of a template.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { QuickSightClient, ListTemplateAliasesCommand } from "@aws-sdk/client-quicksight"; // ES Modules import + * // const { QuickSightClient, ListTemplateAliasesCommand } = require("@aws-sdk/client-quicksight"); // CommonJS import + * const client = new QuickSightClient(config); + * const command = new ListTemplateAliasesCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListTemplateAliasesCommandInput} for command's `input` shape. + * @see {@link ListTemplateAliasesCommandOutput} for command's `response` shape. + * @see {@link QuickSightClientResolvedConfig | config} for command's `input` shape. + * */ export class ListTemplateAliasesCommand extends $Command< ListTemplateAliasesCommandInput, diff --git a/clients/client-quicksight/commands/ListTemplateVersionsCommand.ts b/clients/client-quicksight/commands/ListTemplateVersionsCommand.ts index 71eb4da650d6..820d4b27d4a6 100644 --- a/clients/client-quicksight/commands/ListTemplateVersionsCommand.ts +++ b/clients/client-quicksight/commands/ListTemplateVersionsCommand.ts @@ -22,6 +22,20 @@ export interface ListTemplateVersionsCommandOutput extends ListTemplateVersionsR /** *

Lists all the versions of the templates in the current Amazon QuickSight account.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { QuickSightClient, ListTemplateVersionsCommand } from "@aws-sdk/client-quicksight"; // ES Modules import + * // const { QuickSightClient, ListTemplateVersionsCommand } = require("@aws-sdk/client-quicksight"); // CommonJS import + * const client = new QuickSightClient(config); + * const command = new ListTemplateVersionsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListTemplateVersionsCommandInput} for command's `input` shape. + * @see {@link ListTemplateVersionsCommandOutput} for command's `response` shape. + * @see {@link QuickSightClientResolvedConfig | config} for command's `input` shape. + * */ export class ListTemplateVersionsCommand extends $Command< ListTemplateVersionsCommandInput, diff --git a/clients/client-quicksight/commands/ListTemplatesCommand.ts b/clients/client-quicksight/commands/ListTemplatesCommand.ts index c73c7468017f..515423ee373a 100644 --- a/clients/client-quicksight/commands/ListTemplatesCommand.ts +++ b/clients/client-quicksight/commands/ListTemplatesCommand.ts @@ -22,6 +22,20 @@ export interface ListTemplatesCommandOutput extends ListTemplatesResponse, __Met /** *

Lists all the templates in the current Amazon QuickSight account.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { QuickSightClient, ListTemplatesCommand } from "@aws-sdk/client-quicksight"; // ES Modules import + * // const { QuickSightClient, ListTemplatesCommand } = require("@aws-sdk/client-quicksight"); // CommonJS import + * const client = new QuickSightClient(config); + * const command = new ListTemplatesCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListTemplatesCommandInput} for command's `input` shape. + * @see {@link ListTemplatesCommandOutput} for command's `response` shape. + * @see {@link QuickSightClientResolvedConfig | config} for command's `input` shape. + * */ export class ListTemplatesCommand extends $Command< ListTemplatesCommandInput, diff --git a/clients/client-quicksight/commands/ListThemeAliasesCommand.ts b/clients/client-quicksight/commands/ListThemeAliasesCommand.ts index 2db5c1d39502..a899ac1e83b4 100644 --- a/clients/client-quicksight/commands/ListThemeAliasesCommand.ts +++ b/clients/client-quicksight/commands/ListThemeAliasesCommand.ts @@ -22,6 +22,20 @@ export interface ListThemeAliasesCommandOutput extends ListThemeAliasesResponse, /** *

Lists all the aliases of a theme.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { QuickSightClient, ListThemeAliasesCommand } from "@aws-sdk/client-quicksight"; // ES Modules import + * // const { QuickSightClient, ListThemeAliasesCommand } = require("@aws-sdk/client-quicksight"); // CommonJS import + * const client = new QuickSightClient(config); + * const command = new ListThemeAliasesCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListThemeAliasesCommandInput} for command's `input` shape. + * @see {@link ListThemeAliasesCommandOutput} for command's `response` shape. + * @see {@link QuickSightClientResolvedConfig | config} for command's `input` shape. + * */ export class ListThemeAliasesCommand extends $Command< ListThemeAliasesCommandInput, diff --git a/clients/client-quicksight/commands/ListThemeVersionsCommand.ts b/clients/client-quicksight/commands/ListThemeVersionsCommand.ts index 0db0e414ae18..f279fc5de844 100644 --- a/clients/client-quicksight/commands/ListThemeVersionsCommand.ts +++ b/clients/client-quicksight/commands/ListThemeVersionsCommand.ts @@ -22,6 +22,20 @@ export interface ListThemeVersionsCommandOutput extends ListThemeVersionsRespons /** *

Lists all the versions of the themes in the current AWS account.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { QuickSightClient, ListThemeVersionsCommand } from "@aws-sdk/client-quicksight"; // ES Modules import + * // const { QuickSightClient, ListThemeVersionsCommand } = require("@aws-sdk/client-quicksight"); // CommonJS import + * const client = new QuickSightClient(config); + * const command = new ListThemeVersionsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListThemeVersionsCommandInput} for command's `input` shape. + * @see {@link ListThemeVersionsCommandOutput} for command's `response` shape. + * @see {@link QuickSightClientResolvedConfig | config} for command's `input` shape. + * */ export class ListThemeVersionsCommand extends $Command< ListThemeVersionsCommandInput, diff --git a/clients/client-quicksight/commands/ListThemesCommand.ts b/clients/client-quicksight/commands/ListThemesCommand.ts index f9330b7f2fea..15e7c842ec2d 100644 --- a/clients/client-quicksight/commands/ListThemesCommand.ts +++ b/clients/client-quicksight/commands/ListThemesCommand.ts @@ -22,6 +22,20 @@ export interface ListThemesCommandOutput extends ListThemesResponse, __MetadataB /** *

Lists all the themes in the current AWS account.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { QuickSightClient, ListThemesCommand } from "@aws-sdk/client-quicksight"; // ES Modules import + * // const { QuickSightClient, ListThemesCommand } = require("@aws-sdk/client-quicksight"); // CommonJS import + * const client = new QuickSightClient(config); + * const command = new ListThemesCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListThemesCommandInput} for command's `input` shape. + * @see {@link ListThemesCommandOutput} for command's `response` shape. + * @see {@link QuickSightClientResolvedConfig | config} for command's `input` shape. + * */ export class ListThemesCommand extends $Command< ListThemesCommandInput, diff --git a/clients/client-quicksight/commands/ListUserGroupsCommand.ts b/clients/client-quicksight/commands/ListUserGroupsCommand.ts index f003bdf5f12d..bd0b1b76d8a7 100644 --- a/clients/client-quicksight/commands/ListUserGroupsCommand.ts +++ b/clients/client-quicksight/commands/ListUserGroupsCommand.ts @@ -22,6 +22,20 @@ export interface ListUserGroupsCommandOutput extends ListUserGroupsResponse, __M /** *

Lists the Amazon QuickSight groups that an Amazon QuickSight user is a member of.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { QuickSightClient, ListUserGroupsCommand } from "@aws-sdk/client-quicksight"; // ES Modules import + * // const { QuickSightClient, ListUserGroupsCommand } = require("@aws-sdk/client-quicksight"); // CommonJS import + * const client = new QuickSightClient(config); + * const command = new ListUserGroupsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListUserGroupsCommandInput} for command's `input` shape. + * @see {@link ListUserGroupsCommandOutput} for command's `response` shape. + * @see {@link QuickSightClientResolvedConfig | config} for command's `input` shape. + * */ export class ListUserGroupsCommand extends $Command< ListUserGroupsCommandInput, diff --git a/clients/client-quicksight/commands/ListUsersCommand.ts b/clients/client-quicksight/commands/ListUsersCommand.ts index 551ab1a0c529..a5ecf1ba0a7c 100644 --- a/clients/client-quicksight/commands/ListUsersCommand.ts +++ b/clients/client-quicksight/commands/ListUsersCommand.ts @@ -22,6 +22,20 @@ export interface ListUsersCommandOutput extends ListUsersResponse, __MetadataBea /** *

Returns a list of all of the Amazon QuickSight users belonging to this account.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { QuickSightClient, ListUsersCommand } from "@aws-sdk/client-quicksight"; // ES Modules import + * // const { QuickSightClient, ListUsersCommand } = require("@aws-sdk/client-quicksight"); // CommonJS import + * const client = new QuickSightClient(config); + * const command = new ListUsersCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListUsersCommandInput} for command's `input` shape. + * @see {@link ListUsersCommandOutput} for command's `response` shape. + * @see {@link QuickSightClientResolvedConfig | config} for command's `input` shape. + * */ export class ListUsersCommand extends $Command< ListUsersCommandInput, diff --git a/clients/client-quicksight/commands/RegisterUserCommand.ts b/clients/client-quicksight/commands/RegisterUserCommand.ts index b95c42670e30..aede637f0359 100644 --- a/clients/client-quicksight/commands/RegisterUserCommand.ts +++ b/clients/client-quicksight/commands/RegisterUserCommand.ts @@ -23,6 +23,20 @@ export interface RegisterUserCommandOutput extends RegisterUserResponse, __Metad /** *

Creates an Amazon QuickSight user, whose identity is associated with the AWS Identity * and Access Management (IAM) identity or role specified in the request.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { QuickSightClient, RegisterUserCommand } from "@aws-sdk/client-quicksight"; // ES Modules import + * // const { QuickSightClient, RegisterUserCommand } = require("@aws-sdk/client-quicksight"); // CommonJS import + * const client = new QuickSightClient(config); + * const command = new RegisterUserCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link RegisterUserCommandInput} for command's `input` shape. + * @see {@link RegisterUserCommandOutput} for command's `response` shape. + * @see {@link QuickSightClientResolvedConfig | config} for command's `input` shape. + * */ export class RegisterUserCommand extends $Command< RegisterUserCommandInput, diff --git a/clients/client-quicksight/commands/RestoreAnalysisCommand.ts b/clients/client-quicksight/commands/RestoreAnalysisCommand.ts index 2bfbc6a32ce4..a4cc71b9c83d 100644 --- a/clients/client-quicksight/commands/RestoreAnalysisCommand.ts +++ b/clients/client-quicksight/commands/RestoreAnalysisCommand.ts @@ -22,6 +22,20 @@ export interface RestoreAnalysisCommandOutput extends RestoreAnalysisResponse, _ /** *

Restores an analysis.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { QuickSightClient, RestoreAnalysisCommand } from "@aws-sdk/client-quicksight"; // ES Modules import + * // const { QuickSightClient, RestoreAnalysisCommand } = require("@aws-sdk/client-quicksight"); // CommonJS import + * const client = new QuickSightClient(config); + * const command = new RestoreAnalysisCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link RestoreAnalysisCommandInput} for command's `input` shape. + * @see {@link RestoreAnalysisCommandOutput} for command's `response` shape. + * @see {@link QuickSightClientResolvedConfig | config} for command's `input` shape. + * */ export class RestoreAnalysisCommand extends $Command< RestoreAnalysisCommandInput, diff --git a/clients/client-quicksight/commands/SearchAnalysesCommand.ts b/clients/client-quicksight/commands/SearchAnalysesCommand.ts index 3decb240facc..64749604e15e 100644 --- a/clients/client-quicksight/commands/SearchAnalysesCommand.ts +++ b/clients/client-quicksight/commands/SearchAnalysesCommand.ts @@ -22,6 +22,20 @@ export interface SearchAnalysesCommandOutput extends SearchAnalysesResponse, __M /** *

Searches for analyses that belong to the user specified in the filter.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { QuickSightClient, SearchAnalysesCommand } from "@aws-sdk/client-quicksight"; // ES Modules import + * // const { QuickSightClient, SearchAnalysesCommand } = require("@aws-sdk/client-quicksight"); // CommonJS import + * const client = new QuickSightClient(config); + * const command = new SearchAnalysesCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link SearchAnalysesCommandInput} for command's `input` shape. + * @see {@link SearchAnalysesCommandOutput} for command's `response` shape. + * @see {@link QuickSightClientResolvedConfig | config} for command's `input` shape. + * */ export class SearchAnalysesCommand extends $Command< SearchAnalysesCommandInput, diff --git a/clients/client-quicksight/commands/SearchDashboardsCommand.ts b/clients/client-quicksight/commands/SearchDashboardsCommand.ts index 3e32b41250ed..d01686a5accf 100644 --- a/clients/client-quicksight/commands/SearchDashboardsCommand.ts +++ b/clients/client-quicksight/commands/SearchDashboardsCommand.ts @@ -22,6 +22,20 @@ export interface SearchDashboardsCommandOutput extends SearchDashboardsResponse, /** *

Searches for dashboards that belong to a user.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { QuickSightClient, SearchDashboardsCommand } from "@aws-sdk/client-quicksight"; // ES Modules import + * // const { QuickSightClient, SearchDashboardsCommand } = require("@aws-sdk/client-quicksight"); // CommonJS import + * const client = new QuickSightClient(config); + * const command = new SearchDashboardsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link SearchDashboardsCommandInput} for command's `input` shape. + * @see {@link SearchDashboardsCommandOutput} for command's `response` shape. + * @see {@link QuickSightClientResolvedConfig | config} for command's `input` shape. + * */ export class SearchDashboardsCommand extends $Command< SearchDashboardsCommandInput, diff --git a/clients/client-quicksight/commands/TagResourceCommand.ts b/clients/client-quicksight/commands/TagResourceCommand.ts index 7e583fff8489..7d9911ce7e07 100644 --- a/clients/client-quicksight/commands/TagResourceCommand.ts +++ b/clients/client-quicksight/commands/TagResourceCommand.ts @@ -43,6 +43,20 @@ export interface TagResourceCommandOutput extends TagResourceResponse, __Metadat *

QuickSight doesn't currently support the Tag Editor for AWS Resource Groups.

* * + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { QuickSightClient, TagResourceCommand } from "@aws-sdk/client-quicksight"; // ES Modules import + * // const { QuickSightClient, TagResourceCommand } = require("@aws-sdk/client-quicksight"); // CommonJS import + * const client = new QuickSightClient(config); + * const command = new TagResourceCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link TagResourceCommandInput} for command's `input` shape. + * @see {@link TagResourceCommandOutput} for command's `response` shape. + * @see {@link QuickSightClientResolvedConfig | config} for command's `input` shape. + * */ export class TagResourceCommand extends $Command< TagResourceCommandInput, diff --git a/clients/client-quicksight/commands/UntagResourceCommand.ts b/clients/client-quicksight/commands/UntagResourceCommand.ts index 9e65f9d41026..1d02d14304a0 100644 --- a/clients/client-quicksight/commands/UntagResourceCommand.ts +++ b/clients/client-quicksight/commands/UntagResourceCommand.ts @@ -22,6 +22,20 @@ export interface UntagResourceCommandOutput extends UntagResourceResponse, __Met /** *

Removes a tag or tags from a resource.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { QuickSightClient, UntagResourceCommand } from "@aws-sdk/client-quicksight"; // ES Modules import + * // const { QuickSightClient, UntagResourceCommand } = require("@aws-sdk/client-quicksight"); // CommonJS import + * const client = new QuickSightClient(config); + * const command = new UntagResourceCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link UntagResourceCommandInput} for command's `input` shape. + * @see {@link UntagResourceCommandOutput} for command's `response` shape. + * @see {@link QuickSightClientResolvedConfig | config} for command's `input` shape. + * */ export class UntagResourceCommand extends $Command< UntagResourceCommandInput, diff --git a/clients/client-quicksight/commands/UpdateAccountCustomizationCommand.ts b/clients/client-quicksight/commands/UpdateAccountCustomizationCommand.ts index 62452defe251..945d8ebf1b9f 100644 --- a/clients/client-quicksight/commands/UpdateAccountCustomizationCommand.ts +++ b/clients/client-quicksight/commands/UpdateAccountCustomizationCommand.ts @@ -27,6 +27,20 @@ export interface UpdateAccountCustomizationCommandOutput extends UpdateAccountCu * QuickSight namespace instead. Customizations that apply to a namespace override * customizations that apply to an AWS account. To find out which customizations apply, use * the DescribeAccountCustomization API operation.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { QuickSightClient, UpdateAccountCustomizationCommand } from "@aws-sdk/client-quicksight"; // ES Modules import + * // const { QuickSightClient, UpdateAccountCustomizationCommand } = require("@aws-sdk/client-quicksight"); // CommonJS import + * const client = new QuickSightClient(config); + * const command = new UpdateAccountCustomizationCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link UpdateAccountCustomizationCommandInput} for command's `input` shape. + * @see {@link UpdateAccountCustomizationCommandOutput} for command's `response` shape. + * @see {@link QuickSightClientResolvedConfig | config} for command's `input` shape. + * */ export class UpdateAccountCustomizationCommand extends $Command< UpdateAccountCustomizationCommandInput, diff --git a/clients/client-quicksight/commands/UpdateAccountSettingsCommand.ts b/clients/client-quicksight/commands/UpdateAccountSettingsCommand.ts index f1445b0c097c..1bb168e7072c 100644 --- a/clients/client-quicksight/commands/UpdateAccountSettingsCommand.ts +++ b/clients/client-quicksight/commands/UpdateAccountSettingsCommand.ts @@ -22,6 +22,20 @@ export interface UpdateAccountSettingsCommandOutput extends UpdateAccountSetting /** *

Updates the Amazon QuickSight settings in your AWS account.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { QuickSightClient, UpdateAccountSettingsCommand } from "@aws-sdk/client-quicksight"; // ES Modules import + * // const { QuickSightClient, UpdateAccountSettingsCommand } = require("@aws-sdk/client-quicksight"); // CommonJS import + * const client = new QuickSightClient(config); + * const command = new UpdateAccountSettingsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link UpdateAccountSettingsCommandInput} for command's `input` shape. + * @see {@link UpdateAccountSettingsCommandOutput} for command's `response` shape. + * @see {@link QuickSightClientResolvedConfig | config} for command's `input` shape. + * */ export class UpdateAccountSettingsCommand extends $Command< UpdateAccountSettingsCommandInput, diff --git a/clients/client-quicksight/commands/UpdateAnalysisCommand.ts b/clients/client-quicksight/commands/UpdateAnalysisCommand.ts index 9c191b8f260c..3eda76e07c35 100644 --- a/clients/client-quicksight/commands/UpdateAnalysisCommand.ts +++ b/clients/client-quicksight/commands/UpdateAnalysisCommand.ts @@ -22,6 +22,20 @@ export interface UpdateAnalysisCommandOutput extends UpdateAnalysisResponse, __M /** *

Updates an analysis in Amazon QuickSight

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { QuickSightClient, UpdateAnalysisCommand } from "@aws-sdk/client-quicksight"; // ES Modules import + * // const { QuickSightClient, UpdateAnalysisCommand } = require("@aws-sdk/client-quicksight"); // CommonJS import + * const client = new QuickSightClient(config); + * const command = new UpdateAnalysisCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link UpdateAnalysisCommandInput} for command's `input` shape. + * @see {@link UpdateAnalysisCommandOutput} for command's `response` shape. + * @see {@link QuickSightClientResolvedConfig | config} for command's `input` shape. + * */ export class UpdateAnalysisCommand extends $Command< UpdateAnalysisCommandInput, diff --git a/clients/client-quicksight/commands/UpdateAnalysisPermissionsCommand.ts b/clients/client-quicksight/commands/UpdateAnalysisPermissionsCommand.ts index 0e2be54afed1..9310e61dadf0 100644 --- a/clients/client-quicksight/commands/UpdateAnalysisPermissionsCommand.ts +++ b/clients/client-quicksight/commands/UpdateAnalysisPermissionsCommand.ts @@ -22,6 +22,20 @@ export interface UpdateAnalysisPermissionsCommandOutput extends UpdateAnalysisPe /** *

Updates the read and write permissions for an analysis.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { QuickSightClient, UpdateAnalysisPermissionsCommand } from "@aws-sdk/client-quicksight"; // ES Modules import + * // const { QuickSightClient, UpdateAnalysisPermissionsCommand } = require("@aws-sdk/client-quicksight"); // CommonJS import + * const client = new QuickSightClient(config); + * const command = new UpdateAnalysisPermissionsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link UpdateAnalysisPermissionsCommandInput} for command's `input` shape. + * @see {@link UpdateAnalysisPermissionsCommandOutput} for command's `response` shape. + * @see {@link QuickSightClientResolvedConfig | config} for command's `input` shape. + * */ export class UpdateAnalysisPermissionsCommand extends $Command< UpdateAnalysisPermissionsCommandInput, diff --git a/clients/client-quicksight/commands/UpdateDashboardCommand.ts b/clients/client-quicksight/commands/UpdateDashboardCommand.ts index 8ee4bce315f8..a35f5ea9915d 100644 --- a/clients/client-quicksight/commands/UpdateDashboardCommand.ts +++ b/clients/client-quicksight/commands/UpdateDashboardCommand.ts @@ -22,6 +22,20 @@ export interface UpdateDashboardCommandOutput extends UpdateDashboardResponse, _ /** *

Updates a dashboard in an AWS account.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { QuickSightClient, UpdateDashboardCommand } from "@aws-sdk/client-quicksight"; // ES Modules import + * // const { QuickSightClient, UpdateDashboardCommand } = require("@aws-sdk/client-quicksight"); // CommonJS import + * const client = new QuickSightClient(config); + * const command = new UpdateDashboardCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link UpdateDashboardCommandInput} for command's `input` shape. + * @see {@link UpdateDashboardCommandOutput} for command's `response` shape. + * @see {@link QuickSightClientResolvedConfig | config} for command's `input` shape. + * */ export class UpdateDashboardCommand extends $Command< UpdateDashboardCommandInput, diff --git a/clients/client-quicksight/commands/UpdateDashboardPermissionsCommand.ts b/clients/client-quicksight/commands/UpdateDashboardPermissionsCommand.ts index 77062599663e..2fe9dcb2dc1d 100644 --- a/clients/client-quicksight/commands/UpdateDashboardPermissionsCommand.ts +++ b/clients/client-quicksight/commands/UpdateDashboardPermissionsCommand.ts @@ -22,6 +22,20 @@ export interface UpdateDashboardPermissionsCommandOutput extends UpdateDashboard /** *

Updates read and write permissions on a dashboard.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { QuickSightClient, UpdateDashboardPermissionsCommand } from "@aws-sdk/client-quicksight"; // ES Modules import + * // const { QuickSightClient, UpdateDashboardPermissionsCommand } = require("@aws-sdk/client-quicksight"); // CommonJS import + * const client = new QuickSightClient(config); + * const command = new UpdateDashboardPermissionsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link UpdateDashboardPermissionsCommandInput} for command's `input` shape. + * @see {@link UpdateDashboardPermissionsCommandOutput} for command's `response` shape. + * @see {@link QuickSightClientResolvedConfig | config} for command's `input` shape. + * */ export class UpdateDashboardPermissionsCommand extends $Command< UpdateDashboardPermissionsCommandInput, diff --git a/clients/client-quicksight/commands/UpdateDashboardPublishedVersionCommand.ts b/clients/client-quicksight/commands/UpdateDashboardPublishedVersionCommand.ts index 5ca0d2ccb2ce..010699319d76 100644 --- a/clients/client-quicksight/commands/UpdateDashboardPublishedVersionCommand.ts +++ b/clients/client-quicksight/commands/UpdateDashboardPublishedVersionCommand.ts @@ -24,6 +24,20 @@ export interface UpdateDashboardPublishedVersionCommandOutput /** *

Updates the published version of a dashboard.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { QuickSightClient, UpdateDashboardPublishedVersionCommand } from "@aws-sdk/client-quicksight"; // ES Modules import + * // const { QuickSightClient, UpdateDashboardPublishedVersionCommand } = require("@aws-sdk/client-quicksight"); // CommonJS import + * const client = new QuickSightClient(config); + * const command = new UpdateDashboardPublishedVersionCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link UpdateDashboardPublishedVersionCommandInput} for command's `input` shape. + * @see {@link UpdateDashboardPublishedVersionCommandOutput} for command's `response` shape. + * @see {@link QuickSightClientResolvedConfig | config} for command's `input` shape. + * */ export class UpdateDashboardPublishedVersionCommand extends $Command< UpdateDashboardPublishedVersionCommandInput, diff --git a/clients/client-quicksight/commands/UpdateDataSetCommand.ts b/clients/client-quicksight/commands/UpdateDataSetCommand.ts index ea38c6e6d586..1bc1074e195f 100644 --- a/clients/client-quicksight/commands/UpdateDataSetCommand.ts +++ b/clients/client-quicksight/commands/UpdateDataSetCommand.ts @@ -22,6 +22,20 @@ export interface UpdateDataSetCommandOutput extends UpdateDataSetResponse, __Met /** *

Updates a dataset.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { QuickSightClient, UpdateDataSetCommand } from "@aws-sdk/client-quicksight"; // ES Modules import + * // const { QuickSightClient, UpdateDataSetCommand } = require("@aws-sdk/client-quicksight"); // CommonJS import + * const client = new QuickSightClient(config); + * const command = new UpdateDataSetCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link UpdateDataSetCommandInput} for command's `input` shape. + * @see {@link UpdateDataSetCommandOutput} for command's `response` shape. + * @see {@link QuickSightClientResolvedConfig | config} for command's `input` shape. + * */ export class UpdateDataSetCommand extends $Command< UpdateDataSetCommandInput, diff --git a/clients/client-quicksight/commands/UpdateDataSetPermissionsCommand.ts b/clients/client-quicksight/commands/UpdateDataSetPermissionsCommand.ts index cb6bdffa7c7a..dae5f85803ed 100644 --- a/clients/client-quicksight/commands/UpdateDataSetPermissionsCommand.ts +++ b/clients/client-quicksight/commands/UpdateDataSetPermissionsCommand.ts @@ -23,6 +23,20 @@ export interface UpdateDataSetPermissionsCommandOutput extends UpdateDataSetPerm /** *

Updates the permissions on a dataset.

*

The permissions resource is arn:aws:quicksight:region:aws-account-id:dataset/data-set-id.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { QuickSightClient, UpdateDataSetPermissionsCommand } from "@aws-sdk/client-quicksight"; // ES Modules import + * // const { QuickSightClient, UpdateDataSetPermissionsCommand } = require("@aws-sdk/client-quicksight"); // CommonJS import + * const client = new QuickSightClient(config); + * const command = new UpdateDataSetPermissionsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link UpdateDataSetPermissionsCommandInput} for command's `input` shape. + * @see {@link UpdateDataSetPermissionsCommandOutput} for command's `response` shape. + * @see {@link QuickSightClientResolvedConfig | config} for command's `input` shape. + * */ export class UpdateDataSetPermissionsCommand extends $Command< UpdateDataSetPermissionsCommandInput, diff --git a/clients/client-quicksight/commands/UpdateDataSourceCommand.ts b/clients/client-quicksight/commands/UpdateDataSourceCommand.ts index db7f0459dd47..b14bb5634ca2 100644 --- a/clients/client-quicksight/commands/UpdateDataSourceCommand.ts +++ b/clients/client-quicksight/commands/UpdateDataSourceCommand.ts @@ -22,6 +22,20 @@ export interface UpdateDataSourceCommandOutput extends UpdateDataSourceResponse, /** *

Updates a data source.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { QuickSightClient, UpdateDataSourceCommand } from "@aws-sdk/client-quicksight"; // ES Modules import + * // const { QuickSightClient, UpdateDataSourceCommand } = require("@aws-sdk/client-quicksight"); // CommonJS import + * const client = new QuickSightClient(config); + * const command = new UpdateDataSourceCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link UpdateDataSourceCommandInput} for command's `input` shape. + * @see {@link UpdateDataSourceCommandOutput} for command's `response` shape. + * @see {@link QuickSightClientResolvedConfig | config} for command's `input` shape. + * */ export class UpdateDataSourceCommand extends $Command< UpdateDataSourceCommandInput, diff --git a/clients/client-quicksight/commands/UpdateDataSourcePermissionsCommand.ts b/clients/client-quicksight/commands/UpdateDataSourcePermissionsCommand.ts index 307e145a692e..757045aaa464 100644 --- a/clients/client-quicksight/commands/UpdateDataSourcePermissionsCommand.ts +++ b/clients/client-quicksight/commands/UpdateDataSourcePermissionsCommand.ts @@ -24,6 +24,20 @@ export interface UpdateDataSourcePermissionsCommandOutput /** *

Updates the permissions to a data source.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { QuickSightClient, UpdateDataSourcePermissionsCommand } from "@aws-sdk/client-quicksight"; // ES Modules import + * // const { QuickSightClient, UpdateDataSourcePermissionsCommand } = require("@aws-sdk/client-quicksight"); // CommonJS import + * const client = new QuickSightClient(config); + * const command = new UpdateDataSourcePermissionsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link UpdateDataSourcePermissionsCommandInput} for command's `input` shape. + * @see {@link UpdateDataSourcePermissionsCommandOutput} for command's `response` shape. + * @see {@link QuickSightClientResolvedConfig | config} for command's `input` shape. + * */ export class UpdateDataSourcePermissionsCommand extends $Command< UpdateDataSourcePermissionsCommandInput, diff --git a/clients/client-quicksight/commands/UpdateGroupCommand.ts b/clients/client-quicksight/commands/UpdateGroupCommand.ts index f2a42b9304fd..f52587398ba3 100644 --- a/clients/client-quicksight/commands/UpdateGroupCommand.ts +++ b/clients/client-quicksight/commands/UpdateGroupCommand.ts @@ -22,6 +22,20 @@ export interface UpdateGroupCommandOutput extends UpdateGroupResponse, __Metadat /** *

Changes a group description.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { QuickSightClient, UpdateGroupCommand } from "@aws-sdk/client-quicksight"; // ES Modules import + * // const { QuickSightClient, UpdateGroupCommand } = require("@aws-sdk/client-quicksight"); // CommonJS import + * const client = new QuickSightClient(config); + * const command = new UpdateGroupCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link UpdateGroupCommandInput} for command's `input` shape. + * @see {@link UpdateGroupCommandOutput} for command's `response` shape. + * @see {@link QuickSightClientResolvedConfig | config} for command's `input` shape. + * */ export class UpdateGroupCommand extends $Command< UpdateGroupCommandInput, diff --git a/clients/client-quicksight/commands/UpdateIAMPolicyAssignmentCommand.ts b/clients/client-quicksight/commands/UpdateIAMPolicyAssignmentCommand.ts index e0708764f3eb..61e51db19685 100644 --- a/clients/client-quicksight/commands/UpdateIAMPolicyAssignmentCommand.ts +++ b/clients/client-quicksight/commands/UpdateIAMPolicyAssignmentCommand.ts @@ -25,6 +25,20 @@ export interface UpdateIAMPolicyAssignmentCommandOutput extends UpdateIAMPolicyA * parameter or parameters that are specified in the request. * This overwrites all of the users included in Identities. *

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { QuickSightClient, UpdateIAMPolicyAssignmentCommand } from "@aws-sdk/client-quicksight"; // ES Modules import + * // const { QuickSightClient, UpdateIAMPolicyAssignmentCommand } = require("@aws-sdk/client-quicksight"); // CommonJS import + * const client = new QuickSightClient(config); + * const command = new UpdateIAMPolicyAssignmentCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link UpdateIAMPolicyAssignmentCommandInput} for command's `input` shape. + * @see {@link UpdateIAMPolicyAssignmentCommandOutput} for command's `response` shape. + * @see {@link QuickSightClientResolvedConfig | config} for command's `input` shape. + * */ export class UpdateIAMPolicyAssignmentCommand extends $Command< UpdateIAMPolicyAssignmentCommandInput, diff --git a/clients/client-quicksight/commands/UpdateTemplateAliasCommand.ts b/clients/client-quicksight/commands/UpdateTemplateAliasCommand.ts index be48627cd1a2..8a6274f51347 100644 --- a/clients/client-quicksight/commands/UpdateTemplateAliasCommand.ts +++ b/clients/client-quicksight/commands/UpdateTemplateAliasCommand.ts @@ -22,6 +22,20 @@ export interface UpdateTemplateAliasCommandOutput extends UpdateTemplateAliasRes /** *

Updates the template alias of a template.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { QuickSightClient, UpdateTemplateAliasCommand } from "@aws-sdk/client-quicksight"; // ES Modules import + * // const { QuickSightClient, UpdateTemplateAliasCommand } = require("@aws-sdk/client-quicksight"); // CommonJS import + * const client = new QuickSightClient(config); + * const command = new UpdateTemplateAliasCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link UpdateTemplateAliasCommandInput} for command's `input` shape. + * @see {@link UpdateTemplateAliasCommandOutput} for command's `response` shape. + * @see {@link QuickSightClientResolvedConfig | config} for command's `input` shape. + * */ export class UpdateTemplateAliasCommand extends $Command< UpdateTemplateAliasCommandInput, diff --git a/clients/client-quicksight/commands/UpdateTemplateCommand.ts b/clients/client-quicksight/commands/UpdateTemplateCommand.ts index b3784fa88573..f8f3b5f16f8b 100644 --- a/clients/client-quicksight/commands/UpdateTemplateCommand.ts +++ b/clients/client-quicksight/commands/UpdateTemplateCommand.ts @@ -22,6 +22,20 @@ export interface UpdateTemplateCommandOutput extends UpdateTemplateResponse, __M /** *

Updates a template from an existing Amazon QuickSight analysis or another template.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { QuickSightClient, UpdateTemplateCommand } from "@aws-sdk/client-quicksight"; // ES Modules import + * // const { QuickSightClient, UpdateTemplateCommand } = require("@aws-sdk/client-quicksight"); // CommonJS import + * const client = new QuickSightClient(config); + * const command = new UpdateTemplateCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link UpdateTemplateCommandInput} for command's `input` shape. + * @see {@link UpdateTemplateCommandOutput} for command's `response` shape. + * @see {@link QuickSightClientResolvedConfig | config} for command's `input` shape. + * */ export class UpdateTemplateCommand extends $Command< UpdateTemplateCommandInput, diff --git a/clients/client-quicksight/commands/UpdateTemplatePermissionsCommand.ts b/clients/client-quicksight/commands/UpdateTemplatePermissionsCommand.ts index 9848778ecb91..f280a10ef803 100644 --- a/clients/client-quicksight/commands/UpdateTemplatePermissionsCommand.ts +++ b/clients/client-quicksight/commands/UpdateTemplatePermissionsCommand.ts @@ -22,6 +22,20 @@ export interface UpdateTemplatePermissionsCommandOutput extends UpdateTemplatePe /** *

Updates the resource permissions for a template.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { QuickSightClient, UpdateTemplatePermissionsCommand } from "@aws-sdk/client-quicksight"; // ES Modules import + * // const { QuickSightClient, UpdateTemplatePermissionsCommand } = require("@aws-sdk/client-quicksight"); // CommonJS import + * const client = new QuickSightClient(config); + * const command = new UpdateTemplatePermissionsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link UpdateTemplatePermissionsCommandInput} for command's `input` shape. + * @see {@link UpdateTemplatePermissionsCommandOutput} for command's `response` shape. + * @see {@link QuickSightClientResolvedConfig | config} for command's `input` shape. + * */ export class UpdateTemplatePermissionsCommand extends $Command< UpdateTemplatePermissionsCommandInput, diff --git a/clients/client-quicksight/commands/UpdateThemeAliasCommand.ts b/clients/client-quicksight/commands/UpdateThemeAliasCommand.ts index 657f1981f6fe..b8829b7d4bc1 100644 --- a/clients/client-quicksight/commands/UpdateThemeAliasCommand.ts +++ b/clients/client-quicksight/commands/UpdateThemeAliasCommand.ts @@ -22,6 +22,20 @@ export interface UpdateThemeAliasCommandOutput extends UpdateThemeAliasResponse, /** *

Updates an alias of a theme.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { QuickSightClient, UpdateThemeAliasCommand } from "@aws-sdk/client-quicksight"; // ES Modules import + * // const { QuickSightClient, UpdateThemeAliasCommand } = require("@aws-sdk/client-quicksight"); // CommonJS import + * const client = new QuickSightClient(config); + * const command = new UpdateThemeAliasCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link UpdateThemeAliasCommandInput} for command's `input` shape. + * @see {@link UpdateThemeAliasCommandOutput} for command's `response` shape. + * @see {@link QuickSightClientResolvedConfig | config} for command's `input` shape. + * */ export class UpdateThemeAliasCommand extends $Command< UpdateThemeAliasCommandInput, diff --git a/clients/client-quicksight/commands/UpdateThemeCommand.ts b/clients/client-quicksight/commands/UpdateThemeCommand.ts index 559c043790a9..54bc61afc323 100644 --- a/clients/client-quicksight/commands/UpdateThemeCommand.ts +++ b/clients/client-quicksight/commands/UpdateThemeCommand.ts @@ -22,6 +22,20 @@ export interface UpdateThemeCommandOutput extends UpdateThemeResponse, __Metadat /** *

Updates a theme.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { QuickSightClient, UpdateThemeCommand } from "@aws-sdk/client-quicksight"; // ES Modules import + * // const { QuickSightClient, UpdateThemeCommand } = require("@aws-sdk/client-quicksight"); // CommonJS import + * const client = new QuickSightClient(config); + * const command = new UpdateThemeCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link UpdateThemeCommandInput} for command's `input` shape. + * @see {@link UpdateThemeCommandOutput} for command's `response` shape. + * @see {@link QuickSightClientResolvedConfig | config} for command's `input` shape. + * */ export class UpdateThemeCommand extends $Command< UpdateThemeCommandInput, diff --git a/clients/client-quicksight/commands/UpdateThemePermissionsCommand.ts b/clients/client-quicksight/commands/UpdateThemePermissionsCommand.ts index f9d49a1fe022..40992107298c 100644 --- a/clients/client-quicksight/commands/UpdateThemePermissionsCommand.ts +++ b/clients/client-quicksight/commands/UpdateThemePermissionsCommand.ts @@ -115,6 +115,20 @@ export interface UpdateThemePermissionsCommandOutput extends UpdateThemePermissi *

To specify no permissions, omit the permissions list.

* * + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { QuickSightClient, UpdateThemePermissionsCommand } from "@aws-sdk/client-quicksight"; // ES Modules import + * // const { QuickSightClient, UpdateThemePermissionsCommand } = require("@aws-sdk/client-quicksight"); // CommonJS import + * const client = new QuickSightClient(config); + * const command = new UpdateThemePermissionsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link UpdateThemePermissionsCommandInput} for command's `input` shape. + * @see {@link UpdateThemePermissionsCommandOutput} for command's `response` shape. + * @see {@link QuickSightClientResolvedConfig | config} for command's `input` shape. + * */ export class UpdateThemePermissionsCommand extends $Command< UpdateThemePermissionsCommandInput, diff --git a/clients/client-quicksight/commands/UpdateUserCommand.ts b/clients/client-quicksight/commands/UpdateUserCommand.ts index 9fa5242512ed..ab81f6641ab4 100644 --- a/clients/client-quicksight/commands/UpdateUserCommand.ts +++ b/clients/client-quicksight/commands/UpdateUserCommand.ts @@ -22,6 +22,20 @@ export interface UpdateUserCommandOutput extends UpdateUserResponse, __MetadataB /** *

Updates an Amazon QuickSight user.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { QuickSightClient, UpdateUserCommand } from "@aws-sdk/client-quicksight"; // ES Modules import + * // const { QuickSightClient, UpdateUserCommand } = require("@aws-sdk/client-quicksight"); // CommonJS import + * const client = new QuickSightClient(config); + * const command = new UpdateUserCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link UpdateUserCommandInput} for command's `input` shape. + * @see {@link UpdateUserCommandOutput} for command's `response` shape. + * @see {@link QuickSightClientResolvedConfig | config} for command's `input` shape. + * */ export class UpdateUserCommand extends $Command< UpdateUserCommandInput, diff --git a/clients/client-quicksight/models/models_0.ts b/clients/client-quicksight/models/models_0.ts index 43e576597502..c34c6d084e4b 100644 --- a/clients/client-quicksight/models/models_0.ts +++ b/clients/client-quicksight/models/models_0.ts @@ -18,6 +18,9 @@ export interface AccessDeniedException extends __SmithyException, $MetadataBeare } export namespace AccessDeniedException { + /** + * @internal + */ export const filterSensitiveLog = (obj: AccessDeniedException): any => ({ ...obj, }); @@ -34,6 +37,9 @@ export interface AccountCustomization { } export namespace AccountCustomization { + /** + * @internal + */ export const filterSensitiveLog = (obj: AccountCustomization): any => ({ ...obj, }); @@ -73,6 +79,9 @@ export interface AccountSettings { } export namespace AccountSettings { + /** + * @internal + */ export const filterSensitiveLog = (obj: AccountSettings): any => ({ ...obj, }); @@ -94,6 +103,9 @@ export interface ActiveIAMPolicyAssignment { } export namespace ActiveIAMPolicyAssignment { + /** + * @internal + */ export const filterSensitiveLog = (obj: ActiveIAMPolicyAssignment): any => ({ ...obj, }); @@ -115,6 +127,9 @@ export interface AdHocFilteringOption { } export namespace AdHocFilteringOption { + /** + * @internal + */ export const filterSensitiveLog = (obj: AdHocFilteringOption): any => ({ ...obj, }); @@ -131,6 +146,9 @@ export interface AmazonElasticsearchParameters { } export namespace AmazonElasticsearchParameters { + /** + * @internal + */ export const filterSensitiveLog = (obj: AmazonElasticsearchParameters): any => ({ ...obj, }); @@ -165,6 +183,9 @@ export interface AnalysisError { } export namespace AnalysisError { + /** + * @internal + */ export const filterSensitiveLog = (obj: AnalysisError): any => ({ ...obj, }); @@ -191,6 +212,9 @@ export interface Sheet { } export namespace Sheet { + /** + * @internal + */ export const filterSensitiveLog = (obj: Sheet): any => ({ ...obj, }); @@ -262,6 +286,9 @@ export interface Analysis { } export namespace Analysis { + /** + * @internal + */ export const filterSensitiveLog = (obj: Analysis): any => ({ ...obj, }); @@ -300,6 +327,9 @@ export interface AnalysisSearchFilter { } export namespace AnalysisSearchFilter { + /** + * @internal + */ export const filterSensitiveLog = (obj: AnalysisSearchFilter): any => ({ ...obj, }); @@ -321,6 +351,9 @@ export interface DataSetReference { } export namespace DataSetReference { + /** + * @internal + */ export const filterSensitiveLog = (obj: DataSetReference): any => ({ ...obj, }); @@ -342,6 +375,9 @@ export interface AnalysisSourceTemplate { } export namespace AnalysisSourceTemplate { + /** + * @internal + */ export const filterSensitiveLog = (obj: AnalysisSourceTemplate): any => ({ ...obj, }); @@ -358,6 +394,9 @@ export interface AnalysisSourceEntity { } export namespace AnalysisSourceEntity { + /** + * @internal + */ export const filterSensitiveLog = (obj: AnalysisSourceEntity): any => ({ ...obj, }); @@ -400,6 +439,9 @@ export interface AnalysisSummary { } export namespace AnalysisSummary { + /** + * @internal + */ export const filterSensitiveLog = (obj: AnalysisSummary): any => ({ ...obj, }); @@ -422,6 +464,9 @@ export interface AthenaParameters { } export namespace AthenaParameters { + /** + * @internal + */ export const filterSensitiveLog = (obj: AthenaParameters): any => ({ ...obj, }); @@ -448,6 +493,9 @@ export interface AuroraParameters { } export namespace AuroraParameters { + /** + * @internal + */ export const filterSensitiveLog = (obj: AuroraParameters): any => ({ ...obj, }); @@ -474,6 +522,9 @@ export interface AuroraPostgreSqlParameters { } export namespace AuroraPostgreSqlParameters { + /** + * @internal + */ export const filterSensitiveLog = (obj: AuroraPostgreSqlParameters): any => ({ ...obj, }); @@ -490,6 +541,9 @@ export interface AwsIotAnalyticsParameters { } export namespace AwsIotAnalyticsParameters { + /** + * @internal + */ export const filterSensitiveLog = (obj: AwsIotAnalyticsParameters): any => ({ ...obj, }); @@ -506,6 +560,9 @@ export interface BorderStyle { } export namespace BorderStyle { + /** + * @internal + */ export const filterSensitiveLog = (obj: BorderStyle): any => ({ ...obj, }); @@ -534,6 +591,9 @@ export interface CalculatedColumn { } export namespace CalculatedColumn { + /** + * @internal + */ export const filterSensitiveLog = (obj: CalculatedColumn): any => ({ ...obj, }); @@ -557,6 +617,9 @@ export interface CancelIngestionRequest { } export namespace CancelIngestionRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: CancelIngestionRequest): any => ({ ...obj, }); @@ -585,6 +648,9 @@ export interface CancelIngestionResponse { } export namespace CancelIngestionResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: CancelIngestionResponse): any => ({ ...obj, }); @@ -604,6 +670,9 @@ export interface InternalFailureException extends __SmithyException, $MetadataBe } export namespace InternalFailureException { + /** + * @internal + */ export const filterSensitiveLog = (obj: InternalFailureException): any => ({ ...obj, }); @@ -623,6 +692,9 @@ export interface InvalidParameterValueException extends __SmithyException, $Meta } export namespace InvalidParameterValueException { + /** + * @internal + */ export const filterSensitiveLog = (obj: InvalidParameterValueException): any => ({ ...obj, }); @@ -659,6 +731,9 @@ export interface ResourceExistsException extends __SmithyException, $MetadataBea } export namespace ResourceExistsException { + /** + * @internal + */ export const filterSensitiveLog = (obj: ResourceExistsException): any => ({ ...obj, }); @@ -683,6 +758,9 @@ export interface ResourceNotFoundException extends __SmithyException, $MetadataB } export namespace ResourceNotFoundException { + /** + * @internal + */ export const filterSensitiveLog = (obj: ResourceNotFoundException): any => ({ ...obj, }); @@ -702,6 +780,9 @@ export interface ThrottlingException extends __SmithyException, $MetadataBearer } export namespace ThrottlingException { + /** + * @internal + */ export const filterSensitiveLog = (obj: ThrottlingException): any => ({ ...obj, }); @@ -736,6 +817,9 @@ export interface CastColumnTypeOperation { } export namespace CastColumnTypeOperation { + /** + * @internal + */ export const filterSensitiveLog = (obj: CastColumnTypeOperation): any => ({ ...obj, }); @@ -752,6 +836,9 @@ export interface ColumnDescription { } export namespace ColumnDescription { + /** + * @internal + */ export const filterSensitiveLog = (obj: ColumnDescription): any => ({ ...obj, }); @@ -782,6 +869,9 @@ export interface GeoSpatialColumnGroup { } export namespace GeoSpatialColumnGroup { + /** + * @internal + */ export const filterSensitiveLog = (obj: GeoSpatialColumnGroup): any => ({ ...obj, }); @@ -800,6 +890,9 @@ export interface ColumnGroup { } export namespace ColumnGroup { + /** + * @internal + */ export const filterSensitiveLog = (obj: ColumnGroup): any => ({ ...obj, }); @@ -816,6 +909,9 @@ export interface ColumnGroupColumnSchema { } export namespace ColumnGroupColumnSchema { + /** + * @internal + */ export const filterSensitiveLog = (obj: ColumnGroupColumnSchema): any => ({ ...obj, }); @@ -837,6 +933,9 @@ export interface ColumnGroupSchema { } export namespace ColumnGroupSchema { + /** + * @internal + */ export const filterSensitiveLog = (obj: ColumnGroupSchema): any => ({ ...obj, }); @@ -863,6 +962,9 @@ export interface ColumnLevelPermissionRule { } export namespace ColumnLevelPermissionRule { + /** + * @internal + */ export const filterSensitiveLog = (obj: ColumnLevelPermissionRule): any => ({ ...obj, }); @@ -889,6 +991,9 @@ export interface ColumnSchema { } export namespace ColumnSchema { + /** + * @internal + */ export const filterSensitiveLog = (obj: ColumnSchema): any => ({ ...obj, }); @@ -922,6 +1027,9 @@ export interface ColumnTag { } export namespace ColumnTag { + /** + * @internal + */ export const filterSensitiveLog = (obj: ColumnTag): any => ({ ...obj, }); @@ -939,6 +1047,9 @@ export interface ConcurrentUpdatingException extends __SmithyException, $Metadat } export namespace ConcurrentUpdatingException { + /** + * @internal + */ export const filterSensitiveLog = (obj: ConcurrentUpdatingException): any => ({ ...obj, }); @@ -958,6 +1069,9 @@ export interface ConflictException extends __SmithyException, $MetadataBearer { } export namespace ConflictException { + /** + * @internal + */ export const filterSensitiveLog = (obj: ConflictException): any => ({ ...obj, }); @@ -980,6 +1094,9 @@ export interface Tag { } export namespace Tag { + /** + * @internal + */ export const filterSensitiveLog = (obj: Tag): any => ({ ...obj, }); @@ -1015,6 +1132,9 @@ export interface CreateAccountCustomizationRequest { } export namespace CreateAccountCustomizationRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateAccountCustomizationRequest): any => ({ ...obj, }); @@ -1053,6 +1173,9 @@ export interface CreateAccountCustomizationResponse { } export namespace CreateAccountCustomizationResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateAccountCustomizationResponse): any => ({ ...obj, }); @@ -1077,6 +1200,9 @@ export interface ResourceUnavailableException extends __SmithyException, $Metada } export namespace ResourceUnavailableException { + /** + * @internal + */ export const filterSensitiveLog = (obj: ResourceUnavailableException): any => ({ ...obj, }); @@ -1098,6 +1224,9 @@ export interface DateTimeParameter { } export namespace DateTimeParameter { + /** + * @internal + */ export const filterSensitiveLog = (obj: DateTimeParameter): any => ({ ...obj, }); @@ -1119,6 +1248,9 @@ export interface DecimalParameter { } export namespace DecimalParameter { + /** + * @internal + */ export const filterSensitiveLog = (obj: DecimalParameter): any => ({ ...obj, }); @@ -1140,6 +1272,9 @@ export interface IntegerParameter { } export namespace IntegerParameter { + /** + * @internal + */ export const filterSensitiveLog = (obj: IntegerParameter): any => ({ ...obj, }); @@ -1161,6 +1296,9 @@ export interface StringParameter { } export namespace StringParameter { + /** + * @internal + */ export const filterSensitiveLog = (obj: StringParameter): any => ({ ...obj, }); @@ -1192,6 +1330,9 @@ export interface _Parameters { } export namespace _Parameters { + /** + * @internal + */ export const filterSensitiveLog = (obj: _Parameters): any => ({ ...obj, }); @@ -1227,6 +1368,9 @@ export interface ResourcePermission { } export namespace ResourcePermission { + /** + * @internal + */ export const filterSensitiveLog = (obj: ResourcePermission): any => ({ ...obj, }); @@ -1286,6 +1430,9 @@ export interface CreateAnalysisRequest { } export namespace CreateAnalysisRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateAnalysisRequest): any => ({ ...obj, }); @@ -1319,6 +1466,9 @@ export interface CreateAnalysisResponse { } export namespace CreateAnalysisResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateAnalysisResponse): any => ({ ...obj, }); @@ -1341,6 +1491,9 @@ export interface UnsupportedUserEditionException extends __SmithyException, $Met } export namespace UnsupportedUserEditionException { + /** + * @internal + */ export const filterSensitiveLog = (obj: UnsupportedUserEditionException): any => ({ ...obj, }); @@ -1358,6 +1511,9 @@ export interface CreateColumnsOperation { } export namespace CreateColumnsOperation { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateColumnsOperation): any => ({ ...obj, }); @@ -1374,6 +1530,9 @@ export interface ExportToCSVOption { } export namespace ExportToCSVOption { + /** + * @internal + */ export const filterSensitiveLog = (obj: ExportToCSVOption): any => ({ ...obj, }); @@ -1395,6 +1554,9 @@ export interface SheetControlsOption { } export namespace SheetControlsOption { + /** + * @internal + */ export const filterSensitiveLog = (obj: SheetControlsOption): any => ({ ...obj, }); @@ -1421,6 +1583,9 @@ export interface DashboardPublishOptions { } export namespace DashboardPublishOptions { + /** + * @internal + */ export const filterSensitiveLog = (obj: DashboardPublishOptions): any => ({ ...obj, }); @@ -1442,6 +1607,9 @@ export interface DashboardSourceTemplate { } export namespace DashboardSourceTemplate { + /** + * @internal + */ export const filterSensitiveLog = (obj: DashboardSourceTemplate): any => ({ ...obj, }); @@ -1458,6 +1626,9 @@ export interface DashboardSourceEntity { } export namespace DashboardSourceEntity { + /** + * @internal + */ export const filterSensitiveLog = (obj: DashboardSourceEntity): any => ({ ...obj, }); @@ -1559,6 +1730,9 @@ export interface CreateDashboardRequest { } export namespace CreateDashboardRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateDashboardRequest): any => ({ ...obj, }); @@ -1598,6 +1772,9 @@ export interface CreateDashboardResponse { } export namespace CreateDashboardResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateDashboardResponse): any => ({ ...obj, }); @@ -1619,6 +1796,9 @@ export interface FieldFolder { } export namespace FieldFolder { + /** + * @internal + */ export const filterSensitiveLog = (obj: FieldFolder): any => ({ ...obj, }); @@ -1641,6 +1821,9 @@ export interface FilterOperation { } export namespace FilterOperation { + /** + * @internal + */ export const filterSensitiveLog = (obj: FilterOperation): any => ({ ...obj, }); @@ -1658,6 +1841,9 @@ export interface ProjectOperation { } export namespace ProjectOperation { + /** + * @internal + */ export const filterSensitiveLog = (obj: ProjectOperation): any => ({ ...obj, }); @@ -1679,6 +1865,9 @@ export interface RenameColumnOperation { } export namespace RenameColumnOperation { + /** + * @internal + */ export const filterSensitiveLog = (obj: RenameColumnOperation): any => ({ ...obj, }); @@ -1703,6 +1892,9 @@ export interface TagColumnOperation { } export namespace TagColumnOperation { + /** + * @internal + */ export const filterSensitiveLog = (obj: TagColumnOperation): any => ({ ...obj, }); @@ -1833,6 +2025,9 @@ export namespace TransformOperation { return visitor._(value.$unknown[0], value.$unknown[1]); }; + /** + * @internal + */ export const filterSensitiveLog = (obj: TransformOperation): any => { if (obj.ProjectOperation !== undefined) return { ProjectOperation: ProjectOperation.filterSensitiveLog(obj.ProjectOperation) }; @@ -1862,6 +2057,9 @@ export interface JoinKeyProperties { } export namespace JoinKeyProperties { + /** + * @internal + */ export const filterSensitiveLog = (obj: JoinKeyProperties): any => ({ ...obj, }); @@ -1910,6 +2108,9 @@ export interface JoinInstruction { } export namespace JoinInstruction { + /** + * @internal + */ export const filterSensitiveLog = (obj: JoinInstruction): any => ({ ...obj, }); @@ -1932,6 +2133,9 @@ export interface LogicalTableSource { } export namespace LogicalTableSource { + /** + * @internal + */ export const filterSensitiveLog = (obj: LogicalTableSource): any => ({ ...obj, }); @@ -1961,6 +2165,9 @@ export interface LogicalTable { } export namespace LogicalTable { + /** + * @internal + */ export const filterSensitiveLog = (obj: LogicalTable): any => ({ ...obj, ...(obj.DataTransforms && { @@ -1995,6 +2202,9 @@ export interface InputColumn { } export namespace InputColumn { + /** + * @internal + */ export const filterSensitiveLog = (obj: InputColumn): any => ({ ...obj, }); @@ -2026,6 +2236,9 @@ export interface CustomSql { } export namespace CustomSql { + /** + * @internal + */ export const filterSensitiveLog = (obj: CustomSql): any => ({ ...obj, }); @@ -2062,6 +2275,9 @@ export interface RelationalTable { } export namespace RelationalTable { + /** + * @internal + */ export const filterSensitiveLog = (obj: RelationalTable): any => ({ ...obj, }); @@ -2112,6 +2328,9 @@ export interface UploadSettings { } export namespace UploadSettings { + /** + * @internal + */ export const filterSensitiveLog = (obj: UploadSettings): any => ({ ...obj, }); @@ -2138,6 +2357,9 @@ export interface S3Source { } export namespace S3Source { + /** + * @internal + */ export const filterSensitiveLog = (obj: S3Source): any => ({ ...obj, }); @@ -2206,6 +2428,9 @@ export namespace PhysicalTable { return visitor._(value.$unknown[0], value.$unknown[1]); }; + /** + * @internal + */ export const filterSensitiveLog = (obj: PhysicalTable): any => { if (obj.RelationalTable !== undefined) return { RelationalTable: RelationalTable.filterSensitiveLog(obj.RelationalTable) }; @@ -2247,6 +2472,9 @@ export interface RowLevelPermissionDataSet { } export namespace RowLevelPermissionDataSet { + /** + * @internal + */ export const filterSensitiveLog = (obj: RowLevelPermissionDataSet): any => ({ ...obj, }); @@ -2317,6 +2545,9 @@ export interface CreateDataSetRequest { } export namespace CreateDataSetRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateDataSetRequest): any => ({ ...obj, ...(obj.PhysicalTableMap && { @@ -2375,6 +2606,9 @@ export interface CreateDataSetResponse { } export namespace CreateDataSetResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateDataSetResponse): any => ({ ...obj, }); @@ -2399,6 +2633,9 @@ export interface LimitExceededException extends __SmithyException, $MetadataBear } export namespace LimitExceededException { + /** + * @internal + */ export const filterSensitiveLog = (obj: LimitExceededException): any => ({ ...obj, }); @@ -2415,6 +2652,9 @@ export interface JiraParameters { } export namespace JiraParameters { + /** + * @internal + */ export const filterSensitiveLog = (obj: JiraParameters): any => ({ ...obj, }); @@ -2441,6 +2681,9 @@ export interface MariaDbParameters { } export namespace MariaDbParameters { + /** + * @internal + */ export const filterSensitiveLog = (obj: MariaDbParameters): any => ({ ...obj, }); @@ -2467,6 +2710,9 @@ export interface MySqlParameters { } export namespace MySqlParameters { + /** + * @internal + */ export const filterSensitiveLog = (obj: MySqlParameters): any => ({ ...obj, }); @@ -2493,6 +2739,9 @@ export interface OracleParameters { } export namespace OracleParameters { + /** + * @internal + */ export const filterSensitiveLog = (obj: OracleParameters): any => ({ ...obj, }); @@ -2519,6 +2768,9 @@ export interface PostgreSqlParameters { } export namespace PostgreSqlParameters { + /** + * @internal + */ export const filterSensitiveLog = (obj: PostgreSqlParameters): any => ({ ...obj, }); @@ -2545,6 +2797,9 @@ export interface PrestoParameters { } export namespace PrestoParameters { + /** + * @internal + */ export const filterSensitiveLog = (obj: PrestoParameters): any => ({ ...obj, }); @@ -2566,6 +2821,9 @@ export interface RdsParameters { } export namespace RdsParameters { + /** + * @internal + */ export const filterSensitiveLog = (obj: RdsParameters): any => ({ ...obj, }); @@ -2600,6 +2858,9 @@ export interface RedshiftParameters { } export namespace RedshiftParameters { + /** + * @internal + */ export const filterSensitiveLog = (obj: RedshiftParameters): any => ({ ...obj, }); @@ -2621,6 +2882,9 @@ export interface ManifestFileLocation { } export namespace ManifestFileLocation { + /** + * @internal + */ export const filterSensitiveLog = (obj: ManifestFileLocation): any => ({ ...obj, }); @@ -2638,6 +2902,9 @@ export interface S3Parameters { } export namespace S3Parameters { + /** + * @internal + */ export const filterSensitiveLog = (obj: S3Parameters): any => ({ ...obj, }); @@ -2654,6 +2921,9 @@ export interface ServiceNowParameters { } export namespace ServiceNowParameters { + /** + * @internal + */ export const filterSensitiveLog = (obj: ServiceNowParameters): any => ({ ...obj, }); @@ -2680,6 +2950,9 @@ export interface SnowflakeParameters { } export namespace SnowflakeParameters { + /** + * @internal + */ export const filterSensitiveLog = (obj: SnowflakeParameters): any => ({ ...obj, }); @@ -2701,6 +2974,9 @@ export interface SparkParameters { } export namespace SparkParameters { + /** + * @internal + */ export const filterSensitiveLog = (obj: SparkParameters): any => ({ ...obj, }); @@ -2727,6 +3003,9 @@ export interface SqlServerParameters { } export namespace SqlServerParameters { + /** + * @internal + */ export const filterSensitiveLog = (obj: SqlServerParameters): any => ({ ...obj, }); @@ -2753,6 +3032,9 @@ export interface TeradataParameters { } export namespace TeradataParameters { + /** + * @internal + */ export const filterSensitiveLog = (obj: TeradataParameters): any => ({ ...obj, }); @@ -2774,6 +3056,9 @@ export interface TwitterParameters { } export namespace TwitterParameters { + /** + * @internal + */ export const filterSensitiveLog = (obj: TwitterParameters): any => ({ ...obj, }); @@ -3423,6 +3708,9 @@ export namespace DataSourceParameters { return visitor._(value.$unknown[0], value.$unknown[1]); }; + /** + * @internal + */ export const filterSensitiveLog = (obj: DataSourceParameters): any => { if (obj.AmazonElasticsearchParameters !== undefined) return { @@ -3501,6 +3789,9 @@ export interface CredentialPair { } export namespace CredentialPair { + /** + * @internal + */ export const filterSensitiveLog = (obj: CredentialPair): any => ({ ...obj, ...(obj.AlternateDataSourceParameters && { @@ -3531,6 +3822,9 @@ export interface DataSourceCredentials { } export namespace DataSourceCredentials { + /** + * @internal + */ export const filterSensitiveLog = (obj: DataSourceCredentials): any => ({ ...obj, ...(obj.CredentialPair && { CredentialPair: CredentialPair.filterSensitiveLog(obj.CredentialPair) }), @@ -3549,6 +3843,9 @@ export interface SslProperties { } export namespace SslProperties { + /** + * @internal + */ export const filterSensitiveLog = (obj: SslProperties): any => ({ ...obj, }); @@ -3591,6 +3888,9 @@ export interface VpcConnectionProperties { } export namespace VpcConnectionProperties { + /** + * @internal + */ export const filterSensitiveLog = (obj: VpcConnectionProperties): any => ({ ...obj, }); @@ -3657,6 +3957,9 @@ export interface CreateDataSourceRequest { } export namespace CreateDataSourceRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateDataSourceRequest): any => ({ ...obj, ...(obj.DataSourceParameters && { @@ -3694,6 +3997,9 @@ export interface CreateDataSourceResponse { } export namespace CreateDataSourceResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateDataSourceResponse): any => ({ ...obj, }); @@ -3726,6 +4032,9 @@ export interface CreateGroupRequest { } export namespace CreateGroupRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateGroupRequest): any => ({ ...obj, }); @@ -3758,6 +4067,9 @@ export interface Group { } export namespace Group { + /** + * @internal + */ export const filterSensitiveLog = (obj: Group): any => ({ ...obj, }); @@ -3784,6 +4096,9 @@ export interface CreateGroupResponse { } export namespace CreateGroupResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateGroupResponse): any => ({ ...obj, }); @@ -3803,6 +4118,9 @@ export interface PreconditionNotMetException extends __SmithyException, $Metadat } export namespace PreconditionNotMetException { + /** + * @internal + */ export const filterSensitiveLog = (obj: PreconditionNotMetException): any => ({ ...obj, }); @@ -3832,6 +4150,9 @@ export interface CreateGroupMembershipRequest { } export namespace CreateGroupMembershipRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateGroupMembershipRequest): any => ({ ...obj, }); @@ -3854,6 +4175,9 @@ export interface GroupMember { } export namespace GroupMember { + /** + * @internal + */ export const filterSensitiveLog = (obj: GroupMember): any => ({ ...obj, }); @@ -3877,6 +4201,9 @@ export interface CreateGroupMembershipResponse { } export namespace CreateGroupMembershipResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateGroupMembershipResponse): any => ({ ...obj, }); @@ -3933,6 +4260,9 @@ export interface CreateIAMPolicyAssignmentRequest { } export namespace CreateIAMPolicyAssignmentRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateIAMPolicyAssignmentRequest): any => ({ ...obj, }); @@ -3992,6 +4322,9 @@ export interface CreateIAMPolicyAssignmentResponse { } export namespace CreateIAMPolicyAssignmentResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateIAMPolicyAssignmentResponse): any => ({ ...obj, }); @@ -4015,6 +4348,9 @@ export interface CreateIngestionRequest { } export namespace CreateIngestionRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateIngestionRequest): any => ({ ...obj, }); @@ -4057,6 +4393,9 @@ export interface CreateIngestionResponse { } export namespace CreateIngestionResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateIngestionResponse): any => ({ ...obj, }); @@ -4090,6 +4429,9 @@ export interface CreateNamespaceRequest { } export namespace CreateNamespaceRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateNamespaceRequest): any => ({ ...obj, }); @@ -4147,6 +4489,9 @@ export interface CreateNamespaceResponse { } export namespace CreateNamespaceResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateNamespaceResponse): any => ({ ...obj, }); @@ -4169,6 +4514,9 @@ export interface TemplateSourceAnalysis { } export namespace TemplateSourceAnalysis { + /** + * @internal + */ export const filterSensitiveLog = (obj: TemplateSourceAnalysis): any => ({ ...obj, }); @@ -4185,6 +4533,9 @@ export interface TemplateSourceTemplate { } export namespace TemplateSourceTemplate { + /** + * @internal + */ export const filterSensitiveLog = (obj: TemplateSourceTemplate): any => ({ ...obj, }); @@ -4206,6 +4557,9 @@ export interface TemplateSourceEntity { } export namespace TemplateSourceEntity { + /** + * @internal + */ export const filterSensitiveLog = (obj: TemplateSourceEntity): any => ({ ...obj, }); @@ -4263,6 +4617,9 @@ export interface CreateTemplateRequest { } export namespace CreateTemplateRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateTemplateRequest): any => ({ ...obj, }); @@ -4302,6 +4659,9 @@ export interface CreateTemplateResponse { } export namespace CreateTemplateResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateTemplateResponse): any => ({ ...obj, }); @@ -4332,6 +4692,9 @@ export interface CreateTemplateAliasRequest { } export namespace CreateTemplateAliasRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateTemplateAliasRequest): any => ({ ...obj, }); @@ -4358,6 +4721,9 @@ export interface TemplateAlias { } export namespace TemplateAlias { + /** + * @internal + */ export const filterSensitiveLog = (obj: TemplateAlias): any => ({ ...obj, }); @@ -4381,6 +4747,9 @@ export interface CreateTemplateAliasResponse { } export namespace CreateTemplateAliasResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateTemplateAliasResponse): any => ({ ...obj, }); @@ -4410,6 +4779,9 @@ export interface DataColorPalette { } export namespace DataColorPalette { + /** + * @internal + */ export const filterSensitiveLog = (obj: DataColorPalette): any => ({ ...obj, }); @@ -4426,6 +4798,9 @@ export interface TileStyle { } export namespace TileStyle { + /** + * @internal + */ export const filterSensitiveLog = (obj: TileStyle): any => ({ ...obj, }); @@ -4443,6 +4818,9 @@ export interface GutterStyle { } export namespace GutterStyle { + /** + * @internal + */ export const filterSensitiveLog = (obj: GutterStyle): any => ({ ...obj, }); @@ -4459,6 +4837,9 @@ export interface MarginStyle { } export namespace MarginStyle { + /** + * @internal + */ export const filterSensitiveLog = (obj: MarginStyle): any => ({ ...obj, }); @@ -4480,6 +4861,9 @@ export interface TileLayoutStyle { } export namespace TileLayoutStyle { + /** + * @internal + */ export const filterSensitiveLog = (obj: TileLayoutStyle): any => ({ ...obj, }); @@ -4501,6 +4885,9 @@ export interface SheetStyle { } export namespace SheetStyle { + /** + * @internal + */ export const filterSensitiveLog = (obj: SheetStyle): any => ({ ...obj, }); @@ -4606,6 +4993,9 @@ export interface UIColorPalette { } export namespace UIColorPalette { + /** + * @internal + */ export const filterSensitiveLog = (obj: UIColorPalette): any => ({ ...obj, }); @@ -4634,6 +5024,9 @@ export interface ThemeConfiguration { } export namespace ThemeConfiguration { + /** + * @internal + */ export const filterSensitiveLog = (obj: ThemeConfiguration): any => ({ ...obj, }); @@ -4691,6 +5084,9 @@ export interface CreateThemeRequest { } export namespace CreateThemeRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateThemeRequest): any => ({ ...obj, }); @@ -4729,6 +5125,9 @@ export interface CreateThemeResponse { } export namespace CreateThemeResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateThemeResponse): any => ({ ...obj, }); @@ -4759,6 +5158,9 @@ export interface CreateThemeAliasRequest { } export namespace CreateThemeAliasRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateThemeAliasRequest): any => ({ ...obj, }); @@ -4785,6 +5187,9 @@ export interface ThemeAlias { } export namespace ThemeAlias { + /** + * @internal + */ export const filterSensitiveLog = (obj: ThemeAlias): any => ({ ...obj, }); @@ -4808,6 +5213,9 @@ export interface CreateThemeAliasResponse { } export namespace CreateThemeAliasResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateThemeAliasResponse): any => ({ ...obj, }); @@ -4842,6 +5250,9 @@ export interface DashboardError { } export namespace DashboardError { + /** + * @internal + */ export const filterSensitiveLog = (obj: DashboardError): any => ({ ...obj, }); @@ -4904,6 +5315,9 @@ export interface DashboardVersion { } export namespace DashboardVersion { + /** + * @internal + */ export const filterSensitiveLog = (obj: DashboardVersion): any => ({ ...obj, }); @@ -4950,6 +5364,9 @@ export interface Dashboard { } export namespace Dashboard { + /** + * @internal + */ export const filterSensitiveLog = (obj: Dashboard): any => ({ ...obj, }); @@ -4984,6 +5401,9 @@ export interface DashboardSearchFilter { } export namespace DashboardSearchFilter { + /** + * @internal + */ export const filterSensitiveLog = (obj: DashboardSearchFilter): any => ({ ...obj, }); @@ -5030,6 +5450,9 @@ export interface DashboardSummary { } export namespace DashboardSummary { + /** + * @internal + */ export const filterSensitiveLog = (obj: DashboardSummary): any => ({ ...obj, }); @@ -5071,6 +5494,9 @@ export interface DashboardVersionSummary { } export namespace DashboardVersionSummary { + /** + * @internal + */ export const filterSensitiveLog = (obj: DashboardVersionSummary): any => ({ ...obj, }); @@ -5097,6 +5523,9 @@ export interface OutputColumn { } export namespace OutputColumn { + /** + * @internal + */ export const filterSensitiveLog = (obj: OutputColumn): any => ({ ...obj, }); @@ -5184,6 +5613,9 @@ export interface DataSet { } export namespace DataSet { + /** + * @internal + */ export const filterSensitiveLog = (obj: DataSet): any => ({ ...obj, ...(obj.PhysicalTableMap && { @@ -5218,6 +5650,9 @@ export interface DataSetSchema { } export namespace DataSetSchema { + /** + * @internal + */ export const filterSensitiveLog = (obj: DataSetSchema): any => ({ ...obj, }); @@ -5244,6 +5679,9 @@ export interface DataSetConfiguration { } export namespace DataSetConfiguration { + /** + * @internal + */ export const filterSensitiveLog = (obj: DataSetConfiguration): any => ({ ...obj, }); @@ -5295,6 +5733,9 @@ export interface DataSetSummary { } export namespace DataSetSummary { + /** + * @internal + */ export const filterSensitiveLog = (obj: DataSetSummary): any => ({ ...obj, }); @@ -5327,6 +5768,9 @@ export interface DataSourceErrorInfo { } export namespace DataSourceErrorInfo { + /** + * @internal + */ export const filterSensitiveLog = (obj: DataSourceErrorInfo): any => ({ ...obj, }); @@ -5412,6 +5856,9 @@ export interface DataSource { } export namespace DataSource { + /** + * @internal + */ export const filterSensitiveLog = (obj: DataSource): any => ({ ...obj, ...(obj.DataSourceParameters && { @@ -5439,6 +5886,9 @@ export interface DeleteAccountCustomizationRequest { } export namespace DeleteAccountCustomizationRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteAccountCustomizationRequest): any => ({ ...obj, }); @@ -5457,6 +5907,9 @@ export interface DeleteAccountCustomizationResponse { } export namespace DeleteAccountCustomizationResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteAccountCustomizationResponse): any => ({ ...obj, }); @@ -5489,6 +5942,9 @@ export interface DeleteAnalysisRequest { } export namespace DeleteAnalysisRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteAnalysisRequest): any => ({ ...obj, }); @@ -5522,6 +5978,9 @@ export interface DeleteAnalysisResponse { } export namespace DeleteAnalysisResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteAnalysisResponse): any => ({ ...obj, }); @@ -5547,6 +6006,9 @@ export interface DeleteDashboardRequest { } export namespace DeleteDashboardRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteDashboardRequest): any => ({ ...obj, }); @@ -5575,6 +6037,9 @@ export interface DeleteDashboardResponse { } export namespace DeleteDashboardResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteDashboardResponse): any => ({ ...obj, }); @@ -5593,6 +6058,9 @@ export interface DeleteDataSetRequest { } export namespace DeleteDataSetRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteDataSetRequest): any => ({ ...obj, }); @@ -5621,6 +6089,9 @@ export interface DeleteDataSetResponse { } export namespace DeleteDataSetResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteDataSetResponse): any => ({ ...obj, }); @@ -5639,6 +6110,9 @@ export interface DeleteDataSourceRequest { } export namespace DeleteDataSourceRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteDataSourceRequest): any => ({ ...obj, }); @@ -5667,6 +6141,9 @@ export interface DeleteDataSourceResponse { } export namespace DeleteDataSourceResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteDataSourceResponse): any => ({ ...obj, }); @@ -5691,6 +6168,9 @@ export interface DeleteGroupRequest { } export namespace DeleteGroupRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteGroupRequest): any => ({ ...obj, }); @@ -5709,6 +6189,9 @@ export interface DeleteGroupResponse { } export namespace DeleteGroupResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteGroupResponse): any => ({ ...obj, }); @@ -5738,6 +6221,9 @@ export interface DeleteGroupMembershipRequest { } export namespace DeleteGroupMembershipRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteGroupMembershipRequest): any => ({ ...obj, }); @@ -5756,6 +6242,9 @@ export interface DeleteGroupMembershipResponse { } export namespace DeleteGroupMembershipResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteGroupMembershipResponse): any => ({ ...obj, }); @@ -5779,6 +6268,9 @@ export interface DeleteIAMPolicyAssignmentRequest { } export namespace DeleteIAMPolicyAssignmentRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteIAMPolicyAssignmentRequest): any => ({ ...obj, }); @@ -5802,6 +6294,9 @@ export interface DeleteIAMPolicyAssignmentResponse { } export namespace DeleteIAMPolicyAssignmentResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteIAMPolicyAssignmentResponse): any => ({ ...obj, }); @@ -5820,6 +6315,9 @@ export interface DeleteNamespaceRequest { } export namespace DeleteNamespaceRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteNamespaceRequest): any => ({ ...obj, }); @@ -5838,6 +6336,9 @@ export interface DeleteNamespaceResponse { } export namespace DeleteNamespaceResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteNamespaceResponse): any => ({ ...obj, }); @@ -5863,6 +6364,9 @@ export interface DeleteTemplateRequest { } export namespace DeleteTemplateRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteTemplateRequest): any => ({ ...obj, }); @@ -5891,6 +6395,9 @@ export interface DeleteTemplateResponse { } export namespace DeleteTemplateResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteTemplateResponse): any => ({ ...obj, }); @@ -5917,6 +6424,9 @@ export interface DeleteTemplateAliasRequest { } export namespace DeleteTemplateAliasRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteTemplateAliasRequest): any => ({ ...obj, }); @@ -5950,6 +6460,9 @@ export interface DeleteTemplateAliasResponse { } export namespace DeleteTemplateAliasResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteTemplateAliasResponse): any => ({ ...obj, }); @@ -5976,6 +6489,9 @@ export interface DeleteThemeRequest { } export namespace DeleteThemeRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteThemeRequest): any => ({ ...obj, }); @@ -6004,6 +6520,9 @@ export interface DeleteThemeResponse { } export namespace DeleteThemeResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteThemeResponse): any => ({ ...obj, }); @@ -6027,6 +6546,9 @@ export interface DeleteThemeAliasRequest { } export namespace DeleteThemeAliasRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteThemeAliasRequest): any => ({ ...obj, }); @@ -6060,6 +6582,9 @@ export interface DeleteThemeAliasResponse { } export namespace DeleteThemeAliasResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteThemeAliasResponse): any => ({ ...obj, }); @@ -6084,6 +6609,9 @@ export interface DeleteUserRequest { } export namespace DeleteUserRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteUserRequest): any => ({ ...obj, }); @@ -6102,6 +6630,9 @@ export interface DeleteUserResponse { } export namespace DeleteUserResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteUserResponse): any => ({ ...obj, }); @@ -6129,6 +6660,9 @@ export interface DeleteUserByPrincipalIdRequest { } export namespace DeleteUserByPrincipalIdRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteUserByPrincipalIdRequest): any => ({ ...obj, }); @@ -6147,6 +6681,9 @@ export interface DeleteUserByPrincipalIdResponse { } export namespace DeleteUserByPrincipalIdResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteUserByPrincipalIdResponse): any => ({ ...obj, }); @@ -6176,6 +6713,9 @@ export interface DescribeAccountCustomizationRequest { } export namespace DescribeAccountCustomizationRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeAccountCustomizationRequest): any => ({ ...obj, }); @@ -6214,6 +6754,9 @@ export interface DescribeAccountCustomizationResponse { } export namespace DescribeAccountCustomizationResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeAccountCustomizationResponse): any => ({ ...obj, }); @@ -6227,6 +6770,9 @@ export interface DescribeAccountSettingsRequest { } export namespace DescribeAccountSettingsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeAccountSettingsRequest): any => ({ ...obj, }); @@ -6255,6 +6801,9 @@ export interface DescribeAccountSettingsResponse { } export namespace DescribeAccountSettingsResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeAccountSettingsResponse): any => ({ ...obj, }); @@ -6275,6 +6824,9 @@ export interface DescribeAnalysisRequest { } export namespace DescribeAnalysisRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeAnalysisRequest): any => ({ ...obj, }); @@ -6299,6 +6851,9 @@ export interface DescribeAnalysisResponse { } export namespace DescribeAnalysisResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeAnalysisResponse): any => ({ ...obj, }); @@ -6319,6 +6874,9 @@ export interface DescribeAnalysisPermissionsRequest { } export namespace DescribeAnalysisPermissionsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeAnalysisPermissionsRequest): any => ({ ...obj, }); @@ -6354,6 +6912,9 @@ export interface DescribeAnalysisPermissionsResponse { } export namespace DescribeAnalysisPermissionsResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeAnalysisPermissionsResponse): any => ({ ...obj, }); @@ -6384,6 +6945,9 @@ export interface DescribeDashboardRequest { } export namespace DescribeDashboardRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeDashboardRequest): any => ({ ...obj, }); @@ -6407,6 +6971,9 @@ export interface DescribeDashboardResponse { } export namespace DescribeDashboardResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeDashboardResponse): any => ({ ...obj, }); @@ -6426,6 +6993,9 @@ export interface DescribeDashboardPermissionsRequest { } export namespace DescribeDashboardPermissionsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeDashboardPermissionsRequest): any => ({ ...obj, }); @@ -6459,6 +7029,9 @@ export interface DescribeDashboardPermissionsResponse { } export namespace DescribeDashboardPermissionsResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeDashboardPermissionsResponse): any => ({ ...obj, }); @@ -6477,6 +7050,9 @@ export interface DescribeDataSetRequest { } export namespace DescribeDataSetRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeDataSetRequest): any => ({ ...obj, }); @@ -6500,6 +7076,9 @@ export interface DescribeDataSetResponse { } export namespace DescribeDataSetResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeDataSetResponse): any => ({ ...obj, ...(obj.DataSet && { DataSet: DataSet.filterSensitiveLog(obj.DataSet) }), @@ -6519,6 +7098,9 @@ export interface DescribeDataSetPermissionsRequest { } export namespace DescribeDataSetPermissionsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeDataSetPermissionsRequest): any => ({ ...obj, }); @@ -6552,6 +7134,9 @@ export interface DescribeDataSetPermissionsResponse { } export namespace DescribeDataSetPermissionsResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeDataSetPermissionsResponse): any => ({ ...obj, }); @@ -6570,6 +7155,9 @@ export interface DescribeDataSourceRequest { } export namespace DescribeDataSourceRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeDataSourceRequest): any => ({ ...obj, }); @@ -6593,6 +7181,9 @@ export interface DescribeDataSourceResponse { } export namespace DescribeDataSourceResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeDataSourceResponse): any => ({ ...obj, ...(obj.DataSource && { DataSource: DataSource.filterSensitiveLog(obj.DataSource) }), @@ -6612,6 +7203,9 @@ export interface DescribeDataSourcePermissionsRequest { } export namespace DescribeDataSourcePermissionsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeDataSourcePermissionsRequest): any => ({ ...obj, }); @@ -6645,6 +7239,9 @@ export interface DescribeDataSourcePermissionsResponse { } export namespace DescribeDataSourcePermissionsResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeDataSourcePermissionsResponse): any => ({ ...obj, }); @@ -6669,6 +7266,9 @@ export interface DescribeGroupRequest { } export namespace DescribeGroupRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeGroupRequest): any => ({ ...obj, }); @@ -6692,6 +7292,9 @@ export interface DescribeGroupResponse { } export namespace DescribeGroupResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeGroupResponse): any => ({ ...obj, }); @@ -6715,6 +7318,9 @@ export interface DescribeIAMPolicyAssignmentRequest { } export namespace DescribeIAMPolicyAssignmentRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeIAMPolicyAssignmentRequest): any => ({ ...obj, }); @@ -6756,6 +7362,9 @@ export interface IAMPolicyAssignment { } export namespace IAMPolicyAssignment { + /** + * @internal + */ export const filterSensitiveLog = (obj: IAMPolicyAssignment): any => ({ ...obj, }); @@ -6779,6 +7388,9 @@ export interface DescribeIAMPolicyAssignmentResponse { } export namespace DescribeIAMPolicyAssignmentResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeIAMPolicyAssignmentResponse): any => ({ ...obj, }); @@ -6798,6 +7410,9 @@ export interface InvalidNextTokenException extends __SmithyException, $MetadataB } export namespace InvalidNextTokenException { + /** + * @internal + */ export const filterSensitiveLog = (obj: InvalidNextTokenException): any => ({ ...obj, }); @@ -6821,6 +7436,9 @@ export interface DescribeIngestionRequest { } export namespace DescribeIngestionRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeIngestionRequest): any => ({ ...obj, }); @@ -6885,6 +7503,9 @@ export interface ErrorInfo { } export namespace ErrorInfo { + /** + * @internal + */ export const filterSensitiveLog = (obj: ErrorInfo): any => ({ ...obj, }); @@ -6907,6 +7528,9 @@ export interface QueueInfo { } export namespace QueueInfo { + /** + * @internal + */ export const filterSensitiveLog = (obj: QueueInfo): any => ({ ...obj, }); @@ -6940,6 +7564,9 @@ export interface RowInfo { } export namespace RowInfo { + /** + * @internal + */ export const filterSensitiveLog = (obj: RowInfo): any => ({ ...obj, }); @@ -7006,6 +7633,9 @@ export interface Ingestion { } export namespace Ingestion { + /** + * @internal + */ export const filterSensitiveLog = (obj: Ingestion): any => ({ ...obj, }); @@ -7029,6 +7659,9 @@ export interface DescribeIngestionResponse { } export namespace DescribeIngestionResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeIngestionResponse): any => ({ ...obj, }); @@ -7047,6 +7680,9 @@ export interface DescribeNamespaceRequest { } export namespace DescribeNamespaceRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeNamespaceRequest): any => ({ ...obj, }); @@ -7073,6 +7709,9 @@ export interface NamespaceError { } export namespace NamespaceError { + /** + * @internal + */ export const filterSensitiveLog = (obj: NamespaceError): any => ({ ...obj, }); @@ -7114,6 +7753,9 @@ export interface NamespaceInfoV2 { } export namespace NamespaceInfoV2 { + /** + * @internal + */ export const filterSensitiveLog = (obj: NamespaceInfoV2): any => ({ ...obj, }); @@ -7140,6 +7782,9 @@ export interface DescribeNamespaceResponse { } export namespace DescribeNamespaceResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeNamespaceResponse): any => ({ ...obj, }); @@ -7172,6 +7817,9 @@ export interface DescribeTemplateRequest { } export namespace DescribeTemplateRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeTemplateRequest): any => ({ ...obj, }); @@ -7200,6 +7848,9 @@ export interface TemplateError { } export namespace TemplateError { + /** + * @internal + */ export const filterSensitiveLog = (obj: TemplateError): any => ({ ...obj, }); @@ -7259,6 +7910,9 @@ export interface TemplateVersion { } export namespace TemplateVersion { + /** + * @internal + */ export const filterSensitiveLog = (obj: TemplateVersion): any => ({ ...obj, }); @@ -7307,6 +7961,9 @@ export interface Template { } export namespace Template { + /** + * @internal + */ export const filterSensitiveLog = (obj: Template): any => ({ ...obj, }); @@ -7330,6 +7987,9 @@ export interface DescribeTemplateResponse { } export namespace DescribeTemplateResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeTemplateResponse): any => ({ ...obj, }); @@ -7357,6 +8017,9 @@ export interface DescribeTemplateAliasRequest { } export namespace DescribeTemplateAliasRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeTemplateAliasRequest): any => ({ ...obj, }); @@ -7380,6 +8043,9 @@ export interface DescribeTemplateAliasResponse { } export namespace DescribeTemplateAliasResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeTemplateAliasResponse): any => ({ ...obj, }); @@ -7398,6 +8064,9 @@ export interface DescribeTemplatePermissionsRequest { } export namespace DescribeTemplatePermissionsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeTemplatePermissionsRequest): any => ({ ...obj, }); @@ -7431,6 +8100,9 @@ export interface DescribeTemplatePermissionsResponse { } export namespace DescribeTemplatePermissionsResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeTemplatePermissionsResponse): any => ({ ...obj, }); @@ -7463,6 +8135,9 @@ export interface DescribeThemeRequest { } export namespace DescribeThemeRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeThemeRequest): any => ({ ...obj, }); @@ -7494,6 +8169,9 @@ export interface ThemeError { } export namespace ThemeError { + /** + * @internal + */ export const filterSensitiveLog = (obj: ThemeError): any => ({ ...obj, }); @@ -7546,6 +8224,9 @@ export interface ThemeVersion { } export namespace ThemeVersion { + /** + * @internal + */ export const filterSensitiveLog = (obj: ThemeVersion): any => ({ ...obj, }); @@ -7593,6 +8274,9 @@ export interface Theme { } export namespace Theme { + /** + * @internal + */ export const filterSensitiveLog = (obj: Theme): any => ({ ...obj, }); @@ -7616,6 +8300,9 @@ export interface DescribeThemeResponse { } export namespace DescribeThemeResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeThemeResponse): any => ({ ...obj, }); @@ -7640,6 +8327,9 @@ export interface DescribeThemeAliasRequest { } export namespace DescribeThemeAliasRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeThemeAliasRequest): any => ({ ...obj, }); @@ -7663,6 +8353,9 @@ export interface DescribeThemeAliasResponse { } export namespace DescribeThemeAliasResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeThemeAliasResponse): any => ({ ...obj, }); @@ -7681,6 +8374,9 @@ export interface DescribeThemePermissionsRequest { } export namespace DescribeThemePermissionsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeThemePermissionsRequest): any => ({ ...obj, }); @@ -7714,6 +8410,9 @@ export interface DescribeThemePermissionsResponse { } export namespace DescribeThemePermissionsResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeThemePermissionsResponse): any => ({ ...obj, }); @@ -7738,6 +8437,9 @@ export interface DescribeUserRequest { } export namespace DescribeUserRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeUserRequest): any => ({ ...obj, }); @@ -7831,6 +8533,9 @@ export interface User { } export namespace User { + /** + * @internal + */ export const filterSensitiveLog = (obj: User): any => ({ ...obj, }); @@ -7854,6 +8559,9 @@ export interface DescribeUserResponse { } export namespace DescribeUserResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeUserResponse): any => ({ ...obj, }); @@ -7874,6 +8582,9 @@ export interface DomainNotWhitelistedException extends __SmithyException, $Metad } export namespace DomainNotWhitelistedException { + /** + * @internal + */ export const filterSensitiveLog = (obj: DomainNotWhitelistedException): any => ({ ...obj, }); @@ -7970,6 +8681,9 @@ export interface GetDashboardEmbedUrlRequest { } export namespace GetDashboardEmbedUrlRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetDashboardEmbedUrlRequest): any => ({ ...obj, }); @@ -7999,6 +8713,9 @@ export interface GetDashboardEmbedUrlResponse { } export namespace GetDashboardEmbedUrlResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetDashboardEmbedUrlResponse): any => ({ ...obj, ...(obj.EmbedUrl && { EmbedUrl: SENSITIVE_STRING }), @@ -8020,6 +8737,9 @@ export interface IdentityTypeNotSupportedException extends __SmithyException, $M } export namespace IdentityTypeNotSupportedException { + /** + * @internal + */ export const filterSensitiveLog = (obj: IdentityTypeNotSupportedException): any => ({ ...obj, }); @@ -8041,6 +8761,9 @@ export interface QuickSightUserNotFoundException extends __SmithyException, $Met } export namespace QuickSightUserNotFoundException { + /** + * @internal + */ export const filterSensitiveLog = (obj: QuickSightUserNotFoundException): any => ({ ...obj, }); @@ -8061,6 +8784,9 @@ export interface SessionLifetimeInMinutesInvalidException extends __SmithyExcept } export namespace SessionLifetimeInMinutesInvalidException { + /** + * @internal + */ export const filterSensitiveLog = (obj: SessionLifetimeInMinutesInvalidException): any => ({ ...obj, }); @@ -8086,6 +8812,9 @@ export interface UnsupportedPricingPlanException extends __SmithyException, $Met } export namespace UnsupportedPricingPlanException { + /** + * @internal + */ export const filterSensitiveLog = (obj: UnsupportedPricingPlanException): any => ({ ...obj, }); @@ -8164,6 +8893,9 @@ export interface GetSessionEmbedUrlRequest { } export namespace GetSessionEmbedUrlRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetSessionEmbedUrlRequest): any => ({ ...obj, }); @@ -8190,6 +8922,9 @@ export interface GetSessionEmbedUrlResponse { } export namespace GetSessionEmbedUrlResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetSessionEmbedUrlResponse): any => ({ ...obj, ...(obj.EmbedUrl && { EmbedUrl: SENSITIVE_STRING }), @@ -8212,6 +8947,9 @@ export interface IAMPolicyAssignmentSummary { } export namespace IAMPolicyAssignmentSummary { + /** + * @internal + */ export const filterSensitiveLog = (obj: IAMPolicyAssignmentSummary): any => ({ ...obj, }); @@ -8235,6 +8973,9 @@ export interface ListAnalysesRequest { } export namespace ListAnalysesRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListAnalysesRequest): any => ({ ...obj, }); @@ -8263,6 +9004,9 @@ export interface ListAnalysesResponse { } export namespace ListAnalysesResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListAnalysesResponse): any => ({ ...obj, }); @@ -8287,6 +9031,9 @@ export interface ListDashboardsRequest { } export namespace ListDashboardsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListDashboardsRequest): any => ({ ...obj, }); @@ -8316,6 +9063,9 @@ export interface ListDashboardsResponse { } export namespace ListDashboardsResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListDashboardsResponse): any => ({ ...obj, }); @@ -8345,6 +9095,9 @@ export interface ListDashboardVersionsRequest { } export namespace ListDashboardVersionsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListDashboardVersionsRequest): any => ({ ...obj, }); @@ -8373,6 +9126,9 @@ export interface ListDashboardVersionsResponse { } export namespace ListDashboardVersionsResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListDashboardVersionsResponse): any => ({ ...obj, }); @@ -8396,6 +9152,9 @@ export interface ListDataSetsRequest { } export namespace ListDataSetsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListDataSetsRequest): any => ({ ...obj, }); @@ -8424,6 +9183,9 @@ export interface ListDataSetsResponse { } export namespace ListDataSetsResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListDataSetsResponse): any => ({ ...obj, }); @@ -8447,6 +9209,9 @@ export interface ListDataSourcesRequest { } export namespace ListDataSourcesRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListDataSourcesRequest): any => ({ ...obj, }); @@ -8475,6 +9240,9 @@ export interface ListDataSourcesResponse { } export namespace ListDataSourcesResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListDataSourcesResponse): any => ({ ...obj, ...(obj.DataSources && { DataSources: obj.DataSources.map((item) => DataSource.filterSensitiveLog(item)) }), @@ -8510,6 +9278,9 @@ export interface ListGroupMembershipsRequest { } export namespace ListGroupMembershipsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListGroupMembershipsRequest): any => ({ ...obj, }); @@ -8538,6 +9309,9 @@ export interface ListGroupMembershipsResponse { } export namespace ListGroupMembershipsResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListGroupMembershipsResponse): any => ({ ...obj, }); @@ -8567,6 +9341,9 @@ export interface ListGroupsRequest { } export namespace ListGroupsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListGroupsRequest): any => ({ ...obj, }); @@ -8595,6 +9372,9 @@ export interface ListGroupsResponse { } export namespace ListGroupsResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListGroupsResponse): any => ({ ...obj, }); @@ -8628,6 +9408,9 @@ export interface ListIAMPolicyAssignmentsRequest { } export namespace ListIAMPolicyAssignmentsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListIAMPolicyAssignmentsRequest): any => ({ ...obj, }); @@ -8656,6 +9439,9 @@ export interface ListIAMPolicyAssignmentsResponse { } export namespace ListIAMPolicyAssignmentsResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListIAMPolicyAssignmentsResponse): any => ({ ...obj, }); @@ -8689,6 +9475,9 @@ export interface ListIAMPolicyAssignmentsForUserRequest { } export namespace ListIAMPolicyAssignmentsForUserRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListIAMPolicyAssignmentsForUserRequest): any => ({ ...obj, }); @@ -8717,6 +9506,9 @@ export interface ListIAMPolicyAssignmentsForUserResponse { } export namespace ListIAMPolicyAssignmentsForUserResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListIAMPolicyAssignmentsForUserResponse): any => ({ ...obj, }); @@ -8745,6 +9537,9 @@ export interface ListIngestionsRequest { } export namespace ListIngestionsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListIngestionsRequest): any => ({ ...obj, }); diff --git a/clients/client-quicksight/models/models_1.ts b/clients/client-quicksight/models/models_1.ts index 6a65da743a9b..edaf214d7ed2 100644 --- a/clients/client-quicksight/models/models_1.ts +++ b/clients/client-quicksight/models/models_1.ts @@ -60,6 +60,9 @@ export interface ListIngestionsResponse { } export namespace ListIngestionsResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListIngestionsResponse): any => ({ ...obj, }); @@ -83,6 +86,9 @@ export interface ListNamespacesRequest { } export namespace ListNamespacesRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListNamespacesRequest): any => ({ ...obj, }); @@ -113,6 +119,9 @@ export interface ListNamespacesResponse { } export namespace ListNamespacesResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListNamespacesResponse): any => ({ ...obj, }); @@ -126,6 +135,9 @@ export interface ListTagsForResourceRequest { } export namespace ListTagsForResourceRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListTagsForResourceRequest): any => ({ ...obj, }); @@ -150,6 +162,9 @@ export interface ListTagsForResourceResponse { } export namespace ListTagsForResourceResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListTagsForResourceResponse): any => ({ ...obj, }); @@ -178,6 +193,9 @@ export interface ListTemplateAliasesRequest { } export namespace ListTemplateAliasesRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListTemplateAliasesRequest): any => ({ ...obj, }); @@ -206,6 +224,9 @@ export interface ListTemplateAliasesResponse { } export namespace ListTemplateAliasesResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListTemplateAliasesResponse): any => ({ ...obj, }); @@ -229,6 +250,9 @@ export interface ListTemplatesRequest { } export namespace ListTemplatesRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListTemplatesRequest): any => ({ ...obj, }); @@ -270,6 +294,9 @@ export interface TemplateSummary { } export namespace TemplateSummary { + /** + * @internal + */ export const filterSensitiveLog = (obj: TemplateSummary): any => ({ ...obj, }); @@ -298,6 +325,9 @@ export interface ListTemplatesResponse { } export namespace ListTemplatesResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListTemplatesResponse): any => ({ ...obj, }); @@ -326,6 +356,9 @@ export interface ListTemplateVersionsRequest { } export namespace ListTemplateVersionsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListTemplateVersionsRequest): any => ({ ...obj, }); @@ -362,6 +395,9 @@ export interface TemplateVersionSummary { } export namespace TemplateVersionSummary { + /** + * @internal + */ export const filterSensitiveLog = (obj: TemplateVersionSummary): any => ({ ...obj, }); @@ -390,6 +426,9 @@ export interface ListTemplateVersionsResponse { } export namespace ListTemplateVersionsResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListTemplateVersionsResponse): any => ({ ...obj, }); @@ -418,6 +457,9 @@ export interface ListThemeAliasesRequest { } export namespace ListThemeAliasesRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListThemeAliasesRequest): any => ({ ...obj, }); @@ -446,6 +488,9 @@ export interface ListThemeAliasesResponse { } export namespace ListThemeAliasesResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListThemeAliasesResponse): any => ({ ...obj, }); @@ -488,6 +533,9 @@ export interface ListThemesRequest { } export namespace ListThemesRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListThemesRequest): any => ({ ...obj, }); @@ -529,6 +577,9 @@ export interface ThemeSummary { } export namespace ThemeSummary { + /** + * @internal + */ export const filterSensitiveLog = (obj: ThemeSummary): any => ({ ...obj, }); @@ -557,6 +608,9 @@ export interface ListThemesResponse { } export namespace ListThemesResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListThemesResponse): any => ({ ...obj, }); @@ -585,6 +639,9 @@ export interface ListThemeVersionsRequest { } export namespace ListThemeVersionsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListThemeVersionsRequest): any => ({ ...obj, }); @@ -621,6 +678,9 @@ export interface ThemeVersionSummary { } export namespace ThemeVersionSummary { + /** + * @internal + */ export const filterSensitiveLog = (obj: ThemeVersionSummary): any => ({ ...obj, }); @@ -649,6 +709,9 @@ export interface ListThemeVersionsResponse { } export namespace ListThemeVersionsResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListThemeVersionsResponse): any => ({ ...obj, }); @@ -683,6 +746,9 @@ export interface ListUserGroupsRequest { } export namespace ListUserGroupsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListUserGroupsRequest): any => ({ ...obj, }); @@ -711,6 +777,9 @@ export interface ListUserGroupsResponse { } export namespace ListUserGroupsResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListUserGroupsResponse): any => ({ ...obj, }); @@ -740,6 +809,9 @@ export interface ListUsersRequest { } export namespace ListUsersRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListUsersRequest): any => ({ ...obj, }); @@ -768,6 +840,9 @@ export interface ListUsersResponse { } export namespace ListUsersResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListUsersResponse): any => ({ ...obj, }); @@ -898,6 +973,9 @@ export interface RegisterUserRequest { } export namespace RegisterUserRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: RegisterUserRequest): any => ({ ...obj, }); @@ -927,6 +1005,9 @@ export interface RegisterUserResponse { } export namespace RegisterUserResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: RegisterUserResponse): any => ({ ...obj, }); @@ -945,6 +1026,9 @@ export interface RestoreAnalysisRequest { } export namespace RestoreAnalysisRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: RestoreAnalysisRequest): any => ({ ...obj, }); @@ -974,6 +1058,9 @@ export interface RestoreAnalysisResponse { } export namespace RestoreAnalysisResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: RestoreAnalysisResponse): any => ({ ...obj, }); @@ -1003,6 +1090,9 @@ export interface SearchAnalysesRequest { } export namespace SearchAnalysesRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: SearchAnalysesRequest): any => ({ ...obj, }); @@ -1032,6 +1122,9 @@ export interface SearchAnalysesResponse { } export namespace SearchAnalysesResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: SearchAnalysesResponse): any => ({ ...obj, }); @@ -1064,6 +1157,9 @@ export interface SearchDashboardsRequest { } export namespace SearchDashboardsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: SearchDashboardsRequest): any => ({ ...obj, }); @@ -1093,6 +1189,9 @@ export interface SearchDashboardsResponse { } export namespace SearchDashboardsResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: SearchDashboardsResponse): any => ({ ...obj, }); @@ -1111,6 +1210,9 @@ export interface TagResourceRequest { } export namespace TagResourceRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: TagResourceRequest): any => ({ ...obj, }); @@ -1129,6 +1231,9 @@ export interface TagResourceResponse { } export namespace TagResourceResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: TagResourceResponse): any => ({ ...obj, }); @@ -1147,6 +1252,9 @@ export interface UntagResourceRequest { } export namespace UntagResourceRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: UntagResourceRequest): any => ({ ...obj, }); @@ -1165,6 +1273,9 @@ export interface UntagResourceResponse { } export namespace UntagResourceResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: UntagResourceResponse): any => ({ ...obj, }); @@ -1189,6 +1300,9 @@ export interface UpdateAccountCustomizationRequest { } export namespace UpdateAccountCustomizationRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateAccountCustomizationRequest): any => ({ ...obj, }); @@ -1228,6 +1342,9 @@ export interface UpdateAccountCustomizationResponse { } export namespace UpdateAccountCustomizationResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateAccountCustomizationResponse): any => ({ ...obj, }); @@ -1256,6 +1373,9 @@ export interface UpdateAccountSettingsRequest { } export namespace UpdateAccountSettingsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateAccountSettingsRequest): any => ({ ...obj, }); @@ -1274,6 +1394,9 @@ export interface UpdateAccountSettingsResponse { } export namespace UpdateAccountSettingsResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateAccountSettingsResponse): any => ({ ...obj, }); @@ -1318,6 +1441,9 @@ export interface UpdateAnalysisRequest { } export namespace UpdateAnalysisRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateAnalysisRequest): any => ({ ...obj, }); @@ -1351,6 +1477,9 @@ export interface UpdateAnalysisResponse { } export namespace UpdateAnalysisResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateAnalysisResponse): any => ({ ...obj, }); @@ -1383,6 +1512,9 @@ export interface UpdateAnalysisPermissionsRequest { } export namespace UpdateAnalysisPermissionsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateAnalysisPermissionsRequest): any => ({ ...obj, }); @@ -1417,6 +1549,9 @@ export interface UpdateAnalysisPermissionsResponse { } export namespace UpdateAnalysisPermissionsResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateAnalysisPermissionsResponse): any => ({ ...obj, }); @@ -1504,6 +1639,9 @@ export interface UpdateDashboardRequest { } export namespace UpdateDashboardRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateDashboardRequest): any => ({ ...obj, }); @@ -1542,6 +1680,9 @@ export interface UpdateDashboardResponse { } export namespace UpdateDashboardResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateDashboardResponse): any => ({ ...obj, }); @@ -1571,6 +1712,9 @@ export interface UpdateDashboardPermissionsRequest { } export namespace UpdateDashboardPermissionsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateDashboardPermissionsRequest): any => ({ ...obj, }); @@ -1604,6 +1748,9 @@ export interface UpdateDashboardPermissionsResponse { } export namespace UpdateDashboardPermissionsResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateDashboardPermissionsResponse): any => ({ ...obj, }); @@ -1628,6 +1775,9 @@ export interface UpdateDashboardPublishedVersionRequest { } export namespace UpdateDashboardPublishedVersionRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateDashboardPublishedVersionRequest): any => ({ ...obj, }); @@ -1656,6 +1806,9 @@ export interface UpdateDashboardPublishedVersionResponse { } export namespace UpdateDashboardPublishedVersionResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateDashboardPublishedVersionResponse): any => ({ ...obj, }); @@ -1717,6 +1870,9 @@ export interface UpdateDataSetRequest { } export namespace UpdateDataSetRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateDataSetRequest): any => ({ ...obj, ...(obj.PhysicalTableMap && { @@ -1775,6 +1931,9 @@ export interface UpdateDataSetResponse { } export namespace UpdateDataSetResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateDataSetResponse): any => ({ ...obj, }); @@ -1804,6 +1963,9 @@ export interface UpdateDataSetPermissionsRequest { } export namespace UpdateDataSetPermissionsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateDataSetPermissionsRequest): any => ({ ...obj, }); @@ -1833,6 +1995,9 @@ export interface UpdateDataSetPermissionsResponse { } export namespace UpdateDataSetPermissionsResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateDataSetPermissionsResponse): any => ({ ...obj, }); @@ -1879,6 +2044,9 @@ export interface UpdateDataSourceRequest { } export namespace UpdateDataSourceRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateDataSourceRequest): any => ({ ...obj, ...(obj.DataSourceParameters && { @@ -1916,6 +2084,9 @@ export interface UpdateDataSourceResponse { } export namespace UpdateDataSourceResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateDataSourceResponse): any => ({ ...obj, }); @@ -1944,6 +2115,9 @@ export interface UpdateDataSourcePermissionsRequest { } export namespace UpdateDataSourcePermissionsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateDataSourcePermissionsRequest): any => ({ ...obj, }); @@ -1972,6 +2146,9 @@ export interface UpdateDataSourcePermissionsResponse { } export namespace UpdateDataSourcePermissionsResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateDataSourcePermissionsResponse): any => ({ ...obj, }); @@ -2001,6 +2178,9 @@ export interface UpdateGroupRequest { } export namespace UpdateGroupRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateGroupRequest): any => ({ ...obj, }); @@ -2024,6 +2204,9 @@ export interface UpdateGroupResponse { } export namespace UpdateGroupResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateGroupResponse): any => ({ ...obj, }); @@ -2079,6 +2262,9 @@ export interface UpdateIAMPolicyAssignmentRequest { } export namespace UpdateIAMPolicyAssignmentRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateIAMPolicyAssignmentRequest): any => ({ ...obj, }); @@ -2139,6 +2325,9 @@ export interface UpdateIAMPolicyAssignmentResponse { } export namespace UpdateIAMPolicyAssignmentResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateIAMPolicyAssignmentResponse): any => ({ ...obj, }); @@ -2184,6 +2373,9 @@ export interface UpdateTemplateRequest { } export namespace UpdateTemplateRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateTemplateRequest): any => ({ ...obj, }); @@ -2222,6 +2414,9 @@ export interface UpdateTemplateResponse { } export namespace UpdateTemplateResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateTemplateResponse): any => ({ ...obj, }); @@ -2253,6 +2448,9 @@ export interface UpdateTemplateAliasRequest { } export namespace UpdateTemplateAliasRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateTemplateAliasRequest): any => ({ ...obj, }); @@ -2276,6 +2474,9 @@ export interface UpdateTemplateAliasResponse { } export namespace UpdateTemplateAliasResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateTemplateAliasResponse): any => ({ ...obj, }); @@ -2304,6 +2505,9 @@ export interface UpdateTemplatePermissionsRequest { } export namespace UpdateTemplatePermissionsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateTemplatePermissionsRequest): any => ({ ...obj, }); @@ -2337,6 +2541,9 @@ export interface UpdateTemplatePermissionsResponse { } export namespace UpdateTemplatePermissionsResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateTemplatePermissionsResponse): any => ({ ...obj, }); @@ -2378,6 +2585,9 @@ export interface UpdateThemeRequest { } export namespace UpdateThemeRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateThemeRequest): any => ({ ...obj, }); @@ -2416,6 +2626,9 @@ export interface UpdateThemeResponse { } export namespace UpdateThemeResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateThemeResponse): any => ({ ...obj, }); @@ -2444,6 +2657,9 @@ export interface UpdateThemeAliasRequest { } export namespace UpdateThemeAliasRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateThemeAliasRequest): any => ({ ...obj, }); @@ -2467,6 +2683,9 @@ export interface UpdateThemeAliasResponse { } export namespace UpdateThemeAliasResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateThemeAliasResponse): any => ({ ...obj, }); @@ -2495,6 +2714,9 @@ export interface UpdateThemePermissionsRequest { } export namespace UpdateThemePermissionsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateThemePermissionsRequest): any => ({ ...obj, }); @@ -2528,6 +2750,9 @@ export interface UpdateThemePermissionsResponse { } export namespace UpdateThemePermissionsResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateThemePermissionsResponse): any => ({ ...obj, }); @@ -2619,6 +2844,9 @@ export interface UpdateUserRequest { } export namespace UpdateUserRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateUserRequest): any => ({ ...obj, }); @@ -2642,6 +2870,9 @@ export interface UpdateUserResponse { } export namespace UpdateUserResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateUserResponse): any => ({ ...obj, }); diff --git a/clients/client-ram/commands/AcceptResourceShareInvitationCommand.ts b/clients/client-ram/commands/AcceptResourceShareInvitationCommand.ts index 8ca0c5b617a9..50056df697f2 100644 --- a/clients/client-ram/commands/AcceptResourceShareInvitationCommand.ts +++ b/clients/client-ram/commands/AcceptResourceShareInvitationCommand.ts @@ -24,6 +24,20 @@ export interface AcceptResourceShareInvitationCommandOutput /** *

Accepts an invitation to a resource share from another AWS account.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { RAMClient, AcceptResourceShareInvitationCommand } from "@aws-sdk/client-ram"; // ES Modules import + * // const { RAMClient, AcceptResourceShareInvitationCommand } = require("@aws-sdk/client-ram"); // CommonJS import + * const client = new RAMClient(config); + * const command = new AcceptResourceShareInvitationCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link AcceptResourceShareInvitationCommandInput} for command's `input` shape. + * @see {@link AcceptResourceShareInvitationCommandOutput} for command's `response` shape. + * @see {@link RAMClientResolvedConfig | config} for command's `input` shape. + * */ export class AcceptResourceShareInvitationCommand extends $Command< AcceptResourceShareInvitationCommandInput, diff --git a/clients/client-ram/commands/AssociateResourceShareCommand.ts b/clients/client-ram/commands/AssociateResourceShareCommand.ts index 06deb45c9114..88a42bb17beb 100644 --- a/clients/client-ram/commands/AssociateResourceShareCommand.ts +++ b/clients/client-ram/commands/AssociateResourceShareCommand.ts @@ -22,6 +22,20 @@ export interface AssociateResourceShareCommandOutput extends AssociateResourceSh /** *

Associates the specified resource share with the specified principals and resources.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { RAMClient, AssociateResourceShareCommand } from "@aws-sdk/client-ram"; // ES Modules import + * // const { RAMClient, AssociateResourceShareCommand } = require("@aws-sdk/client-ram"); // CommonJS import + * const client = new RAMClient(config); + * const command = new AssociateResourceShareCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link AssociateResourceShareCommandInput} for command's `input` shape. + * @see {@link AssociateResourceShareCommandOutput} for command's `response` shape. + * @see {@link RAMClientResolvedConfig | config} for command's `input` shape. + * */ export class AssociateResourceShareCommand extends $Command< AssociateResourceShareCommandInput, diff --git a/clients/client-ram/commands/AssociateResourceSharePermissionCommand.ts b/clients/client-ram/commands/AssociateResourceSharePermissionCommand.ts index 82d7264add04..9450384d7c53 100644 --- a/clients/client-ram/commands/AssociateResourceSharePermissionCommand.ts +++ b/clients/client-ram/commands/AssociateResourceSharePermissionCommand.ts @@ -24,6 +24,20 @@ export interface AssociateResourceSharePermissionCommandOutput /** *

Associates a permission with a resource share.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { RAMClient, AssociateResourceSharePermissionCommand } from "@aws-sdk/client-ram"; // ES Modules import + * // const { RAMClient, AssociateResourceSharePermissionCommand } = require("@aws-sdk/client-ram"); // CommonJS import + * const client = new RAMClient(config); + * const command = new AssociateResourceSharePermissionCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link AssociateResourceSharePermissionCommandInput} for command's `input` shape. + * @see {@link AssociateResourceSharePermissionCommandOutput} for command's `response` shape. + * @see {@link RAMClientResolvedConfig | config} for command's `input` shape. + * */ export class AssociateResourceSharePermissionCommand extends $Command< AssociateResourceSharePermissionCommandInput, diff --git a/clients/client-ram/commands/CreateResourceShareCommand.ts b/clients/client-ram/commands/CreateResourceShareCommand.ts index 16baa0a8dc8b..d9b356d09702 100644 --- a/clients/client-ram/commands/CreateResourceShareCommand.ts +++ b/clients/client-ram/commands/CreateResourceShareCommand.ts @@ -22,6 +22,20 @@ export interface CreateResourceShareCommandOutput extends CreateResourceShareRes /** *

Creates a resource share.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { RAMClient, CreateResourceShareCommand } from "@aws-sdk/client-ram"; // ES Modules import + * // const { RAMClient, CreateResourceShareCommand } = require("@aws-sdk/client-ram"); // CommonJS import + * const client = new RAMClient(config); + * const command = new CreateResourceShareCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreateResourceShareCommandInput} for command's `input` shape. + * @see {@link CreateResourceShareCommandOutput} for command's `response` shape. + * @see {@link RAMClientResolvedConfig | config} for command's `input` shape. + * */ export class CreateResourceShareCommand extends $Command< CreateResourceShareCommandInput, diff --git a/clients/client-ram/commands/DeleteResourceShareCommand.ts b/clients/client-ram/commands/DeleteResourceShareCommand.ts index 3018c9f04094..77d1693fab27 100644 --- a/clients/client-ram/commands/DeleteResourceShareCommand.ts +++ b/clients/client-ram/commands/DeleteResourceShareCommand.ts @@ -22,6 +22,20 @@ export interface DeleteResourceShareCommandOutput extends DeleteResourceShareRes /** *

Deletes the specified resource share.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { RAMClient, DeleteResourceShareCommand } from "@aws-sdk/client-ram"; // ES Modules import + * // const { RAMClient, DeleteResourceShareCommand } = require("@aws-sdk/client-ram"); // CommonJS import + * const client = new RAMClient(config); + * const command = new DeleteResourceShareCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteResourceShareCommandInput} for command's `input` shape. + * @see {@link DeleteResourceShareCommandOutput} for command's `response` shape. + * @see {@link RAMClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteResourceShareCommand extends $Command< DeleteResourceShareCommandInput, diff --git a/clients/client-ram/commands/DisassociateResourceShareCommand.ts b/clients/client-ram/commands/DisassociateResourceShareCommand.ts index 018f3d53f19d..2355d8884fba 100644 --- a/clients/client-ram/commands/DisassociateResourceShareCommand.ts +++ b/clients/client-ram/commands/DisassociateResourceShareCommand.ts @@ -22,6 +22,20 @@ export interface DisassociateResourceShareCommandOutput extends DisassociateReso /** *

Disassociates the specified principals or resources from the specified resource share.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { RAMClient, DisassociateResourceShareCommand } from "@aws-sdk/client-ram"; // ES Modules import + * // const { RAMClient, DisassociateResourceShareCommand } = require("@aws-sdk/client-ram"); // CommonJS import + * const client = new RAMClient(config); + * const command = new DisassociateResourceShareCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DisassociateResourceShareCommandInput} for command's `input` shape. + * @see {@link DisassociateResourceShareCommandOutput} for command's `response` shape. + * @see {@link RAMClientResolvedConfig | config} for command's `input` shape. + * */ export class DisassociateResourceShareCommand extends $Command< DisassociateResourceShareCommandInput, diff --git a/clients/client-ram/commands/DisassociateResourceSharePermissionCommand.ts b/clients/client-ram/commands/DisassociateResourceSharePermissionCommand.ts index c75aec5e432b..4e1a1b1cc16c 100644 --- a/clients/client-ram/commands/DisassociateResourceSharePermissionCommand.ts +++ b/clients/client-ram/commands/DisassociateResourceSharePermissionCommand.ts @@ -27,6 +27,20 @@ export interface DisassociateResourceSharePermissionCommandOutput /** *

Disassociates an AWS RAM permission from a resource share.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { RAMClient, DisassociateResourceSharePermissionCommand } from "@aws-sdk/client-ram"; // ES Modules import + * // const { RAMClient, DisassociateResourceSharePermissionCommand } = require("@aws-sdk/client-ram"); // CommonJS import + * const client = new RAMClient(config); + * const command = new DisassociateResourceSharePermissionCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DisassociateResourceSharePermissionCommandInput} for command's `input` shape. + * @see {@link DisassociateResourceSharePermissionCommandOutput} for command's `response` shape. + * @see {@link RAMClientResolvedConfig | config} for command's `input` shape. + * */ export class DisassociateResourceSharePermissionCommand extends $Command< DisassociateResourceSharePermissionCommandInput, diff --git a/clients/client-ram/commands/EnableSharingWithAwsOrganizationCommand.ts b/clients/client-ram/commands/EnableSharingWithAwsOrganizationCommand.ts index 143e5e6e6729..a51f2ab14d73 100644 --- a/clients/client-ram/commands/EnableSharingWithAwsOrganizationCommand.ts +++ b/clients/client-ram/commands/EnableSharingWithAwsOrganizationCommand.ts @@ -25,6 +25,20 @@ export interface EnableSharingWithAwsOrganizationCommandOutput /** *

Enables resource sharing within your AWS Organization.

*

The caller must be the master account for the AWS Organization.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { RAMClient, EnableSharingWithAwsOrganizationCommand } from "@aws-sdk/client-ram"; // ES Modules import + * // const { RAMClient, EnableSharingWithAwsOrganizationCommand } = require("@aws-sdk/client-ram"); // CommonJS import + * const client = new RAMClient(config); + * const command = new EnableSharingWithAwsOrganizationCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link EnableSharingWithAwsOrganizationCommandInput} for command's `input` shape. + * @see {@link EnableSharingWithAwsOrganizationCommandOutput} for command's `response` shape. + * @see {@link RAMClientResolvedConfig | config} for command's `input` shape. + * */ export class EnableSharingWithAwsOrganizationCommand extends $Command< EnableSharingWithAwsOrganizationCommandInput, diff --git a/clients/client-ram/commands/GetPermissionCommand.ts b/clients/client-ram/commands/GetPermissionCommand.ts index 32abafcd62b1..6b1d9b31aab3 100644 --- a/clients/client-ram/commands/GetPermissionCommand.ts +++ b/clients/client-ram/commands/GetPermissionCommand.ts @@ -22,6 +22,20 @@ export interface GetPermissionCommandOutput extends GetPermissionResponse, __Met /** *

Gets the contents of an AWS RAM permission in JSON format.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { RAMClient, GetPermissionCommand } from "@aws-sdk/client-ram"; // ES Modules import + * // const { RAMClient, GetPermissionCommand } = require("@aws-sdk/client-ram"); // CommonJS import + * const client = new RAMClient(config); + * const command = new GetPermissionCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetPermissionCommandInput} for command's `input` shape. + * @see {@link GetPermissionCommandOutput} for command's `response` shape. + * @see {@link RAMClientResolvedConfig | config} for command's `input` shape. + * */ export class GetPermissionCommand extends $Command< GetPermissionCommandInput, diff --git a/clients/client-ram/commands/GetResourcePoliciesCommand.ts b/clients/client-ram/commands/GetResourcePoliciesCommand.ts index e138aba1b445..573ed0596551 100644 --- a/clients/client-ram/commands/GetResourcePoliciesCommand.ts +++ b/clients/client-ram/commands/GetResourcePoliciesCommand.ts @@ -22,6 +22,20 @@ export interface GetResourcePoliciesCommandOutput extends GetResourcePoliciesRes /** *

Gets the policies for the specified resources that you own and have shared.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { RAMClient, GetResourcePoliciesCommand } from "@aws-sdk/client-ram"; // ES Modules import + * // const { RAMClient, GetResourcePoliciesCommand } = require("@aws-sdk/client-ram"); // CommonJS import + * const client = new RAMClient(config); + * const command = new GetResourcePoliciesCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetResourcePoliciesCommandInput} for command's `input` shape. + * @see {@link GetResourcePoliciesCommandOutput} for command's `response` shape. + * @see {@link RAMClientResolvedConfig | config} for command's `input` shape. + * */ export class GetResourcePoliciesCommand extends $Command< GetResourcePoliciesCommandInput, diff --git a/clients/client-ram/commands/GetResourceShareAssociationsCommand.ts b/clients/client-ram/commands/GetResourceShareAssociationsCommand.ts index 51e585096070..63d73867cc51 100644 --- a/clients/client-ram/commands/GetResourceShareAssociationsCommand.ts +++ b/clients/client-ram/commands/GetResourceShareAssociationsCommand.ts @@ -24,6 +24,20 @@ export interface GetResourceShareAssociationsCommandOutput /** *

Gets the resources or principals for the resource shares that you own.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { RAMClient, GetResourceShareAssociationsCommand } from "@aws-sdk/client-ram"; // ES Modules import + * // const { RAMClient, GetResourceShareAssociationsCommand } = require("@aws-sdk/client-ram"); // CommonJS import + * const client = new RAMClient(config); + * const command = new GetResourceShareAssociationsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetResourceShareAssociationsCommandInput} for command's `input` shape. + * @see {@link GetResourceShareAssociationsCommandOutput} for command's `response` shape. + * @see {@link RAMClientResolvedConfig | config} for command's `input` shape. + * */ export class GetResourceShareAssociationsCommand extends $Command< GetResourceShareAssociationsCommandInput, diff --git a/clients/client-ram/commands/GetResourceShareInvitationsCommand.ts b/clients/client-ram/commands/GetResourceShareInvitationsCommand.ts index b3df179d85e8..065a900360d1 100644 --- a/clients/client-ram/commands/GetResourceShareInvitationsCommand.ts +++ b/clients/client-ram/commands/GetResourceShareInvitationsCommand.ts @@ -24,6 +24,20 @@ export interface GetResourceShareInvitationsCommandOutput /** *

Gets the invitations for resource sharing that you've received.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { RAMClient, GetResourceShareInvitationsCommand } from "@aws-sdk/client-ram"; // ES Modules import + * // const { RAMClient, GetResourceShareInvitationsCommand } = require("@aws-sdk/client-ram"); // CommonJS import + * const client = new RAMClient(config); + * const command = new GetResourceShareInvitationsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetResourceShareInvitationsCommandInput} for command's `input` shape. + * @see {@link GetResourceShareInvitationsCommandOutput} for command's `response` shape. + * @see {@link RAMClientResolvedConfig | config} for command's `input` shape. + * */ export class GetResourceShareInvitationsCommand extends $Command< GetResourceShareInvitationsCommandInput, diff --git a/clients/client-ram/commands/GetResourceSharesCommand.ts b/clients/client-ram/commands/GetResourceSharesCommand.ts index c2b8ec97c5e9..2c1938462940 100644 --- a/clients/client-ram/commands/GetResourceSharesCommand.ts +++ b/clients/client-ram/commands/GetResourceSharesCommand.ts @@ -22,6 +22,20 @@ export interface GetResourceSharesCommandOutput extends GetResourceSharesRespons /** *

Gets the resource shares that you own or the resource shares that are shared with you.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { RAMClient, GetResourceSharesCommand } from "@aws-sdk/client-ram"; // ES Modules import + * // const { RAMClient, GetResourceSharesCommand } = require("@aws-sdk/client-ram"); // CommonJS import + * const client = new RAMClient(config); + * const command = new GetResourceSharesCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetResourceSharesCommandInput} for command's `input` shape. + * @see {@link GetResourceSharesCommandOutput} for command's `response` shape. + * @see {@link RAMClientResolvedConfig | config} for command's `input` shape. + * */ export class GetResourceSharesCommand extends $Command< GetResourceSharesCommandInput, diff --git a/clients/client-ram/commands/ListPendingInvitationResourcesCommand.ts b/clients/client-ram/commands/ListPendingInvitationResourcesCommand.ts index aa3f1349a9f2..38cf6e30a7c3 100644 --- a/clients/client-ram/commands/ListPendingInvitationResourcesCommand.ts +++ b/clients/client-ram/commands/ListPendingInvitationResourcesCommand.ts @@ -24,6 +24,20 @@ export interface ListPendingInvitationResourcesCommandOutput /** *

Lists the resources in a resource share that is shared with you but that the invitation is still pending for.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { RAMClient, ListPendingInvitationResourcesCommand } from "@aws-sdk/client-ram"; // ES Modules import + * // const { RAMClient, ListPendingInvitationResourcesCommand } = require("@aws-sdk/client-ram"); // CommonJS import + * const client = new RAMClient(config); + * const command = new ListPendingInvitationResourcesCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListPendingInvitationResourcesCommandInput} for command's `input` shape. + * @see {@link ListPendingInvitationResourcesCommandOutput} for command's `response` shape. + * @see {@link RAMClientResolvedConfig | config} for command's `input` shape. + * */ export class ListPendingInvitationResourcesCommand extends $Command< ListPendingInvitationResourcesCommandInput, diff --git a/clients/client-ram/commands/ListPermissionsCommand.ts b/clients/client-ram/commands/ListPermissionsCommand.ts index f751aec032af..678cafba36ec 100644 --- a/clients/client-ram/commands/ListPermissionsCommand.ts +++ b/clients/client-ram/commands/ListPermissionsCommand.ts @@ -22,6 +22,20 @@ export interface ListPermissionsCommandOutput extends ListPermissionsResponse, _ /** *

Lists the AWS RAM permissions.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { RAMClient, ListPermissionsCommand } from "@aws-sdk/client-ram"; // ES Modules import + * // const { RAMClient, ListPermissionsCommand } = require("@aws-sdk/client-ram"); // CommonJS import + * const client = new RAMClient(config); + * const command = new ListPermissionsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListPermissionsCommandInput} for command's `input` shape. + * @see {@link ListPermissionsCommandOutput} for command's `response` shape. + * @see {@link RAMClientResolvedConfig | config} for command's `input` shape. + * */ export class ListPermissionsCommand extends $Command< ListPermissionsCommandInput, diff --git a/clients/client-ram/commands/ListPrincipalsCommand.ts b/clients/client-ram/commands/ListPrincipalsCommand.ts index aaf22587419f..6694e62d2ab8 100644 --- a/clients/client-ram/commands/ListPrincipalsCommand.ts +++ b/clients/client-ram/commands/ListPrincipalsCommand.ts @@ -23,6 +23,20 @@ export interface ListPrincipalsCommandOutput extends ListPrincipalsResponse, __M /** *

Lists the principals that you have shared resources with or that have shared resources * with you.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { RAMClient, ListPrincipalsCommand } from "@aws-sdk/client-ram"; // ES Modules import + * // const { RAMClient, ListPrincipalsCommand } = require("@aws-sdk/client-ram"); // CommonJS import + * const client = new RAMClient(config); + * const command = new ListPrincipalsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListPrincipalsCommandInput} for command's `input` shape. + * @see {@link ListPrincipalsCommandOutput} for command's `response` shape. + * @see {@link RAMClientResolvedConfig | config} for command's `input` shape. + * */ export class ListPrincipalsCommand extends $Command< ListPrincipalsCommandInput, diff --git a/clients/client-ram/commands/ListResourceSharePermissionsCommand.ts b/clients/client-ram/commands/ListResourceSharePermissionsCommand.ts index 9eb18f8df9e7..6d59110fd3c6 100644 --- a/clients/client-ram/commands/ListResourceSharePermissionsCommand.ts +++ b/clients/client-ram/commands/ListResourceSharePermissionsCommand.ts @@ -24,6 +24,20 @@ export interface ListResourceSharePermissionsCommandOutput /** *

Lists the AWS RAM permissions that are associated with a resource share.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { RAMClient, ListResourceSharePermissionsCommand } from "@aws-sdk/client-ram"; // ES Modules import + * // const { RAMClient, ListResourceSharePermissionsCommand } = require("@aws-sdk/client-ram"); // CommonJS import + * const client = new RAMClient(config); + * const command = new ListResourceSharePermissionsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListResourceSharePermissionsCommandInput} for command's `input` shape. + * @see {@link ListResourceSharePermissionsCommandOutput} for command's `response` shape. + * @see {@link RAMClientResolvedConfig | config} for command's `input` shape. + * */ export class ListResourceSharePermissionsCommand extends $Command< ListResourceSharePermissionsCommandInput, diff --git a/clients/client-ram/commands/ListResourceTypesCommand.ts b/clients/client-ram/commands/ListResourceTypesCommand.ts index b957b9ed1f53..4992a2278e48 100644 --- a/clients/client-ram/commands/ListResourceTypesCommand.ts +++ b/clients/client-ram/commands/ListResourceTypesCommand.ts @@ -22,6 +22,20 @@ export interface ListResourceTypesCommandOutput extends ListResourceTypesRespons /** *

Lists the shareable resource types supported by AWS RAM.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { RAMClient, ListResourceTypesCommand } from "@aws-sdk/client-ram"; // ES Modules import + * // const { RAMClient, ListResourceTypesCommand } = require("@aws-sdk/client-ram"); // CommonJS import + * const client = new RAMClient(config); + * const command = new ListResourceTypesCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListResourceTypesCommandInput} for command's `input` shape. + * @see {@link ListResourceTypesCommandOutput} for command's `response` shape. + * @see {@link RAMClientResolvedConfig | config} for command's `input` shape. + * */ export class ListResourceTypesCommand extends $Command< ListResourceTypesCommandInput, diff --git a/clients/client-ram/commands/ListResourcesCommand.ts b/clients/client-ram/commands/ListResourcesCommand.ts index e369cc0b88e2..e2c9412963c1 100644 --- a/clients/client-ram/commands/ListResourcesCommand.ts +++ b/clients/client-ram/commands/ListResourcesCommand.ts @@ -22,6 +22,20 @@ export interface ListResourcesCommandOutput extends ListResourcesResponse, __Met /** *

Lists the resources that you added to a resource shares or the resources that are shared with you.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { RAMClient, ListResourcesCommand } from "@aws-sdk/client-ram"; // ES Modules import + * // const { RAMClient, ListResourcesCommand } = require("@aws-sdk/client-ram"); // CommonJS import + * const client = new RAMClient(config); + * const command = new ListResourcesCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListResourcesCommandInput} for command's `input` shape. + * @see {@link ListResourcesCommandOutput} for command's `response` shape. + * @see {@link RAMClientResolvedConfig | config} for command's `input` shape. + * */ export class ListResourcesCommand extends $Command< ListResourcesCommandInput, diff --git a/clients/client-ram/commands/PromoteResourceShareCreatedFromPolicyCommand.ts b/clients/client-ram/commands/PromoteResourceShareCreatedFromPolicyCommand.ts index 8eb10ff9e47a..c897590d9fab 100644 --- a/clients/client-ram/commands/PromoteResourceShareCreatedFromPolicyCommand.ts +++ b/clients/client-ram/commands/PromoteResourceShareCreatedFromPolicyCommand.ts @@ -40,6 +40,20 @@ export interface PromoteResourceShareCreatedFromPolicyCommandOutput *

Modifiable in AWS RAM.

* * + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { RAMClient, PromoteResourceShareCreatedFromPolicyCommand } from "@aws-sdk/client-ram"; // ES Modules import + * // const { RAMClient, PromoteResourceShareCreatedFromPolicyCommand } = require("@aws-sdk/client-ram"); // CommonJS import + * const client = new RAMClient(config); + * const command = new PromoteResourceShareCreatedFromPolicyCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link PromoteResourceShareCreatedFromPolicyCommandInput} for command's `input` shape. + * @see {@link PromoteResourceShareCreatedFromPolicyCommandOutput} for command's `response` shape. + * @see {@link RAMClientResolvedConfig | config} for command's `input` shape. + * */ export class PromoteResourceShareCreatedFromPolicyCommand extends $Command< PromoteResourceShareCreatedFromPolicyCommandInput, diff --git a/clients/client-ram/commands/RejectResourceShareInvitationCommand.ts b/clients/client-ram/commands/RejectResourceShareInvitationCommand.ts index 1a52a69f5ec8..f98a13257def 100644 --- a/clients/client-ram/commands/RejectResourceShareInvitationCommand.ts +++ b/clients/client-ram/commands/RejectResourceShareInvitationCommand.ts @@ -24,6 +24,20 @@ export interface RejectResourceShareInvitationCommandOutput /** *

Rejects an invitation to a resource share from another AWS account.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { RAMClient, RejectResourceShareInvitationCommand } from "@aws-sdk/client-ram"; // ES Modules import + * // const { RAMClient, RejectResourceShareInvitationCommand } = require("@aws-sdk/client-ram"); // CommonJS import + * const client = new RAMClient(config); + * const command = new RejectResourceShareInvitationCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link RejectResourceShareInvitationCommandInput} for command's `input` shape. + * @see {@link RejectResourceShareInvitationCommandOutput} for command's `response` shape. + * @see {@link RAMClientResolvedConfig | config} for command's `input` shape. + * */ export class RejectResourceShareInvitationCommand extends $Command< RejectResourceShareInvitationCommandInput, diff --git a/clients/client-ram/commands/TagResourceCommand.ts b/clients/client-ram/commands/TagResourceCommand.ts index 2ad5eaba6003..a446ab1120c7 100644 --- a/clients/client-ram/commands/TagResourceCommand.ts +++ b/clients/client-ram/commands/TagResourceCommand.ts @@ -22,6 +22,20 @@ export interface TagResourceCommandOutput extends TagResourceResponse, __Metadat /** *

Adds the specified tags to the specified resource share that you own.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { RAMClient, TagResourceCommand } from "@aws-sdk/client-ram"; // ES Modules import + * // const { RAMClient, TagResourceCommand } = require("@aws-sdk/client-ram"); // CommonJS import + * const client = new RAMClient(config); + * const command = new TagResourceCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link TagResourceCommandInput} for command's `input` shape. + * @see {@link TagResourceCommandOutput} for command's `response` shape. + * @see {@link RAMClientResolvedConfig | config} for command's `input` shape. + * */ export class TagResourceCommand extends $Command< TagResourceCommandInput, diff --git a/clients/client-ram/commands/UntagResourceCommand.ts b/clients/client-ram/commands/UntagResourceCommand.ts index 28d803e78bff..a95b53ca521f 100644 --- a/clients/client-ram/commands/UntagResourceCommand.ts +++ b/clients/client-ram/commands/UntagResourceCommand.ts @@ -22,6 +22,20 @@ export interface UntagResourceCommandOutput extends UntagResourceResponse, __Met /** *

Removes the specified tags from the specified resource share that you own.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { RAMClient, UntagResourceCommand } from "@aws-sdk/client-ram"; // ES Modules import + * // const { RAMClient, UntagResourceCommand } = require("@aws-sdk/client-ram"); // CommonJS import + * const client = new RAMClient(config); + * const command = new UntagResourceCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link UntagResourceCommandInput} for command's `input` shape. + * @see {@link UntagResourceCommandOutput} for command's `response` shape. + * @see {@link RAMClientResolvedConfig | config} for command's `input` shape. + * */ export class UntagResourceCommand extends $Command< UntagResourceCommandInput, diff --git a/clients/client-ram/commands/UpdateResourceShareCommand.ts b/clients/client-ram/commands/UpdateResourceShareCommand.ts index c22e2fb0789b..3050f0ed9c85 100644 --- a/clients/client-ram/commands/UpdateResourceShareCommand.ts +++ b/clients/client-ram/commands/UpdateResourceShareCommand.ts @@ -22,6 +22,20 @@ export interface UpdateResourceShareCommandOutput extends UpdateResourceShareRes /** *

Updates the specified resource share that you own.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { RAMClient, UpdateResourceShareCommand } from "@aws-sdk/client-ram"; // ES Modules import + * // const { RAMClient, UpdateResourceShareCommand } = require("@aws-sdk/client-ram"); // CommonJS import + * const client = new RAMClient(config); + * const command = new UpdateResourceShareCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link UpdateResourceShareCommandInput} for command's `input` shape. + * @see {@link UpdateResourceShareCommandOutput} for command's `response` shape. + * @see {@link RAMClientResolvedConfig | config} for command's `input` shape. + * */ export class UpdateResourceShareCommand extends $Command< UpdateResourceShareCommandInput, diff --git a/clients/client-ram/models/models_0.ts b/clients/client-ram/models/models_0.ts index 816406ffda54..b2990118e82d 100644 --- a/clients/client-ram/models/models_0.ts +++ b/clients/client-ram/models/models_0.ts @@ -14,6 +14,9 @@ export interface AcceptResourceShareInvitationRequest { } export namespace AcceptResourceShareInvitationRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: AcceptResourceShareInvitationRequest): any => ({ ...obj, }); @@ -81,6 +84,9 @@ export interface ResourceShareAssociation { } export namespace ResourceShareAssociation { + /** + * @internal + */ export const filterSensitiveLog = (obj: ResourceShareAssociation): any => ({ ...obj, }); @@ -138,6 +144,9 @@ export interface ResourceShareInvitation { } export namespace ResourceShareInvitation { + /** + * @internal + */ export const filterSensitiveLog = (obj: ResourceShareInvitation): any => ({ ...obj, }); @@ -156,6 +165,9 @@ export interface AcceptResourceShareInvitationResponse { } export namespace AcceptResourceShareInvitationResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: AcceptResourceShareInvitationResponse): any => ({ ...obj, }); @@ -172,6 +184,9 @@ export interface IdempotentParameterMismatchException extends __SmithyException, } export namespace IdempotentParameterMismatchException { + /** + * @internal + */ export const filterSensitiveLog = (obj: IdempotentParameterMismatchException): any => ({ ...obj, }); @@ -187,6 +202,9 @@ export interface InvalidClientTokenException extends __SmithyException, $Metadat } export namespace InvalidClientTokenException { + /** + * @internal + */ export const filterSensitiveLog = (obj: InvalidClientTokenException): any => ({ ...obj, }); @@ -202,6 +220,9 @@ export interface MalformedArnException extends __SmithyException, $MetadataBeare } export namespace MalformedArnException { + /** + * @internal + */ export const filterSensitiveLog = (obj: MalformedArnException): any => ({ ...obj, }); @@ -217,6 +238,9 @@ export interface OperationNotPermittedException extends __SmithyException, $Meta } export namespace OperationNotPermittedException { + /** + * @internal + */ export const filterSensitiveLog = (obj: OperationNotPermittedException): any => ({ ...obj, }); @@ -232,6 +256,9 @@ export interface ResourceShareInvitationAlreadyAcceptedException extends __Smith } export namespace ResourceShareInvitationAlreadyAcceptedException { + /** + * @internal + */ export const filterSensitiveLog = (obj: ResourceShareInvitationAlreadyAcceptedException): any => ({ ...obj, }); @@ -247,6 +274,9 @@ export interface ResourceShareInvitationAlreadyRejectedException extends __Smith } export namespace ResourceShareInvitationAlreadyRejectedException { + /** + * @internal + */ export const filterSensitiveLog = (obj: ResourceShareInvitationAlreadyRejectedException): any => ({ ...obj, }); @@ -262,6 +292,9 @@ export interface ResourceShareInvitationArnNotFoundException extends __SmithyExc } export namespace ResourceShareInvitationArnNotFoundException { + /** + * @internal + */ export const filterSensitiveLog = (obj: ResourceShareInvitationArnNotFoundException): any => ({ ...obj, }); @@ -277,6 +310,9 @@ export interface ResourceShareInvitationExpiredException extends __SmithyExcepti } export namespace ResourceShareInvitationExpiredException { + /** + * @internal + */ export const filterSensitiveLog = (obj: ResourceShareInvitationExpiredException): any => ({ ...obj, }); @@ -292,6 +328,9 @@ export interface ServerInternalException extends __SmithyException, $MetadataBea } export namespace ServerInternalException { + /** + * @internal + */ export const filterSensitiveLog = (obj: ServerInternalException): any => ({ ...obj, }); @@ -307,6 +346,9 @@ export interface ServiceUnavailableException extends __SmithyException, $Metadat } export namespace ServiceUnavailableException { + /** + * @internal + */ export const filterSensitiveLog = (obj: ServiceUnavailableException): any => ({ ...obj, }); @@ -337,6 +379,9 @@ export interface AssociateResourceShareRequest { } export namespace AssociateResourceShareRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: AssociateResourceShareRequest): any => ({ ...obj, }); @@ -355,6 +400,9 @@ export interface AssociateResourceShareResponse { } export namespace AssociateResourceShareResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: AssociateResourceShareResponse): any => ({ ...obj, }); @@ -370,6 +418,9 @@ export interface InvalidParameterException extends __SmithyException, $MetadataB } export namespace InvalidParameterException { + /** + * @internal + */ export const filterSensitiveLog = (obj: InvalidParameterException): any => ({ ...obj, }); @@ -385,6 +436,9 @@ export interface InvalidStateTransitionException extends __SmithyException, $Met } export namespace InvalidStateTransitionException { + /** + * @internal + */ export const filterSensitiveLog = (obj: InvalidStateTransitionException): any => ({ ...obj, }); @@ -400,6 +454,9 @@ export interface ResourceShareLimitExceededException extends __SmithyException, } export namespace ResourceShareLimitExceededException { + /** + * @internal + */ export const filterSensitiveLog = (obj: ResourceShareLimitExceededException): any => ({ ...obj, }); @@ -415,6 +472,9 @@ export interface UnknownResourceException extends __SmithyException, $MetadataBe } export namespace UnknownResourceException { + /** + * @internal + */ export const filterSensitiveLog = (obj: UnknownResourceException): any => ({ ...obj, }); @@ -445,6 +505,9 @@ export interface AssociateResourceSharePermissionRequest { } export namespace AssociateResourceSharePermissionRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: AssociateResourceSharePermissionRequest): any => ({ ...obj, }); @@ -463,6 +526,9 @@ export interface AssociateResourceSharePermissionResponse { } export namespace AssociateResourceSharePermissionResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: AssociateResourceSharePermissionResponse): any => ({ ...obj, }); @@ -484,6 +550,9 @@ export interface Tag { } export namespace Tag { + /** + * @internal + */ export const filterSensitiveLog = (obj: Tag): any => ({ ...obj, }); @@ -530,6 +599,9 @@ export interface CreateResourceShareRequest { } export namespace CreateResourceShareRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateResourceShareRequest): any => ({ ...obj, }); @@ -616,6 +688,9 @@ export interface ResourceShare { } export namespace ResourceShare { + /** + * @internal + */ export const filterSensitiveLog = (obj: ResourceShare): any => ({ ...obj, }); @@ -634,6 +709,9 @@ export interface CreateResourceShareResponse { } export namespace CreateResourceShareResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateResourceShareResponse): any => ({ ...obj, }); @@ -649,6 +727,9 @@ export interface TagPolicyViolationException extends __SmithyException, $Metadat } export namespace TagPolicyViolationException { + /** + * @internal + */ export const filterSensitiveLog = (obj: TagPolicyViolationException): any => ({ ...obj, }); @@ -667,6 +748,9 @@ export interface DeleteResourceShareRequest { } export namespace DeleteResourceShareRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteResourceShareRequest): any => ({ ...obj, }); @@ -685,6 +769,9 @@ export interface DeleteResourceShareResponse { } export namespace DeleteResourceShareResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteResourceShareResponse): any => ({ ...obj, }); @@ -713,6 +800,9 @@ export interface DisassociateResourceShareRequest { } export namespace DisassociateResourceShareRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DisassociateResourceShareRequest): any => ({ ...obj, }); @@ -731,6 +821,9 @@ export interface DisassociateResourceShareResponse { } export namespace DisassociateResourceShareResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DisassociateResourceShareResponse): any => ({ ...obj, }); @@ -754,6 +847,9 @@ export interface DisassociateResourceSharePermissionRequest { } export namespace DisassociateResourceSharePermissionRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DisassociateResourceSharePermissionRequest): any => ({ ...obj, }); @@ -772,6 +868,9 @@ export interface DisassociateResourceSharePermissionResponse { } export namespace DisassociateResourceSharePermissionResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DisassociateResourceSharePermissionResponse): any => ({ ...obj, }); @@ -780,6 +879,9 @@ export namespace DisassociateResourceSharePermissionResponse { export interface EnableSharingWithAwsOrganizationRequest {} export namespace EnableSharingWithAwsOrganizationRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: EnableSharingWithAwsOrganizationRequest): any => ({ ...obj, }); @@ -793,6 +895,9 @@ export interface EnableSharingWithAwsOrganizationResponse { } export namespace EnableSharingWithAwsOrganizationResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: EnableSharingWithAwsOrganizationResponse): any => ({ ...obj, }); @@ -811,6 +916,9 @@ export interface GetPermissionRequest { } export namespace GetPermissionRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetPermissionRequest): any => ({ ...obj, }); @@ -865,6 +973,9 @@ export interface ResourceSharePermissionDetail { } export namespace ResourceSharePermissionDetail { + /** + * @internal + */ export const filterSensitiveLog = (obj: ResourceSharePermissionDetail): any => ({ ...obj, }); @@ -878,6 +989,9 @@ export interface GetPermissionResponse { } export namespace GetPermissionResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetPermissionResponse): any => ({ ...obj, }); @@ -907,6 +1021,9 @@ export interface GetResourcePoliciesRequest { } export namespace GetResourcePoliciesRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetResourcePoliciesRequest): any => ({ ...obj, }); @@ -925,6 +1042,9 @@ export interface GetResourcePoliciesResponse { } export namespace GetResourcePoliciesResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetResourcePoliciesResponse): any => ({ ...obj, }); @@ -940,6 +1060,9 @@ export interface InvalidNextTokenException extends __SmithyException, $MetadataB } export namespace InvalidNextTokenException { + /** + * @internal + */ export const filterSensitiveLog = (obj: InvalidNextTokenException): any => ({ ...obj, }); @@ -955,6 +1078,9 @@ export interface ResourceArnNotFoundException extends __SmithyException, $Metada } export namespace ResourceArnNotFoundException { + /** + * @internal + */ export const filterSensitiveLog = (obj: ResourceArnNotFoundException): any => ({ ...obj, }); @@ -1003,6 +1129,9 @@ export interface GetResourceShareAssociationsRequest { } export namespace GetResourceShareAssociationsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetResourceShareAssociationsRequest): any => ({ ...obj, }); @@ -1021,6 +1150,9 @@ export interface GetResourceShareAssociationsResponse { } export namespace GetResourceShareAssociationsResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetResourceShareAssociationsResponse): any => ({ ...obj, }); @@ -1050,6 +1182,9 @@ export interface GetResourceShareInvitationsRequest { } export namespace GetResourceShareInvitationsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetResourceShareInvitationsRequest): any => ({ ...obj, }); @@ -1068,6 +1203,9 @@ export interface GetResourceShareInvitationsResponse { } export namespace GetResourceShareInvitationsResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetResourceShareInvitationsResponse): any => ({ ...obj, }); @@ -1083,6 +1221,9 @@ export interface InvalidMaxResultsException extends __SmithyException, $Metadata } export namespace InvalidMaxResultsException { + /** + * @internal + */ export const filterSensitiveLog = (obj: InvalidMaxResultsException): any => ({ ...obj, }); @@ -1109,6 +1250,9 @@ export interface TagFilter { } export namespace TagFilter { + /** + * @internal + */ export const filterSensitiveLog = (obj: TagFilter): any => ({ ...obj, }); @@ -1153,6 +1297,9 @@ export interface GetResourceSharesRequest { } export namespace GetResourceSharesRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetResourceSharesRequest): any => ({ ...obj, }); @@ -1171,6 +1318,9 @@ export interface GetResourceSharesResponse { } export namespace GetResourceSharesResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetResourceSharesResponse): any => ({ ...obj, }); @@ -1195,6 +1345,9 @@ export interface ListPendingInvitationResourcesRequest { } export namespace ListPendingInvitationResourcesRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListPendingInvitationResourcesRequest): any => ({ ...obj, }); @@ -1249,6 +1402,9 @@ export interface Resource { } export namespace Resource { + /** + * @internal + */ export const filterSensitiveLog = (obj: Resource): any => ({ ...obj, }); @@ -1267,6 +1423,9 @@ export interface ListPendingInvitationResourcesResponse { } export namespace ListPendingInvitationResourcesResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListPendingInvitationResourcesResponse): any => ({ ...obj, }); @@ -1282,6 +1441,9 @@ export interface MissingRequiredParameterException extends __SmithyException, $M } export namespace MissingRequiredParameterException { + /** + * @internal + */ export const filterSensitiveLog = (obj: MissingRequiredParameterException): any => ({ ...obj, }); @@ -1307,6 +1469,9 @@ export interface ListPermissionsRequest { } export namespace ListPermissionsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListPermissionsRequest): any => ({ ...obj, }); @@ -1358,6 +1523,9 @@ export interface ResourceSharePermissionSummary { } export namespace ResourceSharePermissionSummary { + /** + * @internal + */ export const filterSensitiveLog = (obj: ResourceSharePermissionSummary): any => ({ ...obj, }); @@ -1376,6 +1544,9 @@ export interface ListPermissionsResponse { } export namespace ListPermissionsResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListPermissionsResponse): any => ({ ...obj, }); @@ -1422,6 +1593,9 @@ export interface ListPrincipalsRequest { } export namespace ListPrincipalsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListPrincipalsRequest): any => ({ ...obj, }); @@ -1458,6 +1632,9 @@ export interface Principal { } export namespace Principal { + /** + * @internal + */ export const filterSensitiveLog = (obj: Principal): any => ({ ...obj, }); @@ -1476,6 +1653,9 @@ export interface ListPrincipalsResponse { } export namespace ListPrincipalsResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListPrincipalsResponse): any => ({ ...obj, }); @@ -1491,6 +1671,9 @@ export interface InvalidResourceTypeException extends __SmithyException, $Metada } export namespace InvalidResourceTypeException { + /** + * @internal + */ export const filterSensitiveLog = (obj: InvalidResourceTypeException): any => ({ ...obj, }); @@ -1537,6 +1720,9 @@ export interface ListResourcesRequest { } export namespace ListResourcesRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListResourcesRequest): any => ({ ...obj, }); @@ -1555,6 +1741,9 @@ export interface ListResourcesResponse { } export namespace ListResourcesResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListResourcesResponse): any => ({ ...obj, }); @@ -1579,6 +1768,9 @@ export interface ListResourceSharePermissionsRequest { } export namespace ListResourceSharePermissionsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListResourceSharePermissionsRequest): any => ({ ...obj, }); @@ -1597,6 +1789,9 @@ export interface ListResourceSharePermissionsResponse { } export namespace ListResourceSharePermissionsResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListResourceSharePermissionsResponse): any => ({ ...obj, }); @@ -1616,6 +1811,9 @@ export interface ListResourceTypesRequest { } export namespace ListResourceTypesRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListResourceTypesRequest): any => ({ ...obj, }); @@ -1637,6 +1835,9 @@ export interface ServiceNameAndResourceType { } export namespace ServiceNameAndResourceType { + /** + * @internal + */ export const filterSensitiveLog = (obj: ServiceNameAndResourceType): any => ({ ...obj, }); @@ -1655,6 +1856,9 @@ export interface ListResourceTypesResponse { } export namespace ListResourceTypesResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListResourceTypesResponse): any => ({ ...obj, }); @@ -1668,6 +1872,9 @@ export interface PromoteResourceShareCreatedFromPolicyRequest { } export namespace PromoteResourceShareCreatedFromPolicyRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: PromoteResourceShareCreatedFromPolicyRequest): any => ({ ...obj, }); @@ -1681,6 +1888,9 @@ export interface PromoteResourceShareCreatedFromPolicyResponse { } export namespace PromoteResourceShareCreatedFromPolicyResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: PromoteResourceShareCreatedFromPolicyResponse): any => ({ ...obj, }); @@ -1699,6 +1909,9 @@ export interface RejectResourceShareInvitationRequest { } export namespace RejectResourceShareInvitationRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: RejectResourceShareInvitationRequest): any => ({ ...obj, }); @@ -1717,6 +1930,9 @@ export interface RejectResourceShareInvitationResponse { } export namespace RejectResourceShareInvitationResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: RejectResourceShareInvitationResponse): any => ({ ...obj, }); @@ -1732,6 +1948,9 @@ export interface TagLimitExceededException extends __SmithyException, $MetadataB } export namespace TagLimitExceededException { + /** + * @internal + */ export const filterSensitiveLog = (obj: TagLimitExceededException): any => ({ ...obj, }); @@ -1750,6 +1969,9 @@ export interface TagResourceRequest { } export namespace TagResourceRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: TagResourceRequest): any => ({ ...obj, }); @@ -1758,6 +1980,9 @@ export namespace TagResourceRequest { export interface TagResourceResponse {} export namespace TagResourceResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: TagResourceResponse): any => ({ ...obj, }); @@ -1776,6 +2001,9 @@ export interface UntagResourceRequest { } export namespace UntagResourceRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: UntagResourceRequest): any => ({ ...obj, }); @@ -1784,6 +2012,9 @@ export namespace UntagResourceRequest { export interface UntagResourceResponse {} export namespace UntagResourceResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: UntagResourceResponse): any => ({ ...obj, }); @@ -1812,6 +2043,9 @@ export interface UpdateResourceShareRequest { } export namespace UpdateResourceShareRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateResourceShareRequest): any => ({ ...obj, }); @@ -1830,6 +2064,9 @@ export interface UpdateResourceShareResponse { } export namespace UpdateResourceShareResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateResourceShareResponse): any => ({ ...obj, }); diff --git a/clients/client-rds-data/commands/BatchExecuteStatementCommand.ts b/clients/client-rds-data/commands/BatchExecuteStatementCommand.ts index 667e86655a15..a44ac863a9a3 100644 --- a/clients/client-rds-data/commands/BatchExecuteStatementCommand.ts +++ b/clients/client-rds-data/commands/BatchExecuteStatementCommand.ts @@ -30,6 +30,20 @@ export interface BatchExecuteStatementCommandOutput extends BatchExecuteStatemen * transactionID parameter, changes that result from the call are * committed automatically.

* + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { RDSDataClient, BatchExecuteStatementCommand } from "@aws-sdk/client-rds-data"; // ES Modules import + * // const { RDSDataClient, BatchExecuteStatementCommand } = require("@aws-sdk/client-rds-data"); // CommonJS import + * const client = new RDSDataClient(config); + * const command = new BatchExecuteStatementCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link BatchExecuteStatementCommandInput} for command's `input` shape. + * @see {@link BatchExecuteStatementCommandOutput} for command's `response` shape. + * @see {@link RDSDataClientResolvedConfig | config} for command's `input` shape. + * */ export class BatchExecuteStatementCommand extends $Command< BatchExecuteStatementCommandInput, diff --git a/clients/client-rds-data/commands/BeginTransactionCommand.ts b/clients/client-rds-data/commands/BeginTransactionCommand.ts index 6e3cd5c72355..89893f1cf748 100644 --- a/clients/client-rds-data/commands/BeginTransactionCommand.ts +++ b/clients/client-rds-data/commands/BeginTransactionCommand.ts @@ -33,6 +33,20 @@ export interface BeginTransactionCommandOutput extends BeginTransactionResponse, * that you run each DDL statement in a separate ExecuteStatement call with * continueAfterTimeout enabled.

* + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { RDSDataClient, BeginTransactionCommand } from "@aws-sdk/client-rds-data"; // ES Modules import + * // const { RDSDataClient, BeginTransactionCommand } = require("@aws-sdk/client-rds-data"); // CommonJS import + * const client = new RDSDataClient(config); + * const command = new BeginTransactionCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link BeginTransactionCommandInput} for command's `input` shape. + * @see {@link BeginTransactionCommandOutput} for command's `response` shape. + * @see {@link RDSDataClientResolvedConfig | config} for command's `input` shape. + * */ export class BeginTransactionCommand extends $Command< BeginTransactionCommandInput, diff --git a/clients/client-rds-data/commands/CommitTransactionCommand.ts b/clients/client-rds-data/commands/CommitTransactionCommand.ts index 88652199da80..359dc1926f3a 100644 --- a/clients/client-rds-data/commands/CommitTransactionCommand.ts +++ b/clients/client-rds-data/commands/CommitTransactionCommand.ts @@ -23,6 +23,20 @@ export interface CommitTransactionCommandOutput extends CommitTransactionRespons /** *

Ends a SQL transaction started with the BeginTransaction operation and * commits the changes.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { RDSDataClient, CommitTransactionCommand } from "@aws-sdk/client-rds-data"; // ES Modules import + * // const { RDSDataClient, CommitTransactionCommand } = require("@aws-sdk/client-rds-data"); // CommonJS import + * const client = new RDSDataClient(config); + * const command = new CommitTransactionCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CommitTransactionCommandInput} for command's `input` shape. + * @see {@link CommitTransactionCommandOutput} for command's `response` shape. + * @see {@link RDSDataClientResolvedConfig | config} for command's `input` shape. + * */ export class CommitTransactionCommand extends $Command< CommitTransactionCommandInput, diff --git a/clients/client-rds-data/commands/ExecuteSqlCommand.ts b/clients/client-rds-data/commands/ExecuteSqlCommand.ts index 30f6cccb03cb..533af38bedaf 100644 --- a/clients/client-rds-data/commands/ExecuteSqlCommand.ts +++ b/clients/client-rds-data/commands/ExecuteSqlCommand.ts @@ -28,6 +28,20 @@ export interface ExecuteSqlCommandOutput extends ExecuteSqlResponse, __MetadataB *

This operation is deprecated. Use the BatchExecuteStatement or * ExecuteStatement operation.

* + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { RDSDataClient, ExecuteSqlCommand } from "@aws-sdk/client-rds-data"; // ES Modules import + * // const { RDSDataClient, ExecuteSqlCommand } = require("@aws-sdk/client-rds-data"); // CommonJS import + * const client = new RDSDataClient(config); + * const command = new ExecuteSqlCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ExecuteSqlCommandInput} for command's `input` shape. + * @see {@link ExecuteSqlCommandOutput} for command's `response` shape. + * @see {@link RDSDataClientResolvedConfig | config} for command's `input` shape. + * */ export class ExecuteSqlCommand extends $Command< ExecuteSqlCommandInput, diff --git a/clients/client-rds-data/commands/ExecuteStatementCommand.ts b/clients/client-rds-data/commands/ExecuteStatementCommand.ts index f195d90c8d4f..bd80956405bb 100644 --- a/clients/client-rds-data/commands/ExecuteStatementCommand.ts +++ b/clients/client-rds-data/commands/ExecuteStatementCommand.ts @@ -28,6 +28,20 @@ export interface ExecuteStatementCommandOutput extends ExecuteStatementResponse, * committed automatically.

* *

The response size limit is 1 MB. If the call returns more than 1 MB of response data, the call is terminated.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { RDSDataClient, ExecuteStatementCommand } from "@aws-sdk/client-rds-data"; // ES Modules import + * // const { RDSDataClient, ExecuteStatementCommand } = require("@aws-sdk/client-rds-data"); // CommonJS import + * const client = new RDSDataClient(config); + * const command = new ExecuteStatementCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ExecuteStatementCommandInput} for command's `input` shape. + * @see {@link ExecuteStatementCommandOutput} for command's `response` shape. + * @see {@link RDSDataClientResolvedConfig | config} for command's `input` shape. + * */ export class ExecuteStatementCommand extends $Command< ExecuteStatementCommandInput, diff --git a/clients/client-rds-data/commands/RollbackTransactionCommand.ts b/clients/client-rds-data/commands/RollbackTransactionCommand.ts index 0b78cee33731..caaa7219768f 100644 --- a/clients/client-rds-data/commands/RollbackTransactionCommand.ts +++ b/clients/client-rds-data/commands/RollbackTransactionCommand.ts @@ -22,6 +22,20 @@ export interface RollbackTransactionCommandOutput extends RollbackTransactionRes /** *

Performs a rollback of a transaction. Rolling back a transaction cancels its changes.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { RDSDataClient, RollbackTransactionCommand } from "@aws-sdk/client-rds-data"; // ES Modules import + * // const { RDSDataClient, RollbackTransactionCommand } = require("@aws-sdk/client-rds-data"); // CommonJS import + * const client = new RDSDataClient(config); + * const command = new RollbackTransactionCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link RollbackTransactionCommandInput} for command's `input` shape. + * @see {@link RollbackTransactionCommandOutput} for command's `response` shape. + * @see {@link RDSDataClientResolvedConfig | config} for command's `input` shape. + * */ export class RollbackTransactionCommand extends $Command< RollbackTransactionCommandInput, diff --git a/clients/client-rds-data/models/models_0.ts b/clients/client-rds-data/models/models_0.ts index 79617cdd44ee..073785b54469 100644 --- a/clients/client-rds-data/models/models_0.ts +++ b/clients/client-rds-data/models/models_0.ts @@ -14,6 +14,9 @@ export interface BadRequestException extends __SmithyException, $MetadataBearer } export namespace BadRequestException { + /** + * @internal + */ export const filterSensitiveLog = (obj: BadRequestException): any => ({ ...obj, }); @@ -41,6 +44,9 @@ export interface ForbiddenException extends __SmithyException, $MetadataBearer { } export namespace ForbiddenException { + /** + * @internal + */ export const filterSensitiveLog = (obj: ForbiddenException): any => ({ ...obj, }); @@ -55,6 +61,9 @@ export interface InternalServerErrorException extends __SmithyException, $Metada } export namespace InternalServerErrorException { + /** + * @internal + */ export const filterSensitiveLog = (obj: InternalServerErrorException): any => ({ ...obj, }); @@ -70,6 +79,9 @@ export interface ServiceUnavailableError extends __SmithyException, $MetadataBea } export namespace ServiceUnavailableError { + /** + * @internal + */ export const filterSensitiveLog = (obj: ServiceUnavailableError): any => ({ ...obj, }); @@ -93,6 +105,9 @@ export interface StatementTimeoutException extends __SmithyException, $MetadataB } export namespace StatementTimeoutException { + /** + * @internal + */ export const filterSensitiveLog = (obj: StatementTimeoutException): any => ({ ...obj, }); @@ -125,6 +140,9 @@ export interface BeginTransactionRequest { } export namespace BeginTransactionRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: BeginTransactionRequest): any => ({ ...obj, }); @@ -142,6 +160,9 @@ export interface BeginTransactionResponse { } export namespace BeginTransactionResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: BeginTransactionResponse): any => ({ ...obj, }); @@ -223,6 +244,9 @@ export interface ColumnMetadata { } export namespace ColumnMetadata { + /** + * @internal + */ export const filterSensitiveLog = (obj: ColumnMetadata): any => ({ ...obj, }); @@ -249,6 +273,9 @@ export interface CommitTransactionRequest { } export namespace CommitTransactionRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: CommitTransactionRequest): any => ({ ...obj, }); @@ -265,6 +292,9 @@ export interface CommitTransactionResponse { } export namespace CommitTransactionResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: CommitTransactionResponse): any => ({ ...obj, }); @@ -283,6 +313,9 @@ export interface NotFoundException extends __SmithyException, $MetadataBearer { } export namespace NotFoundException { + /** + * @internal + */ export const filterSensitiveLog = (obj: NotFoundException): any => ({ ...obj, }); @@ -328,6 +361,9 @@ export interface ExecuteSqlRequest { } export namespace ExecuteSqlRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ExecuteSqlRequest): any => ({ ...obj, }); @@ -349,6 +385,9 @@ export interface ResultSetMetadata { } export namespace ResultSetMetadata { + /** + * @internal + */ export const filterSensitiveLog = (obj: ResultSetMetadata): any => ({ ...obj, }); @@ -373,6 +412,9 @@ export interface ResultSetOptions { } export namespace ResultSetOptions { + /** + * @internal + */ export const filterSensitiveLog = (obj: ResultSetOptions): any => ({ ...obj, }); @@ -400,6 +442,9 @@ export interface RollbackTransactionRequest { } export namespace RollbackTransactionRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: RollbackTransactionRequest): any => ({ ...obj, }); @@ -417,6 +462,9 @@ export interface RollbackTransactionResponse { } export namespace RollbackTransactionResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: RollbackTransactionResponse): any => ({ ...obj, }); @@ -521,6 +569,9 @@ export namespace ArrayValue { return visitor._(value.$unknown[0], value.$unknown[1]); }; + /** + * @internal + */ export const filterSensitiveLog = (obj: ArrayValue): any => { if (obj.booleanValues !== undefined) return { booleanValues: obj.booleanValues }; if (obj.longValues !== undefined) return { longValues: obj.longValues }; @@ -677,6 +728,9 @@ export namespace Field { return visitor._(value.$unknown[0], value.$unknown[1]); }; + /** + * @internal + */ export const filterSensitiveLog = (obj: Field): any => { if (obj.isNull !== undefined) return { isNull: obj.isNull }; if (obj.booleanValue !== undefined) return { booleanValue: obj.booleanValue }; @@ -744,6 +798,9 @@ export interface SqlParameter { } export namespace SqlParameter { + /** + * @internal + */ export const filterSensitiveLog = (obj: SqlParameter): any => ({ ...obj, ...(obj.value && { value: Field.filterSensitiveLog(obj.value) }), @@ -761,6 +818,9 @@ export interface UpdateResult { } export namespace UpdateResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateResult): any => ({ ...obj, ...(obj.generatedFields && { generatedFields: obj.generatedFields.map((item) => Field.filterSensitiveLog(item)) }), @@ -1000,6 +1060,9 @@ export namespace Value { return visitor._(value.$unknown[0], value.$unknown[1]); }; + /** + * @internal + */ export const filterSensitiveLog = (obj: Value): any => { if (obj.isNull !== undefined) return { isNull: obj.isNull }; if (obj.bitValue !== undefined) return { bitValue: obj.bitValue }; @@ -1089,6 +1152,9 @@ export interface ExecuteStatementRequest { } export namespace ExecuteStatementRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ExecuteStatementRequest): any => ({ ...obj, ...(obj.parameters && { parameters: obj.parameters.map((item) => SqlParameter.filterSensitiveLog(item)) }), @@ -1106,6 +1172,9 @@ export interface StructValue { } export namespace StructValue { + /** + * @internal + */ export const filterSensitiveLog = (obj: StructValue): any => ({ ...obj, ...(obj.attributes && { attributes: obj.attributes.map((item) => Value.filterSensitiveLog(item)) }), @@ -1171,6 +1240,9 @@ export interface BatchExecuteStatementRequest { } export namespace BatchExecuteStatementRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: BatchExecuteStatementRequest): any => ({ ...obj, ...(obj.parameterSets && { @@ -1191,6 +1263,9 @@ export interface BatchExecuteStatementResponse { } export namespace BatchExecuteStatementResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: BatchExecuteStatementResponse): any => ({ ...obj, ...(obj.updateResults && { updateResults: obj.updateResults.map((item) => UpdateResult.filterSensitiveLog(item)) }), @@ -1208,6 +1283,9 @@ export interface _Record { } export namespace _Record { + /** + * @internal + */ export const filterSensitiveLog = (obj: _Record): any => ({ ...obj, ...(obj.values && { values: obj.values.map((item) => Value.filterSensitiveLog(item)) }), @@ -1248,6 +1326,9 @@ export interface ExecuteStatementResponse { } export namespace ExecuteStatementResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ExecuteStatementResponse): any => ({ ...obj, ...(obj.records && { records: obj.records.map((item) => item.map((item) => Field.filterSensitiveLog(item))) }), @@ -1271,6 +1352,9 @@ export interface ResultFrame { } export namespace ResultFrame { + /** + * @internal + */ export const filterSensitiveLog = (obj: ResultFrame): any => ({ ...obj, ...(obj.records && { records: obj.records.map((item) => _Record.filterSensitiveLog(item)) }), @@ -1297,6 +1381,9 @@ export interface SqlStatementResult { } export namespace SqlStatementResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: SqlStatementResult): any => ({ ...obj, }); @@ -1314,6 +1401,9 @@ export interface ExecuteSqlResponse { } export namespace ExecuteSqlResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ExecuteSqlResponse): any => ({ ...obj, }); diff --git a/clients/client-rds/commands/AddRoleToDBClusterCommand.ts b/clients/client-rds/commands/AddRoleToDBClusterCommand.ts index a22a779454c5..163b294a6f07 100644 --- a/clients/client-rds/commands/AddRoleToDBClusterCommand.ts +++ b/clients/client-rds/commands/AddRoleToDBClusterCommand.ts @@ -27,6 +27,20 @@ export interface AddRoleToDBClusterCommandOutput extends __MetadataBearer {} * *

This action only applies to Aurora DB clusters.

* + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { RDSClient, AddRoleToDBClusterCommand } from "@aws-sdk/client-rds"; // ES Modules import + * // const { RDSClient, AddRoleToDBClusterCommand } = require("@aws-sdk/client-rds"); // CommonJS import + * const client = new RDSClient(config); + * const command = new AddRoleToDBClusterCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link AddRoleToDBClusterCommandInput} for command's `input` shape. + * @see {@link AddRoleToDBClusterCommandOutput} for command's `response` shape. + * @see {@link RDSClientResolvedConfig | config} for command's `input` shape. + * */ export class AddRoleToDBClusterCommand extends $Command< AddRoleToDBClusterCommandInput, diff --git a/clients/client-rds/commands/AddRoleToDBInstanceCommand.ts b/clients/client-rds/commands/AddRoleToDBInstanceCommand.ts index e183e00439f4..bbced1a6e7bb 100644 --- a/clients/client-rds/commands/AddRoleToDBInstanceCommand.ts +++ b/clients/client-rds/commands/AddRoleToDBInstanceCommand.ts @@ -25,6 +25,20 @@ export interface AddRoleToDBInstanceCommandOutput extends __MetadataBearer {} * *

To add a role to a DB instance, the status of the DB instance must be available.

* + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { RDSClient, AddRoleToDBInstanceCommand } from "@aws-sdk/client-rds"; // ES Modules import + * // const { RDSClient, AddRoleToDBInstanceCommand } = require("@aws-sdk/client-rds"); // CommonJS import + * const client = new RDSClient(config); + * const command = new AddRoleToDBInstanceCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link AddRoleToDBInstanceCommandInput} for command's `input` shape. + * @see {@link AddRoleToDBInstanceCommandOutput} for command's `response` shape. + * @see {@link RDSClientResolvedConfig | config} for command's `input` shape. + * */ export class AddRoleToDBInstanceCommand extends $Command< AddRoleToDBInstanceCommandInput, diff --git a/clients/client-rds/commands/AddSourceIdentifierToSubscriptionCommand.ts b/clients/client-rds/commands/AddSourceIdentifierToSubscriptionCommand.ts index 6e9a8a2bd145..f20150140919 100644 --- a/clients/client-rds/commands/AddSourceIdentifierToSubscriptionCommand.ts +++ b/clients/client-rds/commands/AddSourceIdentifierToSubscriptionCommand.ts @@ -24,6 +24,20 @@ export interface AddSourceIdentifierToSubscriptionCommandOutput /** *

Adds a source identifier to an existing RDS event notification subscription.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { RDSClient, AddSourceIdentifierToSubscriptionCommand } from "@aws-sdk/client-rds"; // ES Modules import + * // const { RDSClient, AddSourceIdentifierToSubscriptionCommand } = require("@aws-sdk/client-rds"); // CommonJS import + * const client = new RDSClient(config); + * const command = new AddSourceIdentifierToSubscriptionCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link AddSourceIdentifierToSubscriptionCommandInput} for command's `input` shape. + * @see {@link AddSourceIdentifierToSubscriptionCommandOutput} for command's `response` shape. + * @see {@link RDSClientResolvedConfig | config} for command's `input` shape. + * */ export class AddSourceIdentifierToSubscriptionCommand extends $Command< AddSourceIdentifierToSubscriptionCommandInput, diff --git a/clients/client-rds/commands/AddTagsToResourceCommand.ts b/clients/client-rds/commands/AddTagsToResourceCommand.ts index 61c8066d6842..05bd37a22a7f 100644 --- a/clients/client-rds/commands/AddTagsToResourceCommand.ts +++ b/clients/client-rds/commands/AddTagsToResourceCommand.ts @@ -24,6 +24,20 @@ export interface AddTagsToResourceCommandOutput extends __MetadataBearer {} *

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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { RDSClient, AddTagsToResourceCommand } from "@aws-sdk/client-rds"; // ES Modules import + * // const { RDSClient, AddTagsToResourceCommand } = require("@aws-sdk/client-rds"); // CommonJS import + * const client = new RDSClient(config); + * const command = new AddTagsToResourceCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link AddTagsToResourceCommandInput} for command's `input` shape. + * @see {@link AddTagsToResourceCommandOutput} for command's `response` shape. + * @see {@link RDSClientResolvedConfig | config} for command's `input` shape. + * */ export class AddTagsToResourceCommand extends $Command< AddTagsToResourceCommandInput, diff --git a/clients/client-rds/commands/ApplyPendingMaintenanceActionCommand.ts b/clients/client-rds/commands/ApplyPendingMaintenanceActionCommand.ts index 0ffbc3a45ebb..cab6c1bb241b 100644 --- a/clients/client-rds/commands/ApplyPendingMaintenanceActionCommand.ts +++ b/clients/client-rds/commands/ApplyPendingMaintenanceActionCommand.ts @@ -24,6 +24,20 @@ export interface ApplyPendingMaintenanceActionCommandOutput /** *

Applies a pending maintenance action to a resource (for example, to a DB instance).

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { RDSClient, ApplyPendingMaintenanceActionCommand } from "@aws-sdk/client-rds"; // ES Modules import + * // const { RDSClient, ApplyPendingMaintenanceActionCommand } = require("@aws-sdk/client-rds"); // CommonJS import + * const client = new RDSClient(config); + * const command = new ApplyPendingMaintenanceActionCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ApplyPendingMaintenanceActionCommandInput} for command's `input` shape. + * @see {@link ApplyPendingMaintenanceActionCommandOutput} for command's `response` shape. + * @see {@link RDSClientResolvedConfig | config} for command's `input` shape. + * */ export class ApplyPendingMaintenanceActionCommand extends $Command< ApplyPendingMaintenanceActionCommandInput, diff --git a/clients/client-rds/commands/AuthorizeDBSecurityGroupIngressCommand.ts b/clients/client-rds/commands/AuthorizeDBSecurityGroupIngressCommand.ts index 4bdcfd05f2a0..62f0459c7ab4 100644 --- a/clients/client-rds/commands/AuthorizeDBSecurityGroupIngressCommand.ts +++ b/clients/client-rds/commands/AuthorizeDBSecurityGroupIngressCommand.ts @@ -35,6 +35,20 @@ export interface AuthorizeDBSecurityGroupIngressCommandOutput *

For an overview of CIDR ranges, go to the * Wikipedia Tutorial. *

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { RDSClient, AuthorizeDBSecurityGroupIngressCommand } from "@aws-sdk/client-rds"; // ES Modules import + * // const { RDSClient, AuthorizeDBSecurityGroupIngressCommand } = require("@aws-sdk/client-rds"); // CommonJS import + * const client = new RDSClient(config); + * const command = new AuthorizeDBSecurityGroupIngressCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link AuthorizeDBSecurityGroupIngressCommandInput} for command's `input` shape. + * @see {@link AuthorizeDBSecurityGroupIngressCommandOutput} for command's `response` shape. + * @see {@link RDSClientResolvedConfig | config} for command's `input` shape. + * */ export class AuthorizeDBSecurityGroupIngressCommand extends $Command< AuthorizeDBSecurityGroupIngressCommandInput, diff --git a/clients/client-rds/commands/BacktrackDBClusterCommand.ts b/clients/client-rds/commands/BacktrackDBClusterCommand.ts index bb9729398634..587cb51cdd47 100644 --- a/clients/client-rds/commands/BacktrackDBClusterCommand.ts +++ b/clients/client-rds/commands/BacktrackDBClusterCommand.ts @@ -30,6 +30,20 @@ export interface BacktrackDBClusterCommandOutput extends DBClusterBacktrack, __M * *

This action only applies to Aurora MySQL DB clusters.

* + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { RDSClient, BacktrackDBClusterCommand } from "@aws-sdk/client-rds"; // ES Modules import + * // const { RDSClient, BacktrackDBClusterCommand } = require("@aws-sdk/client-rds"); // CommonJS import + * const client = new RDSClient(config); + * const command = new BacktrackDBClusterCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link BacktrackDBClusterCommandInput} for command's `input` shape. + * @see {@link BacktrackDBClusterCommandOutput} for command's `response` shape. + * @see {@link RDSClientResolvedConfig | config} for command's `input` shape. + * */ export class BacktrackDBClusterCommand extends $Command< BacktrackDBClusterCommandInput, diff --git a/clients/client-rds/commands/CancelExportTaskCommand.ts b/clients/client-rds/commands/CancelExportTaskCommand.ts index 57e485b4bc18..a84463104dfb 100644 --- a/clients/client-rds/commands/CancelExportTaskCommand.ts +++ b/clients/client-rds/commands/CancelExportTaskCommand.ts @@ -24,6 +24,20 @@ export interface CancelExportTaskCommandOutput extends ExportTask, __MetadataBea *

Cancels an export task in progress that is exporting a snapshot to Amazon S3. * Any data that has already been written to the S3 bucket isn't removed. *

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { RDSClient, CancelExportTaskCommand } from "@aws-sdk/client-rds"; // ES Modules import + * // const { RDSClient, CancelExportTaskCommand } = require("@aws-sdk/client-rds"); // CommonJS import + * const client = new RDSClient(config); + * const command = new CancelExportTaskCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CancelExportTaskCommandInput} for command's `input` shape. + * @see {@link CancelExportTaskCommandOutput} for command's `response` shape. + * @see {@link RDSClientResolvedConfig | config} for command's `input` shape. + * */ export class CancelExportTaskCommand extends $Command< CancelExportTaskCommandInput, diff --git a/clients/client-rds/commands/CopyDBClusterParameterGroupCommand.ts b/clients/client-rds/commands/CopyDBClusterParameterGroupCommand.ts index eae78483424f..174d59ba744f 100644 --- a/clients/client-rds/commands/CopyDBClusterParameterGroupCommand.ts +++ b/clients/client-rds/commands/CopyDBClusterParameterGroupCommand.ts @@ -25,6 +25,20 @@ export interface CopyDBClusterParameterGroupCommandOutput extends CopyDBClusterP * *

This action only applies to Aurora DB clusters.

* + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { RDSClient, CopyDBClusterParameterGroupCommand } from "@aws-sdk/client-rds"; // ES Modules import + * // const { RDSClient, CopyDBClusterParameterGroupCommand } = require("@aws-sdk/client-rds"); // CommonJS import + * const client = new RDSClient(config); + * const command = new CopyDBClusterParameterGroupCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CopyDBClusterParameterGroupCommandInput} for command's `input` shape. + * @see {@link CopyDBClusterParameterGroupCommandOutput} for command's `response` shape. + * @see {@link RDSClientResolvedConfig | config} for command's `input` shape. + * */ export class CopyDBClusterParameterGroupCommand extends $Command< CopyDBClusterParameterGroupCommandInput, diff --git a/clients/client-rds/commands/CopyDBClusterSnapshotCommand.ts b/clients/client-rds/commands/CopyDBClusterSnapshotCommand.ts index 7b91b957e1eb..1515302d04e3 100644 --- a/clients/client-rds/commands/CopyDBClusterSnapshotCommand.ts +++ b/clients/client-rds/commands/CopyDBClusterSnapshotCommand.ts @@ -97,6 +97,20 @@ export interface CopyDBClusterSnapshotCommandOutput extends CopyDBClusterSnapsho * *

This action only applies to Aurora DB clusters.

* + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { RDSClient, CopyDBClusterSnapshotCommand } from "@aws-sdk/client-rds"; // ES Modules import + * // const { RDSClient, CopyDBClusterSnapshotCommand } = require("@aws-sdk/client-rds"); // CommonJS import + * const client = new RDSClient(config); + * const command = new CopyDBClusterSnapshotCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CopyDBClusterSnapshotCommandInput} for command's `input` shape. + * @see {@link CopyDBClusterSnapshotCommandOutput} for command's `response` shape. + * @see {@link RDSClientResolvedConfig | config} for command's `input` shape. + * */ export class CopyDBClusterSnapshotCommand extends $Command< CopyDBClusterSnapshotCommandInput, diff --git a/clients/client-rds/commands/CopyDBParameterGroupCommand.ts b/clients/client-rds/commands/CopyDBParameterGroupCommand.ts index 4e1f95c1333a..27fbe6050147 100644 --- a/clients/client-rds/commands/CopyDBParameterGroupCommand.ts +++ b/clients/client-rds/commands/CopyDBParameterGroupCommand.ts @@ -22,6 +22,20 @@ export interface CopyDBParameterGroupCommandOutput extends CopyDBParameterGroupR /** *

Copies the specified DB parameter group.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { RDSClient, CopyDBParameterGroupCommand } from "@aws-sdk/client-rds"; // ES Modules import + * // const { RDSClient, CopyDBParameterGroupCommand } = require("@aws-sdk/client-rds"); // CommonJS import + * const client = new RDSClient(config); + * const command = new CopyDBParameterGroupCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CopyDBParameterGroupCommandInput} for command's `input` shape. + * @see {@link CopyDBParameterGroupCommandOutput} for command's `response` shape. + * @see {@link RDSClientResolvedConfig | config} for command's `input` shape. + * */ export class CopyDBParameterGroupCommand extends $Command< CopyDBParameterGroupCommandInput, diff --git a/clients/client-rds/commands/CopyDBSnapshotCommand.ts b/clients/client-rds/commands/CopyDBSnapshotCommand.ts index 079ffd1c29de..ffb3fef048cd 100644 --- a/clients/client-rds/commands/CopyDBSnapshotCommand.ts +++ b/clients/client-rds/commands/CopyDBSnapshotCommand.ts @@ -31,6 +31,20 @@ export interface CopyDBSnapshotCommandOutput extends CopyDBSnapshotResult, __Met *

For more information about copying snapshots, see * Copying a DB Snapshot in the Amazon RDS User Guide. *

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { RDSClient, CopyDBSnapshotCommand } from "@aws-sdk/client-rds"; // ES Modules import + * // const { RDSClient, CopyDBSnapshotCommand } = require("@aws-sdk/client-rds"); // CommonJS import + * const client = new RDSClient(config); + * const command = new CopyDBSnapshotCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CopyDBSnapshotCommandInput} for command's `input` shape. + * @see {@link CopyDBSnapshotCommandOutput} for command's `response` shape. + * @see {@link RDSClientResolvedConfig | config} for command's `input` shape. + * */ export class CopyDBSnapshotCommand extends $Command< CopyDBSnapshotCommandInput, diff --git a/clients/client-rds/commands/CopyOptionGroupCommand.ts b/clients/client-rds/commands/CopyOptionGroupCommand.ts index b31f9a2870ff..468382905792 100644 --- a/clients/client-rds/commands/CopyOptionGroupCommand.ts +++ b/clients/client-rds/commands/CopyOptionGroupCommand.ts @@ -22,6 +22,20 @@ export interface CopyOptionGroupCommandOutput extends CopyOptionGroupResult, __M /** *

Copies the specified option group.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { RDSClient, CopyOptionGroupCommand } from "@aws-sdk/client-rds"; // ES Modules import + * // const { RDSClient, CopyOptionGroupCommand } = require("@aws-sdk/client-rds"); // CommonJS import + * const client = new RDSClient(config); + * const command = new CopyOptionGroupCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CopyOptionGroupCommandInput} for command's `input` shape. + * @see {@link CopyOptionGroupCommandOutput} for command's `response` shape. + * @see {@link RDSClientResolvedConfig | config} for command's `input` shape. + * */ export class CopyOptionGroupCommand extends $Command< CopyOptionGroupCommandInput, diff --git a/clients/client-rds/commands/CreateCustomAvailabilityZoneCommand.ts b/clients/client-rds/commands/CreateCustomAvailabilityZoneCommand.ts index b6d78ba6c75e..a7c9f1176a8b 100644 --- a/clients/client-rds/commands/CreateCustomAvailabilityZoneCommand.ts +++ b/clients/client-rds/commands/CreateCustomAvailabilityZoneCommand.ts @@ -29,6 +29,20 @@ export interface CreateCustomAvailabilityZoneCommandOutput * * RDS on VMware User Guide. *

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { RDSClient, CreateCustomAvailabilityZoneCommand } from "@aws-sdk/client-rds"; // ES Modules import + * // const { RDSClient, CreateCustomAvailabilityZoneCommand } = require("@aws-sdk/client-rds"); // CommonJS import + * const client = new RDSClient(config); + * const command = new CreateCustomAvailabilityZoneCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreateCustomAvailabilityZoneCommandInput} for command's `input` shape. + * @see {@link CreateCustomAvailabilityZoneCommandOutput} for command's `response` shape. + * @see {@link RDSClientResolvedConfig | config} for command's `input` shape. + * */ export class CreateCustomAvailabilityZoneCommand extends $Command< CreateCustomAvailabilityZoneCommandInput, diff --git a/clients/client-rds/commands/CreateDBClusterCommand.ts b/clients/client-rds/commands/CreateDBClusterCommand.ts index 24e1d6079321..7ffcae566ec8 100644 --- a/clients/client-rds/commands/CreateDBClusterCommand.ts +++ b/clients/client-rds/commands/CreateDBClusterCommand.ts @@ -36,6 +36,20 @@ export interface CreateDBClusterCommandOutput extends CreateDBClusterResult, __M * *

This action only applies to Aurora DB clusters.

* + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { RDSClient, CreateDBClusterCommand } from "@aws-sdk/client-rds"; // ES Modules import + * // const { RDSClient, CreateDBClusterCommand } = require("@aws-sdk/client-rds"); // CommonJS import + * const client = new RDSClient(config); + * const command = new CreateDBClusterCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreateDBClusterCommandInput} for command's `input` shape. + * @see {@link CreateDBClusterCommandOutput} for command's `response` shape. + * @see {@link RDSClientResolvedConfig | config} for command's `input` shape. + * */ export class CreateDBClusterCommand extends $Command< CreateDBClusterCommandInput, diff --git a/clients/client-rds/commands/CreateDBClusterEndpointCommand.ts b/clients/client-rds/commands/CreateDBClusterEndpointCommand.ts index bf3f0b5d81e5..1662135d8239 100644 --- a/clients/client-rds/commands/CreateDBClusterEndpointCommand.ts +++ b/clients/client-rds/commands/CreateDBClusterEndpointCommand.ts @@ -25,6 +25,20 @@ export interface CreateDBClusterEndpointCommandOutput extends DBClusterEndpoint, * *

This action only applies to Aurora DB clusters.

* + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { RDSClient, CreateDBClusterEndpointCommand } from "@aws-sdk/client-rds"; // ES Modules import + * // const { RDSClient, CreateDBClusterEndpointCommand } = require("@aws-sdk/client-rds"); // CommonJS import + * const client = new RDSClient(config); + * const command = new CreateDBClusterEndpointCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreateDBClusterEndpointCommandInput} for command's `input` shape. + * @see {@link CreateDBClusterEndpointCommandOutput} for command's `response` shape. + * @see {@link RDSClientResolvedConfig | config} for command's `input` shape. + * */ export class CreateDBClusterEndpointCommand extends $Command< CreateDBClusterEndpointCommandInput, diff --git a/clients/client-rds/commands/CreateDBClusterParameterGroupCommand.ts b/clients/client-rds/commands/CreateDBClusterParameterGroupCommand.ts index 8c39926df7d0..ee4b8cff4587 100644 --- a/clients/client-rds/commands/CreateDBClusterParameterGroupCommand.ts +++ b/clients/client-rds/commands/CreateDBClusterParameterGroupCommand.ts @@ -55,6 +55,20 @@ export interface CreateDBClusterParameterGroupCommandOutput * *

This action only applies to Aurora DB clusters.

* + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { RDSClient, CreateDBClusterParameterGroupCommand } from "@aws-sdk/client-rds"; // ES Modules import + * // const { RDSClient, CreateDBClusterParameterGroupCommand } = require("@aws-sdk/client-rds"); // CommonJS import + * const client = new RDSClient(config); + * const command = new CreateDBClusterParameterGroupCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreateDBClusterParameterGroupCommandInput} for command's `input` shape. + * @see {@link CreateDBClusterParameterGroupCommandOutput} for command's `response` shape. + * @see {@link RDSClientResolvedConfig | config} for command's `input` shape. + * */ export class CreateDBClusterParameterGroupCommand extends $Command< CreateDBClusterParameterGroupCommandInput, diff --git a/clients/client-rds/commands/CreateDBClusterSnapshotCommand.ts b/clients/client-rds/commands/CreateDBClusterSnapshotCommand.ts index 0c0a04e83c7f..1f34af18ae1c 100644 --- a/clients/client-rds/commands/CreateDBClusterSnapshotCommand.ts +++ b/clients/client-rds/commands/CreateDBClusterSnapshotCommand.ts @@ -28,6 +28,20 @@ export interface CreateDBClusterSnapshotCommandOutput extends CreateDBClusterSna * *

This action only applies to Aurora DB clusters.

* + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { RDSClient, CreateDBClusterSnapshotCommand } from "@aws-sdk/client-rds"; // ES Modules import + * // const { RDSClient, CreateDBClusterSnapshotCommand } = require("@aws-sdk/client-rds"); // CommonJS import + * const client = new RDSClient(config); + * const command = new CreateDBClusterSnapshotCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreateDBClusterSnapshotCommandInput} for command's `input` shape. + * @see {@link CreateDBClusterSnapshotCommandOutput} for command's `response` shape. + * @see {@link RDSClientResolvedConfig | config} for command's `input` shape. + * */ export class CreateDBClusterSnapshotCommand extends $Command< CreateDBClusterSnapshotCommandInput, diff --git a/clients/client-rds/commands/CreateDBInstanceCommand.ts b/clients/client-rds/commands/CreateDBInstanceCommand.ts index a4aff609f5af..6bdef396052f 100644 --- a/clients/client-rds/commands/CreateDBInstanceCommand.ts +++ b/clients/client-rds/commands/CreateDBInstanceCommand.ts @@ -22,6 +22,20 @@ export interface CreateDBInstanceCommandOutput extends CreateDBInstanceResult, _ /** *

Creates a new DB instance.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { RDSClient, CreateDBInstanceCommand } from "@aws-sdk/client-rds"; // ES Modules import + * // const { RDSClient, CreateDBInstanceCommand } = require("@aws-sdk/client-rds"); // CommonJS import + * const client = new RDSClient(config); + * const command = new CreateDBInstanceCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreateDBInstanceCommandInput} for command's `input` shape. + * @see {@link CreateDBInstanceCommandOutput} for command's `response` shape. + * @see {@link RDSClientResolvedConfig | config} for command's `input` shape. + * */ export class CreateDBInstanceCommand extends $Command< CreateDBInstanceCommandInput, diff --git a/clients/client-rds/commands/CreateDBInstanceReadReplicaCommand.ts b/clients/client-rds/commands/CreateDBInstanceReadReplicaCommand.ts index b19662d85d5f..c703b83c471d 100644 --- a/clients/client-rds/commands/CreateDBInstanceReadReplicaCommand.ts +++ b/clients/client-rds/commands/CreateDBInstanceReadReplicaCommand.ts @@ -38,6 +38,20 @@ export interface CreateDBInstanceReadReplicaCommandOutput extends CreateDBInstan *

Your source DB instance must have backup retention enabled. *

* + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { RDSClient, CreateDBInstanceReadReplicaCommand } from "@aws-sdk/client-rds"; // ES Modules import + * // const { RDSClient, CreateDBInstanceReadReplicaCommand } = require("@aws-sdk/client-rds"); // CommonJS import + * const client = new RDSClient(config); + * const command = new CreateDBInstanceReadReplicaCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreateDBInstanceReadReplicaCommandInput} for command's `input` shape. + * @see {@link CreateDBInstanceReadReplicaCommandOutput} for command's `response` shape. + * @see {@link RDSClientResolvedConfig | config} for command's `input` shape. + * */ export class CreateDBInstanceReadReplicaCommand extends $Command< CreateDBInstanceReadReplicaCommandInput, diff --git a/clients/client-rds/commands/CreateDBParameterGroupCommand.ts b/clients/client-rds/commands/CreateDBParameterGroupCommand.ts index aa5ba2efceb2..632c4920774d 100644 --- a/clients/client-rds/commands/CreateDBParameterGroupCommand.ts +++ b/clients/client-rds/commands/CreateDBParameterGroupCommand.ts @@ -42,6 +42,20 @@ export interface CreateDBParameterGroupCommandOutput extends CreateDBParameterGr * DescribeDBParameters command to verify * that your DB parameter group has been created or modified.

* + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { RDSClient, CreateDBParameterGroupCommand } from "@aws-sdk/client-rds"; // ES Modules import + * // const { RDSClient, CreateDBParameterGroupCommand } = require("@aws-sdk/client-rds"); // CommonJS import + * const client = new RDSClient(config); + * const command = new CreateDBParameterGroupCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreateDBParameterGroupCommandInput} for command's `input` shape. + * @see {@link CreateDBParameterGroupCommandOutput} for command's `response` shape. + * @see {@link RDSClientResolvedConfig | config} for command's `input` shape. + * */ export class CreateDBParameterGroupCommand extends $Command< CreateDBParameterGroupCommandInput, diff --git a/clients/client-rds/commands/CreateDBProxyCommand.ts b/clients/client-rds/commands/CreateDBProxyCommand.ts index 4488949ded9e..9b0dc5a584c3 100644 --- a/clients/client-rds/commands/CreateDBProxyCommand.ts +++ b/clients/client-rds/commands/CreateDBProxyCommand.ts @@ -22,6 +22,20 @@ export interface CreateDBProxyCommandOutput extends CreateDBProxyResponse, __Met /** *

Creates a new DB proxy.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { RDSClient, CreateDBProxyCommand } from "@aws-sdk/client-rds"; // ES Modules import + * // const { RDSClient, CreateDBProxyCommand } = require("@aws-sdk/client-rds"); // CommonJS import + * const client = new RDSClient(config); + * const command = new CreateDBProxyCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreateDBProxyCommandInput} for command's `input` shape. + * @see {@link CreateDBProxyCommandOutput} for command's `response` shape. + * @see {@link RDSClientResolvedConfig | config} for command's `input` shape. + * */ export class CreateDBProxyCommand extends $Command< CreateDBProxyCommandInput, diff --git a/clients/client-rds/commands/CreateDBProxyEndpointCommand.ts b/clients/client-rds/commands/CreateDBProxyEndpointCommand.ts index dcb973bd4298..7688a7c40e75 100644 --- a/clients/client-rds/commands/CreateDBProxyEndpointCommand.ts +++ b/clients/client-rds/commands/CreateDBProxyEndpointCommand.ts @@ -26,6 +26,20 @@ export interface CreateDBProxyEndpointCommandOutput extends CreateDBProxyEndpoin * 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. *

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { RDSClient, CreateDBProxyEndpointCommand } from "@aws-sdk/client-rds"; // ES Modules import + * // const { RDSClient, CreateDBProxyEndpointCommand } = require("@aws-sdk/client-rds"); // CommonJS import + * const client = new RDSClient(config); + * const command = new CreateDBProxyEndpointCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreateDBProxyEndpointCommandInput} for command's `input` shape. + * @see {@link CreateDBProxyEndpointCommandOutput} for command's `response` shape. + * @see {@link RDSClientResolvedConfig | config} for command's `input` shape. + * */ export class CreateDBProxyEndpointCommand extends $Command< CreateDBProxyEndpointCommandInput, diff --git a/clients/client-rds/commands/CreateDBSecurityGroupCommand.ts b/clients/client-rds/commands/CreateDBSecurityGroupCommand.ts index 46655abec4a2..2d0cec8283bb 100644 --- a/clients/client-rds/commands/CreateDBSecurityGroupCommand.ts +++ b/clients/client-rds/commands/CreateDBSecurityGroupCommand.ts @@ -25,6 +25,20 @@ export interface CreateDBSecurityGroupCommandOutput extends CreateDBSecurityGrou * *

A DB security group controls access to EC2-Classic DB instances that are not in a VPC.

* + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { RDSClient, CreateDBSecurityGroupCommand } from "@aws-sdk/client-rds"; // ES Modules import + * // const { RDSClient, CreateDBSecurityGroupCommand } = require("@aws-sdk/client-rds"); // CommonJS import + * const client = new RDSClient(config); + * const command = new CreateDBSecurityGroupCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreateDBSecurityGroupCommandInput} for command's `input` shape. + * @see {@link CreateDBSecurityGroupCommandOutput} for command's `response` shape. + * @see {@link RDSClientResolvedConfig | config} for command's `input` shape. + * */ export class CreateDBSecurityGroupCommand extends $Command< CreateDBSecurityGroupCommandInput, diff --git a/clients/client-rds/commands/CreateDBSnapshotCommand.ts b/clients/client-rds/commands/CreateDBSnapshotCommand.ts index 9c7169286d7a..c878e91e178e 100644 --- a/clients/client-rds/commands/CreateDBSnapshotCommand.ts +++ b/clients/client-rds/commands/CreateDBSnapshotCommand.ts @@ -23,6 +23,20 @@ export interface CreateDBSnapshotCommandOutput extends CreateDBSnapshotResult, _ /** *

Creates a snapshot of a DB instance. The source DB instance must be in the available or * storage-optimization state.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { RDSClient, CreateDBSnapshotCommand } from "@aws-sdk/client-rds"; // ES Modules import + * // const { RDSClient, CreateDBSnapshotCommand } = require("@aws-sdk/client-rds"); // CommonJS import + * const client = new RDSClient(config); + * const command = new CreateDBSnapshotCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreateDBSnapshotCommandInput} for command's `input` shape. + * @see {@link CreateDBSnapshotCommandOutput} for command's `response` shape. + * @see {@link RDSClientResolvedConfig | config} for command's `input` shape. + * */ export class CreateDBSnapshotCommand extends $Command< CreateDBSnapshotCommandInput, diff --git a/clients/client-rds/commands/CreateDBSubnetGroupCommand.ts b/clients/client-rds/commands/CreateDBSubnetGroupCommand.ts index 8666de710602..a987a38a4f48 100644 --- a/clients/client-rds/commands/CreateDBSubnetGroupCommand.ts +++ b/clients/client-rds/commands/CreateDBSubnetGroupCommand.ts @@ -22,6 +22,20 @@ export interface CreateDBSubnetGroupCommandOutput extends CreateDBSubnetGroupRes /** *

Creates a new DB subnet group. DB subnet groups must contain at least one subnet in at least two AZs in the AWS Region.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { RDSClient, CreateDBSubnetGroupCommand } from "@aws-sdk/client-rds"; // ES Modules import + * // const { RDSClient, CreateDBSubnetGroupCommand } = require("@aws-sdk/client-rds"); // CommonJS import + * const client = new RDSClient(config); + * const command = new CreateDBSubnetGroupCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreateDBSubnetGroupCommandInput} for command's `input` shape. + * @see {@link CreateDBSubnetGroupCommandOutput} for command's `response` shape. + * @see {@link RDSClientResolvedConfig | config} for command's `input` shape. + * */ export class CreateDBSubnetGroupCommand extends $Command< CreateDBSubnetGroupCommandInput, diff --git a/clients/client-rds/commands/CreateEventSubscriptionCommand.ts b/clients/client-rds/commands/CreateEventSubscriptionCommand.ts index 962b2a5e7f8c..b5e1c5e3e432 100644 --- a/clients/client-rds/commands/CreateEventSubscriptionCommand.ts +++ b/clients/client-rds/commands/CreateEventSubscriptionCommand.ts @@ -44,6 +44,20 @@ export interface CreateEventSubscriptionCommandOutput extends CreateEventSubscri *

RDS event notification is only available for unencrypted SNS topics. If you specify an * encrypted SNS topic, event notifications aren't sent for the topic.

* + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { RDSClient, CreateEventSubscriptionCommand } from "@aws-sdk/client-rds"; // ES Modules import + * // const { RDSClient, CreateEventSubscriptionCommand } = require("@aws-sdk/client-rds"); // CommonJS import + * const client = new RDSClient(config); + * const command = new CreateEventSubscriptionCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreateEventSubscriptionCommandInput} for command's `input` shape. + * @see {@link CreateEventSubscriptionCommandOutput} for command's `response` shape. + * @see {@link RDSClientResolvedConfig | config} for command's `input` shape. + * */ export class CreateEventSubscriptionCommand extends $Command< CreateEventSubscriptionCommandInput, diff --git a/clients/client-rds/commands/CreateGlobalClusterCommand.ts b/clients/client-rds/commands/CreateGlobalClusterCommand.ts index 6313b9462f8e..d5f464d6cf1c 100644 --- a/clients/client-rds/commands/CreateGlobalClusterCommand.ts +++ b/clients/client-rds/commands/CreateGlobalClusterCommand.ts @@ -38,6 +38,20 @@ export interface CreateGlobalClusterCommandOutput extends CreateGlobalClusterRes * *

This action only applies to Aurora DB clusters.

* + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { RDSClient, CreateGlobalClusterCommand } from "@aws-sdk/client-rds"; // ES Modules import + * // const { RDSClient, CreateGlobalClusterCommand } = require("@aws-sdk/client-rds"); // CommonJS import + * const client = new RDSClient(config); + * const command = new CreateGlobalClusterCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreateGlobalClusterCommandInput} for command's `input` shape. + * @see {@link CreateGlobalClusterCommandOutput} for command's `response` shape. + * @see {@link RDSClientResolvedConfig | config} for command's `input` shape. + * */ export class CreateGlobalClusterCommand extends $Command< CreateGlobalClusterCommandInput, diff --git a/clients/client-rds/commands/CreateOptionGroupCommand.ts b/clients/client-rds/commands/CreateOptionGroupCommand.ts index e9698e08a345..0b6b9b8aa1e5 100644 --- a/clients/client-rds/commands/CreateOptionGroupCommand.ts +++ b/clients/client-rds/commands/CreateOptionGroupCommand.ts @@ -22,6 +22,20 @@ export interface CreateOptionGroupCommandOutput extends CreateOptionGroupResult, /** *

Creates a new option group. You can create up to 20 option groups.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { RDSClient, CreateOptionGroupCommand } from "@aws-sdk/client-rds"; // ES Modules import + * // const { RDSClient, CreateOptionGroupCommand } = require("@aws-sdk/client-rds"); // CommonJS import + * const client = new RDSClient(config); + * const command = new CreateOptionGroupCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreateOptionGroupCommandInput} for command's `input` shape. + * @see {@link CreateOptionGroupCommandOutput} for command's `response` shape. + * @see {@link RDSClientResolvedConfig | config} for command's `input` shape. + * */ export class CreateOptionGroupCommand extends $Command< CreateOptionGroupCommandInput, diff --git a/clients/client-rds/commands/DeleteCustomAvailabilityZoneCommand.ts b/clients/client-rds/commands/DeleteCustomAvailabilityZoneCommand.ts index bd7e119ada72..98d15a8b7323 100644 --- a/clients/client-rds/commands/DeleteCustomAvailabilityZoneCommand.ts +++ b/clients/client-rds/commands/DeleteCustomAvailabilityZoneCommand.ts @@ -29,6 +29,20 @@ export interface DeleteCustomAvailabilityZoneCommandOutput * * RDS on VMware User Guide. *

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { RDSClient, DeleteCustomAvailabilityZoneCommand } from "@aws-sdk/client-rds"; // ES Modules import + * // const { RDSClient, DeleteCustomAvailabilityZoneCommand } = require("@aws-sdk/client-rds"); // CommonJS import + * const client = new RDSClient(config); + * const command = new DeleteCustomAvailabilityZoneCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteCustomAvailabilityZoneCommandInput} for command's `input` shape. + * @see {@link DeleteCustomAvailabilityZoneCommandOutput} for command's `response` shape. + * @see {@link RDSClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteCustomAvailabilityZoneCommand extends $Command< DeleteCustomAvailabilityZoneCommandInput, diff --git a/clients/client-rds/commands/DeleteDBClusterCommand.ts b/clients/client-rds/commands/DeleteDBClusterCommand.ts index e52ffa8b1953..15751e60b37b 100644 --- a/clients/client-rds/commands/DeleteDBClusterCommand.ts +++ b/clients/client-rds/commands/DeleteDBClusterCommand.ts @@ -32,6 +32,20 @@ export interface DeleteDBClusterCommandOutput extends DeleteDBClusterResult, __M * *

This action only applies to Aurora DB clusters.

* + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { RDSClient, DeleteDBClusterCommand } from "@aws-sdk/client-rds"; // ES Modules import + * // const { RDSClient, DeleteDBClusterCommand } = require("@aws-sdk/client-rds"); // CommonJS import + * const client = new RDSClient(config); + * const command = new DeleteDBClusterCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteDBClusterCommandInput} for command's `input` shape. + * @see {@link DeleteDBClusterCommandOutput} for command's `response` shape. + * @see {@link RDSClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteDBClusterCommand extends $Command< DeleteDBClusterCommandInput, diff --git a/clients/client-rds/commands/DeleteDBClusterEndpointCommand.ts b/clients/client-rds/commands/DeleteDBClusterEndpointCommand.ts index 14f36b3905a6..8f7b4ab6959b 100644 --- a/clients/client-rds/commands/DeleteDBClusterEndpointCommand.ts +++ b/clients/client-rds/commands/DeleteDBClusterEndpointCommand.ts @@ -25,6 +25,20 @@ export interface DeleteDBClusterEndpointCommandOutput extends DBClusterEndpoint, * *

This action only applies to Aurora DB clusters.

* + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { RDSClient, DeleteDBClusterEndpointCommand } from "@aws-sdk/client-rds"; // ES Modules import + * // const { RDSClient, DeleteDBClusterEndpointCommand } = require("@aws-sdk/client-rds"); // CommonJS import + * const client = new RDSClient(config); + * const command = new DeleteDBClusterEndpointCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteDBClusterEndpointCommandInput} for command's `input` shape. + * @see {@link DeleteDBClusterEndpointCommandOutput} for command's `response` shape. + * @see {@link RDSClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteDBClusterEndpointCommand extends $Command< DeleteDBClusterEndpointCommandInput, diff --git a/clients/client-rds/commands/DeleteDBClusterParameterGroupCommand.ts b/clients/client-rds/commands/DeleteDBClusterParameterGroupCommand.ts index ead09c80bbb2..feb6f0d0a1a7 100644 --- a/clients/client-rds/commands/DeleteDBClusterParameterGroupCommand.ts +++ b/clients/client-rds/commands/DeleteDBClusterParameterGroupCommand.ts @@ -29,6 +29,20 @@ export interface DeleteDBClusterParameterGroupCommandOutput extends __MetadataBe * *

This action only applies to Aurora DB clusters.

* + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { RDSClient, DeleteDBClusterParameterGroupCommand } from "@aws-sdk/client-rds"; // ES Modules import + * // const { RDSClient, DeleteDBClusterParameterGroupCommand } = require("@aws-sdk/client-rds"); // CommonJS import + * const client = new RDSClient(config); + * const command = new DeleteDBClusterParameterGroupCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteDBClusterParameterGroupCommandInput} for command's `input` shape. + * @see {@link DeleteDBClusterParameterGroupCommandOutput} for command's `response` shape. + * @see {@link RDSClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteDBClusterParameterGroupCommand extends $Command< DeleteDBClusterParameterGroupCommandInput, diff --git a/clients/client-rds/commands/DeleteDBClusterSnapshotCommand.ts b/clients/client-rds/commands/DeleteDBClusterSnapshotCommand.ts index 7cdab6ecfab8..b55404672aff 100644 --- a/clients/client-rds/commands/DeleteDBClusterSnapshotCommand.ts +++ b/clients/client-rds/commands/DeleteDBClusterSnapshotCommand.ts @@ -33,6 +33,20 @@ export interface DeleteDBClusterSnapshotCommandOutput extends DeleteDBClusterSna * *

This action only applies to Aurora DB clusters.

* + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { RDSClient, DeleteDBClusterSnapshotCommand } from "@aws-sdk/client-rds"; // ES Modules import + * // const { RDSClient, DeleteDBClusterSnapshotCommand } = require("@aws-sdk/client-rds"); // CommonJS import + * const client = new RDSClient(config); + * const command = new DeleteDBClusterSnapshotCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteDBClusterSnapshotCommandInput} for command's `input` shape. + * @see {@link DeleteDBClusterSnapshotCommandOutput} for command's `response` shape. + * @see {@link RDSClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteDBClusterSnapshotCommand extends $Command< DeleteDBClusterSnapshotCommandInput, diff --git a/clients/client-rds/commands/DeleteDBInstanceAutomatedBackupCommand.ts b/clients/client-rds/commands/DeleteDBInstanceAutomatedBackupCommand.ts index 508cd1283267..1a0080d11333 100644 --- a/clients/client-rds/commands/DeleteDBInstanceAutomatedBackupCommand.ts +++ b/clients/client-rds/commands/DeleteDBInstanceAutomatedBackupCommand.ts @@ -24,6 +24,20 @@ export interface DeleteDBInstanceAutomatedBackupCommandOutput /** *

Deletes automated backups using the DbiResourceId value of the source DB instance or the Amazon Resource Name (ARN) of the automated backups.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { RDSClient, DeleteDBInstanceAutomatedBackupCommand } from "@aws-sdk/client-rds"; // ES Modules import + * // const { RDSClient, DeleteDBInstanceAutomatedBackupCommand } = require("@aws-sdk/client-rds"); // CommonJS import + * const client = new RDSClient(config); + * const command = new DeleteDBInstanceAutomatedBackupCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteDBInstanceAutomatedBackupCommandInput} for command's `input` shape. + * @see {@link DeleteDBInstanceAutomatedBackupCommandOutput} for command's `response` shape. + * @see {@link RDSClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteDBInstanceAutomatedBackupCommand extends $Command< DeleteDBInstanceAutomatedBackupCommandInput, diff --git a/clients/client-rds/commands/DeleteDBInstanceCommand.ts b/clients/client-rds/commands/DeleteDBInstanceCommand.ts index 73f71c5e0298..9427a7a0cdc9 100644 --- a/clients/client-rds/commands/DeleteDBInstanceCommand.ts +++ b/clients/client-rds/commands/DeleteDBInstanceCommand.ts @@ -47,6 +47,20 @@ export interface DeleteDBInstanceCommandOutput extends DeleteDBInstanceResult, _ * 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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { RDSClient, DeleteDBInstanceCommand } from "@aws-sdk/client-rds"; // ES Modules import + * // const { RDSClient, DeleteDBInstanceCommand } = require("@aws-sdk/client-rds"); // CommonJS import + * const client = new RDSClient(config); + * const command = new DeleteDBInstanceCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteDBInstanceCommandInput} for command's `input` shape. + * @see {@link DeleteDBInstanceCommandOutput} for command's `response` shape. + * @see {@link RDSClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteDBInstanceCommand extends $Command< DeleteDBInstanceCommandInput, diff --git a/clients/client-rds/commands/DeleteDBParameterGroupCommand.ts b/clients/client-rds/commands/DeleteDBParameterGroupCommand.ts index 339663e06f27..0375e8cdb788 100644 --- a/clients/client-rds/commands/DeleteDBParameterGroupCommand.ts +++ b/clients/client-rds/commands/DeleteDBParameterGroupCommand.ts @@ -22,6 +22,20 @@ export interface DeleteDBParameterGroupCommandOutput extends __MetadataBearer {} /** *

Deletes a specified DB parameter group. The DB parameter group to be deleted can't be associated with any DB instances.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { RDSClient, DeleteDBParameterGroupCommand } from "@aws-sdk/client-rds"; // ES Modules import + * // const { RDSClient, DeleteDBParameterGroupCommand } = require("@aws-sdk/client-rds"); // CommonJS import + * const client = new RDSClient(config); + * const command = new DeleteDBParameterGroupCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteDBParameterGroupCommandInput} for command's `input` shape. + * @see {@link DeleteDBParameterGroupCommandOutput} for command's `response` shape. + * @see {@link RDSClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteDBParameterGroupCommand extends $Command< DeleteDBParameterGroupCommandInput, diff --git a/clients/client-rds/commands/DeleteDBProxyCommand.ts b/clients/client-rds/commands/DeleteDBProxyCommand.ts index d2c8145c35bc..39d1313dbcea 100644 --- a/clients/client-rds/commands/DeleteDBProxyCommand.ts +++ b/clients/client-rds/commands/DeleteDBProxyCommand.ts @@ -22,6 +22,20 @@ export interface DeleteDBProxyCommandOutput extends DeleteDBProxyResponse, __Met /** *

Deletes an existing DB proxy.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { RDSClient, DeleteDBProxyCommand } from "@aws-sdk/client-rds"; // ES Modules import + * // const { RDSClient, DeleteDBProxyCommand } = require("@aws-sdk/client-rds"); // CommonJS import + * const client = new RDSClient(config); + * const command = new DeleteDBProxyCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteDBProxyCommandInput} for command's `input` shape. + * @see {@link DeleteDBProxyCommandOutput} for command's `response` shape. + * @see {@link RDSClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteDBProxyCommand extends $Command< DeleteDBProxyCommandInput, diff --git a/clients/client-rds/commands/DeleteDBProxyEndpointCommand.ts b/clients/client-rds/commands/DeleteDBProxyEndpointCommand.ts index 72a355c54cb4..b32cf174bc10 100644 --- a/clients/client-rds/commands/DeleteDBProxyEndpointCommand.ts +++ b/clients/client-rds/commands/DeleteDBProxyEndpointCommand.ts @@ -24,6 +24,20 @@ export interface DeleteDBProxyEndpointCommandOutput extends DeleteDBProxyEndpoin *

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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { RDSClient, DeleteDBProxyEndpointCommand } from "@aws-sdk/client-rds"; // ES Modules import + * // const { RDSClient, DeleteDBProxyEndpointCommand } = require("@aws-sdk/client-rds"); // CommonJS import + * const client = new RDSClient(config); + * const command = new DeleteDBProxyEndpointCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteDBProxyEndpointCommandInput} for command's `input` shape. + * @see {@link DeleteDBProxyEndpointCommandOutput} for command's `response` shape. + * @see {@link RDSClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteDBProxyEndpointCommand extends $Command< DeleteDBProxyEndpointCommandInput, diff --git a/clients/client-rds/commands/DeleteDBSecurityGroupCommand.ts b/clients/client-rds/commands/DeleteDBSecurityGroupCommand.ts index fe0282c15faf..efdd29979ef3 100644 --- a/clients/client-rds/commands/DeleteDBSecurityGroupCommand.ts +++ b/clients/client-rds/commands/DeleteDBSecurityGroupCommand.ts @@ -25,6 +25,20 @@ export interface DeleteDBSecurityGroupCommandOutput extends __MetadataBearer {} * *

The specified DB security group must not be associated with any DB instances.

* + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { RDSClient, DeleteDBSecurityGroupCommand } from "@aws-sdk/client-rds"; // ES Modules import + * // const { RDSClient, DeleteDBSecurityGroupCommand } = require("@aws-sdk/client-rds"); // CommonJS import + * const client = new RDSClient(config); + * const command = new DeleteDBSecurityGroupCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteDBSecurityGroupCommandInput} for command's `input` shape. + * @see {@link DeleteDBSecurityGroupCommandOutput} for command's `response` shape. + * @see {@link RDSClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteDBSecurityGroupCommand extends $Command< DeleteDBSecurityGroupCommandInput, diff --git a/clients/client-rds/commands/DeleteDBSnapshotCommand.ts b/clients/client-rds/commands/DeleteDBSnapshotCommand.ts index 2e6149e2a921..164910b04877 100644 --- a/clients/client-rds/commands/DeleteDBSnapshotCommand.ts +++ b/clients/client-rds/commands/DeleteDBSnapshotCommand.ts @@ -26,6 +26,20 @@ export interface DeleteDBSnapshotCommandOutput extends DeleteDBSnapshotResult, _ * *

The DB snapshot must be in the available state to be deleted.

* + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { RDSClient, DeleteDBSnapshotCommand } from "@aws-sdk/client-rds"; // ES Modules import + * // const { RDSClient, DeleteDBSnapshotCommand } = require("@aws-sdk/client-rds"); // CommonJS import + * const client = new RDSClient(config); + * const command = new DeleteDBSnapshotCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteDBSnapshotCommandInput} for command's `input` shape. + * @see {@link DeleteDBSnapshotCommandOutput} for command's `response` shape. + * @see {@link RDSClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteDBSnapshotCommand extends $Command< DeleteDBSnapshotCommandInput, diff --git a/clients/client-rds/commands/DeleteDBSubnetGroupCommand.ts b/clients/client-rds/commands/DeleteDBSubnetGroupCommand.ts index 7ed0417a7630..63d8f22114b8 100644 --- a/clients/client-rds/commands/DeleteDBSubnetGroupCommand.ts +++ b/clients/client-rds/commands/DeleteDBSubnetGroupCommand.ts @@ -25,6 +25,20 @@ export interface DeleteDBSubnetGroupCommandOutput extends __MetadataBearer {} * *

The specified database subnet group must not be associated with any DB instances.

* + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { RDSClient, DeleteDBSubnetGroupCommand } from "@aws-sdk/client-rds"; // ES Modules import + * // const { RDSClient, DeleteDBSubnetGroupCommand } = require("@aws-sdk/client-rds"); // CommonJS import + * const client = new RDSClient(config); + * const command = new DeleteDBSubnetGroupCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteDBSubnetGroupCommandInput} for command's `input` shape. + * @see {@link DeleteDBSubnetGroupCommandOutput} for command's `response` shape. + * @see {@link RDSClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteDBSubnetGroupCommand extends $Command< DeleteDBSubnetGroupCommandInput, diff --git a/clients/client-rds/commands/DeleteEventSubscriptionCommand.ts b/clients/client-rds/commands/DeleteEventSubscriptionCommand.ts index 19d79120b643..39c257b432d3 100644 --- a/clients/client-rds/commands/DeleteEventSubscriptionCommand.ts +++ b/clients/client-rds/commands/DeleteEventSubscriptionCommand.ts @@ -22,6 +22,20 @@ export interface DeleteEventSubscriptionCommandOutput extends DeleteEventSubscri /** *

Deletes an RDS event notification subscription.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { RDSClient, DeleteEventSubscriptionCommand } from "@aws-sdk/client-rds"; // ES Modules import + * // const { RDSClient, DeleteEventSubscriptionCommand } = require("@aws-sdk/client-rds"); // CommonJS import + * const client = new RDSClient(config); + * const command = new DeleteEventSubscriptionCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteEventSubscriptionCommandInput} for command's `input` shape. + * @see {@link DeleteEventSubscriptionCommandOutput} for command's `response` shape. + * @see {@link RDSClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteEventSubscriptionCommand extends $Command< DeleteEventSubscriptionCommandInput, diff --git a/clients/client-rds/commands/DeleteGlobalClusterCommand.ts b/clients/client-rds/commands/DeleteGlobalClusterCommand.ts index 48fcf1838832..9f6d8943064e 100644 --- a/clients/client-rds/commands/DeleteGlobalClusterCommand.ts +++ b/clients/client-rds/commands/DeleteGlobalClusterCommand.ts @@ -28,6 +28,20 @@ export interface DeleteGlobalClusterCommandOutput extends DeleteGlobalClusterRes * *

This action only applies to Aurora DB clusters.

* + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { RDSClient, DeleteGlobalClusterCommand } from "@aws-sdk/client-rds"; // ES Modules import + * // const { RDSClient, DeleteGlobalClusterCommand } = require("@aws-sdk/client-rds"); // CommonJS import + * const client = new RDSClient(config); + * const command = new DeleteGlobalClusterCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteGlobalClusterCommandInput} for command's `input` shape. + * @see {@link DeleteGlobalClusterCommandOutput} for command's `response` shape. + * @see {@link RDSClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteGlobalClusterCommand extends $Command< DeleteGlobalClusterCommandInput, diff --git a/clients/client-rds/commands/DeleteInstallationMediaCommand.ts b/clients/client-rds/commands/DeleteInstallationMediaCommand.ts index b93b184dfef4..445297f4e1cf 100644 --- a/clients/client-rds/commands/DeleteInstallationMediaCommand.ts +++ b/clients/client-rds/commands/DeleteInstallationMediaCommand.ts @@ -23,6 +23,20 @@ export interface DeleteInstallationMediaCommandOutput extends InstallationMedia, /** *

Deletes the installation medium for a DB engine that requires an on-premises customer provided license, * such as Microsoft SQL Server.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { RDSClient, DeleteInstallationMediaCommand } from "@aws-sdk/client-rds"; // ES Modules import + * // const { RDSClient, DeleteInstallationMediaCommand } = require("@aws-sdk/client-rds"); // CommonJS import + * const client = new RDSClient(config); + * const command = new DeleteInstallationMediaCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteInstallationMediaCommandInput} for command's `input` shape. + * @see {@link DeleteInstallationMediaCommandOutput} for command's `response` shape. + * @see {@link RDSClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteInstallationMediaCommand extends $Command< DeleteInstallationMediaCommandInput, diff --git a/clients/client-rds/commands/DeleteOptionGroupCommand.ts b/clients/client-rds/commands/DeleteOptionGroupCommand.ts index 314015128f94..2ac534e922e4 100644 --- a/clients/client-rds/commands/DeleteOptionGroupCommand.ts +++ b/clients/client-rds/commands/DeleteOptionGroupCommand.ts @@ -22,6 +22,20 @@ export interface DeleteOptionGroupCommandOutput extends __MetadataBearer {} /** *

Deletes an existing option group.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { RDSClient, DeleteOptionGroupCommand } from "@aws-sdk/client-rds"; // ES Modules import + * // const { RDSClient, DeleteOptionGroupCommand } = require("@aws-sdk/client-rds"); // CommonJS import + * const client = new RDSClient(config); + * const command = new DeleteOptionGroupCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteOptionGroupCommandInput} for command's `input` shape. + * @see {@link DeleteOptionGroupCommandOutput} for command's `response` shape. + * @see {@link RDSClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteOptionGroupCommand extends $Command< DeleteOptionGroupCommandInput, diff --git a/clients/client-rds/commands/DeregisterDBProxyTargetsCommand.ts b/clients/client-rds/commands/DeregisterDBProxyTargetsCommand.ts index 3fc49d884f4e..d894fde1fe12 100644 --- a/clients/client-rds/commands/DeregisterDBProxyTargetsCommand.ts +++ b/clients/client-rds/commands/DeregisterDBProxyTargetsCommand.ts @@ -22,6 +22,20 @@ export interface DeregisterDBProxyTargetsCommandOutput extends DeregisterDBProxy /** *

Remove the association between one or more DBProxyTarget data structures and a DBProxyTargetGroup.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { RDSClient, DeregisterDBProxyTargetsCommand } from "@aws-sdk/client-rds"; // ES Modules import + * // const { RDSClient, DeregisterDBProxyTargetsCommand } = require("@aws-sdk/client-rds"); // CommonJS import + * const client = new RDSClient(config); + * const command = new DeregisterDBProxyTargetsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeregisterDBProxyTargetsCommandInput} for command's `input` shape. + * @see {@link DeregisterDBProxyTargetsCommandOutput} for command's `response` shape. + * @see {@link RDSClientResolvedConfig | config} for command's `input` shape. + * */ export class DeregisterDBProxyTargetsCommand extends $Command< DeregisterDBProxyTargetsCommandInput, diff --git a/clients/client-rds/commands/DescribeAccountAttributesCommand.ts b/clients/client-rds/commands/DescribeAccountAttributesCommand.ts index 8b8d55b65339..ceb259e328a8 100644 --- a/clients/client-rds/commands/DescribeAccountAttributesCommand.ts +++ b/clients/client-rds/commands/DescribeAccountAttributesCommand.ts @@ -23,6 +23,20 @@ export interface DescribeAccountAttributesCommandOutput extends AccountAttribute /** *

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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { RDSClient, DescribeAccountAttributesCommand } from "@aws-sdk/client-rds"; // ES Modules import + * // const { RDSClient, DescribeAccountAttributesCommand } = require("@aws-sdk/client-rds"); // CommonJS import + * const client = new RDSClient(config); + * const command = new DescribeAccountAttributesCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeAccountAttributesCommandInput} for command's `input` shape. + * @see {@link DescribeAccountAttributesCommandOutput} for command's `response` shape. + * @see {@link RDSClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeAccountAttributesCommand extends $Command< DescribeAccountAttributesCommandInput, diff --git a/clients/client-rds/commands/DescribeCertificatesCommand.ts b/clients/client-rds/commands/DescribeCertificatesCommand.ts index 91fbe909e27f..9f7db86e6262 100644 --- a/clients/client-rds/commands/DescribeCertificatesCommand.ts +++ b/clients/client-rds/commands/DescribeCertificatesCommand.ts @@ -22,6 +22,20 @@ export interface DescribeCertificatesCommandOutput extends CertificateMessage, _ /** *

Lists the set of CA certificates provided by Amazon RDS for this AWS account.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { RDSClient, DescribeCertificatesCommand } from "@aws-sdk/client-rds"; // ES Modules import + * // const { RDSClient, DescribeCertificatesCommand } = require("@aws-sdk/client-rds"); // CommonJS import + * const client = new RDSClient(config); + * const command = new DescribeCertificatesCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeCertificatesCommandInput} for command's `input` shape. + * @see {@link DescribeCertificatesCommandOutput} for command's `response` shape. + * @see {@link RDSClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeCertificatesCommand extends $Command< DescribeCertificatesCommandInput, diff --git a/clients/client-rds/commands/DescribeCustomAvailabilityZonesCommand.ts b/clients/client-rds/commands/DescribeCustomAvailabilityZonesCommand.ts index dea456218431..d6a012d05389 100644 --- a/clients/client-rds/commands/DescribeCustomAvailabilityZonesCommand.ts +++ b/clients/client-rds/commands/DescribeCustomAvailabilityZonesCommand.ts @@ -27,6 +27,20 @@ export interface DescribeCustomAvailabilityZonesCommandOutput extends CustomAvai * * RDS on VMware User Guide. *

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { RDSClient, DescribeCustomAvailabilityZonesCommand } from "@aws-sdk/client-rds"; // ES Modules import + * // const { RDSClient, DescribeCustomAvailabilityZonesCommand } = require("@aws-sdk/client-rds"); // CommonJS import + * const client = new RDSClient(config); + * const command = new DescribeCustomAvailabilityZonesCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeCustomAvailabilityZonesCommandInput} for command's `input` shape. + * @see {@link DescribeCustomAvailabilityZonesCommandOutput} for command's `response` shape. + * @see {@link RDSClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeCustomAvailabilityZonesCommand extends $Command< DescribeCustomAvailabilityZonesCommandInput, diff --git a/clients/client-rds/commands/DescribeDBClusterBacktracksCommand.ts b/clients/client-rds/commands/DescribeDBClusterBacktracksCommand.ts index 3856d009cb70..39f90de05c1a 100644 --- a/clients/client-rds/commands/DescribeDBClusterBacktracksCommand.ts +++ b/clients/client-rds/commands/DescribeDBClusterBacktracksCommand.ts @@ -29,6 +29,20 @@ export interface DescribeDBClusterBacktracksCommandOutput extends DBClusterBackt * *

This action only applies to Aurora MySQL DB clusters.

* + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { RDSClient, DescribeDBClusterBacktracksCommand } from "@aws-sdk/client-rds"; // ES Modules import + * // const { RDSClient, DescribeDBClusterBacktracksCommand } = require("@aws-sdk/client-rds"); // CommonJS import + * const client = new RDSClient(config); + * const command = new DescribeDBClusterBacktracksCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeDBClusterBacktracksCommandInput} for command's `input` shape. + * @see {@link DescribeDBClusterBacktracksCommandOutput} for command's `response` shape. + * @see {@link RDSClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeDBClusterBacktracksCommand extends $Command< DescribeDBClusterBacktracksCommandInput, diff --git a/clients/client-rds/commands/DescribeDBClusterEndpointsCommand.ts b/clients/client-rds/commands/DescribeDBClusterEndpointsCommand.ts index ac0f523474de..984ae599479c 100644 --- a/clients/client-rds/commands/DescribeDBClusterEndpointsCommand.ts +++ b/clients/client-rds/commands/DescribeDBClusterEndpointsCommand.ts @@ -25,6 +25,20 @@ export interface DescribeDBClusterEndpointsCommandOutput extends DBClusterEndpoi * *

This action only applies to Aurora DB clusters.

* + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { RDSClient, DescribeDBClusterEndpointsCommand } from "@aws-sdk/client-rds"; // ES Modules import + * // const { RDSClient, DescribeDBClusterEndpointsCommand } = require("@aws-sdk/client-rds"); // CommonJS import + * const client = new RDSClient(config); + * const command = new DescribeDBClusterEndpointsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeDBClusterEndpointsCommandInput} for command's `input` shape. + * @see {@link DescribeDBClusterEndpointsCommandOutput} for command's `response` shape. + * @see {@link RDSClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeDBClusterEndpointsCommand extends $Command< DescribeDBClusterEndpointsCommandInput, diff --git a/clients/client-rds/commands/DescribeDBClusterParameterGroupsCommand.ts b/clients/client-rds/commands/DescribeDBClusterParameterGroupsCommand.ts index 5c79620af725..a9c906a1aa3f 100644 --- a/clients/client-rds/commands/DescribeDBClusterParameterGroupsCommand.ts +++ b/clients/client-rds/commands/DescribeDBClusterParameterGroupsCommand.ts @@ -35,6 +35,20 @@ export interface DescribeDBClusterParameterGroupsCommandOutput * *

This action only applies to Aurora DB clusters.

* + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { RDSClient, DescribeDBClusterParameterGroupsCommand } from "@aws-sdk/client-rds"; // ES Modules import + * // const { RDSClient, DescribeDBClusterParameterGroupsCommand } = require("@aws-sdk/client-rds"); // CommonJS import + * const client = new RDSClient(config); + * const command = new DescribeDBClusterParameterGroupsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeDBClusterParameterGroupsCommandInput} for command's `input` shape. + * @see {@link DescribeDBClusterParameterGroupsCommandOutput} for command's `response` shape. + * @see {@link RDSClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeDBClusterParameterGroupsCommand extends $Command< DescribeDBClusterParameterGroupsCommandInput, diff --git a/clients/client-rds/commands/DescribeDBClusterParametersCommand.ts b/clients/client-rds/commands/DescribeDBClusterParametersCommand.ts index e0b92514af6b..0081db5862d8 100644 --- a/clients/client-rds/commands/DescribeDBClusterParametersCommand.ts +++ b/clients/client-rds/commands/DescribeDBClusterParametersCommand.ts @@ -29,6 +29,20 @@ export interface DescribeDBClusterParametersCommandOutput extends DBClusterParam * *

This action only applies to Aurora DB clusters.

* + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { RDSClient, DescribeDBClusterParametersCommand } from "@aws-sdk/client-rds"; // ES Modules import + * // const { RDSClient, DescribeDBClusterParametersCommand } = require("@aws-sdk/client-rds"); // CommonJS import + * const client = new RDSClient(config); + * const command = new DescribeDBClusterParametersCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeDBClusterParametersCommandInput} for command's `input` shape. + * @see {@link DescribeDBClusterParametersCommandOutput} for command's `response` shape. + * @see {@link RDSClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeDBClusterParametersCommand extends $Command< DescribeDBClusterParametersCommandInput, diff --git a/clients/client-rds/commands/DescribeDBClusterSnapshotAttributesCommand.ts b/clients/client-rds/commands/DescribeDBClusterSnapshotAttributesCommand.ts index ddf9a0fa52e2..1d9d3ea0c5d3 100644 --- a/clients/client-rds/commands/DescribeDBClusterSnapshotAttributesCommand.ts +++ b/clients/client-rds/commands/DescribeDBClusterSnapshotAttributesCommand.ts @@ -37,6 +37,20 @@ export interface DescribeDBClusterSnapshotAttributesCommandOutput * *

This action only applies to Aurora DB clusters.

* + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { RDSClient, DescribeDBClusterSnapshotAttributesCommand } from "@aws-sdk/client-rds"; // ES Modules import + * // const { RDSClient, DescribeDBClusterSnapshotAttributesCommand } = require("@aws-sdk/client-rds"); // CommonJS import + * const client = new RDSClient(config); + * const command = new DescribeDBClusterSnapshotAttributesCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeDBClusterSnapshotAttributesCommandInput} for command's `input` shape. + * @see {@link DescribeDBClusterSnapshotAttributesCommandOutput} for command's `response` shape. + * @see {@link RDSClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeDBClusterSnapshotAttributesCommand extends $Command< DescribeDBClusterSnapshotAttributesCommandInput, diff --git a/clients/client-rds/commands/DescribeDBClusterSnapshotsCommand.ts b/clients/client-rds/commands/DescribeDBClusterSnapshotsCommand.ts index 000ffeaa9d76..09e683a9239a 100644 --- a/clients/client-rds/commands/DescribeDBClusterSnapshotsCommand.ts +++ b/clients/client-rds/commands/DescribeDBClusterSnapshotsCommand.ts @@ -29,6 +29,20 @@ export interface DescribeDBClusterSnapshotsCommandOutput extends DBClusterSnapsh * *

This action only applies to Aurora DB clusters.

* + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { RDSClient, DescribeDBClusterSnapshotsCommand } from "@aws-sdk/client-rds"; // ES Modules import + * // const { RDSClient, DescribeDBClusterSnapshotsCommand } = require("@aws-sdk/client-rds"); // CommonJS import + * const client = new RDSClient(config); + * const command = new DescribeDBClusterSnapshotsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeDBClusterSnapshotsCommandInput} for command's `input` shape. + * @see {@link DescribeDBClusterSnapshotsCommandOutput} for command's `response` shape. + * @see {@link RDSClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeDBClusterSnapshotsCommand extends $Command< DescribeDBClusterSnapshotsCommandInput, diff --git a/clients/client-rds/commands/DescribeDBClustersCommand.ts b/clients/client-rds/commands/DescribeDBClustersCommand.ts index df1189cb3b19..9536183aa144 100644 --- a/clients/client-rds/commands/DescribeDBClustersCommand.ts +++ b/clients/client-rds/commands/DescribeDBClustersCommand.ts @@ -29,6 +29,20 @@ export interface DescribeDBClustersCommandOutput extends DBClusterMessage, __Met * *

This operation can also return information for Amazon Neptune DB instances and Amazon DocumentDB instances.

* + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { RDSClient, DescribeDBClustersCommand } from "@aws-sdk/client-rds"; // ES Modules import + * // const { RDSClient, DescribeDBClustersCommand } = require("@aws-sdk/client-rds"); // CommonJS import + * const client = new RDSClient(config); + * const command = new DescribeDBClustersCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeDBClustersCommandInput} for command's `input` shape. + * @see {@link DescribeDBClustersCommandOutput} for command's `response` shape. + * @see {@link RDSClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeDBClustersCommand extends $Command< DescribeDBClustersCommandInput, diff --git a/clients/client-rds/commands/DescribeDBEngineVersionsCommand.ts b/clients/client-rds/commands/DescribeDBEngineVersionsCommand.ts index 7139ce2d9f12..18b7d0b41d5b 100644 --- a/clients/client-rds/commands/DescribeDBEngineVersionsCommand.ts +++ b/clients/client-rds/commands/DescribeDBEngineVersionsCommand.ts @@ -22,6 +22,20 @@ export interface DescribeDBEngineVersionsCommandOutput extends DBEngineVersionMe /** *

Returns a list of the available DB engines.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { RDSClient, DescribeDBEngineVersionsCommand } from "@aws-sdk/client-rds"; // ES Modules import + * // const { RDSClient, DescribeDBEngineVersionsCommand } = require("@aws-sdk/client-rds"); // CommonJS import + * const client = new RDSClient(config); + * const command = new DescribeDBEngineVersionsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeDBEngineVersionsCommandInput} for command's `input` shape. + * @see {@link DescribeDBEngineVersionsCommandOutput} for command's `response` shape. + * @see {@link RDSClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeDBEngineVersionsCommand extends $Command< DescribeDBEngineVersionsCommandInput, diff --git a/clients/client-rds/commands/DescribeDBInstanceAutomatedBackupsCommand.ts b/clients/client-rds/commands/DescribeDBInstanceAutomatedBackupsCommand.ts index 6f6a9e42caa3..f5f79b566120 100644 --- a/clients/client-rds/commands/DescribeDBInstanceAutomatedBackupsCommand.ts +++ b/clients/client-rds/commands/DescribeDBInstanceAutomatedBackupsCommand.ts @@ -30,6 +30,20 @@ export interface DescribeDBInstanceAutomatedBackupsCommandOutput * DescribeDBInstanceAutomatedBackups and * DescribeDBInstances operations.

*

All parameters are optional.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { RDSClient, DescribeDBInstanceAutomatedBackupsCommand } from "@aws-sdk/client-rds"; // ES Modules import + * // const { RDSClient, DescribeDBInstanceAutomatedBackupsCommand } = require("@aws-sdk/client-rds"); // CommonJS import + * const client = new RDSClient(config); + * const command = new DescribeDBInstanceAutomatedBackupsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeDBInstanceAutomatedBackupsCommandInput} for command's `input` shape. + * @see {@link DescribeDBInstanceAutomatedBackupsCommandOutput} for command's `response` shape. + * @see {@link RDSClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeDBInstanceAutomatedBackupsCommand extends $Command< DescribeDBInstanceAutomatedBackupsCommandInput, diff --git a/clients/client-rds/commands/DescribeDBInstancesCommand.ts b/clients/client-rds/commands/DescribeDBInstancesCommand.ts index ac599af99a09..c6bb703bf594 100644 --- a/clients/client-rds/commands/DescribeDBInstancesCommand.ts +++ b/clients/client-rds/commands/DescribeDBInstancesCommand.ts @@ -25,6 +25,20 @@ export interface DescribeDBInstancesCommandOutput extends DBInstanceMessage, __M * *

This operation can also return information for Amazon Neptune DB instances and Amazon DocumentDB instances.

* + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { RDSClient, DescribeDBInstancesCommand } from "@aws-sdk/client-rds"; // ES Modules import + * // const { RDSClient, DescribeDBInstancesCommand } = require("@aws-sdk/client-rds"); // CommonJS import + * const client = new RDSClient(config); + * const command = new DescribeDBInstancesCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeDBInstancesCommandInput} for command's `input` shape. + * @see {@link DescribeDBInstancesCommandOutput} for command's `response` shape. + * @see {@link RDSClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeDBInstancesCommand extends $Command< DescribeDBInstancesCommandInput, diff --git a/clients/client-rds/commands/DescribeDBLogFilesCommand.ts b/clients/client-rds/commands/DescribeDBLogFilesCommand.ts index c526367ac264..e8a562f612fd 100644 --- a/clients/client-rds/commands/DescribeDBLogFilesCommand.ts +++ b/clients/client-rds/commands/DescribeDBLogFilesCommand.ts @@ -22,6 +22,20 @@ export interface DescribeDBLogFilesCommandOutput extends DescribeDBLogFilesRespo /** *

Returns a list of DB log files for the DB instance.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { RDSClient, DescribeDBLogFilesCommand } from "@aws-sdk/client-rds"; // ES Modules import + * // const { RDSClient, DescribeDBLogFilesCommand } = require("@aws-sdk/client-rds"); // CommonJS import + * const client = new RDSClient(config); + * const command = new DescribeDBLogFilesCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeDBLogFilesCommandInput} for command's `input` shape. + * @see {@link DescribeDBLogFilesCommandOutput} for command's `response` shape. + * @see {@link RDSClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeDBLogFilesCommand extends $Command< DescribeDBLogFilesCommandInput, diff --git a/clients/client-rds/commands/DescribeDBParameterGroupsCommand.ts b/clients/client-rds/commands/DescribeDBParameterGroupsCommand.ts index bdb85cc76fe7..82fd696f4ce9 100644 --- a/clients/client-rds/commands/DescribeDBParameterGroupsCommand.ts +++ b/clients/client-rds/commands/DescribeDBParameterGroupsCommand.ts @@ -25,6 +25,20 @@ export interface DescribeDBParameterGroupsCommandOutput extends DBParameterGroup * Returns a list of DBParameterGroup descriptions. If a DBParameterGroupName is specified, * the list will contain only the description of the specified DB parameter group. *

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { RDSClient, DescribeDBParameterGroupsCommand } from "@aws-sdk/client-rds"; // ES Modules import + * // const { RDSClient, DescribeDBParameterGroupsCommand } = require("@aws-sdk/client-rds"); // CommonJS import + * const client = new RDSClient(config); + * const command = new DescribeDBParameterGroupsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeDBParameterGroupsCommandInput} for command's `input` shape. + * @see {@link DescribeDBParameterGroupsCommandOutput} for command's `response` shape. + * @see {@link RDSClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeDBParameterGroupsCommand extends $Command< DescribeDBParameterGroupsCommandInput, diff --git a/clients/client-rds/commands/DescribeDBParametersCommand.ts b/clients/client-rds/commands/DescribeDBParametersCommand.ts index 55fcc0480f34..df9193bba5f5 100644 --- a/clients/client-rds/commands/DescribeDBParametersCommand.ts +++ b/clients/client-rds/commands/DescribeDBParametersCommand.ts @@ -22,6 +22,20 @@ export interface DescribeDBParametersCommandOutput extends DBParameterGroupDetai /** *

Returns the detailed parameter list for a particular DB parameter group.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { RDSClient, DescribeDBParametersCommand } from "@aws-sdk/client-rds"; // ES Modules import + * // const { RDSClient, DescribeDBParametersCommand } = require("@aws-sdk/client-rds"); // CommonJS import + * const client = new RDSClient(config); + * const command = new DescribeDBParametersCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeDBParametersCommandInput} for command's `input` shape. + * @see {@link DescribeDBParametersCommandOutput} for command's `response` shape. + * @see {@link RDSClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeDBParametersCommand extends $Command< DescribeDBParametersCommandInput, diff --git a/clients/client-rds/commands/DescribeDBProxiesCommand.ts b/clients/client-rds/commands/DescribeDBProxiesCommand.ts index e9f1b6cd3812..a8c84b30f300 100644 --- a/clients/client-rds/commands/DescribeDBProxiesCommand.ts +++ b/clients/client-rds/commands/DescribeDBProxiesCommand.ts @@ -22,6 +22,20 @@ export interface DescribeDBProxiesCommandOutput extends DescribeDBProxiesRespons /** *

Returns information about DB proxies.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { RDSClient, DescribeDBProxiesCommand } from "@aws-sdk/client-rds"; // ES Modules import + * // const { RDSClient, DescribeDBProxiesCommand } = require("@aws-sdk/client-rds"); // CommonJS import + * const client = new RDSClient(config); + * const command = new DescribeDBProxiesCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeDBProxiesCommandInput} for command's `input` shape. + * @see {@link DescribeDBProxiesCommandOutput} for command's `response` shape. + * @see {@link RDSClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeDBProxiesCommand extends $Command< DescribeDBProxiesCommandInput, diff --git a/clients/client-rds/commands/DescribeDBProxyEndpointsCommand.ts b/clients/client-rds/commands/DescribeDBProxyEndpointsCommand.ts index 7cf861b0e02b..9310019fb432 100644 --- a/clients/client-rds/commands/DescribeDBProxyEndpointsCommand.ts +++ b/clients/client-rds/commands/DescribeDBProxyEndpointsCommand.ts @@ -22,6 +22,20 @@ export interface DescribeDBProxyEndpointsCommandOutput extends DescribeDBProxyEn /** *

Returns information about DB proxy endpoints.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { RDSClient, DescribeDBProxyEndpointsCommand } from "@aws-sdk/client-rds"; // ES Modules import + * // const { RDSClient, DescribeDBProxyEndpointsCommand } = require("@aws-sdk/client-rds"); // CommonJS import + * const client = new RDSClient(config); + * const command = new DescribeDBProxyEndpointsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeDBProxyEndpointsCommandInput} for command's `input` shape. + * @see {@link DescribeDBProxyEndpointsCommandOutput} for command's `response` shape. + * @see {@link RDSClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeDBProxyEndpointsCommand extends $Command< DescribeDBProxyEndpointsCommandInput, diff --git a/clients/client-rds/commands/DescribeDBProxyTargetGroupsCommand.ts b/clients/client-rds/commands/DescribeDBProxyTargetGroupsCommand.ts index 573b595c129e..ade27b623949 100644 --- a/clients/client-rds/commands/DescribeDBProxyTargetGroupsCommand.ts +++ b/clients/client-rds/commands/DescribeDBProxyTargetGroupsCommand.ts @@ -24,6 +24,20 @@ export interface DescribeDBProxyTargetGroupsCommandOutput /** *

Returns information about DB proxy target groups, represented by DBProxyTargetGroup data structures.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { RDSClient, DescribeDBProxyTargetGroupsCommand } from "@aws-sdk/client-rds"; // ES Modules import + * // const { RDSClient, DescribeDBProxyTargetGroupsCommand } = require("@aws-sdk/client-rds"); // CommonJS import + * const client = new RDSClient(config); + * const command = new DescribeDBProxyTargetGroupsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeDBProxyTargetGroupsCommandInput} for command's `input` shape. + * @see {@link DescribeDBProxyTargetGroupsCommandOutput} for command's `response` shape. + * @see {@link RDSClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeDBProxyTargetGroupsCommand extends $Command< DescribeDBProxyTargetGroupsCommandInput, diff --git a/clients/client-rds/commands/DescribeDBProxyTargetsCommand.ts b/clients/client-rds/commands/DescribeDBProxyTargetsCommand.ts index 29817f6e570e..2982625e6c75 100644 --- a/clients/client-rds/commands/DescribeDBProxyTargetsCommand.ts +++ b/clients/client-rds/commands/DescribeDBProxyTargetsCommand.ts @@ -22,6 +22,20 @@ export interface DescribeDBProxyTargetsCommandOutput extends DescribeDBProxyTarg /** *

Returns information about DBProxyTarget objects. This API supports pagination.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { RDSClient, DescribeDBProxyTargetsCommand } from "@aws-sdk/client-rds"; // ES Modules import + * // const { RDSClient, DescribeDBProxyTargetsCommand } = require("@aws-sdk/client-rds"); // CommonJS import + * const client = new RDSClient(config); + * const command = new DescribeDBProxyTargetsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeDBProxyTargetsCommandInput} for command's `input` shape. + * @see {@link DescribeDBProxyTargetsCommandOutput} for command's `response` shape. + * @see {@link RDSClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeDBProxyTargetsCommand extends $Command< DescribeDBProxyTargetsCommandInput, diff --git a/clients/client-rds/commands/DescribeDBSecurityGroupsCommand.ts b/clients/client-rds/commands/DescribeDBSecurityGroupsCommand.ts index f5ea33ad613f..09d66577737b 100644 --- a/clients/client-rds/commands/DescribeDBSecurityGroupsCommand.ts +++ b/clients/client-rds/commands/DescribeDBSecurityGroupsCommand.ts @@ -25,6 +25,20 @@ export interface DescribeDBSecurityGroupsCommandOutput extends DBSecurityGroupMe * Returns a list of DBSecurityGroup descriptions. If a DBSecurityGroupName is specified, * the list will contain only the descriptions of the specified DB security group. *

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { RDSClient, DescribeDBSecurityGroupsCommand } from "@aws-sdk/client-rds"; // ES Modules import + * // const { RDSClient, DescribeDBSecurityGroupsCommand } = require("@aws-sdk/client-rds"); // CommonJS import + * const client = new RDSClient(config); + * const command = new DescribeDBSecurityGroupsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeDBSecurityGroupsCommandInput} for command's `input` shape. + * @see {@link DescribeDBSecurityGroupsCommandOutput} for command's `response` shape. + * @see {@link RDSClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeDBSecurityGroupsCommand extends $Command< DescribeDBSecurityGroupsCommandInput, diff --git a/clients/client-rds/commands/DescribeDBSnapshotAttributesCommand.ts b/clients/client-rds/commands/DescribeDBSnapshotAttributesCommand.ts index c5c708be1a97..5ed0dcb2516e 100644 --- a/clients/client-rds/commands/DescribeDBSnapshotAttributesCommand.ts +++ b/clients/client-rds/commands/DescribeDBSnapshotAttributesCommand.ts @@ -31,6 +31,20 @@ export interface DescribeDBSnapshotAttributesCommandOutput * can be copied or restored by all AWS accounts.

*

To add or remove access for an AWS account to copy or restore a manual DB snapshot, or to make the * manual DB snapshot public or private, use the ModifyDBSnapshotAttribute API action.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { RDSClient, DescribeDBSnapshotAttributesCommand } from "@aws-sdk/client-rds"; // ES Modules import + * // const { RDSClient, DescribeDBSnapshotAttributesCommand } = require("@aws-sdk/client-rds"); // CommonJS import + * const client = new RDSClient(config); + * const command = new DescribeDBSnapshotAttributesCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeDBSnapshotAttributesCommandInput} for command's `input` shape. + * @see {@link DescribeDBSnapshotAttributesCommandOutput} for command's `response` shape. + * @see {@link RDSClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeDBSnapshotAttributesCommand extends $Command< DescribeDBSnapshotAttributesCommandInput, diff --git a/clients/client-rds/commands/DescribeDBSnapshotsCommand.ts b/clients/client-rds/commands/DescribeDBSnapshotsCommand.ts index de776698fc50..9aa7cf713a8e 100644 --- a/clients/client-rds/commands/DescribeDBSnapshotsCommand.ts +++ b/clients/client-rds/commands/DescribeDBSnapshotsCommand.ts @@ -22,6 +22,20 @@ export interface DescribeDBSnapshotsCommandOutput extends DBSnapshotMessage, __M /** *

Returns information about DB snapshots. This API action supports pagination.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { RDSClient, DescribeDBSnapshotsCommand } from "@aws-sdk/client-rds"; // ES Modules import + * // const { RDSClient, DescribeDBSnapshotsCommand } = require("@aws-sdk/client-rds"); // CommonJS import + * const client = new RDSClient(config); + * const command = new DescribeDBSnapshotsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeDBSnapshotsCommandInput} for command's `input` shape. + * @see {@link DescribeDBSnapshotsCommandOutput} for command's `response` shape. + * @see {@link RDSClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeDBSnapshotsCommand extends $Command< DescribeDBSnapshotsCommandInput, diff --git a/clients/client-rds/commands/DescribeDBSubnetGroupsCommand.ts b/clients/client-rds/commands/DescribeDBSubnetGroupsCommand.ts index 49170751851d..21d0c1956b16 100644 --- a/clients/client-rds/commands/DescribeDBSubnetGroupsCommand.ts +++ b/clients/client-rds/commands/DescribeDBSubnetGroupsCommand.ts @@ -25,6 +25,20 @@ export interface DescribeDBSubnetGroupsCommandOutput extends DBSubnetGroupMessag *

For an overview of CIDR ranges, go to the * Wikipedia Tutorial. *

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { RDSClient, DescribeDBSubnetGroupsCommand } from "@aws-sdk/client-rds"; // ES Modules import + * // const { RDSClient, DescribeDBSubnetGroupsCommand } = require("@aws-sdk/client-rds"); // CommonJS import + * const client = new RDSClient(config); + * const command = new DescribeDBSubnetGroupsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeDBSubnetGroupsCommandInput} for command's `input` shape. + * @see {@link DescribeDBSubnetGroupsCommandOutput} for command's `response` shape. + * @see {@link RDSClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeDBSubnetGroupsCommand extends $Command< DescribeDBSubnetGroupsCommandInput, diff --git a/clients/client-rds/commands/DescribeEngineDefaultClusterParametersCommand.ts b/clients/client-rds/commands/DescribeEngineDefaultClusterParametersCommand.ts index 676b4bdc5365..db870f593169 100644 --- a/clients/client-rds/commands/DescribeEngineDefaultClusterParametersCommand.ts +++ b/clients/client-rds/commands/DescribeEngineDefaultClusterParametersCommand.ts @@ -32,6 +32,20 @@ export interface DescribeEngineDefaultClusterParametersCommandOutput * * What Is Amazon Aurora? in the Amazon Aurora User Guide. *

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { RDSClient, DescribeEngineDefaultClusterParametersCommand } from "@aws-sdk/client-rds"; // ES Modules import + * // const { RDSClient, DescribeEngineDefaultClusterParametersCommand } = require("@aws-sdk/client-rds"); // CommonJS import + * const client = new RDSClient(config); + * const command = new DescribeEngineDefaultClusterParametersCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeEngineDefaultClusterParametersCommandInput} for command's `input` shape. + * @see {@link DescribeEngineDefaultClusterParametersCommandOutput} for command's `response` shape. + * @see {@link RDSClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeEngineDefaultClusterParametersCommand extends $Command< DescribeEngineDefaultClusterParametersCommandInput, diff --git a/clients/client-rds/commands/DescribeEngineDefaultParametersCommand.ts b/clients/client-rds/commands/DescribeEngineDefaultParametersCommand.ts index 962a5b358a45..17a399dea5a6 100644 --- a/clients/client-rds/commands/DescribeEngineDefaultParametersCommand.ts +++ b/clients/client-rds/commands/DescribeEngineDefaultParametersCommand.ts @@ -24,6 +24,20 @@ export interface DescribeEngineDefaultParametersCommandOutput /** *

Returns the default engine and system parameter information for the specified database engine.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { RDSClient, DescribeEngineDefaultParametersCommand } from "@aws-sdk/client-rds"; // ES Modules import + * // const { RDSClient, DescribeEngineDefaultParametersCommand } = require("@aws-sdk/client-rds"); // CommonJS import + * const client = new RDSClient(config); + * const command = new DescribeEngineDefaultParametersCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeEngineDefaultParametersCommandInput} for command's `input` shape. + * @see {@link DescribeEngineDefaultParametersCommandOutput} for command's `response` shape. + * @see {@link RDSClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeEngineDefaultParametersCommand extends $Command< DescribeEngineDefaultParametersCommandInput, diff --git a/clients/client-rds/commands/DescribeEventCategoriesCommand.ts b/clients/client-rds/commands/DescribeEventCategoriesCommand.ts index 25e3bd125c4a..e29c5d1049c9 100644 --- a/clients/client-rds/commands/DescribeEventCategoriesCommand.ts +++ b/clients/client-rds/commands/DescribeEventCategoriesCommand.ts @@ -26,6 +26,20 @@ export interface DescribeEventCategoriesCommandOutput extends EventCategoriesMes * in * Events in the Amazon RDS User Guide. *

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { RDSClient, DescribeEventCategoriesCommand } from "@aws-sdk/client-rds"; // ES Modules import + * // const { RDSClient, DescribeEventCategoriesCommand } = require("@aws-sdk/client-rds"); // CommonJS import + * const client = new RDSClient(config); + * const command = new DescribeEventCategoriesCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeEventCategoriesCommandInput} for command's `input` shape. + * @see {@link DescribeEventCategoriesCommandOutput} for command's `response` shape. + * @see {@link RDSClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeEventCategoriesCommand extends $Command< DescribeEventCategoriesCommandInput, diff --git a/clients/client-rds/commands/DescribeEventSubscriptionsCommand.ts b/clients/client-rds/commands/DescribeEventSubscriptionsCommand.ts index aaa023bf422f..b86aa8c060d5 100644 --- a/clients/client-rds/commands/DescribeEventSubscriptionsCommand.ts +++ b/clients/client-rds/commands/DescribeEventSubscriptionsCommand.ts @@ -24,6 +24,20 @@ export interface DescribeEventSubscriptionsCommandOutput extends EventSubscripti *

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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { RDSClient, DescribeEventSubscriptionsCommand } from "@aws-sdk/client-rds"; // ES Modules import + * // const { RDSClient, DescribeEventSubscriptionsCommand } = require("@aws-sdk/client-rds"); // CommonJS import + * const client = new RDSClient(config); + * const command = new DescribeEventSubscriptionsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeEventSubscriptionsCommandInput} for command's `input` shape. + * @see {@link DescribeEventSubscriptionsCommandOutput} for command's `response` shape. + * @see {@link RDSClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeEventSubscriptionsCommand extends $Command< DescribeEventSubscriptionsCommandInput, diff --git a/clients/client-rds/commands/DescribeEventsCommand.ts b/clients/client-rds/commands/DescribeEventsCommand.ts index 524eb90dba28..f7b6b3df1e64 100644 --- a/clients/client-rds/commands/DescribeEventsCommand.ts +++ b/clients/client-rds/commands/DescribeEventsCommand.ts @@ -27,6 +27,20 @@ export interface DescribeEventsCommandOutput extends EventsMessage, __MetadataBe * *

By default, the past hour of events are returned.

* + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { RDSClient, DescribeEventsCommand } from "@aws-sdk/client-rds"; // ES Modules import + * // const { RDSClient, DescribeEventsCommand } = require("@aws-sdk/client-rds"); // CommonJS import + * const client = new RDSClient(config); + * const command = new DescribeEventsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeEventsCommandInput} for command's `input` shape. + * @see {@link DescribeEventsCommandOutput} for command's `response` shape. + * @see {@link RDSClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeEventsCommand extends $Command< DescribeEventsCommandInput, diff --git a/clients/client-rds/commands/DescribeExportTasksCommand.ts b/clients/client-rds/commands/DescribeExportTasksCommand.ts index 2e07770a3a98..6de1b0f89f85 100644 --- a/clients/client-rds/commands/DescribeExportTasksCommand.ts +++ b/clients/client-rds/commands/DescribeExportTasksCommand.ts @@ -23,6 +23,20 @@ export interface DescribeExportTasksCommandOutput extends ExportTasksMessage, __ /** *

Returns information about a snapshot export to Amazon S3. This API operation supports * pagination.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { RDSClient, DescribeExportTasksCommand } from "@aws-sdk/client-rds"; // ES Modules import + * // const { RDSClient, DescribeExportTasksCommand } = require("@aws-sdk/client-rds"); // CommonJS import + * const client = new RDSClient(config); + * const command = new DescribeExportTasksCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeExportTasksCommandInput} for command's `input` shape. + * @see {@link DescribeExportTasksCommandOutput} for command's `response` shape. + * @see {@link RDSClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeExportTasksCommand extends $Command< DescribeExportTasksCommandInput, diff --git a/clients/client-rds/commands/DescribeGlobalClustersCommand.ts b/clients/client-rds/commands/DescribeGlobalClustersCommand.ts index 31a75191c650..b1bd07aad194 100644 --- a/clients/client-rds/commands/DescribeGlobalClustersCommand.ts +++ b/clients/client-rds/commands/DescribeGlobalClustersCommand.ts @@ -31,6 +31,20 @@ export interface DescribeGlobalClustersCommandOutput extends GlobalClustersMessa * *

This action only applies to Aurora DB clusters.

* + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { RDSClient, DescribeGlobalClustersCommand } from "@aws-sdk/client-rds"; // ES Modules import + * // const { RDSClient, DescribeGlobalClustersCommand } = require("@aws-sdk/client-rds"); // CommonJS import + * const client = new RDSClient(config); + * const command = new DescribeGlobalClustersCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeGlobalClustersCommandInput} for command's `input` shape. + * @see {@link DescribeGlobalClustersCommandOutput} for command's `response` shape. + * @see {@link RDSClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeGlobalClustersCommand extends $Command< DescribeGlobalClustersCommandInput, diff --git a/clients/client-rds/commands/DescribeInstallationMediaCommand.ts b/clients/client-rds/commands/DescribeInstallationMediaCommand.ts index f0379e4c0755..f7244d83f960 100644 --- a/clients/client-rds/commands/DescribeInstallationMediaCommand.ts +++ b/clients/client-rds/commands/DescribeInstallationMediaCommand.ts @@ -23,6 +23,20 @@ export interface DescribeInstallationMediaCommandOutput extends InstallationMedi /** *

Describes the available installation media for a DB engine that requires an * on-premises customer provided license, such as Microsoft SQL Server.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { RDSClient, DescribeInstallationMediaCommand } from "@aws-sdk/client-rds"; // ES Modules import + * // const { RDSClient, DescribeInstallationMediaCommand } = require("@aws-sdk/client-rds"); // CommonJS import + * const client = new RDSClient(config); + * const command = new DescribeInstallationMediaCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeInstallationMediaCommandInput} for command's `input` shape. + * @see {@link DescribeInstallationMediaCommandOutput} for command's `response` shape. + * @see {@link RDSClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeInstallationMediaCommand extends $Command< DescribeInstallationMediaCommandInput, diff --git a/clients/client-rds/commands/DescribeOptionGroupOptionsCommand.ts b/clients/client-rds/commands/DescribeOptionGroupOptionsCommand.ts index 0149cba5d6ec..2565b5f4aaf8 100644 --- a/clients/client-rds/commands/DescribeOptionGroupOptionsCommand.ts +++ b/clients/client-rds/commands/DescribeOptionGroupOptionsCommand.ts @@ -22,6 +22,20 @@ export interface DescribeOptionGroupOptionsCommandOutput extends OptionGroupOpti /** *

Describes all available options.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { RDSClient, DescribeOptionGroupOptionsCommand } from "@aws-sdk/client-rds"; // ES Modules import + * // const { RDSClient, DescribeOptionGroupOptionsCommand } = require("@aws-sdk/client-rds"); // CommonJS import + * const client = new RDSClient(config); + * const command = new DescribeOptionGroupOptionsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeOptionGroupOptionsCommandInput} for command's `input` shape. + * @see {@link DescribeOptionGroupOptionsCommandOutput} for command's `response` shape. + * @see {@link RDSClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeOptionGroupOptionsCommand extends $Command< DescribeOptionGroupOptionsCommandInput, diff --git a/clients/client-rds/commands/DescribeOptionGroupsCommand.ts b/clients/client-rds/commands/DescribeOptionGroupsCommand.ts index 1d9228f592d5..79dc28657970 100644 --- a/clients/client-rds/commands/DescribeOptionGroupsCommand.ts +++ b/clients/client-rds/commands/DescribeOptionGroupsCommand.ts @@ -22,6 +22,20 @@ export interface DescribeOptionGroupsCommandOutput extends OptionGroups, __Metad /** *

Describes the available option groups.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { RDSClient, DescribeOptionGroupsCommand } from "@aws-sdk/client-rds"; // ES Modules import + * // const { RDSClient, DescribeOptionGroupsCommand } = require("@aws-sdk/client-rds"); // CommonJS import + * const client = new RDSClient(config); + * const command = new DescribeOptionGroupsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeOptionGroupsCommandInput} for command's `input` shape. + * @see {@link DescribeOptionGroupsCommandOutput} for command's `response` shape. + * @see {@link RDSClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeOptionGroupsCommand extends $Command< DescribeOptionGroupsCommandInput, diff --git a/clients/client-rds/commands/DescribeOrderableDBInstanceOptionsCommand.ts b/clients/client-rds/commands/DescribeOrderableDBInstanceOptionsCommand.ts index 6327a38525bb..3a0706dc28e5 100644 --- a/clients/client-rds/commands/DescribeOrderableDBInstanceOptionsCommand.ts +++ b/clients/client-rds/commands/DescribeOrderableDBInstanceOptionsCommand.ts @@ -24,6 +24,20 @@ export interface DescribeOrderableDBInstanceOptionsCommandOutput /** *

Returns a list of orderable DB instance options for the specified engine.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { RDSClient, DescribeOrderableDBInstanceOptionsCommand } from "@aws-sdk/client-rds"; // ES Modules import + * // const { RDSClient, DescribeOrderableDBInstanceOptionsCommand } = require("@aws-sdk/client-rds"); // CommonJS import + * const client = new RDSClient(config); + * const command = new DescribeOrderableDBInstanceOptionsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeOrderableDBInstanceOptionsCommandInput} for command's `input` shape. + * @see {@link DescribeOrderableDBInstanceOptionsCommandOutput} for command's `response` shape. + * @see {@link RDSClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeOrderableDBInstanceOptionsCommand extends $Command< DescribeOrderableDBInstanceOptionsCommandInput, diff --git a/clients/client-rds/commands/DescribePendingMaintenanceActionsCommand.ts b/clients/client-rds/commands/DescribePendingMaintenanceActionsCommand.ts index 99d1f1cac98b..90a0d8a245f0 100644 --- a/clients/client-rds/commands/DescribePendingMaintenanceActionsCommand.ts +++ b/clients/client-rds/commands/DescribePendingMaintenanceActionsCommand.ts @@ -24,6 +24,20 @@ export interface DescribePendingMaintenanceActionsCommandOutput /** *

Returns a list of resources (for example, DB instances) that have at least one pending maintenance action.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { RDSClient, DescribePendingMaintenanceActionsCommand } from "@aws-sdk/client-rds"; // ES Modules import + * // const { RDSClient, DescribePendingMaintenanceActionsCommand } = require("@aws-sdk/client-rds"); // CommonJS import + * const client = new RDSClient(config); + * const command = new DescribePendingMaintenanceActionsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribePendingMaintenanceActionsCommandInput} for command's `input` shape. + * @see {@link DescribePendingMaintenanceActionsCommandOutput} for command's `response` shape. + * @see {@link RDSClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribePendingMaintenanceActionsCommand extends $Command< DescribePendingMaintenanceActionsCommandInput, diff --git a/clients/client-rds/commands/DescribeReservedDBInstancesCommand.ts b/clients/client-rds/commands/DescribeReservedDBInstancesCommand.ts index 6620dbb8be0a..f5efe58eb2fb 100644 --- a/clients/client-rds/commands/DescribeReservedDBInstancesCommand.ts +++ b/clients/client-rds/commands/DescribeReservedDBInstancesCommand.ts @@ -22,6 +22,20 @@ export interface DescribeReservedDBInstancesCommandOutput extends ReservedDBInst /** *

Returns information about reserved DB instances for this account, or about a specified reserved DB instance.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { RDSClient, DescribeReservedDBInstancesCommand } from "@aws-sdk/client-rds"; // ES Modules import + * // const { RDSClient, DescribeReservedDBInstancesCommand } = require("@aws-sdk/client-rds"); // CommonJS import + * const client = new RDSClient(config); + * const command = new DescribeReservedDBInstancesCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeReservedDBInstancesCommandInput} for command's `input` shape. + * @see {@link DescribeReservedDBInstancesCommandOutput} for command's `response` shape. + * @see {@link RDSClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeReservedDBInstancesCommand extends $Command< DescribeReservedDBInstancesCommandInput, diff --git a/clients/client-rds/commands/DescribeReservedDBInstancesOfferingsCommand.ts b/clients/client-rds/commands/DescribeReservedDBInstancesOfferingsCommand.ts index 72048c8fbdf7..c2248a91b668 100644 --- a/clients/client-rds/commands/DescribeReservedDBInstancesOfferingsCommand.ts +++ b/clients/client-rds/commands/DescribeReservedDBInstancesOfferingsCommand.ts @@ -24,6 +24,20 @@ export interface DescribeReservedDBInstancesOfferingsCommandOutput /** *

Lists available reserved DB instance offerings.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { RDSClient, DescribeReservedDBInstancesOfferingsCommand } from "@aws-sdk/client-rds"; // ES Modules import + * // const { RDSClient, DescribeReservedDBInstancesOfferingsCommand } = require("@aws-sdk/client-rds"); // CommonJS import + * const client = new RDSClient(config); + * const command = new DescribeReservedDBInstancesOfferingsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeReservedDBInstancesOfferingsCommandInput} for command's `input` shape. + * @see {@link DescribeReservedDBInstancesOfferingsCommandOutput} for command's `response` shape. + * @see {@link RDSClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeReservedDBInstancesOfferingsCommand extends $Command< DescribeReservedDBInstancesOfferingsCommandInput, diff --git a/clients/client-rds/commands/DescribeSourceRegionsCommand.ts b/clients/client-rds/commands/DescribeSourceRegionsCommand.ts index 14fa0cf1d220..31705e993915 100644 --- a/clients/client-rds/commands/DescribeSourceRegionsCommand.ts +++ b/clients/client-rds/commands/DescribeSourceRegionsCommand.ts @@ -23,6 +23,20 @@ export interface DescribeSourceRegionsCommandOutput extends SourceRegionMessage, /** *

Returns a list of the source AWS Regions where the current AWS Region can create a read replica, * copy a DB snapshot from, or replicate automated backups from. This API action supports pagination.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { RDSClient, DescribeSourceRegionsCommand } from "@aws-sdk/client-rds"; // ES Modules import + * // const { RDSClient, DescribeSourceRegionsCommand } = require("@aws-sdk/client-rds"); // CommonJS import + * const client = new RDSClient(config); + * const command = new DescribeSourceRegionsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeSourceRegionsCommandInput} for command's `input` shape. + * @see {@link DescribeSourceRegionsCommandOutput} for command's `response` shape. + * @see {@link RDSClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeSourceRegionsCommand extends $Command< DescribeSourceRegionsCommandInput, diff --git a/clients/client-rds/commands/DescribeValidDBInstanceModificationsCommand.ts b/clients/client-rds/commands/DescribeValidDBInstanceModificationsCommand.ts index ea505a4dba91..a0714bba059d 100644 --- a/clients/client-rds/commands/DescribeValidDBInstanceModificationsCommand.ts +++ b/clients/client-rds/commands/DescribeValidDBInstanceModificationsCommand.ts @@ -31,6 +31,20 @@ export interface DescribeValidDBInstanceModificationsCommandOutput * You can use this information when you call * ModifyDBInstance. *

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { RDSClient, DescribeValidDBInstanceModificationsCommand } from "@aws-sdk/client-rds"; // ES Modules import + * // const { RDSClient, DescribeValidDBInstanceModificationsCommand } = require("@aws-sdk/client-rds"); // CommonJS import + * const client = new RDSClient(config); + * const command = new DescribeValidDBInstanceModificationsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeValidDBInstanceModificationsCommandInput} for command's `input` shape. + * @see {@link DescribeValidDBInstanceModificationsCommandOutput} for command's `response` shape. + * @see {@link RDSClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeValidDBInstanceModificationsCommand extends $Command< DescribeValidDBInstanceModificationsCommandInput, diff --git a/clients/client-rds/commands/DownloadDBLogFilePortionCommand.ts b/clients/client-rds/commands/DownloadDBLogFilePortionCommand.ts index 8fcd4040694e..1fe7a5d430a8 100644 --- a/clients/client-rds/commands/DownloadDBLogFilePortionCommand.ts +++ b/clients/client-rds/commands/DownloadDBLogFilePortionCommand.ts @@ -22,6 +22,20 @@ export interface DownloadDBLogFilePortionCommandOutput extends DownloadDBLogFile /** *

Downloads all or a portion of the specified log file, up to 1 MB in size.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { RDSClient, DownloadDBLogFilePortionCommand } from "@aws-sdk/client-rds"; // ES Modules import + * // const { RDSClient, DownloadDBLogFilePortionCommand } = require("@aws-sdk/client-rds"); // CommonJS import + * const client = new RDSClient(config); + * const command = new DownloadDBLogFilePortionCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DownloadDBLogFilePortionCommandInput} for command's `input` shape. + * @see {@link DownloadDBLogFilePortionCommandOutput} for command's `response` shape. + * @see {@link RDSClientResolvedConfig | config} for command's `input` shape. + * */ export class DownloadDBLogFilePortionCommand extends $Command< DownloadDBLogFilePortionCommandInput, diff --git a/clients/client-rds/commands/FailoverDBClusterCommand.ts b/clients/client-rds/commands/FailoverDBClusterCommand.ts index 47859ce62aae..acfe27a3bbff 100644 --- a/clients/client-rds/commands/FailoverDBClusterCommand.ts +++ b/clients/client-rds/commands/FailoverDBClusterCommand.ts @@ -35,6 +35,20 @@ export interface FailoverDBClusterCommandOutput extends FailoverDBClusterResult, * *

This action only applies to Aurora DB clusters.

* + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { RDSClient, FailoverDBClusterCommand } from "@aws-sdk/client-rds"; // ES Modules import + * // const { RDSClient, FailoverDBClusterCommand } = require("@aws-sdk/client-rds"); // CommonJS import + * const client = new RDSClient(config); + * const command = new FailoverDBClusterCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link FailoverDBClusterCommandInput} for command's `input` shape. + * @see {@link FailoverDBClusterCommandOutput} for command's `response` shape. + * @see {@link RDSClientResolvedConfig | config} for command's `input` shape. + * */ export class FailoverDBClusterCommand extends $Command< FailoverDBClusterCommandInput, diff --git a/clients/client-rds/commands/FailoverGlobalClusterCommand.ts b/clients/client-rds/commands/FailoverGlobalClusterCommand.ts index e37461eedbfb..399a2c423d34 100644 --- a/clients/client-rds/commands/FailoverGlobalClusterCommand.ts +++ b/clients/client-rds/commands/FailoverGlobalClusterCommand.ts @@ -36,6 +36,20 @@ export interface FailoverGlobalClusterCommandOutput extends FailoverGlobalCluste * reconfigure your Aurora global database topology. *

* + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { RDSClient, FailoverGlobalClusterCommand } from "@aws-sdk/client-rds"; // ES Modules import + * // const { RDSClient, FailoverGlobalClusterCommand } = require("@aws-sdk/client-rds"); // CommonJS import + * const client = new RDSClient(config); + * const command = new FailoverGlobalClusterCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link FailoverGlobalClusterCommandInput} for command's `input` shape. + * @see {@link FailoverGlobalClusterCommandOutput} for command's `response` shape. + * @see {@link RDSClientResolvedConfig | config} for command's `input` shape. + * */ export class FailoverGlobalClusterCommand extends $Command< FailoverGlobalClusterCommandInput, diff --git a/clients/client-rds/commands/ImportInstallationMediaCommand.ts b/clients/client-rds/commands/ImportInstallationMediaCommand.ts index efd12c849f15..9ae9db905ffb 100644 --- a/clients/client-rds/commands/ImportInstallationMediaCommand.ts +++ b/clients/client-rds/commands/ImportInstallationMediaCommand.ts @@ -24,6 +24,20 @@ export interface ImportInstallationMediaCommandOutput extends InstallationMedia, /** *

Imports the installation media for a DB engine that requires an on-premises * customer provided license, such as SQL Server.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { RDSClient, ImportInstallationMediaCommand } from "@aws-sdk/client-rds"; // ES Modules import + * // const { RDSClient, ImportInstallationMediaCommand } = require("@aws-sdk/client-rds"); // CommonJS import + * const client = new RDSClient(config); + * const command = new ImportInstallationMediaCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ImportInstallationMediaCommandInput} for command's `input` shape. + * @see {@link ImportInstallationMediaCommandOutput} for command's `response` shape. + * @see {@link RDSClientResolvedConfig | config} for command's `input` shape. + * */ export class ImportInstallationMediaCommand extends $Command< ImportInstallationMediaCommandInput, diff --git a/clients/client-rds/commands/ListTagsForResourceCommand.ts b/clients/client-rds/commands/ListTagsForResourceCommand.ts index 4098295f7710..36d3876f1c82 100644 --- a/clients/client-rds/commands/ListTagsForResourceCommand.ts +++ b/clients/client-rds/commands/ListTagsForResourceCommand.ts @@ -25,6 +25,20 @@ export interface ListTagsForResourceCommandOutput extends TagListMessage, __Meta *

For an overview on tagging an Amazon RDS resource, * see Tagging Amazon RDS Resources * in the Amazon RDS User Guide.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { RDSClient, ListTagsForResourceCommand } from "@aws-sdk/client-rds"; // ES Modules import + * // const { RDSClient, ListTagsForResourceCommand } = require("@aws-sdk/client-rds"); // CommonJS import + * const client = new RDSClient(config); + * const command = new ListTagsForResourceCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListTagsForResourceCommandInput} for command's `input` shape. + * @see {@link ListTagsForResourceCommandOutput} for command's `response` shape. + * @see {@link RDSClientResolvedConfig | config} for command's `input` shape. + * */ export class ListTagsForResourceCommand extends $Command< ListTagsForResourceCommandInput, diff --git a/clients/client-rds/commands/ModifyCertificatesCommand.ts b/clients/client-rds/commands/ModifyCertificatesCommand.ts index e0e4650dba32..0a76651c901a 100644 --- a/clients/client-rds/commands/ModifyCertificatesCommand.ts +++ b/clients/client-rds/commands/ModifyCertificatesCommand.ts @@ -46,6 +46,20 @@ export interface ModifyCertificatesCommandOutput extends ModifyCertificatesResul *

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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { RDSClient, ModifyCertificatesCommand } from "@aws-sdk/client-rds"; // ES Modules import + * // const { RDSClient, ModifyCertificatesCommand } = require("@aws-sdk/client-rds"); // CommonJS import + * const client = new RDSClient(config); + * const command = new ModifyCertificatesCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ModifyCertificatesCommandInput} for command's `input` shape. + * @see {@link ModifyCertificatesCommandOutput} for command's `response` shape. + * @see {@link RDSClientResolvedConfig | config} for command's `input` shape. + * */ export class ModifyCertificatesCommand extends $Command< ModifyCertificatesCommandInput, diff --git a/clients/client-rds/commands/ModifyCurrentDBClusterCapacityCommand.ts b/clients/client-rds/commands/ModifyCurrentDBClusterCapacityCommand.ts index 6ca30473d4cb..3c88ed81a51b 100644 --- a/clients/client-rds/commands/ModifyCurrentDBClusterCapacityCommand.ts +++ b/clients/client-rds/commands/ModifyCurrentDBClusterCapacityCommand.ts @@ -39,6 +39,20 @@ export interface ModifyCurrentDBClusterCapacityCommandOutput extends DBClusterCa * *

This action only applies to Aurora DB clusters.

* + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { RDSClient, ModifyCurrentDBClusterCapacityCommand } from "@aws-sdk/client-rds"; // ES Modules import + * // const { RDSClient, ModifyCurrentDBClusterCapacityCommand } = require("@aws-sdk/client-rds"); // CommonJS import + * const client = new RDSClient(config); + * const command = new ModifyCurrentDBClusterCapacityCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ModifyCurrentDBClusterCapacityCommandInput} for command's `input` shape. + * @see {@link ModifyCurrentDBClusterCapacityCommandOutput} for command's `response` shape. + * @see {@link RDSClientResolvedConfig | config} for command's `input` shape. + * */ export class ModifyCurrentDBClusterCapacityCommand extends $Command< ModifyCurrentDBClusterCapacityCommandInput, diff --git a/clients/client-rds/commands/ModifyDBClusterCommand.ts b/clients/client-rds/commands/ModifyDBClusterCommand.ts index c7fd8ba88c7f..4f61e3ee714a 100644 --- a/clients/client-rds/commands/ModifyDBClusterCommand.ts +++ b/clients/client-rds/commands/ModifyDBClusterCommand.ts @@ -31,6 +31,20 @@ export interface ModifyDBClusterCommandOutput extends ModifyDBClusterResult, __M * *

This action only applies to Aurora DB clusters.

* + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { RDSClient, ModifyDBClusterCommand } from "@aws-sdk/client-rds"; // ES Modules import + * // const { RDSClient, ModifyDBClusterCommand } = require("@aws-sdk/client-rds"); // CommonJS import + * const client = new RDSClient(config); + * const command = new ModifyDBClusterCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ModifyDBClusterCommandInput} for command's `input` shape. + * @see {@link ModifyDBClusterCommandOutput} for command's `response` shape. + * @see {@link RDSClientResolvedConfig | config} for command's `input` shape. + * */ export class ModifyDBClusterCommand extends $Command< ModifyDBClusterCommandInput, diff --git a/clients/client-rds/commands/ModifyDBClusterEndpointCommand.ts b/clients/client-rds/commands/ModifyDBClusterEndpointCommand.ts index 9dc22ca0c0d0..4590a6f3dbb7 100644 --- a/clients/client-rds/commands/ModifyDBClusterEndpointCommand.ts +++ b/clients/client-rds/commands/ModifyDBClusterEndpointCommand.ts @@ -26,6 +26,20 @@ export interface ModifyDBClusterEndpointCommandOutput extends DBClusterEndpoint, * *

This action only applies to Aurora DB clusters.

* + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { RDSClient, ModifyDBClusterEndpointCommand } from "@aws-sdk/client-rds"; // ES Modules import + * // const { RDSClient, ModifyDBClusterEndpointCommand } = require("@aws-sdk/client-rds"); // CommonJS import + * const client = new RDSClient(config); + * const command = new ModifyDBClusterEndpointCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ModifyDBClusterEndpointCommandInput} for command's `input` shape. + * @see {@link ModifyDBClusterEndpointCommandOutput} for command's `response` shape. + * @see {@link RDSClientResolvedConfig | config} for command's `input` shape. + * */ export class ModifyDBClusterEndpointCommand extends $Command< ModifyDBClusterEndpointCommandInput, diff --git a/clients/client-rds/commands/ModifyDBClusterParameterGroupCommand.ts b/clients/client-rds/commands/ModifyDBClusterParameterGroupCommand.ts index f031a4a3f54e..3be16383e6f7 100644 --- a/clients/client-rds/commands/ModifyDBClusterParameterGroupCommand.ts +++ b/clients/client-rds/commands/ModifyDBClusterParameterGroupCommand.ts @@ -54,6 +54,20 @@ export interface ModifyDBClusterParameterGroupCommandOutput * *

This action only applies to Aurora DB clusters.

* + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { RDSClient, ModifyDBClusterParameterGroupCommand } from "@aws-sdk/client-rds"; // ES Modules import + * // const { RDSClient, ModifyDBClusterParameterGroupCommand } = require("@aws-sdk/client-rds"); // CommonJS import + * const client = new RDSClient(config); + * const command = new ModifyDBClusterParameterGroupCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ModifyDBClusterParameterGroupCommandInput} for command's `input` shape. + * @see {@link ModifyDBClusterParameterGroupCommandOutput} for command's `response` shape. + * @see {@link RDSClientResolvedConfig | config} for command's `input` shape. + * */ export class ModifyDBClusterParameterGroupCommand extends $Command< ModifyDBClusterParameterGroupCommandInput, diff --git a/clients/client-rds/commands/ModifyDBClusterSnapshotAttributeCommand.ts b/clients/client-rds/commands/ModifyDBClusterSnapshotAttributeCommand.ts index 627c36f5d92e..43614a076a6c 100644 --- a/clients/client-rds/commands/ModifyDBClusterSnapshotAttributeCommand.ts +++ b/clients/client-rds/commands/ModifyDBClusterSnapshotAttributeCommand.ts @@ -45,6 +45,20 @@ export interface ModifyDBClusterSnapshotAttributeCommandOutput * *

This action only applies to Aurora DB clusters.

* + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { RDSClient, ModifyDBClusterSnapshotAttributeCommand } from "@aws-sdk/client-rds"; // ES Modules import + * // const { RDSClient, ModifyDBClusterSnapshotAttributeCommand } = require("@aws-sdk/client-rds"); // CommonJS import + * const client = new RDSClient(config); + * const command = new ModifyDBClusterSnapshotAttributeCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ModifyDBClusterSnapshotAttributeCommandInput} for command's `input` shape. + * @see {@link ModifyDBClusterSnapshotAttributeCommandOutput} for command's `response` shape. + * @see {@link RDSClientResolvedConfig | config} for command's `input` shape. + * */ export class ModifyDBClusterSnapshotAttributeCommand extends $Command< ModifyDBClusterSnapshotAttributeCommandInput, diff --git a/clients/client-rds/commands/ModifyDBInstanceCommand.ts b/clients/client-rds/commands/ModifyDBInstanceCommand.ts index a59214ad9cbd..58883f3ce330 100644 --- a/clients/client-rds/commands/ModifyDBInstanceCommand.ts +++ b/clients/client-rds/commands/ModifyDBInstanceCommand.ts @@ -27,6 +27,20 @@ export interface ModifyDBInstanceCommandOutput extends ModifyDBInstanceResult, _ * call DescribeValidDBInstanceModifications * before you call ModifyDBInstance. *

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { RDSClient, ModifyDBInstanceCommand } from "@aws-sdk/client-rds"; // ES Modules import + * // const { RDSClient, ModifyDBInstanceCommand } = require("@aws-sdk/client-rds"); // CommonJS import + * const client = new RDSClient(config); + * const command = new ModifyDBInstanceCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ModifyDBInstanceCommandInput} for command's `input` shape. + * @see {@link ModifyDBInstanceCommandOutput} for command's `response` shape. + * @see {@link RDSClientResolvedConfig | config} for command's `input` shape. + * */ export class ModifyDBInstanceCommand extends $Command< ModifyDBInstanceCommandInput, diff --git a/clients/client-rds/commands/ModifyDBParameterGroupCommand.ts b/clients/client-rds/commands/ModifyDBParameterGroupCommand.ts index 8c61a496d0c5..3e8266421095 100644 --- a/clients/client-rds/commands/ModifyDBParameterGroupCommand.ts +++ b/clients/client-rds/commands/ModifyDBParameterGroupCommand.ts @@ -41,6 +41,20 @@ export interface ModifyDBParameterGroupCommandOutput extends DBParameterGroupNam * DescribeDBParameters command to verify * that your DB parameter group has been created or modified.

* + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { RDSClient, ModifyDBParameterGroupCommand } from "@aws-sdk/client-rds"; // ES Modules import + * // const { RDSClient, ModifyDBParameterGroupCommand } = require("@aws-sdk/client-rds"); // CommonJS import + * const client = new RDSClient(config); + * const command = new ModifyDBParameterGroupCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ModifyDBParameterGroupCommandInput} for command's `input` shape. + * @see {@link ModifyDBParameterGroupCommandOutput} for command's `response` shape. + * @see {@link RDSClientResolvedConfig | config} for command's `input` shape. + * */ export class ModifyDBParameterGroupCommand extends $Command< ModifyDBParameterGroupCommandInput, diff --git a/clients/client-rds/commands/ModifyDBProxyCommand.ts b/clients/client-rds/commands/ModifyDBProxyCommand.ts index d22976d4f6e6..915d54913e43 100644 --- a/clients/client-rds/commands/ModifyDBProxyCommand.ts +++ b/clients/client-rds/commands/ModifyDBProxyCommand.ts @@ -22,6 +22,20 @@ export interface ModifyDBProxyCommandOutput extends ModifyDBProxyResponse, __Met /** *

Changes the settings for an existing DB proxy.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { RDSClient, ModifyDBProxyCommand } from "@aws-sdk/client-rds"; // ES Modules import + * // const { RDSClient, ModifyDBProxyCommand } = require("@aws-sdk/client-rds"); // CommonJS import + * const client = new RDSClient(config); + * const command = new ModifyDBProxyCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ModifyDBProxyCommandInput} for command's `input` shape. + * @see {@link ModifyDBProxyCommandOutput} for command's `response` shape. + * @see {@link RDSClientResolvedConfig | config} for command's `input` shape. + * */ export class ModifyDBProxyCommand extends $Command< ModifyDBProxyCommandInput, diff --git a/clients/client-rds/commands/ModifyDBProxyEndpointCommand.ts b/clients/client-rds/commands/ModifyDBProxyEndpointCommand.ts index 930c1e65bfc9..710e08a26e86 100644 --- a/clients/client-rds/commands/ModifyDBProxyEndpointCommand.ts +++ b/clients/client-rds/commands/ModifyDBProxyEndpointCommand.ts @@ -22,6 +22,20 @@ export interface ModifyDBProxyEndpointCommandOutput extends ModifyDBProxyEndpoin /** *

Changes the settings for an existing DB proxy endpoint.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { RDSClient, ModifyDBProxyEndpointCommand } from "@aws-sdk/client-rds"; // ES Modules import + * // const { RDSClient, ModifyDBProxyEndpointCommand } = require("@aws-sdk/client-rds"); // CommonJS import + * const client = new RDSClient(config); + * const command = new ModifyDBProxyEndpointCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ModifyDBProxyEndpointCommandInput} for command's `input` shape. + * @see {@link ModifyDBProxyEndpointCommandOutput} for command's `response` shape. + * @see {@link RDSClientResolvedConfig | config} for command's `input` shape. + * */ export class ModifyDBProxyEndpointCommand extends $Command< ModifyDBProxyEndpointCommandInput, diff --git a/clients/client-rds/commands/ModifyDBProxyTargetGroupCommand.ts b/clients/client-rds/commands/ModifyDBProxyTargetGroupCommand.ts index 9e1384a6007d..0bbf6c189b1f 100644 --- a/clients/client-rds/commands/ModifyDBProxyTargetGroupCommand.ts +++ b/clients/client-rds/commands/ModifyDBProxyTargetGroupCommand.ts @@ -22,6 +22,20 @@ export interface ModifyDBProxyTargetGroupCommandOutput extends ModifyDBProxyTarg /** *

Modifies the properties of a DBProxyTargetGroup.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { RDSClient, ModifyDBProxyTargetGroupCommand } from "@aws-sdk/client-rds"; // ES Modules import + * // const { RDSClient, ModifyDBProxyTargetGroupCommand } = require("@aws-sdk/client-rds"); // CommonJS import + * const client = new RDSClient(config); + * const command = new ModifyDBProxyTargetGroupCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ModifyDBProxyTargetGroupCommandInput} for command's `input` shape. + * @see {@link ModifyDBProxyTargetGroupCommandOutput} for command's `response` shape. + * @see {@link RDSClientResolvedConfig | config} for command's `input` shape. + * */ export class ModifyDBProxyTargetGroupCommand extends $Command< ModifyDBProxyTargetGroupCommandInput, diff --git a/clients/client-rds/commands/ModifyDBSnapshotAttributeCommand.ts b/clients/client-rds/commands/ModifyDBSnapshotAttributeCommand.ts index a39cfa2df0d8..9338c60ebab0 100644 --- a/clients/client-rds/commands/ModifyDBSnapshotAttributeCommand.ts +++ b/clients/client-rds/commands/ModifyDBSnapshotAttributeCommand.ts @@ -38,6 +38,20 @@ export interface ModifyDBSnapshotAttributeCommandOutput extends ModifyDBSnapshot *

To view which AWS accounts have access to copy or restore a manual DB snapshot, or * whether a manual DB snapshot public or private, use the DescribeDBSnapshotAttributes API action. The accounts are returned as * values for the restore attribute.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { RDSClient, ModifyDBSnapshotAttributeCommand } from "@aws-sdk/client-rds"; // ES Modules import + * // const { RDSClient, ModifyDBSnapshotAttributeCommand } = require("@aws-sdk/client-rds"); // CommonJS import + * const client = new RDSClient(config); + * const command = new ModifyDBSnapshotAttributeCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ModifyDBSnapshotAttributeCommandInput} for command's `input` shape. + * @see {@link ModifyDBSnapshotAttributeCommandOutput} for command's `response` shape. + * @see {@link RDSClientResolvedConfig | config} for command's `input` shape. + * */ export class ModifyDBSnapshotAttributeCommand extends $Command< ModifyDBSnapshotAttributeCommandInput, diff --git a/clients/client-rds/commands/ModifyDBSnapshotCommand.ts b/clients/client-rds/commands/ModifyDBSnapshotCommand.ts index ecc71de6fd76..583f7eb1914e 100644 --- a/clients/client-rds/commands/ModifyDBSnapshotCommand.ts +++ b/clients/client-rds/commands/ModifyDBSnapshotCommand.ts @@ -28,6 +28,20 @@ export interface ModifyDBSnapshotCommandOutput extends ModifyDBSnapshotResult, _ * *

Amazon RDS supports upgrading DB snapshots for MySQL, Oracle, and PostgreSQL. *

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { RDSClient, ModifyDBSnapshotCommand } from "@aws-sdk/client-rds"; // ES Modules import + * // const { RDSClient, ModifyDBSnapshotCommand } = require("@aws-sdk/client-rds"); // CommonJS import + * const client = new RDSClient(config); + * const command = new ModifyDBSnapshotCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ModifyDBSnapshotCommandInput} for command's `input` shape. + * @see {@link ModifyDBSnapshotCommandOutput} for command's `response` shape. + * @see {@link RDSClientResolvedConfig | config} for command's `input` shape. + * */ export class ModifyDBSnapshotCommand extends $Command< ModifyDBSnapshotCommandInput, diff --git a/clients/client-rds/commands/ModifyDBSubnetGroupCommand.ts b/clients/client-rds/commands/ModifyDBSubnetGroupCommand.ts index 0188ac386d7a..b8190fcb2dca 100644 --- a/clients/client-rds/commands/ModifyDBSubnetGroupCommand.ts +++ b/clients/client-rds/commands/ModifyDBSubnetGroupCommand.ts @@ -22,6 +22,20 @@ export interface ModifyDBSubnetGroupCommandOutput extends ModifyDBSubnetGroupRes /** *

Modifies an existing DB subnet group. DB subnet groups must contain at least one subnet in at least two AZs in the AWS Region.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { RDSClient, ModifyDBSubnetGroupCommand } from "@aws-sdk/client-rds"; // ES Modules import + * // const { RDSClient, ModifyDBSubnetGroupCommand } = require("@aws-sdk/client-rds"); // CommonJS import + * const client = new RDSClient(config); + * const command = new ModifyDBSubnetGroupCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ModifyDBSubnetGroupCommandInput} for command's `input` shape. + * @see {@link ModifyDBSubnetGroupCommandOutput} for command's `response` shape. + * @see {@link RDSClientResolvedConfig | config} for command's `input` shape. + * */ export class ModifyDBSubnetGroupCommand extends $Command< ModifyDBSubnetGroupCommandInput, diff --git a/clients/client-rds/commands/ModifyEventSubscriptionCommand.ts b/clients/client-rds/commands/ModifyEventSubscriptionCommand.ts index 70d04e2d9f33..505449203d2f 100644 --- a/clients/client-rds/commands/ModifyEventSubscriptionCommand.ts +++ b/clients/client-rds/commands/ModifyEventSubscriptionCommand.ts @@ -26,6 +26,20 @@ export interface ModifyEventSubscriptionCommandOutput extends ModifyEventSubscri *

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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { RDSClient, ModifyEventSubscriptionCommand } from "@aws-sdk/client-rds"; // ES Modules import + * // const { RDSClient, ModifyEventSubscriptionCommand } = require("@aws-sdk/client-rds"); // CommonJS import + * const client = new RDSClient(config); + * const command = new ModifyEventSubscriptionCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ModifyEventSubscriptionCommandInput} for command's `input` shape. + * @see {@link ModifyEventSubscriptionCommandOutput} for command's `response` shape. + * @see {@link RDSClientResolvedConfig | config} for command's `input` shape. + * */ export class ModifyEventSubscriptionCommand extends $Command< ModifyEventSubscriptionCommandInput, diff --git a/clients/client-rds/commands/ModifyGlobalClusterCommand.ts b/clients/client-rds/commands/ModifyGlobalClusterCommand.ts index e6a012309d96..b3e82157c08c 100644 --- a/clients/client-rds/commands/ModifyGlobalClusterCommand.ts +++ b/clients/client-rds/commands/ModifyGlobalClusterCommand.ts @@ -30,6 +30,20 @@ export interface ModifyGlobalClusterCommandOutput extends ModifyGlobalClusterRes * *

This action only applies to Aurora DB clusters.

* + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { RDSClient, ModifyGlobalClusterCommand } from "@aws-sdk/client-rds"; // ES Modules import + * // const { RDSClient, ModifyGlobalClusterCommand } = require("@aws-sdk/client-rds"); // CommonJS import + * const client = new RDSClient(config); + * const command = new ModifyGlobalClusterCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ModifyGlobalClusterCommandInput} for command's `input` shape. + * @see {@link ModifyGlobalClusterCommandOutput} for command's `response` shape. + * @see {@link RDSClientResolvedConfig | config} for command's `input` shape. + * */ export class ModifyGlobalClusterCommand extends $Command< ModifyGlobalClusterCommandInput, diff --git a/clients/client-rds/commands/ModifyOptionGroupCommand.ts b/clients/client-rds/commands/ModifyOptionGroupCommand.ts index 494d388ab598..506d4a55ea9d 100644 --- a/clients/client-rds/commands/ModifyOptionGroupCommand.ts +++ b/clients/client-rds/commands/ModifyOptionGroupCommand.ts @@ -22,6 +22,20 @@ export interface ModifyOptionGroupCommandOutput extends ModifyOptionGroupResult, /** *

Modifies an existing option group.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { RDSClient, ModifyOptionGroupCommand } from "@aws-sdk/client-rds"; // ES Modules import + * // const { RDSClient, ModifyOptionGroupCommand } = require("@aws-sdk/client-rds"); // CommonJS import + * const client = new RDSClient(config); + * const command = new ModifyOptionGroupCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ModifyOptionGroupCommandInput} for command's `input` shape. + * @see {@link ModifyOptionGroupCommandOutput} for command's `response` shape. + * @see {@link RDSClientResolvedConfig | config} for command's `input` shape. + * */ export class ModifyOptionGroupCommand extends $Command< ModifyOptionGroupCommandInput, diff --git a/clients/client-rds/commands/PromoteReadReplicaCommand.ts b/clients/client-rds/commands/PromoteReadReplicaCommand.ts index 9e982bd7985d..b7fa55611e7c 100644 --- a/clients/client-rds/commands/PromoteReadReplicaCommand.ts +++ b/clients/client-rds/commands/PromoteReadReplicaCommand.ts @@ -40,6 +40,20 @@ export interface PromoteReadReplicaCommandOutput extends PromoteReadReplicaResul * * * + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { RDSClient, PromoteReadReplicaCommand } from "@aws-sdk/client-rds"; // ES Modules import + * // const { RDSClient, PromoteReadReplicaCommand } = require("@aws-sdk/client-rds"); // CommonJS import + * const client = new RDSClient(config); + * const command = new PromoteReadReplicaCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link PromoteReadReplicaCommandInput} for command's `input` shape. + * @see {@link PromoteReadReplicaCommandOutput} for command's `response` shape. + * @see {@link RDSClientResolvedConfig | config} for command's `input` shape. + * */ export class PromoteReadReplicaCommand extends $Command< PromoteReadReplicaCommandInput, diff --git a/clients/client-rds/commands/PromoteReadReplicaDBClusterCommand.ts b/clients/client-rds/commands/PromoteReadReplicaDBClusterCommand.ts index e44b67540ecc..a7632d1b7680 100644 --- a/clients/client-rds/commands/PromoteReadReplicaDBClusterCommand.ts +++ b/clients/client-rds/commands/PromoteReadReplicaDBClusterCommand.ts @@ -25,6 +25,20 @@ export interface PromoteReadReplicaDBClusterCommandOutput extends PromoteReadRep * *

This action only applies to Aurora DB clusters.

* + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { RDSClient, PromoteReadReplicaDBClusterCommand } from "@aws-sdk/client-rds"; // ES Modules import + * // const { RDSClient, PromoteReadReplicaDBClusterCommand } = require("@aws-sdk/client-rds"); // CommonJS import + * const client = new RDSClient(config); + * const command = new PromoteReadReplicaDBClusterCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link PromoteReadReplicaDBClusterCommandInput} for command's `input` shape. + * @see {@link PromoteReadReplicaDBClusterCommandOutput} for command's `response` shape. + * @see {@link RDSClientResolvedConfig | config} for command's `input` shape. + * */ export class PromoteReadReplicaDBClusterCommand extends $Command< PromoteReadReplicaDBClusterCommandInput, diff --git a/clients/client-rds/commands/PurchaseReservedDBInstancesOfferingCommand.ts b/clients/client-rds/commands/PurchaseReservedDBInstancesOfferingCommand.ts index 336120006b66..c1258f9152a6 100644 --- a/clients/client-rds/commands/PurchaseReservedDBInstancesOfferingCommand.ts +++ b/clients/client-rds/commands/PurchaseReservedDBInstancesOfferingCommand.ts @@ -27,6 +27,20 @@ export interface PurchaseReservedDBInstancesOfferingCommandOutput /** *

Purchases a reserved DB instance offering.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { RDSClient, PurchaseReservedDBInstancesOfferingCommand } from "@aws-sdk/client-rds"; // ES Modules import + * // const { RDSClient, PurchaseReservedDBInstancesOfferingCommand } = require("@aws-sdk/client-rds"); // CommonJS import + * const client = new RDSClient(config); + * const command = new PurchaseReservedDBInstancesOfferingCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link PurchaseReservedDBInstancesOfferingCommandInput} for command's `input` shape. + * @see {@link PurchaseReservedDBInstancesOfferingCommandOutput} for command's `response` shape. + * @see {@link RDSClientResolvedConfig | config} for command's `input` shape. + * */ export class PurchaseReservedDBInstancesOfferingCommand extends $Command< PurchaseReservedDBInstancesOfferingCommandInput, diff --git a/clients/client-rds/commands/RebootDBInstanceCommand.ts b/clients/client-rds/commands/RebootDBInstanceCommand.ts index cf5d7880e0ae..056ebb7af5f1 100644 --- a/clients/client-rds/commands/RebootDBInstanceCommand.ts +++ b/clients/client-rds/commands/RebootDBInstanceCommand.ts @@ -33,6 +33,20 @@ export interface RebootDBInstanceCommandOutput extends RebootDBInstanceResult, _ * *

For more information about rebooting, see Rebooting a DB Instance in the Amazon RDS User Guide. *

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { RDSClient, RebootDBInstanceCommand } from "@aws-sdk/client-rds"; // ES Modules import + * // const { RDSClient, RebootDBInstanceCommand } = require("@aws-sdk/client-rds"); // CommonJS import + * const client = new RDSClient(config); + * const command = new RebootDBInstanceCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link RebootDBInstanceCommandInput} for command's `input` shape. + * @see {@link RebootDBInstanceCommandOutput} for command's `response` shape. + * @see {@link RDSClientResolvedConfig | config} for command's `input` shape. + * */ export class RebootDBInstanceCommand extends $Command< RebootDBInstanceCommandInput, diff --git a/clients/client-rds/commands/RegisterDBProxyTargetsCommand.ts b/clients/client-rds/commands/RegisterDBProxyTargetsCommand.ts index 8920c4e9702f..1130a965eabf 100644 --- a/clients/client-rds/commands/RegisterDBProxyTargetsCommand.ts +++ b/clients/client-rds/commands/RegisterDBProxyTargetsCommand.ts @@ -22,6 +22,20 @@ export interface RegisterDBProxyTargetsCommandOutput extends RegisterDBProxyTarg /** *

Associate one or more DBProxyTarget data structures with a DBProxyTargetGroup.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { RDSClient, RegisterDBProxyTargetsCommand } from "@aws-sdk/client-rds"; // ES Modules import + * // const { RDSClient, RegisterDBProxyTargetsCommand } = require("@aws-sdk/client-rds"); // CommonJS import + * const client = new RDSClient(config); + * const command = new RegisterDBProxyTargetsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link RegisterDBProxyTargetsCommandInput} for command's `input` shape. + * @see {@link RegisterDBProxyTargetsCommandOutput} for command's `response` shape. + * @see {@link RDSClientResolvedConfig | config} for command's `input` shape. + * */ export class RegisterDBProxyTargetsCommand extends $Command< RegisterDBProxyTargetsCommandInput, diff --git a/clients/client-rds/commands/RemoveFromGlobalClusterCommand.ts b/clients/client-rds/commands/RemoveFromGlobalClusterCommand.ts index 3b2b4d68511b..419714893f49 100644 --- a/clients/client-rds/commands/RemoveFromGlobalClusterCommand.ts +++ b/clients/client-rds/commands/RemoveFromGlobalClusterCommand.ts @@ -29,6 +29,20 @@ export interface RemoveFromGlobalClusterCommandOutput extends RemoveFromGlobalCl * *

This action only applies to Aurora DB clusters.

* + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { RDSClient, RemoveFromGlobalClusterCommand } from "@aws-sdk/client-rds"; // ES Modules import + * // const { RDSClient, RemoveFromGlobalClusterCommand } = require("@aws-sdk/client-rds"); // CommonJS import + * const client = new RDSClient(config); + * const command = new RemoveFromGlobalClusterCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link RemoveFromGlobalClusterCommandInput} for command's `input` shape. + * @see {@link RemoveFromGlobalClusterCommandOutput} for command's `response` shape. + * @see {@link RDSClientResolvedConfig | config} for command's `input` shape. + * */ export class RemoveFromGlobalClusterCommand extends $Command< RemoveFromGlobalClusterCommandInput, diff --git a/clients/client-rds/commands/RemoveRoleFromDBClusterCommand.ts b/clients/client-rds/commands/RemoveRoleFromDBClusterCommand.ts index 87a53791dfd1..65490f93fd88 100644 --- a/clients/client-rds/commands/RemoveRoleFromDBClusterCommand.ts +++ b/clients/client-rds/commands/RemoveRoleFromDBClusterCommand.ts @@ -27,6 +27,20 @@ export interface RemoveRoleFromDBClusterCommandOutput extends __MetadataBearer { * *

This action only applies to Aurora DB clusters.

* + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { RDSClient, RemoveRoleFromDBClusterCommand } from "@aws-sdk/client-rds"; // ES Modules import + * // const { RDSClient, RemoveRoleFromDBClusterCommand } = require("@aws-sdk/client-rds"); // CommonJS import + * const client = new RDSClient(config); + * const command = new RemoveRoleFromDBClusterCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link RemoveRoleFromDBClusterCommandInput} for command's `input` shape. + * @see {@link RemoveRoleFromDBClusterCommandOutput} for command's `response` shape. + * @see {@link RDSClientResolvedConfig | config} for command's `input` shape. + * */ export class RemoveRoleFromDBClusterCommand extends $Command< RemoveRoleFromDBClusterCommandInput, diff --git a/clients/client-rds/commands/RemoveRoleFromDBInstanceCommand.ts b/clients/client-rds/commands/RemoveRoleFromDBInstanceCommand.ts index d70238900632..cbd898f5fa2c 100644 --- a/clients/client-rds/commands/RemoveRoleFromDBInstanceCommand.ts +++ b/clients/client-rds/commands/RemoveRoleFromDBInstanceCommand.ts @@ -22,6 +22,20 @@ export interface RemoveRoleFromDBInstanceCommandOutput extends __MetadataBearer /** *

Disassociates an AWS Identity and Access Management (IAM) role from a DB instance.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { RDSClient, RemoveRoleFromDBInstanceCommand } from "@aws-sdk/client-rds"; // ES Modules import + * // const { RDSClient, RemoveRoleFromDBInstanceCommand } = require("@aws-sdk/client-rds"); // CommonJS import + * const client = new RDSClient(config); + * const command = new RemoveRoleFromDBInstanceCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link RemoveRoleFromDBInstanceCommandInput} for command's `input` shape. + * @see {@link RemoveRoleFromDBInstanceCommandOutput} for command's `response` shape. + * @see {@link RDSClientResolvedConfig | config} for command's `input` shape. + * */ export class RemoveRoleFromDBInstanceCommand extends $Command< RemoveRoleFromDBInstanceCommandInput, diff --git a/clients/client-rds/commands/RemoveSourceIdentifierFromSubscriptionCommand.ts b/clients/client-rds/commands/RemoveSourceIdentifierFromSubscriptionCommand.ts index 18d72471c509..50948dd580bc 100644 --- a/clients/client-rds/commands/RemoveSourceIdentifierFromSubscriptionCommand.ts +++ b/clients/client-rds/commands/RemoveSourceIdentifierFromSubscriptionCommand.ts @@ -28,6 +28,20 @@ export interface RemoveSourceIdentifierFromSubscriptionCommandOutput /** *

Removes a source identifier from an existing RDS event notification subscription.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { RDSClient, RemoveSourceIdentifierFromSubscriptionCommand } from "@aws-sdk/client-rds"; // ES Modules import + * // const { RDSClient, RemoveSourceIdentifierFromSubscriptionCommand } = require("@aws-sdk/client-rds"); // CommonJS import + * const client = new RDSClient(config); + * const command = new RemoveSourceIdentifierFromSubscriptionCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link RemoveSourceIdentifierFromSubscriptionCommandInput} for command's `input` shape. + * @see {@link RemoveSourceIdentifierFromSubscriptionCommandOutput} for command's `response` shape. + * @see {@link RDSClientResolvedConfig | config} for command's `input` shape. + * */ export class RemoveSourceIdentifierFromSubscriptionCommand extends $Command< RemoveSourceIdentifierFromSubscriptionCommandInput, diff --git a/clients/client-rds/commands/RemoveTagsFromResourceCommand.ts b/clients/client-rds/commands/RemoveTagsFromResourceCommand.ts index 8bd993424ad1..160f68f569eb 100644 --- a/clients/client-rds/commands/RemoveTagsFromResourceCommand.ts +++ b/clients/client-rds/commands/RemoveTagsFromResourceCommand.ts @@ -26,6 +26,20 @@ export interface RemoveTagsFromResourceCommandOutput extends __MetadataBearer {} * see Tagging Amazon RDS Resources * in the Amazon RDS User Guide. *

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { RDSClient, RemoveTagsFromResourceCommand } from "@aws-sdk/client-rds"; // ES Modules import + * // const { RDSClient, RemoveTagsFromResourceCommand } = require("@aws-sdk/client-rds"); // CommonJS import + * const client = new RDSClient(config); + * const command = new RemoveTagsFromResourceCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link RemoveTagsFromResourceCommandInput} for command's `input` shape. + * @see {@link RemoveTagsFromResourceCommandOutput} for command's `response` shape. + * @see {@link RDSClientResolvedConfig | config} for command's `input` shape. + * */ export class RemoveTagsFromResourceCommand extends $Command< RemoveTagsFromResourceCommandInput, diff --git a/clients/client-rds/commands/ResetDBClusterParameterGroupCommand.ts b/clients/client-rds/commands/ResetDBClusterParameterGroupCommand.ts index 1e9a9347023e..b47c458da290 100644 --- a/clients/client-rds/commands/ResetDBClusterParameterGroupCommand.ts +++ b/clients/client-rds/commands/ResetDBClusterParameterGroupCommand.ts @@ -43,6 +43,20 @@ export interface ResetDBClusterParameterGroupCommandOutput * *

This action only applies to Aurora DB clusters.

* + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { RDSClient, ResetDBClusterParameterGroupCommand } from "@aws-sdk/client-rds"; // ES Modules import + * // const { RDSClient, ResetDBClusterParameterGroupCommand } = require("@aws-sdk/client-rds"); // CommonJS import + * const client = new RDSClient(config); + * const command = new ResetDBClusterParameterGroupCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ResetDBClusterParameterGroupCommandInput} for command's `input` shape. + * @see {@link ResetDBClusterParameterGroupCommandOutput} for command's `response` shape. + * @see {@link RDSClientResolvedConfig | config} for command's `input` shape. + * */ export class ResetDBClusterParameterGroupCommand extends $Command< ResetDBClusterParameterGroupCommandInput, diff --git a/clients/client-rds/commands/ResetDBParameterGroupCommand.ts b/clients/client-rds/commands/ResetDBParameterGroupCommand.ts index 4cbc6eddeb1d..933a1a5d26d1 100644 --- a/clients/client-rds/commands/ResetDBParameterGroupCommand.ts +++ b/clients/client-rds/commands/ResetDBParameterGroupCommand.ts @@ -29,6 +29,20 @@ export interface ResetDBParameterGroupCommandOutput extends DBParameterGroupName * parameters are updated immediately and static parameters are set to * pending-reboot to take effect on the next DB instance restart or * RebootDBInstance request.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { RDSClient, ResetDBParameterGroupCommand } from "@aws-sdk/client-rds"; // ES Modules import + * // const { RDSClient, ResetDBParameterGroupCommand } = require("@aws-sdk/client-rds"); // CommonJS import + * const client = new RDSClient(config); + * const command = new ResetDBParameterGroupCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ResetDBParameterGroupCommandInput} for command's `input` shape. + * @see {@link ResetDBParameterGroupCommandOutput} for command's `response` shape. + * @see {@link RDSClientResolvedConfig | config} for command's `input` shape. + * */ export class ResetDBParameterGroupCommand extends $Command< ResetDBParameterGroupCommandInput, diff --git a/clients/client-rds/commands/RestoreDBClusterFromS3Command.ts b/clients/client-rds/commands/RestoreDBClusterFromS3Command.ts index d7e27501860f..ccad74573474 100644 --- a/clients/client-rds/commands/RestoreDBClusterFromS3Command.ts +++ b/clients/client-rds/commands/RestoreDBClusterFromS3Command.ts @@ -41,6 +41,20 @@ export interface RestoreDBClusterFromS3CommandOutput extends RestoreDBClusterFro *

This action only applies to Aurora DB clusters. The source DB engine must be * MySQL.

* + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { RDSClient, RestoreDBClusterFromS3Command } from "@aws-sdk/client-rds"; // ES Modules import + * // const { RDSClient, RestoreDBClusterFromS3Command } = require("@aws-sdk/client-rds"); // CommonJS import + * const client = new RDSClient(config); + * const command = new RestoreDBClusterFromS3Command(input); + * const response = await client.send(command); + * ``` + * + * @see {@link RestoreDBClusterFromS3CommandInput} for command's `input` shape. + * @see {@link RestoreDBClusterFromS3CommandOutput} for command's `response` shape. + * @see {@link RDSClientResolvedConfig | config} for command's `input` shape. + * */ export class RestoreDBClusterFromS3Command extends $Command< RestoreDBClusterFromS3CommandInput, diff --git a/clients/client-rds/commands/RestoreDBClusterFromSnapshotCommand.ts b/clients/client-rds/commands/RestoreDBClusterFromSnapshotCommand.ts index 27a6ffaa0087..85c87eab9086 100644 --- a/clients/client-rds/commands/RestoreDBClusterFromSnapshotCommand.ts +++ b/clients/client-rds/commands/RestoreDBClusterFromSnapshotCommand.ts @@ -43,6 +43,20 @@ export interface RestoreDBClusterFromSnapshotCommandOutput * *

This action only applies to Aurora DB clusters.

* + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { RDSClient, RestoreDBClusterFromSnapshotCommand } from "@aws-sdk/client-rds"; // ES Modules import + * // const { RDSClient, RestoreDBClusterFromSnapshotCommand } = require("@aws-sdk/client-rds"); // CommonJS import + * const client = new RDSClient(config); + * const command = new RestoreDBClusterFromSnapshotCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link RestoreDBClusterFromSnapshotCommandInput} for command's `input` shape. + * @see {@link RestoreDBClusterFromSnapshotCommandOutput} for command's `response` shape. + * @see {@link RDSClientResolvedConfig | config} for command's `input` shape. + * */ export class RestoreDBClusterFromSnapshotCommand extends $Command< RestoreDBClusterFromSnapshotCommandInput, diff --git a/clients/client-rds/commands/RestoreDBClusterToPointInTimeCommand.ts b/clients/client-rds/commands/RestoreDBClusterToPointInTimeCommand.ts index 54eb9dbca3a6..e8a206effc00 100644 --- a/clients/client-rds/commands/RestoreDBClusterToPointInTimeCommand.ts +++ b/clients/client-rds/commands/RestoreDBClusterToPointInTimeCommand.ts @@ -43,6 +43,20 @@ export interface RestoreDBClusterToPointInTimeCommandOutput * *

This action only applies to Aurora DB clusters.

* + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { RDSClient, RestoreDBClusterToPointInTimeCommand } from "@aws-sdk/client-rds"; // ES Modules import + * // const { RDSClient, RestoreDBClusterToPointInTimeCommand } = require("@aws-sdk/client-rds"); // CommonJS import + * const client = new RDSClient(config); + * const command = new RestoreDBClusterToPointInTimeCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link RestoreDBClusterToPointInTimeCommandInput} for command's `input` shape. + * @see {@link RestoreDBClusterToPointInTimeCommandOutput} for command's `response` shape. + * @see {@link RDSClientResolvedConfig | config} for command's `input` shape. + * */ export class RestoreDBClusterToPointInTimeCommand extends $Command< RestoreDBClusterToPointInTimeCommandInput, diff --git a/clients/client-rds/commands/RestoreDBInstanceFromDBSnapshotCommand.ts b/clients/client-rds/commands/RestoreDBInstanceFromDBSnapshotCommand.ts index 776bb691487c..7ae894b3127d 100644 --- a/clients/client-rds/commands/RestoreDBInstanceFromDBSnapshotCommand.ts +++ b/clients/client-rds/commands/RestoreDBInstanceFromDBSnapshotCommand.ts @@ -37,6 +37,20 @@ export interface RestoreDBInstanceFromDBSnapshotCommandOutput * *

This command doesn't apply to Aurora MySQL and Aurora PostgreSQL. For Aurora, use RestoreDBClusterFromSnapshot.

* + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { RDSClient, RestoreDBInstanceFromDBSnapshotCommand } from "@aws-sdk/client-rds"; // ES Modules import + * // const { RDSClient, RestoreDBInstanceFromDBSnapshotCommand } = require("@aws-sdk/client-rds"); // CommonJS import + * const client = new RDSClient(config); + * const command = new RestoreDBInstanceFromDBSnapshotCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link RestoreDBInstanceFromDBSnapshotCommandInput} for command's `input` shape. + * @see {@link RestoreDBInstanceFromDBSnapshotCommandOutput} for command's `response` shape. + * @see {@link RDSClientResolvedConfig | config} for command's `input` shape. + * */ export class RestoreDBInstanceFromDBSnapshotCommand extends $Command< RestoreDBInstanceFromDBSnapshotCommandInput, diff --git a/clients/client-rds/commands/RestoreDBInstanceFromS3Command.ts b/clients/client-rds/commands/RestoreDBInstanceFromS3Command.ts index 57a26f28cf70..14d5f9b7bd26 100644 --- a/clients/client-rds/commands/RestoreDBInstanceFromS3Command.ts +++ b/clients/client-rds/commands/RestoreDBInstanceFromS3Command.ts @@ -29,6 +29,20 @@ export interface RestoreDBInstanceFromS3CommandOutput extends RestoreDBInstanceF * For more information, see Importing Data into an Amazon RDS MySQL DB Instance * in the Amazon RDS User Guide. *

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { RDSClient, RestoreDBInstanceFromS3Command } from "@aws-sdk/client-rds"; // ES Modules import + * // const { RDSClient, RestoreDBInstanceFromS3Command } = require("@aws-sdk/client-rds"); // CommonJS import + * const client = new RDSClient(config); + * const command = new RestoreDBInstanceFromS3Command(input); + * const response = await client.send(command); + * ``` + * + * @see {@link RestoreDBInstanceFromS3CommandInput} for command's `input` shape. + * @see {@link RestoreDBInstanceFromS3CommandOutput} for command's `response` shape. + * @see {@link RDSClientResolvedConfig | config} for command's `input` shape. + * */ export class RestoreDBInstanceFromS3Command extends $Command< RestoreDBInstanceFromS3CommandInput, diff --git a/clients/client-rds/commands/RestoreDBInstanceToPointInTimeCommand.ts b/clients/client-rds/commands/RestoreDBInstanceToPointInTimeCommand.ts index f57e56174a3c..fa7a5abd339f 100644 --- a/clients/client-rds/commands/RestoreDBInstanceToPointInTimeCommand.ts +++ b/clients/client-rds/commands/RestoreDBInstanceToPointInTimeCommand.ts @@ -33,6 +33,20 @@ export interface RestoreDBInstanceToPointInTimeCommandOutput * *

This command doesn't apply to Aurora MySQL and Aurora PostgreSQL. For Aurora, use RestoreDBClusterToPointInTime.

* + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { RDSClient, RestoreDBInstanceToPointInTimeCommand } from "@aws-sdk/client-rds"; // ES Modules import + * // const { RDSClient, RestoreDBInstanceToPointInTimeCommand } = require("@aws-sdk/client-rds"); // CommonJS import + * const client = new RDSClient(config); + * const command = new RestoreDBInstanceToPointInTimeCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link RestoreDBInstanceToPointInTimeCommandInput} for command's `input` shape. + * @see {@link RestoreDBInstanceToPointInTimeCommandOutput} for command's `response` shape. + * @see {@link RDSClientResolvedConfig | config} for command's `input` shape. + * */ export class RestoreDBInstanceToPointInTimeCommand extends $Command< RestoreDBInstanceToPointInTimeCommandInput, diff --git a/clients/client-rds/commands/RevokeDBSecurityGroupIngressCommand.ts b/clients/client-rds/commands/RevokeDBSecurityGroupIngressCommand.ts index 68ea7088a14f..8e5650f13d50 100644 --- a/clients/client-rds/commands/RevokeDBSecurityGroupIngressCommand.ts +++ b/clients/client-rds/commands/RevokeDBSecurityGroupIngressCommand.ts @@ -24,6 +24,20 @@ export interface RevokeDBSecurityGroupIngressCommandOutput /** *

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).

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { RDSClient, RevokeDBSecurityGroupIngressCommand } from "@aws-sdk/client-rds"; // ES Modules import + * // const { RDSClient, RevokeDBSecurityGroupIngressCommand } = require("@aws-sdk/client-rds"); // CommonJS import + * const client = new RDSClient(config); + * const command = new RevokeDBSecurityGroupIngressCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link RevokeDBSecurityGroupIngressCommandInput} for command's `input` shape. + * @see {@link RevokeDBSecurityGroupIngressCommandOutput} for command's `response` shape. + * @see {@link RDSClientResolvedConfig | config} for command's `input` shape. + * */ export class RevokeDBSecurityGroupIngressCommand extends $Command< RevokeDBSecurityGroupIngressCommandInput, diff --git a/clients/client-rds/commands/StartActivityStreamCommand.ts b/clients/client-rds/commands/StartActivityStreamCommand.ts index 7b210ff767e3..fafaa3e3498e 100644 --- a/clients/client-rds/commands/StartActivityStreamCommand.ts +++ b/clients/client-rds/commands/StartActivityStreamCommand.ts @@ -24,6 +24,20 @@ export interface StartActivityStreamCommandOutput extends StartActivityStreamRes *

Starts a database activity stream to monitor activity on the database. * For more information, see Database Activity Streams * in the Amazon Aurora User Guide.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { RDSClient, StartActivityStreamCommand } from "@aws-sdk/client-rds"; // ES Modules import + * // const { RDSClient, StartActivityStreamCommand } = require("@aws-sdk/client-rds"); // CommonJS import + * const client = new RDSClient(config); + * const command = new StartActivityStreamCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link StartActivityStreamCommandInput} for command's `input` shape. + * @see {@link StartActivityStreamCommandOutput} for command's `response` shape. + * @see {@link RDSClientResolvedConfig | config} for command's `input` shape. + * */ export class StartActivityStreamCommand extends $Command< StartActivityStreamCommandInput, diff --git a/clients/client-rds/commands/StartDBClusterCommand.ts b/clients/client-rds/commands/StartDBClusterCommand.ts index 69d8498451ab..32d51db6f5b7 100644 --- a/clients/client-rds/commands/StartDBClusterCommand.ts +++ b/clients/client-rds/commands/StartDBClusterCommand.ts @@ -31,6 +31,20 @@ export interface StartDBClusterCommandOutput extends StartDBClusterResult, __Met * *

This action only applies to Aurora DB clusters.

* + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { RDSClient, StartDBClusterCommand } from "@aws-sdk/client-rds"; // ES Modules import + * // const { RDSClient, StartDBClusterCommand } = require("@aws-sdk/client-rds"); // CommonJS import + * const client = new RDSClient(config); + * const command = new StartDBClusterCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link StartDBClusterCommandInput} for command's `input` shape. + * @see {@link StartDBClusterCommandOutput} for command's `response` shape. + * @see {@link RDSClientResolvedConfig | config} for command's `input` shape. + * */ export class StartDBClusterCommand extends $Command< StartDBClusterCommandInput, diff --git a/clients/client-rds/commands/StartDBInstanceAutomatedBackupsReplicationCommand.ts b/clients/client-rds/commands/StartDBInstanceAutomatedBackupsReplicationCommand.ts index 218d40c41ef6..6e4724d3660e 100644 --- a/clients/client-rds/commands/StartDBInstanceAutomatedBackupsReplicationCommand.ts +++ b/clients/client-rds/commands/StartDBInstanceAutomatedBackupsReplicationCommand.ts @@ -32,6 +32,20 @@ export interface StartDBInstanceAutomatedBackupsReplicationCommandOutput *

For more information, see * Replicating Automated Backups to Another AWS Region in the Amazon RDS User Guide. *

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { RDSClient, StartDBInstanceAutomatedBackupsReplicationCommand } from "@aws-sdk/client-rds"; // ES Modules import + * // const { RDSClient, StartDBInstanceAutomatedBackupsReplicationCommand } = require("@aws-sdk/client-rds"); // CommonJS import + * const client = new RDSClient(config); + * const command = new StartDBInstanceAutomatedBackupsReplicationCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link StartDBInstanceAutomatedBackupsReplicationCommandInput} for command's `input` shape. + * @see {@link StartDBInstanceAutomatedBackupsReplicationCommandOutput} for command's `response` shape. + * @see {@link RDSClientResolvedConfig | config} for command's `input` shape. + * */ export class StartDBInstanceAutomatedBackupsReplicationCommand extends $Command< StartDBInstanceAutomatedBackupsReplicationCommandInput, diff --git a/clients/client-rds/commands/StartDBInstanceCommand.ts b/clients/client-rds/commands/StartDBInstanceCommand.ts index 198830e89d68..fa9fed9d6960 100644 --- a/clients/client-rds/commands/StartDBInstanceCommand.ts +++ b/clients/client-rds/commands/StartDBInstanceCommand.ts @@ -37,6 +37,20 @@ export interface StartDBInstanceCommandOutput extends StartDBInstanceResult, __M * For Aurora DB clusters, use StartDBCluster instead. *

* + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { RDSClient, StartDBInstanceCommand } from "@aws-sdk/client-rds"; // ES Modules import + * // const { RDSClient, StartDBInstanceCommand } = require("@aws-sdk/client-rds"); // CommonJS import + * const client = new RDSClient(config); + * const command = new StartDBInstanceCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link StartDBInstanceCommandInput} for command's `input` shape. + * @see {@link StartDBInstanceCommandOutput} for command's `response` shape. + * @see {@link RDSClientResolvedConfig | config} for command's `input` shape. + * */ export class StartDBInstanceCommand extends $Command< StartDBInstanceCommandInput, diff --git a/clients/client-rds/commands/StartExportTaskCommand.ts b/clients/client-rds/commands/StartExportTaskCommand.ts index c93334ca8d11..1398e32e7828 100644 --- a/clients/client-rds/commands/StartExportTaskCommand.ts +++ b/clients/client-rds/commands/StartExportTaskCommand.ts @@ -25,6 +25,20 @@ export interface StartExportTaskCommandOutput extends ExportTask, __MetadataBear *

Starts an export of a snapshot to Amazon S3. * The provided IAM role must have access to the S3 bucket. *

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { RDSClient, StartExportTaskCommand } from "@aws-sdk/client-rds"; // ES Modules import + * // const { RDSClient, StartExportTaskCommand } = require("@aws-sdk/client-rds"); // CommonJS import + * const client = new RDSClient(config); + * const command = new StartExportTaskCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link StartExportTaskCommandInput} for command's `input` shape. + * @see {@link StartExportTaskCommandOutput} for command's `response` shape. + * @see {@link RDSClientResolvedConfig | config} for command's `input` shape. + * */ export class StartExportTaskCommand extends $Command< StartExportTaskCommandInput, diff --git a/clients/client-rds/commands/StopActivityStreamCommand.ts b/clients/client-rds/commands/StopActivityStreamCommand.ts index b15565068616..ee23d037e230 100644 --- a/clients/client-rds/commands/StopActivityStreamCommand.ts +++ b/clients/client-rds/commands/StopActivityStreamCommand.ts @@ -26,6 +26,20 @@ export interface StopActivityStreamCommandOutput extends StopActivityStreamRespo *

For more information, see * Database Activity Streams * in the Amazon Aurora User Guide.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { RDSClient, StopActivityStreamCommand } from "@aws-sdk/client-rds"; // ES Modules import + * // const { RDSClient, StopActivityStreamCommand } = require("@aws-sdk/client-rds"); // CommonJS import + * const client = new RDSClient(config); + * const command = new StopActivityStreamCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link StopActivityStreamCommandInput} for command's `input` shape. + * @see {@link StopActivityStreamCommandOutput} for command's `response` shape. + * @see {@link RDSClientResolvedConfig | config} for command's `input` shape. + * */ export class StopActivityStreamCommand extends $Command< StopActivityStreamCommandInput, diff --git a/clients/client-rds/commands/StopDBClusterCommand.ts b/clients/client-rds/commands/StopDBClusterCommand.ts index aa095e313aae..e4fc86984a06 100644 --- a/clients/client-rds/commands/StopDBClusterCommand.ts +++ b/clients/client-rds/commands/StopDBClusterCommand.ts @@ -34,6 +34,20 @@ export interface StopDBClusterCommandOutput extends StopDBClusterResult, __Metad * *

This action only applies to Aurora DB clusters.

* + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { RDSClient, StopDBClusterCommand } from "@aws-sdk/client-rds"; // ES Modules import + * // const { RDSClient, StopDBClusterCommand } = require("@aws-sdk/client-rds"); // CommonJS import + * const client = new RDSClient(config); + * const command = new StopDBClusterCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link StopDBClusterCommandInput} for command's `input` shape. + * @see {@link StopDBClusterCommandOutput} for command's `response` shape. + * @see {@link RDSClientResolvedConfig | config} for command's `input` shape. + * */ export class StopDBClusterCommand extends $Command< StopDBClusterCommandInput, diff --git a/clients/client-rds/commands/StopDBInstanceAutomatedBackupsReplicationCommand.ts b/clients/client-rds/commands/StopDBInstanceAutomatedBackupsReplicationCommand.ts index bd44463b2e5c..80051e26069b 100644 --- a/clients/client-rds/commands/StopDBInstanceAutomatedBackupsReplicationCommand.ts +++ b/clients/client-rds/commands/StopDBInstanceAutomatedBackupsReplicationCommand.ts @@ -31,6 +31,20 @@ export interface StopDBInstanceAutomatedBackupsReplicationCommandOutput *

For more information, see * Replicating Automated Backups to Another AWS Region in the Amazon RDS User Guide. *

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { RDSClient, StopDBInstanceAutomatedBackupsReplicationCommand } from "@aws-sdk/client-rds"; // ES Modules import + * // const { RDSClient, StopDBInstanceAutomatedBackupsReplicationCommand } = require("@aws-sdk/client-rds"); // CommonJS import + * const client = new RDSClient(config); + * const command = new StopDBInstanceAutomatedBackupsReplicationCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link StopDBInstanceAutomatedBackupsReplicationCommandInput} for command's `input` shape. + * @see {@link StopDBInstanceAutomatedBackupsReplicationCommandOutput} for command's `response` shape. + * @see {@link RDSClientResolvedConfig | config} for command's `input` shape. + * */ export class StopDBInstanceAutomatedBackupsReplicationCommand extends $Command< StopDBInstanceAutomatedBackupsReplicationCommandInput, diff --git a/clients/client-rds/commands/StopDBInstanceCommand.ts b/clients/client-rds/commands/StopDBInstanceCommand.ts index 974483e7b54c..1b55c58abec1 100644 --- a/clients/client-rds/commands/StopDBInstanceCommand.ts +++ b/clients/client-rds/commands/StopDBInstanceCommand.ts @@ -39,6 +39,20 @@ export interface StopDBInstanceCommandOutput extends StopDBInstanceResult, __Met * For Aurora clusters, use StopDBCluster instead. *

* + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { RDSClient, StopDBInstanceCommand } from "@aws-sdk/client-rds"; // ES Modules import + * // const { RDSClient, StopDBInstanceCommand } = require("@aws-sdk/client-rds"); // CommonJS import + * const client = new RDSClient(config); + * const command = new StopDBInstanceCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link StopDBInstanceCommandInput} for command's `input` shape. + * @see {@link StopDBInstanceCommandOutput} for command's `response` shape. + * @see {@link RDSClientResolvedConfig | config} for command's `input` shape. + * */ export class StopDBInstanceCommand extends $Command< StopDBInstanceCommandInput, diff --git a/clients/client-rds/models/models_0.ts b/clients/client-rds/models/models_0.ts index 8d5b6655ada8..5a7b9e7462df 100644 --- a/clients/client-rds/models/models_0.ts +++ b/clients/client-rds/models/models_0.ts @@ -131,6 +131,9 @@ export interface AccountQuota { } export namespace AccountQuota { + /** + * @internal + */ export const filterSensitiveLog = (obj: AccountQuota): any => ({ ...obj, }); @@ -148,6 +151,9 @@ export interface AccountAttributesMessage { } export namespace AccountAttributesMessage { + /** + * @internal + */ export const filterSensitiveLog = (obj: AccountAttributesMessage): any => ({ ...obj, }); @@ -177,6 +183,9 @@ export interface AddRoleToDBClusterMessage { } export namespace AddRoleToDBClusterMessage { + /** + * @internal + */ export const filterSensitiveLog = (obj: AddRoleToDBClusterMessage): any => ({ ...obj, }); @@ -194,6 +203,9 @@ export interface DBClusterNotFoundFault extends __SmithyException, $MetadataBear } export namespace DBClusterNotFoundFault { + /** + * @internal + */ export const filterSensitiveLog = (obj: DBClusterNotFoundFault): any => ({ ...obj, }); @@ -209,6 +221,9 @@ export interface DBClusterRoleAlreadyExistsFault extends __SmithyException, $Met } export namespace DBClusterRoleAlreadyExistsFault { + /** + * @internal + */ export const filterSensitiveLog = (obj: DBClusterRoleAlreadyExistsFault): any => ({ ...obj, }); @@ -224,6 +239,9 @@ export interface DBClusterRoleQuotaExceededFault extends __SmithyException, $Met } export namespace DBClusterRoleQuotaExceededFault { + /** + * @internal + */ export const filterSensitiveLog = (obj: DBClusterRoleQuotaExceededFault): any => ({ ...obj, }); @@ -239,6 +257,9 @@ export interface InvalidDBClusterStateFault extends __SmithyException, $Metadata } export namespace InvalidDBClusterStateFault { + /** + * @internal + */ export const filterSensitiveLog = (obj: InvalidDBClusterStateFault): any => ({ ...obj, }); @@ -265,6 +286,9 @@ export interface AddRoleToDBInstanceMessage { } export namespace AddRoleToDBInstanceMessage { + /** + * @internal + */ export const filterSensitiveLog = (obj: AddRoleToDBInstanceMessage): any => ({ ...obj, }); @@ -282,6 +306,9 @@ export interface DBInstanceNotFoundFault extends __SmithyException, $MetadataBea } export namespace DBInstanceNotFoundFault { + /** + * @internal + */ export const filterSensitiveLog = (obj: DBInstanceNotFoundFault): any => ({ ...obj, }); @@ -297,6 +324,9 @@ export interface DBInstanceRoleAlreadyExistsFault extends __SmithyException, $Me } export namespace DBInstanceRoleAlreadyExistsFault { + /** + * @internal + */ export const filterSensitiveLog = (obj: DBInstanceRoleAlreadyExistsFault): any => ({ ...obj, }); @@ -312,6 +342,9 @@ export interface DBInstanceRoleQuotaExceededFault extends __SmithyException, $Me } export namespace DBInstanceRoleQuotaExceededFault { + /** + * @internal + */ export const filterSensitiveLog = (obj: DBInstanceRoleQuotaExceededFault): any => ({ ...obj, }); @@ -327,6 +360,9 @@ export interface InvalidDBInstanceStateFault extends __SmithyException, $Metadat } export namespace InvalidDBInstanceStateFault { + /** + * @internal + */ export const filterSensitiveLog = (obj: InvalidDBInstanceStateFault): any => ({ ...obj, }); @@ -369,6 +405,9 @@ export interface AddSourceIdentifierToSubscriptionMessage { } export namespace AddSourceIdentifierToSubscriptionMessage { + /** + * @internal + */ export const filterSensitiveLog = (obj: AddSourceIdentifierToSubscriptionMessage): any => ({ ...obj, }); @@ -433,6 +472,9 @@ export interface EventSubscription { } export namespace EventSubscription { + /** + * @internal + */ export const filterSensitiveLog = (obj: EventSubscription): any => ({ ...obj, }); @@ -446,6 +488,9 @@ export interface AddSourceIdentifierToSubscriptionResult { } export namespace AddSourceIdentifierToSubscriptionResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: AddSourceIdentifierToSubscriptionResult): any => ({ ...obj, }); @@ -461,6 +506,9 @@ export interface SourceNotFoundFault extends __SmithyException, $MetadataBearer } export namespace SourceNotFoundFault { + /** + * @internal + */ export const filterSensitiveLog = (obj: SourceNotFoundFault): any => ({ ...obj, }); @@ -476,6 +524,9 @@ export interface SubscriptionNotFoundFault extends __SmithyException, $MetadataB } export namespace SubscriptionNotFoundFault { + /** + * @internal + */ export const filterSensitiveLog = (obj: SubscriptionNotFoundFault): any => ({ ...obj, }); @@ -497,6 +548,9 @@ export interface Tag { } export namespace Tag { + /** + * @internal + */ export const filterSensitiveLog = (obj: Tag): any => ({ ...obj, }); @@ -521,6 +575,9 @@ export interface AddTagsToResourceMessage { } export namespace AddTagsToResourceMessage { + /** + * @internal + */ export const filterSensitiveLog = (obj: AddTagsToResourceMessage): any => ({ ...obj, }); @@ -536,6 +593,9 @@ export interface DBProxyNotFoundFault extends __SmithyException, $MetadataBearer } export namespace DBProxyNotFoundFault { + /** + * @internal + */ export const filterSensitiveLog = (obj: DBProxyNotFoundFault): any => ({ ...obj, }); @@ -551,6 +611,9 @@ export interface DBProxyTargetGroupNotFoundFault extends __SmithyException, $Met } export namespace DBProxyTargetGroupNotFoundFault { + /** + * @internal + */ export const filterSensitiveLog = (obj: DBProxyTargetGroupNotFoundFault): any => ({ ...obj, }); @@ -568,6 +631,9 @@ export interface DBSnapshotNotFoundFault extends __SmithyException, $MetadataBea } export namespace DBSnapshotNotFoundFault { + /** + * @internal + */ export const filterSensitiveLog = (obj: DBSnapshotNotFoundFault): any => ({ ...obj, }); @@ -619,6 +685,9 @@ export interface ApplyPendingMaintenanceActionMessage { } export namespace ApplyPendingMaintenanceActionMessage { + /** + * @internal + */ export const filterSensitiveLog = (obj: ApplyPendingMaintenanceActionMessage): any => ({ ...obj, }); @@ -672,6 +741,9 @@ export interface PendingMaintenanceAction { } export namespace PendingMaintenanceAction { + /** + * @internal + */ export const filterSensitiveLog = (obj: PendingMaintenanceAction): any => ({ ...obj, }); @@ -693,6 +765,9 @@ export interface ResourcePendingMaintenanceActions { } export namespace ResourcePendingMaintenanceActions { + /** + * @internal + */ export const filterSensitiveLog = (obj: ResourcePendingMaintenanceActions): any => ({ ...obj, }); @@ -706,6 +781,9 @@ export interface ApplyPendingMaintenanceActionResult { } export namespace ApplyPendingMaintenanceActionResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: ApplyPendingMaintenanceActionResult): any => ({ ...obj, }); @@ -721,6 +799,9 @@ export interface ResourceNotFoundFault extends __SmithyException, $MetadataBeare } export namespace ResourceNotFoundFault { + /** + * @internal + */ export const filterSensitiveLog = (obj: ResourceNotFoundFault): any => ({ ...obj, }); @@ -737,6 +818,9 @@ export interface AuthorizationAlreadyExistsFault extends __SmithyException, $Met } export namespace AuthorizationAlreadyExistsFault { + /** + * @internal + */ export const filterSensitiveLog = (obj: AuthorizationAlreadyExistsFault): any => ({ ...obj, }); @@ -752,6 +836,9 @@ export interface AuthorizationQuotaExceededFault extends __SmithyException, $Met } export namespace AuthorizationQuotaExceededFault { + /** + * @internal + */ export const filterSensitiveLog = (obj: AuthorizationQuotaExceededFault): any => ({ ...obj, }); @@ -803,6 +890,9 @@ export interface AuthorizeDBSecurityGroupIngressMessage { } export namespace AuthorizeDBSecurityGroupIngressMessage { + /** + * @internal + */ export const filterSensitiveLog = (obj: AuthorizeDBSecurityGroupIngressMessage): any => ({ ...obj, }); @@ -854,6 +944,9 @@ export interface EC2SecurityGroup { } export namespace EC2SecurityGroup { + /** + * @internal + */ export const filterSensitiveLog = (obj: EC2SecurityGroup): any => ({ ...obj, }); @@ -877,6 +970,9 @@ export interface IPRange { } export namespace IPRange { + /** + * @internal + */ export const filterSensitiveLog = (obj: IPRange): any => ({ ...obj, }); @@ -931,6 +1027,9 @@ export interface DBSecurityGroup { } export namespace DBSecurityGroup { + /** + * @internal + */ export const filterSensitiveLog = (obj: DBSecurityGroup): any => ({ ...obj, }); @@ -948,6 +1047,9 @@ export interface AuthorizeDBSecurityGroupIngressResult { } export namespace AuthorizeDBSecurityGroupIngressResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: AuthorizeDBSecurityGroupIngressResult): any => ({ ...obj, }); @@ -965,6 +1067,9 @@ export interface DBSecurityGroupNotFoundFault extends __SmithyException, $Metada } export namespace DBSecurityGroupNotFoundFault { + /** + * @internal + */ export const filterSensitiveLog = (obj: DBSecurityGroupNotFoundFault): any => ({ ...obj, }); @@ -980,6 +1085,9 @@ export interface InvalidDBSecurityGroupStateFault extends __SmithyException, $Me } export namespace InvalidDBSecurityGroupStateFault { + /** + * @internal + */ export const filterSensitiveLog = (obj: InvalidDBSecurityGroupStateFault): any => ({ ...obj, }); @@ -1048,6 +1156,9 @@ export interface BacktrackDBClusterMessage { } export namespace BacktrackDBClusterMessage { + /** + * @internal + */ export const filterSensitiveLog = (obj: BacktrackDBClusterMessage): any => ({ ...obj, }); @@ -1108,6 +1219,9 @@ export interface DBClusterBacktrack { } export namespace DBClusterBacktrack { + /** + * @internal + */ export const filterSensitiveLog = (obj: DBClusterBacktrack): any => ({ ...obj, }); @@ -1121,6 +1235,9 @@ export interface CancelExportTaskMessage { } export namespace CancelExportTaskMessage { + /** + * @internal + */ export const filterSensitiveLog = (obj: CancelExportTaskMessage): any => ({ ...obj, }); @@ -1237,6 +1354,9 @@ export interface ExportTask { } export namespace ExportTask { + /** + * @internal + */ export const filterSensitiveLog = (obj: ExportTask): any => ({ ...obj, }); @@ -1252,6 +1372,9 @@ export interface ExportTaskNotFoundFault extends __SmithyException, $MetadataBea } export namespace ExportTaskNotFoundFault { + /** + * @internal + */ export const filterSensitiveLog = (obj: ExportTaskNotFoundFault): any => ({ ...obj, }); @@ -1267,6 +1390,9 @@ export interface InvalidExportTaskStateFault extends __SmithyException, $Metadat } export namespace InvalidExportTaskStateFault { + /** + * @internal + */ export const filterSensitiveLog = (obj: InvalidExportTaskStateFault): any => ({ ...obj, }); @@ -1325,6 +1451,9 @@ export interface CopyDBClusterParameterGroupMessage { } export namespace CopyDBClusterParameterGroupMessage { + /** + * @internal + */ export const filterSensitiveLog = (obj: CopyDBClusterParameterGroupMessage): any => ({ ...obj, }); @@ -1359,6 +1488,9 @@ export interface DBClusterParameterGroup { } export namespace DBClusterParameterGroup { + /** + * @internal + */ export const filterSensitiveLog = (obj: DBClusterParameterGroup): any => ({ ...obj, }); @@ -1375,6 +1507,9 @@ export interface CopyDBClusterParameterGroupResult { } export namespace CopyDBClusterParameterGroupResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: CopyDBClusterParameterGroupResult): any => ({ ...obj, }); @@ -1390,6 +1525,9 @@ export interface DBParameterGroupAlreadyExistsFault extends __SmithyException, $ } export namespace DBParameterGroupAlreadyExistsFault { + /** + * @internal + */ export const filterSensitiveLog = (obj: DBParameterGroupAlreadyExistsFault): any => ({ ...obj, }); @@ -1408,6 +1546,9 @@ export interface DBParameterGroupNotFoundFault extends __SmithyException, $Metad } export namespace DBParameterGroupNotFoundFault { + /** + * @internal + */ export const filterSensitiveLog = (obj: DBParameterGroupNotFoundFault): any => ({ ...obj, }); @@ -1424,6 +1565,9 @@ export interface DBParameterGroupQuotaExceededFault extends __SmithyException, $ } export namespace DBParameterGroupQuotaExceededFault { + /** + * @internal + */ export const filterSensitiveLog = (obj: DBParameterGroupQuotaExceededFault): any => ({ ...obj, }); @@ -1553,6 +1697,9 @@ export interface CopyDBClusterSnapshotMessage { } export namespace CopyDBClusterSnapshotMessage { + /** + * @internal + */ export const filterSensitiveLog = (obj: CopyDBClusterSnapshotMessage): any => ({ ...obj, }); @@ -1682,6 +1829,9 @@ export interface DBClusterSnapshot { } export namespace DBClusterSnapshot { + /** + * @internal + */ export const filterSensitiveLog = (obj: DBClusterSnapshot): any => ({ ...obj, }); @@ -1699,6 +1849,9 @@ export interface CopyDBClusterSnapshotResult { } export namespace CopyDBClusterSnapshotResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: CopyDBClusterSnapshotResult): any => ({ ...obj, }); @@ -1714,6 +1867,9 @@ export interface DBClusterSnapshotAlreadyExistsFault extends __SmithyException, } export namespace DBClusterSnapshotAlreadyExistsFault { + /** + * @internal + */ export const filterSensitiveLog = (obj: DBClusterSnapshotAlreadyExistsFault): any => ({ ...obj, }); @@ -1731,6 +1887,9 @@ export interface DBClusterSnapshotNotFoundFault extends __SmithyException, $Meta } export namespace DBClusterSnapshotNotFoundFault { + /** + * @internal + */ export const filterSensitiveLog = (obj: DBClusterSnapshotNotFoundFault): any => ({ ...obj, }); @@ -1746,6 +1905,9 @@ export interface InvalidDBClusterSnapshotStateFault extends __SmithyException, $ } export namespace InvalidDBClusterSnapshotStateFault { + /** + * @internal + */ export const filterSensitiveLog = (obj: InvalidDBClusterSnapshotStateFault): any => ({ ...obj, }); @@ -1761,6 +1923,9 @@ export interface KMSKeyNotAccessibleFault extends __SmithyException, $MetadataBe } export namespace KMSKeyNotAccessibleFault { + /** + * @internal + */ export const filterSensitiveLog = (obj: KMSKeyNotAccessibleFault): any => ({ ...obj, }); @@ -1777,6 +1942,9 @@ export interface SnapshotQuotaExceededFault extends __SmithyException, $Metadata } export namespace SnapshotQuotaExceededFault { + /** + * @internal + */ export const filterSensitiveLog = (obj: SnapshotQuotaExceededFault): any => ({ ...obj, }); @@ -1839,6 +2007,9 @@ export interface CopyDBParameterGroupMessage { } export namespace CopyDBParameterGroupMessage { + /** + * @internal + */ export const filterSensitiveLog = (obj: CopyDBParameterGroupMessage): any => ({ ...obj, }); @@ -1873,6 +2044,9 @@ export interface DBParameterGroup { } export namespace DBParameterGroup { + /** + * @internal + */ export const filterSensitiveLog = (obj: DBParameterGroup): any => ({ ...obj, }); @@ -1889,6 +2063,9 @@ export interface CopyDBParameterGroupResult { } export namespace CopyDBParameterGroupResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: CopyDBParameterGroupResult): any => ({ ...obj, }); @@ -2077,6 +2254,9 @@ export interface CopyDBSnapshotMessage { } export namespace CopyDBSnapshotMessage { + /** + * @internal + */ export const filterSensitiveLog = (obj: CopyDBSnapshotMessage): any => ({ ...obj, }); @@ -2168,6 +2348,9 @@ export interface ProcessorFeature { } export namespace ProcessorFeature { + /** + * @internal + */ export const filterSensitiveLog = (obj: ProcessorFeature): any => ({ ...obj, }); @@ -2342,6 +2525,9 @@ export interface DBSnapshot { } export namespace DBSnapshot { + /** + * @internal + */ export const filterSensitiveLog = (obj: DBSnapshot): any => ({ ...obj, }); @@ -2359,6 +2545,9 @@ export interface CopyDBSnapshotResult { } export namespace CopyDBSnapshotResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: CopyDBSnapshotResult): any => ({ ...obj, }); @@ -2376,6 +2565,9 @@ export interface CustomAvailabilityZoneNotFoundFault extends __SmithyException, } export namespace CustomAvailabilityZoneNotFoundFault { + /** + * @internal + */ export const filterSensitiveLog = (obj: CustomAvailabilityZoneNotFoundFault): any => ({ ...obj, }); @@ -2393,6 +2585,9 @@ export interface DBSnapshotAlreadyExistsFault extends __SmithyException, $Metada } export namespace DBSnapshotAlreadyExistsFault { + /** + * @internal + */ export const filterSensitiveLog = (obj: DBSnapshotAlreadyExistsFault): any => ({ ...obj, }); @@ -2408,6 +2603,9 @@ export interface InvalidDBSnapshotStateFault extends __SmithyException, $Metadat } export namespace InvalidDBSnapshotStateFault { + /** + * @internal + */ export const filterSensitiveLog = (obj: InvalidDBSnapshotStateFault): any => ({ ...obj, }); @@ -2465,6 +2663,9 @@ export interface CopyOptionGroupMessage { } export namespace CopyOptionGroupMessage { + /** + * @internal + */ export const filterSensitiveLog = (obj: CopyOptionGroupMessage): any => ({ ...obj, }); @@ -2508,6 +2709,9 @@ export interface DBSecurityGroupMembership { } export namespace DBSecurityGroupMembership { + /** + * @internal + */ export const filterSensitiveLog = (obj: DBSecurityGroupMembership): any => ({ ...obj, }); @@ -2564,6 +2768,9 @@ export interface OptionSetting { } export namespace OptionSetting { + /** + * @internal + */ export const filterSensitiveLog = (obj: OptionSetting): any => ({ ...obj, }); @@ -2585,6 +2792,9 @@ export interface VpcSecurityGroupMembership { } export namespace VpcSecurityGroupMembership { + /** + * @internal + */ export const filterSensitiveLog = (obj: VpcSecurityGroupMembership): any => ({ ...obj, }); @@ -2641,6 +2851,9 @@ export interface Option { } export namespace Option { + /** + * @internal + */ export const filterSensitiveLog = (obj: Option): any => ({ ...obj, }); @@ -2700,6 +2913,9 @@ export interface OptionGroup { } export namespace OptionGroup { + /** + * @internal + */ export const filterSensitiveLog = (obj: OptionGroup): any => ({ ...obj, }); @@ -2713,6 +2929,9 @@ export interface CopyOptionGroupResult { } export namespace CopyOptionGroupResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: CopyOptionGroupResult): any => ({ ...obj, }); @@ -2728,6 +2947,9 @@ export interface OptionGroupAlreadyExistsFault extends __SmithyException, $Metad } export namespace OptionGroupAlreadyExistsFault { + /** + * @internal + */ export const filterSensitiveLog = (obj: OptionGroupAlreadyExistsFault): any => ({ ...obj, }); @@ -2743,6 +2965,9 @@ export interface OptionGroupNotFoundFault extends __SmithyException, $MetadataBe } export namespace OptionGroupNotFoundFault { + /** + * @internal + */ export const filterSensitiveLog = (obj: OptionGroupNotFoundFault): any => ({ ...obj, }); @@ -2758,6 +2983,9 @@ export interface OptionGroupQuotaExceededFault extends __SmithyException, $Metad } export namespace OptionGroupQuotaExceededFault { + /** + * @internal + */ export const filterSensitiveLog = (obj: OptionGroupQuotaExceededFault): any => ({ ...obj, }); @@ -2792,6 +3020,9 @@ export interface CreateCustomAvailabilityZoneMessage { } export namespace CreateCustomAvailabilityZoneMessage { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateCustomAvailabilityZoneMessage): any => ({ ...obj, }); @@ -2837,6 +3068,9 @@ export interface VpnDetails { } export namespace VpnDetails { + /** + * @internal + */ export const filterSensitiveLog = (obj: VpnDetails): any => ({ ...obj, ...(obj.VpnPSK && { VpnPSK: SENSITIVE_STRING }), @@ -2875,6 +3109,9 @@ export interface CustomAvailabilityZone { } export namespace CustomAvailabilityZone { + /** + * @internal + */ export const filterSensitiveLog = (obj: CustomAvailabilityZone): any => ({ ...obj, ...(obj.VpnDetails && { VpnDetails: VpnDetails.filterSensitiveLog(obj.VpnDetails) }), @@ -2893,6 +3130,9 @@ export interface CreateCustomAvailabilityZoneResult { } export namespace CreateCustomAvailabilityZoneResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateCustomAvailabilityZoneResult): any => ({ ...obj, ...(obj.CustomAvailabilityZone && { @@ -2913,6 +3153,9 @@ export interface CustomAvailabilityZoneAlreadyExistsFault extends __SmithyExcept } export namespace CustomAvailabilityZoneAlreadyExistsFault { + /** + * @internal + */ export const filterSensitiveLog = (obj: CustomAvailabilityZoneAlreadyExistsFault): any => ({ ...obj, }); @@ -2928,6 +3171,9 @@ export interface CustomAvailabilityZoneQuotaExceededFault extends __SmithyExcept } export namespace CustomAvailabilityZoneQuotaExceededFault { + /** + * @internal + */ export const filterSensitiveLog = (obj: CustomAvailabilityZoneQuotaExceededFault): any => ({ ...obj, }); @@ -2988,6 +3234,9 @@ export interface ScalingConfiguration { } export namespace ScalingConfiguration { + /** + * @internal + */ export const filterSensitiveLog = (obj: ScalingConfiguration): any => ({ ...obj, }); @@ -3426,6 +3675,9 @@ export interface CreateDBClusterMessage { } export namespace CreateDBClusterMessage { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateDBClusterMessage): any => ({ ...obj, }); @@ -3471,6 +3723,9 @@ export interface DBClusterRole { } export namespace DBClusterRole { + /** + * @internal + */ export const filterSensitiveLog = (obj: DBClusterRole): any => ({ ...obj, }); @@ -3506,6 +3761,9 @@ export interface DBClusterMember { } export namespace DBClusterMember { + /** + * @internal + */ export const filterSensitiveLog = (obj: DBClusterMember): any => ({ ...obj, }); @@ -3527,6 +3785,9 @@ export interface DBClusterOptionGroupStatus { } export namespace DBClusterOptionGroupStatus { + /** + * @internal + */ export const filterSensitiveLog = (obj: DBClusterOptionGroupStatus): any => ({ ...obj, }); @@ -3558,6 +3819,9 @@ export interface DomainMembership { } export namespace DomainMembership { + /** + * @internal + */ export const filterSensitiveLog = (obj: DomainMembership): any => ({ ...obj, }); @@ -3587,6 +3851,9 @@ export interface PendingCloudwatchLogsExports { } export namespace PendingCloudwatchLogsExports { + /** + * @internal + */ export const filterSensitiveLog = (obj: PendingCloudwatchLogsExports): any => ({ ...obj, }); @@ -3624,6 +3891,9 @@ export interface ClusterPendingModifiedValues { } export namespace ClusterPendingModifiedValues { + /** + * @internal + */ export const filterSensitiveLog = (obj: ClusterPendingModifiedValues): any => ({ ...obj, }); @@ -3668,6 +3938,9 @@ export interface ScalingConfigurationInfo { } export namespace ScalingConfigurationInfo { + /** + * @internal + */ export const filterSensitiveLog = (obj: ScalingConfigurationInfo): any => ({ ...obj, }); @@ -4012,6 +4285,9 @@ export interface DBCluster { } export namespace DBCluster { + /** + * @internal + */ export const filterSensitiveLog = (obj: DBCluster): any => ({ ...obj, }); @@ -4029,6 +4305,9 @@ export interface CreateDBClusterResult { } export namespace CreateDBClusterResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateDBClusterResult): any => ({ ...obj, }); @@ -4044,6 +4323,9 @@ export interface DBClusterAlreadyExistsFault extends __SmithyException, $Metadat } export namespace DBClusterAlreadyExistsFault { + /** + * @internal + */ export const filterSensitiveLog = (obj: DBClusterAlreadyExistsFault): any => ({ ...obj, }); @@ -4061,6 +4343,9 @@ export interface DBClusterParameterGroupNotFoundFault extends __SmithyException, } export namespace DBClusterParameterGroupNotFoundFault { + /** + * @internal + */ export const filterSensitiveLog = (obj: DBClusterParameterGroupNotFoundFault): any => ({ ...obj, }); @@ -4077,6 +4362,9 @@ export interface DBClusterQuotaExceededFault extends __SmithyException, $Metadat } export namespace DBClusterQuotaExceededFault { + /** + * @internal + */ export const filterSensitiveLog = (obj: DBClusterQuotaExceededFault): any => ({ ...obj, }); @@ -4092,6 +4380,9 @@ export interface DBSubnetGroupDoesNotCoverEnoughAZs extends __SmithyException, $ } export namespace DBSubnetGroupDoesNotCoverEnoughAZs { + /** + * @internal + */ export const filterSensitiveLog = (obj: DBSubnetGroupDoesNotCoverEnoughAZs): any => ({ ...obj, }); @@ -4109,6 +4400,9 @@ export interface DBSubnetGroupNotFoundFault extends __SmithyException, $Metadata } export namespace DBSubnetGroupNotFoundFault { + /** + * @internal + */ export const filterSensitiveLog = (obj: DBSubnetGroupNotFoundFault): any => ({ ...obj, }); @@ -4126,6 +4420,9 @@ export interface DomainNotFoundFault extends __SmithyException, $MetadataBearer } export namespace DomainNotFoundFault { + /** + * @internal + */ export const filterSensitiveLog = (obj: DomainNotFoundFault): any => ({ ...obj, }); @@ -4141,6 +4438,9 @@ export interface GlobalClusterNotFoundFault extends __SmithyException, $Metadata } export namespace GlobalClusterNotFoundFault { + /** + * @internal + */ export const filterSensitiveLog = (obj: GlobalClusterNotFoundFault): any => ({ ...obj, }); @@ -4158,6 +4458,9 @@ export interface InsufficientStorageClusterCapacityFault extends __SmithyExcepti } export namespace InsufficientStorageClusterCapacityFault { + /** + * @internal + */ export const filterSensitiveLog = (obj: InsufficientStorageClusterCapacityFault): any => ({ ...obj, }); @@ -4173,6 +4476,9 @@ export interface InvalidDBSubnetGroupStateFault extends __SmithyException, $Meta } export namespace InvalidDBSubnetGroupStateFault { + /** + * @internal + */ export const filterSensitiveLog = (obj: InvalidDBSubnetGroupStateFault): any => ({ ...obj, }); @@ -4188,6 +4494,9 @@ export interface InvalidGlobalClusterStateFault extends __SmithyException, $Meta } export namespace InvalidGlobalClusterStateFault { + /** + * @internal + */ export const filterSensitiveLog = (obj: InvalidGlobalClusterStateFault): any => ({ ...obj, }); @@ -4203,6 +4512,9 @@ export interface InvalidSubnet extends __SmithyException, $MetadataBearer { } export namespace InvalidSubnet { + /** + * @internal + */ export const filterSensitiveLog = (obj: InvalidSubnet): any => ({ ...obj, }); @@ -4219,6 +4531,9 @@ export interface InvalidVPCNetworkStateFault extends __SmithyException, $Metadat } export namespace InvalidVPCNetworkStateFault { + /** + * @internal + */ export const filterSensitiveLog = (obj: InvalidVPCNetworkStateFault): any => ({ ...obj, }); @@ -4235,6 +4550,9 @@ export interface StorageQuotaExceededFault extends __SmithyException, $MetadataB } export namespace StorageQuotaExceededFault { + /** + * @internal + */ export const filterSensitiveLog = (obj: StorageQuotaExceededFault): any => ({ ...obj, }); @@ -4276,6 +4594,9 @@ export interface CreateDBClusterEndpointMessage { } export namespace CreateDBClusterEndpointMessage { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateDBClusterEndpointMessage): any => ({ ...obj, }); @@ -4367,6 +4688,9 @@ export interface DBClusterEndpoint { } export namespace DBClusterEndpoint { + /** + * @internal + */ export const filterSensitiveLog = (obj: DBClusterEndpoint): any => ({ ...obj, }); @@ -4382,6 +4706,9 @@ export interface DBClusterEndpointAlreadyExistsFault extends __SmithyException, } export namespace DBClusterEndpointAlreadyExistsFault { + /** + * @internal + */ export const filterSensitiveLog = (obj: DBClusterEndpointAlreadyExistsFault): any => ({ ...obj, }); @@ -4397,6 +4724,9 @@ export interface DBClusterEndpointQuotaExceededFault extends __SmithyException, } export namespace DBClusterEndpointQuotaExceededFault { + /** + * @internal + */ export const filterSensitiveLog = (obj: DBClusterEndpointQuotaExceededFault): any => ({ ...obj, }); @@ -4448,6 +4778,9 @@ export interface CreateDBClusterParameterGroupMessage { } export namespace CreateDBClusterParameterGroupMessage { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateDBClusterParameterGroupMessage): any => ({ ...obj, }); @@ -4464,6 +4797,9 @@ export interface CreateDBClusterParameterGroupResult { } export namespace CreateDBClusterParameterGroupResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateDBClusterParameterGroupResult): any => ({ ...obj, }); @@ -4512,6 +4848,9 @@ export interface CreateDBClusterSnapshotMessage { } export namespace CreateDBClusterSnapshotMessage { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateDBClusterSnapshotMessage): any => ({ ...obj, }); @@ -4529,6 +4868,9 @@ export interface CreateDBClusterSnapshotResult { } export namespace CreateDBClusterSnapshotResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateDBClusterSnapshotResult): any => ({ ...obj, }); @@ -4547,6 +4889,9 @@ export interface AuthorizationNotFoundFault extends __SmithyException, $Metadata } export namespace AuthorizationNotFoundFault { + /** + * @internal + */ export const filterSensitiveLog = (obj: AuthorizationNotFoundFault): any => ({ ...obj, }); @@ -4559,6 +4904,9 @@ export interface BackupPolicyNotFoundFault extends __SmithyException, $MetadataB } export namespace BackupPolicyNotFoundFault { + /** + * @internal + */ export const filterSensitiveLog = (obj: BackupPolicyNotFoundFault): any => ({ ...obj, }); @@ -5627,6 +5975,9 @@ export interface CreateDBInstanceMessage { } export namespace CreateDBInstanceMessage { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateDBInstanceMessage): any => ({ ...obj, }); @@ -5673,6 +6024,9 @@ export interface DBInstanceRole { } export namespace DBInstanceRole { + /** + * @internal + */ export const filterSensitiveLog = (obj: DBInstanceRole): any => ({ ...obj, }); @@ -5689,6 +6043,9 @@ export interface DBInstanceAutomatedBackupsReplication { } export namespace DBInstanceAutomatedBackupsReplication { + /** + * @internal + */ export const filterSensitiveLog = (obj: DBInstanceAutomatedBackupsReplication): any => ({ ...obj, }); @@ -5743,6 +6100,9 @@ export interface DBParameterGroupStatus { } export namespace DBParameterGroupStatus { + /** + * @internal + */ export const filterSensitiveLog = (obj: DBParameterGroupStatus): any => ({ ...obj, }); @@ -5761,6 +6121,9 @@ export interface AvailabilityZone { } export namespace AvailabilityZone { + /** + * @internal + */ export const filterSensitiveLog = (obj: AvailabilityZone): any => ({ ...obj, }); @@ -5780,6 +6143,9 @@ export interface Outpost { } export namespace Outpost { + /** + * @internal + */ export const filterSensitiveLog = (obj: Outpost): any => ({ ...obj, }); @@ -5818,6 +6184,9 @@ export interface Subnet { } export namespace Subnet { + /** + * @internal + */ export const filterSensitiveLog = (obj: Subnet): any => ({ ...obj, }); @@ -5865,6 +6234,9 @@ export interface DBSubnetGroup { } export namespace DBSubnetGroup { + /** + * @internal + */ export const filterSensitiveLog = (obj: DBSubnetGroup): any => ({ ...obj, }); @@ -5911,6 +6283,9 @@ export interface Endpoint { } export namespace Endpoint { + /** + * @internal + */ export const filterSensitiveLog = (obj: Endpoint): any => ({ ...obj, }); @@ -5941,6 +6316,9 @@ export interface OptionGroupMembership { } export namespace OptionGroupMembership { + /** + * @internal + */ export const filterSensitiveLog = (obj: OptionGroupMembership): any => ({ ...obj, }); @@ -6039,6 +6417,9 @@ export interface PendingModifiedValues { } export namespace PendingModifiedValues { + /** + * @internal + */ export const filterSensitiveLog = (obj: PendingModifiedValues): any => ({ ...obj, }); @@ -6077,6 +6458,9 @@ export interface DBInstanceStatusInfo { } export namespace DBInstanceStatusInfo { + /** + * @internal + */ export const filterSensitiveLog = (obj: DBInstanceStatusInfo): any => ({ ...obj, }); @@ -6506,6 +6890,9 @@ export interface DBInstance { } export namespace DBInstance { + /** + * @internal + */ export const filterSensitiveLog = (obj: DBInstance): any => ({ ...obj, }); @@ -6522,6 +6909,9 @@ export interface CreateDBInstanceResult { } export namespace CreateDBInstanceResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateDBInstanceResult): any => ({ ...obj, }); @@ -6537,6 +6927,9 @@ export interface DBInstanceAlreadyExistsFault extends __SmithyException, $Metada } export namespace DBInstanceAlreadyExistsFault { + /** + * @internal + */ export const filterSensitiveLog = (obj: DBInstanceAlreadyExistsFault): any => ({ ...obj, }); @@ -6553,6 +6946,9 @@ export interface InstanceQuotaExceededFault extends __SmithyException, $Metadata } export namespace InstanceQuotaExceededFault { + /** + * @internal + */ export const filterSensitiveLog = (obj: InstanceQuotaExceededFault): any => ({ ...obj, }); @@ -6569,6 +6965,9 @@ export interface InsufficientDBInstanceCapacityFault extends __SmithyException, } export namespace InsufficientDBInstanceCapacityFault { + /** + * @internal + */ export const filterSensitiveLog = (obj: InsufficientDBInstanceCapacityFault): any => ({ ...obj, }); @@ -6584,6 +6983,9 @@ export interface ProvisionedIopsNotAvailableInAZFault extends __SmithyException, } export namespace ProvisionedIopsNotAvailableInAZFault { + /** + * @internal + */ export const filterSensitiveLog = (obj: ProvisionedIopsNotAvailableInAZFault): any => ({ ...obj, }); @@ -6600,6 +7002,9 @@ export interface StorageTypeNotSupportedFault extends __SmithyException, $Metada } export namespace StorageTypeNotSupportedFault { + /** + * @internal + */ export const filterSensitiveLog = (obj: StorageTypeNotSupportedFault): any => ({ ...obj, }); @@ -7021,6 +7426,9 @@ export interface CreateDBInstanceReadReplicaMessage { } export namespace CreateDBInstanceReadReplicaMessage { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateDBInstanceReadReplicaMessage): any => ({ ...obj, }); @@ -7037,6 +7445,9 @@ export interface CreateDBInstanceReadReplicaResult { } export namespace CreateDBInstanceReadReplicaResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateDBInstanceReadReplicaResult): any => ({ ...obj, }); @@ -7053,6 +7464,9 @@ export interface DBSubnetGroupNotAllowedFault extends __SmithyException, $Metada } export namespace DBSubnetGroupNotAllowedFault { + /** + * @internal + */ export const filterSensitiveLog = (obj: DBSubnetGroupNotAllowedFault): any => ({ ...obj, }); @@ -7069,6 +7483,9 @@ export interface InvalidDBSubnetGroupFault extends __SmithyException, $MetadataB } export namespace InvalidDBSubnetGroupFault { + /** + * @internal + */ export const filterSensitiveLog = (obj: InvalidDBSubnetGroupFault): any => ({ ...obj, }); @@ -7122,6 +7539,9 @@ export interface CreateDBParameterGroupMessage { } export namespace CreateDBParameterGroupMessage { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateDBParameterGroupMessage): any => ({ ...obj, }); @@ -7138,6 +7558,9 @@ export interface CreateDBParameterGroupResult { } export namespace CreateDBParameterGroupResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateDBParameterGroupResult): any => ({ ...obj, }); @@ -7184,6 +7607,9 @@ export interface UserAuthConfig { } export namespace UserAuthConfig { + /** + * @internal + */ export const filterSensitiveLog = (obj: UserAuthConfig): any => ({ ...obj, }); @@ -7257,6 +7683,9 @@ export interface CreateDBProxyRequest { } export namespace CreateDBProxyRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateDBProxyRequest): any => ({ ...obj, }); @@ -7294,6 +7723,9 @@ export interface UserAuthConfigInfo { } export namespace UserAuthConfigInfo { + /** + * @internal + */ export const filterSensitiveLog = (obj: UserAuthConfigInfo): any => ({ ...obj, }); @@ -7406,6 +7838,9 @@ export interface DBProxy { } export namespace DBProxy { + /** + * @internal + */ export const filterSensitiveLog = (obj: DBProxy): any => ({ ...obj, }); @@ -7419,6 +7854,9 @@ export interface CreateDBProxyResponse { } export namespace CreateDBProxyResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateDBProxyResponse): any => ({ ...obj, }); @@ -7434,6 +7872,9 @@ export interface DBProxyAlreadyExistsFault extends __SmithyException, $MetadataB } export namespace DBProxyAlreadyExistsFault { + /** + * @internal + */ export const filterSensitiveLog = (obj: DBProxyAlreadyExistsFault): any => ({ ...obj, }); @@ -7449,6 +7890,9 @@ export interface DBProxyQuotaExceededFault extends __SmithyException, $MetadataB } export namespace DBProxyQuotaExceededFault { + /** + * @internal + */ export const filterSensitiveLog = (obj: DBProxyQuotaExceededFault): any => ({ ...obj, }); @@ -7498,6 +7942,9 @@ export interface CreateDBProxyEndpointRequest { } export namespace CreateDBProxyEndpointRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateDBProxyEndpointRequest): any => ({ ...obj, }); @@ -7584,6 +8031,9 @@ export interface DBProxyEndpoint { } export namespace DBProxyEndpoint { + /** + * @internal + */ export const filterSensitiveLog = (obj: DBProxyEndpoint): any => ({ ...obj, }); @@ -7599,6 +8049,9 @@ export interface CreateDBProxyEndpointResponse { } export namespace CreateDBProxyEndpointResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateDBProxyEndpointResponse): any => ({ ...obj, }); @@ -7614,6 +8067,9 @@ export interface DBProxyEndpointAlreadyExistsFault extends __SmithyException, $M } export namespace DBProxyEndpointAlreadyExistsFault { + /** + * @internal + */ export const filterSensitiveLog = (obj: DBProxyEndpointAlreadyExistsFault): any => ({ ...obj, }); @@ -7629,6 +8085,9 @@ export interface DBProxyEndpointQuotaExceededFault extends __SmithyException, $M } export namespace DBProxyEndpointQuotaExceededFault { + /** + * @internal + */ export const filterSensitiveLog = (obj: DBProxyEndpointQuotaExceededFault): any => ({ ...obj, }); @@ -7644,6 +8103,9 @@ export interface InvalidDBProxyStateFault extends __SmithyException, $MetadataBe } export namespace InvalidDBProxyStateFault { + /** + * @internal + */ export const filterSensitiveLog = (obj: InvalidDBProxyStateFault): any => ({ ...obj, }); @@ -7687,6 +8149,9 @@ export interface CreateDBSecurityGroupMessage { } export namespace CreateDBSecurityGroupMessage { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateDBSecurityGroupMessage): any => ({ ...obj, }); @@ -7704,6 +8169,9 @@ export interface CreateDBSecurityGroupResult { } export namespace CreateDBSecurityGroupResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateDBSecurityGroupResult): any => ({ ...obj, }); @@ -7722,6 +8190,9 @@ export interface DBSecurityGroupAlreadyExistsFault extends __SmithyException, $M } export namespace DBSecurityGroupAlreadyExistsFault { + /** + * @internal + */ export const filterSensitiveLog = (obj: DBSecurityGroupAlreadyExistsFault): any => ({ ...obj, }); @@ -7737,6 +8208,9 @@ export interface DBSecurityGroupNotSupportedFault extends __SmithyException, $Me } export namespace DBSecurityGroupNotSupportedFault { + /** + * @internal + */ export const filterSensitiveLog = (obj: DBSecurityGroupNotSupportedFault): any => ({ ...obj, }); @@ -7753,6 +8227,9 @@ export interface DBSecurityGroupQuotaExceededFault extends __SmithyException, $M } export namespace DBSecurityGroupQuotaExceededFault { + /** + * @internal + */ export const filterSensitiveLog = (obj: DBSecurityGroupQuotaExceededFault): any => ({ ...obj, }); @@ -7804,6 +8281,9 @@ export interface CreateDBSnapshotMessage { } export namespace CreateDBSnapshotMessage { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateDBSnapshotMessage): any => ({ ...obj, }); @@ -7821,6 +8301,9 @@ export interface CreateDBSnapshotResult { } export namespace CreateDBSnapshotResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateDBSnapshotResult): any => ({ ...obj, }); @@ -7855,6 +8338,9 @@ export interface CreateDBSubnetGroupMessage { } export namespace CreateDBSubnetGroupMessage { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateDBSubnetGroupMessage): any => ({ ...obj, }); @@ -7872,6 +8358,9 @@ export interface CreateDBSubnetGroupResult { } export namespace CreateDBSubnetGroupResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateDBSubnetGroupResult): any => ({ ...obj, }); @@ -7889,6 +8378,9 @@ export interface DBSubnetGroupAlreadyExistsFault extends __SmithyException, $Met } export namespace DBSubnetGroupAlreadyExistsFault { + /** + * @internal + */ export const filterSensitiveLog = (obj: DBSubnetGroupAlreadyExistsFault): any => ({ ...obj, }); @@ -7905,6 +8397,9 @@ export interface DBSubnetGroupQuotaExceededFault extends __SmithyException, $Met } export namespace DBSubnetGroupQuotaExceededFault { + /** + * @internal + */ export const filterSensitiveLog = (obj: DBSubnetGroupQuotaExceededFault): any => ({ ...obj, }); @@ -7921,6 +8416,9 @@ export interface DBSubnetQuotaExceededFault extends __SmithyException, $Metadata } export namespace DBSubnetQuotaExceededFault { + /** + * @internal + */ export const filterSensitiveLog = (obj: DBSubnetQuotaExceededFault): any => ({ ...obj, }); @@ -8005,6 +8503,9 @@ export interface CreateEventSubscriptionMessage { } export namespace CreateEventSubscriptionMessage { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateEventSubscriptionMessage): any => ({ ...obj, }); @@ -8018,6 +8519,9 @@ export interface CreateEventSubscriptionResult { } export namespace CreateEventSubscriptionResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateEventSubscriptionResult): any => ({ ...obj, }); @@ -8033,6 +8537,9 @@ export interface EventSubscriptionQuotaExceededFault extends __SmithyException, } export namespace EventSubscriptionQuotaExceededFault { + /** + * @internal + */ export const filterSensitiveLog = (obj: EventSubscriptionQuotaExceededFault): any => ({ ...obj, }); @@ -8048,6 +8555,9 @@ export interface SNSInvalidTopicFault extends __SmithyException, $MetadataBearer } export namespace SNSInvalidTopicFault { + /** + * @internal + */ export const filterSensitiveLog = (obj: SNSInvalidTopicFault): any => ({ ...obj, }); @@ -8063,6 +8573,9 @@ export interface SNSNoAuthorizationFault extends __SmithyException, $MetadataBea } export namespace SNSNoAuthorizationFault { + /** + * @internal + */ export const filterSensitiveLog = (obj: SNSNoAuthorizationFault): any => ({ ...obj, }); @@ -8078,6 +8591,9 @@ export interface SNSTopicArnNotFoundFault extends __SmithyException, $MetadataBe } export namespace SNSTopicArnNotFoundFault { + /** + * @internal + */ export const filterSensitiveLog = (obj: SNSTopicArnNotFoundFault): any => ({ ...obj, }); @@ -8093,6 +8609,9 @@ export interface SubscriptionAlreadyExistFault extends __SmithyException, $Metad } export namespace SubscriptionAlreadyExistFault { + /** + * @internal + */ export const filterSensitiveLog = (obj: SubscriptionAlreadyExistFault): any => ({ ...obj, }); @@ -8108,6 +8627,9 @@ export interface SubscriptionCategoryNotFoundFault extends __SmithyException, $M } export namespace SubscriptionCategoryNotFoundFault { + /** + * @internal + */ export const filterSensitiveLog = (obj: SubscriptionCategoryNotFoundFault): any => ({ ...obj, }); @@ -8162,6 +8684,9 @@ export interface CreateGlobalClusterMessage { } export namespace CreateGlobalClusterMessage { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateGlobalClusterMessage): any => ({ ...obj, }); @@ -8215,6 +8740,9 @@ export interface FailoverState { } export namespace FailoverState { + /** + * @internal + */ export const filterSensitiveLog = (obj: FailoverState): any => ({ ...obj, }); @@ -8259,6 +8787,9 @@ export interface GlobalClusterMember { } export namespace GlobalClusterMember { + /** + * @internal + */ export const filterSensitiveLog = (obj: GlobalClusterMember): any => ({ ...obj, }); @@ -8344,6 +8875,9 @@ export interface GlobalCluster { } export namespace GlobalCluster { + /** + * @internal + */ export const filterSensitiveLog = (obj: GlobalCluster): any => ({ ...obj, }); @@ -8357,6 +8891,9 @@ export interface CreateGlobalClusterResult { } export namespace CreateGlobalClusterResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateGlobalClusterResult): any => ({ ...obj, }); @@ -8372,6 +8909,9 @@ export interface GlobalClusterAlreadyExistsFault extends __SmithyException, $Met } export namespace GlobalClusterAlreadyExistsFault { + /** + * @internal + */ export const filterSensitiveLog = (obj: GlobalClusterAlreadyExistsFault): any => ({ ...obj, }); @@ -8387,6 +8927,9 @@ export interface GlobalClusterQuotaExceededFault extends __SmithyException, $Met } export namespace GlobalClusterQuotaExceededFault { + /** + * @internal + */ export const filterSensitiveLog = (obj: GlobalClusterQuotaExceededFault): any => ({ ...obj, }); @@ -8496,6 +9039,9 @@ export interface CreateOptionGroupMessage { } export namespace CreateOptionGroupMessage { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateOptionGroupMessage): any => ({ ...obj, }); @@ -8509,6 +9055,9 @@ export interface CreateOptionGroupResult { } export namespace CreateOptionGroupResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateOptionGroupResult): any => ({ ...obj, }); @@ -8522,6 +9071,9 @@ export interface DeleteCustomAvailabilityZoneMessage { } export namespace DeleteCustomAvailabilityZoneMessage { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteCustomAvailabilityZoneMessage): any => ({ ...obj, }); @@ -8539,6 +9091,9 @@ export interface DeleteCustomAvailabilityZoneResult { } export namespace DeleteCustomAvailabilityZoneResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteCustomAvailabilityZoneResult): any => ({ ...obj, ...(obj.CustomAvailabilityZone && { @@ -8600,6 +9155,9 @@ export interface DeleteDBClusterMessage { } export namespace DeleteDBClusterMessage { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteDBClusterMessage): any => ({ ...obj, }); @@ -8617,6 +9175,9 @@ export interface DeleteDBClusterResult { } export namespace DeleteDBClusterResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteDBClusterResult): any => ({ ...obj, }); @@ -8632,6 +9193,9 @@ export interface DBClusterEndpointNotFoundFault extends __SmithyException, $Meta } export namespace DBClusterEndpointNotFoundFault { + /** + * @internal + */ export const filterSensitiveLog = (obj: DBClusterEndpointNotFoundFault): any => ({ ...obj, }); @@ -8645,6 +9209,9 @@ export interface DeleteDBClusterEndpointMessage { } export namespace DeleteDBClusterEndpointMessage { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteDBClusterEndpointMessage): any => ({ ...obj, }); @@ -8660,6 +9227,9 @@ export interface InvalidDBClusterEndpointStateFault extends __SmithyException, $ } export namespace InvalidDBClusterEndpointStateFault { + /** + * @internal + */ export const filterSensitiveLog = (obj: InvalidDBClusterEndpointStateFault): any => ({ ...obj, }); @@ -8688,6 +9258,9 @@ export interface DeleteDBClusterParameterGroupMessage { } export namespace DeleteDBClusterParameterGroupMessage { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteDBClusterParameterGroupMessage): any => ({ ...obj, }); @@ -8705,6 +9278,9 @@ export interface InvalidDBParameterGroupStateFault extends __SmithyException, $M } export namespace InvalidDBParameterGroupStateFault { + /** + * @internal + */ export const filterSensitiveLog = (obj: InvalidDBParameterGroupStateFault): any => ({ ...obj, }); @@ -8722,6 +9298,9 @@ export interface DeleteDBClusterSnapshotMessage { } export namespace DeleteDBClusterSnapshotMessage { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteDBClusterSnapshotMessage): any => ({ ...obj, }); @@ -8739,6 +9318,9 @@ export interface DeleteDBClusterSnapshotResult { } export namespace DeleteDBClusterSnapshotResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteDBClusterSnapshotResult): any => ({ ...obj, }); @@ -8756,6 +9338,9 @@ export interface DBInstanceAutomatedBackupQuotaExceededFault extends __SmithyExc } export namespace DBInstanceAutomatedBackupQuotaExceededFault { + /** + * @internal + */ export const filterSensitiveLog = (obj: DBInstanceAutomatedBackupQuotaExceededFault): any => ({ ...obj, }); @@ -8823,6 +9408,9 @@ export interface DeleteDBInstanceMessage { } export namespace DeleteDBInstanceMessage { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteDBInstanceMessage): any => ({ ...obj, }); @@ -8839,6 +9427,9 @@ export interface DeleteDBInstanceResult { } export namespace DeleteDBInstanceResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteDBInstanceResult): any => ({ ...obj, }); @@ -8854,6 +9445,9 @@ export interface DBInstanceAutomatedBackupNotFoundFault extends __SmithyExceptio } export namespace DBInstanceAutomatedBackupNotFoundFault { + /** + * @internal + */ export const filterSensitiveLog = (obj: DBInstanceAutomatedBackupNotFoundFault): any => ({ ...obj, }); @@ -8876,6 +9470,9 @@ export interface DeleteDBInstanceAutomatedBackupMessage { } export namespace DeleteDBInstanceAutomatedBackupMessage { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteDBInstanceAutomatedBackupMessage): any => ({ ...obj, }); @@ -8897,6 +9494,9 @@ export interface RestoreWindow { } export namespace RestoreWindow { + /** + * @internal + */ export const filterSensitiveLog = (obj: RestoreWindow): any => ({ ...obj, }); @@ -9066,6 +9666,9 @@ export interface DBInstanceAutomatedBackup { } export namespace DBInstanceAutomatedBackup { + /** + * @internal + */ export const filterSensitiveLog = (obj: DBInstanceAutomatedBackup): any => ({ ...obj, }); @@ -9080,6 +9683,9 @@ export interface DeleteDBInstanceAutomatedBackupResult { } export namespace DeleteDBInstanceAutomatedBackupResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteDBInstanceAutomatedBackupResult): any => ({ ...obj, }); @@ -9096,6 +9702,9 @@ export interface InvalidDBInstanceAutomatedBackupStateFault extends __SmithyExce } export namespace InvalidDBInstanceAutomatedBackupStateFault { + /** + * @internal + */ export const filterSensitiveLog = (obj: InvalidDBInstanceAutomatedBackupStateFault): any => ({ ...obj, }); @@ -9124,6 +9733,9 @@ export interface DeleteDBParameterGroupMessage { } export namespace DeleteDBParameterGroupMessage { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteDBParameterGroupMessage): any => ({ ...obj, }); @@ -9137,6 +9749,9 @@ export interface DeleteDBProxyRequest { } export namespace DeleteDBProxyRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteDBProxyRequest): any => ({ ...obj, }); @@ -9150,6 +9765,9 @@ export interface DeleteDBProxyResponse { } export namespace DeleteDBProxyResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteDBProxyResponse): any => ({ ...obj, }); @@ -9165,6 +9783,9 @@ export interface DBProxyEndpointNotFoundFault extends __SmithyException, $Metada } export namespace DBProxyEndpointNotFoundFault { + /** + * @internal + */ export const filterSensitiveLog = (obj: DBProxyEndpointNotFoundFault): any => ({ ...obj, }); @@ -9178,6 +9799,9 @@ export interface DeleteDBProxyEndpointRequest { } export namespace DeleteDBProxyEndpointRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteDBProxyEndpointRequest): any => ({ ...obj, }); @@ -9191,6 +9815,9 @@ export interface DeleteDBProxyEndpointResponse { } export namespace DeleteDBProxyEndpointResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteDBProxyEndpointResponse): any => ({ ...obj, }); @@ -9206,6 +9833,9 @@ export interface InvalidDBProxyEndpointStateFault extends __SmithyException, $Me } export namespace InvalidDBProxyEndpointStateFault { + /** + * @internal + */ export const filterSensitiveLog = (obj: InvalidDBProxyEndpointStateFault): any => ({ ...obj, }); @@ -9240,6 +9870,9 @@ export interface DeleteDBSecurityGroupMessage { } export namespace DeleteDBSecurityGroupMessage { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteDBSecurityGroupMessage): any => ({ ...obj, }); @@ -9257,6 +9890,9 @@ export interface DeleteDBSnapshotMessage { } export namespace DeleteDBSnapshotMessage { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteDBSnapshotMessage): any => ({ ...obj, }); @@ -9274,6 +9910,9 @@ export interface DeleteDBSnapshotResult { } export namespace DeleteDBSnapshotResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteDBSnapshotResult): any => ({ ...obj, }); @@ -9297,6 +9936,9 @@ export interface DeleteDBSubnetGroupMessage { } export namespace DeleteDBSubnetGroupMessage { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteDBSubnetGroupMessage): any => ({ ...obj, }); @@ -9314,6 +9956,9 @@ export interface InvalidDBSubnetStateFault extends __SmithyException, $MetadataB } export namespace InvalidDBSubnetStateFault { + /** + * @internal + */ export const filterSensitiveLog = (obj: InvalidDBSubnetStateFault): any => ({ ...obj, }); @@ -9330,6 +9975,9 @@ export interface DeleteEventSubscriptionMessage { } export namespace DeleteEventSubscriptionMessage { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteEventSubscriptionMessage): any => ({ ...obj, }); @@ -9343,6 +9991,9 @@ export interface DeleteEventSubscriptionResult { } export namespace DeleteEventSubscriptionResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteEventSubscriptionResult): any => ({ ...obj, }); @@ -9358,6 +10009,9 @@ export interface InvalidEventSubscriptionStateFault extends __SmithyException, $ } export namespace InvalidEventSubscriptionStateFault { + /** + * @internal + */ export const filterSensitiveLog = (obj: InvalidEventSubscriptionStateFault): any => ({ ...obj, }); @@ -9373,6 +10027,9 @@ export interface DeleteGlobalClusterMessage { } export namespace DeleteGlobalClusterMessage { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteGlobalClusterMessage): any => ({ ...obj, }); @@ -9386,6 +10043,9 @@ export interface DeleteGlobalClusterResult { } export namespace DeleteGlobalClusterResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteGlobalClusterResult): any => ({ ...obj, }); @@ -9399,6 +10059,9 @@ export interface DeleteInstallationMediaMessage { } export namespace DeleteInstallationMediaMessage { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteInstallationMediaMessage): any => ({ ...obj, }); @@ -9417,6 +10080,9 @@ export interface InstallationMediaFailureCause { } export namespace InstallationMediaFailureCause { + /** + * @internal + */ export const filterSensitiveLog = (obj: InstallationMediaFailureCause): any => ({ ...obj, }); @@ -9469,6 +10135,9 @@ export interface InstallationMedia { } export namespace InstallationMedia { + /** + * @internal + */ export const filterSensitiveLog = (obj: InstallationMedia): any => ({ ...obj, }); @@ -9485,6 +10154,9 @@ export interface InstallationMediaNotFoundFault extends __SmithyException, $Meta } export namespace InstallationMediaNotFoundFault { + /** + * @internal + */ export const filterSensitiveLog = (obj: InstallationMediaNotFoundFault): any => ({ ...obj, }); @@ -9504,6 +10176,9 @@ export interface DeleteOptionGroupMessage { } export namespace DeleteOptionGroupMessage { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteOptionGroupMessage): any => ({ ...obj, }); @@ -9521,6 +10196,9 @@ export interface InvalidOptionGroupStateFault extends __SmithyException, $Metada } export namespace InvalidOptionGroupStateFault { + /** + * @internal + */ export const filterSensitiveLog = (obj: InvalidOptionGroupStateFault): any => ({ ...obj, }); @@ -9536,6 +10214,9 @@ export interface DBProxyTargetNotFoundFault extends __SmithyException, $Metadata } export namespace DBProxyTargetNotFoundFault { + /** + * @internal + */ export const filterSensitiveLog = (obj: DBProxyTargetNotFoundFault): any => ({ ...obj, }); @@ -9564,6 +10245,9 @@ export interface DeregisterDBProxyTargetsRequest { } export namespace DeregisterDBProxyTargetsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeregisterDBProxyTargetsRequest): any => ({ ...obj, }); @@ -9572,6 +10256,9 @@ export namespace DeregisterDBProxyTargetsRequest { export interface DeregisterDBProxyTargetsResponse {} export namespace DeregisterDBProxyTargetsResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeregisterDBProxyTargetsResponse): any => ({ ...obj, }); @@ -9583,6 +10270,9 @@ export namespace DeregisterDBProxyTargetsResponse { export interface DescribeAccountAttributesMessage {} export namespace DescribeAccountAttributesMessage { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeAccountAttributesMessage): any => ({ ...obj, }); @@ -9635,6 +10325,9 @@ export interface Certificate { } export namespace Certificate { + /** + * @internal + */ export const filterSensitiveLog = (obj: Certificate): any => ({ ...obj, }); @@ -9662,6 +10355,9 @@ export interface CertificateMessage { } export namespace CertificateMessage { + /** + * @internal + */ export const filterSensitiveLog = (obj: CertificateMessage): any => ({ ...obj, }); @@ -9680,6 +10376,9 @@ export interface CertificateNotFoundFault extends __SmithyException, $MetadataBe } export namespace CertificateNotFoundFault { + /** + * @internal + */ export const filterSensitiveLog = (obj: CertificateNotFoundFault): any => ({ ...obj, }); @@ -9735,6 +10434,9 @@ export interface Filter { } export namespace Filter { + /** + * @internal + */ export const filterSensitiveLog = (obj: Filter): any => ({ ...obj, }); @@ -9784,6 +10486,9 @@ export interface DescribeCertificatesMessage { } export namespace DescribeCertificatesMessage { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeCertificatesMessage): any => ({ ...obj, }); @@ -9806,6 +10511,9 @@ export interface CustomAvailabilityZoneMessage { } export namespace CustomAvailabilityZoneMessage { + /** + * @internal + */ export const filterSensitiveLog = (obj: CustomAvailabilityZoneMessage): any => ({ ...obj, ...(obj.CustomAvailabilityZones && { @@ -9847,6 +10555,9 @@ export interface DescribeCustomAvailabilityZonesMessage { } export namespace DescribeCustomAvailabilityZonesMessage { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeCustomAvailabilityZonesMessage): any => ({ ...obj, }); @@ -9868,6 +10579,9 @@ export interface DBClusterBacktrackMessage { } export namespace DBClusterBacktrackMessage { + /** + * @internal + */ export const filterSensitiveLog = (obj: DBClusterBacktrackMessage): any => ({ ...obj, }); @@ -9884,6 +10598,9 @@ export interface DBClusterBacktrackNotFoundFault extends __SmithyException, $Met } export namespace DBClusterBacktrackNotFoundFault { + /** + * @internal + */ export const filterSensitiveLog = (obj: DBClusterBacktrackNotFoundFault): any => ({ ...obj, }); @@ -9993,6 +10710,9 @@ export interface DescribeDBClusterBacktracksMessage { } export namespace DescribeDBClusterBacktracksMessage { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeDBClusterBacktracksMessage): any => ({ ...obj, }); @@ -10017,6 +10737,9 @@ export interface DBClusterEndpointMessage { } export namespace DBClusterEndpointMessage { + /** + * @internal + */ export const filterSensitiveLog = (obj: DBClusterEndpointMessage): any => ({ ...obj, }); @@ -10068,6 +10791,9 @@ export interface DescribeDBClusterEndpointsMessage { } export namespace DescribeDBClusterEndpointsMessage { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeDBClusterEndpointsMessage): any => ({ ...obj, }); @@ -10095,6 +10821,9 @@ export interface DBClusterParameterGroupsMessage { } export namespace DBClusterParameterGroupsMessage { + /** + * @internal + */ export const filterSensitiveLog = (obj: DBClusterParameterGroupsMessage): any => ({ ...obj, }); @@ -10144,6 +10873,9 @@ export interface DescribeDBClusterParameterGroupsMessage { } export namespace DescribeDBClusterParameterGroupsMessage { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeDBClusterParameterGroupsMessage): any => ({ ...obj, }); @@ -10221,6 +10953,9 @@ export interface Parameter { } export namespace Parameter { + /** + * @internal + */ export const filterSensitiveLog = (obj: Parameter): any => ({ ...obj, }); @@ -10248,6 +10983,9 @@ export interface DBClusterParameterGroupDetails { } export namespace DBClusterParameterGroupDetails { + /** + * @internal + */ export const filterSensitiveLog = (obj: DBClusterParameterGroupDetails): any => ({ ...obj, }); @@ -10306,6 +11044,9 @@ export interface DescribeDBClusterParametersMessage { } export namespace DescribeDBClusterParametersMessage { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeDBClusterParametersMessage): any => ({ ...obj, }); @@ -10327,6 +11068,9 @@ export interface DBClusterMessage { } export namespace DBClusterMessage { + /** + * @internal + */ export const filterSensitiveLog = (obj: DBClusterMessage): any => ({ ...obj, }); @@ -10389,6 +11133,9 @@ export interface DescribeDBClustersMessage { } export namespace DescribeDBClustersMessage { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeDBClustersMessage): any => ({ ...obj, }); @@ -10405,6 +11152,9 @@ export interface DescribeDBClusterSnapshotAttributesMessage { } export namespace DescribeDBClusterSnapshotAttributesMessage { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeDBClusterSnapshotAttributesMessage): any => ({ ...obj, }); @@ -10437,6 +11187,9 @@ export interface DBClusterSnapshotAttribute { } export namespace DBClusterSnapshotAttribute { + /** + * @internal + */ export const filterSensitiveLog = (obj: DBClusterSnapshotAttribute): any => ({ ...obj, }); @@ -10462,6 +11215,9 @@ export interface DBClusterSnapshotAttributesResult { } export namespace DBClusterSnapshotAttributesResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: DBClusterSnapshotAttributesResult): any => ({ ...obj, }); @@ -10479,6 +11235,9 @@ export interface DescribeDBClusterSnapshotAttributesResult { } export namespace DescribeDBClusterSnapshotAttributesResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeDBClusterSnapshotAttributesResult): any => ({ ...obj, }); @@ -10508,6 +11267,9 @@ export interface DBClusterSnapshotMessage { } export namespace DBClusterSnapshotMessage { + /** + * @internal + */ export const filterSensitiveLog = (obj: DBClusterSnapshotMessage): any => ({ ...obj, }); @@ -10645,6 +11407,9 @@ export interface DescribeDBClusterSnapshotsMessage { } export namespace DescribeDBClusterSnapshotsMessage { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeDBClusterSnapshotsMessage): any => ({ ...obj, }); @@ -10668,6 +11433,9 @@ export interface CharacterSet { } export namespace CharacterSet { + /** + * @internal + */ export const filterSensitiveLog = (obj: CharacterSet): any => ({ ...obj, }); @@ -10692,6 +11460,9 @@ export interface Timezone { } export namespace Timezone { + /** + * @internal + */ export const filterSensitiveLog = (obj: Timezone): any => ({ ...obj, }); @@ -10743,6 +11514,9 @@ export interface UpgradeTarget { } export namespace UpgradeTarget { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpgradeTarget): any => ({ ...obj, }); @@ -10861,6 +11635,9 @@ export interface DBEngineVersion { } export namespace DBEngineVersion { + /** + * @internal + */ export const filterSensitiveLog = (obj: DBEngineVersion): any => ({ ...obj, }); @@ -10891,6 +11668,9 @@ export interface DBEngineVersionMessage { } export namespace DBEngineVersionMessage { + /** + * @internal + */ export const filterSensitiveLog = (obj: DBEngineVersionMessage): any => ({ ...obj, }); @@ -11046,6 +11826,9 @@ export interface DescribeDBEngineVersionsMessage { } export namespace DescribeDBEngineVersionsMessage { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeDBEngineVersionsMessage): any => ({ ...obj, }); @@ -11076,6 +11859,9 @@ export interface DBInstanceAutomatedBackupMessage { } export namespace DBInstanceAutomatedBackupMessage { + /** + * @internal + */ export const filterSensitiveLog = (obj: DBInstanceAutomatedBackupMessage): any => ({ ...obj, }); @@ -11157,6 +11943,9 @@ export interface DescribeDBInstanceAutomatedBackupsMessage { } export namespace DescribeDBInstanceAutomatedBackupsMessage { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeDBInstanceAutomatedBackupsMessage): any => ({ ...obj, }); @@ -11187,6 +11976,9 @@ export interface DBInstanceMessage { } export namespace DBInstanceMessage { + /** + * @internal + */ export const filterSensitiveLog = (obj: DBInstanceMessage): any => ({ ...obj, }); @@ -11267,6 +12059,9 @@ export interface DescribeDBInstancesMessage { } export namespace DescribeDBInstancesMessage { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeDBInstancesMessage): any => ({ ...obj, }); @@ -11319,6 +12114,9 @@ export interface DescribeDBLogFilesMessage { } export namespace DescribeDBLogFilesMessage { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeDBLogFilesMessage): any => ({ ...obj, }); @@ -11345,6 +12143,9 @@ export interface DescribeDBLogFilesDetails { } export namespace DescribeDBLogFilesDetails { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeDBLogFilesDetails): any => ({ ...obj, }); @@ -11368,6 +12169,9 @@ export interface DescribeDBLogFilesResponse { } export namespace DescribeDBLogFilesResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeDBLogFilesResponse): any => ({ ...obj, }); @@ -11398,6 +12202,9 @@ export interface DBParameterGroupsMessage { } export namespace DBParameterGroupsMessage { + /** + * @internal + */ export const filterSensitiveLog = (obj: DBParameterGroupsMessage): any => ({ ...obj, }); @@ -11448,6 +12255,9 @@ export interface DescribeDBParameterGroupsMessage { } export namespace DescribeDBParameterGroupsMessage { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeDBParameterGroupsMessage): any => ({ ...obj, }); @@ -11478,6 +12288,9 @@ export interface DBParameterGroupDetails { } export namespace DBParameterGroupDetails { + /** + * @internal + */ export const filterSensitiveLog = (obj: DBParameterGroupDetails): any => ({ ...obj, }); @@ -11533,6 +12346,9 @@ export interface DescribeDBParametersMessage { } export namespace DescribeDBParametersMessage { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeDBParametersMessage): any => ({ ...obj, }); @@ -11571,6 +12387,9 @@ export interface DescribeDBProxiesRequest { } export namespace DescribeDBProxiesRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeDBProxiesRequest): any => ({ ...obj, }); @@ -11593,6 +12412,9 @@ export interface DescribeDBProxiesResponse { } export namespace DescribeDBProxiesResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeDBProxiesResponse): any => ({ ...obj, }); @@ -11638,6 +12460,9 @@ export interface DescribeDBProxyEndpointsRequest { } export namespace DescribeDBProxyEndpointsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeDBProxyEndpointsRequest): any => ({ ...obj, }); @@ -11660,6 +12485,9 @@ export interface DescribeDBProxyEndpointsResponse { } export namespace DescribeDBProxyEndpointsResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeDBProxyEndpointsResponse): any => ({ ...obj, }); @@ -11704,6 +12532,9 @@ export interface DescribeDBProxyTargetGroupsRequest { } export namespace DescribeDBProxyTargetGroupsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeDBProxyTargetGroupsRequest): any => ({ ...obj, }); @@ -11757,6 +12588,9 @@ export interface ConnectionPoolConfigurationInfo { } export namespace ConnectionPoolConfigurationInfo { + /** + * @internal + */ export const filterSensitiveLog = (obj: ConnectionPoolConfigurationInfo): any => ({ ...obj, }); @@ -11814,6 +12648,9 @@ export interface DBProxyTargetGroup { } export namespace DBProxyTargetGroup { + /** + * @internal + */ export const filterSensitiveLog = (obj: DBProxyTargetGroup): any => ({ ...obj, }); @@ -11836,6 +12673,9 @@ export interface DescribeDBProxyTargetGroupsResponse { } export namespace DescribeDBProxyTargetGroupsResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeDBProxyTargetGroupsResponse): any => ({ ...obj, }); @@ -11880,6 +12720,9 @@ export interface DescribeDBProxyTargetsRequest { } export namespace DescribeDBProxyTargetsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeDBProxyTargetsRequest): any => ({ ...obj, }); @@ -11932,6 +12775,9 @@ export interface TargetHealth { } export namespace TargetHealth { + /** + * @internal + */ export const filterSensitiveLog = (obj: TargetHealth): any => ({ ...obj, }); @@ -11992,6 +12838,9 @@ export interface DBProxyTarget { } export namespace DBProxyTarget { + /** + * @internal + */ export const filterSensitiveLog = (obj: DBProxyTarget): any => ({ ...obj, }); @@ -12014,6 +12863,9 @@ export interface DescribeDBProxyTargetsResponse { } export namespace DescribeDBProxyTargetsResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeDBProxyTargetsResponse): any => ({ ...obj, }); diff --git a/clients/client-rds/models/models_1.ts b/clients/client-rds/models/models_1.ts index 48352d5eca6a..f54270f57231 100644 --- a/clients/client-rds/models/models_1.ts +++ b/clients/client-rds/models/models_1.ts @@ -57,6 +57,9 @@ export interface DBSecurityGroupMessage { } export namespace DBSecurityGroupMessage { + /** + * @internal + */ export const filterSensitiveLog = (obj: DBSecurityGroupMessage): any => ({ ...obj, }); @@ -101,6 +104,9 @@ export interface DescribeDBSecurityGroupsMessage { } export namespace DescribeDBSecurityGroupsMessage { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeDBSecurityGroupsMessage): any => ({ ...obj, }); @@ -117,6 +123,9 @@ export interface DescribeDBSnapshotAttributesMessage { } export namespace DescribeDBSnapshotAttributesMessage { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeDBSnapshotAttributesMessage): any => ({ ...obj, }); @@ -149,6 +158,9 @@ export interface DBSnapshotAttribute { } export namespace DBSnapshotAttribute { + /** + * @internal + */ export const filterSensitiveLog = (obj: DBSnapshotAttribute): any => ({ ...obj, }); @@ -174,6 +186,9 @@ export interface DBSnapshotAttributesResult { } export namespace DBSnapshotAttributesResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: DBSnapshotAttributesResult): any => ({ ...obj, }); @@ -191,6 +206,9 @@ export interface DescribeDBSnapshotAttributesResult { } export namespace DescribeDBSnapshotAttributesResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeDBSnapshotAttributesResult): any => ({ ...obj, }); @@ -221,6 +239,9 @@ export interface DBSnapshotMessage { } export namespace DBSnapshotMessage { + /** + * @internal + */ export const filterSensitiveLog = (obj: DBSnapshotMessage): any => ({ ...obj, }); @@ -379,6 +400,9 @@ export interface DescribeDBSnapshotsMessage { } export namespace DescribeDBSnapshotsMessage { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeDBSnapshotsMessage): any => ({ ...obj, }); @@ -409,6 +433,9 @@ export interface DBSubnetGroupMessage { } export namespace DBSubnetGroupMessage { + /** + * @internal + */ export const filterSensitiveLog = (obj: DBSubnetGroupMessage): any => ({ ...obj, }); @@ -452,6 +479,9 @@ export interface DescribeDBSubnetGroupsMessage { } export namespace DescribeDBSubnetGroupsMessage { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeDBSubnetGroupsMessage): any => ({ ...obj, }); @@ -495,6 +525,9 @@ export interface DescribeEngineDefaultClusterParametersMessage { } export namespace DescribeEngineDefaultClusterParametersMessage { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeEngineDefaultClusterParametersMessage): any => ({ ...obj, }); @@ -529,6 +562,9 @@ export interface EngineDefaults { } export namespace EngineDefaults { + /** + * @internal + */ export const filterSensitiveLog = (obj: EngineDefaults): any => ({ ...obj, }); @@ -544,6 +580,9 @@ export interface DescribeEngineDefaultClusterParametersResult { } export namespace DescribeEngineDefaultClusterParametersResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeEngineDefaultClusterParametersResult): any => ({ ...obj, }); @@ -587,6 +626,9 @@ export interface DescribeEngineDefaultParametersMessage { } export namespace DescribeEngineDefaultParametersMessage { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeEngineDefaultParametersMessage): any => ({ ...obj, }); @@ -602,6 +644,9 @@ export interface DescribeEngineDefaultParametersResult { } export namespace DescribeEngineDefaultParametersResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeEngineDefaultParametersResult): any => ({ ...obj, }); @@ -625,6 +670,9 @@ export interface DescribeEventCategoriesMessage { } export namespace DescribeEventCategoriesMessage { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeEventCategoriesMessage): any => ({ ...obj, }); @@ -646,6 +694,9 @@ export interface EventCategoriesMap { } export namespace EventCategoriesMap { + /** + * @internal + */ export const filterSensitiveLog = (obj: EventCategoriesMap): any => ({ ...obj, }); @@ -662,6 +713,9 @@ export interface EventCategoriesMessage { } export namespace EventCategoriesMessage { + /** + * @internal + */ export const filterSensitiveLog = (obj: EventCategoriesMessage): any => ({ ...obj, }); @@ -777,6 +831,9 @@ export interface DescribeEventsMessage { } export namespace DescribeEventsMessage { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeEventsMessage): any => ({ ...obj, }); @@ -820,6 +877,9 @@ export interface Event { } export namespace Event { + /** + * @internal + */ export const filterSensitiveLog = (obj: Event): any => ({ ...obj, }); @@ -851,6 +911,9 @@ export interface EventsMessage { } export namespace EventsMessage { + /** + * @internal + */ export const filterSensitiveLog = (obj: EventsMessage): any => ({ ...obj, }); @@ -895,6 +958,9 @@ export interface DescribeEventSubscriptionsMessage { } export namespace DescribeEventSubscriptionsMessage { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeEventSubscriptionsMessage): any => ({ ...obj, }); @@ -922,6 +988,9 @@ export interface EventSubscriptionsMessage { } export namespace EventSubscriptionsMessage { + /** + * @internal + */ export const filterSensitiveLog = (obj: EventSubscriptionsMessage): any => ({ ...obj, }); @@ -986,6 +1055,9 @@ export interface DescribeExportTasksMessage { } export namespace DescribeExportTasksMessage { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeExportTasksMessage): any => ({ ...obj, }); @@ -1006,6 +1078,9 @@ export interface ExportTasksMessage { } export namespace ExportTasksMessage { + /** + * @internal + */ export const filterSensitiveLog = (obj: ExportTasksMessage): any => ({ ...obj, }); @@ -1061,6 +1136,9 @@ export interface DescribeGlobalClustersMessage { } export namespace DescribeGlobalClustersMessage { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeGlobalClustersMessage): any => ({ ...obj, }); @@ -1085,6 +1163,9 @@ export interface GlobalClustersMessage { } export namespace GlobalClustersMessage { + /** + * @internal + */ export const filterSensitiveLog = (obj: GlobalClustersMessage): any => ({ ...obj, }); @@ -1133,6 +1214,9 @@ export interface DescribeInstallationMediaMessage { } export namespace DescribeInstallationMediaMessage { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeInstallationMediaMessage): any => ({ ...obj, }); @@ -1155,6 +1239,9 @@ export interface InstallationMediaMessage { } export namespace InstallationMediaMessage { + /** + * @internal + */ export const filterSensitiveLog = (obj: InstallationMediaMessage): any => ({ ...obj, }); @@ -1260,6 +1347,9 @@ export interface DescribeOptionGroupOptionsMessage { } export namespace DescribeOptionGroupOptionsMessage { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeOptionGroupOptionsMessage): any => ({ ...obj, }); @@ -1281,6 +1371,9 @@ export interface MinimumEngineVersionPerAllowedValue { } export namespace MinimumEngineVersionPerAllowedValue { + /** + * @internal + */ export const filterSensitiveLog = (obj: MinimumEngineVersionPerAllowedValue): any => ({ ...obj, }); @@ -1332,6 +1425,9 @@ export interface OptionGroupOptionSetting { } export namespace OptionGroupOptionSetting { + /** + * @internal + */ export const filterSensitiveLog = (obj: OptionGroupOptionSetting): any => ({ ...obj, }); @@ -1354,6 +1450,9 @@ export interface OptionVersion { } export namespace OptionVersion { + /** + * @internal + */ export const filterSensitiveLog = (obj: OptionVersion): any => ({ ...obj, }); @@ -1452,6 +1551,9 @@ export interface OptionGroupOption { } export namespace OptionGroupOption { + /** + * @internal + */ export const filterSensitiveLog = (obj: OptionGroupOption): any => ({ ...obj, }); @@ -1476,6 +1578,9 @@ export interface OptionGroupOptionsMessage { } export namespace OptionGroupOptionsMessage { + /** + * @internal + */ export const filterSensitiveLog = (obj: OptionGroupOptionsMessage): any => ({ ...obj, }); @@ -1588,6 +1693,9 @@ export interface DescribeOptionGroupsMessage { } export namespace DescribeOptionGroupsMessage { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeOptionGroupsMessage): any => ({ ...obj, }); @@ -1613,6 +1721,9 @@ export interface OptionGroups { } export namespace OptionGroups { + /** + * @internal + */ export const filterSensitiveLog = (obj: OptionGroups): any => ({ ...obj, }); @@ -1755,6 +1866,9 @@ export interface DescribeOrderableDBInstanceOptionsMessage { } export namespace DescribeOrderableDBInstanceOptionsMessage { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeOrderableDBInstanceOptionsMessage): any => ({ ...obj, }); @@ -1786,6 +1900,9 @@ export interface AvailableProcessorFeature { } export namespace AvailableProcessorFeature { + /** + * @internal + */ export const filterSensitiveLog = (obj: AvailableProcessorFeature): any => ({ ...obj, }); @@ -1938,6 +2055,9 @@ export interface OrderableDBInstanceOption { } export namespace OrderableDBInstanceOption { + /** + * @internal + */ export const filterSensitiveLog = (obj: OrderableDBInstanceOption): any => ({ ...obj, }); @@ -1967,6 +2087,9 @@ export interface OrderableDBInstanceOptionsMessage { } export namespace OrderableDBInstanceOptionsMessage { + /** + * @internal + */ export const filterSensitiveLog = (obj: OrderableDBInstanceOptionsMessage): any => ({ ...obj, }); @@ -2026,6 +2149,9 @@ export interface DescribePendingMaintenanceActionsMessage { } export namespace DescribePendingMaintenanceActionsMessage { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribePendingMaintenanceActionsMessage): any => ({ ...obj, }); @@ -2053,6 +2179,9 @@ export interface PendingMaintenanceActionsMessage { } export namespace PendingMaintenanceActionsMessage { + /** + * @internal + */ export const filterSensitiveLog = (obj: PendingMaintenanceActionsMessage): any => ({ ...obj, }); @@ -2137,6 +2266,9 @@ export interface DescribeReservedDBInstancesMessage { } export namespace DescribeReservedDBInstancesMessage { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeReservedDBInstancesMessage): any => ({ ...obj, }); @@ -2161,6 +2293,9 @@ export interface RecurringCharge { } export namespace RecurringCharge { + /** + * @internal + */ export const filterSensitiveLog = (obj: RecurringCharge): any => ({ ...obj, }); @@ -2259,6 +2394,9 @@ export interface ReservedDBInstance { } export namespace ReservedDBInstance { + /** + * @internal + */ export const filterSensitiveLog = (obj: ReservedDBInstance): any => ({ ...obj, }); @@ -2287,6 +2425,9 @@ export interface ReservedDBInstanceMessage { } export namespace ReservedDBInstanceMessage { + /** + * @internal + */ export const filterSensitiveLog = (obj: ReservedDBInstanceMessage): any => ({ ...obj, }); @@ -2302,6 +2443,9 @@ export interface ReservedDBInstanceNotFoundFault extends __SmithyException, $Met } export namespace ReservedDBInstanceNotFoundFault { + /** + * @internal + */ export const filterSensitiveLog = (obj: ReservedDBInstanceNotFoundFault): any => ({ ...obj, }); @@ -2378,6 +2522,9 @@ export interface DescribeReservedDBInstancesOfferingsMessage { } export namespace DescribeReservedDBInstancesOfferingsMessage { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeReservedDBInstancesOfferingsMessage): any => ({ ...obj, }); @@ -2441,6 +2588,9 @@ export interface ReservedDBInstancesOffering { } export namespace ReservedDBInstancesOffering { + /** + * @internal + */ export const filterSensitiveLog = (obj: ReservedDBInstancesOffering): any => ({ ...obj, }); @@ -2469,6 +2619,9 @@ export interface ReservedDBInstancesOfferingMessage { } export namespace ReservedDBInstancesOfferingMessage { + /** + * @internal + */ export const filterSensitiveLog = (obj: ReservedDBInstancesOfferingMessage): any => ({ ...obj, }); @@ -2484,6 +2637,9 @@ export interface ReservedDBInstancesOfferingNotFoundFault extends __SmithyExcept } export namespace ReservedDBInstancesOfferingNotFoundFault { + /** + * @internal + */ export const filterSensitiveLog = (obj: ReservedDBInstancesOfferingNotFoundFault): any => ({ ...obj, }); @@ -2527,6 +2683,9 @@ export interface DescribeSourceRegionsMessage { } export namespace DescribeSourceRegionsMessage { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeSourceRegionsMessage): any => ({ ...obj, }); @@ -2558,6 +2717,9 @@ export interface SourceRegion { } export namespace SourceRegion { + /** + * @internal + */ export const filterSensitiveLog = (obj: SourceRegion): any => ({ ...obj, }); @@ -2585,6 +2747,9 @@ export interface SourceRegionMessage { } export namespace SourceRegionMessage { + /** + * @internal + */ export const filterSensitiveLog = (obj: SourceRegionMessage): any => ({ ...obj, }); @@ -2602,6 +2767,9 @@ export interface DescribeValidDBInstanceModificationsMessage { } export namespace DescribeValidDBInstanceModificationsMessage { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeValidDBInstanceModificationsMessage): any => ({ ...obj, }); @@ -2623,6 +2791,9 @@ export interface DoubleRange { } export namespace DoubleRange { + /** + * @internal + */ export const filterSensitiveLog = (obj: DoubleRange): any => ({ ...obj, }); @@ -2656,6 +2827,9 @@ export interface Range { } export namespace Range { + /** + * @internal + */ export const filterSensitiveLog = (obj: Range): any => ({ ...obj, }); @@ -2704,6 +2878,9 @@ export interface ValidStorageOptions { } export namespace ValidStorageOptions { + /** + * @internal + */ export const filterSensitiveLog = (obj: ValidStorageOptions): any => ({ ...obj, }); @@ -2732,6 +2909,9 @@ export interface ValidDBInstanceModificationsMessage { } export namespace ValidDBInstanceModificationsMessage { + /** + * @internal + */ export const filterSensitiveLog = (obj: ValidDBInstanceModificationsMessage): any => ({ ...obj, }); @@ -2750,6 +2930,9 @@ export interface DescribeValidDBInstanceModificationsResult { } export namespace DescribeValidDBInstanceModificationsResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeValidDBInstanceModificationsResult): any => ({ ...obj, }); @@ -2766,6 +2949,9 @@ export interface DBLogFileNotFoundFault extends __SmithyException, $MetadataBear } export namespace DBLogFileNotFoundFault { + /** + * @internal + */ export const filterSensitiveLog = (obj: DBLogFileNotFoundFault): any => ({ ...obj, }); @@ -2792,6 +2978,9 @@ export interface DownloadDBLogFilePortionDetails { } export namespace DownloadDBLogFilePortionDetails { + /** + * @internal + */ export const filterSensitiveLog = (obj: DownloadDBLogFilePortionDetails): any => ({ ...obj, }); @@ -2853,6 +3042,9 @@ export interface DownloadDBLogFilePortionMessage { } export namespace DownloadDBLogFilePortionMessage { + /** + * @internal + */ export const filterSensitiveLog = (obj: DownloadDBLogFilePortionMessage): any => ({ ...obj, }); @@ -2882,6 +3074,9 @@ export interface FailoverDBClusterMessage { } export namespace FailoverDBClusterMessage { + /** + * @internal + */ export const filterSensitiveLog = (obj: FailoverDBClusterMessage): any => ({ ...obj, }); @@ -2899,6 +3094,9 @@ export interface FailoverDBClusterResult { } export namespace FailoverDBClusterResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: FailoverDBClusterResult): any => ({ ...obj, }); @@ -2930,6 +3128,9 @@ export interface FailoverGlobalClusterMessage { } export namespace FailoverGlobalClusterMessage { + /** + * @internal + */ export const filterSensitiveLog = (obj: FailoverGlobalClusterMessage): any => ({ ...obj, }); @@ -2943,6 +3144,9 @@ export interface FailoverGlobalClusterResult { } export namespace FailoverGlobalClusterResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: FailoverGlobalClusterResult): any => ({ ...obj, }); @@ -3022,6 +3226,9 @@ export interface ImportInstallationMediaMessage { } export namespace ImportInstallationMediaMessage { + /** + * @internal + */ export const filterSensitiveLog = (obj: ImportInstallationMediaMessage): any => ({ ...obj, }); @@ -3037,6 +3244,9 @@ export interface InstallationMediaAlreadyExistsFault extends __SmithyException, } export namespace InstallationMediaAlreadyExistsFault { + /** + * @internal + */ export const filterSensitiveLog = (obj: InstallationMediaAlreadyExistsFault): any => ({ ...obj, }); @@ -3061,6 +3271,9 @@ export interface ListTagsForResourceMessage { } export namespace ListTagsForResourceMessage { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListTagsForResourceMessage): any => ({ ...obj, }); @@ -3077,6 +3290,9 @@ export interface TagListMessage { } export namespace TagListMessage { + /** + * @internal + */ export const filterSensitiveLog = (obj: TagListMessage): any => ({ ...obj, }); @@ -3099,6 +3315,9 @@ export interface ModifyCertificatesMessage { } export namespace ModifyCertificatesMessage { + /** + * @internal + */ export const filterSensitiveLog = (obj: ModifyCertificatesMessage): any => ({ ...obj, }); @@ -3112,6 +3331,9 @@ export interface ModifyCertificatesResult { } export namespace ModifyCertificatesResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: ModifyCertificatesResult): any => ({ ...obj, }); @@ -3147,6 +3369,9 @@ export interface DBClusterCapacityInfo { } export namespace DBClusterCapacityInfo { + /** + * @internal + */ export const filterSensitiveLog = (obj: DBClusterCapacityInfo): any => ({ ...obj, }); @@ -3165,6 +3390,9 @@ export interface InvalidDBClusterCapacityFault extends __SmithyException, $Metad } export namespace InvalidDBClusterCapacityFault { + /** + * @internal + */ export const filterSensitiveLog = (obj: InvalidDBClusterCapacityFault): any => ({ ...obj, }); @@ -3220,6 +3448,9 @@ export interface ModifyCurrentDBClusterCapacityMessage { } export namespace ModifyCurrentDBClusterCapacityMessage { + /** + * @internal + */ export const filterSensitiveLog = (obj: ModifyCurrentDBClusterCapacityMessage): any => ({ ...obj, }); @@ -3247,6 +3478,9 @@ export interface CloudwatchLogsExportConfiguration { } export namespace CloudwatchLogsExportConfiguration { + /** + * @internal + */ export const filterSensitiveLog = (obj: CloudwatchLogsExportConfiguration): any => ({ ...obj, }); @@ -3530,6 +3764,9 @@ export interface ModifyDBClusterMessage { } export namespace ModifyDBClusterMessage { + /** + * @internal + */ export const filterSensitiveLog = (obj: ModifyDBClusterMessage): any => ({ ...obj, }); @@ -3547,6 +3784,9 @@ export interface ModifyDBClusterResult { } export namespace ModifyDBClusterResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: ModifyDBClusterResult): any => ({ ...obj, }); @@ -3577,6 +3817,9 @@ export interface ModifyDBClusterEndpointMessage { } export namespace ModifyDBClusterEndpointMessage { + /** + * @internal + */ export const filterSensitiveLog = (obj: ModifyDBClusterEndpointMessage): any => ({ ...obj, }); @@ -3608,6 +3851,9 @@ export interface DBClusterParameterGroupNameMessage { } export namespace DBClusterParameterGroupNameMessage { + /** + * @internal + */ export const filterSensitiveLog = (obj: DBClusterParameterGroupNameMessage): any => ({ ...obj, }); @@ -3629,6 +3875,9 @@ export interface ModifyDBClusterParameterGroupMessage { } export namespace ModifyDBClusterParameterGroupMessage { + /** + * @internal + */ export const filterSensitiveLog = (obj: ModifyDBClusterParameterGroupMessage): any => ({ ...obj, }); @@ -3677,6 +3926,9 @@ export interface ModifyDBClusterSnapshotAttributeMessage { } export namespace ModifyDBClusterSnapshotAttributeMessage { + /** + * @internal + */ export const filterSensitiveLog = (obj: ModifyDBClusterSnapshotAttributeMessage): any => ({ ...obj, }); @@ -3694,6 +3946,9 @@ export interface ModifyDBClusterSnapshotAttributeResult { } export namespace ModifyDBClusterSnapshotAttributeResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: ModifyDBClusterSnapshotAttributeResult): any => ({ ...obj, }); @@ -3709,6 +3964,9 @@ export interface SharedSnapshotQuotaExceededFault extends __SmithyException, $Me } export namespace SharedSnapshotQuotaExceededFault { + /** + * @internal + */ export const filterSensitiveLog = (obj: SharedSnapshotQuotaExceededFault): any => ({ ...obj, }); @@ -3725,6 +3983,9 @@ export interface DBUpgradeDependencyFailureFault extends __SmithyException, $Met } export namespace DBUpgradeDependencyFailureFault { + /** + * @internal + */ export const filterSensitiveLog = (obj: DBUpgradeDependencyFailureFault): any => ({ ...obj, }); @@ -4419,6 +4680,9 @@ export interface ModifyDBInstanceMessage { } export namespace ModifyDBInstanceMessage { + /** + * @internal + */ export const filterSensitiveLog = (obj: ModifyDBInstanceMessage): any => ({ ...obj, }); @@ -4435,6 +4699,9 @@ export interface ModifyDBInstanceResult { } export namespace ModifyDBInstanceResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: ModifyDBInstanceResult): any => ({ ...obj, }); @@ -4454,6 +4721,9 @@ export interface DBParameterGroupNameMessage { } export namespace DBParameterGroupNameMessage { + /** + * @internal + */ export const filterSensitiveLog = (obj: DBParameterGroupNameMessage): any => ({ ...obj, }); @@ -4486,6 +4756,9 @@ export interface ModifyDBParameterGroupMessage { } export namespace ModifyDBParameterGroupMessage { + /** + * @internal + */ export const filterSensitiveLog = (obj: ModifyDBParameterGroupMessage): any => ({ ...obj, }); @@ -4542,6 +4815,9 @@ export interface ModifyDBProxyRequest { } export namespace ModifyDBProxyRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ModifyDBProxyRequest): any => ({ ...obj, }); @@ -4555,6 +4831,9 @@ export interface ModifyDBProxyResponse { } export namespace ModifyDBProxyResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ModifyDBProxyResponse): any => ({ ...obj, }); @@ -4582,6 +4861,9 @@ export interface ModifyDBProxyEndpointRequest { } export namespace ModifyDBProxyEndpointRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ModifyDBProxyEndpointRequest): any => ({ ...obj, }); @@ -4595,6 +4877,9 @@ export interface ModifyDBProxyEndpointResponse { } export namespace ModifyDBProxyEndpointResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ModifyDBProxyEndpointResponse): any => ({ ...obj, }); @@ -4656,6 +4941,9 @@ export interface ConnectionPoolConfiguration { } export namespace ConnectionPoolConfiguration { + /** + * @internal + */ export const filterSensitiveLog = (obj: ConnectionPoolConfiguration): any => ({ ...obj, }); @@ -4684,6 +4972,9 @@ export interface ModifyDBProxyTargetGroupRequest { } export namespace ModifyDBProxyTargetGroupRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ModifyDBProxyTargetGroupRequest): any => ({ ...obj, }); @@ -4697,6 +4988,9 @@ export interface ModifyDBProxyTargetGroupResponse { } export namespace ModifyDBProxyTargetGroupResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ModifyDBProxyTargetGroupResponse): any => ({ ...obj, }); @@ -4770,6 +5064,9 @@ export interface ModifyDBSnapshotMessage { } export namespace ModifyDBSnapshotMessage { + /** + * @internal + */ export const filterSensitiveLog = (obj: ModifyDBSnapshotMessage): any => ({ ...obj, }); @@ -4787,6 +5084,9 @@ export interface ModifyDBSnapshotResult { } export namespace ModifyDBSnapshotResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: ModifyDBSnapshotResult): any => ({ ...obj, }); @@ -4835,6 +5135,9 @@ export interface ModifyDBSnapshotAttributeMessage { } export namespace ModifyDBSnapshotAttributeMessage { + /** + * @internal + */ export const filterSensitiveLog = (obj: ModifyDBSnapshotAttributeMessage): any => ({ ...obj, }); @@ -4852,6 +5155,9 @@ export interface ModifyDBSnapshotAttributeResult { } export namespace ModifyDBSnapshotAttributeResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: ModifyDBSnapshotAttributeResult): any => ({ ...obj, }); @@ -4883,6 +5189,9 @@ export interface ModifyDBSubnetGroupMessage { } export namespace ModifyDBSubnetGroupMessage { + /** + * @internal + */ export const filterSensitiveLog = (obj: ModifyDBSubnetGroupMessage): any => ({ ...obj, }); @@ -4900,6 +5209,9 @@ export interface ModifyDBSubnetGroupResult { } export namespace ModifyDBSubnetGroupResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: ModifyDBSubnetGroupResult): any => ({ ...obj, }); @@ -4915,6 +5227,9 @@ export interface SubnetAlreadyInUse extends __SmithyException, $MetadataBearer { } export namespace SubnetAlreadyInUse { + /** + * @internal + */ export const filterSensitiveLog = (obj: SubnetAlreadyInUse): any => ({ ...obj, }); @@ -4960,6 +5275,9 @@ export interface ModifyEventSubscriptionMessage { } export namespace ModifyEventSubscriptionMessage { + /** + * @internal + */ export const filterSensitiveLog = (obj: ModifyEventSubscriptionMessage): any => ({ ...obj, }); @@ -4973,6 +5291,9 @@ export interface ModifyEventSubscriptionResult { } export namespace ModifyEventSubscriptionResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: ModifyEventSubscriptionResult): any => ({ ...obj, }); @@ -5054,6 +5375,9 @@ export interface ModifyGlobalClusterMessage { } export namespace ModifyGlobalClusterMessage { + /** + * @internal + */ export const filterSensitiveLog = (obj: ModifyGlobalClusterMessage): any => ({ ...obj, }); @@ -5067,6 +5391,9 @@ export interface ModifyGlobalClusterResult { } export namespace ModifyGlobalClusterResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: ModifyGlobalClusterResult): any => ({ ...obj, }); @@ -5108,6 +5435,9 @@ export interface OptionConfiguration { } export namespace OptionConfiguration { + /** + * @internal + */ export const filterSensitiveLog = (obj: OptionConfiguration): any => ({ ...obj, }); @@ -5140,6 +5470,9 @@ export interface ModifyOptionGroupMessage { } export namespace ModifyOptionGroupMessage { + /** + * @internal + */ export const filterSensitiveLog = (obj: ModifyOptionGroupMessage): any => ({ ...obj, }); @@ -5153,6 +5486,9 @@ export interface ModifyOptionGroupResult { } export namespace ModifyOptionGroupResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: ModifyOptionGroupResult): any => ({ ...obj, }); @@ -5223,6 +5559,9 @@ export interface PromoteReadReplicaMessage { } export namespace PromoteReadReplicaMessage { + /** + * @internal + */ export const filterSensitiveLog = (obj: PromoteReadReplicaMessage): any => ({ ...obj, }); @@ -5239,6 +5578,9 @@ export interface PromoteReadReplicaResult { } export namespace PromoteReadReplicaResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: PromoteReadReplicaResult): any => ({ ...obj, }); @@ -5264,6 +5606,9 @@ export interface PromoteReadReplicaDBClusterMessage { } export namespace PromoteReadReplicaDBClusterMessage { + /** + * @internal + */ export const filterSensitiveLog = (obj: PromoteReadReplicaDBClusterMessage): any => ({ ...obj, }); @@ -5281,6 +5626,9 @@ export interface PromoteReadReplicaDBClusterResult { } export namespace PromoteReadReplicaDBClusterResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: PromoteReadReplicaDBClusterResult): any => ({ ...obj, }); @@ -5318,6 +5666,9 @@ export interface PurchaseReservedDBInstancesOfferingMessage { } export namespace PurchaseReservedDBInstancesOfferingMessage { + /** + * @internal + */ export const filterSensitiveLog = (obj: PurchaseReservedDBInstancesOfferingMessage): any => ({ ...obj, }); @@ -5335,6 +5686,9 @@ export interface PurchaseReservedDBInstancesOfferingResult { } export namespace PurchaseReservedDBInstancesOfferingResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: PurchaseReservedDBInstancesOfferingResult): any => ({ ...obj, }); @@ -5350,6 +5704,9 @@ export interface ReservedDBInstanceAlreadyExistsFault extends __SmithyException, } export namespace ReservedDBInstanceAlreadyExistsFault { + /** + * @internal + */ export const filterSensitiveLog = (obj: ReservedDBInstanceAlreadyExistsFault): any => ({ ...obj, }); @@ -5365,6 +5722,9 @@ export interface ReservedDBInstanceQuotaExceededFault extends __SmithyException, } export namespace ReservedDBInstanceQuotaExceededFault { + /** + * @internal + */ export const filterSensitiveLog = (obj: ReservedDBInstanceQuotaExceededFault): any => ({ ...obj, }); @@ -5395,6 +5755,9 @@ export interface RebootDBInstanceMessage { } export namespace RebootDBInstanceMessage { + /** + * @internal + */ export const filterSensitiveLog = (obj: RebootDBInstanceMessage): any => ({ ...obj, }); @@ -5411,6 +5774,9 @@ export interface RebootDBInstanceResult { } export namespace RebootDBInstanceResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: RebootDBInstanceResult): any => ({ ...obj, }); @@ -5426,6 +5792,9 @@ export interface DBProxyTargetAlreadyRegisteredFault extends __SmithyException, } export namespace DBProxyTargetAlreadyRegisteredFault { + /** + * @internal + */ export const filterSensitiveLog = (obj: DBProxyTargetAlreadyRegisteredFault): any => ({ ...obj, }); @@ -5443,6 +5812,9 @@ export interface InsufficientAvailableIPsInSubnetFault extends __SmithyException } export namespace InsufficientAvailableIPsInSubnetFault { + /** + * @internal + */ export const filterSensitiveLog = (obj: InsufficientAvailableIPsInSubnetFault): any => ({ ...obj, }); @@ -5471,6 +5843,9 @@ export interface RegisterDBProxyTargetsRequest { } export namespace RegisterDBProxyTargetsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: RegisterDBProxyTargetsRequest): any => ({ ...obj, }); @@ -5484,6 +5859,9 @@ export interface RegisterDBProxyTargetsResponse { } export namespace RegisterDBProxyTargetsResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: RegisterDBProxyTargetsResponse): any => ({ ...obj, }); @@ -5506,6 +5884,9 @@ export interface RemoveFromGlobalClusterMessage { } export namespace RemoveFromGlobalClusterMessage { + /** + * @internal + */ export const filterSensitiveLog = (obj: RemoveFromGlobalClusterMessage): any => ({ ...obj, }); @@ -5519,6 +5900,9 @@ export interface RemoveFromGlobalClusterResult { } export namespace RemoveFromGlobalClusterResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: RemoveFromGlobalClusterResult): any => ({ ...obj, }); @@ -5534,6 +5918,9 @@ export interface DBClusterRoleNotFoundFault extends __SmithyException, $Metadata } export namespace DBClusterRoleNotFoundFault { + /** + * @internal + */ export const filterSensitiveLog = (obj: DBClusterRoleNotFoundFault): any => ({ ...obj, }); @@ -5559,6 +5946,9 @@ export interface RemoveRoleFromDBClusterMessage { } export namespace RemoveRoleFromDBClusterMessage { + /** + * @internal + */ export const filterSensitiveLog = (obj: RemoveRoleFromDBClusterMessage): any => ({ ...obj, }); @@ -5575,6 +5965,9 @@ export interface DBInstanceRoleNotFoundFault extends __SmithyException, $Metadat } export namespace DBInstanceRoleNotFoundFault { + /** + * @internal + */ export const filterSensitiveLog = (obj: DBInstanceRoleNotFoundFault): any => ({ ...obj, }); @@ -5601,6 +5994,9 @@ export interface RemoveRoleFromDBInstanceMessage { } export namespace RemoveRoleFromDBInstanceMessage { + /** + * @internal + */ export const filterSensitiveLog = (obj: RemoveRoleFromDBInstanceMessage): any => ({ ...obj, }); @@ -5625,6 +6021,9 @@ export interface RemoveSourceIdentifierFromSubscriptionMessage { } export namespace RemoveSourceIdentifierFromSubscriptionMessage { + /** + * @internal + */ export const filterSensitiveLog = (obj: RemoveSourceIdentifierFromSubscriptionMessage): any => ({ ...obj, }); @@ -5638,6 +6037,9 @@ export interface RemoveSourceIdentifierFromSubscriptionResult { } export namespace RemoveSourceIdentifierFromSubscriptionResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: RemoveSourceIdentifierFromSubscriptionResult): any => ({ ...obj, }); @@ -5663,6 +6065,9 @@ export interface RemoveTagsFromResourceMessage { } export namespace RemoveTagsFromResourceMessage { + /** + * @internal + */ export const filterSensitiveLog = (obj: RemoveTagsFromResourceMessage): any => ({ ...obj, }); @@ -5692,6 +6097,9 @@ export interface ResetDBClusterParameterGroupMessage { } export namespace ResetDBClusterParameterGroupMessage { + /** + * @internal + */ export const filterSensitiveLog = (obj: ResetDBClusterParameterGroupMessage): any => ({ ...obj, }); @@ -5752,6 +6160,9 @@ export interface ResetDBParameterGroupMessage { } export namespace ResetDBParameterGroupMessage { + /** + * @internal + */ export const filterSensitiveLog = (obj: ResetDBParameterGroupMessage): any => ({ ...obj, }); @@ -5768,6 +6179,9 @@ export interface InvalidS3BucketFault extends __SmithyException, $MetadataBearer } export namespace InvalidS3BucketFault { + /** + * @internal + */ export const filterSensitiveLog = (obj: InvalidS3BucketFault): any => ({ ...obj, }); @@ -6089,6 +6503,9 @@ export interface RestoreDBClusterFromS3Message { } export namespace RestoreDBClusterFromS3Message { + /** + * @internal + */ export const filterSensitiveLog = (obj: RestoreDBClusterFromS3Message): any => ({ ...obj, }); @@ -6106,6 +6523,9 @@ export interface RestoreDBClusterFromS3Result { } export namespace RestoreDBClusterFromS3Result { + /** + * @internal + */ export const filterSensitiveLog = (obj: RestoreDBClusterFromS3Result): any => ({ ...obj, }); @@ -6121,6 +6541,9 @@ export interface InsufficientDBClusterCapacityFault extends __SmithyException, $ } export namespace InsufficientDBClusterCapacityFault { + /** + * @internal + */ export const filterSensitiveLog = (obj: InsufficientDBClusterCapacityFault): any => ({ ...obj, }); @@ -6136,6 +6559,9 @@ export interface InvalidRestoreFault extends __SmithyException, $MetadataBearer } export namespace InvalidRestoreFault { + /** + * @internal + */ export const filterSensitiveLog = (obj: InvalidRestoreFault): any => ({ ...obj, }); @@ -6380,6 +6806,9 @@ export interface RestoreDBClusterFromSnapshotMessage { } export namespace RestoreDBClusterFromSnapshotMessage { + /** + * @internal + */ export const filterSensitiveLog = (obj: RestoreDBClusterFromSnapshotMessage): any => ({ ...obj, }); @@ -6397,6 +6826,9 @@ export interface RestoreDBClusterFromSnapshotResult { } export namespace RestoreDBClusterFromSnapshotResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: RestoreDBClusterFromSnapshotResult): any => ({ ...obj, }); @@ -6629,6 +7061,9 @@ export interface RestoreDBClusterToPointInTimeMessage { } export namespace RestoreDBClusterToPointInTimeMessage { + /** + * @internal + */ export const filterSensitiveLog = (obj: RestoreDBClusterToPointInTimeMessage): any => ({ ...obj, }); @@ -6646,6 +7081,9 @@ export interface RestoreDBClusterToPointInTimeResult { } export namespace RestoreDBClusterToPointInTimeResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: RestoreDBClusterToPointInTimeResult): any => ({ ...obj, }); @@ -6990,6 +7428,9 @@ export interface RestoreDBInstanceFromDBSnapshotMessage { } export namespace RestoreDBInstanceFromDBSnapshotMessage { + /** + * @internal + */ export const filterSensitiveLog = (obj: RestoreDBInstanceFromDBSnapshotMessage): any => ({ ...obj, }); @@ -7006,6 +7447,9 @@ export interface RestoreDBInstanceFromDBSnapshotResult { } export namespace RestoreDBInstanceFromDBSnapshotResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: RestoreDBInstanceFromDBSnapshotResult): any => ({ ...obj, }); @@ -7463,6 +7907,9 @@ export interface RestoreDBInstanceFromS3Message { } export namespace RestoreDBInstanceFromS3Message { + /** + * @internal + */ export const filterSensitiveLog = (obj: RestoreDBInstanceFromS3Message): any => ({ ...obj, }); @@ -7479,6 +7926,9 @@ export interface RestoreDBInstanceFromS3Result { } export namespace RestoreDBInstanceFromS3Result { + /** + * @internal + */ export const filterSensitiveLog = (obj: RestoreDBInstanceFromS3Result): any => ({ ...obj, }); @@ -7498,6 +7948,9 @@ export interface PointInTimeRestoreNotEnabledFault extends __SmithyException, $M } export namespace PointInTimeRestoreNotEnabledFault { + /** + * @internal + */ export const filterSensitiveLog = (obj: PointInTimeRestoreNotEnabledFault): any => ({ ...obj, }); @@ -7876,6 +8329,9 @@ export interface RestoreDBInstanceToPointInTimeMessage { } export namespace RestoreDBInstanceToPointInTimeMessage { + /** + * @internal + */ export const filterSensitiveLog = (obj: RestoreDBInstanceToPointInTimeMessage): any => ({ ...obj, }); @@ -7892,6 +8348,9 @@ export interface RestoreDBInstanceToPointInTimeResult { } export namespace RestoreDBInstanceToPointInTimeResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: RestoreDBInstanceToPointInTimeResult): any => ({ ...obj, }); @@ -7947,6 +8406,9 @@ export interface RevokeDBSecurityGroupIngressMessage { } export namespace RevokeDBSecurityGroupIngressMessage { + /** + * @internal + */ export const filterSensitiveLog = (obj: RevokeDBSecurityGroupIngressMessage): any => ({ ...obj, }); @@ -7964,6 +8426,9 @@ export interface RevokeDBSecurityGroupIngressResult { } export namespace RevokeDBSecurityGroupIngressResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: RevokeDBSecurityGroupIngressResult): any => ({ ...obj, }); @@ -7998,6 +8463,9 @@ export interface StartActivityStreamRequest { } export namespace StartActivityStreamRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: StartActivityStreamRequest): any => ({ ...obj, }); @@ -8032,6 +8500,9 @@ export interface StartActivityStreamResponse { } export namespace StartActivityStreamResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: StartActivityStreamResponse): any => ({ ...obj, }); @@ -8046,6 +8517,9 @@ export interface StartDBClusterMessage { } export namespace StartDBClusterMessage { + /** + * @internal + */ export const filterSensitiveLog = (obj: StartDBClusterMessage): any => ({ ...obj, }); @@ -8063,6 +8537,9 @@ export interface StartDBClusterResult { } export namespace StartDBClusterResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: StartDBClusterResult): any => ({ ...obj, }); @@ -8078,6 +8555,9 @@ export interface StartDBInstanceMessage { } export namespace StartDBInstanceMessage { + /** + * @internal + */ export const filterSensitiveLog = (obj: StartDBInstanceMessage): any => ({ ...obj, }); @@ -8094,6 +8574,9 @@ export interface StartDBInstanceResult { } export namespace StartDBInstanceResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: StartDBInstanceResult): any => ({ ...obj, }); @@ -8128,6 +8611,9 @@ export interface StartDBInstanceAutomatedBackupsReplicationMessage { } export namespace StartDBInstanceAutomatedBackupsReplicationMessage { + /** + * @internal + */ export const filterSensitiveLog = (obj: StartDBInstanceAutomatedBackupsReplicationMessage): any => ({ ...obj, }); @@ -8142,6 +8628,9 @@ export interface StartDBInstanceAutomatedBackupsReplicationResult { } export namespace StartDBInstanceAutomatedBackupsReplicationResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: StartDBInstanceAutomatedBackupsReplicationResult): any => ({ ...obj, }); @@ -8157,6 +8646,9 @@ export interface ExportTaskAlreadyExistsFault extends __SmithyException, $Metada } export namespace ExportTaskAlreadyExistsFault { + /** + * @internal + */ export const filterSensitiveLog = (obj: ExportTaskAlreadyExistsFault): any => ({ ...obj, }); @@ -8172,6 +8664,9 @@ export interface IamRoleMissingPermissionsFault extends __SmithyException, $Meta } export namespace IamRoleMissingPermissionsFault { + /** + * @internal + */ export const filterSensitiveLog = (obj: IamRoleMissingPermissionsFault): any => ({ ...obj, }); @@ -8187,6 +8682,9 @@ export interface IamRoleNotFoundFault extends __SmithyException, $MetadataBearer } export namespace IamRoleNotFoundFault { + /** + * @internal + */ export const filterSensitiveLog = (obj: IamRoleNotFoundFault): any => ({ ...obj, }); @@ -8202,6 +8700,9 @@ export interface InvalidExportOnlyFault extends __SmithyException, $MetadataBear } export namespace InvalidExportOnlyFault { + /** + * @internal + */ export const filterSensitiveLog = (obj: InvalidExportOnlyFault): any => ({ ...obj, }); @@ -8217,6 +8718,9 @@ export interface InvalidExportSourceStateFault extends __SmithyException, $Metad } export namespace InvalidExportSourceStateFault { + /** + * @internal + */ export const filterSensitiveLog = (obj: InvalidExportSourceStateFault): any => ({ ...obj, }); @@ -8320,6 +8824,9 @@ export interface StartExportTaskMessage { } export namespace StartExportTaskMessage { + /** + * @internal + */ export const filterSensitiveLog = (obj: StartExportTaskMessage): any => ({ ...obj, }); @@ -8341,6 +8848,9 @@ export interface StopActivityStreamRequest { } export namespace StopActivityStreamRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: StopActivityStreamRequest): any => ({ ...obj, }); @@ -8365,6 +8875,9 @@ export interface StopActivityStreamResponse { } export namespace StopActivityStreamResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: StopActivityStreamResponse): any => ({ ...obj, }); @@ -8379,6 +8892,9 @@ export interface StopDBClusterMessage { } export namespace StopDBClusterMessage { + /** + * @internal + */ export const filterSensitiveLog = (obj: StopDBClusterMessage): any => ({ ...obj, }); @@ -8396,6 +8912,9 @@ export interface StopDBClusterResult { } export namespace StopDBClusterResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: StopDBClusterResult): any => ({ ...obj, }); @@ -8418,6 +8937,9 @@ export interface StopDBInstanceMessage { } export namespace StopDBInstanceMessage { + /** + * @internal + */ export const filterSensitiveLog = (obj: StopDBInstanceMessage): any => ({ ...obj, }); @@ -8434,6 +8956,9 @@ export interface StopDBInstanceResult { } export namespace StopDBInstanceResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: StopDBInstanceResult): any => ({ ...obj, }); @@ -8448,6 +8973,9 @@ export interface StopDBInstanceAutomatedBackupsReplicationMessage { } export namespace StopDBInstanceAutomatedBackupsReplicationMessage { + /** + * @internal + */ export const filterSensitiveLog = (obj: StopDBInstanceAutomatedBackupsReplicationMessage): any => ({ ...obj, }); @@ -8462,6 +8990,9 @@ export interface StopDBInstanceAutomatedBackupsReplicationResult { } export namespace StopDBInstanceAutomatedBackupsReplicationResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: StopDBInstanceAutomatedBackupsReplicationResult): any => ({ ...obj, }); diff --git a/clients/client-redshift-data/commands/CancelStatementCommand.ts b/clients/client-redshift-data/commands/CancelStatementCommand.ts index 0ff781eff236..570eb5f7e913 100644 --- a/clients/client-redshift-data/commands/CancelStatementCommand.ts +++ b/clients/client-redshift-data/commands/CancelStatementCommand.ts @@ -22,6 +22,20 @@ export interface CancelStatementCommandOutput extends CancelStatementResponse, _ /** *

Cancels a running query. To be canceled, a query must be running.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { RedshiftDataClient, CancelStatementCommand } from "@aws-sdk/client-redshift-data"; // ES Modules import + * // const { RedshiftDataClient, CancelStatementCommand } = require("@aws-sdk/client-redshift-data"); // CommonJS import + * const client = new RedshiftDataClient(config); + * const command = new CancelStatementCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CancelStatementCommandInput} for command's `input` shape. + * @see {@link CancelStatementCommandOutput} for command's `response` shape. + * @see {@link RedshiftDataClientResolvedConfig | config} for command's `input` shape. + * */ export class CancelStatementCommand extends $Command< CancelStatementCommandInput, diff --git a/clients/client-redshift-data/commands/DescribeStatementCommand.ts b/clients/client-redshift-data/commands/DescribeStatementCommand.ts index c76b1971ffa2..d5911b11933e 100644 --- a/clients/client-redshift-data/commands/DescribeStatementCommand.ts +++ b/clients/client-redshift-data/commands/DescribeStatementCommand.ts @@ -24,6 +24,20 @@ export interface DescribeStatementCommandOutput extends DescribeStatementRespons *

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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { RedshiftDataClient, DescribeStatementCommand } from "@aws-sdk/client-redshift-data"; // ES Modules import + * // const { RedshiftDataClient, DescribeStatementCommand } = require("@aws-sdk/client-redshift-data"); // CommonJS import + * const client = new RedshiftDataClient(config); + * const command = new DescribeStatementCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeStatementCommandInput} for command's `input` shape. + * @see {@link DescribeStatementCommandOutput} for command's `response` shape. + * @see {@link RedshiftDataClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeStatementCommand extends $Command< DescribeStatementCommandInput, diff --git a/clients/client-redshift-data/commands/DescribeTableCommand.ts b/clients/client-redshift-data/commands/DescribeTableCommand.ts index a35c85ec4e11..10a51ef7f973 100644 --- a/clients/client-redshift-data/commands/DescribeTableCommand.ts +++ b/clients/client-redshift-data/commands/DescribeTableCommand.ts @@ -37,6 +37,20 @@ export interface DescribeTableCommandOutput extends DescribeTableResponse, __Met * required to use this method.

* * + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { RedshiftDataClient, DescribeTableCommand } from "@aws-sdk/client-redshift-data"; // ES Modules import + * // const { RedshiftDataClient, DescribeTableCommand } = require("@aws-sdk/client-redshift-data"); // CommonJS import + * const client = new RedshiftDataClient(config); + * const command = new DescribeTableCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeTableCommandInput} for command's `input` shape. + * @see {@link DescribeTableCommandOutput} for command's `response` shape. + * @see {@link RedshiftDataClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeTableCommand extends $Command< DescribeTableCommandInput, diff --git a/clients/client-redshift-data/commands/ExecuteStatementCommand.ts b/clients/client-redshift-data/commands/ExecuteStatementCommand.ts index 10606ee16fac..caf54c2fdc92 100644 --- a/clients/client-redshift-data/commands/ExecuteStatementCommand.ts +++ b/clients/client-redshift-data/commands/ExecuteStatementCommand.ts @@ -36,6 +36,20 @@ export interface ExecuteStatementCommandOutput extends ExecuteStatementOutput, _ * operation is required to use this method.

* * + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { RedshiftDataClient, ExecuteStatementCommand } from "@aws-sdk/client-redshift-data"; // ES Modules import + * // const { RedshiftDataClient, ExecuteStatementCommand } = require("@aws-sdk/client-redshift-data"); // CommonJS import + * const client = new RedshiftDataClient(config); + * const command = new ExecuteStatementCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ExecuteStatementCommandInput} for command's `input` shape. + * @see {@link ExecuteStatementCommandOutput} for command's `response` shape. + * @see {@link RedshiftDataClientResolvedConfig | config} for command's `input` shape. + * */ export class ExecuteStatementCommand extends $Command< ExecuteStatementCommandInput, diff --git a/clients/client-redshift-data/commands/GetStatementResultCommand.ts b/clients/client-redshift-data/commands/GetStatementResultCommand.ts index 2b1db28af98b..f6d14817aa52 100644 --- a/clients/client-redshift-data/commands/GetStatementResultCommand.ts +++ b/clients/client-redshift-data/commands/GetStatementResultCommand.ts @@ -23,6 +23,20 @@ export interface GetStatementResultCommandOutput extends GetStatementResultRespo /** *

Fetches the temporarily cached result of an SQL statement. * A token is returned to page through the statement results.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { RedshiftDataClient, GetStatementResultCommand } from "@aws-sdk/client-redshift-data"; // ES Modules import + * // const { RedshiftDataClient, GetStatementResultCommand } = require("@aws-sdk/client-redshift-data"); // CommonJS import + * const client = new RedshiftDataClient(config); + * const command = new GetStatementResultCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetStatementResultCommandInput} for command's `input` shape. + * @see {@link GetStatementResultCommandOutput} for command's `response` shape. + * @see {@link RedshiftDataClientResolvedConfig | config} for command's `input` shape. + * */ export class GetStatementResultCommand extends $Command< GetStatementResultCommandInput, diff --git a/clients/client-redshift-data/commands/ListDatabasesCommand.ts b/clients/client-redshift-data/commands/ListDatabasesCommand.ts index e5e95f62da6e..b1d03f4e3e6d 100644 --- a/clients/client-redshift-data/commands/ListDatabasesCommand.ts +++ b/clients/client-redshift-data/commands/ListDatabasesCommand.ts @@ -36,6 +36,20 @@ export interface ListDatabasesCommandOutput extends ListDatabasesResponse, __Met * operation is required to use this method.

* * + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { RedshiftDataClient, ListDatabasesCommand } from "@aws-sdk/client-redshift-data"; // ES Modules import + * // const { RedshiftDataClient, ListDatabasesCommand } = require("@aws-sdk/client-redshift-data"); // CommonJS import + * const client = new RedshiftDataClient(config); + * const command = new ListDatabasesCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListDatabasesCommandInput} for command's `input` shape. + * @see {@link ListDatabasesCommandOutput} for command's `response` shape. + * @see {@link RedshiftDataClientResolvedConfig | config} for command's `input` shape. + * */ export class ListDatabasesCommand extends $Command< ListDatabasesCommandInput, diff --git a/clients/client-redshift-data/commands/ListSchemasCommand.ts b/clients/client-redshift-data/commands/ListSchemasCommand.ts index d8c6165afee5..7b4ba4b54e1a 100644 --- a/clients/client-redshift-data/commands/ListSchemasCommand.ts +++ b/clients/client-redshift-data/commands/ListSchemasCommand.ts @@ -36,6 +36,20 @@ export interface ListSchemasCommandOutput extends ListSchemasResponse, __Metadat * operation is required to use this method.

* * + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { RedshiftDataClient, ListSchemasCommand } from "@aws-sdk/client-redshift-data"; // ES Modules import + * // const { RedshiftDataClient, ListSchemasCommand } = require("@aws-sdk/client-redshift-data"); // CommonJS import + * const client = new RedshiftDataClient(config); + * const command = new ListSchemasCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListSchemasCommandInput} for command's `input` shape. + * @see {@link ListSchemasCommandOutput} for command's `response` shape. + * @see {@link RedshiftDataClientResolvedConfig | config} for command's `input` shape. + * */ export class ListSchemasCommand extends $Command< ListSchemasCommandInput, diff --git a/clients/client-redshift-data/commands/ListStatementsCommand.ts b/clients/client-redshift-data/commands/ListStatementsCommand.ts index a8fba00f2bbf..21a2af7fe66b 100644 --- a/clients/client-redshift-data/commands/ListStatementsCommand.ts +++ b/clients/client-redshift-data/commands/ListStatementsCommand.ts @@ -23,6 +23,20 @@ export interface ListStatementsCommandOutput extends ListStatementsResponse, __M /** *

List of SQL statements. By default, only finished statements are shown. * A token is returned to page through the statement list.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { RedshiftDataClient, ListStatementsCommand } from "@aws-sdk/client-redshift-data"; // ES Modules import + * // const { RedshiftDataClient, ListStatementsCommand } = require("@aws-sdk/client-redshift-data"); // CommonJS import + * const client = new RedshiftDataClient(config); + * const command = new ListStatementsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListStatementsCommandInput} for command's `input` shape. + * @see {@link ListStatementsCommandOutput} for command's `response` shape. + * @see {@link RedshiftDataClientResolvedConfig | config} for command's `input` shape. + * */ export class ListStatementsCommand extends $Command< ListStatementsCommandInput, diff --git a/clients/client-redshift-data/commands/ListTablesCommand.ts b/clients/client-redshift-data/commands/ListTablesCommand.ts index fc98a8a16aa7..e96611b85d9b 100644 --- a/clients/client-redshift-data/commands/ListTablesCommand.ts +++ b/clients/client-redshift-data/commands/ListTablesCommand.ts @@ -37,6 +37,20 @@ export interface ListTablesCommandOutput extends ListTablesResponse, __MetadataB * operation is required to use this method.

* * + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { RedshiftDataClient, ListTablesCommand } from "@aws-sdk/client-redshift-data"; // ES Modules import + * // const { RedshiftDataClient, ListTablesCommand } = require("@aws-sdk/client-redshift-data"); // CommonJS import + * const client = new RedshiftDataClient(config); + * const command = new ListTablesCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListTablesCommandInput} for command's `input` shape. + * @see {@link ListTablesCommandOutput} for command's `response` shape. + * @see {@link RedshiftDataClientResolvedConfig | config} for command's `input` shape. + * */ export class ListTablesCommand extends $Command< ListTablesCommandInput, diff --git a/clients/client-redshift-data/models/models_0.ts b/clients/client-redshift-data/models/models_0.ts index 002798675ae7..90d5aaff421f 100644 --- a/clients/client-redshift-data/models/models_0.ts +++ b/clients/client-redshift-data/models/models_0.ts @@ -11,6 +11,9 @@ export interface ActiveStatementsExceededException extends __SmithyException, $M } export namespace ActiveStatementsExceededException { + /** + * @internal + */ export const filterSensitiveLog = (obj: ActiveStatementsExceededException): any => ({ ...obj, }); @@ -25,6 +28,9 @@ export interface CancelStatementRequest { } export namespace CancelStatementRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: CancelStatementRequest): any => ({ ...obj, }); @@ -38,6 +44,9 @@ export interface CancelStatementResponse { } export namespace CancelStatementResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: CancelStatementResponse): any => ({ ...obj, }); @@ -56,6 +65,9 @@ export interface InternalServerException extends __SmithyException, $MetadataBea } export namespace InternalServerException { + /** + * @internal + */ export const filterSensitiveLog = (obj: InternalServerException): any => ({ ...obj, }); @@ -79,6 +91,9 @@ export interface ResourceNotFoundException extends __SmithyException, $MetadataB } export namespace ResourceNotFoundException { + /** + * @internal + */ export const filterSensitiveLog = (obj: ResourceNotFoundException): any => ({ ...obj, }); @@ -155,6 +170,9 @@ export interface ColumnMetadata { } export namespace ColumnMetadata { + /** + * @internal + */ export const filterSensitiveLog = (obj: ColumnMetadata): any => ({ ...obj, }); @@ -169,6 +187,9 @@ export interface DescribeStatementRequest { } export namespace DescribeStatementRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeStatementRequest): any => ({ ...obj, }); @@ -293,6 +314,9 @@ export interface DescribeStatementResponse { } export namespace DescribeStatementResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeStatementResponse): any => ({ ...obj, }); @@ -311,6 +335,9 @@ export interface ValidationException extends __SmithyException, $MetadataBearer } export namespace ValidationException { + /** + * @internal + */ export const filterSensitiveLog = (obj: ValidationException): any => ({ ...obj, }); @@ -367,6 +394,9 @@ export interface DescribeTableRequest { } export namespace DescribeTableRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeTableRequest): any => ({ ...obj, }); @@ -390,6 +420,9 @@ export interface DescribeTableResponse { } export namespace DescribeTableResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeTableResponse): any => ({ ...obj, }); @@ -413,6 +446,9 @@ export interface ExecuteStatementException extends __SmithyException, $MetadataB } export namespace ExecuteStatementException { + /** + * @internal + */ export const filterSensitiveLog = (obj: ExecuteStatementException): any => ({ ...obj, }); @@ -456,6 +492,9 @@ export interface ExecuteStatementInput { } export namespace ExecuteStatementInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: ExecuteStatementInput): any => ({ ...obj, }); @@ -494,6 +533,9 @@ export interface ExecuteStatementOutput { } export namespace ExecuteStatementOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: ExecuteStatementOutput): any => ({ ...obj, }); @@ -620,6 +662,9 @@ export namespace Field { return visitor._(value.$unknown[0], value.$unknown[1]); }; + /** + * @internal + */ export const filterSensitiveLog = (obj: Field): any => { if (obj.isNull !== undefined) return { isNull: obj.isNull }; if (obj.booleanValue !== undefined) return { booleanValue: obj.booleanValue }; @@ -645,6 +690,9 @@ export interface GetStatementResultRequest { } export namespace GetStatementResultRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetStatementResultRequest): any => ({ ...obj, }); @@ -674,6 +722,9 @@ export interface GetStatementResultResponse { } export namespace GetStatementResultResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetStatementResultResponse): any => ({ ...obj, ...(obj.Records && { Records: obj.Records.map((item) => item.map((item) => Field.filterSensitiveLog(item))) }), @@ -714,6 +765,9 @@ export interface ListDatabasesRequest { } export namespace ListDatabasesRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListDatabasesRequest): any => ({ ...obj, }); @@ -732,6 +786,9 @@ export interface ListDatabasesResponse { } export namespace ListDatabasesResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListDatabasesResponse): any => ({ ...obj, }); @@ -784,6 +841,9 @@ export interface ListSchemasRequest { } export namespace ListSchemasRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListSchemasRequest): any => ({ ...obj, }); @@ -802,6 +862,9 @@ export interface ListSchemasResponse { } export namespace ListSchemasResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListSchemasResponse): any => ({ ...obj, }); @@ -863,6 +926,9 @@ export interface ListStatementsRequest { } export namespace ListStatementsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListStatementsRequest): any => ({ ...obj, }); @@ -911,6 +977,9 @@ export interface StatementData { } export namespace StatementData { + /** + * @internal + */ export const filterSensitiveLog = (obj: StatementData): any => ({ ...obj, }); @@ -929,6 +998,9 @@ export interface ListStatementsResponse { } export namespace ListStatementsResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListStatementsResponse): any => ({ ...obj, }); @@ -992,6 +1064,9 @@ export interface ListTablesRequest { } export namespace ListTablesRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListTablesRequest): any => ({ ...obj, }); @@ -1019,6 +1094,9 @@ export interface TableMember { } export namespace TableMember { + /** + * @internal + */ export const filterSensitiveLog = (obj: TableMember): any => ({ ...obj, }); @@ -1037,6 +1115,9 @@ export interface ListTablesResponse { } export namespace ListTablesResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListTablesResponse): any => ({ ...obj, }); diff --git a/clients/client-redshift/commands/AcceptReservedNodeExchangeCommand.ts b/clients/client-redshift/commands/AcceptReservedNodeExchangeCommand.ts index 62facebae8e3..90d53b572110 100644 --- a/clients/client-redshift/commands/AcceptReservedNodeExchangeCommand.ts +++ b/clients/client-redshift/commands/AcceptReservedNodeExchangeCommand.ts @@ -26,6 +26,20 @@ export interface AcceptReservedNodeExchangeCommandOutput *

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. *

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { RedshiftClient, AcceptReservedNodeExchangeCommand } from "@aws-sdk/client-redshift"; // ES Modules import + * // const { RedshiftClient, AcceptReservedNodeExchangeCommand } = require("@aws-sdk/client-redshift"); // CommonJS import + * const client = new RedshiftClient(config); + * const command = new AcceptReservedNodeExchangeCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link AcceptReservedNodeExchangeCommandInput} for command's `input` shape. + * @see {@link AcceptReservedNodeExchangeCommandOutput} for command's `response` shape. + * @see {@link RedshiftClientResolvedConfig | config} for command's `input` shape. + * */ export class AcceptReservedNodeExchangeCommand extends $Command< AcceptReservedNodeExchangeCommandInput, diff --git a/clients/client-redshift/commands/AddPartnerCommand.ts b/clients/client-redshift/commands/AddPartnerCommand.ts index 10ee8be356f9..2e493cd80c11 100644 --- a/clients/client-redshift/commands/AddPartnerCommand.ts +++ b/clients/client-redshift/commands/AddPartnerCommand.ts @@ -21,6 +21,20 @@ export interface AddPartnerCommandOutput extends PartnerIntegrationOutputMessage *

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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { RedshiftClient, AddPartnerCommand } from "@aws-sdk/client-redshift"; // ES Modules import + * // const { RedshiftClient, AddPartnerCommand } = require("@aws-sdk/client-redshift"); // CommonJS import + * const client = new RedshiftClient(config); + * const command = new AddPartnerCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link AddPartnerCommandInput} for command's `input` shape. + * @see {@link AddPartnerCommandOutput} for command's `response` shape. + * @see {@link RedshiftClientResolvedConfig | config} for command's `input` shape. + * */ export class AddPartnerCommand extends $Command< AddPartnerCommandInput, diff --git a/clients/client-redshift/commands/AuthorizeClusterSecurityGroupIngressCommand.ts b/clients/client-redshift/commands/AuthorizeClusterSecurityGroupIngressCommand.ts index 8bc78e06ead6..37fc22cfaa26 100644 --- a/clients/client-redshift/commands/AuthorizeClusterSecurityGroupIngressCommand.ts +++ b/clients/client-redshift/commands/AuthorizeClusterSecurityGroupIngressCommand.ts @@ -42,6 +42,20 @@ export interface AuthorizeClusterSecurityGroupIngressCommandOutput * 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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { RedshiftClient, AuthorizeClusterSecurityGroupIngressCommand } from "@aws-sdk/client-redshift"; // ES Modules import + * // const { RedshiftClient, AuthorizeClusterSecurityGroupIngressCommand } = require("@aws-sdk/client-redshift"); // CommonJS import + * const client = new RedshiftClient(config); + * const command = new AuthorizeClusterSecurityGroupIngressCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link AuthorizeClusterSecurityGroupIngressCommandInput} for command's `input` shape. + * @see {@link AuthorizeClusterSecurityGroupIngressCommandOutput} for command's `response` shape. + * @see {@link RedshiftClientResolvedConfig | config} for command's `input` shape. + * */ export class AuthorizeClusterSecurityGroupIngressCommand extends $Command< AuthorizeClusterSecurityGroupIngressCommandInput, diff --git a/clients/client-redshift/commands/AuthorizeEndpointAccessCommand.ts b/clients/client-redshift/commands/AuthorizeEndpointAccessCommand.ts index c3d96d3ad8a7..b3f6312c5094 100644 --- a/clients/client-redshift/commands/AuthorizeEndpointAccessCommand.ts +++ b/clients/client-redshift/commands/AuthorizeEndpointAccessCommand.ts @@ -22,6 +22,20 @@ export interface AuthorizeEndpointAccessCommandOutput extends EndpointAuthorizat /** *

Grants access to a cluster.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { RedshiftClient, AuthorizeEndpointAccessCommand } from "@aws-sdk/client-redshift"; // ES Modules import + * // const { RedshiftClient, AuthorizeEndpointAccessCommand } = require("@aws-sdk/client-redshift"); // CommonJS import + * const client = new RedshiftClient(config); + * const command = new AuthorizeEndpointAccessCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link AuthorizeEndpointAccessCommandInput} for command's `input` shape. + * @see {@link AuthorizeEndpointAccessCommandOutput} for command's `response` shape. + * @see {@link RedshiftClientResolvedConfig | config} for command's `input` shape. + * */ export class AuthorizeEndpointAccessCommand extends $Command< AuthorizeEndpointAccessCommandInput, diff --git a/clients/client-redshift/commands/AuthorizeSnapshotAccessCommand.ts b/clients/client-redshift/commands/AuthorizeSnapshotAccessCommand.ts index 48fa8a54cca8..98f59fba9e2b 100644 --- a/clients/client-redshift/commands/AuthorizeSnapshotAccessCommand.ts +++ b/clients/client-redshift/commands/AuthorizeSnapshotAccessCommand.ts @@ -27,6 +27,20 @@ export interface AuthorizeSnapshotAccessCommandOutput extends AuthorizeSnapshotA * For more information about working with snapshots, go to * Amazon Redshift Snapshots * in the Amazon Redshift Cluster Management Guide.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { RedshiftClient, AuthorizeSnapshotAccessCommand } from "@aws-sdk/client-redshift"; // ES Modules import + * // const { RedshiftClient, AuthorizeSnapshotAccessCommand } = require("@aws-sdk/client-redshift"); // CommonJS import + * const client = new RedshiftClient(config); + * const command = new AuthorizeSnapshotAccessCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link AuthorizeSnapshotAccessCommandInput} for command's `input` shape. + * @see {@link AuthorizeSnapshotAccessCommandOutput} for command's `response` shape. + * @see {@link RedshiftClientResolvedConfig | config} for command's `input` shape. + * */ export class AuthorizeSnapshotAccessCommand extends $Command< AuthorizeSnapshotAccessCommandInput, diff --git a/clients/client-redshift/commands/BatchDeleteClusterSnapshotsCommand.ts b/clients/client-redshift/commands/BatchDeleteClusterSnapshotsCommand.ts index fa72515e34f8..9a5bd8c7886c 100644 --- a/clients/client-redshift/commands/BatchDeleteClusterSnapshotsCommand.ts +++ b/clients/client-redshift/commands/BatchDeleteClusterSnapshotsCommand.ts @@ -22,6 +22,20 @@ export interface BatchDeleteClusterSnapshotsCommandOutput extends BatchDeleteClu /** *

Deletes a set of cluster snapshots.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { RedshiftClient, BatchDeleteClusterSnapshotsCommand } from "@aws-sdk/client-redshift"; // ES Modules import + * // const { RedshiftClient, BatchDeleteClusterSnapshotsCommand } = require("@aws-sdk/client-redshift"); // CommonJS import + * const client = new RedshiftClient(config); + * const command = new BatchDeleteClusterSnapshotsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link BatchDeleteClusterSnapshotsCommandInput} for command's `input` shape. + * @see {@link BatchDeleteClusterSnapshotsCommandOutput} for command's `response` shape. + * @see {@link RedshiftClientResolvedConfig | config} for command's `input` shape. + * */ export class BatchDeleteClusterSnapshotsCommand extends $Command< BatchDeleteClusterSnapshotsCommandInput, diff --git a/clients/client-redshift/commands/BatchModifyClusterSnapshotsCommand.ts b/clients/client-redshift/commands/BatchModifyClusterSnapshotsCommand.ts index 7e78338803a1..7fb41e8d3ce7 100644 --- a/clients/client-redshift/commands/BatchModifyClusterSnapshotsCommand.ts +++ b/clients/client-redshift/commands/BatchModifyClusterSnapshotsCommand.ts @@ -24,6 +24,20 @@ export interface BatchModifyClusterSnapshotsCommandOutput /** *

Modifies the settings for a set of cluster snapshots.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { RedshiftClient, BatchModifyClusterSnapshotsCommand } from "@aws-sdk/client-redshift"; // ES Modules import + * // const { RedshiftClient, BatchModifyClusterSnapshotsCommand } = require("@aws-sdk/client-redshift"); // CommonJS import + * const client = new RedshiftClient(config); + * const command = new BatchModifyClusterSnapshotsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link BatchModifyClusterSnapshotsCommandInput} for command's `input` shape. + * @see {@link BatchModifyClusterSnapshotsCommandOutput} for command's `response` shape. + * @see {@link RedshiftClientResolvedConfig | config} for command's `input` shape. + * */ export class BatchModifyClusterSnapshotsCommand extends $Command< BatchModifyClusterSnapshotsCommandInput, diff --git a/clients/client-redshift/commands/CancelResizeCommand.ts b/clients/client-redshift/commands/CancelResizeCommand.ts index dd05bf90f43f..c4852a6d990c 100644 --- a/clients/client-redshift/commands/CancelResizeCommand.ts +++ b/clients/client-redshift/commands/CancelResizeCommand.ts @@ -19,6 +19,20 @@ export interface CancelResizeCommandOutput extends ResizeProgressMessage, __Meta /** *

Cancels a resize operation for a cluster.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { RedshiftClient, CancelResizeCommand } from "@aws-sdk/client-redshift"; // ES Modules import + * // const { RedshiftClient, CancelResizeCommand } = require("@aws-sdk/client-redshift"); // CommonJS import + * const client = new RedshiftClient(config); + * const command = new CancelResizeCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CancelResizeCommandInput} for command's `input` shape. + * @see {@link CancelResizeCommandOutput} for command's `response` shape. + * @see {@link RedshiftClientResolvedConfig | config} for command's `input` shape. + * */ export class CancelResizeCommand extends $Command< CancelResizeCommandInput, diff --git a/clients/client-redshift/commands/CopyClusterSnapshotCommand.ts b/clients/client-redshift/commands/CopyClusterSnapshotCommand.ts index d65d80d882d4..a73a8ed695cc 100644 --- a/clients/client-redshift/commands/CopyClusterSnapshotCommand.ts +++ b/clients/client-redshift/commands/CopyClusterSnapshotCommand.ts @@ -33,6 +33,20 @@ export interface CopyClusterSnapshotCommandOutput extends CopyClusterSnapshotRes * For more information about working with snapshots, go to * Amazon Redshift Snapshots * in the Amazon Redshift Cluster Management Guide.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { RedshiftClient, CopyClusterSnapshotCommand } from "@aws-sdk/client-redshift"; // ES Modules import + * // const { RedshiftClient, CopyClusterSnapshotCommand } = require("@aws-sdk/client-redshift"); // CommonJS import + * const client = new RedshiftClient(config); + * const command = new CopyClusterSnapshotCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CopyClusterSnapshotCommandInput} for command's `input` shape. + * @see {@link CopyClusterSnapshotCommandOutput} for command's `response` shape. + * @see {@link RedshiftClientResolvedConfig | config} for command's `input` shape. + * */ export class CopyClusterSnapshotCommand extends $Command< CopyClusterSnapshotCommandInput, diff --git a/clients/client-redshift/commands/CreateClusterCommand.ts b/clients/client-redshift/commands/CreateClusterCommand.ts index 1668c1572cc4..54dcc7df8c9c 100644 --- a/clients/client-redshift/commands/CreateClusterCommand.ts +++ b/clients/client-redshift/commands/CreateClusterCommand.ts @@ -28,6 +28,20 @@ export interface CreateClusterCommandOutput extends CreateClusterResult, __Metad * For more information about managing clusters, go to * Amazon Redshift Clusters * in the Amazon Redshift Cluster Management Guide.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { RedshiftClient, CreateClusterCommand } from "@aws-sdk/client-redshift"; // ES Modules import + * // const { RedshiftClient, CreateClusterCommand } = require("@aws-sdk/client-redshift"); // CommonJS import + * const client = new RedshiftClient(config); + * const command = new CreateClusterCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreateClusterCommandInput} for command's `input` shape. + * @see {@link CreateClusterCommandOutput} for command's `response` shape. + * @see {@link RedshiftClientResolvedConfig | config} for command's `input` shape. + * */ export class CreateClusterCommand extends $Command< CreateClusterCommandInput, diff --git a/clients/client-redshift/commands/CreateClusterParameterGroupCommand.ts b/clients/client-redshift/commands/CreateClusterParameterGroupCommand.ts index 6765b87a8dc3..cf24bebedf0e 100644 --- a/clients/client-redshift/commands/CreateClusterParameterGroupCommand.ts +++ b/clients/client-redshift/commands/CreateClusterParameterGroupCommand.ts @@ -30,6 +30,20 @@ export interface CreateClusterParameterGroupCommandOutput extends CreateClusterP * For more information about parameters and parameter groups, go to * Amazon Redshift Parameter Groups * in the Amazon Redshift Cluster Management Guide.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { RedshiftClient, CreateClusterParameterGroupCommand } from "@aws-sdk/client-redshift"; // ES Modules import + * // const { RedshiftClient, CreateClusterParameterGroupCommand } = require("@aws-sdk/client-redshift"); // CommonJS import + * const client = new RedshiftClient(config); + * const command = new CreateClusterParameterGroupCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreateClusterParameterGroupCommandInput} for command's `input` shape. + * @see {@link CreateClusterParameterGroupCommandOutput} for command's `response` shape. + * @see {@link RedshiftClientResolvedConfig | config} for command's `input` shape. + * */ export class CreateClusterParameterGroupCommand extends $Command< CreateClusterParameterGroupCommandInput, diff --git a/clients/client-redshift/commands/CreateClusterSecurityGroupCommand.ts b/clients/client-redshift/commands/CreateClusterSecurityGroupCommand.ts index 4b4b0b60da54..555408bb02d5 100644 --- a/clients/client-redshift/commands/CreateClusterSecurityGroupCommand.ts +++ b/clients/client-redshift/commands/CreateClusterSecurityGroupCommand.ts @@ -27,6 +27,20 @@ export interface CreateClusterSecurityGroupCommandOutput extends CreateClusterSe * For information about managing security groups, go to * Amazon Redshift Cluster Security Groups in the * Amazon Redshift Cluster Management Guide.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { RedshiftClient, CreateClusterSecurityGroupCommand } from "@aws-sdk/client-redshift"; // ES Modules import + * // const { RedshiftClient, CreateClusterSecurityGroupCommand } = require("@aws-sdk/client-redshift"); // CommonJS import + * const client = new RedshiftClient(config); + * const command = new CreateClusterSecurityGroupCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreateClusterSecurityGroupCommandInput} for command's `input` shape. + * @see {@link CreateClusterSecurityGroupCommandOutput} for command's `response` shape. + * @see {@link RedshiftClientResolvedConfig | config} for command's `input` shape. + * */ export class CreateClusterSecurityGroupCommand extends $Command< CreateClusterSecurityGroupCommandInput, diff --git a/clients/client-redshift/commands/CreateClusterSnapshotCommand.ts b/clients/client-redshift/commands/CreateClusterSnapshotCommand.ts index 7789c88e8869..d721cee89f03 100644 --- a/clients/client-redshift/commands/CreateClusterSnapshotCommand.ts +++ b/clients/client-redshift/commands/CreateClusterSnapshotCommand.ts @@ -27,6 +27,20 @@ export interface CreateClusterSnapshotCommandOutput extends CreateClusterSnapsho * For more information about working with snapshots, go to * Amazon Redshift Snapshots * in the Amazon Redshift Cluster Management Guide.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { RedshiftClient, CreateClusterSnapshotCommand } from "@aws-sdk/client-redshift"; // ES Modules import + * // const { RedshiftClient, CreateClusterSnapshotCommand } = require("@aws-sdk/client-redshift"); // CommonJS import + * const client = new RedshiftClient(config); + * const command = new CreateClusterSnapshotCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreateClusterSnapshotCommandInput} for command's `input` shape. + * @see {@link CreateClusterSnapshotCommandOutput} for command's `response` shape. + * @see {@link RedshiftClientResolvedConfig | config} for command's `input` shape. + * */ export class CreateClusterSnapshotCommand extends $Command< CreateClusterSnapshotCommandInput, diff --git a/clients/client-redshift/commands/CreateClusterSubnetGroupCommand.ts b/clients/client-redshift/commands/CreateClusterSubnetGroupCommand.ts index 86808d8e11e6..3061a4a9fad1 100644 --- a/clients/client-redshift/commands/CreateClusterSubnetGroupCommand.ts +++ b/clients/client-redshift/commands/CreateClusterSubnetGroupCommand.ts @@ -28,6 +28,20 @@ export interface CreateClusterSubnetGroupCommandOutput extends CreateClusterSubn * For information about subnet groups, go to * Amazon Redshift Cluster Subnet Groups in the * Amazon Redshift Cluster Management Guide.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { RedshiftClient, CreateClusterSubnetGroupCommand } from "@aws-sdk/client-redshift"; // ES Modules import + * // const { RedshiftClient, CreateClusterSubnetGroupCommand } = require("@aws-sdk/client-redshift"); // CommonJS import + * const client = new RedshiftClient(config); + * const command = new CreateClusterSubnetGroupCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreateClusterSubnetGroupCommandInput} for command's `input` shape. + * @see {@link CreateClusterSubnetGroupCommandOutput} for command's `response` shape. + * @see {@link RedshiftClientResolvedConfig | config} for command's `input` shape. + * */ export class CreateClusterSubnetGroupCommand extends $Command< CreateClusterSubnetGroupCommandInput, diff --git a/clients/client-redshift/commands/CreateEndpointAccessCommand.ts b/clients/client-redshift/commands/CreateEndpointAccessCommand.ts index 029627cfd20f..1154d6e462b9 100644 --- a/clients/client-redshift/commands/CreateEndpointAccessCommand.ts +++ b/clients/client-redshift/commands/CreateEndpointAccessCommand.ts @@ -22,6 +22,20 @@ export interface CreateEndpointAccessCommandOutput extends EndpointAccess, __Met /** *

Creates a Redshift-managed VPC endpoint.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { RedshiftClient, CreateEndpointAccessCommand } from "@aws-sdk/client-redshift"; // ES Modules import + * // const { RedshiftClient, CreateEndpointAccessCommand } = require("@aws-sdk/client-redshift"); // CommonJS import + * const client = new RedshiftClient(config); + * const command = new CreateEndpointAccessCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreateEndpointAccessCommandInput} for command's `input` shape. + * @see {@link CreateEndpointAccessCommandOutput} for command's `response` shape. + * @see {@link RedshiftClientResolvedConfig | config} for command's `input` shape. + * */ export class CreateEndpointAccessCommand extends $Command< CreateEndpointAccessCommandInput, diff --git a/clients/client-redshift/commands/CreateEventSubscriptionCommand.ts b/clients/client-redshift/commands/CreateEventSubscriptionCommand.ts index 0ce4628e39a0..15a54da01299 100644 --- a/clients/client-redshift/commands/CreateEventSubscriptionCommand.ts +++ b/clients/client-redshift/commands/CreateEventSubscriptionCommand.ts @@ -39,6 +39,20 @@ export interface CreateEventSubscriptionCommandOutput extends CreateEventSubscri * AWS 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 AWS * account. You must specify a source type if you specify a source ID.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { RedshiftClient, CreateEventSubscriptionCommand } from "@aws-sdk/client-redshift"; // ES Modules import + * // const { RedshiftClient, CreateEventSubscriptionCommand } = require("@aws-sdk/client-redshift"); // CommonJS import + * const client = new RedshiftClient(config); + * const command = new CreateEventSubscriptionCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreateEventSubscriptionCommandInput} for command's `input` shape. + * @see {@link CreateEventSubscriptionCommandOutput} for command's `response` shape. + * @see {@link RedshiftClientResolvedConfig | config} for command's `input` shape. + * */ export class CreateEventSubscriptionCommand extends $Command< CreateEventSubscriptionCommandInput, diff --git a/clients/client-redshift/commands/CreateHsmClientCertificateCommand.ts b/clients/client-redshift/commands/CreateHsmClientCertificateCommand.ts index bcd2f1f88fdb..ba5f6d931340 100644 --- a/clients/client-redshift/commands/CreateHsmClientCertificateCommand.ts +++ b/clients/client-redshift/commands/CreateHsmClientCertificateCommand.ts @@ -29,6 +29,20 @@ export interface CreateHsmClientCertificateCommandOutput extends CreateHsmClient * 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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { RedshiftClient, CreateHsmClientCertificateCommand } from "@aws-sdk/client-redshift"; // ES Modules import + * // const { RedshiftClient, CreateHsmClientCertificateCommand } = require("@aws-sdk/client-redshift"); // CommonJS import + * const client = new RedshiftClient(config); + * const command = new CreateHsmClientCertificateCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreateHsmClientCertificateCommandInput} for command's `input` shape. + * @see {@link CreateHsmClientCertificateCommandOutput} for command's `response` shape. + * @see {@link RedshiftClientResolvedConfig | config} for command's `input` shape. + * */ export class CreateHsmClientCertificateCommand extends $Command< CreateHsmClientCertificateCommandInput, diff --git a/clients/client-redshift/commands/CreateHsmConfigurationCommand.ts b/clients/client-redshift/commands/CreateHsmConfigurationCommand.ts index c56eccf3461d..41872e748945 100644 --- a/clients/client-redshift/commands/CreateHsmConfigurationCommand.ts +++ b/clients/client-redshift/commands/CreateHsmConfigurationCommand.ts @@ -28,6 +28,20 @@ export interface CreateHsmConfigurationCommandOutput extends CreateHsmConfigurat *

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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { RedshiftClient, CreateHsmConfigurationCommand } from "@aws-sdk/client-redshift"; // ES Modules import + * // const { RedshiftClient, CreateHsmConfigurationCommand } = require("@aws-sdk/client-redshift"); // CommonJS import + * const client = new RedshiftClient(config); + * const command = new CreateHsmConfigurationCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreateHsmConfigurationCommandInput} for command's `input` shape. + * @see {@link CreateHsmConfigurationCommandOutput} for command's `response` shape. + * @see {@link RedshiftClientResolvedConfig | config} for command's `input` shape. + * */ export class CreateHsmConfigurationCommand extends $Command< CreateHsmConfigurationCommandInput, diff --git a/clients/client-redshift/commands/CreateScheduledActionCommand.ts b/clients/client-redshift/commands/CreateScheduledActionCommand.ts index 3a8a9a78de2a..2e4518bb5264 100644 --- a/clients/client-redshift/commands/CreateScheduledActionCommand.ts +++ b/clients/client-redshift/commands/CreateScheduledActionCommand.ts @@ -24,6 +24,20 @@ export interface CreateScheduledActionCommandOutput extends ScheduledAction, __M *

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. *

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { RedshiftClient, CreateScheduledActionCommand } from "@aws-sdk/client-redshift"; // ES Modules import + * // const { RedshiftClient, CreateScheduledActionCommand } = require("@aws-sdk/client-redshift"); // CommonJS import + * const client = new RedshiftClient(config); + * const command = new CreateScheduledActionCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreateScheduledActionCommandInput} for command's `input` shape. + * @see {@link CreateScheduledActionCommandOutput} for command's `response` shape. + * @see {@link RedshiftClientResolvedConfig | config} for command's `input` shape. + * */ export class CreateScheduledActionCommand extends $Command< CreateScheduledActionCommandInput, diff --git a/clients/client-redshift/commands/CreateSnapshotCopyGrantCommand.ts b/clients/client-redshift/commands/CreateSnapshotCopyGrantCommand.ts index 0f616d0dd7f3..82d8de6c4c66 100644 --- a/clients/client-redshift/commands/CreateSnapshotCopyGrantCommand.ts +++ b/clients/client-redshift/commands/CreateSnapshotCopyGrantCommand.ts @@ -29,6 +29,20 @@ export interface CreateSnapshotCopyGrantCommandOutput extends CreateSnapshotCopy * Amazon Redshift Database Encryption * in the Amazon Redshift Cluster Management Guide. *

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { RedshiftClient, CreateSnapshotCopyGrantCommand } from "@aws-sdk/client-redshift"; // ES Modules import + * // const { RedshiftClient, CreateSnapshotCopyGrantCommand } = require("@aws-sdk/client-redshift"); // CommonJS import + * const client = new RedshiftClient(config); + * const command = new CreateSnapshotCopyGrantCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreateSnapshotCopyGrantCommandInput} for command's `input` shape. + * @see {@link CreateSnapshotCopyGrantCommandOutput} for command's `response` shape. + * @see {@link RedshiftClientResolvedConfig | config} for command's `input` shape. + * */ export class CreateSnapshotCopyGrantCommand extends $Command< CreateSnapshotCopyGrantCommandInput, diff --git a/clients/client-redshift/commands/CreateSnapshotScheduleCommand.ts b/clients/client-redshift/commands/CreateSnapshotScheduleCommand.ts index 14bcd7020ef0..aa29cc464511 100644 --- a/clients/client-redshift/commands/CreateSnapshotScheduleCommand.ts +++ b/clients/client-redshift/commands/CreateSnapshotScheduleCommand.ts @@ -22,6 +22,20 @@ export interface CreateSnapshotScheduleCommandOutput extends SnapshotSchedule, _ /** *

Create a snapshot schedule that can be associated to a cluster and which overrides the default system backup schedule.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { RedshiftClient, CreateSnapshotScheduleCommand } from "@aws-sdk/client-redshift"; // ES Modules import + * // const { RedshiftClient, CreateSnapshotScheduleCommand } = require("@aws-sdk/client-redshift"); // CommonJS import + * const client = new RedshiftClient(config); + * const command = new CreateSnapshotScheduleCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreateSnapshotScheduleCommandInput} for command's `input` shape. + * @see {@link CreateSnapshotScheduleCommandOutput} for command's `response` shape. + * @see {@link RedshiftClientResolvedConfig | config} for command's `input` shape. + * */ export class CreateSnapshotScheduleCommand extends $Command< CreateSnapshotScheduleCommandInput, diff --git a/clients/client-redshift/commands/CreateTagsCommand.ts b/clients/client-redshift/commands/CreateTagsCommand.ts index 7f317fba7276..3e7bd4a57874 100644 --- a/clients/client-redshift/commands/CreateTagsCommand.ts +++ b/clients/client-redshift/commands/CreateTagsCommand.ts @@ -23,6 +23,20 @@ export interface CreateTagsCommandOutput extends __MetadataBearer {} * 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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { RedshiftClient, CreateTagsCommand } from "@aws-sdk/client-redshift"; // ES Modules import + * // const { RedshiftClient, CreateTagsCommand } = require("@aws-sdk/client-redshift"); // CommonJS import + * const client = new RedshiftClient(config); + * const command = new CreateTagsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreateTagsCommandInput} for command's `input` shape. + * @see {@link CreateTagsCommandOutput} for command's `response` shape. + * @see {@link RedshiftClientResolvedConfig | config} for command's `input` shape. + * */ export class CreateTagsCommand extends $Command< CreateTagsCommandInput, diff --git a/clients/client-redshift/commands/CreateUsageLimitCommand.ts b/clients/client-redshift/commands/CreateUsageLimitCommand.ts index 86f73a92eae3..d9a061979b54 100644 --- a/clients/client-redshift/commands/CreateUsageLimitCommand.ts +++ b/clients/client-redshift/commands/CreateUsageLimitCommand.ts @@ -23,6 +23,20 @@ export interface CreateUsageLimitCommandOutput extends UsageLimit, __MetadataBea /** *

Creates a usage limit for a specified Amazon Redshift feature on a cluster. * The usage limit is identified by the returned usage limit identifier.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { RedshiftClient, CreateUsageLimitCommand } from "@aws-sdk/client-redshift"; // ES Modules import + * // const { RedshiftClient, CreateUsageLimitCommand } = require("@aws-sdk/client-redshift"); // CommonJS import + * const client = new RedshiftClient(config); + * const command = new CreateUsageLimitCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreateUsageLimitCommandInput} for command's `input` shape. + * @see {@link CreateUsageLimitCommandOutput} for command's `response` shape. + * @see {@link RedshiftClientResolvedConfig | config} for command's `input` shape. + * */ export class CreateUsageLimitCommand extends $Command< CreateUsageLimitCommandInput, diff --git a/clients/client-redshift/commands/DeleteClusterCommand.ts b/clients/client-redshift/commands/DeleteClusterCommand.ts index 4680a7394b24..51f8d306aeaf 100644 --- a/clients/client-redshift/commands/DeleteClusterCommand.ts +++ b/clients/client-redshift/commands/DeleteClusterCommand.ts @@ -37,6 +37,20 @@ export interface DeleteClusterCommandOutput extends DeleteClusterResult, __Metad * For more information about managing clusters, go to * Amazon Redshift Clusters * in the Amazon Redshift Cluster Management Guide.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { RedshiftClient, DeleteClusterCommand } from "@aws-sdk/client-redshift"; // ES Modules import + * // const { RedshiftClient, DeleteClusterCommand } = require("@aws-sdk/client-redshift"); // CommonJS import + * const client = new RedshiftClient(config); + * const command = new DeleteClusterCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteClusterCommandInput} for command's `input` shape. + * @see {@link DeleteClusterCommandOutput} for command's `response` shape. + * @see {@link RedshiftClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteClusterCommand extends $Command< DeleteClusterCommandInput, diff --git a/clients/client-redshift/commands/DeleteClusterParameterGroupCommand.ts b/clients/client-redshift/commands/DeleteClusterParameterGroupCommand.ts index dab468ca8e6a..51517bd7ba38 100644 --- a/clients/client-redshift/commands/DeleteClusterParameterGroupCommand.ts +++ b/clients/client-redshift/commands/DeleteClusterParameterGroupCommand.ts @@ -26,6 +26,20 @@ export interface DeleteClusterParameterGroupCommandOutput extends __MetadataBear *

You cannot delete a parameter group if it is associated with a * cluster.

* + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { RedshiftClient, DeleteClusterParameterGroupCommand } from "@aws-sdk/client-redshift"; // ES Modules import + * // const { RedshiftClient, DeleteClusterParameterGroupCommand } = require("@aws-sdk/client-redshift"); // CommonJS import + * const client = new RedshiftClient(config); + * const command = new DeleteClusterParameterGroupCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteClusterParameterGroupCommandInput} for command's `input` shape. + * @see {@link DeleteClusterParameterGroupCommandOutput} for command's `response` shape. + * @see {@link RedshiftClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteClusterParameterGroupCommand extends $Command< DeleteClusterParameterGroupCommandInput, diff --git a/clients/client-redshift/commands/DeleteClusterSecurityGroupCommand.ts b/clients/client-redshift/commands/DeleteClusterSecurityGroupCommand.ts index e20459a9cd8f..36beac0d3713 100644 --- a/clients/client-redshift/commands/DeleteClusterSecurityGroupCommand.ts +++ b/clients/client-redshift/commands/DeleteClusterSecurityGroupCommand.ts @@ -30,6 +30,20 @@ export interface DeleteClusterSecurityGroupCommandOutput extends __MetadataBeare * For information about managing security groups, go to * Amazon Redshift Cluster Security Groups in the * Amazon Redshift Cluster Management Guide.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { RedshiftClient, DeleteClusterSecurityGroupCommand } from "@aws-sdk/client-redshift"; // ES Modules import + * // const { RedshiftClient, DeleteClusterSecurityGroupCommand } = require("@aws-sdk/client-redshift"); // CommonJS import + * const client = new RedshiftClient(config); + * const command = new DeleteClusterSecurityGroupCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteClusterSecurityGroupCommandInput} for command's `input` shape. + * @see {@link DeleteClusterSecurityGroupCommandOutput} for command's `response` shape. + * @see {@link RedshiftClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteClusterSecurityGroupCommand extends $Command< DeleteClusterSecurityGroupCommandInput, diff --git a/clients/client-redshift/commands/DeleteClusterSnapshotCommand.ts b/clients/client-redshift/commands/DeleteClusterSnapshotCommand.ts index 70fbf4cd9a12..79acb0de5ba7 100644 --- a/clients/client-redshift/commands/DeleteClusterSnapshotCommand.ts +++ b/clients/client-redshift/commands/DeleteClusterSnapshotCommand.ts @@ -28,6 +28,20 @@ export interface DeleteClusterSnapshotCommandOutput extends DeleteClusterSnapsho * 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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { RedshiftClient, DeleteClusterSnapshotCommand } from "@aws-sdk/client-redshift"; // ES Modules import + * // const { RedshiftClient, DeleteClusterSnapshotCommand } = require("@aws-sdk/client-redshift"); // CommonJS import + * const client = new RedshiftClient(config); + * const command = new DeleteClusterSnapshotCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteClusterSnapshotCommandInput} for command's `input` shape. + * @see {@link DeleteClusterSnapshotCommandOutput} for command's `response` shape. + * @see {@link RedshiftClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteClusterSnapshotCommand extends $Command< DeleteClusterSnapshotCommandInput, diff --git a/clients/client-redshift/commands/DeleteClusterSubnetGroupCommand.ts b/clients/client-redshift/commands/DeleteClusterSubnetGroupCommand.ts index da2350ce71a3..427a3912288b 100644 --- a/clients/client-redshift/commands/DeleteClusterSubnetGroupCommand.ts +++ b/clients/client-redshift/commands/DeleteClusterSubnetGroupCommand.ts @@ -22,6 +22,20 @@ export interface DeleteClusterSubnetGroupCommandOutput extends __MetadataBearer /** *

Deletes the specified cluster subnet group.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { RedshiftClient, DeleteClusterSubnetGroupCommand } from "@aws-sdk/client-redshift"; // ES Modules import + * // const { RedshiftClient, DeleteClusterSubnetGroupCommand } = require("@aws-sdk/client-redshift"); // CommonJS import + * const client = new RedshiftClient(config); + * const command = new DeleteClusterSubnetGroupCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteClusterSubnetGroupCommandInput} for command's `input` shape. + * @see {@link DeleteClusterSubnetGroupCommandOutput} for command's `response` shape. + * @see {@link RedshiftClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteClusterSubnetGroupCommand extends $Command< DeleteClusterSubnetGroupCommandInput, diff --git a/clients/client-redshift/commands/DeleteEndpointAccessCommand.ts b/clients/client-redshift/commands/DeleteEndpointAccessCommand.ts index 75ba256972da..26b5fb98cf98 100644 --- a/clients/client-redshift/commands/DeleteEndpointAccessCommand.ts +++ b/clients/client-redshift/commands/DeleteEndpointAccessCommand.ts @@ -22,6 +22,20 @@ export interface DeleteEndpointAccessCommandOutput extends EndpointAccess, __Met /** *

Deletes a Redshift-managed VPC endpoint.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { RedshiftClient, DeleteEndpointAccessCommand } from "@aws-sdk/client-redshift"; // ES Modules import + * // const { RedshiftClient, DeleteEndpointAccessCommand } = require("@aws-sdk/client-redshift"); // CommonJS import + * const client = new RedshiftClient(config); + * const command = new DeleteEndpointAccessCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteEndpointAccessCommandInput} for command's `input` shape. + * @see {@link DeleteEndpointAccessCommandOutput} for command's `response` shape. + * @see {@link RedshiftClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteEndpointAccessCommand extends $Command< DeleteEndpointAccessCommandInput, diff --git a/clients/client-redshift/commands/DeleteEventSubscriptionCommand.ts b/clients/client-redshift/commands/DeleteEventSubscriptionCommand.ts index c7e5df621b78..83856f5de869 100644 --- a/clients/client-redshift/commands/DeleteEventSubscriptionCommand.ts +++ b/clients/client-redshift/commands/DeleteEventSubscriptionCommand.ts @@ -22,6 +22,20 @@ export interface DeleteEventSubscriptionCommandOutput extends __MetadataBearer { /** *

Deletes an Amazon Redshift event notification subscription.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { RedshiftClient, DeleteEventSubscriptionCommand } from "@aws-sdk/client-redshift"; // ES Modules import + * // const { RedshiftClient, DeleteEventSubscriptionCommand } = require("@aws-sdk/client-redshift"); // CommonJS import + * const client = new RedshiftClient(config); + * const command = new DeleteEventSubscriptionCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteEventSubscriptionCommandInput} for command's `input` shape. + * @see {@link DeleteEventSubscriptionCommandOutput} for command's `response` shape. + * @see {@link RedshiftClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteEventSubscriptionCommand extends $Command< DeleteEventSubscriptionCommandInput, diff --git a/clients/client-redshift/commands/DeleteHsmClientCertificateCommand.ts b/clients/client-redshift/commands/DeleteHsmClientCertificateCommand.ts index efb5fee76647..fe453c4e2f68 100644 --- a/clients/client-redshift/commands/DeleteHsmClientCertificateCommand.ts +++ b/clients/client-redshift/commands/DeleteHsmClientCertificateCommand.ts @@ -22,6 +22,20 @@ export interface DeleteHsmClientCertificateCommandOutput extends __MetadataBeare /** *

Deletes the specified HSM client certificate.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { RedshiftClient, DeleteHsmClientCertificateCommand } from "@aws-sdk/client-redshift"; // ES Modules import + * // const { RedshiftClient, DeleteHsmClientCertificateCommand } = require("@aws-sdk/client-redshift"); // CommonJS import + * const client = new RedshiftClient(config); + * const command = new DeleteHsmClientCertificateCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteHsmClientCertificateCommandInput} for command's `input` shape. + * @see {@link DeleteHsmClientCertificateCommandOutput} for command's `response` shape. + * @see {@link RedshiftClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteHsmClientCertificateCommand extends $Command< DeleteHsmClientCertificateCommandInput, diff --git a/clients/client-redshift/commands/DeleteHsmConfigurationCommand.ts b/clients/client-redshift/commands/DeleteHsmConfigurationCommand.ts index fd2dc9df212d..e9ace3e3be53 100644 --- a/clients/client-redshift/commands/DeleteHsmConfigurationCommand.ts +++ b/clients/client-redshift/commands/DeleteHsmConfigurationCommand.ts @@ -22,6 +22,20 @@ export interface DeleteHsmConfigurationCommandOutput extends __MetadataBearer {} /** *

Deletes the specified Amazon Redshift HSM configuration.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { RedshiftClient, DeleteHsmConfigurationCommand } from "@aws-sdk/client-redshift"; // ES Modules import + * // const { RedshiftClient, DeleteHsmConfigurationCommand } = require("@aws-sdk/client-redshift"); // CommonJS import + * const client = new RedshiftClient(config); + * const command = new DeleteHsmConfigurationCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteHsmConfigurationCommandInput} for command's `input` shape. + * @see {@link DeleteHsmConfigurationCommandOutput} for command's `response` shape. + * @see {@link RedshiftClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteHsmConfigurationCommand extends $Command< DeleteHsmConfigurationCommandInput, diff --git a/clients/client-redshift/commands/DeletePartnerCommand.ts b/clients/client-redshift/commands/DeletePartnerCommand.ts index cb222c2d3ba1..7fd7bc10dd65 100644 --- a/clients/client-redshift/commands/DeletePartnerCommand.ts +++ b/clients/client-redshift/commands/DeletePartnerCommand.ts @@ -22,6 +22,20 @@ export interface DeletePartnerCommandOutput extends PartnerIntegrationOutputMess /** *

Deletes a partner integration from a cluster. Data can still flow to the cluster until the integration is deleted at the partner's website.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { RedshiftClient, DeletePartnerCommand } from "@aws-sdk/client-redshift"; // ES Modules import + * // const { RedshiftClient, DeletePartnerCommand } = require("@aws-sdk/client-redshift"); // CommonJS import + * const client = new RedshiftClient(config); + * const command = new DeletePartnerCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeletePartnerCommandInput} for command's `input` shape. + * @see {@link DeletePartnerCommandOutput} for command's `response` shape. + * @see {@link RedshiftClientResolvedConfig | config} for command's `input` shape. + * */ export class DeletePartnerCommand extends $Command< DeletePartnerCommandInput, diff --git a/clients/client-redshift/commands/DeleteScheduledActionCommand.ts b/clients/client-redshift/commands/DeleteScheduledActionCommand.ts index 94ae6d46019e..fd60db79b041 100644 --- a/clients/client-redshift/commands/DeleteScheduledActionCommand.ts +++ b/clients/client-redshift/commands/DeleteScheduledActionCommand.ts @@ -23,6 +23,20 @@ export interface DeleteScheduledActionCommandOutput extends __MetadataBearer {} /** *

Deletes a scheduled action. *

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { RedshiftClient, DeleteScheduledActionCommand } from "@aws-sdk/client-redshift"; // ES Modules import + * // const { RedshiftClient, DeleteScheduledActionCommand } = require("@aws-sdk/client-redshift"); // CommonJS import + * const client = new RedshiftClient(config); + * const command = new DeleteScheduledActionCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteScheduledActionCommandInput} for command's `input` shape. + * @see {@link DeleteScheduledActionCommandOutput} for command's `response` shape. + * @see {@link RedshiftClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteScheduledActionCommand extends $Command< DeleteScheduledActionCommandInput, diff --git a/clients/client-redshift/commands/DeleteSnapshotCopyGrantCommand.ts b/clients/client-redshift/commands/DeleteSnapshotCopyGrantCommand.ts index 50ff1daf8b21..d457fe900e91 100644 --- a/clients/client-redshift/commands/DeleteSnapshotCopyGrantCommand.ts +++ b/clients/client-redshift/commands/DeleteSnapshotCopyGrantCommand.ts @@ -22,6 +22,20 @@ export interface DeleteSnapshotCopyGrantCommandOutput extends __MetadataBearer { /** *

Deletes the specified snapshot copy grant.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { RedshiftClient, DeleteSnapshotCopyGrantCommand } from "@aws-sdk/client-redshift"; // ES Modules import + * // const { RedshiftClient, DeleteSnapshotCopyGrantCommand } = require("@aws-sdk/client-redshift"); // CommonJS import + * const client = new RedshiftClient(config); + * const command = new DeleteSnapshotCopyGrantCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteSnapshotCopyGrantCommandInput} for command's `input` shape. + * @see {@link DeleteSnapshotCopyGrantCommandOutput} for command's `response` shape. + * @see {@link RedshiftClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteSnapshotCopyGrantCommand extends $Command< DeleteSnapshotCopyGrantCommandInput, diff --git a/clients/client-redshift/commands/DeleteSnapshotScheduleCommand.ts b/clients/client-redshift/commands/DeleteSnapshotScheduleCommand.ts index 88f6c805fc32..5422615052b6 100644 --- a/clients/client-redshift/commands/DeleteSnapshotScheduleCommand.ts +++ b/clients/client-redshift/commands/DeleteSnapshotScheduleCommand.ts @@ -22,6 +22,20 @@ export interface DeleteSnapshotScheduleCommandOutput extends __MetadataBearer {} /** *

Deletes a snapshot schedule.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { RedshiftClient, DeleteSnapshotScheduleCommand } from "@aws-sdk/client-redshift"; // ES Modules import + * // const { RedshiftClient, DeleteSnapshotScheduleCommand } = require("@aws-sdk/client-redshift"); // CommonJS import + * const client = new RedshiftClient(config); + * const command = new DeleteSnapshotScheduleCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteSnapshotScheduleCommandInput} for command's `input` shape. + * @see {@link DeleteSnapshotScheduleCommandOutput} for command's `response` shape. + * @see {@link RedshiftClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteSnapshotScheduleCommand extends $Command< DeleteSnapshotScheduleCommandInput, diff --git a/clients/client-redshift/commands/DeleteTagsCommand.ts b/clients/client-redshift/commands/DeleteTagsCommand.ts index cfc699b31149..3c7aa7a6b5ae 100644 --- a/clients/client-redshift/commands/DeleteTagsCommand.ts +++ b/clients/client-redshift/commands/DeleteTagsCommand.ts @@ -20,6 +20,20 @@ export interface DeleteTagsCommandOutput extends __MetadataBearer {} /** *

Deletes tags from a resource. You must provide the ARN of the resource * from which you want to delete the tag or tags.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { RedshiftClient, DeleteTagsCommand } from "@aws-sdk/client-redshift"; // ES Modules import + * // const { RedshiftClient, DeleteTagsCommand } = require("@aws-sdk/client-redshift"); // CommonJS import + * const client = new RedshiftClient(config); + * const command = new DeleteTagsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteTagsCommandInput} for command's `input` shape. + * @see {@link DeleteTagsCommandOutput} for command's `response` shape. + * @see {@link RedshiftClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteTagsCommand extends $Command< DeleteTagsCommandInput, diff --git a/clients/client-redshift/commands/DeleteUsageLimitCommand.ts b/clients/client-redshift/commands/DeleteUsageLimitCommand.ts index 6fd5aea55664..06308210b3f5 100644 --- a/clients/client-redshift/commands/DeleteUsageLimitCommand.ts +++ b/clients/client-redshift/commands/DeleteUsageLimitCommand.ts @@ -22,6 +22,20 @@ export interface DeleteUsageLimitCommandOutput extends __MetadataBearer {} /** *

Deletes a usage limit from a cluster.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { RedshiftClient, DeleteUsageLimitCommand } from "@aws-sdk/client-redshift"; // ES Modules import + * // const { RedshiftClient, DeleteUsageLimitCommand } = require("@aws-sdk/client-redshift"); // CommonJS import + * const client = new RedshiftClient(config); + * const command = new DeleteUsageLimitCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteUsageLimitCommandInput} for command's `input` shape. + * @see {@link DeleteUsageLimitCommandOutput} for command's `response` shape. + * @see {@link RedshiftClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteUsageLimitCommand extends $Command< DeleteUsageLimitCommandInput, diff --git a/clients/client-redshift/commands/DescribeAccountAttributesCommand.ts b/clients/client-redshift/commands/DescribeAccountAttributesCommand.ts index 92b255bae1b6..56c43ecfaa3a 100644 --- a/clients/client-redshift/commands/DescribeAccountAttributesCommand.ts +++ b/clients/client-redshift/commands/DescribeAccountAttributesCommand.ts @@ -22,6 +22,20 @@ export interface DescribeAccountAttributesCommandOutput extends AccountAttribute /** *

Returns a list of attributes attached to an account

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { RedshiftClient, DescribeAccountAttributesCommand } from "@aws-sdk/client-redshift"; // ES Modules import + * // const { RedshiftClient, DescribeAccountAttributesCommand } = require("@aws-sdk/client-redshift"); // CommonJS import + * const client = new RedshiftClient(config); + * const command = new DescribeAccountAttributesCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeAccountAttributesCommandInput} for command's `input` shape. + * @see {@link DescribeAccountAttributesCommandOutput} for command's `response` shape. + * @see {@link RedshiftClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeAccountAttributesCommand extends $Command< DescribeAccountAttributesCommandInput, diff --git a/clients/client-redshift/commands/DescribeClusterDbRevisionsCommand.ts b/clients/client-redshift/commands/DescribeClusterDbRevisionsCommand.ts index 45651477b44e..cc9be59a9f1f 100644 --- a/clients/client-redshift/commands/DescribeClusterDbRevisionsCommand.ts +++ b/clients/client-redshift/commands/DescribeClusterDbRevisionsCommand.ts @@ -22,6 +22,20 @@ export interface DescribeClusterDbRevisionsCommandOutput extends ClusterDbRevisi /** *

Returns an array of ClusterDbRevision objects.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { RedshiftClient, DescribeClusterDbRevisionsCommand } from "@aws-sdk/client-redshift"; // ES Modules import + * // const { RedshiftClient, DescribeClusterDbRevisionsCommand } = require("@aws-sdk/client-redshift"); // CommonJS import + * const client = new RedshiftClient(config); + * const command = new DescribeClusterDbRevisionsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeClusterDbRevisionsCommandInput} for command's `input` shape. + * @see {@link DescribeClusterDbRevisionsCommandOutput} for command's `response` shape. + * @see {@link RedshiftClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeClusterDbRevisionsCommand extends $Command< DescribeClusterDbRevisionsCommandInput, diff --git a/clients/client-redshift/commands/DescribeClusterParameterGroupsCommand.ts b/clients/client-redshift/commands/DescribeClusterParameterGroupsCommand.ts index 6910e2e8a5f8..ffe38acafc6c 100644 --- a/clients/client-redshift/commands/DescribeClusterParameterGroupsCommand.ts +++ b/clients/client-redshift/commands/DescribeClusterParameterGroupsCommand.ts @@ -38,6 +38,20 @@ export interface DescribeClusterParameterGroupsCommandOutput extends ClusterPara *

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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { RedshiftClient, DescribeClusterParameterGroupsCommand } from "@aws-sdk/client-redshift"; // ES Modules import + * // const { RedshiftClient, DescribeClusterParameterGroupsCommand } = require("@aws-sdk/client-redshift"); // CommonJS import + * const client = new RedshiftClient(config); + * const command = new DescribeClusterParameterGroupsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeClusterParameterGroupsCommandInput} for command's `input` shape. + * @see {@link DescribeClusterParameterGroupsCommandOutput} for command's `response` shape. + * @see {@link RedshiftClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeClusterParameterGroupsCommand extends $Command< DescribeClusterParameterGroupsCommandInput, diff --git a/clients/client-redshift/commands/DescribeClusterParametersCommand.ts b/clients/client-redshift/commands/DescribeClusterParametersCommand.ts index c54e5aa93724..1a055eb9105f 100644 --- a/clients/client-redshift/commands/DescribeClusterParametersCommand.ts +++ b/clients/client-redshift/commands/DescribeClusterParametersCommand.ts @@ -33,6 +33,20 @@ export interface DescribeClusterParametersCommandOutput extends ClusterParameter * For more information about parameters and parameter groups, go to * Amazon Redshift Parameter Groups * in the Amazon Redshift Cluster Management Guide.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { RedshiftClient, DescribeClusterParametersCommand } from "@aws-sdk/client-redshift"; // ES Modules import + * // const { RedshiftClient, DescribeClusterParametersCommand } = require("@aws-sdk/client-redshift"); // CommonJS import + * const client = new RedshiftClient(config); + * const command = new DescribeClusterParametersCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeClusterParametersCommandInput} for command's `input` shape. + * @see {@link DescribeClusterParametersCommandOutput} for command's `response` shape. + * @see {@link RedshiftClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeClusterParametersCommand extends $Command< DescribeClusterParametersCommandInput, diff --git a/clients/client-redshift/commands/DescribeClusterSecurityGroupsCommand.ts b/clients/client-redshift/commands/DescribeClusterSecurityGroupsCommand.ts index f2ae123f4761..094425a10a94 100644 --- a/clients/client-redshift/commands/DescribeClusterSecurityGroupsCommand.ts +++ b/clients/client-redshift/commands/DescribeClusterSecurityGroupsCommand.ts @@ -36,6 +36,20 @@ export interface DescribeClusterSecurityGroupsCommandOutput extends ClusterSecur *

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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { RedshiftClient, DescribeClusterSecurityGroupsCommand } from "@aws-sdk/client-redshift"; // ES Modules import + * // const { RedshiftClient, DescribeClusterSecurityGroupsCommand } = require("@aws-sdk/client-redshift"); // CommonJS import + * const client = new RedshiftClient(config); + * const command = new DescribeClusterSecurityGroupsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeClusterSecurityGroupsCommandInput} for command's `input` shape. + * @see {@link DescribeClusterSecurityGroupsCommandOutput} for command's `response` shape. + * @see {@link RedshiftClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeClusterSecurityGroupsCommand extends $Command< DescribeClusterSecurityGroupsCommandInput, diff --git a/clients/client-redshift/commands/DescribeClusterSnapshotsCommand.ts b/clients/client-redshift/commands/DescribeClusterSnapshotsCommand.ts index 370b904314eb..51fe1b1ba451 100644 --- a/clients/client-redshift/commands/DescribeClusterSnapshotsCommand.ts +++ b/clients/client-redshift/commands/DescribeClusterSnapshotsCommand.ts @@ -34,6 +34,20 @@ export interface DescribeClusterSnapshotsCommandOutput extends SnapshotMessage, * 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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { RedshiftClient, DescribeClusterSnapshotsCommand } from "@aws-sdk/client-redshift"; // ES Modules import + * // const { RedshiftClient, DescribeClusterSnapshotsCommand } = require("@aws-sdk/client-redshift"); // CommonJS import + * const client = new RedshiftClient(config); + * const command = new DescribeClusterSnapshotsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeClusterSnapshotsCommandInput} for command's `input` shape. + * @see {@link DescribeClusterSnapshotsCommandOutput} for command's `response` shape. + * @see {@link RedshiftClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeClusterSnapshotsCommand extends $Command< DescribeClusterSnapshotsCommandInput, diff --git a/clients/client-redshift/commands/DescribeClusterSubnetGroupsCommand.ts b/clients/client-redshift/commands/DescribeClusterSubnetGroupsCommand.ts index 3eb4daae0ea5..a30ee807feb1 100644 --- a/clients/client-redshift/commands/DescribeClusterSubnetGroupsCommand.ts +++ b/clients/client-redshift/commands/DescribeClusterSubnetGroupsCommand.ts @@ -32,6 +32,20 @@ export interface DescribeClusterSubnetGroupsCommandOutput extends ClusterSubnetG *

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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { RedshiftClient, DescribeClusterSubnetGroupsCommand } from "@aws-sdk/client-redshift"; // ES Modules import + * // const { RedshiftClient, DescribeClusterSubnetGroupsCommand } = require("@aws-sdk/client-redshift"); // CommonJS import + * const client = new RedshiftClient(config); + * const command = new DescribeClusterSubnetGroupsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeClusterSubnetGroupsCommandInput} for command's `input` shape. + * @see {@link DescribeClusterSubnetGroupsCommandOutput} for command's `response` shape. + * @see {@link RedshiftClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeClusterSubnetGroupsCommand extends $Command< DescribeClusterSubnetGroupsCommandInput, diff --git a/clients/client-redshift/commands/DescribeClusterTracksCommand.ts b/clients/client-redshift/commands/DescribeClusterTracksCommand.ts index 91a0b6d009a3..1e99483ec62a 100644 --- a/clients/client-redshift/commands/DescribeClusterTracksCommand.ts +++ b/clients/client-redshift/commands/DescribeClusterTracksCommand.ts @@ -22,6 +22,20 @@ export interface DescribeClusterTracksCommandOutput extends TrackListMessage, __ /** *

Returns a list of all the available maintenance tracks.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { RedshiftClient, DescribeClusterTracksCommand } from "@aws-sdk/client-redshift"; // ES Modules import + * // const { RedshiftClient, DescribeClusterTracksCommand } = require("@aws-sdk/client-redshift"); // CommonJS import + * const client = new RedshiftClient(config); + * const command = new DescribeClusterTracksCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeClusterTracksCommandInput} for command's `input` shape. + * @see {@link DescribeClusterTracksCommandOutput} for command's `response` shape. + * @see {@link RedshiftClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeClusterTracksCommand extends $Command< DescribeClusterTracksCommandInput, diff --git a/clients/client-redshift/commands/DescribeClusterVersionsCommand.ts b/clients/client-redshift/commands/DescribeClusterVersionsCommand.ts index 92a33da30a63..c6b96b5ec2b4 100644 --- a/clients/client-redshift/commands/DescribeClusterVersionsCommand.ts +++ b/clients/client-redshift/commands/DescribeClusterVersionsCommand.ts @@ -27,6 +27,20 @@ export interface DescribeClusterVersionsCommandOutput extends ClusterVersionsMes * For more information about managing clusters, go to * Amazon Redshift Clusters * in the Amazon Redshift Cluster Management Guide.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { RedshiftClient, DescribeClusterVersionsCommand } from "@aws-sdk/client-redshift"; // ES Modules import + * // const { RedshiftClient, DescribeClusterVersionsCommand } = require("@aws-sdk/client-redshift"); // CommonJS import + * const client = new RedshiftClient(config); + * const command = new DescribeClusterVersionsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeClusterVersionsCommandInput} for command's `input` shape. + * @see {@link DescribeClusterVersionsCommandOutput} for command's `response` shape. + * @see {@link RedshiftClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeClusterVersionsCommand extends $Command< DescribeClusterVersionsCommandInput, diff --git a/clients/client-redshift/commands/DescribeClustersCommand.ts b/clients/client-redshift/commands/DescribeClustersCommand.ts index 0b16f4e7deb7..cfc962b83c41 100644 --- a/clients/client-redshift/commands/DescribeClustersCommand.ts +++ b/clients/client-redshift/commands/DescribeClustersCommand.ts @@ -34,6 +34,20 @@ export interface DescribeClustersCommandOutput extends ClustersMessage, __Metada * 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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { RedshiftClient, DescribeClustersCommand } from "@aws-sdk/client-redshift"; // ES Modules import + * // const { RedshiftClient, DescribeClustersCommand } = require("@aws-sdk/client-redshift"); // CommonJS import + * const client = new RedshiftClient(config); + * const command = new DescribeClustersCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeClustersCommandInput} for command's `input` shape. + * @see {@link DescribeClustersCommandOutput} for command's `response` shape. + * @see {@link RedshiftClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeClustersCommand extends $Command< DescribeClustersCommandInput, diff --git a/clients/client-redshift/commands/DescribeDefaultClusterParametersCommand.ts b/clients/client-redshift/commands/DescribeDefaultClusterParametersCommand.ts index be38202e2980..e2e56957cde2 100644 --- a/clients/client-redshift/commands/DescribeDefaultClusterParametersCommand.ts +++ b/clients/client-redshift/commands/DescribeDefaultClusterParametersCommand.ts @@ -29,6 +29,20 @@ export interface DescribeDefaultClusterParametersCommandOutput * For more information about parameters and parameter groups, go to * Amazon Redshift Parameter Groups * in the Amazon Redshift Cluster Management Guide.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { RedshiftClient, DescribeDefaultClusterParametersCommand } from "@aws-sdk/client-redshift"; // ES Modules import + * // const { RedshiftClient, DescribeDefaultClusterParametersCommand } = require("@aws-sdk/client-redshift"); // CommonJS import + * const client = new RedshiftClient(config); + * const command = new DescribeDefaultClusterParametersCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeDefaultClusterParametersCommandInput} for command's `input` shape. + * @see {@link DescribeDefaultClusterParametersCommandOutput} for command's `response` shape. + * @see {@link RedshiftClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeDefaultClusterParametersCommand extends $Command< DescribeDefaultClusterParametersCommandInput, diff --git a/clients/client-redshift/commands/DescribeEndpointAccessCommand.ts b/clients/client-redshift/commands/DescribeEndpointAccessCommand.ts index d10d2aff8297..86e7a8008916 100644 --- a/clients/client-redshift/commands/DescribeEndpointAccessCommand.ts +++ b/clients/client-redshift/commands/DescribeEndpointAccessCommand.ts @@ -22,6 +22,20 @@ export interface DescribeEndpointAccessCommandOutput extends EndpointAccessList, /** *

Describes a Redshift-managed VPC endpoint.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { RedshiftClient, DescribeEndpointAccessCommand } from "@aws-sdk/client-redshift"; // ES Modules import + * // const { RedshiftClient, DescribeEndpointAccessCommand } = require("@aws-sdk/client-redshift"); // CommonJS import + * const client = new RedshiftClient(config); + * const command = new DescribeEndpointAccessCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeEndpointAccessCommandInput} for command's `input` shape. + * @see {@link DescribeEndpointAccessCommandOutput} for command's `response` shape. + * @see {@link RedshiftClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeEndpointAccessCommand extends $Command< DescribeEndpointAccessCommandInput, diff --git a/clients/client-redshift/commands/DescribeEndpointAuthorizationCommand.ts b/clients/client-redshift/commands/DescribeEndpointAuthorizationCommand.ts index 1f3ffba9a5f2..7697f1d0950f 100644 --- a/clients/client-redshift/commands/DescribeEndpointAuthorizationCommand.ts +++ b/clients/client-redshift/commands/DescribeEndpointAuthorizationCommand.ts @@ -22,6 +22,20 @@ export interface DescribeEndpointAuthorizationCommandOutput extends EndpointAuth /** *

Describes an endpoint authorization.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { RedshiftClient, DescribeEndpointAuthorizationCommand } from "@aws-sdk/client-redshift"; // ES Modules import + * // const { RedshiftClient, DescribeEndpointAuthorizationCommand } = require("@aws-sdk/client-redshift"); // CommonJS import + * const client = new RedshiftClient(config); + * const command = new DescribeEndpointAuthorizationCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeEndpointAuthorizationCommandInput} for command's `input` shape. + * @see {@link DescribeEndpointAuthorizationCommandOutput} for command's `response` shape. + * @see {@link RedshiftClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeEndpointAuthorizationCommand extends $Command< DescribeEndpointAuthorizationCommandInput, diff --git a/clients/client-redshift/commands/DescribeEventCategoriesCommand.ts b/clients/client-redshift/commands/DescribeEventCategoriesCommand.ts index 65f9187c0f89..e749a88b4996 100644 --- a/clients/client-redshift/commands/DescribeEventCategoriesCommand.ts +++ b/clients/client-redshift/commands/DescribeEventCategoriesCommand.ts @@ -24,6 +24,20 @@ export interface DescribeEventCategoriesCommandOutput extends EventCategoriesMes *

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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { RedshiftClient, DescribeEventCategoriesCommand } from "@aws-sdk/client-redshift"; // ES Modules import + * // const { RedshiftClient, DescribeEventCategoriesCommand } = require("@aws-sdk/client-redshift"); // CommonJS import + * const client = new RedshiftClient(config); + * const command = new DescribeEventCategoriesCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeEventCategoriesCommandInput} for command's `input` shape. + * @see {@link DescribeEventCategoriesCommandOutput} for command's `response` shape. + * @see {@link RedshiftClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeEventCategoriesCommand extends $Command< DescribeEventCategoriesCommandInput, diff --git a/clients/client-redshift/commands/DescribeEventSubscriptionsCommand.ts b/clients/client-redshift/commands/DescribeEventSubscriptionsCommand.ts index 08bc962b9256..ad9dd0164ddb 100644 --- a/clients/client-redshift/commands/DescribeEventSubscriptionsCommand.ts +++ b/clients/client-redshift/commands/DescribeEventSubscriptionsCommand.ts @@ -32,6 +32,20 @@ export interface DescribeEventSubscriptionsCommandOutput extends EventSubscripti *

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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { RedshiftClient, DescribeEventSubscriptionsCommand } from "@aws-sdk/client-redshift"; // ES Modules import + * // const { RedshiftClient, DescribeEventSubscriptionsCommand } = require("@aws-sdk/client-redshift"); // CommonJS import + * const client = new RedshiftClient(config); + * const command = new DescribeEventSubscriptionsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeEventSubscriptionsCommandInput} for command's `input` shape. + * @see {@link DescribeEventSubscriptionsCommandOutput} for command's `response` shape. + * @see {@link RedshiftClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeEventSubscriptionsCommand extends $Command< DescribeEventSubscriptionsCommandInput, diff --git a/clients/client-redshift/commands/DescribeEventsCommand.ts b/clients/client-redshift/commands/DescribeEventsCommand.ts index 5693107afb4d..a36d5756576c 100644 --- a/clients/client-redshift/commands/DescribeEventsCommand.ts +++ b/clients/client-redshift/commands/DescribeEventsCommand.ts @@ -25,6 +25,20 @@ export interface DescribeEventsCommandOutput extends EventsMessage, __MetadataBe * 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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { RedshiftClient, DescribeEventsCommand } from "@aws-sdk/client-redshift"; // ES Modules import + * // const { RedshiftClient, DescribeEventsCommand } = require("@aws-sdk/client-redshift"); // CommonJS import + * const client = new RedshiftClient(config); + * const command = new DescribeEventsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeEventsCommandInput} for command's `input` shape. + * @see {@link DescribeEventsCommandOutput} for command's `response` shape. + * @see {@link RedshiftClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeEventsCommand extends $Command< DescribeEventsCommandInput, diff --git a/clients/client-redshift/commands/DescribeHsmClientCertificatesCommand.ts b/clients/client-redshift/commands/DescribeHsmClientCertificatesCommand.ts index db3d39f97d3f..39b663877d5e 100644 --- a/clients/client-redshift/commands/DescribeHsmClientCertificatesCommand.ts +++ b/clients/client-redshift/commands/DescribeHsmClientCertificatesCommand.ts @@ -32,6 +32,20 @@ export interface DescribeHsmClientCertificatesCommandOutput extends HsmClientCer *

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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { RedshiftClient, DescribeHsmClientCertificatesCommand } from "@aws-sdk/client-redshift"; // ES Modules import + * // const { RedshiftClient, DescribeHsmClientCertificatesCommand } = require("@aws-sdk/client-redshift"); // CommonJS import + * const client = new RedshiftClient(config); + * const command = new DescribeHsmClientCertificatesCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeHsmClientCertificatesCommandInput} for command's `input` shape. + * @see {@link DescribeHsmClientCertificatesCommandOutput} for command's `response` shape. + * @see {@link RedshiftClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeHsmClientCertificatesCommand extends $Command< DescribeHsmClientCertificatesCommandInput, diff --git a/clients/client-redshift/commands/DescribeHsmConfigurationsCommand.ts b/clients/client-redshift/commands/DescribeHsmConfigurationsCommand.ts index ff3f62516470..56dd260bd311 100644 --- a/clients/client-redshift/commands/DescribeHsmConfigurationsCommand.ts +++ b/clients/client-redshift/commands/DescribeHsmConfigurationsCommand.ts @@ -32,6 +32,20 @@ export interface DescribeHsmConfigurationsCommandOutput extends HsmConfiguration *

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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { RedshiftClient, DescribeHsmConfigurationsCommand } from "@aws-sdk/client-redshift"; // ES Modules import + * // const { RedshiftClient, DescribeHsmConfigurationsCommand } = require("@aws-sdk/client-redshift"); // CommonJS import + * const client = new RedshiftClient(config); + * const command = new DescribeHsmConfigurationsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeHsmConfigurationsCommandInput} for command's `input` shape. + * @see {@link DescribeHsmConfigurationsCommandOutput} for command's `response` shape. + * @see {@link RedshiftClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeHsmConfigurationsCommand extends $Command< DescribeHsmConfigurationsCommandInput, diff --git a/clients/client-redshift/commands/DescribeLoggingStatusCommand.ts b/clients/client-redshift/commands/DescribeLoggingStatusCommand.ts index 3957bbb2299a..9c41d358763d 100644 --- a/clients/client-redshift/commands/DescribeLoggingStatusCommand.ts +++ b/clients/client-redshift/commands/DescribeLoggingStatusCommand.ts @@ -23,6 +23,20 @@ export interface DescribeLoggingStatusCommandOutput extends LoggingStatus, __Met /** *

Describes whether information, such as queries and connection attempts, is being * logged for the specified Amazon Redshift cluster.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { RedshiftClient, DescribeLoggingStatusCommand } from "@aws-sdk/client-redshift"; // ES Modules import + * // const { RedshiftClient, DescribeLoggingStatusCommand } = require("@aws-sdk/client-redshift"); // CommonJS import + * const client = new RedshiftClient(config); + * const command = new DescribeLoggingStatusCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeLoggingStatusCommandInput} for command's `input` shape. + * @see {@link DescribeLoggingStatusCommandOutput} for command's `response` shape. + * @see {@link RedshiftClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeLoggingStatusCommand extends $Command< DescribeLoggingStatusCommandInput, diff --git a/clients/client-redshift/commands/DescribeNodeConfigurationOptionsCommand.ts b/clients/client-redshift/commands/DescribeNodeConfigurationOptionsCommand.ts index 929b8d2bd7fe..0e94f8438bb1 100644 --- a/clients/client-redshift/commands/DescribeNodeConfigurationOptionsCommand.ts +++ b/clients/client-redshift/commands/DescribeNodeConfigurationOptionsCommand.ts @@ -25,6 +25,20 @@ export interface DescribeNodeConfigurationOptionsCommandOutput /** *

Returns properties of possible node configurations such as node type, number of nodes, and * disk usage for the specified action type.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { RedshiftClient, DescribeNodeConfigurationOptionsCommand } from "@aws-sdk/client-redshift"; // ES Modules import + * // const { RedshiftClient, DescribeNodeConfigurationOptionsCommand } = require("@aws-sdk/client-redshift"); // CommonJS import + * const client = new RedshiftClient(config); + * const command = new DescribeNodeConfigurationOptionsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeNodeConfigurationOptionsCommandInput} for command's `input` shape. + * @see {@link DescribeNodeConfigurationOptionsCommandOutput} for command's `response` shape. + * @see {@link RedshiftClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeNodeConfigurationOptionsCommand extends $Command< DescribeNodeConfigurationOptionsCommandInput, diff --git a/clients/client-redshift/commands/DescribeOrderableClusterOptionsCommand.ts b/clients/client-redshift/commands/DescribeOrderableClusterOptionsCommand.ts index 33bc99d3e776..c19842814240 100644 --- a/clients/client-redshift/commands/DescribeOrderableClusterOptionsCommand.ts +++ b/clients/client-redshift/commands/DescribeOrderableClusterOptionsCommand.ts @@ -32,6 +32,20 @@ export interface DescribeOrderableClusterOptionsCommandOutput * For more information about managing clusters, go to * Amazon Redshift Clusters * in the Amazon Redshift Cluster Management Guide.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { RedshiftClient, DescribeOrderableClusterOptionsCommand } from "@aws-sdk/client-redshift"; // ES Modules import + * // const { RedshiftClient, DescribeOrderableClusterOptionsCommand } = require("@aws-sdk/client-redshift"); // CommonJS import + * const client = new RedshiftClient(config); + * const command = new DescribeOrderableClusterOptionsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeOrderableClusterOptionsCommandInput} for command's `input` shape. + * @see {@link DescribeOrderableClusterOptionsCommandOutput} for command's `response` shape. + * @see {@link RedshiftClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeOrderableClusterOptionsCommand extends $Command< DescribeOrderableClusterOptionsCommandInput, diff --git a/clients/client-redshift/commands/DescribePartnersCommand.ts b/clients/client-redshift/commands/DescribePartnersCommand.ts index 8b8a0d26bad9..2fa74618aedf 100644 --- a/clients/client-redshift/commands/DescribePartnersCommand.ts +++ b/clients/client-redshift/commands/DescribePartnersCommand.ts @@ -22,6 +22,20 @@ export interface DescribePartnersCommandOutput extends DescribePartnersOutputMes /** *

Returns information about the partner integrations defined for a cluster.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { RedshiftClient, DescribePartnersCommand } from "@aws-sdk/client-redshift"; // ES Modules import + * // const { RedshiftClient, DescribePartnersCommand } = require("@aws-sdk/client-redshift"); // CommonJS import + * const client = new RedshiftClient(config); + * const command = new DescribePartnersCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribePartnersCommandInput} for command's `input` shape. + * @see {@link DescribePartnersCommandOutput} for command's `response` shape. + * @see {@link RedshiftClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribePartnersCommand extends $Command< DescribePartnersCommandInput, diff --git a/clients/client-redshift/commands/DescribeReservedNodeOfferingsCommand.ts b/clients/client-redshift/commands/DescribeReservedNodeOfferingsCommand.ts index 483e1a089346..1a655c230413 100644 --- a/clients/client-redshift/commands/DescribeReservedNodeOfferingsCommand.ts +++ b/clients/client-redshift/commands/DescribeReservedNodeOfferingsCommand.ts @@ -31,6 +31,20 @@ export interface DescribeReservedNodeOfferingsCommandOutput extends ReservedNode * For more information about reserved node offerings, go to * Purchasing Reserved Nodes * in the Amazon Redshift Cluster Management Guide.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { RedshiftClient, DescribeReservedNodeOfferingsCommand } from "@aws-sdk/client-redshift"; // ES Modules import + * // const { RedshiftClient, DescribeReservedNodeOfferingsCommand } = require("@aws-sdk/client-redshift"); // CommonJS import + * const client = new RedshiftClient(config); + * const command = new DescribeReservedNodeOfferingsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeReservedNodeOfferingsCommandInput} for command's `input` shape. + * @see {@link DescribeReservedNodeOfferingsCommandOutput} for command's `response` shape. + * @see {@link RedshiftClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeReservedNodeOfferingsCommand extends $Command< DescribeReservedNodeOfferingsCommandInput, diff --git a/clients/client-redshift/commands/DescribeReservedNodesCommand.ts b/clients/client-redshift/commands/DescribeReservedNodesCommand.ts index 64df1affdad9..700853a8f20e 100644 --- a/clients/client-redshift/commands/DescribeReservedNodesCommand.ts +++ b/clients/client-redshift/commands/DescribeReservedNodesCommand.ts @@ -22,6 +22,20 @@ export interface DescribeReservedNodesCommandOutput extends ReservedNodesMessage /** *

Returns the descriptions of the reserved nodes.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { RedshiftClient, DescribeReservedNodesCommand } from "@aws-sdk/client-redshift"; // ES Modules import + * // const { RedshiftClient, DescribeReservedNodesCommand } = require("@aws-sdk/client-redshift"); // CommonJS import + * const client = new RedshiftClient(config); + * const command = new DescribeReservedNodesCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeReservedNodesCommandInput} for command's `input` shape. + * @see {@link DescribeReservedNodesCommandOutput} for command's `response` shape. + * @see {@link RedshiftClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeReservedNodesCommand extends $Command< DescribeReservedNodesCommandInput, diff --git a/clients/client-redshift/commands/DescribeResizeCommand.ts b/clients/client-redshift/commands/DescribeResizeCommand.ts index 28be1482972e..93c5cae387a8 100644 --- a/clients/client-redshift/commands/DescribeResizeCommand.ts +++ b/clients/client-redshift/commands/DescribeResizeCommand.ts @@ -27,6 +27,20 @@ export interface DescribeResizeCommandOutput extends ResizeProgressMessage, __Me * 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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { RedshiftClient, DescribeResizeCommand } from "@aws-sdk/client-redshift"; // ES Modules import + * // const { RedshiftClient, DescribeResizeCommand } = require("@aws-sdk/client-redshift"); // CommonJS import + * const client = new RedshiftClient(config); + * const command = new DescribeResizeCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeResizeCommandInput} for command's `input` shape. + * @see {@link DescribeResizeCommandOutput} for command's `response` shape. + * @see {@link RedshiftClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeResizeCommand extends $Command< DescribeResizeCommandInput, diff --git a/clients/client-redshift/commands/DescribeScheduledActionsCommand.ts b/clients/client-redshift/commands/DescribeScheduledActionsCommand.ts index d72a4999c9eb..31e4ecc537b5 100644 --- a/clients/client-redshift/commands/DescribeScheduledActionsCommand.ts +++ b/clients/client-redshift/commands/DescribeScheduledActionsCommand.ts @@ -23,6 +23,20 @@ export interface DescribeScheduledActionsCommandOutput extends ScheduledActionsM /** *

Describes properties of scheduled actions. *

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { RedshiftClient, DescribeScheduledActionsCommand } from "@aws-sdk/client-redshift"; // ES Modules import + * // const { RedshiftClient, DescribeScheduledActionsCommand } = require("@aws-sdk/client-redshift"); // CommonJS import + * const client = new RedshiftClient(config); + * const command = new DescribeScheduledActionsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeScheduledActionsCommandInput} for command's `input` shape. + * @see {@link DescribeScheduledActionsCommandOutput} for command's `response` shape. + * @see {@link RedshiftClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeScheduledActionsCommand extends $Command< DescribeScheduledActionsCommandInput, diff --git a/clients/client-redshift/commands/DescribeSnapshotCopyGrantsCommand.ts b/clients/client-redshift/commands/DescribeSnapshotCopyGrantsCommand.ts index d19649e080f3..9df282411ff6 100644 --- a/clients/client-redshift/commands/DescribeSnapshotCopyGrantsCommand.ts +++ b/clients/client-redshift/commands/DescribeSnapshotCopyGrantsCommand.ts @@ -29,6 +29,20 @@ export interface DescribeSnapshotCopyGrantsCommandOutput extends SnapshotCopyGra * Amazon Redshift Database Encryption * in the Amazon Redshift Cluster Management Guide. *

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { RedshiftClient, DescribeSnapshotCopyGrantsCommand } from "@aws-sdk/client-redshift"; // ES Modules import + * // const { RedshiftClient, DescribeSnapshotCopyGrantsCommand } = require("@aws-sdk/client-redshift"); // CommonJS import + * const client = new RedshiftClient(config); + * const command = new DescribeSnapshotCopyGrantsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeSnapshotCopyGrantsCommandInput} for command's `input` shape. + * @see {@link DescribeSnapshotCopyGrantsCommandOutput} for command's `response` shape. + * @see {@link RedshiftClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeSnapshotCopyGrantsCommand extends $Command< DescribeSnapshotCopyGrantsCommandInput, diff --git a/clients/client-redshift/commands/DescribeSnapshotSchedulesCommand.ts b/clients/client-redshift/commands/DescribeSnapshotSchedulesCommand.ts index 7d3ff76f6c63..e06343208b66 100644 --- a/clients/client-redshift/commands/DescribeSnapshotSchedulesCommand.ts +++ b/clients/client-redshift/commands/DescribeSnapshotSchedulesCommand.ts @@ -24,6 +24,20 @@ export interface DescribeSnapshotSchedulesCommandOutput /** *

Returns a list of snapshot schedules.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { RedshiftClient, DescribeSnapshotSchedulesCommand } from "@aws-sdk/client-redshift"; // ES Modules import + * // const { RedshiftClient, DescribeSnapshotSchedulesCommand } = require("@aws-sdk/client-redshift"); // CommonJS import + * const client = new RedshiftClient(config); + * const command = new DescribeSnapshotSchedulesCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeSnapshotSchedulesCommandInput} for command's `input` shape. + * @see {@link DescribeSnapshotSchedulesCommandOutput} for command's `response` shape. + * @see {@link RedshiftClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeSnapshotSchedulesCommand extends $Command< DescribeSnapshotSchedulesCommandInput, diff --git a/clients/client-redshift/commands/DescribeStorageCommand.ts b/clients/client-redshift/commands/DescribeStorageCommand.ts index c21c8cf6f97d..f25a0a0372be 100644 --- a/clients/client-redshift/commands/DescribeStorageCommand.ts +++ b/clients/client-redshift/commands/DescribeStorageCommand.ts @@ -22,6 +22,20 @@ export interface DescribeStorageCommandOutput extends CustomerStorageMessage, __ /** *

Returns account level backups storage size and provisional storage.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { RedshiftClient, DescribeStorageCommand } from "@aws-sdk/client-redshift"; // ES Modules import + * // const { RedshiftClient, DescribeStorageCommand } = require("@aws-sdk/client-redshift"); // CommonJS import + * const client = new RedshiftClient(config); + * const command = new DescribeStorageCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeStorageCommandInput} for command's `input` shape. + * @see {@link DescribeStorageCommandOutput} for command's `response` shape. + * @see {@link RedshiftClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeStorageCommand extends $Command< DescribeStorageCommandInput, diff --git a/clients/client-redshift/commands/DescribeTableRestoreStatusCommand.ts b/clients/client-redshift/commands/DescribeTableRestoreStatusCommand.ts index 42a82b4432b7..8a23bb4e5539 100644 --- a/clients/client-redshift/commands/DescribeTableRestoreStatusCommand.ts +++ b/clients/client-redshift/commands/DescribeTableRestoreStatusCommand.ts @@ -27,6 +27,20 @@ export interface DescribeTableRestoreStatusCommandOutput extends TableRestoreSta * requests ordered by the date and time of the request in ascending order. Otherwise * DescribeTableRestoreStatus returns the status of the table specified by * TableRestoreRequestId.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { RedshiftClient, DescribeTableRestoreStatusCommand } from "@aws-sdk/client-redshift"; // ES Modules import + * // const { RedshiftClient, DescribeTableRestoreStatusCommand } = require("@aws-sdk/client-redshift"); // CommonJS import + * const client = new RedshiftClient(config); + * const command = new DescribeTableRestoreStatusCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeTableRestoreStatusCommandInput} for command's `input` shape. + * @see {@link DescribeTableRestoreStatusCommandOutput} for command's `response` shape. + * @see {@link RedshiftClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeTableRestoreStatusCommand extends $Command< DescribeTableRestoreStatusCommandInput, diff --git a/clients/client-redshift/commands/DescribeTagsCommand.ts b/clients/client-redshift/commands/DescribeTagsCommand.ts index 6be1ccc434dc..2ac6ca8d0b08 100644 --- a/clients/client-redshift/commands/DescribeTagsCommand.ts +++ b/clients/client-redshift/commands/DescribeTagsCommand.ts @@ -43,6 +43,20 @@ export interface DescribeTagsCommandOutput extends TaggedResourceListMessage, __ * 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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { RedshiftClient, DescribeTagsCommand } from "@aws-sdk/client-redshift"; // ES Modules import + * // const { RedshiftClient, DescribeTagsCommand } = require("@aws-sdk/client-redshift"); // CommonJS import + * const client = new RedshiftClient(config); + * const command = new DescribeTagsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeTagsCommandInput} for command's `input` shape. + * @see {@link DescribeTagsCommandOutput} for command's `response` shape. + * @see {@link RedshiftClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeTagsCommand extends $Command< DescribeTagsCommandInput, diff --git a/clients/client-redshift/commands/DescribeUsageLimitsCommand.ts b/clients/client-redshift/commands/DescribeUsageLimitsCommand.ts index 5a5700ff68ee..1a9604253aad 100644 --- a/clients/client-redshift/commands/DescribeUsageLimitsCommand.ts +++ b/clients/client-redshift/commands/DescribeUsageLimitsCommand.ts @@ -41,6 +41,20 @@ export interface DescribeUsageLimitsCommandOutput extends UsageLimitList, __Meta * then all usage limit objects for the combination of cluster and feature are returned.

* * + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { RedshiftClient, DescribeUsageLimitsCommand } from "@aws-sdk/client-redshift"; // ES Modules import + * // const { RedshiftClient, DescribeUsageLimitsCommand } = require("@aws-sdk/client-redshift"); // CommonJS import + * const client = new RedshiftClient(config); + * const command = new DescribeUsageLimitsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeUsageLimitsCommandInput} for command's `input` shape. + * @see {@link DescribeUsageLimitsCommandOutput} for command's `response` shape. + * @see {@link RedshiftClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeUsageLimitsCommand extends $Command< DescribeUsageLimitsCommandInput, diff --git a/clients/client-redshift/commands/DisableLoggingCommand.ts b/clients/client-redshift/commands/DisableLoggingCommand.ts index 50390a33b15a..84fdfb9bdf45 100644 --- a/clients/client-redshift/commands/DisableLoggingCommand.ts +++ b/clients/client-redshift/commands/DisableLoggingCommand.ts @@ -24,6 +24,20 @@ export interface DisableLoggingCommandOutput extends LoggingStatus, __MetadataBe /** *

Stops logging information, such as queries and connection attempts, for the * specified Amazon Redshift cluster.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { RedshiftClient, DisableLoggingCommand } from "@aws-sdk/client-redshift"; // ES Modules import + * // const { RedshiftClient, DisableLoggingCommand } = require("@aws-sdk/client-redshift"); // CommonJS import + * const client = new RedshiftClient(config); + * const command = new DisableLoggingCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DisableLoggingCommandInput} for command's `input` shape. + * @see {@link DisableLoggingCommandOutput} for command's `response` shape. + * @see {@link RedshiftClientResolvedConfig | config} for command's `input` shape. + * */ export class DisableLoggingCommand extends $Command< DisableLoggingCommandInput, diff --git a/clients/client-redshift/commands/DisableSnapshotCopyCommand.ts b/clients/client-redshift/commands/DisableSnapshotCopyCommand.ts index 106fc2887c05..eea8f0316c52 100644 --- a/clients/client-redshift/commands/DisableSnapshotCopyCommand.ts +++ b/clients/client-redshift/commands/DisableSnapshotCopyCommand.ts @@ -26,6 +26,20 @@ export interface DisableSnapshotCopyCommandOutput extends DisableSnapshotCopyRes *

If your cluster and its snapshots are encrypted using a customer master key (CMK) * from AWS KMS, use DeleteSnapshotCopyGrant to delete the grant that * grants Amazon Redshift permission to the CMK in the destination region.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { RedshiftClient, DisableSnapshotCopyCommand } from "@aws-sdk/client-redshift"; // ES Modules import + * // const { RedshiftClient, DisableSnapshotCopyCommand } = require("@aws-sdk/client-redshift"); // CommonJS import + * const client = new RedshiftClient(config); + * const command = new DisableSnapshotCopyCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DisableSnapshotCopyCommandInput} for command's `input` shape. + * @see {@link DisableSnapshotCopyCommandOutput} for command's `response` shape. + * @see {@link RedshiftClientResolvedConfig | config} for command's `input` shape. + * */ export class DisableSnapshotCopyCommand extends $Command< DisableSnapshotCopyCommandInput, diff --git a/clients/client-redshift/commands/EnableLoggingCommand.ts b/clients/client-redshift/commands/EnableLoggingCommand.ts index 032137e00bd3..e7442bf56b93 100644 --- a/clients/client-redshift/commands/EnableLoggingCommand.ts +++ b/clients/client-redshift/commands/EnableLoggingCommand.ts @@ -24,6 +24,20 @@ export interface EnableLoggingCommandOutput extends LoggingStatus, __MetadataBea /** *

Starts logging information, such as queries and connection attempts, for the * specified Amazon Redshift cluster.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { RedshiftClient, EnableLoggingCommand } from "@aws-sdk/client-redshift"; // ES Modules import + * // const { RedshiftClient, EnableLoggingCommand } = require("@aws-sdk/client-redshift"); // CommonJS import + * const client = new RedshiftClient(config); + * const command = new EnableLoggingCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link EnableLoggingCommandInput} for command's `input` shape. + * @see {@link EnableLoggingCommandOutput} for command's `response` shape. + * @see {@link RedshiftClientResolvedConfig | config} for command's `input` shape. + * */ export class EnableLoggingCommand extends $Command< EnableLoggingCommandInput, diff --git a/clients/client-redshift/commands/EnableSnapshotCopyCommand.ts b/clients/client-redshift/commands/EnableSnapshotCopyCommand.ts index 593176886670..b776e879ea2c 100644 --- a/clients/client-redshift/commands/EnableSnapshotCopyCommand.ts +++ b/clients/client-redshift/commands/EnableSnapshotCopyCommand.ts @@ -23,6 +23,20 @@ export interface EnableSnapshotCopyCommandOutput extends EnableSnapshotCopyResul /** *

Enables the automatic copy of snapshots from one region to another region for a * specified cluster.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { RedshiftClient, EnableSnapshotCopyCommand } from "@aws-sdk/client-redshift"; // ES Modules import + * // const { RedshiftClient, EnableSnapshotCopyCommand } = require("@aws-sdk/client-redshift"); // CommonJS import + * const client = new RedshiftClient(config); + * const command = new EnableSnapshotCopyCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link EnableSnapshotCopyCommandInput} for command's `input` shape. + * @see {@link EnableSnapshotCopyCommandOutput} for command's `response` shape. + * @see {@link RedshiftClientResolvedConfig | config} for command's `input` shape. + * */ export class EnableSnapshotCopyCommand extends $Command< EnableSnapshotCopyCommandInput, diff --git a/clients/client-redshift/commands/GetClusterCredentialsCommand.ts b/clients/client-redshift/commands/GetClusterCredentialsCommand.ts index beae27874b5b..0867a26ffdd6 100644 --- a/clients/client-redshift/commands/GetClusterCredentialsCommand.ts +++ b/clients/client-redshift/commands/GetClusterCredentialsCommand.ts @@ -43,6 +43,20 @@ export interface GetClusterCredentialsCommandOutput extends ClusterCredentials, * privilege.

*

If the DbName parameter is specified, the IAM policy must allow access * to the resource dbname for the specified database name.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { RedshiftClient, GetClusterCredentialsCommand } from "@aws-sdk/client-redshift"; // ES Modules import + * // const { RedshiftClient, GetClusterCredentialsCommand } = require("@aws-sdk/client-redshift"); // CommonJS import + * const client = new RedshiftClient(config); + * const command = new GetClusterCredentialsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetClusterCredentialsCommandInput} for command's `input` shape. + * @see {@link GetClusterCredentialsCommandOutput} for command's `response` shape. + * @see {@link RedshiftClientResolvedConfig | config} for command's `input` shape. + * */ export class GetClusterCredentialsCommand extends $Command< GetClusterCredentialsCommandInput, diff --git a/clients/client-redshift/commands/GetReservedNodeExchangeOfferingsCommand.ts b/clients/client-redshift/commands/GetReservedNodeExchangeOfferingsCommand.ts index f8875ffb2ace..54eeffd87268 100644 --- a/clients/client-redshift/commands/GetReservedNodeExchangeOfferingsCommand.ts +++ b/clients/client-redshift/commands/GetReservedNodeExchangeOfferingsCommand.ts @@ -28,6 +28,20 @@ export interface GetReservedNodeExchangeOfferingsCommandOutput /** *

Returns an array of DC2 ReservedNodeOfferings that matches the payment type, term, * and usage price of the given DC1 reserved node.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { RedshiftClient, GetReservedNodeExchangeOfferingsCommand } from "@aws-sdk/client-redshift"; // ES Modules import + * // const { RedshiftClient, GetReservedNodeExchangeOfferingsCommand } = require("@aws-sdk/client-redshift"); // CommonJS import + * const client = new RedshiftClient(config); + * const command = new GetReservedNodeExchangeOfferingsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetReservedNodeExchangeOfferingsCommandInput} for command's `input` shape. + * @see {@link GetReservedNodeExchangeOfferingsCommandOutput} for command's `response` shape. + * @see {@link RedshiftClientResolvedConfig | config} for command's `input` shape. + * */ export class GetReservedNodeExchangeOfferingsCommand extends $Command< GetReservedNodeExchangeOfferingsCommandInput, diff --git a/clients/client-redshift/commands/ModifyAquaConfigurationCommand.ts b/clients/client-redshift/commands/ModifyAquaConfigurationCommand.ts index e8be8e3f632d..3b437436409d 100644 --- a/clients/client-redshift/commands/ModifyAquaConfigurationCommand.ts +++ b/clients/client-redshift/commands/ModifyAquaConfigurationCommand.ts @@ -22,6 +22,20 @@ export interface ModifyAquaConfigurationCommandOutput extends ModifyAquaOutputMe /** *

Modifies whether a cluster can use AQUA (Advanced Query Accelerator).

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { RedshiftClient, ModifyAquaConfigurationCommand } from "@aws-sdk/client-redshift"; // ES Modules import + * // const { RedshiftClient, ModifyAquaConfigurationCommand } = require("@aws-sdk/client-redshift"); // CommonJS import + * const client = new RedshiftClient(config); + * const command = new ModifyAquaConfigurationCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ModifyAquaConfigurationCommandInput} for command's `input` shape. + * @see {@link ModifyAquaConfigurationCommandOutput} for command's `response` shape. + * @see {@link RedshiftClientResolvedConfig | config} for command's `input` shape. + * */ export class ModifyAquaConfigurationCommand extends $Command< ModifyAquaConfigurationCommandInput, diff --git a/clients/client-redshift/commands/ModifyClusterCommand.ts b/clients/client-redshift/commands/ModifyClusterCommand.ts index 4880e30f441e..67ba3b82d999 100644 --- a/clients/client-redshift/commands/ModifyClusterCommand.ts +++ b/clients/client-redshift/commands/ModifyClusterCommand.ts @@ -30,6 +30,20 @@ export interface ModifyClusterCommandOutput extends ModifyClusterResult, __Metad * For more information about managing clusters, go to * Amazon Redshift Clusters * in the Amazon Redshift Cluster Management Guide.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { RedshiftClient, ModifyClusterCommand } from "@aws-sdk/client-redshift"; // ES Modules import + * // const { RedshiftClient, ModifyClusterCommand } = require("@aws-sdk/client-redshift"); // CommonJS import + * const client = new RedshiftClient(config); + * const command = new ModifyClusterCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ModifyClusterCommandInput} for command's `input` shape. + * @see {@link ModifyClusterCommandOutput} for command's `response` shape. + * @see {@link RedshiftClientResolvedConfig | config} for command's `input` shape. + * */ export class ModifyClusterCommand extends $Command< ModifyClusterCommandInput, diff --git a/clients/client-redshift/commands/ModifyClusterDbRevisionCommand.ts b/clients/client-redshift/commands/ModifyClusterDbRevisionCommand.ts index 67d98c9be250..a3cb1bbeb804 100644 --- a/clients/client-redshift/commands/ModifyClusterDbRevisionCommand.ts +++ b/clients/client-redshift/commands/ModifyClusterDbRevisionCommand.ts @@ -23,6 +23,20 @@ export interface ModifyClusterDbRevisionCommandOutput extends ModifyClusterDbRev /** *

Modifies the database revision of a cluster. The database revision is a unique * revision of the database running in a cluster.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { RedshiftClient, ModifyClusterDbRevisionCommand } from "@aws-sdk/client-redshift"; // ES Modules import + * // const { RedshiftClient, ModifyClusterDbRevisionCommand } = require("@aws-sdk/client-redshift"); // CommonJS import + * const client = new RedshiftClient(config); + * const command = new ModifyClusterDbRevisionCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ModifyClusterDbRevisionCommandInput} for command's `input` shape. + * @see {@link ModifyClusterDbRevisionCommandOutput} for command's `response` shape. + * @see {@link RedshiftClientResolvedConfig | config} for command's `input` shape. + * */ export class ModifyClusterDbRevisionCommand extends $Command< ModifyClusterDbRevisionCommandInput, diff --git a/clients/client-redshift/commands/ModifyClusterIamRolesCommand.ts b/clients/client-redshift/commands/ModifyClusterIamRolesCommand.ts index 242598e4a052..59a312e81ef5 100644 --- a/clients/client-redshift/commands/ModifyClusterIamRolesCommand.ts +++ b/clients/client-redshift/commands/ModifyClusterIamRolesCommand.ts @@ -24,6 +24,20 @@ export interface ModifyClusterIamRolesCommandOutput extends ModifyClusterIamRole *

Modifies the list of AWS Identity and Access Management (IAM) roles that can be * used by the cluster to access other AWS services.

*

A cluster can have up to 10 IAM roles associated at any time.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { RedshiftClient, ModifyClusterIamRolesCommand } from "@aws-sdk/client-redshift"; // ES Modules import + * // const { RedshiftClient, ModifyClusterIamRolesCommand } = require("@aws-sdk/client-redshift"); // CommonJS import + * const client = new RedshiftClient(config); + * const command = new ModifyClusterIamRolesCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ModifyClusterIamRolesCommandInput} for command's `input` shape. + * @see {@link ModifyClusterIamRolesCommandOutput} for command's `response` shape. + * @see {@link RedshiftClientResolvedConfig | config} for command's `input` shape. + * */ export class ModifyClusterIamRolesCommand extends $Command< ModifyClusterIamRolesCommandInput, diff --git a/clients/client-redshift/commands/ModifyClusterMaintenanceCommand.ts b/clients/client-redshift/commands/ModifyClusterMaintenanceCommand.ts index 7b2bb9255fa7..63d28ef561f0 100644 --- a/clients/client-redshift/commands/ModifyClusterMaintenanceCommand.ts +++ b/clients/client-redshift/commands/ModifyClusterMaintenanceCommand.ts @@ -22,6 +22,20 @@ export interface ModifyClusterMaintenanceCommandOutput extends ModifyClusterMain /** *

Modifies the maintenance settings of a cluster.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { RedshiftClient, ModifyClusterMaintenanceCommand } from "@aws-sdk/client-redshift"; // ES Modules import + * // const { RedshiftClient, ModifyClusterMaintenanceCommand } = require("@aws-sdk/client-redshift"); // CommonJS import + * const client = new RedshiftClient(config); + * const command = new ModifyClusterMaintenanceCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ModifyClusterMaintenanceCommandInput} for command's `input` shape. + * @see {@link ModifyClusterMaintenanceCommandOutput} for command's `response` shape. + * @see {@link RedshiftClientResolvedConfig | config} for command's `input` shape. + * */ export class ModifyClusterMaintenanceCommand extends $Command< ModifyClusterMaintenanceCommandInput, diff --git a/clients/client-redshift/commands/ModifyClusterParameterGroupCommand.ts b/clients/client-redshift/commands/ModifyClusterParameterGroupCommand.ts index b1459bd2095e..9d3230f0787d 100644 --- a/clients/client-redshift/commands/ModifyClusterParameterGroupCommand.ts +++ b/clients/client-redshift/commands/ModifyClusterParameterGroupCommand.ts @@ -27,6 +27,20 @@ export interface ModifyClusterParameterGroupCommandOutput extends ClusterParamet * For more information about parameters and parameter groups, go to * Amazon Redshift Parameter Groups * in the Amazon Redshift Cluster Management Guide.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { RedshiftClient, ModifyClusterParameterGroupCommand } from "@aws-sdk/client-redshift"; // ES Modules import + * // const { RedshiftClient, ModifyClusterParameterGroupCommand } = require("@aws-sdk/client-redshift"); // CommonJS import + * const client = new RedshiftClient(config); + * const command = new ModifyClusterParameterGroupCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ModifyClusterParameterGroupCommandInput} for command's `input` shape. + * @see {@link ModifyClusterParameterGroupCommandOutput} for command's `response` shape. + * @see {@link RedshiftClientResolvedConfig | config} for command's `input` shape. + * */ export class ModifyClusterParameterGroupCommand extends $Command< ModifyClusterParameterGroupCommandInput, diff --git a/clients/client-redshift/commands/ModifyClusterSnapshotCommand.ts b/clients/client-redshift/commands/ModifyClusterSnapshotCommand.ts index 8638327945e4..064cc1017a81 100644 --- a/clients/client-redshift/commands/ModifyClusterSnapshotCommand.ts +++ b/clients/client-redshift/commands/ModifyClusterSnapshotCommand.ts @@ -23,6 +23,20 @@ export interface ModifyClusterSnapshotCommandOutput extends ModifyClusterSnapsho /** *

Modifies the settings for a snapshot.

*

This exanmple modifies the manual retention period setting for a cluster snapshot.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { RedshiftClient, ModifyClusterSnapshotCommand } from "@aws-sdk/client-redshift"; // ES Modules import + * // const { RedshiftClient, ModifyClusterSnapshotCommand } = require("@aws-sdk/client-redshift"); // CommonJS import + * const client = new RedshiftClient(config); + * const command = new ModifyClusterSnapshotCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ModifyClusterSnapshotCommandInput} for command's `input` shape. + * @see {@link ModifyClusterSnapshotCommandOutput} for command's `response` shape. + * @see {@link RedshiftClientResolvedConfig | config} for command's `input` shape. + * */ export class ModifyClusterSnapshotCommand extends $Command< ModifyClusterSnapshotCommandInput, diff --git a/clients/client-redshift/commands/ModifyClusterSnapshotScheduleCommand.ts b/clients/client-redshift/commands/ModifyClusterSnapshotScheduleCommand.ts index 13a205c675af..250ab9d70eb1 100644 --- a/clients/client-redshift/commands/ModifyClusterSnapshotScheduleCommand.ts +++ b/clients/client-redshift/commands/ModifyClusterSnapshotScheduleCommand.ts @@ -22,6 +22,20 @@ export interface ModifyClusterSnapshotScheduleCommandOutput extends __MetadataBe /** *

Modifies a snapshot schedule for a cluster.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { RedshiftClient, ModifyClusterSnapshotScheduleCommand } from "@aws-sdk/client-redshift"; // ES Modules import + * // const { RedshiftClient, ModifyClusterSnapshotScheduleCommand } = require("@aws-sdk/client-redshift"); // CommonJS import + * const client = new RedshiftClient(config); + * const command = new ModifyClusterSnapshotScheduleCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ModifyClusterSnapshotScheduleCommandInput} for command's `input` shape. + * @see {@link ModifyClusterSnapshotScheduleCommandOutput} for command's `response` shape. + * @see {@link RedshiftClientResolvedConfig | config} for command's `input` shape. + * */ export class ModifyClusterSnapshotScheduleCommand extends $Command< ModifyClusterSnapshotScheduleCommandInput, diff --git a/clients/client-redshift/commands/ModifyClusterSubnetGroupCommand.ts b/clients/client-redshift/commands/ModifyClusterSubnetGroupCommand.ts index 9082db63a694..4315eed0ecb5 100644 --- a/clients/client-redshift/commands/ModifyClusterSubnetGroupCommand.ts +++ b/clients/client-redshift/commands/ModifyClusterSubnetGroupCommand.ts @@ -23,6 +23,20 @@ export interface ModifyClusterSubnetGroupCommandOutput extends ModifyClusterSubn /** *

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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { RedshiftClient, ModifyClusterSubnetGroupCommand } from "@aws-sdk/client-redshift"; // ES Modules import + * // const { RedshiftClient, ModifyClusterSubnetGroupCommand } = require("@aws-sdk/client-redshift"); // CommonJS import + * const client = new RedshiftClient(config); + * const command = new ModifyClusterSubnetGroupCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ModifyClusterSubnetGroupCommandInput} for command's `input` shape. + * @see {@link ModifyClusterSubnetGroupCommandOutput} for command's `response` shape. + * @see {@link RedshiftClientResolvedConfig | config} for command's `input` shape. + * */ export class ModifyClusterSubnetGroupCommand extends $Command< ModifyClusterSubnetGroupCommandInput, diff --git a/clients/client-redshift/commands/ModifyEndpointAccessCommand.ts b/clients/client-redshift/commands/ModifyEndpointAccessCommand.ts index 741930c180c9..479d41b375cb 100644 --- a/clients/client-redshift/commands/ModifyEndpointAccessCommand.ts +++ b/clients/client-redshift/commands/ModifyEndpointAccessCommand.ts @@ -23,6 +23,20 @@ export interface ModifyEndpointAccessCommandOutput extends EndpointAccess, __Met /** *

Modifies a Redshift-managed VPC endpoint.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { RedshiftClient, ModifyEndpointAccessCommand } from "@aws-sdk/client-redshift"; // ES Modules import + * // const { RedshiftClient, ModifyEndpointAccessCommand } = require("@aws-sdk/client-redshift"); // CommonJS import + * const client = new RedshiftClient(config); + * const command = new ModifyEndpointAccessCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ModifyEndpointAccessCommandInput} for command's `input` shape. + * @see {@link ModifyEndpointAccessCommandOutput} for command's `response` shape. + * @see {@link RedshiftClientResolvedConfig | config} for command's `input` shape. + * */ export class ModifyEndpointAccessCommand extends $Command< ModifyEndpointAccessCommandInput, diff --git a/clients/client-redshift/commands/ModifyEventSubscriptionCommand.ts b/clients/client-redshift/commands/ModifyEventSubscriptionCommand.ts index 94e42c2caa65..0043c23cbb6a 100644 --- a/clients/client-redshift/commands/ModifyEventSubscriptionCommand.ts +++ b/clients/client-redshift/commands/ModifyEventSubscriptionCommand.ts @@ -22,6 +22,20 @@ export interface ModifyEventSubscriptionCommandOutput extends ModifyEventSubscri /** *

Modifies an existing Amazon Redshift event notification subscription.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { RedshiftClient, ModifyEventSubscriptionCommand } from "@aws-sdk/client-redshift"; // ES Modules import + * // const { RedshiftClient, ModifyEventSubscriptionCommand } = require("@aws-sdk/client-redshift"); // CommonJS import + * const client = new RedshiftClient(config); + * const command = new ModifyEventSubscriptionCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ModifyEventSubscriptionCommandInput} for command's `input` shape. + * @see {@link ModifyEventSubscriptionCommandOutput} for command's `response` shape. + * @see {@link RedshiftClientResolvedConfig | config} for command's `input` shape. + * */ export class ModifyEventSubscriptionCommand extends $Command< ModifyEventSubscriptionCommandInput, diff --git a/clients/client-redshift/commands/ModifyScheduledActionCommand.ts b/clients/client-redshift/commands/ModifyScheduledActionCommand.ts index 6b9f0c16a0db..4f4cea8e701a 100644 --- a/clients/client-redshift/commands/ModifyScheduledActionCommand.ts +++ b/clients/client-redshift/commands/ModifyScheduledActionCommand.ts @@ -24,6 +24,20 @@ export interface ModifyScheduledActionCommandOutput extends ScheduledAction, __M /** *

Modifies a scheduled action. *

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { RedshiftClient, ModifyScheduledActionCommand } from "@aws-sdk/client-redshift"; // ES Modules import + * // const { RedshiftClient, ModifyScheduledActionCommand } = require("@aws-sdk/client-redshift"); // CommonJS import + * const client = new RedshiftClient(config); + * const command = new ModifyScheduledActionCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ModifyScheduledActionCommandInput} for command's `input` shape. + * @see {@link ModifyScheduledActionCommandOutput} for command's `response` shape. + * @see {@link RedshiftClientResolvedConfig | config} for command's `input` shape. + * */ export class ModifyScheduledActionCommand extends $Command< ModifyScheduledActionCommandInput, diff --git a/clients/client-redshift/commands/ModifySnapshotCopyRetentionPeriodCommand.ts b/clients/client-redshift/commands/ModifySnapshotCopyRetentionPeriodCommand.ts index 9f9115a171a5..93df64ed549e 100644 --- a/clients/client-redshift/commands/ModifySnapshotCopyRetentionPeriodCommand.ts +++ b/clients/client-redshift/commands/ModifySnapshotCopyRetentionPeriodCommand.ts @@ -30,6 +30,20 @@ export interface ModifySnapshotCopyRetentionPeriodCommandOutput * 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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { RedshiftClient, ModifySnapshotCopyRetentionPeriodCommand } from "@aws-sdk/client-redshift"; // ES Modules import + * // const { RedshiftClient, ModifySnapshotCopyRetentionPeriodCommand } = require("@aws-sdk/client-redshift"); // CommonJS import + * const client = new RedshiftClient(config); + * const command = new ModifySnapshotCopyRetentionPeriodCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ModifySnapshotCopyRetentionPeriodCommandInput} for command's `input` shape. + * @see {@link ModifySnapshotCopyRetentionPeriodCommandOutput} for command's `response` shape. + * @see {@link RedshiftClientResolvedConfig | config} for command's `input` shape. + * */ export class ModifySnapshotCopyRetentionPeriodCommand extends $Command< ModifySnapshotCopyRetentionPeriodCommandInput, diff --git a/clients/client-redshift/commands/ModifySnapshotScheduleCommand.ts b/clients/client-redshift/commands/ModifySnapshotScheduleCommand.ts index 89a6a6ce93a0..0525caeea337 100644 --- a/clients/client-redshift/commands/ModifySnapshotScheduleCommand.ts +++ b/clients/client-redshift/commands/ModifySnapshotScheduleCommand.ts @@ -24,6 +24,20 @@ export interface ModifySnapshotScheduleCommandOutput extends SnapshotSchedule, _ /** *

Modifies a snapshot schedule. Any schedule associated with a cluster is modified * asynchronously.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { RedshiftClient, ModifySnapshotScheduleCommand } from "@aws-sdk/client-redshift"; // ES Modules import + * // const { RedshiftClient, ModifySnapshotScheduleCommand } = require("@aws-sdk/client-redshift"); // CommonJS import + * const client = new RedshiftClient(config); + * const command = new ModifySnapshotScheduleCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ModifySnapshotScheduleCommandInput} for command's `input` shape. + * @see {@link ModifySnapshotScheduleCommandOutput} for command's `response` shape. + * @see {@link RedshiftClientResolvedConfig | config} for command's `input` shape. + * */ export class ModifySnapshotScheduleCommand extends $Command< ModifySnapshotScheduleCommandInput, diff --git a/clients/client-redshift/commands/ModifyUsageLimitCommand.ts b/clients/client-redshift/commands/ModifyUsageLimitCommand.ts index 2a7dee5d292a..ee0a508a59e7 100644 --- a/clients/client-redshift/commands/ModifyUsageLimitCommand.ts +++ b/clients/client-redshift/commands/ModifyUsageLimitCommand.ts @@ -24,6 +24,20 @@ export interface ModifyUsageLimitCommandOutput extends UsageLimit, __MetadataBea /** *

Modifies a usage limit in a cluster. * You can't modify the feature type or period of a usage limit.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { RedshiftClient, ModifyUsageLimitCommand } from "@aws-sdk/client-redshift"; // ES Modules import + * // const { RedshiftClient, ModifyUsageLimitCommand } = require("@aws-sdk/client-redshift"); // CommonJS import + * const client = new RedshiftClient(config); + * const command = new ModifyUsageLimitCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ModifyUsageLimitCommandInput} for command's `input` shape. + * @see {@link ModifyUsageLimitCommandOutput} for command's `response` shape. + * @see {@link RedshiftClientResolvedConfig | config} for command's `input` shape. + * */ export class ModifyUsageLimitCommand extends $Command< ModifyUsageLimitCommandInput, diff --git a/clients/client-redshift/commands/PauseClusterCommand.ts b/clients/client-redshift/commands/PauseClusterCommand.ts index 7fc99c084075..f9487e317e46 100644 --- a/clients/client-redshift/commands/PauseClusterCommand.ts +++ b/clients/client-redshift/commands/PauseClusterCommand.ts @@ -20,6 +20,20 @@ export interface PauseClusterCommandOutput extends PauseClusterResult, __Metadat /** *

Pauses a cluster.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { RedshiftClient, PauseClusterCommand } from "@aws-sdk/client-redshift"; // ES Modules import + * // const { RedshiftClient, PauseClusterCommand } = require("@aws-sdk/client-redshift"); // CommonJS import + * const client = new RedshiftClient(config); + * const command = new PauseClusterCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link PauseClusterCommandInput} for command's `input` shape. + * @see {@link PauseClusterCommandOutput} for command's `response` shape. + * @see {@link RedshiftClientResolvedConfig | config} for command's `input` shape. + * */ export class PauseClusterCommand extends $Command< PauseClusterCommandInput, diff --git a/clients/client-redshift/commands/PurchaseReservedNodeOfferingCommand.ts b/clients/client-redshift/commands/PurchaseReservedNodeOfferingCommand.ts index 63c68a113267..074f204b1293 100644 --- a/clients/client-redshift/commands/PurchaseReservedNodeOfferingCommand.ts +++ b/clients/client-redshift/commands/PurchaseReservedNodeOfferingCommand.ts @@ -32,6 +32,20 @@ export interface PurchaseReservedNodeOfferingCommandOutput * For more information about reserved node offerings, go to * Purchasing Reserved Nodes * in the Amazon Redshift Cluster Management Guide.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { RedshiftClient, PurchaseReservedNodeOfferingCommand } from "@aws-sdk/client-redshift"; // ES Modules import + * // const { RedshiftClient, PurchaseReservedNodeOfferingCommand } = require("@aws-sdk/client-redshift"); // CommonJS import + * const client = new RedshiftClient(config); + * const command = new PurchaseReservedNodeOfferingCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link PurchaseReservedNodeOfferingCommandInput} for command's `input` shape. + * @see {@link PurchaseReservedNodeOfferingCommandOutput} for command's `response` shape. + * @see {@link RedshiftClientResolvedConfig | config} for command's `input` shape. + * */ export class PurchaseReservedNodeOfferingCommand extends $Command< PurchaseReservedNodeOfferingCommandInput, diff --git a/clients/client-redshift/commands/RebootClusterCommand.ts b/clients/client-redshift/commands/RebootClusterCommand.ts index 395a505443bc..e89aeb9ae001 100644 --- a/clients/client-redshift/commands/RebootClusterCommand.ts +++ b/clients/client-redshift/commands/RebootClusterCommand.ts @@ -29,6 +29,20 @@ export interface RebootClusterCommandOutput extends RebootClusterResult, __Metad * For more information about managing clusters, go to * Amazon Redshift Clusters * in the Amazon Redshift Cluster Management Guide.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { RedshiftClient, RebootClusterCommand } from "@aws-sdk/client-redshift"; // ES Modules import + * // const { RedshiftClient, RebootClusterCommand } = require("@aws-sdk/client-redshift"); // CommonJS import + * const client = new RedshiftClient(config); + * const command = new RebootClusterCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link RebootClusterCommandInput} for command's `input` shape. + * @see {@link RebootClusterCommandOutput} for command's `response` shape. + * @see {@link RedshiftClientResolvedConfig | config} for command's `input` shape. + * */ export class RebootClusterCommand extends $Command< RebootClusterCommandInput, diff --git a/clients/client-redshift/commands/ResetClusterParameterGroupCommand.ts b/clients/client-redshift/commands/ResetClusterParameterGroupCommand.ts index 88682b2bd138..8c047757313a 100644 --- a/clients/client-redshift/commands/ResetClusterParameterGroupCommand.ts +++ b/clients/client-redshift/commands/ResetClusterParameterGroupCommand.ts @@ -26,6 +26,20 @@ export interface ResetClusterParameterGroupCommandOutput extends ClusterParamete * 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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { RedshiftClient, ResetClusterParameterGroupCommand } from "@aws-sdk/client-redshift"; // ES Modules import + * // const { RedshiftClient, ResetClusterParameterGroupCommand } = require("@aws-sdk/client-redshift"); // CommonJS import + * const client = new RedshiftClient(config); + * const command = new ResetClusterParameterGroupCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ResetClusterParameterGroupCommandInput} for command's `input` shape. + * @see {@link ResetClusterParameterGroupCommandOutput} for command's `response` shape. + * @see {@link RedshiftClientResolvedConfig | config} for command's `input` shape. + * */ export class ResetClusterParameterGroupCommand extends $Command< ResetClusterParameterGroupCommandInput, diff --git a/clients/client-redshift/commands/ResizeClusterCommand.ts b/clients/client-redshift/commands/ResizeClusterCommand.ts index ccd9c275e07b..92f15dd62ab0 100644 --- a/clients/client-redshift/commands/ResizeClusterCommand.ts +++ b/clients/client-redshift/commands/ResizeClusterCommand.ts @@ -65,6 +65,20 @@ export interface ResizeClusterCommandOutput extends ResizeClusterResult, __Metad * cluster.

* * + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { RedshiftClient, ResizeClusterCommand } from "@aws-sdk/client-redshift"; // ES Modules import + * // const { RedshiftClient, ResizeClusterCommand } = require("@aws-sdk/client-redshift"); // CommonJS import + * const client = new RedshiftClient(config); + * const command = new ResizeClusterCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ResizeClusterCommandInput} for command's `input` shape. + * @see {@link ResizeClusterCommandOutput} for command's `response` shape. + * @see {@link RedshiftClientResolvedConfig | config} for command's `input` shape. + * */ export class ResizeClusterCommand extends $Command< ResizeClusterCommandInput, diff --git a/clients/client-redshift/commands/RestoreFromClusterSnapshotCommand.ts b/clients/client-redshift/commands/RestoreFromClusterSnapshotCommand.ts index 6bdcda4c102e..087b35ba0d0f 100644 --- a/clients/client-redshift/commands/RestoreFromClusterSnapshotCommand.ts +++ b/clients/client-redshift/commands/RestoreFromClusterSnapshotCommand.ts @@ -33,6 +33,20 @@ export interface RestoreFromClusterSnapshotCommandOutput extends RestoreFromClus * For more information about working with snapshots, go to * Amazon Redshift Snapshots * in the Amazon Redshift Cluster Management Guide.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { RedshiftClient, RestoreFromClusterSnapshotCommand } from "@aws-sdk/client-redshift"; // ES Modules import + * // const { RedshiftClient, RestoreFromClusterSnapshotCommand } = require("@aws-sdk/client-redshift"); // CommonJS import + * const client = new RedshiftClient(config); + * const command = new RestoreFromClusterSnapshotCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link RestoreFromClusterSnapshotCommandInput} for command's `input` shape. + * @see {@link RestoreFromClusterSnapshotCommandOutput} for command's `response` shape. + * @see {@link RedshiftClientResolvedConfig | config} for command's `input` shape. + * */ export class RestoreFromClusterSnapshotCommand extends $Command< RestoreFromClusterSnapshotCommandInput, diff --git a/clients/client-redshift/commands/RestoreTableFromClusterSnapshotCommand.ts b/clients/client-redshift/commands/RestoreTableFromClusterSnapshotCommand.ts index 519b9013f90e..a43c42502c43 100644 --- a/clients/client-redshift/commands/RestoreTableFromClusterSnapshotCommand.ts +++ b/clients/client-redshift/commands/RestoreTableFromClusterSnapshotCommand.ts @@ -35,6 +35,20 @@ export interface RestoreTableFromClusterSnapshotCommandOutput * NewTableName parameter value in the call to * RestoreTableFromClusterSnapshot. This way, you can replace the original * table with the table created from the snapshot.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { RedshiftClient, RestoreTableFromClusterSnapshotCommand } from "@aws-sdk/client-redshift"; // ES Modules import + * // const { RedshiftClient, RestoreTableFromClusterSnapshotCommand } = require("@aws-sdk/client-redshift"); // CommonJS import + * const client = new RedshiftClient(config); + * const command = new RestoreTableFromClusterSnapshotCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link RestoreTableFromClusterSnapshotCommandInput} for command's `input` shape. + * @see {@link RestoreTableFromClusterSnapshotCommandOutput} for command's `response` shape. + * @see {@link RedshiftClientResolvedConfig | config} for command's `input` shape. + * */ export class RestoreTableFromClusterSnapshotCommand extends $Command< RestoreTableFromClusterSnapshotCommandInput, diff --git a/clients/client-redshift/commands/ResumeClusterCommand.ts b/clients/client-redshift/commands/ResumeClusterCommand.ts index 3237a57253df..7381dfeea7f2 100644 --- a/clients/client-redshift/commands/ResumeClusterCommand.ts +++ b/clients/client-redshift/commands/ResumeClusterCommand.ts @@ -23,6 +23,20 @@ export interface ResumeClusterCommandOutput extends ResumeClusterResult, __Metad /** *

Resumes a paused cluster.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { RedshiftClient, ResumeClusterCommand } from "@aws-sdk/client-redshift"; // ES Modules import + * // const { RedshiftClient, ResumeClusterCommand } = require("@aws-sdk/client-redshift"); // CommonJS import + * const client = new RedshiftClient(config); + * const command = new ResumeClusterCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ResumeClusterCommandInput} for command's `input` shape. + * @see {@link ResumeClusterCommandOutput} for command's `response` shape. + * @see {@link RedshiftClientResolvedConfig | config} for command's `input` shape. + * */ export class ResumeClusterCommand extends $Command< ResumeClusterCommandInput, diff --git a/clients/client-redshift/commands/RevokeClusterSecurityGroupIngressCommand.ts b/clients/client-redshift/commands/RevokeClusterSecurityGroupIngressCommand.ts index b3c5f4fe90cb..6ea35ce59a8d 100644 --- a/clients/client-redshift/commands/RevokeClusterSecurityGroupIngressCommand.ts +++ b/clients/client-redshift/commands/RevokeClusterSecurityGroupIngressCommand.ts @@ -28,6 +28,20 @@ export interface RevokeClusterSecurityGroupIngressCommandOutput * For information about managing security groups, go to * Amazon Redshift Cluster Security Groups in the * Amazon Redshift Cluster Management Guide.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { RedshiftClient, RevokeClusterSecurityGroupIngressCommand } from "@aws-sdk/client-redshift"; // ES Modules import + * // const { RedshiftClient, RevokeClusterSecurityGroupIngressCommand } = require("@aws-sdk/client-redshift"); // CommonJS import + * const client = new RedshiftClient(config); + * const command = new RevokeClusterSecurityGroupIngressCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link RevokeClusterSecurityGroupIngressCommandInput} for command's `input` shape. + * @see {@link RevokeClusterSecurityGroupIngressCommandOutput} for command's `response` shape. + * @see {@link RedshiftClientResolvedConfig | config} for command's `input` shape. + * */ export class RevokeClusterSecurityGroupIngressCommand extends $Command< RevokeClusterSecurityGroupIngressCommandInput, diff --git a/clients/client-redshift/commands/RevokeEndpointAccessCommand.ts b/clients/client-redshift/commands/RevokeEndpointAccessCommand.ts index e73d6404a4bf..3776a523cf35 100644 --- a/clients/client-redshift/commands/RevokeEndpointAccessCommand.ts +++ b/clients/client-redshift/commands/RevokeEndpointAccessCommand.ts @@ -23,6 +23,20 @@ export interface RevokeEndpointAccessCommandOutput extends EndpointAuthorization /** *

Revokes access to a cluster.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { RedshiftClient, RevokeEndpointAccessCommand } from "@aws-sdk/client-redshift"; // ES Modules import + * // const { RedshiftClient, RevokeEndpointAccessCommand } = require("@aws-sdk/client-redshift"); // CommonJS import + * const client = new RedshiftClient(config); + * const command = new RevokeEndpointAccessCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link RevokeEndpointAccessCommandInput} for command's `input` shape. + * @see {@link RevokeEndpointAccessCommandOutput} for command's `response` shape. + * @see {@link RedshiftClientResolvedConfig | config} for command's `input` shape. + * */ export class RevokeEndpointAccessCommand extends $Command< RevokeEndpointAccessCommandInput, diff --git a/clients/client-redshift/commands/RevokeSnapshotAccessCommand.ts b/clients/client-redshift/commands/RevokeSnapshotAccessCommand.ts index 6016c7305d86..48b7adfa5ad3 100644 --- a/clients/client-redshift/commands/RevokeSnapshotAccessCommand.ts +++ b/clients/client-redshift/commands/RevokeSnapshotAccessCommand.ts @@ -28,6 +28,20 @@ export interface RevokeSnapshotAccessCommandOutput extends RevokeSnapshotAccessR * For more information about working with snapshots, go to * Amazon Redshift Snapshots * in the Amazon Redshift Cluster Management Guide.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { RedshiftClient, RevokeSnapshotAccessCommand } from "@aws-sdk/client-redshift"; // ES Modules import + * // const { RedshiftClient, RevokeSnapshotAccessCommand } = require("@aws-sdk/client-redshift"); // CommonJS import + * const client = new RedshiftClient(config); + * const command = new RevokeSnapshotAccessCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link RevokeSnapshotAccessCommandInput} for command's `input` shape. + * @see {@link RevokeSnapshotAccessCommandOutput} for command's `response` shape. + * @see {@link RedshiftClientResolvedConfig | config} for command's `input` shape. + * */ export class RevokeSnapshotAccessCommand extends $Command< RevokeSnapshotAccessCommandInput, diff --git a/clients/client-redshift/commands/RotateEncryptionKeyCommand.ts b/clients/client-redshift/commands/RotateEncryptionKeyCommand.ts index 18c6cec0f543..ed92160bdcec 100644 --- a/clients/client-redshift/commands/RotateEncryptionKeyCommand.ts +++ b/clients/client-redshift/commands/RotateEncryptionKeyCommand.ts @@ -22,6 +22,20 @@ export interface RotateEncryptionKeyCommandOutput extends RotateEncryptionKeyRes /** *

Rotates the encryption keys for a cluster.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { RedshiftClient, RotateEncryptionKeyCommand } from "@aws-sdk/client-redshift"; // ES Modules import + * // const { RedshiftClient, RotateEncryptionKeyCommand } = require("@aws-sdk/client-redshift"); // CommonJS import + * const client = new RedshiftClient(config); + * const command = new RotateEncryptionKeyCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link RotateEncryptionKeyCommandInput} for command's `input` shape. + * @see {@link RotateEncryptionKeyCommandOutput} for command's `response` shape. + * @see {@link RedshiftClientResolvedConfig | config} for command's `input` shape. + * */ export class RotateEncryptionKeyCommand extends $Command< RotateEncryptionKeyCommandInput, diff --git a/clients/client-redshift/commands/UpdatePartnerStatusCommand.ts b/clients/client-redshift/commands/UpdatePartnerStatusCommand.ts index c68f7a99a287..d0862baad5e8 100644 --- a/clients/client-redshift/commands/UpdatePartnerStatusCommand.ts +++ b/clients/client-redshift/commands/UpdatePartnerStatusCommand.ts @@ -23,6 +23,20 @@ export interface UpdatePartnerStatusCommandOutput extends PartnerIntegrationOutp /** *

Updates the status of a partner integration.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { RedshiftClient, UpdatePartnerStatusCommand } from "@aws-sdk/client-redshift"; // ES Modules import + * // const { RedshiftClient, UpdatePartnerStatusCommand } = require("@aws-sdk/client-redshift"); // CommonJS import + * const client = new RedshiftClient(config); + * const command = new UpdatePartnerStatusCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link UpdatePartnerStatusCommandInput} for command's `input` shape. + * @see {@link UpdatePartnerStatusCommandOutput} for command's `response` shape. + * @see {@link RedshiftClientResolvedConfig | config} for command's `input` shape. + * */ export class UpdatePartnerStatusCommand extends $Command< UpdatePartnerStatusCommandInput, diff --git a/clients/client-redshift/models/models_0.ts b/clients/client-redshift/models/models_0.ts index ca8f619eac3d..d453832681df 100644 --- a/clients/client-redshift/models/models_0.ts +++ b/clients/client-redshift/models/models_0.ts @@ -17,6 +17,9 @@ export interface AcceptReservedNodeExchangeInputMessage { } export namespace AcceptReservedNodeExchangeInputMessage { + /** + * @internal + */ export const filterSensitiveLog = (obj: AcceptReservedNodeExchangeInputMessage): any => ({ ...obj, }); @@ -39,6 +42,9 @@ export interface RecurringCharge { } export namespace RecurringCharge { + /** + * @internal + */ export const filterSensitiveLog = (obj: RecurringCharge): any => ({ ...obj, }); @@ -141,6 +147,9 @@ export interface ReservedNode { } export namespace ReservedNode { + /** + * @internal + */ export const filterSensitiveLog = (obj: ReservedNode): any => ({ ...obj, }); @@ -154,6 +163,9 @@ export interface AcceptReservedNodeExchangeOutputMessage { } export namespace AcceptReservedNodeExchangeOutputMessage { + /** + * @internal + */ export const filterSensitiveLog = (obj: AcceptReservedNodeExchangeOutputMessage): any => ({ ...obj, }); @@ -170,6 +182,9 @@ export interface DependentServiceUnavailableFault extends __SmithyException, $Me } export namespace DependentServiceUnavailableFault { + /** + * @internal + */ export const filterSensitiveLog = (obj: DependentServiceUnavailableFault): any => ({ ...obj, }); @@ -185,6 +200,9 @@ export interface InvalidReservedNodeStateFault extends __SmithyException, $Metad } export namespace InvalidReservedNodeStateFault { + /** + * @internal + */ export const filterSensitiveLog = (obj: InvalidReservedNodeStateFault): any => ({ ...obj, }); @@ -200,6 +218,9 @@ export interface ReservedNodeAlreadyExistsFault extends __SmithyException, $Meta } export namespace ReservedNodeAlreadyExistsFault { + /** + * @internal + */ export const filterSensitiveLog = (obj: ReservedNodeAlreadyExistsFault): any => ({ ...obj, }); @@ -215,6 +236,9 @@ export interface ReservedNodeAlreadyMigratedFault extends __SmithyException, $Me } export namespace ReservedNodeAlreadyMigratedFault { + /** + * @internal + */ export const filterSensitiveLog = (obj: ReservedNodeAlreadyMigratedFault): any => ({ ...obj, }); @@ -230,6 +254,9 @@ export interface ReservedNodeNotFoundFault extends __SmithyException, $MetadataB } export namespace ReservedNodeNotFoundFault { + /** + * @internal + */ export const filterSensitiveLog = (obj: ReservedNodeNotFoundFault): any => ({ ...obj, }); @@ -245,6 +272,9 @@ export interface ReservedNodeOfferingNotFoundFault extends __SmithyException, $M } export namespace ReservedNodeOfferingNotFoundFault { + /** + * @internal + */ export const filterSensitiveLog = (obj: ReservedNodeOfferingNotFoundFault): any => ({ ...obj, }); @@ -260,6 +290,9 @@ export interface UnsupportedOperationFault extends __SmithyException, $MetadataB } export namespace UnsupportedOperationFault { + /** + * @internal + */ export const filterSensitiveLog = (obj: UnsupportedOperationFault): any => ({ ...obj, }); @@ -275,6 +308,9 @@ export interface AccessToClusterDeniedFault extends __SmithyException, $Metadata } export namespace AccessToClusterDeniedFault { + /** + * @internal + */ export const filterSensitiveLog = (obj: AccessToClusterDeniedFault): any => ({ ...obj, }); @@ -291,6 +327,9 @@ export interface AccessToSnapshotDeniedFault extends __SmithyException, $Metadat } export namespace AccessToSnapshotDeniedFault { + /** + * @internal + */ export const filterSensitiveLog = (obj: AccessToSnapshotDeniedFault): any => ({ ...obj, }); @@ -307,6 +346,9 @@ export interface AttributeValueTarget { } export namespace AttributeValueTarget { + /** + * @internal + */ export const filterSensitiveLog = (obj: AttributeValueTarget): any => ({ ...obj, }); @@ -328,6 +370,9 @@ export interface AccountAttribute { } export namespace AccountAttribute { + /** + * @internal + */ export const filterSensitiveLog = (obj: AccountAttribute): any => ({ ...obj, }); @@ -341,6 +386,9 @@ export interface AccountAttributeList { } export namespace AccountAttributeList { + /** + * @internal + */ export const filterSensitiveLog = (obj: AccountAttributeList): any => ({ ...obj, }); @@ -364,6 +412,9 @@ export interface AccountWithRestoreAccess { } export namespace AccountWithRestoreAccess { + /** + * @internal + */ export const filterSensitiveLog = (obj: AccountWithRestoreAccess): any => ({ ...obj, }); @@ -386,6 +437,9 @@ export interface ClusterNotFoundFault extends __SmithyException, $MetadataBearer } export namespace ClusterNotFoundFault { + /** + * @internal + */ export const filterSensitiveLog = (obj: ClusterNotFoundFault): any => ({ ...obj, }); @@ -414,6 +468,9 @@ export interface PartnerIntegrationInputMessage { } export namespace PartnerIntegrationInputMessage { + /** + * @internal + */ export const filterSensitiveLog = (obj: PartnerIntegrationInputMessage): any => ({ ...obj, }); @@ -432,6 +489,9 @@ export interface PartnerIntegrationOutputMessage { } export namespace PartnerIntegrationOutputMessage { + /** + * @internal + */ export const filterSensitiveLog = (obj: PartnerIntegrationOutputMessage): any => ({ ...obj, }); @@ -447,6 +507,9 @@ export interface PartnerNotFoundFault extends __SmithyException, $MetadataBearer } export namespace PartnerNotFoundFault { + /** + * @internal + */ export const filterSensitiveLog = (obj: PartnerNotFoundFault): any => ({ ...obj, }); @@ -462,6 +525,9 @@ export interface UnauthorizedPartnerIntegrationFault extends __SmithyException, } export namespace UnauthorizedPartnerIntegrationFault { + /** + * @internal + */ export const filterSensitiveLog = (obj: UnauthorizedPartnerIntegrationFault): any => ({ ...obj, }); @@ -517,6 +583,9 @@ export interface AquaConfiguration { } export namespace AquaConfiguration { + /** + * @internal + */ export const filterSensitiveLog = (obj: AquaConfiguration): any => ({ ...obj, }); @@ -540,6 +609,9 @@ export interface ClusterAssociatedToSchedule { } export namespace ClusterAssociatedToSchedule { + /** + * @internal + */ export const filterSensitiveLog = (obj: ClusterAssociatedToSchedule): any => ({ ...obj, }); @@ -556,6 +628,9 @@ export interface AuthorizationAlreadyExistsFault extends __SmithyException, $Met } export namespace AuthorizationAlreadyExistsFault { + /** + * @internal + */ export const filterSensitiveLog = (obj: AuthorizationAlreadyExistsFault): any => ({ ...obj, }); @@ -572,6 +647,9 @@ export interface AuthorizationNotFoundFault extends __SmithyException, $Metadata } export namespace AuthorizationNotFoundFault { + /** + * @internal + */ export const filterSensitiveLog = (obj: AuthorizationNotFoundFault): any => ({ ...obj, }); @@ -587,6 +665,9 @@ export interface AuthorizationQuotaExceededFault extends __SmithyException, $Met } export namespace AuthorizationQuotaExceededFault { + /** + * @internal + */ export const filterSensitiveLog = (obj: AuthorizationQuotaExceededFault): any => ({ ...obj, }); @@ -627,6 +708,9 @@ export interface AuthorizeClusterSecurityGroupIngressMessage { } export namespace AuthorizeClusterSecurityGroupIngressMessage { + /** + * @internal + */ export const filterSensitiveLog = (obj: AuthorizeClusterSecurityGroupIngressMessage): any => ({ ...obj, }); @@ -648,6 +732,9 @@ export interface Tag { } export namespace Tag { + /** + * @internal + */ export const filterSensitiveLog = (obj: Tag): any => ({ ...obj, }); @@ -680,6 +767,9 @@ export interface EC2SecurityGroup { } export namespace EC2SecurityGroup { + /** + * @internal + */ export const filterSensitiveLog = (obj: EC2SecurityGroup): any => ({ ...obj, }); @@ -706,6 +796,9 @@ export interface IPRange { } export namespace IPRange { + /** + * @internal + */ export const filterSensitiveLog = (obj: IPRange): any => ({ ...obj, }); @@ -745,6 +838,9 @@ export interface ClusterSecurityGroup { } export namespace ClusterSecurityGroup { + /** + * @internal + */ export const filterSensitiveLog = (obj: ClusterSecurityGroup): any => ({ ...obj, }); @@ -758,6 +854,9 @@ export interface AuthorizeClusterSecurityGroupIngressResult { } export namespace AuthorizeClusterSecurityGroupIngressResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: AuthorizeClusterSecurityGroupIngressResult): any => ({ ...obj, }); @@ -774,6 +873,9 @@ export interface ClusterSecurityGroupNotFoundFault extends __SmithyException, $M } export namespace ClusterSecurityGroupNotFoundFault { + /** + * @internal + */ export const filterSensitiveLog = (obj: ClusterSecurityGroupNotFoundFault): any => ({ ...obj, }); @@ -789,6 +891,9 @@ export interface InvalidClusterSecurityGroupStateFault extends __SmithyException } export namespace InvalidClusterSecurityGroupStateFault { + /** + * @internal + */ export const filterSensitiveLog = (obj: InvalidClusterSecurityGroupStateFault): any => ({ ...obj, }); @@ -812,6 +917,9 @@ export interface AuthorizeEndpointAccessMessage { } export namespace AuthorizeEndpointAccessMessage { + /** + * @internal + */ export const filterSensitiveLog = (obj: AuthorizeEndpointAccessMessage): any => ({ ...obj, }); @@ -868,6 +976,9 @@ export interface EndpointAuthorization { } export namespace EndpointAuthorization { + /** + * @internal + */ export const filterSensitiveLog = (obj: EndpointAuthorization): any => ({ ...obj, }); @@ -883,6 +994,9 @@ export interface EndpointAuthorizationAlreadyExistsFault extends __SmithyExcepti } export namespace EndpointAuthorizationAlreadyExistsFault { + /** + * @internal + */ export const filterSensitiveLog = (obj: EndpointAuthorizationAlreadyExistsFault): any => ({ ...obj, }); @@ -898,6 +1012,9 @@ export interface EndpointAuthorizationsPerClusterLimitExceededFault extends __Sm } export namespace EndpointAuthorizationsPerClusterLimitExceededFault { + /** + * @internal + */ export const filterSensitiveLog = (obj: EndpointAuthorizationsPerClusterLimitExceededFault): any => ({ ...obj, }); @@ -913,6 +1030,9 @@ export interface InvalidAuthorizationStateFault extends __SmithyException, $Meta } export namespace InvalidAuthorizationStateFault { + /** + * @internal + */ export const filterSensitiveLog = (obj: InvalidAuthorizationStateFault): any => ({ ...obj, }); @@ -928,6 +1048,9 @@ export interface InvalidClusterStateFault extends __SmithyException, $MetadataBe } export namespace InvalidClusterStateFault { + /** + * @internal + */ export const filterSensitiveLog = (obj: InvalidClusterStateFault): any => ({ ...obj, }); @@ -958,6 +1081,9 @@ export interface AuthorizeSnapshotAccessMessage { } export namespace AuthorizeSnapshotAccessMessage { + /** + * @internal + */ export const filterSensitiveLog = (obj: AuthorizeSnapshotAccessMessage): any => ({ ...obj, }); @@ -1178,6 +1304,9 @@ export interface Snapshot { } export namespace Snapshot { + /** + * @internal + */ export const filterSensitiveLog = (obj: Snapshot): any => ({ ...obj, }); @@ -1191,6 +1320,9 @@ export interface AuthorizeSnapshotAccessResult { } export namespace AuthorizeSnapshotAccessResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: AuthorizeSnapshotAccessResult): any => ({ ...obj, }); @@ -1206,6 +1338,9 @@ export interface ClusterSnapshotNotFoundFault extends __SmithyException, $Metada } export namespace ClusterSnapshotNotFoundFault { + /** + * @internal + */ export const filterSensitiveLog = (obj: ClusterSnapshotNotFoundFault): any => ({ ...obj, }); @@ -1222,6 +1357,9 @@ export interface DependentServiceRequestThrottlingFault extends __SmithyExceptio } export namespace DependentServiceRequestThrottlingFault { + /** + * @internal + */ export const filterSensitiveLog = (obj: DependentServiceRequestThrottlingFault): any => ({ ...obj, }); @@ -1238,6 +1376,9 @@ export interface InvalidClusterSnapshotStateFault extends __SmithyException, $Me } export namespace InvalidClusterSnapshotStateFault { + /** + * @internal + */ export const filterSensitiveLog = (obj: InvalidClusterSnapshotStateFault): any => ({ ...obj, }); @@ -1253,6 +1394,9 @@ export interface LimitExceededFault extends __SmithyException, $MetadataBearer { } export namespace LimitExceededFault { + /** + * @internal + */ export const filterSensitiveLog = (obj: LimitExceededFault): any => ({ ...obj, }); @@ -1269,6 +1413,9 @@ export interface SupportedPlatform { } export namespace SupportedPlatform { + /** + * @internal + */ export const filterSensitiveLog = (obj: SupportedPlatform): any => ({ ...obj, }); @@ -1290,6 +1437,9 @@ export interface AvailabilityZone { } export namespace AvailabilityZone { + /** + * @internal + */ export const filterSensitiveLog = (obj: AvailabilityZone): any => ({ ...obj, }); @@ -1317,6 +1467,9 @@ export interface DeleteClusterSnapshotMessage { } export namespace DeleteClusterSnapshotMessage { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteClusterSnapshotMessage): any => ({ ...obj, }); @@ -1330,6 +1483,9 @@ export interface BatchDeleteClusterSnapshotsRequest { } export namespace BatchDeleteClusterSnapshotsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: BatchDeleteClusterSnapshotsRequest): any => ({ ...obj, }); @@ -1361,6 +1517,9 @@ export interface SnapshotErrorMessage { } export namespace SnapshotErrorMessage { + /** + * @internal + */ export const filterSensitiveLog = (obj: SnapshotErrorMessage): any => ({ ...obj, }); @@ -1379,6 +1538,9 @@ export interface BatchDeleteClusterSnapshotsResult { } export namespace BatchDeleteClusterSnapshotsResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: BatchDeleteClusterSnapshotsResult): any => ({ ...obj, }); @@ -1395,6 +1557,9 @@ export interface BatchDeleteRequestSizeExceededFault extends __SmithyException, } export namespace BatchDeleteRequestSizeExceededFault { + /** + * @internal + */ export const filterSensitiveLog = (obj: BatchDeleteRequestSizeExceededFault): any => ({ ...obj, }); @@ -1411,6 +1576,9 @@ export interface BatchModifyClusterSnapshotsLimitExceededFault extends __SmithyE } export namespace BatchModifyClusterSnapshotsLimitExceededFault { + /** + * @internal + */ export const filterSensitiveLog = (obj: BatchModifyClusterSnapshotsLimitExceededFault): any => ({ ...obj, }); @@ -1440,6 +1608,9 @@ export interface BatchModifyClusterSnapshotsMessage { } export namespace BatchModifyClusterSnapshotsMessage { + /** + * @internal + */ export const filterSensitiveLog = (obj: BatchModifyClusterSnapshotsMessage): any => ({ ...obj, }); @@ -1458,6 +1629,9 @@ export interface BatchModifyClusterSnapshotsOutputMessage { } export namespace BatchModifyClusterSnapshotsOutputMessage { + /** + * @internal + */ export const filterSensitiveLog = (obj: BatchModifyClusterSnapshotsOutputMessage): any => ({ ...obj, }); @@ -1474,6 +1648,9 @@ export interface InvalidRetentionPeriodFault extends __SmithyException, $Metadat } export namespace InvalidRetentionPeriodFault { + /** + * @internal + */ export const filterSensitiveLog = (obj: InvalidRetentionPeriodFault): any => ({ ...obj, }); @@ -1489,6 +1666,9 @@ export interface BucketNotFoundFault extends __SmithyException, $MetadataBearer } export namespace BucketNotFoundFault { + /** + * @internal + */ export const filterSensitiveLog = (obj: BucketNotFoundFault): any => ({ ...obj, }); @@ -1503,6 +1683,9 @@ export interface CancelResizeMessage { } export namespace CancelResizeMessage { + /** + * @internal + */ export const filterSensitiveLog = (obj: CancelResizeMessage): any => ({ ...obj, }); @@ -1518,6 +1701,9 @@ export interface ResizeNotFoundFault extends __SmithyException, $MetadataBearer } export namespace ResizeNotFoundFault { + /** + * @internal + */ export const filterSensitiveLog = (obj: ResizeNotFoundFault): any => ({ ...obj, }); @@ -1634,6 +1820,9 @@ export interface ResizeProgressMessage { } export namespace ResizeProgressMessage { + /** + * @internal + */ export const filterSensitiveLog = (obj: ResizeProgressMessage): any => ({ ...obj, }); @@ -1660,6 +1849,9 @@ export interface ClusterNode { } export namespace ClusterNode { + /** + * @internal + */ export const filterSensitiveLog = (obj: ClusterNode): any => ({ ...obj, }); @@ -1727,6 +1919,9 @@ export interface ClusterParameterStatus { } export namespace ClusterParameterStatus { + /** + * @internal + */ export const filterSensitiveLog = (obj: ClusterParameterStatus): any => ({ ...obj, }); @@ -1757,6 +1952,9 @@ export interface ClusterParameterGroupStatus { } export namespace ClusterParameterGroupStatus { + /** + * @internal + */ export const filterSensitiveLog = (obj: ClusterParameterGroupStatus): any => ({ ...obj, }); @@ -1778,6 +1976,9 @@ export interface ClusterSecurityGroupMembership { } export namespace ClusterSecurityGroupMembership { + /** + * @internal + */ export const filterSensitiveLog = (obj: ClusterSecurityGroupMembership): any => ({ ...obj, }); @@ -1815,6 +2016,9 @@ export interface ClusterSnapshotCopyStatus { } export namespace ClusterSnapshotCopyStatus { + /** + * @internal + */ export const filterSensitiveLog = (obj: ClusterSnapshotCopyStatus): any => ({ ...obj, }); @@ -1858,6 +2062,9 @@ export interface DataTransferProgress { } export namespace DataTransferProgress { + /** + * @internal + */ export const filterSensitiveLog = (obj: DataTransferProgress): any => ({ ...obj, }); @@ -1884,6 +2091,9 @@ export interface DeferredMaintenanceWindow { } export namespace DeferredMaintenanceWindow { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeferredMaintenanceWindow): any => ({ ...obj, }); @@ -1905,6 +2115,9 @@ export interface ElasticIpStatus { } export namespace ElasticIpStatus { + /** + * @internal + */ export const filterSensitiveLog = (obj: ElasticIpStatus): any => ({ ...obj, }); @@ -1936,6 +2149,9 @@ export interface NetworkInterface { } export namespace NetworkInterface { + /** + * @internal + */ export const filterSensitiveLog = (obj: NetworkInterface): any => ({ ...obj, }); @@ -1962,6 +2178,9 @@ export interface VpcEndpoint { } export namespace VpcEndpoint { + /** + * @internal + */ export const filterSensitiveLog = (obj: VpcEndpoint): any => ({ ...obj, }); @@ -1988,6 +2207,9 @@ export interface Endpoint { } export namespace Endpoint { + /** + * @internal + */ export const filterSensitiveLog = (obj: Endpoint): any => ({ ...obj, }); @@ -2018,6 +2240,9 @@ export interface HsmStatus { } export namespace HsmStatus { + /** + * @internal + */ export const filterSensitiveLog = (obj: HsmStatus): any => ({ ...obj, }); @@ -2059,6 +2284,9 @@ export interface ClusterIamRole { } export namespace ClusterIamRole { + /** + * @internal + */ export const filterSensitiveLog = (obj: ClusterIamRole): any => ({ ...obj, }); @@ -2135,6 +2363,9 @@ export interface PendingModifiedValues { } export namespace PendingModifiedValues { + /** + * @internal + */ export const filterSensitiveLog = (obj: PendingModifiedValues): any => ({ ...obj, }); @@ -2156,6 +2387,9 @@ export interface ResizeInfo { } export namespace ResizeInfo { + /** + * @internal + */ export const filterSensitiveLog = (obj: ResizeInfo): any => ({ ...obj, }); @@ -2207,6 +2441,9 @@ export interface RestoreStatus { } export namespace RestoreStatus { + /** + * @internal + */ export const filterSensitiveLog = (obj: RestoreStatus): any => ({ ...obj, }); @@ -2228,6 +2465,9 @@ export interface VpcSecurityGroupMembership { } export namespace VpcSecurityGroupMembership { + /** + * @internal + */ export const filterSensitiveLog = (obj: VpcSecurityGroupMembership): any => ({ ...obj, }); @@ -2660,6 +2900,9 @@ export interface Cluster { } export namespace Cluster { + /** + * @internal + */ export const filterSensitiveLog = (obj: Cluster): any => ({ ...obj, }); @@ -2675,6 +2918,9 @@ export interface ClusterAlreadyExistsFault extends __SmithyException, $MetadataB } export namespace ClusterAlreadyExistsFault { + /** + * @internal + */ export const filterSensitiveLog = (obj: ClusterAlreadyExistsFault): any => ({ ...obj, }); @@ -2708,6 +2954,9 @@ export interface ClusterCredentials { } export namespace ClusterCredentials { + /** + * @internal + */ export const filterSensitiveLog = (obj: ClusterCredentials): any => ({ ...obj, ...(obj.DbPassword && { DbPassword: SENSITIVE_STRING }), @@ -2737,6 +2986,9 @@ export interface RevisionTarget { } export namespace RevisionTarget { + /** + * @internal + */ export const filterSensitiveLog = (obj: RevisionTarget): any => ({ ...obj, }); @@ -2769,6 +3021,9 @@ export interface ClusterDbRevision { } export namespace ClusterDbRevision { + /** + * @internal + */ export const filterSensitiveLog = (obj: ClusterDbRevision): any => ({ ...obj, }); @@ -2790,6 +3045,9 @@ export interface ClusterDbRevisionsMessage { } export namespace ClusterDbRevisionsMessage { + /** + * @internal + */ export const filterSensitiveLog = (obj: ClusterDbRevisionsMessage): any => ({ ...obj, }); @@ -2805,6 +3063,9 @@ export interface ClusterOnLatestRevisionFault extends __SmithyException, $Metada } export namespace ClusterOnLatestRevisionFault { + /** + * @internal + */ export const filterSensitiveLog = (obj: ClusterOnLatestRevisionFault): any => ({ ...obj, }); @@ -2837,6 +3098,9 @@ export interface ClusterParameterGroup { } export namespace ClusterParameterGroup { + /** + * @internal + */ export const filterSensitiveLog = (obj: ClusterParameterGroup): any => ({ ...obj, }); @@ -2852,6 +3116,9 @@ export interface ClusterParameterGroupAlreadyExistsFault extends __SmithyExcepti } export namespace ClusterParameterGroupAlreadyExistsFault { + /** + * @internal + */ export const filterSensitiveLog = (obj: ClusterParameterGroupAlreadyExistsFault): any => ({ ...obj, }); @@ -2917,6 +3184,9 @@ export interface Parameter { } export namespace Parameter { + /** + * @internal + */ export const filterSensitiveLog = (obj: Parameter): any => ({ ...obj, }); @@ -2944,6 +3214,9 @@ export interface ClusterParameterGroupDetails { } export namespace ClusterParameterGroupDetails { + /** + * @internal + */ export const filterSensitiveLog = (obj: ClusterParameterGroupDetails): any => ({ ...obj, }); @@ -2967,6 +3240,9 @@ export interface ClusterParameterGroupNameMessage { } export namespace ClusterParameterGroupNameMessage { + /** + * @internal + */ export const filterSensitiveLog = (obj: ClusterParameterGroupNameMessage): any => ({ ...obj, }); @@ -2982,6 +3258,9 @@ export interface ClusterParameterGroupNotFoundFault extends __SmithyException, $ } export namespace ClusterParameterGroupNotFoundFault { + /** + * @internal + */ export const filterSensitiveLog = (obj: ClusterParameterGroupNotFoundFault): any => ({ ...obj, }); @@ -3001,6 +3280,9 @@ export interface ClusterParameterGroupQuotaExceededFault extends __SmithyExcepti } export namespace ClusterParameterGroupQuotaExceededFault { + /** + * @internal + */ export const filterSensitiveLog = (obj: ClusterParameterGroupQuotaExceededFault): any => ({ ...obj, }); @@ -3028,6 +3310,9 @@ export interface ClusterParameterGroupsMessage { } export namespace ClusterParameterGroupsMessage { + /** + * @internal + */ export const filterSensitiveLog = (obj: ClusterParameterGroupsMessage): any => ({ ...obj, }); @@ -3047,6 +3332,9 @@ export interface ClusterQuotaExceededFault extends __SmithyException, $MetadataB } export namespace ClusterQuotaExceededFault { + /** + * @internal + */ export const filterSensitiveLog = (obj: ClusterQuotaExceededFault): any => ({ ...obj, }); @@ -3062,6 +3350,9 @@ export interface ClusterSecurityGroupAlreadyExistsFault extends __SmithyExceptio } export namespace ClusterSecurityGroupAlreadyExistsFault { + /** + * @internal + */ export const filterSensitiveLog = (obj: ClusterSecurityGroupAlreadyExistsFault): any => ({ ...obj, }); @@ -3087,6 +3378,9 @@ export interface ClusterSecurityGroupMessage { } export namespace ClusterSecurityGroupMessage { + /** + * @internal + */ export const filterSensitiveLog = (obj: ClusterSecurityGroupMessage): any => ({ ...obj, }); @@ -3106,6 +3400,9 @@ export interface ClusterSecurityGroupQuotaExceededFault extends __SmithyExceptio } export namespace ClusterSecurityGroupQuotaExceededFault { + /** + * @internal + */ export const filterSensitiveLog = (obj: ClusterSecurityGroupQuotaExceededFault): any => ({ ...obj, }); @@ -3132,6 +3429,9 @@ export interface ClustersMessage { } export namespace ClustersMessage { + /** + * @internal + */ export const filterSensitiveLog = (obj: ClustersMessage): any => ({ ...obj, }); @@ -3148,6 +3448,9 @@ export interface ClusterSnapshotAlreadyExistsFault extends __SmithyException, $M } export namespace ClusterSnapshotAlreadyExistsFault { + /** + * @internal + */ export const filterSensitiveLog = (obj: ClusterSnapshotAlreadyExistsFault): any => ({ ...obj, }); @@ -3164,6 +3467,9 @@ export interface ClusterSnapshotQuotaExceededFault extends __SmithyException, $M } export namespace ClusterSnapshotQuotaExceededFault { + /** + * @internal + */ export const filterSensitiveLog = (obj: ClusterSnapshotQuotaExceededFault): any => ({ ...obj, }); @@ -3190,6 +3496,9 @@ export interface Subnet { } export namespace Subnet { + /** + * @internal + */ export const filterSensitiveLog = (obj: Subnet): any => ({ ...obj, }); @@ -3232,6 +3541,9 @@ export interface ClusterSubnetGroup { } export namespace ClusterSubnetGroup { + /** + * @internal + */ export const filterSensitiveLog = (obj: ClusterSubnetGroup): any => ({ ...obj, }); @@ -3248,6 +3560,9 @@ export interface ClusterSubnetGroupAlreadyExistsFault extends __SmithyException, } export namespace ClusterSubnetGroupAlreadyExistsFault { + /** + * @internal + */ export const filterSensitiveLog = (obj: ClusterSubnetGroupAlreadyExistsFault): any => ({ ...obj, }); @@ -3274,6 +3589,9 @@ export interface ClusterSubnetGroupMessage { } export namespace ClusterSubnetGroupMessage { + /** + * @internal + */ export const filterSensitiveLog = (obj: ClusterSubnetGroupMessage): any => ({ ...obj, }); @@ -3290,6 +3608,9 @@ export interface ClusterSubnetGroupNotFoundFault extends __SmithyException, $Met } export namespace ClusterSubnetGroupNotFoundFault { + /** + * @internal + */ export const filterSensitiveLog = (obj: ClusterSubnetGroupNotFoundFault): any => ({ ...obj, }); @@ -3309,6 +3630,9 @@ export interface ClusterSubnetGroupQuotaExceededFault extends __SmithyException, } export namespace ClusterSubnetGroupQuotaExceededFault { + /** + * @internal + */ export const filterSensitiveLog = (obj: ClusterSubnetGroupQuotaExceededFault): any => ({ ...obj, }); @@ -3328,6 +3652,9 @@ export interface ClusterSubnetQuotaExceededFault extends __SmithyException, $Met } export namespace ClusterSubnetQuotaExceededFault { + /** + * @internal + */ export const filterSensitiveLog = (obj: ClusterSubnetQuotaExceededFault): any => ({ ...obj, }); @@ -3355,6 +3682,9 @@ export interface ClusterVersion { } export namespace ClusterVersion { + /** + * @internal + */ export const filterSensitiveLog = (obj: ClusterVersion): any => ({ ...obj, }); @@ -3381,6 +3711,9 @@ export interface ClusterVersionsMessage { } export namespace ClusterVersionsMessage { + /** + * @internal + */ export const filterSensitiveLog = (obj: ClusterVersionsMessage): any => ({ ...obj, }); @@ -3448,6 +3781,9 @@ export interface CopyClusterSnapshotMessage { } export namespace CopyClusterSnapshotMessage { + /** + * @internal + */ export const filterSensitiveLog = (obj: CopyClusterSnapshotMessage): any => ({ ...obj, }); @@ -3461,6 +3797,9 @@ export interface CopyClusterSnapshotResult { } export namespace CopyClusterSnapshotResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: CopyClusterSnapshotResult): any => ({ ...obj, }); @@ -3477,6 +3816,9 @@ export interface CopyToRegionDisabledFault extends __SmithyException, $MetadataB } export namespace CopyToRegionDisabledFault { + /** + * @internal + */ export const filterSensitiveLog = (obj: CopyToRegionDisabledFault): any => ({ ...obj, }); @@ -3856,6 +4198,9 @@ export interface CreateClusterMessage { } export namespace CreateClusterMessage { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateClusterMessage): any => ({ ...obj, }); @@ -3869,6 +4214,9 @@ export interface CreateClusterResult { } export namespace CreateClusterResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateClusterResult): any => ({ ...obj, }); @@ -3885,6 +4233,9 @@ export interface HsmClientCertificateNotFoundFault extends __SmithyException, $M } export namespace HsmClientCertificateNotFoundFault { + /** + * @internal + */ export const filterSensitiveLog = (obj: HsmClientCertificateNotFoundFault): any => ({ ...obj, }); @@ -3900,6 +4251,9 @@ export interface HsmConfigurationNotFoundFault extends __SmithyException, $Metad } export namespace HsmConfigurationNotFoundFault { + /** + * @internal + */ export const filterSensitiveLog = (obj: HsmConfigurationNotFoundFault): any => ({ ...obj, }); @@ -3916,6 +4270,9 @@ export interface InsufficientClusterCapacityFault extends __SmithyException, $Me } export namespace InsufficientClusterCapacityFault { + /** + * @internal + */ export const filterSensitiveLog = (obj: InsufficientClusterCapacityFault): any => ({ ...obj, }); @@ -3931,6 +4288,9 @@ export interface InvalidClusterSubnetGroupStateFault extends __SmithyException, } export namespace InvalidClusterSubnetGroupStateFault { + /** + * @internal + */ export const filterSensitiveLog = (obj: InvalidClusterSubnetGroupStateFault): any => ({ ...obj, }); @@ -3946,6 +4306,9 @@ export interface InvalidClusterTrackFault extends __SmithyException, $MetadataBe } export namespace InvalidClusterTrackFault { + /** + * @internal + */ export const filterSensitiveLog = (obj: InvalidClusterTrackFault): any => ({ ...obj, }); @@ -3961,6 +4324,9 @@ export interface InvalidElasticIpFault extends __SmithyException, $MetadataBeare } export namespace InvalidElasticIpFault { + /** + * @internal + */ export const filterSensitiveLog = (obj: InvalidElasticIpFault): any => ({ ...obj, }); @@ -3977,6 +4343,9 @@ export interface InvalidSubnet extends __SmithyException, $MetadataBearer { } export namespace InvalidSubnet { + /** + * @internal + */ export const filterSensitiveLog = (obj: InvalidSubnet): any => ({ ...obj, }); @@ -3992,6 +4361,9 @@ export interface InvalidTagFault extends __SmithyException, $MetadataBearer { } export namespace InvalidTagFault { + /** + * @internal + */ export const filterSensitiveLog = (obj: InvalidTagFault): any => ({ ...obj, }); @@ -4007,6 +4379,9 @@ export interface InvalidVPCNetworkStateFault extends __SmithyException, $Metadat } export namespace InvalidVPCNetworkStateFault { + /** + * @internal + */ export const filterSensitiveLog = (obj: InvalidVPCNetworkStateFault): any => ({ ...obj, }); @@ -4022,6 +4397,9 @@ export interface NumberOfNodesPerClusterLimitExceededFault extends __SmithyExcep } export namespace NumberOfNodesPerClusterLimitExceededFault { + /** + * @internal + */ export const filterSensitiveLog = (obj: NumberOfNodesPerClusterLimitExceededFault): any => ({ ...obj, }); @@ -4041,6 +4419,9 @@ export interface NumberOfNodesQuotaExceededFault extends __SmithyException, $Met } export namespace NumberOfNodesQuotaExceededFault { + /** + * @internal + */ export const filterSensitiveLog = (obj: NumberOfNodesQuotaExceededFault): any => ({ ...obj, }); @@ -4056,6 +4437,9 @@ export interface SnapshotScheduleNotFoundFault extends __SmithyException, $Metad } export namespace SnapshotScheduleNotFoundFault { + /** + * @internal + */ export const filterSensitiveLog = (obj: SnapshotScheduleNotFoundFault): any => ({ ...obj, }); @@ -4071,6 +4455,9 @@ export interface TagLimitExceededFault extends __SmithyException, $MetadataBeare } export namespace TagLimitExceededFault { + /** + * @internal + */ export const filterSensitiveLog = (obj: TagLimitExceededFault): any => ({ ...obj, }); @@ -4086,6 +4473,9 @@ export interface UnauthorizedOperation extends __SmithyException, $MetadataBeare } export namespace UnauthorizedOperation { + /** + * @internal + */ export const filterSensitiveLog = (obj: UnauthorizedOperation): any => ({ ...obj, }); @@ -4141,6 +4531,9 @@ export interface CreateClusterParameterGroupMessage { } export namespace CreateClusterParameterGroupMessage { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateClusterParameterGroupMessage): any => ({ ...obj, }); @@ -4154,6 +4547,9 @@ export interface CreateClusterParameterGroupResult { } export namespace CreateClusterParameterGroupResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateClusterParameterGroupResult): any => ({ ...obj, }); @@ -4196,6 +4592,9 @@ export interface CreateClusterSecurityGroupMessage { } export namespace CreateClusterSecurityGroupMessage { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateClusterSecurityGroupMessage): any => ({ ...obj, }); @@ -4209,6 +4608,9 @@ export interface CreateClusterSecurityGroupResult { } export namespace CreateClusterSecurityGroupResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateClusterSecurityGroupResult): any => ({ ...obj, }); @@ -4263,6 +4665,9 @@ export interface CreateClusterSnapshotMessage { } export namespace CreateClusterSnapshotMessage { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateClusterSnapshotMessage): any => ({ ...obj, }); @@ -4276,6 +4681,9 @@ export interface CreateClusterSnapshotResult { } export namespace CreateClusterSnapshotResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateClusterSnapshotResult): any => ({ ...obj, }); @@ -4324,6 +4732,9 @@ export interface CreateClusterSubnetGroupMessage { } export namespace CreateClusterSubnetGroupMessage { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateClusterSubnetGroupMessage): any => ({ ...obj, }); @@ -4337,6 +4748,9 @@ export interface CreateClusterSubnetGroupResult { } export namespace CreateClusterSubnetGroupResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateClusterSubnetGroupResult): any => ({ ...obj, }); @@ -4374,6 +4788,9 @@ export interface CreateEndpointAccessMessage { } export namespace CreateEndpointAccessMessage { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateEndpointAccessMessage): any => ({ ...obj, }); @@ -4435,6 +4852,9 @@ export interface EndpointAccess { } export namespace EndpointAccess { + /** + * @internal + */ export const filterSensitiveLog = (obj: EndpointAccess): any => ({ ...obj, }); @@ -4450,6 +4870,9 @@ export interface EndpointAlreadyExistsFault extends __SmithyException, $Metadata } export namespace EndpointAlreadyExistsFault { + /** + * @internal + */ export const filterSensitiveLog = (obj: EndpointAlreadyExistsFault): any => ({ ...obj, }); @@ -4465,6 +4888,9 @@ export interface EndpointsPerAuthorizationLimitExceededFault extends __SmithyExc } export namespace EndpointsPerAuthorizationLimitExceededFault { + /** + * @internal + */ export const filterSensitiveLog = (obj: EndpointsPerAuthorizationLimitExceededFault): any => ({ ...obj, }); @@ -4480,6 +4906,9 @@ export interface EndpointsPerClusterLimitExceededFault extends __SmithyException } export namespace EndpointsPerClusterLimitExceededFault { + /** + * @internal + */ export const filterSensitiveLog = (obj: EndpointsPerClusterLimitExceededFault): any => ({ ...obj, }); @@ -4563,6 +4992,9 @@ export interface CreateEventSubscriptionMessage { } export namespace CreateEventSubscriptionMessage { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateEventSubscriptionMessage): any => ({ ...obj, }); @@ -4652,6 +5084,9 @@ export interface EventSubscription { } export namespace EventSubscription { + /** + * @internal + */ export const filterSensitiveLog = (obj: EventSubscription): any => ({ ...obj, }); @@ -4665,6 +5100,9 @@ export interface CreateEventSubscriptionResult { } export namespace CreateEventSubscriptionResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateEventSubscriptionResult): any => ({ ...obj, }); @@ -4684,6 +5122,9 @@ export interface EventSubscriptionQuotaExceededFault extends __SmithyException, } export namespace EventSubscriptionQuotaExceededFault { + /** + * @internal + */ export const filterSensitiveLog = (obj: EventSubscriptionQuotaExceededFault): any => ({ ...obj, }); @@ -4700,6 +5141,9 @@ export interface SNSInvalidTopicFault extends __SmithyException, $MetadataBearer } export namespace SNSInvalidTopicFault { + /** + * @internal + */ export const filterSensitiveLog = (obj: SNSInvalidTopicFault): any => ({ ...obj, }); @@ -4715,6 +5159,9 @@ export interface SNSNoAuthorizationFault extends __SmithyException, $MetadataBea } export namespace SNSNoAuthorizationFault { + /** + * @internal + */ export const filterSensitiveLog = (obj: SNSNoAuthorizationFault): any => ({ ...obj, }); @@ -4731,6 +5178,9 @@ export interface SNSTopicArnNotFoundFault extends __SmithyException, $MetadataBe } export namespace SNSTopicArnNotFoundFault { + /** + * @internal + */ export const filterSensitiveLog = (obj: SNSTopicArnNotFoundFault): any => ({ ...obj, }); @@ -4746,6 +5196,9 @@ export interface SourceNotFoundFault extends __SmithyException, $MetadataBearer } export namespace SourceNotFoundFault { + /** + * @internal + */ export const filterSensitiveLog = (obj: SourceNotFoundFault): any => ({ ...obj, }); @@ -4762,6 +5215,9 @@ export interface SubscriptionAlreadyExistFault extends __SmithyException, $Metad } export namespace SubscriptionAlreadyExistFault { + /** + * @internal + */ export const filterSensitiveLog = (obj: SubscriptionAlreadyExistFault): any => ({ ...obj, }); @@ -4779,6 +5235,9 @@ export interface SubscriptionCategoryNotFoundFault extends __SmithyException, $M } export namespace SubscriptionCategoryNotFoundFault { + /** + * @internal + */ export const filterSensitiveLog = (obj: SubscriptionCategoryNotFoundFault): any => ({ ...obj, }); @@ -4794,6 +5253,9 @@ export interface SubscriptionEventIdNotFoundFault extends __SmithyException, $Me } export namespace SubscriptionEventIdNotFoundFault { + /** + * @internal + */ export const filterSensitiveLog = (obj: SubscriptionEventIdNotFoundFault): any => ({ ...obj, }); @@ -4811,6 +5273,9 @@ export interface SubscriptionSeverityNotFoundFault extends __SmithyException, $M } export namespace SubscriptionSeverityNotFoundFault { + /** + * @internal + */ export const filterSensitiveLog = (obj: SubscriptionSeverityNotFoundFault): any => ({ ...obj, }); @@ -4833,6 +5298,9 @@ export interface CreateHsmClientCertificateMessage { } export namespace CreateHsmClientCertificateMessage { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateHsmClientCertificateMessage): any => ({ ...obj, }); @@ -4862,6 +5330,9 @@ export interface HsmClientCertificate { } export namespace HsmClientCertificate { + /** + * @internal + */ export const filterSensitiveLog = (obj: HsmClientCertificate): any => ({ ...obj, }); @@ -4877,6 +5348,9 @@ export interface CreateHsmClientCertificateResult { } export namespace CreateHsmClientCertificateResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateHsmClientCertificateResult): any => ({ ...obj, }); @@ -4893,6 +5367,9 @@ export interface HsmClientCertificateAlreadyExistsFault extends __SmithyExceptio } export namespace HsmClientCertificateAlreadyExistsFault { + /** + * @internal + */ export const filterSensitiveLog = (obj: HsmClientCertificateAlreadyExistsFault): any => ({ ...obj, }); @@ -4911,6 +5388,9 @@ export interface HsmClientCertificateQuotaExceededFault extends __SmithyExceptio } export namespace HsmClientCertificateQuotaExceededFault { + /** + * @internal + */ export const filterSensitiveLog = (obj: HsmClientCertificateQuotaExceededFault): any => ({ ...obj, }); @@ -4959,6 +5439,9 @@ export interface CreateHsmConfigurationMessage { } export namespace CreateHsmConfigurationMessage { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateHsmConfigurationMessage): any => ({ ...obj, }); @@ -4998,6 +5481,9 @@ export interface HsmConfiguration { } export namespace HsmConfiguration { + /** + * @internal + */ export const filterSensitiveLog = (obj: HsmConfiguration): any => ({ ...obj, }); @@ -5013,6 +5499,9 @@ export interface CreateHsmConfigurationResult { } export namespace CreateHsmConfigurationResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateHsmConfigurationResult): any => ({ ...obj, }); @@ -5029,6 +5518,9 @@ export interface HsmConfigurationAlreadyExistsFault extends __SmithyException, $ } export namespace HsmConfigurationAlreadyExistsFault { + /** + * @internal + */ export const filterSensitiveLog = (obj: HsmConfigurationAlreadyExistsFault): any => ({ ...obj, }); @@ -5047,6 +5539,9 @@ export interface HsmConfigurationQuotaExceededFault extends __SmithyException, $ } export namespace HsmConfigurationQuotaExceededFault { + /** + * @internal + */ export const filterSensitiveLog = (obj: HsmConfigurationQuotaExceededFault): any => ({ ...obj, }); @@ -5063,6 +5558,9 @@ export interface PauseClusterMessage { } export namespace PauseClusterMessage { + /** + * @internal + */ export const filterSensitiveLog = (obj: PauseClusterMessage): any => ({ ...obj, }); @@ -5101,6 +5599,9 @@ export interface ResizeClusterMessage { } export namespace ResizeClusterMessage { + /** + * @internal + */ export const filterSensitiveLog = (obj: ResizeClusterMessage): any => ({ ...obj, }); @@ -5117,6 +5618,9 @@ export interface ResumeClusterMessage { } export namespace ResumeClusterMessage { + /** + * @internal + */ export const filterSensitiveLog = (obj: ResumeClusterMessage): any => ({ ...obj, }); @@ -5143,6 +5647,9 @@ export interface ScheduledActionType { } export namespace ScheduledActionType { + /** + * @internal + */ export const filterSensitiveLog = (obj: ScheduledActionType): any => ({ ...obj, }); @@ -5200,6 +5707,9 @@ export interface CreateScheduledActionMessage { } export namespace CreateScheduledActionMessage { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateScheduledActionMessage): any => ({ ...obj, }); @@ -5215,6 +5725,9 @@ export interface InvalidScheduledActionFault extends __SmithyException, $Metadat } export namespace InvalidScheduledActionFault { + /** + * @internal + */ export const filterSensitiveLog = (obj: InvalidScheduledActionFault): any => ({ ...obj, }); @@ -5230,6 +5743,9 @@ export interface InvalidScheduleFault extends __SmithyException, $MetadataBearer } export namespace InvalidScheduleFault { + /** + * @internal + */ export const filterSensitiveLog = (obj: InvalidScheduleFault): any => ({ ...obj, }); @@ -5306,6 +5822,9 @@ export interface ScheduledAction { } export namespace ScheduledAction { + /** + * @internal + */ export const filterSensitiveLog = (obj: ScheduledAction): any => ({ ...obj, }); @@ -5321,6 +5840,9 @@ export interface ScheduledActionAlreadyExistsFault extends __SmithyException, $M } export namespace ScheduledActionAlreadyExistsFault { + /** + * @internal + */ export const filterSensitiveLog = (obj: ScheduledActionAlreadyExistsFault): any => ({ ...obj, }); @@ -5336,6 +5858,9 @@ export interface ScheduledActionQuotaExceededFault extends __SmithyException, $M } export namespace ScheduledActionQuotaExceededFault { + /** + * @internal + */ export const filterSensitiveLog = (obj: ScheduledActionQuotaExceededFault): any => ({ ...obj, }); @@ -5351,6 +5876,9 @@ export interface ScheduledActionTypeUnsupportedFault extends __SmithyException, } export namespace ScheduledActionTypeUnsupportedFault { + /** + * @internal + */ export const filterSensitiveLog = (obj: ScheduledActionTypeUnsupportedFault): any => ({ ...obj, }); @@ -5397,6 +5925,9 @@ export interface CreateSnapshotCopyGrantMessage { } export namespace CreateSnapshotCopyGrantMessage { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateSnapshotCopyGrantMessage): any => ({ ...obj, }); @@ -5431,6 +5962,9 @@ export interface SnapshotCopyGrant { } export namespace SnapshotCopyGrant { + /** + * @internal + */ export const filterSensitiveLog = (obj: SnapshotCopyGrant): any => ({ ...obj, }); @@ -5451,6 +5985,9 @@ export interface CreateSnapshotCopyGrantResult { } export namespace CreateSnapshotCopyGrantResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateSnapshotCopyGrantResult): any => ({ ...obj, }); @@ -5467,6 +6004,9 @@ export interface SnapshotCopyGrantAlreadyExistsFault extends __SmithyException, } export namespace SnapshotCopyGrantAlreadyExistsFault { + /** + * @internal + */ export const filterSensitiveLog = (obj: SnapshotCopyGrantAlreadyExistsFault): any => ({ ...obj, }); @@ -5483,6 +6023,9 @@ export interface SnapshotCopyGrantQuotaExceededFault extends __SmithyException, } export namespace SnapshotCopyGrantQuotaExceededFault { + /** + * @internal + */ export const filterSensitiveLog = (obj: SnapshotCopyGrantQuotaExceededFault): any => ({ ...obj, }); @@ -5523,6 +6066,9 @@ export interface CreateSnapshotScheduleMessage { } export namespace CreateSnapshotScheduleMessage { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateSnapshotScheduleMessage): any => ({ ...obj, }); @@ -5538,6 +6084,9 @@ export interface ScheduleDefinitionTypeUnsupportedFault extends __SmithyExceptio } export namespace ScheduleDefinitionTypeUnsupportedFault { + /** + * @internal + */ export const filterSensitiveLog = (obj: ScheduleDefinitionTypeUnsupportedFault): any => ({ ...obj, }); @@ -5585,6 +6134,9 @@ export interface SnapshotSchedule { } export namespace SnapshotSchedule { + /** + * @internal + */ export const filterSensitiveLog = (obj: SnapshotSchedule): any => ({ ...obj, }); @@ -5600,6 +6152,9 @@ export interface SnapshotScheduleAlreadyExistsFault extends __SmithyException, $ } export namespace SnapshotScheduleAlreadyExistsFault { + /** + * @internal + */ export const filterSensitiveLog = (obj: SnapshotScheduleAlreadyExistsFault): any => ({ ...obj, }); @@ -5615,6 +6170,9 @@ export interface SnapshotScheduleQuotaExceededFault extends __SmithyException, $ } export namespace SnapshotScheduleQuotaExceededFault { + /** + * @internal + */ export const filterSensitiveLog = (obj: SnapshotScheduleQuotaExceededFault): any => ({ ...obj, }); @@ -5642,6 +6200,9 @@ export interface CreateTagsMessage { } export namespace CreateTagsMessage { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateTagsMessage): any => ({ ...obj, }); @@ -5657,6 +6218,9 @@ export interface ResourceNotFoundFault extends __SmithyException, $MetadataBeare } export namespace ResourceNotFoundFault { + /** + * @internal + */ export const filterSensitiveLog = (obj: ResourceNotFoundFault): any => ({ ...obj, }); @@ -5729,6 +6293,9 @@ export interface CreateUsageLimitMessage { } export namespace CreateUsageLimitMessage { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateUsageLimitMessage): any => ({ ...obj, }); @@ -5744,6 +6311,9 @@ export interface InvalidUsageLimitFault extends __SmithyException, $MetadataBear } export namespace InvalidUsageLimitFault { + /** + * @internal + */ export const filterSensitiveLog = (obj: InvalidUsageLimitFault): any => ({ ...obj, }); @@ -5809,6 +6379,9 @@ export interface UsageLimit { } export namespace UsageLimit { + /** + * @internal + */ export const filterSensitiveLog = (obj: UsageLimit): any => ({ ...obj, }); @@ -5824,6 +6397,9 @@ export interface UsageLimitAlreadyExistsFault extends __SmithyException, $Metada } export namespace UsageLimitAlreadyExistsFault { + /** + * @internal + */ export const filterSensitiveLog = (obj: UsageLimitAlreadyExistsFault): any => ({ ...obj, }); @@ -5842,6 +6418,9 @@ export interface CustomerStorageMessage { } export namespace CustomerStorageMessage { + /** + * @internal + */ export const filterSensitiveLog = (obj: CustomerStorageMessage): any => ({ ...obj, }); @@ -5873,6 +6452,9 @@ export interface DefaultClusterParameters { } export namespace DefaultClusterParameters { + /** + * @internal + */ export const filterSensitiveLog = (obj: DefaultClusterParameters): any => ({ ...obj, }); @@ -5946,6 +6528,9 @@ export interface DeleteClusterMessage { } export namespace DeleteClusterMessage { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteClusterMessage): any => ({ ...obj, }); @@ -5959,6 +6544,9 @@ export interface DeleteClusterResult { } export namespace DeleteClusterResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteClusterResult): any => ({ ...obj, }); @@ -5984,6 +6572,9 @@ export interface DeleteClusterParameterGroupMessage { } export namespace DeleteClusterParameterGroupMessage { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteClusterParameterGroupMessage): any => ({ ...obj, }); @@ -6001,6 +6592,9 @@ export interface InvalidClusterParameterGroupStateFault extends __SmithyExceptio } export namespace InvalidClusterParameterGroupStateFault { + /** + * @internal + */ export const filterSensitiveLog = (obj: InvalidClusterParameterGroupStateFault): any => ({ ...obj, }); @@ -6017,6 +6611,9 @@ export interface DeleteClusterSecurityGroupMessage { } export namespace DeleteClusterSecurityGroupMessage { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteClusterSecurityGroupMessage): any => ({ ...obj, }); @@ -6030,6 +6627,9 @@ export interface DeleteClusterSnapshotResult { } export namespace DeleteClusterSnapshotResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteClusterSnapshotResult): any => ({ ...obj, }); @@ -6046,6 +6646,9 @@ export interface DeleteClusterSubnetGroupMessage { } export namespace DeleteClusterSubnetGroupMessage { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteClusterSubnetGroupMessage): any => ({ ...obj, }); @@ -6061,6 +6664,9 @@ export interface InvalidClusterSubnetStateFault extends __SmithyException, $Meta } export namespace InvalidClusterSubnetStateFault { + /** + * @internal + */ export const filterSensitiveLog = (obj: InvalidClusterSubnetStateFault): any => ({ ...obj, }); @@ -6074,6 +6680,9 @@ export interface DeleteEndpointAccessMessage { } export namespace DeleteEndpointAccessMessage { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteEndpointAccessMessage): any => ({ ...obj, }); @@ -6089,6 +6698,9 @@ export interface EndpointNotFoundFault extends __SmithyException, $MetadataBeare } export namespace EndpointNotFoundFault { + /** + * @internal + */ export const filterSensitiveLog = (obj: EndpointNotFoundFault): any => ({ ...obj, }); @@ -6104,6 +6716,9 @@ export interface InvalidEndpointStateFault extends __SmithyException, $MetadataB } export namespace InvalidEndpointStateFault { + /** + * @internal + */ export const filterSensitiveLog = (obj: InvalidEndpointStateFault): any => ({ ...obj, }); @@ -6120,6 +6735,9 @@ export interface DeleteEventSubscriptionMessage { } export namespace DeleteEventSubscriptionMessage { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteEventSubscriptionMessage): any => ({ ...obj, }); @@ -6136,6 +6754,9 @@ export interface InvalidSubscriptionStateFault extends __SmithyException, $Metad } export namespace InvalidSubscriptionStateFault { + /** + * @internal + */ export const filterSensitiveLog = (obj: InvalidSubscriptionStateFault): any => ({ ...obj, }); @@ -6152,6 +6773,9 @@ export interface SubscriptionNotFoundFault extends __SmithyException, $MetadataB } export namespace SubscriptionNotFoundFault { + /** + * @internal + */ export const filterSensitiveLog = (obj: SubscriptionNotFoundFault): any => ({ ...obj, }); @@ -6168,6 +6792,9 @@ export interface DeleteHsmClientCertificateMessage { } export namespace DeleteHsmClientCertificateMessage { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteHsmClientCertificateMessage): any => ({ ...obj, }); @@ -6184,6 +6811,9 @@ export interface InvalidHsmClientCertificateStateFault extends __SmithyException } export namespace InvalidHsmClientCertificateStateFault { + /** + * @internal + */ export const filterSensitiveLog = (obj: InvalidHsmClientCertificateStateFault): any => ({ ...obj, }); @@ -6200,6 +6830,9 @@ export interface DeleteHsmConfigurationMessage { } export namespace DeleteHsmConfigurationMessage { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteHsmConfigurationMessage): any => ({ ...obj, }); @@ -6216,6 +6849,9 @@ export interface InvalidHsmConfigurationStateFault extends __SmithyException, $M } export namespace InvalidHsmConfigurationStateFault { + /** + * @internal + */ export const filterSensitiveLog = (obj: InvalidHsmConfigurationStateFault): any => ({ ...obj, }); @@ -6229,6 +6865,9 @@ export interface DeleteScheduledActionMessage { } export namespace DeleteScheduledActionMessage { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteScheduledActionMessage): any => ({ ...obj, }); @@ -6244,6 +6883,9 @@ export interface ScheduledActionNotFoundFault extends __SmithyException, $Metada } export namespace ScheduledActionNotFoundFault { + /** + * @internal + */ export const filterSensitiveLog = (obj: ScheduledActionNotFoundFault): any => ({ ...obj, }); @@ -6260,6 +6902,9 @@ export interface DeleteSnapshotCopyGrantMessage { } export namespace DeleteSnapshotCopyGrantMessage { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteSnapshotCopyGrantMessage): any => ({ ...obj, }); @@ -6276,6 +6921,9 @@ export interface InvalidSnapshotCopyGrantStateFault extends __SmithyException, $ } export namespace InvalidSnapshotCopyGrantStateFault { + /** + * @internal + */ export const filterSensitiveLog = (obj: InvalidSnapshotCopyGrantStateFault): any => ({ ...obj, }); @@ -6292,6 +6940,9 @@ export interface SnapshotCopyGrantNotFoundFault extends __SmithyException, $Meta } export namespace SnapshotCopyGrantNotFoundFault { + /** + * @internal + */ export const filterSensitiveLog = (obj: SnapshotCopyGrantNotFoundFault): any => ({ ...obj, }); @@ -6305,6 +6956,9 @@ export interface DeleteSnapshotScheduleMessage { } export namespace DeleteSnapshotScheduleMessage { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteSnapshotScheduleMessage): any => ({ ...obj, }); @@ -6320,6 +6974,9 @@ export interface InvalidClusterSnapshotScheduleStateFault extends __SmithyExcept } export namespace InvalidClusterSnapshotScheduleStateFault { + /** + * @internal + */ export const filterSensitiveLog = (obj: InvalidClusterSnapshotScheduleStateFault): any => ({ ...obj, }); @@ -6342,6 +6999,9 @@ export interface DeleteTagsMessage { } export namespace DeleteTagsMessage { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteTagsMessage): any => ({ ...obj, }); @@ -6355,6 +7015,9 @@ export interface DeleteUsageLimitMessage { } export namespace DeleteUsageLimitMessage { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteUsageLimitMessage): any => ({ ...obj, }); @@ -6370,6 +7033,9 @@ export interface UsageLimitNotFoundFault extends __SmithyException, $MetadataBea } export namespace UsageLimitNotFoundFault { + /** + * @internal + */ export const filterSensitiveLog = (obj: UsageLimitNotFoundFault): any => ({ ...obj, }); @@ -6383,6 +7049,9 @@ export interface DescribeAccountAttributesMessage { } export namespace DescribeAccountAttributesMessage { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeAccountAttributesMessage): any => ({ ...obj, }); @@ -6421,6 +7090,9 @@ export interface DescribeClusterDbRevisionsMessage { } export namespace DescribeClusterDbRevisionsMessage { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeClusterDbRevisionsMessage): any => ({ ...obj, }); @@ -6480,6 +7152,9 @@ export interface DescribeClusterParameterGroupsMessage { } export namespace DescribeClusterParameterGroupsMessage { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeClusterParameterGroupsMessage): any => ({ ...obj, }); @@ -6527,6 +7202,9 @@ export interface DescribeClusterParametersMessage { } export namespace DescribeClusterParametersMessage { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeClusterParametersMessage): any => ({ ...obj, }); @@ -6586,6 +7264,9 @@ export interface DescribeClustersMessage { } export namespace DescribeClustersMessage { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeClustersMessage): any => ({ ...obj, }); @@ -6647,6 +7328,9 @@ export interface DescribeClusterSecurityGroupsMessage { } export namespace DescribeClusterSecurityGroupsMessage { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeClusterSecurityGroupsMessage): any => ({ ...obj, }); @@ -6679,6 +7363,9 @@ export interface SnapshotSortingEntity { } export namespace SnapshotSortingEntity { + /** + * @internal + */ export const filterSensitiveLog = (obj: SnapshotSortingEntity): any => ({ ...obj, }); @@ -6812,6 +7499,9 @@ export interface DescribeClusterSnapshotsMessage { } export namespace DescribeClusterSnapshotsMessage { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeClusterSnapshotsMessage): any => ({ ...obj, }); @@ -6838,6 +7528,9 @@ export interface SnapshotMessage { } export namespace SnapshotMessage { + /** + * @internal + */ export const filterSensitiveLog = (obj: SnapshotMessage): any => ({ ...obj, }); @@ -6895,6 +7588,9 @@ export interface DescribeClusterSubnetGroupsMessage { } export namespace DescribeClusterSubnetGroupsMessage { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeClusterSubnetGroupsMessage): any => ({ ...obj, }); @@ -6923,6 +7619,9 @@ export interface DescribeClusterTracksMessage { } export namespace DescribeClusterTracksMessage { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeClusterTracksMessage): any => ({ ...obj, }); @@ -6939,6 +7638,9 @@ export interface SupportedOperation { } export namespace SupportedOperation { + /** + * @internal + */ export const filterSensitiveLog = (obj: SupportedOperation): any => ({ ...obj, }); @@ -6965,6 +7667,9 @@ export interface UpdateTarget { } export namespace UpdateTarget { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateTarget): any => ({ ...obj, }); @@ -6997,6 +7702,9 @@ export interface MaintenanceTrack { } export namespace MaintenanceTrack { + /** + * @internal + */ export const filterSensitiveLog = (obj: MaintenanceTrack): any => ({ ...obj, }); @@ -7018,6 +7726,9 @@ export interface TrackListMessage { } export namespace TrackListMessage { + /** + * @internal + */ export const filterSensitiveLog = (obj: TrackListMessage): any => ({ ...obj, }); @@ -7075,6 +7786,9 @@ export interface DescribeClusterVersionsMessage { } export namespace DescribeClusterVersionsMessage { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeClusterVersionsMessage): any => ({ ...obj, }); @@ -7112,6 +7826,9 @@ export interface DescribeDefaultClusterParametersMessage { } export namespace DescribeDefaultClusterParametersMessage { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeDefaultClusterParametersMessage): any => ({ ...obj, }); @@ -7125,6 +7842,9 @@ export interface DescribeDefaultClusterParametersResult { } export namespace DescribeDefaultClusterParametersResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeDefaultClusterParametersResult): any => ({ ...obj, }); @@ -7168,6 +7888,9 @@ export interface DescribeEndpointAccessMessage { } export namespace DescribeEndpointAccessMessage { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeEndpointAccessMessage): any => ({ ...obj, }); @@ -7189,6 +7912,9 @@ export interface EndpointAccessList { } export namespace EndpointAccessList { + /** + * @internal + */ export const filterSensitiveLog = (obj: EndpointAccessList): any => ({ ...obj, }); @@ -7230,6 +7956,9 @@ export interface DescribeEndpointAuthorizationMessage { } export namespace DescribeEndpointAuthorizationMessage { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeEndpointAuthorizationMessage): any => ({ ...obj, }); @@ -7251,6 +7980,9 @@ export interface EndpointAuthorizationList { } export namespace EndpointAuthorizationList { + /** + * @internal + */ export const filterSensitiveLog = (obj: EndpointAuthorizationList): any => ({ ...obj, }); @@ -7269,6 +8001,9 @@ export interface DescribeEventCategoriesMessage { } export namespace DescribeEventCategoriesMessage { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeEventCategoriesMessage): any => ({ ...obj, }); @@ -7301,6 +8036,9 @@ export interface EventInfoMap { } export namespace EventInfoMap { + /** + * @internal + */ export const filterSensitiveLog = (obj: EventInfoMap): any => ({ ...obj, }); @@ -7323,6 +8061,9 @@ export interface EventCategoriesMap { } export namespace EventCategoriesMap { + /** + * @internal + */ export const filterSensitiveLog = (obj: EventCategoriesMap): any => ({ ...obj, }); @@ -7339,6 +8080,9 @@ export interface EventCategoriesMessage { } export namespace EventCategoriesMessage { + /** + * @internal + */ export const filterSensitiveLog = (obj: EventCategoriesMessage): any => ({ ...obj, }); @@ -7462,6 +8206,9 @@ export interface DescribeEventsMessage { } export namespace DescribeEventsMessage { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeEventsMessage): any => ({ ...obj, }); @@ -7510,6 +8257,9 @@ export interface Event { } export namespace Event { + /** + * @internal + */ export const filterSensitiveLog = (obj: Event): any => ({ ...obj, }); @@ -7535,6 +8285,9 @@ export interface EventsMessage { } export namespace EventsMessage { + /** + * @internal + */ export const filterSensitiveLog = (obj: EventsMessage): any => ({ ...obj, }); @@ -7593,6 +8346,9 @@ export interface DescribeEventSubscriptionsMessage { } export namespace DescribeEventSubscriptionsMessage { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeEventSubscriptionsMessage): any => ({ ...obj, }); @@ -7618,6 +8374,9 @@ export interface EventSubscriptionsMessage { } export namespace EventSubscriptionsMessage { + /** + * @internal + */ export const filterSensitiveLog = (obj: EventSubscriptionsMessage): any => ({ ...obj, }); @@ -7677,6 +8436,9 @@ export interface DescribeHsmClientCertificatesMessage { } export namespace DescribeHsmClientCertificatesMessage { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeHsmClientCertificatesMessage): any => ({ ...obj, }); @@ -7703,6 +8465,9 @@ export interface HsmClientCertificateMessage { } export namespace HsmClientCertificateMessage { + /** + * @internal + */ export const filterSensitiveLog = (obj: HsmClientCertificateMessage): any => ({ ...obj, }); @@ -7762,6 +8527,9 @@ export interface DescribeHsmConfigurationsMessage { } export namespace DescribeHsmConfigurationsMessage { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeHsmConfigurationsMessage): any => ({ ...obj, }); @@ -7787,6 +8555,9 @@ export interface HsmConfigurationMessage { } export namespace HsmConfigurationMessage { + /** + * @internal + */ export const filterSensitiveLog = (obj: HsmConfigurationMessage): any => ({ ...obj, }); @@ -7805,6 +8576,9 @@ export interface DescribeLoggingStatusMessage { } export namespace DescribeLoggingStatusMessage { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeLoggingStatusMessage): any => ({ ...obj, }); @@ -7847,6 +8621,9 @@ export interface LoggingStatus { } export namespace LoggingStatus { + /** + * @internal + */ export const filterSensitiveLog = (obj: LoggingStatus): any => ({ ...obj, }); @@ -7897,6 +8674,9 @@ export interface NodeConfigurationOptionsFilter { } export namespace NodeConfigurationOptionsFilter { + /** + * @internal + */ export const filterSensitiveLog = (obj: NodeConfigurationOptionsFilter): any => ({ ...obj, }); @@ -7957,6 +8737,9 @@ export interface DescribeNodeConfigurationOptionsMessage { } export namespace DescribeNodeConfigurationOptionsMessage { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeNodeConfigurationOptionsMessage): any => ({ ...obj, }); @@ -7993,6 +8776,9 @@ export interface NodeConfigurationOption { } export namespace NodeConfigurationOption { + /** + * @internal + */ export const filterSensitiveLog = (obj: NodeConfigurationOption): any => ({ ...obj, }); @@ -8015,6 +8801,9 @@ export interface NodeConfigurationOptionsMessage { } export namespace NodeConfigurationOptionsMessage { + /** + * @internal + */ export const filterSensitiveLog = (obj: NodeConfigurationOptionsMessage): any => ({ ...obj, }); @@ -8061,6 +8850,9 @@ export interface DescribeOrderableClusterOptionsMessage { } export namespace DescribeOrderableClusterOptionsMessage { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeOrderableClusterOptionsMessage): any => ({ ...obj, }); @@ -8092,6 +8884,9 @@ export interface OrderableClusterOption { } export namespace OrderableClusterOption { + /** + * @internal + */ export const filterSensitiveLog = (obj: OrderableClusterOption): any => ({ ...obj, }); @@ -8119,6 +8914,9 @@ export interface OrderableClusterOptionsMessage { } export namespace OrderableClusterOptionsMessage { + /** + * @internal + */ export const filterSensitiveLog = (obj: OrderableClusterOptionsMessage): any => ({ ...obj, }); @@ -8147,6 +8945,9 @@ export interface DescribePartnersInputMessage { } export namespace DescribePartnersInputMessage { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribePartnersInputMessage): any => ({ ...obj, }); @@ -8195,6 +8996,9 @@ export interface PartnerIntegrationInfo { } export namespace PartnerIntegrationInfo { + /** + * @internal + */ export const filterSensitiveLog = (obj: PartnerIntegrationInfo): any => ({ ...obj, }); @@ -8208,6 +9012,9 @@ export interface DescribePartnersOutputMessage { } export namespace DescribePartnersOutputMessage { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribePartnersOutputMessage): any => ({ ...obj, }); @@ -8245,6 +9052,9 @@ export interface DescribeReservedNodeOfferingsMessage { } export namespace DescribeReservedNodeOfferingsMessage { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeReservedNodeOfferingsMessage): any => ({ ...obj, }); @@ -8306,6 +9116,9 @@ export interface ReservedNodeOffering { } export namespace ReservedNodeOffering { + /** + * @internal + */ export const filterSensitiveLog = (obj: ReservedNodeOffering): any => ({ ...obj, }); @@ -8331,6 +9144,9 @@ export interface ReservedNodeOfferingsMessage { } export namespace ReservedNodeOfferingsMessage { + /** + * @internal + */ export const filterSensitiveLog = (obj: ReservedNodeOfferingsMessage): any => ({ ...obj, }); @@ -8368,6 +9184,9 @@ export interface DescribeReservedNodesMessage { } export namespace DescribeReservedNodesMessage { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeReservedNodesMessage): any => ({ ...obj, }); @@ -8393,6 +9212,9 @@ export interface ReservedNodesMessage { } export namespace ReservedNodesMessage { + /** + * @internal + */ export const filterSensitiveLog = (obj: ReservedNodesMessage): any => ({ ...obj, }); @@ -8412,6 +9234,9 @@ export interface DescribeResizeMessage { } export namespace DescribeResizeMessage { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeResizeMessage): any => ({ ...obj, }); @@ -8438,6 +9263,9 @@ export interface ScheduledActionFilter { } export namespace ScheduledActionFilter { + /** + * @internal + */ export const filterSensitiveLog = (obj: ScheduledActionFilter): any => ({ ...obj, }); @@ -8506,6 +9334,9 @@ export interface DescribeScheduledActionsMessage { } export namespace DescribeScheduledActionsMessage { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeScheduledActionsMessage): any => ({ ...obj, }); @@ -8529,6 +9360,9 @@ export interface ScheduledActionsMessage { } export namespace ScheduledActionsMessage { + /** + * @internal + */ export const filterSensitiveLog = (obj: ScheduledActionsMessage): any => ({ ...obj, }); @@ -8585,6 +9419,9 @@ export interface DescribeSnapshotCopyGrantsMessage { } export namespace DescribeSnapshotCopyGrantsMessage { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeSnapshotCopyGrantsMessage): any => ({ ...obj, }); diff --git a/clients/client-redshift/models/models_1.ts b/clients/client-redshift/models/models_1.ts index 680fcb7f24d2..1c2d70594c10 100644 --- a/clients/client-redshift/models/models_1.ts +++ b/clients/client-redshift/models/models_1.ts @@ -43,6 +43,9 @@ export interface SnapshotCopyGrantMessage { } export namespace SnapshotCopyGrantMessage { + /** + * @internal + */ export const filterSensitiveLog = (obj: SnapshotCopyGrantMessage): any => ({ ...obj, }); @@ -90,6 +93,9 @@ export interface DescribeSnapshotSchedulesMessage { } export namespace DescribeSnapshotSchedulesMessage { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeSnapshotSchedulesMessage): any => ({ ...obj, }); @@ -112,6 +118,9 @@ export interface DescribeSnapshotSchedulesOutputMessage { } export namespace DescribeSnapshotSchedulesOutputMessage { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeSnapshotSchedulesOutputMessage): any => ({ ...obj, }); @@ -151,6 +160,9 @@ export interface DescribeTableRestoreStatusMessage { } export namespace DescribeTableRestoreStatusMessage { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeTableRestoreStatusMessage): any => ({ ...obj, }); @@ -166,6 +178,9 @@ export interface TableRestoreNotFoundFault extends __SmithyException, $MetadataB } export namespace TableRestoreNotFoundFault { + /** + * @internal + */ export const filterSensitiveLog = (obj: TableRestoreNotFoundFault): any => ({ ...obj, }); @@ -257,6 +272,9 @@ export interface TableRestoreStatus { } export namespace TableRestoreStatus { + /** + * @internal + */ export const filterSensitiveLog = (obj: TableRestoreStatus): any => ({ ...obj, }); @@ -278,6 +296,9 @@ export interface TableRestoreStatusMessage { } export namespace TableRestoreStatusMessage { + /** + * @internal + */ export const filterSensitiveLog = (obj: TableRestoreStatusMessage): any => ({ ...obj, }); @@ -371,6 +392,9 @@ export interface DescribeTagsMessage { } export namespace DescribeTagsMessage { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeTagsMessage): any => ({ ...obj, }); @@ -430,6 +454,9 @@ export interface TaggedResource { } export namespace TaggedResource { + /** + * @internal + */ export const filterSensitiveLog = (obj: TaggedResource): any => ({ ...obj, }); @@ -455,6 +482,9 @@ export interface TaggedResourceListMessage { } export namespace TaggedResourceListMessage { + /** + * @internal + */ export const filterSensitiveLog = (obj: TaggedResourceListMessage): any => ({ ...obj, }); @@ -519,6 +549,9 @@ export interface DescribeUsageLimitsMessage { } export namespace DescribeUsageLimitsMessage { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeUsageLimitsMessage): any => ({ ...obj, }); @@ -542,6 +575,9 @@ export interface UsageLimitList { } export namespace UsageLimitList { + /** + * @internal + */ export const filterSensitiveLog = (obj: UsageLimitList): any => ({ ...obj, }); @@ -560,6 +596,9 @@ export interface DisableLoggingMessage { } export namespace DisableLoggingMessage { + /** + * @internal + */ export const filterSensitiveLog = (obj: DisableLoggingMessage): any => ({ ...obj, }); @@ -579,6 +618,9 @@ export interface DisableSnapshotCopyMessage { } export namespace DisableSnapshotCopyMessage { + /** + * @internal + */ export const filterSensitiveLog = (obj: DisableSnapshotCopyMessage): any => ({ ...obj, }); @@ -592,6 +634,9 @@ export interface DisableSnapshotCopyResult { } export namespace DisableSnapshotCopyResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: DisableSnapshotCopyResult): any => ({ ...obj, }); @@ -607,6 +652,9 @@ export interface SnapshotCopyAlreadyDisabledFault extends __SmithyException, $Me } export namespace SnapshotCopyAlreadyDisabledFault { + /** + * @internal + */ export const filterSensitiveLog = (obj: SnapshotCopyAlreadyDisabledFault): any => ({ ...obj, }); @@ -671,6 +719,9 @@ export interface EnableLoggingMessage { } export namespace EnableLoggingMessage { + /** + * @internal + */ export const filterSensitiveLog = (obj: EnableLoggingMessage): any => ({ ...obj, }); @@ -687,6 +738,9 @@ export interface InsufficientS3BucketPolicyFault extends __SmithyException, $Met } export namespace InsufficientS3BucketPolicyFault { + /** + * @internal + */ export const filterSensitiveLog = (obj: InsufficientS3BucketPolicyFault): any => ({ ...obj, }); @@ -705,6 +759,9 @@ export interface InvalidS3BucketNameFault extends __SmithyException, $MetadataBe } export namespace InvalidS3BucketNameFault { + /** + * @internal + */ export const filterSensitiveLog = (obj: InvalidS3BucketNameFault): any => ({ ...obj, }); @@ -721,6 +778,9 @@ export interface InvalidS3KeyPrefixFault extends __SmithyException, $MetadataBea } export namespace InvalidS3KeyPrefixFault { + /** + * @internal + */ export const filterSensitiveLog = (obj: InvalidS3KeyPrefixFault): any => ({ ...obj, }); @@ -769,6 +829,9 @@ export interface EnableSnapshotCopyMessage { } export namespace EnableSnapshotCopyMessage { + /** + * @internal + */ export const filterSensitiveLog = (obj: EnableSnapshotCopyMessage): any => ({ ...obj, }); @@ -782,6 +845,9 @@ export interface EnableSnapshotCopyResult { } export namespace EnableSnapshotCopyResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: EnableSnapshotCopyResult): any => ({ ...obj, }); @@ -797,6 +863,9 @@ export interface IncompatibleOrderableOptions extends __SmithyException, $Metada } export namespace IncompatibleOrderableOptions { + /** + * @internal + */ export const filterSensitiveLog = (obj: IncompatibleOrderableOptions): any => ({ ...obj, }); @@ -812,6 +881,9 @@ export interface SnapshotCopyAlreadyEnabledFault extends __SmithyException, $Met } export namespace SnapshotCopyAlreadyEnabledFault { + /** + * @internal + */ export const filterSensitiveLog = (obj: SnapshotCopyAlreadyEnabledFault): any => ({ ...obj, }); @@ -827,6 +899,9 @@ export interface UnknownSnapshotCopyRegionFault extends __SmithyException, $Meta } export namespace UnknownSnapshotCopyRegionFault { + /** + * @internal + */ export const filterSensitiveLog = (obj: UnknownSnapshotCopyRegionFault): any => ({ ...obj, }); @@ -842,6 +917,9 @@ export interface EndpointAuthorizationNotFoundFault extends __SmithyException, $ } export namespace EndpointAuthorizationNotFoundFault { + /** + * @internal + */ export const filterSensitiveLog = (obj: EndpointAuthorizationNotFoundFault): any => ({ ...obj, }); @@ -962,6 +1040,9 @@ export interface GetClusterCredentialsMessage { } export namespace GetClusterCredentialsMessage { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetClusterCredentialsMessage): any => ({ ...obj, }); @@ -991,6 +1072,9 @@ export interface GetReservedNodeExchangeOfferingsInputMessage { } export namespace GetReservedNodeExchangeOfferingsInputMessage { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetReservedNodeExchangeOfferingsInputMessage): any => ({ ...obj, }); @@ -1014,6 +1098,9 @@ export interface GetReservedNodeExchangeOfferingsOutputMessage { } export namespace GetReservedNodeExchangeOfferingsOutputMessage { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetReservedNodeExchangeOfferingsOutputMessage): any => ({ ...obj, }); @@ -1030,6 +1117,9 @@ export interface InProgressTableRestoreQuotaExceededFault extends __SmithyExcept } export namespace InProgressTableRestoreQuotaExceededFault { + /** + * @internal + */ export const filterSensitiveLog = (obj: InProgressTableRestoreQuotaExceededFault): any => ({ ...obj, }); @@ -1045,6 +1135,9 @@ export interface InvalidRestoreFault extends __SmithyException, $MetadataBearer } export namespace InvalidRestoreFault { + /** + * @internal + */ export const filterSensitiveLog = (obj: InvalidRestoreFault): any => ({ ...obj, }); @@ -1062,6 +1155,9 @@ export interface InvalidTableRestoreArgumentFault extends __SmithyException, $Me } export namespace InvalidTableRestoreArgumentFault { + /** + * @internal + */ export const filterSensitiveLog = (obj: InvalidTableRestoreArgumentFault): any => ({ ...obj, }); @@ -1091,6 +1187,9 @@ export interface ModifyAquaInputMessage { } export namespace ModifyAquaInputMessage { + /** + * @internal + */ export const filterSensitiveLog = (obj: ModifyAquaInputMessage): any => ({ ...obj, }); @@ -1104,6 +1203,9 @@ export interface ModifyAquaOutputMessage { } export namespace ModifyAquaOutputMessage { + /** + * @internal + */ export const filterSensitiveLog = (obj: ModifyAquaOutputMessage): any => ({ ...obj, }); @@ -1392,6 +1494,9 @@ export interface ModifyClusterMessage { } export namespace ModifyClusterMessage { + /** + * @internal + */ export const filterSensitiveLog = (obj: ModifyClusterMessage): any => ({ ...obj, }); @@ -1405,6 +1510,9 @@ export interface ModifyClusterResult { } export namespace ModifyClusterResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: ModifyClusterResult): any => ({ ...obj, }); @@ -1421,6 +1529,9 @@ export interface TableLimitExceededFault extends __SmithyException, $MetadataBea } export namespace TableLimitExceededFault { + /** + * @internal + */ export const filterSensitiveLog = (obj: TableLimitExceededFault): any => ({ ...obj, }); @@ -1436,6 +1547,9 @@ export interface UnsupportedOptionFault extends __SmithyException, $MetadataBear } export namespace UnsupportedOptionFault { + /** + * @internal + */ export const filterSensitiveLog = (obj: UnsupportedOptionFault): any => ({ ...obj, }); @@ -1457,6 +1571,9 @@ export interface ModifyClusterDbRevisionMessage { } export namespace ModifyClusterDbRevisionMessage { + /** + * @internal + */ export const filterSensitiveLog = (obj: ModifyClusterDbRevisionMessage): any => ({ ...obj, }); @@ -1470,6 +1587,9 @@ export interface ModifyClusterDbRevisionResult { } export namespace ModifyClusterDbRevisionResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: ModifyClusterDbRevisionResult): any => ({ ...obj, }); @@ -1500,6 +1620,9 @@ export interface ModifyClusterIamRolesMessage { } export namespace ModifyClusterIamRolesMessage { + /** + * @internal + */ export const filterSensitiveLog = (obj: ModifyClusterIamRolesMessage): any => ({ ...obj, }); @@ -1513,6 +1636,9 @@ export interface ModifyClusterIamRolesResult { } export namespace ModifyClusterIamRolesResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: ModifyClusterIamRolesResult): any => ({ ...obj, }); @@ -1553,6 +1679,9 @@ export interface ModifyClusterMaintenanceMessage { } export namespace ModifyClusterMaintenanceMessage { + /** + * @internal + */ export const filterSensitiveLog = (obj: ModifyClusterMaintenanceMessage): any => ({ ...obj, }); @@ -1566,6 +1695,9 @@ export interface ModifyClusterMaintenanceResult { } export namespace ModifyClusterMaintenanceResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: ModifyClusterMaintenanceResult): any => ({ ...obj, }); @@ -1592,6 +1724,9 @@ export interface ModifyClusterParameterGroupMessage { } export namespace ModifyClusterParameterGroupMessage { + /** + * @internal + */ export const filterSensitiveLog = (obj: ModifyClusterParameterGroupMessage): any => ({ ...obj, }); @@ -1620,6 +1755,9 @@ export interface ModifyClusterSnapshotMessage { } export namespace ModifyClusterSnapshotMessage { + /** + * @internal + */ export const filterSensitiveLog = (obj: ModifyClusterSnapshotMessage): any => ({ ...obj, }); @@ -1633,6 +1771,9 @@ export interface ModifyClusterSnapshotResult { } export namespace ModifyClusterSnapshotResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: ModifyClusterSnapshotResult): any => ({ ...obj, }); @@ -1659,6 +1800,9 @@ export interface ModifyClusterSnapshotScheduleMessage { } export namespace ModifyClusterSnapshotScheduleMessage { + /** + * @internal + */ export const filterSensitiveLog = (obj: ModifyClusterSnapshotScheduleMessage): any => ({ ...obj, }); @@ -1686,6 +1830,9 @@ export interface ModifyClusterSubnetGroupMessage { } export namespace ModifyClusterSubnetGroupMessage { + /** + * @internal + */ export const filterSensitiveLog = (obj: ModifyClusterSubnetGroupMessage): any => ({ ...obj, }); @@ -1699,6 +1846,9 @@ export interface ModifyClusterSubnetGroupResult { } export namespace ModifyClusterSubnetGroupResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: ModifyClusterSubnetGroupResult): any => ({ ...obj, }); @@ -1714,6 +1864,9 @@ export interface SubnetAlreadyInUse extends __SmithyException, $MetadataBearer { } export namespace SubnetAlreadyInUse { + /** + * @internal + */ export const filterSensitiveLog = (obj: SubnetAlreadyInUse): any => ({ ...obj, }); @@ -1732,6 +1885,9 @@ export interface ModifyEndpointAccessMessage { } export namespace ModifyEndpointAccessMessage { + /** + * @internal + */ export const filterSensitiveLog = (obj: ModifyEndpointAccessMessage): any => ({ ...obj, }); @@ -1794,6 +1950,9 @@ export interface ModifyEventSubscriptionMessage { } export namespace ModifyEventSubscriptionMessage { + /** + * @internal + */ export const filterSensitiveLog = (obj: ModifyEventSubscriptionMessage): any => ({ ...obj, }); @@ -1807,6 +1966,9 @@ export interface ModifyEventSubscriptionResult { } export namespace ModifyEventSubscriptionResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: ModifyEventSubscriptionResult): any => ({ ...obj, }); @@ -1860,6 +2022,9 @@ export interface ModifyScheduledActionMessage { } export namespace ModifyScheduledActionMessage { + /** + * @internal + */ export const filterSensitiveLog = (obj: ModifyScheduledActionMessage): any => ({ ...obj, }); @@ -1904,6 +2069,9 @@ export interface ModifySnapshotCopyRetentionPeriodMessage { } export namespace ModifySnapshotCopyRetentionPeriodMessage { + /** + * @internal + */ export const filterSensitiveLog = (obj: ModifySnapshotCopyRetentionPeriodMessage): any => ({ ...obj, }); @@ -1917,6 +2085,9 @@ export interface ModifySnapshotCopyRetentionPeriodResult { } export namespace ModifySnapshotCopyRetentionPeriodResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: ModifySnapshotCopyRetentionPeriodResult): any => ({ ...obj, }); @@ -1933,6 +2104,9 @@ export interface SnapshotCopyDisabledFault extends __SmithyException, $MetadataB } export namespace SnapshotCopyDisabledFault { + /** + * @internal + */ export const filterSensitiveLog = (obj: SnapshotCopyDisabledFault): any => ({ ...obj, }); @@ -1952,6 +2126,9 @@ export interface ModifySnapshotScheduleMessage { } export namespace ModifySnapshotScheduleMessage { + /** + * @internal + */ export const filterSensitiveLog = (obj: ModifySnapshotScheduleMessage): any => ({ ...obj, }); @@ -1967,6 +2144,9 @@ export interface SnapshotScheduleUpdateInProgressFault extends __SmithyException } export namespace SnapshotScheduleUpdateInProgressFault { + /** + * @internal + */ export const filterSensitiveLog = (obj: SnapshotScheduleUpdateInProgressFault): any => ({ ...obj, }); @@ -1992,6 +2172,9 @@ export interface ModifyUsageLimitMessage { } export namespace ModifyUsageLimitMessage { + /** + * @internal + */ export const filterSensitiveLog = (obj: ModifyUsageLimitMessage): any => ({ ...obj, }); @@ -2005,6 +2188,9 @@ export interface PauseClusterResult { } export namespace PauseClusterResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: PauseClusterResult): any => ({ ...obj, }); @@ -2028,6 +2214,9 @@ export interface PurchaseReservedNodeOfferingMessage { } export namespace PurchaseReservedNodeOfferingMessage { + /** + * @internal + */ export const filterSensitiveLog = (obj: PurchaseReservedNodeOfferingMessage): any => ({ ...obj, }); @@ -2042,6 +2231,9 @@ export interface PurchaseReservedNodeOfferingResult { } export namespace PurchaseReservedNodeOfferingResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: PurchaseReservedNodeOfferingResult): any => ({ ...obj, }); @@ -2060,6 +2252,9 @@ export interface ReservedNodeQuotaExceededFault extends __SmithyException, $Meta } export namespace ReservedNodeQuotaExceededFault { + /** + * @internal + */ export const filterSensitiveLog = (obj: ReservedNodeQuotaExceededFault): any => ({ ...obj, }); @@ -2076,6 +2271,9 @@ export interface RebootClusterMessage { } export namespace RebootClusterMessage { + /** + * @internal + */ export const filterSensitiveLog = (obj: RebootClusterMessage): any => ({ ...obj, }); @@ -2089,6 +2287,9 @@ export interface RebootClusterResult { } export namespace RebootClusterResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: RebootClusterResult): any => ({ ...obj, }); @@ -2121,6 +2322,9 @@ export interface ResetClusterParameterGroupMessage { } export namespace ResetClusterParameterGroupMessage { + /** + * @internal + */ export const filterSensitiveLog = (obj: ResetClusterParameterGroupMessage): any => ({ ...obj, }); @@ -2134,6 +2338,9 @@ export interface ResizeClusterResult { } export namespace ResizeClusterResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: ResizeClusterResult): any => ({ ...obj, }); @@ -2395,6 +2602,9 @@ export interface RestoreFromClusterSnapshotMessage { } export namespace RestoreFromClusterSnapshotMessage { + /** + * @internal + */ export const filterSensitiveLog = (obj: RestoreFromClusterSnapshotMessage): any => ({ ...obj, }); @@ -2408,6 +2618,9 @@ export interface RestoreFromClusterSnapshotResult { } export namespace RestoreFromClusterSnapshotResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: RestoreFromClusterSnapshotResult): any => ({ ...obj, }); @@ -2470,6 +2683,9 @@ export interface RestoreTableFromClusterSnapshotMessage { } export namespace RestoreTableFromClusterSnapshotMessage { + /** + * @internal + */ export const filterSensitiveLog = (obj: RestoreTableFromClusterSnapshotMessage): any => ({ ...obj, }); @@ -2484,6 +2700,9 @@ export interface RestoreTableFromClusterSnapshotResult { } export namespace RestoreTableFromClusterSnapshotResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: RestoreTableFromClusterSnapshotResult): any => ({ ...obj, }); @@ -2497,6 +2716,9 @@ export interface ResumeClusterResult { } export namespace ResumeClusterResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: ResumeClusterResult): any => ({ ...obj, }); @@ -2539,6 +2761,9 @@ export interface RevokeClusterSecurityGroupIngressMessage { } export namespace RevokeClusterSecurityGroupIngressMessage { + /** + * @internal + */ export const filterSensitiveLog = (obj: RevokeClusterSecurityGroupIngressMessage): any => ({ ...obj, }); @@ -2552,6 +2777,9 @@ export interface RevokeClusterSecurityGroupIngressResult { } export namespace RevokeClusterSecurityGroupIngressResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: RevokeClusterSecurityGroupIngressResult): any => ({ ...obj, }); @@ -2581,6 +2809,9 @@ export interface RevokeEndpointAccessMessage { } export namespace RevokeEndpointAccessMessage { + /** + * @internal + */ export const filterSensitiveLog = (obj: RevokeEndpointAccessMessage): any => ({ ...obj, }); @@ -2610,6 +2841,9 @@ export interface RevokeSnapshotAccessMessage { } export namespace RevokeSnapshotAccessMessage { + /** + * @internal + */ export const filterSensitiveLog = (obj: RevokeSnapshotAccessMessage): any => ({ ...obj, }); @@ -2623,6 +2857,9 @@ export interface RevokeSnapshotAccessResult { } export namespace RevokeSnapshotAccessResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: RevokeSnapshotAccessResult): any => ({ ...obj, }); @@ -2642,6 +2879,9 @@ export interface RotateEncryptionKeyMessage { } export namespace RotateEncryptionKeyMessage { + /** + * @internal + */ export const filterSensitiveLog = (obj: RotateEncryptionKeyMessage): any => ({ ...obj, }); @@ -2655,6 +2895,9 @@ export interface RotateEncryptionKeyResult { } export namespace RotateEncryptionKeyResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: RotateEncryptionKeyResult): any => ({ ...obj, }); @@ -2693,6 +2936,9 @@ export interface UpdatePartnerStatusInputMessage { } export namespace UpdatePartnerStatusInputMessage { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdatePartnerStatusInputMessage): any => ({ ...obj, }); diff --git a/clients/client-rekognition/commands/CompareFacesCommand.ts b/clients/client-rekognition/commands/CompareFacesCommand.ts index e8300d1e3990..fef445466723 100644 --- a/clients/client-rekognition/commands/CompareFacesCommand.ts +++ b/clients/client-rekognition/commands/CompareFacesCommand.ts @@ -84,6 +84,20 @@ export interface CompareFacesCommandOutput extends CompareFacesResponse, __Metad *

For an example, see Comparing Faces in Images in the Amazon Rekognition Developer Guide.

*

This operation requires permissions to perform the rekognition:CompareFaces * action.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { RekognitionClient, CompareFacesCommand } from "@aws-sdk/client-rekognition"; // ES Modules import + * // const { RekognitionClient, CompareFacesCommand } = require("@aws-sdk/client-rekognition"); // CommonJS import + * const client = new RekognitionClient(config); + * const command = new CompareFacesCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CompareFacesCommandInput} for command's `input` shape. + * @see {@link CompareFacesCommandOutput} for command's `response` shape. + * @see {@link RekognitionClientResolvedConfig | config} for command's `input` shape. + * */ export class CompareFacesCommand extends $Command< CompareFacesCommandInput, diff --git a/clients/client-rekognition/commands/CreateCollectionCommand.ts b/clients/client-rekognition/commands/CreateCollectionCommand.ts index cafdca35be71..97034bd6b017 100644 --- a/clients/client-rekognition/commands/CreateCollectionCommand.ts +++ b/clients/client-rekognition/commands/CreateCollectionCommand.ts @@ -34,6 +34,20 @@ export interface CreateCollectionCommandOutput extends CreateCollectionResponse, * *

This operation requires permissions to perform the * rekognition:CreateCollection action.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { RekognitionClient, CreateCollectionCommand } from "@aws-sdk/client-rekognition"; // ES Modules import + * // const { RekognitionClient, CreateCollectionCommand } = require("@aws-sdk/client-rekognition"); // CommonJS import + * const client = new RekognitionClient(config); + * const command = new CreateCollectionCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreateCollectionCommandInput} for command's `input` shape. + * @see {@link CreateCollectionCommandOutput} for command's `response` shape. + * @see {@link RekognitionClientResolvedConfig | config} for command's `input` shape. + * */ export class CreateCollectionCommand extends $Command< CreateCollectionCommandInput, diff --git a/clients/client-rekognition/commands/CreateProjectCommand.ts b/clients/client-rekognition/commands/CreateProjectCommand.ts index 214237c057ad..c6f31e656f75 100644 --- a/clients/client-rekognition/commands/CreateProjectCommand.ts +++ b/clients/client-rekognition/commands/CreateProjectCommand.ts @@ -24,6 +24,20 @@ export interface CreateProjectCommandOutput extends CreateProjectResponse, __Met *

Creates a new Amazon Rekognition Custom Labels project. A project is a logical grouping of resources (images, Labels, models) * and operations (training, evaluation and detection).

*

This operation requires permissions to perform the rekognition:CreateProject action.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { RekognitionClient, CreateProjectCommand } from "@aws-sdk/client-rekognition"; // ES Modules import + * // const { RekognitionClient, CreateProjectCommand } = require("@aws-sdk/client-rekognition"); // CommonJS import + * const client = new RekognitionClient(config); + * const command = new CreateProjectCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreateProjectCommandInput} for command's `input` shape. + * @see {@link CreateProjectCommandOutput} for command's `response` shape. + * @see {@link RekognitionClientResolvedConfig | config} for command's `input` shape. + * */ export class CreateProjectCommand extends $Command< CreateProjectCommandInput, diff --git a/clients/client-rekognition/commands/CreateProjectVersionCommand.ts b/clients/client-rekognition/commands/CreateProjectVersionCommand.ts index 927f592e55af..9d43d1f34b40 100644 --- a/clients/client-rekognition/commands/CreateProjectVersionCommand.ts +++ b/clients/client-rekognition/commands/CreateProjectVersionCommand.ts @@ -33,6 +33,20 @@ export interface CreateProjectVersionCommandOutput extends CreateProjectVersionR *

After evaluating the model, you start the model * by calling StartProjectVersion.

*

This operation requires permissions to perform the rekognition:CreateProjectVersion action.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { RekognitionClient, CreateProjectVersionCommand } from "@aws-sdk/client-rekognition"; // ES Modules import + * // const { RekognitionClient, CreateProjectVersionCommand } = require("@aws-sdk/client-rekognition"); // CommonJS import + * const client = new RekognitionClient(config); + * const command = new CreateProjectVersionCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreateProjectVersionCommandInput} for command's `input` shape. + * @see {@link CreateProjectVersionCommandOutput} for command's `response` shape. + * @see {@link RekognitionClientResolvedConfig | config} for command's `input` shape. + * */ export class CreateProjectVersionCommand extends $Command< CreateProjectVersionCommandInput, diff --git a/clients/client-rekognition/commands/CreateStreamProcessorCommand.ts b/clients/client-rekognition/commands/CreateStreamProcessorCommand.ts index a787ce10da68..45e5219460c0 100644 --- a/clients/client-rekognition/commands/CreateStreamProcessorCommand.ts +++ b/clients/client-rekognition/commands/CreateStreamProcessorCommand.ts @@ -30,6 +30,20 @@ export interface CreateStreamProcessorCommandOutput extends CreateStreamProcesso * the Name field.

*

After you have finished analyzing a streaming video, use StopStreamProcessor to * stop processing. You can delete the stream processor by calling DeleteStreamProcessor.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { RekognitionClient, CreateStreamProcessorCommand } from "@aws-sdk/client-rekognition"; // ES Modules import + * // const { RekognitionClient, CreateStreamProcessorCommand } = require("@aws-sdk/client-rekognition"); // CommonJS import + * const client = new RekognitionClient(config); + * const command = new CreateStreamProcessorCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreateStreamProcessorCommandInput} for command's `input` shape. + * @see {@link CreateStreamProcessorCommandOutput} for command's `response` shape. + * @see {@link RekognitionClientResolvedConfig | config} for command's `input` shape. + * */ export class CreateStreamProcessorCommand extends $Command< CreateStreamProcessorCommandInput, diff --git a/clients/client-rekognition/commands/DeleteCollectionCommand.ts b/clients/client-rekognition/commands/DeleteCollectionCommand.ts index 32fe7da48628..5b8f368ef785 100644 --- a/clients/client-rekognition/commands/DeleteCollectionCommand.ts +++ b/clients/client-rekognition/commands/DeleteCollectionCommand.ts @@ -26,6 +26,20 @@ export interface DeleteCollectionCommandOutput extends DeleteCollectionResponse, * *

This operation requires permissions to perform the * rekognition:DeleteCollection action.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { RekognitionClient, DeleteCollectionCommand } from "@aws-sdk/client-rekognition"; // ES Modules import + * // const { RekognitionClient, DeleteCollectionCommand } = require("@aws-sdk/client-rekognition"); // CommonJS import + * const client = new RekognitionClient(config); + * const command = new DeleteCollectionCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteCollectionCommandInput} for command's `input` shape. + * @see {@link DeleteCollectionCommandOutput} for command's `response` shape. + * @see {@link RekognitionClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteCollectionCommand extends $Command< DeleteCollectionCommandInput, diff --git a/clients/client-rekognition/commands/DeleteFacesCommand.ts b/clients/client-rekognition/commands/DeleteFacesCommand.ts index e310d3ec2259..ed916ccb8420 100644 --- a/clients/client-rekognition/commands/DeleteFacesCommand.ts +++ b/clients/client-rekognition/commands/DeleteFacesCommand.ts @@ -25,6 +25,20 @@ export interface DeleteFacesCommandOutput extends DeleteFacesResponse, __Metadat * to remove from the collection.

*

This operation requires permissions to perform the rekognition:DeleteFaces * action.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { RekognitionClient, DeleteFacesCommand } from "@aws-sdk/client-rekognition"; // ES Modules import + * // const { RekognitionClient, DeleteFacesCommand } = require("@aws-sdk/client-rekognition"); // CommonJS import + * const client = new RekognitionClient(config); + * const command = new DeleteFacesCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteFacesCommandInput} for command's `input` shape. + * @see {@link DeleteFacesCommandOutput} for command's `response` shape. + * @see {@link RekognitionClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteFacesCommand extends $Command< DeleteFacesCommandInput, diff --git a/clients/client-rekognition/commands/DeleteProjectCommand.ts b/clients/client-rekognition/commands/DeleteProjectCommand.ts index 4f3932729674..8e9e45cce7e8 100644 --- a/clients/client-rekognition/commands/DeleteProjectCommand.ts +++ b/clients/client-rekognition/commands/DeleteProjectCommand.ts @@ -25,6 +25,20 @@ export interface DeleteProjectCommandOutput extends DeleteProjectResponse, __Met * with the project. To delete a model, see DeleteProjectVersion.

*

This operation requires permissions to perform the * rekognition:DeleteProject action.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { RekognitionClient, DeleteProjectCommand } from "@aws-sdk/client-rekognition"; // ES Modules import + * // const { RekognitionClient, DeleteProjectCommand } = require("@aws-sdk/client-rekognition"); // CommonJS import + * const client = new RekognitionClient(config); + * const command = new DeleteProjectCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteProjectCommandInput} for command's `input` shape. + * @see {@link DeleteProjectCommandOutput} for command's `response` shape. + * @see {@link RekognitionClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteProjectCommand extends $Command< DeleteProjectCommandInput, diff --git a/clients/client-rekognition/commands/DeleteProjectVersionCommand.ts b/clients/client-rekognition/commands/DeleteProjectVersionCommand.ts index 11b85d9a7d0c..29f1174372a9 100644 --- a/clients/client-rekognition/commands/DeleteProjectVersionCommand.ts +++ b/clients/client-rekognition/commands/DeleteProjectVersionCommand.ts @@ -29,6 +29,20 @@ export interface DeleteProjectVersionCommandOutput extends DeleteProjectVersionR * is training, wait until it finishes.

*

This operation requires permissions to perform the * rekognition:DeleteProjectVersion action.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { RekognitionClient, DeleteProjectVersionCommand } from "@aws-sdk/client-rekognition"; // ES Modules import + * // const { RekognitionClient, DeleteProjectVersionCommand } = require("@aws-sdk/client-rekognition"); // CommonJS import + * const client = new RekognitionClient(config); + * const command = new DeleteProjectVersionCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteProjectVersionCommandInput} for command's `input` shape. + * @see {@link DeleteProjectVersionCommandOutput} for command's `response` shape. + * @see {@link RekognitionClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteProjectVersionCommand extends $Command< DeleteProjectVersionCommandInput, diff --git a/clients/client-rekognition/commands/DeleteStreamProcessorCommand.ts b/clients/client-rekognition/commands/DeleteStreamProcessorCommand.ts index 3d73c2254572..c8940dec7aa3 100644 --- a/clients/client-rekognition/commands/DeleteStreamProcessorCommand.ts +++ b/clients/client-rekognition/commands/DeleteStreamProcessorCommand.ts @@ -23,6 +23,20 @@ export interface DeleteStreamProcessorCommandOutput extends DeleteStreamProcesso /** *

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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { RekognitionClient, DeleteStreamProcessorCommand } from "@aws-sdk/client-rekognition"; // ES Modules import + * // const { RekognitionClient, DeleteStreamProcessorCommand } = require("@aws-sdk/client-rekognition"); // CommonJS import + * const client = new RekognitionClient(config); + * const command = new DeleteStreamProcessorCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteStreamProcessorCommandInput} for command's `input` shape. + * @see {@link DeleteStreamProcessorCommandOutput} for command's `response` shape. + * @see {@link RekognitionClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteStreamProcessorCommand extends $Command< DeleteStreamProcessorCommandInput, diff --git a/clients/client-rekognition/commands/DescribeCollectionCommand.ts b/clients/client-rekognition/commands/DescribeCollectionCommand.ts index 6e4376dde4b9..246228c89c0e 100644 --- a/clients/client-rekognition/commands/DescribeCollectionCommand.ts +++ b/clients/client-rekognition/commands/DescribeCollectionCommand.ts @@ -27,6 +27,20 @@ export interface DescribeCollectionCommandOutput extends DescribeCollectionRespo * *

For more information, see Describing a Collection in the * Amazon Rekognition Developer Guide.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { RekognitionClient, DescribeCollectionCommand } from "@aws-sdk/client-rekognition"; // ES Modules import + * // const { RekognitionClient, DescribeCollectionCommand } = require("@aws-sdk/client-rekognition"); // CommonJS import + * const client = new RekognitionClient(config); + * const command = new DescribeCollectionCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeCollectionCommandInput} for command's `input` shape. + * @see {@link DescribeCollectionCommandOutput} for command's `response` shape. + * @see {@link RekognitionClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeCollectionCommand extends $Command< DescribeCollectionCommandInput, diff --git a/clients/client-rekognition/commands/DescribeProjectVersionsCommand.ts b/clients/client-rekognition/commands/DescribeProjectVersionsCommand.ts index 912f7b53a5f0..cc886c4baf1b 100644 --- a/clients/client-rekognition/commands/DescribeProjectVersionsCommand.ts +++ b/clients/client-rekognition/commands/DescribeProjectVersionsCommand.ts @@ -26,6 +26,20 @@ export interface DescribeProjectVersionsCommandOutput extends DescribeProjectVer * you don't specify a value, descriptions for all models are returned.

*

This operation requires permissions to perform the rekognition:DescribeProjectVersions * action.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { RekognitionClient, DescribeProjectVersionsCommand } from "@aws-sdk/client-rekognition"; // ES Modules import + * // const { RekognitionClient, DescribeProjectVersionsCommand } = require("@aws-sdk/client-rekognition"); // CommonJS import + * const client = new RekognitionClient(config); + * const command = new DescribeProjectVersionsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeProjectVersionsCommandInput} for command's `input` shape. + * @see {@link DescribeProjectVersionsCommandOutput} for command's `response` shape. + * @see {@link RekognitionClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeProjectVersionsCommand extends $Command< DescribeProjectVersionsCommandInput, diff --git a/clients/client-rekognition/commands/DescribeProjectsCommand.ts b/clients/client-rekognition/commands/DescribeProjectsCommand.ts index 573c5a679268..0e23053b6336 100644 --- a/clients/client-rekognition/commands/DescribeProjectsCommand.ts +++ b/clients/client-rekognition/commands/DescribeProjectsCommand.ts @@ -23,6 +23,20 @@ export interface DescribeProjectsCommandOutput extends DescribeProjectsResponse, /** *

Lists and gets information about your Amazon Rekognition Custom Labels projects.

*

This operation requires permissions to perform the rekognition:DescribeProjects action.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { RekognitionClient, DescribeProjectsCommand } from "@aws-sdk/client-rekognition"; // ES Modules import + * // const { RekognitionClient, DescribeProjectsCommand } = require("@aws-sdk/client-rekognition"); // CommonJS import + * const client = new RekognitionClient(config); + * const command = new DescribeProjectsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeProjectsCommandInput} for command's `input` shape. + * @see {@link DescribeProjectsCommandOutput} for command's `response` shape. + * @see {@link RekognitionClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeProjectsCommand extends $Command< DescribeProjectsCommandInput, diff --git a/clients/client-rekognition/commands/DescribeStreamProcessorCommand.ts b/clients/client-rekognition/commands/DescribeStreamProcessorCommand.ts index 8aacef18ece0..1cedb148e106 100644 --- a/clients/client-rekognition/commands/DescribeStreamProcessorCommand.ts +++ b/clients/client-rekognition/commands/DescribeStreamProcessorCommand.ts @@ -23,6 +23,20 @@ export interface DescribeStreamProcessorCommandOutput extends DescribeStreamProc /** *

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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { RekognitionClient, DescribeStreamProcessorCommand } from "@aws-sdk/client-rekognition"; // ES Modules import + * // const { RekognitionClient, DescribeStreamProcessorCommand } = require("@aws-sdk/client-rekognition"); // CommonJS import + * const client = new RekognitionClient(config); + * const command = new DescribeStreamProcessorCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeStreamProcessorCommandInput} for command's `input` shape. + * @see {@link DescribeStreamProcessorCommandOutput} for command's `response` shape. + * @see {@link RekognitionClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeStreamProcessorCommand extends $Command< DescribeStreamProcessorCommandInput, diff --git a/clients/client-rekognition/commands/DetectCustomLabelsCommand.ts b/clients/client-rekognition/commands/DetectCustomLabelsCommand.ts index deaa874d2995..b8b63ebac88d 100644 --- a/clients/client-rekognition/commands/DetectCustomLabelsCommand.ts +++ b/clients/client-rekognition/commands/DetectCustomLabelsCommand.ts @@ -47,6 +47,20 @@ export interface DetectCustomLabelsCommandOutput extends DetectCustomLabelsRespo * data.

*

This operation requires permissions to perform the * rekognition:DetectCustomLabels action.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { RekognitionClient, DetectCustomLabelsCommand } from "@aws-sdk/client-rekognition"; // ES Modules import + * // const { RekognitionClient, DetectCustomLabelsCommand } = require("@aws-sdk/client-rekognition"); // CommonJS import + * const client = new RekognitionClient(config); + * const command = new DetectCustomLabelsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DetectCustomLabelsCommandInput} for command's `input` shape. + * @see {@link DetectCustomLabelsCommandOutput} for command's `response` shape. + * @see {@link RekognitionClientResolvedConfig | config} for command's `input` shape. + * */ export class DetectCustomLabelsCommand extends $Command< DetectCustomLabelsCommandInput, diff --git a/clients/client-rekognition/commands/DetectFacesCommand.ts b/clients/client-rekognition/commands/DetectFacesCommand.ts index c5eba8722f5f..d9b3f0586863 100644 --- a/clients/client-rekognition/commands/DetectFacesCommand.ts +++ b/clients/client-rekognition/commands/DetectFacesCommand.ts @@ -44,6 +44,20 @@ export interface DetectFacesCommandOutput extends DetectFacesResponse, __Metadat * *

This operation requires permissions to perform the * rekognition:DetectFaces action.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { RekognitionClient, DetectFacesCommand } from "@aws-sdk/client-rekognition"; // ES Modules import + * // const { RekognitionClient, DetectFacesCommand } = require("@aws-sdk/client-rekognition"); // CommonJS import + * const client = new RekognitionClient(config); + * const command = new DetectFacesCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DetectFacesCommandInput} for command's `input` shape. + * @see {@link DetectFacesCommandOutput} for command's `response` shape. + * @see {@link RekognitionClientResolvedConfig | config} for command's `input` shape. + * */ export class DetectFacesCommand extends $Command< DetectFacesCommandInput, diff --git a/clients/client-rekognition/commands/DetectLabelsCommand.ts b/clients/client-rekognition/commands/DetectLabelsCommand.ts index 9b12a9ea7b93..2a8c4e66334e 100644 --- a/clients/client-rekognition/commands/DetectLabelsCommand.ts +++ b/clients/client-rekognition/commands/DetectLabelsCommand.ts @@ -95,6 +95,20 @@ export interface DetectLabelsCommandOutput extends DetectLabelsResponse, __Metad * data.

*

This operation requires permissions to perform the * rekognition:DetectLabels action.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { RekognitionClient, DetectLabelsCommand } from "@aws-sdk/client-rekognition"; // ES Modules import + * // const { RekognitionClient, DetectLabelsCommand } = require("@aws-sdk/client-rekognition"); // CommonJS import + * const client = new RekognitionClient(config); + * const command = new DetectLabelsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DetectLabelsCommandInput} for command's `input` shape. + * @see {@link DetectLabelsCommandOutput} for command's `response` shape. + * @see {@link RekognitionClientResolvedConfig | config} for command's `input` shape. + * */ export class DetectLabelsCommand extends $Command< DetectLabelsCommandInput, diff --git a/clients/client-rekognition/commands/DetectModerationLabelsCommand.ts b/clients/client-rekognition/commands/DetectModerationLabelsCommand.ts index edab0b54a7c7..3ecaaa5d6cd7 100644 --- a/clients/client-rekognition/commands/DetectModerationLabelsCommand.ts +++ b/clients/client-rekognition/commands/DetectModerationLabelsCommand.ts @@ -35,6 +35,20 @@ export interface DetectModerationLabelsCommandOutput extends DetectModerationLab * AWS * CLI to call Amazon Rekognition operations, passing image bytes is not * supported. The image must be either a PNG or JPEG formatted file.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { RekognitionClient, DetectModerationLabelsCommand } from "@aws-sdk/client-rekognition"; // ES Modules import + * // const { RekognitionClient, DetectModerationLabelsCommand } = require("@aws-sdk/client-rekognition"); // CommonJS import + * const client = new RekognitionClient(config); + * const command = new DetectModerationLabelsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DetectModerationLabelsCommandInput} for command's `input` shape. + * @see {@link DetectModerationLabelsCommandOutput} for command's `response` shape. + * @see {@link RekognitionClientResolvedConfig | config} for command's `input` shape. + * */ export class DetectModerationLabelsCommand extends $Command< DetectModerationLabelsCommandInput, diff --git a/clients/client-rekognition/commands/DetectProtectiveEquipmentCommand.ts b/clients/client-rekognition/commands/DetectProtectiveEquipmentCommand.ts index c89668c68626..05e83ce503bf 100644 --- a/clients/client-rekognition/commands/DetectProtectiveEquipmentCommand.ts +++ b/clients/client-rekognition/commands/DetectProtectiveEquipmentCommand.ts @@ -61,6 +61,20 @@ export interface DetectProtectiveEquipmentCommandOutput extends DetectProtective *

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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { RekognitionClient, DetectProtectiveEquipmentCommand } from "@aws-sdk/client-rekognition"; // ES Modules import + * // const { RekognitionClient, DetectProtectiveEquipmentCommand } = require("@aws-sdk/client-rekognition"); // CommonJS import + * const client = new RekognitionClient(config); + * const command = new DetectProtectiveEquipmentCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DetectProtectiveEquipmentCommandInput} for command's `input` shape. + * @see {@link DetectProtectiveEquipmentCommandOutput} for command's `response` shape. + * @see {@link RekognitionClientResolvedConfig | config} for command's `input` shape. + * */ export class DetectProtectiveEquipmentCommand extends $Command< DetectProtectiveEquipmentCommandInput, diff --git a/clients/client-rekognition/commands/DetectTextCommand.ts b/clients/client-rekognition/commands/DetectTextCommand.ts index cd446a9dada6..618ba0fd42b9 100644 --- a/clients/client-rekognition/commands/DetectTextCommand.ts +++ b/clients/client-rekognition/commands/DetectTextCommand.ts @@ -43,6 +43,20 @@ export interface DetectTextCommandOutput extends DetectTextResponse, __MetadataB *

To be detected, text must be within +/- 90 degrees orientation of the horizontal axis.

* *

For more information, see DetectText in the Amazon Rekognition Developer Guide.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { RekognitionClient, DetectTextCommand } from "@aws-sdk/client-rekognition"; // ES Modules import + * // const { RekognitionClient, DetectTextCommand } = require("@aws-sdk/client-rekognition"); // CommonJS import + * const client = new RekognitionClient(config); + * const command = new DetectTextCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DetectTextCommandInput} for command's `input` shape. + * @see {@link DetectTextCommandOutput} for command's `response` shape. + * @see {@link RekognitionClientResolvedConfig | config} for command's `input` shape. + * */ export class DetectTextCommand extends $Command< DetectTextCommandInput, diff --git a/clients/client-rekognition/commands/GetCelebrityInfoCommand.ts b/clients/client-rekognition/commands/GetCelebrityInfoCommand.ts index a4f743bc984f..41e4a4d3d60a 100644 --- a/clients/client-rekognition/commands/GetCelebrityInfoCommand.ts +++ b/clients/client-rekognition/commands/GetCelebrityInfoCommand.ts @@ -29,6 +29,20 @@ export interface GetCelebrityInfoCommandOutput extends GetCelebrityInfoResponse, * the Amazon Rekognition Developer Guide.

*

This operation requires permissions to perform the * rekognition:GetCelebrityInfo action.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { RekognitionClient, GetCelebrityInfoCommand } from "@aws-sdk/client-rekognition"; // ES Modules import + * // const { RekognitionClient, GetCelebrityInfoCommand } = require("@aws-sdk/client-rekognition"); // CommonJS import + * const client = new RekognitionClient(config); + * const command = new GetCelebrityInfoCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetCelebrityInfoCommandInput} for command's `input` shape. + * @see {@link GetCelebrityInfoCommandOutput} for command's `response` shape. + * @see {@link RekognitionClientResolvedConfig | config} for command's `input` shape. + * */ export class GetCelebrityInfoCommand extends $Command< GetCelebrityInfoCommandInput, diff --git a/clients/client-rekognition/commands/GetCelebrityRecognitionCommand.ts b/clients/client-rekognition/commands/GetCelebrityRecognitionCommand.ts index f2ced5fcea4a..f934102b3759 100644 --- a/clients/client-rekognition/commands/GetCelebrityRecognitionCommand.ts +++ b/clients/client-rekognition/commands/GetCelebrityRecognitionCommand.ts @@ -58,6 +58,20 @@ export interface GetCelebrityRecognitionCommandOutput extends GetCelebrityRecogn * 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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { RekognitionClient, GetCelebrityRecognitionCommand } from "@aws-sdk/client-rekognition"; // ES Modules import + * // const { RekognitionClient, GetCelebrityRecognitionCommand } = require("@aws-sdk/client-rekognition"); // CommonJS import + * const client = new RekognitionClient(config); + * const command = new GetCelebrityRecognitionCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetCelebrityRecognitionCommandInput} for command's `input` shape. + * @see {@link GetCelebrityRecognitionCommandOutput} for command's `response` shape. + * @see {@link RekognitionClientResolvedConfig | config} for command's `input` shape. + * */ export class GetCelebrityRecognitionCommand extends $Command< GetCelebrityRecognitionCommandInput, diff --git a/clients/client-rekognition/commands/GetContentModerationCommand.ts b/clients/client-rekognition/commands/GetContentModerationCommand.ts index 4310d85a8d4e..798a2bd037f1 100644 --- a/clients/client-rekognition/commands/GetContentModerationCommand.ts +++ b/clients/client-rekognition/commands/GetContentModerationCommand.ts @@ -50,6 +50,20 @@ export interface GetContentModerationCommandOutput extends GetContentModerationR * returned from the previous call to GetContentModeration.

* *

For more information, see Detecting Unsafe Content in the Amazon Rekognition Developer Guide.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { RekognitionClient, GetContentModerationCommand } from "@aws-sdk/client-rekognition"; // ES Modules import + * // const { RekognitionClient, GetContentModerationCommand } = require("@aws-sdk/client-rekognition"); // CommonJS import + * const client = new RekognitionClient(config); + * const command = new GetContentModerationCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetContentModerationCommandInput} for command's `input` shape. + * @see {@link GetContentModerationCommandOutput} for command's `response` shape. + * @see {@link RekognitionClientResolvedConfig | config} for command's `input` shape. + * */ export class GetContentModerationCommand extends $Command< GetContentModerationCommandInput, diff --git a/clients/client-rekognition/commands/GetFaceDetectionCommand.ts b/clients/client-rekognition/commands/GetFaceDetectionCommand.ts index 2ecbfc686437..fd9510f3fe9e 100644 --- a/clients/client-rekognition/commands/GetFaceDetectionCommand.ts +++ b/clients/client-rekognition/commands/GetFaceDetectionCommand.ts @@ -34,6 +34,20 @@ export interface GetFaceDetectionCommandOutput extends GetFaceDetectionResponse, * 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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { RekognitionClient, GetFaceDetectionCommand } from "@aws-sdk/client-rekognition"; // ES Modules import + * // const { RekognitionClient, GetFaceDetectionCommand } = require("@aws-sdk/client-rekognition"); // CommonJS import + * const client = new RekognitionClient(config); + * const command = new GetFaceDetectionCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetFaceDetectionCommandInput} for command's `input` shape. + * @see {@link GetFaceDetectionCommandOutput} for command's `response` shape. + * @see {@link RekognitionClientResolvedConfig | config} for command's `input` shape. + * */ export class GetFaceDetectionCommand extends $Command< GetFaceDetectionCommandInput, diff --git a/clients/client-rekognition/commands/GetFaceSearchCommand.ts b/clients/client-rekognition/commands/GetFaceSearchCommand.ts index 8948bfd2ba3e..b7f645696147 100644 --- a/clients/client-rekognition/commands/GetFaceSearchCommand.ts +++ b/clients/client-rekognition/commands/GetFaceSearchCommand.ts @@ -53,6 +53,20 @@ export interface GetFaceSearchCommandOutput extends GetFaceSearchResponse, __Met * start of the video, persons are matched. * You can also sort by persons by specifying INDEX for the SORTBY input * parameter.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { RekognitionClient, GetFaceSearchCommand } from "@aws-sdk/client-rekognition"; // ES Modules import + * // const { RekognitionClient, GetFaceSearchCommand } = require("@aws-sdk/client-rekognition"); // CommonJS import + * const client = new RekognitionClient(config); + * const command = new GetFaceSearchCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetFaceSearchCommandInput} for command's `input` shape. + * @see {@link GetFaceSearchCommandOutput} for command's `response` shape. + * @see {@link RekognitionClientResolvedConfig | config} for command's `input` shape. + * */ export class GetFaceSearchCommand extends $Command< GetFaceSearchCommandInput, diff --git a/clients/client-rekognition/commands/GetLabelDetectionCommand.ts b/clients/client-rekognition/commands/GetLabelDetectionCommand.ts index 3dde8cd2ba2b..9e5453cd3db7 100644 --- a/clients/client-rekognition/commands/GetLabelDetectionCommand.ts +++ b/clients/client-rekognition/commands/GetLabelDetectionCommand.ts @@ -42,6 +42,20 @@ export interface GetLabelDetectionCommandOutput extends GetLabelDetectionRespons * 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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { RekognitionClient, GetLabelDetectionCommand } from "@aws-sdk/client-rekognition"; // ES Modules import + * // const { RekognitionClient, GetLabelDetectionCommand } = require("@aws-sdk/client-rekognition"); // CommonJS import + * const client = new RekognitionClient(config); + * const command = new GetLabelDetectionCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetLabelDetectionCommandInput} for command's `input` shape. + * @see {@link GetLabelDetectionCommandOutput} for command's `response` shape. + * @see {@link RekognitionClientResolvedConfig | config} for command's `input` shape. + * */ export class GetLabelDetectionCommand extends $Command< GetLabelDetectionCommandInput, diff --git a/clients/client-rekognition/commands/GetPersonTrackingCommand.ts b/clients/client-rekognition/commands/GetPersonTrackingCommand.ts index 0bc690697d1a..3da5eccb9ae8 100644 --- a/clients/client-rekognition/commands/GetPersonTrackingCommand.ts +++ b/clients/client-rekognition/commands/GetPersonTrackingCommand.ts @@ -51,6 +51,20 @@ export interface GetPersonTrackingCommandOutput extends GetPersonTrackingRespons * 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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { RekognitionClient, GetPersonTrackingCommand } from "@aws-sdk/client-rekognition"; // ES Modules import + * // const { RekognitionClient, GetPersonTrackingCommand } = require("@aws-sdk/client-rekognition"); // CommonJS import + * const client = new RekognitionClient(config); + * const command = new GetPersonTrackingCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetPersonTrackingCommandInput} for command's `input` shape. + * @see {@link GetPersonTrackingCommandOutput} for command's `response` shape. + * @see {@link RekognitionClientResolvedConfig | config} for command's `input` shape. + * */ export class GetPersonTrackingCommand extends $Command< GetPersonTrackingCommandInput, diff --git a/clients/client-rekognition/commands/GetSegmentDetectionCommand.ts b/clients/client-rekognition/commands/GetSegmentDetectionCommand.ts index 9dba9dcac29c..e0b81a9e3427 100644 --- a/clients/client-rekognition/commands/GetSegmentDetectionCommand.ts +++ b/clients/client-rekognition/commands/GetSegmentDetectionCommand.ts @@ -44,6 +44,20 @@ export interface GetSegmentDetectionCommandOutput extends GetSegmentDetectionRes * call to GetSegmentDetection.

* *

For more information, see Detecting Video Segments in Stored Video in the Amazon Rekognition Developer Guide.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { RekognitionClient, GetSegmentDetectionCommand } from "@aws-sdk/client-rekognition"; // ES Modules import + * // const { RekognitionClient, GetSegmentDetectionCommand } = require("@aws-sdk/client-rekognition"); // CommonJS import + * const client = new RekognitionClient(config); + * const command = new GetSegmentDetectionCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetSegmentDetectionCommandInput} for command's `input` shape. + * @see {@link GetSegmentDetectionCommandOutput} for command's `response` shape. + * @see {@link RekognitionClientResolvedConfig | config} for command's `input` shape. + * */ export class GetSegmentDetectionCommand extends $Command< GetSegmentDetectionCommandInput, diff --git a/clients/client-rekognition/commands/GetTextDetectionCommand.ts b/clients/client-rekognition/commands/GetTextDetectionCommand.ts index 4b6801c2bd26..4c4e1ab6dd3d 100644 --- a/clients/client-rekognition/commands/GetTextDetectionCommand.ts +++ b/clients/client-rekognition/commands/GetTextDetectionCommand.ts @@ -40,6 +40,20 @@ export interface GetTextDetectionCommandOutput extends GetTextDetectionResponse, * 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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { RekognitionClient, GetTextDetectionCommand } from "@aws-sdk/client-rekognition"; // ES Modules import + * // const { RekognitionClient, GetTextDetectionCommand } = require("@aws-sdk/client-rekognition"); // CommonJS import + * const client = new RekognitionClient(config); + * const command = new GetTextDetectionCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetTextDetectionCommandInput} for command's `input` shape. + * @see {@link GetTextDetectionCommandOutput} for command's `response` shape. + * @see {@link RekognitionClientResolvedConfig | config} for command's `input` shape. + * */ export class GetTextDetectionCommand extends $Command< GetTextDetectionCommandInput, diff --git a/clients/client-rekognition/commands/IndexFacesCommand.ts b/clients/client-rekognition/commands/IndexFacesCommand.ts index e969c7366749..ba7c5376637e 100644 --- a/clients/client-rekognition/commands/IndexFacesCommand.ts +++ b/clients/client-rekognition/commands/IndexFacesCommand.ts @@ -121,6 +121,20 @@ export interface IndexFacesCommandOutput extends IndexFacesResponse, __MetadataB * 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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { RekognitionClient, IndexFacesCommand } from "@aws-sdk/client-rekognition"; // ES Modules import + * // const { RekognitionClient, IndexFacesCommand } = require("@aws-sdk/client-rekognition"); // CommonJS import + * const client = new RekognitionClient(config); + * const command = new IndexFacesCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link IndexFacesCommandInput} for command's `input` shape. + * @see {@link IndexFacesCommandOutput} for command's `response` shape. + * @see {@link RekognitionClientResolvedConfig | config} for command's `input` shape. + * */ export class IndexFacesCommand extends $Command< IndexFacesCommandInput, diff --git a/clients/client-rekognition/commands/ListCollectionsCommand.ts b/clients/client-rekognition/commands/ListCollectionsCommand.ts index 674b474154e2..66bcd806a20d 100644 --- a/clients/client-rekognition/commands/ListCollectionsCommand.ts +++ b/clients/client-rekognition/commands/ListCollectionsCommand.ts @@ -27,6 +27,20 @@ export interface ListCollectionsCommandOutput extends ListCollectionsResponse, _ * *

For an example, see Listing Collections in the Amazon Rekognition Developer Guide.

*

This operation requires permissions to perform the rekognition:ListCollections action.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { RekognitionClient, ListCollectionsCommand } from "@aws-sdk/client-rekognition"; // ES Modules import + * // const { RekognitionClient, ListCollectionsCommand } = require("@aws-sdk/client-rekognition"); // CommonJS import + * const client = new RekognitionClient(config); + * const command = new ListCollectionsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListCollectionsCommandInput} for command's `input` shape. + * @see {@link ListCollectionsCommandOutput} for command's `response` shape. + * @see {@link RekognitionClientResolvedConfig | config} for command's `input` shape. + * */ export class ListCollectionsCommand extends $Command< ListCollectionsCommandInput, diff --git a/clients/client-rekognition/commands/ListFacesCommand.ts b/clients/client-rekognition/commands/ListFacesCommand.ts index 0e2f4669bae9..1aace2f363ce 100644 --- a/clients/client-rekognition/commands/ListFacesCommand.ts +++ b/clients/client-rekognition/commands/ListFacesCommand.ts @@ -26,6 +26,20 @@ export interface ListFacesCommandOutput extends ListFacesResponse, __MetadataBea * *

This operation requires permissions to perform the * rekognition:ListFaces action.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { RekognitionClient, ListFacesCommand } from "@aws-sdk/client-rekognition"; // ES Modules import + * // const { RekognitionClient, ListFacesCommand } = require("@aws-sdk/client-rekognition"); // CommonJS import + * const client = new RekognitionClient(config); + * const command = new ListFacesCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListFacesCommandInput} for command's `input` shape. + * @see {@link ListFacesCommandOutput} for command's `response` shape. + * @see {@link RekognitionClientResolvedConfig | config} for command's `input` shape. + * */ export class ListFacesCommand extends $Command< ListFacesCommandInput, diff --git a/clients/client-rekognition/commands/ListStreamProcessorsCommand.ts b/clients/client-rekognition/commands/ListStreamProcessorsCommand.ts index f720650cbb92..e87e5eec4675 100644 --- a/clients/client-rekognition/commands/ListStreamProcessorsCommand.ts +++ b/clients/client-rekognition/commands/ListStreamProcessorsCommand.ts @@ -22,6 +22,20 @@ export interface ListStreamProcessorsCommandOutput extends ListStreamProcessorsR /** *

Gets a list of stream processors that you have created with CreateStreamProcessor.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { RekognitionClient, ListStreamProcessorsCommand } from "@aws-sdk/client-rekognition"; // ES Modules import + * // const { RekognitionClient, ListStreamProcessorsCommand } = require("@aws-sdk/client-rekognition"); // CommonJS import + * const client = new RekognitionClient(config); + * const command = new ListStreamProcessorsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListStreamProcessorsCommandInput} for command's `input` shape. + * @see {@link ListStreamProcessorsCommandOutput} for command's `response` shape. + * @see {@link RekognitionClientResolvedConfig | config} for command's `input` shape. + * */ export class ListStreamProcessorsCommand extends $Command< ListStreamProcessorsCommandInput, diff --git a/clients/client-rekognition/commands/ListTagsForResourceCommand.ts b/clients/client-rekognition/commands/ListTagsForResourceCommand.ts index 9d6c7fd32fca..1d2160b55ba0 100644 --- a/clients/client-rekognition/commands/ListTagsForResourceCommand.ts +++ b/clients/client-rekognition/commands/ListTagsForResourceCommand.ts @@ -24,6 +24,20 @@ export interface ListTagsForResourceCommandOutput extends ListTagsForResourceRes *

* Returns a list of tags in an Amazon Rekognition collection, stream processor, or Custom Labels model. *

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { RekognitionClient, ListTagsForResourceCommand } from "@aws-sdk/client-rekognition"; // ES Modules import + * // const { RekognitionClient, ListTagsForResourceCommand } = require("@aws-sdk/client-rekognition"); // CommonJS import + * const client = new RekognitionClient(config); + * const command = new ListTagsForResourceCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListTagsForResourceCommandInput} for command's `input` shape. + * @see {@link ListTagsForResourceCommandOutput} for command's `response` shape. + * @see {@link RekognitionClientResolvedConfig | config} for command's `input` shape. + * */ export class ListTagsForResourceCommand extends $Command< ListTagsForResourceCommandInput, diff --git a/clients/client-rekognition/commands/RecognizeCelebritiesCommand.ts b/clients/client-rekognition/commands/RecognizeCelebritiesCommand.ts index 6b1501f6a40f..a13b1921b0b0 100644 --- a/clients/client-rekognition/commands/RecognizeCelebritiesCommand.ts +++ b/clients/client-rekognition/commands/RecognizeCelebritiesCommand.ts @@ -52,6 +52,20 @@ export interface RecognizeCelebritiesCommandOutput extends RecognizeCelebritiesR *

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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { RekognitionClient, RecognizeCelebritiesCommand } from "@aws-sdk/client-rekognition"; // ES Modules import + * // const { RekognitionClient, RecognizeCelebritiesCommand } = require("@aws-sdk/client-rekognition"); // CommonJS import + * const client = new RekognitionClient(config); + * const command = new RecognizeCelebritiesCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link RecognizeCelebritiesCommandInput} for command's `input` shape. + * @see {@link RecognizeCelebritiesCommandOutput} for command's `response` shape. + * @see {@link RekognitionClientResolvedConfig | config} for command's `input` shape. + * */ export class RecognizeCelebritiesCommand extends $Command< RecognizeCelebritiesCommandInput, diff --git a/clients/client-rekognition/commands/SearchFacesByImageCommand.ts b/clients/client-rekognition/commands/SearchFacesByImageCommand.ts index 4f0bb3f7d4c0..5f5cc0d63b8c 100644 --- a/clients/client-rekognition/commands/SearchFacesByImageCommand.ts +++ b/clients/client-rekognition/commands/SearchFacesByImageCommand.ts @@ -66,6 +66,20 @@ export interface SearchFacesByImageCommandOutput extends SearchFacesByImageRespo * *

This operation requires permissions to perform the rekognition:SearchFacesByImage * action.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { RekognitionClient, SearchFacesByImageCommand } from "@aws-sdk/client-rekognition"; // ES Modules import + * // const { RekognitionClient, SearchFacesByImageCommand } = require("@aws-sdk/client-rekognition"); // CommonJS import + * const client = new RekognitionClient(config); + * const command = new SearchFacesByImageCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link SearchFacesByImageCommandInput} for command's `input` shape. + * @see {@link SearchFacesByImageCommandOutput} for command's `response` shape. + * @see {@link RekognitionClientResolvedConfig | config} for command's `input` shape. + * */ export class SearchFacesByImageCommand extends $Command< SearchFacesByImageCommandInput, diff --git a/clients/client-rekognition/commands/SearchFacesCommand.ts b/clients/client-rekognition/commands/SearchFacesCommand.ts index 156e40c7848b..3b487b6e0dd2 100644 --- a/clients/client-rekognition/commands/SearchFacesCommand.ts +++ b/clients/client-rekognition/commands/SearchFacesCommand.ts @@ -42,6 +42,20 @@ export interface SearchFacesCommandOutput extends SearchFacesResponse, __Metadat * *

This operation requires permissions to perform the rekognition:SearchFaces * action.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { RekognitionClient, SearchFacesCommand } from "@aws-sdk/client-rekognition"; // ES Modules import + * // const { RekognitionClient, SearchFacesCommand } = require("@aws-sdk/client-rekognition"); // CommonJS import + * const client = new RekognitionClient(config); + * const command = new SearchFacesCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link SearchFacesCommandInput} for command's `input` shape. + * @see {@link SearchFacesCommandOutput} for command's `response` shape. + * @see {@link RekognitionClientResolvedConfig | config} for command's `input` shape. + * */ export class SearchFacesCommand extends $Command< SearchFacesCommandInput, diff --git a/clients/client-rekognition/commands/StartCelebrityRecognitionCommand.ts b/clients/client-rekognition/commands/StartCelebrityRecognitionCommand.ts index 005c002d8a3d..34226fffa31a 100644 --- a/clients/client-rekognition/commands/StartCelebrityRecognitionCommand.ts +++ b/clients/client-rekognition/commands/StartCelebrityRecognitionCommand.ts @@ -33,6 +33,20 @@ export interface StartCelebrityRecognitionCommandOutput extends StartCelebrityRe * (JobId) from the initial call to StartCelebrityRecognition.

* *

For more information, see Recognizing Celebrities in the Amazon Rekognition Developer Guide.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { RekognitionClient, StartCelebrityRecognitionCommand } from "@aws-sdk/client-rekognition"; // ES Modules import + * // const { RekognitionClient, StartCelebrityRecognitionCommand } = require("@aws-sdk/client-rekognition"); // CommonJS import + * const client = new RekognitionClient(config); + * const command = new StartCelebrityRecognitionCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link StartCelebrityRecognitionCommandInput} for command's `input` shape. + * @see {@link StartCelebrityRecognitionCommandOutput} for command's `response` shape. + * @see {@link RekognitionClientResolvedConfig | config} for command's `input` shape. + * */ export class StartCelebrityRecognitionCommand extends $Command< StartCelebrityRecognitionCommandInput, diff --git a/clients/client-rekognition/commands/StartContentModerationCommand.ts b/clients/client-rekognition/commands/StartContentModerationCommand.ts index cfe337ed9ab3..10ab3525e3af 100644 --- a/clients/client-rekognition/commands/StartContentModerationCommand.ts +++ b/clients/client-rekognition/commands/StartContentModerationCommand.ts @@ -32,6 +32,20 @@ export interface StartContentModerationCommandOutput extends StartContentModerat * (JobId) from the initial call to StartContentModeration.

* *

For more information, see Detecting Unsafe Content in the Amazon Rekognition Developer Guide.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { RekognitionClient, StartContentModerationCommand } from "@aws-sdk/client-rekognition"; // ES Modules import + * // const { RekognitionClient, StartContentModerationCommand } = require("@aws-sdk/client-rekognition"); // CommonJS import + * const client = new RekognitionClient(config); + * const command = new StartContentModerationCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link StartContentModerationCommandInput} for command's `input` shape. + * @see {@link StartContentModerationCommandOutput} for command's `response` shape. + * @see {@link RekognitionClientResolvedConfig | config} for command's `input` shape. + * */ export class StartContentModerationCommand extends $Command< StartContentModerationCommandInput, diff --git a/clients/client-rekognition/commands/StartFaceDetectionCommand.ts b/clients/client-rekognition/commands/StartFaceDetectionCommand.ts index 22ad78fc9382..66c3cbfa429d 100644 --- a/clients/client-rekognition/commands/StartFaceDetectionCommand.ts +++ b/clients/client-rekognition/commands/StartFaceDetectionCommand.ts @@ -34,6 +34,20 @@ export interface StartFaceDetectionCommandOutput extends StartFaceDetectionRespo * *

For more information, see Detecting Faces in a Stored Video in the * Amazon Rekognition Developer Guide.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { RekognitionClient, StartFaceDetectionCommand } from "@aws-sdk/client-rekognition"; // ES Modules import + * // const { RekognitionClient, StartFaceDetectionCommand } = require("@aws-sdk/client-rekognition"); // CommonJS import + * const client = new RekognitionClient(config); + * const command = new StartFaceDetectionCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link StartFaceDetectionCommandInput} for command's `input` shape. + * @see {@link StartFaceDetectionCommandOutput} for command's `response` shape. + * @see {@link RekognitionClientResolvedConfig | config} for command's `input` shape. + * */ export class StartFaceDetectionCommand extends $Command< StartFaceDetectionCommandInput, diff --git a/clients/client-rekognition/commands/StartFaceSearchCommand.ts b/clients/client-rekognition/commands/StartFaceSearchCommand.ts index 98c52fffbed3..e91d677ed69e 100644 --- a/clients/client-rekognition/commands/StartFaceSearchCommand.ts +++ b/clients/client-rekognition/commands/StartFaceSearchCommand.ts @@ -31,6 +31,20 @@ export interface StartFaceSearchCommandOutput extends StartFaceSearchResponse, _ * topic is SUCCEEDED. If so, call GetFaceSearch and pass the job identifier * (JobId) from the initial call to StartFaceSearch. For more information, see * procedure-person-search-videos.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { RekognitionClient, StartFaceSearchCommand } from "@aws-sdk/client-rekognition"; // ES Modules import + * // const { RekognitionClient, StartFaceSearchCommand } = require("@aws-sdk/client-rekognition"); // CommonJS import + * const client = new RekognitionClient(config); + * const command = new StartFaceSearchCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link StartFaceSearchCommandInput} for command's `input` shape. + * @see {@link StartFaceSearchCommandOutput} for command's `response` shape. + * @see {@link RekognitionClientResolvedConfig | config} for command's `input` shape. + * */ export class StartFaceSearchCommand extends $Command< StartFaceSearchCommandInput, diff --git a/clients/client-rekognition/commands/StartLabelDetectionCommand.ts b/clients/client-rekognition/commands/StartLabelDetectionCommand.ts index a6fff842de83..543dd941f112 100644 --- a/clients/client-rekognition/commands/StartLabelDetectionCommand.ts +++ b/clients/client-rekognition/commands/StartLabelDetectionCommand.ts @@ -36,6 +36,20 @@ export interface StartLabelDetectionCommandOutput extends StartLabelDetectionRes * topic is SUCCEEDED. If so, call GetLabelDetection and pass the job identifier * (JobId) from the initial call to StartLabelDetection.

*

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { RekognitionClient, StartLabelDetectionCommand } from "@aws-sdk/client-rekognition"; // ES Modules import + * // const { RekognitionClient, StartLabelDetectionCommand } = require("@aws-sdk/client-rekognition"); // CommonJS import + * const client = new RekognitionClient(config); + * const command = new StartLabelDetectionCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link StartLabelDetectionCommandInput} for command's `input` shape. + * @see {@link StartLabelDetectionCommandOutput} for command's `response` shape. + * @see {@link RekognitionClientResolvedConfig | config} for command's `input` shape. + * */ export class StartLabelDetectionCommand extends $Command< StartLabelDetectionCommandInput, diff --git a/clients/client-rekognition/commands/StartPersonTrackingCommand.ts b/clients/client-rekognition/commands/StartPersonTrackingCommand.ts index d91bceec0623..e5c7bef89774 100644 --- a/clients/client-rekognition/commands/StartPersonTrackingCommand.ts +++ b/clients/client-rekognition/commands/StartPersonTrackingCommand.ts @@ -30,6 +30,20 @@ export interface StartPersonTrackingCommandOutput extends StartPersonTrackingRes *

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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { RekognitionClient, StartPersonTrackingCommand } from "@aws-sdk/client-rekognition"; // ES Modules import + * // const { RekognitionClient, StartPersonTrackingCommand } = require("@aws-sdk/client-rekognition"); // CommonJS import + * const client = new RekognitionClient(config); + * const command = new StartPersonTrackingCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link StartPersonTrackingCommandInput} for command's `input` shape. + * @see {@link StartPersonTrackingCommandOutput} for command's `response` shape. + * @see {@link RekognitionClientResolvedConfig | config} for command's `input` shape. + * */ export class StartPersonTrackingCommand extends $Command< StartPersonTrackingCommandInput, diff --git a/clients/client-rekognition/commands/StartProjectVersionCommand.ts b/clients/client-rekognition/commands/StartProjectVersionCommand.ts index 1cb88b7c15cd..cb24fcf4c99c 100644 --- a/clients/client-rekognition/commands/StartProjectVersionCommand.ts +++ b/clients/client-rekognition/commands/StartProjectVersionCommand.ts @@ -31,6 +31,20 @@ export interface StartProjectVersionCommandOutput extends StartProjectVersionRes * *

This operation requires permissions to perform the * rekognition:StartProjectVersion action.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { RekognitionClient, StartProjectVersionCommand } from "@aws-sdk/client-rekognition"; // ES Modules import + * // const { RekognitionClient, StartProjectVersionCommand } = require("@aws-sdk/client-rekognition"); // CommonJS import + * const client = new RekognitionClient(config); + * const command = new StartProjectVersionCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link StartProjectVersionCommandInput} for command's `input` shape. + * @see {@link StartProjectVersionCommandOutput} for command's `response` shape. + * @see {@link RekognitionClientResolvedConfig | config} for command's `input` shape. + * */ export class StartProjectVersionCommand extends $Command< StartProjectVersionCommandInput, diff --git a/clients/client-rekognition/commands/StartSegmentDetectionCommand.ts b/clients/client-rekognition/commands/StartSegmentDetectionCommand.ts index c49086d15ffd..513308e9e5c6 100644 --- a/clients/client-rekognition/commands/StartSegmentDetectionCommand.ts +++ b/clients/client-rekognition/commands/StartSegmentDetectionCommand.ts @@ -37,6 +37,20 @@ export interface StartSegmentDetectionCommandOutput extends StartSegmentDetectio * * *

For more information, see Detecting Video Segments in Stored Video in the Amazon Rekognition Developer Guide.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { RekognitionClient, StartSegmentDetectionCommand } from "@aws-sdk/client-rekognition"; // ES Modules import + * // const { RekognitionClient, StartSegmentDetectionCommand } = require("@aws-sdk/client-rekognition"); // CommonJS import + * const client = new RekognitionClient(config); + * const command = new StartSegmentDetectionCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link StartSegmentDetectionCommandInput} for command's `input` shape. + * @see {@link StartSegmentDetectionCommandOutput} for command's `response` shape. + * @see {@link RekognitionClientResolvedConfig | config} for command's `input` shape. + * */ export class StartSegmentDetectionCommand extends $Command< StartSegmentDetectionCommandInput, diff --git a/clients/client-rekognition/commands/StartStreamProcessorCommand.ts b/clients/client-rekognition/commands/StartStreamProcessorCommand.ts index 6c18af767595..1f3561a1922d 100644 --- a/clients/client-rekognition/commands/StartStreamProcessorCommand.ts +++ b/clients/client-rekognition/commands/StartStreamProcessorCommand.ts @@ -24,6 +24,20 @@ export interface StartStreamProcessorCommandOutput extends StartStreamProcessorR *

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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { RekognitionClient, StartStreamProcessorCommand } from "@aws-sdk/client-rekognition"; // ES Modules import + * // const { RekognitionClient, StartStreamProcessorCommand } = require("@aws-sdk/client-rekognition"); // CommonJS import + * const client = new RekognitionClient(config); + * const command = new StartStreamProcessorCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link StartStreamProcessorCommandInput} for command's `input` shape. + * @see {@link StartStreamProcessorCommandOutput} for command's `response` shape. + * @see {@link RekognitionClientResolvedConfig | config} for command's `input` shape. + * */ export class StartStreamProcessorCommand extends $Command< StartStreamProcessorCommandInput, diff --git a/clients/client-rekognition/commands/StartTextDetectionCommand.ts b/clients/client-rekognition/commands/StartTextDetectionCommand.ts index 62ad1dbc4348..4f6d5b9b43ca 100644 --- a/clients/client-rekognition/commands/StartTextDetectionCommand.ts +++ b/clients/client-rekognition/commands/StartTextDetectionCommand.ts @@ -29,6 +29,20 @@ export interface StartTextDetectionCommandOutput extends StartTextDetectionRespo *

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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { RekognitionClient, StartTextDetectionCommand } from "@aws-sdk/client-rekognition"; // ES Modules import + * // const { RekognitionClient, StartTextDetectionCommand } = require("@aws-sdk/client-rekognition"); // CommonJS import + * const client = new RekognitionClient(config); + * const command = new StartTextDetectionCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link StartTextDetectionCommandInput} for command's `input` shape. + * @see {@link StartTextDetectionCommandOutput} for command's `response` shape. + * @see {@link RekognitionClientResolvedConfig | config} for command's `input` shape. + * */ export class StartTextDetectionCommand extends $Command< StartTextDetectionCommandInput, diff --git a/clients/client-rekognition/commands/StopProjectVersionCommand.ts b/clients/client-rekognition/commands/StopProjectVersionCommand.ts index 6ff984513f12..47b6e5be159a 100644 --- a/clients/client-rekognition/commands/StopProjectVersionCommand.ts +++ b/clients/client-rekognition/commands/StopProjectVersionCommand.ts @@ -23,6 +23,20 @@ export interface StopProjectVersionCommandOutput extends StopProjectVersionRespo /** *

Stops a running model. The operation might take a while to complete. To * check the current status, call DescribeProjectVersions.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { RekognitionClient, StopProjectVersionCommand } from "@aws-sdk/client-rekognition"; // ES Modules import + * // const { RekognitionClient, StopProjectVersionCommand } = require("@aws-sdk/client-rekognition"); // CommonJS import + * const client = new RekognitionClient(config); + * const command = new StopProjectVersionCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link StopProjectVersionCommandInput} for command's `input` shape. + * @see {@link StopProjectVersionCommandOutput} for command's `response` shape. + * @see {@link RekognitionClientResolvedConfig | config} for command's `input` shape. + * */ export class StopProjectVersionCommand extends $Command< StopProjectVersionCommandInput, diff --git a/clients/client-rekognition/commands/StopStreamProcessorCommand.ts b/clients/client-rekognition/commands/StopStreamProcessorCommand.ts index 8a5f2ad3a0c5..7e4c6de8c319 100644 --- a/clients/client-rekognition/commands/StopStreamProcessorCommand.ts +++ b/clients/client-rekognition/commands/StopStreamProcessorCommand.ts @@ -22,6 +22,20 @@ export interface StopStreamProcessorCommandOutput extends StopStreamProcessorRes /** *

Stops a running stream processor that was created by CreateStreamProcessor.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { RekognitionClient, StopStreamProcessorCommand } from "@aws-sdk/client-rekognition"; // ES Modules import + * // const { RekognitionClient, StopStreamProcessorCommand } = require("@aws-sdk/client-rekognition"); // CommonJS import + * const client = new RekognitionClient(config); + * const command = new StopStreamProcessorCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link StopStreamProcessorCommandInput} for command's `input` shape. + * @see {@link StopStreamProcessorCommandOutput} for command's `response` shape. + * @see {@link RekognitionClientResolvedConfig | config} for command's `input` shape. + * */ export class StopStreamProcessorCommand extends $Command< StopStreamProcessorCommandInput, diff --git a/clients/client-rekognition/commands/TagResourceCommand.ts b/clients/client-rekognition/commands/TagResourceCommand.ts index 4b5f5dacf3b5..9e9e436444c5 100644 --- a/clients/client-rekognition/commands/TagResourceCommand.ts +++ b/clients/client-rekognition/commands/TagResourceCommand.ts @@ -24,6 +24,20 @@ export interface TagResourceCommandOutput extends TagResourceResponse, __Metadat *

* 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. *

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { RekognitionClient, TagResourceCommand } from "@aws-sdk/client-rekognition"; // ES Modules import + * // const { RekognitionClient, TagResourceCommand } = require("@aws-sdk/client-rekognition"); // CommonJS import + * const client = new RekognitionClient(config); + * const command = new TagResourceCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link TagResourceCommandInput} for command's `input` shape. + * @see {@link TagResourceCommandOutput} for command's `response` shape. + * @see {@link RekognitionClientResolvedConfig | config} for command's `input` shape. + * */ export class TagResourceCommand extends $Command< TagResourceCommandInput, diff --git a/clients/client-rekognition/commands/UntagResourceCommand.ts b/clients/client-rekognition/commands/UntagResourceCommand.ts index afa59e826416..5b001e0084a9 100644 --- a/clients/client-rekognition/commands/UntagResourceCommand.ts +++ b/clients/client-rekognition/commands/UntagResourceCommand.ts @@ -24,6 +24,20 @@ export interface UntagResourceCommandOutput extends UntagResourceResponse, __Met *

* Removes one or more tags from an Amazon Rekognition collection, stream processor, or Custom Labels model. *

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { RekognitionClient, UntagResourceCommand } from "@aws-sdk/client-rekognition"; // ES Modules import + * // const { RekognitionClient, UntagResourceCommand } = require("@aws-sdk/client-rekognition"); // CommonJS import + * const client = new RekognitionClient(config); + * const command = new UntagResourceCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link UntagResourceCommandInput} for command's `input` shape. + * @see {@link UntagResourceCommandOutput} for command's `response` shape. + * @see {@link RekognitionClientResolvedConfig | config} for command's `input` shape. + * */ export class UntagResourceCommand extends $Command< UntagResourceCommandInput, diff --git a/clients/client-rekognition/models/models_0.ts b/clients/client-rekognition/models/models_0.ts index 0752e11b99d8..5f5207305418 100644 --- a/clients/client-rekognition/models/models_0.ts +++ b/clients/client-rekognition/models/models_0.ts @@ -16,6 +16,9 @@ export interface AccessDeniedException extends __SmithyException, $MetadataBeare } export namespace AccessDeniedException { + /** + * @internal + */ export const filterSensitiveLog = (obj: AccessDeniedException): any => ({ ...obj, }); @@ -40,6 +43,9 @@ export interface AgeRange { } export namespace AgeRange { + /** + * @internal + */ export const filterSensitiveLog = (obj: AgeRange): any => ({ ...obj, }); @@ -72,6 +78,9 @@ export interface S3Object { } export namespace S3Object { + /** + * @internal + */ export const filterSensitiveLog = (obj: S3Object): any => ({ ...obj, }); @@ -95,6 +104,9 @@ export interface GroundTruthManifest { } export namespace GroundTruthManifest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GroundTruthManifest): any => ({ ...obj, }); @@ -114,6 +126,9 @@ export interface Asset { } export namespace Asset { + /** + * @internal + */ export const filterSensitiveLog = (obj: Asset): any => ({ ...obj, }); @@ -151,6 +166,9 @@ export interface AudioMetadata { } export namespace AudioMetadata { + /** + * @internal + */ export const filterSensitiveLog = (obj: AudioMetadata): any => ({ ...obj, }); @@ -173,6 +191,9 @@ export interface Beard { } export namespace Beard { + /** + * @internal + */ export const filterSensitiveLog = (obj: Beard): any => ({ ...obj, }); @@ -228,6 +249,9 @@ export interface BoundingBox { } export namespace BoundingBox { + /** + * @internal + */ export const filterSensitiveLog = (obj: BoundingBox): any => ({ ...obj, }); @@ -250,6 +274,9 @@ export interface CoversBodyPart { } export namespace CoversBodyPart { + /** + * @internal + */ export const filterSensitiveLog = (obj: CoversBodyPart): any => ({ ...obj, }); @@ -289,6 +316,9 @@ export interface EquipmentDetection { } export namespace EquipmentDetection { + /** + * @internal + */ export const filterSensitiveLog = (obj: EquipmentDetection): any => ({ ...obj, }); @@ -318,6 +348,9 @@ export interface ProtectiveEquipmentBodyPart { } export namespace ProtectiveEquipmentBodyPart { + /** + * @internal + */ export const filterSensitiveLog = (obj: ProtectiveEquipmentBodyPart): any => ({ ...obj, }); @@ -381,6 +414,9 @@ export interface Landmark { } export namespace Landmark { + /** + * @internal + */ export const filterSensitiveLog = (obj: Landmark): any => ({ ...obj, }); @@ -407,6 +443,9 @@ export interface Pose { } export namespace Pose { + /** + * @internal + */ export const filterSensitiveLog = (obj: Pose): any => ({ ...obj, }); @@ -430,6 +469,9 @@ export interface ImageQuality { } export namespace ImageQuality { + /** + * @internal + */ export const filterSensitiveLog = (obj: ImageQuality): any => ({ ...obj, }); @@ -467,6 +509,9 @@ export interface ComparedFace { } export namespace ComparedFace { + /** + * @internal + */ export const filterSensitiveLog = (obj: ComparedFace): any => ({ ...obj, }); @@ -506,6 +551,9 @@ export interface Celebrity { } export namespace Celebrity { + /** + * @internal + */ export const filterSensitiveLog = (obj: Celebrity): any => ({ ...obj, }); @@ -541,6 +589,9 @@ export interface Emotion { } export namespace Emotion { + /** + * @internal + */ export const filterSensitiveLog = (obj: Emotion): any => ({ ...obj, }); @@ -563,6 +614,9 @@ export interface Eyeglasses { } export namespace Eyeglasses { + /** + * @internal + */ export const filterSensitiveLog = (obj: Eyeglasses): any => ({ ...obj, }); @@ -585,6 +639,9 @@ export interface EyeOpen { } export namespace EyeOpen { + /** + * @internal + */ export const filterSensitiveLog = (obj: EyeOpen): any => ({ ...obj, }); @@ -623,6 +680,9 @@ export interface Gender { } export namespace Gender { + /** + * @internal + */ export const filterSensitiveLog = (obj: Gender): any => ({ ...obj, }); @@ -645,6 +705,9 @@ export interface MouthOpen { } export namespace MouthOpen { + /** + * @internal + */ export const filterSensitiveLog = (obj: MouthOpen): any => ({ ...obj, }); @@ -667,6 +730,9 @@ export interface Mustache { } export namespace Mustache { + /** + * @internal + */ export const filterSensitiveLog = (obj: Mustache): any => ({ ...obj, }); @@ -689,6 +755,9 @@ export interface Smile { } export namespace Smile { + /** + * @internal + */ export const filterSensitiveLog = (obj: Smile): any => ({ ...obj, }); @@ -711,6 +780,9 @@ export interface Sunglasses { } export namespace Sunglasses { + /** + * @internal + */ export const filterSensitiveLog = (obj: Sunglasses): any => ({ ...obj, }); @@ -832,6 +904,9 @@ export interface FaceDetail { } export namespace FaceDetail { + /** + * @internal + */ export const filterSensitiveLog = (obj: FaceDetail): any => ({ ...obj, }); @@ -873,6 +948,9 @@ export interface CelebrityDetail { } export namespace CelebrityDetail { + /** + * @internal + */ export const filterSensitiveLog = (obj: CelebrityDetail): any => ({ ...obj, }); @@ -895,6 +973,9 @@ export interface CelebrityRecognition { } export namespace CelebrityRecognition { + /** + * @internal + */ export const filterSensitiveLog = (obj: CelebrityRecognition): any => ({ ...obj, }); @@ -924,6 +1005,9 @@ export interface ComparedSourceImageFace { } export namespace ComparedSourceImageFace { + /** + * @internal + */ export const filterSensitiveLog = (obj: ComparedSourceImageFace): any => ({ ...obj, }); @@ -975,6 +1059,9 @@ export interface Image { } export namespace Image { + /** + * @internal + */ export const filterSensitiveLog = (obj: Image): any => ({ ...obj, }); @@ -1026,6 +1113,9 @@ export interface CompareFacesRequest { } export namespace CompareFacesRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: CompareFacesRequest): any => ({ ...obj, }); @@ -1051,6 +1141,9 @@ export interface CompareFacesMatch { } export namespace CompareFacesMatch { + /** + * @internal + */ export const filterSensitiveLog = (obj: CompareFacesMatch): any => ({ ...obj, }); @@ -1113,6 +1206,9 @@ export interface CompareFacesResponse { } export namespace CompareFacesResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: CompareFacesResponse): any => ({ ...obj, }); @@ -1135,6 +1231,9 @@ export interface ImageTooLargeException extends __SmithyException, $MetadataBear } export namespace ImageTooLargeException { + /** + * @internal + */ export const filterSensitiveLog = (obj: ImageTooLargeException): any => ({ ...obj, }); @@ -1155,6 +1254,9 @@ export interface InternalServerError extends __SmithyException, $MetadataBearer } export namespace InternalServerError { + /** + * @internal + */ export const filterSensitiveLog = (obj: InternalServerError): any => ({ ...obj, }); @@ -1175,6 +1277,9 @@ export interface InvalidImageFormatException extends __SmithyException, $Metadat } export namespace InvalidImageFormatException { + /** + * @internal + */ export const filterSensitiveLog = (obj: InvalidImageFormatException): any => ({ ...obj, }); @@ -1196,6 +1301,9 @@ export interface InvalidParameterException extends __SmithyException, $MetadataB } export namespace InvalidParameterException { + /** + * @internal + */ export const filterSensitiveLog = (obj: InvalidParameterException): any => ({ ...obj, }); @@ -1216,6 +1324,9 @@ export interface InvalidS3ObjectException extends __SmithyException, $MetadataBe } export namespace InvalidS3ObjectException { + /** + * @internal + */ export const filterSensitiveLog = (obj: InvalidS3ObjectException): any => ({ ...obj, }); @@ -1237,6 +1348,9 @@ export interface ProvisionedThroughputExceededException extends __SmithyExceptio } export namespace ProvisionedThroughputExceededException { + /** + * @internal + */ export const filterSensitiveLog = (obj: ProvisionedThroughputExceededException): any => ({ ...obj, }); @@ -1257,6 +1371,9 @@ export interface ThrottlingException extends __SmithyException, $MetadataBearer } export namespace ThrottlingException { + /** + * @internal + */ export const filterSensitiveLog = (obj: ThrottlingException): any => ({ ...obj, }); @@ -1295,6 +1412,9 @@ export interface ModerationLabel { } export namespace ModerationLabel { + /** + * @internal + */ export const filterSensitiveLog = (obj: ModerationLabel): any => ({ ...obj, }); @@ -1316,6 +1436,9 @@ export interface ContentModerationDetection { } export namespace ContentModerationDetection { + /** + * @internal + */ export const filterSensitiveLog = (obj: ContentModerationDetection): any => ({ ...obj, }); @@ -1341,6 +1464,9 @@ export interface CreateCollectionRequest { } export namespace CreateCollectionRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateCollectionRequest): any => ({ ...obj, }); @@ -1365,6 +1491,9 @@ export interface CreateCollectionResponse { } export namespace CreateCollectionResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateCollectionResponse): any => ({ ...obj, }); @@ -1385,6 +1514,9 @@ export interface ResourceAlreadyExistsException extends __SmithyException, $Meta } export namespace ResourceAlreadyExistsException { + /** + * @internal + */ export const filterSensitiveLog = (obj: ResourceAlreadyExistsException): any => ({ ...obj, }); @@ -1409,6 +1541,9 @@ export interface ServiceQuotaExceededException extends __SmithyException, $Metad } export namespace ServiceQuotaExceededException { + /** + * @internal + */ export const filterSensitiveLog = (obj: ServiceQuotaExceededException): any => ({ ...obj, }); @@ -1422,6 +1557,9 @@ export interface CreateProjectRequest { } export namespace CreateProjectRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateProjectRequest): any => ({ ...obj, }); @@ -1436,6 +1574,9 @@ export interface CreateProjectResponse { } export namespace CreateProjectResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateProjectResponse): any => ({ ...obj, }); @@ -1458,6 +1599,9 @@ export interface LimitExceededException extends __SmithyException, $MetadataBear } export namespace LimitExceededException { + /** + * @internal + */ export const filterSensitiveLog = (obj: LimitExceededException): any => ({ ...obj, }); @@ -1478,6 +1622,9 @@ export interface ResourceInUseException extends __SmithyException, $MetadataBear } export namespace ResourceInUseException { + /** + * @internal + */ export const filterSensitiveLog = (obj: ResourceInUseException): any => ({ ...obj, }); @@ -1499,6 +1646,9 @@ export interface OutputConfig { } export namespace OutputConfig { + /** + * @internal + */ export const filterSensitiveLog = (obj: OutputConfig): any => ({ ...obj, }); @@ -1521,6 +1671,9 @@ export interface TestingData { } export namespace TestingData { + /** + * @internal + */ export const filterSensitiveLog = (obj: TestingData): any => ({ ...obj, }); @@ -1537,6 +1690,9 @@ export interface TrainingData { } export namespace TrainingData { + /** + * @internal + */ export const filterSensitiveLog = (obj: TrainingData): any => ({ ...obj, }); @@ -1578,6 +1734,9 @@ export interface CreateProjectVersionRequest { } export namespace CreateProjectVersionRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateProjectVersionRequest): any => ({ ...obj, }); @@ -1592,6 +1751,9 @@ export interface CreateProjectVersionResponse { } export namespace CreateProjectVersionResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateProjectVersionResponse): any => ({ ...obj, }); @@ -1612,6 +1774,9 @@ export interface ResourceNotFoundException extends __SmithyException, $MetadataB } export namespace ResourceNotFoundException { + /** + * @internal + */ export const filterSensitiveLog = (obj: ResourceNotFoundException): any => ({ ...obj, }); @@ -1629,6 +1794,9 @@ export interface KinesisVideoStream { } export namespace KinesisVideoStream { + /** + * @internal + */ export const filterSensitiveLog = (obj: KinesisVideoStream): any => ({ ...obj, }); @@ -1645,6 +1813,9 @@ export interface StreamProcessorInput { } export namespace StreamProcessorInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: StreamProcessorInput): any => ({ ...obj, }); @@ -1662,6 +1833,9 @@ export interface KinesisDataStream { } export namespace KinesisDataStream { + /** + * @internal + */ export const filterSensitiveLog = (obj: KinesisDataStream): any => ({ ...obj, }); @@ -1679,6 +1853,9 @@ export interface StreamProcessorOutput { } export namespace StreamProcessorOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: StreamProcessorOutput): any => ({ ...obj, }); @@ -1702,6 +1879,9 @@ export interface FaceSearchSettings { } export namespace FaceSearchSettings { + /** + * @internal + */ export const filterSensitiveLog = (obj: FaceSearchSettings): any => ({ ...obj, }); @@ -1718,6 +1898,9 @@ export interface StreamProcessorSettings { } export namespace StreamProcessorSettings { + /** + * @internal + */ export const filterSensitiveLog = (obj: StreamProcessorSettings): any => ({ ...obj, }); @@ -1762,6 +1945,9 @@ export interface CreateStreamProcessorRequest { } export namespace CreateStreamProcessorRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateStreamProcessorRequest): any => ({ ...obj, }); @@ -1775,6 +1961,9 @@ export interface CreateStreamProcessorResponse { } export namespace CreateStreamProcessorResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateStreamProcessorResponse): any => ({ ...obj, }); @@ -1803,6 +1992,9 @@ export interface Point { } export namespace Point { + /** + * @internal + */ export const filterSensitiveLog = (obj: Point): any => ({ ...obj, }); @@ -1826,6 +2018,9 @@ export interface Geometry { } export namespace Geometry { + /** + * @internal + */ export const filterSensitiveLog = (obj: Geometry): any => ({ ...obj, }); @@ -1855,6 +2050,9 @@ export interface CustomLabel { } export namespace CustomLabel { + /** + * @internal + */ export const filterSensitiveLog = (obj: CustomLabel): any => ({ ...obj, }); @@ -1868,6 +2066,9 @@ export interface DeleteCollectionRequest { } export namespace DeleteCollectionRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteCollectionRequest): any => ({ ...obj, }); @@ -1881,6 +2082,9 @@ export interface DeleteCollectionResponse { } export namespace DeleteCollectionResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteCollectionResponse): any => ({ ...obj, }); @@ -1899,6 +2103,9 @@ export interface DeleteFacesRequest { } export namespace DeleteFacesRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteFacesRequest): any => ({ ...obj, }); @@ -1912,6 +2119,9 @@ export interface DeleteFacesResponse { } export namespace DeleteFacesResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteFacesResponse): any => ({ ...obj, }); @@ -1925,6 +2135,9 @@ export interface DeleteProjectRequest { } export namespace DeleteProjectRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteProjectRequest): any => ({ ...obj, }); @@ -1944,6 +2157,9 @@ export interface DeleteProjectResponse { } export namespace DeleteProjectResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteProjectResponse): any => ({ ...obj, }); @@ -1957,6 +2173,9 @@ export interface DeleteProjectVersionRequest { } export namespace DeleteProjectVersionRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteProjectVersionRequest): any => ({ ...obj, }); @@ -1982,6 +2201,9 @@ export interface DeleteProjectVersionResponse { } export namespace DeleteProjectVersionResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteProjectVersionResponse): any => ({ ...obj, }); @@ -1995,6 +2217,9 @@ export interface DeleteStreamProcessorRequest { } export namespace DeleteStreamProcessorRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteStreamProcessorRequest): any => ({ ...obj, }); @@ -2003,6 +2228,9 @@ export namespace DeleteStreamProcessorRequest { export interface DeleteStreamProcessorResponse {} export namespace DeleteStreamProcessorResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteStreamProcessorResponse): any => ({ ...obj, }); @@ -2016,6 +2244,9 @@ export interface DescribeCollectionRequest { } export namespace DescribeCollectionRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeCollectionRequest): any => ({ ...obj, }); @@ -2049,6 +2280,9 @@ export interface DescribeCollectionResponse { } export namespace DescribeCollectionResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeCollectionResponse): any => ({ ...obj, }); @@ -2071,6 +2305,9 @@ export interface DescribeProjectsRequest { } export namespace DescribeProjectsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeProjectsRequest): any => ({ ...obj, }); @@ -2097,6 +2334,9 @@ export interface ProjectDescription { } export namespace ProjectDescription { + /** + * @internal + */ export const filterSensitiveLog = (obj: ProjectDescription): any => ({ ...obj, }); @@ -2117,6 +2357,9 @@ export interface DescribeProjectsResponse { } export namespace DescribeProjectsResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeProjectsResponse): any => ({ ...obj, }); @@ -2137,6 +2380,9 @@ export interface InvalidPaginationTokenException extends __SmithyException, $Met } export namespace InvalidPaginationTokenException { + /** + * @internal + */ export const filterSensitiveLog = (obj: InvalidPaginationTokenException): any => ({ ...obj, }); @@ -2172,6 +2418,9 @@ export interface DescribeProjectVersionsRequest { } export namespace DescribeProjectVersionsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeProjectVersionsRequest): any => ({ ...obj, }); @@ -2198,6 +2447,9 @@ export interface Summary { } export namespace Summary { + /** + * @internal + */ export const filterSensitiveLog = (obj: Summary): any => ({ ...obj, }); @@ -2223,6 +2475,9 @@ export interface EvaluationResult { } export namespace EvaluationResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: EvaluationResult): any => ({ ...obj, }); @@ -2250,6 +2505,9 @@ export interface ValidationData { } export namespace ValidationData { + /** + * @internal + */ export const filterSensitiveLog = (obj: ValidationData): any => ({ ...obj, }); @@ -2277,6 +2535,9 @@ export interface TestingDataResult { } export namespace TestingDataResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: TestingDataResult): any => ({ ...obj, }); @@ -2303,6 +2564,9 @@ export interface TrainingDataResult { } export namespace TrainingDataResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: TrainingDataResult): any => ({ ...obj, }); @@ -2377,6 +2641,9 @@ export interface ProjectVersionDescription { } export namespace ProjectVersionDescription { + /** + * @internal + */ export const filterSensitiveLog = (obj: ProjectVersionDescription): any => ({ ...obj, }); @@ -2398,6 +2665,9 @@ export interface DescribeProjectVersionsResponse { } export namespace DescribeProjectVersionsResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeProjectVersionsResponse): any => ({ ...obj, }); @@ -2411,6 +2681,9 @@ export interface DescribeStreamProcessorRequest { } export namespace DescribeStreamProcessorRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeStreamProcessorRequest): any => ({ ...obj, }); @@ -2480,6 +2753,9 @@ export interface DescribeStreamProcessorResponse { } export namespace DescribeStreamProcessorResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeStreamProcessorResponse): any => ({ ...obj, }); @@ -2534,6 +2810,9 @@ export interface DetectCustomLabelsRequest { } export namespace DetectCustomLabelsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DetectCustomLabelsRequest): any => ({ ...obj, }); @@ -2547,6 +2826,9 @@ export interface DetectCustomLabelsResponse { } export namespace DetectCustomLabelsResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DetectCustomLabelsResponse): any => ({ ...obj, }); @@ -2569,6 +2851,9 @@ export interface ResourceNotReadyException extends __SmithyException, $MetadataB } export namespace ResourceNotReadyException { + /** + * @internal + */ export const filterSensitiveLog = (obj: ResourceNotReadyException): any => ({ ...obj, }); @@ -2598,6 +2883,9 @@ export interface DetectFacesRequest { } export namespace DetectFacesRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DetectFacesRequest): any => ({ ...obj, }); @@ -2625,6 +2913,9 @@ export interface DetectFacesResponse { } export namespace DetectFacesResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DetectFacesResponse): any => ({ ...obj, }); @@ -2655,6 +2946,9 @@ export interface DetectionFilter { } export namespace DetectionFilter { + /** + * @internal + */ export const filterSensitiveLog = (obj: DetectionFilter): any => ({ ...obj, }); @@ -2687,6 +2981,9 @@ export interface DetectLabelsRequest { } export namespace DetectLabelsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DetectLabelsRequest): any => ({ ...obj, }); @@ -2709,6 +3006,9 @@ export interface Instance { } export namespace Instance { + /** + * @internal + */ export const filterSensitiveLog = (obj: Instance): any => ({ ...obj, }); @@ -2725,6 +3025,9 @@ export interface Parent { } export namespace Parent { + /** + * @internal + */ export const filterSensitiveLog = (obj: Parent): any => ({ ...obj, }); @@ -2760,6 +3063,9 @@ export interface Label { } export namespace Label { + /** + * @internal + */ export const filterSensitiveLog = (obj: Label): any => ({ ...obj, }); @@ -2792,6 +3098,9 @@ export interface DetectLabelsResponse { } export namespace DetectLabelsResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DetectLabelsResponse): any => ({ ...obj, }); @@ -2809,6 +3118,9 @@ export interface HumanLoopDataAttributes { } export namespace HumanLoopDataAttributes { + /** + * @internal + */ export const filterSensitiveLog = (obj: HumanLoopDataAttributes): any => ({ ...obj, }); @@ -2838,6 +3150,9 @@ export interface HumanLoopConfig { } export namespace HumanLoopConfig { + /** + * @internal + */ export const filterSensitiveLog = (obj: HumanLoopConfig): any => ({ ...obj, }); @@ -2870,6 +3185,9 @@ export interface DetectModerationLabelsRequest { } export namespace DetectModerationLabelsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DetectModerationLabelsRequest): any => ({ ...obj, }); @@ -2898,6 +3216,9 @@ export interface HumanLoopActivationOutput { } export namespace HumanLoopActivationOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: HumanLoopActivationOutput): any => ({ ...obj, }); @@ -2922,6 +3243,9 @@ export interface DetectModerationLabelsResponse { } export namespace DetectModerationLabelsResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DetectModerationLabelsResponse): any => ({ ...obj, }); @@ -2957,6 +3281,9 @@ export interface HumanLoopQuotaExceededException extends __SmithyException, $Met } export namespace HumanLoopQuotaExceededException { + /** + * @internal + */ export const filterSensitiveLog = (obj: HumanLoopQuotaExceededException): any => ({ ...obj, }); @@ -2995,6 +3322,9 @@ export interface ProtectiveEquipmentSummarizationAttributes { } export namespace ProtectiveEquipmentSummarizationAttributes { + /** + * @internal + */ export const filterSensitiveLog = (obj: ProtectiveEquipmentSummarizationAttributes): any => ({ ...obj, }); @@ -3014,6 +3344,9 @@ export interface DetectProtectiveEquipmentRequest { } export namespace DetectProtectiveEquipmentRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DetectProtectiveEquipmentRequest): any => ({ ...obj, }); @@ -3048,6 +3381,9 @@ export interface ProtectiveEquipmentPerson { } export namespace ProtectiveEquipmentPerson { + /** + * @internal + */ export const filterSensitiveLog = (obj: ProtectiveEquipmentPerson): any => ({ ...obj, }); @@ -3093,6 +3429,9 @@ export interface ProtectiveEquipmentSummary { } export namespace ProtectiveEquipmentSummary { + /** + * @internal + */ export const filterSensitiveLog = (obj: ProtectiveEquipmentSummary): any => ({ ...obj, }); @@ -3117,6 +3456,9 @@ export interface DetectProtectiveEquipmentResponse { } export namespace DetectProtectiveEquipmentResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DetectProtectiveEquipmentResponse): any => ({ ...obj, }); @@ -3137,6 +3479,9 @@ export interface RegionOfInterest { } export namespace RegionOfInterest { + /** + * @internal + */ export const filterSensitiveLog = (obj: RegionOfInterest): any => ({ ...obj, }); @@ -3162,6 +3507,9 @@ export interface DetectTextFilters { } export namespace DetectTextFilters { + /** + * @internal + */ export const filterSensitiveLog = (obj: DetectTextFilters): any => ({ ...obj, }); @@ -3184,6 +3532,9 @@ export interface DetectTextRequest { } export namespace DetectTextRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DetectTextRequest): any => ({ ...obj, }); @@ -3244,6 +3595,9 @@ export interface TextDetection { } export namespace TextDetection { + /** + * @internal + */ export const filterSensitiveLog = (obj: TextDetection): any => ({ ...obj, }); @@ -3262,6 +3616,9 @@ export interface DetectTextResponse { } export namespace DetectTextResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DetectTextResponse): any => ({ ...obj, }); @@ -3300,6 +3657,9 @@ export interface Face { } export namespace Face { + /** + * @internal + */ export const filterSensitiveLog = (obj: Face): any => ({ ...obj, }); @@ -3326,6 +3686,9 @@ export interface FaceDetection { } export namespace FaceDetection { + /** + * @internal + */ export const filterSensitiveLog = (obj: FaceDetection): any => ({ ...obj, }); @@ -3349,6 +3712,9 @@ export interface FaceMatch { } export namespace FaceMatch { + /** + * @internal + */ export const filterSensitiveLog = (obj: FaceMatch): any => ({ ...obj, }); @@ -3372,6 +3738,9 @@ export interface FaceRecord { } export namespace FaceRecord { + /** + * @internal + */ export const filterSensitiveLog = (obj: FaceRecord): any => ({ ...obj, }); @@ -3391,6 +3760,9 @@ export interface GetCelebrityInfoRequest { } export namespace GetCelebrityInfoRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetCelebrityInfoRequest): any => ({ ...obj, }); @@ -3409,6 +3781,9 @@ export interface GetCelebrityInfoResponse { } export namespace GetCelebrityInfoResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetCelebrityInfoResponse): any => ({ ...obj, }); @@ -3442,6 +3817,9 @@ export interface GetCelebrityRecognitionRequest { } export namespace GetCelebrityRecognitionRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetCelebrityRecognitionRequest): any => ({ ...obj, }); @@ -3490,6 +3868,9 @@ export interface VideoMetadata { } export namespace VideoMetadata { + /** + * @internal + */ export const filterSensitiveLog = (obj: VideoMetadata): any => ({ ...obj, }); @@ -3525,6 +3906,9 @@ export interface GetCelebrityRecognitionResponse { } export namespace GetCelebrityRecognitionResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetCelebrityRecognitionResponse): any => ({ ...obj, }); @@ -3562,6 +3946,9 @@ export interface GetContentModerationRequest { } export namespace GetContentModerationRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetContentModerationRequest): any => ({ ...obj, }); @@ -3602,6 +3989,9 @@ export interface GetContentModerationResponse { } export namespace GetContentModerationResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetContentModerationResponse): any => ({ ...obj, }); @@ -3628,6 +4018,9 @@ export interface GetFaceDetectionRequest { } export namespace GetFaceDetectionRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetFaceDetectionRequest): any => ({ ...obj, }); @@ -3663,6 +4056,9 @@ export interface GetFaceDetectionResponse { } export namespace GetFaceDetectionResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetFaceDetectionResponse): any => ({ ...obj, }); @@ -3695,6 +4091,9 @@ export interface GetFaceSearchRequest { } export namespace GetFaceSearchRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetFaceSearchRequest): any => ({ ...obj, }); @@ -3721,6 +4120,9 @@ export interface PersonDetail { } export namespace PersonDetail { + /** + * @internal + */ export const filterSensitiveLog = (obj: PersonDetail): any => ({ ...obj, }); @@ -3750,6 +4152,9 @@ export interface PersonMatch { } export namespace PersonMatch { + /** + * @internal + */ export const filterSensitiveLog = (obj: PersonMatch): any => ({ ...obj, }); @@ -3790,6 +4195,9 @@ export interface GetFaceSearchResponse { } export namespace GetFaceSearchResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetFaceSearchResponse): any => ({ ...obj, }); @@ -3831,6 +4239,9 @@ export interface GetLabelDetectionRequest { } export namespace GetLabelDetectionRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetLabelDetectionRequest): any => ({ ...obj, }); @@ -3852,6 +4263,9 @@ export interface LabelDetection { } export namespace LabelDetection { + /** + * @internal + */ export const filterSensitiveLog = (obj: LabelDetection): any => ({ ...obj, }); @@ -3893,6 +4307,9 @@ export interface GetLabelDetectionResponse { } export namespace GetLabelDetectionResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetLabelDetectionResponse): any => ({ ...obj, }); @@ -3933,6 +4350,9 @@ export interface GetPersonTrackingRequest { } export namespace GetPersonTrackingRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetPersonTrackingRequest): any => ({ ...obj, }); @@ -3958,6 +4378,9 @@ export interface PersonDetection { } export namespace PersonDetection { + /** + * @internal + */ export const filterSensitiveLog = (obj: PersonDetection): any => ({ ...obj, }); @@ -3993,6 +4416,9 @@ export interface GetPersonTrackingResponse { } export namespace GetPersonTrackingResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetPersonTrackingResponse): any => ({ ...obj, }); @@ -4018,6 +4444,9 @@ export interface GetSegmentDetectionRequest { } export namespace GetSegmentDetectionRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetSegmentDetectionRequest): any => ({ ...obj, }); @@ -4040,6 +4469,9 @@ export interface ShotSegment { } export namespace ShotSegment { + /** + * @internal + */ export const filterSensitiveLog = (obj: ShotSegment): any => ({ ...obj, }); @@ -4067,6 +4499,9 @@ export interface TechnicalCueSegment { } export namespace TechnicalCueSegment { + /** + * @internal + */ export const filterSensitiveLog = (obj: TechnicalCueSegment): any => ({ ...obj, }); @@ -4138,6 +4573,9 @@ export interface SegmentDetection { } export namespace SegmentDetection { + /** + * @internal + */ export const filterSensitiveLog = (obj: SegmentDetection): any => ({ ...obj, }); @@ -4160,6 +4598,9 @@ export interface SegmentTypeInfo { } export namespace SegmentTypeInfo { + /** + * @internal + */ export const filterSensitiveLog = (obj: SegmentTypeInfo): any => ({ ...obj, }); @@ -4217,6 +4658,9 @@ export interface GetSegmentDetectionResponse { } export namespace GetSegmentDetectionResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetSegmentDetectionResponse): any => ({ ...obj, }); @@ -4242,6 +4686,9 @@ export interface GetTextDetectionRequest { } export namespace GetTextDetectionRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetTextDetectionRequest): any => ({ ...obj, }); @@ -4264,6 +4711,9 @@ export interface TextDetectionResult { } export namespace TextDetectionResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: TextDetectionResult): any => ({ ...obj, }); @@ -4305,6 +4755,9 @@ export interface GetTextDetectionResponse { } export namespace GetTextDetectionResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetTextDetectionResponse): any => ({ ...obj, }); @@ -4326,6 +4779,9 @@ export interface IdempotentParameterMismatchException extends __SmithyException, } export namespace IdempotentParameterMismatchException { + /** + * @internal + */ export const filterSensitiveLog = (obj: IdempotentParameterMismatchException): any => ({ ...obj, }); @@ -4400,6 +4856,9 @@ export interface IndexFacesRequest { } export namespace IndexFacesRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: IndexFacesRequest): any => ({ ...obj, }); @@ -4456,6 +4915,9 @@ export interface UnindexedFace { } export namespace UnindexedFace { + /** + * @internal + */ export const filterSensitiveLog = (obj: UnindexedFace): any => ({ ...obj, }); @@ -4516,6 +4978,9 @@ export interface IndexFacesResponse { } export namespace IndexFacesResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: IndexFacesResponse): any => ({ ...obj, }); @@ -4534,6 +4999,9 @@ export interface ListCollectionsRequest { } export namespace ListCollectionsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListCollectionsRequest): any => ({ ...obj, }); @@ -4560,6 +5028,9 @@ export interface ListCollectionsResponse { } export namespace ListCollectionsResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListCollectionsResponse): any => ({ ...obj, }); @@ -4585,6 +5056,9 @@ export interface ListFacesRequest { } export namespace ListFacesRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListFacesRequest): any => ({ ...obj, }); @@ -4609,6 +5083,9 @@ export interface ListFacesResponse { } export namespace ListFacesResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListFacesResponse): any => ({ ...obj, }); @@ -4628,6 +5105,9 @@ export interface ListStreamProcessorsRequest { } export namespace ListStreamProcessorsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListStreamProcessorsRequest): any => ({ ...obj, }); @@ -4652,6 +5132,9 @@ export interface StreamProcessor { } export namespace StreamProcessor { + /** + * @internal + */ export const filterSensitiveLog = (obj: StreamProcessor): any => ({ ...obj, }); @@ -4671,6 +5154,9 @@ export interface ListStreamProcessorsResponse { } export namespace ListStreamProcessorsResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListStreamProcessorsResponse): any => ({ ...obj, }); @@ -4686,6 +5172,9 @@ export interface ListTagsForResourceRequest { } export namespace ListTagsForResourceRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListTagsForResourceRequest): any => ({ ...obj, }); @@ -4701,6 +5190,9 @@ export interface ListTagsForResourceResponse { } export namespace ListTagsForResourceResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListTagsForResourceResponse): any => ({ ...obj, }); @@ -4723,6 +5215,9 @@ export interface NotificationChannel { } export namespace NotificationChannel { + /** + * @internal + */ export const filterSensitiveLog = (obj: NotificationChannel): any => ({ ...obj, }); @@ -4740,6 +5235,9 @@ export interface RecognizeCelebritiesRequest { } export namespace RecognizeCelebritiesRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: RecognizeCelebritiesRequest): any => ({ ...obj, }); @@ -4775,6 +5273,9 @@ export interface RecognizeCelebritiesResponse { } export namespace RecognizeCelebritiesResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: RecognizeCelebritiesResponse): any => ({ ...obj, }); @@ -4807,6 +5308,9 @@ export interface SearchFacesRequest { } export namespace SearchFacesRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: SearchFacesRequest): any => ({ ...obj, }); @@ -4831,6 +5335,9 @@ export interface SearchFacesResponse { } export namespace SearchFacesResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: SearchFacesResponse): any => ({ ...obj, }); @@ -4884,6 +5391,9 @@ export interface SearchFacesByImageRequest { } export namespace SearchFacesByImageRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: SearchFacesByImageRequest): any => ({ ...obj, }); @@ -4915,6 +5425,9 @@ export interface SearchFacesByImageResponse { } export namespace SearchFacesByImageResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: SearchFacesByImageResponse): any => ({ ...obj, }); @@ -4932,6 +5445,9 @@ export interface Video { } export namespace Video { + /** + * @internal + */ export const filterSensitiveLog = (obj: Video): any => ({ ...obj, }); @@ -4965,6 +5481,9 @@ export interface StartCelebrityRecognitionRequest { } export namespace StartCelebrityRecognitionRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: StartCelebrityRecognitionRequest): any => ({ ...obj, }); @@ -4979,6 +5498,9 @@ export interface StartCelebrityRecognitionResponse { } export namespace StartCelebrityRecognitionResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: StartCelebrityRecognitionResponse): any => ({ ...obj, }); @@ -5000,6 +5522,9 @@ export interface VideoTooLargeException extends __SmithyException, $MetadataBear } export namespace VideoTooLargeException { + /** + * @internal + */ export const filterSensitiveLog = (obj: VideoTooLargeException): any => ({ ...obj, }); @@ -5042,6 +5567,9 @@ export interface StartContentModerationRequest { } export namespace StartContentModerationRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: StartContentModerationRequest): any => ({ ...obj, }); @@ -5056,6 +5584,9 @@ export interface StartContentModerationResponse { } export namespace StartContentModerationResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: StartContentModerationResponse): any => ({ ...obj, }); @@ -5098,6 +5629,9 @@ export interface StartFaceDetectionRequest { } export namespace StartFaceDetectionRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: StartFaceDetectionRequest): any => ({ ...obj, }); @@ -5112,6 +5646,9 @@ export interface StartFaceDetectionResponse { } export namespace StartFaceDetectionResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: StartFaceDetectionResponse): any => ({ ...obj, }); @@ -5154,6 +5691,9 @@ export interface StartFaceSearchRequest { } export namespace StartFaceSearchRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: StartFaceSearchRequest): any => ({ ...obj, }); @@ -5167,6 +5707,9 @@ export interface StartFaceSearchResponse { } export namespace StartFaceSearchResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: StartFaceSearchResponse): any => ({ ...obj, }); @@ -5210,6 +5753,9 @@ export interface StartLabelDetectionRequest { } export namespace StartLabelDetectionRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: StartLabelDetectionRequest): any => ({ ...obj, }); @@ -5224,6 +5770,9 @@ export interface StartLabelDetectionResponse { } export namespace StartLabelDetectionResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: StartLabelDetectionResponse): any => ({ ...obj, }); @@ -5257,6 +5806,9 @@ export interface StartPersonTrackingRequest { } export namespace StartPersonTrackingRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: StartPersonTrackingRequest): any => ({ ...obj, }); @@ -5271,6 +5823,9 @@ export interface StartPersonTrackingResponse { } export namespace StartPersonTrackingResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: StartPersonTrackingResponse): any => ({ ...obj, }); @@ -5293,6 +5848,9 @@ export interface StartProjectVersionRequest { } export namespace StartProjectVersionRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: StartProjectVersionRequest): any => ({ ...obj, }); @@ -5306,6 +5864,9 @@ export interface StartProjectVersionResponse { } export namespace StartProjectVersionResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: StartProjectVersionResponse): any => ({ ...obj, }); @@ -5328,6 +5889,9 @@ export interface StartShotDetectionFilter { } export namespace StartShotDetectionFilter { + /** + * @internal + */ export const filterSensitiveLog = (obj: StartShotDetectionFilter): any => ({ ...obj, }); @@ -5350,6 +5914,9 @@ export interface StartTechnicalCueDetectionFilter { } export namespace StartTechnicalCueDetectionFilter { + /** + * @internal + */ export const filterSensitiveLog = (obj: StartTechnicalCueDetectionFilter): any => ({ ...obj, }); @@ -5373,6 +5940,9 @@ export interface StartSegmentDetectionFilters { } export namespace StartSegmentDetectionFilters { + /** + * @internal + */ export const filterSensitiveLog = (obj: StartSegmentDetectionFilters): any => ({ ...obj, }); @@ -5416,6 +5986,9 @@ export interface StartSegmentDetectionRequest { } export namespace StartSegmentDetectionRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: StartSegmentDetectionRequest): any => ({ ...obj, }); @@ -5430,6 +6003,9 @@ export interface StartSegmentDetectionResponse { } export namespace StartSegmentDetectionResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: StartSegmentDetectionResponse): any => ({ ...obj, }); @@ -5443,6 +6019,9 @@ export interface StartStreamProcessorRequest { } export namespace StartStreamProcessorRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: StartStreamProcessorRequest): any => ({ ...obj, }); @@ -5451,6 +6030,9 @@ export namespace StartStreamProcessorRequest { export interface StartStreamProcessorResponse {} export namespace StartStreamProcessorResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: StartStreamProcessorResponse): any => ({ ...obj, }); @@ -5475,6 +6057,9 @@ export interface StartTextDetectionFilters { } export namespace StartTextDetectionFilters { + /** + * @internal + */ export const filterSensitiveLog = (obj: StartTextDetectionFilters): any => ({ ...obj, }); @@ -5513,6 +6098,9 @@ export interface StartTextDetectionRequest { } export namespace StartTextDetectionRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: StartTextDetectionRequest): any => ({ ...obj, }); @@ -5526,6 +6114,9 @@ export interface StartTextDetectionResponse { } export namespace StartTextDetectionResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: StartTextDetectionResponse): any => ({ ...obj, }); @@ -5540,6 +6131,9 @@ export interface StopProjectVersionRequest { } export namespace StopProjectVersionRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: StopProjectVersionRequest): any => ({ ...obj, }); @@ -5553,6 +6147,9 @@ export interface StopProjectVersionResponse { } export namespace StopProjectVersionResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: StopProjectVersionResponse): any => ({ ...obj, }); @@ -5566,6 +6163,9 @@ export interface StopStreamProcessorRequest { } export namespace StopStreamProcessorRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: StopStreamProcessorRequest): any => ({ ...obj, }); @@ -5574,6 +6174,9 @@ export namespace StopStreamProcessorRequest { export interface StopStreamProcessorResponse {} export namespace StopStreamProcessorResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: StopStreamProcessorResponse): any => ({ ...obj, }); @@ -5596,6 +6199,9 @@ export interface TagResourceRequest { } export namespace TagResourceRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: TagResourceRequest): any => ({ ...obj, }); @@ -5604,6 +6210,9 @@ export namespace TagResourceRequest { export interface TagResourceResponse {} export namespace TagResourceResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: TagResourceResponse): any => ({ ...obj, }); @@ -5626,6 +6235,9 @@ export interface UntagResourceRequest { } export namespace UntagResourceRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: UntagResourceRequest): any => ({ ...obj, }); @@ -5634,6 +6246,9 @@ export namespace UntagResourceRequest { export interface UntagResourceResponse {} export namespace UntagResourceResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: UntagResourceResponse): any => ({ ...obj, }); diff --git a/clients/client-resource-groups-tagging-api/commands/DescribeReportCreationCommand.ts b/clients/client-resource-groups-tagging-api/commands/DescribeReportCreationCommand.ts index a9c28dcaaf40..45b377d78c71 100644 --- a/clients/client-resource-groups-tagging-api/commands/DescribeReportCreationCommand.ts +++ b/clients/client-resource-groups-tagging-api/commands/DescribeReportCreationCommand.ts @@ -28,6 +28,20 @@ export interface DescribeReportCreationCommandOutput extends DescribeReportCreat *

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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ResourceGroupsTaggingAPIClient, DescribeReportCreationCommand } from "@aws-sdk/client-resource-groups-tagging-api"; // ES Modules import + * // const { ResourceGroupsTaggingAPIClient, DescribeReportCreationCommand } = require("@aws-sdk/client-resource-groups-tagging-api"); // CommonJS import + * const client = new ResourceGroupsTaggingAPIClient(config); + * const command = new DescribeReportCreationCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeReportCreationCommandInput} for command's `input` shape. + * @see {@link DescribeReportCreationCommandOutput} for command's `response` shape. + * @see {@link ResourceGroupsTaggingAPIClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeReportCreationCommand extends $Command< DescribeReportCreationCommandInput, diff --git a/clients/client-resource-groups-tagging-api/commands/GetComplianceSummaryCommand.ts b/clients/client-resource-groups-tagging-api/commands/GetComplianceSummaryCommand.ts index 05714d149da6..62146ddf6ed8 100644 --- a/clients/client-resource-groups-tagging-api/commands/GetComplianceSummaryCommand.ts +++ b/clients/client-resource-groups-tagging-api/commands/GetComplianceSummaryCommand.ts @@ -38,6 +38,20 @@ export interface GetComplianceSummaryCommandOutput extends GetComplianceSummaryO * 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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ResourceGroupsTaggingAPIClient, GetComplianceSummaryCommand } from "@aws-sdk/client-resource-groups-tagging-api"; // ES Modules import + * // const { ResourceGroupsTaggingAPIClient, GetComplianceSummaryCommand } = require("@aws-sdk/client-resource-groups-tagging-api"); // CommonJS import + * const client = new ResourceGroupsTaggingAPIClient(config); + * const command = new GetComplianceSummaryCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetComplianceSummaryCommandInput} for command's `input` shape. + * @see {@link GetComplianceSummaryCommandOutput} for command's `response` shape. + * @see {@link ResourceGroupsTaggingAPIClientResolvedConfig | config} for command's `input` shape. + * */ export class GetComplianceSummaryCommand extends $Command< GetComplianceSummaryCommandInput, diff --git a/clients/client-resource-groups-tagging-api/commands/GetResourcesCommand.ts b/clients/client-resource-groups-tagging-api/commands/GetResourcesCommand.ts index 47e873f5ec00..07b6acab3347 100644 --- a/clients/client-resource-groups-tagging-api/commands/GetResourcesCommand.ts +++ b/clients/client-resource-groups-tagging-api/commands/GetResourcesCommand.ts @@ -49,6 +49,20 @@ export interface GetResourcesCommandOutput extends GetResourcesOutput, __Metadat * 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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ResourceGroupsTaggingAPIClient, GetResourcesCommand } from "@aws-sdk/client-resource-groups-tagging-api"; // ES Modules import + * // const { ResourceGroupsTaggingAPIClient, GetResourcesCommand } = require("@aws-sdk/client-resource-groups-tagging-api"); // CommonJS import + * const client = new ResourceGroupsTaggingAPIClient(config); + * const command = new GetResourcesCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetResourcesCommandInput} for command's `input` shape. + * @see {@link GetResourcesCommandOutput} for command's `response` shape. + * @see {@link ResourceGroupsTaggingAPIClientResolvedConfig | config} for command's `input` shape. + * */ export class GetResourcesCommand extends $Command< GetResourcesCommandInput, diff --git a/clients/client-resource-groups-tagging-api/commands/GetTagKeysCommand.ts b/clients/client-resource-groups-tagging-api/commands/GetTagKeysCommand.ts index 5468bf5907fe..37dc5e82be38 100644 --- a/clients/client-resource-groups-tagging-api/commands/GetTagKeysCommand.ts +++ b/clients/client-resource-groups-tagging-api/commands/GetTagKeysCommand.ts @@ -33,6 +33,20 @@ export interface GetTagKeysCommandOutput extends GetTagKeysOutput, __MetadataBea * 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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ResourceGroupsTaggingAPIClient, GetTagKeysCommand } from "@aws-sdk/client-resource-groups-tagging-api"; // ES Modules import + * // const { ResourceGroupsTaggingAPIClient, GetTagKeysCommand } = require("@aws-sdk/client-resource-groups-tagging-api"); // CommonJS import + * const client = new ResourceGroupsTaggingAPIClient(config); + * const command = new GetTagKeysCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetTagKeysCommandInput} for command's `input` shape. + * @see {@link GetTagKeysCommandOutput} for command's `response` shape. + * @see {@link ResourceGroupsTaggingAPIClientResolvedConfig | config} for command's `input` shape. + * */ export class GetTagKeysCommand extends $Command< GetTagKeysCommandInput, diff --git a/clients/client-resource-groups-tagging-api/commands/GetTagValuesCommand.ts b/clients/client-resource-groups-tagging-api/commands/GetTagValuesCommand.ts index 577fa46b0ca3..c17a3b831142 100644 --- a/clients/client-resource-groups-tagging-api/commands/GetTagValuesCommand.ts +++ b/clients/client-resource-groups-tagging-api/commands/GetTagValuesCommand.ts @@ -33,6 +33,20 @@ export interface GetTagValuesCommandOutput extends GetTagValuesOutput, __Metadat * 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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ResourceGroupsTaggingAPIClient, GetTagValuesCommand } from "@aws-sdk/client-resource-groups-tagging-api"; // ES Modules import + * // const { ResourceGroupsTaggingAPIClient, GetTagValuesCommand } = require("@aws-sdk/client-resource-groups-tagging-api"); // CommonJS import + * const client = new ResourceGroupsTaggingAPIClient(config); + * const command = new GetTagValuesCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetTagValuesCommandInput} for command's `input` shape. + * @see {@link GetTagValuesCommandOutput} for command's `response` shape. + * @see {@link ResourceGroupsTaggingAPIClientResolvedConfig | config} for command's `input` shape. + * */ export class GetTagValuesCommand extends $Command< GetTagValuesCommandInput, diff --git a/clients/client-resource-groups-tagging-api/commands/StartReportCreationCommand.ts b/clients/client-resource-groups-tagging-api/commands/StartReportCreationCommand.ts index dff10612d14e..83fb39f83ce4 100644 --- a/clients/client-resource-groups-tagging-api/commands/StartReportCreationCommand.ts +++ b/clients/client-resource-groups-tagging-api/commands/StartReportCreationCommand.ts @@ -34,6 +34,20 @@ export interface StartReportCreationCommandOutput extends StartReportCreationOut *

*

You can call this operation only from the organization's * management account and from the us-east-1 Region.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ResourceGroupsTaggingAPIClient, StartReportCreationCommand } from "@aws-sdk/client-resource-groups-tagging-api"; // ES Modules import + * // const { ResourceGroupsTaggingAPIClient, StartReportCreationCommand } = require("@aws-sdk/client-resource-groups-tagging-api"); // CommonJS import + * const client = new ResourceGroupsTaggingAPIClient(config); + * const command = new StartReportCreationCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link StartReportCreationCommandInput} for command's `input` shape. + * @see {@link StartReportCreationCommandOutput} for command's `response` shape. + * @see {@link ResourceGroupsTaggingAPIClientResolvedConfig | config} for command's `input` shape. + * */ export class StartReportCreationCommand extends $Command< StartReportCreationCommandInput, diff --git a/clients/client-resource-groups-tagging-api/commands/TagResourcesCommand.ts b/clients/client-resource-groups-tagging-api/commands/TagResourcesCommand.ts index 42b0b718b322..9781515aa588 100644 --- a/clients/client-resource-groups-tagging-api/commands/TagResourcesCommand.ts +++ b/clients/client-resource-groups-tagging-api/commands/TagResourcesCommand.ts @@ -53,6 +53,20 @@ export interface TagResourcesCommandOutput extends TagResourcesOutput, __Metadat * administration services. Tags are not intended to be used for private or sensitive * data.

* + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ResourceGroupsTaggingAPIClient, TagResourcesCommand } from "@aws-sdk/client-resource-groups-tagging-api"; // ES Modules import + * // const { ResourceGroupsTaggingAPIClient, TagResourcesCommand } = require("@aws-sdk/client-resource-groups-tagging-api"); // CommonJS import + * const client = new ResourceGroupsTaggingAPIClient(config); + * const command = new TagResourcesCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link TagResourcesCommandInput} for command's `input` shape. + * @see {@link TagResourcesCommandOutput} for command's `response` shape. + * @see {@link ResourceGroupsTaggingAPIClientResolvedConfig | config} for command's `input` shape. + * */ export class TagResourcesCommand extends $Command< TagResourcesCommandInput, diff --git a/clients/client-resource-groups-tagging-api/commands/UntagResourcesCommand.ts b/clients/client-resource-groups-tagging-api/commands/UntagResourcesCommand.ts index 325bf12f7305..ee381939e5fe 100644 --- a/clients/client-resource-groups-tagging-api/commands/UntagResourcesCommand.ts +++ b/clients/client-resource-groups-tagging-api/commands/UntagResourcesCommand.ts @@ -41,6 +41,20 @@ export interface UntagResourcesCommandOutput extends UntagResourcesOutput, __Met * the calling AWS account.

* * + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ResourceGroupsTaggingAPIClient, UntagResourcesCommand } from "@aws-sdk/client-resource-groups-tagging-api"; // ES Modules import + * // const { ResourceGroupsTaggingAPIClient, UntagResourcesCommand } = require("@aws-sdk/client-resource-groups-tagging-api"); // CommonJS import + * const client = new ResourceGroupsTaggingAPIClient(config); + * const command = new UntagResourcesCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link UntagResourcesCommandInput} for command's `input` shape. + * @see {@link UntagResourcesCommandOutput} for command's `response` shape. + * @see {@link ResourceGroupsTaggingAPIClientResolvedConfig | config} for command's `input` shape. + * */ export class UntagResourcesCommand extends $Command< UntagResourcesCommandInput, diff --git a/clients/client-resource-groups-tagging-api/models/models_0.ts b/clients/client-resource-groups-tagging-api/models/models_0.ts index 110824fbc0f6..f9ae0857f6b5 100644 --- a/clients/client-resource-groups-tagging-api/models/models_0.ts +++ b/clients/client-resource-groups-tagging-api/models/models_0.ts @@ -24,6 +24,9 @@ export interface ComplianceDetails { } export namespace ComplianceDetails { + /** + * @internal + */ export const filterSensitiveLog = (obj: ComplianceDetails): any => ({ ...obj, }); @@ -40,6 +43,9 @@ export interface ConcurrentModificationException extends __SmithyException, $Met } export namespace ConcurrentModificationException { + /** + * @internal + */ export const filterSensitiveLog = (obj: ConcurrentModificationException): any => ({ ...obj, }); @@ -74,6 +80,9 @@ export interface ConstraintViolationException extends __SmithyException, $Metada } export namespace ConstraintViolationException { + /** + * @internal + */ export const filterSensitiveLog = (obj: ConstraintViolationException): any => ({ ...obj, }); @@ -82,6 +91,9 @@ export namespace ConstraintViolationException { export interface DescribeReportCreationInput {} export namespace DescribeReportCreationInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeReportCreationInput): any => ({ ...obj, }); @@ -132,6 +144,9 @@ export interface DescribeReportCreationOutput { } export namespace DescribeReportCreationOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeReportCreationOutput): any => ({ ...obj, }); @@ -148,6 +163,9 @@ export interface InternalServiceException extends __SmithyException, $MetadataBe } export namespace InternalServiceException { + /** + * @internal + */ export const filterSensitiveLog = (obj: InternalServiceException): any => ({ ...obj, }); @@ -183,6 +201,9 @@ export interface InvalidParameterException extends __SmithyException, $MetadataB } export namespace InvalidParameterException { + /** + * @internal + */ export const filterSensitiveLog = (obj: InvalidParameterException): any => ({ ...obj, }); @@ -198,6 +219,9 @@ export interface ThrottledException extends __SmithyException, $MetadataBearer { } export namespace ThrottledException { + /** + * @internal + */ export const filterSensitiveLog = (obj: ThrottledException): any => ({ ...obj, }); @@ -263,6 +287,9 @@ export interface FailureInfo { } export namespace FailureInfo { + /** + * @internal + */ export const filterSensitiveLog = (obj: FailureInfo): any => ({ ...obj, }); @@ -347,6 +374,9 @@ export interface GetComplianceSummaryInput { } export namespace GetComplianceSummaryInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetComplianceSummaryInput): any => ({ ...obj, }); @@ -395,6 +425,9 @@ export interface Summary { } export namespace Summary { + /** + * @internal + */ export const filterSensitiveLog = (obj: Summary): any => ({ ...obj, }); @@ -415,6 +448,9 @@ export interface GetComplianceSummaryOutput { } export namespace GetComplianceSummaryOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetComplianceSummaryOutput): any => ({ ...obj, }); @@ -437,6 +473,9 @@ export interface TagFilter { } export namespace TagFilter { + /** + * @internal + */ export const filterSensitiveLog = (obj: TagFilter): any => ({ ...obj, }); @@ -588,6 +627,9 @@ export interface GetResourcesInput { } export namespace GetResourcesInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetResourcesInput): any => ({ ...obj, }); @@ -612,6 +654,9 @@ export interface Tag { } export namespace Tag { + /** + * @internal + */ export const filterSensitiveLog = (obj: Tag): any => ({ ...obj, }); @@ -640,6 +685,9 @@ export interface ResourceTagMapping { } export namespace ResourceTagMapping { + /** + * @internal + */ export const filterSensitiveLog = (obj: ResourceTagMapping): any => ({ ...obj, }); @@ -661,6 +709,9 @@ export interface GetResourcesOutput { } export namespace GetResourcesOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetResourcesOutput): any => ({ ...obj, }); @@ -677,6 +728,9 @@ export interface PaginationTokenExpiredException extends __SmithyException, $Met } export namespace PaginationTokenExpiredException { + /** + * @internal + */ export const filterSensitiveLog = (obj: PaginationTokenExpiredException): any => ({ ...obj, }); @@ -692,6 +746,9 @@ export interface GetTagKeysInput { } export namespace GetTagKeysInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetTagKeysInput): any => ({ ...obj, }); @@ -712,6 +769,9 @@ export interface GetTagKeysOutput { } export namespace GetTagKeysOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetTagKeysOutput): any => ({ ...obj, }); @@ -733,6 +793,9 @@ export interface GetTagValuesInput { } export namespace GetTagValuesInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetTagValuesInput): any => ({ ...obj, }); @@ -754,6 +817,9 @@ export interface GetTagValuesOutput { } export namespace GetTagValuesOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetTagValuesOutput): any => ({ ...obj, }); @@ -772,6 +838,9 @@ export interface StartReportCreationInput { } export namespace StartReportCreationInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: StartReportCreationInput): any => ({ ...obj, }); @@ -780,6 +849,9 @@ export namespace StartReportCreationInput { export interface StartReportCreationOutput {} export namespace StartReportCreationOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: StartReportCreationOutput): any => ({ ...obj, }); @@ -803,6 +875,9 @@ export interface TagResourcesInput { } export namespace TagResourcesInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: TagResourcesInput): any => ({ ...obj, }); @@ -819,6 +894,9 @@ export interface TagResourcesOutput { } export namespace TagResourcesOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: TagResourcesOutput): any => ({ ...obj, }); @@ -842,6 +920,9 @@ export interface UntagResourcesInput { } export namespace UntagResourcesInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: UntagResourcesInput): any => ({ ...obj, }); @@ -858,6 +939,9 @@ export interface UntagResourcesOutput { } export namespace UntagResourcesOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: UntagResourcesOutput): any => ({ ...obj, }); diff --git a/clients/client-resource-groups/commands/CreateGroupCommand.ts b/clients/client-resource-groups/commands/CreateGroupCommand.ts index d56d04b594be..373100a727a5 100644 --- a/clients/client-resource-groups/commands/CreateGroupCommand.ts +++ b/clients/client-resource-groups/commands/CreateGroupCommand.ts @@ -37,6 +37,20 @@ export interface CreateGroupCommandOutput extends CreateGroupOutput, __MetadataB *

* * + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ResourceGroupsClient, CreateGroupCommand } from "@aws-sdk/client-resource-groups"; // ES Modules import + * // const { ResourceGroupsClient, CreateGroupCommand } = require("@aws-sdk/client-resource-groups"); // CommonJS import + * const client = new ResourceGroupsClient(config); + * const command = new CreateGroupCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreateGroupCommandInput} for command's `input` shape. + * @see {@link CreateGroupCommandOutput} for command's `response` shape. + * @see {@link ResourceGroupsClientResolvedConfig | config} for command's `input` shape. + * */ export class CreateGroupCommand extends $Command< CreateGroupCommandInput, diff --git a/clients/client-resource-groups/commands/DeleteGroupCommand.ts b/clients/client-resource-groups/commands/DeleteGroupCommand.ts index 6f0474e4e3e2..82aeeec3ab91 100644 --- a/clients/client-resource-groups/commands/DeleteGroupCommand.ts +++ b/clients/client-resource-groups/commands/DeleteGroupCommand.ts @@ -34,6 +34,20 @@ export interface DeleteGroupCommandOutput extends DeleteGroupOutput, __MetadataB *

* * + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ResourceGroupsClient, DeleteGroupCommand } from "@aws-sdk/client-resource-groups"; // ES Modules import + * // const { ResourceGroupsClient, DeleteGroupCommand } = require("@aws-sdk/client-resource-groups"); // CommonJS import + * const client = new ResourceGroupsClient(config); + * const command = new DeleteGroupCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteGroupCommandInput} for command's `input` shape. + * @see {@link DeleteGroupCommandOutput} for command's `response` shape. + * @see {@link ResourceGroupsClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteGroupCommand extends $Command< DeleteGroupCommandInput, diff --git a/clients/client-resource-groups/commands/GetGroupCommand.ts b/clients/client-resource-groups/commands/GetGroupCommand.ts index 24a54eeda996..a004357786a7 100644 --- a/clients/client-resource-groups/commands/GetGroupCommand.ts +++ b/clients/client-resource-groups/commands/GetGroupCommand.ts @@ -33,6 +33,20 @@ export interface GetGroupCommandOutput extends GetGroupOutput, __MetadataBearer *

* * + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ResourceGroupsClient, GetGroupCommand } from "@aws-sdk/client-resource-groups"; // ES Modules import + * // const { ResourceGroupsClient, GetGroupCommand } = require("@aws-sdk/client-resource-groups"); // CommonJS import + * const client = new ResourceGroupsClient(config); + * const command = new GetGroupCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetGroupCommandInput} for command's `input` shape. + * @see {@link GetGroupCommandOutput} for command's `response` shape. + * @see {@link ResourceGroupsClientResolvedConfig | config} for command's `input` shape. + * */ export class GetGroupCommand extends $Command< GetGroupCommandInput, diff --git a/clients/client-resource-groups/commands/GetGroupConfigurationCommand.ts b/clients/client-resource-groups/commands/GetGroupConfigurationCommand.ts index 3c40df30556a..1328b80caeb9 100644 --- a/clients/client-resource-groups/commands/GetGroupConfigurationCommand.ts +++ b/clients/client-resource-groups/commands/GetGroupConfigurationCommand.ts @@ -35,6 +35,20 @@ export interface GetGroupConfigurationCommandOutput extends GetGroupConfiguratio *

* * + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ResourceGroupsClient, GetGroupConfigurationCommand } from "@aws-sdk/client-resource-groups"; // ES Modules import + * // const { ResourceGroupsClient, GetGroupConfigurationCommand } = require("@aws-sdk/client-resource-groups"); // CommonJS import + * const client = new ResourceGroupsClient(config); + * const command = new GetGroupConfigurationCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetGroupConfigurationCommandInput} for command's `input` shape. + * @see {@link GetGroupConfigurationCommandOutput} for command's `response` shape. + * @see {@link ResourceGroupsClientResolvedConfig | config} for command's `input` shape. + * */ export class GetGroupConfigurationCommand extends $Command< GetGroupConfigurationCommandInput, diff --git a/clients/client-resource-groups/commands/GetGroupQueryCommand.ts b/clients/client-resource-groups/commands/GetGroupQueryCommand.ts index cd24254572b2..2dd10271c370 100644 --- a/clients/client-resource-groups/commands/GetGroupQueryCommand.ts +++ b/clients/client-resource-groups/commands/GetGroupQueryCommand.ts @@ -35,6 +35,20 @@ export interface GetGroupQueryCommandOutput extends GetGroupQueryOutput, __Metad *

* * + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ResourceGroupsClient, GetGroupQueryCommand } from "@aws-sdk/client-resource-groups"; // ES Modules import + * // const { ResourceGroupsClient, GetGroupQueryCommand } = require("@aws-sdk/client-resource-groups"); // CommonJS import + * const client = new ResourceGroupsClient(config); + * const command = new GetGroupQueryCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetGroupQueryCommandInput} for command's `input` shape. + * @see {@link GetGroupQueryCommandOutput} for command's `response` shape. + * @see {@link ResourceGroupsClientResolvedConfig | config} for command's `input` shape. + * */ export class GetGroupQueryCommand extends $Command< GetGroupQueryCommandInput, diff --git a/clients/client-resource-groups/commands/GetTagsCommand.ts b/clients/client-resource-groups/commands/GetTagsCommand.ts index 3a36f01ae92f..0048151e6746 100644 --- a/clients/client-resource-groups/commands/GetTagsCommand.ts +++ b/clients/client-resource-groups/commands/GetTagsCommand.ts @@ -34,6 +34,20 @@ export interface GetTagsCommandOutput extends GetTagsOutput, __MetadataBearer {} *

* * + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ResourceGroupsClient, GetTagsCommand } from "@aws-sdk/client-resource-groups"; // ES Modules import + * // const { ResourceGroupsClient, GetTagsCommand } = require("@aws-sdk/client-resource-groups"); // CommonJS import + * const client = new ResourceGroupsClient(config); + * const command = new GetTagsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetTagsCommandInput} for command's `input` shape. + * @see {@link GetTagsCommandOutput} for command's `response` shape. + * @see {@link ResourceGroupsClientResolvedConfig | config} for command's `input` shape. + * */ export class GetTagsCommand extends $Command< GetTagsCommandInput, diff --git a/clients/client-resource-groups/commands/GroupResourcesCommand.ts b/clients/client-resource-groups/commands/GroupResourcesCommand.ts index 13bf95a90cd1..928451ad8646 100644 --- a/clients/client-resource-groups/commands/GroupResourcesCommand.ts +++ b/clients/client-resource-groups/commands/GroupResourcesCommand.ts @@ -33,6 +33,20 @@ export interface GroupResourcesCommandOutput extends GroupResourcesOutput, __Met *

* * + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ResourceGroupsClient, GroupResourcesCommand } from "@aws-sdk/client-resource-groups"; // ES Modules import + * // const { ResourceGroupsClient, GroupResourcesCommand } = require("@aws-sdk/client-resource-groups"); // CommonJS import + * const client = new ResourceGroupsClient(config); + * const command = new GroupResourcesCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GroupResourcesCommandInput} for command's `input` shape. + * @see {@link GroupResourcesCommandOutput} for command's `response` shape. + * @see {@link ResourceGroupsClientResolvedConfig | config} for command's `input` shape. + * */ export class GroupResourcesCommand extends $Command< GroupResourcesCommandInput, diff --git a/clients/client-resource-groups/commands/ListGroupResourcesCommand.ts b/clients/client-resource-groups/commands/ListGroupResourcesCommand.ts index bbea000a1fb6..67d3cb6e00c4 100644 --- a/clients/client-resource-groups/commands/ListGroupResourcesCommand.ts +++ b/clients/client-resource-groups/commands/ListGroupResourcesCommand.ts @@ -34,6 +34,20 @@ export interface ListGroupResourcesCommandOutput extends ListGroupResourcesOutpu *

* * + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ResourceGroupsClient, ListGroupResourcesCommand } from "@aws-sdk/client-resource-groups"; // ES Modules import + * // const { ResourceGroupsClient, ListGroupResourcesCommand } = require("@aws-sdk/client-resource-groups"); // CommonJS import + * const client = new ResourceGroupsClient(config); + * const command = new ListGroupResourcesCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListGroupResourcesCommandInput} for command's `input` shape. + * @see {@link ListGroupResourcesCommandOutput} for command's `response` shape. + * @see {@link ResourceGroupsClientResolvedConfig | config} for command's `input` shape. + * */ export class ListGroupResourcesCommand extends $Command< ListGroupResourcesCommandInput, diff --git a/clients/client-resource-groups/commands/ListGroupsCommand.ts b/clients/client-resource-groups/commands/ListGroupsCommand.ts index b6051bbe31d9..404b82a1897f 100644 --- a/clients/client-resource-groups/commands/ListGroupsCommand.ts +++ b/clients/client-resource-groups/commands/ListGroupsCommand.ts @@ -33,6 +33,20 @@ export interface ListGroupsCommandOutput extends ListGroupsOutput, __MetadataBea *

* * + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ResourceGroupsClient, ListGroupsCommand } from "@aws-sdk/client-resource-groups"; // ES Modules import + * // const { ResourceGroupsClient, ListGroupsCommand } = require("@aws-sdk/client-resource-groups"); // CommonJS import + * const client = new ResourceGroupsClient(config); + * const command = new ListGroupsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListGroupsCommandInput} for command's `input` shape. + * @see {@link ListGroupsCommandOutput} for command's `response` shape. + * @see {@link ResourceGroupsClientResolvedConfig | config} for command's `input` shape. + * */ export class ListGroupsCommand extends $Command< ListGroupsCommandInput, diff --git a/clients/client-resource-groups/commands/PutGroupConfigurationCommand.ts b/clients/client-resource-groups/commands/PutGroupConfigurationCommand.ts index 20c52d534490..f88984e14db3 100644 --- a/clients/client-resource-groups/commands/PutGroupConfigurationCommand.ts +++ b/clients/client-resource-groups/commands/PutGroupConfigurationCommand.ts @@ -35,6 +35,20 @@ export interface PutGroupConfigurationCommandOutput extends PutGroupConfiguratio *

* * + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ResourceGroupsClient, PutGroupConfigurationCommand } from "@aws-sdk/client-resource-groups"; // ES Modules import + * // const { ResourceGroupsClient, PutGroupConfigurationCommand } = require("@aws-sdk/client-resource-groups"); // CommonJS import + * const client = new ResourceGroupsClient(config); + * const command = new PutGroupConfigurationCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link PutGroupConfigurationCommandInput} for command's `input` shape. + * @see {@link PutGroupConfigurationCommandOutput} for command's `response` shape. + * @see {@link ResourceGroupsClientResolvedConfig | config} for command's `input` shape. + * */ export class PutGroupConfigurationCommand extends $Command< PutGroupConfigurationCommandInput, diff --git a/clients/client-resource-groups/commands/SearchResourcesCommand.ts b/clients/client-resource-groups/commands/SearchResourcesCommand.ts index 163bd9abae44..8d2026a05321 100644 --- a/clients/client-resource-groups/commands/SearchResourcesCommand.ts +++ b/clients/client-resource-groups/commands/SearchResourcesCommand.ts @@ -35,6 +35,20 @@ export interface SearchResourcesCommandOutput extends SearchResourcesOutput, __M *

* * + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ResourceGroupsClient, SearchResourcesCommand } from "@aws-sdk/client-resource-groups"; // ES Modules import + * // const { ResourceGroupsClient, SearchResourcesCommand } = require("@aws-sdk/client-resource-groups"); // CommonJS import + * const client = new ResourceGroupsClient(config); + * const command = new SearchResourcesCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link SearchResourcesCommandInput} for command's `input` shape. + * @see {@link SearchResourcesCommandOutput} for command's `response` shape. + * @see {@link ResourceGroupsClientResolvedConfig | config} for command's `input` shape. + * */ export class SearchResourcesCommand extends $Command< SearchResourcesCommandInput, diff --git a/clients/client-resource-groups/commands/TagCommand.ts b/clients/client-resource-groups/commands/TagCommand.ts index c5ff83d7f555..1965233b1466 100644 --- a/clients/client-resource-groups/commands/TagCommand.ts +++ b/clients/client-resource-groups/commands/TagCommand.ts @@ -37,6 +37,20 @@ export interface TagCommandOutput extends TagOutput, __MetadataBearer {} *

* * + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ResourceGroupsClient, TagCommand } from "@aws-sdk/client-resource-groups"; // ES Modules import + * // const { ResourceGroupsClient, TagCommand } = require("@aws-sdk/client-resource-groups"); // CommonJS import + * const client = new ResourceGroupsClient(config); + * const command = new TagCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link TagCommandInput} for command's `input` shape. + * @see {@link TagCommandOutput} for command's `response` shape. + * @see {@link ResourceGroupsClientResolvedConfig | config} for command's `input` shape. + * */ export class TagCommand extends $Command { // Start section: command_properties diff --git a/clients/client-resource-groups/commands/UngroupResourcesCommand.ts b/clients/client-resource-groups/commands/UngroupResourcesCommand.ts index 3a44980a94df..13dcfc6b466f 100644 --- a/clients/client-resource-groups/commands/UngroupResourcesCommand.ts +++ b/clients/client-resource-groups/commands/UngroupResourcesCommand.ts @@ -33,6 +33,20 @@ export interface UngroupResourcesCommandOutput extends UngroupResourcesOutput, _ *

* * + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ResourceGroupsClient, UngroupResourcesCommand } from "@aws-sdk/client-resource-groups"; // ES Modules import + * // const { ResourceGroupsClient, UngroupResourcesCommand } = require("@aws-sdk/client-resource-groups"); // CommonJS import + * const client = new ResourceGroupsClient(config); + * const command = new UngroupResourcesCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link UngroupResourcesCommandInput} for command's `input` shape. + * @see {@link UngroupResourcesCommandOutput} for command's `response` shape. + * @see {@link ResourceGroupsClientResolvedConfig | config} for command's `input` shape. + * */ export class UngroupResourcesCommand extends $Command< UngroupResourcesCommandInput, diff --git a/clients/client-resource-groups/commands/UntagCommand.ts b/clients/client-resource-groups/commands/UntagCommand.ts index 1f7e1edfc509..fbd8ad96e866 100644 --- a/clients/client-resource-groups/commands/UntagCommand.ts +++ b/clients/client-resource-groups/commands/UntagCommand.ts @@ -30,6 +30,20 @@ export interface UntagCommandOutput extends UntagOutput, __MetadataBearer {} *

* * + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ResourceGroupsClient, UntagCommand } from "@aws-sdk/client-resource-groups"; // ES Modules import + * // const { ResourceGroupsClient, UntagCommand } = require("@aws-sdk/client-resource-groups"); // CommonJS import + * const client = new ResourceGroupsClient(config); + * const command = new UntagCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link UntagCommandInput} for command's `input` shape. + * @see {@link UntagCommandOutput} for command's `response` shape. + * @see {@link ResourceGroupsClientResolvedConfig | config} for command's `input` shape. + * */ export class UntagCommand extends $Command { // Start section: command_properties diff --git a/clients/client-resource-groups/commands/UpdateGroupCommand.ts b/clients/client-resource-groups/commands/UpdateGroupCommand.ts index 7b96e1d065b2..4214a712ae04 100644 --- a/clients/client-resource-groups/commands/UpdateGroupCommand.ts +++ b/clients/client-resource-groups/commands/UpdateGroupCommand.ts @@ -34,6 +34,20 @@ export interface UpdateGroupCommandOutput extends UpdateGroupOutput, __MetadataB *

* * + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ResourceGroupsClient, UpdateGroupCommand } from "@aws-sdk/client-resource-groups"; // ES Modules import + * // const { ResourceGroupsClient, UpdateGroupCommand } = require("@aws-sdk/client-resource-groups"); // CommonJS import + * const client = new ResourceGroupsClient(config); + * const command = new UpdateGroupCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link UpdateGroupCommandInput} for command's `input` shape. + * @see {@link UpdateGroupCommandOutput} for command's `response` shape. + * @see {@link ResourceGroupsClientResolvedConfig | config} for command's `input` shape. + * */ export class UpdateGroupCommand extends $Command< UpdateGroupCommandInput, diff --git a/clients/client-resource-groups/commands/UpdateGroupQueryCommand.ts b/clients/client-resource-groups/commands/UpdateGroupQueryCommand.ts index 79f86d7ee1fc..a18ecaeef144 100644 --- a/clients/client-resource-groups/commands/UpdateGroupQueryCommand.ts +++ b/clients/client-resource-groups/commands/UpdateGroupQueryCommand.ts @@ -34,6 +34,20 @@ export interface UpdateGroupQueryCommandOutput extends UpdateGroupQueryOutput, _ *

* * + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ResourceGroupsClient, UpdateGroupQueryCommand } from "@aws-sdk/client-resource-groups"; // ES Modules import + * // const { ResourceGroupsClient, UpdateGroupQueryCommand } = require("@aws-sdk/client-resource-groups"); // CommonJS import + * const client = new ResourceGroupsClient(config); + * const command = new UpdateGroupQueryCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link UpdateGroupQueryCommandInput} for command's `input` shape. + * @see {@link UpdateGroupQueryCommandOutput} for command's `response` shape. + * @see {@link ResourceGroupsClientResolvedConfig | config} for command's `input` shape. + * */ export class UpdateGroupQueryCommand extends $Command< UpdateGroupQueryCommandInput, diff --git a/clients/client-resource-groups/models/models_0.ts b/clients/client-resource-groups/models/models_0.ts index b1937fb5a0a5..ed287728b4bc 100644 --- a/clients/client-resource-groups/models/models_0.ts +++ b/clients/client-resource-groups/models/models_0.ts @@ -11,6 +11,9 @@ export interface BadRequestException extends __SmithyException, $MetadataBearer } export namespace BadRequestException { + /** + * @internal + */ export const filterSensitiveLog = (obj: BadRequestException): any => ({ ...obj, }); @@ -38,6 +41,9 @@ export interface GroupConfigurationParameter { } export namespace GroupConfigurationParameter { + /** + * @internal + */ export const filterSensitiveLog = (obj: GroupConfigurationParameter): any => ({ ...obj, }); @@ -66,6 +72,9 @@ export interface GroupConfigurationItem { } export namespace GroupConfigurationItem { + /** + * @internal + */ export const filterSensitiveLog = (obj: GroupConfigurationItem): any => ({ ...obj, }); @@ -259,6 +268,9 @@ export interface ResourceQuery { } export namespace ResourceQuery { + /** + * @internal + */ export const filterSensitiveLog = (obj: ResourceQuery): any => ({ ...obj, }); @@ -311,6 +323,9 @@ export interface CreateGroupInput { } export namespace CreateGroupInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateGroupInput): any => ({ ...obj, }); @@ -353,6 +368,9 @@ export interface Group { } export namespace Group { + /** + * @internal + */ export const filterSensitiveLog = (obj: Group): any => ({ ...obj, }); @@ -396,6 +414,9 @@ export interface GroupConfiguration { } export namespace GroupConfiguration { + /** + * @internal + */ export const filterSensitiveLog = (obj: GroupConfiguration): any => ({ ...obj, }); @@ -428,6 +449,9 @@ export interface CreateGroupOutput { } export namespace CreateGroupOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateGroupOutput): any => ({ ...obj, }); @@ -443,6 +467,9 @@ export interface ForbiddenException extends __SmithyException, $MetadataBearer { } export namespace ForbiddenException { + /** + * @internal + */ export const filterSensitiveLog = (obj: ForbiddenException): any => ({ ...obj, }); @@ -458,6 +485,9 @@ export interface InternalServerErrorException extends __SmithyException, $Metada } export namespace InternalServerErrorException { + /** + * @internal + */ export const filterSensitiveLog = (obj: InternalServerErrorException): any => ({ ...obj, }); @@ -473,6 +503,9 @@ export interface MethodNotAllowedException extends __SmithyException, $MetadataB } export namespace MethodNotAllowedException { + /** + * @internal + */ export const filterSensitiveLog = (obj: MethodNotAllowedException): any => ({ ...obj, }); @@ -489,6 +522,9 @@ export interface TooManyRequestsException extends __SmithyException, $MetadataBe } export namespace TooManyRequestsException { + /** + * @internal + */ export const filterSensitiveLog = (obj: TooManyRequestsException): any => ({ ...obj, }); @@ -509,6 +545,9 @@ export interface DeleteGroupInput { } export namespace DeleteGroupInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteGroupInput): any => ({ ...obj, }); @@ -522,6 +561,9 @@ export interface DeleteGroupOutput { } export namespace DeleteGroupOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteGroupOutput): any => ({ ...obj, }); @@ -537,6 +579,9 @@ export interface NotFoundException extends __SmithyException, $MetadataBearer { } export namespace NotFoundException { + /** + * @internal + */ export const filterSensitiveLog = (obj: NotFoundException): any => ({ ...obj, }); @@ -557,6 +602,9 @@ export interface GetGroupInput { } export namespace GetGroupInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetGroupInput): any => ({ ...obj, }); @@ -570,6 +618,9 @@ export interface GetGroupOutput { } export namespace GetGroupOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetGroupOutput): any => ({ ...obj, }); @@ -583,6 +634,9 @@ export interface GetGroupConfigurationInput { } export namespace GetGroupConfigurationInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetGroupConfigurationInput): any => ({ ...obj, }); @@ -598,6 +652,9 @@ export interface GetGroupConfigurationOutput { } export namespace GetGroupConfigurationOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetGroupConfigurationOutput): any => ({ ...obj, }); @@ -618,6 +675,9 @@ export interface GetGroupQueryInput { } export namespace GetGroupQueryInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetGroupQueryInput): any => ({ ...obj, }); @@ -642,6 +702,9 @@ export interface GroupQuery { } export namespace GroupQuery { + /** + * @internal + */ export const filterSensitiveLog = (obj: GroupQuery): any => ({ ...obj, }); @@ -657,6 +720,9 @@ export interface GetGroupQueryOutput { } export namespace GetGroupQueryOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetGroupQueryOutput): any => ({ ...obj, }); @@ -670,6 +736,9 @@ export interface GetTagsInput { } export namespace GetTagsInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetTagsInput): any => ({ ...obj, }); @@ -688,6 +757,9 @@ export interface GetTagsOutput { } export namespace GetTagsOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetTagsOutput): any => ({ ...obj, }); @@ -706,6 +778,9 @@ export interface GroupResourcesInput { } export namespace GroupResourcesInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: GroupResourcesInput): any => ({ ...obj, }); @@ -732,6 +807,9 @@ export interface FailedResource { } export namespace FailedResource { + /** + * @internal + */ export const filterSensitiveLog = (obj: FailedResource): any => ({ ...obj, }); @@ -750,6 +828,9 @@ export interface PendingResource { } export namespace PendingResource { + /** + * @internal + */ export const filterSensitiveLog = (obj: PendingResource): any => ({ ...obj, }); @@ -780,6 +861,9 @@ export interface GroupResourcesOutput { } export namespace GroupResourcesOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: GroupResourcesOutput): any => ({ ...obj, }); @@ -807,6 +891,9 @@ export interface ResourceFilter { } export namespace ResourceFilter { + /** + * @internal + */ export const filterSensitiveLog = (obj: ResourceFilter): any => ({ ...obj, }); @@ -887,6 +974,9 @@ export interface ListGroupResourcesInput { } export namespace ListGroupResourcesInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListGroupResourcesInput): any => ({ ...obj, }); @@ -923,6 +1013,9 @@ export interface QueryError { } export namespace QueryError { + /** + * @internal + */ export const filterSensitiveLog = (obj: QueryError): any => ({ ...obj, }); @@ -944,6 +1037,9 @@ export interface ResourceIdentifier { } export namespace ResourceIdentifier { + /** + * @internal + */ export const filterSensitiveLog = (obj: ResourceIdentifier): any => ({ ...obj, }); @@ -967,6 +1063,9 @@ export interface ResourceStatus { } export namespace ResourceStatus { + /** + * @internal + */ export const filterSensitiveLog = (obj: ResourceStatus): any => ({ ...obj, }); @@ -995,6 +1094,9 @@ export interface ListGroupResourcesItem { } export namespace ListGroupResourcesItem { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListGroupResourcesItem): any => ({ ...obj, }); @@ -1040,6 +1142,9 @@ export interface ListGroupResourcesOutput { } export namespace ListGroupResourcesOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListGroupResourcesOutput): any => ({ ...obj, }); @@ -1056,6 +1161,9 @@ export interface UnauthorizedException extends __SmithyException, $MetadataBeare } export namespace UnauthorizedException { + /** + * @internal + */ export const filterSensitiveLog = (obj: UnauthorizedException): any => ({ ...obj, }); @@ -1084,6 +1192,9 @@ export interface GroupFilter { } export namespace GroupFilter { + /** + * @internal + */ export const filterSensitiveLog = (obj: GroupFilter): any => ({ ...obj, }); @@ -1147,6 +1258,9 @@ export interface ListGroupsInput { } export namespace ListGroupsInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListGroupsInput): any => ({ ...obj, }); @@ -1168,6 +1282,9 @@ export interface GroupIdentifier { } export namespace GroupIdentifier { + /** + * @internal + */ export const filterSensitiveLog = (obj: GroupIdentifier): any => ({ ...obj, }); @@ -1205,6 +1322,9 @@ export interface ListGroupsOutput { } export namespace ListGroupsOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListGroupsOutput): any => ({ ...obj, }); @@ -1232,6 +1352,9 @@ export interface PutGroupConfigurationInput { } export namespace PutGroupConfigurationInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: PutGroupConfigurationInput): any => ({ ...obj, }); @@ -1240,6 +1363,9 @@ export namespace PutGroupConfigurationInput { export interface PutGroupConfigurationOutput {} export namespace PutGroupConfigurationOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: PutGroupConfigurationOutput): any => ({ ...obj, }); @@ -1274,6 +1400,9 @@ export interface SearchResourcesInput { } export namespace SearchResourcesInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: SearchResourcesInput): any => ({ ...obj, }); @@ -1304,6 +1433,9 @@ export interface SearchResourcesOutput { } export namespace SearchResourcesOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: SearchResourcesOutput): any => ({ ...obj, }); @@ -1323,6 +1455,9 @@ export interface TagInput { } export namespace TagInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: TagInput): any => ({ ...obj, }); @@ -1341,6 +1476,9 @@ export interface TagOutput { } export namespace TagOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: TagOutput): any => ({ ...obj, }); @@ -1359,6 +1497,9 @@ export interface UngroupResourcesInput { } export namespace UngroupResourcesInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: UngroupResourcesInput): any => ({ ...obj, }); @@ -1389,6 +1530,9 @@ export interface UngroupResourcesOutput { } export namespace UngroupResourcesOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: UngroupResourcesOutput): any => ({ ...obj, }); @@ -1408,6 +1552,9 @@ export interface UntagInput { } export namespace UntagInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: UntagInput): any => ({ ...obj, }); @@ -1426,6 +1573,9 @@ export interface UntagOutput { } export namespace UntagOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: UntagOutput): any => ({ ...obj, }); @@ -1452,6 +1602,9 @@ export interface UpdateGroupInput { } export namespace UpdateGroupInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateGroupInput): any => ({ ...obj, }); @@ -1465,6 +1618,9 @@ export interface UpdateGroupOutput { } export namespace UpdateGroupOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateGroupOutput): any => ({ ...obj, }); @@ -1495,6 +1651,9 @@ export interface UpdateGroupQueryInput { } export namespace UpdateGroupQueryInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateGroupQueryInput): any => ({ ...obj, }); @@ -1508,6 +1667,9 @@ export interface UpdateGroupQueryOutput { } export namespace UpdateGroupQueryOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateGroupQueryOutput): any => ({ ...obj, }); diff --git a/clients/client-robomaker/commands/BatchDeleteWorldsCommand.ts b/clients/client-robomaker/commands/BatchDeleteWorldsCommand.ts index 6ad316a620d8..890f2c63f9ba 100644 --- a/clients/client-robomaker/commands/BatchDeleteWorldsCommand.ts +++ b/clients/client-robomaker/commands/BatchDeleteWorldsCommand.ts @@ -22,6 +22,20 @@ export interface BatchDeleteWorldsCommandOutput extends BatchDeleteWorldsRespons /** *

Deletes one or more worlds in a batch operation.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { RoboMakerClient, BatchDeleteWorldsCommand } from "@aws-sdk/client-robomaker"; // ES Modules import + * // const { RoboMakerClient, BatchDeleteWorldsCommand } = require("@aws-sdk/client-robomaker"); // CommonJS import + * const client = new RoboMakerClient(config); + * const command = new BatchDeleteWorldsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link BatchDeleteWorldsCommandInput} for command's `input` shape. + * @see {@link BatchDeleteWorldsCommandOutput} for command's `response` shape. + * @see {@link RoboMakerClientResolvedConfig | config} for command's `input` shape. + * */ export class BatchDeleteWorldsCommand extends $Command< BatchDeleteWorldsCommandInput, diff --git a/clients/client-robomaker/commands/BatchDescribeSimulationJobCommand.ts b/clients/client-robomaker/commands/BatchDescribeSimulationJobCommand.ts index 8206b659fe7d..d5c5a46bd1fc 100644 --- a/clients/client-robomaker/commands/BatchDescribeSimulationJobCommand.ts +++ b/clients/client-robomaker/commands/BatchDescribeSimulationJobCommand.ts @@ -22,6 +22,20 @@ export interface BatchDescribeSimulationJobCommandOutput extends BatchDescribeSi /** *

Describes one or more simulation jobs.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { RoboMakerClient, BatchDescribeSimulationJobCommand } from "@aws-sdk/client-robomaker"; // ES Modules import + * // const { RoboMakerClient, BatchDescribeSimulationJobCommand } = require("@aws-sdk/client-robomaker"); // CommonJS import + * const client = new RoboMakerClient(config); + * const command = new BatchDescribeSimulationJobCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link BatchDescribeSimulationJobCommandInput} for command's `input` shape. + * @see {@link BatchDescribeSimulationJobCommandOutput} for command's `response` shape. + * @see {@link RoboMakerClientResolvedConfig | config} for command's `input` shape. + * */ export class BatchDescribeSimulationJobCommand extends $Command< BatchDescribeSimulationJobCommandInput, diff --git a/clients/client-robomaker/commands/CancelDeploymentJobCommand.ts b/clients/client-robomaker/commands/CancelDeploymentJobCommand.ts index 12d7162cd324..1d2355ee806c 100644 --- a/clients/client-robomaker/commands/CancelDeploymentJobCommand.ts +++ b/clients/client-robomaker/commands/CancelDeploymentJobCommand.ts @@ -22,6 +22,20 @@ export interface CancelDeploymentJobCommandOutput extends CancelDeploymentJobRes /** *

Cancels the specified deployment job.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { RoboMakerClient, CancelDeploymentJobCommand } from "@aws-sdk/client-robomaker"; // ES Modules import + * // const { RoboMakerClient, CancelDeploymentJobCommand } = require("@aws-sdk/client-robomaker"); // CommonJS import + * const client = new RoboMakerClient(config); + * const command = new CancelDeploymentJobCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CancelDeploymentJobCommandInput} for command's `input` shape. + * @see {@link CancelDeploymentJobCommandOutput} for command's `response` shape. + * @see {@link RoboMakerClientResolvedConfig | config} for command's `input` shape. + * */ export class CancelDeploymentJobCommand extends $Command< CancelDeploymentJobCommandInput, diff --git a/clients/client-robomaker/commands/CancelSimulationJobBatchCommand.ts b/clients/client-robomaker/commands/CancelSimulationJobBatchCommand.ts index 71e8ae3dbc4d..7512510038ac 100644 --- a/clients/client-robomaker/commands/CancelSimulationJobBatchCommand.ts +++ b/clients/client-robomaker/commands/CancelSimulationJobBatchCommand.ts @@ -23,6 +23,20 @@ export interface CancelSimulationJobBatchCommandOutput extends CancelSimulationJ /** *

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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { RoboMakerClient, CancelSimulationJobBatchCommand } from "@aws-sdk/client-robomaker"; // ES Modules import + * // const { RoboMakerClient, CancelSimulationJobBatchCommand } = require("@aws-sdk/client-robomaker"); // CommonJS import + * const client = new RoboMakerClient(config); + * const command = new CancelSimulationJobBatchCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CancelSimulationJobBatchCommandInput} for command's `input` shape. + * @see {@link CancelSimulationJobBatchCommandOutput} for command's `response` shape. + * @see {@link RoboMakerClientResolvedConfig | config} for command's `input` shape. + * */ export class CancelSimulationJobBatchCommand extends $Command< CancelSimulationJobBatchCommandInput, diff --git a/clients/client-robomaker/commands/CancelSimulationJobCommand.ts b/clients/client-robomaker/commands/CancelSimulationJobCommand.ts index 90d44f48fee1..cac91f012457 100644 --- a/clients/client-robomaker/commands/CancelSimulationJobCommand.ts +++ b/clients/client-robomaker/commands/CancelSimulationJobCommand.ts @@ -22,6 +22,20 @@ export interface CancelSimulationJobCommandOutput extends CancelSimulationJobRes /** *

Cancels the specified simulation job.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { RoboMakerClient, CancelSimulationJobCommand } from "@aws-sdk/client-robomaker"; // ES Modules import + * // const { RoboMakerClient, CancelSimulationJobCommand } = require("@aws-sdk/client-robomaker"); // CommonJS import + * const client = new RoboMakerClient(config); + * const command = new CancelSimulationJobCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CancelSimulationJobCommandInput} for command's `input` shape. + * @see {@link CancelSimulationJobCommandOutput} for command's `response` shape. + * @see {@link RoboMakerClientResolvedConfig | config} for command's `input` shape. + * */ export class CancelSimulationJobCommand extends $Command< CancelSimulationJobCommandInput, diff --git a/clients/client-robomaker/commands/CancelWorldExportJobCommand.ts b/clients/client-robomaker/commands/CancelWorldExportJobCommand.ts index e67d12e8a8f4..a228d8ae0838 100644 --- a/clients/client-robomaker/commands/CancelWorldExportJobCommand.ts +++ b/clients/client-robomaker/commands/CancelWorldExportJobCommand.ts @@ -22,6 +22,20 @@ export interface CancelWorldExportJobCommandOutput extends CancelWorldExportJobR /** *

Cancels the specified export job.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { RoboMakerClient, CancelWorldExportJobCommand } from "@aws-sdk/client-robomaker"; // ES Modules import + * // const { RoboMakerClient, CancelWorldExportJobCommand } = require("@aws-sdk/client-robomaker"); // CommonJS import + * const client = new RoboMakerClient(config); + * const command = new CancelWorldExportJobCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CancelWorldExportJobCommandInput} for command's `input` shape. + * @see {@link CancelWorldExportJobCommandOutput} for command's `response` shape. + * @see {@link RoboMakerClientResolvedConfig | config} for command's `input` shape. + * */ export class CancelWorldExportJobCommand extends $Command< CancelWorldExportJobCommandInput, diff --git a/clients/client-robomaker/commands/CancelWorldGenerationJobCommand.ts b/clients/client-robomaker/commands/CancelWorldGenerationJobCommand.ts index bc9ee7101aab..3d49f994c738 100644 --- a/clients/client-robomaker/commands/CancelWorldGenerationJobCommand.ts +++ b/clients/client-robomaker/commands/CancelWorldGenerationJobCommand.ts @@ -22,6 +22,20 @@ export interface CancelWorldGenerationJobCommandOutput extends CancelWorldGenera /** *

Cancels the specified world generator job.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { RoboMakerClient, CancelWorldGenerationJobCommand } from "@aws-sdk/client-robomaker"; // ES Modules import + * // const { RoboMakerClient, CancelWorldGenerationJobCommand } = require("@aws-sdk/client-robomaker"); // CommonJS import + * const client = new RoboMakerClient(config); + * const command = new CancelWorldGenerationJobCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CancelWorldGenerationJobCommandInput} for command's `input` shape. + * @see {@link CancelWorldGenerationJobCommandOutput} for command's `response` shape. + * @see {@link RoboMakerClientResolvedConfig | config} for command's `input` shape. + * */ export class CancelWorldGenerationJobCommand extends $Command< CancelWorldGenerationJobCommandInput, diff --git a/clients/client-robomaker/commands/CreateDeploymentJobCommand.ts b/clients/client-robomaker/commands/CreateDeploymentJobCommand.ts index 9fee0cf8bbb7..04dafcc36b7b 100644 --- a/clients/client-robomaker/commands/CreateDeploymentJobCommand.ts +++ b/clients/client-robomaker/commands/CreateDeploymentJobCommand.ts @@ -29,6 +29,20 @@ export interface CreateDeploymentJobCommandOutput extends CreateDeploymentJobRes *

After 90 days, deployment jobs expire and will be deleted. They will no longer be * accessible.

* + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { RoboMakerClient, CreateDeploymentJobCommand } from "@aws-sdk/client-robomaker"; // ES Modules import + * // const { RoboMakerClient, CreateDeploymentJobCommand } = require("@aws-sdk/client-robomaker"); // CommonJS import + * const client = new RoboMakerClient(config); + * const command = new CreateDeploymentJobCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreateDeploymentJobCommandInput} for command's `input` shape. + * @see {@link CreateDeploymentJobCommandOutput} for command's `response` shape. + * @see {@link RoboMakerClientResolvedConfig | config} for command's `input` shape. + * */ export class CreateDeploymentJobCommand extends $Command< CreateDeploymentJobCommandInput, diff --git a/clients/client-robomaker/commands/CreateFleetCommand.ts b/clients/client-robomaker/commands/CreateFleetCommand.ts index 4c3b5af267f9..2984f14d2334 100644 --- a/clients/client-robomaker/commands/CreateFleetCommand.ts +++ b/clients/client-robomaker/commands/CreateFleetCommand.ts @@ -22,6 +22,20 @@ export interface CreateFleetCommandOutput extends CreateFleetResponse, __Metadat /** *

Creates a fleet, a logical group of robots running the same robot application.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { RoboMakerClient, CreateFleetCommand } from "@aws-sdk/client-robomaker"; // ES Modules import + * // const { RoboMakerClient, CreateFleetCommand } = require("@aws-sdk/client-robomaker"); // CommonJS import + * const client = new RoboMakerClient(config); + * const command = new CreateFleetCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreateFleetCommandInput} for command's `input` shape. + * @see {@link CreateFleetCommandOutput} for command's `response` shape. + * @see {@link RoboMakerClientResolvedConfig | config} for command's `input` shape. + * */ export class CreateFleetCommand extends $Command< CreateFleetCommandInput, diff --git a/clients/client-robomaker/commands/CreateRobotApplicationCommand.ts b/clients/client-robomaker/commands/CreateRobotApplicationCommand.ts index aab88a60a96f..1bf6620b46b0 100644 --- a/clients/client-robomaker/commands/CreateRobotApplicationCommand.ts +++ b/clients/client-robomaker/commands/CreateRobotApplicationCommand.ts @@ -22,6 +22,20 @@ export interface CreateRobotApplicationCommandOutput extends CreateRobotApplicat /** *

Creates a robot application.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { RoboMakerClient, CreateRobotApplicationCommand } from "@aws-sdk/client-robomaker"; // ES Modules import + * // const { RoboMakerClient, CreateRobotApplicationCommand } = require("@aws-sdk/client-robomaker"); // CommonJS import + * const client = new RoboMakerClient(config); + * const command = new CreateRobotApplicationCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreateRobotApplicationCommandInput} for command's `input` shape. + * @see {@link CreateRobotApplicationCommandOutput} for command's `response` shape. + * @see {@link RoboMakerClientResolvedConfig | config} for command's `input` shape. + * */ export class CreateRobotApplicationCommand extends $Command< CreateRobotApplicationCommandInput, diff --git a/clients/client-robomaker/commands/CreateRobotApplicationVersionCommand.ts b/clients/client-robomaker/commands/CreateRobotApplicationVersionCommand.ts index 05a6cbb3dbde..9f4b217fcfe7 100644 --- a/clients/client-robomaker/commands/CreateRobotApplicationVersionCommand.ts +++ b/clients/client-robomaker/commands/CreateRobotApplicationVersionCommand.ts @@ -24,6 +24,20 @@ export interface CreateRobotApplicationVersionCommandOutput /** *

Creates a version of a robot application.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { RoboMakerClient, CreateRobotApplicationVersionCommand } from "@aws-sdk/client-robomaker"; // ES Modules import + * // const { RoboMakerClient, CreateRobotApplicationVersionCommand } = require("@aws-sdk/client-robomaker"); // CommonJS import + * const client = new RoboMakerClient(config); + * const command = new CreateRobotApplicationVersionCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreateRobotApplicationVersionCommandInput} for command's `input` shape. + * @see {@link CreateRobotApplicationVersionCommandOutput} for command's `response` shape. + * @see {@link RoboMakerClientResolvedConfig | config} for command's `input` shape. + * */ export class CreateRobotApplicationVersionCommand extends $Command< CreateRobotApplicationVersionCommandInput, diff --git a/clients/client-robomaker/commands/CreateRobotCommand.ts b/clients/client-robomaker/commands/CreateRobotCommand.ts index 2bc17597af8a..a67fd2a535a1 100644 --- a/clients/client-robomaker/commands/CreateRobotCommand.ts +++ b/clients/client-robomaker/commands/CreateRobotCommand.ts @@ -22,6 +22,20 @@ export interface CreateRobotCommandOutput extends CreateRobotResponse, __Metadat /** *

Creates a robot.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { RoboMakerClient, CreateRobotCommand } from "@aws-sdk/client-robomaker"; // ES Modules import + * // const { RoboMakerClient, CreateRobotCommand } = require("@aws-sdk/client-robomaker"); // CommonJS import + * const client = new RoboMakerClient(config); + * const command = new CreateRobotCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreateRobotCommandInput} for command's `input` shape. + * @see {@link CreateRobotCommandOutput} for command's `response` shape. + * @see {@link RoboMakerClientResolvedConfig | config} for command's `input` shape. + * */ export class CreateRobotCommand extends $Command< CreateRobotCommandInput, diff --git a/clients/client-robomaker/commands/CreateSimulationApplicationCommand.ts b/clients/client-robomaker/commands/CreateSimulationApplicationCommand.ts index 746d016bc1b0..8ea924bc0903 100644 --- a/clients/client-robomaker/commands/CreateSimulationApplicationCommand.ts +++ b/clients/client-robomaker/commands/CreateSimulationApplicationCommand.ts @@ -24,6 +24,20 @@ export interface CreateSimulationApplicationCommandOutput /** *

Creates a simulation application.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { RoboMakerClient, CreateSimulationApplicationCommand } from "@aws-sdk/client-robomaker"; // ES Modules import + * // const { RoboMakerClient, CreateSimulationApplicationCommand } = require("@aws-sdk/client-robomaker"); // CommonJS import + * const client = new RoboMakerClient(config); + * const command = new CreateSimulationApplicationCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreateSimulationApplicationCommandInput} for command's `input` shape. + * @see {@link CreateSimulationApplicationCommandOutput} for command's `response` shape. + * @see {@link RoboMakerClientResolvedConfig | config} for command's `input` shape. + * */ export class CreateSimulationApplicationCommand extends $Command< CreateSimulationApplicationCommandInput, diff --git a/clients/client-robomaker/commands/CreateSimulationApplicationVersionCommand.ts b/clients/client-robomaker/commands/CreateSimulationApplicationVersionCommand.ts index bb5c2d9dd52f..abb338b73e93 100644 --- a/clients/client-robomaker/commands/CreateSimulationApplicationVersionCommand.ts +++ b/clients/client-robomaker/commands/CreateSimulationApplicationVersionCommand.ts @@ -27,6 +27,20 @@ export interface CreateSimulationApplicationVersionCommandOutput /** *

Creates a simulation application with a specific revision id.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { RoboMakerClient, CreateSimulationApplicationVersionCommand } from "@aws-sdk/client-robomaker"; // ES Modules import + * // const { RoboMakerClient, CreateSimulationApplicationVersionCommand } = require("@aws-sdk/client-robomaker"); // CommonJS import + * const client = new RoboMakerClient(config); + * const command = new CreateSimulationApplicationVersionCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreateSimulationApplicationVersionCommandInput} for command's `input` shape. + * @see {@link CreateSimulationApplicationVersionCommandOutput} for command's `response` shape. + * @see {@link RoboMakerClientResolvedConfig | config} for command's `input` shape. + * */ export class CreateSimulationApplicationVersionCommand extends $Command< CreateSimulationApplicationVersionCommandInput, diff --git a/clients/client-robomaker/commands/CreateSimulationJobCommand.ts b/clients/client-robomaker/commands/CreateSimulationJobCommand.ts index fbd05c952e8a..17811deb248d 100644 --- a/clients/client-robomaker/commands/CreateSimulationJobCommand.ts +++ b/clients/client-robomaker/commands/CreateSimulationJobCommand.ts @@ -26,6 +26,20 @@ export interface CreateSimulationJobCommandOutput extends CreateSimulationJobRes *

After 90 days, simulation jobs expire and will be deleted. They will no longer be * accessible.

* + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { RoboMakerClient, CreateSimulationJobCommand } from "@aws-sdk/client-robomaker"; // ES Modules import + * // const { RoboMakerClient, CreateSimulationJobCommand } = require("@aws-sdk/client-robomaker"); // CommonJS import + * const client = new RoboMakerClient(config); + * const command = new CreateSimulationJobCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreateSimulationJobCommandInput} for command's `input` shape. + * @see {@link CreateSimulationJobCommandOutput} for command's `response` shape. + * @see {@link RoboMakerClientResolvedConfig | config} for command's `input` shape. + * */ export class CreateSimulationJobCommand extends $Command< CreateSimulationJobCommandInput, diff --git a/clients/client-robomaker/commands/CreateWorldExportJobCommand.ts b/clients/client-robomaker/commands/CreateWorldExportJobCommand.ts index 17a08b31f533..321698b4a001 100644 --- a/clients/client-robomaker/commands/CreateWorldExportJobCommand.ts +++ b/clients/client-robomaker/commands/CreateWorldExportJobCommand.ts @@ -22,6 +22,20 @@ export interface CreateWorldExportJobCommandOutput extends CreateWorldExportJobR /** *

Creates a world export job.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { RoboMakerClient, CreateWorldExportJobCommand } from "@aws-sdk/client-robomaker"; // ES Modules import + * // const { RoboMakerClient, CreateWorldExportJobCommand } = require("@aws-sdk/client-robomaker"); // CommonJS import + * const client = new RoboMakerClient(config); + * const command = new CreateWorldExportJobCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreateWorldExportJobCommandInput} for command's `input` shape. + * @see {@link CreateWorldExportJobCommandOutput} for command's `response` shape. + * @see {@link RoboMakerClientResolvedConfig | config} for command's `input` shape. + * */ export class CreateWorldExportJobCommand extends $Command< CreateWorldExportJobCommandInput, diff --git a/clients/client-robomaker/commands/CreateWorldGenerationJobCommand.ts b/clients/client-robomaker/commands/CreateWorldGenerationJobCommand.ts index 4ff74ddeb2ff..265fcadf873d 100644 --- a/clients/client-robomaker/commands/CreateWorldGenerationJobCommand.ts +++ b/clients/client-robomaker/commands/CreateWorldGenerationJobCommand.ts @@ -22,6 +22,20 @@ export interface CreateWorldGenerationJobCommandOutput extends CreateWorldGenera /** *

Creates worlds using the specified template.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { RoboMakerClient, CreateWorldGenerationJobCommand } from "@aws-sdk/client-robomaker"; // ES Modules import + * // const { RoboMakerClient, CreateWorldGenerationJobCommand } = require("@aws-sdk/client-robomaker"); // CommonJS import + * const client = new RoboMakerClient(config); + * const command = new CreateWorldGenerationJobCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreateWorldGenerationJobCommandInput} for command's `input` shape. + * @see {@link CreateWorldGenerationJobCommandOutput} for command's `response` shape. + * @see {@link RoboMakerClientResolvedConfig | config} for command's `input` shape. + * */ export class CreateWorldGenerationJobCommand extends $Command< CreateWorldGenerationJobCommandInput, diff --git a/clients/client-robomaker/commands/CreateWorldTemplateCommand.ts b/clients/client-robomaker/commands/CreateWorldTemplateCommand.ts index 65d9ab669fce..4772a74bc54b 100644 --- a/clients/client-robomaker/commands/CreateWorldTemplateCommand.ts +++ b/clients/client-robomaker/commands/CreateWorldTemplateCommand.ts @@ -22,6 +22,20 @@ export interface CreateWorldTemplateCommandOutput extends CreateWorldTemplateRes /** *

Creates a world template.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { RoboMakerClient, CreateWorldTemplateCommand } from "@aws-sdk/client-robomaker"; // ES Modules import + * // const { RoboMakerClient, CreateWorldTemplateCommand } = require("@aws-sdk/client-robomaker"); // CommonJS import + * const client = new RoboMakerClient(config); + * const command = new CreateWorldTemplateCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreateWorldTemplateCommandInput} for command's `input` shape. + * @see {@link CreateWorldTemplateCommandOutput} for command's `response` shape. + * @see {@link RoboMakerClientResolvedConfig | config} for command's `input` shape. + * */ export class CreateWorldTemplateCommand extends $Command< CreateWorldTemplateCommandInput, diff --git a/clients/client-robomaker/commands/DeleteFleetCommand.ts b/clients/client-robomaker/commands/DeleteFleetCommand.ts index 7fd6f1aaecff..28ce09e14be1 100644 --- a/clients/client-robomaker/commands/DeleteFleetCommand.ts +++ b/clients/client-robomaker/commands/DeleteFleetCommand.ts @@ -22,6 +22,20 @@ export interface DeleteFleetCommandOutput extends DeleteFleetResponse, __Metadat /** *

Deletes a fleet.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { RoboMakerClient, DeleteFleetCommand } from "@aws-sdk/client-robomaker"; // ES Modules import + * // const { RoboMakerClient, DeleteFleetCommand } = require("@aws-sdk/client-robomaker"); // CommonJS import + * const client = new RoboMakerClient(config); + * const command = new DeleteFleetCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteFleetCommandInput} for command's `input` shape. + * @see {@link DeleteFleetCommandOutput} for command's `response` shape. + * @see {@link RoboMakerClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteFleetCommand extends $Command< DeleteFleetCommandInput, diff --git a/clients/client-robomaker/commands/DeleteRobotApplicationCommand.ts b/clients/client-robomaker/commands/DeleteRobotApplicationCommand.ts index 5867956005b5..3b26b7f5fad1 100644 --- a/clients/client-robomaker/commands/DeleteRobotApplicationCommand.ts +++ b/clients/client-robomaker/commands/DeleteRobotApplicationCommand.ts @@ -22,6 +22,20 @@ export interface DeleteRobotApplicationCommandOutput extends DeleteRobotApplicat /** *

Deletes a robot application.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { RoboMakerClient, DeleteRobotApplicationCommand } from "@aws-sdk/client-robomaker"; // ES Modules import + * // const { RoboMakerClient, DeleteRobotApplicationCommand } = require("@aws-sdk/client-robomaker"); // CommonJS import + * const client = new RoboMakerClient(config); + * const command = new DeleteRobotApplicationCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteRobotApplicationCommandInput} for command's `input` shape. + * @see {@link DeleteRobotApplicationCommandOutput} for command's `response` shape. + * @see {@link RoboMakerClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteRobotApplicationCommand extends $Command< DeleteRobotApplicationCommandInput, diff --git a/clients/client-robomaker/commands/DeleteRobotCommand.ts b/clients/client-robomaker/commands/DeleteRobotCommand.ts index f421ffe980e0..e1e38ab89c6d 100644 --- a/clients/client-robomaker/commands/DeleteRobotCommand.ts +++ b/clients/client-robomaker/commands/DeleteRobotCommand.ts @@ -22,6 +22,20 @@ export interface DeleteRobotCommandOutput extends DeleteRobotResponse, __Metadat /** *

Deletes a robot.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { RoboMakerClient, DeleteRobotCommand } from "@aws-sdk/client-robomaker"; // ES Modules import + * // const { RoboMakerClient, DeleteRobotCommand } = require("@aws-sdk/client-robomaker"); // CommonJS import + * const client = new RoboMakerClient(config); + * const command = new DeleteRobotCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteRobotCommandInput} for command's `input` shape. + * @see {@link DeleteRobotCommandOutput} for command's `response` shape. + * @see {@link RoboMakerClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteRobotCommand extends $Command< DeleteRobotCommandInput, diff --git a/clients/client-robomaker/commands/DeleteSimulationApplicationCommand.ts b/clients/client-robomaker/commands/DeleteSimulationApplicationCommand.ts index d3f1174cb183..8ae473010a06 100644 --- a/clients/client-robomaker/commands/DeleteSimulationApplicationCommand.ts +++ b/clients/client-robomaker/commands/DeleteSimulationApplicationCommand.ts @@ -24,6 +24,20 @@ export interface DeleteSimulationApplicationCommandOutput /** *

Deletes a simulation application.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { RoboMakerClient, DeleteSimulationApplicationCommand } from "@aws-sdk/client-robomaker"; // ES Modules import + * // const { RoboMakerClient, DeleteSimulationApplicationCommand } = require("@aws-sdk/client-robomaker"); // CommonJS import + * const client = new RoboMakerClient(config); + * const command = new DeleteSimulationApplicationCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteSimulationApplicationCommandInput} for command's `input` shape. + * @see {@link DeleteSimulationApplicationCommandOutput} for command's `response` shape. + * @see {@link RoboMakerClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteSimulationApplicationCommand extends $Command< DeleteSimulationApplicationCommandInput, diff --git a/clients/client-robomaker/commands/DeleteWorldTemplateCommand.ts b/clients/client-robomaker/commands/DeleteWorldTemplateCommand.ts index 7f250bd55c62..97be13a6628a 100644 --- a/clients/client-robomaker/commands/DeleteWorldTemplateCommand.ts +++ b/clients/client-robomaker/commands/DeleteWorldTemplateCommand.ts @@ -22,6 +22,20 @@ export interface DeleteWorldTemplateCommandOutput extends DeleteWorldTemplateRes /** *

Deletes a world template.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { RoboMakerClient, DeleteWorldTemplateCommand } from "@aws-sdk/client-robomaker"; // ES Modules import + * // const { RoboMakerClient, DeleteWorldTemplateCommand } = require("@aws-sdk/client-robomaker"); // CommonJS import + * const client = new RoboMakerClient(config); + * const command = new DeleteWorldTemplateCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteWorldTemplateCommandInput} for command's `input` shape. + * @see {@link DeleteWorldTemplateCommandOutput} for command's `response` shape. + * @see {@link RoboMakerClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteWorldTemplateCommand extends $Command< DeleteWorldTemplateCommandInput, diff --git a/clients/client-robomaker/commands/DeregisterRobotCommand.ts b/clients/client-robomaker/commands/DeregisterRobotCommand.ts index 164d590914c4..788b091f4a80 100644 --- a/clients/client-robomaker/commands/DeregisterRobotCommand.ts +++ b/clients/client-robomaker/commands/DeregisterRobotCommand.ts @@ -22,6 +22,20 @@ export interface DeregisterRobotCommandOutput extends DeregisterRobotResponse, _ /** *

Deregisters a robot.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { RoboMakerClient, DeregisterRobotCommand } from "@aws-sdk/client-robomaker"; // ES Modules import + * // const { RoboMakerClient, DeregisterRobotCommand } = require("@aws-sdk/client-robomaker"); // CommonJS import + * const client = new RoboMakerClient(config); + * const command = new DeregisterRobotCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeregisterRobotCommandInput} for command's `input` shape. + * @see {@link DeregisterRobotCommandOutput} for command's `response` shape. + * @see {@link RoboMakerClientResolvedConfig | config} for command's `input` shape. + * */ export class DeregisterRobotCommand extends $Command< DeregisterRobotCommandInput, diff --git a/clients/client-robomaker/commands/DescribeDeploymentJobCommand.ts b/clients/client-robomaker/commands/DescribeDeploymentJobCommand.ts index 084effedee62..e799d3dabe7b 100644 --- a/clients/client-robomaker/commands/DescribeDeploymentJobCommand.ts +++ b/clients/client-robomaker/commands/DescribeDeploymentJobCommand.ts @@ -22,6 +22,20 @@ export interface DescribeDeploymentJobCommandOutput extends DescribeDeploymentJo /** *

Describes a deployment job.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { RoboMakerClient, DescribeDeploymentJobCommand } from "@aws-sdk/client-robomaker"; // ES Modules import + * // const { RoboMakerClient, DescribeDeploymentJobCommand } = require("@aws-sdk/client-robomaker"); // CommonJS import + * const client = new RoboMakerClient(config); + * const command = new DescribeDeploymentJobCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeDeploymentJobCommandInput} for command's `input` shape. + * @see {@link DescribeDeploymentJobCommandOutput} for command's `response` shape. + * @see {@link RoboMakerClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeDeploymentJobCommand extends $Command< DescribeDeploymentJobCommandInput, diff --git a/clients/client-robomaker/commands/DescribeFleetCommand.ts b/clients/client-robomaker/commands/DescribeFleetCommand.ts index ce54fca1027c..74afc1b854be 100644 --- a/clients/client-robomaker/commands/DescribeFleetCommand.ts +++ b/clients/client-robomaker/commands/DescribeFleetCommand.ts @@ -22,6 +22,20 @@ export interface DescribeFleetCommandOutput extends DescribeFleetResponse, __Met /** *

Describes a fleet.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { RoboMakerClient, DescribeFleetCommand } from "@aws-sdk/client-robomaker"; // ES Modules import + * // const { RoboMakerClient, DescribeFleetCommand } = require("@aws-sdk/client-robomaker"); // CommonJS import + * const client = new RoboMakerClient(config); + * const command = new DescribeFleetCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeFleetCommandInput} for command's `input` shape. + * @see {@link DescribeFleetCommandOutput} for command's `response` shape. + * @see {@link RoboMakerClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeFleetCommand extends $Command< DescribeFleetCommandInput, diff --git a/clients/client-robomaker/commands/DescribeRobotApplicationCommand.ts b/clients/client-robomaker/commands/DescribeRobotApplicationCommand.ts index be9699758eb7..f64286222838 100644 --- a/clients/client-robomaker/commands/DescribeRobotApplicationCommand.ts +++ b/clients/client-robomaker/commands/DescribeRobotApplicationCommand.ts @@ -22,6 +22,20 @@ export interface DescribeRobotApplicationCommandOutput extends DescribeRobotAppl /** *

Describes a robot application.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { RoboMakerClient, DescribeRobotApplicationCommand } from "@aws-sdk/client-robomaker"; // ES Modules import + * // const { RoboMakerClient, DescribeRobotApplicationCommand } = require("@aws-sdk/client-robomaker"); // CommonJS import + * const client = new RoboMakerClient(config); + * const command = new DescribeRobotApplicationCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeRobotApplicationCommandInput} for command's `input` shape. + * @see {@link DescribeRobotApplicationCommandOutput} for command's `response` shape. + * @see {@link RoboMakerClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeRobotApplicationCommand extends $Command< DescribeRobotApplicationCommandInput, diff --git a/clients/client-robomaker/commands/DescribeRobotCommand.ts b/clients/client-robomaker/commands/DescribeRobotCommand.ts index 7814a50f3646..0e468574513a 100644 --- a/clients/client-robomaker/commands/DescribeRobotCommand.ts +++ b/clients/client-robomaker/commands/DescribeRobotCommand.ts @@ -22,6 +22,20 @@ export interface DescribeRobotCommandOutput extends DescribeRobotResponse, __Met /** *

Describes a robot.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { RoboMakerClient, DescribeRobotCommand } from "@aws-sdk/client-robomaker"; // ES Modules import + * // const { RoboMakerClient, DescribeRobotCommand } = require("@aws-sdk/client-robomaker"); // CommonJS import + * const client = new RoboMakerClient(config); + * const command = new DescribeRobotCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeRobotCommandInput} for command's `input` shape. + * @see {@link DescribeRobotCommandOutput} for command's `response` shape. + * @see {@link RoboMakerClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeRobotCommand extends $Command< DescribeRobotCommandInput, diff --git a/clients/client-robomaker/commands/DescribeSimulationApplicationCommand.ts b/clients/client-robomaker/commands/DescribeSimulationApplicationCommand.ts index fada7f26d9bf..747f8d537171 100644 --- a/clients/client-robomaker/commands/DescribeSimulationApplicationCommand.ts +++ b/clients/client-robomaker/commands/DescribeSimulationApplicationCommand.ts @@ -24,6 +24,20 @@ export interface DescribeSimulationApplicationCommandOutput /** *

Describes a simulation application.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { RoboMakerClient, DescribeSimulationApplicationCommand } from "@aws-sdk/client-robomaker"; // ES Modules import + * // const { RoboMakerClient, DescribeSimulationApplicationCommand } = require("@aws-sdk/client-robomaker"); // CommonJS import + * const client = new RoboMakerClient(config); + * const command = new DescribeSimulationApplicationCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeSimulationApplicationCommandInput} for command's `input` shape. + * @see {@link DescribeSimulationApplicationCommandOutput} for command's `response` shape. + * @see {@link RoboMakerClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeSimulationApplicationCommand extends $Command< DescribeSimulationApplicationCommandInput, diff --git a/clients/client-robomaker/commands/DescribeSimulationJobBatchCommand.ts b/clients/client-robomaker/commands/DescribeSimulationJobBatchCommand.ts index 69261ccef924..f8661db042c0 100644 --- a/clients/client-robomaker/commands/DescribeSimulationJobBatchCommand.ts +++ b/clients/client-robomaker/commands/DescribeSimulationJobBatchCommand.ts @@ -22,6 +22,20 @@ export interface DescribeSimulationJobBatchCommandOutput extends DescribeSimulat /** *

Describes a simulation job batch.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { RoboMakerClient, DescribeSimulationJobBatchCommand } from "@aws-sdk/client-robomaker"; // ES Modules import + * // const { RoboMakerClient, DescribeSimulationJobBatchCommand } = require("@aws-sdk/client-robomaker"); // CommonJS import + * const client = new RoboMakerClient(config); + * const command = new DescribeSimulationJobBatchCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeSimulationJobBatchCommandInput} for command's `input` shape. + * @see {@link DescribeSimulationJobBatchCommandOutput} for command's `response` shape. + * @see {@link RoboMakerClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeSimulationJobBatchCommand extends $Command< DescribeSimulationJobBatchCommandInput, diff --git a/clients/client-robomaker/commands/DescribeSimulationJobCommand.ts b/clients/client-robomaker/commands/DescribeSimulationJobCommand.ts index 22759c28837b..5447a95c03ea 100644 --- a/clients/client-robomaker/commands/DescribeSimulationJobCommand.ts +++ b/clients/client-robomaker/commands/DescribeSimulationJobCommand.ts @@ -22,6 +22,20 @@ export interface DescribeSimulationJobCommandOutput extends DescribeSimulationJo /** *

Describes a simulation job.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { RoboMakerClient, DescribeSimulationJobCommand } from "@aws-sdk/client-robomaker"; // ES Modules import + * // const { RoboMakerClient, DescribeSimulationJobCommand } = require("@aws-sdk/client-robomaker"); // CommonJS import + * const client = new RoboMakerClient(config); + * const command = new DescribeSimulationJobCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeSimulationJobCommandInput} for command's `input` shape. + * @see {@link DescribeSimulationJobCommandOutput} for command's `response` shape. + * @see {@link RoboMakerClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeSimulationJobCommand extends $Command< DescribeSimulationJobCommandInput, diff --git a/clients/client-robomaker/commands/DescribeWorldCommand.ts b/clients/client-robomaker/commands/DescribeWorldCommand.ts index 1a2f729bfb55..e4f0bf8f17d6 100644 --- a/clients/client-robomaker/commands/DescribeWorldCommand.ts +++ b/clients/client-robomaker/commands/DescribeWorldCommand.ts @@ -22,6 +22,20 @@ export interface DescribeWorldCommandOutput extends DescribeWorldResponse, __Met /** *

Describes a world.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { RoboMakerClient, DescribeWorldCommand } from "@aws-sdk/client-robomaker"; // ES Modules import + * // const { RoboMakerClient, DescribeWorldCommand } = require("@aws-sdk/client-robomaker"); // CommonJS import + * const client = new RoboMakerClient(config); + * const command = new DescribeWorldCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeWorldCommandInput} for command's `input` shape. + * @see {@link DescribeWorldCommandOutput} for command's `response` shape. + * @see {@link RoboMakerClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeWorldCommand extends $Command< DescribeWorldCommandInput, diff --git a/clients/client-robomaker/commands/DescribeWorldExportJobCommand.ts b/clients/client-robomaker/commands/DescribeWorldExportJobCommand.ts index be554a151c0f..1cb7c9cdf213 100644 --- a/clients/client-robomaker/commands/DescribeWorldExportJobCommand.ts +++ b/clients/client-robomaker/commands/DescribeWorldExportJobCommand.ts @@ -22,6 +22,20 @@ export interface DescribeWorldExportJobCommandOutput extends DescribeWorldExport /** *

Describes a world export job.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { RoboMakerClient, DescribeWorldExportJobCommand } from "@aws-sdk/client-robomaker"; // ES Modules import + * // const { RoboMakerClient, DescribeWorldExportJobCommand } = require("@aws-sdk/client-robomaker"); // CommonJS import + * const client = new RoboMakerClient(config); + * const command = new DescribeWorldExportJobCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeWorldExportJobCommandInput} for command's `input` shape. + * @see {@link DescribeWorldExportJobCommandOutput} for command's `response` shape. + * @see {@link RoboMakerClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeWorldExportJobCommand extends $Command< DescribeWorldExportJobCommandInput, diff --git a/clients/client-robomaker/commands/DescribeWorldGenerationJobCommand.ts b/clients/client-robomaker/commands/DescribeWorldGenerationJobCommand.ts index 5bc95d402914..9fcde5db8b1e 100644 --- a/clients/client-robomaker/commands/DescribeWorldGenerationJobCommand.ts +++ b/clients/client-robomaker/commands/DescribeWorldGenerationJobCommand.ts @@ -22,6 +22,20 @@ export interface DescribeWorldGenerationJobCommandOutput extends DescribeWorldGe /** *

Describes a world generation job.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { RoboMakerClient, DescribeWorldGenerationJobCommand } from "@aws-sdk/client-robomaker"; // ES Modules import + * // const { RoboMakerClient, DescribeWorldGenerationJobCommand } = require("@aws-sdk/client-robomaker"); // CommonJS import + * const client = new RoboMakerClient(config); + * const command = new DescribeWorldGenerationJobCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeWorldGenerationJobCommandInput} for command's `input` shape. + * @see {@link DescribeWorldGenerationJobCommandOutput} for command's `response` shape. + * @see {@link RoboMakerClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeWorldGenerationJobCommand extends $Command< DescribeWorldGenerationJobCommandInput, diff --git a/clients/client-robomaker/commands/DescribeWorldTemplateCommand.ts b/clients/client-robomaker/commands/DescribeWorldTemplateCommand.ts index 956f7d244247..b8154a976d05 100644 --- a/clients/client-robomaker/commands/DescribeWorldTemplateCommand.ts +++ b/clients/client-robomaker/commands/DescribeWorldTemplateCommand.ts @@ -22,6 +22,20 @@ export interface DescribeWorldTemplateCommandOutput extends DescribeWorldTemplat /** *

Describes a world template.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { RoboMakerClient, DescribeWorldTemplateCommand } from "@aws-sdk/client-robomaker"; // ES Modules import + * // const { RoboMakerClient, DescribeWorldTemplateCommand } = require("@aws-sdk/client-robomaker"); // CommonJS import + * const client = new RoboMakerClient(config); + * const command = new DescribeWorldTemplateCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeWorldTemplateCommandInput} for command's `input` shape. + * @see {@link DescribeWorldTemplateCommandOutput} for command's `response` shape. + * @see {@link RoboMakerClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeWorldTemplateCommand extends $Command< DescribeWorldTemplateCommandInput, diff --git a/clients/client-robomaker/commands/GetWorldTemplateBodyCommand.ts b/clients/client-robomaker/commands/GetWorldTemplateBodyCommand.ts index 2a8fc3a8ebd9..6bc11f8356cf 100644 --- a/clients/client-robomaker/commands/GetWorldTemplateBodyCommand.ts +++ b/clients/client-robomaker/commands/GetWorldTemplateBodyCommand.ts @@ -22,6 +22,20 @@ export interface GetWorldTemplateBodyCommandOutput extends GetWorldTemplateBodyR /** *

Gets the world template body.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { RoboMakerClient, GetWorldTemplateBodyCommand } from "@aws-sdk/client-robomaker"; // ES Modules import + * // const { RoboMakerClient, GetWorldTemplateBodyCommand } = require("@aws-sdk/client-robomaker"); // CommonJS import + * const client = new RoboMakerClient(config); + * const command = new GetWorldTemplateBodyCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetWorldTemplateBodyCommandInput} for command's `input` shape. + * @see {@link GetWorldTemplateBodyCommandOutput} for command's `response` shape. + * @see {@link RoboMakerClientResolvedConfig | config} for command's `input` shape. + * */ export class GetWorldTemplateBodyCommand extends $Command< GetWorldTemplateBodyCommandInput, diff --git a/clients/client-robomaker/commands/ListDeploymentJobsCommand.ts b/clients/client-robomaker/commands/ListDeploymentJobsCommand.ts index ff6944d7599c..08055d5602fd 100644 --- a/clients/client-robomaker/commands/ListDeploymentJobsCommand.ts +++ b/clients/client-robomaker/commands/ListDeploymentJobsCommand.ts @@ -23,6 +23,20 @@ export interface ListDeploymentJobsCommandOutput extends ListDeploymentJobsRespo /** *

Returns a list of deployment jobs for a fleet. You can optionally provide filters to * retrieve specific deployment jobs.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { RoboMakerClient, ListDeploymentJobsCommand } from "@aws-sdk/client-robomaker"; // ES Modules import + * // const { RoboMakerClient, ListDeploymentJobsCommand } = require("@aws-sdk/client-robomaker"); // CommonJS import + * const client = new RoboMakerClient(config); + * const command = new ListDeploymentJobsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListDeploymentJobsCommandInput} for command's `input` shape. + * @see {@link ListDeploymentJobsCommandOutput} for command's `response` shape. + * @see {@link RoboMakerClientResolvedConfig | config} for command's `input` shape. + * */ export class ListDeploymentJobsCommand extends $Command< ListDeploymentJobsCommandInput, diff --git a/clients/client-robomaker/commands/ListFleetsCommand.ts b/clients/client-robomaker/commands/ListFleetsCommand.ts index 5ad5527bdeb3..89771ad2d341 100644 --- a/clients/client-robomaker/commands/ListFleetsCommand.ts +++ b/clients/client-robomaker/commands/ListFleetsCommand.ts @@ -23,6 +23,20 @@ export interface ListFleetsCommandOutput extends ListFleetsResponse, __MetadataB /** *

Returns a list of fleets. You can optionally provide filters to retrieve specific * fleets.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { RoboMakerClient, ListFleetsCommand } from "@aws-sdk/client-robomaker"; // ES Modules import + * // const { RoboMakerClient, ListFleetsCommand } = require("@aws-sdk/client-robomaker"); // CommonJS import + * const client = new RoboMakerClient(config); + * const command = new ListFleetsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListFleetsCommandInput} for command's `input` shape. + * @see {@link ListFleetsCommandOutput} for command's `response` shape. + * @see {@link RoboMakerClientResolvedConfig | config} for command's `input` shape. + * */ export class ListFleetsCommand extends $Command< ListFleetsCommandInput, diff --git a/clients/client-robomaker/commands/ListRobotApplicationsCommand.ts b/clients/client-robomaker/commands/ListRobotApplicationsCommand.ts index d9525bbd375b..1eaaa8b4e35b 100644 --- a/clients/client-robomaker/commands/ListRobotApplicationsCommand.ts +++ b/clients/client-robomaker/commands/ListRobotApplicationsCommand.ts @@ -23,6 +23,20 @@ export interface ListRobotApplicationsCommandOutput extends ListRobotApplication /** *

Returns a list of robot application. You can optionally provide filters to retrieve * specific robot applications.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { RoboMakerClient, ListRobotApplicationsCommand } from "@aws-sdk/client-robomaker"; // ES Modules import + * // const { RoboMakerClient, ListRobotApplicationsCommand } = require("@aws-sdk/client-robomaker"); // CommonJS import + * const client = new RoboMakerClient(config); + * const command = new ListRobotApplicationsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListRobotApplicationsCommandInput} for command's `input` shape. + * @see {@link ListRobotApplicationsCommandOutput} for command's `response` shape. + * @see {@link RoboMakerClientResolvedConfig | config} for command's `input` shape. + * */ export class ListRobotApplicationsCommand extends $Command< ListRobotApplicationsCommandInput, diff --git a/clients/client-robomaker/commands/ListRobotsCommand.ts b/clients/client-robomaker/commands/ListRobotsCommand.ts index 1109447999fc..f811dc1012e1 100644 --- a/clients/client-robomaker/commands/ListRobotsCommand.ts +++ b/clients/client-robomaker/commands/ListRobotsCommand.ts @@ -23,6 +23,20 @@ export interface ListRobotsCommandOutput extends ListRobotsResponse, __MetadataB /** *

Returns a list of robots. You can optionally provide filters to retrieve specific * robots.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { RoboMakerClient, ListRobotsCommand } from "@aws-sdk/client-robomaker"; // ES Modules import + * // const { RoboMakerClient, ListRobotsCommand } = require("@aws-sdk/client-robomaker"); // CommonJS import + * const client = new RoboMakerClient(config); + * const command = new ListRobotsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListRobotsCommandInput} for command's `input` shape. + * @see {@link ListRobotsCommandOutput} for command's `response` shape. + * @see {@link RoboMakerClientResolvedConfig | config} for command's `input` shape. + * */ export class ListRobotsCommand extends $Command< ListRobotsCommandInput, diff --git a/clients/client-robomaker/commands/ListSimulationApplicationsCommand.ts b/clients/client-robomaker/commands/ListSimulationApplicationsCommand.ts index 4302abce0e7a..614605fa78b9 100644 --- a/clients/client-robomaker/commands/ListSimulationApplicationsCommand.ts +++ b/clients/client-robomaker/commands/ListSimulationApplicationsCommand.ts @@ -23,6 +23,20 @@ export interface ListSimulationApplicationsCommandOutput extends ListSimulationA /** *

Returns a list of simulation applications. You can optionally provide filters to * retrieve specific simulation applications.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { RoboMakerClient, ListSimulationApplicationsCommand } from "@aws-sdk/client-robomaker"; // ES Modules import + * // const { RoboMakerClient, ListSimulationApplicationsCommand } = require("@aws-sdk/client-robomaker"); // CommonJS import + * const client = new RoboMakerClient(config); + * const command = new ListSimulationApplicationsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListSimulationApplicationsCommandInput} for command's `input` shape. + * @see {@link ListSimulationApplicationsCommandOutput} for command's `response` shape. + * @see {@link RoboMakerClientResolvedConfig | config} for command's `input` shape. + * */ export class ListSimulationApplicationsCommand extends $Command< ListSimulationApplicationsCommandInput, diff --git a/clients/client-robomaker/commands/ListSimulationJobBatchesCommand.ts b/clients/client-robomaker/commands/ListSimulationJobBatchesCommand.ts index cce85827f9f4..1c6b027d2d56 100644 --- a/clients/client-robomaker/commands/ListSimulationJobBatchesCommand.ts +++ b/clients/client-robomaker/commands/ListSimulationJobBatchesCommand.ts @@ -23,6 +23,20 @@ export interface ListSimulationJobBatchesCommandOutput extends ListSimulationJob /** *

Returns a list simulation job batches. You can optionally provide filters to retrieve * specific simulation batch jobs.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { RoboMakerClient, ListSimulationJobBatchesCommand } from "@aws-sdk/client-robomaker"; // ES Modules import + * // const { RoboMakerClient, ListSimulationJobBatchesCommand } = require("@aws-sdk/client-robomaker"); // CommonJS import + * const client = new RoboMakerClient(config); + * const command = new ListSimulationJobBatchesCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListSimulationJobBatchesCommandInput} for command's `input` shape. + * @see {@link ListSimulationJobBatchesCommandOutput} for command's `response` shape. + * @see {@link RoboMakerClientResolvedConfig | config} for command's `input` shape. + * */ export class ListSimulationJobBatchesCommand extends $Command< ListSimulationJobBatchesCommandInput, diff --git a/clients/client-robomaker/commands/ListSimulationJobsCommand.ts b/clients/client-robomaker/commands/ListSimulationJobsCommand.ts index 8c1e5e81df58..b8ed328e63f1 100644 --- a/clients/client-robomaker/commands/ListSimulationJobsCommand.ts +++ b/clients/client-robomaker/commands/ListSimulationJobsCommand.ts @@ -23,6 +23,20 @@ export interface ListSimulationJobsCommandOutput extends ListSimulationJobsRespo /** *

Returns a list of simulation jobs. You can optionally provide filters to retrieve * specific simulation jobs.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { RoboMakerClient, ListSimulationJobsCommand } from "@aws-sdk/client-robomaker"; // ES Modules import + * // const { RoboMakerClient, ListSimulationJobsCommand } = require("@aws-sdk/client-robomaker"); // CommonJS import + * const client = new RoboMakerClient(config); + * const command = new ListSimulationJobsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListSimulationJobsCommandInput} for command's `input` shape. + * @see {@link ListSimulationJobsCommandOutput} for command's `response` shape. + * @see {@link RoboMakerClientResolvedConfig | config} for command's `input` shape. + * */ export class ListSimulationJobsCommand extends $Command< ListSimulationJobsCommandInput, diff --git a/clients/client-robomaker/commands/ListTagsForResourceCommand.ts b/clients/client-robomaker/commands/ListTagsForResourceCommand.ts index 814f3ee43857..05440ea26240 100644 --- a/clients/client-robomaker/commands/ListTagsForResourceCommand.ts +++ b/clients/client-robomaker/commands/ListTagsForResourceCommand.ts @@ -22,6 +22,20 @@ export interface ListTagsForResourceCommandOutput extends ListTagsForResourceRes /** *

Lists all tags on a AWS RoboMaker resource.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { RoboMakerClient, ListTagsForResourceCommand } from "@aws-sdk/client-robomaker"; // ES Modules import + * // const { RoboMakerClient, ListTagsForResourceCommand } = require("@aws-sdk/client-robomaker"); // CommonJS import + * const client = new RoboMakerClient(config); + * const command = new ListTagsForResourceCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListTagsForResourceCommandInput} for command's `input` shape. + * @see {@link ListTagsForResourceCommandOutput} for command's `response` shape. + * @see {@link RoboMakerClientResolvedConfig | config} for command's `input` shape. + * */ export class ListTagsForResourceCommand extends $Command< ListTagsForResourceCommandInput, diff --git a/clients/client-robomaker/commands/ListWorldExportJobsCommand.ts b/clients/client-robomaker/commands/ListWorldExportJobsCommand.ts index d4a10ba9dd11..c96924eeccea 100644 --- a/clients/client-robomaker/commands/ListWorldExportJobsCommand.ts +++ b/clients/client-robomaker/commands/ListWorldExportJobsCommand.ts @@ -22,6 +22,20 @@ export interface ListWorldExportJobsCommandOutput extends ListWorldExportJobsRes /** *

Lists world export jobs.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { RoboMakerClient, ListWorldExportJobsCommand } from "@aws-sdk/client-robomaker"; // ES Modules import + * // const { RoboMakerClient, ListWorldExportJobsCommand } = require("@aws-sdk/client-robomaker"); // CommonJS import + * const client = new RoboMakerClient(config); + * const command = new ListWorldExportJobsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListWorldExportJobsCommandInput} for command's `input` shape. + * @see {@link ListWorldExportJobsCommandOutput} for command's `response` shape. + * @see {@link RoboMakerClientResolvedConfig | config} for command's `input` shape. + * */ export class ListWorldExportJobsCommand extends $Command< ListWorldExportJobsCommandInput, diff --git a/clients/client-robomaker/commands/ListWorldGenerationJobsCommand.ts b/clients/client-robomaker/commands/ListWorldGenerationJobsCommand.ts index 0fac7b99f978..93f6598ce752 100644 --- a/clients/client-robomaker/commands/ListWorldGenerationJobsCommand.ts +++ b/clients/client-robomaker/commands/ListWorldGenerationJobsCommand.ts @@ -22,6 +22,20 @@ export interface ListWorldGenerationJobsCommandOutput extends ListWorldGeneratio /** *

Lists world generator jobs.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { RoboMakerClient, ListWorldGenerationJobsCommand } from "@aws-sdk/client-robomaker"; // ES Modules import + * // const { RoboMakerClient, ListWorldGenerationJobsCommand } = require("@aws-sdk/client-robomaker"); // CommonJS import + * const client = new RoboMakerClient(config); + * const command = new ListWorldGenerationJobsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListWorldGenerationJobsCommandInput} for command's `input` shape. + * @see {@link ListWorldGenerationJobsCommandOutput} for command's `response` shape. + * @see {@link RoboMakerClientResolvedConfig | config} for command's `input` shape. + * */ export class ListWorldGenerationJobsCommand extends $Command< ListWorldGenerationJobsCommandInput, diff --git a/clients/client-robomaker/commands/ListWorldTemplatesCommand.ts b/clients/client-robomaker/commands/ListWorldTemplatesCommand.ts index c40f2c5b5a78..3e131e07dc5a 100644 --- a/clients/client-robomaker/commands/ListWorldTemplatesCommand.ts +++ b/clients/client-robomaker/commands/ListWorldTemplatesCommand.ts @@ -22,6 +22,20 @@ export interface ListWorldTemplatesCommandOutput extends ListWorldTemplatesRespo /** *

Lists world templates.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { RoboMakerClient, ListWorldTemplatesCommand } from "@aws-sdk/client-robomaker"; // ES Modules import + * // const { RoboMakerClient, ListWorldTemplatesCommand } = require("@aws-sdk/client-robomaker"); // CommonJS import + * const client = new RoboMakerClient(config); + * const command = new ListWorldTemplatesCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListWorldTemplatesCommandInput} for command's `input` shape. + * @see {@link ListWorldTemplatesCommandOutput} for command's `response` shape. + * @see {@link RoboMakerClientResolvedConfig | config} for command's `input` shape. + * */ export class ListWorldTemplatesCommand extends $Command< ListWorldTemplatesCommandInput, diff --git a/clients/client-robomaker/commands/ListWorldsCommand.ts b/clients/client-robomaker/commands/ListWorldsCommand.ts index 5f8f7227e7d6..f35c1209e983 100644 --- a/clients/client-robomaker/commands/ListWorldsCommand.ts +++ b/clients/client-robomaker/commands/ListWorldsCommand.ts @@ -22,6 +22,20 @@ export interface ListWorldsCommandOutput extends ListWorldsResponse, __MetadataB /** *

Lists worlds.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { RoboMakerClient, ListWorldsCommand } from "@aws-sdk/client-robomaker"; // ES Modules import + * // const { RoboMakerClient, ListWorldsCommand } = require("@aws-sdk/client-robomaker"); // CommonJS import + * const client = new RoboMakerClient(config); + * const command = new ListWorldsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListWorldsCommandInput} for command's `input` shape. + * @see {@link ListWorldsCommandOutput} for command's `response` shape. + * @see {@link RoboMakerClientResolvedConfig | config} for command's `input` shape. + * */ export class ListWorldsCommand extends $Command< ListWorldsCommandInput, diff --git a/clients/client-robomaker/commands/RegisterRobotCommand.ts b/clients/client-robomaker/commands/RegisterRobotCommand.ts index 4a0f3bf2eeef..d96ad2216811 100644 --- a/clients/client-robomaker/commands/RegisterRobotCommand.ts +++ b/clients/client-robomaker/commands/RegisterRobotCommand.ts @@ -22,6 +22,20 @@ export interface RegisterRobotCommandOutput extends RegisterRobotResponse, __Met /** *

Registers a robot with a fleet.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { RoboMakerClient, RegisterRobotCommand } from "@aws-sdk/client-robomaker"; // ES Modules import + * // const { RoboMakerClient, RegisterRobotCommand } = require("@aws-sdk/client-robomaker"); // CommonJS import + * const client = new RoboMakerClient(config); + * const command = new RegisterRobotCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link RegisterRobotCommandInput} for command's `input` shape. + * @see {@link RegisterRobotCommandOutput} for command's `response` shape. + * @see {@link RoboMakerClientResolvedConfig | config} for command's `input` shape. + * */ export class RegisterRobotCommand extends $Command< RegisterRobotCommandInput, diff --git a/clients/client-robomaker/commands/RestartSimulationJobCommand.ts b/clients/client-robomaker/commands/RestartSimulationJobCommand.ts index 7e83f1404df3..48e00d39ee16 100644 --- a/clients/client-robomaker/commands/RestartSimulationJobCommand.ts +++ b/clients/client-robomaker/commands/RestartSimulationJobCommand.ts @@ -22,6 +22,20 @@ export interface RestartSimulationJobCommandOutput extends RestartSimulationJobR /** *

Restarts a running simulation job.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { RoboMakerClient, RestartSimulationJobCommand } from "@aws-sdk/client-robomaker"; // ES Modules import + * // const { RoboMakerClient, RestartSimulationJobCommand } = require("@aws-sdk/client-robomaker"); // CommonJS import + * const client = new RoboMakerClient(config); + * const command = new RestartSimulationJobCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link RestartSimulationJobCommandInput} for command's `input` shape. + * @see {@link RestartSimulationJobCommandOutput} for command's `response` shape. + * @see {@link RoboMakerClientResolvedConfig | config} for command's `input` shape. + * */ export class RestartSimulationJobCommand extends $Command< RestartSimulationJobCommandInput, diff --git a/clients/client-robomaker/commands/StartSimulationJobBatchCommand.ts b/clients/client-robomaker/commands/StartSimulationJobBatchCommand.ts index 14aa14d48a32..1692aa8f68f8 100644 --- a/clients/client-robomaker/commands/StartSimulationJobBatchCommand.ts +++ b/clients/client-robomaker/commands/StartSimulationJobBatchCommand.ts @@ -23,6 +23,20 @@ export interface StartSimulationJobBatchCommandOutput extends StartSimulationJob /** *

Starts a new simulation job batch. The batch is defined using one or more * SimulationJobRequest objects.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { RoboMakerClient, StartSimulationJobBatchCommand } from "@aws-sdk/client-robomaker"; // ES Modules import + * // const { RoboMakerClient, StartSimulationJobBatchCommand } = require("@aws-sdk/client-robomaker"); // CommonJS import + * const client = new RoboMakerClient(config); + * const command = new StartSimulationJobBatchCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link StartSimulationJobBatchCommandInput} for command's `input` shape. + * @see {@link StartSimulationJobBatchCommandOutput} for command's `response` shape. + * @see {@link RoboMakerClientResolvedConfig | config} for command's `input` shape. + * */ export class StartSimulationJobBatchCommand extends $Command< StartSimulationJobBatchCommandInput, diff --git a/clients/client-robomaker/commands/SyncDeploymentJobCommand.ts b/clients/client-robomaker/commands/SyncDeploymentJobCommand.ts index e83b5aece660..4556650e9c96 100644 --- a/clients/client-robomaker/commands/SyncDeploymentJobCommand.ts +++ b/clients/client-robomaker/commands/SyncDeploymentJobCommand.ts @@ -23,6 +23,20 @@ export interface SyncDeploymentJobCommandOutput extends SyncDeploymentJobRespons /** *

Syncrhonizes robots in a fleet to the latest deployment. This is helpful if robots were * added after a deployment.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { RoboMakerClient, SyncDeploymentJobCommand } from "@aws-sdk/client-robomaker"; // ES Modules import + * // const { RoboMakerClient, SyncDeploymentJobCommand } = require("@aws-sdk/client-robomaker"); // CommonJS import + * const client = new RoboMakerClient(config); + * const command = new SyncDeploymentJobCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link SyncDeploymentJobCommandInput} for command's `input` shape. + * @see {@link SyncDeploymentJobCommandOutput} for command's `response` shape. + * @see {@link RoboMakerClientResolvedConfig | config} for command's `input` shape. + * */ export class SyncDeploymentJobCommand extends $Command< SyncDeploymentJobCommandInput, diff --git a/clients/client-robomaker/commands/TagResourceCommand.ts b/clients/client-robomaker/commands/TagResourceCommand.ts index 8e1e5aa499b9..13caf7ba3394 100644 --- a/clients/client-robomaker/commands/TagResourceCommand.ts +++ b/clients/client-robomaker/commands/TagResourceCommand.ts @@ -26,6 +26,20 @@ export interface TagResourceCommandOutput extends TagResourceResponse, __Metadat * 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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { RoboMakerClient, TagResourceCommand } from "@aws-sdk/client-robomaker"; // ES Modules import + * // const { RoboMakerClient, TagResourceCommand } = require("@aws-sdk/client-robomaker"); // CommonJS import + * const client = new RoboMakerClient(config); + * const command = new TagResourceCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link TagResourceCommandInput} for command's `input` shape. + * @see {@link TagResourceCommandOutput} for command's `response` shape. + * @see {@link RoboMakerClientResolvedConfig | config} for command's `input` shape. + * */ export class TagResourceCommand extends $Command< TagResourceCommandInput, diff --git a/clients/client-robomaker/commands/UntagResourceCommand.ts b/clients/client-robomaker/commands/UntagResourceCommand.ts index 0abd741dd17d..4e6b6ec17373 100644 --- a/clients/client-robomaker/commands/UntagResourceCommand.ts +++ b/clients/client-robomaker/commands/UntagResourceCommand.ts @@ -26,6 +26,20 @@ export interface UntagResourceCommandOutput extends UntagResourceResponse, __Met * use * TagResource * .

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { RoboMakerClient, UntagResourceCommand } from "@aws-sdk/client-robomaker"; // ES Modules import + * // const { RoboMakerClient, UntagResourceCommand } = require("@aws-sdk/client-robomaker"); // CommonJS import + * const client = new RoboMakerClient(config); + * const command = new UntagResourceCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link UntagResourceCommandInput} for command's `input` shape. + * @see {@link UntagResourceCommandOutput} for command's `response` shape. + * @see {@link RoboMakerClientResolvedConfig | config} for command's `input` shape. + * */ export class UntagResourceCommand extends $Command< UntagResourceCommandInput, diff --git a/clients/client-robomaker/commands/UpdateRobotApplicationCommand.ts b/clients/client-robomaker/commands/UpdateRobotApplicationCommand.ts index ff7f041747ad..d46b740568c1 100644 --- a/clients/client-robomaker/commands/UpdateRobotApplicationCommand.ts +++ b/clients/client-robomaker/commands/UpdateRobotApplicationCommand.ts @@ -22,6 +22,20 @@ export interface UpdateRobotApplicationCommandOutput extends UpdateRobotApplicat /** *

Updates a robot application.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { RoboMakerClient, UpdateRobotApplicationCommand } from "@aws-sdk/client-robomaker"; // ES Modules import + * // const { RoboMakerClient, UpdateRobotApplicationCommand } = require("@aws-sdk/client-robomaker"); // CommonJS import + * const client = new RoboMakerClient(config); + * const command = new UpdateRobotApplicationCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link UpdateRobotApplicationCommandInput} for command's `input` shape. + * @see {@link UpdateRobotApplicationCommandOutput} for command's `response` shape. + * @see {@link RoboMakerClientResolvedConfig | config} for command's `input` shape. + * */ export class UpdateRobotApplicationCommand extends $Command< UpdateRobotApplicationCommandInput, diff --git a/clients/client-robomaker/commands/UpdateSimulationApplicationCommand.ts b/clients/client-robomaker/commands/UpdateSimulationApplicationCommand.ts index a22c09a438f5..6945dbf9f99b 100644 --- a/clients/client-robomaker/commands/UpdateSimulationApplicationCommand.ts +++ b/clients/client-robomaker/commands/UpdateSimulationApplicationCommand.ts @@ -24,6 +24,20 @@ export interface UpdateSimulationApplicationCommandOutput /** *

Updates a simulation application.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { RoboMakerClient, UpdateSimulationApplicationCommand } from "@aws-sdk/client-robomaker"; // ES Modules import + * // const { RoboMakerClient, UpdateSimulationApplicationCommand } = require("@aws-sdk/client-robomaker"); // CommonJS import + * const client = new RoboMakerClient(config); + * const command = new UpdateSimulationApplicationCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link UpdateSimulationApplicationCommandInput} for command's `input` shape. + * @see {@link UpdateSimulationApplicationCommandOutput} for command's `response` shape. + * @see {@link RoboMakerClientResolvedConfig | config} for command's `input` shape. + * */ export class UpdateSimulationApplicationCommand extends $Command< UpdateSimulationApplicationCommandInput, diff --git a/clients/client-robomaker/commands/UpdateWorldTemplateCommand.ts b/clients/client-robomaker/commands/UpdateWorldTemplateCommand.ts index 3c7f5586c619..25dfaff4d4ad 100644 --- a/clients/client-robomaker/commands/UpdateWorldTemplateCommand.ts +++ b/clients/client-robomaker/commands/UpdateWorldTemplateCommand.ts @@ -22,6 +22,20 @@ export interface UpdateWorldTemplateCommandOutput extends UpdateWorldTemplateRes /** *

Updates a world template.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { RoboMakerClient, UpdateWorldTemplateCommand } from "@aws-sdk/client-robomaker"; // ES Modules import + * // const { RoboMakerClient, UpdateWorldTemplateCommand } = require("@aws-sdk/client-robomaker"); // CommonJS import + * const client = new RoboMakerClient(config); + * const command = new UpdateWorldTemplateCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link UpdateWorldTemplateCommandInput} for command's `input` shape. + * @see {@link UpdateWorldTemplateCommandOutput} for command's `response` shape. + * @see {@link RoboMakerClientResolvedConfig | config} for command's `input` shape. + * */ export class UpdateWorldTemplateCommand extends $Command< UpdateWorldTemplateCommandInput, diff --git a/clients/client-robomaker/models/models_0.ts b/clients/client-robomaker/models/models_0.ts index 3ca27057dba7..d10c8f9c9e45 100644 --- a/clients/client-robomaker/models/models_0.ts +++ b/clients/client-robomaker/models/models_0.ts @@ -15,6 +15,9 @@ export interface BatchDeleteWorldsRequest { } export namespace BatchDeleteWorldsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: BatchDeleteWorldsRequest): any => ({ ...obj, }); @@ -29,6 +32,9 @@ export interface BatchDeleteWorldsResponse { } export namespace BatchDeleteWorldsResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: BatchDeleteWorldsResponse): any => ({ ...obj, }); @@ -44,6 +50,9 @@ export interface InternalServerException extends __SmithyException, $MetadataBea } export namespace InternalServerException { + /** + * @internal + */ export const filterSensitiveLog = (obj: InternalServerException): any => ({ ...obj, }); @@ -60,6 +69,9 @@ export interface InvalidParameterException extends __SmithyException, $MetadataB } export namespace InvalidParameterException { + /** + * @internal + */ export const filterSensitiveLog = (obj: InvalidParameterException): any => ({ ...obj, }); @@ -75,6 +87,9 @@ export interface ThrottlingException extends __SmithyException, $MetadataBearer } export namespace ThrottlingException { + /** + * @internal + */ export const filterSensitiveLog = (obj: ThrottlingException): any => ({ ...obj, }); @@ -88,6 +103,9 @@ export interface BatchDescribeSimulationJobRequest { } export namespace BatchDescribeSimulationJobRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: BatchDescribeSimulationJobRequest): any => ({ ...obj, }); @@ -107,6 +125,9 @@ export interface ComputeResponse { } export namespace ComputeResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ComputeResponse): any => ({ ...obj, }); @@ -128,6 +149,9 @@ export interface S3KeyOutput { } export namespace S3KeyOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: S3KeyOutput): any => ({ ...obj, }); @@ -154,6 +178,9 @@ export interface DataSource { } export namespace DataSource { + /** + * @internal + */ export const filterSensitiveLog = (obj: DataSource): any => ({ ...obj, }); @@ -209,6 +236,9 @@ export interface LoggingConfig { } export namespace LoggingConfig { + /** + * @internal + */ export const filterSensitiveLog = (obj: LoggingConfig): any => ({ ...obj, }); @@ -235,6 +265,9 @@ export interface NetworkInterface { } export namespace NetworkInterface { + /** + * @internal + */ export const filterSensitiveLog = (obj: NetworkInterface): any => ({ ...obj, }); @@ -256,6 +289,9 @@ export interface OutputLocation { } export namespace OutputLocation { + /** + * @internal + */ export const filterSensitiveLog = (obj: OutputLocation): any => ({ ...obj, }); @@ -283,6 +319,9 @@ export interface PortMapping { } export namespace PortMapping { + /** + * @internal + */ export const filterSensitiveLog = (obj: PortMapping): any => ({ ...obj, }); @@ -299,6 +338,9 @@ export interface PortForwardingConfig { } export namespace PortForwardingConfig { + /** + * @internal + */ export const filterSensitiveLog = (obj: PortForwardingConfig): any => ({ ...obj, }); @@ -338,6 +380,9 @@ export interface LaunchConfig { } export namespace LaunchConfig { + /** + * @internal + */ export const filterSensitiveLog = (obj: LaunchConfig): any => ({ ...obj, }); @@ -388,6 +433,9 @@ export interface Tool { } export namespace Tool { + /** + * @internal + */ export const filterSensitiveLog = (obj: Tool): any => ({ ...obj, }); @@ -446,6 +494,9 @@ export interface UploadConfiguration { } export namespace UploadConfiguration { + /** + * @internal + */ export const filterSensitiveLog = (obj: UploadConfiguration): any => ({ ...obj, }); @@ -498,6 +549,9 @@ export interface RobotApplicationConfig { } export namespace RobotApplicationConfig { + /** + * @internal + */ export const filterSensitiveLog = (obj: RobotApplicationConfig): any => ({ ...obj, }); @@ -514,6 +568,9 @@ export interface WorldConfig { } export namespace WorldConfig { + /** + * @internal + */ export const filterSensitiveLog = (obj: WorldConfig): any => ({ ...obj, }); @@ -571,6 +628,9 @@ export interface SimulationApplicationConfig { } export namespace SimulationApplicationConfig { + /** + * @internal + */ export const filterSensitiveLog = (obj: SimulationApplicationConfig): any => ({ ...obj, }); @@ -615,6 +675,9 @@ export interface VPCConfigResponse { } export namespace VPCConfigResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: VPCConfigResponse): any => ({ ...obj, }); @@ -747,6 +810,9 @@ export interface SimulationJob { } export namespace SimulationJob { + /** + * @internal + */ export const filterSensitiveLog = (obj: SimulationJob): any => ({ ...obj, }); @@ -765,6 +831,9 @@ export interface BatchDescribeSimulationJobResponse { } export namespace BatchDescribeSimulationJobResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: BatchDescribeSimulationJobResponse): any => ({ ...obj, }); @@ -780,6 +849,9 @@ export interface ResourceNotFoundException extends __SmithyException, $MetadataB } export namespace ResourceNotFoundException { + /** + * @internal + */ export const filterSensitiveLog = (obj: ResourceNotFoundException): any => ({ ...obj, }); @@ -812,6 +884,9 @@ export interface BatchPolicy { } export namespace BatchPolicy { + /** + * @internal + */ export const filterSensitiveLog = (obj: BatchPolicy): any => ({ ...obj, }); @@ -825,6 +900,9 @@ export interface CancelDeploymentJobRequest { } export namespace CancelDeploymentJobRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: CancelDeploymentJobRequest): any => ({ ...obj, }); @@ -833,6 +911,9 @@ export namespace CancelDeploymentJobRequest { export interface CancelDeploymentJobResponse {} export namespace CancelDeploymentJobResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: CancelDeploymentJobResponse): any => ({ ...obj, }); @@ -846,6 +927,9 @@ export interface CancelSimulationJobRequest { } export namespace CancelSimulationJobRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: CancelSimulationJobRequest): any => ({ ...obj, }); @@ -854,6 +938,9 @@ export namespace CancelSimulationJobRequest { export interface CancelSimulationJobResponse {} export namespace CancelSimulationJobResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: CancelSimulationJobResponse): any => ({ ...obj, }); @@ -867,6 +954,9 @@ export interface CancelSimulationJobBatchRequest { } export namespace CancelSimulationJobBatchRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: CancelSimulationJobBatchRequest): any => ({ ...obj, }); @@ -875,6 +965,9 @@ export namespace CancelSimulationJobBatchRequest { export interface CancelSimulationJobBatchResponse {} export namespace CancelSimulationJobBatchResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: CancelSimulationJobBatchResponse): any => ({ ...obj, }); @@ -888,6 +981,9 @@ export interface CancelWorldExportJobRequest { } export namespace CancelWorldExportJobRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: CancelWorldExportJobRequest): any => ({ ...obj, }); @@ -896,6 +992,9 @@ export namespace CancelWorldExportJobRequest { export interface CancelWorldExportJobResponse {} export namespace CancelWorldExportJobResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: CancelWorldExportJobResponse): any => ({ ...obj, }); @@ -909,6 +1008,9 @@ export interface CancelWorldGenerationJobRequest { } export namespace CancelWorldGenerationJobRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: CancelWorldGenerationJobRequest): any => ({ ...obj, }); @@ -917,6 +1019,9 @@ export namespace CancelWorldGenerationJobRequest { export interface CancelWorldGenerationJobResponse {} export namespace CancelWorldGenerationJobResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: CancelWorldGenerationJobResponse): any => ({ ...obj, }); @@ -936,6 +1041,9 @@ export interface Compute { } export namespace Compute { + /** + * @internal + */ export const filterSensitiveLog = (obj: Compute): any => ({ ...obj, }); @@ -951,6 +1059,9 @@ export interface ConcurrentDeploymentException extends __SmithyException, $Metad } export namespace ConcurrentDeploymentException { + /** + * @internal + */ export const filterSensitiveLog = (obj: ConcurrentDeploymentException): any => ({ ...obj, }); @@ -990,6 +1101,9 @@ export interface DeploymentLaunchConfig { } export namespace DeploymentLaunchConfig { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeploymentLaunchConfig): any => ({ ...obj, }); @@ -1016,6 +1130,9 @@ export interface DeploymentApplicationConfig { } export namespace DeploymentApplicationConfig { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeploymentApplicationConfig): any => ({ ...obj, }); @@ -1042,6 +1159,9 @@ export interface S3Object { } export namespace S3Object { + /** + * @internal + */ export const filterSensitiveLog = (obj: S3Object): any => ({ ...obj, }); @@ -1074,6 +1194,9 @@ export interface DeploymentConfig { } export namespace DeploymentConfig { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeploymentConfig): any => ({ ...obj, }); @@ -1109,6 +1232,9 @@ export interface CreateDeploymentJobRequest { } export namespace CreateDeploymentJobRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateDeploymentJobRequest): any => ({ ...obj, }); @@ -1258,6 +1384,9 @@ export interface CreateDeploymentJobResponse { } export namespace CreateDeploymentJobResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateDeploymentJobResponse): any => ({ ...obj, }); @@ -1274,6 +1403,9 @@ export interface IdempotentParameterMismatchException extends __SmithyException, } export namespace IdempotentParameterMismatchException { + /** + * @internal + */ export const filterSensitiveLog = (obj: IdempotentParameterMismatchException): any => ({ ...obj, }); @@ -1290,6 +1422,9 @@ export interface LimitExceededException extends __SmithyException, $MetadataBear } export namespace LimitExceededException { + /** + * @internal + */ export const filterSensitiveLog = (obj: LimitExceededException): any => ({ ...obj, }); @@ -1308,6 +1443,9 @@ export interface CreateFleetRequest { } export namespace CreateFleetRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateFleetRequest): any => ({ ...obj, }); @@ -1336,6 +1474,9 @@ export interface CreateFleetResponse { } export namespace CreateFleetResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateFleetResponse): any => ({ ...obj, }); @@ -1364,6 +1505,9 @@ export interface CreateRobotRequest { } export namespace CreateRobotRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateRobotRequest): any => ({ ...obj, }); @@ -1402,6 +1546,9 @@ export interface CreateRobotResponse { } export namespace CreateRobotResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateRobotResponse): any => ({ ...obj, }); @@ -1417,6 +1564,9 @@ export interface ResourceAlreadyExistsException extends __SmithyException, $Meta } export namespace ResourceAlreadyExistsException { + /** + * @internal + */ export const filterSensitiveLog = (obj: ResourceAlreadyExistsException): any => ({ ...obj, }); @@ -1449,6 +1599,9 @@ export interface RobotSoftwareSuite { } export namespace RobotSoftwareSuite { + /** + * @internal + */ export const filterSensitiveLog = (obj: RobotSoftwareSuite): any => ({ ...obj, }); @@ -1475,6 +1628,9 @@ export interface SourceConfig { } export namespace SourceConfig { + /** + * @internal + */ export const filterSensitiveLog = (obj: SourceConfig): any => ({ ...obj, }); @@ -1504,6 +1660,9 @@ export interface CreateRobotApplicationRequest { } export namespace CreateRobotApplicationRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateRobotApplicationRequest): any => ({ ...obj, }); @@ -1535,6 +1694,9 @@ export interface Source { } export namespace Source { + /** + * @internal + */ export const filterSensitiveLog = (obj: Source): any => ({ ...obj, }); @@ -1584,6 +1746,9 @@ export interface CreateRobotApplicationResponse { } export namespace CreateRobotApplicationResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateRobotApplicationResponse): any => ({ ...obj, }); @@ -1603,6 +1768,9 @@ export interface CreateRobotApplicationVersionRequest { } export namespace CreateRobotApplicationVersionRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateRobotApplicationVersionRequest): any => ({ ...obj, }); @@ -1647,6 +1815,9 @@ export interface CreateRobotApplicationVersionResponse { } export namespace CreateRobotApplicationVersionResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateRobotApplicationVersionResponse): any => ({ ...obj, }); @@ -1672,6 +1843,9 @@ export interface RenderingEngine { } export namespace RenderingEngine { + /** + * @internal + */ export const filterSensitiveLog = (obj: RenderingEngine): any => ({ ...obj, }); @@ -1698,6 +1872,9 @@ export interface SimulationSoftwareSuite { } export namespace SimulationSoftwareSuite { + /** + * @internal + */ export const filterSensitiveLog = (obj: SimulationSoftwareSuite): any => ({ ...obj, }); @@ -1737,6 +1914,9 @@ export interface CreateSimulationApplicationRequest { } export namespace CreateSimulationApplicationRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateSimulationApplicationRequest): any => ({ ...obj, }); @@ -1796,6 +1976,9 @@ export interface CreateSimulationApplicationResponse { } export namespace CreateSimulationApplicationResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateSimulationApplicationResponse): any => ({ ...obj, }); @@ -1815,6 +1998,9 @@ export interface CreateSimulationApplicationVersionRequest { } export namespace CreateSimulationApplicationVersionRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateSimulationApplicationVersionRequest): any => ({ ...obj, }); @@ -1869,6 +2055,9 @@ export interface CreateSimulationApplicationVersionResponse { } export namespace CreateSimulationApplicationVersionResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateSimulationApplicationVersionResponse): any => ({ ...obj, }); @@ -1895,6 +2084,9 @@ export interface DataSourceConfig { } export namespace DataSourceConfig { + /** + * @internal + */ export const filterSensitiveLog = (obj: DataSourceConfig): any => ({ ...obj, }); @@ -1923,6 +2115,9 @@ export interface VPCConfig { } export namespace VPCConfig { + /** + * @internal + */ export const filterSensitiveLog = (obj: VPCConfig): any => ({ ...obj, }); @@ -2014,6 +2209,9 @@ export interface CreateSimulationJobRequest { } export namespace CreateSimulationJobRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateSimulationJobRequest): any => ({ ...obj, }); @@ -2177,6 +2375,9 @@ export interface CreateSimulationJobResponse { } export namespace CreateSimulationJobResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateSimulationJobResponse): any => ({ ...obj, }); @@ -2192,6 +2393,9 @@ export interface ServiceUnavailableException extends __SmithyException, $Metadat } export namespace ServiceUnavailableException { + /** + * @internal + */ export const filterSensitiveLog = (obj: ServiceUnavailableException): any => ({ ...obj, }); @@ -2285,6 +2489,9 @@ export interface SimulationJobRequest { } export namespace SimulationJobRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: SimulationJobRequest): any => ({ ...obj, }); @@ -2321,6 +2528,9 @@ export interface CreateWorldExportJobRequest { } export namespace CreateWorldExportJobRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateWorldExportJobRequest): any => ({ ...obj, }); @@ -2446,6 +2656,9 @@ export interface CreateWorldExportJobResponse { } export namespace CreateWorldExportJobResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateWorldExportJobResponse): any => ({ ...obj, }); @@ -2473,6 +2686,9 @@ export interface WorldCount { } export namespace WorldCount { + /** + * @internal + */ export const filterSensitiveLog = (obj: WorldCount): any => ({ ...obj, }); @@ -2510,6 +2726,9 @@ export interface CreateWorldGenerationJobRequest { } export namespace CreateWorldGenerationJobRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateWorldGenerationJobRequest): any => ({ ...obj, }); @@ -2640,6 +2859,9 @@ export interface CreateWorldGenerationJobResponse { } export namespace CreateWorldGenerationJobResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateWorldGenerationJobResponse): any => ({ ...obj, }); @@ -2661,6 +2883,9 @@ export interface TemplateLocation { } export namespace TemplateLocation { + /** + * @internal + */ export const filterSensitiveLog = (obj: TemplateLocation): any => ({ ...obj, }); @@ -2696,6 +2921,9 @@ export interface CreateWorldTemplateRequest { } export namespace CreateWorldTemplateRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateWorldTemplateRequest): any => ({ ...obj, }); @@ -2731,6 +2959,9 @@ export interface CreateWorldTemplateResponse { } export namespace CreateWorldTemplateResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateWorldTemplateResponse): any => ({ ...obj, }); @@ -2744,6 +2975,9 @@ export interface DeleteFleetRequest { } export namespace DeleteFleetRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteFleetRequest): any => ({ ...obj, }); @@ -2752,6 +2986,9 @@ export namespace DeleteFleetRequest { export interface DeleteFleetResponse {} export namespace DeleteFleetResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteFleetResponse): any => ({ ...obj, }); @@ -2765,6 +3002,9 @@ export interface DeleteRobotRequest { } export namespace DeleteRobotRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteRobotRequest): any => ({ ...obj, }); @@ -2773,6 +3013,9 @@ export namespace DeleteRobotRequest { export interface DeleteRobotResponse {} export namespace DeleteRobotResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteRobotResponse): any => ({ ...obj, }); @@ -2791,6 +3034,9 @@ export interface DeleteRobotApplicationRequest { } export namespace DeleteRobotApplicationRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteRobotApplicationRequest): any => ({ ...obj, }); @@ -2799,6 +3045,9 @@ export namespace DeleteRobotApplicationRequest { export interface DeleteRobotApplicationResponse {} export namespace DeleteRobotApplicationResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteRobotApplicationResponse): any => ({ ...obj, }); @@ -2817,6 +3066,9 @@ export interface DeleteSimulationApplicationRequest { } export namespace DeleteSimulationApplicationRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteSimulationApplicationRequest): any => ({ ...obj, }); @@ -2825,6 +3077,9 @@ export namespace DeleteSimulationApplicationRequest { export interface DeleteSimulationApplicationResponse {} export namespace DeleteSimulationApplicationResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteSimulationApplicationResponse): any => ({ ...obj, }); @@ -2838,6 +3093,9 @@ export interface DeleteWorldTemplateRequest { } export namespace DeleteWorldTemplateRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteWorldTemplateRequest): any => ({ ...obj, }); @@ -2846,6 +3104,9 @@ export namespace DeleteWorldTemplateRequest { export interface DeleteWorldTemplateResponse {} export namespace DeleteWorldTemplateResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteWorldTemplateResponse): any => ({ ...obj, }); @@ -2897,6 +3158,9 @@ export interface DeploymentJob { } export namespace DeploymentJob { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeploymentJob): any => ({ ...obj, }); @@ -2915,6 +3179,9 @@ export interface DeregisterRobotRequest { } export namespace DeregisterRobotRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeregisterRobotRequest): any => ({ ...obj, }); @@ -2933,6 +3200,9 @@ export interface DeregisterRobotResponse { } export namespace DeregisterRobotResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeregisterRobotResponse): any => ({ ...obj, }); @@ -2946,6 +3216,9 @@ export interface DescribeDeploymentJobRequest { } export namespace DescribeDeploymentJobRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeDeploymentJobRequest): any => ({ ...obj, }); @@ -3017,6 +3290,9 @@ export interface ProgressDetail { } export namespace ProgressDetail { + /** + * @internal + */ export const filterSensitiveLog = (obj: ProgressDetail): any => ({ ...obj, }); @@ -3073,6 +3349,9 @@ export interface RobotDeployment { } export namespace RobotDeployment { + /** + * @internal + */ export const filterSensitiveLog = (obj: RobotDeployment): any => ({ ...obj, }); @@ -3131,6 +3410,9 @@ export interface DescribeDeploymentJobResponse { } export namespace DescribeDeploymentJobResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeDeploymentJobResponse): any => ({ ...obj, }); @@ -3144,6 +3426,9 @@ export interface DescribeFleetRequest { } export namespace DescribeFleetRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeFleetRequest): any => ({ ...obj, }); @@ -3200,6 +3485,9 @@ export interface Robot { } export namespace Robot { + /** + * @internal + */ export const filterSensitiveLog = (obj: Robot): any => ({ ...obj, }); @@ -3248,6 +3536,9 @@ export interface DescribeFleetResponse { } export namespace DescribeFleetResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeFleetResponse): any => ({ ...obj, }); @@ -3261,6 +3552,9 @@ export interface DescribeRobotRequest { } export namespace DescribeRobotRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeRobotRequest): any => ({ ...obj, }); @@ -3319,6 +3613,9 @@ export interface DescribeRobotResponse { } export namespace DescribeRobotResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeRobotResponse): any => ({ ...obj, }); @@ -3337,6 +3634,9 @@ export interface DescribeRobotApplicationRequest { } export namespace DescribeRobotApplicationRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeRobotApplicationRequest): any => ({ ...obj, }); @@ -3386,6 +3686,9 @@ export interface DescribeRobotApplicationResponse { } export namespace DescribeRobotApplicationResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeRobotApplicationResponse): any => ({ ...obj, }); @@ -3404,6 +3707,9 @@ export interface DescribeSimulationApplicationRequest { } export namespace DescribeSimulationApplicationRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeSimulationApplicationRequest): any => ({ ...obj, }); @@ -3463,6 +3769,9 @@ export interface DescribeSimulationApplicationResponse { } export namespace DescribeSimulationApplicationResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeSimulationApplicationResponse): any => ({ ...obj, }); @@ -3476,6 +3785,9 @@ export interface DescribeSimulationJobRequest { } export namespace DescribeSimulationJobRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeSimulationJobRequest): any => ({ ...obj, }); @@ -3656,6 +3968,9 @@ export interface DescribeSimulationJobResponse { } export namespace DescribeSimulationJobResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeSimulationJobResponse): any => ({ ...obj, }); @@ -3669,6 +3984,9 @@ export interface DescribeSimulationJobBatchRequest { } export namespace DescribeSimulationJobBatchRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeSimulationJobBatchRequest): any => ({ ...obj, }); @@ -3716,6 +4034,9 @@ export interface SimulationJobSummary { } export namespace SimulationJobSummary { + /** + * @internal + */ export const filterSensitiveLog = (obj: SimulationJobSummary): any => ({ ...obj, }); @@ -3747,6 +4068,9 @@ export interface FailedCreateSimulationJobRequest { } export namespace FailedCreateSimulationJobRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: FailedCreateSimulationJobRequest): any => ({ ...obj, }); @@ -3886,6 +4210,9 @@ export interface DescribeSimulationJobBatchResponse { } export namespace DescribeSimulationJobBatchResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeSimulationJobBatchResponse): any => ({ ...obj, }); @@ -3899,6 +4226,9 @@ export interface DescribeWorldRequest { } export namespace DescribeWorldRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeWorldRequest): any => ({ ...obj, }); @@ -3933,6 +4263,9 @@ export interface DescribeWorldResponse { } export namespace DescribeWorldResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeWorldResponse): any => ({ ...obj, }); @@ -3946,6 +4279,9 @@ export interface DescribeWorldExportJobRequest { } export namespace DescribeWorldExportJobRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeWorldExportJobRequest): any => ({ ...obj, }); @@ -4057,6 +4393,9 @@ export interface DescribeWorldExportJobResponse { } export namespace DescribeWorldExportJobResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeWorldExportJobResponse): any => ({ ...obj, }); @@ -4070,6 +4409,9 @@ export interface DescribeWorldGenerationJobRequest { } export namespace DescribeWorldGenerationJobRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeWorldGenerationJobRequest): any => ({ ...obj, }); @@ -4120,6 +4462,9 @@ export interface WorldFailure { } export namespace WorldFailure { + /** + * @internal + */ export const filterSensitiveLog = (obj: WorldFailure): any => ({ ...obj, }); @@ -4141,6 +4486,9 @@ export interface FailureSummary { } export namespace FailureSummary { + /** + * @internal + */ export const filterSensitiveLog = (obj: FailureSummary): any => ({ ...obj, }); @@ -4167,6 +4515,9 @@ export interface FinishedWorldsSummary { } export namespace FinishedWorldsSummary { + /** + * @internal + */ export const filterSensitiveLog = (obj: FinishedWorldsSummary): any => ({ ...obj, }); @@ -4288,6 +4639,9 @@ export interface DescribeWorldGenerationJobResponse { } export namespace DescribeWorldGenerationJobResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeWorldGenerationJobResponse): any => ({ ...obj, }); @@ -4301,6 +4655,9 @@ export interface DescribeWorldTemplateRequest { } export namespace DescribeWorldTemplateRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeWorldTemplateRequest): any => ({ ...obj, }); @@ -4342,6 +4699,9 @@ export interface DescribeWorldTemplateResponse { } export namespace DescribeWorldTemplateResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeWorldTemplateResponse): any => ({ ...obj, }); @@ -4363,6 +4723,9 @@ export interface Filter { } export namespace Filter { + /** + * @internal + */ export const filterSensitiveLog = (obj: Filter): any => ({ ...obj, }); @@ -4404,6 +4767,9 @@ export interface Fleet { } export namespace Fleet { + /** + * @internal + */ export const filterSensitiveLog = (obj: Fleet): any => ({ ...obj, }); @@ -4422,6 +4788,9 @@ export interface GetWorldTemplateBodyRequest { } export namespace GetWorldTemplateBodyRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetWorldTemplateBodyRequest): any => ({ ...obj, }); @@ -4435,6 +4804,9 @@ export interface GetWorldTemplateBodyResponse { } export namespace GetWorldTemplateBodyResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetWorldTemplateBodyResponse): any => ({ ...obj, }); @@ -4472,6 +4844,9 @@ export interface ListDeploymentJobsRequest { } export namespace ListDeploymentJobsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListDeploymentJobsRequest): any => ({ ...obj, }); @@ -4494,6 +4869,9 @@ export interface ListDeploymentJobsResponse { } export namespace ListDeploymentJobsResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListDeploymentJobsResponse): any => ({ ...obj, }); @@ -4533,6 +4911,9 @@ export interface ListFleetsRequest { } export namespace ListFleetsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListFleetsRequest): any => ({ ...obj, }); @@ -4555,6 +4936,9 @@ export interface ListFleetsResponse { } export namespace ListFleetsResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListFleetsResponse): any => ({ ...obj, }); @@ -4595,6 +4979,9 @@ export interface ListRobotApplicationsRequest { } export namespace ListRobotApplicationsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListRobotApplicationsRequest): any => ({ ...obj, }); @@ -4632,6 +5019,9 @@ export interface RobotApplicationSummary { } export namespace RobotApplicationSummary { + /** + * @internal + */ export const filterSensitiveLog = (obj: RobotApplicationSummary): any => ({ ...obj, }); @@ -4654,6 +5044,9 @@ export interface ListRobotApplicationsResponse { } export namespace ListRobotApplicationsResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListRobotApplicationsResponse): any => ({ ...obj, }); @@ -4691,6 +5084,9 @@ export interface ListRobotsRequest { } export namespace ListRobotsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListRobotsRequest): any => ({ ...obj, }); @@ -4713,6 +5109,9 @@ export interface ListRobotsResponse { } export namespace ListRobotsResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListRobotsResponse): any => ({ ...obj, }); @@ -4753,6 +5152,9 @@ export interface ListSimulationApplicationsRequest { } export namespace ListSimulationApplicationsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListSimulationApplicationsRequest): any => ({ ...obj, }); @@ -4795,6 +5197,9 @@ export interface SimulationApplicationSummary { } export namespace SimulationApplicationSummary { + /** + * @internal + */ export const filterSensitiveLog = (obj: SimulationApplicationSummary): any => ({ ...obj, }); @@ -4817,6 +5222,9 @@ export interface ListSimulationApplicationsResponse { } export namespace ListSimulationApplicationsResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListSimulationApplicationsResponse): any => ({ ...obj, }); @@ -4848,6 +5256,9 @@ export interface ListSimulationJobBatchesRequest { } export namespace ListSimulationJobBatchesRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListSimulationJobBatchesRequest): any => ({ ...obj, }); @@ -4945,6 +5356,9 @@ export interface SimulationJobBatchSummary { } export namespace SimulationJobBatchSummary { + /** + * @internal + */ export const filterSensitiveLog = (obj: SimulationJobBatchSummary): any => ({ ...obj, }); @@ -4967,6 +5381,9 @@ export interface ListSimulationJobBatchesResponse { } export namespace ListSimulationJobBatchesResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListSimulationJobBatchesResponse): any => ({ ...obj, }); @@ -5005,6 +5422,9 @@ export interface ListSimulationJobsRequest { } export namespace ListSimulationJobsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListSimulationJobsRequest): any => ({ ...obj, }); @@ -5027,6 +5447,9 @@ export interface ListSimulationJobsResponse { } export namespace ListSimulationJobsResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListSimulationJobsResponse): any => ({ ...obj, }); @@ -5040,6 +5463,9 @@ export interface ListTagsForResourceRequest { } export namespace ListTagsForResourceRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListTagsForResourceRequest): any => ({ ...obj, }); @@ -5053,6 +5479,9 @@ export interface ListTagsForResourceResponse { } export namespace ListTagsForResourceResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListTagsForResourceResponse): any => ({ ...obj, }); @@ -5087,6 +5516,9 @@ export interface ListWorldExportJobsRequest { } export namespace ListWorldExportJobsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListWorldExportJobsRequest): any => ({ ...obj, }); @@ -5145,6 +5577,9 @@ export interface WorldExportJobSummary { } export namespace WorldExportJobSummary { + /** + * @internal + */ export const filterSensitiveLog = (obj: WorldExportJobSummary): any => ({ ...obj, }); @@ -5167,6 +5602,9 @@ export interface ListWorldExportJobsResponse { } export namespace ListWorldExportJobsResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListWorldExportJobsResponse): any => ({ ...obj, }); @@ -5201,6 +5639,9 @@ export interface ListWorldGenerationJobsRequest { } export namespace ListWorldGenerationJobsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListWorldGenerationJobsRequest): any => ({ ...obj, }); @@ -5279,6 +5720,9 @@ export interface WorldGenerationJobSummary { } export namespace WorldGenerationJobSummary { + /** + * @internal + */ export const filterSensitiveLog = (obj: WorldGenerationJobSummary): any => ({ ...obj, }); @@ -5301,6 +5745,9 @@ export interface ListWorldGenerationJobsResponse { } export namespace ListWorldGenerationJobsResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListWorldGenerationJobsResponse): any => ({ ...obj, }); @@ -5334,6 +5781,9 @@ export interface ListWorldsRequest { } export namespace ListWorldsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListWorldsRequest): any => ({ ...obj, }); @@ -5365,6 +5815,9 @@ export interface WorldSummary { } export namespace WorldSummary { + /** + * @internal + */ export const filterSensitiveLog = (obj: WorldSummary): any => ({ ...obj, }); @@ -5387,6 +5840,9 @@ export interface ListWorldsResponse { } export namespace ListWorldsResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListWorldsResponse): any => ({ ...obj, }); @@ -5415,6 +5871,9 @@ export interface ListWorldTemplatesRequest { } export namespace ListWorldTemplatesRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListWorldTemplatesRequest): any => ({ ...obj, }); @@ -5446,6 +5905,9 @@ export interface TemplateSummary { } export namespace TemplateSummary { + /** + * @internal + */ export const filterSensitiveLog = (obj: TemplateSummary): any => ({ ...obj, }); @@ -5468,6 +5930,9 @@ export interface ListWorldTemplatesResponse { } export namespace ListWorldTemplatesResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListWorldTemplatesResponse): any => ({ ...obj, }); @@ -5486,6 +5951,9 @@ export interface RegisterRobotRequest { } export namespace RegisterRobotRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: RegisterRobotRequest): any => ({ ...obj, }); @@ -5504,6 +5972,9 @@ export interface RegisterRobotResponse { } export namespace RegisterRobotResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: RegisterRobotResponse): any => ({ ...obj, }); @@ -5517,6 +5988,9 @@ export interface RestartSimulationJobRequest { } export namespace RestartSimulationJobRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: RestartSimulationJobRequest): any => ({ ...obj, }); @@ -5525,6 +5999,9 @@ export namespace RestartSimulationJobRequest { export interface RestartSimulationJobResponse {} export namespace RestartSimulationJobResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: RestartSimulationJobResponse): any => ({ ...obj, }); @@ -5555,6 +6032,9 @@ export interface StartSimulationJobBatchRequest { } export namespace StartSimulationJobBatchRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: StartSimulationJobBatchRequest): any => ({ ...obj, }); @@ -5672,6 +6152,9 @@ export interface StartSimulationJobBatchResponse { } export namespace StartSimulationJobBatchResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: StartSimulationJobBatchResponse): any => ({ ...obj, }); @@ -5691,6 +6174,9 @@ export interface SyncDeploymentJobRequest { } export namespace SyncDeploymentJobRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: SyncDeploymentJobRequest): any => ({ ...obj, }); @@ -5800,6 +6286,9 @@ export interface SyncDeploymentJobResponse { } export namespace SyncDeploymentJobResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: SyncDeploymentJobResponse): any => ({ ...obj, }); @@ -5818,6 +6307,9 @@ export interface TagResourceRequest { } export namespace TagResourceRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: TagResourceRequest): any => ({ ...obj, }); @@ -5826,6 +6318,9 @@ export namespace TagResourceRequest { export interface TagResourceResponse {} export namespace TagResourceResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: TagResourceResponse): any => ({ ...obj, }); @@ -5846,6 +6341,9 @@ export interface UntagResourceRequest { } export namespace UntagResourceRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: UntagResourceRequest): any => ({ ...obj, }); @@ -5854,6 +6352,9 @@ export namespace UntagResourceRequest { export interface UntagResourceResponse {} export namespace UntagResourceResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: UntagResourceResponse): any => ({ ...obj, }); @@ -5882,6 +6383,9 @@ export interface UpdateRobotApplicationRequest { } export namespace UpdateRobotApplicationRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateRobotApplicationRequest): any => ({ ...obj, }); @@ -5926,6 +6430,9 @@ export interface UpdateRobotApplicationResponse { } export namespace UpdateRobotApplicationResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateRobotApplicationResponse): any => ({ ...obj, }); @@ -5964,6 +6471,9 @@ export interface UpdateSimulationApplicationRequest { } export namespace UpdateSimulationApplicationRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateSimulationApplicationRequest): any => ({ ...obj, }); @@ -6018,6 +6528,9 @@ export interface UpdateSimulationApplicationResponse { } export namespace UpdateSimulationApplicationResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateSimulationApplicationResponse): any => ({ ...obj, }); @@ -6046,6 +6559,9 @@ export interface UpdateWorldTemplateRequest { } export namespace UpdateWorldTemplateRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateWorldTemplateRequest): any => ({ ...obj, }); @@ -6075,6 +6591,9 @@ export interface UpdateWorldTemplateResponse { } export namespace UpdateWorldTemplateResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateWorldTemplateResponse): any => ({ ...obj, }); diff --git a/clients/client-route-53-domains/commands/AcceptDomainTransferFromAnotherAwsAccountCommand.ts b/clients/client-route-53-domains/commands/AcceptDomainTransferFromAnotherAwsAccountCommand.ts index 4be44cec57f9..276d5f6badac 100644 --- a/clients/client-route-53-domains/commands/AcceptDomainTransferFromAnotherAwsAccountCommand.ts +++ b/clients/client-route-53-domains/commands/AcceptDomainTransferFromAnotherAwsAccountCommand.ts @@ -38,6 +38,20 @@ export interface AcceptDomainTransferFromAnotherAwsAccountCommandOutput * GetOperationDetail * provides additional information, for example, Domain Transfer from Aws Account 111122223333 has been cancelled. *

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { Route53DomainsClient, AcceptDomainTransferFromAnotherAwsAccountCommand } from "@aws-sdk/client-route-53-domains"; // ES Modules import + * // const { Route53DomainsClient, AcceptDomainTransferFromAnotherAwsAccountCommand } = require("@aws-sdk/client-route-53-domains"); // CommonJS import + * const client = new Route53DomainsClient(config); + * const command = new AcceptDomainTransferFromAnotherAwsAccountCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link AcceptDomainTransferFromAnotherAwsAccountCommandInput} for command's `input` shape. + * @see {@link AcceptDomainTransferFromAnotherAwsAccountCommandOutput} for command's `response` shape. + * @see {@link Route53DomainsClientResolvedConfig | config} for command's `input` shape. + * */ export class AcceptDomainTransferFromAnotherAwsAccountCommand extends $Command< AcceptDomainTransferFromAnotherAwsAccountCommandInput, diff --git a/clients/client-route-53-domains/commands/CancelDomainTransferToAnotherAwsAccountCommand.ts b/clients/client-route-53-domains/commands/CancelDomainTransferToAnotherAwsAccountCommand.ts index 4f5254fb356d..ce398f26150b 100644 --- a/clients/client-route-53-domains/commands/CancelDomainTransferToAnotherAwsAccountCommand.ts +++ b/clients/client-route-53-domains/commands/CancelDomainTransferToAnotherAwsAccountCommand.ts @@ -43,6 +43,20 @@ export interface CancelDomainTransferToAnotherAwsAccountCommandOutput * GetOperationDetail * provides additional information, for example, Domain Transfer from Aws Account 111122223333 has been cancelled. *

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { Route53DomainsClient, CancelDomainTransferToAnotherAwsAccountCommand } from "@aws-sdk/client-route-53-domains"; // ES Modules import + * // const { Route53DomainsClient, CancelDomainTransferToAnotherAwsAccountCommand } = require("@aws-sdk/client-route-53-domains"); // CommonJS import + * const client = new Route53DomainsClient(config); + * const command = new CancelDomainTransferToAnotherAwsAccountCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CancelDomainTransferToAnotherAwsAccountCommandInput} for command's `input` shape. + * @see {@link CancelDomainTransferToAnotherAwsAccountCommandOutput} for command's `response` shape. + * @see {@link Route53DomainsClientResolvedConfig | config} for command's `input` shape. + * */ export class CancelDomainTransferToAnotherAwsAccountCommand extends $Command< CancelDomainTransferToAnotherAwsAccountCommandInput, diff --git a/clients/client-route-53-domains/commands/CheckDomainAvailabilityCommand.ts b/clients/client-route-53-domains/commands/CheckDomainAvailabilityCommand.ts index c94e599940a9..c6c272341b21 100644 --- a/clients/client-route-53-domains/commands/CheckDomainAvailabilityCommand.ts +++ b/clients/client-route-53-domains/commands/CheckDomainAvailabilityCommand.ts @@ -23,6 +23,20 @@ export interface CheckDomainAvailabilityCommandOutput extends CheckDomainAvailab /** *

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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { Route53DomainsClient, CheckDomainAvailabilityCommand } from "@aws-sdk/client-route-53-domains"; // ES Modules import + * // const { Route53DomainsClient, CheckDomainAvailabilityCommand } = require("@aws-sdk/client-route-53-domains"); // CommonJS import + * const client = new Route53DomainsClient(config); + * const command = new CheckDomainAvailabilityCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CheckDomainAvailabilityCommandInput} for command's `input` shape. + * @see {@link CheckDomainAvailabilityCommandOutput} for command's `response` shape. + * @see {@link Route53DomainsClientResolvedConfig | config} for command's `input` shape. + * */ export class CheckDomainAvailabilityCommand extends $Command< CheckDomainAvailabilityCommandInput, diff --git a/clients/client-route-53-domains/commands/CheckDomainTransferabilityCommand.ts b/clients/client-route-53-domains/commands/CheckDomainTransferabilityCommand.ts index 61ec0ac1f31f..89c6491cc678 100644 --- a/clients/client-route-53-domains/commands/CheckDomainTransferabilityCommand.ts +++ b/clients/client-route-53-domains/commands/CheckDomainTransferabilityCommand.ts @@ -22,6 +22,20 @@ export interface CheckDomainTransferabilityCommandOutput extends CheckDomainTran /** *

Checks whether a domain name can be transferred to Amazon Route 53.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { Route53DomainsClient, CheckDomainTransferabilityCommand } from "@aws-sdk/client-route-53-domains"; // ES Modules import + * // const { Route53DomainsClient, CheckDomainTransferabilityCommand } = require("@aws-sdk/client-route-53-domains"); // CommonJS import + * const client = new Route53DomainsClient(config); + * const command = new CheckDomainTransferabilityCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CheckDomainTransferabilityCommandInput} for command's `input` shape. + * @see {@link CheckDomainTransferabilityCommandOutput} for command's `response` shape. + * @see {@link Route53DomainsClientResolvedConfig | config} for command's `input` shape. + * */ export class CheckDomainTransferabilityCommand extends $Command< CheckDomainTransferabilityCommandInput, diff --git a/clients/client-route-53-domains/commands/DeleteTagsForDomainCommand.ts b/clients/client-route-53-domains/commands/DeleteTagsForDomainCommand.ts index f6418343c33c..175870090744 100644 --- a/clients/client-route-53-domains/commands/DeleteTagsForDomainCommand.ts +++ b/clients/client-route-53-domains/commands/DeleteTagsForDomainCommand.ts @@ -23,6 +23,20 @@ export interface DeleteTagsForDomainCommandOutput extends DeleteTagsForDomainRes /** *

This operation deletes the specified tags for a domain.

*

All tag operations are eventually consistent; subsequent operations might not immediately represent all issued operations.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { Route53DomainsClient, DeleteTagsForDomainCommand } from "@aws-sdk/client-route-53-domains"; // ES Modules import + * // const { Route53DomainsClient, DeleteTagsForDomainCommand } = require("@aws-sdk/client-route-53-domains"); // CommonJS import + * const client = new Route53DomainsClient(config); + * const command = new DeleteTagsForDomainCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteTagsForDomainCommandInput} for command's `input` shape. + * @see {@link DeleteTagsForDomainCommandOutput} for command's `response` shape. + * @see {@link Route53DomainsClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteTagsForDomainCommand extends $Command< DeleteTagsForDomainCommandInput, diff --git a/clients/client-route-53-domains/commands/DisableDomainAutoRenewCommand.ts b/clients/client-route-53-domains/commands/DisableDomainAutoRenewCommand.ts index 3c4ca9f28cff..a74a7c5c480a 100644 --- a/clients/client-route-53-domains/commands/DisableDomainAutoRenewCommand.ts +++ b/clients/client-route-53-domains/commands/DisableDomainAutoRenewCommand.ts @@ -22,6 +22,20 @@ export interface DisableDomainAutoRenewCommandOutput extends DisableDomainAutoRe /** *

This operation disables automatic renewal of domain registration for the specified domain.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { Route53DomainsClient, DisableDomainAutoRenewCommand } from "@aws-sdk/client-route-53-domains"; // ES Modules import + * // const { Route53DomainsClient, DisableDomainAutoRenewCommand } = require("@aws-sdk/client-route-53-domains"); // CommonJS import + * const client = new Route53DomainsClient(config); + * const command = new DisableDomainAutoRenewCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DisableDomainAutoRenewCommandInput} for command's `input` shape. + * @see {@link DisableDomainAutoRenewCommandOutput} for command's `response` shape. + * @see {@link Route53DomainsClientResolvedConfig | config} for command's `input` shape. + * */ export class DisableDomainAutoRenewCommand extends $Command< DisableDomainAutoRenewCommandInput, diff --git a/clients/client-route-53-domains/commands/DisableDomainTransferLockCommand.ts b/clients/client-route-53-domains/commands/DisableDomainTransferLockCommand.ts index c1235c0c52b8..0dd56c9a2f12 100644 --- a/clients/client-route-53-domains/commands/DisableDomainTransferLockCommand.ts +++ b/clients/client-route-53-domains/commands/DisableDomainTransferLockCommand.ts @@ -27,6 +27,20 @@ export interface DisableDomainTransferLockCommandOutput extends DisableDomainTra * 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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { Route53DomainsClient, DisableDomainTransferLockCommand } from "@aws-sdk/client-route-53-domains"; // ES Modules import + * // const { Route53DomainsClient, DisableDomainTransferLockCommand } = require("@aws-sdk/client-route-53-domains"); // CommonJS import + * const client = new Route53DomainsClient(config); + * const command = new DisableDomainTransferLockCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DisableDomainTransferLockCommandInput} for command's `input` shape. + * @see {@link DisableDomainTransferLockCommandOutput} for command's `response` shape. + * @see {@link Route53DomainsClientResolvedConfig | config} for command's `input` shape. + * */ export class DisableDomainTransferLockCommand extends $Command< DisableDomainTransferLockCommandInput, diff --git a/clients/client-route-53-domains/commands/EnableDomainAutoRenewCommand.ts b/clients/client-route-53-domains/commands/EnableDomainAutoRenewCommand.ts index 223d3e4ee484..eef74987a57c 100644 --- a/clients/client-route-53-domains/commands/EnableDomainAutoRenewCommand.ts +++ b/clients/client-route-53-domains/commands/EnableDomainAutoRenewCommand.ts @@ -27,6 +27,20 @@ export interface EnableDomainAutoRenewCommandOutput extends EnableDomainAutoRene * 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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { Route53DomainsClient, EnableDomainAutoRenewCommand } from "@aws-sdk/client-route-53-domains"; // ES Modules import + * // const { Route53DomainsClient, EnableDomainAutoRenewCommand } = require("@aws-sdk/client-route-53-domains"); // CommonJS import + * const client = new Route53DomainsClient(config); + * const command = new EnableDomainAutoRenewCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link EnableDomainAutoRenewCommandInput} for command's `input` shape. + * @see {@link EnableDomainAutoRenewCommandOutput} for command's `response` shape. + * @see {@link Route53DomainsClientResolvedConfig | config} for command's `input` shape. + * */ export class EnableDomainAutoRenewCommand extends $Command< EnableDomainAutoRenewCommandInput, diff --git a/clients/client-route-53-domains/commands/EnableDomainTransferLockCommand.ts b/clients/client-route-53-domains/commands/EnableDomainTransferLockCommand.ts index 63de06b99de6..875fbfde6ac6 100644 --- a/clients/client-route-53-domains/commands/EnableDomainTransferLockCommand.ts +++ b/clients/client-route-53-domains/commands/EnableDomainTransferLockCommand.ts @@ -24,6 +24,20 @@ export interface EnableDomainTransferLockCommandOutput extends EnableDomainTrans *

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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { Route53DomainsClient, EnableDomainTransferLockCommand } from "@aws-sdk/client-route-53-domains"; // ES Modules import + * // const { Route53DomainsClient, EnableDomainTransferLockCommand } = require("@aws-sdk/client-route-53-domains"); // CommonJS import + * const client = new Route53DomainsClient(config); + * const command = new EnableDomainTransferLockCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link EnableDomainTransferLockCommandInput} for command's `input` shape. + * @see {@link EnableDomainTransferLockCommandOutput} for command's `response` shape. + * @see {@link Route53DomainsClientResolvedConfig | config} for command's `input` shape. + * */ export class EnableDomainTransferLockCommand extends $Command< EnableDomainTransferLockCommandInput, diff --git a/clients/client-route-53-domains/commands/GetContactReachabilityStatusCommand.ts b/clients/client-route-53-domains/commands/GetContactReachabilityStatusCommand.ts index f452561ba9c9..a9db937891a9 100644 --- a/clients/client-route-53-domains/commands/GetContactReachabilityStatusCommand.ts +++ b/clients/client-route-53-domains/commands/GetContactReachabilityStatusCommand.ts @@ -26,6 +26,20 @@ export interface GetContactReachabilityStatusCommandOutput *

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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { Route53DomainsClient, GetContactReachabilityStatusCommand } from "@aws-sdk/client-route-53-domains"; // ES Modules import + * // const { Route53DomainsClient, GetContactReachabilityStatusCommand } = require("@aws-sdk/client-route-53-domains"); // CommonJS import + * const client = new Route53DomainsClient(config); + * const command = new GetContactReachabilityStatusCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetContactReachabilityStatusCommandInput} for command's `input` shape. + * @see {@link GetContactReachabilityStatusCommandOutput} for command's `response` shape. + * @see {@link Route53DomainsClientResolvedConfig | config} for command's `input` shape. + * */ export class GetContactReachabilityStatusCommand extends $Command< GetContactReachabilityStatusCommandInput, diff --git a/clients/client-route-53-domains/commands/GetDomainDetailCommand.ts b/clients/client-route-53-domains/commands/GetDomainDetailCommand.ts index 589221d7d33e..417c37c35fb7 100644 --- a/clients/client-route-53-domains/commands/GetDomainDetailCommand.ts +++ b/clients/client-route-53-domains/commands/GetDomainDetailCommand.ts @@ -23,6 +23,20 @@ export interface GetDomainDetailCommandOutput extends GetDomainDetailResponse, _ /** *

This operation returns detailed information about a specified domain that is associated with the current AWS account. * Contact information for the domain is also returned as part of the output.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { Route53DomainsClient, GetDomainDetailCommand } from "@aws-sdk/client-route-53-domains"; // ES Modules import + * // const { Route53DomainsClient, GetDomainDetailCommand } = require("@aws-sdk/client-route-53-domains"); // CommonJS import + * const client = new Route53DomainsClient(config); + * const command = new GetDomainDetailCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetDomainDetailCommandInput} for command's `input` shape. + * @see {@link GetDomainDetailCommandOutput} for command's `response` shape. + * @see {@link Route53DomainsClientResolvedConfig | config} for command's `input` shape. + * */ export class GetDomainDetailCommand extends $Command< GetDomainDetailCommandInput, diff --git a/clients/client-route-53-domains/commands/GetDomainSuggestionsCommand.ts b/clients/client-route-53-domains/commands/GetDomainSuggestionsCommand.ts index b09375f961e6..05d220d251a5 100644 --- a/clients/client-route-53-domains/commands/GetDomainSuggestionsCommand.ts +++ b/clients/client-route-53-domains/commands/GetDomainSuggestionsCommand.ts @@ -22,6 +22,20 @@ export interface GetDomainSuggestionsCommandOutput extends GetDomainSuggestionsR /** *

The GetDomainSuggestions operation returns a list of suggested domain names.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { Route53DomainsClient, GetDomainSuggestionsCommand } from "@aws-sdk/client-route-53-domains"; // ES Modules import + * // const { Route53DomainsClient, GetDomainSuggestionsCommand } = require("@aws-sdk/client-route-53-domains"); // CommonJS import + * const client = new Route53DomainsClient(config); + * const command = new GetDomainSuggestionsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetDomainSuggestionsCommandInput} for command's `input` shape. + * @see {@link GetDomainSuggestionsCommandOutput} for command's `response` shape. + * @see {@link Route53DomainsClientResolvedConfig | config} for command's `input` shape. + * */ export class GetDomainSuggestionsCommand extends $Command< GetDomainSuggestionsCommandInput, diff --git a/clients/client-route-53-domains/commands/GetOperationDetailCommand.ts b/clients/client-route-53-domains/commands/GetOperationDetailCommand.ts index 7de0c1b005bd..94e6058c09e8 100644 --- a/clients/client-route-53-domains/commands/GetOperationDetailCommand.ts +++ b/clients/client-route-53-domains/commands/GetOperationDetailCommand.ts @@ -22,6 +22,20 @@ export interface GetOperationDetailCommandOutput extends GetOperationDetailRespo /** *

This operation returns the current status of an operation that is not completed.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { Route53DomainsClient, GetOperationDetailCommand } from "@aws-sdk/client-route-53-domains"; // ES Modules import + * // const { Route53DomainsClient, GetOperationDetailCommand } = require("@aws-sdk/client-route-53-domains"); // CommonJS import + * const client = new Route53DomainsClient(config); + * const command = new GetOperationDetailCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetOperationDetailCommandInput} for command's `input` shape. + * @see {@link GetOperationDetailCommandOutput} for command's `response` shape. + * @see {@link Route53DomainsClientResolvedConfig | config} for command's `input` shape. + * */ export class GetOperationDetailCommand extends $Command< GetOperationDetailCommandInput, diff --git a/clients/client-route-53-domains/commands/ListDomainsCommand.ts b/clients/client-route-53-domains/commands/ListDomainsCommand.ts index 63520c347aad..7be824233787 100644 --- a/clients/client-route-53-domains/commands/ListDomainsCommand.ts +++ b/clients/client-route-53-domains/commands/ListDomainsCommand.ts @@ -22,6 +22,20 @@ export interface ListDomainsCommandOutput extends ListDomainsResponse, __Metadat /** *

This operation returns all the domain names registered with Amazon Route 53 for the current AWS account.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { Route53DomainsClient, ListDomainsCommand } from "@aws-sdk/client-route-53-domains"; // ES Modules import + * // const { Route53DomainsClient, ListDomainsCommand } = require("@aws-sdk/client-route-53-domains"); // CommonJS import + * const client = new Route53DomainsClient(config); + * const command = new ListDomainsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListDomainsCommandInput} for command's `input` shape. + * @see {@link ListDomainsCommandOutput} for command's `response` shape. + * @see {@link Route53DomainsClientResolvedConfig | config} for command's `input` shape. + * */ export class ListDomainsCommand extends $Command< ListDomainsCommandInput, diff --git a/clients/client-route-53-domains/commands/ListOperationsCommand.ts b/clients/client-route-53-domains/commands/ListOperationsCommand.ts index 675b6aad10ba..bb6ffb8f8de8 100644 --- a/clients/client-route-53-domains/commands/ListOperationsCommand.ts +++ b/clients/client-route-53-domains/commands/ListOperationsCommand.ts @@ -23,6 +23,20 @@ export interface ListOperationsCommandOutput extends ListOperationsResponse, __M /** *

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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { Route53DomainsClient, ListOperationsCommand } from "@aws-sdk/client-route-53-domains"; // ES Modules import + * // const { Route53DomainsClient, ListOperationsCommand } = require("@aws-sdk/client-route-53-domains"); // CommonJS import + * const client = new Route53DomainsClient(config); + * const command = new ListOperationsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListOperationsCommandInput} for command's `input` shape. + * @see {@link ListOperationsCommandOutput} for command's `response` shape. + * @see {@link Route53DomainsClientResolvedConfig | config} for command's `input` shape. + * */ export class ListOperationsCommand extends $Command< ListOperationsCommandInput, diff --git a/clients/client-route-53-domains/commands/ListTagsForDomainCommand.ts b/clients/client-route-53-domains/commands/ListTagsForDomainCommand.ts index 8e769cba2d85..41cc2fc73bd1 100644 --- a/clients/client-route-53-domains/commands/ListTagsForDomainCommand.ts +++ b/clients/client-route-53-domains/commands/ListTagsForDomainCommand.ts @@ -23,6 +23,20 @@ export interface ListTagsForDomainCommandOutput extends ListTagsForDomainRespons /** *

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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { Route53DomainsClient, ListTagsForDomainCommand } from "@aws-sdk/client-route-53-domains"; // ES Modules import + * // const { Route53DomainsClient, ListTagsForDomainCommand } = require("@aws-sdk/client-route-53-domains"); // CommonJS import + * const client = new Route53DomainsClient(config); + * const command = new ListTagsForDomainCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListTagsForDomainCommandInput} for command's `input` shape. + * @see {@link ListTagsForDomainCommandOutput} for command's `response` shape. + * @see {@link Route53DomainsClientResolvedConfig | config} for command's `input` shape. + * */ export class ListTagsForDomainCommand extends $Command< ListTagsForDomainCommandInput, diff --git a/clients/client-route-53-domains/commands/RegisterDomainCommand.ts b/clients/client-route-53-domains/commands/RegisterDomainCommand.ts index fa9bdc07b1d9..f361ceeb022d 100644 --- a/clients/client-route-53-domains/commands/RegisterDomainCommand.ts +++ b/clients/client-route-53-domains/commands/RegisterDomainCommand.ts @@ -47,6 +47,20 @@ export interface RegisterDomainCommandOutput extends RegisterDomainResponse, __M * Amazon Route 53 Pricing.

* * + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { Route53DomainsClient, RegisterDomainCommand } from "@aws-sdk/client-route-53-domains"; // ES Modules import + * // const { Route53DomainsClient, RegisterDomainCommand } = require("@aws-sdk/client-route-53-domains"); // CommonJS import + * const client = new Route53DomainsClient(config); + * const command = new RegisterDomainCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link RegisterDomainCommandInput} for command's `input` shape. + * @see {@link RegisterDomainCommandOutput} for command's `response` shape. + * @see {@link Route53DomainsClientResolvedConfig | config} for command's `input` shape. + * */ export class RegisterDomainCommand extends $Command< RegisterDomainCommandInput, diff --git a/clients/client-route-53-domains/commands/RejectDomainTransferFromAnotherAwsAccountCommand.ts b/clients/client-route-53-domains/commands/RejectDomainTransferFromAnotherAwsAccountCommand.ts index e98d8bbdb8b9..64c66a595274 100644 --- a/clients/client-route-53-domains/commands/RejectDomainTransferFromAnotherAwsAccountCommand.ts +++ b/clients/client-route-53-domains/commands/RejectDomainTransferFromAnotherAwsAccountCommand.ts @@ -38,6 +38,20 @@ export interface RejectDomainTransferFromAnotherAwsAccountCommandOutput * GetOperationDetail * provides additional information, for example, Domain Transfer from Aws Account 111122223333 has been cancelled. *

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { Route53DomainsClient, RejectDomainTransferFromAnotherAwsAccountCommand } from "@aws-sdk/client-route-53-domains"; // ES Modules import + * // const { Route53DomainsClient, RejectDomainTransferFromAnotherAwsAccountCommand } = require("@aws-sdk/client-route-53-domains"); // CommonJS import + * const client = new Route53DomainsClient(config); + * const command = new RejectDomainTransferFromAnotherAwsAccountCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link RejectDomainTransferFromAnotherAwsAccountCommandInput} for command's `input` shape. + * @see {@link RejectDomainTransferFromAnotherAwsAccountCommandOutput} for command's `response` shape. + * @see {@link Route53DomainsClientResolvedConfig | config} for command's `input` shape. + * */ export class RejectDomainTransferFromAnotherAwsAccountCommand extends $Command< RejectDomainTransferFromAnotherAwsAccountCommandInput, diff --git a/clients/client-route-53-domains/commands/RenewDomainCommand.ts b/clients/client-route-53-domains/commands/RenewDomainCommand.ts index e4a353d2b994..f4078c60cb37 100644 --- a/clients/client-route-53-domains/commands/RenewDomainCommand.ts +++ b/clients/client-route-53-domains/commands/RenewDomainCommand.ts @@ -26,6 +26,20 @@ export interface RenewDomainCommandOutput extends RenewDomainResponse, __Metadat * 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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { Route53DomainsClient, RenewDomainCommand } from "@aws-sdk/client-route-53-domains"; // ES Modules import + * // const { Route53DomainsClient, RenewDomainCommand } = require("@aws-sdk/client-route-53-domains"); // CommonJS import + * const client = new Route53DomainsClient(config); + * const command = new RenewDomainCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link RenewDomainCommandInput} for command's `input` shape. + * @see {@link RenewDomainCommandOutput} for command's `response` shape. + * @see {@link Route53DomainsClientResolvedConfig | config} for command's `input` shape. + * */ export class RenewDomainCommand extends $Command< RenewDomainCommandInput, diff --git a/clients/client-route-53-domains/commands/ResendContactReachabilityEmailCommand.ts b/clients/client-route-53-domains/commands/ResendContactReachabilityEmailCommand.ts index a75f8ea290dc..6f7e39159f0a 100644 --- a/clients/client-route-53-domains/commands/ResendContactReachabilityEmailCommand.ts +++ b/clients/client-route-53-domains/commands/ResendContactReachabilityEmailCommand.ts @@ -25,6 +25,20 @@ export interface ResendContactReachabilityEmailCommandOutput /** *

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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { Route53DomainsClient, ResendContactReachabilityEmailCommand } from "@aws-sdk/client-route-53-domains"; // ES Modules import + * // const { Route53DomainsClient, ResendContactReachabilityEmailCommand } = require("@aws-sdk/client-route-53-domains"); // CommonJS import + * const client = new Route53DomainsClient(config); + * const command = new ResendContactReachabilityEmailCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ResendContactReachabilityEmailCommandInput} for command's `input` shape. + * @see {@link ResendContactReachabilityEmailCommandOutput} for command's `response` shape. + * @see {@link Route53DomainsClientResolvedConfig | config} for command's `input` shape. + * */ export class ResendContactReachabilityEmailCommand extends $Command< ResendContactReachabilityEmailCommandInput, diff --git a/clients/client-route-53-domains/commands/RetrieveDomainAuthCodeCommand.ts b/clients/client-route-53-domains/commands/RetrieveDomainAuthCodeCommand.ts index 76b94101d63d..5dfef12ea135 100644 --- a/clients/client-route-53-domains/commands/RetrieveDomainAuthCodeCommand.ts +++ b/clients/client-route-53-domains/commands/RetrieveDomainAuthCodeCommand.ts @@ -22,6 +22,20 @@ export interface RetrieveDomainAuthCodeCommandOutput extends RetrieveDomainAuthC /** *

This operation returns the AuthCode for the domain. To transfer a domain to another registrar, you provide this value to the new registrar.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { Route53DomainsClient, RetrieveDomainAuthCodeCommand } from "@aws-sdk/client-route-53-domains"; // ES Modules import + * // const { Route53DomainsClient, RetrieveDomainAuthCodeCommand } = require("@aws-sdk/client-route-53-domains"); // CommonJS import + * const client = new Route53DomainsClient(config); + * const command = new RetrieveDomainAuthCodeCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link RetrieveDomainAuthCodeCommandInput} for command's `input` shape. + * @see {@link RetrieveDomainAuthCodeCommandOutput} for command's `response` shape. + * @see {@link Route53DomainsClientResolvedConfig | config} for command's `input` shape. + * */ export class RetrieveDomainAuthCodeCommand extends $Command< RetrieveDomainAuthCodeCommandInput, diff --git a/clients/client-route-53-domains/commands/TransferDomainCommand.ts b/clients/client-route-53-domains/commands/TransferDomainCommand.ts index 344adce129fa..34318826ec68 100644 --- a/clients/client-route-53-domains/commands/TransferDomainCommand.ts +++ b/clients/client-route-53-domains/commands/TransferDomainCommand.ts @@ -55,6 +55,20 @@ export interface TransferDomainCommandOutput extends TransferDomainResponse, __M * *

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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { Route53DomainsClient, TransferDomainCommand } from "@aws-sdk/client-route-53-domains"; // ES Modules import + * // const { Route53DomainsClient, TransferDomainCommand } = require("@aws-sdk/client-route-53-domains"); // CommonJS import + * const client = new Route53DomainsClient(config); + * const command = new TransferDomainCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link TransferDomainCommandInput} for command's `input` shape. + * @see {@link TransferDomainCommandOutput} for command's `response` shape. + * @see {@link Route53DomainsClientResolvedConfig | config} for command's `input` shape. + * */ export class TransferDomainCommand extends $Command< TransferDomainCommandInput, diff --git a/clients/client-route-53-domains/commands/TransferDomainToAnotherAwsAccountCommand.ts b/clients/client-route-53-domains/commands/TransferDomainToAnotherAwsAccountCommand.ts index 61f7c8e556c9..f1e7d7d1da4c 100644 --- a/clients/client-route-53-domains/commands/TransferDomainToAnotherAwsAccountCommand.ts +++ b/clients/client-route-53-domains/commands/TransferDomainToAnotherAwsAccountCommand.ts @@ -61,6 +61,20 @@ export interface TransferDomainToAnotherAwsAccountCommandOutput * GetOperationDetail * provides additional information, for example, Domain Transfer from Aws Account 111122223333 has been cancelled. *

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { Route53DomainsClient, TransferDomainToAnotherAwsAccountCommand } from "@aws-sdk/client-route-53-domains"; // ES Modules import + * // const { Route53DomainsClient, TransferDomainToAnotherAwsAccountCommand } = require("@aws-sdk/client-route-53-domains"); // CommonJS import + * const client = new Route53DomainsClient(config); + * const command = new TransferDomainToAnotherAwsAccountCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link TransferDomainToAnotherAwsAccountCommandInput} for command's `input` shape. + * @see {@link TransferDomainToAnotherAwsAccountCommandOutput} for command's `response` shape. + * @see {@link Route53DomainsClientResolvedConfig | config} for command's `input` shape. + * */ export class TransferDomainToAnotherAwsAccountCommand extends $Command< TransferDomainToAnotherAwsAccountCommandInput, diff --git a/clients/client-route-53-domains/commands/UpdateDomainContactCommand.ts b/clients/client-route-53-domains/commands/UpdateDomainContactCommand.ts index 2967fba8895c..867d3d577dab 100644 --- a/clients/client-route-53-domains/commands/UpdateDomainContactCommand.ts +++ b/clients/client-route-53-domains/commands/UpdateDomainContactCommand.ts @@ -25,6 +25,20 @@ export interface UpdateDomainContactCommandOutput extends UpdateDomainContactRes * 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 action. * If the request is not completed successfully, the domain registrant will be notified by email.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { Route53DomainsClient, UpdateDomainContactCommand } from "@aws-sdk/client-route-53-domains"; // ES Modules import + * // const { Route53DomainsClient, UpdateDomainContactCommand } = require("@aws-sdk/client-route-53-domains"); // CommonJS import + * const client = new Route53DomainsClient(config); + * const command = new UpdateDomainContactCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link UpdateDomainContactCommandInput} for command's `input` shape. + * @see {@link UpdateDomainContactCommandOutput} for command's `response` shape. + * @see {@link Route53DomainsClientResolvedConfig | config} for command's `input` shape. + * */ export class UpdateDomainContactCommand extends $Command< UpdateDomainContactCommandInput, diff --git a/clients/client-route-53-domains/commands/UpdateDomainContactPrivacyCommand.ts b/clients/client-route-53-domains/commands/UpdateDomainContactPrivacyCommand.ts index 3c88e85f6791..63dd3b27e84c 100644 --- a/clients/client-route-53-domains/commands/UpdateDomainContactPrivacyCommand.ts +++ b/clients/client-route-53-domains/commands/UpdateDomainContactPrivacyCommand.ts @@ -36,6 +36,20 @@ export interface UpdateDomainContactPrivacyCommandOutput extends UpdateDomainCon * For more information on our privacy practices, see * https://aws.amazon.com/privacy/.

* + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { Route53DomainsClient, UpdateDomainContactPrivacyCommand } from "@aws-sdk/client-route-53-domains"; // ES Modules import + * // const { Route53DomainsClient, UpdateDomainContactPrivacyCommand } = require("@aws-sdk/client-route-53-domains"); // CommonJS import + * const client = new Route53DomainsClient(config); + * const command = new UpdateDomainContactPrivacyCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link UpdateDomainContactPrivacyCommandInput} for command's `input` shape. + * @see {@link UpdateDomainContactPrivacyCommandOutput} for command's `response` shape. + * @see {@link Route53DomainsClientResolvedConfig | config} for command's `input` shape. + * */ export class UpdateDomainContactPrivacyCommand extends $Command< UpdateDomainContactPrivacyCommandInput, diff --git a/clients/client-route-53-domains/commands/UpdateDomainNameserversCommand.ts b/clients/client-route-53-domains/commands/UpdateDomainNameserversCommand.ts index 38674195fde2..3c4892044384 100644 --- a/clients/client-route-53-domains/commands/UpdateDomainNameserversCommand.ts +++ b/clients/client-route-53-domains/commands/UpdateDomainNameserversCommand.ts @@ -25,6 +25,20 @@ export interface UpdateDomainNameserversCommandOutput extends UpdateDomainNamese * 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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { Route53DomainsClient, UpdateDomainNameserversCommand } from "@aws-sdk/client-route-53-domains"; // ES Modules import + * // const { Route53DomainsClient, UpdateDomainNameserversCommand } = require("@aws-sdk/client-route-53-domains"); // CommonJS import + * const client = new Route53DomainsClient(config); + * const command = new UpdateDomainNameserversCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link UpdateDomainNameserversCommandInput} for command's `input` shape. + * @see {@link UpdateDomainNameserversCommandOutput} for command's `response` shape. + * @see {@link Route53DomainsClientResolvedConfig | config} for command's `input` shape. + * */ export class UpdateDomainNameserversCommand extends $Command< UpdateDomainNameserversCommandInput, diff --git a/clients/client-route-53-domains/commands/UpdateTagsForDomainCommand.ts b/clients/client-route-53-domains/commands/UpdateTagsForDomainCommand.ts index b2605b1b7b38..f02babba6b6f 100644 --- a/clients/client-route-53-domains/commands/UpdateTagsForDomainCommand.ts +++ b/clients/client-route-53-domains/commands/UpdateTagsForDomainCommand.ts @@ -23,6 +23,20 @@ export interface UpdateTagsForDomainCommandOutput extends UpdateTagsForDomainRes /** *

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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { Route53DomainsClient, UpdateTagsForDomainCommand } from "@aws-sdk/client-route-53-domains"; // ES Modules import + * // const { Route53DomainsClient, UpdateTagsForDomainCommand } = require("@aws-sdk/client-route-53-domains"); // CommonJS import + * const client = new Route53DomainsClient(config); + * const command = new UpdateTagsForDomainCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link UpdateTagsForDomainCommandInput} for command's `input` shape. + * @see {@link UpdateTagsForDomainCommandOutput} for command's `response` shape. + * @see {@link Route53DomainsClientResolvedConfig | config} for command's `input` shape. + * */ export class UpdateTagsForDomainCommand extends $Command< UpdateTagsForDomainCommandInput, diff --git a/clients/client-route-53-domains/commands/ViewBillingCommand.ts b/clients/client-route-53-domains/commands/ViewBillingCommand.ts index 7219b07332fa..e618dba0dc82 100644 --- a/clients/client-route-53-domains/commands/ViewBillingCommand.ts +++ b/clients/client-route-53-domains/commands/ViewBillingCommand.ts @@ -22,6 +22,20 @@ export interface ViewBillingCommandOutput extends ViewBillingResponse, __Metadat /** *

Returns all the domain-related billing records for the current AWS account for a specified period

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { Route53DomainsClient, ViewBillingCommand } from "@aws-sdk/client-route-53-domains"; // ES Modules import + * // const { Route53DomainsClient, ViewBillingCommand } = require("@aws-sdk/client-route-53-domains"); // CommonJS import + * const client = new Route53DomainsClient(config); + * const command = new ViewBillingCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ViewBillingCommandInput} for command's `input` shape. + * @see {@link ViewBillingCommandOutput} for command's `response` shape. + * @see {@link Route53DomainsClientResolvedConfig | config} for command's `input` shape. + * */ export class ViewBillingCommand extends $Command< ViewBillingCommandInput, diff --git a/clients/client-route-53-domains/models/models_0.ts b/clients/client-route-53-domains/models/models_0.ts index c8294ab8aecf..84fdfa2096d3 100644 --- a/clients/client-route-53-domains/models/models_0.ts +++ b/clients/client-route-53-domains/models/models_0.ts @@ -23,6 +23,9 @@ export interface AcceptDomainTransferFromAnotherAwsAccountRequest { } export namespace AcceptDomainTransferFromAnotherAwsAccountRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: AcceptDomainTransferFromAnotherAwsAccountRequest): any => ({ ...obj, }); @@ -40,6 +43,9 @@ export interface AcceptDomainTransferFromAnotherAwsAccountResponse { } export namespace AcceptDomainTransferFromAnotherAwsAccountResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: AcceptDomainTransferFromAnotherAwsAccountResponse): any => ({ ...obj, }); @@ -58,6 +64,9 @@ export interface DomainLimitExceeded extends __SmithyException, $MetadataBearer } export namespace DomainLimitExceeded { + /** + * @internal + */ export const filterSensitiveLog = (obj: DomainLimitExceeded): any => ({ ...obj, }); @@ -79,6 +88,9 @@ export interface InvalidInput extends __SmithyException, $MetadataBearer { } export namespace InvalidInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: InvalidInput): any => ({ ...obj, }); @@ -97,6 +109,9 @@ export interface OperationLimitExceeded extends __SmithyException, $MetadataBear } export namespace OperationLimitExceeded { + /** + * @internal + */ export const filterSensitiveLog = (obj: OperationLimitExceeded): any => ({ ...obj, }); @@ -159,6 +174,9 @@ export interface BillingRecord { } export namespace BillingRecord { + /** + * @internal + */ export const filterSensitiveLog = (obj: BillingRecord): any => ({ ...obj, }); @@ -175,6 +193,9 @@ export interface CancelDomainTransferToAnotherAwsAccountRequest { } export namespace CancelDomainTransferToAnotherAwsAccountRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: CancelDomainTransferToAnotherAwsAccountRequest): any => ({ ...obj, }); @@ -193,6 +214,9 @@ export interface CancelDomainTransferToAnotherAwsAccountResponse { } export namespace CancelDomainTransferToAnotherAwsAccountResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: CancelDomainTransferToAnotherAwsAccountResponse): any => ({ ...obj, }); @@ -238,6 +262,9 @@ export interface CheckDomainAvailabilityRequest { } export namespace CheckDomainAvailabilityRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: CheckDomainAvailabilityRequest): any => ({ ...obj, }); @@ -309,6 +336,9 @@ export interface CheckDomainAvailabilityResponse { } export namespace CheckDomainAvailabilityResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: CheckDomainAvailabilityResponse): any => ({ ...obj, }); @@ -327,6 +357,9 @@ export interface UnsupportedTLD extends __SmithyException, $MetadataBearer { } export namespace UnsupportedTLD { + /** + * @internal + */ export const filterSensitiveLog = (obj: UnsupportedTLD): any => ({ ...obj, }); @@ -367,6 +400,9 @@ export interface CheckDomainTransferabilityRequest { } export namespace CheckDomainTransferabilityRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: CheckDomainTransferabilityRequest): any => ({ ...obj, ...(obj.AuthCode && { AuthCode: SENSITIVE_STRING }), @@ -409,6 +445,9 @@ export interface DomainTransferability { } export namespace DomainTransferability { + /** + * @internal + */ export const filterSensitiveLog = (obj: DomainTransferability): any => ({ ...obj, }); @@ -425,6 +464,9 @@ export interface CheckDomainTransferabilityResponse { } export namespace CheckDomainTransferabilityResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: CheckDomainTransferabilityResponse): any => ({ ...obj, }); @@ -1476,6 +1518,9 @@ export interface ExtraParam { } export namespace ExtraParam { + /** + * @internal + */ export const filterSensitiveLog = (obj: ExtraParam): any => ({ ...obj, }); @@ -1578,6 +1623,9 @@ export interface ContactDetail { } export namespace ContactDetail { + /** + * @internal + */ export const filterSensitiveLog = (obj: ContactDetail): any => ({ ...obj, }); @@ -1599,6 +1647,9 @@ export interface DeleteTagsForDomainRequest { } export namespace DeleteTagsForDomainRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteTagsForDomainRequest): any => ({ ...obj, }); @@ -1607,6 +1658,9 @@ export namespace DeleteTagsForDomainRequest { export interface DeleteTagsForDomainResponse {} export namespace DeleteTagsForDomainResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteTagsForDomainResponse): any => ({ ...obj, }); @@ -1620,6 +1674,9 @@ export interface DisableDomainAutoRenewRequest { } export namespace DisableDomainAutoRenewRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DisableDomainAutoRenewRequest): any => ({ ...obj, }); @@ -1628,6 +1685,9 @@ export namespace DisableDomainAutoRenewRequest { export interface DisableDomainAutoRenewResponse {} export namespace DisableDomainAutoRenewResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DisableDomainAutoRenewResponse): any => ({ ...obj, }); @@ -1644,6 +1704,9 @@ export interface DisableDomainTransferLockRequest { } export namespace DisableDomainTransferLockRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DisableDomainTransferLockRequest): any => ({ ...obj, }); @@ -1661,6 +1724,9 @@ export interface DisableDomainTransferLockResponse { } export namespace DisableDomainTransferLockResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DisableDomainTransferLockResponse): any => ({ ...obj, }); @@ -1679,6 +1745,9 @@ export interface DuplicateRequest extends __SmithyException, $MetadataBearer { } export namespace DuplicateRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DuplicateRequest): any => ({ ...obj, }); @@ -1697,6 +1766,9 @@ export interface TLDRulesViolation extends __SmithyException, $MetadataBearer { } export namespace TLDRulesViolation { + /** + * @internal + */ export const filterSensitiveLog = (obj: TLDRulesViolation): any => ({ ...obj, }); @@ -1763,6 +1835,9 @@ export interface DomainSuggestion { } export namespace DomainSuggestion { + /** + * @internal + */ export const filterSensitiveLog = (obj: DomainSuggestion): any => ({ ...obj, }); @@ -1794,6 +1869,9 @@ export interface DomainSummary { } export namespace DomainSummary { + /** + * @internal + */ export const filterSensitiveLog = (obj: DomainSummary): any => ({ ...obj, }); @@ -1807,6 +1885,9 @@ export interface EnableDomainAutoRenewRequest { } export namespace EnableDomainAutoRenewRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: EnableDomainAutoRenewRequest): any => ({ ...obj, }); @@ -1815,6 +1896,9 @@ export namespace EnableDomainAutoRenewRequest { export interface EnableDomainAutoRenewResponse {} export namespace EnableDomainAutoRenewResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: EnableDomainAutoRenewResponse): any => ({ ...obj, }); @@ -1831,6 +1915,9 @@ export interface EnableDomainTransferLockRequest { } export namespace EnableDomainTransferLockRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: EnableDomainTransferLockRequest): any => ({ ...obj, }); @@ -1847,6 +1934,9 @@ export interface EnableDomainTransferLockResponse { } export namespace EnableDomainTransferLockResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: EnableDomainTransferLockResponse): any => ({ ...obj, }); @@ -1860,6 +1950,9 @@ export interface GetContactReachabilityStatusRequest { } export namespace GetContactReachabilityStatusRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetContactReachabilityStatusRequest): any => ({ ...obj, }); @@ -1898,6 +1991,9 @@ export interface GetContactReachabilityStatusResponse { } export namespace GetContactReachabilityStatusResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetContactReachabilityStatusResponse): any => ({ ...obj, }); @@ -1914,6 +2010,9 @@ export interface GetDomainDetailRequest { } export namespace GetDomainDetailRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetDomainDetailRequest): any => ({ ...obj, }); @@ -1939,6 +2038,9 @@ export interface Nameserver { } export namespace Nameserver { + /** + * @internal + */ export const filterSensitiveLog = (obj: Nameserver): any => ({ ...obj, }); @@ -2078,6 +2180,9 @@ export interface GetDomainDetailResponse { } export namespace GetDomainDetailResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetDomainDetailResponse): any => ({ ...obj, ...(obj.AdminContact && { AdminContact: SENSITIVE_STRING }), @@ -2129,6 +2234,9 @@ export interface GetDomainSuggestionsRequest { } export namespace GetDomainSuggestionsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetDomainSuggestionsRequest): any => ({ ...obj, }); @@ -2143,6 +2251,9 @@ export interface GetDomainSuggestionsResponse { } export namespace GetDomainSuggestionsResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetDomainSuggestionsResponse): any => ({ ...obj, }); @@ -2162,6 +2273,9 @@ export interface GetOperationDetailRequest { } export namespace GetOperationDetailRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetOperationDetailRequest): any => ({ ...obj, }); @@ -2205,6 +2319,9 @@ export interface GetOperationDetailResponse { } export namespace GetOperationDetailResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetOperationDetailResponse): any => ({ ...obj, }); @@ -2232,6 +2349,9 @@ export interface ListDomainsRequest { } export namespace ListDomainsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListDomainsRequest): any => ({ ...obj, }); @@ -2254,6 +2374,9 @@ export interface ListDomainsResponse { } export namespace ListDomainsResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListDomainsResponse): any => ({ ...obj, }); @@ -2285,6 +2408,9 @@ export interface ListOperationsRequest { } export namespace ListOperationsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListOperationsRequest): any => ({ ...obj, }); @@ -2316,6 +2442,9 @@ export interface OperationSummary { } export namespace OperationSummary { + /** + * @internal + */ export const filterSensitiveLog = (obj: OperationSummary): any => ({ ...obj, }); @@ -2338,6 +2467,9 @@ export interface ListOperationsResponse { } export namespace ListOperationsResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListOperationsResponse): any => ({ ...obj, }); @@ -2354,6 +2486,9 @@ export interface ListTagsForDomainRequest { } export namespace ListTagsForDomainRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListTagsForDomainRequest): any => ({ ...obj, }); @@ -2379,6 +2514,9 @@ export interface Tag { } export namespace Tag { + /** + * @internal + */ export const filterSensitiveLog = (obj: Tag): any => ({ ...obj, }); @@ -2395,6 +2533,9 @@ export interface ListTagsForDomainResponse { } export namespace ListTagsForDomainResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListTagsForDomainResponse): any => ({ ...obj, }); @@ -2505,6 +2646,9 @@ export interface RegisterDomainRequest { } export namespace RegisterDomainRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: RegisterDomainRequest): any => ({ ...obj, ...(obj.AdminContact && { AdminContact: SENSITIVE_STRING }), @@ -2525,6 +2669,9 @@ export interface RegisterDomainResponse { } export namespace RegisterDomainResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: RegisterDomainResponse): any => ({ ...obj, }); @@ -2544,6 +2691,9 @@ export interface RejectDomainTransferFromAnotherAwsAccountRequest { } export namespace RejectDomainTransferFromAnotherAwsAccountRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: RejectDomainTransferFromAnotherAwsAccountRequest): any => ({ ...obj, }); @@ -2562,6 +2712,9 @@ export interface RejectDomainTransferFromAnotherAwsAccountResponse { } export namespace RejectDomainTransferFromAnotherAwsAccountResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: RejectDomainTransferFromAnotherAwsAccountResponse): any => ({ ...obj, }); @@ -2592,6 +2745,9 @@ export interface RenewDomainRequest { } export namespace RenewDomainRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: RenewDomainRequest): any => ({ ...obj, }); @@ -2606,6 +2762,9 @@ export interface RenewDomainResponse { } export namespace RenewDomainResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: RenewDomainResponse): any => ({ ...obj, }); @@ -2619,6 +2778,9 @@ export interface ResendContactReachabilityEmailRequest { } export namespace ResendContactReachabilityEmailRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ResendContactReachabilityEmailRequest): any => ({ ...obj, }); @@ -2644,6 +2806,9 @@ export interface ResendContactReachabilityEmailResponse { } export namespace ResendContactReachabilityEmailResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ResendContactReachabilityEmailResponse): any => ({ ...obj, }); @@ -2661,6 +2826,9 @@ export interface RetrieveDomainAuthCodeRequest { } export namespace RetrieveDomainAuthCodeRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: RetrieveDomainAuthCodeRequest): any => ({ ...obj, }); @@ -2677,6 +2845,9 @@ export interface RetrieveDomainAuthCodeResponse { } export namespace RetrieveDomainAuthCodeResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: RetrieveDomainAuthCodeResponse): any => ({ ...obj, ...(obj.AuthCode && { AuthCode: SENSITIVE_STRING }), @@ -2786,6 +2957,9 @@ export interface TransferDomainRequest { } export namespace TransferDomainRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: TransferDomainRequest): any => ({ ...obj, ...(obj.AuthCode && { AuthCode: SENSITIVE_STRING }), @@ -2807,6 +2981,9 @@ export interface TransferDomainResponse { } export namespace TransferDomainResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: TransferDomainResponse): any => ({ ...obj, }); @@ -2828,6 +3005,9 @@ export interface TransferDomainToAnotherAwsAccountRequest { } export namespace TransferDomainToAnotherAwsAccountRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: TransferDomainToAnotherAwsAccountRequest): any => ({ ...obj, }); @@ -2853,6 +3033,9 @@ export interface TransferDomainToAnotherAwsAccountResponse { } export namespace TransferDomainToAnotherAwsAccountResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: TransferDomainToAnotherAwsAccountResponse): any => ({ ...obj, }); @@ -2884,6 +3067,9 @@ export interface UpdateDomainContactRequest { } export namespace UpdateDomainContactRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateDomainContactRequest): any => ({ ...obj, ...(obj.AdminContact && { AdminContact: SENSITIVE_STRING }), @@ -2904,6 +3090,9 @@ export interface UpdateDomainContactResponse { } export namespace UpdateDomainContactResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateDomainContactResponse): any => ({ ...obj, }); @@ -2944,6 +3133,9 @@ export interface UpdateDomainContactPrivacyRequest { } export namespace UpdateDomainContactPrivacyRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateDomainContactPrivacyRequest): any => ({ ...obj, }); @@ -2960,6 +3152,9 @@ export interface UpdateDomainContactPrivacyResponse { } export namespace UpdateDomainContactPrivacyResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateDomainContactPrivacyResponse): any => ({ ...obj, }); @@ -2991,6 +3186,9 @@ export interface UpdateDomainNameserversRequest { } export namespace UpdateDomainNameserversRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateDomainNameserversRequest): any => ({ ...obj, }); @@ -3008,6 +3206,9 @@ export interface UpdateDomainNameserversResponse { } export namespace UpdateDomainNameserversResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateDomainNameserversResponse): any => ({ ...obj, }); @@ -3030,6 +3231,9 @@ export interface UpdateTagsForDomainRequest { } export namespace UpdateTagsForDomainRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateTagsForDomainRequest): any => ({ ...obj, }); @@ -3038,6 +3242,9 @@ export namespace UpdateTagsForDomainRequest { export interface UpdateTagsForDomainResponse {} export namespace UpdateTagsForDomainResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateTagsForDomainResponse): any => ({ ...obj, }); @@ -3078,6 +3285,9 @@ export interface ViewBillingRequest { } export namespace ViewBillingRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ViewBillingRequest): any => ({ ...obj, }); @@ -3100,6 +3310,9 @@ export interface ViewBillingResponse { } export namespace ViewBillingResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ViewBillingResponse): any => ({ ...obj, }); diff --git a/clients/client-route-53/commands/ActivateKeySigningKeyCommand.ts b/clients/client-route-53/commands/ActivateKeySigningKeyCommand.ts index b3184a678a6d..4ad68b32bcfa 100644 --- a/clients/client-route-53/commands/ActivateKeySigningKeyCommand.ts +++ b/clients/client-route-53/commands/ActivateKeySigningKeyCommand.ts @@ -24,6 +24,20 @@ export interface ActivateKeySigningKeyCommandOutput extends ActivateKeySigningKe /** *

Activates a key-signing key (KSK) so that it can be used for signing by DNSSEC. This operation changes the * KSK status to ACTIVE.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { Route53Client, ActivateKeySigningKeyCommand } from "@aws-sdk/client-route-53"; // ES Modules import + * // const { Route53Client, ActivateKeySigningKeyCommand } = require("@aws-sdk/client-route-53"); // CommonJS import + * const client = new Route53Client(config); + * const command = new ActivateKeySigningKeyCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ActivateKeySigningKeyCommandInput} for command's `input` shape. + * @see {@link ActivateKeySigningKeyCommandOutput} for command's `response` shape. + * @see {@link Route53ClientResolvedConfig | config} for command's `input` shape. + * */ export class ActivateKeySigningKeyCommand extends $Command< ActivateKeySigningKeyCommandInput, diff --git a/clients/client-route-53/commands/AssociateVPCWithHostedZoneCommand.ts b/clients/client-route-53/commands/AssociateVPCWithHostedZoneCommand.ts index b43281ae575c..bbabf742660e 100644 --- a/clients/client-route-53/commands/AssociateVPCWithHostedZoneCommand.ts +++ b/clients/client-route-53/commands/AssociateVPCWithHostedZoneCommand.ts @@ -33,6 +33,20 @@ export interface AssociateVPCWithHostedZoneCommandOutput extends AssociateVPCWit * CreateVPCAssociationAuthorization request. Then the account that created the VPC must submit an * AssociateVPCWithHostedZone request.

* + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { Route53Client, AssociateVPCWithHostedZoneCommand } from "@aws-sdk/client-route-53"; // ES Modules import + * // const { Route53Client, AssociateVPCWithHostedZoneCommand } = require("@aws-sdk/client-route-53"); // CommonJS import + * const client = new Route53Client(config); + * const command = new AssociateVPCWithHostedZoneCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link AssociateVPCWithHostedZoneCommandInput} for command's `input` shape. + * @see {@link AssociateVPCWithHostedZoneCommandOutput} for command's `response` shape. + * @see {@link Route53ClientResolvedConfig | config} for command's `input` shape. + * */ export class AssociateVPCWithHostedZoneCommand extends $Command< AssociateVPCWithHostedZoneCommandInput, diff --git a/clients/client-route-53/commands/ChangeResourceRecordSetsCommand.ts b/clients/client-route-53/commands/ChangeResourceRecordSetsCommand.ts index f2904e8f0540..aa9b388d4469 100644 --- a/clients/client-route-53/commands/ChangeResourceRecordSetsCommand.ts +++ b/clients/client-route-53/commands/ChangeResourceRecordSetsCommand.ts @@ -104,6 +104,20 @@ export interface ChangeResourceRecordSetsCommandOutput extends ChangeResourceRec *

For information about the limits on a ChangeResourceRecordSets request, see * Limits in the * Amazon Route 53 Developer Guide.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { Route53Client, ChangeResourceRecordSetsCommand } from "@aws-sdk/client-route-53"; // ES Modules import + * // const { Route53Client, ChangeResourceRecordSetsCommand } = require("@aws-sdk/client-route-53"); // CommonJS import + * const client = new Route53Client(config); + * const command = new ChangeResourceRecordSetsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ChangeResourceRecordSetsCommandInput} for command's `input` shape. + * @see {@link ChangeResourceRecordSetsCommandOutput} for command's `response` shape. + * @see {@link Route53ClientResolvedConfig | config} for command's `input` shape. + * */ export class ChangeResourceRecordSetsCommand extends $Command< ChangeResourceRecordSetsCommandInput, diff --git a/clients/client-route-53/commands/ChangeTagsForResourceCommand.ts b/clients/client-route-53/commands/ChangeTagsForResourceCommand.ts index 6b0c25d53ab9..77c07e32f9ae 100644 --- a/clients/client-route-53/commands/ChangeTagsForResourceCommand.ts +++ b/clients/client-route-53/commands/ChangeTagsForResourceCommand.ts @@ -25,6 +25,20 @@ export interface ChangeTagsForResourceCommandOutput extends ChangeTagsForResourc *

For information about using tags for cost allocation, see * Using Cost Allocation Tags * in the AWS Billing and Cost Management User Guide.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { Route53Client, ChangeTagsForResourceCommand } from "@aws-sdk/client-route-53"; // ES Modules import + * // const { Route53Client, ChangeTagsForResourceCommand } = require("@aws-sdk/client-route-53"); // CommonJS import + * const client = new Route53Client(config); + * const command = new ChangeTagsForResourceCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ChangeTagsForResourceCommandInput} for command's `input` shape. + * @see {@link ChangeTagsForResourceCommandOutput} for command's `response` shape. + * @see {@link Route53ClientResolvedConfig | config} for command's `input` shape. + * */ export class ChangeTagsForResourceCommand extends $Command< ChangeTagsForResourceCommandInput, diff --git a/clients/client-route-53/commands/CreateHealthCheckCommand.ts b/clients/client-route-53/commands/CreateHealthCheckCommand.ts index e9c021801b45..ff1db63b0e38 100644 --- a/clients/client-route-53/commands/CreateHealthCheckCommand.ts +++ b/clients/client-route-53/commands/CreateHealthCheckCommand.ts @@ -55,6 +55,20 @@ export interface CreateHealthCheckCommandOutput extends CreateHealthCheckRespons * Amazon CloudWatch User Guide.

* * + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { Route53Client, CreateHealthCheckCommand } from "@aws-sdk/client-route-53"; // ES Modules import + * // const { Route53Client, CreateHealthCheckCommand } = require("@aws-sdk/client-route-53"); // CommonJS import + * const client = new Route53Client(config); + * const command = new CreateHealthCheckCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreateHealthCheckCommandInput} for command's `input` shape. + * @see {@link CreateHealthCheckCommandOutput} for command's `response` shape. + * @see {@link Route53ClientResolvedConfig | config} for command's `input` shape. + * */ export class CreateHealthCheckCommand extends $Command< CreateHealthCheckCommandInput, diff --git a/clients/client-route-53/commands/CreateHostedZoneCommand.ts b/clients/client-route-53/commands/CreateHostedZoneCommand.ts index dd4313911bab..fc970f3fe6a6 100644 --- a/clients/client-route-53/commands/CreateHostedZoneCommand.ts +++ b/clients/client-route-53/commands/CreateHostedZoneCommand.ts @@ -55,6 +55,20 @@ export interface CreateHostedZoneCommandOutput extends CreateHostedZoneResponse, * 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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { Route53Client, CreateHostedZoneCommand } from "@aws-sdk/client-route-53"; // ES Modules import + * // const { Route53Client, CreateHostedZoneCommand } = require("@aws-sdk/client-route-53"); // CommonJS import + * const client = new Route53Client(config); + * const command = new CreateHostedZoneCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreateHostedZoneCommandInput} for command's `input` shape. + * @see {@link CreateHostedZoneCommandOutput} for command's `response` shape. + * @see {@link Route53ClientResolvedConfig | config} for command's `input` shape. + * */ export class CreateHostedZoneCommand extends $Command< CreateHostedZoneCommandInput, diff --git a/clients/client-route-53/commands/CreateKeySigningKeyCommand.ts b/clients/client-route-53/commands/CreateKeySigningKeyCommand.ts index e698f80ee559..d6d1149c502f 100644 --- a/clients/client-route-53/commands/CreateKeySigningKeyCommand.ts +++ b/clients/client-route-53/commands/CreateKeySigningKeyCommand.ts @@ -23,6 +23,20 @@ export interface CreateKeySigningKeyCommandOutput extends CreateKeySigningKeyRes /** *

Creates a new key-signing key (KSK) associated with a hosted zone. You can only have two KSKs per hosted zone.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { Route53Client, CreateKeySigningKeyCommand } from "@aws-sdk/client-route-53"; // ES Modules import + * // const { Route53Client, CreateKeySigningKeyCommand } = require("@aws-sdk/client-route-53"); // CommonJS import + * const client = new Route53Client(config); + * const command = new CreateKeySigningKeyCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreateKeySigningKeyCommandInput} for command's `input` shape. + * @see {@link CreateKeySigningKeyCommandOutput} for command's `response` shape. + * @see {@link Route53ClientResolvedConfig | config} for command's `input` shape. + * */ export class CreateKeySigningKeyCommand extends $Command< CreateKeySigningKeyCommandInput, diff --git a/clients/client-route-53/commands/CreateQueryLoggingConfigCommand.ts b/clients/client-route-53/commands/CreateQueryLoggingConfigCommand.ts index 7b309c25fecb..367e5e16c6f9 100644 --- a/clients/client-route-53/commands/CreateQueryLoggingConfigCommand.ts +++ b/clients/client-route-53/commands/CreateQueryLoggingConfigCommand.ts @@ -139,6 +139,20 @@ export interface CreateQueryLoggingConfigCommandOutput extends CreateQueryLoggin * DeleteQueryLoggingConfig.

* * + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { Route53Client, CreateQueryLoggingConfigCommand } from "@aws-sdk/client-route-53"; // ES Modules import + * // const { Route53Client, CreateQueryLoggingConfigCommand } = require("@aws-sdk/client-route-53"); // CommonJS import + * const client = new Route53Client(config); + * const command = new CreateQueryLoggingConfigCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreateQueryLoggingConfigCommandInput} for command's `input` shape. + * @see {@link CreateQueryLoggingConfigCommandOutput} for command's `response` shape. + * @see {@link Route53ClientResolvedConfig | config} for command's `input` shape. + * */ export class CreateQueryLoggingConfigCommand extends $Command< CreateQueryLoggingConfigCommandInput, diff --git a/clients/client-route-53/commands/CreateReusableDelegationSetCommand.ts b/clients/client-route-53/commands/CreateReusableDelegationSetCommand.ts index bff13e3b087a..a8c2da213dfd 100644 --- a/clients/client-route-53/commands/CreateReusableDelegationSetCommand.ts +++ b/clients/client-route-53/commands/CreateReusableDelegationSetCommand.ts @@ -75,6 +75,20 @@ export interface CreateReusableDelegationSetCommandOutput * reusable delegation set.

* * + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { Route53Client, CreateReusableDelegationSetCommand } from "@aws-sdk/client-route-53"; // ES Modules import + * // const { Route53Client, CreateReusableDelegationSetCommand } = require("@aws-sdk/client-route-53"); // CommonJS import + * const client = new Route53Client(config); + * const command = new CreateReusableDelegationSetCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreateReusableDelegationSetCommandInput} for command's `input` shape. + * @see {@link CreateReusableDelegationSetCommandOutput} for command's `response` shape. + * @see {@link Route53ClientResolvedConfig | config} for command's `input` shape. + * */ export class CreateReusableDelegationSetCommand extends $Command< CreateReusableDelegationSetCommandInput, diff --git a/clients/client-route-53/commands/CreateTrafficPolicyCommand.ts b/clients/client-route-53/commands/CreateTrafficPolicyCommand.ts index 0a748128fd9f..90b98852d214 100644 --- a/clients/client-route-53/commands/CreateTrafficPolicyCommand.ts +++ b/clients/client-route-53/commands/CreateTrafficPolicyCommand.ts @@ -23,6 +23,20 @@ export interface CreateTrafficPolicyCommandOutput extends CreateTrafficPolicyRes /** *

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).

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { Route53Client, CreateTrafficPolicyCommand } from "@aws-sdk/client-route-53"; // ES Modules import + * // const { Route53Client, CreateTrafficPolicyCommand } = require("@aws-sdk/client-route-53"); // CommonJS import + * const client = new Route53Client(config); + * const command = new CreateTrafficPolicyCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreateTrafficPolicyCommandInput} for command's `input` shape. + * @see {@link CreateTrafficPolicyCommandOutput} for command's `response` shape. + * @see {@link Route53ClientResolvedConfig | config} for command's `input` shape. + * */ export class CreateTrafficPolicyCommand extends $Command< CreateTrafficPolicyCommandInput, diff --git a/clients/client-route-53/commands/CreateTrafficPolicyInstanceCommand.ts b/clients/client-route-53/commands/CreateTrafficPolicyInstanceCommand.ts index d759beecd001..960aaacf0efe 100644 --- a/clients/client-route-53/commands/CreateTrafficPolicyInstanceCommand.ts +++ b/clients/client-route-53/commands/CreateTrafficPolicyInstanceCommand.ts @@ -28,6 +28,20 @@ export interface CreateTrafficPolicyInstanceCommandOutput * 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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { Route53Client, CreateTrafficPolicyInstanceCommand } from "@aws-sdk/client-route-53"; // ES Modules import + * // const { Route53Client, CreateTrafficPolicyInstanceCommand } = require("@aws-sdk/client-route-53"); // CommonJS import + * const client = new Route53Client(config); + * const command = new CreateTrafficPolicyInstanceCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreateTrafficPolicyInstanceCommandInput} for command's `input` shape. + * @see {@link CreateTrafficPolicyInstanceCommandOutput} for command's `response` shape. + * @see {@link Route53ClientResolvedConfig | config} for command's `input` shape. + * */ export class CreateTrafficPolicyInstanceCommand extends $Command< CreateTrafficPolicyInstanceCommandInput, diff --git a/clients/client-route-53/commands/CreateTrafficPolicyVersionCommand.ts b/clients/client-route-53/commands/CreateTrafficPolicyVersionCommand.ts index 0dd46de0317c..4f1ed9530ef0 100644 --- a/clients/client-route-53/commands/CreateTrafficPolicyVersionCommand.ts +++ b/clients/client-route-53/commands/CreateTrafficPolicyVersionCommand.ts @@ -27,6 +27,20 @@ export interface CreateTrafficPolicyVersionCommandOutput extends CreateTrafficPo * 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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { Route53Client, CreateTrafficPolicyVersionCommand } from "@aws-sdk/client-route-53"; // ES Modules import + * // const { Route53Client, CreateTrafficPolicyVersionCommand } = require("@aws-sdk/client-route-53"); // CommonJS import + * const client = new Route53Client(config); + * const command = new CreateTrafficPolicyVersionCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreateTrafficPolicyVersionCommandInput} for command's `input` shape. + * @see {@link CreateTrafficPolicyVersionCommandOutput} for command's `response` shape. + * @see {@link Route53ClientResolvedConfig | config} for command's `input` shape. + * */ export class CreateTrafficPolicyVersionCommand extends $Command< CreateTrafficPolicyVersionCommandInput, diff --git a/clients/client-route-53/commands/CreateVPCAssociationAuthorizationCommand.ts b/clients/client-route-53/commands/CreateVPCAssociationAuthorizationCommand.ts index 1cb2bae101ec..5097b3d8d019 100644 --- a/clients/client-route-53/commands/CreateVPCAssociationAuthorizationCommand.ts +++ b/clients/client-route-53/commands/CreateVPCAssociationAuthorizationCommand.ts @@ -36,6 +36,20 @@ export interface CreateVPCAssociationAuthorizationCommandOutput *

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.

* + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { Route53Client, CreateVPCAssociationAuthorizationCommand } from "@aws-sdk/client-route-53"; // ES Modules import + * // const { Route53Client, CreateVPCAssociationAuthorizationCommand } = require("@aws-sdk/client-route-53"); // CommonJS import + * const client = new Route53Client(config); + * const command = new CreateVPCAssociationAuthorizationCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreateVPCAssociationAuthorizationCommandInput} for command's `input` shape. + * @see {@link CreateVPCAssociationAuthorizationCommandOutput} for command's `response` shape. + * @see {@link Route53ClientResolvedConfig | config} for command's `input` shape. + * */ export class CreateVPCAssociationAuthorizationCommand extends $Command< CreateVPCAssociationAuthorizationCommandInput, diff --git a/clients/client-route-53/commands/DeactivateKeySigningKeyCommand.ts b/clients/client-route-53/commands/DeactivateKeySigningKeyCommand.ts index f607d4338ba5..53b96add6757 100644 --- a/clients/client-route-53/commands/DeactivateKeySigningKeyCommand.ts +++ b/clients/client-route-53/commands/DeactivateKeySigningKeyCommand.ts @@ -24,6 +24,20 @@ export interface DeactivateKeySigningKeyCommandOutput extends DeactivateKeySigni /** *

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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { Route53Client, DeactivateKeySigningKeyCommand } from "@aws-sdk/client-route-53"; // ES Modules import + * // const { Route53Client, DeactivateKeySigningKeyCommand } = require("@aws-sdk/client-route-53"); // CommonJS import + * const client = new Route53Client(config); + * const command = new DeactivateKeySigningKeyCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeactivateKeySigningKeyCommandInput} for command's `input` shape. + * @see {@link DeactivateKeySigningKeyCommandOutput} for command's `response` shape. + * @see {@link Route53ClientResolvedConfig | config} for command's `input` shape. + * */ export class DeactivateKeySigningKeyCommand extends $Command< DeactivateKeySigningKeyCommandInput, diff --git a/clients/client-route-53/commands/DeleteHealthCheckCommand.ts b/clients/client-route-53/commands/DeleteHealthCheckCommand.ts index bab39a01c081..a3255c8d57ad 100644 --- a/clients/client-route-53/commands/DeleteHealthCheckCommand.ts +++ b/clients/client-route-53/commands/DeleteHealthCheckCommand.ts @@ -35,6 +35,20 @@ export interface DeleteHealthCheckCommandOutput extends DeleteHealthCheckRespons * 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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { Route53Client, DeleteHealthCheckCommand } from "@aws-sdk/client-route-53"; // ES Modules import + * // const { Route53Client, DeleteHealthCheckCommand } = require("@aws-sdk/client-route-53"); // CommonJS import + * const client = new Route53Client(config); + * const command = new DeleteHealthCheckCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteHealthCheckCommandInput} for command's `input` shape. + * @see {@link DeleteHealthCheckCommandOutput} for command's `response` shape. + * @see {@link Route53ClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteHealthCheckCommand extends $Command< DeleteHealthCheckCommandInput, diff --git a/clients/client-route-53/commands/DeleteHostedZoneCommand.ts b/clients/client-route-53/commands/DeleteHostedZoneCommand.ts index 2219c77f61b2..9b44da418a6c 100644 --- a/clients/client-route-53/commands/DeleteHostedZoneCommand.ts +++ b/clients/client-route-53/commands/DeleteHostedZoneCommand.ts @@ -61,6 +61,20 @@ export interface DeleteHostedZoneCommandOutput extends DeleteHostedZoneResponse, * AWS account.

* * + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { Route53Client, DeleteHostedZoneCommand } from "@aws-sdk/client-route-53"; // ES Modules import + * // const { Route53Client, DeleteHostedZoneCommand } = require("@aws-sdk/client-route-53"); // CommonJS import + * const client = new Route53Client(config); + * const command = new DeleteHostedZoneCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteHostedZoneCommandInput} for command's `input` shape. + * @see {@link DeleteHostedZoneCommandOutput} for command's `response` shape. + * @see {@link Route53ClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteHostedZoneCommand extends $Command< DeleteHostedZoneCommandInput, diff --git a/clients/client-route-53/commands/DeleteKeySigningKeyCommand.ts b/clients/client-route-53/commands/DeleteKeySigningKeyCommand.ts index 59131539aab4..1acc65462c0c 100644 --- a/clients/client-route-53/commands/DeleteKeySigningKeyCommand.ts +++ b/clients/client-route-53/commands/DeleteKeySigningKeyCommand.ts @@ -24,6 +24,20 @@ export interface DeleteKeySigningKeyCommandOutput extends DeleteKeySigningKeyRes /** *

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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { Route53Client, DeleteKeySigningKeyCommand } from "@aws-sdk/client-route-53"; // ES Modules import + * // const { Route53Client, DeleteKeySigningKeyCommand } = require("@aws-sdk/client-route-53"); // CommonJS import + * const client = new Route53Client(config); + * const command = new DeleteKeySigningKeyCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteKeySigningKeyCommandInput} for command's `input` shape. + * @see {@link DeleteKeySigningKeyCommandOutput} for command's `response` shape. + * @see {@link Route53ClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteKeySigningKeyCommand extends $Command< DeleteKeySigningKeyCommandInput, diff --git a/clients/client-route-53/commands/DeleteQueryLoggingConfigCommand.ts b/clients/client-route-53/commands/DeleteQueryLoggingConfigCommand.ts index 92b0aab483f6..5d52f4383221 100644 --- a/clients/client-route-53/commands/DeleteQueryLoggingConfigCommand.ts +++ b/clients/client-route-53/commands/DeleteQueryLoggingConfigCommand.ts @@ -27,6 +27,20 @@ export interface DeleteQueryLoggingConfigCommandOutput extends DeleteQueryLoggin * *

For more information about DNS query logs, see * CreateQueryLoggingConfig.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { Route53Client, DeleteQueryLoggingConfigCommand } from "@aws-sdk/client-route-53"; // ES Modules import + * // const { Route53Client, DeleteQueryLoggingConfigCommand } = require("@aws-sdk/client-route-53"); // CommonJS import + * const client = new Route53Client(config); + * const command = new DeleteQueryLoggingConfigCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteQueryLoggingConfigCommandInput} for command's `input` shape. + * @see {@link DeleteQueryLoggingConfigCommandOutput} for command's `response` shape. + * @see {@link Route53ClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteQueryLoggingConfigCommand extends $Command< DeleteQueryLoggingConfigCommandInput, diff --git a/clients/client-route-53/commands/DeleteReusableDelegationSetCommand.ts b/clients/client-route-53/commands/DeleteReusableDelegationSetCommand.ts index ad70e28d0dce..a408565f4dbd 100644 --- a/clients/client-route-53/commands/DeleteReusableDelegationSetCommand.ts +++ b/clients/client-route-53/commands/DeleteReusableDelegationSetCommand.ts @@ -31,6 +31,20 @@ export interface DeleteReusableDelegationSetCommandOutput *

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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { Route53Client, DeleteReusableDelegationSetCommand } from "@aws-sdk/client-route-53"; // ES Modules import + * // const { Route53Client, DeleteReusableDelegationSetCommand } = require("@aws-sdk/client-route-53"); // CommonJS import + * const client = new Route53Client(config); + * const command = new DeleteReusableDelegationSetCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteReusableDelegationSetCommandInput} for command's `input` shape. + * @see {@link DeleteReusableDelegationSetCommandOutput} for command's `response` shape. + * @see {@link Route53ClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteReusableDelegationSetCommand extends $Command< DeleteReusableDelegationSetCommandInput, diff --git a/clients/client-route-53/commands/DeleteTrafficPolicyCommand.ts b/clients/client-route-53/commands/DeleteTrafficPolicyCommand.ts index 7a9e7d3ce0b6..d6de77a76eb1 100644 --- a/clients/client-route-53/commands/DeleteTrafficPolicyCommand.ts +++ b/clients/client-route-53/commands/DeleteTrafficPolicyCommand.ts @@ -37,6 +37,20 @@ export interface DeleteTrafficPolicyCommandOutput extends DeleteTrafficPolicyRes * GetTrafficPolicy.

* * + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { Route53Client, DeleteTrafficPolicyCommand } from "@aws-sdk/client-route-53"; // ES Modules import + * // const { Route53Client, DeleteTrafficPolicyCommand } = require("@aws-sdk/client-route-53"); // CommonJS import + * const client = new Route53Client(config); + * const command = new DeleteTrafficPolicyCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteTrafficPolicyCommandInput} for command's `input` shape. + * @see {@link DeleteTrafficPolicyCommandOutput} for command's `response` shape. + * @see {@link Route53ClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteTrafficPolicyCommand extends $Command< DeleteTrafficPolicyCommandInput, diff --git a/clients/client-route-53/commands/DeleteTrafficPolicyInstanceCommand.ts b/clients/client-route-53/commands/DeleteTrafficPolicyInstanceCommand.ts index 0aeef3aabd2f..2e60858c722c 100644 --- a/clients/client-route-53/commands/DeleteTrafficPolicyInstanceCommand.ts +++ b/clients/client-route-53/commands/DeleteTrafficPolicyInstanceCommand.ts @@ -28,6 +28,20 @@ export interface DeleteTrafficPolicyInstanceCommandOutput * *

In the Route 53 console, traffic policy instances are known as policy records.

* + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { Route53Client, DeleteTrafficPolicyInstanceCommand } from "@aws-sdk/client-route-53"; // ES Modules import + * // const { Route53Client, DeleteTrafficPolicyInstanceCommand } = require("@aws-sdk/client-route-53"); // CommonJS import + * const client = new Route53Client(config); + * const command = new DeleteTrafficPolicyInstanceCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteTrafficPolicyInstanceCommandInput} for command's `input` shape. + * @see {@link DeleteTrafficPolicyInstanceCommandOutput} for command's `response` shape. + * @see {@link Route53ClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteTrafficPolicyInstanceCommand extends $Command< DeleteTrafficPolicyInstanceCommandInput, diff --git a/clients/client-route-53/commands/DeleteVPCAssociationAuthorizationCommand.ts b/clients/client-route-53/commands/DeleteVPCAssociationAuthorizationCommand.ts index 27ff4da63e3e..7e6edb8dc7d8 100644 --- a/clients/client-route-53/commands/DeleteVPCAssociationAuthorizationCommand.ts +++ b/clients/client-route-53/commands/DeleteVPCAssociationAuthorizationCommand.ts @@ -36,6 +36,20 @@ export interface DeleteVPCAssociationAuthorizationCommandOutput * DeleteVPCAssociationAuthorization won't disassociate the VPC from the hosted zone. * If you want to delete an existing association, use DisassociateVPCFromHostedZone.

* + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { Route53Client, DeleteVPCAssociationAuthorizationCommand } from "@aws-sdk/client-route-53"; // ES Modules import + * // const { Route53Client, DeleteVPCAssociationAuthorizationCommand } = require("@aws-sdk/client-route-53"); // CommonJS import + * const client = new Route53Client(config); + * const command = new DeleteVPCAssociationAuthorizationCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteVPCAssociationAuthorizationCommandInput} for command's `input` shape. + * @see {@link DeleteVPCAssociationAuthorizationCommandOutput} for command's `response` shape. + * @see {@link Route53ClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteVPCAssociationAuthorizationCommand extends $Command< DeleteVPCAssociationAuthorizationCommandInput, diff --git a/clients/client-route-53/commands/DisableHostedZoneDNSSECCommand.ts b/clients/client-route-53/commands/DisableHostedZoneDNSSECCommand.ts index 7e9bb6d090f1..522d3ed21779 100644 --- a/clients/client-route-53/commands/DisableHostedZoneDNSSECCommand.ts +++ b/clients/client-route-53/commands/DisableHostedZoneDNSSECCommand.ts @@ -24,6 +24,20 @@ export interface DisableHostedZoneDNSSECCommandOutput extends DisableHostedZoneD /** *

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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { Route53Client, DisableHostedZoneDNSSECCommand } from "@aws-sdk/client-route-53"; // ES Modules import + * // const { Route53Client, DisableHostedZoneDNSSECCommand } = require("@aws-sdk/client-route-53"); // CommonJS import + * const client = new Route53Client(config); + * const command = new DisableHostedZoneDNSSECCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DisableHostedZoneDNSSECCommandInput} for command's `input` shape. + * @see {@link DisableHostedZoneDNSSECCommandOutput} for command's `response` shape. + * @see {@link Route53ClientResolvedConfig | config} for command's `input` shape. + * */ export class DisableHostedZoneDNSSECCommand extends $Command< DisableHostedZoneDNSSECCommandInput, diff --git a/clients/client-route-53/commands/DisassociateVPCFromHostedZoneCommand.ts b/clients/client-route-53/commands/DisassociateVPCFromHostedZoneCommand.ts index aa0ac9c8bf7d..19d23cdde7d6 100644 --- a/clients/client-route-53/commands/DisassociateVPCFromHostedZoneCommand.ts +++ b/clients/client-route-53/commands/DisassociateVPCFromHostedZoneCommand.ts @@ -45,6 +45,20 @@ export interface DisassociateVPCFromHostedZoneCommandOutput * If the hosted zone has a value for OwningService, you can't use DisassociateVPCFromHostedZone.

* * + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { Route53Client, DisassociateVPCFromHostedZoneCommand } from "@aws-sdk/client-route-53"; // ES Modules import + * // const { Route53Client, DisassociateVPCFromHostedZoneCommand } = require("@aws-sdk/client-route-53"); // CommonJS import + * const client = new Route53Client(config); + * const command = new DisassociateVPCFromHostedZoneCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DisassociateVPCFromHostedZoneCommandInput} for command's `input` shape. + * @see {@link DisassociateVPCFromHostedZoneCommandOutput} for command's `response` shape. + * @see {@link Route53ClientResolvedConfig | config} for command's `input` shape. + * */ export class DisassociateVPCFromHostedZoneCommand extends $Command< DisassociateVPCFromHostedZoneCommandInput, diff --git a/clients/client-route-53/commands/EnableHostedZoneDNSSECCommand.ts b/clients/client-route-53/commands/EnableHostedZoneDNSSECCommand.ts index c8b7f5aa8b62..79a6213d1470 100644 --- a/clients/client-route-53/commands/EnableHostedZoneDNSSECCommand.ts +++ b/clients/client-route-53/commands/EnableHostedZoneDNSSECCommand.ts @@ -23,6 +23,20 @@ export interface EnableHostedZoneDNSSECCommandOutput extends EnableHostedZoneDNS /** *

Enables DNSSEC signing in a specific hosted zone.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { Route53Client, EnableHostedZoneDNSSECCommand } from "@aws-sdk/client-route-53"; // ES Modules import + * // const { Route53Client, EnableHostedZoneDNSSECCommand } = require("@aws-sdk/client-route-53"); // CommonJS import + * const client = new Route53Client(config); + * const command = new EnableHostedZoneDNSSECCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link EnableHostedZoneDNSSECCommandInput} for command's `input` shape. + * @see {@link EnableHostedZoneDNSSECCommandOutput} for command's `response` shape. + * @see {@link Route53ClientResolvedConfig | config} for command's `input` shape. + * */ export class EnableHostedZoneDNSSECCommand extends $Command< EnableHostedZoneDNSSECCommandInput, diff --git a/clients/client-route-53/commands/GetAccountLimitCommand.ts b/clients/client-route-53/commands/GetAccountLimitCommand.ts index 74fbadc90e19..a1be3a079109 100644 --- a/clients/client-route-53/commands/GetAccountLimitCommand.ts +++ b/clients/client-route-53/commands/GetAccountLimitCommand.ts @@ -31,6 +31,20 @@ export interface GetAccountLimitCommandOutput extends GetAccountLimitResponse, _ * https://console.aws.amazon.com/trustedadvisor/. Then choose * Service limits in the navigation pane.

* + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { Route53Client, GetAccountLimitCommand } from "@aws-sdk/client-route-53"; // ES Modules import + * // const { Route53Client, GetAccountLimitCommand } = require("@aws-sdk/client-route-53"); // CommonJS import + * const client = new Route53Client(config); + * const command = new GetAccountLimitCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetAccountLimitCommandInput} for command's `input` shape. + * @see {@link GetAccountLimitCommandOutput} for command's `response` shape. + * @see {@link Route53ClientResolvedConfig | config} for command's `input` shape. + * */ export class GetAccountLimitCommand extends $Command< GetAccountLimitCommandInput, diff --git a/clients/client-route-53/commands/GetChangeCommand.ts b/clients/client-route-53/commands/GetChangeCommand.ts index c1df805c6cf7..d93559596794 100644 --- a/clients/client-route-53/commands/GetChangeCommand.ts +++ b/clients/client-route-53/commands/GetChangeCommand.ts @@ -32,6 +32,20 @@ export interface GetChangeCommandOutput extends GetChangeResponse, __MetadataBea * INSYNC indicates that the changes have propagated to all Route 53 DNS servers.

* * + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { Route53Client, GetChangeCommand } from "@aws-sdk/client-route-53"; // ES Modules import + * // const { Route53Client, GetChangeCommand } = require("@aws-sdk/client-route-53"); // CommonJS import + * const client = new Route53Client(config); + * const command = new GetChangeCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetChangeCommandInput} for command's `input` shape. + * @see {@link GetChangeCommandOutput} for command's `response` shape. + * @see {@link Route53ClientResolvedConfig | config} for command's `input` shape. + * */ export class GetChangeCommand extends $Command< GetChangeCommandInput, diff --git a/clients/client-route-53/commands/GetCheckerIpRangesCommand.ts b/clients/client-route-53/commands/GetCheckerIpRangesCommand.ts index c7402ea7d367..80abe0d2e42c 100644 --- a/clients/client-route-53/commands/GetCheckerIpRangesCommand.ts +++ b/clients/client-route-53/commands/GetCheckerIpRangesCommand.ts @@ -29,6 +29,20 @@ export interface GetCheckerIpRangesCommandOutput extends GetCheckerIpRangesRespo * IP Address Ranges of Amazon Route 53 Servers * in the Amazon Route 53 Developer Guide.

* + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { Route53Client, GetCheckerIpRangesCommand } from "@aws-sdk/client-route-53"; // ES Modules import + * // const { Route53Client, GetCheckerIpRangesCommand } = require("@aws-sdk/client-route-53"); // CommonJS import + * const client = new Route53Client(config); + * const command = new GetCheckerIpRangesCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetCheckerIpRangesCommandInput} for command's `input` shape. + * @see {@link GetCheckerIpRangesCommandOutput} for command's `response` shape. + * @see {@link Route53ClientResolvedConfig | config} for command's `input` shape. + * */ export class GetCheckerIpRangesCommand extends $Command< GetCheckerIpRangesCommandInput, diff --git a/clients/client-route-53/commands/GetDNSSECCommand.ts b/clients/client-route-53/commands/GetDNSSECCommand.ts index c1b44eddfad4..d24e49c77361 100644 --- a/clients/client-route-53/commands/GetDNSSECCommand.ts +++ b/clients/client-route-53/commands/GetDNSSECCommand.ts @@ -20,6 +20,20 @@ export interface GetDNSSECCommandOutput extends GetDNSSECResponse, __MetadataBea /** *

Returns information about DNSSEC for a specific hosted zone, including the key-signing keys (KSKs) in the hosted zone.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { Route53Client, GetDNSSECCommand } from "@aws-sdk/client-route-53"; // ES Modules import + * // const { Route53Client, GetDNSSECCommand } = require("@aws-sdk/client-route-53"); // CommonJS import + * const client = new Route53Client(config); + * const command = new GetDNSSECCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetDNSSECCommandInput} for command's `input` shape. + * @see {@link GetDNSSECCommandOutput} for command's `response` shape. + * @see {@link Route53ClientResolvedConfig | config} for command's `input` shape. + * */ export class GetDNSSECCommand extends $Command< GetDNSSECCommandInput, diff --git a/clients/client-route-53/commands/GetGeoLocationCommand.ts b/clients/client-route-53/commands/GetGeoLocationCommand.ts index 569ae15f80f3..6357b7347df5 100644 --- a/clients/client-route-53/commands/GetGeoLocationCommand.ts +++ b/clients/client-route-53/commands/GetGeoLocationCommand.ts @@ -42,6 +42,20 @@ export interface GetGeoLocationCommandOutput extends GetGeoLocationResponse, __M * GET /2013-04-01/geolocation?countrycode=two-character country code&subdivisioncode=subdivision code * *

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { Route53Client, GetGeoLocationCommand } from "@aws-sdk/client-route-53"; // ES Modules import + * // const { Route53Client, GetGeoLocationCommand } = require("@aws-sdk/client-route-53"); // CommonJS import + * const client = new Route53Client(config); + * const command = new GetGeoLocationCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetGeoLocationCommandInput} for command's `input` shape. + * @see {@link GetGeoLocationCommandOutput} for command's `response` shape. + * @see {@link Route53ClientResolvedConfig | config} for command's `input` shape. + * */ export class GetGeoLocationCommand extends $Command< GetGeoLocationCommandInput, diff --git a/clients/client-route-53/commands/GetHealthCheckCommand.ts b/clients/client-route-53/commands/GetHealthCheckCommand.ts index 370182a8f8a5..95d4ddc8a240 100644 --- a/clients/client-route-53/commands/GetHealthCheckCommand.ts +++ b/clients/client-route-53/commands/GetHealthCheckCommand.ts @@ -22,6 +22,20 @@ export interface GetHealthCheckCommandOutput extends GetHealthCheckResponse, __M /** *

Gets information about a specified health check.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { Route53Client, GetHealthCheckCommand } from "@aws-sdk/client-route-53"; // ES Modules import + * // const { Route53Client, GetHealthCheckCommand } = require("@aws-sdk/client-route-53"); // CommonJS import + * const client = new Route53Client(config); + * const command = new GetHealthCheckCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetHealthCheckCommandInput} for command's `input` shape. + * @see {@link GetHealthCheckCommandOutput} for command's `response` shape. + * @see {@link Route53ClientResolvedConfig | config} for command's `input` shape. + * */ export class GetHealthCheckCommand extends $Command< GetHealthCheckCommandInput, diff --git a/clients/client-route-53/commands/GetHealthCheckCountCommand.ts b/clients/client-route-53/commands/GetHealthCheckCountCommand.ts index 1e745c350f56..6bb79625990d 100644 --- a/clients/client-route-53/commands/GetHealthCheckCountCommand.ts +++ b/clients/client-route-53/commands/GetHealthCheckCountCommand.ts @@ -22,6 +22,20 @@ export interface GetHealthCheckCountCommandOutput extends GetHealthCheckCountRes /** *

Retrieves the number of health checks that are associated with the current AWS account.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { Route53Client, GetHealthCheckCountCommand } from "@aws-sdk/client-route-53"; // ES Modules import + * // const { Route53Client, GetHealthCheckCountCommand } = require("@aws-sdk/client-route-53"); // CommonJS import + * const client = new Route53Client(config); + * const command = new GetHealthCheckCountCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetHealthCheckCountCommandInput} for command's `input` shape. + * @see {@link GetHealthCheckCountCommandOutput} for command's `response` shape. + * @see {@link Route53ClientResolvedConfig | config} for command's `input` shape. + * */ export class GetHealthCheckCountCommand extends $Command< GetHealthCheckCountCommandInput, diff --git a/clients/client-route-53/commands/GetHealthCheckLastFailureReasonCommand.ts b/clients/client-route-53/commands/GetHealthCheckLastFailureReasonCommand.ts index a58e68581f92..d4304961e1c6 100644 --- a/clients/client-route-53/commands/GetHealthCheckLastFailureReasonCommand.ts +++ b/clients/client-route-53/commands/GetHealthCheckLastFailureReasonCommand.ts @@ -24,6 +24,20 @@ export interface GetHealthCheckLastFailureReasonCommandOutput /** *

Gets the reason that a specified health check failed most recently.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { Route53Client, GetHealthCheckLastFailureReasonCommand } from "@aws-sdk/client-route-53"; // ES Modules import + * // const { Route53Client, GetHealthCheckLastFailureReasonCommand } = require("@aws-sdk/client-route-53"); // CommonJS import + * const client = new Route53Client(config); + * const command = new GetHealthCheckLastFailureReasonCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetHealthCheckLastFailureReasonCommandInput} for command's `input` shape. + * @see {@link GetHealthCheckLastFailureReasonCommandOutput} for command's `response` shape. + * @see {@link Route53ClientResolvedConfig | config} for command's `input` shape. + * */ export class GetHealthCheckLastFailureReasonCommand extends $Command< GetHealthCheckLastFailureReasonCommandInput, diff --git a/clients/client-route-53/commands/GetHealthCheckStatusCommand.ts b/clients/client-route-53/commands/GetHealthCheckStatusCommand.ts index 328d91f3fba5..0b91bf39745e 100644 --- a/clients/client-route-53/commands/GetHealthCheckStatusCommand.ts +++ b/clients/client-route-53/commands/GetHealthCheckStatusCommand.ts @@ -22,6 +22,20 @@ export interface GetHealthCheckStatusCommandOutput extends GetHealthCheckStatusR /** *

Gets status of a specified health check.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { Route53Client, GetHealthCheckStatusCommand } from "@aws-sdk/client-route-53"; // ES Modules import + * // const { Route53Client, GetHealthCheckStatusCommand } = require("@aws-sdk/client-route-53"); // CommonJS import + * const client = new Route53Client(config); + * const command = new GetHealthCheckStatusCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetHealthCheckStatusCommandInput} for command's `input` shape. + * @see {@link GetHealthCheckStatusCommandOutput} for command's `response` shape. + * @see {@link Route53ClientResolvedConfig | config} for command's `input` shape. + * */ export class GetHealthCheckStatusCommand extends $Command< GetHealthCheckStatusCommandInput, diff --git a/clients/client-route-53/commands/GetHostedZoneCommand.ts b/clients/client-route-53/commands/GetHostedZoneCommand.ts index 3bf76a5af071..59502f6a1a60 100644 --- a/clients/client-route-53/commands/GetHostedZoneCommand.ts +++ b/clients/client-route-53/commands/GetHostedZoneCommand.ts @@ -23,6 +23,20 @@ export interface GetHostedZoneCommandOutput extends GetHostedZoneResponse, __Met /** *

Gets information about a specified hosted zone including the four name servers assigned to the hosted zone.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { Route53Client, GetHostedZoneCommand } from "@aws-sdk/client-route-53"; // ES Modules import + * // const { Route53Client, GetHostedZoneCommand } = require("@aws-sdk/client-route-53"); // CommonJS import + * const client = new Route53Client(config); + * const command = new GetHostedZoneCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetHostedZoneCommandInput} for command's `input` shape. + * @see {@link GetHostedZoneCommandOutput} for command's `response` shape. + * @see {@link Route53ClientResolvedConfig | config} for command's `input` shape. + * */ export class GetHostedZoneCommand extends $Command< GetHostedZoneCommandInput, diff --git a/clients/client-route-53/commands/GetHostedZoneCountCommand.ts b/clients/client-route-53/commands/GetHostedZoneCountCommand.ts index 3c7cabc10899..f47b798ed017 100644 --- a/clients/client-route-53/commands/GetHostedZoneCountCommand.ts +++ b/clients/client-route-53/commands/GetHostedZoneCountCommand.ts @@ -22,6 +22,20 @@ export interface GetHostedZoneCountCommandOutput extends GetHostedZoneCountRespo /** *

Retrieves the number of hosted zones that are associated with the current AWS account.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { Route53Client, GetHostedZoneCountCommand } from "@aws-sdk/client-route-53"; // ES Modules import + * // const { Route53Client, GetHostedZoneCountCommand } = require("@aws-sdk/client-route-53"); // CommonJS import + * const client = new Route53Client(config); + * const command = new GetHostedZoneCountCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetHostedZoneCountCommandInput} for command's `input` shape. + * @see {@link GetHostedZoneCountCommandOutput} for command's `response` shape. + * @see {@link Route53ClientResolvedConfig | config} for command's `input` shape. + * */ export class GetHostedZoneCountCommand extends $Command< GetHostedZoneCountCommandInput, diff --git a/clients/client-route-53/commands/GetHostedZoneLimitCommand.ts b/clients/client-route-53/commands/GetHostedZoneLimitCommand.ts index 6547c61f6a9f..7d704112c8fb 100644 --- a/clients/client-route-53/commands/GetHostedZoneLimitCommand.ts +++ b/clients/client-route-53/commands/GetHostedZoneLimitCommand.ts @@ -27,6 +27,20 @@ export interface GetHostedZoneLimitCommandOutput extends GetHostedZoneLimitRespo *

For the default limit, see Limits * in the Amazon Route 53 Developer Guide. To request a higher limit, * open a case.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { Route53Client, GetHostedZoneLimitCommand } from "@aws-sdk/client-route-53"; // ES Modules import + * // const { Route53Client, GetHostedZoneLimitCommand } = require("@aws-sdk/client-route-53"); // CommonJS import + * const client = new Route53Client(config); + * const command = new GetHostedZoneLimitCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetHostedZoneLimitCommandInput} for command's `input` shape. + * @see {@link GetHostedZoneLimitCommandOutput} for command's `response` shape. + * @see {@link Route53ClientResolvedConfig | config} for command's `input` shape. + * */ export class GetHostedZoneLimitCommand extends $Command< GetHostedZoneLimitCommandInput, diff --git a/clients/client-route-53/commands/GetQueryLoggingConfigCommand.ts b/clients/client-route-53/commands/GetQueryLoggingConfigCommand.ts index 8dcc7b527c8c..57a97c84b9b5 100644 --- a/clients/client-route-53/commands/GetQueryLoggingConfigCommand.ts +++ b/clients/client-route-53/commands/GetQueryLoggingConfigCommand.ts @@ -28,6 +28,20 @@ export interface GetQueryLoggingConfigCommandOutput extends GetQueryLoggingConfi * CreateQueryLoggingConfig * and * Logging DNS Queries.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { Route53Client, GetQueryLoggingConfigCommand } from "@aws-sdk/client-route-53"; // ES Modules import + * // const { Route53Client, GetQueryLoggingConfigCommand } = require("@aws-sdk/client-route-53"); // CommonJS import + * const client = new Route53Client(config); + * const command = new GetQueryLoggingConfigCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetQueryLoggingConfigCommandInput} for command's `input` shape. + * @see {@link GetQueryLoggingConfigCommandOutput} for command's `response` shape. + * @see {@link Route53ClientResolvedConfig | config} for command's `input` shape. + * */ export class GetQueryLoggingConfigCommand extends $Command< GetQueryLoggingConfigCommandInput, diff --git a/clients/client-route-53/commands/GetReusableDelegationSetCommand.ts b/clients/client-route-53/commands/GetReusableDelegationSetCommand.ts index 0beaabbb12f5..c54f379dff99 100644 --- a/clients/client-route-53/commands/GetReusableDelegationSetCommand.ts +++ b/clients/client-route-53/commands/GetReusableDelegationSetCommand.ts @@ -24,6 +24,20 @@ export interface GetReusableDelegationSetCommandOutput extends GetReusableDelega /** *

Retrieves information about a specified reusable delegation set, including the four name servers that are assigned * to the delegation set.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { Route53Client, GetReusableDelegationSetCommand } from "@aws-sdk/client-route-53"; // ES Modules import + * // const { Route53Client, GetReusableDelegationSetCommand } = require("@aws-sdk/client-route-53"); // CommonJS import + * const client = new Route53Client(config); + * const command = new GetReusableDelegationSetCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetReusableDelegationSetCommandInput} for command's `input` shape. + * @see {@link GetReusableDelegationSetCommandOutput} for command's `response` shape. + * @see {@link Route53ClientResolvedConfig | config} for command's `input` shape. + * */ export class GetReusableDelegationSetCommand extends $Command< GetReusableDelegationSetCommandInput, diff --git a/clients/client-route-53/commands/GetReusableDelegationSetLimitCommand.ts b/clients/client-route-53/commands/GetReusableDelegationSetLimitCommand.ts index a64e7876d186..9a74641e02b2 100644 --- a/clients/client-route-53/commands/GetReusableDelegationSetLimitCommand.ts +++ b/clients/client-route-53/commands/GetReusableDelegationSetLimitCommand.ts @@ -28,6 +28,20 @@ export interface GetReusableDelegationSetLimitCommandOutput *

For the default limit, see Limits * in the Amazon Route 53 Developer Guide. To request a higher limit, * open a case.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { Route53Client, GetReusableDelegationSetLimitCommand } from "@aws-sdk/client-route-53"; // ES Modules import + * // const { Route53Client, GetReusableDelegationSetLimitCommand } = require("@aws-sdk/client-route-53"); // CommonJS import + * const client = new Route53Client(config); + * const command = new GetReusableDelegationSetLimitCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetReusableDelegationSetLimitCommandInput} for command's `input` shape. + * @see {@link GetReusableDelegationSetLimitCommandOutput} for command's `response` shape. + * @see {@link Route53ClientResolvedConfig | config} for command's `input` shape. + * */ export class GetReusableDelegationSetLimitCommand extends $Command< GetReusableDelegationSetLimitCommandInput, diff --git a/clients/client-route-53/commands/GetTrafficPolicyCommand.ts b/clients/client-route-53/commands/GetTrafficPolicyCommand.ts index 7cd14f6857f9..5705441fe7b5 100644 --- a/clients/client-route-53/commands/GetTrafficPolicyCommand.ts +++ b/clients/client-route-53/commands/GetTrafficPolicyCommand.ts @@ -26,6 +26,20 @@ export interface GetTrafficPolicyCommandOutput extends GetTrafficPolicyResponse, *

For information about how of deleting a traffic policy affects the response from GetTrafficPolicy, see * DeleteTrafficPolicy. *

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { Route53Client, GetTrafficPolicyCommand } from "@aws-sdk/client-route-53"; // ES Modules import + * // const { Route53Client, GetTrafficPolicyCommand } = require("@aws-sdk/client-route-53"); // CommonJS import + * const client = new Route53Client(config); + * const command = new GetTrafficPolicyCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetTrafficPolicyCommandInput} for command's `input` shape. + * @see {@link GetTrafficPolicyCommandOutput} for command's `response` shape. + * @see {@link Route53ClientResolvedConfig | config} for command's `input` shape. + * */ export class GetTrafficPolicyCommand extends $Command< GetTrafficPolicyCommandInput, diff --git a/clients/client-route-53/commands/GetTrafficPolicyInstanceCommand.ts b/clients/client-route-53/commands/GetTrafficPolicyInstanceCommand.ts index 6d98d2478b67..a3923a3d39b8 100644 --- a/clients/client-route-53/commands/GetTrafficPolicyInstanceCommand.ts +++ b/clients/client-route-53/commands/GetTrafficPolicyInstanceCommand.ts @@ -31,6 +31,20 @@ export interface GetTrafficPolicyInstanceCommandOutput extends GetTrafficPolicyI * *

In the Route 53 console, traffic policy instances are known as policy records.

* + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { Route53Client, GetTrafficPolicyInstanceCommand } from "@aws-sdk/client-route-53"; // ES Modules import + * // const { Route53Client, GetTrafficPolicyInstanceCommand } = require("@aws-sdk/client-route-53"); // CommonJS import + * const client = new Route53Client(config); + * const command = new GetTrafficPolicyInstanceCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetTrafficPolicyInstanceCommandInput} for command's `input` shape. + * @see {@link GetTrafficPolicyInstanceCommandOutput} for command's `response` shape. + * @see {@link Route53ClientResolvedConfig | config} for command's `input` shape. + * */ export class GetTrafficPolicyInstanceCommand extends $Command< GetTrafficPolicyInstanceCommandInput, diff --git a/clients/client-route-53/commands/GetTrafficPolicyInstanceCountCommand.ts b/clients/client-route-53/commands/GetTrafficPolicyInstanceCountCommand.ts index 84c4247ec7a6..8018df78295f 100644 --- a/clients/client-route-53/commands/GetTrafficPolicyInstanceCountCommand.ts +++ b/clients/client-route-53/commands/GetTrafficPolicyInstanceCountCommand.ts @@ -24,6 +24,20 @@ export interface GetTrafficPolicyInstanceCountCommandOutput /** *

Gets the number of traffic policy instances that are associated with the current AWS account.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { Route53Client, GetTrafficPolicyInstanceCountCommand } from "@aws-sdk/client-route-53"; // ES Modules import + * // const { Route53Client, GetTrafficPolicyInstanceCountCommand } = require("@aws-sdk/client-route-53"); // CommonJS import + * const client = new Route53Client(config); + * const command = new GetTrafficPolicyInstanceCountCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetTrafficPolicyInstanceCountCommandInput} for command's `input` shape. + * @see {@link GetTrafficPolicyInstanceCountCommandOutput} for command's `response` shape. + * @see {@link Route53ClientResolvedConfig | config} for command's `input` shape. + * */ export class GetTrafficPolicyInstanceCountCommand extends $Command< GetTrafficPolicyInstanceCountCommandInput, diff --git a/clients/client-route-53/commands/ListGeoLocationsCommand.ts b/clients/client-route-53/commands/ListGeoLocationsCommand.ts index 92a69507653e..9ae1bb14f4ad 100644 --- a/clients/client-route-53/commands/ListGeoLocationsCommand.ts +++ b/clients/client-route-53/commands/ListGeoLocationsCommand.ts @@ -27,6 +27,20 @@ export interface ListGeoLocationsCommandOutput extends ListGeoLocationsResponse, *

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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { Route53Client, ListGeoLocationsCommand } from "@aws-sdk/client-route-53"; // ES Modules import + * // const { Route53Client, ListGeoLocationsCommand } = require("@aws-sdk/client-route-53"); // CommonJS import + * const client = new Route53Client(config); + * const command = new ListGeoLocationsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListGeoLocationsCommandInput} for command's `input` shape. + * @see {@link ListGeoLocationsCommandOutput} for command's `response` shape. + * @see {@link Route53ClientResolvedConfig | config} for command's `input` shape. + * */ export class ListGeoLocationsCommand extends $Command< ListGeoLocationsCommandInput, diff --git a/clients/client-route-53/commands/ListHealthChecksCommand.ts b/clients/client-route-53/commands/ListHealthChecksCommand.ts index 077f0fbe5137..95e346045fb5 100644 --- a/clients/client-route-53/commands/ListHealthChecksCommand.ts +++ b/clients/client-route-53/commands/ListHealthChecksCommand.ts @@ -22,6 +22,20 @@ export interface ListHealthChecksCommandOutput extends ListHealthChecksResponse, /** *

Retrieve a list of the health checks that are associated with the current AWS account.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { Route53Client, ListHealthChecksCommand } from "@aws-sdk/client-route-53"; // ES Modules import + * // const { Route53Client, ListHealthChecksCommand } = require("@aws-sdk/client-route-53"); // CommonJS import + * const client = new Route53Client(config); + * const command = new ListHealthChecksCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListHealthChecksCommandInput} for command's `input` shape. + * @see {@link ListHealthChecksCommandOutput} for command's `response` shape. + * @see {@link Route53ClientResolvedConfig | config} for command's `input` shape. + * */ export class ListHealthChecksCommand extends $Command< ListHealthChecksCommandInput, diff --git a/clients/client-route-53/commands/ListHostedZonesByNameCommand.ts b/clients/client-route-53/commands/ListHostedZonesByNameCommand.ts index a720d439e546..194ceca8cca0 100644 --- a/clients/client-route-53/commands/ListHostedZonesByNameCommand.ts +++ b/clients/client-route-53/commands/ListHostedZonesByNameCommand.ts @@ -67,6 +67,20 @@ export interface ListHostedZonesByNameCommandOutput extends ListHostedZonesByNam * NextHostedZoneId in the dnsname and hostedzoneid parameters, respectively.

* * + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { Route53Client, ListHostedZonesByNameCommand } from "@aws-sdk/client-route-53"; // ES Modules import + * // const { Route53Client, ListHostedZonesByNameCommand } = require("@aws-sdk/client-route-53"); // CommonJS import + * const client = new Route53Client(config); + * const command = new ListHostedZonesByNameCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListHostedZonesByNameCommandInput} for command's `input` shape. + * @see {@link ListHostedZonesByNameCommandOutput} for command's `response` shape. + * @see {@link Route53ClientResolvedConfig | config} for command's `input` shape. + * */ export class ListHostedZonesByNameCommand extends $Command< ListHostedZonesByNameCommandInput, diff --git a/clients/client-route-53/commands/ListHostedZonesByVPCCommand.ts b/clients/client-route-53/commands/ListHostedZonesByVPCCommand.ts index f48a3cbfd12c..7df20ee0f64c 100644 --- a/clients/client-route-53/commands/ListHostedZonesByVPCCommand.ts +++ b/clients/client-route-53/commands/ListHostedZonesByVPCCommand.ts @@ -34,6 +34,20 @@ export interface ListHostedZonesByVPCCommandOutput extends ListHostedZonesByVPCR * efs.amazonaws.com.

* * + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { Route53Client, ListHostedZonesByVPCCommand } from "@aws-sdk/client-route-53"; // ES Modules import + * // const { Route53Client, ListHostedZonesByVPCCommand } = require("@aws-sdk/client-route-53"); // CommonJS import + * const client = new Route53Client(config); + * const command = new ListHostedZonesByVPCCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListHostedZonesByVPCCommandInput} for command's `input` shape. + * @see {@link ListHostedZonesByVPCCommandOutput} for command's `response` shape. + * @see {@link Route53ClientResolvedConfig | config} for command's `input` shape. + * */ export class ListHostedZonesByVPCCommand extends $Command< ListHostedZonesByVPCCommandInput, diff --git a/clients/client-route-53/commands/ListHostedZonesCommand.ts b/clients/client-route-53/commands/ListHostedZonesCommand.ts index 77f6d39ae24b..9953e57f9ab5 100644 --- a/clients/client-route-53/commands/ListHostedZonesCommand.ts +++ b/clients/client-route-53/commands/ListHostedZonesCommand.ts @@ -26,6 +26,20 @@ export interface ListHostedZonesCommandOutput extends ListHostedZonesResponse, _ * 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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { Route53Client, ListHostedZonesCommand } from "@aws-sdk/client-route-53"; // ES Modules import + * // const { Route53Client, ListHostedZonesCommand } = require("@aws-sdk/client-route-53"); // CommonJS import + * const client = new Route53Client(config); + * const command = new ListHostedZonesCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListHostedZonesCommandInput} for command's `input` shape. + * @see {@link ListHostedZonesCommandOutput} for command's `response` shape. + * @see {@link Route53ClientResolvedConfig | config} for command's `input` shape. + * */ export class ListHostedZonesCommand extends $Command< ListHostedZonesCommandInput, diff --git a/clients/client-route-53/commands/ListQueryLoggingConfigsCommand.ts b/clients/client-route-53/commands/ListQueryLoggingConfigsCommand.ts index b882ec34108e..13793ed1432b 100644 --- a/clients/client-route-53/commands/ListQueryLoggingConfigsCommand.ts +++ b/clients/client-route-53/commands/ListQueryLoggingConfigsCommand.ts @@ -30,6 +30,20 @@ export interface ListQueryLoggingConfigsCommandOutput extends ListQueryLoggingCo * Additional information, including the format of DNS query logs, appears in * Logging DNS Queries * in the Amazon Route 53 Developer Guide.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { Route53Client, ListQueryLoggingConfigsCommand } from "@aws-sdk/client-route-53"; // ES Modules import + * // const { Route53Client, ListQueryLoggingConfigsCommand } = require("@aws-sdk/client-route-53"); // CommonJS import + * const client = new Route53Client(config); + * const command = new ListQueryLoggingConfigsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListQueryLoggingConfigsCommandInput} for command's `input` shape. + * @see {@link ListQueryLoggingConfigsCommandOutput} for command's `response` shape. + * @see {@link Route53ClientResolvedConfig | config} for command's `input` shape. + * */ export class ListQueryLoggingConfigsCommand extends $Command< ListQueryLoggingConfigsCommandInput, diff --git a/clients/client-route-53/commands/ListResourceRecordSetsCommand.ts b/clients/client-route-53/commands/ListResourceRecordSetsCommand.ts index cee41443b4f8..24809f2877ff 100644 --- a/clients/client-route-53/commands/ListResourceRecordSetsCommand.ts +++ b/clients/client-route-53/commands/ListResourceRecordSetsCommand.ts @@ -86,6 +86,20 @@ export interface ListResourceRecordSetsCommandOutput extends ListResourceRecordS * 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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { Route53Client, ListResourceRecordSetsCommand } from "@aws-sdk/client-route-53"; // ES Modules import + * // const { Route53Client, ListResourceRecordSetsCommand } = require("@aws-sdk/client-route-53"); // CommonJS import + * const client = new Route53Client(config); + * const command = new ListResourceRecordSetsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListResourceRecordSetsCommandInput} for command's `input` shape. + * @see {@link ListResourceRecordSetsCommandOutput} for command's `response` shape. + * @see {@link Route53ClientResolvedConfig | config} for command's `input` shape. + * */ export class ListResourceRecordSetsCommand extends $Command< ListResourceRecordSetsCommandInput, diff --git a/clients/client-route-53/commands/ListReusableDelegationSetsCommand.ts b/clients/client-route-53/commands/ListReusableDelegationSetsCommand.ts index c3c4b7ebd022..7afffcee3829 100644 --- a/clients/client-route-53/commands/ListReusableDelegationSetsCommand.ts +++ b/clients/client-route-53/commands/ListReusableDelegationSetsCommand.ts @@ -22,6 +22,20 @@ export interface ListReusableDelegationSetsCommandOutput extends ListReusableDel /** *

Retrieves a list of the reusable delegation sets that are associated with the current AWS account.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { Route53Client, ListReusableDelegationSetsCommand } from "@aws-sdk/client-route-53"; // ES Modules import + * // const { Route53Client, ListReusableDelegationSetsCommand } = require("@aws-sdk/client-route-53"); // CommonJS import + * const client = new Route53Client(config); + * const command = new ListReusableDelegationSetsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListReusableDelegationSetsCommandInput} for command's `input` shape. + * @see {@link ListReusableDelegationSetsCommandOutput} for command's `response` shape. + * @see {@link Route53ClientResolvedConfig | config} for command's `input` shape. + * */ export class ListReusableDelegationSetsCommand extends $Command< ListReusableDelegationSetsCommandInput, diff --git a/clients/client-route-53/commands/ListTagsForResourceCommand.ts b/clients/client-route-53/commands/ListTagsForResourceCommand.ts index a07b79e9e726..d4420f9592a9 100644 --- a/clients/client-route-53/commands/ListTagsForResourceCommand.ts +++ b/clients/client-route-53/commands/ListTagsForResourceCommand.ts @@ -25,6 +25,20 @@ export interface ListTagsForResourceCommandOutput extends ListTagsForResourceRes *

For information about using tags for cost allocation, see * Using Cost Allocation Tags * in the AWS Billing and Cost Management User Guide.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { Route53Client, ListTagsForResourceCommand } from "@aws-sdk/client-route-53"; // ES Modules import + * // const { Route53Client, ListTagsForResourceCommand } = require("@aws-sdk/client-route-53"); // CommonJS import + * const client = new Route53Client(config); + * const command = new ListTagsForResourceCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListTagsForResourceCommandInput} for command's `input` shape. + * @see {@link ListTagsForResourceCommandOutput} for command's `response` shape. + * @see {@link Route53ClientResolvedConfig | config} for command's `input` shape. + * */ export class ListTagsForResourceCommand extends $Command< ListTagsForResourceCommandInput, diff --git a/clients/client-route-53/commands/ListTagsForResourcesCommand.ts b/clients/client-route-53/commands/ListTagsForResourcesCommand.ts index 0ae45cef5d93..3df88da5d50d 100644 --- a/clients/client-route-53/commands/ListTagsForResourcesCommand.ts +++ b/clients/client-route-53/commands/ListTagsForResourcesCommand.ts @@ -25,6 +25,20 @@ export interface ListTagsForResourcesCommandOutput extends ListTagsForResourcesR *

For information about using tags for cost allocation, see * Using Cost Allocation Tags * in the AWS Billing and Cost Management User Guide.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { Route53Client, ListTagsForResourcesCommand } from "@aws-sdk/client-route-53"; // ES Modules import + * // const { Route53Client, ListTagsForResourcesCommand } = require("@aws-sdk/client-route-53"); // CommonJS import + * const client = new Route53Client(config); + * const command = new ListTagsForResourcesCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListTagsForResourcesCommandInput} for command's `input` shape. + * @see {@link ListTagsForResourcesCommandOutput} for command's `response` shape. + * @see {@link Route53ClientResolvedConfig | config} for command's `input` shape. + * */ export class ListTagsForResourcesCommand extends $Command< ListTagsForResourcesCommandInput, diff --git a/clients/client-route-53/commands/ListTrafficPoliciesCommand.ts b/clients/client-route-53/commands/ListTrafficPoliciesCommand.ts index d4ac3aab0442..4872a1449c5c 100644 --- a/clients/client-route-53/commands/ListTrafficPoliciesCommand.ts +++ b/clients/client-route-53/commands/ListTrafficPoliciesCommand.ts @@ -28,6 +28,20 @@ export interface ListTrafficPoliciesCommandOutput extends ListTrafficPoliciesRes * DeleteTrafficPolicy. * *

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { Route53Client, ListTrafficPoliciesCommand } from "@aws-sdk/client-route-53"; // ES Modules import + * // const { Route53Client, ListTrafficPoliciesCommand } = require("@aws-sdk/client-route-53"); // CommonJS import + * const client = new Route53Client(config); + * const command = new ListTrafficPoliciesCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListTrafficPoliciesCommandInput} for command's `input` shape. + * @see {@link ListTrafficPoliciesCommandOutput} for command's `response` shape. + * @see {@link Route53ClientResolvedConfig | config} for command's `input` shape. + * */ export class ListTrafficPoliciesCommand extends $Command< ListTrafficPoliciesCommandInput, diff --git a/clients/client-route-53/commands/ListTrafficPolicyInstancesByHostedZoneCommand.ts b/clients/client-route-53/commands/ListTrafficPolicyInstancesByHostedZoneCommand.ts index f8cd9b63cf63..82446949aa1b 100644 --- a/clients/client-route-53/commands/ListTrafficPolicyInstancesByHostedZoneCommand.ts +++ b/clients/client-route-53/commands/ListTrafficPolicyInstancesByHostedZoneCommand.ts @@ -36,6 +36,20 @@ export interface ListTrafficPolicyInstancesByHostedZoneCommandOutput * *

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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { Route53Client, ListTrafficPolicyInstancesByHostedZoneCommand } from "@aws-sdk/client-route-53"; // ES Modules import + * // const { Route53Client, ListTrafficPolicyInstancesByHostedZoneCommand } = require("@aws-sdk/client-route-53"); // CommonJS import + * const client = new Route53Client(config); + * const command = new ListTrafficPolicyInstancesByHostedZoneCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListTrafficPolicyInstancesByHostedZoneCommandInput} for command's `input` shape. + * @see {@link ListTrafficPolicyInstancesByHostedZoneCommandOutput} for command's `response` shape. + * @see {@link Route53ClientResolvedConfig | config} for command's `input` shape. + * */ export class ListTrafficPolicyInstancesByHostedZoneCommand extends $Command< ListTrafficPolicyInstancesByHostedZoneCommandInput, diff --git a/clients/client-route-53/commands/ListTrafficPolicyInstancesByPolicyCommand.ts b/clients/client-route-53/commands/ListTrafficPolicyInstancesByPolicyCommand.ts index fbd7f6a03ffb..37279ab548d0 100644 --- a/clients/client-route-53/commands/ListTrafficPolicyInstancesByPolicyCommand.ts +++ b/clients/client-route-53/commands/ListTrafficPolicyInstancesByPolicyCommand.ts @@ -34,6 +34,20 @@ export interface ListTrafficPolicyInstancesByPolicyCommandOutput * *

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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { Route53Client, ListTrafficPolicyInstancesByPolicyCommand } from "@aws-sdk/client-route-53"; // ES Modules import + * // const { Route53Client, ListTrafficPolicyInstancesByPolicyCommand } = require("@aws-sdk/client-route-53"); // CommonJS import + * const client = new Route53Client(config); + * const command = new ListTrafficPolicyInstancesByPolicyCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListTrafficPolicyInstancesByPolicyCommandInput} for command's `input` shape. + * @see {@link ListTrafficPolicyInstancesByPolicyCommandOutput} for command's `response` shape. + * @see {@link Route53ClientResolvedConfig | config} for command's `input` shape. + * */ export class ListTrafficPolicyInstancesByPolicyCommand extends $Command< ListTrafficPolicyInstancesByPolicyCommandInput, diff --git a/clients/client-route-53/commands/ListTrafficPolicyInstancesCommand.ts b/clients/client-route-53/commands/ListTrafficPolicyInstancesCommand.ts index 7e26b0b45b46..53a522ff7205 100644 --- a/clients/client-route-53/commands/ListTrafficPolicyInstancesCommand.ts +++ b/clients/client-route-53/commands/ListTrafficPolicyInstancesCommand.ts @@ -28,6 +28,20 @@ export interface ListTrafficPolicyInstancesCommandOutput extends ListTrafficPoli * *

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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { Route53Client, ListTrafficPolicyInstancesCommand } from "@aws-sdk/client-route-53"; // ES Modules import + * // const { Route53Client, ListTrafficPolicyInstancesCommand } = require("@aws-sdk/client-route-53"); // CommonJS import + * const client = new Route53Client(config); + * const command = new ListTrafficPolicyInstancesCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListTrafficPolicyInstancesCommandInput} for command's `input` shape. + * @see {@link ListTrafficPolicyInstancesCommandOutput} for command's `response` shape. + * @see {@link Route53ClientResolvedConfig | config} for command's `input` shape. + * */ export class ListTrafficPolicyInstancesCommand extends $Command< ListTrafficPolicyInstancesCommandInput, diff --git a/clients/client-route-53/commands/ListTrafficPolicyVersionsCommand.ts b/clients/client-route-53/commands/ListTrafficPolicyVersionsCommand.ts index 601ffe373aaf..db46b694f8b7 100644 --- a/clients/client-route-53/commands/ListTrafficPolicyVersionsCommand.ts +++ b/clients/client-route-53/commands/ListTrafficPolicyVersionsCommand.ts @@ -24,6 +24,20 @@ export interface ListTrafficPolicyVersionsCommandOutput extends ListTrafficPolic /** *

Gets information about all of the versions for a specified traffic policy.

*

Traffic policy versions are listed in numerical order by VersionNumber.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { Route53Client, ListTrafficPolicyVersionsCommand } from "@aws-sdk/client-route-53"; // ES Modules import + * // const { Route53Client, ListTrafficPolicyVersionsCommand } = require("@aws-sdk/client-route-53"); // CommonJS import + * const client = new Route53Client(config); + * const command = new ListTrafficPolicyVersionsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListTrafficPolicyVersionsCommandInput} for command's `input` shape. + * @see {@link ListTrafficPolicyVersionsCommandOutput} for command's `response` shape. + * @see {@link Route53ClientResolvedConfig | config} for command's `input` shape. + * */ export class ListTrafficPolicyVersionsCommand extends $Command< ListTrafficPolicyVersionsCommandInput, diff --git a/clients/client-route-53/commands/ListVPCAssociationAuthorizationsCommand.ts b/clients/client-route-53/commands/ListVPCAssociationAuthorizationsCommand.ts index e6188e2c1bfe..8355eb6b53a7 100644 --- a/clients/client-route-53/commands/ListVPCAssociationAuthorizationsCommand.ts +++ b/clients/client-route-53/commands/ListVPCAssociationAuthorizationsCommand.ts @@ -28,6 +28,20 @@ export interface ListVPCAssociationAuthorizationsCommandOutput * 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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { Route53Client, ListVPCAssociationAuthorizationsCommand } from "@aws-sdk/client-route-53"; // ES Modules import + * // const { Route53Client, ListVPCAssociationAuthorizationsCommand } = require("@aws-sdk/client-route-53"); // CommonJS import + * const client = new Route53Client(config); + * const command = new ListVPCAssociationAuthorizationsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListVPCAssociationAuthorizationsCommandInput} for command's `input` shape. + * @see {@link ListVPCAssociationAuthorizationsCommandOutput} for command's `response` shape. + * @see {@link Route53ClientResolvedConfig | config} for command's `input` shape. + * */ export class ListVPCAssociationAuthorizationsCommand extends $Command< ListVPCAssociationAuthorizationsCommandInput, diff --git a/clients/client-route-53/commands/TestDNSAnswerCommand.ts b/clients/client-route-53/commands/TestDNSAnswerCommand.ts index 819b2189e84d..dd58742535af 100644 --- a/clients/client-route-53/commands/TestDNSAnswerCommand.ts +++ b/clients/client-route-53/commands/TestDNSAnswerCommand.ts @@ -25,6 +25,20 @@ export interface TestDNSAnswerCommandOutput extends TestDNSAnswerResponse, __Met *

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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { Route53Client, TestDNSAnswerCommand } from "@aws-sdk/client-route-53"; // ES Modules import + * // const { Route53Client, TestDNSAnswerCommand } = require("@aws-sdk/client-route-53"); // CommonJS import + * const client = new Route53Client(config); + * const command = new TestDNSAnswerCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link TestDNSAnswerCommandInput} for command's `input` shape. + * @see {@link TestDNSAnswerCommandOutput} for command's `response` shape. + * @see {@link Route53ClientResolvedConfig | config} for command's `input` shape. + * */ export class TestDNSAnswerCommand extends $Command< TestDNSAnswerCommandInput, diff --git a/clients/client-route-53/commands/UpdateHealthCheckCommand.ts b/clients/client-route-53/commands/UpdateHealthCheckCommand.ts index 7184f5669036..b115d29d70fb 100644 --- a/clients/client-route-53/commands/UpdateHealthCheckCommand.ts +++ b/clients/client-route-53/commands/UpdateHealthCheckCommand.ts @@ -25,6 +25,20 @@ export interface UpdateHealthCheckCommandOutput extends UpdateHealthCheckRespons *

For more information about updating health checks, see * Creating, Updating, and Deleting Health Checks * in the Amazon Route 53 Developer Guide.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { Route53Client, UpdateHealthCheckCommand } from "@aws-sdk/client-route-53"; // ES Modules import + * // const { Route53Client, UpdateHealthCheckCommand } = require("@aws-sdk/client-route-53"); // CommonJS import + * const client = new Route53Client(config); + * const command = new UpdateHealthCheckCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link UpdateHealthCheckCommandInput} for command's `input` shape. + * @see {@link UpdateHealthCheckCommandOutput} for command's `response` shape. + * @see {@link Route53ClientResolvedConfig | config} for command's `input` shape. + * */ export class UpdateHealthCheckCommand extends $Command< UpdateHealthCheckCommandInput, diff --git a/clients/client-route-53/commands/UpdateHostedZoneCommentCommand.ts b/clients/client-route-53/commands/UpdateHostedZoneCommentCommand.ts index 1ed7460e094d..d55ef0320174 100644 --- a/clients/client-route-53/commands/UpdateHostedZoneCommentCommand.ts +++ b/clients/client-route-53/commands/UpdateHostedZoneCommentCommand.ts @@ -23,6 +23,20 @@ export interface UpdateHostedZoneCommentCommandOutput extends UpdateHostedZoneCo /** *

Updates the comment for a specified hosted zone.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { Route53Client, UpdateHostedZoneCommentCommand } from "@aws-sdk/client-route-53"; // ES Modules import + * // const { Route53Client, UpdateHostedZoneCommentCommand } = require("@aws-sdk/client-route-53"); // CommonJS import + * const client = new Route53Client(config); + * const command = new UpdateHostedZoneCommentCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link UpdateHostedZoneCommentCommandInput} for command's `input` shape. + * @see {@link UpdateHostedZoneCommentCommandOutput} for command's `response` shape. + * @see {@link Route53ClientResolvedConfig | config} for command's `input` shape. + * */ export class UpdateHostedZoneCommentCommand extends $Command< UpdateHostedZoneCommentCommandInput, diff --git a/clients/client-route-53/commands/UpdateTrafficPolicyCommentCommand.ts b/clients/client-route-53/commands/UpdateTrafficPolicyCommentCommand.ts index c3a2e14e9075..62a8872b712a 100644 --- a/clients/client-route-53/commands/UpdateTrafficPolicyCommentCommand.ts +++ b/clients/client-route-53/commands/UpdateTrafficPolicyCommentCommand.ts @@ -23,6 +23,20 @@ export interface UpdateTrafficPolicyCommentCommandOutput extends UpdateTrafficPo /** *

Updates the comment for a specified traffic policy version.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { Route53Client, UpdateTrafficPolicyCommentCommand } from "@aws-sdk/client-route-53"; // ES Modules import + * // const { Route53Client, UpdateTrafficPolicyCommentCommand } = require("@aws-sdk/client-route-53"); // CommonJS import + * const client = new Route53Client(config); + * const command = new UpdateTrafficPolicyCommentCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link UpdateTrafficPolicyCommentCommandInput} for command's `input` shape. + * @see {@link UpdateTrafficPolicyCommentCommandOutput} for command's `response` shape. + * @see {@link Route53ClientResolvedConfig | config} for command's `input` shape. + * */ export class UpdateTrafficPolicyCommentCommand extends $Command< UpdateTrafficPolicyCommentCommandInput, diff --git a/clients/client-route-53/commands/UpdateTrafficPolicyInstanceCommand.ts b/clients/client-route-53/commands/UpdateTrafficPolicyInstanceCommand.ts index 3ae27110cf31..cd8a8e5185ef 100644 --- a/clients/client-route-53/commands/UpdateTrafficPolicyInstanceCommand.ts +++ b/clients/client-route-53/commands/UpdateTrafficPolicyInstanceCommand.ts @@ -40,6 +40,20 @@ export interface UpdateTrafficPolicyInstanceCommandOutput *

Route 53 deletes the old group of resource record sets that are associated with the root resource record set name.

* * + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { Route53Client, UpdateTrafficPolicyInstanceCommand } from "@aws-sdk/client-route-53"; // ES Modules import + * // const { Route53Client, UpdateTrafficPolicyInstanceCommand } = require("@aws-sdk/client-route-53"); // CommonJS import + * const client = new Route53Client(config); + * const command = new UpdateTrafficPolicyInstanceCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link UpdateTrafficPolicyInstanceCommandInput} for command's `input` shape. + * @see {@link UpdateTrafficPolicyInstanceCommandOutput} for command's `response` shape. + * @see {@link Route53ClientResolvedConfig | config} for command's `input` shape. + * */ export class UpdateTrafficPolicyInstanceCommand extends $Command< UpdateTrafficPolicyInstanceCommandInput, diff --git a/clients/client-route-53/models/models_0.ts b/clients/client-route-53/models/models_0.ts index d8645d123296..5f4a7b47c450 100644 --- a/clients/client-route-53/models/models_0.ts +++ b/clients/client-route-53/models/models_0.ts @@ -53,6 +53,9 @@ export interface AccountLimit { } export namespace AccountLimit { + /** + * @internal + */ export const filterSensitiveLog = (obj: AccountLimit): any => ({ ...obj, }); @@ -72,6 +75,9 @@ export interface ActivateKeySigningKeyRequest { } export namespace ActivateKeySigningKeyRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ActivateKeySigningKeyRequest): any => ({ ...obj, }); @@ -113,6 +119,9 @@ export interface ChangeInfo { } export namespace ChangeInfo { + /** + * @internal + */ export const filterSensitiveLog = (obj: ChangeInfo): any => ({ ...obj, }); @@ -127,6 +136,9 @@ export interface ActivateKeySigningKeyResponse { } export namespace ActivateKeySigningKeyResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ActivateKeySigningKeyResponse): any => ({ ...obj, }); @@ -145,6 +157,9 @@ export interface ConcurrentModification extends __SmithyException, $MetadataBear } export namespace ConcurrentModification { + /** + * @internal + */ export const filterSensitiveLog = (obj: ConcurrentModification): any => ({ ...obj, }); @@ -160,6 +175,9 @@ export interface InvalidKeySigningKeyStatus extends __SmithyException, $Metadata } export namespace InvalidKeySigningKeyStatus { + /** + * @internal + */ export const filterSensitiveLog = (obj: InvalidKeySigningKeyStatus): any => ({ ...obj, }); @@ -175,6 +193,9 @@ export interface InvalidKMSArn extends __SmithyException, $MetadataBearer { } export namespace InvalidKMSArn { + /** + * @internal + */ export const filterSensitiveLog = (obj: InvalidKMSArn): any => ({ ...obj, }); @@ -191,6 +212,9 @@ export interface InvalidSigningStatus extends __SmithyException, $MetadataBearer } export namespace InvalidSigningStatus { + /** + * @internal + */ export const filterSensitiveLog = (obj: InvalidSigningStatus): any => ({ ...obj, }); @@ -206,6 +230,9 @@ export interface NoSuchKeySigningKey extends __SmithyException, $MetadataBearer } export namespace NoSuchKeySigningKey { + /** + * @internal + */ export const filterSensitiveLog = (obj: NoSuchKeySigningKey): any => ({ ...obj, }); @@ -273,6 +300,9 @@ export interface AlarmIdentifier { } export namespace AlarmIdentifier { + /** + * @internal + */ export const filterSensitiveLog = (obj: AlarmIdentifier): any => ({ ...obj, }); @@ -652,6 +682,9 @@ export interface AliasTarget { } export namespace AliasTarget { + /** + * @internal + */ export const filterSensitiveLog = (obj: AliasTarget): any => ({ ...obj, }); @@ -701,6 +734,9 @@ export interface VPC { } export namespace VPC { + /** + * @internal + */ export const filterSensitiveLog = (obj: VPC): any => ({ ...obj, }); @@ -729,6 +765,9 @@ export interface AssociateVPCWithHostedZoneRequest { } export namespace AssociateVPCWithHostedZoneRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: AssociateVPCWithHostedZoneRequest): any => ({ ...obj, }); @@ -745,6 +784,9 @@ export interface AssociateVPCWithHostedZoneResponse { } export namespace AssociateVPCWithHostedZoneResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: AssociateVPCWithHostedZoneResponse): any => ({ ...obj, }); @@ -780,6 +822,9 @@ export interface ConflictingDomainExists extends __SmithyException, $MetadataBea } export namespace ConflictingDomainExists { + /** + * @internal + */ export const filterSensitiveLog = (obj: ConflictingDomainExists): any => ({ ...obj, }); @@ -798,6 +843,9 @@ export interface InvalidInput extends __SmithyException, $MetadataBearer { } export namespace InvalidInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: InvalidInput): any => ({ ...obj, }); @@ -816,6 +864,9 @@ export interface InvalidVPCId extends __SmithyException, $MetadataBearer { } export namespace InvalidVPCId { + /** + * @internal + */ export const filterSensitiveLog = (obj: InvalidVPCId): any => ({ ...obj, }); @@ -840,6 +891,9 @@ export interface LimitsExceeded extends __SmithyException, $MetadataBearer { } export namespace LimitsExceeded { + /** + * @internal + */ export const filterSensitiveLog = (obj: LimitsExceeded): any => ({ ...obj, }); @@ -858,6 +912,9 @@ export interface NoSuchHostedZone extends __SmithyException, $MetadataBearer { } export namespace NoSuchHostedZone { + /** + * @internal + */ export const filterSensitiveLog = (obj: NoSuchHostedZone): any => ({ ...obj, }); @@ -876,6 +933,9 @@ export interface NotAuthorizedException extends __SmithyException, $MetadataBear } export namespace NotAuthorizedException { + /** + * @internal + */ export const filterSensitiveLog = (obj: NotAuthorizedException): any => ({ ...obj, }); @@ -895,6 +955,9 @@ export interface PriorRequestNotComplete extends __SmithyException, $MetadataBea } export namespace PriorRequestNotComplete { + /** + * @internal + */ export const filterSensitiveLog = (obj: PriorRequestNotComplete): any => ({ ...obj, }); @@ -914,6 +977,9 @@ export interface PublicZoneVPCAssociation extends __SmithyException, $MetadataBe } export namespace PublicZoneVPCAssociation { + /** + * @internal + */ export const filterSensitiveLog = (obj: PublicZoneVPCAssociation): any => ({ ...obj, }); @@ -983,6 +1049,9 @@ export interface GeoLocation { } export namespace GeoLocation { + /** + * @internal + */ export const filterSensitiveLog = (obj: GeoLocation): any => ({ ...obj, }); @@ -1035,6 +1104,9 @@ export interface ResourceRecord { } export namespace ResourceRecord { + /** + * @internal + */ export const filterSensitiveLog = (obj: ResourceRecord): any => ({ ...obj, }); @@ -1556,6 +1628,9 @@ export interface ResourceRecordSet { } export namespace ResourceRecordSet { + /** + * @internal + */ export const filterSensitiveLog = (obj: ResourceRecordSet): any => ({ ...obj, }); @@ -1599,6 +1674,9 @@ export interface Change { } export namespace Change { + /** + * @internal + */ export const filterSensitiveLog = (obj: Change): any => ({ ...obj, }); @@ -1622,6 +1700,9 @@ export interface ChangeBatch { } export namespace ChangeBatch { + /** + * @internal + */ export const filterSensitiveLog = (obj: ChangeBatch): any => ({ ...obj, }); @@ -1643,6 +1724,9 @@ export interface ChangeResourceRecordSetsRequest { } export namespace ChangeResourceRecordSetsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ChangeResourceRecordSetsRequest): any => ({ ...obj, }); @@ -1662,6 +1746,9 @@ export interface ChangeResourceRecordSetsResponse { } export namespace ChangeResourceRecordSetsResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ChangeResourceRecordSetsResponse): any => ({ ...obj, }); @@ -1683,6 +1770,9 @@ export interface InvalidChangeBatch extends __SmithyException, $MetadataBearer { } export namespace InvalidChangeBatch { + /** + * @internal + */ export const filterSensitiveLog = (obj: InvalidChangeBatch): any => ({ ...obj, }); @@ -1701,6 +1791,9 @@ export interface NoSuchHealthCheck extends __SmithyException, $MetadataBearer { } export namespace NoSuchHealthCheck { + /** + * @internal + */ export const filterSensitiveLog = (obj: NoSuchHealthCheck): any => ({ ...obj, }); @@ -1753,6 +1846,9 @@ export interface Tag { } export namespace Tag { + /** + * @internal + */ export const filterSensitiveLog = (obj: Tag): any => ({ ...obj, }); @@ -1797,6 +1893,9 @@ export interface ChangeTagsForResourceRequest { } export namespace ChangeTagsForResourceRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ChangeTagsForResourceRequest): any => ({ ...obj, }); @@ -1808,6 +1907,9 @@ export namespace ChangeTagsForResourceRequest { export interface ChangeTagsForResourceResponse {} export namespace ChangeTagsForResourceResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ChangeTagsForResourceResponse): any => ({ ...obj, }); @@ -1823,6 +1925,9 @@ export interface ThrottlingException extends __SmithyException, $MetadataBearer } export namespace ThrottlingException { + /** + * @internal + */ export const filterSensitiveLog = (obj: ThrottlingException): any => ({ ...obj, }); @@ -2177,6 +2282,9 @@ export interface HealthCheckConfig { } export namespace HealthCheckConfig { + /** + * @internal + */ export const filterSensitiveLog = (obj: HealthCheckConfig): any => ({ ...obj, }); @@ -2218,6 +2326,9 @@ export interface CreateHealthCheckRequest { } export namespace CreateHealthCheckRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateHealthCheckRequest): any => ({ ...obj, }); @@ -2245,6 +2356,9 @@ export interface Dimension { } export namespace Dimension { + /** + * @internal + */ export const filterSensitiveLog = (obj: Dimension): any => ({ ...obj, }); @@ -2303,6 +2417,9 @@ export interface CloudWatchAlarmConfiguration { } export namespace CloudWatchAlarmConfiguration { + /** + * @internal + */ export const filterSensitiveLog = (obj: CloudWatchAlarmConfiguration): any => ({ ...obj, }); @@ -2327,6 +2444,9 @@ export interface LinkedService { } export namespace LinkedService { + /** + * @internal + */ export const filterSensitiveLog = (obj: LinkedService): any => ({ ...obj, }); @@ -2371,6 +2491,9 @@ export interface HealthCheck { } export namespace HealthCheck { + /** + * @internal + */ export const filterSensitiveLog = (obj: HealthCheck): any => ({ ...obj, }); @@ -2392,6 +2515,9 @@ export interface CreateHealthCheckResponse { } export namespace CreateHealthCheckResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateHealthCheckResponse): any => ({ ...obj, }); @@ -2421,6 +2547,9 @@ export interface HealthCheckAlreadyExists extends __SmithyException, $MetadataBe } export namespace HealthCheckAlreadyExists { + /** + * @internal + */ export const filterSensitiveLog = (obj: HealthCheckAlreadyExists): any => ({ ...obj, }); @@ -2444,6 +2573,9 @@ export interface TooManyHealthChecks extends __SmithyException, $MetadataBearer } export namespace TooManyHealthChecks { + /** + * @internal + */ export const filterSensitiveLog = (obj: TooManyHealthChecks): any => ({ ...obj, }); @@ -2467,6 +2599,9 @@ export interface HostedZoneConfig { } export namespace HostedZoneConfig { + /** + * @internal + */ export const filterSensitiveLog = (obj: HostedZoneConfig): any => ({ ...obj, }); @@ -2525,6 +2660,9 @@ export interface CreateHostedZoneRequest { } export namespace CreateHostedZoneRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateHostedZoneRequest): any => ({ ...obj, }); @@ -2552,6 +2690,9 @@ export interface DelegationSet { } export namespace DelegationSet { + /** + * @internal + */ export const filterSensitiveLog = (obj: DelegationSet): any => ({ ...obj, }); @@ -2602,6 +2743,9 @@ export interface HostedZone { } export namespace HostedZone { + /** + * @internal + */ export const filterSensitiveLog = (obj: HostedZone): any => ({ ...obj, }); @@ -2638,6 +2782,9 @@ export interface CreateHostedZoneResponse { } export namespace CreateHostedZoneResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateHostedZoneResponse): any => ({ ...obj, }); @@ -2658,6 +2805,9 @@ export interface DelegationSetNotAvailable extends __SmithyException, $MetadataB } export namespace DelegationSetNotAvailable { + /** + * @internal + */ export const filterSensitiveLog = (obj: DelegationSetNotAvailable): any => ({ ...obj, }); @@ -2676,6 +2826,9 @@ export interface DelegationSetNotReusable extends __SmithyException, $MetadataBe } export namespace DelegationSetNotReusable { + /** + * @internal + */ export const filterSensitiveLog = (obj: DelegationSetNotReusable): any => ({ ...obj, }); @@ -2695,6 +2848,9 @@ export interface HostedZoneAlreadyExists extends __SmithyException, $MetadataBea } export namespace HostedZoneAlreadyExists { + /** + * @internal + */ export const filterSensitiveLog = (obj: HostedZoneAlreadyExists): any => ({ ...obj, }); @@ -2713,6 +2869,9 @@ export interface InvalidDomainName extends __SmithyException, $MetadataBearer { } export namespace InvalidDomainName { + /** + * @internal + */ export const filterSensitiveLog = (obj: InvalidDomainName): any => ({ ...obj, }); @@ -2731,6 +2890,9 @@ export interface NoSuchDelegationSet extends __SmithyException, $MetadataBearer } export namespace NoSuchDelegationSet { + /** + * @internal + */ export const filterSensitiveLog = (obj: NoSuchDelegationSet): any => ({ ...obj, }); @@ -2757,6 +2919,9 @@ export interface TooManyHostedZones extends __SmithyException, $MetadataBearer { } export namespace TooManyHostedZones { + /** + * @internal + */ export const filterSensitiveLog = (obj: TooManyHostedZones): any => ({ ...obj, }); @@ -2835,6 +3000,9 @@ export interface CreateKeySigningKeyRequest { } export namespace CreateKeySigningKeyRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateKeySigningKeyRequest): any => ({ ...obj, }); @@ -3010,6 +3178,9 @@ export interface KeySigningKey { } export namespace KeySigningKey { + /** + * @internal + */ export const filterSensitiveLog = (obj: KeySigningKey): any => ({ ...obj, }); @@ -3034,6 +3205,9 @@ export interface CreateKeySigningKeyResponse { } export namespace CreateKeySigningKeyResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateKeySigningKeyResponse): any => ({ ...obj, }); @@ -3052,6 +3226,9 @@ export interface InvalidArgument extends __SmithyException, $MetadataBearer { } export namespace InvalidArgument { + /** + * @internal + */ export const filterSensitiveLog = (obj: InvalidArgument): any => ({ ...obj, }); @@ -3067,6 +3244,9 @@ export interface InvalidKeySigningKeyName extends __SmithyException, $MetadataBe } export namespace InvalidKeySigningKeyName { + /** + * @internal + */ export const filterSensitiveLog = (obj: InvalidKeySigningKeyName): any => ({ ...obj, }); @@ -3082,6 +3262,9 @@ export interface KeySigningKeyAlreadyExists extends __SmithyException, $Metadata } export namespace KeySigningKeyAlreadyExists { + /** + * @internal + */ export const filterSensitiveLog = (obj: KeySigningKeyAlreadyExists): any => ({ ...obj, }); @@ -3097,6 +3280,9 @@ export interface TooManyKeySigningKeys extends __SmithyException, $MetadataBeare } export namespace TooManyKeySigningKeys { + /** + * @internal + */ export const filterSensitiveLog = (obj: TooManyKeySigningKeys): any => ({ ...obj, }); @@ -3124,6 +3310,9 @@ export interface CreateQueryLoggingConfigRequest { } export namespace CreateQueryLoggingConfigRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateQueryLoggingConfigRequest): any => ({ ...obj, }); @@ -3150,6 +3339,9 @@ export interface QueryLoggingConfig { } export namespace QueryLoggingConfig { + /** + * @internal + */ export const filterSensitiveLog = (obj: QueryLoggingConfig): any => ({ ...obj, }); @@ -3169,6 +3361,9 @@ export interface CreateQueryLoggingConfigResponse { } export namespace CreateQueryLoggingConfigResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateQueryLoggingConfigResponse): any => ({ ...obj, }); @@ -3197,6 +3392,9 @@ export interface InsufficientCloudWatchLogsResourcePolicy extends __SmithyExcept } export namespace InsufficientCloudWatchLogsResourcePolicy { + /** + * @internal + */ export const filterSensitiveLog = (obj: InsufficientCloudWatchLogsResourcePolicy): any => ({ ...obj, }); @@ -3212,6 +3410,9 @@ export interface NoSuchCloudWatchLogsLogGroup extends __SmithyException, $Metada } export namespace NoSuchCloudWatchLogsLogGroup { + /** + * @internal + */ export const filterSensitiveLog = (obj: NoSuchCloudWatchLogsLogGroup): any => ({ ...obj, }); @@ -3228,6 +3429,9 @@ export interface QueryLoggingConfigAlreadyExists extends __SmithyException, $Met } export namespace QueryLoggingConfigAlreadyExists { + /** + * @internal + */ export const filterSensitiveLog = (obj: QueryLoggingConfigAlreadyExists): any => ({ ...obj, }); @@ -3251,6 +3455,9 @@ export interface CreateReusableDelegationSetRequest { } export namespace CreateReusableDelegationSetRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateReusableDelegationSetRequest): any => ({ ...obj, }); @@ -3269,6 +3476,9 @@ export interface CreateReusableDelegationSetResponse { } export namespace CreateReusableDelegationSetResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateReusableDelegationSetResponse): any => ({ ...obj, }); @@ -3287,6 +3497,9 @@ export interface DelegationSetAlreadyCreated extends __SmithyException, $Metadat } export namespace DelegationSetAlreadyCreated { + /** + * @internal + */ export const filterSensitiveLog = (obj: DelegationSetAlreadyCreated): any => ({ ...obj, }); @@ -3305,6 +3518,9 @@ export interface DelegationSetAlreadyReusable extends __SmithyException, $Metada } export namespace DelegationSetAlreadyReusable { + /** + * @internal + */ export const filterSensitiveLog = (obj: DelegationSetAlreadyReusable): any => ({ ...obj, }); @@ -3323,6 +3539,9 @@ export interface HostedZoneNotFound extends __SmithyException, $MetadataBearer { } export namespace HostedZoneNotFound { + /** + * @internal + */ export const filterSensitiveLog = (obj: HostedZoneNotFound): any => ({ ...obj, }); @@ -3350,6 +3569,9 @@ export interface CreateTrafficPolicyRequest { } export namespace CreateTrafficPolicyRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateTrafficPolicyRequest): any => ({ ...obj, }); @@ -3395,6 +3617,9 @@ export interface TrafficPolicy { } export namespace TrafficPolicy { + /** + * @internal + */ export const filterSensitiveLog = (obj: TrafficPolicy): any => ({ ...obj, }); @@ -3416,6 +3641,9 @@ export interface CreateTrafficPolicyResponse { } export namespace CreateTrafficPolicyResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateTrafficPolicyResponse): any => ({ ...obj, }); @@ -3434,6 +3662,9 @@ export interface InvalidTrafficPolicyDocument extends __SmithyException, $Metada } export namespace InvalidTrafficPolicyDocument { + /** + * @internal + */ export const filterSensitiveLog = (obj: InvalidTrafficPolicyDocument): any => ({ ...obj, }); @@ -3458,6 +3689,9 @@ export interface TooManyTrafficPolicies extends __SmithyException, $MetadataBear } export namespace TooManyTrafficPolicies { + /** + * @internal + */ export const filterSensitiveLog = (obj: TooManyTrafficPolicies): any => ({ ...obj, }); @@ -3476,6 +3710,9 @@ export interface TrafficPolicyAlreadyExists extends __SmithyException, $Metadata } export namespace TrafficPolicyAlreadyExists { + /** + * @internal + */ export const filterSensitiveLog = (obj: TrafficPolicyAlreadyExists): any => ({ ...obj, }); @@ -3513,6 +3750,9 @@ export interface CreateTrafficPolicyInstanceRequest { } export namespace CreateTrafficPolicyInstanceRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateTrafficPolicyInstanceRequest): any => ({ ...obj, }); @@ -3587,6 +3827,9 @@ export interface TrafficPolicyInstance { } export namespace TrafficPolicyInstance { + /** + * @internal + */ export const filterSensitiveLog = (obj: TrafficPolicyInstance): any => ({ ...obj, }); @@ -3608,6 +3851,9 @@ export interface CreateTrafficPolicyInstanceResponse { } export namespace CreateTrafficPolicyInstanceResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateTrafficPolicyInstanceResponse): any => ({ ...obj, }); @@ -3626,6 +3872,9 @@ export interface NoSuchTrafficPolicy extends __SmithyException, $MetadataBearer } export namespace NoSuchTrafficPolicy { + /** + * @internal + */ export const filterSensitiveLog = (obj: NoSuchTrafficPolicy): any => ({ ...obj, }); @@ -3651,6 +3900,9 @@ export interface TooManyTrafficPolicyInstances extends __SmithyException, $Metad } export namespace TooManyTrafficPolicyInstances { + /** + * @internal + */ export const filterSensitiveLog = (obj: TooManyTrafficPolicyInstances): any => ({ ...obj, }); @@ -3669,6 +3921,9 @@ export interface TrafficPolicyInstanceAlreadyExists extends __SmithyException, $ } export namespace TrafficPolicyInstanceAlreadyExists { + /** + * @internal + */ export const filterSensitiveLog = (obj: TrafficPolicyInstanceAlreadyExists): any => ({ ...obj, }); @@ -3697,6 +3952,9 @@ export interface CreateTrafficPolicyVersionRequest { } export namespace CreateTrafficPolicyVersionRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateTrafficPolicyVersionRequest): any => ({ ...obj, }); @@ -3718,6 +3976,9 @@ export interface CreateTrafficPolicyVersionResponse { } export namespace CreateTrafficPolicyVersionResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateTrafficPolicyVersionResponse): any => ({ ...obj, }); @@ -3742,6 +4003,9 @@ export interface TooManyTrafficPolicyVersionsForCurrentPolicy extends __SmithyEx } export namespace TooManyTrafficPolicyVersionsForCurrentPolicy { + /** + * @internal + */ export const filterSensitiveLog = (obj: TooManyTrafficPolicyVersionsForCurrentPolicy): any => ({ ...obj, }); @@ -3765,6 +4029,9 @@ export interface CreateVPCAssociationAuthorizationRequest { } export namespace CreateVPCAssociationAuthorizationRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateVPCAssociationAuthorizationRequest): any => ({ ...obj, }); @@ -3786,6 +4053,9 @@ export interface CreateVPCAssociationAuthorizationResponse { } export namespace CreateVPCAssociationAuthorizationResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateVPCAssociationAuthorizationResponse): any => ({ ...obj, }); @@ -3807,6 +4077,9 @@ export interface TooManyVPCAssociationAuthorizations extends __SmithyException, } export namespace TooManyVPCAssociationAuthorizations { + /** + * @internal + */ export const filterSensitiveLog = (obj: TooManyVPCAssociationAuthorizations): any => ({ ...obj, }); @@ -3825,6 +4098,9 @@ export interface DeactivateKeySigningKeyRequest { } export namespace DeactivateKeySigningKeyRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeactivateKeySigningKeyRequest): any => ({ ...obj, }); @@ -3839,6 +4115,9 @@ export interface DeactivateKeySigningKeyResponse { } export namespace DeactivateKeySigningKeyResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeactivateKeySigningKeyResponse): any => ({ ...obj, }); @@ -3854,6 +4133,9 @@ export interface KeySigningKeyInParentDSRecord extends __SmithyException, $Metad } export namespace KeySigningKeyInParentDSRecord { + /** + * @internal + */ export const filterSensitiveLog = (obj: KeySigningKeyInParentDSRecord): any => ({ ...obj, }); @@ -3870,6 +4152,9 @@ export interface KeySigningKeyInUse extends __SmithyException, $MetadataBearer { } export namespace KeySigningKeyInUse { + /** + * @internal + */ export const filterSensitiveLog = (obj: KeySigningKeyInUse): any => ({ ...obj, }); @@ -3886,6 +4171,9 @@ export interface DeleteHealthCheckRequest { } export namespace DeleteHealthCheckRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteHealthCheckRequest): any => ({ ...obj, }); @@ -3897,6 +4185,9 @@ export namespace DeleteHealthCheckRequest { export interface DeleteHealthCheckResponse {} export namespace DeleteHealthCheckResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteHealthCheckResponse): any => ({ ...obj, }); @@ -3917,6 +4208,9 @@ export interface HealthCheckInUse extends __SmithyException, $MetadataBearer { } export namespace HealthCheckInUse { + /** + * @internal + */ export const filterSensitiveLog = (obj: HealthCheckInUse): any => ({ ...obj, }); @@ -3933,6 +4227,9 @@ export interface DeleteHostedZoneRequest { } export namespace DeleteHostedZoneRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteHostedZoneRequest): any => ({ ...obj, }); @@ -3949,6 +4246,9 @@ export interface DeleteHostedZoneResponse { } export namespace DeleteHostedZoneResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteHostedZoneResponse): any => ({ ...obj, }); @@ -3967,6 +4267,9 @@ export interface HostedZoneNotEmpty extends __SmithyException, $MetadataBearer { } export namespace HostedZoneNotEmpty { + /** + * @internal + */ export const filterSensitiveLog = (obj: HostedZoneNotEmpty): any => ({ ...obj, }); @@ -3985,6 +4288,9 @@ export interface DeleteKeySigningKeyRequest { } export namespace DeleteKeySigningKeyRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteKeySigningKeyRequest): any => ({ ...obj, }); @@ -3999,6 +4305,9 @@ export interface DeleteKeySigningKeyResponse { } export namespace DeleteKeySigningKeyResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteKeySigningKeyResponse): any => ({ ...obj, }); @@ -4012,6 +4321,9 @@ export interface DeleteQueryLoggingConfigRequest { } export namespace DeleteQueryLoggingConfigRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteQueryLoggingConfigRequest): any => ({ ...obj, }); @@ -4020,6 +4332,9 @@ export namespace DeleteQueryLoggingConfigRequest { export interface DeleteQueryLoggingConfigResponse {} export namespace DeleteQueryLoggingConfigResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteQueryLoggingConfigResponse): any => ({ ...obj, }); @@ -4035,6 +4350,9 @@ export interface NoSuchQueryLoggingConfig extends __SmithyException, $MetadataBe } export namespace NoSuchQueryLoggingConfig { + /** + * @internal + */ export const filterSensitiveLog = (obj: NoSuchQueryLoggingConfig): any => ({ ...obj, }); @@ -4054,6 +4372,9 @@ export interface DelegationSetInUse extends __SmithyException, $MetadataBearer { } export namespace DelegationSetInUse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DelegationSetInUse): any => ({ ...obj, }); @@ -4070,6 +4391,9 @@ export interface DeleteReusableDelegationSetRequest { } export namespace DeleteReusableDelegationSetRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteReusableDelegationSetRequest): any => ({ ...obj, }); @@ -4081,6 +4405,9 @@ export namespace DeleteReusableDelegationSetRequest { export interface DeleteReusableDelegationSetResponse {} export namespace DeleteReusableDelegationSetResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteReusableDelegationSetResponse): any => ({ ...obj, }); @@ -4102,6 +4429,9 @@ export interface DeleteTrafficPolicyRequest { } export namespace DeleteTrafficPolicyRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteTrafficPolicyRequest): any => ({ ...obj, }); @@ -4113,6 +4443,9 @@ export namespace DeleteTrafficPolicyRequest { export interface DeleteTrafficPolicyResponse {} export namespace DeleteTrafficPolicyResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteTrafficPolicyResponse): any => ({ ...obj, }); @@ -4131,6 +4464,9 @@ export interface TrafficPolicyInUse extends __SmithyException, $MetadataBearer { } export namespace TrafficPolicyInUse { + /** + * @internal + */ export const filterSensitiveLog = (obj: TrafficPolicyInUse): any => ({ ...obj, }); @@ -4151,6 +4487,9 @@ export interface DeleteTrafficPolicyInstanceRequest { } export namespace DeleteTrafficPolicyInstanceRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteTrafficPolicyInstanceRequest): any => ({ ...obj, }); @@ -4162,6 +4501,9 @@ export namespace DeleteTrafficPolicyInstanceRequest { export interface DeleteTrafficPolicyInstanceResponse {} export namespace DeleteTrafficPolicyInstanceResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteTrafficPolicyInstanceResponse): any => ({ ...obj, }); @@ -4180,6 +4522,9 @@ export interface NoSuchTrafficPolicyInstance extends __SmithyException, $Metadat } export namespace NoSuchTrafficPolicyInstance { + /** + * @internal + */ export const filterSensitiveLog = (obj: NoSuchTrafficPolicyInstance): any => ({ ...obj, }); @@ -4204,6 +4549,9 @@ export interface DeleteVPCAssociationAuthorizationRequest { } export namespace DeleteVPCAssociationAuthorizationRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteVPCAssociationAuthorizationRequest): any => ({ ...obj, }); @@ -4215,6 +4563,9 @@ export namespace DeleteVPCAssociationAuthorizationRequest { export interface DeleteVPCAssociationAuthorizationResponse {} export namespace DeleteVPCAssociationAuthorizationResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteVPCAssociationAuthorizationResponse): any => ({ ...obj, }); @@ -4233,6 +4584,9 @@ export interface VPCAssociationAuthorizationNotFound extends __SmithyException, } export namespace VPCAssociationAuthorizationNotFound { + /** + * @internal + */ export const filterSensitiveLog = (obj: VPCAssociationAuthorizationNotFound): any => ({ ...obj, }); @@ -4246,6 +4600,9 @@ export interface DisableHostedZoneDNSSECRequest { } export namespace DisableHostedZoneDNSSECRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DisableHostedZoneDNSSECRequest): any => ({ ...obj, }); @@ -4260,6 +4617,9 @@ export interface DisableHostedZoneDNSSECResponse { } export namespace DisableHostedZoneDNSSECResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DisableHostedZoneDNSSECResponse): any => ({ ...obj, }); @@ -4275,6 +4635,9 @@ export interface DNSSECNotFound extends __SmithyException, $MetadataBearer { } export namespace DNSSECNotFound { + /** + * @internal + */ export const filterSensitiveLog = (obj: DNSSECNotFound): any => ({ ...obj, }); @@ -4304,6 +4667,9 @@ export interface DisassociateVPCFromHostedZoneRequest { } export namespace DisassociateVPCFromHostedZoneRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DisassociateVPCFromHostedZoneRequest): any => ({ ...obj, }); @@ -4320,6 +4686,9 @@ export interface DisassociateVPCFromHostedZoneResponse { } export namespace DisassociateVPCFromHostedZoneResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DisassociateVPCFromHostedZoneResponse): any => ({ ...obj, }); @@ -4339,6 +4708,9 @@ export interface LastVPCAssociation extends __SmithyException, $MetadataBearer { } export namespace LastVPCAssociation { + /** + * @internal + */ export const filterSensitiveLog = (obj: LastVPCAssociation): any => ({ ...obj, }); @@ -4357,6 +4729,9 @@ export interface VPCAssociationNotFound extends __SmithyException, $MetadataBear } export namespace VPCAssociationNotFound { + /** + * @internal + */ export const filterSensitiveLog = (obj: VPCAssociationNotFound): any => ({ ...obj, }); @@ -4370,6 +4745,9 @@ export interface EnableHostedZoneDNSSECRequest { } export namespace EnableHostedZoneDNSSECRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: EnableHostedZoneDNSSECRequest): any => ({ ...obj, }); @@ -4384,6 +4762,9 @@ export interface EnableHostedZoneDNSSECResponse { } export namespace EnableHostedZoneDNSSECResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: EnableHostedZoneDNSSECResponse): any => ({ ...obj, }); @@ -4399,6 +4780,9 @@ export interface HostedZonePartiallyDelegated extends __SmithyException, $Metada } export namespace HostedZonePartiallyDelegated { + /** + * @internal + */ export const filterSensitiveLog = (obj: HostedZonePartiallyDelegated): any => ({ ...obj, }); @@ -4414,6 +4798,9 @@ export interface KeySigningKeyWithActiveStatusNotFound extends __SmithyException } export namespace KeySigningKeyWithActiveStatusNotFound { + /** + * @internal + */ export const filterSensitiveLog = (obj: KeySigningKeyWithActiveStatusNotFound): any => ({ ...obj, }); @@ -4458,6 +4845,9 @@ export interface GetAccountLimitRequest { } export namespace GetAccountLimitRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetAccountLimitRequest): any => ({ ...obj, }); @@ -4483,6 +4873,9 @@ export interface GetAccountLimitResponse { } export namespace GetAccountLimitResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetAccountLimitResponse): any => ({ ...obj, }); @@ -4500,6 +4893,9 @@ export interface GetChangeRequest { } export namespace GetChangeRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetChangeRequest): any => ({ ...obj, }); @@ -4516,6 +4912,9 @@ export interface GetChangeResponse { } export namespace GetChangeResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetChangeResponse): any => ({ ...obj, }); @@ -4531,6 +4930,9 @@ export interface NoSuchChange extends __SmithyException, $MetadataBearer { } export namespace NoSuchChange { + /** + * @internal + */ export const filterSensitiveLog = (obj: NoSuchChange): any => ({ ...obj, }); @@ -4542,6 +4944,9 @@ export namespace NoSuchChange { export interface GetCheckerIpRangesRequest {} export namespace GetCheckerIpRangesRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetCheckerIpRangesRequest): any => ({ ...obj, }); @@ -4559,6 +4964,9 @@ export interface GetCheckerIpRangesResponse { } export namespace GetCheckerIpRangesResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetCheckerIpRangesResponse): any => ({ ...obj, }); @@ -4572,6 +4980,9 @@ export interface GetDNSSECRequest { } export namespace GetDNSSECRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetDNSSECRequest): any => ({ ...obj, }); @@ -4621,6 +5032,9 @@ export interface DNSSECStatus { } export namespace DNSSECStatus { + /** + * @internal + */ export const filterSensitiveLog = (obj: DNSSECStatus): any => ({ ...obj, }); @@ -4639,6 +5053,9 @@ export interface GetDNSSECResponse { } export namespace GetDNSSECResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetDNSSECResponse): any => ({ ...obj, }); @@ -4696,6 +5113,9 @@ export interface GetGeoLocationRequest { } export namespace GetGeoLocationRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetGeoLocationRequest): any => ({ ...obj, }); @@ -4737,6 +5157,9 @@ export interface GeoLocationDetails { } export namespace GeoLocationDetails { + /** + * @internal + */ export const filterSensitiveLog = (obj: GeoLocationDetails): any => ({ ...obj, }); @@ -4753,6 +5176,9 @@ export interface GetGeoLocationResponse { } export namespace GetGeoLocationResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetGeoLocationResponse): any => ({ ...obj, }); @@ -4772,6 +5198,9 @@ export interface NoSuchGeoLocation extends __SmithyException, $MetadataBearer { } export namespace NoSuchGeoLocation { + /** + * @internal + */ export const filterSensitiveLog = (obj: NoSuchGeoLocation): any => ({ ...obj, }); @@ -4789,6 +5218,9 @@ export interface GetHealthCheckRequest { } export namespace GetHealthCheckRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetHealthCheckRequest): any => ({ ...obj, }); @@ -4806,6 +5238,9 @@ export interface GetHealthCheckResponse { } export namespace GetHealthCheckResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetHealthCheckResponse): any => ({ ...obj, }); @@ -4821,6 +5256,9 @@ export interface IncompatibleVersion extends __SmithyException, $MetadataBearer } export namespace IncompatibleVersion { + /** + * @internal + */ export const filterSensitiveLog = (obj: IncompatibleVersion): any => ({ ...obj, }); @@ -4832,6 +5270,9 @@ export namespace IncompatibleVersion { export interface GetHealthCheckCountRequest {} export namespace GetHealthCheckCountRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetHealthCheckCountRequest): any => ({ ...obj, }); @@ -4848,6 +5289,9 @@ export interface GetHealthCheckCountResponse { } export namespace GetHealthCheckCountResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetHealthCheckCountResponse): any => ({ ...obj, }); @@ -4869,6 +5313,9 @@ export interface GetHealthCheckLastFailureReasonRequest { } export namespace GetHealthCheckLastFailureReasonRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetHealthCheckLastFailureReasonRequest): any => ({ ...obj, }); @@ -4892,6 +5339,9 @@ export interface StatusReport { } export namespace StatusReport { + /** + * @internal + */ export const filterSensitiveLog = (obj: StatusReport): any => ({ ...obj, }); @@ -4918,6 +5368,9 @@ export interface HealthCheckObservation { } export namespace HealthCheckObservation { + /** + * @internal + */ export const filterSensitiveLog = (obj: HealthCheckObservation): any => ({ ...obj, }); @@ -4934,6 +5387,9 @@ export interface GetHealthCheckLastFailureReasonResponse { } export namespace GetHealthCheckLastFailureReasonResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetHealthCheckLastFailureReasonResponse): any => ({ ...obj, }); @@ -4955,6 +5411,9 @@ export interface GetHealthCheckStatusRequest { } export namespace GetHealthCheckStatusRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetHealthCheckStatusRequest): any => ({ ...obj, }); @@ -4973,6 +5432,9 @@ export interface GetHealthCheckStatusResponse { } export namespace GetHealthCheckStatusResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetHealthCheckStatusResponse): any => ({ ...obj, }); @@ -4989,6 +5451,9 @@ export interface GetHostedZoneRequest { } export namespace GetHostedZoneRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetHostedZoneRequest): any => ({ ...obj, }); @@ -5015,6 +5480,9 @@ export interface GetHostedZoneResponse { } export namespace GetHostedZoneResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetHostedZoneResponse): any => ({ ...obj, }); @@ -5026,6 +5494,9 @@ export namespace GetHostedZoneResponse { export interface GetHostedZoneCountRequest {} export namespace GetHostedZoneCountRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetHostedZoneCountRequest): any => ({ ...obj, }); @@ -5042,6 +5513,9 @@ export interface GetHostedZoneCountResponse { } export namespace GetHostedZoneCountResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetHostedZoneCountResponse): any => ({ ...obj, }); @@ -5077,6 +5551,9 @@ export interface GetHostedZoneLimitRequest { } export namespace GetHostedZoneLimitRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetHostedZoneLimitRequest): any => ({ ...obj, }); @@ -5110,6 +5587,9 @@ export interface HostedZoneLimit { } export namespace HostedZoneLimit { + /** + * @internal + */ export const filterSensitiveLog = (obj: HostedZoneLimit): any => ({ ...obj, }); @@ -5135,6 +5615,9 @@ export interface GetHostedZoneLimitResponse { } export namespace GetHostedZoneLimitResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetHostedZoneLimitResponse): any => ({ ...obj, }); @@ -5153,6 +5636,9 @@ export interface HostedZoneNotPrivate extends __SmithyException, $MetadataBearer } export namespace HostedZoneNotPrivate { + /** + * @internal + */ export const filterSensitiveLog = (obj: HostedZoneNotPrivate): any => ({ ...obj, }); @@ -5166,6 +5652,9 @@ export interface GetQueryLoggingConfigRequest { } export namespace GetQueryLoggingConfigRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetQueryLoggingConfigRequest): any => ({ ...obj, }); @@ -5180,6 +5669,9 @@ export interface GetQueryLoggingConfigResponse { } export namespace GetQueryLoggingConfigResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetQueryLoggingConfigResponse): any => ({ ...obj, }); @@ -5196,6 +5688,9 @@ export interface GetReusableDelegationSetRequest { } export namespace GetReusableDelegationSetRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetReusableDelegationSetRequest): any => ({ ...obj, }); @@ -5212,6 +5707,9 @@ export interface GetReusableDelegationSetResponse { } export namespace GetReusableDelegationSetResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetReusableDelegationSetResponse): any => ({ ...obj, }); @@ -5236,6 +5734,9 @@ export interface GetReusableDelegationSetLimitRequest { } export namespace GetReusableDelegationSetLimitRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetReusableDelegationSetLimitRequest): any => ({ ...obj, }); @@ -5258,6 +5759,9 @@ export interface ReusableDelegationSetLimit { } export namespace ReusableDelegationSetLimit { + /** + * @internal + */ export const filterSensitiveLog = (obj: ReusableDelegationSetLimit): any => ({ ...obj, }); @@ -5279,6 +5783,9 @@ export interface GetReusableDelegationSetLimitResponse { } export namespace GetReusableDelegationSetLimitResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetReusableDelegationSetLimitResponse): any => ({ ...obj, }); @@ -5300,6 +5807,9 @@ export interface GetTrafficPolicyRequest { } export namespace GetTrafficPolicyRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetTrafficPolicyRequest): any => ({ ...obj, }); @@ -5316,6 +5826,9 @@ export interface GetTrafficPolicyResponse { } export namespace GetTrafficPolicyResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetTrafficPolicyResponse): any => ({ ...obj, }); @@ -5332,6 +5845,9 @@ export interface GetTrafficPolicyInstanceRequest { } export namespace GetTrafficPolicyInstanceRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetTrafficPolicyInstanceRequest): any => ({ ...obj, }); @@ -5348,6 +5864,9 @@ export interface GetTrafficPolicyInstanceResponse { } export namespace GetTrafficPolicyInstanceResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetTrafficPolicyInstanceResponse): any => ({ ...obj, }); @@ -5359,6 +5878,9 @@ export namespace GetTrafficPolicyInstanceResponse { export interface GetTrafficPolicyInstanceCountRequest {} export namespace GetTrafficPolicyInstanceCountRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetTrafficPolicyInstanceCountRequest): any => ({ ...obj, }); @@ -5375,6 +5897,9 @@ export interface GetTrafficPolicyInstanceCountResponse { } export namespace GetTrafficPolicyInstanceCountResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetTrafficPolicyInstanceCountResponse): any => ({ ...obj, }); @@ -5417,6 +5942,9 @@ export interface ListGeoLocationsRequest { } export namespace ListGeoLocationsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListGeoLocationsRequest): any => ({ ...obj, }); @@ -5464,6 +5992,9 @@ export interface ListGeoLocationsResponse { } export namespace ListGeoLocationsResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListGeoLocationsResponse): any => ({ ...obj, }); @@ -5490,6 +6021,9 @@ export interface ListHealthChecksRequest { } export namespace ListHealthChecksRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListHealthChecksRequest): any => ({ ...obj, }); @@ -5533,6 +6067,9 @@ export interface ListHealthChecksResponse { } export namespace ListHealthChecksResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListHealthChecksResponse): any => ({ ...obj, }); @@ -5566,6 +6103,9 @@ export interface ListHostedZonesRequest { } export namespace ListHostedZonesRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListHostedZonesRequest): any => ({ ...obj, }); @@ -5606,6 +6146,9 @@ export interface ListHostedZonesResponse { } export namespace ListHostedZonesResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListHostedZonesResponse): any => ({ ...obj, }); @@ -5642,6 +6185,9 @@ export interface ListHostedZonesByNameRequest { } export namespace ListHostedZonesByNameRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListHostedZonesByNameRequest): any => ({ ...obj, }); @@ -5698,6 +6244,9 @@ export interface ListHostedZonesByNameResponse { } export namespace ListHostedZonesByNameResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListHostedZonesByNameResponse): any => ({ ...obj, }); @@ -5713,6 +6262,9 @@ export interface InvalidPaginationToken extends __SmithyException, $MetadataBear } export namespace InvalidPaginationToken { + /** + * @internal + */ export const filterSensitiveLog = (obj: InvalidPaginationToken): any => ({ ...obj, }); @@ -5749,6 +6301,9 @@ export interface ListHostedZonesByVPCRequest { } export namespace ListHostedZonesByVPCRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListHostedZonesByVPCRequest): any => ({ ...obj, }); @@ -5775,6 +6330,9 @@ export interface HostedZoneOwner { } export namespace HostedZoneOwner { + /** + * @internal + */ export const filterSensitiveLog = (obj: HostedZoneOwner): any => ({ ...obj, }); @@ -5804,6 +6362,9 @@ export interface HostedZoneSummary { } export namespace HostedZoneSummary { + /** + * @internal + */ export const filterSensitiveLog = (obj: HostedZoneSummary): any => ({ ...obj, }); @@ -5828,6 +6389,9 @@ export interface ListHostedZonesByVPCResponse { } export namespace ListHostedZonesByVPCResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListHostedZonesByVPCResponse): any => ({ ...obj, }); @@ -5862,6 +6426,9 @@ export interface ListQueryLoggingConfigsRequest { } export namespace ListQueryLoggingConfigsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListQueryLoggingConfigsRequest): any => ({ ...obj, }); @@ -5887,6 +6454,9 @@ export interface ListQueryLoggingConfigsResponse { } export namespace ListQueryLoggingConfigsResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListQueryLoggingConfigsResponse): any => ({ ...obj, }); @@ -5970,6 +6540,9 @@ export interface ListResourceRecordSetsRequest { } export namespace ListResourceRecordSetsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListResourceRecordSetsRequest): any => ({ ...obj, }); @@ -6019,6 +6592,9 @@ export interface ListResourceRecordSetsResponse { } export namespace ListResourceRecordSetsResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListResourceRecordSetsResponse): any => ({ ...obj, }); @@ -6045,6 +6621,9 @@ export interface ListReusableDelegationSetsRequest { } export namespace ListReusableDelegationSetsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListReusableDelegationSetsRequest): any => ({ ...obj, }); @@ -6086,6 +6665,9 @@ export interface ListReusableDelegationSetsResponse { } export namespace ListReusableDelegationSetsResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListReusableDelegationSetsResponse): any => ({ ...obj, }); @@ -6115,6 +6697,9 @@ export interface ListTagsForResourceRequest { } export namespace ListTagsForResourceRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListTagsForResourceRequest): any => ({ ...obj, }); @@ -6149,6 +6734,9 @@ export interface ResourceTagSet { } export namespace ResourceTagSet { + /** + * @internal + */ export const filterSensitiveLog = (obj: ResourceTagSet): any => ({ ...obj, }); @@ -6165,6 +6753,9 @@ export interface ListTagsForResourceResponse { } export namespace ListTagsForResourceResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListTagsForResourceResponse): any => ({ ...obj, }); @@ -6194,6 +6785,9 @@ export interface ListTagsForResourcesRequest { } export namespace ListTagsForResourcesRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListTagsForResourcesRequest): any => ({ ...obj, }); @@ -6210,6 +6804,9 @@ export interface ListTagsForResourcesResponse { } export namespace ListTagsForResourcesResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListTagsForResourcesResponse): any => ({ ...obj, }); @@ -6239,6 +6836,9 @@ export interface ListTrafficPoliciesRequest { } export namespace ListTrafficPoliciesRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListTrafficPoliciesRequest): any => ({ ...obj, }); @@ -6277,6 +6877,9 @@ export interface TrafficPolicySummary { } export namespace TrafficPolicySummary { + /** + * @internal + */ export const filterSensitiveLog = (obj: TrafficPolicySummary): any => ({ ...obj, }); @@ -6312,6 +6915,9 @@ export interface ListTrafficPoliciesResponse { } export namespace ListTrafficPoliciesResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListTrafficPoliciesResponse): any => ({ ...obj, }); @@ -6359,6 +6965,9 @@ export interface ListTrafficPolicyInstancesRequest { } export namespace ListTrafficPolicyInstancesRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListTrafficPolicyInstancesRequest): any => ({ ...obj, }); @@ -6408,6 +7017,9 @@ export interface ListTrafficPolicyInstancesResponse { } export namespace ListTrafficPolicyInstancesResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListTrafficPolicyInstancesResponse): any => ({ ...obj, }); @@ -6450,6 +7062,9 @@ export interface ListTrafficPolicyInstancesByHostedZoneRequest { } export namespace ListTrafficPolicyInstancesByHostedZoneRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListTrafficPolicyInstancesByHostedZoneRequest): any => ({ ...obj, }); @@ -6492,6 +7107,9 @@ export interface ListTrafficPolicyInstancesByHostedZoneResponse { } export namespace ListTrafficPolicyInstancesByHostedZoneResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListTrafficPolicyInstancesByHostedZoneResponse): any => ({ ...obj, }); @@ -6549,6 +7167,9 @@ export interface ListTrafficPolicyInstancesByPolicyRequest { } export namespace ListTrafficPolicyInstancesByPolicyRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListTrafficPolicyInstancesByPolicyRequest): any => ({ ...obj, }); @@ -6596,6 +7217,9 @@ export interface ListTrafficPolicyInstancesByPolicyResponse { } export namespace ListTrafficPolicyInstancesByPolicyResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListTrafficPolicyInstancesByPolicyResponse): any => ({ ...obj, }); @@ -6630,6 +7254,9 @@ export interface ListTrafficPolicyVersionsRequest { } export namespace ListTrafficPolicyVersionsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListTrafficPolicyVersionsRequest): any => ({ ...obj, }); @@ -6668,6 +7295,9 @@ export interface ListTrafficPolicyVersionsResponse { } export namespace ListTrafficPolicyVersionsResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListTrafficPolicyVersionsResponse): any => ({ ...obj, }); @@ -6700,6 +7330,9 @@ export interface ListVPCAssociationAuthorizationsRequest { } export namespace ListVPCAssociationAuthorizationsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListVPCAssociationAuthorizationsRequest): any => ({ ...obj, }); @@ -6728,6 +7361,9 @@ export interface ListVPCAssociationAuthorizationsResponse { } export namespace ListVPCAssociationAuthorizationsResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListVPCAssociationAuthorizationsResponse): any => ({ ...obj, }); @@ -6787,6 +7423,9 @@ export interface TestDNSAnswerRequest { } export namespace TestDNSAnswerRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: TestDNSAnswerRequest): any => ({ ...obj, }); @@ -6831,6 +7470,9 @@ export interface TestDNSAnswerResponse { } export namespace TestDNSAnswerResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: TestDNSAnswerResponse): any => ({ ...obj, }); @@ -6847,6 +7489,9 @@ export interface HealthCheckVersionMismatch extends __SmithyException, $Metadata } export namespace HealthCheckVersionMismatch { + /** + * @internal + */ export const filterSensitiveLog = (obj: HealthCheckVersionMismatch): any => ({ ...obj, }); @@ -7180,6 +7825,9 @@ export interface UpdateHealthCheckRequest { } export namespace UpdateHealthCheckRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateHealthCheckRequest): any => ({ ...obj, }); @@ -7196,6 +7844,9 @@ export interface UpdateHealthCheckResponse { } export namespace UpdateHealthCheckResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateHealthCheckResponse): any => ({ ...obj, }); @@ -7218,6 +7869,9 @@ export interface UpdateHostedZoneCommentRequest { } export namespace UpdateHostedZoneCommentRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateHostedZoneCommentRequest): any => ({ ...obj, }); @@ -7234,6 +7888,9 @@ export interface UpdateHostedZoneCommentResponse { } export namespace UpdateHostedZoneCommentResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateHostedZoneCommentResponse): any => ({ ...obj, }); @@ -7260,6 +7917,9 @@ export interface UpdateTrafficPolicyCommentRequest { } export namespace UpdateTrafficPolicyCommentRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateTrafficPolicyCommentRequest): any => ({ ...obj, }); @@ -7276,6 +7936,9 @@ export interface UpdateTrafficPolicyCommentResponse { } export namespace UpdateTrafficPolicyCommentResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateTrafficPolicyCommentResponse): any => ({ ...obj, }); @@ -7296,6 +7959,9 @@ export interface ConflictingTypes extends __SmithyException, $MetadataBearer { } export namespace ConflictingTypes { + /** + * @internal + */ export const filterSensitiveLog = (obj: ConflictingTypes): any => ({ ...obj, }); @@ -7327,6 +7993,9 @@ export interface UpdateTrafficPolicyInstanceRequest { } export namespace UpdateTrafficPolicyInstanceRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateTrafficPolicyInstanceRequest): any => ({ ...obj, }); @@ -7344,6 +8013,9 @@ export interface UpdateTrafficPolicyInstanceResponse { } export namespace UpdateTrafficPolicyInstanceResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateTrafficPolicyInstanceResponse): any => ({ ...obj, }); diff --git a/clients/client-route53resolver/commands/AssociateFirewallRuleGroupCommand.ts b/clients/client-route53resolver/commands/AssociateFirewallRuleGroupCommand.ts index cee623727a86..a2e5d1ccf777 100644 --- a/clients/client-route53resolver/commands/AssociateFirewallRuleGroupCommand.ts +++ b/clients/client-route53resolver/commands/AssociateFirewallRuleGroupCommand.ts @@ -22,6 +22,20 @@ export interface AssociateFirewallRuleGroupCommandOutput extends AssociateFirewa /** *

Associates a FirewallRuleGroup with a VPC, to provide DNS filtering for the VPC.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { Route53ResolverClient, AssociateFirewallRuleGroupCommand } from "@aws-sdk/client-route53resolver"; // ES Modules import + * // const { Route53ResolverClient, AssociateFirewallRuleGroupCommand } = require("@aws-sdk/client-route53resolver"); // CommonJS import + * const client = new Route53ResolverClient(config); + * const command = new AssociateFirewallRuleGroupCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link AssociateFirewallRuleGroupCommandInput} for command's `input` shape. + * @see {@link AssociateFirewallRuleGroupCommandOutput} for command's `response` shape. + * @see {@link Route53ResolverClientResolvedConfig | config} for command's `input` shape. + * */ export class AssociateFirewallRuleGroupCommand extends $Command< AssociateFirewallRuleGroupCommandInput, diff --git a/clients/client-route53resolver/commands/AssociateResolverEndpointIpAddressCommand.ts b/clients/client-route53resolver/commands/AssociateResolverEndpointIpAddressCommand.ts index ebc5653591b8..96a8be65409a 100644 --- a/clients/client-route53resolver/commands/AssociateResolverEndpointIpAddressCommand.ts +++ b/clients/client-route53resolver/commands/AssociateResolverEndpointIpAddressCommand.ts @@ -31,6 +31,20 @@ export interface AssociateResolverEndpointIpAddressCommandOutput *

To remove an IP address from an endpoint, see * DisassociateResolverEndpointIpAddress. *

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { Route53ResolverClient, AssociateResolverEndpointIpAddressCommand } from "@aws-sdk/client-route53resolver"; // ES Modules import + * // const { Route53ResolverClient, AssociateResolverEndpointIpAddressCommand } = require("@aws-sdk/client-route53resolver"); // CommonJS import + * const client = new Route53ResolverClient(config); + * const command = new AssociateResolverEndpointIpAddressCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link AssociateResolverEndpointIpAddressCommandInput} for command's `input` shape. + * @see {@link AssociateResolverEndpointIpAddressCommandOutput} for command's `response` shape. + * @see {@link Route53ResolverClientResolvedConfig | config} for command's `input` shape. + * */ export class AssociateResolverEndpointIpAddressCommand extends $Command< AssociateResolverEndpointIpAddressCommandInput, diff --git a/clients/client-route53resolver/commands/AssociateResolverQueryLogConfigCommand.ts b/clients/client-route53resolver/commands/AssociateResolverQueryLogConfigCommand.ts index be572143d45e..3a8d19661636 100644 --- a/clients/client-route53resolver/commands/AssociateResolverQueryLogConfigCommand.ts +++ b/clients/client-route53resolver/commands/AssociateResolverQueryLogConfigCommand.ts @@ -34,6 +34,20 @@ export interface AssociateResolverQueryLogConfigCommandOutput *

To remove a VPC from a query logging configuration, see * DisassociateResolverQueryLogConfig. *

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { Route53ResolverClient, AssociateResolverQueryLogConfigCommand } from "@aws-sdk/client-route53resolver"; // ES Modules import + * // const { Route53ResolverClient, AssociateResolverQueryLogConfigCommand } = require("@aws-sdk/client-route53resolver"); // CommonJS import + * const client = new Route53ResolverClient(config); + * const command = new AssociateResolverQueryLogConfigCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link AssociateResolverQueryLogConfigCommandInput} for command's `input` shape. + * @see {@link AssociateResolverQueryLogConfigCommandOutput} for command's `response` shape. + * @see {@link Route53ResolverClientResolvedConfig | config} for command's `input` shape. + * */ export class AssociateResolverQueryLogConfigCommand extends $Command< AssociateResolverQueryLogConfigCommandInput, diff --git a/clients/client-route53resolver/commands/AssociateResolverRuleCommand.ts b/clients/client-route53resolver/commands/AssociateResolverRuleCommand.ts index 8e4c0967aeb4..f188d96519b1 100644 --- a/clients/client-route53resolver/commands/AssociateResolverRuleCommand.ts +++ b/clients/client-route53resolver/commands/AssociateResolverRuleCommand.ts @@ -25,6 +25,20 @@ export interface AssociateResolverRuleCommandOutput extends AssociateResolverRul * 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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { Route53ResolverClient, AssociateResolverRuleCommand } from "@aws-sdk/client-route53resolver"; // ES Modules import + * // const { Route53ResolverClient, AssociateResolverRuleCommand } = require("@aws-sdk/client-route53resolver"); // CommonJS import + * const client = new Route53ResolverClient(config); + * const command = new AssociateResolverRuleCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link AssociateResolverRuleCommandInput} for command's `input` shape. + * @see {@link AssociateResolverRuleCommandOutput} for command's `response` shape. + * @see {@link Route53ResolverClientResolvedConfig | config} for command's `input` shape. + * */ export class AssociateResolverRuleCommand extends $Command< AssociateResolverRuleCommandInput, diff --git a/clients/client-route53resolver/commands/CreateFirewallDomainListCommand.ts b/clients/client-route53resolver/commands/CreateFirewallDomainListCommand.ts index 57cb6e55e0b2..35cd7d0107e0 100644 --- a/clients/client-route53resolver/commands/CreateFirewallDomainListCommand.ts +++ b/clients/client-route53resolver/commands/CreateFirewallDomainListCommand.ts @@ -22,6 +22,20 @@ export interface CreateFirewallDomainListCommandOutput extends CreateFirewallDom /** *

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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { Route53ResolverClient, CreateFirewallDomainListCommand } from "@aws-sdk/client-route53resolver"; // ES Modules import + * // const { Route53ResolverClient, CreateFirewallDomainListCommand } = require("@aws-sdk/client-route53resolver"); // CommonJS import + * const client = new Route53ResolverClient(config); + * const command = new CreateFirewallDomainListCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreateFirewallDomainListCommandInput} for command's `input` shape. + * @see {@link CreateFirewallDomainListCommandOutput} for command's `response` shape. + * @see {@link Route53ResolverClientResolvedConfig | config} for command's `input` shape. + * */ export class CreateFirewallDomainListCommand extends $Command< CreateFirewallDomainListCommandInput, diff --git a/clients/client-route53resolver/commands/CreateFirewallRuleCommand.ts b/clients/client-route53resolver/commands/CreateFirewallRuleCommand.ts index d503dc657b76..196583f1eced 100644 --- a/clients/client-route53resolver/commands/CreateFirewallRuleCommand.ts +++ b/clients/client-route53resolver/commands/CreateFirewallRuleCommand.ts @@ -22,6 +22,20 @@ export interface CreateFirewallRuleCommandOutput extends CreateFirewallRuleRespo /** *

Creates a single DNS Firewall rule in the specified rule group, using the specified domain list.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { Route53ResolverClient, CreateFirewallRuleCommand } from "@aws-sdk/client-route53resolver"; // ES Modules import + * // const { Route53ResolverClient, CreateFirewallRuleCommand } = require("@aws-sdk/client-route53resolver"); // CommonJS import + * const client = new Route53ResolverClient(config); + * const command = new CreateFirewallRuleCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreateFirewallRuleCommandInput} for command's `input` shape. + * @see {@link CreateFirewallRuleCommandOutput} for command's `response` shape. + * @see {@link Route53ResolverClientResolvedConfig | config} for command's `input` shape. + * */ export class CreateFirewallRuleCommand extends $Command< CreateFirewallRuleCommandInput, diff --git a/clients/client-route53resolver/commands/CreateFirewallRuleGroupCommand.ts b/clients/client-route53resolver/commands/CreateFirewallRuleGroupCommand.ts index e27357b3b3aa..ee88c5853f5c 100644 --- a/clients/client-route53resolver/commands/CreateFirewallRuleGroupCommand.ts +++ b/clients/client-route53resolver/commands/CreateFirewallRuleGroupCommand.ts @@ -23,6 +23,20 @@ export interface CreateFirewallRuleGroupCommandOutput extends CreateFirewallRule /** *

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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { Route53ResolverClient, CreateFirewallRuleGroupCommand } from "@aws-sdk/client-route53resolver"; // ES Modules import + * // const { Route53ResolverClient, CreateFirewallRuleGroupCommand } = require("@aws-sdk/client-route53resolver"); // CommonJS import + * const client = new Route53ResolverClient(config); + * const command = new CreateFirewallRuleGroupCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreateFirewallRuleGroupCommandInput} for command's `input` shape. + * @see {@link CreateFirewallRuleGroupCommandOutput} for command's `response` shape. + * @see {@link Route53ResolverClientResolvedConfig | config} for command's `input` shape. + * */ export class CreateFirewallRuleGroupCommand extends $Command< CreateFirewallRuleGroupCommandInput, diff --git a/clients/client-route53resolver/commands/CreateResolverEndpointCommand.ts b/clients/client-route53resolver/commands/CreateResolverEndpointCommand.ts index b8c60491f122..c1593c06275b 100644 --- a/clients/client-route53resolver/commands/CreateResolverEndpointCommand.ts +++ b/clients/client-route53resolver/commands/CreateResolverEndpointCommand.ts @@ -32,6 +32,20 @@ export interface CreateResolverEndpointCommandOutput extends CreateResolverEndpo * to your network.

* * + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { Route53ResolverClient, CreateResolverEndpointCommand } from "@aws-sdk/client-route53resolver"; // ES Modules import + * // const { Route53ResolverClient, CreateResolverEndpointCommand } = require("@aws-sdk/client-route53resolver"); // CommonJS import + * const client = new Route53ResolverClient(config); + * const command = new CreateResolverEndpointCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreateResolverEndpointCommandInput} for command's `input` shape. + * @see {@link CreateResolverEndpointCommandOutput} for command's `response` shape. + * @see {@link Route53ResolverClientResolvedConfig | config} for command's `input` shape. + * */ export class CreateResolverEndpointCommand extends $Command< CreateResolverEndpointCommandInput, diff --git a/clients/client-route53resolver/commands/CreateResolverQueryLogConfigCommand.ts b/clients/client-route53resolver/commands/CreateResolverQueryLogConfigCommand.ts index 9edc117ab442..493aa9d089e0 100644 --- a/clients/client-route53resolver/commands/CreateResolverQueryLogConfigCommand.ts +++ b/clients/client-route53resolver/commands/CreateResolverQueryLogConfigCommand.ts @@ -32,6 +32,20 @@ export interface CreateResolverQueryLogConfigCommandOutput *

You can optionally use AWS Resource Access Manager (AWS RAM) to share a query logging configuration with other AWS 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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { Route53ResolverClient, CreateResolverQueryLogConfigCommand } from "@aws-sdk/client-route53resolver"; // ES Modules import + * // const { Route53ResolverClient, CreateResolverQueryLogConfigCommand } = require("@aws-sdk/client-route53resolver"); // CommonJS import + * const client = new Route53ResolverClient(config); + * const command = new CreateResolverQueryLogConfigCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreateResolverQueryLogConfigCommandInput} for command's `input` shape. + * @see {@link CreateResolverQueryLogConfigCommandOutput} for command's `response` shape. + * @see {@link Route53ResolverClientResolvedConfig | config} for command's `input` shape. + * */ export class CreateResolverQueryLogConfigCommand extends $Command< CreateResolverQueryLogConfigCommandInput, diff --git a/clients/client-route53resolver/commands/CreateResolverRuleCommand.ts b/clients/client-route53resolver/commands/CreateResolverRuleCommand.ts index 5be285284795..4e03f76f77a4 100644 --- a/clients/client-route53resolver/commands/CreateResolverRuleCommand.ts +++ b/clients/client-route53resolver/commands/CreateResolverRuleCommand.ts @@ -23,6 +23,20 @@ export interface CreateResolverRuleCommandOutput extends CreateResolverRuleRespo /** *

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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { Route53ResolverClient, CreateResolverRuleCommand } from "@aws-sdk/client-route53resolver"; // ES Modules import + * // const { Route53ResolverClient, CreateResolverRuleCommand } = require("@aws-sdk/client-route53resolver"); // CommonJS import + * const client = new Route53ResolverClient(config); + * const command = new CreateResolverRuleCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreateResolverRuleCommandInput} for command's `input` shape. + * @see {@link CreateResolverRuleCommandOutput} for command's `response` shape. + * @see {@link Route53ResolverClientResolvedConfig | config} for command's `input` shape. + * */ export class CreateResolverRuleCommand extends $Command< CreateResolverRuleCommandInput, diff --git a/clients/client-route53resolver/commands/DeleteFirewallDomainListCommand.ts b/clients/client-route53resolver/commands/DeleteFirewallDomainListCommand.ts index 68e928836ab8..6c9f9f28601b 100644 --- a/clients/client-route53resolver/commands/DeleteFirewallDomainListCommand.ts +++ b/clients/client-route53resolver/commands/DeleteFirewallDomainListCommand.ts @@ -22,6 +22,20 @@ export interface DeleteFirewallDomainListCommandOutput extends DeleteFirewallDom /** *

Deletes the specified domain list.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { Route53ResolverClient, DeleteFirewallDomainListCommand } from "@aws-sdk/client-route53resolver"; // ES Modules import + * // const { Route53ResolverClient, DeleteFirewallDomainListCommand } = require("@aws-sdk/client-route53resolver"); // CommonJS import + * const client = new Route53ResolverClient(config); + * const command = new DeleteFirewallDomainListCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteFirewallDomainListCommandInput} for command's `input` shape. + * @see {@link DeleteFirewallDomainListCommandOutput} for command's `response` shape. + * @see {@link Route53ResolverClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteFirewallDomainListCommand extends $Command< DeleteFirewallDomainListCommandInput, diff --git a/clients/client-route53resolver/commands/DeleteFirewallRuleCommand.ts b/clients/client-route53resolver/commands/DeleteFirewallRuleCommand.ts index 55e11d789aae..5c3968e0018f 100644 --- a/clients/client-route53resolver/commands/DeleteFirewallRuleCommand.ts +++ b/clients/client-route53resolver/commands/DeleteFirewallRuleCommand.ts @@ -22,6 +22,20 @@ export interface DeleteFirewallRuleCommandOutput extends DeleteFirewallRuleRespo /** *

Deletes the specified firewall rule.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { Route53ResolverClient, DeleteFirewallRuleCommand } from "@aws-sdk/client-route53resolver"; // ES Modules import + * // const { Route53ResolverClient, DeleteFirewallRuleCommand } = require("@aws-sdk/client-route53resolver"); // CommonJS import + * const client = new Route53ResolverClient(config); + * const command = new DeleteFirewallRuleCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteFirewallRuleCommandInput} for command's `input` shape. + * @see {@link DeleteFirewallRuleCommandOutput} for command's `response` shape. + * @see {@link Route53ResolverClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteFirewallRuleCommand extends $Command< DeleteFirewallRuleCommandInput, diff --git a/clients/client-route53resolver/commands/DeleteFirewallRuleGroupCommand.ts b/clients/client-route53resolver/commands/DeleteFirewallRuleGroupCommand.ts index c65e8c2b1f18..5dc07efca05a 100644 --- a/clients/client-route53resolver/commands/DeleteFirewallRuleGroupCommand.ts +++ b/clients/client-route53resolver/commands/DeleteFirewallRuleGroupCommand.ts @@ -22,6 +22,20 @@ export interface DeleteFirewallRuleGroupCommandOutput extends DeleteFirewallRule /** *

Deletes the specified firewall rule group.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { Route53ResolverClient, DeleteFirewallRuleGroupCommand } from "@aws-sdk/client-route53resolver"; // ES Modules import + * // const { Route53ResolverClient, DeleteFirewallRuleGroupCommand } = require("@aws-sdk/client-route53resolver"); // CommonJS import + * const client = new Route53ResolverClient(config); + * const command = new DeleteFirewallRuleGroupCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteFirewallRuleGroupCommandInput} for command's `input` shape. + * @see {@link DeleteFirewallRuleGroupCommandOutput} for command's `response` shape. + * @see {@link Route53ResolverClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteFirewallRuleGroupCommand extends $Command< DeleteFirewallRuleGroupCommandInput, diff --git a/clients/client-route53resolver/commands/DeleteResolverEndpointCommand.ts b/clients/client-route53resolver/commands/DeleteResolverEndpointCommand.ts index cd54db36c9c7..cdda90446688 100644 --- a/clients/client-route53resolver/commands/DeleteResolverEndpointCommand.ts +++ b/clients/client-route53resolver/commands/DeleteResolverEndpointCommand.ts @@ -34,6 +34,20 @@ export interface DeleteResolverEndpointCommandOutput extends DeleteResolverEndpo * Outbound: DNS queries from a VPC are no longer routed to your network.

* * + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { Route53ResolverClient, DeleteResolverEndpointCommand } from "@aws-sdk/client-route53resolver"; // ES Modules import + * // const { Route53ResolverClient, DeleteResolverEndpointCommand } = require("@aws-sdk/client-route53resolver"); // CommonJS import + * const client = new Route53ResolverClient(config); + * const command = new DeleteResolverEndpointCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteResolverEndpointCommandInput} for command's `input` shape. + * @see {@link DeleteResolverEndpointCommandOutput} for command's `response` shape. + * @see {@link Route53ResolverClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteResolverEndpointCommand extends $Command< DeleteResolverEndpointCommandInput, diff --git a/clients/client-route53resolver/commands/DeleteResolverQueryLogConfigCommand.ts b/clients/client-route53resolver/commands/DeleteResolverQueryLogConfigCommand.ts index f69f7bd57106..04e2a7a3452a 100644 --- a/clients/client-route53resolver/commands/DeleteResolverQueryLogConfigCommand.ts +++ b/clients/client-route53resolver/commands/DeleteResolverQueryLogConfigCommand.ts @@ -34,6 +34,20 @@ export interface DeleteResolverQueryLogConfigCommandOutput * 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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { Route53ResolverClient, DeleteResolverQueryLogConfigCommand } from "@aws-sdk/client-route53resolver"; // ES Modules import + * // const { Route53ResolverClient, DeleteResolverQueryLogConfigCommand } = require("@aws-sdk/client-route53resolver"); // CommonJS import + * const client = new Route53ResolverClient(config); + * const command = new DeleteResolverQueryLogConfigCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteResolverQueryLogConfigCommandInput} for command's `input` shape. + * @see {@link DeleteResolverQueryLogConfigCommandOutput} for command's `response` shape. + * @see {@link Route53ResolverClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteResolverQueryLogConfigCommand extends $Command< DeleteResolverQueryLogConfigCommandInput, diff --git a/clients/client-route53resolver/commands/DeleteResolverRuleCommand.ts b/clients/client-route53resolver/commands/DeleteResolverRuleCommand.ts index 37ebd91c0e0a..935e6bbd8921 100644 --- a/clients/client-route53resolver/commands/DeleteResolverRuleCommand.ts +++ b/clients/client-route53resolver/commands/DeleteResolverRuleCommand.ts @@ -24,6 +24,20 @@ export interface DeleteResolverRuleCommandOutput extends DeleteResolverRuleRespo *

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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { Route53ResolverClient, DeleteResolverRuleCommand } from "@aws-sdk/client-route53resolver"; // ES Modules import + * // const { Route53ResolverClient, DeleteResolverRuleCommand } = require("@aws-sdk/client-route53resolver"); // CommonJS import + * const client = new Route53ResolverClient(config); + * const command = new DeleteResolverRuleCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteResolverRuleCommandInput} for command's `input` shape. + * @see {@link DeleteResolverRuleCommandOutput} for command's `response` shape. + * @see {@link Route53ResolverClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteResolverRuleCommand extends $Command< DeleteResolverRuleCommandInput, diff --git a/clients/client-route53resolver/commands/DisassociateFirewallRuleGroupCommand.ts b/clients/client-route53resolver/commands/DisassociateFirewallRuleGroupCommand.ts index 225cd845ad36..62d2bea9a3b3 100644 --- a/clients/client-route53resolver/commands/DisassociateFirewallRuleGroupCommand.ts +++ b/clients/client-route53resolver/commands/DisassociateFirewallRuleGroupCommand.ts @@ -24,6 +24,20 @@ export interface DisassociateFirewallRuleGroupCommandOutput /** *

Disassociates a FirewallRuleGroup from a VPC, to remove DNS filtering from the VPC.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { Route53ResolverClient, DisassociateFirewallRuleGroupCommand } from "@aws-sdk/client-route53resolver"; // ES Modules import + * // const { Route53ResolverClient, DisassociateFirewallRuleGroupCommand } = require("@aws-sdk/client-route53resolver"); // CommonJS import + * const client = new Route53ResolverClient(config); + * const command = new DisassociateFirewallRuleGroupCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DisassociateFirewallRuleGroupCommandInput} for command's `input` shape. + * @see {@link DisassociateFirewallRuleGroupCommandOutput} for command's `response` shape. + * @see {@link Route53ResolverClientResolvedConfig | config} for command's `input` shape. + * */ export class DisassociateFirewallRuleGroupCommand extends $Command< DisassociateFirewallRuleGroupCommandInput, diff --git a/clients/client-route53resolver/commands/DisassociateResolverEndpointIpAddressCommand.ts b/clients/client-route53resolver/commands/DisassociateResolverEndpointIpAddressCommand.ts index 872834be9fe0..1dc0a97ad852 100644 --- a/clients/client-route53resolver/commands/DisassociateResolverEndpointIpAddressCommand.ts +++ b/clients/client-route53resolver/commands/DisassociateResolverEndpointIpAddressCommand.ts @@ -32,6 +32,20 @@ export interface DisassociateResolverEndpointIpAddressCommandOutput *

To add an IP address to an endpoint, see * AssociateResolverEndpointIpAddress. *

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { Route53ResolverClient, DisassociateResolverEndpointIpAddressCommand } from "@aws-sdk/client-route53resolver"; // ES Modules import + * // const { Route53ResolverClient, DisassociateResolverEndpointIpAddressCommand } = require("@aws-sdk/client-route53resolver"); // CommonJS import + * const client = new Route53ResolverClient(config); + * const command = new DisassociateResolverEndpointIpAddressCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DisassociateResolverEndpointIpAddressCommandInput} for command's `input` shape. + * @see {@link DisassociateResolverEndpointIpAddressCommandOutput} for command's `response` shape. + * @see {@link Route53ResolverClientResolvedConfig | config} for command's `input` shape. + * */ export class DisassociateResolverEndpointIpAddressCommand extends $Command< DisassociateResolverEndpointIpAddressCommandInput, diff --git a/clients/client-route53resolver/commands/DisassociateResolverQueryLogConfigCommand.ts b/clients/client-route53resolver/commands/DisassociateResolverQueryLogConfigCommand.ts index f6e645586f75..a6798f633e5a 100644 --- a/clients/client-route53resolver/commands/DisassociateResolverQueryLogConfigCommand.ts +++ b/clients/client-route53resolver/commands/DisassociateResolverQueryLogConfigCommand.ts @@ -41,6 +41,20 @@ export interface DisassociateResolverQueryLogConfigCommandOutput * * * + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { Route53ResolverClient, DisassociateResolverQueryLogConfigCommand } from "@aws-sdk/client-route53resolver"; // ES Modules import + * // const { Route53ResolverClient, DisassociateResolverQueryLogConfigCommand } = require("@aws-sdk/client-route53resolver"); // CommonJS import + * const client = new Route53ResolverClient(config); + * const command = new DisassociateResolverQueryLogConfigCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DisassociateResolverQueryLogConfigCommandInput} for command's `input` shape. + * @see {@link DisassociateResolverQueryLogConfigCommandOutput} for command's `response` shape. + * @see {@link Route53ResolverClientResolvedConfig | config} for command's `input` shape. + * */ export class DisassociateResolverQueryLogConfigCommand extends $Command< DisassociateResolverQueryLogConfigCommandInput, diff --git a/clients/client-route53resolver/commands/DisassociateResolverRuleCommand.ts b/clients/client-route53resolver/commands/DisassociateResolverRuleCommand.ts index 2a9e1cf777b4..a7508c222bfe 100644 --- a/clients/client-route53resolver/commands/DisassociateResolverRuleCommand.ts +++ b/clients/client-route53resolver/commands/DisassociateResolverRuleCommand.ts @@ -26,6 +26,20 @@ export interface DisassociateResolverRuleCommandOutput extends DisassociateResol *

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.

* + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { Route53ResolverClient, DisassociateResolverRuleCommand } from "@aws-sdk/client-route53resolver"; // ES Modules import + * // const { Route53ResolverClient, DisassociateResolverRuleCommand } = require("@aws-sdk/client-route53resolver"); // CommonJS import + * const client = new Route53ResolverClient(config); + * const command = new DisassociateResolverRuleCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DisassociateResolverRuleCommandInput} for command's `input` shape. + * @see {@link DisassociateResolverRuleCommandOutput} for command's `response` shape. + * @see {@link Route53ResolverClientResolvedConfig | config} for command's `input` shape. + * */ export class DisassociateResolverRuleCommand extends $Command< DisassociateResolverRuleCommandInput, diff --git a/clients/client-route53resolver/commands/GetFirewallConfigCommand.ts b/clients/client-route53resolver/commands/GetFirewallConfigCommand.ts index b2f4e39f9547..4b73fb86ba20 100644 --- a/clients/client-route53resolver/commands/GetFirewallConfigCommand.ts +++ b/clients/client-route53resolver/commands/GetFirewallConfigCommand.ts @@ -22,6 +22,20 @@ export interface GetFirewallConfigCommandOutput extends GetFirewallConfigRespons /** *

Retrieves the configuration of the firewall behavior provided by DNS Firewall for a single Amazon virtual private cloud (VPC).

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { Route53ResolverClient, GetFirewallConfigCommand } from "@aws-sdk/client-route53resolver"; // ES Modules import + * // const { Route53ResolverClient, GetFirewallConfigCommand } = require("@aws-sdk/client-route53resolver"); // CommonJS import + * const client = new Route53ResolverClient(config); + * const command = new GetFirewallConfigCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetFirewallConfigCommandInput} for command's `input` shape. + * @see {@link GetFirewallConfigCommandOutput} for command's `response` shape. + * @see {@link Route53ResolverClientResolvedConfig | config} for command's `input` shape. + * */ export class GetFirewallConfigCommand extends $Command< GetFirewallConfigCommandInput, diff --git a/clients/client-route53resolver/commands/GetFirewallDomainListCommand.ts b/clients/client-route53resolver/commands/GetFirewallDomainListCommand.ts index 7dc983c51009..9f49cf684ef4 100644 --- a/clients/client-route53resolver/commands/GetFirewallDomainListCommand.ts +++ b/clients/client-route53resolver/commands/GetFirewallDomainListCommand.ts @@ -22,6 +22,20 @@ export interface GetFirewallDomainListCommandOutput extends GetFirewallDomainLis /** *

Retrieves the specified firewall domain list.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { Route53ResolverClient, GetFirewallDomainListCommand } from "@aws-sdk/client-route53resolver"; // ES Modules import + * // const { Route53ResolverClient, GetFirewallDomainListCommand } = require("@aws-sdk/client-route53resolver"); // CommonJS import + * const client = new Route53ResolverClient(config); + * const command = new GetFirewallDomainListCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetFirewallDomainListCommandInput} for command's `input` shape. + * @see {@link GetFirewallDomainListCommandOutput} for command's `response` shape. + * @see {@link Route53ResolverClientResolvedConfig | config} for command's `input` shape. + * */ export class GetFirewallDomainListCommand extends $Command< GetFirewallDomainListCommandInput, diff --git a/clients/client-route53resolver/commands/GetFirewallRuleGroupAssociationCommand.ts b/clients/client-route53resolver/commands/GetFirewallRuleGroupAssociationCommand.ts index eb667811cae0..42e10dadfd92 100644 --- a/clients/client-route53resolver/commands/GetFirewallRuleGroupAssociationCommand.ts +++ b/clients/client-route53resolver/commands/GetFirewallRuleGroupAssociationCommand.ts @@ -24,6 +24,20 @@ export interface GetFirewallRuleGroupAssociationCommandOutput /** *

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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { Route53ResolverClient, GetFirewallRuleGroupAssociationCommand } from "@aws-sdk/client-route53resolver"; // ES Modules import + * // const { Route53ResolverClient, GetFirewallRuleGroupAssociationCommand } = require("@aws-sdk/client-route53resolver"); // CommonJS import + * const client = new Route53ResolverClient(config); + * const command = new GetFirewallRuleGroupAssociationCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetFirewallRuleGroupAssociationCommandInput} for command's `input` shape. + * @see {@link GetFirewallRuleGroupAssociationCommandOutput} for command's `response` shape. + * @see {@link Route53ResolverClientResolvedConfig | config} for command's `input` shape. + * */ export class GetFirewallRuleGroupAssociationCommand extends $Command< GetFirewallRuleGroupAssociationCommandInput, diff --git a/clients/client-route53resolver/commands/GetFirewallRuleGroupCommand.ts b/clients/client-route53resolver/commands/GetFirewallRuleGroupCommand.ts index 1608e0e2123a..a682b514a2d3 100644 --- a/clients/client-route53resolver/commands/GetFirewallRuleGroupCommand.ts +++ b/clients/client-route53resolver/commands/GetFirewallRuleGroupCommand.ts @@ -22,6 +22,20 @@ export interface GetFirewallRuleGroupCommandOutput extends GetFirewallRuleGroupR /** *

Retrieves the specified firewall rule group.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { Route53ResolverClient, GetFirewallRuleGroupCommand } from "@aws-sdk/client-route53resolver"; // ES Modules import + * // const { Route53ResolverClient, GetFirewallRuleGroupCommand } = require("@aws-sdk/client-route53resolver"); // CommonJS import + * const client = new Route53ResolverClient(config); + * const command = new GetFirewallRuleGroupCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetFirewallRuleGroupCommandInput} for command's `input` shape. + * @see {@link GetFirewallRuleGroupCommandOutput} for command's `response` shape. + * @see {@link Route53ResolverClientResolvedConfig | config} for command's `input` shape. + * */ export class GetFirewallRuleGroupCommand extends $Command< GetFirewallRuleGroupCommandInput, diff --git a/clients/client-route53resolver/commands/GetFirewallRuleGroupPolicyCommand.ts b/clients/client-route53resolver/commands/GetFirewallRuleGroupPolicyCommand.ts index e3b4b86da2ff..2a104865f9ec 100644 --- a/clients/client-route53resolver/commands/GetFirewallRuleGroupPolicyCommand.ts +++ b/clients/client-route53resolver/commands/GetFirewallRuleGroupPolicyCommand.ts @@ -22,6 +22,20 @@ export interface GetFirewallRuleGroupPolicyCommandOutput extends GetFirewallRule /** *

Returns the AWS Identity and Access Management (AWS IAM) policy for sharing the specified rule group. You can use the policy to share the rule group using AWS Resource Access Manager (RAM).

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { Route53ResolverClient, GetFirewallRuleGroupPolicyCommand } from "@aws-sdk/client-route53resolver"; // ES Modules import + * // const { Route53ResolverClient, GetFirewallRuleGroupPolicyCommand } = require("@aws-sdk/client-route53resolver"); // CommonJS import + * const client = new Route53ResolverClient(config); + * const command = new GetFirewallRuleGroupPolicyCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetFirewallRuleGroupPolicyCommandInput} for command's `input` shape. + * @see {@link GetFirewallRuleGroupPolicyCommandOutput} for command's `response` shape. + * @see {@link Route53ResolverClientResolvedConfig | config} for command's `input` shape. + * */ export class GetFirewallRuleGroupPolicyCommand extends $Command< GetFirewallRuleGroupPolicyCommandInput, diff --git a/clients/client-route53resolver/commands/GetResolverDnssecConfigCommand.ts b/clients/client-route53resolver/commands/GetResolverDnssecConfigCommand.ts index f7690359ff8e..c01770d13475 100644 --- a/clients/client-route53resolver/commands/GetResolverDnssecConfigCommand.ts +++ b/clients/client-route53resolver/commands/GetResolverDnssecConfigCommand.ts @@ -22,6 +22,20 @@ export interface GetResolverDnssecConfigCommandOutput extends GetResolverDnssecC /** *

Gets DNSSEC validation information for a specified resource.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { Route53ResolverClient, GetResolverDnssecConfigCommand } from "@aws-sdk/client-route53resolver"; // ES Modules import + * // const { Route53ResolverClient, GetResolverDnssecConfigCommand } = require("@aws-sdk/client-route53resolver"); // CommonJS import + * const client = new Route53ResolverClient(config); + * const command = new GetResolverDnssecConfigCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetResolverDnssecConfigCommandInput} for command's `input` shape. + * @see {@link GetResolverDnssecConfigCommandOutput} for command's `response` shape. + * @see {@link Route53ResolverClientResolvedConfig | config} for command's `input` shape. + * */ export class GetResolverDnssecConfigCommand extends $Command< GetResolverDnssecConfigCommandInput, diff --git a/clients/client-route53resolver/commands/GetResolverEndpointCommand.ts b/clients/client-route53resolver/commands/GetResolverEndpointCommand.ts index be71d30fbcc3..b89aacb2750d 100644 --- a/clients/client-route53resolver/commands/GetResolverEndpointCommand.ts +++ b/clients/client-route53resolver/commands/GetResolverEndpointCommand.ts @@ -23,6 +23,20 @@ export interface GetResolverEndpointCommandOutput extends GetResolverEndpointRes /** *

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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { Route53ResolverClient, GetResolverEndpointCommand } from "@aws-sdk/client-route53resolver"; // ES Modules import + * // const { Route53ResolverClient, GetResolverEndpointCommand } = require("@aws-sdk/client-route53resolver"); // CommonJS import + * const client = new Route53ResolverClient(config); + * const command = new GetResolverEndpointCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetResolverEndpointCommandInput} for command's `input` shape. + * @see {@link GetResolverEndpointCommandOutput} for command's `response` shape. + * @see {@link Route53ResolverClientResolvedConfig | config} for command's `input` shape. + * */ export class GetResolverEndpointCommand extends $Command< GetResolverEndpointCommandInput, diff --git a/clients/client-route53resolver/commands/GetResolverQueryLogConfigAssociationCommand.ts b/clients/client-route53resolver/commands/GetResolverQueryLogConfigAssociationCommand.ts index b692d51cbb83..7c31c92d4955 100644 --- a/clients/client-route53resolver/commands/GetResolverQueryLogConfigAssociationCommand.ts +++ b/clients/client-route53resolver/commands/GetResolverQueryLogConfigAssociationCommand.ts @@ -28,6 +28,20 @@ export interface GetResolverQueryLogConfigAssociationCommandOutput /** *

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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { Route53ResolverClient, GetResolverQueryLogConfigAssociationCommand } from "@aws-sdk/client-route53resolver"; // ES Modules import + * // const { Route53ResolverClient, GetResolverQueryLogConfigAssociationCommand } = require("@aws-sdk/client-route53resolver"); // CommonJS import + * const client = new Route53ResolverClient(config); + * const command = new GetResolverQueryLogConfigAssociationCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetResolverQueryLogConfigAssociationCommandInput} for command's `input` shape. + * @see {@link GetResolverQueryLogConfigAssociationCommandOutput} for command's `response` shape. + * @see {@link Route53ResolverClientResolvedConfig | config} for command's `input` shape. + * */ export class GetResolverQueryLogConfigAssociationCommand extends $Command< GetResolverQueryLogConfigAssociationCommandInput, diff --git a/clients/client-route53resolver/commands/GetResolverQueryLogConfigCommand.ts b/clients/client-route53resolver/commands/GetResolverQueryLogConfigCommand.ts index 2de611e20f77..611fa505f7c6 100644 --- a/clients/client-route53resolver/commands/GetResolverQueryLogConfigCommand.ts +++ b/clients/client-route53resolver/commands/GetResolverQueryLogConfigCommand.ts @@ -23,6 +23,20 @@ export interface GetResolverQueryLogConfigCommandOutput extends GetResolverQuery /** *

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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { Route53ResolverClient, GetResolverQueryLogConfigCommand } from "@aws-sdk/client-route53resolver"; // ES Modules import + * // const { Route53ResolverClient, GetResolverQueryLogConfigCommand } = require("@aws-sdk/client-route53resolver"); // CommonJS import + * const client = new Route53ResolverClient(config); + * const command = new GetResolverQueryLogConfigCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetResolverQueryLogConfigCommandInput} for command's `input` shape. + * @see {@link GetResolverQueryLogConfigCommandOutput} for command's `response` shape. + * @see {@link Route53ResolverClientResolvedConfig | config} for command's `input` shape. + * */ export class GetResolverQueryLogConfigCommand extends $Command< GetResolverQueryLogConfigCommandInput, diff --git a/clients/client-route53resolver/commands/GetResolverQueryLogConfigPolicyCommand.ts b/clients/client-route53resolver/commands/GetResolverQueryLogConfigPolicyCommand.ts index b4925a8ccc00..1f989cd4b2f0 100644 --- a/clients/client-route53resolver/commands/GetResolverQueryLogConfigPolicyCommand.ts +++ b/clients/client-route53resolver/commands/GetResolverQueryLogConfigPolicyCommand.ts @@ -25,6 +25,20 @@ export interface GetResolverQueryLogConfigPolicyCommandOutput /** *

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 AWS account to be able to use.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { Route53ResolverClient, GetResolverQueryLogConfigPolicyCommand } from "@aws-sdk/client-route53resolver"; // ES Modules import + * // const { Route53ResolverClient, GetResolverQueryLogConfigPolicyCommand } = require("@aws-sdk/client-route53resolver"); // CommonJS import + * const client = new Route53ResolverClient(config); + * const command = new GetResolverQueryLogConfigPolicyCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetResolverQueryLogConfigPolicyCommandInput} for command's `input` shape. + * @see {@link GetResolverQueryLogConfigPolicyCommandOutput} for command's `response` shape. + * @see {@link Route53ResolverClientResolvedConfig | config} for command's `input` shape. + * */ export class GetResolverQueryLogConfigPolicyCommand extends $Command< GetResolverQueryLogConfigPolicyCommandInput, diff --git a/clients/client-route53resolver/commands/GetResolverRuleAssociationCommand.ts b/clients/client-route53resolver/commands/GetResolverRuleAssociationCommand.ts index 0af6b6dbf711..c194021bd1e7 100644 --- a/clients/client-route53resolver/commands/GetResolverRuleAssociationCommand.ts +++ b/clients/client-route53resolver/commands/GetResolverRuleAssociationCommand.ts @@ -23,6 +23,20 @@ export interface GetResolverRuleAssociationCommandOutput extends GetResolverRule /** *

Gets information about an association between a specified Resolver rule and a VPC. You associate a Resolver rule and a VPC using * AssociateResolverRule.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { Route53ResolverClient, GetResolverRuleAssociationCommand } from "@aws-sdk/client-route53resolver"; // ES Modules import + * // const { Route53ResolverClient, GetResolverRuleAssociationCommand } = require("@aws-sdk/client-route53resolver"); // CommonJS import + * const client = new Route53ResolverClient(config); + * const command = new GetResolverRuleAssociationCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetResolverRuleAssociationCommandInput} for command's `input` shape. + * @see {@link GetResolverRuleAssociationCommandOutput} for command's `response` shape. + * @see {@link Route53ResolverClientResolvedConfig | config} for command's `input` shape. + * */ export class GetResolverRuleAssociationCommand extends $Command< GetResolverRuleAssociationCommandInput, diff --git a/clients/client-route53resolver/commands/GetResolverRuleCommand.ts b/clients/client-route53resolver/commands/GetResolverRuleCommand.ts index 23afd5a79625..be9f4b8b8ae1 100644 --- a/clients/client-route53resolver/commands/GetResolverRuleCommand.ts +++ b/clients/client-route53resolver/commands/GetResolverRuleCommand.ts @@ -23,6 +23,20 @@ export interface GetResolverRuleCommandOutput extends GetResolverRuleResponse, _ /** *

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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { Route53ResolverClient, GetResolverRuleCommand } from "@aws-sdk/client-route53resolver"; // ES Modules import + * // const { Route53ResolverClient, GetResolverRuleCommand } = require("@aws-sdk/client-route53resolver"); // CommonJS import + * const client = new Route53ResolverClient(config); + * const command = new GetResolverRuleCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetResolverRuleCommandInput} for command's `input` shape. + * @see {@link GetResolverRuleCommandOutput} for command's `response` shape. + * @see {@link Route53ResolverClientResolvedConfig | config} for command's `input` shape. + * */ export class GetResolverRuleCommand extends $Command< GetResolverRuleCommandInput, diff --git a/clients/client-route53resolver/commands/GetResolverRulePolicyCommand.ts b/clients/client-route53resolver/commands/GetResolverRulePolicyCommand.ts index 7e0abba57711..799ffc0b1357 100644 --- a/clients/client-route53resolver/commands/GetResolverRulePolicyCommand.ts +++ b/clients/client-route53resolver/commands/GetResolverRulePolicyCommand.ts @@ -23,6 +23,20 @@ export interface GetResolverRulePolicyCommandOutput extends GetResolverRulePolic /** *

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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { Route53ResolverClient, GetResolverRulePolicyCommand } from "@aws-sdk/client-route53resolver"; // ES Modules import + * // const { Route53ResolverClient, GetResolverRulePolicyCommand } = require("@aws-sdk/client-route53resolver"); // CommonJS import + * const client = new Route53ResolverClient(config); + * const command = new GetResolverRulePolicyCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetResolverRulePolicyCommandInput} for command's `input` shape. + * @see {@link GetResolverRulePolicyCommandOutput} for command's `response` shape. + * @see {@link Route53ResolverClientResolvedConfig | config} for command's `input` shape. + * */ export class GetResolverRulePolicyCommand extends $Command< GetResolverRulePolicyCommandInput, diff --git a/clients/client-route53resolver/commands/ImportFirewallDomainsCommand.ts b/clients/client-route53resolver/commands/ImportFirewallDomainsCommand.ts index d33047ea1ab4..3e4fe74089ad 100644 --- a/clients/client-route53resolver/commands/ImportFirewallDomainsCommand.ts +++ b/clients/client-route53resolver/commands/ImportFirewallDomainsCommand.ts @@ -37,6 +37,20 @@ export interface ImportFirewallDomainsCommandOutput extends ImportFirewallDomain *

It must be from 1-255 characters in length.

* * + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { Route53ResolverClient, ImportFirewallDomainsCommand } from "@aws-sdk/client-route53resolver"; // ES Modules import + * // const { Route53ResolverClient, ImportFirewallDomainsCommand } = require("@aws-sdk/client-route53resolver"); // CommonJS import + * const client = new Route53ResolverClient(config); + * const command = new ImportFirewallDomainsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ImportFirewallDomainsCommandInput} for command's `input` shape. + * @see {@link ImportFirewallDomainsCommandOutput} for command's `response` shape. + * @see {@link Route53ResolverClientResolvedConfig | config} for command's `input` shape. + * */ export class ImportFirewallDomainsCommand extends $Command< ImportFirewallDomainsCommandInput, diff --git a/clients/client-route53resolver/commands/ListFirewallConfigsCommand.ts b/clients/client-route53resolver/commands/ListFirewallConfigsCommand.ts index 77cb1a9e64b0..ebb1b1bde622 100644 --- a/clients/client-route53resolver/commands/ListFirewallConfigsCommand.ts +++ b/clients/client-route53resolver/commands/ListFirewallConfigsCommand.ts @@ -23,6 +23,20 @@ export interface ListFirewallConfigsCommandOutput extends ListFirewallConfigsRes /** *

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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { Route53ResolverClient, ListFirewallConfigsCommand } from "@aws-sdk/client-route53resolver"; // ES Modules import + * // const { Route53ResolverClient, ListFirewallConfigsCommand } = require("@aws-sdk/client-route53resolver"); // CommonJS import + * const client = new Route53ResolverClient(config); + * const command = new ListFirewallConfigsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListFirewallConfigsCommandInput} for command's `input` shape. + * @see {@link ListFirewallConfigsCommandOutput} for command's `response` shape. + * @see {@link Route53ResolverClientResolvedConfig | config} for command's `input` shape. + * */ export class ListFirewallConfigsCommand extends $Command< ListFirewallConfigsCommandInput, diff --git a/clients/client-route53resolver/commands/ListFirewallDomainListsCommand.ts b/clients/client-route53resolver/commands/ListFirewallDomainListsCommand.ts index c56394bb8db8..20cfb9244633 100644 --- a/clients/client-route53resolver/commands/ListFirewallDomainListsCommand.ts +++ b/clients/client-route53resolver/commands/ListFirewallDomainListsCommand.ts @@ -23,6 +23,20 @@ export interface ListFirewallDomainListsCommandOutput extends ListFirewallDomain /** *

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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { Route53ResolverClient, ListFirewallDomainListsCommand } from "@aws-sdk/client-route53resolver"; // ES Modules import + * // const { Route53ResolverClient, ListFirewallDomainListsCommand } = require("@aws-sdk/client-route53resolver"); // CommonJS import + * const client = new Route53ResolverClient(config); + * const command = new ListFirewallDomainListsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListFirewallDomainListsCommandInput} for command's `input` shape. + * @see {@link ListFirewallDomainListsCommandOutput} for command's `response` shape. + * @see {@link Route53ResolverClientResolvedConfig | config} for command's `input` shape. + * */ export class ListFirewallDomainListsCommand extends $Command< ListFirewallDomainListsCommandInput, diff --git a/clients/client-route53resolver/commands/ListFirewallDomainsCommand.ts b/clients/client-route53resolver/commands/ListFirewallDomainsCommand.ts index 803be731a1bf..7d91c69451b7 100644 --- a/clients/client-route53resolver/commands/ListFirewallDomainsCommand.ts +++ b/clients/client-route53resolver/commands/ListFirewallDomainsCommand.ts @@ -23,6 +23,20 @@ export interface ListFirewallDomainsCommandOutput extends ListFirewallDomainsRes /** *

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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { Route53ResolverClient, ListFirewallDomainsCommand } from "@aws-sdk/client-route53resolver"; // ES Modules import + * // const { Route53ResolverClient, ListFirewallDomainsCommand } = require("@aws-sdk/client-route53resolver"); // CommonJS import + * const client = new Route53ResolverClient(config); + * const command = new ListFirewallDomainsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListFirewallDomainsCommandInput} for command's `input` shape. + * @see {@link ListFirewallDomainsCommandOutput} for command's `response` shape. + * @see {@link Route53ResolverClientResolvedConfig | config} for command's `input` shape. + * */ export class ListFirewallDomainsCommand extends $Command< ListFirewallDomainsCommandInput, diff --git a/clients/client-route53resolver/commands/ListFirewallRuleGroupAssociationsCommand.ts b/clients/client-route53resolver/commands/ListFirewallRuleGroupAssociationsCommand.ts index 5a36c359ebdf..af54f78650dd 100644 --- a/clients/client-route53resolver/commands/ListFirewallRuleGroupAssociationsCommand.ts +++ b/clients/client-route53resolver/commands/ListFirewallRuleGroupAssociationsCommand.ts @@ -28,6 +28,20 @@ export interface ListFirewallRuleGroupAssociationsCommandOutput /** *

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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { Route53ResolverClient, ListFirewallRuleGroupAssociationsCommand } from "@aws-sdk/client-route53resolver"; // ES Modules import + * // const { Route53ResolverClient, ListFirewallRuleGroupAssociationsCommand } = require("@aws-sdk/client-route53resolver"); // CommonJS import + * const client = new Route53ResolverClient(config); + * const command = new ListFirewallRuleGroupAssociationsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListFirewallRuleGroupAssociationsCommandInput} for command's `input` shape. + * @see {@link ListFirewallRuleGroupAssociationsCommandOutput} for command's `response` shape. + * @see {@link Route53ResolverClientResolvedConfig | config} for command's `input` shape. + * */ export class ListFirewallRuleGroupAssociationsCommand extends $Command< ListFirewallRuleGroupAssociationsCommandInput, diff --git a/clients/client-route53resolver/commands/ListFirewallRuleGroupsCommand.ts b/clients/client-route53resolver/commands/ListFirewallRuleGroupsCommand.ts index 8de9a21289f6..399124993c42 100644 --- a/clients/client-route53resolver/commands/ListFirewallRuleGroupsCommand.ts +++ b/clients/client-route53resolver/commands/ListFirewallRuleGroupsCommand.ts @@ -23,6 +23,20 @@ export interface ListFirewallRuleGroupsCommandOutput extends ListFirewallRuleGro /** *

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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { Route53ResolverClient, ListFirewallRuleGroupsCommand } from "@aws-sdk/client-route53resolver"; // ES Modules import + * // const { Route53ResolverClient, ListFirewallRuleGroupsCommand } = require("@aws-sdk/client-route53resolver"); // CommonJS import + * const client = new Route53ResolverClient(config); + * const command = new ListFirewallRuleGroupsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListFirewallRuleGroupsCommandInput} for command's `input` shape. + * @see {@link ListFirewallRuleGroupsCommandOutput} for command's `response` shape. + * @see {@link Route53ResolverClientResolvedConfig | config} for command's `input` shape. + * */ export class ListFirewallRuleGroupsCommand extends $Command< ListFirewallRuleGroupsCommandInput, diff --git a/clients/client-route53resolver/commands/ListFirewallRulesCommand.ts b/clients/client-route53resolver/commands/ListFirewallRulesCommand.ts index b3a94e8d80f3..180d12068899 100644 --- a/clients/client-route53resolver/commands/ListFirewallRulesCommand.ts +++ b/clients/client-route53resolver/commands/ListFirewallRulesCommand.ts @@ -23,6 +23,20 @@ export interface ListFirewallRulesCommandOutput extends ListFirewallRulesRespons /** *

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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { Route53ResolverClient, ListFirewallRulesCommand } from "@aws-sdk/client-route53resolver"; // ES Modules import + * // const { Route53ResolverClient, ListFirewallRulesCommand } = require("@aws-sdk/client-route53resolver"); // CommonJS import + * const client = new Route53ResolverClient(config); + * const command = new ListFirewallRulesCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListFirewallRulesCommandInput} for command's `input` shape. + * @see {@link ListFirewallRulesCommandOutput} for command's `response` shape. + * @see {@link Route53ResolverClientResolvedConfig | config} for command's `input` shape. + * */ export class ListFirewallRulesCommand extends $Command< ListFirewallRulesCommandInput, diff --git a/clients/client-route53resolver/commands/ListResolverDnssecConfigsCommand.ts b/clients/client-route53resolver/commands/ListResolverDnssecConfigsCommand.ts index c7544bfffdd5..64bba637adc9 100644 --- a/clients/client-route53resolver/commands/ListResolverDnssecConfigsCommand.ts +++ b/clients/client-route53resolver/commands/ListResolverDnssecConfigsCommand.ts @@ -22,6 +22,20 @@ export interface ListResolverDnssecConfigsCommandOutput extends ListResolverDnss /** *

Lists the configurations for DNSSEC validation that are associated with the current AWS account.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { Route53ResolverClient, ListResolverDnssecConfigsCommand } from "@aws-sdk/client-route53resolver"; // ES Modules import + * // const { Route53ResolverClient, ListResolverDnssecConfigsCommand } = require("@aws-sdk/client-route53resolver"); // CommonJS import + * const client = new Route53ResolverClient(config); + * const command = new ListResolverDnssecConfigsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListResolverDnssecConfigsCommandInput} for command's `input` shape. + * @see {@link ListResolverDnssecConfigsCommandOutput} for command's `response` shape. + * @see {@link Route53ResolverClientResolvedConfig | config} for command's `input` shape. + * */ export class ListResolverDnssecConfigsCommand extends $Command< ListResolverDnssecConfigsCommandInput, diff --git a/clients/client-route53resolver/commands/ListResolverEndpointIpAddressesCommand.ts b/clients/client-route53resolver/commands/ListResolverEndpointIpAddressesCommand.ts index a261d454ee62..42d0e5ff95ba 100644 --- a/clients/client-route53resolver/commands/ListResolverEndpointIpAddressesCommand.ts +++ b/clients/client-route53resolver/commands/ListResolverEndpointIpAddressesCommand.ts @@ -24,6 +24,20 @@ export interface ListResolverEndpointIpAddressesCommandOutput /** *

Gets the IP addresses for a specified Resolver endpoint.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { Route53ResolverClient, ListResolverEndpointIpAddressesCommand } from "@aws-sdk/client-route53resolver"; // ES Modules import + * // const { Route53ResolverClient, ListResolverEndpointIpAddressesCommand } = require("@aws-sdk/client-route53resolver"); // CommonJS import + * const client = new Route53ResolverClient(config); + * const command = new ListResolverEndpointIpAddressesCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListResolverEndpointIpAddressesCommandInput} for command's `input` shape. + * @see {@link ListResolverEndpointIpAddressesCommandOutput} for command's `response` shape. + * @see {@link Route53ResolverClientResolvedConfig | config} for command's `input` shape. + * */ export class ListResolverEndpointIpAddressesCommand extends $Command< ListResolverEndpointIpAddressesCommandInput, diff --git a/clients/client-route53resolver/commands/ListResolverEndpointsCommand.ts b/clients/client-route53resolver/commands/ListResolverEndpointsCommand.ts index 98ae7cd4b02e..a12fd8bf0b3d 100644 --- a/clients/client-route53resolver/commands/ListResolverEndpointsCommand.ts +++ b/clients/client-route53resolver/commands/ListResolverEndpointsCommand.ts @@ -22,6 +22,20 @@ export interface ListResolverEndpointsCommandOutput extends ListResolverEndpoint /** *

Lists all the Resolver endpoints that were created using the current AWS account.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { Route53ResolverClient, ListResolverEndpointsCommand } from "@aws-sdk/client-route53resolver"; // ES Modules import + * // const { Route53ResolverClient, ListResolverEndpointsCommand } = require("@aws-sdk/client-route53resolver"); // CommonJS import + * const client = new Route53ResolverClient(config); + * const command = new ListResolverEndpointsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListResolverEndpointsCommandInput} for command's `input` shape. + * @see {@link ListResolverEndpointsCommandOutput} for command's `response` shape. + * @see {@link Route53ResolverClientResolvedConfig | config} for command's `input` shape. + * */ export class ListResolverEndpointsCommand extends $Command< ListResolverEndpointsCommandInput, diff --git a/clients/client-route53resolver/commands/ListResolverQueryLogConfigAssociationsCommand.ts b/clients/client-route53resolver/commands/ListResolverQueryLogConfigAssociationsCommand.ts index af1e7492ad4f..39221433eb61 100644 --- a/clients/client-route53resolver/commands/ListResolverQueryLogConfigAssociationsCommand.ts +++ b/clients/client-route53resolver/commands/ListResolverQueryLogConfigAssociationsCommand.ts @@ -28,6 +28,20 @@ export interface ListResolverQueryLogConfigAssociationsCommandOutput /** *

Lists information about associations between Amazon VPCs and query logging configurations.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { Route53ResolverClient, ListResolverQueryLogConfigAssociationsCommand } from "@aws-sdk/client-route53resolver"; // ES Modules import + * // const { Route53ResolverClient, ListResolverQueryLogConfigAssociationsCommand } = require("@aws-sdk/client-route53resolver"); // CommonJS import + * const client = new Route53ResolverClient(config); + * const command = new ListResolverQueryLogConfigAssociationsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListResolverQueryLogConfigAssociationsCommandInput} for command's `input` shape. + * @see {@link ListResolverQueryLogConfigAssociationsCommandOutput} for command's `response` shape. + * @see {@link Route53ResolverClientResolvedConfig | config} for command's `input` shape. + * */ export class ListResolverQueryLogConfigAssociationsCommand extends $Command< ListResolverQueryLogConfigAssociationsCommandInput, diff --git a/clients/client-route53resolver/commands/ListResolverQueryLogConfigsCommand.ts b/clients/client-route53resolver/commands/ListResolverQueryLogConfigsCommand.ts index 37da56f1dc74..bbe832cc3044 100644 --- a/clients/client-route53resolver/commands/ListResolverQueryLogConfigsCommand.ts +++ b/clients/client-route53resolver/commands/ListResolverQueryLogConfigsCommand.ts @@ -25,6 +25,20 @@ export interface ListResolverQueryLogConfigsCommandOutput /** *

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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { Route53ResolverClient, ListResolverQueryLogConfigsCommand } from "@aws-sdk/client-route53resolver"; // ES Modules import + * // const { Route53ResolverClient, ListResolverQueryLogConfigsCommand } = require("@aws-sdk/client-route53resolver"); // CommonJS import + * const client = new Route53ResolverClient(config); + * const command = new ListResolverQueryLogConfigsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListResolverQueryLogConfigsCommandInput} for command's `input` shape. + * @see {@link ListResolverQueryLogConfigsCommandOutput} for command's `response` shape. + * @see {@link Route53ResolverClientResolvedConfig | config} for command's `input` shape. + * */ export class ListResolverQueryLogConfigsCommand extends $Command< ListResolverQueryLogConfigsCommandInput, diff --git a/clients/client-route53resolver/commands/ListResolverRuleAssociationsCommand.ts b/clients/client-route53resolver/commands/ListResolverRuleAssociationsCommand.ts index 6086982c2d36..c8e2f0e610ca 100644 --- a/clients/client-route53resolver/commands/ListResolverRuleAssociationsCommand.ts +++ b/clients/client-route53resolver/commands/ListResolverRuleAssociationsCommand.ts @@ -24,6 +24,20 @@ export interface ListResolverRuleAssociationsCommandOutput /** *

Lists the associations that were created between Resolver rules and VPCs using the current AWS account.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { Route53ResolverClient, ListResolverRuleAssociationsCommand } from "@aws-sdk/client-route53resolver"; // ES Modules import + * // const { Route53ResolverClient, ListResolverRuleAssociationsCommand } = require("@aws-sdk/client-route53resolver"); // CommonJS import + * const client = new Route53ResolverClient(config); + * const command = new ListResolverRuleAssociationsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListResolverRuleAssociationsCommandInput} for command's `input` shape. + * @see {@link ListResolverRuleAssociationsCommandOutput} for command's `response` shape. + * @see {@link Route53ResolverClientResolvedConfig | config} for command's `input` shape. + * */ export class ListResolverRuleAssociationsCommand extends $Command< ListResolverRuleAssociationsCommandInput, diff --git a/clients/client-route53resolver/commands/ListResolverRulesCommand.ts b/clients/client-route53resolver/commands/ListResolverRulesCommand.ts index 8cd3be60aec8..6a7d42370000 100644 --- a/clients/client-route53resolver/commands/ListResolverRulesCommand.ts +++ b/clients/client-route53resolver/commands/ListResolverRulesCommand.ts @@ -22,6 +22,20 @@ export interface ListResolverRulesCommandOutput extends ListResolverRulesRespons /** *

Lists the Resolver rules that were created using the current AWS account.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { Route53ResolverClient, ListResolverRulesCommand } from "@aws-sdk/client-route53resolver"; // ES Modules import + * // const { Route53ResolverClient, ListResolverRulesCommand } = require("@aws-sdk/client-route53resolver"); // CommonJS import + * const client = new Route53ResolverClient(config); + * const command = new ListResolverRulesCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListResolverRulesCommandInput} for command's `input` shape. + * @see {@link ListResolverRulesCommandOutput} for command's `response` shape. + * @see {@link Route53ResolverClientResolvedConfig | config} for command's `input` shape. + * */ export class ListResolverRulesCommand extends $Command< ListResolverRulesCommandInput, diff --git a/clients/client-route53resolver/commands/ListTagsForResourceCommand.ts b/clients/client-route53resolver/commands/ListTagsForResourceCommand.ts index 40b83cdd6232..fcffd144538f 100644 --- a/clients/client-route53resolver/commands/ListTagsForResourceCommand.ts +++ b/clients/client-route53resolver/commands/ListTagsForResourceCommand.ts @@ -22,6 +22,20 @@ export interface ListTagsForResourceCommandOutput extends ListTagsForResourceRes /** *

Lists the tags that you associated with the specified resource.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { Route53ResolverClient, ListTagsForResourceCommand } from "@aws-sdk/client-route53resolver"; // ES Modules import + * // const { Route53ResolverClient, ListTagsForResourceCommand } = require("@aws-sdk/client-route53resolver"); // CommonJS import + * const client = new Route53ResolverClient(config); + * const command = new ListTagsForResourceCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListTagsForResourceCommandInput} for command's `input` shape. + * @see {@link ListTagsForResourceCommandOutput} for command's `response` shape. + * @see {@link Route53ResolverClientResolvedConfig | config} for command's `input` shape. + * */ export class ListTagsForResourceCommand extends $Command< ListTagsForResourceCommandInput, diff --git a/clients/client-route53resolver/commands/PutFirewallRuleGroupPolicyCommand.ts b/clients/client-route53resolver/commands/PutFirewallRuleGroupPolicyCommand.ts index b28bbb8dc254..23bea52a9b6f 100644 --- a/clients/client-route53resolver/commands/PutFirewallRuleGroupPolicyCommand.ts +++ b/clients/client-route53resolver/commands/PutFirewallRuleGroupPolicyCommand.ts @@ -22,6 +22,20 @@ export interface PutFirewallRuleGroupPolicyCommandOutput extends PutFirewallRule /** *

Attaches an AWS Identity and Access Management (AWS IAM) policy for sharing the rule group. You can use the policy to share the rule group using AWS Resource Access Manager (RAM).

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { Route53ResolverClient, PutFirewallRuleGroupPolicyCommand } from "@aws-sdk/client-route53resolver"; // ES Modules import + * // const { Route53ResolverClient, PutFirewallRuleGroupPolicyCommand } = require("@aws-sdk/client-route53resolver"); // CommonJS import + * const client = new Route53ResolverClient(config); + * const command = new PutFirewallRuleGroupPolicyCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link PutFirewallRuleGroupPolicyCommandInput} for command's `input` shape. + * @see {@link PutFirewallRuleGroupPolicyCommandOutput} for command's `response` shape. + * @see {@link Route53ResolverClientResolvedConfig | config} for command's `input` shape. + * */ export class PutFirewallRuleGroupPolicyCommand extends $Command< PutFirewallRuleGroupPolicyCommandInput, diff --git a/clients/client-route53resolver/commands/PutResolverQueryLogConfigPolicyCommand.ts b/clients/client-route53resolver/commands/PutResolverQueryLogConfigPolicyCommand.ts index 5f0f09b8f677..c92e1dc48fd4 100644 --- a/clients/client-route53resolver/commands/PutResolverQueryLogConfigPolicyCommand.ts +++ b/clients/client-route53resolver/commands/PutResolverQueryLogConfigPolicyCommand.ts @@ -25,6 +25,20 @@ export interface PutResolverQueryLogConfigPolicyCommandOutput /** *

Specifies an AWS 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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { Route53ResolverClient, PutResolverQueryLogConfigPolicyCommand } from "@aws-sdk/client-route53resolver"; // ES Modules import + * // const { Route53ResolverClient, PutResolverQueryLogConfigPolicyCommand } = require("@aws-sdk/client-route53resolver"); // CommonJS import + * const client = new Route53ResolverClient(config); + * const command = new PutResolverQueryLogConfigPolicyCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link PutResolverQueryLogConfigPolicyCommandInput} for command's `input` shape. + * @see {@link PutResolverQueryLogConfigPolicyCommandOutput} for command's `response` shape. + * @see {@link Route53ResolverClientResolvedConfig | config} for command's `input` shape. + * */ export class PutResolverQueryLogConfigPolicyCommand extends $Command< PutResolverQueryLogConfigPolicyCommandInput, diff --git a/clients/client-route53resolver/commands/PutResolverRulePolicyCommand.ts b/clients/client-route53resolver/commands/PutResolverRulePolicyCommand.ts index 2a6d6a5a234d..8c91f969057d 100644 --- a/clients/client-route53resolver/commands/PutResolverRulePolicyCommand.ts +++ b/clients/client-route53resolver/commands/PutResolverRulePolicyCommand.ts @@ -23,6 +23,20 @@ export interface PutResolverRulePolicyCommandOutput extends PutResolverRulePolic /** *

Specifies an AWS 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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { Route53ResolverClient, PutResolverRulePolicyCommand } from "@aws-sdk/client-route53resolver"; // ES Modules import + * // const { Route53ResolverClient, PutResolverRulePolicyCommand } = require("@aws-sdk/client-route53resolver"); // CommonJS import + * const client = new Route53ResolverClient(config); + * const command = new PutResolverRulePolicyCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link PutResolverRulePolicyCommandInput} for command's `input` shape. + * @see {@link PutResolverRulePolicyCommandOutput} for command's `response` shape. + * @see {@link Route53ResolverClientResolvedConfig | config} for command's `input` shape. + * */ export class PutResolverRulePolicyCommand extends $Command< PutResolverRulePolicyCommandInput, diff --git a/clients/client-route53resolver/commands/TagResourceCommand.ts b/clients/client-route53resolver/commands/TagResourceCommand.ts index e8ff846aa0d1..618a45079f3b 100644 --- a/clients/client-route53resolver/commands/TagResourceCommand.ts +++ b/clients/client-route53resolver/commands/TagResourceCommand.ts @@ -22,6 +22,20 @@ export interface TagResourceCommandOutput extends TagResourceResponse, __Metadat /** *

Adds one or more tags to a specified resource.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { Route53ResolverClient, TagResourceCommand } from "@aws-sdk/client-route53resolver"; // ES Modules import + * // const { Route53ResolverClient, TagResourceCommand } = require("@aws-sdk/client-route53resolver"); // CommonJS import + * const client = new Route53ResolverClient(config); + * const command = new TagResourceCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link TagResourceCommandInput} for command's `input` shape. + * @see {@link TagResourceCommandOutput} for command's `response` shape. + * @see {@link Route53ResolverClientResolvedConfig | config} for command's `input` shape. + * */ export class TagResourceCommand extends $Command< TagResourceCommandInput, diff --git a/clients/client-route53resolver/commands/UntagResourceCommand.ts b/clients/client-route53resolver/commands/UntagResourceCommand.ts index 4d6f1495c1cc..e9ad13f02186 100644 --- a/clients/client-route53resolver/commands/UntagResourceCommand.ts +++ b/clients/client-route53resolver/commands/UntagResourceCommand.ts @@ -22,6 +22,20 @@ export interface UntagResourceCommandOutput extends UntagResourceResponse, __Met /** *

Removes one or more tags from a specified resource.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { Route53ResolverClient, UntagResourceCommand } from "@aws-sdk/client-route53resolver"; // ES Modules import + * // const { Route53ResolverClient, UntagResourceCommand } = require("@aws-sdk/client-route53resolver"); // CommonJS import + * const client = new Route53ResolverClient(config); + * const command = new UntagResourceCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link UntagResourceCommandInput} for command's `input` shape. + * @see {@link UntagResourceCommandOutput} for command's `response` shape. + * @see {@link Route53ResolverClientResolvedConfig | config} for command's `input` shape. + * */ export class UntagResourceCommand extends $Command< UntagResourceCommandInput, diff --git a/clients/client-route53resolver/commands/UpdateFirewallConfigCommand.ts b/clients/client-route53resolver/commands/UpdateFirewallConfigCommand.ts index 4465336f8178..c184c06099e9 100644 --- a/clients/client-route53resolver/commands/UpdateFirewallConfigCommand.ts +++ b/clients/client-route53resolver/commands/UpdateFirewallConfigCommand.ts @@ -22,6 +22,20 @@ export interface UpdateFirewallConfigCommandOutput extends UpdateFirewallConfigR /** *

Updates the configuration of the firewall behavior provided by DNS Firewall for a single Amazon virtual private cloud (VPC).

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { Route53ResolverClient, UpdateFirewallConfigCommand } from "@aws-sdk/client-route53resolver"; // ES Modules import + * // const { Route53ResolverClient, UpdateFirewallConfigCommand } = require("@aws-sdk/client-route53resolver"); // CommonJS import + * const client = new Route53ResolverClient(config); + * const command = new UpdateFirewallConfigCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link UpdateFirewallConfigCommandInput} for command's `input` shape. + * @see {@link UpdateFirewallConfigCommandOutput} for command's `response` shape. + * @see {@link Route53ResolverClientResolvedConfig | config} for command's `input` shape. + * */ export class UpdateFirewallConfigCommand extends $Command< UpdateFirewallConfigCommandInput, diff --git a/clients/client-route53resolver/commands/UpdateFirewallDomainsCommand.ts b/clients/client-route53resolver/commands/UpdateFirewallDomainsCommand.ts index d995a41a3692..9b4b2a9ffdcf 100644 --- a/clients/client-route53resolver/commands/UpdateFirewallDomainsCommand.ts +++ b/clients/client-route53resolver/commands/UpdateFirewallDomainsCommand.ts @@ -22,6 +22,20 @@ export interface UpdateFirewallDomainsCommandOutput extends UpdateFirewallDomain /** *

Updates the firewall domain list from an array of domain specifications.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { Route53ResolverClient, UpdateFirewallDomainsCommand } from "@aws-sdk/client-route53resolver"; // ES Modules import + * // const { Route53ResolverClient, UpdateFirewallDomainsCommand } = require("@aws-sdk/client-route53resolver"); // CommonJS import + * const client = new Route53ResolverClient(config); + * const command = new UpdateFirewallDomainsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link UpdateFirewallDomainsCommandInput} for command's `input` shape. + * @see {@link UpdateFirewallDomainsCommandOutput} for command's `response` shape. + * @see {@link Route53ResolverClientResolvedConfig | config} for command's `input` shape. + * */ export class UpdateFirewallDomainsCommand extends $Command< UpdateFirewallDomainsCommandInput, diff --git a/clients/client-route53resolver/commands/UpdateFirewallRuleCommand.ts b/clients/client-route53resolver/commands/UpdateFirewallRuleCommand.ts index 7b54511f9288..191df03799dd 100644 --- a/clients/client-route53resolver/commands/UpdateFirewallRuleCommand.ts +++ b/clients/client-route53resolver/commands/UpdateFirewallRuleCommand.ts @@ -22,6 +22,20 @@ export interface UpdateFirewallRuleCommandOutput extends UpdateFirewallRuleRespo /** *

Updates the specified firewall rule.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { Route53ResolverClient, UpdateFirewallRuleCommand } from "@aws-sdk/client-route53resolver"; // ES Modules import + * // const { Route53ResolverClient, UpdateFirewallRuleCommand } = require("@aws-sdk/client-route53resolver"); // CommonJS import + * const client = new Route53ResolverClient(config); + * const command = new UpdateFirewallRuleCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link UpdateFirewallRuleCommandInput} for command's `input` shape. + * @see {@link UpdateFirewallRuleCommandOutput} for command's `response` shape. + * @see {@link Route53ResolverClientResolvedConfig | config} for command's `input` shape. + * */ export class UpdateFirewallRuleCommand extends $Command< UpdateFirewallRuleCommandInput, diff --git a/clients/client-route53resolver/commands/UpdateFirewallRuleGroupAssociationCommand.ts b/clients/client-route53resolver/commands/UpdateFirewallRuleGroupAssociationCommand.ts index ba15c821ef12..97c15c5363b3 100644 --- a/clients/client-route53resolver/commands/UpdateFirewallRuleGroupAssociationCommand.ts +++ b/clients/client-route53resolver/commands/UpdateFirewallRuleGroupAssociationCommand.ts @@ -27,6 +27,20 @@ export interface UpdateFirewallRuleGroupAssociationCommandOutput /** *

Changes the association of a FirewallRuleGroup with a VPC. The association enables DNS filtering for the VPC.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { Route53ResolverClient, UpdateFirewallRuleGroupAssociationCommand } from "@aws-sdk/client-route53resolver"; // ES Modules import + * // const { Route53ResolverClient, UpdateFirewallRuleGroupAssociationCommand } = require("@aws-sdk/client-route53resolver"); // CommonJS import + * const client = new Route53ResolverClient(config); + * const command = new UpdateFirewallRuleGroupAssociationCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link UpdateFirewallRuleGroupAssociationCommandInput} for command's `input` shape. + * @see {@link UpdateFirewallRuleGroupAssociationCommandOutput} for command's `response` shape. + * @see {@link Route53ResolverClientResolvedConfig | config} for command's `input` shape. + * */ export class UpdateFirewallRuleGroupAssociationCommand extends $Command< UpdateFirewallRuleGroupAssociationCommandInput, diff --git a/clients/client-route53resolver/commands/UpdateResolverDnssecConfigCommand.ts b/clients/client-route53resolver/commands/UpdateResolverDnssecConfigCommand.ts index 688df219cf6d..c4fb4afec302 100644 --- a/clients/client-route53resolver/commands/UpdateResolverDnssecConfigCommand.ts +++ b/clients/client-route53resolver/commands/UpdateResolverDnssecConfigCommand.ts @@ -22,6 +22,20 @@ export interface UpdateResolverDnssecConfigCommandOutput extends UpdateResolverD /** *

Updates an existing DNSSEC validation configuration. If there is no existing DNSSEC validation configuration, one is created.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { Route53ResolverClient, UpdateResolverDnssecConfigCommand } from "@aws-sdk/client-route53resolver"; // ES Modules import + * // const { Route53ResolverClient, UpdateResolverDnssecConfigCommand } = require("@aws-sdk/client-route53resolver"); // CommonJS import + * const client = new Route53ResolverClient(config); + * const command = new UpdateResolverDnssecConfigCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link UpdateResolverDnssecConfigCommandInput} for command's `input` shape. + * @see {@link UpdateResolverDnssecConfigCommandOutput} for command's `response` shape. + * @see {@link Route53ResolverClientResolvedConfig | config} for command's `input` shape. + * */ export class UpdateResolverDnssecConfigCommand extends $Command< UpdateResolverDnssecConfigCommandInput, diff --git a/clients/client-route53resolver/commands/UpdateResolverEndpointCommand.ts b/clients/client-route53resolver/commands/UpdateResolverEndpointCommand.ts index 7999a90e4238..26986079fe15 100644 --- a/clients/client-route53resolver/commands/UpdateResolverEndpointCommand.ts +++ b/clients/client-route53resolver/commands/UpdateResolverEndpointCommand.ts @@ -22,6 +22,20 @@ export interface UpdateResolverEndpointCommandOutput extends UpdateResolverEndpo /** *

Updates the name of an inbound or an outbound Resolver endpoint.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { Route53ResolverClient, UpdateResolverEndpointCommand } from "@aws-sdk/client-route53resolver"; // ES Modules import + * // const { Route53ResolverClient, UpdateResolverEndpointCommand } = require("@aws-sdk/client-route53resolver"); // CommonJS import + * const client = new Route53ResolverClient(config); + * const command = new UpdateResolverEndpointCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link UpdateResolverEndpointCommandInput} for command's `input` shape. + * @see {@link UpdateResolverEndpointCommandOutput} for command's `response` shape. + * @see {@link Route53ResolverClientResolvedConfig | config} for command's `input` shape. + * */ export class UpdateResolverEndpointCommand extends $Command< UpdateResolverEndpointCommandInput, diff --git a/clients/client-route53resolver/commands/UpdateResolverRuleCommand.ts b/clients/client-route53resolver/commands/UpdateResolverRuleCommand.ts index 9b1784a8af38..12f5fa3b74e7 100644 --- a/clients/client-route53resolver/commands/UpdateResolverRuleCommand.ts +++ b/clients/client-route53resolver/commands/UpdateResolverRuleCommand.ts @@ -23,6 +23,20 @@ export interface UpdateResolverRuleCommandOutput extends UpdateResolverRuleRespo /** *

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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { Route53ResolverClient, UpdateResolverRuleCommand } from "@aws-sdk/client-route53resolver"; // ES Modules import + * // const { Route53ResolverClient, UpdateResolverRuleCommand } = require("@aws-sdk/client-route53resolver"); // CommonJS import + * const client = new Route53ResolverClient(config); + * const command = new UpdateResolverRuleCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link UpdateResolverRuleCommandInput} for command's `input` shape. + * @see {@link UpdateResolverRuleCommandOutput} for command's `response` shape. + * @see {@link Route53ResolverClientResolvedConfig | config} for command's `input` shape. + * */ export class UpdateResolverRuleCommand extends $Command< UpdateResolverRuleCommandInput, diff --git a/clients/client-route53resolver/models/models_0.ts b/clients/client-route53resolver/models/models_0.ts index 8420516c7328..799fd44be458 100644 --- a/clients/client-route53resolver/models/models_0.ts +++ b/clients/client-route53resolver/models/models_0.ts @@ -11,6 +11,9 @@ export interface AccessDeniedException extends __SmithyException, $MetadataBeare } export namespace AccessDeniedException { + /** + * @internal + */ export const filterSensitiveLog = (obj: AccessDeniedException): any => ({ ...obj, }); @@ -45,6 +48,9 @@ export interface Tag { } export namespace Tag { + /** + * @internal + */ export const filterSensitiveLog = (obj: Tag): any => ({ ...obj, }); @@ -95,6 +101,9 @@ export interface AssociateFirewallRuleGroupRequest { } export namespace AssociateFirewallRuleGroupRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: AssociateFirewallRuleGroupRequest): any => ({ ...obj, }); @@ -180,6 +189,9 @@ export interface FirewallRuleGroupAssociation { } export namespace FirewallRuleGroupAssociation { + /** + * @internal + */ export const filterSensitiveLog = (obj: FirewallRuleGroupAssociation): any => ({ ...obj, }); @@ -193,6 +205,9 @@ export interface AssociateFirewallRuleGroupResponse { } export namespace AssociateFirewallRuleGroupResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: AssociateFirewallRuleGroupResponse): any => ({ ...obj, }); @@ -208,6 +223,9 @@ export interface ConflictException extends __SmithyException, $MetadataBearer { } export namespace ConflictException { + /** + * @internal + */ export const filterSensitiveLog = (obj: ConflictException): any => ({ ...obj, }); @@ -223,6 +241,9 @@ export interface InternalServiceErrorException extends __SmithyException, $Metad } export namespace InternalServiceErrorException { + /** + * @internal + */ export const filterSensitiveLog = (obj: InternalServiceErrorException): any => ({ ...obj, }); @@ -242,6 +263,9 @@ export interface LimitExceededException extends __SmithyException, $MetadataBear } export namespace LimitExceededException { + /** + * @internal + */ export const filterSensitiveLog = (obj: LimitExceededException): any => ({ ...obj, }); @@ -261,6 +285,9 @@ export interface ResourceNotFoundException extends __SmithyException, $MetadataB } export namespace ResourceNotFoundException { + /** + * @internal + */ export const filterSensitiveLog = (obj: ResourceNotFoundException): any => ({ ...obj, }); @@ -276,6 +303,9 @@ export interface ThrottlingException extends __SmithyException, $MetadataBearer } export namespace ThrottlingException { + /** + * @internal + */ export const filterSensitiveLog = (obj: ThrottlingException): any => ({ ...obj, }); @@ -291,6 +321,9 @@ export interface ValidationException extends __SmithyException, $MetadataBearer } export namespace ValidationException { + /** + * @internal + */ export const filterSensitiveLog = (obj: ValidationException): any => ({ ...obj, }); @@ -323,6 +356,9 @@ export interface IpAddressUpdate { } export namespace IpAddressUpdate { + /** + * @internal + */ export const filterSensitiveLog = (obj: IpAddressUpdate): any => ({ ...obj, }); @@ -342,6 +378,9 @@ export interface AssociateResolverEndpointIpAddressRequest { } export namespace AssociateResolverEndpointIpAddressRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: AssociateResolverEndpointIpAddressRequest): any => ({ ...obj, }); @@ -492,6 +531,9 @@ export interface ResolverEndpoint { } export namespace ResolverEndpoint { + /** + * @internal + */ export const filterSensitiveLog = (obj: ResolverEndpoint): any => ({ ...obj, }); @@ -505,6 +547,9 @@ export interface AssociateResolverEndpointIpAddressResponse { } export namespace AssociateResolverEndpointIpAddressResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: AssociateResolverEndpointIpAddressResponse): any => ({ ...obj, }); @@ -524,6 +569,9 @@ export interface InvalidParameterException extends __SmithyException, $MetadataB } export namespace InvalidParameterException { + /** + * @internal + */ export const filterSensitiveLog = (obj: InvalidParameterException): any => ({ ...obj, }); @@ -539,6 +587,9 @@ export interface InvalidRequestException extends __SmithyException, $MetadataBea } export namespace InvalidRequestException { + /** + * @internal + */ export const filterSensitiveLog = (obj: InvalidRequestException): any => ({ ...obj, }); @@ -558,6 +609,9 @@ export interface ResourceExistsException extends __SmithyException, $MetadataBea } export namespace ResourceExistsException { + /** + * @internal + */ export const filterSensitiveLog = (obj: ResourceExistsException): any => ({ ...obj, }); @@ -580,6 +634,9 @@ export interface AssociateResolverQueryLogConfigRequest { } export namespace AssociateResolverQueryLogConfigRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: AssociateResolverQueryLogConfigRequest): any => ({ ...obj, }); @@ -677,6 +734,9 @@ export interface ResolverQueryLogConfigAssociation { } export namespace ResolverQueryLogConfigAssociation { + /** + * @internal + */ export const filterSensitiveLog = (obj: ResolverQueryLogConfigAssociation): any => ({ ...obj, }); @@ -690,6 +750,9 @@ export interface AssociateResolverQueryLogConfigResponse { } export namespace AssociateResolverQueryLogConfigResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: AssociateResolverQueryLogConfigResponse): any => ({ ...obj, }); @@ -714,6 +777,9 @@ export interface AssociateResolverRuleRequest { } export namespace AssociateResolverRuleRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: AssociateResolverRuleRequest): any => ({ ...obj, }); @@ -771,6 +837,9 @@ export interface ResolverRuleAssociation { } export namespace ResolverRuleAssociation { + /** + * @internal + */ export const filterSensitiveLog = (obj: ResolverRuleAssociation): any => ({ ...obj, }); @@ -784,6 +853,9 @@ export interface AssociateResolverRuleResponse { } export namespace AssociateResolverRuleResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: AssociateResolverRuleResponse): any => ({ ...obj, }); @@ -803,6 +875,9 @@ export interface ResourceUnavailableException extends __SmithyException, $Metada } export namespace ResourceUnavailableException { + /** + * @internal + */ export const filterSensitiveLog = (obj: ResourceUnavailableException): any => ({ ...obj, }); @@ -838,6 +913,9 @@ export interface CreateFirewallDomainListRequest { } export namespace CreateFirewallDomainListRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateFirewallDomainListRequest): any => ({ ...obj, }); @@ -909,6 +987,9 @@ export interface FirewallDomainList { } export namespace FirewallDomainList { + /** + * @internal + */ export const filterSensitiveLog = (obj: FirewallDomainList): any => ({ ...obj, }); @@ -922,6 +1003,9 @@ export interface CreateFirewallDomainListResponse { } export namespace CreateFirewallDomainListResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateFirewallDomainListResponse): any => ({ ...obj, }); @@ -1018,6 +1102,9 @@ export interface CreateFirewallRuleRequest { } export namespace CreateFirewallRuleRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateFirewallRuleRequest): any => ({ ...obj, }); @@ -1118,6 +1205,9 @@ export interface FirewallRule { } export namespace FirewallRule { + /** + * @internal + */ export const filterSensitiveLog = (obj: FirewallRule): any => ({ ...obj, }); @@ -1131,6 +1221,9 @@ export interface CreateFirewallRuleResponse { } export namespace CreateFirewallRuleResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateFirewallRuleResponse): any => ({ ...obj, }); @@ -1155,6 +1248,9 @@ export interface CreateFirewallRuleGroupRequest { } export namespace CreateFirewallRuleGroupRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateFirewallRuleGroupRequest): any => ({ ...obj, }); @@ -1236,6 +1332,9 @@ export interface FirewallRuleGroup { } export namespace FirewallRuleGroup { + /** + * @internal + */ export const filterSensitiveLog = (obj: FirewallRuleGroup): any => ({ ...obj, }); @@ -1249,6 +1348,9 @@ export interface CreateFirewallRuleGroupResponse { } export namespace CreateFirewallRuleGroupResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateFirewallRuleGroupResponse): any => ({ ...obj, }); @@ -1273,6 +1375,9 @@ export interface IpAddressRequest { } export namespace IpAddressRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: IpAddressRequest): any => ({ ...obj, }); @@ -1326,6 +1431,9 @@ export interface CreateResolverEndpointRequest { } export namespace CreateResolverEndpointRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateResolverEndpointRequest): any => ({ ...obj, }); @@ -1339,6 +1447,9 @@ export interface CreateResolverEndpointResponse { } export namespace CreateResolverEndpointResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateResolverEndpointResponse): any => ({ ...obj, }); @@ -1397,6 +1508,9 @@ export interface CreateResolverQueryLogConfigRequest { } export namespace CreateResolverQueryLogConfigRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateResolverQueryLogConfigRequest): any => ({ ...obj, }); @@ -1502,6 +1616,9 @@ export interface ResolverQueryLogConfig { } export namespace ResolverQueryLogConfig { + /** + * @internal + */ export const filterSensitiveLog = (obj: ResolverQueryLogConfig): any => ({ ...obj, }); @@ -1515,6 +1632,9 @@ export interface CreateResolverQueryLogConfigResponse { } export namespace CreateResolverQueryLogConfigResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateResolverQueryLogConfigResponse): any => ({ ...obj, }); @@ -1544,6 +1664,9 @@ export interface TargetAddress { } export namespace TargetAddress { + /** + * @internal + */ export const filterSensitiveLog = (obj: TargetAddress): any => ({ ...obj, }); @@ -1599,6 +1722,9 @@ export interface CreateResolverRuleRequest { } export namespace CreateResolverRuleRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateResolverRuleRequest): any => ({ ...obj, }); @@ -1705,6 +1831,9 @@ export interface ResolverRule { } export namespace ResolverRule { + /** + * @internal + */ export const filterSensitiveLog = (obj: ResolverRule): any => ({ ...obj, }); @@ -1718,6 +1847,9 @@ export interface CreateResolverRuleResponse { } export namespace CreateResolverRuleResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateResolverRuleResponse): any => ({ ...obj, }); @@ -1731,6 +1863,9 @@ export interface DeleteFirewallDomainListRequest { } export namespace DeleteFirewallDomainListRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteFirewallDomainListRequest): any => ({ ...obj, }); @@ -1744,6 +1879,9 @@ export interface DeleteFirewallDomainListResponse { } export namespace DeleteFirewallDomainListResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteFirewallDomainListResponse): any => ({ ...obj, }); @@ -1762,6 +1900,9 @@ export interface DeleteFirewallRuleRequest { } export namespace DeleteFirewallRuleRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteFirewallRuleRequest): any => ({ ...obj, }); @@ -1775,6 +1916,9 @@ export interface DeleteFirewallRuleResponse { } export namespace DeleteFirewallRuleResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteFirewallRuleResponse): any => ({ ...obj, }); @@ -1788,6 +1932,9 @@ export interface DeleteFirewallRuleGroupRequest { } export namespace DeleteFirewallRuleGroupRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteFirewallRuleGroupRequest): any => ({ ...obj, }); @@ -1801,6 +1948,9 @@ export interface DeleteFirewallRuleGroupResponse { } export namespace DeleteFirewallRuleGroupResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteFirewallRuleGroupResponse): any => ({ ...obj, }); @@ -1814,6 +1964,9 @@ export interface DeleteResolverEndpointRequest { } export namespace DeleteResolverEndpointRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteResolverEndpointRequest): any => ({ ...obj, }); @@ -1827,6 +1980,9 @@ export interface DeleteResolverEndpointResponse { } export namespace DeleteResolverEndpointResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteResolverEndpointResponse): any => ({ ...obj, }); @@ -1840,6 +1996,9 @@ export interface DeleteResolverQueryLogConfigRequest { } export namespace DeleteResolverQueryLogConfigRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteResolverQueryLogConfigRequest): any => ({ ...obj, }); @@ -1853,6 +2012,9 @@ export interface DeleteResolverQueryLogConfigResponse { } export namespace DeleteResolverQueryLogConfigResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteResolverQueryLogConfigResponse): any => ({ ...obj, }); @@ -1866,6 +2028,9 @@ export interface DeleteResolverRuleRequest { } export namespace DeleteResolverRuleRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteResolverRuleRequest): any => ({ ...obj, }); @@ -1879,6 +2044,9 @@ export interface DeleteResolverRuleResponse { } export namespace DeleteResolverRuleResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteResolverRuleResponse): any => ({ ...obj, }); @@ -1898,6 +2066,9 @@ export interface ResourceInUseException extends __SmithyException, $MetadataBear } export namespace ResourceInUseException { + /** + * @internal + */ export const filterSensitiveLog = (obj: ResourceInUseException): any => ({ ...obj, }); @@ -1911,6 +2082,9 @@ export interface DisassociateFirewallRuleGroupRequest { } export namespace DisassociateFirewallRuleGroupRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DisassociateFirewallRuleGroupRequest): any => ({ ...obj, }); @@ -1924,6 +2098,9 @@ export interface DisassociateFirewallRuleGroupResponse { } export namespace DisassociateFirewallRuleGroupResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DisassociateFirewallRuleGroupResponse): any => ({ ...obj, }); @@ -1942,6 +2119,9 @@ export interface DisassociateResolverEndpointIpAddressRequest { } export namespace DisassociateResolverEndpointIpAddressRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DisassociateResolverEndpointIpAddressRequest): any => ({ ...obj, }); @@ -1955,6 +2135,9 @@ export interface DisassociateResolverEndpointIpAddressResponse { } export namespace DisassociateResolverEndpointIpAddressResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DisassociateResolverEndpointIpAddressResponse): any => ({ ...obj, }); @@ -1973,6 +2156,9 @@ export interface DisassociateResolverQueryLogConfigRequest { } export namespace DisassociateResolverQueryLogConfigRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DisassociateResolverQueryLogConfigRequest): any => ({ ...obj, }); @@ -1986,6 +2172,9 @@ export interface DisassociateResolverQueryLogConfigResponse { } export namespace DisassociateResolverQueryLogConfigResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DisassociateResolverQueryLogConfigResponse): any => ({ ...obj, }); @@ -2004,6 +2193,9 @@ export interface DisassociateResolverRuleRequest { } export namespace DisassociateResolverRuleRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DisassociateResolverRuleRequest): any => ({ ...obj, }); @@ -2017,6 +2209,9 @@ export interface DisassociateResolverRuleResponse { } export namespace DisassociateResolverRuleResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DisassociateResolverRuleResponse): any => ({ ...obj, }); @@ -2289,6 +2484,9 @@ export interface Filter { } export namespace Filter { + /** + * @internal + */ export const filterSensitiveLog = (obj: Filter): any => ({ ...obj, }); @@ -2336,6 +2534,9 @@ export interface FirewallConfig { } export namespace FirewallConfig { + /** + * @internal + */ export const filterSensitiveLog = (obj: FirewallConfig): any => ({ ...obj, }); @@ -2378,6 +2579,9 @@ export interface FirewallDomainListMetadata { } export namespace FirewallDomainListMetadata { + /** + * @internal + */ export const filterSensitiveLog = (obj: FirewallDomainListMetadata): any => ({ ...obj, }); @@ -2429,6 +2633,9 @@ export interface FirewallRuleGroupMetadata { } export namespace FirewallRuleGroupMetadata { + /** + * @internal + */ export const filterSensitiveLog = (obj: FirewallRuleGroupMetadata): any => ({ ...obj, }); @@ -2442,6 +2649,9 @@ export interface GetFirewallConfigRequest { } export namespace GetFirewallConfigRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetFirewallConfigRequest): any => ({ ...obj, }); @@ -2455,6 +2665,9 @@ export interface GetFirewallConfigResponse { } export namespace GetFirewallConfigResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetFirewallConfigResponse): any => ({ ...obj, }); @@ -2468,6 +2681,9 @@ export interface GetFirewallDomainListRequest { } export namespace GetFirewallDomainListRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetFirewallDomainListRequest): any => ({ ...obj, }); @@ -2481,6 +2697,9 @@ export interface GetFirewallDomainListResponse { } export namespace GetFirewallDomainListResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetFirewallDomainListResponse): any => ({ ...obj, }); @@ -2494,6 +2713,9 @@ export interface GetFirewallRuleGroupRequest { } export namespace GetFirewallRuleGroupRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetFirewallRuleGroupRequest): any => ({ ...obj, }); @@ -2507,6 +2729,9 @@ export interface GetFirewallRuleGroupResponse { } export namespace GetFirewallRuleGroupResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetFirewallRuleGroupResponse): any => ({ ...obj, }); @@ -2520,6 +2745,9 @@ export interface GetFirewallRuleGroupAssociationRequest { } export namespace GetFirewallRuleGroupAssociationRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetFirewallRuleGroupAssociationRequest): any => ({ ...obj, }); @@ -2533,6 +2761,9 @@ export interface GetFirewallRuleGroupAssociationResponse { } export namespace GetFirewallRuleGroupAssociationResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetFirewallRuleGroupAssociationResponse): any => ({ ...obj, }); @@ -2546,6 +2777,9 @@ export interface GetFirewallRuleGroupPolicyRequest { } export namespace GetFirewallRuleGroupPolicyRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetFirewallRuleGroupPolicyRequest): any => ({ ...obj, }); @@ -2559,6 +2793,9 @@ export interface GetFirewallRuleGroupPolicyResponse { } export namespace GetFirewallRuleGroupPolicyResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetFirewallRuleGroupPolicyResponse): any => ({ ...obj, }); @@ -2572,6 +2809,9 @@ export interface GetResolverDnssecConfigRequest { } export namespace GetResolverDnssecConfigRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetResolverDnssecConfigRequest): any => ({ ...obj, }); @@ -2628,6 +2868,9 @@ export interface ResolverDnssecConfig { } export namespace ResolverDnssecConfig { + /** + * @internal + */ export const filterSensitiveLog = (obj: ResolverDnssecConfig): any => ({ ...obj, }); @@ -2641,6 +2884,9 @@ export interface GetResolverDnssecConfigResponse { } export namespace GetResolverDnssecConfigResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetResolverDnssecConfigResponse): any => ({ ...obj, }); @@ -2654,6 +2900,9 @@ export interface GetResolverEndpointRequest { } export namespace GetResolverEndpointRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetResolverEndpointRequest): any => ({ ...obj, }); @@ -2667,6 +2916,9 @@ export interface GetResolverEndpointResponse { } export namespace GetResolverEndpointResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetResolverEndpointResponse): any => ({ ...obj, }); @@ -2680,6 +2932,9 @@ export interface GetResolverQueryLogConfigRequest { } export namespace GetResolverQueryLogConfigRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetResolverQueryLogConfigRequest): any => ({ ...obj, }); @@ -2693,6 +2948,9 @@ export interface GetResolverQueryLogConfigResponse { } export namespace GetResolverQueryLogConfigResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetResolverQueryLogConfigResponse): any => ({ ...obj, }); @@ -2706,6 +2964,9 @@ export interface GetResolverQueryLogConfigAssociationRequest { } export namespace GetResolverQueryLogConfigAssociationRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetResolverQueryLogConfigAssociationRequest): any => ({ ...obj, }); @@ -2719,6 +2980,9 @@ export interface GetResolverQueryLogConfigAssociationResponse { } export namespace GetResolverQueryLogConfigAssociationResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetResolverQueryLogConfigAssociationResponse): any => ({ ...obj, }); @@ -2732,6 +2996,9 @@ export interface GetResolverQueryLogConfigPolicyRequest { } export namespace GetResolverQueryLogConfigPolicyRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetResolverQueryLogConfigPolicyRequest): any => ({ ...obj, }); @@ -2746,6 +3013,9 @@ export interface GetResolverQueryLogConfigPolicyResponse { } export namespace GetResolverQueryLogConfigPolicyResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetResolverQueryLogConfigPolicyResponse): any => ({ ...obj, }); @@ -2761,6 +3031,9 @@ export interface UnknownResourceException extends __SmithyException, $MetadataBe } export namespace UnknownResourceException { + /** + * @internal + */ export const filterSensitiveLog = (obj: UnknownResourceException): any => ({ ...obj, }); @@ -2774,6 +3047,9 @@ export interface GetResolverRuleRequest { } export namespace GetResolverRuleRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetResolverRuleRequest): any => ({ ...obj, }); @@ -2787,6 +3063,9 @@ export interface GetResolverRuleResponse { } export namespace GetResolverRuleResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetResolverRuleResponse): any => ({ ...obj, }); @@ -2800,6 +3079,9 @@ export interface GetResolverRuleAssociationRequest { } export namespace GetResolverRuleAssociationRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetResolverRuleAssociationRequest): any => ({ ...obj, }); @@ -2813,6 +3095,9 @@ export interface GetResolverRuleAssociationResponse { } export namespace GetResolverRuleAssociationResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetResolverRuleAssociationResponse): any => ({ ...obj, }); @@ -2826,6 +3111,9 @@ export interface GetResolverRulePolicyRequest { } export namespace GetResolverRulePolicyRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetResolverRulePolicyRequest): any => ({ ...obj, }); @@ -2839,6 +3127,9 @@ export interface GetResolverRulePolicyResponse { } export namespace GetResolverRulePolicyResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetResolverRulePolicyResponse): any => ({ ...obj, }); @@ -2864,6 +3155,9 @@ export interface ImportFirewallDomainsRequest { } export namespace ImportFirewallDomainsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ImportFirewallDomainsRequest): any => ({ ...obj, }); @@ -2892,6 +3186,9 @@ export interface ImportFirewallDomainsResponse { } export namespace ImportFirewallDomainsResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ImportFirewallDomainsResponse): any => ({ ...obj, }); @@ -2907,6 +3204,9 @@ export interface InvalidNextTokenException extends __SmithyException, $MetadataB } export namespace InvalidNextTokenException { + /** + * @internal + */ export const filterSensitiveLog = (obj: InvalidNextTokenException): any => ({ ...obj, }); @@ -2922,6 +3222,9 @@ export interface InvalidPolicyDocument extends __SmithyException, $MetadataBeare } export namespace InvalidPolicyDocument { + /** + * @internal + */ export const filterSensitiveLog = (obj: InvalidPolicyDocument): any => ({ ...obj, }); @@ -2937,6 +3240,9 @@ export interface InvalidTagException extends __SmithyException, $MetadataBearer } export namespace InvalidTagException { + /** + * @internal + */ export const filterSensitiveLog = (obj: InvalidTagException): any => ({ ...obj, }); @@ -2998,6 +3304,9 @@ export interface IpAddressResponse { } export namespace IpAddressResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: IpAddressResponse): any => ({ ...obj, }); @@ -3023,6 +3332,9 @@ export interface ListFirewallConfigsRequest { } export namespace ListFirewallConfigsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListFirewallConfigsRequest): any => ({ ...obj, }); @@ -3042,6 +3354,9 @@ export interface ListFirewallConfigsResponse { } export namespace ListFirewallConfigsResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListFirewallConfigsResponse): any => ({ ...obj, }); @@ -3067,6 +3382,9 @@ export interface ListFirewallDomainListsRequest { } export namespace ListFirewallDomainListsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListFirewallDomainListsRequest): any => ({ ...obj, }); @@ -3087,6 +3405,9 @@ export interface ListFirewallDomainListsResponse { } export namespace ListFirewallDomainListsResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListFirewallDomainListsResponse): any => ({ ...obj, }); @@ -3117,6 +3438,9 @@ export interface ListFirewallDomainsRequest { } export namespace ListFirewallDomainsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListFirewallDomainsRequest): any => ({ ...obj, }); @@ -3137,6 +3461,9 @@ export interface ListFirewallDomainsResponse { } export namespace ListFirewallDomainsResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListFirewallDomainsResponse): any => ({ ...obj, }); @@ -3185,6 +3512,9 @@ export interface ListFirewallRuleGroupAssociationsRequest { } export namespace ListFirewallRuleGroupAssociationsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListFirewallRuleGroupAssociationsRequest): any => ({ ...obj, }); @@ -3205,6 +3535,9 @@ export interface ListFirewallRuleGroupAssociationsResponse { } export namespace ListFirewallRuleGroupAssociationsResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListFirewallRuleGroupAssociationsResponse): any => ({ ...obj, }); @@ -3230,6 +3563,9 @@ export interface ListFirewallRuleGroupsRequest { } export namespace ListFirewallRuleGroupsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListFirewallRuleGroupsRequest): any => ({ ...obj, }); @@ -3250,6 +3586,9 @@ export interface ListFirewallRuleGroupsResponse { } export namespace ListFirewallRuleGroupsResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListFirewallRuleGroupsResponse): any => ({ ...obj, }); @@ -3307,6 +3646,9 @@ export interface ListFirewallRulesRequest { } export namespace ListFirewallRulesRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListFirewallRulesRequest): any => ({ ...obj, }); @@ -3327,6 +3669,9 @@ export interface ListFirewallRulesResponse { } export namespace ListFirewallRulesResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListFirewallRulesResponse): any => ({ ...obj, }); @@ -3356,6 +3701,9 @@ export interface ListResolverDnssecConfigsRequest { } export namespace ListResolverDnssecConfigsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListResolverDnssecConfigsRequest): any => ({ ...obj, }); @@ -3381,6 +3729,9 @@ export interface ListResolverDnssecConfigsResponse { } export namespace ListResolverDnssecConfigsResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListResolverDnssecConfigsResponse): any => ({ ...obj, }); @@ -3408,6 +3759,9 @@ export interface ListResolverEndpointIpAddressesRequest { } export namespace ListResolverEndpointIpAddressesRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListResolverEndpointIpAddressesRequest): any => ({ ...obj, }); @@ -3434,6 +3788,9 @@ export interface ListResolverEndpointIpAddressesResponse { } export namespace ListResolverEndpointIpAddressesResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListResolverEndpointIpAddressesResponse): any => ({ ...obj, }); @@ -3464,6 +3821,9 @@ export interface ListResolverEndpointsRequest { } export namespace ListResolverEndpointsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListResolverEndpointsRequest): any => ({ ...obj, }); @@ -3488,6 +3848,9 @@ export interface ListResolverEndpointsResponse { } export namespace ListResolverEndpointsResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListResolverEndpointsResponse): any => ({ ...obj, }); @@ -3612,6 +3975,9 @@ export interface ListResolverQueryLogConfigAssociationsRequest { } export namespace ListResolverQueryLogConfigAssociationsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListResolverQueryLogConfigAssociationsRequest): any => ({ ...obj, }); @@ -3646,6 +4012,9 @@ export interface ListResolverQueryLogConfigAssociationsResponse { } export namespace ListResolverQueryLogConfigAssociationsResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListResolverQueryLogConfigAssociationsResponse): any => ({ ...obj, }); @@ -3770,6 +4139,9 @@ export interface ListResolverQueryLogConfigsRequest { } export namespace ListResolverQueryLogConfigsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListResolverQueryLogConfigsRequest): any => ({ ...obj, }); @@ -3804,6 +4176,9 @@ export interface ListResolverQueryLogConfigsResponse { } export namespace ListResolverQueryLogConfigsResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListResolverQueryLogConfigsResponse): any => ({ ...obj, }); @@ -3834,6 +4209,9 @@ export interface ListResolverRuleAssociationsRequest { } export namespace ListResolverRuleAssociationsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListResolverRuleAssociationsRequest): any => ({ ...obj, }); @@ -3860,6 +4238,9 @@ export interface ListResolverRuleAssociationsResponse { } export namespace ListResolverRuleAssociationsResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListResolverRuleAssociationsResponse): any => ({ ...obj, }); @@ -3890,6 +4271,9 @@ export interface ListResolverRulesRequest { } export namespace ListResolverRulesRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListResolverRulesRequest): any => ({ ...obj, }); @@ -3915,6 +4299,9 @@ export interface ListResolverRulesResponse { } export namespace ListResolverRulesResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListResolverRulesResponse): any => ({ ...obj, }); @@ -3941,6 +4328,9 @@ export interface ListTagsForResourceRequest { } export namespace ListTagsForResourceRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListTagsForResourceRequest): any => ({ ...obj, }); @@ -3961,6 +4351,9 @@ export interface ListTagsForResourceResponse { } export namespace ListTagsForResourceResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListTagsForResourceResponse): any => ({ ...obj, }); @@ -3979,6 +4372,9 @@ export interface PutFirewallRuleGroupPolicyRequest { } export namespace PutFirewallRuleGroupPolicyRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: PutFirewallRuleGroupPolicyRequest): any => ({ ...obj, }); @@ -3992,6 +4388,9 @@ export interface PutFirewallRuleGroupPolicyResponse { } export namespace PutFirewallRuleGroupPolicyResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: PutFirewallRuleGroupPolicyResponse): any => ({ ...obj, }); @@ -4037,6 +4436,9 @@ export interface PutResolverQueryLogConfigPolicyRequest { } export namespace PutResolverQueryLogConfigPolicyRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: PutResolverQueryLogConfigPolicyRequest): any => ({ ...obj, }); @@ -4053,6 +4455,9 @@ export interface PutResolverQueryLogConfigPolicyResponse { } export namespace PutResolverQueryLogConfigPolicyResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: PutResolverQueryLogConfigPolicyResponse): any => ({ ...obj, }); @@ -4102,6 +4507,9 @@ export interface PutResolverRulePolicyRequest { } export namespace PutResolverRulePolicyRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: PutResolverRulePolicyRequest): any => ({ ...obj, }); @@ -4118,6 +4526,9 @@ export interface PutResolverRulePolicyResponse { } export namespace PutResolverRulePolicyResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: PutResolverRulePolicyResponse): any => ({ ...obj, }); @@ -4147,6 +4558,9 @@ export interface ResolverRuleConfig { } export namespace ResolverRuleConfig { + /** + * @internal + */ export const filterSensitiveLog = (obj: ResolverRuleConfig): any => ({ ...obj, }); @@ -4198,6 +4612,9 @@ export interface TagResourceRequest { } export namespace TagResourceRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: TagResourceRequest): any => ({ ...obj, }); @@ -4206,6 +4623,9 @@ export namespace TagResourceRequest { export interface TagResourceResponse {} export namespace TagResourceResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: TagResourceResponse): any => ({ ...obj, }); @@ -4257,6 +4677,9 @@ export interface UntagResourceRequest { } export namespace UntagResourceRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: UntagResourceRequest): any => ({ ...obj, }); @@ -4265,6 +4688,9 @@ export namespace UntagResourceRequest { export interface UntagResourceResponse {} export namespace UntagResourceResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: UntagResourceResponse): any => ({ ...obj, }); @@ -4294,6 +4720,9 @@ export interface UpdateFirewallConfigRequest { } export namespace UpdateFirewallConfigRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateFirewallConfigRequest): any => ({ ...obj, }); @@ -4307,6 +4736,9 @@ export interface UpdateFirewallConfigResponse { } export namespace UpdateFirewallConfigResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateFirewallConfigResponse): any => ({ ...obj, }); @@ -4359,6 +4791,9 @@ export interface UpdateFirewallDomainsRequest { } export namespace UpdateFirewallDomainsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateFirewallDomainsRequest): any => ({ ...obj, }); @@ -4387,6 +4822,9 @@ export interface UpdateFirewallDomainsResponse { } export namespace UpdateFirewallDomainsResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateFirewallDomainsResponse): any => ({ ...obj, }); @@ -4472,6 +4910,9 @@ export interface UpdateFirewallRuleRequest { } export namespace UpdateFirewallRuleRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateFirewallRuleRequest): any => ({ ...obj, }); @@ -4485,6 +4926,9 @@ export interface UpdateFirewallRuleResponse { } export namespace UpdateFirewallRuleResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateFirewallRuleResponse): any => ({ ...obj, }); @@ -4517,6 +4961,9 @@ export interface UpdateFirewallRuleGroupAssociationRequest { } export namespace UpdateFirewallRuleGroupAssociationRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateFirewallRuleGroupAssociationRequest): any => ({ ...obj, }); @@ -4530,6 +4977,9 @@ export interface UpdateFirewallRuleGroupAssociationResponse { } export namespace UpdateFirewallRuleGroupAssociationResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateFirewallRuleGroupAssociationResponse): any => ({ ...obj, }); @@ -4554,6 +5004,9 @@ export interface UpdateResolverDnssecConfigRequest { } export namespace UpdateResolverDnssecConfigRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateResolverDnssecConfigRequest): any => ({ ...obj, }); @@ -4567,6 +5020,9 @@ export interface UpdateResolverDnssecConfigResponse { } export namespace UpdateResolverDnssecConfigResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateResolverDnssecConfigResponse): any => ({ ...obj, }); @@ -4585,6 +5041,9 @@ export interface UpdateResolverEndpointRequest { } export namespace UpdateResolverEndpointRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateResolverEndpointRequest): any => ({ ...obj, }); @@ -4598,6 +5057,9 @@ export interface UpdateResolverEndpointResponse { } export namespace UpdateResolverEndpointResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateResolverEndpointResponse): any => ({ ...obj, }); @@ -4616,6 +5078,9 @@ export interface UpdateResolverRuleRequest { } export namespace UpdateResolverRuleRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateResolverRuleRequest): any => ({ ...obj, }); @@ -4629,6 +5094,9 @@ export interface UpdateResolverRuleResponse { } export namespace UpdateResolverRuleResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateResolverRuleResponse): any => ({ ...obj, }); diff --git a/clients/client-s3-control/commands/CreateAccessPointCommand.ts b/clients/client-s3-control/commands/CreateAccessPointCommand.ts index b501cfa6abaa..f72e4f0f7004 100644 --- a/clients/client-s3-control/commands/CreateAccessPointCommand.ts +++ b/clients/client-s3-control/commands/CreateAccessPointCommand.ts @@ -53,6 +53,20 @@ export interface CreateAccessPointCommandOutput extends CreateAccessPointResult, *

* * + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { S3ControlClient, CreateAccessPointCommand } from "@aws-sdk/client-s3-control"; // ES Modules import + * // const { S3ControlClient, CreateAccessPointCommand } = require("@aws-sdk/client-s3-control"); // CommonJS import + * const client = new S3ControlClient(config); + * const command = new CreateAccessPointCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreateAccessPointCommandInput} for command's `input` shape. + * @see {@link CreateAccessPointCommandOutput} for command's `response` shape. + * @see {@link S3ControlClientResolvedConfig | config} for command's `input` shape. + * */ export class CreateAccessPointCommand extends $Command< CreateAccessPointCommandInput, diff --git a/clients/client-s3-control/commands/CreateAccessPointForObjectLambdaCommand.ts b/clients/client-s3-control/commands/CreateAccessPointForObjectLambdaCommand.ts index 34bb8dfbb095..3dee435b3ded 100644 --- a/clients/client-s3-control/commands/CreateAccessPointForObjectLambdaCommand.ts +++ b/clients/client-s3-control/commands/CreateAccessPointForObjectLambdaCommand.ts @@ -44,6 +44,20 @@ export interface CreateAccessPointForObjectLambdaCommandOutput *

* * + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { S3ControlClient, CreateAccessPointForObjectLambdaCommand } from "@aws-sdk/client-s3-control"; // ES Modules import + * // const { S3ControlClient, CreateAccessPointForObjectLambdaCommand } = require("@aws-sdk/client-s3-control"); // CommonJS import + * const client = new S3ControlClient(config); + * const command = new CreateAccessPointForObjectLambdaCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreateAccessPointForObjectLambdaCommandInput} for command's `input` shape. + * @see {@link CreateAccessPointForObjectLambdaCommandOutput} for command's `response` shape. + * @see {@link S3ControlClientResolvedConfig | config} for command's `input` shape. + * */ export class CreateAccessPointForObjectLambdaCommand extends $Command< CreateAccessPointForObjectLambdaCommandInput, diff --git a/clients/client-s3-control/commands/CreateBucketCommand.ts b/clients/client-s3-control/commands/CreateBucketCommand.ts index 481c73c45584..26b0858fcaf5 100644 --- a/clients/client-s3-control/commands/CreateBucketCommand.ts +++ b/clients/client-s3-control/commands/CreateBucketCommand.ts @@ -72,6 +72,20 @@ export interface CreateBucketCommandOutput extends CreateBucketResult, __Metadat *

* * + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { S3ControlClient, CreateBucketCommand } from "@aws-sdk/client-s3-control"; // ES Modules import + * // const { S3ControlClient, CreateBucketCommand } = require("@aws-sdk/client-s3-control"); // CommonJS import + * const client = new S3ControlClient(config); + * const command = new CreateBucketCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreateBucketCommandInput} for command's `input` shape. + * @see {@link CreateBucketCommandOutput} for command's `response` shape. + * @see {@link S3ControlClientResolvedConfig | config} for command's `input` shape. + * */ export class CreateBucketCommand extends $Command< CreateBucketCommandInput, diff --git a/clients/client-s3-control/commands/CreateJobCommand.ts b/clients/client-s3-control/commands/CreateJobCommand.ts index 7ebc1c7decbf..d441f0ad58e6 100644 --- a/clients/client-s3-control/commands/CreateJobCommand.ts +++ b/clients/client-s3-control/commands/CreateJobCommand.ts @@ -53,6 +53,20 @@ export interface CreateJobCommandOutput extends CreateJobResult, __MetadataBeare *

* * + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { S3ControlClient, CreateJobCommand } from "@aws-sdk/client-s3-control"; // ES Modules import + * // const { S3ControlClient, CreateJobCommand } = require("@aws-sdk/client-s3-control"); // CommonJS import + * const client = new S3ControlClient(config); + * const command = new CreateJobCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreateJobCommandInput} for command's `input` shape. + * @see {@link CreateJobCommandOutput} for command's `response` shape. + * @see {@link S3ControlClientResolvedConfig | config} for command's `input` shape. + * */ export class CreateJobCommand extends $Command< CreateJobCommandInput, diff --git a/clients/client-s3-control/commands/DeleteAccessPointCommand.ts b/clients/client-s3-control/commands/DeleteAccessPointCommand.ts index 0205b38a96f4..2f9ce58e245b 100644 --- a/clients/client-s3-control/commands/DeleteAccessPointCommand.ts +++ b/clients/client-s3-control/commands/DeleteAccessPointCommand.ts @@ -43,6 +43,20 @@ export interface DeleteAccessPointCommandOutput extends __MetadataBearer {} *

* * + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { S3ControlClient, DeleteAccessPointCommand } from "@aws-sdk/client-s3-control"; // ES Modules import + * // const { S3ControlClient, DeleteAccessPointCommand } = require("@aws-sdk/client-s3-control"); // CommonJS import + * const client = new S3ControlClient(config); + * const command = new DeleteAccessPointCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteAccessPointCommandInput} for command's `input` shape. + * @see {@link DeleteAccessPointCommandOutput} for command's `response` shape. + * @see {@link S3ControlClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteAccessPointCommand extends $Command< DeleteAccessPointCommandInput, diff --git a/clients/client-s3-control/commands/DeleteAccessPointForObjectLambdaCommand.ts b/clients/client-s3-control/commands/DeleteAccessPointForObjectLambdaCommand.ts index 16fb7dc1ac3d..6044ffa7e11e 100644 --- a/clients/client-s3-control/commands/DeleteAccessPointForObjectLambdaCommand.ts +++ b/clients/client-s3-control/commands/DeleteAccessPointForObjectLambdaCommand.ts @@ -41,6 +41,20 @@ export interface DeleteAccessPointForObjectLambdaCommandOutput extends __Metadat *

* * + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { S3ControlClient, DeleteAccessPointForObjectLambdaCommand } from "@aws-sdk/client-s3-control"; // ES Modules import + * // const { S3ControlClient, DeleteAccessPointForObjectLambdaCommand } = require("@aws-sdk/client-s3-control"); // CommonJS import + * const client = new S3ControlClient(config); + * const command = new DeleteAccessPointForObjectLambdaCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteAccessPointForObjectLambdaCommandInput} for command's `input` shape. + * @see {@link DeleteAccessPointForObjectLambdaCommandOutput} for command's `response` shape. + * @see {@link S3ControlClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteAccessPointForObjectLambdaCommand extends $Command< DeleteAccessPointForObjectLambdaCommandInput, diff --git a/clients/client-s3-control/commands/DeleteAccessPointPolicyCommand.ts b/clients/client-s3-control/commands/DeleteAccessPointPolicyCommand.ts index 3da9ec0d1a8a..6d23e5b837bc 100644 --- a/clients/client-s3-control/commands/DeleteAccessPointPolicyCommand.ts +++ b/clients/client-s3-control/commands/DeleteAccessPointPolicyCommand.ts @@ -38,6 +38,20 @@ export interface DeleteAccessPointPolicyCommandOutput extends __MetadataBearer { *

* * + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { S3ControlClient, DeleteAccessPointPolicyCommand } from "@aws-sdk/client-s3-control"; // ES Modules import + * // const { S3ControlClient, DeleteAccessPointPolicyCommand } = require("@aws-sdk/client-s3-control"); // CommonJS import + * const client = new S3ControlClient(config); + * const command = new DeleteAccessPointPolicyCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteAccessPointPolicyCommandInput} for command's `input` shape. + * @see {@link DeleteAccessPointPolicyCommandOutput} for command's `response` shape. + * @see {@link S3ControlClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteAccessPointPolicyCommand extends $Command< DeleteAccessPointPolicyCommandInput, diff --git a/clients/client-s3-control/commands/DeleteAccessPointPolicyForObjectLambdaCommand.ts b/clients/client-s3-control/commands/DeleteAccessPointPolicyForObjectLambdaCommand.ts index 776373d60b5d..e966eaa5ce4f 100644 --- a/clients/client-s3-control/commands/DeleteAccessPointPolicyForObjectLambdaCommand.ts +++ b/clients/client-s3-control/commands/DeleteAccessPointPolicyForObjectLambdaCommand.ts @@ -37,6 +37,20 @@ export interface DeleteAccessPointPolicyForObjectLambdaCommandOutput extends __M *

* * + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { S3ControlClient, DeleteAccessPointPolicyForObjectLambdaCommand } from "@aws-sdk/client-s3-control"; // ES Modules import + * // const { S3ControlClient, DeleteAccessPointPolicyForObjectLambdaCommand } = require("@aws-sdk/client-s3-control"); // CommonJS import + * const client = new S3ControlClient(config); + * const command = new DeleteAccessPointPolicyForObjectLambdaCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteAccessPointPolicyForObjectLambdaCommandInput} for command's `input` shape. + * @see {@link DeleteAccessPointPolicyForObjectLambdaCommandOutput} for command's `response` shape. + * @see {@link S3ControlClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteAccessPointPolicyForObjectLambdaCommand extends $Command< DeleteAccessPointPolicyForObjectLambdaCommandInput, diff --git a/clients/client-s3-control/commands/DeleteBucketCommand.ts b/clients/client-s3-control/commands/DeleteBucketCommand.ts index c4b5fabb798c..675bcc9c0407 100644 --- a/clients/client-s3-control/commands/DeleteBucketCommand.ts +++ b/clients/client-s3-control/commands/DeleteBucketCommand.ts @@ -51,6 +51,20 @@ export interface DeleteBucketCommandOutput extends __MetadataBearer {} *

* * + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { S3ControlClient, DeleteBucketCommand } from "@aws-sdk/client-s3-control"; // ES Modules import + * // const { S3ControlClient, DeleteBucketCommand } = require("@aws-sdk/client-s3-control"); // CommonJS import + * const client = new S3ControlClient(config); + * const command = new DeleteBucketCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteBucketCommandInput} for command's `input` shape. + * @see {@link DeleteBucketCommandOutput} for command's `response` shape. + * @see {@link S3ControlClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteBucketCommand extends $Command< DeleteBucketCommandInput, diff --git a/clients/client-s3-control/commands/DeleteBucketLifecycleConfigurationCommand.ts b/clients/client-s3-control/commands/DeleteBucketLifecycleConfigurationCommand.ts index 619ef613f12a..b02249aa45b5 100644 --- a/clients/client-s3-control/commands/DeleteBucketLifecycleConfigurationCommand.ts +++ b/clients/client-s3-control/commands/DeleteBucketLifecycleConfigurationCommand.ts @@ -51,6 +51,20 @@ export interface DeleteBucketLifecycleConfigurationCommandOutput extends __Metad *

* * + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { S3ControlClient, DeleteBucketLifecycleConfigurationCommand } from "@aws-sdk/client-s3-control"; // ES Modules import + * // const { S3ControlClient, DeleteBucketLifecycleConfigurationCommand } = require("@aws-sdk/client-s3-control"); // CommonJS import + * const client = new S3ControlClient(config); + * const command = new DeleteBucketLifecycleConfigurationCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteBucketLifecycleConfigurationCommandInput} for command's `input` shape. + * @see {@link DeleteBucketLifecycleConfigurationCommandOutput} for command's `response` shape. + * @see {@link S3ControlClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteBucketLifecycleConfigurationCommand extends $Command< DeleteBucketLifecycleConfigurationCommandInput, diff --git a/clients/client-s3-control/commands/DeleteBucketPolicyCommand.ts b/clients/client-s3-control/commands/DeleteBucketPolicyCommand.ts index ada885f4a7f8..6e74d0dfc0b8 100644 --- a/clients/client-s3-control/commands/DeleteBucketPolicyCommand.ts +++ b/clients/client-s3-control/commands/DeleteBucketPolicyCommand.ts @@ -63,6 +63,20 @@ export interface DeleteBucketPolicyCommandOutput extends __MetadataBearer {} *

* * + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { S3ControlClient, DeleteBucketPolicyCommand } from "@aws-sdk/client-s3-control"; // ES Modules import + * // const { S3ControlClient, DeleteBucketPolicyCommand } = require("@aws-sdk/client-s3-control"); // CommonJS import + * const client = new S3ControlClient(config); + * const command = new DeleteBucketPolicyCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteBucketPolicyCommandInput} for command's `input` shape. + * @see {@link DeleteBucketPolicyCommandOutput} for command's `response` shape. + * @see {@link S3ControlClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteBucketPolicyCommand extends $Command< DeleteBucketPolicyCommandInput, diff --git a/clients/client-s3-control/commands/DeleteBucketTaggingCommand.ts b/clients/client-s3-control/commands/DeleteBucketTaggingCommand.ts index 75ac293c3448..7f3ab86bbe73 100644 --- a/clients/client-s3-control/commands/DeleteBucketTaggingCommand.ts +++ b/clients/client-s3-control/commands/DeleteBucketTaggingCommand.ts @@ -49,6 +49,20 @@ export interface DeleteBucketTaggingCommandOutput extends __MetadataBearer {} *

* * + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { S3ControlClient, DeleteBucketTaggingCommand } from "@aws-sdk/client-s3-control"; // ES Modules import + * // const { S3ControlClient, DeleteBucketTaggingCommand } = require("@aws-sdk/client-s3-control"); // CommonJS import + * const client = new S3ControlClient(config); + * const command = new DeleteBucketTaggingCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteBucketTaggingCommandInput} for command's `input` shape. + * @see {@link DeleteBucketTaggingCommandOutput} for command's `response` shape. + * @see {@link S3ControlClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteBucketTaggingCommand extends $Command< DeleteBucketTaggingCommandInput, diff --git a/clients/client-s3-control/commands/DeleteJobTaggingCommand.ts b/clients/client-s3-control/commands/DeleteJobTaggingCommand.ts index d8abc4cc03f6..bf1a116f1691 100644 --- a/clients/client-s3-control/commands/DeleteJobTaggingCommand.ts +++ b/clients/client-s3-control/commands/DeleteJobTaggingCommand.ts @@ -45,6 +45,20 @@ export interface DeleteJobTaggingCommandOutput extends DeleteJobTaggingResult, _ *

* * + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { S3ControlClient, DeleteJobTaggingCommand } from "@aws-sdk/client-s3-control"; // ES Modules import + * // const { S3ControlClient, DeleteJobTaggingCommand } = require("@aws-sdk/client-s3-control"); // CommonJS import + * const client = new S3ControlClient(config); + * const command = new DeleteJobTaggingCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteJobTaggingCommandInput} for command's `input` shape. + * @see {@link DeleteJobTaggingCommandOutput} for command's `response` shape. + * @see {@link S3ControlClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteJobTaggingCommand extends $Command< DeleteJobTaggingCommandInput, diff --git a/clients/client-s3-control/commands/DeletePublicAccessBlockCommand.ts b/clients/client-s3-control/commands/DeletePublicAccessBlockCommand.ts index 6a641339fa12..14cf2ef720fc 100644 --- a/clients/client-s3-control/commands/DeletePublicAccessBlockCommand.ts +++ b/clients/client-s3-control/commands/DeletePublicAccessBlockCommand.ts @@ -38,6 +38,20 @@ export interface DeletePublicAccessBlockCommandOutput extends __MetadataBearer { *

* * + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { S3ControlClient, DeletePublicAccessBlockCommand } from "@aws-sdk/client-s3-control"; // ES Modules import + * // const { S3ControlClient, DeletePublicAccessBlockCommand } = require("@aws-sdk/client-s3-control"); // CommonJS import + * const client = new S3ControlClient(config); + * const command = new DeletePublicAccessBlockCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeletePublicAccessBlockCommandInput} for command's `input` shape. + * @see {@link DeletePublicAccessBlockCommandOutput} for command's `response` shape. + * @see {@link S3ControlClientResolvedConfig | config} for command's `input` shape. + * */ export class DeletePublicAccessBlockCommand extends $Command< DeletePublicAccessBlockCommandInput, diff --git a/clients/client-s3-control/commands/DeleteStorageLensConfigurationCommand.ts b/clients/client-s3-control/commands/DeleteStorageLensConfigurationCommand.ts index 2e2bf7e10a6d..8ba956c91008 100644 --- a/clients/client-s3-control/commands/DeleteStorageLensConfigurationCommand.ts +++ b/clients/client-s3-control/commands/DeleteStorageLensConfigurationCommand.ts @@ -32,6 +32,20 @@ export interface DeleteStorageLensConfigurationCommandOutput extends __MetadataB * information, see Setting permissions to use Amazon S3 Storage Lens in the * Amazon Simple Storage Service User Guide.

* + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { S3ControlClient, DeleteStorageLensConfigurationCommand } from "@aws-sdk/client-s3-control"; // ES Modules import + * // const { S3ControlClient, DeleteStorageLensConfigurationCommand } = require("@aws-sdk/client-s3-control"); // CommonJS import + * const client = new S3ControlClient(config); + * const command = new DeleteStorageLensConfigurationCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteStorageLensConfigurationCommandInput} for command's `input` shape. + * @see {@link DeleteStorageLensConfigurationCommandOutput} for command's `response` shape. + * @see {@link S3ControlClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteStorageLensConfigurationCommand extends $Command< DeleteStorageLensConfigurationCommandInput, diff --git a/clients/client-s3-control/commands/DeleteStorageLensConfigurationTaggingCommand.ts b/clients/client-s3-control/commands/DeleteStorageLensConfigurationTaggingCommand.ts index c874698796d0..24f1e6339a1b 100644 --- a/clients/client-s3-control/commands/DeleteStorageLensConfigurationTaggingCommand.ts +++ b/clients/client-s3-control/commands/DeleteStorageLensConfigurationTaggingCommand.ts @@ -38,6 +38,20 @@ export interface DeleteStorageLensConfigurationTaggingCommandOutput * information, see Setting permissions to use Amazon S3 Storage Lens in the * Amazon Simple Storage Service User Guide.

* + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { S3ControlClient, DeleteStorageLensConfigurationTaggingCommand } from "@aws-sdk/client-s3-control"; // ES Modules import + * // const { S3ControlClient, DeleteStorageLensConfigurationTaggingCommand } = require("@aws-sdk/client-s3-control"); // CommonJS import + * const client = new S3ControlClient(config); + * const command = new DeleteStorageLensConfigurationTaggingCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteStorageLensConfigurationTaggingCommandInput} for command's `input` shape. + * @see {@link DeleteStorageLensConfigurationTaggingCommandOutput} for command's `response` shape. + * @see {@link S3ControlClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteStorageLensConfigurationTaggingCommand extends $Command< DeleteStorageLensConfigurationTaggingCommandInput, diff --git a/clients/client-s3-control/commands/DescribeJobCommand.ts b/clients/client-s3-control/commands/DescribeJobCommand.ts index 04b1b30a4817..cfd44bc43c58 100644 --- a/clients/client-s3-control/commands/DescribeJobCommand.ts +++ b/clients/client-s3-control/commands/DescribeJobCommand.ts @@ -49,6 +49,20 @@ export interface DescribeJobCommandOutput extends DescribeJobResult, __MetadataB *

* * + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { S3ControlClient, DescribeJobCommand } from "@aws-sdk/client-s3-control"; // ES Modules import + * // const { S3ControlClient, DescribeJobCommand } = require("@aws-sdk/client-s3-control"); // CommonJS import + * const client = new S3ControlClient(config); + * const command = new DescribeJobCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeJobCommandInput} for command's `input` shape. + * @see {@link DescribeJobCommandOutput} for command's `response` shape. + * @see {@link S3ControlClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeJobCommand extends $Command< DescribeJobCommandInput, diff --git a/clients/client-s3-control/commands/GetAccessPointCommand.ts b/clients/client-s3-control/commands/GetAccessPointCommand.ts index d85231951633..dab2e7535b4d 100644 --- a/clients/client-s3-control/commands/GetAccessPointCommand.ts +++ b/clients/client-s3-control/commands/GetAccessPointCommand.ts @@ -44,6 +44,20 @@ export interface GetAccessPointCommandOutput extends GetAccessPointResult, __Met *

* * + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { S3ControlClient, GetAccessPointCommand } from "@aws-sdk/client-s3-control"; // ES Modules import + * // const { S3ControlClient, GetAccessPointCommand } = require("@aws-sdk/client-s3-control"); // CommonJS import + * const client = new S3ControlClient(config); + * const command = new GetAccessPointCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetAccessPointCommandInput} for command's `input` shape. + * @see {@link GetAccessPointCommandOutput} for command's `response` shape. + * @see {@link S3ControlClientResolvedConfig | config} for command's `input` shape. + * */ export class GetAccessPointCommand extends $Command< GetAccessPointCommandInput, diff --git a/clients/client-s3-control/commands/GetAccessPointConfigurationForObjectLambdaCommand.ts b/clients/client-s3-control/commands/GetAccessPointConfigurationForObjectLambdaCommand.ts index 9daec428dedf..f021946781b2 100644 --- a/clients/client-s3-control/commands/GetAccessPointConfigurationForObjectLambdaCommand.ts +++ b/clients/client-s3-control/commands/GetAccessPointConfigurationForObjectLambdaCommand.ts @@ -37,6 +37,20 @@ export interface GetAccessPointConfigurationForObjectLambdaCommandOutput *

* * + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { S3ControlClient, GetAccessPointConfigurationForObjectLambdaCommand } from "@aws-sdk/client-s3-control"; // ES Modules import + * // const { S3ControlClient, GetAccessPointConfigurationForObjectLambdaCommand } = require("@aws-sdk/client-s3-control"); // CommonJS import + * const client = new S3ControlClient(config); + * const command = new GetAccessPointConfigurationForObjectLambdaCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetAccessPointConfigurationForObjectLambdaCommandInput} for command's `input` shape. + * @see {@link GetAccessPointConfigurationForObjectLambdaCommandOutput} for command's `response` shape. + * @see {@link S3ControlClientResolvedConfig | config} for command's `input` shape. + * */ export class GetAccessPointConfigurationForObjectLambdaCommand extends $Command< GetAccessPointConfigurationForObjectLambdaCommandInput, diff --git a/clients/client-s3-control/commands/GetAccessPointForObjectLambdaCommand.ts b/clients/client-s3-control/commands/GetAccessPointForObjectLambdaCommand.ts index 58ace09c433a..a5221231ffdc 100644 --- a/clients/client-s3-control/commands/GetAccessPointForObjectLambdaCommand.ts +++ b/clients/client-s3-control/commands/GetAccessPointForObjectLambdaCommand.ts @@ -43,6 +43,20 @@ export interface GetAccessPointForObjectLambdaCommandOutput *

* * + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { S3ControlClient, GetAccessPointForObjectLambdaCommand } from "@aws-sdk/client-s3-control"; // ES Modules import + * // const { S3ControlClient, GetAccessPointForObjectLambdaCommand } = require("@aws-sdk/client-s3-control"); // CommonJS import + * const client = new S3ControlClient(config); + * const command = new GetAccessPointForObjectLambdaCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetAccessPointForObjectLambdaCommandInput} for command's `input` shape. + * @see {@link GetAccessPointForObjectLambdaCommandOutput} for command's `response` shape. + * @see {@link S3ControlClientResolvedConfig | config} for command's `input` shape. + * */ export class GetAccessPointForObjectLambdaCommand extends $Command< GetAccessPointForObjectLambdaCommandInput, diff --git a/clients/client-s3-control/commands/GetAccessPointPolicyCommand.ts b/clients/client-s3-control/commands/GetAccessPointPolicyCommand.ts index d530b483579e..f00c133a5dfa 100644 --- a/clients/client-s3-control/commands/GetAccessPointPolicyCommand.ts +++ b/clients/client-s3-control/commands/GetAccessPointPolicyCommand.ts @@ -36,6 +36,20 @@ export interface GetAccessPointPolicyCommandOutput extends GetAccessPointPolicyR *

* * + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { S3ControlClient, GetAccessPointPolicyCommand } from "@aws-sdk/client-s3-control"; // ES Modules import + * // const { S3ControlClient, GetAccessPointPolicyCommand } = require("@aws-sdk/client-s3-control"); // CommonJS import + * const client = new S3ControlClient(config); + * const command = new GetAccessPointPolicyCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetAccessPointPolicyCommandInput} for command's `input` shape. + * @see {@link GetAccessPointPolicyCommandOutput} for command's `response` shape. + * @see {@link S3ControlClientResolvedConfig | config} for command's `input` shape. + * */ export class GetAccessPointPolicyCommand extends $Command< GetAccessPointPolicyCommandInput, diff --git a/clients/client-s3-control/commands/GetAccessPointPolicyForObjectLambdaCommand.ts b/clients/client-s3-control/commands/GetAccessPointPolicyForObjectLambdaCommand.ts index f8d4eea7c391..7d47107bee5c 100644 --- a/clients/client-s3-control/commands/GetAccessPointPolicyForObjectLambdaCommand.ts +++ b/clients/client-s3-control/commands/GetAccessPointPolicyForObjectLambdaCommand.ts @@ -41,6 +41,20 @@ export interface GetAccessPointPolicyForObjectLambdaCommandOutput *

* * + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { S3ControlClient, GetAccessPointPolicyForObjectLambdaCommand } from "@aws-sdk/client-s3-control"; // ES Modules import + * // const { S3ControlClient, GetAccessPointPolicyForObjectLambdaCommand } = require("@aws-sdk/client-s3-control"); // CommonJS import + * const client = new S3ControlClient(config); + * const command = new GetAccessPointPolicyForObjectLambdaCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetAccessPointPolicyForObjectLambdaCommandInput} for command's `input` shape. + * @see {@link GetAccessPointPolicyForObjectLambdaCommandOutput} for command's `response` shape. + * @see {@link S3ControlClientResolvedConfig | config} for command's `input` shape. + * */ export class GetAccessPointPolicyForObjectLambdaCommand extends $Command< GetAccessPointPolicyForObjectLambdaCommandInput, diff --git a/clients/client-s3-control/commands/GetAccessPointPolicyStatusCommand.ts b/clients/client-s3-control/commands/GetAccessPointPolicyStatusCommand.ts index 39d19f664194..602481854d5d 100644 --- a/clients/client-s3-control/commands/GetAccessPointPolicyStatusCommand.ts +++ b/clients/client-s3-control/commands/GetAccessPointPolicyStatusCommand.ts @@ -23,6 +23,20 @@ export interface GetAccessPointPolicyStatusCommandOutput extends GetAccessPointP /** *

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 Simple Storage Service Developer Guide.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { S3ControlClient, GetAccessPointPolicyStatusCommand } from "@aws-sdk/client-s3-control"; // ES Modules import + * // const { S3ControlClient, GetAccessPointPolicyStatusCommand } = require("@aws-sdk/client-s3-control"); // CommonJS import + * const client = new S3ControlClient(config); + * const command = new GetAccessPointPolicyStatusCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetAccessPointPolicyStatusCommandInput} for command's `input` shape. + * @see {@link GetAccessPointPolicyStatusCommandOutput} for command's `response` shape. + * @see {@link S3ControlClientResolvedConfig | config} for command's `input` shape. + * */ export class GetAccessPointPolicyStatusCommand extends $Command< GetAccessPointPolicyStatusCommandInput, diff --git a/clients/client-s3-control/commands/GetAccessPointPolicyStatusForObjectLambdaCommand.ts b/clients/client-s3-control/commands/GetAccessPointPolicyStatusForObjectLambdaCommand.ts index 0765f05a3f99..fae297b1d7e1 100644 --- a/clients/client-s3-control/commands/GetAccessPointPolicyStatusForObjectLambdaCommand.ts +++ b/clients/client-s3-control/commands/GetAccessPointPolicyStatusForObjectLambdaCommand.ts @@ -29,6 +29,20 @@ export interface GetAccessPointPolicyStatusForObjectLambdaCommandOutput /** *

Returns the status of the resource policy associated with an Object Lambda Access Point.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { S3ControlClient, GetAccessPointPolicyStatusForObjectLambdaCommand } from "@aws-sdk/client-s3-control"; // ES Modules import + * // const { S3ControlClient, GetAccessPointPolicyStatusForObjectLambdaCommand } = require("@aws-sdk/client-s3-control"); // CommonJS import + * const client = new S3ControlClient(config); + * const command = new GetAccessPointPolicyStatusForObjectLambdaCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetAccessPointPolicyStatusForObjectLambdaCommandInput} for command's `input` shape. + * @see {@link GetAccessPointPolicyStatusForObjectLambdaCommandOutput} for command's `response` shape. + * @see {@link S3ControlClientResolvedConfig | config} for command's `input` shape. + * */ export class GetAccessPointPolicyStatusForObjectLambdaCommand extends $Command< GetAccessPointPolicyStatusForObjectLambdaCommandInput, diff --git a/clients/client-s3-control/commands/GetBucketCommand.ts b/clients/client-s3-control/commands/GetBucketCommand.ts index ac7e9fb19c4b..a024d77a4979 100644 --- a/clients/client-s3-control/commands/GetBucketCommand.ts +++ b/clients/client-s3-control/commands/GetBucketCommand.ts @@ -50,6 +50,20 @@ export interface GetBucketCommandOutput extends GetBucketResult, __MetadataBeare *

* * + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { S3ControlClient, GetBucketCommand } from "@aws-sdk/client-s3-control"; // ES Modules import + * // const { S3ControlClient, GetBucketCommand } = require("@aws-sdk/client-s3-control"); // CommonJS import + * const client = new S3ControlClient(config); + * const command = new GetBucketCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetBucketCommandInput} for command's `input` shape. + * @see {@link GetBucketCommandOutput} for command's `response` shape. + * @see {@link S3ControlClientResolvedConfig | config} for command's `input` shape. + * */ export class GetBucketCommand extends $Command< GetBucketCommandInput, diff --git a/clients/client-s3-control/commands/GetBucketLifecycleConfigurationCommand.ts b/clients/client-s3-control/commands/GetBucketLifecycleConfigurationCommand.ts index 038fa9aa59f2..7c5bfc1a380e 100644 --- a/clients/client-s3-control/commands/GetBucketLifecycleConfigurationCommand.ts +++ b/clients/client-s3-control/commands/GetBucketLifecycleConfigurationCommand.ts @@ -73,6 +73,20 @@ export interface GetBucketLifecycleConfigurationCommandOutput *

* * + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { S3ControlClient, GetBucketLifecycleConfigurationCommand } from "@aws-sdk/client-s3-control"; // ES Modules import + * // const { S3ControlClient, GetBucketLifecycleConfigurationCommand } = require("@aws-sdk/client-s3-control"); // CommonJS import + * const client = new S3ControlClient(config); + * const command = new GetBucketLifecycleConfigurationCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetBucketLifecycleConfigurationCommandInput} for command's `input` shape. + * @see {@link GetBucketLifecycleConfigurationCommandOutput} for command's `response` shape. + * @see {@link S3ControlClientResolvedConfig | config} for command's `input` shape. + * */ export class GetBucketLifecycleConfigurationCommand extends $Command< GetBucketLifecycleConfigurationCommandInput, diff --git a/clients/client-s3-control/commands/GetBucketPolicyCommand.ts b/clients/client-s3-control/commands/GetBucketPolicyCommand.ts index f1cd8e21f187..baead5b6794b 100644 --- a/clients/client-s3-control/commands/GetBucketPolicyCommand.ts +++ b/clients/client-s3-control/commands/GetBucketPolicyCommand.ts @@ -63,6 +63,20 @@ export interface GetBucketPolicyCommandOutput extends GetBucketPolicyResult, __M *

* * + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { S3ControlClient, GetBucketPolicyCommand } from "@aws-sdk/client-s3-control"; // ES Modules import + * // const { S3ControlClient, GetBucketPolicyCommand } = require("@aws-sdk/client-s3-control"); // CommonJS import + * const client = new S3ControlClient(config); + * const command = new GetBucketPolicyCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetBucketPolicyCommandInput} for command's `input` shape. + * @see {@link GetBucketPolicyCommandOutput} for command's `response` shape. + * @see {@link S3ControlClientResolvedConfig | config} for command's `input` shape. + * */ export class GetBucketPolicyCommand extends $Command< GetBucketPolicyCommandInput, diff --git a/clients/client-s3-control/commands/GetBucketTaggingCommand.ts b/clients/client-s3-control/commands/GetBucketTaggingCommand.ts index 4938b22e50ef..2e7aa2e774cd 100644 --- a/clients/client-s3-control/commands/GetBucketTaggingCommand.ts +++ b/clients/client-s3-control/commands/GetBucketTaggingCommand.ts @@ -61,6 +61,20 @@ export interface GetBucketTaggingCommandOutput extends GetBucketTaggingResult, _ *

* * + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { S3ControlClient, GetBucketTaggingCommand } from "@aws-sdk/client-s3-control"; // ES Modules import + * // const { S3ControlClient, GetBucketTaggingCommand } = require("@aws-sdk/client-s3-control"); // CommonJS import + * const client = new S3ControlClient(config); + * const command = new GetBucketTaggingCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetBucketTaggingCommandInput} for command's `input` shape. + * @see {@link GetBucketTaggingCommandOutput} for command's `response` shape. + * @see {@link S3ControlClientResolvedConfig | config} for command's `input` shape. + * */ export class GetBucketTaggingCommand extends $Command< GetBucketTaggingCommandInput, diff --git a/clients/client-s3-control/commands/GetJobTaggingCommand.ts b/clients/client-s3-control/commands/GetJobTaggingCommand.ts index a04ce405e9d3..ef6f272e445a 100644 --- a/clients/client-s3-control/commands/GetJobTaggingCommand.ts +++ b/clients/client-s3-control/commands/GetJobTaggingCommand.ts @@ -46,6 +46,20 @@ export interface GetJobTaggingCommandOutput extends GetJobTaggingResult, __Metad *

* * + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { S3ControlClient, GetJobTaggingCommand } from "@aws-sdk/client-s3-control"; // ES Modules import + * // const { S3ControlClient, GetJobTaggingCommand } = require("@aws-sdk/client-s3-control"); // CommonJS import + * const client = new S3ControlClient(config); + * const command = new GetJobTaggingCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetJobTaggingCommandInput} for command's `input` shape. + * @see {@link GetJobTaggingCommandOutput} for command's `response` shape. + * @see {@link S3ControlClientResolvedConfig | config} for command's `input` shape. + * */ export class GetJobTaggingCommand extends $Command< GetJobTaggingCommandInput, diff --git a/clients/client-s3-control/commands/GetPublicAccessBlockCommand.ts b/clients/client-s3-control/commands/GetPublicAccessBlockCommand.ts index fe7cd5bd74df..3f0ddab2a0a8 100644 --- a/clients/client-s3-control/commands/GetPublicAccessBlockCommand.ts +++ b/clients/client-s3-control/commands/GetPublicAccessBlockCommand.ts @@ -38,6 +38,20 @@ export interface GetPublicAccessBlockCommandOutput extends GetPublicAccessBlockO *

* * + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { S3ControlClient, GetPublicAccessBlockCommand } from "@aws-sdk/client-s3-control"; // ES Modules import + * // const { S3ControlClient, GetPublicAccessBlockCommand } = require("@aws-sdk/client-s3-control"); // CommonJS import + * const client = new S3ControlClient(config); + * const command = new GetPublicAccessBlockCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetPublicAccessBlockCommandInput} for command's `input` shape. + * @see {@link GetPublicAccessBlockCommandOutput} for command's `response` shape. + * @see {@link S3ControlClientResolvedConfig | config} for command's `input` shape. + * */ export class GetPublicAccessBlockCommand extends $Command< GetPublicAccessBlockCommandInput, diff --git a/clients/client-s3-control/commands/GetStorageLensConfigurationCommand.ts b/clients/client-s3-control/commands/GetStorageLensConfigurationCommand.ts index bedf5cb7ba28..3a012705e78b 100644 --- a/clients/client-s3-control/commands/GetStorageLensConfigurationCommand.ts +++ b/clients/client-s3-control/commands/GetStorageLensConfigurationCommand.ts @@ -32,6 +32,20 @@ export interface GetStorageLensConfigurationCommandOutput extends GetStorageLens * information, see Setting permissions to use Amazon S3 Storage Lens in the * Amazon Simple Storage Service User Guide.

* + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { S3ControlClient, GetStorageLensConfigurationCommand } from "@aws-sdk/client-s3-control"; // ES Modules import + * // const { S3ControlClient, GetStorageLensConfigurationCommand } = require("@aws-sdk/client-s3-control"); // CommonJS import + * const client = new S3ControlClient(config); + * const command = new GetStorageLensConfigurationCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetStorageLensConfigurationCommandInput} for command's `input` shape. + * @see {@link GetStorageLensConfigurationCommandOutput} for command's `response` shape. + * @see {@link S3ControlClientResolvedConfig | config} for command's `input` shape. + * */ export class GetStorageLensConfigurationCommand extends $Command< GetStorageLensConfigurationCommandInput, diff --git a/clients/client-s3-control/commands/GetStorageLensConfigurationTaggingCommand.ts b/clients/client-s3-control/commands/GetStorageLensConfigurationTaggingCommand.ts index 6986b4978959..265d1ae42027 100644 --- a/clients/client-s3-control/commands/GetStorageLensConfigurationTaggingCommand.ts +++ b/clients/client-s3-control/commands/GetStorageLensConfigurationTaggingCommand.ts @@ -36,6 +36,20 @@ export interface GetStorageLensConfigurationTaggingCommandOutput * information, see Setting permissions to use Amazon S3 Storage Lens in the * Amazon Simple Storage Service User Guide.

* + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { S3ControlClient, GetStorageLensConfigurationTaggingCommand } from "@aws-sdk/client-s3-control"; // ES Modules import + * // const { S3ControlClient, GetStorageLensConfigurationTaggingCommand } = require("@aws-sdk/client-s3-control"); // CommonJS import + * const client = new S3ControlClient(config); + * const command = new GetStorageLensConfigurationTaggingCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetStorageLensConfigurationTaggingCommandInput} for command's `input` shape. + * @see {@link GetStorageLensConfigurationTaggingCommandOutput} for command's `response` shape. + * @see {@link S3ControlClientResolvedConfig | config} for command's `input` shape. + * */ export class GetStorageLensConfigurationTaggingCommand extends $Command< GetStorageLensConfigurationTaggingCommandInput, diff --git a/clients/client-s3-control/commands/ListAccessPointsCommand.ts b/clients/client-s3-control/commands/ListAccessPointsCommand.ts index 5cdf5f0b2036..fab177ab2d26 100644 --- a/clients/client-s3-control/commands/ListAccessPointsCommand.ts +++ b/clients/client-s3-control/commands/ListAccessPointsCommand.ts @@ -47,6 +47,20 @@ export interface ListAccessPointsCommandOutput extends ListAccessPointsResult, _ *

* * + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { S3ControlClient, ListAccessPointsCommand } from "@aws-sdk/client-s3-control"; // ES Modules import + * // const { S3ControlClient, ListAccessPointsCommand } = require("@aws-sdk/client-s3-control"); // CommonJS import + * const client = new S3ControlClient(config); + * const command = new ListAccessPointsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListAccessPointsCommandInput} for command's `input` shape. + * @see {@link ListAccessPointsCommandOutput} for command's `response` shape. + * @see {@link S3ControlClientResolvedConfig | config} for command's `input` shape. + * */ export class ListAccessPointsCommand extends $Command< ListAccessPointsCommandInput, diff --git a/clients/client-s3-control/commands/ListAccessPointsForObjectLambdaCommand.ts b/clients/client-s3-control/commands/ListAccessPointsForObjectLambdaCommand.ts index 84ccf75f3ee3..40df98d0df51 100644 --- a/clients/client-s3-control/commands/ListAccessPointsForObjectLambdaCommand.ts +++ b/clients/client-s3-control/commands/ListAccessPointsForObjectLambdaCommand.ts @@ -47,6 +47,20 @@ export interface ListAccessPointsForObjectLambdaCommandOutput *

* * + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { S3ControlClient, ListAccessPointsForObjectLambdaCommand } from "@aws-sdk/client-s3-control"; // ES Modules import + * // const { S3ControlClient, ListAccessPointsForObjectLambdaCommand } = require("@aws-sdk/client-s3-control"); // CommonJS import + * const client = new S3ControlClient(config); + * const command = new ListAccessPointsForObjectLambdaCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListAccessPointsForObjectLambdaCommandInput} for command's `input` shape. + * @see {@link ListAccessPointsForObjectLambdaCommandOutput} for command's `response` shape. + * @see {@link S3ControlClientResolvedConfig | config} for command's `input` shape. + * */ export class ListAccessPointsForObjectLambdaCommand extends $Command< ListAccessPointsForObjectLambdaCommandInput, diff --git a/clients/client-s3-control/commands/ListJobsCommand.ts b/clients/client-s3-control/commands/ListJobsCommand.ts index 4ddbcc85db07..7bc7ec73b9e0 100644 --- a/clients/client-s3-control/commands/ListJobsCommand.ts +++ b/clients/client-s3-control/commands/ListJobsCommand.ts @@ -46,6 +46,20 @@ export interface ListJobsCommandOutput extends ListJobsResult, __MetadataBearer *

* * + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { S3ControlClient, ListJobsCommand } from "@aws-sdk/client-s3-control"; // ES Modules import + * // const { S3ControlClient, ListJobsCommand } = require("@aws-sdk/client-s3-control"); // CommonJS import + * const client = new S3ControlClient(config); + * const command = new ListJobsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListJobsCommandInput} for command's `input` shape. + * @see {@link ListJobsCommandOutput} for command's `response` shape. + * @see {@link S3ControlClientResolvedConfig | config} for command's `input` shape. + * */ export class ListJobsCommand extends $Command< ListJobsCommandInput, diff --git a/clients/client-s3-control/commands/ListRegionalBucketsCommand.ts b/clients/client-s3-control/commands/ListRegionalBucketsCommand.ts index fe4644658d3b..01f2a77fca13 100644 --- a/clients/client-s3-control/commands/ListRegionalBucketsCommand.ts +++ b/clients/client-s3-control/commands/ListRegionalBucketsCommand.ts @@ -27,6 +27,20 @@ export interface ListRegionalBucketsCommandOutput extends ListRegionalBucketsRes * Amazon Simple Storage Service 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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { S3ControlClient, ListRegionalBucketsCommand } from "@aws-sdk/client-s3-control"; // ES Modules import + * // const { S3ControlClient, ListRegionalBucketsCommand } = require("@aws-sdk/client-s3-control"); // CommonJS import + * const client = new S3ControlClient(config); + * const command = new ListRegionalBucketsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListRegionalBucketsCommandInput} for command's `input` shape. + * @see {@link ListRegionalBucketsCommandOutput} for command's `response` shape. + * @see {@link S3ControlClientResolvedConfig | config} for command's `input` shape. + * */ export class ListRegionalBucketsCommand extends $Command< ListRegionalBucketsCommandInput, diff --git a/clients/client-s3-control/commands/ListStorageLensConfigurationsCommand.ts b/clients/client-s3-control/commands/ListStorageLensConfigurationsCommand.ts index 1bf9042d9aa2..0d90c077645e 100644 --- a/clients/client-s3-control/commands/ListStorageLensConfigurationsCommand.ts +++ b/clients/client-s3-control/commands/ListStorageLensConfigurationsCommand.ts @@ -34,6 +34,20 @@ export interface ListStorageLensConfigurationsCommandOutput * information, see Setting permissions to use Amazon S3 Storage Lens in the * Amazon Simple Storage Service User Guide.

* + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { S3ControlClient, ListStorageLensConfigurationsCommand } from "@aws-sdk/client-s3-control"; // ES Modules import + * // const { S3ControlClient, ListStorageLensConfigurationsCommand } = require("@aws-sdk/client-s3-control"); // CommonJS import + * const client = new S3ControlClient(config); + * const command = new ListStorageLensConfigurationsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListStorageLensConfigurationsCommandInput} for command's `input` shape. + * @see {@link ListStorageLensConfigurationsCommandOutput} for command's `response` shape. + * @see {@link S3ControlClientResolvedConfig | config} for command's `input` shape. + * */ export class ListStorageLensConfigurationsCommand extends $Command< ListStorageLensConfigurationsCommandInput, diff --git a/clients/client-s3-control/commands/PutAccessPointConfigurationForObjectLambdaCommand.ts b/clients/client-s3-control/commands/PutAccessPointConfigurationForObjectLambdaCommand.ts index b9c521bb0f25..82b3bd1069c9 100644 --- a/clients/client-s3-control/commands/PutAccessPointConfigurationForObjectLambdaCommand.ts +++ b/clients/client-s3-control/commands/PutAccessPointConfigurationForObjectLambdaCommand.ts @@ -32,6 +32,20 @@ export interface PutAccessPointConfigurationForObjectLambdaCommandOutput extends *

* * + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { S3ControlClient, PutAccessPointConfigurationForObjectLambdaCommand } from "@aws-sdk/client-s3-control"; // ES Modules import + * // const { S3ControlClient, PutAccessPointConfigurationForObjectLambdaCommand } = require("@aws-sdk/client-s3-control"); // CommonJS import + * const client = new S3ControlClient(config); + * const command = new PutAccessPointConfigurationForObjectLambdaCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link PutAccessPointConfigurationForObjectLambdaCommandInput} for command's `input` shape. + * @see {@link PutAccessPointConfigurationForObjectLambdaCommandOutput} for command's `response` shape. + * @see {@link S3ControlClientResolvedConfig | config} for command's `input` shape. + * */ export class PutAccessPointConfigurationForObjectLambdaCommand extends $Command< PutAccessPointConfigurationForObjectLambdaCommandInput, diff --git a/clients/client-s3-control/commands/PutAccessPointPolicyCommand.ts b/clients/client-s3-control/commands/PutAccessPointPolicyCommand.ts index 2842791471cc..b4cdf608ac89 100644 --- a/clients/client-s3-control/commands/PutAccessPointPolicyCommand.ts +++ b/clients/client-s3-control/commands/PutAccessPointPolicyCommand.ts @@ -39,6 +39,20 @@ export interface PutAccessPointPolicyCommandOutput extends __MetadataBearer {} *

* * + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { S3ControlClient, PutAccessPointPolicyCommand } from "@aws-sdk/client-s3-control"; // ES Modules import + * // const { S3ControlClient, PutAccessPointPolicyCommand } = require("@aws-sdk/client-s3-control"); // CommonJS import + * const client = new S3ControlClient(config); + * const command = new PutAccessPointPolicyCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link PutAccessPointPolicyCommandInput} for command's `input` shape. + * @see {@link PutAccessPointPolicyCommandOutput} for command's `response` shape. + * @see {@link S3ControlClientResolvedConfig | config} for command's `input` shape. + * */ export class PutAccessPointPolicyCommand extends $Command< PutAccessPointPolicyCommandInput, diff --git a/clients/client-s3-control/commands/PutAccessPointPolicyForObjectLambdaCommand.ts b/clients/client-s3-control/commands/PutAccessPointPolicyForObjectLambdaCommand.ts index aa074ef61f29..7769ab1f7ab0 100644 --- a/clients/client-s3-control/commands/PutAccessPointPolicyForObjectLambdaCommand.ts +++ b/clients/client-s3-control/commands/PutAccessPointPolicyForObjectLambdaCommand.ts @@ -37,6 +37,20 @@ export interface PutAccessPointPolicyForObjectLambdaCommandOutput extends __Meta *

* * + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { S3ControlClient, PutAccessPointPolicyForObjectLambdaCommand } from "@aws-sdk/client-s3-control"; // ES Modules import + * // const { S3ControlClient, PutAccessPointPolicyForObjectLambdaCommand } = require("@aws-sdk/client-s3-control"); // CommonJS import + * const client = new S3ControlClient(config); + * const command = new PutAccessPointPolicyForObjectLambdaCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link PutAccessPointPolicyForObjectLambdaCommandInput} for command's `input` shape. + * @see {@link PutAccessPointPolicyForObjectLambdaCommandOutput} for command's `response` shape. + * @see {@link S3ControlClientResolvedConfig | config} for command's `input` shape. + * */ export class PutAccessPointPolicyForObjectLambdaCommand extends $Command< PutAccessPointPolicyForObjectLambdaCommandInput, diff --git a/clients/client-s3-control/commands/PutBucketLifecycleConfigurationCommand.ts b/clients/client-s3-control/commands/PutBucketLifecycleConfigurationCommand.ts index 8fb0ceace90e..be3293f23d32 100644 --- a/clients/client-s3-control/commands/PutBucketLifecycleConfigurationCommand.ts +++ b/clients/client-s3-control/commands/PutBucketLifecycleConfigurationCommand.ts @@ -45,6 +45,20 @@ export interface PutBucketLifecycleConfigurationCommandOutput extends __Metadata *

* * + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { S3ControlClient, PutBucketLifecycleConfigurationCommand } from "@aws-sdk/client-s3-control"; // ES Modules import + * // const { S3ControlClient, PutBucketLifecycleConfigurationCommand } = require("@aws-sdk/client-s3-control"); // CommonJS import + * const client = new S3ControlClient(config); + * const command = new PutBucketLifecycleConfigurationCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link PutBucketLifecycleConfigurationCommandInput} for command's `input` shape. + * @see {@link PutBucketLifecycleConfigurationCommandOutput} for command's `response` shape. + * @see {@link S3ControlClientResolvedConfig | config} for command's `input` shape. + * */ export class PutBucketLifecycleConfigurationCommand extends $Command< PutBucketLifecycleConfigurationCommandInput, diff --git a/clients/client-s3-control/commands/PutBucketPolicyCommand.ts b/clients/client-s3-control/commands/PutBucketPolicyCommand.ts index 280cb968c007..7ea7a748f9e7 100644 --- a/clients/client-s3-control/commands/PutBucketPolicyCommand.ts +++ b/clients/client-s3-control/commands/PutBucketPolicyCommand.ts @@ -61,6 +61,20 @@ export interface PutBucketPolicyCommandOutput extends __MetadataBearer {} *

* * + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { S3ControlClient, PutBucketPolicyCommand } from "@aws-sdk/client-s3-control"; // ES Modules import + * // const { S3ControlClient, PutBucketPolicyCommand } = require("@aws-sdk/client-s3-control"); // CommonJS import + * const client = new S3ControlClient(config); + * const command = new PutBucketPolicyCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link PutBucketPolicyCommandInput} for command's `input` shape. + * @see {@link PutBucketPolicyCommandOutput} for command's `response` shape. + * @see {@link S3ControlClientResolvedConfig | config} for command's `input` shape. + * */ export class PutBucketPolicyCommand extends $Command< PutBucketPolicyCommandInput, diff --git a/clients/client-s3-control/commands/PutBucketTaggingCommand.ts b/clients/client-s3-control/commands/PutBucketTaggingCommand.ts index 3e026100d6a3..f3bb419b16e1 100644 --- a/clients/client-s3-control/commands/PutBucketTaggingCommand.ts +++ b/clients/client-s3-control/commands/PutBucketTaggingCommand.ts @@ -106,6 +106,20 @@ export interface PutBucketTaggingCommandOutput extends __MetadataBearer {} *

* * + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { S3ControlClient, PutBucketTaggingCommand } from "@aws-sdk/client-s3-control"; // ES Modules import + * // const { S3ControlClient, PutBucketTaggingCommand } = require("@aws-sdk/client-s3-control"); // CommonJS import + * const client = new S3ControlClient(config); + * const command = new PutBucketTaggingCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link PutBucketTaggingCommandInput} for command's `input` shape. + * @see {@link PutBucketTaggingCommandOutput} for command's `response` shape. + * @see {@link S3ControlClientResolvedConfig | config} for command's `input` shape. + * */ export class PutBucketTaggingCommand extends $Command< PutBucketTaggingCommandInput, diff --git a/clients/client-s3-control/commands/PutJobTaggingCommand.ts b/clients/client-s3-control/commands/PutJobTaggingCommand.ts index 3bfd137c80cf..4df08cfad011 100644 --- a/clients/client-s3-control/commands/PutJobTaggingCommand.ts +++ b/clients/client-s3-control/commands/PutJobTaggingCommand.ts @@ -86,6 +86,20 @@ export interface PutJobTaggingCommandOutput extends PutJobTaggingResult, __Metad *

* * + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { S3ControlClient, PutJobTaggingCommand } from "@aws-sdk/client-s3-control"; // ES Modules import + * // const { S3ControlClient, PutJobTaggingCommand } = require("@aws-sdk/client-s3-control"); // CommonJS import + * const client = new S3ControlClient(config); + * const command = new PutJobTaggingCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link PutJobTaggingCommandInput} for command's `input` shape. + * @see {@link PutJobTaggingCommandOutput} for command's `response` shape. + * @see {@link S3ControlClientResolvedConfig | config} for command's `input` shape. + * */ export class PutJobTaggingCommand extends $Command< PutJobTaggingCommandInput, diff --git a/clients/client-s3-control/commands/PutPublicAccessBlockCommand.ts b/clients/client-s3-control/commands/PutPublicAccessBlockCommand.ts index 902dcf899dd3..24073de83dda 100644 --- a/clients/client-s3-control/commands/PutPublicAccessBlockCommand.ts +++ b/clients/client-s3-control/commands/PutPublicAccessBlockCommand.ts @@ -38,6 +38,20 @@ export interface PutPublicAccessBlockCommandOutput extends __MetadataBearer {} *

* * + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { S3ControlClient, PutPublicAccessBlockCommand } from "@aws-sdk/client-s3-control"; // ES Modules import + * // const { S3ControlClient, PutPublicAccessBlockCommand } = require("@aws-sdk/client-s3-control"); // CommonJS import + * const client = new S3ControlClient(config); + * const command = new PutPublicAccessBlockCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link PutPublicAccessBlockCommandInput} for command's `input` shape. + * @see {@link PutPublicAccessBlockCommandOutput} for command's `response` shape. + * @see {@link S3ControlClientResolvedConfig | config} for command's `input` shape. + * */ export class PutPublicAccessBlockCommand extends $Command< PutPublicAccessBlockCommandInput, diff --git a/clients/client-s3-control/commands/PutStorageLensConfigurationCommand.ts b/clients/client-s3-control/commands/PutStorageLensConfigurationCommand.ts index 7672562abfff..c77b4d5fef60 100644 --- a/clients/client-s3-control/commands/PutStorageLensConfigurationCommand.ts +++ b/clients/client-s3-control/commands/PutStorageLensConfigurationCommand.ts @@ -30,6 +30,20 @@ export interface PutStorageLensConfigurationCommandOutput extends __MetadataBear * information, see Setting permissions to use Amazon S3 Storage Lens in the * Amazon Simple Storage Service User Guide.

* + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { S3ControlClient, PutStorageLensConfigurationCommand } from "@aws-sdk/client-s3-control"; // ES Modules import + * // const { S3ControlClient, PutStorageLensConfigurationCommand } = require("@aws-sdk/client-s3-control"); // CommonJS import + * const client = new S3ControlClient(config); + * const command = new PutStorageLensConfigurationCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link PutStorageLensConfigurationCommandInput} for command's `input` shape. + * @see {@link PutStorageLensConfigurationCommandOutput} for command's `response` shape. + * @see {@link S3ControlClientResolvedConfig | config} for command's `input` shape. + * */ export class PutStorageLensConfigurationCommand extends $Command< PutStorageLensConfigurationCommandInput, diff --git a/clients/client-s3-control/commands/PutStorageLensConfigurationTaggingCommand.ts b/clients/client-s3-control/commands/PutStorageLensConfigurationTaggingCommand.ts index f2679f126d91..6cf5103fe533 100644 --- a/clients/client-s3-control/commands/PutStorageLensConfigurationTaggingCommand.ts +++ b/clients/client-s3-control/commands/PutStorageLensConfigurationTaggingCommand.ts @@ -37,6 +37,20 @@ export interface PutStorageLensConfigurationTaggingCommandOutput * information, see Setting permissions to use Amazon S3 Storage Lens in the * Amazon Simple Storage Service User Guide.

* + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { S3ControlClient, PutStorageLensConfigurationTaggingCommand } from "@aws-sdk/client-s3-control"; // ES Modules import + * // const { S3ControlClient, PutStorageLensConfigurationTaggingCommand } = require("@aws-sdk/client-s3-control"); // CommonJS import + * const client = new S3ControlClient(config); + * const command = new PutStorageLensConfigurationTaggingCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link PutStorageLensConfigurationTaggingCommandInput} for command's `input` shape. + * @see {@link PutStorageLensConfigurationTaggingCommandOutput} for command's `response` shape. + * @see {@link S3ControlClientResolvedConfig | config} for command's `input` shape. + * */ export class PutStorageLensConfigurationTaggingCommand extends $Command< PutStorageLensConfigurationTaggingCommandInput, diff --git a/clients/client-s3-control/commands/UpdateJobPriorityCommand.ts b/clients/client-s3-control/commands/UpdateJobPriorityCommand.ts index 84ca80b8afdd..810978e4db4c 100644 --- a/clients/client-s3-control/commands/UpdateJobPriorityCommand.ts +++ b/clients/client-s3-control/commands/UpdateJobPriorityCommand.ts @@ -48,6 +48,20 @@ export interface UpdateJobPriorityCommandOutput extends UpdateJobPriorityResult, *

* * + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { S3ControlClient, UpdateJobPriorityCommand } from "@aws-sdk/client-s3-control"; // ES Modules import + * // const { S3ControlClient, UpdateJobPriorityCommand } = require("@aws-sdk/client-s3-control"); // CommonJS import + * const client = new S3ControlClient(config); + * const command = new UpdateJobPriorityCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link UpdateJobPriorityCommandInput} for command's `input` shape. + * @see {@link UpdateJobPriorityCommandOutput} for command's `response` shape. + * @see {@link S3ControlClientResolvedConfig | config} for command's `input` shape. + * */ export class UpdateJobPriorityCommand extends $Command< UpdateJobPriorityCommandInput, diff --git a/clients/client-s3-control/commands/UpdateJobStatusCommand.ts b/clients/client-s3-control/commands/UpdateJobStatusCommand.ts index ced29d67d619..601dba157dde 100644 --- a/clients/client-s3-control/commands/UpdateJobStatusCommand.ts +++ b/clients/client-s3-control/commands/UpdateJobStatusCommand.ts @@ -49,6 +49,20 @@ export interface UpdateJobStatusCommandOutput extends UpdateJobStatusResult, __M *

* * + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { S3ControlClient, UpdateJobStatusCommand } from "@aws-sdk/client-s3-control"; // ES Modules import + * // const { S3ControlClient, UpdateJobStatusCommand } = require("@aws-sdk/client-s3-control"); // CommonJS import + * const client = new S3ControlClient(config); + * const command = new UpdateJobStatusCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link UpdateJobStatusCommandInput} for command's `input` shape. + * @see {@link UpdateJobStatusCommandOutput} for command's `response` shape. + * @see {@link S3ControlClientResolvedConfig | config} for command's `input` shape. + * */ export class UpdateJobStatusCommand extends $Command< UpdateJobStatusCommandInput, diff --git a/clients/client-s3-control/models/models_0.ts b/clients/client-s3-control/models/models_0.ts index 217dbd5c0fc3..34a4e23c96e1 100644 --- a/clients/client-s3-control/models/models_0.ts +++ b/clients/client-s3-control/models/models_0.ts @@ -13,6 +13,9 @@ export interface AbortIncompleteMultipartUpload { } export namespace AbortIncompleteMultipartUpload { + /** + * @internal + */ export const filterSensitiveLog = (obj: AbortIncompleteMultipartUpload): any => ({ ...obj, }); @@ -34,6 +37,9 @@ export interface VpcConfiguration { } export namespace VpcConfiguration { + /** + * @internal + */ export const filterSensitiveLog = (obj: VpcConfiguration): any => ({ ...obj, }); @@ -75,6 +81,9 @@ export interface AccessPoint { } export namespace AccessPoint { + /** + * @internal + */ export const filterSensitiveLog = (obj: AccessPoint): any => ({ ...obj, }); @@ -91,6 +100,9 @@ export interface ActivityMetrics { } export namespace ActivityMetrics { + /** + * @internal + */ export const filterSensitiveLog = (obj: ActivityMetrics): any => ({ ...obj, }); @@ -120,6 +132,9 @@ export interface SelectionCriteria { } export namespace SelectionCriteria { + /** + * @internal + */ export const filterSensitiveLog = (obj: SelectionCriteria): any => ({ ...obj, }); @@ -141,6 +156,9 @@ export interface PrefixLevelStorageMetrics { } export namespace PrefixLevelStorageMetrics { + /** + * @internal + */ export const filterSensitiveLog = (obj: PrefixLevelStorageMetrics): any => ({ ...obj, }); @@ -157,6 +175,9 @@ export interface PrefixLevel { } export namespace PrefixLevel { + /** + * @internal + */ export const filterSensitiveLog = (obj: PrefixLevel): any => ({ ...obj, }); @@ -178,6 +199,9 @@ export interface BucketLevel { } export namespace BucketLevel { + /** + * @internal + */ export const filterSensitiveLog = (obj: BucketLevel): any => ({ ...obj, }); @@ -199,6 +223,9 @@ export interface AccountLevel { } export namespace AccountLevel { + /** + * @internal + */ export const filterSensitiveLog = (obj: AccountLevel): any => ({ ...obj, }); @@ -220,6 +247,9 @@ export interface AwsLambdaTransformation { } export namespace AwsLambdaTransformation { + /** + * @internal + */ export const filterSensitiveLog = (obj: AwsLambdaTransformation): any => ({ ...obj, }); @@ -284,6 +314,9 @@ export interface PublicAccessBlockConfiguration { } export namespace PublicAccessBlockConfiguration { + /** + * @internal + */ export const filterSensitiveLog = (obj: PublicAccessBlockConfiguration): any => ({ ...obj, }); @@ -325,6 +358,9 @@ export interface CreateAccessPointRequest { } export namespace CreateAccessPointRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateAccessPointRequest): any => ({ ...obj, }); @@ -341,6 +377,9 @@ export interface CreateAccessPointResult { } export namespace CreateAccessPointResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateAccessPointResult): any => ({ ...obj, }); @@ -386,6 +425,9 @@ export namespace ObjectLambdaContentTransformation { return visitor._(value.$unknown[0], value.$unknown[1]); }; + /** + * @internal + */ export const filterSensitiveLog = (obj: ObjectLambdaContentTransformation): any => { if (obj.AwsLambda !== undefined) return { AwsLambda: AwsLambdaTransformation.filterSensitiveLog(obj.AwsLambda) }; if (obj.$unknown !== undefined) return { [obj.$unknown[0]]: "UNKNOWN" }; @@ -408,6 +450,9 @@ export interface ObjectLambdaTransformationConfiguration { } export namespace ObjectLambdaTransformationConfiguration { + /** + * @internal + */ export const filterSensitiveLog = (obj: ObjectLambdaTransformationConfiguration): any => ({ ...obj, ...(obj.ContentTransformation && { @@ -443,6 +488,9 @@ export interface ObjectLambdaConfiguration { } export namespace ObjectLambdaConfiguration { + /** + * @internal + */ export const filterSensitiveLog = (obj: ObjectLambdaConfiguration): any => ({ ...obj, ...(obj.TransformationConfigurations && { @@ -471,6 +519,9 @@ export interface CreateAccessPointForObjectLambdaRequest { } export namespace CreateAccessPointForObjectLambdaRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateAccessPointForObjectLambdaRequest): any => ({ ...obj, ...(obj.Configuration && { Configuration: ObjectLambdaConfiguration.filterSensitiveLog(obj.Configuration) }), @@ -485,6 +536,9 @@ export interface CreateAccessPointForObjectLambdaResult { } export namespace CreateAccessPointForObjectLambdaResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateAccessPointForObjectLambdaResult): any => ({ ...obj, }); @@ -501,6 +555,9 @@ export interface BucketAlreadyExists extends __SmithyException, $MetadataBearer } export namespace BucketAlreadyExists { + /** + * @internal + */ export const filterSensitiveLog = (obj: BucketAlreadyExists): any => ({ ...obj, }); @@ -515,6 +572,9 @@ export interface BucketAlreadyOwnedByYou extends __SmithyException, $MetadataBea } export namespace BucketAlreadyOwnedByYou { + /** + * @internal + */ export const filterSensitiveLog = (obj: BucketAlreadyOwnedByYou): any => ({ ...obj, }); @@ -555,6 +615,9 @@ export interface CreateBucketConfiguration { } export namespace CreateBucketConfiguration { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateBucketConfiguration): any => ({ ...obj, }); @@ -640,6 +703,9 @@ export interface CreateBucketRequest { } export namespace CreateBucketRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateBucketRequest): any => ({ ...obj, }); @@ -660,6 +726,9 @@ export interface CreateBucketResult { } export namespace CreateBucketResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateBucketResult): any => ({ ...obj, }); @@ -675,6 +744,9 @@ export interface BadRequestException extends __SmithyException, $MetadataBearer } export namespace BadRequestException { + /** + * @internal + */ export const filterSensitiveLog = (obj: BadRequestException): any => ({ ...obj, }); @@ -706,6 +778,9 @@ export interface JobManifestLocation { } export namespace JobManifestLocation { + /** + * @internal + */ export const filterSensitiveLog = (obj: JobManifestLocation): any => ({ ...obj, }); @@ -739,6 +814,9 @@ export interface JobManifestSpec { } export namespace JobManifestSpec { + /** + * @internal + */ export const filterSensitiveLog = (obj: JobManifestSpec): any => ({ ...obj, }); @@ -760,6 +838,9 @@ export interface JobManifest { } export namespace JobManifest { + /** + * @internal + */ export const filterSensitiveLog = (obj: JobManifest): any => ({ ...obj, }); @@ -776,6 +857,9 @@ export interface LambdaInvokeOperation { } export namespace LambdaInvokeOperation { + /** + * @internal + */ export const filterSensitiveLog = (obj: LambdaInvokeOperation): any => ({ ...obj, }); @@ -787,6 +871,9 @@ export namespace LambdaInvokeOperation { export interface S3DeleteObjectTaggingOperation {} export namespace S3DeleteObjectTaggingOperation { + /** + * @internal + */ export const filterSensitiveLog = (obj: S3DeleteObjectTaggingOperation): any => ({ ...obj, }); @@ -828,6 +915,9 @@ export interface S3InitiateRestoreObjectOperation { } export namespace S3InitiateRestoreObjectOperation { + /** + * @internal + */ export const filterSensitiveLog = (obj: S3InitiateRestoreObjectOperation): any => ({ ...obj, }); @@ -860,6 +950,9 @@ export interface S3Grantee { } export namespace S3Grantee { + /** + * @internal + */ export const filterSensitiveLog = (obj: S3Grantee): any => ({ ...obj, }); @@ -889,6 +982,9 @@ export interface S3Grant { } export namespace S3Grant { + /** + * @internal + */ export const filterSensitiveLog = (obj: S3Grant): any => ({ ...obj, }); @@ -910,6 +1006,9 @@ export interface S3ObjectOwner { } export namespace S3ObjectOwner { + /** + * @internal + */ export const filterSensitiveLog = (obj: S3ObjectOwner): any => ({ ...obj, }); @@ -931,6 +1030,9 @@ export interface S3AccessControlList { } export namespace S3AccessControlList { + /** + * @internal + */ export const filterSensitiveLog = (obj: S3AccessControlList): any => ({ ...obj, }); @@ -962,6 +1064,9 @@ export interface S3AccessControlPolicy { } export namespace S3AccessControlPolicy { + /** + * @internal + */ export const filterSensitiveLog = (obj: S3AccessControlPolicy): any => ({ ...obj, }); @@ -979,6 +1084,9 @@ export interface S3SetObjectAclOperation { } export namespace S3SetObjectAclOperation { + /** + * @internal + */ export const filterSensitiveLog = (obj: S3SetObjectAclOperation): any => ({ ...obj, }); @@ -1055,6 +1163,9 @@ export interface S3ObjectMetadata { } export namespace S3ObjectMetadata { + /** + * @internal + */ export const filterSensitiveLog = (obj: S3ObjectMetadata): any => ({ ...obj, }); @@ -1076,6 +1187,9 @@ export interface S3Tag { } export namespace S3Tag { + /** + * @internal + */ export const filterSensitiveLog = (obj: S3Tag): any => ({ ...obj, }); @@ -1194,6 +1308,9 @@ export interface S3CopyObjectOperation { } export namespace S3CopyObjectOperation { + /** + * @internal + */ export const filterSensitiveLog = (obj: S3CopyObjectOperation): any => ({ ...obj, }); @@ -1211,6 +1328,9 @@ export interface S3ObjectLockLegalHold { } export namespace S3ObjectLockLegalHold { + /** + * @internal + */ export const filterSensitiveLog = (obj: S3ObjectLockLegalHold): any => ({ ...obj, }); @@ -1231,6 +1351,9 @@ export interface S3SetObjectLegalHoldOperation { } export namespace S3SetObjectLegalHoldOperation { + /** + * @internal + */ export const filterSensitiveLog = (obj: S3SetObjectLegalHoldOperation): any => ({ ...obj, }); @@ -1261,6 +1384,9 @@ export interface S3Retention { } export namespace S3Retention { + /** + * @internal + */ export const filterSensitiveLog = (obj: S3Retention): any => ({ ...obj, }); @@ -1289,6 +1415,9 @@ export interface S3SetObjectRetentionOperation { } export namespace S3SetObjectRetentionOperation { + /** + * @internal + */ export const filterSensitiveLog = (obj: S3SetObjectRetentionOperation): any => ({ ...obj, }); @@ -1306,6 +1435,9 @@ export interface S3SetObjectTaggingOperation { } export namespace S3SetObjectTaggingOperation { + /** + * @internal + */ export const filterSensitiveLog = (obj: S3SetObjectTaggingOperation): any => ({ ...obj, }); @@ -1367,6 +1499,9 @@ export interface JobOperation { } export namespace JobOperation { + /** + * @internal + */ export const filterSensitiveLog = (obj: JobOperation): any => ({ ...obj, }); @@ -1414,6 +1549,9 @@ export interface JobReport { } export namespace JobReport { + /** + * @internal + */ export const filterSensitiveLog = (obj: JobReport): any => ({ ...obj, }); @@ -1476,6 +1614,9 @@ export interface CreateJobRequest { } export namespace CreateJobRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateJobRequest): any => ({ ...obj, }); @@ -1490,6 +1631,9 @@ export interface CreateJobResult { } export namespace CreateJobResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateJobResult): any => ({ ...obj, }); @@ -1505,6 +1649,9 @@ export interface IdempotencyException extends __SmithyException, $MetadataBearer } export namespace IdempotencyException { + /** + * @internal + */ export const filterSensitiveLog = (obj: IdempotencyException): any => ({ ...obj, }); @@ -1520,6 +1667,9 @@ export interface InternalServiceException extends __SmithyException, $MetadataBe } export namespace InternalServiceException { + /** + * @internal + */ export const filterSensitiveLog = (obj: InternalServiceException): any => ({ ...obj, }); @@ -1535,6 +1685,9 @@ export interface TooManyRequestsException extends __SmithyException, $MetadataBe } export namespace TooManyRequestsException { + /** + * @internal + */ export const filterSensitiveLog = (obj: TooManyRequestsException): any => ({ ...obj, }); @@ -1555,6 +1708,9 @@ export interface DeleteAccessPointRequest { } export namespace DeleteAccessPointRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteAccessPointRequest): any => ({ ...obj, }); @@ -1573,6 +1729,9 @@ export interface DeleteAccessPointForObjectLambdaRequest { } export namespace DeleteAccessPointForObjectLambdaRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteAccessPointForObjectLambdaRequest): any => ({ ...obj, }); @@ -1593,6 +1752,9 @@ export interface DeleteAccessPointPolicyRequest { } export namespace DeleteAccessPointPolicyRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteAccessPointPolicyRequest): any => ({ ...obj, }); @@ -1611,6 +1773,9 @@ export interface DeleteAccessPointPolicyForObjectLambdaRequest { } export namespace DeleteAccessPointPolicyForObjectLambdaRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteAccessPointPolicyForObjectLambdaRequest): any => ({ ...obj, }); @@ -1631,6 +1796,9 @@ export interface DeleteBucketRequest { } export namespace DeleteBucketRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteBucketRequest): any => ({ ...obj, }); @@ -1651,6 +1819,9 @@ export interface DeleteBucketLifecycleConfigurationRequest { } export namespace DeleteBucketLifecycleConfigurationRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteBucketLifecycleConfigurationRequest): any => ({ ...obj, }); @@ -1671,6 +1842,9 @@ export interface DeleteBucketPolicyRequest { } export namespace DeleteBucketPolicyRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteBucketPolicyRequest): any => ({ ...obj, }); @@ -1691,6 +1865,9 @@ export interface DeleteBucketTaggingRequest { } export namespace DeleteBucketTaggingRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteBucketTaggingRequest): any => ({ ...obj, }); @@ -1709,6 +1886,9 @@ export interface DeleteJobTaggingRequest { } export namespace DeleteJobTaggingRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteJobTaggingRequest): any => ({ ...obj, }); @@ -1717,6 +1897,9 @@ export namespace DeleteJobTaggingRequest { export interface DeleteJobTaggingResult {} export namespace DeleteJobTaggingResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteJobTaggingResult): any => ({ ...obj, }); @@ -1732,6 +1915,9 @@ export interface NotFoundException extends __SmithyException, $MetadataBearer { } export namespace NotFoundException { + /** + * @internal + */ export const filterSensitiveLog = (obj: NotFoundException): any => ({ ...obj, }); @@ -1746,6 +1932,9 @@ export interface DeletePublicAccessBlockRequest { } export namespace DeletePublicAccessBlockRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeletePublicAccessBlockRequest): any => ({ ...obj, }); @@ -1764,6 +1953,9 @@ export interface DeleteStorageLensConfigurationRequest { } export namespace DeleteStorageLensConfigurationRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteStorageLensConfigurationRequest): any => ({ ...obj, }); @@ -1782,6 +1974,9 @@ export interface DeleteStorageLensConfigurationTaggingRequest { } export namespace DeleteStorageLensConfigurationTaggingRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteStorageLensConfigurationTaggingRequest): any => ({ ...obj, }); @@ -1790,6 +1985,9 @@ export namespace DeleteStorageLensConfigurationTaggingRequest { export interface DeleteStorageLensConfigurationTaggingResult {} export namespace DeleteStorageLensConfigurationTaggingResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteStorageLensConfigurationTaggingResult): any => ({ ...obj, }); @@ -1808,6 +2006,9 @@ export interface DescribeJobRequest { } export namespace DescribeJobRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeJobRequest): any => ({ ...obj, }); @@ -1829,6 +2030,9 @@ export interface JobFailure { } export namespace JobFailure { + /** + * @internal + */ export const filterSensitiveLog = (obj: JobFailure): any => ({ ...obj, }); @@ -1855,6 +2059,9 @@ export interface JobProgressSummary { } export namespace JobProgressSummary { + /** + * @internal + */ export const filterSensitiveLog = (obj: JobProgressSummary): any => ({ ...obj, }); @@ -1970,6 +2177,9 @@ export interface JobDescriptor { } export namespace JobDescriptor { + /** + * @internal + */ export const filterSensitiveLog = (obj: JobDescriptor): any => ({ ...obj, }); @@ -1983,6 +2193,9 @@ export interface DescribeJobResult { } export namespace DescribeJobResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeJobResult): any => ({ ...obj, }); @@ -2003,6 +2216,9 @@ export interface GetAccessPointRequest { } export namespace GetAccessPointRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetAccessPointRequest): any => ({ ...obj, }); @@ -2051,6 +2267,9 @@ export interface GetAccessPointResult { } export namespace GetAccessPointResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetAccessPointResult): any => ({ ...obj, }); @@ -2069,6 +2288,9 @@ export interface GetAccessPointConfigurationForObjectLambdaRequest { } export namespace GetAccessPointConfigurationForObjectLambdaRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetAccessPointConfigurationForObjectLambdaRequest): any => ({ ...obj, }); @@ -2082,6 +2304,9 @@ export interface GetAccessPointConfigurationForObjectLambdaResult { } export namespace GetAccessPointConfigurationForObjectLambdaResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetAccessPointConfigurationForObjectLambdaResult): any => ({ ...obj, ...(obj.Configuration && { Configuration: ObjectLambdaConfiguration.filterSensitiveLog(obj.Configuration) }), @@ -2101,6 +2326,9 @@ export interface GetAccessPointForObjectLambdaRequest { } export namespace GetAccessPointForObjectLambdaRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetAccessPointForObjectLambdaRequest): any => ({ ...obj, }); @@ -2124,6 +2352,9 @@ export interface GetAccessPointForObjectLambdaResult { } export namespace GetAccessPointForObjectLambdaResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetAccessPointForObjectLambdaResult): any => ({ ...obj, }); @@ -2144,6 +2375,9 @@ export interface GetAccessPointPolicyRequest { } export namespace GetAccessPointPolicyRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetAccessPointPolicyRequest): any => ({ ...obj, }); @@ -2157,6 +2391,9 @@ export interface GetAccessPointPolicyResult { } export namespace GetAccessPointPolicyResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetAccessPointPolicyResult): any => ({ ...obj, }); @@ -2175,6 +2412,9 @@ export interface GetAccessPointPolicyForObjectLambdaRequest { } export namespace GetAccessPointPolicyForObjectLambdaRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetAccessPointPolicyForObjectLambdaRequest): any => ({ ...obj, }); @@ -2188,6 +2428,9 @@ export interface GetAccessPointPolicyForObjectLambdaResult { } export namespace GetAccessPointPolicyForObjectLambdaResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetAccessPointPolicyForObjectLambdaResult): any => ({ ...obj, }); @@ -2206,6 +2449,9 @@ export interface GetAccessPointPolicyStatusRequest { } export namespace GetAccessPointPolicyStatusRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetAccessPointPolicyStatusRequest): any => ({ ...obj, }); @@ -2225,6 +2471,9 @@ export interface PolicyStatus { } export namespace PolicyStatus { + /** + * @internal + */ export const filterSensitiveLog = (obj: PolicyStatus): any => ({ ...obj, }); @@ -2238,6 +2487,9 @@ export interface GetAccessPointPolicyStatusResult { } export namespace GetAccessPointPolicyStatusResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetAccessPointPolicyStatusResult): any => ({ ...obj, }); @@ -2256,6 +2508,9 @@ export interface GetAccessPointPolicyStatusForObjectLambdaRequest { } export namespace GetAccessPointPolicyStatusForObjectLambdaRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetAccessPointPolicyStatusForObjectLambdaRequest): any => ({ ...obj, }); @@ -2272,6 +2527,9 @@ export interface GetAccessPointPolicyStatusForObjectLambdaResult { } export namespace GetAccessPointPolicyStatusForObjectLambdaResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetAccessPointPolicyStatusForObjectLambdaResult): any => ({ ...obj, }); @@ -2292,6 +2550,9 @@ export interface GetBucketRequest { } export namespace GetBucketRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetBucketRequest): any => ({ ...obj, }); @@ -2315,6 +2576,9 @@ export interface GetBucketResult { } export namespace GetBucketResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetBucketResult): any => ({ ...obj, }); @@ -2335,6 +2599,9 @@ export interface GetBucketLifecycleConfigurationRequest { } export namespace GetBucketLifecycleConfigurationRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetBucketLifecycleConfigurationRequest): any => ({ ...obj, }); @@ -2364,6 +2631,9 @@ export interface LifecycleExpiration { } export namespace LifecycleExpiration { + /** + * @internal + */ export const filterSensitiveLog = (obj: LifecycleExpiration): any => ({ ...obj, }); @@ -2385,6 +2655,9 @@ export interface LifecycleRuleAndOperator { } export namespace LifecycleRuleAndOperator { + /** + * @internal + */ export const filterSensitiveLog = (obj: LifecycleRuleAndOperator): any => ({ ...obj, }); @@ -2416,6 +2689,9 @@ export interface LifecycleRuleFilter { } export namespace LifecycleRuleFilter { + /** + * @internal + */ export const filterSensitiveLog = (obj: LifecycleRuleFilter): any => ({ ...obj, }); @@ -2435,6 +2711,9 @@ export interface NoncurrentVersionExpiration { } export namespace NoncurrentVersionExpiration { + /** + * @internal + */ export const filterSensitiveLog = (obj: NoncurrentVersionExpiration): any => ({ ...obj, }); @@ -2461,6 +2740,9 @@ export interface NoncurrentVersionTransition { } export namespace NoncurrentVersionTransition { + /** + * @internal + */ export const filterSensitiveLog = (obj: NoncurrentVersionTransition): any => ({ ...obj, }); @@ -2494,6 +2776,9 @@ export interface Transition { } export namespace Transition { + /** + * @internal + */ export const filterSensitiveLog = (obj: Transition): any => ({ ...obj, }); @@ -2562,6 +2847,9 @@ export interface LifecycleRule { } export namespace LifecycleRule { + /** + * @internal + */ export const filterSensitiveLog = (obj: LifecycleRule): any => ({ ...obj, }); @@ -2575,6 +2863,9 @@ export interface GetBucketLifecycleConfigurationResult { } export namespace GetBucketLifecycleConfigurationResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetBucketLifecycleConfigurationResult): any => ({ ...obj, }); @@ -2595,6 +2886,9 @@ export interface GetBucketPolicyRequest { } export namespace GetBucketPolicyRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetBucketPolicyRequest): any => ({ ...obj, }); @@ -2608,6 +2902,9 @@ export interface GetBucketPolicyResult { } export namespace GetBucketPolicyResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetBucketPolicyResult): any => ({ ...obj, }); @@ -2628,6 +2925,9 @@ export interface GetBucketTaggingRequest { } export namespace GetBucketTaggingRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetBucketTaggingRequest): any => ({ ...obj, }); @@ -2641,6 +2941,9 @@ export interface GetBucketTaggingResult { } export namespace GetBucketTaggingResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetBucketTaggingResult): any => ({ ...obj, }); @@ -2659,6 +2962,9 @@ export interface GetJobTaggingRequest { } export namespace GetJobTaggingRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetJobTaggingRequest): any => ({ ...obj, }); @@ -2672,6 +2978,9 @@ export interface GetJobTaggingResult { } export namespace GetJobTaggingResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetJobTaggingResult): any => ({ ...obj, }); @@ -2686,6 +2995,9 @@ export interface GetPublicAccessBlockOutput { } export namespace GetPublicAccessBlockOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetPublicAccessBlockOutput): any => ({ ...obj, }); @@ -2700,6 +3012,9 @@ export interface GetPublicAccessBlockRequest { } export namespace GetPublicAccessBlockRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetPublicAccessBlockRequest): any => ({ ...obj, }); @@ -2716,6 +3031,9 @@ export interface NoSuchPublicAccessBlockConfiguration extends __SmithyException, } export namespace NoSuchPublicAccessBlockConfiguration { + /** + * @internal + */ export const filterSensitiveLog = (obj: NoSuchPublicAccessBlockConfiguration): any => ({ ...obj, }); @@ -2734,6 +3052,9 @@ export interface GetStorageLensConfigurationRequest { } export namespace GetStorageLensConfigurationRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetStorageLensConfigurationRequest): any => ({ ...obj, }); @@ -2754,6 +3075,9 @@ export interface StorageLensAwsOrg { } export namespace StorageLensAwsOrg { + /** + * @internal + */ export const filterSensitiveLog = (obj: StorageLensAwsOrg): any => ({ ...obj, }); @@ -2774,6 +3098,9 @@ export interface SSEKMS { } export namespace SSEKMS { + /** + * @internal + */ export const filterSensitiveLog = (obj: SSEKMS): any => ({ ...obj, }); @@ -2785,6 +3112,9 @@ export namespace SSEKMS { export interface SSES3 {} export namespace SSES3 { + /** + * @internal + */ export const filterSensitiveLog = (obj: SSES3): any => ({ ...obj, }); @@ -2806,6 +3136,9 @@ export interface StorageLensDataExportEncryption { } export namespace StorageLensDataExportEncryption { + /** + * @internal + */ export const filterSensitiveLog = (obj: StorageLensDataExportEncryption): any => ({ ...obj, }); @@ -2855,6 +3188,9 @@ export interface S3BucketDestination { } export namespace S3BucketDestination { + /** + * @internal + */ export const filterSensitiveLog = (obj: S3BucketDestination): any => ({ ...obj, }); @@ -2875,6 +3211,9 @@ export interface StorageLensDataExport { } export namespace StorageLensDataExport { + /** + * @internal + */ export const filterSensitiveLog = (obj: StorageLensDataExport): any => ({ ...obj, }); @@ -2896,6 +3235,9 @@ export interface _Exclude { } export namespace _Exclude { + /** + * @internal + */ export const filterSensitiveLog = (obj: _Exclude): any => ({ ...obj, }); @@ -2917,6 +3259,9 @@ export interface Include { } export namespace Include { + /** + * @internal + */ export const filterSensitiveLog = (obj: Include): any => ({ ...obj, }); @@ -2976,6 +3321,9 @@ export interface StorageLensConfiguration { } export namespace StorageLensConfiguration { + /** + * @internal + */ export const filterSensitiveLog = (obj: StorageLensConfiguration): any => ({ ...obj, }); @@ -2989,6 +3337,9 @@ export interface GetStorageLensConfigurationResult { } export namespace GetStorageLensConfigurationResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetStorageLensConfigurationResult): any => ({ ...obj, }); @@ -3007,6 +3358,9 @@ export interface GetStorageLensConfigurationTaggingRequest { } export namespace GetStorageLensConfigurationTaggingRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetStorageLensConfigurationTaggingRequest): any => ({ ...obj, }); @@ -3028,6 +3382,9 @@ export interface StorageLensTag { } export namespace StorageLensTag { + /** + * @internal + */ export const filterSensitiveLog = (obj: StorageLensTag): any => ({ ...obj, }); @@ -3041,6 +3398,9 @@ export interface GetStorageLensConfigurationTaggingResult { } export namespace GetStorageLensConfigurationTaggingResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetStorageLensConfigurationTaggingResult): any => ({ ...obj, }); @@ -3074,6 +3434,9 @@ export interface ListAccessPointsRequest { } export namespace ListAccessPointsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListAccessPointsRequest): any => ({ ...obj, }); @@ -3095,6 +3458,9 @@ export interface ListAccessPointsResult { } export namespace ListAccessPointsResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListAccessPointsResult): any => ({ ...obj, }); @@ -3120,6 +3486,9 @@ export interface ListAccessPointsForObjectLambdaRequest { } export namespace ListAccessPointsForObjectLambdaRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListAccessPointsForObjectLambdaRequest): any => ({ ...obj, }); @@ -3141,6 +3510,9 @@ export interface ObjectLambdaAccessPoint { } export namespace ObjectLambdaAccessPoint { + /** + * @internal + */ export const filterSensitiveLog = (obj: ObjectLambdaAccessPoint): any => ({ ...obj, }); @@ -3161,6 +3533,9 @@ export interface ListAccessPointsForObjectLambdaResult { } export namespace ListAccessPointsForObjectLambdaResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListAccessPointsForObjectLambdaResult): any => ({ ...obj, }); @@ -3176,6 +3551,9 @@ export interface InvalidNextTokenException extends __SmithyException, $MetadataB } export namespace InvalidNextTokenException { + /** + * @internal + */ export const filterSensitiveLog = (obj: InvalidNextTokenException): any => ({ ...obj, }); @@ -3191,6 +3569,9 @@ export interface InvalidRequestException extends __SmithyException, $MetadataBea } export namespace InvalidRequestException { + /** + * @internal + */ export const filterSensitiveLog = (obj: InvalidRequestException): any => ({ ...obj, }); @@ -3219,6 +3600,9 @@ export interface ListJobsRequest { } export namespace ListJobsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListJobsRequest): any => ({ ...obj, }); @@ -3282,6 +3666,9 @@ export interface JobListDescriptor { } export namespace JobListDescriptor { + /** + * @internal + */ export const filterSensitiveLog = (obj: JobListDescriptor): any => ({ ...obj, }); @@ -3301,6 +3688,9 @@ export interface ListJobsResult { } export namespace ListJobsResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListJobsResult): any => ({ ...obj, }); @@ -3332,6 +3722,9 @@ export interface ListRegionalBucketsRequest { } export namespace ListRegionalBucketsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListRegionalBucketsRequest): any => ({ ...obj, }); @@ -3368,6 +3761,9 @@ export interface RegionalBucket { } export namespace RegionalBucket { + /** + * @internal + */ export const filterSensitiveLog = (obj: RegionalBucket): any => ({ ...obj, }); @@ -3390,6 +3786,9 @@ export interface ListRegionalBucketsResult { } export namespace ListRegionalBucketsResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListRegionalBucketsResult): any => ({ ...obj, }); @@ -3408,6 +3807,9 @@ export interface ListStorageLensConfigurationsRequest { } export namespace ListStorageLensConfigurationsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListStorageLensConfigurationsRequest): any => ({ ...obj, }); @@ -3442,6 +3844,9 @@ export interface ListStorageLensConfigurationEntry { } export namespace ListStorageLensConfigurationEntry { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListStorageLensConfigurationEntry): any => ({ ...obj, }); @@ -3462,6 +3867,9 @@ export interface ListStorageLensConfigurationsResult { } export namespace ListStorageLensConfigurationsResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListStorageLensConfigurationsResult): any => ({ ...obj, }); @@ -3485,6 +3893,9 @@ export interface PutAccessPointConfigurationForObjectLambdaRequest { } export namespace PutAccessPointConfigurationForObjectLambdaRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: PutAccessPointConfigurationForObjectLambdaRequest): any => ({ ...obj, ...(obj.Configuration && { Configuration: ObjectLambdaConfiguration.filterSensitiveLog(obj.Configuration) }), @@ -3511,6 +3922,9 @@ export interface PutAccessPointPolicyRequest { } export namespace PutAccessPointPolicyRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: PutAccessPointPolicyRequest): any => ({ ...obj, }); @@ -3534,6 +3948,9 @@ export interface PutAccessPointPolicyForObjectLambdaRequest { } export namespace PutAccessPointPolicyForObjectLambdaRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: PutAccessPointPolicyForObjectLambdaRequest): any => ({ ...obj, }); @@ -3550,6 +3967,9 @@ export interface LifecycleConfiguration { } export namespace LifecycleConfiguration { + /** + * @internal + */ export const filterSensitiveLog = (obj: LifecycleConfiguration): any => ({ ...obj, }); @@ -3573,6 +3993,9 @@ export interface PutBucketLifecycleConfigurationRequest { } export namespace PutBucketLifecycleConfigurationRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: PutBucketLifecycleConfigurationRequest): any => ({ ...obj, }); @@ -3606,6 +4029,9 @@ export interface PutBucketPolicyRequest { } export namespace PutBucketPolicyRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: PutBucketPolicyRequest): any => ({ ...obj, }); @@ -3622,6 +4048,9 @@ export interface Tagging { } export namespace Tagging { + /** + * @internal + */ export const filterSensitiveLog = (obj: Tagging): any => ({ ...obj, }); @@ -3647,6 +4076,9 @@ export interface PutBucketTaggingRequest { } export namespace PutBucketTaggingRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: PutBucketTaggingRequest): any => ({ ...obj, }); @@ -3670,6 +4102,9 @@ export interface PutJobTaggingRequest { } export namespace PutJobTaggingRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: PutJobTaggingRequest): any => ({ ...obj, }); @@ -3678,6 +4113,9 @@ export namespace PutJobTaggingRequest { export interface PutJobTaggingResult {} export namespace PutJobTaggingResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: PutJobTaggingResult): any => ({ ...obj, }); @@ -3693,6 +4131,9 @@ export interface TooManyTagsException extends __SmithyException, $MetadataBearer } export namespace TooManyTagsException { + /** + * @internal + */ export const filterSensitiveLog = (obj: TooManyTagsException): any => ({ ...obj, }); @@ -3713,6 +4154,9 @@ export interface PutPublicAccessBlockRequest { } export namespace PutPublicAccessBlockRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: PutPublicAccessBlockRequest): any => ({ ...obj, }); @@ -3744,6 +4188,9 @@ export interface PutStorageLensConfigurationRequest { } export namespace PutStorageLensConfigurationRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: PutStorageLensConfigurationRequest): any => ({ ...obj, }); @@ -3770,6 +4217,9 @@ export interface PutStorageLensConfigurationTaggingRequest { } export namespace PutStorageLensConfigurationTaggingRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: PutStorageLensConfigurationTaggingRequest): any => ({ ...obj, }); @@ -3778,6 +4228,9 @@ export namespace PutStorageLensConfigurationTaggingRequest { export interface PutStorageLensConfigurationTaggingResult {} export namespace PutStorageLensConfigurationTaggingResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: PutStorageLensConfigurationTaggingResult): any => ({ ...obj, }); @@ -3801,6 +4254,9 @@ export interface UpdateJobPriorityRequest { } export namespace UpdateJobPriorityRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateJobPriorityRequest): any => ({ ...obj, }); @@ -3819,6 +4275,9 @@ export interface UpdateJobPriorityResult { } export namespace UpdateJobPriorityResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateJobPriorityResult): any => ({ ...obj, }); @@ -3834,6 +4293,9 @@ export interface JobStatusException extends __SmithyException, $MetadataBearer { } export namespace JobStatusException { + /** + * @internal + */ export const filterSensitiveLog = (obj: JobStatusException): any => ({ ...obj, }); @@ -3867,6 +4329,9 @@ export interface UpdateJobStatusRequest { } export namespace UpdateJobStatusRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateJobStatusRequest): any => ({ ...obj, }); @@ -3890,6 +4355,9 @@ export interface UpdateJobStatusResult { } export namespace UpdateJobStatusResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateJobStatusResult): any => ({ ...obj, }); diff --git a/clients/client-s3/commands/AbortMultipartUploadCommand.ts b/clients/client-s3/commands/AbortMultipartUploadCommand.ts index 0db6ad1a8d75..2be3fb3b8279 100644 --- a/clients/client-s3/commands/AbortMultipartUploadCommand.ts +++ b/clients/client-s3/commands/AbortMultipartUploadCommand.ts @@ -61,6 +61,20 @@ export interface AbortMultipartUploadCommandOutput extends AbortMultipartUploadO *

* * + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { S3Client, AbortMultipartUploadCommand } from "@aws-sdk/client-s3"; // ES Modules import + * // const { S3Client, AbortMultipartUploadCommand } = require("@aws-sdk/client-s3"); // CommonJS import + * const client = new S3Client(config); + * const command = new AbortMultipartUploadCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link AbortMultipartUploadCommandInput} for command's `input` shape. + * @see {@link AbortMultipartUploadCommandOutput} for command's `response` shape. + * @see {@link S3ClientResolvedConfig | config} for command's `input` shape. + * */ export class AbortMultipartUploadCommand extends $Command< AbortMultipartUploadCommandInput, diff --git a/clients/client-s3/commands/CompleteMultipartUploadCommand.ts b/clients/client-s3/commands/CompleteMultipartUploadCommand.ts index c21e97100f74..fa0f33aac23e 100644 --- a/clients/client-s3/commands/CompleteMultipartUploadCommand.ts +++ b/clients/client-s3/commands/CompleteMultipartUploadCommand.ts @@ -133,6 +133,20 @@ export interface CompleteMultipartUploadCommandOutput extends CompleteMultipartU *

* * + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { S3Client, CompleteMultipartUploadCommand } from "@aws-sdk/client-s3"; // ES Modules import + * // const { S3Client, CompleteMultipartUploadCommand } = require("@aws-sdk/client-s3"); // CommonJS import + * const client = new S3Client(config); + * const command = new CompleteMultipartUploadCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CompleteMultipartUploadCommandInput} for command's `input` shape. + * @see {@link CompleteMultipartUploadCommandOutput} for command's `response` shape. + * @see {@link S3ClientResolvedConfig | config} for command's `input` shape. + * */ export class CompleteMultipartUploadCommand extends $Command< CompleteMultipartUploadCommandInput, diff --git a/clients/client-s3/commands/CopyObjectCommand.ts b/clients/client-s3/commands/CopyObjectCommand.ts index beb69ff485ff..09c7629049e8 100644 --- a/clients/client-s3/commands/CopyObjectCommand.ts +++ b/clients/client-s3/commands/CopyObjectCommand.ts @@ -194,6 +194,20 @@ export interface CopyObjectCommandOutput extends CopyObjectOutput, __MetadataBea * *

For more information, see Copying * Objects.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { S3Client, CopyObjectCommand } from "@aws-sdk/client-s3"; // ES Modules import + * // const { S3Client, CopyObjectCommand } = require("@aws-sdk/client-s3"); // CommonJS import + * const client = new S3Client(config); + * const command = new CopyObjectCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CopyObjectCommandInput} for command's `input` shape. + * @see {@link CopyObjectCommandOutput} for command's `response` shape. + * @see {@link S3ClientResolvedConfig | config} for command's `input` shape. + * */ export class CopyObjectCommand extends $Command< CopyObjectCommandInput, diff --git a/clients/client-s3/commands/CreateBucketCommand.ts b/clients/client-s3/commands/CreateBucketCommand.ts index 2ec72257645e..68052477f87e 100644 --- a/clients/client-s3/commands/CreateBucketCommand.ts +++ b/clients/client-s3/commands/CreateBucketCommand.ts @@ -134,6 +134,20 @@ export interface CreateBucketCommandOutput extends CreateBucketOutput, __Metadat *

* * + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { S3Client, CreateBucketCommand } from "@aws-sdk/client-s3"; // ES Modules import + * // const { S3Client, CreateBucketCommand } = require("@aws-sdk/client-s3"); // CommonJS import + * const client = new S3Client(config); + * const command = new CreateBucketCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreateBucketCommandInput} for command's `input` shape. + * @see {@link CreateBucketCommandOutput} for command's `response` shape. + * @see {@link S3ClientResolvedConfig | config} for command's `input` shape. + * */ export class CreateBucketCommand extends $Command< CreateBucketCommandInput, diff --git a/clients/client-s3/commands/CreateMultipartUploadCommand.ts b/clients/client-s3/commands/CreateMultipartUploadCommand.ts index 84d025ac8708..19e5e06593f7 100644 --- a/clients/client-s3/commands/CreateMultipartUploadCommand.ts +++ b/clients/client-s3/commands/CreateMultipartUploadCommand.ts @@ -285,6 +285,20 @@ export interface CreateMultipartUploadCommandOutput extends CreateMultipartUploa *

* * + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { S3Client, CreateMultipartUploadCommand } from "@aws-sdk/client-s3"; // ES Modules import + * // const { S3Client, CreateMultipartUploadCommand } = require("@aws-sdk/client-s3"); // CommonJS import + * const client = new S3Client(config); + * const command = new CreateMultipartUploadCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreateMultipartUploadCommandInput} for command's `input` shape. + * @see {@link CreateMultipartUploadCommandOutput} for command's `response` shape. + * @see {@link S3ClientResolvedConfig | config} for command's `input` shape. + * */ export class CreateMultipartUploadCommand extends $Command< CreateMultipartUploadCommandInput, diff --git a/clients/client-s3/commands/DeleteBucketAnalyticsConfigurationCommand.ts b/clients/client-s3/commands/DeleteBucketAnalyticsConfigurationCommand.ts index da105f33bcf2..b8e7045adc10 100644 --- a/clients/client-s3/commands/DeleteBucketAnalyticsConfigurationCommand.ts +++ b/clients/client-s3/commands/DeleteBucketAnalyticsConfigurationCommand.ts @@ -52,6 +52,20 @@ export interface DeleteBucketAnalyticsConfigurationCommandOutput extends __Metad *

* * + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { S3Client, DeleteBucketAnalyticsConfigurationCommand } from "@aws-sdk/client-s3"; // ES Modules import + * // const { S3Client, DeleteBucketAnalyticsConfigurationCommand } = require("@aws-sdk/client-s3"); // CommonJS import + * const client = new S3Client(config); + * const command = new DeleteBucketAnalyticsConfigurationCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteBucketAnalyticsConfigurationCommandInput} for command's `input` shape. + * @see {@link DeleteBucketAnalyticsConfigurationCommandOutput} for command's `response` shape. + * @see {@link S3ClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteBucketAnalyticsConfigurationCommand extends $Command< DeleteBucketAnalyticsConfigurationCommandInput, diff --git a/clients/client-s3/commands/DeleteBucketCommand.ts b/clients/client-s3/commands/DeleteBucketCommand.ts index e68f8445e396..3b659ef64b9e 100644 --- a/clients/client-s3/commands/DeleteBucketCommand.ts +++ b/clients/client-s3/commands/DeleteBucketCommand.ts @@ -39,6 +39,20 @@ export interface DeleteBucketCommandOutput extends __MetadataBearer {} *

* * + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { S3Client, DeleteBucketCommand } from "@aws-sdk/client-s3"; // ES Modules import + * // const { S3Client, DeleteBucketCommand } = require("@aws-sdk/client-s3"); // CommonJS import + * const client = new S3Client(config); + * const command = new DeleteBucketCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteBucketCommandInput} for command's `input` shape. + * @see {@link DeleteBucketCommandOutput} for command's `response` shape. + * @see {@link S3ClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteBucketCommand extends $Command< DeleteBucketCommandInput, diff --git a/clients/client-s3/commands/DeleteBucketCorsCommand.ts b/clients/client-s3/commands/DeleteBucketCorsCommand.ts index 28b2f9a3ad51..f243546e2ebd 100644 --- a/clients/client-s3/commands/DeleteBucketCorsCommand.ts +++ b/clients/client-s3/commands/DeleteBucketCorsCommand.ts @@ -44,6 +44,20 @@ export interface DeleteBucketCorsCommandOutput extends __MetadataBearer {} *

* * + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { S3Client, DeleteBucketCorsCommand } from "@aws-sdk/client-s3"; // ES Modules import + * // const { S3Client, DeleteBucketCorsCommand } = require("@aws-sdk/client-s3"); // CommonJS import + * const client = new S3Client(config); + * const command = new DeleteBucketCorsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteBucketCorsCommandInput} for command's `input` shape. + * @see {@link DeleteBucketCorsCommandOutput} for command's `response` shape. + * @see {@link S3ClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteBucketCorsCommand extends $Command< DeleteBucketCorsCommandInput, diff --git a/clients/client-s3/commands/DeleteBucketEncryptionCommand.ts b/clients/client-s3/commands/DeleteBucketEncryptionCommand.ts index b37df1147de7..c55a50e6f5bd 100644 --- a/clients/client-s3/commands/DeleteBucketEncryptionCommand.ts +++ b/clients/client-s3/commands/DeleteBucketEncryptionCommand.ts @@ -46,6 +46,20 @@ export interface DeleteBucketEncryptionCommandOutput extends __MetadataBearer {} *

* * + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { S3Client, DeleteBucketEncryptionCommand } from "@aws-sdk/client-s3"; // ES Modules import + * // const { S3Client, DeleteBucketEncryptionCommand } = require("@aws-sdk/client-s3"); // CommonJS import + * const client = new S3Client(config); + * const command = new DeleteBucketEncryptionCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteBucketEncryptionCommandInput} for command's `input` shape. + * @see {@link DeleteBucketEncryptionCommandOutput} for command's `response` shape. + * @see {@link S3ClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteBucketEncryptionCommand extends $Command< DeleteBucketEncryptionCommandInput, diff --git a/clients/client-s3/commands/DeleteBucketIntelligentTieringConfigurationCommand.ts b/clients/client-s3/commands/DeleteBucketIntelligentTieringConfigurationCommand.ts index 7b9934d805ab..89420402c97a 100644 --- a/clients/client-s3/commands/DeleteBucketIntelligentTieringConfigurationCommand.ts +++ b/clients/client-s3/commands/DeleteBucketIntelligentTieringConfigurationCommand.ts @@ -46,6 +46,20 @@ export interface DeleteBucketIntelligentTieringConfigurationCommandOutput extend *

* * + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { S3Client, DeleteBucketIntelligentTieringConfigurationCommand } from "@aws-sdk/client-s3"; // ES Modules import + * // const { S3Client, DeleteBucketIntelligentTieringConfigurationCommand } = require("@aws-sdk/client-s3"); // CommonJS import + * const client = new S3Client(config); + * const command = new DeleteBucketIntelligentTieringConfigurationCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteBucketIntelligentTieringConfigurationCommandInput} for command's `input` shape. + * @see {@link DeleteBucketIntelligentTieringConfigurationCommandOutput} for command's `response` shape. + * @see {@link S3ClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteBucketIntelligentTieringConfigurationCommand extends $Command< DeleteBucketIntelligentTieringConfigurationCommandInput, diff --git a/clients/client-s3/commands/DeleteBucketInventoryConfigurationCommand.ts b/clients/client-s3/commands/DeleteBucketInventoryConfigurationCommand.ts index 50fecaee5114..f8937b51f315 100644 --- a/clients/client-s3/commands/DeleteBucketInventoryConfigurationCommand.ts +++ b/clients/client-s3/commands/DeleteBucketInventoryConfigurationCommand.ts @@ -48,6 +48,20 @@ export interface DeleteBucketInventoryConfigurationCommandOutput extends __Metad *

* * + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { S3Client, DeleteBucketInventoryConfigurationCommand } from "@aws-sdk/client-s3"; // ES Modules import + * // const { S3Client, DeleteBucketInventoryConfigurationCommand } = require("@aws-sdk/client-s3"); // CommonJS import + * const client = new S3Client(config); + * const command = new DeleteBucketInventoryConfigurationCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteBucketInventoryConfigurationCommandInput} for command's `input` shape. + * @see {@link DeleteBucketInventoryConfigurationCommandOutput} for command's `response` shape. + * @see {@link S3ClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteBucketInventoryConfigurationCommand extends $Command< DeleteBucketInventoryConfigurationCommandInput, diff --git a/clients/client-s3/commands/DeleteBucketLifecycleCommand.ts b/clients/client-s3/commands/DeleteBucketLifecycleCommand.ts index b1033c266574..98eab71ccd92 100644 --- a/clients/client-s3/commands/DeleteBucketLifecycleCommand.ts +++ b/clients/client-s3/commands/DeleteBucketLifecycleCommand.ts @@ -48,6 +48,20 @@ export interface DeleteBucketLifecycleCommandOutput extends __MetadataBearer {} *

* * + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { S3Client, DeleteBucketLifecycleCommand } from "@aws-sdk/client-s3"; // ES Modules import + * // const { S3Client, DeleteBucketLifecycleCommand } = require("@aws-sdk/client-s3"); // CommonJS import + * const client = new S3Client(config); + * const command = new DeleteBucketLifecycleCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteBucketLifecycleCommandInput} for command's `input` shape. + * @see {@link DeleteBucketLifecycleCommandOutput} for command's `response` shape. + * @see {@link S3ClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteBucketLifecycleCommand extends $Command< DeleteBucketLifecycleCommandInput, diff --git a/clients/client-s3/commands/DeleteBucketMetricsConfigurationCommand.ts b/clients/client-s3/commands/DeleteBucketMetricsConfigurationCommand.ts index 1020fa3d6d31..9c62a91be9dc 100644 --- a/clients/client-s3/commands/DeleteBucketMetricsConfigurationCommand.ts +++ b/clients/client-s3/commands/DeleteBucketMetricsConfigurationCommand.ts @@ -58,6 +58,20 @@ export interface DeleteBucketMetricsConfigurationCommandOutput extends __Metadat *

* * + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { S3Client, DeleteBucketMetricsConfigurationCommand } from "@aws-sdk/client-s3"; // ES Modules import + * // const { S3Client, DeleteBucketMetricsConfigurationCommand } = require("@aws-sdk/client-s3"); // CommonJS import + * const client = new S3Client(config); + * const command = new DeleteBucketMetricsConfigurationCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteBucketMetricsConfigurationCommandInput} for command's `input` shape. + * @see {@link DeleteBucketMetricsConfigurationCommandOutput} for command's `response` shape. + * @see {@link S3ClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteBucketMetricsConfigurationCommand extends $Command< DeleteBucketMetricsConfigurationCommandInput, diff --git a/clients/client-s3/commands/DeleteBucketOwnershipControlsCommand.ts b/clients/client-s3/commands/DeleteBucketOwnershipControlsCommand.ts index f183c584fc40..2e3e6b018929 100644 --- a/clients/client-s3/commands/DeleteBucketOwnershipControlsCommand.ts +++ b/clients/client-s3/commands/DeleteBucketOwnershipControlsCommand.ts @@ -41,6 +41,20 @@ export interface DeleteBucketOwnershipControlsCommandOutput extends __MetadataBe *

* * + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { S3Client, DeleteBucketOwnershipControlsCommand } from "@aws-sdk/client-s3"; // ES Modules import + * // const { S3Client, DeleteBucketOwnershipControlsCommand } = require("@aws-sdk/client-s3"); // CommonJS import + * const client = new S3Client(config); + * const command = new DeleteBucketOwnershipControlsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteBucketOwnershipControlsCommandInput} for command's `input` shape. + * @see {@link DeleteBucketOwnershipControlsCommandOutput} for command's `response` shape. + * @see {@link S3ClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteBucketOwnershipControlsCommand extends $Command< DeleteBucketOwnershipControlsCommandInput, diff --git a/clients/client-s3/commands/DeleteBucketPolicyCommand.ts b/clients/client-s3/commands/DeleteBucketPolicyCommand.ts index 9b6f5c57d9cc..6e5abe6c684e 100644 --- a/clients/client-s3/commands/DeleteBucketPolicyCommand.ts +++ b/clients/client-s3/commands/DeleteBucketPolicyCommand.ts @@ -55,6 +55,20 @@ export interface DeleteBucketPolicyCommandOutput extends __MetadataBearer {} *

* * + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { S3Client, DeleteBucketPolicyCommand } from "@aws-sdk/client-s3"; // ES Modules import + * // const { S3Client, DeleteBucketPolicyCommand } = require("@aws-sdk/client-s3"); // CommonJS import + * const client = new S3Client(config); + * const command = new DeleteBucketPolicyCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteBucketPolicyCommandInput} for command's `input` shape. + * @see {@link DeleteBucketPolicyCommandOutput} for command's `response` shape. + * @see {@link S3ClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteBucketPolicyCommand extends $Command< DeleteBucketPolicyCommandInput, diff --git a/clients/client-s3/commands/DeleteBucketReplicationCommand.ts b/clients/client-s3/commands/DeleteBucketReplicationCommand.ts index fc6c980f9960..887fb9c46e3b 100644 --- a/clients/client-s3/commands/DeleteBucketReplicationCommand.ts +++ b/clients/client-s3/commands/DeleteBucketReplicationCommand.ts @@ -49,6 +49,20 @@ export interface DeleteBucketReplicationCommandOutput extends __MetadataBearer { *

* * + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { S3Client, DeleteBucketReplicationCommand } from "@aws-sdk/client-s3"; // ES Modules import + * // const { S3Client, DeleteBucketReplicationCommand } = require("@aws-sdk/client-s3"); // CommonJS import + * const client = new S3Client(config); + * const command = new DeleteBucketReplicationCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteBucketReplicationCommandInput} for command's `input` shape. + * @see {@link DeleteBucketReplicationCommandOutput} for command's `response` shape. + * @see {@link S3ClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteBucketReplicationCommand extends $Command< DeleteBucketReplicationCommandInput, diff --git a/clients/client-s3/commands/DeleteBucketTaggingCommand.ts b/clients/client-s3/commands/DeleteBucketTaggingCommand.ts index 07f769269aa4..83724cefd267 100644 --- a/clients/client-s3/commands/DeleteBucketTaggingCommand.ts +++ b/clients/client-s3/commands/DeleteBucketTaggingCommand.ts @@ -40,6 +40,20 @@ export interface DeleteBucketTaggingCommandOutput extends __MetadataBearer {} *

* * + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { S3Client, DeleteBucketTaggingCommand } from "@aws-sdk/client-s3"; // ES Modules import + * // const { S3Client, DeleteBucketTaggingCommand } = require("@aws-sdk/client-s3"); // CommonJS import + * const client = new S3Client(config); + * const command = new DeleteBucketTaggingCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteBucketTaggingCommandInput} for command's `input` shape. + * @see {@link DeleteBucketTaggingCommandOutput} for command's `response` shape. + * @see {@link S3ClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteBucketTaggingCommand extends $Command< DeleteBucketTaggingCommandInput, diff --git a/clients/client-s3/commands/DeleteBucketWebsiteCommand.ts b/clients/client-s3/commands/DeleteBucketWebsiteCommand.ts index 8fbb4504e6dc..9cde0993650b 100644 --- a/clients/client-s3/commands/DeleteBucketWebsiteCommand.ts +++ b/clients/client-s3/commands/DeleteBucketWebsiteCommand.ts @@ -49,6 +49,20 @@ export interface DeleteBucketWebsiteCommandOutput extends __MetadataBearer {} *

* * + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { S3Client, DeleteBucketWebsiteCommand } from "@aws-sdk/client-s3"; // ES Modules import + * // const { S3Client, DeleteBucketWebsiteCommand } = require("@aws-sdk/client-s3"); // CommonJS import + * const client = new S3Client(config); + * const command = new DeleteBucketWebsiteCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteBucketWebsiteCommandInput} for command's `input` shape. + * @see {@link DeleteBucketWebsiteCommandOutput} for command's `response` shape. + * @see {@link S3ClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteBucketWebsiteCommand extends $Command< DeleteBucketWebsiteCommandInput, diff --git a/clients/client-s3/commands/DeleteObjectCommand.ts b/clients/client-s3/commands/DeleteObjectCommand.ts index efd6c7edb583..9c5bb78b8609 100644 --- a/clients/client-s3/commands/DeleteObjectCommand.ts +++ b/clients/client-s3/commands/DeleteObjectCommand.ts @@ -53,6 +53,20 @@ export interface DeleteObjectCommandOutput extends DeleteObjectOutput, __Metadat *

* * + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { S3Client, DeleteObjectCommand } from "@aws-sdk/client-s3"; // ES Modules import + * // const { S3Client, DeleteObjectCommand } = require("@aws-sdk/client-s3"); // CommonJS import + * const client = new S3Client(config); + * const command = new DeleteObjectCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteObjectCommandInput} for command's `input` shape. + * @see {@link DeleteObjectCommandOutput} for command's `response` shape. + * @see {@link S3ClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteObjectCommand extends $Command< DeleteObjectCommandInput, diff --git a/clients/client-s3/commands/DeleteObjectTaggingCommand.ts b/clients/client-s3/commands/DeleteObjectTaggingCommand.ts index 2ff3bd1558ae..9f060f4c3f46 100644 --- a/clients/client-s3/commands/DeleteObjectTaggingCommand.ts +++ b/clients/client-s3/commands/DeleteObjectTaggingCommand.ts @@ -47,6 +47,20 @@ export interface DeleteObjectTaggingCommandOutput extends DeleteObjectTaggingOut *

* * + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { S3Client, DeleteObjectTaggingCommand } from "@aws-sdk/client-s3"; // ES Modules import + * // const { S3Client, DeleteObjectTaggingCommand } = require("@aws-sdk/client-s3"); // CommonJS import + * const client = new S3Client(config); + * const command = new DeleteObjectTaggingCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteObjectTaggingCommandInput} for command's `input` shape. + * @see {@link DeleteObjectTaggingCommandOutput} for command's `response` shape. + * @see {@link S3ClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteObjectTaggingCommand extends $Command< DeleteObjectTaggingCommandInput, diff --git a/clients/client-s3/commands/DeleteObjectsCommand.ts b/clients/client-s3/commands/DeleteObjectsCommand.ts index 9d6eef8f05b3..405812a7546c 100644 --- a/clients/client-s3/commands/DeleteObjectsCommand.ts +++ b/clients/client-s3/commands/DeleteObjectsCommand.ts @@ -80,6 +80,20 @@ export interface DeleteObjectsCommandOutput extends DeleteObjectsOutput, __Metad *

* * + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { S3Client, DeleteObjectsCommand } from "@aws-sdk/client-s3"; // ES Modules import + * // const { S3Client, DeleteObjectsCommand } = require("@aws-sdk/client-s3"); // CommonJS import + * const client = new S3Client(config); + * const command = new DeleteObjectsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteObjectsCommandInput} for command's `input` shape. + * @see {@link DeleteObjectsCommandOutput} for command's `response` shape. + * @see {@link S3ClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteObjectsCommand extends $Command< DeleteObjectsCommandInput, diff --git a/clients/client-s3/commands/DeletePublicAccessBlockCommand.ts b/clients/client-s3/commands/DeletePublicAccessBlockCommand.ts index 6ae83d6dde57..a8b9eb5ab4ca 100644 --- a/clients/client-s3/commands/DeletePublicAccessBlockCommand.ts +++ b/clients/client-s3/commands/DeletePublicAccessBlockCommand.ts @@ -51,6 +51,20 @@ export interface DeletePublicAccessBlockCommandOutput extends __MetadataBearer { *

* * + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { S3Client, DeletePublicAccessBlockCommand } from "@aws-sdk/client-s3"; // ES Modules import + * // const { S3Client, DeletePublicAccessBlockCommand } = require("@aws-sdk/client-s3"); // CommonJS import + * const client = new S3Client(config); + * const command = new DeletePublicAccessBlockCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeletePublicAccessBlockCommandInput} for command's `input` shape. + * @see {@link DeletePublicAccessBlockCommandOutput} for command's `response` shape. + * @see {@link S3ClientResolvedConfig | config} for command's `input` shape. + * */ export class DeletePublicAccessBlockCommand extends $Command< DeletePublicAccessBlockCommandInput, diff --git a/clients/client-s3/commands/GetBucketAccelerateConfigurationCommand.ts b/clients/client-s3/commands/GetBucketAccelerateConfigurationCommand.ts index 9d2a22c32d9e..c9068c494d47 100644 --- a/clients/client-s3/commands/GetBucketAccelerateConfigurationCommand.ts +++ b/clients/client-s3/commands/GetBucketAccelerateConfigurationCommand.ts @@ -51,6 +51,20 @@ export interface GetBucketAccelerateConfigurationCommandOutput *

* * + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { S3Client, GetBucketAccelerateConfigurationCommand } from "@aws-sdk/client-s3"; // ES Modules import + * // const { S3Client, GetBucketAccelerateConfigurationCommand } = require("@aws-sdk/client-s3"); // CommonJS import + * const client = new S3Client(config); + * const command = new GetBucketAccelerateConfigurationCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetBucketAccelerateConfigurationCommandInput} for command's `input` shape. + * @see {@link GetBucketAccelerateConfigurationCommandOutput} for command's `response` shape. + * @see {@link S3ClientResolvedConfig | config} for command's `input` shape. + * */ export class GetBucketAccelerateConfigurationCommand extends $Command< GetBucketAccelerateConfigurationCommandInput, diff --git a/clients/client-s3/commands/GetBucketAclCommand.ts b/clients/client-s3/commands/GetBucketAclCommand.ts index 89816a3fdab4..3f5b5f26d998 100644 --- a/clients/client-s3/commands/GetBucketAclCommand.ts +++ b/clients/client-s3/commands/GetBucketAclCommand.ts @@ -38,6 +38,20 @@ export interface GetBucketAclCommandOutput extends GetBucketAclOutput, __Metadat *

* * + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { S3Client, GetBucketAclCommand } from "@aws-sdk/client-s3"; // ES Modules import + * // const { S3Client, GetBucketAclCommand } = require("@aws-sdk/client-s3"); // CommonJS import + * const client = new S3Client(config); + * const command = new GetBucketAclCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetBucketAclCommandInput} for command's `input` shape. + * @see {@link GetBucketAclCommandOutput} for command's `response` shape. + * @see {@link S3ClientResolvedConfig | config} for command's `input` shape. + * */ export class GetBucketAclCommand extends $Command< GetBucketAclCommandInput, diff --git a/clients/client-s3/commands/GetBucketAnalyticsConfigurationCommand.ts b/clients/client-s3/commands/GetBucketAnalyticsConfigurationCommand.ts index c00adfd86ed3..875b5542d8f0 100644 --- a/clients/client-s3/commands/GetBucketAnalyticsConfigurationCommand.ts +++ b/clients/client-s3/commands/GetBucketAnalyticsConfigurationCommand.ts @@ -54,6 +54,20 @@ export interface GetBucketAnalyticsConfigurationCommandOutput *

* * + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { S3Client, GetBucketAnalyticsConfigurationCommand } from "@aws-sdk/client-s3"; // ES Modules import + * // const { S3Client, GetBucketAnalyticsConfigurationCommand } = require("@aws-sdk/client-s3"); // CommonJS import + * const client = new S3Client(config); + * const command = new GetBucketAnalyticsConfigurationCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetBucketAnalyticsConfigurationCommandInput} for command's `input` shape. + * @see {@link GetBucketAnalyticsConfigurationCommandOutput} for command's `response` shape. + * @see {@link S3ClientResolvedConfig | config} for command's `input` shape. + * */ export class GetBucketAnalyticsConfigurationCommand extends $Command< GetBucketAnalyticsConfigurationCommandInput, diff --git a/clients/client-s3/commands/GetBucketCorsCommand.ts b/clients/client-s3/commands/GetBucketCorsCommand.ts index 20f937602a1c..d0b8f03d4357 100644 --- a/clients/client-s3/commands/GetBucketCorsCommand.ts +++ b/clients/client-s3/commands/GetBucketCorsCommand.ts @@ -43,6 +43,20 @@ export interface GetBucketCorsCommandOutput extends GetBucketCorsOutput, __Metad *

* * + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { S3Client, GetBucketCorsCommand } from "@aws-sdk/client-s3"; // ES Modules import + * // const { S3Client, GetBucketCorsCommand } = require("@aws-sdk/client-s3"); // CommonJS import + * const client = new S3Client(config); + * const command = new GetBucketCorsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetBucketCorsCommandInput} for command's `input` shape. + * @see {@link GetBucketCorsCommandOutput} for command's `response` shape. + * @see {@link S3ClientResolvedConfig | config} for command's `input` shape. + * */ export class GetBucketCorsCommand extends $Command< GetBucketCorsCommandInput, diff --git a/clients/client-s3/commands/GetBucketEncryptionCommand.ts b/clients/client-s3/commands/GetBucketEncryptionCommand.ts index c0e4fd98a279..83527987c669 100644 --- a/clients/client-s3/commands/GetBucketEncryptionCommand.ts +++ b/clients/client-s3/commands/GetBucketEncryptionCommand.ts @@ -44,6 +44,20 @@ export interface GetBucketEncryptionCommandOutput extends GetBucketEncryptionOut *

* * + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { S3Client, GetBucketEncryptionCommand } from "@aws-sdk/client-s3"; // ES Modules import + * // const { S3Client, GetBucketEncryptionCommand } = require("@aws-sdk/client-s3"); // CommonJS import + * const client = new S3Client(config); + * const command = new GetBucketEncryptionCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetBucketEncryptionCommandInput} for command's `input` shape. + * @see {@link GetBucketEncryptionCommandOutput} for command's `response` shape. + * @see {@link S3ClientResolvedConfig | config} for command's `input` shape. + * */ export class GetBucketEncryptionCommand extends $Command< GetBucketEncryptionCommandInput, diff --git a/clients/client-s3/commands/GetBucketIntelligentTieringConfigurationCommand.ts b/clients/client-s3/commands/GetBucketIntelligentTieringConfigurationCommand.ts index 5e7afb7a2725..76791ef5d616 100644 --- a/clients/client-s3/commands/GetBucketIntelligentTieringConfigurationCommand.ts +++ b/clients/client-s3/commands/GetBucketIntelligentTieringConfigurationCommand.ts @@ -51,6 +51,20 @@ export interface GetBucketIntelligentTieringConfigurationCommandOutput *

* * + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { S3Client, GetBucketIntelligentTieringConfigurationCommand } from "@aws-sdk/client-s3"; // ES Modules import + * // const { S3Client, GetBucketIntelligentTieringConfigurationCommand } = require("@aws-sdk/client-s3"); // CommonJS import + * const client = new S3Client(config); + * const command = new GetBucketIntelligentTieringConfigurationCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetBucketIntelligentTieringConfigurationCommandInput} for command's `input` shape. + * @see {@link GetBucketIntelligentTieringConfigurationCommandOutput} for command's `response` shape. + * @see {@link S3ClientResolvedConfig | config} for command's `input` shape. + * */ export class GetBucketIntelligentTieringConfigurationCommand extends $Command< GetBucketIntelligentTieringConfigurationCommandInput, diff --git a/clients/client-s3/commands/GetBucketInventoryConfigurationCommand.ts b/clients/client-s3/commands/GetBucketInventoryConfigurationCommand.ts index 761df835ec51..0a5b6ff007f3 100644 --- a/clients/client-s3/commands/GetBucketInventoryConfigurationCommand.ts +++ b/clients/client-s3/commands/GetBucketInventoryConfigurationCommand.ts @@ -54,6 +54,20 @@ export interface GetBucketInventoryConfigurationCommandOutput *

* * + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { S3Client, GetBucketInventoryConfigurationCommand } from "@aws-sdk/client-s3"; // ES Modules import + * // const { S3Client, GetBucketInventoryConfigurationCommand } = require("@aws-sdk/client-s3"); // CommonJS import + * const client = new S3Client(config); + * const command = new GetBucketInventoryConfigurationCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetBucketInventoryConfigurationCommandInput} for command's `input` shape. + * @see {@link GetBucketInventoryConfigurationCommandOutput} for command's `response` shape. + * @see {@link S3ClientResolvedConfig | config} for command's `input` shape. + * */ export class GetBucketInventoryConfigurationCommand extends $Command< GetBucketInventoryConfigurationCommandInput, diff --git a/clients/client-s3/commands/GetBucketLifecycleConfigurationCommand.ts b/clients/client-s3/commands/GetBucketLifecycleConfigurationCommand.ts index 818cfeee8769..de5393aef51f 100644 --- a/clients/client-s3/commands/GetBucketLifecycleConfigurationCommand.ts +++ b/clients/client-s3/commands/GetBucketLifecycleConfigurationCommand.ts @@ -80,6 +80,20 @@ export interface GetBucketLifecycleConfigurationCommandOutput *

* * + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { S3Client, GetBucketLifecycleConfigurationCommand } from "@aws-sdk/client-s3"; // ES Modules import + * // const { S3Client, GetBucketLifecycleConfigurationCommand } = require("@aws-sdk/client-s3"); // CommonJS import + * const client = new S3Client(config); + * const command = new GetBucketLifecycleConfigurationCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetBucketLifecycleConfigurationCommandInput} for command's `input` shape. + * @see {@link GetBucketLifecycleConfigurationCommandOutput} for command's `response` shape. + * @see {@link S3ClientResolvedConfig | config} for command's `input` shape. + * */ export class GetBucketLifecycleConfigurationCommand extends $Command< GetBucketLifecycleConfigurationCommandInput, diff --git a/clients/client-s3/commands/GetBucketLocationCommand.ts b/clients/client-s3/commands/GetBucketLocationCommand.ts index bf2f67486ad2..793574c1b0d0 100644 --- a/clients/client-s3/commands/GetBucketLocationCommand.ts +++ b/clients/client-s3/commands/GetBucketLocationCommand.ts @@ -41,6 +41,20 @@ export interface GetBucketLocationCommandOutput extends GetBucketLocationOutput, *

* * + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { S3Client, GetBucketLocationCommand } from "@aws-sdk/client-s3"; // ES Modules import + * // const { S3Client, GetBucketLocationCommand } = require("@aws-sdk/client-s3"); // CommonJS import + * const client = new S3Client(config); + * const command = new GetBucketLocationCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetBucketLocationCommandInput} for command's `input` shape. + * @see {@link GetBucketLocationCommandOutput} for command's `response` shape. + * @see {@link S3ClientResolvedConfig | config} for command's `input` shape. + * */ export class GetBucketLocationCommand extends $Command< GetBucketLocationCommandInput, diff --git a/clients/client-s3/commands/GetBucketLoggingCommand.ts b/clients/client-s3/commands/GetBucketLoggingCommand.ts index ed2b4c20d7df..c91fb0a5a9b8 100644 --- a/clients/client-s3/commands/GetBucketLoggingCommand.ts +++ b/clients/client-s3/commands/GetBucketLoggingCommand.ts @@ -38,6 +38,20 @@ export interface GetBucketLoggingCommandOutput extends GetBucketLoggingOutput, _ *

* * + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { S3Client, GetBucketLoggingCommand } from "@aws-sdk/client-s3"; // ES Modules import + * // const { S3Client, GetBucketLoggingCommand } = require("@aws-sdk/client-s3"); // CommonJS import + * const client = new S3Client(config); + * const command = new GetBucketLoggingCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetBucketLoggingCommandInput} for command's `input` shape. + * @see {@link GetBucketLoggingCommandOutput} for command's `response` shape. + * @see {@link S3ClientResolvedConfig | config} for command's `input` shape. + * */ export class GetBucketLoggingCommand extends $Command< GetBucketLoggingCommandInput, diff --git a/clients/client-s3/commands/GetBucketMetricsConfigurationCommand.ts b/clients/client-s3/commands/GetBucketMetricsConfigurationCommand.ts index d4f22252872c..405a6d692d66 100644 --- a/clients/client-s3/commands/GetBucketMetricsConfigurationCommand.ts +++ b/clients/client-s3/commands/GetBucketMetricsConfigurationCommand.ts @@ -61,6 +61,20 @@ export interface GetBucketMetricsConfigurationCommandOutput *

* * + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { S3Client, GetBucketMetricsConfigurationCommand } from "@aws-sdk/client-s3"; // ES Modules import + * // const { S3Client, GetBucketMetricsConfigurationCommand } = require("@aws-sdk/client-s3"); // CommonJS import + * const client = new S3Client(config); + * const command = new GetBucketMetricsConfigurationCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetBucketMetricsConfigurationCommandInput} for command's `input` shape. + * @see {@link GetBucketMetricsConfigurationCommandOutput} for command's `response` shape. + * @see {@link S3ClientResolvedConfig | config} for command's `input` shape. + * */ export class GetBucketMetricsConfigurationCommand extends $Command< GetBucketMetricsConfigurationCommandInput, diff --git a/clients/client-s3/commands/GetBucketNotificationConfigurationCommand.ts b/clients/client-s3/commands/GetBucketNotificationConfigurationCommand.ts index 79cb3d94f4a0..24bbf2803edf 100644 --- a/clients/client-s3/commands/GetBucketNotificationConfigurationCommand.ts +++ b/clients/client-s3/commands/GetBucketNotificationConfigurationCommand.ts @@ -43,6 +43,20 @@ export interface GetBucketNotificationConfigurationCommandOutput extends Notific *

* * + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { S3Client, GetBucketNotificationConfigurationCommand } from "@aws-sdk/client-s3"; // ES Modules import + * // const { S3Client, GetBucketNotificationConfigurationCommand } = require("@aws-sdk/client-s3"); // CommonJS import + * const client = new S3Client(config); + * const command = new GetBucketNotificationConfigurationCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetBucketNotificationConfigurationCommandInput} for command's `input` shape. + * @see {@link GetBucketNotificationConfigurationCommandOutput} for command's `response` shape. + * @see {@link S3ClientResolvedConfig | config} for command's `input` shape. + * */ export class GetBucketNotificationConfigurationCommand extends $Command< GetBucketNotificationConfigurationCommandInput, diff --git a/clients/client-s3/commands/GetBucketOwnershipControlsCommand.ts b/clients/client-s3/commands/GetBucketOwnershipControlsCommand.ts index 14df31844c44..e54acb051fdc 100644 --- a/clients/client-s3/commands/GetBucketOwnershipControlsCommand.ts +++ b/clients/client-s3/commands/GetBucketOwnershipControlsCommand.ts @@ -40,6 +40,20 @@ export interface GetBucketOwnershipControlsCommandOutput extends GetBucketOwners *

* * + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { S3Client, GetBucketOwnershipControlsCommand } from "@aws-sdk/client-s3"; // ES Modules import + * // const { S3Client, GetBucketOwnershipControlsCommand } = require("@aws-sdk/client-s3"); // CommonJS import + * const client = new S3Client(config); + * const command = new GetBucketOwnershipControlsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetBucketOwnershipControlsCommandInput} for command's `input` shape. + * @see {@link GetBucketOwnershipControlsCommandOutput} for command's `response` shape. + * @see {@link S3ClientResolvedConfig | config} for command's `input` shape. + * */ export class GetBucketOwnershipControlsCommand extends $Command< GetBucketOwnershipControlsCommandInput, diff --git a/clients/client-s3/commands/GetBucketPolicyCommand.ts b/clients/client-s3/commands/GetBucketPolicyCommand.ts index 89d12e662ea5..72782c7c724c 100644 --- a/clients/client-s3/commands/GetBucketPolicyCommand.ts +++ b/clients/client-s3/commands/GetBucketPolicyCommand.ts @@ -49,6 +49,20 @@ export interface GetBucketPolicyCommandOutput extends GetBucketPolicyOutput, __M *

* * + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { S3Client, GetBucketPolicyCommand } from "@aws-sdk/client-s3"; // ES Modules import + * // const { S3Client, GetBucketPolicyCommand } = require("@aws-sdk/client-s3"); // CommonJS import + * const client = new S3Client(config); + * const command = new GetBucketPolicyCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetBucketPolicyCommandInput} for command's `input` shape. + * @see {@link GetBucketPolicyCommandOutput} for command's `response` shape. + * @see {@link S3ClientResolvedConfig | config} for command's `input` shape. + * */ export class GetBucketPolicyCommand extends $Command< GetBucketPolicyCommandInput, diff --git a/clients/client-s3/commands/GetBucketPolicyStatusCommand.ts b/clients/client-s3/commands/GetBucketPolicyStatusCommand.ts index 0659a65b51ab..6ff96c26b138 100644 --- a/clients/client-s3/commands/GetBucketPolicyStatusCommand.ts +++ b/clients/client-s3/commands/GetBucketPolicyStatusCommand.ts @@ -53,6 +53,20 @@ export interface GetBucketPolicyStatusCommandOutput extends GetBucketPolicyStatu *

* * + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { S3Client, GetBucketPolicyStatusCommand } from "@aws-sdk/client-s3"; // ES Modules import + * // const { S3Client, GetBucketPolicyStatusCommand } = require("@aws-sdk/client-s3"); // CommonJS import + * const client = new S3Client(config); + * const command = new GetBucketPolicyStatusCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetBucketPolicyStatusCommandInput} for command's `input` shape. + * @see {@link GetBucketPolicyStatusCommandOutput} for command's `response` shape. + * @see {@link S3ClientResolvedConfig | config} for command's `input` shape. + * */ export class GetBucketPolicyStatusCommand extends $Command< GetBucketPolicyStatusCommandInput, diff --git a/clients/client-s3/commands/GetBucketReplicationCommand.ts b/clients/client-s3/commands/GetBucketReplicationCommand.ts index 484dba301d0c..82f0d3989b65 100644 --- a/clients/client-s3/commands/GetBucketReplicationCommand.ts +++ b/clients/client-s3/commands/GetBucketReplicationCommand.ts @@ -57,6 +57,20 @@ export interface GetBucketReplicationCommandOutput extends GetBucketReplicationO *

* * + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { S3Client, GetBucketReplicationCommand } from "@aws-sdk/client-s3"; // ES Modules import + * // const { S3Client, GetBucketReplicationCommand } = require("@aws-sdk/client-s3"); // CommonJS import + * const client = new S3Client(config); + * const command = new GetBucketReplicationCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetBucketReplicationCommandInput} for command's `input` shape. + * @see {@link GetBucketReplicationCommandOutput} for command's `response` shape. + * @see {@link S3ClientResolvedConfig | config} for command's `input` shape. + * */ export class GetBucketReplicationCommand extends $Command< GetBucketReplicationCommandInput, diff --git a/clients/client-s3/commands/GetBucketRequestPaymentCommand.ts b/clients/client-s3/commands/GetBucketRequestPaymentCommand.ts index fe9524683cb8..dce9d597a3b7 100644 --- a/clients/client-s3/commands/GetBucketRequestPaymentCommand.ts +++ b/clients/client-s3/commands/GetBucketRequestPaymentCommand.ts @@ -33,6 +33,20 @@ export interface GetBucketRequestPaymentCommandOutput extends GetBucketRequestPa *

* * + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { S3Client, GetBucketRequestPaymentCommand } from "@aws-sdk/client-s3"; // ES Modules import + * // const { S3Client, GetBucketRequestPaymentCommand } = require("@aws-sdk/client-s3"); // CommonJS import + * const client = new S3Client(config); + * const command = new GetBucketRequestPaymentCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetBucketRequestPaymentCommandInput} for command's `input` shape. + * @see {@link GetBucketRequestPaymentCommandOutput} for command's `response` shape. + * @see {@link S3ClientResolvedConfig | config} for command's `input` shape. + * */ export class GetBucketRequestPaymentCommand extends $Command< GetBucketRequestPaymentCommandInput, diff --git a/clients/client-s3/commands/GetBucketTaggingCommand.ts b/clients/client-s3/commands/GetBucketTaggingCommand.ts index e4a7f6686e17..15ed6c6f8991 100644 --- a/clients/client-s3/commands/GetBucketTaggingCommand.ts +++ b/clients/client-s3/commands/GetBucketTaggingCommand.ts @@ -54,6 +54,20 @@ export interface GetBucketTaggingCommandOutput extends GetBucketTaggingOutput, _ *

* * + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { S3Client, GetBucketTaggingCommand } from "@aws-sdk/client-s3"; // ES Modules import + * // const { S3Client, GetBucketTaggingCommand } = require("@aws-sdk/client-s3"); // CommonJS import + * const client = new S3Client(config); + * const command = new GetBucketTaggingCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetBucketTaggingCommandInput} for command's `input` shape. + * @see {@link GetBucketTaggingCommandOutput} for command's `response` shape. + * @see {@link S3ClientResolvedConfig | config} for command's `input` shape. + * */ export class GetBucketTaggingCommand extends $Command< GetBucketTaggingCommandInput, diff --git a/clients/client-s3/commands/GetBucketVersioningCommand.ts b/clients/client-s3/commands/GetBucketVersioningCommand.ts index b01b20e37467..fc53599b16e3 100644 --- a/clients/client-s3/commands/GetBucketVersioningCommand.ts +++ b/clients/client-s3/commands/GetBucketVersioningCommand.ts @@ -47,6 +47,20 @@ export interface GetBucketVersioningCommandOutput extends GetBucketVersioningOut *

* * + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { S3Client, GetBucketVersioningCommand } from "@aws-sdk/client-s3"; // ES Modules import + * // const { S3Client, GetBucketVersioningCommand } = require("@aws-sdk/client-s3"); // CommonJS import + * const client = new S3Client(config); + * const command = new GetBucketVersioningCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetBucketVersioningCommandInput} for command's `input` shape. + * @see {@link GetBucketVersioningCommandOutput} for command's `response` shape. + * @see {@link S3ClientResolvedConfig | config} for command's `input` shape. + * */ export class GetBucketVersioningCommand extends $Command< GetBucketVersioningCommandInput, diff --git a/clients/client-s3/commands/GetBucketWebsiteCommand.ts b/clients/client-s3/commands/GetBucketWebsiteCommand.ts index 45c5911d6d09..359c050147fd 100644 --- a/clients/client-s3/commands/GetBucketWebsiteCommand.ts +++ b/clients/client-s3/commands/GetBucketWebsiteCommand.ts @@ -43,6 +43,20 @@ export interface GetBucketWebsiteCommandOutput extends GetBucketWebsiteOutput, _ *

* * + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { S3Client, GetBucketWebsiteCommand } from "@aws-sdk/client-s3"; // ES Modules import + * // const { S3Client, GetBucketWebsiteCommand } = require("@aws-sdk/client-s3"); // CommonJS import + * const client = new S3Client(config); + * const command = new GetBucketWebsiteCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetBucketWebsiteCommandInput} for command's `input` shape. + * @see {@link GetBucketWebsiteCommandOutput} for command's `response` shape. + * @see {@link S3ClientResolvedConfig | config} for command's `input` shape. + * */ export class GetBucketWebsiteCommand extends $Command< GetBucketWebsiteCommandInput, diff --git a/clients/client-s3/commands/GetObjectAclCommand.ts b/clients/client-s3/commands/GetObjectAclCommand.ts index 61cfb6eac6fe..880e717ad826 100644 --- a/clients/client-s3/commands/GetObjectAclCommand.ts +++ b/clients/client-s3/commands/GetObjectAclCommand.ts @@ -49,6 +49,20 @@ export interface GetObjectAclCommandOutput extends GetObjectAclOutput, __Metadat *

* * + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { S3Client, GetObjectAclCommand } from "@aws-sdk/client-s3"; // ES Modules import + * // const { S3Client, GetObjectAclCommand } = require("@aws-sdk/client-s3"); // CommonJS import + * const client = new S3Client(config); + * const command = new GetObjectAclCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetObjectAclCommandInput} for command's `input` shape. + * @see {@link GetObjectAclCommandOutput} for command's `response` shape. + * @see {@link S3ClientResolvedConfig | config} for command's `input` shape. + * */ export class GetObjectAclCommand extends $Command< GetObjectAclCommandInput, diff --git a/clients/client-s3/commands/GetObjectCommand.ts b/clients/client-s3/commands/GetObjectCommand.ts index 6c796a05fb54..ab67a73bd813 100644 --- a/clients/client-s3/commands/GetObjectCommand.ts +++ b/clients/client-s3/commands/GetObjectCommand.ts @@ -194,6 +194,20 @@ export interface GetObjectCommandOutput extends GetObjectOutput, __MetadataBeare *

* * + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { S3Client, GetObjectCommand } from "@aws-sdk/client-s3"; // ES Modules import + * // const { S3Client, GetObjectCommand } = require("@aws-sdk/client-s3"); // CommonJS import + * const client = new S3Client(config); + * const command = new GetObjectCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetObjectCommandInput} for command's `input` shape. + * @see {@link GetObjectCommandOutput} for command's `response` shape. + * @see {@link S3ClientResolvedConfig | config} for command's `input` shape. + * */ export class GetObjectCommand extends $Command { // Start section: command_properties diff --git a/clients/client-s3/commands/GetObjectLegalHoldCommand.ts b/clients/client-s3/commands/GetObjectLegalHoldCommand.ts index 7c49939a4971..7fe230ab290b 100644 --- a/clients/client-s3/commands/GetObjectLegalHoldCommand.ts +++ b/clients/client-s3/commands/GetObjectLegalHoldCommand.ts @@ -24,6 +24,20 @@ export interface GetObjectLegalHoldCommandOutput extends GetObjectLegalHoldOutpu /** *

Gets an object's current Legal Hold status. For more information, see Locking Objects.

*

This action is not supported by Amazon S3 on Outposts.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { S3Client, GetObjectLegalHoldCommand } from "@aws-sdk/client-s3"; // ES Modules import + * // const { S3Client, GetObjectLegalHoldCommand } = require("@aws-sdk/client-s3"); // CommonJS import + * const client = new S3Client(config); + * const command = new GetObjectLegalHoldCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetObjectLegalHoldCommandInput} for command's `input` shape. + * @see {@link GetObjectLegalHoldCommandOutput} for command's `response` shape. + * @see {@link S3ClientResolvedConfig | config} for command's `input` shape. + * */ export class GetObjectLegalHoldCommand extends $Command< GetObjectLegalHoldCommandInput, diff --git a/clients/client-s3/commands/GetObjectLockConfigurationCommand.ts b/clients/client-s3/commands/GetObjectLockConfigurationCommand.ts index 17b0cfd1fbd5..239a27de42b4 100644 --- a/clients/client-s3/commands/GetObjectLockConfigurationCommand.ts +++ b/clients/client-s3/commands/GetObjectLockConfigurationCommand.ts @@ -26,6 +26,20 @@ export interface GetObjectLockConfigurationCommandOutput extends GetObjectLockCo * configuration will be applied by default to every new object placed in the specified * bucket. For more information, see Locking * Objects.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { S3Client, GetObjectLockConfigurationCommand } from "@aws-sdk/client-s3"; // ES Modules import + * // const { S3Client, GetObjectLockConfigurationCommand } = require("@aws-sdk/client-s3"); // CommonJS import + * const client = new S3Client(config); + * const command = new GetObjectLockConfigurationCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetObjectLockConfigurationCommandInput} for command's `input` shape. + * @see {@link GetObjectLockConfigurationCommandOutput} for command's `response` shape. + * @see {@link S3ClientResolvedConfig | config} for command's `input` shape. + * */ export class GetObjectLockConfigurationCommand extends $Command< GetObjectLockConfigurationCommandInput, diff --git a/clients/client-s3/commands/GetObjectRetentionCommand.ts b/clients/client-s3/commands/GetObjectRetentionCommand.ts index f5839186f268..69e167561e79 100644 --- a/clients/client-s3/commands/GetObjectRetentionCommand.ts +++ b/clients/client-s3/commands/GetObjectRetentionCommand.ts @@ -24,6 +24,20 @@ export interface GetObjectRetentionCommandOutput extends GetObjectRetentionOutpu /** *

Retrieves an object's retention settings. For more information, see Locking Objects.

*

This action is not supported by Amazon S3 on Outposts.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { S3Client, GetObjectRetentionCommand } from "@aws-sdk/client-s3"; // ES Modules import + * // const { S3Client, GetObjectRetentionCommand } = require("@aws-sdk/client-s3"); // CommonJS import + * const client = new S3Client(config); + * const command = new GetObjectRetentionCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetObjectRetentionCommandInput} for command's `input` shape. + * @see {@link GetObjectRetentionCommandOutput} for command's `response` shape. + * @see {@link S3ClientResolvedConfig | config} for command's `input` shape. + * */ export class GetObjectRetentionCommand extends $Command< GetObjectRetentionCommandInput, diff --git a/clients/client-s3/commands/GetObjectTaggingCommand.ts b/clients/client-s3/commands/GetObjectTaggingCommand.ts index 7f312bd46360..c1c15f9f3760 100644 --- a/clients/client-s3/commands/GetObjectTaggingCommand.ts +++ b/clients/client-s3/commands/GetObjectTaggingCommand.ts @@ -50,6 +50,20 @@ export interface GetObjectTaggingCommandOutput extends GetObjectTaggingOutput, _ *

* * + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { S3Client, GetObjectTaggingCommand } from "@aws-sdk/client-s3"; // ES Modules import + * // const { S3Client, GetObjectTaggingCommand } = require("@aws-sdk/client-s3"); // CommonJS import + * const client = new S3Client(config); + * const command = new GetObjectTaggingCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetObjectTaggingCommandInput} for command's `input` shape. + * @see {@link GetObjectTaggingCommandOutput} for command's `response` shape. + * @see {@link S3ClientResolvedConfig | config} for command's `input` shape. + * */ export class GetObjectTaggingCommand extends $Command< GetObjectTaggingCommandInput, diff --git a/clients/client-s3/commands/GetObjectTorrentCommand.ts b/clients/client-s3/commands/GetObjectTorrentCommand.ts index f18d6b91d5f4..66b508f0548c 100644 --- a/clients/client-s3/commands/GetObjectTorrentCommand.ts +++ b/clients/client-s3/commands/GetObjectTorrentCommand.ts @@ -39,6 +39,20 @@ export interface GetObjectTorrentCommandOutput extends GetObjectTorrentOutput, _ *

* * + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { S3Client, GetObjectTorrentCommand } from "@aws-sdk/client-s3"; // ES Modules import + * // const { S3Client, GetObjectTorrentCommand } = require("@aws-sdk/client-s3"); // CommonJS import + * const client = new S3Client(config); + * const command = new GetObjectTorrentCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetObjectTorrentCommandInput} for command's `input` shape. + * @see {@link GetObjectTorrentCommandOutput} for command's `response` shape. + * @see {@link S3ClientResolvedConfig | config} for command's `input` shape. + * */ export class GetObjectTorrentCommand extends $Command< GetObjectTorrentCommandInput, diff --git a/clients/client-s3/commands/GetPublicAccessBlockCommand.ts b/clients/client-s3/commands/GetPublicAccessBlockCommand.ts index 830cea0a9504..1400ca93ff87 100644 --- a/clients/client-s3/commands/GetPublicAccessBlockCommand.ts +++ b/clients/client-s3/commands/GetPublicAccessBlockCommand.ts @@ -62,6 +62,20 @@ export interface GetPublicAccessBlockCommandOutput extends GetPublicAccessBlockO *

* * + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { S3Client, GetPublicAccessBlockCommand } from "@aws-sdk/client-s3"; // ES Modules import + * // const { S3Client, GetPublicAccessBlockCommand } = require("@aws-sdk/client-s3"); // CommonJS import + * const client = new S3Client(config); + * const command = new GetPublicAccessBlockCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetPublicAccessBlockCommandInput} for command's `input` shape. + * @see {@link GetPublicAccessBlockCommandOutput} for command's `response` shape. + * @see {@link S3ClientResolvedConfig | config} for command's `input` shape. + * */ export class GetPublicAccessBlockCommand extends $Command< GetPublicAccessBlockCommandInput, diff --git a/clients/client-s3/commands/HeadBucketCommand.ts b/clients/client-s3/commands/HeadBucketCommand.ts index abd3b8cc1247..4fe753a45fee 100644 --- a/clients/client-s3/commands/HeadBucketCommand.ts +++ b/clients/client-s3/commands/HeadBucketCommand.ts @@ -35,6 +35,20 @@ export interface HeadBucketCommandOutput extends __MetadataBearer {} * 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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { S3Client, HeadBucketCommand } from "@aws-sdk/client-s3"; // ES Modules import + * // const { S3Client, HeadBucketCommand } = require("@aws-sdk/client-s3"); // CommonJS import + * const client = new S3Client(config); + * const command = new HeadBucketCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link HeadBucketCommandInput} for command's `input` shape. + * @see {@link HeadBucketCommandOutput} for command's `response` shape. + * @see {@link S3ClientResolvedConfig | config} for command's `input` shape. + * */ export class HeadBucketCommand extends $Command< HeadBucketCommandInput, diff --git a/clients/client-s3/commands/HeadObjectCommand.ts b/clients/client-s3/commands/HeadObjectCommand.ts index bee5a3641183..d2e3ece0a4a6 100644 --- a/clients/client-s3/commands/HeadObjectCommand.ts +++ b/clients/client-s3/commands/HeadObjectCommand.ts @@ -135,6 +135,20 @@ export interface HeadObjectCommandOutput extends HeadObjectOutput, __MetadataBea *

* * + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { S3Client, HeadObjectCommand } from "@aws-sdk/client-s3"; // ES Modules import + * // const { S3Client, HeadObjectCommand } = require("@aws-sdk/client-s3"); // CommonJS import + * const client = new S3Client(config); + * const command = new HeadObjectCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link HeadObjectCommandInput} for command's `input` shape. + * @see {@link HeadObjectCommandOutput} for command's `response` shape. + * @see {@link S3ClientResolvedConfig | config} for command's `input` shape. + * */ export class HeadObjectCommand extends $Command< HeadObjectCommandInput, diff --git a/clients/client-s3/commands/ListBucketAnalyticsConfigurationsCommand.ts b/clients/client-s3/commands/ListBucketAnalyticsConfigurationsCommand.ts index 4b34546a868f..6c54f0dd7dab 100644 --- a/clients/client-s3/commands/ListBucketAnalyticsConfigurationsCommand.ts +++ b/clients/client-s3/commands/ListBucketAnalyticsConfigurationsCommand.ts @@ -64,6 +64,20 @@ export interface ListBucketAnalyticsConfigurationsCommandOutput *

* * + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { S3Client, ListBucketAnalyticsConfigurationsCommand } from "@aws-sdk/client-s3"; // ES Modules import + * // const { S3Client, ListBucketAnalyticsConfigurationsCommand } = require("@aws-sdk/client-s3"); // CommonJS import + * const client = new S3Client(config); + * const command = new ListBucketAnalyticsConfigurationsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListBucketAnalyticsConfigurationsCommandInput} for command's `input` shape. + * @see {@link ListBucketAnalyticsConfigurationsCommandOutput} for command's `response` shape. + * @see {@link S3ClientResolvedConfig | config} for command's `input` shape. + * */ export class ListBucketAnalyticsConfigurationsCommand extends $Command< ListBucketAnalyticsConfigurationsCommandInput, diff --git a/clients/client-s3/commands/ListBucketIntelligentTieringConfigurationsCommand.ts b/clients/client-s3/commands/ListBucketIntelligentTieringConfigurationsCommand.ts index 96dbbc520d7c..f8feb4f67863 100644 --- a/clients/client-s3/commands/ListBucketIntelligentTieringConfigurationsCommand.ts +++ b/clients/client-s3/commands/ListBucketIntelligentTieringConfigurationsCommand.ts @@ -51,6 +51,20 @@ export interface ListBucketIntelligentTieringConfigurationsCommandOutput *

* * + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { S3Client, ListBucketIntelligentTieringConfigurationsCommand } from "@aws-sdk/client-s3"; // ES Modules import + * // const { S3Client, ListBucketIntelligentTieringConfigurationsCommand } = require("@aws-sdk/client-s3"); // CommonJS import + * const client = new S3Client(config); + * const command = new ListBucketIntelligentTieringConfigurationsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListBucketIntelligentTieringConfigurationsCommandInput} for command's `input` shape. + * @see {@link ListBucketIntelligentTieringConfigurationsCommandOutput} for command's `response` shape. + * @see {@link S3ClientResolvedConfig | config} for command's `input` shape. + * */ export class ListBucketIntelligentTieringConfigurationsCommand extends $Command< ListBucketIntelligentTieringConfigurationsCommandInput, diff --git a/clients/client-s3/commands/ListBucketInventoryConfigurationsCommand.ts b/clients/client-s3/commands/ListBucketInventoryConfigurationsCommand.ts index 26df1c1aca0c..3042f2458056 100644 --- a/clients/client-s3/commands/ListBucketInventoryConfigurationsCommand.ts +++ b/clients/client-s3/commands/ListBucketInventoryConfigurationsCommand.ts @@ -63,6 +63,20 @@ export interface ListBucketInventoryConfigurationsCommandOutput *

* * + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { S3Client, ListBucketInventoryConfigurationsCommand } from "@aws-sdk/client-s3"; // ES Modules import + * // const { S3Client, ListBucketInventoryConfigurationsCommand } = require("@aws-sdk/client-s3"); // CommonJS import + * const client = new S3Client(config); + * const command = new ListBucketInventoryConfigurationsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListBucketInventoryConfigurationsCommandInput} for command's `input` shape. + * @see {@link ListBucketInventoryConfigurationsCommandOutput} for command's `response` shape. + * @see {@link S3ClientResolvedConfig | config} for command's `input` shape. + * */ export class ListBucketInventoryConfigurationsCommand extends $Command< ListBucketInventoryConfigurationsCommandInput, diff --git a/clients/client-s3/commands/ListBucketMetricsConfigurationsCommand.ts b/clients/client-s3/commands/ListBucketMetricsConfigurationsCommand.ts index 6da620cb950a..17b6e493d589 100644 --- a/clients/client-s3/commands/ListBucketMetricsConfigurationsCommand.ts +++ b/clients/client-s3/commands/ListBucketMetricsConfigurationsCommand.ts @@ -65,6 +65,20 @@ export interface ListBucketMetricsConfigurationsCommandOutput *

* * + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { S3Client, ListBucketMetricsConfigurationsCommand } from "@aws-sdk/client-s3"; // ES Modules import + * // const { S3Client, ListBucketMetricsConfigurationsCommand } = require("@aws-sdk/client-s3"); // CommonJS import + * const client = new S3Client(config); + * const command = new ListBucketMetricsConfigurationsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListBucketMetricsConfigurationsCommandInput} for command's `input` shape. + * @see {@link ListBucketMetricsConfigurationsCommandOutput} for command's `response` shape. + * @see {@link S3ClientResolvedConfig | config} for command's `input` shape. + * */ export class ListBucketMetricsConfigurationsCommand extends $Command< ListBucketMetricsConfigurationsCommandInput, diff --git a/clients/client-s3/commands/ListBucketsCommand.ts b/clients/client-s3/commands/ListBucketsCommand.ts index b88ee77c2cd4..f32c59d7885d 100644 --- a/clients/client-s3/commands/ListBucketsCommand.ts +++ b/clients/client-s3/commands/ListBucketsCommand.ts @@ -22,6 +22,20 @@ export interface ListBucketsCommandOutput extends ListBucketsOutput, __MetadataB /** *

Returns a list of all buckets owned by the authenticated sender of the request.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { S3Client, ListBucketsCommand } from "@aws-sdk/client-s3"; // ES Modules import + * // const { S3Client, ListBucketsCommand } = require("@aws-sdk/client-s3"); // CommonJS import + * const client = new S3Client(config); + * const command = new ListBucketsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListBucketsCommandInput} for command's `input` shape. + * @see {@link ListBucketsCommandOutput} for command's `response` shape. + * @see {@link S3ClientResolvedConfig | config} for command's `input` shape. + * */ export class ListBucketsCommand extends $Command< ListBucketsCommandInput, diff --git a/clients/client-s3/commands/ListMultipartUploadsCommand.ts b/clients/client-s3/commands/ListMultipartUploadsCommand.ts index dfbd6a7c8aed..07384fe1d835 100644 --- a/clients/client-s3/commands/ListMultipartUploadsCommand.ts +++ b/clients/client-s3/commands/ListMultipartUploadsCommand.ts @@ -73,6 +73,20 @@ export interface ListMultipartUploadsCommandOutput extends ListMultipartUploadsO *

* * + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { S3Client, ListMultipartUploadsCommand } from "@aws-sdk/client-s3"; // ES Modules import + * // const { S3Client, ListMultipartUploadsCommand } = require("@aws-sdk/client-s3"); // CommonJS import + * const client = new S3Client(config); + * const command = new ListMultipartUploadsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListMultipartUploadsCommandInput} for command's `input` shape. + * @see {@link ListMultipartUploadsCommandOutput} for command's `response` shape. + * @see {@link S3ClientResolvedConfig | config} for command's `input` shape. + * */ export class ListMultipartUploadsCommand extends $Command< ListMultipartUploadsCommandInput, diff --git a/clients/client-s3/commands/ListObjectVersionsCommand.ts b/clients/client-s3/commands/ListObjectVersionsCommand.ts index 453d7c72f2c6..5b14f878267f 100644 --- a/clients/client-s3/commands/ListObjectVersionsCommand.ts +++ b/clients/client-s3/commands/ListObjectVersionsCommand.ts @@ -61,6 +61,20 @@ export interface ListObjectVersionsCommandOutput extends ListObjectVersionsOutpu *

* * + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { S3Client, ListObjectVersionsCommand } from "@aws-sdk/client-s3"; // ES Modules import + * // const { S3Client, ListObjectVersionsCommand } = require("@aws-sdk/client-s3"); // CommonJS import + * const client = new S3Client(config); + * const command = new ListObjectVersionsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListObjectVersionsCommandInput} for command's `input` shape. + * @see {@link ListObjectVersionsCommandOutput} for command's `response` shape. + * @see {@link S3ClientResolvedConfig | config} for command's `input` shape. + * */ export class ListObjectVersionsCommand extends $Command< ListObjectVersionsCommandInput, diff --git a/clients/client-s3/commands/ListObjectsCommand.ts b/clients/client-s3/commands/ListObjectsCommand.ts index 66835226ce8e..33f0426486a7 100644 --- a/clients/client-s3/commands/ListObjectsCommand.ts +++ b/clients/client-s3/commands/ListObjectsCommand.ts @@ -60,6 +60,20 @@ export interface ListObjectsCommandOutput extends ListObjectsOutput, __MetadataB *

* * + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { S3Client, ListObjectsCommand } from "@aws-sdk/client-s3"; // ES Modules import + * // const { S3Client, ListObjectsCommand } = require("@aws-sdk/client-s3"); // CommonJS import + * const client = new S3Client(config); + * const command = new ListObjectsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListObjectsCommandInput} for command's `input` shape. + * @see {@link ListObjectsCommandOutput} for command's `response` shape. + * @see {@link S3ClientResolvedConfig | config} for command's `input` shape. + * */ export class ListObjectsCommand extends $Command< ListObjectsCommandInput, diff --git a/clients/client-s3/commands/ListObjectsV2Command.ts b/clients/client-s3/commands/ListObjectsV2Command.ts index 56332e0a8919..5f68b84093d7 100644 --- a/clients/client-s3/commands/ListObjectsV2Command.ts +++ b/clients/client-s3/commands/ListObjectsV2Command.ts @@ -61,6 +61,20 @@ export interface ListObjectsV2CommandOutput extends ListObjectsV2Output, __Metad *

* * + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { S3Client, ListObjectsV2Command } from "@aws-sdk/client-s3"; // ES Modules import + * // const { S3Client, ListObjectsV2Command } = require("@aws-sdk/client-s3"); // CommonJS import + * const client = new S3Client(config); + * const command = new ListObjectsV2Command(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListObjectsV2CommandInput} for command's `input` shape. + * @see {@link ListObjectsV2CommandOutput} for command's `response` shape. + * @see {@link S3ClientResolvedConfig | config} for command's `input` shape. + * */ export class ListObjectsV2Command extends $Command< ListObjectsV2CommandInput, diff --git a/clients/client-s3/commands/ListPartsCommand.ts b/clients/client-s3/commands/ListPartsCommand.ts index 3498c4e858c0..add683901dd0 100644 --- a/clients/client-s3/commands/ListPartsCommand.ts +++ b/clients/client-s3/commands/ListPartsCommand.ts @@ -64,6 +64,20 @@ export interface ListPartsCommandOutput extends ListPartsOutput, __MetadataBeare *

* * + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { S3Client, ListPartsCommand } from "@aws-sdk/client-s3"; // ES Modules import + * // const { S3Client, ListPartsCommand } = require("@aws-sdk/client-s3"); // CommonJS import + * const client = new S3Client(config); + * const command = new ListPartsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListPartsCommandInput} for command's `input` shape. + * @see {@link ListPartsCommandOutput} for command's `response` shape. + * @see {@link S3ClientResolvedConfig | config} for command's `input` shape. + * */ export class ListPartsCommand extends $Command { // Start section: command_properties diff --git a/clients/client-s3/commands/PutBucketAccelerateConfigurationCommand.ts b/clients/client-s3/commands/PutBucketAccelerateConfigurationCommand.ts index cf901fa283ac..0b0ff98c1ba5 100644 --- a/clients/client-s3/commands/PutBucketAccelerateConfigurationCommand.ts +++ b/clients/client-s3/commands/PutBucketAccelerateConfigurationCommand.ts @@ -68,6 +68,20 @@ export interface PutBucketAccelerateConfigurationCommandOutput extends __Metadat *

* * + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { S3Client, PutBucketAccelerateConfigurationCommand } from "@aws-sdk/client-s3"; // ES Modules import + * // const { S3Client, PutBucketAccelerateConfigurationCommand } = require("@aws-sdk/client-s3"); // CommonJS import + * const client = new S3Client(config); + * const command = new PutBucketAccelerateConfigurationCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link PutBucketAccelerateConfigurationCommandInput} for command's `input` shape. + * @see {@link PutBucketAccelerateConfigurationCommandOutput} for command's `response` shape. + * @see {@link S3ClientResolvedConfig | config} for command's `input` shape. + * */ export class PutBucketAccelerateConfigurationCommand extends $Command< PutBucketAccelerateConfigurationCommandInput, diff --git a/clients/client-s3/commands/PutBucketAclCommand.ts b/clients/client-s3/commands/PutBucketAclCommand.ts index 9b6d7e4d572b..602639da1e41 100644 --- a/clients/client-s3/commands/PutBucketAclCommand.ts +++ b/clients/client-s3/commands/PutBucketAclCommand.ts @@ -213,6 +213,20 @@ export interface PutBucketAclCommandOutput extends __MetadataBearer {} *

* * + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { S3Client, PutBucketAclCommand } from "@aws-sdk/client-s3"; // ES Modules import + * // const { S3Client, PutBucketAclCommand } = require("@aws-sdk/client-s3"); // CommonJS import + * const client = new S3Client(config); + * const command = new PutBucketAclCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link PutBucketAclCommandInput} for command's `input` shape. + * @see {@link PutBucketAclCommandOutput} for command's `response` shape. + * @see {@link S3ClientResolvedConfig | config} for command's `input` shape. + * */ export class PutBucketAclCommand extends $Command< PutBucketAclCommandInput, diff --git a/clients/client-s3/commands/PutBucketAnalyticsConfigurationCommand.ts b/clients/client-s3/commands/PutBucketAnalyticsConfigurationCommand.ts index 685407f15af3..2dc868aece4a 100644 --- a/clients/client-s3/commands/PutBucketAnalyticsConfigurationCommand.ts +++ b/clients/client-s3/commands/PutBucketAnalyticsConfigurationCommand.ts @@ -138,6 +138,20 @@ export interface PutBucketAnalyticsConfigurationCommandOutput extends __Metadata *

* * + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { S3Client, PutBucketAnalyticsConfigurationCommand } from "@aws-sdk/client-s3"; // ES Modules import + * // const { S3Client, PutBucketAnalyticsConfigurationCommand } = require("@aws-sdk/client-s3"); // CommonJS import + * const client = new S3Client(config); + * const command = new PutBucketAnalyticsConfigurationCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link PutBucketAnalyticsConfigurationCommandInput} for command's `input` shape. + * @see {@link PutBucketAnalyticsConfigurationCommandOutput} for command's `response` shape. + * @see {@link S3ClientResolvedConfig | config} for command's `input` shape. + * */ export class PutBucketAnalyticsConfigurationCommand extends $Command< PutBucketAnalyticsConfigurationCommandInput, diff --git a/clients/client-s3/commands/PutBucketCorsCommand.ts b/clients/client-s3/commands/PutBucketCorsCommand.ts index 83acce143260..2b62e3ebfd8d 100644 --- a/clients/client-s3/commands/PutBucketCorsCommand.ts +++ b/clients/client-s3/commands/PutBucketCorsCommand.ts @@ -80,6 +80,20 @@ export interface PutBucketCorsCommandOutput extends __MetadataBearer {} *

* * + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { S3Client, PutBucketCorsCommand } from "@aws-sdk/client-s3"; // ES Modules import + * // const { S3Client, PutBucketCorsCommand } = require("@aws-sdk/client-s3"); // CommonJS import + * const client = new S3Client(config); + * const command = new PutBucketCorsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link PutBucketCorsCommandInput} for command's `input` shape. + * @see {@link PutBucketCorsCommandOutput} for command's `response` shape. + * @see {@link S3ClientResolvedConfig | config} for command's `input` shape. + * */ export class PutBucketCorsCommand extends $Command< PutBucketCorsCommandInput, diff --git a/clients/client-s3/commands/PutBucketEncryptionCommand.ts b/clients/client-s3/commands/PutBucketEncryptionCommand.ts index 9479576bfcc2..8f1110baa95e 100644 --- a/clients/client-s3/commands/PutBucketEncryptionCommand.ts +++ b/clients/client-s3/commands/PutBucketEncryptionCommand.ts @@ -55,6 +55,20 @@ export interface PutBucketEncryptionCommandOutput extends __MetadataBearer {} *

* * + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { S3Client, PutBucketEncryptionCommand } from "@aws-sdk/client-s3"; // ES Modules import + * // const { S3Client, PutBucketEncryptionCommand } = require("@aws-sdk/client-s3"); // CommonJS import + * const client = new S3Client(config); + * const command = new PutBucketEncryptionCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link PutBucketEncryptionCommandInput} for command's `input` shape. + * @see {@link PutBucketEncryptionCommandOutput} for command's `response` shape. + * @see {@link S3ClientResolvedConfig | config} for command's `input` shape. + * */ export class PutBucketEncryptionCommand extends $Command< PutBucketEncryptionCommandInput, diff --git a/clients/client-s3/commands/PutBucketIntelligentTieringConfigurationCommand.ts b/clients/client-s3/commands/PutBucketIntelligentTieringConfigurationCommand.ts index 5caae28fdc19..65acec9b61c5 100644 --- a/clients/client-s3/commands/PutBucketIntelligentTieringConfigurationCommand.ts +++ b/clients/client-s3/commands/PutBucketIntelligentTieringConfigurationCommand.ts @@ -106,6 +106,20 @@ export interface PutBucketIntelligentTieringConfigurationCommandOutput extends _ * * * + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { S3Client, PutBucketIntelligentTieringConfigurationCommand } from "@aws-sdk/client-s3"; // ES Modules import + * // const { S3Client, PutBucketIntelligentTieringConfigurationCommand } = require("@aws-sdk/client-s3"); // CommonJS import + * const client = new S3Client(config); + * const command = new PutBucketIntelligentTieringConfigurationCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link PutBucketIntelligentTieringConfigurationCommandInput} for command's `input` shape. + * @see {@link PutBucketIntelligentTieringConfigurationCommandOutput} for command's `response` shape. + * @see {@link S3ClientResolvedConfig | config} for command's `input` shape. + * */ export class PutBucketIntelligentTieringConfigurationCommand extends $Command< PutBucketIntelligentTieringConfigurationCommandInput, diff --git a/clients/client-s3/commands/PutBucketInventoryConfigurationCommand.ts b/clients/client-s3/commands/PutBucketInventoryConfigurationCommand.ts index a439a975e317..19b691cb7fc1 100644 --- a/clients/client-s3/commands/PutBucketInventoryConfigurationCommand.ts +++ b/clients/client-s3/commands/PutBucketInventoryConfigurationCommand.ts @@ -123,6 +123,20 @@ export interface PutBucketInventoryConfigurationCommandOutput extends __Metadata *

* * + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { S3Client, PutBucketInventoryConfigurationCommand } from "@aws-sdk/client-s3"; // ES Modules import + * // const { S3Client, PutBucketInventoryConfigurationCommand } = require("@aws-sdk/client-s3"); // CommonJS import + * const client = new S3Client(config); + * const command = new PutBucketInventoryConfigurationCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link PutBucketInventoryConfigurationCommandInput} for command's `input` shape. + * @see {@link PutBucketInventoryConfigurationCommandOutput} for command's `response` shape. + * @see {@link S3ClientResolvedConfig | config} for command's `input` shape. + * */ export class PutBucketInventoryConfigurationCommand extends $Command< PutBucketInventoryConfigurationCommandInput, diff --git a/clients/client-s3/commands/PutBucketLifecycleConfigurationCommand.ts b/clients/client-s3/commands/PutBucketLifecycleConfigurationCommand.ts index 36ff0d908722..c0fd6e5761c3 100644 --- a/clients/client-s3/commands/PutBucketLifecycleConfigurationCommand.ts +++ b/clients/client-s3/commands/PutBucketLifecycleConfigurationCommand.ts @@ -117,6 +117,20 @@ export interface PutBucketLifecycleConfigurationCommandOutput extends __Metadata *

* * + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { S3Client, PutBucketLifecycleConfigurationCommand } from "@aws-sdk/client-s3"; // ES Modules import + * // const { S3Client, PutBucketLifecycleConfigurationCommand } = require("@aws-sdk/client-s3"); // CommonJS import + * const client = new S3Client(config); + * const command = new PutBucketLifecycleConfigurationCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link PutBucketLifecycleConfigurationCommandInput} for command's `input` shape. + * @see {@link PutBucketLifecycleConfigurationCommandOutput} for command's `response` shape. + * @see {@link S3ClientResolvedConfig | config} for command's `input` shape. + * */ export class PutBucketLifecycleConfigurationCommand extends $Command< PutBucketLifecycleConfigurationCommandInput, diff --git a/clients/client-s3/commands/PutBucketLoggingCommand.ts b/clients/client-s3/commands/PutBucketLoggingCommand.ts index bac5f77f724e..0189bb9e21e7 100644 --- a/clients/client-s3/commands/PutBucketLoggingCommand.ts +++ b/clients/client-s3/commands/PutBucketLoggingCommand.ts @@ -102,6 +102,20 @@ export interface PutBucketLoggingCommandOutput extends __MetadataBearer {} *

* * + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { S3Client, PutBucketLoggingCommand } from "@aws-sdk/client-s3"; // ES Modules import + * // const { S3Client, PutBucketLoggingCommand } = require("@aws-sdk/client-s3"); // CommonJS import + * const client = new S3Client(config); + * const command = new PutBucketLoggingCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link PutBucketLoggingCommandInput} for command's `input` shape. + * @see {@link PutBucketLoggingCommandOutput} for command's `response` shape. + * @see {@link S3ClientResolvedConfig | config} for command's `input` shape. + * */ export class PutBucketLoggingCommand extends $Command< PutBucketLoggingCommandInput, diff --git a/clients/client-s3/commands/PutBucketMetricsConfigurationCommand.ts b/clients/client-s3/commands/PutBucketMetricsConfigurationCommand.ts index 0f0e8f92b063..f84ca80d49bb 100644 --- a/clients/client-s3/commands/PutBucketMetricsConfigurationCommand.ts +++ b/clients/client-s3/commands/PutBucketMetricsConfigurationCommand.ts @@ -73,6 +73,20 @@ export interface PutBucketMetricsConfigurationCommandOutput extends __MetadataBe * * * + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { S3Client, PutBucketMetricsConfigurationCommand } from "@aws-sdk/client-s3"; // ES Modules import + * // const { S3Client, PutBucketMetricsConfigurationCommand } = require("@aws-sdk/client-s3"); // CommonJS import + * const client = new S3Client(config); + * const command = new PutBucketMetricsConfigurationCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link PutBucketMetricsConfigurationCommandInput} for command's `input` shape. + * @see {@link PutBucketMetricsConfigurationCommandOutput} for command's `response` shape. + * @see {@link S3ClientResolvedConfig | config} for command's `input` shape. + * */ export class PutBucketMetricsConfigurationCommand extends $Command< PutBucketMetricsConfigurationCommandInput, diff --git a/clients/client-s3/commands/PutBucketNotificationConfigurationCommand.ts b/clients/client-s3/commands/PutBucketNotificationConfigurationCommand.ts index 9dcb6bcb8aed..6f97c07cda3f 100644 --- a/clients/client-s3/commands/PutBucketNotificationConfigurationCommand.ts +++ b/clients/client-s3/commands/PutBucketNotificationConfigurationCommand.ts @@ -84,6 +84,20 @@ export interface PutBucketNotificationConfigurationCommandOutput extends __Metad *

* * + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { S3Client, PutBucketNotificationConfigurationCommand } from "@aws-sdk/client-s3"; // ES Modules import + * // const { S3Client, PutBucketNotificationConfigurationCommand } = require("@aws-sdk/client-s3"); // CommonJS import + * const client = new S3Client(config); + * const command = new PutBucketNotificationConfigurationCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link PutBucketNotificationConfigurationCommandInput} for command's `input` shape. + * @see {@link PutBucketNotificationConfigurationCommandOutput} for command's `response` shape. + * @see {@link S3ClientResolvedConfig | config} for command's `input` shape. + * */ export class PutBucketNotificationConfigurationCommand extends $Command< PutBucketNotificationConfigurationCommandInput, diff --git a/clients/client-s3/commands/PutBucketOwnershipControlsCommand.ts b/clients/client-s3/commands/PutBucketOwnershipControlsCommand.ts index 0eff70f38dfb..965f65e83974 100644 --- a/clients/client-s3/commands/PutBucketOwnershipControlsCommand.ts +++ b/clients/client-s3/commands/PutBucketOwnershipControlsCommand.ts @@ -39,6 +39,20 @@ export interface PutBucketOwnershipControlsCommandOutput extends __MetadataBeare *

* * + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { S3Client, PutBucketOwnershipControlsCommand } from "@aws-sdk/client-s3"; // ES Modules import + * // const { S3Client, PutBucketOwnershipControlsCommand } = require("@aws-sdk/client-s3"); // CommonJS import + * const client = new S3Client(config); + * const command = new PutBucketOwnershipControlsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link PutBucketOwnershipControlsCommandInput} for command's `input` shape. + * @see {@link PutBucketOwnershipControlsCommandOutput} for command's `response` shape. + * @see {@link S3ClientResolvedConfig | config} for command's `input` shape. + * */ export class PutBucketOwnershipControlsCommand extends $Command< PutBucketOwnershipControlsCommandInput, diff --git a/clients/client-s3/commands/PutBucketPolicyCommand.ts b/clients/client-s3/commands/PutBucketPolicyCommand.ts index c81afdc48ee4..880e8be3ec69 100644 --- a/clients/client-s3/commands/PutBucketPolicyCommand.ts +++ b/clients/client-s3/commands/PutBucketPolicyCommand.ts @@ -56,6 +56,20 @@ export interface PutBucketPolicyCommandOutput extends __MetadataBearer {} *

* * + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { S3Client, PutBucketPolicyCommand } from "@aws-sdk/client-s3"; // ES Modules import + * // const { S3Client, PutBucketPolicyCommand } = require("@aws-sdk/client-s3"); // CommonJS import + * const client = new S3Client(config); + * const command = new PutBucketPolicyCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link PutBucketPolicyCommandInput} for command's `input` shape. + * @see {@link PutBucketPolicyCommandOutput} for command's `response` shape. + * @see {@link S3ClientResolvedConfig | config} for command's `input` shape. + * */ export class PutBucketPolicyCommand extends $Command< PutBucketPolicyCommandInput, diff --git a/clients/client-s3/commands/PutBucketReplicationCommand.ts b/clients/client-s3/commands/PutBucketReplicationCommand.ts index d5a7edd857f3..0d3e5b9d51e6 100644 --- a/clients/client-s3/commands/PutBucketReplicationCommand.ts +++ b/clients/client-s3/commands/PutBucketReplicationCommand.ts @@ -87,6 +87,20 @@ export interface PutBucketReplicationCommandOutput extends __MetadataBearer {} *

* * + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { S3Client, PutBucketReplicationCommand } from "@aws-sdk/client-s3"; // ES Modules import + * // const { S3Client, PutBucketReplicationCommand } = require("@aws-sdk/client-s3"); // CommonJS import + * const client = new S3Client(config); + * const command = new PutBucketReplicationCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link PutBucketReplicationCommandInput} for command's `input` shape. + * @see {@link PutBucketReplicationCommandOutput} for command's `response` shape. + * @see {@link S3ClientResolvedConfig | config} for command's `input` shape. + * */ export class PutBucketReplicationCommand extends $Command< PutBucketReplicationCommandInput, diff --git a/clients/client-s3/commands/PutBucketRequestPaymentCommand.ts b/clients/client-s3/commands/PutBucketRequestPaymentCommand.ts index 04b3e3b56fa9..f0a0ff94d276 100644 --- a/clients/client-s3/commands/PutBucketRequestPaymentCommand.ts +++ b/clients/client-s3/commands/PutBucketRequestPaymentCommand.ts @@ -41,6 +41,20 @@ export interface PutBucketRequestPaymentCommandOutput extends __MetadataBearer { *

* * + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { S3Client, PutBucketRequestPaymentCommand } from "@aws-sdk/client-s3"; // ES Modules import + * // const { S3Client, PutBucketRequestPaymentCommand } = require("@aws-sdk/client-s3"); // CommonJS import + * const client = new S3Client(config); + * const command = new PutBucketRequestPaymentCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link PutBucketRequestPaymentCommandInput} for command's `input` shape. + * @see {@link PutBucketRequestPaymentCommandOutput} for command's `response` shape. + * @see {@link S3ClientResolvedConfig | config} for command's `input` shape. + * */ export class PutBucketRequestPaymentCommand extends $Command< PutBucketRequestPaymentCommandInput, diff --git a/clients/client-s3/commands/PutBucketTaggingCommand.ts b/clients/client-s3/commands/PutBucketTaggingCommand.ts index d117df5a2eae..b11d9295dc84 100644 --- a/clients/client-s3/commands/PutBucketTaggingCommand.ts +++ b/clients/client-s3/commands/PutBucketTaggingCommand.ts @@ -101,6 +101,20 @@ export interface PutBucketTaggingCommandOutput extends __MetadataBearer {} *

* * + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { S3Client, PutBucketTaggingCommand } from "@aws-sdk/client-s3"; // ES Modules import + * // const { S3Client, PutBucketTaggingCommand } = require("@aws-sdk/client-s3"); // CommonJS import + * const client = new S3Client(config); + * const command = new PutBucketTaggingCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link PutBucketTaggingCommandInput} for command's `input` shape. + * @see {@link PutBucketTaggingCommandOutput} for command's `response` shape. + * @see {@link S3ClientResolvedConfig | config} for command's `input` shape. + * */ export class PutBucketTaggingCommand extends $Command< PutBucketTaggingCommandInput, diff --git a/clients/client-s3/commands/PutBucketVersioningCommand.ts b/clients/client-s3/commands/PutBucketVersioningCommand.ts index 1256d9bdb8d6..5d82ecc1c3fd 100644 --- a/clients/client-s3/commands/PutBucketVersioningCommand.ts +++ b/clients/client-s3/commands/PutBucketVersioningCommand.ts @@ -71,6 +71,20 @@ export interface PutBucketVersioningCommandOutput extends __MetadataBearer {} *

* * + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { S3Client, PutBucketVersioningCommand } from "@aws-sdk/client-s3"; // ES Modules import + * // const { S3Client, PutBucketVersioningCommand } = require("@aws-sdk/client-s3"); // CommonJS import + * const client = new S3Client(config); + * const command = new PutBucketVersioningCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link PutBucketVersioningCommandInput} for command's `input` shape. + * @see {@link PutBucketVersioningCommandOutput} for command's `response` shape. + * @see {@link S3ClientResolvedConfig | config} for command's `input` shape. + * */ export class PutBucketVersioningCommand extends $Command< PutBucketVersioningCommandInput, diff --git a/clients/client-s3/commands/PutBucketWebsiteCommand.ts b/clients/client-s3/commands/PutBucketWebsiteCommand.ts index 21581fa89e7a..981fd5a6b631 100644 --- a/clients/client-s3/commands/PutBucketWebsiteCommand.ts +++ b/clients/client-s3/commands/PutBucketWebsiteCommand.ts @@ -148,6 +148,20 @@ export interface PutBucketWebsiteCommandOutput extends __MetadataBearer {} *

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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { S3Client, PutBucketWebsiteCommand } from "@aws-sdk/client-s3"; // ES Modules import + * // const { S3Client, PutBucketWebsiteCommand } = require("@aws-sdk/client-s3"); // CommonJS import + * const client = new S3Client(config); + * const command = new PutBucketWebsiteCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link PutBucketWebsiteCommandInput} for command's `input` shape. + * @see {@link PutBucketWebsiteCommandOutput} for command's `response` shape. + * @see {@link S3ClientResolvedConfig | config} for command's `input` shape. + * */ export class PutBucketWebsiteCommand extends $Command< PutBucketWebsiteCommandInput, diff --git a/clients/client-s3/commands/PutObjectAclCommand.ts b/clients/client-s3/commands/PutObjectAclCommand.ts index c2e2fe1ec372..098eb275dc79 100644 --- a/clients/client-s3/commands/PutObjectAclCommand.ts +++ b/clients/client-s3/commands/PutObjectAclCommand.ts @@ -201,6 +201,20 @@ export interface PutObjectAclCommandOutput extends PutObjectAclOutput, __Metadat *

* * + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { S3Client, PutObjectAclCommand } from "@aws-sdk/client-s3"; // ES Modules import + * // const { S3Client, PutObjectAclCommand } = require("@aws-sdk/client-s3"); // CommonJS import + * const client = new S3Client(config); + * const command = new PutObjectAclCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link PutObjectAclCommandInput} for command's `input` shape. + * @see {@link PutObjectAclCommandOutput} for command's `response` shape. + * @see {@link S3ClientResolvedConfig | config} for command's `input` shape. + * */ export class PutObjectAclCommand extends $Command< PutObjectAclCommandInput, diff --git a/clients/client-s3/commands/PutObjectCommand.ts b/clients/client-s3/commands/PutObjectCommand.ts index c96371e6df77..b516ec8c288b 100644 --- a/clients/client-s3/commands/PutObjectCommand.ts +++ b/clients/client-s3/commands/PutObjectCommand.ts @@ -113,6 +113,20 @@ export interface PutObjectCommandOutput extends PutObjectOutput, __MetadataBeare *

* * + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { S3Client, PutObjectCommand } from "@aws-sdk/client-s3"; // ES Modules import + * // const { S3Client, PutObjectCommand } = require("@aws-sdk/client-s3"); // CommonJS import + * const client = new S3Client(config); + * const command = new PutObjectCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link PutObjectCommandInput} for command's `input` shape. + * @see {@link PutObjectCommandOutput} for command's `response` shape. + * @see {@link S3ClientResolvedConfig | config} for command's `input` shape. + * */ export class PutObjectCommand extends $Command { // Start section: command_properties diff --git a/clients/client-s3/commands/PutObjectLegalHoldCommand.ts b/clients/client-s3/commands/PutObjectLegalHoldCommand.ts index 60c16e10a4e0..ba4ed696e91a 100644 --- a/clients/client-s3/commands/PutObjectLegalHoldCommand.ts +++ b/clients/client-s3/commands/PutObjectLegalHoldCommand.ts @@ -26,6 +26,20 @@ export interface PutObjectLegalHoldCommandOutput extends PutObjectLegalHoldOutpu * Locking * Objects.

*

This action is not supported by Amazon S3 on Outposts.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { S3Client, PutObjectLegalHoldCommand } from "@aws-sdk/client-s3"; // ES Modules import + * // const { S3Client, PutObjectLegalHoldCommand } = require("@aws-sdk/client-s3"); // CommonJS import + * const client = new S3Client(config); + * const command = new PutObjectLegalHoldCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link PutObjectLegalHoldCommandInput} for command's `input` shape. + * @see {@link PutObjectLegalHoldCommandOutput} for command's `response` shape. + * @see {@link S3ClientResolvedConfig | config} for command's `input` shape. + * */ export class PutObjectLegalHoldCommand extends $Command< PutObjectLegalHoldCommandInput, diff --git a/clients/client-s3/commands/PutObjectLockConfigurationCommand.ts b/clients/client-s3/commands/PutObjectLockConfigurationCommand.ts index 2dc17ffa5daf..ed0a1ce7ef8d 100644 --- a/clients/client-s3/commands/PutObjectLockConfigurationCommand.ts +++ b/clients/client-s3/commands/PutObjectLockConfigurationCommand.ts @@ -43,6 +43,20 @@ export interface PutObjectLockConfigurationCommandOutput extends PutObjectLockCo * * * + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { S3Client, PutObjectLockConfigurationCommand } from "@aws-sdk/client-s3"; // ES Modules import + * // const { S3Client, PutObjectLockConfigurationCommand } = require("@aws-sdk/client-s3"); // CommonJS import + * const client = new S3Client(config); + * const command = new PutObjectLockConfigurationCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link PutObjectLockConfigurationCommandInput} for command's `input` shape. + * @see {@link PutObjectLockConfigurationCommandOutput} for command's `response` shape. + * @see {@link S3ClientResolvedConfig | config} for command's `input` shape. + * */ export class PutObjectLockConfigurationCommand extends $Command< PutObjectLockConfigurationCommandInput, diff --git a/clients/client-s3/commands/PutObjectRetentionCommand.ts b/clients/client-s3/commands/PutObjectRetentionCommand.ts index b8f37692775d..055310040280 100644 --- a/clients/client-s3/commands/PutObjectRetentionCommand.ts +++ b/clients/client-s3/commands/PutObjectRetentionCommand.ts @@ -25,6 +25,20 @@ export interface PutObjectRetentionCommandOutput extends PutObjectRetentionOutpu *

Places an Object Retention configuration on an object. For more information, see Locking Objects. *

*

This action is not supported by Amazon S3 on Outposts.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { S3Client, PutObjectRetentionCommand } from "@aws-sdk/client-s3"; // ES Modules import + * // const { S3Client, PutObjectRetentionCommand } = require("@aws-sdk/client-s3"); // CommonJS import + * const client = new S3Client(config); + * const command = new PutObjectRetentionCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link PutObjectRetentionCommandInput} for command's `input` shape. + * @see {@link PutObjectRetentionCommandOutput} for command's `response` shape. + * @see {@link S3ClientResolvedConfig | config} for command's `input` shape. + * */ export class PutObjectRetentionCommand extends $Command< PutObjectRetentionCommandInput, diff --git a/clients/client-s3/commands/PutObjectTaggingCommand.ts b/clients/client-s3/commands/PutObjectTaggingCommand.ts index 8bc5612a4e1f..81604bef0ada 100644 --- a/clients/client-s3/commands/PutObjectTaggingCommand.ts +++ b/clients/client-s3/commands/PutObjectTaggingCommand.ts @@ -126,6 +126,20 @@ export interface PutObjectTaggingCommandOutput extends PutObjectTaggingOutput, _ *

* * + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { S3Client, PutObjectTaggingCommand } from "@aws-sdk/client-s3"; // ES Modules import + * // const { S3Client, PutObjectTaggingCommand } = require("@aws-sdk/client-s3"); // CommonJS import + * const client = new S3Client(config); + * const command = new PutObjectTaggingCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link PutObjectTaggingCommandInput} for command's `input` shape. + * @see {@link PutObjectTaggingCommandOutput} for command's `response` shape. + * @see {@link S3ClientResolvedConfig | config} for command's `input` shape. + * */ export class PutObjectTaggingCommand extends $Command< PutObjectTaggingCommandInput, diff --git a/clients/client-s3/commands/PutPublicAccessBlockCommand.ts b/clients/client-s3/commands/PutPublicAccessBlockCommand.ts index ec392bccb3cb..984339c7c472 100644 --- a/clients/client-s3/commands/PutPublicAccessBlockCommand.ts +++ b/clients/client-s3/commands/PutPublicAccessBlockCommand.ts @@ -67,6 +67,20 @@ export interface PutPublicAccessBlockCommandOutput extends __MetadataBearer {} *

* * + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { S3Client, PutPublicAccessBlockCommand } from "@aws-sdk/client-s3"; // ES Modules import + * // const { S3Client, PutPublicAccessBlockCommand } = require("@aws-sdk/client-s3"); // CommonJS import + * const client = new S3Client(config); + * const command = new PutPublicAccessBlockCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link PutPublicAccessBlockCommandInput} for command's `input` shape. + * @see {@link PutPublicAccessBlockCommandOutput} for command's `response` shape. + * @see {@link S3ClientResolvedConfig | config} for command's `input` shape. + * */ export class PutPublicAccessBlockCommand extends $Command< PutPublicAccessBlockCommandInput, diff --git a/clients/client-s3/commands/RestoreObjectCommand.ts b/clients/client-s3/commands/RestoreObjectCommand.ts index 2c965f1cb426..c65c42eaaa40 100644 --- a/clients/client-s3/commands/RestoreObjectCommand.ts +++ b/clients/client-s3/commands/RestoreObjectCommand.ts @@ -315,6 +315,20 @@ export interface RestoreObjectCommandOutput extends RestoreObjectOutput, __Metad *

* * + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { S3Client, RestoreObjectCommand } from "@aws-sdk/client-s3"; // ES Modules import + * // const { S3Client, RestoreObjectCommand } = require("@aws-sdk/client-s3"); // CommonJS import + * const client = new S3Client(config); + * const command = new RestoreObjectCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link RestoreObjectCommandInput} for command's `input` shape. + * @see {@link RestoreObjectCommandOutput} for command's `response` shape. + * @see {@link S3ClientResolvedConfig | config} for command's `input` shape. + * */ export class RestoreObjectCommand extends $Command< RestoreObjectCommandInput, diff --git a/clients/client-s3/commands/SelectObjectContentCommand.ts b/clients/client-s3/commands/SelectObjectContentCommand.ts index 7a75e37fbc08..e2ab55298442 100644 --- a/clients/client-s3/commands/SelectObjectContentCommand.ts +++ b/clients/client-s3/commands/SelectObjectContentCommand.ts @@ -142,6 +142,20 @@ export interface SelectObjectContentCommandOutput extends SelectObjectContentOut *

* * + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { S3Client, SelectObjectContentCommand } from "@aws-sdk/client-s3"; // ES Modules import + * // const { S3Client, SelectObjectContentCommand } = require("@aws-sdk/client-s3"); // CommonJS import + * const client = new S3Client(config); + * const command = new SelectObjectContentCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link SelectObjectContentCommandInput} for command's `input` shape. + * @see {@link SelectObjectContentCommandOutput} for command's `response` shape. + * @see {@link S3ClientResolvedConfig | config} for command's `input` shape. + * */ export class SelectObjectContentCommand extends $Command< SelectObjectContentCommandInput, diff --git a/clients/client-s3/commands/UploadPartCommand.ts b/clients/client-s3/commands/UploadPartCommand.ts index 667463e75b41..2c0a5623dbbd 100644 --- a/clients/client-s3/commands/UploadPartCommand.ts +++ b/clients/client-s3/commands/UploadPartCommand.ts @@ -170,6 +170,20 @@ export interface UploadPartCommandOutput extends UploadPartOutput, __MetadataBea *

* * + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { S3Client, UploadPartCommand } from "@aws-sdk/client-s3"; // ES Modules import + * // const { S3Client, UploadPartCommand } = require("@aws-sdk/client-s3"); // CommonJS import + * const client = new S3Client(config); + * const command = new UploadPartCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link UploadPartCommandInput} for command's `input` shape. + * @see {@link UploadPartCommandOutput} for command's `response` shape. + * @see {@link S3ClientResolvedConfig | config} for command's `input` shape. + * */ export class UploadPartCommand extends $Command< UploadPartCommandInput, diff --git a/clients/client-s3/commands/UploadPartCopyCommand.ts b/clients/client-s3/commands/UploadPartCopyCommand.ts index 26ac137b9f85..4ff2f7133034 100644 --- a/clients/client-s3/commands/UploadPartCopyCommand.ts +++ b/clients/client-s3/commands/UploadPartCopyCommand.ts @@ -203,6 +203,20 @@ export interface UploadPartCopyCommandOutput extends UploadPartCopyOutput, __Met *

* * + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { S3Client, UploadPartCopyCommand } from "@aws-sdk/client-s3"; // ES Modules import + * // const { S3Client, UploadPartCopyCommand } = require("@aws-sdk/client-s3"); // CommonJS import + * const client = new S3Client(config); + * const command = new UploadPartCopyCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link UploadPartCopyCommandInput} for command's `input` shape. + * @see {@link UploadPartCopyCommandOutput} for command's `response` shape. + * @see {@link S3ClientResolvedConfig | config} for command's `input` shape. + * */ export class UploadPartCopyCommand extends $Command< UploadPartCopyCommandInput, diff --git a/clients/client-s3/commands/WriteGetObjectResponseCommand.ts b/clients/client-s3/commands/WriteGetObjectResponseCommand.ts index 9ac6945d503b..28ec4bf082c8 100644 --- a/clients/client-s3/commands/WriteGetObjectResponseCommand.ts +++ b/clients/client-s3/commands/WriteGetObjectResponseCommand.ts @@ -51,6 +51,20 @@ export interface WriteGetObjectResponseCommandOutput extends __MetadataBearer {} *

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 AWS built Lambda functions in the Amazon S3 User Guide.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { S3Client, WriteGetObjectResponseCommand } from "@aws-sdk/client-s3"; // ES Modules import + * // const { S3Client, WriteGetObjectResponseCommand } = require("@aws-sdk/client-s3"); // CommonJS import + * const client = new S3Client(config); + * const command = new WriteGetObjectResponseCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link WriteGetObjectResponseCommandInput} for command's `input` shape. + * @see {@link WriteGetObjectResponseCommandOutput} for command's `response` shape. + * @see {@link S3ClientResolvedConfig | config} for command's `input` shape. + * */ export class WriteGetObjectResponseCommand extends $Command< WriteGetObjectResponseCommandInput, diff --git a/clients/client-s3/models/models_0.ts b/clients/client-s3/models/models_0.ts index 32109b2ac637..ab3cb08f4ae9 100644 --- a/clients/client-s3/models/models_0.ts +++ b/clients/client-s3/models/models_0.ts @@ -17,6 +17,9 @@ export interface AbortIncompleteMultipartUpload { } export namespace AbortIncompleteMultipartUpload { + /** + * @internal + */ export const filterSensitiveLog = (obj: AbortIncompleteMultipartUpload): any => ({ ...obj, }); @@ -33,6 +36,9 @@ export interface AbortMultipartUploadOutput { } export namespace AbortMultipartUploadOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: AbortMultipartUploadOutput): any => ({ ...obj, }); @@ -73,6 +79,9 @@ export interface AbortMultipartUploadRequest { } export namespace AbortMultipartUploadRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: AbortMultipartUploadRequest): any => ({ ...obj, }); @@ -87,6 +96,9 @@ export interface NoSuchUpload extends __SmithyException, $MetadataBearer { } export namespace NoSuchUpload { + /** + * @internal + */ export const filterSensitiveLog = (obj: NoSuchUpload): any => ({ ...obj, }); @@ -107,6 +119,9 @@ export interface AccelerateConfiguration { } export namespace AccelerateConfiguration { + /** + * @internal + */ export const filterSensitiveLog = (obj: AccelerateConfiguration): any => ({ ...obj, }); @@ -175,6 +190,9 @@ export interface Grantee { } export namespace Grantee { + /** + * @internal + */ export const filterSensitiveLog = (obj: Grantee): any => ({ ...obj, }); @@ -198,6 +216,9 @@ export interface Grant { } export namespace Grant { + /** + * @internal + */ export const filterSensitiveLog = (obj: Grant): any => ({ ...obj, }); @@ -219,6 +240,9 @@ export interface Owner { } export namespace Owner { + /** + * @internal + */ export const filterSensitiveLog = (obj: Owner): any => ({ ...obj, }); @@ -240,6 +264,9 @@ export interface AccessControlPolicy { } export namespace AccessControlPolicy { + /** + * @internal + */ export const filterSensitiveLog = (obj: AccessControlPolicy): any => ({ ...obj, }); @@ -259,6 +286,9 @@ export interface AccessControlTranslation { } export namespace AccessControlTranslation { + /** + * @internal + */ export const filterSensitiveLog = (obj: AccessControlTranslation): any => ({ ...obj, }); @@ -332,6 +362,9 @@ export interface CompleteMultipartUploadOutput { } export namespace CompleteMultipartUploadOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: CompleteMultipartUploadOutput): any => ({ ...obj, ...(obj.SSEKMSKeyId && { SSEKMSKeyId: SENSITIVE_STRING }), @@ -355,6 +388,9 @@ export interface CompletedPart { } export namespace CompletedPart { + /** + * @internal + */ export const filterSensitiveLog = (obj: CompletedPart): any => ({ ...obj, }); @@ -371,6 +407,9 @@ export interface CompletedMultipartUpload { } export namespace CompletedMultipartUpload { + /** + * @internal + */ export const filterSensitiveLog = (obj: CompletedMultipartUpload): any => ({ ...obj, }); @@ -412,6 +451,9 @@ export interface CompleteMultipartUploadRequest { } export namespace CompleteMultipartUploadRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: CompleteMultipartUploadRequest): any => ({ ...obj, }); @@ -435,6 +477,9 @@ export interface CopyObjectResult { } export namespace CopyObjectResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: CopyObjectResult): any => ({ ...obj, }); @@ -506,6 +551,9 @@ export interface CopyObjectOutput { } export namespace CopyObjectOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: CopyObjectOutput): any => ({ ...obj, ...(obj.SSEKMSKeyId && { SSEKMSKeyId: SENSITIVE_STRING }), @@ -812,6 +860,9 @@ export interface CopyObjectRequest { } export namespace CopyObjectRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: CopyObjectRequest): any => ({ ...obj, ...(obj.SSECustomerKey && { SSECustomerKey: SENSITIVE_STRING }), @@ -831,6 +882,9 @@ export interface ObjectNotInActiveTierError extends __SmithyException, $Metadata } export namespace ObjectNotInActiveTierError { + /** + * @internal + */ export const filterSensitiveLog = (obj: ObjectNotInActiveTierError): any => ({ ...obj, }); @@ -846,6 +900,9 @@ export interface BucketAlreadyExists extends __SmithyException, $MetadataBearer } export namespace BucketAlreadyExists { + /** + * @internal + */ export const filterSensitiveLog = (obj: BucketAlreadyExists): any => ({ ...obj, }); @@ -863,6 +920,9 @@ export interface BucketAlreadyOwnedByYou extends __SmithyException, $MetadataBea } export namespace BucketAlreadyOwnedByYou { + /** + * @internal + */ export const filterSensitiveLog = (obj: BucketAlreadyOwnedByYou): any => ({ ...obj, }); @@ -878,6 +938,9 @@ export interface CreateBucketOutput { } export namespace CreateBucketOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateBucketOutput): any => ({ ...obj, }); @@ -924,6 +987,9 @@ export interface CreateBucketConfiguration { } export namespace CreateBucketConfiguration { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateBucketConfiguration): any => ({ ...obj, }); @@ -978,6 +1044,9 @@ export interface CreateBucketRequest { } export namespace CreateBucketRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateBucketRequest): any => ({ ...obj, }); @@ -1065,6 +1134,9 @@ export interface CreateMultipartUploadOutput { } export namespace CreateMultipartUploadOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateMultipartUploadOutput): any => ({ ...obj, ...(obj.SSEKMSKeyId && { SSEKMSKeyId: SENSITIVE_STRING }), @@ -1255,6 +1327,9 @@ export interface CreateMultipartUploadRequest { } export namespace CreateMultipartUploadRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateMultipartUploadRequest): any => ({ ...obj, ...(obj.SSECustomerKey && { SSECustomerKey: SENSITIVE_STRING }), @@ -1276,6 +1351,9 @@ export interface DeleteBucketRequest { } export namespace DeleteBucketRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteBucketRequest): any => ({ ...obj, }); @@ -1299,6 +1377,9 @@ export interface DeleteBucketAnalyticsConfigurationRequest { } export namespace DeleteBucketAnalyticsConfigurationRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteBucketAnalyticsConfigurationRequest): any => ({ ...obj, }); @@ -1317,6 +1398,9 @@ export interface DeleteBucketCorsRequest { } export namespace DeleteBucketCorsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteBucketCorsRequest): any => ({ ...obj, }); @@ -1336,6 +1420,9 @@ export interface DeleteBucketEncryptionRequest { } export namespace DeleteBucketEncryptionRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteBucketEncryptionRequest): any => ({ ...obj, }); @@ -1354,6 +1441,9 @@ export interface DeleteBucketIntelligentTieringConfigurationRequest { } export namespace DeleteBucketIntelligentTieringConfigurationRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteBucketIntelligentTieringConfigurationRequest): any => ({ ...obj, }); @@ -1377,6 +1467,9 @@ export interface DeleteBucketInventoryConfigurationRequest { } export namespace DeleteBucketInventoryConfigurationRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteBucketInventoryConfigurationRequest): any => ({ ...obj, }); @@ -1395,6 +1488,9 @@ export interface DeleteBucketLifecycleRequest { } export namespace DeleteBucketLifecycleRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteBucketLifecycleRequest): any => ({ ...obj, }); @@ -1418,6 +1514,9 @@ export interface DeleteBucketMetricsConfigurationRequest { } export namespace DeleteBucketMetricsConfigurationRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteBucketMetricsConfigurationRequest): any => ({ ...obj, }); @@ -1436,6 +1535,9 @@ export interface DeleteBucketOwnershipControlsRequest { } export namespace DeleteBucketOwnershipControlsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteBucketOwnershipControlsRequest): any => ({ ...obj, }); @@ -1454,6 +1556,9 @@ export interface DeleteBucketPolicyRequest { } export namespace DeleteBucketPolicyRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteBucketPolicyRequest): any => ({ ...obj, }); @@ -1472,6 +1577,9 @@ export interface DeleteBucketReplicationRequest { } export namespace DeleteBucketReplicationRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteBucketReplicationRequest): any => ({ ...obj, }); @@ -1490,6 +1598,9 @@ export interface DeleteBucketTaggingRequest { } export namespace DeleteBucketTaggingRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteBucketTaggingRequest): any => ({ ...obj, }); @@ -1508,6 +1619,9 @@ export interface DeleteBucketWebsiteRequest { } export namespace DeleteBucketWebsiteRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteBucketWebsiteRequest): any => ({ ...obj, }); @@ -1534,6 +1648,9 @@ export interface DeleteObjectOutput { } export namespace DeleteObjectOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteObjectOutput): any => ({ ...obj, }); @@ -1585,6 +1702,9 @@ export interface DeleteObjectRequest { } export namespace DeleteObjectRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteObjectRequest): any => ({ ...obj, }); @@ -1620,6 +1740,9 @@ export interface DeletedObject { } export namespace DeletedObject { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeletedObject): any => ({ ...obj, }); @@ -3517,6 +3640,9 @@ export interface _Error { } export namespace _Error { + /** + * @internal + */ export const filterSensitiveLog = (obj: _Error): any => ({ ...obj, }); @@ -3543,6 +3669,9 @@ export interface DeleteObjectsOutput { } export namespace DeleteObjectsOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteObjectsOutput): any => ({ ...obj, }); @@ -3569,6 +3698,9 @@ export interface ObjectIdentifier { } export namespace ObjectIdentifier { + /** + * @internal + */ export const filterSensitiveLog = (obj: ObjectIdentifier): any => ({ ...obj, }); @@ -3591,6 +3723,9 @@ export interface Delete { } export namespace Delete { + /** + * @internal + */ export const filterSensitiveLog = (obj: Delete): any => ({ ...obj, }); @@ -3637,6 +3772,9 @@ export interface DeleteObjectsRequest { } export namespace DeleteObjectsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteObjectsRequest): any => ({ ...obj, }); @@ -3650,6 +3788,9 @@ export interface DeleteObjectTaggingOutput { } export namespace DeleteObjectTaggingOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteObjectTaggingOutput): any => ({ ...obj, }); @@ -3680,6 +3821,9 @@ export interface DeleteObjectTaggingRequest { } export namespace DeleteObjectTaggingRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteObjectTaggingRequest): any => ({ ...obj, }); @@ -3699,6 +3843,9 @@ export interface DeletePublicAccessBlockRequest { } export namespace DeletePublicAccessBlockRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeletePublicAccessBlockRequest): any => ({ ...obj, }); @@ -3712,6 +3859,9 @@ export interface GetBucketAccelerateConfigurationOutput { } export namespace GetBucketAccelerateConfigurationOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetBucketAccelerateConfigurationOutput): any => ({ ...obj, }); @@ -3730,6 +3880,9 @@ export interface GetBucketAccelerateConfigurationRequest { } export namespace GetBucketAccelerateConfigurationRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetBucketAccelerateConfigurationRequest): any => ({ ...obj, }); @@ -3748,6 +3901,9 @@ export interface GetBucketAclOutput { } export namespace GetBucketAclOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetBucketAclOutput): any => ({ ...obj, }); @@ -3766,6 +3922,9 @@ export interface GetBucketAclRequest { } export namespace GetBucketAclRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetBucketAclRequest): any => ({ ...obj, }); @@ -3787,6 +3946,9 @@ export interface Tag { } export namespace Tag { + /** + * @internal + */ export const filterSensitiveLog = (obj: Tag): any => ({ ...obj, }); @@ -3811,6 +3973,9 @@ export interface AnalyticsAndOperator { } export namespace AnalyticsAndOperator { + /** + * @internal + */ export const filterSensitiveLog = (obj: AnalyticsAndOperator): any => ({ ...obj, }); @@ -3880,6 +4045,9 @@ export namespace AnalyticsFilter { return visitor._(value.$unknown[0], value.$unknown[1]); }; + /** + * @internal + */ export const filterSensitiveLog = (obj: AnalyticsFilter): any => { if (obj.Prefix !== undefined) return { Prefix: obj.Prefix }; if (obj.Tag !== undefined) return { Tag: Tag.filterSensitiveLog(obj.Tag) }; @@ -3921,6 +4089,9 @@ export interface AnalyticsS3BucketDestination { } export namespace AnalyticsS3BucketDestination { + /** + * @internal + */ export const filterSensitiveLog = (obj: AnalyticsS3BucketDestination): any => ({ ...obj, }); @@ -3937,6 +4108,9 @@ export interface AnalyticsExportDestination { } export namespace AnalyticsExportDestination { + /** + * @internal + */ export const filterSensitiveLog = (obj: AnalyticsExportDestination): any => ({ ...obj, }); @@ -3962,6 +4136,9 @@ export interface StorageClassAnalysisDataExport { } export namespace StorageClassAnalysisDataExport { + /** + * @internal + */ export const filterSensitiveLog = (obj: StorageClassAnalysisDataExport): any => ({ ...obj, }); @@ -3980,6 +4157,9 @@ export interface StorageClassAnalysis { } export namespace StorageClassAnalysis { + /** + * @internal + */ export const filterSensitiveLog = (obj: StorageClassAnalysis): any => ({ ...obj, }); @@ -4010,6 +4190,9 @@ export interface AnalyticsConfiguration { } export namespace AnalyticsConfiguration { + /** + * @internal + */ export const filterSensitiveLog = (obj: AnalyticsConfiguration): any => ({ ...obj, ...(obj.Filter && { Filter: AnalyticsFilter.filterSensitiveLog(obj.Filter) }), @@ -4024,6 +4207,9 @@ export interface GetBucketAnalyticsConfigurationOutput { } export namespace GetBucketAnalyticsConfigurationOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetBucketAnalyticsConfigurationOutput): any => ({ ...obj, ...(obj.AnalyticsConfiguration && { @@ -4050,6 +4236,9 @@ export interface GetBucketAnalyticsConfigurationRequest { } export namespace GetBucketAnalyticsConfigurationRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetBucketAnalyticsConfigurationRequest): any => ({ ...obj, }); @@ -4097,6 +4286,9 @@ export interface CORSRule { } export namespace CORSRule { + /** + * @internal + */ export const filterSensitiveLog = (obj: CORSRule): any => ({ ...obj, }); @@ -4111,6 +4303,9 @@ export interface GetBucketCorsOutput { } export namespace GetBucketCorsOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetBucketCorsOutput): any => ({ ...obj, }); @@ -4129,6 +4324,9 @@ export interface GetBucketCorsRequest { } export namespace GetBucketCorsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetBucketCorsRequest): any => ({ ...obj, }); @@ -4178,6 +4376,9 @@ export interface ServerSideEncryptionByDefault { } export namespace ServerSideEncryptionByDefault { + /** + * @internal + */ export const filterSensitiveLog = (obj: ServerSideEncryptionByDefault): any => ({ ...obj, ...(obj.KMSMasterKeyID && { KMSMasterKeyID: SENSITIVE_STRING }), @@ -4203,6 +4404,9 @@ export interface ServerSideEncryptionRule { } export namespace ServerSideEncryptionRule { + /** + * @internal + */ export const filterSensitiveLog = (obj: ServerSideEncryptionRule): any => ({ ...obj, ...(obj.ApplyServerSideEncryptionByDefault && { @@ -4225,6 +4429,9 @@ export interface ServerSideEncryptionConfiguration { } export namespace ServerSideEncryptionConfiguration { + /** + * @internal + */ export const filterSensitiveLog = (obj: ServerSideEncryptionConfiguration): any => ({ ...obj, ...(obj.Rules && { Rules: obj.Rules.map((item) => ServerSideEncryptionRule.filterSensitiveLog(item)) }), @@ -4239,6 +4446,9 @@ export interface GetBucketEncryptionOutput { } export namespace GetBucketEncryptionOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetBucketEncryptionOutput): any => ({ ...obj, ...(obj.ServerSideEncryptionConfiguration && { @@ -4263,6 +4473,9 @@ export interface GetBucketEncryptionRequest { } export namespace GetBucketEncryptionRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetBucketEncryptionRequest): any => ({ ...obj, }); @@ -4287,6 +4500,9 @@ export interface IntelligentTieringAndOperator { } export namespace IntelligentTieringAndOperator { + /** + * @internal + */ export const filterSensitiveLog = (obj: IntelligentTieringAndOperator): any => ({ ...obj, }); @@ -4322,6 +4538,9 @@ export interface IntelligentTieringFilter { } export namespace IntelligentTieringFilter { + /** + * @internal + */ export const filterSensitiveLog = (obj: IntelligentTieringFilter): any => ({ ...obj, }); @@ -4354,6 +4573,9 @@ export interface Tiering { } export namespace Tiering { + /** + * @internal + */ export const filterSensitiveLog = (obj: Tiering): any => ({ ...obj, }); @@ -4388,6 +4610,9 @@ export interface IntelligentTieringConfiguration { } export namespace IntelligentTieringConfiguration { + /** + * @internal + */ export const filterSensitiveLog = (obj: IntelligentTieringConfiguration): any => ({ ...obj, }); @@ -4401,6 +4626,9 @@ export interface GetBucketIntelligentTieringConfigurationOutput { } export namespace GetBucketIntelligentTieringConfigurationOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetBucketIntelligentTieringConfigurationOutput): any => ({ ...obj, }); @@ -4419,6 +4647,9 @@ export interface GetBucketIntelligentTieringConfigurationRequest { } export namespace GetBucketIntelligentTieringConfigurationRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetBucketIntelligentTieringConfigurationRequest): any => ({ ...obj, }); @@ -4436,6 +4667,9 @@ export interface SSEKMS { } export namespace SSEKMS { + /** + * @internal + */ export const filterSensitiveLog = (obj: SSEKMS): any => ({ ...obj, ...(obj.KeyId && { KeyId: SENSITIVE_STRING }), @@ -4448,6 +4682,9 @@ export namespace SSEKMS { export interface SSES3 {} export namespace SSES3 { + /** + * @internal + */ export const filterSensitiveLog = (obj: SSES3): any => ({ ...obj, }); @@ -4470,6 +4707,9 @@ export interface InventoryEncryption { } export namespace InventoryEncryption { + /** + * @internal + */ export const filterSensitiveLog = (obj: InventoryEncryption): any => ({ ...obj, ...(obj.SSEKMS && { SSEKMS: SSEKMS.filterSensitiveLog(obj.SSEKMS) }), @@ -4517,6 +4757,9 @@ export interface InventoryS3BucketDestination { } export namespace InventoryS3BucketDestination { + /** + * @internal + */ export const filterSensitiveLog = (obj: InventoryS3BucketDestination): any => ({ ...obj, ...(obj.Encryption && { Encryption: InventoryEncryption.filterSensitiveLog(obj.Encryption) }), @@ -4535,6 +4778,9 @@ export interface InventoryDestination { } export namespace InventoryDestination { + /** + * @internal + */ export const filterSensitiveLog = (obj: InventoryDestination): any => ({ ...obj, ...(obj.S3BucketDestination && { @@ -4555,6 +4801,9 @@ export interface InventoryFilter { } export namespace InventoryFilter { + /** + * @internal + */ export const filterSensitiveLog = (obj: InventoryFilter): any => ({ ...obj, }); @@ -4588,6 +4837,9 @@ export interface InventorySchedule { } export namespace InventorySchedule { + /** + * @internal + */ export const filterSensitiveLog = (obj: InventorySchedule): any => ({ ...obj, }); @@ -4643,6 +4895,9 @@ export interface InventoryConfiguration { } export namespace InventoryConfiguration { + /** + * @internal + */ export const filterSensitiveLog = (obj: InventoryConfiguration): any => ({ ...obj, ...(obj.Destination && { Destination: InventoryDestination.filterSensitiveLog(obj.Destination) }), @@ -4657,6 +4912,9 @@ export interface GetBucketInventoryConfigurationOutput { } export namespace GetBucketInventoryConfigurationOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetBucketInventoryConfigurationOutput): any => ({ ...obj, ...(obj.InventoryConfiguration && { @@ -4683,6 +4941,9 @@ export interface GetBucketInventoryConfigurationRequest { } export namespace GetBucketInventoryConfigurationRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetBucketInventoryConfigurationRequest): any => ({ ...obj, }); @@ -4713,6 +4974,9 @@ export interface LifecycleExpiration { } export namespace LifecycleExpiration { + /** + * @internal + */ export const filterSensitiveLog = (obj: LifecycleExpiration): any => ({ ...obj, }); @@ -4737,6 +5001,9 @@ export interface LifecycleRuleAndOperator { } export namespace LifecycleRuleAndOperator { + /** + * @internal + */ export const filterSensitiveLog = (obj: LifecycleRuleAndOperator): any => ({ ...obj, }); @@ -4812,6 +5079,9 @@ export namespace LifecycleRuleFilter { return visitor._(value.$unknown[0], value.$unknown[1]); }; + /** + * @internal + */ export const filterSensitiveLog = (obj: LifecycleRuleFilter): any => { if (obj.Prefix !== undefined) return { Prefix: obj.Prefix }; if (obj.Tag !== undefined) return { Tag: Tag.filterSensitiveLog(obj.Tag) }; @@ -4837,6 +5107,9 @@ export interface NoncurrentVersionExpiration { } export namespace NoncurrentVersionExpiration { + /** + * @internal + */ export const filterSensitiveLog = (obj: NoncurrentVersionExpiration): any => ({ ...obj, }); @@ -4870,6 +5143,9 @@ export interface NoncurrentVersionTransition { } export namespace NoncurrentVersionTransition { + /** + * @internal + */ export const filterSensitiveLog = (obj: NoncurrentVersionTransition): any => ({ ...obj, }); @@ -4902,6 +5178,9 @@ export interface Transition { } export namespace Transition { + /** + * @internal + */ export const filterSensitiveLog = (obj: Transition): any => ({ ...obj, }); @@ -4981,6 +5260,9 @@ export interface LifecycleRule { } export namespace LifecycleRule { + /** + * @internal + */ export const filterSensitiveLog = (obj: LifecycleRule): any => ({ ...obj, ...(obj.Filter && { Filter: LifecycleRuleFilter.filterSensitiveLog(obj.Filter) }), @@ -4995,6 +5277,9 @@ export interface GetBucketLifecycleConfigurationOutput { } export namespace GetBucketLifecycleConfigurationOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetBucketLifecycleConfigurationOutput): any => ({ ...obj, ...(obj.Rules && { Rules: obj.Rules.map((item) => LifecycleRule.filterSensitiveLog(item)) }), @@ -5014,6 +5299,9 @@ export interface GetBucketLifecycleConfigurationRequest { } export namespace GetBucketLifecycleConfigurationRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetBucketLifecycleConfigurationRequest): any => ({ ...obj, }); @@ -5030,6 +5318,9 @@ export interface GetBucketLocationOutput { } export namespace GetBucketLocationOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetBucketLocationOutput): any => ({ ...obj, }); @@ -5048,6 +5339,9 @@ export interface GetBucketLocationRequest { } export namespace GetBucketLocationRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetBucketLocationRequest): any => ({ ...obj, }); @@ -5071,6 +5365,9 @@ export interface TargetGrant { } export namespace TargetGrant { + /** + * @internal + */ export const filterSensitiveLog = (obj: TargetGrant): any => ({ ...obj, }); @@ -5105,6 +5402,9 @@ export interface LoggingEnabled { } export namespace LoggingEnabled { + /** + * @internal + */ export const filterSensitiveLog = (obj: LoggingEnabled): any => ({ ...obj, }); @@ -5120,6 +5420,9 @@ export interface GetBucketLoggingOutput { } export namespace GetBucketLoggingOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetBucketLoggingOutput): any => ({ ...obj, }); @@ -5138,6 +5441,9 @@ export interface GetBucketLoggingRequest { } export namespace GetBucketLoggingRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetBucketLoggingRequest): any => ({ ...obj, }); @@ -5161,6 +5467,9 @@ export interface MetricsAndOperator { } export namespace MetricsAndOperator { + /** + * @internal + */ export const filterSensitiveLog = (obj: MetricsAndOperator): any => ({ ...obj, }); @@ -5231,6 +5540,9 @@ export namespace MetricsFilter { return visitor._(value.$unknown[0], value.$unknown[1]); }; + /** + * @internal + */ export const filterSensitiveLog = (obj: MetricsFilter): any => { if (obj.Prefix !== undefined) return { Prefix: obj.Prefix }; if (obj.Tag !== undefined) return { Tag: Tag.filterSensitiveLog(obj.Tag) }; @@ -5262,6 +5574,9 @@ export interface MetricsConfiguration { } export namespace MetricsConfiguration { + /** + * @internal + */ export const filterSensitiveLog = (obj: MetricsConfiguration): any => ({ ...obj, ...(obj.Filter && { Filter: MetricsFilter.filterSensitiveLog(obj.Filter) }), @@ -5276,6 +5591,9 @@ export interface GetBucketMetricsConfigurationOutput { } export namespace GetBucketMetricsConfigurationOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetBucketMetricsConfigurationOutput): any => ({ ...obj, ...(obj.MetricsConfiguration && { @@ -5302,6 +5620,9 @@ export interface GetBucketMetricsConfigurationRequest { } export namespace GetBucketMetricsConfigurationRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetBucketMetricsConfigurationRequest): any => ({ ...obj, }); @@ -5320,6 +5641,9 @@ export interface GetBucketNotificationConfigurationRequest { } export namespace GetBucketNotificationConfigurationRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetBucketNotificationConfigurationRequest): any => ({ ...obj, }); @@ -5366,6 +5690,9 @@ export interface FilterRule { } export namespace FilterRule { + /** + * @internal + */ export const filterSensitiveLog = (obj: FilterRule): any => ({ ...obj, }); @@ -5383,6 +5710,9 @@ export interface S3KeyFilter { } export namespace S3KeyFilter { + /** + * @internal + */ export const filterSensitiveLog = (obj: S3KeyFilter): any => ({ ...obj, }); @@ -5401,6 +5731,9 @@ export interface NotificationConfigurationFilter { } export namespace NotificationConfigurationFilter { + /** + * @internal + */ export const filterSensitiveLog = (obj: NotificationConfigurationFilter): any => ({ ...obj, }); @@ -5438,6 +5771,9 @@ export interface LambdaFunctionConfiguration { } export namespace LambdaFunctionConfiguration { + /** + * @internal + */ export const filterSensitiveLog = (obj: LambdaFunctionConfiguration): any => ({ ...obj, }); @@ -5474,6 +5810,9 @@ export interface QueueConfiguration { } export namespace QueueConfiguration { + /** + * @internal + */ export const filterSensitiveLog = (obj: QueueConfiguration): any => ({ ...obj, }); @@ -5512,6 +5851,9 @@ export interface TopicConfiguration { } export namespace TopicConfiguration { + /** + * @internal + */ export const filterSensitiveLog = (obj: TopicConfiguration): any => ({ ...obj, }); @@ -5542,6 +5884,9 @@ export interface NotificationConfiguration { } export namespace NotificationConfiguration { + /** + * @internal + */ export const filterSensitiveLog = (obj: NotificationConfiguration): any => ({ ...obj, }); @@ -5565,6 +5910,9 @@ export interface OwnershipControlsRule { } export namespace OwnershipControlsRule { + /** + * @internal + */ export const filterSensitiveLog = (obj: OwnershipControlsRule): any => ({ ...obj, }); @@ -5581,6 +5929,9 @@ export interface OwnershipControls { } export namespace OwnershipControls { + /** + * @internal + */ export const filterSensitiveLog = (obj: OwnershipControls): any => ({ ...obj, }); @@ -5595,6 +5946,9 @@ export interface GetBucketOwnershipControlsOutput { } export namespace GetBucketOwnershipControlsOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetBucketOwnershipControlsOutput): any => ({ ...obj, }); @@ -5614,6 +5968,9 @@ export interface GetBucketOwnershipControlsRequest { } export namespace GetBucketOwnershipControlsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetBucketOwnershipControlsRequest): any => ({ ...obj, }); @@ -5627,6 +5984,9 @@ export interface GetBucketPolicyOutput { } export namespace GetBucketPolicyOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetBucketPolicyOutput): any => ({ ...obj, }); @@ -5645,6 +6005,9 @@ export interface GetBucketPolicyRequest { } export namespace GetBucketPolicyRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetBucketPolicyRequest): any => ({ ...obj, }); @@ -5662,6 +6025,9 @@ export interface PolicyStatus { } export namespace PolicyStatus { + /** + * @internal + */ export const filterSensitiveLog = (obj: PolicyStatus): any => ({ ...obj, }); @@ -5675,6 +6041,9 @@ export interface GetBucketPolicyStatusOutput { } export namespace GetBucketPolicyStatusOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetBucketPolicyStatusOutput): any => ({ ...obj, }); @@ -5693,6 +6062,9 @@ export interface GetBucketPolicyStatusRequest { } export namespace GetBucketPolicyStatusRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetBucketPolicyStatusRequest): any => ({ ...obj, }); @@ -5725,6 +6097,9 @@ export interface DeleteMarkerReplication { } export namespace DeleteMarkerReplication { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteMarkerReplication): any => ({ ...obj, }); @@ -5747,6 +6122,9 @@ export interface EncryptionConfiguration { } export namespace EncryptionConfiguration { + /** + * @internal + */ export const filterSensitiveLog = (obj: EncryptionConfiguration): any => ({ ...obj, }); @@ -5765,6 +6143,9 @@ export interface ReplicationTimeValue { } export namespace ReplicationTimeValue { + /** + * @internal + */ export const filterSensitiveLog = (obj: ReplicationTimeValue): any => ({ ...obj, }); @@ -5790,6 +6171,9 @@ export interface Metrics { } export namespace Metrics { + /** + * @internal + */ export const filterSensitiveLog = (obj: Metrics): any => ({ ...obj, }); @@ -5816,6 +6200,9 @@ export interface ReplicationTime { } export namespace ReplicationTime { + /** + * @internal + */ export const filterSensitiveLog = (obj: ReplicationTime): any => ({ ...obj, }); @@ -5880,6 +6267,9 @@ export interface Destination { } export namespace Destination { + /** + * @internal + */ export const filterSensitiveLog = (obj: Destination): any => ({ ...obj, }); @@ -5900,6 +6290,9 @@ export interface ExistingObjectReplication { } export namespace ExistingObjectReplication { + /** + * @internal + */ export const filterSensitiveLog = (obj: ExistingObjectReplication): any => ({ ...obj, }); @@ -5934,6 +6327,9 @@ export interface ReplicationRuleAndOperator { } export namespace ReplicationRuleAndOperator { + /** + * @internal + */ export const filterSensitiveLog = (obj: ReplicationRuleAndOperator): any => ({ ...obj, }); @@ -6021,6 +6417,9 @@ export namespace ReplicationRuleFilter { return visitor._(value.$unknown[0], value.$unknown[1]); }; + /** + * @internal + */ export const filterSensitiveLog = (obj: ReplicationRuleFilter): any => { if (obj.Prefix !== undefined) return { Prefix: obj.Prefix }; if (obj.Tag !== undefined) return { Tag: Tag.filterSensitiveLog(obj.Tag) }; @@ -6050,6 +6449,9 @@ export interface ReplicaModifications { } export namespace ReplicaModifications { + /** + * @internal + */ export const filterSensitiveLog = (obj: ReplicaModifications): any => ({ ...obj, }); @@ -6070,6 +6472,9 @@ export interface SseKmsEncryptedObjects { } export namespace SseKmsEncryptedObjects { + /** + * @internal + */ export const filterSensitiveLog = (obj: SseKmsEncryptedObjects): any => ({ ...obj, }); @@ -6105,6 +6510,9 @@ export interface SourceSelectionCriteria { } export namespace SourceSelectionCriteria { + /** + * @internal + */ export const filterSensitiveLog = (obj: SourceSelectionCriteria): any => ({ ...obj, }); @@ -6196,6 +6604,9 @@ export interface ReplicationRule { } export namespace ReplicationRule { + /** + * @internal + */ export const filterSensitiveLog = (obj: ReplicationRule): any => ({ ...obj, ...(obj.Filter && { Filter: ReplicationRuleFilter.filterSensitiveLog(obj.Filter) }), @@ -6222,6 +6633,9 @@ export interface ReplicationConfiguration { } export namespace ReplicationConfiguration { + /** + * @internal + */ export const filterSensitiveLog = (obj: ReplicationConfiguration): any => ({ ...obj, ...(obj.Rules && { Rules: obj.Rules.map((item) => ReplicationRule.filterSensitiveLog(item)) }), @@ -6237,6 +6651,9 @@ export interface GetBucketReplicationOutput { } export namespace GetBucketReplicationOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetBucketReplicationOutput): any => ({ ...obj, ...(obj.ReplicationConfiguration && { @@ -6258,6 +6675,9 @@ export interface GetBucketReplicationRequest { } export namespace GetBucketReplicationRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetBucketReplicationRequest): any => ({ ...obj, }); @@ -6273,6 +6693,9 @@ export interface GetBucketRequestPaymentOutput { } export namespace GetBucketRequestPaymentOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetBucketRequestPaymentOutput): any => ({ ...obj, }); @@ -6291,6 +6714,9 @@ export interface GetBucketRequestPaymentRequest { } export namespace GetBucketRequestPaymentRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetBucketRequestPaymentRequest): any => ({ ...obj, }); @@ -6304,6 +6730,9 @@ export interface GetBucketTaggingOutput { } export namespace GetBucketTaggingOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetBucketTaggingOutput): any => ({ ...obj, }); @@ -6322,6 +6751,9 @@ export interface GetBucketTaggingRequest { } export namespace GetBucketTaggingRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetBucketTaggingRequest): any => ({ ...obj, }); @@ -6346,6 +6778,9 @@ export interface GetBucketVersioningOutput { } export namespace GetBucketVersioningOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetBucketVersioningOutput): any => ({ ...obj, }); @@ -6364,6 +6799,9 @@ export interface GetBucketVersioningRequest { } export namespace GetBucketVersioningRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetBucketVersioningRequest): any => ({ ...obj, }); @@ -6385,6 +6823,9 @@ export interface ErrorDocument { } export namespace ErrorDocument { + /** + * @internal + */ export const filterSensitiveLog = (obj: ErrorDocument): any => ({ ...obj, }); @@ -6409,6 +6850,9 @@ export interface IndexDocument { } export namespace IndexDocument { + /** + * @internal + */ export const filterSensitiveLog = (obj: IndexDocument): any => ({ ...obj, }); @@ -6434,6 +6878,9 @@ export interface RedirectAllRequestsTo { } export namespace RedirectAllRequestsTo { + /** + * @internal + */ export const filterSensitiveLog = (obj: RedirectAllRequestsTo): any => ({ ...obj, }); @@ -6474,6 +6921,9 @@ export interface Condition { } export namespace Condition { + /** + * @internal + */ export const filterSensitiveLog = (obj: Condition): any => ({ ...obj, }); @@ -6530,6 +6980,9 @@ export interface Redirect { } export namespace Redirect { + /** + * @internal + */ export const filterSensitiveLog = (obj: Redirect): any => ({ ...obj, }); @@ -6558,6 +7011,9 @@ export interface RoutingRule { } export namespace RoutingRule { + /** + * @internal + */ export const filterSensitiveLog = (obj: RoutingRule): any => ({ ...obj, }); @@ -6588,6 +7044,9 @@ export interface GetBucketWebsiteOutput { } export namespace GetBucketWebsiteOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetBucketWebsiteOutput): any => ({ ...obj, }); @@ -6606,6 +7065,9 @@ export interface GetBucketWebsiteRequest { } export namespace GetBucketWebsiteRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetBucketWebsiteRequest): any => ({ ...obj, }); @@ -6797,6 +7259,9 @@ export interface GetObjectOutput { } export namespace GetObjectOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetObjectOutput): any => ({ ...obj, ...(obj.SSEKMSKeyId && { SSEKMSKeyId: SENSITIVE_STRING }), @@ -6928,6 +7393,9 @@ export interface GetObjectRequest { } export namespace GetObjectRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetObjectRequest): any => ({ ...obj, ...(obj.SSECustomerKey && { SSECustomerKey: SENSITIVE_STRING }), @@ -6945,6 +7413,9 @@ export interface InvalidObjectState extends __SmithyException, $MetadataBearer { } export namespace InvalidObjectState { + /** + * @internal + */ export const filterSensitiveLog = (obj: InvalidObjectState): any => ({ ...obj, }); @@ -6959,6 +7430,9 @@ export interface NoSuchKey extends __SmithyException, $MetadataBearer { } export namespace NoSuchKey { + /** + * @internal + */ export const filterSensitiveLog = (obj: NoSuchKey): any => ({ ...obj, }); @@ -6983,6 +7457,9 @@ export interface GetObjectAclOutput { } export namespace GetObjectAclOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetObjectAclOutput): any => ({ ...obj, }); @@ -7020,6 +7497,9 @@ export interface GetObjectAclRequest { } export namespace GetObjectAclRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetObjectAclRequest): any => ({ ...obj, }); @@ -7036,6 +7516,9 @@ export interface ObjectLockLegalHold { } export namespace ObjectLockLegalHold { + /** + * @internal + */ export const filterSensitiveLog = (obj: ObjectLockLegalHold): any => ({ ...obj, }); @@ -7049,6 +7532,9 @@ export interface GetObjectLegalHoldOutput { } export namespace GetObjectLegalHoldOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetObjectLegalHoldOutput): any => ({ ...obj, }); @@ -7086,6 +7572,9 @@ export interface GetObjectLegalHoldRequest { } export namespace GetObjectLegalHoldRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetObjectLegalHoldRequest): any => ({ ...obj, }); @@ -7133,6 +7622,9 @@ export interface DefaultRetention { } export namespace DefaultRetention { + /** + * @internal + */ export const filterSensitiveLog = (obj: DefaultRetention): any => ({ ...obj, }); @@ -7152,6 +7644,9 @@ export interface ObjectLockRule { } export namespace ObjectLockRule { + /** + * @internal + */ export const filterSensitiveLog = (obj: ObjectLockRule): any => ({ ...obj, }); @@ -7178,6 +7673,9 @@ export interface ObjectLockConfiguration { } export namespace ObjectLockConfiguration { + /** + * @internal + */ export const filterSensitiveLog = (obj: ObjectLockConfiguration): any => ({ ...obj, }); @@ -7191,6 +7689,9 @@ export interface GetObjectLockConfigurationOutput { } export namespace GetObjectLockConfigurationOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetObjectLockConfigurationOutput): any => ({ ...obj, }); @@ -7210,6 +7711,9 @@ export interface GetObjectLockConfigurationRequest { } export namespace GetObjectLockConfigurationRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetObjectLockConfigurationRequest): any => ({ ...obj, }); @@ -7231,6 +7735,9 @@ export interface ObjectLockRetention { } export namespace ObjectLockRetention { + /** + * @internal + */ export const filterSensitiveLog = (obj: ObjectLockRetention): any => ({ ...obj, }); @@ -7244,6 +7751,9 @@ export interface GetObjectRetentionOutput { } export namespace GetObjectRetentionOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetObjectRetentionOutput): any => ({ ...obj, }); @@ -7281,6 +7791,9 @@ export interface GetObjectRetentionRequest { } export namespace GetObjectRetentionRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetObjectRetentionRequest): any => ({ ...obj, }); @@ -7299,6 +7812,9 @@ export interface GetObjectTaggingOutput { } export namespace GetObjectTaggingOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetObjectTaggingOutput): any => ({ ...obj, }); @@ -7337,6 +7853,9 @@ export interface GetObjectTaggingRequest { } export namespace GetObjectTaggingRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetObjectTaggingRequest): any => ({ ...obj, }); @@ -7356,6 +7875,9 @@ export interface GetObjectTorrentOutput { } export namespace GetObjectTorrentOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetObjectTorrentOutput): any => ({ ...obj, }); @@ -7387,6 +7909,9 @@ export interface GetObjectTorrentRequest { } export namespace GetObjectTorrentRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetObjectTorrentRequest): any => ({ ...obj, }); @@ -7448,6 +7973,9 @@ export interface PublicAccessBlockConfiguration { } export namespace PublicAccessBlockConfiguration { + /** + * @internal + */ export const filterSensitiveLog = (obj: PublicAccessBlockConfiguration): any => ({ ...obj, }); @@ -7462,6 +7990,9 @@ export interface GetPublicAccessBlockOutput { } export namespace GetPublicAccessBlockOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetPublicAccessBlockOutput): any => ({ ...obj, }); @@ -7481,6 +8012,9 @@ export interface GetPublicAccessBlockRequest { } export namespace GetPublicAccessBlockRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetPublicAccessBlockRequest): any => ({ ...obj, }); @@ -7501,6 +8035,9 @@ export interface HeadBucketRequest { } export namespace HeadBucketRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: HeadBucketRequest): any => ({ ...obj, }); @@ -7515,6 +8052,9 @@ export interface NotFound extends __SmithyException, $MetadataBearer { } export namespace NotFound { + /** + * @internal + */ export const filterSensitiveLog = (obj: NotFound): any => ({ ...obj, }); @@ -7756,6 +8296,9 @@ export interface HeadObjectOutput { } export namespace HeadObjectOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: HeadObjectOutput): any => ({ ...obj, ...(obj.SSEKMSKeyId && { SSEKMSKeyId: SENSITIVE_STRING }), @@ -7857,6 +8400,9 @@ export interface HeadObjectRequest { } export namespace HeadObjectRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: HeadObjectRequest): any => ({ ...obj, ...(obj.SSECustomerKey && { SSECustomerKey: SENSITIVE_STRING }), @@ -7893,6 +8439,9 @@ export interface ListBucketAnalyticsConfigurationsOutput { } export namespace ListBucketAnalyticsConfigurationsOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListBucketAnalyticsConfigurationsOutput): any => ({ ...obj, ...(obj.AnalyticsConfigurationList && { @@ -7922,6 +8471,9 @@ export interface ListBucketAnalyticsConfigurationsRequest { } export namespace ListBucketAnalyticsConfigurationsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListBucketAnalyticsConfigurationsRequest): any => ({ ...obj, }); @@ -7955,6 +8507,9 @@ export interface ListBucketIntelligentTieringConfigurationsOutput { } export namespace ListBucketIntelligentTieringConfigurationsOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListBucketIntelligentTieringConfigurationsOutput): any => ({ ...obj, }); @@ -7974,6 +8529,9 @@ export interface ListBucketIntelligentTieringConfigurationsRequest { } export namespace ListBucketIntelligentTieringConfigurationsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListBucketIntelligentTieringConfigurationsRequest): any => ({ ...obj, }); @@ -8007,6 +8565,9 @@ export interface ListBucketInventoryConfigurationsOutput { } export namespace ListBucketInventoryConfigurationsOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListBucketInventoryConfigurationsOutput): any => ({ ...obj, ...(obj.InventoryConfigurationList && { @@ -8037,6 +8598,9 @@ export interface ListBucketInventoryConfigurationsRequest { } export namespace ListBucketInventoryConfigurationsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListBucketInventoryConfigurationsRequest): any => ({ ...obj, }); @@ -8071,6 +8635,9 @@ export interface ListBucketMetricsConfigurationsOutput { } export namespace ListBucketMetricsConfigurationsOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListBucketMetricsConfigurationsOutput): any => ({ ...obj, ...(obj.MetricsConfigurationList && { @@ -8102,6 +8669,9 @@ export interface ListBucketMetricsConfigurationsRequest { } export namespace ListBucketMetricsConfigurationsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListBucketMetricsConfigurationsRequest): any => ({ ...obj, }); @@ -8124,6 +8694,9 @@ export interface Bucket { } export namespace Bucket { + /** + * @internal + */ export const filterSensitiveLog = (obj: Bucket): any => ({ ...obj, }); @@ -8142,6 +8715,9 @@ export interface ListBucketsOutput { } export namespace ListBucketsOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListBucketsOutput): any => ({ ...obj, }); @@ -8161,6 +8737,9 @@ export interface CommonPrefix { } export namespace CommonPrefix { + /** + * @internal + */ export const filterSensitiveLog = (obj: CommonPrefix): any => ({ ...obj, }); @@ -8185,6 +8764,9 @@ export interface Initiator { } export namespace Initiator { + /** + * @internal + */ export const filterSensitiveLog = (obj: Initiator): any => ({ ...obj, }); @@ -8226,6 +8808,9 @@ export interface MultipartUpload { } export namespace MultipartUpload { + /** + * @internal + */ export const filterSensitiveLog = (obj: MultipartUpload): any => ({ ...obj, }); @@ -8311,6 +8896,9 @@ export interface ListMultipartUploadsOutput { } export namespace ListMultipartUploadsOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListMultipartUploadsOutput): any => ({ ...obj, }); @@ -8386,6 +8974,9 @@ export interface ListMultipartUploadsRequest { } export namespace ListMultipartUploadsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListMultipartUploadsRequest): any => ({ ...obj, }); @@ -8457,6 +9048,9 @@ export interface _Object { } export namespace _Object { + /** + * @internal + */ export const filterSensitiveLog = (obj: _Object): any => ({ ...obj, }); @@ -8539,6 +9133,9 @@ export interface ListObjectsOutput { } export namespace ListObjectsOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListObjectsOutput): any => ({ ...obj, }); @@ -8596,6 +9193,9 @@ export interface ListObjectsRequest { } export namespace ListObjectsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListObjectsRequest): any => ({ ...obj, }); @@ -8610,6 +9210,9 @@ export interface NoSuchBucket extends __SmithyException, $MetadataBearer { } export namespace NoSuchBucket { + /** + * @internal + */ export const filterSensitiveLog = (obj: NoSuchBucket): any => ({ ...obj, }); @@ -8717,6 +9320,9 @@ export interface ListObjectsV2Output { } export namespace ListObjectsV2Output { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListObjectsV2Output): any => ({ ...obj, }); @@ -8784,6 +9390,9 @@ export interface ListObjectsV2Request { } export namespace ListObjectsV2Request { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListObjectsV2Request): any => ({ ...obj, }); @@ -8821,6 +9430,9 @@ export interface DeleteMarkerEntry { } export namespace DeleteMarkerEntry { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteMarkerEntry): any => ({ ...obj, }); @@ -8875,6 +9487,9 @@ export interface ObjectVersion { } export namespace ObjectVersion { + /** + * @internal + */ export const filterSensitiveLog = (obj: ObjectVersion): any => ({ ...obj, }); @@ -8968,6 +9583,9 @@ export interface ListObjectVersionsOutput { } export namespace ListObjectVersionsOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListObjectVersionsOutput): any => ({ ...obj, }); @@ -9032,6 +9650,9 @@ export interface ListObjectVersionsRequest { } export namespace ListObjectVersionsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListObjectVersionsRequest): any => ({ ...obj, }); @@ -9064,6 +9685,9 @@ export interface Part { } export namespace Part { + /** + * @internal + */ export const filterSensitiveLog = (obj: Part): any => ({ ...obj, }); @@ -9165,6 +9789,9 @@ export interface ListPartsOutput { } export namespace ListPartsOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListPartsOutput): any => ({ ...obj, }); @@ -9214,6 +9841,9 @@ export interface ListPartsRequest { } export namespace ListPartsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListPartsRequest): any => ({ ...obj, }); @@ -9237,6 +9867,9 @@ export interface PutBucketAccelerateConfigurationRequest { } export namespace PutBucketAccelerateConfigurationRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: PutBucketAccelerateConfigurationRequest): any => ({ ...obj, }); @@ -9301,6 +9934,9 @@ export interface PutBucketAclRequest { } export namespace PutBucketAclRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: PutBucketAclRequest): any => ({ ...obj, }); @@ -9329,6 +9965,9 @@ export interface PutBucketAnalyticsConfigurationRequest { } export namespace PutBucketAnalyticsConfigurationRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: PutBucketAnalyticsConfigurationRequest): any => ({ ...obj, ...(obj.AnalyticsConfiguration && { @@ -9351,6 +9990,9 @@ export interface CORSConfiguration { } export namespace CORSConfiguration { + /** + * @internal + */ export const filterSensitiveLog = (obj: CORSConfiguration): any => ({ ...obj, }); @@ -9386,6 +10028,9 @@ export interface PutBucketCorsRequest { } export namespace PutBucketCorsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: PutBucketCorsRequest): any => ({ ...obj, }); @@ -9418,6 +10063,9 @@ export interface PutBucketEncryptionRequest { } export namespace PutBucketEncryptionRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: PutBucketEncryptionRequest): any => ({ ...obj, ...(obj.ServerSideEncryptionConfiguration && { @@ -9446,6 +10094,9 @@ export interface PutBucketIntelligentTieringConfigurationRequest { } export namespace PutBucketIntelligentTieringConfigurationRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: PutBucketIntelligentTieringConfigurationRequest): any => ({ ...obj, }); @@ -9474,6 +10125,9 @@ export interface PutBucketInventoryConfigurationRequest { } export namespace PutBucketInventoryConfigurationRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: PutBucketInventoryConfigurationRequest): any => ({ ...obj, ...(obj.InventoryConfiguration && { @@ -9495,6 +10149,9 @@ export interface BucketLifecycleConfiguration { } export namespace BucketLifecycleConfiguration { + /** + * @internal + */ export const filterSensitiveLog = (obj: BucketLifecycleConfiguration): any => ({ ...obj, ...(obj.Rules && { Rules: obj.Rules.map((item) => LifecycleRule.filterSensitiveLog(item)) }), @@ -9519,6 +10176,9 @@ export interface PutBucketLifecycleConfigurationRequest { } export namespace PutBucketLifecycleConfigurationRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: PutBucketLifecycleConfigurationRequest): any => ({ ...obj, ...(obj.LifecycleConfiguration && { @@ -9540,6 +10200,9 @@ export interface BucketLoggingStatus { } export namespace BucketLoggingStatus { + /** + * @internal + */ export const filterSensitiveLog = (obj: BucketLoggingStatus): any => ({ ...obj, }); @@ -9569,6 +10232,9 @@ export interface PutBucketLoggingRequest { } export namespace PutBucketLoggingRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: PutBucketLoggingRequest): any => ({ ...obj, }); @@ -9597,6 +10263,9 @@ export interface PutBucketMetricsConfigurationRequest { } export namespace PutBucketMetricsConfigurationRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: PutBucketMetricsConfigurationRequest): any => ({ ...obj, ...(obj.MetricsConfiguration && { @@ -9624,6 +10293,9 @@ export interface PutBucketNotificationConfigurationRequest { } export namespace PutBucketNotificationConfigurationRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: PutBucketNotificationConfigurationRequest): any => ({ ...obj, }); @@ -9654,6 +10326,9 @@ export interface PutBucketOwnershipControlsRequest { } export namespace PutBucketOwnershipControlsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: PutBucketOwnershipControlsRequest): any => ({ ...obj, }); @@ -9689,6 +10364,9 @@ export interface PutBucketPolicyRequest { } export namespace PutBucketPolicyRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: PutBucketPolicyRequest): any => ({ ...obj, }); @@ -9726,6 +10404,9 @@ export interface PutBucketReplicationRequest { } export namespace PutBucketReplicationRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: PutBucketReplicationRequest): any => ({ ...obj, ...(obj.ReplicationConfiguration && { @@ -9745,6 +10426,9 @@ export interface RequestPaymentConfiguration { } export namespace RequestPaymentConfiguration { + /** + * @internal + */ export const filterSensitiveLog = (obj: RequestPaymentConfiguration): any => ({ ...obj, }); @@ -9777,6 +10461,9 @@ export interface PutBucketRequestPaymentRequest { } export namespace PutBucketRequestPaymentRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: PutBucketRequestPaymentRequest): any => ({ ...obj, }); @@ -9793,6 +10480,9 @@ export interface Tagging { } export namespace Tagging { + /** + * @internal + */ export const filterSensitiveLog = (obj: Tagging): any => ({ ...obj, }); @@ -9824,6 +10514,9 @@ export interface PutBucketTaggingRequest { } export namespace PutBucketTaggingRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: PutBucketTaggingRequest): any => ({ ...obj, }); @@ -9850,6 +10543,9 @@ export interface VersioningConfiguration { } export namespace VersioningConfiguration { + /** + * @internal + */ export const filterSensitiveLog = (obj: VersioningConfiguration): any => ({ ...obj, }); @@ -9888,6 +10584,9 @@ export interface PutBucketVersioningRequest { } export namespace PutBucketVersioningRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: PutBucketVersioningRequest): any => ({ ...obj, }); @@ -9922,6 +10621,9 @@ export interface WebsiteConfiguration { } export namespace WebsiteConfiguration { + /** + * @internal + */ export const filterSensitiveLog = (obj: WebsiteConfiguration): any => ({ ...obj, }); @@ -9953,6 +10655,9 @@ export interface PutBucketWebsiteRequest { } export namespace PutBucketWebsiteRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: PutBucketWebsiteRequest): any => ({ ...obj, }); @@ -10024,6 +10729,9 @@ export interface PutObjectOutput { } export namespace PutObjectOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: PutObjectOutput): any => ({ ...obj, ...(obj.SSEKMSKeyId && { SSEKMSKeyId: SENSITIVE_STRING }), @@ -10263,6 +10971,9 @@ export interface PutObjectRequest { } export namespace PutObjectRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: PutObjectRequest): any => ({ ...obj, ...(obj.SSECustomerKey && { SSECustomerKey: SENSITIVE_STRING }), @@ -10280,6 +10991,9 @@ export interface PutObjectAclOutput { } export namespace PutObjectAclOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: PutObjectAclOutput): any => ({ ...obj, }); @@ -10371,6 +11085,9 @@ export interface PutObjectAclRequest { } export namespace PutObjectAclRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: PutObjectAclRequest): any => ({ ...obj, }); @@ -10385,6 +11102,9 @@ export interface PutObjectLegalHoldOutput { } export namespace PutObjectLegalHoldOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: PutObjectLegalHoldOutput): any => ({ ...obj, }); @@ -10434,6 +11154,9 @@ export interface PutObjectLegalHoldRequest { } export namespace PutObjectLegalHoldRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: PutObjectLegalHoldRequest): any => ({ ...obj, }); @@ -10448,6 +11171,9 @@ export interface PutObjectLockConfigurationOutput { } export namespace PutObjectLockConfigurationOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: PutObjectLockConfigurationOutput): any => ({ ...obj, }); @@ -10490,6 +11216,9 @@ export interface PutObjectLockConfigurationRequest { } export namespace PutObjectLockConfigurationRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: PutObjectLockConfigurationRequest): any => ({ ...obj, }); @@ -10504,6 +11233,9 @@ export interface PutObjectRetentionOutput { } export namespace PutObjectRetentionOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: PutObjectRetentionOutput): any => ({ ...obj, }); @@ -10560,6 +11292,9 @@ export interface PutObjectRetentionRequest { } export namespace PutObjectRetentionRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: PutObjectRetentionRequest): any => ({ ...obj, }); @@ -10573,6 +11308,9 @@ export interface PutObjectTaggingOutput { } export namespace PutObjectTaggingOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: PutObjectTaggingOutput): any => ({ ...obj, }); @@ -10622,6 +11360,9 @@ export interface PutObjectTaggingRequest { } export namespace PutObjectTaggingRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: PutObjectTaggingRequest): any => ({ ...obj, }); @@ -10654,6 +11395,9 @@ export interface PutPublicAccessBlockRequest { } export namespace PutPublicAccessBlockRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: PutPublicAccessBlockRequest): any => ({ ...obj, }); @@ -10668,6 +11412,9 @@ export interface ObjectAlreadyInActiveTierError extends __SmithyException, $Meta } export namespace ObjectAlreadyInActiveTierError { + /** + * @internal + */ export const filterSensitiveLog = (obj: ObjectAlreadyInActiveTierError): any => ({ ...obj, }); @@ -10688,6 +11435,9 @@ export interface RestoreObjectOutput { } export namespace RestoreObjectOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: RestoreObjectOutput): any => ({ ...obj, }); @@ -10706,6 +11456,9 @@ export interface GlacierJobParameters { } export namespace GlacierJobParameters { + /** + * @internal + */ export const filterSensitiveLog = (obj: GlacierJobParameters): any => ({ ...obj, }); diff --git a/clients/client-s3/models/models_1.ts b/clients/client-s3/models/models_1.ts index 0f6c7e17fd41..4847811e7b01 100644 --- a/clients/client-s3/models/models_1.ts +++ b/clients/client-s3/models/models_1.ts @@ -42,6 +42,9 @@ export interface Encryption { } export namespace Encryption { + /** + * @internal + */ export const filterSensitiveLog = (obj: Encryption): any => ({ ...obj, ...(obj.KMSKeyId && { KMSKeyId: SENSITIVE_STRING }), @@ -64,6 +67,9 @@ export interface MetadataEntry { } export namespace MetadataEntry { + /** + * @internal + */ export const filterSensitiveLog = (obj: MetadataEntry): any => ({ ...obj, }); @@ -115,6 +121,9 @@ export interface S3Location { } export namespace S3Location { + /** + * @internal + */ export const filterSensitiveLog = (obj: S3Location): any => ({ ...obj, ...(obj.Encryption && { Encryption: Encryption.filterSensitiveLog(obj.Encryption) }), @@ -132,6 +141,9 @@ export interface OutputLocation { } export namespace OutputLocation { + /** + * @internal + */ export const filterSensitiveLog = (obj: OutputLocation): any => ({ ...obj, ...(obj.S3 && { S3: S3Location.filterSensitiveLog(obj.S3) }), @@ -221,6 +233,9 @@ export interface CSVInput { } export namespace CSVInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: CSVInput): any => ({ ...obj, }); @@ -242,6 +257,9 @@ export interface JSONInput { } export namespace JSONInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: JSONInput): any => ({ ...obj, }); @@ -253,6 +271,9 @@ export namespace JSONInput { export interface ParquetInput {} export namespace ParquetInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: ParquetInput): any => ({ ...obj, }); @@ -285,6 +306,9 @@ export interface InputSerialization { } export namespace InputSerialization { + /** + * @internal + */ export const filterSensitiveLog = (obj: InputSerialization): any => ({ ...obj, }); @@ -342,6 +366,9 @@ export interface CSVOutput { } export namespace CSVOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: CSVOutput): any => ({ ...obj, }); @@ -359,6 +386,9 @@ export interface JSONOutput { } export namespace JSONOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: JSONOutput): any => ({ ...obj, }); @@ -380,6 +410,9 @@ export interface OutputSerialization { } export namespace OutputSerialization { + /** + * @internal + */ export const filterSensitiveLog = (obj: OutputSerialization): any => ({ ...obj, }); @@ -411,6 +444,9 @@ export interface SelectParameters { } export namespace SelectParameters { + /** + * @internal + */ export const filterSensitiveLog = (obj: SelectParameters): any => ({ ...obj, }); @@ -465,6 +501,9 @@ export interface RestoreRequest { } export namespace RestoreRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: RestoreRequest): any => ({ ...obj, ...(obj.OutputLocation && { OutputLocation: OutputLocation.filterSensitiveLog(obj.OutputLocation) }), @@ -509,6 +548,9 @@ export interface RestoreObjectRequest { } export namespace RestoreObjectRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: RestoreObjectRequest): any => ({ ...obj, ...(obj.RestoreRequest && { RestoreRequest: RestoreRequest.filterSensitiveLog(obj.RestoreRequest) }), @@ -521,6 +563,9 @@ export namespace RestoreObjectRequest { export interface ContinuationEvent {} export namespace ContinuationEvent { + /** + * @internal + */ export const filterSensitiveLog = (obj: ContinuationEvent): any => ({ ...obj, }); @@ -534,6 +579,9 @@ export namespace ContinuationEvent { export interface EndEvent {} export namespace EndEvent { + /** + * @internal + */ export const filterSensitiveLog = (obj: EndEvent): any => ({ ...obj, }); @@ -560,6 +608,9 @@ export interface Progress { } export namespace Progress { + /** + * @internal + */ export const filterSensitiveLog = (obj: Progress): any => ({ ...obj, }); @@ -576,6 +627,9 @@ export interface ProgressEvent { } export namespace ProgressEvent { + /** + * @internal + */ export const filterSensitiveLog = (obj: ProgressEvent): any => ({ ...obj, }); @@ -592,6 +646,9 @@ export interface RecordsEvent { } export namespace RecordsEvent { + /** + * @internal + */ export const filterSensitiveLog = (obj: RecordsEvent): any => ({ ...obj, }); @@ -618,6 +675,9 @@ export interface Stats { } export namespace Stats { + /** + * @internal + */ export const filterSensitiveLog = (obj: Stats): any => ({ ...obj, }); @@ -634,6 +694,9 @@ export interface StatsEvent { } export namespace StatsEvent { + /** + * @internal + */ export const filterSensitiveLog = (obj: StatsEvent): any => ({ ...obj, }); @@ -738,6 +801,9 @@ export namespace SelectObjectContentEventStream { return visitor._(value.$unknown[0], value.$unknown[1]); }; + /** + * @internal + */ export const filterSensitiveLog = (obj: SelectObjectContentEventStream): any => { if (obj.Records !== undefined) return { Records: RecordsEvent.filterSensitiveLog(obj.Records) }; if (obj.Stats !== undefined) return { Stats: StatsEvent.filterSensitiveLog(obj.Stats) }; @@ -756,6 +822,9 @@ export interface SelectObjectContentOutput { } export namespace SelectObjectContentOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: SelectObjectContentOutput): any => ({ ...obj, ...(obj.Payload && { Payload: "STREAMING_CONTENT" }), @@ -775,6 +844,9 @@ export interface RequestProgress { } export namespace RequestProgress { + /** + * @internal + */ export const filterSensitiveLog = (obj: RequestProgress): any => ({ ...obj, }); @@ -808,6 +880,9 @@ export interface ScanRange { } export namespace ScanRange { + /** + * @internal + */ export const filterSensitiveLog = (obj: ScanRange): any => ({ ...obj, }); @@ -909,6 +984,9 @@ export interface SelectObjectContentRequest { } export namespace SelectObjectContentRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: SelectObjectContentRequest): any => ({ ...obj, ...(obj.SSECustomerKey && { SSECustomerKey: SENSITIVE_STRING }), @@ -959,6 +1037,9 @@ export interface UploadPartOutput { } export namespace UploadPartOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: UploadPartOutput): any => ({ ...obj, ...(obj.SSEKMSKeyId && { SSEKMSKeyId: SENSITIVE_STRING }), @@ -1044,6 +1125,9 @@ export interface UploadPartRequest { } export namespace UploadPartRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: UploadPartRequest): any => ({ ...obj, ...(obj.SSECustomerKey && { SSECustomerKey: SENSITIVE_STRING }), @@ -1066,6 +1150,9 @@ export interface CopyPartResult { } export namespace CopyPartResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: CopyPartResult): any => ({ ...obj, }); @@ -1121,6 +1208,9 @@ export interface UploadPartCopyOutput { } export namespace UploadPartCopyOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: UploadPartCopyOutput): any => ({ ...obj, ...(obj.SSEKMSKeyId && { SSEKMSKeyId: SENSITIVE_STRING }), @@ -1270,6 +1360,9 @@ export interface UploadPartCopyRequest { } export namespace UploadPartCopyRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: UploadPartCopyRequest): any => ({ ...obj, ...(obj.SSECustomerKey && { SSECustomerKey: SENSITIVE_STRING }), @@ -1558,6 +1651,9 @@ export interface WriteGetObjectResponseRequest { } export namespace WriteGetObjectResponseRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: WriteGetObjectResponseRequest): any => ({ ...obj, ...(obj.SSEKMSKeyId && { SSEKMSKeyId: SENSITIVE_STRING }), diff --git a/clients/client-s3outposts/commands/CreateEndpointCommand.ts b/clients/client-s3outposts/commands/CreateEndpointCommand.ts index 0ccdb5bfa48d..4c6bb788c92d 100644 --- a/clients/client-s3outposts/commands/CreateEndpointCommand.ts +++ b/clients/client-s3outposts/commands/CreateEndpointCommand.ts @@ -39,6 +39,20 @@ export interface CreateEndpointCommandOutput extends CreateEndpointResult, __Met *

* * + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { S3OutpostsClient, CreateEndpointCommand } from "@aws-sdk/client-s3outposts"; // ES Modules import + * // const { S3OutpostsClient, CreateEndpointCommand } = require("@aws-sdk/client-s3outposts"); // CommonJS import + * const client = new S3OutpostsClient(config); + * const command = new CreateEndpointCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreateEndpointCommandInput} for command's `input` shape. + * @see {@link CreateEndpointCommandOutput} for command's `response` shape. + * @see {@link S3OutpostsClientResolvedConfig | config} for command's `input` shape. + * */ export class CreateEndpointCommand extends $Command< CreateEndpointCommandInput, diff --git a/clients/client-s3outposts/commands/DeleteEndpointCommand.ts b/clients/client-s3outposts/commands/DeleteEndpointCommand.ts index 0da59741d55a..60abc844a181 100644 --- a/clients/client-s3outposts/commands/DeleteEndpointCommand.ts +++ b/clients/client-s3outposts/commands/DeleteEndpointCommand.ts @@ -40,6 +40,20 @@ export interface DeleteEndpointCommandOutput extends __MetadataBearer {} *

* * + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { S3OutpostsClient, DeleteEndpointCommand } from "@aws-sdk/client-s3outposts"; // ES Modules import + * // const { S3OutpostsClient, DeleteEndpointCommand } = require("@aws-sdk/client-s3outposts"); // CommonJS import + * const client = new S3OutpostsClient(config); + * const command = new DeleteEndpointCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteEndpointCommandInput} for command's `input` shape. + * @see {@link DeleteEndpointCommandOutput} for command's `response` shape. + * @see {@link S3OutpostsClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteEndpointCommand extends $Command< DeleteEndpointCommandInput, diff --git a/clients/client-s3outposts/commands/ListEndpointsCommand.ts b/clients/client-s3outposts/commands/ListEndpointsCommand.ts index f5f3b6b58e55..1e5e41969101 100644 --- a/clients/client-s3outposts/commands/ListEndpointsCommand.ts +++ b/clients/client-s3outposts/commands/ListEndpointsCommand.ts @@ -40,6 +40,20 @@ export interface ListEndpointsCommandOutput extends ListEndpointsResult, __Metad *

* * + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { S3OutpostsClient, ListEndpointsCommand } from "@aws-sdk/client-s3outposts"; // ES Modules import + * // const { S3OutpostsClient, ListEndpointsCommand } = require("@aws-sdk/client-s3outposts"); // CommonJS import + * const client = new S3OutpostsClient(config); + * const command = new ListEndpointsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListEndpointsCommandInput} for command's `input` shape. + * @see {@link ListEndpointsCommandOutput} for command's `response` shape. + * @see {@link S3OutpostsClientResolvedConfig | config} for command's `input` shape. + * */ export class ListEndpointsCommand extends $Command< ListEndpointsCommandInput, diff --git a/clients/client-s3outposts/models/models_0.ts b/clients/client-s3outposts/models/models_0.ts index f864da35eb60..485ddb587826 100644 --- a/clients/client-s3outposts/models/models_0.ts +++ b/clients/client-s3outposts/models/models_0.ts @@ -11,6 +11,9 @@ export interface AccessDeniedException extends __SmithyException, $MetadataBeare } export namespace AccessDeniedException { + /** + * @internal + */ export const filterSensitiveLog = (obj: AccessDeniedException): any => ({ ...obj, }); @@ -26,6 +29,9 @@ export interface ConflictException extends __SmithyException, $MetadataBearer { } export namespace ConflictException { + /** + * @internal + */ export const filterSensitiveLog = (obj: ConflictException): any => ({ ...obj, }); @@ -49,6 +55,9 @@ export interface CreateEndpointRequest { } export namespace CreateEndpointRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateEndpointRequest): any => ({ ...obj, }); @@ -62,6 +71,9 @@ export interface CreateEndpointResult { } export namespace CreateEndpointResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateEndpointResult): any => ({ ...obj, }); @@ -77,6 +89,9 @@ export interface InternalServerException extends __SmithyException, $MetadataBea } export namespace InternalServerException { + /** + * @internal + */ export const filterSensitiveLog = (obj: InternalServerException): any => ({ ...obj, }); @@ -92,6 +107,9 @@ export interface ResourceNotFoundException extends __SmithyException, $MetadataB } export namespace ResourceNotFoundException { + /** + * @internal + */ export const filterSensitiveLog = (obj: ResourceNotFoundException): any => ({ ...obj, }); @@ -107,6 +125,9 @@ export interface ValidationException extends __SmithyException, $MetadataBearer } export namespace ValidationException { + /** + * @internal + */ export const filterSensitiveLog = (obj: ValidationException): any => ({ ...obj, }); @@ -125,6 +146,9 @@ export interface DeleteEndpointRequest { } export namespace DeleteEndpointRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteEndpointRequest): any => ({ ...obj, }); @@ -141,6 +165,9 @@ export interface NetworkInterface { } export namespace NetworkInterface { + /** + * @internal + */ export const filterSensitiveLog = (obj: NetworkInterface): any => ({ ...obj, }); @@ -189,6 +216,9 @@ export interface Endpoint { } export namespace Endpoint { + /** + * @internal + */ export const filterSensitiveLog = (obj: Endpoint): any => ({ ...obj, }); @@ -207,6 +237,9 @@ export interface ListEndpointsRequest { } export namespace ListEndpointsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListEndpointsRequest): any => ({ ...obj, }); @@ -225,6 +258,9 @@ export interface ListEndpointsResult { } export namespace ListEndpointsResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListEndpointsResult): any => ({ ...obj, }); diff --git a/clients/client-sagemaker-a2i-runtime/commands/DeleteHumanLoopCommand.ts b/clients/client-sagemaker-a2i-runtime/commands/DeleteHumanLoopCommand.ts index a104aef76ebe..b2159540619a 100644 --- a/clients/client-sagemaker-a2i-runtime/commands/DeleteHumanLoopCommand.ts +++ b/clients/client-sagemaker-a2i-runtime/commands/DeleteHumanLoopCommand.ts @@ -26,6 +26,20 @@ export interface DeleteHumanLoopCommandOutput extends DeleteHumanLoopResponse, _ /** *

Deletes the specified human loop for a flow definition.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { SageMakerA2IRuntimeClient, DeleteHumanLoopCommand } from "@aws-sdk/client-sagemaker-a2i-runtime"; // ES Modules import + * // const { SageMakerA2IRuntimeClient, DeleteHumanLoopCommand } = require("@aws-sdk/client-sagemaker-a2i-runtime"); // CommonJS import + * const client = new SageMakerA2IRuntimeClient(config); + * const command = new DeleteHumanLoopCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteHumanLoopCommandInput} for command's `input` shape. + * @see {@link DeleteHumanLoopCommandOutput} for command's `response` shape. + * @see {@link SageMakerA2IRuntimeClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteHumanLoopCommand extends $Command< DeleteHumanLoopCommandInput, diff --git a/clients/client-sagemaker-a2i-runtime/commands/DescribeHumanLoopCommand.ts b/clients/client-sagemaker-a2i-runtime/commands/DescribeHumanLoopCommand.ts index 749a656fa3ce..060c4f9db8cd 100644 --- a/clients/client-sagemaker-a2i-runtime/commands/DescribeHumanLoopCommand.ts +++ b/clients/client-sagemaker-a2i-runtime/commands/DescribeHumanLoopCommand.ts @@ -26,6 +26,20 @@ export interface DescribeHumanLoopCommandOutput extends DescribeHumanLoopRespons /** *

Returns information about the specified human loop.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { SageMakerA2IRuntimeClient, DescribeHumanLoopCommand } from "@aws-sdk/client-sagemaker-a2i-runtime"; // ES Modules import + * // const { SageMakerA2IRuntimeClient, DescribeHumanLoopCommand } = require("@aws-sdk/client-sagemaker-a2i-runtime"); // CommonJS import + * const client = new SageMakerA2IRuntimeClient(config); + * const command = new DescribeHumanLoopCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeHumanLoopCommandInput} for command's `input` shape. + * @see {@link DescribeHumanLoopCommandOutput} for command's `response` shape. + * @see {@link SageMakerA2IRuntimeClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeHumanLoopCommand extends $Command< DescribeHumanLoopCommandInput, diff --git a/clients/client-sagemaker-a2i-runtime/commands/ListHumanLoopsCommand.ts b/clients/client-sagemaker-a2i-runtime/commands/ListHumanLoopsCommand.ts index 3e392d3644c3..11b517672a4c 100644 --- a/clients/client-sagemaker-a2i-runtime/commands/ListHumanLoopsCommand.ts +++ b/clients/client-sagemaker-a2i-runtime/commands/ListHumanLoopsCommand.ts @@ -26,6 +26,20 @@ export interface ListHumanLoopsCommandOutput extends ListHumanLoopsResponse, __M /** *

Returns information about human loops, given the specified parameters. If a human loop was deleted, it will not be included.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { SageMakerA2IRuntimeClient, ListHumanLoopsCommand } from "@aws-sdk/client-sagemaker-a2i-runtime"; // ES Modules import + * // const { SageMakerA2IRuntimeClient, ListHumanLoopsCommand } = require("@aws-sdk/client-sagemaker-a2i-runtime"); // CommonJS import + * const client = new SageMakerA2IRuntimeClient(config); + * const command = new ListHumanLoopsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListHumanLoopsCommandInput} for command's `input` shape. + * @see {@link ListHumanLoopsCommandOutput} for command's `response` shape. + * @see {@link SageMakerA2IRuntimeClientResolvedConfig | config} for command's `input` shape. + * */ export class ListHumanLoopsCommand extends $Command< ListHumanLoopsCommandInput, diff --git a/clients/client-sagemaker-a2i-runtime/commands/StartHumanLoopCommand.ts b/clients/client-sagemaker-a2i-runtime/commands/StartHumanLoopCommand.ts index d327a7ce8c84..c33acce4f368 100644 --- a/clients/client-sagemaker-a2i-runtime/commands/StartHumanLoopCommand.ts +++ b/clients/client-sagemaker-a2i-runtime/commands/StartHumanLoopCommand.ts @@ -26,6 +26,20 @@ export interface StartHumanLoopCommandOutput extends StartHumanLoopResponse, __M /** *

Starts a human loop, provided that at least one activation condition is met.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { SageMakerA2IRuntimeClient, StartHumanLoopCommand } from "@aws-sdk/client-sagemaker-a2i-runtime"; // ES Modules import + * // const { SageMakerA2IRuntimeClient, StartHumanLoopCommand } = require("@aws-sdk/client-sagemaker-a2i-runtime"); // CommonJS import + * const client = new SageMakerA2IRuntimeClient(config); + * const command = new StartHumanLoopCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link StartHumanLoopCommandInput} for command's `input` shape. + * @see {@link StartHumanLoopCommandOutput} for command's `response` shape. + * @see {@link SageMakerA2IRuntimeClientResolvedConfig | config} for command's `input` shape. + * */ export class StartHumanLoopCommand extends $Command< StartHumanLoopCommandInput, diff --git a/clients/client-sagemaker-a2i-runtime/commands/StopHumanLoopCommand.ts b/clients/client-sagemaker-a2i-runtime/commands/StopHumanLoopCommand.ts index f84c29a3c34b..3253e92b5479 100644 --- a/clients/client-sagemaker-a2i-runtime/commands/StopHumanLoopCommand.ts +++ b/clients/client-sagemaker-a2i-runtime/commands/StopHumanLoopCommand.ts @@ -26,6 +26,20 @@ export interface StopHumanLoopCommandOutput extends StopHumanLoopResponse, __Met /** *

Stops the specified human loop.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { SageMakerA2IRuntimeClient, StopHumanLoopCommand } from "@aws-sdk/client-sagemaker-a2i-runtime"; // ES Modules import + * // const { SageMakerA2IRuntimeClient, StopHumanLoopCommand } = require("@aws-sdk/client-sagemaker-a2i-runtime"); // CommonJS import + * const client = new SageMakerA2IRuntimeClient(config); + * const command = new StopHumanLoopCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link StopHumanLoopCommandInput} for command's `input` shape. + * @see {@link StopHumanLoopCommandOutput} for command's `response` shape. + * @see {@link SageMakerA2IRuntimeClientResolvedConfig | config} for command's `input` shape. + * */ export class StopHumanLoopCommand extends $Command< StopHumanLoopCommandInput, diff --git a/clients/client-sagemaker-a2i-runtime/models/models_0.ts b/clients/client-sagemaker-a2i-runtime/models/models_0.ts index 16b0d65d820f..2ed390394a2a 100644 --- a/clients/client-sagemaker-a2i-runtime/models/models_0.ts +++ b/clients/client-sagemaker-a2i-runtime/models/models_0.ts @@ -9,6 +9,9 @@ export interface DeleteHumanLoopRequest { } export namespace DeleteHumanLoopRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteHumanLoopRequest): any => ({ ...obj, }); @@ -17,6 +20,9 @@ export namespace DeleteHumanLoopRequest { export interface DeleteHumanLoopResponse {} export namespace DeleteHumanLoopResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteHumanLoopResponse): any => ({ ...obj, }); @@ -33,6 +39,9 @@ export interface InternalServerException extends __SmithyException, $MetadataBea } export namespace InternalServerException { + /** + * @internal + */ export const filterSensitiveLog = (obj: InternalServerException): any => ({ ...obj, }); @@ -50,6 +59,9 @@ export interface ResourceNotFoundException extends __SmithyException, $MetadataB } export namespace ResourceNotFoundException { + /** + * @internal + */ export const filterSensitiveLog = (obj: ResourceNotFoundException): any => ({ ...obj, }); @@ -67,6 +79,9 @@ export interface ThrottlingException extends __SmithyException, $MetadataBearer } export namespace ThrottlingException { + /** + * @internal + */ export const filterSensitiveLog = (obj: ThrottlingException): any => ({ ...obj, }); @@ -83,6 +98,9 @@ export interface ValidationException extends __SmithyException, $MetadataBearer } export namespace ValidationException { + /** + * @internal + */ export const filterSensitiveLog = (obj: ValidationException): any => ({ ...obj, }); @@ -96,6 +114,9 @@ export interface DescribeHumanLoopRequest { } export namespace DescribeHumanLoopRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeHumanLoopRequest): any => ({ ...obj, }); @@ -112,6 +133,9 @@ export interface HumanLoopOutput { } export namespace HumanLoopOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: HumanLoopOutput): any => ({ ...obj, }); @@ -172,6 +196,9 @@ export interface DescribeHumanLoopResponse { } export namespace DescribeHumanLoopResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeHumanLoopResponse): any => ({ ...obj, }); @@ -218,6 +245,9 @@ export interface ListHumanLoopsRequest { } export namespace ListHumanLoopsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListHumanLoopsRequest): any => ({ ...obj, }); @@ -256,6 +286,9 @@ export interface HumanLoopSummary { } export namespace HumanLoopSummary { + /** + * @internal + */ export const filterSensitiveLog = (obj: HumanLoopSummary): any => ({ ...obj, }); @@ -274,6 +307,9 @@ export interface ListHumanLoopsResponse { } export namespace ListHumanLoopsResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListHumanLoopsResponse): any => ({ ...obj, }); @@ -290,6 +326,9 @@ export interface ConflictException extends __SmithyException, $MetadataBearer { } export namespace ConflictException { + /** + * @internal + */ export const filterSensitiveLog = (obj: ConflictException): any => ({ ...obj, }); @@ -309,6 +348,9 @@ export interface ServiceQuotaExceededException extends __SmithyException, $Metad } export namespace ServiceQuotaExceededException { + /** + * @internal + */ export const filterSensitiveLog = (obj: ServiceQuotaExceededException): any => ({ ...obj, }); @@ -331,6 +373,9 @@ export interface HumanLoopDataAttributes { } export namespace HumanLoopDataAttributes { + /** + * @internal + */ export const filterSensitiveLog = (obj: HumanLoopDataAttributes): any => ({ ...obj, }); @@ -347,6 +392,9 @@ export interface HumanLoopInput { } export namespace HumanLoopInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: HumanLoopInput): any => ({ ...obj, }); @@ -377,6 +425,9 @@ export interface StartHumanLoopRequest { } export namespace StartHumanLoopRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: StartHumanLoopRequest): any => ({ ...obj, }); @@ -390,6 +441,9 @@ export interface StartHumanLoopResponse { } export namespace StartHumanLoopResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: StartHumanLoopResponse): any => ({ ...obj, }); @@ -403,6 +457,9 @@ export interface StopHumanLoopRequest { } export namespace StopHumanLoopRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: StopHumanLoopRequest): any => ({ ...obj, }); @@ -411,6 +468,9 @@ export namespace StopHumanLoopRequest { export interface StopHumanLoopResponse {} export namespace StopHumanLoopResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: StopHumanLoopResponse): any => ({ ...obj, }); diff --git a/clients/client-sagemaker-edge/commands/GetDeviceRegistrationCommand.ts b/clients/client-sagemaker-edge/commands/GetDeviceRegistrationCommand.ts index b823b5aaa886..8d045d351a39 100644 --- a/clients/client-sagemaker-edge/commands/GetDeviceRegistrationCommand.ts +++ b/clients/client-sagemaker-edge/commands/GetDeviceRegistrationCommand.ts @@ -22,6 +22,20 @@ export interface GetDeviceRegistrationCommandOutput extends GetDeviceRegistratio /** *

Use to check if a device is registered with SageMaker Edge Manager.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { SagemakerEdgeClient, GetDeviceRegistrationCommand } from "@aws-sdk/client-sagemaker-edge"; // ES Modules import + * // const { SagemakerEdgeClient, GetDeviceRegistrationCommand } = require("@aws-sdk/client-sagemaker-edge"); // CommonJS import + * const client = new SagemakerEdgeClient(config); + * const command = new GetDeviceRegistrationCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetDeviceRegistrationCommandInput} for command's `input` shape. + * @see {@link GetDeviceRegistrationCommandOutput} for command's `response` shape. + * @see {@link SagemakerEdgeClientResolvedConfig | config} for command's `input` shape. + * */ export class GetDeviceRegistrationCommand extends $Command< GetDeviceRegistrationCommandInput, diff --git a/clients/client-sagemaker-edge/commands/SendHeartbeatCommand.ts b/clients/client-sagemaker-edge/commands/SendHeartbeatCommand.ts index e9d1679435dc..1b16223a7e23 100644 --- a/clients/client-sagemaker-edge/commands/SendHeartbeatCommand.ts +++ b/clients/client-sagemaker-edge/commands/SendHeartbeatCommand.ts @@ -22,6 +22,20 @@ export interface SendHeartbeatCommandOutput extends __MetadataBearer {} /** *

Use to get the current status of devices registered on SageMaker Edge Manager.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { SagemakerEdgeClient, SendHeartbeatCommand } from "@aws-sdk/client-sagemaker-edge"; // ES Modules import + * // const { SagemakerEdgeClient, SendHeartbeatCommand } = require("@aws-sdk/client-sagemaker-edge"); // CommonJS import + * const client = new SagemakerEdgeClient(config); + * const command = new SendHeartbeatCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link SendHeartbeatCommandInput} for command's `input` shape. + * @see {@link SendHeartbeatCommandOutput} for command's `response` shape. + * @see {@link SagemakerEdgeClientResolvedConfig | config} for command's `input` shape. + * */ export class SendHeartbeatCommand extends $Command< SendHeartbeatCommandInput, diff --git a/clients/client-sagemaker-edge/models/models_0.ts b/clients/client-sagemaker-edge/models/models_0.ts index 653a69a13088..56157f6ecd25 100644 --- a/clients/client-sagemaker-edge/models/models_0.ts +++ b/clients/client-sagemaker-edge/models/models_0.ts @@ -14,6 +14,9 @@ export interface GetDeviceRegistrationRequest { } export namespace GetDeviceRegistrationRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetDeviceRegistrationRequest): any => ({ ...obj, }); @@ -32,6 +35,9 @@ export interface GetDeviceRegistrationResult { } export namespace GetDeviceRegistrationResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetDeviceRegistrationResult): any => ({ ...obj, }); @@ -48,6 +54,9 @@ export interface InternalServiceException extends __SmithyException, $MetadataBe } export namespace InternalServiceException { + /** + * @internal + */ export const filterSensitiveLog = (obj: InternalServiceException): any => ({ ...obj, }); @@ -79,6 +88,9 @@ export interface EdgeMetric { } export namespace EdgeMetric { + /** + * @internal + */ export const filterSensitiveLog = (obj: EdgeMetric): any => ({ ...obj, }); @@ -115,6 +127,9 @@ export interface Model { } export namespace Model { + /** + * @internal + */ export const filterSensitiveLog = (obj: Model): any => ({ ...obj, }); @@ -148,6 +163,9 @@ export interface SendHeartbeatRequest { } export namespace SendHeartbeatRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: SendHeartbeatRequest): any => ({ ...obj, }); diff --git a/clients/client-sagemaker-featurestore-runtime/commands/DeleteRecordCommand.ts b/clients/client-sagemaker-featurestore-runtime/commands/DeleteRecordCommand.ts index aa8a5cd4dcde..6a17c187f870 100644 --- a/clients/client-sagemaker-featurestore-runtime/commands/DeleteRecordCommand.ts +++ b/clients/client-sagemaker-featurestore-runtime/commands/DeleteRecordCommand.ts @@ -28,6 +28,20 @@ export interface DeleteRecordCommandOutput extends __MetadataBearer {} *

Deletes a Record from a FeatureGroup. A new record will show * up in the OfflineStore when the DeleteRecord API is called. This * record will have a value of True in the is_deleted column.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { SageMakerFeatureStoreRuntimeClient, DeleteRecordCommand } from "@aws-sdk/client-sagemaker-featurestore-runtime"; // ES Modules import + * // const { SageMakerFeatureStoreRuntimeClient, DeleteRecordCommand } = require("@aws-sdk/client-sagemaker-featurestore-runtime"); // CommonJS import + * const client = new SageMakerFeatureStoreRuntimeClient(config); + * const command = new DeleteRecordCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteRecordCommandInput} for command's `input` shape. + * @see {@link DeleteRecordCommandOutput} for command's `response` shape. + * @see {@link SageMakerFeatureStoreRuntimeClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteRecordCommand extends $Command< DeleteRecordCommandInput, diff --git a/clients/client-sagemaker-featurestore-runtime/commands/GetRecordCommand.ts b/clients/client-sagemaker-featurestore-runtime/commands/GetRecordCommand.ts index 41dbe9639733..18b3965a66f3 100644 --- a/clients/client-sagemaker-featurestore-runtime/commands/GetRecordCommand.ts +++ b/clients/client-sagemaker-featurestore-runtime/commands/GetRecordCommand.ts @@ -28,6 +28,20 @@ export interface GetRecordCommandOutput extends GetRecordResponse, __MetadataBea *

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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { SageMakerFeatureStoreRuntimeClient, GetRecordCommand } from "@aws-sdk/client-sagemaker-featurestore-runtime"; // ES Modules import + * // const { SageMakerFeatureStoreRuntimeClient, GetRecordCommand } = require("@aws-sdk/client-sagemaker-featurestore-runtime"); // CommonJS import + * const client = new SageMakerFeatureStoreRuntimeClient(config); + * const command = new GetRecordCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetRecordCommandInput} for command's `input` shape. + * @see {@link GetRecordCommandOutput} for command's `response` shape. + * @see {@link SageMakerFeatureStoreRuntimeClientResolvedConfig | config} for command's `input` shape. + * */ export class GetRecordCommand extends $Command< GetRecordCommandInput, diff --git a/clients/client-sagemaker-featurestore-runtime/commands/PutRecordCommand.ts b/clients/client-sagemaker-featurestore-runtime/commands/PutRecordCommand.ts index 6c3b5d9ab09e..cf877ebe068a 100644 --- a/clients/client-sagemaker-featurestore-runtime/commands/PutRecordCommand.ts +++ b/clients/client-sagemaker-featurestore-runtime/commands/PutRecordCommand.ts @@ -30,6 +30,20 @@ export interface PutRecordCommandOutput extends __MetadataBearer {} * 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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { SageMakerFeatureStoreRuntimeClient, PutRecordCommand } from "@aws-sdk/client-sagemaker-featurestore-runtime"; // ES Modules import + * // const { SageMakerFeatureStoreRuntimeClient, PutRecordCommand } = require("@aws-sdk/client-sagemaker-featurestore-runtime"); // CommonJS import + * const client = new SageMakerFeatureStoreRuntimeClient(config); + * const command = new PutRecordCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link PutRecordCommandInput} for command's `input` shape. + * @see {@link PutRecordCommandOutput} for command's `response` shape. + * @see {@link SageMakerFeatureStoreRuntimeClientResolvedConfig | config} for command's `input` shape. + * */ export class PutRecordCommand extends $Command< PutRecordCommandInput, diff --git a/clients/client-sagemaker-featurestore-runtime/models/models_0.ts b/clients/client-sagemaker-featurestore-runtime/models/models_0.ts index 9c505f8414b2..3abdca47acc8 100644 --- a/clients/client-sagemaker-featurestore-runtime/models/models_0.ts +++ b/clients/client-sagemaker-featurestore-runtime/models/models_0.ts @@ -11,6 +11,9 @@ export interface AccessForbidden extends __SmithyException, $MetadataBearer { } export namespace AccessForbidden { + /** + * @internal + */ export const filterSensitiveLog = (obj: AccessForbidden): any => ({ ...obj, }); @@ -36,6 +39,9 @@ export interface DeleteRecordRequest { } export namespace DeleteRecordRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteRecordRequest): any => ({ ...obj, }); @@ -52,6 +58,9 @@ export interface InternalFailure extends __SmithyException, $MetadataBearer { } export namespace InternalFailure { + /** + * @internal + */ export const filterSensitiveLog = (obj: InternalFailure): any => ({ ...obj, }); @@ -67,6 +76,9 @@ export interface ServiceUnavailable extends __SmithyException, $MetadataBearer { } export namespace ServiceUnavailable { + /** + * @internal + */ export const filterSensitiveLog = (obj: ServiceUnavailable): any => ({ ...obj, }); @@ -82,6 +94,9 @@ export interface ValidationError extends __SmithyException, $MetadataBearer { } export namespace ValidationError { + /** + * @internal + */ export const filterSensitiveLog = (obj: ValidationError): any => ({ ...obj, }); @@ -107,6 +122,9 @@ export interface GetRecordRequest { } export namespace GetRecordRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetRecordRequest): any => ({ ...obj, }); @@ -129,6 +147,9 @@ export interface FeatureValue { } export namespace FeatureValue { + /** + * @internal + */ export const filterSensitiveLog = (obj: FeatureValue): any => ({ ...obj, }); @@ -142,6 +163,9 @@ export interface GetRecordResponse { } export namespace GetRecordResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetRecordResponse): any => ({ ...obj, }); @@ -157,6 +181,9 @@ export interface ResourceNotFound extends __SmithyException, $MetadataBearer { } export namespace ResourceNotFound { + /** + * @internal + */ export const filterSensitiveLog = (obj: ResourceNotFound): any => ({ ...obj, }); @@ -187,6 +214,9 @@ export interface PutRecordRequest { } export namespace PutRecordRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: PutRecordRequest): any => ({ ...obj, }); diff --git a/clients/client-sagemaker-runtime/commands/InvokeEndpointCommand.ts b/clients/client-sagemaker-runtime/commands/InvokeEndpointCommand.ts index 3358861c945c..958c90c5c82d 100644 --- a/clients/client-sagemaker-runtime/commands/InvokeEndpointCommand.ts +++ b/clients/client-sagemaker-runtime/commands/InvokeEndpointCommand.ts @@ -41,6 +41,20 @@ export interface InvokeEndpointCommandOutput extends InvokeEndpointOutput, __Met * not contain the account ID, but Amazon SageMaker determines the account ID from the * authentication token that is supplied by the caller.

* + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { SageMakerRuntimeClient, InvokeEndpointCommand } from "@aws-sdk/client-sagemaker-runtime"; // ES Modules import + * // const { SageMakerRuntimeClient, InvokeEndpointCommand } = require("@aws-sdk/client-sagemaker-runtime"); // CommonJS import + * const client = new SageMakerRuntimeClient(config); + * const command = new InvokeEndpointCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link InvokeEndpointCommandInput} for command's `input` shape. + * @see {@link InvokeEndpointCommandOutput} for command's `response` shape. + * @see {@link SageMakerRuntimeClientResolvedConfig | config} for command's `input` shape. + * */ export class InvokeEndpointCommand extends $Command< InvokeEndpointCommandInput, diff --git a/clients/client-sagemaker-runtime/models/models_0.ts b/clients/client-sagemaker-runtime/models/models_0.ts index 3a2d521631ce..d8a3971970b0 100644 --- a/clients/client-sagemaker-runtime/models/models_0.ts +++ b/clients/client-sagemaker-runtime/models/models_0.ts @@ -11,6 +11,9 @@ export interface InternalFailure extends __SmithyException, $MetadataBearer { } export namespace InternalFailure { + /** + * @internal + */ export const filterSensitiveLog = (obj: InternalFailure): any => ({ ...obj, }); @@ -91,6 +94,9 @@ export interface InvokeEndpointInput { } export namespace InvokeEndpointInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: InvokeEndpointInput): any => ({ ...obj, ...(obj.Body && { Body: SENSITIVE_STRING }), @@ -138,6 +144,9 @@ export interface InvokeEndpointOutput { } export namespace InvokeEndpointOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: InvokeEndpointOutput): any => ({ ...obj, ...(obj.Body && { Body: SENSITIVE_STRING }), @@ -170,6 +179,9 @@ export interface ModelError extends __SmithyException, $MetadataBearer { } export namespace ModelError { + /** + * @internal + */ export const filterSensitiveLog = (obj: ModelError): any => ({ ...obj, }); @@ -185,6 +197,9 @@ export interface ServiceUnavailable extends __SmithyException, $MetadataBearer { } export namespace ServiceUnavailable { + /** + * @internal + */ export const filterSensitiveLog = (obj: ServiceUnavailable): any => ({ ...obj, }); @@ -200,6 +215,9 @@ export interface ValidationError extends __SmithyException, $MetadataBearer { } export namespace ValidationError { + /** + * @internal + */ export const filterSensitiveLog = (obj: ValidationError): any => ({ ...obj, }); diff --git a/clients/client-sagemaker/commands/AddAssociationCommand.ts b/clients/client-sagemaker/commands/AddAssociationCommand.ts index d8f07a3e2996..d2a9e712d286 100644 --- a/clients/client-sagemaker/commands/AddAssociationCommand.ts +++ b/clients/client-sagemaker/commands/AddAssociationCommand.ts @@ -26,6 +26,20 @@ export interface AddAssociationCommandOutput extends AddAssociationResponse, __M * with multiple sources. An association is a lineage tracking entity. For more information, see * Amazon SageMaker * ML Lineage Tracking.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { SageMakerClient, AddAssociationCommand } from "@aws-sdk/client-sagemaker"; // ES Modules import + * // const { SageMakerClient, AddAssociationCommand } = require("@aws-sdk/client-sagemaker"); // CommonJS import + * const client = new SageMakerClient(config); + * const command = new AddAssociationCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link AddAssociationCommandInput} for command's `input` shape. + * @see {@link AddAssociationCommandOutput} for command's `response` shape. + * @see {@link SageMakerClientResolvedConfig | config} for command's `input` shape. + * */ export class AddAssociationCommand extends $Command< AddAssociationCommandInput, diff --git a/clients/client-sagemaker/commands/AddTagsCommand.ts b/clients/client-sagemaker/commands/AddTagsCommand.ts index 47ca81b9f52f..858306e7c7e6 100644 --- a/clients/client-sagemaker/commands/AddTagsCommand.ts +++ b/clients/client-sagemaker/commands/AddTagsCommand.ts @@ -35,6 +35,20 @@ export interface AddTagsCommandOutput extends AddTagsOutput, __MetadataBearer {} * job by specifying them in the Tags parameter of CreateHyperParameterTuningJob *

* + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { SageMakerClient, AddTagsCommand } from "@aws-sdk/client-sagemaker"; // ES Modules import + * // const { SageMakerClient, AddTagsCommand } = require("@aws-sdk/client-sagemaker"); // CommonJS import + * const client = new SageMakerClient(config); + * const command = new AddTagsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link AddTagsCommandInput} for command's `input` shape. + * @see {@link AddTagsCommandOutput} for command's `response` shape. + * @see {@link SageMakerClientResolvedConfig | config} for command's `input` shape. + * */ export class AddTagsCommand extends $Command { // Start section: command_properties diff --git a/clients/client-sagemaker/commands/AssociateTrialComponentCommand.ts b/clients/client-sagemaker/commands/AssociateTrialComponentCommand.ts index 854866456da4..1605c76e6e81 100644 --- a/clients/client-sagemaker/commands/AssociateTrialComponentCommand.ts +++ b/clients/client-sagemaker/commands/AssociateTrialComponentCommand.ts @@ -23,6 +23,20 @@ export interface AssociateTrialComponentCommandOutput extends AssociateTrialComp /** *

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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { SageMakerClient, AssociateTrialComponentCommand } from "@aws-sdk/client-sagemaker"; // ES Modules import + * // const { SageMakerClient, AssociateTrialComponentCommand } = require("@aws-sdk/client-sagemaker"); // CommonJS import + * const client = new SageMakerClient(config); + * const command = new AssociateTrialComponentCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link AssociateTrialComponentCommandInput} for command's `input` shape. + * @see {@link AssociateTrialComponentCommandOutput} for command's `response` shape. + * @see {@link SageMakerClientResolvedConfig | config} for command's `input` shape. + * */ export class AssociateTrialComponentCommand extends $Command< AssociateTrialComponentCommandInput, diff --git a/clients/client-sagemaker/commands/CreateActionCommand.ts b/clients/client-sagemaker/commands/CreateActionCommand.ts index 6b61d371e913..53427327065a 100644 --- a/clients/client-sagemaker/commands/CreateActionCommand.ts +++ b/clients/client-sagemaker/commands/CreateActionCommand.ts @@ -26,6 +26,20 @@ export interface CreateActionCommandOutput extends CreateActionResponse, __Metad * Generally, an action involves at least one input or output artifact. For more information, see * Amazon SageMaker * ML Lineage Tracking.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { SageMakerClient, CreateActionCommand } from "@aws-sdk/client-sagemaker"; // ES Modules import + * // const { SageMakerClient, CreateActionCommand } = require("@aws-sdk/client-sagemaker"); // CommonJS import + * const client = new SageMakerClient(config); + * const command = new CreateActionCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreateActionCommandInput} for command's `input` shape. + * @see {@link CreateActionCommandOutput} for command's `response` shape. + * @see {@link SageMakerClientResolvedConfig | config} for command's `input` shape. + * */ export class CreateActionCommand extends $Command< CreateActionCommandInput, diff --git a/clients/client-sagemaker/commands/CreateAlgorithmCommand.ts b/clients/client-sagemaker/commands/CreateAlgorithmCommand.ts index 736dac228beb..3be9b17153bd 100644 --- a/clients/client-sagemaker/commands/CreateAlgorithmCommand.ts +++ b/clients/client-sagemaker/commands/CreateAlgorithmCommand.ts @@ -23,6 +23,20 @@ export interface CreateAlgorithmCommandOutput extends CreateAlgorithmOutput, __M /** *

Create a machine learning algorithm that you can use in Amazon SageMaker and list in the AWS * Marketplace.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { SageMakerClient, CreateAlgorithmCommand } from "@aws-sdk/client-sagemaker"; // ES Modules import + * // const { SageMakerClient, CreateAlgorithmCommand } = require("@aws-sdk/client-sagemaker"); // CommonJS import + * const client = new SageMakerClient(config); + * const command = new CreateAlgorithmCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreateAlgorithmCommandInput} for command's `input` shape. + * @see {@link CreateAlgorithmCommandOutput} for command's `response` shape. + * @see {@link SageMakerClientResolvedConfig | config} for command's `input` shape. + * */ export class CreateAlgorithmCommand extends $Command< CreateAlgorithmCommandInput, diff --git a/clients/client-sagemaker/commands/CreateAppCommand.ts b/clients/client-sagemaker/commands/CreateAppCommand.ts index 52a7ee01ac67..940e6f270ea7 100644 --- a/clients/client-sagemaker/commands/CreateAppCommand.ts +++ b/clients/client-sagemaker/commands/CreateAppCommand.ts @@ -22,6 +22,20 @@ export interface CreateAppCommandOutput extends CreateAppResponse, __MetadataBea * JupyterServer and KernelGateway. 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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { SageMakerClient, CreateAppCommand } from "@aws-sdk/client-sagemaker"; // ES Modules import + * // const { SageMakerClient, CreateAppCommand } = require("@aws-sdk/client-sagemaker"); // CommonJS import + * const client = new SageMakerClient(config); + * const command = new CreateAppCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreateAppCommandInput} for command's `input` shape. + * @see {@link CreateAppCommandOutput} for command's `response` shape. + * @see {@link SageMakerClientResolvedConfig | config} for command's `input` shape. + * */ export class CreateAppCommand extends $Command< CreateAppCommandInput, diff --git a/clients/client-sagemaker/commands/CreateAppImageConfigCommand.ts b/clients/client-sagemaker/commands/CreateAppImageConfigCommand.ts index 7adf86ef2ed6..7848d5b0e35a 100644 --- a/clients/client-sagemaker/commands/CreateAppImageConfigCommand.ts +++ b/clients/client-sagemaker/commands/CreateAppImageConfigCommand.ts @@ -24,6 +24,20 @@ export interface CreateAppImageConfigCommandOutput extends CreateAppImageConfigR *

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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { SageMakerClient, CreateAppImageConfigCommand } from "@aws-sdk/client-sagemaker"; // ES Modules import + * // const { SageMakerClient, CreateAppImageConfigCommand } = require("@aws-sdk/client-sagemaker"); // CommonJS import + * const client = new SageMakerClient(config); + * const command = new CreateAppImageConfigCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreateAppImageConfigCommandInput} for command's `input` shape. + * @see {@link CreateAppImageConfigCommandOutput} for command's `response` shape. + * @see {@link SageMakerClientResolvedConfig | config} for command's `input` shape. + * */ export class CreateAppImageConfigCommand extends $Command< CreateAppImageConfigCommandInput, diff --git a/clients/client-sagemaker/commands/CreateArtifactCommand.ts b/clients/client-sagemaker/commands/CreateArtifactCommand.ts index ccf56c9a7997..153ea90b8a0a 100644 --- a/clients/client-sagemaker/commands/CreateArtifactCommand.ts +++ b/clients/client-sagemaker/commands/CreateArtifactCommand.ts @@ -26,6 +26,20 @@ export interface CreateArtifactCommandOutput extends CreateArtifactResponse, __M * the ECR registry path of an image. For more information, see * Amazon SageMaker * ML Lineage Tracking.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { SageMakerClient, CreateArtifactCommand } from "@aws-sdk/client-sagemaker"; // ES Modules import + * // const { SageMakerClient, CreateArtifactCommand } = require("@aws-sdk/client-sagemaker"); // CommonJS import + * const client = new SageMakerClient(config); + * const command = new CreateArtifactCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreateArtifactCommandInput} for command's `input` shape. + * @see {@link CreateArtifactCommandOutput} for command's `response` shape. + * @see {@link SageMakerClientResolvedConfig | config} for command's `input` shape. + * */ export class CreateArtifactCommand extends $Command< CreateArtifactCommandInput, diff --git a/clients/client-sagemaker/commands/CreateAutoMLJobCommand.ts b/clients/client-sagemaker/commands/CreateAutoMLJobCommand.ts index 51fd09a1d447..442045ad27f0 100644 --- a/clients/client-sagemaker/commands/CreateAutoMLJobCommand.ts +++ b/clients/client-sagemaker/commands/CreateAutoMLJobCommand.ts @@ -25,6 +25,20 @@ export interface CreateAutoMLJobCommandOutput extends CreateAutoMLJobResponse, _ *

Find the best performing model after you run an Autopilot job by calling .

*

For information about how to use Autopilot, see Automate Model * Development with Amazon SageMaker Autopilot.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { SageMakerClient, CreateAutoMLJobCommand } from "@aws-sdk/client-sagemaker"; // ES Modules import + * // const { SageMakerClient, CreateAutoMLJobCommand } = require("@aws-sdk/client-sagemaker"); // CommonJS import + * const client = new SageMakerClient(config); + * const command = new CreateAutoMLJobCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreateAutoMLJobCommandInput} for command's `input` shape. + * @see {@link CreateAutoMLJobCommandOutput} for command's `response` shape. + * @see {@link SageMakerClientResolvedConfig | config} for command's `input` shape. + * */ export class CreateAutoMLJobCommand extends $Command< CreateAutoMLJobCommandInput, diff --git a/clients/client-sagemaker/commands/CreateCodeRepositoryCommand.ts b/clients/client-sagemaker/commands/CreateCodeRepositoryCommand.ts index 9cd74ec567aa..15f2c6485fe9 100644 --- a/clients/client-sagemaker/commands/CreateCodeRepositoryCommand.ts +++ b/clients/client-sagemaker/commands/CreateCodeRepositoryCommand.ts @@ -28,6 +28,20 @@ export interface CreateCodeRepositoryCommandOutput extends CreateCodeRepositoryO * the lifecycle of any notebook instances it is associated with.

*

The repository can be hosted either in AWS CodeCommit or in any * other Git repository.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { SageMakerClient, CreateCodeRepositoryCommand } from "@aws-sdk/client-sagemaker"; // ES Modules import + * // const { SageMakerClient, CreateCodeRepositoryCommand } = require("@aws-sdk/client-sagemaker"); // CommonJS import + * const client = new SageMakerClient(config); + * const command = new CreateCodeRepositoryCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreateCodeRepositoryCommandInput} for command's `input` shape. + * @see {@link CreateCodeRepositoryCommandOutput} for command's `response` shape. + * @see {@link SageMakerClientResolvedConfig | config} for command's `input` shape. + * */ export class CreateCodeRepositoryCommand extends $Command< CreateCodeRepositoryCommandInput, diff --git a/clients/client-sagemaker/commands/CreateCompilationJobCommand.ts b/clients/client-sagemaker/commands/CreateCompilationJobCommand.ts index e54ade712d83..6c8d13e58ac6 100644 --- a/clients/client-sagemaker/commands/CreateCompilationJobCommand.ts +++ b/clients/client-sagemaker/commands/CreateCompilationJobCommand.ts @@ -53,6 +53,20 @@ export interface CreateCompilationJobCommandOutput extends CreateCompilationJobR *

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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { SageMakerClient, CreateCompilationJobCommand } from "@aws-sdk/client-sagemaker"; // ES Modules import + * // const { SageMakerClient, CreateCompilationJobCommand } = require("@aws-sdk/client-sagemaker"); // CommonJS import + * const client = new SageMakerClient(config); + * const command = new CreateCompilationJobCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreateCompilationJobCommandInput} for command's `input` shape. + * @see {@link CreateCompilationJobCommandOutput} for command's `response` shape. + * @see {@link SageMakerClientResolvedConfig | config} for command's `input` shape. + * */ export class CreateCompilationJobCommand extends $Command< CreateCompilationJobCommandInput, diff --git a/clients/client-sagemaker/commands/CreateContextCommand.ts b/clients/client-sagemaker/commands/CreateContextCommand.ts index b9f278163fb3..c65e2445e15e 100644 --- a/clients/client-sagemaker/commands/CreateContextCommand.ts +++ b/clients/client-sagemaker/commands/CreateContextCommand.ts @@ -26,6 +26,20 @@ export interface CreateContextCommandOutput extends CreateContextResponse, __Met * an endpoint and a model package. For more information, see * Amazon SageMaker * ML Lineage Tracking.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { SageMakerClient, CreateContextCommand } from "@aws-sdk/client-sagemaker"; // ES Modules import + * // const { SageMakerClient, CreateContextCommand } = require("@aws-sdk/client-sagemaker"); // CommonJS import + * const client = new SageMakerClient(config); + * const command = new CreateContextCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreateContextCommandInput} for command's `input` shape. + * @see {@link CreateContextCommandOutput} for command's `response` shape. + * @see {@link SageMakerClientResolvedConfig | config} for command's `input` shape. + * */ export class CreateContextCommand extends $Command< CreateContextCommandInput, diff --git a/clients/client-sagemaker/commands/CreateDataQualityJobDefinitionCommand.ts b/clients/client-sagemaker/commands/CreateDataQualityJobDefinitionCommand.ts index a5d109ae7d55..9596da5f4ff3 100644 --- a/clients/client-sagemaker/commands/CreateDataQualityJobDefinitionCommand.ts +++ b/clients/client-sagemaker/commands/CreateDataQualityJobDefinitionCommand.ts @@ -25,6 +25,20 @@ export interface CreateDataQualityJobDefinitionCommandOutput /** *

Creates a definition for a job that monitors data quality and drift. For information * about model monitor, see Amazon SageMaker Model Monitor.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { SageMakerClient, CreateDataQualityJobDefinitionCommand } from "@aws-sdk/client-sagemaker"; // ES Modules import + * // const { SageMakerClient, CreateDataQualityJobDefinitionCommand } = require("@aws-sdk/client-sagemaker"); // CommonJS import + * const client = new SageMakerClient(config); + * const command = new CreateDataQualityJobDefinitionCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreateDataQualityJobDefinitionCommandInput} for command's `input` shape. + * @see {@link CreateDataQualityJobDefinitionCommandOutput} for command's `response` shape. + * @see {@link SageMakerClientResolvedConfig | config} for command's `input` shape. + * */ export class CreateDataQualityJobDefinitionCommand extends $Command< CreateDataQualityJobDefinitionCommandInput, diff --git a/clients/client-sagemaker/commands/CreateDeviceFleetCommand.ts b/clients/client-sagemaker/commands/CreateDeviceFleetCommand.ts index 86565e19802f..cd660bde65c8 100644 --- a/clients/client-sagemaker/commands/CreateDeviceFleetCommand.ts +++ b/clients/client-sagemaker/commands/CreateDeviceFleetCommand.ts @@ -22,6 +22,20 @@ export interface CreateDeviceFleetCommandOutput extends __MetadataBearer {} /** *

Creates a device fleet.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { SageMakerClient, CreateDeviceFleetCommand } from "@aws-sdk/client-sagemaker"; // ES Modules import + * // const { SageMakerClient, CreateDeviceFleetCommand } = require("@aws-sdk/client-sagemaker"); // CommonJS import + * const client = new SageMakerClient(config); + * const command = new CreateDeviceFleetCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreateDeviceFleetCommandInput} for command's `input` shape. + * @see {@link CreateDeviceFleetCommandOutput} for command's `response` shape. + * @see {@link SageMakerClientResolvedConfig | config} for command's `input` shape. + * */ export class CreateDeviceFleetCommand extends $Command< CreateDeviceFleetCommandInput, diff --git a/clients/client-sagemaker/commands/CreateDomainCommand.ts b/clients/client-sagemaker/commands/CreateDomainCommand.ts index f5ed15b8affa..69493edaa1a5 100644 --- a/clients/client-sagemaker/commands/CreateDomainCommand.ts +++ b/clients/client-sagemaker/commands/CreateDomainCommand.ts @@ -64,6 +64,20 @@ export interface CreateDomainCommandOutput extends CreateDomainResponse, __Metad *

For more information, see * Connect * SageMaker Studio Notebooks to Resources in a VPC.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { SageMakerClient, CreateDomainCommand } from "@aws-sdk/client-sagemaker"; // ES Modules import + * // const { SageMakerClient, CreateDomainCommand } = require("@aws-sdk/client-sagemaker"); // CommonJS import + * const client = new SageMakerClient(config); + * const command = new CreateDomainCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreateDomainCommandInput} for command's `input` shape. + * @see {@link CreateDomainCommandOutput} for command's `response` shape. + * @see {@link SageMakerClientResolvedConfig | config} for command's `input` shape. + * */ export class CreateDomainCommand extends $Command< CreateDomainCommandInput, diff --git a/clients/client-sagemaker/commands/CreateEdgePackagingJobCommand.ts b/clients/client-sagemaker/commands/CreateEdgePackagingJobCommand.ts index 1e17373bd7a5..c64c729f8d1d 100644 --- a/clients/client-sagemaker/commands/CreateEdgePackagingJobCommand.ts +++ b/clients/client-sagemaker/commands/CreateEdgePackagingJobCommand.ts @@ -22,6 +22,20 @@ export interface CreateEdgePackagingJobCommandOutput extends __MetadataBearer {} /** *

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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { SageMakerClient, CreateEdgePackagingJobCommand } from "@aws-sdk/client-sagemaker"; // ES Modules import + * // const { SageMakerClient, CreateEdgePackagingJobCommand } = require("@aws-sdk/client-sagemaker"); // CommonJS import + * const client = new SageMakerClient(config); + * const command = new CreateEdgePackagingJobCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreateEdgePackagingJobCommandInput} for command's `input` shape. + * @see {@link CreateEdgePackagingJobCommandOutput} for command's `response` shape. + * @see {@link SageMakerClientResolvedConfig | config} for command's `input` shape. + * */ export class CreateEdgePackagingJobCommand extends $Command< CreateEdgePackagingJobCommandInput, diff --git a/clients/client-sagemaker/commands/CreateEndpointCommand.ts b/clients/client-sagemaker/commands/CreateEndpointCommand.ts index 99efb40ef9be..bdd5463bc231 100644 --- a/clients/client-sagemaker/commands/CreateEndpointCommand.ts +++ b/clients/client-sagemaker/commands/CreateEndpointCommand.ts @@ -100,6 +100,20 @@ export interface CreateEndpointCommandOutput extends CreateEndpointOutput, __Met * * * + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { SageMakerClient, CreateEndpointCommand } from "@aws-sdk/client-sagemaker"; // ES Modules import + * // const { SageMakerClient, CreateEndpointCommand } = require("@aws-sdk/client-sagemaker"); // CommonJS import + * const client = new SageMakerClient(config); + * const command = new CreateEndpointCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreateEndpointCommandInput} for command's `input` shape. + * @see {@link CreateEndpointCommandOutput} for command's `response` shape. + * @see {@link SageMakerClientResolvedConfig | config} for command's `input` shape. + * */ export class CreateEndpointCommand extends $Command< CreateEndpointCommandInput, diff --git a/clients/client-sagemaker/commands/CreateEndpointConfigCommand.ts b/clients/client-sagemaker/commands/CreateEndpointConfigCommand.ts index 813a221ba9da..c280e6858095 100644 --- a/clients/client-sagemaker/commands/CreateEndpointConfigCommand.ts +++ b/clients/client-sagemaker/commands/CreateEndpointConfigCommand.ts @@ -55,6 +55,20 @@ export interface CreateEndpointConfigCommandOutput extends CreateEndpointConfigO * 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.

* + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { SageMakerClient, CreateEndpointConfigCommand } from "@aws-sdk/client-sagemaker"; // ES Modules import + * // const { SageMakerClient, CreateEndpointConfigCommand } = require("@aws-sdk/client-sagemaker"); // CommonJS import + * const client = new SageMakerClient(config); + * const command = new CreateEndpointConfigCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreateEndpointConfigCommandInput} for command's `input` shape. + * @see {@link CreateEndpointConfigCommandOutput} for command's `response` shape. + * @see {@link SageMakerClientResolvedConfig | config} for command's `input` shape. + * */ export class CreateEndpointConfigCommand extends $Command< CreateEndpointConfigCommandInput, diff --git a/clients/client-sagemaker/commands/CreateExperimentCommand.ts b/clients/client-sagemaker/commands/CreateExperimentCommand.ts index 4799167edb3e..aaef74b77c09 100644 --- a/clients/client-sagemaker/commands/CreateExperimentCommand.ts +++ b/clients/client-sagemaker/commands/CreateExperimentCommand.ts @@ -38,6 +38,20 @@ export interface CreateExperimentCommandOutput extends CreateExperimentResponse, * 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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { SageMakerClient, CreateExperimentCommand } from "@aws-sdk/client-sagemaker"; // ES Modules import + * // const { SageMakerClient, CreateExperimentCommand } = require("@aws-sdk/client-sagemaker"); // CommonJS import + * const client = new SageMakerClient(config); + * const command = new CreateExperimentCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreateExperimentCommandInput} for command's `input` shape. + * @see {@link CreateExperimentCommandOutput} for command's `response` shape. + * @see {@link SageMakerClientResolvedConfig | config} for command's `input` shape. + * */ export class CreateExperimentCommand extends $Command< CreateExperimentCommandInput, diff --git a/clients/client-sagemaker/commands/CreateFeatureGroupCommand.ts b/clients/client-sagemaker/commands/CreateFeatureGroupCommand.ts index 0a57b74a0849..97a4e794e179 100644 --- a/clients/client-sagemaker/commands/CreateFeatureGroupCommand.ts +++ b/clients/client-sagemaker/commands/CreateFeatureGroupCommand.ts @@ -34,6 +34,20 @@ export interface CreateFeatureGroupCommandOutput extends CreateFeatureGroupRespo *

You must include at least one of OnlineStoreConfig and * OfflineStoreConfig to create a FeatureGroup.

* + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { SageMakerClient, CreateFeatureGroupCommand } from "@aws-sdk/client-sagemaker"; // ES Modules import + * // const { SageMakerClient, CreateFeatureGroupCommand } = require("@aws-sdk/client-sagemaker"); // CommonJS import + * const client = new SageMakerClient(config); + * const command = new CreateFeatureGroupCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreateFeatureGroupCommandInput} for command's `input` shape. + * @see {@link CreateFeatureGroupCommandOutput} for command's `response` shape. + * @see {@link SageMakerClientResolvedConfig | config} for command's `input` shape. + * */ export class CreateFeatureGroupCommand extends $Command< CreateFeatureGroupCommandInput, diff --git a/clients/client-sagemaker/commands/CreateFlowDefinitionCommand.ts b/clients/client-sagemaker/commands/CreateFlowDefinitionCommand.ts index 8d922f74736d..0c79c8dbea7d 100644 --- a/clients/client-sagemaker/commands/CreateFlowDefinitionCommand.ts +++ b/clients/client-sagemaker/commands/CreateFlowDefinitionCommand.ts @@ -22,6 +22,20 @@ export interface CreateFlowDefinitionCommandOutput extends CreateFlowDefinitionR /** *

Creates a flow definition.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { SageMakerClient, CreateFlowDefinitionCommand } from "@aws-sdk/client-sagemaker"; // ES Modules import + * // const { SageMakerClient, CreateFlowDefinitionCommand } = require("@aws-sdk/client-sagemaker"); // CommonJS import + * const client = new SageMakerClient(config); + * const command = new CreateFlowDefinitionCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreateFlowDefinitionCommandInput} for command's `input` shape. + * @see {@link CreateFlowDefinitionCommandOutput} for command's `response` shape. + * @see {@link SageMakerClientResolvedConfig | config} for command's `input` shape. + * */ export class CreateFlowDefinitionCommand extends $Command< CreateFlowDefinitionCommandInput, diff --git a/clients/client-sagemaker/commands/CreateHumanTaskUiCommand.ts b/clients/client-sagemaker/commands/CreateHumanTaskUiCommand.ts index c6382ef34649..3d26755a01b9 100644 --- a/clients/client-sagemaker/commands/CreateHumanTaskUiCommand.ts +++ b/clients/client-sagemaker/commands/CreateHumanTaskUiCommand.ts @@ -22,6 +22,20 @@ export interface CreateHumanTaskUiCommandOutput extends CreateHumanTaskUiRespons /** *

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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { SageMakerClient, CreateHumanTaskUiCommand } from "@aws-sdk/client-sagemaker"; // ES Modules import + * // const { SageMakerClient, CreateHumanTaskUiCommand } = require("@aws-sdk/client-sagemaker"); // CommonJS import + * const client = new SageMakerClient(config); + * const command = new CreateHumanTaskUiCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreateHumanTaskUiCommandInput} for command's `input` shape. + * @see {@link CreateHumanTaskUiCommandOutput} for command's `response` shape. + * @see {@link SageMakerClientResolvedConfig | config} for command's `input` shape. + * */ export class CreateHumanTaskUiCommand extends $Command< CreateHumanTaskUiCommandInput, diff --git a/clients/client-sagemaker/commands/CreateHyperParameterTuningJobCommand.ts b/clients/client-sagemaker/commands/CreateHyperParameterTuningJobCommand.ts index db794cb73f8f..b7c7e92716e9 100644 --- a/clients/client-sagemaker/commands/CreateHyperParameterTuningJobCommand.ts +++ b/clients/client-sagemaker/commands/CreateHyperParameterTuningJobCommand.ts @@ -28,6 +28,20 @@ export interface CreateHyperParameterTuningJobCommandOutput * 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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { SageMakerClient, CreateHyperParameterTuningJobCommand } from "@aws-sdk/client-sagemaker"; // ES Modules import + * // const { SageMakerClient, CreateHyperParameterTuningJobCommand } = require("@aws-sdk/client-sagemaker"); // CommonJS import + * const client = new SageMakerClient(config); + * const command = new CreateHyperParameterTuningJobCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreateHyperParameterTuningJobCommandInput} for command's `input` shape. + * @see {@link CreateHyperParameterTuningJobCommandOutput} for command's `response` shape. + * @see {@link SageMakerClientResolvedConfig | config} for command's `input` shape. + * */ export class CreateHyperParameterTuningJobCommand extends $Command< CreateHyperParameterTuningJobCommandInput, diff --git a/clients/client-sagemaker/commands/CreateImageCommand.ts b/clients/client-sagemaker/commands/CreateImageCommand.ts index 6c1f175b68bc..dcd931c911d3 100644 --- a/clients/client-sagemaker/commands/CreateImageCommand.ts +++ b/clients/client-sagemaker/commands/CreateImageCommand.ts @@ -24,6 +24,20 @@ export interface CreateImageCommandOutput extends CreateImageResponse, __Metadat *

Creates a custom SageMaker image. A SageMaker image is a set of image versions. Each image * version represents a container image stored in Amazon Container Registry (ECR). For more information, see * Bring your own SageMaker image.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { SageMakerClient, CreateImageCommand } from "@aws-sdk/client-sagemaker"; // ES Modules import + * // const { SageMakerClient, CreateImageCommand } = require("@aws-sdk/client-sagemaker"); // CommonJS import + * const client = new SageMakerClient(config); + * const command = new CreateImageCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreateImageCommandInput} for command's `input` shape. + * @see {@link CreateImageCommandOutput} for command's `response` shape. + * @see {@link SageMakerClientResolvedConfig | config} for command's `input` shape. + * */ export class CreateImageCommand extends $Command< CreateImageCommandInput, diff --git a/clients/client-sagemaker/commands/CreateImageVersionCommand.ts b/clients/client-sagemaker/commands/CreateImageVersionCommand.ts index 6012587980d8..9861c1953a6d 100644 --- a/clients/client-sagemaker/commands/CreateImageVersionCommand.ts +++ b/clients/client-sagemaker/commands/CreateImageVersionCommand.ts @@ -23,6 +23,20 @@ export interface CreateImageVersionCommandOutput extends CreateImageVersionRespo /** *

Creates a version of the SageMaker image specified by ImageName. The version * represents the Amazon Container Registry (ECR) container image specified by BaseImage.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { SageMakerClient, CreateImageVersionCommand } from "@aws-sdk/client-sagemaker"; // ES Modules import + * // const { SageMakerClient, CreateImageVersionCommand } = require("@aws-sdk/client-sagemaker"); // CommonJS import + * const client = new SageMakerClient(config); + * const command = new CreateImageVersionCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreateImageVersionCommandInput} for command's `input` shape. + * @see {@link CreateImageVersionCommandOutput} for command's `response` shape. + * @see {@link SageMakerClientResolvedConfig | config} for command's `input` shape. + * */ export class CreateImageVersionCommand extends $Command< CreateImageVersionCommandInput, diff --git a/clients/client-sagemaker/commands/CreateLabelingJobCommand.ts b/clients/client-sagemaker/commands/CreateLabelingJobCommand.ts index f82cd0611690..e397234c8c2c 100644 --- a/clients/client-sagemaker/commands/CreateLabelingJobCommand.ts +++ b/clients/client-sagemaker/commands/CreateLabelingJobCommand.ts @@ -59,6 +59,20 @@ export interface CreateLabelingJobCommandOutput extends CreateLabelingJobRespons * (API) in the Amazon SageMaker Developer Guide. To learn how to create a streaming * labeling job, see Create a Streaming Labeling * Job.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { SageMakerClient, CreateLabelingJobCommand } from "@aws-sdk/client-sagemaker"; // ES Modules import + * // const { SageMakerClient, CreateLabelingJobCommand } = require("@aws-sdk/client-sagemaker"); // CommonJS import + * const client = new SageMakerClient(config); + * const command = new CreateLabelingJobCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreateLabelingJobCommandInput} for command's `input` shape. + * @see {@link CreateLabelingJobCommandOutput} for command's `response` shape. + * @see {@link SageMakerClientResolvedConfig | config} for command's `input` shape. + * */ export class CreateLabelingJobCommand extends $Command< CreateLabelingJobCommandInput, diff --git a/clients/client-sagemaker/commands/CreateModelBiasJobDefinitionCommand.ts b/clients/client-sagemaker/commands/CreateModelBiasJobDefinitionCommand.ts index 7ec13ab4e501..eff354a740d3 100644 --- a/clients/client-sagemaker/commands/CreateModelBiasJobDefinitionCommand.ts +++ b/clients/client-sagemaker/commands/CreateModelBiasJobDefinitionCommand.ts @@ -24,6 +24,20 @@ export interface CreateModelBiasJobDefinitionCommandOutput /** *

Creates the definition for a model bias job.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { SageMakerClient, CreateModelBiasJobDefinitionCommand } from "@aws-sdk/client-sagemaker"; // ES Modules import + * // const { SageMakerClient, CreateModelBiasJobDefinitionCommand } = require("@aws-sdk/client-sagemaker"); // CommonJS import + * const client = new SageMakerClient(config); + * const command = new CreateModelBiasJobDefinitionCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreateModelBiasJobDefinitionCommandInput} for command's `input` shape. + * @see {@link CreateModelBiasJobDefinitionCommandOutput} for command's `response` shape. + * @see {@link SageMakerClientResolvedConfig | config} for command's `input` shape. + * */ export class CreateModelBiasJobDefinitionCommand extends $Command< CreateModelBiasJobDefinitionCommandInput, diff --git a/clients/client-sagemaker/commands/CreateModelCommand.ts b/clients/client-sagemaker/commands/CreateModelCommand.ts index 6b00877fb5c0..331657688d3b 100644 --- a/clients/client-sagemaker/commands/CreateModelCommand.ts +++ b/clients/client-sagemaker/commands/CreateModelCommand.ts @@ -47,6 +47,20 @@ export interface CreateModelCommandOutput extends CreateModelOutput, __MetadataB * 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 AWS resources, * you grant necessary permissions via this role.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { SageMakerClient, CreateModelCommand } from "@aws-sdk/client-sagemaker"; // ES Modules import + * // const { SageMakerClient, CreateModelCommand } = require("@aws-sdk/client-sagemaker"); // CommonJS import + * const client = new SageMakerClient(config); + * const command = new CreateModelCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreateModelCommandInput} for command's `input` shape. + * @see {@link CreateModelCommandOutput} for command's `response` shape. + * @see {@link SageMakerClientResolvedConfig | config} for command's `input` shape. + * */ export class CreateModelCommand extends $Command< CreateModelCommandInput, diff --git a/clients/client-sagemaker/commands/CreateModelExplainabilityJobDefinitionCommand.ts b/clients/client-sagemaker/commands/CreateModelExplainabilityJobDefinitionCommand.ts index 6b1a21e9b9d1..9e396d8fc15f 100644 --- a/clients/client-sagemaker/commands/CreateModelExplainabilityJobDefinitionCommand.ts +++ b/clients/client-sagemaker/commands/CreateModelExplainabilityJobDefinitionCommand.ts @@ -28,6 +28,20 @@ export interface CreateModelExplainabilityJobDefinitionCommandOutput /** *

Creates the definition for a model explainability job.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { SageMakerClient, CreateModelExplainabilityJobDefinitionCommand } from "@aws-sdk/client-sagemaker"; // ES Modules import + * // const { SageMakerClient, CreateModelExplainabilityJobDefinitionCommand } = require("@aws-sdk/client-sagemaker"); // CommonJS import + * const client = new SageMakerClient(config); + * const command = new CreateModelExplainabilityJobDefinitionCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreateModelExplainabilityJobDefinitionCommandInput} for command's `input` shape. + * @see {@link CreateModelExplainabilityJobDefinitionCommandOutput} for command's `response` shape. + * @see {@link SageMakerClientResolvedConfig | config} for command's `input` shape. + * */ export class CreateModelExplainabilityJobDefinitionCommand extends $Command< CreateModelExplainabilityJobDefinitionCommandInput, diff --git a/clients/client-sagemaker/commands/CreateModelPackageCommand.ts b/clients/client-sagemaker/commands/CreateModelPackageCommand.ts index 6feafb024e15..a29989e4f9ed 100644 --- a/clients/client-sagemaker/commands/CreateModelPackageCommand.ts +++ b/clients/client-sagemaker/commands/CreateModelPackageCommand.ts @@ -41,6 +41,20 @@ export interface CreateModelPackageCommandOutput extends CreateModelPackageOutpu * * * + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { SageMakerClient, CreateModelPackageCommand } from "@aws-sdk/client-sagemaker"; // ES Modules import + * // const { SageMakerClient, CreateModelPackageCommand } = require("@aws-sdk/client-sagemaker"); // CommonJS import + * const client = new SageMakerClient(config); + * const command = new CreateModelPackageCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreateModelPackageCommandInput} for command's `input` shape. + * @see {@link CreateModelPackageCommandOutput} for command's `response` shape. + * @see {@link SageMakerClientResolvedConfig | config} for command's `input` shape. + * */ export class CreateModelPackageCommand extends $Command< CreateModelPackageCommandInput, diff --git a/clients/client-sagemaker/commands/CreateModelPackageGroupCommand.ts b/clients/client-sagemaker/commands/CreateModelPackageGroupCommand.ts index ca56088d1999..7edc2f698e1b 100644 --- a/clients/client-sagemaker/commands/CreateModelPackageGroupCommand.ts +++ b/clients/client-sagemaker/commands/CreateModelPackageGroupCommand.ts @@ -22,6 +22,20 @@ export interface CreateModelPackageGroupCommandOutput extends CreateModelPackage /** *

Creates a model group. A model group contains a group of model versions.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { SageMakerClient, CreateModelPackageGroupCommand } from "@aws-sdk/client-sagemaker"; // ES Modules import + * // const { SageMakerClient, CreateModelPackageGroupCommand } = require("@aws-sdk/client-sagemaker"); // CommonJS import + * const client = new SageMakerClient(config); + * const command = new CreateModelPackageGroupCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreateModelPackageGroupCommandInput} for command's `input` shape. + * @see {@link CreateModelPackageGroupCommandOutput} for command's `response` shape. + * @see {@link SageMakerClientResolvedConfig | config} for command's `input` shape. + * */ export class CreateModelPackageGroupCommand extends $Command< CreateModelPackageGroupCommandInput, diff --git a/clients/client-sagemaker/commands/CreateModelQualityJobDefinitionCommand.ts b/clients/client-sagemaker/commands/CreateModelQualityJobDefinitionCommand.ts index 858be0894a11..07acdcf05807 100644 --- a/clients/client-sagemaker/commands/CreateModelQualityJobDefinitionCommand.ts +++ b/clients/client-sagemaker/commands/CreateModelQualityJobDefinitionCommand.ts @@ -25,6 +25,20 @@ export interface CreateModelQualityJobDefinitionCommandOutput /** *

Creates a definition for a job that monitors model quality and drift. For information * about model monitor, see Amazon SageMaker Model Monitor.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { SageMakerClient, CreateModelQualityJobDefinitionCommand } from "@aws-sdk/client-sagemaker"; // ES Modules import + * // const { SageMakerClient, CreateModelQualityJobDefinitionCommand } = require("@aws-sdk/client-sagemaker"); // CommonJS import + * const client = new SageMakerClient(config); + * const command = new CreateModelQualityJobDefinitionCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreateModelQualityJobDefinitionCommandInput} for command's `input` shape. + * @see {@link CreateModelQualityJobDefinitionCommandOutput} for command's `response` shape. + * @see {@link SageMakerClientResolvedConfig | config} for command's `input` shape. + * */ export class CreateModelQualityJobDefinitionCommand extends $Command< CreateModelQualityJobDefinitionCommandInput, diff --git a/clients/client-sagemaker/commands/CreateMonitoringScheduleCommand.ts b/clients/client-sagemaker/commands/CreateMonitoringScheduleCommand.ts index 7793ad894195..b44a21f856d6 100644 --- a/clients/client-sagemaker/commands/CreateMonitoringScheduleCommand.ts +++ b/clients/client-sagemaker/commands/CreateMonitoringScheduleCommand.ts @@ -23,6 +23,20 @@ export interface CreateMonitoringScheduleCommandOutput extends CreateMonitoringS /** *

Creates a schedule that regularly starts Amazon SageMaker Processing Jobs to monitor the data * captured for an Amazon SageMaker Endoint.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { SageMakerClient, CreateMonitoringScheduleCommand } from "@aws-sdk/client-sagemaker"; // ES Modules import + * // const { SageMakerClient, CreateMonitoringScheduleCommand } = require("@aws-sdk/client-sagemaker"); // CommonJS import + * const client = new SageMakerClient(config); + * const command = new CreateMonitoringScheduleCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreateMonitoringScheduleCommandInput} for command's `input` shape. + * @see {@link CreateMonitoringScheduleCommandOutput} for command's `response` shape. + * @see {@link SageMakerClientResolvedConfig | config} for command's `input` shape. + * */ export class CreateMonitoringScheduleCommand extends $Command< CreateMonitoringScheduleCommandInput, diff --git a/clients/client-sagemaker/commands/CreateNotebookInstanceCommand.ts b/clients/client-sagemaker/commands/CreateNotebookInstanceCommand.ts index e9a1fd78142c..aed7b0c870b1 100644 --- a/clients/client-sagemaker/commands/CreateNotebookInstanceCommand.ts +++ b/clients/client-sagemaker/commands/CreateNotebookInstanceCommand.ts @@ -58,6 +58,20 @@ export interface CreateNotebookInstanceCommandOutput extends CreateNotebookInsta * can use for model training, train a model, host models by creating Amazon SageMaker endpoints, and * validate hosted models.

*

For more information, see How It Works.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { SageMakerClient, CreateNotebookInstanceCommand } from "@aws-sdk/client-sagemaker"; // ES Modules import + * // const { SageMakerClient, CreateNotebookInstanceCommand } = require("@aws-sdk/client-sagemaker"); // CommonJS import + * const client = new SageMakerClient(config); + * const command = new CreateNotebookInstanceCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreateNotebookInstanceCommandInput} for command's `input` shape. + * @see {@link CreateNotebookInstanceCommandOutput} for command's `response` shape. + * @see {@link SageMakerClientResolvedConfig | config} for command's `input` shape. + * */ export class CreateNotebookInstanceCommand extends $Command< CreateNotebookInstanceCommandInput, diff --git a/clients/client-sagemaker/commands/CreateNotebookInstanceLifecycleConfigCommand.ts b/clients/client-sagemaker/commands/CreateNotebookInstanceLifecycleConfigCommand.ts index 6c130aaba8b9..5379e2260bfb 100644 --- a/clients/client-sagemaker/commands/CreateNotebookInstanceLifecycleConfigCommand.ts +++ b/clients/client-sagemaker/commands/CreateNotebookInstanceLifecycleConfigCommand.ts @@ -40,6 +40,20 @@ export interface CreateNotebookInstanceLifecycleConfigCommandOutput * started.

*

For information about notebook instance lifestyle configurations, see Step * 2.1: (Optional) Customize a Notebook Instance.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { SageMakerClient, CreateNotebookInstanceLifecycleConfigCommand } from "@aws-sdk/client-sagemaker"; // ES Modules import + * // const { SageMakerClient, CreateNotebookInstanceLifecycleConfigCommand } = require("@aws-sdk/client-sagemaker"); // CommonJS import + * const client = new SageMakerClient(config); + * const command = new CreateNotebookInstanceLifecycleConfigCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreateNotebookInstanceLifecycleConfigCommandInput} for command's `input` shape. + * @see {@link CreateNotebookInstanceLifecycleConfigCommandOutput} for command's `response` shape. + * @see {@link SageMakerClientResolvedConfig | config} for command's `input` shape. + * */ export class CreateNotebookInstanceLifecycleConfigCommand extends $Command< CreateNotebookInstanceLifecycleConfigCommandInput, diff --git a/clients/client-sagemaker/commands/CreatePipelineCommand.ts b/clients/client-sagemaker/commands/CreatePipelineCommand.ts index 4f9685a61273..ab83e9a4e376 100644 --- a/clients/client-sagemaker/commands/CreatePipelineCommand.ts +++ b/clients/client-sagemaker/commands/CreatePipelineCommand.ts @@ -22,6 +22,20 @@ export interface CreatePipelineCommandOutput extends CreatePipelineResponse, __M /** *

Creates a pipeline using a JSON pipeline definition.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { SageMakerClient, CreatePipelineCommand } from "@aws-sdk/client-sagemaker"; // ES Modules import + * // const { SageMakerClient, CreatePipelineCommand } = require("@aws-sdk/client-sagemaker"); // CommonJS import + * const client = new SageMakerClient(config); + * const command = new CreatePipelineCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreatePipelineCommandInput} for command's `input` shape. + * @see {@link CreatePipelineCommandOutput} for command's `response` shape. + * @see {@link SageMakerClientResolvedConfig | config} for command's `input` shape. + * */ export class CreatePipelineCommand extends $Command< CreatePipelineCommandInput, diff --git a/clients/client-sagemaker/commands/CreatePresignedDomainUrlCommand.ts b/clients/client-sagemaker/commands/CreatePresignedDomainUrlCommand.ts index 4dba9d4bf7c8..907a7f699c69 100644 --- a/clients/client-sagemaker/commands/CreatePresignedDomainUrlCommand.ts +++ b/clients/client-sagemaker/commands/CreatePresignedDomainUrlCommand.ts @@ -30,6 +30,20 @@ export interface CreatePresignedDomainUrlCommandOutput extends CreatePresignedDo *

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 AWS console sign-in page.

* + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { SageMakerClient, CreatePresignedDomainUrlCommand } from "@aws-sdk/client-sagemaker"; // ES Modules import + * // const { SageMakerClient, CreatePresignedDomainUrlCommand } = require("@aws-sdk/client-sagemaker"); // CommonJS import + * const client = new SageMakerClient(config); + * const command = new CreatePresignedDomainUrlCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreatePresignedDomainUrlCommandInput} for command's `input` shape. + * @see {@link CreatePresignedDomainUrlCommandOutput} for command's `response` shape. + * @see {@link SageMakerClientResolvedConfig | config} for command's `input` shape. + * */ export class CreatePresignedDomainUrlCommand extends $Command< CreatePresignedDomainUrlCommandInput, diff --git a/clients/client-sagemaker/commands/CreatePresignedNotebookInstanceUrlCommand.ts b/clients/client-sagemaker/commands/CreatePresignedNotebookInstanceUrlCommand.ts index d19ef07cc0df..477476223cdc 100644 --- a/clients/client-sagemaker/commands/CreatePresignedNotebookInstanceUrlCommand.ts +++ b/clients/client-sagemaker/commands/CreatePresignedNotebookInstanceUrlCommand.ts @@ -41,6 +41,20 @@ export interface CreatePresignedNotebookInstanceUrlCommandOutput * you try to use the URL after the 5-minute limit expires, you are directed to the * AWS console sign-in page.

* + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { SageMakerClient, CreatePresignedNotebookInstanceUrlCommand } from "@aws-sdk/client-sagemaker"; // ES Modules import + * // const { SageMakerClient, CreatePresignedNotebookInstanceUrlCommand } = require("@aws-sdk/client-sagemaker"); // CommonJS import + * const client = new SageMakerClient(config); + * const command = new CreatePresignedNotebookInstanceUrlCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreatePresignedNotebookInstanceUrlCommandInput} for command's `input` shape. + * @see {@link CreatePresignedNotebookInstanceUrlCommandOutput} for command's `response` shape. + * @see {@link SageMakerClientResolvedConfig | config} for command's `input` shape. + * */ export class CreatePresignedNotebookInstanceUrlCommand extends $Command< CreatePresignedNotebookInstanceUrlCommandInput, diff --git a/clients/client-sagemaker/commands/CreateProcessingJobCommand.ts b/clients/client-sagemaker/commands/CreateProcessingJobCommand.ts index 72041921d60e..d4f132b97630 100644 --- a/clients/client-sagemaker/commands/CreateProcessingJobCommand.ts +++ b/clients/client-sagemaker/commands/CreateProcessingJobCommand.ts @@ -22,6 +22,20 @@ export interface CreateProcessingJobCommandOutput extends CreateProcessingJobRes /** *

Creates a processing job.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { SageMakerClient, CreateProcessingJobCommand } from "@aws-sdk/client-sagemaker"; // ES Modules import + * // const { SageMakerClient, CreateProcessingJobCommand } = require("@aws-sdk/client-sagemaker"); // CommonJS import + * const client = new SageMakerClient(config); + * const command = new CreateProcessingJobCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreateProcessingJobCommandInput} for command's `input` shape. + * @see {@link CreateProcessingJobCommandOutput} for command's `response` shape. + * @see {@link SageMakerClientResolvedConfig | config} for command's `input` shape. + * */ export class CreateProcessingJobCommand extends $Command< CreateProcessingJobCommandInput, diff --git a/clients/client-sagemaker/commands/CreateProjectCommand.ts b/clients/client-sagemaker/commands/CreateProjectCommand.ts index 83a59fc011ee..1ee38abb405f 100644 --- a/clients/client-sagemaker/commands/CreateProjectCommand.ts +++ b/clients/client-sagemaker/commands/CreateProjectCommand.ts @@ -23,6 +23,20 @@ export interface CreateProjectCommandOutput extends CreateProjectOutput, __Metad /** *

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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { SageMakerClient, CreateProjectCommand } from "@aws-sdk/client-sagemaker"; // ES Modules import + * // const { SageMakerClient, CreateProjectCommand } = require("@aws-sdk/client-sagemaker"); // CommonJS import + * const client = new SageMakerClient(config); + * const command = new CreateProjectCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreateProjectCommandInput} for command's `input` shape. + * @see {@link CreateProjectCommandOutput} for command's `response` shape. + * @see {@link SageMakerClientResolvedConfig | config} for command's `input` shape. + * */ export class CreateProjectCommand extends $Command< CreateProjectCommandInput, diff --git a/clients/client-sagemaker/commands/CreateTrainingJobCommand.ts b/clients/client-sagemaker/commands/CreateTrainingJobCommand.ts index c3b3181aae65..bb53e8fd8b93 100644 --- a/clients/client-sagemaker/commands/CreateTrainingJobCommand.ts +++ b/clients/client-sagemaker/commands/CreateTrainingJobCommand.ts @@ -90,6 +90,20 @@ export interface CreateTrainingJobCommandOutput extends CreateTrainingJobRespons * * *

For more information about Amazon SageMaker, see How It Works.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { SageMakerClient, CreateTrainingJobCommand } from "@aws-sdk/client-sagemaker"; // ES Modules import + * // const { SageMakerClient, CreateTrainingJobCommand } = require("@aws-sdk/client-sagemaker"); // CommonJS import + * const client = new SageMakerClient(config); + * const command = new CreateTrainingJobCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreateTrainingJobCommandInput} for command's `input` shape. + * @see {@link CreateTrainingJobCommandOutput} for command's `response` shape. + * @see {@link SageMakerClientResolvedConfig | config} for command's `input` shape. + * */ export class CreateTrainingJobCommand extends $Command< CreateTrainingJobCommandInput, diff --git a/clients/client-sagemaker/commands/CreateTransformJobCommand.ts b/clients/client-sagemaker/commands/CreateTransformJobCommand.ts index 938b1a875e87..dc5c8d00c78a 100644 --- a/clients/client-sagemaker/commands/CreateTransformJobCommand.ts +++ b/clients/client-sagemaker/commands/CreateTransformJobCommand.ts @@ -56,6 +56,20 @@ export interface CreateTransformJobCommandOutput extends CreateTransformJobRespo * *

For more information about how batch transformation works, see Batch * Transform.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { SageMakerClient, CreateTransformJobCommand } from "@aws-sdk/client-sagemaker"; // ES Modules import + * // const { SageMakerClient, CreateTransformJobCommand } = require("@aws-sdk/client-sagemaker"); // CommonJS import + * const client = new SageMakerClient(config); + * const command = new CreateTransformJobCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreateTransformJobCommandInput} for command's `input` shape. + * @see {@link CreateTransformJobCommandOutput} for command's `response` shape. + * @see {@link SageMakerClientResolvedConfig | config} for command's `input` shape. + * */ export class CreateTransformJobCommand extends $Command< CreateTransformJobCommandInput, diff --git a/clients/client-sagemaker/commands/CreateTrialCommand.ts b/clients/client-sagemaker/commands/CreateTrialCommand.ts index df034afdacd7..5952c1a6fbd9 100644 --- a/clients/client-sagemaker/commands/CreateTrialCommand.ts +++ b/clients/client-sagemaker/commands/CreateTrialCommand.ts @@ -32,6 +32,20 @@ export interface CreateTrialCommandOutput extends CreateTrialResponse, __Metadat *

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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { SageMakerClient, CreateTrialCommand } from "@aws-sdk/client-sagemaker"; // ES Modules import + * // const { SageMakerClient, CreateTrialCommand } = require("@aws-sdk/client-sagemaker"); // CommonJS import + * const client = new SageMakerClient(config); + * const command = new CreateTrialCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreateTrialCommandInput} for command's `input` shape. + * @see {@link CreateTrialCommandOutput} for command's `response` shape. + * @see {@link SageMakerClientResolvedConfig | config} for command's `input` shape. + * */ export class CreateTrialCommand extends $Command< CreateTrialCommandInput, diff --git a/clients/client-sagemaker/commands/CreateTrialComponentCommand.ts b/clients/client-sagemaker/commands/CreateTrialComponentCommand.ts index c59fbabfb0de..409eb9479977 100644 --- a/clients/client-sagemaker/commands/CreateTrialComponentCommand.ts +++ b/clients/client-sagemaker/commands/CreateTrialComponentCommand.ts @@ -38,6 +38,20 @@ export interface CreateTrialComponentCommandOutput extends CreateTrialComponentR * notebooks. A call to CreateTrialComponent from outside one of these * environments results in an error.

* + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { SageMakerClient, CreateTrialComponentCommand } from "@aws-sdk/client-sagemaker"; // ES Modules import + * // const { SageMakerClient, CreateTrialComponentCommand } = require("@aws-sdk/client-sagemaker"); // CommonJS import + * const client = new SageMakerClient(config); + * const command = new CreateTrialComponentCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreateTrialComponentCommandInput} for command's `input` shape. + * @see {@link CreateTrialComponentCommandOutput} for command's `response` shape. + * @see {@link SageMakerClientResolvedConfig | config} for command's `input` shape. + * */ export class CreateTrialComponentCommand extends $Command< CreateTrialComponentCommandInput, diff --git a/clients/client-sagemaker/commands/CreateUserProfileCommand.ts b/clients/client-sagemaker/commands/CreateUserProfileCommand.ts index 2fc94051af2c..403bd8f65140 100644 --- a/clients/client-sagemaker/commands/CreateUserProfileCommand.ts +++ b/clients/client-sagemaker/commands/CreateUserProfileCommand.ts @@ -28,6 +28,20 @@ export interface CreateUserProfileCommandOutput extends CreateUserProfileRespons * 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. *

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { SageMakerClient, CreateUserProfileCommand } from "@aws-sdk/client-sagemaker"; // ES Modules import + * // const { SageMakerClient, CreateUserProfileCommand } = require("@aws-sdk/client-sagemaker"); // CommonJS import + * const client = new SageMakerClient(config); + * const command = new CreateUserProfileCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreateUserProfileCommandInput} for command's `input` shape. + * @see {@link CreateUserProfileCommandOutput} for command's `response` shape. + * @see {@link SageMakerClientResolvedConfig | config} for command's `input` shape. + * */ export class CreateUserProfileCommand extends $Command< CreateUserProfileCommandInput, diff --git a/clients/client-sagemaker/commands/CreateWorkforceCommand.ts b/clients/client-sagemaker/commands/CreateWorkforceCommand.ts index 1a8d33a86062..4a509baca198 100644 --- a/clients/client-sagemaker/commands/CreateWorkforceCommand.ts +++ b/clients/client-sagemaker/commands/CreateWorkforceCommand.ts @@ -42,6 +42,20 @@ export interface CreateWorkforceCommandOutput extends CreateWorkforceResponse, _ * because groups are used by Ground Truth and Amazon A2I to create work teams. * For more information, see * Create a Private Workforce (OIDC IdP).

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { SageMakerClient, CreateWorkforceCommand } from "@aws-sdk/client-sagemaker"; // ES Modules import + * // const { SageMakerClient, CreateWorkforceCommand } = require("@aws-sdk/client-sagemaker"); // CommonJS import + * const client = new SageMakerClient(config); + * const command = new CreateWorkforceCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreateWorkforceCommandInput} for command's `input` shape. + * @see {@link CreateWorkforceCommandOutput} for command's `response` shape. + * @see {@link SageMakerClientResolvedConfig | config} for command's `input` shape. + * */ export class CreateWorkforceCommand extends $Command< CreateWorkforceCommandInput, diff --git a/clients/client-sagemaker/commands/CreateWorkteamCommand.ts b/clients/client-sagemaker/commands/CreateWorkteamCommand.ts index 8543b85b2d8b..8fbd9657396d 100644 --- a/clients/client-sagemaker/commands/CreateWorkteamCommand.ts +++ b/clients/client-sagemaker/commands/CreateWorkteamCommand.ts @@ -25,6 +25,20 @@ export interface CreateWorkteamCommandOutput extends CreateWorkteamResponse, __M * 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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { SageMakerClient, CreateWorkteamCommand } from "@aws-sdk/client-sagemaker"; // ES Modules import + * // const { SageMakerClient, CreateWorkteamCommand } = require("@aws-sdk/client-sagemaker"); // CommonJS import + * const client = new SageMakerClient(config); + * const command = new CreateWorkteamCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreateWorkteamCommandInput} for command's `input` shape. + * @see {@link CreateWorkteamCommandOutput} for command's `response` shape. + * @see {@link SageMakerClientResolvedConfig | config} for command's `input` shape. + * */ export class CreateWorkteamCommand extends $Command< CreateWorkteamCommandInput, diff --git a/clients/client-sagemaker/commands/DeleteActionCommand.ts b/clients/client-sagemaker/commands/DeleteActionCommand.ts index 923c7324382b..784ec138827c 100644 --- a/clients/client-sagemaker/commands/DeleteActionCommand.ts +++ b/clients/client-sagemaker/commands/DeleteActionCommand.ts @@ -22,6 +22,20 @@ export interface DeleteActionCommandOutput extends DeleteActionResponse, __Metad /** *

Deletes an action.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { SageMakerClient, DeleteActionCommand } from "@aws-sdk/client-sagemaker"; // ES Modules import + * // const { SageMakerClient, DeleteActionCommand } = require("@aws-sdk/client-sagemaker"); // CommonJS import + * const client = new SageMakerClient(config); + * const command = new DeleteActionCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteActionCommandInput} for command's `input` shape. + * @see {@link DeleteActionCommandOutput} for command's `response` shape. + * @see {@link SageMakerClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteActionCommand extends $Command< DeleteActionCommandInput, diff --git a/clients/client-sagemaker/commands/DeleteAlgorithmCommand.ts b/clients/client-sagemaker/commands/DeleteAlgorithmCommand.ts index 42e0e5baab0f..3b86505d0a15 100644 --- a/clients/client-sagemaker/commands/DeleteAlgorithmCommand.ts +++ b/clients/client-sagemaker/commands/DeleteAlgorithmCommand.ts @@ -22,6 +22,20 @@ export interface DeleteAlgorithmCommandOutput extends __MetadataBearer {} /** *

Removes the specified algorithm from your account.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { SageMakerClient, DeleteAlgorithmCommand } from "@aws-sdk/client-sagemaker"; // ES Modules import + * // const { SageMakerClient, DeleteAlgorithmCommand } = require("@aws-sdk/client-sagemaker"); // CommonJS import + * const client = new SageMakerClient(config); + * const command = new DeleteAlgorithmCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteAlgorithmCommandInput} for command's `input` shape. + * @see {@link DeleteAlgorithmCommandOutput} for command's `response` shape. + * @see {@link SageMakerClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteAlgorithmCommand extends $Command< DeleteAlgorithmCommandInput, diff --git a/clients/client-sagemaker/commands/DeleteAppCommand.ts b/clients/client-sagemaker/commands/DeleteAppCommand.ts index 915eb47b4e5b..d3d3223f43b7 100644 --- a/clients/client-sagemaker/commands/DeleteAppCommand.ts +++ b/clients/client-sagemaker/commands/DeleteAppCommand.ts @@ -19,6 +19,20 @@ export interface DeleteAppCommandOutput extends __MetadataBearer {} /** *

Used to stop and delete an app.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { SageMakerClient, DeleteAppCommand } from "@aws-sdk/client-sagemaker"; // ES Modules import + * // const { SageMakerClient, DeleteAppCommand } = require("@aws-sdk/client-sagemaker"); // CommonJS import + * const client = new SageMakerClient(config); + * const command = new DeleteAppCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteAppCommandInput} for command's `input` shape. + * @see {@link DeleteAppCommandOutput} for command's `response` shape. + * @see {@link SageMakerClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteAppCommand extends $Command< DeleteAppCommandInput, diff --git a/clients/client-sagemaker/commands/DeleteAppImageConfigCommand.ts b/clients/client-sagemaker/commands/DeleteAppImageConfigCommand.ts index 4e22ef77cd53..1df768b02dcb 100644 --- a/clients/client-sagemaker/commands/DeleteAppImageConfigCommand.ts +++ b/clients/client-sagemaker/commands/DeleteAppImageConfigCommand.ts @@ -22,6 +22,20 @@ export interface DeleteAppImageConfigCommandOutput extends __MetadataBearer {} /** *

Deletes an AppImageConfig.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { SageMakerClient, DeleteAppImageConfigCommand } from "@aws-sdk/client-sagemaker"; // ES Modules import + * // const { SageMakerClient, DeleteAppImageConfigCommand } = require("@aws-sdk/client-sagemaker"); // CommonJS import + * const client = new SageMakerClient(config); + * const command = new DeleteAppImageConfigCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteAppImageConfigCommandInput} for command's `input` shape. + * @see {@link DeleteAppImageConfigCommandOutput} for command's `response` shape. + * @see {@link SageMakerClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteAppImageConfigCommand extends $Command< DeleteAppImageConfigCommandInput, diff --git a/clients/client-sagemaker/commands/DeleteArtifactCommand.ts b/clients/client-sagemaker/commands/DeleteArtifactCommand.ts index d116f7d2d579..89f3b2089961 100644 --- a/clients/client-sagemaker/commands/DeleteArtifactCommand.ts +++ b/clients/client-sagemaker/commands/DeleteArtifactCommand.ts @@ -23,6 +23,20 @@ export interface DeleteArtifactCommandOutput extends DeleteArtifactResponse, __M /** *

Deletes an artifact. Either ArtifactArn or Source must be * specified.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { SageMakerClient, DeleteArtifactCommand } from "@aws-sdk/client-sagemaker"; // ES Modules import + * // const { SageMakerClient, DeleteArtifactCommand } = require("@aws-sdk/client-sagemaker"); // CommonJS import + * const client = new SageMakerClient(config); + * const command = new DeleteArtifactCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteArtifactCommandInput} for command's `input` shape. + * @see {@link DeleteArtifactCommandOutput} for command's `response` shape. + * @see {@link SageMakerClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteArtifactCommand extends $Command< DeleteArtifactCommandInput, diff --git a/clients/client-sagemaker/commands/DeleteAssociationCommand.ts b/clients/client-sagemaker/commands/DeleteAssociationCommand.ts index 20148260d08d..e8a53301071b 100644 --- a/clients/client-sagemaker/commands/DeleteAssociationCommand.ts +++ b/clients/client-sagemaker/commands/DeleteAssociationCommand.ts @@ -22,6 +22,20 @@ export interface DeleteAssociationCommandOutput extends DeleteAssociationRespons /** *

Deletes an association.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { SageMakerClient, DeleteAssociationCommand } from "@aws-sdk/client-sagemaker"; // ES Modules import + * // const { SageMakerClient, DeleteAssociationCommand } = require("@aws-sdk/client-sagemaker"); // CommonJS import + * const client = new SageMakerClient(config); + * const command = new DeleteAssociationCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteAssociationCommandInput} for command's `input` shape. + * @see {@link DeleteAssociationCommandOutput} for command's `response` shape. + * @see {@link SageMakerClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteAssociationCommand extends $Command< DeleteAssociationCommandInput, diff --git a/clients/client-sagemaker/commands/DeleteCodeRepositoryCommand.ts b/clients/client-sagemaker/commands/DeleteCodeRepositoryCommand.ts index 311976d3f4c9..fe8c75b9d625 100644 --- a/clients/client-sagemaker/commands/DeleteCodeRepositoryCommand.ts +++ b/clients/client-sagemaker/commands/DeleteCodeRepositoryCommand.ts @@ -22,6 +22,20 @@ export interface DeleteCodeRepositoryCommandOutput extends __MetadataBearer {} /** *

Deletes the specified Git repository from your account.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { SageMakerClient, DeleteCodeRepositoryCommand } from "@aws-sdk/client-sagemaker"; // ES Modules import + * // const { SageMakerClient, DeleteCodeRepositoryCommand } = require("@aws-sdk/client-sagemaker"); // CommonJS import + * const client = new SageMakerClient(config); + * const command = new DeleteCodeRepositoryCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteCodeRepositoryCommandInput} for command's `input` shape. + * @see {@link DeleteCodeRepositoryCommandOutput} for command's `response` shape. + * @see {@link SageMakerClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteCodeRepositoryCommand extends $Command< DeleteCodeRepositoryCommandInput, diff --git a/clients/client-sagemaker/commands/DeleteContextCommand.ts b/clients/client-sagemaker/commands/DeleteContextCommand.ts index fa9e0b12f84d..334c7c035a5e 100644 --- a/clients/client-sagemaker/commands/DeleteContextCommand.ts +++ b/clients/client-sagemaker/commands/DeleteContextCommand.ts @@ -22,6 +22,20 @@ export interface DeleteContextCommandOutput extends DeleteContextResponse, __Met /** *

Deletes an context.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { SageMakerClient, DeleteContextCommand } from "@aws-sdk/client-sagemaker"; // ES Modules import + * // const { SageMakerClient, DeleteContextCommand } = require("@aws-sdk/client-sagemaker"); // CommonJS import + * const client = new SageMakerClient(config); + * const command = new DeleteContextCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteContextCommandInput} for command's `input` shape. + * @see {@link DeleteContextCommandOutput} for command's `response` shape. + * @see {@link SageMakerClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteContextCommand extends $Command< DeleteContextCommandInput, diff --git a/clients/client-sagemaker/commands/DeleteDataQualityJobDefinitionCommand.ts b/clients/client-sagemaker/commands/DeleteDataQualityJobDefinitionCommand.ts index 491573546182..e14044e58a5f 100644 --- a/clients/client-sagemaker/commands/DeleteDataQualityJobDefinitionCommand.ts +++ b/clients/client-sagemaker/commands/DeleteDataQualityJobDefinitionCommand.ts @@ -22,6 +22,20 @@ export interface DeleteDataQualityJobDefinitionCommandOutput extends __MetadataB /** *

Deletes a data quality monitoring job definition.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { SageMakerClient, DeleteDataQualityJobDefinitionCommand } from "@aws-sdk/client-sagemaker"; // ES Modules import + * // const { SageMakerClient, DeleteDataQualityJobDefinitionCommand } = require("@aws-sdk/client-sagemaker"); // CommonJS import + * const client = new SageMakerClient(config); + * const command = new DeleteDataQualityJobDefinitionCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteDataQualityJobDefinitionCommandInput} for command's `input` shape. + * @see {@link DeleteDataQualityJobDefinitionCommandOutput} for command's `response` shape. + * @see {@link SageMakerClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteDataQualityJobDefinitionCommand extends $Command< DeleteDataQualityJobDefinitionCommandInput, diff --git a/clients/client-sagemaker/commands/DeleteDeviceFleetCommand.ts b/clients/client-sagemaker/commands/DeleteDeviceFleetCommand.ts index 65a74898d344..ea929d422570 100644 --- a/clients/client-sagemaker/commands/DeleteDeviceFleetCommand.ts +++ b/clients/client-sagemaker/commands/DeleteDeviceFleetCommand.ts @@ -22,6 +22,20 @@ export interface DeleteDeviceFleetCommandOutput extends __MetadataBearer {} /** *

Deletes a fleet.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { SageMakerClient, DeleteDeviceFleetCommand } from "@aws-sdk/client-sagemaker"; // ES Modules import + * // const { SageMakerClient, DeleteDeviceFleetCommand } = require("@aws-sdk/client-sagemaker"); // CommonJS import + * const client = new SageMakerClient(config); + * const command = new DeleteDeviceFleetCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteDeviceFleetCommandInput} for command's `input` shape. + * @see {@link DeleteDeviceFleetCommandOutput} for command's `response` shape. + * @see {@link SageMakerClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteDeviceFleetCommand extends $Command< DeleteDeviceFleetCommandInput, diff --git a/clients/client-sagemaker/commands/DeleteDomainCommand.ts b/clients/client-sagemaker/commands/DeleteDomainCommand.ts index dbbcbefbf328..9209feeef750 100644 --- a/clients/client-sagemaker/commands/DeleteDomainCommand.ts +++ b/clients/client-sagemaker/commands/DeleteDomainCommand.ts @@ -26,6 +26,20 @@ export interface DeleteDomainCommandOutput extends __MetadataBearer {} * Use with caution. All of the members of the domain will lose access to their EFS volume, * including data, notebooks, and other artifacts. *

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { SageMakerClient, DeleteDomainCommand } from "@aws-sdk/client-sagemaker"; // ES Modules import + * // const { SageMakerClient, DeleteDomainCommand } = require("@aws-sdk/client-sagemaker"); // CommonJS import + * const client = new SageMakerClient(config); + * const command = new DeleteDomainCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteDomainCommandInput} for command's `input` shape. + * @see {@link DeleteDomainCommandOutput} for command's `response` shape. + * @see {@link SageMakerClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteDomainCommand extends $Command< DeleteDomainCommandInput, diff --git a/clients/client-sagemaker/commands/DeleteEndpointCommand.ts b/clients/client-sagemaker/commands/DeleteEndpointCommand.ts index 1e9ad326510e..8171d7b09ba6 100644 --- a/clients/client-sagemaker/commands/DeleteEndpointCommand.ts +++ b/clients/client-sagemaker/commands/DeleteEndpointCommand.ts @@ -25,6 +25,20 @@ export interface DeleteEndpointCommandOutput extends __MetadataBearer {} * endpoint was created.

*

Amazon SageMaker retires any custom KMS key grants associated with the endpoint, meaning you don't * need to use the RevokeGrant API call.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { SageMakerClient, DeleteEndpointCommand } from "@aws-sdk/client-sagemaker"; // ES Modules import + * // const { SageMakerClient, DeleteEndpointCommand } = require("@aws-sdk/client-sagemaker"); // CommonJS import + * const client = new SageMakerClient(config); + * const command = new DeleteEndpointCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteEndpointCommandInput} for command's `input` shape. + * @see {@link DeleteEndpointCommandOutput} for command's `response` shape. + * @see {@link SageMakerClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteEndpointCommand extends $Command< DeleteEndpointCommandInput, diff --git a/clients/client-sagemaker/commands/DeleteEndpointConfigCommand.ts b/clients/client-sagemaker/commands/DeleteEndpointConfigCommand.ts index 897d45200e94..cad549d3269e 100644 --- a/clients/client-sagemaker/commands/DeleteEndpointConfigCommand.ts +++ b/clients/client-sagemaker/commands/DeleteEndpointConfigCommand.ts @@ -30,6 +30,20 @@ export interface DeleteEndpointConfigCommandOutput extends __MetadataBearer {} * 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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { SageMakerClient, DeleteEndpointConfigCommand } from "@aws-sdk/client-sagemaker"; // ES Modules import + * // const { SageMakerClient, DeleteEndpointConfigCommand } = require("@aws-sdk/client-sagemaker"); // CommonJS import + * const client = new SageMakerClient(config); + * const command = new DeleteEndpointConfigCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteEndpointConfigCommandInput} for command's `input` shape. + * @see {@link DeleteEndpointConfigCommandOutput} for command's `response` shape. + * @see {@link SageMakerClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteEndpointConfigCommand extends $Command< DeleteEndpointConfigCommandInput, diff --git a/clients/client-sagemaker/commands/DeleteExperimentCommand.ts b/clients/client-sagemaker/commands/DeleteExperimentCommand.ts index 2fd36139dfc3..204adec31916 100644 --- a/clients/client-sagemaker/commands/DeleteExperimentCommand.ts +++ b/clients/client-sagemaker/commands/DeleteExperimentCommand.ts @@ -24,6 +24,20 @@ export interface DeleteExperimentCommandOutput extends DeleteExperimentResponse, *

Deletes an Amazon 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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { SageMakerClient, DeleteExperimentCommand } from "@aws-sdk/client-sagemaker"; // ES Modules import + * // const { SageMakerClient, DeleteExperimentCommand } = require("@aws-sdk/client-sagemaker"); // CommonJS import + * const client = new SageMakerClient(config); + * const command = new DeleteExperimentCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteExperimentCommandInput} for command's `input` shape. + * @see {@link DeleteExperimentCommandOutput} for command's `response` shape. + * @see {@link SageMakerClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteExperimentCommand extends $Command< DeleteExperimentCommandInput, diff --git a/clients/client-sagemaker/commands/DeleteFeatureGroupCommand.ts b/clients/client-sagemaker/commands/DeleteFeatureGroupCommand.ts index ada3e30303c5..1904728bd4bb 100644 --- a/clients/client-sagemaker/commands/DeleteFeatureGroupCommand.ts +++ b/clients/client-sagemaker/commands/DeleteFeatureGroupCommand.ts @@ -27,6 +27,20 @@ export interface DeleteFeatureGroupCommandOutput extends __MetadataBearer {} *

Data written into the OfflineStore will not be deleted. The AWS Glue * database and tables that are automatically created for your OfflineStore are * not deleted.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { SageMakerClient, DeleteFeatureGroupCommand } from "@aws-sdk/client-sagemaker"; // ES Modules import + * // const { SageMakerClient, DeleteFeatureGroupCommand } = require("@aws-sdk/client-sagemaker"); // CommonJS import + * const client = new SageMakerClient(config); + * const command = new DeleteFeatureGroupCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteFeatureGroupCommandInput} for command's `input` shape. + * @see {@link DeleteFeatureGroupCommandOutput} for command's `response` shape. + * @see {@link SageMakerClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteFeatureGroupCommand extends $Command< DeleteFeatureGroupCommandInput, diff --git a/clients/client-sagemaker/commands/DeleteFlowDefinitionCommand.ts b/clients/client-sagemaker/commands/DeleteFlowDefinitionCommand.ts index b82dc71db531..27bfe63f48b5 100644 --- a/clients/client-sagemaker/commands/DeleteFlowDefinitionCommand.ts +++ b/clients/client-sagemaker/commands/DeleteFlowDefinitionCommand.ts @@ -22,6 +22,20 @@ export interface DeleteFlowDefinitionCommandOutput extends DeleteFlowDefinitionR /** *

Deletes the specified flow definition.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { SageMakerClient, DeleteFlowDefinitionCommand } from "@aws-sdk/client-sagemaker"; // ES Modules import + * // const { SageMakerClient, DeleteFlowDefinitionCommand } = require("@aws-sdk/client-sagemaker"); // CommonJS import + * const client = new SageMakerClient(config); + * const command = new DeleteFlowDefinitionCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteFlowDefinitionCommandInput} for command's `input` shape. + * @see {@link DeleteFlowDefinitionCommandOutput} for command's `response` shape. + * @see {@link SageMakerClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteFlowDefinitionCommand extends $Command< DeleteFlowDefinitionCommandInput, diff --git a/clients/client-sagemaker/commands/DeleteHumanTaskUiCommand.ts b/clients/client-sagemaker/commands/DeleteHumanTaskUiCommand.ts index 6084886951b4..6d3b87a464a7 100644 --- a/clients/client-sagemaker/commands/DeleteHumanTaskUiCommand.ts +++ b/clients/client-sagemaker/commands/DeleteHumanTaskUiCommand.ts @@ -26,6 +26,20 @@ export interface DeleteHumanTaskUiCommandOutput extends DeleteHumanTaskUiRespons * 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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { SageMakerClient, DeleteHumanTaskUiCommand } from "@aws-sdk/client-sagemaker"; // ES Modules import + * // const { SageMakerClient, DeleteHumanTaskUiCommand } = require("@aws-sdk/client-sagemaker"); // CommonJS import + * const client = new SageMakerClient(config); + * const command = new DeleteHumanTaskUiCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteHumanTaskUiCommandInput} for command's `input` shape. + * @see {@link DeleteHumanTaskUiCommandOutput} for command's `response` shape. + * @see {@link SageMakerClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteHumanTaskUiCommand extends $Command< DeleteHumanTaskUiCommandInput, diff --git a/clients/client-sagemaker/commands/DeleteImageCommand.ts b/clients/client-sagemaker/commands/DeleteImageCommand.ts index 4a98796afbef..5532801d32cc 100644 --- a/clients/client-sagemaker/commands/DeleteImageCommand.ts +++ b/clients/client-sagemaker/commands/DeleteImageCommand.ts @@ -23,6 +23,20 @@ export interface DeleteImageCommandOutput extends DeleteImageResponse, __Metadat /** *

Deletes a SageMaker image and all versions of the image. The container images aren't * deleted.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { SageMakerClient, DeleteImageCommand } from "@aws-sdk/client-sagemaker"; // ES Modules import + * // const { SageMakerClient, DeleteImageCommand } = require("@aws-sdk/client-sagemaker"); // CommonJS import + * const client = new SageMakerClient(config); + * const command = new DeleteImageCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteImageCommandInput} for command's `input` shape. + * @see {@link DeleteImageCommandOutput} for command's `response` shape. + * @see {@link SageMakerClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteImageCommand extends $Command< DeleteImageCommandInput, diff --git a/clients/client-sagemaker/commands/DeleteImageVersionCommand.ts b/clients/client-sagemaker/commands/DeleteImageVersionCommand.ts index 47ec8aa062b6..a5f86c5f5db7 100644 --- a/clients/client-sagemaker/commands/DeleteImageVersionCommand.ts +++ b/clients/client-sagemaker/commands/DeleteImageVersionCommand.ts @@ -23,6 +23,20 @@ export interface DeleteImageVersionCommandOutput extends DeleteImageVersionRespo /** *

Deletes a version of a SageMaker image. The container image the version represents isn't * deleted.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { SageMakerClient, DeleteImageVersionCommand } from "@aws-sdk/client-sagemaker"; // ES Modules import + * // const { SageMakerClient, DeleteImageVersionCommand } = require("@aws-sdk/client-sagemaker"); // CommonJS import + * const client = new SageMakerClient(config); + * const command = new DeleteImageVersionCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteImageVersionCommandInput} for command's `input` shape. + * @see {@link DeleteImageVersionCommandOutput} for command's `response` shape. + * @see {@link SageMakerClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteImageVersionCommand extends $Command< DeleteImageVersionCommandInput, diff --git a/clients/client-sagemaker/commands/DeleteModelBiasJobDefinitionCommand.ts b/clients/client-sagemaker/commands/DeleteModelBiasJobDefinitionCommand.ts index 4afe5579d0c8..8366fcc14367 100644 --- a/clients/client-sagemaker/commands/DeleteModelBiasJobDefinitionCommand.ts +++ b/clients/client-sagemaker/commands/DeleteModelBiasJobDefinitionCommand.ts @@ -22,6 +22,20 @@ export interface DeleteModelBiasJobDefinitionCommandOutput extends __MetadataBea /** *

Deletes an Amazon SageMaker model bias job definition.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { SageMakerClient, DeleteModelBiasJobDefinitionCommand } from "@aws-sdk/client-sagemaker"; // ES Modules import + * // const { SageMakerClient, DeleteModelBiasJobDefinitionCommand } = require("@aws-sdk/client-sagemaker"); // CommonJS import + * const client = new SageMakerClient(config); + * const command = new DeleteModelBiasJobDefinitionCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteModelBiasJobDefinitionCommandInput} for command's `input` shape. + * @see {@link DeleteModelBiasJobDefinitionCommandOutput} for command's `response` shape. + * @see {@link SageMakerClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteModelBiasJobDefinitionCommand extends $Command< DeleteModelBiasJobDefinitionCommandInput, diff --git a/clients/client-sagemaker/commands/DeleteModelCommand.ts b/clients/client-sagemaker/commands/DeleteModelCommand.ts index a43ef764b89d..516185226105 100644 --- a/clients/client-sagemaker/commands/DeleteModelCommand.ts +++ b/clients/client-sagemaker/commands/DeleteModelCommand.ts @@ -25,6 +25,20 @@ export interface DeleteModelCommandOutput extends __MetadataBearer {} * was created in Amazon 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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { SageMakerClient, DeleteModelCommand } from "@aws-sdk/client-sagemaker"; // ES Modules import + * // const { SageMakerClient, DeleteModelCommand } = require("@aws-sdk/client-sagemaker"); // CommonJS import + * const client = new SageMakerClient(config); + * const command = new DeleteModelCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteModelCommandInput} for command's `input` shape. + * @see {@link DeleteModelCommandOutput} for command's `response` shape. + * @see {@link SageMakerClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteModelCommand extends $Command< DeleteModelCommandInput, diff --git a/clients/client-sagemaker/commands/DeleteModelExplainabilityJobDefinitionCommand.ts b/clients/client-sagemaker/commands/DeleteModelExplainabilityJobDefinitionCommand.ts index 29728bb149d4..178c8c44a3b9 100644 --- a/clients/client-sagemaker/commands/DeleteModelExplainabilityJobDefinitionCommand.ts +++ b/clients/client-sagemaker/commands/DeleteModelExplainabilityJobDefinitionCommand.ts @@ -23,6 +23,20 @@ export interface DeleteModelExplainabilityJobDefinitionCommandOutput extends __M /** *

Deletes an Amazon SageMaker model explainability job definition.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { SageMakerClient, DeleteModelExplainabilityJobDefinitionCommand } from "@aws-sdk/client-sagemaker"; // ES Modules import + * // const { SageMakerClient, DeleteModelExplainabilityJobDefinitionCommand } = require("@aws-sdk/client-sagemaker"); // CommonJS import + * const client = new SageMakerClient(config); + * const command = new DeleteModelExplainabilityJobDefinitionCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteModelExplainabilityJobDefinitionCommandInput} for command's `input` shape. + * @see {@link DeleteModelExplainabilityJobDefinitionCommandOutput} for command's `response` shape. + * @see {@link SageMakerClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteModelExplainabilityJobDefinitionCommand extends $Command< DeleteModelExplainabilityJobDefinitionCommandInput, diff --git a/clients/client-sagemaker/commands/DeleteModelPackageCommand.ts b/clients/client-sagemaker/commands/DeleteModelPackageCommand.ts index 9d3b1cfa58ad..eb093d7722ce 100644 --- a/clients/client-sagemaker/commands/DeleteModelPackageCommand.ts +++ b/clients/client-sagemaker/commands/DeleteModelPackageCommand.ts @@ -24,6 +24,20 @@ export interface DeleteModelPackageCommandOutput extends __MetadataBearer {} *

Deletes a model package.

*

A model package is used to create Amazon SageMaker models or list on AWS Marketplace. Buyers can * subscribe to model packages listed on AWS Marketplace to create models in Amazon SageMaker.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { SageMakerClient, DeleteModelPackageCommand } from "@aws-sdk/client-sagemaker"; // ES Modules import + * // const { SageMakerClient, DeleteModelPackageCommand } = require("@aws-sdk/client-sagemaker"); // CommonJS import + * const client = new SageMakerClient(config); + * const command = new DeleteModelPackageCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteModelPackageCommandInput} for command's `input` shape. + * @see {@link DeleteModelPackageCommandOutput} for command's `response` shape. + * @see {@link SageMakerClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteModelPackageCommand extends $Command< DeleteModelPackageCommandInput, diff --git a/clients/client-sagemaker/commands/DeleteModelPackageGroupCommand.ts b/clients/client-sagemaker/commands/DeleteModelPackageGroupCommand.ts index a9b43e223391..08c05e99b64b 100644 --- a/clients/client-sagemaker/commands/DeleteModelPackageGroupCommand.ts +++ b/clients/client-sagemaker/commands/DeleteModelPackageGroupCommand.ts @@ -22,6 +22,20 @@ export interface DeleteModelPackageGroupCommandOutput extends __MetadataBearer { /** *

Deletes the specified model group.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { SageMakerClient, DeleteModelPackageGroupCommand } from "@aws-sdk/client-sagemaker"; // ES Modules import + * // const { SageMakerClient, DeleteModelPackageGroupCommand } = require("@aws-sdk/client-sagemaker"); // CommonJS import + * const client = new SageMakerClient(config); + * const command = new DeleteModelPackageGroupCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteModelPackageGroupCommandInput} for command's `input` shape. + * @see {@link DeleteModelPackageGroupCommandOutput} for command's `response` shape. + * @see {@link SageMakerClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteModelPackageGroupCommand extends $Command< DeleteModelPackageGroupCommandInput, diff --git a/clients/client-sagemaker/commands/DeleteModelPackageGroupPolicyCommand.ts b/clients/client-sagemaker/commands/DeleteModelPackageGroupPolicyCommand.ts index c10ce530fa9f..97f9ec4742dd 100644 --- a/clients/client-sagemaker/commands/DeleteModelPackageGroupPolicyCommand.ts +++ b/clients/client-sagemaker/commands/DeleteModelPackageGroupPolicyCommand.ts @@ -22,6 +22,20 @@ export interface DeleteModelPackageGroupPolicyCommandOutput extends __MetadataBe /** *

Deletes a model group resource policy.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { SageMakerClient, DeleteModelPackageGroupPolicyCommand } from "@aws-sdk/client-sagemaker"; // ES Modules import + * // const { SageMakerClient, DeleteModelPackageGroupPolicyCommand } = require("@aws-sdk/client-sagemaker"); // CommonJS import + * const client = new SageMakerClient(config); + * const command = new DeleteModelPackageGroupPolicyCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteModelPackageGroupPolicyCommandInput} for command's `input` shape. + * @see {@link DeleteModelPackageGroupPolicyCommandOutput} for command's `response` shape. + * @see {@link SageMakerClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteModelPackageGroupPolicyCommand extends $Command< DeleteModelPackageGroupPolicyCommandInput, diff --git a/clients/client-sagemaker/commands/DeleteModelQualityJobDefinitionCommand.ts b/clients/client-sagemaker/commands/DeleteModelQualityJobDefinitionCommand.ts index 412e24bf7f16..683b593e9f7a 100644 --- a/clients/client-sagemaker/commands/DeleteModelQualityJobDefinitionCommand.ts +++ b/clients/client-sagemaker/commands/DeleteModelQualityJobDefinitionCommand.ts @@ -22,6 +22,20 @@ export interface DeleteModelQualityJobDefinitionCommandOutput extends __Metadata /** *

Deletes the secified model quality monitoring job definition.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { SageMakerClient, DeleteModelQualityJobDefinitionCommand } from "@aws-sdk/client-sagemaker"; // ES Modules import + * // const { SageMakerClient, DeleteModelQualityJobDefinitionCommand } = require("@aws-sdk/client-sagemaker"); // CommonJS import + * const client = new SageMakerClient(config); + * const command = new DeleteModelQualityJobDefinitionCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteModelQualityJobDefinitionCommandInput} for command's `input` shape. + * @see {@link DeleteModelQualityJobDefinitionCommandOutput} for command's `response` shape. + * @see {@link SageMakerClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteModelQualityJobDefinitionCommand extends $Command< DeleteModelQualityJobDefinitionCommandInput, diff --git a/clients/client-sagemaker/commands/DeleteMonitoringScheduleCommand.ts b/clients/client-sagemaker/commands/DeleteMonitoringScheduleCommand.ts index ebb91ceb3ada..f56f8d481faf 100644 --- a/clients/client-sagemaker/commands/DeleteMonitoringScheduleCommand.ts +++ b/clients/client-sagemaker/commands/DeleteMonitoringScheduleCommand.ts @@ -23,6 +23,20 @@ export interface DeleteMonitoringScheduleCommandOutput extends __MetadataBearer /** *

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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { SageMakerClient, DeleteMonitoringScheduleCommand } from "@aws-sdk/client-sagemaker"; // ES Modules import + * // const { SageMakerClient, DeleteMonitoringScheduleCommand } = require("@aws-sdk/client-sagemaker"); // CommonJS import + * const client = new SageMakerClient(config); + * const command = new DeleteMonitoringScheduleCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteMonitoringScheduleCommandInput} for command's `input` shape. + * @see {@link DeleteMonitoringScheduleCommandOutput} for command's `response` shape. + * @see {@link SageMakerClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteMonitoringScheduleCommand extends $Command< DeleteMonitoringScheduleCommandInput, diff --git a/clients/client-sagemaker/commands/DeleteNotebookInstanceCommand.ts b/clients/client-sagemaker/commands/DeleteNotebookInstanceCommand.ts index de9541ac696c..5b589bd6d7cd 100644 --- a/clients/client-sagemaker/commands/DeleteNotebookInstanceCommand.ts +++ b/clients/client-sagemaker/commands/DeleteNotebookInstanceCommand.ts @@ -28,6 +28,20 @@ export interface DeleteNotebookInstanceCommandOutput extends __MetadataBearer {} * the ML compute instance, and deletes the ML storage volume and the network interface * associated with the notebook instance.

* + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { SageMakerClient, DeleteNotebookInstanceCommand } from "@aws-sdk/client-sagemaker"; // ES Modules import + * // const { SageMakerClient, DeleteNotebookInstanceCommand } = require("@aws-sdk/client-sagemaker"); // CommonJS import + * const client = new SageMakerClient(config); + * const command = new DeleteNotebookInstanceCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteNotebookInstanceCommandInput} for command's `input` shape. + * @see {@link DeleteNotebookInstanceCommandOutput} for command's `response` shape. + * @see {@link SageMakerClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteNotebookInstanceCommand extends $Command< DeleteNotebookInstanceCommandInput, diff --git a/clients/client-sagemaker/commands/DeleteNotebookInstanceLifecycleConfigCommand.ts b/clients/client-sagemaker/commands/DeleteNotebookInstanceLifecycleConfigCommand.ts index 32f4426e00be..3f84f6e6e229 100644 --- a/clients/client-sagemaker/commands/DeleteNotebookInstanceLifecycleConfigCommand.ts +++ b/clients/client-sagemaker/commands/DeleteNotebookInstanceLifecycleConfigCommand.ts @@ -22,6 +22,20 @@ export interface DeleteNotebookInstanceLifecycleConfigCommandOutput extends __Me /** *

Deletes a notebook instance lifecycle configuration.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { SageMakerClient, DeleteNotebookInstanceLifecycleConfigCommand } from "@aws-sdk/client-sagemaker"; // ES Modules import + * // const { SageMakerClient, DeleteNotebookInstanceLifecycleConfigCommand } = require("@aws-sdk/client-sagemaker"); // CommonJS import + * const client = new SageMakerClient(config); + * const command = new DeleteNotebookInstanceLifecycleConfigCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteNotebookInstanceLifecycleConfigCommandInput} for command's `input` shape. + * @see {@link DeleteNotebookInstanceLifecycleConfigCommandOutput} for command's `response` shape. + * @see {@link SageMakerClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteNotebookInstanceLifecycleConfigCommand extends $Command< DeleteNotebookInstanceLifecycleConfigCommandInput, diff --git a/clients/client-sagemaker/commands/DeletePipelineCommand.ts b/clients/client-sagemaker/commands/DeletePipelineCommand.ts index 3c3fcd56ebc5..a127bd76fe71 100644 --- a/clients/client-sagemaker/commands/DeletePipelineCommand.ts +++ b/clients/client-sagemaker/commands/DeletePipelineCommand.ts @@ -22,6 +22,20 @@ export interface DeletePipelineCommandOutput extends DeletePipelineResponse, __M /** *

Deletes a pipeline if there are no in-progress executions.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { SageMakerClient, DeletePipelineCommand } from "@aws-sdk/client-sagemaker"; // ES Modules import + * // const { SageMakerClient, DeletePipelineCommand } = require("@aws-sdk/client-sagemaker"); // CommonJS import + * const client = new SageMakerClient(config); + * const command = new DeletePipelineCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeletePipelineCommandInput} for command's `input` shape. + * @see {@link DeletePipelineCommandOutput} for command's `response` shape. + * @see {@link SageMakerClientResolvedConfig | config} for command's `input` shape. + * */ export class DeletePipelineCommand extends $Command< DeletePipelineCommandInput, diff --git a/clients/client-sagemaker/commands/DeleteProjectCommand.ts b/clients/client-sagemaker/commands/DeleteProjectCommand.ts index b963cf2b084b..719ecc8a11c4 100644 --- a/clients/client-sagemaker/commands/DeleteProjectCommand.ts +++ b/clients/client-sagemaker/commands/DeleteProjectCommand.ts @@ -22,6 +22,20 @@ export interface DeleteProjectCommandOutput extends __MetadataBearer {} /** *

Delete the specified project.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { SageMakerClient, DeleteProjectCommand } from "@aws-sdk/client-sagemaker"; // ES Modules import + * // const { SageMakerClient, DeleteProjectCommand } = require("@aws-sdk/client-sagemaker"); // CommonJS import + * const client = new SageMakerClient(config); + * const command = new DeleteProjectCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteProjectCommandInput} for command's `input` shape. + * @see {@link DeleteProjectCommandOutput} for command's `response` shape. + * @see {@link SageMakerClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteProjectCommand extends $Command< DeleteProjectCommandInput, diff --git a/clients/client-sagemaker/commands/DeleteTagsCommand.ts b/clients/client-sagemaker/commands/DeleteTagsCommand.ts index 36a293979989..2cc254b602cd 100644 --- a/clients/client-sagemaker/commands/DeleteTagsCommand.ts +++ b/clients/client-sagemaker/commands/DeleteTagsCommand.ts @@ -28,6 +28,20 @@ export interface DeleteTagsCommandOutput extends DeleteTagsOutput, __MetadataBea * deleted tags are not removed from training jobs that the hyperparameter tuning job * launched before you called this API.

* + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { SageMakerClient, DeleteTagsCommand } from "@aws-sdk/client-sagemaker"; // ES Modules import + * // const { SageMakerClient, DeleteTagsCommand } = require("@aws-sdk/client-sagemaker"); // CommonJS import + * const client = new SageMakerClient(config); + * const command = new DeleteTagsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteTagsCommandInput} for command's `input` shape. + * @see {@link DeleteTagsCommandOutput} for command's `response` shape. + * @see {@link SageMakerClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteTagsCommand extends $Command< DeleteTagsCommandInput, diff --git a/clients/client-sagemaker/commands/DeleteTrialCommand.ts b/clients/client-sagemaker/commands/DeleteTrialCommand.ts index df134231fe89..17d41b3db037 100644 --- a/clients/client-sagemaker/commands/DeleteTrialCommand.ts +++ b/clients/client-sagemaker/commands/DeleteTrialCommand.ts @@ -24,6 +24,20 @@ export interface DeleteTrialCommandOutput extends DeleteTrialResponse, __Metadat *

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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { SageMakerClient, DeleteTrialCommand } from "@aws-sdk/client-sagemaker"; // ES Modules import + * // const { SageMakerClient, DeleteTrialCommand } = require("@aws-sdk/client-sagemaker"); // CommonJS import + * const client = new SageMakerClient(config); + * const command = new DeleteTrialCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteTrialCommandInput} for command's `input` shape. + * @see {@link DeleteTrialCommandOutput} for command's `response` shape. + * @see {@link SageMakerClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteTrialCommand extends $Command< DeleteTrialCommandInput, diff --git a/clients/client-sagemaker/commands/DeleteTrialComponentCommand.ts b/clients/client-sagemaker/commands/DeleteTrialComponentCommand.ts index 89c0cb3b4fc1..4b1517441e2e 100644 --- a/clients/client-sagemaker/commands/DeleteTrialComponentCommand.ts +++ b/clients/client-sagemaker/commands/DeleteTrialComponentCommand.ts @@ -24,6 +24,20 @@ export interface DeleteTrialComponentCommandOutput extends DeleteTrialComponentR *

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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { SageMakerClient, DeleteTrialComponentCommand } from "@aws-sdk/client-sagemaker"; // ES Modules import + * // const { SageMakerClient, DeleteTrialComponentCommand } = require("@aws-sdk/client-sagemaker"); // CommonJS import + * const client = new SageMakerClient(config); + * const command = new DeleteTrialComponentCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteTrialComponentCommandInput} for command's `input` shape. + * @see {@link DeleteTrialComponentCommandOutput} for command's `response` shape. + * @see {@link SageMakerClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteTrialComponentCommand extends $Command< DeleteTrialComponentCommandInput, diff --git a/clients/client-sagemaker/commands/DeleteUserProfileCommand.ts b/clients/client-sagemaker/commands/DeleteUserProfileCommand.ts index 7a1735b02acd..9ecae8593c2d 100644 --- a/clients/client-sagemaker/commands/DeleteUserProfileCommand.ts +++ b/clients/client-sagemaker/commands/DeleteUserProfileCommand.ts @@ -23,6 +23,20 @@ export interface DeleteUserProfileCommandOutput extends __MetadataBearer {} /** *

Deletes a user profile. When a user profile is deleted, the user loses access to their EFS * volume, including data, notebooks, and other artifacts.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { SageMakerClient, DeleteUserProfileCommand } from "@aws-sdk/client-sagemaker"; // ES Modules import + * // const { SageMakerClient, DeleteUserProfileCommand } = require("@aws-sdk/client-sagemaker"); // CommonJS import + * const client = new SageMakerClient(config); + * const command = new DeleteUserProfileCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteUserProfileCommandInput} for command's `input` shape. + * @see {@link DeleteUserProfileCommandOutput} for command's `response` shape. + * @see {@link SageMakerClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteUserProfileCommand extends $Command< DeleteUserProfileCommandInput, diff --git a/clients/client-sagemaker/commands/DeleteWorkforceCommand.ts b/clients/client-sagemaker/commands/DeleteWorkforceCommand.ts index 1f603539cff1..5e95d4521d48 100644 --- a/clients/client-sagemaker/commands/DeleteWorkforceCommand.ts +++ b/clients/client-sagemaker/commands/DeleteWorkforceCommand.ts @@ -34,6 +34,20 @@ export interface DeleteWorkforceCommandOutput extends DeleteWorkforceResponse, _ * If you try to delete a workforce that contains one or more work teams, * you will recieve a ResourceInUse error.

* + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { SageMakerClient, DeleteWorkforceCommand } from "@aws-sdk/client-sagemaker"; // ES Modules import + * // const { SageMakerClient, DeleteWorkforceCommand } = require("@aws-sdk/client-sagemaker"); // CommonJS import + * const client = new SageMakerClient(config); + * const command = new DeleteWorkforceCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteWorkforceCommandInput} for command's `input` shape. + * @see {@link DeleteWorkforceCommandOutput} for command's `response` shape. + * @see {@link SageMakerClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteWorkforceCommand extends $Command< DeleteWorkforceCommandInput, diff --git a/clients/client-sagemaker/commands/DeleteWorkteamCommand.ts b/clients/client-sagemaker/commands/DeleteWorkteamCommand.ts index ed2fa535a093..8bfbec009e4f 100644 --- a/clients/client-sagemaker/commands/DeleteWorkteamCommand.ts +++ b/clients/client-sagemaker/commands/DeleteWorkteamCommand.ts @@ -22,6 +22,20 @@ export interface DeleteWorkteamCommandOutput extends DeleteWorkteamResponse, __M /** *

Deletes an existing work team. This operation can't be undone.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { SageMakerClient, DeleteWorkteamCommand } from "@aws-sdk/client-sagemaker"; // ES Modules import + * // const { SageMakerClient, DeleteWorkteamCommand } = require("@aws-sdk/client-sagemaker"); // CommonJS import + * const client = new SageMakerClient(config); + * const command = new DeleteWorkteamCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteWorkteamCommandInput} for command's `input` shape. + * @see {@link DeleteWorkteamCommandOutput} for command's `response` shape. + * @see {@link SageMakerClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteWorkteamCommand extends $Command< DeleteWorkteamCommandInput, diff --git a/clients/client-sagemaker/commands/DeregisterDevicesCommand.ts b/clients/client-sagemaker/commands/DeregisterDevicesCommand.ts index 36f620ab4f0a..9810430cd236 100644 --- a/clients/client-sagemaker/commands/DeregisterDevicesCommand.ts +++ b/clients/client-sagemaker/commands/DeregisterDevicesCommand.ts @@ -22,6 +22,20 @@ export interface DeregisterDevicesCommandOutput extends __MetadataBearer {} /** *

Deregisters the specified devices. After you deregister a device, you will need to re-register the devices.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { SageMakerClient, DeregisterDevicesCommand } from "@aws-sdk/client-sagemaker"; // ES Modules import + * // const { SageMakerClient, DeregisterDevicesCommand } = require("@aws-sdk/client-sagemaker"); // CommonJS import + * const client = new SageMakerClient(config); + * const command = new DeregisterDevicesCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeregisterDevicesCommandInput} for command's `input` shape. + * @see {@link DeregisterDevicesCommandOutput} for command's `response` shape. + * @see {@link SageMakerClientResolvedConfig | config} for command's `input` shape. + * */ export class DeregisterDevicesCommand extends $Command< DeregisterDevicesCommandInput, diff --git a/clients/client-sagemaker/commands/DescribeActionCommand.ts b/clients/client-sagemaker/commands/DescribeActionCommand.ts index 2b9b849f9a52..ff4dbfbec582 100644 --- a/clients/client-sagemaker/commands/DescribeActionCommand.ts +++ b/clients/client-sagemaker/commands/DescribeActionCommand.ts @@ -22,6 +22,20 @@ export interface DescribeActionCommandOutput extends DescribeActionResponse, __M /** *

Describes an action.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { SageMakerClient, DescribeActionCommand } from "@aws-sdk/client-sagemaker"; // ES Modules import + * // const { SageMakerClient, DescribeActionCommand } = require("@aws-sdk/client-sagemaker"); // CommonJS import + * const client = new SageMakerClient(config); + * const command = new DescribeActionCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeActionCommandInput} for command's `input` shape. + * @see {@link DescribeActionCommandOutput} for command's `response` shape. + * @see {@link SageMakerClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeActionCommand extends $Command< DescribeActionCommandInput, diff --git a/clients/client-sagemaker/commands/DescribeAlgorithmCommand.ts b/clients/client-sagemaker/commands/DescribeAlgorithmCommand.ts index cbfb4c094b8c..d656f590dcc1 100644 --- a/clients/client-sagemaker/commands/DescribeAlgorithmCommand.ts +++ b/clients/client-sagemaker/commands/DescribeAlgorithmCommand.ts @@ -22,6 +22,20 @@ export interface DescribeAlgorithmCommandOutput extends DescribeAlgorithmOutput, /** *

Returns a description of the specified algorithm that is in your account.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { SageMakerClient, DescribeAlgorithmCommand } from "@aws-sdk/client-sagemaker"; // ES Modules import + * // const { SageMakerClient, DescribeAlgorithmCommand } = require("@aws-sdk/client-sagemaker"); // CommonJS import + * const client = new SageMakerClient(config); + * const command = new DescribeAlgorithmCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeAlgorithmCommandInput} for command's `input` shape. + * @see {@link DescribeAlgorithmCommandOutput} for command's `response` shape. + * @see {@link SageMakerClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeAlgorithmCommand extends $Command< DescribeAlgorithmCommandInput, diff --git a/clients/client-sagemaker/commands/DescribeAppCommand.ts b/clients/client-sagemaker/commands/DescribeAppCommand.ts index 0c3660ee2db6..bc23b1ef0d99 100644 --- a/clients/client-sagemaker/commands/DescribeAppCommand.ts +++ b/clients/client-sagemaker/commands/DescribeAppCommand.ts @@ -22,6 +22,20 @@ export interface DescribeAppCommandOutput extends DescribeAppResponse, __Metadat /** *

Describes the app.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { SageMakerClient, DescribeAppCommand } from "@aws-sdk/client-sagemaker"; // ES Modules import + * // const { SageMakerClient, DescribeAppCommand } = require("@aws-sdk/client-sagemaker"); // CommonJS import + * const client = new SageMakerClient(config); + * const command = new DescribeAppCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeAppCommandInput} for command's `input` shape. + * @see {@link DescribeAppCommandOutput} for command's `response` shape. + * @see {@link SageMakerClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeAppCommand extends $Command< DescribeAppCommandInput, diff --git a/clients/client-sagemaker/commands/DescribeAppImageConfigCommand.ts b/clients/client-sagemaker/commands/DescribeAppImageConfigCommand.ts index 03fa252b884d..11fd36bde51a 100644 --- a/clients/client-sagemaker/commands/DescribeAppImageConfigCommand.ts +++ b/clients/client-sagemaker/commands/DescribeAppImageConfigCommand.ts @@ -22,6 +22,20 @@ export interface DescribeAppImageConfigCommandOutput extends DescribeAppImageCon /** *

Describes an AppImageConfig.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { SageMakerClient, DescribeAppImageConfigCommand } from "@aws-sdk/client-sagemaker"; // ES Modules import + * // const { SageMakerClient, DescribeAppImageConfigCommand } = require("@aws-sdk/client-sagemaker"); // CommonJS import + * const client = new SageMakerClient(config); + * const command = new DescribeAppImageConfigCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeAppImageConfigCommandInput} for command's `input` shape. + * @see {@link DescribeAppImageConfigCommandOutput} for command's `response` shape. + * @see {@link SageMakerClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeAppImageConfigCommand extends $Command< DescribeAppImageConfigCommandInput, diff --git a/clients/client-sagemaker/commands/DescribeArtifactCommand.ts b/clients/client-sagemaker/commands/DescribeArtifactCommand.ts index de87d03283e0..0e690ba73037 100644 --- a/clients/client-sagemaker/commands/DescribeArtifactCommand.ts +++ b/clients/client-sagemaker/commands/DescribeArtifactCommand.ts @@ -22,6 +22,20 @@ export interface DescribeArtifactCommandOutput extends DescribeArtifactResponse, /** *

Describes an artifact.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { SageMakerClient, DescribeArtifactCommand } from "@aws-sdk/client-sagemaker"; // ES Modules import + * // const { SageMakerClient, DescribeArtifactCommand } = require("@aws-sdk/client-sagemaker"); // CommonJS import + * const client = new SageMakerClient(config); + * const command = new DescribeArtifactCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeArtifactCommandInput} for command's `input` shape. + * @see {@link DescribeArtifactCommandOutput} for command's `response` shape. + * @see {@link SageMakerClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeArtifactCommand extends $Command< DescribeArtifactCommandInput, diff --git a/clients/client-sagemaker/commands/DescribeAutoMLJobCommand.ts b/clients/client-sagemaker/commands/DescribeAutoMLJobCommand.ts index a4398ad77fa4..2d2590ee53b7 100644 --- a/clients/client-sagemaker/commands/DescribeAutoMLJobCommand.ts +++ b/clients/client-sagemaker/commands/DescribeAutoMLJobCommand.ts @@ -22,6 +22,20 @@ export interface DescribeAutoMLJobCommandOutput extends DescribeAutoMLJobRespons /** *

Returns information about an Amazon SageMaker AutoML job.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { SageMakerClient, DescribeAutoMLJobCommand } from "@aws-sdk/client-sagemaker"; // ES Modules import + * // const { SageMakerClient, DescribeAutoMLJobCommand } = require("@aws-sdk/client-sagemaker"); // CommonJS import + * const client = new SageMakerClient(config); + * const command = new DescribeAutoMLJobCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeAutoMLJobCommandInput} for command's `input` shape. + * @see {@link DescribeAutoMLJobCommandOutput} for command's `response` shape. + * @see {@link SageMakerClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeAutoMLJobCommand extends $Command< DescribeAutoMLJobCommandInput, diff --git a/clients/client-sagemaker/commands/DescribeCodeRepositoryCommand.ts b/clients/client-sagemaker/commands/DescribeCodeRepositoryCommand.ts index 0364e1bdaa5d..4e424f1a0f0e 100644 --- a/clients/client-sagemaker/commands/DescribeCodeRepositoryCommand.ts +++ b/clients/client-sagemaker/commands/DescribeCodeRepositoryCommand.ts @@ -22,6 +22,20 @@ export interface DescribeCodeRepositoryCommandOutput extends DescribeCodeReposit /** *

Gets details about the specified Git repository.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { SageMakerClient, DescribeCodeRepositoryCommand } from "@aws-sdk/client-sagemaker"; // ES Modules import + * // const { SageMakerClient, DescribeCodeRepositoryCommand } = require("@aws-sdk/client-sagemaker"); // CommonJS import + * const client = new SageMakerClient(config); + * const command = new DescribeCodeRepositoryCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeCodeRepositoryCommandInput} for command's `input` shape. + * @see {@link DescribeCodeRepositoryCommandOutput} for command's `response` shape. + * @see {@link SageMakerClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeCodeRepositoryCommand extends $Command< DescribeCodeRepositoryCommandInput, diff --git a/clients/client-sagemaker/commands/DescribeCompilationJobCommand.ts b/clients/client-sagemaker/commands/DescribeCompilationJobCommand.ts index 0d05efe40d27..ec86c03774aa 100644 --- a/clients/client-sagemaker/commands/DescribeCompilationJobCommand.ts +++ b/clients/client-sagemaker/commands/DescribeCompilationJobCommand.ts @@ -24,6 +24,20 @@ export interface DescribeCompilationJobCommandOutput extends DescribeCompilation *

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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { SageMakerClient, DescribeCompilationJobCommand } from "@aws-sdk/client-sagemaker"; // ES Modules import + * // const { SageMakerClient, DescribeCompilationJobCommand } = require("@aws-sdk/client-sagemaker"); // CommonJS import + * const client = new SageMakerClient(config); + * const command = new DescribeCompilationJobCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeCompilationJobCommandInput} for command's `input` shape. + * @see {@link DescribeCompilationJobCommandOutput} for command's `response` shape. + * @see {@link SageMakerClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeCompilationJobCommand extends $Command< DescribeCompilationJobCommandInput, diff --git a/clients/client-sagemaker/commands/DescribeContextCommand.ts b/clients/client-sagemaker/commands/DescribeContextCommand.ts index 1c55928bbe77..a728dd5a3ab4 100644 --- a/clients/client-sagemaker/commands/DescribeContextCommand.ts +++ b/clients/client-sagemaker/commands/DescribeContextCommand.ts @@ -22,6 +22,20 @@ export interface DescribeContextCommandOutput extends DescribeContextResponse, _ /** *

Describes a context.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { SageMakerClient, DescribeContextCommand } from "@aws-sdk/client-sagemaker"; // ES Modules import + * // const { SageMakerClient, DescribeContextCommand } = require("@aws-sdk/client-sagemaker"); // CommonJS import + * const client = new SageMakerClient(config); + * const command = new DescribeContextCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeContextCommandInput} for command's `input` shape. + * @see {@link DescribeContextCommandOutput} for command's `response` shape. + * @see {@link SageMakerClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeContextCommand extends $Command< DescribeContextCommandInput, diff --git a/clients/client-sagemaker/commands/DescribeDataQualityJobDefinitionCommand.ts b/clients/client-sagemaker/commands/DescribeDataQualityJobDefinitionCommand.ts index bf80ba5644f9..ef7a792d14fe 100644 --- a/clients/client-sagemaker/commands/DescribeDataQualityJobDefinitionCommand.ts +++ b/clients/client-sagemaker/commands/DescribeDataQualityJobDefinitionCommand.ts @@ -24,6 +24,20 @@ export interface DescribeDataQualityJobDefinitionCommandOutput /** *

Gets the details of a data quality monitoring job definition.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { SageMakerClient, DescribeDataQualityJobDefinitionCommand } from "@aws-sdk/client-sagemaker"; // ES Modules import + * // const { SageMakerClient, DescribeDataQualityJobDefinitionCommand } = require("@aws-sdk/client-sagemaker"); // CommonJS import + * const client = new SageMakerClient(config); + * const command = new DescribeDataQualityJobDefinitionCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeDataQualityJobDefinitionCommandInput} for command's `input` shape. + * @see {@link DescribeDataQualityJobDefinitionCommandOutput} for command's `response` shape. + * @see {@link SageMakerClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeDataQualityJobDefinitionCommand extends $Command< DescribeDataQualityJobDefinitionCommandInput, diff --git a/clients/client-sagemaker/commands/DescribeDeviceCommand.ts b/clients/client-sagemaker/commands/DescribeDeviceCommand.ts index fe1fb5c5f454..f1d581449349 100644 --- a/clients/client-sagemaker/commands/DescribeDeviceCommand.ts +++ b/clients/client-sagemaker/commands/DescribeDeviceCommand.ts @@ -22,6 +22,20 @@ export interface DescribeDeviceCommandOutput extends DescribeDeviceResponse, __M /** *

Describes the device.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { SageMakerClient, DescribeDeviceCommand } from "@aws-sdk/client-sagemaker"; // ES Modules import + * // const { SageMakerClient, DescribeDeviceCommand } = require("@aws-sdk/client-sagemaker"); // CommonJS import + * const client = new SageMakerClient(config); + * const command = new DescribeDeviceCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeDeviceCommandInput} for command's `input` shape. + * @see {@link DescribeDeviceCommandOutput} for command's `response` shape. + * @see {@link SageMakerClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeDeviceCommand extends $Command< DescribeDeviceCommandInput, diff --git a/clients/client-sagemaker/commands/DescribeDeviceFleetCommand.ts b/clients/client-sagemaker/commands/DescribeDeviceFleetCommand.ts index 1331a6f034f1..8d510cda505d 100644 --- a/clients/client-sagemaker/commands/DescribeDeviceFleetCommand.ts +++ b/clients/client-sagemaker/commands/DescribeDeviceFleetCommand.ts @@ -22,6 +22,20 @@ export interface DescribeDeviceFleetCommandOutput extends DescribeDeviceFleetRes /** *

A description of the fleet the device belongs to.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { SageMakerClient, DescribeDeviceFleetCommand } from "@aws-sdk/client-sagemaker"; // ES Modules import + * // const { SageMakerClient, DescribeDeviceFleetCommand } = require("@aws-sdk/client-sagemaker"); // CommonJS import + * const client = new SageMakerClient(config); + * const command = new DescribeDeviceFleetCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeDeviceFleetCommandInput} for command's `input` shape. + * @see {@link DescribeDeviceFleetCommandOutput} for command's `response` shape. + * @see {@link SageMakerClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeDeviceFleetCommand extends $Command< DescribeDeviceFleetCommandInput, diff --git a/clients/client-sagemaker/commands/DescribeDomainCommand.ts b/clients/client-sagemaker/commands/DescribeDomainCommand.ts index 557e530f4371..27c737d500cd 100644 --- a/clients/client-sagemaker/commands/DescribeDomainCommand.ts +++ b/clients/client-sagemaker/commands/DescribeDomainCommand.ts @@ -22,6 +22,20 @@ export interface DescribeDomainCommandOutput extends DescribeDomainResponse, __M /** *

The description of the domain.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { SageMakerClient, DescribeDomainCommand } from "@aws-sdk/client-sagemaker"; // ES Modules import + * // const { SageMakerClient, DescribeDomainCommand } = require("@aws-sdk/client-sagemaker"); // CommonJS import + * const client = new SageMakerClient(config); + * const command = new DescribeDomainCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeDomainCommandInput} for command's `input` shape. + * @see {@link DescribeDomainCommandOutput} for command's `response` shape. + * @see {@link SageMakerClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeDomainCommand extends $Command< DescribeDomainCommandInput, diff --git a/clients/client-sagemaker/commands/DescribeEdgePackagingJobCommand.ts b/clients/client-sagemaker/commands/DescribeEdgePackagingJobCommand.ts index c7e0f876e5d6..60382c8569f0 100644 --- a/clients/client-sagemaker/commands/DescribeEdgePackagingJobCommand.ts +++ b/clients/client-sagemaker/commands/DescribeEdgePackagingJobCommand.ts @@ -22,6 +22,20 @@ export interface DescribeEdgePackagingJobCommandOutput extends DescribeEdgePacka /** *

A description of edge packaging jobs.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { SageMakerClient, DescribeEdgePackagingJobCommand } from "@aws-sdk/client-sagemaker"; // ES Modules import + * // const { SageMakerClient, DescribeEdgePackagingJobCommand } = require("@aws-sdk/client-sagemaker"); // CommonJS import + * const client = new SageMakerClient(config); + * const command = new DescribeEdgePackagingJobCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeEdgePackagingJobCommandInput} for command's `input` shape. + * @see {@link DescribeEdgePackagingJobCommandOutput} for command's `response` shape. + * @see {@link SageMakerClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeEdgePackagingJobCommand extends $Command< DescribeEdgePackagingJobCommandInput, diff --git a/clients/client-sagemaker/commands/DescribeEndpointCommand.ts b/clients/client-sagemaker/commands/DescribeEndpointCommand.ts index 6436a4032efa..162eae437bd2 100644 --- a/clients/client-sagemaker/commands/DescribeEndpointCommand.ts +++ b/clients/client-sagemaker/commands/DescribeEndpointCommand.ts @@ -22,6 +22,20 @@ export interface DescribeEndpointCommandOutput extends DescribeEndpointOutput, _ /** *

Returns the description of an endpoint.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { SageMakerClient, DescribeEndpointCommand } from "@aws-sdk/client-sagemaker"; // ES Modules import + * // const { SageMakerClient, DescribeEndpointCommand } = require("@aws-sdk/client-sagemaker"); // CommonJS import + * const client = new SageMakerClient(config); + * const command = new DescribeEndpointCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeEndpointCommandInput} for command's `input` shape. + * @see {@link DescribeEndpointCommandOutput} for command's `response` shape. + * @see {@link SageMakerClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeEndpointCommand extends $Command< DescribeEndpointCommandInput, diff --git a/clients/client-sagemaker/commands/DescribeEndpointConfigCommand.ts b/clients/client-sagemaker/commands/DescribeEndpointConfigCommand.ts index 309f5e706cc8..edec216b2ca4 100644 --- a/clients/client-sagemaker/commands/DescribeEndpointConfigCommand.ts +++ b/clients/client-sagemaker/commands/DescribeEndpointConfigCommand.ts @@ -23,6 +23,20 @@ export interface DescribeEndpointConfigCommandOutput extends DescribeEndpointCon /** *

Returns the description of an endpoint configuration created using the * CreateEndpointConfig API.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { SageMakerClient, DescribeEndpointConfigCommand } from "@aws-sdk/client-sagemaker"; // ES Modules import + * // const { SageMakerClient, DescribeEndpointConfigCommand } = require("@aws-sdk/client-sagemaker"); // CommonJS import + * const client = new SageMakerClient(config); + * const command = new DescribeEndpointConfigCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeEndpointConfigCommandInput} for command's `input` shape. + * @see {@link DescribeEndpointConfigCommandOutput} for command's `response` shape. + * @see {@link SageMakerClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeEndpointConfigCommand extends $Command< DescribeEndpointConfigCommandInput, diff --git a/clients/client-sagemaker/commands/DescribeExperimentCommand.ts b/clients/client-sagemaker/commands/DescribeExperimentCommand.ts index de5b78b2350c..ad6ce6906931 100644 --- a/clients/client-sagemaker/commands/DescribeExperimentCommand.ts +++ b/clients/client-sagemaker/commands/DescribeExperimentCommand.ts @@ -22,6 +22,20 @@ export interface DescribeExperimentCommandOutput extends DescribeExperimentRespo /** *

Provides a list of an experiment's properties.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { SageMakerClient, DescribeExperimentCommand } from "@aws-sdk/client-sagemaker"; // ES Modules import + * // const { SageMakerClient, DescribeExperimentCommand } = require("@aws-sdk/client-sagemaker"); // CommonJS import + * const client = new SageMakerClient(config); + * const command = new DescribeExperimentCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeExperimentCommandInput} for command's `input` shape. + * @see {@link DescribeExperimentCommandOutput} for command's `response` shape. + * @see {@link SageMakerClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeExperimentCommand extends $Command< DescribeExperimentCommandInput, diff --git a/clients/client-sagemaker/commands/DescribeFeatureGroupCommand.ts b/clients/client-sagemaker/commands/DescribeFeatureGroupCommand.ts index bee6a2f087a5..58a9477912ea 100644 --- a/clients/client-sagemaker/commands/DescribeFeatureGroupCommand.ts +++ b/clients/client-sagemaker/commands/DescribeFeatureGroupCommand.ts @@ -24,6 +24,20 @@ export interface DescribeFeatureGroupCommandOutput extends DescribeFeatureGroupR *

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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { SageMakerClient, DescribeFeatureGroupCommand } from "@aws-sdk/client-sagemaker"; // ES Modules import + * // const { SageMakerClient, DescribeFeatureGroupCommand } = require("@aws-sdk/client-sagemaker"); // CommonJS import + * const client = new SageMakerClient(config); + * const command = new DescribeFeatureGroupCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeFeatureGroupCommandInput} for command's `input` shape. + * @see {@link DescribeFeatureGroupCommandOutput} for command's `response` shape. + * @see {@link SageMakerClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeFeatureGroupCommand extends $Command< DescribeFeatureGroupCommandInput, diff --git a/clients/client-sagemaker/commands/DescribeFlowDefinitionCommand.ts b/clients/client-sagemaker/commands/DescribeFlowDefinitionCommand.ts index 1e96c3bdaf76..81310dee6a1e 100644 --- a/clients/client-sagemaker/commands/DescribeFlowDefinitionCommand.ts +++ b/clients/client-sagemaker/commands/DescribeFlowDefinitionCommand.ts @@ -22,6 +22,20 @@ export interface DescribeFlowDefinitionCommandOutput extends DescribeFlowDefinit /** *

Returns information about the specified flow definition.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { SageMakerClient, DescribeFlowDefinitionCommand } from "@aws-sdk/client-sagemaker"; // ES Modules import + * // const { SageMakerClient, DescribeFlowDefinitionCommand } = require("@aws-sdk/client-sagemaker"); // CommonJS import + * const client = new SageMakerClient(config); + * const command = new DescribeFlowDefinitionCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeFlowDefinitionCommandInput} for command's `input` shape. + * @see {@link DescribeFlowDefinitionCommandOutput} for command's `response` shape. + * @see {@link SageMakerClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeFlowDefinitionCommand extends $Command< DescribeFlowDefinitionCommandInput, diff --git a/clients/client-sagemaker/commands/DescribeHumanTaskUiCommand.ts b/clients/client-sagemaker/commands/DescribeHumanTaskUiCommand.ts index 2e92e2b612b5..c9dd5236124b 100644 --- a/clients/client-sagemaker/commands/DescribeHumanTaskUiCommand.ts +++ b/clients/client-sagemaker/commands/DescribeHumanTaskUiCommand.ts @@ -22,6 +22,20 @@ export interface DescribeHumanTaskUiCommandOutput extends DescribeHumanTaskUiRes /** *

Returns information about the requested human task user interface (worker task template).

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { SageMakerClient, DescribeHumanTaskUiCommand } from "@aws-sdk/client-sagemaker"; // ES Modules import + * // const { SageMakerClient, DescribeHumanTaskUiCommand } = require("@aws-sdk/client-sagemaker"); // CommonJS import + * const client = new SageMakerClient(config); + * const command = new DescribeHumanTaskUiCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeHumanTaskUiCommandInput} for command's `input` shape. + * @see {@link DescribeHumanTaskUiCommandOutput} for command's `response` shape. + * @see {@link SageMakerClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeHumanTaskUiCommand extends $Command< DescribeHumanTaskUiCommandInput, diff --git a/clients/client-sagemaker/commands/DescribeHyperParameterTuningJobCommand.ts b/clients/client-sagemaker/commands/DescribeHyperParameterTuningJobCommand.ts index 64bd85ff1ca6..f0d113cd7db6 100644 --- a/clients/client-sagemaker/commands/DescribeHyperParameterTuningJobCommand.ts +++ b/clients/client-sagemaker/commands/DescribeHyperParameterTuningJobCommand.ts @@ -25,6 +25,20 @@ export interface DescribeHyperParameterTuningJobCommandOutput /** *

Gets * a description of a hyperparameter tuning job.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { SageMakerClient, DescribeHyperParameterTuningJobCommand } from "@aws-sdk/client-sagemaker"; // ES Modules import + * // const { SageMakerClient, DescribeHyperParameterTuningJobCommand } = require("@aws-sdk/client-sagemaker"); // CommonJS import + * const client = new SageMakerClient(config); + * const command = new DescribeHyperParameterTuningJobCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeHyperParameterTuningJobCommandInput} for command's `input` shape. + * @see {@link DescribeHyperParameterTuningJobCommandOutput} for command's `response` shape. + * @see {@link SageMakerClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeHyperParameterTuningJobCommand extends $Command< DescribeHyperParameterTuningJobCommandInput, diff --git a/clients/client-sagemaker/commands/DescribeImageCommand.ts b/clients/client-sagemaker/commands/DescribeImageCommand.ts index 6180c45fcc8b..647af073f78a 100644 --- a/clients/client-sagemaker/commands/DescribeImageCommand.ts +++ b/clients/client-sagemaker/commands/DescribeImageCommand.ts @@ -22,6 +22,20 @@ export interface DescribeImageCommandOutput extends DescribeImageResponse, __Met /** *

Describes a SageMaker image.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { SageMakerClient, DescribeImageCommand } from "@aws-sdk/client-sagemaker"; // ES Modules import + * // const { SageMakerClient, DescribeImageCommand } = require("@aws-sdk/client-sagemaker"); // CommonJS import + * const client = new SageMakerClient(config); + * const command = new DescribeImageCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeImageCommandInput} for command's `input` shape. + * @see {@link DescribeImageCommandOutput} for command's `response` shape. + * @see {@link SageMakerClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeImageCommand extends $Command< DescribeImageCommandInput, diff --git a/clients/client-sagemaker/commands/DescribeImageVersionCommand.ts b/clients/client-sagemaker/commands/DescribeImageVersionCommand.ts index 5a56376498e0..cfa6b490029c 100644 --- a/clients/client-sagemaker/commands/DescribeImageVersionCommand.ts +++ b/clients/client-sagemaker/commands/DescribeImageVersionCommand.ts @@ -22,6 +22,20 @@ export interface DescribeImageVersionCommandOutput extends DescribeImageVersionR /** *

Describes a version of a SageMaker image.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { SageMakerClient, DescribeImageVersionCommand } from "@aws-sdk/client-sagemaker"; // ES Modules import + * // const { SageMakerClient, DescribeImageVersionCommand } = require("@aws-sdk/client-sagemaker"); // CommonJS import + * const client = new SageMakerClient(config); + * const command = new DescribeImageVersionCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeImageVersionCommandInput} for command's `input` shape. + * @see {@link DescribeImageVersionCommandOutput} for command's `response` shape. + * @see {@link SageMakerClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeImageVersionCommand extends $Command< DescribeImageVersionCommandInput, diff --git a/clients/client-sagemaker/commands/DescribeLabelingJobCommand.ts b/clients/client-sagemaker/commands/DescribeLabelingJobCommand.ts index 82d535ec24b1..61c433654330 100644 --- a/clients/client-sagemaker/commands/DescribeLabelingJobCommand.ts +++ b/clients/client-sagemaker/commands/DescribeLabelingJobCommand.ts @@ -22,6 +22,20 @@ export interface DescribeLabelingJobCommandOutput extends DescribeLabelingJobRes /** *

Gets information about a labeling job.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { SageMakerClient, DescribeLabelingJobCommand } from "@aws-sdk/client-sagemaker"; // ES Modules import + * // const { SageMakerClient, DescribeLabelingJobCommand } = require("@aws-sdk/client-sagemaker"); // CommonJS import + * const client = new SageMakerClient(config); + * const command = new DescribeLabelingJobCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeLabelingJobCommandInput} for command's `input` shape. + * @see {@link DescribeLabelingJobCommandOutput} for command's `response` shape. + * @see {@link SageMakerClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeLabelingJobCommand extends $Command< DescribeLabelingJobCommandInput, diff --git a/clients/client-sagemaker/commands/DescribeModelBiasJobDefinitionCommand.ts b/clients/client-sagemaker/commands/DescribeModelBiasJobDefinitionCommand.ts index d590734630a4..24bf941b14ee 100644 --- a/clients/client-sagemaker/commands/DescribeModelBiasJobDefinitionCommand.ts +++ b/clients/client-sagemaker/commands/DescribeModelBiasJobDefinitionCommand.ts @@ -24,6 +24,20 @@ export interface DescribeModelBiasJobDefinitionCommandOutput /** *

Returns a description of a model bias job definition.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { SageMakerClient, DescribeModelBiasJobDefinitionCommand } from "@aws-sdk/client-sagemaker"; // ES Modules import + * // const { SageMakerClient, DescribeModelBiasJobDefinitionCommand } = require("@aws-sdk/client-sagemaker"); // CommonJS import + * const client = new SageMakerClient(config); + * const command = new DescribeModelBiasJobDefinitionCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeModelBiasJobDefinitionCommandInput} for command's `input` shape. + * @see {@link DescribeModelBiasJobDefinitionCommandOutput} for command's `response` shape. + * @see {@link SageMakerClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeModelBiasJobDefinitionCommand extends $Command< DescribeModelBiasJobDefinitionCommandInput, diff --git a/clients/client-sagemaker/commands/DescribeModelCommand.ts b/clients/client-sagemaker/commands/DescribeModelCommand.ts index 3a0f5f5a293e..3acffdfb1965 100644 --- a/clients/client-sagemaker/commands/DescribeModelCommand.ts +++ b/clients/client-sagemaker/commands/DescribeModelCommand.ts @@ -23,6 +23,20 @@ export interface DescribeModelCommandOutput extends DescribeModelOutput, __Metad /** *

Describes a model that you created using the CreateModel * API.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { SageMakerClient, DescribeModelCommand } from "@aws-sdk/client-sagemaker"; // ES Modules import + * // const { SageMakerClient, DescribeModelCommand } = require("@aws-sdk/client-sagemaker"); // CommonJS import + * const client = new SageMakerClient(config); + * const command = new DescribeModelCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeModelCommandInput} for command's `input` shape. + * @see {@link DescribeModelCommandOutput} for command's `response` shape. + * @see {@link SageMakerClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeModelCommand extends $Command< DescribeModelCommandInput, diff --git a/clients/client-sagemaker/commands/DescribeModelExplainabilityJobDefinitionCommand.ts b/clients/client-sagemaker/commands/DescribeModelExplainabilityJobDefinitionCommand.ts index 68b0c0775a77..32cb5b7931f2 100644 --- a/clients/client-sagemaker/commands/DescribeModelExplainabilityJobDefinitionCommand.ts +++ b/clients/client-sagemaker/commands/DescribeModelExplainabilityJobDefinitionCommand.ts @@ -28,6 +28,20 @@ export interface DescribeModelExplainabilityJobDefinitionCommandOutput /** *

Returns a description of a model explainability job definition.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { SageMakerClient, DescribeModelExplainabilityJobDefinitionCommand } from "@aws-sdk/client-sagemaker"; // ES Modules import + * // const { SageMakerClient, DescribeModelExplainabilityJobDefinitionCommand } = require("@aws-sdk/client-sagemaker"); // CommonJS import + * const client = new SageMakerClient(config); + * const command = new DescribeModelExplainabilityJobDefinitionCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeModelExplainabilityJobDefinitionCommandInput} for command's `input` shape. + * @see {@link DescribeModelExplainabilityJobDefinitionCommandOutput} for command's `response` shape. + * @see {@link SageMakerClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeModelExplainabilityJobDefinitionCommand extends $Command< DescribeModelExplainabilityJobDefinitionCommandInput, diff --git a/clients/client-sagemaker/commands/DescribeModelPackageCommand.ts b/clients/client-sagemaker/commands/DescribeModelPackageCommand.ts index e9e668180dbd..7c412fffecf0 100644 --- a/clients/client-sagemaker/commands/DescribeModelPackageCommand.ts +++ b/clients/client-sagemaker/commands/DescribeModelPackageCommand.ts @@ -25,6 +25,20 @@ export interface DescribeModelPackageCommandOutput extends DescribeModelPackageO * models or list them on AWS Marketplace.

*

To create models in Amazon SageMaker, buyers can subscribe to model packages listed on AWS * Marketplace.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { SageMakerClient, DescribeModelPackageCommand } from "@aws-sdk/client-sagemaker"; // ES Modules import + * // const { SageMakerClient, DescribeModelPackageCommand } = require("@aws-sdk/client-sagemaker"); // CommonJS import + * const client = new SageMakerClient(config); + * const command = new DescribeModelPackageCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeModelPackageCommandInput} for command's `input` shape. + * @see {@link DescribeModelPackageCommandOutput} for command's `response` shape. + * @see {@link SageMakerClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeModelPackageCommand extends $Command< DescribeModelPackageCommandInput, diff --git a/clients/client-sagemaker/commands/DescribeModelPackageGroupCommand.ts b/clients/client-sagemaker/commands/DescribeModelPackageGroupCommand.ts index 79ea67089bd0..c30bef78e902 100644 --- a/clients/client-sagemaker/commands/DescribeModelPackageGroupCommand.ts +++ b/clients/client-sagemaker/commands/DescribeModelPackageGroupCommand.ts @@ -22,6 +22,20 @@ export interface DescribeModelPackageGroupCommandOutput extends DescribeModelPac /** *

Gets a description for the specified model group.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { SageMakerClient, DescribeModelPackageGroupCommand } from "@aws-sdk/client-sagemaker"; // ES Modules import + * // const { SageMakerClient, DescribeModelPackageGroupCommand } = require("@aws-sdk/client-sagemaker"); // CommonJS import + * const client = new SageMakerClient(config); + * const command = new DescribeModelPackageGroupCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeModelPackageGroupCommandInput} for command's `input` shape. + * @see {@link DescribeModelPackageGroupCommandOutput} for command's `response` shape. + * @see {@link SageMakerClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeModelPackageGroupCommand extends $Command< DescribeModelPackageGroupCommandInput, diff --git a/clients/client-sagemaker/commands/DescribeModelQualityJobDefinitionCommand.ts b/clients/client-sagemaker/commands/DescribeModelQualityJobDefinitionCommand.ts index f5957d191f6b..70bf0b6030b1 100644 --- a/clients/client-sagemaker/commands/DescribeModelQualityJobDefinitionCommand.ts +++ b/clients/client-sagemaker/commands/DescribeModelQualityJobDefinitionCommand.ts @@ -27,6 +27,20 @@ export interface DescribeModelQualityJobDefinitionCommandOutput /** *

Returns a description of a model quality job definition.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { SageMakerClient, DescribeModelQualityJobDefinitionCommand } from "@aws-sdk/client-sagemaker"; // ES Modules import + * // const { SageMakerClient, DescribeModelQualityJobDefinitionCommand } = require("@aws-sdk/client-sagemaker"); // CommonJS import + * const client = new SageMakerClient(config); + * const command = new DescribeModelQualityJobDefinitionCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeModelQualityJobDefinitionCommandInput} for command's `input` shape. + * @see {@link DescribeModelQualityJobDefinitionCommandOutput} for command's `response` shape. + * @see {@link SageMakerClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeModelQualityJobDefinitionCommand extends $Command< DescribeModelQualityJobDefinitionCommandInput, diff --git a/clients/client-sagemaker/commands/DescribeMonitoringScheduleCommand.ts b/clients/client-sagemaker/commands/DescribeMonitoringScheduleCommand.ts index 2fba321d9a45..47e7c4733a38 100644 --- a/clients/client-sagemaker/commands/DescribeMonitoringScheduleCommand.ts +++ b/clients/client-sagemaker/commands/DescribeMonitoringScheduleCommand.ts @@ -22,6 +22,20 @@ export interface DescribeMonitoringScheduleCommandOutput extends DescribeMonitor /** *

Describes the schedule for a monitoring job.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { SageMakerClient, DescribeMonitoringScheduleCommand } from "@aws-sdk/client-sagemaker"; // ES Modules import + * // const { SageMakerClient, DescribeMonitoringScheduleCommand } = require("@aws-sdk/client-sagemaker"); // CommonJS import + * const client = new SageMakerClient(config); + * const command = new DescribeMonitoringScheduleCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeMonitoringScheduleCommandInput} for command's `input` shape. + * @see {@link DescribeMonitoringScheduleCommandOutput} for command's `response` shape. + * @see {@link SageMakerClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeMonitoringScheduleCommand extends $Command< DescribeMonitoringScheduleCommandInput, diff --git a/clients/client-sagemaker/commands/DescribeNotebookInstanceCommand.ts b/clients/client-sagemaker/commands/DescribeNotebookInstanceCommand.ts index 49b4bb8891d3..930505263464 100644 --- a/clients/client-sagemaker/commands/DescribeNotebookInstanceCommand.ts +++ b/clients/client-sagemaker/commands/DescribeNotebookInstanceCommand.ts @@ -22,6 +22,20 @@ export interface DescribeNotebookInstanceCommandOutput extends DescribeNotebookI /** *

Returns information about a notebook instance.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { SageMakerClient, DescribeNotebookInstanceCommand } from "@aws-sdk/client-sagemaker"; // ES Modules import + * // const { SageMakerClient, DescribeNotebookInstanceCommand } = require("@aws-sdk/client-sagemaker"); // CommonJS import + * const client = new SageMakerClient(config); + * const command = new DescribeNotebookInstanceCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeNotebookInstanceCommandInput} for command's `input` shape. + * @see {@link DescribeNotebookInstanceCommandOutput} for command's `response` shape. + * @see {@link SageMakerClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeNotebookInstanceCommand extends $Command< DescribeNotebookInstanceCommandInput, diff --git a/clients/client-sagemaker/commands/DescribeNotebookInstanceLifecycleConfigCommand.ts b/clients/client-sagemaker/commands/DescribeNotebookInstanceLifecycleConfigCommand.ts index d6aa3ae0b95e..5616e327eb87 100644 --- a/clients/client-sagemaker/commands/DescribeNotebookInstanceLifecycleConfigCommand.ts +++ b/clients/client-sagemaker/commands/DescribeNotebookInstanceLifecycleConfigCommand.ts @@ -30,6 +30,20 @@ export interface DescribeNotebookInstanceLifecycleConfigCommandOutput *

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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { SageMakerClient, DescribeNotebookInstanceLifecycleConfigCommand } from "@aws-sdk/client-sagemaker"; // ES Modules import + * // const { SageMakerClient, DescribeNotebookInstanceLifecycleConfigCommand } = require("@aws-sdk/client-sagemaker"); // CommonJS import + * const client = new SageMakerClient(config); + * const command = new DescribeNotebookInstanceLifecycleConfigCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeNotebookInstanceLifecycleConfigCommandInput} for command's `input` shape. + * @see {@link DescribeNotebookInstanceLifecycleConfigCommandOutput} for command's `response` shape. + * @see {@link SageMakerClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeNotebookInstanceLifecycleConfigCommand extends $Command< DescribeNotebookInstanceLifecycleConfigCommandInput, diff --git a/clients/client-sagemaker/commands/DescribePipelineCommand.ts b/clients/client-sagemaker/commands/DescribePipelineCommand.ts index eb1063da3b51..acb78f7c7737 100644 --- a/clients/client-sagemaker/commands/DescribePipelineCommand.ts +++ b/clients/client-sagemaker/commands/DescribePipelineCommand.ts @@ -22,6 +22,20 @@ export interface DescribePipelineCommandOutput extends DescribePipelineResponse, /** *

Describes the details of a pipeline.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { SageMakerClient, DescribePipelineCommand } from "@aws-sdk/client-sagemaker"; // ES Modules import + * // const { SageMakerClient, DescribePipelineCommand } = require("@aws-sdk/client-sagemaker"); // CommonJS import + * const client = new SageMakerClient(config); + * const command = new DescribePipelineCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribePipelineCommandInput} for command's `input` shape. + * @see {@link DescribePipelineCommandOutput} for command's `response` shape. + * @see {@link SageMakerClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribePipelineCommand extends $Command< DescribePipelineCommandInput, diff --git a/clients/client-sagemaker/commands/DescribePipelineDefinitionForExecutionCommand.ts b/clients/client-sagemaker/commands/DescribePipelineDefinitionForExecutionCommand.ts index aa415428d95a..d3d548346be3 100644 --- a/clients/client-sagemaker/commands/DescribePipelineDefinitionForExecutionCommand.ts +++ b/clients/client-sagemaker/commands/DescribePipelineDefinitionForExecutionCommand.ts @@ -28,6 +28,20 @@ export interface DescribePipelineDefinitionForExecutionCommandOutput /** *

Describes the details of an execution's pipeline definition.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { SageMakerClient, DescribePipelineDefinitionForExecutionCommand } from "@aws-sdk/client-sagemaker"; // ES Modules import + * // const { SageMakerClient, DescribePipelineDefinitionForExecutionCommand } = require("@aws-sdk/client-sagemaker"); // CommonJS import + * const client = new SageMakerClient(config); + * const command = new DescribePipelineDefinitionForExecutionCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribePipelineDefinitionForExecutionCommandInput} for command's `input` shape. + * @see {@link DescribePipelineDefinitionForExecutionCommandOutput} for command's `response` shape. + * @see {@link SageMakerClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribePipelineDefinitionForExecutionCommand extends $Command< DescribePipelineDefinitionForExecutionCommandInput, diff --git a/clients/client-sagemaker/commands/DescribePipelineExecutionCommand.ts b/clients/client-sagemaker/commands/DescribePipelineExecutionCommand.ts index df8c8c877c35..fdd0f9550804 100644 --- a/clients/client-sagemaker/commands/DescribePipelineExecutionCommand.ts +++ b/clients/client-sagemaker/commands/DescribePipelineExecutionCommand.ts @@ -22,6 +22,20 @@ export interface DescribePipelineExecutionCommandOutput extends DescribePipeline /** *

Describes the details of a pipeline execution.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { SageMakerClient, DescribePipelineExecutionCommand } from "@aws-sdk/client-sagemaker"; // ES Modules import + * // const { SageMakerClient, DescribePipelineExecutionCommand } = require("@aws-sdk/client-sagemaker"); // CommonJS import + * const client = new SageMakerClient(config); + * const command = new DescribePipelineExecutionCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribePipelineExecutionCommandInput} for command's `input` shape. + * @see {@link DescribePipelineExecutionCommandOutput} for command's `response` shape. + * @see {@link SageMakerClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribePipelineExecutionCommand extends $Command< DescribePipelineExecutionCommandInput, diff --git a/clients/client-sagemaker/commands/DescribeProcessingJobCommand.ts b/clients/client-sagemaker/commands/DescribeProcessingJobCommand.ts index ed0dbaa5e858..d4b47180e224 100644 --- a/clients/client-sagemaker/commands/DescribeProcessingJobCommand.ts +++ b/clients/client-sagemaker/commands/DescribeProcessingJobCommand.ts @@ -22,6 +22,20 @@ export interface DescribeProcessingJobCommandOutput extends DescribeProcessingJo /** *

Returns a description of a processing job.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { SageMakerClient, DescribeProcessingJobCommand } from "@aws-sdk/client-sagemaker"; // ES Modules import + * // const { SageMakerClient, DescribeProcessingJobCommand } = require("@aws-sdk/client-sagemaker"); // CommonJS import + * const client = new SageMakerClient(config); + * const command = new DescribeProcessingJobCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeProcessingJobCommandInput} for command's `input` shape. + * @see {@link DescribeProcessingJobCommandOutput} for command's `response` shape. + * @see {@link SageMakerClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeProcessingJobCommand extends $Command< DescribeProcessingJobCommandInput, diff --git a/clients/client-sagemaker/commands/DescribeProjectCommand.ts b/clients/client-sagemaker/commands/DescribeProjectCommand.ts index a2120e52f0de..9d0033e451d7 100644 --- a/clients/client-sagemaker/commands/DescribeProjectCommand.ts +++ b/clients/client-sagemaker/commands/DescribeProjectCommand.ts @@ -22,6 +22,20 @@ export interface DescribeProjectCommandOutput extends DescribeProjectOutput, __M /** *

Describes the details of a project.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { SageMakerClient, DescribeProjectCommand } from "@aws-sdk/client-sagemaker"; // ES Modules import + * // const { SageMakerClient, DescribeProjectCommand } = require("@aws-sdk/client-sagemaker"); // CommonJS import + * const client = new SageMakerClient(config); + * const command = new DescribeProjectCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeProjectCommandInput} for command's `input` shape. + * @see {@link DescribeProjectCommandOutput} for command's `response` shape. + * @see {@link SageMakerClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeProjectCommand extends $Command< DescribeProjectCommandInput, diff --git a/clients/client-sagemaker/commands/DescribeSubscribedWorkteamCommand.ts b/clients/client-sagemaker/commands/DescribeSubscribedWorkteamCommand.ts index 11cec70ed48b..40b8dfd2a091 100644 --- a/clients/client-sagemaker/commands/DescribeSubscribedWorkteamCommand.ts +++ b/clients/client-sagemaker/commands/DescribeSubscribedWorkteamCommand.ts @@ -23,6 +23,20 @@ export interface DescribeSubscribedWorkteamCommandOutput extends DescribeSubscri /** *

Gets information about a work team provided by a vendor. It returns details about the * subscription with a vendor in the AWS Marketplace.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { SageMakerClient, DescribeSubscribedWorkteamCommand } from "@aws-sdk/client-sagemaker"; // ES Modules import + * // const { SageMakerClient, DescribeSubscribedWorkteamCommand } = require("@aws-sdk/client-sagemaker"); // CommonJS import + * const client = new SageMakerClient(config); + * const command = new DescribeSubscribedWorkteamCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeSubscribedWorkteamCommandInput} for command's `input` shape. + * @see {@link DescribeSubscribedWorkteamCommandOutput} for command's `response` shape. + * @see {@link SageMakerClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeSubscribedWorkteamCommand extends $Command< DescribeSubscribedWorkteamCommandInput, diff --git a/clients/client-sagemaker/commands/DescribeTrainingJobCommand.ts b/clients/client-sagemaker/commands/DescribeTrainingJobCommand.ts index 5584a081645c..5da56a8c39f5 100644 --- a/clients/client-sagemaker/commands/DescribeTrainingJobCommand.ts +++ b/clients/client-sagemaker/commands/DescribeTrainingJobCommand.ts @@ -28,6 +28,20 @@ export interface DescribeTrainingJobCommandOutput extends DescribeTrainingJobRes * TrainingStartTime, TrainingTimeInSeconds, * TrainingEndTime, and BillableTimeInSeconds may not be * present in the response.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { SageMakerClient, DescribeTrainingJobCommand } from "@aws-sdk/client-sagemaker"; // ES Modules import + * // const { SageMakerClient, DescribeTrainingJobCommand } = require("@aws-sdk/client-sagemaker"); // CommonJS import + * const client = new SageMakerClient(config); + * const command = new DescribeTrainingJobCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeTrainingJobCommandInput} for command's `input` shape. + * @see {@link DescribeTrainingJobCommandOutput} for command's `response` shape. + * @see {@link SageMakerClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeTrainingJobCommand extends $Command< DescribeTrainingJobCommandInput, diff --git a/clients/client-sagemaker/commands/DescribeTransformJobCommand.ts b/clients/client-sagemaker/commands/DescribeTransformJobCommand.ts index b45f3b2a4989..298080354912 100644 --- a/clients/client-sagemaker/commands/DescribeTransformJobCommand.ts +++ b/clients/client-sagemaker/commands/DescribeTransformJobCommand.ts @@ -22,6 +22,20 @@ export interface DescribeTransformJobCommandOutput extends DescribeTransformJobR /** *

Returns information about a transform job.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { SageMakerClient, DescribeTransformJobCommand } from "@aws-sdk/client-sagemaker"; // ES Modules import + * // const { SageMakerClient, DescribeTransformJobCommand } = require("@aws-sdk/client-sagemaker"); // CommonJS import + * const client = new SageMakerClient(config); + * const command = new DescribeTransformJobCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeTransformJobCommandInput} for command's `input` shape. + * @see {@link DescribeTransformJobCommandOutput} for command's `response` shape. + * @see {@link SageMakerClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeTransformJobCommand extends $Command< DescribeTransformJobCommandInput, diff --git a/clients/client-sagemaker/commands/DescribeTrialCommand.ts b/clients/client-sagemaker/commands/DescribeTrialCommand.ts index 9ef5b60ddae4..8ed9e7dab05a 100644 --- a/clients/client-sagemaker/commands/DescribeTrialCommand.ts +++ b/clients/client-sagemaker/commands/DescribeTrialCommand.ts @@ -22,6 +22,20 @@ export interface DescribeTrialCommandOutput extends DescribeTrialResponse, __Met /** *

Provides a list of a trial's properties.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { SageMakerClient, DescribeTrialCommand } from "@aws-sdk/client-sagemaker"; // ES Modules import + * // const { SageMakerClient, DescribeTrialCommand } = require("@aws-sdk/client-sagemaker"); // CommonJS import + * const client = new SageMakerClient(config); + * const command = new DescribeTrialCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeTrialCommandInput} for command's `input` shape. + * @see {@link DescribeTrialCommandOutput} for command's `response` shape. + * @see {@link SageMakerClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeTrialCommand extends $Command< DescribeTrialCommandInput, diff --git a/clients/client-sagemaker/commands/DescribeTrialComponentCommand.ts b/clients/client-sagemaker/commands/DescribeTrialComponentCommand.ts index 7e6a7bccfb75..4c9e2fee533a 100644 --- a/clients/client-sagemaker/commands/DescribeTrialComponentCommand.ts +++ b/clients/client-sagemaker/commands/DescribeTrialComponentCommand.ts @@ -22,6 +22,20 @@ export interface DescribeTrialComponentCommandOutput extends DescribeTrialCompon /** *

Provides a list of a trials component's properties.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { SageMakerClient, DescribeTrialComponentCommand } from "@aws-sdk/client-sagemaker"; // ES Modules import + * // const { SageMakerClient, DescribeTrialComponentCommand } = require("@aws-sdk/client-sagemaker"); // CommonJS import + * const client = new SageMakerClient(config); + * const command = new DescribeTrialComponentCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeTrialComponentCommandInput} for command's `input` shape. + * @see {@link DescribeTrialComponentCommandOutput} for command's `response` shape. + * @see {@link SageMakerClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeTrialComponentCommand extends $Command< DescribeTrialComponentCommandInput, diff --git a/clients/client-sagemaker/commands/DescribeUserProfileCommand.ts b/clients/client-sagemaker/commands/DescribeUserProfileCommand.ts index a44590426df0..a3e51b048dd6 100644 --- a/clients/client-sagemaker/commands/DescribeUserProfileCommand.ts +++ b/clients/client-sagemaker/commands/DescribeUserProfileCommand.ts @@ -22,6 +22,20 @@ export interface DescribeUserProfileCommandOutput extends DescribeUserProfileRes /** *

Describes a user profile. For more information, see CreateUserProfile.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { SageMakerClient, DescribeUserProfileCommand } from "@aws-sdk/client-sagemaker"; // ES Modules import + * // const { SageMakerClient, DescribeUserProfileCommand } = require("@aws-sdk/client-sagemaker"); // CommonJS import + * const client = new SageMakerClient(config); + * const command = new DescribeUserProfileCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeUserProfileCommandInput} for command's `input` shape. + * @see {@link DescribeUserProfileCommandOutput} for command's `response` shape. + * @see {@link SageMakerClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeUserProfileCommand extends $Command< DescribeUserProfileCommandInput, diff --git a/clients/client-sagemaker/commands/DescribeWorkforceCommand.ts b/clients/client-sagemaker/commands/DescribeWorkforceCommand.ts index d8a48f0c82bb..419bd55f346c 100644 --- a/clients/client-sagemaker/commands/DescribeWorkforceCommand.ts +++ b/clients/client-sagemaker/commands/DescribeWorkforceCommand.ts @@ -27,6 +27,20 @@ export interface DescribeWorkforceCommandOutput extends DescribeWorkforceRespons * *

This operation applies only to private workforces.

* + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { SageMakerClient, DescribeWorkforceCommand } from "@aws-sdk/client-sagemaker"; // ES Modules import + * // const { SageMakerClient, DescribeWorkforceCommand } = require("@aws-sdk/client-sagemaker"); // CommonJS import + * const client = new SageMakerClient(config); + * const command = new DescribeWorkforceCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeWorkforceCommandInput} for command's `input` shape. + * @see {@link DescribeWorkforceCommandOutput} for command's `response` shape. + * @see {@link SageMakerClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeWorkforceCommand extends $Command< DescribeWorkforceCommandInput, diff --git a/clients/client-sagemaker/commands/DescribeWorkteamCommand.ts b/clients/client-sagemaker/commands/DescribeWorkteamCommand.ts index 859a99bcc14e..828c9b65f8fa 100644 --- a/clients/client-sagemaker/commands/DescribeWorkteamCommand.ts +++ b/clients/client-sagemaker/commands/DescribeWorkteamCommand.ts @@ -25,6 +25,20 @@ export interface DescribeWorkteamCommandOutput extends DescribeWorkteamResponse, *

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).

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { SageMakerClient, DescribeWorkteamCommand } from "@aws-sdk/client-sagemaker"; // ES Modules import + * // const { SageMakerClient, DescribeWorkteamCommand } = require("@aws-sdk/client-sagemaker"); // CommonJS import + * const client = new SageMakerClient(config); + * const command = new DescribeWorkteamCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeWorkteamCommandInput} for command's `input` shape. + * @see {@link DescribeWorkteamCommandOutput} for command's `response` shape. + * @see {@link SageMakerClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeWorkteamCommand extends $Command< DescribeWorkteamCommandInput, diff --git a/clients/client-sagemaker/commands/DisableSagemakerServicecatalogPortfolioCommand.ts b/clients/client-sagemaker/commands/DisableSagemakerServicecatalogPortfolioCommand.ts index 5740acbf1921..b03c1cd3a781 100644 --- a/clients/client-sagemaker/commands/DisableSagemakerServicecatalogPortfolioCommand.ts +++ b/clients/client-sagemaker/commands/DisableSagemakerServicecatalogPortfolioCommand.ts @@ -29,6 +29,20 @@ export interface DisableSagemakerServicecatalogPortfolioCommandOutput /** *

Disables using Service Catalog in SageMaker. Service Catalog is used to create * SageMaker projects.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { SageMakerClient, DisableSagemakerServicecatalogPortfolioCommand } from "@aws-sdk/client-sagemaker"; // ES Modules import + * // const { SageMakerClient, DisableSagemakerServicecatalogPortfolioCommand } = require("@aws-sdk/client-sagemaker"); // CommonJS import + * const client = new SageMakerClient(config); + * const command = new DisableSagemakerServicecatalogPortfolioCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DisableSagemakerServicecatalogPortfolioCommandInput} for command's `input` shape. + * @see {@link DisableSagemakerServicecatalogPortfolioCommandOutput} for command's `response` shape. + * @see {@link SageMakerClientResolvedConfig | config} for command's `input` shape. + * */ export class DisableSagemakerServicecatalogPortfolioCommand extends $Command< DisableSagemakerServicecatalogPortfolioCommandInput, diff --git a/clients/client-sagemaker/commands/DisassociateTrialComponentCommand.ts b/clients/client-sagemaker/commands/DisassociateTrialComponentCommand.ts index bf4c022a6247..642748512fdb 100644 --- a/clients/client-sagemaker/commands/DisassociateTrialComponentCommand.ts +++ b/clients/client-sagemaker/commands/DisassociateTrialComponentCommand.ts @@ -27,6 +27,20 @@ export interface DisassociateTrialComponentCommandOutput extends DisassociateTri * 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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { SageMakerClient, DisassociateTrialComponentCommand } from "@aws-sdk/client-sagemaker"; // ES Modules import + * // const { SageMakerClient, DisassociateTrialComponentCommand } = require("@aws-sdk/client-sagemaker"); // CommonJS import + * const client = new SageMakerClient(config); + * const command = new DisassociateTrialComponentCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DisassociateTrialComponentCommandInput} for command's `input` shape. + * @see {@link DisassociateTrialComponentCommandOutput} for command's `response` shape. + * @see {@link SageMakerClientResolvedConfig | config} for command's `input` shape. + * */ export class DisassociateTrialComponentCommand extends $Command< DisassociateTrialComponentCommandInput, diff --git a/clients/client-sagemaker/commands/EnableSagemakerServicecatalogPortfolioCommand.ts b/clients/client-sagemaker/commands/EnableSagemakerServicecatalogPortfolioCommand.ts index ba71f564f1aa..08961150e17b 100644 --- a/clients/client-sagemaker/commands/EnableSagemakerServicecatalogPortfolioCommand.ts +++ b/clients/client-sagemaker/commands/EnableSagemakerServicecatalogPortfolioCommand.ts @@ -29,6 +29,20 @@ export interface EnableSagemakerServicecatalogPortfolioCommandOutput /** *

Enables using Service Catalog in SageMaker. Service Catalog is used to create * SageMaker projects.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { SageMakerClient, EnableSagemakerServicecatalogPortfolioCommand } from "@aws-sdk/client-sagemaker"; // ES Modules import + * // const { SageMakerClient, EnableSagemakerServicecatalogPortfolioCommand } = require("@aws-sdk/client-sagemaker"); // CommonJS import + * const client = new SageMakerClient(config); + * const command = new EnableSagemakerServicecatalogPortfolioCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link EnableSagemakerServicecatalogPortfolioCommandInput} for command's `input` shape. + * @see {@link EnableSagemakerServicecatalogPortfolioCommandOutput} for command's `response` shape. + * @see {@link SageMakerClientResolvedConfig | config} for command's `input` shape. + * */ export class EnableSagemakerServicecatalogPortfolioCommand extends $Command< EnableSagemakerServicecatalogPortfolioCommandInput, diff --git a/clients/client-sagemaker/commands/GetDeviceFleetReportCommand.ts b/clients/client-sagemaker/commands/GetDeviceFleetReportCommand.ts index ffd619bc7954..126467624aad 100644 --- a/clients/client-sagemaker/commands/GetDeviceFleetReportCommand.ts +++ b/clients/client-sagemaker/commands/GetDeviceFleetReportCommand.ts @@ -22,6 +22,20 @@ export interface GetDeviceFleetReportCommandOutput extends GetDeviceFleetReportR /** *

Describes a fleet.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { SageMakerClient, GetDeviceFleetReportCommand } from "@aws-sdk/client-sagemaker"; // ES Modules import + * // const { SageMakerClient, GetDeviceFleetReportCommand } = require("@aws-sdk/client-sagemaker"); // CommonJS import + * const client = new SageMakerClient(config); + * const command = new GetDeviceFleetReportCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetDeviceFleetReportCommandInput} for command's `input` shape. + * @see {@link GetDeviceFleetReportCommandOutput} for command's `response` shape. + * @see {@link SageMakerClientResolvedConfig | config} for command's `input` shape. + * */ export class GetDeviceFleetReportCommand extends $Command< GetDeviceFleetReportCommandInput, diff --git a/clients/client-sagemaker/commands/GetModelPackageGroupPolicyCommand.ts b/clients/client-sagemaker/commands/GetModelPackageGroupPolicyCommand.ts index e3694a87cc37..826dc0e3fe8d 100644 --- a/clients/client-sagemaker/commands/GetModelPackageGroupPolicyCommand.ts +++ b/clients/client-sagemaker/commands/GetModelPackageGroupPolicyCommand.ts @@ -25,6 +25,20 @@ export interface GetModelPackageGroupPolicyCommandOutput extends GetModelPackage * resource policies, see Identity-based * policies and resource-based policies in the AWS Identity and * Access Management User Guide..

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { SageMakerClient, GetModelPackageGroupPolicyCommand } from "@aws-sdk/client-sagemaker"; // ES Modules import + * // const { SageMakerClient, GetModelPackageGroupPolicyCommand } = require("@aws-sdk/client-sagemaker"); // CommonJS import + * const client = new SageMakerClient(config); + * const command = new GetModelPackageGroupPolicyCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetModelPackageGroupPolicyCommandInput} for command's `input` shape. + * @see {@link GetModelPackageGroupPolicyCommandOutput} for command's `response` shape. + * @see {@link SageMakerClientResolvedConfig | config} for command's `input` shape. + * */ export class GetModelPackageGroupPolicyCommand extends $Command< GetModelPackageGroupPolicyCommandInput, diff --git a/clients/client-sagemaker/commands/GetSagemakerServicecatalogPortfolioStatusCommand.ts b/clients/client-sagemaker/commands/GetSagemakerServicecatalogPortfolioStatusCommand.ts index ea243014bc98..0d6f15a3e0ee 100644 --- a/clients/client-sagemaker/commands/GetSagemakerServicecatalogPortfolioStatusCommand.ts +++ b/clients/client-sagemaker/commands/GetSagemakerServicecatalogPortfolioStatusCommand.ts @@ -29,6 +29,20 @@ export interface GetSagemakerServicecatalogPortfolioStatusCommandOutput /** *

Gets the status of Service Catalog in SageMaker. Service Catalog is used to create * SageMaker projects.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { SageMakerClient, GetSagemakerServicecatalogPortfolioStatusCommand } from "@aws-sdk/client-sagemaker"; // ES Modules import + * // const { SageMakerClient, GetSagemakerServicecatalogPortfolioStatusCommand } = require("@aws-sdk/client-sagemaker"); // CommonJS import + * const client = new SageMakerClient(config); + * const command = new GetSagemakerServicecatalogPortfolioStatusCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetSagemakerServicecatalogPortfolioStatusCommandInput} for command's `input` shape. + * @see {@link GetSagemakerServicecatalogPortfolioStatusCommandOutput} for command's `response` shape. + * @see {@link SageMakerClientResolvedConfig | config} for command's `input` shape. + * */ export class GetSagemakerServicecatalogPortfolioStatusCommand extends $Command< GetSagemakerServicecatalogPortfolioStatusCommandInput, diff --git a/clients/client-sagemaker/commands/GetSearchSuggestionsCommand.ts b/clients/client-sagemaker/commands/GetSearchSuggestionsCommand.ts index 280a084c054e..733049ce1641 100644 --- a/clients/client-sagemaker/commands/GetSearchSuggestionsCommand.ts +++ b/clients/client-sagemaker/commands/GetSearchSuggestionsCommand.ts @@ -25,6 +25,20 @@ export interface GetSearchSuggestionsCommandOutput extends GetSearchSuggestionsR * suggestions of possible matches for the property name to use in Search * queries. Provides suggestions for HyperParameters, Tags, and * Metrics.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { SageMakerClient, GetSearchSuggestionsCommand } from "@aws-sdk/client-sagemaker"; // ES Modules import + * // const { SageMakerClient, GetSearchSuggestionsCommand } = require("@aws-sdk/client-sagemaker"); // CommonJS import + * const client = new SageMakerClient(config); + * const command = new GetSearchSuggestionsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetSearchSuggestionsCommandInput} for command's `input` shape. + * @see {@link GetSearchSuggestionsCommandOutput} for command's `response` shape. + * @see {@link SageMakerClientResolvedConfig | config} for command's `input` shape. + * */ export class GetSearchSuggestionsCommand extends $Command< GetSearchSuggestionsCommandInput, diff --git a/clients/client-sagemaker/commands/ListActionsCommand.ts b/clients/client-sagemaker/commands/ListActionsCommand.ts index 0ee3cae3ca8b..844214c055ac 100644 --- a/clients/client-sagemaker/commands/ListActionsCommand.ts +++ b/clients/client-sagemaker/commands/ListActionsCommand.ts @@ -22,6 +22,20 @@ export interface ListActionsCommandOutput extends ListActionsResponse, __Metadat /** *

Lists the actions in your account and their properties.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { SageMakerClient, ListActionsCommand } from "@aws-sdk/client-sagemaker"; // ES Modules import + * // const { SageMakerClient, ListActionsCommand } = require("@aws-sdk/client-sagemaker"); // CommonJS import + * const client = new SageMakerClient(config); + * const command = new ListActionsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListActionsCommandInput} for command's `input` shape. + * @see {@link ListActionsCommandOutput} for command's `response` shape. + * @see {@link SageMakerClientResolvedConfig | config} for command's `input` shape. + * */ export class ListActionsCommand extends $Command< ListActionsCommandInput, diff --git a/clients/client-sagemaker/commands/ListAlgorithmsCommand.ts b/clients/client-sagemaker/commands/ListAlgorithmsCommand.ts index da1a1e5a9d83..c7cfa11a5779 100644 --- a/clients/client-sagemaker/commands/ListAlgorithmsCommand.ts +++ b/clients/client-sagemaker/commands/ListAlgorithmsCommand.ts @@ -22,6 +22,20 @@ export interface ListAlgorithmsCommandOutput extends ListAlgorithmsOutput, __Met /** *

Lists the machine learning algorithms that have been created.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { SageMakerClient, ListAlgorithmsCommand } from "@aws-sdk/client-sagemaker"; // ES Modules import + * // const { SageMakerClient, ListAlgorithmsCommand } = require("@aws-sdk/client-sagemaker"); // CommonJS import + * const client = new SageMakerClient(config); + * const command = new ListAlgorithmsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListAlgorithmsCommandInput} for command's `input` shape. + * @see {@link ListAlgorithmsCommandOutput} for command's `response` shape. + * @see {@link SageMakerClientResolvedConfig | config} for command's `input` shape. + * */ export class ListAlgorithmsCommand extends $Command< ListAlgorithmsCommandInput, diff --git a/clients/client-sagemaker/commands/ListAppImageConfigsCommand.ts b/clients/client-sagemaker/commands/ListAppImageConfigsCommand.ts index ec185b932e00..6277d7416a06 100644 --- a/clients/client-sagemaker/commands/ListAppImageConfigsCommand.ts +++ b/clients/client-sagemaker/commands/ListAppImageConfigsCommand.ts @@ -24,6 +24,20 @@ export interface ListAppImageConfigsCommandOutput extends ListAppImageConfigsRes *

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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { SageMakerClient, ListAppImageConfigsCommand } from "@aws-sdk/client-sagemaker"; // ES Modules import + * // const { SageMakerClient, ListAppImageConfigsCommand } = require("@aws-sdk/client-sagemaker"); // CommonJS import + * const client = new SageMakerClient(config); + * const command = new ListAppImageConfigsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListAppImageConfigsCommandInput} for command's `input` shape. + * @see {@link ListAppImageConfigsCommandOutput} for command's `response` shape. + * @see {@link SageMakerClientResolvedConfig | config} for command's `input` shape. + * */ export class ListAppImageConfigsCommand extends $Command< ListAppImageConfigsCommandInput, diff --git a/clients/client-sagemaker/commands/ListAppsCommand.ts b/clients/client-sagemaker/commands/ListAppsCommand.ts index ad889c5aa580..373c39cd82a3 100644 --- a/clients/client-sagemaker/commands/ListAppsCommand.ts +++ b/clients/client-sagemaker/commands/ListAppsCommand.ts @@ -19,6 +19,20 @@ export interface ListAppsCommandOutput extends ListAppsResponse, __MetadataBeare /** *

Lists apps.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { SageMakerClient, ListAppsCommand } from "@aws-sdk/client-sagemaker"; // ES Modules import + * // const { SageMakerClient, ListAppsCommand } = require("@aws-sdk/client-sagemaker"); // CommonJS import + * const client = new SageMakerClient(config); + * const command = new ListAppsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListAppsCommandInput} for command's `input` shape. + * @see {@link ListAppsCommandOutput} for command's `response` shape. + * @see {@link SageMakerClientResolvedConfig | config} for command's `input` shape. + * */ export class ListAppsCommand extends $Command< ListAppsCommandInput, diff --git a/clients/client-sagemaker/commands/ListArtifactsCommand.ts b/clients/client-sagemaker/commands/ListArtifactsCommand.ts index c6ad6f11330e..0778b495293c 100644 --- a/clients/client-sagemaker/commands/ListArtifactsCommand.ts +++ b/clients/client-sagemaker/commands/ListArtifactsCommand.ts @@ -22,6 +22,20 @@ export interface ListArtifactsCommandOutput extends ListArtifactsResponse, __Met /** *

Lists the artifacts in your account and their properties.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { SageMakerClient, ListArtifactsCommand } from "@aws-sdk/client-sagemaker"; // ES Modules import + * // const { SageMakerClient, ListArtifactsCommand } = require("@aws-sdk/client-sagemaker"); // CommonJS import + * const client = new SageMakerClient(config); + * const command = new ListArtifactsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListArtifactsCommandInput} for command's `input` shape. + * @see {@link ListArtifactsCommandOutput} for command's `response` shape. + * @see {@link SageMakerClientResolvedConfig | config} for command's `input` shape. + * */ export class ListArtifactsCommand extends $Command< ListArtifactsCommandInput, diff --git a/clients/client-sagemaker/commands/ListAssociationsCommand.ts b/clients/client-sagemaker/commands/ListAssociationsCommand.ts index 730c03c524bf..bcfa07b29b0d 100644 --- a/clients/client-sagemaker/commands/ListAssociationsCommand.ts +++ b/clients/client-sagemaker/commands/ListAssociationsCommand.ts @@ -22,6 +22,20 @@ export interface ListAssociationsCommandOutput extends ListAssociationsResponse, /** *

Lists the associations in your account and their properties.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { SageMakerClient, ListAssociationsCommand } from "@aws-sdk/client-sagemaker"; // ES Modules import + * // const { SageMakerClient, ListAssociationsCommand } = require("@aws-sdk/client-sagemaker"); // CommonJS import + * const client = new SageMakerClient(config); + * const command = new ListAssociationsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListAssociationsCommandInput} for command's `input` shape. + * @see {@link ListAssociationsCommandOutput} for command's `response` shape. + * @see {@link SageMakerClientResolvedConfig | config} for command's `input` shape. + * */ export class ListAssociationsCommand extends $Command< ListAssociationsCommandInput, diff --git a/clients/client-sagemaker/commands/ListAutoMLJobsCommand.ts b/clients/client-sagemaker/commands/ListAutoMLJobsCommand.ts index db614185b8ee..59d5e9d2a1b0 100644 --- a/clients/client-sagemaker/commands/ListAutoMLJobsCommand.ts +++ b/clients/client-sagemaker/commands/ListAutoMLJobsCommand.ts @@ -22,6 +22,20 @@ export interface ListAutoMLJobsCommandOutput extends ListAutoMLJobsResponse, __M /** *

Request a list of jobs.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { SageMakerClient, ListAutoMLJobsCommand } from "@aws-sdk/client-sagemaker"; // ES Modules import + * // const { SageMakerClient, ListAutoMLJobsCommand } = require("@aws-sdk/client-sagemaker"); // CommonJS import + * const client = new SageMakerClient(config); + * const command = new ListAutoMLJobsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListAutoMLJobsCommandInput} for command's `input` shape. + * @see {@link ListAutoMLJobsCommandOutput} for command's `response` shape. + * @see {@link SageMakerClientResolvedConfig | config} for command's `input` shape. + * */ export class ListAutoMLJobsCommand extends $Command< ListAutoMLJobsCommandInput, diff --git a/clients/client-sagemaker/commands/ListCandidatesForAutoMLJobCommand.ts b/clients/client-sagemaker/commands/ListCandidatesForAutoMLJobCommand.ts index 48bb807ab700..bb07b1abd71d 100644 --- a/clients/client-sagemaker/commands/ListCandidatesForAutoMLJobCommand.ts +++ b/clients/client-sagemaker/commands/ListCandidatesForAutoMLJobCommand.ts @@ -22,6 +22,20 @@ export interface ListCandidatesForAutoMLJobCommandOutput extends ListCandidatesF /** *

List the candidates created for the job.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { SageMakerClient, ListCandidatesForAutoMLJobCommand } from "@aws-sdk/client-sagemaker"; // ES Modules import + * // const { SageMakerClient, ListCandidatesForAutoMLJobCommand } = require("@aws-sdk/client-sagemaker"); // CommonJS import + * const client = new SageMakerClient(config); + * const command = new ListCandidatesForAutoMLJobCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListCandidatesForAutoMLJobCommandInput} for command's `input` shape. + * @see {@link ListCandidatesForAutoMLJobCommandOutput} for command's `response` shape. + * @see {@link SageMakerClientResolvedConfig | config} for command's `input` shape. + * */ export class ListCandidatesForAutoMLJobCommand extends $Command< ListCandidatesForAutoMLJobCommandInput, diff --git a/clients/client-sagemaker/commands/ListCodeRepositoriesCommand.ts b/clients/client-sagemaker/commands/ListCodeRepositoriesCommand.ts index 4d4ef0e3fe11..c75118a6fd2e 100644 --- a/clients/client-sagemaker/commands/ListCodeRepositoriesCommand.ts +++ b/clients/client-sagemaker/commands/ListCodeRepositoriesCommand.ts @@ -22,6 +22,20 @@ export interface ListCodeRepositoriesCommandOutput extends ListCodeRepositoriesO /** *

Gets a list of the Git repositories in your account.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { SageMakerClient, ListCodeRepositoriesCommand } from "@aws-sdk/client-sagemaker"; // ES Modules import + * // const { SageMakerClient, ListCodeRepositoriesCommand } = require("@aws-sdk/client-sagemaker"); // CommonJS import + * const client = new SageMakerClient(config); + * const command = new ListCodeRepositoriesCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListCodeRepositoriesCommandInput} for command's `input` shape. + * @see {@link ListCodeRepositoriesCommandOutput} for command's `response` shape. + * @see {@link SageMakerClientResolvedConfig | config} for command's `input` shape. + * */ export class ListCodeRepositoriesCommand extends $Command< ListCodeRepositoriesCommandInput, diff --git a/clients/client-sagemaker/commands/ListCompilationJobsCommand.ts b/clients/client-sagemaker/commands/ListCompilationJobsCommand.ts index 5987c4f43188..d645137d6351 100644 --- a/clients/client-sagemaker/commands/ListCompilationJobsCommand.ts +++ b/clients/client-sagemaker/commands/ListCompilationJobsCommand.ts @@ -24,6 +24,20 @@ export interface ListCompilationJobsCommandOutput extends ListCompilationJobsRes *

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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { SageMakerClient, ListCompilationJobsCommand } from "@aws-sdk/client-sagemaker"; // ES Modules import + * // const { SageMakerClient, ListCompilationJobsCommand } = require("@aws-sdk/client-sagemaker"); // CommonJS import + * const client = new SageMakerClient(config); + * const command = new ListCompilationJobsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListCompilationJobsCommandInput} for command's `input` shape. + * @see {@link ListCompilationJobsCommandOutput} for command's `response` shape. + * @see {@link SageMakerClientResolvedConfig | config} for command's `input` shape. + * */ export class ListCompilationJobsCommand extends $Command< ListCompilationJobsCommandInput, diff --git a/clients/client-sagemaker/commands/ListContextsCommand.ts b/clients/client-sagemaker/commands/ListContextsCommand.ts index 2f144db663a8..ab3f1147be16 100644 --- a/clients/client-sagemaker/commands/ListContextsCommand.ts +++ b/clients/client-sagemaker/commands/ListContextsCommand.ts @@ -22,6 +22,20 @@ export interface ListContextsCommandOutput extends ListContextsResponse, __Metad /** *

Lists the contexts in your account and their properties.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { SageMakerClient, ListContextsCommand } from "@aws-sdk/client-sagemaker"; // ES Modules import + * // const { SageMakerClient, ListContextsCommand } = require("@aws-sdk/client-sagemaker"); // CommonJS import + * const client = new SageMakerClient(config); + * const command = new ListContextsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListContextsCommandInput} for command's `input` shape. + * @see {@link ListContextsCommandOutput} for command's `response` shape. + * @see {@link SageMakerClientResolvedConfig | config} for command's `input` shape. + * */ export class ListContextsCommand extends $Command< ListContextsCommandInput, diff --git a/clients/client-sagemaker/commands/ListDataQualityJobDefinitionsCommand.ts b/clients/client-sagemaker/commands/ListDataQualityJobDefinitionsCommand.ts index 3d3813eb67d5..fca0331a9425 100644 --- a/clients/client-sagemaker/commands/ListDataQualityJobDefinitionsCommand.ts +++ b/clients/client-sagemaker/commands/ListDataQualityJobDefinitionsCommand.ts @@ -24,6 +24,20 @@ export interface ListDataQualityJobDefinitionsCommandOutput /** *

Lists the data quality job definitions in your account.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { SageMakerClient, ListDataQualityJobDefinitionsCommand } from "@aws-sdk/client-sagemaker"; // ES Modules import + * // const { SageMakerClient, ListDataQualityJobDefinitionsCommand } = require("@aws-sdk/client-sagemaker"); // CommonJS import + * const client = new SageMakerClient(config); + * const command = new ListDataQualityJobDefinitionsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListDataQualityJobDefinitionsCommandInput} for command's `input` shape. + * @see {@link ListDataQualityJobDefinitionsCommandOutput} for command's `response` shape. + * @see {@link SageMakerClientResolvedConfig | config} for command's `input` shape. + * */ export class ListDataQualityJobDefinitionsCommand extends $Command< ListDataQualityJobDefinitionsCommandInput, diff --git a/clients/client-sagemaker/commands/ListDeviceFleetsCommand.ts b/clients/client-sagemaker/commands/ListDeviceFleetsCommand.ts index 7d7e853d68fd..b3e8b44e3165 100644 --- a/clients/client-sagemaker/commands/ListDeviceFleetsCommand.ts +++ b/clients/client-sagemaker/commands/ListDeviceFleetsCommand.ts @@ -22,6 +22,20 @@ export interface ListDeviceFleetsCommandOutput extends ListDeviceFleetsResponse, /** *

Returns a list of devices in the fleet.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { SageMakerClient, ListDeviceFleetsCommand } from "@aws-sdk/client-sagemaker"; // ES Modules import + * // const { SageMakerClient, ListDeviceFleetsCommand } = require("@aws-sdk/client-sagemaker"); // CommonJS import + * const client = new SageMakerClient(config); + * const command = new ListDeviceFleetsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListDeviceFleetsCommandInput} for command's `input` shape. + * @see {@link ListDeviceFleetsCommandOutput} for command's `response` shape. + * @see {@link SageMakerClientResolvedConfig | config} for command's `input` shape. + * */ export class ListDeviceFleetsCommand extends $Command< ListDeviceFleetsCommandInput, diff --git a/clients/client-sagemaker/commands/ListDevicesCommand.ts b/clients/client-sagemaker/commands/ListDevicesCommand.ts index 0bed2a233bbb..c2eb00b03e98 100644 --- a/clients/client-sagemaker/commands/ListDevicesCommand.ts +++ b/clients/client-sagemaker/commands/ListDevicesCommand.ts @@ -22,6 +22,20 @@ export interface ListDevicesCommandOutput extends ListDevicesResponse, __Metadat /** *

A list of devices.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { SageMakerClient, ListDevicesCommand } from "@aws-sdk/client-sagemaker"; // ES Modules import + * // const { SageMakerClient, ListDevicesCommand } = require("@aws-sdk/client-sagemaker"); // CommonJS import + * const client = new SageMakerClient(config); + * const command = new ListDevicesCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListDevicesCommandInput} for command's `input` shape. + * @see {@link ListDevicesCommandOutput} for command's `response` shape. + * @see {@link SageMakerClientResolvedConfig | config} for command's `input` shape. + * */ export class ListDevicesCommand extends $Command< ListDevicesCommandInput, diff --git a/clients/client-sagemaker/commands/ListDomainsCommand.ts b/clients/client-sagemaker/commands/ListDomainsCommand.ts index ec31c2c7d5c4..ed810b01ba0f 100644 --- a/clients/client-sagemaker/commands/ListDomainsCommand.ts +++ b/clients/client-sagemaker/commands/ListDomainsCommand.ts @@ -22,6 +22,20 @@ export interface ListDomainsCommandOutput extends ListDomainsResponse, __Metadat /** *

Lists the domains.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { SageMakerClient, ListDomainsCommand } from "@aws-sdk/client-sagemaker"; // ES Modules import + * // const { SageMakerClient, ListDomainsCommand } = require("@aws-sdk/client-sagemaker"); // CommonJS import + * const client = new SageMakerClient(config); + * const command = new ListDomainsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListDomainsCommandInput} for command's `input` shape. + * @see {@link ListDomainsCommandOutput} for command's `response` shape. + * @see {@link SageMakerClientResolvedConfig | config} for command's `input` shape. + * */ export class ListDomainsCommand extends $Command< ListDomainsCommandInput, diff --git a/clients/client-sagemaker/commands/ListEdgePackagingJobsCommand.ts b/clients/client-sagemaker/commands/ListEdgePackagingJobsCommand.ts index 6148f1019c78..7fa90ab46a2b 100644 --- a/clients/client-sagemaker/commands/ListEdgePackagingJobsCommand.ts +++ b/clients/client-sagemaker/commands/ListEdgePackagingJobsCommand.ts @@ -22,6 +22,20 @@ export interface ListEdgePackagingJobsCommandOutput extends ListEdgePackagingJob /** *

Returns a list of edge packaging jobs.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { SageMakerClient, ListEdgePackagingJobsCommand } from "@aws-sdk/client-sagemaker"; // ES Modules import + * // const { SageMakerClient, ListEdgePackagingJobsCommand } = require("@aws-sdk/client-sagemaker"); // CommonJS import + * const client = new SageMakerClient(config); + * const command = new ListEdgePackagingJobsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListEdgePackagingJobsCommandInput} for command's `input` shape. + * @see {@link ListEdgePackagingJobsCommandOutput} for command's `response` shape. + * @see {@link SageMakerClientResolvedConfig | config} for command's `input` shape. + * */ export class ListEdgePackagingJobsCommand extends $Command< ListEdgePackagingJobsCommandInput, diff --git a/clients/client-sagemaker/commands/ListEndpointConfigsCommand.ts b/clients/client-sagemaker/commands/ListEndpointConfigsCommand.ts index 5bcd22841558..a8832f953747 100644 --- a/clients/client-sagemaker/commands/ListEndpointConfigsCommand.ts +++ b/clients/client-sagemaker/commands/ListEndpointConfigsCommand.ts @@ -22,6 +22,20 @@ export interface ListEndpointConfigsCommandOutput extends ListEndpointConfigsOut /** *

Lists endpoint configurations.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { SageMakerClient, ListEndpointConfigsCommand } from "@aws-sdk/client-sagemaker"; // ES Modules import + * // const { SageMakerClient, ListEndpointConfigsCommand } = require("@aws-sdk/client-sagemaker"); // CommonJS import + * const client = new SageMakerClient(config); + * const command = new ListEndpointConfigsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListEndpointConfigsCommandInput} for command's `input` shape. + * @see {@link ListEndpointConfigsCommandOutput} for command's `response` shape. + * @see {@link SageMakerClientResolvedConfig | config} for command's `input` shape. + * */ export class ListEndpointConfigsCommand extends $Command< ListEndpointConfigsCommandInput, diff --git a/clients/client-sagemaker/commands/ListEndpointsCommand.ts b/clients/client-sagemaker/commands/ListEndpointsCommand.ts index ebdf79b6e650..ab0310d5a68f 100644 --- a/clients/client-sagemaker/commands/ListEndpointsCommand.ts +++ b/clients/client-sagemaker/commands/ListEndpointsCommand.ts @@ -22,6 +22,20 @@ export interface ListEndpointsCommandOutput extends ListEndpointsOutput, __Metad /** *

Lists endpoints.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { SageMakerClient, ListEndpointsCommand } from "@aws-sdk/client-sagemaker"; // ES Modules import + * // const { SageMakerClient, ListEndpointsCommand } = require("@aws-sdk/client-sagemaker"); // CommonJS import + * const client = new SageMakerClient(config); + * const command = new ListEndpointsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListEndpointsCommandInput} for command's `input` shape. + * @see {@link ListEndpointsCommandOutput} for command's `response` shape. + * @see {@link SageMakerClientResolvedConfig | config} for command's `input` shape. + * */ export class ListEndpointsCommand extends $Command< ListEndpointsCommandInput, diff --git a/clients/client-sagemaker/commands/ListExperimentsCommand.ts b/clients/client-sagemaker/commands/ListExperimentsCommand.ts index eb2247a1c167..9aa1ecdb1d7f 100644 --- a/clients/client-sagemaker/commands/ListExperimentsCommand.ts +++ b/clients/client-sagemaker/commands/ListExperimentsCommand.ts @@ -24,6 +24,20 @@ export interface ListExperimentsCommandOutput extends ListExperimentsResponse, _ *

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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { SageMakerClient, ListExperimentsCommand } from "@aws-sdk/client-sagemaker"; // ES Modules import + * // const { SageMakerClient, ListExperimentsCommand } = require("@aws-sdk/client-sagemaker"); // CommonJS import + * const client = new SageMakerClient(config); + * const command = new ListExperimentsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListExperimentsCommandInput} for command's `input` shape. + * @see {@link ListExperimentsCommandOutput} for command's `response` shape. + * @see {@link SageMakerClientResolvedConfig | config} for command's `input` shape. + * */ export class ListExperimentsCommand extends $Command< ListExperimentsCommandInput, diff --git a/clients/client-sagemaker/commands/ListFeatureGroupsCommand.ts b/clients/client-sagemaker/commands/ListFeatureGroupsCommand.ts index 41f99fa19bba..c354d5f3a36d 100644 --- a/clients/client-sagemaker/commands/ListFeatureGroupsCommand.ts +++ b/clients/client-sagemaker/commands/ListFeatureGroupsCommand.ts @@ -22,6 +22,20 @@ export interface ListFeatureGroupsCommandOutput extends ListFeatureGroupsRespons /** *

List FeatureGroups based on given filter and order.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { SageMakerClient, ListFeatureGroupsCommand } from "@aws-sdk/client-sagemaker"; // ES Modules import + * // const { SageMakerClient, ListFeatureGroupsCommand } = require("@aws-sdk/client-sagemaker"); // CommonJS import + * const client = new SageMakerClient(config); + * const command = new ListFeatureGroupsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListFeatureGroupsCommandInput} for command's `input` shape. + * @see {@link ListFeatureGroupsCommandOutput} for command's `response` shape. + * @see {@link SageMakerClientResolvedConfig | config} for command's `input` shape. + * */ export class ListFeatureGroupsCommand extends $Command< ListFeatureGroupsCommandInput, diff --git a/clients/client-sagemaker/commands/ListFlowDefinitionsCommand.ts b/clients/client-sagemaker/commands/ListFlowDefinitionsCommand.ts index 5603c7c1c66f..5abd3daea0cb 100644 --- a/clients/client-sagemaker/commands/ListFlowDefinitionsCommand.ts +++ b/clients/client-sagemaker/commands/ListFlowDefinitionsCommand.ts @@ -22,6 +22,20 @@ export interface ListFlowDefinitionsCommandOutput extends ListFlowDefinitionsRes /** *

Returns information about the flow definitions in your account.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { SageMakerClient, ListFlowDefinitionsCommand } from "@aws-sdk/client-sagemaker"; // ES Modules import + * // const { SageMakerClient, ListFlowDefinitionsCommand } = require("@aws-sdk/client-sagemaker"); // CommonJS import + * const client = new SageMakerClient(config); + * const command = new ListFlowDefinitionsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListFlowDefinitionsCommandInput} for command's `input` shape. + * @see {@link ListFlowDefinitionsCommandOutput} for command's `response` shape. + * @see {@link SageMakerClientResolvedConfig | config} for command's `input` shape. + * */ export class ListFlowDefinitionsCommand extends $Command< ListFlowDefinitionsCommandInput, diff --git a/clients/client-sagemaker/commands/ListHumanTaskUisCommand.ts b/clients/client-sagemaker/commands/ListHumanTaskUisCommand.ts index c25f1a844228..512cf57fea94 100644 --- a/clients/client-sagemaker/commands/ListHumanTaskUisCommand.ts +++ b/clients/client-sagemaker/commands/ListHumanTaskUisCommand.ts @@ -22,6 +22,20 @@ export interface ListHumanTaskUisCommandOutput extends ListHumanTaskUisResponse, /** *

Returns information about the human task user interfaces in your account.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { SageMakerClient, ListHumanTaskUisCommand } from "@aws-sdk/client-sagemaker"; // ES Modules import + * // const { SageMakerClient, ListHumanTaskUisCommand } = require("@aws-sdk/client-sagemaker"); // CommonJS import + * const client = new SageMakerClient(config); + * const command = new ListHumanTaskUisCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListHumanTaskUisCommandInput} for command's `input` shape. + * @see {@link ListHumanTaskUisCommandOutput} for command's `response` shape. + * @see {@link SageMakerClientResolvedConfig | config} for command's `input` shape. + * */ export class ListHumanTaskUisCommand extends $Command< ListHumanTaskUisCommandInput, diff --git a/clients/client-sagemaker/commands/ListHyperParameterTuningJobsCommand.ts b/clients/client-sagemaker/commands/ListHyperParameterTuningJobsCommand.ts index 889165364065..7a0632e2dce3 100644 --- a/clients/client-sagemaker/commands/ListHyperParameterTuningJobsCommand.ts +++ b/clients/client-sagemaker/commands/ListHyperParameterTuningJobsCommand.ts @@ -26,6 +26,20 @@ export interface ListHyperParameterTuningJobsCommandOutput *

Gets a list of HyperParameterTuningJobSummary objects that * describe * the hyperparameter tuning jobs launched in your account.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { SageMakerClient, ListHyperParameterTuningJobsCommand } from "@aws-sdk/client-sagemaker"; // ES Modules import + * // const { SageMakerClient, ListHyperParameterTuningJobsCommand } = require("@aws-sdk/client-sagemaker"); // CommonJS import + * const client = new SageMakerClient(config); + * const command = new ListHyperParameterTuningJobsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListHyperParameterTuningJobsCommandInput} for command's `input` shape. + * @see {@link ListHyperParameterTuningJobsCommandOutput} for command's `response` shape. + * @see {@link SageMakerClientResolvedConfig | config} for command's `input` shape. + * */ export class ListHyperParameterTuningJobsCommand extends $Command< ListHyperParameterTuningJobsCommandInput, diff --git a/clients/client-sagemaker/commands/ListImageVersionsCommand.ts b/clients/client-sagemaker/commands/ListImageVersionsCommand.ts index c45e96f3dab8..fbc643d419cb 100644 --- a/clients/client-sagemaker/commands/ListImageVersionsCommand.ts +++ b/clients/client-sagemaker/commands/ListImageVersionsCommand.ts @@ -23,6 +23,20 @@ export interface ListImageVersionsCommandOutput extends ListImageVersionsRespons /** *

Lists the versions of a specified image and their properties. The list can be filtered * by creation time or modified time.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { SageMakerClient, ListImageVersionsCommand } from "@aws-sdk/client-sagemaker"; // ES Modules import + * // const { SageMakerClient, ListImageVersionsCommand } = require("@aws-sdk/client-sagemaker"); // CommonJS import + * const client = new SageMakerClient(config); + * const command = new ListImageVersionsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListImageVersionsCommandInput} for command's `input` shape. + * @see {@link ListImageVersionsCommandOutput} for command's `response` shape. + * @see {@link SageMakerClientResolvedConfig | config} for command's `input` shape. + * */ export class ListImageVersionsCommand extends $Command< ListImageVersionsCommandInput, diff --git a/clients/client-sagemaker/commands/ListImagesCommand.ts b/clients/client-sagemaker/commands/ListImagesCommand.ts index 9854bdc2d1aa..b548fb12dc46 100644 --- a/clients/client-sagemaker/commands/ListImagesCommand.ts +++ b/clients/client-sagemaker/commands/ListImagesCommand.ts @@ -23,6 +23,20 @@ export interface ListImagesCommandOutput extends ListImagesResponse, __MetadataB /** *

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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { SageMakerClient, ListImagesCommand } from "@aws-sdk/client-sagemaker"; // ES Modules import + * // const { SageMakerClient, ListImagesCommand } = require("@aws-sdk/client-sagemaker"); // CommonJS import + * const client = new SageMakerClient(config); + * const command = new ListImagesCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListImagesCommandInput} for command's `input` shape. + * @see {@link ListImagesCommandOutput} for command's `response` shape. + * @see {@link SageMakerClientResolvedConfig | config} for command's `input` shape. + * */ export class ListImagesCommand extends $Command< ListImagesCommandInput, diff --git a/clients/client-sagemaker/commands/ListLabelingJobsCommand.ts b/clients/client-sagemaker/commands/ListLabelingJobsCommand.ts index 67412d30cf67..91ca8f2ff02e 100644 --- a/clients/client-sagemaker/commands/ListLabelingJobsCommand.ts +++ b/clients/client-sagemaker/commands/ListLabelingJobsCommand.ts @@ -22,6 +22,20 @@ export interface ListLabelingJobsCommandOutput extends ListLabelingJobsResponse, /** *

Gets a list of labeling jobs.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { SageMakerClient, ListLabelingJobsCommand } from "@aws-sdk/client-sagemaker"; // ES Modules import + * // const { SageMakerClient, ListLabelingJobsCommand } = require("@aws-sdk/client-sagemaker"); // CommonJS import + * const client = new SageMakerClient(config); + * const command = new ListLabelingJobsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListLabelingJobsCommandInput} for command's `input` shape. + * @see {@link ListLabelingJobsCommandOutput} for command's `response` shape. + * @see {@link SageMakerClientResolvedConfig | config} for command's `input` shape. + * */ export class ListLabelingJobsCommand extends $Command< ListLabelingJobsCommandInput, diff --git a/clients/client-sagemaker/commands/ListLabelingJobsForWorkteamCommand.ts b/clients/client-sagemaker/commands/ListLabelingJobsForWorkteamCommand.ts index ded7318f0b69..f148c6a625c2 100644 --- a/clients/client-sagemaker/commands/ListLabelingJobsForWorkteamCommand.ts +++ b/clients/client-sagemaker/commands/ListLabelingJobsForWorkteamCommand.ts @@ -24,6 +24,20 @@ export interface ListLabelingJobsForWorkteamCommandOutput /** *

Gets a list of labeling jobs assigned to a specified work team.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { SageMakerClient, ListLabelingJobsForWorkteamCommand } from "@aws-sdk/client-sagemaker"; // ES Modules import + * // const { SageMakerClient, ListLabelingJobsForWorkteamCommand } = require("@aws-sdk/client-sagemaker"); // CommonJS import + * const client = new SageMakerClient(config); + * const command = new ListLabelingJobsForWorkteamCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListLabelingJobsForWorkteamCommandInput} for command's `input` shape. + * @see {@link ListLabelingJobsForWorkteamCommandOutput} for command's `response` shape. + * @see {@link SageMakerClientResolvedConfig | config} for command's `input` shape. + * */ export class ListLabelingJobsForWorkteamCommand extends $Command< ListLabelingJobsForWorkteamCommandInput, diff --git a/clients/client-sagemaker/commands/ListModelBiasJobDefinitionsCommand.ts b/clients/client-sagemaker/commands/ListModelBiasJobDefinitionsCommand.ts index e2934f655d34..8084acb617f7 100644 --- a/clients/client-sagemaker/commands/ListModelBiasJobDefinitionsCommand.ts +++ b/clients/client-sagemaker/commands/ListModelBiasJobDefinitionsCommand.ts @@ -24,6 +24,20 @@ export interface ListModelBiasJobDefinitionsCommandOutput /** *

Lists model bias jobs definitions that satisfy various filters.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { SageMakerClient, ListModelBiasJobDefinitionsCommand } from "@aws-sdk/client-sagemaker"; // ES Modules import + * // const { SageMakerClient, ListModelBiasJobDefinitionsCommand } = require("@aws-sdk/client-sagemaker"); // CommonJS import + * const client = new SageMakerClient(config); + * const command = new ListModelBiasJobDefinitionsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListModelBiasJobDefinitionsCommandInput} for command's `input` shape. + * @see {@link ListModelBiasJobDefinitionsCommandOutput} for command's `response` shape. + * @see {@link SageMakerClientResolvedConfig | config} for command's `input` shape. + * */ export class ListModelBiasJobDefinitionsCommand extends $Command< ListModelBiasJobDefinitionsCommandInput, diff --git a/clients/client-sagemaker/commands/ListModelExplainabilityJobDefinitionsCommand.ts b/clients/client-sagemaker/commands/ListModelExplainabilityJobDefinitionsCommand.ts index 65b6a5982063..d3fcedcf7a81 100644 --- a/clients/client-sagemaker/commands/ListModelExplainabilityJobDefinitionsCommand.ts +++ b/clients/client-sagemaker/commands/ListModelExplainabilityJobDefinitionsCommand.ts @@ -28,6 +28,20 @@ export interface ListModelExplainabilityJobDefinitionsCommandOutput /** *

Lists model explainability job definitions that satisfy various filters.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { SageMakerClient, ListModelExplainabilityJobDefinitionsCommand } from "@aws-sdk/client-sagemaker"; // ES Modules import + * // const { SageMakerClient, ListModelExplainabilityJobDefinitionsCommand } = require("@aws-sdk/client-sagemaker"); // CommonJS import + * const client = new SageMakerClient(config); + * const command = new ListModelExplainabilityJobDefinitionsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListModelExplainabilityJobDefinitionsCommandInput} for command's `input` shape. + * @see {@link ListModelExplainabilityJobDefinitionsCommandOutput} for command's `response` shape. + * @see {@link SageMakerClientResolvedConfig | config} for command's `input` shape. + * */ export class ListModelExplainabilityJobDefinitionsCommand extends $Command< ListModelExplainabilityJobDefinitionsCommandInput, diff --git a/clients/client-sagemaker/commands/ListModelPackageGroupsCommand.ts b/clients/client-sagemaker/commands/ListModelPackageGroupsCommand.ts index 81285131d1fc..89b4683d23c3 100644 --- a/clients/client-sagemaker/commands/ListModelPackageGroupsCommand.ts +++ b/clients/client-sagemaker/commands/ListModelPackageGroupsCommand.ts @@ -22,6 +22,20 @@ export interface ListModelPackageGroupsCommandOutput extends ListModelPackageGro /** *

Gets a list of the model groups in your AWS account.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { SageMakerClient, ListModelPackageGroupsCommand } from "@aws-sdk/client-sagemaker"; // ES Modules import + * // const { SageMakerClient, ListModelPackageGroupsCommand } = require("@aws-sdk/client-sagemaker"); // CommonJS import + * const client = new SageMakerClient(config); + * const command = new ListModelPackageGroupsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListModelPackageGroupsCommandInput} for command's `input` shape. + * @see {@link ListModelPackageGroupsCommandOutput} for command's `response` shape. + * @see {@link SageMakerClientResolvedConfig | config} for command's `input` shape. + * */ export class ListModelPackageGroupsCommand extends $Command< ListModelPackageGroupsCommandInput, diff --git a/clients/client-sagemaker/commands/ListModelPackagesCommand.ts b/clients/client-sagemaker/commands/ListModelPackagesCommand.ts index f370a6fb7cb6..138070c928d9 100644 --- a/clients/client-sagemaker/commands/ListModelPackagesCommand.ts +++ b/clients/client-sagemaker/commands/ListModelPackagesCommand.ts @@ -22,6 +22,20 @@ export interface ListModelPackagesCommandOutput extends ListModelPackagesOutput, /** *

Lists the model packages that have been created.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { SageMakerClient, ListModelPackagesCommand } from "@aws-sdk/client-sagemaker"; // ES Modules import + * // const { SageMakerClient, ListModelPackagesCommand } = require("@aws-sdk/client-sagemaker"); // CommonJS import + * const client = new SageMakerClient(config); + * const command = new ListModelPackagesCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListModelPackagesCommandInput} for command's `input` shape. + * @see {@link ListModelPackagesCommandOutput} for command's `response` shape. + * @see {@link SageMakerClientResolvedConfig | config} for command's `input` shape. + * */ export class ListModelPackagesCommand extends $Command< ListModelPackagesCommandInput, diff --git a/clients/client-sagemaker/commands/ListModelQualityJobDefinitionsCommand.ts b/clients/client-sagemaker/commands/ListModelQualityJobDefinitionsCommand.ts index 766880f7d48e..4418e28c35ba 100644 --- a/clients/client-sagemaker/commands/ListModelQualityJobDefinitionsCommand.ts +++ b/clients/client-sagemaker/commands/ListModelQualityJobDefinitionsCommand.ts @@ -24,6 +24,20 @@ export interface ListModelQualityJobDefinitionsCommandOutput /** *

Gets a list of model quality monitoring job definitions in your account.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { SageMakerClient, ListModelQualityJobDefinitionsCommand } from "@aws-sdk/client-sagemaker"; // ES Modules import + * // const { SageMakerClient, ListModelQualityJobDefinitionsCommand } = require("@aws-sdk/client-sagemaker"); // CommonJS import + * const client = new SageMakerClient(config); + * const command = new ListModelQualityJobDefinitionsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListModelQualityJobDefinitionsCommandInput} for command's `input` shape. + * @see {@link ListModelQualityJobDefinitionsCommandOutput} for command's `response` shape. + * @see {@link SageMakerClientResolvedConfig | config} for command's `input` shape. + * */ export class ListModelQualityJobDefinitionsCommand extends $Command< ListModelQualityJobDefinitionsCommandInput, diff --git a/clients/client-sagemaker/commands/ListModelsCommand.ts b/clients/client-sagemaker/commands/ListModelsCommand.ts index 99ac03bac3b8..6de598e57c3f 100644 --- a/clients/client-sagemaker/commands/ListModelsCommand.ts +++ b/clients/client-sagemaker/commands/ListModelsCommand.ts @@ -22,6 +22,20 @@ export interface ListModelsCommandOutput extends ListModelsOutput, __MetadataBea /** *

Lists models created with the CreateModel API.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { SageMakerClient, ListModelsCommand } from "@aws-sdk/client-sagemaker"; // ES Modules import + * // const { SageMakerClient, ListModelsCommand } = require("@aws-sdk/client-sagemaker"); // CommonJS import + * const client = new SageMakerClient(config); + * const command = new ListModelsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListModelsCommandInput} for command's `input` shape. + * @see {@link ListModelsCommandOutput} for command's `response` shape. + * @see {@link SageMakerClientResolvedConfig | config} for command's `input` shape. + * */ export class ListModelsCommand extends $Command< ListModelsCommandInput, diff --git a/clients/client-sagemaker/commands/ListMonitoringExecutionsCommand.ts b/clients/client-sagemaker/commands/ListMonitoringExecutionsCommand.ts index a83c4633eede..51ea88693faa 100644 --- a/clients/client-sagemaker/commands/ListMonitoringExecutionsCommand.ts +++ b/clients/client-sagemaker/commands/ListMonitoringExecutionsCommand.ts @@ -22,6 +22,20 @@ export interface ListMonitoringExecutionsCommandOutput extends ListMonitoringExe /** *

Returns list of all monitoring job executions.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { SageMakerClient, ListMonitoringExecutionsCommand } from "@aws-sdk/client-sagemaker"; // ES Modules import + * // const { SageMakerClient, ListMonitoringExecutionsCommand } = require("@aws-sdk/client-sagemaker"); // CommonJS import + * const client = new SageMakerClient(config); + * const command = new ListMonitoringExecutionsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListMonitoringExecutionsCommandInput} for command's `input` shape. + * @see {@link ListMonitoringExecutionsCommandOutput} for command's `response` shape. + * @see {@link SageMakerClientResolvedConfig | config} for command's `input` shape. + * */ export class ListMonitoringExecutionsCommand extends $Command< ListMonitoringExecutionsCommandInput, diff --git a/clients/client-sagemaker/commands/ListMonitoringSchedulesCommand.ts b/clients/client-sagemaker/commands/ListMonitoringSchedulesCommand.ts index 42c4029e8bc8..15f185c37542 100644 --- a/clients/client-sagemaker/commands/ListMonitoringSchedulesCommand.ts +++ b/clients/client-sagemaker/commands/ListMonitoringSchedulesCommand.ts @@ -22,6 +22,20 @@ export interface ListMonitoringSchedulesCommandOutput extends ListMonitoringSche /** *

Returns list of all monitoring schedules.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { SageMakerClient, ListMonitoringSchedulesCommand } from "@aws-sdk/client-sagemaker"; // ES Modules import + * // const { SageMakerClient, ListMonitoringSchedulesCommand } = require("@aws-sdk/client-sagemaker"); // CommonJS import + * const client = new SageMakerClient(config); + * const command = new ListMonitoringSchedulesCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListMonitoringSchedulesCommandInput} for command's `input` shape. + * @see {@link ListMonitoringSchedulesCommandOutput} for command's `response` shape. + * @see {@link SageMakerClientResolvedConfig | config} for command's `input` shape. + * */ export class ListMonitoringSchedulesCommand extends $Command< ListMonitoringSchedulesCommandInput, diff --git a/clients/client-sagemaker/commands/ListNotebookInstanceLifecycleConfigsCommand.ts b/clients/client-sagemaker/commands/ListNotebookInstanceLifecycleConfigsCommand.ts index eab4ebf31380..ceb72268ed71 100644 --- a/clients/client-sagemaker/commands/ListNotebookInstanceLifecycleConfigsCommand.ts +++ b/clients/client-sagemaker/commands/ListNotebookInstanceLifecycleConfigsCommand.ts @@ -27,6 +27,20 @@ export interface ListNotebookInstanceLifecycleConfigsCommandOutput /** *

Lists notebook instance lifestyle configurations created with the CreateNotebookInstanceLifecycleConfig API.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { SageMakerClient, ListNotebookInstanceLifecycleConfigsCommand } from "@aws-sdk/client-sagemaker"; // ES Modules import + * // const { SageMakerClient, ListNotebookInstanceLifecycleConfigsCommand } = require("@aws-sdk/client-sagemaker"); // CommonJS import + * const client = new SageMakerClient(config); + * const command = new ListNotebookInstanceLifecycleConfigsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListNotebookInstanceLifecycleConfigsCommandInput} for command's `input` shape. + * @see {@link ListNotebookInstanceLifecycleConfigsCommandOutput} for command's `response` shape. + * @see {@link SageMakerClientResolvedConfig | config} for command's `input` shape. + * */ export class ListNotebookInstanceLifecycleConfigsCommand extends $Command< ListNotebookInstanceLifecycleConfigsCommandInput, diff --git a/clients/client-sagemaker/commands/ListNotebookInstancesCommand.ts b/clients/client-sagemaker/commands/ListNotebookInstancesCommand.ts index 0fa3c1ae2274..932e18979cfa 100644 --- a/clients/client-sagemaker/commands/ListNotebookInstancesCommand.ts +++ b/clients/client-sagemaker/commands/ListNotebookInstancesCommand.ts @@ -23,6 +23,20 @@ export interface ListNotebookInstancesCommandOutput extends ListNotebookInstance /** *

Returns a list of the Amazon SageMaker notebook instances in the requester's account in an AWS * Region.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { SageMakerClient, ListNotebookInstancesCommand } from "@aws-sdk/client-sagemaker"; // ES Modules import + * // const { SageMakerClient, ListNotebookInstancesCommand } = require("@aws-sdk/client-sagemaker"); // CommonJS import + * const client = new SageMakerClient(config); + * const command = new ListNotebookInstancesCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListNotebookInstancesCommandInput} for command's `input` shape. + * @see {@link ListNotebookInstancesCommandOutput} for command's `response` shape. + * @see {@link SageMakerClientResolvedConfig | config} for command's `input` shape. + * */ export class ListNotebookInstancesCommand extends $Command< ListNotebookInstancesCommandInput, diff --git a/clients/client-sagemaker/commands/ListPipelineExecutionStepsCommand.ts b/clients/client-sagemaker/commands/ListPipelineExecutionStepsCommand.ts index 33af5dfd0036..5ee93e19d17f 100644 --- a/clients/client-sagemaker/commands/ListPipelineExecutionStepsCommand.ts +++ b/clients/client-sagemaker/commands/ListPipelineExecutionStepsCommand.ts @@ -22,6 +22,20 @@ export interface ListPipelineExecutionStepsCommandOutput extends ListPipelineExe /** *

Gets a list of PipeLineExecutionStep objects.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { SageMakerClient, ListPipelineExecutionStepsCommand } from "@aws-sdk/client-sagemaker"; // ES Modules import + * // const { SageMakerClient, ListPipelineExecutionStepsCommand } = require("@aws-sdk/client-sagemaker"); // CommonJS import + * const client = new SageMakerClient(config); + * const command = new ListPipelineExecutionStepsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListPipelineExecutionStepsCommandInput} for command's `input` shape. + * @see {@link ListPipelineExecutionStepsCommandOutput} for command's `response` shape. + * @see {@link SageMakerClientResolvedConfig | config} for command's `input` shape. + * */ export class ListPipelineExecutionStepsCommand extends $Command< ListPipelineExecutionStepsCommandInput, diff --git a/clients/client-sagemaker/commands/ListPipelineExecutionsCommand.ts b/clients/client-sagemaker/commands/ListPipelineExecutionsCommand.ts index 2a5adf76c907..2b51d084ebcf 100644 --- a/clients/client-sagemaker/commands/ListPipelineExecutionsCommand.ts +++ b/clients/client-sagemaker/commands/ListPipelineExecutionsCommand.ts @@ -22,6 +22,20 @@ export interface ListPipelineExecutionsCommandOutput extends ListPipelineExecuti /** *

Gets a list of the pipeline executions.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { SageMakerClient, ListPipelineExecutionsCommand } from "@aws-sdk/client-sagemaker"; // ES Modules import + * // const { SageMakerClient, ListPipelineExecutionsCommand } = require("@aws-sdk/client-sagemaker"); // CommonJS import + * const client = new SageMakerClient(config); + * const command = new ListPipelineExecutionsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListPipelineExecutionsCommandInput} for command's `input` shape. + * @see {@link ListPipelineExecutionsCommandOutput} for command's `response` shape. + * @see {@link SageMakerClientResolvedConfig | config} for command's `input` shape. + * */ export class ListPipelineExecutionsCommand extends $Command< ListPipelineExecutionsCommandInput, diff --git a/clients/client-sagemaker/commands/ListPipelineParametersForExecutionCommand.ts b/clients/client-sagemaker/commands/ListPipelineParametersForExecutionCommand.ts index 106d66b69e8b..1772a53ed450 100644 --- a/clients/client-sagemaker/commands/ListPipelineParametersForExecutionCommand.ts +++ b/clients/client-sagemaker/commands/ListPipelineParametersForExecutionCommand.ts @@ -27,6 +27,20 @@ export interface ListPipelineParametersForExecutionCommandOutput /** *

Gets a list of parameters for a pipeline execution.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { SageMakerClient, ListPipelineParametersForExecutionCommand } from "@aws-sdk/client-sagemaker"; // ES Modules import + * // const { SageMakerClient, ListPipelineParametersForExecutionCommand } = require("@aws-sdk/client-sagemaker"); // CommonJS import + * const client = new SageMakerClient(config); + * const command = new ListPipelineParametersForExecutionCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListPipelineParametersForExecutionCommandInput} for command's `input` shape. + * @see {@link ListPipelineParametersForExecutionCommandOutput} for command's `response` shape. + * @see {@link SageMakerClientResolvedConfig | config} for command's `input` shape. + * */ export class ListPipelineParametersForExecutionCommand extends $Command< ListPipelineParametersForExecutionCommandInput, diff --git a/clients/client-sagemaker/commands/ListPipelinesCommand.ts b/clients/client-sagemaker/commands/ListPipelinesCommand.ts index 6584854c1c48..6bb87b87e5ec 100644 --- a/clients/client-sagemaker/commands/ListPipelinesCommand.ts +++ b/clients/client-sagemaker/commands/ListPipelinesCommand.ts @@ -22,6 +22,20 @@ export interface ListPipelinesCommandOutput extends ListPipelinesResponse, __Met /** *

Gets a list of pipelines.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { SageMakerClient, ListPipelinesCommand } from "@aws-sdk/client-sagemaker"; // ES Modules import + * // const { SageMakerClient, ListPipelinesCommand } = require("@aws-sdk/client-sagemaker"); // CommonJS import + * const client = new SageMakerClient(config); + * const command = new ListPipelinesCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListPipelinesCommandInput} for command's `input` shape. + * @see {@link ListPipelinesCommandOutput} for command's `response` shape. + * @see {@link SageMakerClientResolvedConfig | config} for command's `input` shape. + * */ export class ListPipelinesCommand extends $Command< ListPipelinesCommandInput, diff --git a/clients/client-sagemaker/commands/ListProcessingJobsCommand.ts b/clients/client-sagemaker/commands/ListProcessingJobsCommand.ts index 2aead76c6aae..8a0dea8bcfc5 100644 --- a/clients/client-sagemaker/commands/ListProcessingJobsCommand.ts +++ b/clients/client-sagemaker/commands/ListProcessingJobsCommand.ts @@ -22,6 +22,20 @@ export interface ListProcessingJobsCommandOutput extends ListProcessingJobsRespo /** *

Lists processing jobs that satisfy various filters.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { SageMakerClient, ListProcessingJobsCommand } from "@aws-sdk/client-sagemaker"; // ES Modules import + * // const { SageMakerClient, ListProcessingJobsCommand } = require("@aws-sdk/client-sagemaker"); // CommonJS import + * const client = new SageMakerClient(config); + * const command = new ListProcessingJobsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListProcessingJobsCommandInput} for command's `input` shape. + * @see {@link ListProcessingJobsCommandOutput} for command's `response` shape. + * @see {@link SageMakerClientResolvedConfig | config} for command's `input` shape. + * */ export class ListProcessingJobsCommand extends $Command< ListProcessingJobsCommandInput, diff --git a/clients/client-sagemaker/commands/ListProjectsCommand.ts b/clients/client-sagemaker/commands/ListProjectsCommand.ts index da238e2be273..6b89c30aee82 100644 --- a/clients/client-sagemaker/commands/ListProjectsCommand.ts +++ b/clients/client-sagemaker/commands/ListProjectsCommand.ts @@ -22,6 +22,20 @@ export interface ListProjectsCommandOutput extends ListProjectsOutput, __Metadat /** *

Gets a list of the projects in an AWS account.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { SageMakerClient, ListProjectsCommand } from "@aws-sdk/client-sagemaker"; // ES Modules import + * // const { SageMakerClient, ListProjectsCommand } = require("@aws-sdk/client-sagemaker"); // CommonJS import + * const client = new SageMakerClient(config); + * const command = new ListProjectsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListProjectsCommandInput} for command's `input` shape. + * @see {@link ListProjectsCommandOutput} for command's `response` shape. + * @see {@link SageMakerClientResolvedConfig | config} for command's `input` shape. + * */ export class ListProjectsCommand extends $Command< ListProjectsCommandInput, diff --git a/clients/client-sagemaker/commands/ListSubscribedWorkteamsCommand.ts b/clients/client-sagemaker/commands/ListSubscribedWorkteamsCommand.ts index fcc7a39fe3b7..9620cf109521 100644 --- a/clients/client-sagemaker/commands/ListSubscribedWorkteamsCommand.ts +++ b/clients/client-sagemaker/commands/ListSubscribedWorkteamsCommand.ts @@ -24,6 +24,20 @@ export interface ListSubscribedWorkteamsCommandOutput extends ListSubscribedWork *

Gets a list of the work teams that you are subscribed to in the AWS Marketplace. The * list may be empty if no work team satisfies the filter specified in the * NameContains parameter.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { SageMakerClient, ListSubscribedWorkteamsCommand } from "@aws-sdk/client-sagemaker"; // ES Modules import + * // const { SageMakerClient, ListSubscribedWorkteamsCommand } = require("@aws-sdk/client-sagemaker"); // CommonJS import + * const client = new SageMakerClient(config); + * const command = new ListSubscribedWorkteamsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListSubscribedWorkteamsCommandInput} for command's `input` shape. + * @see {@link ListSubscribedWorkteamsCommandOutput} for command's `response` shape. + * @see {@link SageMakerClientResolvedConfig | config} for command's `input` shape. + * */ export class ListSubscribedWorkteamsCommand extends $Command< ListSubscribedWorkteamsCommandInput, diff --git a/clients/client-sagemaker/commands/ListTagsCommand.ts b/clients/client-sagemaker/commands/ListTagsCommand.ts index 952009cb0169..2f166a40d340 100644 --- a/clients/client-sagemaker/commands/ListTagsCommand.ts +++ b/clients/client-sagemaker/commands/ListTagsCommand.ts @@ -19,6 +19,20 @@ export interface ListTagsCommandOutput extends ListTagsOutput, __MetadataBearer /** *

Returns the tags for the specified Amazon SageMaker resource.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { SageMakerClient, ListTagsCommand } from "@aws-sdk/client-sagemaker"; // ES Modules import + * // const { SageMakerClient, ListTagsCommand } = require("@aws-sdk/client-sagemaker"); // CommonJS import + * const client = new SageMakerClient(config); + * const command = new ListTagsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListTagsCommandInput} for command's `input` shape. + * @see {@link ListTagsCommandOutput} for command's `response` shape. + * @see {@link SageMakerClientResolvedConfig | config} for command's `input` shape. + * */ export class ListTagsCommand extends $Command< ListTagsCommandInput, diff --git a/clients/client-sagemaker/commands/ListTrainingJobsCommand.ts b/clients/client-sagemaker/commands/ListTrainingJobsCommand.ts index 16a415473898..91749a7d62b2 100644 --- a/clients/client-sagemaker/commands/ListTrainingJobsCommand.ts +++ b/clients/client-sagemaker/commands/ListTrainingJobsCommand.ts @@ -42,6 +42,20 @@ export interface ListTrainingJobsCommandOutput extends ListTrainingJobsResponse, * InProgress *

* + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { SageMakerClient, ListTrainingJobsCommand } from "@aws-sdk/client-sagemaker"; // ES Modules import + * // const { SageMakerClient, ListTrainingJobsCommand } = require("@aws-sdk/client-sagemaker"); // CommonJS import + * const client = new SageMakerClient(config); + * const command = new ListTrainingJobsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListTrainingJobsCommandInput} for command's `input` shape. + * @see {@link ListTrainingJobsCommandOutput} for command's `response` shape. + * @see {@link SageMakerClientResolvedConfig | config} for command's `input` shape. + * */ export class ListTrainingJobsCommand extends $Command< ListTrainingJobsCommandInput, diff --git a/clients/client-sagemaker/commands/ListTrainingJobsForHyperParameterTuningJobCommand.ts b/clients/client-sagemaker/commands/ListTrainingJobsForHyperParameterTuningJobCommand.ts index 7caa0a9cd563..2020ac486534 100644 --- a/clients/client-sagemaker/commands/ListTrainingJobsForHyperParameterTuningJobCommand.ts +++ b/clients/client-sagemaker/commands/ListTrainingJobsForHyperParameterTuningJobCommand.ts @@ -29,6 +29,20 @@ export interface ListTrainingJobsForHyperParameterTuningJobCommandOutput /** *

Gets a list of TrainingJobSummary objects that describe the training * jobs that a hyperparameter tuning job launched.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { SageMakerClient, ListTrainingJobsForHyperParameterTuningJobCommand } from "@aws-sdk/client-sagemaker"; // ES Modules import + * // const { SageMakerClient, ListTrainingJobsForHyperParameterTuningJobCommand } = require("@aws-sdk/client-sagemaker"); // CommonJS import + * const client = new SageMakerClient(config); + * const command = new ListTrainingJobsForHyperParameterTuningJobCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListTrainingJobsForHyperParameterTuningJobCommandInput} for command's `input` shape. + * @see {@link ListTrainingJobsForHyperParameterTuningJobCommandOutput} for command's `response` shape. + * @see {@link SageMakerClientResolvedConfig | config} for command's `input` shape. + * */ export class ListTrainingJobsForHyperParameterTuningJobCommand extends $Command< ListTrainingJobsForHyperParameterTuningJobCommandInput, diff --git a/clients/client-sagemaker/commands/ListTransformJobsCommand.ts b/clients/client-sagemaker/commands/ListTransformJobsCommand.ts index df931b242d6d..8c2b87201c41 100644 --- a/clients/client-sagemaker/commands/ListTransformJobsCommand.ts +++ b/clients/client-sagemaker/commands/ListTransformJobsCommand.ts @@ -22,6 +22,20 @@ export interface ListTransformJobsCommandOutput extends ListTransformJobsRespons /** *

Lists transform jobs.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { SageMakerClient, ListTransformJobsCommand } from "@aws-sdk/client-sagemaker"; // ES Modules import + * // const { SageMakerClient, ListTransformJobsCommand } = require("@aws-sdk/client-sagemaker"); // CommonJS import + * const client = new SageMakerClient(config); + * const command = new ListTransformJobsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListTransformJobsCommandInput} for command's `input` shape. + * @see {@link ListTransformJobsCommandOutput} for command's `response` shape. + * @see {@link SageMakerClientResolvedConfig | config} for command's `input` shape. + * */ export class ListTransformJobsCommand extends $Command< ListTransformJobsCommandInput, diff --git a/clients/client-sagemaker/commands/ListTrialComponentsCommand.ts b/clients/client-sagemaker/commands/ListTrialComponentsCommand.ts index ae98f5ece3e8..bd21238c330a 100644 --- a/clients/client-sagemaker/commands/ListTrialComponentsCommand.ts +++ b/clients/client-sagemaker/commands/ListTrialComponentsCommand.ts @@ -41,6 +41,20 @@ export interface ListTrialComponentsCommandOutput extends ListTrialComponentsRes *

* * + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { SageMakerClient, ListTrialComponentsCommand } from "@aws-sdk/client-sagemaker"; // ES Modules import + * // const { SageMakerClient, ListTrialComponentsCommand } = require("@aws-sdk/client-sagemaker"); // CommonJS import + * const client = new SageMakerClient(config); + * const command = new ListTrialComponentsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListTrialComponentsCommandInput} for command's `input` shape. + * @see {@link ListTrialComponentsCommandOutput} for command's `response` shape. + * @see {@link SageMakerClientResolvedConfig | config} for command's `input` shape. + * */ export class ListTrialComponentsCommand extends $Command< ListTrialComponentsCommandInput, diff --git a/clients/client-sagemaker/commands/ListTrialsCommand.ts b/clients/client-sagemaker/commands/ListTrialsCommand.ts index 21df6500962a..7ecbb4ed18d7 100644 --- a/clients/client-sagemaker/commands/ListTrialsCommand.ts +++ b/clients/client-sagemaker/commands/ListTrialsCommand.ts @@ -26,6 +26,20 @@ export interface ListTrialsCommandOutput extends ListTrialsResponse, __MetadataB * 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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { SageMakerClient, ListTrialsCommand } from "@aws-sdk/client-sagemaker"; // ES Modules import + * // const { SageMakerClient, ListTrialsCommand } = require("@aws-sdk/client-sagemaker"); // CommonJS import + * const client = new SageMakerClient(config); + * const command = new ListTrialsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListTrialsCommandInput} for command's `input` shape. + * @see {@link ListTrialsCommandOutput} for command's `response` shape. + * @see {@link SageMakerClientResolvedConfig | config} for command's `input` shape. + * */ export class ListTrialsCommand extends $Command< ListTrialsCommandInput, diff --git a/clients/client-sagemaker/commands/ListUserProfilesCommand.ts b/clients/client-sagemaker/commands/ListUserProfilesCommand.ts index 8ff4dec71d9d..8ec23d3022c8 100644 --- a/clients/client-sagemaker/commands/ListUserProfilesCommand.ts +++ b/clients/client-sagemaker/commands/ListUserProfilesCommand.ts @@ -22,6 +22,20 @@ export interface ListUserProfilesCommandOutput extends ListUserProfilesResponse, /** *

Lists user profiles.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { SageMakerClient, ListUserProfilesCommand } from "@aws-sdk/client-sagemaker"; // ES Modules import + * // const { SageMakerClient, ListUserProfilesCommand } = require("@aws-sdk/client-sagemaker"); // CommonJS import + * const client = new SageMakerClient(config); + * const command = new ListUserProfilesCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListUserProfilesCommandInput} for command's `input` shape. + * @see {@link ListUserProfilesCommandOutput} for command's `response` shape. + * @see {@link SageMakerClientResolvedConfig | config} for command's `input` shape. + * */ export class ListUserProfilesCommand extends $Command< ListUserProfilesCommandInput, diff --git a/clients/client-sagemaker/commands/ListWorkforcesCommand.ts b/clients/client-sagemaker/commands/ListWorkforcesCommand.ts index c0f2dcca100c..2d04e8b28c3f 100644 --- a/clients/client-sagemaker/commands/ListWorkforcesCommand.ts +++ b/clients/client-sagemaker/commands/ListWorkforcesCommand.ts @@ -23,6 +23,20 @@ export interface ListWorkforcesCommandOutput extends ListWorkforcesResponse, __M /** *

Use this operation to list all private and vendor workforces in an AWS Region. Note that you can only * have one private workforce per AWS Region.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { SageMakerClient, ListWorkforcesCommand } from "@aws-sdk/client-sagemaker"; // ES Modules import + * // const { SageMakerClient, ListWorkforcesCommand } = require("@aws-sdk/client-sagemaker"); // CommonJS import + * const client = new SageMakerClient(config); + * const command = new ListWorkforcesCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListWorkforcesCommandInput} for command's `input` shape. + * @see {@link ListWorkforcesCommandOutput} for command's `response` shape. + * @see {@link SageMakerClientResolvedConfig | config} for command's `input` shape. + * */ export class ListWorkforcesCommand extends $Command< ListWorkforcesCommandInput, diff --git a/clients/client-sagemaker/commands/ListWorkteamsCommand.ts b/clients/client-sagemaker/commands/ListWorkteamsCommand.ts index 158751595349..036c70239f80 100644 --- a/clients/client-sagemaker/commands/ListWorkteamsCommand.ts +++ b/clients/client-sagemaker/commands/ListWorkteamsCommand.ts @@ -24,6 +24,20 @@ export interface ListWorkteamsCommandOutput extends ListWorkteamsResponse, __Met *

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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { SageMakerClient, ListWorkteamsCommand } from "@aws-sdk/client-sagemaker"; // ES Modules import + * // const { SageMakerClient, ListWorkteamsCommand } = require("@aws-sdk/client-sagemaker"); // CommonJS import + * const client = new SageMakerClient(config); + * const command = new ListWorkteamsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListWorkteamsCommandInput} for command's `input` shape. + * @see {@link ListWorkteamsCommandOutput} for command's `response` shape. + * @see {@link SageMakerClientResolvedConfig | config} for command's `input` shape. + * */ export class ListWorkteamsCommand extends $Command< ListWorkteamsCommandInput, diff --git a/clients/client-sagemaker/commands/PutModelPackageGroupPolicyCommand.ts b/clients/client-sagemaker/commands/PutModelPackageGroupPolicyCommand.ts index 9da5f7e39f2c..dd129ca6edf4 100644 --- a/clients/client-sagemaker/commands/PutModelPackageGroupPolicyCommand.ts +++ b/clients/client-sagemaker/commands/PutModelPackageGroupPolicyCommand.ts @@ -24,6 +24,20 @@ export interface PutModelPackageGroupPolicyCommandOutput extends PutModelPackage *

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 AWS Identity and Access Management User Guide..

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { SageMakerClient, PutModelPackageGroupPolicyCommand } from "@aws-sdk/client-sagemaker"; // ES Modules import + * // const { SageMakerClient, PutModelPackageGroupPolicyCommand } = require("@aws-sdk/client-sagemaker"); // CommonJS import + * const client = new SageMakerClient(config); + * const command = new PutModelPackageGroupPolicyCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link PutModelPackageGroupPolicyCommandInput} for command's `input` shape. + * @see {@link PutModelPackageGroupPolicyCommandOutput} for command's `response` shape. + * @see {@link SageMakerClientResolvedConfig | config} for command's `input` shape. + * */ export class PutModelPackageGroupPolicyCommand extends $Command< PutModelPackageGroupPolicyCommandInput, diff --git a/clients/client-sagemaker/commands/RegisterDevicesCommand.ts b/clients/client-sagemaker/commands/RegisterDevicesCommand.ts index e16292b6bce8..fde81d3b8c82 100644 --- a/clients/client-sagemaker/commands/RegisterDevicesCommand.ts +++ b/clients/client-sagemaker/commands/RegisterDevicesCommand.ts @@ -22,6 +22,20 @@ export interface RegisterDevicesCommandOutput extends __MetadataBearer {} /** *

Register devices.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { SageMakerClient, RegisterDevicesCommand } from "@aws-sdk/client-sagemaker"; // ES Modules import + * // const { SageMakerClient, RegisterDevicesCommand } = require("@aws-sdk/client-sagemaker"); // CommonJS import + * const client = new SageMakerClient(config); + * const command = new RegisterDevicesCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link RegisterDevicesCommandInput} for command's `input` shape. + * @see {@link RegisterDevicesCommandOutput} for command's `response` shape. + * @see {@link SageMakerClientResolvedConfig | config} for command's `input` shape. + * */ export class RegisterDevicesCommand extends $Command< RegisterDevicesCommandInput, diff --git a/clients/client-sagemaker/commands/RenderUiTemplateCommand.ts b/clients/client-sagemaker/commands/RenderUiTemplateCommand.ts index 48d46dc803e9..b6818791c5fe 100644 --- a/clients/client-sagemaker/commands/RenderUiTemplateCommand.ts +++ b/clients/client-sagemaker/commands/RenderUiTemplateCommand.ts @@ -22,6 +22,20 @@ export interface RenderUiTemplateCommandOutput extends RenderUiTemplateResponse, /** *

Renders the UI template so that you can preview the worker's experience.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { SageMakerClient, RenderUiTemplateCommand } from "@aws-sdk/client-sagemaker"; // ES Modules import + * // const { SageMakerClient, RenderUiTemplateCommand } = require("@aws-sdk/client-sagemaker"); // CommonJS import + * const client = new SageMakerClient(config); + * const command = new RenderUiTemplateCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link RenderUiTemplateCommandInput} for command's `input` shape. + * @see {@link RenderUiTemplateCommandOutput} for command's `response` shape. + * @see {@link SageMakerClientResolvedConfig | config} for command's `input` shape. + * */ export class RenderUiTemplateCommand extends $Command< RenderUiTemplateCommandInput, diff --git a/clients/client-sagemaker/commands/SearchCommand.ts b/clients/client-sagemaker/commands/SearchCommand.ts index 7e0f95723709..fa7924044268 100644 --- a/clients/client-sagemaker/commands/SearchCommand.ts +++ b/clients/client-sagemaker/commands/SearchCommand.ts @@ -24,6 +24,20 @@ export interface SearchCommandOutput extends SearchResponse, __MetadataBearer {} * results by any resource property in a ascending or descending order.

*

You can query against the following value types: numeric, text, Boolean, and * timestamp.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { SageMakerClient, SearchCommand } from "@aws-sdk/client-sagemaker"; // ES Modules import + * // const { SageMakerClient, SearchCommand } = require("@aws-sdk/client-sagemaker"); // CommonJS import + * const client = new SageMakerClient(config); + * const command = new SearchCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link SearchCommandInput} for command's `input` shape. + * @see {@link SearchCommandOutput} for command's `response` shape. + * @see {@link SageMakerClientResolvedConfig | config} for command's `input` shape. + * */ export class SearchCommand extends $Command { // Start section: command_properties diff --git a/clients/client-sagemaker/commands/StartMonitoringScheduleCommand.ts b/clients/client-sagemaker/commands/StartMonitoringScheduleCommand.ts index 4e62b20cb18e..6cf4b7441aab 100644 --- a/clients/client-sagemaker/commands/StartMonitoringScheduleCommand.ts +++ b/clients/client-sagemaker/commands/StartMonitoringScheduleCommand.ts @@ -26,6 +26,20 @@ export interface StartMonitoringScheduleCommandOutput extends __MetadataBearer { *

By default, when you successfully create a new schedule, the status of a monitoring * schedule is scheduled.

* + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { SageMakerClient, StartMonitoringScheduleCommand } from "@aws-sdk/client-sagemaker"; // ES Modules import + * // const { SageMakerClient, StartMonitoringScheduleCommand } = require("@aws-sdk/client-sagemaker"); // CommonJS import + * const client = new SageMakerClient(config); + * const command = new StartMonitoringScheduleCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link StartMonitoringScheduleCommandInput} for command's `input` shape. + * @see {@link StartMonitoringScheduleCommandOutput} for command's `response` shape. + * @see {@link SageMakerClientResolvedConfig | config} for command's `input` shape. + * */ export class StartMonitoringScheduleCommand extends $Command< StartMonitoringScheduleCommandInput, diff --git a/clients/client-sagemaker/commands/StartNotebookInstanceCommand.ts b/clients/client-sagemaker/commands/StartNotebookInstanceCommand.ts index 6b40642da8fb..61a1e5f031c2 100644 --- a/clients/client-sagemaker/commands/StartNotebookInstanceCommand.ts +++ b/clients/client-sagemaker/commands/StartNotebookInstanceCommand.ts @@ -25,6 +25,20 @@ export interface StartNotebookInstanceCommandOutput extends __MetadataBearer {} * attaches your ML storage volume. After configuring the notebook instance, Amazon SageMaker sets the * notebook instance status to InService. A notebook instance's status must be * InService before you can connect to your Jupyter notebook.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { SageMakerClient, StartNotebookInstanceCommand } from "@aws-sdk/client-sagemaker"; // ES Modules import + * // const { SageMakerClient, StartNotebookInstanceCommand } = require("@aws-sdk/client-sagemaker"); // CommonJS import + * const client = new SageMakerClient(config); + * const command = new StartNotebookInstanceCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link StartNotebookInstanceCommandInput} for command's `input` shape. + * @see {@link StartNotebookInstanceCommandOutput} for command's `response` shape. + * @see {@link SageMakerClientResolvedConfig | config} for command's `input` shape. + * */ export class StartNotebookInstanceCommand extends $Command< StartNotebookInstanceCommandInput, diff --git a/clients/client-sagemaker/commands/StartPipelineExecutionCommand.ts b/clients/client-sagemaker/commands/StartPipelineExecutionCommand.ts index f7a69e947a03..cb4e75b24ff5 100644 --- a/clients/client-sagemaker/commands/StartPipelineExecutionCommand.ts +++ b/clients/client-sagemaker/commands/StartPipelineExecutionCommand.ts @@ -22,6 +22,20 @@ export interface StartPipelineExecutionCommandOutput extends StartPipelineExecut /** *

Starts a pipeline execution.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { SageMakerClient, StartPipelineExecutionCommand } from "@aws-sdk/client-sagemaker"; // ES Modules import + * // const { SageMakerClient, StartPipelineExecutionCommand } = require("@aws-sdk/client-sagemaker"); // CommonJS import + * const client = new SageMakerClient(config); + * const command = new StartPipelineExecutionCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link StartPipelineExecutionCommandInput} for command's `input` shape. + * @see {@link StartPipelineExecutionCommandOutput} for command's `response` shape. + * @see {@link SageMakerClientResolvedConfig | config} for command's `input` shape. + * */ export class StartPipelineExecutionCommand extends $Command< StartPipelineExecutionCommandInput, diff --git a/clients/client-sagemaker/commands/StopAutoMLJobCommand.ts b/clients/client-sagemaker/commands/StopAutoMLJobCommand.ts index 821b494cfaa4..e89fe82a8fb1 100644 --- a/clients/client-sagemaker/commands/StopAutoMLJobCommand.ts +++ b/clients/client-sagemaker/commands/StopAutoMLJobCommand.ts @@ -22,6 +22,20 @@ export interface StopAutoMLJobCommandOutput extends __MetadataBearer {} /** *

A method for forcing the termination of a running job.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { SageMakerClient, StopAutoMLJobCommand } from "@aws-sdk/client-sagemaker"; // ES Modules import + * // const { SageMakerClient, StopAutoMLJobCommand } = require("@aws-sdk/client-sagemaker"); // CommonJS import + * const client = new SageMakerClient(config); + * const command = new StopAutoMLJobCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link StopAutoMLJobCommandInput} for command's `input` shape. + * @see {@link StopAutoMLJobCommandOutput} for command's `response` shape. + * @see {@link SageMakerClientResolvedConfig | config} for command's `input` shape. + * */ export class StopAutoMLJobCommand extends $Command< StopAutoMLJobCommandInput, diff --git a/clients/client-sagemaker/commands/StopCompilationJobCommand.ts b/clients/client-sagemaker/commands/StopCompilationJobCommand.ts index 5cf0cd64c29b..f63627e56f8f 100644 --- a/clients/client-sagemaker/commands/StopCompilationJobCommand.ts +++ b/clients/client-sagemaker/commands/StopCompilationJobCommand.ts @@ -27,6 +27,20 @@ export interface StopCompilationJobCommandOutput extends __MetadataBearer {} *

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. *

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { SageMakerClient, StopCompilationJobCommand } from "@aws-sdk/client-sagemaker"; // ES Modules import + * // const { SageMakerClient, StopCompilationJobCommand } = require("@aws-sdk/client-sagemaker"); // CommonJS import + * const client = new SageMakerClient(config); + * const command = new StopCompilationJobCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link StopCompilationJobCommandInput} for command's `input` shape. + * @see {@link StopCompilationJobCommandOutput} for command's `response` shape. + * @see {@link SageMakerClientResolvedConfig | config} for command's `input` shape. + * */ export class StopCompilationJobCommand extends $Command< StopCompilationJobCommandInput, diff --git a/clients/client-sagemaker/commands/StopEdgePackagingJobCommand.ts b/clients/client-sagemaker/commands/StopEdgePackagingJobCommand.ts index 435ae8a3b21e..125c3cd1de12 100644 --- a/clients/client-sagemaker/commands/StopEdgePackagingJobCommand.ts +++ b/clients/client-sagemaker/commands/StopEdgePackagingJobCommand.ts @@ -22,6 +22,20 @@ export interface StopEdgePackagingJobCommandOutput extends __MetadataBearer {} /** *

Request to stop an edge packaging job.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { SageMakerClient, StopEdgePackagingJobCommand } from "@aws-sdk/client-sagemaker"; // ES Modules import + * // const { SageMakerClient, StopEdgePackagingJobCommand } = require("@aws-sdk/client-sagemaker"); // CommonJS import + * const client = new SageMakerClient(config); + * const command = new StopEdgePackagingJobCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link StopEdgePackagingJobCommandInput} for command's `input` shape. + * @see {@link StopEdgePackagingJobCommandOutput} for command's `response` shape. + * @see {@link SageMakerClientResolvedConfig | config} for command's `input` shape. + * */ export class StopEdgePackagingJobCommand extends $Command< StopEdgePackagingJobCommandInput, diff --git a/clients/client-sagemaker/commands/StopHyperParameterTuningJobCommand.ts b/clients/client-sagemaker/commands/StopHyperParameterTuningJobCommand.ts index 08423af95e7c..4f78215c769e 100644 --- a/clients/client-sagemaker/commands/StopHyperParameterTuningJobCommand.ts +++ b/clients/client-sagemaker/commands/StopHyperParameterTuningJobCommand.ts @@ -28,6 +28,20 @@ export interface StopHyperParameterTuningJobCommandOutput extends __MetadataBear * tuning job moves to the Stopped state, it releases all * reserved * resources for the tuning job.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { SageMakerClient, StopHyperParameterTuningJobCommand } from "@aws-sdk/client-sagemaker"; // ES Modules import + * // const { SageMakerClient, StopHyperParameterTuningJobCommand } = require("@aws-sdk/client-sagemaker"); // CommonJS import + * const client = new SageMakerClient(config); + * const command = new StopHyperParameterTuningJobCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link StopHyperParameterTuningJobCommandInput} for command's `input` shape. + * @see {@link StopHyperParameterTuningJobCommandOutput} for command's `response` shape. + * @see {@link SageMakerClientResolvedConfig | config} for command's `input` shape. + * */ export class StopHyperParameterTuningJobCommand extends $Command< StopHyperParameterTuningJobCommandInput, diff --git a/clients/client-sagemaker/commands/StopLabelingJobCommand.ts b/clients/client-sagemaker/commands/StopLabelingJobCommand.ts index 47e7f510eb8e..08a6ca51a02a 100644 --- a/clients/client-sagemaker/commands/StopLabelingJobCommand.ts +++ b/clients/client-sagemaker/commands/StopLabelingJobCommand.ts @@ -23,6 +23,20 @@ export interface StopLabelingJobCommandOutput extends __MetadataBearer {} /** *

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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { SageMakerClient, StopLabelingJobCommand } from "@aws-sdk/client-sagemaker"; // ES Modules import + * // const { SageMakerClient, StopLabelingJobCommand } = require("@aws-sdk/client-sagemaker"); // CommonJS import + * const client = new SageMakerClient(config); + * const command = new StopLabelingJobCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link StopLabelingJobCommandInput} for command's `input` shape. + * @see {@link StopLabelingJobCommandOutput} for command's `response` shape. + * @see {@link SageMakerClientResolvedConfig | config} for command's `input` shape. + * */ export class StopLabelingJobCommand extends $Command< StopLabelingJobCommandInput, diff --git a/clients/client-sagemaker/commands/StopMonitoringScheduleCommand.ts b/clients/client-sagemaker/commands/StopMonitoringScheduleCommand.ts index 77a9cd48fa21..d5a9446a6dcd 100644 --- a/clients/client-sagemaker/commands/StopMonitoringScheduleCommand.ts +++ b/clients/client-sagemaker/commands/StopMonitoringScheduleCommand.ts @@ -22,6 +22,20 @@ export interface StopMonitoringScheduleCommandOutput extends __MetadataBearer {} /** *

Stops a previously started monitoring schedule.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { SageMakerClient, StopMonitoringScheduleCommand } from "@aws-sdk/client-sagemaker"; // ES Modules import + * // const { SageMakerClient, StopMonitoringScheduleCommand } = require("@aws-sdk/client-sagemaker"); // CommonJS import + * const client = new SageMakerClient(config); + * const command = new StopMonitoringScheduleCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link StopMonitoringScheduleCommandInput} for command's `input` shape. + * @see {@link StopMonitoringScheduleCommandOutput} for command's `response` shape. + * @see {@link SageMakerClientResolvedConfig | config} for command's `input` shape. + * */ export class StopMonitoringScheduleCommand extends $Command< StopMonitoringScheduleCommandInput, diff --git a/clients/client-sagemaker/commands/StopNotebookInstanceCommand.ts b/clients/client-sagemaker/commands/StopNotebookInstanceCommand.ts index 89fbe2346ed0..801a7f6ea2c8 100644 --- a/clients/client-sagemaker/commands/StopNotebookInstanceCommand.ts +++ b/clients/client-sagemaker/commands/StopNotebookInstanceCommand.ts @@ -30,6 +30,20 @@ export interface StopNotebookInstanceCommandOutput extends __MetadataBearer {} * StartNotebookInstance launches another ML compute instance, configures * it, and attaches the preserved ML storage volume so you can continue your work. *

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { SageMakerClient, StopNotebookInstanceCommand } from "@aws-sdk/client-sagemaker"; // ES Modules import + * // const { SageMakerClient, StopNotebookInstanceCommand } = require("@aws-sdk/client-sagemaker"); // CommonJS import + * const client = new SageMakerClient(config); + * const command = new StopNotebookInstanceCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link StopNotebookInstanceCommandInput} for command's `input` shape. + * @see {@link StopNotebookInstanceCommandOutput} for command's `response` shape. + * @see {@link SageMakerClientResolvedConfig | config} for command's `input` shape. + * */ export class StopNotebookInstanceCommand extends $Command< StopNotebookInstanceCommandInput, diff --git a/clients/client-sagemaker/commands/StopPipelineExecutionCommand.ts b/clients/client-sagemaker/commands/StopPipelineExecutionCommand.ts index 8deac4a34f9d..a6ec108e8283 100644 --- a/clients/client-sagemaker/commands/StopPipelineExecutionCommand.ts +++ b/clients/client-sagemaker/commands/StopPipelineExecutionCommand.ts @@ -22,6 +22,20 @@ export interface StopPipelineExecutionCommandOutput extends StopPipelineExecutio /** *

Stops a pipeline execution.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { SageMakerClient, StopPipelineExecutionCommand } from "@aws-sdk/client-sagemaker"; // ES Modules import + * // const { SageMakerClient, StopPipelineExecutionCommand } = require("@aws-sdk/client-sagemaker"); // CommonJS import + * const client = new SageMakerClient(config); + * const command = new StopPipelineExecutionCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link StopPipelineExecutionCommandInput} for command's `input` shape. + * @see {@link StopPipelineExecutionCommandOutput} for command's `response` shape. + * @see {@link SageMakerClientResolvedConfig | config} for command's `input` shape. + * */ export class StopPipelineExecutionCommand extends $Command< StopPipelineExecutionCommandInput, diff --git a/clients/client-sagemaker/commands/StopProcessingJobCommand.ts b/clients/client-sagemaker/commands/StopProcessingJobCommand.ts index 9b4182d480c3..ac1ebee17ee6 100644 --- a/clients/client-sagemaker/commands/StopProcessingJobCommand.ts +++ b/clients/client-sagemaker/commands/StopProcessingJobCommand.ts @@ -22,6 +22,20 @@ export interface StopProcessingJobCommandOutput extends __MetadataBearer {} /** *

Stops a processing job.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { SageMakerClient, StopProcessingJobCommand } from "@aws-sdk/client-sagemaker"; // ES Modules import + * // const { SageMakerClient, StopProcessingJobCommand } = require("@aws-sdk/client-sagemaker"); // CommonJS import + * const client = new SageMakerClient(config); + * const command = new StopProcessingJobCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link StopProcessingJobCommandInput} for command's `input` shape. + * @see {@link StopProcessingJobCommandOutput} for command's `response` shape. + * @see {@link SageMakerClientResolvedConfig | config} for command's `input` shape. + * */ export class StopProcessingJobCommand extends $Command< StopProcessingJobCommandInput, diff --git a/clients/client-sagemaker/commands/StopTrainingJobCommand.ts b/clients/client-sagemaker/commands/StopTrainingJobCommand.ts index bc0e5c52f47d..8d6d9cd1ef44 100644 --- a/clients/client-sagemaker/commands/StopTrainingJobCommand.ts +++ b/clients/client-sagemaker/commands/StopTrainingJobCommand.ts @@ -28,6 +28,20 @@ export interface StopTrainingJobCommandOutput extends __MetadataBearer {} *

When it receives a StopTrainingJob request, Amazon SageMaker changes the status of * the job to Stopping. After Amazon SageMaker stops the job, it sets the status to * Stopped.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { SageMakerClient, StopTrainingJobCommand } from "@aws-sdk/client-sagemaker"; // ES Modules import + * // const { SageMakerClient, StopTrainingJobCommand } = require("@aws-sdk/client-sagemaker"); // CommonJS import + * const client = new SageMakerClient(config); + * const command = new StopTrainingJobCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link StopTrainingJobCommandInput} for command's `input` shape. + * @see {@link StopTrainingJobCommandOutput} for command's `response` shape. + * @see {@link SageMakerClientResolvedConfig | config} for command's `input` shape. + * */ export class StopTrainingJobCommand extends $Command< StopTrainingJobCommandInput, diff --git a/clients/client-sagemaker/commands/StopTransformJobCommand.ts b/clients/client-sagemaker/commands/StopTransformJobCommand.ts index 92934a9d1f19..978fce1bc69e 100644 --- a/clients/client-sagemaker/commands/StopTransformJobCommand.ts +++ b/clients/client-sagemaker/commands/StopTransformJobCommand.ts @@ -27,6 +27,20 @@ export interface StopTransformJobCommandOutput extends __MetadataBearer {} * stops * the job, the status is set to Stopped. When you stop a transform job before * it is completed, Amazon SageMaker doesn't store the job's output in Amazon S3.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { SageMakerClient, StopTransformJobCommand } from "@aws-sdk/client-sagemaker"; // ES Modules import + * // const { SageMakerClient, StopTransformJobCommand } = require("@aws-sdk/client-sagemaker"); // CommonJS import + * const client = new SageMakerClient(config); + * const command = new StopTransformJobCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link StopTransformJobCommandInput} for command's `input` shape. + * @see {@link StopTransformJobCommandOutput} for command's `response` shape. + * @see {@link SageMakerClientResolvedConfig | config} for command's `input` shape. + * */ export class StopTransformJobCommand extends $Command< StopTransformJobCommandInput, diff --git a/clients/client-sagemaker/commands/UpdateActionCommand.ts b/clients/client-sagemaker/commands/UpdateActionCommand.ts index 8bc95c908723..71c6e3f1b082 100644 --- a/clients/client-sagemaker/commands/UpdateActionCommand.ts +++ b/clients/client-sagemaker/commands/UpdateActionCommand.ts @@ -22,6 +22,20 @@ export interface UpdateActionCommandOutput extends UpdateActionResponse, __Metad /** *

Updates an action.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { SageMakerClient, UpdateActionCommand } from "@aws-sdk/client-sagemaker"; // ES Modules import + * // const { SageMakerClient, UpdateActionCommand } = require("@aws-sdk/client-sagemaker"); // CommonJS import + * const client = new SageMakerClient(config); + * const command = new UpdateActionCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link UpdateActionCommandInput} for command's `input` shape. + * @see {@link UpdateActionCommandOutput} for command's `response` shape. + * @see {@link SageMakerClientResolvedConfig | config} for command's `input` shape. + * */ export class UpdateActionCommand extends $Command< UpdateActionCommandInput, diff --git a/clients/client-sagemaker/commands/UpdateAppImageConfigCommand.ts b/clients/client-sagemaker/commands/UpdateAppImageConfigCommand.ts index 11546f4bb9bf..61dcf9d65a46 100644 --- a/clients/client-sagemaker/commands/UpdateAppImageConfigCommand.ts +++ b/clients/client-sagemaker/commands/UpdateAppImageConfigCommand.ts @@ -22,6 +22,20 @@ export interface UpdateAppImageConfigCommandOutput extends UpdateAppImageConfigR /** *

Updates the properties of an AppImageConfig.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { SageMakerClient, UpdateAppImageConfigCommand } from "@aws-sdk/client-sagemaker"; // ES Modules import + * // const { SageMakerClient, UpdateAppImageConfigCommand } = require("@aws-sdk/client-sagemaker"); // CommonJS import + * const client = new SageMakerClient(config); + * const command = new UpdateAppImageConfigCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link UpdateAppImageConfigCommandInput} for command's `input` shape. + * @see {@link UpdateAppImageConfigCommandOutput} for command's `response` shape. + * @see {@link SageMakerClientResolvedConfig | config} for command's `input` shape. + * */ export class UpdateAppImageConfigCommand extends $Command< UpdateAppImageConfigCommandInput, diff --git a/clients/client-sagemaker/commands/UpdateArtifactCommand.ts b/clients/client-sagemaker/commands/UpdateArtifactCommand.ts index 3fc37579e23e..ff5187e15f79 100644 --- a/clients/client-sagemaker/commands/UpdateArtifactCommand.ts +++ b/clients/client-sagemaker/commands/UpdateArtifactCommand.ts @@ -22,6 +22,20 @@ export interface UpdateArtifactCommandOutput extends UpdateArtifactResponse, __M /** *

Updates an artifact.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { SageMakerClient, UpdateArtifactCommand } from "@aws-sdk/client-sagemaker"; // ES Modules import + * // const { SageMakerClient, UpdateArtifactCommand } = require("@aws-sdk/client-sagemaker"); // CommonJS import + * const client = new SageMakerClient(config); + * const command = new UpdateArtifactCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link UpdateArtifactCommandInput} for command's `input` shape. + * @see {@link UpdateArtifactCommandOutput} for command's `response` shape. + * @see {@link SageMakerClientResolvedConfig | config} for command's `input` shape. + * */ export class UpdateArtifactCommand extends $Command< UpdateArtifactCommandInput, diff --git a/clients/client-sagemaker/commands/UpdateCodeRepositoryCommand.ts b/clients/client-sagemaker/commands/UpdateCodeRepositoryCommand.ts index c8897c3c113c..8f88ce9765e0 100644 --- a/clients/client-sagemaker/commands/UpdateCodeRepositoryCommand.ts +++ b/clients/client-sagemaker/commands/UpdateCodeRepositoryCommand.ts @@ -22,6 +22,20 @@ export interface UpdateCodeRepositoryCommandOutput extends UpdateCodeRepositoryO /** *

Updates the specified Git repository with the specified values.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { SageMakerClient, UpdateCodeRepositoryCommand } from "@aws-sdk/client-sagemaker"; // ES Modules import + * // const { SageMakerClient, UpdateCodeRepositoryCommand } = require("@aws-sdk/client-sagemaker"); // CommonJS import + * const client = new SageMakerClient(config); + * const command = new UpdateCodeRepositoryCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link UpdateCodeRepositoryCommandInput} for command's `input` shape. + * @see {@link UpdateCodeRepositoryCommandOutput} for command's `response` shape. + * @see {@link SageMakerClientResolvedConfig | config} for command's `input` shape. + * */ export class UpdateCodeRepositoryCommand extends $Command< UpdateCodeRepositoryCommandInput, diff --git a/clients/client-sagemaker/commands/UpdateContextCommand.ts b/clients/client-sagemaker/commands/UpdateContextCommand.ts index d8fece603d17..e178b3b4633d 100644 --- a/clients/client-sagemaker/commands/UpdateContextCommand.ts +++ b/clients/client-sagemaker/commands/UpdateContextCommand.ts @@ -22,6 +22,20 @@ export interface UpdateContextCommandOutput extends UpdateContextResponse, __Met /** *

Updates a context.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { SageMakerClient, UpdateContextCommand } from "@aws-sdk/client-sagemaker"; // ES Modules import + * // const { SageMakerClient, UpdateContextCommand } = require("@aws-sdk/client-sagemaker"); // CommonJS import + * const client = new SageMakerClient(config); + * const command = new UpdateContextCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link UpdateContextCommandInput} for command's `input` shape. + * @see {@link UpdateContextCommandOutput} for command's `response` shape. + * @see {@link SageMakerClientResolvedConfig | config} for command's `input` shape. + * */ export class UpdateContextCommand extends $Command< UpdateContextCommandInput, diff --git a/clients/client-sagemaker/commands/UpdateDeviceFleetCommand.ts b/clients/client-sagemaker/commands/UpdateDeviceFleetCommand.ts index e880d81bf76d..36aa4365f549 100644 --- a/clients/client-sagemaker/commands/UpdateDeviceFleetCommand.ts +++ b/clients/client-sagemaker/commands/UpdateDeviceFleetCommand.ts @@ -22,6 +22,20 @@ export interface UpdateDeviceFleetCommandOutput extends __MetadataBearer {} /** *

Updates a fleet of devices.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { SageMakerClient, UpdateDeviceFleetCommand } from "@aws-sdk/client-sagemaker"; // ES Modules import + * // const { SageMakerClient, UpdateDeviceFleetCommand } = require("@aws-sdk/client-sagemaker"); // CommonJS import + * const client = new SageMakerClient(config); + * const command = new UpdateDeviceFleetCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link UpdateDeviceFleetCommandInput} for command's `input` shape. + * @see {@link UpdateDeviceFleetCommandOutput} for command's `response` shape. + * @see {@link SageMakerClientResolvedConfig | config} for command's `input` shape. + * */ export class UpdateDeviceFleetCommand extends $Command< UpdateDeviceFleetCommandInput, diff --git a/clients/client-sagemaker/commands/UpdateDevicesCommand.ts b/clients/client-sagemaker/commands/UpdateDevicesCommand.ts index e9a46b3bf9fa..cb3eddb0c976 100644 --- a/clients/client-sagemaker/commands/UpdateDevicesCommand.ts +++ b/clients/client-sagemaker/commands/UpdateDevicesCommand.ts @@ -22,6 +22,20 @@ export interface UpdateDevicesCommandOutput extends __MetadataBearer {} /** *

Updates one or more devices in a fleet.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { SageMakerClient, UpdateDevicesCommand } from "@aws-sdk/client-sagemaker"; // ES Modules import + * // const { SageMakerClient, UpdateDevicesCommand } = require("@aws-sdk/client-sagemaker"); // CommonJS import + * const client = new SageMakerClient(config); + * const command = new UpdateDevicesCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link UpdateDevicesCommandInput} for command's `input` shape. + * @see {@link UpdateDevicesCommandOutput} for command's `response` shape. + * @see {@link SageMakerClientResolvedConfig | config} for command's `input` shape. + * */ export class UpdateDevicesCommand extends $Command< UpdateDevicesCommandInput, diff --git a/clients/client-sagemaker/commands/UpdateDomainCommand.ts b/clients/client-sagemaker/commands/UpdateDomainCommand.ts index 7007b1682649..ab66f7388535 100644 --- a/clients/client-sagemaker/commands/UpdateDomainCommand.ts +++ b/clients/client-sagemaker/commands/UpdateDomainCommand.ts @@ -22,6 +22,20 @@ export interface UpdateDomainCommandOutput extends UpdateDomainResponse, __Metad /** *

Updates the default settings for new user profiles in the domain.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { SageMakerClient, UpdateDomainCommand } from "@aws-sdk/client-sagemaker"; // ES Modules import + * // const { SageMakerClient, UpdateDomainCommand } = require("@aws-sdk/client-sagemaker"); // CommonJS import + * const client = new SageMakerClient(config); + * const command = new UpdateDomainCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link UpdateDomainCommandInput} for command's `input` shape. + * @see {@link UpdateDomainCommandOutput} for command's `response` shape. + * @see {@link SageMakerClientResolvedConfig | config} for command's `input` shape. + * */ export class UpdateDomainCommand extends $Command< UpdateDomainCommandInput, diff --git a/clients/client-sagemaker/commands/UpdateEndpointCommand.ts b/clients/client-sagemaker/commands/UpdateEndpointCommand.ts index d763284c2323..abe453bf4484 100644 --- a/clients/client-sagemaker/commands/UpdateEndpointCommand.ts +++ b/clients/client-sagemaker/commands/UpdateEndpointCommand.ts @@ -38,6 +38,20 @@ export interface UpdateEndpointCommandOutput extends UpdateEndpointOutput, __Met * 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.

* + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { SageMakerClient, UpdateEndpointCommand } from "@aws-sdk/client-sagemaker"; // ES Modules import + * // const { SageMakerClient, UpdateEndpointCommand } = require("@aws-sdk/client-sagemaker"); // CommonJS import + * const client = new SageMakerClient(config); + * const command = new UpdateEndpointCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link UpdateEndpointCommandInput} for command's `input` shape. + * @see {@link UpdateEndpointCommandOutput} for command's `response` shape. + * @see {@link SageMakerClientResolvedConfig | config} for command's `input` shape. + * */ export class UpdateEndpointCommand extends $Command< UpdateEndpointCommandInput, diff --git a/clients/client-sagemaker/commands/UpdateEndpointWeightsAndCapacitiesCommand.ts b/clients/client-sagemaker/commands/UpdateEndpointWeightsAndCapacitiesCommand.ts index 5ecc78700128..4b816d3e0674 100644 --- a/clients/client-sagemaker/commands/UpdateEndpointWeightsAndCapacitiesCommand.ts +++ b/clients/client-sagemaker/commands/UpdateEndpointWeightsAndCapacitiesCommand.ts @@ -28,6 +28,20 @@ export interface UpdateEndpointWeightsAndCapacitiesCommandOutput * receives the request, Amazon 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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { SageMakerClient, UpdateEndpointWeightsAndCapacitiesCommand } from "@aws-sdk/client-sagemaker"; // ES Modules import + * // const { SageMakerClient, UpdateEndpointWeightsAndCapacitiesCommand } = require("@aws-sdk/client-sagemaker"); // CommonJS import + * const client = new SageMakerClient(config); + * const command = new UpdateEndpointWeightsAndCapacitiesCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link UpdateEndpointWeightsAndCapacitiesCommandInput} for command's `input` shape. + * @see {@link UpdateEndpointWeightsAndCapacitiesCommandOutput} for command's `response` shape. + * @see {@link SageMakerClientResolvedConfig | config} for command's `input` shape. + * */ export class UpdateEndpointWeightsAndCapacitiesCommand extends $Command< UpdateEndpointWeightsAndCapacitiesCommandInput, diff --git a/clients/client-sagemaker/commands/UpdateExperimentCommand.ts b/clients/client-sagemaker/commands/UpdateExperimentCommand.ts index 911f248b1daa..8eba6cf278e3 100644 --- a/clients/client-sagemaker/commands/UpdateExperimentCommand.ts +++ b/clients/client-sagemaker/commands/UpdateExperimentCommand.ts @@ -23,6 +23,20 @@ export interface UpdateExperimentCommandOutput extends UpdateExperimentResponse, /** *

Adds, updates, or removes the description of an experiment. Updates the display name of an * experiment.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { SageMakerClient, UpdateExperimentCommand } from "@aws-sdk/client-sagemaker"; // ES Modules import + * // const { SageMakerClient, UpdateExperimentCommand } = require("@aws-sdk/client-sagemaker"); // CommonJS import + * const client = new SageMakerClient(config); + * const command = new UpdateExperimentCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link UpdateExperimentCommandInput} for command's `input` shape. + * @see {@link UpdateExperimentCommandOutput} for command's `response` shape. + * @see {@link SageMakerClientResolvedConfig | config} for command's `input` shape. + * */ export class UpdateExperimentCommand extends $Command< UpdateExperimentCommandInput, diff --git a/clients/client-sagemaker/commands/UpdateImageCommand.ts b/clients/client-sagemaker/commands/UpdateImageCommand.ts index da4cadc45c6a..6a6ca69fc77b 100644 --- a/clients/client-sagemaker/commands/UpdateImageCommand.ts +++ b/clients/client-sagemaker/commands/UpdateImageCommand.ts @@ -23,6 +23,20 @@ export interface UpdateImageCommandOutput extends UpdateImageResponse, __Metadat /** *

Updates the properties of a SageMaker image. To change the image's tags, use the * AddTags and DeleteTags APIs.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { SageMakerClient, UpdateImageCommand } from "@aws-sdk/client-sagemaker"; // ES Modules import + * // const { SageMakerClient, UpdateImageCommand } = require("@aws-sdk/client-sagemaker"); // CommonJS import + * const client = new SageMakerClient(config); + * const command = new UpdateImageCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link UpdateImageCommandInput} for command's `input` shape. + * @see {@link UpdateImageCommandOutput} for command's `response` shape. + * @see {@link SageMakerClientResolvedConfig | config} for command's `input` shape. + * */ export class UpdateImageCommand extends $Command< UpdateImageCommandInput, diff --git a/clients/client-sagemaker/commands/UpdateModelPackageCommand.ts b/clients/client-sagemaker/commands/UpdateModelPackageCommand.ts index d4b370148a7b..ebfd0c9ffa1b 100644 --- a/clients/client-sagemaker/commands/UpdateModelPackageCommand.ts +++ b/clients/client-sagemaker/commands/UpdateModelPackageCommand.ts @@ -22,6 +22,20 @@ export interface UpdateModelPackageCommandOutput extends UpdateModelPackageOutpu /** *

Updates a versioned model.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { SageMakerClient, UpdateModelPackageCommand } from "@aws-sdk/client-sagemaker"; // ES Modules import + * // const { SageMakerClient, UpdateModelPackageCommand } = require("@aws-sdk/client-sagemaker"); // CommonJS import + * const client = new SageMakerClient(config); + * const command = new UpdateModelPackageCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link UpdateModelPackageCommandInput} for command's `input` shape. + * @see {@link UpdateModelPackageCommandOutput} for command's `response` shape. + * @see {@link SageMakerClientResolvedConfig | config} for command's `input` shape. + * */ export class UpdateModelPackageCommand extends $Command< UpdateModelPackageCommandInput, diff --git a/clients/client-sagemaker/commands/UpdateMonitoringScheduleCommand.ts b/clients/client-sagemaker/commands/UpdateMonitoringScheduleCommand.ts index 1ca31da66269..6e3e21493440 100644 --- a/clients/client-sagemaker/commands/UpdateMonitoringScheduleCommand.ts +++ b/clients/client-sagemaker/commands/UpdateMonitoringScheduleCommand.ts @@ -22,6 +22,20 @@ export interface UpdateMonitoringScheduleCommandOutput extends UpdateMonitoringS /** *

Updates a previously created schedule.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { SageMakerClient, UpdateMonitoringScheduleCommand } from "@aws-sdk/client-sagemaker"; // ES Modules import + * // const { SageMakerClient, UpdateMonitoringScheduleCommand } = require("@aws-sdk/client-sagemaker"); // CommonJS import + * const client = new SageMakerClient(config); + * const command = new UpdateMonitoringScheduleCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link UpdateMonitoringScheduleCommandInput} for command's `input` shape. + * @see {@link UpdateMonitoringScheduleCommandOutput} for command's `response` shape. + * @see {@link SageMakerClientResolvedConfig | config} for command's `input` shape. + * */ export class UpdateMonitoringScheduleCommand extends $Command< UpdateMonitoringScheduleCommandInput, diff --git a/clients/client-sagemaker/commands/UpdateNotebookInstanceCommand.ts b/clients/client-sagemaker/commands/UpdateNotebookInstanceCommand.ts index ce7c3194983f..57ecf0c0471f 100644 --- a/clients/client-sagemaker/commands/UpdateNotebookInstanceCommand.ts +++ b/clients/client-sagemaker/commands/UpdateNotebookInstanceCommand.ts @@ -24,6 +24,20 @@ export interface UpdateNotebookInstanceCommandOutput extends UpdateNotebookInsta *

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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { SageMakerClient, UpdateNotebookInstanceCommand } from "@aws-sdk/client-sagemaker"; // ES Modules import + * // const { SageMakerClient, UpdateNotebookInstanceCommand } = require("@aws-sdk/client-sagemaker"); // CommonJS import + * const client = new SageMakerClient(config); + * const command = new UpdateNotebookInstanceCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link UpdateNotebookInstanceCommandInput} for command's `input` shape. + * @see {@link UpdateNotebookInstanceCommandOutput} for command's `response` shape. + * @see {@link SageMakerClientResolvedConfig | config} for command's `input` shape. + * */ export class UpdateNotebookInstanceCommand extends $Command< UpdateNotebookInstanceCommandInput, diff --git a/clients/client-sagemaker/commands/UpdateNotebookInstanceLifecycleConfigCommand.ts b/clients/client-sagemaker/commands/UpdateNotebookInstanceLifecycleConfigCommand.ts index 969b9c9ce39b..ad0c07e44df3 100644 --- a/clients/client-sagemaker/commands/UpdateNotebookInstanceLifecycleConfigCommand.ts +++ b/clients/client-sagemaker/commands/UpdateNotebookInstanceLifecycleConfigCommand.ts @@ -27,6 +27,20 @@ export interface UpdateNotebookInstanceLifecycleConfigCommandOutput /** *

Updates a notebook instance lifecycle configuration created with the CreateNotebookInstanceLifecycleConfig API.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { SageMakerClient, UpdateNotebookInstanceLifecycleConfigCommand } from "@aws-sdk/client-sagemaker"; // ES Modules import + * // const { SageMakerClient, UpdateNotebookInstanceLifecycleConfigCommand } = require("@aws-sdk/client-sagemaker"); // CommonJS import + * const client = new SageMakerClient(config); + * const command = new UpdateNotebookInstanceLifecycleConfigCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link UpdateNotebookInstanceLifecycleConfigCommandInput} for command's `input` shape. + * @see {@link UpdateNotebookInstanceLifecycleConfigCommandOutput} for command's `response` shape. + * @see {@link SageMakerClientResolvedConfig | config} for command's `input` shape. + * */ export class UpdateNotebookInstanceLifecycleConfigCommand extends $Command< UpdateNotebookInstanceLifecycleConfigCommandInput, diff --git a/clients/client-sagemaker/commands/UpdatePipelineCommand.ts b/clients/client-sagemaker/commands/UpdatePipelineCommand.ts index 9f08fc6f63ce..93c32b5277ae 100644 --- a/clients/client-sagemaker/commands/UpdatePipelineCommand.ts +++ b/clients/client-sagemaker/commands/UpdatePipelineCommand.ts @@ -22,6 +22,20 @@ export interface UpdatePipelineCommandOutput extends UpdatePipelineResponse, __M /** *

Updates a pipeline.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { SageMakerClient, UpdatePipelineCommand } from "@aws-sdk/client-sagemaker"; // ES Modules import + * // const { SageMakerClient, UpdatePipelineCommand } = require("@aws-sdk/client-sagemaker"); // CommonJS import + * const client = new SageMakerClient(config); + * const command = new UpdatePipelineCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link UpdatePipelineCommandInput} for command's `input` shape. + * @see {@link UpdatePipelineCommandOutput} for command's `response` shape. + * @see {@link SageMakerClientResolvedConfig | config} for command's `input` shape. + * */ export class UpdatePipelineCommand extends $Command< UpdatePipelineCommandInput, diff --git a/clients/client-sagemaker/commands/UpdatePipelineExecutionCommand.ts b/clients/client-sagemaker/commands/UpdatePipelineExecutionCommand.ts index 3888abc884be..70756d3ce42d 100644 --- a/clients/client-sagemaker/commands/UpdatePipelineExecutionCommand.ts +++ b/clients/client-sagemaker/commands/UpdatePipelineExecutionCommand.ts @@ -22,6 +22,20 @@ export interface UpdatePipelineExecutionCommandOutput extends UpdatePipelineExec /** *

Updates a pipeline execution.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { SageMakerClient, UpdatePipelineExecutionCommand } from "@aws-sdk/client-sagemaker"; // ES Modules import + * // const { SageMakerClient, UpdatePipelineExecutionCommand } = require("@aws-sdk/client-sagemaker"); // CommonJS import + * const client = new SageMakerClient(config); + * const command = new UpdatePipelineExecutionCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link UpdatePipelineExecutionCommandInput} for command's `input` shape. + * @see {@link UpdatePipelineExecutionCommandOutput} for command's `response` shape. + * @see {@link SageMakerClientResolvedConfig | config} for command's `input` shape. + * */ export class UpdatePipelineExecutionCommand extends $Command< UpdatePipelineExecutionCommandInput, diff --git a/clients/client-sagemaker/commands/UpdateTrainingJobCommand.ts b/clients/client-sagemaker/commands/UpdateTrainingJobCommand.ts index 5b26f73bb515..e2d6d544256e 100644 --- a/clients/client-sagemaker/commands/UpdateTrainingJobCommand.ts +++ b/clients/client-sagemaker/commands/UpdateTrainingJobCommand.ts @@ -22,6 +22,20 @@ export interface UpdateTrainingJobCommandOutput extends UpdateTrainingJobRespons /** *

Update a model training job to request a new Debugger profiling configuration.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { SageMakerClient, UpdateTrainingJobCommand } from "@aws-sdk/client-sagemaker"; // ES Modules import + * // const { SageMakerClient, UpdateTrainingJobCommand } = require("@aws-sdk/client-sagemaker"); // CommonJS import + * const client = new SageMakerClient(config); + * const command = new UpdateTrainingJobCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link UpdateTrainingJobCommandInput} for command's `input` shape. + * @see {@link UpdateTrainingJobCommandOutput} for command's `response` shape. + * @see {@link SageMakerClientResolvedConfig | config} for command's `input` shape. + * */ export class UpdateTrainingJobCommand extends $Command< UpdateTrainingJobCommandInput, diff --git a/clients/client-sagemaker/commands/UpdateTrialCommand.ts b/clients/client-sagemaker/commands/UpdateTrialCommand.ts index b44170749c58..f378ec3c0d57 100644 --- a/clients/client-sagemaker/commands/UpdateTrialCommand.ts +++ b/clients/client-sagemaker/commands/UpdateTrialCommand.ts @@ -23,6 +23,20 @@ export interface UpdateTrialCommandOutput extends UpdateTrialResponse, __Metadat /** *

Updates the display name of a trial.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { SageMakerClient, UpdateTrialCommand } from "@aws-sdk/client-sagemaker"; // ES Modules import + * // const { SageMakerClient, UpdateTrialCommand } = require("@aws-sdk/client-sagemaker"); // CommonJS import + * const client = new SageMakerClient(config); + * const command = new UpdateTrialCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link UpdateTrialCommandInput} for command's `input` shape. + * @see {@link UpdateTrialCommandOutput} for command's `response` shape. + * @see {@link SageMakerClientResolvedConfig | config} for command's `input` shape. + * */ export class UpdateTrialCommand extends $Command< UpdateTrialCommandInput, diff --git a/clients/client-sagemaker/commands/UpdateTrialComponentCommand.ts b/clients/client-sagemaker/commands/UpdateTrialComponentCommand.ts index 8b216a5f9809..f472a1ad50e3 100644 --- a/clients/client-sagemaker/commands/UpdateTrialComponentCommand.ts +++ b/clients/client-sagemaker/commands/UpdateTrialComponentCommand.ts @@ -22,6 +22,20 @@ export interface UpdateTrialComponentCommandOutput extends UpdateTrialComponentR /** *

Updates one or more properties of a trial component.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { SageMakerClient, UpdateTrialComponentCommand } from "@aws-sdk/client-sagemaker"; // ES Modules import + * // const { SageMakerClient, UpdateTrialComponentCommand } = require("@aws-sdk/client-sagemaker"); // CommonJS import + * const client = new SageMakerClient(config); + * const command = new UpdateTrialComponentCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link UpdateTrialComponentCommandInput} for command's `input` shape. + * @see {@link UpdateTrialComponentCommandOutput} for command's `response` shape. + * @see {@link SageMakerClientResolvedConfig | config} for command's `input` shape. + * */ export class UpdateTrialComponentCommand extends $Command< UpdateTrialComponentCommandInput, diff --git a/clients/client-sagemaker/commands/UpdateUserProfileCommand.ts b/clients/client-sagemaker/commands/UpdateUserProfileCommand.ts index e48a8bf2cfcc..2adfefa9dac5 100644 --- a/clients/client-sagemaker/commands/UpdateUserProfileCommand.ts +++ b/clients/client-sagemaker/commands/UpdateUserProfileCommand.ts @@ -22,6 +22,20 @@ export interface UpdateUserProfileCommandOutput extends UpdateUserProfileRespons /** *

Updates a user profile.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { SageMakerClient, UpdateUserProfileCommand } from "@aws-sdk/client-sagemaker"; // ES Modules import + * // const { SageMakerClient, UpdateUserProfileCommand } = require("@aws-sdk/client-sagemaker"); // CommonJS import + * const client = new SageMakerClient(config); + * const command = new UpdateUserProfileCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link UpdateUserProfileCommandInput} for command's `input` shape. + * @see {@link UpdateUserProfileCommandOutput} for command's `response` shape. + * @see {@link SageMakerClientResolvedConfig | config} for command's `input` shape. + * */ export class UpdateUserProfileCommand extends $Command< UpdateUserProfileCommandInput, diff --git a/clients/client-sagemaker/commands/UpdateWorkforceCommand.ts b/clients/client-sagemaker/commands/UpdateWorkforceCommand.ts index b61dcf9aa3e8..420bf559ef37 100644 --- a/clients/client-sagemaker/commands/UpdateWorkforceCommand.ts +++ b/clients/client-sagemaker/commands/UpdateWorkforceCommand.ts @@ -43,6 +43,20 @@ export interface UpdateWorkforceCommandOutput extends UpdateWorkforceResponse, _ * *

This operation only applies to private workforces.

* + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { SageMakerClient, UpdateWorkforceCommand } from "@aws-sdk/client-sagemaker"; // ES Modules import + * // const { SageMakerClient, UpdateWorkforceCommand } = require("@aws-sdk/client-sagemaker"); // CommonJS import + * const client = new SageMakerClient(config); + * const command = new UpdateWorkforceCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link UpdateWorkforceCommandInput} for command's `input` shape. + * @see {@link UpdateWorkforceCommandOutput} for command's `response` shape. + * @see {@link SageMakerClientResolvedConfig | config} for command's `input` shape. + * */ export class UpdateWorkforceCommand extends $Command< UpdateWorkforceCommandInput, diff --git a/clients/client-sagemaker/commands/UpdateWorkteamCommand.ts b/clients/client-sagemaker/commands/UpdateWorkteamCommand.ts index ed5ebb11b4da..12260d2c37a8 100644 --- a/clients/client-sagemaker/commands/UpdateWorkteamCommand.ts +++ b/clients/client-sagemaker/commands/UpdateWorkteamCommand.ts @@ -22,6 +22,20 @@ export interface UpdateWorkteamCommandOutput extends UpdateWorkteamResponse, __M /** *

Updates an existing work team with new member definitions or description.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { SageMakerClient, UpdateWorkteamCommand } from "@aws-sdk/client-sagemaker"; // ES Modules import + * // const { SageMakerClient, UpdateWorkteamCommand } = require("@aws-sdk/client-sagemaker"); // CommonJS import + * const client = new SageMakerClient(config); + * const command = new UpdateWorkteamCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link UpdateWorkteamCommandInput} for command's `input` shape. + * @see {@link UpdateWorkteamCommandOutput} for command's `response` shape. + * @see {@link SageMakerClientResolvedConfig | config} for command's `input` shape. + * */ export class UpdateWorkteamCommand extends $Command< UpdateWorkteamCommandInput, diff --git a/clients/client-sagemaker/models/models_0.ts b/clients/client-sagemaker/models/models_0.ts index ff2057b3140b..f925d67bc7d0 100644 --- a/clients/client-sagemaker/models/models_0.ts +++ b/clients/client-sagemaker/models/models_0.ts @@ -22,6 +22,9 @@ export interface ActionSource { } export namespace ActionSource { + /** + * @internal + */ export const filterSensitiveLog = (obj: ActionSource): any => ({ ...obj, }); @@ -79,6 +82,9 @@ export interface ActionSummary { } export namespace ActionSummary { + /** + * @internal + */ export const filterSensitiveLog = (obj: ActionSummary): any => ({ ...obj, }); @@ -129,6 +135,9 @@ export interface AddAssociationRequest { } export namespace AddAssociationRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: AddAssociationRequest): any => ({ ...obj, }); @@ -147,6 +156,9 @@ export interface AddAssociationResponse { } export namespace AddAssociationResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: AddAssociationResponse): any => ({ ...obj, }); @@ -163,6 +175,9 @@ export interface ResourceLimitExceeded extends __SmithyException, $MetadataBeare } export namespace ResourceLimitExceeded { + /** + * @internal + */ export const filterSensitiveLog = (obj: ResourceLimitExceeded): any => ({ ...obj, }); @@ -178,6 +193,9 @@ export interface ResourceNotFound extends __SmithyException, $MetadataBearer { } export namespace ResourceNotFound { + /** + * @internal + */ export const filterSensitiveLog = (obj: ResourceNotFound): any => ({ ...obj, }); @@ -199,6 +217,9 @@ export interface Tag { } export namespace Tag { + /** + * @internal + */ export const filterSensitiveLog = (obj: Tag): any => ({ ...obj, }); @@ -220,6 +241,9 @@ export interface AddTagsInput { } export namespace AddTagsInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: AddTagsInput): any => ({ ...obj, }); @@ -233,6 +257,9 @@ export interface AddTagsOutput { } export namespace AddTagsOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: AddTagsOutput): any => ({ ...obj, }); @@ -254,6 +281,9 @@ export interface AgentVersion { } export namespace AgentVersion { + /** + * @internal + */ export const filterSensitiveLog = (obj: AgentVersion): any => ({ ...obj, }); @@ -270,6 +300,9 @@ export interface Alarm { } export namespace Alarm { + /** + * @internal + */ export const filterSensitiveLog = (obj: Alarm): any => ({ ...obj, }); @@ -308,6 +341,9 @@ export interface MetricDefinition { } export namespace MetricDefinition { + /** + * @internal + */ export const filterSensitiveLog = (obj: MetricDefinition): any => ({ ...obj, }); @@ -401,6 +437,9 @@ export interface AlgorithmSpecification { } export namespace AlgorithmSpecification { + /** + * @internal + */ export const filterSensitiveLog = (obj: AlgorithmSpecification): any => ({ ...obj, }); @@ -442,6 +481,9 @@ export interface AlgorithmStatusItem { } export namespace AlgorithmStatusItem { + /** + * @internal + */ export const filterSensitiveLog = (obj: AlgorithmStatusItem): any => ({ ...obj, }); @@ -463,6 +505,9 @@ export interface AlgorithmStatusDetails { } export namespace AlgorithmStatusDetails { + /** + * @internal + */ export const filterSensitiveLog = (obj: AlgorithmStatusDetails): any => ({ ...obj, }); @@ -499,6 +544,9 @@ export interface AlgorithmSummary { } export namespace AlgorithmSummary { + /** + * @internal + */ export const filterSensitiveLog = (obj: AlgorithmSummary): any => ({ ...obj, }); @@ -547,6 +595,9 @@ export interface FileSystemDataSource { } export namespace FileSystemDataSource { + /** + * @internal + */ export const filterSensitiveLog = (obj: FileSystemDataSource): any => ({ ...obj, }); @@ -668,6 +719,9 @@ export interface S3DataSource { } export namespace S3DataSource { + /** + * @internal + */ export const filterSensitiveLog = (obj: S3DataSource): any => ({ ...obj, }); @@ -689,6 +743,9 @@ export interface DataSource { } export namespace DataSource { + /** + * @internal + */ export const filterSensitiveLog = (obj: DataSource): any => ({ ...obj, }); @@ -723,6 +780,9 @@ export interface ShuffleConfig { } export namespace ShuffleConfig { + /** + * @internal + */ export const filterSensitiveLog = (obj: ShuffleConfig): any => ({ ...obj, }); @@ -799,6 +859,9 @@ export interface Channel { } export namespace Channel { + /** + * @internal + */ export const filterSensitiveLog = (obj: Channel): any => ({ ...obj, }); @@ -866,6 +929,9 @@ export interface OutputDataConfig { } export namespace OutputDataConfig { + /** + * @internal + */ export const filterSensitiveLog = (obj: OutputDataConfig): any => ({ ...obj, }); @@ -984,6 +1050,9 @@ export interface ResourceConfig { } export namespace ResourceConfig { + /** + * @internal + */ export const filterSensitiveLog = (obj: ResourceConfig): any => ({ ...obj, }); @@ -1027,6 +1096,9 @@ export interface StoppingCondition { } export namespace StoppingCondition { + /** + * @internal + */ export const filterSensitiveLog = (obj: StoppingCondition): any => ({ ...obj, }); @@ -1080,6 +1152,9 @@ export interface TrainingJobDefinition { } export namespace TrainingJobDefinition { + /** + * @internal + */ export const filterSensitiveLog = (obj: TrainingJobDefinition): any => ({ ...obj, }); @@ -1163,6 +1238,9 @@ export interface TransformS3DataSource { } export namespace TransformS3DataSource { + /** + * @internal + */ export const filterSensitiveLog = (obj: TransformS3DataSource): any => ({ ...obj, }); @@ -1179,6 +1257,9 @@ export interface TransformDataSource { } export namespace TransformDataSource { + /** + * @internal + */ export const filterSensitiveLog = (obj: TransformDataSource): any => ({ ...obj, }); @@ -1260,6 +1341,9 @@ export interface TransformInput { } export namespace TransformInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: TransformInput): any => ({ ...obj, }); @@ -1348,6 +1432,9 @@ export interface TransformOutput { } export namespace TransformOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: TransformOutput): any => ({ ...obj, }); @@ -1435,6 +1522,9 @@ export interface TransformResources { } export namespace TransformResources { + /** + * @internal + */ export const filterSensitiveLog = (obj: TransformResources): any => ({ ...obj, }); @@ -1490,6 +1580,9 @@ export interface TransformJobDefinition { } export namespace TransformJobDefinition { + /** + * @internal + */ export const filterSensitiveLog = (obj: TransformJobDefinition): any => ({ ...obj, }); @@ -1522,6 +1615,9 @@ export interface AlgorithmValidationProfile { } export namespace AlgorithmValidationProfile { + /** + * @internal + */ export const filterSensitiveLog = (obj: AlgorithmValidationProfile): any => ({ ...obj, }); @@ -1545,6 +1641,9 @@ export interface AlgorithmValidationSpecification { } export namespace AlgorithmValidationSpecification { + /** + * @internal + */ export const filterSensitiveLog = (obj: AlgorithmValidationSpecification): any => ({ ...obj, }); @@ -3053,6 +3152,9 @@ export interface AnnotationConsolidationConfig { } export namespace AnnotationConsolidationConfig { + /** + * @internal + */ export const filterSensitiveLog = (obj: AnnotationConsolidationConfig): any => ({ ...obj, }); @@ -3108,6 +3210,9 @@ export interface AppDetails { } export namespace AppDetails { + /** + * @internal + */ export const filterSensitiveLog = (obj: AppDetails): any => ({ ...obj, }); @@ -3135,6 +3240,9 @@ export interface FileSystemConfig { } export namespace FileSystemConfig { + /** + * @internal + */ export const filterSensitiveLog = (obj: FileSystemConfig): any => ({ ...obj, }); @@ -3156,6 +3264,9 @@ export interface KernelSpec { } export namespace KernelSpec { + /** + * @internal + */ export const filterSensitiveLog = (obj: KernelSpec): any => ({ ...obj, }); @@ -3178,6 +3289,9 @@ export interface KernelGatewayImageConfig { } export namespace KernelGatewayImageConfig { + /** + * @internal + */ export const filterSensitiveLog = (obj: KernelGatewayImageConfig): any => ({ ...obj, }); @@ -3214,6 +3328,9 @@ export interface AppImageConfigDetails { } export namespace AppImageConfigDetails { + /** + * @internal + */ export const filterSensitiveLog = (obj: AppImageConfigDetails): any => ({ ...obj, }); @@ -3290,6 +3407,9 @@ export interface AppSpecification { } export namespace AppSpecification { + /** + * @internal + */ export const filterSensitiveLog = (obj: AppSpecification): any => ({ ...obj, }); @@ -3318,6 +3438,9 @@ export interface ArtifactSourceType { } export namespace ArtifactSourceType { + /** + * @internal + */ export const filterSensitiveLog = (obj: ArtifactSourceType): any => ({ ...obj, }); @@ -3339,6 +3462,9 @@ export interface ArtifactSource { } export namespace ArtifactSource { + /** + * @internal + */ export const filterSensitiveLog = (obj: ArtifactSource): any => ({ ...obj, }); @@ -3381,6 +3507,9 @@ export interface ArtifactSummary { } export namespace ArtifactSummary { + /** + * @internal + */ export const filterSensitiveLog = (obj: ArtifactSummary): any => ({ ...obj, }); @@ -3399,6 +3528,9 @@ export interface AssociateTrialComponentRequest { } export namespace AssociateTrialComponentRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: AssociateTrialComponentRequest): any => ({ ...obj, }); @@ -3417,6 +3549,9 @@ export interface AssociateTrialComponentResponse { } export namespace AssociateTrialComponentResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: AssociateTrialComponentResponse): any => ({ ...obj, }); @@ -3444,6 +3579,9 @@ export interface UserContext { } export namespace UserContext { + /** + * @internal + */ export const filterSensitiveLog = (obj: UserContext): any => ({ ...obj, }); @@ -3503,6 +3641,9 @@ export interface AssociationSummary { } export namespace AssociationSummary { + /** + * @internal + */ export const filterSensitiveLog = (obj: AssociationSummary): any => ({ ...obj, }); @@ -3569,6 +3710,9 @@ export interface AthenaDatasetDefinition { } export namespace AthenaDatasetDefinition { + /** + * @internal + */ export const filterSensitiveLog = (obj: AthenaDatasetDefinition): any => ({ ...obj, }); @@ -3590,6 +3734,9 @@ export interface CandidateArtifactLocations { } export namespace CandidateArtifactLocations { + /** + * @internal + */ export const filterSensitiveLog = (obj: CandidateArtifactLocations): any => ({ ...obj, }); @@ -3606,6 +3753,9 @@ export interface CandidateProperties { } export namespace CandidateProperties { + /** + * @internal + */ export const filterSensitiveLog = (obj: CandidateProperties): any => ({ ...obj, }); @@ -3646,6 +3796,9 @@ export interface AutoMLCandidateStep { } export namespace AutoMLCandidateStep { + /** + * @internal + */ export const filterSensitiveLog = (obj: AutoMLCandidateStep): any => ({ ...obj, }); @@ -3686,6 +3839,9 @@ export interface FinalAutoMLJobObjectiveMetric { } export namespace FinalAutoMLJobObjectiveMetric { + /** + * @internal + */ export const filterSensitiveLog = (obj: FinalAutoMLJobObjectiveMetric): any => ({ ...obj, }); @@ -3713,6 +3869,9 @@ export interface AutoMLContainerDefinition { } export namespace AutoMLContainerDefinition { + /** + * @internal + */ export const filterSensitiveLog = (obj: AutoMLContainerDefinition): any => ({ ...obj, }); @@ -3786,6 +3945,9 @@ export interface AutoMLCandidate { } export namespace AutoMLCandidate { + /** + * @internal + */ export const filterSensitiveLog = (obj: AutoMLCandidate): any => ({ ...obj, }); @@ -3812,6 +3974,9 @@ export interface AutoMLS3DataSource { } export namespace AutoMLS3DataSource { + /** + * @internal + */ export const filterSensitiveLog = (obj: AutoMLS3DataSource): any => ({ ...obj, }); @@ -3831,6 +3996,9 @@ export interface AutoMLDataSource { } export namespace AutoMLDataSource { + /** + * @internal + */ export const filterSensitiveLog = (obj: AutoMLDataSource): any => ({ ...obj, }); @@ -3860,6 +4028,9 @@ export interface AutoMLChannel { } export namespace AutoMLChannel { + /** + * @internal + */ export const filterSensitiveLog = (obj: AutoMLChannel): any => ({ ...obj, }); @@ -3881,6 +4052,9 @@ export interface AutoMLJobArtifacts { } export namespace AutoMLJobArtifacts { + /** + * @internal + */ export const filterSensitiveLog = (obj: AutoMLJobArtifacts): any => ({ ...obj, }); @@ -3909,6 +4083,9 @@ export interface AutoMLJobCompletionCriteria { } export namespace AutoMLJobCompletionCriteria { + /** + * @internal + */ export const filterSensitiveLog = (obj: AutoMLJobCompletionCriteria): any => ({ ...obj, }); @@ -3936,6 +4113,9 @@ export interface VpcConfig { } export namespace VpcConfig { + /** + * @internal + */ export const filterSensitiveLog = (obj: VpcConfig): any => ({ ...obj, }); @@ -3962,6 +4142,9 @@ export interface AutoMLSecurityConfig { } export namespace AutoMLSecurityConfig { + /** + * @internal + */ export const filterSensitiveLog = (obj: AutoMLSecurityConfig): any => ({ ...obj, }); @@ -3984,6 +4167,9 @@ export interface AutoMLJobConfig { } export namespace AutoMLJobConfig { + /** + * @internal + */ export const filterSensitiveLog = (obj: AutoMLJobConfig): any => ({ ...obj, }); @@ -4079,6 +4265,9 @@ export interface AutoMLJobObjective { } export namespace AutoMLJobObjective { + /** + * @internal + */ export const filterSensitiveLog = (obj: AutoMLJobObjective): any => ({ ...obj, }); @@ -4119,6 +4308,9 @@ export interface AutoMLPartialFailureReason { } export namespace AutoMLPartialFailureReason { + /** + * @internal + */ export const filterSensitiveLog = (obj: AutoMLPartialFailureReason): any => ({ ...obj, }); @@ -4175,6 +4367,9 @@ export interface AutoMLJobSummary { } export namespace AutoMLJobSummary { + /** + * @internal + */ export const filterSensitiveLog = (obj: AutoMLJobSummary): any => ({ ...obj, }); @@ -4196,6 +4391,9 @@ export interface AutoMLOutputDataConfig { } export namespace AutoMLOutputDataConfig { + /** + * @internal + */ export const filterSensitiveLog = (obj: AutoMLOutputDataConfig): any => ({ ...obj, }); @@ -4223,6 +4421,9 @@ export interface AutoRollbackConfig { } export namespace AutoRollbackConfig { + /** + * @internal + */ export const filterSensitiveLog = (obj: AutoRollbackConfig): any => ({ ...obj, }); @@ -4254,6 +4455,9 @@ export interface MetricsSource { } export namespace MetricsSource { + /** + * @internal + */ export const filterSensitiveLog = (obj: MetricsSource): any => ({ ...obj, }); @@ -4270,6 +4474,9 @@ export interface Bias { } export namespace Bias { + /** + * @internal + */ export const filterSensitiveLog = (obj: Bias): any => ({ ...obj, }); @@ -4296,6 +4503,9 @@ export interface CapacitySize { } export namespace CapacitySize { + /** + * @internal + */ export const filterSensitiveLog = (obj: CapacitySize): any => ({ ...obj, }); @@ -4327,6 +4537,9 @@ export interface TrafficRoutingConfig { } export namespace TrafficRoutingConfig { + /** + * @internal + */ export const filterSensitiveLog = (obj: TrafficRoutingConfig): any => ({ ...obj, }); @@ -4353,6 +4566,9 @@ export interface BlueGreenUpdatePolicy { } export namespace BlueGreenUpdatePolicy { + /** + * @internal + */ export const filterSensitiveLog = (obj: BlueGreenUpdatePolicy): any => ({ ...obj, }); @@ -4374,6 +4590,9 @@ export interface CacheHitResult { } export namespace CacheHitResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: CacheHitResult): any => ({ ...obj, }); @@ -4401,6 +4620,9 @@ export interface CaptureContentTypeHeader { } export namespace CaptureContentTypeHeader { + /** + * @internal + */ export const filterSensitiveLog = (obj: CaptureContentTypeHeader): any => ({ ...obj, }); @@ -4422,6 +4644,9 @@ export interface CaptureOption { } export namespace CaptureOption { + /** + * @internal + */ export const filterSensitiveLog = (obj: CaptureOption): any => ({ ...obj, }); @@ -4450,6 +4675,9 @@ export interface CategoricalParameterRange { } export namespace CategoricalParameterRange { + /** + * @internal + */ export const filterSensitiveLog = (obj: CategoricalParameterRange): any => ({ ...obj, }); @@ -4466,6 +4694,9 @@ export interface CategoricalParameterRangeSpecification { } export namespace CategoricalParameterRangeSpecification { + /** + * @internal + */ export const filterSensitiveLog = (obj: CategoricalParameterRangeSpecification): any => ({ ...obj, }); @@ -4512,6 +4743,9 @@ export interface ChannelSpecification { } export namespace ChannelSpecification { + /** + * @internal + */ export const filterSensitiveLog = (obj: ChannelSpecification): any => ({ ...obj, }); @@ -4536,6 +4770,9 @@ export interface CheckpointConfig { } export namespace CheckpointConfig { + /** + * @internal + */ export const filterSensitiveLog = (obj: CheckpointConfig): any => ({ ...obj, }); @@ -4579,6 +4816,9 @@ export interface GitConfig { } export namespace GitConfig { + /** + * @internal + */ export const filterSensitiveLog = (obj: GitConfig): any => ({ ...obj, }); @@ -4617,6 +4857,9 @@ export interface CodeRepositorySummary { } export namespace CodeRepositorySummary { + /** + * @internal + */ export const filterSensitiveLog = (obj: CodeRepositorySummary): any => ({ ...obj, }); @@ -4645,6 +4888,9 @@ export interface CognitoConfig { } export namespace CognitoConfig { + /** + * @internal + */ export const filterSensitiveLog = (obj: CognitoConfig): any => ({ ...obj, }); @@ -4674,6 +4920,9 @@ export interface CognitoMemberDefinition { } export namespace CognitoMemberDefinition { + /** + * @internal + */ export const filterSensitiveLog = (obj: CognitoMemberDefinition): any => ({ ...obj, }); @@ -4698,6 +4947,9 @@ export interface CollectionConfiguration { } export namespace CollectionConfiguration { + /** + * @internal + */ export const filterSensitiveLog = (obj: CollectionConfiguration): any => ({ ...obj, }); @@ -4828,6 +5080,9 @@ export interface CompilationJobSummary { } export namespace CompilationJobSummary { + /** + * @internal + */ export const filterSensitiveLog = (obj: CompilationJobSummary): any => ({ ...obj, }); @@ -4849,6 +5104,9 @@ export interface ConditionStepMetadata { } export namespace ConditionStepMetadata { + /** + * @internal + */ export const filterSensitiveLog = (obj: ConditionStepMetadata): any => ({ ...obj, }); @@ -4865,6 +5123,9 @@ export interface ConflictException extends __SmithyException, $MetadataBearer { } export namespace ConflictException { + /** + * @internal + */ export const filterSensitiveLog = (obj: ConflictException): any => ({ ...obj, }); @@ -4893,6 +5154,9 @@ export interface RepositoryAuthConfig { } export namespace RepositoryAuthConfig { + /** + * @internal + */ export const filterSensitiveLog = (obj: RepositoryAuthConfig): any => ({ ...obj, }); @@ -4929,6 +5193,9 @@ export interface ImageConfig { } export namespace ImageConfig { + /** + * @internal + */ export const filterSensitiveLog = (obj: ImageConfig): any => ({ ...obj, }); @@ -4960,6 +5227,9 @@ export interface MultiModelConfig { } export namespace MultiModelConfig { + /** + * @internal + */ export const filterSensitiveLog = (obj: MultiModelConfig): any => ({ ...obj, }); @@ -5055,6 +5325,9 @@ export interface ContainerDefinition { } export namespace ContainerDefinition { + /** + * @internal + */ export const filterSensitiveLog = (obj: ContainerDefinition): any => ({ ...obj, }); @@ -5086,6 +5359,9 @@ export interface ContextSource { } export namespace ContextSource { + /** + * @internal + */ export const filterSensitiveLog = (obj: ContextSource): any => ({ ...obj, }); @@ -5128,6 +5404,9 @@ export interface ContextSummary { } export namespace ContextSummary { + /** + * @internal + */ export const filterSensitiveLog = (obj: ContextSummary): any => ({ ...obj, }); @@ -5197,6 +5476,9 @@ export interface ContinuousParameterRange { } export namespace ContinuousParameterRange { + /** + * @internal + */ export const filterSensitiveLog = (obj: ContinuousParameterRange): any => ({ ...obj, }); @@ -5218,6 +5500,9 @@ export interface ContinuousParameterRangeSpecification { } export namespace ContinuousParameterRangeSpecification { + /** + * @internal + */ export const filterSensitiveLog = (obj: ContinuousParameterRangeSpecification): any => ({ ...obj, }); @@ -5249,6 +5534,9 @@ export interface MetadataProperties { } export namespace MetadataProperties { + /** + * @internal + */ export const filterSensitiveLog = (obj: MetadataProperties): any => ({ ...obj, }); @@ -5297,6 +5585,9 @@ export interface CreateActionRequest { } export namespace CreateActionRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateActionRequest): any => ({ ...obj, }); @@ -5310,6 +5601,9 @@ export interface CreateActionResponse { } export namespace CreateActionResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateActionResponse): any => ({ ...obj, }); @@ -5358,6 +5652,9 @@ export interface ModelPackageContainerDefinition { } export namespace ModelPackageContainerDefinition { + /** + * @internal + */ export const filterSensitiveLog = (obj: ModelPackageContainerDefinition): any => ({ ...obj, }); @@ -5468,6 +5765,9 @@ export interface InferenceSpecification { } export namespace InferenceSpecification { + /** + * @internal + */ export const filterSensitiveLog = (obj: InferenceSpecification): any => ({ ...obj, }); @@ -5489,6 +5789,9 @@ export interface IntegerParameterRangeSpecification { } export namespace IntegerParameterRangeSpecification { + /** + * @internal + */ export const filterSensitiveLog = (obj: IntegerParameterRangeSpecification): any => ({ ...obj, }); @@ -5519,6 +5822,9 @@ export interface ParameterRange { } export namespace ParameterRange { + /** + * @internal + */ export const filterSensitiveLog = (obj: ParameterRange): any => ({ ...obj, }); @@ -5575,6 +5881,9 @@ export interface HyperParameterSpecification { } export namespace HyperParameterSpecification { + /** + * @internal + */ export const filterSensitiveLog = (obj: HyperParameterSpecification): any => ({ ...obj, }); @@ -5609,6 +5918,9 @@ export interface HyperParameterTuningJobObjective { } export namespace HyperParameterTuningJobObjective { + /** + * @internal + */ export const filterSensitiveLog = (obj: HyperParameterTuningJobObjective): any => ({ ...obj, }); @@ -5668,6 +5980,9 @@ export interface TrainingSpecification { } export namespace TrainingSpecification { + /** + * @internal + */ export const filterSensitiveLog = (obj: TrainingSpecification): any => ({ ...obj, }); @@ -5759,6 +6074,9 @@ export interface CreateAlgorithmInput { } export namespace CreateAlgorithmInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateAlgorithmInput): any => ({ ...obj, }); @@ -5772,6 +6090,9 @@ export interface CreateAlgorithmOutput { } export namespace CreateAlgorithmOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateAlgorithmOutput): any => ({ ...obj, }); @@ -5799,6 +6120,9 @@ export interface ResourceSpec { } export namespace ResourceSpec { + /** + * @internal + */ export const filterSensitiveLog = (obj: ResourceSpec): any => ({ ...obj, }); @@ -5839,6 +6163,9 @@ export interface CreateAppRequest { } export namespace CreateAppRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateAppRequest): any => ({ ...obj, }); @@ -5852,6 +6179,9 @@ export interface CreateAppResponse { } export namespace CreateAppResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateAppResponse): any => ({ ...obj, }); @@ -5867,6 +6197,9 @@ export interface ResourceInUse extends __SmithyException, $MetadataBearer { } export namespace ResourceInUse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ResourceInUse): any => ({ ...obj, }); @@ -5890,6 +6223,9 @@ export interface CreateAppImageConfigRequest { } export namespace CreateAppImageConfigRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateAppImageConfigRequest): any => ({ ...obj, }); @@ -5903,6 +6239,9 @@ export interface CreateAppImageConfigResponse { } export namespace CreateAppImageConfigResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateAppImageConfigResponse): any => ({ ...obj, }); @@ -5941,6 +6280,9 @@ export interface CreateArtifactRequest { } export namespace CreateArtifactRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateArtifactRequest): any => ({ ...obj, }); @@ -5954,6 +6296,9 @@ export interface CreateArtifactResponse { } export namespace CreateArtifactResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateArtifactResponse): any => ({ ...obj, }); @@ -6024,6 +6369,9 @@ export interface CreateAutoMLJobRequest { } export namespace CreateAutoMLJobRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateAutoMLJobRequest): any => ({ ...obj, }); @@ -6037,6 +6385,9 @@ export interface CreateAutoMLJobResponse { } export namespace CreateAutoMLJobResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateAutoMLJobResponse): any => ({ ...obj, }); @@ -6065,6 +6416,9 @@ export interface CreateCodeRepositoryInput { } export namespace CreateCodeRepositoryInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateCodeRepositoryInput): any => ({ ...obj, }); @@ -6078,6 +6432,9 @@ export interface CreateCodeRepositoryOutput { } export namespace CreateCodeRepositoryOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateCodeRepositoryOutput): any => ({ ...obj, }); @@ -6456,6 +6813,9 @@ export interface InputConfig { } export namespace InputConfig { + /** + * @internal + */ export const filterSensitiveLog = (obj: InputConfig): any => ({ ...obj, }); @@ -6536,6 +6896,9 @@ export interface TargetPlatform { } export namespace TargetPlatform { + /** + * @internal + */ export const filterSensitiveLog = (obj: TargetPlatform): any => ({ ...obj, }); @@ -6815,6 +7178,9 @@ export interface OutputConfig { } export namespace OutputConfig { + /** + * @internal + */ export const filterSensitiveLog = (obj: OutputConfig): any => ({ ...obj, }); @@ -6882,6 +7248,9 @@ export interface CreateCompilationJobRequest { } export namespace CreateCompilationJobRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateCompilationJobRequest): any => ({ ...obj, }); @@ -6903,6 +7272,9 @@ export interface CreateCompilationJobResponse { } export namespace CreateCompilationJobResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateCompilationJobResponse): any => ({ ...obj, }); @@ -6941,6 +7313,9 @@ export interface CreateContextRequest { } export namespace CreateContextRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateContextRequest): any => ({ ...obj, }); @@ -6954,6 +7329,9 @@ export interface CreateContextResponse { } export namespace CreateContextResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateContextResponse): any => ({ ...obj, }); @@ -6999,6 +7377,9 @@ export interface DataQualityAppSpecification { } export namespace DataQualityAppSpecification { + /** + * @internal + */ export const filterSensitiveLog = (obj: DataQualityAppSpecification): any => ({ ...obj, }); @@ -7015,6 +7396,9 @@ export interface MonitoringConstraintsResource { } export namespace MonitoringConstraintsResource { + /** + * @internal + */ export const filterSensitiveLog = (obj: MonitoringConstraintsResource): any => ({ ...obj, }); @@ -7031,6 +7415,9 @@ export interface MonitoringStatisticsResource { } export namespace MonitoringStatisticsResource { + /** + * @internal + */ export const filterSensitiveLog = (obj: MonitoringStatisticsResource): any => ({ ...obj, }); @@ -7059,6 +7446,9 @@ export interface DataQualityBaselineConfig { } export namespace DataQualityBaselineConfig { + /** + * @internal + */ export const filterSensitiveLog = (obj: DataQualityBaselineConfig): any => ({ ...obj, }); @@ -7140,6 +7530,9 @@ export interface EndpointInput { } export namespace EndpointInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: EndpointInput): any => ({ ...obj, }); @@ -7157,6 +7550,9 @@ export interface DataQualityJobInput { } export namespace DataQualityJobInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: DataQualityJobInput): any => ({ ...obj, }); @@ -7192,6 +7588,9 @@ export interface MonitoringS3Output { } export namespace MonitoringS3Output { + /** + * @internal + */ export const filterSensitiveLog = (obj: MonitoringS3Output): any => ({ ...obj, }); @@ -7208,6 +7607,9 @@ export interface MonitoringOutput { } export namespace MonitoringOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: MonitoringOutput): any => ({ ...obj, }); @@ -7231,6 +7633,9 @@ export interface MonitoringOutputConfig { } export namespace MonitoringOutputConfig { + /** + * @internal + */ export const filterSensitiveLog = (obj: MonitoringOutputConfig): any => ({ ...obj, }); @@ -7307,6 +7712,9 @@ export interface MonitoringClusterConfig { } export namespace MonitoringClusterConfig { + /** + * @internal + */ export const filterSensitiveLog = (obj: MonitoringClusterConfig): any => ({ ...obj, }); @@ -7323,6 +7731,9 @@ export interface MonitoringResources { } export namespace MonitoringResources { + /** + * @internal + */ export const filterSensitiveLog = (obj: MonitoringResources): any => ({ ...obj, }); @@ -7355,6 +7766,9 @@ export interface MonitoringNetworkConfig { } export namespace MonitoringNetworkConfig { + /** + * @internal + */ export const filterSensitiveLog = (obj: MonitoringNetworkConfig): any => ({ ...obj, }); @@ -7371,6 +7785,9 @@ export interface MonitoringStoppingCondition { } export namespace MonitoringStoppingCondition { + /** + * @internal + */ export const filterSensitiveLog = (obj: MonitoringStoppingCondition): any => ({ ...obj, }); @@ -7432,6 +7849,9 @@ export interface CreateDataQualityJobDefinitionRequest { } export namespace CreateDataQualityJobDefinitionRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateDataQualityJobDefinitionRequest): any => ({ ...obj, }); @@ -7445,6 +7865,9 @@ export interface CreateDataQualityJobDefinitionResponse { } export namespace CreateDataQualityJobDefinitionResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateDataQualityJobDefinitionResponse): any => ({ ...obj, }); @@ -7466,6 +7889,9 @@ export interface EdgeOutputConfig { } export namespace EdgeOutputConfig { + /** + * @internal + */ export const filterSensitiveLog = (obj: EdgeOutputConfig): any => ({ ...obj, }); @@ -7499,6 +7925,9 @@ export interface CreateDeviceFleetRequest { } export namespace CreateDeviceFleetRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateDeviceFleetRequest): any => ({ ...obj, }); @@ -7515,6 +7944,9 @@ export interface JupyterServerAppSettings { } export namespace JupyterServerAppSettings { + /** + * @internal + */ export const filterSensitiveLog = (obj: JupyterServerAppSettings): any => ({ ...obj, }); @@ -7542,6 +7974,9 @@ export interface CustomImage { } export namespace CustomImage { + /** + * @internal + */ export const filterSensitiveLog = (obj: CustomImage): any => ({ ...obj, }); @@ -7563,6 +7998,9 @@ export interface KernelGatewayAppSettings { } export namespace KernelGatewayAppSettings { + /** + * @internal + */ export const filterSensitiveLog = (obj: KernelGatewayAppSettings): any => ({ ...obj, }); @@ -7601,6 +8039,9 @@ export interface SharingSettings { } export namespace SharingSettings { + /** + * @internal + */ export const filterSensitiveLog = (obj: SharingSettings): any => ({ ...obj, }); @@ -7617,6 +8058,9 @@ export interface TensorBoardAppSettings { } export namespace TensorBoardAppSettings { + /** + * @internal + */ export const filterSensitiveLog = (obj: TensorBoardAppSettings): any => ({ ...obj, }); @@ -7670,6 +8114,9 @@ export interface UserSettings { } export namespace UserSettings { + /** + * @internal + */ export const filterSensitiveLog = (obj: UserSettings): any => ({ ...obj, }); @@ -7745,6 +8192,9 @@ export interface CreateDomainRequest { } export namespace CreateDomainRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateDomainRequest): any => ({ ...obj, }); @@ -7763,6 +8213,9 @@ export interface CreateDomainResponse { } export namespace CreateDomainResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateDomainResponse): any => ({ ...obj, }); @@ -7811,6 +8264,9 @@ export interface CreateEdgePackagingJobRequest { } export namespace CreateEdgePackagingJobRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateEdgePackagingJobRequest): any => ({ ...obj, }); @@ -7839,6 +8295,9 @@ export interface CreateEndpointInput { } export namespace CreateEndpointInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateEndpointInput): any => ({ ...obj, }); @@ -7852,6 +8311,9 @@ export interface CreateEndpointOutput { } export namespace CreateEndpointOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateEndpointOutput): any => ({ ...obj, }); @@ -7893,6 +8355,9 @@ export interface DataCaptureConfig { } export namespace DataCaptureConfig { + /** + * @internal + */ export const filterSensitiveLog = (obj: DataCaptureConfig): any => ({ ...obj, }); @@ -7967,6 +8432,9 @@ export interface ProductionVariantCoreDumpConfig { } export namespace ProductionVariantCoreDumpConfig { + /** + * @internal + */ export const filterSensitiveLog = (obj: ProductionVariantCoreDumpConfig): any => ({ ...obj, }); @@ -8025,6 +8493,9 @@ export interface ProductionVariant { } export namespace ProductionVariant { + /** + * @internal + */ export const filterSensitiveLog = (obj: ProductionVariant): any => ({ ...obj, }); @@ -8102,6 +8573,9 @@ export interface CreateEndpointConfigInput { } export namespace CreateEndpointConfigInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateEndpointConfigInput): any => ({ ...obj, }); @@ -8115,6 +8589,9 @@ export interface CreateEndpointConfigOutput { } export namespace CreateEndpointConfigOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateEndpointConfigOutput): any => ({ ...obj, }); @@ -8147,6 +8624,9 @@ export interface CreateExperimentRequest { } export namespace CreateExperimentRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateExperimentRequest): any => ({ ...obj, }); @@ -8160,6 +8640,9 @@ export interface CreateExperimentResponse { } export namespace CreateExperimentResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateExperimentResponse): any => ({ ...obj, }); @@ -8191,6 +8674,9 @@ export interface FeatureDefinition { } export namespace FeatureDefinition { + /** + * @internal + */ export const filterSensitiveLog = (obj: FeatureDefinition): any => ({ ...obj, }); @@ -8218,6 +8704,9 @@ export interface DataCatalogConfig { } export namespace DataCatalogConfig { + /** + * @internal + */ export const filterSensitiveLog = (obj: DataCatalogConfig): any => ({ ...obj, }); @@ -8256,6 +8745,9 @@ export interface S3StorageConfig { } export namespace S3StorageConfig { + /** + * @internal + */ export const filterSensitiveLog = (obj: S3StorageConfig): any => ({ ...obj, }); @@ -8289,6 +8781,9 @@ export interface OfflineStoreConfig { } export namespace OfflineStoreConfig { + /** + * @internal + */ export const filterSensitiveLog = (obj: OfflineStoreConfig): any => ({ ...obj, }); @@ -8376,6 +8871,9 @@ export interface OnlineStoreSecurityConfig { } export namespace OnlineStoreSecurityConfig { + /** + * @internal + */ export const filterSensitiveLog = (obj: OnlineStoreSecurityConfig): any => ({ ...obj, }); @@ -8405,6 +8903,9 @@ export interface OnlineStoreConfig { } export namespace OnlineStoreConfig { + /** + * @internal + */ export const filterSensitiveLog = (obj: OnlineStoreConfig): any => ({ ...obj, }); @@ -8536,6 +9037,9 @@ export interface CreateFeatureGroupRequest { } export namespace CreateFeatureGroupRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateFeatureGroupRequest): any => ({ ...obj, }); @@ -8550,6 +9054,9 @@ export interface CreateFeatureGroupResponse { } export namespace CreateFeatureGroupResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateFeatureGroupResponse): any => ({ ...obj, }); @@ -8570,6 +9077,9 @@ export interface HumanLoopActivationConditionsConfig { } export namespace HumanLoopActivationConditionsConfig { + /** + * @internal + */ export const filterSensitiveLog = (obj: HumanLoopActivationConditionsConfig): any => ({ ...obj, }); @@ -8587,6 +9097,9 @@ export interface HumanLoopActivationConfig { } export namespace HumanLoopActivationConfig { + /** + * @internal + */ export const filterSensitiveLog = (obj: HumanLoopActivationConfig): any => ({ ...obj, }); @@ -8613,6 +9126,9 @@ export interface USD { } export namespace USD { + /** + * @internal + */ export const filterSensitiveLog = (obj: USD): any => ({ ...obj, }); @@ -8930,6 +9446,9 @@ export interface PublicWorkforceTaskPrice { } export namespace PublicWorkforceTaskPrice { + /** + * @internal + */ export const filterSensitiveLog = (obj: PublicWorkforceTaskPrice): any => ({ ...obj, }); @@ -9299,6 +9818,9 @@ export interface HumanLoopConfig { } export namespace HumanLoopConfig { + /** + * @internal + */ export const filterSensitiveLog = (obj: HumanLoopConfig): any => ({ ...obj, }); @@ -9316,6 +9838,9 @@ export interface HumanLoopRequestSource { } export namespace HumanLoopRequestSource { + /** + * @internal + */ export const filterSensitiveLog = (obj: HumanLoopRequestSource): any => ({ ...obj, }); @@ -9339,6 +9864,9 @@ export interface FlowDefinitionOutputConfig { } export namespace FlowDefinitionOutputConfig { + /** + * @internal + */ export const filterSensitiveLog = (obj: FlowDefinitionOutputConfig): any => ({ ...obj, }); @@ -9383,6 +9911,9 @@ export interface CreateFlowDefinitionRequest { } export namespace CreateFlowDefinitionRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateFlowDefinitionRequest): any => ({ ...obj, }); @@ -9396,6 +9927,9 @@ export interface CreateFlowDefinitionResponse { } export namespace CreateFlowDefinitionResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateFlowDefinitionResponse): any => ({ ...obj, }); @@ -9412,6 +9946,9 @@ export interface UiTemplate { } export namespace UiTemplate { + /** + * @internal + */ export const filterSensitiveLog = (obj: UiTemplate): any => ({ ...obj, }); @@ -9435,6 +9972,9 @@ export interface CreateHumanTaskUiRequest { } export namespace CreateHumanTaskUiRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateHumanTaskUiRequest): any => ({ ...obj, }); @@ -9448,6 +9988,9 @@ export interface CreateHumanTaskUiResponse { } export namespace CreateHumanTaskUiResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateHumanTaskUiResponse): any => ({ ...obj, }); @@ -9505,6 +10048,9 @@ export interface IntegerParameterRange { } export namespace IntegerParameterRange { + /** + * @internal + */ export const filterSensitiveLog = (obj: IntegerParameterRange): any => ({ ...obj, }); @@ -9543,6 +10089,9 @@ export interface ParameterRanges { } export namespace ParameterRanges { + /** + * @internal + */ export const filterSensitiveLog = (obj: ParameterRanges): any => ({ ...obj, }); @@ -9573,6 +10122,9 @@ export interface ResourceLimits { } export namespace ResourceLimits { + /** + * @internal + */ export const filterSensitiveLog = (obj: ResourceLimits): any => ({ ...obj, }); @@ -9599,6 +10151,9 @@ export interface TuningJobCompletionCriteria { } export namespace TuningJobCompletionCriteria { + /** + * @internal + */ export const filterSensitiveLog = (obj: TuningJobCompletionCriteria): any => ({ ...obj, }); @@ -9666,6 +10221,9 @@ export interface HyperParameterTuningJobConfig { } export namespace HyperParameterTuningJobConfig { + /** + * @internal + */ export const filterSensitiveLog = (obj: HyperParameterTuningJobConfig): any => ({ ...obj, }); @@ -9724,6 +10282,9 @@ export interface HyperParameterAlgorithmSpecification { } export namespace HyperParameterAlgorithmSpecification { + /** + * @internal + */ export const filterSensitiveLog = (obj: HyperParameterAlgorithmSpecification): any => ({ ...obj, }); @@ -9869,6 +10430,9 @@ export interface HyperParameterTrainingJobDefinition { } export namespace HyperParameterTrainingJobDefinition { + /** + * @internal + */ export const filterSensitiveLog = (obj: HyperParameterTrainingJobDefinition): any => ({ ...obj, }); @@ -9887,6 +10451,9 @@ export interface ParentHyperParameterTuningJob { } export namespace ParentHyperParameterTuningJob { + /** + * @internal + */ export const filterSensitiveLog = (obj: ParentHyperParameterTuningJob): any => ({ ...obj, }); @@ -9959,6 +10526,9 @@ export interface HyperParameterTuningJobWarmStartConfig { } export namespace HyperParameterTuningJobWarmStartConfig { + /** + * @internal + */ export const filterSensitiveLog = (obj: HyperParameterTuningJobWarmStartConfig): any => ({ ...obj, }); @@ -10028,6 +10598,9 @@ export interface CreateHyperParameterTuningJobRequest { } export namespace CreateHyperParameterTuningJobRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateHyperParameterTuningJobRequest): any => ({ ...obj, }); @@ -10042,6 +10615,9 @@ export interface CreateHyperParameterTuningJobResponse { } export namespace CreateHyperParameterTuningJobResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateHyperParameterTuningJobResponse): any => ({ ...obj, }); @@ -10075,6 +10651,9 @@ export interface CreateImageRequest { } export namespace CreateImageRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateImageRequest): any => ({ ...obj, }); @@ -10088,6 +10667,9 @@ export interface CreateImageResponse { } export namespace CreateImageResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateImageResponse): any => ({ ...obj, }); @@ -10116,6 +10698,9 @@ export interface CreateImageVersionRequest { } export namespace CreateImageVersionRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateImageVersionRequest): any => ({ ...obj, }); @@ -10129,6 +10714,9 @@ export interface CreateImageVersionResponse { } export namespace CreateImageVersionResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateImageVersionResponse): any => ({ ...obj, }); @@ -10217,6 +10805,9 @@ export interface UiConfig { } export namespace UiConfig { + /** + * @internal + */ export const filterSensitiveLog = (obj: UiConfig): any => ({ ...obj, }); @@ -11840,6 +12431,9 @@ export interface HumanTaskConfig { } export namespace HumanTaskConfig { + /** + * @internal + */ export const filterSensitiveLog = (obj: HumanTaskConfig): any => ({ ...obj, }); @@ -11859,6 +12453,9 @@ export interface LabelingJobDataAttributes { } export namespace LabelingJobDataAttributes { + /** + * @internal + */ export const filterSensitiveLog = (obj: LabelingJobDataAttributes): any => ({ ...obj, }); @@ -11893,6 +12490,9 @@ export interface LabelingJobS3DataSource { } export namespace LabelingJobS3DataSource { + /** + * @internal + */ export const filterSensitiveLog = (obj: LabelingJobS3DataSource): any => ({ ...obj, }); @@ -11910,6 +12510,9 @@ export interface LabelingJobSnsDataSource { } export namespace LabelingJobSnsDataSource { + /** + * @internal + */ export const filterSensitiveLog = (obj: LabelingJobSnsDataSource): any => ({ ...obj, }); @@ -11939,6 +12542,9 @@ export interface LabelingJobDataSource { } export namespace LabelingJobDataSource { + /** + * @internal + */ export const filterSensitiveLog = (obj: LabelingJobDataSource): any => ({ ...obj, }); @@ -11960,6 +12566,9 @@ export interface LabelingJobInputConfig { } export namespace LabelingJobInputConfig { + /** + * @internal + */ export const filterSensitiveLog = (obj: LabelingJobInputConfig): any => ({ ...obj, }); @@ -12000,6 +12609,9 @@ export interface LabelingJobResourceConfig { } export namespace LabelingJobResourceConfig { + /** + * @internal + */ export const filterSensitiveLog = (obj: LabelingJobResourceConfig): any => ({ ...obj, }); @@ -12065,6 +12677,9 @@ export interface LabelingJobAlgorithmsConfig { } export namespace LabelingJobAlgorithmsConfig { + /** + * @internal + */ export const filterSensitiveLog = (obj: LabelingJobAlgorithmsConfig): any => ({ ...obj, }); @@ -12106,6 +12721,9 @@ export interface LabelingJobOutputConfig { } export namespace LabelingJobOutputConfig { + /** + * @internal + */ export const filterSensitiveLog = (obj: LabelingJobOutputConfig): any => ({ ...obj, }); @@ -12132,6 +12750,9 @@ export interface LabelingJobStoppingConditions { } export namespace LabelingJobStoppingConditions { + /** + * @internal + */ export const filterSensitiveLog = (obj: LabelingJobStoppingConditions): any => ({ ...obj, }); @@ -12316,6 +12937,9 @@ export interface CreateLabelingJobRequest { } export namespace CreateLabelingJobRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateLabelingJobRequest): any => ({ ...obj, }); @@ -12330,6 +12954,9 @@ export interface CreateLabelingJobResponse { } export namespace CreateLabelingJobResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateLabelingJobResponse): any => ({ ...obj, }); @@ -12361,6 +12988,9 @@ export interface InferenceExecutionConfig { } export namespace InferenceExecutionConfig { + /** + * @internal + */ export const filterSensitiveLog = (obj: InferenceExecutionConfig): any => ({ ...obj, }); @@ -12427,6 +13057,9 @@ export interface CreateModelInput { } export namespace CreateModelInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateModelInput): any => ({ ...obj, }); @@ -12440,6 +13073,9 @@ export interface CreateModelOutput { } export namespace CreateModelOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateModelOutput): any => ({ ...obj, }); @@ -12468,6 +13104,9 @@ export interface ModelBiasAppSpecification { } export namespace ModelBiasAppSpecification { + /** + * @internal + */ export const filterSensitiveLog = (obj: ModelBiasAppSpecification): any => ({ ...obj, }); @@ -12489,6 +13128,9 @@ export interface ModelBiasBaselineConfig { } export namespace ModelBiasBaselineConfig { + /** + * @internal + */ export const filterSensitiveLog = (obj: ModelBiasBaselineConfig): any => ({ ...obj, }); @@ -12505,6 +13147,9 @@ export interface MonitoringGroundTruthS3Input { } export namespace MonitoringGroundTruthS3Input { + /** + * @internal + */ export const filterSensitiveLog = (obj: MonitoringGroundTruthS3Input): any => ({ ...obj, }); @@ -12526,6 +13171,9 @@ export interface ModelBiasJobInput { } export namespace ModelBiasJobInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: ModelBiasJobInput): any => ({ ...obj, }); @@ -12587,6 +13235,9 @@ export interface CreateModelBiasJobDefinitionRequest { } export namespace CreateModelBiasJobDefinitionRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateModelBiasJobDefinitionRequest): any => ({ ...obj, }); @@ -12600,6 +13251,9 @@ export interface CreateModelBiasJobDefinitionResponse { } export namespace CreateModelBiasJobDefinitionResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateModelBiasJobDefinitionResponse): any => ({ ...obj, }); @@ -12628,6 +13282,9 @@ export interface ModelExplainabilityAppSpecification { } export namespace ModelExplainabilityAppSpecification { + /** + * @internal + */ export const filterSensitiveLog = (obj: ModelExplainabilityAppSpecification): any => ({ ...obj, }); @@ -12649,6 +13306,9 @@ export interface ModelExplainabilityBaselineConfig { } export namespace ModelExplainabilityBaselineConfig { + /** + * @internal + */ export const filterSensitiveLog = (obj: ModelExplainabilityBaselineConfig): any => ({ ...obj, }); @@ -12665,6 +13325,9 @@ export interface ModelExplainabilityJobInput { } export namespace ModelExplainabilityJobInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: ModelExplainabilityJobInput): any => ({ ...obj, }); @@ -12727,6 +13390,9 @@ export interface CreateModelExplainabilityJobDefinitionRequest { } export namespace CreateModelExplainabilityJobDefinitionRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateModelExplainabilityJobDefinitionRequest): any => ({ ...obj, }); @@ -12740,6 +13406,9 @@ export interface CreateModelExplainabilityJobDefinitionResponse { } export namespace CreateModelExplainabilityJobDefinitionResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateModelExplainabilityJobDefinitionResponse): any => ({ ...obj, }); @@ -12762,6 +13431,9 @@ export interface Explainability { } export namespace Explainability { + /** + * @internal + */ export const filterSensitiveLog = (obj: Explainability): any => ({ ...obj, }); @@ -12783,6 +13455,9 @@ export interface ModelDataQuality { } export namespace ModelDataQuality { + /** + * @internal + */ export const filterSensitiveLog = (obj: ModelDataQuality): any => ({ ...obj, }); @@ -12804,6 +13479,9 @@ export interface ModelQuality { } export namespace ModelQuality { + /** + * @internal + */ export const filterSensitiveLog = (obj: ModelQuality): any => ({ ...obj, }); diff --git a/clients/client-sagemaker/models/models_1.ts b/clients/client-sagemaker/models/models_1.ts index 048a5999578f..a3cb508bcb85 100644 --- a/clients/client-sagemaker/models/models_1.ts +++ b/clients/client-sagemaker/models/models_1.ts @@ -130,6 +130,9 @@ export interface ModelMetrics { } export namespace ModelMetrics { + /** + * @internal + */ export const filterSensitiveLog = (obj: ModelMetrics): any => ({ ...obj, }); @@ -161,6 +164,9 @@ export interface SourceAlgorithm { } export namespace SourceAlgorithm { + /** + * @internal + */ export const filterSensitiveLog = (obj: SourceAlgorithm): any => ({ ...obj, }); @@ -177,6 +183,9 @@ export interface SourceAlgorithmSpecification { } export namespace SourceAlgorithmSpecification { + /** + * @internal + */ export const filterSensitiveLog = (obj: SourceAlgorithmSpecification): any => ({ ...obj, }); @@ -202,6 +211,9 @@ export interface ModelPackageValidationProfile { } export namespace ModelPackageValidationProfile { + /** + * @internal + */ export const filterSensitiveLog = (obj: ModelPackageValidationProfile): any => ({ ...obj, }); @@ -224,6 +236,9 @@ export interface ModelPackageValidationSpecification { } export namespace ModelPackageValidationSpecification { + /** + * @internal + */ export const filterSensitiveLog = (obj: ModelPackageValidationSpecification): any => ({ ...obj, }); @@ -320,6 +335,9 @@ export interface CreateModelPackageInput { } export namespace CreateModelPackageInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateModelPackageInput): any => ({ ...obj, }); @@ -333,6 +351,9 @@ export interface CreateModelPackageOutput { } export namespace CreateModelPackageOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateModelPackageOutput): any => ({ ...obj, }); @@ -358,6 +379,9 @@ export interface CreateModelPackageGroupInput { } export namespace CreateModelPackageGroupInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateModelPackageGroupInput): any => ({ ...obj, }); @@ -371,6 +395,9 @@ export interface CreateModelPackageGroupOutput { } export namespace CreateModelPackageGroupOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateModelPackageGroupOutput): any => ({ ...obj, }); @@ -427,6 +454,9 @@ export interface ModelQualityAppSpecification { } export namespace ModelQualityAppSpecification { + /** + * @internal + */ export const filterSensitiveLog = (obj: ModelQualityAppSpecification): any => ({ ...obj, }); @@ -450,6 +480,9 @@ export interface ModelQualityBaselineConfig { } export namespace ModelQualityBaselineConfig { + /** + * @internal + */ export const filterSensitiveLog = (obj: ModelQualityBaselineConfig): any => ({ ...obj, }); @@ -472,6 +505,9 @@ export interface ModelQualityJobInput { } export namespace ModelQualityJobInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: ModelQualityJobInput): any => ({ ...obj, }); @@ -532,6 +568,9 @@ export interface CreateModelQualityJobDefinitionRequest { } export namespace CreateModelQualityJobDefinitionRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateModelQualityJobDefinitionRequest): any => ({ ...obj, }); @@ -545,6 +584,9 @@ export interface CreateModelQualityJobDefinitionResponse { } export namespace CreateModelQualityJobDefinitionResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateModelQualityJobDefinitionResponse): any => ({ ...obj, }); @@ -575,6 +617,9 @@ export interface MonitoringBaselineConfig { } export namespace MonitoringBaselineConfig { + /** + * @internal + */ export const filterSensitiveLog = (obj: MonitoringBaselineConfig): any => ({ ...obj, }); @@ -615,6 +660,9 @@ export interface MonitoringAppSpecification { } export namespace MonitoringAppSpecification { + /** + * @internal + */ export const filterSensitiveLog = (obj: MonitoringAppSpecification): any => ({ ...obj, }); @@ -631,6 +679,9 @@ export interface MonitoringInput { } export namespace MonitoringInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: MonitoringInput): any => ({ ...obj, }); @@ -665,6 +716,9 @@ export interface NetworkConfig { } export namespace NetworkConfig { + /** + * @internal + */ export const filterSensitiveLog = (obj: NetworkConfig): any => ({ ...obj, }); @@ -726,6 +780,9 @@ export interface MonitoringJobDefinition { } export namespace MonitoringJobDefinition { + /** + * @internal + */ export const filterSensitiveLog = (obj: MonitoringJobDefinition): any => ({ ...obj, }); @@ -806,6 +863,9 @@ export interface ScheduleConfig { } export namespace ScheduleConfig { + /** + * @internal + */ export const filterSensitiveLog = (obj: ScheduleConfig): any => ({ ...obj, }); @@ -837,6 +897,9 @@ export interface MonitoringScheduleConfig { } export namespace MonitoringScheduleConfig { + /** + * @internal + */ export const filterSensitiveLog = (obj: MonitoringScheduleConfig): any => ({ ...obj, }); @@ -863,6 +926,9 @@ export interface CreateMonitoringScheduleRequest { } export namespace CreateMonitoringScheduleRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateMonitoringScheduleRequest): any => ({ ...obj, }); @@ -876,6 +942,9 @@ export interface CreateMonitoringScheduleResponse { } export namespace CreateMonitoringScheduleResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateMonitoringScheduleResponse): any => ({ ...obj, }); @@ -1058,6 +1127,9 @@ export interface CreateNotebookInstanceInput { } export namespace CreateNotebookInstanceInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateNotebookInstanceInput): any => ({ ...obj, }); @@ -1071,6 +1143,9 @@ export interface CreateNotebookInstanceOutput { } export namespace CreateNotebookInstanceOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateNotebookInstanceOutput): any => ({ ...obj, }); @@ -1099,6 +1174,9 @@ export interface NotebookInstanceLifecycleHook { } export namespace NotebookInstanceLifecycleHook { + /** + * @internal + */ export const filterSensitiveLog = (obj: NotebookInstanceLifecycleHook): any => ({ ...obj, }); @@ -1124,6 +1202,9 @@ export interface CreateNotebookInstanceLifecycleConfigInput { } export namespace CreateNotebookInstanceLifecycleConfigInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateNotebookInstanceLifecycleConfigInput): any => ({ ...obj, }); @@ -1137,6 +1218,9 @@ export interface CreateNotebookInstanceLifecycleConfigOutput { } export namespace CreateNotebookInstanceLifecycleConfigOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateNotebookInstanceLifecycleConfigOutput): any => ({ ...obj, }); @@ -1181,6 +1265,9 @@ export interface CreatePipelineRequest { } export namespace CreatePipelineRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreatePipelineRequest): any => ({ ...obj, }); @@ -1194,6 +1281,9 @@ export interface CreatePipelineResponse { } export namespace CreatePipelineResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreatePipelineResponse): any => ({ ...obj, }); @@ -1223,6 +1313,9 @@ export interface CreatePresignedDomainUrlRequest { } export namespace CreatePresignedDomainUrlRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreatePresignedDomainUrlRequest): any => ({ ...obj, }); @@ -1236,6 +1329,9 @@ export interface CreatePresignedDomainUrlResponse { } export namespace CreatePresignedDomainUrlResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreatePresignedDomainUrlResponse): any => ({ ...obj, }); @@ -1254,6 +1350,9 @@ export interface CreatePresignedNotebookInstanceUrlInput { } export namespace CreatePresignedNotebookInstanceUrlInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreatePresignedNotebookInstanceUrlInput): any => ({ ...obj, }); @@ -1267,6 +1366,9 @@ export interface CreatePresignedNotebookInstanceUrlOutput { } export namespace CreatePresignedNotebookInstanceUrlOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreatePresignedNotebookInstanceUrlOutput): any => ({ ...obj, }); @@ -1313,6 +1415,9 @@ export interface ExperimentConfig { } export namespace ExperimentConfig { + /** + * @internal + */ export const filterSensitiveLog = (obj: ExperimentConfig): any => ({ ...obj, }); @@ -1393,6 +1498,9 @@ export interface RedshiftDatasetDefinition { } export namespace RedshiftDatasetDefinition { + /** + * @internal + */ export const filterSensitiveLog = (obj: RedshiftDatasetDefinition): any => ({ ...obj, }); @@ -1438,6 +1546,9 @@ export interface DatasetDefinition { } export namespace DatasetDefinition { + /** + * @internal + */ export const filterSensitiveLog = (obj: DatasetDefinition): any => ({ ...obj, }); @@ -1506,6 +1617,9 @@ export interface ProcessingS3Input { } export namespace ProcessingS3Input { + /** + * @internal + */ export const filterSensitiveLog = (obj: ProcessingS3Input): any => ({ ...obj, }); @@ -1539,6 +1653,9 @@ export interface ProcessingInput { } export namespace ProcessingInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: ProcessingInput): any => ({ ...obj, }); @@ -1556,6 +1673,9 @@ export interface ProcessingFeatureStoreOutput { } export namespace ProcessingFeatureStoreOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: ProcessingFeatureStoreOutput): any => ({ ...obj, }); @@ -1587,6 +1707,9 @@ export interface ProcessingS3Output { } export namespace ProcessingS3Output { + /** + * @internal + */ export const filterSensitiveLog = (obj: ProcessingS3Output): any => ({ ...obj, }); @@ -1622,6 +1745,9 @@ export interface ProcessingOutput { } export namespace ProcessingOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: ProcessingOutput): any => ({ ...obj, }); @@ -1646,6 +1772,9 @@ export interface ProcessingOutputConfig { } export namespace ProcessingOutputConfig { + /** + * @internal + */ export const filterSensitiveLog = (obj: ProcessingOutputConfig): any => ({ ...obj, }); @@ -1681,6 +1810,9 @@ export interface ProcessingClusterConfig { } export namespace ProcessingClusterConfig { + /** + * @internal + */ export const filterSensitiveLog = (obj: ProcessingClusterConfig): any => ({ ...obj, }); @@ -1699,6 +1831,9 @@ export interface ProcessingResources { } export namespace ProcessingResources { + /** + * @internal + */ export const filterSensitiveLog = (obj: ProcessingResources): any => ({ ...obj, }); @@ -1716,6 +1851,9 @@ export interface ProcessingStoppingCondition { } export namespace ProcessingStoppingCondition { + /** + * @internal + */ export const filterSensitiveLog = (obj: ProcessingStoppingCondition): any => ({ ...obj, }); @@ -1805,6 +1943,9 @@ export interface CreateProcessingJobRequest { } export namespace CreateProcessingJobRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateProcessingJobRequest): any => ({ ...obj, }); @@ -1818,6 +1959,9 @@ export interface CreateProcessingJobResponse { } export namespace CreateProcessingJobResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateProcessingJobResponse): any => ({ ...obj, }); @@ -1841,6 +1985,9 @@ export interface ProvisioningParameter { } export namespace ProvisioningParameter { + /** + * @internal + */ export const filterSensitiveLog = (obj: ProvisioningParameter): any => ({ ...obj, }); @@ -1874,6 +2021,9 @@ export interface ServiceCatalogProvisioningDetails { } export namespace ServiceCatalogProvisioningDetails { + /** + * @internal + */ export const filterSensitiveLog = (obj: ServiceCatalogProvisioningDetails): any => ({ ...obj, }); @@ -1905,6 +2055,9 @@ export interface CreateProjectInput { } export namespace CreateProjectInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateProjectInput): any => ({ ...obj, }); @@ -1923,6 +2076,9 @@ export interface CreateProjectOutput { } export namespace CreateProjectOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateProjectOutput): any => ({ ...obj, }); @@ -1961,6 +2117,9 @@ export interface DebugHookConfig { } export namespace DebugHookConfig { + /** + * @internal + */ export const filterSensitiveLog = (obj: DebugHookConfig): any => ({ ...obj, }); @@ -2011,6 +2170,9 @@ export interface DebugRuleConfiguration { } export namespace DebugRuleConfiguration { + /** + * @internal + */ export const filterSensitiveLog = (obj: DebugRuleConfiguration): any => ({ ...obj, }); @@ -2044,6 +2206,9 @@ export interface ProfilerConfig { } export namespace ProfilerConfig { + /** + * @internal + */ export const filterSensitiveLog = (obj: ProfilerConfig): any => ({ ...obj, }); @@ -2090,6 +2255,9 @@ export interface ProfilerRuleConfiguration { } export namespace ProfilerRuleConfiguration { + /** + * @internal + */ export const filterSensitiveLog = (obj: ProfilerRuleConfiguration): any => ({ ...obj, }); @@ -2112,6 +2280,9 @@ export interface TensorBoardOutputConfig { } export namespace TensorBoardOutputConfig { + /** + * @internal + */ export const filterSensitiveLog = (obj: TensorBoardOutputConfig): any => ({ ...obj, }); @@ -2316,6 +2487,9 @@ export interface CreateTrainingJobRequest { } export namespace CreateTrainingJobRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateTrainingJobRequest): any => ({ ...obj, }); @@ -2329,6 +2503,9 @@ export interface CreateTrainingJobResponse { } export namespace CreateTrainingJobResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateTrainingJobResponse): any => ({ ...obj, }); @@ -2392,6 +2569,9 @@ export interface DataProcessing { } export namespace DataProcessing { + /** + * @internal + */ export const filterSensitiveLog = (obj: DataProcessing): any => ({ ...obj, }); @@ -2414,6 +2594,9 @@ export interface ModelClientConfig { } export namespace ModelClientConfig { + /** + * @internal + */ export const filterSensitiveLog = (obj: ModelClientConfig): any => ({ ...obj, }); @@ -2552,6 +2735,9 @@ export interface CreateTransformJobRequest { } export namespace CreateTransformJobRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateTransformJobRequest): any => ({ ...obj, }); @@ -2565,6 +2751,9 @@ export interface CreateTransformJobResponse { } export namespace CreateTransformJobResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateTransformJobResponse): any => ({ ...obj, }); @@ -2601,6 +2790,9 @@ export interface CreateTrialRequest { } export namespace CreateTrialRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateTrialRequest): any => ({ ...obj, }); @@ -2614,6 +2806,9 @@ export interface CreateTrialResponse { } export namespace CreateTrialResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateTrialResponse): any => ({ ...obj, }); @@ -2643,6 +2838,9 @@ export interface TrialComponentArtifact { } export namespace TrialComponentArtifact { + /** + * @internal + */ export const filterSensitiveLog = (obj: TrialComponentArtifact): any => ({ ...obj, }); @@ -2697,6 +2895,9 @@ export namespace TrialComponentParameterValue { return visitor._(value.$unknown[0], value.$unknown[1]); }; + /** + * @internal + */ export const filterSensitiveLog = (obj: TrialComponentParameterValue): any => { if (obj.StringValue !== undefined) return { StringValue: obj.StringValue }; if (obj.NumberValue !== undefined) return { NumberValue: obj.NumberValue }; @@ -2728,6 +2929,9 @@ export interface TrialComponentStatus { } export namespace TrialComponentStatus { + /** + * @internal + */ export const filterSensitiveLog = (obj: TrialComponentStatus): any => ({ ...obj, }); @@ -2803,6 +3007,9 @@ export interface CreateTrialComponentRequest { } export namespace CreateTrialComponentRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateTrialComponentRequest): any => ({ ...obj, ...(obj.Parameters && { @@ -2825,6 +3032,9 @@ export interface CreateTrialComponentResponse { } export namespace CreateTrialComponentResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateTrialComponentResponse): any => ({ ...obj, }); @@ -2868,6 +3078,9 @@ export interface CreateUserProfileRequest { } export namespace CreateUserProfileRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateUserProfileRequest): any => ({ ...obj, }); @@ -2881,6 +3094,9 @@ export interface CreateUserProfileResponse { } export namespace CreateUserProfileResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateUserProfileResponse): any => ({ ...obj, }); @@ -2932,6 +3148,9 @@ export interface OidcConfig { } export namespace OidcConfig { + /** + * @internal + */ export const filterSensitiveLog = (obj: OidcConfig): any => ({ ...obj, ...(obj.ClientSecret && { ClientSecret: SENSITIVE_STRING }), @@ -2956,6 +3175,9 @@ export interface SourceIpConfig { } export namespace SourceIpConfig { + /** + * @internal + */ export const filterSensitiveLog = (obj: SourceIpConfig): any => ({ ...obj, }); @@ -3001,6 +3223,9 @@ export interface CreateWorkforceRequest { } export namespace CreateWorkforceRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateWorkforceRequest): any => ({ ...obj, ...(obj.OidcConfig && { OidcConfig: OidcConfig.filterSensitiveLog(obj.OidcConfig) }), @@ -3015,6 +3240,9 @@ export interface CreateWorkforceResponse { } export namespace CreateWorkforceResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateWorkforceResponse): any => ({ ...obj, }); @@ -3037,6 +3265,9 @@ export interface OidcMemberDefinition { } export namespace OidcMemberDefinition { + /** + * @internal + */ export const filterSensitiveLog = (obj: OidcMemberDefinition): any => ({ ...obj, }); @@ -3062,6 +3293,9 @@ export interface MemberDefinition { } export namespace MemberDefinition { + /** + * @internal + */ export const filterSensitiveLog = (obj: MemberDefinition): any => ({ ...obj, }); @@ -3079,6 +3313,9 @@ export interface NotificationConfiguration { } export namespace NotificationConfiguration { + /** + * @internal + */ export const filterSensitiveLog = (obj: NotificationConfiguration): any => ({ ...obj, }); @@ -3137,6 +3374,9 @@ export interface CreateWorkteamRequest { } export namespace CreateWorkteamRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateWorkteamRequest): any => ({ ...obj, }); @@ -3151,6 +3391,9 @@ export interface CreateWorkteamResponse { } export namespace CreateWorkteamResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateWorkteamResponse): any => ({ ...obj, }); @@ -3187,6 +3430,9 @@ export interface DataCaptureConfigSummary { } export namespace DataCaptureConfigSummary { + /** + * @internal + */ export const filterSensitiveLog = (obj: DataCaptureConfigSummary): any => ({ ...obj, }); @@ -3232,6 +3478,9 @@ export interface DebugRuleEvaluationStatus { } export namespace DebugRuleEvaluationStatus { + /** + * @internal + */ export const filterSensitiveLog = (obj: DebugRuleEvaluationStatus): any => ({ ...obj, }); @@ -3245,6 +3494,9 @@ export interface DeleteActionRequest { } export namespace DeleteActionRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteActionRequest): any => ({ ...obj, }); @@ -3258,6 +3510,9 @@ export interface DeleteActionResponse { } export namespace DeleteActionResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteActionResponse): any => ({ ...obj, }); @@ -3271,6 +3526,9 @@ export interface DeleteAlgorithmInput { } export namespace DeleteAlgorithmInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteAlgorithmInput): any => ({ ...obj, }); @@ -3299,6 +3557,9 @@ export interface DeleteAppRequest { } export namespace DeleteAppRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteAppRequest): any => ({ ...obj, }); @@ -3312,6 +3573,9 @@ export interface DeleteAppImageConfigRequest { } export namespace DeleteAppImageConfigRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteAppImageConfigRequest): any => ({ ...obj, }); @@ -3330,6 +3594,9 @@ export interface DeleteArtifactRequest { } export namespace DeleteArtifactRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteArtifactRequest): any => ({ ...obj, }); @@ -3343,6 +3610,9 @@ export interface DeleteArtifactResponse { } export namespace DeleteArtifactResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteArtifactResponse): any => ({ ...obj, }); @@ -3361,6 +3631,9 @@ export interface DeleteAssociationRequest { } export namespace DeleteAssociationRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteAssociationRequest): any => ({ ...obj, }); @@ -3379,6 +3652,9 @@ export interface DeleteAssociationResponse { } export namespace DeleteAssociationResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteAssociationResponse): any => ({ ...obj, }); @@ -3392,6 +3668,9 @@ export interface DeleteCodeRepositoryInput { } export namespace DeleteCodeRepositoryInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteCodeRepositoryInput): any => ({ ...obj, }); @@ -3405,6 +3684,9 @@ export interface DeleteContextRequest { } export namespace DeleteContextRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteContextRequest): any => ({ ...obj, }); @@ -3418,6 +3700,9 @@ export interface DeleteContextResponse { } export namespace DeleteContextResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteContextResponse): any => ({ ...obj, }); @@ -3431,6 +3716,9 @@ export interface DeleteDataQualityJobDefinitionRequest { } export namespace DeleteDataQualityJobDefinitionRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteDataQualityJobDefinitionRequest): any => ({ ...obj, }); @@ -3444,6 +3732,9 @@ export interface DeleteDeviceFleetRequest { } export namespace DeleteDeviceFleetRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteDeviceFleetRequest): any => ({ ...obj, }); @@ -3466,6 +3757,9 @@ export interface RetentionPolicy { } export namespace RetentionPolicy { + /** + * @internal + */ export const filterSensitiveLog = (obj: RetentionPolicy): any => ({ ...obj, }); @@ -3486,6 +3780,9 @@ export interface DeleteDomainRequest { } export namespace DeleteDomainRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteDomainRequest): any => ({ ...obj, }); @@ -3499,6 +3796,9 @@ export interface DeleteEndpointInput { } export namespace DeleteEndpointInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteEndpointInput): any => ({ ...obj, }); @@ -3512,6 +3812,9 @@ export interface DeleteEndpointConfigInput { } export namespace DeleteEndpointConfigInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteEndpointConfigInput): any => ({ ...obj, }); @@ -3525,6 +3828,9 @@ export interface DeleteExperimentRequest { } export namespace DeleteExperimentRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteExperimentRequest): any => ({ ...obj, }); @@ -3538,6 +3844,9 @@ export interface DeleteExperimentResponse { } export namespace DeleteExperimentResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteExperimentResponse): any => ({ ...obj, }); @@ -3552,6 +3861,9 @@ export interface DeleteFeatureGroupRequest { } export namespace DeleteFeatureGroupRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteFeatureGroupRequest): any => ({ ...obj, }); @@ -3565,6 +3877,9 @@ export interface DeleteFlowDefinitionRequest { } export namespace DeleteFlowDefinitionRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteFlowDefinitionRequest): any => ({ ...obj, }); @@ -3573,6 +3888,9 @@ export namespace DeleteFlowDefinitionRequest { export interface DeleteFlowDefinitionResponse {} export namespace DeleteFlowDefinitionResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteFlowDefinitionResponse): any => ({ ...obj, }); @@ -3586,6 +3904,9 @@ export interface DeleteHumanTaskUiRequest { } export namespace DeleteHumanTaskUiRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteHumanTaskUiRequest): any => ({ ...obj, }); @@ -3594,6 +3915,9 @@ export namespace DeleteHumanTaskUiRequest { export interface DeleteHumanTaskUiResponse {} export namespace DeleteHumanTaskUiResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteHumanTaskUiResponse): any => ({ ...obj, }); @@ -3607,6 +3931,9 @@ export interface DeleteImageRequest { } export namespace DeleteImageRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteImageRequest): any => ({ ...obj, }); @@ -3615,6 +3942,9 @@ export namespace DeleteImageRequest { export interface DeleteImageResponse {} export namespace DeleteImageResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteImageResponse): any => ({ ...obj, }); @@ -3633,6 +3963,9 @@ export interface DeleteImageVersionRequest { } export namespace DeleteImageVersionRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteImageVersionRequest): any => ({ ...obj, }); @@ -3641,6 +3974,9 @@ export namespace DeleteImageVersionRequest { export interface DeleteImageVersionResponse {} export namespace DeleteImageVersionResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteImageVersionResponse): any => ({ ...obj, }); @@ -3654,6 +3990,9 @@ export interface DeleteModelInput { } export namespace DeleteModelInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteModelInput): any => ({ ...obj, }); @@ -3667,6 +4006,9 @@ export interface DeleteModelBiasJobDefinitionRequest { } export namespace DeleteModelBiasJobDefinitionRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteModelBiasJobDefinitionRequest): any => ({ ...obj, }); @@ -3680,6 +4022,9 @@ export interface DeleteModelExplainabilityJobDefinitionRequest { } export namespace DeleteModelExplainabilityJobDefinitionRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteModelExplainabilityJobDefinitionRequest): any => ({ ...obj, }); @@ -3694,6 +4039,9 @@ export interface DeleteModelPackageInput { } export namespace DeleteModelPackageInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteModelPackageInput): any => ({ ...obj, }); @@ -3707,6 +4055,9 @@ export interface DeleteModelPackageGroupInput { } export namespace DeleteModelPackageGroupInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteModelPackageGroupInput): any => ({ ...obj, }); @@ -3720,6 +4071,9 @@ export interface DeleteModelPackageGroupPolicyInput { } export namespace DeleteModelPackageGroupPolicyInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteModelPackageGroupPolicyInput): any => ({ ...obj, }); @@ -3733,6 +4087,9 @@ export interface DeleteModelQualityJobDefinitionRequest { } export namespace DeleteModelQualityJobDefinitionRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteModelQualityJobDefinitionRequest): any => ({ ...obj, }); @@ -3746,6 +4103,9 @@ export interface DeleteMonitoringScheduleRequest { } export namespace DeleteMonitoringScheduleRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteMonitoringScheduleRequest): any => ({ ...obj, }); @@ -3759,6 +4119,9 @@ export interface DeleteNotebookInstanceInput { } export namespace DeleteNotebookInstanceInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteNotebookInstanceInput): any => ({ ...obj, }); @@ -3772,6 +4135,9 @@ export interface DeleteNotebookInstanceLifecycleConfigInput { } export namespace DeleteNotebookInstanceLifecycleConfigInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteNotebookInstanceLifecycleConfigInput): any => ({ ...obj, }); @@ -3791,6 +4157,9 @@ export interface DeletePipelineRequest { } export namespace DeletePipelineRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeletePipelineRequest): any => ({ ...obj, }); @@ -3804,6 +4173,9 @@ export interface DeletePipelineResponse { } export namespace DeletePipelineResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeletePipelineResponse): any => ({ ...obj, }); @@ -3817,6 +4189,9 @@ export interface DeleteProjectInput { } export namespace DeleteProjectInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteProjectInput): any => ({ ...obj, }); @@ -3836,6 +4211,9 @@ export interface DeleteTagsInput { } export namespace DeleteTagsInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteTagsInput): any => ({ ...obj, }); @@ -3844,6 +4222,9 @@ export namespace DeleteTagsInput { export interface DeleteTagsOutput {} export namespace DeleteTagsOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteTagsOutput): any => ({ ...obj, }); @@ -3857,6 +4238,9 @@ export interface DeleteTrialRequest { } export namespace DeleteTrialRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteTrialRequest): any => ({ ...obj, }); @@ -3870,6 +4254,9 @@ export interface DeleteTrialResponse { } export namespace DeleteTrialResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteTrialResponse): any => ({ ...obj, }); @@ -3883,6 +4270,9 @@ export interface DeleteTrialComponentRequest { } export namespace DeleteTrialComponentRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteTrialComponentRequest): any => ({ ...obj, }); @@ -3896,6 +4286,9 @@ export interface DeleteTrialComponentResponse { } export namespace DeleteTrialComponentResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteTrialComponentResponse): any => ({ ...obj, }); @@ -3914,6 +4307,9 @@ export interface DeleteUserProfileRequest { } export namespace DeleteUserProfileRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteUserProfileRequest): any => ({ ...obj, }); @@ -3927,6 +4323,9 @@ export interface DeleteWorkforceRequest { } export namespace DeleteWorkforceRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteWorkforceRequest): any => ({ ...obj, }); @@ -3935,6 +4334,9 @@ export namespace DeleteWorkforceRequest { export interface DeleteWorkforceResponse {} export namespace DeleteWorkforceResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteWorkforceResponse): any => ({ ...obj, }); @@ -3948,6 +4350,9 @@ export interface DeleteWorkteamRequest { } export namespace DeleteWorkteamRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteWorkteamRequest): any => ({ ...obj, }); @@ -3962,6 +4367,9 @@ export interface DeleteWorkteamResponse { } export namespace DeleteWorkteamResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteWorkteamResponse): any => ({ ...obj, }); @@ -3996,6 +4404,9 @@ export interface DeployedImage { } export namespace DeployedImage { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeployedImage): any => ({ ...obj, }); @@ -4017,6 +4428,9 @@ export interface DeploymentConfig { } export namespace DeploymentConfig { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeploymentConfig): any => ({ ...obj, }); @@ -4035,6 +4449,9 @@ export interface DeregisterDevicesRequest { } export namespace DeregisterDevicesRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeregisterDevicesRequest): any => ({ ...obj, }); @@ -4048,6 +4465,9 @@ export interface DescribeActionRequest { } export namespace DescribeActionRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeActionRequest): any => ({ ...obj, }); @@ -4118,6 +4538,9 @@ export interface DescribeActionResponse { } export namespace DescribeActionResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeActionResponse): any => ({ ...obj, }); @@ -4131,6 +4554,9 @@ export interface DescribeAlgorithmInput { } export namespace DescribeAlgorithmInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeAlgorithmInput): any => ({ ...obj, }); @@ -4195,6 +4621,9 @@ export interface DescribeAlgorithmOutput { } export namespace DescribeAlgorithmOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeAlgorithmOutput): any => ({ ...obj, }); @@ -4223,6 +4652,9 @@ export interface DescribeAppRequest { } export namespace DescribeAppRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeAppRequest): any => ({ ...obj, }); @@ -4286,6 +4718,9 @@ export interface DescribeAppResponse { } export namespace DescribeAppResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeAppResponse): any => ({ ...obj, }); @@ -4299,6 +4734,9 @@ export interface DescribeAppImageConfigRequest { } export namespace DescribeAppImageConfigRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeAppImageConfigRequest): any => ({ ...obj, }); @@ -4332,6 +4770,9 @@ export interface DescribeAppImageConfigResponse { } export namespace DescribeAppImageConfigResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeAppImageConfigResponse): any => ({ ...obj, }); @@ -4345,6 +4786,9 @@ export interface DescribeArtifactRequest { } export namespace DescribeArtifactRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeArtifactRequest): any => ({ ...obj, }); @@ -4405,6 +4849,9 @@ export interface DescribeArtifactResponse { } export namespace DescribeArtifactResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeArtifactResponse): any => ({ ...obj, }); @@ -4418,6 +4865,9 @@ export interface DescribeAutoMLJobRequest { } export namespace DescribeAutoMLJobRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeAutoMLJobRequest): any => ({ ...obj, }); @@ -4445,6 +4895,9 @@ export interface ResolvedAttributes { } export namespace ResolvedAttributes { + /** + * @internal + */ export const filterSensitiveLog = (obj: ResolvedAttributes): any => ({ ...obj, }); @@ -4551,6 +5004,9 @@ export interface DescribeAutoMLJobResponse { } export namespace DescribeAutoMLJobResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeAutoMLJobResponse): any => ({ ...obj, }); @@ -4564,6 +5020,9 @@ export interface DescribeCodeRepositoryInput { } export namespace DescribeCodeRepositoryInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeCodeRepositoryInput): any => ({ ...obj, }); @@ -4599,6 +5058,9 @@ export interface DescribeCodeRepositoryOutput { } export namespace DescribeCodeRepositoryOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeCodeRepositoryOutput): any => ({ ...obj, }); @@ -4612,6 +5074,9 @@ export interface DescribeCompilationJobRequest { } export namespace DescribeCompilationJobRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeCompilationJobRequest): any => ({ ...obj, }); @@ -4633,6 +5098,9 @@ export interface ModelArtifacts { } export namespace ModelArtifacts { + /** + * @internal + */ export const filterSensitiveLog = (obj: ModelArtifacts): any => ({ ...obj, }); @@ -4650,6 +5118,9 @@ export interface ModelDigests { } export namespace ModelDigests { + /** + * @internal + */ export const filterSensitiveLog = (obj: ModelDigests): any => ({ ...obj, }); @@ -4743,6 +5214,9 @@ export interface DescribeCompilationJobResponse { } export namespace DescribeCompilationJobResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeCompilationJobResponse): any => ({ ...obj, }); @@ -4756,6 +5230,9 @@ export interface DescribeContextRequest { } export namespace DescribeContextRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeContextRequest): any => ({ ...obj, }); @@ -4816,6 +5293,9 @@ export interface DescribeContextResponse { } export namespace DescribeContextResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeContextResponse): any => ({ ...obj, }); @@ -4829,6 +5309,9 @@ export interface DescribeDataQualityJobDefinitionRequest { } export namespace DescribeDataQualityJobDefinitionRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeDataQualityJobDefinitionRequest): any => ({ ...obj, }); @@ -4894,6 +5377,9 @@ export interface DescribeDataQualityJobDefinitionResponse { } export namespace DescribeDataQualityJobDefinitionResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeDataQualityJobDefinitionResponse): any => ({ ...obj, }); @@ -4917,6 +5403,9 @@ export interface DescribeDeviceRequest { } export namespace DescribeDeviceRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeDeviceRequest): any => ({ ...obj, }); @@ -4948,6 +5437,9 @@ export interface EdgeModel { } export namespace EdgeModel { + /** + * @internal + */ export const filterSensitiveLog = (obj: EdgeModel): any => ({ ...obj, }); @@ -5006,6 +5498,9 @@ export interface DescribeDeviceResponse { } export namespace DescribeDeviceResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeDeviceResponse): any => ({ ...obj, }); @@ -5019,6 +5514,9 @@ export interface DescribeDeviceFleetRequest { } export namespace DescribeDeviceFleetRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeDeviceFleetRequest): any => ({ ...obj, }); @@ -5067,6 +5565,9 @@ export interface DescribeDeviceFleetResponse { } export namespace DescribeDeviceFleetResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeDeviceFleetResponse): any => ({ ...obj, }); @@ -5080,6 +5581,9 @@ export interface DescribeDomainRequest { } export namespace DescribeDomainRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeDomainRequest): any => ({ ...obj, }); @@ -5200,6 +5704,9 @@ export interface DescribeDomainResponse { } export namespace DescribeDomainResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeDomainResponse): any => ({ ...obj, }); @@ -5213,6 +5720,9 @@ export interface DescribeEdgePackagingJobRequest { } export namespace DescribeEdgePackagingJobRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeEdgePackagingJobRequest): any => ({ ...obj, }); @@ -5300,6 +5810,9 @@ export interface DescribeEdgePackagingJobResponse { } export namespace DescribeEdgePackagingJobResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeEdgePackagingJobResponse): any => ({ ...obj, }); @@ -5313,6 +5826,9 @@ export interface DescribeEndpointInput { } export namespace DescribeEndpointInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeEndpointInput): any => ({ ...obj, }); @@ -5371,6 +5887,9 @@ export interface ProductionVariantSummary { } export namespace ProductionVariantSummary { + /** + * @internal + */ export const filterSensitiveLog = (obj: ProductionVariantSummary): any => ({ ...obj, }); @@ -5479,6 +5998,9 @@ export interface DescribeEndpointOutput { } export namespace DescribeEndpointOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeEndpointOutput): any => ({ ...obj, }); @@ -5492,6 +6014,9 @@ export interface DescribeEndpointConfigInput { } export namespace DescribeEndpointConfigInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeEndpointConfigInput): any => ({ ...obj, }); @@ -5532,6 +6057,9 @@ export interface DescribeEndpointConfigOutput { } export namespace DescribeEndpointConfigOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeEndpointConfigOutput): any => ({ ...obj, }); @@ -5545,6 +6073,9 @@ export interface DescribeExperimentRequest { } export namespace DescribeExperimentRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeExperimentRequest): any => ({ ...obj, }); @@ -5566,6 +6097,9 @@ export interface ExperimentSource { } export namespace ExperimentSource { + /** + * @internal + */ export const filterSensitiveLog = (obj: ExperimentSource): any => ({ ...obj, }); @@ -5620,6 +6154,9 @@ export interface DescribeExperimentResponse { } export namespace DescribeExperimentResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeExperimentResponse): any => ({ ...obj, }); @@ -5640,6 +6177,9 @@ export interface DescribeFeatureGroupRequest { } export namespace DescribeFeatureGroupRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeFeatureGroupRequest): any => ({ ...obj, }); @@ -5675,6 +6215,9 @@ export interface OfflineStoreStatus { } export namespace OfflineStoreStatus { + /** + * @internal + */ export const filterSensitiveLog = (obj: OfflineStoreStatus): any => ({ ...obj, }); @@ -5778,6 +6321,9 @@ export interface DescribeFeatureGroupResponse { } export namespace DescribeFeatureGroupResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeFeatureGroupResponse): any => ({ ...obj, }); @@ -5791,6 +6337,9 @@ export interface DescribeFlowDefinitionRequest { } export namespace DescribeFlowDefinitionRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeFlowDefinitionRequest): any => ({ ...obj, }); @@ -5857,6 +6406,9 @@ export interface DescribeFlowDefinitionResponse { } export namespace DescribeFlowDefinitionResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeFlowDefinitionResponse): any => ({ ...obj, }); @@ -5871,6 +6423,9 @@ export interface DescribeHumanTaskUiRequest { } export namespace DescribeHumanTaskUiRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeHumanTaskUiRequest): any => ({ ...obj, }); @@ -5897,6 +6452,9 @@ export interface UiTemplateInfo { } export namespace UiTemplateInfo { + /** + * @internal + */ export const filterSensitiveLog = (obj: UiTemplateInfo): any => ({ ...obj, }); @@ -5930,6 +6488,9 @@ export interface DescribeHumanTaskUiResponse { } export namespace DescribeHumanTaskUiResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeHumanTaskUiResponse): any => ({ ...obj, }); @@ -5943,6 +6504,9 @@ export interface DescribeHyperParameterTuningJobRequest { } export namespace DescribeHyperParameterTuningJobRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeHyperParameterTuningJobRequest): any => ({ ...obj, }); @@ -5978,6 +6542,9 @@ export interface FinalHyperParameterTuningJobObjectiveMetric { } export namespace FinalHyperParameterTuningJobObjectiveMetric { + /** + * @internal + */ export const filterSensitiveLog = (obj: FinalHyperParameterTuningJobObjectiveMetric): any => ({ ...obj, }); @@ -6099,6 +6666,9 @@ export interface HyperParameterTrainingJobSummary { } export namespace HyperParameterTrainingJobSummary { + /** + * @internal + */ export const filterSensitiveLog = (obj: HyperParameterTrainingJobSummary): any => ({ ...obj, }); @@ -6142,6 +6712,9 @@ export interface ObjectiveStatusCounters { } export namespace ObjectiveStatusCounters { + /** + * @internal + */ export const filterSensitiveLog = (obj: ObjectiveStatusCounters): any => ({ ...obj, }); @@ -6185,6 +6758,9 @@ export interface TrainingJobStatusCounters { } export namespace TrainingJobStatusCounters { + /** + * @internal + */ export const filterSensitiveLog = (obj: TrainingJobStatusCounters): any => ({ ...obj, }); @@ -6284,6 +6860,9 @@ export interface DescribeHyperParameterTuningJobResponse { } export namespace DescribeHyperParameterTuningJobResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeHyperParameterTuningJobResponse): any => ({ ...obj, }); @@ -6297,6 +6876,9 @@ export interface DescribeImageRequest { } export namespace DescribeImageRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeImageRequest): any => ({ ...obj, }); @@ -6360,6 +6942,9 @@ export interface DescribeImageResponse { } export namespace DescribeImageResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeImageResponse): any => ({ ...obj, }); @@ -6378,6 +6963,9 @@ export interface DescribeImageVersionRequest { } export namespace DescribeImageVersionRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeImageVersionRequest): any => ({ ...obj, }); @@ -6439,6 +7027,9 @@ export interface DescribeImageVersionResponse { } export namespace DescribeImageVersionResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeImageVersionResponse): any => ({ ...obj, }); @@ -6452,6 +7043,9 @@ export interface DescribeLabelingJobRequest { } export namespace DescribeLabelingJobRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeLabelingJobRequest): any => ({ ...obj, }); @@ -6488,6 +7082,9 @@ export interface LabelCounters { } export namespace LabelCounters { + /** + * @internal + */ export const filterSensitiveLog = (obj: LabelCounters): any => ({ ...obj, }); @@ -6510,6 +7107,9 @@ export interface LabelingJobOutput { } export namespace LabelingJobOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: LabelingJobOutput): any => ({ ...obj, }); @@ -6683,6 +7283,9 @@ export interface DescribeLabelingJobResponse { } export namespace DescribeLabelingJobResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeLabelingJobResponse): any => ({ ...obj, }); @@ -6696,6 +7299,9 @@ export interface DescribeModelInput { } export namespace DescribeModelInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeModelInput): any => ({ ...obj, }); @@ -6756,6 +7362,9 @@ export interface DescribeModelOutput { } export namespace DescribeModelOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeModelOutput): any => ({ ...obj, }); @@ -6770,6 +7379,9 @@ export interface DescribeModelBiasJobDefinitionRequest { } export namespace DescribeModelBiasJobDefinitionRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeModelBiasJobDefinitionRequest): any => ({ ...obj, }); @@ -6836,6 +7448,9 @@ export interface DescribeModelBiasJobDefinitionResponse { } export namespace DescribeModelBiasJobDefinitionResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeModelBiasJobDefinitionResponse): any => ({ ...obj, }); @@ -6850,6 +7465,9 @@ export interface DescribeModelExplainabilityJobDefinitionRequest { } export namespace DescribeModelExplainabilityJobDefinitionRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeModelExplainabilityJobDefinitionRequest): any => ({ ...obj, }); @@ -6917,6 +7535,9 @@ export interface DescribeModelExplainabilityJobDefinitionResponse { } export namespace DescribeModelExplainabilityJobDefinitionResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeModelExplainabilityJobDefinitionResponse): any => ({ ...obj, }); @@ -6930,6 +7551,9 @@ export interface DescribeModelPackageInput { } export namespace DescribeModelPackageInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeModelPackageInput): any => ({ ...obj, }); @@ -6971,6 +7595,9 @@ export interface ModelPackageStatusItem { } export namespace ModelPackageStatusItem { + /** + * @internal + */ export const filterSensitiveLog = (obj: ModelPackageStatusItem): any => ({ ...obj, }); @@ -6992,6 +7619,9 @@ export interface ModelPackageStatusDetails { } export namespace ModelPackageStatusDetails { + /** + * @internal + */ export const filterSensitiveLog = (obj: ModelPackageStatusDetails): any => ({ ...obj, }); @@ -7100,6 +7730,9 @@ export interface DescribeModelPackageOutput { } export namespace DescribeModelPackageOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeModelPackageOutput): any => ({ ...obj, }); @@ -7113,6 +7746,9 @@ export interface DescribeModelPackageGroupInput { } export namespace DescribeModelPackageGroupInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeModelPackageGroupInput): any => ({ ...obj, }); @@ -7161,6 +7797,9 @@ export interface DescribeModelPackageGroupOutput { } export namespace DescribeModelPackageGroupOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeModelPackageGroupOutput): any => ({ ...obj, }); @@ -7175,6 +7814,9 @@ export interface DescribeModelQualityJobDefinitionRequest { } export namespace DescribeModelQualityJobDefinitionRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeModelQualityJobDefinitionRequest): any => ({ ...obj, }); @@ -7240,6 +7882,9 @@ export interface DescribeModelQualityJobDefinitionResponse { } export namespace DescribeModelQualityJobDefinitionResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeModelQualityJobDefinitionResponse): any => ({ ...obj, }); @@ -7253,6 +7898,9 @@ export interface DescribeMonitoringScheduleRequest { } export namespace DescribeMonitoringScheduleRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeMonitoringScheduleRequest): any => ({ ...obj, }); @@ -7324,6 +7972,9 @@ export interface MonitoringExecutionSummary { } export namespace MonitoringExecutionSummary { + /** + * @internal + */ export const filterSensitiveLog = (obj: MonitoringExecutionSummary): any => ({ ...obj, }); @@ -7413,6 +8064,9 @@ export interface DescribeMonitoringScheduleResponse { } export namespace DescribeMonitoringScheduleResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeMonitoringScheduleResponse): any => ({ ...obj, }); @@ -7426,6 +8080,9 @@ export interface DescribeNotebookInstanceInput { } export namespace DescribeNotebookInstanceInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeNotebookInstanceInput): any => ({ ...obj, }); @@ -7575,6 +8232,9 @@ export interface DescribeNotebookInstanceOutput { } export namespace DescribeNotebookInstanceOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeNotebookInstanceOutput): any => ({ ...obj, }); @@ -7588,6 +8248,9 @@ export interface DescribeNotebookInstanceLifecycleConfigInput { } export namespace DescribeNotebookInstanceLifecycleConfigInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeNotebookInstanceLifecycleConfigInput): any => ({ ...obj, }); @@ -7627,6 +8290,9 @@ export interface DescribeNotebookInstanceLifecycleConfigOutput { } export namespace DescribeNotebookInstanceLifecycleConfigOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeNotebookInstanceLifecycleConfigOutput): any => ({ ...obj, }); @@ -7640,6 +8306,9 @@ export interface DescribePipelineRequest { } export namespace DescribePipelineRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribePipelineRequest): any => ({ ...obj, }); @@ -7714,6 +8383,9 @@ export interface DescribePipelineResponse { } export namespace DescribePipelineResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribePipelineResponse): any => ({ ...obj, }); @@ -7727,6 +8399,9 @@ export interface DescribePipelineDefinitionForExecutionRequest { } export namespace DescribePipelineDefinitionForExecutionRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribePipelineDefinitionForExecutionRequest): any => ({ ...obj, }); @@ -7745,6 +8420,9 @@ export interface DescribePipelineDefinitionForExecutionResponse { } export namespace DescribePipelineDefinitionForExecutionResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribePipelineDefinitionForExecutionResponse): any => ({ ...obj, }); @@ -7758,6 +8436,9 @@ export interface DescribePipelineExecutionRequest { } export namespace DescribePipelineExecutionRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribePipelineExecutionRequest): any => ({ ...obj, }); @@ -7821,6 +8502,9 @@ export interface DescribePipelineExecutionResponse { } export namespace DescribePipelineExecutionResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribePipelineExecutionResponse): any => ({ ...obj, }); @@ -7835,6 +8519,9 @@ export interface DescribeProcessingJobRequest { } export namespace DescribeProcessingJobRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeProcessingJobRequest): any => ({ ...obj, }); @@ -7962,6 +8649,9 @@ export interface DescribeProcessingJobResponse { } export namespace DescribeProcessingJobResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeProcessingJobResponse): any => ({ ...obj, }); @@ -7975,6 +8665,9 @@ export interface DescribeProjectInput { } export namespace DescribeProjectInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeProjectInput): any => ({ ...obj, }); @@ -8030,6 +8723,9 @@ export interface ServiceCatalogProvisionedProductDetails { } export namespace ServiceCatalogProvisionedProductDetails { + /** + * @internal + */ export const filterSensitiveLog = (obj: ServiceCatalogProvisionedProductDetails): any => ({ ...obj, }); @@ -8085,6 +8781,9 @@ export interface DescribeProjectOutput { } export namespace DescribeProjectOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeProjectOutput): any => ({ ...obj, }); @@ -8098,6 +8797,9 @@ export interface DescribeSubscribedWorkteamRequest { } export namespace DescribeSubscribedWorkteamRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeSubscribedWorkteamRequest): any => ({ ...obj, }); @@ -8134,6 +8836,9 @@ export interface SubscribedWorkteam { } export namespace SubscribedWorkteam { + /** + * @internal + */ export const filterSensitiveLog = (obj: SubscribedWorkteam): any => ({ ...obj, }); @@ -8147,6 +8852,9 @@ export interface DescribeSubscribedWorkteamResponse { } export namespace DescribeSubscribedWorkteamResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeSubscribedWorkteamResponse): any => ({ ...obj, }); @@ -8160,6 +8868,9 @@ export interface DescribeTrainingJobRequest { } export namespace DescribeTrainingJobRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeTrainingJobRequest): any => ({ ...obj, }); @@ -8186,6 +8897,9 @@ export interface MetricData { } export namespace MetricData { + /** + * @internal + */ export const filterSensitiveLog = (obj: MetricData): any => ({ ...obj, }); @@ -8222,6 +8936,9 @@ export interface ProfilerRuleEvaluationStatus { } export namespace ProfilerRuleEvaluationStatus { + /** + * @internal + */ export const filterSensitiveLog = (obj: ProfilerRuleEvaluationStatus): any => ({ ...obj, }); @@ -8441,6 +9158,9 @@ export interface SecondaryStatusTransition { } export namespace SecondaryStatusTransition { + /** + * @internal + */ export const filterSensitiveLog = (obj: SecondaryStatusTransition): any => ({ ...obj, }); @@ -8845,6 +9565,9 @@ export interface DescribeTrainingJobResponse { } export namespace DescribeTrainingJobResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeTrainingJobResponse): any => ({ ...obj, }); @@ -8858,6 +9581,9 @@ export interface DescribeTransformJobRequest { } export namespace DescribeTransformJobRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeTransformJobRequest): any => ({ ...obj, }); @@ -9035,6 +9761,9 @@ export interface DescribeTransformJobResponse { } export namespace DescribeTransformJobResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeTransformJobResponse): any => ({ ...obj, }); @@ -9048,6 +9777,9 @@ export interface DescribeTrialRequest { } export namespace DescribeTrialRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeTrialRequest): any => ({ ...obj, }); @@ -9069,6 +9801,9 @@ export interface TrialSource { } export namespace TrialSource { + /** + * @internal + */ export const filterSensitiveLog = (obj: TrialSource): any => ({ ...obj, }); @@ -9128,6 +9863,9 @@ export interface DescribeTrialResponse { } export namespace DescribeTrialResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeTrialResponse): any => ({ ...obj, }); @@ -9141,6 +9879,9 @@ export interface DescribeTrialComponentRequest { } export namespace DescribeTrialComponentRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeTrialComponentRequest): any => ({ ...obj, }); @@ -9197,6 +9938,9 @@ export interface TrialComponentMetricSummary { } export namespace TrialComponentMetricSummary { + /** + * @internal + */ export const filterSensitiveLog = (obj: TrialComponentMetricSummary): any => ({ ...obj, }); @@ -9218,6 +9962,9 @@ export interface TrialComponentSource { } export namespace TrialComponentSource { + /** + * @internal + */ export const filterSensitiveLog = (obj: TrialComponentSource): any => ({ ...obj, }); @@ -9318,6 +10065,9 @@ export interface DescribeTrialComponentResponse { } export namespace DescribeTrialComponentResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeTrialComponentResponse): any => ({ ...obj, ...(obj.Parameters && { @@ -9345,6 +10095,9 @@ export interface DescribeUserProfileRequest { } export namespace DescribeUserProfileRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeUserProfileRequest): any => ({ ...obj, }); @@ -9418,6 +10171,9 @@ export interface DescribeUserProfileResponse { } export namespace DescribeUserProfileResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeUserProfileResponse): any => ({ ...obj, }); @@ -9433,6 +10189,9 @@ export interface DescribeWorkforceRequest { } export namespace DescribeWorkforceRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeWorkforceRequest): any => ({ ...obj, }); @@ -9479,6 +10238,9 @@ export interface OidcConfigForResponse { } export namespace OidcConfigForResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: OidcConfigForResponse): any => ({ ...obj, }); @@ -9539,6 +10301,9 @@ export interface Workforce { } export namespace Workforce { + /** + * @internal + */ export const filterSensitiveLog = (obj: Workforce): any => ({ ...obj, }); @@ -9555,6 +10320,9 @@ export interface DescribeWorkforceResponse { } export namespace DescribeWorkforceResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeWorkforceResponse): any => ({ ...obj, }); @@ -9568,6 +10336,9 @@ export interface DescribeWorkteamRequest { } export namespace DescribeWorkteamRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeWorkteamRequest): any => ({ ...obj, }); @@ -9636,6 +10407,9 @@ export interface Workteam { } export namespace Workteam { + /** + * @internal + */ export const filterSensitiveLog = (obj: Workteam): any => ({ ...obj, }); diff --git a/clients/client-sagemaker/models/models_2.ts b/clients/client-sagemaker/models/models_2.ts index f284ad973d9a..e0b85b42e051 100644 --- a/clients/client-sagemaker/models/models_2.ts +++ b/clients/client-sagemaker/models/models_2.ts @@ -135,6 +135,9 @@ export interface DescribeWorkteamResponse { } export namespace DescribeWorkteamResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeWorkteamResponse): any => ({ ...obj, }); @@ -163,6 +166,9 @@ export interface DesiredWeightAndCapacity { } export namespace DesiredWeightAndCapacity { + /** + * @internal + */ export const filterSensitiveLog = (obj: DesiredWeightAndCapacity): any => ({ ...obj, }); @@ -189,6 +195,9 @@ export interface Device { } export namespace Device { + /** + * @internal + */ export const filterSensitiveLog = (obj: Device): any => ({ ...obj, }); @@ -220,6 +229,9 @@ export interface DeviceFleetSummary { } export namespace DeviceFleetSummary { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeviceFleetSummary): any => ({ ...obj, }); @@ -241,6 +253,9 @@ export interface DeviceStats { } export namespace DeviceStats { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeviceStats): any => ({ ...obj, }); @@ -262,6 +277,9 @@ export interface EdgeModelSummary { } export namespace EdgeModelSummary { + /** + * @internal + */ export const filterSensitiveLog = (obj: EdgeModelSummary): any => ({ ...obj, }); @@ -313,6 +331,9 @@ export interface DeviceSummary { } export namespace DeviceSummary { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeviceSummary): any => ({ ...obj, }); @@ -321,6 +342,9 @@ export namespace DeviceSummary { export interface DisableSagemakerServicecatalogPortfolioInput {} export namespace DisableSagemakerServicecatalogPortfolioInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: DisableSagemakerServicecatalogPortfolioInput): any => ({ ...obj, }); @@ -329,6 +353,9 @@ export namespace DisableSagemakerServicecatalogPortfolioInput { export interface DisableSagemakerServicecatalogPortfolioOutput {} export namespace DisableSagemakerServicecatalogPortfolioOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: DisableSagemakerServicecatalogPortfolioOutput): any => ({ ...obj, }); @@ -347,6 +374,9 @@ export interface DisassociateTrialComponentRequest { } export namespace DisassociateTrialComponentRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DisassociateTrialComponentRequest): any => ({ ...obj, }); @@ -365,6 +395,9 @@ export interface DisassociateTrialComponentResponse { } export namespace DisassociateTrialComponentResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DisassociateTrialComponentResponse): any => ({ ...obj, }); @@ -411,6 +444,9 @@ export interface DomainDetails { } export namespace DomainDetails { + /** + * @internal + */ export const filterSensitiveLog = (obj: DomainDetails): any => ({ ...obj, }); @@ -452,6 +488,9 @@ export interface EdgeModelStat { } export namespace EdgeModelStat { + /** + * @internal + */ export const filterSensitiveLog = (obj: EdgeModelStat): any => ({ ...obj, }); @@ -503,6 +542,9 @@ export interface EdgePackagingJobSummary { } export namespace EdgePackagingJobSummary { + /** + * @internal + */ export const filterSensitiveLog = (obj: EdgePackagingJobSummary): any => ({ ...obj, }); @@ -511,6 +553,9 @@ export namespace EdgePackagingJobSummary { export interface EnableSagemakerServicecatalogPortfolioInput {} export namespace EnableSagemakerServicecatalogPortfolioInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: EnableSagemakerServicecatalogPortfolioInput): any => ({ ...obj, }); @@ -519,6 +564,9 @@ export namespace EnableSagemakerServicecatalogPortfolioInput { export interface EnableSagemakerServicecatalogPortfolioOutput {} export namespace EnableSagemakerServicecatalogPortfolioOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: EnableSagemakerServicecatalogPortfolioOutput): any => ({ ...obj, }); @@ -606,6 +654,9 @@ export interface MonitoringSchedule { } export namespace MonitoringSchedule { + /** + * @internal + */ export const filterSensitiveLog = (obj: MonitoringSchedule): any => ({ ...obj, }); @@ -675,6 +726,9 @@ export interface Endpoint { } export namespace Endpoint { + /** + * @internal + */ export const filterSensitiveLog = (obj: Endpoint): any => ({ ...obj, }); @@ -706,6 +760,9 @@ export interface EndpointConfigSummary { } export namespace EndpointConfigSummary { + /** + * @internal + */ export const filterSensitiveLog = (obj: EndpointConfigSummary): any => ({ ...obj, }); @@ -797,6 +854,9 @@ export interface EndpointSummary { } export namespace EndpointSummary { + /** + * @internal + */ export const filterSensitiveLog = (obj: EndpointSummary): any => ({ ...obj, }); @@ -861,6 +921,9 @@ export interface Experiment { } export namespace Experiment { + /** + * @internal + */ export const filterSensitiveLog = (obj: Experiment): any => ({ ...obj, }); @@ -905,6 +968,9 @@ export interface ExperimentSummary { } export namespace ExperimentSummary { + /** + * @internal + */ export const filterSensitiveLog = (obj: ExperimentSummary): any => ({ ...obj, }); @@ -1016,6 +1082,9 @@ export interface FeatureGroup { } export namespace FeatureGroup { + /** + * @internal + */ export const filterSensitiveLog = (obj: FeatureGroup): any => ({ ...obj, }); @@ -1069,6 +1138,9 @@ export interface FeatureGroupSummary { } export namespace FeatureGroupSummary { + /** + * @internal + */ export const filterSensitiveLog = (obj: FeatureGroupSummary): any => ({ ...obj, }); @@ -1289,6 +1361,9 @@ export interface Filter { } export namespace Filter { + /** + * @internal + */ export const filterSensitiveLog = (obj: Filter): any => ({ ...obj, }); @@ -1325,6 +1400,9 @@ export interface FlowDefinitionSummary { } export namespace FlowDefinitionSummary { + /** + * @internal + */ export const filterSensitiveLog = (obj: FlowDefinitionSummary): any => ({ ...obj, }); @@ -1338,6 +1416,9 @@ export interface GetDeviceFleetReportRequest { } export namespace GetDeviceFleetReportRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetDeviceFleetReportRequest): any => ({ ...obj, }); @@ -1386,6 +1467,9 @@ export interface GetDeviceFleetReportResponse { } export namespace GetDeviceFleetReportResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetDeviceFleetReportResponse): any => ({ ...obj, }); @@ -1399,6 +1483,9 @@ export interface GetModelPackageGroupPolicyInput { } export namespace GetModelPackageGroupPolicyInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetModelPackageGroupPolicyInput): any => ({ ...obj, }); @@ -1412,6 +1499,9 @@ export interface GetModelPackageGroupPolicyOutput { } export namespace GetModelPackageGroupPolicyOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetModelPackageGroupPolicyOutput): any => ({ ...obj, }); @@ -1420,6 +1510,9 @@ export namespace GetModelPackageGroupPolicyOutput { export interface GetSagemakerServicecatalogPortfolioStatusInput {} export namespace GetSagemakerServicecatalogPortfolioStatusInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetSagemakerServicecatalogPortfolioStatusInput): any => ({ ...obj, }); @@ -1438,6 +1531,9 @@ export interface GetSagemakerServicecatalogPortfolioStatusOutput { } export namespace GetSagemakerServicecatalogPortfolioStatusOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetSagemakerServicecatalogPortfolioStatusOutput): any => ({ ...obj, }); @@ -1468,6 +1564,9 @@ export interface PropertyNameQuery { } export namespace PropertyNameQuery { + /** + * @internal + */ export const filterSensitiveLog = (obj: PropertyNameQuery): any => ({ ...obj, }); @@ -1486,6 +1585,9 @@ export interface SuggestionQuery { } export namespace SuggestionQuery { + /** + * @internal + */ export const filterSensitiveLog = (obj: SuggestionQuery): any => ({ ...obj, }); @@ -1504,6 +1606,9 @@ export interface GetSearchSuggestionsRequest { } export namespace GetSearchSuggestionsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetSearchSuggestionsRequest): any => ({ ...obj, }); @@ -1522,6 +1627,9 @@ export interface PropertyNameSuggestion { } export namespace PropertyNameSuggestion { + /** + * @internal + */ export const filterSensitiveLog = (obj: PropertyNameSuggestion): any => ({ ...obj, }); @@ -1536,6 +1644,9 @@ export interface GetSearchSuggestionsResponse { } export namespace GetSearchSuggestionsResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetSearchSuggestionsResponse): any => ({ ...obj, }); @@ -1559,6 +1670,9 @@ export interface GitConfigForUpdate { } export namespace GitConfigForUpdate { + /** + * @internal + */ export const filterSensitiveLog = (obj: GitConfigForUpdate): any => ({ ...obj, }); @@ -1585,6 +1699,9 @@ export interface HumanTaskUiSummary { } export namespace HumanTaskUiSummary { + /** + * @internal + */ export const filterSensitiveLog = (obj: HumanTaskUiSummary): any => ({ ...obj, }); @@ -1665,6 +1782,9 @@ export interface HyperParameterTuningJobSummary { } export namespace HyperParameterTuningJobSummary { + /** + * @internal + */ export const filterSensitiveLog = (obj: HyperParameterTuningJobSummary): any => ({ ...obj, }); @@ -1718,6 +1838,9 @@ export interface Image { } export namespace Image { + /** + * @internal + */ export const filterSensitiveLog = (obj: Image): any => ({ ...obj, }); @@ -1776,6 +1899,9 @@ export interface ImageVersion { } export namespace ImageVersion { + /** + * @internal + */ export const filterSensitiveLog = (obj: ImageVersion): any => ({ ...obj, }); @@ -1813,6 +1939,9 @@ export interface LabelCountersForWorkteam { } export namespace LabelCountersForWorkteam { + /** + * @internal + */ export const filterSensitiveLog = (obj: LabelCountersForWorkteam): any => ({ ...obj, }); @@ -1855,6 +1984,9 @@ export interface LabelingJobForWorkteamSummary { } export namespace LabelingJobForWorkteamSummary { + /** + * @internal + */ export const filterSensitiveLog = (obj: LabelingJobForWorkteamSummary): any => ({ ...obj, }); @@ -1932,6 +2064,9 @@ export interface LabelingJobSummary { } export namespace LabelingJobSummary { + /** + * @internal + */ export const filterSensitiveLog = (obj: LabelingJobSummary): any => ({ ...obj, }); @@ -1991,6 +2126,9 @@ export interface ListActionsRequest { } export namespace ListActionsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListActionsRequest): any => ({ ...obj, }); @@ -2009,6 +2147,9 @@ export interface ListActionsResponse { } export namespace ListActionsResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListActionsResponse): any => ({ ...obj, }); @@ -2058,6 +2199,9 @@ export interface ListAlgorithmsInput { } export namespace ListAlgorithmsInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListAlgorithmsInput): any => ({ ...obj, }); @@ -2078,6 +2222,9 @@ export interface ListAlgorithmsOutput { } export namespace ListAlgorithmsOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListAlgorithmsOutput): any => ({ ...obj, }); @@ -2133,6 +2280,9 @@ export interface ListAppImageConfigsRequest { } export namespace ListAppImageConfigsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListAppImageConfigsRequest): any => ({ ...obj, }); @@ -2151,6 +2301,9 @@ export interface ListAppImageConfigsResponse { } export namespace ListAppImageConfigsResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListAppImageConfigsResponse): any => ({ ...obj, }); @@ -2190,6 +2343,9 @@ export interface ListAppsRequest { } export namespace ListAppsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListAppsRequest): any => ({ ...obj, }); @@ -2209,6 +2365,9 @@ export interface ListAppsResponse { } export namespace ListAppsResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListAppsResponse): any => ({ ...obj, }); @@ -2262,6 +2421,9 @@ export interface ListArtifactsRequest { } export namespace ListArtifactsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListArtifactsRequest): any => ({ ...obj, }); @@ -2280,6 +2442,9 @@ export interface ListArtifactsResponse { } export namespace ListArtifactsResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListArtifactsResponse): any => ({ ...obj, }); @@ -2352,6 +2517,9 @@ export interface ListAssociationsRequest { } export namespace ListAssociationsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListAssociationsRequest): any => ({ ...obj, }); @@ -2370,6 +2538,9 @@ export interface ListAssociationsResponse { } export namespace ListAssociationsResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListAssociationsResponse): any => ({ ...obj, }); @@ -2429,6 +2600,9 @@ export interface ListAutoMLJobsRequest { } export namespace ListAutoMLJobsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListAutoMLJobsRequest): any => ({ ...obj, }); @@ -2448,6 +2622,9 @@ export interface ListAutoMLJobsResponse { } export namespace ListAutoMLJobsResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListAutoMLJobsResponse): any => ({ ...obj, }); @@ -2493,6 +2670,9 @@ export interface ListCandidatesForAutoMLJobRequest { } export namespace ListCandidatesForAutoMLJobRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListCandidatesForAutoMLJobRequest): any => ({ ...obj, }); @@ -2512,6 +2692,9 @@ export interface ListCandidatesForAutoMLJobResponse { } export namespace ListCandidatesForAutoMLJobResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListCandidatesForAutoMLJobResponse): any => ({ ...obj, }); @@ -2572,6 +2755,9 @@ export interface ListCodeRepositoriesInput { } export namespace ListCodeRepositoriesInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListCodeRepositoriesInput): any => ({ ...obj, }); @@ -2612,6 +2798,9 @@ export interface ListCodeRepositoriesOutput { } export namespace ListCodeRepositoriesOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListCodeRepositoriesOutput): any => ({ ...obj, }); @@ -2683,6 +2872,9 @@ export interface ListCompilationJobsRequest { } export namespace ListCompilationJobsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListCompilationJobsRequest): any => ({ ...obj, }); @@ -2703,6 +2895,9 @@ export interface ListCompilationJobsResponse { } export namespace ListCompilationJobsResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListCompilationJobsResponse): any => ({ ...obj, }); @@ -2757,6 +2952,9 @@ export interface ListContextsRequest { } export namespace ListContextsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListContextsRequest): any => ({ ...obj, }); @@ -2775,6 +2973,9 @@ export interface ListContextsResponse { } export namespace ListContextsResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListContextsResponse): any => ({ ...obj, }); @@ -2835,6 +3036,9 @@ export interface ListDataQualityJobDefinitionsRequest { } export namespace ListDataQualityJobDefinitionsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListDataQualityJobDefinitionsRequest): any => ({ ...obj, }); @@ -2866,6 +3070,9 @@ export interface MonitoringJobDefinitionSummary { } export namespace MonitoringJobDefinitionSummary { + /** + * @internal + */ export const filterSensitiveLog = (obj: MonitoringJobDefinitionSummary): any => ({ ...obj, }); @@ -2886,6 +3093,9 @@ export interface ListDataQualityJobDefinitionsResponse { } export namespace ListDataQualityJobDefinitionsResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListDataQualityJobDefinitionsResponse): any => ({ ...obj, }); @@ -2945,6 +3155,9 @@ export interface ListDeviceFleetsRequest { } export namespace ListDeviceFleetsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListDeviceFleetsRequest): any => ({ ...obj, }); @@ -2963,6 +3176,9 @@ export interface ListDeviceFleetsResponse { } export namespace ListDeviceFleetsResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListDeviceFleetsResponse): any => ({ ...obj, }); @@ -2996,6 +3212,9 @@ export interface ListDevicesRequest { } export namespace ListDevicesRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListDevicesRequest): any => ({ ...obj, }); @@ -3014,6 +3233,9 @@ export interface ListDevicesResponse { } export namespace ListDevicesResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListDevicesResponse): any => ({ ...obj, }); @@ -3033,6 +3255,9 @@ export interface ListDomainsRequest { } export namespace ListDomainsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListDomainsRequest): any => ({ ...obj, }); @@ -3052,6 +3277,9 @@ export interface ListDomainsResponse { } export namespace ListDomainsResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListDomainsResponse): any => ({ ...obj, }); @@ -3123,6 +3351,9 @@ export interface ListEdgePackagingJobsRequest { } export namespace ListEdgePackagingJobsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListEdgePackagingJobsRequest): any => ({ ...obj, }); @@ -3141,6 +3372,9 @@ export interface ListEdgePackagingJobsResponse { } export namespace ListEdgePackagingJobsResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListEdgePackagingJobsResponse): any => ({ ...obj, }); @@ -3194,6 +3428,9 @@ export interface ListEndpointConfigsInput { } export namespace ListEndpointConfigsInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListEndpointConfigsInput): any => ({ ...obj, }); @@ -3213,6 +3450,9 @@ export interface ListEndpointConfigsOutput { } export namespace ListEndpointConfigsOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListEndpointConfigsOutput): any => ({ ...obj, }); @@ -3278,6 +3518,9 @@ export interface ListEndpointsInput { } export namespace ListEndpointsInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListEndpointsInput): any => ({ ...obj, }); @@ -3297,6 +3540,9 @@ export interface ListEndpointsOutput { } export namespace ListEndpointsOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListEndpointsOutput): any => ({ ...obj, }); @@ -3342,6 +3588,9 @@ export interface ListExperimentsRequest { } export namespace ListExperimentsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListExperimentsRequest): any => ({ ...obj, }); @@ -3360,6 +3609,9 @@ export interface ListExperimentsResponse { } export namespace ListExperimentsResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListExperimentsResponse): any => ({ ...obj, }); @@ -3416,6 +3668,9 @@ export interface ListFeatureGroupsRequest { } export namespace ListFeatureGroupsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListFeatureGroupsRequest): any => ({ ...obj, }); @@ -3434,6 +3689,9 @@ export interface ListFeatureGroupsResponse { } export namespace ListFeatureGroupsResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListFeatureGroupsResponse): any => ({ ...obj, }); @@ -3467,6 +3725,9 @@ export interface ListFlowDefinitionsRequest { } export namespace ListFlowDefinitionsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListFlowDefinitionsRequest): any => ({ ...obj, }); @@ -3485,6 +3746,9 @@ export interface ListFlowDefinitionsResponse { } export namespace ListFlowDefinitionsResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListFlowDefinitionsResponse): any => ({ ...obj, }); @@ -3518,6 +3782,9 @@ export interface ListHumanTaskUisRequest { } export namespace ListHumanTaskUisRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListHumanTaskUisRequest): any => ({ ...obj, }); @@ -3536,6 +3803,9 @@ export interface ListHumanTaskUisResponse { } export namespace ListHumanTaskUisResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListHumanTaskUisResponse): any => ({ ...obj, }); @@ -3611,6 +3881,9 @@ export interface ListHyperParameterTuningJobsRequest { } export namespace ListHyperParameterTuningJobsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListHyperParameterTuningJobsRequest): any => ({ ...obj, }); @@ -3634,6 +3907,9 @@ export interface ListHyperParameterTuningJobsResponse { } export namespace ListHyperParameterTuningJobsResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListHyperParameterTuningJobsResponse): any => ({ ...obj, }); @@ -3688,6 +3964,9 @@ export interface ListImagesRequest { } export namespace ListImagesRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListImagesRequest): any => ({ ...obj, }); @@ -3706,6 +3985,9 @@ export interface ListImagesResponse { } export namespace ListImagesResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListImagesResponse): any => ({ ...obj, }); @@ -3760,6 +4042,9 @@ export interface ListImageVersionsRequest { } export namespace ListImageVersionsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListImageVersionsRequest): any => ({ ...obj, }); @@ -3778,6 +4063,9 @@ export interface ListImageVersionsResponse { } export namespace ListImageVersionsResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListImageVersionsResponse): any => ({ ...obj, }); @@ -3849,6 +4137,9 @@ export interface ListLabelingJobsRequest { } export namespace ListLabelingJobsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListLabelingJobsRequest): any => ({ ...obj, }); @@ -3869,6 +4160,9 @@ export interface ListLabelingJobsResponse { } export namespace ListLabelingJobsResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListLabelingJobsResponse): any => ({ ...obj, }); @@ -3927,6 +4221,9 @@ export interface ListLabelingJobsForWorkteamRequest { } export namespace ListLabelingJobsForWorkteamRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListLabelingJobsForWorkteamRequest): any => ({ ...obj, }); @@ -3947,6 +4244,9 @@ export interface ListLabelingJobsForWorkteamResponse { } export namespace ListLabelingJobsForWorkteamResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListLabelingJobsForWorkteamResponse): any => ({ ...obj, }); @@ -3999,6 +4299,9 @@ export interface ListModelBiasJobDefinitionsRequest { } export namespace ListModelBiasJobDefinitionsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListModelBiasJobDefinitionsRequest): any => ({ ...obj, }); @@ -4018,6 +4321,9 @@ export interface ListModelBiasJobDefinitionsResponse { } export namespace ListModelBiasJobDefinitionsResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListModelBiasJobDefinitionsResponse): any => ({ ...obj, }); @@ -4071,6 +4377,9 @@ export interface ListModelExplainabilityJobDefinitionsRequest { } export namespace ListModelExplainabilityJobDefinitionsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListModelExplainabilityJobDefinitionsRequest): any => ({ ...obj, }); @@ -4090,6 +4399,9 @@ export interface ListModelExplainabilityJobDefinitionsResponse { } export namespace ListModelExplainabilityJobDefinitionsResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListModelExplainabilityJobDefinitionsResponse): any => ({ ...obj, }); @@ -4141,6 +4453,9 @@ export interface ListModelPackageGroupsInput { } export namespace ListModelPackageGroupsInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListModelPackageGroupsInput): any => ({ ...obj, }); @@ -4177,6 +4492,9 @@ export interface ModelPackageGroupSummary { } export namespace ModelPackageGroupSummary { + /** + * @internal + */ export const filterSensitiveLog = (obj: ModelPackageGroupSummary): any => ({ ...obj, }); @@ -4196,6 +4514,9 @@ export interface ListModelPackageGroupsOutput { } export namespace ListModelPackageGroupsOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListModelPackageGroupsOutput): any => ({ ...obj, }); @@ -4287,6 +4608,9 @@ export interface ListModelPackagesInput { } export namespace ListModelPackagesInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListModelPackagesInput): any => ({ ...obj, }); @@ -4354,6 +4678,9 @@ export interface ModelPackageSummary { } export namespace ModelPackageSummary { + /** + * @internal + */ export const filterSensitiveLog = (obj: ModelPackageSummary): any => ({ ...obj, }); @@ -4374,6 +4701,9 @@ export interface ListModelPackagesOutput { } export namespace ListModelPackagesOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListModelPackagesOutput): any => ({ ...obj, }); @@ -4429,6 +4759,9 @@ export interface ListModelQualityJobDefinitionsRequest { } export namespace ListModelQualityJobDefinitionsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListModelQualityJobDefinitionsRequest): any => ({ ...obj, }); @@ -4448,6 +4781,9 @@ export interface ListModelQualityJobDefinitionsResponse { } export namespace ListModelQualityJobDefinitionsResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListModelQualityJobDefinitionsResponse): any => ({ ...obj, }); @@ -4501,6 +4837,9 @@ export interface ListModelsInput { } export namespace ListModelsInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListModelsInput): any => ({ ...obj, }); @@ -4527,6 +4866,9 @@ export interface ModelSummary { } export namespace ModelSummary { + /** + * @internal + */ export const filterSensitiveLog = (obj: ModelSummary): any => ({ ...obj, }); @@ -4547,6 +4889,9 @@ export interface ListModelsOutput { } export namespace ListModelsOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListModelsOutput): any => ({ ...obj, }); @@ -4641,6 +4986,9 @@ export interface ListMonitoringExecutionsRequest { } export namespace ListMonitoringExecutionsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListMonitoringExecutionsRequest): any => ({ ...obj, }); @@ -4660,6 +5008,9 @@ export interface ListMonitoringExecutionsResponse { } export namespace ListMonitoringExecutionsResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListMonitoringExecutionsResponse): any => ({ ...obj, }); @@ -4744,6 +5095,9 @@ export interface ListMonitoringSchedulesRequest { } export namespace ListMonitoringSchedulesRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListMonitoringSchedulesRequest): any => ({ ...obj, }); @@ -4795,6 +5149,9 @@ export interface MonitoringScheduleSummary { } export namespace MonitoringScheduleSummary { + /** + * @internal + */ export const filterSensitiveLog = (obj: MonitoringScheduleSummary): any => ({ ...obj, }); @@ -4814,6 +5171,9 @@ export interface ListMonitoringSchedulesResponse { } export namespace ListMonitoringSchedulesResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListMonitoringSchedulesResponse): any => ({ ...obj, }); @@ -4885,6 +5245,9 @@ export interface ListNotebookInstanceLifecycleConfigsInput { } export namespace ListNotebookInstanceLifecycleConfigsInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListNotebookInstanceLifecycleConfigsInput): any => ({ ...obj, }); @@ -4916,6 +5279,9 @@ export interface NotebookInstanceLifecycleConfigSummary { } export namespace NotebookInstanceLifecycleConfigSummary { + /** + * @internal + */ export const filterSensitiveLog = (obj: NotebookInstanceLifecycleConfigSummary): any => ({ ...obj, }); @@ -4936,6 +5302,9 @@ export interface ListNotebookInstanceLifecycleConfigsOutput { } export namespace ListNotebookInstanceLifecycleConfigsOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListNotebookInstanceLifecycleConfigsOutput): any => ({ ...obj, }); @@ -5038,6 +5407,9 @@ export interface ListNotebookInstancesInput { } export namespace ListNotebookInstancesInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListNotebookInstancesInput): any => ({ ...obj, }); @@ -5114,6 +5486,9 @@ export interface NotebookInstanceSummary { } export namespace NotebookInstanceSummary { + /** + * @internal + */ export const filterSensitiveLog = (obj: NotebookInstanceSummary): any => ({ ...obj, }); @@ -5135,6 +5510,9 @@ export interface ListNotebookInstancesOutput { } export namespace ListNotebookInstancesOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListNotebookInstancesOutput): any => ({ ...obj, }); @@ -5186,6 +5564,9 @@ export interface ListPipelineExecutionsRequest { } export namespace ListPipelineExecutionsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListPipelineExecutionsRequest): any => ({ ...obj, }); @@ -5222,6 +5603,9 @@ export interface PipelineExecutionSummary { } export namespace PipelineExecutionSummary { + /** + * @internal + */ export const filterSensitiveLog = (obj: PipelineExecutionSummary): any => ({ ...obj, }); @@ -5243,6 +5627,9 @@ export interface ListPipelineExecutionsResponse { } export namespace ListPipelineExecutionsResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListPipelineExecutionsResponse): any => ({ ...obj, }); @@ -5272,6 +5659,9 @@ export interface ListPipelineExecutionStepsRequest { } export namespace ListPipelineExecutionStepsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListPipelineExecutionStepsRequest): any => ({ ...obj, }); @@ -5288,6 +5678,9 @@ export interface ModelStepMetadata { } export namespace ModelStepMetadata { + /** + * @internal + */ export const filterSensitiveLog = (obj: ModelStepMetadata): any => ({ ...obj, }); @@ -5304,6 +5697,9 @@ export interface ProcessingJobStepMetadata { } export namespace ProcessingJobStepMetadata { + /** + * @internal + */ export const filterSensitiveLog = (obj: ProcessingJobStepMetadata): any => ({ ...obj, }); @@ -5320,6 +5716,9 @@ export interface RegisterModelStepMetadata { } export namespace RegisterModelStepMetadata { + /** + * @internal + */ export const filterSensitiveLog = (obj: RegisterModelStepMetadata): any => ({ ...obj, }); @@ -5336,6 +5735,9 @@ export interface TrainingJobStepMetadata { } export namespace TrainingJobStepMetadata { + /** + * @internal + */ export const filterSensitiveLog = (obj: TrainingJobStepMetadata): any => ({ ...obj, }); @@ -5352,6 +5754,9 @@ export interface TransformJobStepMetadata { } export namespace TransformJobStepMetadata { + /** + * @internal + */ export const filterSensitiveLog = (obj: TransformJobStepMetadata): any => ({ ...obj, }); @@ -5393,6 +5798,9 @@ export interface PipelineExecutionStepMetadata { } export namespace PipelineExecutionStepMetadata { + /** + * @internal + */ export const filterSensitiveLog = (obj: PipelineExecutionStepMetadata): any => ({ ...obj, }); @@ -5448,6 +5856,9 @@ export interface PipelineExecutionStep { } export namespace PipelineExecutionStep { + /** + * @internal + */ export const filterSensitiveLog = (obj: PipelineExecutionStep): any => ({ ...obj, }); @@ -5470,6 +5881,9 @@ export interface ListPipelineExecutionStepsResponse { } export namespace ListPipelineExecutionStepsResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListPipelineExecutionStepsResponse): any => ({ ...obj, }); @@ -5494,6 +5908,9 @@ export interface ListPipelineParametersForExecutionRequest { } export namespace ListPipelineParametersForExecutionRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListPipelineParametersForExecutionRequest): any => ({ ...obj, }); @@ -5515,6 +5932,9 @@ export interface Parameter { } export namespace Parameter { + /** + * @internal + */ export const filterSensitiveLog = (obj: Parameter): any => ({ ...obj, }); @@ -5534,6 +5954,9 @@ export interface ListPipelineParametersForExecutionResponse { } export namespace ListPipelineParametersForExecutionResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListPipelineParametersForExecutionResponse): any => ({ ...obj, }); @@ -5585,6 +6008,9 @@ export interface ListPipelinesRequest { } export namespace ListPipelinesRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListPipelinesRequest): any => ({ ...obj, }); @@ -5636,6 +6062,9 @@ export interface PipelineSummary { } export namespace PipelineSummary { + /** + * @internal + */ export const filterSensitiveLog = (obj: PipelineSummary): any => ({ ...obj, }); @@ -5658,6 +6087,9 @@ export interface ListPipelinesResponse { } export namespace ListPipelinesResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListPipelinesResponse): any => ({ ...obj, }); @@ -5719,6 +6151,9 @@ export interface ListProcessingJobsRequest { } export namespace ListProcessingJobsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListProcessingJobsRequest): any => ({ ...obj, }); @@ -5772,6 +6207,9 @@ export interface ProcessingJobSummary { } export namespace ProcessingJobSummary { + /** + * @internal + */ export const filterSensitiveLog = (obj: ProcessingJobSummary): any => ({ ...obj, }); @@ -5792,6 +6230,9 @@ export interface ListProcessingJobsResponse { } export namespace ListProcessingJobsResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListProcessingJobsResponse): any => ({ ...obj, }); @@ -5849,6 +6290,9 @@ export interface ListProjectsInput { } export namespace ListProjectsInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListProjectsInput): any => ({ ...obj, }); @@ -5890,6 +6334,9 @@ export interface ProjectSummary { } export namespace ProjectSummary { + /** + * @internal + */ export const filterSensitiveLog = (obj: ProjectSummary): any => ({ ...obj, }); @@ -5910,6 +6357,9 @@ export interface ListProjectsOutput { } export namespace ListProjectsOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListProjectsOutput): any => ({ ...obj, }); @@ -5936,6 +6386,9 @@ export interface ListSubscribedWorkteamsRequest { } export namespace ListSubscribedWorkteamsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListSubscribedWorkteamsRequest): any => ({ ...obj, }); @@ -5955,6 +6408,9 @@ export interface ListSubscribedWorkteamsResponse { } export namespace ListSubscribedWorkteamsResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListSubscribedWorkteamsResponse): any => ({ ...obj, }); @@ -5981,6 +6437,9 @@ export interface ListTagsInput { } export namespace ListTagsInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListTagsInput): any => ({ ...obj, }); @@ -6000,6 +6459,9 @@ export interface ListTagsOutput { } export namespace ListTagsOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListTagsOutput): any => ({ ...obj, }); @@ -6065,6 +6527,9 @@ export interface ListTrainingJobsRequest { } export namespace ListTrainingJobsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListTrainingJobsRequest): any => ({ ...obj, }); @@ -6108,6 +6573,9 @@ export interface TrainingJobSummary { } export namespace TrainingJobSummary { + /** + * @internal + */ export const filterSensitiveLog = (obj: TrainingJobSummary): any => ({ ...obj, }); @@ -6128,6 +6596,9 @@ export interface ListTrainingJobsResponse { } export namespace ListTrainingJobsResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListTrainingJobsResponse): any => ({ ...obj, }); @@ -6183,6 +6654,9 @@ export interface ListTrainingJobsForHyperParameterTuningJobRequest { } export namespace ListTrainingJobsForHyperParameterTuningJobRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListTrainingJobsForHyperParameterTuningJobRequest): any => ({ ...obj, }); @@ -6206,6 +6680,9 @@ export interface ListTrainingJobsForHyperParameterTuningJobResponse { } export namespace ListTrainingJobsForHyperParameterTuningJobResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListTrainingJobsForHyperParameterTuningJobResponse): any => ({ ...obj, }); @@ -6267,6 +6744,9 @@ export interface ListTransformJobsRequest { } export namespace ListTransformJobsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListTransformJobsRequest): any => ({ ...obj, }); @@ -6324,6 +6804,9 @@ export interface TransformJobSummary { } export namespace TransformJobSummary { + /** + * @internal + */ export const filterSensitiveLog = (obj: TransformJobSummary): any => ({ ...obj, }); @@ -6345,6 +6828,9 @@ export interface ListTransformJobsResponse { } export namespace ListTransformJobsResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListTransformJobsResponse): any => ({ ...obj, }); @@ -6411,6 +6897,9 @@ export interface ListTrialComponentsRequest { } export namespace ListTrialComponentsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListTrialComponentsRequest): any => ({ ...obj, }); @@ -6491,6 +6980,9 @@ export interface TrialComponentSummary { } export namespace TrialComponentSummary { + /** + * @internal + */ export const filterSensitiveLog = (obj: TrialComponentSummary): any => ({ ...obj, }); @@ -6509,6 +7001,9 @@ export interface ListTrialComponentsResponse { } export namespace ListTrialComponentsResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListTrialComponentsResponse): any => ({ ...obj, }); @@ -6564,6 +7059,9 @@ export interface ListTrialsRequest { } export namespace ListTrialsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListTrialsRequest): any => ({ ...obj, }); @@ -6607,6 +7105,9 @@ export interface TrialSummary { } export namespace TrialSummary { + /** + * @internal + */ export const filterSensitiveLog = (obj: TrialSummary): any => ({ ...obj, }); @@ -6625,6 +7126,9 @@ export interface ListTrialsResponse { } export namespace ListTrialsResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListTrialsResponse): any => ({ ...obj, }); @@ -6669,6 +7173,9 @@ export interface ListUserProfilesRequest { } export namespace ListUserProfilesRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListUserProfilesRequest): any => ({ ...obj, }); @@ -6705,6 +7212,9 @@ export interface UserProfileDetails { } export namespace UserProfileDetails { + /** + * @internal + */ export const filterSensitiveLog = (obj: UserProfileDetails): any => ({ ...obj, }); @@ -6724,6 +7234,9 @@ export interface ListUserProfilesResponse { } export namespace ListUserProfilesResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListUserProfilesResponse): any => ({ ...obj, }); @@ -6762,6 +7275,9 @@ export interface ListWorkforcesRequest { } export namespace ListWorkforcesRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListWorkforcesRequest): any => ({ ...obj, }); @@ -6780,6 +7296,9 @@ export interface ListWorkforcesResponse { } export namespace ListWorkforcesResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListWorkforcesResponse): any => ({ ...obj, }); @@ -6821,6 +7340,9 @@ export interface ListWorkteamsRequest { } export namespace ListWorkteamsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListWorkteamsRequest): any => ({ ...obj, }); @@ -6840,6 +7362,9 @@ export interface ListWorkteamsResponse { } export namespace ListWorkteamsResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListWorkteamsResponse): any => ({ ...obj, }); @@ -6994,6 +7519,9 @@ export interface ModelPackage { } export namespace ModelPackage { + /** + * @internal + */ export const filterSensitiveLog = (obj: ModelPackage): any => ({ ...obj, }); @@ -7069,6 +7597,9 @@ export interface ModelPackageGroup { } export namespace ModelPackageGroup { + /** + * @internal + */ export const filterSensitiveLog = (obj: ModelPackageGroup): any => ({ ...obj, }); @@ -7111,6 +7642,9 @@ export interface NestedFilters { } export namespace NestedFilters { + /** + * @internal + */ export const filterSensitiveLog = (obj: NestedFilters): any => ({ ...obj, }); @@ -7134,6 +7668,9 @@ export interface Parent { } export namespace Parent { + /** + * @internal + */ export const filterSensitiveLog = (obj: Parent): any => ({ ...obj, }); @@ -7207,6 +7744,9 @@ export interface Pipeline { } export namespace Pipeline { + /** + * @internal + */ export const filterSensitiveLog = (obj: Pipeline): any => ({ ...obj, }); @@ -7270,6 +7810,9 @@ export interface PipelineExecution { } export namespace PipelineExecution { + /** + * @internal + */ export const filterSensitiveLog = (obj: PipelineExecution): any => ({ ...obj, }); @@ -7419,6 +7962,9 @@ export interface ProcessingJob { } export namespace ProcessingJob { + /** + * @internal + */ export const filterSensitiveLog = (obj: ProcessingJob): any => ({ ...obj, }); @@ -7457,6 +8003,9 @@ export interface ProfilerConfigForUpdate { } export namespace ProfilerConfigForUpdate { + /** + * @internal + */ export const filterSensitiveLog = (obj: ProfilerConfigForUpdate): any => ({ ...obj, }); @@ -7475,6 +8024,9 @@ export interface PutModelPackageGroupPolicyInput { } export namespace PutModelPackageGroupPolicyInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: PutModelPackageGroupPolicyInput): any => ({ ...obj, }); @@ -7488,6 +8040,9 @@ export interface PutModelPackageGroupPolicyOutput { } export namespace PutModelPackageGroupPolicyOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: PutModelPackageGroupPolicyOutput): any => ({ ...obj, }); @@ -7511,6 +8066,9 @@ export interface RegisterDevicesRequest { } export namespace RegisterDevicesRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: RegisterDevicesRequest): any => ({ ...obj, }); @@ -7530,6 +8088,9 @@ export interface RenderableTask { } export namespace RenderableTask { + /** + * @internal + */ export const filterSensitiveLog = (obj: RenderableTask): any => ({ ...obj, }); @@ -7551,6 +8112,9 @@ export interface RenderingError { } export namespace RenderingError { + /** + * @internal + */ export const filterSensitiveLog = (obj: RenderingError): any => ({ ...obj, }); @@ -7584,6 +8148,9 @@ export interface RenderUiTemplateRequest { } export namespace RenderUiTemplateRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: RenderUiTemplateRequest): any => ({ ...obj, }); @@ -7603,6 +8170,9 @@ export interface RenderUiTemplateResponse { } export namespace RenderUiTemplateResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: RenderUiTemplateResponse): any => ({ ...obj, }); @@ -7975,6 +8545,9 @@ export interface TrainingJob { } export namespace TrainingJob { + /** + * @internal + */ export const filterSensitiveLog = (obj: TrainingJob): any => ({ ...obj, }); @@ -8012,6 +8585,9 @@ export interface TrialComponentSimpleSummary { } export namespace TrialComponentSimpleSummary { + /** + * @internal + */ export const filterSensitiveLog = (obj: TrialComponentSimpleSummary): any => ({ ...obj, }); @@ -8088,6 +8664,9 @@ export interface Trial { } export namespace Trial { + /** + * @internal + */ export const filterSensitiveLog = (obj: Trial): any => ({ ...obj, }); @@ -8274,6 +8853,9 @@ export interface TransformJob { } export namespace TransformJob { + /** + * @internal + */ export const filterSensitiveLog = (obj: TransformJob): any => ({ ...obj, }); @@ -8306,6 +8888,9 @@ export interface TrialComponentSourceDetail { } export namespace TrialComponentSourceDetail { + /** + * @internal + */ export const filterSensitiveLog = (obj: TrialComponentSourceDetail): any => ({ ...obj, }); @@ -8417,6 +9002,9 @@ export interface TrialComponent { } export namespace TrialComponent { + /** + * @internal + */ export const filterSensitiveLog = (obj: TrialComponent): any => ({ ...obj, ...(obj.Parameters && { @@ -8490,6 +9078,9 @@ export interface SearchRecord { } export namespace SearchRecord { + /** + * @internal + */ export const filterSensitiveLog = (obj: SearchRecord): any => ({ ...obj, ...(obj.TrialComponent && { TrialComponent: TrialComponent.filterSensitiveLog(obj.TrialComponent) }), @@ -8511,6 +9102,9 @@ export interface SearchResponse { } export namespace SearchResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: SearchResponse): any => ({ ...obj, ...(obj.Results && { Results: obj.Results.map((item) => SearchRecord.filterSensitiveLog(item)) }), @@ -8525,6 +9119,9 @@ export interface StartMonitoringScheduleRequest { } export namespace StartMonitoringScheduleRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: StartMonitoringScheduleRequest): any => ({ ...obj, }); @@ -8538,6 +9135,9 @@ export interface StartNotebookInstanceInput { } export namespace StartNotebookInstanceInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: StartNotebookInstanceInput): any => ({ ...obj, }); @@ -8572,6 +9172,9 @@ export interface StartPipelineExecutionRequest { } export namespace StartPipelineExecutionRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: StartPipelineExecutionRequest): any => ({ ...obj, }); @@ -8585,6 +9188,9 @@ export interface StartPipelineExecutionResponse { } export namespace StartPipelineExecutionResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: StartPipelineExecutionResponse): any => ({ ...obj, }); @@ -8598,6 +9204,9 @@ export interface StopAutoMLJobRequest { } export namespace StopAutoMLJobRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: StopAutoMLJobRequest): any => ({ ...obj, }); @@ -8611,6 +9220,9 @@ export interface StopCompilationJobRequest { } export namespace StopCompilationJobRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: StopCompilationJobRequest): any => ({ ...obj, }); @@ -8624,6 +9236,9 @@ export interface StopEdgePackagingJobRequest { } export namespace StopEdgePackagingJobRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: StopEdgePackagingJobRequest): any => ({ ...obj, }); @@ -8637,6 +9252,9 @@ export interface StopHyperParameterTuningJobRequest { } export namespace StopHyperParameterTuningJobRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: StopHyperParameterTuningJobRequest): any => ({ ...obj, }); @@ -8650,6 +9268,9 @@ export interface StopLabelingJobRequest { } export namespace StopLabelingJobRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: StopLabelingJobRequest): any => ({ ...obj, }); @@ -8663,6 +9284,9 @@ export interface StopMonitoringScheduleRequest { } export namespace StopMonitoringScheduleRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: StopMonitoringScheduleRequest): any => ({ ...obj, }); @@ -8676,6 +9300,9 @@ export interface StopNotebookInstanceInput { } export namespace StopNotebookInstanceInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: StopNotebookInstanceInput): any => ({ ...obj, }); @@ -8695,6 +9322,9 @@ export interface StopPipelineExecutionRequest { } export namespace StopPipelineExecutionRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: StopPipelineExecutionRequest): any => ({ ...obj, }); @@ -8708,6 +9338,9 @@ export interface StopPipelineExecutionResponse { } export namespace StopPipelineExecutionResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: StopPipelineExecutionResponse): any => ({ ...obj, }); @@ -8721,6 +9354,9 @@ export interface StopProcessingJobRequest { } export namespace StopProcessingJobRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: StopProcessingJobRequest): any => ({ ...obj, }); @@ -8734,6 +9370,9 @@ export interface StopTrainingJobRequest { } export namespace StopTrainingJobRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: StopTrainingJobRequest): any => ({ ...obj, }); @@ -8747,6 +9386,9 @@ export interface StopTransformJobRequest { } export namespace StopTransformJobRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: StopTransformJobRequest): any => ({ ...obj, }); @@ -8780,6 +9422,9 @@ export interface UpdateActionRequest { } export namespace UpdateActionRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateActionRequest): any => ({ ...obj, }); @@ -8793,6 +9438,9 @@ export interface UpdateActionResponse { } export namespace UpdateActionResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateActionResponse): any => ({ ...obj, }); @@ -8811,6 +9459,9 @@ export interface UpdateAppImageConfigRequest { } export namespace UpdateAppImageConfigRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateAppImageConfigRequest): any => ({ ...obj, }); @@ -8824,6 +9475,9 @@ export interface UpdateAppImageConfigResponse { } export namespace UpdateAppImageConfigResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateAppImageConfigResponse): any => ({ ...obj, }); @@ -8852,6 +9506,9 @@ export interface UpdateArtifactRequest { } export namespace UpdateArtifactRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateArtifactRequest): any => ({ ...obj, }); @@ -8865,6 +9522,9 @@ export interface UpdateArtifactResponse { } export namespace UpdateArtifactResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateArtifactResponse): any => ({ ...obj, }); @@ -8890,6 +9550,9 @@ export interface UpdateCodeRepositoryInput { } export namespace UpdateCodeRepositoryInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateCodeRepositoryInput): any => ({ ...obj, }); @@ -8903,6 +9566,9 @@ export interface UpdateCodeRepositoryOutput { } export namespace UpdateCodeRepositoryOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateCodeRepositoryOutput): any => ({ ...obj, }); @@ -8931,6 +9597,9 @@ export interface UpdateContextRequest { } export namespace UpdateContextRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateContextRequest): any => ({ ...obj, }); @@ -8944,6 +9613,9 @@ export interface UpdateContextResponse { } export namespace UpdateContextResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateContextResponse): any => ({ ...obj, }); @@ -8972,6 +9644,9 @@ export interface UpdateDeviceFleetRequest { } export namespace UpdateDeviceFleetRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateDeviceFleetRequest): any => ({ ...obj, }); @@ -8990,6 +9665,9 @@ export interface UpdateDevicesRequest { } export namespace UpdateDevicesRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateDevicesRequest): any => ({ ...obj, }); @@ -9008,6 +9686,9 @@ export interface UpdateDomainRequest { } export namespace UpdateDomainRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateDomainRequest): any => ({ ...obj, }); @@ -9021,6 +9702,9 @@ export interface UpdateDomainResponse { } export namespace UpdateDomainResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateDomainResponse): any => ({ ...obj, }); @@ -9063,6 +9747,9 @@ export interface VariantProperty { } export namespace VariantProperty { + /** + * @internal + */ export const filterSensitiveLog = (obj: VariantProperty): any => ({ ...obj, }); @@ -9106,6 +9793,9 @@ export interface UpdateEndpointInput { } export namespace UpdateEndpointInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateEndpointInput): any => ({ ...obj, }); @@ -9119,6 +9809,9 @@ export interface UpdateEndpointOutput { } export namespace UpdateEndpointOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateEndpointOutput): any => ({ ...obj, }); @@ -9137,6 +9830,9 @@ export interface UpdateEndpointWeightsAndCapacitiesInput { } export namespace UpdateEndpointWeightsAndCapacitiesInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateEndpointWeightsAndCapacitiesInput): any => ({ ...obj, }); @@ -9150,6 +9846,9 @@ export interface UpdateEndpointWeightsAndCapacitiesOutput { } export namespace UpdateEndpointWeightsAndCapacitiesOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateEndpointWeightsAndCapacitiesOutput): any => ({ ...obj, }); @@ -9174,6 +9873,9 @@ export interface UpdateExperimentRequest { } export namespace UpdateExperimentRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateExperimentRequest): any => ({ ...obj, }); @@ -9187,6 +9889,9 @@ export interface UpdateExperimentResponse { } export namespace UpdateExperimentResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateExperimentResponse): any => ({ ...obj, }); @@ -9221,6 +9926,9 @@ export interface UpdateImageRequest { } export namespace UpdateImageRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateImageRequest): any => ({ ...obj, }); @@ -9234,6 +9942,9 @@ export interface UpdateImageResponse { } export namespace UpdateImageResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateImageResponse): any => ({ ...obj, }); @@ -9257,6 +9968,9 @@ export interface UpdateModelPackageInput { } export namespace UpdateModelPackageInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateModelPackageInput): any => ({ ...obj, }); @@ -9270,6 +9984,9 @@ export interface UpdateModelPackageOutput { } export namespace UpdateModelPackageOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateModelPackageOutput): any => ({ ...obj, }); @@ -9290,6 +10007,9 @@ export interface UpdateMonitoringScheduleRequest { } export namespace UpdateMonitoringScheduleRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateMonitoringScheduleRequest): any => ({ ...obj, }); @@ -9303,6 +10023,9 @@ export interface UpdateMonitoringScheduleResponse { } export namespace UpdateMonitoringScheduleResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateMonitoringScheduleResponse): any => ({ ...obj, }); @@ -9418,6 +10141,9 @@ export interface UpdateNotebookInstanceInput { } export namespace UpdateNotebookInstanceInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateNotebookInstanceInput): any => ({ ...obj, }); @@ -9426,6 +10152,9 @@ export namespace UpdateNotebookInstanceInput { export interface UpdateNotebookInstanceOutput {} export namespace UpdateNotebookInstanceOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateNotebookInstanceOutput): any => ({ ...obj, }); @@ -9452,6 +10181,9 @@ export interface UpdateNotebookInstanceLifecycleConfigInput { } export namespace UpdateNotebookInstanceLifecycleConfigInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateNotebookInstanceLifecycleConfigInput): any => ({ ...obj, }); @@ -9460,6 +10192,9 @@ export namespace UpdateNotebookInstanceLifecycleConfigInput { export interface UpdateNotebookInstanceLifecycleConfigOutput {} export namespace UpdateNotebookInstanceLifecycleConfigOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateNotebookInstanceLifecycleConfigOutput): any => ({ ...obj, }); @@ -9493,6 +10228,9 @@ export interface UpdatePipelineRequest { } export namespace UpdatePipelineRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdatePipelineRequest): any => ({ ...obj, }); @@ -9506,6 +10244,9 @@ export interface UpdatePipelineResponse { } export namespace UpdatePipelineResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdatePipelineResponse): any => ({ ...obj, }); @@ -9529,6 +10270,9 @@ export interface UpdatePipelineExecutionRequest { } export namespace UpdatePipelineExecutionRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdatePipelineExecutionRequest): any => ({ ...obj, }); @@ -9542,6 +10286,9 @@ export interface UpdatePipelineExecutionResponse { } export namespace UpdatePipelineExecutionResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdatePipelineExecutionResponse): any => ({ ...obj, }); @@ -9567,6 +10314,9 @@ export interface UpdateTrainingJobRequest { } export namespace UpdateTrainingJobRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateTrainingJobRequest): any => ({ ...obj, }); @@ -9580,6 +10330,9 @@ export interface UpdateTrainingJobResponse { } export namespace UpdateTrainingJobResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateTrainingJobResponse): any => ({ ...obj, }); @@ -9599,6 +10352,9 @@ export interface UpdateTrialRequest { } export namespace UpdateTrialRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateTrialRequest): any => ({ ...obj, }); diff --git a/clients/client-sagemaker/models/models_3.ts b/clients/client-sagemaker/models/models_3.ts index 2f26052b3618..0281b0f15a77 100644 --- a/clients/client-sagemaker/models/models_3.ts +++ b/clients/client-sagemaker/models/models_3.ts @@ -20,6 +20,9 @@ export interface UpdateTrialResponse { } export namespace UpdateTrialResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateTrialResponse): any => ({ ...obj, }); @@ -85,6 +88,9 @@ export interface UpdateTrialComponentRequest { } export namespace UpdateTrialComponentRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateTrialComponentRequest): any => ({ ...obj, ...(obj.Parameters && { @@ -107,6 +113,9 @@ export interface UpdateTrialComponentResponse { } export namespace UpdateTrialComponentResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateTrialComponentResponse): any => ({ ...obj, }); @@ -130,6 +139,9 @@ export interface UpdateUserProfileRequest { } export namespace UpdateUserProfileRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateUserProfileRequest): any => ({ ...obj, }); @@ -143,6 +155,9 @@ export interface UpdateUserProfileResponse { } export namespace UpdateUserProfileResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateUserProfileResponse): any => ({ ...obj, }); @@ -170,6 +185,9 @@ export interface UpdateWorkforceRequest { } export namespace UpdateWorkforceRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateWorkforceRequest): any => ({ ...obj, ...(obj.OidcConfig && { OidcConfig: OidcConfig.filterSensitiveLog(obj.OidcConfig) }), @@ -186,6 +204,9 @@ export interface UpdateWorkforceResponse { } export namespace UpdateWorkforceResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateWorkforceResponse): any => ({ ...obj, }); @@ -233,6 +254,9 @@ export interface UpdateWorkteamRequest { } export namespace UpdateWorkteamRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateWorkteamRequest): any => ({ ...obj, }); @@ -246,6 +270,9 @@ export interface UpdateWorkteamResponse { } export namespace UpdateWorkteamResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateWorkteamResponse): any => ({ ...obj, }); @@ -305,6 +332,9 @@ export interface SearchExpression { } export namespace SearchExpression { + /** + * @internal + */ export const filterSensitiveLog = (obj: SearchExpression): any => ({ ...obj, }); @@ -352,6 +382,9 @@ export interface SearchRequest { } export namespace SearchRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: SearchRequest): any => ({ ...obj, }); diff --git a/clients/client-savingsplans/commands/CreateSavingsPlanCommand.ts b/clients/client-savingsplans/commands/CreateSavingsPlanCommand.ts index b36da41a2767..26cad3c9703f 100644 --- a/clients/client-savingsplans/commands/CreateSavingsPlanCommand.ts +++ b/clients/client-savingsplans/commands/CreateSavingsPlanCommand.ts @@ -22,6 +22,20 @@ export interface CreateSavingsPlanCommandOutput extends CreateSavingsPlanRespons /** *

Creates a Savings Plan.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { SavingsplansClient, CreateSavingsPlanCommand } from "@aws-sdk/client-savingsplans"; // ES Modules import + * // const { SavingsplansClient, CreateSavingsPlanCommand } = require("@aws-sdk/client-savingsplans"); // CommonJS import + * const client = new SavingsplansClient(config); + * const command = new CreateSavingsPlanCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreateSavingsPlanCommandInput} for command's `input` shape. + * @see {@link CreateSavingsPlanCommandOutput} for command's `response` shape. + * @see {@link SavingsplansClientResolvedConfig | config} for command's `input` shape. + * */ export class CreateSavingsPlanCommand extends $Command< CreateSavingsPlanCommandInput, diff --git a/clients/client-savingsplans/commands/DeleteQueuedSavingsPlanCommand.ts b/clients/client-savingsplans/commands/DeleteQueuedSavingsPlanCommand.ts index de8b37a31dc2..2be1702c015b 100644 --- a/clients/client-savingsplans/commands/DeleteQueuedSavingsPlanCommand.ts +++ b/clients/client-savingsplans/commands/DeleteQueuedSavingsPlanCommand.ts @@ -22,6 +22,20 @@ export interface DeleteQueuedSavingsPlanCommandOutput extends DeleteQueuedSaving /** *

Deletes the queued purchase for the specified Savings Plan.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { SavingsplansClient, DeleteQueuedSavingsPlanCommand } from "@aws-sdk/client-savingsplans"; // ES Modules import + * // const { SavingsplansClient, DeleteQueuedSavingsPlanCommand } = require("@aws-sdk/client-savingsplans"); // CommonJS import + * const client = new SavingsplansClient(config); + * const command = new DeleteQueuedSavingsPlanCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteQueuedSavingsPlanCommandInput} for command's `input` shape. + * @see {@link DeleteQueuedSavingsPlanCommandOutput} for command's `response` shape. + * @see {@link SavingsplansClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteQueuedSavingsPlanCommand extends $Command< DeleteQueuedSavingsPlanCommandInput, diff --git a/clients/client-savingsplans/commands/DescribeSavingsPlanRatesCommand.ts b/clients/client-savingsplans/commands/DescribeSavingsPlanRatesCommand.ts index a20fd7536492..d96a40d2e4a2 100644 --- a/clients/client-savingsplans/commands/DescribeSavingsPlanRatesCommand.ts +++ b/clients/client-savingsplans/commands/DescribeSavingsPlanRatesCommand.ts @@ -22,6 +22,20 @@ export interface DescribeSavingsPlanRatesCommandOutput extends DescribeSavingsPl /** *

Describes the specified Savings Plans rates.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { SavingsplansClient, DescribeSavingsPlanRatesCommand } from "@aws-sdk/client-savingsplans"; // ES Modules import + * // const { SavingsplansClient, DescribeSavingsPlanRatesCommand } = require("@aws-sdk/client-savingsplans"); // CommonJS import + * const client = new SavingsplansClient(config); + * const command = new DescribeSavingsPlanRatesCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeSavingsPlanRatesCommandInput} for command's `input` shape. + * @see {@link DescribeSavingsPlanRatesCommandOutput} for command's `response` shape. + * @see {@link SavingsplansClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeSavingsPlanRatesCommand extends $Command< DescribeSavingsPlanRatesCommandInput, diff --git a/clients/client-savingsplans/commands/DescribeSavingsPlansCommand.ts b/clients/client-savingsplans/commands/DescribeSavingsPlansCommand.ts index 3e4c6a1a93de..4254115f90aa 100644 --- a/clients/client-savingsplans/commands/DescribeSavingsPlansCommand.ts +++ b/clients/client-savingsplans/commands/DescribeSavingsPlansCommand.ts @@ -22,6 +22,20 @@ export interface DescribeSavingsPlansCommandOutput extends DescribeSavingsPlansR /** *

Describes the specified Savings Plans.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { SavingsplansClient, DescribeSavingsPlansCommand } from "@aws-sdk/client-savingsplans"; // ES Modules import + * // const { SavingsplansClient, DescribeSavingsPlansCommand } = require("@aws-sdk/client-savingsplans"); // CommonJS import + * const client = new SavingsplansClient(config); + * const command = new DescribeSavingsPlansCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeSavingsPlansCommandInput} for command's `input` shape. + * @see {@link DescribeSavingsPlansCommandOutput} for command's `response` shape. + * @see {@link SavingsplansClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeSavingsPlansCommand extends $Command< DescribeSavingsPlansCommandInput, diff --git a/clients/client-savingsplans/commands/DescribeSavingsPlansOfferingRatesCommand.ts b/clients/client-savingsplans/commands/DescribeSavingsPlansOfferingRatesCommand.ts index 37c80953b005..df7231ca5b14 100644 --- a/clients/client-savingsplans/commands/DescribeSavingsPlansOfferingRatesCommand.ts +++ b/clients/client-savingsplans/commands/DescribeSavingsPlansOfferingRatesCommand.ts @@ -27,6 +27,20 @@ export interface DescribeSavingsPlansOfferingRatesCommandOutput /** *

Describes the specified Savings Plans offering rates.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { SavingsplansClient, DescribeSavingsPlansOfferingRatesCommand } from "@aws-sdk/client-savingsplans"; // ES Modules import + * // const { SavingsplansClient, DescribeSavingsPlansOfferingRatesCommand } = require("@aws-sdk/client-savingsplans"); // CommonJS import + * const client = new SavingsplansClient(config); + * const command = new DescribeSavingsPlansOfferingRatesCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeSavingsPlansOfferingRatesCommandInput} for command's `input` shape. + * @see {@link DescribeSavingsPlansOfferingRatesCommandOutput} for command's `response` shape. + * @see {@link SavingsplansClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeSavingsPlansOfferingRatesCommand extends $Command< DescribeSavingsPlansOfferingRatesCommandInput, diff --git a/clients/client-savingsplans/commands/DescribeSavingsPlansOfferingsCommand.ts b/clients/client-savingsplans/commands/DescribeSavingsPlansOfferingsCommand.ts index 227ec84ef3f2..459f42daf0c4 100644 --- a/clients/client-savingsplans/commands/DescribeSavingsPlansOfferingsCommand.ts +++ b/clients/client-savingsplans/commands/DescribeSavingsPlansOfferingsCommand.ts @@ -24,6 +24,20 @@ export interface DescribeSavingsPlansOfferingsCommandOutput /** *

Describes the specified Savings Plans offerings.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { SavingsplansClient, DescribeSavingsPlansOfferingsCommand } from "@aws-sdk/client-savingsplans"; // ES Modules import + * // const { SavingsplansClient, DescribeSavingsPlansOfferingsCommand } = require("@aws-sdk/client-savingsplans"); // CommonJS import + * const client = new SavingsplansClient(config); + * const command = new DescribeSavingsPlansOfferingsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeSavingsPlansOfferingsCommandInput} for command's `input` shape. + * @see {@link DescribeSavingsPlansOfferingsCommandOutput} for command's `response` shape. + * @see {@link SavingsplansClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeSavingsPlansOfferingsCommand extends $Command< DescribeSavingsPlansOfferingsCommandInput, diff --git a/clients/client-savingsplans/commands/ListTagsForResourceCommand.ts b/clients/client-savingsplans/commands/ListTagsForResourceCommand.ts index 700fdfff7797..a06ad8213ce0 100644 --- a/clients/client-savingsplans/commands/ListTagsForResourceCommand.ts +++ b/clients/client-savingsplans/commands/ListTagsForResourceCommand.ts @@ -22,6 +22,20 @@ export interface ListTagsForResourceCommandOutput extends ListTagsForResourceRes /** *

Lists the tags for the specified resource.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { SavingsplansClient, ListTagsForResourceCommand } from "@aws-sdk/client-savingsplans"; // ES Modules import + * // const { SavingsplansClient, ListTagsForResourceCommand } = require("@aws-sdk/client-savingsplans"); // CommonJS import + * const client = new SavingsplansClient(config); + * const command = new ListTagsForResourceCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListTagsForResourceCommandInput} for command's `input` shape. + * @see {@link ListTagsForResourceCommandOutput} for command's `response` shape. + * @see {@link SavingsplansClientResolvedConfig | config} for command's `input` shape. + * */ export class ListTagsForResourceCommand extends $Command< ListTagsForResourceCommandInput, diff --git a/clients/client-savingsplans/commands/TagResourceCommand.ts b/clients/client-savingsplans/commands/TagResourceCommand.ts index 2136914de714..a36993a5bbb0 100644 --- a/clients/client-savingsplans/commands/TagResourceCommand.ts +++ b/clients/client-savingsplans/commands/TagResourceCommand.ts @@ -22,6 +22,20 @@ export interface TagResourceCommandOutput extends TagResourceResponse, __Metadat /** *

Adds the specified tags to the specified resource.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { SavingsplansClient, TagResourceCommand } from "@aws-sdk/client-savingsplans"; // ES Modules import + * // const { SavingsplansClient, TagResourceCommand } = require("@aws-sdk/client-savingsplans"); // CommonJS import + * const client = new SavingsplansClient(config); + * const command = new TagResourceCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link TagResourceCommandInput} for command's `input` shape. + * @see {@link TagResourceCommandOutput} for command's `response` shape. + * @see {@link SavingsplansClientResolvedConfig | config} for command's `input` shape. + * */ export class TagResourceCommand extends $Command< TagResourceCommandInput, diff --git a/clients/client-savingsplans/commands/UntagResourceCommand.ts b/clients/client-savingsplans/commands/UntagResourceCommand.ts index a3e45458f1b5..c6373129ccec 100644 --- a/clients/client-savingsplans/commands/UntagResourceCommand.ts +++ b/clients/client-savingsplans/commands/UntagResourceCommand.ts @@ -22,6 +22,20 @@ export interface UntagResourceCommandOutput extends UntagResourceResponse, __Met /** *

Removes the specified tags from the specified resource.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { SavingsplansClient, UntagResourceCommand } from "@aws-sdk/client-savingsplans"; // ES Modules import + * // const { SavingsplansClient, UntagResourceCommand } = require("@aws-sdk/client-savingsplans"); // CommonJS import + * const client = new SavingsplansClient(config); + * const command = new UntagResourceCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link UntagResourceCommandInput} for command's `input` shape. + * @see {@link UntagResourceCommandOutput} for command's `response` shape. + * @see {@link SavingsplansClientResolvedConfig | config} for command's `input` shape. + * */ export class UntagResourceCommand extends $Command< UntagResourceCommandInput, diff --git a/clients/client-savingsplans/models/models_0.ts b/clients/client-savingsplans/models/models_0.ts index 306a8c7e16e0..eada55bba669 100644 --- a/clients/client-savingsplans/models/models_0.ts +++ b/clients/client-savingsplans/models/models_0.ts @@ -36,6 +36,9 @@ export interface CreateSavingsPlanRequest { } export namespace CreateSavingsPlanRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateSavingsPlanRequest): any => ({ ...obj, }); @@ -49,6 +52,9 @@ export interface CreateSavingsPlanResponse { } export namespace CreateSavingsPlanResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateSavingsPlanResponse): any => ({ ...obj, }); @@ -64,6 +70,9 @@ export interface InternalServerException extends __SmithyException, $MetadataBea } export namespace InternalServerException { + /** + * @internal + */ export const filterSensitiveLog = (obj: InternalServerException): any => ({ ...obj, }); @@ -79,6 +88,9 @@ export interface ResourceNotFoundException extends __SmithyException, $MetadataB } export namespace ResourceNotFoundException { + /** + * @internal + */ export const filterSensitiveLog = (obj: ResourceNotFoundException): any => ({ ...obj, }); @@ -94,6 +106,9 @@ export interface ServiceQuotaExceededException extends __SmithyException, $Metad } export namespace ServiceQuotaExceededException { + /** + * @internal + */ export const filterSensitiveLog = (obj: ServiceQuotaExceededException): any => ({ ...obj, }); @@ -109,6 +124,9 @@ export interface ValidationException extends __SmithyException, $MetadataBearer } export namespace ValidationException { + /** + * @internal + */ export const filterSensitiveLog = (obj: ValidationException): any => ({ ...obj, }); @@ -122,6 +140,9 @@ export interface DeleteQueuedSavingsPlanRequest { } export namespace DeleteQueuedSavingsPlanRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteQueuedSavingsPlanRequest): any => ({ ...obj, }); @@ -130,6 +151,9 @@ export namespace DeleteQueuedSavingsPlanRequest { export interface DeleteQueuedSavingsPlanResponse {} export namespace DeleteQueuedSavingsPlanResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteQueuedSavingsPlanResponse): any => ({ ...obj, }); @@ -162,6 +186,9 @@ export interface SavingsPlanRateFilter { } export namespace SavingsPlanRateFilter { + /** + * @internal + */ export const filterSensitiveLog = (obj: SavingsPlanRateFilter): any => ({ ...obj, }); @@ -191,6 +218,9 @@ export interface DescribeSavingsPlanRatesRequest { } export namespace DescribeSavingsPlanRatesRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeSavingsPlanRatesRequest): any => ({ ...obj, }); @@ -229,6 +259,9 @@ export interface SavingsPlanRateProperty { } export namespace SavingsPlanRateProperty { + /** + * @internal + */ export const filterSensitiveLog = (obj: SavingsPlanRateProperty): any => ({ ...obj, }); @@ -294,6 +327,9 @@ export interface SavingsPlanRate { } export namespace SavingsPlanRate { + /** + * @internal + */ export const filterSensitiveLog = (obj: SavingsPlanRate): any => ({ ...obj, }); @@ -318,6 +354,9 @@ export interface DescribeSavingsPlanRatesResponse { } export namespace DescribeSavingsPlanRatesResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeSavingsPlanRatesResponse): any => ({ ...obj, }); @@ -351,6 +390,9 @@ export interface SavingsPlanFilter { } export namespace SavingsPlanFilter { + /** + * @internal + */ export const filterSensitiveLog = (obj: SavingsPlanFilter): any => ({ ...obj, }); @@ -399,6 +441,9 @@ export interface DescribeSavingsPlansRequest { } export namespace DescribeSavingsPlansRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeSavingsPlansRequest): any => ({ ...obj, }); @@ -512,6 +557,9 @@ export interface SavingsPlan { } export namespace SavingsPlan { + /** + * @internal + */ export const filterSensitiveLog = (obj: SavingsPlan): any => ({ ...obj, }); @@ -531,6 +579,9 @@ export interface DescribeSavingsPlansResponse { } export namespace DescribeSavingsPlansResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeSavingsPlansResponse): any => ({ ...obj, }); @@ -561,6 +612,9 @@ export interface SavingsPlanOfferingRateFilterElement { } export namespace SavingsPlanOfferingRateFilterElement { + /** + * @internal + */ export const filterSensitiveLog = (obj: SavingsPlanOfferingRateFilterElement): any => ({ ...obj, }); @@ -620,6 +674,9 @@ export interface DescribeSavingsPlansOfferingRatesRequest { } export namespace DescribeSavingsPlansOfferingRatesRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeSavingsPlansOfferingRatesRequest): any => ({ ...obj, }); @@ -641,6 +698,9 @@ export interface SavingsPlanOfferingRateProperty { } export namespace SavingsPlanOfferingRateProperty { + /** + * @internal + */ export const filterSensitiveLog = (obj: SavingsPlanOfferingRateProperty): any => ({ ...obj, }); @@ -682,6 +742,9 @@ export interface ParentSavingsPlanOffering { } export namespace ParentSavingsPlanOffering { + /** + * @internal + */ export const filterSensitiveLog = (obj: ParentSavingsPlanOffering): any => ({ ...obj, }); @@ -733,6 +796,9 @@ export interface SavingsPlanOfferingRate { } export namespace SavingsPlanOfferingRate { + /** + * @internal + */ export const filterSensitiveLog = (obj: SavingsPlanOfferingRate): any => ({ ...obj, }); @@ -752,6 +818,9 @@ export interface DescribeSavingsPlansOfferingRatesResponse { } export namespace DescribeSavingsPlansOfferingRatesResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeSavingsPlansOfferingRatesResponse): any => ({ ...obj, }); @@ -778,6 +847,9 @@ export interface SavingsPlanOfferingFilterElement { } export namespace SavingsPlanOfferingFilterElement { + /** + * @internal + */ export const filterSensitiveLog = (obj: SavingsPlanOfferingFilterElement): any => ({ ...obj, }); @@ -852,6 +924,9 @@ export interface DescribeSavingsPlansOfferingsRequest { } export namespace DescribeSavingsPlansOfferingsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeSavingsPlansOfferingsRequest): any => ({ ...obj, }); @@ -878,6 +953,9 @@ export interface SavingsPlanOfferingProperty { } export namespace SavingsPlanOfferingProperty { + /** + * @internal + */ export const filterSensitiveLog = (obj: SavingsPlanOfferingProperty): any => ({ ...obj, }); @@ -944,6 +1022,9 @@ export interface SavingsPlanOffering { } export namespace SavingsPlanOffering { + /** + * @internal + */ export const filterSensitiveLog = (obj: SavingsPlanOffering): any => ({ ...obj, }); @@ -963,6 +1044,9 @@ export interface DescribeSavingsPlansOfferingsResponse { } export namespace DescribeSavingsPlansOfferingsResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeSavingsPlansOfferingsResponse): any => ({ ...obj, }); @@ -976,6 +1060,9 @@ export interface ListTagsForResourceRequest { } export namespace ListTagsForResourceRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListTagsForResourceRequest): any => ({ ...obj, }); @@ -989,6 +1076,9 @@ export interface ListTagsForResourceResponse { } export namespace ListTagsForResourceResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListTagsForResourceResponse): any => ({ ...obj, }); @@ -1007,6 +1097,9 @@ export interface TagResourceRequest { } export namespace TagResourceRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: TagResourceRequest): any => ({ ...obj, }); @@ -1015,6 +1108,9 @@ export namespace TagResourceRequest { export interface TagResourceResponse {} export namespace TagResourceResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: TagResourceResponse): any => ({ ...obj, }); @@ -1033,6 +1129,9 @@ export interface UntagResourceRequest { } export namespace UntagResourceRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: UntagResourceRequest): any => ({ ...obj, }); @@ -1041,6 +1140,9 @@ export namespace UntagResourceRequest { export interface UntagResourceResponse {} export namespace UntagResourceResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: UntagResourceResponse): any => ({ ...obj, }); diff --git a/clients/client-schemas/commands/CreateDiscovererCommand.ts b/clients/client-schemas/commands/CreateDiscovererCommand.ts index 265f33f0b6c8..c34898c4484d 100644 --- a/clients/client-schemas/commands/CreateDiscovererCommand.ts +++ b/clients/client-schemas/commands/CreateDiscovererCommand.ts @@ -22,6 +22,20 @@ export interface CreateDiscovererCommandOutput extends CreateDiscovererResponse, /** *

Creates a discoverer.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { SchemasClient, CreateDiscovererCommand } from "@aws-sdk/client-schemas"; // ES Modules import + * // const { SchemasClient, CreateDiscovererCommand } = require("@aws-sdk/client-schemas"); // CommonJS import + * const client = new SchemasClient(config); + * const command = new CreateDiscovererCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreateDiscovererCommandInput} for command's `input` shape. + * @see {@link CreateDiscovererCommandOutput} for command's `response` shape. + * @see {@link SchemasClientResolvedConfig | config} for command's `input` shape. + * */ export class CreateDiscovererCommand extends $Command< CreateDiscovererCommandInput, diff --git a/clients/client-schemas/commands/CreateRegistryCommand.ts b/clients/client-schemas/commands/CreateRegistryCommand.ts index 82017d0e0c41..d52ee8235061 100644 --- a/clients/client-schemas/commands/CreateRegistryCommand.ts +++ b/clients/client-schemas/commands/CreateRegistryCommand.ts @@ -22,6 +22,20 @@ export interface CreateRegistryCommandOutput extends CreateRegistryResponse, __M /** *

Creates a registry.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { SchemasClient, CreateRegistryCommand } from "@aws-sdk/client-schemas"; // ES Modules import + * // const { SchemasClient, CreateRegistryCommand } = require("@aws-sdk/client-schemas"); // CommonJS import + * const client = new SchemasClient(config); + * const command = new CreateRegistryCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreateRegistryCommandInput} for command's `input` shape. + * @see {@link CreateRegistryCommandOutput} for command's `response` shape. + * @see {@link SchemasClientResolvedConfig | config} for command's `input` shape. + * */ export class CreateRegistryCommand extends $Command< CreateRegistryCommandInput, diff --git a/clients/client-schemas/commands/CreateSchemaCommand.ts b/clients/client-schemas/commands/CreateSchemaCommand.ts index 889d842f154c..127a818de2cd 100644 --- a/clients/client-schemas/commands/CreateSchemaCommand.ts +++ b/clients/client-schemas/commands/CreateSchemaCommand.ts @@ -22,6 +22,20 @@ export interface CreateSchemaCommandOutput extends CreateSchemaResponse, __Metad /** *

Creates a schema definition.

Inactive schemas will be deleted after two years.

 + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { SchemasClient, CreateSchemaCommand } from "@aws-sdk/client-schemas"; // ES Modules import + * // const { SchemasClient, CreateSchemaCommand } = require("@aws-sdk/client-schemas"); // CommonJS import + * const client = new SchemasClient(config); + * const command = new CreateSchemaCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreateSchemaCommandInput} for command's `input` shape. + * @see {@link CreateSchemaCommandOutput} for command's `response` shape. + * @see {@link SchemasClientResolvedConfig | config} for command's `input` shape. + * */ export class CreateSchemaCommand extends $Command< CreateSchemaCommandInput, diff --git a/clients/client-schemas/commands/DeleteDiscovererCommand.ts b/clients/client-schemas/commands/DeleteDiscovererCommand.ts index ea275b364635..2db225e4df32 100644 --- a/clients/client-schemas/commands/DeleteDiscovererCommand.ts +++ b/clients/client-schemas/commands/DeleteDiscovererCommand.ts @@ -22,6 +22,20 @@ export interface DeleteDiscovererCommandOutput extends __MetadataBearer {} /** *

Deletes a discoverer.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { SchemasClient, DeleteDiscovererCommand } from "@aws-sdk/client-schemas"; // ES Modules import + * // const { SchemasClient, DeleteDiscovererCommand } = require("@aws-sdk/client-schemas"); // CommonJS import + * const client = new SchemasClient(config); + * const command = new DeleteDiscovererCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteDiscovererCommandInput} for command's `input` shape. + * @see {@link DeleteDiscovererCommandOutput} for command's `response` shape. + * @see {@link SchemasClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteDiscovererCommand extends $Command< DeleteDiscovererCommandInput, diff --git a/clients/client-schemas/commands/DeleteRegistryCommand.ts b/clients/client-schemas/commands/DeleteRegistryCommand.ts index d394ee89ec93..9c560f9e0a6f 100644 --- a/clients/client-schemas/commands/DeleteRegistryCommand.ts +++ b/clients/client-schemas/commands/DeleteRegistryCommand.ts @@ -22,6 +22,20 @@ export interface DeleteRegistryCommandOutput extends __MetadataBearer {} /** *

Deletes a Registry.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { SchemasClient, DeleteRegistryCommand } from "@aws-sdk/client-schemas"; // ES Modules import + * // const { SchemasClient, DeleteRegistryCommand } = require("@aws-sdk/client-schemas"); // CommonJS import + * const client = new SchemasClient(config); + * const command = new DeleteRegistryCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteRegistryCommandInput} for command's `input` shape. + * @see {@link DeleteRegistryCommandOutput} for command's `response` shape. + * @see {@link SchemasClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteRegistryCommand extends $Command< DeleteRegistryCommandInput, diff --git a/clients/client-schemas/commands/DeleteResourcePolicyCommand.ts b/clients/client-schemas/commands/DeleteResourcePolicyCommand.ts index a7ed621bd3d0..ffe45d1403c9 100644 --- a/clients/client-schemas/commands/DeleteResourcePolicyCommand.ts +++ b/clients/client-schemas/commands/DeleteResourcePolicyCommand.ts @@ -22,6 +22,20 @@ export interface DeleteResourcePolicyCommandOutput extends __MetadataBearer {} /** *

Delete the resource-based policy attached to the specified registry.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { SchemasClient, DeleteResourcePolicyCommand } from "@aws-sdk/client-schemas"; // ES Modules import + * // const { SchemasClient, DeleteResourcePolicyCommand } = require("@aws-sdk/client-schemas"); // CommonJS import + * const client = new SchemasClient(config); + * const command = new DeleteResourcePolicyCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteResourcePolicyCommandInput} for command's `input` shape. + * @see {@link DeleteResourcePolicyCommandOutput} for command's `response` shape. + * @see {@link SchemasClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteResourcePolicyCommand extends $Command< DeleteResourcePolicyCommandInput, diff --git a/clients/client-schemas/commands/DeleteSchemaCommand.ts b/clients/client-schemas/commands/DeleteSchemaCommand.ts index 490530ff4f32..88908732f0c5 100644 --- a/clients/client-schemas/commands/DeleteSchemaCommand.ts +++ b/clients/client-schemas/commands/DeleteSchemaCommand.ts @@ -22,6 +22,20 @@ export interface DeleteSchemaCommandOutput extends __MetadataBearer {} /** *

Delete a schema definition.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { SchemasClient, DeleteSchemaCommand } from "@aws-sdk/client-schemas"; // ES Modules import + * // const { SchemasClient, DeleteSchemaCommand } = require("@aws-sdk/client-schemas"); // CommonJS import + * const client = new SchemasClient(config); + * const command = new DeleteSchemaCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteSchemaCommandInput} for command's `input` shape. + * @see {@link DeleteSchemaCommandOutput} for command's `response` shape. + * @see {@link SchemasClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteSchemaCommand extends $Command< DeleteSchemaCommandInput, diff --git a/clients/client-schemas/commands/DeleteSchemaVersionCommand.ts b/clients/client-schemas/commands/DeleteSchemaVersionCommand.ts index 7055dbec273a..9e6de7131d5d 100644 --- a/clients/client-schemas/commands/DeleteSchemaVersionCommand.ts +++ b/clients/client-schemas/commands/DeleteSchemaVersionCommand.ts @@ -22,6 +22,20 @@ export interface DeleteSchemaVersionCommandOutput extends __MetadataBearer {} /** *

Delete the schema version definition

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { SchemasClient, DeleteSchemaVersionCommand } from "@aws-sdk/client-schemas"; // ES Modules import + * // const { SchemasClient, DeleteSchemaVersionCommand } = require("@aws-sdk/client-schemas"); // CommonJS import + * const client = new SchemasClient(config); + * const command = new DeleteSchemaVersionCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteSchemaVersionCommandInput} for command's `input` shape. + * @see {@link DeleteSchemaVersionCommandOutput} for command's `response` shape. + * @see {@link SchemasClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteSchemaVersionCommand extends $Command< DeleteSchemaVersionCommandInput, diff --git a/clients/client-schemas/commands/DescribeCodeBindingCommand.ts b/clients/client-schemas/commands/DescribeCodeBindingCommand.ts index 0523a088a78a..2e0e54858678 100644 --- a/clients/client-schemas/commands/DescribeCodeBindingCommand.ts +++ b/clients/client-schemas/commands/DescribeCodeBindingCommand.ts @@ -22,6 +22,20 @@ export interface DescribeCodeBindingCommandOutput extends DescribeCodeBindingRes /** *

Describe the code binding URI.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { SchemasClient, DescribeCodeBindingCommand } from "@aws-sdk/client-schemas"; // ES Modules import + * // const { SchemasClient, DescribeCodeBindingCommand } = require("@aws-sdk/client-schemas"); // CommonJS import + * const client = new SchemasClient(config); + * const command = new DescribeCodeBindingCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeCodeBindingCommandInput} for command's `input` shape. + * @see {@link DescribeCodeBindingCommandOutput} for command's `response` shape. + * @see {@link SchemasClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeCodeBindingCommand extends $Command< DescribeCodeBindingCommandInput, diff --git a/clients/client-schemas/commands/DescribeDiscovererCommand.ts b/clients/client-schemas/commands/DescribeDiscovererCommand.ts index 2691931d9069..28e330eea58b 100644 --- a/clients/client-schemas/commands/DescribeDiscovererCommand.ts +++ b/clients/client-schemas/commands/DescribeDiscovererCommand.ts @@ -22,6 +22,20 @@ export interface DescribeDiscovererCommandOutput extends DescribeDiscovererRespo /** *

Describes the discoverer.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { SchemasClient, DescribeDiscovererCommand } from "@aws-sdk/client-schemas"; // ES Modules import + * // const { SchemasClient, DescribeDiscovererCommand } = require("@aws-sdk/client-schemas"); // CommonJS import + * const client = new SchemasClient(config); + * const command = new DescribeDiscovererCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeDiscovererCommandInput} for command's `input` shape. + * @see {@link DescribeDiscovererCommandOutput} for command's `response` shape. + * @see {@link SchemasClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeDiscovererCommand extends $Command< DescribeDiscovererCommandInput, diff --git a/clients/client-schemas/commands/DescribeRegistryCommand.ts b/clients/client-schemas/commands/DescribeRegistryCommand.ts index 744161f0ff85..0d9a743d03b0 100644 --- a/clients/client-schemas/commands/DescribeRegistryCommand.ts +++ b/clients/client-schemas/commands/DescribeRegistryCommand.ts @@ -22,6 +22,20 @@ export interface DescribeRegistryCommandOutput extends DescribeRegistryResponse, /** *

Describes the registry.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { SchemasClient, DescribeRegistryCommand } from "@aws-sdk/client-schemas"; // ES Modules import + * // const { SchemasClient, DescribeRegistryCommand } = require("@aws-sdk/client-schemas"); // CommonJS import + * const client = new SchemasClient(config); + * const command = new DescribeRegistryCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeRegistryCommandInput} for command's `input` shape. + * @see {@link DescribeRegistryCommandOutput} for command's `response` shape. + * @see {@link SchemasClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeRegistryCommand extends $Command< DescribeRegistryCommandInput, diff --git a/clients/client-schemas/commands/DescribeSchemaCommand.ts b/clients/client-schemas/commands/DescribeSchemaCommand.ts index bf61f75817dd..19a719b83f51 100644 --- a/clients/client-schemas/commands/DescribeSchemaCommand.ts +++ b/clients/client-schemas/commands/DescribeSchemaCommand.ts @@ -22,6 +22,20 @@ export interface DescribeSchemaCommandOutput extends DescribeSchemaResponse, __M /** *

Retrieve the schema definition.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { SchemasClient, DescribeSchemaCommand } from "@aws-sdk/client-schemas"; // ES Modules import + * // const { SchemasClient, DescribeSchemaCommand } = require("@aws-sdk/client-schemas"); // CommonJS import + * const client = new SchemasClient(config); + * const command = new DescribeSchemaCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeSchemaCommandInput} for command's `input` shape. + * @see {@link DescribeSchemaCommandOutput} for command's `response` shape. + * @see {@link SchemasClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeSchemaCommand extends $Command< DescribeSchemaCommandInput, diff --git a/clients/client-schemas/commands/GetCodeBindingSourceCommand.ts b/clients/client-schemas/commands/GetCodeBindingSourceCommand.ts index 34c1399e613b..6de802520012 100644 --- a/clients/client-schemas/commands/GetCodeBindingSourceCommand.ts +++ b/clients/client-schemas/commands/GetCodeBindingSourceCommand.ts @@ -22,6 +22,20 @@ export interface GetCodeBindingSourceCommandOutput extends GetCodeBindingSourceR /** *

Get the code binding source URI.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { SchemasClient, GetCodeBindingSourceCommand } from "@aws-sdk/client-schemas"; // ES Modules import + * // const { SchemasClient, GetCodeBindingSourceCommand } = require("@aws-sdk/client-schemas"); // CommonJS import + * const client = new SchemasClient(config); + * const command = new GetCodeBindingSourceCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetCodeBindingSourceCommandInput} for command's `input` shape. + * @see {@link GetCodeBindingSourceCommandOutput} for command's `response` shape. + * @see {@link SchemasClientResolvedConfig | config} for command's `input` shape. + * */ export class GetCodeBindingSourceCommand extends $Command< GetCodeBindingSourceCommandInput, diff --git a/clients/client-schemas/commands/GetDiscoveredSchemaCommand.ts b/clients/client-schemas/commands/GetDiscoveredSchemaCommand.ts index c02a530aba07..86799153512e 100644 --- a/clients/client-schemas/commands/GetDiscoveredSchemaCommand.ts +++ b/clients/client-schemas/commands/GetDiscoveredSchemaCommand.ts @@ -22,6 +22,20 @@ export interface GetDiscoveredSchemaCommandOutput extends GetDiscoveredSchemaRes /** *

Get the discovered schema that was generated based on sampled events.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { SchemasClient, GetDiscoveredSchemaCommand } from "@aws-sdk/client-schemas"; // ES Modules import + * // const { SchemasClient, GetDiscoveredSchemaCommand } = require("@aws-sdk/client-schemas"); // CommonJS import + * const client = new SchemasClient(config); + * const command = new GetDiscoveredSchemaCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetDiscoveredSchemaCommandInput} for command's `input` shape. + * @see {@link GetDiscoveredSchemaCommandOutput} for command's `response` shape. + * @see {@link SchemasClientResolvedConfig | config} for command's `input` shape. + * */ export class GetDiscoveredSchemaCommand extends $Command< GetDiscoveredSchemaCommandInput, diff --git a/clients/client-schemas/commands/GetResourcePolicyCommand.ts b/clients/client-schemas/commands/GetResourcePolicyCommand.ts index f9c84e25699c..4f550f7c5755 100644 --- a/clients/client-schemas/commands/GetResourcePolicyCommand.ts +++ b/clients/client-schemas/commands/GetResourcePolicyCommand.ts @@ -22,6 +22,20 @@ export interface GetResourcePolicyCommandOutput extends GetResourcePolicyRespons /** *

Retrieves the resource-based policy attached to a given registry.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { SchemasClient, GetResourcePolicyCommand } from "@aws-sdk/client-schemas"; // ES Modules import + * // const { SchemasClient, GetResourcePolicyCommand } = require("@aws-sdk/client-schemas"); // CommonJS import + * const client = new SchemasClient(config); + * const command = new GetResourcePolicyCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetResourcePolicyCommandInput} for command's `input` shape. + * @see {@link GetResourcePolicyCommandOutput} for command's `response` shape. + * @see {@link SchemasClientResolvedConfig | config} for command's `input` shape. + * */ export class GetResourcePolicyCommand extends $Command< GetResourcePolicyCommandInput, diff --git a/clients/client-schemas/commands/ListDiscoverersCommand.ts b/clients/client-schemas/commands/ListDiscoverersCommand.ts index bcb47532e71c..9e0ba8393661 100644 --- a/clients/client-schemas/commands/ListDiscoverersCommand.ts +++ b/clients/client-schemas/commands/ListDiscoverersCommand.ts @@ -22,6 +22,20 @@ export interface ListDiscoverersCommandOutput extends ListDiscoverersResponse, _ /** *

List the discoverers.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { SchemasClient, ListDiscoverersCommand } from "@aws-sdk/client-schemas"; // ES Modules import + * // const { SchemasClient, ListDiscoverersCommand } = require("@aws-sdk/client-schemas"); // CommonJS import + * const client = new SchemasClient(config); + * const command = new ListDiscoverersCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListDiscoverersCommandInput} for command's `input` shape. + * @see {@link ListDiscoverersCommandOutput} for command's `response` shape. + * @see {@link SchemasClientResolvedConfig | config} for command's `input` shape. + * */ export class ListDiscoverersCommand extends $Command< ListDiscoverersCommandInput, diff --git a/clients/client-schemas/commands/ListRegistriesCommand.ts b/clients/client-schemas/commands/ListRegistriesCommand.ts index 1f49088fd09f..dd5f2d3389c2 100644 --- a/clients/client-schemas/commands/ListRegistriesCommand.ts +++ b/clients/client-schemas/commands/ListRegistriesCommand.ts @@ -22,6 +22,20 @@ export interface ListRegistriesCommandOutput extends ListRegistriesResponse, __M /** *

List the registries.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { SchemasClient, ListRegistriesCommand } from "@aws-sdk/client-schemas"; // ES Modules import + * // const { SchemasClient, ListRegistriesCommand } = require("@aws-sdk/client-schemas"); // CommonJS import + * const client = new SchemasClient(config); + * const command = new ListRegistriesCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListRegistriesCommandInput} for command's `input` shape. + * @see {@link ListRegistriesCommandOutput} for command's `response` shape. + * @see {@link SchemasClientResolvedConfig | config} for command's `input` shape. + * */ export class ListRegistriesCommand extends $Command< ListRegistriesCommandInput, diff --git a/clients/client-schemas/commands/ListSchemaVersionsCommand.ts b/clients/client-schemas/commands/ListSchemaVersionsCommand.ts index 2d2d459e52be..fc5240f511f0 100644 --- a/clients/client-schemas/commands/ListSchemaVersionsCommand.ts +++ b/clients/client-schemas/commands/ListSchemaVersionsCommand.ts @@ -22,6 +22,20 @@ export interface ListSchemaVersionsCommandOutput extends ListSchemaVersionsRespo /** *

Provides a list of the schema versions and related information.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { SchemasClient, ListSchemaVersionsCommand } from "@aws-sdk/client-schemas"; // ES Modules import + * // const { SchemasClient, ListSchemaVersionsCommand } = require("@aws-sdk/client-schemas"); // CommonJS import + * const client = new SchemasClient(config); + * const command = new ListSchemaVersionsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListSchemaVersionsCommandInput} for command's `input` shape. + * @see {@link ListSchemaVersionsCommandOutput} for command's `response` shape. + * @see {@link SchemasClientResolvedConfig | config} for command's `input` shape. + * */ export class ListSchemaVersionsCommand extends $Command< ListSchemaVersionsCommandInput, diff --git a/clients/client-schemas/commands/ListSchemasCommand.ts b/clients/client-schemas/commands/ListSchemasCommand.ts index 5ee8a75257d5..d384d8d26ebd 100644 --- a/clients/client-schemas/commands/ListSchemasCommand.ts +++ b/clients/client-schemas/commands/ListSchemasCommand.ts @@ -22,6 +22,20 @@ export interface ListSchemasCommandOutput extends ListSchemasResponse, __Metadat /** *

List the schemas.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { SchemasClient, ListSchemasCommand } from "@aws-sdk/client-schemas"; // ES Modules import + * // const { SchemasClient, ListSchemasCommand } = require("@aws-sdk/client-schemas"); // CommonJS import + * const client = new SchemasClient(config); + * const command = new ListSchemasCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListSchemasCommandInput} for command's `input` shape. + * @see {@link ListSchemasCommandOutput} for command's `response` shape. + * @see {@link SchemasClientResolvedConfig | config} for command's `input` shape. + * */ export class ListSchemasCommand extends $Command< ListSchemasCommandInput, diff --git a/clients/client-schemas/commands/ListTagsForResourceCommand.ts b/clients/client-schemas/commands/ListTagsForResourceCommand.ts index e9a75c675366..f4f87208a077 100644 --- a/clients/client-schemas/commands/ListTagsForResourceCommand.ts +++ b/clients/client-schemas/commands/ListTagsForResourceCommand.ts @@ -22,6 +22,20 @@ export interface ListTagsForResourceCommandOutput extends ListTagsForResourceRes /** *

Get tags for resource.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { SchemasClient, ListTagsForResourceCommand } from "@aws-sdk/client-schemas"; // ES Modules import + * // const { SchemasClient, ListTagsForResourceCommand } = require("@aws-sdk/client-schemas"); // CommonJS import + * const client = new SchemasClient(config); + * const command = new ListTagsForResourceCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListTagsForResourceCommandInput} for command's `input` shape. + * @see {@link ListTagsForResourceCommandOutput} for command's `response` shape. + * @see {@link SchemasClientResolvedConfig | config} for command's `input` shape. + * */ export class ListTagsForResourceCommand extends $Command< ListTagsForResourceCommandInput, diff --git a/clients/client-schemas/commands/PutCodeBindingCommand.ts b/clients/client-schemas/commands/PutCodeBindingCommand.ts index af5fb251b528..17787bc8836a 100644 --- a/clients/client-schemas/commands/PutCodeBindingCommand.ts +++ b/clients/client-schemas/commands/PutCodeBindingCommand.ts @@ -22,6 +22,20 @@ export interface PutCodeBindingCommandOutput extends PutCodeBindingResponse, __M /** *

Put code binding URI

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { SchemasClient, PutCodeBindingCommand } from "@aws-sdk/client-schemas"; // ES Modules import + * // const { SchemasClient, PutCodeBindingCommand } = require("@aws-sdk/client-schemas"); // CommonJS import + * const client = new SchemasClient(config); + * const command = new PutCodeBindingCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link PutCodeBindingCommandInput} for command's `input` shape. + * @see {@link PutCodeBindingCommandOutput} for command's `response` shape. + * @see {@link SchemasClientResolvedConfig | config} for command's `input` shape. + * */ export class PutCodeBindingCommand extends $Command< PutCodeBindingCommandInput, diff --git a/clients/client-schemas/commands/PutResourcePolicyCommand.ts b/clients/client-schemas/commands/PutResourcePolicyCommand.ts index da1dc14476e5..9638d4ec94f2 100644 --- a/clients/client-schemas/commands/PutResourcePolicyCommand.ts +++ b/clients/client-schemas/commands/PutResourcePolicyCommand.ts @@ -22,6 +22,20 @@ export interface PutResourcePolicyCommandOutput extends PutResourcePolicyRespons /** *

The name of the policy.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { SchemasClient, PutResourcePolicyCommand } from "@aws-sdk/client-schemas"; // ES Modules import + * // const { SchemasClient, PutResourcePolicyCommand } = require("@aws-sdk/client-schemas"); // CommonJS import + * const client = new SchemasClient(config); + * const command = new PutResourcePolicyCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link PutResourcePolicyCommandInput} for command's `input` shape. + * @see {@link PutResourcePolicyCommandOutput} for command's `response` shape. + * @see {@link SchemasClientResolvedConfig | config} for command's `input` shape. + * */ export class PutResourcePolicyCommand extends $Command< PutResourcePolicyCommandInput, diff --git a/clients/client-schemas/commands/SearchSchemasCommand.ts b/clients/client-schemas/commands/SearchSchemasCommand.ts index 03fada75932b..4ebbf4f4152a 100644 --- a/clients/client-schemas/commands/SearchSchemasCommand.ts +++ b/clients/client-schemas/commands/SearchSchemasCommand.ts @@ -22,6 +22,20 @@ export interface SearchSchemasCommandOutput extends SearchSchemasResponse, __Met /** *

Search the schemas

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { SchemasClient, SearchSchemasCommand } from "@aws-sdk/client-schemas"; // ES Modules import + * // const { SchemasClient, SearchSchemasCommand } = require("@aws-sdk/client-schemas"); // CommonJS import + * const client = new SchemasClient(config); + * const command = new SearchSchemasCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link SearchSchemasCommandInput} for command's `input` shape. + * @see {@link SearchSchemasCommandOutput} for command's `response` shape. + * @see {@link SchemasClientResolvedConfig | config} for command's `input` shape. + * */ export class SearchSchemasCommand extends $Command< SearchSchemasCommandInput, diff --git a/clients/client-schemas/commands/StartDiscovererCommand.ts b/clients/client-schemas/commands/StartDiscovererCommand.ts index b721a76e41f4..13f212d33d1f 100644 --- a/clients/client-schemas/commands/StartDiscovererCommand.ts +++ b/clients/client-schemas/commands/StartDiscovererCommand.ts @@ -22,6 +22,20 @@ export interface StartDiscovererCommandOutput extends StartDiscovererResponse, _ /** *

Starts the discoverer

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { SchemasClient, StartDiscovererCommand } from "@aws-sdk/client-schemas"; // ES Modules import + * // const { SchemasClient, StartDiscovererCommand } = require("@aws-sdk/client-schemas"); // CommonJS import + * const client = new SchemasClient(config); + * const command = new StartDiscovererCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link StartDiscovererCommandInput} for command's `input` shape. + * @see {@link StartDiscovererCommandOutput} for command's `response` shape. + * @see {@link SchemasClientResolvedConfig | config} for command's `input` shape. + * */ export class StartDiscovererCommand extends $Command< StartDiscovererCommandInput, diff --git a/clients/client-schemas/commands/StopDiscovererCommand.ts b/clients/client-schemas/commands/StopDiscovererCommand.ts index 95ad8e7b8405..7a23fdedd532 100644 --- a/clients/client-schemas/commands/StopDiscovererCommand.ts +++ b/clients/client-schemas/commands/StopDiscovererCommand.ts @@ -22,6 +22,20 @@ export interface StopDiscovererCommandOutput extends StopDiscovererResponse, __M /** *

Stops the discoverer

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { SchemasClient, StopDiscovererCommand } from "@aws-sdk/client-schemas"; // ES Modules import + * // const { SchemasClient, StopDiscovererCommand } = require("@aws-sdk/client-schemas"); // CommonJS import + * const client = new SchemasClient(config); + * const command = new StopDiscovererCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link StopDiscovererCommandInput} for command's `input` shape. + * @see {@link StopDiscovererCommandOutput} for command's `response` shape. + * @see {@link SchemasClientResolvedConfig | config} for command's `input` shape. + * */ export class StopDiscovererCommand extends $Command< StopDiscovererCommandInput, diff --git a/clients/client-schemas/commands/TagResourceCommand.ts b/clients/client-schemas/commands/TagResourceCommand.ts index 0f0bba1c29b7..bd61553c2219 100644 --- a/clients/client-schemas/commands/TagResourceCommand.ts +++ b/clients/client-schemas/commands/TagResourceCommand.ts @@ -22,6 +22,20 @@ export interface TagResourceCommandOutput extends __MetadataBearer {} /** *

Add tags to a resource.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { SchemasClient, TagResourceCommand } from "@aws-sdk/client-schemas"; // ES Modules import + * // const { SchemasClient, TagResourceCommand } = require("@aws-sdk/client-schemas"); // CommonJS import + * const client = new SchemasClient(config); + * const command = new TagResourceCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link TagResourceCommandInput} for command's `input` shape. + * @see {@link TagResourceCommandOutput} for command's `response` shape. + * @see {@link SchemasClientResolvedConfig | config} for command's `input` shape. + * */ export class TagResourceCommand extends $Command< TagResourceCommandInput, diff --git a/clients/client-schemas/commands/UntagResourceCommand.ts b/clients/client-schemas/commands/UntagResourceCommand.ts index 029b17c77184..7e906b0a4aea 100644 --- a/clients/client-schemas/commands/UntagResourceCommand.ts +++ b/clients/client-schemas/commands/UntagResourceCommand.ts @@ -22,6 +22,20 @@ export interface UntagResourceCommandOutput extends __MetadataBearer {} /** *

Removes tags from a resource.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { SchemasClient, UntagResourceCommand } from "@aws-sdk/client-schemas"; // ES Modules import + * // const { SchemasClient, UntagResourceCommand } = require("@aws-sdk/client-schemas"); // CommonJS import + * const client = new SchemasClient(config); + * const command = new UntagResourceCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link UntagResourceCommandInput} for command's `input` shape. + * @see {@link UntagResourceCommandOutput} for command's `response` shape. + * @see {@link SchemasClientResolvedConfig | config} for command's `input` shape. + * */ export class UntagResourceCommand extends $Command< UntagResourceCommandInput, diff --git a/clients/client-schemas/commands/UpdateDiscovererCommand.ts b/clients/client-schemas/commands/UpdateDiscovererCommand.ts index b791e3181008..c3cf0f02eaf7 100644 --- a/clients/client-schemas/commands/UpdateDiscovererCommand.ts +++ b/clients/client-schemas/commands/UpdateDiscovererCommand.ts @@ -22,6 +22,20 @@ export interface UpdateDiscovererCommandOutput extends UpdateDiscovererResponse, /** *

Updates the discoverer

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { SchemasClient, UpdateDiscovererCommand } from "@aws-sdk/client-schemas"; // ES Modules import + * // const { SchemasClient, UpdateDiscovererCommand } = require("@aws-sdk/client-schemas"); // CommonJS import + * const client = new SchemasClient(config); + * const command = new UpdateDiscovererCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link UpdateDiscovererCommandInput} for command's `input` shape. + * @see {@link UpdateDiscovererCommandOutput} for command's `response` shape. + * @see {@link SchemasClientResolvedConfig | config} for command's `input` shape. + * */ export class UpdateDiscovererCommand extends $Command< UpdateDiscovererCommandInput, diff --git a/clients/client-schemas/commands/UpdateRegistryCommand.ts b/clients/client-schemas/commands/UpdateRegistryCommand.ts index e89673041832..dfc4f3eb82d9 100644 --- a/clients/client-schemas/commands/UpdateRegistryCommand.ts +++ b/clients/client-schemas/commands/UpdateRegistryCommand.ts @@ -22,6 +22,20 @@ export interface UpdateRegistryCommandOutput extends UpdateRegistryResponse, __M /** *

Updates a registry.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { SchemasClient, UpdateRegistryCommand } from "@aws-sdk/client-schemas"; // ES Modules import + * // const { SchemasClient, UpdateRegistryCommand } = require("@aws-sdk/client-schemas"); // CommonJS import + * const client = new SchemasClient(config); + * const command = new UpdateRegistryCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link UpdateRegistryCommandInput} for command's `input` shape. + * @see {@link UpdateRegistryCommandOutput} for command's `response` shape. + * @see {@link SchemasClientResolvedConfig | config} for command's `input` shape. + * */ export class UpdateRegistryCommand extends $Command< UpdateRegistryCommandInput, diff --git a/clients/client-schemas/commands/UpdateSchemaCommand.ts b/clients/client-schemas/commands/UpdateSchemaCommand.ts index 7bc98c54cd65..6c4719c4d240 100644 --- a/clients/client-schemas/commands/UpdateSchemaCommand.ts +++ b/clients/client-schemas/commands/UpdateSchemaCommand.ts @@ -22,6 +22,20 @@ export interface UpdateSchemaCommandOutput extends UpdateSchemaResponse, __Metad /** *

Updates the schema definition

Inactive schemas will be deleted after two years.

 + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { SchemasClient, UpdateSchemaCommand } from "@aws-sdk/client-schemas"; // ES Modules import + * // const { SchemasClient, UpdateSchemaCommand } = require("@aws-sdk/client-schemas"); // CommonJS import + * const client = new SchemasClient(config); + * const command = new UpdateSchemaCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link UpdateSchemaCommandInput} for command's `input` shape. + * @see {@link UpdateSchemaCommandOutput} for command's `response` shape. + * @see {@link SchemasClientResolvedConfig | config} for command's `input` shape. + * */ export class UpdateSchemaCommand extends $Command< UpdateSchemaCommandInput, diff --git a/clients/client-schemas/models/models_0.ts b/clients/client-schemas/models/models_0.ts index cd53421a9546..b6769cc60476 100644 --- a/clients/client-schemas/models/models_0.ts +++ b/clients/client-schemas/models/models_0.ts @@ -34,6 +34,9 @@ export interface DiscovererSummary { } export namespace DiscovererSummary { + /** + * @internal + */ export const filterSensitiveLog = (obj: DiscovererSummary): any => ({ ...obj, }); @@ -57,6 +60,9 @@ export interface RegistrySummary { } export namespace RegistrySummary { + /** + * @internal + */ export const filterSensitiveLog = (obj: RegistrySummary): any => ({ ...obj, }); @@ -93,6 +99,9 @@ export interface SchemaSummary { } export namespace SchemaSummary { + /** + * @internal + */ export const filterSensitiveLog = (obj: SchemaSummary): any => ({ ...obj, }); @@ -126,6 +135,9 @@ export interface SchemaVersionSummary { } export namespace SchemaVersionSummary { + /** + * @internal + */ export const filterSensitiveLog = (obj: SchemaVersionSummary): any => ({ ...obj, }); @@ -149,6 +161,9 @@ export interface SearchSchemaVersionSummary { } export namespace SearchSchemaVersionSummary { + /** + * @internal + */ export const filterSensitiveLog = (obj: SearchSchemaVersionSummary): any => ({ ...obj, }); @@ -177,6 +192,9 @@ export interface SearchSchemaSummary { } export namespace SearchSchemaSummary { + /** + * @internal + */ export const filterSensitiveLog = (obj: SearchSchemaSummary): any => ({ ...obj, }); @@ -197,6 +215,9 @@ export interface BadRequestException extends __SmithyException, $MetadataBearer } export namespace BadRequestException { + /** + * @internal + */ export const filterSensitiveLog = (obj: BadRequestException): any => ({ ...obj, }); @@ -223,6 +244,9 @@ export interface ConflictException extends __SmithyException, $MetadataBearer { } export namespace ConflictException { + /** + * @internal + */ export const filterSensitiveLog = (obj: ConflictException): any => ({ ...obj, }); @@ -246,6 +270,9 @@ export interface CreateDiscovererRequest { } export namespace CreateDiscovererRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateDiscovererRequest): any => ({ ...obj, }); @@ -284,6 +311,9 @@ export interface CreateDiscovererResponse { } export namespace CreateDiscovererResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateDiscovererResponse): any => ({ ...obj, }); @@ -304,6 +334,9 @@ export interface ForbiddenException extends __SmithyException, $MetadataBearer { } export namespace ForbiddenException { + /** + * @internal + */ export const filterSensitiveLog = (obj: ForbiddenException): any => ({ ...obj, }); @@ -324,6 +357,9 @@ export interface InternalServerErrorException extends __SmithyException, $Metada } export namespace InternalServerErrorException { + /** + * @internal + */ export const filterSensitiveLog = (obj: InternalServerErrorException): any => ({ ...obj, }); @@ -344,6 +380,9 @@ export interface ServiceUnavailableException extends __SmithyException, $Metadat } export namespace ServiceUnavailableException { + /** + * @internal + */ export const filterSensitiveLog = (obj: ServiceUnavailableException): any => ({ ...obj, }); @@ -364,6 +403,9 @@ export interface UnauthorizedException extends __SmithyException, $MetadataBeare } export namespace UnauthorizedException { + /** + * @internal + */ export const filterSensitiveLog = (obj: UnauthorizedException): any => ({ ...obj, }); @@ -387,6 +429,9 @@ export interface CreateRegistryRequest { } export namespace CreateRegistryRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateRegistryRequest): any => ({ ...obj, }); @@ -415,6 +460,9 @@ export interface CreateRegistryResponse { } export namespace CreateRegistryResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateRegistryResponse): any => ({ ...obj, }); @@ -453,6 +501,9 @@ export interface CreateSchemaRequest { } export namespace CreateSchemaRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateSchemaRequest): any => ({ ...obj, }); @@ -501,6 +552,9 @@ export interface CreateSchemaResponse { } export namespace CreateSchemaResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateSchemaResponse): any => ({ ...obj, }); @@ -514,6 +568,9 @@ export interface DeleteDiscovererRequest { } export namespace DeleteDiscovererRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteDiscovererRequest): any => ({ ...obj, }); @@ -534,6 +591,9 @@ export interface NotFoundException extends __SmithyException, $MetadataBearer { } export namespace NotFoundException { + /** + * @internal + */ export const filterSensitiveLog = (obj: NotFoundException): any => ({ ...obj, }); @@ -547,6 +607,9 @@ export interface DeleteRegistryRequest { } export namespace DeleteRegistryRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteRegistryRequest): any => ({ ...obj, }); @@ -560,6 +623,9 @@ export interface DeleteResourcePolicyRequest { } export namespace DeleteResourcePolicyRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteResourcePolicyRequest): any => ({ ...obj, }); @@ -578,6 +644,9 @@ export interface DeleteSchemaRequest { } export namespace DeleteSchemaRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteSchemaRequest): any => ({ ...obj, }); @@ -601,6 +670,9 @@ export interface DeleteSchemaVersionRequest { } export namespace DeleteSchemaVersionRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteSchemaVersionRequest): any => ({ ...obj, }); @@ -629,6 +701,9 @@ export interface DescribeCodeBindingRequest { } export namespace DescribeCodeBindingRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeCodeBindingRequest): any => ({ ...obj, }); @@ -657,6 +732,9 @@ export interface DescribeCodeBindingResponse { } export namespace DescribeCodeBindingResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeCodeBindingResponse): any => ({ ...obj, }); @@ -677,6 +755,9 @@ export interface TooManyRequestsException extends __SmithyException, $MetadataBe } export namespace TooManyRequestsException { + /** + * @internal + */ export const filterSensitiveLog = (obj: TooManyRequestsException): any => ({ ...obj, }); @@ -690,6 +771,9 @@ export interface DescribeDiscovererRequest { } export namespace DescribeDiscovererRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeDiscovererRequest): any => ({ ...obj, }); @@ -728,6 +812,9 @@ export interface DescribeDiscovererResponse { } export namespace DescribeDiscovererResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeDiscovererResponse): any => ({ ...obj, }); @@ -741,6 +828,9 @@ export interface DescribeRegistryRequest { } export namespace DescribeRegistryRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeRegistryRequest): any => ({ ...obj, }); @@ -769,6 +859,9 @@ export interface DescribeRegistryResponse { } export namespace DescribeRegistryResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeRegistryResponse): any => ({ ...obj, }); @@ -792,6 +885,9 @@ export interface DescribeSchemaRequest { } export namespace DescribeSchemaRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeSchemaRequest): any => ({ ...obj, }); @@ -845,6 +941,9 @@ export interface DescribeSchemaResponse { } export namespace DescribeSchemaResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeSchemaResponse): any => ({ ...obj, }); @@ -870,6 +969,9 @@ export interface ExportSchemaRequest { } export namespace ExportSchemaRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ExportSchemaRequest): any => ({ ...obj, }); @@ -884,6 +986,9 @@ export interface ExportSchemaResponse { } export namespace ExportSchemaResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ExportSchemaResponse): any => ({ ...obj, }); @@ -912,6 +1017,9 @@ export interface GetCodeBindingSourceRequest { } export namespace GetCodeBindingSourceRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetCodeBindingSourceRequest): any => ({ ...obj, }); @@ -922,6 +1030,9 @@ export interface GetCodeBindingSourceResponse { } export namespace GetCodeBindingSourceResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetCodeBindingSourceResponse): any => ({ ...obj, }); @@ -940,6 +1051,9 @@ export interface GetDiscoveredSchemaRequest { } export namespace GetDiscoveredSchemaRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetDiscoveredSchemaRequest): any => ({ ...obj, }); @@ -953,6 +1067,9 @@ export interface GetDiscoveredSchemaResponse { } export namespace GetDiscoveredSchemaResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetDiscoveredSchemaResponse): any => ({ ...obj, }); @@ -966,6 +1083,9 @@ export interface GetResourcePolicyRequest { } export namespace GetResourcePolicyRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetResourcePolicyRequest): any => ({ ...obj, }); @@ -984,6 +1104,9 @@ export interface GetResourcePolicyResponse { } export namespace GetResourcePolicyResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetResourcePolicyResponse): any => ({ ...obj, }); @@ -1004,6 +1127,9 @@ export interface GoneException extends __SmithyException, $MetadataBearer { } export namespace GoneException { + /** + * @internal + */ export const filterSensitiveLog = (obj: GoneException): any => ({ ...obj, }); @@ -1028,6 +1154,9 @@ export interface ListDiscoverersRequest { } export namespace ListDiscoverersRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListDiscoverersRequest): any => ({ ...obj, }); @@ -1046,6 +1175,9 @@ export interface ListDiscoverersResponse { } export namespace ListDiscoverersResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListDiscoverersResponse): any => ({ ...obj, }); @@ -1070,6 +1202,9 @@ export interface ListRegistriesRequest { } export namespace ListRegistriesRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListRegistriesRequest): any => ({ ...obj, }); @@ -1088,6 +1223,9 @@ export interface ListRegistriesResponse { } export namespace ListRegistriesResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListRegistriesResponse): any => ({ ...obj, }); @@ -1112,6 +1250,9 @@ export interface ListSchemasRequest { } export namespace ListSchemasRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListSchemasRequest): any => ({ ...obj, }); @@ -1130,6 +1271,9 @@ export interface ListSchemasResponse { } export namespace ListSchemasResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListSchemasResponse): any => ({ ...obj, }); @@ -1154,6 +1298,9 @@ export interface ListSchemaVersionsRequest { } export namespace ListSchemaVersionsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListSchemaVersionsRequest): any => ({ ...obj, }); @@ -1172,6 +1319,9 @@ export interface ListSchemaVersionsResponse { } export namespace ListSchemaVersionsResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListSchemaVersionsResponse): any => ({ ...obj, }); @@ -1185,6 +1335,9 @@ export interface ListTagsForResourceRequest { } export namespace ListTagsForResourceRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListTagsForResourceRequest): any => ({ ...obj, }); @@ -1198,6 +1351,9 @@ export interface ListTagsForResourceResponse { } export namespace ListTagsForResourceResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListTagsForResourceResponse): any => ({ ...obj, }); @@ -1218,6 +1374,9 @@ export interface PreconditionFailedException extends __SmithyException, $Metadat } export namespace PreconditionFailedException { + /** + * @internal + */ export const filterSensitiveLog = (obj: PreconditionFailedException): any => ({ ...obj, }); @@ -1246,6 +1405,9 @@ export interface PutCodeBindingRequest { } export namespace PutCodeBindingRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: PutCodeBindingRequest): any => ({ ...obj, }); @@ -1274,6 +1436,9 @@ export interface PutCodeBindingResponse { } export namespace PutCodeBindingResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: PutCodeBindingResponse): any => ({ ...obj, }); @@ -1300,6 +1465,9 @@ export interface PutResourcePolicyRequest { } export namespace PutResourcePolicyRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: PutResourcePolicyRequest): any => ({ ...obj, }); @@ -1318,6 +1486,9 @@ export interface PutResourcePolicyResponse { } export namespace PutResourcePolicyResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: PutResourcePolicyResponse): any => ({ ...obj, }); @@ -1342,6 +1513,9 @@ export interface SearchSchemasRequest { } export namespace SearchSchemasRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: SearchSchemasRequest): any => ({ ...obj, }); @@ -1360,6 +1534,9 @@ export interface SearchSchemasResponse { } export namespace SearchSchemasResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: SearchSchemasResponse): any => ({ ...obj, }); @@ -1373,6 +1550,9 @@ export interface StartDiscovererRequest { } export namespace StartDiscovererRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: StartDiscovererRequest): any => ({ ...obj, }); @@ -1391,6 +1571,9 @@ export interface StartDiscovererResponse { } export namespace StartDiscovererResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: StartDiscovererResponse): any => ({ ...obj, }); @@ -1404,6 +1587,9 @@ export interface StopDiscovererRequest { } export namespace StopDiscovererRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: StopDiscovererRequest): any => ({ ...obj, }); @@ -1422,6 +1608,9 @@ export interface StopDiscovererResponse { } export namespace StopDiscovererResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: StopDiscovererResponse): any => ({ ...obj, }); @@ -1443,6 +1632,9 @@ export interface TagResourceRequest { } export namespace TagResourceRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: TagResourceRequest): any => ({ ...obj, }); @@ -1461,6 +1653,9 @@ export interface UntagResourceRequest { } export namespace UntagResourceRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: UntagResourceRequest): any => ({ ...obj, }); @@ -1479,6 +1674,9 @@ export interface UpdateDiscovererRequest { } export namespace UpdateDiscovererRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateDiscovererRequest): any => ({ ...obj, }); @@ -1517,6 +1715,9 @@ export interface UpdateDiscovererResponse { } export namespace UpdateDiscovererResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateDiscovererResponse): any => ({ ...obj, }); @@ -1538,6 +1739,9 @@ export interface UpdateRegistryRequest { } export namespace UpdateRegistryRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateRegistryRequest): any => ({ ...obj, }); @@ -1566,6 +1770,9 @@ export interface UpdateRegistryResponse { } export namespace UpdateRegistryResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateRegistryResponse): any => ({ ...obj, }); @@ -1604,6 +1811,9 @@ export interface UpdateSchemaRequest { } export namespace UpdateSchemaRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateSchemaRequest): any => ({ ...obj, }); @@ -1652,6 +1862,9 @@ export interface UpdateSchemaResponse { } export namespace UpdateSchemaResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateSchemaResponse): any => ({ ...obj, }); diff --git a/clients/client-secrets-manager/commands/CancelRotateSecretCommand.ts b/clients/client-secrets-manager/commands/CancelRotateSecretCommand.ts index 763d4361c9d5..17fe9864c8a3 100644 --- a/clients/client-secrets-manager/commands/CancelRotateSecretCommand.ts +++ b/clients/client-secrets-manager/commands/CancelRotateSecretCommand.ts @@ -74,6 +74,20 @@ export interface CancelRotateSecretCommandOutput extends CancelRotateSecretRespo *

To list all of the versions currently associated with a secret, use ListSecretVersionIds.

* * + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { SecretsManagerClient, CancelRotateSecretCommand } from "@aws-sdk/client-secrets-manager"; // ES Modules import + * // const { SecretsManagerClient, CancelRotateSecretCommand } = require("@aws-sdk/client-secrets-manager"); // CommonJS import + * const client = new SecretsManagerClient(config); + * const command = new CancelRotateSecretCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CancelRotateSecretCommandInput} for command's `input` shape. + * @see {@link CancelRotateSecretCommandOutput} for command's `response` shape. + * @see {@link SecretsManagerClientResolvedConfig | config} for command's `input` shape. + * */ export class CancelRotateSecretCommand extends $Command< CancelRotateSecretCommandInput, diff --git a/clients/client-secrets-manager/commands/CreateSecretCommand.ts b/clients/client-secrets-manager/commands/CreateSecretCommand.ts index 0e303504d91d..b1ade620f48a 100644 --- a/clients/client-secrets-manager/commands/CreateSecretCommand.ts +++ b/clients/client-secrets-manager/commands/CreateSecretCommand.ts @@ -109,6 +109,20 @@ export interface CreateSecretCommandOutput extends CreateSecretResponse, __Metad * value.

* * + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { SecretsManagerClient, CreateSecretCommand } from "@aws-sdk/client-secrets-manager"; // ES Modules import + * // const { SecretsManagerClient, CreateSecretCommand } = require("@aws-sdk/client-secrets-manager"); // CommonJS import + * const client = new SecretsManagerClient(config); + * const command = new CreateSecretCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreateSecretCommandInput} for command's `input` shape. + * @see {@link CreateSecretCommandOutput} for command's `response` shape. + * @see {@link SecretsManagerClientResolvedConfig | config} for command's `input` shape. + * */ export class CreateSecretCommand extends $Command< CreateSecretCommandInput, diff --git a/clients/client-secrets-manager/commands/DeleteResourcePolicyCommand.ts b/clients/client-secrets-manager/commands/DeleteResourcePolicyCommand.ts index 939b631d839f..351ad908832d 100644 --- a/clients/client-secrets-manager/commands/DeleteResourcePolicyCommand.ts +++ b/clients/client-secrets-manager/commands/DeleteResourcePolicyCommand.ts @@ -45,6 +45,20 @@ export interface DeleteResourcePolicyCommandOutput extends DeleteResourcePolicyR *

To list all of the currently available secrets, use ListSecrets.

* * + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { SecretsManagerClient, DeleteResourcePolicyCommand } from "@aws-sdk/client-secrets-manager"; // ES Modules import + * // const { SecretsManagerClient, DeleteResourcePolicyCommand } = require("@aws-sdk/client-secrets-manager"); // CommonJS import + * const client = new SecretsManagerClient(config); + * const command = new DeleteResourcePolicyCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteResourcePolicyCommandInput} for command's `input` shape. + * @see {@link DeleteResourcePolicyCommandOutput} for command's `response` shape. + * @see {@link SecretsManagerClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteResourcePolicyCommand extends $Command< DeleteResourcePolicyCommandInput, diff --git a/clients/client-secrets-manager/commands/DeleteSecretCommand.ts b/clients/client-secrets-manager/commands/DeleteSecretCommand.ts index c0bbbfeb0c8e..d53824b6f053 100644 --- a/clients/client-secrets-manager/commands/DeleteSecretCommand.ts +++ b/clients/client-secrets-manager/commands/DeleteSecretCommand.ts @@ -67,6 +67,20 @@ export interface DeleteSecretCommandOutput extends DeleteSecretResponse, __Metad * use RestoreSecret.

* * + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { SecretsManagerClient, DeleteSecretCommand } from "@aws-sdk/client-secrets-manager"; // ES Modules import + * // const { SecretsManagerClient, DeleteSecretCommand } = require("@aws-sdk/client-secrets-manager"); // CommonJS import + * const client = new SecretsManagerClient(config); + * const command = new DeleteSecretCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteSecretCommandInput} for command's `input` shape. + * @see {@link DeleteSecretCommandOutput} for command's `response` shape. + * @see {@link SecretsManagerClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteSecretCommand extends $Command< DeleteSecretCommandInput, diff --git a/clients/client-secrets-manager/commands/DescribeSecretCommand.ts b/clients/client-secrets-manager/commands/DescribeSecretCommand.ts index 993e24e19f13..0dc71069e064 100644 --- a/clients/client-secrets-manager/commands/DescribeSecretCommand.ts +++ b/clients/client-secrets-manager/commands/DescribeSecretCommand.ts @@ -49,6 +49,20 @@ export interface DescribeSecretCommandOutput extends DescribeSecretResponse, __M *

To list all of the secrets in the AWS account, use ListSecrets.

* * + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { SecretsManagerClient, DescribeSecretCommand } from "@aws-sdk/client-secrets-manager"; // ES Modules import + * // const { SecretsManagerClient, DescribeSecretCommand } = require("@aws-sdk/client-secrets-manager"); // CommonJS import + * const client = new SecretsManagerClient(config); + * const command = new DescribeSecretCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeSecretCommandInput} for command's `input` shape. + * @see {@link DescribeSecretCommandOutput} for command's `response` shape. + * @see {@link SecretsManagerClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeSecretCommand extends $Command< DescribeSecretCommandInput, diff --git a/clients/client-secrets-manager/commands/GetRandomPasswordCommand.ts b/clients/client-secrets-manager/commands/GetRandomPasswordCommand.ts index ed0fdd24f596..e2b9cea29d64 100644 --- a/clients/client-secrets-manager/commands/GetRandomPasswordCommand.ts +++ b/clients/client-secrets-manager/commands/GetRandomPasswordCommand.ts @@ -34,6 +34,20 @@ export interface GetRandomPasswordCommandOutput extends GetRandomPasswordRespons *

secretsmanager:GetRandomPassword

* * + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { SecretsManagerClient, GetRandomPasswordCommand } from "@aws-sdk/client-secrets-manager"; // ES Modules import + * // const { SecretsManagerClient, GetRandomPasswordCommand } = require("@aws-sdk/client-secrets-manager"); // CommonJS import + * const client = new SecretsManagerClient(config); + * const command = new GetRandomPasswordCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetRandomPasswordCommandInput} for command's `input` shape. + * @see {@link GetRandomPasswordCommandOutput} for command's `response` shape. + * @see {@link SecretsManagerClientResolvedConfig | config} for command's `input` shape. + * */ export class GetRandomPasswordCommand extends $Command< GetRandomPasswordCommandInput, diff --git a/clients/client-secrets-manager/commands/GetResourcePolicyCommand.ts b/clients/client-secrets-manager/commands/GetResourcePolicyCommand.ts index 3c5e95274e84..fe0903da5790 100644 --- a/clients/client-secrets-manager/commands/GetResourcePolicyCommand.ts +++ b/clients/client-secrets-manager/commands/GetResourcePolicyCommand.ts @@ -48,6 +48,20 @@ export interface GetResourcePolicyCommandOutput extends GetResourcePolicyRespons *

To list all of the currently available secrets, use ListSecrets.

* * + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { SecretsManagerClient, GetResourcePolicyCommand } from "@aws-sdk/client-secrets-manager"; // ES Modules import + * // const { SecretsManagerClient, GetResourcePolicyCommand } = require("@aws-sdk/client-secrets-manager"); // CommonJS import + * const client = new SecretsManagerClient(config); + * const command = new GetResourcePolicyCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetResourcePolicyCommandInput} for command's `input` shape. + * @see {@link GetResourcePolicyCommandOutput} for command's `response` shape. + * @see {@link SecretsManagerClientResolvedConfig | config} for command's `input` shape. + * */ export class GetResourcePolicyCommand extends $Command< GetResourcePolicyCommandInput, diff --git a/clients/client-secrets-manager/commands/GetSecretValueCommand.ts b/clients/client-secrets-manager/commands/GetSecretValueCommand.ts index 34ee8ab56b5e..6c58951813c3 100644 --- a/clients/client-secrets-manager/commands/GetSecretValueCommand.ts +++ b/clients/client-secrets-manager/commands/GetSecretValueCommand.ts @@ -49,6 +49,20 @@ export interface GetSecretValueCommandOutput extends GetSecretValueResponse, __M *

To retrieve the non-encrypted details for the secret, use DescribeSecret.

* * + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { SecretsManagerClient, GetSecretValueCommand } from "@aws-sdk/client-secrets-manager"; // ES Modules import + * // const { SecretsManagerClient, GetSecretValueCommand } = require("@aws-sdk/client-secrets-manager"); // CommonJS import + * const client = new SecretsManagerClient(config); + * const command = new GetSecretValueCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetSecretValueCommandInput} for command's `input` shape. + * @see {@link GetSecretValueCommandOutput} for command's `response` shape. + * @see {@link SecretsManagerClientResolvedConfig | config} for command's `input` shape. + * */ export class GetSecretValueCommand extends $Command< GetSecretValueCommandInput, diff --git a/clients/client-secrets-manager/commands/ListSecretVersionIdsCommand.ts b/clients/client-secrets-manager/commands/ListSecretVersionIdsCommand.ts index 859a2d92e77a..bab130acbfda 100644 --- a/clients/client-secrets-manager/commands/ListSecretVersionIdsCommand.ts +++ b/clients/client-secrets-manager/commands/ListSecretVersionIdsCommand.ts @@ -50,6 +50,20 @@ export interface ListSecretVersionIdsCommandOutput extends ListSecretVersionIdsR *

To list the secrets in an account, use ListSecrets.

* * + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { SecretsManagerClient, ListSecretVersionIdsCommand } from "@aws-sdk/client-secrets-manager"; // ES Modules import + * // const { SecretsManagerClient, ListSecretVersionIdsCommand } = require("@aws-sdk/client-secrets-manager"); // CommonJS import + * const client = new SecretsManagerClient(config); + * const command = new ListSecretVersionIdsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListSecretVersionIdsCommandInput} for command's `input` shape. + * @see {@link ListSecretVersionIdsCommandOutput} for command's `response` shape. + * @see {@link SecretsManagerClientResolvedConfig | config} for command's `input` shape. + * */ export class ListSecretVersionIdsCommand extends $Command< ListSecretVersionIdsCommandInput, diff --git a/clients/client-secrets-manager/commands/ListSecretsCommand.ts b/clients/client-secrets-manager/commands/ListSecretsCommand.ts index 3ff6753a2064..b3e846b66f9d 100644 --- a/clients/client-secrets-manager/commands/ListSecretsCommand.ts +++ b/clients/client-secrets-manager/commands/ListSecretsCommand.ts @@ -51,6 +51,20 @@ export interface ListSecretsCommandOutput extends ListSecretsResponse, __Metadat *

To list the versions attached to a secret, use ListSecretVersionIds.

* * + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { SecretsManagerClient, ListSecretsCommand } from "@aws-sdk/client-secrets-manager"; // ES Modules import + * // const { SecretsManagerClient, ListSecretsCommand } = require("@aws-sdk/client-secrets-manager"); // CommonJS import + * const client = new SecretsManagerClient(config); + * const command = new ListSecretsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListSecretsCommandInput} for command's `input` shape. + * @see {@link ListSecretsCommandOutput} for command's `response` shape. + * @see {@link SecretsManagerClientResolvedConfig | config} for command's `input` shape. + * */ export class ListSecretsCommand extends $Command< ListSecretsCommandInput, diff --git a/clients/client-secrets-manager/commands/PutResourcePolicyCommand.ts b/clients/client-secrets-manager/commands/PutResourcePolicyCommand.ts index 0cb05be7ac91..d8b2bdef01c8 100644 --- a/clients/client-secrets-manager/commands/PutResourcePolicyCommand.ts +++ b/clients/client-secrets-manager/commands/PutResourcePolicyCommand.ts @@ -53,6 +53,20 @@ export interface PutResourcePolicyCommandOutput extends PutResourcePolicyRespons *

To list all of the currently available secrets, use ListSecrets.

* * + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { SecretsManagerClient, PutResourcePolicyCommand } from "@aws-sdk/client-secrets-manager"; // ES Modules import + * // const { SecretsManagerClient, PutResourcePolicyCommand } = require("@aws-sdk/client-secrets-manager"); // CommonJS import + * const client = new SecretsManagerClient(config); + * const command = new PutResourcePolicyCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link PutResourcePolicyCommandInput} for command's `input` shape. + * @see {@link PutResourcePolicyCommandOutput} for command's `response` shape. + * @see {@link SecretsManagerClientResolvedConfig | config} for command's `input` shape. + * */ export class PutResourcePolicyCommand extends $Command< PutResourcePolicyCommandInput, diff --git a/clients/client-secrets-manager/commands/PutSecretValueCommand.ts b/clients/client-secrets-manager/commands/PutSecretValueCommand.ts index 476d02be5c9e..2b2725044979 100644 --- a/clients/client-secrets-manager/commands/PutSecretValueCommand.ts +++ b/clients/client-secrets-manager/commands/PutSecretValueCommand.ts @@ -109,6 +109,20 @@ export interface PutSecretValueCommandOutput extends PutSecretValueResponse, __M *

To list the versions attached to a secret, use ListSecretVersionIds.

* * + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { SecretsManagerClient, PutSecretValueCommand } from "@aws-sdk/client-secrets-manager"; // ES Modules import + * // const { SecretsManagerClient, PutSecretValueCommand } = require("@aws-sdk/client-secrets-manager"); // CommonJS import + * const client = new SecretsManagerClient(config); + * const command = new PutSecretValueCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link PutSecretValueCommandInput} for command's `input` shape. + * @see {@link PutSecretValueCommandOutput} for command's `response` shape. + * @see {@link SecretsManagerClientResolvedConfig | config} for command's `input` shape. + * */ export class PutSecretValueCommand extends $Command< PutSecretValueCommandInput, diff --git a/clients/client-secrets-manager/commands/RemoveRegionsFromReplicationCommand.ts b/clients/client-secrets-manager/commands/RemoveRegionsFromReplicationCommand.ts index aa96f3c0ad42..e19bc654bbde 100644 --- a/clients/client-secrets-manager/commands/RemoveRegionsFromReplicationCommand.ts +++ b/clients/client-secrets-manager/commands/RemoveRegionsFromReplicationCommand.ts @@ -24,6 +24,20 @@ export interface RemoveRegionsFromReplicationCommandOutput /** *

Remove regions from replication.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { SecretsManagerClient, RemoveRegionsFromReplicationCommand } from "@aws-sdk/client-secrets-manager"; // ES Modules import + * // const { SecretsManagerClient, RemoveRegionsFromReplicationCommand } = require("@aws-sdk/client-secrets-manager"); // CommonJS import + * const client = new SecretsManagerClient(config); + * const command = new RemoveRegionsFromReplicationCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link RemoveRegionsFromReplicationCommandInput} for command's `input` shape. + * @see {@link RemoveRegionsFromReplicationCommandOutput} for command's `response` shape. + * @see {@link SecretsManagerClientResolvedConfig | config} for command's `input` shape. + * */ export class RemoveRegionsFromReplicationCommand extends $Command< RemoveRegionsFromReplicationCommandInput, diff --git a/clients/client-secrets-manager/commands/ReplicateSecretToRegionsCommand.ts b/clients/client-secrets-manager/commands/ReplicateSecretToRegionsCommand.ts index aa97302d9fff..16129fbedfa4 100644 --- a/clients/client-secrets-manager/commands/ReplicateSecretToRegionsCommand.ts +++ b/clients/client-secrets-manager/commands/ReplicateSecretToRegionsCommand.ts @@ -23,6 +23,20 @@ export interface ReplicateSecretToRegionsCommandOutput extends ReplicateSecretTo /** *

Converts an existing secret to a multi-Region secret and begins replication the secret to a * list of new regions.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { SecretsManagerClient, ReplicateSecretToRegionsCommand } from "@aws-sdk/client-secrets-manager"; // ES Modules import + * // const { SecretsManagerClient, ReplicateSecretToRegionsCommand } = require("@aws-sdk/client-secrets-manager"); // CommonJS import + * const client = new SecretsManagerClient(config); + * const command = new ReplicateSecretToRegionsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ReplicateSecretToRegionsCommandInput} for command's `input` shape. + * @see {@link ReplicateSecretToRegionsCommandOutput} for command's `response` shape. + * @see {@link SecretsManagerClientResolvedConfig | config} for command's `input` shape. + * */ export class ReplicateSecretToRegionsCommand extends $Command< ReplicateSecretToRegionsCommandInput, diff --git a/clients/client-secrets-manager/commands/RestoreSecretCommand.ts b/clients/client-secrets-manager/commands/RestoreSecretCommand.ts index 047870432931..97d577c6b6ef 100644 --- a/clients/client-secrets-manager/commands/RestoreSecretCommand.ts +++ b/clients/client-secrets-manager/commands/RestoreSecretCommand.ts @@ -40,6 +40,20 @@ export interface RestoreSecretCommandOutput extends RestoreSecretResponse, __Met *

To delete a secret, use DeleteSecret.

* * + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { SecretsManagerClient, RestoreSecretCommand } from "@aws-sdk/client-secrets-manager"; // ES Modules import + * // const { SecretsManagerClient, RestoreSecretCommand } = require("@aws-sdk/client-secrets-manager"); // CommonJS import + * const client = new SecretsManagerClient(config); + * const command = new RestoreSecretCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link RestoreSecretCommandInput} for command's `input` shape. + * @see {@link RestoreSecretCommandOutput} for command's `response` shape. + * @see {@link SecretsManagerClientResolvedConfig | config} for command's `input` shape. + * */ export class RestoreSecretCommand extends $Command< RestoreSecretCommandInput, diff --git a/clients/client-secrets-manager/commands/RotateSecretCommand.ts b/clients/client-secrets-manager/commands/RotateSecretCommand.ts index 02986ea9e764..7ae65a31c190 100644 --- a/clients/client-secrets-manager/commands/RotateSecretCommand.ts +++ b/clients/client-secrets-manager/commands/RotateSecretCommand.ts @@ -83,6 +83,20 @@ export interface RotateSecretCommandOutput extends RotateSecretResponse, __Metad * UpdateSecretVersionStage.

* * + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { SecretsManagerClient, RotateSecretCommand } from "@aws-sdk/client-secrets-manager"; // ES Modules import + * // const { SecretsManagerClient, RotateSecretCommand } = require("@aws-sdk/client-secrets-manager"); // CommonJS import + * const client = new SecretsManagerClient(config); + * const command = new RotateSecretCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link RotateSecretCommandInput} for command's `input` shape. + * @see {@link RotateSecretCommandOutput} for command's `response` shape. + * @see {@link SecretsManagerClientResolvedConfig | config} for command's `input` shape. + * */ export class RotateSecretCommand extends $Command< RotateSecretCommandInput, diff --git a/clients/client-secrets-manager/commands/StopReplicationToReplicaCommand.ts b/clients/client-secrets-manager/commands/StopReplicationToReplicaCommand.ts index 2226219fe4d3..1e2174dc1c02 100644 --- a/clients/client-secrets-manager/commands/StopReplicationToReplicaCommand.ts +++ b/clients/client-secrets-manager/commands/StopReplicationToReplicaCommand.ts @@ -22,6 +22,20 @@ export interface StopReplicationToReplicaCommandOutput extends StopReplicationTo /** *

Removes the secret from replication and promotes the secret to a regional secret in the replica Region.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { SecretsManagerClient, StopReplicationToReplicaCommand } from "@aws-sdk/client-secrets-manager"; // ES Modules import + * // const { SecretsManagerClient, StopReplicationToReplicaCommand } = require("@aws-sdk/client-secrets-manager"); // CommonJS import + * const client = new SecretsManagerClient(config); + * const command = new StopReplicationToReplicaCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link StopReplicationToReplicaCommandInput} for command's `input` shape. + * @see {@link StopReplicationToReplicaCommandOutput} for command's `response` shape. + * @see {@link SecretsManagerClientResolvedConfig | config} for command's `input` shape. + * */ export class StopReplicationToReplicaCommand extends $Command< StopReplicationToReplicaCommandInput, diff --git a/clients/client-secrets-manager/commands/TagResourceCommand.ts b/clients/client-secrets-manager/commands/TagResourceCommand.ts index a380f792550a..95f339a5de7c 100644 --- a/clients/client-secrets-manager/commands/TagResourceCommand.ts +++ b/clients/client-secrets-manager/commands/TagResourceCommand.ts @@ -77,6 +77,20 @@ export interface TagResourceCommandOutput extends __MetadataBearer {} *

To view the list of tags attached to a secret, use DescribeSecret.

* * + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { SecretsManagerClient, TagResourceCommand } from "@aws-sdk/client-secrets-manager"; // ES Modules import + * // const { SecretsManagerClient, TagResourceCommand } = require("@aws-sdk/client-secrets-manager"); // CommonJS import + * const client = new SecretsManagerClient(config); + * const command = new TagResourceCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link TagResourceCommandInput} for command's `input` shape. + * @see {@link TagResourceCommandOutput} for command's `response` shape. + * @see {@link SecretsManagerClientResolvedConfig | config} for command's `input` shape. + * */ export class TagResourceCommand extends $Command< TagResourceCommandInput, diff --git a/clients/client-secrets-manager/commands/UntagResourceCommand.ts b/clients/client-secrets-manager/commands/UntagResourceCommand.ts index 70c3af3111f9..9c3b125a8f19 100644 --- a/clients/client-secrets-manager/commands/UntagResourceCommand.ts +++ b/clients/client-secrets-manager/commands/UntagResourceCommand.ts @@ -50,6 +50,20 @@ export interface UntagResourceCommandOutput extends __MetadataBearer {} *

To view the list of tags attached to a secret, use DescribeSecret.

* * + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { SecretsManagerClient, UntagResourceCommand } from "@aws-sdk/client-secrets-manager"; // ES Modules import + * // const { SecretsManagerClient, UntagResourceCommand } = require("@aws-sdk/client-secrets-manager"); // CommonJS import + * const client = new SecretsManagerClient(config); + * const command = new UntagResourceCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link UntagResourceCommandInput} for command's `input` shape. + * @see {@link UntagResourceCommandOutput} for command's `response` shape. + * @see {@link SecretsManagerClientResolvedConfig | config} for command's `input` shape. + * */ export class UntagResourceCommand extends $Command< UntagResourceCommandInput, diff --git a/clients/client-secrets-manager/commands/UpdateSecretCommand.ts b/clients/client-secrets-manager/commands/UpdateSecretCommand.ts index ceeaa09118d7..46fbf24c2d90 100644 --- a/clients/client-secrets-manager/commands/UpdateSecretCommand.ts +++ b/clients/client-secrets-manager/commands/UpdateSecretCommand.ts @@ -106,6 +106,20 @@ export interface UpdateSecretCommandOutput extends UpdateSecretResponse, __Metad *

To list the versions contained in a secret, use ListSecretVersionIds.

* * + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { SecretsManagerClient, UpdateSecretCommand } from "@aws-sdk/client-secrets-manager"; // ES Modules import + * // const { SecretsManagerClient, UpdateSecretCommand } = require("@aws-sdk/client-secrets-manager"); // CommonJS import + * const client = new SecretsManagerClient(config); + * const command = new UpdateSecretCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link UpdateSecretCommandInput} for command's `input` shape. + * @see {@link UpdateSecretCommandOutput} for command's `response` shape. + * @see {@link SecretsManagerClientResolvedConfig | config} for command's `input` shape. + * */ export class UpdateSecretCommand extends $Command< UpdateSecretCommandInput, diff --git a/clients/client-secrets-manager/commands/UpdateSecretVersionStageCommand.ts b/clients/client-secrets-manager/commands/UpdateSecretVersionStageCommand.ts index 4676a3cb8f68..4878f8e754f7 100644 --- a/clients/client-secrets-manager/commands/UpdateSecretVersionStageCommand.ts +++ b/clients/client-secrets-manager/commands/UpdateSecretVersionStageCommand.ts @@ -58,6 +58,20 @@ export interface UpdateSecretVersionStageCommandOutput extends UpdateSecretVersi * SecretVersionsToStages response value.

* * + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { SecretsManagerClient, UpdateSecretVersionStageCommand } from "@aws-sdk/client-secrets-manager"; // ES Modules import + * // const { SecretsManagerClient, UpdateSecretVersionStageCommand } = require("@aws-sdk/client-secrets-manager"); // CommonJS import + * const client = new SecretsManagerClient(config); + * const command = new UpdateSecretVersionStageCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link UpdateSecretVersionStageCommandInput} for command's `input` shape. + * @see {@link UpdateSecretVersionStageCommandOutput} for command's `response` shape. + * @see {@link SecretsManagerClientResolvedConfig | config} for command's `input` shape. + * */ export class UpdateSecretVersionStageCommand extends $Command< UpdateSecretVersionStageCommandInput, diff --git a/clients/client-secrets-manager/commands/ValidateResourcePolicyCommand.ts b/clients/client-secrets-manager/commands/ValidateResourcePolicyCommand.ts index 43d64632657f..439cb7f1f1ae 100644 --- a/clients/client-secrets-manager/commands/ValidateResourcePolicyCommand.ts +++ b/clients/client-secrets-manager/commands/ValidateResourcePolicyCommand.ts @@ -56,6 +56,20 @@ export interface ValidateResourcePolicyCommandOutput extends ValidateResourcePol *

* * + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { SecretsManagerClient, ValidateResourcePolicyCommand } from "@aws-sdk/client-secrets-manager"; // ES Modules import + * // const { SecretsManagerClient, ValidateResourcePolicyCommand } = require("@aws-sdk/client-secrets-manager"); // CommonJS import + * const client = new SecretsManagerClient(config); + * const command = new ValidateResourcePolicyCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ValidateResourcePolicyCommandInput} for command's `input` shape. + * @see {@link ValidateResourcePolicyCommandOutput} for command's `response` shape. + * @see {@link SecretsManagerClientResolvedConfig | config} for command's `input` shape. + * */ export class ValidateResourcePolicyCommand extends $Command< ValidateResourcePolicyCommandInput, diff --git a/clients/client-secrets-manager/models/models_0.ts b/clients/client-secrets-manager/models/models_0.ts index 77990ab2cca1..bc1c975524ca 100644 --- a/clients/client-secrets-manager/models/models_0.ts +++ b/clients/client-secrets-manager/models/models_0.ts @@ -17,6 +17,9 @@ export interface ReplicaRegionType { } export namespace ReplicaRegionType { + /** + * @internal + */ export const filterSensitiveLog = (obj: ReplicaRegionType): any => ({ ...obj, }); @@ -45,6 +48,9 @@ export interface CancelRotateSecretRequest { } export namespace CancelRotateSecretRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: CancelRotateSecretRequest): any => ({ ...obj, }); @@ -72,6 +78,9 @@ export interface CancelRotateSecretResponse { } export namespace CancelRotateSecretResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: CancelRotateSecretResponse): any => ({ ...obj, }); @@ -87,6 +96,9 @@ export interface InternalServiceError extends __SmithyException, $MetadataBearer } export namespace InternalServiceError { + /** + * @internal + */ export const filterSensitiveLog = (obj: InternalServiceError): any => ({ ...obj, }); @@ -102,6 +114,9 @@ export interface InvalidParameterException extends __SmithyException, $MetadataB } export namespace InvalidParameterException { + /** + * @internal + */ export const filterSensitiveLog = (obj: InvalidParameterException): any => ({ ...obj, }); @@ -128,6 +143,9 @@ export interface InvalidRequestException extends __SmithyException, $MetadataBea } export namespace InvalidRequestException { + /** + * @internal + */ export const filterSensitiveLog = (obj: InvalidRequestException): any => ({ ...obj, }); @@ -143,6 +161,9 @@ export interface ResourceNotFoundException extends __SmithyException, $MetadataB } export namespace ResourceNotFoundException { + /** + * @internal + */ export const filterSensitiveLog = (obj: ResourceNotFoundException): any => ({ ...obj, }); @@ -164,6 +185,9 @@ export interface Tag { } export namespace Tag { + /** + * @internal + */ export const filterSensitiveLog = (obj: Tag): any => ({ ...obj, }); @@ -346,6 +370,9 @@ export interface CreateSecretRequest { } export namespace CreateSecretRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateSecretRequest): any => ({ ...obj, ...(obj.SecretBinary && { SecretBinary: SENSITIVE_STRING }), @@ -391,6 +418,9 @@ export interface ReplicationStatusType { } export namespace ReplicationStatusType { + /** + * @internal + */ export const filterSensitiveLog = (obj: ReplicationStatusType): any => ({ ...obj, }); @@ -426,6 +456,9 @@ export interface CreateSecretResponse { } export namespace CreateSecretResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateSecretResponse): any => ({ ...obj, }); @@ -444,6 +477,9 @@ export interface EncryptionFailure extends __SmithyException, $MetadataBearer { } export namespace EncryptionFailure { + /** + * @internal + */ export const filterSensitiveLog = (obj: EncryptionFailure): any => ({ ...obj, }); @@ -459,6 +495,9 @@ export interface LimitExceededException extends __SmithyException, $MetadataBear } export namespace LimitExceededException { + /** + * @internal + */ export const filterSensitiveLog = (obj: LimitExceededException): any => ({ ...obj, }); @@ -474,6 +513,9 @@ export interface MalformedPolicyDocumentException extends __SmithyException, $Me } export namespace MalformedPolicyDocumentException { + /** + * @internal + */ export const filterSensitiveLog = (obj: MalformedPolicyDocumentException): any => ({ ...obj, }); @@ -489,6 +531,9 @@ export interface PreconditionNotMetException extends __SmithyException, $Metadat } export namespace PreconditionNotMetException { + /** + * @internal + */ export const filterSensitiveLog = (obj: PreconditionNotMetException): any => ({ ...obj, }); @@ -504,6 +549,9 @@ export interface ResourceExistsException extends __SmithyException, $MetadataBea } export namespace ResourceExistsException { + /** + * @internal + */ export const filterSensitiveLog = (obj: ResourceExistsException): any => ({ ...obj, }); @@ -519,6 +567,9 @@ export interface DecryptionFailure extends __SmithyException, $MetadataBearer { } export namespace DecryptionFailure { + /** + * @internal + */ export const filterSensitiveLog = (obj: DecryptionFailure): any => ({ ...obj, }); @@ -547,6 +598,9 @@ export interface DeleteResourcePolicyRequest { } export namespace DeleteResourcePolicyRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteResourcePolicyRequest): any => ({ ...obj, }); @@ -565,6 +619,9 @@ export interface DeleteResourcePolicyResponse { } export namespace DeleteResourcePolicyResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteResourcePolicyResponse): any => ({ ...obj, }); @@ -624,6 +681,9 @@ export interface DeleteSecretRequest { } export namespace DeleteSecretRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteSecretRequest): any => ({ ...obj, }); @@ -649,6 +709,9 @@ export interface DeleteSecretResponse { } export namespace DeleteSecretResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteSecretResponse): any => ({ ...obj, }); @@ -677,6 +740,9 @@ export interface DescribeSecretRequest { } export namespace DescribeSecretRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeSecretRequest): any => ({ ...obj, }); @@ -698,6 +764,9 @@ export interface RotationRulesType { } export namespace RotationRulesType { + /** + * @internal + */ export const filterSensitiveLog = (obj: RotationRulesType): any => ({ ...obj, }); @@ -813,6 +882,9 @@ export interface DescribeSecretResponse { } export namespace DescribeSecretResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeSecretResponse): any => ({ ...obj, }); @@ -837,6 +909,9 @@ export interface Filter { } export namespace Filter { + /** + * @internal + */ export const filterSensitiveLog = (obj: Filter): any => ({ ...obj, }); @@ -902,6 +977,9 @@ export interface GetRandomPasswordRequest { } export namespace GetRandomPasswordRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetRandomPasswordRequest): any => ({ ...obj, }); @@ -915,6 +993,9 @@ export interface GetRandomPasswordResponse { } export namespace GetRandomPasswordResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetRandomPasswordResponse): any => ({ ...obj, ...(obj.RandomPassword && { RandomPassword: SENSITIVE_STRING }), @@ -944,6 +1025,9 @@ export interface GetResourcePolicyRequest { } export namespace GetResourcePolicyRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetResourcePolicyRequest): any => ({ ...obj, }); @@ -971,6 +1055,9 @@ export interface GetResourcePolicyResponse { } export namespace GetResourcePolicyResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetResourcePolicyResponse): any => ({ ...obj, }); @@ -1021,6 +1108,9 @@ export interface GetSecretValueRequest { } export namespace GetSecretValueRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetSecretValueRequest): any => ({ ...obj, }); @@ -1081,6 +1171,9 @@ export interface GetSecretValueResponse { } export namespace GetSecretValueResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetSecretValueResponse): any => ({ ...obj, ...(obj.SecretBinary && { SecretBinary: SENSITIVE_STRING }), @@ -1098,6 +1191,9 @@ export interface InvalidNextTokenException extends __SmithyException, $MetadataB } export namespace InvalidNextTokenException { + /** + * @internal + */ export const filterSensitiveLog = (obj: InvalidNextTokenException): any => ({ ...obj, }); @@ -1141,6 +1237,9 @@ export interface ListSecretsRequest { } export namespace ListSecretsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListSecretsRequest): any => ({ ...obj, }); @@ -1253,6 +1352,9 @@ export interface SecretListEntry { } export namespace SecretListEntry { + /** + * @internal + */ export const filterSensitiveLog = (obj: SecretListEntry): any => ({ ...obj, }); @@ -1277,6 +1379,9 @@ export interface ListSecretsResponse { } export namespace ListSecretsResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListSecretsResponse): any => ({ ...obj, }); @@ -1332,6 +1437,9 @@ export interface ListSecretVersionIdsRequest { } export namespace ListSecretVersionIdsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListSecretVersionIdsRequest): any => ({ ...obj, }); @@ -1365,6 +1473,9 @@ export interface SecretVersionsListEntry { } export namespace SecretVersionsListEntry { + /** + * @internal + */ export const filterSensitiveLog = (obj: SecretVersionsListEntry): any => ({ ...obj, }); @@ -1406,6 +1517,9 @@ export interface ListSecretVersionIdsResponse { } export namespace ListSecretVersionIdsResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListSecretVersionIdsResponse): any => ({ ...obj, }); @@ -1421,6 +1535,9 @@ export interface PublicPolicyException extends __SmithyException, $MetadataBeare } export namespace PublicPolicyException { + /** + * @internal + */ export const filterSensitiveLog = (obj: PublicPolicyException): any => ({ ...obj, }); @@ -1464,6 +1581,9 @@ export interface PutResourcePolicyRequest { } export namespace PutResourcePolicyRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: PutResourcePolicyRequest): any => ({ ...obj, }); @@ -1482,6 +1602,9 @@ export interface PutResourcePolicyResponse { } export namespace PutResourcePolicyResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: PutResourcePolicyResponse): any => ({ ...obj, }); @@ -1591,6 +1714,9 @@ export interface PutSecretValueRequest { } export namespace PutSecretValueRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: PutSecretValueRequest): any => ({ ...obj, ...(obj.SecretBinary && { SecretBinary: SENSITIVE_STRING }), @@ -1623,6 +1749,9 @@ export interface PutSecretValueResponse { } export namespace PutSecretValueResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: PutSecretValueResponse): any => ({ ...obj, }); @@ -1641,6 +1770,9 @@ export interface RemoveRegionsFromReplicationRequest { } export namespace RemoveRegionsFromReplicationRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: RemoveRegionsFromReplicationRequest): any => ({ ...obj, }); @@ -1659,6 +1791,9 @@ export interface RemoveRegionsFromReplicationResponse { } export namespace RemoveRegionsFromReplicationResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: RemoveRegionsFromReplicationResponse): any => ({ ...obj, }); @@ -1683,6 +1818,9 @@ export interface ReplicateSecretToRegionsRequest { } export namespace ReplicateSecretToRegionsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ReplicateSecretToRegionsRequest): any => ({ ...obj, }); @@ -1702,6 +1840,9 @@ export interface ReplicateSecretToRegionsResponse { } export namespace ReplicateSecretToRegionsResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ReplicateSecretToRegionsResponse): any => ({ ...obj, }); @@ -1730,6 +1871,9 @@ export interface RestoreSecretRequest { } export namespace RestoreSecretRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: RestoreSecretRequest): any => ({ ...obj, }); @@ -1748,6 +1892,9 @@ export interface RestoreSecretResponse { } export namespace RestoreSecretResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: RestoreSecretResponse): any => ({ ...obj, }); @@ -1804,6 +1951,9 @@ export interface RotateSecretRequest { } export namespace RotateSecretRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: RotateSecretRequest): any => ({ ...obj, }); @@ -1828,6 +1978,9 @@ export interface RotateSecretResponse { } export namespace RotateSecretResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: RotateSecretResponse): any => ({ ...obj, }); @@ -1841,6 +1994,9 @@ export interface StopReplicationToReplicaRequest { } export namespace StopReplicationToReplicaRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: StopReplicationToReplicaRequest): any => ({ ...obj, }); @@ -1854,6 +2010,9 @@ export interface StopReplicationToReplicaResponse { } export namespace StopReplicationToReplicaResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: StopReplicationToReplicaResponse): any => ({ ...obj, }); @@ -1893,6 +2052,9 @@ export interface TagResourceRequest { } export namespace TagResourceRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: TagResourceRequest): any => ({ ...obj, }); @@ -1929,6 +2091,9 @@ export interface UntagResourceRequest { } export namespace UntagResourceRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: UntagResourceRequest): any => ({ ...obj, }); @@ -2046,6 +2211,9 @@ export interface UpdateSecretRequest { } export namespace UpdateSecretRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateSecretRequest): any => ({ ...obj, ...(obj.SecretBinary && { SecretBinary: SENSITIVE_STRING }), @@ -2079,6 +2247,9 @@ export interface UpdateSecretResponse { } export namespace UpdateSecretResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateSecretResponse): any => ({ ...obj, }); @@ -2130,6 +2301,9 @@ export interface UpdateSecretVersionStageRequest { } export namespace UpdateSecretVersionStageRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateSecretVersionStageRequest): any => ({ ...obj, }); @@ -2148,6 +2322,9 @@ export interface UpdateSecretVersionStageResponse { } export namespace UpdateSecretVersionStageResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateSecretVersionStageResponse): any => ({ ...obj, }); @@ -2186,6 +2363,9 @@ export interface ValidateResourcePolicyRequest { } export namespace ValidateResourcePolicyRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ValidateResourcePolicyRequest): any => ({ ...obj, }); @@ -2207,6 +2387,9 @@ export interface ValidationErrorsEntry { } export namespace ValidationErrorsEntry { + /** + * @internal + */ export const filterSensitiveLog = (obj: ValidationErrorsEntry): any => ({ ...obj, }); @@ -2225,6 +2408,9 @@ export interface ValidateResourcePolicyResponse { } export namespace ValidateResourcePolicyResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ValidateResourcePolicyResponse): any => ({ ...obj, }); diff --git a/clients/client-securityhub/commands/AcceptAdministratorInvitationCommand.ts b/clients/client-securityhub/commands/AcceptAdministratorInvitationCommand.ts index ac79b21951be..4cbb8df8894c 100644 --- a/clients/client-securityhub/commands/AcceptAdministratorInvitationCommand.ts +++ b/clients/client-securityhub/commands/AcceptAdministratorInvitationCommand.ts @@ -29,6 +29,20 @@ export interface AcceptAdministratorInvitationCommandOutput * Organizations.

*

When the member account accepts the invitation, permission is granted to the administrator * account to view findings generated in the member account.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { SecurityHubClient, AcceptAdministratorInvitationCommand } from "@aws-sdk/client-securityhub"; // ES Modules import + * // const { SecurityHubClient, AcceptAdministratorInvitationCommand } = require("@aws-sdk/client-securityhub"); // CommonJS import + * const client = new SecurityHubClient(config); + * const command = new AcceptAdministratorInvitationCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link AcceptAdministratorInvitationCommandInput} for command's `input` shape. + * @see {@link AcceptAdministratorInvitationCommandOutput} for command's `response` shape. + * @see {@link SecurityHubClientResolvedConfig | config} for command's `input` shape. + * */ export class AcceptAdministratorInvitationCommand extends $Command< AcceptAdministratorInvitationCommandInput, diff --git a/clients/client-securityhub/commands/AcceptInvitationCommand.ts b/clients/client-securityhub/commands/AcceptInvitationCommand.ts index d7a93ec92208..5b381f9ce82c 100644 --- a/clients/client-securityhub/commands/AcceptInvitationCommand.ts +++ b/clients/client-securityhub/commands/AcceptInvitationCommand.ts @@ -30,6 +30,20 @@ export interface AcceptInvitationCommandOutput extends AcceptInvitationResponse, * Organizations.

*

When the member account accepts the invitation, permission is granted to the administrator * account to view findings generated in the member account.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { SecurityHubClient, AcceptInvitationCommand } from "@aws-sdk/client-securityhub"; // ES Modules import + * // const { SecurityHubClient, AcceptInvitationCommand } = require("@aws-sdk/client-securityhub"); // CommonJS import + * const client = new SecurityHubClient(config); + * const command = new AcceptInvitationCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link AcceptInvitationCommandInput} for command's `input` shape. + * @see {@link AcceptInvitationCommandOutput} for command's `response` shape. + * @see {@link SecurityHubClientResolvedConfig | config} for command's `input` shape. + * */ export class AcceptInvitationCommand extends $Command< AcceptInvitationCommandInput, diff --git a/clients/client-securityhub/commands/BatchDisableStandardsCommand.ts b/clients/client-securityhub/commands/BatchDisableStandardsCommand.ts index 0e8e0870b98b..066b437684e6 100644 --- a/clients/client-securityhub/commands/BatchDisableStandardsCommand.ts +++ b/clients/client-securityhub/commands/BatchDisableStandardsCommand.ts @@ -25,6 +25,20 @@ export interface BatchDisableStandardsCommandOutput extends BatchDisableStandard * StandardsSubscriptionArns.

*

For more information, see Security Standards section of the AWS Security Hub User * Guide.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { SecurityHubClient, BatchDisableStandardsCommand } from "@aws-sdk/client-securityhub"; // ES Modules import + * // const { SecurityHubClient, BatchDisableStandardsCommand } = require("@aws-sdk/client-securityhub"); // CommonJS import + * const client = new SecurityHubClient(config); + * const command = new BatchDisableStandardsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link BatchDisableStandardsCommandInput} for command's `input` shape. + * @see {@link BatchDisableStandardsCommandOutput} for command's `response` shape. + * @see {@link SecurityHubClientResolvedConfig | config} for command's `input` shape. + * */ export class BatchDisableStandardsCommand extends $Command< BatchDisableStandardsCommandInput, diff --git a/clients/client-securityhub/commands/BatchEnableStandardsCommand.ts b/clients/client-securityhub/commands/BatchEnableStandardsCommand.ts index 5123b30bfe3c..32071a127de4 100644 --- a/clients/client-securityhub/commands/BatchEnableStandardsCommand.ts +++ b/clients/client-securityhub/commands/BatchEnableStandardsCommand.ts @@ -28,6 +28,20 @@ export interface BatchEnableStandardsCommandOutput extends BatchEnableStandardsR * operation.

*

For more information, see the Security Standards * section of the AWS Security Hub User Guide.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { SecurityHubClient, BatchEnableStandardsCommand } from "@aws-sdk/client-securityhub"; // ES Modules import + * // const { SecurityHubClient, BatchEnableStandardsCommand } = require("@aws-sdk/client-securityhub"); // CommonJS import + * const client = new SecurityHubClient(config); + * const command = new BatchEnableStandardsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link BatchEnableStandardsCommandInput} for command's `input` shape. + * @see {@link BatchEnableStandardsCommandOutput} for command's `response` shape. + * @see {@link SecurityHubClientResolvedConfig | config} for command's `input` shape. + * */ export class BatchEnableStandardsCommand extends $Command< BatchEnableStandardsCommandInput, diff --git a/clients/client-securityhub/commands/BatchImportFindingsCommand.ts b/clients/client-securityhub/commands/BatchImportFindingsCommand.ts index 9ddddbed7197..77020fb5b590 100644 --- a/clients/client-securityhub/commands/BatchImportFindingsCommand.ts +++ b/clients/client-securityhub/commands/BatchImportFindingsCommand.ts @@ -80,6 +80,20 @@ export interface BatchImportFindingsCommandOutput extends BatchImportFindingsRes * * *

Instead, finding providers use FindingProviderFields to provide values for these attributes.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { SecurityHubClient, BatchImportFindingsCommand } from "@aws-sdk/client-securityhub"; // ES Modules import + * // const { SecurityHubClient, BatchImportFindingsCommand } = require("@aws-sdk/client-securityhub"); // CommonJS import + * const client = new SecurityHubClient(config); + * const command = new BatchImportFindingsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link BatchImportFindingsCommandInput} for command's `input` shape. + * @see {@link BatchImportFindingsCommandOutput} for command's `response` shape. + * @see {@link SecurityHubClientResolvedConfig | config} for command's `input` shape. + * */ export class BatchImportFindingsCommand extends $Command< BatchImportFindingsCommandInput, diff --git a/clients/client-securityhub/commands/BatchUpdateFindingsCommand.ts b/clients/client-securityhub/commands/BatchUpdateFindingsCommand.ts index 3a912055191f..0d9e96e380aa 100644 --- a/clients/client-securityhub/commands/BatchUpdateFindingsCommand.ts +++ b/clients/client-securityhub/commands/BatchUpdateFindingsCommand.ts @@ -80,6 +80,20 @@ export interface BatchUpdateFindingsCommandOutput extends BatchUpdateFindingsRes * 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 * AWS Security Hub User Guide.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { SecurityHubClient, BatchUpdateFindingsCommand } from "@aws-sdk/client-securityhub"; // ES Modules import + * // const { SecurityHubClient, BatchUpdateFindingsCommand } = require("@aws-sdk/client-securityhub"); // CommonJS import + * const client = new SecurityHubClient(config); + * const command = new BatchUpdateFindingsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link BatchUpdateFindingsCommandInput} for command's `input` shape. + * @see {@link BatchUpdateFindingsCommandOutput} for command's `response` shape. + * @see {@link SecurityHubClientResolvedConfig | config} for command's `input` shape. + * */ export class BatchUpdateFindingsCommand extends $Command< BatchUpdateFindingsCommandInput, diff --git a/clients/client-securityhub/commands/CreateActionTargetCommand.ts b/clients/client-securityhub/commands/CreateActionTargetCommand.ts index 7becba42fa88..0e2abcdb22db 100644 --- a/clients/client-securityhub/commands/CreateActionTargetCommand.ts +++ b/clients/client-securityhub/commands/CreateActionTargetCommand.ts @@ -24,6 +24,20 @@ export interface CreateActionTargetCommandOutput extends CreateActionTargetRespo *

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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { SecurityHubClient, CreateActionTargetCommand } from "@aws-sdk/client-securityhub"; // ES Modules import + * // const { SecurityHubClient, CreateActionTargetCommand } = require("@aws-sdk/client-securityhub"); // CommonJS import + * const client = new SecurityHubClient(config); + * const command = new CreateActionTargetCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreateActionTargetCommandInput} for command's `input` shape. + * @see {@link CreateActionTargetCommandOutput} for command's `response` shape. + * @see {@link SecurityHubClientResolvedConfig | config} for command's `input` shape. + * */ export class CreateActionTargetCommand extends $Command< CreateActionTargetCommandInput, diff --git a/clients/client-securityhub/commands/CreateInsightCommand.ts b/clients/client-securityhub/commands/CreateInsightCommand.ts index c28aff339969..6e2f1e73bfca 100644 --- a/clients/client-securityhub/commands/CreateInsightCommand.ts +++ b/clients/client-securityhub/commands/CreateInsightCommand.ts @@ -25,6 +25,20 @@ export interface CreateInsightCommandOutput extends CreateInsightResponse, __Met * to a security issue that requires attention or remediation.

*

To group the related findings in the insight, use the * GroupByAttribute.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { SecurityHubClient, CreateInsightCommand } from "@aws-sdk/client-securityhub"; // ES Modules import + * // const { SecurityHubClient, CreateInsightCommand } = require("@aws-sdk/client-securityhub"); // CommonJS import + * const client = new SecurityHubClient(config); + * const command = new CreateInsightCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreateInsightCommandInput} for command's `input` shape. + * @see {@link CreateInsightCommandOutput} for command's `response` shape. + * @see {@link SecurityHubClientResolvedConfig | config} for command's `input` shape. + * */ export class CreateInsightCommand extends $Command< CreateInsightCommandInput, diff --git a/clients/client-securityhub/commands/CreateMembersCommand.ts b/clients/client-securityhub/commands/CreateMembersCommand.ts index 0feaa6ad3d50..20b7068b95eb 100644 --- a/clients/client-securityhub/commands/CreateMembersCommand.ts +++ b/clients/client-securityhub/commands/CreateMembersCommand.ts @@ -58,6 +58,20 @@ export interface CreateMembersCommandOutput extends CreateMembersResponse, __Met * or * DisassociateMembers * operation.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { SecurityHubClient, CreateMembersCommand } from "@aws-sdk/client-securityhub"; // ES Modules import + * // const { SecurityHubClient, CreateMembersCommand } = require("@aws-sdk/client-securityhub"); // CommonJS import + * const client = new SecurityHubClient(config); + * const command = new CreateMembersCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreateMembersCommandInput} for command's `input` shape. + * @see {@link CreateMembersCommandOutput} for command's `response` shape. + * @see {@link SecurityHubClientResolvedConfig | config} for command's `input` shape. + * */ export class CreateMembersCommand extends $Command< CreateMembersCommandInput, diff --git a/clients/client-securityhub/commands/DeclineInvitationsCommand.ts b/clients/client-securityhub/commands/DeclineInvitationsCommand.ts index b61a8d19c450..13a9a1f219a5 100644 --- a/clients/client-securityhub/commands/DeclineInvitationsCommand.ts +++ b/clients/client-securityhub/commands/DeclineInvitationsCommand.ts @@ -24,6 +24,20 @@ export interface DeclineInvitationsCommandOutput extends DeclineInvitationsRespo *

Declines invitations to become a member account.

*

This operation is only used by accounts that are not part of an organization. * Organization accounts do not receive invitations.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { SecurityHubClient, DeclineInvitationsCommand } from "@aws-sdk/client-securityhub"; // ES Modules import + * // const { SecurityHubClient, DeclineInvitationsCommand } = require("@aws-sdk/client-securityhub"); // CommonJS import + * const client = new SecurityHubClient(config); + * const command = new DeclineInvitationsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeclineInvitationsCommandInput} for command's `input` shape. + * @see {@link DeclineInvitationsCommandOutput} for command's `response` shape. + * @see {@link SecurityHubClientResolvedConfig | config} for command's `input` shape. + * */ export class DeclineInvitationsCommand extends $Command< DeclineInvitationsCommandInput, diff --git a/clients/client-securityhub/commands/DeleteActionTargetCommand.ts b/clients/client-securityhub/commands/DeleteActionTargetCommand.ts index 6837c0000c0e..c651ea029378 100644 --- a/clients/client-securityhub/commands/DeleteActionTargetCommand.ts +++ b/clients/client-securityhub/commands/DeleteActionTargetCommand.ts @@ -24,6 +24,20 @@ export interface DeleteActionTargetCommandOutput extends DeleteActionTargetRespo *

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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { SecurityHubClient, DeleteActionTargetCommand } from "@aws-sdk/client-securityhub"; // ES Modules import + * // const { SecurityHubClient, DeleteActionTargetCommand } = require("@aws-sdk/client-securityhub"); // CommonJS import + * const client = new SecurityHubClient(config); + * const command = new DeleteActionTargetCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteActionTargetCommandInput} for command's `input` shape. + * @see {@link DeleteActionTargetCommandOutput} for command's `response` shape. + * @see {@link SecurityHubClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteActionTargetCommand extends $Command< DeleteActionTargetCommandInput, diff --git a/clients/client-securityhub/commands/DeleteInsightCommand.ts b/clients/client-securityhub/commands/DeleteInsightCommand.ts index 1dc7228b76fe..de9561823b2b 100644 --- a/clients/client-securityhub/commands/DeleteInsightCommand.ts +++ b/clients/client-securityhub/commands/DeleteInsightCommand.ts @@ -22,6 +22,20 @@ export interface DeleteInsightCommandOutput extends DeleteInsightResponse, __Met /** *

Deletes the insight specified by the InsightArn.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { SecurityHubClient, DeleteInsightCommand } from "@aws-sdk/client-securityhub"; // ES Modules import + * // const { SecurityHubClient, DeleteInsightCommand } = require("@aws-sdk/client-securityhub"); // CommonJS import + * const client = new SecurityHubClient(config); + * const command = new DeleteInsightCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteInsightCommandInput} for command's `input` shape. + * @see {@link DeleteInsightCommandOutput} for command's `response` shape. + * @see {@link SecurityHubClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteInsightCommand extends $Command< DeleteInsightCommandInput, diff --git a/clients/client-securityhub/commands/DeleteInvitationsCommand.ts b/clients/client-securityhub/commands/DeleteInvitationsCommand.ts index 296ac581c2e4..5c244c847b13 100644 --- a/clients/client-securityhub/commands/DeleteInvitationsCommand.ts +++ b/clients/client-securityhub/commands/DeleteInvitationsCommand.ts @@ -24,6 +24,20 @@ export interface DeleteInvitationsCommandOutput extends DeleteInvitationsRespons *

Deletes invitations received by the AWS account to become a member account.

*

This operation is only used by accounts that are not part of an organization. * Organization accounts do not receive invitations.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { SecurityHubClient, DeleteInvitationsCommand } from "@aws-sdk/client-securityhub"; // ES Modules import + * // const { SecurityHubClient, DeleteInvitationsCommand } = require("@aws-sdk/client-securityhub"); // CommonJS import + * const client = new SecurityHubClient(config); + * const command = new DeleteInvitationsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteInvitationsCommandInput} for command's `input` shape. + * @see {@link DeleteInvitationsCommandOutput} for command's `response` shape. + * @see {@link SecurityHubClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteInvitationsCommand extends $Command< DeleteInvitationsCommandInput, diff --git a/clients/client-securityhub/commands/DeleteMembersCommand.ts b/clients/client-securityhub/commands/DeleteMembersCommand.ts index 2bba714efc4b..0c9ced52efb8 100644 --- a/clients/client-securityhub/commands/DeleteMembersCommand.ts +++ b/clients/client-securityhub/commands/DeleteMembersCommand.ts @@ -24,6 +24,20 @@ export interface DeleteMembersCommandOutput extends DeleteMembersResponse, __Met *

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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { SecurityHubClient, DeleteMembersCommand } from "@aws-sdk/client-securityhub"; // ES Modules import + * // const { SecurityHubClient, DeleteMembersCommand } = require("@aws-sdk/client-securityhub"); // CommonJS import + * const client = new SecurityHubClient(config); + * const command = new DeleteMembersCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteMembersCommandInput} for command's `input` shape. + * @see {@link DeleteMembersCommandOutput} for command's `response` shape. + * @see {@link SecurityHubClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteMembersCommand extends $Command< DeleteMembersCommandInput, diff --git a/clients/client-securityhub/commands/DescribeActionTargetsCommand.ts b/clients/client-securityhub/commands/DescribeActionTargetsCommand.ts index f38ff0173dc1..98dcb2a23030 100644 --- a/clients/client-securityhub/commands/DescribeActionTargetsCommand.ts +++ b/clients/client-securityhub/commands/DescribeActionTargetsCommand.ts @@ -23,6 +23,20 @@ export interface DescribeActionTargetsCommandOutput extends DescribeActionTarget /** *

Returns a list of the custom action targets in Security Hub in your account.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { SecurityHubClient, DescribeActionTargetsCommand } from "@aws-sdk/client-securityhub"; // ES Modules import + * // const { SecurityHubClient, DescribeActionTargetsCommand } = require("@aws-sdk/client-securityhub"); // CommonJS import + * const client = new SecurityHubClient(config); + * const command = new DescribeActionTargetsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeActionTargetsCommandInput} for command's `input` shape. + * @see {@link DescribeActionTargetsCommandOutput} for command's `response` shape. + * @see {@link SecurityHubClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeActionTargetsCommand extends $Command< DescribeActionTargetsCommandInput, diff --git a/clients/client-securityhub/commands/DescribeHubCommand.ts b/clients/client-securityhub/commands/DescribeHubCommand.ts index 4ab2d58ffff8..8faea6d7b9b4 100644 --- a/clients/client-securityhub/commands/DescribeHubCommand.ts +++ b/clients/client-securityhub/commands/DescribeHubCommand.ts @@ -23,6 +23,20 @@ export interface DescribeHubCommandOutput extends DescribeHubResponse, __Metadat /** *

Returns details about the Hub resource in your account, including the * HubArn and the time when you enabled Security Hub.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { SecurityHubClient, DescribeHubCommand } from "@aws-sdk/client-securityhub"; // ES Modules import + * // const { SecurityHubClient, DescribeHubCommand } = require("@aws-sdk/client-securityhub"); // CommonJS import + * const client = new SecurityHubClient(config); + * const command = new DescribeHubCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeHubCommandInput} for command's `input` shape. + * @see {@link DescribeHubCommandOutput} for command's `response` shape. + * @see {@link SecurityHubClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeHubCommand extends $Command< DescribeHubCommandInput, diff --git a/clients/client-securityhub/commands/DescribeOrganizationConfigurationCommand.ts b/clients/client-securityhub/commands/DescribeOrganizationConfigurationCommand.ts index 559be947fd78..4ad2759a0277 100644 --- a/clients/client-securityhub/commands/DescribeOrganizationConfigurationCommand.ts +++ b/clients/client-securityhub/commands/DescribeOrganizationConfigurationCommand.ts @@ -28,6 +28,20 @@ export interface DescribeOrganizationConfigurationCommandOutput /** *

Returns information about the Organizations configuration for Security Hub. Can only be * called from a Security Hub administrator account.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { SecurityHubClient, DescribeOrganizationConfigurationCommand } from "@aws-sdk/client-securityhub"; // ES Modules import + * // const { SecurityHubClient, DescribeOrganizationConfigurationCommand } = require("@aws-sdk/client-securityhub"); // CommonJS import + * const client = new SecurityHubClient(config); + * const command = new DescribeOrganizationConfigurationCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeOrganizationConfigurationCommandInput} for command's `input` shape. + * @see {@link DescribeOrganizationConfigurationCommandOutput} for command's `response` shape. + * @see {@link SecurityHubClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeOrganizationConfigurationCommand extends $Command< DescribeOrganizationConfigurationCommandInput, diff --git a/clients/client-securityhub/commands/DescribeProductsCommand.ts b/clients/client-securityhub/commands/DescribeProductsCommand.ts index b4803e0e7149..b21d5f8bc86d 100644 --- a/clients/client-securityhub/commands/DescribeProductsCommand.ts +++ b/clients/client-securityhub/commands/DescribeProductsCommand.ts @@ -26,6 +26,20 @@ export interface DescribeProductsCommandOutput extends DescribeProductsResponse, * the results only include that integration.

*

If you do not provide an integration ARN, then the results include all of the available * product integrations.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { SecurityHubClient, DescribeProductsCommand } from "@aws-sdk/client-securityhub"; // ES Modules import + * // const { SecurityHubClient, DescribeProductsCommand } = require("@aws-sdk/client-securityhub"); // CommonJS import + * const client = new SecurityHubClient(config); + * const command = new DescribeProductsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeProductsCommandInput} for command's `input` shape. + * @see {@link DescribeProductsCommandOutput} for command's `response` shape. + * @see {@link SecurityHubClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeProductsCommand extends $Command< DescribeProductsCommandInput, diff --git a/clients/client-securityhub/commands/DescribeStandardsCommand.ts b/clients/client-securityhub/commands/DescribeStandardsCommand.ts index a36a1b5b79d5..07e7a4ff9868 100644 --- a/clients/client-securityhub/commands/DescribeStandardsCommand.ts +++ b/clients/client-securityhub/commands/DescribeStandardsCommand.ts @@ -23,6 +23,20 @@ export interface DescribeStandardsCommandOutput extends DescribeStandardsRespons /** *

Returns a list of the available standards in Security Hub.

*

For each standard, the results include the standard ARN, the name, and a description.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { SecurityHubClient, DescribeStandardsCommand } from "@aws-sdk/client-securityhub"; // ES Modules import + * // const { SecurityHubClient, DescribeStandardsCommand } = require("@aws-sdk/client-securityhub"); // CommonJS import + * const client = new SecurityHubClient(config); + * const command = new DescribeStandardsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeStandardsCommandInput} for command's `input` shape. + * @see {@link DescribeStandardsCommandOutput} for command's `response` shape. + * @see {@link SecurityHubClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeStandardsCommand extends $Command< DescribeStandardsCommandInput, diff --git a/clients/client-securityhub/commands/DescribeStandardsControlsCommand.ts b/clients/client-securityhub/commands/DescribeStandardsControlsCommand.ts index b11d365fa69d..fe5a4bd4e387 100644 --- a/clients/client-securityhub/commands/DescribeStandardsControlsCommand.ts +++ b/clients/client-securityhub/commands/DescribeStandardsControlsCommand.ts @@ -24,6 +24,20 @@ export interface DescribeStandardsControlsCommandOutput extends DescribeStandard *

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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { SecurityHubClient, DescribeStandardsControlsCommand } from "@aws-sdk/client-securityhub"; // ES Modules import + * // const { SecurityHubClient, DescribeStandardsControlsCommand } = require("@aws-sdk/client-securityhub"); // CommonJS import + * const client = new SecurityHubClient(config); + * const command = new DescribeStandardsControlsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeStandardsControlsCommandInput} for command's `input` shape. + * @see {@link DescribeStandardsControlsCommandOutput} for command's `response` shape. + * @see {@link SecurityHubClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeStandardsControlsCommand extends $Command< DescribeStandardsControlsCommandInput, diff --git a/clients/client-securityhub/commands/DisableImportFindingsForProductCommand.ts b/clients/client-securityhub/commands/DisableImportFindingsForProductCommand.ts index 0a8b2800f714..68e41d28b7a9 100644 --- a/clients/client-securityhub/commands/DisableImportFindingsForProductCommand.ts +++ b/clients/client-securityhub/commands/DisableImportFindingsForProductCommand.ts @@ -25,6 +25,20 @@ export interface DisableImportFindingsForProductCommandOutput /** *

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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { SecurityHubClient, DisableImportFindingsForProductCommand } from "@aws-sdk/client-securityhub"; // ES Modules import + * // const { SecurityHubClient, DisableImportFindingsForProductCommand } = require("@aws-sdk/client-securityhub"); // CommonJS import + * const client = new SecurityHubClient(config); + * const command = new DisableImportFindingsForProductCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DisableImportFindingsForProductCommandInput} for command's `input` shape. + * @see {@link DisableImportFindingsForProductCommandOutput} for command's `response` shape. + * @see {@link SecurityHubClientResolvedConfig | config} for command's `input` shape. + * */ export class DisableImportFindingsForProductCommand extends $Command< DisableImportFindingsForProductCommandInput, diff --git a/clients/client-securityhub/commands/DisableOrganizationAdminAccountCommand.ts b/clients/client-securityhub/commands/DisableOrganizationAdminAccountCommand.ts index b2a79ae172ff..27a9a94c02e3 100644 --- a/clients/client-securityhub/commands/DisableOrganizationAdminAccountCommand.ts +++ b/clients/client-securityhub/commands/DisableOrganizationAdminAccountCommand.ts @@ -25,6 +25,20 @@ export interface DisableOrganizationAdminAccountCommandOutput /** *

Disables a Security Hub administrator account. Can only be called by the organization * management account.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { SecurityHubClient, DisableOrganizationAdminAccountCommand } from "@aws-sdk/client-securityhub"; // ES Modules import + * // const { SecurityHubClient, DisableOrganizationAdminAccountCommand } = require("@aws-sdk/client-securityhub"); // CommonJS import + * const client = new SecurityHubClient(config); + * const command = new DisableOrganizationAdminAccountCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DisableOrganizationAdminAccountCommandInput} for command's `input` shape. + * @see {@link DisableOrganizationAdminAccountCommandOutput} for command's `response` shape. + * @see {@link SecurityHubClientResolvedConfig | config} for command's `input` shape. + * */ export class DisableOrganizationAdminAccountCommand extends $Command< DisableOrganizationAdminAccountCommandInput, diff --git a/clients/client-securityhub/commands/DisableSecurityHubCommand.ts b/clients/client-securityhub/commands/DisableSecurityHubCommand.ts index 44099bea28f4..ee5df5af7448 100644 --- a/clients/client-securityhub/commands/DisableSecurityHubCommand.ts +++ b/clients/client-securityhub/commands/DisableSecurityHubCommand.ts @@ -30,6 +30,20 @@ export interface DisableSecurityHubCommandOutput extends DisableSecurityHubRespo * 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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { SecurityHubClient, DisableSecurityHubCommand } from "@aws-sdk/client-securityhub"; // ES Modules import + * // const { SecurityHubClient, DisableSecurityHubCommand } = require("@aws-sdk/client-securityhub"); // CommonJS import + * const client = new SecurityHubClient(config); + * const command = new DisableSecurityHubCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DisableSecurityHubCommandInput} for command's `input` shape. + * @see {@link DisableSecurityHubCommandOutput} for command's `response` shape. + * @see {@link SecurityHubClientResolvedConfig | config} for command's `input` shape. + * */ export class DisableSecurityHubCommand extends $Command< DisableSecurityHubCommandInput, diff --git a/clients/client-securityhub/commands/DisassociateFromAdministratorAccountCommand.ts b/clients/client-securityhub/commands/DisassociateFromAdministratorAccountCommand.ts index c8cda9ba9780..f978caf74e3b 100644 --- a/clients/client-securityhub/commands/DisassociateFromAdministratorAccountCommand.ts +++ b/clients/client-securityhub/commands/DisassociateFromAdministratorAccountCommand.ts @@ -31,6 +31,20 @@ export interface DisassociateFromAdministratorAccountCommandOutput *

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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { SecurityHubClient, DisassociateFromAdministratorAccountCommand } from "@aws-sdk/client-securityhub"; // ES Modules import + * // const { SecurityHubClient, DisassociateFromAdministratorAccountCommand } = require("@aws-sdk/client-securityhub"); // CommonJS import + * const client = new SecurityHubClient(config); + * const command = new DisassociateFromAdministratorAccountCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DisassociateFromAdministratorAccountCommandInput} for command's `input` shape. + * @see {@link DisassociateFromAdministratorAccountCommandOutput} for command's `response` shape. + * @see {@link SecurityHubClientResolvedConfig | config} for command's `input` shape. + * */ export class DisassociateFromAdministratorAccountCommand extends $Command< DisassociateFromAdministratorAccountCommandInput, diff --git a/clients/client-securityhub/commands/DisassociateFromMasterAccountCommand.ts b/clients/client-securityhub/commands/DisassociateFromMasterAccountCommand.ts index acb3fe48cd72..fea39a46d1bd 100644 --- a/clients/client-securityhub/commands/DisassociateFromMasterAccountCommand.ts +++ b/clients/client-securityhub/commands/DisassociateFromMasterAccountCommand.ts @@ -31,6 +31,20 @@ export interface DisassociateFromMasterAccountCommandOutput *

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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { SecurityHubClient, DisassociateFromMasterAccountCommand } from "@aws-sdk/client-securityhub"; // ES Modules import + * // const { SecurityHubClient, DisassociateFromMasterAccountCommand } = require("@aws-sdk/client-securityhub"); // CommonJS import + * const client = new SecurityHubClient(config); + * const command = new DisassociateFromMasterAccountCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DisassociateFromMasterAccountCommandInput} for command's `input` shape. + * @see {@link DisassociateFromMasterAccountCommandOutput} for command's `response` shape. + * @see {@link SecurityHubClientResolvedConfig | config} for command's `input` shape. + * */ export class DisassociateFromMasterAccountCommand extends $Command< DisassociateFromMasterAccountCommandInput, diff --git a/clients/client-securityhub/commands/DisassociateMembersCommand.ts b/clients/client-securityhub/commands/DisassociateMembersCommand.ts index 8634acaa45d6..c49fbe51661a 100644 --- a/clients/client-securityhub/commands/DisassociateMembersCommand.ts +++ b/clients/client-securityhub/commands/DisassociateMembersCommand.ts @@ -24,6 +24,20 @@ export interface DisassociateMembersCommandOutput extends DisassociateMembersRes *

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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { SecurityHubClient, DisassociateMembersCommand } from "@aws-sdk/client-securityhub"; // ES Modules import + * // const { SecurityHubClient, DisassociateMembersCommand } = require("@aws-sdk/client-securityhub"); // CommonJS import + * const client = new SecurityHubClient(config); + * const command = new DisassociateMembersCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DisassociateMembersCommandInput} for command's `input` shape. + * @see {@link DisassociateMembersCommandOutput} for command's `response` shape. + * @see {@link SecurityHubClientResolvedConfig | config} for command's `input` shape. + * */ export class DisassociateMembersCommand extends $Command< DisassociateMembersCommandInput, diff --git a/clients/client-securityhub/commands/EnableImportFindingsForProductCommand.ts b/clients/client-securityhub/commands/EnableImportFindingsForProductCommand.ts index 0ea352462a4e..b661d8e3d5ff 100644 --- a/clients/client-securityhub/commands/EnableImportFindingsForProductCommand.ts +++ b/clients/client-securityhub/commands/EnableImportFindingsForProductCommand.ts @@ -27,6 +27,20 @@ export interface EnableImportFindingsForProductCommandOutput * 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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { SecurityHubClient, EnableImportFindingsForProductCommand } from "@aws-sdk/client-securityhub"; // ES Modules import + * // const { SecurityHubClient, EnableImportFindingsForProductCommand } = require("@aws-sdk/client-securityhub"); // CommonJS import + * const client = new SecurityHubClient(config); + * const command = new EnableImportFindingsForProductCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link EnableImportFindingsForProductCommandInput} for command's `input` shape. + * @see {@link EnableImportFindingsForProductCommandOutput} for command's `response` shape. + * @see {@link SecurityHubClientResolvedConfig | config} for command's `input` shape. + * */ export class EnableImportFindingsForProductCommand extends $Command< EnableImportFindingsForProductCommandInput, diff --git a/clients/client-securityhub/commands/EnableOrganizationAdminAccountCommand.ts b/clients/client-securityhub/commands/EnableOrganizationAdminAccountCommand.ts index 3562d463ab10..c70070203f8f 100644 --- a/clients/client-securityhub/commands/EnableOrganizationAdminAccountCommand.ts +++ b/clients/client-securityhub/commands/EnableOrganizationAdminAccountCommand.ts @@ -25,6 +25,20 @@ export interface EnableOrganizationAdminAccountCommandOutput /** *

Designates the Security Hub administrator account for an organization. Can only be called by * the organization management account.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { SecurityHubClient, EnableOrganizationAdminAccountCommand } from "@aws-sdk/client-securityhub"; // ES Modules import + * // const { SecurityHubClient, EnableOrganizationAdminAccountCommand } = require("@aws-sdk/client-securityhub"); // CommonJS import + * const client = new SecurityHubClient(config); + * const command = new EnableOrganizationAdminAccountCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link EnableOrganizationAdminAccountCommandInput} for command's `input` shape. + * @see {@link EnableOrganizationAdminAccountCommandOutput} for command's `response` shape. + * @see {@link SecurityHubClientResolvedConfig | config} for command's `input` shape. + * */ export class EnableOrganizationAdminAccountCommand extends $Command< EnableOrganizationAdminAccountCommandInput, diff --git a/clients/client-securityhub/commands/EnableSecurityHubCommand.ts b/clients/client-securityhub/commands/EnableSecurityHubCommand.ts index 03428e4fe0ca..da933f5551b9 100644 --- a/clients/client-securityhub/commands/EnableSecurityHubCommand.ts +++ b/clients/client-securityhub/commands/EnableSecurityHubCommand.ts @@ -46,6 +46,20 @@ export interface EnableSecurityHubCommandOutput extends EnableSecurityHubRespons * operation.

*

To learn more, see Setting Up * AWS Security Hub in the AWS Security Hub User Guide.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { SecurityHubClient, EnableSecurityHubCommand } from "@aws-sdk/client-securityhub"; // ES Modules import + * // const { SecurityHubClient, EnableSecurityHubCommand } = require("@aws-sdk/client-securityhub"); // CommonJS import + * const client = new SecurityHubClient(config); + * const command = new EnableSecurityHubCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link EnableSecurityHubCommandInput} for command's `input` shape. + * @see {@link EnableSecurityHubCommandOutput} for command's `response` shape. + * @see {@link SecurityHubClientResolvedConfig | config} for command's `input` shape. + * */ export class EnableSecurityHubCommand extends $Command< EnableSecurityHubCommandInput, diff --git a/clients/client-securityhub/commands/GetAdministratorAccountCommand.ts b/clients/client-securityhub/commands/GetAdministratorAccountCommand.ts index b6c09bb4e9f5..a5347f98d7cc 100644 --- a/clients/client-securityhub/commands/GetAdministratorAccountCommand.ts +++ b/clients/client-securityhub/commands/GetAdministratorAccountCommand.ts @@ -24,6 +24,20 @@ export interface GetAdministratorAccountCommandOutput extends GetAdministratorAc *

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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { SecurityHubClient, GetAdministratorAccountCommand } from "@aws-sdk/client-securityhub"; // ES Modules import + * // const { SecurityHubClient, GetAdministratorAccountCommand } = require("@aws-sdk/client-securityhub"); // CommonJS import + * const client = new SecurityHubClient(config); + * const command = new GetAdministratorAccountCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetAdministratorAccountCommandInput} for command's `input` shape. + * @see {@link GetAdministratorAccountCommandOutput} for command's `response` shape. + * @see {@link SecurityHubClientResolvedConfig | config} for command's `input` shape. + * */ export class GetAdministratorAccountCommand extends $Command< GetAdministratorAccountCommandInput, diff --git a/clients/client-securityhub/commands/GetEnabledStandardsCommand.ts b/clients/client-securityhub/commands/GetEnabledStandardsCommand.ts index 8ddae67da820..13389cb5f18f 100644 --- a/clients/client-securityhub/commands/GetEnabledStandardsCommand.ts +++ b/clients/client-securityhub/commands/GetEnabledStandardsCommand.ts @@ -22,6 +22,20 @@ export interface GetEnabledStandardsCommandOutput extends GetEnabledStandardsRes /** *

Returns a list of the standards that are currently enabled.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { SecurityHubClient, GetEnabledStandardsCommand } from "@aws-sdk/client-securityhub"; // ES Modules import + * // const { SecurityHubClient, GetEnabledStandardsCommand } = require("@aws-sdk/client-securityhub"); // CommonJS import + * const client = new SecurityHubClient(config); + * const command = new GetEnabledStandardsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetEnabledStandardsCommandInput} for command's `input` shape. + * @see {@link GetEnabledStandardsCommandOutput} for command's `response` shape. + * @see {@link SecurityHubClientResolvedConfig | config} for command's `input` shape. + * */ export class GetEnabledStandardsCommand extends $Command< GetEnabledStandardsCommandInput, diff --git a/clients/client-securityhub/commands/GetFindingsCommand.ts b/clients/client-securityhub/commands/GetFindingsCommand.ts index 88366c12ae5f..21b12c56cdbe 100644 --- a/clients/client-securityhub/commands/GetFindingsCommand.ts +++ b/clients/client-securityhub/commands/GetFindingsCommand.ts @@ -22,6 +22,20 @@ export interface GetFindingsCommandOutput extends GetFindingsResponse, __Metadat /** *

Returns a list of findings that match the specified criteria.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { SecurityHubClient, GetFindingsCommand } from "@aws-sdk/client-securityhub"; // ES Modules import + * // const { SecurityHubClient, GetFindingsCommand } = require("@aws-sdk/client-securityhub"); // CommonJS import + * const client = new SecurityHubClient(config); + * const command = new GetFindingsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetFindingsCommandInput} for command's `input` shape. + * @see {@link GetFindingsCommandOutput} for command's `response` shape. + * @see {@link SecurityHubClientResolvedConfig | config} for command's `input` shape. + * */ export class GetFindingsCommand extends $Command< GetFindingsCommandInput, diff --git a/clients/client-securityhub/commands/GetInsightResultsCommand.ts b/clients/client-securityhub/commands/GetInsightResultsCommand.ts index 5c30911b898b..633a39eed61e 100644 --- a/clients/client-securityhub/commands/GetInsightResultsCommand.ts +++ b/clients/client-securityhub/commands/GetInsightResultsCommand.ts @@ -22,6 +22,20 @@ export interface GetInsightResultsCommandOutput extends GetInsightResultsRespons /** *

Lists the results of the Security Hub insight specified by the insight ARN.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { SecurityHubClient, GetInsightResultsCommand } from "@aws-sdk/client-securityhub"; // ES Modules import + * // const { SecurityHubClient, GetInsightResultsCommand } = require("@aws-sdk/client-securityhub"); // CommonJS import + * const client = new SecurityHubClient(config); + * const command = new GetInsightResultsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetInsightResultsCommandInput} for command's `input` shape. + * @see {@link GetInsightResultsCommandOutput} for command's `response` shape. + * @see {@link SecurityHubClientResolvedConfig | config} for command's `input` shape. + * */ export class GetInsightResultsCommand extends $Command< GetInsightResultsCommandInput, diff --git a/clients/client-securityhub/commands/GetInsightsCommand.ts b/clients/client-securityhub/commands/GetInsightsCommand.ts index 5a4a856d2c17..0b993509ea9d 100644 --- a/clients/client-securityhub/commands/GetInsightsCommand.ts +++ b/clients/client-securityhub/commands/GetInsightsCommand.ts @@ -22,6 +22,20 @@ export interface GetInsightsCommandOutput extends GetInsightsResponse, __Metadat /** *

Lists and describes insights for the specified insight ARNs.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { SecurityHubClient, GetInsightsCommand } from "@aws-sdk/client-securityhub"; // ES Modules import + * // const { SecurityHubClient, GetInsightsCommand } = require("@aws-sdk/client-securityhub"); // CommonJS import + * const client = new SecurityHubClient(config); + * const command = new GetInsightsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetInsightsCommandInput} for command's `input` shape. + * @see {@link GetInsightsCommandOutput} for command's `response` shape. + * @see {@link SecurityHubClientResolvedConfig | config} for command's `input` shape. + * */ export class GetInsightsCommand extends $Command< GetInsightsCommandInput, diff --git a/clients/client-securityhub/commands/GetInvitationsCountCommand.ts b/clients/client-securityhub/commands/GetInvitationsCountCommand.ts index 374c3bbafa32..b8f4c6285d08 100644 --- a/clients/client-securityhub/commands/GetInvitationsCountCommand.ts +++ b/clients/client-securityhub/commands/GetInvitationsCountCommand.ts @@ -23,6 +23,20 @@ export interface GetInvitationsCountCommandOutput extends GetInvitationsCountRes /** *

Returns the count of all Security Hub membership invitations that were sent to the * current member account, not including the currently accepted invitation.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { SecurityHubClient, GetInvitationsCountCommand } from "@aws-sdk/client-securityhub"; // ES Modules import + * // const { SecurityHubClient, GetInvitationsCountCommand } = require("@aws-sdk/client-securityhub"); // CommonJS import + * const client = new SecurityHubClient(config); + * const command = new GetInvitationsCountCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetInvitationsCountCommandInput} for command's `input` shape. + * @see {@link GetInvitationsCountCommandOutput} for command's `response` shape. + * @see {@link SecurityHubClientResolvedConfig | config} for command's `input` shape. + * */ export class GetInvitationsCountCommand extends $Command< GetInvitationsCountCommandInput, diff --git a/clients/client-securityhub/commands/GetMasterAccountCommand.ts b/clients/client-securityhub/commands/GetMasterAccountCommand.ts index 98d30c66586d..5d998a0611de 100644 --- a/clients/client-securityhub/commands/GetMasterAccountCommand.ts +++ b/clients/client-securityhub/commands/GetMasterAccountCommand.ts @@ -27,6 +27,20 @@ export interface GetMasterAccountCommandOutput extends GetMasterAccountResponse, *

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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { SecurityHubClient, GetMasterAccountCommand } from "@aws-sdk/client-securityhub"; // ES Modules import + * // const { SecurityHubClient, GetMasterAccountCommand } = require("@aws-sdk/client-securityhub"); // CommonJS import + * const client = new SecurityHubClient(config); + * const command = new GetMasterAccountCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetMasterAccountCommandInput} for command's `input` shape. + * @see {@link GetMasterAccountCommandOutput} for command's `response` shape. + * @see {@link SecurityHubClientResolvedConfig | config} for command's `input` shape. + * */ export class GetMasterAccountCommand extends $Command< GetMasterAccountCommandInput, diff --git a/clients/client-securityhub/commands/GetMembersCommand.ts b/clients/client-securityhub/commands/GetMembersCommand.ts index e42646fecfb0..734b62ee4c2b 100644 --- a/clients/client-securityhub/commands/GetMembersCommand.ts +++ b/clients/client-securityhub/commands/GetMembersCommand.ts @@ -26,6 +26,20 @@ export interface GetMembersCommandOutput extends GetMembersResponse, __MetadataB * 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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { SecurityHubClient, GetMembersCommand } from "@aws-sdk/client-securityhub"; // ES Modules import + * // const { SecurityHubClient, GetMembersCommand } = require("@aws-sdk/client-securityhub"); // CommonJS import + * const client = new SecurityHubClient(config); + * const command = new GetMembersCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetMembersCommandInput} for command's `input` shape. + * @see {@link GetMembersCommandOutput} for command's `response` shape. + * @see {@link SecurityHubClientResolvedConfig | config} for command's `input` shape. + * */ export class GetMembersCommand extends $Command< GetMembersCommandInput, diff --git a/clients/client-securityhub/commands/InviteMembersCommand.ts b/clients/client-securityhub/commands/InviteMembersCommand.ts index d6179a1b5fb5..5fcafd0aa138 100644 --- a/clients/client-securityhub/commands/InviteMembersCommand.ts +++ b/clients/client-securityhub/commands/InviteMembersCommand.ts @@ -30,6 +30,20 @@ export interface InviteMembersCommandOutput extends InviteMembersResponse, __Met * 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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { SecurityHubClient, InviteMembersCommand } from "@aws-sdk/client-securityhub"; // ES Modules import + * // const { SecurityHubClient, InviteMembersCommand } = require("@aws-sdk/client-securityhub"); // CommonJS import + * const client = new SecurityHubClient(config); + * const command = new InviteMembersCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link InviteMembersCommandInput} for command's `input` shape. + * @see {@link InviteMembersCommandOutput} for command's `response` shape. + * @see {@link SecurityHubClientResolvedConfig | config} for command's `input` shape. + * */ export class InviteMembersCommand extends $Command< InviteMembersCommandInput, diff --git a/clients/client-securityhub/commands/ListEnabledProductsForImportCommand.ts b/clients/client-securityhub/commands/ListEnabledProductsForImportCommand.ts index 23c9385681c1..8282b5f9cdbb 100644 --- a/clients/client-securityhub/commands/ListEnabledProductsForImportCommand.ts +++ b/clients/client-securityhub/commands/ListEnabledProductsForImportCommand.ts @@ -25,6 +25,20 @@ export interface ListEnabledProductsForImportCommandOutput /** *

Lists all findings-generating solutions (products) that you are subscribed to receive * findings from in Security Hub.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { SecurityHubClient, ListEnabledProductsForImportCommand } from "@aws-sdk/client-securityhub"; // ES Modules import + * // const { SecurityHubClient, ListEnabledProductsForImportCommand } = require("@aws-sdk/client-securityhub"); // CommonJS import + * const client = new SecurityHubClient(config); + * const command = new ListEnabledProductsForImportCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListEnabledProductsForImportCommandInput} for command's `input` shape. + * @see {@link ListEnabledProductsForImportCommandOutput} for command's `response` shape. + * @see {@link SecurityHubClientResolvedConfig | config} for command's `input` shape. + * */ export class ListEnabledProductsForImportCommand extends $Command< ListEnabledProductsForImportCommandInput, diff --git a/clients/client-securityhub/commands/ListInvitationsCommand.ts b/clients/client-securityhub/commands/ListInvitationsCommand.ts index 13d9f2fc65af..5eb0de1f3aee 100644 --- a/clients/client-securityhub/commands/ListInvitationsCommand.ts +++ b/clients/client-securityhub/commands/ListInvitationsCommand.ts @@ -24,6 +24,20 @@ export interface ListInvitationsCommandOutput extends ListInvitationsResponse, _ *

Lists all Security Hub membership invitations that were sent to the current AWS account.

*

This operation is only used by accounts that are managed by invitation. * Accounts that are managed using the integration with AWS Organizations do not receive invitations.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { SecurityHubClient, ListInvitationsCommand } from "@aws-sdk/client-securityhub"; // ES Modules import + * // const { SecurityHubClient, ListInvitationsCommand } = require("@aws-sdk/client-securityhub"); // CommonJS import + * const client = new SecurityHubClient(config); + * const command = new ListInvitationsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListInvitationsCommandInput} for command's `input` shape. + * @see {@link ListInvitationsCommandOutput} for command's `response` shape. + * @see {@link SecurityHubClientResolvedConfig | config} for command's `input` shape. + * */ export class ListInvitationsCommand extends $Command< ListInvitationsCommandInput, diff --git a/clients/client-securityhub/commands/ListMembersCommand.ts b/clients/client-securityhub/commands/ListMembersCommand.ts index 785bd9a178f4..a07199f1be89 100644 --- a/clients/client-securityhub/commands/ListMembersCommand.ts +++ b/clients/client-securityhub/commands/ListMembersCommand.ts @@ -25,6 +25,20 @@ export interface ListMembersCommandOutput extends ListMembersResponse, __Metadat * account.

*

The results include both member accounts that belong to an organization and member * accounts that were invited manually.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { SecurityHubClient, ListMembersCommand } from "@aws-sdk/client-securityhub"; // ES Modules import + * // const { SecurityHubClient, ListMembersCommand } = require("@aws-sdk/client-securityhub"); // CommonJS import + * const client = new SecurityHubClient(config); + * const command = new ListMembersCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListMembersCommandInput} for command's `input` shape. + * @see {@link ListMembersCommandOutput} for command's `response` shape. + * @see {@link SecurityHubClientResolvedConfig | config} for command's `input` shape. + * */ export class ListMembersCommand extends $Command< ListMembersCommandInput, diff --git a/clients/client-securityhub/commands/ListOrganizationAdminAccountsCommand.ts b/clients/client-securityhub/commands/ListOrganizationAdminAccountsCommand.ts index 1880a41225e8..cc318ca4efcd 100644 --- a/clients/client-securityhub/commands/ListOrganizationAdminAccountsCommand.ts +++ b/clients/client-securityhub/commands/ListOrganizationAdminAccountsCommand.ts @@ -25,6 +25,20 @@ export interface ListOrganizationAdminAccountsCommandOutput /** *

Lists the Security Hub administrator accounts. Can only be called by the organization * management account.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { SecurityHubClient, ListOrganizationAdminAccountsCommand } from "@aws-sdk/client-securityhub"; // ES Modules import + * // const { SecurityHubClient, ListOrganizationAdminAccountsCommand } = require("@aws-sdk/client-securityhub"); // CommonJS import + * const client = new SecurityHubClient(config); + * const command = new ListOrganizationAdminAccountsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListOrganizationAdminAccountsCommandInput} for command's `input` shape. + * @see {@link ListOrganizationAdminAccountsCommandOutput} for command's `response` shape. + * @see {@link SecurityHubClientResolvedConfig | config} for command's `input` shape. + * */ export class ListOrganizationAdminAccountsCommand extends $Command< ListOrganizationAdminAccountsCommandInput, diff --git a/clients/client-securityhub/commands/ListTagsForResourceCommand.ts b/clients/client-securityhub/commands/ListTagsForResourceCommand.ts index 008553a26516..ad340d74736b 100644 --- a/clients/client-securityhub/commands/ListTagsForResourceCommand.ts +++ b/clients/client-securityhub/commands/ListTagsForResourceCommand.ts @@ -22,6 +22,20 @@ export interface ListTagsForResourceCommandOutput extends ListTagsForResourceRes /** *

Returns a list of tags associated with a resource.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { SecurityHubClient, ListTagsForResourceCommand } from "@aws-sdk/client-securityhub"; // ES Modules import + * // const { SecurityHubClient, ListTagsForResourceCommand } = require("@aws-sdk/client-securityhub"); // CommonJS import + * const client = new SecurityHubClient(config); + * const command = new ListTagsForResourceCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListTagsForResourceCommandInput} for command's `input` shape. + * @see {@link ListTagsForResourceCommandOutput} for command's `response` shape. + * @see {@link SecurityHubClientResolvedConfig | config} for command's `input` shape. + * */ export class ListTagsForResourceCommand extends $Command< ListTagsForResourceCommandInput, diff --git a/clients/client-securityhub/commands/TagResourceCommand.ts b/clients/client-securityhub/commands/TagResourceCommand.ts index 3c5b8f5f00a6..fdc87d1a8d87 100644 --- a/clients/client-securityhub/commands/TagResourceCommand.ts +++ b/clients/client-securityhub/commands/TagResourceCommand.ts @@ -22,6 +22,20 @@ export interface TagResourceCommandOutput extends TagResourceResponse, __Metadat /** *

Adds one or more tags to a resource.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { SecurityHubClient, TagResourceCommand } from "@aws-sdk/client-securityhub"; // ES Modules import + * // const { SecurityHubClient, TagResourceCommand } = require("@aws-sdk/client-securityhub"); // CommonJS import + * const client = new SecurityHubClient(config); + * const command = new TagResourceCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link TagResourceCommandInput} for command's `input` shape. + * @see {@link TagResourceCommandOutput} for command's `response` shape. + * @see {@link SecurityHubClientResolvedConfig | config} for command's `input` shape. + * */ export class TagResourceCommand extends $Command< TagResourceCommandInput, diff --git a/clients/client-securityhub/commands/UntagResourceCommand.ts b/clients/client-securityhub/commands/UntagResourceCommand.ts index 746030372876..586152edfa3a 100644 --- a/clients/client-securityhub/commands/UntagResourceCommand.ts +++ b/clients/client-securityhub/commands/UntagResourceCommand.ts @@ -22,6 +22,20 @@ export interface UntagResourceCommandOutput extends UntagResourceResponse, __Met /** *

Removes one or more tags from a resource.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { SecurityHubClient, UntagResourceCommand } from "@aws-sdk/client-securityhub"; // ES Modules import + * // const { SecurityHubClient, UntagResourceCommand } = require("@aws-sdk/client-securityhub"); // CommonJS import + * const client = new SecurityHubClient(config); + * const command = new UntagResourceCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link UntagResourceCommandInput} for command's `input` shape. + * @see {@link UntagResourceCommandOutput} for command's `response` shape. + * @see {@link SecurityHubClientResolvedConfig | config} for command's `input` shape. + * */ export class UntagResourceCommand extends $Command< UntagResourceCommandInput, diff --git a/clients/client-securityhub/commands/UpdateActionTargetCommand.ts b/clients/client-securityhub/commands/UpdateActionTargetCommand.ts index 79e74b1574ad..bd377328f1ea 100644 --- a/clients/client-securityhub/commands/UpdateActionTargetCommand.ts +++ b/clients/client-securityhub/commands/UpdateActionTargetCommand.ts @@ -22,6 +22,20 @@ export interface UpdateActionTargetCommandOutput extends UpdateActionTargetRespo /** *

Updates the name and description of a custom action target in Security Hub.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { SecurityHubClient, UpdateActionTargetCommand } from "@aws-sdk/client-securityhub"; // ES Modules import + * // const { SecurityHubClient, UpdateActionTargetCommand } = require("@aws-sdk/client-securityhub"); // CommonJS import + * const client = new SecurityHubClient(config); + * const command = new UpdateActionTargetCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link UpdateActionTargetCommandInput} for command's `input` shape. + * @see {@link UpdateActionTargetCommandOutput} for command's `response` shape. + * @see {@link SecurityHubClientResolvedConfig | config} for command's `input` shape. + * */ export class UpdateActionTargetCommand extends $Command< UpdateActionTargetCommandInput, diff --git a/clients/client-securityhub/commands/UpdateFindingsCommand.ts b/clients/client-securityhub/commands/UpdateFindingsCommand.ts index f1c96a5d842b..d199cf2b3b01 100644 --- a/clients/client-securityhub/commands/UpdateFindingsCommand.ts +++ b/clients/client-securityhub/commands/UpdateFindingsCommand.ts @@ -27,6 +27,20 @@ export interface UpdateFindingsCommandOutput extends UpdateFindingsResponse, __M *

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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { SecurityHubClient, UpdateFindingsCommand } from "@aws-sdk/client-securityhub"; // ES Modules import + * // const { SecurityHubClient, UpdateFindingsCommand } = require("@aws-sdk/client-securityhub"); // CommonJS import + * const client = new SecurityHubClient(config); + * const command = new UpdateFindingsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link UpdateFindingsCommandInput} for command's `input` shape. + * @see {@link UpdateFindingsCommandOutput} for command's `response` shape. + * @see {@link SecurityHubClientResolvedConfig | config} for command's `input` shape. + * */ export class UpdateFindingsCommand extends $Command< UpdateFindingsCommandInput, diff --git a/clients/client-securityhub/commands/UpdateInsightCommand.ts b/clients/client-securityhub/commands/UpdateInsightCommand.ts index bca28b95ffb4..452779dafec4 100644 --- a/clients/client-securityhub/commands/UpdateInsightCommand.ts +++ b/clients/client-securityhub/commands/UpdateInsightCommand.ts @@ -22,6 +22,20 @@ export interface UpdateInsightCommandOutput extends UpdateInsightResponse, __Met /** *

Updates the Security Hub insight identified by the specified insight ARN.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { SecurityHubClient, UpdateInsightCommand } from "@aws-sdk/client-securityhub"; // ES Modules import + * // const { SecurityHubClient, UpdateInsightCommand } = require("@aws-sdk/client-securityhub"); // CommonJS import + * const client = new SecurityHubClient(config); + * const command = new UpdateInsightCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link UpdateInsightCommandInput} for command's `input` shape. + * @see {@link UpdateInsightCommandOutput} for command's `response` shape. + * @see {@link SecurityHubClientResolvedConfig | config} for command's `input` shape. + * */ export class UpdateInsightCommand extends $Command< UpdateInsightCommandInput, diff --git a/clients/client-securityhub/commands/UpdateOrganizationConfigurationCommand.ts b/clients/client-securityhub/commands/UpdateOrganizationConfigurationCommand.ts index 119b76c22e0e..4260a51d2d72 100644 --- a/clients/client-securityhub/commands/UpdateOrganizationConfigurationCommand.ts +++ b/clients/client-securityhub/commands/UpdateOrganizationConfigurationCommand.ts @@ -25,6 +25,20 @@ export interface UpdateOrganizationConfigurationCommandOutput /** *

Used to update the configuration related to Organizations. Can only be called from a * Security Hub administrator account.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { SecurityHubClient, UpdateOrganizationConfigurationCommand } from "@aws-sdk/client-securityhub"; // ES Modules import + * // const { SecurityHubClient, UpdateOrganizationConfigurationCommand } = require("@aws-sdk/client-securityhub"); // CommonJS import + * const client = new SecurityHubClient(config); + * const command = new UpdateOrganizationConfigurationCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link UpdateOrganizationConfigurationCommandInput} for command's `input` shape. + * @see {@link UpdateOrganizationConfigurationCommandOutput} for command's `response` shape. + * @see {@link SecurityHubClientResolvedConfig | config} for command's `input` shape. + * */ export class UpdateOrganizationConfigurationCommand extends $Command< UpdateOrganizationConfigurationCommandInput, diff --git a/clients/client-securityhub/commands/UpdateSecurityHubConfigurationCommand.ts b/clients/client-securityhub/commands/UpdateSecurityHubConfigurationCommand.ts index 632cf978fea7..a50e2d7f1bf6 100644 --- a/clients/client-securityhub/commands/UpdateSecurityHubConfigurationCommand.ts +++ b/clients/client-securityhub/commands/UpdateSecurityHubConfigurationCommand.ts @@ -24,6 +24,20 @@ export interface UpdateSecurityHubConfigurationCommandOutput /** *

Updates configuration options for Security Hub.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { SecurityHubClient, UpdateSecurityHubConfigurationCommand } from "@aws-sdk/client-securityhub"; // ES Modules import + * // const { SecurityHubClient, UpdateSecurityHubConfigurationCommand } = require("@aws-sdk/client-securityhub"); // CommonJS import + * const client = new SecurityHubClient(config); + * const command = new UpdateSecurityHubConfigurationCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link UpdateSecurityHubConfigurationCommandInput} for command's `input` shape. + * @see {@link UpdateSecurityHubConfigurationCommandOutput} for command's `response` shape. + * @see {@link SecurityHubClientResolvedConfig | config} for command's `input` shape. + * */ export class UpdateSecurityHubConfigurationCommand extends $Command< UpdateSecurityHubConfigurationCommandInput, diff --git a/clients/client-securityhub/commands/UpdateStandardsControlCommand.ts b/clients/client-securityhub/commands/UpdateStandardsControlCommand.ts index 417cb9158142..b32b993dc95f 100644 --- a/clients/client-securityhub/commands/UpdateStandardsControlCommand.ts +++ b/clients/client-securityhub/commands/UpdateStandardsControlCommand.ts @@ -23,6 +23,20 @@ export interface UpdateStandardsControlCommandOutput extends UpdateStandardsCont /** *

Used to control whether an individual security standard control is enabled or * disabled.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { SecurityHubClient, UpdateStandardsControlCommand } from "@aws-sdk/client-securityhub"; // ES Modules import + * // const { SecurityHubClient, UpdateStandardsControlCommand } = require("@aws-sdk/client-securityhub"); // CommonJS import + * const client = new SecurityHubClient(config); + * const command = new UpdateStandardsControlCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link UpdateStandardsControlCommandInput} for command's `input` shape. + * @see {@link UpdateStandardsControlCommandOutput} for command's `response` shape. + * @see {@link SecurityHubClientResolvedConfig | config} for command's `input` shape. + * */ export class UpdateStandardsControlCommand extends $Command< UpdateStandardsControlCommandInput, diff --git a/clients/client-securityhub/models/models_0.ts b/clients/client-securityhub/models/models_0.ts index e64ffa13b47e..66384061972d 100644 --- a/clients/client-securityhub/models/models_0.ts +++ b/clients/client-securityhub/models/models_0.ts @@ -14,6 +14,9 @@ export interface AcceptAdministratorInvitationRequest { } export namespace AcceptAdministratorInvitationRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: AcceptAdministratorInvitationRequest): any => ({ ...obj, }); @@ -22,6 +25,9 @@ export namespace AcceptAdministratorInvitationRequest { export interface AcceptAdministratorInvitationResponse {} export namespace AcceptAdministratorInvitationResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: AcceptAdministratorInvitationResponse): any => ({ ...obj, }); @@ -38,6 +44,9 @@ export interface InternalException extends __SmithyException, $MetadataBearer { } export namespace InternalException { + /** + * @internal + */ export const filterSensitiveLog = (obj: InternalException): any => ({ ...obj, }); @@ -55,6 +64,9 @@ export interface InvalidAccessException extends __SmithyException, $MetadataBear } export namespace InvalidAccessException { + /** + * @internal + */ export const filterSensitiveLog = (obj: InvalidAccessException): any => ({ ...obj, }); @@ -72,6 +84,9 @@ export interface InvalidInputException extends __SmithyException, $MetadataBeare } export namespace InvalidInputException { + /** + * @internal + */ export const filterSensitiveLog = (obj: InvalidInputException): any => ({ ...obj, }); @@ -89,6 +104,9 @@ export interface LimitExceededException extends __SmithyException, $MetadataBear } export namespace LimitExceededException { + /** + * @internal + */ export const filterSensitiveLog = (obj: LimitExceededException): any => ({ ...obj, }); @@ -105,6 +123,9 @@ export interface ResourceNotFoundException extends __SmithyException, $MetadataB } export namespace ResourceNotFoundException { + /** + * @internal + */ export const filterSensitiveLog = (obj: ResourceNotFoundException): any => ({ ...obj, }); @@ -123,6 +144,9 @@ export interface AcceptInvitationRequest { } export namespace AcceptInvitationRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: AcceptInvitationRequest): any => ({ ...obj, }); @@ -131,6 +155,9 @@ export namespace AcceptInvitationRequest { export interface AcceptInvitationResponse {} export namespace AcceptInvitationResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: AcceptInvitationResponse): any => ({ ...obj, }); @@ -147,6 +174,9 @@ export interface AccessDeniedException extends __SmithyException, $MetadataBeare } export namespace AccessDeniedException { + /** + * @internal + */ export const filterSensitiveLog = (obj: AccessDeniedException): any => ({ ...obj, }); @@ -168,6 +198,9 @@ export interface AccountDetails { } export namespace AccountDetails { + /** + * @internal + */ export const filterSensitiveLog = (obj: AccountDetails): any => ({ ...obj, }); @@ -185,6 +218,9 @@ export interface AwsApiCallActionDomainDetails { } export namespace AwsApiCallActionDomainDetails { + /** + * @internal + */ export const filterSensitiveLog = (obj: AwsApiCallActionDomainDetails): any => ({ ...obj, }); @@ -201,6 +237,9 @@ export interface City { } export namespace City { + /** + * @internal + */ export const filterSensitiveLog = (obj: City): any => ({ ...obj, }); @@ -222,6 +261,9 @@ export interface Country { } export namespace Country { + /** + * @internal + */ export const filterSensitiveLog = (obj: Country): any => ({ ...obj, }); @@ -243,6 +285,9 @@ export interface GeoLocation { } export namespace GeoLocation { + /** + * @internal + */ export const filterSensitiveLog = (obj: GeoLocation): any => ({ ...obj, }); @@ -274,6 +319,9 @@ export interface IpOrganizationDetails { } export namespace IpOrganizationDetails { + /** + * @internal + */ export const filterSensitiveLog = (obj: IpOrganizationDetails): any => ({ ...obj, }); @@ -313,6 +361,9 @@ export interface ActionRemoteIpDetails { } export namespace ActionRemoteIpDetails { + /** + * @internal + */ export const filterSensitiveLog = (obj: ActionRemoteIpDetails): any => ({ ...obj, }); @@ -370,6 +421,9 @@ export interface AwsApiCallAction { } export namespace AwsApiCallAction { + /** + * @internal + */ export const filterSensitiveLog = (obj: AwsApiCallAction): any => ({ ...obj, }); @@ -397,6 +451,9 @@ export interface DnsRequestAction { } export namespace DnsRequestAction { + /** + * @internal + */ export const filterSensitiveLog = (obj: DnsRequestAction): any => ({ ...obj, }); @@ -420,6 +477,9 @@ export interface ActionLocalPortDetails { } export namespace ActionLocalPortDetails { + /** + * @internal + */ export const filterSensitiveLog = (obj: ActionLocalPortDetails): any => ({ ...obj, }); @@ -442,6 +502,9 @@ export interface ActionRemotePortDetails { } export namespace ActionRemotePortDetails { + /** + * @internal + */ export const filterSensitiveLog = (obj: ActionRemotePortDetails): any => ({ ...obj, }); @@ -486,6 +549,9 @@ export interface NetworkConnectionAction { } export namespace NetworkConnectionAction { + /** + * @internal + */ export const filterSensitiveLog = (obj: NetworkConnectionAction): any => ({ ...obj, }); @@ -502,6 +568,9 @@ export interface ActionLocalIpDetails { } export namespace ActionLocalIpDetails { + /** + * @internal + */ export const filterSensitiveLog = (obj: ActionLocalIpDetails): any => ({ ...obj, }); @@ -530,6 +599,9 @@ export interface PortProbeDetail { } export namespace PortProbeDetail { + /** + * @internal + */ export const filterSensitiveLog = (obj: PortProbeDetail): any => ({ ...obj, }); @@ -552,6 +624,9 @@ export interface PortProbeAction { } export namespace PortProbeAction { + /** + * @internal + */ export const filterSensitiveLog = (obj: PortProbeAction): any => ({ ...obj, }); @@ -628,6 +703,9 @@ export interface Action { } export namespace Action { + /** + * @internal + */ export const filterSensitiveLog = (obj: Action): any => ({ ...obj, }); @@ -654,6 +732,9 @@ export interface ActionTarget { } export namespace ActionTarget { + /** + * @internal + */ export const filterSensitiveLog = (obj: ActionTarget): any => ({ ...obj, }); @@ -682,6 +763,9 @@ export interface AdminAccount { } export namespace AdminAccount { + /** + * @internal + */ export const filterSensitiveLog = (obj: AdminAccount): any => ({ ...obj, }); @@ -703,6 +787,9 @@ export interface AvailabilityZone { } export namespace AvailabilityZone { + /** + * @internal + */ export const filterSensitiveLog = (obj: AvailabilityZone): any => ({ ...obj, }); @@ -726,6 +813,9 @@ export interface AwsApiGatewayAccessLogSettings { } export namespace AwsApiGatewayAccessLogSettings { + /** + * @internal + */ export const filterSensitiveLog = (obj: AwsApiGatewayAccessLogSettings): any => ({ ...obj, }); @@ -760,6 +850,9 @@ export interface AwsApiGatewayCanarySettings { } export namespace AwsApiGatewayCanarySettings { + /** + * @internal + */ export const filterSensitiveLog = (obj: AwsApiGatewayCanarySettings): any => ({ ...obj, }); @@ -779,6 +872,9 @@ export interface AwsApiGatewayEndpointConfiguration { } export namespace AwsApiGatewayEndpointConfiguration { + /** + * @internal + */ export const filterSensitiveLog = (obj: AwsApiGatewayEndpointConfiguration): any => ({ ...obj, }); @@ -869,6 +965,9 @@ export interface AwsApiGatewayMethodSettings { } export namespace AwsApiGatewayMethodSettings { + /** + * @internal + */ export const filterSensitiveLog = (obj: AwsApiGatewayMethodSettings): any => ({ ...obj, }); @@ -936,6 +1035,9 @@ export interface AwsApiGatewayRestApiDetails { } export namespace AwsApiGatewayRestApiDetails { + /** + * @internal + */ export const filterSensitiveLog = (obj: AwsApiGatewayRestApiDetails): any => ({ ...obj, }); @@ -1046,6 +1148,9 @@ export interface AwsApiGatewayStageDetails { } export namespace AwsApiGatewayStageDetails { + /** + * @internal + */ export const filterSensitiveLog = (obj: AwsApiGatewayStageDetails): any => ({ ...obj, }); @@ -1088,6 +1193,9 @@ export interface AwsCorsConfiguration { } export namespace AwsCorsConfiguration { + /** + * @internal + */ export const filterSensitiveLog = (obj: AwsCorsConfiguration): any => ({ ...obj, }); @@ -1164,6 +1272,9 @@ export interface AwsApiGatewayV2ApiDetails { } export namespace AwsApiGatewayV2ApiDetails { + /** + * @internal + */ export const filterSensitiveLog = (obj: AwsApiGatewayV2ApiDetails): any => ({ ...obj, }); @@ -1208,6 +1319,9 @@ export interface AwsApiGatewayV2RouteSettings { } export namespace AwsApiGatewayV2RouteSettings { + /** + * @internal + */ export const filterSensitiveLog = (obj: AwsApiGatewayV2RouteSettings): any => ({ ...obj, }); @@ -1299,6 +1413,9 @@ export interface AwsApiGatewayV2StageDetails { } export namespace AwsApiGatewayV2StageDetails { + /** + * @internal + */ export const filterSensitiveLog = (obj: AwsApiGatewayV2StageDetails): any => ({ ...obj, }); @@ -1339,6 +1456,9 @@ export interface AwsAutoScalingAutoScalingGroupDetails { } export namespace AwsAutoScalingAutoScalingGroupDetails { + /** + * @internal + */ export const filterSensitiveLog = (obj: AwsAutoScalingAutoScalingGroupDetails): any => ({ ...obj, }); @@ -1366,6 +1486,9 @@ export interface AwsCertificateManagerCertificateResourceRecord { } export namespace AwsCertificateManagerCertificateResourceRecord { + /** + * @internal + */ export const filterSensitiveLog = (obj: AwsCertificateManagerCertificateResourceRecord): any => ({ ...obj, }); @@ -1419,6 +1542,9 @@ export interface AwsCertificateManagerCertificateDomainValidationOption { } export namespace AwsCertificateManagerCertificateDomainValidationOption { + /** + * @internal + */ export const filterSensitiveLog = (obj: AwsCertificateManagerCertificateDomainValidationOption): any => ({ ...obj, }); @@ -1442,6 +1568,9 @@ export interface AwsCertificateManagerCertificateExtendedKeyUsage { } export namespace AwsCertificateManagerCertificateExtendedKeyUsage { + /** + * @internal + */ export const filterSensitiveLog = (obj: AwsCertificateManagerCertificateExtendedKeyUsage): any => ({ ...obj, }); @@ -1458,6 +1587,9 @@ export interface AwsCertificateManagerCertificateKeyUsage { } export namespace AwsCertificateManagerCertificateKeyUsage { + /** + * @internal + */ export const filterSensitiveLog = (obj: AwsCertificateManagerCertificateKeyUsage): any => ({ ...obj, }); @@ -1476,6 +1608,9 @@ export interface AwsCertificateManagerCertificateOptions { } export namespace AwsCertificateManagerCertificateOptions { + /** + * @internal + */ export const filterSensitiveLog = (obj: AwsCertificateManagerCertificateOptions): any => ({ ...obj, }); @@ -1525,6 +1660,9 @@ export interface AwsCertificateManagerCertificateRenewalSummary { } export namespace AwsCertificateManagerCertificateRenewalSummary { + /** + * @internal + */ export const filterSensitiveLog = (obj: AwsCertificateManagerCertificateRenewalSummary): any => ({ ...obj, }); @@ -1705,6 +1843,9 @@ export interface AwsCertificateManagerCertificateDetails { } export namespace AwsCertificateManagerCertificateDetails { + /** + * @internal + */ export const filterSensitiveLog = (obj: AwsCertificateManagerCertificateDetails): any => ({ ...obj, }); @@ -1739,6 +1880,9 @@ export interface AwsCloudFrontDistributionCacheBehavior { } export namespace AwsCloudFrontDistributionCacheBehavior { + /** + * @internal + */ export const filterSensitiveLog = (obj: AwsCloudFrontDistributionCacheBehavior): any => ({ ...obj, }); @@ -1755,6 +1899,9 @@ export interface AwsCloudFrontDistributionCacheBehaviors { } export namespace AwsCloudFrontDistributionCacheBehaviors { + /** + * @internal + */ export const filterSensitiveLog = (obj: AwsCloudFrontDistributionCacheBehaviors): any => ({ ...obj, }); @@ -1789,6 +1936,9 @@ export interface AwsCloudFrontDistributionDefaultCacheBehavior { } export namespace AwsCloudFrontDistributionDefaultCacheBehavior { + /** + * @internal + */ export const filterSensitiveLog = (obj: AwsCloudFrontDistributionDefaultCacheBehavior): any => ({ ...obj, }); @@ -1821,6 +1971,9 @@ export interface AwsCloudFrontDistributionLogging { } export namespace AwsCloudFrontDistributionLogging { + /** + * @internal + */ export const filterSensitiveLog = (obj: AwsCloudFrontDistributionLogging): any => ({ ...obj, }); @@ -1842,6 +1995,9 @@ export interface AwsCloudFrontDistributionOriginGroupFailoverStatusCodes { } export namespace AwsCloudFrontDistributionOriginGroupFailoverStatusCodes { + /** + * @internal + */ export const filterSensitiveLog = (obj: AwsCloudFrontDistributionOriginGroupFailoverStatusCodes): any => ({ ...obj, }); @@ -1858,6 +2014,9 @@ export interface AwsCloudFrontDistributionOriginGroupFailover { } export namespace AwsCloudFrontDistributionOriginGroupFailover { + /** + * @internal + */ export const filterSensitiveLog = (obj: AwsCloudFrontDistributionOriginGroupFailover): any => ({ ...obj, }); @@ -1874,6 +2033,9 @@ export interface AwsCloudFrontDistributionOriginGroup { } export namespace AwsCloudFrontDistributionOriginGroup { + /** + * @internal + */ export const filterSensitiveLog = (obj: AwsCloudFrontDistributionOriginGroup): any => ({ ...obj, }); @@ -1891,6 +2053,9 @@ export interface AwsCloudFrontDistributionOriginGroups { } export namespace AwsCloudFrontDistributionOriginGroups { + /** + * @internal + */ export const filterSensitiveLog = (obj: AwsCloudFrontDistributionOriginGroups): any => ({ ...obj, }); @@ -1908,6 +2073,9 @@ export interface AwsCloudFrontDistributionOriginS3OriginConfig { } export namespace AwsCloudFrontDistributionOriginS3OriginConfig { + /** + * @internal + */ export const filterSensitiveLog = (obj: AwsCloudFrontDistributionOriginS3OriginConfig): any => ({ ...obj, }); @@ -1942,6 +2110,9 @@ export interface AwsCloudFrontDistributionOriginItem { } export namespace AwsCloudFrontDistributionOriginItem { + /** + * @internal + */ export const filterSensitiveLog = (obj: AwsCloudFrontDistributionOriginItem): any => ({ ...obj, }); @@ -1958,6 +2129,9 @@ export interface AwsCloudFrontDistributionOrigins { } export namespace AwsCloudFrontDistributionOrigins { + /** + * @internal + */ export const filterSensitiveLog = (obj: AwsCloudFrontDistributionOrigins): any => ({ ...obj, }); @@ -2030,6 +2204,9 @@ export interface AwsCloudFrontDistributionDetails { } export namespace AwsCloudFrontDistributionDetails { + /** + * @internal + */ export const filterSensitiveLog = (obj: AwsCloudFrontDistributionDetails): any => ({ ...obj, }); @@ -2120,6 +2297,9 @@ export interface AwsCloudTrailTrailDetails { } export namespace AwsCloudTrailTrailDetails { + /** + * @internal + */ export const filterSensitiveLog = (obj: AwsCloudTrailTrailDetails): any => ({ ...obj, }); @@ -2147,6 +2327,9 @@ export interface AwsCodeBuildProjectEnvironmentRegistryCredential { } export namespace AwsCodeBuildProjectEnvironmentRegistryCredential { + /** + * @internal + */ export const filterSensitiveLog = (obj: AwsCodeBuildProjectEnvironmentRegistryCredential): any => ({ ...obj, }); @@ -2211,6 +2394,9 @@ export interface AwsCodeBuildProjectEnvironment { } export namespace AwsCodeBuildProjectEnvironment { + /** + * @internal + */ export const filterSensitiveLog = (obj: AwsCodeBuildProjectEnvironment): any => ({ ...obj, }); @@ -2312,6 +2498,9 @@ export interface AwsCodeBuildProjectSource { } export namespace AwsCodeBuildProjectSource { + /** + * @internal + */ export const filterSensitiveLog = (obj: AwsCodeBuildProjectSource): any => ({ ...obj, }); @@ -2338,6 +2527,9 @@ export interface AwsCodeBuildProjectVpcConfig { } export namespace AwsCodeBuildProjectVpcConfig { + /** + * @internal + */ export const filterSensitiveLog = (obj: AwsCodeBuildProjectVpcConfig): any => ({ ...obj, }); @@ -2383,6 +2575,9 @@ export interface AwsCodeBuildProjectDetails { } export namespace AwsCodeBuildProjectDetails { + /** + * @internal + */ export const filterSensitiveLog = (obj: AwsCodeBuildProjectDetails): any => ({ ...obj, }); @@ -2404,6 +2599,9 @@ export interface AwsDynamoDbTableAttributeDefinition { } export namespace AwsDynamoDbTableAttributeDefinition { + /** + * @internal + */ export const filterSensitiveLog = (obj: AwsDynamoDbTableAttributeDefinition): any => ({ ...obj, }); @@ -2429,6 +2627,9 @@ export interface AwsDynamoDbTableBillingModeSummary { } export namespace AwsDynamoDbTableBillingModeSummary { + /** + * @internal + */ export const filterSensitiveLog = (obj: AwsDynamoDbTableBillingModeSummary): any => ({ ...obj, }); @@ -2451,6 +2652,9 @@ export interface AwsDynamoDbTableKeySchema { } export namespace AwsDynamoDbTableKeySchema { + /** + * @internal + */ export const filterSensitiveLog = (obj: AwsDynamoDbTableKeySchema): any => ({ ...obj, }); @@ -2474,6 +2678,9 @@ export interface AwsDynamoDbTableProjection { } export namespace AwsDynamoDbTableProjection { + /** + * @internal + */ export const filterSensitiveLog = (obj: AwsDynamoDbTableProjection): any => ({ ...obj, }); @@ -2520,6 +2727,9 @@ export interface AwsDynamoDbTableProvisionedThroughput { } export namespace AwsDynamoDbTableProvisionedThroughput { + /** + * @internal + */ export const filterSensitiveLog = (obj: AwsDynamoDbTableProvisionedThroughput): any => ({ ...obj, }); @@ -2576,6 +2786,9 @@ export interface AwsDynamoDbTableGlobalSecondaryIndex { } export namespace AwsDynamoDbTableGlobalSecondaryIndex { + /** + * @internal + */ export const filterSensitiveLog = (obj: AwsDynamoDbTableGlobalSecondaryIndex): any => ({ ...obj, }); @@ -2608,6 +2821,9 @@ export interface AwsDynamoDbTableLocalSecondaryIndex { } export namespace AwsDynamoDbTableLocalSecondaryIndex { + /** + * @internal + */ export const filterSensitiveLog = (obj: AwsDynamoDbTableLocalSecondaryIndex): any => ({ ...obj, }); @@ -2624,6 +2840,9 @@ export interface AwsDynamoDbTableProvisionedThroughputOverride { } export namespace AwsDynamoDbTableProvisionedThroughputOverride { + /** + * @internal + */ export const filterSensitiveLog = (obj: AwsDynamoDbTableProvisionedThroughputOverride): any => ({ ...obj, }); @@ -2645,6 +2864,9 @@ export interface AwsDynamoDbTableReplicaGlobalSecondaryIndex { } export namespace AwsDynamoDbTableReplicaGlobalSecondaryIndex { + /** + * @internal + */ export const filterSensitiveLog = (obj: AwsDynamoDbTableReplicaGlobalSecondaryIndex): any => ({ ...obj, }); @@ -2687,6 +2909,9 @@ export interface AwsDynamoDbTableReplica { } export namespace AwsDynamoDbTableReplica { + /** + * @internal + */ export const filterSensitiveLog = (obj: AwsDynamoDbTableReplica): any => ({ ...obj, }); @@ -2721,6 +2946,9 @@ export interface AwsDynamoDbTableRestoreSummary { } export namespace AwsDynamoDbTableRestoreSummary { + /** + * @internal + */ export const filterSensitiveLog = (obj: AwsDynamoDbTableRestoreSummary): any => ({ ...obj, }); @@ -2757,6 +2985,9 @@ export interface AwsDynamoDbTableSseDescription { } export namespace AwsDynamoDbTableSseDescription { + /** + * @internal + */ export const filterSensitiveLog = (obj: AwsDynamoDbTableSseDescription): any => ({ ...obj, }); @@ -2778,6 +3009,9 @@ export interface AwsDynamoDbTableStreamSpecification { } export namespace AwsDynamoDbTableStreamSpecification { + /** + * @internal + */ export const filterSensitiveLog = (obj: AwsDynamoDbTableStreamSpecification): any => ({ ...obj, }); @@ -2887,6 +3121,9 @@ export interface AwsDynamoDbTableDetails { } export namespace AwsDynamoDbTableDetails { + /** + * @internal + */ export const filterSensitiveLog = (obj: AwsDynamoDbTableDetails): any => ({ ...obj, }); @@ -2953,6 +3190,9 @@ export interface AwsEc2EipDetails { } export namespace AwsEc2EipDetails { + /** + * @internal + */ export const filterSensitiveLog = (obj: AwsEc2EipDetails): any => ({ ...obj, }); @@ -3012,6 +3252,9 @@ export interface AwsEc2InstanceDetails { } export namespace AwsEc2InstanceDetails { + /** + * @internal + */ export const filterSensitiveLog = (obj: AwsEc2InstanceDetails): any => ({ ...obj, }); @@ -3065,6 +3308,9 @@ export interface AwsEc2NetworkInterfaceAttachment { } export namespace AwsEc2NetworkInterfaceAttachment { + /** + * @internal + */ export const filterSensitiveLog = (obj: AwsEc2NetworkInterfaceAttachment): any => ({ ...obj, }); @@ -3082,6 +3328,9 @@ export interface AwsEc2NetworkInterfaceIpV6AddressDetail { } export namespace AwsEc2NetworkInterfaceIpV6AddressDetail { + /** + * @internal + */ export const filterSensitiveLog = (obj: AwsEc2NetworkInterfaceIpV6AddressDetail): any => ({ ...obj, }); @@ -3104,6 +3353,9 @@ export interface AwsEc2NetworkInterfacePrivateIpAddressDetail { } export namespace AwsEc2NetworkInterfacePrivateIpAddressDetail { + /** + * @internal + */ export const filterSensitiveLog = (obj: AwsEc2NetworkInterfacePrivateIpAddressDetail): any => ({ ...obj, }); @@ -3125,6 +3377,9 @@ export interface AwsEc2NetworkInterfaceSecurityGroup { } export namespace AwsEc2NetworkInterfaceSecurityGroup { + /** + * @internal + */ export const filterSensitiveLog = (obj: AwsEc2NetworkInterfaceSecurityGroup): any => ({ ...obj, }); @@ -3176,6 +3431,9 @@ export interface AwsEc2NetworkInterfaceDetails { } export namespace AwsEc2NetworkInterfaceDetails { + /** + * @internal + */ export const filterSensitiveLog = (obj: AwsEc2NetworkInterfaceDetails): any => ({ ...obj, }); @@ -3193,6 +3451,9 @@ export interface AwsEc2SecurityGroupIpRange { } export namespace AwsEc2SecurityGroupIpRange { + /** + * @internal + */ export const filterSensitiveLog = (obj: AwsEc2SecurityGroupIpRange): any => ({ ...obj, }); @@ -3210,6 +3471,9 @@ export interface AwsEc2SecurityGroupIpv6Range { } export namespace AwsEc2SecurityGroupIpv6Range { + /** + * @internal + */ export const filterSensitiveLog = (obj: AwsEc2SecurityGroupIpv6Range): any => ({ ...obj, }); @@ -3226,6 +3490,9 @@ export interface AwsEc2SecurityGroupPrefixListId { } export namespace AwsEc2SecurityGroupPrefixListId { + /** + * @internal + */ export const filterSensitiveLog = (obj: AwsEc2SecurityGroupPrefixListId): any => ({ ...obj, }); @@ -3272,6 +3539,9 @@ export interface AwsEc2SecurityGroupUserIdGroupPair { } export namespace AwsEc2SecurityGroupUserIdGroupPair { + /** + * @internal + */ export const filterSensitiveLog = (obj: AwsEc2SecurityGroupUserIdGroupPair): any => ({ ...obj, }); @@ -3334,6 +3604,9 @@ export interface AwsEc2SecurityGroupIpPermission { } export namespace AwsEc2SecurityGroupIpPermission { + /** + * @internal + */ export const filterSensitiveLog = (obj: AwsEc2SecurityGroupIpPermission): any => ({ ...obj, }); @@ -3375,6 +3648,9 @@ export interface AwsEc2SecurityGroupDetails { } export namespace AwsEc2SecurityGroupDetails { + /** + * @internal + */ export const filterSensitiveLog = (obj: AwsEc2SecurityGroupDetails): any => ({ ...obj, }); @@ -3406,6 +3682,9 @@ export interface AwsEc2VolumeAttachment { } export namespace AwsEc2VolumeAttachment { + /** + * @internal + */ export const filterSensitiveLog = (obj: AwsEc2VolumeAttachment): any => ({ ...obj, }); @@ -3456,6 +3735,9 @@ export interface AwsEc2VolumeDetails { } export namespace AwsEc2VolumeDetails { + /** + * @internal + */ export const filterSensitiveLog = (obj: AwsEc2VolumeDetails): any => ({ ...obj, }); @@ -3482,6 +3764,9 @@ export interface CidrBlockAssociation { } export namespace CidrBlockAssociation { + /** + * @internal + */ export const filterSensitiveLog = (obj: CidrBlockAssociation): any => ({ ...obj, }); @@ -3508,6 +3793,9 @@ export interface Ipv6CidrBlockAssociation { } export namespace Ipv6CidrBlockAssociation { + /** + * @internal + */ export const filterSensitiveLog = (obj: Ipv6CidrBlockAssociation): any => ({ ...obj, }); @@ -3541,6 +3829,9 @@ export interface AwsEc2VpcDetails { } export namespace AwsEc2VpcDetails { + /** + * @internal + */ export const filterSensitiveLog = (obj: AwsEc2VpcDetails): any => ({ ...obj, }); @@ -3575,6 +3866,9 @@ export interface AwsElasticsearchDomainDomainEndpointOptions { } export namespace AwsElasticsearchDomainDomainEndpointOptions { + /** + * @internal + */ export const filterSensitiveLog = (obj: AwsElasticsearchDomainDomainEndpointOptions): any => ({ ...obj, }); @@ -3596,6 +3890,9 @@ export interface AwsElasticsearchDomainEncryptionAtRestOptions { } export namespace AwsElasticsearchDomainEncryptionAtRestOptions { + /** + * @internal + */ export const filterSensitiveLog = (obj: AwsElasticsearchDomainEncryptionAtRestOptions): any => ({ ...obj, }); @@ -3612,6 +3909,9 @@ export interface AwsElasticsearchDomainNodeToNodeEncryptionOptions { } export namespace AwsElasticsearchDomainNodeToNodeEncryptionOptions { + /** + * @internal + */ export const filterSensitiveLog = (obj: AwsElasticsearchDomainNodeToNodeEncryptionOptions): any => ({ ...obj, }); @@ -3644,6 +3944,9 @@ export interface AwsElasticsearchDomainVPCOptions { } export namespace AwsElasticsearchDomainVPCOptions { + /** + * @internal + */ export const filterSensitiveLog = (obj: AwsElasticsearchDomainVPCOptions): any => ({ ...obj, }); @@ -3713,6 +4016,9 @@ export interface AwsElasticsearchDomainDetails { } export namespace AwsElasticsearchDomainDetails { + /** + * @internal + */ export const filterSensitiveLog = (obj: AwsElasticsearchDomainDetails): any => ({ ...obj, }); @@ -3736,6 +4042,9 @@ export interface AwsElbAppCookieStickinessPolicy { } export namespace AwsElbAppCookieStickinessPolicy { + /** + * @internal + */ export const filterSensitiveLog = (obj: AwsElbAppCookieStickinessPolicy): any => ({ ...obj, }); @@ -3761,6 +4070,9 @@ export interface AwsElbLbCookieStickinessPolicy { } export namespace AwsElbLbCookieStickinessPolicy { + /** + * @internal + */ export const filterSensitiveLog = (obj: AwsElbLbCookieStickinessPolicy): any => ({ ...obj, }); @@ -3794,6 +4106,9 @@ export interface AwsElbLoadBalancerAccessLog { } export namespace AwsElbLoadBalancerAccessLog { + /** + * @internal + */ export const filterSensitiveLog = (obj: AwsElbLoadBalancerAccessLog): any => ({ ...obj, }); @@ -3817,6 +4132,9 @@ export interface AwsElbLoadBalancerConnectionDraining { } export namespace AwsElbLoadBalancerConnectionDraining { + /** + * @internal + */ export const filterSensitiveLog = (obj: AwsElbLoadBalancerConnectionDraining): any => ({ ...obj, }); @@ -3834,6 +4152,9 @@ export interface AwsElbLoadBalancerConnectionSettings { } export namespace AwsElbLoadBalancerConnectionSettings { + /** + * @internal + */ export const filterSensitiveLog = (obj: AwsElbLoadBalancerConnectionSettings): any => ({ ...obj, }); @@ -3850,6 +4171,9 @@ export interface AwsElbLoadBalancerCrossZoneLoadBalancing { } export namespace AwsElbLoadBalancerCrossZoneLoadBalancing { + /** + * @internal + */ export const filterSensitiveLog = (obj: AwsElbLoadBalancerCrossZoneLoadBalancing): any => ({ ...obj, }); @@ -3890,6 +4214,9 @@ export interface AwsElbLoadBalancerAttributes { } export namespace AwsElbLoadBalancerAttributes { + /** + * @internal + */ export const filterSensitiveLog = (obj: AwsElbLoadBalancerAttributes): any => ({ ...obj, }); @@ -3912,6 +4239,9 @@ export interface AwsElbLoadBalancerBackendServerDescription { } export namespace AwsElbLoadBalancerBackendServerDescription { + /** + * @internal + */ export const filterSensitiveLog = (obj: AwsElbLoadBalancerBackendServerDescription): any => ({ ...obj, }); @@ -3967,6 +4297,9 @@ export interface AwsElbLoadBalancerHealthCheck { } export namespace AwsElbLoadBalancerHealthCheck { + /** + * @internal + */ export const filterSensitiveLog = (obj: AwsElbLoadBalancerHealthCheck): any => ({ ...obj, }); @@ -3983,6 +4316,9 @@ export interface AwsElbLoadBalancerInstance { } export namespace AwsElbLoadBalancerInstance { + /** + * @internal + */ export const filterSensitiveLog = (obj: AwsElbLoadBalancerInstance): any => ({ ...obj, }); @@ -4028,6 +4364,9 @@ export interface AwsElbLoadBalancerListener { } export namespace AwsElbLoadBalancerListener { + /** + * @internal + */ export const filterSensitiveLog = (obj: AwsElbLoadBalancerListener): any => ({ ...obj, }); @@ -4049,6 +4388,9 @@ export interface AwsElbLoadBalancerListenerDescription { } export namespace AwsElbLoadBalancerListenerDescription { + /** + * @internal + */ export const filterSensitiveLog = (obj: AwsElbLoadBalancerListenerDescription): any => ({ ...obj, }); @@ -4077,6 +4419,9 @@ export interface AwsElbLoadBalancerPolicies { } export namespace AwsElbLoadBalancerPolicies { + /** + * @internal + */ export const filterSensitiveLog = (obj: AwsElbLoadBalancerPolicies): any => ({ ...obj, }); @@ -4098,6 +4443,9 @@ export interface AwsElbLoadBalancerSourceSecurityGroup { } export namespace AwsElbLoadBalancerSourceSecurityGroup { + /** + * @internal + */ export const filterSensitiveLog = (obj: AwsElbLoadBalancerSourceSecurityGroup): any => ({ ...obj, }); @@ -4203,6 +4551,9 @@ export interface AwsElbLoadBalancerDetails { } export namespace AwsElbLoadBalancerDetails { + /** + * @internal + */ export const filterSensitiveLog = (obj: AwsElbLoadBalancerDetails): any => ({ ...obj, }); @@ -4227,6 +4578,9 @@ export interface LoadBalancerState { } export namespace LoadBalancerState { + /** + * @internal + */ export const filterSensitiveLog = (obj: LoadBalancerState): any => ({ ...obj, }); @@ -4293,6 +4647,9 @@ export interface AwsElbv2LoadBalancerDetails { } export namespace AwsElbv2LoadBalancerDetails { + /** + * @internal + */ export const filterSensitiveLog = (obj: AwsElbv2LoadBalancerDetails): any => ({ ...obj, }); @@ -4317,6 +4674,9 @@ export interface AwsIamAccessKeySessionContextAttributes { } export namespace AwsIamAccessKeySessionContextAttributes { + /** + * @internal + */ export const filterSensitiveLog = (obj: AwsIamAccessKeySessionContextAttributes): any => ({ ...obj, }); @@ -4354,6 +4714,9 @@ export interface AwsIamAccessKeySessionContextSessionIssuer { } export namespace AwsIamAccessKeySessionContextSessionIssuer { + /** + * @internal + */ export const filterSensitiveLog = (obj: AwsIamAccessKeySessionContextSessionIssuer): any => ({ ...obj, }); @@ -4375,6 +4738,9 @@ export interface AwsIamAccessKeySessionContext { } export namespace AwsIamAccessKeySessionContext { + /** + * @internal + */ export const filterSensitiveLog = (obj: AwsIamAccessKeySessionContext): any => ({ ...obj, }); @@ -4444,6 +4810,9 @@ export interface AwsIamAccessKeyDetails { } export namespace AwsIamAccessKeyDetails { + /** + * @internal + */ export const filterSensitiveLog = (obj: AwsIamAccessKeyDetails): any => ({ ...obj, }); @@ -4465,6 +4834,9 @@ export interface AwsIamAttachedManagedPolicy { } export namespace AwsIamAttachedManagedPolicy { + /** + * @internal + */ export const filterSensitiveLog = (obj: AwsIamAttachedManagedPolicy): any => ({ ...obj, }); @@ -4481,6 +4853,9 @@ export interface AwsIamGroupPolicy { } export namespace AwsIamGroupPolicy { + /** + * @internal + */ export const filterSensitiveLog = (obj: AwsIamGroupPolicy): any => ({ ...obj, }); @@ -4525,6 +4900,9 @@ export interface AwsIamGroupDetails { } export namespace AwsIamGroupDetails { + /** + * @internal + */ export const filterSensitiveLog = (obj: AwsIamGroupDetails): any => ({ ...obj, }); @@ -4569,6 +4947,9 @@ export interface AwsIamInstanceProfileRole { } export namespace AwsIamInstanceProfileRole { + /** + * @internal + */ export const filterSensitiveLog = (obj: AwsIamInstanceProfileRole): any => ({ ...obj, }); @@ -4613,6 +4994,9 @@ export interface AwsIamInstanceProfile { } export namespace AwsIamInstanceProfile { + /** + * @internal + */ export const filterSensitiveLog = (obj: AwsIamInstanceProfile): any => ({ ...obj, }); @@ -4635,6 +5019,9 @@ export interface AwsIamPermissionsBoundary { } export namespace AwsIamPermissionsBoundary { + /** + * @internal + */ export const filterSensitiveLog = (obj: AwsIamPermissionsBoundary): any => ({ ...obj, }); @@ -4664,6 +5051,9 @@ export interface AwsIamPolicyVersion { } export namespace AwsIamPolicyVersion { + /** + * @internal + */ export const filterSensitiveLog = (obj: AwsIamPolicyVersion): any => ({ ...obj, }); @@ -4737,6 +5127,9 @@ export interface AwsIamPolicyDetails { } export namespace AwsIamPolicyDetails { + /** + * @internal + */ export const filterSensitiveLog = (obj: AwsIamPolicyDetails): any => ({ ...obj, }); @@ -4753,6 +5146,9 @@ export interface AwsIamRolePolicy { } export namespace AwsIamRolePolicy { + /** + * @internal + */ export const filterSensitiveLog = (obj: AwsIamRolePolicy): any => ({ ...obj, }); @@ -4818,6 +5214,9 @@ export interface AwsIamRoleDetails { } export namespace AwsIamRoleDetails { + /** + * @internal + */ export const filterSensitiveLog = (obj: AwsIamRoleDetails): any => ({ ...obj, }); @@ -4834,6 +5233,9 @@ export interface AwsIamUserPolicy { } export namespace AwsIamUserPolicy { + /** + * @internal + */ export const filterSensitiveLog = (obj: AwsIamUserPolicy): any => ({ ...obj, }); @@ -4888,6 +5290,9 @@ export interface AwsIamUserDetails { } export namespace AwsIamUserDetails { + /** + * @internal + */ export const filterSensitiveLog = (obj: AwsIamUserDetails): any => ({ ...obj, }); @@ -4942,6 +5347,9 @@ export interface AwsKmsKeyDetails { } export namespace AwsKmsKeyDetails { + /** + * @internal + */ export const filterSensitiveLog = (obj: AwsKmsKeyDetails): any => ({ ...obj, }); @@ -4973,6 +5381,9 @@ export interface AwsLambdaFunctionCode { } export namespace AwsLambdaFunctionCode { + /** + * @internal + */ export const filterSensitiveLog = (obj: AwsLambdaFunctionCode): any => ({ ...obj, }); @@ -4989,6 +5400,9 @@ export interface AwsLambdaFunctionDeadLetterConfig { } export namespace AwsLambdaFunctionDeadLetterConfig { + /** + * @internal + */ export const filterSensitiveLog = (obj: AwsLambdaFunctionDeadLetterConfig): any => ({ ...obj, }); @@ -5010,6 +5424,9 @@ export interface AwsLambdaFunctionEnvironmentError { } export namespace AwsLambdaFunctionEnvironmentError { + /** + * @internal + */ export const filterSensitiveLog = (obj: AwsLambdaFunctionEnvironmentError): any => ({ ...obj, }); @@ -5031,6 +5448,9 @@ export interface AwsLambdaFunctionEnvironment { } export namespace AwsLambdaFunctionEnvironment { + /** + * @internal + */ export const filterSensitiveLog = (obj: AwsLambdaFunctionEnvironment): any => ({ ...obj, }); @@ -5052,6 +5472,9 @@ export interface AwsLambdaFunctionLayer { } export namespace AwsLambdaFunctionLayer { + /** + * @internal + */ export const filterSensitiveLog = (obj: AwsLambdaFunctionLayer): any => ({ ...obj, }); @@ -5068,6 +5491,9 @@ export interface AwsLambdaFunctionTracingConfig { } export namespace AwsLambdaFunctionTracingConfig { + /** + * @internal + */ export const filterSensitiveLog = (obj: AwsLambdaFunctionTracingConfig): any => ({ ...obj, }); @@ -5094,6 +5520,9 @@ export interface AwsLambdaFunctionVpcConfig { } export namespace AwsLambdaFunctionVpcConfig { + /** + * @internal + */ export const filterSensitiveLog = (obj: AwsLambdaFunctionVpcConfig): any => ({ ...obj, }); @@ -5198,6 +5627,9 @@ export interface AwsLambdaFunctionDetails { } export namespace AwsLambdaFunctionDetails { + /** + * @internal + */ export const filterSensitiveLog = (obj: AwsLambdaFunctionDetails): any => ({ ...obj, }); @@ -5233,6 +5665,9 @@ export interface AwsLambdaLayerVersionDetails { } export namespace AwsLambdaLayerVersionDetails { + /** + * @internal + */ export const filterSensitiveLog = (obj: AwsLambdaLayerVersionDetails): any => ({ ...obj, }); @@ -5254,6 +5689,9 @@ export interface AwsRdsDbClusterAssociatedRole { } export namespace AwsRdsDbClusterAssociatedRole { + /** + * @internal + */ export const filterSensitiveLog = (obj: AwsRdsDbClusterAssociatedRole): any => ({ ...obj, }); @@ -5286,6 +5724,9 @@ export interface AwsRdsDbClusterMember { } export namespace AwsRdsDbClusterMember { + /** + * @internal + */ export const filterSensitiveLog = (obj: AwsRdsDbClusterMember): any => ({ ...obj, }); @@ -5307,6 +5748,9 @@ export interface AwsRdsDbClusterOptionGroupMembership { } export namespace AwsRdsDbClusterOptionGroupMembership { + /** + * @internal + */ export const filterSensitiveLog = (obj: AwsRdsDbClusterOptionGroupMembership): any => ({ ...obj, }); @@ -5339,6 +5783,9 @@ export interface AwsRdsDbDomainMembership { } export namespace AwsRdsDbDomainMembership { + /** + * @internal + */ export const filterSensitiveLog = (obj: AwsRdsDbDomainMembership): any => ({ ...obj, }); @@ -5360,6 +5807,9 @@ export interface AwsRdsDbInstanceVpcSecurityGroup { } export namespace AwsRdsDbInstanceVpcSecurityGroup { + /** + * @internal + */ export const filterSensitiveLog = (obj: AwsRdsDbInstanceVpcSecurityGroup): any => ({ ...obj, }); @@ -5576,6 +6026,9 @@ export interface AwsRdsDbClusterDetails { } export namespace AwsRdsDbClusterDetails { + /** + * @internal + */ export const filterSensitiveLog = (obj: AwsRdsDbClusterDetails): any => ({ ...obj, }); @@ -5684,6 +6137,9 @@ export interface AwsRdsDbClusterSnapshotDetails { } export namespace AwsRdsDbClusterSnapshotDetails { + /** + * @internal + */ export const filterSensitiveLog = (obj: AwsRdsDbClusterSnapshotDetails): any => ({ ...obj, }); @@ -5730,6 +6186,9 @@ export interface AwsRdsDbInstanceAssociatedRole { } export namespace AwsRdsDbInstanceAssociatedRole { + /** + * @internal + */ export const filterSensitiveLog = (obj: AwsRdsDbInstanceAssociatedRole): any => ({ ...obj, }); @@ -5751,6 +6210,9 @@ export interface AwsRdsDbParameterGroup { } export namespace AwsRdsDbParameterGroup { + /** + * @internal + */ export const filterSensitiveLog = (obj: AwsRdsDbParameterGroup): any => ({ ...obj, }); @@ -5767,6 +6229,9 @@ export interface AwsRdsDbSubnetGroupSubnetAvailabilityZone { } export namespace AwsRdsDbSubnetGroupSubnetAvailabilityZone { + /** + * @internal + */ export const filterSensitiveLog = (obj: AwsRdsDbSubnetGroupSubnetAvailabilityZone): any => ({ ...obj, }); @@ -5793,6 +6258,9 @@ export interface AwsRdsDbSubnetGroupSubnet { } export namespace AwsRdsDbSubnetGroupSubnet { + /** + * @internal + */ export const filterSensitiveLog = (obj: AwsRdsDbSubnetGroupSubnet): any => ({ ...obj, }); @@ -5834,6 +6302,9 @@ export interface AwsRdsDbSubnetGroup { } export namespace AwsRdsDbSubnetGroup { + /** + * @internal + */ export const filterSensitiveLog = (obj: AwsRdsDbSubnetGroup): any => ({ ...obj, }); @@ -5860,6 +6331,9 @@ export interface AwsRdsDbInstanceEndpoint { } export namespace AwsRdsDbInstanceEndpoint { + /** + * @internal + */ export const filterSensitiveLog = (obj: AwsRdsDbInstanceEndpoint): any => ({ ...obj, }); @@ -5881,6 +6355,9 @@ export interface AwsRdsDbOptionGroupMembership { } export namespace AwsRdsDbOptionGroupMembership { + /** + * @internal + */ export const filterSensitiveLog = (obj: AwsRdsDbOptionGroupMembership): any => ({ ...obj, }); @@ -5902,6 +6379,9 @@ export interface AwsRdsPendingCloudWatchLogsExports { } export namespace AwsRdsPendingCloudWatchLogsExports { + /** + * @internal + */ export const filterSensitiveLog = (obj: AwsRdsPendingCloudWatchLogsExports): any => ({ ...obj, }); @@ -5923,6 +6403,9 @@ export interface AwsRdsDbProcessorFeature { } export namespace AwsRdsDbProcessorFeature { + /** + * @internal + */ export const filterSensitiveLog = (obj: AwsRdsDbProcessorFeature): any => ({ ...obj, }); @@ -6009,6 +6492,9 @@ export interface AwsRdsDbPendingModifiedValues { } export namespace AwsRdsDbPendingModifiedValues { + /** + * @internal + */ export const filterSensitiveLog = (obj: AwsRdsDbPendingModifiedValues): any => ({ ...obj, }); @@ -6040,6 +6526,9 @@ export interface AwsRdsDbStatusInfo { } export namespace AwsRdsDbStatusInfo { + /** + * @internal + */ export const filterSensitiveLog = (obj: AwsRdsDbStatusInfo): any => ({ ...obj, }); @@ -6398,6 +6887,9 @@ export interface AwsRdsDbInstanceDetails { } export namespace AwsRdsDbInstanceDetails { + /** + * @internal + */ export const filterSensitiveLog = (obj: AwsRdsDbInstanceDetails): any => ({ ...obj, }); @@ -6544,6 +7036,9 @@ export interface AwsRdsDbSnapshotDetails { } export namespace AwsRdsDbSnapshotDetails { + /** + * @internal + */ export const filterSensitiveLog = (obj: AwsRdsDbSnapshotDetails): any => ({ ...obj, }); @@ -6570,6 +7065,9 @@ export interface AwsRedshiftClusterClusterNode { } export namespace AwsRedshiftClusterClusterNode { + /** + * @internal + */ export const filterSensitiveLog = (obj: AwsRedshiftClusterClusterNode): any => ({ ...obj, }); @@ -6602,6 +7100,9 @@ export interface AwsRedshiftClusterClusterParameterStatus { } export namespace AwsRedshiftClusterClusterParameterStatus { + /** + * @internal + */ export const filterSensitiveLog = (obj: AwsRedshiftClusterClusterParameterStatus): any => ({ ...obj, }); @@ -6628,6 +7129,9 @@ export interface AwsRedshiftClusterClusterParameterGroup { } export namespace AwsRedshiftClusterClusterParameterGroup { + /** + * @internal + */ export const filterSensitiveLog = (obj: AwsRedshiftClusterClusterParameterGroup): any => ({ ...obj, }); @@ -6649,6 +7153,9 @@ export interface AwsRedshiftClusterClusterSecurityGroup { } export namespace AwsRedshiftClusterClusterSecurityGroup { + /** + * @internal + */ export const filterSensitiveLog = (obj: AwsRedshiftClusterClusterSecurityGroup): any => ({ ...obj, }); @@ -6685,6 +7192,9 @@ export interface AwsRedshiftClusterClusterSnapshotCopyStatus { } export namespace AwsRedshiftClusterClusterSnapshotCopyStatus { + /** + * @internal + */ export const filterSensitiveLog = (obj: AwsRedshiftClusterClusterSnapshotCopyStatus): any => ({ ...obj, }); @@ -6718,6 +7228,9 @@ export interface AwsRedshiftClusterDeferredMaintenanceWindow { } export namespace AwsRedshiftClusterDeferredMaintenanceWindow { + /** + * @internal + */ export const filterSensitiveLog = (obj: AwsRedshiftClusterDeferredMaintenanceWindow): any => ({ ...obj, }); @@ -6739,6 +7252,9 @@ export interface AwsRedshiftClusterElasticIpStatus { } export namespace AwsRedshiftClusterElasticIpStatus { + /** + * @internal + */ export const filterSensitiveLog = (obj: AwsRedshiftClusterElasticIpStatus): any => ({ ...obj, }); @@ -6760,6 +7276,9 @@ export interface AwsRedshiftClusterEndpoint { } export namespace AwsRedshiftClusterEndpoint { + /** + * @internal + */ export const filterSensitiveLog = (obj: AwsRedshiftClusterEndpoint): any => ({ ...obj, }); @@ -6794,6 +7313,9 @@ export interface AwsRedshiftClusterHsmStatus { } export namespace AwsRedshiftClusterHsmStatus { + /** + * @internal + */ export const filterSensitiveLog = (obj: AwsRedshiftClusterHsmStatus): any => ({ ...obj, }); @@ -6817,6 +7339,9 @@ export interface AwsRedshiftClusterIamRole { } export namespace AwsRedshiftClusterIamRole { + /** + * @internal + */ export const filterSensitiveLog = (obj: AwsRedshiftClusterIamRole): any => ({ ...obj, }); @@ -6885,6 +7410,9 @@ export interface AwsRedshiftClusterPendingModifiedValues { } export namespace AwsRedshiftClusterPendingModifiedValues { + /** + * @internal + */ export const filterSensitiveLog = (obj: AwsRedshiftClusterPendingModifiedValues): any => ({ ...obj, }); @@ -6908,6 +7436,9 @@ export interface AwsRedshiftClusterResizeInfo { } export namespace AwsRedshiftClusterResizeInfo { + /** + * @internal + */ export const filterSensitiveLog = (obj: AwsRedshiftClusterResizeInfo): any => ({ ...obj, }); @@ -6961,6 +7492,9 @@ export interface AwsRedshiftClusterRestoreStatus { } export namespace AwsRedshiftClusterRestoreStatus { + /** + * @internal + */ export const filterSensitiveLog = (obj: AwsRedshiftClusterRestoreStatus): any => ({ ...obj, }); @@ -6982,6 +7516,9 @@ export interface AwsRedshiftClusterVpcSecurityGroup { } export namespace AwsRedshiftClusterVpcSecurityGroup { + /** + * @internal + */ export const filterSensitiveLog = (obj: AwsRedshiftClusterVpcSecurityGroup): any => ({ ...obj, }); @@ -7283,6 +7820,9 @@ export interface AwsRedshiftClusterDetails { } export namespace AwsRedshiftClusterDetails { + /** + * @internal + */ export const filterSensitiveLog = (obj: AwsRedshiftClusterDetails): any => ({ ...obj, }); @@ -7314,6 +7854,9 @@ export interface AwsS3AccountPublicAccessBlockDetails { } export namespace AwsS3AccountPublicAccessBlockDetails { + /** + * @internal + */ export const filterSensitiveLog = (obj: AwsS3AccountPublicAccessBlockDetails): any => ({ ...obj, }); @@ -7336,6 +7879,9 @@ export interface AwsS3BucketServerSideEncryptionByDefault { } export namespace AwsS3BucketServerSideEncryptionByDefault { + /** + * @internal + */ export const filterSensitiveLog = (obj: AwsS3BucketServerSideEncryptionByDefault): any => ({ ...obj, }); @@ -7354,6 +7900,9 @@ export interface AwsS3BucketServerSideEncryptionRule { } export namespace AwsS3BucketServerSideEncryptionRule { + /** + * @internal + */ export const filterSensitiveLog = (obj: AwsS3BucketServerSideEncryptionRule): any => ({ ...obj, }); @@ -7370,6 +7919,9 @@ export interface AwsS3BucketServerSideEncryptionConfiguration { } export namespace AwsS3BucketServerSideEncryptionConfiguration { + /** + * @internal + */ export const filterSensitiveLog = (obj: AwsS3BucketServerSideEncryptionConfiguration): any => ({ ...obj, }); @@ -7409,6 +7961,9 @@ export interface AwsS3BucketDetails { } export namespace AwsS3BucketDetails { + /** + * @internal + */ export const filterSensitiveLog = (obj: AwsS3BucketDetails): any => ({ ...obj, }); @@ -7456,6 +8011,9 @@ export interface AwsS3ObjectDetails { } export namespace AwsS3ObjectDetails { + /** + * @internal + */ export const filterSensitiveLog = (obj: AwsS3ObjectDetails): any => ({ ...obj, }); @@ -7472,6 +8030,9 @@ export interface AwsSecretsManagerSecretRotationRules { } export namespace AwsSecretsManagerSecretRotationRules { + /** + * @internal + */ export const filterSensitiveLog = (obj: AwsSecretsManagerSecretRotationRules): any => ({ ...obj, }); @@ -7525,6 +8086,9 @@ export interface AwsSecretsManagerSecretDetails { } export namespace AwsSecretsManagerSecretDetails { + /** + * @internal + */ export const filterSensitiveLog = (obj: AwsSecretsManagerSecretDetails): any => ({ ...obj, }); @@ -7555,6 +8119,9 @@ export interface StatusReason { } export namespace StatusReason { + /** + * @internal + */ export const filterSensitiveLog = (obj: StatusReason): any => ({ ...obj, }); @@ -7615,6 +8182,9 @@ export interface Compliance { } export namespace Compliance { + /** + * @internal + */ export const filterSensitiveLog = (obj: Compliance): any => ({ ...obj, }); @@ -7636,6 +8206,9 @@ export interface RelatedFinding { } export namespace RelatedFinding { + /** + * @internal + */ export const filterSensitiveLog = (obj: RelatedFinding): any => ({ ...obj, }); @@ -7665,6 +8238,9 @@ export interface FindingProviderSeverity { } export namespace FindingProviderSeverity { + /** + * @internal + */ export const filterSensitiveLog = (obj: FindingProviderSeverity): any => ({ ...obj, }); @@ -7709,6 +8285,9 @@ export interface FindingProviderFields { } export namespace FindingProviderFields { + /** + * @internal + */ export const filterSensitiveLog = (obj: FindingProviderFields): any => ({ ...obj, }); @@ -7764,6 +8343,9 @@ export interface Malware { } export namespace Malware { + /** + * @internal + */ export const filterSensitiveLog = (obj: Malware): any => ({ ...obj, }); @@ -7790,6 +8372,9 @@ export interface PortRange { } export namespace PortRange { + /** + * @internal + */ export const filterSensitiveLog = (obj: PortRange): any => ({ ...obj, }); @@ -7862,6 +8447,9 @@ export interface Network { } export namespace Network { + /** + * @internal + */ export const filterSensitiveLog = (obj: Network): any => ({ ...obj, }); @@ -7883,6 +8471,9 @@ export interface NetworkPathComponentDetails { } export namespace NetworkPathComponentDetails { + /** + * @internal + */ export const filterSensitiveLog = (obj: NetworkPathComponentDetails): any => ({ ...obj, }); @@ -7910,6 +8501,9 @@ export interface NetworkHeader { } export namespace NetworkHeader { + /** + * @internal + */ export const filterSensitiveLog = (obj: NetworkHeader): any => ({ ...obj, }); @@ -7943,6 +8537,9 @@ export interface NetworkPathComponent { } export namespace NetworkPathComponent { + /** + * @internal + */ export const filterSensitiveLog = (obj: NetworkPathComponent): any => ({ ...obj, }); @@ -7972,6 +8569,9 @@ export interface Note { } export namespace Note { + /** + * @internal + */ export const filterSensitiveLog = (obj: Note): any => ({ ...obj, }); @@ -8051,6 +8651,9 @@ export interface PatchSummary { } export namespace PatchSummary { + /** + * @internal + */ export const filterSensitiveLog = (obj: PatchSummary): any => ({ ...obj, }); @@ -8098,6 +8701,9 @@ export interface ProcessDetails { } export namespace ProcessDetails { + /** + * @internal + */ export const filterSensitiveLog = (obj: ProcessDetails): any => ({ ...obj, }); @@ -8124,6 +8730,9 @@ export interface Recommendation { } export namespace Recommendation { + /** + * @internal + */ export const filterSensitiveLog = (obj: Recommendation): any => ({ ...obj, }); @@ -8140,6 +8749,9 @@ export interface Remediation { } export namespace Remediation { + /** + * @internal + */ export const filterSensitiveLog = (obj: Remediation): any => ({ ...obj, }); @@ -8171,6 +8783,9 @@ export interface Cell { } export namespace Cell { + /** + * @internal + */ export const filterSensitiveLog = (obj: Cell): any => ({ ...obj, }); @@ -8197,6 +8812,9 @@ export interface Range { } export namespace Range { + /** + * @internal + */ export const filterSensitiveLog = (obj: Range): any => ({ ...obj, }); @@ -8223,6 +8841,9 @@ export interface Page { } export namespace Page { + /** + * @internal + */ export const filterSensitiveLog = (obj: Page): any => ({ ...obj, }); @@ -8244,6 +8865,9 @@ export interface _Record { } export namespace _Record { + /** + * @internal + */ export const filterSensitiveLog = (obj: _Record): any => ({ ...obj, }); @@ -8280,6 +8904,9 @@ export interface Occurrences { } export namespace Occurrences { + /** + * @internal + */ export const filterSensitiveLog = (obj: Occurrences): any => ({ ...obj, }); @@ -8311,6 +8938,9 @@ export interface CustomDataIdentifiersDetections { } export namespace CustomDataIdentifiersDetections { + /** + * @internal + */ export const filterSensitiveLog = (obj: CustomDataIdentifiersDetections): any => ({ ...obj, }); @@ -8332,6 +8962,9 @@ export interface CustomDataIdentifiersResult { } export namespace CustomDataIdentifiersResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: CustomDataIdentifiersResult): any => ({ ...obj, }); @@ -8358,6 +8991,9 @@ export interface SensitiveDataDetections { } export namespace SensitiveDataDetections { + /** + * @internal + */ export const filterSensitiveLog = (obj: SensitiveDataDetections): any => ({ ...obj, }); @@ -8384,6 +9020,9 @@ export interface SensitiveDataResult { } export namespace SensitiveDataResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: SensitiveDataResult): any => ({ ...obj, }); @@ -8405,6 +9044,9 @@ export interface ClassificationStatus { } export namespace ClassificationStatus { + /** + * @internal + */ export const filterSensitiveLog = (obj: ClassificationStatus): any => ({ ...obj, }); @@ -8446,6 +9088,9 @@ export interface ClassificationResult { } export namespace ClassificationResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: ClassificationResult): any => ({ ...obj, }); @@ -8467,6 +9112,9 @@ export interface DataClassificationDetails { } export namespace DataClassificationDetails { + /** + * @internal + */ export const filterSensitiveLog = (obj: DataClassificationDetails): any => ({ ...obj, }); @@ -8488,6 +9136,9 @@ export interface AwsSnsTopicSubscription { } export namespace AwsSnsTopicSubscription { + /** + * @internal + */ export const filterSensitiveLog = (obj: AwsSnsTopicSubscription): any => ({ ...obj, }); @@ -8520,6 +9171,9 @@ export interface AwsSnsTopicDetails { } export namespace AwsSnsTopicDetails { + /** + * @internal + */ export const filterSensitiveLog = (obj: AwsSnsTopicDetails): any => ({ ...obj, }); @@ -8553,6 +9207,9 @@ export interface AwsSqsQueueDetails { } export namespace AwsSqsQueueDetails { + /** + * @internal + */ export const filterSensitiveLog = (obj: AwsSqsQueueDetails): any => ({ ...obj, }); @@ -8687,6 +9344,9 @@ export interface AwsSsmComplianceSummary { } export namespace AwsSsmComplianceSummary { + /** + * @internal + */ export const filterSensitiveLog = (obj: AwsSsmComplianceSummary): any => ({ ...obj, }); @@ -8703,6 +9363,9 @@ export interface AwsSsmPatch { } export namespace AwsSsmPatch { + /** + * @internal + */ export const filterSensitiveLog = (obj: AwsSsmPatch): any => ({ ...obj, }); @@ -8720,6 +9383,9 @@ export interface AwsSsmPatchComplianceDetails { } export namespace AwsSsmPatchComplianceDetails { + /** + * @internal + */ export const filterSensitiveLog = (obj: AwsSsmPatchComplianceDetails): any => ({ ...obj, }); @@ -8756,6 +9422,9 @@ export interface WafAction { } export namespace WafAction { + /** + * @internal + */ export const filterSensitiveLog = (obj: WafAction): any => ({ ...obj, }); @@ -8772,6 +9441,9 @@ export interface WafExcludedRule { } export namespace WafExcludedRule { + /** + * @internal + */ export const filterSensitiveLog = (obj: WafExcludedRule): any => ({ ...obj, }); @@ -8791,6 +9463,9 @@ export interface WafOverrideAction { } export namespace WafOverrideAction { + /** + * @internal + */ export const filterSensitiveLog = (obj: WafOverrideAction): any => ({ ...obj, }); @@ -8853,6 +9528,9 @@ export interface AwsWafWebAclRule { } export namespace AwsWafWebAclRule { + /** + * @internal + */ export const filterSensitiveLog = (obj: AwsWafWebAclRule): any => ({ ...obj, }); @@ -8886,6 +9564,9 @@ export interface AwsWafWebAclDetails { } export namespace AwsWafWebAclDetails { + /** + * @internal + */ export const filterSensitiveLog = (obj: AwsWafWebAclDetails): any => ({ ...obj, }); @@ -8920,6 +9601,9 @@ export interface ContainerDetails { } export namespace ContainerDetails { + /** + * @internal + */ export const filterSensitiveLog = (obj: ContainerDetails): any => ({ ...obj, }); @@ -9161,6 +9845,9 @@ export interface ResourceDetails { } export namespace ResourceDetails { + /** + * @internal + */ export const filterSensitiveLog = (obj: ResourceDetails): any => ({ ...obj, }); @@ -9223,6 +9910,9 @@ export interface Resource { } export namespace Resource { + /** + * @internal + */ export const filterSensitiveLog = (obj: Resource): any => ({ ...obj, }); @@ -9336,6 +10026,9 @@ export interface Severity { } export namespace Severity { + /** + * @internal + */ export const filterSensitiveLog = (obj: Severity): any => ({ ...obj, }); @@ -9405,6 +10098,9 @@ export interface ThreatIntelIndicator { } export namespace ThreatIntelIndicator { + /** + * @internal + */ export const filterSensitiveLog = (obj: ThreatIntelIndicator): any => ({ ...obj, }); @@ -9438,6 +10134,9 @@ export interface Cvss { } export namespace Cvss { + /** + * @internal + */ export const filterSensitiveLog = (obj: Cvss): any => ({ ...obj, }); @@ -9480,6 +10179,9 @@ export interface VulnerabilityVendor { } export namespace VulnerabilityVendor { + /** + * @internal + */ export const filterSensitiveLog = (obj: VulnerabilityVendor): any => ({ ...obj, }); @@ -9516,6 +10218,9 @@ export interface SoftwarePackage { } export namespace SoftwarePackage { + /** + * @internal + */ export const filterSensitiveLog = (obj: SoftwarePackage): any => ({ ...obj, }); @@ -9557,6 +10262,9 @@ export interface Vulnerability { } export namespace Vulnerability { + /** + * @internal + */ export const filterSensitiveLog = (obj: Vulnerability): any => ({ ...obj, }); @@ -9618,6 +10326,9 @@ export interface Workflow { } export namespace Workflow { + /** + * @internal + */ export const filterSensitiveLog = (obj: Workflow): any => ({ ...obj, }); @@ -9867,6 +10578,9 @@ export interface AwsSecurityFinding { } export namespace AwsSecurityFinding { + /** + * @internal + */ export const filterSensitiveLog = (obj: AwsSecurityFinding): any => ({ ...obj, }); @@ -9975,6 +10689,9 @@ export interface StringFilter { } export namespace StringFilter { + /** + * @internal + */ export const filterSensitiveLog = (obj: StringFilter): any => ({ ...obj, }); @@ -10004,6 +10721,9 @@ export interface NumberFilter { } export namespace NumberFilter { + /** + * @internal + */ export const filterSensitiveLog = (obj: NumberFilter): any => ({ ...obj, }); @@ -10029,6 +10749,9 @@ export interface DateRange { } export namespace DateRange { + /** + * @internal + */ export const filterSensitiveLog = (obj: DateRange): any => ({ ...obj, }); @@ -10055,6 +10778,9 @@ export interface DateFilter { } export namespace DateFilter { + /** + * @internal + */ export const filterSensitiveLog = (obj: DateFilter): any => ({ ...obj, }); @@ -10071,6 +10797,9 @@ export interface KeywordFilter { } export namespace KeywordFilter { + /** + * @internal + */ export const filterSensitiveLog = (obj: KeywordFilter): any => ({ ...obj, }); @@ -10087,6 +10816,9 @@ export interface IpFilter { } export namespace IpFilter { + /** + * @internal + */ export const filterSensitiveLog = (obj: IpFilter): any => ({ ...obj, }); @@ -10140,6 +10872,9 @@ export interface MapFilter { } export namespace MapFilter { + /** + * @internal + */ export const filterSensitiveLog = (obj: MapFilter): any => ({ ...obj, }); @@ -10682,6 +11417,9 @@ export interface AwsSecurityFindingFilters { } export namespace AwsSecurityFindingFilters { + /** + * @internal + */ export const filterSensitiveLog = (obj: AwsSecurityFindingFilters): any => ({ ...obj, }); @@ -10705,6 +11443,9 @@ export interface AwsSecurityFindingIdentifier { } export namespace AwsSecurityFindingIdentifier { + /** + * @internal + */ export const filterSensitiveLog = (obj: AwsSecurityFindingIdentifier): any => ({ ...obj, }); @@ -10718,6 +11459,9 @@ export interface BatchDisableStandardsRequest { } export namespace BatchDisableStandardsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: BatchDisableStandardsRequest): any => ({ ...obj, }); @@ -10780,6 +11524,9 @@ export interface StandardsSubscription { } export namespace StandardsSubscription { + /** + * @internal + */ export const filterSensitiveLog = (obj: StandardsSubscription): any => ({ ...obj, }); @@ -10793,6 +11540,9 @@ export interface BatchDisableStandardsResponse { } export namespace BatchDisableStandardsResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: BatchDisableStandardsResponse): any => ({ ...obj, }); @@ -10817,6 +11567,9 @@ export interface StandardsSubscriptionRequest { } export namespace StandardsSubscriptionRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: StandardsSubscriptionRequest): any => ({ ...obj, }); @@ -10830,6 +11583,9 @@ export interface BatchEnableStandardsRequest { } export namespace BatchEnableStandardsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: BatchEnableStandardsRequest): any => ({ ...obj, }); @@ -10843,6 +11599,9 @@ export interface BatchEnableStandardsResponse { } export namespace BatchEnableStandardsResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: BatchEnableStandardsResponse): any => ({ ...obj, }); @@ -10857,6 +11616,9 @@ export interface BatchImportFindingsRequest { } export namespace BatchImportFindingsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: BatchImportFindingsRequest): any => ({ ...obj, }); @@ -10885,6 +11647,9 @@ export interface ImportFindingsError { } export namespace ImportFindingsError { + /** + * @internal + */ export const filterSensitiveLog = (obj: ImportFindingsError): any => ({ ...obj, }); @@ -10908,6 +11673,9 @@ export interface BatchImportFindingsResponse { } export namespace BatchImportFindingsResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: BatchImportFindingsResponse): any => ({ ...obj, }); @@ -10929,6 +11697,9 @@ export interface NoteUpdate { } export namespace NoteUpdate { + /** + * @internal + */ export const filterSensitiveLog = (obj: NoteUpdate): any => ({ ...obj, }); @@ -11004,6 +11775,9 @@ export interface SeverityUpdate { } export namespace SeverityUpdate { + /** + * @internal + */ export const filterSensitiveLog = (obj: SeverityUpdate): any => ({ ...obj, }); @@ -11056,6 +11830,9 @@ export interface WorkflowUpdate { } export namespace WorkflowUpdate { + /** + * @internal + */ export const filterSensitiveLog = (obj: WorkflowUpdate): any => ({ ...obj, }); @@ -11166,6 +11943,9 @@ export interface BatchUpdateFindingsRequest { } export namespace BatchUpdateFindingsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: BatchUpdateFindingsRequest): any => ({ ...obj, }); @@ -11193,6 +11973,9 @@ export interface BatchUpdateFindingsUnprocessedFinding { } export namespace BatchUpdateFindingsUnprocessedFinding { + /** + * @internal + */ export const filterSensitiveLog = (obj: BatchUpdateFindingsUnprocessedFinding): any => ({ ...obj, }); @@ -11211,6 +11994,9 @@ export interface BatchUpdateFindingsResponse { } export namespace BatchUpdateFindingsResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: BatchUpdateFindingsResponse): any => ({ ...obj, }); @@ -11239,6 +12025,9 @@ export interface CreateActionTargetRequest { } export namespace CreateActionTargetRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateActionTargetRequest): any => ({ ...obj, }); @@ -11252,6 +12041,9 @@ export interface CreateActionTargetResponse { } export namespace CreateActionTargetResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateActionTargetResponse): any => ({ ...obj, }); @@ -11268,6 +12060,9 @@ export interface ResourceConflictException extends __SmithyException, $MetadataB } export namespace ResourceConflictException { + /** + * @internal + */ export const filterSensitiveLog = (obj: ResourceConflictException): any => ({ ...obj, }); @@ -11295,6 +12090,9 @@ export interface CreateInsightRequest { } export namespace CreateInsightRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateInsightRequest): any => ({ ...obj, }); @@ -11308,6 +12106,9 @@ export interface CreateInsightResponse { } export namespace CreateInsightResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateInsightResponse): any => ({ ...obj, }); @@ -11322,6 +12123,9 @@ export interface CreateMembersRequest { } export namespace CreateMembersRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateMembersRequest): any => ({ ...obj, }); @@ -11343,6 +12147,9 @@ export interface Result { } export namespace Result { + /** + * @internal + */ export const filterSensitiveLog = (obj: Result): any => ({ ...obj, }); @@ -11357,6 +12164,9 @@ export interface CreateMembersResponse { } export namespace CreateMembersResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateMembersResponse): any => ({ ...obj, }); @@ -11371,6 +12181,9 @@ export interface DeclineInvitationsRequest { } export namespace DeclineInvitationsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeclineInvitationsRequest): any => ({ ...obj, }); @@ -11385,6 +12198,9 @@ export interface DeclineInvitationsResponse { } export namespace DeclineInvitationsResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeclineInvitationsResponse): any => ({ ...obj, }); @@ -11398,6 +12214,9 @@ export interface DeleteActionTargetRequest { } export namespace DeleteActionTargetRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteActionTargetRequest): any => ({ ...obj, }); @@ -11411,6 +12230,9 @@ export interface DeleteActionTargetResponse { } export namespace DeleteActionTargetResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteActionTargetResponse): any => ({ ...obj, }); @@ -11424,6 +12246,9 @@ export interface DeleteInsightRequest { } export namespace DeleteInsightRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteInsightRequest): any => ({ ...obj, }); @@ -11437,6 +12262,9 @@ export interface DeleteInsightResponse { } export namespace DeleteInsightResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteInsightResponse): any => ({ ...obj, }); @@ -11450,6 +12278,9 @@ export interface DeleteInvitationsRequest { } export namespace DeleteInvitationsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteInvitationsRequest): any => ({ ...obj, }); @@ -11464,6 +12295,9 @@ export interface DeleteInvitationsResponse { } export namespace DeleteInvitationsResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteInvitationsResponse): any => ({ ...obj, }); @@ -11477,6 +12311,9 @@ export interface DeleteMembersRequest { } export namespace DeleteMembersRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteMembersRequest): any => ({ ...obj, }); @@ -11491,6 +12328,9 @@ export interface DeleteMembersResponse { } export namespace DeleteMembersResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteMembersResponse): any => ({ ...obj, }); @@ -11518,6 +12358,9 @@ export interface DescribeActionTargetsRequest { } export namespace DescribeActionTargetsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeActionTargetsRequest): any => ({ ...obj, }); diff --git a/clients/client-securityhub/models/models_1.ts b/clients/client-securityhub/models/models_1.ts index 70eb0f663705..3cdd0f92322b 100644 --- a/clients/client-securityhub/models/models_1.ts +++ b/clients/client-securityhub/models/models_1.ts @@ -25,6 +25,9 @@ export interface DescribeActionTargetsResponse { } export namespace DescribeActionTargetsResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeActionTargetsResponse): any => ({ ...obj, }); @@ -38,6 +41,9 @@ export interface DescribeHubRequest { } export namespace DescribeHubRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeHubRequest): any => ({ ...obj, }); @@ -64,6 +70,9 @@ export interface DescribeHubResponse { } export namespace DescribeHubResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeHubResponse): any => ({ ...obj, }); @@ -72,6 +81,9 @@ export namespace DescribeHubResponse { export interface DescribeOrganizationConfigurationRequest {} export namespace DescribeOrganizationConfigurationRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeOrganizationConfigurationRequest): any => ({ ...obj, }); @@ -93,6 +105,9 @@ export interface DescribeOrganizationConfigurationResponse { } export namespace DescribeOrganizationConfigurationResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeOrganizationConfigurationResponse): any => ({ ...obj, }); @@ -120,6 +135,9 @@ export interface DescribeProductsRequest { } export namespace DescribeProductsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeProductsRequest): any => ({ ...obj, }); @@ -200,6 +218,9 @@ export interface Product { } export namespace Product { + /** + * @internal + */ export const filterSensitiveLog = (obj: Product): any => ({ ...obj, }); @@ -218,6 +239,9 @@ export interface DescribeProductsResponse { } export namespace DescribeProductsResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeProductsResponse): any => ({ ...obj, }); @@ -240,6 +264,9 @@ export interface DescribeStandardsRequest { } export namespace DescribeStandardsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeStandardsRequest): any => ({ ...obj, }); @@ -276,6 +303,9 @@ export interface Standard { } export namespace Standard { + /** + * @internal + */ export const filterSensitiveLog = (obj: Standard): any => ({ ...obj, }); @@ -294,6 +324,9 @@ export interface DescribeStandardsResponse { } export namespace DescribeStandardsResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeStandardsResponse): any => ({ ...obj, }); @@ -324,6 +357,9 @@ export interface DescribeStandardsControlsRequest { } export namespace DescribeStandardsControlsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeStandardsControlsRequest): any => ({ ...obj, }); @@ -398,6 +434,9 @@ export interface StandardsControl { } export namespace StandardsControl { + /** + * @internal + */ export const filterSensitiveLog = (obj: StandardsControl): any => ({ ...obj, }); @@ -416,6 +455,9 @@ export interface DescribeStandardsControlsResponse { } export namespace DescribeStandardsControlsResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeStandardsControlsResponse): any => ({ ...obj, }); @@ -429,6 +471,9 @@ export interface DisableImportFindingsForProductRequest { } export namespace DisableImportFindingsForProductRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DisableImportFindingsForProductRequest): any => ({ ...obj, }); @@ -437,6 +482,9 @@ export namespace DisableImportFindingsForProductRequest { export interface DisableImportFindingsForProductResponse {} export namespace DisableImportFindingsForProductResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DisableImportFindingsForProductResponse): any => ({ ...obj, }); @@ -450,6 +498,9 @@ export interface DisableOrganizationAdminAccountRequest { } export namespace DisableOrganizationAdminAccountRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DisableOrganizationAdminAccountRequest): any => ({ ...obj, }); @@ -458,6 +509,9 @@ export namespace DisableOrganizationAdminAccountRequest { export interface DisableOrganizationAdminAccountResponse {} export namespace DisableOrganizationAdminAccountResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DisableOrganizationAdminAccountResponse): any => ({ ...obj, }); @@ -466,6 +520,9 @@ export namespace DisableOrganizationAdminAccountResponse { export interface DisableSecurityHubRequest {} export namespace DisableSecurityHubRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DisableSecurityHubRequest): any => ({ ...obj, }); @@ -474,6 +531,9 @@ export namespace DisableSecurityHubRequest { export interface DisableSecurityHubResponse {} export namespace DisableSecurityHubResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DisableSecurityHubResponse): any => ({ ...obj, }); @@ -482,6 +542,9 @@ export namespace DisableSecurityHubResponse { export interface DisassociateFromAdministratorAccountRequest {} export namespace DisassociateFromAdministratorAccountRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DisassociateFromAdministratorAccountRequest): any => ({ ...obj, }); @@ -490,6 +553,9 @@ export namespace DisassociateFromAdministratorAccountRequest { export interface DisassociateFromAdministratorAccountResponse {} export namespace DisassociateFromAdministratorAccountResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DisassociateFromAdministratorAccountResponse): any => ({ ...obj, }); @@ -498,6 +564,9 @@ export namespace DisassociateFromAdministratorAccountResponse { export interface DisassociateFromMasterAccountRequest {} export namespace DisassociateFromMasterAccountRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DisassociateFromMasterAccountRequest): any => ({ ...obj, }); @@ -506,6 +575,9 @@ export namespace DisassociateFromMasterAccountRequest { export interface DisassociateFromMasterAccountResponse {} export namespace DisassociateFromMasterAccountResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DisassociateFromMasterAccountResponse): any => ({ ...obj, }); @@ -519,6 +591,9 @@ export interface DisassociateMembersRequest { } export namespace DisassociateMembersRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DisassociateMembersRequest): any => ({ ...obj, }); @@ -527,6 +602,9 @@ export namespace DisassociateMembersRequest { export interface DisassociateMembersResponse {} export namespace DisassociateMembersResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DisassociateMembersResponse): any => ({ ...obj, }); @@ -540,6 +618,9 @@ export interface EnableImportFindingsForProductRequest { } export namespace EnableImportFindingsForProductRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: EnableImportFindingsForProductRequest): any => ({ ...obj, }); @@ -553,6 +634,9 @@ export interface EnableImportFindingsForProductResponse { } export namespace EnableImportFindingsForProductResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: EnableImportFindingsForProductResponse): any => ({ ...obj, }); @@ -567,6 +651,9 @@ export interface EnableOrganizationAdminAccountRequest { } export namespace EnableOrganizationAdminAccountRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: EnableOrganizationAdminAccountRequest): any => ({ ...obj, }); @@ -575,6 +662,9 @@ export namespace EnableOrganizationAdminAccountRequest { export interface EnableOrganizationAdminAccountResponse {} export namespace EnableOrganizationAdminAccountResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: EnableOrganizationAdminAccountResponse): any => ({ ...obj, }); @@ -596,6 +686,9 @@ export interface EnableSecurityHubRequest { } export namespace EnableSecurityHubRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: EnableSecurityHubRequest): any => ({ ...obj, }); @@ -604,6 +697,9 @@ export namespace EnableSecurityHubRequest { export interface EnableSecurityHubResponse {} export namespace EnableSecurityHubResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: EnableSecurityHubResponse): any => ({ ...obj, }); @@ -612,6 +708,9 @@ export namespace EnableSecurityHubResponse { export interface GetAdministratorAccountRequest {} export namespace GetAdministratorAccountRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetAdministratorAccountRequest): any => ({ ...obj, }); @@ -643,6 +742,9 @@ export interface Invitation { } export namespace Invitation { + /** + * @internal + */ export const filterSensitiveLog = (obj: Invitation): any => ({ ...obj, }); @@ -656,6 +758,9 @@ export interface GetAdministratorAccountResponse { } export namespace GetAdministratorAccountResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetAdministratorAccountResponse): any => ({ ...obj, }); @@ -683,6 +788,9 @@ export interface GetEnabledStandardsRequest { } export namespace GetEnabledStandardsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetEnabledStandardsRequest): any => ({ ...obj, }); @@ -702,6 +810,9 @@ export interface GetEnabledStandardsResponse { } export namespace GetEnabledStandardsResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetEnabledStandardsResponse): any => ({ ...obj, }); @@ -728,6 +839,9 @@ export interface SortCriterion { } export namespace SortCriterion { + /** + * @internal + */ export const filterSensitiveLog = (obj: SortCriterion): any => ({ ...obj, }); @@ -765,6 +879,9 @@ export interface GetFindingsRequest { } export namespace GetFindingsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetFindingsRequest): any => ({ ...obj, }); @@ -783,6 +900,9 @@ export interface GetFindingsResponse { } export namespace GetFindingsResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetFindingsResponse): any => ({ ...obj, }); @@ -796,6 +916,9 @@ export interface GetInsightResultsRequest { } export namespace GetInsightResultsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetInsightResultsRequest): any => ({ ...obj, }); @@ -819,6 +942,9 @@ export interface InsightResultValue { } export namespace InsightResultValue { + /** + * @internal + */ export const filterSensitiveLog = (obj: InsightResultValue): any => ({ ...obj, }); @@ -848,6 +974,9 @@ export interface InsightResults { } export namespace InsightResults { + /** + * @internal + */ export const filterSensitiveLog = (obj: InsightResults): any => ({ ...obj, }); @@ -861,6 +990,9 @@ export interface GetInsightResultsResponse { } export namespace GetInsightResultsResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetInsightResultsResponse): any => ({ ...obj, }); @@ -890,6 +1022,9 @@ export interface GetInsightsRequest { } export namespace GetInsightsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetInsightsRequest): any => ({ ...obj, }); @@ -925,6 +1060,9 @@ export interface Insight { } export namespace Insight { + /** + * @internal + */ export const filterSensitiveLog = (obj: Insight): any => ({ ...obj, }); @@ -943,6 +1081,9 @@ export interface GetInsightsResponse { } export namespace GetInsightsResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetInsightsResponse): any => ({ ...obj, }); @@ -951,6 +1092,9 @@ export namespace GetInsightsResponse { export interface GetInvitationsCountRequest {} export namespace GetInvitationsCountRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetInvitationsCountRequest): any => ({ ...obj, }); @@ -965,6 +1109,9 @@ export interface GetInvitationsCountResponse { } export namespace GetInvitationsCountResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetInvitationsCountResponse): any => ({ ...obj, }); @@ -973,6 +1120,9 @@ export namespace GetInvitationsCountResponse { export interface GetMasterAccountRequest {} export namespace GetMasterAccountRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetMasterAccountRequest): any => ({ ...obj, }); @@ -987,6 +1137,9 @@ export interface GetMasterAccountResponse { } export namespace GetMasterAccountResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetMasterAccountResponse): any => ({ ...obj, }); @@ -1000,6 +1153,9 @@ export interface GetMembersRequest { } export namespace GetMembersRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetMembersRequest): any => ({ ...obj, }); @@ -1085,6 +1241,9 @@ export interface Member { } export namespace Member { + /** + * @internal + */ export const filterSensitiveLog = (obj: Member): any => ({ ...obj, }); @@ -1104,6 +1263,9 @@ export interface GetMembersResponse { } export namespace GetMembersResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetMembersResponse): any => ({ ...obj, }); @@ -1117,6 +1279,9 @@ export interface InviteMembersRequest { } export namespace InviteMembersRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: InviteMembersRequest): any => ({ ...obj, }); @@ -1131,6 +1296,9 @@ export interface InviteMembersResponse { } export namespace InviteMembersResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: InviteMembersResponse): any => ({ ...obj, }); @@ -1153,6 +1321,9 @@ export interface ListEnabledProductsForImportRequest { } export namespace ListEnabledProductsForImportRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListEnabledProductsForImportRequest): any => ({ ...obj, }); @@ -1171,6 +1342,9 @@ export interface ListEnabledProductsForImportResponse { } export namespace ListEnabledProductsForImportResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListEnabledProductsForImportResponse): any => ({ ...obj, }); @@ -1193,6 +1367,9 @@ export interface ListInvitationsRequest { } export namespace ListInvitationsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListInvitationsRequest): any => ({ ...obj, }); @@ -1211,6 +1388,9 @@ export interface ListInvitationsResponse { } export namespace ListInvitationsResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListInvitationsResponse): any => ({ ...obj, }); @@ -1243,6 +1423,9 @@ export interface ListMembersRequest { } export namespace ListMembersRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListMembersRequest): any => ({ ...obj, }); @@ -1261,6 +1444,9 @@ export interface ListMembersResponse { } export namespace ListMembersResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListMembersResponse): any => ({ ...obj, }); @@ -1282,6 +1468,9 @@ export interface ListOrganizationAdminAccountsRequest { } export namespace ListOrganizationAdminAccountsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListOrganizationAdminAccountsRequest): any => ({ ...obj, }); @@ -1300,6 +1489,9 @@ export interface ListOrganizationAdminAccountsResponse { } export namespace ListOrganizationAdminAccountsResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListOrganizationAdminAccountsResponse): any => ({ ...obj, }); @@ -1313,6 +1505,9 @@ export interface ListTagsForResourceRequest { } export namespace ListTagsForResourceRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListTagsForResourceRequest): any => ({ ...obj, }); @@ -1326,6 +1521,9 @@ export interface ListTagsForResourceResponse { } export namespace ListTagsForResourceResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListTagsForResourceResponse): any => ({ ...obj, }); @@ -1344,6 +1542,9 @@ export interface TagResourceRequest { } export namespace TagResourceRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: TagResourceRequest): any => ({ ...obj, }); @@ -1352,6 +1553,9 @@ export namespace TagResourceRequest { export interface TagResourceResponse {} export namespace TagResourceResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: TagResourceResponse): any => ({ ...obj, }); @@ -1370,6 +1574,9 @@ export interface UntagResourceRequest { } export namespace UntagResourceRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: UntagResourceRequest): any => ({ ...obj, }); @@ -1378,6 +1585,9 @@ export namespace UntagResourceRequest { export interface UntagResourceResponse {} export namespace UntagResourceResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: UntagResourceResponse): any => ({ ...obj, }); @@ -1401,6 +1611,9 @@ export interface UpdateActionTargetRequest { } export namespace UpdateActionTargetRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateActionTargetRequest): any => ({ ...obj, }); @@ -1409,6 +1622,9 @@ export namespace UpdateActionTargetRequest { export interface UpdateActionTargetResponse {} export namespace UpdateActionTargetResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateActionTargetResponse): any => ({ ...obj, }); @@ -1432,6 +1648,9 @@ export interface UpdateFindingsRequest { } export namespace UpdateFindingsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateFindingsRequest): any => ({ ...obj, }); @@ -1440,6 +1659,9 @@ export namespace UpdateFindingsRequest { export interface UpdateFindingsResponse {} export namespace UpdateFindingsResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateFindingsResponse): any => ({ ...obj, }); @@ -1468,6 +1690,9 @@ export interface UpdateInsightRequest { } export namespace UpdateInsightRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateInsightRequest): any => ({ ...obj, }); @@ -1476,6 +1701,9 @@ export namespace UpdateInsightRequest { export interface UpdateInsightResponse {} export namespace UpdateInsightResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateInsightResponse): any => ({ ...obj, }); @@ -1492,6 +1720,9 @@ export interface UpdateOrganizationConfigurationRequest { } export namespace UpdateOrganizationConfigurationRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateOrganizationConfigurationRequest): any => ({ ...obj, }); @@ -1500,6 +1731,9 @@ export namespace UpdateOrganizationConfigurationRequest { export interface UpdateOrganizationConfigurationResponse {} export namespace UpdateOrganizationConfigurationResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateOrganizationConfigurationResponse): any => ({ ...obj, }); @@ -1517,6 +1751,9 @@ export interface UpdateSecurityHubConfigurationRequest { } export namespace UpdateSecurityHubConfigurationRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateSecurityHubConfigurationRequest): any => ({ ...obj, }); @@ -1525,6 +1762,9 @@ export namespace UpdateSecurityHubConfigurationRequest { export interface UpdateSecurityHubConfigurationResponse {} export namespace UpdateSecurityHubConfigurationResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateSecurityHubConfigurationResponse): any => ({ ...obj, }); @@ -1549,6 +1789,9 @@ export interface UpdateStandardsControlRequest { } export namespace UpdateStandardsControlRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateStandardsControlRequest): any => ({ ...obj, }); @@ -1557,6 +1800,9 @@ export namespace UpdateStandardsControlRequest { export interface UpdateStandardsControlResponse {} export namespace UpdateStandardsControlResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateStandardsControlResponse): any => ({ ...obj, }); diff --git a/clients/client-serverlessapplicationrepository/commands/CreateApplicationCommand.ts b/clients/client-serverlessapplicationrepository/commands/CreateApplicationCommand.ts index 7aa45d9f6daa..1f43407fb28b 100644 --- a/clients/client-serverlessapplicationrepository/commands/CreateApplicationCommand.ts +++ b/clients/client-serverlessapplicationrepository/commands/CreateApplicationCommand.ts @@ -26,6 +26,20 @@ export interface CreateApplicationCommandOutput extends CreateApplicationRespons /** *

Creates an application, optionally including an AWS SAM file to create the first application version in the same call.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ServerlessApplicationRepositoryClient, CreateApplicationCommand } from "@aws-sdk/client-serverlessapplicationrepository"; // ES Modules import + * // const { ServerlessApplicationRepositoryClient, CreateApplicationCommand } = require("@aws-sdk/client-serverlessapplicationrepository"); // CommonJS import + * const client = new ServerlessApplicationRepositoryClient(config); + * const command = new CreateApplicationCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreateApplicationCommandInput} for command's `input` shape. + * @see {@link CreateApplicationCommandOutput} for command's `response` shape. + * @see {@link ServerlessApplicationRepositoryClientResolvedConfig | config} for command's `input` shape. + * */ export class CreateApplicationCommand extends $Command< CreateApplicationCommandInput, diff --git a/clients/client-serverlessapplicationrepository/commands/CreateApplicationVersionCommand.ts b/clients/client-serverlessapplicationrepository/commands/CreateApplicationVersionCommand.ts index 1931afb2840c..673be36ae865 100644 --- a/clients/client-serverlessapplicationrepository/commands/CreateApplicationVersionCommand.ts +++ b/clients/client-serverlessapplicationrepository/commands/CreateApplicationVersionCommand.ts @@ -26,6 +26,20 @@ export interface CreateApplicationVersionCommandOutput extends CreateApplication /** *

Creates an application version.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ServerlessApplicationRepositoryClient, CreateApplicationVersionCommand } from "@aws-sdk/client-serverlessapplicationrepository"; // ES Modules import + * // const { ServerlessApplicationRepositoryClient, CreateApplicationVersionCommand } = require("@aws-sdk/client-serverlessapplicationrepository"); // CommonJS import + * const client = new ServerlessApplicationRepositoryClient(config); + * const command = new CreateApplicationVersionCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreateApplicationVersionCommandInput} for command's `input` shape. + * @see {@link CreateApplicationVersionCommandOutput} for command's `response` shape. + * @see {@link ServerlessApplicationRepositoryClientResolvedConfig | config} for command's `input` shape. + * */ export class CreateApplicationVersionCommand extends $Command< CreateApplicationVersionCommandInput, diff --git a/clients/client-serverlessapplicationrepository/commands/CreateCloudFormationChangeSetCommand.ts b/clients/client-serverlessapplicationrepository/commands/CreateCloudFormationChangeSetCommand.ts index 9f33963acd07..139f9959670b 100644 --- a/clients/client-serverlessapplicationrepository/commands/CreateCloudFormationChangeSetCommand.ts +++ b/clients/client-serverlessapplicationrepository/commands/CreateCloudFormationChangeSetCommand.ts @@ -28,6 +28,20 @@ export interface CreateCloudFormationChangeSetCommandOutput /** *

Creates an AWS CloudFormation change set for the given application.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ServerlessApplicationRepositoryClient, CreateCloudFormationChangeSetCommand } from "@aws-sdk/client-serverlessapplicationrepository"; // ES Modules import + * // const { ServerlessApplicationRepositoryClient, CreateCloudFormationChangeSetCommand } = require("@aws-sdk/client-serverlessapplicationrepository"); // CommonJS import + * const client = new ServerlessApplicationRepositoryClient(config); + * const command = new CreateCloudFormationChangeSetCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreateCloudFormationChangeSetCommandInput} for command's `input` shape. + * @see {@link CreateCloudFormationChangeSetCommandOutput} for command's `response` shape. + * @see {@link ServerlessApplicationRepositoryClientResolvedConfig | config} for command's `input` shape. + * */ export class CreateCloudFormationChangeSetCommand extends $Command< CreateCloudFormationChangeSetCommandInput, diff --git a/clients/client-serverlessapplicationrepository/commands/CreateCloudFormationTemplateCommand.ts b/clients/client-serverlessapplicationrepository/commands/CreateCloudFormationTemplateCommand.ts index b209bc956fee..e661cb43c99d 100644 --- a/clients/client-serverlessapplicationrepository/commands/CreateCloudFormationTemplateCommand.ts +++ b/clients/client-serverlessapplicationrepository/commands/CreateCloudFormationTemplateCommand.ts @@ -28,6 +28,20 @@ export interface CreateCloudFormationTemplateCommandOutput /** *

Creates an AWS CloudFormation template.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ServerlessApplicationRepositoryClient, CreateCloudFormationTemplateCommand } from "@aws-sdk/client-serverlessapplicationrepository"; // ES Modules import + * // const { ServerlessApplicationRepositoryClient, CreateCloudFormationTemplateCommand } = require("@aws-sdk/client-serverlessapplicationrepository"); // CommonJS import + * const client = new ServerlessApplicationRepositoryClient(config); + * const command = new CreateCloudFormationTemplateCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreateCloudFormationTemplateCommandInput} for command's `input` shape. + * @see {@link CreateCloudFormationTemplateCommandOutput} for command's `response` shape. + * @see {@link ServerlessApplicationRepositoryClientResolvedConfig | config} for command's `input` shape. + * */ export class CreateCloudFormationTemplateCommand extends $Command< CreateCloudFormationTemplateCommandInput, diff --git a/clients/client-serverlessapplicationrepository/commands/DeleteApplicationCommand.ts b/clients/client-serverlessapplicationrepository/commands/DeleteApplicationCommand.ts index f884ce801916..4ec53ff144c8 100644 --- a/clients/client-serverlessapplicationrepository/commands/DeleteApplicationCommand.ts +++ b/clients/client-serverlessapplicationrepository/commands/DeleteApplicationCommand.ts @@ -26,6 +26,20 @@ export interface DeleteApplicationCommandOutput extends __MetadataBearer {} /** *

Deletes the specified application.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ServerlessApplicationRepositoryClient, DeleteApplicationCommand } from "@aws-sdk/client-serverlessapplicationrepository"; // ES Modules import + * // const { ServerlessApplicationRepositoryClient, DeleteApplicationCommand } = require("@aws-sdk/client-serverlessapplicationrepository"); // CommonJS import + * const client = new ServerlessApplicationRepositoryClient(config); + * const command = new DeleteApplicationCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteApplicationCommandInput} for command's `input` shape. + * @see {@link DeleteApplicationCommandOutput} for command's `response` shape. + * @see {@link ServerlessApplicationRepositoryClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteApplicationCommand extends $Command< DeleteApplicationCommandInput, diff --git a/clients/client-serverlessapplicationrepository/commands/GetApplicationCommand.ts b/clients/client-serverlessapplicationrepository/commands/GetApplicationCommand.ts index b7d3c295ff95..18b5c2ebdd92 100644 --- a/clients/client-serverlessapplicationrepository/commands/GetApplicationCommand.ts +++ b/clients/client-serverlessapplicationrepository/commands/GetApplicationCommand.ts @@ -26,6 +26,20 @@ export interface GetApplicationCommandOutput extends GetApplicationResponse, __M /** *

Gets the specified application.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ServerlessApplicationRepositoryClient, GetApplicationCommand } from "@aws-sdk/client-serverlessapplicationrepository"; // ES Modules import + * // const { ServerlessApplicationRepositoryClient, GetApplicationCommand } = require("@aws-sdk/client-serverlessapplicationrepository"); // CommonJS import + * const client = new ServerlessApplicationRepositoryClient(config); + * const command = new GetApplicationCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetApplicationCommandInput} for command's `input` shape. + * @see {@link GetApplicationCommandOutput} for command's `response` shape. + * @see {@link ServerlessApplicationRepositoryClientResolvedConfig | config} for command's `input` shape. + * */ export class GetApplicationCommand extends $Command< GetApplicationCommandInput, diff --git a/clients/client-serverlessapplicationrepository/commands/GetApplicationPolicyCommand.ts b/clients/client-serverlessapplicationrepository/commands/GetApplicationPolicyCommand.ts index 3af6defa2689..9036d05f2d03 100644 --- a/clients/client-serverlessapplicationrepository/commands/GetApplicationPolicyCommand.ts +++ b/clients/client-serverlessapplicationrepository/commands/GetApplicationPolicyCommand.ts @@ -26,6 +26,20 @@ export interface GetApplicationPolicyCommandOutput extends GetApplicationPolicyR /** *

Retrieves the policy for the application.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ServerlessApplicationRepositoryClient, GetApplicationPolicyCommand } from "@aws-sdk/client-serverlessapplicationrepository"; // ES Modules import + * // const { ServerlessApplicationRepositoryClient, GetApplicationPolicyCommand } = require("@aws-sdk/client-serverlessapplicationrepository"); // CommonJS import + * const client = new ServerlessApplicationRepositoryClient(config); + * const command = new GetApplicationPolicyCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetApplicationPolicyCommandInput} for command's `input` shape. + * @see {@link GetApplicationPolicyCommandOutput} for command's `response` shape. + * @see {@link ServerlessApplicationRepositoryClientResolvedConfig | config} for command's `input` shape. + * */ export class GetApplicationPolicyCommand extends $Command< GetApplicationPolicyCommandInput, diff --git a/clients/client-serverlessapplicationrepository/commands/GetCloudFormationTemplateCommand.ts b/clients/client-serverlessapplicationrepository/commands/GetCloudFormationTemplateCommand.ts index 95b5e06c6b25..fc4088d32d8b 100644 --- a/clients/client-serverlessapplicationrepository/commands/GetCloudFormationTemplateCommand.ts +++ b/clients/client-serverlessapplicationrepository/commands/GetCloudFormationTemplateCommand.ts @@ -26,6 +26,20 @@ export interface GetCloudFormationTemplateCommandOutput extends GetCloudFormatio /** *

Gets the specified AWS CloudFormation template.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ServerlessApplicationRepositoryClient, GetCloudFormationTemplateCommand } from "@aws-sdk/client-serverlessapplicationrepository"; // ES Modules import + * // const { ServerlessApplicationRepositoryClient, GetCloudFormationTemplateCommand } = require("@aws-sdk/client-serverlessapplicationrepository"); // CommonJS import + * const client = new ServerlessApplicationRepositoryClient(config); + * const command = new GetCloudFormationTemplateCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetCloudFormationTemplateCommandInput} for command's `input` shape. + * @see {@link GetCloudFormationTemplateCommandOutput} for command's `response` shape. + * @see {@link ServerlessApplicationRepositoryClientResolvedConfig | config} for command's `input` shape. + * */ export class GetCloudFormationTemplateCommand extends $Command< GetCloudFormationTemplateCommandInput, diff --git a/clients/client-serverlessapplicationrepository/commands/ListApplicationDependenciesCommand.ts b/clients/client-serverlessapplicationrepository/commands/ListApplicationDependenciesCommand.ts index 4c7a06787d12..784687a2f45f 100644 --- a/clients/client-serverlessapplicationrepository/commands/ListApplicationDependenciesCommand.ts +++ b/clients/client-serverlessapplicationrepository/commands/ListApplicationDependenciesCommand.ts @@ -28,6 +28,20 @@ export interface ListApplicationDependenciesCommandOutput /** *

Retrieves the list of applications nested in the containing application.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ServerlessApplicationRepositoryClient, ListApplicationDependenciesCommand } from "@aws-sdk/client-serverlessapplicationrepository"; // ES Modules import + * // const { ServerlessApplicationRepositoryClient, ListApplicationDependenciesCommand } = require("@aws-sdk/client-serverlessapplicationrepository"); // CommonJS import + * const client = new ServerlessApplicationRepositoryClient(config); + * const command = new ListApplicationDependenciesCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListApplicationDependenciesCommandInput} for command's `input` shape. + * @see {@link ListApplicationDependenciesCommandOutput} for command's `response` shape. + * @see {@link ServerlessApplicationRepositoryClientResolvedConfig | config} for command's `input` shape. + * */ export class ListApplicationDependenciesCommand extends $Command< ListApplicationDependenciesCommandInput, diff --git a/clients/client-serverlessapplicationrepository/commands/ListApplicationVersionsCommand.ts b/clients/client-serverlessapplicationrepository/commands/ListApplicationVersionsCommand.ts index de9473f56fd4..b8087d36a7a6 100644 --- a/clients/client-serverlessapplicationrepository/commands/ListApplicationVersionsCommand.ts +++ b/clients/client-serverlessapplicationrepository/commands/ListApplicationVersionsCommand.ts @@ -26,6 +26,20 @@ export interface ListApplicationVersionsCommandOutput extends ListApplicationVer /** *

Lists versions for the specified application.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ServerlessApplicationRepositoryClient, ListApplicationVersionsCommand } from "@aws-sdk/client-serverlessapplicationrepository"; // ES Modules import + * // const { ServerlessApplicationRepositoryClient, ListApplicationVersionsCommand } = require("@aws-sdk/client-serverlessapplicationrepository"); // CommonJS import + * const client = new ServerlessApplicationRepositoryClient(config); + * const command = new ListApplicationVersionsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListApplicationVersionsCommandInput} for command's `input` shape. + * @see {@link ListApplicationVersionsCommandOutput} for command's `response` shape. + * @see {@link ServerlessApplicationRepositoryClientResolvedConfig | config} for command's `input` shape. + * */ export class ListApplicationVersionsCommand extends $Command< ListApplicationVersionsCommandInput, diff --git a/clients/client-serverlessapplicationrepository/commands/ListApplicationsCommand.ts b/clients/client-serverlessapplicationrepository/commands/ListApplicationsCommand.ts index 39b4371fa764..1a9cc4840b52 100644 --- a/clients/client-serverlessapplicationrepository/commands/ListApplicationsCommand.ts +++ b/clients/client-serverlessapplicationrepository/commands/ListApplicationsCommand.ts @@ -26,6 +26,20 @@ export interface ListApplicationsCommandOutput extends ListApplicationsResponse, /** *

Lists applications owned by the requester.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ServerlessApplicationRepositoryClient, ListApplicationsCommand } from "@aws-sdk/client-serverlessapplicationrepository"; // ES Modules import + * // const { ServerlessApplicationRepositoryClient, ListApplicationsCommand } = require("@aws-sdk/client-serverlessapplicationrepository"); // CommonJS import + * const client = new ServerlessApplicationRepositoryClient(config); + * const command = new ListApplicationsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListApplicationsCommandInput} for command's `input` shape. + * @see {@link ListApplicationsCommandOutput} for command's `response` shape. + * @see {@link ServerlessApplicationRepositoryClientResolvedConfig | config} for command's `input` shape. + * */ export class ListApplicationsCommand extends $Command< ListApplicationsCommandInput, diff --git a/clients/client-serverlessapplicationrepository/commands/PutApplicationPolicyCommand.ts b/clients/client-serverlessapplicationrepository/commands/PutApplicationPolicyCommand.ts index 44c2cae206c7..f61cb0ef5f78 100644 --- a/clients/client-serverlessapplicationrepository/commands/PutApplicationPolicyCommand.ts +++ b/clients/client-serverlessapplicationrepository/commands/PutApplicationPolicyCommand.ts @@ -29,6 +29,20 @@ export interface PutApplicationPolicyCommandOutput extends PutApplicationPolicyR * Application * Permissions * .

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ServerlessApplicationRepositoryClient, PutApplicationPolicyCommand } from "@aws-sdk/client-serverlessapplicationrepository"; // ES Modules import + * // const { ServerlessApplicationRepositoryClient, PutApplicationPolicyCommand } = require("@aws-sdk/client-serverlessapplicationrepository"); // CommonJS import + * const client = new ServerlessApplicationRepositoryClient(config); + * const command = new PutApplicationPolicyCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link PutApplicationPolicyCommandInput} for command's `input` shape. + * @see {@link PutApplicationPolicyCommandOutput} for command's `response` shape. + * @see {@link ServerlessApplicationRepositoryClientResolvedConfig | config} for command's `input` shape. + * */ export class PutApplicationPolicyCommand extends $Command< PutApplicationPolicyCommandInput, diff --git a/clients/client-serverlessapplicationrepository/commands/UnshareApplicationCommand.ts b/clients/client-serverlessapplicationrepository/commands/UnshareApplicationCommand.ts index bc2da64e153b..3297e9d813bc 100644 --- a/clients/client-serverlessapplicationrepository/commands/UnshareApplicationCommand.ts +++ b/clients/client-serverlessapplicationrepository/commands/UnshareApplicationCommand.ts @@ -26,6 +26,20 @@ export interface UnshareApplicationCommandOutput extends __MetadataBearer {} /** *

Unshares an application from an AWS Organization.

This operation can be called only from the organization's master account.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ServerlessApplicationRepositoryClient, UnshareApplicationCommand } from "@aws-sdk/client-serverlessapplicationrepository"; // ES Modules import + * // const { ServerlessApplicationRepositoryClient, UnshareApplicationCommand } = require("@aws-sdk/client-serverlessapplicationrepository"); // CommonJS import + * const client = new ServerlessApplicationRepositoryClient(config); + * const command = new UnshareApplicationCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link UnshareApplicationCommandInput} for command's `input` shape. + * @see {@link UnshareApplicationCommandOutput} for command's `response` shape. + * @see {@link ServerlessApplicationRepositoryClientResolvedConfig | config} for command's `input` shape. + * */ export class UnshareApplicationCommand extends $Command< UnshareApplicationCommandInput, diff --git a/clients/client-serverlessapplicationrepository/commands/UpdateApplicationCommand.ts b/clients/client-serverlessapplicationrepository/commands/UpdateApplicationCommand.ts index 60e967e73801..b7ee1bf526d0 100644 --- a/clients/client-serverlessapplicationrepository/commands/UpdateApplicationCommand.ts +++ b/clients/client-serverlessapplicationrepository/commands/UpdateApplicationCommand.ts @@ -26,6 +26,20 @@ export interface UpdateApplicationCommandOutput extends UpdateApplicationRespons /** *

Updates the specified application.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ServerlessApplicationRepositoryClient, UpdateApplicationCommand } from "@aws-sdk/client-serverlessapplicationrepository"; // ES Modules import + * // const { ServerlessApplicationRepositoryClient, UpdateApplicationCommand } = require("@aws-sdk/client-serverlessapplicationrepository"); // CommonJS import + * const client = new ServerlessApplicationRepositoryClient(config); + * const command = new UpdateApplicationCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link UpdateApplicationCommandInput} for command's `input` shape. + * @see {@link UpdateApplicationCommandOutput} for command's `response` shape. + * @see {@link ServerlessApplicationRepositoryClientResolvedConfig | config} for command's `input` shape. + * */ export class UpdateApplicationCommand extends $Command< UpdateApplicationCommandInput, diff --git a/clients/client-serverlessapplicationrepository/models/models_0.ts b/clients/client-serverlessapplicationrepository/models/models_0.ts index baafb853ad19..af0d6c6a2502 100644 --- a/clients/client-serverlessapplicationrepository/models/models_0.ts +++ b/clients/client-serverlessapplicationrepository/models/models_0.ts @@ -17,6 +17,9 @@ export interface ApplicationDependencySummary { } export namespace ApplicationDependencySummary { + /** + * @internal + */ export const filterSensitiveLog = (obj: ApplicationDependencySummary): any => ({ ...obj, }); @@ -49,6 +52,9 @@ export interface ApplicationPolicyStatement { } export namespace ApplicationPolicyStatement { + /** + * @internal + */ export const filterSensitiveLog = (obj: ApplicationPolicyStatement): any => ({ ...obj, }); @@ -100,6 +106,9 @@ export interface ApplicationSummary { } export namespace ApplicationSummary { + /** + * @internal + */ export const filterSensitiveLog = (obj: ApplicationSummary): any => ({ ...obj, }); @@ -200,6 +209,9 @@ export interface ParameterDefinition { } export namespace ParameterDefinition { + /** + * @internal + */ export const filterSensitiveLog = (obj: ParameterDefinition): any => ({ ...obj, }); @@ -222,6 +234,9 @@ export interface ParameterValue { } export namespace ParameterValue { + /** + * @internal + */ export const filterSensitiveLog = (obj: ParameterValue): any => ({ ...obj, }); @@ -246,6 +261,9 @@ export interface RollbackTrigger { } export namespace RollbackTrigger { + /** + * @internal + */ export const filterSensitiveLog = (obj: RollbackTrigger): any => ({ ...obj, }); @@ -272,6 +290,9 @@ export interface Tag { } export namespace Tag { + /** + * @internal + */ export const filterSensitiveLog = (obj: Tag): any => ({ ...obj, }); @@ -305,6 +326,9 @@ export interface VersionSummary { } export namespace VersionSummary { + /** + * @internal + */ export const filterSensitiveLog = (obj: VersionSummary): any => ({ ...obj, }); @@ -328,6 +352,9 @@ export interface BadRequestException extends __SmithyException, $MetadataBearer } export namespace BadRequestException { + /** + * @internal + */ export const filterSensitiveLog = (obj: BadRequestException): any => ({ ...obj, }); @@ -351,6 +378,9 @@ export interface ConflictException extends __SmithyException, $MetadataBearer { } export namespace ConflictException { + /** + * @internal + */ export const filterSensitiveLog = (obj: ConflictException): any => ({ ...obj, }); @@ -439,6 +469,9 @@ export interface CreateApplicationRequest { } export namespace CreateApplicationRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateApplicationRequest): any => ({ ...obj, }); @@ -520,6 +553,9 @@ export interface Version { } export namespace Version { + /** + * @internal + */ export const filterSensitiveLog = (obj: Version): any => ({ ...obj, }); @@ -593,6 +629,9 @@ export interface CreateApplicationResponse { } export namespace CreateApplicationResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateApplicationResponse): any => ({ ...obj, }); @@ -616,6 +655,9 @@ export interface ForbiddenException extends __SmithyException, $MetadataBearer { } export namespace ForbiddenException { + /** + * @internal + */ export const filterSensitiveLog = (obj: ForbiddenException): any => ({ ...obj, }); @@ -639,6 +681,9 @@ export interface InternalServerErrorException extends __SmithyException, $Metada } export namespace InternalServerErrorException { + /** + * @internal + */ export const filterSensitiveLog = (obj: InternalServerErrorException): any => ({ ...obj, }); @@ -662,6 +707,9 @@ export interface TooManyRequestsException extends __SmithyException, $MetadataBe } export namespace TooManyRequestsException { + /** + * @internal + */ export const filterSensitiveLog = (obj: TooManyRequestsException): any => ({ ...obj, }); @@ -700,6 +748,9 @@ export interface CreateApplicationVersionRequest { } export namespace CreateApplicationVersionRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateApplicationVersionRequest): any => ({ ...obj, }); @@ -778,6 +829,9 @@ export interface CreateApplicationVersionResponse { } export namespace CreateApplicationVersionResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateApplicationVersionResponse): any => ({ ...obj, }); @@ -802,6 +856,9 @@ export interface RollbackConfiguration { } export namespace RollbackConfiguration { + /** + * @internal + */ export const filterSensitiveLog = (obj: RollbackConfiguration): any => ({ ...obj, }); @@ -907,6 +964,9 @@ export interface CreateCloudFormationChangeSetRequest { } export namespace CreateCloudFormationChangeSetRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateCloudFormationChangeSetRequest): any => ({ ...obj, }); @@ -937,6 +997,9 @@ export interface CreateCloudFormationChangeSetResponse { } export namespace CreateCloudFormationChangeSetResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateCloudFormationChangeSetResponse): any => ({ ...obj, }); @@ -957,6 +1020,9 @@ export interface CreateCloudFormationTemplateRequest { } export namespace CreateCloudFormationTemplateRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateCloudFormationTemplateRequest): any => ({ ...obj, }); @@ -1011,6 +1077,9 @@ export interface CreateCloudFormationTemplateResponse { } export namespace CreateCloudFormationTemplateResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateCloudFormationTemplateResponse): any => ({ ...obj, }); @@ -1034,6 +1103,9 @@ export interface NotFoundException extends __SmithyException, $MetadataBearer { } export namespace NotFoundException { + /** + * @internal + */ export const filterSensitiveLog = (obj: NotFoundException): any => ({ ...obj, }); @@ -1047,6 +1119,9 @@ export interface DeleteApplicationRequest { } export namespace DeleteApplicationRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteApplicationRequest): any => ({ ...obj, }); @@ -1065,6 +1140,9 @@ export interface GetApplicationRequest { } export namespace GetApplicationRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetApplicationRequest): any => ({ ...obj, }); @@ -1138,6 +1216,9 @@ export interface GetApplicationResponse { } export namespace GetApplicationResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetApplicationResponse): any => ({ ...obj, }); @@ -1151,6 +1232,9 @@ export interface GetApplicationPolicyRequest { } export namespace GetApplicationPolicyRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetApplicationPolicyRequest): any => ({ ...obj, }); @@ -1164,6 +1248,9 @@ export interface GetApplicationPolicyResponse { } export namespace GetApplicationPolicyResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetApplicationPolicyResponse): any => ({ ...obj, }); @@ -1182,6 +1269,9 @@ export interface GetCloudFormationTemplateRequest { } export namespace GetCloudFormationTemplateRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetCloudFormationTemplateRequest): any => ({ ...obj, }); @@ -1230,6 +1320,9 @@ export interface GetCloudFormationTemplateResponse { } export namespace GetCloudFormationTemplateResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetCloudFormationTemplateResponse): any => ({ ...obj, }); @@ -1258,6 +1351,9 @@ export interface ListApplicationDependenciesRequest { } export namespace ListApplicationDependenciesRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListApplicationDependenciesRequest): any => ({ ...obj, }); @@ -1276,6 +1372,9 @@ export interface ListApplicationDependenciesResponse { } export namespace ListApplicationDependenciesResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListApplicationDependenciesResponse): any => ({ ...obj, }); @@ -1294,6 +1393,9 @@ export interface ListApplicationsRequest { } export namespace ListApplicationsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListApplicationsRequest): any => ({ ...obj, }); @@ -1312,6 +1414,9 @@ export interface ListApplicationsResponse { } export namespace ListApplicationsResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListApplicationsResponse): any => ({ ...obj, }); @@ -1335,6 +1440,9 @@ export interface ListApplicationVersionsRequest { } export namespace ListApplicationVersionsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListApplicationVersionsRequest): any => ({ ...obj, }); @@ -1353,6 +1461,9 @@ export interface ListApplicationVersionsResponse { } export namespace ListApplicationVersionsResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListApplicationVersionsResponse): any => ({ ...obj, }); @@ -1371,6 +1482,9 @@ export interface PutApplicationPolicyRequest { } export namespace PutApplicationPolicyRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: PutApplicationPolicyRequest): any => ({ ...obj, }); @@ -1384,6 +1498,9 @@ export interface PutApplicationPolicyResponse { } export namespace PutApplicationPolicyResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: PutApplicationPolicyResponse): any => ({ ...obj, }); @@ -1402,6 +1519,9 @@ export interface UnshareApplicationRequest { } export namespace UnshareApplicationRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: UnshareApplicationRequest): any => ({ ...obj, }); @@ -1445,6 +1565,9 @@ export interface UpdateApplicationRequest { } export namespace UpdateApplicationRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateApplicationRequest): any => ({ ...obj, }); @@ -1518,6 +1641,9 @@ export interface UpdateApplicationResponse { } export namespace UpdateApplicationResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateApplicationResponse): any => ({ ...obj, }); diff --git a/clients/client-service-catalog-appregistry/commands/AssociateAttributeGroupCommand.ts b/clients/client-service-catalog-appregistry/commands/AssociateAttributeGroupCommand.ts index b60b3e3dfc01..726b4100ca19 100644 --- a/clients/client-service-catalog-appregistry/commands/AssociateAttributeGroupCommand.ts +++ b/clients/client-service-catalog-appregistry/commands/AssociateAttributeGroupCommand.ts @@ -28,6 +28,20 @@ export interface AssociateAttributeGroupCommandOutput extends AssociateAttribute *

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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ServiceCatalogAppRegistryClient, AssociateAttributeGroupCommand } from "@aws-sdk/client-service-catalog-appregistry"; // ES Modules import + * // const { ServiceCatalogAppRegistryClient, AssociateAttributeGroupCommand } = require("@aws-sdk/client-service-catalog-appregistry"); // CommonJS import + * const client = new ServiceCatalogAppRegistryClient(config); + * const command = new AssociateAttributeGroupCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link AssociateAttributeGroupCommandInput} for command's `input` shape. + * @see {@link AssociateAttributeGroupCommandOutput} for command's `response` shape. + * @see {@link ServiceCatalogAppRegistryClientResolvedConfig | config} for command's `input` shape. + * */ export class AssociateAttributeGroupCommand extends $Command< AssociateAttributeGroupCommandInput, diff --git a/clients/client-service-catalog-appregistry/commands/AssociateResourceCommand.ts b/clients/client-service-catalog-appregistry/commands/AssociateResourceCommand.ts index 53d54e2d687f..d3da930327b8 100644 --- a/clients/client-service-catalog-appregistry/commands/AssociateResourceCommand.ts +++ b/clients/client-service-catalog-appregistry/commands/AssociateResourceCommand.ts @@ -26,6 +26,20 @@ export interface AssociateResourceCommandOutput extends AssociateResourceRespons /** *

Associates a resource with an application. Both the resource and the application can be specified either by ID or name.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ServiceCatalogAppRegistryClient, AssociateResourceCommand } from "@aws-sdk/client-service-catalog-appregistry"; // ES Modules import + * // const { ServiceCatalogAppRegistryClient, AssociateResourceCommand } = require("@aws-sdk/client-service-catalog-appregistry"); // CommonJS import + * const client = new ServiceCatalogAppRegistryClient(config); + * const command = new AssociateResourceCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link AssociateResourceCommandInput} for command's `input` shape. + * @see {@link AssociateResourceCommandOutput} for command's `response` shape. + * @see {@link ServiceCatalogAppRegistryClientResolvedConfig | config} for command's `input` shape. + * */ export class AssociateResourceCommand extends $Command< AssociateResourceCommandInput, diff --git a/clients/client-service-catalog-appregistry/commands/CreateApplicationCommand.ts b/clients/client-service-catalog-appregistry/commands/CreateApplicationCommand.ts index a7b6e4eb2414..2a84369d15c1 100644 --- a/clients/client-service-catalog-appregistry/commands/CreateApplicationCommand.ts +++ b/clients/client-service-catalog-appregistry/commands/CreateApplicationCommand.ts @@ -26,6 +26,20 @@ export interface CreateApplicationCommandOutput extends CreateApplicationRespons /** *

Creates a new application that is the top-level node in a hierarchy of related cloud resource abstractions.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ServiceCatalogAppRegistryClient, CreateApplicationCommand } from "@aws-sdk/client-service-catalog-appregistry"; // ES Modules import + * // const { ServiceCatalogAppRegistryClient, CreateApplicationCommand } = require("@aws-sdk/client-service-catalog-appregistry"); // CommonJS import + * const client = new ServiceCatalogAppRegistryClient(config); + * const command = new CreateApplicationCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreateApplicationCommandInput} for command's `input` shape. + * @see {@link CreateApplicationCommandOutput} for command's `response` shape. + * @see {@link ServiceCatalogAppRegistryClientResolvedConfig | config} for command's `input` shape. + * */ export class CreateApplicationCommand extends $Command< CreateApplicationCommandInput, diff --git a/clients/client-service-catalog-appregistry/commands/CreateAttributeGroupCommand.ts b/clients/client-service-catalog-appregistry/commands/CreateAttributeGroupCommand.ts index 22dcadd5a431..dba1dec9bdae 100644 --- a/clients/client-service-catalog-appregistry/commands/CreateAttributeGroupCommand.ts +++ b/clients/client-service-catalog-appregistry/commands/CreateAttributeGroupCommand.ts @@ -29,6 +29,20 @@ export interface CreateAttributeGroupCommandOutput extends CreateAttributeGroupR * 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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ServiceCatalogAppRegistryClient, CreateAttributeGroupCommand } from "@aws-sdk/client-service-catalog-appregistry"; // ES Modules import + * // const { ServiceCatalogAppRegistryClient, CreateAttributeGroupCommand } = require("@aws-sdk/client-service-catalog-appregistry"); // CommonJS import + * const client = new ServiceCatalogAppRegistryClient(config); + * const command = new CreateAttributeGroupCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreateAttributeGroupCommandInput} for command's `input` shape. + * @see {@link CreateAttributeGroupCommandOutput} for command's `response` shape. + * @see {@link ServiceCatalogAppRegistryClientResolvedConfig | config} for command's `input` shape. + * */ export class CreateAttributeGroupCommand extends $Command< CreateAttributeGroupCommandInput, diff --git a/clients/client-service-catalog-appregistry/commands/DeleteApplicationCommand.ts b/clients/client-service-catalog-appregistry/commands/DeleteApplicationCommand.ts index 6a4b3c15f9f3..66b6731551ac 100644 --- a/clients/client-service-catalog-appregistry/commands/DeleteApplicationCommand.ts +++ b/clients/client-service-catalog-appregistry/commands/DeleteApplicationCommand.ts @@ -26,6 +26,20 @@ export interface DeleteApplicationCommandOutput extends DeleteApplicationRespons /** *

Deletes an application that is specified either by its application ID or name. All associated attribute groups and resources must be disassociated from it before deleting an application.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ServiceCatalogAppRegistryClient, DeleteApplicationCommand } from "@aws-sdk/client-service-catalog-appregistry"; // ES Modules import + * // const { ServiceCatalogAppRegistryClient, DeleteApplicationCommand } = require("@aws-sdk/client-service-catalog-appregistry"); // CommonJS import + * const client = new ServiceCatalogAppRegistryClient(config); + * const command = new DeleteApplicationCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteApplicationCommandInput} for command's `input` shape. + * @see {@link DeleteApplicationCommandOutput} for command's `response` shape. + * @see {@link ServiceCatalogAppRegistryClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteApplicationCommand extends $Command< DeleteApplicationCommandInput, diff --git a/clients/client-service-catalog-appregistry/commands/DeleteAttributeGroupCommand.ts b/clients/client-service-catalog-appregistry/commands/DeleteAttributeGroupCommand.ts index c8aa5f3bcb58..c8097f657671 100644 --- a/clients/client-service-catalog-appregistry/commands/DeleteAttributeGroupCommand.ts +++ b/clients/client-service-catalog-appregistry/commands/DeleteAttributeGroupCommand.ts @@ -26,6 +26,20 @@ export interface DeleteAttributeGroupCommandOutput extends DeleteAttributeGroupR /** *

Deletes an attribute group, specified either by its attribute group ID or name.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ServiceCatalogAppRegistryClient, DeleteAttributeGroupCommand } from "@aws-sdk/client-service-catalog-appregistry"; // ES Modules import + * // const { ServiceCatalogAppRegistryClient, DeleteAttributeGroupCommand } = require("@aws-sdk/client-service-catalog-appregistry"); // CommonJS import + * const client = new ServiceCatalogAppRegistryClient(config); + * const command = new DeleteAttributeGroupCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteAttributeGroupCommandInput} for command's `input` shape. + * @see {@link DeleteAttributeGroupCommandOutput} for command's `response` shape. + * @see {@link ServiceCatalogAppRegistryClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteAttributeGroupCommand extends $Command< DeleteAttributeGroupCommandInput, diff --git a/clients/client-service-catalog-appregistry/commands/DisassociateAttributeGroupCommand.ts b/clients/client-service-catalog-appregistry/commands/DisassociateAttributeGroupCommand.ts index 8470295b5716..c9fc0a64fddc 100644 --- a/clients/client-service-catalog-appregistry/commands/DisassociateAttributeGroupCommand.ts +++ b/clients/client-service-catalog-appregistry/commands/DisassociateAttributeGroupCommand.ts @@ -26,6 +26,20 @@ export interface DisassociateAttributeGroupCommandOutput extends DisassociateAtt /** *

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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ServiceCatalogAppRegistryClient, DisassociateAttributeGroupCommand } from "@aws-sdk/client-service-catalog-appregistry"; // ES Modules import + * // const { ServiceCatalogAppRegistryClient, DisassociateAttributeGroupCommand } = require("@aws-sdk/client-service-catalog-appregistry"); // CommonJS import + * const client = new ServiceCatalogAppRegistryClient(config); + * const command = new DisassociateAttributeGroupCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DisassociateAttributeGroupCommandInput} for command's `input` shape. + * @see {@link DisassociateAttributeGroupCommandOutput} for command's `response` shape. + * @see {@link ServiceCatalogAppRegistryClientResolvedConfig | config} for command's `input` shape. + * */ export class DisassociateAttributeGroupCommand extends $Command< DisassociateAttributeGroupCommandInput, diff --git a/clients/client-service-catalog-appregistry/commands/DisassociateResourceCommand.ts b/clients/client-service-catalog-appregistry/commands/DisassociateResourceCommand.ts index 21acaec59e8d..3e2882c5ecd4 100644 --- a/clients/client-service-catalog-appregistry/commands/DisassociateResourceCommand.ts +++ b/clients/client-service-catalog-appregistry/commands/DisassociateResourceCommand.ts @@ -26,6 +26,20 @@ export interface DisassociateResourceCommandOutput extends DisassociateResourceR /** *

Disassociates a resource from application. Both the resource and the application can be specified either by ID or name.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ServiceCatalogAppRegistryClient, DisassociateResourceCommand } from "@aws-sdk/client-service-catalog-appregistry"; // ES Modules import + * // const { ServiceCatalogAppRegistryClient, DisassociateResourceCommand } = require("@aws-sdk/client-service-catalog-appregistry"); // CommonJS import + * const client = new ServiceCatalogAppRegistryClient(config); + * const command = new DisassociateResourceCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DisassociateResourceCommandInput} for command's `input` shape. + * @see {@link DisassociateResourceCommandOutput} for command's `response` shape. + * @see {@link ServiceCatalogAppRegistryClientResolvedConfig | config} for command's `input` shape. + * */ export class DisassociateResourceCommand extends $Command< DisassociateResourceCommandInput, diff --git a/clients/client-service-catalog-appregistry/commands/GetApplicationCommand.ts b/clients/client-service-catalog-appregistry/commands/GetApplicationCommand.ts index fc2c12bfd9e2..0ab135c48fed 100644 --- a/clients/client-service-catalog-appregistry/commands/GetApplicationCommand.ts +++ b/clients/client-service-catalog-appregistry/commands/GetApplicationCommand.ts @@ -26,6 +26,20 @@ export interface GetApplicationCommandOutput extends GetApplicationResponse, __M /** *

Retrieves metadata information about one of your applications. The application can be specified either by its unique ID or by its name (which is unique within one account in one region at a given point in time). Specify by 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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ServiceCatalogAppRegistryClient, GetApplicationCommand } from "@aws-sdk/client-service-catalog-appregistry"; // ES Modules import + * // const { ServiceCatalogAppRegistryClient, GetApplicationCommand } = require("@aws-sdk/client-service-catalog-appregistry"); // CommonJS import + * const client = new ServiceCatalogAppRegistryClient(config); + * const command = new GetApplicationCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetApplicationCommandInput} for command's `input` shape. + * @see {@link GetApplicationCommandOutput} for command's `response` shape. + * @see {@link ServiceCatalogAppRegistryClientResolvedConfig | config} for command's `input` shape. + * */ export class GetApplicationCommand extends $Command< GetApplicationCommandInput, diff --git a/clients/client-service-catalog-appregistry/commands/GetAttributeGroupCommand.ts b/clients/client-service-catalog-appregistry/commands/GetAttributeGroupCommand.ts index 5dc4d7514eb5..0907fc836760 100644 --- a/clients/client-service-catalog-appregistry/commands/GetAttributeGroupCommand.ts +++ b/clients/client-service-catalog-appregistry/commands/GetAttributeGroupCommand.ts @@ -26,6 +26,20 @@ export interface GetAttributeGroupCommandOutput extends GetAttributeGroupRespons /** *

Retrieves an attribute group, either by its name or its ID. The attribute group can be specified either by its unique ID or by its name.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ServiceCatalogAppRegistryClient, GetAttributeGroupCommand } from "@aws-sdk/client-service-catalog-appregistry"; // ES Modules import + * // const { ServiceCatalogAppRegistryClient, GetAttributeGroupCommand } = require("@aws-sdk/client-service-catalog-appregistry"); // CommonJS import + * const client = new ServiceCatalogAppRegistryClient(config); + * const command = new GetAttributeGroupCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetAttributeGroupCommandInput} for command's `input` shape. + * @see {@link GetAttributeGroupCommandOutput} for command's `response` shape. + * @see {@link ServiceCatalogAppRegistryClientResolvedConfig | config} for command's `input` shape. + * */ export class GetAttributeGroupCommand extends $Command< GetAttributeGroupCommandInput, diff --git a/clients/client-service-catalog-appregistry/commands/ListApplicationsCommand.ts b/clients/client-service-catalog-appregistry/commands/ListApplicationsCommand.ts index 7efee975e927..69835f26cc8f 100644 --- a/clients/client-service-catalog-appregistry/commands/ListApplicationsCommand.ts +++ b/clients/client-service-catalog-appregistry/commands/ListApplicationsCommand.ts @@ -26,6 +26,20 @@ export interface ListApplicationsCommandOutput extends ListApplicationsResponse, /** *

Retrieves a list of all of your applications. Results are paginated.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ServiceCatalogAppRegistryClient, ListApplicationsCommand } from "@aws-sdk/client-service-catalog-appregistry"; // ES Modules import + * // const { ServiceCatalogAppRegistryClient, ListApplicationsCommand } = require("@aws-sdk/client-service-catalog-appregistry"); // CommonJS import + * const client = new ServiceCatalogAppRegistryClient(config); + * const command = new ListApplicationsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListApplicationsCommandInput} for command's `input` shape. + * @see {@link ListApplicationsCommandOutput} for command's `response` shape. + * @see {@link ServiceCatalogAppRegistryClientResolvedConfig | config} for command's `input` shape. + * */ export class ListApplicationsCommand extends $Command< ListApplicationsCommandInput, diff --git a/clients/client-service-catalog-appregistry/commands/ListAssociatedAttributeGroupsCommand.ts b/clients/client-service-catalog-appregistry/commands/ListAssociatedAttributeGroupsCommand.ts index d231311d49b9..d6f0aec4a8de 100644 --- a/clients/client-service-catalog-appregistry/commands/ListAssociatedAttributeGroupsCommand.ts +++ b/clients/client-service-catalog-appregistry/commands/ListAssociatedAttributeGroupsCommand.ts @@ -28,6 +28,20 @@ export interface ListAssociatedAttributeGroupsCommandOutput /** *

Lists all attribute groups that are associated with specified application. Results are paginated.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ServiceCatalogAppRegistryClient, ListAssociatedAttributeGroupsCommand } from "@aws-sdk/client-service-catalog-appregistry"; // ES Modules import + * // const { ServiceCatalogAppRegistryClient, ListAssociatedAttributeGroupsCommand } = require("@aws-sdk/client-service-catalog-appregistry"); // CommonJS import + * const client = new ServiceCatalogAppRegistryClient(config); + * const command = new ListAssociatedAttributeGroupsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListAssociatedAttributeGroupsCommandInput} for command's `input` shape. + * @see {@link ListAssociatedAttributeGroupsCommandOutput} for command's `response` shape. + * @see {@link ServiceCatalogAppRegistryClientResolvedConfig | config} for command's `input` shape. + * */ export class ListAssociatedAttributeGroupsCommand extends $Command< ListAssociatedAttributeGroupsCommandInput, diff --git a/clients/client-service-catalog-appregistry/commands/ListAssociatedResourcesCommand.ts b/clients/client-service-catalog-appregistry/commands/ListAssociatedResourcesCommand.ts index 9993d065858b..3b589aedf665 100644 --- a/clients/client-service-catalog-appregistry/commands/ListAssociatedResourcesCommand.ts +++ b/clients/client-service-catalog-appregistry/commands/ListAssociatedResourcesCommand.ts @@ -26,6 +26,20 @@ export interface ListAssociatedResourcesCommandOutput extends ListAssociatedReso /** *

Lists all resources that are associated with specified application. Results are paginated.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ServiceCatalogAppRegistryClient, ListAssociatedResourcesCommand } from "@aws-sdk/client-service-catalog-appregistry"; // ES Modules import + * // const { ServiceCatalogAppRegistryClient, ListAssociatedResourcesCommand } = require("@aws-sdk/client-service-catalog-appregistry"); // CommonJS import + * const client = new ServiceCatalogAppRegistryClient(config); + * const command = new ListAssociatedResourcesCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListAssociatedResourcesCommandInput} for command's `input` shape. + * @see {@link ListAssociatedResourcesCommandOutput} for command's `response` shape. + * @see {@link ServiceCatalogAppRegistryClientResolvedConfig | config} for command's `input` shape. + * */ export class ListAssociatedResourcesCommand extends $Command< ListAssociatedResourcesCommandInput, diff --git a/clients/client-service-catalog-appregistry/commands/ListAttributeGroupsCommand.ts b/clients/client-service-catalog-appregistry/commands/ListAttributeGroupsCommand.ts index e07d572b01d7..d9789f69ac17 100644 --- a/clients/client-service-catalog-appregistry/commands/ListAttributeGroupsCommand.ts +++ b/clients/client-service-catalog-appregistry/commands/ListAttributeGroupsCommand.ts @@ -26,6 +26,20 @@ export interface ListAttributeGroupsCommandOutput extends ListAttributeGroupsRes /** *

Lists all attribute groups which you have access to. Results are paginated.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ServiceCatalogAppRegistryClient, ListAttributeGroupsCommand } from "@aws-sdk/client-service-catalog-appregistry"; // ES Modules import + * // const { ServiceCatalogAppRegistryClient, ListAttributeGroupsCommand } = require("@aws-sdk/client-service-catalog-appregistry"); // CommonJS import + * const client = new ServiceCatalogAppRegistryClient(config); + * const command = new ListAttributeGroupsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListAttributeGroupsCommandInput} for command's `input` shape. + * @see {@link ListAttributeGroupsCommandOutput} for command's `response` shape. + * @see {@link ServiceCatalogAppRegistryClientResolvedConfig | config} for command's `input` shape. + * */ export class ListAttributeGroupsCommand extends $Command< ListAttributeGroupsCommandInput, diff --git a/clients/client-service-catalog-appregistry/commands/ListTagsForResourceCommand.ts b/clients/client-service-catalog-appregistry/commands/ListTagsForResourceCommand.ts index c5965bf71be2..38a2313f81d5 100644 --- a/clients/client-service-catalog-appregistry/commands/ListTagsForResourceCommand.ts +++ b/clients/client-service-catalog-appregistry/commands/ListTagsForResourceCommand.ts @@ -26,6 +26,20 @@ export interface ListTagsForResourceCommandOutput extends ListTagsForResourceRes /** *

Lists all of the tags on the resource.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ServiceCatalogAppRegistryClient, ListTagsForResourceCommand } from "@aws-sdk/client-service-catalog-appregistry"; // ES Modules import + * // const { ServiceCatalogAppRegistryClient, ListTagsForResourceCommand } = require("@aws-sdk/client-service-catalog-appregistry"); // CommonJS import + * const client = new ServiceCatalogAppRegistryClient(config); + * const command = new ListTagsForResourceCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListTagsForResourceCommandInput} for command's `input` shape. + * @see {@link ListTagsForResourceCommandOutput} for command's `response` shape. + * @see {@link ServiceCatalogAppRegistryClientResolvedConfig | config} for command's `input` shape. + * */ export class ListTagsForResourceCommand extends $Command< ListTagsForResourceCommandInput, diff --git a/clients/client-service-catalog-appregistry/commands/SyncResourceCommand.ts b/clients/client-service-catalog-appregistry/commands/SyncResourceCommand.ts index 575ceb52677c..36122994c155 100644 --- a/clients/client-service-catalog-appregistry/commands/SyncResourceCommand.ts +++ b/clients/client-service-catalog-appregistry/commands/SyncResourceCommand.ts @@ -26,6 +26,20 @@ export interface SyncResourceCommandOutput extends SyncResourceResponse, __Metad /** *

Syncs the resource with what is currently recorded in App registry. Specifically, the resource’s App registry system tags are synced with its associated application. The resource is removed if it is not associated with the application. The caller must have permissions to read and update the resource.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ServiceCatalogAppRegistryClient, SyncResourceCommand } from "@aws-sdk/client-service-catalog-appregistry"; // ES Modules import + * // const { ServiceCatalogAppRegistryClient, SyncResourceCommand } = require("@aws-sdk/client-service-catalog-appregistry"); // CommonJS import + * const client = new ServiceCatalogAppRegistryClient(config); + * const command = new SyncResourceCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link SyncResourceCommandInput} for command's `input` shape. + * @see {@link SyncResourceCommandOutput} for command's `response` shape. + * @see {@link ServiceCatalogAppRegistryClientResolvedConfig | config} for command's `input` shape. + * */ export class SyncResourceCommand extends $Command< SyncResourceCommandInput, diff --git a/clients/client-service-catalog-appregistry/commands/TagResourceCommand.ts b/clients/client-service-catalog-appregistry/commands/TagResourceCommand.ts index 77d9129728e9..b2c03e24fdb8 100644 --- a/clients/client-service-catalog-appregistry/commands/TagResourceCommand.ts +++ b/clients/client-service-catalog-appregistry/commands/TagResourceCommand.ts @@ -28,6 +28,20 @@ export interface TagResourceCommandOutput extends TagResourceResponse, __Metadat *

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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ServiceCatalogAppRegistryClient, TagResourceCommand } from "@aws-sdk/client-service-catalog-appregistry"; // ES Modules import + * // const { ServiceCatalogAppRegistryClient, TagResourceCommand } = require("@aws-sdk/client-service-catalog-appregistry"); // CommonJS import + * const client = new ServiceCatalogAppRegistryClient(config); + * const command = new TagResourceCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link TagResourceCommandInput} for command's `input` shape. + * @see {@link TagResourceCommandOutput} for command's `response` shape. + * @see {@link ServiceCatalogAppRegistryClientResolvedConfig | config} for command's `input` shape. + * */ export class TagResourceCommand extends $Command< TagResourceCommandInput, diff --git a/clients/client-service-catalog-appregistry/commands/UntagResourceCommand.ts b/clients/client-service-catalog-appregistry/commands/UntagResourceCommand.ts index 72cc4c7aa0f3..3c5a629cd38e 100644 --- a/clients/client-service-catalog-appregistry/commands/UntagResourceCommand.ts +++ b/clients/client-service-catalog-appregistry/commands/UntagResourceCommand.ts @@ -27,6 +27,20 @@ export interface UntagResourceCommandOutput extends UntagResourceResponse, __Met /** *

Removes tags from a resource.

*

This operation returns an empty response if the call was successful.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ServiceCatalogAppRegistryClient, UntagResourceCommand } from "@aws-sdk/client-service-catalog-appregistry"; // ES Modules import + * // const { ServiceCatalogAppRegistryClient, UntagResourceCommand } = require("@aws-sdk/client-service-catalog-appregistry"); // CommonJS import + * const client = new ServiceCatalogAppRegistryClient(config); + * const command = new UntagResourceCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link UntagResourceCommandInput} for command's `input` shape. + * @see {@link UntagResourceCommandOutput} for command's `response` shape. + * @see {@link ServiceCatalogAppRegistryClientResolvedConfig | config} for command's `input` shape. + * */ export class UntagResourceCommand extends $Command< UntagResourceCommandInput, diff --git a/clients/client-service-catalog-appregistry/commands/UpdateApplicationCommand.ts b/clients/client-service-catalog-appregistry/commands/UpdateApplicationCommand.ts index cccad2fc3f7b..7e0fa90008a0 100644 --- a/clients/client-service-catalog-appregistry/commands/UpdateApplicationCommand.ts +++ b/clients/client-service-catalog-appregistry/commands/UpdateApplicationCommand.ts @@ -26,6 +26,20 @@ export interface UpdateApplicationCommandOutput extends UpdateApplicationRespons /** *

Updates an existing application with new attributes.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ServiceCatalogAppRegistryClient, UpdateApplicationCommand } from "@aws-sdk/client-service-catalog-appregistry"; // ES Modules import + * // const { ServiceCatalogAppRegistryClient, UpdateApplicationCommand } = require("@aws-sdk/client-service-catalog-appregistry"); // CommonJS import + * const client = new ServiceCatalogAppRegistryClient(config); + * const command = new UpdateApplicationCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link UpdateApplicationCommandInput} for command's `input` shape. + * @see {@link UpdateApplicationCommandOutput} for command's `response` shape. + * @see {@link ServiceCatalogAppRegistryClientResolvedConfig | config} for command's `input` shape. + * */ export class UpdateApplicationCommand extends $Command< UpdateApplicationCommandInput, diff --git a/clients/client-service-catalog-appregistry/commands/UpdateAttributeGroupCommand.ts b/clients/client-service-catalog-appregistry/commands/UpdateAttributeGroupCommand.ts index 3f10924890ec..88507d9f871f 100644 --- a/clients/client-service-catalog-appregistry/commands/UpdateAttributeGroupCommand.ts +++ b/clients/client-service-catalog-appregistry/commands/UpdateAttributeGroupCommand.ts @@ -26,6 +26,20 @@ export interface UpdateAttributeGroupCommandOutput extends UpdateAttributeGroupR /** *

Updates an existing attribute group with new details.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ServiceCatalogAppRegistryClient, UpdateAttributeGroupCommand } from "@aws-sdk/client-service-catalog-appregistry"; // ES Modules import + * // const { ServiceCatalogAppRegistryClient, UpdateAttributeGroupCommand } = require("@aws-sdk/client-service-catalog-appregistry"); // CommonJS import + * const client = new ServiceCatalogAppRegistryClient(config); + * const command = new UpdateAttributeGroupCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link UpdateAttributeGroupCommandInput} for command's `input` shape. + * @see {@link UpdateAttributeGroupCommandOutput} for command's `response` shape. + * @see {@link ServiceCatalogAppRegistryClientResolvedConfig | config} for command's `input` shape. + * */ export class UpdateAttributeGroupCommand extends $Command< UpdateAttributeGroupCommandInput, diff --git a/clients/client-service-catalog-appregistry/models/models_0.ts b/clients/client-service-catalog-appregistry/models/models_0.ts index 7ba0a691961d..4bb64dabb23c 100644 --- a/clients/client-service-catalog-appregistry/models/models_0.ts +++ b/clients/client-service-catalog-appregistry/models/models_0.ts @@ -43,6 +43,9 @@ export interface Application { } export namespace Application { + /** + * @internal + */ export const filterSensitiveLog = (obj: Application): any => ({ ...obj, }); @@ -84,6 +87,9 @@ export interface ApplicationSummary { } export namespace ApplicationSummary { + /** + * @internal + */ export const filterSensitiveLog = (obj: ApplicationSummary): any => ({ ...obj, }); @@ -102,6 +108,9 @@ export interface AssociateAttributeGroupRequest { } export namespace AssociateAttributeGroupRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: AssociateAttributeGroupRequest): any => ({ ...obj, }); @@ -120,6 +129,9 @@ export interface AssociateAttributeGroupResponse { } export namespace AssociateAttributeGroupResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: AssociateAttributeGroupResponse): any => ({ ...obj, }); @@ -135,6 +147,9 @@ export interface InternalServerException extends __SmithyException, $MetadataBea } export namespace InternalServerException { + /** + * @internal + */ export const filterSensitiveLog = (obj: InternalServerException): any => ({ ...obj, }); @@ -150,6 +165,9 @@ export interface ResourceNotFoundException extends __SmithyException, $MetadataB } export namespace ResourceNotFoundException { + /** + * @internal + */ export const filterSensitiveLog = (obj: ResourceNotFoundException): any => ({ ...obj, }); @@ -165,6 +183,9 @@ export interface ServiceQuotaExceededException extends __SmithyException, $Metad } export namespace ServiceQuotaExceededException { + /** + * @internal + */ export const filterSensitiveLog = (obj: ServiceQuotaExceededException): any => ({ ...obj, }); @@ -180,6 +201,9 @@ export interface ValidationException extends __SmithyException, $MetadataBearer } export namespace ValidationException { + /** + * @internal + */ export const filterSensitiveLog = (obj: ValidationException): any => ({ ...obj, }); @@ -207,6 +231,9 @@ export interface AssociateResourceRequest { } export namespace AssociateResourceRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: AssociateResourceRequest): any => ({ ...obj, }); @@ -225,6 +252,9 @@ export interface AssociateResourceResponse { } export namespace AssociateResourceResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: AssociateResourceResponse): any => ({ ...obj, }); @@ -241,6 +271,9 @@ export interface ConflictException extends __SmithyException, $MetadataBearer { } export namespace ConflictException { + /** + * @internal + */ export const filterSensitiveLog = (obj: ConflictException): any => ({ ...obj, }); @@ -287,6 +320,9 @@ export interface AttributeGroup { } export namespace AttributeGroup { + /** + * @internal + */ export const filterSensitiveLog = (obj: AttributeGroup): any => ({ ...obj, }); @@ -328,6 +364,9 @@ export interface AttributeGroupSummary { } export namespace AttributeGroupSummary { + /** + * @internal + */ export const filterSensitiveLog = (obj: AttributeGroupSummary): any => ({ ...obj, }); @@ -359,6 +398,9 @@ export interface CreateApplicationRequest { } export namespace CreateApplicationRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateApplicationRequest): any => ({ ...obj, }); @@ -372,6 +414,9 @@ export interface CreateApplicationResponse { } export namespace CreateApplicationResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateApplicationResponse): any => ({ ...obj, }); @@ -408,6 +453,9 @@ export interface CreateAttributeGroupRequest { } export namespace CreateAttributeGroupRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateAttributeGroupRequest): any => ({ ...obj, }); @@ -421,6 +469,9 @@ export interface CreateAttributeGroupResponse { } export namespace CreateAttributeGroupResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateAttributeGroupResponse): any => ({ ...obj, }); @@ -434,6 +485,9 @@ export interface DeleteApplicationRequest { } export namespace DeleteApplicationRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteApplicationRequest): any => ({ ...obj, }); @@ -447,6 +501,9 @@ export interface DeleteApplicationResponse { } export namespace DeleteApplicationResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteApplicationResponse): any => ({ ...obj, }); @@ -460,6 +517,9 @@ export interface DeleteAttributeGroupRequest { } export namespace DeleteAttributeGroupRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteAttributeGroupRequest): any => ({ ...obj, }); @@ -473,6 +533,9 @@ export interface DeleteAttributeGroupResponse { } export namespace DeleteAttributeGroupResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteAttributeGroupResponse): any => ({ ...obj, }); @@ -491,6 +554,9 @@ export interface DisassociateAttributeGroupRequest { } export namespace DisassociateAttributeGroupRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DisassociateAttributeGroupRequest): any => ({ ...obj, }); @@ -509,6 +575,9 @@ export interface DisassociateAttributeGroupResponse { } export namespace DisassociateAttributeGroupResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DisassociateAttributeGroupResponse): any => ({ ...obj, }); @@ -532,6 +601,9 @@ export interface DisassociateResourceRequest { } export namespace DisassociateResourceRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DisassociateResourceRequest): any => ({ ...obj, }); @@ -550,6 +622,9 @@ export interface DisassociateResourceResponse { } export namespace DisassociateResourceResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DisassociateResourceResponse): any => ({ ...obj, }); @@ -563,6 +638,9 @@ export interface GetApplicationRequest { } export namespace GetApplicationRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetApplicationRequest): any => ({ ...obj, }); @@ -611,6 +689,9 @@ export interface GetApplicationResponse { } export namespace GetApplicationResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetApplicationResponse): any => ({ ...obj, }); @@ -624,6 +705,9 @@ export interface GetAttributeGroupRequest { } export namespace GetAttributeGroupRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetAttributeGroupRequest): any => ({ ...obj, }); @@ -672,6 +756,9 @@ export interface GetAttributeGroupResponse { } export namespace GetAttributeGroupResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetAttributeGroupResponse): any => ({ ...obj, }); @@ -690,6 +777,9 @@ export interface ListApplicationsRequest { } export namespace ListApplicationsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListApplicationsRequest): any => ({ ...obj, }); @@ -708,6 +798,9 @@ export interface ListApplicationsResponse { } export namespace ListApplicationsResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListApplicationsResponse): any => ({ ...obj, }); @@ -731,6 +824,9 @@ export interface ListAssociatedAttributeGroupsRequest { } export namespace ListAssociatedAttributeGroupsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListAssociatedAttributeGroupsRequest): any => ({ ...obj, }); @@ -749,6 +845,9 @@ export interface ListAssociatedAttributeGroupsResponse { } export namespace ListAssociatedAttributeGroupsResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListAssociatedAttributeGroupsResponse): any => ({ ...obj, }); @@ -772,6 +871,9 @@ export interface ListAssociatedResourcesRequest { } export namespace ListAssociatedResourcesRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListAssociatedResourcesRequest): any => ({ ...obj, }); @@ -793,6 +895,9 @@ export interface ResourceInfo { } export namespace ResourceInfo { + /** + * @internal + */ export const filterSensitiveLog = (obj: ResourceInfo): any => ({ ...obj, }); @@ -811,6 +916,9 @@ export interface ListAssociatedResourcesResponse { } export namespace ListAssociatedResourcesResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListAssociatedResourcesResponse): any => ({ ...obj, }); @@ -829,6 +937,9 @@ export interface ListAttributeGroupsRequest { } export namespace ListAttributeGroupsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListAttributeGroupsRequest): any => ({ ...obj, }); @@ -847,6 +958,9 @@ export interface ListAttributeGroupsResponse { } export namespace ListAttributeGroupsResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListAttributeGroupsResponse): any => ({ ...obj, }); @@ -860,6 +974,9 @@ export interface ListTagsForResourceRequest { } export namespace ListTagsForResourceRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListTagsForResourceRequest): any => ({ ...obj, }); @@ -873,6 +990,9 @@ export interface ListTagsForResourceResponse { } export namespace ListTagsForResourceResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListTagsForResourceResponse): any => ({ ...obj, }); @@ -891,6 +1011,9 @@ export interface SyncResourceRequest { } export namespace SyncResourceRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: SyncResourceRequest): any => ({ ...obj, }); @@ -919,6 +1042,9 @@ export interface SyncResourceResponse { } export namespace SyncResourceResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: SyncResourceResponse): any => ({ ...obj, }); @@ -937,6 +1063,9 @@ export interface TagResourceRequest { } export namespace TagResourceRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: TagResourceRequest): any => ({ ...obj, }); @@ -945,6 +1074,9 @@ export namespace TagResourceRequest { export interface TagResourceResponse {} export namespace TagResourceResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: TagResourceResponse): any => ({ ...obj, }); @@ -963,6 +1095,9 @@ export interface UntagResourceRequest { } export namespace UntagResourceRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: UntagResourceRequest): any => ({ ...obj, }); @@ -971,6 +1106,9 @@ export namespace UntagResourceRequest { export interface UntagResourceResponse {} export namespace UntagResourceResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: UntagResourceResponse): any => ({ ...obj, }); @@ -994,6 +1132,9 @@ export interface UpdateApplicationRequest { } export namespace UpdateApplicationRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateApplicationRequest): any => ({ ...obj, }); @@ -1007,6 +1148,9 @@ export interface UpdateApplicationResponse { } export namespace UpdateApplicationResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateApplicationResponse): any => ({ ...obj, }); @@ -1036,6 +1180,9 @@ export interface UpdateAttributeGroupRequest { } export namespace UpdateAttributeGroupRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateAttributeGroupRequest): any => ({ ...obj, }); @@ -1049,6 +1196,9 @@ export interface UpdateAttributeGroupResponse { } export namespace UpdateAttributeGroupResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateAttributeGroupResponse): any => ({ ...obj, }); diff --git a/clients/client-service-catalog/commands/AcceptPortfolioShareCommand.ts b/clients/client-service-catalog/commands/AcceptPortfolioShareCommand.ts index f49b954af9bd..ff157159e214 100644 --- a/clients/client-service-catalog/commands/AcceptPortfolioShareCommand.ts +++ b/clients/client-service-catalog/commands/AcceptPortfolioShareCommand.ts @@ -22,6 +22,20 @@ export interface AcceptPortfolioShareCommandOutput extends AcceptPortfolioShareO /** *

Accepts an offer to share the specified portfolio.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ServiceCatalogClient, AcceptPortfolioShareCommand } from "@aws-sdk/client-service-catalog"; // ES Modules import + * // const { ServiceCatalogClient, AcceptPortfolioShareCommand } = require("@aws-sdk/client-service-catalog"); // CommonJS import + * const client = new ServiceCatalogClient(config); + * const command = new AcceptPortfolioShareCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link AcceptPortfolioShareCommandInput} for command's `input` shape. + * @see {@link AcceptPortfolioShareCommandOutput} for command's `response` shape. + * @see {@link ServiceCatalogClientResolvedConfig | config} for command's `input` shape. + * */ export class AcceptPortfolioShareCommand extends $Command< AcceptPortfolioShareCommandInput, diff --git a/clients/client-service-catalog/commands/AssociateBudgetWithResourceCommand.ts b/clients/client-service-catalog/commands/AssociateBudgetWithResourceCommand.ts index 3bf24db69729..f86a2977b808 100644 --- a/clients/client-service-catalog/commands/AssociateBudgetWithResourceCommand.ts +++ b/clients/client-service-catalog/commands/AssociateBudgetWithResourceCommand.ts @@ -22,6 +22,20 @@ export interface AssociateBudgetWithResourceCommandOutput extends AssociateBudge /** *

Associates the specified budget with the specified resource.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ServiceCatalogClient, AssociateBudgetWithResourceCommand } from "@aws-sdk/client-service-catalog"; // ES Modules import + * // const { ServiceCatalogClient, AssociateBudgetWithResourceCommand } = require("@aws-sdk/client-service-catalog"); // CommonJS import + * const client = new ServiceCatalogClient(config); + * const command = new AssociateBudgetWithResourceCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link AssociateBudgetWithResourceCommandInput} for command's `input` shape. + * @see {@link AssociateBudgetWithResourceCommandOutput} for command's `response` shape. + * @see {@link ServiceCatalogClientResolvedConfig | config} for command's `input` shape. + * */ export class AssociateBudgetWithResourceCommand extends $Command< AssociateBudgetWithResourceCommandInput, diff --git a/clients/client-service-catalog/commands/AssociatePrincipalWithPortfolioCommand.ts b/clients/client-service-catalog/commands/AssociatePrincipalWithPortfolioCommand.ts index a2adcb5229d3..b16baf67a833 100644 --- a/clients/client-service-catalog/commands/AssociatePrincipalWithPortfolioCommand.ts +++ b/clients/client-service-catalog/commands/AssociatePrincipalWithPortfolioCommand.ts @@ -24,6 +24,20 @@ export interface AssociatePrincipalWithPortfolioCommandOutput /** *

Associates the specified principal ARN with the specified portfolio.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ServiceCatalogClient, AssociatePrincipalWithPortfolioCommand } from "@aws-sdk/client-service-catalog"; // ES Modules import + * // const { ServiceCatalogClient, AssociatePrincipalWithPortfolioCommand } = require("@aws-sdk/client-service-catalog"); // CommonJS import + * const client = new ServiceCatalogClient(config); + * const command = new AssociatePrincipalWithPortfolioCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link AssociatePrincipalWithPortfolioCommandInput} for command's `input` shape. + * @see {@link AssociatePrincipalWithPortfolioCommandOutput} for command's `response` shape. + * @see {@link ServiceCatalogClientResolvedConfig | config} for command's `input` shape. + * */ export class AssociatePrincipalWithPortfolioCommand extends $Command< AssociatePrincipalWithPortfolioCommandInput, diff --git a/clients/client-service-catalog/commands/AssociateProductWithPortfolioCommand.ts b/clients/client-service-catalog/commands/AssociateProductWithPortfolioCommand.ts index ee1cdfaa8e4e..23e8e85440e7 100644 --- a/clients/client-service-catalog/commands/AssociateProductWithPortfolioCommand.ts +++ b/clients/client-service-catalog/commands/AssociateProductWithPortfolioCommand.ts @@ -25,6 +25,20 @@ export interface AssociateProductWithPortfolioCommandOutput /** *

Associates the specified product with the specified portfolio.

*

A delegated admin is authorized to invoke this command.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ServiceCatalogClient, AssociateProductWithPortfolioCommand } from "@aws-sdk/client-service-catalog"; // ES Modules import + * // const { ServiceCatalogClient, AssociateProductWithPortfolioCommand } = require("@aws-sdk/client-service-catalog"); // CommonJS import + * const client = new ServiceCatalogClient(config); + * const command = new AssociateProductWithPortfolioCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link AssociateProductWithPortfolioCommandInput} for command's `input` shape. + * @see {@link AssociateProductWithPortfolioCommandOutput} for command's `response` shape. + * @see {@link ServiceCatalogClientResolvedConfig | config} for command's `input` shape. + * */ export class AssociateProductWithPortfolioCommand extends $Command< AssociateProductWithPortfolioCommandInput, diff --git a/clients/client-service-catalog/commands/AssociateServiceActionWithProvisioningArtifactCommand.ts b/clients/client-service-catalog/commands/AssociateServiceActionWithProvisioningArtifactCommand.ts index 5fdff0851294..7bab2bfbe597 100644 --- a/clients/client-service-catalog/commands/AssociateServiceActionWithProvisioningArtifactCommand.ts +++ b/clients/client-service-catalog/commands/AssociateServiceActionWithProvisioningArtifactCommand.ts @@ -28,6 +28,20 @@ export interface AssociateServiceActionWithProvisioningArtifactCommandOutput /** *

Associates a self-service action with a provisioning artifact.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ServiceCatalogClient, AssociateServiceActionWithProvisioningArtifactCommand } from "@aws-sdk/client-service-catalog"; // ES Modules import + * // const { ServiceCatalogClient, AssociateServiceActionWithProvisioningArtifactCommand } = require("@aws-sdk/client-service-catalog"); // CommonJS import + * const client = new ServiceCatalogClient(config); + * const command = new AssociateServiceActionWithProvisioningArtifactCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link AssociateServiceActionWithProvisioningArtifactCommandInput} for command's `input` shape. + * @see {@link AssociateServiceActionWithProvisioningArtifactCommandOutput} for command's `response` shape. + * @see {@link ServiceCatalogClientResolvedConfig | config} for command's `input` shape. + * */ export class AssociateServiceActionWithProvisioningArtifactCommand extends $Command< AssociateServiceActionWithProvisioningArtifactCommandInput, diff --git a/clients/client-service-catalog/commands/AssociateTagOptionWithResourceCommand.ts b/clients/client-service-catalog/commands/AssociateTagOptionWithResourceCommand.ts index 319a29582eef..e48d7695956d 100644 --- a/clients/client-service-catalog/commands/AssociateTagOptionWithResourceCommand.ts +++ b/clients/client-service-catalog/commands/AssociateTagOptionWithResourceCommand.ts @@ -24,6 +24,20 @@ export interface AssociateTagOptionWithResourceCommandOutput /** *

Associate the specified TagOption with the specified portfolio or product.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ServiceCatalogClient, AssociateTagOptionWithResourceCommand } from "@aws-sdk/client-service-catalog"; // ES Modules import + * // const { ServiceCatalogClient, AssociateTagOptionWithResourceCommand } = require("@aws-sdk/client-service-catalog"); // CommonJS import + * const client = new ServiceCatalogClient(config); + * const command = new AssociateTagOptionWithResourceCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link AssociateTagOptionWithResourceCommandInput} for command's `input` shape. + * @see {@link AssociateTagOptionWithResourceCommandOutput} for command's `response` shape. + * @see {@link ServiceCatalogClientResolvedConfig | config} for command's `input` shape. + * */ export class AssociateTagOptionWithResourceCommand extends $Command< AssociateTagOptionWithResourceCommandInput, diff --git a/clients/client-service-catalog/commands/BatchAssociateServiceActionWithProvisioningArtifactCommand.ts b/clients/client-service-catalog/commands/BatchAssociateServiceActionWithProvisioningArtifactCommand.ts index 3909e7e05f2d..4946d6c30e46 100644 --- a/clients/client-service-catalog/commands/BatchAssociateServiceActionWithProvisioningArtifactCommand.ts +++ b/clients/client-service-catalog/commands/BatchAssociateServiceActionWithProvisioningArtifactCommand.ts @@ -28,6 +28,20 @@ export interface BatchAssociateServiceActionWithProvisioningArtifactCommandOutpu /** *

Associates multiple self-service actions with provisioning artifacts.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ServiceCatalogClient, BatchAssociateServiceActionWithProvisioningArtifactCommand } from "@aws-sdk/client-service-catalog"; // ES Modules import + * // const { ServiceCatalogClient, BatchAssociateServiceActionWithProvisioningArtifactCommand } = require("@aws-sdk/client-service-catalog"); // CommonJS import + * const client = new ServiceCatalogClient(config); + * const command = new BatchAssociateServiceActionWithProvisioningArtifactCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link BatchAssociateServiceActionWithProvisioningArtifactCommandInput} for command's `input` shape. + * @see {@link BatchAssociateServiceActionWithProvisioningArtifactCommandOutput} for command's `response` shape. + * @see {@link ServiceCatalogClientResolvedConfig | config} for command's `input` shape. + * */ export class BatchAssociateServiceActionWithProvisioningArtifactCommand extends $Command< BatchAssociateServiceActionWithProvisioningArtifactCommandInput, diff --git a/clients/client-service-catalog/commands/BatchDisassociateServiceActionFromProvisioningArtifactCommand.ts b/clients/client-service-catalog/commands/BatchDisassociateServiceActionFromProvisioningArtifactCommand.ts index d648dec5f77a..2358ccc862a1 100644 --- a/clients/client-service-catalog/commands/BatchDisassociateServiceActionFromProvisioningArtifactCommand.ts +++ b/clients/client-service-catalog/commands/BatchDisassociateServiceActionFromProvisioningArtifactCommand.ts @@ -28,6 +28,20 @@ export interface BatchDisassociateServiceActionFromProvisioningArtifactCommandOu /** *

Disassociates a batch of self-service actions from the specified provisioning artifact.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ServiceCatalogClient, BatchDisassociateServiceActionFromProvisioningArtifactCommand } from "@aws-sdk/client-service-catalog"; // ES Modules import + * // const { ServiceCatalogClient, BatchDisassociateServiceActionFromProvisioningArtifactCommand } = require("@aws-sdk/client-service-catalog"); // CommonJS import + * const client = new ServiceCatalogClient(config); + * const command = new BatchDisassociateServiceActionFromProvisioningArtifactCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link BatchDisassociateServiceActionFromProvisioningArtifactCommandInput} for command's `input` shape. + * @see {@link BatchDisassociateServiceActionFromProvisioningArtifactCommandOutput} for command's `response` shape. + * @see {@link ServiceCatalogClientResolvedConfig | config} for command's `input` shape. + * */ export class BatchDisassociateServiceActionFromProvisioningArtifactCommand extends $Command< BatchDisassociateServiceActionFromProvisioningArtifactCommandInput, diff --git a/clients/client-service-catalog/commands/CopyProductCommand.ts b/clients/client-service-catalog/commands/CopyProductCommand.ts index 0b542d989e2b..44eaf8815fd6 100644 --- a/clients/client-service-catalog/commands/CopyProductCommand.ts +++ b/clients/client-service-catalog/commands/CopyProductCommand.ts @@ -26,6 +26,20 @@ export interface CopyProductCommandOutput extends CopyProductOutput, __MetadataB * You can copy a product to the same region or another region.

*

This operation is performed asynchronously. To track the progress of the * operation, use DescribeCopyProductStatus.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ServiceCatalogClient, CopyProductCommand } from "@aws-sdk/client-service-catalog"; // ES Modules import + * // const { ServiceCatalogClient, CopyProductCommand } = require("@aws-sdk/client-service-catalog"); // CommonJS import + * const client = new ServiceCatalogClient(config); + * const command = new CopyProductCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CopyProductCommandInput} for command's `input` shape. + * @see {@link CopyProductCommandOutput} for command's `response` shape. + * @see {@link ServiceCatalogClientResolvedConfig | config} for command's `input` shape. + * */ export class CopyProductCommand extends $Command< CopyProductCommandInput, diff --git a/clients/client-service-catalog/commands/CreateConstraintCommand.ts b/clients/client-service-catalog/commands/CreateConstraintCommand.ts index f060e2bece75..1691600f957b 100644 --- a/clients/client-service-catalog/commands/CreateConstraintCommand.ts +++ b/clients/client-service-catalog/commands/CreateConstraintCommand.ts @@ -23,6 +23,20 @@ export interface CreateConstraintCommandOutput extends CreateConstraintOutput, _ /** *

Creates a constraint.

*

A delegated admin is authorized to invoke this command.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ServiceCatalogClient, CreateConstraintCommand } from "@aws-sdk/client-service-catalog"; // ES Modules import + * // const { ServiceCatalogClient, CreateConstraintCommand } = require("@aws-sdk/client-service-catalog"); // CommonJS import + * const client = new ServiceCatalogClient(config); + * const command = new CreateConstraintCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreateConstraintCommandInput} for command's `input` shape. + * @see {@link CreateConstraintCommandOutput} for command's `response` shape. + * @see {@link ServiceCatalogClientResolvedConfig | config} for command's `input` shape. + * */ export class CreateConstraintCommand extends $Command< CreateConstraintCommandInput, diff --git a/clients/client-service-catalog/commands/CreatePortfolioCommand.ts b/clients/client-service-catalog/commands/CreatePortfolioCommand.ts index 80d2071900d3..8a150449b0ca 100644 --- a/clients/client-service-catalog/commands/CreatePortfolioCommand.ts +++ b/clients/client-service-catalog/commands/CreatePortfolioCommand.ts @@ -23,6 +23,20 @@ export interface CreatePortfolioCommandOutput extends CreatePortfolioOutput, __M /** *

Creates a portfolio.

*

A delegated admin is authorized to invoke this command.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ServiceCatalogClient, CreatePortfolioCommand } from "@aws-sdk/client-service-catalog"; // ES Modules import + * // const { ServiceCatalogClient, CreatePortfolioCommand } = require("@aws-sdk/client-service-catalog"); // CommonJS import + * const client = new ServiceCatalogClient(config); + * const command = new CreatePortfolioCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreatePortfolioCommandInput} for command's `input` shape. + * @see {@link CreatePortfolioCommandOutput} for command's `response` shape. + * @see {@link ServiceCatalogClientResolvedConfig | config} for command's `input` shape. + * */ export class CreatePortfolioCommand extends $Command< CreatePortfolioCommandInput, diff --git a/clients/client-service-catalog/commands/CreatePortfolioShareCommand.ts b/clients/client-service-catalog/commands/CreatePortfolioShareCommand.ts index 2f2369bfb501..5a2390b65888 100644 --- a/clients/client-service-catalog/commands/CreatePortfolioShareCommand.ts +++ b/clients/client-service-catalog/commands/CreatePortfolioShareCommand.ts @@ -30,6 +30,20 @@ export interface CreatePortfolioShareCommandOutput extends CreatePortfolioShareO * 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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ServiceCatalogClient, CreatePortfolioShareCommand } from "@aws-sdk/client-service-catalog"; // ES Modules import + * // const { ServiceCatalogClient, CreatePortfolioShareCommand } = require("@aws-sdk/client-service-catalog"); // CommonJS import + * const client = new ServiceCatalogClient(config); + * const command = new CreatePortfolioShareCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreatePortfolioShareCommandInput} for command's `input` shape. + * @see {@link CreatePortfolioShareCommandOutput} for command's `response` shape. + * @see {@link ServiceCatalogClientResolvedConfig | config} for command's `input` shape. + * */ export class CreatePortfolioShareCommand extends $Command< CreatePortfolioShareCommandInput, diff --git a/clients/client-service-catalog/commands/CreateProductCommand.ts b/clients/client-service-catalog/commands/CreateProductCommand.ts index adac979e1e22..6fd799cf133e 100644 --- a/clients/client-service-catalog/commands/CreateProductCommand.ts +++ b/clients/client-service-catalog/commands/CreateProductCommand.ts @@ -28,6 +28,20 @@ export interface CreateProductCommandOutput extends CreateProductOutput, __Metad * cloudformation:GetTemplate IAM policy permission. This policy permission is * required when using the ImportFromPhysicalId template source in the * information data section.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ServiceCatalogClient, CreateProductCommand } from "@aws-sdk/client-service-catalog"; // ES Modules import + * // const { ServiceCatalogClient, CreateProductCommand } = require("@aws-sdk/client-service-catalog"); // CommonJS import + * const client = new ServiceCatalogClient(config); + * const command = new CreateProductCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreateProductCommandInput} for command's `input` shape. + * @see {@link CreateProductCommandOutput} for command's `response` shape. + * @see {@link ServiceCatalogClientResolvedConfig | config} for command's `input` shape. + * */ export class CreateProductCommand extends $Command< CreateProductCommandInput, diff --git a/clients/client-service-catalog/commands/CreateProvisionedProductPlanCommand.ts b/clients/client-service-catalog/commands/CreateProvisionedProductPlanCommand.ts index ea8742326411..0a6197a97db7 100644 --- a/clients/client-service-catalog/commands/CreateProvisionedProductPlanCommand.ts +++ b/clients/client-service-catalog/commands/CreateProvisionedProductPlanCommand.ts @@ -30,6 +30,20 @@ export interface CreateProvisionedProductPlanCommandOutput * provisioned product, the product status must be AVAILBLE or TAINTED.

*

To view the resource changes in the change set, use DescribeProvisionedProductPlan. * To create or modify the provisioned product, use ExecuteProvisionedProductPlan.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ServiceCatalogClient, CreateProvisionedProductPlanCommand } from "@aws-sdk/client-service-catalog"; // ES Modules import + * // const { ServiceCatalogClient, CreateProvisionedProductPlanCommand } = require("@aws-sdk/client-service-catalog"); // CommonJS import + * const client = new ServiceCatalogClient(config); + * const command = new CreateProvisionedProductPlanCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreateProvisionedProductPlanCommandInput} for command's `input` shape. + * @see {@link CreateProvisionedProductPlanCommandOutput} for command's `response` shape. + * @see {@link ServiceCatalogClientResolvedConfig | config} for command's `input` shape. + * */ export class CreateProvisionedProductPlanCommand extends $Command< CreateProvisionedProductPlanCommandInput, diff --git a/clients/client-service-catalog/commands/CreateProvisioningArtifactCommand.ts b/clients/client-service-catalog/commands/CreateProvisioningArtifactCommand.ts index 84313d7cf684..9d382c2ac505 100644 --- a/clients/client-service-catalog/commands/CreateProvisioningArtifactCommand.ts +++ b/clients/client-service-catalog/commands/CreateProvisioningArtifactCommand.ts @@ -27,6 +27,20 @@ export interface CreateProvisioningArtifactCommandOutput extends CreateProvision *

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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ServiceCatalogClient, CreateProvisioningArtifactCommand } from "@aws-sdk/client-service-catalog"; // ES Modules import + * // const { ServiceCatalogClient, CreateProvisioningArtifactCommand } = require("@aws-sdk/client-service-catalog"); // CommonJS import + * const client = new ServiceCatalogClient(config); + * const command = new CreateProvisioningArtifactCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreateProvisioningArtifactCommandInput} for command's `input` shape. + * @see {@link CreateProvisioningArtifactCommandOutput} for command's `response` shape. + * @see {@link ServiceCatalogClientResolvedConfig | config} for command's `input` shape. + * */ export class CreateProvisioningArtifactCommand extends $Command< CreateProvisioningArtifactCommandInput, diff --git a/clients/client-service-catalog/commands/CreateServiceActionCommand.ts b/clients/client-service-catalog/commands/CreateServiceActionCommand.ts index b465eec40b48..4e84c35986f8 100644 --- a/clients/client-service-catalog/commands/CreateServiceActionCommand.ts +++ b/clients/client-service-catalog/commands/CreateServiceActionCommand.ts @@ -22,6 +22,20 @@ export interface CreateServiceActionCommandOutput extends CreateServiceActionOut /** *

Creates a self-service action.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ServiceCatalogClient, CreateServiceActionCommand } from "@aws-sdk/client-service-catalog"; // ES Modules import + * // const { ServiceCatalogClient, CreateServiceActionCommand } = require("@aws-sdk/client-service-catalog"); // CommonJS import + * const client = new ServiceCatalogClient(config); + * const command = new CreateServiceActionCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreateServiceActionCommandInput} for command's `input` shape. + * @see {@link CreateServiceActionCommandOutput} for command's `response` shape. + * @see {@link ServiceCatalogClientResolvedConfig | config} for command's `input` shape. + * */ export class CreateServiceActionCommand extends $Command< CreateServiceActionCommandInput, diff --git a/clients/client-service-catalog/commands/CreateTagOptionCommand.ts b/clients/client-service-catalog/commands/CreateTagOptionCommand.ts index b9196fa3d0ce..d335e0aa3f00 100644 --- a/clients/client-service-catalog/commands/CreateTagOptionCommand.ts +++ b/clients/client-service-catalog/commands/CreateTagOptionCommand.ts @@ -22,6 +22,20 @@ export interface CreateTagOptionCommandOutput extends CreateTagOptionOutput, __M /** *

Creates a TagOption.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ServiceCatalogClient, CreateTagOptionCommand } from "@aws-sdk/client-service-catalog"; // ES Modules import + * // const { ServiceCatalogClient, CreateTagOptionCommand } = require("@aws-sdk/client-service-catalog"); // CommonJS import + * const client = new ServiceCatalogClient(config); + * const command = new CreateTagOptionCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreateTagOptionCommandInput} for command's `input` shape. + * @see {@link CreateTagOptionCommandOutput} for command's `response` shape. + * @see {@link ServiceCatalogClientResolvedConfig | config} for command's `input` shape. + * */ export class CreateTagOptionCommand extends $Command< CreateTagOptionCommandInput, diff --git a/clients/client-service-catalog/commands/DeleteConstraintCommand.ts b/clients/client-service-catalog/commands/DeleteConstraintCommand.ts index d0ae05e59533..7cf82b41397e 100644 --- a/clients/client-service-catalog/commands/DeleteConstraintCommand.ts +++ b/clients/client-service-catalog/commands/DeleteConstraintCommand.ts @@ -23,6 +23,20 @@ export interface DeleteConstraintCommandOutput extends DeleteConstraintOutput, _ /** *

Deletes the specified constraint.

*

A delegated admin is authorized to invoke this command.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ServiceCatalogClient, DeleteConstraintCommand } from "@aws-sdk/client-service-catalog"; // ES Modules import + * // const { ServiceCatalogClient, DeleteConstraintCommand } = require("@aws-sdk/client-service-catalog"); // CommonJS import + * const client = new ServiceCatalogClient(config); + * const command = new DeleteConstraintCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteConstraintCommandInput} for command's `input` shape. + * @see {@link DeleteConstraintCommandOutput} for command's `response` shape. + * @see {@link ServiceCatalogClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteConstraintCommand extends $Command< DeleteConstraintCommandInput, diff --git a/clients/client-service-catalog/commands/DeletePortfolioCommand.ts b/clients/client-service-catalog/commands/DeletePortfolioCommand.ts index fdaedb65bfae..a72b927e64c1 100644 --- a/clients/client-service-catalog/commands/DeletePortfolioCommand.ts +++ b/clients/client-service-catalog/commands/DeletePortfolioCommand.ts @@ -25,6 +25,20 @@ export interface DeletePortfolioCommandOutput extends DeletePortfolioOutput, __M *

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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ServiceCatalogClient, DeletePortfolioCommand } from "@aws-sdk/client-service-catalog"; // ES Modules import + * // const { ServiceCatalogClient, DeletePortfolioCommand } = require("@aws-sdk/client-service-catalog"); // CommonJS import + * const client = new ServiceCatalogClient(config); + * const command = new DeletePortfolioCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeletePortfolioCommandInput} for command's `input` shape. + * @see {@link DeletePortfolioCommandOutput} for command's `response` shape. + * @see {@link ServiceCatalogClientResolvedConfig | config} for command's `input` shape. + * */ export class DeletePortfolioCommand extends $Command< DeletePortfolioCommandInput, diff --git a/clients/client-service-catalog/commands/DeletePortfolioShareCommand.ts b/clients/client-service-catalog/commands/DeletePortfolioShareCommand.ts index 5991ae2f0532..84cd0564d2d6 100644 --- a/clients/client-service-catalog/commands/DeletePortfolioShareCommand.ts +++ b/clients/client-service-catalog/commands/DeletePortfolioShareCommand.ts @@ -25,6 +25,20 @@ export interface DeletePortfolioShareCommandOutput extends DeletePortfolioShareO * 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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ServiceCatalogClient, DeletePortfolioShareCommand } from "@aws-sdk/client-service-catalog"; // ES Modules import + * // const { ServiceCatalogClient, DeletePortfolioShareCommand } = require("@aws-sdk/client-service-catalog"); // CommonJS import + * const client = new ServiceCatalogClient(config); + * const command = new DeletePortfolioShareCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeletePortfolioShareCommandInput} for command's `input` shape. + * @see {@link DeletePortfolioShareCommandOutput} for command's `response` shape. + * @see {@link ServiceCatalogClientResolvedConfig | config} for command's `input` shape. + * */ export class DeletePortfolioShareCommand extends $Command< DeletePortfolioShareCommandInput, diff --git a/clients/client-service-catalog/commands/DeleteProductCommand.ts b/clients/client-service-catalog/commands/DeleteProductCommand.ts index 498a2c0a5791..6ef17569c6c3 100644 --- a/clients/client-service-catalog/commands/DeleteProductCommand.ts +++ b/clients/client-service-catalog/commands/DeleteProductCommand.ts @@ -24,6 +24,20 @@ export interface DeleteProductCommandOutput extends DeleteProductOutput, __Metad *

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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ServiceCatalogClient, DeleteProductCommand } from "@aws-sdk/client-service-catalog"; // ES Modules import + * // const { ServiceCatalogClient, DeleteProductCommand } = require("@aws-sdk/client-service-catalog"); // CommonJS import + * const client = new ServiceCatalogClient(config); + * const command = new DeleteProductCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteProductCommandInput} for command's `input` shape. + * @see {@link DeleteProductCommandOutput} for command's `response` shape. + * @see {@link ServiceCatalogClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteProductCommand extends $Command< DeleteProductCommandInput, diff --git a/clients/client-service-catalog/commands/DeleteProvisionedProductPlanCommand.ts b/clients/client-service-catalog/commands/DeleteProvisionedProductPlanCommand.ts index 5777a206c2d7..fd2bb09f9ddc 100644 --- a/clients/client-service-catalog/commands/DeleteProvisionedProductPlanCommand.ts +++ b/clients/client-service-catalog/commands/DeleteProvisionedProductPlanCommand.ts @@ -24,6 +24,20 @@ export interface DeleteProvisionedProductPlanCommandOutput /** *

Deletes the specified plan.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ServiceCatalogClient, DeleteProvisionedProductPlanCommand } from "@aws-sdk/client-service-catalog"; // ES Modules import + * // const { ServiceCatalogClient, DeleteProvisionedProductPlanCommand } = require("@aws-sdk/client-service-catalog"); // CommonJS import + * const client = new ServiceCatalogClient(config); + * const command = new DeleteProvisionedProductPlanCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteProvisionedProductPlanCommandInput} for command's `input` shape. + * @see {@link DeleteProvisionedProductPlanCommandOutput} for command's `response` shape. + * @see {@link ServiceCatalogClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteProvisionedProductPlanCommand extends $Command< DeleteProvisionedProductPlanCommandInput, diff --git a/clients/client-service-catalog/commands/DeleteProvisioningArtifactCommand.ts b/clients/client-service-catalog/commands/DeleteProvisioningArtifactCommand.ts index 2143cb6c9132..2dd3e1244365 100644 --- a/clients/client-service-catalog/commands/DeleteProvisioningArtifactCommand.ts +++ b/clients/client-service-catalog/commands/DeleteProvisioningArtifactCommand.ts @@ -25,6 +25,20 @@ export interface DeleteProvisioningArtifactCommandOutput extends DeleteProvision *

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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ServiceCatalogClient, DeleteProvisioningArtifactCommand } from "@aws-sdk/client-service-catalog"; // ES Modules import + * // const { ServiceCatalogClient, DeleteProvisioningArtifactCommand } = require("@aws-sdk/client-service-catalog"); // CommonJS import + * const client = new ServiceCatalogClient(config); + * const command = new DeleteProvisioningArtifactCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteProvisioningArtifactCommandInput} for command's `input` shape. + * @see {@link DeleteProvisioningArtifactCommandOutput} for command's `response` shape. + * @see {@link ServiceCatalogClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteProvisioningArtifactCommand extends $Command< DeleteProvisioningArtifactCommandInput, diff --git a/clients/client-service-catalog/commands/DeleteServiceActionCommand.ts b/clients/client-service-catalog/commands/DeleteServiceActionCommand.ts index 130f35e5e9cc..90d09f911430 100644 --- a/clients/client-service-catalog/commands/DeleteServiceActionCommand.ts +++ b/clients/client-service-catalog/commands/DeleteServiceActionCommand.ts @@ -22,6 +22,20 @@ export interface DeleteServiceActionCommandOutput extends DeleteServiceActionOut /** *

Deletes a self-service action.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ServiceCatalogClient, DeleteServiceActionCommand } from "@aws-sdk/client-service-catalog"; // ES Modules import + * // const { ServiceCatalogClient, DeleteServiceActionCommand } = require("@aws-sdk/client-service-catalog"); // CommonJS import + * const client = new ServiceCatalogClient(config); + * const command = new DeleteServiceActionCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteServiceActionCommandInput} for command's `input` shape. + * @see {@link DeleteServiceActionCommandOutput} for command's `response` shape. + * @see {@link ServiceCatalogClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteServiceActionCommand extends $Command< DeleteServiceActionCommandInput, diff --git a/clients/client-service-catalog/commands/DeleteTagOptionCommand.ts b/clients/client-service-catalog/commands/DeleteTagOptionCommand.ts index 1257c6a1ee0c..32f97a7ca12b 100644 --- a/clients/client-service-catalog/commands/DeleteTagOptionCommand.ts +++ b/clients/client-service-catalog/commands/DeleteTagOptionCommand.ts @@ -23,6 +23,20 @@ export interface DeleteTagOptionCommandOutput extends DeleteTagOptionOutput, __M /** *

Deletes the specified TagOption.

*

You cannot delete a TagOption if it is associated with a product or portfolio.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ServiceCatalogClient, DeleteTagOptionCommand } from "@aws-sdk/client-service-catalog"; // ES Modules import + * // const { ServiceCatalogClient, DeleteTagOptionCommand } = require("@aws-sdk/client-service-catalog"); // CommonJS import + * const client = new ServiceCatalogClient(config); + * const command = new DeleteTagOptionCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteTagOptionCommandInput} for command's `input` shape. + * @see {@link DeleteTagOptionCommandOutput} for command's `response` shape. + * @see {@link ServiceCatalogClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteTagOptionCommand extends $Command< DeleteTagOptionCommandInput, diff --git a/clients/client-service-catalog/commands/DescribeConstraintCommand.ts b/clients/client-service-catalog/commands/DescribeConstraintCommand.ts index d228ef43ab4a..6df93349b645 100644 --- a/clients/client-service-catalog/commands/DescribeConstraintCommand.ts +++ b/clients/client-service-catalog/commands/DescribeConstraintCommand.ts @@ -22,6 +22,20 @@ export interface DescribeConstraintCommandOutput extends DescribeConstraintOutpu /** *

Gets information about the specified constraint.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ServiceCatalogClient, DescribeConstraintCommand } from "@aws-sdk/client-service-catalog"; // ES Modules import + * // const { ServiceCatalogClient, DescribeConstraintCommand } = require("@aws-sdk/client-service-catalog"); // CommonJS import + * const client = new ServiceCatalogClient(config); + * const command = new DescribeConstraintCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeConstraintCommandInput} for command's `input` shape. + * @see {@link DescribeConstraintCommandOutput} for command's `response` shape. + * @see {@link ServiceCatalogClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeConstraintCommand extends $Command< DescribeConstraintCommandInput, diff --git a/clients/client-service-catalog/commands/DescribeCopyProductStatusCommand.ts b/clients/client-service-catalog/commands/DescribeCopyProductStatusCommand.ts index 7655e5a3ef6b..e823540aa9f3 100644 --- a/clients/client-service-catalog/commands/DescribeCopyProductStatusCommand.ts +++ b/clients/client-service-catalog/commands/DescribeCopyProductStatusCommand.ts @@ -22,6 +22,20 @@ export interface DescribeCopyProductStatusCommandOutput extends DescribeCopyProd /** *

Gets the status of the specified copy product operation.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ServiceCatalogClient, DescribeCopyProductStatusCommand } from "@aws-sdk/client-service-catalog"; // ES Modules import + * // const { ServiceCatalogClient, DescribeCopyProductStatusCommand } = require("@aws-sdk/client-service-catalog"); // CommonJS import + * const client = new ServiceCatalogClient(config); + * const command = new DescribeCopyProductStatusCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeCopyProductStatusCommandInput} for command's `input` shape. + * @see {@link DescribeCopyProductStatusCommandOutput} for command's `response` shape. + * @see {@link ServiceCatalogClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeCopyProductStatusCommand extends $Command< DescribeCopyProductStatusCommandInput, diff --git a/clients/client-service-catalog/commands/DescribePortfolioCommand.ts b/clients/client-service-catalog/commands/DescribePortfolioCommand.ts index 2549a33149ab..d528dd57f999 100644 --- a/clients/client-service-catalog/commands/DescribePortfolioCommand.ts +++ b/clients/client-service-catalog/commands/DescribePortfolioCommand.ts @@ -23,6 +23,20 @@ export interface DescribePortfolioCommandOutput extends DescribePortfolioOutput, /** *

Gets information about the specified portfolio.

*

A delegated admin is authorized to invoke this command.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ServiceCatalogClient, DescribePortfolioCommand } from "@aws-sdk/client-service-catalog"; // ES Modules import + * // const { ServiceCatalogClient, DescribePortfolioCommand } = require("@aws-sdk/client-service-catalog"); // CommonJS import + * const client = new ServiceCatalogClient(config); + * const command = new DescribePortfolioCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribePortfolioCommandInput} for command's `input` shape. + * @see {@link DescribePortfolioCommandOutput} for command's `response` shape. + * @see {@link ServiceCatalogClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribePortfolioCommand extends $Command< DescribePortfolioCommandInput, diff --git a/clients/client-service-catalog/commands/DescribePortfolioShareStatusCommand.ts b/clients/client-service-catalog/commands/DescribePortfolioShareStatusCommand.ts index 1945ddaa7d9b..e853a9bcde95 100644 --- a/clients/client-service-catalog/commands/DescribePortfolioShareStatusCommand.ts +++ b/clients/client-service-catalog/commands/DescribePortfolioShareStatusCommand.ts @@ -25,6 +25,20 @@ export interface DescribePortfolioShareStatusCommandOutput /** *

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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ServiceCatalogClient, DescribePortfolioShareStatusCommand } from "@aws-sdk/client-service-catalog"; // ES Modules import + * // const { ServiceCatalogClient, DescribePortfolioShareStatusCommand } = require("@aws-sdk/client-service-catalog"); // CommonJS import + * const client = new ServiceCatalogClient(config); + * const command = new DescribePortfolioShareStatusCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribePortfolioShareStatusCommandInput} for command's `input` shape. + * @see {@link DescribePortfolioShareStatusCommandOutput} for command's `response` shape. + * @see {@link ServiceCatalogClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribePortfolioShareStatusCommand extends $Command< DescribePortfolioShareStatusCommandInput, diff --git a/clients/client-service-catalog/commands/DescribePortfolioSharesCommand.ts b/clients/client-service-catalog/commands/DescribePortfolioSharesCommand.ts index 64fe466082cc..9a0fcdd54d37 100644 --- a/clients/client-service-catalog/commands/DescribePortfolioSharesCommand.ts +++ b/clients/client-service-catalog/commands/DescribePortfolioSharesCommand.ts @@ -26,6 +26,20 @@ export interface DescribePortfolioSharesCommandOutput extends DescribePortfolioS * 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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ServiceCatalogClient, DescribePortfolioSharesCommand } from "@aws-sdk/client-service-catalog"; // ES Modules import + * // const { ServiceCatalogClient, DescribePortfolioSharesCommand } = require("@aws-sdk/client-service-catalog"); // CommonJS import + * const client = new ServiceCatalogClient(config); + * const command = new DescribePortfolioSharesCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribePortfolioSharesCommandInput} for command's `input` shape. + * @see {@link DescribePortfolioSharesCommandOutput} for command's `response` shape. + * @see {@link ServiceCatalogClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribePortfolioSharesCommand extends $Command< DescribePortfolioSharesCommandInput, diff --git a/clients/client-service-catalog/commands/DescribeProductAsAdminCommand.ts b/clients/client-service-catalog/commands/DescribeProductAsAdminCommand.ts index 5ebc246d32ab..b47e2c953b29 100644 --- a/clients/client-service-catalog/commands/DescribeProductAsAdminCommand.ts +++ b/clients/client-service-catalog/commands/DescribeProductAsAdminCommand.ts @@ -22,6 +22,20 @@ export interface DescribeProductAsAdminCommandOutput extends DescribeProductAsAd /** *

Gets information about the specified product. This operation is run with administrator access.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ServiceCatalogClient, DescribeProductAsAdminCommand } from "@aws-sdk/client-service-catalog"; // ES Modules import + * // const { ServiceCatalogClient, DescribeProductAsAdminCommand } = require("@aws-sdk/client-service-catalog"); // CommonJS import + * const client = new ServiceCatalogClient(config); + * const command = new DescribeProductAsAdminCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeProductAsAdminCommandInput} for command's `input` shape. + * @see {@link DescribeProductAsAdminCommandOutput} for command's `response` shape. + * @see {@link ServiceCatalogClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeProductAsAdminCommand extends $Command< DescribeProductAsAdminCommandInput, diff --git a/clients/client-service-catalog/commands/DescribeProductCommand.ts b/clients/client-service-catalog/commands/DescribeProductCommand.ts index d1e63ecc0620..0565edf4fcc5 100644 --- a/clients/client-service-catalog/commands/DescribeProductCommand.ts +++ b/clients/client-service-catalog/commands/DescribeProductCommand.ts @@ -22,6 +22,20 @@ export interface DescribeProductCommandOutput extends DescribeProductOutput, __M /** *

Gets information about the specified product.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ServiceCatalogClient, DescribeProductCommand } from "@aws-sdk/client-service-catalog"; // ES Modules import + * // const { ServiceCatalogClient, DescribeProductCommand } = require("@aws-sdk/client-service-catalog"); // CommonJS import + * const client = new ServiceCatalogClient(config); + * const command = new DescribeProductCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeProductCommandInput} for command's `input` shape. + * @see {@link DescribeProductCommandOutput} for command's `response` shape. + * @see {@link ServiceCatalogClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeProductCommand extends $Command< DescribeProductCommandInput, diff --git a/clients/client-service-catalog/commands/DescribeProductViewCommand.ts b/clients/client-service-catalog/commands/DescribeProductViewCommand.ts index cca3dd81b4a4..d4c69dcc39fb 100644 --- a/clients/client-service-catalog/commands/DescribeProductViewCommand.ts +++ b/clients/client-service-catalog/commands/DescribeProductViewCommand.ts @@ -22,6 +22,20 @@ export interface DescribeProductViewCommandOutput extends DescribeProductViewOut /** *

Gets information about the specified product.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ServiceCatalogClient, DescribeProductViewCommand } from "@aws-sdk/client-service-catalog"; // ES Modules import + * // const { ServiceCatalogClient, DescribeProductViewCommand } = require("@aws-sdk/client-service-catalog"); // CommonJS import + * const client = new ServiceCatalogClient(config); + * const command = new DescribeProductViewCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeProductViewCommandInput} for command's `input` shape. + * @see {@link DescribeProductViewCommandOutput} for command's `response` shape. + * @see {@link ServiceCatalogClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeProductViewCommand extends $Command< DescribeProductViewCommandInput, diff --git a/clients/client-service-catalog/commands/DescribeProvisionedProductCommand.ts b/clients/client-service-catalog/commands/DescribeProvisionedProductCommand.ts index 25cc15b40981..c7f75d313efd 100644 --- a/clients/client-service-catalog/commands/DescribeProvisionedProductCommand.ts +++ b/clients/client-service-catalog/commands/DescribeProvisionedProductCommand.ts @@ -22,6 +22,20 @@ export interface DescribeProvisionedProductCommandOutput extends DescribeProvisi /** *

Gets information about the specified provisioned product.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ServiceCatalogClient, DescribeProvisionedProductCommand } from "@aws-sdk/client-service-catalog"; // ES Modules import + * // const { ServiceCatalogClient, DescribeProvisionedProductCommand } = require("@aws-sdk/client-service-catalog"); // CommonJS import + * const client = new ServiceCatalogClient(config); + * const command = new DescribeProvisionedProductCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeProvisionedProductCommandInput} for command's `input` shape. + * @see {@link DescribeProvisionedProductCommandOutput} for command's `response` shape. + * @see {@link ServiceCatalogClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeProvisionedProductCommand extends $Command< DescribeProvisionedProductCommandInput, diff --git a/clients/client-service-catalog/commands/DescribeProvisionedProductPlanCommand.ts b/clients/client-service-catalog/commands/DescribeProvisionedProductPlanCommand.ts index 3cbc82c3ec46..c9322bcdedf0 100644 --- a/clients/client-service-catalog/commands/DescribeProvisionedProductPlanCommand.ts +++ b/clients/client-service-catalog/commands/DescribeProvisionedProductPlanCommand.ts @@ -24,6 +24,20 @@ export interface DescribeProvisionedProductPlanCommandOutput /** *

Gets information about the resource changes for the specified plan.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ServiceCatalogClient, DescribeProvisionedProductPlanCommand } from "@aws-sdk/client-service-catalog"; // ES Modules import + * // const { ServiceCatalogClient, DescribeProvisionedProductPlanCommand } = require("@aws-sdk/client-service-catalog"); // CommonJS import + * const client = new ServiceCatalogClient(config); + * const command = new DescribeProvisionedProductPlanCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeProvisionedProductPlanCommandInput} for command's `input` shape. + * @see {@link DescribeProvisionedProductPlanCommandOutput} for command's `response` shape. + * @see {@link ServiceCatalogClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeProvisionedProductPlanCommand extends $Command< DescribeProvisionedProductPlanCommandInput, diff --git a/clients/client-service-catalog/commands/DescribeProvisioningArtifactCommand.ts b/clients/client-service-catalog/commands/DescribeProvisioningArtifactCommand.ts index acf48d35be18..778e10797f69 100644 --- a/clients/client-service-catalog/commands/DescribeProvisioningArtifactCommand.ts +++ b/clients/client-service-catalog/commands/DescribeProvisioningArtifactCommand.ts @@ -24,6 +24,20 @@ export interface DescribeProvisioningArtifactCommandOutput /** *

Gets information about the specified provisioning artifact (also known as a version) for the specified product.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ServiceCatalogClient, DescribeProvisioningArtifactCommand } from "@aws-sdk/client-service-catalog"; // ES Modules import + * // const { ServiceCatalogClient, DescribeProvisioningArtifactCommand } = require("@aws-sdk/client-service-catalog"); // CommonJS import + * const client = new ServiceCatalogClient(config); + * const command = new DescribeProvisioningArtifactCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeProvisioningArtifactCommandInput} for command's `input` shape. + * @see {@link DescribeProvisioningArtifactCommandOutput} for command's `response` shape. + * @see {@link ServiceCatalogClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeProvisioningArtifactCommand extends $Command< DescribeProvisioningArtifactCommandInput, diff --git a/clients/client-service-catalog/commands/DescribeProvisioningParametersCommand.ts b/clients/client-service-catalog/commands/DescribeProvisioningParametersCommand.ts index e16fe1aa22cc..ca40fad12a52 100644 --- a/clients/client-service-catalog/commands/DescribeProvisioningParametersCommand.ts +++ b/clients/client-service-catalog/commands/DescribeProvisioningParametersCommand.ts @@ -31,6 +31,20 @@ export interface DescribeProvisioningParametersCommandOutput * 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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ServiceCatalogClient, DescribeProvisioningParametersCommand } from "@aws-sdk/client-service-catalog"; // ES Modules import + * // const { ServiceCatalogClient, DescribeProvisioningParametersCommand } = require("@aws-sdk/client-service-catalog"); // CommonJS import + * const client = new ServiceCatalogClient(config); + * const command = new DescribeProvisioningParametersCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeProvisioningParametersCommandInput} for command's `input` shape. + * @see {@link DescribeProvisioningParametersCommandOutput} for command's `response` shape. + * @see {@link ServiceCatalogClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeProvisioningParametersCommand extends $Command< DescribeProvisioningParametersCommandInput, diff --git a/clients/client-service-catalog/commands/DescribeRecordCommand.ts b/clients/client-service-catalog/commands/DescribeRecordCommand.ts index c66b58e38658..4ad35ea98a7c 100644 --- a/clients/client-service-catalog/commands/DescribeRecordCommand.ts +++ b/clients/client-service-catalog/commands/DescribeRecordCommand.ts @@ -30,6 +30,20 @@ export interface DescribeRecordCommandOutput extends DescribeRecordOutput, __Met * 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.

* + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ServiceCatalogClient, DescribeRecordCommand } from "@aws-sdk/client-service-catalog"; // ES Modules import + * // const { ServiceCatalogClient, DescribeRecordCommand } = require("@aws-sdk/client-service-catalog"); // CommonJS import + * const client = new ServiceCatalogClient(config); + * const command = new DescribeRecordCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeRecordCommandInput} for command's `input` shape. + * @see {@link DescribeRecordCommandOutput} for command's `response` shape. + * @see {@link ServiceCatalogClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeRecordCommand extends $Command< DescribeRecordCommandInput, diff --git a/clients/client-service-catalog/commands/DescribeServiceActionCommand.ts b/clients/client-service-catalog/commands/DescribeServiceActionCommand.ts index 74c1c909ee6a..8e046fbef07b 100644 --- a/clients/client-service-catalog/commands/DescribeServiceActionCommand.ts +++ b/clients/client-service-catalog/commands/DescribeServiceActionCommand.ts @@ -22,6 +22,20 @@ export interface DescribeServiceActionCommandOutput extends DescribeServiceActio /** *

Describes a self-service action.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ServiceCatalogClient, DescribeServiceActionCommand } from "@aws-sdk/client-service-catalog"; // ES Modules import + * // const { ServiceCatalogClient, DescribeServiceActionCommand } = require("@aws-sdk/client-service-catalog"); // CommonJS import + * const client = new ServiceCatalogClient(config); + * const command = new DescribeServiceActionCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeServiceActionCommandInput} for command's `input` shape. + * @see {@link DescribeServiceActionCommandOutput} for command's `response` shape. + * @see {@link ServiceCatalogClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeServiceActionCommand extends $Command< DescribeServiceActionCommandInput, diff --git a/clients/client-service-catalog/commands/DescribeServiceActionExecutionParametersCommand.ts b/clients/client-service-catalog/commands/DescribeServiceActionExecutionParametersCommand.ts index af1399dfdef0..ff47ee84dc14 100644 --- a/clients/client-service-catalog/commands/DescribeServiceActionExecutionParametersCommand.ts +++ b/clients/client-service-catalog/commands/DescribeServiceActionExecutionParametersCommand.ts @@ -28,6 +28,20 @@ export interface DescribeServiceActionExecutionParametersCommandOutput /** *

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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ServiceCatalogClient, DescribeServiceActionExecutionParametersCommand } from "@aws-sdk/client-service-catalog"; // ES Modules import + * // const { ServiceCatalogClient, DescribeServiceActionExecutionParametersCommand } = require("@aws-sdk/client-service-catalog"); // CommonJS import + * const client = new ServiceCatalogClient(config); + * const command = new DescribeServiceActionExecutionParametersCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeServiceActionExecutionParametersCommandInput} for command's `input` shape. + * @see {@link DescribeServiceActionExecutionParametersCommandOutput} for command's `response` shape. + * @see {@link ServiceCatalogClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeServiceActionExecutionParametersCommand extends $Command< DescribeServiceActionExecutionParametersCommandInput, diff --git a/clients/client-service-catalog/commands/DescribeTagOptionCommand.ts b/clients/client-service-catalog/commands/DescribeTagOptionCommand.ts index af70ab15df39..832396ee3aec 100644 --- a/clients/client-service-catalog/commands/DescribeTagOptionCommand.ts +++ b/clients/client-service-catalog/commands/DescribeTagOptionCommand.ts @@ -22,6 +22,20 @@ export interface DescribeTagOptionCommandOutput extends DescribeTagOptionOutput, /** *

Gets information about the specified TagOption.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ServiceCatalogClient, DescribeTagOptionCommand } from "@aws-sdk/client-service-catalog"; // ES Modules import + * // const { ServiceCatalogClient, DescribeTagOptionCommand } = require("@aws-sdk/client-service-catalog"); // CommonJS import + * const client = new ServiceCatalogClient(config); + * const command = new DescribeTagOptionCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeTagOptionCommandInput} for command's `input` shape. + * @see {@link DescribeTagOptionCommandOutput} for command's `response` shape. + * @see {@link ServiceCatalogClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeTagOptionCommand extends $Command< DescribeTagOptionCommandInput, diff --git a/clients/client-service-catalog/commands/DisableAWSOrganizationsAccessCommand.ts b/clients/client-service-catalog/commands/DisableAWSOrganizationsAccessCommand.ts index 2889502e10f6..19e216331590 100644 --- a/clients/client-service-catalog/commands/DisableAWSOrganizationsAccessCommand.ts +++ b/clients/client-service-catalog/commands/DisableAWSOrganizationsAccessCommand.ts @@ -30,6 +30,20 @@ export interface DisableAWSOrganizationsAccessCommandOutput * the organization.

*

This API can't be invoked if there are active delegated administrators in the organization.

*

Note that a delegated administrator is not authorized to invoke DisableAWSOrganizationsAccess.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ServiceCatalogClient, DisableAWSOrganizationsAccessCommand } from "@aws-sdk/client-service-catalog"; // ES Modules import + * // const { ServiceCatalogClient, DisableAWSOrganizationsAccessCommand } = require("@aws-sdk/client-service-catalog"); // CommonJS import + * const client = new ServiceCatalogClient(config); + * const command = new DisableAWSOrganizationsAccessCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DisableAWSOrganizationsAccessCommandInput} for command's `input` shape. + * @see {@link DisableAWSOrganizationsAccessCommandOutput} for command's `response` shape. + * @see {@link ServiceCatalogClientResolvedConfig | config} for command's `input` shape. + * */ export class DisableAWSOrganizationsAccessCommand extends $Command< DisableAWSOrganizationsAccessCommandInput, diff --git a/clients/client-service-catalog/commands/DisassociateBudgetFromResourceCommand.ts b/clients/client-service-catalog/commands/DisassociateBudgetFromResourceCommand.ts index 2e1819bd0735..238f706c8bbf 100644 --- a/clients/client-service-catalog/commands/DisassociateBudgetFromResourceCommand.ts +++ b/clients/client-service-catalog/commands/DisassociateBudgetFromResourceCommand.ts @@ -24,6 +24,20 @@ export interface DisassociateBudgetFromResourceCommandOutput /** *

Disassociates the specified budget from the specified resource.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ServiceCatalogClient, DisassociateBudgetFromResourceCommand } from "@aws-sdk/client-service-catalog"; // ES Modules import + * // const { ServiceCatalogClient, DisassociateBudgetFromResourceCommand } = require("@aws-sdk/client-service-catalog"); // CommonJS import + * const client = new ServiceCatalogClient(config); + * const command = new DisassociateBudgetFromResourceCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DisassociateBudgetFromResourceCommandInput} for command's `input` shape. + * @see {@link DisassociateBudgetFromResourceCommandOutput} for command's `response` shape. + * @see {@link ServiceCatalogClientResolvedConfig | config} for command's `input` shape. + * */ export class DisassociateBudgetFromResourceCommand extends $Command< DisassociateBudgetFromResourceCommandInput, diff --git a/clients/client-service-catalog/commands/DisassociatePrincipalFromPortfolioCommand.ts b/clients/client-service-catalog/commands/DisassociatePrincipalFromPortfolioCommand.ts index 13584413e75c..f9c995a476d0 100644 --- a/clients/client-service-catalog/commands/DisassociatePrincipalFromPortfolioCommand.ts +++ b/clients/client-service-catalog/commands/DisassociatePrincipalFromPortfolioCommand.ts @@ -25,6 +25,20 @@ export interface DisassociatePrincipalFromPortfolioCommandOutput /** *

Disassociates a previously associated principal ARN from a specified * portfolio.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ServiceCatalogClient, DisassociatePrincipalFromPortfolioCommand } from "@aws-sdk/client-service-catalog"; // ES Modules import + * // const { ServiceCatalogClient, DisassociatePrincipalFromPortfolioCommand } = require("@aws-sdk/client-service-catalog"); // CommonJS import + * const client = new ServiceCatalogClient(config); + * const command = new DisassociatePrincipalFromPortfolioCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DisassociatePrincipalFromPortfolioCommandInput} for command's `input` shape. + * @see {@link DisassociatePrincipalFromPortfolioCommandOutput} for command's `response` shape. + * @see {@link ServiceCatalogClientResolvedConfig | config} for command's `input` shape. + * */ export class DisassociatePrincipalFromPortfolioCommand extends $Command< DisassociatePrincipalFromPortfolioCommandInput, diff --git a/clients/client-service-catalog/commands/DisassociateProductFromPortfolioCommand.ts b/clients/client-service-catalog/commands/DisassociateProductFromPortfolioCommand.ts index 3be1d411d05f..95beac8951b3 100644 --- a/clients/client-service-catalog/commands/DisassociateProductFromPortfolioCommand.ts +++ b/clients/client-service-catalog/commands/DisassociateProductFromPortfolioCommand.ts @@ -25,6 +25,20 @@ export interface DisassociateProductFromPortfolioCommandOutput /** *

Disassociates the specified product from the specified portfolio.

*

A delegated admin is authorized to invoke this command.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ServiceCatalogClient, DisassociateProductFromPortfolioCommand } from "@aws-sdk/client-service-catalog"; // ES Modules import + * // const { ServiceCatalogClient, DisassociateProductFromPortfolioCommand } = require("@aws-sdk/client-service-catalog"); // CommonJS import + * const client = new ServiceCatalogClient(config); + * const command = new DisassociateProductFromPortfolioCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DisassociateProductFromPortfolioCommandInput} for command's `input` shape. + * @see {@link DisassociateProductFromPortfolioCommandOutput} for command's `response` shape. + * @see {@link ServiceCatalogClientResolvedConfig | config} for command's `input` shape. + * */ export class DisassociateProductFromPortfolioCommand extends $Command< DisassociateProductFromPortfolioCommandInput, diff --git a/clients/client-service-catalog/commands/DisassociateServiceActionFromProvisioningArtifactCommand.ts b/clients/client-service-catalog/commands/DisassociateServiceActionFromProvisioningArtifactCommand.ts index b63aa430dd62..aaf33c9d4ef3 100644 --- a/clients/client-service-catalog/commands/DisassociateServiceActionFromProvisioningArtifactCommand.ts +++ b/clients/client-service-catalog/commands/DisassociateServiceActionFromProvisioningArtifactCommand.ts @@ -28,6 +28,20 @@ export interface DisassociateServiceActionFromProvisioningArtifactCommandOutput /** *

Disassociates the specified self-service action association from the specified provisioning artifact.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ServiceCatalogClient, DisassociateServiceActionFromProvisioningArtifactCommand } from "@aws-sdk/client-service-catalog"; // ES Modules import + * // const { ServiceCatalogClient, DisassociateServiceActionFromProvisioningArtifactCommand } = require("@aws-sdk/client-service-catalog"); // CommonJS import + * const client = new ServiceCatalogClient(config); + * const command = new DisassociateServiceActionFromProvisioningArtifactCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DisassociateServiceActionFromProvisioningArtifactCommandInput} for command's `input` shape. + * @see {@link DisassociateServiceActionFromProvisioningArtifactCommandOutput} for command's `response` shape. + * @see {@link ServiceCatalogClientResolvedConfig | config} for command's `input` shape. + * */ export class DisassociateServiceActionFromProvisioningArtifactCommand extends $Command< DisassociateServiceActionFromProvisioningArtifactCommandInput, diff --git a/clients/client-service-catalog/commands/DisassociateTagOptionFromResourceCommand.ts b/clients/client-service-catalog/commands/DisassociateTagOptionFromResourceCommand.ts index a7fb3efc8ba2..82b53bb1a1ca 100644 --- a/clients/client-service-catalog/commands/DisassociateTagOptionFromResourceCommand.ts +++ b/clients/client-service-catalog/commands/DisassociateTagOptionFromResourceCommand.ts @@ -24,6 +24,20 @@ export interface DisassociateTagOptionFromResourceCommandOutput /** *

Disassociates the specified TagOption from the specified resource.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ServiceCatalogClient, DisassociateTagOptionFromResourceCommand } from "@aws-sdk/client-service-catalog"; // ES Modules import + * // const { ServiceCatalogClient, DisassociateTagOptionFromResourceCommand } = require("@aws-sdk/client-service-catalog"); // CommonJS import + * const client = new ServiceCatalogClient(config); + * const command = new DisassociateTagOptionFromResourceCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DisassociateTagOptionFromResourceCommandInput} for command's `input` shape. + * @see {@link DisassociateTagOptionFromResourceCommandOutput} for command's `response` shape. + * @see {@link ServiceCatalogClientResolvedConfig | config} for command's `input` shape. + * */ export class DisassociateTagOptionFromResourceCommand extends $Command< DisassociateTagOptionFromResourceCommandInput, diff --git a/clients/client-service-catalog/commands/EnableAWSOrganizationsAccessCommand.ts b/clients/client-service-catalog/commands/EnableAWSOrganizationsAccessCommand.ts index 3d539bc04d73..c1fb1adf8250 100644 --- a/clients/client-service-catalog/commands/EnableAWSOrganizationsAccessCommand.ts +++ b/clients/client-service-catalog/commands/EnableAWSOrganizationsAccessCommand.ts @@ -29,6 +29,20 @@ export interface EnableAWSOrganizationsAccessCommandOutput * organization.

*

By calling this API Service Catalog will make a call to organizations:EnableAWSServiceAccess on your behalf so that your shares can be in sync with any changes in your AWS Organizations structure.

*

Note that a delegated administrator is not authorized to invoke EnableAWSOrganizationsAccess.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ServiceCatalogClient, EnableAWSOrganizationsAccessCommand } from "@aws-sdk/client-service-catalog"; // ES Modules import + * // const { ServiceCatalogClient, EnableAWSOrganizationsAccessCommand } = require("@aws-sdk/client-service-catalog"); // CommonJS import + * const client = new ServiceCatalogClient(config); + * const command = new EnableAWSOrganizationsAccessCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link EnableAWSOrganizationsAccessCommandInput} for command's `input` shape. + * @see {@link EnableAWSOrganizationsAccessCommandOutput} for command's `response` shape. + * @see {@link ServiceCatalogClientResolvedConfig | config} for command's `input` shape. + * */ export class EnableAWSOrganizationsAccessCommand extends $Command< EnableAWSOrganizationsAccessCommandInput, diff --git a/clients/client-service-catalog/commands/ExecuteProvisionedProductPlanCommand.ts b/clients/client-service-catalog/commands/ExecuteProvisionedProductPlanCommand.ts index 3b746f00100d..c05724040e14 100644 --- a/clients/client-service-catalog/commands/ExecuteProvisionedProductPlanCommand.ts +++ b/clients/client-service-catalog/commands/ExecuteProvisionedProductPlanCommand.ts @@ -24,6 +24,20 @@ export interface ExecuteProvisionedProductPlanCommandOutput /** *

Provisions or modifies a product based on the resource changes for the specified plan.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ServiceCatalogClient, ExecuteProvisionedProductPlanCommand } from "@aws-sdk/client-service-catalog"; // ES Modules import + * // const { ServiceCatalogClient, ExecuteProvisionedProductPlanCommand } = require("@aws-sdk/client-service-catalog"); // CommonJS import + * const client = new ServiceCatalogClient(config); + * const command = new ExecuteProvisionedProductPlanCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ExecuteProvisionedProductPlanCommandInput} for command's `input` shape. + * @see {@link ExecuteProvisionedProductPlanCommandOutput} for command's `response` shape. + * @see {@link ServiceCatalogClientResolvedConfig | config} for command's `input` shape. + * */ export class ExecuteProvisionedProductPlanCommand extends $Command< ExecuteProvisionedProductPlanCommandInput, diff --git a/clients/client-service-catalog/commands/ExecuteProvisionedProductServiceActionCommand.ts b/clients/client-service-catalog/commands/ExecuteProvisionedProductServiceActionCommand.ts index a479aa9c6c9b..4c4a373421a8 100644 --- a/clients/client-service-catalog/commands/ExecuteProvisionedProductServiceActionCommand.ts +++ b/clients/client-service-catalog/commands/ExecuteProvisionedProductServiceActionCommand.ts @@ -28,6 +28,20 @@ export interface ExecuteProvisionedProductServiceActionCommandOutput /** *

Executes a self-service action against a provisioned product.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ServiceCatalogClient, ExecuteProvisionedProductServiceActionCommand } from "@aws-sdk/client-service-catalog"; // ES Modules import + * // const { ServiceCatalogClient, ExecuteProvisionedProductServiceActionCommand } = require("@aws-sdk/client-service-catalog"); // CommonJS import + * const client = new ServiceCatalogClient(config); + * const command = new ExecuteProvisionedProductServiceActionCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ExecuteProvisionedProductServiceActionCommandInput} for command's `input` shape. + * @see {@link ExecuteProvisionedProductServiceActionCommandOutput} for command's `response` shape. + * @see {@link ServiceCatalogClientResolvedConfig | config} for command's `input` shape. + * */ export class ExecuteProvisionedProductServiceActionCommand extends $Command< ExecuteProvisionedProductServiceActionCommandInput, diff --git a/clients/client-service-catalog/commands/GetAWSOrganizationsAccessStatusCommand.ts b/clients/client-service-catalog/commands/GetAWSOrganizationsAccessStatusCommand.ts index d10b06ef2d6b..5d40a8ff9558 100644 --- a/clients/client-service-catalog/commands/GetAWSOrganizationsAccessStatusCommand.ts +++ b/clients/client-service-catalog/commands/GetAWSOrganizationsAccessStatusCommand.ts @@ -25,6 +25,20 @@ export interface GetAWSOrganizationsAccessStatusCommandOutput /** *

Get the Access Status for AWS Organization portfolio share feature. This API can only be * called by the management account in the organization or by a delegated admin.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ServiceCatalogClient, GetAWSOrganizationsAccessStatusCommand } from "@aws-sdk/client-service-catalog"; // ES Modules import + * // const { ServiceCatalogClient, GetAWSOrganizationsAccessStatusCommand } = require("@aws-sdk/client-service-catalog"); // CommonJS import + * const client = new ServiceCatalogClient(config); + * const command = new GetAWSOrganizationsAccessStatusCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetAWSOrganizationsAccessStatusCommandInput} for command's `input` shape. + * @see {@link GetAWSOrganizationsAccessStatusCommandOutput} for command's `response` shape. + * @see {@link ServiceCatalogClientResolvedConfig | config} for command's `input` shape. + * */ export class GetAWSOrganizationsAccessStatusCommand extends $Command< GetAWSOrganizationsAccessStatusCommandInput, diff --git a/clients/client-service-catalog/commands/GetProvisionedProductOutputsCommand.ts b/clients/client-service-catalog/commands/GetProvisionedProductOutputsCommand.ts index 2dced03411aa..5a9b0ad7f570 100644 --- a/clients/client-service-catalog/commands/GetProvisionedProductOutputsCommand.ts +++ b/clients/client-service-catalog/commands/GetProvisionedProductOutputsCommand.ts @@ -24,6 +24,20 @@ export interface GetProvisionedProductOutputsCommandOutput /** *

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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ServiceCatalogClient, GetProvisionedProductOutputsCommand } from "@aws-sdk/client-service-catalog"; // ES Modules import + * // const { ServiceCatalogClient, GetProvisionedProductOutputsCommand } = require("@aws-sdk/client-service-catalog"); // CommonJS import + * const client = new ServiceCatalogClient(config); + * const command = new GetProvisionedProductOutputsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetProvisionedProductOutputsCommandInput} for command's `input` shape. + * @see {@link GetProvisionedProductOutputsCommandOutput} for command's `response` shape. + * @see {@link ServiceCatalogClientResolvedConfig | config} for command's `input` shape. + * */ export class GetProvisionedProductOutputsCommand extends $Command< GetProvisionedProductOutputsCommandInput, diff --git a/clients/client-service-catalog/commands/ImportAsProvisionedProductCommand.ts b/clients/client-service-catalog/commands/ImportAsProvisionedProductCommand.ts index e72a23bc8228..4ec4bc44d398 100644 --- a/clients/client-service-catalog/commands/ImportAsProvisionedProductCommand.ts +++ b/clients/client-service-catalog/commands/ImportAsProvisionedProductCommand.ts @@ -35,6 +35,20 @@ export interface ImportAsProvisionedProductCommandOutput extends ImportAsProvisi * *

The user or role that performs this operation must have the cloudformation:GetTemplate * and cloudformation:DescribeStacks IAM policy permissions.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ServiceCatalogClient, ImportAsProvisionedProductCommand } from "@aws-sdk/client-service-catalog"; // ES Modules import + * // const { ServiceCatalogClient, ImportAsProvisionedProductCommand } = require("@aws-sdk/client-service-catalog"); // CommonJS import + * const client = new ServiceCatalogClient(config); + * const command = new ImportAsProvisionedProductCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ImportAsProvisionedProductCommandInput} for command's `input` shape. + * @see {@link ImportAsProvisionedProductCommandOutput} for command's `response` shape. + * @see {@link ServiceCatalogClientResolvedConfig | config} for command's `input` shape. + * */ export class ImportAsProvisionedProductCommand extends $Command< ImportAsProvisionedProductCommandInput, diff --git a/clients/client-service-catalog/commands/ListAcceptedPortfolioSharesCommand.ts b/clients/client-service-catalog/commands/ListAcceptedPortfolioSharesCommand.ts index 0247b44a98d4..effc415304ee 100644 --- a/clients/client-service-catalog/commands/ListAcceptedPortfolioSharesCommand.ts +++ b/clients/client-service-catalog/commands/ListAcceptedPortfolioSharesCommand.ts @@ -22,6 +22,20 @@ export interface ListAcceptedPortfolioSharesCommandOutput extends ListAcceptedPo /** *

Lists all portfolios for which sharing was accepted by this account.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ServiceCatalogClient, ListAcceptedPortfolioSharesCommand } from "@aws-sdk/client-service-catalog"; // ES Modules import + * // const { ServiceCatalogClient, ListAcceptedPortfolioSharesCommand } = require("@aws-sdk/client-service-catalog"); // CommonJS import + * const client = new ServiceCatalogClient(config); + * const command = new ListAcceptedPortfolioSharesCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListAcceptedPortfolioSharesCommandInput} for command's `input` shape. + * @see {@link ListAcceptedPortfolioSharesCommandOutput} for command's `response` shape. + * @see {@link ServiceCatalogClientResolvedConfig | config} for command's `input` shape. + * */ export class ListAcceptedPortfolioSharesCommand extends $Command< ListAcceptedPortfolioSharesCommandInput, diff --git a/clients/client-service-catalog/commands/ListBudgetsForResourceCommand.ts b/clients/client-service-catalog/commands/ListBudgetsForResourceCommand.ts index b9be824e0f3f..922cf7ea4c7f 100644 --- a/clients/client-service-catalog/commands/ListBudgetsForResourceCommand.ts +++ b/clients/client-service-catalog/commands/ListBudgetsForResourceCommand.ts @@ -22,6 +22,20 @@ export interface ListBudgetsForResourceCommandOutput extends ListBudgetsForResou /** *

Lists all the budgets associated to the specified resource.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ServiceCatalogClient, ListBudgetsForResourceCommand } from "@aws-sdk/client-service-catalog"; // ES Modules import + * // const { ServiceCatalogClient, ListBudgetsForResourceCommand } = require("@aws-sdk/client-service-catalog"); // CommonJS import + * const client = new ServiceCatalogClient(config); + * const command = new ListBudgetsForResourceCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListBudgetsForResourceCommandInput} for command's `input` shape. + * @see {@link ListBudgetsForResourceCommandOutput} for command's `response` shape. + * @see {@link ServiceCatalogClientResolvedConfig | config} for command's `input` shape. + * */ export class ListBudgetsForResourceCommand extends $Command< ListBudgetsForResourceCommandInput, diff --git a/clients/client-service-catalog/commands/ListConstraintsForPortfolioCommand.ts b/clients/client-service-catalog/commands/ListConstraintsForPortfolioCommand.ts index 70f25f29ea12..2ea70219b440 100644 --- a/clients/client-service-catalog/commands/ListConstraintsForPortfolioCommand.ts +++ b/clients/client-service-catalog/commands/ListConstraintsForPortfolioCommand.ts @@ -22,6 +22,20 @@ export interface ListConstraintsForPortfolioCommandOutput extends ListConstraint /** *

Lists the constraints for the specified portfolio and product.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ServiceCatalogClient, ListConstraintsForPortfolioCommand } from "@aws-sdk/client-service-catalog"; // ES Modules import + * // const { ServiceCatalogClient, ListConstraintsForPortfolioCommand } = require("@aws-sdk/client-service-catalog"); // CommonJS import + * const client = new ServiceCatalogClient(config); + * const command = new ListConstraintsForPortfolioCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListConstraintsForPortfolioCommandInput} for command's `input` shape. + * @see {@link ListConstraintsForPortfolioCommandOutput} for command's `response` shape. + * @see {@link ServiceCatalogClientResolvedConfig | config} for command's `input` shape. + * */ export class ListConstraintsForPortfolioCommand extends $Command< ListConstraintsForPortfolioCommandInput, diff --git a/clients/client-service-catalog/commands/ListLaunchPathsCommand.ts b/clients/client-service-catalog/commands/ListLaunchPathsCommand.ts index 0451d3e4ae0a..1ebf8d5a31ee 100644 --- a/clients/client-service-catalog/commands/ListLaunchPathsCommand.ts +++ b/clients/client-service-catalog/commands/ListLaunchPathsCommand.ts @@ -24,6 +24,20 @@ export interface ListLaunchPathsCommandOutput extends ListLaunchPathsOutput, __M *

Lists the paths to the specified product. A path is how the user * has access to a specified product, and is necessary when provisioning a product. A path * also determines the constraints put on the product.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ServiceCatalogClient, ListLaunchPathsCommand } from "@aws-sdk/client-service-catalog"; // ES Modules import + * // const { ServiceCatalogClient, ListLaunchPathsCommand } = require("@aws-sdk/client-service-catalog"); // CommonJS import + * const client = new ServiceCatalogClient(config); + * const command = new ListLaunchPathsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListLaunchPathsCommandInput} for command's `input` shape. + * @see {@link ListLaunchPathsCommandOutput} for command's `response` shape. + * @see {@link ServiceCatalogClientResolvedConfig | config} for command's `input` shape. + * */ export class ListLaunchPathsCommand extends $Command< ListLaunchPathsCommandInput, diff --git a/clients/client-service-catalog/commands/ListOrganizationPortfolioAccessCommand.ts b/clients/client-service-catalog/commands/ListOrganizationPortfolioAccessCommand.ts index 87f269bd9266..d657ff963b16 100644 --- a/clients/client-service-catalog/commands/ListOrganizationPortfolioAccessCommand.ts +++ b/clients/client-service-catalog/commands/ListOrganizationPortfolioAccessCommand.ts @@ -27,6 +27,20 @@ export interface ListOrganizationPortfolioAccessCommandOutput * 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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ServiceCatalogClient, ListOrganizationPortfolioAccessCommand } from "@aws-sdk/client-service-catalog"; // ES Modules import + * // const { ServiceCatalogClient, ListOrganizationPortfolioAccessCommand } = require("@aws-sdk/client-service-catalog"); // CommonJS import + * const client = new ServiceCatalogClient(config); + * const command = new ListOrganizationPortfolioAccessCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListOrganizationPortfolioAccessCommandInput} for command's `input` shape. + * @see {@link ListOrganizationPortfolioAccessCommandOutput} for command's `response` shape. + * @see {@link ServiceCatalogClientResolvedConfig | config} for command's `input` shape. + * */ export class ListOrganizationPortfolioAccessCommand extends $Command< ListOrganizationPortfolioAccessCommandInput, diff --git a/clients/client-service-catalog/commands/ListPortfolioAccessCommand.ts b/clients/client-service-catalog/commands/ListPortfolioAccessCommand.ts index a35539f74edc..3ec9eec94f51 100644 --- a/clients/client-service-catalog/commands/ListPortfolioAccessCommand.ts +++ b/clients/client-service-catalog/commands/ListPortfolioAccessCommand.ts @@ -23,6 +23,20 @@ export interface ListPortfolioAccessCommandOutput extends ListPortfolioAccessOut /** *

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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ServiceCatalogClient, ListPortfolioAccessCommand } from "@aws-sdk/client-service-catalog"; // ES Modules import + * // const { ServiceCatalogClient, ListPortfolioAccessCommand } = require("@aws-sdk/client-service-catalog"); // CommonJS import + * const client = new ServiceCatalogClient(config); + * const command = new ListPortfolioAccessCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListPortfolioAccessCommandInput} for command's `input` shape. + * @see {@link ListPortfolioAccessCommandOutput} for command's `response` shape. + * @see {@link ServiceCatalogClientResolvedConfig | config} for command's `input` shape. + * */ export class ListPortfolioAccessCommand extends $Command< ListPortfolioAccessCommandInput, diff --git a/clients/client-service-catalog/commands/ListPortfoliosCommand.ts b/clients/client-service-catalog/commands/ListPortfoliosCommand.ts index 8e5b83a23165..79477a62e98c 100644 --- a/clients/client-service-catalog/commands/ListPortfoliosCommand.ts +++ b/clients/client-service-catalog/commands/ListPortfoliosCommand.ts @@ -22,6 +22,20 @@ export interface ListPortfoliosCommandOutput extends ListPortfoliosOutput, __Met /** *

Lists all portfolios in the catalog.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ServiceCatalogClient, ListPortfoliosCommand } from "@aws-sdk/client-service-catalog"; // ES Modules import + * // const { ServiceCatalogClient, ListPortfoliosCommand } = require("@aws-sdk/client-service-catalog"); // CommonJS import + * const client = new ServiceCatalogClient(config); + * const command = new ListPortfoliosCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListPortfoliosCommandInput} for command's `input` shape. + * @see {@link ListPortfoliosCommandOutput} for command's `response` shape. + * @see {@link ServiceCatalogClientResolvedConfig | config} for command's `input` shape. + * */ export class ListPortfoliosCommand extends $Command< ListPortfoliosCommandInput, diff --git a/clients/client-service-catalog/commands/ListPortfoliosForProductCommand.ts b/clients/client-service-catalog/commands/ListPortfoliosForProductCommand.ts index 4a53e24e909b..3fc08de4d26c 100644 --- a/clients/client-service-catalog/commands/ListPortfoliosForProductCommand.ts +++ b/clients/client-service-catalog/commands/ListPortfoliosForProductCommand.ts @@ -22,6 +22,20 @@ export interface ListPortfoliosForProductCommandOutput extends ListPortfoliosFor /** *

Lists all portfolios that the specified product is associated with.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ServiceCatalogClient, ListPortfoliosForProductCommand } from "@aws-sdk/client-service-catalog"; // ES Modules import + * // const { ServiceCatalogClient, ListPortfoliosForProductCommand } = require("@aws-sdk/client-service-catalog"); // CommonJS import + * const client = new ServiceCatalogClient(config); + * const command = new ListPortfoliosForProductCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListPortfoliosForProductCommandInput} for command's `input` shape. + * @see {@link ListPortfoliosForProductCommandOutput} for command's `response` shape. + * @see {@link ServiceCatalogClientResolvedConfig | config} for command's `input` shape. + * */ export class ListPortfoliosForProductCommand extends $Command< ListPortfoliosForProductCommandInput, diff --git a/clients/client-service-catalog/commands/ListPrincipalsForPortfolioCommand.ts b/clients/client-service-catalog/commands/ListPrincipalsForPortfolioCommand.ts index 5413fc18b1d2..6a9ea2f885cd 100644 --- a/clients/client-service-catalog/commands/ListPrincipalsForPortfolioCommand.ts +++ b/clients/client-service-catalog/commands/ListPrincipalsForPortfolioCommand.ts @@ -22,6 +22,20 @@ export interface ListPrincipalsForPortfolioCommandOutput extends ListPrincipalsF /** *

Lists all principal ARNs associated with the specified portfolio.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ServiceCatalogClient, ListPrincipalsForPortfolioCommand } from "@aws-sdk/client-service-catalog"; // ES Modules import + * // const { ServiceCatalogClient, ListPrincipalsForPortfolioCommand } = require("@aws-sdk/client-service-catalog"); // CommonJS import + * const client = new ServiceCatalogClient(config); + * const command = new ListPrincipalsForPortfolioCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListPrincipalsForPortfolioCommandInput} for command's `input` shape. + * @see {@link ListPrincipalsForPortfolioCommandOutput} for command's `response` shape. + * @see {@link ServiceCatalogClientResolvedConfig | config} for command's `input` shape. + * */ export class ListPrincipalsForPortfolioCommand extends $Command< ListPrincipalsForPortfolioCommandInput, diff --git a/clients/client-service-catalog/commands/ListProvisionedProductPlansCommand.ts b/clients/client-service-catalog/commands/ListProvisionedProductPlansCommand.ts index 351a2d9d20c1..50050d59fcb5 100644 --- a/clients/client-service-catalog/commands/ListProvisionedProductPlansCommand.ts +++ b/clients/client-service-catalog/commands/ListProvisionedProductPlansCommand.ts @@ -22,6 +22,20 @@ export interface ListProvisionedProductPlansCommandOutput extends ListProvisione /** *

Lists the plans for the specified provisioned product or all plans to which the user has access.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ServiceCatalogClient, ListProvisionedProductPlansCommand } from "@aws-sdk/client-service-catalog"; // ES Modules import + * // const { ServiceCatalogClient, ListProvisionedProductPlansCommand } = require("@aws-sdk/client-service-catalog"); // CommonJS import + * const client = new ServiceCatalogClient(config); + * const command = new ListProvisionedProductPlansCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListProvisionedProductPlansCommandInput} for command's `input` shape. + * @see {@link ListProvisionedProductPlansCommandOutput} for command's `response` shape. + * @see {@link ServiceCatalogClientResolvedConfig | config} for command's `input` shape. + * */ export class ListProvisionedProductPlansCommand extends $Command< ListProvisionedProductPlansCommandInput, diff --git a/clients/client-service-catalog/commands/ListProvisioningArtifactsCommand.ts b/clients/client-service-catalog/commands/ListProvisioningArtifactsCommand.ts index 6829d1816cb1..c26411e2fdad 100644 --- a/clients/client-service-catalog/commands/ListProvisioningArtifactsCommand.ts +++ b/clients/client-service-catalog/commands/ListProvisioningArtifactsCommand.ts @@ -22,6 +22,20 @@ export interface ListProvisioningArtifactsCommandOutput extends ListProvisioning /** *

Lists all provisioning artifacts (also known as versions) for the specified product.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ServiceCatalogClient, ListProvisioningArtifactsCommand } from "@aws-sdk/client-service-catalog"; // ES Modules import + * // const { ServiceCatalogClient, ListProvisioningArtifactsCommand } = require("@aws-sdk/client-service-catalog"); // CommonJS import + * const client = new ServiceCatalogClient(config); + * const command = new ListProvisioningArtifactsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListProvisioningArtifactsCommandInput} for command's `input` shape. + * @see {@link ListProvisioningArtifactsCommandOutput} for command's `response` shape. + * @see {@link ServiceCatalogClientResolvedConfig | config} for command's `input` shape. + * */ export class ListProvisioningArtifactsCommand extends $Command< ListProvisioningArtifactsCommandInput, diff --git a/clients/client-service-catalog/commands/ListProvisioningArtifactsForServiceActionCommand.ts b/clients/client-service-catalog/commands/ListProvisioningArtifactsForServiceActionCommand.ts index 1e0286a50549..a5525c2019b0 100644 --- a/clients/client-service-catalog/commands/ListProvisioningArtifactsForServiceActionCommand.ts +++ b/clients/client-service-catalog/commands/ListProvisioningArtifactsForServiceActionCommand.ts @@ -28,6 +28,20 @@ export interface ListProvisioningArtifactsForServiceActionCommandOutput /** *

Lists all provisioning artifacts (also known as versions) for the specified self-service action.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ServiceCatalogClient, ListProvisioningArtifactsForServiceActionCommand } from "@aws-sdk/client-service-catalog"; // ES Modules import + * // const { ServiceCatalogClient, ListProvisioningArtifactsForServiceActionCommand } = require("@aws-sdk/client-service-catalog"); // CommonJS import + * const client = new ServiceCatalogClient(config); + * const command = new ListProvisioningArtifactsForServiceActionCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListProvisioningArtifactsForServiceActionCommandInput} for command's `input` shape. + * @see {@link ListProvisioningArtifactsForServiceActionCommandOutput} for command's `response` shape. + * @see {@link ServiceCatalogClientResolvedConfig | config} for command's `input` shape. + * */ export class ListProvisioningArtifactsForServiceActionCommand extends $Command< ListProvisioningArtifactsForServiceActionCommandInput, diff --git a/clients/client-service-catalog/commands/ListRecordHistoryCommand.ts b/clients/client-service-catalog/commands/ListRecordHistoryCommand.ts index 0ecd8eb6bfe3..3213f0d7b534 100644 --- a/clients/client-service-catalog/commands/ListRecordHistoryCommand.ts +++ b/clients/client-service-catalog/commands/ListRecordHistoryCommand.ts @@ -22,6 +22,20 @@ export interface ListRecordHistoryCommandOutput extends ListRecordHistoryOutput, /** *

Lists the specified requests or all performed requests.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ServiceCatalogClient, ListRecordHistoryCommand } from "@aws-sdk/client-service-catalog"; // ES Modules import + * // const { ServiceCatalogClient, ListRecordHistoryCommand } = require("@aws-sdk/client-service-catalog"); // CommonJS import + * const client = new ServiceCatalogClient(config); + * const command = new ListRecordHistoryCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListRecordHistoryCommandInput} for command's `input` shape. + * @see {@link ListRecordHistoryCommandOutput} for command's `response` shape. + * @see {@link ServiceCatalogClientResolvedConfig | config} for command's `input` shape. + * */ export class ListRecordHistoryCommand extends $Command< ListRecordHistoryCommandInput, diff --git a/clients/client-service-catalog/commands/ListResourcesForTagOptionCommand.ts b/clients/client-service-catalog/commands/ListResourcesForTagOptionCommand.ts index 5ee92bc1ce76..02e4cc4ec047 100644 --- a/clients/client-service-catalog/commands/ListResourcesForTagOptionCommand.ts +++ b/clients/client-service-catalog/commands/ListResourcesForTagOptionCommand.ts @@ -22,6 +22,20 @@ export interface ListResourcesForTagOptionCommandOutput extends ListResourcesFor /** *

Lists the resources associated with the specified TagOption.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ServiceCatalogClient, ListResourcesForTagOptionCommand } from "@aws-sdk/client-service-catalog"; // ES Modules import + * // const { ServiceCatalogClient, ListResourcesForTagOptionCommand } = require("@aws-sdk/client-service-catalog"); // CommonJS import + * const client = new ServiceCatalogClient(config); + * const command = new ListResourcesForTagOptionCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListResourcesForTagOptionCommandInput} for command's `input` shape. + * @see {@link ListResourcesForTagOptionCommandOutput} for command's `response` shape. + * @see {@link ServiceCatalogClientResolvedConfig | config} for command's `input` shape. + * */ export class ListResourcesForTagOptionCommand extends $Command< ListResourcesForTagOptionCommandInput, diff --git a/clients/client-service-catalog/commands/ListServiceActionsCommand.ts b/clients/client-service-catalog/commands/ListServiceActionsCommand.ts index 02bef8659d19..6d6cccfffd7d 100644 --- a/clients/client-service-catalog/commands/ListServiceActionsCommand.ts +++ b/clients/client-service-catalog/commands/ListServiceActionsCommand.ts @@ -22,6 +22,20 @@ export interface ListServiceActionsCommandOutput extends ListServiceActionsOutpu /** *

Lists all self-service actions.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ServiceCatalogClient, ListServiceActionsCommand } from "@aws-sdk/client-service-catalog"; // ES Modules import + * // const { ServiceCatalogClient, ListServiceActionsCommand } = require("@aws-sdk/client-service-catalog"); // CommonJS import + * const client = new ServiceCatalogClient(config); + * const command = new ListServiceActionsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListServiceActionsCommandInput} for command's `input` shape. + * @see {@link ListServiceActionsCommandOutput} for command's `response` shape. + * @see {@link ServiceCatalogClientResolvedConfig | config} for command's `input` shape. + * */ export class ListServiceActionsCommand extends $Command< ListServiceActionsCommandInput, diff --git a/clients/client-service-catalog/commands/ListServiceActionsForProvisioningArtifactCommand.ts b/clients/client-service-catalog/commands/ListServiceActionsForProvisioningArtifactCommand.ts index a90c4b7d1624..e3310c3583a0 100644 --- a/clients/client-service-catalog/commands/ListServiceActionsForProvisioningArtifactCommand.ts +++ b/clients/client-service-catalog/commands/ListServiceActionsForProvisioningArtifactCommand.ts @@ -28,6 +28,20 @@ export interface ListServiceActionsForProvisioningArtifactCommandOutput /** *

Returns a paginated list of self-service actions associated with the specified Product ID and Provisioning Artifact ID.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ServiceCatalogClient, ListServiceActionsForProvisioningArtifactCommand } from "@aws-sdk/client-service-catalog"; // ES Modules import + * // const { ServiceCatalogClient, ListServiceActionsForProvisioningArtifactCommand } = require("@aws-sdk/client-service-catalog"); // CommonJS import + * const client = new ServiceCatalogClient(config); + * const command = new ListServiceActionsForProvisioningArtifactCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListServiceActionsForProvisioningArtifactCommandInput} for command's `input` shape. + * @see {@link ListServiceActionsForProvisioningArtifactCommandOutput} for command's `response` shape. + * @see {@link ServiceCatalogClientResolvedConfig | config} for command's `input` shape. + * */ export class ListServiceActionsForProvisioningArtifactCommand extends $Command< ListServiceActionsForProvisioningArtifactCommandInput, diff --git a/clients/client-service-catalog/commands/ListStackInstancesForProvisionedProductCommand.ts b/clients/client-service-catalog/commands/ListStackInstancesForProvisionedProductCommand.ts index df1feffab018..a910de28bc45 100644 --- a/clients/client-service-catalog/commands/ListStackInstancesForProvisionedProductCommand.ts +++ b/clients/client-service-catalog/commands/ListStackInstancesForProvisionedProductCommand.ts @@ -28,6 +28,20 @@ export interface ListStackInstancesForProvisionedProductCommandOutput /** *

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 AWS account name or region.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ServiceCatalogClient, ListStackInstancesForProvisionedProductCommand } from "@aws-sdk/client-service-catalog"; // ES Modules import + * // const { ServiceCatalogClient, ListStackInstancesForProvisionedProductCommand } = require("@aws-sdk/client-service-catalog"); // CommonJS import + * const client = new ServiceCatalogClient(config); + * const command = new ListStackInstancesForProvisionedProductCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListStackInstancesForProvisionedProductCommandInput} for command's `input` shape. + * @see {@link ListStackInstancesForProvisionedProductCommandOutput} for command's `response` shape. + * @see {@link ServiceCatalogClientResolvedConfig | config} for command's `input` shape. + * */ export class ListStackInstancesForProvisionedProductCommand extends $Command< ListStackInstancesForProvisionedProductCommandInput, diff --git a/clients/client-service-catalog/commands/ListTagOptionsCommand.ts b/clients/client-service-catalog/commands/ListTagOptionsCommand.ts index 7fd4568834af..633fa8ce98b3 100644 --- a/clients/client-service-catalog/commands/ListTagOptionsCommand.ts +++ b/clients/client-service-catalog/commands/ListTagOptionsCommand.ts @@ -22,6 +22,20 @@ export interface ListTagOptionsCommandOutput extends ListTagOptionsOutput, __Met /** *

Lists the specified TagOptions or all TagOptions.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ServiceCatalogClient, ListTagOptionsCommand } from "@aws-sdk/client-service-catalog"; // ES Modules import + * // const { ServiceCatalogClient, ListTagOptionsCommand } = require("@aws-sdk/client-service-catalog"); // CommonJS import + * const client = new ServiceCatalogClient(config); + * const command = new ListTagOptionsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListTagOptionsCommandInput} for command's `input` shape. + * @see {@link ListTagOptionsCommandOutput} for command's `response` shape. + * @see {@link ServiceCatalogClientResolvedConfig | config} for command's `input` shape. + * */ export class ListTagOptionsCommand extends $Command< ListTagOptionsCommandInput, diff --git a/clients/client-service-catalog/commands/ProvisionProductCommand.ts b/clients/client-service-catalog/commands/ProvisionProductCommand.ts index fc430801a308..b9a63dfd10df 100644 --- a/clients/client-service-catalog/commands/ProvisionProductCommand.ts +++ b/clients/client-service-catalog/commands/ProvisionProductCommand.ts @@ -30,6 +30,20 @@ export interface ProvisionProductCommandOutput extends ProvisionProductOutput, _ * tag conflict for that key. Do not include conflicted keys as tags, or this causes * the error "Parameter validation failed: Missing required parameter in * Tags[N]:Value".

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ServiceCatalogClient, ProvisionProductCommand } from "@aws-sdk/client-service-catalog"; // ES Modules import + * // const { ServiceCatalogClient, ProvisionProductCommand } = require("@aws-sdk/client-service-catalog"); // CommonJS import + * const client = new ServiceCatalogClient(config); + * const command = new ProvisionProductCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ProvisionProductCommandInput} for command's `input` shape. + * @see {@link ProvisionProductCommandOutput} for command's `response` shape. + * @see {@link ServiceCatalogClientResolvedConfig | config} for command's `input` shape. + * */ export class ProvisionProductCommand extends $Command< ProvisionProductCommandInput, diff --git a/clients/client-service-catalog/commands/RejectPortfolioShareCommand.ts b/clients/client-service-catalog/commands/RejectPortfolioShareCommand.ts index 129bce63c33c..d3b2b05fe394 100644 --- a/clients/client-service-catalog/commands/RejectPortfolioShareCommand.ts +++ b/clients/client-service-catalog/commands/RejectPortfolioShareCommand.ts @@ -22,6 +22,20 @@ export interface RejectPortfolioShareCommandOutput extends RejectPortfolioShareO /** *

Rejects an offer to share the specified portfolio.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ServiceCatalogClient, RejectPortfolioShareCommand } from "@aws-sdk/client-service-catalog"; // ES Modules import + * // const { ServiceCatalogClient, RejectPortfolioShareCommand } = require("@aws-sdk/client-service-catalog"); // CommonJS import + * const client = new ServiceCatalogClient(config); + * const command = new RejectPortfolioShareCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link RejectPortfolioShareCommandInput} for command's `input` shape. + * @see {@link RejectPortfolioShareCommandOutput} for command's `response` shape. + * @see {@link ServiceCatalogClientResolvedConfig | config} for command's `input` shape. + * */ export class RejectPortfolioShareCommand extends $Command< RejectPortfolioShareCommandInput, diff --git a/clients/client-service-catalog/commands/ScanProvisionedProductsCommand.ts b/clients/client-service-catalog/commands/ScanProvisionedProductsCommand.ts index 7e9fdfac9796..68c5c39269ed 100644 --- a/clients/client-service-catalog/commands/ScanProvisionedProductsCommand.ts +++ b/clients/client-service-catalog/commands/ScanProvisionedProductsCommand.ts @@ -23,6 +23,20 @@ export interface ScanProvisionedProductsCommandOutput extends ScanProvisionedPro /** *

Lists the provisioned products that are available (not terminated).

*

To use additional filtering, see SearchProvisionedProducts.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ServiceCatalogClient, ScanProvisionedProductsCommand } from "@aws-sdk/client-service-catalog"; // ES Modules import + * // const { ServiceCatalogClient, ScanProvisionedProductsCommand } = require("@aws-sdk/client-service-catalog"); // CommonJS import + * const client = new ServiceCatalogClient(config); + * const command = new ScanProvisionedProductsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ScanProvisionedProductsCommandInput} for command's `input` shape. + * @see {@link ScanProvisionedProductsCommandOutput} for command's `response` shape. + * @see {@link ServiceCatalogClientResolvedConfig | config} for command's `input` shape. + * */ export class ScanProvisionedProductsCommand extends $Command< ScanProvisionedProductsCommandInput, diff --git a/clients/client-service-catalog/commands/SearchProductsAsAdminCommand.ts b/clients/client-service-catalog/commands/SearchProductsAsAdminCommand.ts index 156a960a8b7a..44a4d31abee8 100644 --- a/clients/client-service-catalog/commands/SearchProductsAsAdminCommand.ts +++ b/clients/client-service-catalog/commands/SearchProductsAsAdminCommand.ts @@ -22,6 +22,20 @@ export interface SearchProductsAsAdminCommandOutput extends SearchProductsAsAdmi /** *

Gets information about the products for the specified portfolio or all products.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ServiceCatalogClient, SearchProductsAsAdminCommand } from "@aws-sdk/client-service-catalog"; // ES Modules import + * // const { ServiceCatalogClient, SearchProductsAsAdminCommand } = require("@aws-sdk/client-service-catalog"); // CommonJS import + * const client = new ServiceCatalogClient(config); + * const command = new SearchProductsAsAdminCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link SearchProductsAsAdminCommandInput} for command's `input` shape. + * @see {@link SearchProductsAsAdminCommandOutput} for command's `response` shape. + * @see {@link ServiceCatalogClientResolvedConfig | config} for command's `input` shape. + * */ export class SearchProductsAsAdminCommand extends $Command< SearchProductsAsAdminCommandInput, diff --git a/clients/client-service-catalog/commands/SearchProductsCommand.ts b/clients/client-service-catalog/commands/SearchProductsCommand.ts index 6b4cd89d3a17..d4e0c4d9d37b 100644 --- a/clients/client-service-catalog/commands/SearchProductsCommand.ts +++ b/clients/client-service-catalog/commands/SearchProductsCommand.ts @@ -22,6 +22,20 @@ export interface SearchProductsCommandOutput extends SearchProductsOutput, __Met /** *

Gets information about the products to which the caller has access.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ServiceCatalogClient, SearchProductsCommand } from "@aws-sdk/client-service-catalog"; // ES Modules import + * // const { ServiceCatalogClient, SearchProductsCommand } = require("@aws-sdk/client-service-catalog"); // CommonJS import + * const client = new ServiceCatalogClient(config); + * const command = new SearchProductsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link SearchProductsCommandInput} for command's `input` shape. + * @see {@link SearchProductsCommandOutput} for command's `response` shape. + * @see {@link ServiceCatalogClientResolvedConfig | config} for command's `input` shape. + * */ export class SearchProductsCommand extends $Command< SearchProductsCommandInput, diff --git a/clients/client-service-catalog/commands/SearchProvisionedProductsCommand.ts b/clients/client-service-catalog/commands/SearchProvisionedProductsCommand.ts index 2cf8b6f20290..5bac86359429 100644 --- a/clients/client-service-catalog/commands/SearchProvisionedProductsCommand.ts +++ b/clients/client-service-catalog/commands/SearchProvisionedProductsCommand.ts @@ -22,6 +22,20 @@ export interface SearchProvisionedProductsCommandOutput extends SearchProvisione /** *

Gets information about the provisioned products that meet the specified criteria.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ServiceCatalogClient, SearchProvisionedProductsCommand } from "@aws-sdk/client-service-catalog"; // ES Modules import + * // const { ServiceCatalogClient, SearchProvisionedProductsCommand } = require("@aws-sdk/client-service-catalog"); // CommonJS import + * const client = new ServiceCatalogClient(config); + * const command = new SearchProvisionedProductsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link SearchProvisionedProductsCommandInput} for command's `input` shape. + * @see {@link SearchProvisionedProductsCommandOutput} for command's `response` shape. + * @see {@link ServiceCatalogClientResolvedConfig | config} for command's `input` shape. + * */ export class SearchProvisionedProductsCommand extends $Command< SearchProvisionedProductsCommandInput, diff --git a/clients/client-service-catalog/commands/TerminateProvisionedProductCommand.ts b/clients/client-service-catalog/commands/TerminateProvisionedProductCommand.ts index 854deb7606d2..fca4140e4732 100644 --- a/clients/client-service-catalog/commands/TerminateProvisionedProductCommand.ts +++ b/clients/client-service-catalog/commands/TerminateProvisionedProductCommand.ts @@ -24,6 +24,20 @@ export interface TerminateProvisionedProductCommandOutput extends TerminateProvi *

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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ServiceCatalogClient, TerminateProvisionedProductCommand } from "@aws-sdk/client-service-catalog"; // ES Modules import + * // const { ServiceCatalogClient, TerminateProvisionedProductCommand } = require("@aws-sdk/client-service-catalog"); // CommonJS import + * const client = new ServiceCatalogClient(config); + * const command = new TerminateProvisionedProductCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link TerminateProvisionedProductCommandInput} for command's `input` shape. + * @see {@link TerminateProvisionedProductCommandOutput} for command's `response` shape. + * @see {@link ServiceCatalogClientResolvedConfig | config} for command's `input` shape. + * */ export class TerminateProvisionedProductCommand extends $Command< TerminateProvisionedProductCommandInput, diff --git a/clients/client-service-catalog/commands/UpdateConstraintCommand.ts b/clients/client-service-catalog/commands/UpdateConstraintCommand.ts index 206f3de8b652..5ecb7c321995 100644 --- a/clients/client-service-catalog/commands/UpdateConstraintCommand.ts +++ b/clients/client-service-catalog/commands/UpdateConstraintCommand.ts @@ -22,6 +22,20 @@ export interface UpdateConstraintCommandOutput extends UpdateConstraintOutput, _ /** *

Updates the specified constraint.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ServiceCatalogClient, UpdateConstraintCommand } from "@aws-sdk/client-service-catalog"; // ES Modules import + * // const { ServiceCatalogClient, UpdateConstraintCommand } = require("@aws-sdk/client-service-catalog"); // CommonJS import + * const client = new ServiceCatalogClient(config); + * const command = new UpdateConstraintCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link UpdateConstraintCommandInput} for command's `input` shape. + * @see {@link UpdateConstraintCommandOutput} for command's `response` shape. + * @see {@link ServiceCatalogClientResolvedConfig | config} for command's `input` shape. + * */ export class UpdateConstraintCommand extends $Command< UpdateConstraintCommandInput, diff --git a/clients/client-service-catalog/commands/UpdatePortfolioCommand.ts b/clients/client-service-catalog/commands/UpdatePortfolioCommand.ts index 00cf6afbb2a7..a90909fef676 100644 --- a/clients/client-service-catalog/commands/UpdatePortfolioCommand.ts +++ b/clients/client-service-catalog/commands/UpdatePortfolioCommand.ts @@ -23,6 +23,20 @@ export interface UpdatePortfolioCommandOutput extends UpdatePortfolioOutput, __M /** *

Updates the specified portfolio.

*

You cannot update a product that was shared with you.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ServiceCatalogClient, UpdatePortfolioCommand } from "@aws-sdk/client-service-catalog"; // ES Modules import + * // const { ServiceCatalogClient, UpdatePortfolioCommand } = require("@aws-sdk/client-service-catalog"); // CommonJS import + * const client = new ServiceCatalogClient(config); + * const command = new UpdatePortfolioCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link UpdatePortfolioCommandInput} for command's `input` shape. + * @see {@link UpdatePortfolioCommandOutput} for command's `response` shape. + * @see {@link ServiceCatalogClientResolvedConfig | config} for command's `input` shape. + * */ export class UpdatePortfolioCommand extends $Command< UpdatePortfolioCommandInput, diff --git a/clients/client-service-catalog/commands/UpdatePortfolioShareCommand.ts b/clients/client-service-catalog/commands/UpdatePortfolioShareCommand.ts index 14694588d82a..346d56366d43 100644 --- a/clients/client-service-catalog/commands/UpdatePortfolioShareCommand.ts +++ b/clients/client-service-catalog/commands/UpdatePortfolioShareCommand.ts @@ -30,6 +30,20 @@ export interface UpdatePortfolioShareCommandOutput extends UpdatePortfolioShareO *

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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ServiceCatalogClient, UpdatePortfolioShareCommand } from "@aws-sdk/client-service-catalog"; // ES Modules import + * // const { ServiceCatalogClient, UpdatePortfolioShareCommand } = require("@aws-sdk/client-service-catalog"); // CommonJS import + * const client = new ServiceCatalogClient(config); + * const command = new UpdatePortfolioShareCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link UpdatePortfolioShareCommandInput} for command's `input` shape. + * @see {@link UpdatePortfolioShareCommandOutput} for command's `response` shape. + * @see {@link ServiceCatalogClientResolvedConfig | config} for command's `input` shape. + * */ export class UpdatePortfolioShareCommand extends $Command< UpdatePortfolioShareCommandInput, diff --git a/clients/client-service-catalog/commands/UpdateProductCommand.ts b/clients/client-service-catalog/commands/UpdateProductCommand.ts index bc5b94cee798..61e4a149dac1 100644 --- a/clients/client-service-catalog/commands/UpdateProductCommand.ts +++ b/clients/client-service-catalog/commands/UpdateProductCommand.ts @@ -22,6 +22,20 @@ export interface UpdateProductCommandOutput extends UpdateProductOutput, __Metad /** *

Updates the specified product.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ServiceCatalogClient, UpdateProductCommand } from "@aws-sdk/client-service-catalog"; // ES Modules import + * // const { ServiceCatalogClient, UpdateProductCommand } = require("@aws-sdk/client-service-catalog"); // CommonJS import + * const client = new ServiceCatalogClient(config); + * const command = new UpdateProductCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link UpdateProductCommandInput} for command's `input` shape. + * @see {@link UpdateProductCommandOutput} for command's `response` shape. + * @see {@link ServiceCatalogClientResolvedConfig | config} for command's `input` shape. + * */ export class UpdateProductCommand extends $Command< UpdateProductCommandInput, diff --git a/clients/client-service-catalog/commands/UpdateProvisionedProductCommand.ts b/clients/client-service-catalog/commands/UpdateProvisionedProductCommand.ts index b9cf4937edcd..d1522e8872be 100644 --- a/clients/client-service-catalog/commands/UpdateProvisionedProductCommand.ts +++ b/clients/client-service-catalog/commands/UpdateProvisionedProductCommand.ts @@ -26,6 +26,20 @@ export interface UpdateProvisionedProductCommandOutput extends UpdateProvisioned * 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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ServiceCatalogClient, UpdateProvisionedProductCommand } from "@aws-sdk/client-service-catalog"; // ES Modules import + * // const { ServiceCatalogClient, UpdateProvisionedProductCommand } = require("@aws-sdk/client-service-catalog"); // CommonJS import + * const client = new ServiceCatalogClient(config); + * const command = new UpdateProvisionedProductCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link UpdateProvisionedProductCommandInput} for command's `input` shape. + * @see {@link UpdateProvisionedProductCommandOutput} for command's `response` shape. + * @see {@link ServiceCatalogClientResolvedConfig | config} for command's `input` shape. + * */ export class UpdateProvisionedProductCommand extends $Command< UpdateProvisionedProductCommandInput, diff --git a/clients/client-service-catalog/commands/UpdateProvisionedProductPropertiesCommand.ts b/clients/client-service-catalog/commands/UpdateProvisionedProductPropertiesCommand.ts index 2b83ead7d0dd..94848dde32c2 100644 --- a/clients/client-service-catalog/commands/UpdateProvisionedProductPropertiesCommand.ts +++ b/clients/client-service-catalog/commands/UpdateProvisionedProductPropertiesCommand.ts @@ -24,6 +24,20 @@ export interface UpdateProvisionedProductPropertiesCommandOutput /** *

Requests updates to the properties of the specified provisioned product.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ServiceCatalogClient, UpdateProvisionedProductPropertiesCommand } from "@aws-sdk/client-service-catalog"; // ES Modules import + * // const { ServiceCatalogClient, UpdateProvisionedProductPropertiesCommand } = require("@aws-sdk/client-service-catalog"); // CommonJS import + * const client = new ServiceCatalogClient(config); + * const command = new UpdateProvisionedProductPropertiesCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link UpdateProvisionedProductPropertiesCommandInput} for command's `input` shape. + * @see {@link UpdateProvisionedProductPropertiesCommandOutput} for command's `response` shape. + * @see {@link ServiceCatalogClientResolvedConfig | config} for command's `input` shape. + * */ export class UpdateProvisionedProductPropertiesCommand extends $Command< UpdateProvisionedProductPropertiesCommandInput, diff --git a/clients/client-service-catalog/commands/UpdateProvisioningArtifactCommand.ts b/clients/client-service-catalog/commands/UpdateProvisioningArtifactCommand.ts index 2a38d87c8a34..e583e2d323d1 100644 --- a/clients/client-service-catalog/commands/UpdateProvisioningArtifactCommand.ts +++ b/clients/client-service-catalog/commands/UpdateProvisioningArtifactCommand.ts @@ -23,6 +23,20 @@ export interface UpdateProvisioningArtifactCommandOutput extends UpdateProvision /** *

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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ServiceCatalogClient, UpdateProvisioningArtifactCommand } from "@aws-sdk/client-service-catalog"; // ES Modules import + * // const { ServiceCatalogClient, UpdateProvisioningArtifactCommand } = require("@aws-sdk/client-service-catalog"); // CommonJS import + * const client = new ServiceCatalogClient(config); + * const command = new UpdateProvisioningArtifactCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link UpdateProvisioningArtifactCommandInput} for command's `input` shape. + * @see {@link UpdateProvisioningArtifactCommandOutput} for command's `response` shape. + * @see {@link ServiceCatalogClientResolvedConfig | config} for command's `input` shape. + * */ export class UpdateProvisioningArtifactCommand extends $Command< UpdateProvisioningArtifactCommandInput, diff --git a/clients/client-service-catalog/commands/UpdateServiceActionCommand.ts b/clients/client-service-catalog/commands/UpdateServiceActionCommand.ts index ff582723ca58..bdd3253aad23 100644 --- a/clients/client-service-catalog/commands/UpdateServiceActionCommand.ts +++ b/clients/client-service-catalog/commands/UpdateServiceActionCommand.ts @@ -22,6 +22,20 @@ export interface UpdateServiceActionCommandOutput extends UpdateServiceActionOut /** *

Updates a self-service action.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ServiceCatalogClient, UpdateServiceActionCommand } from "@aws-sdk/client-service-catalog"; // ES Modules import + * // const { ServiceCatalogClient, UpdateServiceActionCommand } = require("@aws-sdk/client-service-catalog"); // CommonJS import + * const client = new ServiceCatalogClient(config); + * const command = new UpdateServiceActionCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link UpdateServiceActionCommandInput} for command's `input` shape. + * @see {@link UpdateServiceActionCommandOutput} for command's `response` shape. + * @see {@link ServiceCatalogClientResolvedConfig | config} for command's `input` shape. + * */ export class UpdateServiceActionCommand extends $Command< UpdateServiceActionCommandInput, diff --git a/clients/client-service-catalog/commands/UpdateTagOptionCommand.ts b/clients/client-service-catalog/commands/UpdateTagOptionCommand.ts index 4c1c5f9687c4..16565fb7cdca 100644 --- a/clients/client-service-catalog/commands/UpdateTagOptionCommand.ts +++ b/clients/client-service-catalog/commands/UpdateTagOptionCommand.ts @@ -22,6 +22,20 @@ export interface UpdateTagOptionCommandOutput extends UpdateTagOptionOutput, __M /** *

Updates the specified TagOption.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ServiceCatalogClient, UpdateTagOptionCommand } from "@aws-sdk/client-service-catalog"; // ES Modules import + * // const { ServiceCatalogClient, UpdateTagOptionCommand } = require("@aws-sdk/client-service-catalog"); // CommonJS import + * const client = new ServiceCatalogClient(config); + * const command = new UpdateTagOptionCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link UpdateTagOptionCommandInput} for command's `input` shape. + * @see {@link UpdateTagOptionCommandOutput} for command's `response` shape. + * @see {@link ServiceCatalogClientResolvedConfig | config} for command's `input` shape. + * */ export class UpdateTagOptionCommand extends $Command< UpdateTagOptionCommandInput, diff --git a/clients/client-service-catalog/models/models_0.ts b/clients/client-service-catalog/models/models_0.ts index 976fd58b4e62..df915e799f68 100644 --- a/clients/client-service-catalog/models/models_0.ts +++ b/clients/client-service-catalog/models/models_0.ts @@ -56,6 +56,9 @@ export interface AcceptPortfolioShareInput { } export namespace AcceptPortfolioShareInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: AcceptPortfolioShareInput): any => ({ ...obj, }); @@ -64,6 +67,9 @@ export namespace AcceptPortfolioShareInput { export interface AcceptPortfolioShareOutput {} export namespace AcceptPortfolioShareOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: AcceptPortfolioShareOutput): any => ({ ...obj, }); @@ -79,6 +85,9 @@ export interface InvalidParametersException extends __SmithyException, $Metadata } export namespace InvalidParametersException { + /** + * @internal + */ export const filterSensitiveLog = (obj: InvalidParametersException): any => ({ ...obj, }); @@ -95,6 +104,9 @@ export interface LimitExceededException extends __SmithyException, $MetadataBear } export namespace LimitExceededException { + /** + * @internal + */ export const filterSensitiveLog = (obj: LimitExceededException): any => ({ ...obj, }); @@ -110,6 +122,9 @@ export interface ResourceNotFoundException extends __SmithyException, $MetadataB } export namespace ResourceNotFoundException { + /** + * @internal + */ export const filterSensitiveLog = (obj: ResourceNotFoundException): any => ({ ...obj, }); @@ -151,6 +166,9 @@ export interface AccessLevelFilter { } export namespace AccessLevelFilter { + /** + * @internal + */ export const filterSensitiveLog = (obj: AccessLevelFilter): any => ({ ...obj, }); @@ -179,6 +197,9 @@ export interface Tag { } export namespace Tag { + /** + * @internal + */ export const filterSensitiveLog = (obj: Tag): any => ({ ...obj, }); @@ -197,6 +218,9 @@ export interface AssociateBudgetWithResourceInput { } export namespace AssociateBudgetWithResourceInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: AssociateBudgetWithResourceInput): any => ({ ...obj, }); @@ -205,6 +229,9 @@ export namespace AssociateBudgetWithResourceInput { export interface AssociateBudgetWithResourceOutput {} export namespace AssociateBudgetWithResourceOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: AssociateBudgetWithResourceOutput): any => ({ ...obj, }); @@ -220,6 +247,9 @@ export interface DuplicateResourceException extends __SmithyException, $Metadata } export namespace DuplicateResourceException { + /** + * @internal + */ export const filterSensitiveLog = (obj: DuplicateResourceException): any => ({ ...obj, }); @@ -266,6 +296,9 @@ export interface AssociatePrincipalWithPortfolioInput { } export namespace AssociatePrincipalWithPortfolioInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: AssociatePrincipalWithPortfolioInput): any => ({ ...obj, }); @@ -274,6 +307,9 @@ export namespace AssociatePrincipalWithPortfolioInput { export interface AssociatePrincipalWithPortfolioOutput {} export namespace AssociatePrincipalWithPortfolioOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: AssociatePrincipalWithPortfolioOutput): any => ({ ...obj, }); @@ -316,6 +352,9 @@ export interface AssociateProductWithPortfolioInput { } export namespace AssociateProductWithPortfolioInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: AssociateProductWithPortfolioInput): any => ({ ...obj, }); @@ -324,6 +363,9 @@ export namespace AssociateProductWithPortfolioInput { export interface AssociateProductWithPortfolioOutput {} export namespace AssociateProductWithPortfolioOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: AssociateProductWithPortfolioOutput): any => ({ ...obj, }); @@ -366,6 +408,9 @@ export interface AssociateServiceActionWithProvisioningArtifactInput { } export namespace AssociateServiceActionWithProvisioningArtifactInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: AssociateServiceActionWithProvisioningArtifactInput): any => ({ ...obj, }); @@ -374,6 +419,9 @@ export namespace AssociateServiceActionWithProvisioningArtifactInput { export interface AssociateServiceActionWithProvisioningArtifactOutput {} export namespace AssociateServiceActionWithProvisioningArtifactOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: AssociateServiceActionWithProvisioningArtifactOutput): any => ({ ...obj, }); @@ -392,6 +440,9 @@ export interface AssociateTagOptionWithResourceInput { } export namespace AssociateTagOptionWithResourceInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: AssociateTagOptionWithResourceInput): any => ({ ...obj, }); @@ -400,6 +451,9 @@ export namespace AssociateTagOptionWithResourceInput { export interface AssociateTagOptionWithResourceOutput {} export namespace AssociateTagOptionWithResourceOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: AssociateTagOptionWithResourceOutput): any => ({ ...obj, }); @@ -416,6 +470,9 @@ export interface InvalidStateException extends __SmithyException, $MetadataBeare } export namespace InvalidStateException { + /** + * @internal + */ export const filterSensitiveLog = (obj: InvalidStateException): any => ({ ...obj, }); @@ -433,6 +490,9 @@ export interface TagOptionNotMigratedException extends __SmithyException, $Metad } export namespace TagOptionNotMigratedException { + /** + * @internal + */ export const filterSensitiveLog = (obj: TagOptionNotMigratedException): any => ({ ...obj, }); @@ -459,6 +519,9 @@ export interface ServiceActionAssociation { } export namespace ServiceActionAssociation { + /** + * @internal + */ export const filterSensitiveLog = (obj: ServiceActionAssociation): any => ({ ...obj, }); @@ -491,6 +554,9 @@ export interface BatchAssociateServiceActionWithProvisioningArtifactInput { } export namespace BatchAssociateServiceActionWithProvisioningArtifactInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: BatchAssociateServiceActionWithProvisioningArtifactInput): any => ({ ...obj, }); @@ -535,6 +601,9 @@ export interface FailedServiceActionAssociation { } export namespace FailedServiceActionAssociation { + /** + * @internal + */ export const filterSensitiveLog = (obj: FailedServiceActionAssociation): any => ({ ...obj, }); @@ -548,6 +617,9 @@ export interface BatchAssociateServiceActionWithProvisioningArtifactOutput { } export namespace BatchAssociateServiceActionWithProvisioningArtifactOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: BatchAssociateServiceActionWithProvisioningArtifactOutput): any => ({ ...obj, }); @@ -580,6 +652,9 @@ export interface BatchDisassociateServiceActionFromProvisioningArtifactInput { } export namespace BatchDisassociateServiceActionFromProvisioningArtifactInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: BatchDisassociateServiceActionFromProvisioningArtifactInput): any => ({ ...obj, }); @@ -593,6 +668,9 @@ export interface BatchDisassociateServiceActionFromProvisioningArtifactOutput { } export namespace BatchDisassociateServiceActionFromProvisioningArtifactOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: BatchDisassociateServiceActionFromProvisioningArtifactOutput): any => ({ ...obj, }); @@ -661,6 +739,9 @@ export interface CopyProductInput { } export namespace CopyProductInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: CopyProductInput): any => ({ ...obj, }); @@ -674,6 +755,9 @@ export interface CopyProductOutput { } export namespace CopyProductOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: CopyProductOutput): any => ({ ...obj, }); @@ -810,6 +894,9 @@ export interface CreateConstraintInput { } export namespace CreateConstraintInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateConstraintInput): any => ({ ...obj, }); @@ -871,6 +958,9 @@ export interface ConstraintDetail { } export namespace ConstraintDetail { + /** + * @internal + */ export const filterSensitiveLog = (obj: ConstraintDetail): any => ({ ...obj, }); @@ -900,6 +990,9 @@ export interface CreateConstraintOutput { } export namespace CreateConstraintOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateConstraintOutput): any => ({ ...obj, }); @@ -953,6 +1046,9 @@ export interface CreatePortfolioInput { } export namespace CreatePortfolioInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreatePortfolioInput): any => ({ ...obj, }); @@ -994,6 +1090,9 @@ export interface PortfolioDetail { } export namespace PortfolioDetail { + /** + * @internal + */ export const filterSensitiveLog = (obj: PortfolioDetail): any => ({ ...obj, }); @@ -1012,6 +1111,9 @@ export interface CreatePortfolioOutput { } export namespace CreatePortfolioOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreatePortfolioOutput): any => ({ ...obj, }); @@ -1039,6 +1141,9 @@ export interface OrganizationNode { } export namespace OrganizationNode { + /** + * @internal + */ export const filterSensitiveLog = (obj: OrganizationNode): any => ({ ...obj, }); @@ -1091,6 +1196,9 @@ export interface CreatePortfolioShareInput { } export namespace CreatePortfolioShareInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreatePortfolioShareInput): any => ({ ...obj, }); @@ -1104,6 +1212,9 @@ export interface CreatePortfolioShareOutput { } export namespace CreatePortfolioShareOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreatePortfolioShareOutput): any => ({ ...obj, }); @@ -1119,6 +1230,9 @@ export interface OperationNotSupportedException extends __SmithyException, $Meta } export namespace OperationNotSupportedException { + /** + * @internal + */ export const filterSensitiveLog = (obj: OperationNotSupportedException): any => ({ ...obj, }); @@ -1190,6 +1304,9 @@ export interface ProvisioningArtifactProperties { } export namespace ProvisioningArtifactProperties { + /** + * @internal + */ export const filterSensitiveLog = (obj: ProvisioningArtifactProperties): any => ({ ...obj, }); @@ -1275,6 +1392,9 @@ export interface CreateProductInput { } export namespace CreateProductInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateProductInput): any => ({ ...obj, }); @@ -1349,6 +1469,9 @@ export interface ProductViewSummary { } export namespace ProductViewSummary { + /** + * @internal + */ export const filterSensitiveLog = (obj: ProductViewSummary): any => ({ ...obj, }); @@ -1394,6 +1517,9 @@ export interface ProductViewDetail { } export namespace ProductViewDetail { + /** + * @internal + */ export const filterSensitiveLog = (obj: ProductViewDetail): any => ({ ...obj, }); @@ -1459,6 +1585,9 @@ export interface ProvisioningArtifactDetail { } export namespace ProvisioningArtifactDetail { + /** + * @internal + */ export const filterSensitiveLog = (obj: ProvisioningArtifactDetail): any => ({ ...obj, }); @@ -1482,6 +1611,9 @@ export interface CreateProductOutput { } export namespace CreateProductOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateProductOutput): any => ({ ...obj, }); @@ -1512,6 +1644,9 @@ export interface UpdateProvisioningParameter { } export namespace UpdateProvisioningParameter { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateProvisioningParameter): any => ({ ...obj, }); @@ -1596,6 +1731,9 @@ export interface CreateProvisionedProductPlanInput { } export namespace CreateProvisionedProductPlanInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateProvisionedProductPlanInput): any => ({ ...obj, }); @@ -1629,6 +1767,9 @@ export interface CreateProvisionedProductPlanOutput { } export namespace CreateProvisionedProductPlanOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateProvisionedProductPlanOutput): any => ({ ...obj, }); @@ -1672,6 +1813,9 @@ export interface CreateProvisioningArtifactInput { } export namespace CreateProvisioningArtifactInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateProvisioningArtifactInput): any => ({ ...obj, }); @@ -1706,6 +1850,9 @@ export interface CreateProvisioningArtifactOutput { } export namespace CreateProvisioningArtifactOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateProvisioningArtifactOutput): any => ({ ...obj, }); @@ -1792,6 +1939,9 @@ export interface CreateServiceActionInput { } export namespace CreateServiceActionInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateServiceActionInput): any => ({ ...obj, }); @@ -1823,6 +1973,9 @@ export interface ServiceActionSummary { } export namespace ServiceActionSummary { + /** + * @internal + */ export const filterSensitiveLog = (obj: ServiceActionSummary): any => ({ ...obj, }); @@ -1844,6 +1997,9 @@ export interface ServiceActionDetail { } export namespace ServiceActionDetail { + /** + * @internal + */ export const filterSensitiveLog = (obj: ServiceActionDetail): any => ({ ...obj, }); @@ -1857,6 +2013,9 @@ export interface CreateServiceActionOutput { } export namespace CreateServiceActionOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateServiceActionOutput): any => ({ ...obj, }); @@ -1875,6 +2034,9 @@ export interface CreateTagOptionInput { } export namespace CreateTagOptionInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateTagOptionInput): any => ({ ...obj, }); @@ -1911,6 +2073,9 @@ export interface TagOptionDetail { } export namespace TagOptionDetail { + /** + * @internal + */ export const filterSensitiveLog = (obj: TagOptionDetail): any => ({ ...obj, }); @@ -1924,6 +2089,9 @@ export interface CreateTagOptionOutput { } export namespace CreateTagOptionOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateTagOptionOutput): any => ({ ...obj, }); @@ -1956,6 +2124,9 @@ export interface DeleteConstraintInput { } export namespace DeleteConstraintInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteConstraintInput): any => ({ ...obj, }); @@ -1964,6 +2135,9 @@ export namespace DeleteConstraintInput { export interface DeleteConstraintOutput {} export namespace DeleteConstraintOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteConstraintOutput): any => ({ ...obj, }); @@ -1996,6 +2170,9 @@ export interface DeletePortfolioInput { } export namespace DeletePortfolioInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeletePortfolioInput): any => ({ ...obj, }); @@ -2004,6 +2181,9 @@ export namespace DeletePortfolioInput { export interface DeletePortfolioOutput {} export namespace DeletePortfolioOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeletePortfolioOutput): any => ({ ...obj, }); @@ -2019,6 +2199,9 @@ export interface ResourceInUseException extends __SmithyException, $MetadataBear } export namespace ResourceInUseException { + /** + * @internal + */ export const filterSensitiveLog = (obj: ResourceInUseException): any => ({ ...obj, }); @@ -2061,6 +2244,9 @@ export interface DeletePortfolioShareInput { } export namespace DeletePortfolioShareInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeletePortfolioShareInput): any => ({ ...obj, }); @@ -2074,6 +2260,9 @@ export interface DeletePortfolioShareOutput { } export namespace DeletePortfolioShareOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeletePortfolioShareOutput): any => ({ ...obj, }); @@ -2106,6 +2295,9 @@ export interface DeleteProductInput { } export namespace DeleteProductInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteProductInput): any => ({ ...obj, }); @@ -2114,6 +2306,9 @@ export namespace DeleteProductInput { export interface DeleteProductOutput {} export namespace DeleteProductOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteProductOutput): any => ({ ...obj, }); @@ -2152,6 +2347,9 @@ export interface DeleteProvisionedProductPlanInput { } export namespace DeleteProvisionedProductPlanInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteProvisionedProductPlanInput): any => ({ ...obj, }); @@ -2160,6 +2358,9 @@ export namespace DeleteProvisionedProductPlanInput { export interface DeleteProvisionedProductPlanOutput {} export namespace DeleteProvisionedProductPlanOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteProvisionedProductPlanOutput): any => ({ ...obj, }); @@ -2197,6 +2398,9 @@ export interface DeleteProvisioningArtifactInput { } export namespace DeleteProvisioningArtifactInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteProvisioningArtifactInput): any => ({ ...obj, }); @@ -2205,6 +2409,9 @@ export namespace DeleteProvisioningArtifactInput { export interface DeleteProvisioningArtifactOutput {} export namespace DeleteProvisioningArtifactOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteProvisioningArtifactOutput): any => ({ ...obj, }); @@ -2237,6 +2444,9 @@ export interface DeleteServiceActionInput { } export namespace DeleteServiceActionInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteServiceActionInput): any => ({ ...obj, }); @@ -2245,6 +2455,9 @@ export namespace DeleteServiceActionInput { export interface DeleteServiceActionOutput {} export namespace DeleteServiceActionOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteServiceActionOutput): any => ({ ...obj, }); @@ -2258,6 +2471,9 @@ export interface DeleteTagOptionInput { } export namespace DeleteTagOptionInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteTagOptionInput): any => ({ ...obj, }); @@ -2266,6 +2482,9 @@ export namespace DeleteTagOptionInput { export interface DeleteTagOptionOutput {} export namespace DeleteTagOptionOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteTagOptionOutput): any => ({ ...obj, }); @@ -2298,6 +2517,9 @@ export interface DescribeConstraintInput { } export namespace DescribeConstraintInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeConstraintInput): any => ({ ...obj, }); @@ -2321,6 +2543,9 @@ export interface DescribeConstraintOutput { } export namespace DescribeConstraintOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeConstraintOutput): any => ({ ...obj, }); @@ -2353,6 +2578,9 @@ export interface DescribeCopyProductStatusInput { } export namespace DescribeCopyProductStatusInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeCopyProductStatusInput): any => ({ ...obj, }); @@ -2382,6 +2610,9 @@ export interface DescribeCopyProductStatusOutput { } export namespace DescribeCopyProductStatusOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeCopyProductStatusOutput): any => ({ ...obj, }); @@ -2414,6 +2645,9 @@ export interface DescribePortfolioInput { } export namespace DescribePortfolioInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribePortfolioInput): any => ({ ...obj, }); @@ -2430,6 +2664,9 @@ export interface BudgetDetail { } export namespace BudgetDetail { + /** + * @internal + */ export const filterSensitiveLog = (obj: BudgetDetail): any => ({ ...obj, }); @@ -2458,6 +2695,9 @@ export interface DescribePortfolioOutput { } export namespace DescribePortfolioOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribePortfolioOutput): any => ({ ...obj, }); @@ -2497,6 +2737,9 @@ export interface DescribePortfolioSharesInput { } export namespace DescribePortfolioSharesInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribePortfolioSharesInput): any => ({ ...obj, }); @@ -2534,6 +2777,9 @@ export interface PortfolioShareDetail { } export namespace PortfolioShareDetail { + /** + * @internal + */ export const filterSensitiveLog = (obj: PortfolioShareDetail): any => ({ ...obj, }); @@ -2552,6 +2798,9 @@ export interface DescribePortfolioSharesOutput { } export namespace DescribePortfolioSharesOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribePortfolioSharesOutput): any => ({ ...obj, }); @@ -2565,6 +2814,9 @@ export interface DescribePortfolioShareStatusInput { } export namespace DescribePortfolioShareStatusInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribePortfolioShareStatusInput): any => ({ ...obj, }); @@ -2591,6 +2843,9 @@ export interface ShareError { } export namespace ShareError { + /** + * @internal + */ export const filterSensitiveLog = (obj: ShareError): any => ({ ...obj, }); @@ -2612,6 +2867,9 @@ export interface ShareDetails { } export namespace ShareDetails { + /** + * @internal + */ export const filterSensitiveLog = (obj: ShareDetails): any => ({ ...obj, }); @@ -2653,6 +2911,9 @@ export interface DescribePortfolioShareStatusOutput { } export namespace DescribePortfolioShareStatusOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribePortfolioShareStatusOutput): any => ({ ...obj, }); @@ -2690,6 +2951,9 @@ export interface DescribeProductInput { } export namespace DescribeProductInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeProductInput): any => ({ ...obj, }); @@ -2711,6 +2975,9 @@ export interface LaunchPath { } export namespace LaunchPath { + /** + * @internal + */ export const filterSensitiveLog = (obj: LaunchPath): any => ({ ...obj, }); @@ -2747,6 +3014,9 @@ export interface ProvisioningArtifact { } export namespace ProvisioningArtifact { + /** + * @internal + */ export const filterSensitiveLog = (obj: ProvisioningArtifact): any => ({ ...obj, }); @@ -2775,6 +3045,9 @@ export interface DescribeProductOutput { } export namespace DescribeProductOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeProductOutput): any => ({ ...obj, }); @@ -2822,6 +3095,9 @@ export interface DescribeProductAsAdminInput { } export namespace DescribeProductAsAdminInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeProductAsAdminInput): any => ({ ...obj, }); @@ -2858,6 +3134,9 @@ export interface ProvisioningArtifactSummary { } export namespace ProvisioningArtifactSummary { + /** + * @internal + */ export const filterSensitiveLog = (obj: ProvisioningArtifactSummary): any => ({ ...obj, }); @@ -2891,6 +3170,9 @@ export interface DescribeProductAsAdminOutput { } export namespace DescribeProductAsAdminOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeProductAsAdminOutput): any => ({ ...obj, }); @@ -2923,6 +3205,9 @@ export interface DescribeProductViewInput { } export namespace DescribeProductViewInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeProductViewInput): any => ({ ...obj, }); @@ -2941,6 +3226,9 @@ export interface DescribeProductViewOutput { } export namespace DescribeProductViewOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeProductViewOutput): any => ({ ...obj, }); @@ -2992,6 +3280,9 @@ export interface DescribeProvisionedProductInput { } export namespace DescribeProvisionedProductInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeProvisionedProductInput): any => ({ ...obj, }); @@ -3008,6 +3299,9 @@ export interface CloudWatchDashboard { } export namespace CloudWatchDashboard { + /** + * @internal + */ export const filterSensitiveLog = (obj: CloudWatchDashboard): any => ({ ...obj, }); @@ -3170,6 +3464,9 @@ export interface ProvisionedProductDetail { } export namespace ProvisionedProductDetail { + /** + * @internal + */ export const filterSensitiveLog = (obj: ProvisionedProductDetail): any => ({ ...obj, }); @@ -3188,6 +3485,9 @@ export interface DescribeProvisionedProductOutput { } export namespace DescribeProvisionedProductOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeProvisionedProductOutput): any => ({ ...obj, }); @@ -3230,6 +3530,9 @@ export interface DescribeProvisionedProductPlanInput { } export namespace DescribeProvisionedProductPlanInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeProvisionedProductPlanInput): any => ({ ...obj, }); @@ -3329,6 +3632,9 @@ export interface ProvisionedProductPlanDetails { } export namespace ProvisionedProductPlanDetails { + /** + * @internal + */ export const filterSensitiveLog = (obj: ProvisionedProductPlanDetails): any => ({ ...obj, }); @@ -3383,6 +3689,9 @@ export interface ResourceTargetDefinition { } export namespace ResourceTargetDefinition { + /** + * @internal + */ export const filterSensitiveLog = (obj: ResourceTargetDefinition): any => ({ ...obj, }); @@ -3410,6 +3719,9 @@ export interface ResourceChangeDetail { } export namespace ResourceChangeDetail { + /** + * @internal + */ export const filterSensitiveLog = (obj: ResourceChangeDetail): any => ({ ...obj, }); @@ -3463,6 +3775,9 @@ export interface ResourceChange { } export namespace ResourceChange { + /** + * @internal + */ export const filterSensitiveLog = (obj: ResourceChange): any => ({ ...obj, }); @@ -3486,6 +3801,9 @@ export interface DescribeProvisionedProductPlanOutput { } export namespace DescribeProvisionedProductPlanOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeProvisionedProductPlanOutput): any => ({ ...obj, }); @@ -3538,6 +3856,9 @@ export interface DescribeProvisioningArtifactInput { } export namespace DescribeProvisioningArtifactInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeProvisioningArtifactInput): any => ({ ...obj, }); @@ -3561,6 +3882,9 @@ export interface DescribeProvisioningArtifactOutput { } export namespace DescribeProvisioningArtifactOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeProvisioningArtifactOutput): any => ({ ...obj, }); @@ -3620,6 +3944,9 @@ export interface DescribeProvisioningParametersInput { } export namespace DescribeProvisioningParametersInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeProvisioningParametersInput): any => ({ ...obj, }); @@ -3661,6 +3988,9 @@ export interface ConstraintSummary { } export namespace ConstraintSummary { + /** + * @internal + */ export const filterSensitiveLog = (obj: ConstraintSummary): any => ({ ...obj, }); @@ -3682,6 +4012,9 @@ export interface ProvisioningArtifactOutput { } export namespace ProvisioningArtifactOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: ProvisioningArtifactOutput): any => ({ ...obj, }); @@ -3738,6 +4071,9 @@ export interface ParameterConstraints { } export namespace ParameterConstraints { + /** + * @internal + */ export const filterSensitiveLog = (obj: ParameterConstraints): any => ({ ...obj, }); @@ -3780,6 +4116,9 @@ export interface ProvisioningArtifactParameter { } export namespace ProvisioningArtifactParameter { + /** + * @internal + */ export const filterSensitiveLog = (obj: ProvisioningArtifactParameter): any => ({ ...obj, }); @@ -3804,6 +4143,9 @@ export interface ProvisioningArtifactPreferences { } export namespace ProvisioningArtifactPreferences { + /** + * @internal + */ export const filterSensitiveLog = (obj: ProvisioningArtifactPreferences): any => ({ ...obj, }); @@ -3825,6 +4167,9 @@ export interface TagOptionSummary { } export namespace TagOptionSummary { + /** + * @internal + */ export const filterSensitiveLog = (obj: TagOptionSummary): any => ({ ...obj, }); @@ -3846,6 +4191,9 @@ export interface UsageInstruction { } export namespace UsageInstruction { + /** + * @internal + */ export const filterSensitiveLog = (obj: UsageInstruction): any => ({ ...obj, }); @@ -3885,6 +4233,9 @@ export interface DescribeProvisioningParametersOutput { } export namespace DescribeProvisioningParametersOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeProvisioningParametersOutput): any => ({ ...obj, }); @@ -3928,6 +4279,9 @@ export interface DescribeRecordInput { } export namespace DescribeRecordInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeRecordInput): any => ({ ...obj, }); @@ -3949,6 +4303,9 @@ export interface RecordError { } export namespace RecordError { + /** + * @internal + */ export const filterSensitiveLog = (obj: RecordError): any => ({ ...obj, }); @@ -3970,6 +4327,9 @@ export interface RecordTag { } export namespace RecordTag { + /** + * @internal + */ export const filterSensitiveLog = (obj: RecordTag): any => ({ ...obj, }); @@ -4100,6 +4460,9 @@ export interface RecordDetail { } export namespace RecordDetail { + /** + * @internal + */ export const filterSensitiveLog = (obj: RecordDetail): any => ({ ...obj, }); @@ -4127,6 +4490,9 @@ export interface RecordOutput { } export namespace RecordOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: RecordOutput): any => ({ ...obj, }); @@ -4151,6 +4517,9 @@ export interface DescribeRecordOutput { } export namespace DescribeRecordOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeRecordOutput): any => ({ ...obj, }); @@ -4183,6 +4552,9 @@ export interface DescribeServiceActionInput { } export namespace DescribeServiceActionInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeServiceActionInput): any => ({ ...obj, }); @@ -4196,6 +4568,9 @@ export interface DescribeServiceActionOutput { } export namespace DescribeServiceActionOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeServiceActionOutput): any => ({ ...obj, }); @@ -4233,6 +4608,9 @@ export interface DescribeServiceActionExecutionParametersInput { } export namespace DescribeServiceActionExecutionParametersInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeServiceActionExecutionParametersInput): any => ({ ...obj, }); @@ -4259,6 +4637,9 @@ export interface ExecutionParameter { } export namespace ExecutionParameter { + /** + * @internal + */ export const filterSensitiveLog = (obj: ExecutionParameter): any => ({ ...obj, }); @@ -4272,6 +4653,9 @@ export interface DescribeServiceActionExecutionParametersOutput { } export namespace DescribeServiceActionExecutionParametersOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeServiceActionExecutionParametersOutput): any => ({ ...obj, }); @@ -4285,6 +4669,9 @@ export interface DescribeTagOptionInput { } export namespace DescribeTagOptionInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeTagOptionInput): any => ({ ...obj, }); @@ -4298,6 +4685,9 @@ export interface DescribeTagOptionOutput { } export namespace DescribeTagOptionOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeTagOptionOutput): any => ({ ...obj, }); @@ -4306,6 +4696,9 @@ export namespace DescribeTagOptionOutput { export interface DisableAWSOrganizationsAccessInput {} export namespace DisableAWSOrganizationsAccessInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: DisableAWSOrganizationsAccessInput): any => ({ ...obj, }); @@ -4314,6 +4707,9 @@ export namespace DisableAWSOrganizationsAccessInput { export interface DisableAWSOrganizationsAccessOutput {} export namespace DisableAWSOrganizationsAccessOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: DisableAWSOrganizationsAccessOutput): any => ({ ...obj, }); @@ -4332,6 +4728,9 @@ export interface DisassociateBudgetFromResourceInput { } export namespace DisassociateBudgetFromResourceInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: DisassociateBudgetFromResourceInput): any => ({ ...obj, }); @@ -4340,6 +4739,9 @@ export namespace DisassociateBudgetFromResourceInput { export interface DisassociateBudgetFromResourceOutput {} export namespace DisassociateBudgetFromResourceOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: DisassociateBudgetFromResourceOutput): any => ({ ...obj, }); @@ -4377,6 +4779,9 @@ export interface DisassociatePrincipalFromPortfolioInput { } export namespace DisassociatePrincipalFromPortfolioInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: DisassociatePrincipalFromPortfolioInput): any => ({ ...obj, }); @@ -4385,6 +4790,9 @@ export namespace DisassociatePrincipalFromPortfolioInput { export interface DisassociatePrincipalFromPortfolioOutput {} export namespace DisassociatePrincipalFromPortfolioOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: DisassociatePrincipalFromPortfolioOutput): any => ({ ...obj, }); @@ -4422,6 +4830,9 @@ export interface DisassociateProductFromPortfolioInput { } export namespace DisassociateProductFromPortfolioInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: DisassociateProductFromPortfolioInput): any => ({ ...obj, }); @@ -4430,6 +4841,9 @@ export namespace DisassociateProductFromPortfolioInput { export interface DisassociateProductFromPortfolioOutput {} export namespace DisassociateProductFromPortfolioOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: DisassociateProductFromPortfolioOutput): any => ({ ...obj, }); @@ -4472,6 +4886,9 @@ export interface DisassociateServiceActionFromProvisioningArtifactInput { } export namespace DisassociateServiceActionFromProvisioningArtifactInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: DisassociateServiceActionFromProvisioningArtifactInput): any => ({ ...obj, }); @@ -4480,6 +4897,9 @@ export namespace DisassociateServiceActionFromProvisioningArtifactInput { export interface DisassociateServiceActionFromProvisioningArtifactOutput {} export namespace DisassociateServiceActionFromProvisioningArtifactOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: DisassociateServiceActionFromProvisioningArtifactOutput): any => ({ ...obj, }); @@ -4498,6 +4918,9 @@ export interface DisassociateTagOptionFromResourceInput { } export namespace DisassociateTagOptionFromResourceInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: DisassociateTagOptionFromResourceInput): any => ({ ...obj, }); @@ -4506,6 +4929,9 @@ export namespace DisassociateTagOptionFromResourceInput { export interface DisassociateTagOptionFromResourceOutput {} export namespace DisassociateTagOptionFromResourceOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: DisassociateTagOptionFromResourceOutput): any => ({ ...obj, }); @@ -4514,6 +4940,9 @@ export namespace DisassociateTagOptionFromResourceOutput { export interface EnableAWSOrganizationsAccessInput {} export namespace EnableAWSOrganizationsAccessInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: EnableAWSOrganizationsAccessInput): any => ({ ...obj, }); @@ -4522,6 +4951,9 @@ export namespace EnableAWSOrganizationsAccessInput { export interface EnableAWSOrganizationsAccessOutput {} export namespace EnableAWSOrganizationsAccessOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: EnableAWSOrganizationsAccessOutput): any => ({ ...obj, }); @@ -4560,6 +4992,9 @@ export interface ExecuteProvisionedProductPlanInput { } export namespace ExecuteProvisionedProductPlanInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: ExecuteProvisionedProductPlanInput): any => ({ ...obj, }); @@ -4573,6 +5008,9 @@ export interface ExecuteProvisionedProductPlanOutput { } export namespace ExecuteProvisionedProductPlanOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: ExecuteProvisionedProductPlanOutput): any => ({ ...obj, }); @@ -4622,6 +5060,9 @@ export interface ExecuteProvisionedProductServiceActionInput { } export namespace ExecuteProvisionedProductServiceActionInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: ExecuteProvisionedProductServiceActionInput): any => ({ ...obj, }); @@ -4635,6 +5076,9 @@ export interface ExecuteProvisionedProductServiceActionOutput { } export namespace ExecuteProvisionedProductServiceActionOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: ExecuteProvisionedProductServiceActionOutput): any => ({ ...obj, }); @@ -4643,6 +5087,9 @@ export namespace ExecuteProvisionedProductServiceActionOutput { export interface GetAWSOrganizationsAccessStatusInput {} export namespace GetAWSOrganizationsAccessStatusInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetAWSOrganizationsAccessStatusInput): any => ({ ...obj, }); @@ -4656,6 +5103,9 @@ export interface GetAWSOrganizationsAccessStatusOutput { } export namespace GetAWSOrganizationsAccessStatusOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetAWSOrganizationsAccessStatusOutput): any => ({ ...obj, }); @@ -4708,6 +5158,9 @@ export interface GetProvisionedProductOutputsInput { } export namespace GetProvisionedProductOutputsInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetProvisionedProductOutputsInput): any => ({ ...obj, }); @@ -4727,6 +5180,9 @@ export interface GetProvisionedProductOutputsOutput { } export namespace GetProvisionedProductOutputsOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetProvisionedProductOutputsOutput): any => ({ ...obj, }); @@ -4782,6 +5238,9 @@ export interface ImportAsProvisionedProductInput { } export namespace ImportAsProvisionedProductInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: ImportAsProvisionedProductInput): any => ({ ...obj, }); @@ -4795,6 +5254,9 @@ export interface ImportAsProvisionedProductOutput { } export namespace ImportAsProvisionedProductOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: ImportAsProvisionedProductOutput): any => ({ ...obj, }); @@ -4852,6 +5314,9 @@ export interface ListAcceptedPortfolioSharesInput { } export namespace ListAcceptedPortfolioSharesInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListAcceptedPortfolioSharesInput): any => ({ ...obj, }); @@ -4870,6 +5335,9 @@ export interface ListAcceptedPortfolioSharesOutput { } export namespace ListAcceptedPortfolioSharesOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListAcceptedPortfolioSharesOutput): any => ({ ...obj, }); @@ -4912,6 +5380,9 @@ export interface ListBudgetsForResourceInput { } export namespace ListBudgetsForResourceInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListBudgetsForResourceInput): any => ({ ...obj, }); @@ -4930,6 +5401,9 @@ export interface ListBudgetsForResourceOutput { } export namespace ListBudgetsForResourceOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListBudgetsForResourceOutput): any => ({ ...obj, }); @@ -4977,6 +5451,9 @@ export interface ListConstraintsForPortfolioInput { } export namespace ListConstraintsForPortfolioInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListConstraintsForPortfolioInput): any => ({ ...obj, }); @@ -4995,6 +5472,9 @@ export interface ListConstraintsForPortfolioOutput { } export namespace ListConstraintsForPortfolioOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListConstraintsForPortfolioOutput): any => ({ ...obj, }); @@ -5037,6 +5517,9 @@ export interface ListLaunchPathsInput { } export namespace ListLaunchPathsInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListLaunchPathsInput): any => ({ ...obj, }); @@ -5068,6 +5551,9 @@ export interface LaunchPathSummary { } export namespace LaunchPathSummary { + /** + * @internal + */ export const filterSensitiveLog = (obj: LaunchPathSummary): any => ({ ...obj, }); @@ -5086,6 +5572,9 @@ export interface ListLaunchPathsOutput { } export namespace ListLaunchPathsOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListLaunchPathsOutput): any => ({ ...obj, }); @@ -5147,6 +5636,9 @@ export interface ListOrganizationPortfolioAccessInput { } export namespace ListOrganizationPortfolioAccessInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListOrganizationPortfolioAccessInput): any => ({ ...obj, }); @@ -5165,6 +5657,9 @@ export interface ListOrganizationPortfolioAccessOutput { } export namespace ListOrganizationPortfolioAccessOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListOrganizationPortfolioAccessOutput): any => ({ ...obj, }); @@ -5212,6 +5707,9 @@ export interface ListPortfolioAccessInput { } export namespace ListPortfolioAccessInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListPortfolioAccessInput): any => ({ ...obj, }); @@ -5230,6 +5728,9 @@ export interface ListPortfolioAccessOutput { } export namespace ListPortfolioAccessOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListPortfolioAccessOutput): any => ({ ...obj, }); @@ -5267,6 +5768,9 @@ export interface ListPortfoliosInput { } export namespace ListPortfoliosInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListPortfoliosInput): any => ({ ...obj, }); @@ -5285,6 +5789,9 @@ export interface ListPortfoliosOutput { } export namespace ListPortfoliosOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListPortfoliosOutput): any => ({ ...obj, }); @@ -5327,6 +5834,9 @@ export interface ListPortfoliosForProductInput { } export namespace ListPortfoliosForProductInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListPortfoliosForProductInput): any => ({ ...obj, }); @@ -5345,6 +5855,9 @@ export interface ListPortfoliosForProductOutput { } export namespace ListPortfoliosForProductOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListPortfoliosForProductOutput): any => ({ ...obj, }); @@ -5387,6 +5900,9 @@ export interface ListPrincipalsForPortfolioInput { } export namespace ListPrincipalsForPortfolioInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListPrincipalsForPortfolioInput): any => ({ ...obj, }); @@ -5408,6 +5924,9 @@ export interface Principal { } export namespace Principal { + /** + * @internal + */ export const filterSensitiveLog = (obj: Principal): any => ({ ...obj, }); @@ -5426,6 +5945,9 @@ export interface ListPrincipalsForPortfolioOutput { } export namespace ListPrincipalsForPortfolioOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListPrincipalsForPortfolioOutput): any => ({ ...obj, }); @@ -5473,6 +5995,9 @@ export interface ListProvisionedProductPlansInput { } export namespace ListProvisionedProductPlansInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListProvisionedProductPlansInput): any => ({ ...obj, }); @@ -5514,6 +6039,9 @@ export interface ProvisionedProductPlanSummary { } export namespace ProvisionedProductPlanSummary { + /** + * @internal + */ export const filterSensitiveLog = (obj: ProvisionedProductPlanSummary): any => ({ ...obj, }); @@ -5532,6 +6060,9 @@ export interface ListProvisionedProductPlansOutput { } export namespace ListProvisionedProductPlansOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListProvisionedProductPlansOutput): any => ({ ...obj, }); @@ -5564,6 +6095,9 @@ export interface ListProvisioningArtifactsInput { } export namespace ListProvisioningArtifactsInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListProvisioningArtifactsInput): any => ({ ...obj, }); @@ -5582,6 +6116,9 @@ export interface ListProvisioningArtifactsOutput { } export namespace ListProvisioningArtifactsOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListProvisioningArtifactsOutput): any => ({ ...obj, }); @@ -5624,6 +6161,9 @@ export interface ListProvisioningArtifactsForServiceActionInput { } export namespace ListProvisioningArtifactsForServiceActionInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListProvisioningArtifactsForServiceActionInput): any => ({ ...obj, }); @@ -5645,6 +6185,9 @@ export interface ProvisioningArtifactView { } export namespace ProvisioningArtifactView { + /** + * @internal + */ export const filterSensitiveLog = (obj: ProvisioningArtifactView): any => ({ ...obj, }); @@ -5663,6 +6206,9 @@ export interface ListProvisioningArtifactsForServiceActionOutput { } export namespace ListProvisioningArtifactsForServiceActionOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListProvisioningArtifactsForServiceActionOutput): any => ({ ...obj, }); @@ -5694,6 +6240,9 @@ export interface ListRecordHistorySearchFilter { } export namespace ListRecordHistorySearchFilter { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListRecordHistorySearchFilter): any => ({ ...obj, }); @@ -5741,6 +6290,9 @@ export interface ListRecordHistoryInput { } export namespace ListRecordHistoryInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListRecordHistoryInput): any => ({ ...obj, }); @@ -5759,6 +6311,9 @@ export interface ListRecordHistoryOutput { } export namespace ListRecordHistoryOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListRecordHistoryOutput): any => ({ ...obj, }); @@ -5799,6 +6354,9 @@ export interface ListResourcesForTagOptionInput { } export namespace ListResourcesForTagOptionInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListResourcesForTagOptionInput): any => ({ ...obj, }); @@ -5835,6 +6393,9 @@ export interface ResourceDetail { } export namespace ResourceDetail { + /** + * @internal + */ export const filterSensitiveLog = (obj: ResourceDetail): any => ({ ...obj, }); @@ -5853,6 +6414,9 @@ export interface ListResourcesForTagOptionOutput { } export namespace ListResourcesForTagOptionOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListResourcesForTagOptionOutput): any => ({ ...obj, }); @@ -5890,6 +6454,9 @@ export interface ListServiceActionsInput { } export namespace ListServiceActionsInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListServiceActionsInput): any => ({ ...obj, }); @@ -5908,6 +6475,9 @@ export interface ListServiceActionsOutput { } export namespace ListServiceActionsOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListServiceActionsOutput): any => ({ ...obj, }); @@ -5955,6 +6525,9 @@ export interface ListServiceActionsForProvisioningArtifactInput { } export namespace ListServiceActionsForProvisioningArtifactInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListServiceActionsForProvisioningArtifactInput): any => ({ ...obj, }); @@ -5973,6 +6546,9 @@ export interface ListServiceActionsForProvisioningArtifactOutput { } export namespace ListServiceActionsForProvisioningArtifactOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListServiceActionsForProvisioningArtifactOutput): any => ({ ...obj, }); @@ -6015,6 +6591,9 @@ export interface ListStackInstancesForProvisionedProductInput { } export namespace ListStackInstancesForProvisionedProductInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListStackInstancesForProvisionedProductInput): any => ({ ...obj, }); @@ -6063,6 +6642,9 @@ export interface StackInstance { } export namespace StackInstance { + /** + * @internal + */ export const filterSensitiveLog = (obj: StackInstance): any => ({ ...obj, }); @@ -6081,6 +6663,9 @@ export interface ListStackInstancesForProvisionedProductOutput { } export namespace ListStackInstancesForProvisionedProductOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListStackInstancesForProvisionedProductOutput): any => ({ ...obj, }); @@ -6107,6 +6692,9 @@ export interface ListTagOptionsFilters { } export namespace ListTagOptionsFilters { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListTagOptionsFilters): any => ({ ...obj, }); @@ -6130,6 +6718,9 @@ export interface ListTagOptionsInput { } export namespace ListTagOptionsInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListTagOptionsInput): any => ({ ...obj, }); @@ -6148,6 +6739,9 @@ export interface ListTagOptionsOutput { } export namespace ListTagOptionsOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListTagOptionsOutput): any => ({ ...obj, }); @@ -6169,6 +6763,9 @@ export interface ProvisioningParameter { } export namespace ProvisioningParameter { + /** + * @internal + */ export const filterSensitiveLog = (obj: ProvisioningParameter): any => ({ ...obj, }); @@ -6238,6 +6835,9 @@ export interface ProvisioningPreferences { } export namespace ProvisioningPreferences { + /** + * @internal + */ export const filterSensitiveLog = (obj: ProvisioningPreferences): any => ({ ...obj, }); @@ -6330,6 +6930,9 @@ export interface ProvisionProductInput { } export namespace ProvisionProductInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: ProvisionProductInput): any => ({ ...obj, }); @@ -6343,6 +6946,9 @@ export interface ProvisionProductOutput { } export namespace ProvisionProductOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: ProvisionProductOutput): any => ({ ...obj, }); @@ -6397,6 +7003,9 @@ export interface RejectPortfolioShareInput { } export namespace RejectPortfolioShareInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: RejectPortfolioShareInput): any => ({ ...obj, }); @@ -6405,6 +7014,9 @@ export namespace RejectPortfolioShareInput { export interface RejectPortfolioShareOutput {} export namespace RejectPortfolioShareOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: RejectPortfolioShareOutput): any => ({ ...obj, }); @@ -6447,6 +7059,9 @@ export interface ScanProvisionedProductsInput { } export namespace ScanProvisionedProductsInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: ScanProvisionedProductsInput): any => ({ ...obj, }); @@ -6465,6 +7080,9 @@ export interface ScanProvisionedProductsOutput { } export namespace ScanProvisionedProductsOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: ScanProvisionedProductsOutput): any => ({ ...obj, }); @@ -6536,6 +7154,9 @@ export interface SearchProductsInput { } export namespace SearchProductsInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: SearchProductsInput): any => ({ ...obj, }); @@ -6558,6 +7179,9 @@ export interface ProductViewAggregationValue { } export namespace ProductViewAggregationValue { + /** + * @internal + */ export const filterSensitiveLog = (obj: ProductViewAggregationValue): any => ({ ...obj, }); @@ -6581,6 +7205,9 @@ export interface SearchProductsOutput { } export namespace SearchProductsOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: SearchProductsOutput): any => ({ ...obj, }); @@ -6648,6 +7275,9 @@ export interface SearchProductsAsAdminInput { } export namespace SearchProductsAsAdminInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: SearchProductsAsAdminInput): any => ({ ...obj, }); @@ -6666,6 +7296,9 @@ export interface SearchProductsAsAdminOutput { } export namespace SearchProductsAsAdminOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: SearchProductsAsAdminOutput): any => ({ ...obj, }); @@ -6736,6 +7369,9 @@ export interface SearchProvisionedProductsInput { } export namespace SearchProvisionedProductsInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: SearchProvisionedProductsInput): any => ({ ...obj, }); @@ -6915,6 +7551,9 @@ export interface ProvisionedProductAttribute { } export namespace ProvisionedProductAttribute { + /** + * @internal + */ export const filterSensitiveLog = (obj: ProvisionedProductAttribute): any => ({ ...obj, }); @@ -6938,6 +7577,9 @@ export interface SearchProvisionedProductsOutput { } export namespace SearchProvisionedProductsOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: SearchProvisionedProductsOutput): any => ({ ...obj, }); @@ -6999,6 +7641,9 @@ export interface TerminateProvisionedProductInput { } export namespace TerminateProvisionedProductInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: TerminateProvisionedProductInput): any => ({ ...obj, }); @@ -7012,6 +7657,9 @@ export interface TerminateProvisionedProductOutput { } export namespace TerminateProvisionedProductOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: TerminateProvisionedProductOutput): any => ({ ...obj, }); @@ -7105,6 +7753,9 @@ export interface UpdateConstraintInput { } export namespace UpdateConstraintInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateConstraintInput): any => ({ ...obj, }); @@ -7128,6 +7779,9 @@ export interface UpdateConstraintOutput { } export namespace UpdateConstraintOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateConstraintOutput): any => ({ ...obj, }); @@ -7185,6 +7839,9 @@ export interface UpdatePortfolioInput { } export namespace UpdatePortfolioInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdatePortfolioInput): any => ({ ...obj, }); @@ -7203,6 +7860,9 @@ export interface UpdatePortfolioOutput { } export namespace UpdatePortfolioOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdatePortfolioOutput): any => ({ ...obj, }); @@ -7250,6 +7910,9 @@ export interface UpdatePortfolioShareInput { } export namespace UpdatePortfolioShareInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdatePortfolioShareInput): any => ({ ...obj, }); @@ -7270,6 +7933,9 @@ export interface UpdatePortfolioShareOutput { } export namespace UpdatePortfolioShareOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdatePortfolioShareOutput): any => ({ ...obj, }); @@ -7347,6 +8013,9 @@ export interface UpdateProductInput { } export namespace UpdateProductInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateProductInput): any => ({ ...obj, }); @@ -7365,6 +8034,9 @@ export interface UpdateProductOutput { } export namespace UpdateProductOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateProductOutput): any => ({ ...obj, }); @@ -7447,6 +8119,9 @@ export interface UpdateProvisioningPreferences { } export namespace UpdateProvisioningPreferences { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateProvisioningPreferences): any => ({ ...obj, }); @@ -7536,6 +8211,9 @@ export interface UpdateProvisionedProductInput { } export namespace UpdateProvisionedProductInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateProvisionedProductInput): any => ({ ...obj, }); @@ -7549,6 +8227,9 @@ export interface UpdateProvisionedProductOutput { } export namespace UpdateProvisionedProductOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateProvisionedProductOutput): any => ({ ...obj, }); @@ -7614,6 +8295,9 @@ export interface UpdateProvisionedProductPropertiesInput { } export namespace UpdateProvisionedProductPropertiesInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateProvisionedProductPropertiesInput): any => ({ ...obj, }); @@ -7642,6 +8326,9 @@ export interface UpdateProvisionedProductPropertiesOutput { } export namespace UpdateProvisionedProductPropertiesOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateProvisionedProductPropertiesOutput): any => ({ ...obj, }); @@ -7704,6 +8391,9 @@ export interface UpdateProvisioningArtifactInput { } export namespace UpdateProvisioningArtifactInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateProvisioningArtifactInput): any => ({ ...obj, }); @@ -7727,6 +8417,9 @@ export interface UpdateProvisioningArtifactOutput { } export namespace UpdateProvisioningArtifactOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateProvisioningArtifactOutput): any => ({ ...obj, }); @@ -7774,6 +8467,9 @@ export interface UpdateServiceActionInput { } export namespace UpdateServiceActionInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateServiceActionInput): any => ({ ...obj, }); @@ -7787,6 +8483,9 @@ export interface UpdateServiceActionOutput { } export namespace UpdateServiceActionOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateServiceActionOutput): any => ({ ...obj, }); @@ -7810,6 +8509,9 @@ export interface UpdateTagOptionInput { } export namespace UpdateTagOptionInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateTagOptionInput): any => ({ ...obj, }); @@ -7823,6 +8525,9 @@ export interface UpdateTagOptionOutput { } export namespace UpdateTagOptionOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateTagOptionOutput): any => ({ ...obj, }); diff --git a/clients/client-service-quotas/commands/AssociateServiceQuotaTemplateCommand.ts b/clients/client-service-quotas/commands/AssociateServiceQuotaTemplateCommand.ts index ccb8086d054d..d4dcbfa90d7b 100644 --- a/clients/client-service-quotas/commands/AssociateServiceQuotaTemplateCommand.ts +++ b/clients/client-service-quotas/commands/AssociateServiceQuotaTemplateCommand.ts @@ -27,6 +27,20 @@ export interface AssociateServiceQuotaTemplateCommandOutput * 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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ServiceQuotasClient, AssociateServiceQuotaTemplateCommand } from "@aws-sdk/client-service-quotas"; // ES Modules import + * // const { ServiceQuotasClient, AssociateServiceQuotaTemplateCommand } = require("@aws-sdk/client-service-quotas"); // CommonJS import + * const client = new ServiceQuotasClient(config); + * const command = new AssociateServiceQuotaTemplateCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link AssociateServiceQuotaTemplateCommandInput} for command's `input` shape. + * @see {@link AssociateServiceQuotaTemplateCommandOutput} for command's `response` shape. + * @see {@link ServiceQuotasClientResolvedConfig | config} for command's `input` shape. + * */ export class AssociateServiceQuotaTemplateCommand extends $Command< AssociateServiceQuotaTemplateCommandInput, diff --git a/clients/client-service-quotas/commands/DeleteServiceQuotaIncreaseRequestFromTemplateCommand.ts b/clients/client-service-quotas/commands/DeleteServiceQuotaIncreaseRequestFromTemplateCommand.ts index b45f8e1a4591..d6c078664377 100644 --- a/clients/client-service-quotas/commands/DeleteServiceQuotaIncreaseRequestFromTemplateCommand.ts +++ b/clients/client-service-quotas/commands/DeleteServiceQuotaIncreaseRequestFromTemplateCommand.ts @@ -29,6 +29,20 @@ export interface DeleteServiceQuotaIncreaseRequestFromTemplateCommandOutput /** *

Deletes the quota increase request for the specified quota from your quota request * template.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ServiceQuotasClient, DeleteServiceQuotaIncreaseRequestFromTemplateCommand } from "@aws-sdk/client-service-quotas"; // ES Modules import + * // const { ServiceQuotasClient, DeleteServiceQuotaIncreaseRequestFromTemplateCommand } = require("@aws-sdk/client-service-quotas"); // CommonJS import + * const client = new ServiceQuotasClient(config); + * const command = new DeleteServiceQuotaIncreaseRequestFromTemplateCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteServiceQuotaIncreaseRequestFromTemplateCommandInput} for command's `input` shape. + * @see {@link DeleteServiceQuotaIncreaseRequestFromTemplateCommandOutput} for command's `response` shape. + * @see {@link ServiceQuotasClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteServiceQuotaIncreaseRequestFromTemplateCommand extends $Command< DeleteServiceQuotaIncreaseRequestFromTemplateCommandInput, diff --git a/clients/client-service-quotas/commands/DisassociateServiceQuotaTemplateCommand.ts b/clients/client-service-quotas/commands/DisassociateServiceQuotaTemplateCommand.ts index 6e625900efc7..befd216f28a2 100644 --- a/clients/client-service-quotas/commands/DisassociateServiceQuotaTemplateCommand.ts +++ b/clients/client-service-quotas/commands/DisassociateServiceQuotaTemplateCommand.ts @@ -26,6 +26,20 @@ export interface DisassociateServiceQuotaTemplateCommandOutput *

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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ServiceQuotasClient, DisassociateServiceQuotaTemplateCommand } from "@aws-sdk/client-service-quotas"; // ES Modules import + * // const { ServiceQuotasClient, DisassociateServiceQuotaTemplateCommand } = require("@aws-sdk/client-service-quotas"); // CommonJS import + * const client = new ServiceQuotasClient(config); + * const command = new DisassociateServiceQuotaTemplateCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DisassociateServiceQuotaTemplateCommandInput} for command's `input` shape. + * @see {@link DisassociateServiceQuotaTemplateCommandOutput} for command's `response` shape. + * @see {@link ServiceQuotasClientResolvedConfig | config} for command's `input` shape. + * */ export class DisassociateServiceQuotaTemplateCommand extends $Command< DisassociateServiceQuotaTemplateCommandInput, diff --git a/clients/client-service-quotas/commands/GetAWSDefaultServiceQuotaCommand.ts b/clients/client-service-quotas/commands/GetAWSDefaultServiceQuotaCommand.ts index 3fa35b10baf7..950539475d4d 100644 --- a/clients/client-service-quotas/commands/GetAWSDefaultServiceQuotaCommand.ts +++ b/clients/client-service-quotas/commands/GetAWSDefaultServiceQuotaCommand.ts @@ -23,6 +23,20 @@ export interface GetAWSDefaultServiceQuotaCommandOutput extends GetAWSDefaultSer /** *

Retrieves the default value for the specified quota. The default value does not reflect * any quota increases.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ServiceQuotasClient, GetAWSDefaultServiceQuotaCommand } from "@aws-sdk/client-service-quotas"; // ES Modules import + * // const { ServiceQuotasClient, GetAWSDefaultServiceQuotaCommand } = require("@aws-sdk/client-service-quotas"); // CommonJS import + * const client = new ServiceQuotasClient(config); + * const command = new GetAWSDefaultServiceQuotaCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetAWSDefaultServiceQuotaCommandInput} for command's `input` shape. + * @see {@link GetAWSDefaultServiceQuotaCommandOutput} for command's `response` shape. + * @see {@link ServiceQuotasClientResolvedConfig | config} for command's `input` shape. + * */ export class GetAWSDefaultServiceQuotaCommand extends $Command< GetAWSDefaultServiceQuotaCommandInput, diff --git a/clients/client-service-quotas/commands/GetAssociationForServiceQuotaTemplateCommand.ts b/clients/client-service-quotas/commands/GetAssociationForServiceQuotaTemplateCommand.ts index 090559464422..be0b21d7c12d 100644 --- a/clients/client-service-quotas/commands/GetAssociationForServiceQuotaTemplateCommand.ts +++ b/clients/client-service-quotas/commands/GetAssociationForServiceQuotaTemplateCommand.ts @@ -28,6 +28,20 @@ export interface GetAssociationForServiceQuotaTemplateCommandOutput /** *

Retrieves the status of the association for the quota request template.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ServiceQuotasClient, GetAssociationForServiceQuotaTemplateCommand } from "@aws-sdk/client-service-quotas"; // ES Modules import + * // const { ServiceQuotasClient, GetAssociationForServiceQuotaTemplateCommand } = require("@aws-sdk/client-service-quotas"); // CommonJS import + * const client = new ServiceQuotasClient(config); + * const command = new GetAssociationForServiceQuotaTemplateCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetAssociationForServiceQuotaTemplateCommandInput} for command's `input` shape. + * @see {@link GetAssociationForServiceQuotaTemplateCommandOutput} for command's `response` shape. + * @see {@link ServiceQuotasClientResolvedConfig | config} for command's `input` shape. + * */ export class GetAssociationForServiceQuotaTemplateCommand extends $Command< GetAssociationForServiceQuotaTemplateCommandInput, diff --git a/clients/client-service-quotas/commands/GetRequestedServiceQuotaChangeCommand.ts b/clients/client-service-quotas/commands/GetRequestedServiceQuotaChangeCommand.ts index 12e469ab8447..8f245cf87292 100644 --- a/clients/client-service-quotas/commands/GetRequestedServiceQuotaChangeCommand.ts +++ b/clients/client-service-quotas/commands/GetRequestedServiceQuotaChangeCommand.ts @@ -24,6 +24,20 @@ export interface GetRequestedServiceQuotaChangeCommandOutput /** *

Retrieves information about the specified quota increase request.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ServiceQuotasClient, GetRequestedServiceQuotaChangeCommand } from "@aws-sdk/client-service-quotas"; // ES Modules import + * // const { ServiceQuotasClient, GetRequestedServiceQuotaChangeCommand } = require("@aws-sdk/client-service-quotas"); // CommonJS import + * const client = new ServiceQuotasClient(config); + * const command = new GetRequestedServiceQuotaChangeCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetRequestedServiceQuotaChangeCommandInput} for command's `input` shape. + * @see {@link GetRequestedServiceQuotaChangeCommandOutput} for command's `response` shape. + * @see {@link ServiceQuotasClientResolvedConfig | config} for command's `input` shape. + * */ export class GetRequestedServiceQuotaChangeCommand extends $Command< GetRequestedServiceQuotaChangeCommandInput, diff --git a/clients/client-service-quotas/commands/GetServiceQuotaCommand.ts b/clients/client-service-quotas/commands/GetServiceQuotaCommand.ts index 47e9328b83dd..bd1bed63de25 100644 --- a/clients/client-service-quotas/commands/GetServiceQuotaCommand.ts +++ b/clients/client-service-quotas/commands/GetServiceQuotaCommand.ts @@ -24,6 +24,20 @@ export interface GetServiceQuotaCommandOutput extends GetServiceQuotaResponse, _ *

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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ServiceQuotasClient, GetServiceQuotaCommand } from "@aws-sdk/client-service-quotas"; // ES Modules import + * // const { ServiceQuotasClient, GetServiceQuotaCommand } = require("@aws-sdk/client-service-quotas"); // CommonJS import + * const client = new ServiceQuotasClient(config); + * const command = new GetServiceQuotaCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetServiceQuotaCommandInput} for command's `input` shape. + * @see {@link GetServiceQuotaCommandOutput} for command's `response` shape. + * @see {@link ServiceQuotasClientResolvedConfig | config} for command's `input` shape. + * */ export class GetServiceQuotaCommand extends $Command< GetServiceQuotaCommandInput, diff --git a/clients/client-service-quotas/commands/GetServiceQuotaIncreaseRequestFromTemplateCommand.ts b/clients/client-service-quotas/commands/GetServiceQuotaIncreaseRequestFromTemplateCommand.ts index 2dd95d424d62..f8fac1eabbd7 100644 --- a/clients/client-service-quotas/commands/GetServiceQuotaIncreaseRequestFromTemplateCommand.ts +++ b/clients/client-service-quotas/commands/GetServiceQuotaIncreaseRequestFromTemplateCommand.ts @@ -29,6 +29,20 @@ export interface GetServiceQuotaIncreaseRequestFromTemplateCommandOutput /** *

Retrieves information about the specified quota increase request in your quota request * template.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ServiceQuotasClient, GetServiceQuotaIncreaseRequestFromTemplateCommand } from "@aws-sdk/client-service-quotas"; // ES Modules import + * // const { ServiceQuotasClient, GetServiceQuotaIncreaseRequestFromTemplateCommand } = require("@aws-sdk/client-service-quotas"); // CommonJS import + * const client = new ServiceQuotasClient(config); + * const command = new GetServiceQuotaIncreaseRequestFromTemplateCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetServiceQuotaIncreaseRequestFromTemplateCommandInput} for command's `input` shape. + * @see {@link GetServiceQuotaIncreaseRequestFromTemplateCommandOutput} for command's `response` shape. + * @see {@link ServiceQuotasClientResolvedConfig | config} for command's `input` shape. + * */ export class GetServiceQuotaIncreaseRequestFromTemplateCommand extends $Command< GetServiceQuotaIncreaseRequestFromTemplateCommandInput, diff --git a/clients/client-service-quotas/commands/ListAWSDefaultServiceQuotasCommand.ts b/clients/client-service-quotas/commands/ListAWSDefaultServiceQuotasCommand.ts index 8746d29ba478..fa2a772a3743 100644 --- a/clients/client-service-quotas/commands/ListAWSDefaultServiceQuotasCommand.ts +++ b/clients/client-service-quotas/commands/ListAWSDefaultServiceQuotasCommand.ts @@ -25,6 +25,20 @@ export interface ListAWSDefaultServiceQuotasCommandOutput /** *

Lists the default values for the quotas for the specified AWS service. A default value * does not reflect any quota increases.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ServiceQuotasClient, ListAWSDefaultServiceQuotasCommand } from "@aws-sdk/client-service-quotas"; // ES Modules import + * // const { ServiceQuotasClient, ListAWSDefaultServiceQuotasCommand } = require("@aws-sdk/client-service-quotas"); // CommonJS import + * const client = new ServiceQuotasClient(config); + * const command = new ListAWSDefaultServiceQuotasCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListAWSDefaultServiceQuotasCommandInput} for command's `input` shape. + * @see {@link ListAWSDefaultServiceQuotasCommandOutput} for command's `response` shape. + * @see {@link ServiceQuotasClientResolvedConfig | config} for command's `input` shape. + * */ export class ListAWSDefaultServiceQuotasCommand extends $Command< ListAWSDefaultServiceQuotasCommandInput, diff --git a/clients/client-service-quotas/commands/ListRequestedServiceQuotaChangeHistoryByQuotaCommand.ts b/clients/client-service-quotas/commands/ListRequestedServiceQuotaChangeHistoryByQuotaCommand.ts index 52d0de95d468..7c02cb2b3757 100644 --- a/clients/client-service-quotas/commands/ListRequestedServiceQuotaChangeHistoryByQuotaCommand.ts +++ b/clients/client-service-quotas/commands/ListRequestedServiceQuotaChangeHistoryByQuotaCommand.ts @@ -28,6 +28,20 @@ export interface ListRequestedServiceQuotaChangeHistoryByQuotaCommandOutput /** *

Retrieves the quota increase requests for the specified quota.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ServiceQuotasClient, ListRequestedServiceQuotaChangeHistoryByQuotaCommand } from "@aws-sdk/client-service-quotas"; // ES Modules import + * // const { ServiceQuotasClient, ListRequestedServiceQuotaChangeHistoryByQuotaCommand } = require("@aws-sdk/client-service-quotas"); // CommonJS import + * const client = new ServiceQuotasClient(config); + * const command = new ListRequestedServiceQuotaChangeHistoryByQuotaCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListRequestedServiceQuotaChangeHistoryByQuotaCommandInput} for command's `input` shape. + * @see {@link ListRequestedServiceQuotaChangeHistoryByQuotaCommandOutput} for command's `response` shape. + * @see {@link ServiceQuotasClientResolvedConfig | config} for command's `input` shape. + * */ export class ListRequestedServiceQuotaChangeHistoryByQuotaCommand extends $Command< ListRequestedServiceQuotaChangeHistoryByQuotaCommandInput, diff --git a/clients/client-service-quotas/commands/ListRequestedServiceQuotaChangeHistoryCommand.ts b/clients/client-service-quotas/commands/ListRequestedServiceQuotaChangeHistoryCommand.ts index 62087a7dac0e..a1fb919e4c97 100644 --- a/clients/client-service-quotas/commands/ListRequestedServiceQuotaChangeHistoryCommand.ts +++ b/clients/client-service-quotas/commands/ListRequestedServiceQuotaChangeHistoryCommand.ts @@ -28,6 +28,20 @@ export interface ListRequestedServiceQuotaChangeHistoryCommandOutput /** *

Retrieves the quota increase requests for the specified service.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ServiceQuotasClient, ListRequestedServiceQuotaChangeHistoryCommand } from "@aws-sdk/client-service-quotas"; // ES Modules import + * // const { ServiceQuotasClient, ListRequestedServiceQuotaChangeHistoryCommand } = require("@aws-sdk/client-service-quotas"); // CommonJS import + * const client = new ServiceQuotasClient(config); + * const command = new ListRequestedServiceQuotaChangeHistoryCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListRequestedServiceQuotaChangeHistoryCommandInput} for command's `input` shape. + * @see {@link ListRequestedServiceQuotaChangeHistoryCommandOutput} for command's `response` shape. + * @see {@link ServiceQuotasClientResolvedConfig | config} for command's `input` shape. + * */ export class ListRequestedServiceQuotaChangeHistoryCommand extends $Command< ListRequestedServiceQuotaChangeHistoryCommandInput, diff --git a/clients/client-service-quotas/commands/ListServiceQuotaIncreaseRequestsInTemplateCommand.ts b/clients/client-service-quotas/commands/ListServiceQuotaIncreaseRequestsInTemplateCommand.ts index 8c669b510f70..2c0642c45e1d 100644 --- a/clients/client-service-quotas/commands/ListServiceQuotaIncreaseRequestsInTemplateCommand.ts +++ b/clients/client-service-quotas/commands/ListServiceQuotaIncreaseRequestsInTemplateCommand.ts @@ -28,6 +28,20 @@ export interface ListServiceQuotaIncreaseRequestsInTemplateCommandOutput /** *

Lists the quota increase requests in the specified quota request template.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ServiceQuotasClient, ListServiceQuotaIncreaseRequestsInTemplateCommand } from "@aws-sdk/client-service-quotas"; // ES Modules import + * // const { ServiceQuotasClient, ListServiceQuotaIncreaseRequestsInTemplateCommand } = require("@aws-sdk/client-service-quotas"); // CommonJS import + * const client = new ServiceQuotasClient(config); + * const command = new ListServiceQuotaIncreaseRequestsInTemplateCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListServiceQuotaIncreaseRequestsInTemplateCommandInput} for command's `input` shape. + * @see {@link ListServiceQuotaIncreaseRequestsInTemplateCommandOutput} for command's `response` shape. + * @see {@link ServiceQuotasClientResolvedConfig | config} for command's `input` shape. + * */ export class ListServiceQuotaIncreaseRequestsInTemplateCommand extends $Command< ListServiceQuotaIncreaseRequestsInTemplateCommandInput, diff --git a/clients/client-service-quotas/commands/ListServiceQuotasCommand.ts b/clients/client-service-quotas/commands/ListServiceQuotasCommand.ts index 7296d4bc5b74..be709e4a28e0 100644 --- a/clients/client-service-quotas/commands/ListServiceQuotasCommand.ts +++ b/clients/client-service-quotas/commands/ListServiceQuotasCommand.ts @@ -24,6 +24,20 @@ export interface ListServiceQuotasCommandOutput extends ListServiceQuotasRespons *

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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ServiceQuotasClient, ListServiceQuotasCommand } from "@aws-sdk/client-service-quotas"; // ES Modules import + * // const { ServiceQuotasClient, ListServiceQuotasCommand } = require("@aws-sdk/client-service-quotas"); // CommonJS import + * const client = new ServiceQuotasClient(config); + * const command = new ListServiceQuotasCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListServiceQuotasCommandInput} for command's `input` shape. + * @see {@link ListServiceQuotasCommandOutput} for command's `response` shape. + * @see {@link ServiceQuotasClientResolvedConfig | config} for command's `input` shape. + * */ export class ListServiceQuotasCommand extends $Command< ListServiceQuotasCommandInput, diff --git a/clients/client-service-quotas/commands/ListServicesCommand.ts b/clients/client-service-quotas/commands/ListServicesCommand.ts index 34176aa710eb..c9df2eea9bda 100644 --- a/clients/client-service-quotas/commands/ListServicesCommand.ts +++ b/clients/client-service-quotas/commands/ListServicesCommand.ts @@ -22,6 +22,20 @@ export interface ListServicesCommandOutput extends ListServicesResponse, __Metad /** *

Lists the names and codes for the services integrated with Service Quotas.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ServiceQuotasClient, ListServicesCommand } from "@aws-sdk/client-service-quotas"; // ES Modules import + * // const { ServiceQuotasClient, ListServicesCommand } = require("@aws-sdk/client-service-quotas"); // CommonJS import + * const client = new ServiceQuotasClient(config); + * const command = new ListServicesCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListServicesCommandInput} for command's `input` shape. + * @see {@link ListServicesCommandOutput} for command's `response` shape. + * @see {@link ServiceQuotasClientResolvedConfig | config} for command's `input` shape. + * */ export class ListServicesCommand extends $Command< ListServicesCommandInput, diff --git a/clients/client-service-quotas/commands/ListTagsForResourceCommand.ts b/clients/client-service-quotas/commands/ListTagsForResourceCommand.ts index ebcfdfc88e27..cd17b5d0916e 100644 --- a/clients/client-service-quotas/commands/ListTagsForResourceCommand.ts +++ b/clients/client-service-quotas/commands/ListTagsForResourceCommand.ts @@ -22,6 +22,20 @@ export interface ListTagsForResourceCommandOutput extends ListTagsForResourceRes /** *

Returns a list of the tags assigned to the specified applied quota.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ServiceQuotasClient, ListTagsForResourceCommand } from "@aws-sdk/client-service-quotas"; // ES Modules import + * // const { ServiceQuotasClient, ListTagsForResourceCommand } = require("@aws-sdk/client-service-quotas"); // CommonJS import + * const client = new ServiceQuotasClient(config); + * const command = new ListTagsForResourceCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListTagsForResourceCommandInput} for command's `input` shape. + * @see {@link ListTagsForResourceCommandOutput} for command's `response` shape. + * @see {@link ServiceQuotasClientResolvedConfig | config} for command's `input` shape. + * */ export class ListTagsForResourceCommand extends $Command< ListTagsForResourceCommandInput, diff --git a/clients/client-service-quotas/commands/PutServiceQuotaIncreaseRequestIntoTemplateCommand.ts b/clients/client-service-quotas/commands/PutServiceQuotaIncreaseRequestIntoTemplateCommand.ts index 2503effee091..4df0ffc374a7 100644 --- a/clients/client-service-quotas/commands/PutServiceQuotaIncreaseRequestIntoTemplateCommand.ts +++ b/clients/client-service-quotas/commands/PutServiceQuotaIncreaseRequestIntoTemplateCommand.ts @@ -28,6 +28,20 @@ export interface PutServiceQuotaIncreaseRequestIntoTemplateCommandOutput /** *

Adds a quota increase request to your quota request template.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ServiceQuotasClient, PutServiceQuotaIncreaseRequestIntoTemplateCommand } from "@aws-sdk/client-service-quotas"; // ES Modules import + * // const { ServiceQuotasClient, PutServiceQuotaIncreaseRequestIntoTemplateCommand } = require("@aws-sdk/client-service-quotas"); // CommonJS import + * const client = new ServiceQuotasClient(config); + * const command = new PutServiceQuotaIncreaseRequestIntoTemplateCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link PutServiceQuotaIncreaseRequestIntoTemplateCommandInput} for command's `input` shape. + * @see {@link PutServiceQuotaIncreaseRequestIntoTemplateCommandOutput} for command's `response` shape. + * @see {@link ServiceQuotasClientResolvedConfig | config} for command's `input` shape. + * */ export class PutServiceQuotaIncreaseRequestIntoTemplateCommand extends $Command< PutServiceQuotaIncreaseRequestIntoTemplateCommandInput, diff --git a/clients/client-service-quotas/commands/RequestServiceQuotaIncreaseCommand.ts b/clients/client-service-quotas/commands/RequestServiceQuotaIncreaseCommand.ts index 779222c2dac2..6f338450a9d8 100644 --- a/clients/client-service-quotas/commands/RequestServiceQuotaIncreaseCommand.ts +++ b/clients/client-service-quotas/commands/RequestServiceQuotaIncreaseCommand.ts @@ -24,6 +24,20 @@ export interface RequestServiceQuotaIncreaseCommandOutput /** *

Submits a quota increase request for the specified quota.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ServiceQuotasClient, RequestServiceQuotaIncreaseCommand } from "@aws-sdk/client-service-quotas"; // ES Modules import + * // const { ServiceQuotasClient, RequestServiceQuotaIncreaseCommand } = require("@aws-sdk/client-service-quotas"); // CommonJS import + * const client = new ServiceQuotasClient(config); + * const command = new RequestServiceQuotaIncreaseCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link RequestServiceQuotaIncreaseCommandInput} for command's `input` shape. + * @see {@link RequestServiceQuotaIncreaseCommandOutput} for command's `response` shape. + * @see {@link ServiceQuotasClientResolvedConfig | config} for command's `input` shape. + * */ export class RequestServiceQuotaIncreaseCommand extends $Command< RequestServiceQuotaIncreaseCommandInput, diff --git a/clients/client-service-quotas/commands/TagResourceCommand.ts b/clients/client-service-quotas/commands/TagResourceCommand.ts index 34a481992033..791c81e0e9a0 100644 --- a/clients/client-service-quotas/commands/TagResourceCommand.ts +++ b/clients/client-service-quotas/commands/TagResourceCommand.ts @@ -23,6 +23,20 @@ export interface TagResourceCommandOutput extends TagResourceResponse, __Metadat /** *

Adds tags to the specified applied quota. You can include one or more tags to add to the * quota.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ServiceQuotasClient, TagResourceCommand } from "@aws-sdk/client-service-quotas"; // ES Modules import + * // const { ServiceQuotasClient, TagResourceCommand } = require("@aws-sdk/client-service-quotas"); // CommonJS import + * const client = new ServiceQuotasClient(config); + * const command = new TagResourceCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link TagResourceCommandInput} for command's `input` shape. + * @see {@link TagResourceCommandOutput} for command's `response` shape. + * @see {@link ServiceQuotasClientResolvedConfig | config} for command's `input` shape. + * */ export class TagResourceCommand extends $Command< TagResourceCommandInput, diff --git a/clients/client-service-quotas/commands/UntagResourceCommand.ts b/clients/client-service-quotas/commands/UntagResourceCommand.ts index 4cfb8e7a40c3..5531eb568a4f 100644 --- a/clients/client-service-quotas/commands/UntagResourceCommand.ts +++ b/clients/client-service-quotas/commands/UntagResourceCommand.ts @@ -23,6 +23,20 @@ export interface UntagResourceCommandOutput extends UntagResourceResponse, __Met /** *

Removes tags from the specified applied quota. You can specify one or more tags to * remove.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ServiceQuotasClient, UntagResourceCommand } from "@aws-sdk/client-service-quotas"; // ES Modules import + * // const { ServiceQuotasClient, UntagResourceCommand } = require("@aws-sdk/client-service-quotas"); // CommonJS import + * const client = new ServiceQuotasClient(config); + * const command = new UntagResourceCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link UntagResourceCommandInput} for command's `input` shape. + * @see {@link UntagResourceCommandOutput} for command's `response` shape. + * @see {@link ServiceQuotasClientResolvedConfig | config} for command's `input` shape. + * */ export class UntagResourceCommand extends $Command< UntagResourceCommandInput, diff --git a/clients/client-service-quotas/models/models_0.ts b/clients/client-service-quotas/models/models_0.ts index af30c54daa71..c81e5e881369 100644 --- a/clients/client-service-quotas/models/models_0.ts +++ b/clients/client-service-quotas/models/models_0.ts @@ -11,6 +11,9 @@ export interface AccessDeniedException extends __SmithyException, $MetadataBeare } export namespace AccessDeniedException { + /** + * @internal + */ export const filterSensitiveLog = (obj: AccessDeniedException): any => ({ ...obj, }); @@ -19,6 +22,9 @@ export namespace AccessDeniedException { export interface AssociateServiceQuotaTemplateRequest {} export namespace AssociateServiceQuotaTemplateRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: AssociateServiceQuotaTemplateRequest): any => ({ ...obj, }); @@ -27,6 +33,9 @@ export namespace AssociateServiceQuotaTemplateRequest { export interface AssociateServiceQuotaTemplateResponse {} export namespace AssociateServiceQuotaTemplateResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: AssociateServiceQuotaTemplateResponse): any => ({ ...obj, }); @@ -43,6 +52,9 @@ export interface AWSServiceAccessNotEnabledException extends __SmithyException, } export namespace AWSServiceAccessNotEnabledException { + /** + * @internal + */ export const filterSensitiveLog = (obj: AWSServiceAccessNotEnabledException): any => ({ ...obj, }); @@ -58,6 +70,9 @@ export interface DependencyAccessDeniedException extends __SmithyException, $Met } export namespace DependencyAccessDeniedException { + /** + * @internal + */ export const filterSensitiveLog = (obj: DependencyAccessDeniedException): any => ({ ...obj, }); @@ -73,6 +88,9 @@ export interface NoAvailableOrganizationException extends __SmithyException, $Me } export namespace NoAvailableOrganizationException { + /** + * @internal + */ export const filterSensitiveLog = (obj: NoAvailableOrganizationException): any => ({ ...obj, }); @@ -88,6 +106,9 @@ export interface OrganizationNotInAllFeaturesModeException extends __SmithyExcep } export namespace OrganizationNotInAllFeaturesModeException { + /** + * @internal + */ export const filterSensitiveLog = (obj: OrganizationNotInAllFeaturesModeException): any => ({ ...obj, }); @@ -103,6 +124,9 @@ export interface ServiceException extends __SmithyException, $MetadataBearer { } export namespace ServiceException { + /** + * @internal + */ export const filterSensitiveLog = (obj: ServiceException): any => ({ ...obj, }); @@ -118,6 +142,9 @@ export interface TemplatesNotAvailableInRegionException extends __SmithyExceptio } export namespace TemplatesNotAvailableInRegionException { + /** + * @internal + */ export const filterSensitiveLog = (obj: TemplatesNotAvailableInRegionException): any => ({ ...obj, }); @@ -134,6 +161,9 @@ export interface TooManyRequestsException extends __SmithyException, $MetadataBe } export namespace TooManyRequestsException { + /** + * @internal + */ export const filterSensitiveLog = (obj: TooManyRequestsException): any => ({ ...obj, }); @@ -157,6 +187,9 @@ export interface DeleteServiceQuotaIncreaseRequestFromTemplateRequest { } export namespace DeleteServiceQuotaIncreaseRequestFromTemplateRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteServiceQuotaIncreaseRequestFromTemplateRequest): any => ({ ...obj, }); @@ -165,6 +198,9 @@ export namespace DeleteServiceQuotaIncreaseRequestFromTemplateRequest { export interface DeleteServiceQuotaIncreaseRequestFromTemplateResponse {} export namespace DeleteServiceQuotaIncreaseRequestFromTemplateResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteServiceQuotaIncreaseRequestFromTemplateResponse): any => ({ ...obj, }); @@ -180,6 +216,9 @@ export interface IllegalArgumentException extends __SmithyException, $MetadataBe } export namespace IllegalArgumentException { + /** + * @internal + */ export const filterSensitiveLog = (obj: IllegalArgumentException): any => ({ ...obj, }); @@ -195,6 +234,9 @@ export interface NoSuchResourceException extends __SmithyException, $MetadataBea } export namespace NoSuchResourceException { + /** + * @internal + */ export const filterSensitiveLog = (obj: NoSuchResourceException): any => ({ ...obj, }); @@ -203,6 +245,9 @@ export namespace NoSuchResourceException { export interface DisassociateServiceQuotaTemplateRequest {} export namespace DisassociateServiceQuotaTemplateRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DisassociateServiceQuotaTemplateRequest): any => ({ ...obj, }); @@ -211,6 +256,9 @@ export namespace DisassociateServiceQuotaTemplateRequest { export interface DisassociateServiceQuotaTemplateResponse {} export namespace DisassociateServiceQuotaTemplateResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DisassociateServiceQuotaTemplateResponse): any => ({ ...obj, }); @@ -226,6 +274,9 @@ export interface ServiceQuotaTemplateNotInUseException extends __SmithyException } export namespace ServiceQuotaTemplateNotInUseException { + /** + * @internal + */ export const filterSensitiveLog = (obj: ServiceQuotaTemplateNotInUseException): any => ({ ...obj, }); @@ -276,6 +327,9 @@ export interface ErrorReason { } export namespace ErrorReason { + /** + * @internal + */ export const filterSensitiveLog = (obj: ErrorReason): any => ({ ...obj, }); @@ -284,6 +338,9 @@ export namespace ErrorReason { export interface GetAssociationForServiceQuotaTemplateRequest {} export namespace GetAssociationForServiceQuotaTemplateRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetAssociationForServiceQuotaTemplateRequest): any => ({ ...obj, }); @@ -304,6 +361,9 @@ export interface GetAssociationForServiceQuotaTemplateResponse { } export namespace GetAssociationForServiceQuotaTemplateResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetAssociationForServiceQuotaTemplateResponse): any => ({ ...obj, }); @@ -322,6 +382,9 @@ export interface GetAWSDefaultServiceQuotaRequest { } export namespace GetAWSDefaultServiceQuotaRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetAWSDefaultServiceQuotaRequest): any => ({ ...obj, }); @@ -353,6 +416,9 @@ export interface QuotaPeriod { } export namespace QuotaPeriod { + /** + * @internal + */ export const filterSensitiveLog = (obj: QuotaPeriod): any => ({ ...obj, }); @@ -385,6 +451,9 @@ export interface MetricInfo { } export namespace MetricInfo { + /** + * @internal + */ export const filterSensitiveLog = (obj: MetricInfo): any => ({ ...obj, }); @@ -456,6 +525,9 @@ export interface ServiceQuota { } export namespace ServiceQuota { + /** + * @internal + */ export const filterSensitiveLog = (obj: ServiceQuota): any => ({ ...obj, }); @@ -469,6 +541,9 @@ export interface GetAWSDefaultServiceQuotaResponse { } export namespace GetAWSDefaultServiceQuotaResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetAWSDefaultServiceQuotaResponse): any => ({ ...obj, }); @@ -482,6 +557,9 @@ export interface GetRequestedServiceQuotaChangeRequest { } export namespace GetRequestedServiceQuotaChangeRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetRequestedServiceQuotaChangeRequest): any => ({ ...obj, }); @@ -572,6 +650,9 @@ export interface RequestedServiceQuotaChange { } export namespace RequestedServiceQuotaChange { + /** + * @internal + */ export const filterSensitiveLog = (obj: RequestedServiceQuotaChange): any => ({ ...obj, }); @@ -585,6 +666,9 @@ export interface GetRequestedServiceQuotaChangeResponse { } export namespace GetRequestedServiceQuotaChangeResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetRequestedServiceQuotaChangeResponse): any => ({ ...obj, }); @@ -603,6 +687,9 @@ export interface GetServiceQuotaRequest { } export namespace GetServiceQuotaRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetServiceQuotaRequest): any => ({ ...obj, }); @@ -616,6 +703,9 @@ export interface GetServiceQuotaResponse { } export namespace GetServiceQuotaResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetServiceQuotaResponse): any => ({ ...obj, }); @@ -639,6 +729,9 @@ export interface GetServiceQuotaIncreaseRequestFromTemplateRequest { } export namespace GetServiceQuotaIncreaseRequestFromTemplateRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetServiceQuotaIncreaseRequestFromTemplateRequest): any => ({ ...obj, }); @@ -690,6 +783,9 @@ export interface ServiceQuotaIncreaseRequestInTemplate { } export namespace ServiceQuotaIncreaseRequestInTemplate { + /** + * @internal + */ export const filterSensitiveLog = (obj: ServiceQuotaIncreaseRequestInTemplate): any => ({ ...obj, }); @@ -703,6 +799,9 @@ export interface GetServiceQuotaIncreaseRequestFromTemplateResponse { } export namespace GetServiceQuotaIncreaseRequestFromTemplateResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetServiceQuotaIncreaseRequestFromTemplateResponse): any => ({ ...obj, }); @@ -728,6 +827,9 @@ export interface Tag { } export namespace Tag { + /** + * @internal + */ export const filterSensitiveLog = (obj: Tag): any => ({ ...obj, }); @@ -743,6 +845,9 @@ export interface InvalidPaginationTokenException extends __SmithyException, $Met } export namespace InvalidPaginationTokenException { + /** + * @internal + */ export const filterSensitiveLog = (obj: InvalidPaginationTokenException): any => ({ ...obj, }); @@ -758,6 +863,9 @@ export interface InvalidResourceStateException extends __SmithyException, $Metad } export namespace InvalidResourceStateException { + /** + * @internal + */ export const filterSensitiveLog = (obj: InvalidResourceStateException): any => ({ ...obj, }); @@ -782,6 +890,9 @@ export interface ListAWSDefaultServiceQuotasRequest { } export namespace ListAWSDefaultServiceQuotasRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListAWSDefaultServiceQuotasRequest): any => ({ ...obj, }); @@ -801,6 +912,9 @@ export interface ListAWSDefaultServiceQuotasResponse { } export namespace ListAWSDefaultServiceQuotasResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListAWSDefaultServiceQuotasResponse): any => ({ ...obj, }); @@ -830,6 +944,9 @@ export interface ListRequestedServiceQuotaChangeHistoryRequest { } export namespace ListRequestedServiceQuotaChangeHistoryRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListRequestedServiceQuotaChangeHistoryRequest): any => ({ ...obj, }); @@ -849,6 +966,9 @@ export interface ListRequestedServiceQuotaChangeHistoryResponse { } export namespace ListRequestedServiceQuotaChangeHistoryResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListRequestedServiceQuotaChangeHistoryResponse): any => ({ ...obj, }); @@ -883,6 +1003,9 @@ export interface ListRequestedServiceQuotaChangeHistoryByQuotaRequest { } export namespace ListRequestedServiceQuotaChangeHistoryByQuotaRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListRequestedServiceQuotaChangeHistoryByQuotaRequest): any => ({ ...obj, }); @@ -902,6 +1025,9 @@ export interface ListRequestedServiceQuotaChangeHistoryByQuotaResponse { } export namespace ListRequestedServiceQuotaChangeHistoryByQuotaResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListRequestedServiceQuotaChangeHistoryByQuotaResponse): any => ({ ...obj, }); @@ -931,6 +1057,9 @@ export interface ListServiceQuotaIncreaseRequestsInTemplateRequest { } export namespace ListServiceQuotaIncreaseRequestsInTemplateRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListServiceQuotaIncreaseRequestsInTemplateRequest): any => ({ ...obj, }); @@ -950,6 +1079,9 @@ export interface ListServiceQuotaIncreaseRequestsInTemplateResponse { } export namespace ListServiceQuotaIncreaseRequestsInTemplateResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListServiceQuotaIncreaseRequestsInTemplateResponse): any => ({ ...obj, }); @@ -974,6 +1106,9 @@ export interface ListServiceQuotasRequest { } export namespace ListServiceQuotasRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListServiceQuotasRequest): any => ({ ...obj, }); @@ -993,6 +1128,9 @@ export interface ListServiceQuotasResponse { } export namespace ListServiceQuotasResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListServiceQuotasResponse): any => ({ ...obj, }); @@ -1012,6 +1150,9 @@ export interface ListServicesRequest { } export namespace ListServicesRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListServicesRequest): any => ({ ...obj, }); @@ -1033,6 +1174,9 @@ export interface ServiceInfo { } export namespace ServiceInfo { + /** + * @internal + */ export const filterSensitiveLog = (obj: ServiceInfo): any => ({ ...obj, }); @@ -1052,6 +1196,9 @@ export interface ListServicesResponse { } export namespace ListServicesResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListServicesResponse): any => ({ ...obj, }); @@ -1067,6 +1214,9 @@ export interface ListTagsForResourceRequest { } export namespace ListTagsForResourceRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListTagsForResourceRequest): any => ({ ...obj, }); @@ -1080,6 +1230,9 @@ export interface ListTagsForResourceResponse { } export namespace ListTagsForResourceResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListTagsForResourceResponse): any => ({ ...obj, }); @@ -1108,6 +1261,9 @@ export interface PutServiceQuotaIncreaseRequestIntoTemplateRequest { } export namespace PutServiceQuotaIncreaseRequestIntoTemplateRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: PutServiceQuotaIncreaseRequestIntoTemplateRequest): any => ({ ...obj, }); @@ -1121,6 +1277,9 @@ export interface PutServiceQuotaIncreaseRequestIntoTemplateResponse { } export namespace PutServiceQuotaIncreaseRequestIntoTemplateResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: PutServiceQuotaIncreaseRequestIntoTemplateResponse): any => ({ ...obj, }); @@ -1137,6 +1296,9 @@ export interface QuotaExceededException extends __SmithyException, $MetadataBear } export namespace QuotaExceededException { + /** + * @internal + */ export const filterSensitiveLog = (obj: QuotaExceededException): any => ({ ...obj, }); @@ -1160,6 +1322,9 @@ export interface RequestServiceQuotaIncreaseRequest { } export namespace RequestServiceQuotaIncreaseRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: RequestServiceQuotaIncreaseRequest): any => ({ ...obj, }); @@ -1173,6 +1338,9 @@ export interface RequestServiceQuotaIncreaseResponse { } export namespace RequestServiceQuotaIncreaseResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: RequestServiceQuotaIncreaseResponse): any => ({ ...obj, }); @@ -1188,6 +1356,9 @@ export interface ResourceAlreadyExistsException extends __SmithyException, $Meta } export namespace ResourceAlreadyExistsException { + /** + * @internal + */ export const filterSensitiveLog = (obj: ResourceAlreadyExistsException): any => ({ ...obj, }); @@ -1203,6 +1374,9 @@ export interface TagPolicyViolationException extends __SmithyException, $Metadat } export namespace TagPolicyViolationException { + /** + * @internal + */ export const filterSensitiveLog = (obj: TagPolicyViolationException): any => ({ ...obj, }); @@ -1222,6 +1396,9 @@ export interface TagResourceRequest { } export namespace TagResourceRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: TagResourceRequest): any => ({ ...obj, }); @@ -1230,6 +1407,9 @@ export namespace TagResourceRequest { export interface TagResourceResponse {} export namespace TagResourceResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: TagResourceResponse): any => ({ ...obj, }); @@ -1247,6 +1427,9 @@ export interface TooManyTagsException extends __SmithyException, $MetadataBearer } export namespace TooManyTagsException { + /** + * @internal + */ export const filterSensitiveLog = (obj: TooManyTagsException): any => ({ ...obj, }); @@ -1266,6 +1449,9 @@ export interface UntagResourceRequest { } export namespace UntagResourceRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: UntagResourceRequest): any => ({ ...obj, }); @@ -1274,6 +1460,9 @@ export namespace UntagResourceRequest { export interface UntagResourceResponse {} export namespace UntagResourceResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: UntagResourceResponse): any => ({ ...obj, }); diff --git a/clients/client-servicediscovery/commands/CreateHttpNamespaceCommand.ts b/clients/client-servicediscovery/commands/CreateHttpNamespaceCommand.ts index 1530f5b72dfa..44c5381368e6 100644 --- a/clients/client-servicediscovery/commands/CreateHttpNamespaceCommand.ts +++ b/clients/client-servicediscovery/commands/CreateHttpNamespaceCommand.ts @@ -25,6 +25,20 @@ export interface CreateHttpNamespaceCommandOutput extends CreateHttpNamespaceRes * 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 AWS account, see AWS Cloud Map quotas in the * AWS Cloud Map Developer Guide.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ServiceDiscoveryClient, CreateHttpNamespaceCommand } from "@aws-sdk/client-servicediscovery"; // ES Modules import + * // const { ServiceDiscoveryClient, CreateHttpNamespaceCommand } = require("@aws-sdk/client-servicediscovery"); // CommonJS import + * const client = new ServiceDiscoveryClient(config); + * const command = new CreateHttpNamespaceCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreateHttpNamespaceCommandInput} for command's `input` shape. + * @see {@link CreateHttpNamespaceCommandOutput} for command's `response` shape. + * @see {@link ServiceDiscoveryClientResolvedConfig | config} for command's `input` shape. + * */ export class CreateHttpNamespaceCommand extends $Command< CreateHttpNamespaceCommandInput, diff --git a/clients/client-servicediscovery/commands/CreatePrivateDnsNamespaceCommand.ts b/clients/client-servicediscovery/commands/CreatePrivateDnsNamespaceCommand.ts index df112ad427e0..1fbbd44970b1 100644 --- a/clients/client-servicediscovery/commands/CreatePrivateDnsNamespaceCommand.ts +++ b/clients/client-servicediscovery/commands/CreatePrivateDnsNamespaceCommand.ts @@ -27,6 +27,20 @@ export interface CreatePrivateDnsNamespaceCommandOutput extends CreatePrivateDns * backend.example.com. For the current quota on the number of namespaces that you can create using the * same AWS account, see AWS Cloud Map * Limits in the AWS Cloud Map Developer Guide.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ServiceDiscoveryClient, CreatePrivateDnsNamespaceCommand } from "@aws-sdk/client-servicediscovery"; // ES Modules import + * // const { ServiceDiscoveryClient, CreatePrivateDnsNamespaceCommand } = require("@aws-sdk/client-servicediscovery"); // CommonJS import + * const client = new ServiceDiscoveryClient(config); + * const command = new CreatePrivateDnsNamespaceCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreatePrivateDnsNamespaceCommandInput} for command's `input` shape. + * @see {@link CreatePrivateDnsNamespaceCommandOutput} for command's `response` shape. + * @see {@link ServiceDiscoveryClientResolvedConfig | config} for command's `input` shape. + * */ export class CreatePrivateDnsNamespaceCommand extends $Command< CreatePrivateDnsNamespaceCommandInput, diff --git a/clients/client-servicediscovery/commands/CreatePublicDnsNamespaceCommand.ts b/clients/client-servicediscovery/commands/CreatePublicDnsNamespaceCommand.ts index c212c99541e5..408adfb84525 100644 --- a/clients/client-servicediscovery/commands/CreatePublicDnsNamespaceCommand.ts +++ b/clients/client-servicediscovery/commands/CreatePublicDnsNamespaceCommand.ts @@ -26,6 +26,20 @@ export interface CreatePublicDnsNamespaceCommandOutput extends CreatePublicDnsNa * backend, the resulting DNS name for the service will be backend.example.com. For the * current quota on the number of namespaces that you can create using the same AWS account, see AWS Cloud Map Limits in the * AWS Cloud Map Developer Guide.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ServiceDiscoveryClient, CreatePublicDnsNamespaceCommand } from "@aws-sdk/client-servicediscovery"; // ES Modules import + * // const { ServiceDiscoveryClient, CreatePublicDnsNamespaceCommand } = require("@aws-sdk/client-servicediscovery"); // CommonJS import + * const client = new ServiceDiscoveryClient(config); + * const command = new CreatePublicDnsNamespaceCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreatePublicDnsNamespaceCommandInput} for command's `input` shape. + * @see {@link CreatePublicDnsNamespaceCommandOutput} for command's `response` shape. + * @see {@link ServiceDiscoveryClientResolvedConfig | config} for command's `input` shape. + * */ export class CreatePublicDnsNamespaceCommand extends $Command< CreatePublicDnsNamespaceCommandInput, diff --git a/clients/client-servicediscovery/commands/CreateServiceCommand.ts b/clients/client-servicediscovery/commands/CreateServiceCommand.ts index dc3cecc7e863..ea97783510be 100644 --- a/clients/client-servicediscovery/commands/CreateServiceCommand.ts +++ b/clients/client-servicediscovery/commands/CreateServiceCommand.ts @@ -62,6 +62,20 @@ export interface CreateServiceCommandOutput extends CreateServiceResponse, __Met *

For the current quota on the number of instances that you can register using the same namespace and using the * same service, see AWS Cloud Map * Limits in the AWS Cloud Map Developer Guide.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ServiceDiscoveryClient, CreateServiceCommand } from "@aws-sdk/client-servicediscovery"; // ES Modules import + * // const { ServiceDiscoveryClient, CreateServiceCommand } = require("@aws-sdk/client-servicediscovery"); // CommonJS import + * const client = new ServiceDiscoveryClient(config); + * const command = new CreateServiceCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreateServiceCommandInput} for command's `input` shape. + * @see {@link CreateServiceCommandOutput} for command's `response` shape. + * @see {@link ServiceDiscoveryClientResolvedConfig | config} for command's `input` shape. + * */ export class CreateServiceCommand extends $Command< CreateServiceCommandInput, diff --git a/clients/client-servicediscovery/commands/DeleteNamespaceCommand.ts b/clients/client-servicediscovery/commands/DeleteNamespaceCommand.ts index 916e8dbf8d01..3d7b44193ad7 100644 --- a/clients/client-servicediscovery/commands/DeleteNamespaceCommand.ts +++ b/clients/client-servicediscovery/commands/DeleteNamespaceCommand.ts @@ -23,6 +23,20 @@ export interface DeleteNamespaceCommandOutput extends DeleteNamespaceResponse, _ /** *

Deletes a namespace from the current account. If the namespace still contains one or more services, the request * fails.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ServiceDiscoveryClient, DeleteNamespaceCommand } from "@aws-sdk/client-servicediscovery"; // ES Modules import + * // const { ServiceDiscoveryClient, DeleteNamespaceCommand } = require("@aws-sdk/client-servicediscovery"); // CommonJS import + * const client = new ServiceDiscoveryClient(config); + * const command = new DeleteNamespaceCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteNamespaceCommandInput} for command's `input` shape. + * @see {@link DeleteNamespaceCommandOutput} for command's `response` shape. + * @see {@link ServiceDiscoveryClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteNamespaceCommand extends $Command< DeleteNamespaceCommandInput, diff --git a/clients/client-servicediscovery/commands/DeleteServiceCommand.ts b/clients/client-servicediscovery/commands/DeleteServiceCommand.ts index ba3ab5744406..c1f3da742a7d 100644 --- a/clients/client-servicediscovery/commands/DeleteServiceCommand.ts +++ b/clients/client-servicediscovery/commands/DeleteServiceCommand.ts @@ -23,6 +23,20 @@ export interface DeleteServiceCommandOutput extends DeleteServiceResponse, __Met /** *

Deletes a specified service. If the service still contains one or more registered instances, the request * fails.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ServiceDiscoveryClient, DeleteServiceCommand } from "@aws-sdk/client-servicediscovery"; // ES Modules import + * // const { ServiceDiscoveryClient, DeleteServiceCommand } = require("@aws-sdk/client-servicediscovery"); // CommonJS import + * const client = new ServiceDiscoveryClient(config); + * const command = new DeleteServiceCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteServiceCommandInput} for command's `input` shape. + * @see {@link DeleteServiceCommandOutput} for command's `response` shape. + * @see {@link ServiceDiscoveryClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteServiceCommand extends $Command< DeleteServiceCommandInput, diff --git a/clients/client-servicediscovery/commands/DeregisterInstanceCommand.ts b/clients/client-servicediscovery/commands/DeregisterInstanceCommand.ts index f87eb88edd71..52de4d65f35c 100644 --- a/clients/client-servicediscovery/commands/DeregisterInstanceCommand.ts +++ b/clients/client-servicediscovery/commands/DeregisterInstanceCommand.ts @@ -23,6 +23,20 @@ export interface DeregisterInstanceCommandOutput extends DeregisterInstanceRespo /** *

Deletes the Amazon Route 53 DNS records and health check, if any, that AWS Cloud Map created for the specified * instance.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ServiceDiscoveryClient, DeregisterInstanceCommand } from "@aws-sdk/client-servicediscovery"; // ES Modules import + * // const { ServiceDiscoveryClient, DeregisterInstanceCommand } = require("@aws-sdk/client-servicediscovery"); // CommonJS import + * const client = new ServiceDiscoveryClient(config); + * const command = new DeregisterInstanceCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeregisterInstanceCommandInput} for command's `input` shape. + * @see {@link DeregisterInstanceCommandOutput} for command's `response` shape. + * @see {@link ServiceDiscoveryClientResolvedConfig | config} for command's `input` shape. + * */ export class DeregisterInstanceCommand extends $Command< DeregisterInstanceCommandInput, diff --git a/clients/client-servicediscovery/commands/DiscoverInstancesCommand.ts b/clients/client-servicediscovery/commands/DiscoverInstancesCommand.ts index 47e81febcf53..5441e94b10fb 100644 --- a/clients/client-servicediscovery/commands/DiscoverInstancesCommand.ts +++ b/clients/client-servicediscovery/commands/DiscoverInstancesCommand.ts @@ -24,6 +24,20 @@ export interface DiscoverInstancesCommandOutput extends DiscoverInstancesRespons *

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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ServiceDiscoveryClient, DiscoverInstancesCommand } from "@aws-sdk/client-servicediscovery"; // ES Modules import + * // const { ServiceDiscoveryClient, DiscoverInstancesCommand } = require("@aws-sdk/client-servicediscovery"); // CommonJS import + * const client = new ServiceDiscoveryClient(config); + * const command = new DiscoverInstancesCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DiscoverInstancesCommandInput} for command's `input` shape. + * @see {@link DiscoverInstancesCommandOutput} for command's `response` shape. + * @see {@link ServiceDiscoveryClientResolvedConfig | config} for command's `input` shape. + * */ export class DiscoverInstancesCommand extends $Command< DiscoverInstancesCommandInput, diff --git a/clients/client-servicediscovery/commands/GetInstanceCommand.ts b/clients/client-servicediscovery/commands/GetInstanceCommand.ts index 04edae48b5b4..6db7d763ed42 100644 --- a/clients/client-servicediscovery/commands/GetInstanceCommand.ts +++ b/clients/client-servicediscovery/commands/GetInstanceCommand.ts @@ -22,6 +22,20 @@ export interface GetInstanceCommandOutput extends GetInstanceResponse, __Metadat /** *

Gets information about a specified instance.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ServiceDiscoveryClient, GetInstanceCommand } from "@aws-sdk/client-servicediscovery"; // ES Modules import + * // const { ServiceDiscoveryClient, GetInstanceCommand } = require("@aws-sdk/client-servicediscovery"); // CommonJS import + * const client = new ServiceDiscoveryClient(config); + * const command = new GetInstanceCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetInstanceCommandInput} for command's `input` shape. + * @see {@link GetInstanceCommandOutput} for command's `response` shape. + * @see {@link ServiceDiscoveryClientResolvedConfig | config} for command's `input` shape. + * */ export class GetInstanceCommand extends $Command< GetInstanceCommandInput, diff --git a/clients/client-servicediscovery/commands/GetInstancesHealthStatusCommand.ts b/clients/client-servicediscovery/commands/GetInstancesHealthStatusCommand.ts index 9c0e9a1fd790..610e0fe9a135 100644 --- a/clients/client-servicediscovery/commands/GetInstancesHealthStatusCommand.ts +++ b/clients/client-servicediscovery/commands/GetInstancesHealthStatusCommand.ts @@ -27,6 +27,20 @@ export interface GetInstancesHealthStatusCommandOutput extends GetInstancesHealt *

There is a brief delay between when you register an instance and when the health status for the instance is * available.

* + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ServiceDiscoveryClient, GetInstancesHealthStatusCommand } from "@aws-sdk/client-servicediscovery"; // ES Modules import + * // const { ServiceDiscoveryClient, GetInstancesHealthStatusCommand } = require("@aws-sdk/client-servicediscovery"); // CommonJS import + * const client = new ServiceDiscoveryClient(config); + * const command = new GetInstancesHealthStatusCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetInstancesHealthStatusCommandInput} for command's `input` shape. + * @see {@link GetInstancesHealthStatusCommandOutput} for command's `response` shape. + * @see {@link ServiceDiscoveryClientResolvedConfig | config} for command's `input` shape. + * */ export class GetInstancesHealthStatusCommand extends $Command< GetInstancesHealthStatusCommandInput, diff --git a/clients/client-servicediscovery/commands/GetNamespaceCommand.ts b/clients/client-servicediscovery/commands/GetNamespaceCommand.ts index bd07de204684..44df0cbd5855 100644 --- a/clients/client-servicediscovery/commands/GetNamespaceCommand.ts +++ b/clients/client-servicediscovery/commands/GetNamespaceCommand.ts @@ -22,6 +22,20 @@ export interface GetNamespaceCommandOutput extends GetNamespaceResponse, __Metad /** *

Gets information about a namespace.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ServiceDiscoveryClient, GetNamespaceCommand } from "@aws-sdk/client-servicediscovery"; // ES Modules import + * // const { ServiceDiscoveryClient, GetNamespaceCommand } = require("@aws-sdk/client-servicediscovery"); // CommonJS import + * const client = new ServiceDiscoveryClient(config); + * const command = new GetNamespaceCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetNamespaceCommandInput} for command's `input` shape. + * @see {@link GetNamespaceCommandOutput} for command's `response` shape. + * @see {@link ServiceDiscoveryClientResolvedConfig | config} for command's `input` shape. + * */ export class GetNamespaceCommand extends $Command< GetNamespaceCommandInput, diff --git a/clients/client-servicediscovery/commands/GetOperationCommand.ts b/clients/client-servicediscovery/commands/GetOperationCommand.ts index 08cac02e2973..3a50e0834925 100644 --- a/clients/client-servicediscovery/commands/GetOperationCommand.ts +++ b/clients/client-servicediscovery/commands/GetOperationCommand.ts @@ -26,6 +26,20 @@ export interface GetOperationCommandOutput extends GetOperationResponse, __Metad * *

To get a list of operations that match specified criteria, see ListOperations.

* + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ServiceDiscoveryClient, GetOperationCommand } from "@aws-sdk/client-servicediscovery"; // ES Modules import + * // const { ServiceDiscoveryClient, GetOperationCommand } = require("@aws-sdk/client-servicediscovery"); // CommonJS import + * const client = new ServiceDiscoveryClient(config); + * const command = new GetOperationCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetOperationCommandInput} for command's `input` shape. + * @see {@link GetOperationCommandOutput} for command's `response` shape. + * @see {@link ServiceDiscoveryClientResolvedConfig | config} for command's `input` shape. + * */ export class GetOperationCommand extends $Command< GetOperationCommandInput, diff --git a/clients/client-servicediscovery/commands/GetServiceCommand.ts b/clients/client-servicediscovery/commands/GetServiceCommand.ts index f20c967a6e95..54d27c94d258 100644 --- a/clients/client-servicediscovery/commands/GetServiceCommand.ts +++ b/clients/client-servicediscovery/commands/GetServiceCommand.ts @@ -22,6 +22,20 @@ export interface GetServiceCommandOutput extends GetServiceResponse, __MetadataB /** *

Gets the settings for a specified service.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ServiceDiscoveryClient, GetServiceCommand } from "@aws-sdk/client-servicediscovery"; // ES Modules import + * // const { ServiceDiscoveryClient, GetServiceCommand } = require("@aws-sdk/client-servicediscovery"); // CommonJS import + * const client = new ServiceDiscoveryClient(config); + * const command = new GetServiceCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetServiceCommandInput} for command's `input` shape. + * @see {@link GetServiceCommandOutput} for command's `response` shape. + * @see {@link ServiceDiscoveryClientResolvedConfig | config} for command's `input` shape. + * */ export class GetServiceCommand extends $Command< GetServiceCommandInput, diff --git a/clients/client-servicediscovery/commands/ListInstancesCommand.ts b/clients/client-servicediscovery/commands/ListInstancesCommand.ts index 46ca8ec69793..d780e784e18a 100644 --- a/clients/client-servicediscovery/commands/ListInstancesCommand.ts +++ b/clients/client-servicediscovery/commands/ListInstancesCommand.ts @@ -22,6 +22,20 @@ export interface ListInstancesCommandOutput extends ListInstancesResponse, __Met /** *

Lists summary information about the instances that you registered by using a specified service.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ServiceDiscoveryClient, ListInstancesCommand } from "@aws-sdk/client-servicediscovery"; // ES Modules import + * // const { ServiceDiscoveryClient, ListInstancesCommand } = require("@aws-sdk/client-servicediscovery"); // CommonJS import + * const client = new ServiceDiscoveryClient(config); + * const command = new ListInstancesCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListInstancesCommandInput} for command's `input` shape. + * @see {@link ListInstancesCommandOutput} for command's `response` shape. + * @see {@link ServiceDiscoveryClientResolvedConfig | config} for command's `input` shape. + * */ export class ListInstancesCommand extends $Command< ListInstancesCommandInput, diff --git a/clients/client-servicediscovery/commands/ListNamespacesCommand.ts b/clients/client-servicediscovery/commands/ListNamespacesCommand.ts index 3824dc4cf7db..b7ef8f72b172 100644 --- a/clients/client-servicediscovery/commands/ListNamespacesCommand.ts +++ b/clients/client-servicediscovery/commands/ListNamespacesCommand.ts @@ -22,6 +22,20 @@ export interface ListNamespacesCommandOutput extends ListNamespacesResponse, __M /** *

Lists summary information about the namespaces that were created by the current AWS account.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ServiceDiscoveryClient, ListNamespacesCommand } from "@aws-sdk/client-servicediscovery"; // ES Modules import + * // const { ServiceDiscoveryClient, ListNamespacesCommand } = require("@aws-sdk/client-servicediscovery"); // CommonJS import + * const client = new ServiceDiscoveryClient(config); + * const command = new ListNamespacesCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListNamespacesCommandInput} for command's `input` shape. + * @see {@link ListNamespacesCommandOutput} for command's `response` shape. + * @see {@link ServiceDiscoveryClientResolvedConfig | config} for command's `input` shape. + * */ export class ListNamespacesCommand extends $Command< ListNamespacesCommandInput, diff --git a/clients/client-servicediscovery/commands/ListOperationsCommand.ts b/clients/client-servicediscovery/commands/ListOperationsCommand.ts index f0125d3fc505..a8e45a7e3240 100644 --- a/clients/client-servicediscovery/commands/ListOperationsCommand.ts +++ b/clients/client-servicediscovery/commands/ListOperationsCommand.ts @@ -22,6 +22,20 @@ export interface ListOperationsCommandOutput extends ListOperationsResponse, __M /** *

Lists operations that match the criteria that you specify.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ServiceDiscoveryClient, ListOperationsCommand } from "@aws-sdk/client-servicediscovery"; // ES Modules import + * // const { ServiceDiscoveryClient, ListOperationsCommand } = require("@aws-sdk/client-servicediscovery"); // CommonJS import + * const client = new ServiceDiscoveryClient(config); + * const command = new ListOperationsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListOperationsCommandInput} for command's `input` shape. + * @see {@link ListOperationsCommandOutput} for command's `response` shape. + * @see {@link ServiceDiscoveryClientResolvedConfig | config} for command's `input` shape. + * */ export class ListOperationsCommand extends $Command< ListOperationsCommandInput, diff --git a/clients/client-servicediscovery/commands/ListServicesCommand.ts b/clients/client-servicediscovery/commands/ListServicesCommand.ts index 083b24588b8e..2c7a2bfc9b03 100644 --- a/clients/client-servicediscovery/commands/ListServicesCommand.ts +++ b/clients/client-servicediscovery/commands/ListServicesCommand.ts @@ -22,6 +22,20 @@ export interface ListServicesCommandOutput extends ListServicesResponse, __Metad /** *

Lists summary information for all the services that are associated with one or more specified namespaces.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ServiceDiscoveryClient, ListServicesCommand } from "@aws-sdk/client-servicediscovery"; // ES Modules import + * // const { ServiceDiscoveryClient, ListServicesCommand } = require("@aws-sdk/client-servicediscovery"); // CommonJS import + * const client = new ServiceDiscoveryClient(config); + * const command = new ListServicesCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListServicesCommandInput} for command's `input` shape. + * @see {@link ListServicesCommandOutput} for command's `response` shape. + * @see {@link ServiceDiscoveryClientResolvedConfig | config} for command's `input` shape. + * */ export class ListServicesCommand extends $Command< ListServicesCommandInput, diff --git a/clients/client-servicediscovery/commands/ListTagsForResourceCommand.ts b/clients/client-servicediscovery/commands/ListTagsForResourceCommand.ts index a1070b3eaace..c7870f8cfdc6 100644 --- a/clients/client-servicediscovery/commands/ListTagsForResourceCommand.ts +++ b/clients/client-servicediscovery/commands/ListTagsForResourceCommand.ts @@ -22,6 +22,20 @@ export interface ListTagsForResourceCommandOutput extends ListTagsForResourceRes /** *

Lists tags for the specified resource.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ServiceDiscoveryClient, ListTagsForResourceCommand } from "@aws-sdk/client-servicediscovery"; // ES Modules import + * // const { ServiceDiscoveryClient, ListTagsForResourceCommand } = require("@aws-sdk/client-servicediscovery"); // CommonJS import + * const client = new ServiceDiscoveryClient(config); + * const command = new ListTagsForResourceCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListTagsForResourceCommandInput} for command's `input` shape. + * @see {@link ListTagsForResourceCommandOutput} for command's `response` shape. + * @see {@link ServiceDiscoveryClientResolvedConfig | config} for command's `input` shape. + * */ export class ListTagsForResourceCommand extends $Command< ListTagsForResourceCommandInput, diff --git a/clients/client-servicediscovery/commands/RegisterInstanceCommand.ts b/clients/client-servicediscovery/commands/RegisterInstanceCommand.ts index c810a1625c22..4e7a0b031882 100644 --- a/clients/client-servicediscovery/commands/RegisterInstanceCommand.ts +++ b/clients/client-servicediscovery/commands/RegisterInstanceCommand.ts @@ -61,6 +61,20 @@ export interface RegisterInstanceCommandOutput extends RegisterInstanceResponse, *

For the current quota on the number of instances that you can register using the same namespace and using the * same service, see AWS Cloud Map * Limits in the AWS Cloud Map Developer Guide.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ServiceDiscoveryClient, RegisterInstanceCommand } from "@aws-sdk/client-servicediscovery"; // ES Modules import + * // const { ServiceDiscoveryClient, RegisterInstanceCommand } = require("@aws-sdk/client-servicediscovery"); // CommonJS import + * const client = new ServiceDiscoveryClient(config); + * const command = new RegisterInstanceCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link RegisterInstanceCommandInput} for command's `input` shape. + * @see {@link RegisterInstanceCommandOutput} for command's `response` shape. + * @see {@link ServiceDiscoveryClientResolvedConfig | config} for command's `input` shape. + * */ export class RegisterInstanceCommand extends $Command< RegisterInstanceCommandInput, diff --git a/clients/client-servicediscovery/commands/TagResourceCommand.ts b/clients/client-servicediscovery/commands/TagResourceCommand.ts index 78670f277d03..1cb19a0b3a38 100644 --- a/clients/client-servicediscovery/commands/TagResourceCommand.ts +++ b/clients/client-servicediscovery/commands/TagResourceCommand.ts @@ -22,6 +22,20 @@ export interface TagResourceCommandOutput extends TagResourceResponse, __Metadat /** *

Adds one or more tags to the specified resource.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ServiceDiscoveryClient, TagResourceCommand } from "@aws-sdk/client-servicediscovery"; // ES Modules import + * // const { ServiceDiscoveryClient, TagResourceCommand } = require("@aws-sdk/client-servicediscovery"); // CommonJS import + * const client = new ServiceDiscoveryClient(config); + * const command = new TagResourceCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link TagResourceCommandInput} for command's `input` shape. + * @see {@link TagResourceCommandOutput} for command's `response` shape. + * @see {@link ServiceDiscoveryClientResolvedConfig | config} for command's `input` shape. + * */ export class TagResourceCommand extends $Command< TagResourceCommandInput, diff --git a/clients/client-servicediscovery/commands/UntagResourceCommand.ts b/clients/client-servicediscovery/commands/UntagResourceCommand.ts index 653a007405e3..deb646794992 100644 --- a/clients/client-servicediscovery/commands/UntagResourceCommand.ts +++ b/clients/client-servicediscovery/commands/UntagResourceCommand.ts @@ -22,6 +22,20 @@ export interface UntagResourceCommandOutput extends UntagResourceResponse, __Met /** *

Removes one or more tags from the specified resource.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ServiceDiscoveryClient, UntagResourceCommand } from "@aws-sdk/client-servicediscovery"; // ES Modules import + * // const { ServiceDiscoveryClient, UntagResourceCommand } = require("@aws-sdk/client-servicediscovery"); // CommonJS import + * const client = new ServiceDiscoveryClient(config); + * const command = new UntagResourceCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link UntagResourceCommandInput} for command's `input` shape. + * @see {@link UntagResourceCommandOutput} for command's `response` shape. + * @see {@link ServiceDiscoveryClientResolvedConfig | config} for command's `input` shape. + * */ export class UntagResourceCommand extends $Command< UntagResourceCommandInput, diff --git a/clients/client-servicediscovery/commands/UpdateInstanceCustomHealthStatusCommand.ts b/clients/client-servicediscovery/commands/UpdateInstanceCustomHealthStatusCommand.ts index 0ca41db69702..18ae11e9ce0e 100644 --- a/clients/client-servicediscovery/commands/UpdateInstanceCustomHealthStatusCommand.ts +++ b/clients/client-servicediscovery/commands/UpdateInstanceCustomHealthStatusCommand.ts @@ -26,6 +26,20 @@ export interface UpdateInstanceCustomHealthStatusCommandOutput extends __Metadat * 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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ServiceDiscoveryClient, UpdateInstanceCustomHealthStatusCommand } from "@aws-sdk/client-servicediscovery"; // ES Modules import + * // const { ServiceDiscoveryClient, UpdateInstanceCustomHealthStatusCommand } = require("@aws-sdk/client-servicediscovery"); // CommonJS import + * const client = new ServiceDiscoveryClient(config); + * const command = new UpdateInstanceCustomHealthStatusCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link UpdateInstanceCustomHealthStatusCommandInput} for command's `input` shape. + * @see {@link UpdateInstanceCustomHealthStatusCommandOutput} for command's `response` shape. + * @see {@link ServiceDiscoveryClientResolvedConfig | config} for command's `input` shape. + * */ export class UpdateInstanceCustomHealthStatusCommand extends $Command< UpdateInstanceCustomHealthStatusCommandInput, diff --git a/clients/client-servicediscovery/commands/UpdateServiceCommand.ts b/clients/client-servicediscovery/commands/UpdateServiceCommand.ts index cf8f83c4ae00..0df6be6c9230 100644 --- a/clients/client-servicediscovery/commands/UpdateServiceCommand.ts +++ b/clients/client-servicediscovery/commands/UpdateServiceCommand.ts @@ -46,6 +46,20 @@ export interface UpdateServiceCommandOutput extends UpdateServiceResponse, __Met * *

When you update settings for a service, AWS Cloud Map also updates the corresponding settings in all the records * and health checks that were created by using the specified service.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ServiceDiscoveryClient, UpdateServiceCommand } from "@aws-sdk/client-servicediscovery"; // ES Modules import + * // const { ServiceDiscoveryClient, UpdateServiceCommand } = require("@aws-sdk/client-servicediscovery"); // CommonJS import + * const client = new ServiceDiscoveryClient(config); + * const command = new UpdateServiceCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link UpdateServiceCommandInput} for command's `input` shape. + * @see {@link UpdateServiceCommandOutput} for command's `response` shape. + * @see {@link ServiceDiscoveryClientResolvedConfig | config} for command's `input` shape. + * */ export class UpdateServiceCommand extends $Command< UpdateServiceCommandInput, diff --git a/clients/client-servicediscovery/models/models_0.ts b/clients/client-servicediscovery/models/models_0.ts index f5171b691e92..1812c5596216 100644 --- a/clients/client-servicediscovery/models/models_0.ts +++ b/clients/client-servicediscovery/models/models_0.ts @@ -18,6 +18,9 @@ export interface Tag { } export namespace Tag { + /** + * @internal + */ export const filterSensitiveLog = (obj: Tag): any => ({ ...obj, }); @@ -50,6 +53,9 @@ export interface CreateHttpNamespaceRequest { } export namespace CreateHttpNamespaceRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateHttpNamespaceRequest): any => ({ ...obj, }); @@ -64,6 +70,9 @@ export interface CreateHttpNamespaceResponse { } export namespace CreateHttpNamespaceResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateHttpNamespaceResponse): any => ({ ...obj, }); @@ -83,6 +92,9 @@ export interface DuplicateRequest extends __SmithyException, $MetadataBearer { } export namespace DuplicateRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DuplicateRequest): any => ({ ...obj, }); @@ -99,6 +111,9 @@ export interface InvalidInput extends __SmithyException, $MetadataBearer { } export namespace InvalidInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: InvalidInput): any => ({ ...obj, }); @@ -123,6 +138,9 @@ export interface NamespaceAlreadyExists extends __SmithyException, $MetadataBear } export namespace NamespaceAlreadyExists { + /** + * @internal + */ export const filterSensitiveLog = (obj: NamespaceAlreadyExists): any => ({ ...obj, }); @@ -138,6 +156,9 @@ export interface ResourceLimitExceeded extends __SmithyException, $MetadataBeare } export namespace ResourceLimitExceeded { + /** + * @internal + */ export const filterSensitiveLog = (obj: ResourceLimitExceeded): any => ({ ...obj, }); @@ -158,6 +179,9 @@ export interface TooManyTagsException extends __SmithyException, $MetadataBearer } export namespace TooManyTagsException { + /** + * @internal + */ export const filterSensitiveLog = (obj: TooManyTagsException): any => ({ ...obj, }); @@ -196,6 +220,9 @@ export interface CreatePrivateDnsNamespaceRequest { } export namespace CreatePrivateDnsNamespaceRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreatePrivateDnsNamespaceRequest): any => ({ ...obj, }); @@ -210,6 +237,9 @@ export interface CreatePrivateDnsNamespaceResponse { } export namespace CreatePrivateDnsNamespaceResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreatePrivateDnsNamespaceResponse): any => ({ ...obj, }); @@ -242,6 +272,9 @@ export interface CreatePublicDnsNamespaceRequest { } export namespace CreatePublicDnsNamespaceRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreatePublicDnsNamespaceRequest): any => ({ ...obj, }); @@ -256,6 +289,9 @@ export interface CreatePublicDnsNamespaceResponse { } export namespace CreatePublicDnsNamespaceResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreatePublicDnsNamespaceResponse): any => ({ ...obj, }); @@ -411,6 +447,9 @@ export interface DnsRecord { } export namespace DnsRecord { + /** + * @internal + */ export const filterSensitiveLog = (obj: DnsRecord): any => ({ ...obj, }); @@ -479,6 +518,9 @@ export interface DnsConfig { } export namespace DnsConfig { + /** + * @internal + */ export const filterSensitiveLog = (obj: DnsConfig): any => ({ ...obj, }); @@ -604,6 +646,9 @@ export interface HealthCheckConfig { } export namespace HealthCheckConfig { + /** + * @internal + */ export const filterSensitiveLog = (obj: HealthCheckConfig): any => ({ ...obj, }); @@ -683,6 +728,9 @@ export interface HealthCheckCustomConfig { } export namespace HealthCheckCustomConfig { + /** + * @internal + */ export const filterSensitiveLog = (obj: HealthCheckCustomConfig): any => ({ ...obj, }); @@ -783,6 +831,9 @@ export interface CreateServiceRequest { } export namespace CreateServiceRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateServiceRequest): any => ({ ...obj, }); @@ -892,6 +943,9 @@ export interface Service { } export namespace Service { + /** + * @internal + */ export const filterSensitiveLog = (obj: Service): any => ({ ...obj, }); @@ -905,6 +959,9 @@ export interface CreateServiceResponse { } export namespace CreateServiceResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateServiceResponse): any => ({ ...obj, }); @@ -920,6 +977,9 @@ export interface NamespaceNotFound extends __SmithyException, $MetadataBearer { } export namespace NamespaceNotFound { + /** + * @internal + */ export const filterSensitiveLog = (obj: NamespaceNotFound): any => ({ ...obj, }); @@ -944,6 +1004,9 @@ export interface ServiceAlreadyExists extends __SmithyException, $MetadataBearer } export namespace ServiceAlreadyExists { + /** + * @internal + */ export const filterSensitiveLog = (obj: ServiceAlreadyExists): any => ({ ...obj, }); @@ -960,6 +1023,9 @@ export interface CustomHealthNotFound extends __SmithyException, $MetadataBearer } export namespace CustomHealthNotFound { + /** + * @internal + */ export const filterSensitiveLog = (obj: CustomHealthNotFound): any => ({ ...obj, }); @@ -978,6 +1044,9 @@ export interface DeleteNamespaceRequest { } export namespace DeleteNamespaceRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteNamespaceRequest): any => ({ ...obj, }); @@ -992,6 +1061,9 @@ export interface DeleteNamespaceResponse { } export namespace DeleteNamespaceResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteNamespaceResponse): any => ({ ...obj, }); @@ -1008,6 +1080,9 @@ export interface ResourceInUse extends __SmithyException, $MetadataBearer { } export namespace ResourceInUse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ResourceInUse): any => ({ ...obj, }); @@ -1021,6 +1096,9 @@ export interface DeleteServiceRequest { } export namespace DeleteServiceRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteServiceRequest): any => ({ ...obj, }); @@ -1029,6 +1107,9 @@ export namespace DeleteServiceRequest { export interface DeleteServiceResponse {} export namespace DeleteServiceResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteServiceResponse): any => ({ ...obj, }); @@ -1044,6 +1125,9 @@ export interface ServiceNotFound extends __SmithyException, $MetadataBearer { } export namespace ServiceNotFound { + /** + * @internal + */ export const filterSensitiveLog = (obj: ServiceNotFound): any => ({ ...obj, }); @@ -1062,6 +1146,9 @@ export interface DeregisterInstanceRequest { } export namespace DeregisterInstanceRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeregisterInstanceRequest): any => ({ ...obj, }); @@ -1076,6 +1163,9 @@ export interface DeregisterInstanceResponse { } export namespace DeregisterInstanceResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeregisterInstanceResponse): any => ({ ...obj, }); @@ -1092,6 +1182,9 @@ export interface InstanceNotFound extends __SmithyException, $MetadataBearer { } export namespace InstanceNotFound { + /** + * @internal + */ export const filterSensitiveLog = (obj: InstanceNotFound): any => ({ ...obj, }); @@ -1142,6 +1235,9 @@ export interface DiscoverInstancesRequest { } export namespace DiscoverInstancesRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DiscoverInstancesRequest): any => ({ ...obj, }); @@ -1185,6 +1281,9 @@ export interface HttpInstanceSummary { } export namespace HttpInstanceSummary { + /** + * @internal + */ export const filterSensitiveLog = (obj: HttpInstanceSummary): any => ({ ...obj, }); @@ -1198,6 +1297,9 @@ export interface DiscoverInstancesResponse { } export namespace DiscoverInstancesResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DiscoverInstancesResponse): any => ({ ...obj, }); @@ -1215,6 +1317,9 @@ export interface RequestLimitExceeded extends __SmithyException, $MetadataBearer } export namespace RequestLimitExceeded { + /** + * @internal + */ export const filterSensitiveLog = (obj: RequestLimitExceeded): any => ({ ...obj, }); @@ -1233,6 +1338,9 @@ export interface DnsConfigChange { } export namespace DnsConfigChange { + /** + * @internal + */ export const filterSensitiveLog = (obj: DnsConfigChange): any => ({ ...obj, }); @@ -1250,6 +1358,9 @@ export interface DnsProperties { } export namespace DnsProperties { + /** + * @internal + */ export const filterSensitiveLog = (obj: DnsProperties): any => ({ ...obj, }); @@ -1274,6 +1385,9 @@ export interface GetInstanceRequest { } export namespace GetInstanceRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetInstanceRequest): any => ({ ...obj, }); @@ -1410,6 +1524,9 @@ export interface Instance { } export namespace Instance { + /** + * @internal + */ export const filterSensitiveLog = (obj: Instance): any => ({ ...obj, }); @@ -1423,6 +1540,9 @@ export interface GetInstanceResponse { } export namespace GetInstanceResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetInstanceResponse): any => ({ ...obj, }); @@ -1461,6 +1581,9 @@ export interface GetInstancesHealthStatusRequest { } export namespace GetInstancesHealthStatusRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetInstancesHealthStatusRequest): any => ({ ...obj, }); @@ -1482,6 +1605,9 @@ export interface GetInstancesHealthStatusResponse { } export namespace GetInstancesHealthStatusResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetInstancesHealthStatusResponse): any => ({ ...obj, }); @@ -1495,6 +1621,9 @@ export interface GetNamespaceRequest { } export namespace GetNamespaceRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetNamespaceRequest): any => ({ ...obj, }); @@ -1511,6 +1640,9 @@ export interface HttpProperties { } export namespace HttpProperties { + /** + * @internal + */ export const filterSensitiveLog = (obj: HttpProperties): any => ({ ...obj, }); @@ -1533,6 +1665,9 @@ export interface NamespaceProperties { } export namespace NamespaceProperties { + /** + * @internal + */ export const filterSensitiveLog = (obj: NamespaceProperties): any => ({ ...obj, }); @@ -1615,6 +1750,9 @@ export interface Namespace { } export namespace Namespace { + /** + * @internal + */ export const filterSensitiveLog = (obj: Namespace): any => ({ ...obj, }); @@ -1628,6 +1766,9 @@ export interface GetNamespaceResponse { } export namespace GetNamespaceResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetNamespaceResponse): any => ({ ...obj, }); @@ -1641,6 +1782,9 @@ export interface GetOperationRequest { } export namespace GetOperationRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetOperationRequest): any => ({ ...obj, }); @@ -1792,6 +1936,9 @@ export interface Operation { } export namespace Operation { + /** + * @internal + */ export const filterSensitiveLog = (obj: Operation): any => ({ ...obj, }); @@ -1805,6 +1952,9 @@ export interface GetOperationResponse { } export namespace GetOperationResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetOperationResponse): any => ({ ...obj, }); @@ -1820,6 +1970,9 @@ export interface OperationNotFound extends __SmithyException, $MetadataBearer { } export namespace OperationNotFound { + /** + * @internal + */ export const filterSensitiveLog = (obj: OperationNotFound): any => ({ ...obj, }); @@ -1833,6 +1986,9 @@ export interface GetServiceRequest { } export namespace GetServiceRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetServiceRequest): any => ({ ...obj, }); @@ -1846,6 +2002,9 @@ export interface GetServiceResponse { } export namespace GetServiceResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetServiceResponse): any => ({ ...obj, }); @@ -1913,6 +2072,9 @@ export interface InstanceSummary { } export namespace InstanceSummary { + /** + * @internal + */ export const filterSensitiveLog = (obj: InstanceSummary): any => ({ ...obj, }); @@ -1941,6 +2103,9 @@ export interface ListInstancesRequest { } export namespace ListInstancesRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListInstancesRequest): any => ({ ...obj, }); @@ -1961,6 +2126,9 @@ export interface ListInstancesResponse { } export namespace ListInstancesResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListInstancesResponse): any => ({ ...obj, }); @@ -2012,6 +2180,9 @@ export interface NamespaceFilter { } export namespace NamespaceFilter { + /** + * @internal + */ export const filterSensitiveLog = (obj: NamespaceFilter): any => ({ ...obj, }); @@ -2047,6 +2218,9 @@ export interface ListNamespacesRequest { } export namespace ListNamespacesRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListNamespacesRequest): any => ({ ...obj, }); @@ -2099,6 +2273,9 @@ export interface NamespaceSummary { } export namespace NamespaceSummary { + /** + * @internal + */ export const filterSensitiveLog = (obj: NamespaceSummary): any => ({ ...obj, }); @@ -2125,6 +2302,9 @@ export interface ListNamespacesResponse { } export namespace ListNamespacesResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListNamespacesResponse): any => ({ ...obj, }); @@ -2230,6 +2410,9 @@ export interface OperationFilter { } export namespace OperationFilter { + /** + * @internal + */ export const filterSensitiveLog = (obj: OperationFilter): any => ({ ...obj, }); @@ -2265,6 +2448,9 @@ export interface ListOperationsRequest { } export namespace ListOperationsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListOperationsRequest): any => ({ ...obj, }); @@ -2308,6 +2494,9 @@ export interface OperationSummary { } export namespace OperationSummary { + /** + * @internal + */ export const filterSensitiveLog = (obj: OperationSummary): any => ({ ...obj, }); @@ -2333,6 +2522,9 @@ export interface ListOperationsResponse { } export namespace ListOperationsResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListOperationsResponse): any => ({ ...obj, }); @@ -2381,6 +2573,9 @@ export interface ServiceFilter { } export namespace ServiceFilter { + /** + * @internal + */ export const filterSensitiveLog = (obj: ServiceFilter): any => ({ ...obj, }); @@ -2415,6 +2610,9 @@ export interface ListServicesRequest { } export namespace ListServicesRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListServicesRequest): any => ({ ...obj, }); @@ -2602,6 +2800,9 @@ export interface ServiceSummary { } export namespace ServiceSummary { + /** + * @internal + */ export const filterSensitiveLog = (obj: ServiceSummary): any => ({ ...obj, }); @@ -2628,6 +2829,9 @@ export interface ListServicesResponse { } export namespace ListServicesResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListServicesResponse): any => ({ ...obj, }); @@ -2641,6 +2845,9 @@ export interface ListTagsForResourceRequest { } export namespace ListTagsForResourceRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListTagsForResourceRequest): any => ({ ...obj, }); @@ -2654,6 +2861,9 @@ export interface ListTagsForResourceResponse { } export namespace ListTagsForResourceResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListTagsForResourceResponse): any => ({ ...obj, }); @@ -2669,6 +2879,9 @@ export interface ResourceNotFoundException extends __SmithyException, $MetadataB } export namespace ResourceNotFoundException { + /** + * @internal + */ export const filterSensitiveLog = (obj: ResourceNotFoundException): any => ({ ...obj, }); @@ -2820,6 +3033,9 @@ export interface RegisterInstanceRequest { } export namespace RegisterInstanceRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: RegisterInstanceRequest): any => ({ ...obj, }); @@ -2834,6 +3050,9 @@ export interface RegisterInstanceResponse { } export namespace RegisterInstanceResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: RegisterInstanceResponse): any => ({ ...obj, }); @@ -2853,6 +3072,9 @@ export interface TagResourceRequest { } export namespace TagResourceRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: TagResourceRequest): any => ({ ...obj, }); @@ -2861,6 +3083,9 @@ export namespace TagResourceRequest { export interface TagResourceResponse {} export namespace TagResourceResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: TagResourceResponse): any => ({ ...obj, }); @@ -2879,6 +3104,9 @@ export interface UntagResourceRequest { } export namespace UntagResourceRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: UntagResourceRequest): any => ({ ...obj, }); @@ -2887,6 +3115,9 @@ export namespace UntagResourceRequest { export interface UntagResourceResponse {} export namespace UntagResourceResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: UntagResourceResponse): any => ({ ...obj, }); @@ -2911,6 +3142,9 @@ export interface UpdateInstanceCustomHealthStatusRequest { } export namespace UpdateInstanceCustomHealthStatusRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateInstanceCustomHealthStatusRequest): any => ({ ...obj, }); @@ -2996,6 +3230,9 @@ export interface ServiceChange { } export namespace ServiceChange { + /** + * @internal + */ export const filterSensitiveLog = (obj: ServiceChange): any => ({ ...obj, }); @@ -3014,6 +3251,9 @@ export interface UpdateServiceRequest { } export namespace UpdateServiceRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateServiceRequest): any => ({ ...obj, }); @@ -3028,6 +3268,9 @@ export interface UpdateServiceResponse { } export namespace UpdateServiceResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateServiceResponse): any => ({ ...obj, }); diff --git a/clients/client-ses/commands/CloneReceiptRuleSetCommand.ts b/clients/client-ses/commands/CloneReceiptRuleSetCommand.ts index 024b332b016f..369db7d4e297 100644 --- a/clients/client-ses/commands/CloneReceiptRuleSetCommand.ts +++ b/clients/client-ses/commands/CloneReceiptRuleSetCommand.ts @@ -27,6 +27,20 @@ export interface CloneReceiptRuleSetCommandOutput extends CloneReceiptRuleSetRes *

For information about setting up rule sets, see the Amazon SES * Developer Guide.

*

You can execute this operation no more than once per second.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { SESClient, CloneReceiptRuleSetCommand } from "@aws-sdk/client-ses"; // ES Modules import + * // const { SESClient, CloneReceiptRuleSetCommand } = require("@aws-sdk/client-ses"); // CommonJS import + * const client = new SESClient(config); + * const command = new CloneReceiptRuleSetCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CloneReceiptRuleSetCommandInput} for command's `input` shape. + * @see {@link CloneReceiptRuleSetCommandOutput} for command's `response` shape. + * @see {@link SESClientResolvedConfig | config} for command's `input` shape. + * */ export class CloneReceiptRuleSetCommand extends $Command< CloneReceiptRuleSetCommandInput, diff --git a/clients/client-ses/commands/CreateConfigurationSetCommand.ts b/clients/client-ses/commands/CreateConfigurationSetCommand.ts index bcc2b0ce6b0a..f1d6d6d119ea 100644 --- a/clients/client-ses/commands/CreateConfigurationSetCommand.ts +++ b/clients/client-ses/commands/CreateConfigurationSetCommand.ts @@ -26,6 +26,20 @@ export interface CreateConfigurationSetCommandOutput extends CreateConfiguration * using configuration sets, see the Amazon SES Developer * Guide.

*

You can execute this operation no more than once per second.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { SESClient, CreateConfigurationSetCommand } from "@aws-sdk/client-ses"; // ES Modules import + * // const { SESClient, CreateConfigurationSetCommand } = require("@aws-sdk/client-ses"); // CommonJS import + * const client = new SESClient(config); + * const command = new CreateConfigurationSetCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreateConfigurationSetCommandInput} for command's `input` shape. + * @see {@link CreateConfigurationSetCommandOutput} for command's `response` shape. + * @see {@link SESClientResolvedConfig | config} for command's `input` shape. + * */ export class CreateConfigurationSetCommand extends $Command< CreateConfigurationSetCommandInput, diff --git a/clients/client-ses/commands/CreateConfigurationSetEventDestinationCommand.ts b/clients/client-ses/commands/CreateConfigurationSetEventDestinationCommand.ts index 81ed645ec567..26468aa8f3a5 100644 --- a/clients/client-ses/commands/CreateConfigurationSetEventDestinationCommand.ts +++ b/clients/client-ses/commands/CreateConfigurationSetEventDestinationCommand.ts @@ -37,6 +37,20 @@ export interface CreateConfigurationSetEventDestinationCommandOutput * sets, see the Amazon SES Developer * Guide.

*

You can execute this operation no more than once per second.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { SESClient, CreateConfigurationSetEventDestinationCommand } from "@aws-sdk/client-ses"; // ES Modules import + * // const { SESClient, CreateConfigurationSetEventDestinationCommand } = require("@aws-sdk/client-ses"); // CommonJS import + * const client = new SESClient(config); + * const command = new CreateConfigurationSetEventDestinationCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreateConfigurationSetEventDestinationCommandInput} for command's `input` shape. + * @see {@link CreateConfigurationSetEventDestinationCommandOutput} for command's `response` shape. + * @see {@link SESClientResolvedConfig | config} for command's `input` shape. + * */ export class CreateConfigurationSetEventDestinationCommand extends $Command< CreateConfigurationSetEventDestinationCommandInput, diff --git a/clients/client-ses/commands/CreateConfigurationSetTrackingOptionsCommand.ts b/clients/client-ses/commands/CreateConfigurationSetTrackingOptionsCommand.ts index d382b1242d39..3efcbb6a8bef 100644 --- a/clients/client-ses/commands/CreateConfigurationSetTrackingOptionsCommand.ts +++ b/clients/client-ses/commands/CreateConfigurationSetTrackingOptionsCommand.ts @@ -32,6 +32,20 @@ export interface CreateConfigurationSetTrackingOptionsCommandOutput *

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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { SESClient, CreateConfigurationSetTrackingOptionsCommand } from "@aws-sdk/client-ses"; // ES Modules import + * // const { SESClient, CreateConfigurationSetTrackingOptionsCommand } = require("@aws-sdk/client-ses"); // CommonJS import + * const client = new SESClient(config); + * const command = new CreateConfigurationSetTrackingOptionsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreateConfigurationSetTrackingOptionsCommandInput} for command's `input` shape. + * @see {@link CreateConfigurationSetTrackingOptionsCommandOutput} for command's `response` shape. + * @see {@link SESClientResolvedConfig | config} for command's `input` shape. + * */ export class CreateConfigurationSetTrackingOptionsCommand extends $Command< CreateConfigurationSetTrackingOptionsCommandInput, diff --git a/clients/client-ses/commands/CreateCustomVerificationEmailTemplateCommand.ts b/clients/client-ses/commands/CreateCustomVerificationEmailTemplateCommand.ts index 6e9325d5bc0f..3e20ab8d4283 100644 --- a/clients/client-ses/commands/CreateCustomVerificationEmailTemplateCommand.ts +++ b/clients/client-ses/commands/CreateCustomVerificationEmailTemplateCommand.ts @@ -26,6 +26,20 @@ export interface CreateCustomVerificationEmailTemplateCommandOutput extends __Me *

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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { SESClient, CreateCustomVerificationEmailTemplateCommand } from "@aws-sdk/client-ses"; // ES Modules import + * // const { SESClient, CreateCustomVerificationEmailTemplateCommand } = require("@aws-sdk/client-ses"); // CommonJS import + * const client = new SESClient(config); + * const command = new CreateCustomVerificationEmailTemplateCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreateCustomVerificationEmailTemplateCommandInput} for command's `input` shape. + * @see {@link CreateCustomVerificationEmailTemplateCommandOutput} for command's `response` shape. + * @see {@link SESClientResolvedConfig | config} for command's `input` shape. + * */ export class CreateCustomVerificationEmailTemplateCommand extends $Command< CreateCustomVerificationEmailTemplateCommandInput, diff --git a/clients/client-ses/commands/CreateReceiptFilterCommand.ts b/clients/client-ses/commands/CreateReceiptFilterCommand.ts index 725e57ca2c47..f9dbdcfa9a02 100644 --- a/clients/client-ses/commands/CreateReceiptFilterCommand.ts +++ b/clients/client-ses/commands/CreateReceiptFilterCommand.ts @@ -24,6 +24,20 @@ export interface CreateReceiptFilterCommandOutput extends CreateReceiptFilterRes *

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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { SESClient, CreateReceiptFilterCommand } from "@aws-sdk/client-ses"; // ES Modules import + * // const { SESClient, CreateReceiptFilterCommand } = require("@aws-sdk/client-ses"); // CommonJS import + * const client = new SESClient(config); + * const command = new CreateReceiptFilterCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreateReceiptFilterCommandInput} for command's `input` shape. + * @see {@link CreateReceiptFilterCommandOutput} for command's `response` shape. + * @see {@link SESClientResolvedConfig | config} for command's `input` shape. + * */ export class CreateReceiptFilterCommand extends $Command< CreateReceiptFilterCommandInput, diff --git a/clients/client-ses/commands/CreateReceiptRuleCommand.ts b/clients/client-ses/commands/CreateReceiptRuleCommand.ts index 6a556fd73b21..dca1f088c8d5 100644 --- a/clients/client-ses/commands/CreateReceiptRuleCommand.ts +++ b/clients/client-ses/commands/CreateReceiptRuleCommand.ts @@ -25,6 +25,20 @@ export interface CreateReceiptRuleCommandOutput extends CreateReceiptRuleRespons *

For information about setting up receipt rules, see the Amazon SES Developer * Guide.

*

You can execute this operation no more than once per second.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { SESClient, CreateReceiptRuleCommand } from "@aws-sdk/client-ses"; // ES Modules import + * // const { SESClient, CreateReceiptRuleCommand } = require("@aws-sdk/client-ses"); // CommonJS import + * const client = new SESClient(config); + * const command = new CreateReceiptRuleCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreateReceiptRuleCommandInput} for command's `input` shape. + * @see {@link CreateReceiptRuleCommandOutput} for command's `response` shape. + * @see {@link SESClientResolvedConfig | config} for command's `input` shape. + * */ export class CreateReceiptRuleCommand extends $Command< CreateReceiptRuleCommandInput, diff --git a/clients/client-ses/commands/CreateReceiptRuleSetCommand.ts b/clients/client-ses/commands/CreateReceiptRuleSetCommand.ts index aa643a4505a1..39b50d333594 100644 --- a/clients/client-ses/commands/CreateReceiptRuleSetCommand.ts +++ b/clients/client-ses/commands/CreateReceiptRuleSetCommand.ts @@ -25,6 +25,20 @@ export interface CreateReceiptRuleSetCommandOutput extends CreateReceiptRuleSetR *

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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { SESClient, CreateReceiptRuleSetCommand } from "@aws-sdk/client-ses"; // ES Modules import + * // const { SESClient, CreateReceiptRuleSetCommand } = require("@aws-sdk/client-ses"); // CommonJS import + * const client = new SESClient(config); + * const command = new CreateReceiptRuleSetCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreateReceiptRuleSetCommandInput} for command's `input` shape. + * @see {@link CreateReceiptRuleSetCommandOutput} for command's `response` shape. + * @see {@link SESClientResolvedConfig | config} for command's `input` shape. + * */ export class CreateReceiptRuleSetCommand extends $Command< CreateReceiptRuleSetCommandInput, diff --git a/clients/client-ses/commands/CreateTemplateCommand.ts b/clients/client-ses/commands/CreateTemplateCommand.ts index 3ab82338888c..83cab8d1fe12 100644 --- a/clients/client-ses/commands/CreateTemplateCommand.ts +++ b/clients/client-ses/commands/CreateTemplateCommand.ts @@ -25,6 +25,20 @@ export interface CreateTemplateCommandOutput extends CreateTemplateResponse, __M * 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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { SESClient, CreateTemplateCommand } from "@aws-sdk/client-ses"; // ES Modules import + * // const { SESClient, CreateTemplateCommand } = require("@aws-sdk/client-ses"); // CommonJS import + * const client = new SESClient(config); + * const command = new CreateTemplateCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreateTemplateCommandInput} for command's `input` shape. + * @see {@link CreateTemplateCommandOutput} for command's `response` shape. + * @see {@link SESClientResolvedConfig | config} for command's `input` shape. + * */ export class CreateTemplateCommand extends $Command< CreateTemplateCommandInput, diff --git a/clients/client-ses/commands/DeleteConfigurationSetCommand.ts b/clients/client-ses/commands/DeleteConfigurationSetCommand.ts index 2f128eb35013..82a0c383e449 100644 --- a/clients/client-ses/commands/DeleteConfigurationSetCommand.ts +++ b/clients/client-ses/commands/DeleteConfigurationSetCommand.ts @@ -24,6 +24,20 @@ export interface DeleteConfigurationSetCommandOutput extends DeleteConfiguration *

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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { SESClient, DeleteConfigurationSetCommand } from "@aws-sdk/client-ses"; // ES Modules import + * // const { SESClient, DeleteConfigurationSetCommand } = require("@aws-sdk/client-ses"); // CommonJS import + * const client = new SESClient(config); + * const command = new DeleteConfigurationSetCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteConfigurationSetCommandInput} for command's `input` shape. + * @see {@link DeleteConfigurationSetCommandOutput} for command's `response` shape. + * @see {@link SESClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteConfigurationSetCommand extends $Command< DeleteConfigurationSetCommandInput, diff --git a/clients/client-ses/commands/DeleteConfigurationSetEventDestinationCommand.ts b/clients/client-ses/commands/DeleteConfigurationSetEventDestinationCommand.ts index 3cd966ce6a38..d58e9cebbe7f 100644 --- a/clients/client-ses/commands/DeleteConfigurationSetEventDestinationCommand.ts +++ b/clients/client-ses/commands/DeleteConfigurationSetEventDestinationCommand.ts @@ -31,6 +31,20 @@ export interface DeleteConfigurationSetEventDestinationCommandOutput * 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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { SESClient, DeleteConfigurationSetEventDestinationCommand } from "@aws-sdk/client-ses"; // ES Modules import + * // const { SESClient, DeleteConfigurationSetEventDestinationCommand } = require("@aws-sdk/client-ses"); // CommonJS import + * const client = new SESClient(config); + * const command = new DeleteConfigurationSetEventDestinationCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteConfigurationSetEventDestinationCommandInput} for command's `input` shape. + * @see {@link DeleteConfigurationSetEventDestinationCommandOutput} for command's `response` shape. + * @see {@link SESClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteConfigurationSetEventDestinationCommand extends $Command< DeleteConfigurationSetEventDestinationCommandInput, diff --git a/clients/client-ses/commands/DeleteConfigurationSetTrackingOptionsCommand.ts b/clients/client-ses/commands/DeleteConfigurationSetTrackingOptionsCommand.ts index 1b3255ba1317..906418af716c 100644 --- a/clients/client-ses/commands/DeleteConfigurationSetTrackingOptionsCommand.ts +++ b/clients/client-ses/commands/DeleteConfigurationSetTrackingOptionsCommand.ts @@ -37,6 +37,20 @@ export interface DeleteConfigurationSetTrackingOptionsCommandOutput * configuration set to capture open and click events using the standard, * Amazon SES-operated domains.

* + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { SESClient, DeleteConfigurationSetTrackingOptionsCommand } from "@aws-sdk/client-ses"; // ES Modules import + * // const { SESClient, DeleteConfigurationSetTrackingOptionsCommand } = require("@aws-sdk/client-ses"); // CommonJS import + * const client = new SESClient(config); + * const command = new DeleteConfigurationSetTrackingOptionsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteConfigurationSetTrackingOptionsCommandInput} for command's `input` shape. + * @see {@link DeleteConfigurationSetTrackingOptionsCommandOutput} for command's `response` shape. + * @see {@link SESClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteConfigurationSetTrackingOptionsCommand extends $Command< DeleteConfigurationSetTrackingOptionsCommandInput, diff --git a/clients/client-ses/commands/DeleteCustomVerificationEmailTemplateCommand.ts b/clients/client-ses/commands/DeleteCustomVerificationEmailTemplateCommand.ts index d072db7f0bf0..07176461f8d1 100644 --- a/clients/client-ses/commands/DeleteCustomVerificationEmailTemplateCommand.ts +++ b/clients/client-ses/commands/DeleteCustomVerificationEmailTemplateCommand.ts @@ -26,6 +26,20 @@ export interface DeleteCustomVerificationEmailTemplateCommandOutput extends __Me *

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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { SESClient, DeleteCustomVerificationEmailTemplateCommand } from "@aws-sdk/client-ses"; // ES Modules import + * // const { SESClient, DeleteCustomVerificationEmailTemplateCommand } = require("@aws-sdk/client-ses"); // CommonJS import + * const client = new SESClient(config); + * const command = new DeleteCustomVerificationEmailTemplateCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteCustomVerificationEmailTemplateCommandInput} for command's `input` shape. + * @see {@link DeleteCustomVerificationEmailTemplateCommandOutput} for command's `response` shape. + * @see {@link SESClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteCustomVerificationEmailTemplateCommand extends $Command< DeleteCustomVerificationEmailTemplateCommandInput, diff --git a/clients/client-ses/commands/DeleteIdentityCommand.ts b/clients/client-ses/commands/DeleteIdentityCommand.ts index c56bb49b3410..cafa64659aa6 100644 --- a/clients/client-ses/commands/DeleteIdentityCommand.ts +++ b/clients/client-ses/commands/DeleteIdentityCommand.ts @@ -24,6 +24,20 @@ export interface DeleteIdentityCommandOutput extends DeleteIdentityResponse, __M *

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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { SESClient, DeleteIdentityCommand } from "@aws-sdk/client-ses"; // ES Modules import + * // const { SESClient, DeleteIdentityCommand } = require("@aws-sdk/client-ses"); // CommonJS import + * const client = new SESClient(config); + * const command = new DeleteIdentityCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteIdentityCommandInput} for command's `input` shape. + * @see {@link DeleteIdentityCommandOutput} for command's `response` shape. + * @see {@link SESClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteIdentityCommand extends $Command< DeleteIdentityCommandInput, diff --git a/clients/client-ses/commands/DeleteIdentityPolicyCommand.ts b/clients/client-ses/commands/DeleteIdentityPolicyCommand.ts index 5a17352d0695..58fe33c88604 100644 --- a/clients/client-ses/commands/DeleteIdentityPolicyCommand.ts +++ b/clients/client-ses/commands/DeleteIdentityPolicyCommand.ts @@ -33,6 +33,20 @@ export interface DeleteIdentityPolicyCommandOutput extends DeleteIdentityPolicyR * the Amazon SES Developer * Guide.

*

You can execute this operation no more than once per second.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { SESClient, DeleteIdentityPolicyCommand } from "@aws-sdk/client-ses"; // ES Modules import + * // const { SESClient, DeleteIdentityPolicyCommand } = require("@aws-sdk/client-ses"); // CommonJS import + * const client = new SESClient(config); + * const command = new DeleteIdentityPolicyCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteIdentityPolicyCommandInput} for command's `input` shape. + * @see {@link DeleteIdentityPolicyCommandOutput} for command's `response` shape. + * @see {@link SESClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteIdentityPolicyCommand extends $Command< DeleteIdentityPolicyCommandInput, diff --git a/clients/client-ses/commands/DeleteReceiptFilterCommand.ts b/clients/client-ses/commands/DeleteReceiptFilterCommand.ts index 3add2ead3262..ca13c3bb97cd 100644 --- a/clients/client-ses/commands/DeleteReceiptFilterCommand.ts +++ b/clients/client-ses/commands/DeleteReceiptFilterCommand.ts @@ -25,6 +25,20 @@ export interface DeleteReceiptFilterCommandOutput extends DeleteReceiptFilterRes *

For information about managing IP address filters, see the Amazon SES * Developer Guide.

*

You can execute this operation no more than once per second.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { SESClient, DeleteReceiptFilterCommand } from "@aws-sdk/client-ses"; // ES Modules import + * // const { SESClient, DeleteReceiptFilterCommand } = require("@aws-sdk/client-ses"); // CommonJS import + * const client = new SESClient(config); + * const command = new DeleteReceiptFilterCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteReceiptFilterCommandInput} for command's `input` shape. + * @see {@link DeleteReceiptFilterCommandOutput} for command's `response` shape. + * @see {@link SESClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteReceiptFilterCommand extends $Command< DeleteReceiptFilterCommandInput, diff --git a/clients/client-ses/commands/DeleteReceiptRuleCommand.ts b/clients/client-ses/commands/DeleteReceiptRuleCommand.ts index 868af34a3a27..3d022a40ab30 100644 --- a/clients/client-ses/commands/DeleteReceiptRuleCommand.ts +++ b/clients/client-ses/commands/DeleteReceiptRuleCommand.ts @@ -25,6 +25,20 @@ export interface DeleteReceiptRuleCommandOutput extends DeleteReceiptRuleRespons *

For information about managing receipt rules, see the Amazon SES * Developer Guide.

*

You can execute this operation no more than once per second.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { SESClient, DeleteReceiptRuleCommand } from "@aws-sdk/client-ses"; // ES Modules import + * // const { SESClient, DeleteReceiptRuleCommand } = require("@aws-sdk/client-ses"); // CommonJS import + * const client = new SESClient(config); + * const command = new DeleteReceiptRuleCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteReceiptRuleCommandInput} for command's `input` shape. + * @see {@link DeleteReceiptRuleCommandOutput} for command's `response` shape. + * @see {@link SESClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteReceiptRuleCommand extends $Command< DeleteReceiptRuleCommandInput, diff --git a/clients/client-ses/commands/DeleteReceiptRuleSetCommand.ts b/clients/client-ses/commands/DeleteReceiptRuleSetCommand.ts index b4065727b1dc..ae2e5a2d413f 100644 --- a/clients/client-ses/commands/DeleteReceiptRuleSetCommand.ts +++ b/clients/client-ses/commands/DeleteReceiptRuleSetCommand.ts @@ -28,6 +28,20 @@ export interface DeleteReceiptRuleSetCommandOutput extends DeleteReceiptRuleSetR * *

For information about managing receipt rule sets, see the Amazon SES Developer Guide.

*

You can execute this operation no more than once per second.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { SESClient, DeleteReceiptRuleSetCommand } from "@aws-sdk/client-ses"; // ES Modules import + * // const { SESClient, DeleteReceiptRuleSetCommand } = require("@aws-sdk/client-ses"); // CommonJS import + * const client = new SESClient(config); + * const command = new DeleteReceiptRuleSetCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteReceiptRuleSetCommandInput} for command's `input` shape. + * @see {@link DeleteReceiptRuleSetCommandOutput} for command's `response` shape. + * @see {@link SESClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteReceiptRuleSetCommand extends $Command< DeleteReceiptRuleSetCommandInput, diff --git a/clients/client-ses/commands/DeleteTemplateCommand.ts b/clients/client-ses/commands/DeleteTemplateCommand.ts index 554d56c04b6e..e9196c3c2270 100644 --- a/clients/client-ses/commands/DeleteTemplateCommand.ts +++ b/clients/client-ses/commands/DeleteTemplateCommand.ts @@ -23,6 +23,20 @@ export interface DeleteTemplateCommandOutput extends DeleteTemplateResponse, __M /** *

Deletes an email template.

*

You can execute this operation no more than once per second.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { SESClient, DeleteTemplateCommand } from "@aws-sdk/client-ses"; // ES Modules import + * // const { SESClient, DeleteTemplateCommand } = require("@aws-sdk/client-ses"); // CommonJS import + * const client = new SESClient(config); + * const command = new DeleteTemplateCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteTemplateCommandInput} for command's `input` shape. + * @see {@link DeleteTemplateCommandOutput} for command's `response` shape. + * @see {@link SESClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteTemplateCommand extends $Command< DeleteTemplateCommandInput, diff --git a/clients/client-ses/commands/DeleteVerifiedEmailAddressCommand.ts b/clients/client-ses/commands/DeleteVerifiedEmailAddressCommand.ts index 3aed2e5ef54d..e5f03430e7bb 100644 --- a/clients/client-ses/commands/DeleteVerifiedEmailAddressCommand.ts +++ b/clients/client-ses/commands/DeleteVerifiedEmailAddressCommand.ts @@ -23,6 +23,20 @@ export interface DeleteVerifiedEmailAddressCommandOutput extends __MetadataBeare /** *

Deprecated. Use the DeleteIdentity operation to delete email addresses * and domains.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { SESClient, DeleteVerifiedEmailAddressCommand } from "@aws-sdk/client-ses"; // ES Modules import + * // const { SESClient, DeleteVerifiedEmailAddressCommand } = require("@aws-sdk/client-ses"); // CommonJS import + * const client = new SESClient(config); + * const command = new DeleteVerifiedEmailAddressCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteVerifiedEmailAddressCommandInput} for command's `input` shape. + * @see {@link DeleteVerifiedEmailAddressCommandOutput} for command's `response` shape. + * @see {@link SESClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteVerifiedEmailAddressCommand extends $Command< DeleteVerifiedEmailAddressCommandInput, diff --git a/clients/client-ses/commands/DescribeActiveReceiptRuleSetCommand.ts b/clients/client-ses/commands/DescribeActiveReceiptRuleSetCommand.ts index f664e0ed5389..598d8e7fa2ef 100644 --- a/clients/client-ses/commands/DescribeActiveReceiptRuleSetCommand.ts +++ b/clients/client-ses/commands/DescribeActiveReceiptRuleSetCommand.ts @@ -28,6 +28,20 @@ export interface DescribeActiveReceiptRuleSetCommandOutput *

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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { SESClient, DescribeActiveReceiptRuleSetCommand } from "@aws-sdk/client-ses"; // ES Modules import + * // const { SESClient, DescribeActiveReceiptRuleSetCommand } = require("@aws-sdk/client-ses"); // CommonJS import + * const client = new SESClient(config); + * const command = new DescribeActiveReceiptRuleSetCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeActiveReceiptRuleSetCommandInput} for command's `input` shape. + * @see {@link DescribeActiveReceiptRuleSetCommandOutput} for command's `response` shape. + * @see {@link SESClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeActiveReceiptRuleSetCommand extends $Command< DescribeActiveReceiptRuleSetCommandInput, diff --git a/clients/client-ses/commands/DescribeConfigurationSetCommand.ts b/clients/client-ses/commands/DescribeConfigurationSetCommand.ts index f55cc17687b3..f28ea05f1d90 100644 --- a/clients/client-ses/commands/DescribeConfigurationSetCommand.ts +++ b/clients/client-ses/commands/DescribeConfigurationSetCommand.ts @@ -25,6 +25,20 @@ export interface DescribeConfigurationSetCommandOutput extends DescribeConfigura * configuration sets, see the Amazon SES Developer * Guide.

*

You can execute this operation no more than once per second.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { SESClient, DescribeConfigurationSetCommand } from "@aws-sdk/client-ses"; // ES Modules import + * // const { SESClient, DescribeConfigurationSetCommand } = require("@aws-sdk/client-ses"); // CommonJS import + * const client = new SESClient(config); + * const command = new DescribeConfigurationSetCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeConfigurationSetCommandInput} for command's `input` shape. + * @see {@link DescribeConfigurationSetCommandOutput} for command's `response` shape. + * @see {@link SESClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeConfigurationSetCommand extends $Command< DescribeConfigurationSetCommandInput, diff --git a/clients/client-ses/commands/DescribeReceiptRuleCommand.ts b/clients/client-ses/commands/DescribeReceiptRuleCommand.ts index 98d83c99ceba..fe7625c51914 100644 --- a/clients/client-ses/commands/DescribeReceiptRuleCommand.ts +++ b/clients/client-ses/commands/DescribeReceiptRuleCommand.ts @@ -25,6 +25,20 @@ export interface DescribeReceiptRuleCommandOutput extends DescribeReceiptRuleRes *

For information about setting up receipt rules, see the Amazon SES Developer * Guide.

*

You can execute this operation no more than once per second.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { SESClient, DescribeReceiptRuleCommand } from "@aws-sdk/client-ses"; // ES Modules import + * // const { SESClient, DescribeReceiptRuleCommand } = require("@aws-sdk/client-ses"); // CommonJS import + * const client = new SESClient(config); + * const command = new DescribeReceiptRuleCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeReceiptRuleCommandInput} for command's `input` shape. + * @see {@link DescribeReceiptRuleCommandOutput} for command's `response` shape. + * @see {@link SESClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeReceiptRuleCommand extends $Command< DescribeReceiptRuleCommandInput, diff --git a/clients/client-ses/commands/DescribeReceiptRuleSetCommand.ts b/clients/client-ses/commands/DescribeReceiptRuleSetCommand.ts index 2e87c30d5fd2..ad34b852175f 100644 --- a/clients/client-ses/commands/DescribeReceiptRuleSetCommand.ts +++ b/clients/client-ses/commands/DescribeReceiptRuleSetCommand.ts @@ -24,6 +24,20 @@ export interface DescribeReceiptRuleSetCommandOutput extends DescribeReceiptRule *

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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { SESClient, DescribeReceiptRuleSetCommand } from "@aws-sdk/client-ses"; // ES Modules import + * // const { SESClient, DescribeReceiptRuleSetCommand } = require("@aws-sdk/client-ses"); // CommonJS import + * const client = new SESClient(config); + * const command = new DescribeReceiptRuleSetCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeReceiptRuleSetCommandInput} for command's `input` shape. + * @see {@link DescribeReceiptRuleSetCommandOutput} for command's `response` shape. + * @see {@link SESClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeReceiptRuleSetCommand extends $Command< DescribeReceiptRuleSetCommandInput, diff --git a/clients/client-ses/commands/GetAccountSendingEnabledCommand.ts b/clients/client-ses/commands/GetAccountSendingEnabledCommand.ts index aa9da0579928..74c84d943351 100644 --- a/clients/client-ses/commands/GetAccountSendingEnabledCommand.ts +++ b/clients/client-ses/commands/GetAccountSendingEnabledCommand.ts @@ -23,6 +23,20 @@ export interface GetAccountSendingEnabledCommandOutput extends GetAccountSending /** *

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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { SESClient, GetAccountSendingEnabledCommand } from "@aws-sdk/client-ses"; // ES Modules import + * // const { SESClient, GetAccountSendingEnabledCommand } = require("@aws-sdk/client-ses"); // CommonJS import + * const client = new SESClient(config); + * const command = new GetAccountSendingEnabledCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetAccountSendingEnabledCommandInput} for command's `input` shape. + * @see {@link GetAccountSendingEnabledCommandOutput} for command's `response` shape. + * @see {@link SESClientResolvedConfig | config} for command's `input` shape. + * */ export class GetAccountSendingEnabledCommand extends $Command< GetAccountSendingEnabledCommandInput, diff --git a/clients/client-ses/commands/GetCustomVerificationEmailTemplateCommand.ts b/clients/client-ses/commands/GetCustomVerificationEmailTemplateCommand.ts index 24618cdb9d24..575d903715f0 100644 --- a/clients/client-ses/commands/GetCustomVerificationEmailTemplateCommand.ts +++ b/clients/client-ses/commands/GetCustomVerificationEmailTemplateCommand.ts @@ -31,6 +31,20 @@ export interface GetCustomVerificationEmailTemplateCommandOutput *

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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { SESClient, GetCustomVerificationEmailTemplateCommand } from "@aws-sdk/client-ses"; // ES Modules import + * // const { SESClient, GetCustomVerificationEmailTemplateCommand } = require("@aws-sdk/client-ses"); // CommonJS import + * const client = new SESClient(config); + * const command = new GetCustomVerificationEmailTemplateCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetCustomVerificationEmailTemplateCommandInput} for command's `input` shape. + * @see {@link GetCustomVerificationEmailTemplateCommandOutput} for command's `response` shape. + * @see {@link SESClientResolvedConfig | config} for command's `input` shape. + * */ export class GetCustomVerificationEmailTemplateCommand extends $Command< GetCustomVerificationEmailTemplateCommandInput, diff --git a/clients/client-ses/commands/GetIdentityDkimAttributesCommand.ts b/clients/client-ses/commands/GetIdentityDkimAttributesCommand.ts index fd5b1d792828..34d18b221889 100644 --- a/clients/client-ses/commands/GetIdentityDkimAttributesCommand.ts +++ b/clients/client-ses/commands/GetIdentityDkimAttributesCommand.ts @@ -44,6 +44,20 @@ export interface GetIdentityDkimAttributesCommandOutput extends GetIdentityDkimA *

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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { SESClient, GetIdentityDkimAttributesCommand } from "@aws-sdk/client-ses"; // ES Modules import + * // const { SESClient, GetIdentityDkimAttributesCommand } = require("@aws-sdk/client-ses"); // CommonJS import + * const client = new SESClient(config); + * const command = new GetIdentityDkimAttributesCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetIdentityDkimAttributesCommandInput} for command's `input` shape. + * @see {@link GetIdentityDkimAttributesCommandOutput} for command's `response` shape. + * @see {@link SESClientResolvedConfig | config} for command's `input` shape. + * */ export class GetIdentityDkimAttributesCommand extends $Command< GetIdentityDkimAttributesCommandInput, diff --git a/clients/client-ses/commands/GetIdentityMailFromDomainAttributesCommand.ts b/clients/client-ses/commands/GetIdentityMailFromDomainAttributesCommand.ts index 30fd836b50ce..4b4213e1e144 100644 --- a/clients/client-ses/commands/GetIdentityMailFromDomainAttributesCommand.ts +++ b/clients/client-ses/commands/GetIdentityMailFromDomainAttributesCommand.ts @@ -30,6 +30,20 @@ export interface GetIdentityMailFromDomainAttributesCommandOutput * 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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { SESClient, GetIdentityMailFromDomainAttributesCommand } from "@aws-sdk/client-ses"; // ES Modules import + * // const { SESClient, GetIdentityMailFromDomainAttributesCommand } = require("@aws-sdk/client-ses"); // CommonJS import + * const client = new SESClient(config); + * const command = new GetIdentityMailFromDomainAttributesCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetIdentityMailFromDomainAttributesCommandInput} for command's `input` shape. + * @see {@link GetIdentityMailFromDomainAttributesCommandOutput} for command's `response` shape. + * @see {@link SESClientResolvedConfig | config} for command's `input` shape. + * */ export class GetIdentityMailFromDomainAttributesCommand extends $Command< GetIdentityMailFromDomainAttributesCommandInput, diff --git a/clients/client-ses/commands/GetIdentityNotificationAttributesCommand.ts b/clients/client-ses/commands/GetIdentityNotificationAttributesCommand.ts index 3d4c85450dbc..3e338d8faf68 100644 --- a/clients/client-ses/commands/GetIdentityNotificationAttributesCommand.ts +++ b/clients/client-ses/commands/GetIdentityNotificationAttributesCommand.ts @@ -32,6 +32,20 @@ export interface GetIdentityNotificationAttributesCommandOutput * attributes for up to 100 identities at a time.

*

For more information about using notifications with Amazon SES, see the Amazon SES * Developer Guide.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { SESClient, GetIdentityNotificationAttributesCommand } from "@aws-sdk/client-ses"; // ES Modules import + * // const { SESClient, GetIdentityNotificationAttributesCommand } = require("@aws-sdk/client-ses"); // CommonJS import + * const client = new SESClient(config); + * const command = new GetIdentityNotificationAttributesCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetIdentityNotificationAttributesCommandInput} for command's `input` shape. + * @see {@link GetIdentityNotificationAttributesCommandOutput} for command's `response` shape. + * @see {@link SESClientResolvedConfig | config} for command's `input` shape. + * */ export class GetIdentityNotificationAttributesCommand extends $Command< GetIdentityNotificationAttributesCommandInput, diff --git a/clients/client-ses/commands/GetIdentityPoliciesCommand.ts b/clients/client-ses/commands/GetIdentityPoliciesCommand.ts index a376c99d6994..be6ee63c0647 100644 --- a/clients/client-ses/commands/GetIdentityPoliciesCommand.ts +++ b/clients/client-ses/commands/GetIdentityPoliciesCommand.ts @@ -33,6 +33,20 @@ export interface GetIdentityPoliciesCommandOutput extends GetIdentityPoliciesRes * the Amazon SES Developer * Guide.

*

You can execute this operation no more than once per second.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { SESClient, GetIdentityPoliciesCommand } from "@aws-sdk/client-ses"; // ES Modules import + * // const { SESClient, GetIdentityPoliciesCommand } = require("@aws-sdk/client-ses"); // CommonJS import + * const client = new SESClient(config); + * const command = new GetIdentityPoliciesCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetIdentityPoliciesCommandInput} for command's `input` shape. + * @see {@link GetIdentityPoliciesCommandOutput} for command's `response` shape. + * @see {@link SESClientResolvedConfig | config} for command's `input` shape. + * */ export class GetIdentityPoliciesCommand extends $Command< GetIdentityPoliciesCommandInput, diff --git a/clients/client-ses/commands/GetIdentityVerificationAttributesCommand.ts b/clients/client-ses/commands/GetIdentityVerificationAttributesCommand.ts index 7502169d703e..33fa4f0a43a5 100644 --- a/clients/client-ses/commands/GetIdentityVerificationAttributesCommand.ts +++ b/clients/client-ses/commands/GetIdentityVerificationAttributesCommand.ts @@ -42,6 +42,20 @@ export interface GetIdentityVerificationAttributesCommandOutput * 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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { SESClient, GetIdentityVerificationAttributesCommand } from "@aws-sdk/client-ses"; // ES Modules import + * // const { SESClient, GetIdentityVerificationAttributesCommand } = require("@aws-sdk/client-ses"); // CommonJS import + * const client = new SESClient(config); + * const command = new GetIdentityVerificationAttributesCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetIdentityVerificationAttributesCommandInput} for command's `input` shape. + * @see {@link GetIdentityVerificationAttributesCommandOutput} for command's `response` shape. + * @see {@link SESClientResolvedConfig | config} for command's `input` shape. + * */ export class GetIdentityVerificationAttributesCommand extends $Command< GetIdentityVerificationAttributesCommandInput, diff --git a/clients/client-ses/commands/GetSendQuotaCommand.ts b/clients/client-ses/commands/GetSendQuotaCommand.ts index 042a04b344bc..e7869a3b20b9 100644 --- a/clients/client-ses/commands/GetSendQuotaCommand.ts +++ b/clients/client-ses/commands/GetSendQuotaCommand.ts @@ -20,6 +20,20 @@ export interface GetSendQuotaCommandOutput extends GetSendQuotaResponse, __Metad /** *

Provides the sending limits for the Amazon SES account.

*

You can execute this operation no more than once per second.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { SESClient, GetSendQuotaCommand } from "@aws-sdk/client-ses"; // ES Modules import + * // const { SESClient, GetSendQuotaCommand } = require("@aws-sdk/client-ses"); // CommonJS import + * const client = new SESClient(config); + * const command = new GetSendQuotaCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetSendQuotaCommandInput} for command's `input` shape. + * @see {@link GetSendQuotaCommandOutput} for command's `response` shape. + * @see {@link SESClientResolvedConfig | config} for command's `input` shape. + * */ export class GetSendQuotaCommand extends $Command< GetSendQuotaCommandInput, diff --git a/clients/client-ses/commands/GetSendStatisticsCommand.ts b/clients/client-ses/commands/GetSendStatisticsCommand.ts index d0fa1765d752..0b577ce0b5b8 100644 --- a/clients/client-ses/commands/GetSendStatisticsCommand.ts +++ b/clients/client-ses/commands/GetSendStatisticsCommand.ts @@ -25,6 +25,20 @@ export interface GetSendStatisticsCommandOutput extends GetSendStatisticsRespons * 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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { SESClient, GetSendStatisticsCommand } from "@aws-sdk/client-ses"; // ES Modules import + * // const { SESClient, GetSendStatisticsCommand } = require("@aws-sdk/client-ses"); // CommonJS import + * const client = new SESClient(config); + * const command = new GetSendStatisticsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetSendStatisticsCommandInput} for command's `input` shape. + * @see {@link GetSendStatisticsCommandOutput} for command's `response` shape. + * @see {@link SESClientResolvedConfig | config} for command's `input` shape. + * */ export class GetSendStatisticsCommand extends $Command< GetSendStatisticsCommandInput, diff --git a/clients/client-ses/commands/GetTemplateCommand.ts b/clients/client-ses/commands/GetTemplateCommand.ts index f11c09323e40..f13d96285331 100644 --- a/clients/client-ses/commands/GetTemplateCommand.ts +++ b/clients/client-ses/commands/GetTemplateCommand.ts @@ -21,6 +21,20 @@ export interface GetTemplateCommandOutput extends GetTemplateResponse, __Metadat *

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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { SESClient, GetTemplateCommand } from "@aws-sdk/client-ses"; // ES Modules import + * // const { SESClient, GetTemplateCommand } = require("@aws-sdk/client-ses"); // CommonJS import + * const client = new SESClient(config); + * const command = new GetTemplateCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetTemplateCommandInput} for command's `input` shape. + * @see {@link GetTemplateCommandOutput} for command's `response` shape. + * @see {@link SESClientResolvedConfig | config} for command's `input` shape. + * */ export class GetTemplateCommand extends $Command< GetTemplateCommandInput, diff --git a/clients/client-ses/commands/ListConfigurationSetsCommand.ts b/clients/client-ses/commands/ListConfigurationSetsCommand.ts index 5e9cabfa33b1..cb024b7caae2 100644 --- a/clients/client-ses/commands/ListConfigurationSetsCommand.ts +++ b/clients/client-ses/commands/ListConfigurationSetsCommand.ts @@ -31,6 +31,20 @@ export interface ListConfigurationSetsCommandOutput extends ListConfigurationSet * You can then execute the ListConfigurationSets operation again, passing the * NextToken parameter and the value of the NextToken element to retrieve * additional results.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { SESClient, ListConfigurationSetsCommand } from "@aws-sdk/client-ses"; // ES Modules import + * // const { SESClient, ListConfigurationSetsCommand } = require("@aws-sdk/client-ses"); // CommonJS import + * const client = new SESClient(config); + * const command = new ListConfigurationSetsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListConfigurationSetsCommandInput} for command's `input` shape. + * @see {@link ListConfigurationSetsCommandOutput} for command's `response` shape. + * @see {@link SESClientResolvedConfig | config} for command's `input` shape. + * */ export class ListConfigurationSetsCommand extends $Command< ListConfigurationSetsCommandInput, diff --git a/clients/client-ses/commands/ListCustomVerificationEmailTemplatesCommand.ts b/clients/client-ses/commands/ListCustomVerificationEmailTemplatesCommand.ts index 9b3633994487..7f0c3872749d 100644 --- a/clients/client-ses/commands/ListCustomVerificationEmailTemplatesCommand.ts +++ b/clients/client-ses/commands/ListCustomVerificationEmailTemplatesCommand.ts @@ -31,6 +31,20 @@ export interface ListCustomVerificationEmailTemplatesCommandOutput *

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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { SESClient, ListCustomVerificationEmailTemplatesCommand } from "@aws-sdk/client-ses"; // ES Modules import + * // const { SESClient, ListCustomVerificationEmailTemplatesCommand } = require("@aws-sdk/client-ses"); // CommonJS import + * const client = new SESClient(config); + * const command = new ListCustomVerificationEmailTemplatesCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListCustomVerificationEmailTemplatesCommandInput} for command's `input` shape. + * @see {@link ListCustomVerificationEmailTemplatesCommandOutput} for command's `response` shape. + * @see {@link SESClientResolvedConfig | config} for command's `input` shape. + * */ export class ListCustomVerificationEmailTemplatesCommand extends $Command< ListCustomVerificationEmailTemplatesCommandInput, diff --git a/clients/client-ses/commands/ListIdentitiesCommand.ts b/clients/client-ses/commands/ListIdentitiesCommand.ts index a028e459327f..84c81d5088e7 100644 --- a/clients/client-ses/commands/ListIdentitiesCommand.ts +++ b/clients/client-ses/commands/ListIdentitiesCommand.ts @@ -24,6 +24,20 @@ export interface ListIdentitiesCommandOutput extends ListIdentitiesResponse, __M *

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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { SESClient, ListIdentitiesCommand } from "@aws-sdk/client-ses"; // ES Modules import + * // const { SESClient, ListIdentitiesCommand } = require("@aws-sdk/client-ses"); // CommonJS import + * const client = new SESClient(config); + * const command = new ListIdentitiesCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListIdentitiesCommandInput} for command's `input` shape. + * @see {@link ListIdentitiesCommandOutput} for command's `response` shape. + * @see {@link SESClientResolvedConfig | config} for command's `input` shape. + * */ export class ListIdentitiesCommand extends $Command< ListIdentitiesCommandInput, diff --git a/clients/client-ses/commands/ListIdentityPoliciesCommand.ts b/clients/client-ses/commands/ListIdentityPoliciesCommand.ts index ec7857a95949..04bfdf6a2483 100644 --- a/clients/client-ses/commands/ListIdentityPoliciesCommand.ts +++ b/clients/client-ses/commands/ListIdentityPoliciesCommand.ts @@ -33,6 +33,20 @@ export interface ListIdentityPoliciesCommandOutput extends ListIdentityPoliciesR * the Amazon SES Developer * Guide.

*

You can execute this operation no more than once per second.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { SESClient, ListIdentityPoliciesCommand } from "@aws-sdk/client-ses"; // ES Modules import + * // const { SESClient, ListIdentityPoliciesCommand } = require("@aws-sdk/client-ses"); // CommonJS import + * const client = new SESClient(config); + * const command = new ListIdentityPoliciesCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListIdentityPoliciesCommandInput} for command's `input` shape. + * @see {@link ListIdentityPoliciesCommandOutput} for command's `response` shape. + * @see {@link SESClientResolvedConfig | config} for command's `input` shape. + * */ export class ListIdentityPoliciesCommand extends $Command< ListIdentityPoliciesCommandInput, diff --git a/clients/client-ses/commands/ListReceiptFiltersCommand.ts b/clients/client-ses/commands/ListReceiptFiltersCommand.ts index ead53bbc36fb..313f34530b3d 100644 --- a/clients/client-ses/commands/ListReceiptFiltersCommand.ts +++ b/clients/client-ses/commands/ListReceiptFiltersCommand.ts @@ -26,6 +26,20 @@ export interface ListReceiptFiltersCommandOutput extends ListReceiptFiltersRespo *

For information about managing IP address filters, see the Amazon SES * Developer Guide.

*

You can execute this operation no more than once per second.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { SESClient, ListReceiptFiltersCommand } from "@aws-sdk/client-ses"; // ES Modules import + * // const { SESClient, ListReceiptFiltersCommand } = require("@aws-sdk/client-ses"); // CommonJS import + * const client = new SESClient(config); + * const command = new ListReceiptFiltersCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListReceiptFiltersCommandInput} for command's `input` shape. + * @see {@link ListReceiptFiltersCommandOutput} for command's `response` shape. + * @see {@link SESClientResolvedConfig | config} for command's `input` shape. + * */ export class ListReceiptFiltersCommand extends $Command< ListReceiptFiltersCommandInput, diff --git a/clients/client-ses/commands/ListReceiptRuleSetsCommand.ts b/clients/client-ses/commands/ListReceiptRuleSetsCommand.ts index 3167dd19e9f0..f8151d406d90 100644 --- a/clients/client-ses/commands/ListReceiptRuleSetsCommand.ts +++ b/clients/client-ses/commands/ListReceiptRuleSetsCommand.ts @@ -27,6 +27,20 @@ export interface ListReceiptRuleSetsCommandOutput extends ListReceiptRuleSetsRes * 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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { SESClient, ListReceiptRuleSetsCommand } from "@aws-sdk/client-ses"; // ES Modules import + * // const { SESClient, ListReceiptRuleSetsCommand } = require("@aws-sdk/client-ses"); // CommonJS import + * const client = new SESClient(config); + * const command = new ListReceiptRuleSetsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListReceiptRuleSetsCommandInput} for command's `input` shape. + * @see {@link ListReceiptRuleSetsCommandOutput} for command's `response` shape. + * @see {@link SESClientResolvedConfig | config} for command's `input` shape. + * */ export class ListReceiptRuleSetsCommand extends $Command< ListReceiptRuleSetsCommandInput, diff --git a/clients/client-ses/commands/ListTemplatesCommand.ts b/clients/client-ses/commands/ListTemplatesCommand.ts index 090a52fb1832..a74f7b367870 100644 --- a/clients/client-ses/commands/ListTemplatesCommand.ts +++ b/clients/client-ses/commands/ListTemplatesCommand.ts @@ -24,6 +24,20 @@ export interface ListTemplatesCommandOutput extends ListTemplatesResponse, __Met *

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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { SESClient, ListTemplatesCommand } from "@aws-sdk/client-ses"; // ES Modules import + * // const { SESClient, ListTemplatesCommand } = require("@aws-sdk/client-ses"); // CommonJS import + * const client = new SESClient(config); + * const command = new ListTemplatesCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListTemplatesCommandInput} for command's `input` shape. + * @see {@link ListTemplatesCommandOutput} for command's `response` shape. + * @see {@link SESClientResolvedConfig | config} for command's `input` shape. + * */ export class ListTemplatesCommand extends $Command< ListTemplatesCommandInput, diff --git a/clients/client-ses/commands/ListVerifiedEmailAddressesCommand.ts b/clients/client-ses/commands/ListVerifiedEmailAddressesCommand.ts index 36e96a9c0324..079bcacdd4c6 100644 --- a/clients/client-ses/commands/ListVerifiedEmailAddressesCommand.ts +++ b/clients/client-ses/commands/ListVerifiedEmailAddressesCommand.ts @@ -23,6 +23,20 @@ export interface ListVerifiedEmailAddressesCommandOutput extends ListVerifiedEma /** *

Deprecated. Use the ListIdentities operation to list the email addresses * and domains associated with your account.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { SESClient, ListVerifiedEmailAddressesCommand } from "@aws-sdk/client-ses"; // ES Modules import + * // const { SESClient, ListVerifiedEmailAddressesCommand } = require("@aws-sdk/client-ses"); // CommonJS import + * const client = new SESClient(config); + * const command = new ListVerifiedEmailAddressesCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListVerifiedEmailAddressesCommandInput} for command's `input` shape. + * @see {@link ListVerifiedEmailAddressesCommandOutput} for command's `response` shape. + * @see {@link SESClientResolvedConfig | config} for command's `input` shape. + * */ export class ListVerifiedEmailAddressesCommand extends $Command< ListVerifiedEmailAddressesCommandInput, diff --git a/clients/client-ses/commands/PutConfigurationSetDeliveryOptionsCommand.ts b/clients/client-ses/commands/PutConfigurationSetDeliveryOptionsCommand.ts index 6b0e4bf77a91..686aeb455993 100644 --- a/clients/client-ses/commands/PutConfigurationSetDeliveryOptionsCommand.ts +++ b/clients/client-ses/commands/PutConfigurationSetDeliveryOptionsCommand.ts @@ -27,6 +27,20 @@ export interface PutConfigurationSetDeliveryOptionsCommandOutput /** *

Adds or updates the delivery options for a configuration set.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { SESClient, PutConfigurationSetDeliveryOptionsCommand } from "@aws-sdk/client-ses"; // ES Modules import + * // const { SESClient, PutConfigurationSetDeliveryOptionsCommand } = require("@aws-sdk/client-ses"); // CommonJS import + * const client = new SESClient(config); + * const command = new PutConfigurationSetDeliveryOptionsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link PutConfigurationSetDeliveryOptionsCommandInput} for command's `input` shape. + * @see {@link PutConfigurationSetDeliveryOptionsCommandOutput} for command's `response` shape. + * @see {@link SESClientResolvedConfig | config} for command's `input` shape. + * */ export class PutConfigurationSetDeliveryOptionsCommand extends $Command< PutConfigurationSetDeliveryOptionsCommandInput, diff --git a/clients/client-ses/commands/PutIdentityPolicyCommand.ts b/clients/client-ses/commands/PutIdentityPolicyCommand.ts index 2f824213baad..5e1187107924 100644 --- a/clients/client-ses/commands/PutIdentityPolicyCommand.ts +++ b/clients/client-ses/commands/PutIdentityPolicyCommand.ts @@ -32,6 +32,20 @@ export interface PutIdentityPolicyCommandOutput extends PutIdentityPolicyRespons * the Amazon SES Developer * Guide.

*

You can execute this operation no more than once per second.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { SESClient, PutIdentityPolicyCommand } from "@aws-sdk/client-ses"; // ES Modules import + * // const { SESClient, PutIdentityPolicyCommand } = require("@aws-sdk/client-ses"); // CommonJS import + * const client = new SESClient(config); + * const command = new PutIdentityPolicyCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link PutIdentityPolicyCommandInput} for command's `input` shape. + * @see {@link PutIdentityPolicyCommandOutput} for command's `response` shape. + * @see {@link SESClientResolvedConfig | config} for command's `input` shape. + * */ export class PutIdentityPolicyCommand extends $Command< PutIdentityPolicyCommandInput, diff --git a/clients/client-ses/commands/ReorderReceiptRuleSetCommand.ts b/clients/client-ses/commands/ReorderReceiptRuleSetCommand.ts index adf609460ea6..89a76d007e34 100644 --- a/clients/client-ses/commands/ReorderReceiptRuleSetCommand.ts +++ b/clients/client-ses/commands/ReorderReceiptRuleSetCommand.ts @@ -29,6 +29,20 @@ export interface ReorderReceiptRuleSetCommandOutput extends ReorderReceiptRuleSe * *

For information about managing receipt rule sets, see the Amazon SES Developer Guide.

*

You can execute this operation no more than once per second.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { SESClient, ReorderReceiptRuleSetCommand } from "@aws-sdk/client-ses"; // ES Modules import + * // const { SESClient, ReorderReceiptRuleSetCommand } = require("@aws-sdk/client-ses"); // CommonJS import + * const client = new SESClient(config); + * const command = new ReorderReceiptRuleSetCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ReorderReceiptRuleSetCommandInput} for command's `input` shape. + * @see {@link ReorderReceiptRuleSetCommandOutput} for command's `response` shape. + * @see {@link SESClientResolvedConfig | config} for command's `input` shape. + * */ export class ReorderReceiptRuleSetCommand extends $Command< ReorderReceiptRuleSetCommandInput, diff --git a/clients/client-ses/commands/SendBounceCommand.ts b/clients/client-ses/commands/SendBounceCommand.ts index a3f710fca6fe..46b9a17c3574 100644 --- a/clients/client-ses/commands/SendBounceCommand.ts +++ b/clients/client-ses/commands/SendBounceCommand.ts @@ -27,6 +27,20 @@ export interface SendBounceCommandOutput extends SendBounceResponse, __MetadataB *

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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { SESClient, SendBounceCommand } from "@aws-sdk/client-ses"; // ES Modules import + * // const { SESClient, SendBounceCommand } = require("@aws-sdk/client-ses"); // CommonJS import + * const client = new SESClient(config); + * const command = new SendBounceCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link SendBounceCommandInput} for command's `input` shape. + * @see {@link SendBounceCommandOutput} for command's `response` shape. + * @see {@link SESClientResolvedConfig | config} for command's `input` shape. + * */ export class SendBounceCommand extends $Command< SendBounceCommandInput, diff --git a/clients/client-ses/commands/SendBulkTemplatedEmailCommand.ts b/clients/client-ses/commands/SendBulkTemplatedEmailCommand.ts index bacbb1a5972f..be55edcd02f5 100644 --- a/clients/client-ses/commands/SendBulkTemplatedEmailCommand.ts +++ b/clients/client-ses/commands/SendBulkTemplatedEmailCommand.ts @@ -64,6 +64,20 @@ export interface SendBulkTemplatedEmailCommandOutput extends SendBulkTemplatedEm * limited by your account's maximum sending rate.

* * + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { SESClient, SendBulkTemplatedEmailCommand } from "@aws-sdk/client-ses"; // ES Modules import + * // const { SESClient, SendBulkTemplatedEmailCommand } = require("@aws-sdk/client-ses"); // CommonJS import + * const client = new SESClient(config); + * const command = new SendBulkTemplatedEmailCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link SendBulkTemplatedEmailCommandInput} for command's `input` shape. + * @see {@link SendBulkTemplatedEmailCommandOutput} for command's `response` shape. + * @see {@link SESClientResolvedConfig | config} for command's `input` shape. + * */ export class SendBulkTemplatedEmailCommand extends $Command< SendBulkTemplatedEmailCommandInput, diff --git a/clients/client-ses/commands/SendCustomVerificationEmailCommand.ts b/clients/client-ses/commands/SendCustomVerificationEmailCommand.ts index 20906aa43319..2bd3712d432e 100644 --- a/clients/client-ses/commands/SendCustomVerificationEmailCommand.ts +++ b/clients/client-ses/commands/SendCustomVerificationEmailCommand.ts @@ -32,6 +32,20 @@ export interface SendCustomVerificationEmailCommandOutput * Verification Email Templates in the Amazon SES Developer * Guide.

*

You can execute this operation no more than once per second.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { SESClient, SendCustomVerificationEmailCommand } from "@aws-sdk/client-ses"; // ES Modules import + * // const { SESClient, SendCustomVerificationEmailCommand } = require("@aws-sdk/client-ses"); // CommonJS import + * const client = new SESClient(config); + * const command = new SendCustomVerificationEmailCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link SendCustomVerificationEmailCommandInput} for command's `input` shape. + * @see {@link SendCustomVerificationEmailCommandOutput} for command's `response` shape. + * @see {@link SESClientResolvedConfig | config} for command's `input` shape. + * */ export class SendCustomVerificationEmailCommand extends $Command< SendCustomVerificationEmailCommandInput, diff --git a/clients/client-ses/commands/SendEmailCommand.ts b/clients/client-ses/commands/SendEmailCommand.ts index ebb4fd732987..1a50dee8697f 100644 --- a/clients/client-ses/commands/SendEmailCommand.ts +++ b/clients/client-ses/commands/SendEmailCommand.ts @@ -63,6 +63,20 @@ export interface SendEmailCommandOutput extends SendEmailResponse, __MetadataBea * Sending Limits in the Amazon SES Developer Guide. *

* + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { SESClient, SendEmailCommand } from "@aws-sdk/client-ses"; // ES Modules import + * // const { SESClient, SendEmailCommand } = require("@aws-sdk/client-ses"); // CommonJS import + * const client = new SESClient(config); + * const command = new SendEmailCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link SendEmailCommandInput} for command's `input` shape. + * @see {@link SendEmailCommandOutput} for command's `response` shape. + * @see {@link SESClientResolvedConfig | config} for command's `input` shape. + * */ export class SendEmailCommand extends $Command { // Start section: command_properties diff --git a/clients/client-ses/commands/SendRawEmailCommand.ts b/clients/client-ses/commands/SendRawEmailCommand.ts index 1e42b6b633b2..d315c00ca8a1 100644 --- a/clients/client-ses/commands/SendRawEmailCommand.ts +++ b/clients/client-ses/commands/SendRawEmailCommand.ts @@ -127,6 +127,20 @@ export interface SendRawEmailCommandOutput extends SendRawEmailResponse, __Metad *

* * + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { SESClient, SendRawEmailCommand } from "@aws-sdk/client-ses"; // ES Modules import + * // const { SESClient, SendRawEmailCommand } = require("@aws-sdk/client-ses"); // CommonJS import + * const client = new SESClient(config); + * const command = new SendRawEmailCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link SendRawEmailCommandInput} for command's `input` shape. + * @see {@link SendRawEmailCommandOutput} for command's `response` shape. + * @see {@link SESClientResolvedConfig | config} for command's `input` shape. + * */ export class SendRawEmailCommand extends $Command< SendRawEmailCommandInput, diff --git a/clients/client-ses/commands/SendTemplatedEmailCommand.ts b/clients/client-ses/commands/SendTemplatedEmailCommand.ts index 4bf7a1a99560..ba882551486e 100644 --- a/clients/client-ses/commands/SendTemplatedEmailCommand.ts +++ b/clients/client-ses/commands/SendTemplatedEmailCommand.ts @@ -71,6 +71,20 @@ export interface SendTemplatedEmailCommandOutput extends SendTemplatedEmailRespo * Personalized Email Using the Amazon SES API in the Amazon Simple Email Service * Developer Guide.

* + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { SESClient, SendTemplatedEmailCommand } from "@aws-sdk/client-ses"; // ES Modules import + * // const { SESClient, SendTemplatedEmailCommand } = require("@aws-sdk/client-ses"); // CommonJS import + * const client = new SESClient(config); + * const command = new SendTemplatedEmailCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link SendTemplatedEmailCommandInput} for command's `input` shape. + * @see {@link SendTemplatedEmailCommandOutput} for command's `response` shape. + * @see {@link SESClientResolvedConfig | config} for command's `input` shape. + * */ export class SendTemplatedEmailCommand extends $Command< SendTemplatedEmailCommandInput, diff --git a/clients/client-ses/commands/SetActiveReceiptRuleSetCommand.ts b/clients/client-ses/commands/SetActiveReceiptRuleSetCommand.ts index 3bbf94bfe4bd..15a1b9ce2048 100644 --- a/clients/client-ses/commands/SetActiveReceiptRuleSetCommand.ts +++ b/clients/client-ses/commands/SetActiveReceiptRuleSetCommand.ts @@ -28,6 +28,20 @@ export interface SetActiveReceiptRuleSetCommandOutput extends SetActiveReceiptRu * *

For information about managing receipt rule sets, see the Amazon SES Developer Guide.

*

You can execute this operation no more than once per second.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { SESClient, SetActiveReceiptRuleSetCommand } from "@aws-sdk/client-ses"; // ES Modules import + * // const { SESClient, SetActiveReceiptRuleSetCommand } = require("@aws-sdk/client-ses"); // CommonJS import + * const client = new SESClient(config); + * const command = new SetActiveReceiptRuleSetCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link SetActiveReceiptRuleSetCommandInput} for command's `input` shape. + * @see {@link SetActiveReceiptRuleSetCommandOutput} for command's `response` shape. + * @see {@link SESClientResolvedConfig | config} for command's `input` shape. + * */ export class SetActiveReceiptRuleSetCommand extends $Command< SetActiveReceiptRuleSetCommandInput, diff --git a/clients/client-ses/commands/SetIdentityDkimEnabledCommand.ts b/clients/client-ses/commands/SetIdentityDkimEnabledCommand.ts index 347be31f3a79..d9e50dd04e75 100644 --- a/clients/client-ses/commands/SetIdentityDkimEnabledCommand.ts +++ b/clients/client-ses/commands/SetIdentityDkimEnabledCommand.ts @@ -34,6 +34,20 @@ export interface SetIdentityDkimEnabledCommandOutput extends SetIdentityDkimEnab * 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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { SESClient, SetIdentityDkimEnabledCommand } from "@aws-sdk/client-ses"; // ES Modules import + * // const { SESClient, SetIdentityDkimEnabledCommand } = require("@aws-sdk/client-ses"); // CommonJS import + * const client = new SESClient(config); + * const command = new SetIdentityDkimEnabledCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link SetIdentityDkimEnabledCommandInput} for command's `input` shape. + * @see {@link SetIdentityDkimEnabledCommandOutput} for command's `response` shape. + * @see {@link SESClientResolvedConfig | config} for command's `input` shape. + * */ export class SetIdentityDkimEnabledCommand extends $Command< SetIdentityDkimEnabledCommandInput, diff --git a/clients/client-ses/commands/SetIdentityFeedbackForwardingEnabledCommand.ts b/clients/client-ses/commands/SetIdentityFeedbackForwardingEnabledCommand.ts index 117cb14c6f00..82fe26c77996 100644 --- a/clients/client-ses/commands/SetIdentityFeedbackForwardingEnabledCommand.ts +++ b/clients/client-ses/commands/SetIdentityFeedbackForwardingEnabledCommand.ts @@ -37,6 +37,20 @@ export interface SetIdentityFeedbackForwardingEnabledCommandOutput *

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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { SESClient, SetIdentityFeedbackForwardingEnabledCommand } from "@aws-sdk/client-ses"; // ES Modules import + * // const { SESClient, SetIdentityFeedbackForwardingEnabledCommand } = require("@aws-sdk/client-ses"); // CommonJS import + * const client = new SESClient(config); + * const command = new SetIdentityFeedbackForwardingEnabledCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link SetIdentityFeedbackForwardingEnabledCommandInput} for command's `input` shape. + * @see {@link SetIdentityFeedbackForwardingEnabledCommandOutput} for command's `response` shape. + * @see {@link SESClientResolvedConfig | config} for command's `input` shape. + * */ export class SetIdentityFeedbackForwardingEnabledCommand extends $Command< SetIdentityFeedbackForwardingEnabledCommandInput, diff --git a/clients/client-ses/commands/SetIdentityHeadersInNotificationsEnabledCommand.ts b/clients/client-ses/commands/SetIdentityHeadersInNotificationsEnabledCommand.ts index 9f8afa8b8b57..592d8c6b79dd 100644 --- a/clients/client-ses/commands/SetIdentityHeadersInNotificationsEnabledCommand.ts +++ b/clients/client-ses/commands/SetIdentityHeadersInNotificationsEnabledCommand.ts @@ -33,6 +33,20 @@ export interface SetIdentityHeadersInNotificationsEnabledCommandOutput *

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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { SESClient, SetIdentityHeadersInNotificationsEnabledCommand } from "@aws-sdk/client-ses"; // ES Modules import + * // const { SESClient, SetIdentityHeadersInNotificationsEnabledCommand } = require("@aws-sdk/client-ses"); // CommonJS import + * const client = new SESClient(config); + * const command = new SetIdentityHeadersInNotificationsEnabledCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link SetIdentityHeadersInNotificationsEnabledCommandInput} for command's `input` shape. + * @see {@link SetIdentityHeadersInNotificationsEnabledCommandOutput} for command's `response` shape. + * @see {@link SESClientResolvedConfig | config} for command's `input` shape. + * */ export class SetIdentityHeadersInNotificationsEnabledCommand extends $Command< SetIdentityHeadersInNotificationsEnabledCommandInput, diff --git a/clients/client-ses/commands/SetIdentityMailFromDomainCommand.ts b/clients/client-ses/commands/SetIdentityMailFromDomainCommand.ts index 139747f55f46..286dcdd34735 100644 --- a/clients/client-ses/commands/SetIdentityMailFromDomainCommand.ts +++ b/clients/client-ses/commands/SetIdentityMailFromDomainCommand.ts @@ -31,6 +31,20 @@ export interface SetIdentityMailFromDomainCommandOutput extends SetIdentityMailF * Guide.

* *

You can execute this operation no more than once per second.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { SESClient, SetIdentityMailFromDomainCommand } from "@aws-sdk/client-ses"; // ES Modules import + * // const { SESClient, SetIdentityMailFromDomainCommand } = require("@aws-sdk/client-ses"); // CommonJS import + * const client = new SESClient(config); + * const command = new SetIdentityMailFromDomainCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link SetIdentityMailFromDomainCommandInput} for command's `input` shape. + * @see {@link SetIdentityMailFromDomainCommandOutput} for command's `response` shape. + * @see {@link SESClientResolvedConfig | config} for command's `input` shape. + * */ export class SetIdentityMailFromDomainCommand extends $Command< SetIdentityMailFromDomainCommandInput, diff --git a/clients/client-ses/commands/SetIdentityNotificationTopicCommand.ts b/clients/client-ses/commands/SetIdentityNotificationTopicCommand.ts index 8140ec17e175..403f06868cd7 100644 --- a/clients/client-ses/commands/SetIdentityNotificationTopicCommand.ts +++ b/clients/client-ses/commands/SetIdentityNotificationTopicCommand.ts @@ -32,6 +32,20 @@ export interface SetIdentityNotificationTopicCommandOutput *

You can execute this operation no more than once per second.

*

For more information about feedback notification, see the Amazon SES Developer * Guide.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { SESClient, SetIdentityNotificationTopicCommand } from "@aws-sdk/client-ses"; // ES Modules import + * // const { SESClient, SetIdentityNotificationTopicCommand } = require("@aws-sdk/client-ses"); // CommonJS import + * const client = new SESClient(config); + * const command = new SetIdentityNotificationTopicCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link SetIdentityNotificationTopicCommandInput} for command's `input` shape. + * @see {@link SetIdentityNotificationTopicCommandOutput} for command's `response` shape. + * @see {@link SESClientResolvedConfig | config} for command's `input` shape. + * */ export class SetIdentityNotificationTopicCommand extends $Command< SetIdentityNotificationTopicCommandInput, diff --git a/clients/client-ses/commands/SetReceiptRulePositionCommand.ts b/clients/client-ses/commands/SetReceiptRulePositionCommand.ts index 17d0315b4e5e..66f82c970691 100644 --- a/clients/client-ses/commands/SetReceiptRulePositionCommand.ts +++ b/clients/client-ses/commands/SetReceiptRulePositionCommand.ts @@ -25,6 +25,20 @@ export interface SetReceiptRulePositionCommandOutput extends SetReceiptRulePosit *

For information about managing receipt rules, see the Amazon SES * Developer Guide.

*

You can execute this operation no more than once per second.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { SESClient, SetReceiptRulePositionCommand } from "@aws-sdk/client-ses"; // ES Modules import + * // const { SESClient, SetReceiptRulePositionCommand } = require("@aws-sdk/client-ses"); // CommonJS import + * const client = new SESClient(config); + * const command = new SetReceiptRulePositionCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link SetReceiptRulePositionCommandInput} for command's `input` shape. + * @see {@link SetReceiptRulePositionCommandOutput} for command's `response` shape. + * @see {@link SESClientResolvedConfig | config} for command's `input` shape. + * */ export class SetReceiptRulePositionCommand extends $Command< SetReceiptRulePositionCommandInput, diff --git a/clients/client-ses/commands/TestRenderTemplateCommand.ts b/clients/client-ses/commands/TestRenderTemplateCommand.ts index 651e1f5787e1..cecd464a918b 100644 --- a/clients/client-ses/commands/TestRenderTemplateCommand.ts +++ b/clients/client-ses/commands/TestRenderTemplateCommand.ts @@ -24,6 +24,20 @@ export interface TestRenderTemplateCommandOutput extends TestRenderTemplateRespo *

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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { SESClient, TestRenderTemplateCommand } from "@aws-sdk/client-ses"; // ES Modules import + * // const { SESClient, TestRenderTemplateCommand } = require("@aws-sdk/client-ses"); // CommonJS import + * const client = new SESClient(config); + * const command = new TestRenderTemplateCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link TestRenderTemplateCommandInput} for command's `input` shape. + * @see {@link TestRenderTemplateCommandOutput} for command's `response` shape. + * @see {@link SESClientResolvedConfig | config} for command's `input` shape. + * */ export class TestRenderTemplateCommand extends $Command< TestRenderTemplateCommandInput, diff --git a/clients/client-ses/commands/UpdateAccountSendingEnabledCommand.ts b/clients/client-ses/commands/UpdateAccountSendingEnabledCommand.ts index b5242b92d487..85a855d4e70d 100644 --- a/clients/client-ses/commands/UpdateAccountSendingEnabledCommand.ts +++ b/clients/client-ses/commands/UpdateAccountSendingEnabledCommand.ts @@ -27,6 +27,20 @@ export interface UpdateAccountSendingEnabledCommandOutput extends __MetadataBear * reputation metrics (such as your bounce or complaint rates) reach certain * thresholds.

*

You can execute this operation no more than once per second.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { SESClient, UpdateAccountSendingEnabledCommand } from "@aws-sdk/client-ses"; // ES Modules import + * // const { SESClient, UpdateAccountSendingEnabledCommand } = require("@aws-sdk/client-ses"); // CommonJS import + * const client = new SESClient(config); + * const command = new UpdateAccountSendingEnabledCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link UpdateAccountSendingEnabledCommandInput} for command's `input` shape. + * @see {@link UpdateAccountSendingEnabledCommandOutput} for command's `response` shape. + * @see {@link SESClientResolvedConfig | config} for command's `input` shape. + * */ export class UpdateAccountSendingEnabledCommand extends $Command< UpdateAccountSendingEnabledCommandInput, diff --git a/clients/client-ses/commands/UpdateConfigurationSetEventDestinationCommand.ts b/clients/client-ses/commands/UpdateConfigurationSetEventDestinationCommand.ts index d285d96b0bbf..009614390555 100644 --- a/clients/client-ses/commands/UpdateConfigurationSetEventDestinationCommand.ts +++ b/clients/client-ses/commands/UpdateConfigurationSetEventDestinationCommand.ts @@ -39,6 +39,20 @@ export interface UpdateConfigurationSetEventDestinationCommandOutput * (Amazon SNS).

* *

You can execute this operation no more than once per second.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { SESClient, UpdateConfigurationSetEventDestinationCommand } from "@aws-sdk/client-ses"; // ES Modules import + * // const { SESClient, UpdateConfigurationSetEventDestinationCommand } = require("@aws-sdk/client-ses"); // CommonJS import + * const client = new SESClient(config); + * const command = new UpdateConfigurationSetEventDestinationCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link UpdateConfigurationSetEventDestinationCommandInput} for command's `input` shape. + * @see {@link UpdateConfigurationSetEventDestinationCommandOutput} for command's `response` shape. + * @see {@link SESClientResolvedConfig | config} for command's `input` shape. + * */ export class UpdateConfigurationSetEventDestinationCommand extends $Command< UpdateConfigurationSetEventDestinationCommandInput, diff --git a/clients/client-ses/commands/UpdateConfigurationSetReputationMetricsEnabledCommand.ts b/clients/client-ses/commands/UpdateConfigurationSetReputationMetricsEnabledCommand.ts index 6db394fd2d9b..0efb40a1427b 100644 --- a/clients/client-ses/commands/UpdateConfigurationSetReputationMetricsEnabledCommand.ts +++ b/clients/client-ses/commands/UpdateConfigurationSetReputationMetricsEnabledCommand.ts @@ -27,6 +27,20 @@ export interface UpdateConfigurationSetReputationMetricsEnabledCommandOutput ext * 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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { SESClient, UpdateConfigurationSetReputationMetricsEnabledCommand } from "@aws-sdk/client-ses"; // ES Modules import + * // const { SESClient, UpdateConfigurationSetReputationMetricsEnabledCommand } = require("@aws-sdk/client-ses"); // CommonJS import + * const client = new SESClient(config); + * const command = new UpdateConfigurationSetReputationMetricsEnabledCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link UpdateConfigurationSetReputationMetricsEnabledCommandInput} for command's `input` shape. + * @see {@link UpdateConfigurationSetReputationMetricsEnabledCommandOutput} for command's `response` shape. + * @see {@link SESClientResolvedConfig | config} for command's `input` shape. + * */ export class UpdateConfigurationSetReputationMetricsEnabledCommand extends $Command< UpdateConfigurationSetReputationMetricsEnabledCommandInput, diff --git a/clients/client-ses/commands/UpdateConfigurationSetSendingEnabledCommand.ts b/clients/client-ses/commands/UpdateConfigurationSetSendingEnabledCommand.ts index f93f36ed725a..a55ee696106e 100644 --- a/clients/client-ses/commands/UpdateConfigurationSetSendingEnabledCommand.ts +++ b/clients/client-ses/commands/UpdateConfigurationSetSendingEnabledCommand.ts @@ -27,6 +27,20 @@ export interface UpdateConfigurationSetSendingEnabledCommandOutput extends __Met * 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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { SESClient, UpdateConfigurationSetSendingEnabledCommand } from "@aws-sdk/client-ses"; // ES Modules import + * // const { SESClient, UpdateConfigurationSetSendingEnabledCommand } = require("@aws-sdk/client-ses"); // CommonJS import + * const client = new SESClient(config); + * const command = new UpdateConfigurationSetSendingEnabledCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link UpdateConfigurationSetSendingEnabledCommandInput} for command's `input` shape. + * @see {@link UpdateConfigurationSetSendingEnabledCommandOutput} for command's `response` shape. + * @see {@link SESClientResolvedConfig | config} for command's `input` shape. + * */ export class UpdateConfigurationSetSendingEnabledCommand extends $Command< UpdateConfigurationSetSendingEnabledCommandInput, diff --git a/clients/client-ses/commands/UpdateConfigurationSetTrackingOptionsCommand.ts b/clients/client-ses/commands/UpdateConfigurationSetTrackingOptionsCommand.ts index c1b70127f28e..86ba26c33fb3 100644 --- a/clients/client-ses/commands/UpdateConfigurationSetTrackingOptionsCommand.ts +++ b/clients/client-ses/commands/UpdateConfigurationSetTrackingOptionsCommand.ts @@ -32,6 +32,20 @@ export interface UpdateConfigurationSetTrackingOptionsCommandOutput *

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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { SESClient, UpdateConfigurationSetTrackingOptionsCommand } from "@aws-sdk/client-ses"; // ES Modules import + * // const { SESClient, UpdateConfigurationSetTrackingOptionsCommand } = require("@aws-sdk/client-ses"); // CommonJS import + * const client = new SESClient(config); + * const command = new UpdateConfigurationSetTrackingOptionsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link UpdateConfigurationSetTrackingOptionsCommandInput} for command's `input` shape. + * @see {@link UpdateConfigurationSetTrackingOptionsCommandOutput} for command's `response` shape. + * @see {@link SESClientResolvedConfig | config} for command's `input` shape. + * */ export class UpdateConfigurationSetTrackingOptionsCommand extends $Command< UpdateConfigurationSetTrackingOptionsCommandInput, diff --git a/clients/client-ses/commands/UpdateCustomVerificationEmailTemplateCommand.ts b/clients/client-ses/commands/UpdateCustomVerificationEmailTemplateCommand.ts index bd1726ff31d5..15f6a4d6269f 100644 --- a/clients/client-ses/commands/UpdateCustomVerificationEmailTemplateCommand.ts +++ b/clients/client-ses/commands/UpdateCustomVerificationEmailTemplateCommand.ts @@ -26,6 +26,20 @@ export interface UpdateCustomVerificationEmailTemplateCommandOutput extends __Me *

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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { SESClient, UpdateCustomVerificationEmailTemplateCommand } from "@aws-sdk/client-ses"; // ES Modules import + * // const { SESClient, UpdateCustomVerificationEmailTemplateCommand } = require("@aws-sdk/client-ses"); // CommonJS import + * const client = new SESClient(config); + * const command = new UpdateCustomVerificationEmailTemplateCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link UpdateCustomVerificationEmailTemplateCommandInput} for command's `input` shape. + * @see {@link UpdateCustomVerificationEmailTemplateCommandOutput} for command's `response` shape. + * @see {@link SESClientResolvedConfig | config} for command's `input` shape. + * */ export class UpdateCustomVerificationEmailTemplateCommand extends $Command< UpdateCustomVerificationEmailTemplateCommandInput, diff --git a/clients/client-ses/commands/UpdateReceiptRuleCommand.ts b/clients/client-ses/commands/UpdateReceiptRuleCommand.ts index 5f4e7ce5a043..71ae45e320aa 100644 --- a/clients/client-ses/commands/UpdateReceiptRuleCommand.ts +++ b/clients/client-ses/commands/UpdateReceiptRuleCommand.ts @@ -25,6 +25,20 @@ export interface UpdateReceiptRuleCommandOutput extends UpdateReceiptRuleRespons *

For information about managing receipt rules, see the Amazon SES * Developer Guide.

*

You can execute this operation no more than once per second.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { SESClient, UpdateReceiptRuleCommand } from "@aws-sdk/client-ses"; // ES Modules import + * // const { SESClient, UpdateReceiptRuleCommand } = require("@aws-sdk/client-ses"); // CommonJS import + * const client = new SESClient(config); + * const command = new UpdateReceiptRuleCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link UpdateReceiptRuleCommandInput} for command's `input` shape. + * @see {@link UpdateReceiptRuleCommandOutput} for command's `response` shape. + * @see {@link SESClientResolvedConfig | config} for command's `input` shape. + * */ export class UpdateReceiptRuleCommand extends $Command< UpdateReceiptRuleCommandInput, diff --git a/clients/client-ses/commands/UpdateTemplateCommand.ts b/clients/client-ses/commands/UpdateTemplateCommand.ts index dddc1af5f0a6..81d1086a6454 100644 --- a/clients/client-ses/commands/UpdateTemplateCommand.ts +++ b/clients/client-ses/commands/UpdateTemplateCommand.ts @@ -25,6 +25,20 @@ export interface UpdateTemplateCommandOutput extends UpdateTemplateResponse, __M * 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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { SESClient, UpdateTemplateCommand } from "@aws-sdk/client-ses"; // ES Modules import + * // const { SESClient, UpdateTemplateCommand } = require("@aws-sdk/client-ses"); // CommonJS import + * const client = new SESClient(config); + * const command = new UpdateTemplateCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link UpdateTemplateCommandInput} for command's `input` shape. + * @see {@link UpdateTemplateCommandOutput} for command's `response` shape. + * @see {@link SESClientResolvedConfig | config} for command's `input` shape. + * */ export class UpdateTemplateCommand extends $Command< UpdateTemplateCommandInput, diff --git a/clients/client-ses/commands/VerifyDomainDkimCommand.ts b/clients/client-ses/commands/VerifyDomainDkimCommand.ts index 85be6206b84e..0f4db093da9b 100644 --- a/clients/client-ses/commands/VerifyDomainDkimCommand.ts +++ b/clients/client-ses/commands/VerifyDomainDkimCommand.ts @@ -60,6 +60,20 @@ export interface VerifyDomainDkimCommandOutput extends VerifyDomainDkimResponse, * 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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { SESClient, VerifyDomainDkimCommand } from "@aws-sdk/client-ses"; // ES Modules import + * // const { SESClient, VerifyDomainDkimCommand } = require("@aws-sdk/client-ses"); // CommonJS import + * const client = new SESClient(config); + * const command = new VerifyDomainDkimCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link VerifyDomainDkimCommandInput} for command's `input` shape. + * @see {@link VerifyDomainDkimCommandOutput} for command's `response` shape. + * @see {@link SESClientResolvedConfig | config} for command's `input` shape. + * */ export class VerifyDomainDkimCommand extends $Command< VerifyDomainDkimCommandInput, diff --git a/clients/client-ses/commands/VerifyDomainIdentityCommand.ts b/clients/client-ses/commands/VerifyDomainIdentityCommand.ts index 17e3c87f6b66..8f25462b5ffb 100644 --- a/clients/client-ses/commands/VerifyDomainIdentityCommand.ts +++ b/clients/client-ses/commands/VerifyDomainIdentityCommand.ts @@ -28,6 +28,20 @@ export interface VerifyDomainIdentityCommandOutput extends VerifyDomainIdentityR * Guide. *

*

You can execute this operation no more than once per second.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { SESClient, VerifyDomainIdentityCommand } from "@aws-sdk/client-ses"; // ES Modules import + * // const { SESClient, VerifyDomainIdentityCommand } = require("@aws-sdk/client-ses"); // CommonJS import + * const client = new SESClient(config); + * const command = new VerifyDomainIdentityCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link VerifyDomainIdentityCommandInput} for command's `input` shape. + * @see {@link VerifyDomainIdentityCommandOutput} for command's `response` shape. + * @see {@link SESClientResolvedConfig | config} for command's `input` shape. + * */ export class VerifyDomainIdentityCommand extends $Command< VerifyDomainIdentityCommandInput, diff --git a/clients/client-ses/commands/VerifyEmailAddressCommand.ts b/clients/client-ses/commands/VerifyEmailAddressCommand.ts index a891628ebc0c..2088706fc7be 100644 --- a/clients/client-ses/commands/VerifyEmailAddressCommand.ts +++ b/clients/client-ses/commands/VerifyEmailAddressCommand.ts @@ -23,6 +23,20 @@ export interface VerifyEmailAddressCommandOutput extends __MetadataBearer {} /** *

Deprecated. Use the VerifyEmailIdentity operation to verify a new email * address.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { SESClient, VerifyEmailAddressCommand } from "@aws-sdk/client-ses"; // ES Modules import + * // const { SESClient, VerifyEmailAddressCommand } = require("@aws-sdk/client-ses"); // CommonJS import + * const client = new SESClient(config); + * const command = new VerifyEmailAddressCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link VerifyEmailAddressCommandInput} for command's `input` shape. + * @see {@link VerifyEmailAddressCommandOutput} for command's `response` shape. + * @see {@link SESClientResolvedConfig | config} for command's `input` shape. + * */ export class VerifyEmailAddressCommand extends $Command< VerifyEmailAddressCommandInput, diff --git a/clients/client-ses/commands/VerifyEmailIdentityCommand.ts b/clients/client-ses/commands/VerifyEmailIdentityCommand.ts index 17d93f6ce97d..acf970a414a7 100644 --- a/clients/client-ses/commands/VerifyEmailIdentityCommand.ts +++ b/clients/client-ses/commands/VerifyEmailIdentityCommand.ts @@ -25,6 +25,20 @@ export interface VerifyEmailIdentityCommandOutput extends VerifyEmailIdentityRes * 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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { SESClient, VerifyEmailIdentityCommand } from "@aws-sdk/client-ses"; // ES Modules import + * // const { SESClient, VerifyEmailIdentityCommand } = require("@aws-sdk/client-ses"); // CommonJS import + * const client = new SESClient(config); + * const command = new VerifyEmailIdentityCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link VerifyEmailIdentityCommandInput} for command's `input` shape. + * @see {@link VerifyEmailIdentityCommandOutput} for command's `response` shape. + * @see {@link SESClientResolvedConfig | config} for command's `input` shape. + * */ export class VerifyEmailIdentityCommand extends $Command< VerifyEmailIdentityCommandInput, diff --git a/clients/client-ses/models/models_0.ts b/clients/client-ses/models/models_0.ts index b3af7df21979..3dab894cd9ea 100644 --- a/clients/client-ses/models/models_0.ts +++ b/clients/client-ses/models/models_0.ts @@ -12,6 +12,9 @@ export interface AccountSendingPausedException extends __SmithyException, $Metad } export namespace AccountSendingPausedException { + /** + * @internal + */ export const filterSensitiveLog = (obj: AccountSendingPausedException): any => ({ ...obj, }); @@ -38,6 +41,9 @@ export interface AddHeaderAction { } export namespace AddHeaderAction { + /** + * @internal + */ export const filterSensitiveLog = (obj: AddHeaderAction): any => ({ ...obj, }); @@ -59,6 +65,9 @@ export interface AlreadyExistsException extends __SmithyException, $MetadataBear } export namespace AlreadyExistsException { + /** + * @internal + */ export const filterSensitiveLog = (obj: AlreadyExistsException): any => ({ ...obj, }); @@ -88,6 +97,9 @@ export interface Content { } export namespace Content { + /** + * @internal + */ export const filterSensitiveLog = (obj: Content): any => ({ ...obj, }); @@ -114,6 +126,9 @@ export interface Body { } export namespace Body { + /** + * @internal + */ export const filterSensitiveLog = (obj: Body): any => ({ ...obj, }); @@ -159,6 +174,9 @@ export interface BounceAction { } export namespace BounceAction { + /** + * @internal + */ export const filterSensitiveLog = (obj: BounceAction): any => ({ ...obj, }); @@ -202,6 +220,9 @@ export interface ExtensionField { } export namespace ExtensionField { + /** + * @internal + */ export const filterSensitiveLog = (obj: ExtensionField): any => ({ ...obj, }); @@ -266,6 +287,9 @@ export interface RecipientDsnFields { } export namespace RecipientDsnFields { + /** + * @internal + */ export const filterSensitiveLog = (obj: RecipientDsnFields): any => ({ ...obj, }); @@ -307,6 +331,9 @@ export interface BouncedRecipientInfo { } export namespace BouncedRecipientInfo { + /** + * @internal + */ export const filterSensitiveLog = (obj: BouncedRecipientInfo): any => ({ ...obj, }); @@ -342,6 +369,9 @@ export interface Destination { } export namespace Destination { + /** + * @internal + */ export const filterSensitiveLog = (obj: Destination): any => ({ ...obj, }); @@ -384,6 +414,9 @@ export interface MessageTag { } export namespace MessageTag { + /** + * @internal + */ export const filterSensitiveLog = (obj: MessageTag): any => ({ ...obj, }); @@ -424,6 +457,9 @@ export interface BulkEmailDestination { } export namespace BulkEmailDestination { + /** + * @internal + */ export const filterSensitiveLog = (obj: BulkEmailDestination): any => ({ ...obj, }); @@ -547,6 +583,9 @@ export interface BulkEmailDestinationStatus { } export namespace BulkEmailDestinationStatus { + /** + * @internal + */ export const filterSensitiveLog = (obj: BulkEmailDestinationStatus): any => ({ ...obj, }); @@ -568,6 +607,9 @@ export interface CannotDeleteException extends __SmithyException, $MetadataBeare } export namespace CannotDeleteException { + /** + * @internal + */ export const filterSensitiveLog = (obj: CannotDeleteException): any => ({ ...obj, }); @@ -602,6 +644,9 @@ export interface CloneReceiptRuleSetRequest { } export namespace CloneReceiptRuleSetRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: CloneReceiptRuleSetRequest): any => ({ ...obj, }); @@ -613,6 +658,9 @@ export namespace CloneReceiptRuleSetRequest { export interface CloneReceiptRuleSetResponse {} export namespace CloneReceiptRuleSetResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: CloneReceiptRuleSetResponse): any => ({ ...obj, }); @@ -630,6 +678,9 @@ export interface LimitExceededException extends __SmithyException, $MetadataBear } export namespace LimitExceededException { + /** + * @internal + */ export const filterSensitiveLog = (obj: LimitExceededException): any => ({ ...obj, }); @@ -650,6 +701,9 @@ export interface RuleSetDoesNotExistException extends __SmithyException, $Metada } export namespace RuleSetDoesNotExistException { + /** + * @internal + */ export const filterSensitiveLog = (obj: RuleSetDoesNotExistException): any => ({ ...obj, }); @@ -709,6 +763,9 @@ export interface CloudWatchDimensionConfiguration { } export namespace CloudWatchDimensionConfiguration { + /** + * @internal + */ export const filterSensitiveLog = (obj: CloudWatchDimensionConfiguration): any => ({ ...obj, }); @@ -731,6 +788,9 @@ export interface CloudWatchDestination { } export namespace CloudWatchDestination { + /** + * @internal + */ export const filterSensitiveLog = (obj: CloudWatchDestination): any => ({ ...obj, }); @@ -759,6 +819,9 @@ export interface ConfigurationSet { } export namespace ConfigurationSet { + /** + * @internal + */ export const filterSensitiveLog = (obj: ConfigurationSet): any => ({ ...obj, }); @@ -780,6 +843,9 @@ export interface ConfigurationSetAlreadyExistsException extends __SmithyExceptio } export namespace ConfigurationSetAlreadyExistsException { + /** + * @internal + */ export const filterSensitiveLog = (obj: ConfigurationSetAlreadyExistsException): any => ({ ...obj, }); @@ -807,6 +873,9 @@ export interface ConfigurationSetDoesNotExistException extends __SmithyException } export namespace ConfigurationSetDoesNotExistException { + /** + * @internal + */ export const filterSensitiveLog = (obj: ConfigurationSetDoesNotExistException): any => ({ ...obj, }); @@ -828,6 +897,9 @@ export interface ConfigurationSetSendingPausedException extends __SmithyExceptio } export namespace ConfigurationSetSendingPausedException { + /** + * @internal + */ export const filterSensitiveLog = (obj: ConfigurationSetSendingPausedException): any => ({ ...obj, }); @@ -847,6 +919,9 @@ export interface CreateConfigurationSetRequest { } export namespace CreateConfigurationSetRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateConfigurationSetRequest): any => ({ ...obj, }); @@ -858,6 +933,9 @@ export namespace CreateConfigurationSetRequest { export interface CreateConfigurationSetResponse {} export namespace CreateConfigurationSetResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateConfigurationSetResponse): any => ({ ...obj, }); @@ -874,6 +952,9 @@ export interface InvalidConfigurationSetException extends __SmithyException, $Me } export namespace InvalidConfigurationSetException { + /** + * @internal + */ export const filterSensitiveLog = (obj: InvalidConfigurationSetException): any => ({ ...obj, }); @@ -901,6 +982,9 @@ export interface KinesisFirehoseDestination { } export namespace KinesisFirehoseDestination { + /** + * @internal + */ export const filterSensitiveLog = (obj: KinesisFirehoseDestination): any => ({ ...obj, }); @@ -934,6 +1018,9 @@ export interface SNSDestination { } export namespace SNSDestination { + /** + * @internal + */ export const filterSensitiveLog = (obj: SNSDestination): any => ({ ...obj, }); @@ -999,6 +1086,9 @@ export interface EventDestination { } export namespace EventDestination { + /** + * @internal + */ export const filterSensitiveLog = (obj: EventDestination): any => ({ ...obj, }); @@ -1026,6 +1116,9 @@ export interface CreateConfigurationSetEventDestinationRequest { } export namespace CreateConfigurationSetEventDestinationRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateConfigurationSetEventDestinationRequest): any => ({ ...obj, }); @@ -1037,6 +1130,9 @@ export namespace CreateConfigurationSetEventDestinationRequest { export interface CreateConfigurationSetEventDestinationResponse {} export namespace CreateConfigurationSetEventDestinationResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateConfigurationSetEventDestinationResponse): any => ({ ...obj, }); @@ -1063,6 +1159,9 @@ export interface EventDestinationAlreadyExistsException extends __SmithyExceptio } export namespace EventDestinationAlreadyExistsException { + /** + * @internal + */ export const filterSensitiveLog = (obj: EventDestinationAlreadyExistsException): any => ({ ...obj, }); @@ -1089,6 +1188,9 @@ export interface InvalidCloudWatchDestinationException extends __SmithyException } export namespace InvalidCloudWatchDestinationException { + /** + * @internal + */ export const filterSensitiveLog = (obj: InvalidCloudWatchDestinationException): any => ({ ...obj, }); @@ -1115,6 +1217,9 @@ export interface InvalidFirehoseDestinationException extends __SmithyException, } export namespace InvalidFirehoseDestinationException { + /** + * @internal + */ export const filterSensitiveLog = (obj: InvalidFirehoseDestinationException): any => ({ ...obj, }); @@ -1141,6 +1246,9 @@ export interface InvalidSNSDestinationException extends __SmithyException, $Meta } export namespace InvalidSNSDestinationException { + /** + * @internal + */ export const filterSensitiveLog = (obj: InvalidSNSDestinationException): any => ({ ...obj, }); @@ -1162,6 +1270,9 @@ export interface TrackingOptions { } export namespace TrackingOptions { + /** + * @internal + */ export const filterSensitiveLog = (obj: TrackingOptions): any => ({ ...obj, }); @@ -1189,6 +1300,9 @@ export interface CreateConfigurationSetTrackingOptionsRequest { } export namespace CreateConfigurationSetTrackingOptionsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateConfigurationSetTrackingOptionsRequest): any => ({ ...obj, }); @@ -1200,6 +1314,9 @@ export namespace CreateConfigurationSetTrackingOptionsRequest { export interface CreateConfigurationSetTrackingOptionsResponse {} export namespace CreateConfigurationSetTrackingOptionsResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateConfigurationSetTrackingOptionsResponse): any => ({ ...obj, }); @@ -1225,6 +1342,9 @@ export interface InvalidTrackingOptionsException extends __SmithyException, $Met } export namespace InvalidTrackingOptionsException { + /** + * @internal + */ export const filterSensitiveLog = (obj: InvalidTrackingOptionsException): any => ({ ...obj, }); @@ -1247,6 +1367,9 @@ export interface TrackingOptionsAlreadyExistsException extends __SmithyException } export namespace TrackingOptionsAlreadyExistsException { + /** + * @internal + */ export const filterSensitiveLog = (obj: TrackingOptionsAlreadyExistsException): any => ({ ...obj, }); @@ -1293,6 +1416,9 @@ export interface CreateCustomVerificationEmailTemplateRequest { } export namespace CreateCustomVerificationEmailTemplateRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateCustomVerificationEmailTemplateRequest): any => ({ ...obj, }); @@ -1308,6 +1434,9 @@ export interface CustomVerificationEmailInvalidContentException extends __Smithy } export namespace CustomVerificationEmailInvalidContentException { + /** + * @internal + */ export const filterSensitiveLog = (obj: CustomVerificationEmailInvalidContentException): any => ({ ...obj, }); @@ -1330,6 +1459,9 @@ export interface CustomVerificationEmailTemplateAlreadyExistsException extends _ } export namespace CustomVerificationEmailTemplateAlreadyExistsException { + /** + * @internal + */ export const filterSensitiveLog = (obj: CustomVerificationEmailTemplateAlreadyExistsException): any => ({ ...obj, }); @@ -1352,6 +1484,9 @@ export interface FromEmailAddressNotVerifiedException extends __SmithyException, } export namespace FromEmailAddressNotVerifiedException { + /** + * @internal + */ export const filterSensitiveLog = (obj: FromEmailAddressNotVerifiedException): any => ({ ...obj, }); @@ -1384,6 +1519,9 @@ export interface ReceiptIpFilter { } export namespace ReceiptIpFilter { + /** + * @internal + */ export const filterSensitiveLog = (obj: ReceiptIpFilter): any => ({ ...obj, }); @@ -1420,6 +1558,9 @@ export interface ReceiptFilter { } export namespace ReceiptFilter { + /** + * @internal + */ export const filterSensitiveLog = (obj: ReceiptFilter): any => ({ ...obj, }); @@ -1438,6 +1579,9 @@ export interface CreateReceiptFilterRequest { } export namespace CreateReceiptFilterRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateReceiptFilterRequest): any => ({ ...obj, }); @@ -1449,6 +1593,9 @@ export namespace CreateReceiptFilterRequest { export interface CreateReceiptFilterResponse {} export namespace CreateReceiptFilterResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateReceiptFilterResponse): any => ({ ...obj, }); @@ -1499,6 +1646,9 @@ export interface LambdaAction { } export namespace LambdaAction { + /** + * @internal + */ export const filterSensitiveLog = (obj: LambdaAction): any => ({ ...obj, }); @@ -1575,6 +1725,9 @@ export interface S3Action { } export namespace S3Action { + /** + * @internal + */ export const filterSensitiveLog = (obj: S3Action): any => ({ ...obj, }); @@ -1622,6 +1775,9 @@ export interface SNSAction { } export namespace SNSAction { + /** + * @internal + */ export const filterSensitiveLog = (obj: SNSAction): any => ({ ...obj, }); @@ -1653,6 +1809,9 @@ export interface StopAction { } export namespace StopAction { + /** + * @internal + */ export const filterSensitiveLog = (obj: StopAction): any => ({ ...obj, }); @@ -1686,6 +1845,9 @@ export interface WorkmailAction { } export namespace WorkmailAction { + /** + * @internal + */ export const filterSensitiveLog = (obj: WorkmailAction): any => ({ ...obj, }); @@ -1740,6 +1902,9 @@ export interface ReceiptAction { } export namespace ReceiptAction { + /** + * @internal + */ export const filterSensitiveLog = (obj: ReceiptAction): any => ({ ...obj, }); @@ -1812,6 +1977,9 @@ export interface ReceiptRule { } export namespace ReceiptRule { + /** + * @internal + */ export const filterSensitiveLog = (obj: ReceiptRule): any => ({ ...obj, }); @@ -1843,6 +2011,9 @@ export interface CreateReceiptRuleRequest { } export namespace CreateReceiptRuleRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateReceiptRuleRequest): any => ({ ...obj, }); @@ -1854,6 +2025,9 @@ export namespace CreateReceiptRuleRequest { export interface CreateReceiptRuleResponse {} export namespace CreateReceiptRuleResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateReceiptRuleResponse): any => ({ ...obj, }); @@ -1877,6 +2051,9 @@ export interface InvalidLambdaFunctionException extends __SmithyException, $Meta } export namespace InvalidLambdaFunctionException { + /** + * @internal + */ export const filterSensitiveLog = (obj: InvalidLambdaFunctionException): any => ({ ...obj, }); @@ -1900,6 +2077,9 @@ export interface InvalidS3ConfigurationException extends __SmithyException, $Met } export namespace InvalidS3ConfigurationException { + /** + * @internal + */ export const filterSensitiveLog = (obj: InvalidS3ConfigurationException): any => ({ ...obj, }); @@ -1923,6 +2103,9 @@ export interface InvalidSnsTopicException extends __SmithyException, $MetadataBe } export namespace InvalidSnsTopicException { + /** + * @internal + */ export const filterSensitiveLog = (obj: InvalidSnsTopicException): any => ({ ...obj, }); @@ -1943,6 +2126,9 @@ export interface RuleDoesNotExistException extends __SmithyException, $MetadataB } export namespace RuleDoesNotExistException { + /** + * @internal + */ export const filterSensitiveLog = (obj: RuleDoesNotExistException): any => ({ ...obj, }); @@ -1973,6 +2159,9 @@ export interface CreateReceiptRuleSetRequest { } export namespace CreateReceiptRuleSetRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateReceiptRuleSetRequest): any => ({ ...obj, }); @@ -1984,6 +2173,9 @@ export namespace CreateReceiptRuleSetRequest { export interface CreateReceiptRuleSetResponse {} export namespace CreateReceiptRuleSetResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateReceiptRuleSetResponse): any => ({ ...obj, }); @@ -2019,6 +2211,9 @@ export interface Template { } export namespace Template { + /** + * @internal + */ export const filterSensitiveLog = (obj: Template): any => ({ ...obj, }); @@ -2037,6 +2232,9 @@ export interface CreateTemplateRequest { } export namespace CreateTemplateRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateTemplateRequest): any => ({ ...obj, }); @@ -2045,6 +2243,9 @@ export namespace CreateTemplateRequest { export interface CreateTemplateResponse {} export namespace CreateTemplateResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateTemplateResponse): any => ({ ...obj, }); @@ -2062,6 +2263,9 @@ export interface InvalidTemplateException extends __SmithyException, $MetadataBe } export namespace InvalidTemplateException { + /** + * @internal + */ export const filterSensitiveLog = (obj: InvalidTemplateException): any => ({ ...obj, }); @@ -2107,6 +2311,9 @@ export interface CustomVerificationEmailTemplate { } export namespace CustomVerificationEmailTemplate { + /** + * @internal + */ export const filterSensitiveLog = (obj: CustomVerificationEmailTemplate): any => ({ ...obj, }); @@ -2128,6 +2335,9 @@ export interface CustomVerificationEmailTemplateDoesNotExistException extends __ } export namespace CustomVerificationEmailTemplateDoesNotExistException { + /** + * @internal + */ export const filterSensitiveLog = (obj: CustomVerificationEmailTemplateDoesNotExistException): any => ({ ...obj, }); @@ -2147,6 +2357,9 @@ export interface DeleteConfigurationSetRequest { } export namespace DeleteConfigurationSetRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteConfigurationSetRequest): any => ({ ...obj, }); @@ -2158,6 +2371,9 @@ export namespace DeleteConfigurationSetRequest { export interface DeleteConfigurationSetResponse {} export namespace DeleteConfigurationSetResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteConfigurationSetResponse): any => ({ ...obj, }); @@ -2183,6 +2399,9 @@ export interface DeleteConfigurationSetEventDestinationRequest { } export namespace DeleteConfigurationSetEventDestinationRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteConfigurationSetEventDestinationRequest): any => ({ ...obj, }); @@ -2194,6 +2413,9 @@ export namespace DeleteConfigurationSetEventDestinationRequest { export interface DeleteConfigurationSetEventDestinationResponse {} export namespace DeleteConfigurationSetEventDestinationResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteConfigurationSetEventDestinationResponse): any => ({ ...obj, }); @@ -2219,6 +2441,9 @@ export interface EventDestinationDoesNotExistException extends __SmithyException } export namespace EventDestinationDoesNotExistException { + /** + * @internal + */ export const filterSensitiveLog = (obj: EventDestinationDoesNotExistException): any => ({ ...obj, }); @@ -2237,6 +2462,9 @@ export interface DeleteConfigurationSetTrackingOptionsRequest { } export namespace DeleteConfigurationSetTrackingOptionsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteConfigurationSetTrackingOptionsRequest): any => ({ ...obj, }); @@ -2248,6 +2476,9 @@ export namespace DeleteConfigurationSetTrackingOptionsRequest { export interface DeleteConfigurationSetTrackingOptionsResponse {} export namespace DeleteConfigurationSetTrackingOptionsResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteConfigurationSetTrackingOptionsResponse): any => ({ ...obj, }); @@ -2269,6 +2500,9 @@ export interface TrackingOptionsDoesNotExistException extends __SmithyException, } export namespace TrackingOptionsDoesNotExistException { + /** + * @internal + */ export const filterSensitiveLog = (obj: TrackingOptionsDoesNotExistException): any => ({ ...obj, }); @@ -2285,6 +2519,9 @@ export interface DeleteCustomVerificationEmailTemplateRequest { } export namespace DeleteCustomVerificationEmailTemplateRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteCustomVerificationEmailTemplateRequest): any => ({ ...obj, }); @@ -2302,6 +2539,9 @@ export interface DeleteIdentityRequest { } export namespace DeleteIdentityRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteIdentityRequest): any => ({ ...obj, }); @@ -2313,6 +2553,9 @@ export namespace DeleteIdentityRequest { export interface DeleteIdentityResponse {} export namespace DeleteIdentityResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteIdentityResponse): any => ({ ...obj, }); @@ -2341,6 +2584,9 @@ export interface DeleteIdentityPolicyRequest { } export namespace DeleteIdentityPolicyRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteIdentityPolicyRequest): any => ({ ...obj, }); @@ -2352,6 +2598,9 @@ export namespace DeleteIdentityPolicyRequest { export interface DeleteIdentityPolicyResponse {} export namespace DeleteIdentityPolicyResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteIdentityPolicyResponse): any => ({ ...obj, }); @@ -2370,6 +2619,9 @@ export interface DeleteReceiptFilterRequest { } export namespace DeleteReceiptFilterRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteReceiptFilterRequest): any => ({ ...obj, }); @@ -2381,6 +2633,9 @@ export namespace DeleteReceiptFilterRequest { export interface DeleteReceiptFilterResponse {} export namespace DeleteReceiptFilterResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteReceiptFilterResponse): any => ({ ...obj, }); @@ -2404,6 +2659,9 @@ export interface DeleteReceiptRuleRequest { } export namespace DeleteReceiptRuleRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteReceiptRuleRequest): any => ({ ...obj, }); @@ -2415,6 +2673,9 @@ export namespace DeleteReceiptRuleRequest { export interface DeleteReceiptRuleResponse {} export namespace DeleteReceiptRuleResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteReceiptRuleResponse): any => ({ ...obj, }); @@ -2434,6 +2695,9 @@ export interface DeleteReceiptRuleSetRequest { } export namespace DeleteReceiptRuleSetRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteReceiptRuleSetRequest): any => ({ ...obj, }); @@ -2445,6 +2709,9 @@ export namespace DeleteReceiptRuleSetRequest { export interface DeleteReceiptRuleSetResponse {} export namespace DeleteReceiptRuleSetResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteReceiptRuleSetResponse): any => ({ ...obj, }); @@ -2462,6 +2729,9 @@ export interface DeleteTemplateRequest { } export namespace DeleteTemplateRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteTemplateRequest): any => ({ ...obj, }); @@ -2470,6 +2740,9 @@ export namespace DeleteTemplateRequest { export interface DeleteTemplateResponse {} export namespace DeleteTemplateResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteTemplateResponse): any => ({ ...obj, }); @@ -2487,6 +2760,9 @@ export interface DeleteVerifiedEmailAddressRequest { } export namespace DeleteVerifiedEmailAddressRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteVerifiedEmailAddressRequest): any => ({ ...obj, }); @@ -2507,6 +2783,9 @@ export interface DeliveryOptions { } export namespace DeliveryOptions { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeliveryOptions): any => ({ ...obj, }); @@ -2521,6 +2800,9 @@ export namespace DeliveryOptions { export interface DescribeActiveReceiptRuleSetRequest {} export namespace DescribeActiveReceiptRuleSetRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeActiveReceiptRuleSetRequest): any => ({ ...obj, }); @@ -2558,6 +2840,9 @@ export interface ReceiptRuleSetMetadata { } export namespace ReceiptRuleSetMetadata { + /** + * @internal + */ export const filterSensitiveLog = (obj: ReceiptRuleSetMetadata): any => ({ ...obj, }); @@ -2581,6 +2866,9 @@ export interface DescribeActiveReceiptRuleSetResponse { } export namespace DescribeActiveReceiptRuleSetResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeActiveReceiptRuleSetResponse): any => ({ ...obj, }); @@ -2605,6 +2893,9 @@ export interface DescribeConfigurationSetRequest { } export namespace DescribeConfigurationSetRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeConfigurationSetRequest): any => ({ ...obj, }); @@ -2645,6 +2936,9 @@ export interface ReputationOptions { } export namespace ReputationOptions { + /** + * @internal + */ export const filterSensitiveLog = (obj: ReputationOptions): any => ({ ...obj, }); @@ -2686,6 +2980,9 @@ export interface DescribeConfigurationSetResponse { } export namespace DescribeConfigurationSetResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeConfigurationSetResponse): any => ({ ...obj, }); @@ -2709,6 +3006,9 @@ export interface DescribeReceiptRuleRequest { } export namespace DescribeReceiptRuleRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeReceiptRuleRequest): any => ({ ...obj, }); @@ -2726,6 +3026,9 @@ export interface DescribeReceiptRuleResponse { } export namespace DescribeReceiptRuleResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeReceiptRuleResponse): any => ({ ...obj, }); @@ -2743,6 +3046,9 @@ export interface DescribeReceiptRuleSetRequest { } export namespace DescribeReceiptRuleSetRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeReceiptRuleSetRequest): any => ({ ...obj, }); @@ -2765,6 +3071,9 @@ export interface DescribeReceiptRuleSetResponse { } export namespace DescribeReceiptRuleSetResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeReceiptRuleSetResponse): any => ({ ...obj, }); @@ -2803,6 +3112,9 @@ export interface IdentityDkimAttributes { } export namespace IdentityDkimAttributes { + /** + * @internal + */ export const filterSensitiveLog = (obj: IdentityDkimAttributes): any => ({ ...obj, }); @@ -2821,6 +3133,9 @@ export interface GetAccountSendingEnabledResponse { } export namespace GetAccountSendingEnabledResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetAccountSendingEnabledResponse): any => ({ ...obj, }); @@ -2838,6 +3153,9 @@ export interface GetCustomVerificationEmailTemplateRequest { } export namespace GetCustomVerificationEmailTemplateRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetCustomVerificationEmailTemplateRequest): any => ({ ...obj, }); @@ -2881,6 +3199,9 @@ export interface GetCustomVerificationEmailTemplateResponse { } export namespace GetCustomVerificationEmailTemplateResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetCustomVerificationEmailTemplateResponse): any => ({ ...obj, }); @@ -2900,6 +3221,9 @@ export interface GetIdentityDkimAttributesRequest { } export namespace GetIdentityDkimAttributesRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetIdentityDkimAttributesRequest): any => ({ ...obj, }); @@ -2919,6 +3243,9 @@ export interface GetIdentityDkimAttributesResponse { } export namespace GetIdentityDkimAttributesResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetIdentityDkimAttributesResponse): any => ({ ...obj, }); @@ -2937,6 +3264,9 @@ export interface GetIdentityMailFromDomainAttributesRequest { } export namespace GetIdentityMailFromDomainAttributesRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetIdentityMailFromDomainAttributesRequest): any => ({ ...obj, }); @@ -2975,6 +3305,9 @@ export interface IdentityMailFromDomainAttributes { } export namespace IdentityMailFromDomainAttributes { + /** + * @internal + */ export const filterSensitiveLog = (obj: IdentityMailFromDomainAttributes): any => ({ ...obj, }); @@ -2991,6 +3324,9 @@ export interface GetIdentityMailFromDomainAttributesResponse { } export namespace GetIdentityMailFromDomainAttributesResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetIdentityMailFromDomainAttributesResponse): any => ({ ...obj, }); @@ -3012,6 +3348,9 @@ export interface GetIdentityNotificationAttributesRequest { } export namespace GetIdentityNotificationAttributesRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetIdentityNotificationAttributesRequest): any => ({ ...obj, }); @@ -3077,6 +3416,9 @@ export interface IdentityNotificationAttributes { } export namespace IdentityNotificationAttributes { + /** + * @internal + */ export const filterSensitiveLog = (obj: IdentityNotificationAttributes): any => ({ ...obj, }); @@ -3093,6 +3435,9 @@ export interface GetIdentityNotificationAttributesResponse { } export namespace GetIdentityNotificationAttributesResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetIdentityNotificationAttributesResponse): any => ({ ...obj, }); @@ -3123,6 +3468,9 @@ export interface GetIdentityPoliciesRequest { } export namespace GetIdentityPoliciesRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetIdentityPoliciesRequest): any => ({ ...obj, }); @@ -3139,6 +3487,9 @@ export interface GetIdentityPoliciesResponse { } export namespace GetIdentityPoliciesResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetIdentityPoliciesResponse): any => ({ ...obj, }); @@ -3158,6 +3509,9 @@ export interface GetIdentityVerificationAttributesRequest { } export namespace GetIdentityVerificationAttributesRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetIdentityVerificationAttributesRequest): any => ({ ...obj, }); @@ -3181,6 +3535,9 @@ export interface IdentityVerificationAttributes { } export namespace IdentityVerificationAttributes { + /** + * @internal + */ export const filterSensitiveLog = (obj: IdentityVerificationAttributes): any => ({ ...obj, }); @@ -3198,6 +3555,9 @@ export interface GetIdentityVerificationAttributesResponse { } export namespace GetIdentityVerificationAttributesResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetIdentityVerificationAttributesResponse): any => ({ ...obj, }); @@ -3231,6 +3591,9 @@ export interface GetSendQuotaResponse { } export namespace GetSendQuotaResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetSendQuotaResponse): any => ({ ...obj, }); @@ -3268,6 +3631,9 @@ export interface SendDataPoint { } export namespace SendDataPoint { + /** + * @internal + */ export const filterSensitiveLog = (obj: SendDataPoint): any => ({ ...obj, }); @@ -3285,6 +3651,9 @@ export interface GetSendStatisticsResponse { } export namespace GetSendStatisticsResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetSendStatisticsResponse): any => ({ ...obj, }); @@ -3298,6 +3667,9 @@ export interface GetTemplateRequest { } export namespace GetTemplateRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetTemplateRequest): any => ({ ...obj, }); @@ -3312,6 +3684,9 @@ export interface GetTemplateResponse { } export namespace GetTemplateResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetTemplateResponse): any => ({ ...obj, }); @@ -3329,6 +3704,9 @@ export interface TemplateDoesNotExistException extends __SmithyException, $Metad } export namespace TemplateDoesNotExistException { + /** + * @internal + */ export const filterSensitiveLog = (obj: TemplateDoesNotExistException): any => ({ ...obj, }); @@ -3346,6 +3724,9 @@ export interface InvalidDeliveryOptionsException extends __SmithyException, $Met } export namespace InvalidDeliveryOptionsException { + /** + * @internal + */ export const filterSensitiveLog = (obj: InvalidDeliveryOptionsException): any => ({ ...obj, }); @@ -3362,6 +3743,9 @@ export interface InvalidPolicyException extends __SmithyException, $MetadataBear } export namespace InvalidPolicyException { + /** + * @internal + */ export const filterSensitiveLog = (obj: InvalidPolicyException): any => ({ ...obj, }); @@ -3379,6 +3763,9 @@ export interface InvalidRenderingParameterException extends __SmithyException, $ } export namespace InvalidRenderingParameterException { + /** + * @internal + */ export const filterSensitiveLog = (obj: InvalidRenderingParameterException): any => ({ ...obj, }); @@ -3404,6 +3791,9 @@ export interface ListConfigurationSetsRequest { } export namespace ListConfigurationSetsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListConfigurationSetsRequest): any => ({ ...obj, }); @@ -3430,6 +3820,9 @@ export interface ListConfigurationSetsResponse { } export namespace ListConfigurationSetsResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListConfigurationSetsResponse): any => ({ ...obj, }); @@ -3459,6 +3852,9 @@ export interface ListCustomVerificationEmailTemplatesRequest { } export namespace ListCustomVerificationEmailTemplatesRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListCustomVerificationEmailTemplatesRequest): any => ({ ...obj, }); @@ -3483,6 +3879,9 @@ export interface ListCustomVerificationEmailTemplatesResponse { } export namespace ListCustomVerificationEmailTemplatesResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListCustomVerificationEmailTemplatesResponse): any => ({ ...obj, }); @@ -3513,6 +3912,9 @@ export interface ListIdentitiesRequest { } export namespace ListIdentitiesRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListIdentitiesRequest): any => ({ ...obj, }); @@ -3535,6 +3937,9 @@ export interface ListIdentitiesResponse { } export namespace ListIdentitiesResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListIdentitiesResponse): any => ({ ...obj, }); @@ -3557,6 +3962,9 @@ export interface ListIdentityPoliciesRequest { } export namespace ListIdentityPoliciesRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListIdentityPoliciesRequest): any => ({ ...obj, }); @@ -3573,6 +3981,9 @@ export interface ListIdentityPoliciesResponse { } export namespace ListIdentityPoliciesResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListIdentityPoliciesResponse): any => ({ ...obj, }); @@ -3587,6 +3998,9 @@ export namespace ListIdentityPoliciesResponse { export interface ListReceiptFiltersRequest {} export namespace ListReceiptFiltersRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListReceiptFiltersRequest): any => ({ ...obj, }); @@ -3604,6 +4018,9 @@ export interface ListReceiptFiltersResponse { } export namespace ListReceiptFiltersResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListReceiptFiltersResponse): any => ({ ...obj, }); @@ -3624,6 +4041,9 @@ export interface ListReceiptRuleSetsRequest { } export namespace ListReceiptRuleSetsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListReceiptRuleSetsRequest): any => ({ ...obj, }); @@ -3648,6 +4068,9 @@ export interface ListReceiptRuleSetsResponse { } export namespace ListReceiptRuleSetsResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListReceiptRuleSetsResponse): any => ({ ...obj, }); @@ -3669,6 +4092,9 @@ export interface ListTemplatesRequest { } export namespace ListTemplatesRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListTemplatesRequest): any => ({ ...obj, }); @@ -3690,6 +4116,9 @@ export interface TemplateMetadata { } export namespace TemplateMetadata { + /** + * @internal + */ export const filterSensitiveLog = (obj: TemplateMetadata): any => ({ ...obj, }); @@ -3711,6 +4140,9 @@ export interface ListTemplatesResponse { } export namespace ListTemplatesResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListTemplatesResponse): any => ({ ...obj, }); @@ -3728,6 +4160,9 @@ export interface ListVerifiedEmailAddressesResponse { } export namespace ListVerifiedEmailAddressesResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListVerifiedEmailAddressesResponse): any => ({ ...obj, }); @@ -3746,6 +4181,9 @@ export interface MailFromDomainNotVerifiedException extends __SmithyException, $ } export namespace MailFromDomainNotVerifiedException { + /** + * @internal + */ export const filterSensitiveLog = (obj: MailFromDomainNotVerifiedException): any => ({ ...obj, }); @@ -3768,6 +4206,9 @@ export interface Message { } export namespace Message { + /** + * @internal + */ export const filterSensitiveLog = (obj: Message): any => ({ ...obj, }); @@ -3800,6 +4241,9 @@ export interface MessageDsn { } export namespace MessageDsn { + /** + * @internal + */ export const filterSensitiveLog = (obj: MessageDsn): any => ({ ...obj, }); @@ -3816,6 +4260,9 @@ export interface MessageRejected extends __SmithyException, $MetadataBearer { } export namespace MessageRejected { + /** + * @internal + */ export const filterSensitiveLog = (obj: MessageRejected): any => ({ ...obj, }); @@ -3834,6 +4281,9 @@ export interface MissingRenderingAttributeException extends __SmithyException, $ } export namespace MissingRenderingAttributeException { + /** + * @internal + */ export const filterSensitiveLog = (obj: MissingRenderingAttributeException): any => ({ ...obj, }); @@ -3851,6 +4301,9 @@ export interface ProductionAccessNotGrantedException extends __SmithyException, } export namespace ProductionAccessNotGrantedException { + /** + * @internal + */ export const filterSensitiveLog = (obj: ProductionAccessNotGrantedException): any => ({ ...obj, }); @@ -3874,6 +4327,9 @@ export interface PutConfigurationSetDeliveryOptionsRequest { } export namespace PutConfigurationSetDeliveryOptionsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: PutConfigurationSetDeliveryOptionsRequest): any => ({ ...obj, }); @@ -3886,6 +4342,9 @@ export namespace PutConfigurationSetDeliveryOptionsRequest { export interface PutConfigurationSetDeliveryOptionsResponse {} export namespace PutConfigurationSetDeliveryOptionsResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: PutConfigurationSetDeliveryOptionsResponse): any => ({ ...obj, }); @@ -3923,6 +4382,9 @@ export interface PutIdentityPolicyRequest { } export namespace PutIdentityPolicyRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: PutIdentityPolicyRequest): any => ({ ...obj, }); @@ -3934,6 +4396,9 @@ export namespace PutIdentityPolicyRequest { export interface PutIdentityPolicyResponse {} export namespace PutIdentityPolicyResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: PutIdentityPolicyResponse): any => ({ ...obj, }); @@ -3964,6 +4429,9 @@ export interface RawMessage { } export namespace RawMessage { + /** + * @internal + */ export const filterSensitiveLog = (obj: RawMessage): any => ({ ...obj, }); @@ -3987,6 +4455,9 @@ export interface ReorderReceiptRuleSetRequest { } export namespace ReorderReceiptRuleSetRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ReorderReceiptRuleSetRequest): any => ({ ...obj, }); @@ -3998,6 +4469,9 @@ export namespace ReorderReceiptRuleSetRequest { export interface ReorderReceiptRuleSetResponse {} export namespace ReorderReceiptRuleSetResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ReorderReceiptRuleSetResponse): any => ({ ...obj, }); @@ -4048,6 +4522,9 @@ export interface SendBounceRequest { } export namespace SendBounceRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: SendBounceRequest): any => ({ ...obj, }); @@ -4064,6 +4541,9 @@ export interface SendBounceResponse { } export namespace SendBounceResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: SendBounceResponse): any => ({ ...obj, }); @@ -4186,6 +4666,9 @@ export interface SendBulkTemplatedEmailRequest { } export namespace SendBulkTemplatedEmailRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: SendBulkTemplatedEmailRequest): any => ({ ...obj, }); @@ -4200,6 +4683,9 @@ export interface SendBulkTemplatedEmailResponse { } export namespace SendBulkTemplatedEmailResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: SendBulkTemplatedEmailResponse): any => ({ ...obj, }); @@ -4228,6 +4714,9 @@ export interface SendCustomVerificationEmailRequest { } export namespace SendCustomVerificationEmailRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: SendCustomVerificationEmailRequest): any => ({ ...obj, }); @@ -4245,6 +4734,9 @@ export interface SendCustomVerificationEmailResponse { } export namespace SendCustomVerificationEmailResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: SendCustomVerificationEmailResponse): any => ({ ...obj, }); @@ -4351,6 +4843,9 @@ export interface SendEmailRequest { } export namespace SendEmailRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: SendEmailRequest): any => ({ ...obj, }); @@ -4367,6 +4862,9 @@ export interface SendEmailResponse { } export namespace SendEmailResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: SendEmailResponse): any => ({ ...obj, }); @@ -4515,6 +5013,9 @@ export interface SendRawEmailRequest { } export namespace SendRawEmailRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: SendRawEmailRequest): any => ({ ...obj, }); @@ -4532,6 +5033,9 @@ export interface SendRawEmailResponse { } export namespace SendRawEmailResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: SendRawEmailResponse): any => ({ ...obj, }); @@ -4651,6 +5155,9 @@ export interface SendTemplatedEmailRequest { } export namespace SendTemplatedEmailRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: SendTemplatedEmailRequest): any => ({ ...obj, }); @@ -4665,6 +5172,9 @@ export interface SendTemplatedEmailResponse { } export namespace SendTemplatedEmailResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: SendTemplatedEmailResponse): any => ({ ...obj, }); @@ -4683,6 +5193,9 @@ export interface SetActiveReceiptRuleSetRequest { } export namespace SetActiveReceiptRuleSetRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: SetActiveReceiptRuleSetRequest): any => ({ ...obj, }); @@ -4694,6 +5207,9 @@ export namespace SetActiveReceiptRuleSetRequest { export interface SetActiveReceiptRuleSetResponse {} export namespace SetActiveReceiptRuleSetResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: SetActiveReceiptRuleSetResponse): any => ({ ...obj, }); @@ -4717,6 +5233,9 @@ export interface SetIdentityDkimEnabledRequest { } export namespace SetIdentityDkimEnabledRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: SetIdentityDkimEnabledRequest): any => ({ ...obj, }); @@ -4728,6 +5247,9 @@ export namespace SetIdentityDkimEnabledRequest { export interface SetIdentityDkimEnabledResponse {} export namespace SetIdentityDkimEnabledResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: SetIdentityDkimEnabledResponse): any => ({ ...obj, }); @@ -4759,6 +5281,9 @@ export interface SetIdentityFeedbackForwardingEnabledRequest { } export namespace SetIdentityFeedbackForwardingEnabledRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: SetIdentityFeedbackForwardingEnabledRequest): any => ({ ...obj, }); @@ -4770,6 +5295,9 @@ export namespace SetIdentityFeedbackForwardingEnabledRequest { export interface SetIdentityFeedbackForwardingEnabledResponse {} export namespace SetIdentityFeedbackForwardingEnabledResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: SetIdentityFeedbackForwardingEnabledResponse): any => ({ ...obj, }); @@ -4805,6 +5333,9 @@ export interface SetIdentityHeadersInNotificationsEnabledRequest { } export namespace SetIdentityHeadersInNotificationsEnabledRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: SetIdentityHeadersInNotificationsEnabledRequest): any => ({ ...obj, }); @@ -4816,6 +5347,9 @@ export namespace SetIdentityHeadersInNotificationsEnabledRequest { export interface SetIdentityHeadersInNotificationsEnabledResponse {} export namespace SetIdentityHeadersInNotificationsEnabledResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: SetIdentityHeadersInNotificationsEnabledResponse): any => ({ ...obj, }); @@ -4858,6 +5392,9 @@ export interface SetIdentityMailFromDomainRequest { } export namespace SetIdentityMailFromDomainRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: SetIdentityMailFromDomainRequest): any => ({ ...obj, }); @@ -4869,6 +5406,9 @@ export namespace SetIdentityMailFromDomainRequest { export interface SetIdentityMailFromDomainResponse {} export namespace SetIdentityMailFromDomainResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: SetIdentityMailFromDomainResponse): any => ({ ...obj, }); @@ -4908,6 +5448,9 @@ export interface SetIdentityNotificationTopicRequest { } export namespace SetIdentityNotificationTopicRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: SetIdentityNotificationTopicRequest): any => ({ ...obj, }); @@ -4919,6 +5462,9 @@ export namespace SetIdentityNotificationTopicRequest { export interface SetIdentityNotificationTopicResponse {} export namespace SetIdentityNotificationTopicResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: SetIdentityNotificationTopicResponse): any => ({ ...obj, }); @@ -4946,6 +5492,9 @@ export interface SetReceiptRulePositionRequest { } export namespace SetReceiptRulePositionRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: SetReceiptRulePositionRequest): any => ({ ...obj, }); @@ -4957,6 +5506,9 @@ export namespace SetReceiptRulePositionRequest { export interface SetReceiptRulePositionResponse {} export namespace SetReceiptRulePositionResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: SetReceiptRulePositionResponse): any => ({ ...obj, }); @@ -4977,6 +5529,9 @@ export interface TestRenderTemplateRequest { } export namespace TestRenderTemplateRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: TestRenderTemplateRequest): any => ({ ...obj, }); @@ -4991,6 +5546,9 @@ export interface TestRenderTemplateResponse { } export namespace TestRenderTemplateResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: TestRenderTemplateResponse): any => ({ ...obj, }); @@ -5009,6 +5567,9 @@ export interface UpdateAccountSendingEnabledRequest { } export namespace UpdateAccountSendingEnabledRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateAccountSendingEnabledRequest): any => ({ ...obj, }); @@ -5035,6 +5596,9 @@ export interface UpdateConfigurationSetEventDestinationRequest { } export namespace UpdateConfigurationSetEventDestinationRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateConfigurationSetEventDestinationRequest): any => ({ ...obj, }); @@ -5046,6 +5610,9 @@ export namespace UpdateConfigurationSetEventDestinationRequest { export interface UpdateConfigurationSetEventDestinationResponse {} export namespace UpdateConfigurationSetEventDestinationResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateConfigurationSetEventDestinationResponse): any => ({ ...obj, }); @@ -5069,6 +5636,9 @@ export interface UpdateConfigurationSetReputationMetricsEnabledRequest { } export namespace UpdateConfigurationSetReputationMetricsEnabledRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateConfigurationSetReputationMetricsEnabledRequest): any => ({ ...obj, }); @@ -5092,6 +5662,9 @@ export interface UpdateConfigurationSetSendingEnabledRequest { } export namespace UpdateConfigurationSetSendingEnabledRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateConfigurationSetSendingEnabledRequest): any => ({ ...obj, }); @@ -5118,6 +5691,9 @@ export interface UpdateConfigurationSetTrackingOptionsRequest { } export namespace UpdateConfigurationSetTrackingOptionsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateConfigurationSetTrackingOptionsRequest): any => ({ ...obj, }); @@ -5129,6 +5705,9 @@ export namespace UpdateConfigurationSetTrackingOptionsRequest { export interface UpdateConfigurationSetTrackingOptionsResponse {} export namespace UpdateConfigurationSetTrackingOptionsResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateConfigurationSetTrackingOptionsResponse): any => ({ ...obj, }); @@ -5175,6 +5754,9 @@ export interface UpdateCustomVerificationEmailTemplateRequest { } export namespace UpdateCustomVerificationEmailTemplateRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateCustomVerificationEmailTemplateRequest): any => ({ ...obj, }); @@ -5198,6 +5780,9 @@ export interface UpdateReceiptRuleRequest { } export namespace UpdateReceiptRuleRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateReceiptRuleRequest): any => ({ ...obj, }); @@ -5209,6 +5794,9 @@ export namespace UpdateReceiptRuleRequest { export interface UpdateReceiptRuleResponse {} export namespace UpdateReceiptRuleResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateReceiptRuleResponse): any => ({ ...obj, }); @@ -5223,6 +5811,9 @@ export interface UpdateTemplateRequest { } export namespace UpdateTemplateRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateTemplateRequest): any => ({ ...obj, }); @@ -5231,6 +5822,9 @@ export namespace UpdateTemplateRequest { export interface UpdateTemplateResponse {} export namespace UpdateTemplateResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateTemplateResponse): any => ({ ...obj, }); @@ -5249,6 +5843,9 @@ export interface VerifyDomainDkimRequest { } export namespace VerifyDomainDkimRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: VerifyDomainDkimRequest): any => ({ ...obj, }); @@ -5274,6 +5871,9 @@ export interface VerifyDomainDkimResponse { } export namespace VerifyDomainDkimResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: VerifyDomainDkimResponse): any => ({ ...obj, }); @@ -5293,6 +5893,9 @@ export interface VerifyDomainIdentityRequest { } export namespace VerifyDomainIdentityRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: VerifyDomainIdentityRequest): any => ({ ...obj, }); @@ -5316,6 +5919,9 @@ export interface VerifyDomainIdentityResponse { } export namespace VerifyDomainIdentityResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: VerifyDomainIdentityResponse): any => ({ ...obj, }); @@ -5334,6 +5940,9 @@ export interface VerifyEmailAddressRequest { } export namespace VerifyEmailAddressRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: VerifyEmailAddressRequest): any => ({ ...obj, }); @@ -5352,6 +5961,9 @@ export interface VerifyEmailIdentityRequest { } export namespace VerifyEmailIdentityRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: VerifyEmailIdentityRequest): any => ({ ...obj, }); @@ -5363,6 +5975,9 @@ export namespace VerifyEmailIdentityRequest { export interface VerifyEmailIdentityResponse {} export namespace VerifyEmailIdentityResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: VerifyEmailIdentityResponse): any => ({ ...obj, }); diff --git a/clients/client-sesv2/commands/CreateConfigurationSetCommand.ts b/clients/client-sesv2/commands/CreateConfigurationSetCommand.ts index c84f3a3341de..86fe93f4987d 100644 --- a/clients/client-sesv2/commands/CreateConfigurationSetCommand.ts +++ b/clients/client-sesv2/commands/CreateConfigurationSetCommand.ts @@ -26,6 +26,20 @@ export interface CreateConfigurationSetCommandOutput extends CreateConfiguration * 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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { SESv2Client, CreateConfigurationSetCommand } from "@aws-sdk/client-sesv2"; // ES Modules import + * // const { SESv2Client, CreateConfigurationSetCommand } = require("@aws-sdk/client-sesv2"); // CommonJS import + * const client = new SESv2Client(config); + * const command = new CreateConfigurationSetCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreateConfigurationSetCommandInput} for command's `input` shape. + * @see {@link CreateConfigurationSetCommandOutput} for command's `response` shape. + * @see {@link SESv2ClientResolvedConfig | config} for command's `input` shape. + * */ export class CreateConfigurationSetCommand extends $Command< CreateConfigurationSetCommandInput, diff --git a/clients/client-sesv2/commands/CreateConfigurationSetEventDestinationCommand.ts b/clients/client-sesv2/commands/CreateConfigurationSetEventDestinationCommand.ts index a37632651384..070fceb4e71b 100644 --- a/clients/client-sesv2/commands/CreateConfigurationSetEventDestinationCommand.ts +++ b/clients/client-sesv2/commands/CreateConfigurationSetEventDestinationCommand.ts @@ -34,6 +34,20 @@ export interface CreateConfigurationSetEventDestinationCommandOutput * 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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { SESv2Client, CreateConfigurationSetEventDestinationCommand } from "@aws-sdk/client-sesv2"; // ES Modules import + * // const { SESv2Client, CreateConfigurationSetEventDestinationCommand } = require("@aws-sdk/client-sesv2"); // CommonJS import + * const client = new SESv2Client(config); + * const command = new CreateConfigurationSetEventDestinationCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreateConfigurationSetEventDestinationCommandInput} for command's `input` shape. + * @see {@link CreateConfigurationSetEventDestinationCommandOutput} for command's `response` shape. + * @see {@link SESv2ClientResolvedConfig | config} for command's `input` shape. + * */ export class CreateConfigurationSetEventDestinationCommand extends $Command< CreateConfigurationSetEventDestinationCommandInput, diff --git a/clients/client-sesv2/commands/CreateContactCommand.ts b/clients/client-sesv2/commands/CreateContactCommand.ts index 961435f11a11..350c50d80baf 100644 --- a/clients/client-sesv2/commands/CreateContactCommand.ts +++ b/clients/client-sesv2/commands/CreateContactCommand.ts @@ -23,6 +23,20 @@ export interface CreateContactCommandOutput extends CreateContactResponse, __Met /** *

Creates a contact, which is an end-user who is receiving the email, and adds them to a * contact list.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { SESv2Client, CreateContactCommand } from "@aws-sdk/client-sesv2"; // ES Modules import + * // const { SESv2Client, CreateContactCommand } = require("@aws-sdk/client-sesv2"); // CommonJS import + * const client = new SESv2Client(config); + * const command = new CreateContactCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreateContactCommandInput} for command's `input` shape. + * @see {@link CreateContactCommandOutput} for command's `response` shape. + * @see {@link SESv2ClientResolvedConfig | config} for command's `input` shape. + * */ export class CreateContactCommand extends $Command< CreateContactCommandInput, diff --git a/clients/client-sesv2/commands/CreateContactListCommand.ts b/clients/client-sesv2/commands/CreateContactListCommand.ts index 49535946103c..f8513c69dfd6 100644 --- a/clients/client-sesv2/commands/CreateContactListCommand.ts +++ b/clients/client-sesv2/commands/CreateContactListCommand.ts @@ -22,6 +22,20 @@ export interface CreateContactListCommandOutput extends CreateContactListRespons /** *

Creates a contact list.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { SESv2Client, CreateContactListCommand } from "@aws-sdk/client-sesv2"; // ES Modules import + * // const { SESv2Client, CreateContactListCommand } = require("@aws-sdk/client-sesv2"); // CommonJS import + * const client = new SESv2Client(config); + * const command = new CreateContactListCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreateContactListCommandInput} for command's `input` shape. + * @see {@link CreateContactListCommandOutput} for command's `response` shape. + * @see {@link SESv2ClientResolvedConfig | config} for command's `input` shape. + * */ export class CreateContactListCommand extends $Command< CreateContactListCommandInput, diff --git a/clients/client-sesv2/commands/CreateCustomVerificationEmailTemplateCommand.ts b/clients/client-sesv2/commands/CreateCustomVerificationEmailTemplateCommand.ts index 80de75e5ea05..e55fe93cbd04 100644 --- a/clients/client-sesv2/commands/CreateCustomVerificationEmailTemplateCommand.ts +++ b/clients/client-sesv2/commands/CreateCustomVerificationEmailTemplateCommand.ts @@ -31,6 +31,20 @@ export interface CreateCustomVerificationEmailTemplateCommandOutput *

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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { SESv2Client, CreateCustomVerificationEmailTemplateCommand } from "@aws-sdk/client-sesv2"; // ES Modules import + * // const { SESv2Client, CreateCustomVerificationEmailTemplateCommand } = require("@aws-sdk/client-sesv2"); // CommonJS import + * const client = new SESv2Client(config); + * const command = new CreateCustomVerificationEmailTemplateCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreateCustomVerificationEmailTemplateCommandInput} for command's `input` shape. + * @see {@link CreateCustomVerificationEmailTemplateCommandOutput} for command's `response` shape. + * @see {@link SESv2ClientResolvedConfig | config} for command's `input` shape. + * */ export class CreateCustomVerificationEmailTemplateCommand extends $Command< CreateCustomVerificationEmailTemplateCommandInput, diff --git a/clients/client-sesv2/commands/CreateDedicatedIpPoolCommand.ts b/clients/client-sesv2/commands/CreateDedicatedIpPoolCommand.ts index ba21f2858552..ee335b2fe1ac 100644 --- a/clients/client-sesv2/commands/CreateDedicatedIpPoolCommand.ts +++ b/clients/client-sesv2/commands/CreateDedicatedIpPoolCommand.ts @@ -25,6 +25,20 @@ export interface CreateDedicatedIpPoolCommandOutput extends CreateDedicatedIpPoo * IP addresses that are associated with your AWS 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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { SESv2Client, CreateDedicatedIpPoolCommand } from "@aws-sdk/client-sesv2"; // ES Modules import + * // const { SESv2Client, CreateDedicatedIpPoolCommand } = require("@aws-sdk/client-sesv2"); // CommonJS import + * const client = new SESv2Client(config); + * const command = new CreateDedicatedIpPoolCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreateDedicatedIpPoolCommandInput} for command's `input` shape. + * @see {@link CreateDedicatedIpPoolCommandOutput} for command's `response` shape. + * @see {@link SESv2ClientResolvedConfig | config} for command's `input` shape. + * */ export class CreateDedicatedIpPoolCommand extends $Command< CreateDedicatedIpPoolCommandInput, diff --git a/clients/client-sesv2/commands/CreateDeliverabilityTestReportCommand.ts b/clients/client-sesv2/commands/CreateDeliverabilityTestReportCommand.ts index 7d6e02df2fbf..1f9bf86e3eee 100644 --- a/clients/client-sesv2/commands/CreateDeliverabilityTestReportCommand.ts +++ b/clients/client-sesv2/commands/CreateDeliverabilityTestReportCommand.ts @@ -30,6 +30,20 @@ export interface CreateDeliverabilityTestReportCommandOutput * providers. After about 24 hours, the test is complete, and you can use the * GetDeliverabilityTestReport operation to view the results of the * test.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { SESv2Client, CreateDeliverabilityTestReportCommand } from "@aws-sdk/client-sesv2"; // ES Modules import + * // const { SESv2Client, CreateDeliverabilityTestReportCommand } = require("@aws-sdk/client-sesv2"); // CommonJS import + * const client = new SESv2Client(config); + * const command = new CreateDeliverabilityTestReportCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreateDeliverabilityTestReportCommandInput} for command's `input` shape. + * @see {@link CreateDeliverabilityTestReportCommandOutput} for command's `response` shape. + * @see {@link SESv2ClientResolvedConfig | config} for command's `input` shape. + * */ export class CreateDeliverabilityTestReportCommand extends $Command< CreateDeliverabilityTestReportCommandInput, diff --git a/clients/client-sesv2/commands/CreateEmailIdentityCommand.ts b/clients/client-sesv2/commands/CreateEmailIdentityCommand.ts index dfea25af93d8..2ec9642b772d 100644 --- a/clients/client-sesv2/commands/CreateEmailIdentityCommand.ts +++ b/clients/client-sesv2/commands/CreateEmailIdentityCommand.ts @@ -47,6 +47,20 @@ export interface CreateEmailIdentityCommandOutput extends CreateEmailIdentityRes * 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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { SESv2Client, CreateEmailIdentityCommand } from "@aws-sdk/client-sesv2"; // ES Modules import + * // const { SESv2Client, CreateEmailIdentityCommand } = require("@aws-sdk/client-sesv2"); // CommonJS import + * const client = new SESv2Client(config); + * const command = new CreateEmailIdentityCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreateEmailIdentityCommandInput} for command's `input` shape. + * @see {@link CreateEmailIdentityCommandOutput} for command's `response` shape. + * @see {@link SESv2ClientResolvedConfig | config} for command's `input` shape. + * */ export class CreateEmailIdentityCommand extends $Command< CreateEmailIdentityCommandInput, diff --git a/clients/client-sesv2/commands/CreateEmailIdentityPolicyCommand.ts b/clients/client-sesv2/commands/CreateEmailIdentityPolicyCommand.ts index 7aa552c5b3bb..9c6c9e850fea 100644 --- a/clients/client-sesv2/commands/CreateEmailIdentityPolicyCommand.ts +++ b/clients/client-sesv2/commands/CreateEmailIdentityPolicyCommand.ts @@ -33,6 +33,20 @@ export interface CreateEmailIdentityPolicyCommandOutput extends CreateEmailIdent * Guide.

* *

You can execute this operation no more than once per second.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { SESv2Client, CreateEmailIdentityPolicyCommand } from "@aws-sdk/client-sesv2"; // ES Modules import + * // const { SESv2Client, CreateEmailIdentityPolicyCommand } = require("@aws-sdk/client-sesv2"); // CommonJS import + * const client = new SESv2Client(config); + * const command = new CreateEmailIdentityPolicyCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreateEmailIdentityPolicyCommandInput} for command's `input` shape. + * @see {@link CreateEmailIdentityPolicyCommandOutput} for command's `response` shape. + * @see {@link SESv2ClientResolvedConfig | config} for command's `input` shape. + * */ export class CreateEmailIdentityPolicyCommand extends $Command< CreateEmailIdentityPolicyCommandInput, diff --git a/clients/client-sesv2/commands/CreateEmailTemplateCommand.ts b/clients/client-sesv2/commands/CreateEmailTemplateCommand.ts index 8c2700bfde7f..10d931f0f89c 100644 --- a/clients/client-sesv2/commands/CreateEmailTemplateCommand.ts +++ b/clients/client-sesv2/commands/CreateEmailTemplateCommand.ts @@ -25,6 +25,20 @@ export interface CreateEmailTemplateCommandOutput extends CreateEmailTemplateRes * 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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { SESv2Client, CreateEmailTemplateCommand } from "@aws-sdk/client-sesv2"; // ES Modules import + * // const { SESv2Client, CreateEmailTemplateCommand } = require("@aws-sdk/client-sesv2"); // CommonJS import + * const client = new SESv2Client(config); + * const command = new CreateEmailTemplateCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreateEmailTemplateCommandInput} for command's `input` shape. + * @see {@link CreateEmailTemplateCommandOutput} for command's `response` shape. + * @see {@link SESv2ClientResolvedConfig | config} for command's `input` shape. + * */ export class CreateEmailTemplateCommand extends $Command< CreateEmailTemplateCommandInput, diff --git a/clients/client-sesv2/commands/CreateImportJobCommand.ts b/clients/client-sesv2/commands/CreateImportJobCommand.ts index 829c7d031d81..e4c7651ff1d6 100644 --- a/clients/client-sesv2/commands/CreateImportJobCommand.ts +++ b/clients/client-sesv2/commands/CreateImportJobCommand.ts @@ -22,6 +22,20 @@ export interface CreateImportJobCommandOutput extends CreateImportJobResponse, _ /** *

Creates an import job for a data destination.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { SESv2Client, CreateImportJobCommand } from "@aws-sdk/client-sesv2"; // ES Modules import + * // const { SESv2Client, CreateImportJobCommand } = require("@aws-sdk/client-sesv2"); // CommonJS import + * const client = new SESv2Client(config); + * const command = new CreateImportJobCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreateImportJobCommandInput} for command's `input` shape. + * @see {@link CreateImportJobCommandOutput} for command's `response` shape. + * @see {@link SESv2ClientResolvedConfig | config} for command's `input` shape. + * */ export class CreateImportJobCommand extends $Command< CreateImportJobCommandInput, diff --git a/clients/client-sesv2/commands/DeleteConfigurationSetCommand.ts b/clients/client-sesv2/commands/DeleteConfigurationSetCommand.ts index 36601def7eb6..eed83f105c9c 100644 --- a/clients/client-sesv2/commands/DeleteConfigurationSetCommand.ts +++ b/clients/client-sesv2/commands/DeleteConfigurationSetCommand.ts @@ -27,6 +27,20 @@ export interface DeleteConfigurationSetCommandOutput extends DeleteConfiguration * 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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { SESv2Client, DeleteConfigurationSetCommand } from "@aws-sdk/client-sesv2"; // ES Modules import + * // const { SESv2Client, DeleteConfigurationSetCommand } = require("@aws-sdk/client-sesv2"); // CommonJS import + * const client = new SESv2Client(config); + * const command = new DeleteConfigurationSetCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteConfigurationSetCommandInput} for command's `input` shape. + * @see {@link DeleteConfigurationSetCommandOutput} for command's `response` shape. + * @see {@link SESv2ClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteConfigurationSetCommand extends $Command< DeleteConfigurationSetCommandInput, diff --git a/clients/client-sesv2/commands/DeleteConfigurationSetEventDestinationCommand.ts b/clients/client-sesv2/commands/DeleteConfigurationSetEventDestinationCommand.ts index 19da990c0722..bc9597fba075 100644 --- a/clients/client-sesv2/commands/DeleteConfigurationSetEventDestinationCommand.ts +++ b/clients/client-sesv2/commands/DeleteConfigurationSetEventDestinationCommand.ts @@ -34,6 +34,20 @@ export interface DeleteConfigurationSetEventDestinationCommandOutput * 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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { SESv2Client, DeleteConfigurationSetEventDestinationCommand } from "@aws-sdk/client-sesv2"; // ES Modules import + * // const { SESv2Client, DeleteConfigurationSetEventDestinationCommand } = require("@aws-sdk/client-sesv2"); // CommonJS import + * const client = new SESv2Client(config); + * const command = new DeleteConfigurationSetEventDestinationCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteConfigurationSetEventDestinationCommandInput} for command's `input` shape. + * @see {@link DeleteConfigurationSetEventDestinationCommandOutput} for command's `response` shape. + * @see {@link SESv2ClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteConfigurationSetEventDestinationCommand extends $Command< DeleteConfigurationSetEventDestinationCommandInput, diff --git a/clients/client-sesv2/commands/DeleteContactCommand.ts b/clients/client-sesv2/commands/DeleteContactCommand.ts index 165411dada61..6ce57b4ebccf 100644 --- a/clients/client-sesv2/commands/DeleteContactCommand.ts +++ b/clients/client-sesv2/commands/DeleteContactCommand.ts @@ -22,6 +22,20 @@ export interface DeleteContactCommandOutput extends DeleteContactResponse, __Met /** *

Removes a contact from a contact list.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { SESv2Client, DeleteContactCommand } from "@aws-sdk/client-sesv2"; // ES Modules import + * // const { SESv2Client, DeleteContactCommand } = require("@aws-sdk/client-sesv2"); // CommonJS import + * const client = new SESv2Client(config); + * const command = new DeleteContactCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteContactCommandInput} for command's `input` shape. + * @see {@link DeleteContactCommandOutput} for command's `response` shape. + * @see {@link SESv2ClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteContactCommand extends $Command< DeleteContactCommandInput, diff --git a/clients/client-sesv2/commands/DeleteContactListCommand.ts b/clients/client-sesv2/commands/DeleteContactListCommand.ts index 55fd29ccf24c..da491ae5b590 100644 --- a/clients/client-sesv2/commands/DeleteContactListCommand.ts +++ b/clients/client-sesv2/commands/DeleteContactListCommand.ts @@ -22,6 +22,20 @@ export interface DeleteContactListCommandOutput extends DeleteContactListRespons /** *

Deletes a contact list and all of the contacts on that list.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { SESv2Client, DeleteContactListCommand } from "@aws-sdk/client-sesv2"; // ES Modules import + * // const { SESv2Client, DeleteContactListCommand } = require("@aws-sdk/client-sesv2"); // CommonJS import + * const client = new SESv2Client(config); + * const command = new DeleteContactListCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteContactListCommandInput} for command's `input` shape. + * @see {@link DeleteContactListCommandOutput} for command's `response` shape. + * @see {@link SESv2ClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteContactListCommand extends $Command< DeleteContactListCommandInput, diff --git a/clients/client-sesv2/commands/DeleteCustomVerificationEmailTemplateCommand.ts b/clients/client-sesv2/commands/DeleteCustomVerificationEmailTemplateCommand.ts index 9435ae70c78c..1d7e40039d72 100644 --- a/clients/client-sesv2/commands/DeleteCustomVerificationEmailTemplateCommand.ts +++ b/clients/client-sesv2/commands/DeleteCustomVerificationEmailTemplateCommand.ts @@ -31,6 +31,20 @@ export interface DeleteCustomVerificationEmailTemplateCommandOutput *

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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { SESv2Client, DeleteCustomVerificationEmailTemplateCommand } from "@aws-sdk/client-sesv2"; // ES Modules import + * // const { SESv2Client, DeleteCustomVerificationEmailTemplateCommand } = require("@aws-sdk/client-sesv2"); // CommonJS import + * const client = new SESv2Client(config); + * const command = new DeleteCustomVerificationEmailTemplateCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteCustomVerificationEmailTemplateCommandInput} for command's `input` shape. + * @see {@link DeleteCustomVerificationEmailTemplateCommandOutput} for command's `response` shape. + * @see {@link SESv2ClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteCustomVerificationEmailTemplateCommand extends $Command< DeleteCustomVerificationEmailTemplateCommandInput, diff --git a/clients/client-sesv2/commands/DeleteDedicatedIpPoolCommand.ts b/clients/client-sesv2/commands/DeleteDedicatedIpPoolCommand.ts index 0368d491fdf3..dc81cc2f0e65 100644 --- a/clients/client-sesv2/commands/DeleteDedicatedIpPoolCommand.ts +++ b/clients/client-sesv2/commands/DeleteDedicatedIpPoolCommand.ts @@ -22,6 +22,20 @@ export interface DeleteDedicatedIpPoolCommandOutput extends DeleteDedicatedIpPoo /** *

Delete a dedicated IP pool.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { SESv2Client, DeleteDedicatedIpPoolCommand } from "@aws-sdk/client-sesv2"; // ES Modules import + * // const { SESv2Client, DeleteDedicatedIpPoolCommand } = require("@aws-sdk/client-sesv2"); // CommonJS import + * const client = new SESv2Client(config); + * const command = new DeleteDedicatedIpPoolCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteDedicatedIpPoolCommandInput} for command's `input` shape. + * @see {@link DeleteDedicatedIpPoolCommandOutput} for command's `response` shape. + * @see {@link SESv2ClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteDedicatedIpPoolCommand extends $Command< DeleteDedicatedIpPoolCommandInput, diff --git a/clients/client-sesv2/commands/DeleteEmailIdentityCommand.ts b/clients/client-sesv2/commands/DeleteEmailIdentityCommand.ts index 1a294a672dba..1369870e61a1 100644 --- a/clients/client-sesv2/commands/DeleteEmailIdentityCommand.ts +++ b/clients/client-sesv2/commands/DeleteEmailIdentityCommand.ts @@ -23,6 +23,20 @@ export interface DeleteEmailIdentityCommandOutput extends DeleteEmailIdentityRes /** *

Deletes an email identity. An identity can be either an email address or a domain * name.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { SESv2Client, DeleteEmailIdentityCommand } from "@aws-sdk/client-sesv2"; // ES Modules import + * // const { SESv2Client, DeleteEmailIdentityCommand } = require("@aws-sdk/client-sesv2"); // CommonJS import + * const client = new SESv2Client(config); + * const command = new DeleteEmailIdentityCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteEmailIdentityCommandInput} for command's `input` shape. + * @see {@link DeleteEmailIdentityCommandOutput} for command's `response` shape. + * @see {@link SESv2ClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteEmailIdentityCommand extends $Command< DeleteEmailIdentityCommandInput, diff --git a/clients/client-sesv2/commands/DeleteEmailIdentityPolicyCommand.ts b/clients/client-sesv2/commands/DeleteEmailIdentityPolicyCommand.ts index 879f30a1dad8..3d2c836e4137 100644 --- a/clients/client-sesv2/commands/DeleteEmailIdentityPolicyCommand.ts +++ b/clients/client-sesv2/commands/DeleteEmailIdentityPolicyCommand.ts @@ -34,6 +34,20 @@ export interface DeleteEmailIdentityPolicyCommandOutput extends DeleteEmailIdent * Guide.

* *

You can execute this operation no more than once per second.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { SESv2Client, DeleteEmailIdentityPolicyCommand } from "@aws-sdk/client-sesv2"; // ES Modules import + * // const { SESv2Client, DeleteEmailIdentityPolicyCommand } = require("@aws-sdk/client-sesv2"); // CommonJS import + * const client = new SESv2Client(config); + * const command = new DeleteEmailIdentityPolicyCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteEmailIdentityPolicyCommandInput} for command's `input` shape. + * @see {@link DeleteEmailIdentityPolicyCommandOutput} for command's `response` shape. + * @see {@link SESv2ClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteEmailIdentityPolicyCommand extends $Command< DeleteEmailIdentityPolicyCommandInput, diff --git a/clients/client-sesv2/commands/DeleteEmailTemplateCommand.ts b/clients/client-sesv2/commands/DeleteEmailTemplateCommand.ts index 379aaf7db37c..4d629789b08f 100644 --- a/clients/client-sesv2/commands/DeleteEmailTemplateCommand.ts +++ b/clients/client-sesv2/commands/DeleteEmailTemplateCommand.ts @@ -24,6 +24,20 @@ export interface DeleteEmailTemplateCommandOutput extends DeleteEmailTemplateRes *

Deletes an email template.

* *

You can execute this operation no more than once per second.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { SESv2Client, DeleteEmailTemplateCommand } from "@aws-sdk/client-sesv2"; // ES Modules import + * // const { SESv2Client, DeleteEmailTemplateCommand } = require("@aws-sdk/client-sesv2"); // CommonJS import + * const client = new SESv2Client(config); + * const command = new DeleteEmailTemplateCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteEmailTemplateCommandInput} for command's `input` shape. + * @see {@link DeleteEmailTemplateCommandOutput} for command's `response` shape. + * @see {@link SESv2ClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteEmailTemplateCommand extends $Command< DeleteEmailTemplateCommandInput, diff --git a/clients/client-sesv2/commands/DeleteSuppressedDestinationCommand.ts b/clients/client-sesv2/commands/DeleteSuppressedDestinationCommand.ts index b90bab800dbb..5d0ac5756755 100644 --- a/clients/client-sesv2/commands/DeleteSuppressedDestinationCommand.ts +++ b/clients/client-sesv2/commands/DeleteSuppressedDestinationCommand.ts @@ -24,6 +24,20 @@ export interface DeleteSuppressedDestinationCommandOutput /** *

Removes an email address from the suppression list for your account.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { SESv2Client, DeleteSuppressedDestinationCommand } from "@aws-sdk/client-sesv2"; // ES Modules import + * // const { SESv2Client, DeleteSuppressedDestinationCommand } = require("@aws-sdk/client-sesv2"); // CommonJS import + * const client = new SESv2Client(config); + * const command = new DeleteSuppressedDestinationCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteSuppressedDestinationCommandInput} for command's `input` shape. + * @see {@link DeleteSuppressedDestinationCommandOutput} for command's `response` shape. + * @see {@link SESv2ClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteSuppressedDestinationCommand extends $Command< DeleteSuppressedDestinationCommandInput, diff --git a/clients/client-sesv2/commands/GetAccountCommand.ts b/clients/client-sesv2/commands/GetAccountCommand.ts index c2da0f4cd8f2..84f1d3b15f17 100644 --- a/clients/client-sesv2/commands/GetAccountCommand.ts +++ b/clients/client-sesv2/commands/GetAccountCommand.ts @@ -23,6 +23,20 @@ export interface GetAccountCommandOutput extends GetAccountResponse, __MetadataB /** *

Obtain information about the email-sending status and capabilities of your Amazon SES * account in the current AWS Region.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { SESv2Client, GetAccountCommand } from "@aws-sdk/client-sesv2"; // ES Modules import + * // const { SESv2Client, GetAccountCommand } = require("@aws-sdk/client-sesv2"); // CommonJS import + * const client = new SESv2Client(config); + * const command = new GetAccountCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetAccountCommandInput} for command's `input` shape. + * @see {@link GetAccountCommandOutput} for command's `response` shape. + * @see {@link SESv2ClientResolvedConfig | config} for command's `input` shape. + * */ export class GetAccountCommand extends $Command< GetAccountCommandInput, diff --git a/clients/client-sesv2/commands/GetBlacklistReportsCommand.ts b/clients/client-sesv2/commands/GetBlacklistReportsCommand.ts index ce120d92eda7..8e057bde8835 100644 --- a/clients/client-sesv2/commands/GetBlacklistReportsCommand.ts +++ b/clients/client-sesv2/commands/GetBlacklistReportsCommand.ts @@ -22,6 +22,20 @@ export interface GetBlacklistReportsCommandOutput extends GetBlacklistReportsRes /** *

Retrieve a list of the blacklists that your dedicated IP addresses appear on.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { SESv2Client, GetBlacklistReportsCommand } from "@aws-sdk/client-sesv2"; // ES Modules import + * // const { SESv2Client, GetBlacklistReportsCommand } = require("@aws-sdk/client-sesv2"); // CommonJS import + * const client = new SESv2Client(config); + * const command = new GetBlacklistReportsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetBlacklistReportsCommandInput} for command's `input` shape. + * @see {@link GetBlacklistReportsCommandOutput} for command's `response` shape. + * @see {@link SESv2ClientResolvedConfig | config} for command's `input` shape. + * */ export class GetBlacklistReportsCommand extends $Command< GetBlacklistReportsCommandInput, diff --git a/clients/client-sesv2/commands/GetConfigurationSetCommand.ts b/clients/client-sesv2/commands/GetConfigurationSetCommand.ts index df7055600ceb..62b56963179d 100644 --- a/clients/client-sesv2/commands/GetConfigurationSetCommand.ts +++ b/clients/client-sesv2/commands/GetConfigurationSetCommand.ts @@ -29,6 +29,20 @@ export interface GetConfigurationSetCommandOutput extends GetConfigurationSetRes * 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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { SESv2Client, GetConfigurationSetCommand } from "@aws-sdk/client-sesv2"; // ES Modules import + * // const { SESv2Client, GetConfigurationSetCommand } = require("@aws-sdk/client-sesv2"); // CommonJS import + * const client = new SESv2Client(config); + * const command = new GetConfigurationSetCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetConfigurationSetCommandInput} for command's `input` shape. + * @see {@link GetConfigurationSetCommandOutput} for command's `response` shape. + * @see {@link SESv2ClientResolvedConfig | config} for command's `input` shape. + * */ export class GetConfigurationSetCommand extends $Command< GetConfigurationSetCommandInput, diff --git a/clients/client-sesv2/commands/GetConfigurationSetEventDestinationsCommand.ts b/clients/client-sesv2/commands/GetConfigurationSetEventDestinationsCommand.ts index a8c021e04b17..a360d338b404 100644 --- a/clients/client-sesv2/commands/GetConfigurationSetEventDestinationsCommand.ts +++ b/clients/client-sesv2/commands/GetConfigurationSetEventDestinationsCommand.ts @@ -34,6 +34,20 @@ export interface GetConfigurationSetEventDestinationsCommandOutput * 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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { SESv2Client, GetConfigurationSetEventDestinationsCommand } from "@aws-sdk/client-sesv2"; // ES Modules import + * // const { SESv2Client, GetConfigurationSetEventDestinationsCommand } = require("@aws-sdk/client-sesv2"); // CommonJS import + * const client = new SESv2Client(config); + * const command = new GetConfigurationSetEventDestinationsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetConfigurationSetEventDestinationsCommandInput} for command's `input` shape. + * @see {@link GetConfigurationSetEventDestinationsCommandOutput} for command's `response` shape. + * @see {@link SESv2ClientResolvedConfig | config} for command's `input` shape. + * */ export class GetConfigurationSetEventDestinationsCommand extends $Command< GetConfigurationSetEventDestinationsCommandInput, diff --git a/clients/client-sesv2/commands/GetContactCommand.ts b/clients/client-sesv2/commands/GetContactCommand.ts index 4c0220f7f101..0c901f93be3b 100644 --- a/clients/client-sesv2/commands/GetContactCommand.ts +++ b/clients/client-sesv2/commands/GetContactCommand.ts @@ -22,6 +22,20 @@ export interface GetContactCommandOutput extends GetContactResponse, __MetadataB /** *

Returns a contact from a contact list.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { SESv2Client, GetContactCommand } from "@aws-sdk/client-sesv2"; // ES Modules import + * // const { SESv2Client, GetContactCommand } = require("@aws-sdk/client-sesv2"); // CommonJS import + * const client = new SESv2Client(config); + * const command = new GetContactCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetContactCommandInput} for command's `input` shape. + * @see {@link GetContactCommandOutput} for command's `response` shape. + * @see {@link SESv2ClientResolvedConfig | config} for command's `input` shape. + * */ export class GetContactCommand extends $Command< GetContactCommandInput, diff --git a/clients/client-sesv2/commands/GetContactListCommand.ts b/clients/client-sesv2/commands/GetContactListCommand.ts index b28251e45e13..33861c95b0ee 100644 --- a/clients/client-sesv2/commands/GetContactListCommand.ts +++ b/clients/client-sesv2/commands/GetContactListCommand.ts @@ -23,6 +23,20 @@ export interface GetContactListCommandOutput extends GetContactListResponse, __M /** *

Returns contact list metadata. It does not return any information about the contacts * present in the list.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { SESv2Client, GetContactListCommand } from "@aws-sdk/client-sesv2"; // ES Modules import + * // const { SESv2Client, GetContactListCommand } = require("@aws-sdk/client-sesv2"); // CommonJS import + * const client = new SESv2Client(config); + * const command = new GetContactListCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetContactListCommandInput} for command's `input` shape. + * @see {@link GetContactListCommandOutput} for command's `response` shape. + * @see {@link SESv2ClientResolvedConfig | config} for command's `input` shape. + * */ export class GetContactListCommand extends $Command< GetContactListCommandInput, diff --git a/clients/client-sesv2/commands/GetCustomVerificationEmailTemplateCommand.ts b/clients/client-sesv2/commands/GetCustomVerificationEmailTemplateCommand.ts index 3c08ad4e6a86..5ebc0a53792c 100644 --- a/clients/client-sesv2/commands/GetCustomVerificationEmailTemplateCommand.ts +++ b/clients/client-sesv2/commands/GetCustomVerificationEmailTemplateCommand.ts @@ -31,6 +31,20 @@ export interface GetCustomVerificationEmailTemplateCommandOutput *

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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { SESv2Client, GetCustomVerificationEmailTemplateCommand } from "@aws-sdk/client-sesv2"; // ES Modules import + * // const { SESv2Client, GetCustomVerificationEmailTemplateCommand } = require("@aws-sdk/client-sesv2"); // CommonJS import + * const client = new SESv2Client(config); + * const command = new GetCustomVerificationEmailTemplateCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetCustomVerificationEmailTemplateCommandInput} for command's `input` shape. + * @see {@link GetCustomVerificationEmailTemplateCommandOutput} for command's `response` shape. + * @see {@link SESv2ClientResolvedConfig | config} for command's `input` shape. + * */ export class GetCustomVerificationEmailTemplateCommand extends $Command< GetCustomVerificationEmailTemplateCommandInput, diff --git a/clients/client-sesv2/commands/GetDedicatedIpCommand.ts b/clients/client-sesv2/commands/GetDedicatedIpCommand.ts index bebb46db9317..effec6173fbb 100644 --- a/clients/client-sesv2/commands/GetDedicatedIpCommand.ts +++ b/clients/client-sesv2/commands/GetDedicatedIpCommand.ts @@ -24,6 +24,20 @@ export interface GetDedicatedIpCommandOutput extends GetDedicatedIpResponse, __M *

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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { SESv2Client, GetDedicatedIpCommand } from "@aws-sdk/client-sesv2"; // ES Modules import + * // const { SESv2Client, GetDedicatedIpCommand } = require("@aws-sdk/client-sesv2"); // CommonJS import + * const client = new SESv2Client(config); + * const command = new GetDedicatedIpCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetDedicatedIpCommandInput} for command's `input` shape. + * @see {@link GetDedicatedIpCommandOutput} for command's `response` shape. + * @see {@link SESv2ClientResolvedConfig | config} for command's `input` shape. + * */ export class GetDedicatedIpCommand extends $Command< GetDedicatedIpCommandInput, diff --git a/clients/client-sesv2/commands/GetDedicatedIpsCommand.ts b/clients/client-sesv2/commands/GetDedicatedIpsCommand.ts index 5d7b709239c6..b7a96a7b7f3b 100644 --- a/clients/client-sesv2/commands/GetDedicatedIpsCommand.ts +++ b/clients/client-sesv2/commands/GetDedicatedIpsCommand.ts @@ -23,6 +23,20 @@ export interface GetDedicatedIpsCommandOutput extends GetDedicatedIpsResponse, _ /** *

List the dedicated IP addresses that are associated with your AWS * account.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { SESv2Client, GetDedicatedIpsCommand } from "@aws-sdk/client-sesv2"; // ES Modules import + * // const { SESv2Client, GetDedicatedIpsCommand } = require("@aws-sdk/client-sesv2"); // CommonJS import + * const client = new SESv2Client(config); + * const command = new GetDedicatedIpsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetDedicatedIpsCommandInput} for command's `input` shape. + * @see {@link GetDedicatedIpsCommandOutput} for command's `response` shape. + * @see {@link SESv2ClientResolvedConfig | config} for command's `input` shape. + * */ export class GetDedicatedIpsCommand extends $Command< GetDedicatedIpsCommandInput, diff --git a/clients/client-sesv2/commands/GetDeliverabilityDashboardOptionsCommand.ts b/clients/client-sesv2/commands/GetDeliverabilityDashboardOptionsCommand.ts index cee2c88f8bb5..2533baa1df91 100644 --- a/clients/client-sesv2/commands/GetDeliverabilityDashboardOptionsCommand.ts +++ b/clients/client-sesv2/commands/GetDeliverabilityDashboardOptionsCommand.ts @@ -34,6 +34,20 @@ export interface GetDeliverabilityDashboardOptionsCommandOutput *

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 AWS services. For more * information about the features and cost of a Deliverability dashboard subscription, see Amazon SES Pricing.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { SESv2Client, GetDeliverabilityDashboardOptionsCommand } from "@aws-sdk/client-sesv2"; // ES Modules import + * // const { SESv2Client, GetDeliverabilityDashboardOptionsCommand } = require("@aws-sdk/client-sesv2"); // CommonJS import + * const client = new SESv2Client(config); + * const command = new GetDeliverabilityDashboardOptionsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetDeliverabilityDashboardOptionsCommandInput} for command's `input` shape. + * @see {@link GetDeliverabilityDashboardOptionsCommandOutput} for command's `response` shape. + * @see {@link SESv2ClientResolvedConfig | config} for command's `input` shape. + * */ export class GetDeliverabilityDashboardOptionsCommand extends $Command< GetDeliverabilityDashboardOptionsCommandInput, diff --git a/clients/client-sesv2/commands/GetDeliverabilityTestReportCommand.ts b/clients/client-sesv2/commands/GetDeliverabilityTestReportCommand.ts index 690d97a77c34..fba13d2d6b20 100644 --- a/clients/client-sesv2/commands/GetDeliverabilityTestReportCommand.ts +++ b/clients/client-sesv2/commands/GetDeliverabilityTestReportCommand.ts @@ -24,6 +24,20 @@ export interface GetDeliverabilityTestReportCommandOutput /** *

Retrieve the results of a predictive inbox placement test.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { SESv2Client, GetDeliverabilityTestReportCommand } from "@aws-sdk/client-sesv2"; // ES Modules import + * // const { SESv2Client, GetDeliverabilityTestReportCommand } = require("@aws-sdk/client-sesv2"); // CommonJS import + * const client = new SESv2Client(config); + * const command = new GetDeliverabilityTestReportCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetDeliverabilityTestReportCommandInput} for command's `input` shape. + * @see {@link GetDeliverabilityTestReportCommandOutput} for command's `response` shape. + * @see {@link SESv2ClientResolvedConfig | config} for command's `input` shape. + * */ export class GetDeliverabilityTestReportCommand extends $Command< GetDeliverabilityTestReportCommandInput, diff --git a/clients/client-sesv2/commands/GetDomainDeliverabilityCampaignCommand.ts b/clients/client-sesv2/commands/GetDomainDeliverabilityCampaignCommand.ts index 613bbadb59f3..701b656cb8f4 100644 --- a/clients/client-sesv2/commands/GetDomainDeliverabilityCampaignCommand.ts +++ b/clients/client-sesv2/commands/GetDomainDeliverabilityCampaignCommand.ts @@ -26,6 +26,20 @@ export interface GetDomainDeliverabilityCampaignCommandOutput *

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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { SESv2Client, GetDomainDeliverabilityCampaignCommand } from "@aws-sdk/client-sesv2"; // ES Modules import + * // const { SESv2Client, GetDomainDeliverabilityCampaignCommand } = require("@aws-sdk/client-sesv2"); // CommonJS import + * const client = new SESv2Client(config); + * const command = new GetDomainDeliverabilityCampaignCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetDomainDeliverabilityCampaignCommandInput} for command's `input` shape. + * @see {@link GetDomainDeliverabilityCampaignCommandOutput} for command's `response` shape. + * @see {@link SESv2ClientResolvedConfig | config} for command's `input` shape. + * */ export class GetDomainDeliverabilityCampaignCommand extends $Command< GetDomainDeliverabilityCampaignCommandInput, diff --git a/clients/client-sesv2/commands/GetDomainStatisticsReportCommand.ts b/clients/client-sesv2/commands/GetDomainStatisticsReportCommand.ts index 1ea5314e56f5..e4a377eb0567 100644 --- a/clients/client-sesv2/commands/GetDomainStatisticsReportCommand.ts +++ b/clients/client-sesv2/commands/GetDomainStatisticsReportCommand.ts @@ -23,6 +23,20 @@ export interface GetDomainStatisticsReportCommandOutput extends GetDomainStatist /** *

Retrieve inbox placement and engagement rates for the domains that you use to send * email.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { SESv2Client, GetDomainStatisticsReportCommand } from "@aws-sdk/client-sesv2"; // ES Modules import + * // const { SESv2Client, GetDomainStatisticsReportCommand } = require("@aws-sdk/client-sesv2"); // CommonJS import + * const client = new SESv2Client(config); + * const command = new GetDomainStatisticsReportCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetDomainStatisticsReportCommandInput} for command's `input` shape. + * @see {@link GetDomainStatisticsReportCommandOutput} for command's `response` shape. + * @see {@link SESv2ClientResolvedConfig | config} for command's `input` shape. + * */ export class GetDomainStatisticsReportCommand extends $Command< GetDomainStatisticsReportCommandInput, diff --git a/clients/client-sesv2/commands/GetEmailIdentityCommand.ts b/clients/client-sesv2/commands/GetEmailIdentityCommand.ts index 7d29a61ee269..cd0e68b80f71 100644 --- a/clients/client-sesv2/commands/GetEmailIdentityCommand.ts +++ b/clients/client-sesv2/commands/GetEmailIdentityCommand.ts @@ -24,6 +24,20 @@ export interface GetEmailIdentityCommandOutput extends GetEmailIdentityResponse, *

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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { SESv2Client, GetEmailIdentityCommand } from "@aws-sdk/client-sesv2"; // ES Modules import + * // const { SESv2Client, GetEmailIdentityCommand } = require("@aws-sdk/client-sesv2"); // CommonJS import + * const client = new SESv2Client(config); + * const command = new GetEmailIdentityCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetEmailIdentityCommandInput} for command's `input` shape. + * @see {@link GetEmailIdentityCommandOutput} for command's `response` shape. + * @see {@link SESv2ClientResolvedConfig | config} for command's `input` shape. + * */ export class GetEmailIdentityCommand extends $Command< GetEmailIdentityCommandInput, diff --git a/clients/client-sesv2/commands/GetEmailIdentityPoliciesCommand.ts b/clients/client-sesv2/commands/GetEmailIdentityPoliciesCommand.ts index 8f97935d5714..24fcfbff4957 100644 --- a/clients/client-sesv2/commands/GetEmailIdentityPoliciesCommand.ts +++ b/clients/client-sesv2/commands/GetEmailIdentityPoliciesCommand.ts @@ -33,6 +33,20 @@ export interface GetEmailIdentityPoliciesCommandOutput extends GetEmailIdentityP * the Amazon SES Developer * Guide.

*

You can execute this operation no more than once per second.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { SESv2Client, GetEmailIdentityPoliciesCommand } from "@aws-sdk/client-sesv2"; // ES Modules import + * // const { SESv2Client, GetEmailIdentityPoliciesCommand } = require("@aws-sdk/client-sesv2"); // CommonJS import + * const client = new SESv2Client(config); + * const command = new GetEmailIdentityPoliciesCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetEmailIdentityPoliciesCommandInput} for command's `input` shape. + * @see {@link GetEmailIdentityPoliciesCommandOutput} for command's `response` shape. + * @see {@link SESv2ClientResolvedConfig | config} for command's `input` shape. + * */ export class GetEmailIdentityPoliciesCommand extends $Command< GetEmailIdentityPoliciesCommandInput, diff --git a/clients/client-sesv2/commands/GetEmailTemplateCommand.ts b/clients/client-sesv2/commands/GetEmailTemplateCommand.ts index 7474c18cb2ca..4c5cb98f595c 100644 --- a/clients/client-sesv2/commands/GetEmailTemplateCommand.ts +++ b/clients/client-sesv2/commands/GetEmailTemplateCommand.ts @@ -25,6 +25,20 @@ export interface GetEmailTemplateCommandOutput extends GetEmailTemplateResponse, * part) for the template you specify.

* *

You can execute this operation no more than once per second.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { SESv2Client, GetEmailTemplateCommand } from "@aws-sdk/client-sesv2"; // ES Modules import + * // const { SESv2Client, GetEmailTemplateCommand } = require("@aws-sdk/client-sesv2"); // CommonJS import + * const client = new SESv2Client(config); + * const command = new GetEmailTemplateCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetEmailTemplateCommandInput} for command's `input` shape. + * @see {@link GetEmailTemplateCommandOutput} for command's `response` shape. + * @see {@link SESv2ClientResolvedConfig | config} for command's `input` shape. + * */ export class GetEmailTemplateCommand extends $Command< GetEmailTemplateCommandInput, diff --git a/clients/client-sesv2/commands/GetImportJobCommand.ts b/clients/client-sesv2/commands/GetImportJobCommand.ts index 7501aa238800..cb3127771286 100644 --- a/clients/client-sesv2/commands/GetImportJobCommand.ts +++ b/clients/client-sesv2/commands/GetImportJobCommand.ts @@ -22,6 +22,20 @@ export interface GetImportJobCommandOutput extends GetImportJobResponse, __Metad /** *

Provides information about an import job.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { SESv2Client, GetImportJobCommand } from "@aws-sdk/client-sesv2"; // ES Modules import + * // const { SESv2Client, GetImportJobCommand } = require("@aws-sdk/client-sesv2"); // CommonJS import + * const client = new SESv2Client(config); + * const command = new GetImportJobCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetImportJobCommandInput} for command's `input` shape. + * @see {@link GetImportJobCommandOutput} for command's `response` shape. + * @see {@link SESv2ClientResolvedConfig | config} for command's `input` shape. + * */ export class GetImportJobCommand extends $Command< GetImportJobCommandInput, diff --git a/clients/client-sesv2/commands/GetSuppressedDestinationCommand.ts b/clients/client-sesv2/commands/GetSuppressedDestinationCommand.ts index 3264f78d518e..72ef31647871 100644 --- a/clients/client-sesv2/commands/GetSuppressedDestinationCommand.ts +++ b/clients/client-sesv2/commands/GetSuppressedDestinationCommand.ts @@ -23,6 +23,20 @@ export interface GetSuppressedDestinationCommandOutput extends GetSuppressedDest /** *

Retrieves information about a specific email address that's on the suppression list * for your account.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { SESv2Client, GetSuppressedDestinationCommand } from "@aws-sdk/client-sesv2"; // ES Modules import + * // const { SESv2Client, GetSuppressedDestinationCommand } = require("@aws-sdk/client-sesv2"); // CommonJS import + * const client = new SESv2Client(config); + * const command = new GetSuppressedDestinationCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetSuppressedDestinationCommandInput} for command's `input` shape. + * @see {@link GetSuppressedDestinationCommandOutput} for command's `response` shape. + * @see {@link SESv2ClientResolvedConfig | config} for command's `input` shape. + * */ export class GetSuppressedDestinationCommand extends $Command< GetSuppressedDestinationCommandInput, diff --git a/clients/client-sesv2/commands/ListConfigurationSetsCommand.ts b/clients/client-sesv2/commands/ListConfigurationSetsCommand.ts index 56bf3c1f8966..efea967b8921 100644 --- a/clients/client-sesv2/commands/ListConfigurationSetsCommand.ts +++ b/clients/client-sesv2/commands/ListConfigurationSetsCommand.ts @@ -28,6 +28,20 @@ export interface ListConfigurationSetsCommandOutput extends ListConfigurationSet * 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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { SESv2Client, ListConfigurationSetsCommand } from "@aws-sdk/client-sesv2"; // ES Modules import + * // const { SESv2Client, ListConfigurationSetsCommand } = require("@aws-sdk/client-sesv2"); // CommonJS import + * const client = new SESv2Client(config); + * const command = new ListConfigurationSetsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListConfigurationSetsCommandInput} for command's `input` shape. + * @see {@link ListConfigurationSetsCommandOutput} for command's `response` shape. + * @see {@link SESv2ClientResolvedConfig | config} for command's `input` shape. + * */ export class ListConfigurationSetsCommand extends $Command< ListConfigurationSetsCommandInput, diff --git a/clients/client-sesv2/commands/ListContactListsCommand.ts b/clients/client-sesv2/commands/ListContactListsCommand.ts index ca295f039930..b602a0165f35 100644 --- a/clients/client-sesv2/commands/ListContactListsCommand.ts +++ b/clients/client-sesv2/commands/ListContactListsCommand.ts @@ -22,6 +22,20 @@ export interface ListContactListsCommandOutput extends ListContactListsResponse, /** *

Lists all of the contact lists available.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { SESv2Client, ListContactListsCommand } from "@aws-sdk/client-sesv2"; // ES Modules import + * // const { SESv2Client, ListContactListsCommand } = require("@aws-sdk/client-sesv2"); // CommonJS import + * const client = new SESv2Client(config); + * const command = new ListContactListsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListContactListsCommandInput} for command's `input` shape. + * @see {@link ListContactListsCommandOutput} for command's `response` shape. + * @see {@link SESv2ClientResolvedConfig | config} for command's `input` shape. + * */ export class ListContactListsCommand extends $Command< ListContactListsCommandInput, diff --git a/clients/client-sesv2/commands/ListContactsCommand.ts b/clients/client-sesv2/commands/ListContactsCommand.ts index da3cb5684ac9..ff76fda1832e 100644 --- a/clients/client-sesv2/commands/ListContactsCommand.ts +++ b/clients/client-sesv2/commands/ListContactsCommand.ts @@ -22,6 +22,20 @@ export interface ListContactsCommandOutput extends ListContactsResponse, __Metad /** *

Lists the contacts present in a specific contact list.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { SESv2Client, ListContactsCommand } from "@aws-sdk/client-sesv2"; // ES Modules import + * // const { SESv2Client, ListContactsCommand } = require("@aws-sdk/client-sesv2"); // CommonJS import + * const client = new SESv2Client(config); + * const command = new ListContactsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListContactsCommandInput} for command's `input` shape. + * @see {@link ListContactsCommandOutput} for command's `response` shape. + * @see {@link SESv2ClientResolvedConfig | config} for command's `input` shape. + * */ export class ListContactsCommand extends $Command< ListContactsCommandInput, diff --git a/clients/client-sesv2/commands/ListCustomVerificationEmailTemplatesCommand.ts b/clients/client-sesv2/commands/ListCustomVerificationEmailTemplatesCommand.ts index dea2acb08342..35ee58c539a5 100644 --- a/clients/client-sesv2/commands/ListCustomVerificationEmailTemplatesCommand.ts +++ b/clients/client-sesv2/commands/ListCustomVerificationEmailTemplatesCommand.ts @@ -31,6 +31,20 @@ export interface ListCustomVerificationEmailTemplatesCommandOutput *

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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { SESv2Client, ListCustomVerificationEmailTemplatesCommand } from "@aws-sdk/client-sesv2"; // ES Modules import + * // const { SESv2Client, ListCustomVerificationEmailTemplatesCommand } = require("@aws-sdk/client-sesv2"); // CommonJS import + * const client = new SESv2Client(config); + * const command = new ListCustomVerificationEmailTemplatesCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListCustomVerificationEmailTemplatesCommandInput} for command's `input` shape. + * @see {@link ListCustomVerificationEmailTemplatesCommandOutput} for command's `response` shape. + * @see {@link SESv2ClientResolvedConfig | config} for command's `input` shape. + * */ export class ListCustomVerificationEmailTemplatesCommand extends $Command< ListCustomVerificationEmailTemplatesCommandInput, diff --git a/clients/client-sesv2/commands/ListDedicatedIpPoolsCommand.ts b/clients/client-sesv2/commands/ListDedicatedIpPoolsCommand.ts index 52f47028003c..b06c96ad38ef 100644 --- a/clients/client-sesv2/commands/ListDedicatedIpPoolsCommand.ts +++ b/clients/client-sesv2/commands/ListDedicatedIpPoolsCommand.ts @@ -23,6 +23,20 @@ export interface ListDedicatedIpPoolsCommandOutput extends ListDedicatedIpPoolsR /** *

List all of the dedicated IP pools that exist in your AWS account in the current * Region.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { SESv2Client, ListDedicatedIpPoolsCommand } from "@aws-sdk/client-sesv2"; // ES Modules import + * // const { SESv2Client, ListDedicatedIpPoolsCommand } = require("@aws-sdk/client-sesv2"); // CommonJS import + * const client = new SESv2Client(config); + * const command = new ListDedicatedIpPoolsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListDedicatedIpPoolsCommandInput} for command's `input` shape. + * @see {@link ListDedicatedIpPoolsCommandOutput} for command's `response` shape. + * @see {@link SESv2ClientResolvedConfig | config} for command's `input` shape. + * */ export class ListDedicatedIpPoolsCommand extends $Command< ListDedicatedIpPoolsCommandInput, diff --git a/clients/client-sesv2/commands/ListDeliverabilityTestReportsCommand.ts b/clients/client-sesv2/commands/ListDeliverabilityTestReportsCommand.ts index a4df8944d75b..f5fd3dd5673e 100644 --- a/clients/client-sesv2/commands/ListDeliverabilityTestReportsCommand.ts +++ b/clients/client-sesv2/commands/ListDeliverabilityTestReportsCommand.ts @@ -26,6 +26,20 @@ export interface ListDeliverabilityTestReportsCommandOutput *

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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { SESv2Client, ListDeliverabilityTestReportsCommand } from "@aws-sdk/client-sesv2"; // ES Modules import + * // const { SESv2Client, ListDeliverabilityTestReportsCommand } = require("@aws-sdk/client-sesv2"); // CommonJS import + * const client = new SESv2Client(config); + * const command = new ListDeliverabilityTestReportsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListDeliverabilityTestReportsCommandInput} for command's `input` shape. + * @see {@link ListDeliverabilityTestReportsCommandOutput} for command's `response` shape. + * @see {@link SESv2ClientResolvedConfig | config} for command's `input` shape. + * */ export class ListDeliverabilityTestReportsCommand extends $Command< ListDeliverabilityTestReportsCommandInput, diff --git a/clients/client-sesv2/commands/ListDomainDeliverabilityCampaignsCommand.ts b/clients/client-sesv2/commands/ListDomainDeliverabilityCampaignsCommand.ts index 49dda01acd7c..36ef2214833f 100644 --- a/clients/client-sesv2/commands/ListDomainDeliverabilityCampaignsCommand.ts +++ b/clients/client-sesv2/commands/ListDomainDeliverabilityCampaignsCommand.ts @@ -29,6 +29,20 @@ export interface ListDomainDeliverabilityCampaignsCommandOutput *

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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { SESv2Client, ListDomainDeliverabilityCampaignsCommand } from "@aws-sdk/client-sesv2"; // ES Modules import + * // const { SESv2Client, ListDomainDeliverabilityCampaignsCommand } = require("@aws-sdk/client-sesv2"); // CommonJS import + * const client = new SESv2Client(config); + * const command = new ListDomainDeliverabilityCampaignsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListDomainDeliverabilityCampaignsCommandInput} for command's `input` shape. + * @see {@link ListDomainDeliverabilityCampaignsCommandOutput} for command's `response` shape. + * @see {@link SESv2ClientResolvedConfig | config} for command's `input` shape. + * */ export class ListDomainDeliverabilityCampaignsCommand extends $Command< ListDomainDeliverabilityCampaignsCommandInput, diff --git a/clients/client-sesv2/commands/ListEmailIdentitiesCommand.ts b/clients/client-sesv2/commands/ListEmailIdentitiesCommand.ts index 4697c4c658ec..f396f7ad3193 100644 --- a/clients/client-sesv2/commands/ListEmailIdentitiesCommand.ts +++ b/clients/client-sesv2/commands/ListEmailIdentitiesCommand.ts @@ -25,6 +25,20 @@ export interface ListEmailIdentitiesCommandOutput extends ListEmailIdentitiesRes * 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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { SESv2Client, ListEmailIdentitiesCommand } from "@aws-sdk/client-sesv2"; // ES Modules import + * // const { SESv2Client, ListEmailIdentitiesCommand } = require("@aws-sdk/client-sesv2"); // CommonJS import + * const client = new SESv2Client(config); + * const command = new ListEmailIdentitiesCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListEmailIdentitiesCommandInput} for command's `input` shape. + * @see {@link ListEmailIdentitiesCommandOutput} for command's `response` shape. + * @see {@link SESv2ClientResolvedConfig | config} for command's `input` shape. + * */ export class ListEmailIdentitiesCommand extends $Command< ListEmailIdentitiesCommandInput, diff --git a/clients/client-sesv2/commands/ListEmailTemplatesCommand.ts b/clients/client-sesv2/commands/ListEmailTemplatesCommand.ts index e11031da6656..63cc1bd73844 100644 --- a/clients/client-sesv2/commands/ListEmailTemplatesCommand.ts +++ b/clients/client-sesv2/commands/ListEmailTemplatesCommand.ts @@ -25,6 +25,20 @@ export interface ListEmailTemplatesCommandOutput extends ListEmailTemplatesRespo * Region.

* *

You can execute this operation no more than once per second.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { SESv2Client, ListEmailTemplatesCommand } from "@aws-sdk/client-sesv2"; // ES Modules import + * // const { SESv2Client, ListEmailTemplatesCommand } = require("@aws-sdk/client-sesv2"); // CommonJS import + * const client = new SESv2Client(config); + * const command = new ListEmailTemplatesCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListEmailTemplatesCommandInput} for command's `input` shape. + * @see {@link ListEmailTemplatesCommandOutput} for command's `response` shape. + * @see {@link SESv2ClientResolvedConfig | config} for command's `input` shape. + * */ export class ListEmailTemplatesCommand extends $Command< ListEmailTemplatesCommandInput, diff --git a/clients/client-sesv2/commands/ListImportJobsCommand.ts b/clients/client-sesv2/commands/ListImportJobsCommand.ts index fccb1b339e8b..7ba9a0411846 100644 --- a/clients/client-sesv2/commands/ListImportJobsCommand.ts +++ b/clients/client-sesv2/commands/ListImportJobsCommand.ts @@ -22,6 +22,20 @@ export interface ListImportJobsCommandOutput extends ListImportJobsResponse, __M /** *

Lists all of the import jobs.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { SESv2Client, ListImportJobsCommand } from "@aws-sdk/client-sesv2"; // ES Modules import + * // const { SESv2Client, ListImportJobsCommand } = require("@aws-sdk/client-sesv2"); // CommonJS import + * const client = new SESv2Client(config); + * const command = new ListImportJobsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListImportJobsCommandInput} for command's `input` shape. + * @see {@link ListImportJobsCommandOutput} for command's `response` shape. + * @see {@link SESv2ClientResolvedConfig | config} for command's `input` shape. + * */ export class ListImportJobsCommand extends $Command< ListImportJobsCommandInput, diff --git a/clients/client-sesv2/commands/ListSuppressedDestinationsCommand.ts b/clients/client-sesv2/commands/ListSuppressedDestinationsCommand.ts index e114ae768e7f..0c409ecb9b01 100644 --- a/clients/client-sesv2/commands/ListSuppressedDestinationsCommand.ts +++ b/clients/client-sesv2/commands/ListSuppressedDestinationsCommand.ts @@ -23,6 +23,20 @@ export interface ListSuppressedDestinationsCommandOutput extends ListSuppressedD /** *

Retrieves a list of email addresses that are on the suppression list for your * account.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { SESv2Client, ListSuppressedDestinationsCommand } from "@aws-sdk/client-sesv2"; // ES Modules import + * // const { SESv2Client, ListSuppressedDestinationsCommand } = require("@aws-sdk/client-sesv2"); // CommonJS import + * const client = new SESv2Client(config); + * const command = new ListSuppressedDestinationsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListSuppressedDestinationsCommandInput} for command's `input` shape. + * @see {@link ListSuppressedDestinationsCommandOutput} for command's `response` shape. + * @see {@link SESv2ClientResolvedConfig | config} for command's `input` shape. + * */ export class ListSuppressedDestinationsCommand extends $Command< ListSuppressedDestinationsCommandInput, diff --git a/clients/client-sesv2/commands/ListTagsForResourceCommand.ts b/clients/client-sesv2/commands/ListTagsForResourceCommand.ts index cb781c381443..69358081bb03 100644 --- a/clients/client-sesv2/commands/ListTagsForResourceCommand.ts +++ b/clients/client-sesv2/commands/ListTagsForResourceCommand.ts @@ -27,6 +27,20 @@ export interface ListTagsForResourceCommandOutput extends ListTagsForResourceRes * 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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { SESv2Client, ListTagsForResourceCommand } from "@aws-sdk/client-sesv2"; // ES Modules import + * // const { SESv2Client, ListTagsForResourceCommand } = require("@aws-sdk/client-sesv2"); // CommonJS import + * const client = new SESv2Client(config); + * const command = new ListTagsForResourceCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListTagsForResourceCommandInput} for command's `input` shape. + * @see {@link ListTagsForResourceCommandOutput} for command's `response` shape. + * @see {@link SESv2ClientResolvedConfig | config} for command's `input` shape. + * */ export class ListTagsForResourceCommand extends $Command< ListTagsForResourceCommandInput, diff --git a/clients/client-sesv2/commands/PutAccountDedicatedIpWarmupAttributesCommand.ts b/clients/client-sesv2/commands/PutAccountDedicatedIpWarmupAttributesCommand.ts index c81699049d9d..34105dba98de 100644 --- a/clients/client-sesv2/commands/PutAccountDedicatedIpWarmupAttributesCommand.ts +++ b/clients/client-sesv2/commands/PutAccountDedicatedIpWarmupAttributesCommand.ts @@ -28,6 +28,20 @@ export interface PutAccountDedicatedIpWarmupAttributesCommandOutput /** *

Enable or disable the automatic warm-up feature for dedicated IP addresses.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { SESv2Client, PutAccountDedicatedIpWarmupAttributesCommand } from "@aws-sdk/client-sesv2"; // ES Modules import + * // const { SESv2Client, PutAccountDedicatedIpWarmupAttributesCommand } = require("@aws-sdk/client-sesv2"); // CommonJS import + * const client = new SESv2Client(config); + * const command = new PutAccountDedicatedIpWarmupAttributesCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link PutAccountDedicatedIpWarmupAttributesCommandInput} for command's `input` shape. + * @see {@link PutAccountDedicatedIpWarmupAttributesCommandOutput} for command's `response` shape. + * @see {@link SESv2ClientResolvedConfig | config} for command's `input` shape. + * */ export class PutAccountDedicatedIpWarmupAttributesCommand extends $Command< PutAccountDedicatedIpWarmupAttributesCommandInput, diff --git a/clients/client-sesv2/commands/PutAccountDetailsCommand.ts b/clients/client-sesv2/commands/PutAccountDetailsCommand.ts index 7bc12a4b962b..acfbbfb64818 100644 --- a/clients/client-sesv2/commands/PutAccountDetailsCommand.ts +++ b/clients/client-sesv2/commands/PutAccountDetailsCommand.ts @@ -22,6 +22,20 @@ export interface PutAccountDetailsCommandOutput extends PutAccountDetailsRespons /** *

Update your Amazon SES account details.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { SESv2Client, PutAccountDetailsCommand } from "@aws-sdk/client-sesv2"; // ES Modules import + * // const { SESv2Client, PutAccountDetailsCommand } = require("@aws-sdk/client-sesv2"); // CommonJS import + * const client = new SESv2Client(config); + * const command = new PutAccountDetailsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link PutAccountDetailsCommandInput} for command's `input` shape. + * @see {@link PutAccountDetailsCommandOutput} for command's `response` shape. + * @see {@link SESv2ClientResolvedConfig | config} for command's `input` shape. + * */ export class PutAccountDetailsCommand extends $Command< PutAccountDetailsCommandInput, diff --git a/clients/client-sesv2/commands/PutAccountSendingAttributesCommand.ts b/clients/client-sesv2/commands/PutAccountSendingAttributesCommand.ts index 96fd3d7f96bb..61b7fb8feeb3 100644 --- a/clients/client-sesv2/commands/PutAccountSendingAttributesCommand.ts +++ b/clients/client-sesv2/commands/PutAccountSendingAttributesCommand.ts @@ -24,6 +24,20 @@ export interface PutAccountSendingAttributesCommandOutput /** *

Enable or disable the ability of your account to send email.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { SESv2Client, PutAccountSendingAttributesCommand } from "@aws-sdk/client-sesv2"; // ES Modules import + * // const { SESv2Client, PutAccountSendingAttributesCommand } = require("@aws-sdk/client-sesv2"); // CommonJS import + * const client = new SESv2Client(config); + * const command = new PutAccountSendingAttributesCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link PutAccountSendingAttributesCommandInput} for command's `input` shape. + * @see {@link PutAccountSendingAttributesCommandOutput} for command's `response` shape. + * @see {@link SESv2ClientResolvedConfig | config} for command's `input` shape. + * */ export class PutAccountSendingAttributesCommand extends $Command< PutAccountSendingAttributesCommandInput, diff --git a/clients/client-sesv2/commands/PutAccountSuppressionAttributesCommand.ts b/clients/client-sesv2/commands/PutAccountSuppressionAttributesCommand.ts index fd3e1a6b894c..8e9d3252e51e 100644 --- a/clients/client-sesv2/commands/PutAccountSuppressionAttributesCommand.ts +++ b/clients/client-sesv2/commands/PutAccountSuppressionAttributesCommand.ts @@ -24,6 +24,20 @@ export interface PutAccountSuppressionAttributesCommandOutput /** *

Change the settings for the account-level suppression list.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { SESv2Client, PutAccountSuppressionAttributesCommand } from "@aws-sdk/client-sesv2"; // ES Modules import + * // const { SESv2Client, PutAccountSuppressionAttributesCommand } = require("@aws-sdk/client-sesv2"); // CommonJS import + * const client = new SESv2Client(config); + * const command = new PutAccountSuppressionAttributesCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link PutAccountSuppressionAttributesCommandInput} for command's `input` shape. + * @see {@link PutAccountSuppressionAttributesCommandOutput} for command's `response` shape. + * @see {@link SESv2ClientResolvedConfig | config} for command's `input` shape. + * */ export class PutAccountSuppressionAttributesCommand extends $Command< PutAccountSuppressionAttributesCommandInput, diff --git a/clients/client-sesv2/commands/PutConfigurationSetDeliveryOptionsCommand.ts b/clients/client-sesv2/commands/PutConfigurationSetDeliveryOptionsCommand.ts index a4f17287f06f..d4eea11574db 100644 --- a/clients/client-sesv2/commands/PutConfigurationSetDeliveryOptionsCommand.ts +++ b/clients/client-sesv2/commands/PutConfigurationSetDeliveryOptionsCommand.ts @@ -28,6 +28,20 @@ export interface PutConfigurationSetDeliveryOptionsCommandOutput /** *

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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { SESv2Client, PutConfigurationSetDeliveryOptionsCommand } from "@aws-sdk/client-sesv2"; // ES Modules import + * // const { SESv2Client, PutConfigurationSetDeliveryOptionsCommand } = require("@aws-sdk/client-sesv2"); // CommonJS import + * const client = new SESv2Client(config); + * const command = new PutConfigurationSetDeliveryOptionsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link PutConfigurationSetDeliveryOptionsCommandInput} for command's `input` shape. + * @see {@link PutConfigurationSetDeliveryOptionsCommandOutput} for command's `response` shape. + * @see {@link SESv2ClientResolvedConfig | config} for command's `input` shape. + * */ export class PutConfigurationSetDeliveryOptionsCommand extends $Command< PutConfigurationSetDeliveryOptionsCommandInput, diff --git a/clients/client-sesv2/commands/PutConfigurationSetReputationOptionsCommand.ts b/clients/client-sesv2/commands/PutConfigurationSetReputationOptionsCommand.ts index 3c7cf2dda2aa..f9de4384122e 100644 --- a/clients/client-sesv2/commands/PutConfigurationSetReputationOptionsCommand.ts +++ b/clients/client-sesv2/commands/PutConfigurationSetReputationOptionsCommand.ts @@ -28,6 +28,20 @@ export interface PutConfigurationSetReputationOptionsCommandOutput /** *

Enable or disable collection of reputation metrics for emails that you send using a * particular configuration set in a specific AWS Region.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { SESv2Client, PutConfigurationSetReputationOptionsCommand } from "@aws-sdk/client-sesv2"; // ES Modules import + * // const { SESv2Client, PutConfigurationSetReputationOptionsCommand } = require("@aws-sdk/client-sesv2"); // CommonJS import + * const client = new SESv2Client(config); + * const command = new PutConfigurationSetReputationOptionsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link PutConfigurationSetReputationOptionsCommandInput} for command's `input` shape. + * @see {@link PutConfigurationSetReputationOptionsCommandOutput} for command's `response` shape. + * @see {@link SESv2ClientResolvedConfig | config} for command's `input` shape. + * */ export class PutConfigurationSetReputationOptionsCommand extends $Command< PutConfigurationSetReputationOptionsCommandInput, diff --git a/clients/client-sesv2/commands/PutConfigurationSetSendingOptionsCommand.ts b/clients/client-sesv2/commands/PutConfigurationSetSendingOptionsCommand.ts index 6d554d96ede3..4aab0e62b2ff 100644 --- a/clients/client-sesv2/commands/PutConfigurationSetSendingOptionsCommand.ts +++ b/clients/client-sesv2/commands/PutConfigurationSetSendingOptionsCommand.ts @@ -28,6 +28,20 @@ export interface PutConfigurationSetSendingOptionsCommandOutput /** *

Enable or disable email sending for messages that use a particular configuration set * in a specific AWS Region.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { SESv2Client, PutConfigurationSetSendingOptionsCommand } from "@aws-sdk/client-sesv2"; // ES Modules import + * // const { SESv2Client, PutConfigurationSetSendingOptionsCommand } = require("@aws-sdk/client-sesv2"); // CommonJS import + * const client = new SESv2Client(config); + * const command = new PutConfigurationSetSendingOptionsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link PutConfigurationSetSendingOptionsCommandInput} for command's `input` shape. + * @see {@link PutConfigurationSetSendingOptionsCommandOutput} for command's `response` shape. + * @see {@link SESv2ClientResolvedConfig | config} for command's `input` shape. + * */ export class PutConfigurationSetSendingOptionsCommand extends $Command< PutConfigurationSetSendingOptionsCommandInput, diff --git a/clients/client-sesv2/commands/PutConfigurationSetSuppressionOptionsCommand.ts b/clients/client-sesv2/commands/PutConfigurationSetSuppressionOptionsCommand.ts index 366393230947..b2d9a05f984a 100644 --- a/clients/client-sesv2/commands/PutConfigurationSetSuppressionOptionsCommand.ts +++ b/clients/client-sesv2/commands/PutConfigurationSetSuppressionOptionsCommand.ts @@ -28,6 +28,20 @@ export interface PutConfigurationSetSuppressionOptionsCommandOutput /** *

Specify the account suppression list preferences for a configuration set.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { SESv2Client, PutConfigurationSetSuppressionOptionsCommand } from "@aws-sdk/client-sesv2"; // ES Modules import + * // const { SESv2Client, PutConfigurationSetSuppressionOptionsCommand } = require("@aws-sdk/client-sesv2"); // CommonJS import + * const client = new SESv2Client(config); + * const command = new PutConfigurationSetSuppressionOptionsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link PutConfigurationSetSuppressionOptionsCommandInput} for command's `input` shape. + * @see {@link PutConfigurationSetSuppressionOptionsCommandOutput} for command's `response` shape. + * @see {@link SESv2ClientResolvedConfig | config} for command's `input` shape. + * */ export class PutConfigurationSetSuppressionOptionsCommand extends $Command< PutConfigurationSetSuppressionOptionsCommandInput, diff --git a/clients/client-sesv2/commands/PutConfigurationSetTrackingOptionsCommand.ts b/clients/client-sesv2/commands/PutConfigurationSetTrackingOptionsCommand.ts index e8fd9e3d7a9c..feb655e7bc31 100644 --- a/clients/client-sesv2/commands/PutConfigurationSetTrackingOptionsCommand.ts +++ b/clients/client-sesv2/commands/PutConfigurationSetTrackingOptionsCommand.ts @@ -28,6 +28,20 @@ export interface PutConfigurationSetTrackingOptionsCommandOutput /** *

Specify a custom domain to use for open and click tracking elements in email that you * send.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { SESv2Client, PutConfigurationSetTrackingOptionsCommand } from "@aws-sdk/client-sesv2"; // ES Modules import + * // const { SESv2Client, PutConfigurationSetTrackingOptionsCommand } = require("@aws-sdk/client-sesv2"); // CommonJS import + * const client = new SESv2Client(config); + * const command = new PutConfigurationSetTrackingOptionsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link PutConfigurationSetTrackingOptionsCommandInput} for command's `input` shape. + * @see {@link PutConfigurationSetTrackingOptionsCommandOutput} for command's `response` shape. + * @see {@link SESv2ClientResolvedConfig | config} for command's `input` shape. + * */ export class PutConfigurationSetTrackingOptionsCommand extends $Command< PutConfigurationSetTrackingOptionsCommandInput, diff --git a/clients/client-sesv2/commands/PutDedicatedIpInPoolCommand.ts b/clients/client-sesv2/commands/PutDedicatedIpInPoolCommand.ts index 43f576d8f2d3..66c6283174d7 100644 --- a/clients/client-sesv2/commands/PutDedicatedIpInPoolCommand.ts +++ b/clients/client-sesv2/commands/PutDedicatedIpInPoolCommand.ts @@ -31,6 +31,20 @@ export interface PutDedicatedIpInPoolCommandOutput extends PutDedicatedIpInPoolR * using the CreateDedicatedIpPool operation.

* * + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { SESv2Client, PutDedicatedIpInPoolCommand } from "@aws-sdk/client-sesv2"; // ES Modules import + * // const { SESv2Client, PutDedicatedIpInPoolCommand } = require("@aws-sdk/client-sesv2"); // CommonJS import + * const client = new SESv2Client(config); + * const command = new PutDedicatedIpInPoolCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link PutDedicatedIpInPoolCommandInput} for command's `input` shape. + * @see {@link PutDedicatedIpInPoolCommandOutput} for command's `response` shape. + * @see {@link SESv2ClientResolvedConfig | config} for command's `input` shape. + * */ export class PutDedicatedIpInPoolCommand extends $Command< PutDedicatedIpInPoolCommandInput, diff --git a/clients/client-sesv2/commands/PutDedicatedIpWarmupAttributesCommand.ts b/clients/client-sesv2/commands/PutDedicatedIpWarmupAttributesCommand.ts index c0fa9b0dce28..733c5caae4ab 100644 --- a/clients/client-sesv2/commands/PutDedicatedIpWarmupAttributesCommand.ts +++ b/clients/client-sesv2/commands/PutDedicatedIpWarmupAttributesCommand.ts @@ -24,6 +24,20 @@ export interface PutDedicatedIpWarmupAttributesCommandOutput /** *

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { SESv2Client, PutDedicatedIpWarmupAttributesCommand } from "@aws-sdk/client-sesv2"; // ES Modules import + * // const { SESv2Client, PutDedicatedIpWarmupAttributesCommand } = require("@aws-sdk/client-sesv2"); // CommonJS import + * const client = new SESv2Client(config); + * const command = new PutDedicatedIpWarmupAttributesCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link PutDedicatedIpWarmupAttributesCommandInput} for command's `input` shape. + * @see {@link PutDedicatedIpWarmupAttributesCommandOutput} for command's `response` shape. + * @see {@link SESv2ClientResolvedConfig | config} for command's `input` shape. + * */ export class PutDedicatedIpWarmupAttributesCommand extends $Command< PutDedicatedIpWarmupAttributesCommandInput, diff --git a/clients/client-sesv2/commands/PutDeliverabilityDashboardOptionCommand.ts b/clients/client-sesv2/commands/PutDeliverabilityDashboardOptionCommand.ts index e2bf5578019e..16bd3e1c1a81 100644 --- a/clients/client-sesv2/commands/PutDeliverabilityDashboardOptionCommand.ts +++ b/clients/client-sesv2/commands/PutDeliverabilityDashboardOptionCommand.ts @@ -30,6 +30,20 @@ export interface PutDeliverabilityDashboardOptionCommandOutput *

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 AWS services. For more * information about the features and cost of a Deliverability dashboard subscription, see Amazon SES Pricing.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { SESv2Client, PutDeliverabilityDashboardOptionCommand } from "@aws-sdk/client-sesv2"; // ES Modules import + * // const { SESv2Client, PutDeliverabilityDashboardOptionCommand } = require("@aws-sdk/client-sesv2"); // CommonJS import + * const client = new SESv2Client(config); + * const command = new PutDeliverabilityDashboardOptionCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link PutDeliverabilityDashboardOptionCommandInput} for command's `input` shape. + * @see {@link PutDeliverabilityDashboardOptionCommandOutput} for command's `response` shape. + * @see {@link SESv2ClientResolvedConfig | config} for command's `input` shape. + * */ export class PutDeliverabilityDashboardOptionCommand extends $Command< PutDeliverabilityDashboardOptionCommandInput, diff --git a/clients/client-sesv2/commands/PutEmailIdentityConfigurationSetAttributesCommand.ts b/clients/client-sesv2/commands/PutEmailIdentityConfigurationSetAttributesCommand.ts index e693a7f6cb6f..95bb4d52a063 100644 --- a/clients/client-sesv2/commands/PutEmailIdentityConfigurationSetAttributesCommand.ts +++ b/clients/client-sesv2/commands/PutEmailIdentityConfigurationSetAttributesCommand.ts @@ -28,6 +28,20 @@ export interface PutEmailIdentityConfigurationSetAttributesCommandOutput /** *

Used to associate a configuration set with an email identity.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { SESv2Client, PutEmailIdentityConfigurationSetAttributesCommand } from "@aws-sdk/client-sesv2"; // ES Modules import + * // const { SESv2Client, PutEmailIdentityConfigurationSetAttributesCommand } = require("@aws-sdk/client-sesv2"); // CommonJS import + * const client = new SESv2Client(config); + * const command = new PutEmailIdentityConfigurationSetAttributesCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link PutEmailIdentityConfigurationSetAttributesCommandInput} for command's `input` shape. + * @see {@link PutEmailIdentityConfigurationSetAttributesCommandOutput} for command's `response` shape. + * @see {@link SESv2ClientResolvedConfig | config} for command's `input` shape. + * */ export class PutEmailIdentityConfigurationSetAttributesCommand extends $Command< PutEmailIdentityConfigurationSetAttributesCommandInput, diff --git a/clients/client-sesv2/commands/PutEmailIdentityDkimAttributesCommand.ts b/clients/client-sesv2/commands/PutEmailIdentityDkimAttributesCommand.ts index 7dfaf6878d93..d486df09c366 100644 --- a/clients/client-sesv2/commands/PutEmailIdentityDkimAttributesCommand.ts +++ b/clients/client-sesv2/commands/PutEmailIdentityDkimAttributesCommand.ts @@ -24,6 +24,20 @@ export interface PutEmailIdentityDkimAttributesCommandOutput /** *

Used to enable or disable DKIM authentication for an email identity.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { SESv2Client, PutEmailIdentityDkimAttributesCommand } from "@aws-sdk/client-sesv2"; // ES Modules import + * // const { SESv2Client, PutEmailIdentityDkimAttributesCommand } = require("@aws-sdk/client-sesv2"); // CommonJS import + * const client = new SESv2Client(config); + * const command = new PutEmailIdentityDkimAttributesCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link PutEmailIdentityDkimAttributesCommandInput} for command's `input` shape. + * @see {@link PutEmailIdentityDkimAttributesCommandOutput} for command's `response` shape. + * @see {@link SESv2ClientResolvedConfig | config} for command's `input` shape. + * */ export class PutEmailIdentityDkimAttributesCommand extends $Command< PutEmailIdentityDkimAttributesCommandInput, diff --git a/clients/client-sesv2/commands/PutEmailIdentityDkimSigningAttributesCommand.ts b/clients/client-sesv2/commands/PutEmailIdentityDkimSigningAttributesCommand.ts index df820e08d7ec..cc197e733349 100644 --- a/clients/client-sesv2/commands/PutEmailIdentityDkimSigningAttributesCommand.ts +++ b/clients/client-sesv2/commands/PutEmailIdentityDkimSigningAttributesCommand.ts @@ -47,6 +47,20 @@ export interface PutEmailIdentityDkimSigningAttributesCommandOutput *

Change from using BYODKIM to using Easy DKIM.

* * + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { SESv2Client, PutEmailIdentityDkimSigningAttributesCommand } from "@aws-sdk/client-sesv2"; // ES Modules import + * // const { SESv2Client, PutEmailIdentityDkimSigningAttributesCommand } = require("@aws-sdk/client-sesv2"); // CommonJS import + * const client = new SESv2Client(config); + * const command = new PutEmailIdentityDkimSigningAttributesCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link PutEmailIdentityDkimSigningAttributesCommandInput} for command's `input` shape. + * @see {@link PutEmailIdentityDkimSigningAttributesCommandOutput} for command's `response` shape. + * @see {@link SESv2ClientResolvedConfig | config} for command's `input` shape. + * */ export class PutEmailIdentityDkimSigningAttributesCommand extends $Command< PutEmailIdentityDkimSigningAttributesCommandInput, diff --git a/clients/client-sesv2/commands/PutEmailIdentityFeedbackAttributesCommand.ts b/clients/client-sesv2/commands/PutEmailIdentityFeedbackAttributesCommand.ts index dbc2f2faa9aa..52be64672757 100644 --- a/clients/client-sesv2/commands/PutEmailIdentityFeedbackAttributesCommand.ts +++ b/clients/client-sesv2/commands/PutEmailIdentityFeedbackAttributesCommand.ts @@ -36,6 +36,20 @@ export interface PutEmailIdentityFeedbackAttributesCommandOutput * 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).

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { SESv2Client, PutEmailIdentityFeedbackAttributesCommand } from "@aws-sdk/client-sesv2"; // ES Modules import + * // const { SESv2Client, PutEmailIdentityFeedbackAttributesCommand } = require("@aws-sdk/client-sesv2"); // CommonJS import + * const client = new SESv2Client(config); + * const command = new PutEmailIdentityFeedbackAttributesCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link PutEmailIdentityFeedbackAttributesCommandInput} for command's `input` shape. + * @see {@link PutEmailIdentityFeedbackAttributesCommandOutput} for command's `response` shape. + * @see {@link SESv2ClientResolvedConfig | config} for command's `input` shape. + * */ export class PutEmailIdentityFeedbackAttributesCommand extends $Command< PutEmailIdentityFeedbackAttributesCommandInput, diff --git a/clients/client-sesv2/commands/PutEmailIdentityMailFromAttributesCommand.ts b/clients/client-sesv2/commands/PutEmailIdentityMailFromAttributesCommand.ts index 4868695f9170..c0fba17bde0a 100644 --- a/clients/client-sesv2/commands/PutEmailIdentityMailFromAttributesCommand.ts +++ b/clients/client-sesv2/commands/PutEmailIdentityMailFromAttributesCommand.ts @@ -28,6 +28,20 @@ export interface PutEmailIdentityMailFromAttributesCommandOutput /** *

Used to enable or disable the custom Mail-From domain configuration for an email * identity.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { SESv2Client, PutEmailIdentityMailFromAttributesCommand } from "@aws-sdk/client-sesv2"; // ES Modules import + * // const { SESv2Client, PutEmailIdentityMailFromAttributesCommand } = require("@aws-sdk/client-sesv2"); // CommonJS import + * const client = new SESv2Client(config); + * const command = new PutEmailIdentityMailFromAttributesCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link PutEmailIdentityMailFromAttributesCommandInput} for command's `input` shape. + * @see {@link PutEmailIdentityMailFromAttributesCommandOutput} for command's `response` shape. + * @see {@link SESv2ClientResolvedConfig | config} for command's `input` shape. + * */ export class PutEmailIdentityMailFromAttributesCommand extends $Command< PutEmailIdentityMailFromAttributesCommandInput, diff --git a/clients/client-sesv2/commands/PutSuppressedDestinationCommand.ts b/clients/client-sesv2/commands/PutSuppressedDestinationCommand.ts index 8f7408702baf..d80e67dd30f3 100644 --- a/clients/client-sesv2/commands/PutSuppressedDestinationCommand.ts +++ b/clients/client-sesv2/commands/PutSuppressedDestinationCommand.ts @@ -22,6 +22,20 @@ export interface PutSuppressedDestinationCommandOutput extends PutSuppressedDest /** *

Adds an email address to the suppression list for your account.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { SESv2Client, PutSuppressedDestinationCommand } from "@aws-sdk/client-sesv2"; // ES Modules import + * // const { SESv2Client, PutSuppressedDestinationCommand } = require("@aws-sdk/client-sesv2"); // CommonJS import + * const client = new SESv2Client(config); + * const command = new PutSuppressedDestinationCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link PutSuppressedDestinationCommandInput} for command's `input` shape. + * @see {@link PutSuppressedDestinationCommandOutput} for command's `response` shape. + * @see {@link SESv2ClientResolvedConfig | config} for command's `input` shape. + * */ export class PutSuppressedDestinationCommand extends $Command< PutSuppressedDestinationCommandInput, diff --git a/clients/client-sesv2/commands/SendBulkEmailCommand.ts b/clients/client-sesv2/commands/SendBulkEmailCommand.ts index a47f790e6d34..cb2cb5cd25eb 100644 --- a/clients/client-sesv2/commands/SendBulkEmailCommand.ts +++ b/clients/client-sesv2/commands/SendBulkEmailCommand.ts @@ -22,6 +22,20 @@ export interface SendBulkEmailCommandOutput extends SendBulkEmailResponse, __Met /** *

Composes an email message to multiple destinations.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { SESv2Client, SendBulkEmailCommand } from "@aws-sdk/client-sesv2"; // ES Modules import + * // const { SESv2Client, SendBulkEmailCommand } = require("@aws-sdk/client-sesv2"); // CommonJS import + * const client = new SESv2Client(config); + * const command = new SendBulkEmailCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link SendBulkEmailCommandInput} for command's `input` shape. + * @see {@link SendBulkEmailCommandOutput} for command's `response` shape. + * @see {@link SESv2ClientResolvedConfig | config} for command's `input` shape. + * */ export class SendBulkEmailCommand extends $Command< SendBulkEmailCommandInput, diff --git a/clients/client-sesv2/commands/SendCustomVerificationEmailCommand.ts b/clients/client-sesv2/commands/SendCustomVerificationEmailCommand.ts index 8688887c0d5f..ea7c3b3c6d4f 100644 --- a/clients/client-sesv2/commands/SendCustomVerificationEmailCommand.ts +++ b/clients/client-sesv2/commands/SendCustomVerificationEmailCommand.ts @@ -31,6 +31,20 @@ export interface SendCustomVerificationEmailCommandOutput * Using Custom Verification Email Templates in the Amazon SES Developer * Guide.

*

You can execute this operation no more than once per second.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { SESv2Client, SendCustomVerificationEmailCommand } from "@aws-sdk/client-sesv2"; // ES Modules import + * // const { SESv2Client, SendCustomVerificationEmailCommand } = require("@aws-sdk/client-sesv2"); // CommonJS import + * const client = new SESv2Client(config); + * const command = new SendCustomVerificationEmailCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link SendCustomVerificationEmailCommandInput} for command's `input` shape. + * @see {@link SendCustomVerificationEmailCommandOutput} for command's `response` shape. + * @see {@link SESv2ClientResolvedConfig | config} for command's `input` shape. + * */ export class SendCustomVerificationEmailCommand extends $Command< SendCustomVerificationEmailCommandInput, diff --git a/clients/client-sesv2/commands/SendEmailCommand.ts b/clients/client-sesv2/commands/SendEmailCommand.ts index fd677bbb07c5..891e824454c1 100644 --- a/clients/client-sesv2/commands/SendEmailCommand.ts +++ b/clients/client-sesv2/commands/SendEmailCommand.ts @@ -45,6 +45,20 @@ export interface SendEmailCommandOutput extends SendEmailResponse, __MetadataBea * replaces the tags with values that you specify.

* * + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { SESv2Client, SendEmailCommand } from "@aws-sdk/client-sesv2"; // ES Modules import + * // const { SESv2Client, SendEmailCommand } = require("@aws-sdk/client-sesv2"); // CommonJS import + * const client = new SESv2Client(config); + * const command = new SendEmailCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link SendEmailCommandInput} for command's `input` shape. + * @see {@link SendEmailCommandOutput} for command's `response` shape. + * @see {@link SESv2ClientResolvedConfig | config} for command's `input` shape. + * */ export class SendEmailCommand extends $Command< SendEmailCommandInput, diff --git a/clients/client-sesv2/commands/TagResourceCommand.ts b/clients/client-sesv2/commands/TagResourceCommand.ts index 3d6f0a875066..0e5ec762cc8f 100644 --- a/clients/client-sesv2/commands/TagResourceCommand.ts +++ b/clients/client-sesv2/commands/TagResourceCommand.ts @@ -30,6 +30,20 @@ export interface TagResourceCommandOutput extends TagResourceResponse, __Metadat * 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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { SESv2Client, TagResourceCommand } from "@aws-sdk/client-sesv2"; // ES Modules import + * // const { SESv2Client, TagResourceCommand } = require("@aws-sdk/client-sesv2"); // CommonJS import + * const client = new SESv2Client(config); + * const command = new TagResourceCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link TagResourceCommandInput} for command's `input` shape. + * @see {@link TagResourceCommandOutput} for command's `response` shape. + * @see {@link SESv2ClientResolvedConfig | config} for command's `input` shape. + * */ export class TagResourceCommand extends $Command< TagResourceCommandInput, diff --git a/clients/client-sesv2/commands/TestRenderEmailTemplateCommand.ts b/clients/client-sesv2/commands/TestRenderEmailTemplateCommand.ts index 6889f0a5dd01..6bfe20a44cb4 100644 --- a/clients/client-sesv2/commands/TestRenderEmailTemplateCommand.ts +++ b/clients/client-sesv2/commands/TestRenderEmailTemplateCommand.ts @@ -25,6 +25,20 @@ export interface TestRenderEmailTemplateCommandOutput extends TestRenderEmailTem * set of replacement data.

* *

You can execute this operation no more than once per second.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { SESv2Client, TestRenderEmailTemplateCommand } from "@aws-sdk/client-sesv2"; // ES Modules import + * // const { SESv2Client, TestRenderEmailTemplateCommand } = require("@aws-sdk/client-sesv2"); // CommonJS import + * const client = new SESv2Client(config); + * const command = new TestRenderEmailTemplateCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link TestRenderEmailTemplateCommandInput} for command's `input` shape. + * @see {@link TestRenderEmailTemplateCommandOutput} for command's `response` shape. + * @see {@link SESv2ClientResolvedConfig | config} for command's `input` shape. + * */ export class TestRenderEmailTemplateCommand extends $Command< TestRenderEmailTemplateCommandInput, diff --git a/clients/client-sesv2/commands/UntagResourceCommand.ts b/clients/client-sesv2/commands/UntagResourceCommand.ts index 5f24b1aec22d..aba35c0c6c63 100644 --- a/clients/client-sesv2/commands/UntagResourceCommand.ts +++ b/clients/client-sesv2/commands/UntagResourceCommand.ts @@ -22,6 +22,20 @@ export interface UntagResourceCommandOutput extends UntagResourceResponse, __Met /** *

Remove one or more tags (keys and values) from a specified resource.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { SESv2Client, UntagResourceCommand } from "@aws-sdk/client-sesv2"; // ES Modules import + * // const { SESv2Client, UntagResourceCommand } = require("@aws-sdk/client-sesv2"); // CommonJS import + * const client = new SESv2Client(config); + * const command = new UntagResourceCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link UntagResourceCommandInput} for command's `input` shape. + * @see {@link UntagResourceCommandOutput} for command's `response` shape. + * @see {@link SESv2ClientResolvedConfig | config} for command's `input` shape. + * */ export class UntagResourceCommand extends $Command< UntagResourceCommandInput, diff --git a/clients/client-sesv2/commands/UpdateConfigurationSetEventDestinationCommand.ts b/clients/client-sesv2/commands/UpdateConfigurationSetEventDestinationCommand.ts index 1024d8c9549a..b83f84aac874 100644 --- a/clients/client-sesv2/commands/UpdateConfigurationSetEventDestinationCommand.ts +++ b/clients/client-sesv2/commands/UpdateConfigurationSetEventDestinationCommand.ts @@ -34,6 +34,20 @@ export interface UpdateConfigurationSetEventDestinationCommandOutput * 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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { SESv2Client, UpdateConfigurationSetEventDestinationCommand } from "@aws-sdk/client-sesv2"; // ES Modules import + * // const { SESv2Client, UpdateConfigurationSetEventDestinationCommand } = require("@aws-sdk/client-sesv2"); // CommonJS import + * const client = new SESv2Client(config); + * const command = new UpdateConfigurationSetEventDestinationCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link UpdateConfigurationSetEventDestinationCommandInput} for command's `input` shape. + * @see {@link UpdateConfigurationSetEventDestinationCommandOutput} for command's `response` shape. + * @see {@link SESv2ClientResolvedConfig | config} for command's `input` shape. + * */ export class UpdateConfigurationSetEventDestinationCommand extends $Command< UpdateConfigurationSetEventDestinationCommandInput, diff --git a/clients/client-sesv2/commands/UpdateContactCommand.ts b/clients/client-sesv2/commands/UpdateContactCommand.ts index 3c3781dd651f..ca88a9ec92f1 100644 --- a/clients/client-sesv2/commands/UpdateContactCommand.ts +++ b/clients/client-sesv2/commands/UpdateContactCommand.ts @@ -24,6 +24,20 @@ export interface UpdateContactCommandOutput extends UpdateContactResponse, __Met *

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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { SESv2Client, UpdateContactCommand } from "@aws-sdk/client-sesv2"; // ES Modules import + * // const { SESv2Client, UpdateContactCommand } = require("@aws-sdk/client-sesv2"); // CommonJS import + * const client = new SESv2Client(config); + * const command = new UpdateContactCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link UpdateContactCommandInput} for command's `input` shape. + * @see {@link UpdateContactCommandOutput} for command's `response` shape. + * @see {@link SESv2ClientResolvedConfig | config} for command's `input` shape. + * */ export class UpdateContactCommand extends $Command< UpdateContactCommandInput, diff --git a/clients/client-sesv2/commands/UpdateContactListCommand.ts b/clients/client-sesv2/commands/UpdateContactListCommand.ts index 881ae62b9a77..102ec2c25120 100644 --- a/clients/client-sesv2/commands/UpdateContactListCommand.ts +++ b/clients/client-sesv2/commands/UpdateContactListCommand.ts @@ -22,6 +22,20 @@ export interface UpdateContactListCommandOutput extends UpdateContactListRespons /** *

Updates contact list metadata. This operation does a complete replacement.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { SESv2Client, UpdateContactListCommand } from "@aws-sdk/client-sesv2"; // ES Modules import + * // const { SESv2Client, UpdateContactListCommand } = require("@aws-sdk/client-sesv2"); // CommonJS import + * const client = new SESv2Client(config); + * const command = new UpdateContactListCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link UpdateContactListCommandInput} for command's `input` shape. + * @see {@link UpdateContactListCommandOutput} for command's `response` shape. + * @see {@link SESv2ClientResolvedConfig | config} for command's `input` shape. + * */ export class UpdateContactListCommand extends $Command< UpdateContactListCommandInput, diff --git a/clients/client-sesv2/commands/UpdateCustomVerificationEmailTemplateCommand.ts b/clients/client-sesv2/commands/UpdateCustomVerificationEmailTemplateCommand.ts index 6a60386301bf..517dfcd8db3f 100644 --- a/clients/client-sesv2/commands/UpdateCustomVerificationEmailTemplateCommand.ts +++ b/clients/client-sesv2/commands/UpdateCustomVerificationEmailTemplateCommand.ts @@ -31,6 +31,20 @@ export interface UpdateCustomVerificationEmailTemplateCommandOutput *

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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { SESv2Client, UpdateCustomVerificationEmailTemplateCommand } from "@aws-sdk/client-sesv2"; // ES Modules import + * // const { SESv2Client, UpdateCustomVerificationEmailTemplateCommand } = require("@aws-sdk/client-sesv2"); // CommonJS import + * const client = new SESv2Client(config); + * const command = new UpdateCustomVerificationEmailTemplateCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link UpdateCustomVerificationEmailTemplateCommandInput} for command's `input` shape. + * @see {@link UpdateCustomVerificationEmailTemplateCommandOutput} for command's `response` shape. + * @see {@link SESv2ClientResolvedConfig | config} for command's `input` shape. + * */ export class UpdateCustomVerificationEmailTemplateCommand extends $Command< UpdateCustomVerificationEmailTemplateCommandInput, diff --git a/clients/client-sesv2/commands/UpdateEmailIdentityPolicyCommand.ts b/clients/client-sesv2/commands/UpdateEmailIdentityPolicyCommand.ts index 40e2fb707fcc..b8ac8303e82e 100644 --- a/clients/client-sesv2/commands/UpdateEmailIdentityPolicyCommand.ts +++ b/clients/client-sesv2/commands/UpdateEmailIdentityPolicyCommand.ts @@ -34,6 +34,20 @@ export interface UpdateEmailIdentityPolicyCommandOutput extends UpdateEmailIdent * Guide.

* *

You can execute this operation no more than once per second.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { SESv2Client, UpdateEmailIdentityPolicyCommand } from "@aws-sdk/client-sesv2"; // ES Modules import + * // const { SESv2Client, UpdateEmailIdentityPolicyCommand } = require("@aws-sdk/client-sesv2"); // CommonJS import + * const client = new SESv2Client(config); + * const command = new UpdateEmailIdentityPolicyCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link UpdateEmailIdentityPolicyCommandInput} for command's `input` shape. + * @see {@link UpdateEmailIdentityPolicyCommandOutput} for command's `response` shape. + * @see {@link SESv2ClientResolvedConfig | config} for command's `input` shape. + * */ export class UpdateEmailIdentityPolicyCommand extends $Command< UpdateEmailIdentityPolicyCommandInput, diff --git a/clients/client-sesv2/commands/UpdateEmailTemplateCommand.ts b/clients/client-sesv2/commands/UpdateEmailTemplateCommand.ts index 0872d682cafc..723d583e0767 100644 --- a/clients/client-sesv2/commands/UpdateEmailTemplateCommand.ts +++ b/clients/client-sesv2/commands/UpdateEmailTemplateCommand.ts @@ -25,6 +25,20 @@ export interface UpdateEmailTemplateCommandOutput extends UpdateEmailTemplateRes * 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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { SESv2Client, UpdateEmailTemplateCommand } from "@aws-sdk/client-sesv2"; // ES Modules import + * // const { SESv2Client, UpdateEmailTemplateCommand } = require("@aws-sdk/client-sesv2"); // CommonJS import + * const client = new SESv2Client(config); + * const command = new UpdateEmailTemplateCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link UpdateEmailTemplateCommandInput} for command's `input` shape. + * @see {@link UpdateEmailTemplateCommandOutput} for command's `response` shape. + * @see {@link SESv2ClientResolvedConfig | config} for command's `input` shape. + * */ export class UpdateEmailTemplateCommand extends $Command< UpdateEmailTemplateCommandInput, diff --git a/clients/client-sesv2/models/models_0.ts b/clients/client-sesv2/models/models_0.ts index d954ee08b1b9..d07b31b3cfda 100644 --- a/clients/client-sesv2/models/models_0.ts +++ b/clients/client-sesv2/models/models_0.ts @@ -57,6 +57,9 @@ export interface ReviewDetails { } export namespace ReviewDetails { + /** + * @internal + */ export const filterSensitiveLog = (obj: ReviewDetails): any => ({ ...obj, }); @@ -114,6 +117,9 @@ export interface AccountDetails { } export namespace AccountDetails { + /** + * @internal + */ export const filterSensitiveLog = (obj: AccountDetails): any => ({ ...obj, ...(obj.WebsiteURL && { WebsiteURL: SENSITIVE_STRING }), @@ -133,6 +139,9 @@ export interface AccountSuspendedException extends __SmithyException, $MetadataB } export namespace AccountSuspendedException { + /** + * @internal + */ export const filterSensitiveLog = (obj: AccountSuspendedException): any => ({ ...obj, }); @@ -148,6 +157,9 @@ export interface AlreadyExistsException extends __SmithyException, $MetadataBear } export namespace AlreadyExistsException { + /** + * @internal + */ export const filterSensitiveLog = (obj: AlreadyExistsException): any => ({ ...obj, }); @@ -163,6 +175,9 @@ export interface BadRequestException extends __SmithyException, $MetadataBearer } export namespace BadRequestException { + /** + * @internal + */ export const filterSensitiveLog = (obj: BadRequestException): any => ({ ...obj, }); @@ -196,6 +211,9 @@ export interface BlacklistEntry { } export namespace BlacklistEntry { + /** + * @internal + */ export const filterSensitiveLog = (obj: BlacklistEntry): any => ({ ...obj, }); @@ -221,6 +239,9 @@ export interface Content { } export namespace Content { + /** + * @internal + */ export const filterSensitiveLog = (obj: Content): any => ({ ...obj, }); @@ -246,6 +267,9 @@ export interface Body { } export namespace Body { + /** + * @internal + */ export const filterSensitiveLog = (obj: Body): any => ({ ...obj, }); @@ -279,6 +303,9 @@ export interface Template { } export namespace Template { + /** + * @internal + */ export const filterSensitiveLog = (obj: Template): any => ({ ...obj, }); @@ -296,6 +323,9 @@ export interface BulkEmailContent { } export namespace BulkEmailContent { + /** + * @internal + */ export const filterSensitiveLog = (obj: BulkEmailContent): any => ({ ...obj, }); @@ -325,6 +355,9 @@ export interface Destination { } export namespace Destination { + /** + * @internal + */ export const filterSensitiveLog = (obj: Destination): any => ({ ...obj, }); @@ -344,6 +377,9 @@ export interface ReplacementTemplate { } export namespace ReplacementTemplate { + /** + * @internal + */ export const filterSensitiveLog = (obj: ReplacementTemplate): any => ({ ...obj, }); @@ -363,6 +399,9 @@ export interface ReplacementEmailContent { } export namespace ReplacementEmailContent { + /** + * @internal + */ export const filterSensitiveLog = (obj: ReplacementEmailContent): any => ({ ...obj, }); @@ -406,6 +445,9 @@ export interface MessageTag { } export namespace MessageTag { + /** + * @internal + */ export const filterSensitiveLog = (obj: MessageTag): any => ({ ...obj, }); @@ -442,6 +484,9 @@ export interface BulkEmailEntry { } export namespace BulkEmailEntry { + /** + * @internal + */ export const filterSensitiveLog = (obj: BulkEmailEntry): any => ({ ...obj, }); @@ -548,6 +593,9 @@ export interface BulkEmailEntryResult { } export namespace BulkEmailEntryResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: BulkEmailEntryResult): any => ({ ...obj, }); @@ -607,6 +655,9 @@ export interface CloudWatchDimensionConfiguration { } export namespace CloudWatchDimensionConfiguration { + /** + * @internal + */ export const filterSensitiveLog = (obj: CloudWatchDimensionConfiguration): any => ({ ...obj, }); @@ -625,6 +676,9 @@ export interface CloudWatchDestination { } export namespace CloudWatchDestination { + /** + * @internal + */ export const filterSensitiveLog = (obj: CloudWatchDestination): any => ({ ...obj, }); @@ -640,6 +694,9 @@ export interface ConcurrentModificationException extends __SmithyException, $Met } export namespace ConcurrentModificationException { + /** + * @internal + */ export const filterSensitiveLog = (obj: ConcurrentModificationException): any => ({ ...obj, }); @@ -655,6 +712,9 @@ export interface ConflictException extends __SmithyException, $MetadataBearer { } export namespace ConflictException { + /** + * @internal + */ export const filterSensitiveLog = (obj: ConflictException): any => ({ ...obj, }); @@ -682,6 +742,9 @@ export interface TopicPreference { } export namespace TopicPreference { + /** + * @internal + */ export const filterSensitiveLog = (obj: TopicPreference): any => ({ ...obj, }); @@ -719,6 +782,9 @@ export interface Contact { } export namespace Contact { + /** + * @internal + */ export const filterSensitiveLog = (obj: Contact): any => ({ ...obj, }); @@ -741,6 +807,9 @@ export interface ContactList { } export namespace ContactList { + /** + * @internal + */ export const filterSensitiveLog = (obj: ContactList): any => ({ ...obj, }); @@ -777,6 +846,9 @@ export interface ContactListDestination { } export namespace ContactListDestination { + /** + * @internal + */ export const filterSensitiveLog = (obj: ContactListDestination): any => ({ ...obj, }); @@ -807,6 +879,9 @@ export interface DeliveryOptions { } export namespace DeliveryOptions { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeliveryOptions): any => ({ ...obj, }); @@ -833,6 +908,9 @@ export interface ReputationOptions { } export namespace ReputationOptions { + /** + * @internal + */ export const filterSensitiveLog = (obj: ReputationOptions): any => ({ ...obj, }); @@ -851,6 +929,9 @@ export interface SendingOptions { } export namespace SendingOptions { + /** + * @internal + */ export const filterSensitiveLog = (obj: SendingOptions): any => ({ ...obj, }); @@ -889,6 +970,9 @@ export interface SuppressionOptions { } export namespace SuppressionOptions { + /** + * @internal + */ export const filterSensitiveLog = (obj: SuppressionOptions): any => ({ ...obj, }); @@ -946,6 +1030,9 @@ export interface Tag { } export namespace Tag { + /** + * @internal + */ export const filterSensitiveLog = (obj: Tag): any => ({ ...obj, }); @@ -968,6 +1055,9 @@ export interface TrackingOptions { } export namespace TrackingOptions { + /** + * @internal + */ export const filterSensitiveLog = (obj: TrackingOptions): any => ({ ...obj, }); @@ -1020,6 +1110,9 @@ export interface CreateConfigurationSetRequest { } export namespace CreateConfigurationSetRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateConfigurationSetRequest): any => ({ ...obj, }); @@ -1032,6 +1125,9 @@ export namespace CreateConfigurationSetRequest { export interface CreateConfigurationSetResponse {} export namespace CreateConfigurationSetResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateConfigurationSetResponse): any => ({ ...obj, }); @@ -1047,6 +1143,9 @@ export interface LimitExceededException extends __SmithyException, $MetadataBear } export namespace LimitExceededException { + /** + * @internal + */ export const filterSensitiveLog = (obj: LimitExceededException): any => ({ ...obj, }); @@ -1062,6 +1161,9 @@ export interface NotFoundException extends __SmithyException, $MetadataBearer { } export namespace NotFoundException { + /** + * @internal + */ export const filterSensitiveLog = (obj: NotFoundException): any => ({ ...obj, }); @@ -1077,6 +1179,9 @@ export interface TooManyRequestsException extends __SmithyException, $MetadataBe } export namespace TooManyRequestsException { + /** + * @internal + */ export const filterSensitiveLog = (obj: TooManyRequestsException): any => ({ ...obj, }); @@ -1101,6 +1206,9 @@ export interface KinesisFirehoseDestination { } export namespace KinesisFirehoseDestination { + /** + * @internal + */ export const filterSensitiveLog = (obj: KinesisFirehoseDestination): any => ({ ...obj, }); @@ -1134,6 +1242,9 @@ export interface PinpointDestination { } export namespace PinpointDestination { + /** + * @internal + */ export const filterSensitiveLog = (obj: PinpointDestination): any => ({ ...obj, }); @@ -1153,6 +1264,9 @@ export interface SnsDestination { } export namespace SnsDestination { + /** + * @internal + */ export const filterSensitiveLog = (obj: SnsDestination): any => ({ ...obj, }); @@ -1208,6 +1322,9 @@ export interface EventDestinationDefinition { } export namespace EventDestinationDefinition { + /** + * @internal + */ export const filterSensitiveLog = (obj: EventDestinationDefinition): any => ({ ...obj, }); @@ -1234,6 +1351,9 @@ export interface CreateConfigurationSetEventDestinationRequest { } export namespace CreateConfigurationSetEventDestinationRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateConfigurationSetEventDestinationRequest): any => ({ ...obj, }); @@ -1246,6 +1366,9 @@ export namespace CreateConfigurationSetEventDestinationRequest { export interface CreateConfigurationSetEventDestinationResponse {} export namespace CreateConfigurationSetEventDestinationResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateConfigurationSetEventDestinationResponse): any => ({ ...obj, }); @@ -1280,6 +1403,9 @@ export interface CreateContactRequest { } export namespace CreateContactRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateContactRequest): any => ({ ...obj, }); @@ -1288,6 +1414,9 @@ export namespace CreateContactRequest { export interface CreateContactResponse {} export namespace CreateContactResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateContactResponse): any => ({ ...obj, }); @@ -1321,6 +1450,9 @@ export interface Topic { } export namespace Topic { + /** + * @internal + */ export const filterSensitiveLog = (obj: Topic): any => ({ ...obj, }); @@ -1350,6 +1482,9 @@ export interface CreateContactListRequest { } export namespace CreateContactListRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateContactListRequest): any => ({ ...obj, }); @@ -1358,6 +1493,9 @@ export namespace CreateContactListRequest { export interface CreateContactListResponse {} export namespace CreateContactListResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateContactListResponse): any => ({ ...obj, }); @@ -1404,6 +1542,9 @@ export interface CreateCustomVerificationEmailTemplateRequest { } export namespace CreateCustomVerificationEmailTemplateRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateCustomVerificationEmailTemplateRequest): any => ({ ...obj, }); @@ -1416,6 +1557,9 @@ export namespace CreateCustomVerificationEmailTemplateRequest { export interface CreateCustomVerificationEmailTemplateResponse {} export namespace CreateCustomVerificationEmailTemplateResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateCustomVerificationEmailTemplateResponse): any => ({ ...obj, }); @@ -1438,6 +1582,9 @@ export interface CreateDedicatedIpPoolRequest { } export namespace CreateDedicatedIpPoolRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateDedicatedIpPoolRequest): any => ({ ...obj, }); @@ -1450,6 +1597,9 @@ export namespace CreateDedicatedIpPoolRequest { export interface CreateDedicatedIpPoolResponse {} export namespace CreateDedicatedIpPoolResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateDedicatedIpPoolResponse): any => ({ ...obj, }); @@ -1493,6 +1643,9 @@ export interface RawMessage { } export namespace RawMessage { + /** + * @internal + */ export const filterSensitiveLog = (obj: RawMessage): any => ({ ...obj, }); @@ -1518,6 +1671,9 @@ export interface Message { } export namespace Message { + /** + * @internal + */ export const filterSensitiveLog = (obj: Message): any => ({ ...obj, }); @@ -1577,6 +1733,9 @@ export interface EmailContent { } export namespace EmailContent { + /** + * @internal + */ export const filterSensitiveLog = (obj: EmailContent): any => ({ ...obj, }); @@ -1616,6 +1775,9 @@ export interface CreateDeliverabilityTestReportRequest { } export namespace CreateDeliverabilityTestReportRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateDeliverabilityTestReportRequest): any => ({ ...obj, }); @@ -1645,6 +1807,9 @@ export interface CreateDeliverabilityTestReportResponse { } export namespace CreateDeliverabilityTestReportResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateDeliverabilityTestReportResponse): any => ({ ...obj, }); @@ -1660,6 +1825,9 @@ export interface MailFromDomainNotVerifiedException extends __SmithyException, $ } export namespace MailFromDomainNotVerifiedException { + /** + * @internal + */ export const filterSensitiveLog = (obj: MailFromDomainNotVerifiedException): any => ({ ...obj, }); @@ -1675,6 +1843,9 @@ export interface MessageRejected extends __SmithyException, $MetadataBearer { } export namespace MessageRejected { + /** + * @internal + */ export const filterSensitiveLog = (obj: MessageRejected): any => ({ ...obj, }); @@ -1691,6 +1862,9 @@ export interface SendingPausedException extends __SmithyException, $MetadataBear } export namespace SendingPausedException { + /** + * @internal + */ export const filterSensitiveLog = (obj: SendingPausedException): any => ({ ...obj, }); @@ -1716,6 +1890,9 @@ export interface DkimSigningAttributes { } export namespace DkimSigningAttributes { + /** + * @internal + */ export const filterSensitiveLog = (obj: DkimSigningAttributes): any => ({ ...obj, ...(obj.DomainSigningPrivateKey && { DomainSigningPrivateKey: SENSITIVE_STRING }), @@ -1757,6 +1934,9 @@ export interface CreateEmailIdentityRequest { } export namespace CreateEmailIdentityRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateEmailIdentityRequest): any => ({ ...obj, ...(obj.DkimSigningAttributes && { @@ -1865,6 +2045,9 @@ export interface DkimAttributes { } export namespace DkimAttributes { + /** + * @internal + */ export const filterSensitiveLog = (obj: DkimAttributes): any => ({ ...obj, }); @@ -1901,6 +2084,9 @@ export interface CreateEmailIdentityResponse { } export namespace CreateEmailIdentityResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateEmailIdentityResponse): any => ({ ...obj, }); @@ -1934,6 +2120,9 @@ export interface CreateEmailIdentityPolicyRequest { } export namespace CreateEmailIdentityPolicyRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateEmailIdentityPolicyRequest): any => ({ ...obj, }); @@ -1946,6 +2135,9 @@ export namespace CreateEmailIdentityPolicyRequest { export interface CreateEmailIdentityPolicyResponse {} export namespace CreateEmailIdentityPolicyResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateEmailIdentityPolicyResponse): any => ({ ...obj, }); @@ -1974,6 +2166,9 @@ export interface EmailTemplateContent { } export namespace EmailTemplateContent { + /** + * @internal + */ export const filterSensitiveLog = (obj: EmailTemplateContent): any => ({ ...obj, }); @@ -1997,6 +2192,9 @@ export interface CreateEmailTemplateRequest { } export namespace CreateEmailTemplateRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateEmailTemplateRequest): any => ({ ...obj, }); @@ -2009,6 +2207,9 @@ export namespace CreateEmailTemplateRequest { export interface CreateEmailTemplateResponse {} export namespace CreateEmailTemplateResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateEmailTemplateResponse): any => ({ ...obj, }); @@ -2036,6 +2237,9 @@ export interface ImportDataSource { } export namespace ImportDataSource { + /** + * @internal + */ export const filterSensitiveLog = (obj: ImportDataSource): any => ({ ...obj, }); @@ -2066,6 +2270,9 @@ export interface SuppressionListDestination { } export namespace SuppressionListDestination { + /** + * @internal + */ export const filterSensitiveLog = (obj: SuppressionListDestination): any => ({ ...obj, }); @@ -2088,6 +2295,9 @@ export interface ImportDestination { } export namespace ImportDestination { + /** + * @internal + */ export const filterSensitiveLog = (obj: ImportDestination): any => ({ ...obj, }); @@ -2110,6 +2320,9 @@ export interface CreateImportJobRequest { } export namespace CreateImportJobRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateImportJobRequest): any => ({ ...obj, }); @@ -2127,6 +2340,9 @@ export interface CreateImportJobResponse { } export namespace CreateImportJobResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateImportJobResponse): any => ({ ...obj, }); @@ -2165,6 +2381,9 @@ export interface CustomVerificationEmailTemplateMetadata { } export namespace CustomVerificationEmailTemplateMetadata { + /** + * @internal + */ export const filterSensitiveLog = (obj: CustomVerificationEmailTemplateMetadata): any => ({ ...obj, }); @@ -2206,6 +2425,9 @@ export interface DomainIspPlacement { } export namespace DomainIspPlacement { + /** + * @internal + */ export const filterSensitiveLog = (obj: DomainIspPlacement): any => ({ ...obj, }); @@ -2241,6 +2463,9 @@ export interface VolumeStatistics { } export namespace VolumeStatistics { + /** + * @internal + */ export const filterSensitiveLog = (obj: VolumeStatistics): any => ({ ...obj, }); @@ -2270,6 +2495,9 @@ export interface DailyVolume { } export namespace DailyVolume { + /** + * @internal + */ export const filterSensitiveLog = (obj: DailyVolume): any => ({ ...obj, }); @@ -2324,6 +2552,9 @@ export interface DedicatedIp { } export namespace DedicatedIp { + /** + * @internal + */ export const filterSensitiveLog = (obj: DedicatedIp): any => ({ ...obj, }); @@ -2340,6 +2571,9 @@ export interface DeleteConfigurationSetRequest { } export namespace DeleteConfigurationSetRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteConfigurationSetRequest): any => ({ ...obj, }); @@ -2352,6 +2586,9 @@ export namespace DeleteConfigurationSetRequest { export interface DeleteConfigurationSetResponse {} export namespace DeleteConfigurationSetResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteConfigurationSetResponse): any => ({ ...obj, }); @@ -2374,6 +2611,9 @@ export interface DeleteConfigurationSetEventDestinationRequest { } export namespace DeleteConfigurationSetEventDestinationRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteConfigurationSetEventDestinationRequest): any => ({ ...obj, }); @@ -2386,6 +2626,9 @@ export namespace DeleteConfigurationSetEventDestinationRequest { export interface DeleteConfigurationSetEventDestinationResponse {} export namespace DeleteConfigurationSetEventDestinationResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteConfigurationSetEventDestinationResponse): any => ({ ...obj, }); @@ -2404,6 +2647,9 @@ export interface DeleteContactRequest { } export namespace DeleteContactRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteContactRequest): any => ({ ...obj, }); @@ -2412,6 +2658,9 @@ export namespace DeleteContactRequest { export interface DeleteContactResponse {} export namespace DeleteContactResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteContactResponse): any => ({ ...obj, }); @@ -2425,6 +2674,9 @@ export interface DeleteContactListRequest { } export namespace DeleteContactListRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteContactListRequest): any => ({ ...obj, }); @@ -2433,6 +2685,9 @@ export namespace DeleteContactListRequest { export interface DeleteContactListResponse {} export namespace DeleteContactListResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteContactListResponse): any => ({ ...obj, }); @@ -2449,6 +2704,9 @@ export interface DeleteCustomVerificationEmailTemplateRequest { } export namespace DeleteCustomVerificationEmailTemplateRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteCustomVerificationEmailTemplateRequest): any => ({ ...obj, }); @@ -2461,6 +2719,9 @@ export namespace DeleteCustomVerificationEmailTemplateRequest { export interface DeleteCustomVerificationEmailTemplateResponse {} export namespace DeleteCustomVerificationEmailTemplateResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteCustomVerificationEmailTemplateResponse): any => ({ ...obj, }); @@ -2477,6 +2738,9 @@ export interface DeleteDedicatedIpPoolRequest { } export namespace DeleteDedicatedIpPoolRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteDedicatedIpPoolRequest): any => ({ ...obj, }); @@ -2489,6 +2753,9 @@ export namespace DeleteDedicatedIpPoolRequest { export interface DeleteDedicatedIpPoolResponse {} export namespace DeleteDedicatedIpPoolResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteDedicatedIpPoolResponse): any => ({ ...obj, }); @@ -2507,6 +2774,9 @@ export interface DeleteEmailIdentityRequest { } export namespace DeleteEmailIdentityRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteEmailIdentityRequest): any => ({ ...obj, }); @@ -2519,6 +2789,9 @@ export namespace DeleteEmailIdentityRequest { export interface DeleteEmailIdentityResponse {} export namespace DeleteEmailIdentityResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteEmailIdentityResponse): any => ({ ...obj, }); @@ -2545,6 +2818,9 @@ export interface DeleteEmailIdentityPolicyRequest { } export namespace DeleteEmailIdentityPolicyRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteEmailIdentityPolicyRequest): any => ({ ...obj, }); @@ -2557,6 +2833,9 @@ export namespace DeleteEmailIdentityPolicyRequest { export interface DeleteEmailIdentityPolicyResponse {} export namespace DeleteEmailIdentityPolicyResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteEmailIdentityPolicyResponse): any => ({ ...obj, }); @@ -2574,6 +2853,9 @@ export interface DeleteEmailTemplateRequest { } export namespace DeleteEmailTemplateRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteEmailTemplateRequest): any => ({ ...obj, }); @@ -2586,6 +2868,9 @@ export namespace DeleteEmailTemplateRequest { export interface DeleteEmailTemplateResponse {} export namespace DeleteEmailTemplateResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteEmailTemplateResponse): any => ({ ...obj, }); @@ -2603,6 +2888,9 @@ export interface DeleteSuppressedDestinationRequest { } export namespace DeleteSuppressedDestinationRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteSuppressedDestinationRequest): any => ({ ...obj, }); @@ -2615,6 +2903,9 @@ export namespace DeleteSuppressedDestinationRequest { export interface DeleteSuppressedDestinationResponse {} export namespace DeleteSuppressedDestinationResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteSuppressedDestinationResponse): any => ({ ...obj, }); @@ -2665,6 +2956,9 @@ export interface DeliverabilityTestReport { } export namespace DeliverabilityTestReport { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeliverabilityTestReport): any => ({ ...obj, }); @@ -2762,6 +3056,9 @@ export interface DomainDeliverabilityCampaign { } export namespace DomainDeliverabilityCampaign { + /** + * @internal + */ export const filterSensitiveLog = (obj: DomainDeliverabilityCampaign): any => ({ ...obj, }); @@ -2786,6 +3083,9 @@ export interface InboxPlacementTrackingOption { } export namespace InboxPlacementTrackingOption { + /** + * @internal + */ export const filterSensitiveLog = (obj: InboxPlacementTrackingOption): any => ({ ...obj, }); @@ -2818,6 +3118,9 @@ export interface DomainDeliverabilityTrackingOption { } export namespace DomainDeliverabilityTrackingOption { + /** + * @internal + */ export const filterSensitiveLog = (obj: DomainDeliverabilityTrackingOption): any => ({ ...obj, }); @@ -2839,6 +3142,9 @@ export interface EmailTemplateMetadata { } export namespace EmailTemplateMetadata { + /** + * @internal + */ export const filterSensitiveLog = (obj: EmailTemplateMetadata): any => ({ ...obj, }); @@ -2899,6 +3205,9 @@ export interface EventDestination { } export namespace EventDestination { + /** + * @internal + */ export const filterSensitiveLog = (obj: EventDestination): any => ({ ...obj, }); @@ -2921,6 +3230,9 @@ export interface FailureInfo { } export namespace FailureInfo { + /** + * @internal + */ export const filterSensitiveLog = (obj: FailureInfo): any => ({ ...obj, }); @@ -2933,6 +3245,9 @@ export namespace FailureInfo { export interface GetAccountRequest {} export namespace GetAccountRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetAccountRequest): any => ({ ...obj, }); @@ -2965,6 +3280,9 @@ export interface SendQuota { } export namespace SendQuota { + /** + * @internal + */ export const filterSensitiveLog = (obj: SendQuota): any => ({ ...obj, }); @@ -2998,6 +3316,9 @@ export interface SuppressionAttributes { } export namespace SuppressionAttributes { + /** + * @internal + */ export const filterSensitiveLog = (obj: SuppressionAttributes): any => ({ ...obj, }); @@ -3079,6 +3400,9 @@ export interface GetAccountResponse { } export namespace GetAccountResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetAccountResponse): any => ({ ...obj, ...(obj.Details && { Details: AccountDetails.filterSensitiveLog(obj.Details) }), @@ -3099,6 +3423,9 @@ export interface GetBlacklistReportsRequest { } export namespace GetBlacklistReportsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetBlacklistReportsRequest): any => ({ ...obj, }); @@ -3116,6 +3443,9 @@ export interface GetBlacklistReportsResponse { } export namespace GetBlacklistReportsResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetBlacklistReportsResponse): any => ({ ...obj, }); @@ -3133,6 +3463,9 @@ export interface GetConfigurationSetRequest { } export namespace GetConfigurationSetRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetConfigurationSetRequest): any => ({ ...obj, }); @@ -3185,6 +3518,9 @@ export interface GetConfigurationSetResponse { } export namespace GetConfigurationSetResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetConfigurationSetResponse): any => ({ ...obj, }); @@ -3202,6 +3538,9 @@ export interface GetConfigurationSetEventDestinationsRequest { } export namespace GetConfigurationSetEventDestinationsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetConfigurationSetEventDestinationsRequest): any => ({ ...obj, }); @@ -3219,6 +3558,9 @@ export interface GetConfigurationSetEventDestinationsResponse { } export namespace GetConfigurationSetEventDestinationsResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetConfigurationSetEventDestinationsResponse): any => ({ ...obj, }); @@ -3237,6 +3579,9 @@ export interface GetContactRequest { } export namespace GetContactRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetContactRequest): any => ({ ...obj, }); @@ -3286,6 +3631,9 @@ export interface GetContactResponse { } export namespace GetContactResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetContactResponse): any => ({ ...obj, }); @@ -3299,6 +3647,9 @@ export interface GetContactListRequest { } export namespace GetContactListRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetContactListRequest): any => ({ ...obj, }); @@ -3338,6 +3689,9 @@ export interface GetContactListResponse { } export namespace GetContactListResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetContactListResponse): any => ({ ...obj, }); @@ -3355,6 +3709,9 @@ export interface GetCustomVerificationEmailTemplateRequest { } export namespace GetCustomVerificationEmailTemplateRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetCustomVerificationEmailTemplateRequest): any => ({ ...obj, }); @@ -3398,6 +3755,9 @@ export interface GetCustomVerificationEmailTemplateResponse { } export namespace GetCustomVerificationEmailTemplateResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetCustomVerificationEmailTemplateResponse): any => ({ ...obj, }); @@ -3415,6 +3775,9 @@ export interface GetDedicatedIpRequest { } export namespace GetDedicatedIpRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetDedicatedIpRequest): any => ({ ...obj, }); @@ -3431,6 +3794,9 @@ export interface GetDedicatedIpResponse { } export namespace GetDedicatedIpResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetDedicatedIpResponse): any => ({ ...obj, }); @@ -3461,6 +3827,9 @@ export interface GetDedicatedIpsRequest { } export namespace GetDedicatedIpsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetDedicatedIpsRequest): any => ({ ...obj, }); @@ -3485,6 +3854,9 @@ export interface GetDedicatedIpsResponse { } export namespace GetDedicatedIpsResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetDedicatedIpsResponse): any => ({ ...obj, }); @@ -3502,6 +3874,9 @@ export namespace GetDedicatedIpsResponse { export interface GetDeliverabilityDashboardOptionsRequest {} export namespace GetDeliverabilityDashboardOptionsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetDeliverabilityDashboardOptionsRequest): any => ({ ...obj, }); @@ -3548,6 +3923,9 @@ export interface GetDeliverabilityDashboardOptionsResponse { } export namespace GetDeliverabilityDashboardOptionsResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetDeliverabilityDashboardOptionsResponse): any => ({ ...obj, }); @@ -3564,6 +3942,9 @@ export interface GetDeliverabilityTestReportRequest { } export namespace GetDeliverabilityTestReportRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetDeliverabilityTestReportRequest): any => ({ ...obj, }); @@ -3604,6 +3985,9 @@ export interface PlacementStatistics { } export namespace PlacementStatistics { + /** + * @internal + */ export const filterSensitiveLog = (obj: PlacementStatistics): any => ({ ...obj, }); @@ -3626,6 +4010,9 @@ export interface IspPlacement { } export namespace IspPlacement { + /** + * @internal + */ export const filterSensitiveLog = (obj: IspPlacement): any => ({ ...obj, }); @@ -3667,6 +4054,9 @@ export interface GetDeliverabilityTestReportResponse { } export namespace GetDeliverabilityTestReportResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetDeliverabilityTestReportResponse): any => ({ ...obj, }); @@ -3687,6 +4077,9 @@ export interface GetDomainDeliverabilityCampaignRequest { } export namespace GetDomainDeliverabilityCampaignRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetDomainDeliverabilityCampaignRequest): any => ({ ...obj, }); @@ -3705,6 +4098,9 @@ export interface GetDomainDeliverabilityCampaignResponse { } export namespace GetDomainDeliverabilityCampaignResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetDomainDeliverabilityCampaignResponse): any => ({ ...obj, }); @@ -3734,6 +4130,9 @@ export interface GetDomainStatisticsReportRequest { } export namespace GetDomainStatisticsReportRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetDomainStatisticsReportRequest): any => ({ ...obj, }); @@ -3764,6 +4163,9 @@ export interface OverallVolume { } export namespace OverallVolume { + /** + * @internal + */ export const filterSensitiveLog = (obj: OverallVolume): any => ({ ...obj, }); @@ -3790,6 +4192,9 @@ export interface GetDomainStatisticsReportResponse { } export namespace GetDomainStatisticsReportResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetDomainStatisticsReportResponse): any => ({ ...obj, }); @@ -3806,6 +4211,9 @@ export interface GetEmailIdentityRequest { } export namespace GetEmailIdentityRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetEmailIdentityRequest): any => ({ ...obj, }); @@ -3869,6 +4277,9 @@ export interface MailFromAttributes { } export namespace MailFromAttributes { + /** + * @internal + */ export const filterSensitiveLog = (obj: MailFromAttributes): any => ({ ...obj, }); @@ -3931,6 +4342,9 @@ export interface GetEmailIdentityResponse { } export namespace GetEmailIdentityResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetEmailIdentityResponse): any => ({ ...obj, }); @@ -3947,6 +4361,9 @@ export interface GetEmailIdentityPoliciesRequest { } export namespace GetEmailIdentityPoliciesRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetEmailIdentityPoliciesRequest): any => ({ ...obj, }); @@ -3963,6 +4380,9 @@ export interface GetEmailIdentityPoliciesResponse { } export namespace GetEmailIdentityPoliciesResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetEmailIdentityPoliciesResponse): any => ({ ...obj, }); @@ -3980,6 +4400,9 @@ export interface GetEmailTemplateRequest { } export namespace GetEmailTemplateRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetEmailTemplateRequest): any => ({ ...obj, }); @@ -4002,6 +4425,9 @@ export interface GetEmailTemplateResponse { } export namespace GetEmailTemplateResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetEmailTemplateResponse): any => ({ ...obj, }); @@ -4019,6 +4445,9 @@ export interface GetImportJobRequest { } export namespace GetImportJobRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetImportJobRequest): any => ({ ...obj, }); @@ -4084,6 +4513,9 @@ export interface GetImportJobResponse { } export namespace GetImportJobResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetImportJobResponse): any => ({ ...obj, }); @@ -4101,6 +4533,9 @@ export interface GetSuppressedDestinationRequest { } export namespace GetSuppressedDestinationRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetSuppressedDestinationRequest): any => ({ ...obj, }); @@ -4125,6 +4560,9 @@ export interface SuppressedDestinationAttributes { } export namespace SuppressedDestinationAttributes { + /** + * @internal + */ export const filterSensitiveLog = (obj: SuppressedDestinationAttributes): any => ({ ...obj, }); @@ -4159,6 +4597,9 @@ export interface SuppressedDestination { } export namespace SuppressedDestination { + /** + * @internal + */ export const filterSensitiveLog = (obj: SuppressedDestination): any => ({ ...obj, }); @@ -4175,6 +4616,9 @@ export interface GetSuppressedDestinationResponse { } export namespace GetSuppressedDestinationResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetSuppressedDestinationResponse): any => ({ ...obj, }); @@ -4219,6 +4663,9 @@ export interface IdentityInfo { } export namespace IdentityInfo { + /** + * @internal + */ export const filterSensitiveLog = (obj: IdentityInfo): any => ({ ...obj, }); @@ -4256,6 +4703,9 @@ export interface ImportJobSummary { } export namespace ImportJobSummary { + /** + * @internal + */ export const filterSensitiveLog = (obj: ImportJobSummary): any => ({ ...obj, }); @@ -4271,6 +4721,9 @@ export interface InvalidNextTokenException extends __SmithyException, $MetadataB } export namespace InvalidNextTokenException { + /** + * @internal + */ export const filterSensitiveLog = (obj: InvalidNextTokenException): any => ({ ...obj, }); @@ -4297,6 +4750,9 @@ export interface ListConfigurationSetsRequest { } export namespace ListConfigurationSetsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListConfigurationSetsRequest): any => ({ ...obj, }); @@ -4322,6 +4778,9 @@ export interface ListConfigurationSetsResponse { } export namespace ListConfigurationSetsResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListConfigurationSetsResponse): any => ({ ...obj, }); @@ -4347,6 +4806,9 @@ export interface ListContactListsRequest { } export namespace ListContactListsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListContactListsRequest): any => ({ ...obj, }); @@ -4367,6 +4829,9 @@ export interface ListContactListsResponse { } export namespace ListContactListsResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListContactListsResponse): any => ({ ...obj, }); @@ -4389,6 +4854,9 @@ export interface TopicFilter { } export namespace TopicFilter { + /** + * @internal + */ export const filterSensitiveLog = (obj: TopicFilter): any => ({ ...obj, }); @@ -4411,6 +4879,9 @@ export interface ListContactsFilter { } export namespace ListContactsFilter { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListContactsFilter): any => ({ ...obj, }); @@ -4446,6 +4917,9 @@ export interface ListContactsRequest { } export namespace ListContactsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListContactsRequest): any => ({ ...obj, }); @@ -4466,6 +4940,9 @@ export interface ListContactsResponse { } export namespace ListContactsResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListContactsResponse): any => ({ ...obj, }); @@ -4495,6 +4972,9 @@ export interface ListCustomVerificationEmailTemplatesRequest { } export namespace ListCustomVerificationEmailTemplatesRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListCustomVerificationEmailTemplatesRequest): any => ({ ...obj, }); @@ -4519,6 +4999,9 @@ export interface ListCustomVerificationEmailTemplatesResponse { } export namespace ListCustomVerificationEmailTemplatesResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListCustomVerificationEmailTemplatesResponse): any => ({ ...obj, }); @@ -4544,6 +5027,9 @@ export interface ListDedicatedIpPoolsRequest { } export namespace ListDedicatedIpPoolsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListDedicatedIpPoolsRequest): any => ({ ...obj, }); @@ -4568,6 +5054,9 @@ export interface ListDedicatedIpPoolsResponse { } export namespace ListDedicatedIpPoolsResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListDedicatedIpPoolsResponse): any => ({ ...obj, }); @@ -4595,6 +5084,9 @@ export interface ListDeliverabilityTestReportsRequest { } export namespace ListDeliverabilityTestReportsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListDeliverabilityTestReportsRequest): any => ({ ...obj, }); @@ -4619,6 +5111,9 @@ export interface ListDeliverabilityTestReportsResponse { } export namespace ListDeliverabilityTestReportsResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListDeliverabilityTestReportsResponse): any => ({ ...obj, }); @@ -4666,6 +5161,9 @@ export interface ListDomainDeliverabilityCampaignsRequest { } export namespace ListDomainDeliverabilityCampaignsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListDomainDeliverabilityCampaignsRequest): any => ({ ...obj, }); @@ -4692,6 +5190,9 @@ export interface ListDomainDeliverabilityCampaignsResponse { } export namespace ListDomainDeliverabilityCampaignsResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListDomainDeliverabilityCampaignsResponse): any => ({ ...obj, }); @@ -4720,6 +5221,9 @@ export interface ListEmailIdentitiesRequest { } export namespace ListEmailIdentitiesRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListEmailIdentitiesRequest): any => ({ ...obj, }); @@ -4746,6 +5250,9 @@ export interface ListEmailIdentitiesResponse { } export namespace ListEmailIdentitiesResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListEmailIdentitiesResponse): any => ({ ...obj, }); @@ -4773,6 +5280,9 @@ export interface ListEmailTemplatesRequest { } export namespace ListEmailTemplatesRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListEmailTemplatesRequest): any => ({ ...obj, }); @@ -4797,6 +5307,9 @@ export interface ListEmailTemplatesResponse { } export namespace ListEmailTemplatesResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListEmailTemplatesResponse): any => ({ ...obj, }); @@ -4831,6 +5344,9 @@ export interface ListImportJobsRequest { } export namespace ListImportJobsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListImportJobsRequest): any => ({ ...obj, }); @@ -4855,6 +5371,9 @@ export interface ListImportJobsResponse { } export namespace ListImportJobsResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListImportJobsResponse): any => ({ ...obj, }); @@ -4877,6 +5396,9 @@ export interface ListManagementOptions { } export namespace ListManagementOptions { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListManagementOptions): any => ({ ...obj, }); @@ -4923,6 +5445,9 @@ export interface ListSuppressedDestinationsRequest { } export namespace ListSuppressedDestinationsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListSuppressedDestinationsRequest): any => ({ ...obj, }); @@ -4950,6 +5475,9 @@ export interface SuppressedDestinationSummary { } export namespace SuppressedDestinationSummary { + /** + * @internal + */ export const filterSensitiveLog = (obj: SuppressedDestinationSummary): any => ({ ...obj, }); @@ -4975,6 +5503,9 @@ export interface ListSuppressedDestinationsResponse { } export namespace ListSuppressedDestinationsResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListSuppressedDestinationsResponse): any => ({ ...obj, }); @@ -4989,6 +5520,9 @@ export interface ListTagsForResourceRequest { } export namespace ListTagsForResourceRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListTagsForResourceRequest): any => ({ ...obj, }); @@ -5004,6 +5538,9 @@ export interface ListTagsForResourceResponse { } export namespace ListTagsForResourceResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListTagsForResourceResponse): any => ({ ...obj, }); @@ -5023,6 +5560,9 @@ export interface PutAccountDedicatedIpWarmupAttributesRequest { } export namespace PutAccountDedicatedIpWarmupAttributesRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: PutAccountDedicatedIpWarmupAttributesRequest): any => ({ ...obj, }); @@ -5035,6 +5575,9 @@ export namespace PutAccountDedicatedIpWarmupAttributesRequest { export interface PutAccountDedicatedIpWarmupAttributesResponse {} export namespace PutAccountDedicatedIpWarmupAttributesResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: PutAccountDedicatedIpWarmupAttributesResponse): any => ({ ...obj, }); @@ -5087,6 +5630,9 @@ export interface PutAccountDetailsRequest { } export namespace PutAccountDetailsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: PutAccountDetailsRequest): any => ({ ...obj, ...(obj.WebsiteURL && { WebsiteURL: SENSITIVE_STRING }), @@ -5102,6 +5648,9 @@ export namespace PutAccountDetailsRequest { export interface PutAccountDetailsResponse {} export namespace PutAccountDetailsResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: PutAccountDetailsResponse): any => ({ ...obj, }); @@ -5123,6 +5672,9 @@ export interface PutAccountSendingAttributesRequest { } export namespace PutAccountSendingAttributesRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: PutAccountSendingAttributesRequest): any => ({ ...obj, }); @@ -5135,6 +5687,9 @@ export namespace PutAccountSendingAttributesRequest { export interface PutAccountSendingAttributesResponse {} export namespace PutAccountSendingAttributesResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: PutAccountSendingAttributesResponse): any => ({ ...obj, }); @@ -5167,6 +5722,9 @@ export interface PutAccountSuppressionAttributesRequest { } export namespace PutAccountSuppressionAttributesRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: PutAccountSuppressionAttributesRequest): any => ({ ...obj, }); @@ -5179,6 +5737,9 @@ export namespace PutAccountSuppressionAttributesRequest { export interface PutAccountSuppressionAttributesResponse {} export namespace PutAccountSuppressionAttributesResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: PutAccountSuppressionAttributesResponse): any => ({ ...obj, }); @@ -5210,6 +5771,9 @@ export interface PutConfigurationSetDeliveryOptionsRequest { } export namespace PutConfigurationSetDeliveryOptionsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: PutConfigurationSetDeliveryOptionsRequest): any => ({ ...obj, }); @@ -5222,6 +5786,9 @@ export namespace PutConfigurationSetDeliveryOptionsRequest { export interface PutConfigurationSetDeliveryOptionsResponse {} export namespace PutConfigurationSetDeliveryOptionsResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: PutConfigurationSetDeliveryOptionsResponse): any => ({ ...obj, }); @@ -5247,6 +5814,9 @@ export interface PutConfigurationSetReputationOptionsRequest { } export namespace PutConfigurationSetReputationOptionsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: PutConfigurationSetReputationOptionsRequest): any => ({ ...obj, }); @@ -5259,6 +5829,9 @@ export namespace PutConfigurationSetReputationOptionsRequest { export interface PutConfigurationSetReputationOptionsResponse {} export namespace PutConfigurationSetReputationOptionsResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: PutConfigurationSetReputationOptionsResponse): any => ({ ...obj, }); @@ -5283,6 +5856,9 @@ export interface PutConfigurationSetSendingOptionsRequest { } export namespace PutConfigurationSetSendingOptionsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: PutConfigurationSetSendingOptionsRequest): any => ({ ...obj, }); @@ -5295,6 +5871,9 @@ export namespace PutConfigurationSetSendingOptionsRequest { export interface PutConfigurationSetSendingOptionsResponse {} export namespace PutConfigurationSetSendingOptionsResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: PutConfigurationSetSendingOptionsResponse): any => ({ ...obj, }); @@ -5334,6 +5913,9 @@ export interface PutConfigurationSetSuppressionOptionsRequest { } export namespace PutConfigurationSetSuppressionOptionsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: PutConfigurationSetSuppressionOptionsRequest): any => ({ ...obj, }); @@ -5346,6 +5928,9 @@ export namespace PutConfigurationSetSuppressionOptionsRequest { export interface PutConfigurationSetSuppressionOptionsResponse {} export namespace PutConfigurationSetSuppressionOptionsResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: PutConfigurationSetSuppressionOptionsResponse): any => ({ ...obj, }); @@ -5369,6 +5954,9 @@ export interface PutConfigurationSetTrackingOptionsRequest { } export namespace PutConfigurationSetTrackingOptionsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: PutConfigurationSetTrackingOptionsRequest): any => ({ ...obj, }); @@ -5381,6 +5969,9 @@ export namespace PutConfigurationSetTrackingOptionsRequest { export interface PutConfigurationSetTrackingOptionsResponse {} export namespace PutConfigurationSetTrackingOptionsResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: PutConfigurationSetTrackingOptionsResponse): any => ({ ...obj, }); @@ -5404,6 +5995,9 @@ export interface PutDedicatedIpInPoolRequest { } export namespace PutDedicatedIpInPoolRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: PutDedicatedIpInPoolRequest): any => ({ ...obj, }); @@ -5416,6 +6010,9 @@ export namespace PutDedicatedIpInPoolRequest { export interface PutDedicatedIpInPoolResponse {} export namespace PutDedicatedIpInPoolResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: PutDedicatedIpInPoolResponse): any => ({ ...obj, }); @@ -5439,6 +6036,9 @@ export interface PutDedicatedIpWarmupAttributesRequest { } export namespace PutDedicatedIpWarmupAttributesRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: PutDedicatedIpWarmupAttributesRequest): any => ({ ...obj, }); @@ -5451,6 +6051,9 @@ export namespace PutDedicatedIpWarmupAttributesRequest { export interface PutDedicatedIpWarmupAttributesResponse {} export namespace PutDedicatedIpWarmupAttributesResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: PutDedicatedIpWarmupAttributesResponse): any => ({ ...obj, }); @@ -5479,6 +6082,9 @@ export interface PutDeliverabilityDashboardOptionRequest { } export namespace PutDeliverabilityDashboardOptionRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: PutDeliverabilityDashboardOptionRequest): any => ({ ...obj, }); @@ -5490,6 +6096,9 @@ export namespace PutDeliverabilityDashboardOptionRequest { export interface PutDeliverabilityDashboardOptionResponse {} export namespace PutDeliverabilityDashboardOptionResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: PutDeliverabilityDashboardOptionResponse): any => ({ ...obj, }); @@ -5511,6 +6120,9 @@ export interface PutEmailIdentityConfigurationSetAttributesRequest { } export namespace PutEmailIdentityConfigurationSetAttributesRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: PutEmailIdentityConfigurationSetAttributesRequest): any => ({ ...obj, }); @@ -5522,6 +6134,9 @@ export namespace PutEmailIdentityConfigurationSetAttributesRequest { export interface PutEmailIdentityConfigurationSetAttributesResponse {} export namespace PutEmailIdentityConfigurationSetAttributesResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: PutEmailIdentityConfigurationSetAttributesResponse): any => ({ ...obj, }); @@ -5547,6 +6162,9 @@ export interface PutEmailIdentityDkimAttributesRequest { } export namespace PutEmailIdentityDkimAttributesRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: PutEmailIdentityDkimAttributesRequest): any => ({ ...obj, }); @@ -5559,6 +6177,9 @@ export namespace PutEmailIdentityDkimAttributesRequest { export interface PutEmailIdentityDkimAttributesResponse {} export namespace PutEmailIdentityDkimAttributesResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: PutEmailIdentityDkimAttributesResponse): any => ({ ...obj, }); @@ -5600,6 +6221,9 @@ export interface PutEmailIdentityDkimSigningAttributesRequest { } export namespace PutEmailIdentityDkimSigningAttributesRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: PutEmailIdentityDkimSigningAttributesRequest): any => ({ ...obj, ...(obj.SigningAttributes && { @@ -5671,6 +6295,9 @@ export interface PutEmailIdentityDkimSigningAttributesResponse { } export namespace PutEmailIdentityDkimSigningAttributesResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: PutEmailIdentityDkimSigningAttributesResponse): any => ({ ...obj, }); @@ -5701,6 +6328,9 @@ export interface PutEmailIdentityFeedbackAttributesRequest { } export namespace PutEmailIdentityFeedbackAttributesRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: PutEmailIdentityFeedbackAttributesRequest): any => ({ ...obj, }); @@ -5713,6 +6343,9 @@ export namespace PutEmailIdentityFeedbackAttributesRequest { export interface PutEmailIdentityFeedbackAttributesResponse {} export namespace PutEmailIdentityFeedbackAttributesResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: PutEmailIdentityFeedbackAttributesResponse): any => ({ ...obj, }); @@ -5761,6 +6394,9 @@ export interface PutEmailIdentityMailFromAttributesRequest { } export namespace PutEmailIdentityMailFromAttributesRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: PutEmailIdentityMailFromAttributesRequest): any => ({ ...obj, }); @@ -5773,6 +6409,9 @@ export namespace PutEmailIdentityMailFromAttributesRequest { export interface PutEmailIdentityMailFromAttributesResponse {} export namespace PutEmailIdentityMailFromAttributesResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: PutEmailIdentityMailFromAttributesResponse): any => ({ ...obj, }); @@ -5796,6 +6435,9 @@ export interface PutSuppressedDestinationRequest { } export namespace PutSuppressedDestinationRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: PutSuppressedDestinationRequest): any => ({ ...obj, }); @@ -5808,6 +6450,9 @@ export namespace PutSuppressedDestinationRequest { export interface PutSuppressedDestinationResponse {} export namespace PutSuppressedDestinationResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: PutSuppressedDestinationResponse): any => ({ ...obj, }); @@ -5892,6 +6537,9 @@ export interface SendBulkEmailRequest { } export namespace SendBulkEmailRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: SendBulkEmailRequest): any => ({ ...obj, }); @@ -5908,6 +6556,9 @@ export interface SendBulkEmailResponse { } export namespace SendBulkEmailResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: SendBulkEmailResponse): any => ({ ...obj, }); @@ -5936,6 +6587,9 @@ export interface SendCustomVerificationEmailRequest { } export namespace SendCustomVerificationEmailRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: SendCustomVerificationEmailRequest): any => ({ ...obj, }); @@ -5953,6 +6607,9 @@ export interface SendCustomVerificationEmailResponse { } export namespace SendCustomVerificationEmailResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: SendCustomVerificationEmailResponse): any => ({ ...obj, }); @@ -6047,6 +6704,9 @@ export interface SendEmailRequest { } export namespace SendEmailRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: SendEmailRequest): any => ({ ...obj, }); @@ -6070,6 +6730,9 @@ export interface SendEmailResponse { } export namespace SendEmailResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: SendEmailResponse): any => ({ ...obj, }); @@ -6092,6 +6755,9 @@ export interface TagResourceRequest { } export namespace TagResourceRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: TagResourceRequest): any => ({ ...obj, }); @@ -6100,6 +6766,9 @@ export namespace TagResourceRequest { export interface TagResourceResponse {} export namespace TagResourceResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: TagResourceResponse): any => ({ ...obj, }); @@ -6124,6 +6793,9 @@ export interface TestRenderEmailTemplateRequest { } export namespace TestRenderEmailTemplateRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: TestRenderEmailTemplateRequest): any => ({ ...obj, }); @@ -6142,6 +6814,9 @@ export interface TestRenderEmailTemplateResponse { } export namespace TestRenderEmailTemplateResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: TestRenderEmailTemplateResponse): any => ({ ...obj, }); @@ -6167,6 +6842,9 @@ export interface UntagResourceRequest { } export namespace UntagResourceRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: UntagResourceRequest): any => ({ ...obj, }); @@ -6175,6 +6853,9 @@ export namespace UntagResourceRequest { export interface UntagResourceResponse {} export namespace UntagResourceResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: UntagResourceResponse): any => ({ ...obj, }); @@ -6203,6 +6884,9 @@ export interface UpdateConfigurationSetEventDestinationRequest { } export namespace UpdateConfigurationSetEventDestinationRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateConfigurationSetEventDestinationRequest): any => ({ ...obj, }); @@ -6215,6 +6899,9 @@ export namespace UpdateConfigurationSetEventDestinationRequest { export interface UpdateConfigurationSetEventDestinationResponse {} export namespace UpdateConfigurationSetEventDestinationResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateConfigurationSetEventDestinationResponse): any => ({ ...obj, }); @@ -6249,6 +6936,9 @@ export interface UpdateContactRequest { } export namespace UpdateContactRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateContactRequest): any => ({ ...obj, }); @@ -6257,6 +6947,9 @@ export namespace UpdateContactRequest { export interface UpdateContactResponse {} export namespace UpdateContactResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateContactResponse): any => ({ ...obj, }); @@ -6281,6 +6974,9 @@ export interface UpdateContactListRequest { } export namespace UpdateContactListRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateContactListRequest): any => ({ ...obj, }); @@ -6289,6 +6985,9 @@ export namespace UpdateContactListRequest { export interface UpdateContactListResponse {} export namespace UpdateContactListResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateContactListResponse): any => ({ ...obj, }); @@ -6335,6 +7034,9 @@ export interface UpdateCustomVerificationEmailTemplateRequest { } export namespace UpdateCustomVerificationEmailTemplateRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateCustomVerificationEmailTemplateRequest): any => ({ ...obj, }); @@ -6347,6 +7049,9 @@ export namespace UpdateCustomVerificationEmailTemplateRequest { export interface UpdateCustomVerificationEmailTemplateResponse {} export namespace UpdateCustomVerificationEmailTemplateResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateCustomVerificationEmailTemplateResponse): any => ({ ...obj, }); @@ -6380,6 +7085,9 @@ export interface UpdateEmailIdentityPolicyRequest { } export namespace UpdateEmailIdentityPolicyRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateEmailIdentityPolicyRequest): any => ({ ...obj, }); @@ -6392,6 +7100,9 @@ export namespace UpdateEmailIdentityPolicyRequest { export interface UpdateEmailIdentityPolicyResponse {} export namespace UpdateEmailIdentityPolicyResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateEmailIdentityPolicyResponse): any => ({ ...obj, }); @@ -6415,6 +7126,9 @@ export interface UpdateEmailTemplateRequest { } export namespace UpdateEmailTemplateRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateEmailTemplateRequest): any => ({ ...obj, }); @@ -6427,6 +7141,9 @@ export namespace UpdateEmailTemplateRequest { export interface UpdateEmailTemplateResponse {} export namespace UpdateEmailTemplateResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateEmailTemplateResponse): any => ({ ...obj, }); diff --git a/clients/client-sfn/commands/CreateActivityCommand.ts b/clients/client-sfn/commands/CreateActivityCommand.ts index 508f3f2a9e70..a1c04c940752 100644 --- a/clients/client-sfn/commands/CreateActivityCommand.ts +++ b/clients/client-sfn/commands/CreateActivityCommand.ts @@ -38,6 +38,20 @@ export interface CreateActivityCommandOutput extends CreateActivityOutput, __Met * idempotent request of the previous. In this case, tags will not be updated, * even if they are different.

* + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { SFNClient, CreateActivityCommand } from "@aws-sdk/client-sfn"; // ES Modules import + * // const { SFNClient, CreateActivityCommand } = require("@aws-sdk/client-sfn"); // CommonJS import + * const client = new SFNClient(config); + * const command = new CreateActivityCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreateActivityCommandInput} for command's `input` shape. + * @see {@link CreateActivityCommandOutput} for command's `response` shape. + * @see {@link SFNClientResolvedConfig | config} for command's `input` shape. + * */ export class CreateActivityCommand extends $Command< CreateActivityCommandInput, diff --git a/clients/client-sfn/commands/CreateStateMachineCommand.ts b/clients/client-sfn/commands/CreateStateMachineCommand.ts index 4d4b6653c1d2..332d65afcd41 100644 --- a/clients/client-sfn/commands/CreateStateMachineCommand.ts +++ b/clients/client-sfn/commands/CreateStateMachineCommand.ts @@ -40,6 +40,20 @@ export interface CreateStateMachineCommandOutput extends CreateStateMachineOutpu * treat it as an idempotent request of the previous. In this case, roleArn and * tags will not be updated, even if they are different.

* + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { SFNClient, CreateStateMachineCommand } from "@aws-sdk/client-sfn"; // ES Modules import + * // const { SFNClient, CreateStateMachineCommand } = require("@aws-sdk/client-sfn"); // CommonJS import + * const client = new SFNClient(config); + * const command = new CreateStateMachineCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreateStateMachineCommandInput} for command's `input` shape. + * @see {@link CreateStateMachineCommandOutput} for command's `response` shape. + * @see {@link SFNClientResolvedConfig | config} for command's `input` shape. + * */ export class CreateStateMachineCommand extends $Command< CreateStateMachineCommandInput, diff --git a/clients/client-sfn/commands/DeleteActivityCommand.ts b/clients/client-sfn/commands/DeleteActivityCommand.ts index 54cacf7c2887..69e1d8eae04a 100644 --- a/clients/client-sfn/commands/DeleteActivityCommand.ts +++ b/clients/client-sfn/commands/DeleteActivityCommand.ts @@ -22,6 +22,20 @@ export interface DeleteActivityCommandOutput extends DeleteActivityOutput, __Met /** *

Deletes an activity.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { SFNClient, DeleteActivityCommand } from "@aws-sdk/client-sfn"; // ES Modules import + * // const { SFNClient, DeleteActivityCommand } = require("@aws-sdk/client-sfn"); // CommonJS import + * const client = new SFNClient(config); + * const command = new DeleteActivityCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteActivityCommandInput} for command's `input` shape. + * @see {@link DeleteActivityCommandOutput} for command's `response` shape. + * @see {@link SFNClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteActivityCommand extends $Command< DeleteActivityCommandInput, diff --git a/clients/client-sfn/commands/DeleteStateMachineCommand.ts b/clients/client-sfn/commands/DeleteStateMachineCommand.ts index 1f04559ea2a2..8b55388d3035 100644 --- a/clients/client-sfn/commands/DeleteStateMachineCommand.ts +++ b/clients/client-sfn/commands/DeleteStateMachineCommand.ts @@ -28,6 +28,20 @@ export interface DeleteStateMachineCommandOutput extends DeleteStateMachineOutpu * less than a minute). Running executions may emit logs after DeleteStateMachine * API is called.

* + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { SFNClient, DeleteStateMachineCommand } from "@aws-sdk/client-sfn"; // ES Modules import + * // const { SFNClient, DeleteStateMachineCommand } = require("@aws-sdk/client-sfn"); // CommonJS import + * const client = new SFNClient(config); + * const command = new DeleteStateMachineCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteStateMachineCommandInput} for command's `input` shape. + * @see {@link DeleteStateMachineCommandOutput} for command's `response` shape. + * @see {@link SFNClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteStateMachineCommand extends $Command< DeleteStateMachineCommandInput, diff --git a/clients/client-sfn/commands/DescribeActivityCommand.ts b/clients/client-sfn/commands/DescribeActivityCommand.ts index b0508ceff50e..12e7c905ee8e 100644 --- a/clients/client-sfn/commands/DescribeActivityCommand.ts +++ b/clients/client-sfn/commands/DescribeActivityCommand.ts @@ -25,6 +25,20 @@ export interface DescribeActivityCommandOutput extends DescribeActivityOutput, _ * *

This operation is eventually consistent. The results are best effort and may not reflect very recent updates and changes.

* + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { SFNClient, DescribeActivityCommand } from "@aws-sdk/client-sfn"; // ES Modules import + * // const { SFNClient, DescribeActivityCommand } = require("@aws-sdk/client-sfn"); // CommonJS import + * const client = new SFNClient(config); + * const command = new DescribeActivityCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeActivityCommandInput} for command's `input` shape. + * @see {@link DescribeActivityCommandOutput} for command's `response` shape. + * @see {@link SFNClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeActivityCommand extends $Command< DescribeActivityCommandInput, diff --git a/clients/client-sfn/commands/DescribeExecutionCommand.ts b/clients/client-sfn/commands/DescribeExecutionCommand.ts index 607e6b6d8633..3e3d6b7f7e18 100644 --- a/clients/client-sfn/commands/DescribeExecutionCommand.ts +++ b/clients/client-sfn/commands/DescribeExecutionCommand.ts @@ -26,6 +26,20 @@ export interface DescribeExecutionCommandOutput extends DescribeExecutionOutput, *

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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { SFNClient, DescribeExecutionCommand } from "@aws-sdk/client-sfn"; // ES Modules import + * // const { SFNClient, DescribeExecutionCommand } = require("@aws-sdk/client-sfn"); // CommonJS import + * const client = new SFNClient(config); + * const command = new DescribeExecutionCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeExecutionCommandInput} for command's `input` shape. + * @see {@link DescribeExecutionCommandOutput} for command's `response` shape. + * @see {@link SFNClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeExecutionCommand extends $Command< DescribeExecutionCommandInput, diff --git a/clients/client-sfn/commands/DescribeStateMachineCommand.ts b/clients/client-sfn/commands/DescribeStateMachineCommand.ts index 5b9ea541b020..e12579fc2c7f 100644 --- a/clients/client-sfn/commands/DescribeStateMachineCommand.ts +++ b/clients/client-sfn/commands/DescribeStateMachineCommand.ts @@ -25,6 +25,20 @@ export interface DescribeStateMachineCommandOutput extends DescribeStateMachineO * *

This operation is eventually consistent. The results are best effort and may not reflect very recent updates and changes.

* + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { SFNClient, DescribeStateMachineCommand } from "@aws-sdk/client-sfn"; // ES Modules import + * // const { SFNClient, DescribeStateMachineCommand } = require("@aws-sdk/client-sfn"); // CommonJS import + * const client = new SFNClient(config); + * const command = new DescribeStateMachineCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeStateMachineCommandInput} for command's `input` shape. + * @see {@link DescribeStateMachineCommandOutput} for command's `response` shape. + * @see {@link SFNClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeStateMachineCommand extends $Command< DescribeStateMachineCommandInput, diff --git a/clients/client-sfn/commands/DescribeStateMachineForExecutionCommand.ts b/clients/client-sfn/commands/DescribeStateMachineForExecutionCommand.ts index c50868b556c5..e6ad5a51b10c 100644 --- a/clients/client-sfn/commands/DescribeStateMachineForExecutionCommand.ts +++ b/clients/client-sfn/commands/DescribeStateMachineForExecutionCommand.ts @@ -28,6 +28,20 @@ export interface DescribeStateMachineForExecutionCommandOutput *

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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { SFNClient, DescribeStateMachineForExecutionCommand } from "@aws-sdk/client-sfn"; // ES Modules import + * // const { SFNClient, DescribeStateMachineForExecutionCommand } = require("@aws-sdk/client-sfn"); // CommonJS import + * const client = new SFNClient(config); + * const command = new DescribeStateMachineForExecutionCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeStateMachineForExecutionCommandInput} for command's `input` shape. + * @see {@link DescribeStateMachineForExecutionCommandOutput} for command's `response` shape. + * @see {@link SFNClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeStateMachineForExecutionCommand extends $Command< DescribeStateMachineForExecutionCommandInput, diff --git a/clients/client-sfn/commands/GetActivityTaskCommand.ts b/clients/client-sfn/commands/GetActivityTaskCommand.ts index 2f2aea38716c..89338ef068b2 100644 --- a/clients/client-sfn/commands/GetActivityTaskCommand.ts +++ b/clients/client-sfn/commands/GetActivityTaskCommand.ts @@ -34,6 +34,20 @@ export interface GetActivityTaskCommandOutput extends GetActivityTaskOutput, __M * Avoid * Latency When Polling for Activity Tasks in the Step Functions Developer Guide.

* + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { SFNClient, GetActivityTaskCommand } from "@aws-sdk/client-sfn"; // ES Modules import + * // const { SFNClient, GetActivityTaskCommand } = require("@aws-sdk/client-sfn"); // CommonJS import + * const client = new SFNClient(config); + * const command = new GetActivityTaskCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetActivityTaskCommandInput} for command's `input` shape. + * @see {@link GetActivityTaskCommandOutput} for command's `response` shape. + * @see {@link SFNClientResolvedConfig | config} for command's `input` shape. + * */ export class GetActivityTaskCommand extends $Command< GetActivityTaskCommandInput, diff --git a/clients/client-sfn/commands/GetExecutionHistoryCommand.ts b/clients/client-sfn/commands/GetExecutionHistoryCommand.ts index 4727dd1fee5c..82d7903cdaf5 100644 --- a/clients/client-sfn/commands/GetExecutionHistoryCommand.ts +++ b/clients/client-sfn/commands/GetExecutionHistoryCommand.ts @@ -27,6 +27,20 @@ export interface GetExecutionHistoryCommandOutput extends GetExecutionHistoryOut *

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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { SFNClient, GetExecutionHistoryCommand } from "@aws-sdk/client-sfn"; // ES Modules import + * // const { SFNClient, GetExecutionHistoryCommand } = require("@aws-sdk/client-sfn"); // CommonJS import + * const client = new SFNClient(config); + * const command = new GetExecutionHistoryCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetExecutionHistoryCommandInput} for command's `input` shape. + * @see {@link GetExecutionHistoryCommandOutput} for command's `response` shape. + * @see {@link SFNClientResolvedConfig | config} for command's `input` shape. + * */ export class GetExecutionHistoryCommand extends $Command< GetExecutionHistoryCommandInput, diff --git a/clients/client-sfn/commands/ListActivitiesCommand.ts b/clients/client-sfn/commands/ListActivitiesCommand.ts index f837688ed480..8d357f932632 100644 --- a/clients/client-sfn/commands/ListActivitiesCommand.ts +++ b/clients/client-sfn/commands/ListActivitiesCommand.ts @@ -27,6 +27,20 @@ export interface ListActivitiesCommandOutput extends ListActivitiesOutput, __Met * *

This operation is eventually consistent. The results are best effort and may not reflect very recent updates and changes.

* + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { SFNClient, ListActivitiesCommand } from "@aws-sdk/client-sfn"; // ES Modules import + * // const { SFNClient, ListActivitiesCommand } = require("@aws-sdk/client-sfn"); // CommonJS import + * const client = new SFNClient(config); + * const command = new ListActivitiesCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListActivitiesCommandInput} for command's `input` shape. + * @see {@link ListActivitiesCommandOutput} for command's `response` shape. + * @see {@link SFNClientResolvedConfig | config} for command's `input` shape. + * */ export class ListActivitiesCommand extends $Command< ListActivitiesCommandInput, diff --git a/clients/client-sfn/commands/ListExecutionsCommand.ts b/clients/client-sfn/commands/ListExecutionsCommand.ts index 121c65df83b4..12a4f3276ecc 100644 --- a/clients/client-sfn/commands/ListExecutionsCommand.ts +++ b/clients/client-sfn/commands/ListExecutionsCommand.ts @@ -29,6 +29,20 @@ export interface ListExecutionsCommandOutput extends ListExecutionsOutput, __Met *

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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { SFNClient, ListExecutionsCommand } from "@aws-sdk/client-sfn"; // ES Modules import + * // const { SFNClient, ListExecutionsCommand } = require("@aws-sdk/client-sfn"); // CommonJS import + * const client = new SFNClient(config); + * const command = new ListExecutionsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListExecutionsCommandInput} for command's `input` shape. + * @see {@link ListExecutionsCommandOutput} for command's `response` shape. + * @see {@link SFNClientResolvedConfig | config} for command's `input` shape. + * */ export class ListExecutionsCommand extends $Command< ListExecutionsCommandInput, diff --git a/clients/client-sfn/commands/ListStateMachinesCommand.ts b/clients/client-sfn/commands/ListStateMachinesCommand.ts index 949786747c7f..f84150ccfbd1 100644 --- a/clients/client-sfn/commands/ListStateMachinesCommand.ts +++ b/clients/client-sfn/commands/ListStateMachinesCommand.ts @@ -27,6 +27,20 @@ export interface ListStateMachinesCommandOutput extends ListStateMachinesOutput, * *

This operation is eventually consistent. The results are best effort and may not reflect very recent updates and changes.

* + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { SFNClient, ListStateMachinesCommand } from "@aws-sdk/client-sfn"; // ES Modules import + * // const { SFNClient, ListStateMachinesCommand } = require("@aws-sdk/client-sfn"); // CommonJS import + * const client = new SFNClient(config); + * const command = new ListStateMachinesCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListStateMachinesCommandInput} for command's `input` shape. + * @see {@link ListStateMachinesCommandOutput} for command's `response` shape. + * @see {@link SFNClientResolvedConfig | config} for command's `input` shape. + * */ export class ListStateMachinesCommand extends $Command< ListStateMachinesCommandInput, diff --git a/clients/client-sfn/commands/ListTagsForResourceCommand.ts b/clients/client-sfn/commands/ListTagsForResourceCommand.ts index 837232512a36..0e38e1eea85f 100644 --- a/clients/client-sfn/commands/ListTagsForResourceCommand.ts +++ b/clients/client-sfn/commands/ListTagsForResourceCommand.ts @@ -23,6 +23,20 @@ export interface ListTagsForResourceCommandOutput extends ListTagsForResourceOut /** *

List tags for a given resource.

*

Tags may only contain Unicode letters, digits, white space, or these symbols: _ . : / = + - @.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { SFNClient, ListTagsForResourceCommand } from "@aws-sdk/client-sfn"; // ES Modules import + * // const { SFNClient, ListTagsForResourceCommand } = require("@aws-sdk/client-sfn"); // CommonJS import + * const client = new SFNClient(config); + * const command = new ListTagsForResourceCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListTagsForResourceCommandInput} for command's `input` shape. + * @see {@link ListTagsForResourceCommandOutput} for command's `response` shape. + * @see {@link SFNClientResolvedConfig | config} for command's `input` shape. + * */ export class ListTagsForResourceCommand extends $Command< ListTagsForResourceCommandInput, diff --git a/clients/client-sfn/commands/SendTaskFailureCommand.ts b/clients/client-sfn/commands/SendTaskFailureCommand.ts index 2d51e05ee19e..2ef7a7b1114c 100644 --- a/clients/client-sfn/commands/SendTaskFailureCommand.ts +++ b/clients/client-sfn/commands/SendTaskFailureCommand.ts @@ -23,6 +23,20 @@ export interface SendTaskFailureCommandOutput extends SendTaskFailureOutput, __M /** *

Used by activity workers and task states using the callback * pattern to report that the task identified by the taskToken failed.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { SFNClient, SendTaskFailureCommand } from "@aws-sdk/client-sfn"; // ES Modules import + * // const { SFNClient, SendTaskFailureCommand } = require("@aws-sdk/client-sfn"); // CommonJS import + * const client = new SFNClient(config); + * const command = new SendTaskFailureCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link SendTaskFailureCommandInput} for command's `input` shape. + * @see {@link SendTaskFailureCommandOutput} for command's `response` shape. + * @see {@link SFNClientResolvedConfig | config} for command's `input` shape. + * */ export class SendTaskFailureCommand extends $Command< SendTaskFailureCommandInput, diff --git a/clients/client-sfn/commands/SendTaskHeartbeatCommand.ts b/clients/client-sfn/commands/SendTaskHeartbeatCommand.ts index 5d5e7059fa69..32de0d0f3785 100644 --- a/clients/client-sfn/commands/SendTaskHeartbeatCommand.ts +++ b/clients/client-sfn/commands/SendTaskHeartbeatCommand.ts @@ -36,6 +36,20 @@ export interface SendTaskHeartbeatCommandOutput extends SendTaskHeartbeatOutput, * its maximum allowed duration, regardless of the number of SendTaskHeartbeat requests received. Use HeartbeatSeconds to configure the timeout interval * for heartbeats.

* + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { SFNClient, SendTaskHeartbeatCommand } from "@aws-sdk/client-sfn"; // ES Modules import + * // const { SFNClient, SendTaskHeartbeatCommand } = require("@aws-sdk/client-sfn"); // CommonJS import + * const client = new SFNClient(config); + * const command = new SendTaskHeartbeatCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link SendTaskHeartbeatCommandInput} for command's `input` shape. + * @see {@link SendTaskHeartbeatCommandOutput} for command's `response` shape. + * @see {@link SFNClientResolvedConfig | config} for command's `input` shape. + * */ export class SendTaskHeartbeatCommand extends $Command< SendTaskHeartbeatCommandInput, diff --git a/clients/client-sfn/commands/SendTaskSuccessCommand.ts b/clients/client-sfn/commands/SendTaskSuccessCommand.ts index 5aaf1375c3ed..cfb0895c1acf 100644 --- a/clients/client-sfn/commands/SendTaskSuccessCommand.ts +++ b/clients/client-sfn/commands/SendTaskSuccessCommand.ts @@ -24,6 +24,20 @@ export interface SendTaskSuccessCommandOutput extends SendTaskSuccessOutput, __M *

Used by activity workers and task states using the callback * pattern to report that the task identified by the taskToken completed * successfully.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { SFNClient, SendTaskSuccessCommand } from "@aws-sdk/client-sfn"; // ES Modules import + * // const { SFNClient, SendTaskSuccessCommand } = require("@aws-sdk/client-sfn"); // CommonJS import + * const client = new SFNClient(config); + * const command = new SendTaskSuccessCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link SendTaskSuccessCommandInput} for command's `input` shape. + * @see {@link SendTaskSuccessCommandOutput} for command's `response` shape. + * @see {@link SFNClientResolvedConfig | config} for command's `input` shape. + * */ export class SendTaskSuccessCommand extends $Command< SendTaskSuccessCommandInput, diff --git a/clients/client-sfn/commands/StartExecutionCommand.ts b/clients/client-sfn/commands/StartExecutionCommand.ts index 35b09e1a4925..fd5bbe8fb314 100644 --- a/clients/client-sfn/commands/StartExecutionCommand.ts +++ b/clients/client-sfn/commands/StartExecutionCommand.ts @@ -30,6 +30,20 @@ export interface StartExecutionCommandOutput extends StartExecutionOutput, __Met * it will return a 400 ExecutionAlreadyExists error. Names can be reused after 90 * days.

* + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { SFNClient, StartExecutionCommand } from "@aws-sdk/client-sfn"; // ES Modules import + * // const { SFNClient, StartExecutionCommand } = require("@aws-sdk/client-sfn"); // CommonJS import + * const client = new SFNClient(config); + * const command = new StartExecutionCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link StartExecutionCommandInput} for command's `input` shape. + * @see {@link StartExecutionCommandOutput} for command's `response` shape. + * @see {@link SFNClientResolvedConfig | config} for command's `input` shape. + * */ export class StartExecutionCommand extends $Command< StartExecutionCommandInput, diff --git a/clients/client-sfn/commands/StartSyncExecutionCommand.ts b/clients/client-sfn/commands/StartSyncExecutionCommand.ts index 9d02bc62913f..1211c8459cfc 100644 --- a/clients/client-sfn/commands/StartSyncExecutionCommand.ts +++ b/clients/client-sfn/commands/StartSyncExecutionCommand.ts @@ -22,6 +22,20 @@ export interface StartSyncExecutionCommandOutput extends StartSyncExecutionOutpu /** *

Starts a Synchronous Express state machine execution.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { SFNClient, StartSyncExecutionCommand } from "@aws-sdk/client-sfn"; // ES Modules import + * // const { SFNClient, StartSyncExecutionCommand } = require("@aws-sdk/client-sfn"); // CommonJS import + * const client = new SFNClient(config); + * const command = new StartSyncExecutionCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link StartSyncExecutionCommandInput} for command's `input` shape. + * @see {@link StartSyncExecutionCommandOutput} for command's `response` shape. + * @see {@link SFNClientResolvedConfig | config} for command's `input` shape. + * */ export class StartSyncExecutionCommand extends $Command< StartSyncExecutionCommandInput, diff --git a/clients/client-sfn/commands/StopExecutionCommand.ts b/clients/client-sfn/commands/StopExecutionCommand.ts index 450d5d1e4f19..7af2ce133b14 100644 --- a/clients/client-sfn/commands/StopExecutionCommand.ts +++ b/clients/client-sfn/commands/StopExecutionCommand.ts @@ -23,6 +23,20 @@ export interface StopExecutionCommandOutput extends StopExecutionOutput, __Metad /** *

Stops an execution.

*

This API action is not supported by EXPRESS state machines.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { SFNClient, StopExecutionCommand } from "@aws-sdk/client-sfn"; // ES Modules import + * // const { SFNClient, StopExecutionCommand } = require("@aws-sdk/client-sfn"); // CommonJS import + * const client = new SFNClient(config); + * const command = new StopExecutionCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link StopExecutionCommandInput} for command's `input` shape. + * @see {@link StopExecutionCommandOutput} for command's `response` shape. + * @see {@link SFNClientResolvedConfig | config} for command's `input` shape. + * */ export class StopExecutionCommand extends $Command< StopExecutionCommandInput, diff --git a/clients/client-sfn/commands/TagResourceCommand.ts b/clients/client-sfn/commands/TagResourceCommand.ts index 1c68893bb172..869cf15f1856 100644 --- a/clients/client-sfn/commands/TagResourceCommand.ts +++ b/clients/client-sfn/commands/TagResourceCommand.ts @@ -27,6 +27,20 @@ export interface TagResourceCommandOutput extends TagResourceOutput, __MetadataB * Guide, and Controlling Access Using IAM * Tags.

*

Tags may only contain Unicode letters, digits, white space, or these symbols: _ . : / = + - @.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { SFNClient, TagResourceCommand } from "@aws-sdk/client-sfn"; // ES Modules import + * // const { SFNClient, TagResourceCommand } = require("@aws-sdk/client-sfn"); // CommonJS import + * const client = new SFNClient(config); + * const command = new TagResourceCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link TagResourceCommandInput} for command's `input` shape. + * @see {@link TagResourceCommandOutput} for command's `response` shape. + * @see {@link SFNClientResolvedConfig | config} for command's `input` shape. + * */ export class TagResourceCommand extends $Command< TagResourceCommandInput, diff --git a/clients/client-sfn/commands/UntagResourceCommand.ts b/clients/client-sfn/commands/UntagResourceCommand.ts index 1c648459f7b2..c5de6c4eb579 100644 --- a/clients/client-sfn/commands/UntagResourceCommand.ts +++ b/clients/client-sfn/commands/UntagResourceCommand.ts @@ -22,6 +22,20 @@ export interface UntagResourceCommandOutput extends UntagResourceOutput, __Metad /** *

Remove a tag from a Step Functions resource

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { SFNClient, UntagResourceCommand } from "@aws-sdk/client-sfn"; // ES Modules import + * // const { SFNClient, UntagResourceCommand } = require("@aws-sdk/client-sfn"); // CommonJS import + * const client = new SFNClient(config); + * const command = new UntagResourceCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link UntagResourceCommandInput} for command's `input` shape. + * @see {@link UntagResourceCommandOutput} for command's `response` shape. + * @see {@link SFNClientResolvedConfig | config} for command's `input` shape. + * */ export class UntagResourceCommand extends $Command< UntagResourceCommandInput, diff --git a/clients/client-sfn/commands/UpdateStateMachineCommand.ts b/clients/client-sfn/commands/UpdateStateMachineCommand.ts index 0f452a17c113..f5c5111da93b 100644 --- a/clients/client-sfn/commands/UpdateStateMachineCommand.ts +++ b/clients/client-sfn/commands/UpdateStateMachineCommand.ts @@ -32,6 +32,20 @@ export interface UpdateStateMachineCommandOutput extends UpdateStateMachineOutpu * calling UpdateStateMachine may use the previous state machine * definition and roleArn.

* + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { SFNClient, UpdateStateMachineCommand } from "@aws-sdk/client-sfn"; // ES Modules import + * // const { SFNClient, UpdateStateMachineCommand } = require("@aws-sdk/client-sfn"); // CommonJS import + * const client = new SFNClient(config); + * const command = new UpdateStateMachineCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link UpdateStateMachineCommandInput} for command's `input` shape. + * @see {@link UpdateStateMachineCommandOutput} for command's `response` shape. + * @see {@link SFNClientResolvedConfig | config} for command's `input` shape. + * */ export class UpdateStateMachineCommand extends $Command< UpdateStateMachineCommandInput, diff --git a/clients/client-sfn/models/models_0.ts b/clients/client-sfn/models/models_0.ts index 4f4ab196c276..f2bdffc8804a 100644 --- a/clients/client-sfn/models/models_0.ts +++ b/clients/client-sfn/models/models_0.ts @@ -11,6 +11,9 @@ export interface ActivityDoesNotExist extends __SmithyException, $MetadataBearer } export namespace ActivityDoesNotExist { + /** + * @internal + */ export const filterSensitiveLog = (obj: ActivityDoesNotExist): any => ({ ...obj, }); @@ -32,6 +35,9 @@ export interface ActivityFailedEventDetails { } export namespace ActivityFailedEventDetails { + /** + * @internal + */ export const filterSensitiveLog = (obj: ActivityFailedEventDetails): any => ({ ...obj, ...(obj.error && { error: SENSITIVE_STRING }), @@ -50,6 +56,9 @@ export interface ActivityLimitExceeded extends __SmithyException, $MetadataBeare } export namespace ActivityLimitExceeded { + /** + * @internal + */ export const filterSensitiveLog = (obj: ActivityLimitExceeded): any => ({ ...obj, }); @@ -98,6 +107,9 @@ export interface ActivityListItem { } export namespace ActivityListItem { + /** + * @internal + */ export const filterSensitiveLog = (obj: ActivityListItem): any => ({ ...obj, }); @@ -115,6 +127,9 @@ export interface HistoryEventExecutionDataDetails { } export namespace HistoryEventExecutionDataDetails { + /** + * @internal + */ export const filterSensitiveLog = (obj: HistoryEventExecutionDataDetails): any => ({ ...obj, }); @@ -151,6 +166,9 @@ export interface ActivityScheduledEventDetails { } export namespace ActivityScheduledEventDetails { + /** + * @internal + */ export const filterSensitiveLog = (obj: ActivityScheduledEventDetails): any => ({ ...obj, ...(obj.input && { input: SENSITIVE_STRING }), @@ -174,6 +192,9 @@ export interface ActivityScheduleFailedEventDetails { } export namespace ActivityScheduleFailedEventDetails { + /** + * @internal + */ export const filterSensitiveLog = (obj: ActivityScheduleFailedEventDetails): any => ({ ...obj, ...(obj.error && { error: SENSITIVE_STRING }), @@ -193,6 +214,9 @@ export interface ActivityStartedEventDetails { } export namespace ActivityStartedEventDetails { + /** + * @internal + */ export const filterSensitiveLog = (obj: ActivityStartedEventDetails): any => ({ ...obj, }); @@ -215,6 +239,9 @@ export interface ActivitySucceededEventDetails { } export namespace ActivitySucceededEventDetails { + /** + * @internal + */ export const filterSensitiveLog = (obj: ActivitySucceededEventDetails): any => ({ ...obj, ...(obj.output && { output: SENSITIVE_STRING }), @@ -237,6 +264,9 @@ export interface ActivityTimedOutEventDetails { } export namespace ActivityTimedOutEventDetails { + /** + * @internal + */ export const filterSensitiveLog = (obj: ActivityTimedOutEventDetails): any => ({ ...obj, ...(obj.error && { error: SENSITIVE_STRING }), @@ -255,6 +285,9 @@ export interface ActivityWorkerLimitExceeded extends __SmithyException, $Metadat } export namespace ActivityWorkerLimitExceeded { + /** + * @internal + */ export const filterSensitiveLog = (obj: ActivityWorkerLimitExceeded): any => ({ ...obj, }); @@ -282,6 +315,9 @@ export interface Tag { } export namespace Tag { + /** + * @internal + */ export const filterSensitiveLog = (obj: Tag): any => ({ ...obj, }); @@ -329,6 +365,9 @@ export interface CreateActivityInput { } export namespace CreateActivityInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateActivityInput): any => ({ ...obj, }); @@ -347,6 +386,9 @@ export interface CreateActivityOutput { } export namespace CreateActivityOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateActivityOutput): any => ({ ...obj, }); @@ -362,6 +404,9 @@ export interface InvalidName extends __SmithyException, $MetadataBearer { } export namespace InvalidName { + /** + * @internal + */ export const filterSensitiveLog = (obj: InvalidName): any => ({ ...obj, }); @@ -379,6 +424,9 @@ export interface TooManyTags extends __SmithyException, $MetadataBearer { } export namespace TooManyTags { + /** + * @internal + */ export const filterSensitiveLog = (obj: TooManyTags): any => ({ ...obj, }); @@ -397,6 +445,9 @@ export interface CloudWatchLogsLogGroup { } export namespace CloudWatchLogsLogGroup { + /** + * @internal + */ export const filterSensitiveLog = (obj: CloudWatchLogsLogGroup): any => ({ ...obj, }); @@ -413,6 +464,9 @@ export interface LogDestination { } export namespace LogDestination { + /** + * @internal + */ export const filterSensitiveLog = (obj: LogDestination): any => ({ ...obj, }); @@ -444,6 +498,9 @@ export interface LoggingConfiguration { } export namespace LoggingConfiguration { + /** + * @internal + */ export const filterSensitiveLog = (obj: LoggingConfiguration): any => ({ ...obj, }); @@ -461,6 +518,9 @@ export interface TracingConfiguration { } export namespace TracingConfiguration { + /** + * @internal + */ export const filterSensitiveLog = (obj: TracingConfiguration): any => ({ ...obj, }); @@ -540,6 +600,9 @@ export interface CreateStateMachineInput { } export namespace CreateStateMachineInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateStateMachineInput): any => ({ ...obj, ...(obj.definition && { definition: SENSITIVE_STRING }), @@ -559,6 +622,9 @@ export interface CreateStateMachineOutput { } export namespace CreateStateMachineOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateStateMachineOutput): any => ({ ...obj, }); @@ -574,6 +640,9 @@ export interface InvalidArn extends __SmithyException, $MetadataBearer { } export namespace InvalidArn { + /** + * @internal + */ export const filterSensitiveLog = (obj: InvalidArn): any => ({ ...obj, }); @@ -589,6 +658,9 @@ export interface InvalidDefinition extends __SmithyException, $MetadataBearer { } export namespace InvalidDefinition { + /** + * @internal + */ export const filterSensitiveLog = (obj: InvalidDefinition): any => ({ ...obj, }); @@ -604,6 +676,9 @@ export interface InvalidLoggingConfiguration extends __SmithyException, $Metadat } export namespace InvalidLoggingConfiguration { + /** + * @internal + */ export const filterSensitiveLog = (obj: InvalidLoggingConfiguration): any => ({ ...obj, }); @@ -619,6 +694,9 @@ export interface InvalidTracingConfiguration extends __SmithyException, $Metadat } export namespace InvalidTracingConfiguration { + /** + * @internal + */ export const filterSensitiveLog = (obj: InvalidTracingConfiguration): any => ({ ...obj, }); @@ -635,6 +713,9 @@ export interface StateMachineAlreadyExists extends __SmithyException, $MetadataB } export namespace StateMachineAlreadyExists { + /** + * @internal + */ export const filterSensitiveLog = (obj: StateMachineAlreadyExists): any => ({ ...obj, }); @@ -650,6 +731,9 @@ export interface StateMachineDeleting extends __SmithyException, $MetadataBearer } export namespace StateMachineDeleting { + /** + * @internal + */ export const filterSensitiveLog = (obj: StateMachineDeleting): any => ({ ...obj, }); @@ -666,6 +750,9 @@ export interface StateMachineLimitExceeded extends __SmithyException, $MetadataB } export namespace StateMachineLimitExceeded { + /** + * @internal + */ export const filterSensitiveLog = (obj: StateMachineLimitExceeded): any => ({ ...obj, }); @@ -681,6 +768,9 @@ export interface StateMachineTypeNotSupported extends __SmithyException, $Metada } export namespace StateMachineTypeNotSupported { + /** + * @internal + */ export const filterSensitiveLog = (obj: StateMachineTypeNotSupported): any => ({ ...obj, }); @@ -694,6 +784,9 @@ export interface DeleteActivityInput { } export namespace DeleteActivityInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteActivityInput): any => ({ ...obj, }); @@ -702,6 +795,9 @@ export namespace DeleteActivityInput { export interface DeleteActivityOutput {} export namespace DeleteActivityOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteActivityOutput): any => ({ ...obj, }); @@ -715,6 +811,9 @@ export interface DeleteStateMachineInput { } export namespace DeleteStateMachineInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteStateMachineInput): any => ({ ...obj, }); @@ -723,6 +822,9 @@ export namespace DeleteStateMachineInput { export interface DeleteStateMachineOutput {} export namespace DeleteStateMachineOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteStateMachineOutput): any => ({ ...obj, }); @@ -736,6 +838,9 @@ export interface DescribeActivityInput { } export namespace DescribeActivityInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeActivityInput): any => ({ ...obj, }); @@ -781,6 +886,9 @@ export interface DescribeActivityOutput { } export namespace DescribeActivityOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeActivityOutput): any => ({ ...obj, }); @@ -794,6 +902,9 @@ export interface DescribeExecutionInput { } export namespace DescribeExecutionInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeExecutionInput): any => ({ ...obj, }); @@ -811,6 +922,9 @@ export interface CloudWatchEventsExecutionDataDetails { } export namespace CloudWatchEventsExecutionDataDetails { + /** + * @internal + */ export const filterSensitiveLog = (obj: CloudWatchEventsExecutionDataDetails): any => ({ ...obj, }); @@ -902,6 +1016,9 @@ export interface DescribeExecutionOutput { } export namespace DescribeExecutionOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeExecutionOutput): any => ({ ...obj, ...(obj.input && { input: SENSITIVE_STRING }), @@ -919,6 +1036,9 @@ export interface ExecutionDoesNotExist extends __SmithyException, $MetadataBeare } export namespace ExecutionDoesNotExist { + /** + * @internal + */ export const filterSensitiveLog = (obj: ExecutionDoesNotExist): any => ({ ...obj, }); @@ -932,6 +1052,9 @@ export interface DescribeStateMachineInput { } export namespace DescribeStateMachineInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeStateMachineInput): any => ({ ...obj, }); @@ -1012,6 +1135,9 @@ export interface DescribeStateMachineOutput { } export namespace DescribeStateMachineOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeStateMachineOutput): any => ({ ...obj, ...(obj.definition && { definition: SENSITIVE_STRING }), @@ -1028,6 +1154,9 @@ export interface StateMachineDoesNotExist extends __SmithyException, $MetadataBe } export namespace StateMachineDoesNotExist { + /** + * @internal + */ export const filterSensitiveLog = (obj: StateMachineDoesNotExist): any => ({ ...obj, }); @@ -1041,6 +1170,9 @@ export interface DescribeStateMachineForExecutionInput { } export namespace DescribeStateMachineForExecutionInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeStateMachineForExecutionInput): any => ({ ...obj, }); @@ -1086,6 +1218,9 @@ export interface DescribeStateMachineForExecutionOutput { } export namespace DescribeStateMachineForExecutionOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeStateMachineForExecutionOutput): any => ({ ...obj, ...(obj.definition && { definition: SENSITIVE_STRING }), @@ -1107,6 +1242,9 @@ export interface GetActivityTaskInput { } export namespace GetActivityTaskInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetActivityTaskInput): any => ({ ...obj, }); @@ -1128,6 +1266,9 @@ export interface GetActivityTaskOutput { } export namespace GetActivityTaskOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetActivityTaskOutput): any => ({ ...obj, ...(obj.input && { input: SENSITIVE_STRING }), @@ -1166,6 +1307,9 @@ export interface GetExecutionHistoryInput { } export namespace GetExecutionHistoryInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetExecutionHistoryInput): any => ({ ...obj, }); @@ -1187,6 +1331,9 @@ export interface ExecutionAbortedEventDetails { } export namespace ExecutionAbortedEventDetails { + /** + * @internal + */ export const filterSensitiveLog = (obj: ExecutionAbortedEventDetails): any => ({ ...obj, ...(obj.error && { error: SENSITIVE_STRING }), @@ -1210,6 +1357,9 @@ export interface ExecutionFailedEventDetails { } export namespace ExecutionFailedEventDetails { + /** + * @internal + */ export const filterSensitiveLog = (obj: ExecutionFailedEventDetails): any => ({ ...obj, ...(obj.error && { error: SENSITIVE_STRING }), @@ -1238,6 +1388,9 @@ export interface ExecutionStartedEventDetails { } export namespace ExecutionStartedEventDetails { + /** + * @internal + */ export const filterSensitiveLog = (obj: ExecutionStartedEventDetails): any => ({ ...obj, ...(obj.input && { input: SENSITIVE_STRING }), @@ -1260,6 +1413,9 @@ export interface ExecutionSucceededEventDetails { } export namespace ExecutionSucceededEventDetails { + /** + * @internal + */ export const filterSensitiveLog = (obj: ExecutionSucceededEventDetails): any => ({ ...obj, ...(obj.output && { output: SENSITIVE_STRING }), @@ -1282,6 +1438,9 @@ export interface ExecutionTimedOutEventDetails { } export namespace ExecutionTimedOutEventDetails { + /** + * @internal + */ export const filterSensitiveLog = (obj: ExecutionTimedOutEventDetails): any => ({ ...obj, ...(obj.error && { error: SENSITIVE_STRING }), @@ -1305,6 +1464,9 @@ export interface LambdaFunctionFailedEventDetails { } export namespace LambdaFunctionFailedEventDetails { + /** + * @internal + */ export const filterSensitiveLog = (obj: LambdaFunctionFailedEventDetails): any => ({ ...obj, ...(obj.error && { error: SENSITIVE_STRING }), @@ -1338,6 +1500,9 @@ export interface LambdaFunctionScheduledEventDetails { } export namespace LambdaFunctionScheduledEventDetails { + /** + * @internal + */ export const filterSensitiveLog = (obj: LambdaFunctionScheduledEventDetails): any => ({ ...obj, ...(obj.input && { input: SENSITIVE_STRING }), @@ -1361,6 +1526,9 @@ export interface LambdaFunctionScheduleFailedEventDetails { } export namespace LambdaFunctionScheduleFailedEventDetails { + /** + * @internal + */ export const filterSensitiveLog = (obj: LambdaFunctionScheduleFailedEventDetails): any => ({ ...obj, ...(obj.error && { error: SENSITIVE_STRING }), @@ -1384,6 +1552,9 @@ export interface LambdaFunctionStartFailedEventDetails { } export namespace LambdaFunctionStartFailedEventDetails { + /** + * @internal + */ export const filterSensitiveLog = (obj: LambdaFunctionStartFailedEventDetails): any => ({ ...obj, ...(obj.error && { error: SENSITIVE_STRING }), @@ -1408,6 +1579,9 @@ export interface LambdaFunctionSucceededEventDetails { } export namespace LambdaFunctionSucceededEventDetails { + /** + * @internal + */ export const filterSensitiveLog = (obj: LambdaFunctionSucceededEventDetails): any => ({ ...obj, ...(obj.output && { output: SENSITIVE_STRING }), @@ -1430,6 +1604,9 @@ export interface LambdaFunctionTimedOutEventDetails { } export namespace LambdaFunctionTimedOutEventDetails { + /** + * @internal + */ export const filterSensitiveLog = (obj: LambdaFunctionTimedOutEventDetails): any => ({ ...obj, ...(obj.error && { error: SENSITIVE_STRING }), @@ -1453,6 +1630,9 @@ export interface MapIterationEventDetails { } export namespace MapIterationEventDetails { + /** + * @internal + */ export const filterSensitiveLog = (obj: MapIterationEventDetails): any => ({ ...obj, }); @@ -1469,6 +1649,9 @@ export interface MapStateStartedEventDetails { } export namespace MapStateStartedEventDetails { + /** + * @internal + */ export const filterSensitiveLog = (obj: MapStateStartedEventDetails): any => ({ ...obj, }); @@ -1495,6 +1678,9 @@ export interface StateEnteredEventDetails { } export namespace StateEnteredEventDetails { + /** + * @internal + */ export const filterSensitiveLog = (obj: StateEnteredEventDetails): any => ({ ...obj, ...(obj.input && { input: SENSITIVE_STRING }), @@ -1544,6 +1730,9 @@ export interface StateExitedEventDetails { } export namespace StateExitedEventDetails { + /** + * @internal + */ export const filterSensitiveLog = (obj: StateExitedEventDetails): any => ({ ...obj, ...(obj.output && { output: SENSITIVE_STRING }), @@ -1576,6 +1765,9 @@ export interface TaskFailedEventDetails { } export namespace TaskFailedEventDetails { + /** + * @internal + */ export const filterSensitiveLog = (obj: TaskFailedEventDetails): any => ({ ...obj, ...(obj.error && { error: SENSITIVE_STRING }), @@ -1620,6 +1812,9 @@ export interface TaskScheduledEventDetails { } export namespace TaskScheduledEventDetails { + /** + * @internal + */ export const filterSensitiveLog = (obj: TaskScheduledEventDetails): any => ({ ...obj, ...(obj.parameters && { parameters: SENSITIVE_STRING }), @@ -1642,6 +1837,9 @@ export interface TaskStartedEventDetails { } export namespace TaskStartedEventDetails { + /** + * @internal + */ export const filterSensitiveLog = (obj: TaskStartedEventDetails): any => ({ ...obj, }); @@ -1673,6 +1871,9 @@ export interface TaskStartFailedEventDetails { } export namespace TaskStartFailedEventDetails { + /** + * @internal + */ export const filterSensitiveLog = (obj: TaskStartFailedEventDetails): any => ({ ...obj, ...(obj.error && { error: SENSITIVE_STRING }), @@ -1706,6 +1907,9 @@ export interface TaskSubmitFailedEventDetails { } export namespace TaskSubmitFailedEventDetails { + /** + * @internal + */ export const filterSensitiveLog = (obj: TaskSubmitFailedEventDetails): any => ({ ...obj, ...(obj.error && { error: SENSITIVE_STRING }), @@ -1739,6 +1943,9 @@ export interface TaskSubmittedEventDetails { } export namespace TaskSubmittedEventDetails { + /** + * @internal + */ export const filterSensitiveLog = (obj: TaskSubmittedEventDetails): any => ({ ...obj, ...(obj.output && { output: SENSITIVE_STRING }), @@ -1772,6 +1979,9 @@ export interface TaskSucceededEventDetails { } export namespace TaskSucceededEventDetails { + /** + * @internal + */ export const filterSensitiveLog = (obj: TaskSucceededEventDetails): any => ({ ...obj, ...(obj.output && { output: SENSITIVE_STRING }), @@ -1804,6 +2014,9 @@ export interface TaskTimedOutEventDetails { } export namespace TaskTimedOutEventDetails { + /** + * @internal + */ export const filterSensitiveLog = (obj: TaskTimedOutEventDetails): any => ({ ...obj, ...(obj.error && { error: SENSITIVE_STRING }), @@ -2057,6 +2270,9 @@ export interface HistoryEvent { } export namespace HistoryEvent { + /** + * @internal + */ export const filterSensitiveLog = (obj: HistoryEvent): any => ({ ...obj, ...(obj.activityFailedEventDetails && { @@ -2173,6 +2389,9 @@ export interface GetExecutionHistoryOutput { } export namespace GetExecutionHistoryOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetExecutionHistoryOutput): any => ({ ...obj, ...(obj.events && { events: obj.events.map((item) => HistoryEvent.filterSensitiveLog(item)) }), @@ -2189,6 +2408,9 @@ export interface InvalidToken extends __SmithyException, $MetadataBearer { } export namespace InvalidToken { + /** + * @internal + */ export const filterSensitiveLog = (obj: InvalidToken): any => ({ ...obj, }); @@ -2210,6 +2432,9 @@ export interface ListActivitiesInput { } export namespace ListActivitiesInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListActivitiesInput): any => ({ ...obj, }); @@ -2229,6 +2454,9 @@ export interface ListActivitiesOutput { } export namespace ListActivitiesOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListActivitiesOutput): any => ({ ...obj, }); @@ -2261,6 +2489,9 @@ export interface ListExecutionsInput { } export namespace ListExecutionsInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListExecutionsInput): any => ({ ...obj, }); @@ -2324,6 +2555,9 @@ export interface ExecutionListItem { } export namespace ExecutionListItem { + /** + * @internal + */ export const filterSensitiveLog = (obj: ExecutionListItem): any => ({ ...obj, }); @@ -2343,6 +2577,9 @@ export interface ListExecutionsOutput { } export namespace ListExecutionsOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListExecutionsOutput): any => ({ ...obj, }); @@ -2364,6 +2601,9 @@ export interface ListStateMachinesInput { } export namespace ListStateMachinesInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListStateMachinesInput): any => ({ ...obj, }); @@ -2417,6 +2657,9 @@ export interface StateMachineListItem { } export namespace StateMachineListItem { + /** + * @internal + */ export const filterSensitiveLog = (obj: StateMachineListItem): any => ({ ...obj, }); @@ -2432,6 +2675,9 @@ export interface ListStateMachinesOutput { } export namespace ListStateMachinesOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListStateMachinesOutput): any => ({ ...obj, }); @@ -2445,6 +2691,9 @@ export interface ListTagsForResourceInput { } export namespace ListTagsForResourceInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListTagsForResourceInput): any => ({ ...obj, }); @@ -2458,6 +2707,9 @@ export interface ListTagsForResourceOutput { } export namespace ListTagsForResourceOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListTagsForResourceOutput): any => ({ ...obj, }); @@ -2475,6 +2727,9 @@ export interface ResourceNotFound extends __SmithyException, $MetadataBearer { } export namespace ResourceNotFound { + /** + * @internal + */ export const filterSensitiveLog = (obj: ResourceNotFound): any => ({ ...obj, }); @@ -2500,6 +2755,9 @@ export interface SendTaskFailureInput { } export namespace SendTaskFailureInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: SendTaskFailureInput): any => ({ ...obj, ...(obj.error && { error: SENSITIVE_STRING }), @@ -2510,6 +2768,9 @@ export namespace SendTaskFailureInput { export interface SendTaskFailureOutput {} export namespace SendTaskFailureOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: SendTaskFailureOutput): any => ({ ...obj, }); @@ -2522,6 +2783,9 @@ export interface TaskDoesNotExist extends __SmithyException, $MetadataBearer { } export namespace TaskDoesNotExist { + /** + * @internal + */ export const filterSensitiveLog = (obj: TaskDoesNotExist): any => ({ ...obj, }); @@ -2534,6 +2798,9 @@ export interface TaskTimedOut extends __SmithyException, $MetadataBearer { } export namespace TaskTimedOut { + /** + * @internal + */ export const filterSensitiveLog = (obj: TaskTimedOut): any => ({ ...obj, }); @@ -2549,6 +2816,9 @@ export interface SendTaskHeartbeatInput { } export namespace SendTaskHeartbeatInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: SendTaskHeartbeatInput): any => ({ ...obj, }); @@ -2557,6 +2827,9 @@ export namespace SendTaskHeartbeatInput { export interface SendTaskHeartbeatOutput {} export namespace SendTaskHeartbeatOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: SendTaskHeartbeatOutput): any => ({ ...obj, }); @@ -2572,6 +2845,9 @@ export interface InvalidOutput extends __SmithyException, $MetadataBearer { } export namespace InvalidOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: InvalidOutput): any => ({ ...obj, }); @@ -2592,6 +2868,9 @@ export interface SendTaskSuccessInput { } export namespace SendTaskSuccessInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: SendTaskSuccessInput): any => ({ ...obj, ...(obj.output && { output: SENSITIVE_STRING }), @@ -2601,6 +2880,9 @@ export namespace SendTaskSuccessInput { export interface SendTaskSuccessOutput {} export namespace SendTaskSuccessOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: SendTaskSuccessOutput): any => ({ ...obj, }); @@ -2621,6 +2903,9 @@ export interface ExecutionAlreadyExists extends __SmithyException, $MetadataBear } export namespace ExecutionAlreadyExists { + /** + * @internal + */ export const filterSensitiveLog = (obj: ExecutionAlreadyExists): any => ({ ...obj, }); @@ -2637,6 +2922,9 @@ export interface ExecutionLimitExceeded extends __SmithyException, $MetadataBear } export namespace ExecutionLimitExceeded { + /** + * @internal + */ export const filterSensitiveLog = (obj: ExecutionLimitExceeded): any => ({ ...obj, }); @@ -2652,6 +2940,9 @@ export interface InvalidExecutionInput extends __SmithyException, $MetadataBeare } export namespace InvalidExecutionInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: InvalidExecutionInput): any => ({ ...obj, }); @@ -2713,6 +3004,9 @@ export interface StartExecutionInput { } export namespace StartExecutionInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: StartExecutionInput): any => ({ ...obj, ...(obj.input && { input: SENSITIVE_STRING }), @@ -2732,6 +3026,9 @@ export interface StartExecutionOutput { } export namespace StartExecutionOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: StartExecutionOutput): any => ({ ...obj, }); @@ -2769,6 +3066,9 @@ export interface StartSyncExecutionInput { } export namespace StartSyncExecutionInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: StartSyncExecutionInput): any => ({ ...obj, ...(obj.input && { input: SENSITIVE_STRING }), @@ -2791,6 +3091,9 @@ export interface BillingDetails { } export namespace BillingDetails { + /** + * @internal + */ export const filterSensitiveLog = (obj: BillingDetails): any => ({ ...obj, }); @@ -2876,6 +3179,9 @@ export interface StartSyncExecutionOutput { } export namespace StartSyncExecutionOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: StartSyncExecutionOutput): any => ({ ...obj, ...(obj.error && { error: SENSITIVE_STRING }), @@ -2903,6 +3209,9 @@ export interface StopExecutionInput { } export namespace StopExecutionInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: StopExecutionInput): any => ({ ...obj, ...(obj.error && { error: SENSITIVE_STRING }), @@ -2918,6 +3227,9 @@ export interface StopExecutionOutput { } export namespace StopExecutionOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: StopExecutionOutput): any => ({ ...obj, }); @@ -2937,6 +3249,9 @@ export interface TagResourceInput { } export namespace TagResourceInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: TagResourceInput): any => ({ ...obj, }); @@ -2945,6 +3260,9 @@ export namespace TagResourceInput { export interface TagResourceOutput {} export namespace TagResourceOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: TagResourceOutput): any => ({ ...obj, }); @@ -2963,6 +3281,9 @@ export interface UntagResourceInput { } export namespace UntagResourceInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: UntagResourceInput): any => ({ ...obj, }); @@ -2971,6 +3292,9 @@ export namespace UntagResourceInput { export interface UntagResourceOutput {} export namespace UntagResourceOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: UntagResourceOutput): any => ({ ...obj, }); @@ -2987,6 +3311,9 @@ export interface MissingRequiredParameter extends __SmithyException, $MetadataBe } export namespace MissingRequiredParameter { + /** + * @internal + */ export const filterSensitiveLog = (obj: MissingRequiredParameter): any => ({ ...obj, }); @@ -3021,6 +3348,9 @@ export interface UpdateStateMachineInput { } export namespace UpdateStateMachineInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateStateMachineInput): any => ({ ...obj, ...(obj.definition && { definition: SENSITIVE_STRING }), @@ -3035,6 +3365,9 @@ export interface UpdateStateMachineOutput { } export namespace UpdateStateMachineOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateStateMachineOutput): any => ({ ...obj, }); diff --git a/clients/client-shield/commands/AssociateDRTLogBucketCommand.ts b/clients/client-shield/commands/AssociateDRTLogBucketCommand.ts index 4769d8d163ee..6b3de071009e 100644 --- a/clients/client-shield/commands/AssociateDRTLogBucketCommand.ts +++ b/clients/client-shield/commands/AssociateDRTLogBucketCommand.ts @@ -23,6 +23,20 @@ export interface AssociateDRTLogBucketCommandOutput extends AssociateDRTLogBucke /** *

Authorizes the DDoS Response Team (DRT) to access the specified Amazon S3 bucket containing your AWS WAF logs. You can associate up to 10 Amazon S3 buckets with your subscription.

*

To use the services of the DRT and make an AssociateDRTLogBucket request, you must be subscribed to the Business Support plan or the Enterprise Support plan.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ShieldClient, AssociateDRTLogBucketCommand } from "@aws-sdk/client-shield"; // ES Modules import + * // const { ShieldClient, AssociateDRTLogBucketCommand } = require("@aws-sdk/client-shield"); // CommonJS import + * const client = new ShieldClient(config); + * const command = new AssociateDRTLogBucketCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link AssociateDRTLogBucketCommandInput} for command's `input` shape. + * @see {@link AssociateDRTLogBucketCommandOutput} for command's `response` shape. + * @see {@link ShieldClientResolvedConfig | config} for command's `input` shape. + * */ export class AssociateDRTLogBucketCommand extends $Command< AssociateDRTLogBucketCommandInput, diff --git a/clients/client-shield/commands/AssociateDRTRoleCommand.ts b/clients/client-shield/commands/AssociateDRTRoleCommand.ts index eac16d58e952..16527b30f74f 100644 --- a/clients/client-shield/commands/AssociateDRTRoleCommand.ts +++ b/clients/client-shield/commands/AssociateDRTRoleCommand.ts @@ -28,6 +28,20 @@ export interface AssociateDRTRoleCommandOutput extends AssociateDRTRoleResponse, *

The DRT will have access only to your AWS WAF and Shield resources. By submitting this request, you authorize the DRT to inspect your AWS WAF and Shield configuration and create and update AWS WAF rules and web ACLs on your behalf. The DRT 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 AWS Service.

*

To use the services of the DRT and make an AssociateDRTRole request, you must be subscribed to the Business Support plan or the Enterprise Support plan.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ShieldClient, AssociateDRTRoleCommand } from "@aws-sdk/client-shield"; // ES Modules import + * // const { ShieldClient, AssociateDRTRoleCommand } = require("@aws-sdk/client-shield"); // CommonJS import + * const client = new ShieldClient(config); + * const command = new AssociateDRTRoleCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link AssociateDRTRoleCommandInput} for command's `input` shape. + * @see {@link AssociateDRTRoleCommandOutput} for command's `response` shape. + * @see {@link ShieldClientResolvedConfig | config} for command's `input` shape. + * */ export class AssociateDRTRoleCommand extends $Command< AssociateDRTRoleCommandInput, diff --git a/clients/client-shield/commands/AssociateHealthCheckCommand.ts b/clients/client-shield/commands/AssociateHealthCheckCommand.ts index 20ebfb61f0f2..5809de14400b 100644 --- a/clients/client-shield/commands/AssociateHealthCheckCommand.ts +++ b/clients/client-shield/commands/AssociateHealthCheckCommand.ts @@ -23,6 +23,20 @@ export interface AssociateHealthCheckCommandOutput extends AssociateHealthCheckR /** *

Adds health-based detection to the Shield Advanced protection for a resource. Shield Advanced health-based detection uses the health of your AWS resource to improve responsiveness and accuracy in attack detection and mitigation.

*

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 AWS WAF and AWS Shield Developer Guide.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ShieldClient, AssociateHealthCheckCommand } from "@aws-sdk/client-shield"; // ES Modules import + * // const { ShieldClient, AssociateHealthCheckCommand } = require("@aws-sdk/client-shield"); // CommonJS import + * const client = new ShieldClient(config); + * const command = new AssociateHealthCheckCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link AssociateHealthCheckCommandInput} for command's `input` shape. + * @see {@link AssociateHealthCheckCommandOutput} for command's `response` shape. + * @see {@link ShieldClientResolvedConfig | config} for command's `input` shape. + * */ export class AssociateHealthCheckCommand extends $Command< AssociateHealthCheckCommandInput, diff --git a/clients/client-shield/commands/AssociateProactiveEngagementDetailsCommand.ts b/clients/client-shield/commands/AssociateProactiveEngagementDetailsCommand.ts index c00bc78d97eb..5e481187fce7 100644 --- a/clients/client-shield/commands/AssociateProactiveEngagementDetailsCommand.ts +++ b/clients/client-shield/commands/AssociateProactiveEngagementDetailsCommand.ts @@ -32,6 +32,20 @@ export interface AssociateProactiveEngagementDetailsCommandOutput *

This call defines the list of email addresses and phone numbers that the DDoS Response Team (DRT) can use to contact you for escalations to the DRT 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.

* + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ShieldClient, AssociateProactiveEngagementDetailsCommand } from "@aws-sdk/client-shield"; // ES Modules import + * // const { ShieldClient, AssociateProactiveEngagementDetailsCommand } = require("@aws-sdk/client-shield"); // CommonJS import + * const client = new ShieldClient(config); + * const command = new AssociateProactiveEngagementDetailsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link AssociateProactiveEngagementDetailsCommandInput} for command's `input` shape. + * @see {@link AssociateProactiveEngagementDetailsCommandOutput} for command's `response` shape. + * @see {@link ShieldClientResolvedConfig | config} for command's `input` shape. + * */ export class AssociateProactiveEngagementDetailsCommand extends $Command< AssociateProactiveEngagementDetailsCommandInput, diff --git a/clients/client-shield/commands/CreateProtectionCommand.ts b/clients/client-shield/commands/CreateProtectionCommand.ts index dcfea6201e26..a869341dd3ae 100644 --- a/clients/client-shield/commands/CreateProtectionCommand.ts +++ b/clients/client-shield/commands/CreateProtectionCommand.ts @@ -24,6 +24,20 @@ export interface CreateProtectionCommandOutput extends CreateProtectionResponse, *

Enables AWS Shield Advanced for a specific AWS resource. The resource can be an Amazon * CloudFront distribution, Elastic Load Balancing load balancer, AWS Global Accelerator accelerator, Elastic IP Address, or an Amazon Route 53 hosted zone.

*

You can add protection to only a single resource with each CreateProtection request. If you want to add protection to multiple resources at once, use the AWS WAF console. For more information see Getting Started with AWS Shield Advanced and Add AWS Shield Advanced Protection to more AWS Resources.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ShieldClient, CreateProtectionCommand } from "@aws-sdk/client-shield"; // ES Modules import + * // const { ShieldClient, CreateProtectionCommand } = require("@aws-sdk/client-shield"); // CommonJS import + * const client = new ShieldClient(config); + * const command = new CreateProtectionCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreateProtectionCommandInput} for command's `input` shape. + * @see {@link CreateProtectionCommandOutput} for command's `response` shape. + * @see {@link ShieldClientResolvedConfig | config} for command's `input` shape. + * */ export class CreateProtectionCommand extends $Command< CreateProtectionCommandInput, diff --git a/clients/client-shield/commands/CreateProtectionGroupCommand.ts b/clients/client-shield/commands/CreateProtectionGroupCommand.ts index d7043ddd6501..1852631a0476 100644 --- a/clients/client-shield/commands/CreateProtectionGroupCommand.ts +++ b/clients/client-shield/commands/CreateProtectionGroupCommand.ts @@ -22,6 +22,20 @@ export interface CreateProtectionGroupCommandOutput extends CreateProtectionGrou /** *

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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ShieldClient, CreateProtectionGroupCommand } from "@aws-sdk/client-shield"; // ES Modules import + * // const { ShieldClient, CreateProtectionGroupCommand } = require("@aws-sdk/client-shield"); // CommonJS import + * const client = new ShieldClient(config); + * const command = new CreateProtectionGroupCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreateProtectionGroupCommandInput} for command's `input` shape. + * @see {@link CreateProtectionGroupCommandOutput} for command's `response` shape. + * @see {@link ShieldClientResolvedConfig | config} for command's `input` shape. + * */ export class CreateProtectionGroupCommand extends $Command< CreateProtectionGroupCommandInput, diff --git a/clients/client-shield/commands/CreateSubscriptionCommand.ts b/clients/client-shield/commands/CreateSubscriptionCommand.ts index 4b8d8efa9531..bd85691f8997 100644 --- a/clients/client-shield/commands/CreateSubscriptionCommand.ts +++ b/clients/client-shield/commands/CreateSubscriptionCommand.ts @@ -24,6 +24,20 @@ export interface CreateSubscriptionCommandOutput extends CreateSubscriptionRespo *

Activates AWS Shield Advanced for an account.

* *

When you initally 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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ShieldClient, CreateSubscriptionCommand } from "@aws-sdk/client-shield"; // ES Modules import + * // const { ShieldClient, CreateSubscriptionCommand } = require("@aws-sdk/client-shield"); // CommonJS import + * const client = new ShieldClient(config); + * const command = new CreateSubscriptionCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreateSubscriptionCommandInput} for command's `input` shape. + * @see {@link CreateSubscriptionCommandOutput} for command's `response` shape. + * @see {@link ShieldClientResolvedConfig | config} for command's `input` shape. + * */ export class CreateSubscriptionCommand extends $Command< CreateSubscriptionCommandInput, diff --git a/clients/client-shield/commands/DeleteProtectionCommand.ts b/clients/client-shield/commands/DeleteProtectionCommand.ts index 0eeb56b0c7e4..383985e50b97 100644 --- a/clients/client-shield/commands/DeleteProtectionCommand.ts +++ b/clients/client-shield/commands/DeleteProtectionCommand.ts @@ -22,6 +22,20 @@ export interface DeleteProtectionCommandOutput extends DeleteProtectionResponse, /** *

Deletes an AWS Shield Advanced Protection.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ShieldClient, DeleteProtectionCommand } from "@aws-sdk/client-shield"; // ES Modules import + * // const { ShieldClient, DeleteProtectionCommand } = require("@aws-sdk/client-shield"); // CommonJS import + * const client = new ShieldClient(config); + * const command = new DeleteProtectionCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteProtectionCommandInput} for command's `input` shape. + * @see {@link DeleteProtectionCommandOutput} for command's `response` shape. + * @see {@link ShieldClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteProtectionCommand extends $Command< DeleteProtectionCommandInput, diff --git a/clients/client-shield/commands/DeleteProtectionGroupCommand.ts b/clients/client-shield/commands/DeleteProtectionGroupCommand.ts index 0f5341cabe31..10e09d9aedab 100644 --- a/clients/client-shield/commands/DeleteProtectionGroupCommand.ts +++ b/clients/client-shield/commands/DeleteProtectionGroupCommand.ts @@ -22,6 +22,20 @@ export interface DeleteProtectionGroupCommandOutput extends DeleteProtectionGrou /** *

Removes the specified protection group.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ShieldClient, DeleteProtectionGroupCommand } from "@aws-sdk/client-shield"; // ES Modules import + * // const { ShieldClient, DeleteProtectionGroupCommand } = require("@aws-sdk/client-shield"); // CommonJS import + * const client = new ShieldClient(config); + * const command = new DeleteProtectionGroupCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteProtectionGroupCommandInput} for command's `input` shape. + * @see {@link DeleteProtectionGroupCommandOutput} for command's `response` shape. + * @see {@link ShieldClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteProtectionGroupCommand extends $Command< DeleteProtectionGroupCommandInput, diff --git a/clients/client-shield/commands/DeleteSubscriptionCommand.ts b/clients/client-shield/commands/DeleteSubscriptionCommand.ts index 8b7449065981..ef57ec05fae4 100644 --- a/clients/client-shield/commands/DeleteSubscriptionCommand.ts +++ b/clients/client-shield/commands/DeleteSubscriptionCommand.ts @@ -24,6 +24,20 @@ export interface DeleteSubscriptionCommandOutput extends DeleteSubscriptionRespo * @deprecated * *

Removes AWS Shield Advanced from an account. AWS Shield Advanced requires a 1-year subscription commitment. You cannot delete a subscription prior to the completion of that commitment.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ShieldClient, DeleteSubscriptionCommand } from "@aws-sdk/client-shield"; // ES Modules import + * // const { ShieldClient, DeleteSubscriptionCommand } = require("@aws-sdk/client-shield"); // CommonJS import + * const client = new ShieldClient(config); + * const command = new DeleteSubscriptionCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteSubscriptionCommandInput} for command's `input` shape. + * @see {@link DeleteSubscriptionCommandOutput} for command's `response` shape. + * @see {@link ShieldClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteSubscriptionCommand extends $Command< DeleteSubscriptionCommandInput, diff --git a/clients/client-shield/commands/DescribeAttackCommand.ts b/clients/client-shield/commands/DescribeAttackCommand.ts index 44ebd1f6a8f4..55d172358177 100644 --- a/clients/client-shield/commands/DescribeAttackCommand.ts +++ b/clients/client-shield/commands/DescribeAttackCommand.ts @@ -22,6 +22,20 @@ export interface DescribeAttackCommandOutput extends DescribeAttackResponse, __M /** *

Describes the details of a DDoS attack.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ShieldClient, DescribeAttackCommand } from "@aws-sdk/client-shield"; // ES Modules import + * // const { ShieldClient, DescribeAttackCommand } = require("@aws-sdk/client-shield"); // CommonJS import + * const client = new ShieldClient(config); + * const command = new DescribeAttackCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeAttackCommandInput} for command's `input` shape. + * @see {@link DescribeAttackCommandOutput} for command's `response` shape. + * @see {@link ShieldClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeAttackCommand extends $Command< DescribeAttackCommandInput, diff --git a/clients/client-shield/commands/DescribeAttackStatisticsCommand.ts b/clients/client-shield/commands/DescribeAttackStatisticsCommand.ts index 77a5a5b64854..c07727c2172a 100644 --- a/clients/client-shield/commands/DescribeAttackStatisticsCommand.ts +++ b/clients/client-shield/commands/DescribeAttackStatisticsCommand.ts @@ -24,6 +24,20 @@ export interface DescribeAttackStatisticsCommandOutput extends DescribeAttackSta *

Provides information about the number and type of attacks AWS 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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ShieldClient, DescribeAttackStatisticsCommand } from "@aws-sdk/client-shield"; // ES Modules import + * // const { ShieldClient, DescribeAttackStatisticsCommand } = require("@aws-sdk/client-shield"); // CommonJS import + * const client = new ShieldClient(config); + * const command = new DescribeAttackStatisticsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeAttackStatisticsCommandInput} for command's `input` shape. + * @see {@link DescribeAttackStatisticsCommandOutput} for command's `response` shape. + * @see {@link ShieldClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeAttackStatisticsCommand extends $Command< DescribeAttackStatisticsCommandInput, diff --git a/clients/client-shield/commands/DescribeDRTAccessCommand.ts b/clients/client-shield/commands/DescribeDRTAccessCommand.ts index f80ce578682f..369ae0020e86 100644 --- a/clients/client-shield/commands/DescribeDRTAccessCommand.ts +++ b/clients/client-shield/commands/DescribeDRTAccessCommand.ts @@ -22,6 +22,20 @@ export interface DescribeDRTAccessCommandOutput extends DescribeDRTAccessRespons /** *

Returns the current role and list of Amazon S3 log buckets used by the DDoS Response Team (DRT) to access your AWS account while assisting with attack mitigation.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ShieldClient, DescribeDRTAccessCommand } from "@aws-sdk/client-shield"; // ES Modules import + * // const { ShieldClient, DescribeDRTAccessCommand } = require("@aws-sdk/client-shield"); // CommonJS import + * const client = new ShieldClient(config); + * const command = new DescribeDRTAccessCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeDRTAccessCommandInput} for command's `input` shape. + * @see {@link DescribeDRTAccessCommandOutput} for command's `response` shape. + * @see {@link ShieldClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeDRTAccessCommand extends $Command< DescribeDRTAccessCommandInput, diff --git a/clients/client-shield/commands/DescribeEmergencyContactSettingsCommand.ts b/clients/client-shield/commands/DescribeEmergencyContactSettingsCommand.ts index f84bb464e979..68a5836fe64a 100644 --- a/clients/client-shield/commands/DescribeEmergencyContactSettingsCommand.ts +++ b/clients/client-shield/commands/DescribeEmergencyContactSettingsCommand.ts @@ -24,6 +24,20 @@ export interface DescribeEmergencyContactSettingsCommandOutput /** *

A list of email addresses and phone numbers that the DDoS Response Team (DRT) can use to contact you if you have proactive engagement enabled, for escalations to the DRT and to initiate proactive customer support.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ShieldClient, DescribeEmergencyContactSettingsCommand } from "@aws-sdk/client-shield"; // ES Modules import + * // const { ShieldClient, DescribeEmergencyContactSettingsCommand } = require("@aws-sdk/client-shield"); // CommonJS import + * const client = new ShieldClient(config); + * const command = new DescribeEmergencyContactSettingsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeEmergencyContactSettingsCommandInput} for command's `input` shape. + * @see {@link DescribeEmergencyContactSettingsCommandOutput} for command's `response` shape. + * @see {@link ShieldClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeEmergencyContactSettingsCommand extends $Command< DescribeEmergencyContactSettingsCommandInput, diff --git a/clients/client-shield/commands/DescribeProtectionCommand.ts b/clients/client-shield/commands/DescribeProtectionCommand.ts index 4f466a8fa780..e274462e14e0 100644 --- a/clients/client-shield/commands/DescribeProtectionCommand.ts +++ b/clients/client-shield/commands/DescribeProtectionCommand.ts @@ -22,6 +22,20 @@ export interface DescribeProtectionCommandOutput extends DescribeProtectionRespo /** *

Lists the details of a Protection object.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ShieldClient, DescribeProtectionCommand } from "@aws-sdk/client-shield"; // ES Modules import + * // const { ShieldClient, DescribeProtectionCommand } = require("@aws-sdk/client-shield"); // CommonJS import + * const client = new ShieldClient(config); + * const command = new DescribeProtectionCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeProtectionCommandInput} for command's `input` shape. + * @see {@link DescribeProtectionCommandOutput} for command's `response` shape. + * @see {@link ShieldClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeProtectionCommand extends $Command< DescribeProtectionCommandInput, diff --git a/clients/client-shield/commands/DescribeProtectionGroupCommand.ts b/clients/client-shield/commands/DescribeProtectionGroupCommand.ts index d11b042efde2..528c1d460303 100644 --- a/clients/client-shield/commands/DescribeProtectionGroupCommand.ts +++ b/clients/client-shield/commands/DescribeProtectionGroupCommand.ts @@ -22,6 +22,20 @@ export interface DescribeProtectionGroupCommandOutput extends DescribeProtection /** *

Returns the specification for the specified protection group.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ShieldClient, DescribeProtectionGroupCommand } from "@aws-sdk/client-shield"; // ES Modules import + * // const { ShieldClient, DescribeProtectionGroupCommand } = require("@aws-sdk/client-shield"); // CommonJS import + * const client = new ShieldClient(config); + * const command = new DescribeProtectionGroupCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeProtectionGroupCommandInput} for command's `input` shape. + * @see {@link DescribeProtectionGroupCommandOutput} for command's `response` shape. + * @see {@link ShieldClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeProtectionGroupCommand extends $Command< DescribeProtectionGroupCommandInput, diff --git a/clients/client-shield/commands/DescribeSubscriptionCommand.ts b/clients/client-shield/commands/DescribeSubscriptionCommand.ts index 4fe76919bcce..0c1b631ab787 100644 --- a/clients/client-shield/commands/DescribeSubscriptionCommand.ts +++ b/clients/client-shield/commands/DescribeSubscriptionCommand.ts @@ -22,6 +22,20 @@ export interface DescribeSubscriptionCommandOutput extends DescribeSubscriptionR /** *

Provides details about the AWS Shield Advanced subscription for an account.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ShieldClient, DescribeSubscriptionCommand } from "@aws-sdk/client-shield"; // ES Modules import + * // const { ShieldClient, DescribeSubscriptionCommand } = require("@aws-sdk/client-shield"); // CommonJS import + * const client = new ShieldClient(config); + * const command = new DescribeSubscriptionCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeSubscriptionCommandInput} for command's `input` shape. + * @see {@link DescribeSubscriptionCommandOutput} for command's `response` shape. + * @see {@link ShieldClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeSubscriptionCommand extends $Command< DescribeSubscriptionCommandInput, diff --git a/clients/client-shield/commands/DisableProactiveEngagementCommand.ts b/clients/client-shield/commands/DisableProactiveEngagementCommand.ts index 3292505e5ae6..a0ae84d2290e 100644 --- a/clients/client-shield/commands/DisableProactiveEngagementCommand.ts +++ b/clients/client-shield/commands/DisableProactiveEngagementCommand.ts @@ -22,6 +22,20 @@ export interface DisableProactiveEngagementCommandOutput extends DisableProactiv /** *

Removes authorization from the DDoS Response Team (DRT) to notify contacts about escalations to the DRT and to initiate proactive customer support.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ShieldClient, DisableProactiveEngagementCommand } from "@aws-sdk/client-shield"; // ES Modules import + * // const { ShieldClient, DisableProactiveEngagementCommand } = require("@aws-sdk/client-shield"); // CommonJS import + * const client = new ShieldClient(config); + * const command = new DisableProactiveEngagementCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DisableProactiveEngagementCommandInput} for command's `input` shape. + * @see {@link DisableProactiveEngagementCommandOutput} for command's `response` shape. + * @see {@link ShieldClientResolvedConfig | config} for command's `input` shape. + * */ export class DisableProactiveEngagementCommand extends $Command< DisableProactiveEngagementCommandInput, diff --git a/clients/client-shield/commands/DisassociateDRTLogBucketCommand.ts b/clients/client-shield/commands/DisassociateDRTLogBucketCommand.ts index d7ab21e67df7..0b50e401af6c 100644 --- a/clients/client-shield/commands/DisassociateDRTLogBucketCommand.ts +++ b/clients/client-shield/commands/DisassociateDRTLogBucketCommand.ts @@ -23,6 +23,20 @@ export interface DisassociateDRTLogBucketCommandOutput extends DisassociateDRTLo /** *

Removes the DDoS Response Team's (DRT) access to the specified Amazon S3 bucket containing your AWS WAF logs.

*

To make a DisassociateDRTLogBucket request, you must be subscribed to the Business Support plan or the Enterprise Support plan. However, if you are not subscribed to one of these support plans, but had been previously and had granted the DRT access to your account, you can submit a DisassociateDRTLogBucket request to remove this access.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ShieldClient, DisassociateDRTLogBucketCommand } from "@aws-sdk/client-shield"; // ES Modules import + * // const { ShieldClient, DisassociateDRTLogBucketCommand } = require("@aws-sdk/client-shield"); // CommonJS import + * const client = new ShieldClient(config); + * const command = new DisassociateDRTLogBucketCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DisassociateDRTLogBucketCommandInput} for command's `input` shape. + * @see {@link DisassociateDRTLogBucketCommandOutput} for command's `response` shape. + * @see {@link ShieldClientResolvedConfig | config} for command's `input` shape. + * */ export class DisassociateDRTLogBucketCommand extends $Command< DisassociateDRTLogBucketCommandInput, diff --git a/clients/client-shield/commands/DisassociateDRTRoleCommand.ts b/clients/client-shield/commands/DisassociateDRTRoleCommand.ts index 5bef3852f038..b994e7baa062 100644 --- a/clients/client-shield/commands/DisassociateDRTRoleCommand.ts +++ b/clients/client-shield/commands/DisassociateDRTRoleCommand.ts @@ -23,6 +23,20 @@ export interface DisassociateDRTRoleCommandOutput extends DisassociateDRTRoleRes /** *

Removes the DDoS Response Team's (DRT) access to your AWS account.

*

To make a DisassociateDRTRole request, you must be subscribed to the Business Support plan or the Enterprise Support plan. However, if you are not subscribed to one of these support plans, but had been previously and had granted the DRT access to your account, you can submit a DisassociateDRTRole request to remove this access.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ShieldClient, DisassociateDRTRoleCommand } from "@aws-sdk/client-shield"; // ES Modules import + * // const { ShieldClient, DisassociateDRTRoleCommand } = require("@aws-sdk/client-shield"); // CommonJS import + * const client = new ShieldClient(config); + * const command = new DisassociateDRTRoleCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DisassociateDRTRoleCommandInput} for command's `input` shape. + * @see {@link DisassociateDRTRoleCommandOutput} for command's `response` shape. + * @see {@link ShieldClientResolvedConfig | config} for command's `input` shape. + * */ export class DisassociateDRTRoleCommand extends $Command< DisassociateDRTRoleCommandInput, diff --git a/clients/client-shield/commands/DisassociateHealthCheckCommand.ts b/clients/client-shield/commands/DisassociateHealthCheckCommand.ts index d94bd6910d4d..95dc394547d9 100644 --- a/clients/client-shield/commands/DisassociateHealthCheckCommand.ts +++ b/clients/client-shield/commands/DisassociateHealthCheckCommand.ts @@ -23,6 +23,20 @@ export interface DisassociateHealthCheckCommandOutput extends DisassociateHealth /** *

Removes health-based detection from the Shield Advanced protection for a resource. Shield Advanced health-based detection uses the health of your AWS resource to improve responsiveness and accuracy in attack detection and mitigation.

*

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 AWS WAF and AWS Shield Developer Guide.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ShieldClient, DisassociateHealthCheckCommand } from "@aws-sdk/client-shield"; // ES Modules import + * // const { ShieldClient, DisassociateHealthCheckCommand } = require("@aws-sdk/client-shield"); // CommonJS import + * const client = new ShieldClient(config); + * const command = new DisassociateHealthCheckCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DisassociateHealthCheckCommandInput} for command's `input` shape. + * @see {@link DisassociateHealthCheckCommandOutput} for command's `response` shape. + * @see {@link ShieldClientResolvedConfig | config} for command's `input` shape. + * */ export class DisassociateHealthCheckCommand extends $Command< DisassociateHealthCheckCommandInput, diff --git a/clients/client-shield/commands/EnableProactiveEngagementCommand.ts b/clients/client-shield/commands/EnableProactiveEngagementCommand.ts index 2284d033b228..d035ff0eba0e 100644 --- a/clients/client-shield/commands/EnableProactiveEngagementCommand.ts +++ b/clients/client-shield/commands/EnableProactiveEngagementCommand.ts @@ -22,6 +22,20 @@ export interface EnableProactiveEngagementCommandOutput extends EnableProactiveE /** *

Authorizes the DDoS Response Team (DRT) to use email and phone to notify contacts about escalations to the DRT and to initiate proactive customer support.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ShieldClient, EnableProactiveEngagementCommand } from "@aws-sdk/client-shield"; // ES Modules import + * // const { ShieldClient, EnableProactiveEngagementCommand } = require("@aws-sdk/client-shield"); // CommonJS import + * const client = new ShieldClient(config); + * const command = new EnableProactiveEngagementCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link EnableProactiveEngagementCommandInput} for command's `input` shape. + * @see {@link EnableProactiveEngagementCommandOutput} for command's `response` shape. + * @see {@link ShieldClientResolvedConfig | config} for command's `input` shape. + * */ export class EnableProactiveEngagementCommand extends $Command< EnableProactiveEngagementCommandInput, diff --git a/clients/client-shield/commands/GetSubscriptionStateCommand.ts b/clients/client-shield/commands/GetSubscriptionStateCommand.ts index bb6eba68086a..e778a2463647 100644 --- a/clients/client-shield/commands/GetSubscriptionStateCommand.ts +++ b/clients/client-shield/commands/GetSubscriptionStateCommand.ts @@ -22,6 +22,20 @@ export interface GetSubscriptionStateCommandOutput extends GetSubscriptionStateR /** *

Returns the SubscriptionState, either Active or Inactive.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ShieldClient, GetSubscriptionStateCommand } from "@aws-sdk/client-shield"; // ES Modules import + * // const { ShieldClient, GetSubscriptionStateCommand } = require("@aws-sdk/client-shield"); // CommonJS import + * const client = new ShieldClient(config); + * const command = new GetSubscriptionStateCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetSubscriptionStateCommandInput} for command's `input` shape. + * @see {@link GetSubscriptionStateCommandOutput} for command's `response` shape. + * @see {@link ShieldClientResolvedConfig | config} for command's `input` shape. + * */ export class GetSubscriptionStateCommand extends $Command< GetSubscriptionStateCommandInput, diff --git a/clients/client-shield/commands/ListAttacksCommand.ts b/clients/client-shield/commands/ListAttacksCommand.ts index 5b80946af754..bf382f81d330 100644 --- a/clients/client-shield/commands/ListAttacksCommand.ts +++ b/clients/client-shield/commands/ListAttacksCommand.ts @@ -23,6 +23,20 @@ export interface ListAttacksCommandOutput extends ListAttacksResponse, __Metadat /** *

Returns all ongoing DDoS attacks or all DDoS attacks during a specified time * period.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ShieldClient, ListAttacksCommand } from "@aws-sdk/client-shield"; // ES Modules import + * // const { ShieldClient, ListAttacksCommand } = require("@aws-sdk/client-shield"); // CommonJS import + * const client = new ShieldClient(config); + * const command = new ListAttacksCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListAttacksCommandInput} for command's `input` shape. + * @see {@link ListAttacksCommandOutput} for command's `response` shape. + * @see {@link ShieldClientResolvedConfig | config} for command's `input` shape. + * */ export class ListAttacksCommand extends $Command< ListAttacksCommandInput, diff --git a/clients/client-shield/commands/ListProtectionGroupsCommand.ts b/clients/client-shield/commands/ListProtectionGroupsCommand.ts index 51944e3abdb0..82c8f7ec34f4 100644 --- a/clients/client-shield/commands/ListProtectionGroupsCommand.ts +++ b/clients/client-shield/commands/ListProtectionGroupsCommand.ts @@ -22,6 +22,20 @@ export interface ListProtectionGroupsCommandOutput extends ListProtectionGroupsR /** *

Retrieves the ProtectionGroup objects for the account.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ShieldClient, ListProtectionGroupsCommand } from "@aws-sdk/client-shield"; // ES Modules import + * // const { ShieldClient, ListProtectionGroupsCommand } = require("@aws-sdk/client-shield"); // CommonJS import + * const client = new ShieldClient(config); + * const command = new ListProtectionGroupsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListProtectionGroupsCommandInput} for command's `input` shape. + * @see {@link ListProtectionGroupsCommandOutput} for command's `response` shape. + * @see {@link ShieldClientResolvedConfig | config} for command's `input` shape. + * */ export class ListProtectionGroupsCommand extends $Command< ListProtectionGroupsCommandInput, diff --git a/clients/client-shield/commands/ListProtectionsCommand.ts b/clients/client-shield/commands/ListProtectionsCommand.ts index 8526486a545b..bdf3183ac243 100644 --- a/clients/client-shield/commands/ListProtectionsCommand.ts +++ b/clients/client-shield/commands/ListProtectionsCommand.ts @@ -22,6 +22,20 @@ export interface ListProtectionsCommandOutput extends ListProtectionsResponse, _ /** *

Lists all Protection objects for the account.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ShieldClient, ListProtectionsCommand } from "@aws-sdk/client-shield"; // ES Modules import + * // const { ShieldClient, ListProtectionsCommand } = require("@aws-sdk/client-shield"); // CommonJS import + * const client = new ShieldClient(config); + * const command = new ListProtectionsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListProtectionsCommandInput} for command's `input` shape. + * @see {@link ListProtectionsCommandOutput} for command's `response` shape. + * @see {@link ShieldClientResolvedConfig | config} for command's `input` shape. + * */ export class ListProtectionsCommand extends $Command< ListProtectionsCommandInput, diff --git a/clients/client-shield/commands/ListResourcesInProtectionGroupCommand.ts b/clients/client-shield/commands/ListResourcesInProtectionGroupCommand.ts index 74724045be4d..7765eee5ec7e 100644 --- a/clients/client-shield/commands/ListResourcesInProtectionGroupCommand.ts +++ b/clients/client-shield/commands/ListResourcesInProtectionGroupCommand.ts @@ -24,6 +24,20 @@ export interface ListResourcesInProtectionGroupCommandOutput /** *

Retrieves the resources that are included in the protection group.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ShieldClient, ListResourcesInProtectionGroupCommand } from "@aws-sdk/client-shield"; // ES Modules import + * // const { ShieldClient, ListResourcesInProtectionGroupCommand } = require("@aws-sdk/client-shield"); // CommonJS import + * const client = new ShieldClient(config); + * const command = new ListResourcesInProtectionGroupCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListResourcesInProtectionGroupCommandInput} for command's `input` shape. + * @see {@link ListResourcesInProtectionGroupCommandOutput} for command's `response` shape. + * @see {@link ShieldClientResolvedConfig | config} for command's `input` shape. + * */ export class ListResourcesInProtectionGroupCommand extends $Command< ListResourcesInProtectionGroupCommandInput, diff --git a/clients/client-shield/commands/ListTagsForResourceCommand.ts b/clients/client-shield/commands/ListTagsForResourceCommand.ts index c6998e108f91..6876188cfa50 100644 --- a/clients/client-shield/commands/ListTagsForResourceCommand.ts +++ b/clients/client-shield/commands/ListTagsForResourceCommand.ts @@ -22,6 +22,20 @@ export interface ListTagsForResourceCommandOutput extends ListTagsForResourceRes /** *

Gets information about AWS tags for a specified Amazon Resource Name (ARN) in AWS Shield.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ShieldClient, ListTagsForResourceCommand } from "@aws-sdk/client-shield"; // ES Modules import + * // const { ShieldClient, ListTagsForResourceCommand } = require("@aws-sdk/client-shield"); // CommonJS import + * const client = new ShieldClient(config); + * const command = new ListTagsForResourceCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListTagsForResourceCommandInput} for command's `input` shape. + * @see {@link ListTagsForResourceCommandOutput} for command's `response` shape. + * @see {@link ShieldClientResolvedConfig | config} for command's `input` shape. + * */ export class ListTagsForResourceCommand extends $Command< ListTagsForResourceCommandInput, diff --git a/clients/client-shield/commands/TagResourceCommand.ts b/clients/client-shield/commands/TagResourceCommand.ts index 15077919a355..b2e8e04fd9be 100644 --- a/clients/client-shield/commands/TagResourceCommand.ts +++ b/clients/client-shield/commands/TagResourceCommand.ts @@ -22,6 +22,20 @@ export interface TagResourceCommandOutput extends TagResourceResponse, __Metadat /** *

Adds or updates tags for a resource in AWS Shield.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ShieldClient, TagResourceCommand } from "@aws-sdk/client-shield"; // ES Modules import + * // const { ShieldClient, TagResourceCommand } = require("@aws-sdk/client-shield"); // CommonJS import + * const client = new ShieldClient(config); + * const command = new TagResourceCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link TagResourceCommandInput} for command's `input` shape. + * @see {@link TagResourceCommandOutput} for command's `response` shape. + * @see {@link ShieldClientResolvedConfig | config} for command's `input` shape. + * */ export class TagResourceCommand extends $Command< TagResourceCommandInput, diff --git a/clients/client-shield/commands/UntagResourceCommand.ts b/clients/client-shield/commands/UntagResourceCommand.ts index 94a0cf928bec..a12ced347023 100644 --- a/clients/client-shield/commands/UntagResourceCommand.ts +++ b/clients/client-shield/commands/UntagResourceCommand.ts @@ -22,6 +22,20 @@ export interface UntagResourceCommandOutput extends UntagResourceResponse, __Met /** *

Removes tags from a resource in AWS Shield.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ShieldClient, UntagResourceCommand } from "@aws-sdk/client-shield"; // ES Modules import + * // const { ShieldClient, UntagResourceCommand } = require("@aws-sdk/client-shield"); // CommonJS import + * const client = new ShieldClient(config); + * const command = new UntagResourceCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link UntagResourceCommandInput} for command's `input` shape. + * @see {@link UntagResourceCommandOutput} for command's `response` shape. + * @see {@link ShieldClientResolvedConfig | config} for command's `input` shape. + * */ export class UntagResourceCommand extends $Command< UntagResourceCommandInput, diff --git a/clients/client-shield/commands/UpdateEmergencyContactSettingsCommand.ts b/clients/client-shield/commands/UpdateEmergencyContactSettingsCommand.ts index 66d97003150c..68d1f2bf9ca3 100644 --- a/clients/client-shield/commands/UpdateEmergencyContactSettingsCommand.ts +++ b/clients/client-shield/commands/UpdateEmergencyContactSettingsCommand.ts @@ -24,6 +24,20 @@ export interface UpdateEmergencyContactSettingsCommandOutput /** *

Updates the details of the list of email addresses and phone numbers that the DDoS Response Team (DRT) can use to contact you if you have proactive engagement enabled, for escalations to the DRT and to initiate proactive customer support.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ShieldClient, UpdateEmergencyContactSettingsCommand } from "@aws-sdk/client-shield"; // ES Modules import + * // const { ShieldClient, UpdateEmergencyContactSettingsCommand } = require("@aws-sdk/client-shield"); // CommonJS import + * const client = new ShieldClient(config); + * const command = new UpdateEmergencyContactSettingsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link UpdateEmergencyContactSettingsCommandInput} for command's `input` shape. + * @see {@link UpdateEmergencyContactSettingsCommandOutput} for command's `response` shape. + * @see {@link ShieldClientResolvedConfig | config} for command's `input` shape. + * */ export class UpdateEmergencyContactSettingsCommand extends $Command< UpdateEmergencyContactSettingsCommandInput, diff --git a/clients/client-shield/commands/UpdateProtectionGroupCommand.ts b/clients/client-shield/commands/UpdateProtectionGroupCommand.ts index f1dd8934e63a..42405f3e8266 100644 --- a/clients/client-shield/commands/UpdateProtectionGroupCommand.ts +++ b/clients/client-shield/commands/UpdateProtectionGroupCommand.ts @@ -22,6 +22,20 @@ export interface UpdateProtectionGroupCommandOutput extends UpdateProtectionGrou /** *

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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ShieldClient, UpdateProtectionGroupCommand } from "@aws-sdk/client-shield"; // ES Modules import + * // const { ShieldClient, UpdateProtectionGroupCommand } = require("@aws-sdk/client-shield"); // CommonJS import + * const client = new ShieldClient(config); + * const command = new UpdateProtectionGroupCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link UpdateProtectionGroupCommandInput} for command's `input` shape. + * @see {@link UpdateProtectionGroupCommandOutput} for command's `response` shape. + * @see {@link ShieldClientResolvedConfig | config} for command's `input` shape. + * */ export class UpdateProtectionGroupCommand extends $Command< UpdateProtectionGroupCommandInput, diff --git a/clients/client-shield/commands/UpdateSubscriptionCommand.ts b/clients/client-shield/commands/UpdateSubscriptionCommand.ts index 98e86e439355..e55747ff2549 100644 --- a/clients/client-shield/commands/UpdateSubscriptionCommand.ts +++ b/clients/client-shield/commands/UpdateSubscriptionCommand.ts @@ -22,6 +22,20 @@ export interface UpdateSubscriptionCommandOutput extends UpdateSubscriptionRespo /** *

Updates the details of an existing subscription. Only enter values for parameters you want to change. Empty parameters are not updated.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ShieldClient, UpdateSubscriptionCommand } from "@aws-sdk/client-shield"; // ES Modules import + * // const { ShieldClient, UpdateSubscriptionCommand } = require("@aws-sdk/client-shield"); // CommonJS import + * const client = new ShieldClient(config); + * const command = new UpdateSubscriptionCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link UpdateSubscriptionCommandInput} for command's `input` shape. + * @see {@link UpdateSubscriptionCommandOutput} for command's `response` shape. + * @see {@link ShieldClientResolvedConfig | config} for command's `input` shape. + * */ export class UpdateSubscriptionCommand extends $Command< UpdateSubscriptionCommandInput, diff --git a/clients/client-shield/models/models_0.ts b/clients/client-shield/models/models_0.ts index 3ac0bfd008a9..ab01964c4ce1 100644 --- a/clients/client-shield/models/models_0.ts +++ b/clients/client-shield/models/models_0.ts @@ -11,6 +11,9 @@ export interface AccessDeniedException extends __SmithyException, $MetadataBeare } export namespace AccessDeniedException { + /** + * @internal + */ export const filterSensitiveLog = (obj: AccessDeniedException): any => ({ ...obj, }); @@ -26,6 +29,9 @@ export interface AccessDeniedForDependencyException extends __SmithyException, $ } export namespace AccessDeniedForDependencyException { + /** + * @internal + */ export const filterSensitiveLog = (obj: AccessDeniedForDependencyException): any => ({ ...obj, }); @@ -39,6 +45,9 @@ export interface AssociateDRTLogBucketRequest { } export namespace AssociateDRTLogBucketRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: AssociateDRTLogBucketRequest): any => ({ ...obj, }); @@ -47,6 +56,9 @@ export namespace AssociateDRTLogBucketRequest { export interface AssociateDRTLogBucketResponse {} export namespace AssociateDRTLogBucketResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: AssociateDRTLogBucketResponse): any => ({ ...obj, }); @@ -63,6 +75,9 @@ export interface InternalErrorException extends __SmithyException, $MetadataBear } export namespace InternalErrorException { + /** + * @internal + */ export const filterSensitiveLog = (obj: InternalErrorException): any => ({ ...obj, }); @@ -78,6 +93,9 @@ export interface InvalidOperationException extends __SmithyException, $MetadataB } export namespace InvalidOperationException { + /** + * @internal + */ export const filterSensitiveLog = (obj: InvalidOperationException): any => ({ ...obj, }); @@ -99,6 +117,9 @@ export interface ValidationExceptionField { } export namespace ValidationExceptionField { + /** + * @internal + */ export const filterSensitiveLog = (obj: ValidationExceptionField): any => ({ ...obj, }); @@ -128,6 +149,9 @@ export interface InvalidParameterException extends __SmithyException, $MetadataB } export namespace InvalidParameterException { + /** + * @internal + */ export const filterSensitiveLog = (obj: InvalidParameterException): any => ({ ...obj, }); @@ -152,6 +176,9 @@ export interface LimitsExceededException extends __SmithyException, $MetadataBea } export namespace LimitsExceededException { + /** + * @internal + */ export const filterSensitiveLog = (obj: LimitsExceededException): any => ({ ...obj, }); @@ -167,6 +194,9 @@ export interface NoAssociatedRoleException extends __SmithyException, $MetadataB } export namespace NoAssociatedRoleException { + /** + * @internal + */ export const filterSensitiveLog = (obj: NoAssociatedRoleException): any => ({ ...obj, }); @@ -183,6 +213,9 @@ export interface OptimisticLockException extends __SmithyException, $MetadataBea } export namespace OptimisticLockException { + /** + * @internal + */ export const filterSensitiveLog = (obj: OptimisticLockException): any => ({ ...obj, }); @@ -202,6 +235,9 @@ export interface ResourceNotFoundException extends __SmithyException, $MetadataB } export namespace ResourceNotFoundException { + /** + * @internal + */ export const filterSensitiveLog = (obj: ResourceNotFoundException): any => ({ ...obj, }); @@ -216,6 +252,9 @@ export interface AssociateDRTRoleRequest { } export namespace AssociateDRTRoleRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: AssociateDRTRoleRequest): any => ({ ...obj, }); @@ -224,6 +263,9 @@ export namespace AssociateDRTRoleRequest { export interface AssociateDRTRoleResponse {} export namespace AssociateDRTRoleResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: AssociateDRTRoleResponse): any => ({ ...obj, }); @@ -242,6 +284,9 @@ export interface AssociateHealthCheckRequest { } export namespace AssociateHealthCheckRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: AssociateHealthCheckRequest): any => ({ ...obj, }); @@ -250,6 +295,9 @@ export namespace AssociateHealthCheckRequest { export interface AssociateHealthCheckResponse {} export namespace AssociateHealthCheckResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: AssociateHealthCheckResponse): any => ({ ...obj, }); @@ -276,6 +324,9 @@ export interface EmergencyContact { } export namespace EmergencyContact { + /** + * @internal + */ export const filterSensitiveLog = (obj: EmergencyContact): any => ({ ...obj, }); @@ -293,6 +344,9 @@ export interface AssociateProactiveEngagementDetailsRequest { } export namespace AssociateProactiveEngagementDetailsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: AssociateProactiveEngagementDetailsRequest): any => ({ ...obj, }); @@ -301,6 +355,9 @@ export namespace AssociateProactiveEngagementDetailsRequest { export interface AssociateProactiveEngagementDetailsResponse {} export namespace AssociateProactiveEngagementDetailsResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: AssociateProactiveEngagementDetailsResponse): any => ({ ...obj, }); @@ -342,6 +399,9 @@ export interface SummarizedCounter { } export namespace SummarizedCounter { + /** + * @internal + */ export const filterSensitiveLog = (obj: SummarizedCounter): any => ({ ...obj, }); @@ -379,6 +439,9 @@ export interface Contributor { } export namespace Contributor { + /** + * @internal + */ export const filterSensitiveLog = (obj: Contributor): any => ({ ...obj, }); @@ -426,6 +489,9 @@ export interface AttackProperty { } export namespace AttackProperty { + /** + * @internal + */ export const filterSensitiveLog = (obj: AttackProperty): any => ({ ...obj, }); @@ -442,6 +508,9 @@ export interface Mitigation { } export namespace Mitigation { + /** + * @internal + */ export const filterSensitiveLog = (obj: Mitigation): any => ({ ...obj, }); @@ -463,6 +532,9 @@ export interface SummarizedAttackVector { } export namespace SummarizedAttackVector { + /** + * @internal + */ export const filterSensitiveLog = (obj: SummarizedAttackVector): any => ({ ...obj, }); @@ -499,6 +571,9 @@ export interface SubResourceSummary { } export namespace SubResourceSummary { + /** + * @internal + */ export const filterSensitiveLog = (obj: SubResourceSummary): any => ({ ...obj, }); @@ -550,6 +625,9 @@ export interface AttackDetail { } export namespace AttackDetail { + /** + * @internal + */ export const filterSensitiveLog = (obj: AttackDetail): any => ({ ...obj, }); @@ -566,6 +644,9 @@ export interface AttackVolumeStatistics { } export namespace AttackVolumeStatistics { + /** + * @internal + */ export const filterSensitiveLog = (obj: AttackVolumeStatistics): any => ({ ...obj, }); @@ -592,6 +673,9 @@ export interface AttackVolume { } export namespace AttackVolume { + /** + * @internal + */ export const filterSensitiveLog = (obj: AttackVolume): any => ({ ...obj, }); @@ -613,6 +697,9 @@ export interface AttackStatisticsDataItem { } export namespace AttackStatisticsDataItem { + /** + * @internal + */ export const filterSensitiveLog = (obj: AttackStatisticsDataItem): any => ({ ...obj, }); @@ -685,6 +772,9 @@ export interface AttackVectorDescription { } export namespace AttackVectorDescription { + /** + * @internal + */ export const filterSensitiveLog = (obj: AttackVectorDescription): any => ({ ...obj, }); @@ -721,6 +811,9 @@ export interface AttackSummary { } export namespace AttackSummary { + /** + * @internal + */ export const filterSensitiveLog = (obj: AttackSummary): any => ({ ...obj, }); @@ -747,6 +840,9 @@ export interface Tag { } export namespace Tag { + /** + * @internal + */ export const filterSensitiveLog = (obj: Tag): any => ({ ...obj, }); @@ -803,6 +899,9 @@ export interface CreateProtectionRequest { } export namespace CreateProtectionRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateProtectionRequest): any => ({ ...obj, }); @@ -816,6 +915,9 @@ export interface CreateProtectionResponse { } export namespace CreateProtectionResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateProtectionResponse): any => ({ ...obj, }); @@ -831,6 +933,9 @@ export interface InvalidResourceException extends __SmithyException, $MetadataBe } export namespace InvalidResourceException { + /** + * @internal + */ export const filterSensitiveLog = (obj: InvalidResourceException): any => ({ ...obj, }); @@ -850,6 +955,9 @@ export interface ResourceAlreadyExistsException extends __SmithyException, $Meta } export namespace ResourceAlreadyExistsException { + /** + * @internal + */ export const filterSensitiveLog = (obj: ResourceAlreadyExistsException): any => ({ ...obj, }); @@ -921,6 +1029,9 @@ export interface CreateProtectionGroupRequest { } export namespace CreateProtectionGroupRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateProtectionGroupRequest): any => ({ ...obj, }); @@ -929,6 +1040,9 @@ export namespace CreateProtectionGroupRequest { export interface CreateProtectionGroupResponse {} export namespace CreateProtectionGroupResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateProtectionGroupResponse): any => ({ ...obj, }); @@ -937,6 +1051,9 @@ export namespace CreateProtectionGroupResponse { export interface CreateSubscriptionRequest {} export namespace CreateSubscriptionRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateSubscriptionRequest): any => ({ ...obj, }); @@ -945,6 +1062,9 @@ export namespace CreateSubscriptionRequest { export interface CreateSubscriptionResponse {} export namespace CreateSubscriptionResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateSubscriptionResponse): any => ({ ...obj, }); @@ -959,6 +1079,9 @@ export interface DeleteProtectionRequest { } export namespace DeleteProtectionRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteProtectionRequest): any => ({ ...obj, }); @@ -967,6 +1090,9 @@ export namespace DeleteProtectionRequest { export interface DeleteProtectionResponse {} export namespace DeleteProtectionResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteProtectionResponse): any => ({ ...obj, }); @@ -980,6 +1106,9 @@ export interface DeleteProtectionGroupRequest { } export namespace DeleteProtectionGroupRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteProtectionGroupRequest): any => ({ ...obj, }); @@ -988,6 +1117,9 @@ export namespace DeleteProtectionGroupRequest { export interface DeleteProtectionGroupResponse {} export namespace DeleteProtectionGroupResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteProtectionGroupResponse): any => ({ ...obj, }); @@ -996,6 +1128,9 @@ export namespace DeleteProtectionGroupResponse { export interface DeleteSubscriptionRequest {} export namespace DeleteSubscriptionRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteSubscriptionRequest): any => ({ ...obj, }); @@ -1004,6 +1139,9 @@ export namespace DeleteSubscriptionRequest { export interface DeleteSubscriptionResponse {} export namespace DeleteSubscriptionResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteSubscriptionResponse): any => ({ ...obj, }); @@ -1019,6 +1157,9 @@ export interface LockedSubscriptionException extends __SmithyException, $Metadat } export namespace LockedSubscriptionException { + /** + * @internal + */ export const filterSensitiveLog = (obj: LockedSubscriptionException): any => ({ ...obj, }); @@ -1032,6 +1173,9 @@ export interface DescribeAttackRequest { } export namespace DescribeAttackRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeAttackRequest): any => ({ ...obj, }); @@ -1045,6 +1189,9 @@ export interface DescribeAttackResponse { } export namespace DescribeAttackResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeAttackResponse): any => ({ ...obj, }); @@ -1053,6 +1200,9 @@ export namespace DescribeAttackResponse { export interface DescribeAttackStatisticsRequest {} export namespace DescribeAttackStatisticsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeAttackStatisticsRequest): any => ({ ...obj, }); @@ -1074,6 +1224,9 @@ export interface TimeRange { } export namespace TimeRange { + /** + * @internal + */ export const filterSensitiveLog = (obj: TimeRange): any => ({ ...obj, }); @@ -1092,6 +1245,9 @@ export interface DescribeAttackStatisticsResponse { } export namespace DescribeAttackStatisticsResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeAttackStatisticsResponse): any => ({ ...obj, }); @@ -1100,6 +1256,9 @@ export namespace DescribeAttackStatisticsResponse { export interface DescribeDRTAccessRequest {} export namespace DescribeDRTAccessRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeDRTAccessRequest): any => ({ ...obj, }); @@ -1118,6 +1277,9 @@ export interface DescribeDRTAccessResponse { } export namespace DescribeDRTAccessResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeDRTAccessResponse): any => ({ ...obj, }); @@ -1126,6 +1288,9 @@ export namespace DescribeDRTAccessResponse { export interface DescribeEmergencyContactSettingsRequest {} export namespace DescribeEmergencyContactSettingsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeEmergencyContactSettingsRequest): any => ({ ...obj, }); @@ -1139,6 +1304,9 @@ export interface DescribeEmergencyContactSettingsResponse { } export namespace DescribeEmergencyContactSettingsResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeEmergencyContactSettingsResponse): any => ({ ...obj, }); @@ -1159,6 +1327,9 @@ export interface DescribeProtectionRequest { } export namespace DescribeProtectionRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeProtectionRequest): any => ({ ...obj, }); @@ -1195,6 +1366,9 @@ export interface Protection { } export namespace Protection { + /** + * @internal + */ export const filterSensitiveLog = (obj: Protection): any => ({ ...obj, }); @@ -1208,6 +1382,9 @@ export interface DescribeProtectionResponse { } export namespace DescribeProtectionResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeProtectionResponse): any => ({ ...obj, }); @@ -1221,6 +1398,9 @@ export interface DescribeProtectionGroupRequest { } export namespace DescribeProtectionGroupRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeProtectionGroupRequest): any => ({ ...obj, }); @@ -1274,6 +1454,9 @@ export interface ProtectionGroup { } export namespace ProtectionGroup { + /** + * @internal + */ export const filterSensitiveLog = (obj: ProtectionGroup): any => ({ ...obj, }); @@ -1287,6 +1470,9 @@ export interface DescribeProtectionGroupResponse { } export namespace DescribeProtectionGroupResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeProtectionGroupResponse): any => ({ ...obj, }); @@ -1295,6 +1481,9 @@ export namespace DescribeProtectionGroupResponse { export interface DescribeSubscriptionRequest {} export namespace DescribeSubscriptionRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeSubscriptionRequest): any => ({ ...obj, }); @@ -1316,6 +1505,9 @@ export interface Limit { } export namespace Limit { + /** + * @internal + */ export const filterSensitiveLog = (obj: Limit): any => ({ ...obj, }); @@ -1338,6 +1530,9 @@ export interface ProtectionGroupArbitraryPatternLimits { } export namespace ProtectionGroupArbitraryPatternLimits { + /** + * @internal + */ export const filterSensitiveLog = (obj: ProtectionGroupArbitraryPatternLimits): any => ({ ...obj, }); @@ -1354,6 +1549,9 @@ export interface ProtectionGroupPatternTypeLimits { } export namespace ProtectionGroupPatternTypeLimits { + /** + * @internal + */ export const filterSensitiveLog = (obj: ProtectionGroupPatternTypeLimits): any => ({ ...obj, }); @@ -1375,6 +1573,9 @@ export interface ProtectionGroupLimits { } export namespace ProtectionGroupLimits { + /** + * @internal + */ export const filterSensitiveLog = (obj: ProtectionGroupLimits): any => ({ ...obj, }); @@ -1391,6 +1592,9 @@ export interface ProtectionLimits { } export namespace ProtectionLimits { + /** + * @internal + */ export const filterSensitiveLog = (obj: ProtectionLimits): any => ({ ...obj, }); @@ -1412,6 +1616,9 @@ export interface SubscriptionLimits { } export namespace SubscriptionLimits { + /** + * @internal + */ export const filterSensitiveLog = (obj: SubscriptionLimits): any => ({ ...obj, }); @@ -1466,6 +1673,9 @@ export interface Subscription { } export namespace Subscription { + /** + * @internal + */ export const filterSensitiveLog = (obj: Subscription): any => ({ ...obj, }); @@ -1479,6 +1689,9 @@ export interface DescribeSubscriptionResponse { } export namespace DescribeSubscriptionResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeSubscriptionResponse): any => ({ ...obj, }); @@ -1487,6 +1700,9 @@ export namespace DescribeSubscriptionResponse { export interface DisableProactiveEngagementRequest {} export namespace DisableProactiveEngagementRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DisableProactiveEngagementRequest): any => ({ ...obj, }); @@ -1495,6 +1711,9 @@ export namespace DisableProactiveEngagementRequest { export interface DisableProactiveEngagementResponse {} export namespace DisableProactiveEngagementResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DisableProactiveEngagementResponse): any => ({ ...obj, }); @@ -1508,6 +1727,9 @@ export interface DisassociateDRTLogBucketRequest { } export namespace DisassociateDRTLogBucketRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DisassociateDRTLogBucketRequest): any => ({ ...obj, }); @@ -1516,6 +1738,9 @@ export namespace DisassociateDRTLogBucketRequest { export interface DisassociateDRTLogBucketResponse {} export namespace DisassociateDRTLogBucketResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DisassociateDRTLogBucketResponse): any => ({ ...obj, }); @@ -1524,6 +1749,9 @@ export namespace DisassociateDRTLogBucketResponse { export interface DisassociateDRTRoleRequest {} export namespace DisassociateDRTRoleRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DisassociateDRTRoleRequest): any => ({ ...obj, }); @@ -1532,6 +1760,9 @@ export namespace DisassociateDRTRoleRequest { export interface DisassociateDRTRoleResponse {} export namespace DisassociateDRTRoleResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DisassociateDRTRoleResponse): any => ({ ...obj, }); @@ -1550,6 +1781,9 @@ export interface DisassociateHealthCheckRequest { } export namespace DisassociateHealthCheckRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DisassociateHealthCheckRequest): any => ({ ...obj, }); @@ -1558,6 +1792,9 @@ export namespace DisassociateHealthCheckRequest { export interface DisassociateHealthCheckResponse {} export namespace DisassociateHealthCheckResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DisassociateHealthCheckResponse): any => ({ ...obj, }); @@ -1566,6 +1803,9 @@ export namespace DisassociateHealthCheckResponse { export interface EnableProactiveEngagementRequest {} export namespace EnableProactiveEngagementRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: EnableProactiveEngagementRequest): any => ({ ...obj, }); @@ -1574,6 +1814,9 @@ export namespace EnableProactiveEngagementRequest { export interface EnableProactiveEngagementResponse {} export namespace EnableProactiveEngagementResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: EnableProactiveEngagementResponse): any => ({ ...obj, }); @@ -1582,6 +1825,9 @@ export namespace EnableProactiveEngagementResponse { export interface GetSubscriptionStateRequest {} export namespace GetSubscriptionStateRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetSubscriptionStateRequest): any => ({ ...obj, }); @@ -1600,6 +1846,9 @@ export interface GetSubscriptionStateResponse { } export namespace GetSubscriptionStateResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetSubscriptionStateResponse): any => ({ ...obj, }); @@ -1636,6 +1885,9 @@ export interface ListAttacksRequest { } export namespace ListAttacksRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListAttacksRequest): any => ({ ...obj, }); @@ -1658,6 +1910,9 @@ export interface ListAttacksResponse { } export namespace ListAttacksResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListAttacksResponse): any => ({ ...obj, }); @@ -1673,6 +1928,9 @@ export interface InvalidPaginationTokenException extends __SmithyException, $Met } export namespace InvalidPaginationTokenException { + /** + * @internal + */ export const filterSensitiveLog = (obj: InvalidPaginationTokenException): any => ({ ...obj, }); @@ -1693,6 +1951,9 @@ export interface ListProtectionGroupsRequest { } export namespace ListProtectionGroupsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListProtectionGroupsRequest): any => ({ ...obj, }); @@ -1711,6 +1972,9 @@ export interface ListProtectionGroupsResponse { } export namespace ListProtectionGroupsResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListProtectionGroupsResponse): any => ({ ...obj, }); @@ -1731,6 +1995,9 @@ export interface ListProtectionsRequest { } export namespace ListProtectionsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListProtectionsRequest): any => ({ ...obj, }); @@ -1750,6 +2017,9 @@ export interface ListProtectionsResponse { } export namespace ListProtectionsResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListProtectionsResponse): any => ({ ...obj, }); @@ -1775,6 +2045,9 @@ export interface ListResourcesInProtectionGroupRequest { } export namespace ListResourcesInProtectionGroupRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListResourcesInProtectionGroupRequest): any => ({ ...obj, }); @@ -1793,6 +2066,9 @@ export interface ListResourcesInProtectionGroupResponse { } export namespace ListResourcesInProtectionGroupResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListResourcesInProtectionGroupResponse): any => ({ ...obj, }); @@ -1806,6 +2082,9 @@ export interface ListTagsForResourceRequest { } export namespace ListTagsForResourceRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListTagsForResourceRequest): any => ({ ...obj, }); @@ -1819,6 +2098,9 @@ export interface ListTagsForResourceResponse { } export namespace ListTagsForResourceResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListTagsForResourceResponse): any => ({ ...obj, }); @@ -1837,6 +2119,9 @@ export interface TagResourceRequest { } export namespace TagResourceRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: TagResourceRequest): any => ({ ...obj, }); @@ -1845,6 +2130,9 @@ export namespace TagResourceRequest { export interface TagResourceResponse {} export namespace TagResourceResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: TagResourceResponse): any => ({ ...obj, }); @@ -1863,6 +2151,9 @@ export interface UntagResourceRequest { } export namespace UntagResourceRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: UntagResourceRequest): any => ({ ...obj, }); @@ -1871,6 +2162,9 @@ export namespace UntagResourceRequest { export interface UntagResourceResponse {} export namespace UntagResourceResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: UntagResourceResponse): any => ({ ...obj, }); @@ -1885,6 +2179,9 @@ export interface UpdateEmergencyContactSettingsRequest { } export namespace UpdateEmergencyContactSettingsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateEmergencyContactSettingsRequest): any => ({ ...obj, }); @@ -1893,6 +2190,9 @@ export namespace UpdateEmergencyContactSettingsRequest { export interface UpdateEmergencyContactSettingsResponse {} export namespace UpdateEmergencyContactSettingsResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateEmergencyContactSettingsResponse): any => ({ ...obj, }); @@ -1938,6 +2238,9 @@ export interface UpdateProtectionGroupRequest { } export namespace UpdateProtectionGroupRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateProtectionGroupRequest): any => ({ ...obj, }); @@ -1946,6 +2249,9 @@ export namespace UpdateProtectionGroupRequest { export interface UpdateProtectionGroupResponse {} export namespace UpdateProtectionGroupResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateProtectionGroupResponse): any => ({ ...obj, }); @@ -1959,6 +2265,9 @@ export interface UpdateSubscriptionRequest { } export namespace UpdateSubscriptionRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateSubscriptionRequest): any => ({ ...obj, }); @@ -1967,6 +2276,9 @@ export namespace UpdateSubscriptionRequest { export interface UpdateSubscriptionResponse {} export namespace UpdateSubscriptionResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateSubscriptionResponse): any => ({ ...obj, }); diff --git a/clients/client-signer/commands/AddProfilePermissionCommand.ts b/clients/client-signer/commands/AddProfilePermissionCommand.ts index f3f7d30c958b..8f9a5398c6de 100644 --- a/clients/client-signer/commands/AddProfilePermissionCommand.ts +++ b/clients/client-signer/commands/AddProfilePermissionCommand.ts @@ -22,6 +22,20 @@ export interface AddProfilePermissionCommandOutput extends AddProfilePermissionR /** *

Adds cross-account permissions to a signing profile.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { SignerClient, AddProfilePermissionCommand } from "@aws-sdk/client-signer"; // ES Modules import + * // const { SignerClient, AddProfilePermissionCommand } = require("@aws-sdk/client-signer"); // CommonJS import + * const client = new SignerClient(config); + * const command = new AddProfilePermissionCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link AddProfilePermissionCommandInput} for command's `input` shape. + * @see {@link AddProfilePermissionCommandOutput} for command's `response` shape. + * @see {@link SignerClientResolvedConfig | config} for command's `input` shape. + * */ export class AddProfilePermissionCommand extends $Command< AddProfilePermissionCommandInput, diff --git a/clients/client-signer/commands/CancelSigningProfileCommand.ts b/clients/client-signer/commands/CancelSigningProfileCommand.ts index ff563d53d1af..028b36ae3132 100644 --- a/clients/client-signer/commands/CancelSigningProfileCommand.ts +++ b/clients/client-signer/commands/CancelSigningProfileCommand.ts @@ -25,6 +25,20 @@ export interface CancelSigningProfileCommandOutput extends __MetadataBearer {} * A canceled profile is still viewable with the ListSigningProfiles * operation, but it cannot perform new signing jobs, and is deleted two years after * cancelation.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { SignerClient, CancelSigningProfileCommand } from "@aws-sdk/client-signer"; // ES Modules import + * // const { SignerClient, CancelSigningProfileCommand } = require("@aws-sdk/client-signer"); // CommonJS import + * const client = new SignerClient(config); + * const command = new CancelSigningProfileCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CancelSigningProfileCommandInput} for command's `input` shape. + * @see {@link CancelSigningProfileCommandOutput} for command's `response` shape. + * @see {@link SignerClientResolvedConfig | config} for command's `input` shape. + * */ export class CancelSigningProfileCommand extends $Command< CancelSigningProfileCommandInput, diff --git a/clients/client-signer/commands/DescribeSigningJobCommand.ts b/clients/client-signer/commands/DescribeSigningJobCommand.ts index b1070af4d963..77666b04e21e 100644 --- a/clients/client-signer/commands/DescribeSigningJobCommand.ts +++ b/clients/client-signer/commands/DescribeSigningJobCommand.ts @@ -24,6 +24,20 @@ export interface DescribeSigningJobCommandOutput extends DescribeSigningJobRespo *

Returns information about a specific code signing job. You specify the job by using * the jobId value that is returned by the StartSigningJob * operation.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { SignerClient, DescribeSigningJobCommand } from "@aws-sdk/client-signer"; // ES Modules import + * // const { SignerClient, DescribeSigningJobCommand } = require("@aws-sdk/client-signer"); // CommonJS import + * const client = new SignerClient(config); + * const command = new DescribeSigningJobCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeSigningJobCommandInput} for command's `input` shape. + * @see {@link DescribeSigningJobCommandOutput} for command's `response` shape. + * @see {@link SignerClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeSigningJobCommand extends $Command< DescribeSigningJobCommandInput, diff --git a/clients/client-signer/commands/GetSigningPlatformCommand.ts b/clients/client-signer/commands/GetSigningPlatformCommand.ts index 75c50c1f3bf0..ba7156119269 100644 --- a/clients/client-signer/commands/GetSigningPlatformCommand.ts +++ b/clients/client-signer/commands/GetSigningPlatformCommand.ts @@ -22,6 +22,20 @@ export interface GetSigningPlatformCommandOutput extends GetSigningPlatformRespo /** *

Returns information on a specific signing platform.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { SignerClient, GetSigningPlatformCommand } from "@aws-sdk/client-signer"; // ES Modules import + * // const { SignerClient, GetSigningPlatformCommand } = require("@aws-sdk/client-signer"); // CommonJS import + * const client = new SignerClient(config); + * const command = new GetSigningPlatformCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetSigningPlatformCommandInput} for command's `input` shape. + * @see {@link GetSigningPlatformCommandOutput} for command's `response` shape. + * @see {@link SignerClientResolvedConfig | config} for command's `input` shape. + * */ export class GetSigningPlatformCommand extends $Command< GetSigningPlatformCommandInput, diff --git a/clients/client-signer/commands/GetSigningProfileCommand.ts b/clients/client-signer/commands/GetSigningProfileCommand.ts index 54bf0f5cabc3..95e3381f3dab 100644 --- a/clients/client-signer/commands/GetSigningProfileCommand.ts +++ b/clients/client-signer/commands/GetSigningProfileCommand.ts @@ -22,6 +22,20 @@ export interface GetSigningProfileCommandOutput extends GetSigningProfileRespons /** *

Returns information on a specific signing profile.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { SignerClient, GetSigningProfileCommand } from "@aws-sdk/client-signer"; // ES Modules import + * // const { SignerClient, GetSigningProfileCommand } = require("@aws-sdk/client-signer"); // CommonJS import + * const client = new SignerClient(config); + * const command = new GetSigningProfileCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetSigningProfileCommandInput} for command's `input` shape. + * @see {@link GetSigningProfileCommandOutput} for command's `response` shape. + * @see {@link SignerClientResolvedConfig | config} for command's `input` shape. + * */ export class GetSigningProfileCommand extends $Command< GetSigningProfileCommandInput, diff --git a/clients/client-signer/commands/ListProfilePermissionsCommand.ts b/clients/client-signer/commands/ListProfilePermissionsCommand.ts index b3a6d71cfcce..657c17710b2b 100644 --- a/clients/client-signer/commands/ListProfilePermissionsCommand.ts +++ b/clients/client-signer/commands/ListProfilePermissionsCommand.ts @@ -22,6 +22,20 @@ export interface ListProfilePermissionsCommandOutput extends ListProfilePermissi /** *

Lists the cross-account permissions associated with a signing profile.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { SignerClient, ListProfilePermissionsCommand } from "@aws-sdk/client-signer"; // ES Modules import + * // const { SignerClient, ListProfilePermissionsCommand } = require("@aws-sdk/client-signer"); // CommonJS import + * const client = new SignerClient(config); + * const command = new ListProfilePermissionsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListProfilePermissionsCommandInput} for command's `input` shape. + * @see {@link ListProfilePermissionsCommandOutput} for command's `response` shape. + * @see {@link SignerClientResolvedConfig | config} for command's `input` shape. + * */ export class ListProfilePermissionsCommand extends $Command< ListProfilePermissionsCommandInput, diff --git a/clients/client-signer/commands/ListSigningJobsCommand.ts b/clients/client-signer/commands/ListSigningJobsCommand.ts index 636894aedd75..ec332e544d08 100644 --- a/clients/client-signer/commands/ListSigningJobsCommand.ts +++ b/clients/client-signer/commands/ListSigningJobsCommand.ts @@ -28,6 +28,20 @@ export interface ListSigningJobsCommandOutput extends ListSigningJobsResponse, _ * 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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { SignerClient, ListSigningJobsCommand } from "@aws-sdk/client-signer"; // ES Modules import + * // const { SignerClient, ListSigningJobsCommand } = require("@aws-sdk/client-signer"); // CommonJS import + * const client = new SignerClient(config); + * const command = new ListSigningJobsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListSigningJobsCommandInput} for command's `input` shape. + * @see {@link ListSigningJobsCommandOutput} for command's `response` shape. + * @see {@link SignerClientResolvedConfig | config} for command's `input` shape. + * */ export class ListSigningJobsCommand extends $Command< ListSigningJobsCommandInput, diff --git a/clients/client-signer/commands/ListSigningPlatformsCommand.ts b/clients/client-signer/commands/ListSigningPlatformsCommand.ts index 56d4d2fa7dbc..1ea4f57ac26f 100644 --- a/clients/client-signer/commands/ListSigningPlatformsCommand.ts +++ b/clients/client-signer/commands/ListSigningPlatformsCommand.ts @@ -28,6 +28,20 @@ export interface ListSigningPlatformsCommandOutput extends ListSigningPlatformsR * maxResults parameter and with new values that code signing returns in the * nextToken parameter until all of your signing jobs have been * returned.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { SignerClient, ListSigningPlatformsCommand } from "@aws-sdk/client-signer"; // ES Modules import + * // const { SignerClient, ListSigningPlatformsCommand } = require("@aws-sdk/client-signer"); // CommonJS import + * const client = new SignerClient(config); + * const command = new ListSigningPlatformsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListSigningPlatformsCommandInput} for command's `input` shape. + * @see {@link ListSigningPlatformsCommandOutput} for command's `response` shape. + * @see {@link SignerClientResolvedConfig | config} for command's `input` shape. + * */ export class ListSigningPlatformsCommand extends $Command< ListSigningPlatformsCommandInput, diff --git a/clients/client-signer/commands/ListSigningProfilesCommand.ts b/clients/client-signer/commands/ListSigningProfilesCommand.ts index 50f8891d3025..6c9efd0e94fb 100644 --- a/clients/client-signer/commands/ListSigningProfilesCommand.ts +++ b/clients/client-signer/commands/ListSigningProfilesCommand.ts @@ -29,6 +29,20 @@ export interface ListSigningProfilesCommandOutput extends ListSigningProfilesRes * 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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { SignerClient, ListSigningProfilesCommand } from "@aws-sdk/client-signer"; // ES Modules import + * // const { SignerClient, ListSigningProfilesCommand } = require("@aws-sdk/client-signer"); // CommonJS import + * const client = new SignerClient(config); + * const command = new ListSigningProfilesCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListSigningProfilesCommandInput} for command's `input` shape. + * @see {@link ListSigningProfilesCommandOutput} for command's `response` shape. + * @see {@link SignerClientResolvedConfig | config} for command's `input` shape. + * */ export class ListSigningProfilesCommand extends $Command< ListSigningProfilesCommandInput, diff --git a/clients/client-signer/commands/ListTagsForResourceCommand.ts b/clients/client-signer/commands/ListTagsForResourceCommand.ts index 8b45ebd81bc5..416ff49c9219 100644 --- a/clients/client-signer/commands/ListTagsForResourceCommand.ts +++ b/clients/client-signer/commands/ListTagsForResourceCommand.ts @@ -22,6 +22,20 @@ export interface ListTagsForResourceCommandOutput extends ListTagsForResourceRes /** *

Returns a list of the tags associated with a signing profile resource.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { SignerClient, ListTagsForResourceCommand } from "@aws-sdk/client-signer"; // ES Modules import + * // const { SignerClient, ListTagsForResourceCommand } = require("@aws-sdk/client-signer"); // CommonJS import + * const client = new SignerClient(config); + * const command = new ListTagsForResourceCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListTagsForResourceCommandInput} for command's `input` shape. + * @see {@link ListTagsForResourceCommandOutput} for command's `response` shape. + * @see {@link SignerClientResolvedConfig | config} for command's `input` shape. + * */ export class ListTagsForResourceCommand extends $Command< ListTagsForResourceCommandInput, diff --git a/clients/client-signer/commands/PutSigningProfileCommand.ts b/clients/client-signer/commands/PutSigningProfileCommand.ts index b9e174d76fde..953ec2f12f6b 100644 --- a/clients/client-signer/commands/PutSigningProfileCommand.ts +++ b/clients/client-signer/commands/PutSigningProfileCommand.ts @@ -24,6 +24,20 @@ export interface PutSigningProfileCommandOutput extends PutSigningProfileRespons *

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 *

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { SignerClient, PutSigningProfileCommand } from "@aws-sdk/client-signer"; // ES Modules import + * // const { SignerClient, PutSigningProfileCommand } = require("@aws-sdk/client-signer"); // CommonJS import + * const client = new SignerClient(config); + * const command = new PutSigningProfileCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link PutSigningProfileCommandInput} for command's `input` shape. + * @see {@link PutSigningProfileCommandOutput} for command's `response` shape. + * @see {@link SignerClientResolvedConfig | config} for command's `input` shape. + * */ export class PutSigningProfileCommand extends $Command< PutSigningProfileCommandInput, diff --git a/clients/client-signer/commands/RemoveProfilePermissionCommand.ts b/clients/client-signer/commands/RemoveProfilePermissionCommand.ts index ad102b89b5e0..b42c1f0be08b 100644 --- a/clients/client-signer/commands/RemoveProfilePermissionCommand.ts +++ b/clients/client-signer/commands/RemoveProfilePermissionCommand.ts @@ -22,6 +22,20 @@ export interface RemoveProfilePermissionCommandOutput extends RemoveProfilePermi /** *

Removes cross-account permissions from a signing profile.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { SignerClient, RemoveProfilePermissionCommand } from "@aws-sdk/client-signer"; // ES Modules import + * // const { SignerClient, RemoveProfilePermissionCommand } = require("@aws-sdk/client-signer"); // CommonJS import + * const client = new SignerClient(config); + * const command = new RemoveProfilePermissionCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link RemoveProfilePermissionCommandInput} for command's `input` shape. + * @see {@link RemoveProfilePermissionCommandOutput} for command's `response` shape. + * @see {@link SignerClientResolvedConfig | config} for command's `input` shape. + * */ export class RemoveProfilePermissionCommand extends $Command< RemoveProfilePermissionCommandInput, diff --git a/clients/client-signer/commands/RevokeSignatureCommand.ts b/clients/client-signer/commands/RevokeSignatureCommand.ts index 3cd8163e08d3..e9991f9169bd 100644 --- a/clients/client-signer/commands/RevokeSignatureCommand.ts +++ b/clients/client-signer/commands/RevokeSignatureCommand.ts @@ -23,6 +23,20 @@ export interface RevokeSignatureCommandOutput extends __MetadataBearer {} /** *

Changes the state of a signing job to REVOKED. This indicates that the signature is no * longer valid.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { SignerClient, RevokeSignatureCommand } from "@aws-sdk/client-signer"; // ES Modules import + * // const { SignerClient, RevokeSignatureCommand } = require("@aws-sdk/client-signer"); // CommonJS import + * const client = new SignerClient(config); + * const command = new RevokeSignatureCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link RevokeSignatureCommandInput} for command's `input` shape. + * @see {@link RevokeSignatureCommandOutput} for command's `response` shape. + * @see {@link SignerClientResolvedConfig | config} for command's `input` shape. + * */ export class RevokeSignatureCommand extends $Command< RevokeSignatureCommandInput, diff --git a/clients/client-signer/commands/RevokeSigningProfileCommand.ts b/clients/client-signer/commands/RevokeSigningProfileCommand.ts index f0a30146f9aa..486ce1d22db6 100644 --- a/clients/client-signer/commands/RevokeSigningProfileCommand.ts +++ b/clients/client-signer/commands/RevokeSigningProfileCommand.ts @@ -24,6 +24,20 @@ export interface RevokeSigningProfileCommandOutput extends __MetadataBearer {} *

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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { SignerClient, RevokeSigningProfileCommand } from "@aws-sdk/client-signer"; // ES Modules import + * // const { SignerClient, RevokeSigningProfileCommand } = require("@aws-sdk/client-signer"); // CommonJS import + * const client = new SignerClient(config); + * const command = new RevokeSigningProfileCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link RevokeSigningProfileCommandInput} for command's `input` shape. + * @see {@link RevokeSigningProfileCommandOutput} for command's `response` shape. + * @see {@link SignerClientResolvedConfig | config} for command's `input` shape. + * */ export class RevokeSigningProfileCommand extends $Command< RevokeSigningProfileCommandInput, diff --git a/clients/client-signer/commands/StartSigningJobCommand.ts b/clients/client-signer/commands/StartSigningJobCommand.ts index b1570ce97bcb..65ba2de4abf0 100644 --- a/clients/client-signer/commands/StartSigningJobCommand.ts +++ b/clients/client-signer/commands/StartSigningJobCommand.ts @@ -49,6 +49,20 @@ export interface StartSigningJobCommandOutput extends StartSigningJobResponse, _ * StartSigningJob.

*

For a Java example that shows how to use this action, see http://docs.aws.amazon.com/acm/latest/userguide/ *

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { SignerClient, StartSigningJobCommand } from "@aws-sdk/client-signer"; // ES Modules import + * // const { SignerClient, StartSigningJobCommand } = require("@aws-sdk/client-signer"); // CommonJS import + * const client = new SignerClient(config); + * const command = new StartSigningJobCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link StartSigningJobCommandInput} for command's `input` shape. + * @see {@link StartSigningJobCommandOutput} for command's `response` shape. + * @see {@link SignerClientResolvedConfig | config} for command's `input` shape. + * */ export class StartSigningJobCommand extends $Command< StartSigningJobCommandInput, diff --git a/clients/client-signer/commands/TagResourceCommand.ts b/clients/client-signer/commands/TagResourceCommand.ts index 412829b5181c..ae4de4564128 100644 --- a/clients/client-signer/commands/TagResourceCommand.ts +++ b/clients/client-signer/commands/TagResourceCommand.ts @@ -25,6 +25,20 @@ export interface TagResourceCommandOutput extends TagResourceResponse, __Metadat * 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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { SignerClient, TagResourceCommand } from "@aws-sdk/client-signer"; // ES Modules import + * // const { SignerClient, TagResourceCommand } = require("@aws-sdk/client-signer"); // CommonJS import + * const client = new SignerClient(config); + * const command = new TagResourceCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link TagResourceCommandInput} for command's `input` shape. + * @see {@link TagResourceCommandOutput} for command's `response` shape. + * @see {@link SignerClientResolvedConfig | config} for command's `input` shape. + * */ export class TagResourceCommand extends $Command< TagResourceCommandInput, diff --git a/clients/client-signer/commands/UntagResourceCommand.ts b/clients/client-signer/commands/UntagResourceCommand.ts index e7a542fe7925..6ee91cca3198 100644 --- a/clients/client-signer/commands/UntagResourceCommand.ts +++ b/clients/client-signer/commands/UntagResourceCommand.ts @@ -23,6 +23,20 @@ export interface UntagResourceCommandOutput extends UntagResourceResponse, __Met /** *

Removes one or more tags from a signing profile. To remove the tags, specify a list of * tag keys.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { SignerClient, UntagResourceCommand } from "@aws-sdk/client-signer"; // ES Modules import + * // const { SignerClient, UntagResourceCommand } = require("@aws-sdk/client-signer"); // CommonJS import + * const client = new SignerClient(config); + * const command = new UntagResourceCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link UntagResourceCommandInput} for command's `input` shape. + * @see {@link UntagResourceCommandOutput} for command's `response` shape. + * @see {@link SignerClientResolvedConfig | config} for command's `input` shape. + * */ export class UntagResourceCommand extends $Command< UntagResourceCommandInput, diff --git a/clients/client-signer/models/models_0.ts b/clients/client-signer/models/models_0.ts index cf9adb8ad700..f5a915cc11ee 100644 --- a/clients/client-signer/models/models_0.ts +++ b/clients/client-signer/models/models_0.ts @@ -12,6 +12,9 @@ export interface AccessDeniedException extends __SmithyException, $MetadataBeare } export namespace AccessDeniedException { + /** + * @internal + */ export const filterSensitiveLog = (obj: AccessDeniedException): any => ({ ...obj, }); @@ -51,6 +54,9 @@ export interface AddProfilePermissionRequest { } export namespace AddProfilePermissionRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: AddProfilePermissionRequest): any => ({ ...obj, }); @@ -64,6 +70,9 @@ export interface AddProfilePermissionResponse { } export namespace AddProfilePermissionResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: AddProfilePermissionResponse): any => ({ ...obj, }); @@ -80,6 +89,9 @@ export interface ConflictException extends __SmithyException, $MetadataBearer { } export namespace ConflictException { + /** + * @internal + */ export const filterSensitiveLog = (obj: ConflictException): any => ({ ...obj, }); @@ -96,6 +108,9 @@ export interface InternalServiceErrorException extends __SmithyException, $Metad } export namespace InternalServiceErrorException { + /** + * @internal + */ export const filterSensitiveLog = (obj: InternalServiceErrorException): any => ({ ...obj, }); @@ -112,6 +127,9 @@ export interface ResourceNotFoundException extends __SmithyException, $MetadataB } export namespace ResourceNotFoundException { + /** + * @internal + */ export const filterSensitiveLog = (obj: ResourceNotFoundException): any => ({ ...obj, }); @@ -128,6 +146,9 @@ export interface ServiceLimitExceededException extends __SmithyException, $Metad } export namespace ServiceLimitExceededException { + /** + * @internal + */ export const filterSensitiveLog = (obj: ServiceLimitExceededException): any => ({ ...obj, }); @@ -145,6 +166,9 @@ export interface TooManyRequestsException extends __SmithyException, $MetadataBe } export namespace TooManyRequestsException { + /** + * @internal + */ export const filterSensitiveLog = (obj: TooManyRequestsException): any => ({ ...obj, }); @@ -161,6 +185,9 @@ export interface ValidationException extends __SmithyException, $MetadataBearer } export namespace ValidationException { + /** + * @internal + */ export const filterSensitiveLog = (obj: ValidationException): any => ({ ...obj, }); @@ -178,6 +205,9 @@ export interface BadRequestException extends __SmithyException, $MetadataBearer } export namespace BadRequestException { + /** + * @internal + */ export const filterSensitiveLog = (obj: BadRequestException): any => ({ ...obj, }); @@ -191,6 +221,9 @@ export interface CancelSigningProfileRequest { } export namespace CancelSigningProfileRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: CancelSigningProfileRequest): any => ({ ...obj, }); @@ -206,6 +239,9 @@ export interface DescribeSigningJobRequest { } export namespace DescribeSigningJobRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeSigningJobRequest): any => ({ ...obj, }); @@ -234,6 +270,9 @@ export interface SigningConfigurationOverrides { } export namespace SigningConfigurationOverrides { + /** + * @internal + */ export const filterSensitiveLog = (obj: SigningConfigurationOverrides): any => ({ ...obj, }); @@ -264,6 +303,9 @@ export interface SigningPlatformOverrides { } export namespace SigningPlatformOverrides { + /** + * @internal + */ export const filterSensitiveLog = (obj: SigningPlatformOverrides): any => ({ ...obj, }); @@ -290,6 +332,9 @@ export interface SigningJobRevocationRecord { } export namespace SigningJobRevocationRecord { + /** + * @internal + */ export const filterSensitiveLog = (obj: SigningJobRevocationRecord): any => ({ ...obj, }); @@ -311,6 +356,9 @@ export interface S3SignedObject { } export namespace S3SignedObject { + /** + * @internal + */ export const filterSensitiveLog = (obj: S3SignedObject): any => ({ ...obj, }); @@ -328,6 +376,9 @@ export interface SignedObject { } export namespace SignedObject { + /** + * @internal + */ export const filterSensitiveLog = (obj: SignedObject): any => ({ ...obj, }); @@ -345,6 +396,9 @@ export interface SigningMaterial { } export namespace SigningMaterial { + /** + * @internal + */ export const filterSensitiveLog = (obj: SigningMaterial): any => ({ ...obj, }); @@ -371,6 +425,9 @@ export interface S3Source { } export namespace S3Source { + /** + * @internal + */ export const filterSensitiveLog = (obj: S3Source): any => ({ ...obj, }); @@ -388,6 +445,9 @@ export interface Source { } export namespace Source { + /** + * @internal + */ export const filterSensitiveLog = (obj: Source): any => ({ ...obj, }); @@ -496,6 +556,9 @@ export interface DescribeSigningJobResponse { } export namespace DescribeSigningJobResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeSigningJobResponse): any => ({ ...obj, }); @@ -518,6 +581,9 @@ export interface S3Destination { } export namespace S3Destination { + /** + * @internal + */ export const filterSensitiveLog = (obj: S3Destination): any => ({ ...obj, }); @@ -535,6 +601,9 @@ export interface Destination { } export namespace Destination { + /** + * @internal + */ export const filterSensitiveLog = (obj: Destination): any => ({ ...obj, }); @@ -556,6 +625,9 @@ export interface EncryptionAlgorithmOptions { } export namespace EncryptionAlgorithmOptions { + /** + * @internal + */ export const filterSensitiveLog = (obj: EncryptionAlgorithmOptions): any => ({ ...obj, }); @@ -569,6 +641,9 @@ export interface GetSigningPlatformRequest { } export namespace GetSigningPlatformRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetSigningPlatformRequest): any => ({ ...obj, }); @@ -590,6 +665,9 @@ export interface HashAlgorithmOptions { } export namespace HashAlgorithmOptions { + /** + * @internal + */ export const filterSensitiveLog = (obj: HashAlgorithmOptions): any => ({ ...obj, }); @@ -611,6 +689,9 @@ export interface SigningConfiguration { } export namespace SigningConfiguration { + /** + * @internal + */ export const filterSensitiveLog = (obj: SigningConfiguration): any => ({ ...obj, }); @@ -632,6 +713,9 @@ export interface SigningImageFormat { } export namespace SigningImageFormat { + /** + * @internal + */ export const filterSensitiveLog = (obj: SigningImageFormat): any => ({ ...obj, }); @@ -687,6 +771,9 @@ export interface GetSigningPlatformResponse { } export namespace GetSigningPlatformResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetSigningPlatformResponse): any => ({ ...obj, }); @@ -705,6 +792,9 @@ export interface GetSigningProfileRequest { } export namespace GetSigningProfileRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetSigningProfileRequest): any => ({ ...obj, }); @@ -731,6 +821,9 @@ export interface SigningProfileRevocationRecord { } export namespace SigningProfileRevocationRecord { + /** + * @internal + */ export const filterSensitiveLog = (obj: SigningProfileRevocationRecord): any => ({ ...obj, }); @@ -755,6 +848,9 @@ export interface SignatureValidityPeriod { } export namespace SignatureValidityPeriod { + /** + * @internal + */ export const filterSensitiveLog = (obj: SignatureValidityPeriod): any => ({ ...obj, }); @@ -838,6 +934,9 @@ export interface GetSigningProfileResponse { } export namespace GetSigningProfileResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetSigningProfileResponse): any => ({ ...obj, }); @@ -856,6 +955,9 @@ export interface ListProfilePermissionsRequest { } export namespace ListProfilePermissionsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListProfilePermissionsRequest): any => ({ ...obj, }); @@ -887,6 +989,9 @@ export interface Permission { } export namespace Permission { + /** + * @internal + */ export const filterSensitiveLog = (obj: Permission): any => ({ ...obj, }); @@ -915,6 +1020,9 @@ export interface ListProfilePermissionsResponse { } export namespace ListProfilePermissionsResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListProfilePermissionsResponse): any => ({ ...obj, }); @@ -978,6 +1086,9 @@ export interface ListSigningJobsRequest { } export namespace ListSigningJobsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListSigningJobsRequest): any => ({ ...obj, }); @@ -1062,6 +1173,9 @@ export interface SigningJob { } export namespace SigningJob { + /** + * @internal + */ export const filterSensitiveLog = (obj: SigningJob): any => ({ ...obj, }); @@ -1080,6 +1194,9 @@ export interface ListSigningJobsResponse { } export namespace ListSigningJobsResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListSigningJobsResponse): any => ({ ...obj, }); @@ -1115,6 +1232,9 @@ export interface ListSigningPlatformsRequest { } export namespace ListSigningPlatformsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListSigningPlatformsRequest): any => ({ ...obj, }); @@ -1173,6 +1293,9 @@ export interface SigningPlatform { } export namespace SigningPlatform { + /** + * @internal + */ export const filterSensitiveLog = (obj: SigningPlatform): any => ({ ...obj, }); @@ -1191,6 +1314,9 @@ export interface ListSigningPlatformsResponse { } export namespace ListSigningPlatformsResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListSigningPlatformsResponse): any => ({ ...obj, }); @@ -1229,6 +1355,9 @@ export interface ListSigningProfilesRequest { } export namespace ListSigningProfilesRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListSigningProfilesRequest): any => ({ ...obj, }); @@ -1296,6 +1425,9 @@ export interface SigningProfile { } export namespace SigningProfile { + /** + * @internal + */ export const filterSensitiveLog = (obj: SigningProfile): any => ({ ...obj, }); @@ -1316,6 +1448,9 @@ export interface ListSigningProfilesResponse { } export namespace ListSigningProfilesResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListSigningProfilesResponse): any => ({ ...obj, }); @@ -1329,6 +1464,9 @@ export interface ListTagsForResourceRequest { } export namespace ListTagsForResourceRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListTagsForResourceRequest): any => ({ ...obj, }); @@ -1342,6 +1480,9 @@ export interface ListTagsForResourceResponse { } export namespace ListTagsForResourceResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListTagsForResourceResponse): any => ({ ...obj, }); @@ -1358,6 +1499,9 @@ export interface NotFoundException extends __SmithyException, $MetadataBearer { } export namespace NotFoundException { + /** + * @internal + */ export const filterSensitiveLog = (obj: NotFoundException): any => ({ ...obj, }); @@ -1406,6 +1550,9 @@ export interface PutSigningProfileRequest { } export namespace PutSigningProfileRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: PutSigningProfileRequest): any => ({ ...obj, }); @@ -1429,6 +1576,9 @@ export interface PutSigningProfileResponse { } export namespace PutSigningProfileResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: PutSigningProfileResponse): any => ({ ...obj, }); @@ -1452,6 +1602,9 @@ export interface RemoveProfilePermissionRequest { } export namespace RemoveProfilePermissionRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: RemoveProfilePermissionRequest): any => ({ ...obj, }); @@ -1465,6 +1618,9 @@ export interface RemoveProfilePermissionResponse { } export namespace RemoveProfilePermissionResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: RemoveProfilePermissionResponse): any => ({ ...obj, }); @@ -1488,6 +1644,9 @@ export interface RevokeSignatureRequest { } export namespace RevokeSignatureRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: RevokeSignatureRequest): any => ({ ...obj, }); @@ -1518,6 +1677,9 @@ export interface RevokeSigningProfileRequest { } export namespace RevokeSigningProfileRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: RevokeSigningProfileRequest): any => ({ ...obj, }); @@ -1554,6 +1716,9 @@ export interface StartSigningJobRequest { } export namespace StartSigningJobRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: StartSigningJobRequest): any => ({ ...obj, }); @@ -1572,6 +1737,9 @@ export interface StartSigningJobResponse { } export namespace StartSigningJobResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: StartSigningJobResponse): any => ({ ...obj, }); @@ -1591,6 +1759,9 @@ export interface ThrottlingException extends __SmithyException, $MetadataBearer } export namespace ThrottlingException { + /** + * @internal + */ export const filterSensitiveLog = (obj: ThrottlingException): any => ({ ...obj, }); @@ -1609,6 +1780,9 @@ export interface TagResourceRequest { } export namespace TagResourceRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: TagResourceRequest): any => ({ ...obj, }); @@ -1617,6 +1791,9 @@ export namespace TagResourceRequest { export interface TagResourceResponse {} export namespace TagResourceResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: TagResourceResponse): any => ({ ...obj, }); @@ -1635,6 +1812,9 @@ export interface UntagResourceRequest { } export namespace UntagResourceRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: UntagResourceRequest): any => ({ ...obj, }); @@ -1643,6 +1823,9 @@ export namespace UntagResourceRequest { export interface UntagResourceResponse {} export namespace UntagResourceResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: UntagResourceResponse): any => ({ ...obj, }); diff --git a/clients/client-sms/commands/CreateAppCommand.ts b/clients/client-sms/commands/CreateAppCommand.ts index 216e4d68cf73..198b07bcf5dd 100644 --- a/clients/client-sms/commands/CreateAppCommand.ts +++ b/clients/client-sms/commands/CreateAppCommand.ts @@ -20,6 +20,20 @@ export interface CreateAppCommandOutput extends CreateAppResponse, __MetadataBea /** *

Creates an application. An application consists of one or more server groups. Each * server group contain one or more servers.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { SMSClient, CreateAppCommand } from "@aws-sdk/client-sms"; // ES Modules import + * // const { SMSClient, CreateAppCommand } = require("@aws-sdk/client-sms"); // CommonJS import + * const client = new SMSClient(config); + * const command = new CreateAppCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreateAppCommandInput} for command's `input` shape. + * @see {@link CreateAppCommandOutput} for command's `response` shape. + * @see {@link SMSClientResolvedConfig | config} for command's `input` shape. + * */ export class CreateAppCommand extends $Command { // Start section: command_properties diff --git a/clients/client-sms/commands/CreateReplicationJobCommand.ts b/clients/client-sms/commands/CreateReplicationJobCommand.ts index df73e53eacc4..a7e2c4999e59 100644 --- a/clients/client-sms/commands/CreateReplicationJobCommand.ts +++ b/clients/client-sms/commands/CreateReplicationJobCommand.ts @@ -24,6 +24,20 @@ export interface CreateReplicationJobCommandOutput extends CreateReplicationJobR *

Creates a replication job. The replication job schedules periodic replication runs * to replicate your server to AWS. Each replication run creates an Amazon Machine Image * (AMI).

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { SMSClient, CreateReplicationJobCommand } from "@aws-sdk/client-sms"; // ES Modules import + * // const { SMSClient, CreateReplicationJobCommand } = require("@aws-sdk/client-sms"); // CommonJS import + * const client = new SMSClient(config); + * const command = new CreateReplicationJobCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreateReplicationJobCommandInput} for command's `input` shape. + * @see {@link CreateReplicationJobCommandOutput} for command's `response` shape. + * @see {@link SMSClientResolvedConfig | config} for command's `input` shape. + * */ export class CreateReplicationJobCommand extends $Command< CreateReplicationJobCommandInput, diff --git a/clients/client-sms/commands/DeleteAppCommand.ts b/clients/client-sms/commands/DeleteAppCommand.ts index 7e1cbf942222..771e29a1349e 100644 --- a/clients/client-sms/commands/DeleteAppCommand.ts +++ b/clients/client-sms/commands/DeleteAppCommand.ts @@ -20,6 +20,20 @@ export interface DeleteAppCommandOutput extends DeleteAppResponse, __MetadataBea /** *

Deletes the specified application. Optionally deletes the launched stack associated with * the application and all AWS SMS replication jobs for servers in the application.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { SMSClient, DeleteAppCommand } from "@aws-sdk/client-sms"; // ES Modules import + * // const { SMSClient, DeleteAppCommand } = require("@aws-sdk/client-sms"); // CommonJS import + * const client = new SMSClient(config); + * const command = new DeleteAppCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteAppCommandInput} for command's `input` shape. + * @see {@link DeleteAppCommandOutput} for command's `response` shape. + * @see {@link SMSClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteAppCommand extends $Command { // Start section: command_properties diff --git a/clients/client-sms/commands/DeleteAppLaunchConfigurationCommand.ts b/clients/client-sms/commands/DeleteAppLaunchConfigurationCommand.ts index e9fe48f115f7..80f8d78de638 100644 --- a/clients/client-sms/commands/DeleteAppLaunchConfigurationCommand.ts +++ b/clients/client-sms/commands/DeleteAppLaunchConfigurationCommand.ts @@ -24,6 +24,20 @@ export interface DeleteAppLaunchConfigurationCommandOutput /** *

Deletes the launch configuration for the specified application.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { SMSClient, DeleteAppLaunchConfigurationCommand } from "@aws-sdk/client-sms"; // ES Modules import + * // const { SMSClient, DeleteAppLaunchConfigurationCommand } = require("@aws-sdk/client-sms"); // CommonJS import + * const client = new SMSClient(config); + * const command = new DeleteAppLaunchConfigurationCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteAppLaunchConfigurationCommandInput} for command's `input` shape. + * @see {@link DeleteAppLaunchConfigurationCommandOutput} for command's `response` shape. + * @see {@link SMSClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteAppLaunchConfigurationCommand extends $Command< DeleteAppLaunchConfigurationCommandInput, diff --git a/clients/client-sms/commands/DeleteAppReplicationConfigurationCommand.ts b/clients/client-sms/commands/DeleteAppReplicationConfigurationCommand.ts index efa83cd0d3e9..7a24cb0a7521 100644 --- a/clients/client-sms/commands/DeleteAppReplicationConfigurationCommand.ts +++ b/clients/client-sms/commands/DeleteAppReplicationConfigurationCommand.ts @@ -27,6 +27,20 @@ export interface DeleteAppReplicationConfigurationCommandOutput /** *

Deletes the replication configuration for the specified application.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { SMSClient, DeleteAppReplicationConfigurationCommand } from "@aws-sdk/client-sms"; // ES Modules import + * // const { SMSClient, DeleteAppReplicationConfigurationCommand } = require("@aws-sdk/client-sms"); // CommonJS import + * const client = new SMSClient(config); + * const command = new DeleteAppReplicationConfigurationCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteAppReplicationConfigurationCommandInput} for command's `input` shape. + * @see {@link DeleteAppReplicationConfigurationCommandOutput} for command's `response` shape. + * @see {@link SMSClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteAppReplicationConfigurationCommand extends $Command< DeleteAppReplicationConfigurationCommandInput, diff --git a/clients/client-sms/commands/DeleteAppValidationConfigurationCommand.ts b/clients/client-sms/commands/DeleteAppValidationConfigurationCommand.ts index c7e0df4327e7..efd132c35fd2 100644 --- a/clients/client-sms/commands/DeleteAppValidationConfigurationCommand.ts +++ b/clients/client-sms/commands/DeleteAppValidationConfigurationCommand.ts @@ -24,6 +24,20 @@ export interface DeleteAppValidationConfigurationCommandOutput /** *

Deletes the validation configuration for the specified application.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { SMSClient, DeleteAppValidationConfigurationCommand } from "@aws-sdk/client-sms"; // ES Modules import + * // const { SMSClient, DeleteAppValidationConfigurationCommand } = require("@aws-sdk/client-sms"); // CommonJS import + * const client = new SMSClient(config); + * const command = new DeleteAppValidationConfigurationCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteAppValidationConfigurationCommandInput} for command's `input` shape. + * @see {@link DeleteAppValidationConfigurationCommandOutput} for command's `response` shape. + * @see {@link SMSClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteAppValidationConfigurationCommand extends $Command< DeleteAppValidationConfigurationCommandInput, diff --git a/clients/client-sms/commands/DeleteReplicationJobCommand.ts b/clients/client-sms/commands/DeleteReplicationJobCommand.ts index e0d39e15f67d..dccabe4da23a 100644 --- a/clients/client-sms/commands/DeleteReplicationJobCommand.ts +++ b/clients/client-sms/commands/DeleteReplicationJobCommand.ts @@ -25,6 +25,20 @@ export interface DeleteReplicationJobCommandOutput extends DeleteReplicationJobR *

After you delete a replication job, there are no further replication runs. AWS * deletes the contents of the Amazon S3 bucket used to store AWS SMS artifacts. The AMIs created * by the replication runs are not deleted.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { SMSClient, DeleteReplicationJobCommand } from "@aws-sdk/client-sms"; // ES Modules import + * // const { SMSClient, DeleteReplicationJobCommand } = require("@aws-sdk/client-sms"); // CommonJS import + * const client = new SMSClient(config); + * const command = new DeleteReplicationJobCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteReplicationJobCommandInput} for command's `input` shape. + * @see {@link DeleteReplicationJobCommandOutput} for command's `response` shape. + * @see {@link SMSClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteReplicationJobCommand extends $Command< DeleteReplicationJobCommandInput, diff --git a/clients/client-sms/commands/DeleteServerCatalogCommand.ts b/clients/client-sms/commands/DeleteServerCatalogCommand.ts index ddfbf8470263..e05268f44e84 100644 --- a/clients/client-sms/commands/DeleteServerCatalogCommand.ts +++ b/clients/client-sms/commands/DeleteServerCatalogCommand.ts @@ -22,6 +22,20 @@ export interface DeleteServerCatalogCommandOutput extends DeleteServerCatalogRes /** *

Deletes all servers from your server catalog.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { SMSClient, DeleteServerCatalogCommand } from "@aws-sdk/client-sms"; // ES Modules import + * // const { SMSClient, DeleteServerCatalogCommand } = require("@aws-sdk/client-sms"); // CommonJS import + * const client = new SMSClient(config); + * const command = new DeleteServerCatalogCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteServerCatalogCommandInput} for command's `input` shape. + * @see {@link DeleteServerCatalogCommandOutput} for command's `response` shape. + * @see {@link SMSClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteServerCatalogCommand extends $Command< DeleteServerCatalogCommandInput, diff --git a/clients/client-sms/commands/DisassociateConnectorCommand.ts b/clients/client-sms/commands/DisassociateConnectorCommand.ts index ff608c17ff35..16c62f49c1e8 100644 --- a/clients/client-sms/commands/DisassociateConnectorCommand.ts +++ b/clients/client-sms/commands/DisassociateConnectorCommand.ts @@ -24,6 +24,20 @@ export interface DisassociateConnectorCommandOutput extends DisassociateConnecto *

Disassociates the specified connector from AWS SMS.

*

After you disassociate a connector, it is no longer available to support * replication jobs.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { SMSClient, DisassociateConnectorCommand } from "@aws-sdk/client-sms"; // ES Modules import + * // const { SMSClient, DisassociateConnectorCommand } = require("@aws-sdk/client-sms"); // CommonJS import + * const client = new SMSClient(config); + * const command = new DisassociateConnectorCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DisassociateConnectorCommandInput} for command's `input` shape. + * @see {@link DisassociateConnectorCommandOutput} for command's `response` shape. + * @see {@link SMSClientResolvedConfig | config} for command's `input` shape. + * */ export class DisassociateConnectorCommand extends $Command< DisassociateConnectorCommandInput, diff --git a/clients/client-sms/commands/GenerateChangeSetCommand.ts b/clients/client-sms/commands/GenerateChangeSetCommand.ts index 33caedf73919..7a2986033186 100644 --- a/clients/client-sms/commands/GenerateChangeSetCommand.ts +++ b/clients/client-sms/commands/GenerateChangeSetCommand.ts @@ -23,6 +23,20 @@ export interface GenerateChangeSetCommandOutput extends GenerateChangeSetRespons /** *

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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { SMSClient, GenerateChangeSetCommand } from "@aws-sdk/client-sms"; // ES Modules import + * // const { SMSClient, GenerateChangeSetCommand } = require("@aws-sdk/client-sms"); // CommonJS import + * const client = new SMSClient(config); + * const command = new GenerateChangeSetCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GenerateChangeSetCommandInput} for command's `input` shape. + * @see {@link GenerateChangeSetCommandOutput} for command's `response` shape. + * @see {@link SMSClientResolvedConfig | config} for command's `input` shape. + * */ export class GenerateChangeSetCommand extends $Command< GenerateChangeSetCommandInput, diff --git a/clients/client-sms/commands/GenerateTemplateCommand.ts b/clients/client-sms/commands/GenerateTemplateCommand.ts index 74a8ca16b875..bf45e6a314a0 100644 --- a/clients/client-sms/commands/GenerateTemplateCommand.ts +++ b/clients/client-sms/commands/GenerateTemplateCommand.ts @@ -23,6 +23,20 @@ export interface GenerateTemplateCommandOutput extends GenerateTemplateResponse, /** *

Generates an AWS CloudFormation template based on the current launch configuration and writes it to * an Amazon S3 object in the customer’s Amazon S3 bucket.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { SMSClient, GenerateTemplateCommand } from "@aws-sdk/client-sms"; // ES Modules import + * // const { SMSClient, GenerateTemplateCommand } = require("@aws-sdk/client-sms"); // CommonJS import + * const client = new SMSClient(config); + * const command = new GenerateTemplateCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GenerateTemplateCommandInput} for command's `input` shape. + * @see {@link GenerateTemplateCommandOutput} for command's `response` shape. + * @see {@link SMSClientResolvedConfig | config} for command's `input` shape. + * */ export class GenerateTemplateCommand extends $Command< GenerateTemplateCommandInput, diff --git a/clients/client-sms/commands/GetAppCommand.ts b/clients/client-sms/commands/GetAppCommand.ts index 9098f8d4d4f6..0b6dc14479ec 100644 --- a/clients/client-sms/commands/GetAppCommand.ts +++ b/clients/client-sms/commands/GetAppCommand.ts @@ -19,6 +19,20 @@ export interface GetAppCommandOutput extends GetAppResponse, __MetadataBearer {} /** *

Retrieve information about the specified application.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { SMSClient, GetAppCommand } from "@aws-sdk/client-sms"; // ES Modules import + * // const { SMSClient, GetAppCommand } = require("@aws-sdk/client-sms"); // CommonJS import + * const client = new SMSClient(config); + * const command = new GetAppCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetAppCommandInput} for command's `input` shape. + * @see {@link GetAppCommandOutput} for command's `response` shape. + * @see {@link SMSClientResolvedConfig | config} for command's `input` shape. + * */ export class GetAppCommand extends $Command { // Start section: command_properties diff --git a/clients/client-sms/commands/GetAppLaunchConfigurationCommand.ts b/clients/client-sms/commands/GetAppLaunchConfigurationCommand.ts index 53bcd841e679..47200345f530 100644 --- a/clients/client-sms/commands/GetAppLaunchConfigurationCommand.ts +++ b/clients/client-sms/commands/GetAppLaunchConfigurationCommand.ts @@ -22,6 +22,20 @@ export interface GetAppLaunchConfigurationCommandOutput extends GetAppLaunchConf /** *

Retrieves the application launch configuration associated with the specified application.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { SMSClient, GetAppLaunchConfigurationCommand } from "@aws-sdk/client-sms"; // ES Modules import + * // const { SMSClient, GetAppLaunchConfigurationCommand } = require("@aws-sdk/client-sms"); // CommonJS import + * const client = new SMSClient(config); + * const command = new GetAppLaunchConfigurationCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetAppLaunchConfigurationCommandInput} for command's `input` shape. + * @see {@link GetAppLaunchConfigurationCommandOutput} for command's `response` shape. + * @see {@link SMSClientResolvedConfig | config} for command's `input` shape. + * */ export class GetAppLaunchConfigurationCommand extends $Command< GetAppLaunchConfigurationCommandInput, diff --git a/clients/client-sms/commands/GetAppReplicationConfigurationCommand.ts b/clients/client-sms/commands/GetAppReplicationConfigurationCommand.ts index a31b21163e0b..95240f28cd21 100644 --- a/clients/client-sms/commands/GetAppReplicationConfigurationCommand.ts +++ b/clients/client-sms/commands/GetAppReplicationConfigurationCommand.ts @@ -25,6 +25,20 @@ export interface GetAppReplicationConfigurationCommandOutput /** *

Retrieves the application replication configuration associated with the specified * application.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { SMSClient, GetAppReplicationConfigurationCommand } from "@aws-sdk/client-sms"; // ES Modules import + * // const { SMSClient, GetAppReplicationConfigurationCommand } = require("@aws-sdk/client-sms"); // CommonJS import + * const client = new SMSClient(config); + * const command = new GetAppReplicationConfigurationCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetAppReplicationConfigurationCommandInput} for command's `input` shape. + * @see {@link GetAppReplicationConfigurationCommandOutput} for command's `response` shape. + * @see {@link SMSClientResolvedConfig | config} for command's `input` shape. + * */ export class GetAppReplicationConfigurationCommand extends $Command< GetAppReplicationConfigurationCommandInput, diff --git a/clients/client-sms/commands/GetAppValidationConfigurationCommand.ts b/clients/client-sms/commands/GetAppValidationConfigurationCommand.ts index d0e6a21b081e..e9adbea06b09 100644 --- a/clients/client-sms/commands/GetAppValidationConfigurationCommand.ts +++ b/clients/client-sms/commands/GetAppValidationConfigurationCommand.ts @@ -24,6 +24,20 @@ export interface GetAppValidationConfigurationCommandOutput /** *

Retrieves information about a configuration for validating an application.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { SMSClient, GetAppValidationConfigurationCommand } from "@aws-sdk/client-sms"; // ES Modules import + * // const { SMSClient, GetAppValidationConfigurationCommand } = require("@aws-sdk/client-sms"); // CommonJS import + * const client = new SMSClient(config); + * const command = new GetAppValidationConfigurationCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetAppValidationConfigurationCommandInput} for command's `input` shape. + * @see {@link GetAppValidationConfigurationCommandOutput} for command's `response` shape. + * @see {@link SMSClientResolvedConfig | config} for command's `input` shape. + * */ export class GetAppValidationConfigurationCommand extends $Command< GetAppValidationConfigurationCommandInput, diff --git a/clients/client-sms/commands/GetAppValidationOutputCommand.ts b/clients/client-sms/commands/GetAppValidationOutputCommand.ts index 8703b9f5e1e6..f6b02be0bd18 100644 --- a/clients/client-sms/commands/GetAppValidationOutputCommand.ts +++ b/clients/client-sms/commands/GetAppValidationOutputCommand.ts @@ -22,6 +22,20 @@ export interface GetAppValidationOutputCommandOutput extends GetAppValidationOut /** *

Retrieves output from validating an application.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { SMSClient, GetAppValidationOutputCommand } from "@aws-sdk/client-sms"; // ES Modules import + * // const { SMSClient, GetAppValidationOutputCommand } = require("@aws-sdk/client-sms"); // CommonJS import + * const client = new SMSClient(config); + * const command = new GetAppValidationOutputCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetAppValidationOutputCommandInput} for command's `input` shape. + * @see {@link GetAppValidationOutputCommandOutput} for command's `response` shape. + * @see {@link SMSClientResolvedConfig | config} for command's `input` shape. + * */ export class GetAppValidationOutputCommand extends $Command< GetAppValidationOutputCommandInput, diff --git a/clients/client-sms/commands/GetConnectorsCommand.ts b/clients/client-sms/commands/GetConnectorsCommand.ts index 1e75e11f11cb..0b2695552161 100644 --- a/clients/client-sms/commands/GetConnectorsCommand.ts +++ b/clients/client-sms/commands/GetConnectorsCommand.ts @@ -22,6 +22,20 @@ export interface GetConnectorsCommandOutput extends GetConnectorsResponse, __Met /** *

Describes the connectors registered with the AWS SMS.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { SMSClient, GetConnectorsCommand } from "@aws-sdk/client-sms"; // ES Modules import + * // const { SMSClient, GetConnectorsCommand } = require("@aws-sdk/client-sms"); // CommonJS import + * const client = new SMSClient(config); + * const command = new GetConnectorsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetConnectorsCommandInput} for command's `input` shape. + * @see {@link GetConnectorsCommandOutput} for command's `response` shape. + * @see {@link SMSClientResolvedConfig | config} for command's `input` shape. + * */ export class GetConnectorsCommand extends $Command< GetConnectorsCommandInput, diff --git a/clients/client-sms/commands/GetReplicationJobsCommand.ts b/clients/client-sms/commands/GetReplicationJobsCommand.ts index d20127c123ec..a7f16d45a769 100644 --- a/clients/client-sms/commands/GetReplicationJobsCommand.ts +++ b/clients/client-sms/commands/GetReplicationJobsCommand.ts @@ -22,6 +22,20 @@ export interface GetReplicationJobsCommandOutput extends GetReplicationJobsRespo /** *

Describes the specified replication job or all of your replication jobs.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { SMSClient, GetReplicationJobsCommand } from "@aws-sdk/client-sms"; // ES Modules import + * // const { SMSClient, GetReplicationJobsCommand } = require("@aws-sdk/client-sms"); // CommonJS import + * const client = new SMSClient(config); + * const command = new GetReplicationJobsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetReplicationJobsCommandInput} for command's `input` shape. + * @see {@link GetReplicationJobsCommandOutput} for command's `response` shape. + * @see {@link SMSClientResolvedConfig | config} for command's `input` shape. + * */ export class GetReplicationJobsCommand extends $Command< GetReplicationJobsCommandInput, diff --git a/clients/client-sms/commands/GetReplicationRunsCommand.ts b/clients/client-sms/commands/GetReplicationRunsCommand.ts index 5532c7cb37f0..71a61ac7d431 100644 --- a/clients/client-sms/commands/GetReplicationRunsCommand.ts +++ b/clients/client-sms/commands/GetReplicationRunsCommand.ts @@ -22,6 +22,20 @@ export interface GetReplicationRunsCommandOutput extends GetReplicationRunsRespo /** *

Describes the replication runs for the specified replication job.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { SMSClient, GetReplicationRunsCommand } from "@aws-sdk/client-sms"; // ES Modules import + * // const { SMSClient, GetReplicationRunsCommand } = require("@aws-sdk/client-sms"); // CommonJS import + * const client = new SMSClient(config); + * const command = new GetReplicationRunsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetReplicationRunsCommandInput} for command's `input` shape. + * @see {@link GetReplicationRunsCommandOutput} for command's `response` shape. + * @see {@link SMSClientResolvedConfig | config} for command's `input` shape. + * */ export class GetReplicationRunsCommand extends $Command< GetReplicationRunsCommandInput, diff --git a/clients/client-sms/commands/GetServersCommand.ts b/clients/client-sms/commands/GetServersCommand.ts index 46fa22a1114a..97873d7610fe 100644 --- a/clients/client-sms/commands/GetServersCommand.ts +++ b/clients/client-sms/commands/GetServersCommand.ts @@ -23,6 +23,20 @@ export interface GetServersCommandOutput extends GetServersResponse, __MetadataB /** *

Describes the servers in your server catalog.

*

Before you can describe your servers, you must import them using ImportServerCatalog.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { SMSClient, GetServersCommand } from "@aws-sdk/client-sms"; // ES Modules import + * // const { SMSClient, GetServersCommand } = require("@aws-sdk/client-sms"); // CommonJS import + * const client = new SMSClient(config); + * const command = new GetServersCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetServersCommandInput} for command's `input` shape. + * @see {@link GetServersCommandOutput} for command's `response` shape. + * @see {@link SMSClientResolvedConfig | config} for command's `input` shape. + * */ export class GetServersCommand extends $Command< GetServersCommandInput, diff --git a/clients/client-sms/commands/ImportAppCatalogCommand.ts b/clients/client-sms/commands/ImportAppCatalogCommand.ts index fe02d6fe364e..6d755ca4429c 100644 --- a/clients/client-sms/commands/ImportAppCatalogCommand.ts +++ b/clients/client-sms/commands/ImportAppCatalogCommand.ts @@ -22,6 +22,20 @@ export interface ImportAppCatalogCommandOutput extends ImportAppCatalogResponse, /** *

Allows application import from AWS Migration Hub.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { SMSClient, ImportAppCatalogCommand } from "@aws-sdk/client-sms"; // ES Modules import + * // const { SMSClient, ImportAppCatalogCommand } = require("@aws-sdk/client-sms"); // CommonJS import + * const client = new SMSClient(config); + * const command = new ImportAppCatalogCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ImportAppCatalogCommandInput} for command's `input` shape. + * @see {@link ImportAppCatalogCommandOutput} for command's `response` shape. + * @see {@link SMSClientResolvedConfig | config} for command's `input` shape. + * */ export class ImportAppCatalogCommand extends $Command< ImportAppCatalogCommandInput, diff --git a/clients/client-sms/commands/ImportServerCatalogCommand.ts b/clients/client-sms/commands/ImportServerCatalogCommand.ts index 548d9285ea83..8a690203c79c 100644 --- a/clients/client-sms/commands/ImportServerCatalogCommand.ts +++ b/clients/client-sms/commands/ImportServerCatalogCommand.ts @@ -25,6 +25,20 @@ export interface ImportServerCatalogCommandOutput extends ImportServerCatalogRes * monitoring all servers to import.

*

This call returns immediately, but might take additional time to retrieve all the * servers.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { SMSClient, ImportServerCatalogCommand } from "@aws-sdk/client-sms"; // ES Modules import + * // const { SMSClient, ImportServerCatalogCommand } = require("@aws-sdk/client-sms"); // CommonJS import + * const client = new SMSClient(config); + * const command = new ImportServerCatalogCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ImportServerCatalogCommandInput} for command's `input` shape. + * @see {@link ImportServerCatalogCommandOutput} for command's `response` shape. + * @see {@link SMSClientResolvedConfig | config} for command's `input` shape. + * */ export class ImportServerCatalogCommand extends $Command< ImportServerCatalogCommandInput, diff --git a/clients/client-sms/commands/LaunchAppCommand.ts b/clients/client-sms/commands/LaunchAppCommand.ts index 991fe53d469c..6495cd6d547b 100644 --- a/clients/client-sms/commands/LaunchAppCommand.ts +++ b/clients/client-sms/commands/LaunchAppCommand.ts @@ -19,6 +19,20 @@ export interface LaunchAppCommandOutput extends LaunchAppResponse, __MetadataBea /** *

Launches the specified application as a stack in AWS CloudFormation.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { SMSClient, LaunchAppCommand } from "@aws-sdk/client-sms"; // ES Modules import + * // const { SMSClient, LaunchAppCommand } = require("@aws-sdk/client-sms"); // CommonJS import + * const client = new SMSClient(config); + * const command = new LaunchAppCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link LaunchAppCommandInput} for command's `input` shape. + * @see {@link LaunchAppCommandOutput} for command's `response` shape. + * @see {@link SMSClientResolvedConfig | config} for command's `input` shape. + * */ export class LaunchAppCommand extends $Command { // Start section: command_properties diff --git a/clients/client-sms/commands/ListAppsCommand.ts b/clients/client-sms/commands/ListAppsCommand.ts index 450df5c8563f..0ddda77f181e 100644 --- a/clients/client-sms/commands/ListAppsCommand.ts +++ b/clients/client-sms/commands/ListAppsCommand.ts @@ -19,6 +19,20 @@ export interface ListAppsCommandOutput extends ListAppsResponse, __MetadataBeare /** *

Retrieves summaries for all applications.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { SMSClient, ListAppsCommand } from "@aws-sdk/client-sms"; // ES Modules import + * // const { SMSClient, ListAppsCommand } = require("@aws-sdk/client-sms"); // CommonJS import + * const client = new SMSClient(config); + * const command = new ListAppsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListAppsCommandInput} for command's `input` shape. + * @see {@link ListAppsCommandOutput} for command's `response` shape. + * @see {@link SMSClientResolvedConfig | config} for command's `input` shape. + * */ export class ListAppsCommand extends $Command { // Start section: command_properties diff --git a/clients/client-sms/commands/NotifyAppValidationOutputCommand.ts b/clients/client-sms/commands/NotifyAppValidationOutputCommand.ts index 12d252441691..8eb35c1a47e8 100644 --- a/clients/client-sms/commands/NotifyAppValidationOutputCommand.ts +++ b/clients/client-sms/commands/NotifyAppValidationOutputCommand.ts @@ -22,6 +22,20 @@ export interface NotifyAppValidationOutputCommandOutput extends NotifyAppValidat /** *

Provides information to AWS SMS about whether application validation is successful.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { SMSClient, NotifyAppValidationOutputCommand } from "@aws-sdk/client-sms"; // ES Modules import + * // const { SMSClient, NotifyAppValidationOutputCommand } = require("@aws-sdk/client-sms"); // CommonJS import + * const client = new SMSClient(config); + * const command = new NotifyAppValidationOutputCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link NotifyAppValidationOutputCommandInput} for command's `input` shape. + * @see {@link NotifyAppValidationOutputCommandOutput} for command's `response` shape. + * @see {@link SMSClientResolvedConfig | config} for command's `input` shape. + * */ export class NotifyAppValidationOutputCommand extends $Command< NotifyAppValidationOutputCommandInput, diff --git a/clients/client-sms/commands/PutAppLaunchConfigurationCommand.ts b/clients/client-sms/commands/PutAppLaunchConfigurationCommand.ts index dac904611b4a..48f0ffcfd994 100644 --- a/clients/client-sms/commands/PutAppLaunchConfigurationCommand.ts +++ b/clients/client-sms/commands/PutAppLaunchConfigurationCommand.ts @@ -22,6 +22,20 @@ export interface PutAppLaunchConfigurationCommandOutput extends PutAppLaunchConf /** *

Creates or updates the launch configuration for the specified application.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { SMSClient, PutAppLaunchConfigurationCommand } from "@aws-sdk/client-sms"; // ES Modules import + * // const { SMSClient, PutAppLaunchConfigurationCommand } = require("@aws-sdk/client-sms"); // CommonJS import + * const client = new SMSClient(config); + * const command = new PutAppLaunchConfigurationCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link PutAppLaunchConfigurationCommandInput} for command's `input` shape. + * @see {@link PutAppLaunchConfigurationCommandOutput} for command's `response` shape. + * @see {@link SMSClientResolvedConfig | config} for command's `input` shape. + * */ export class PutAppLaunchConfigurationCommand extends $Command< PutAppLaunchConfigurationCommandInput, diff --git a/clients/client-sms/commands/PutAppReplicationConfigurationCommand.ts b/clients/client-sms/commands/PutAppReplicationConfigurationCommand.ts index af52119bf1f4..9323a3333dcb 100644 --- a/clients/client-sms/commands/PutAppReplicationConfigurationCommand.ts +++ b/clients/client-sms/commands/PutAppReplicationConfigurationCommand.ts @@ -24,6 +24,20 @@ export interface PutAppReplicationConfigurationCommandOutput /** *

Creates or updates the replication configuration for the specified application.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { SMSClient, PutAppReplicationConfigurationCommand } from "@aws-sdk/client-sms"; // ES Modules import + * // const { SMSClient, PutAppReplicationConfigurationCommand } = require("@aws-sdk/client-sms"); // CommonJS import + * const client = new SMSClient(config); + * const command = new PutAppReplicationConfigurationCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link PutAppReplicationConfigurationCommandInput} for command's `input` shape. + * @see {@link PutAppReplicationConfigurationCommandOutput} for command's `response` shape. + * @see {@link SMSClientResolvedConfig | config} for command's `input` shape. + * */ export class PutAppReplicationConfigurationCommand extends $Command< PutAppReplicationConfigurationCommandInput, diff --git a/clients/client-sms/commands/PutAppValidationConfigurationCommand.ts b/clients/client-sms/commands/PutAppValidationConfigurationCommand.ts index cadc39ea6237..98728ce421bc 100644 --- a/clients/client-sms/commands/PutAppValidationConfigurationCommand.ts +++ b/clients/client-sms/commands/PutAppValidationConfigurationCommand.ts @@ -24,6 +24,20 @@ export interface PutAppValidationConfigurationCommandOutput /** *

Creates or updates a validation configuration for the specified application.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { SMSClient, PutAppValidationConfigurationCommand } from "@aws-sdk/client-sms"; // ES Modules import + * // const { SMSClient, PutAppValidationConfigurationCommand } = require("@aws-sdk/client-sms"); // CommonJS import + * const client = new SMSClient(config); + * const command = new PutAppValidationConfigurationCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link PutAppValidationConfigurationCommandInput} for command's `input` shape. + * @see {@link PutAppValidationConfigurationCommandOutput} for command's `response` shape. + * @see {@link SMSClientResolvedConfig | config} for command's `input` shape. + * */ export class PutAppValidationConfigurationCommand extends $Command< PutAppValidationConfigurationCommandInput, diff --git a/clients/client-sms/commands/StartAppReplicationCommand.ts b/clients/client-sms/commands/StartAppReplicationCommand.ts index 299dfdedd107..5b5abd581b2b 100644 --- a/clients/client-sms/commands/StartAppReplicationCommand.ts +++ b/clients/client-sms/commands/StartAppReplicationCommand.ts @@ -23,6 +23,20 @@ export interface StartAppReplicationCommandOutput extends StartAppReplicationRes /** *

Starts replicating the specified application by creating replication jobs for each server in the * application.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { SMSClient, StartAppReplicationCommand } from "@aws-sdk/client-sms"; // ES Modules import + * // const { SMSClient, StartAppReplicationCommand } = require("@aws-sdk/client-sms"); // CommonJS import + * const client = new SMSClient(config); + * const command = new StartAppReplicationCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link StartAppReplicationCommandInput} for command's `input` shape. + * @see {@link StartAppReplicationCommandOutput} for command's `response` shape. + * @see {@link SMSClientResolvedConfig | config} for command's `input` shape. + * */ export class StartAppReplicationCommand extends $Command< StartAppReplicationCommandInput, diff --git a/clients/client-sms/commands/StartOnDemandAppReplicationCommand.ts b/clients/client-sms/commands/StartOnDemandAppReplicationCommand.ts index 339085d671d7..eab18b31f3e4 100644 --- a/clients/client-sms/commands/StartOnDemandAppReplicationCommand.ts +++ b/clients/client-sms/commands/StartOnDemandAppReplicationCommand.ts @@ -24,6 +24,20 @@ export interface StartOnDemandAppReplicationCommandOutput /** *

Starts an on-demand replication run for the specified application.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { SMSClient, StartOnDemandAppReplicationCommand } from "@aws-sdk/client-sms"; // ES Modules import + * // const { SMSClient, StartOnDemandAppReplicationCommand } = require("@aws-sdk/client-sms"); // CommonJS import + * const client = new SMSClient(config); + * const command = new StartOnDemandAppReplicationCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link StartOnDemandAppReplicationCommandInput} for command's `input` shape. + * @see {@link StartOnDemandAppReplicationCommandOutput} for command's `response` shape. + * @see {@link SMSClientResolvedConfig | config} for command's `input` shape. + * */ export class StartOnDemandAppReplicationCommand extends $Command< StartOnDemandAppReplicationCommandInput, diff --git a/clients/client-sms/commands/StartOnDemandReplicationRunCommand.ts b/clients/client-sms/commands/StartOnDemandReplicationRunCommand.ts index f70f1ab30c26..beccd9dff538 100644 --- a/clients/client-sms/commands/StartOnDemandReplicationRunCommand.ts +++ b/clients/client-sms/commands/StartOnDemandReplicationRunCommand.ts @@ -28,6 +28,20 @@ export interface StartOnDemandReplicationRunCommandOutput * already scheduled.

*

There is a limit on the number of on-demand replications runs that you can request * in a 24-hour period.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { SMSClient, StartOnDemandReplicationRunCommand } from "@aws-sdk/client-sms"; // ES Modules import + * // const { SMSClient, StartOnDemandReplicationRunCommand } = require("@aws-sdk/client-sms"); // CommonJS import + * const client = new SMSClient(config); + * const command = new StartOnDemandReplicationRunCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link StartOnDemandReplicationRunCommandInput} for command's `input` shape. + * @see {@link StartOnDemandReplicationRunCommandOutput} for command's `response` shape. + * @see {@link SMSClientResolvedConfig | config} for command's `input` shape. + * */ export class StartOnDemandReplicationRunCommand extends $Command< StartOnDemandReplicationRunCommandInput, diff --git a/clients/client-sms/commands/StopAppReplicationCommand.ts b/clients/client-sms/commands/StopAppReplicationCommand.ts index 3cb34a423529..03d8c61c29bd 100644 --- a/clients/client-sms/commands/StopAppReplicationCommand.ts +++ b/clients/client-sms/commands/StopAppReplicationCommand.ts @@ -23,6 +23,20 @@ export interface StopAppReplicationCommandOutput extends StopAppReplicationRespo /** *

Stops replicating the specified application by deleting the replication job for each server in * the application.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { SMSClient, StopAppReplicationCommand } from "@aws-sdk/client-sms"; // ES Modules import + * // const { SMSClient, StopAppReplicationCommand } = require("@aws-sdk/client-sms"); // CommonJS import + * const client = new SMSClient(config); + * const command = new StopAppReplicationCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link StopAppReplicationCommandInput} for command's `input` shape. + * @see {@link StopAppReplicationCommandOutput} for command's `response` shape. + * @see {@link SMSClientResolvedConfig | config} for command's `input` shape. + * */ export class StopAppReplicationCommand extends $Command< StopAppReplicationCommandInput, diff --git a/clients/client-sms/commands/TerminateAppCommand.ts b/clients/client-sms/commands/TerminateAppCommand.ts index 920cf7e7fe2c..fa4ef62cda05 100644 --- a/clients/client-sms/commands/TerminateAppCommand.ts +++ b/clients/client-sms/commands/TerminateAppCommand.ts @@ -22,6 +22,20 @@ export interface TerminateAppCommandOutput extends TerminateAppResponse, __Metad /** *

Terminates the stack for the specified application.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { SMSClient, TerminateAppCommand } from "@aws-sdk/client-sms"; // ES Modules import + * // const { SMSClient, TerminateAppCommand } = require("@aws-sdk/client-sms"); // CommonJS import + * const client = new SMSClient(config); + * const command = new TerminateAppCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link TerminateAppCommandInput} for command's `input` shape. + * @see {@link TerminateAppCommandOutput} for command's `response` shape. + * @see {@link SMSClientResolvedConfig | config} for command's `input` shape. + * */ export class TerminateAppCommand extends $Command< TerminateAppCommandInput, diff --git a/clients/client-sms/commands/UpdateAppCommand.ts b/clients/client-sms/commands/UpdateAppCommand.ts index b8b797d196bc..a3410d80c13a 100644 --- a/clients/client-sms/commands/UpdateAppCommand.ts +++ b/clients/client-sms/commands/UpdateAppCommand.ts @@ -19,6 +19,20 @@ export interface UpdateAppCommandOutput extends UpdateAppResponse, __MetadataBea /** *

Updates the specified application.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { SMSClient, UpdateAppCommand } from "@aws-sdk/client-sms"; // ES Modules import + * // const { SMSClient, UpdateAppCommand } = require("@aws-sdk/client-sms"); // CommonJS import + * const client = new SMSClient(config); + * const command = new UpdateAppCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link UpdateAppCommandInput} for command's `input` shape. + * @see {@link UpdateAppCommandOutput} for command's `response` shape. + * @see {@link SMSClientResolvedConfig | config} for command's `input` shape. + * */ export class UpdateAppCommand extends $Command { // Start section: command_properties diff --git a/clients/client-sms/commands/UpdateReplicationJobCommand.ts b/clients/client-sms/commands/UpdateReplicationJobCommand.ts index 24554342e8ad..55c49ab5318c 100644 --- a/clients/client-sms/commands/UpdateReplicationJobCommand.ts +++ b/clients/client-sms/commands/UpdateReplicationJobCommand.ts @@ -22,6 +22,20 @@ export interface UpdateReplicationJobCommandOutput extends UpdateReplicationJobR /** *

Updates the specified settings for the specified replication job.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { SMSClient, UpdateReplicationJobCommand } from "@aws-sdk/client-sms"; // ES Modules import + * // const { SMSClient, UpdateReplicationJobCommand } = require("@aws-sdk/client-sms"); // CommonJS import + * const client = new SMSClient(config); + * const command = new UpdateReplicationJobCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link UpdateReplicationJobCommandInput} for command's `input` shape. + * @see {@link UpdateReplicationJobCommandOutput} for command's `response` shape. + * @see {@link SMSClientResolvedConfig | config} for command's `input` shape. + * */ export class UpdateReplicationJobCommand extends $Command< UpdateReplicationJobCommandInput, diff --git a/clients/client-sms/models/models_0.ts b/clients/client-sms/models/models_0.ts index 9fd6d4a28998..44269c9f45a0 100644 --- a/clients/client-sms/models/models_0.ts +++ b/clients/client-sms/models/models_0.ts @@ -69,6 +69,9 @@ export interface LaunchDetails { } export namespace LaunchDetails { + /** + * @internal + */ export const filterSensitiveLog = (obj: LaunchDetails): any => ({ ...obj, }); @@ -184,6 +187,9 @@ export interface AppSummary { } export namespace AppSummary { + /** + * @internal + */ export const filterSensitiveLog = (obj: AppSummary): any => ({ ...obj, }); @@ -214,6 +220,9 @@ export interface S3Location { } export namespace S3Location { + /** + * @internal + */ export const filterSensitiveLog = (obj: S3Location): any => ({ ...obj, }); @@ -230,6 +239,9 @@ export interface Source { } export namespace Source { + /** + * @internal + */ export const filterSensitiveLog = (obj: Source): any => ({ ...obj, }); @@ -271,6 +283,9 @@ export interface SSMValidationParameters { } export namespace SSMValidationParameters { + /** + * @internal + */ export const filterSensitiveLog = (obj: SSMValidationParameters): any => ({ ...obj, }); @@ -302,6 +317,9 @@ export interface AppValidationConfiguration { } export namespace AppValidationConfiguration { + /** + * @internal + */ export const filterSensitiveLog = (obj: AppValidationConfiguration): any => ({ ...obj, }); @@ -318,6 +336,9 @@ export interface SSMOutput { } export namespace SSMOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: SSMOutput): any => ({ ...obj, }); @@ -334,6 +355,9 @@ export interface AppValidationOutput { } export namespace AppValidationOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: AppValidationOutput): any => ({ ...obj, }); @@ -365,6 +389,9 @@ export interface VmServerAddress { } export namespace VmServerAddress { + /** + * @internal + */ export const filterSensitiveLog = (obj: VmServerAddress): any => ({ ...obj, }); @@ -401,6 +428,9 @@ export interface VmServer { } export namespace VmServer { + /** + * @internal + */ export const filterSensitiveLog = (obj: VmServer): any => ({ ...obj, }); @@ -437,6 +467,9 @@ export interface Server { } export namespace Server { + /** + * @internal + */ export const filterSensitiveLog = (obj: Server): any => ({ ...obj, }); @@ -463,6 +496,9 @@ export interface ServerGroup { } export namespace ServerGroup { + /** + * @internal + */ export const filterSensitiveLog = (obj: ServerGroup): any => ({ ...obj, }); @@ -484,6 +520,9 @@ export interface Tag { } export namespace Tag { + /** + * @internal + */ export const filterSensitiveLog = (obj: Tag): any => ({ ...obj, }); @@ -523,6 +562,9 @@ export interface CreateAppRequest { } export namespace CreateAppRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateAppRequest): any => ({ ...obj, }); @@ -546,6 +588,9 @@ export interface CreateAppResponse { } export namespace CreateAppResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateAppResponse): any => ({ ...obj, }); @@ -561,6 +606,9 @@ export interface InternalError extends __SmithyException, $MetadataBearer { } export namespace InternalError { + /** + * @internal + */ export const filterSensitiveLog = (obj: InternalError): any => ({ ...obj, }); @@ -576,6 +624,9 @@ export interface InvalidParameterException extends __SmithyException, $MetadataB } export namespace InvalidParameterException { + /** + * @internal + */ export const filterSensitiveLog = (obj: InvalidParameterException): any => ({ ...obj, }); @@ -591,6 +642,9 @@ export interface MissingRequiredParameterException extends __SmithyException, $M } export namespace MissingRequiredParameterException { + /** + * @internal + */ export const filterSensitiveLog = (obj: MissingRequiredParameterException): any => ({ ...obj, }); @@ -606,6 +660,9 @@ export interface OperationNotPermittedException extends __SmithyException, $Meta } export namespace OperationNotPermittedException { + /** + * @internal + */ export const filterSensitiveLog = (obj: OperationNotPermittedException): any => ({ ...obj, }); @@ -622,6 +679,9 @@ export interface UnauthorizedOperationException extends __SmithyException, $Meta } export namespace UnauthorizedOperationException { + /** + * @internal + */ export const filterSensitiveLog = (obj: UnauthorizedOperationException): any => ({ ...obj, }); @@ -704,6 +764,9 @@ export interface CreateReplicationJobRequest { } export namespace CreateReplicationJobRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateReplicationJobRequest): any => ({ ...obj, }); @@ -717,6 +780,9 @@ export interface CreateReplicationJobResponse { } export namespace CreateReplicationJobResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateReplicationJobResponse): any => ({ ...obj, }); @@ -732,6 +798,9 @@ export interface NoConnectorsAvailableException extends __SmithyException, $Meta } export namespace NoConnectorsAvailableException { + /** + * @internal + */ export const filterSensitiveLog = (obj: NoConnectorsAvailableException): any => ({ ...obj, }); @@ -747,6 +816,9 @@ export interface ReplicationJobAlreadyExistsException extends __SmithyException, } export namespace ReplicationJobAlreadyExistsException { + /** + * @internal + */ export const filterSensitiveLog = (obj: ReplicationJobAlreadyExistsException): any => ({ ...obj, }); @@ -762,6 +834,9 @@ export interface ServerCannotBeReplicatedException extends __SmithyException, $M } export namespace ServerCannotBeReplicatedException { + /** + * @internal + */ export const filterSensitiveLog = (obj: ServerCannotBeReplicatedException): any => ({ ...obj, }); @@ -776,6 +851,9 @@ export interface TemporarilyUnavailableException extends __SmithyException, $Met } export namespace TemporarilyUnavailableException { + /** + * @internal + */ export const filterSensitiveLog = (obj: TemporarilyUnavailableException): any => ({ ...obj, }); @@ -801,6 +879,9 @@ export interface DeleteAppRequest { } export namespace DeleteAppRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteAppRequest): any => ({ ...obj, }); @@ -809,6 +890,9 @@ export namespace DeleteAppRequest { export interface DeleteAppResponse {} export namespace DeleteAppResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteAppResponse): any => ({ ...obj, }); @@ -822,6 +906,9 @@ export interface DeleteAppLaunchConfigurationRequest { } export namespace DeleteAppLaunchConfigurationRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteAppLaunchConfigurationRequest): any => ({ ...obj, }); @@ -830,6 +917,9 @@ export namespace DeleteAppLaunchConfigurationRequest { export interface DeleteAppLaunchConfigurationResponse {} export namespace DeleteAppLaunchConfigurationResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteAppLaunchConfigurationResponse): any => ({ ...obj, }); @@ -843,6 +933,9 @@ export interface DeleteAppReplicationConfigurationRequest { } export namespace DeleteAppReplicationConfigurationRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteAppReplicationConfigurationRequest): any => ({ ...obj, }); @@ -851,6 +944,9 @@ export namespace DeleteAppReplicationConfigurationRequest { export interface DeleteAppReplicationConfigurationResponse {} export namespace DeleteAppReplicationConfigurationResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteAppReplicationConfigurationResponse): any => ({ ...obj, }); @@ -864,6 +960,9 @@ export interface DeleteAppValidationConfigurationRequest { } export namespace DeleteAppValidationConfigurationRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteAppValidationConfigurationRequest): any => ({ ...obj, }); @@ -872,6 +971,9 @@ export namespace DeleteAppValidationConfigurationRequest { export interface DeleteAppValidationConfigurationResponse {} export namespace DeleteAppValidationConfigurationResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteAppValidationConfigurationResponse): any => ({ ...obj, }); @@ -885,6 +987,9 @@ export interface DeleteReplicationJobRequest { } export namespace DeleteReplicationJobRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteReplicationJobRequest): any => ({ ...obj, }); @@ -893,6 +998,9 @@ export namespace DeleteReplicationJobRequest { export interface DeleteReplicationJobResponse {} export namespace DeleteReplicationJobResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteReplicationJobResponse): any => ({ ...obj, }); @@ -908,6 +1016,9 @@ export interface ReplicationJobNotFoundException extends __SmithyException, $Met } export namespace ReplicationJobNotFoundException { + /** + * @internal + */ export const filterSensitiveLog = (obj: ReplicationJobNotFoundException): any => ({ ...obj, }); @@ -916,6 +1027,9 @@ export namespace ReplicationJobNotFoundException { export interface DeleteServerCatalogRequest {} export namespace DeleteServerCatalogRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteServerCatalogRequest): any => ({ ...obj, }); @@ -924,6 +1038,9 @@ export namespace DeleteServerCatalogRequest { export interface DeleteServerCatalogResponse {} export namespace DeleteServerCatalogResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteServerCatalogResponse): any => ({ ...obj, }); @@ -937,6 +1054,9 @@ export interface DisassociateConnectorRequest { } export namespace DisassociateConnectorRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DisassociateConnectorRequest): any => ({ ...obj, }); @@ -945,6 +1065,9 @@ export namespace DisassociateConnectorRequest { export interface DisassociateConnectorResponse {} export namespace DisassociateConnectorResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DisassociateConnectorResponse): any => ({ ...obj, }); @@ -968,6 +1091,9 @@ export interface GenerateChangeSetRequest { } export namespace GenerateChangeSetRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GenerateChangeSetRequest): any => ({ ...obj, }); @@ -981,6 +1107,9 @@ export interface GenerateChangeSetResponse { } export namespace GenerateChangeSetResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: GenerateChangeSetResponse): any => ({ ...obj, }); @@ -999,6 +1128,9 @@ export interface GenerateTemplateRequest { } export namespace GenerateTemplateRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GenerateTemplateRequest): any => ({ ...obj, }); @@ -1012,6 +1144,9 @@ export interface GenerateTemplateResponse { } export namespace GenerateTemplateResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: GenerateTemplateResponse): any => ({ ...obj, }); @@ -1025,6 +1160,9 @@ export interface GetAppRequest { } export namespace GetAppRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetAppRequest): any => ({ ...obj, }); @@ -1048,6 +1186,9 @@ export interface GetAppResponse { } export namespace GetAppResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetAppResponse): any => ({ ...obj, }); @@ -1061,6 +1202,9 @@ export interface GetAppLaunchConfigurationRequest { } export namespace GetAppLaunchConfigurationRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetAppLaunchConfigurationRequest): any => ({ ...obj, }); @@ -1078,6 +1222,9 @@ export interface UserData { } export namespace UserData { + /** + * @internal + */ export const filterSensitiveLog = (obj: UserData): any => ({ ...obj, }); @@ -1149,6 +1296,9 @@ export interface ServerLaunchConfiguration { } export namespace ServerLaunchConfiguration { + /** + * @internal + */ export const filterSensitiveLog = (obj: ServerLaunchConfiguration): any => ({ ...obj, }); @@ -1176,6 +1326,9 @@ export interface ServerGroupLaunchConfiguration { } export namespace ServerGroupLaunchConfiguration { + /** + * @internal + */ export const filterSensitiveLog = (obj: ServerGroupLaunchConfiguration): any => ({ ...obj, }); @@ -1205,6 +1358,9 @@ export interface GetAppLaunchConfigurationResponse { } export namespace GetAppLaunchConfigurationResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetAppLaunchConfigurationResponse): any => ({ ...obj, }); @@ -1218,6 +1374,9 @@ export interface GetAppReplicationConfigurationRequest { } export namespace GetAppReplicationConfigurationRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetAppReplicationConfigurationRequest): any => ({ ...obj, }); @@ -1281,6 +1440,9 @@ export interface ServerReplicationParameters { } export namespace ServerReplicationParameters { + /** + * @internal + */ export const filterSensitiveLog = (obj: ServerReplicationParameters): any => ({ ...obj, }); @@ -1303,6 +1465,9 @@ export interface ServerReplicationConfiguration { } export namespace ServerReplicationConfiguration { + /** + * @internal + */ export const filterSensitiveLog = (obj: ServerReplicationConfiguration): any => ({ ...obj, }); @@ -1325,6 +1490,9 @@ export interface ServerGroupReplicationConfiguration { } export namespace ServerGroupReplicationConfiguration { + /** + * @internal + */ export const filterSensitiveLog = (obj: ServerGroupReplicationConfiguration): any => ({ ...obj, }); @@ -1338,6 +1506,9 @@ export interface GetAppReplicationConfigurationResponse { } export namespace GetAppReplicationConfigurationResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetAppReplicationConfigurationResponse): any => ({ ...obj, }); @@ -1351,6 +1522,9 @@ export interface GetAppValidationConfigurationRequest { } export namespace GetAppValidationConfigurationRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetAppValidationConfigurationRequest): any => ({ ...obj, }); @@ -1376,6 +1550,9 @@ export interface UserDataValidationParameters { } export namespace UserDataValidationParameters { + /** + * @internal + */ export const filterSensitiveLog = (obj: UserDataValidationParameters): any => ({ ...obj, }); @@ -1412,6 +1589,9 @@ export interface ServerValidationConfiguration { } export namespace ServerValidationConfiguration { + /** + * @internal + */ export const filterSensitiveLog = (obj: ServerValidationConfiguration): any => ({ ...obj, }); @@ -1433,6 +1613,9 @@ export interface ServerGroupValidationConfiguration { } export namespace ServerGroupValidationConfiguration { + /** + * @internal + */ export const filterSensitiveLog = (obj: ServerGroupValidationConfiguration): any => ({ ...obj, }); @@ -1451,6 +1634,9 @@ export interface GetAppValidationConfigurationResponse { } export namespace GetAppValidationConfigurationResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetAppValidationConfigurationResponse): any => ({ ...obj, }); @@ -1464,6 +1650,9 @@ export interface GetAppValidationOutputRequest { } export namespace GetAppValidationOutputRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetAppValidationOutputRequest): any => ({ ...obj, }); @@ -1480,6 +1669,9 @@ export interface ServerValidationOutput { } export namespace ServerValidationOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: ServerValidationOutput): any => ({ ...obj, }); @@ -1534,6 +1726,9 @@ export interface ValidationOutput { } export namespace ValidationOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: ValidationOutput): any => ({ ...obj, }); @@ -1547,6 +1742,9 @@ export interface GetAppValidationOutputResponse { } export namespace GetAppValidationOutputResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetAppValidationOutputResponse): any => ({ ...obj, }); @@ -1567,6 +1765,9 @@ export interface GetConnectorsRequest { } export namespace GetConnectorsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetConnectorsRequest): any => ({ ...obj, }); @@ -1641,6 +1842,9 @@ export interface Connector { } export namespace Connector { + /** + * @internal + */ export const filterSensitiveLog = (obj: Connector): any => ({ ...obj, }); @@ -1660,6 +1864,9 @@ export interface GetConnectorsResponse { } export namespace GetConnectorsResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetConnectorsResponse): any => ({ ...obj, }); @@ -1685,6 +1892,9 @@ export interface GetReplicationJobsRequest { } export namespace GetReplicationJobsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetReplicationJobsRequest): any => ({ ...obj, }); @@ -1706,6 +1916,9 @@ export interface ReplicationRunStageDetails { } export namespace ReplicationRunStageDetails { + /** + * @internal + */ export const filterSensitiveLog = (obj: ReplicationRunStageDetails): any => ({ ...obj, }); @@ -1805,6 +2018,9 @@ export interface ReplicationRun { } export namespace ReplicationRun { + /** + * @internal + */ export const filterSensitiveLog = (obj: ReplicationRun): any => ({ ...obj, }); @@ -1936,6 +2152,9 @@ export interface ReplicationJob { } export namespace ReplicationJob { + /** + * @internal + */ export const filterSensitiveLog = (obj: ReplicationJob): any => ({ ...obj, }); @@ -1955,6 +2174,9 @@ export interface GetReplicationJobsResponse { } export namespace GetReplicationJobsResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetReplicationJobsResponse): any => ({ ...obj, }); @@ -1980,6 +2202,9 @@ export interface GetReplicationRunsRequest { } export namespace GetReplicationRunsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetReplicationRunsRequest): any => ({ ...obj, }); @@ -2004,6 +2229,9 @@ export interface GetReplicationRunsResponse { } export namespace GetReplicationRunsResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetReplicationRunsResponse): any => ({ ...obj, }); @@ -2029,6 +2257,9 @@ export interface GetServersRequest { } export namespace GetServersRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetServersRequest): any => ({ ...obj, }); @@ -2066,6 +2297,9 @@ export interface GetServersResponse { } export namespace GetServersResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetServersResponse): any => ({ ...obj, }); @@ -2081,6 +2315,9 @@ export interface ImportAppCatalogRequest { } export namespace ImportAppCatalogRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ImportAppCatalogRequest): any => ({ ...obj, }); @@ -2089,6 +2326,9 @@ export namespace ImportAppCatalogRequest { export interface ImportAppCatalogResponse {} export namespace ImportAppCatalogResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ImportAppCatalogResponse): any => ({ ...obj, }); @@ -2097,6 +2337,9 @@ export namespace ImportAppCatalogResponse { export interface ImportServerCatalogRequest {} export namespace ImportServerCatalogRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ImportServerCatalogRequest): any => ({ ...obj, }); @@ -2105,6 +2348,9 @@ export namespace ImportServerCatalogRequest { export interface ImportServerCatalogResponse {} export namespace ImportServerCatalogResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ImportServerCatalogResponse): any => ({ ...obj, }); @@ -2118,6 +2364,9 @@ export interface LaunchAppRequest { } export namespace LaunchAppRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: LaunchAppRequest): any => ({ ...obj, }); @@ -2126,6 +2375,9 @@ export namespace LaunchAppRequest { export interface LaunchAppResponse {} export namespace LaunchAppResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: LaunchAppResponse): any => ({ ...obj, }); @@ -2151,6 +2403,9 @@ export interface ListAppsRequest { } export namespace ListAppsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListAppsRequest): any => ({ ...obj, }); @@ -2170,6 +2425,9 @@ export interface ListAppsResponse { } export namespace ListAppsResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListAppsResponse): any => ({ ...obj, }); @@ -2196,6 +2454,9 @@ export interface NotificationContext { } export namespace NotificationContext { + /** + * @internal + */ export const filterSensitiveLog = (obj: NotificationContext): any => ({ ...obj, }); @@ -2214,6 +2475,9 @@ export interface NotifyAppValidationOutputRequest { } export namespace NotifyAppValidationOutputRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: NotifyAppValidationOutputRequest): any => ({ ...obj, }); @@ -2222,6 +2486,9 @@ export namespace NotifyAppValidationOutputRequest { export interface NotifyAppValidationOutputResponse {} export namespace NotifyAppValidationOutputResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: NotifyAppValidationOutputResponse): any => ({ ...obj, }); @@ -2251,6 +2518,9 @@ export interface PutAppLaunchConfigurationRequest { } export namespace PutAppLaunchConfigurationRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: PutAppLaunchConfigurationRequest): any => ({ ...obj, }); @@ -2259,6 +2529,9 @@ export namespace PutAppLaunchConfigurationRequest { export interface PutAppLaunchConfigurationResponse {} export namespace PutAppLaunchConfigurationResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: PutAppLaunchConfigurationResponse): any => ({ ...obj, }); @@ -2277,6 +2550,9 @@ export interface PutAppReplicationConfigurationRequest { } export namespace PutAppReplicationConfigurationRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: PutAppReplicationConfigurationRequest): any => ({ ...obj, }); @@ -2285,6 +2561,9 @@ export namespace PutAppReplicationConfigurationRequest { export interface PutAppReplicationConfigurationResponse {} export namespace PutAppReplicationConfigurationResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: PutAppReplicationConfigurationResponse): any => ({ ...obj, }); @@ -2308,6 +2587,9 @@ export interface PutAppValidationConfigurationRequest { } export namespace PutAppValidationConfigurationRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: PutAppValidationConfigurationRequest): any => ({ ...obj, }); @@ -2316,6 +2598,9 @@ export namespace PutAppValidationConfigurationRequest { export interface PutAppValidationConfigurationResponse {} export namespace PutAppValidationConfigurationResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: PutAppValidationConfigurationResponse): any => ({ ...obj, }); @@ -2329,6 +2614,9 @@ export interface StartAppReplicationRequest { } export namespace StartAppReplicationRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: StartAppReplicationRequest): any => ({ ...obj, }); @@ -2337,6 +2625,9 @@ export namespace StartAppReplicationRequest { export interface StartAppReplicationResponse {} export namespace StartAppReplicationResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: StartAppReplicationResponse): any => ({ ...obj, }); @@ -2355,6 +2646,9 @@ export interface StartOnDemandAppReplicationRequest { } export namespace StartOnDemandAppReplicationRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: StartOnDemandAppReplicationRequest): any => ({ ...obj, }); @@ -2363,6 +2657,9 @@ export namespace StartOnDemandAppReplicationRequest { export interface StartOnDemandAppReplicationResponse {} export namespace StartOnDemandAppReplicationResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: StartOnDemandAppReplicationResponse): any => ({ ...obj, }); @@ -2379,6 +2676,9 @@ export interface DryRunOperationException extends __SmithyException, $MetadataBe } export namespace DryRunOperationException { + /** + * @internal + */ export const filterSensitiveLog = (obj: DryRunOperationException): any => ({ ...obj, }); @@ -2395,6 +2695,9 @@ export interface ReplicationRunLimitExceededException extends __SmithyException, } export namespace ReplicationRunLimitExceededException { + /** + * @internal + */ export const filterSensitiveLog = (obj: ReplicationRunLimitExceededException): any => ({ ...obj, }); @@ -2413,6 +2716,9 @@ export interface StartOnDemandReplicationRunRequest { } export namespace StartOnDemandReplicationRunRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: StartOnDemandReplicationRunRequest): any => ({ ...obj, }); @@ -2426,6 +2732,9 @@ export interface StartOnDemandReplicationRunResponse { } export namespace StartOnDemandReplicationRunResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: StartOnDemandReplicationRunResponse): any => ({ ...obj, }); @@ -2439,6 +2748,9 @@ export interface StopAppReplicationRequest { } export namespace StopAppReplicationRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: StopAppReplicationRequest): any => ({ ...obj, }); @@ -2447,6 +2759,9 @@ export namespace StopAppReplicationRequest { export interface StopAppReplicationResponse {} export namespace StopAppReplicationResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: StopAppReplicationResponse): any => ({ ...obj, }); @@ -2460,6 +2775,9 @@ export interface TerminateAppRequest { } export namespace TerminateAppRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: TerminateAppRequest): any => ({ ...obj, }); @@ -2468,6 +2786,9 @@ export namespace TerminateAppRequest { export interface TerminateAppResponse {} export namespace TerminateAppResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: TerminateAppResponse): any => ({ ...obj, }); @@ -2506,6 +2827,9 @@ export interface UpdateAppRequest { } export namespace UpdateAppRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateAppRequest): any => ({ ...obj, }); @@ -2529,6 +2853,9 @@ export interface UpdateAppResponse { } export namespace UpdateAppResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateAppResponse): any => ({ ...obj, }); @@ -2602,6 +2929,9 @@ export interface UpdateReplicationJobRequest { } export namespace UpdateReplicationJobRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateReplicationJobRequest): any => ({ ...obj, }); @@ -2610,6 +2940,9 @@ export namespace UpdateReplicationJobRequest { export interface UpdateReplicationJobResponse {} export namespace UpdateReplicationJobResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateReplicationJobResponse): any => ({ ...obj, }); diff --git a/clients/client-snowball/commands/CancelClusterCommand.ts b/clients/client-snowball/commands/CancelClusterCommand.ts index e1fff556b23a..e45bda477191 100644 --- a/clients/client-snowball/commands/CancelClusterCommand.ts +++ b/clients/client-snowball/commands/CancelClusterCommand.ts @@ -24,6 +24,20 @@ export interface CancelClusterCommandOutput extends CancelClusterResult, __Metad *

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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { SnowballClient, CancelClusterCommand } from "@aws-sdk/client-snowball"; // ES Modules import + * // const { SnowballClient, CancelClusterCommand } = require("@aws-sdk/client-snowball"); // CommonJS import + * const client = new SnowballClient(config); + * const command = new CancelClusterCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CancelClusterCommandInput} for command's `input` shape. + * @see {@link CancelClusterCommandOutput} for command's `response` shape. + * @see {@link SnowballClientResolvedConfig | config} for command's `input` shape. + * */ export class CancelClusterCommand extends $Command< CancelClusterCommandInput, diff --git a/clients/client-snowball/commands/CancelJobCommand.ts b/clients/client-snowball/commands/CancelJobCommand.ts index 10153093df14..e9d33a64b539 100644 --- a/clients/client-snowball/commands/CancelJobCommand.ts +++ b/clients/client-snowball/commands/CancelJobCommand.ts @@ -22,6 +22,20 @@ export interface CancelJobCommandOutput extends CancelJobResult, __MetadataBeare * value changes to PreparingAppliance. Requesting the ListJobs or * DescribeJob action returns a job's JobState as part of the * response element data returned.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { SnowballClient, CancelJobCommand } from "@aws-sdk/client-snowball"; // ES Modules import + * // const { SnowballClient, CancelJobCommand } = require("@aws-sdk/client-snowball"); // CommonJS import + * const client = new SnowballClient(config); + * const command = new CancelJobCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CancelJobCommandInput} for command's `input` shape. + * @see {@link CancelJobCommandOutput} for command's `response` shape. + * @see {@link SnowballClientResolvedConfig | config} for command's `input` shape. + * */ export class CancelJobCommand extends $Command< CancelJobCommandInput, diff --git a/clients/client-snowball/commands/CreateAddressCommand.ts b/clients/client-snowball/commands/CreateAddressCommand.ts index 9d8d2f6391bf..699b1cc83d29 100644 --- a/clients/client-snowball/commands/CreateAddressCommand.ts +++ b/clients/client-snowball/commands/CreateAddressCommand.ts @@ -25,6 +25,20 @@ export interface CreateAddressCommandOutput extends CreateAddressResult, __Metad * 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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { SnowballClient, CreateAddressCommand } from "@aws-sdk/client-snowball"; // ES Modules import + * // const { SnowballClient, CreateAddressCommand } = require("@aws-sdk/client-snowball"); // CommonJS import + * const client = new SnowballClient(config); + * const command = new CreateAddressCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreateAddressCommandInput} for command's `input` shape. + * @see {@link CreateAddressCommandOutput} for command's `response` shape. + * @see {@link SnowballClientResolvedConfig | config} for command's `input` shape. + * */ export class CreateAddressCommand extends $Command< CreateAddressCommandInput, diff --git a/clients/client-snowball/commands/CreateClusterCommand.ts b/clients/client-snowball/commands/CreateClusterCommand.ts index ee408e3eb1c6..4a5f663556b3 100644 --- a/clients/client-snowball/commands/CreateClusterCommand.ts +++ b/clients/client-snowball/commands/CreateClusterCommand.ts @@ -23,6 +23,20 @@ export interface CreateClusterCommandOutput extends CreateClusterResult, __Metad /** *

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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { SnowballClient, CreateClusterCommand } from "@aws-sdk/client-snowball"; // ES Modules import + * // const { SnowballClient, CreateClusterCommand } = require("@aws-sdk/client-snowball"); // CommonJS import + * const client = new SnowballClient(config); + * const command = new CreateClusterCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreateClusterCommandInput} for command's `input` shape. + * @see {@link CreateClusterCommandOutput} for command's `response` shape. + * @see {@link SnowballClientResolvedConfig | config} for command's `input` shape. + * */ export class CreateClusterCommand extends $Command< CreateClusterCommandInput, diff --git a/clients/client-snowball/commands/CreateJobCommand.ts b/clients/client-snowball/commands/CreateJobCommand.ts index 20f4b1263acb..4340d83c6e69 100644 --- a/clients/client-snowball/commands/CreateJobCommand.ts +++ b/clients/client-snowball/commands/CreateJobCommand.ts @@ -23,6 +23,20 @@ export interface CreateJobCommandOutput extends CreateJobResult, __MetadataBeare * 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. *

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { SnowballClient, CreateJobCommand } from "@aws-sdk/client-snowball"; // ES Modules import + * // const { SnowballClient, CreateJobCommand } = require("@aws-sdk/client-snowball"); // CommonJS import + * const client = new SnowballClient(config); + * const command = new CreateJobCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreateJobCommandInput} for command's `input` shape. + * @see {@link CreateJobCommandOutput} for command's `response` shape. + * @see {@link SnowballClientResolvedConfig | config} for command's `input` shape. + * */ export class CreateJobCommand extends $Command< CreateJobCommandInput, diff --git a/clients/client-snowball/commands/CreateReturnShippingLabelCommand.ts b/clients/client-snowball/commands/CreateReturnShippingLabelCommand.ts index 6a7e31349742..e012d26b67b6 100644 --- a/clients/client-snowball/commands/CreateReturnShippingLabelCommand.ts +++ b/clients/client-snowball/commands/CreateReturnShippingLabelCommand.ts @@ -22,6 +22,20 @@ export interface CreateReturnShippingLabelCommandOutput extends CreateReturnShip /** *

Creates a shipping label that will be used to return the Snow device to AWS.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { SnowballClient, CreateReturnShippingLabelCommand } from "@aws-sdk/client-snowball"; // ES Modules import + * // const { SnowballClient, CreateReturnShippingLabelCommand } = require("@aws-sdk/client-snowball"); // CommonJS import + * const client = new SnowballClient(config); + * const command = new CreateReturnShippingLabelCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreateReturnShippingLabelCommandInput} for command's `input` shape. + * @see {@link CreateReturnShippingLabelCommandOutput} for command's `response` shape. + * @see {@link SnowballClientResolvedConfig | config} for command's `input` shape. + * */ export class CreateReturnShippingLabelCommand extends $Command< CreateReturnShippingLabelCommandInput, diff --git a/clients/client-snowball/commands/DescribeAddressCommand.ts b/clients/client-snowball/commands/DescribeAddressCommand.ts index becfa34f00b8..d0d599c19543 100644 --- a/clients/client-snowball/commands/DescribeAddressCommand.ts +++ b/clients/client-snowball/commands/DescribeAddressCommand.ts @@ -23,6 +23,20 @@ export interface DescribeAddressCommandOutput extends DescribeAddressResult, __M /** *

Takes an AddressId and returns specific details about that address in the * form of an Address object.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { SnowballClient, DescribeAddressCommand } from "@aws-sdk/client-snowball"; // ES Modules import + * // const { SnowballClient, DescribeAddressCommand } = require("@aws-sdk/client-snowball"); // CommonJS import + * const client = new SnowballClient(config); + * const command = new DescribeAddressCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeAddressCommandInput} for command's `input` shape. + * @see {@link DescribeAddressCommandOutput} for command's `response` shape. + * @see {@link SnowballClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeAddressCommand extends $Command< DescribeAddressCommandInput, diff --git a/clients/client-snowball/commands/DescribeAddressesCommand.ts b/clients/client-snowball/commands/DescribeAddressesCommand.ts index 6dc8c06e5eb4..2f4dae82f8ac 100644 --- a/clients/client-snowball/commands/DescribeAddressesCommand.ts +++ b/clients/client-snowball/commands/DescribeAddressesCommand.ts @@ -24,6 +24,20 @@ export interface DescribeAddressesCommandOutput extends DescribeAddressesResult, *

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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { SnowballClient, DescribeAddressesCommand } from "@aws-sdk/client-snowball"; // ES Modules import + * // const { SnowballClient, DescribeAddressesCommand } = require("@aws-sdk/client-snowball"); // CommonJS import + * const client = new SnowballClient(config); + * const command = new DescribeAddressesCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeAddressesCommandInput} for command's `input` shape. + * @see {@link DescribeAddressesCommandOutput} for command's `response` shape. + * @see {@link SnowballClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeAddressesCommand extends $Command< DescribeAddressesCommandInput, diff --git a/clients/client-snowball/commands/DescribeClusterCommand.ts b/clients/client-snowball/commands/DescribeClusterCommand.ts index 912aa6a187c3..b4bc03754619 100644 --- a/clients/client-snowball/commands/DescribeClusterCommand.ts +++ b/clients/client-snowball/commands/DescribeClusterCommand.ts @@ -23,6 +23,20 @@ export interface DescribeClusterCommandOutput extends DescribeClusterResult, __M /** *

Returns information about a specific cluster including shipping information, cluster * status, and other important metadata.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { SnowballClient, DescribeClusterCommand } from "@aws-sdk/client-snowball"; // ES Modules import + * // const { SnowballClient, DescribeClusterCommand } = require("@aws-sdk/client-snowball"); // CommonJS import + * const client = new SnowballClient(config); + * const command = new DescribeClusterCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeClusterCommandInput} for command's `input` shape. + * @see {@link DescribeClusterCommandOutput} for command's `response` shape. + * @see {@link SnowballClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeClusterCommand extends $Command< DescribeClusterCommandInput, diff --git a/clients/client-snowball/commands/DescribeJobCommand.ts b/clients/client-snowball/commands/DescribeJobCommand.ts index 13ef30722d32..d1c4e840a618 100644 --- a/clients/client-snowball/commands/DescribeJobCommand.ts +++ b/clients/client-snowball/commands/DescribeJobCommand.ts @@ -23,6 +23,20 @@ export interface DescribeJobCommandOutput extends DescribeJobResult, __MetadataB /** *

Returns information about a specific job including shipping information, job status, * and other important metadata.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { SnowballClient, DescribeJobCommand } from "@aws-sdk/client-snowball"; // ES Modules import + * // const { SnowballClient, DescribeJobCommand } = require("@aws-sdk/client-snowball"); // CommonJS import + * const client = new SnowballClient(config); + * const command = new DescribeJobCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeJobCommandInput} for command's `input` shape. + * @see {@link DescribeJobCommandOutput} for command's `response` shape. + * @see {@link SnowballClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeJobCommand extends $Command< DescribeJobCommandInput, diff --git a/clients/client-snowball/commands/DescribeReturnShippingLabelCommand.ts b/clients/client-snowball/commands/DescribeReturnShippingLabelCommand.ts index d6702114e0e8..55c2164d81cc 100644 --- a/clients/client-snowball/commands/DescribeReturnShippingLabelCommand.ts +++ b/clients/client-snowball/commands/DescribeReturnShippingLabelCommand.ts @@ -22,6 +22,20 @@ export interface DescribeReturnShippingLabelCommandOutput extends DescribeReturn /** *

Information on the shipping label of a Snow device that is being returned to AWS.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { SnowballClient, DescribeReturnShippingLabelCommand } from "@aws-sdk/client-snowball"; // ES Modules import + * // const { SnowballClient, DescribeReturnShippingLabelCommand } = require("@aws-sdk/client-snowball"); // CommonJS import + * const client = new SnowballClient(config); + * const command = new DescribeReturnShippingLabelCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeReturnShippingLabelCommandInput} for command's `input` shape. + * @see {@link DescribeReturnShippingLabelCommandOutput} for command's `response` shape. + * @see {@link SnowballClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeReturnShippingLabelCommand extends $Command< DescribeReturnShippingLabelCommandInput, diff --git a/clients/client-snowball/commands/GetJobManifestCommand.ts b/clients/client-snowball/commands/GetJobManifestCommand.ts index 38f44b215b43..39b67cca1dfe 100644 --- a/clients/client-snowball/commands/GetJobManifestCommand.ts +++ b/clients/client-snowball/commands/GetJobManifestCommand.ts @@ -40,6 +40,20 @@ export interface GetJobManifestCommandOutput extends GetJobManifestResult, __Met * *

The credentials of a given job, including its manifest file and unlock code, expire 90 * days after the job is created.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { SnowballClient, GetJobManifestCommand } from "@aws-sdk/client-snowball"; // ES Modules import + * // const { SnowballClient, GetJobManifestCommand } = require("@aws-sdk/client-snowball"); // CommonJS import + * const client = new SnowballClient(config); + * const command = new GetJobManifestCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetJobManifestCommandInput} for command's `input` shape. + * @see {@link GetJobManifestCommandOutput} for command's `response` shape. + * @see {@link SnowballClientResolvedConfig | config} for command's `input` shape. + * */ export class GetJobManifestCommand extends $Command< GetJobManifestCommandInput, diff --git a/clients/client-snowball/commands/GetJobUnlockCodeCommand.ts b/clients/client-snowball/commands/GetJobUnlockCodeCommand.ts index c74f77c9e55c..34eb4406a591 100644 --- a/clients/client-snowball/commands/GetJobUnlockCodeCommand.ts +++ b/clients/client-snowball/commands/GetJobUnlockCodeCommand.ts @@ -34,6 +34,20 @@ export interface GetJobUnlockCodeCommandOutput extends GetJobUnlockCodeResult, _ * 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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { SnowballClient, GetJobUnlockCodeCommand } from "@aws-sdk/client-snowball"; // ES Modules import + * // const { SnowballClient, GetJobUnlockCodeCommand } = require("@aws-sdk/client-snowball"); // CommonJS import + * const client = new SnowballClient(config); + * const command = new GetJobUnlockCodeCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetJobUnlockCodeCommandInput} for command's `input` shape. + * @see {@link GetJobUnlockCodeCommandOutput} for command's `response` shape. + * @see {@link SnowballClientResolvedConfig | config} for command's `input` shape. + * */ export class GetJobUnlockCodeCommand extends $Command< GetJobUnlockCodeCommandInput, diff --git a/clients/client-snowball/commands/GetSnowballUsageCommand.ts b/clients/client-snowball/commands/GetSnowballUsageCommand.ts index 88774e2a981b..0abbcfd561ec 100644 --- a/clients/client-snowball/commands/GetSnowballUsageCommand.ts +++ b/clients/client-snowball/commands/GetSnowballUsageCommand.ts @@ -26,6 +26,20 @@ export interface GetSnowballUsageCommandOutput extends GetSnowballUsageResult, _ * *

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 AWS Support.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { SnowballClient, GetSnowballUsageCommand } from "@aws-sdk/client-snowball"; // ES Modules import + * // const { SnowballClient, GetSnowballUsageCommand } = require("@aws-sdk/client-snowball"); // CommonJS import + * const client = new SnowballClient(config); + * const command = new GetSnowballUsageCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetSnowballUsageCommandInput} for command's `input` shape. + * @see {@link GetSnowballUsageCommandOutput} for command's `response` shape. + * @see {@link SnowballClientResolvedConfig | config} for command's `input` shape. + * */ export class GetSnowballUsageCommand extends $Command< GetSnowballUsageCommandInput, diff --git a/clients/client-snowball/commands/GetSoftwareUpdatesCommand.ts b/clients/client-snowball/commands/GetSoftwareUpdatesCommand.ts index 3a273624fad0..62724b485340 100644 --- a/clients/client-snowball/commands/GetSoftwareUpdatesCommand.ts +++ b/clients/client-snowball/commands/GetSoftwareUpdatesCommand.ts @@ -23,6 +23,20 @@ export interface GetSoftwareUpdatesCommandOutput extends GetSoftwareUpdatesResul /** *

Returns an Amazon S3 presigned URL for an update file associated with a specified * JobId.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { SnowballClient, GetSoftwareUpdatesCommand } from "@aws-sdk/client-snowball"; // ES Modules import + * // const { SnowballClient, GetSoftwareUpdatesCommand } = require("@aws-sdk/client-snowball"); // CommonJS import + * const client = new SnowballClient(config); + * const command = new GetSoftwareUpdatesCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetSoftwareUpdatesCommandInput} for command's `input` shape. + * @see {@link GetSoftwareUpdatesCommandOutput} for command's `response` shape. + * @see {@link SnowballClientResolvedConfig | config} for command's `input` shape. + * */ export class GetSoftwareUpdatesCommand extends $Command< GetSoftwareUpdatesCommandInput, diff --git a/clients/client-snowball/commands/ListClusterJobsCommand.ts b/clients/client-snowball/commands/ListClusterJobsCommand.ts index 7cd26b5e9a3e..dbdf1f54e4ec 100644 --- a/clients/client-snowball/commands/ListClusterJobsCommand.ts +++ b/clients/client-snowball/commands/ListClusterJobsCommand.ts @@ -24,6 +24,20 @@ export interface ListClusterJobsCommandOutput extends ListClusterJobsResult, __M *

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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { SnowballClient, ListClusterJobsCommand } from "@aws-sdk/client-snowball"; // ES Modules import + * // const { SnowballClient, ListClusterJobsCommand } = require("@aws-sdk/client-snowball"); // CommonJS import + * const client = new SnowballClient(config); + * const command = new ListClusterJobsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListClusterJobsCommandInput} for command's `input` shape. + * @see {@link ListClusterJobsCommandOutput} for command's `response` shape. + * @see {@link SnowballClientResolvedConfig | config} for command's `input` shape. + * */ export class ListClusterJobsCommand extends $Command< ListClusterJobsCommandInput, diff --git a/clients/client-snowball/commands/ListClustersCommand.ts b/clients/client-snowball/commands/ListClustersCommand.ts index ed2d3d63d82f..5d82f793063b 100644 --- a/clients/client-snowball/commands/ListClustersCommand.ts +++ b/clients/client-snowball/commands/ListClustersCommand.ts @@ -24,6 +24,20 @@ export interface ListClustersCommandOutput extends ListClustersResult, __Metadat *

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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { SnowballClient, ListClustersCommand } from "@aws-sdk/client-snowball"; // ES Modules import + * // const { SnowballClient, ListClustersCommand } = require("@aws-sdk/client-snowball"); // CommonJS import + * const client = new SnowballClient(config); + * const command = new ListClustersCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListClustersCommandInput} for command's `input` shape. + * @see {@link ListClustersCommandOutput} for command's `response` shape. + * @see {@link SnowballClientResolvedConfig | config} for command's `input` shape. + * */ export class ListClustersCommand extends $Command< ListClustersCommandInput, diff --git a/clients/client-snowball/commands/ListCompatibleImagesCommand.ts b/clients/client-snowball/commands/ListCompatibleImagesCommand.ts index b9bcbf40cd54..fa34409c6549 100644 --- a/clients/client-snowball/commands/ListCompatibleImagesCommand.ts +++ b/clients/client-snowball/commands/ListCompatibleImagesCommand.ts @@ -26,6 +26,20 @@ export interface ListCompatibleImagesCommandOutput extends ListCompatibleImagesR * 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 AWS * Marketplace.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { SnowballClient, ListCompatibleImagesCommand } from "@aws-sdk/client-snowball"; // ES Modules import + * // const { SnowballClient, ListCompatibleImagesCommand } = require("@aws-sdk/client-snowball"); // CommonJS import + * const client = new SnowballClient(config); + * const command = new ListCompatibleImagesCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListCompatibleImagesCommandInput} for command's `input` shape. + * @see {@link ListCompatibleImagesCommandOutput} for command's `response` shape. + * @see {@link SnowballClientResolvedConfig | config} for command's `input` shape. + * */ export class ListCompatibleImagesCommand extends $Command< ListCompatibleImagesCommandInput, diff --git a/clients/client-snowball/commands/ListJobsCommand.ts b/clients/client-snowball/commands/ListJobsCommand.ts index 22ff419f7144..d08a8df70167 100644 --- a/clients/client-snowball/commands/ListJobsCommand.ts +++ b/clients/client-snowball/commands/ListJobsCommand.ts @@ -23,6 +23,20 @@ export interface ListJobsCommandOutput extends ListJobsResult, __MetadataBearer * 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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { SnowballClient, ListJobsCommand } from "@aws-sdk/client-snowball"; // ES Modules import + * // const { SnowballClient, ListJobsCommand } = require("@aws-sdk/client-snowball"); // CommonJS import + * const client = new SnowballClient(config); + * const command = new ListJobsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListJobsCommandInput} for command's `input` shape. + * @see {@link ListJobsCommandOutput} for command's `response` shape. + * @see {@link SnowballClientResolvedConfig | config} for command's `input` shape. + * */ export class ListJobsCommand extends $Command< ListJobsCommandInput, diff --git a/clients/client-snowball/commands/UpdateClusterCommand.ts b/clients/client-snowball/commands/UpdateClusterCommand.ts index 88da691ec228..483a2900635e 100644 --- a/clients/client-snowball/commands/UpdateClusterCommand.ts +++ b/clients/client-snowball/commands/UpdateClusterCommand.ts @@ -25,6 +25,20 @@ export interface UpdateClusterCommandOutput extends UpdateClusterResult, __Metad * 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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { SnowballClient, UpdateClusterCommand } from "@aws-sdk/client-snowball"; // ES Modules import + * // const { SnowballClient, UpdateClusterCommand } = require("@aws-sdk/client-snowball"); // CommonJS import + * const client = new SnowballClient(config); + * const command = new UpdateClusterCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link UpdateClusterCommandInput} for command's `input` shape. + * @see {@link UpdateClusterCommandOutput} for command's `response` shape. + * @see {@link SnowballClientResolvedConfig | config} for command's `input` shape. + * */ export class UpdateClusterCommand extends $Command< UpdateClusterCommandInput, diff --git a/clients/client-snowball/commands/UpdateJobCommand.ts b/clients/client-snowball/commands/UpdateJobCommand.ts index 42d55d083d0f..c9ef7efdd91d 100644 --- a/clients/client-snowball/commands/UpdateJobCommand.ts +++ b/clients/client-snowball/commands/UpdateJobCommand.ts @@ -21,6 +21,20 @@ export interface UpdateJobCommandOutput extends UpdateJobResult, __MetadataBeare *

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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { SnowballClient, UpdateJobCommand } from "@aws-sdk/client-snowball"; // ES Modules import + * // const { SnowballClient, UpdateJobCommand } = require("@aws-sdk/client-snowball"); // CommonJS import + * const client = new SnowballClient(config); + * const command = new UpdateJobCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link UpdateJobCommandInput} for command's `input` shape. + * @see {@link UpdateJobCommandOutput} for command's `response` shape. + * @see {@link SnowballClientResolvedConfig | config} for command's `input` shape. + * */ export class UpdateJobCommand extends $Command< UpdateJobCommandInput, diff --git a/clients/client-snowball/commands/UpdateJobShipmentStateCommand.ts b/clients/client-snowball/commands/UpdateJobShipmentStateCommand.ts index e4172d9d4d41..6ae1dd28b2c3 100644 --- a/clients/client-snowball/commands/UpdateJobShipmentStateCommand.ts +++ b/clients/client-snowball/commands/UpdateJobShipmentStateCommand.ts @@ -22,6 +22,20 @@ export interface UpdateJobShipmentStateCommandOutput extends UpdateJobShipmentSt /** *

Updates the state when a the shipment states changes to a different state.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { SnowballClient, UpdateJobShipmentStateCommand } from "@aws-sdk/client-snowball"; // ES Modules import + * // const { SnowballClient, UpdateJobShipmentStateCommand } = require("@aws-sdk/client-snowball"); // CommonJS import + * const client = new SnowballClient(config); + * const command = new UpdateJobShipmentStateCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link UpdateJobShipmentStateCommandInput} for command's `input` shape. + * @see {@link UpdateJobShipmentStateCommandOutput} for command's `response` shape. + * @see {@link SnowballClientResolvedConfig | config} for command's `input` shape. + * */ export class UpdateJobShipmentStateCommand extends $Command< UpdateJobShipmentStateCommandInput, diff --git a/clients/client-snowball/models/models_0.ts b/clients/client-snowball/models/models_0.ts index d097103f2e57..7b5ced8690b0 100644 --- a/clients/client-snowball/models/models_0.ts +++ b/clients/client-snowball/models/models_0.ts @@ -86,6 +86,9 @@ export interface Address { } export namespace Address { + /** + * @internal + */ export const filterSensitiveLog = (obj: Address): any => ({ ...obj, }); @@ -100,6 +103,9 @@ export interface CancelClusterRequest { } export namespace CancelClusterRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: CancelClusterRequest): any => ({ ...obj, }); @@ -108,6 +114,9 @@ export namespace CancelClusterRequest { export interface CancelClusterResult {} export namespace CancelClusterResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: CancelClusterResult): any => ({ ...obj, }); @@ -124,6 +133,9 @@ export interface InvalidJobStateException extends __SmithyException, $MetadataBe } export namespace InvalidJobStateException { + /** + * @internal + */ export const filterSensitiveLog = (obj: InvalidJobStateException): any => ({ ...obj, }); @@ -144,6 +156,9 @@ export interface InvalidResourceException extends __SmithyException, $MetadataBe } export namespace InvalidResourceException { + /** + * @internal + */ export const filterSensitiveLog = (obj: InvalidResourceException): any => ({ ...obj, }); @@ -160,6 +175,9 @@ export interface KMSRequestFailedException extends __SmithyException, $MetadataB } export namespace KMSRequestFailedException { + /** + * @internal + */ export const filterSensitiveLog = (obj: KMSRequestFailedException): any => ({ ...obj, }); @@ -174,6 +192,9 @@ export interface CancelJobRequest { } export namespace CancelJobRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: CancelJobRequest): any => ({ ...obj, }); @@ -182,6 +203,9 @@ export namespace CancelJobRequest { export interface CancelJobResult {} export namespace CancelJobResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: CancelJobResult): any => ({ ...obj, }); @@ -195,6 +219,9 @@ export interface CreateAddressRequest { } export namespace CreateAddressRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateAddressRequest): any => ({ ...obj, }); @@ -209,6 +236,9 @@ export interface CreateAddressResult { } export namespace CreateAddressResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateAddressResult): any => ({ ...obj, }); @@ -225,6 +255,9 @@ export interface InvalidAddressException extends __SmithyException, $MetadataBea } export namespace InvalidAddressException { + /** + * @internal + */ export const filterSensitiveLog = (obj: InvalidAddressException): any => ({ ...obj, }); @@ -242,6 +275,9 @@ export interface UnsupportedAddressException extends __SmithyException, $Metadat } export namespace UnsupportedAddressException { + /** + * @internal + */ export const filterSensitiveLog = (obj: UnsupportedAddressException): any => ({ ...obj, }); @@ -303,6 +339,9 @@ export interface Notification { } export namespace Notification { + /** + * @internal + */ export const filterSensitiveLog = (obj: Notification): any => ({ ...obj, }); @@ -326,6 +365,9 @@ export interface Ec2AmiResource { } export namespace Ec2AmiResource { + /** + * @internal + */ export const filterSensitiveLog = (obj: Ec2AmiResource): any => ({ ...obj, }); @@ -343,6 +385,9 @@ export interface EventTriggerDefinition { } export namespace EventTriggerDefinition { + /** + * @internal + */ export const filterSensitiveLog = (obj: EventTriggerDefinition): any => ({ ...obj, }); @@ -365,6 +410,9 @@ export interface LambdaResource { } export namespace LambdaResource { + /** + * @internal + */ export const filterSensitiveLog = (obj: LambdaResource): any => ({ ...obj, }); @@ -391,6 +439,9 @@ export interface KeyRange { } export namespace KeyRange { + /** + * @internal + */ export const filterSensitiveLog = (obj: KeyRange): any => ({ ...obj, }); @@ -419,6 +470,9 @@ export interface S3Resource { } export namespace S3Resource { + /** + * @internal + */ export const filterSensitiveLog = (obj: S3Resource): any => ({ ...obj, }); @@ -447,6 +501,9 @@ export interface JobResource { } export namespace JobResource { + /** + * @internal + */ export const filterSensitiveLog = (obj: JobResource): any => ({ ...obj, }); @@ -479,6 +536,9 @@ export interface INDTaxDocuments { } export namespace INDTaxDocuments { + /** + * @internal + */ export const filterSensitiveLog = (obj: INDTaxDocuments): any => ({ ...obj, }); @@ -495,6 +555,9 @@ export interface TaxDocuments { } export namespace TaxDocuments { + /** + * @internal + */ export const filterSensitiveLog = (obj: TaxDocuments): any => ({ ...obj, }); @@ -613,6 +676,9 @@ export interface CreateClusterRequest { } export namespace CreateClusterRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateClusterRequest): any => ({ ...obj, }); @@ -626,6 +692,9 @@ export interface CreateClusterResult { } export namespace CreateClusterResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateClusterResult): any => ({ ...obj, }); @@ -642,6 +711,9 @@ export interface Ec2RequestFailedException extends __SmithyException, $MetadataB } export namespace Ec2RequestFailedException { + /** + * @internal + */ export const filterSensitiveLog = (obj: Ec2RequestFailedException): any => ({ ...obj, }); @@ -658,6 +730,9 @@ export interface InvalidInputCombinationException extends __SmithyException, $Me } export namespace InvalidInputCombinationException { + /** + * @internal + */ export const filterSensitiveLog = (obj: InvalidInputCombinationException): any => ({ ...obj, }); @@ -675,6 +750,9 @@ export interface ClusterLimitExceededException extends __SmithyException, $Metad } export namespace ClusterLimitExceededException { + /** + * @internal + */ export const filterSensitiveLog = (obj: ClusterLimitExceededException): any => ({ ...obj, }); @@ -691,6 +769,9 @@ export interface WirelessConnection { } export namespace WirelessConnection { + /** + * @internal + */ export const filterSensitiveLog = (obj: WirelessConnection): any => ({ ...obj, }); @@ -707,6 +788,9 @@ export interface SnowconeDeviceConfiguration { } export namespace SnowconeDeviceConfiguration { + /** + * @internal + */ export const filterSensitiveLog = (obj: SnowconeDeviceConfiguration): any => ({ ...obj, }); @@ -723,6 +807,9 @@ export interface DeviceConfiguration { } export namespace DeviceConfiguration { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeviceConfiguration): any => ({ ...obj, }); @@ -861,6 +948,9 @@ export interface CreateJobRequest { } export namespace CreateJobRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateJobRequest): any => ({ ...obj, }); @@ -875,6 +965,9 @@ export interface CreateJobResult { } export namespace CreateJobResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateJobResult): any => ({ ...obj, }); @@ -891,6 +984,9 @@ export interface ConflictException extends __SmithyException, $MetadataBearer { } export namespace ConflictException { + /** + * @internal + */ export const filterSensitiveLog = (obj: ConflictException): any => ({ ...obj, }); @@ -912,6 +1008,9 @@ export interface CreateReturnShippingLabelRequest { } export namespace CreateReturnShippingLabelRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateReturnShippingLabelRequest): any => ({ ...obj, }); @@ -932,6 +1031,9 @@ export interface CreateReturnShippingLabelResult { } export namespace CreateReturnShippingLabelResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateReturnShippingLabelResult): any => ({ ...obj, }); @@ -949,6 +1051,9 @@ export interface ReturnShippingLabelAlreadyExistsException extends __SmithyExcep } export namespace ReturnShippingLabelAlreadyExistsException { + /** + * @internal + */ export const filterSensitiveLog = (obj: ReturnShippingLabelAlreadyExistsException): any => ({ ...obj, }); @@ -962,6 +1067,9 @@ export interface DescribeAddressRequest { } export namespace DescribeAddressRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeAddressRequest): any => ({ ...obj, }); @@ -976,6 +1084,9 @@ export interface DescribeAddressResult { } export namespace DescribeAddressResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeAddressResult): any => ({ ...obj, }); @@ -996,6 +1107,9 @@ export interface DescribeAddressesRequest { } export namespace DescribeAddressesRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeAddressesRequest): any => ({ ...obj, }); @@ -1016,6 +1130,9 @@ export interface DescribeAddressesResult { } export namespace DescribeAddressesResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeAddressesResult): any => ({ ...obj, }); @@ -1033,6 +1150,9 @@ export interface InvalidNextTokenException extends __SmithyException, $MetadataB } export namespace InvalidNextTokenException { + /** + * @internal + */ export const filterSensitiveLog = (obj: InvalidNextTokenException): any => ({ ...obj, }); @@ -1046,6 +1166,9 @@ export interface DescribeClusterRequest { } export namespace DescribeClusterRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeClusterRequest): any => ({ ...obj, }); @@ -1166,6 +1289,9 @@ export interface ClusterMetadata { } export namespace ClusterMetadata { + /** + * @internal + */ export const filterSensitiveLog = (obj: ClusterMetadata): any => ({ ...obj, }); @@ -1180,6 +1306,9 @@ export interface DescribeClusterResult { } export namespace DescribeClusterResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeClusterResult): any => ({ ...obj, }); @@ -1194,6 +1323,9 @@ export interface DescribeJobRequest { } export namespace DescribeJobRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeJobRequest): any => ({ ...obj, }); @@ -1229,6 +1361,9 @@ export interface DataTransfer { } export namespace DataTransfer { + /** + * @internal + */ export const filterSensitiveLog = (obj: DataTransfer): any => ({ ...obj, }); @@ -1273,6 +1408,9 @@ export interface JobLogs { } export namespace JobLogs { + /** + * @internal + */ export const filterSensitiveLog = (obj: JobLogs): any => ({ ...obj, }); @@ -1298,6 +1436,9 @@ export interface Shipment { } export namespace Shipment { + /** + * @internal + */ export const filterSensitiveLog = (obj: Shipment): any => ({ ...obj, }); @@ -1349,6 +1490,9 @@ export interface ShippingDetails { } export namespace ShippingDetails { + /** + * @internal + */ export const filterSensitiveLog = (obj: ShippingDetails): any => ({ ...obj, }); @@ -1476,6 +1620,9 @@ export interface JobMetadata { } export namespace JobMetadata { + /** + * @internal + */ export const filterSensitiveLog = (obj: JobMetadata): any => ({ ...obj, }); @@ -1496,6 +1643,9 @@ export interface DescribeJobResult { } export namespace DescribeJobResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeJobResult): any => ({ ...obj, }); @@ -1510,6 +1660,9 @@ export interface DescribeReturnShippingLabelRequest { } export namespace DescribeReturnShippingLabelRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeReturnShippingLabelRequest): any => ({ ...obj, }); @@ -1528,6 +1681,9 @@ export interface DescribeReturnShippingLabelResult { } export namespace DescribeReturnShippingLabelResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeReturnShippingLabelResult): any => ({ ...obj, }); @@ -1542,6 +1698,9 @@ export interface GetJobManifestRequest { } export namespace GetJobManifestRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetJobManifestRequest): any => ({ ...obj, }); @@ -1556,6 +1715,9 @@ export interface GetJobManifestResult { } export namespace GetJobManifestResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetJobManifestResult): any => ({ ...obj, }); @@ -1570,6 +1732,9 @@ export interface GetJobUnlockCodeRequest { } export namespace GetJobUnlockCodeRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetJobUnlockCodeRequest): any => ({ ...obj, }); @@ -1584,6 +1749,9 @@ export interface GetJobUnlockCodeResult { } export namespace GetJobUnlockCodeResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetJobUnlockCodeResult): any => ({ ...obj, }); @@ -1592,6 +1760,9 @@ export namespace GetJobUnlockCodeResult { export interface GetSnowballUsageRequest {} export namespace GetSnowballUsageRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetSnowballUsageRequest): any => ({ ...obj, }); @@ -1611,6 +1782,9 @@ export interface GetSnowballUsageResult { } export namespace GetSnowballUsageResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetSnowballUsageResult): any => ({ ...obj, }); @@ -1625,6 +1799,9 @@ export interface GetSoftwareUpdatesRequest { } export namespace GetSoftwareUpdatesRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetSoftwareUpdatesRequest): any => ({ ...obj, }); @@ -1640,6 +1817,9 @@ export interface GetSoftwareUpdatesResult { } export namespace GetSoftwareUpdatesResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetSoftwareUpdatesResult): any => ({ ...obj, }); @@ -1666,6 +1846,9 @@ export interface ListClusterJobsRequest { } export namespace ListClusterJobsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListClusterJobsRequest): any => ({ ...obj, }); @@ -1719,6 +1902,9 @@ export interface JobListEntry { } export namespace JobListEntry { + /** + * @internal + */ export const filterSensitiveLog = (obj: JobListEntry): any => ({ ...obj, }); @@ -1740,6 +1926,9 @@ export interface ListClusterJobsResult { } export namespace ListClusterJobsResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListClusterJobsResult): any => ({ ...obj, }); @@ -1760,6 +1949,9 @@ export interface ListClustersRequest { } export namespace ListClustersRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListClustersRequest): any => ({ ...obj, }); @@ -1794,6 +1986,9 @@ export interface ClusterListEntry { } export namespace ClusterListEntry { + /** + * @internal + */ export const filterSensitiveLog = (obj: ClusterListEntry): any => ({ ...obj, }); @@ -1815,6 +2010,9 @@ export interface ListClustersResult { } export namespace ListClustersResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListClustersResult): any => ({ ...obj, }); @@ -1836,6 +2034,9 @@ export interface ListCompatibleImagesRequest { } export namespace ListCompatibleImagesRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListCompatibleImagesRequest): any => ({ ...obj, }); @@ -1860,6 +2061,9 @@ export interface CompatibleImage { } export namespace CompatibleImage { + /** + * @internal + */ export const filterSensitiveLog = (obj: CompatibleImage): any => ({ ...obj, }); @@ -1880,6 +2084,9 @@ export interface ListCompatibleImagesResult { } export namespace ListCompatibleImagesResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListCompatibleImagesResult): any => ({ ...obj, }); @@ -1900,6 +2107,9 @@ export interface ListJobsRequest { } export namespace ListJobsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListJobsRequest): any => ({ ...obj, }); @@ -1921,6 +2131,9 @@ export interface ListJobsResult { } export namespace ListJobsResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListJobsResult): any => ({ ...obj, }); @@ -1975,6 +2188,9 @@ export interface UpdateClusterRequest { } export namespace UpdateClusterRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateClusterRequest): any => ({ ...obj, }); @@ -1983,6 +2199,9 @@ export namespace UpdateClusterRequest { export interface UpdateClusterResult {} export namespace UpdateClusterResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateClusterResult): any => ({ ...obj, }); @@ -2042,6 +2261,9 @@ export interface UpdateJobRequest { } export namespace UpdateJobRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateJobRequest): any => ({ ...obj, }); @@ -2050,6 +2272,9 @@ export namespace UpdateJobRequest { export interface UpdateJobResult {} export namespace UpdateJobResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateJobResult): any => ({ ...obj, }); @@ -2076,6 +2301,9 @@ export interface UpdateJobShipmentStateRequest { } export namespace UpdateJobShipmentStateRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateJobShipmentStateRequest): any => ({ ...obj, }); @@ -2084,6 +2312,9 @@ export namespace UpdateJobShipmentStateRequest { export interface UpdateJobShipmentStateResult {} export namespace UpdateJobShipmentStateResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateJobShipmentStateResult): any => ({ ...obj, }); diff --git a/clients/client-sns/commands/AddPermissionCommand.ts b/clients/client-sns/commands/AddPermissionCommand.ts index 4b8784ea50c3..827ae4f2a63e 100644 --- a/clients/client-sns/commands/AddPermissionCommand.ts +++ b/clients/client-sns/commands/AddPermissionCommand.ts @@ -23,6 +23,20 @@ export interface AddPermissionCommandOutput extends __MetadataBearer {} /** *

Adds a statement to a topic's access control policy, granting access for the specified * AWS accounts to the specified actions.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { SNSClient, AddPermissionCommand } from "@aws-sdk/client-sns"; // ES Modules import + * // const { SNSClient, AddPermissionCommand } = require("@aws-sdk/client-sns"); // CommonJS import + * const client = new SNSClient(config); + * const command = new AddPermissionCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link AddPermissionCommandInput} for command's `input` shape. + * @see {@link AddPermissionCommandOutput} for command's `response` shape. + * @see {@link SNSClientResolvedConfig | config} for command's `input` shape. + * */ export class AddPermissionCommand extends $Command< AddPermissionCommandInput, diff --git a/clients/client-sns/commands/CheckIfPhoneNumberIsOptedOutCommand.ts b/clients/client-sns/commands/CheckIfPhoneNumberIsOptedOutCommand.ts index ae8744a57b05..c79bbafa5796 100644 --- a/clients/client-sns/commands/CheckIfPhoneNumberIsOptedOutCommand.ts +++ b/clients/client-sns/commands/CheckIfPhoneNumberIsOptedOutCommand.ts @@ -28,6 +28,20 @@ export interface CheckIfPhoneNumberIsOptedOutCommandOutput * is opted out.

*

To resume sending messages, you can opt in the number by using the * OptInPhoneNumber action.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { SNSClient, CheckIfPhoneNumberIsOptedOutCommand } from "@aws-sdk/client-sns"; // ES Modules import + * // const { SNSClient, CheckIfPhoneNumberIsOptedOutCommand } = require("@aws-sdk/client-sns"); // CommonJS import + * const client = new SNSClient(config); + * const command = new CheckIfPhoneNumberIsOptedOutCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CheckIfPhoneNumberIsOptedOutCommandInput} for command's `input` shape. + * @see {@link CheckIfPhoneNumberIsOptedOutCommandOutput} for command's `response` shape. + * @see {@link SNSClientResolvedConfig | config} for command's `input` shape. + * */ export class CheckIfPhoneNumberIsOptedOutCommand extends $Command< CheckIfPhoneNumberIsOptedOutCommandInput, diff --git a/clients/client-sns/commands/ConfirmSubscriptionCommand.ts b/clients/client-sns/commands/ConfirmSubscriptionCommand.ts index 9ababee9070d..e699c575b7e6 100644 --- a/clients/client-sns/commands/ConfirmSubscriptionCommand.ts +++ b/clients/client-sns/commands/ConfirmSubscriptionCommand.ts @@ -26,6 +26,20 @@ export interface ConfirmSubscriptionCommandOutput extends ConfirmSubscriptionRes * 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".

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { SNSClient, ConfirmSubscriptionCommand } from "@aws-sdk/client-sns"; // ES Modules import + * // const { SNSClient, ConfirmSubscriptionCommand } = require("@aws-sdk/client-sns"); // CommonJS import + * const client = new SNSClient(config); + * const command = new ConfirmSubscriptionCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ConfirmSubscriptionCommandInput} for command's `input` shape. + * @see {@link ConfirmSubscriptionCommandOutput} for command's `response` shape. + * @see {@link SNSClientResolvedConfig | config} for command's `input` shape. + * */ export class ConfirmSubscriptionCommand extends $Command< ConfirmSubscriptionCommandInput, diff --git a/clients/client-sns/commands/CreatePlatformApplicationCommand.ts b/clients/client-sns/commands/CreatePlatformApplicationCommand.ts index 8bae96e07480..71dfc9361e08 100644 --- a/clients/client-sns/commands/CreatePlatformApplicationCommand.ts +++ b/clients/client-sns/commands/CreatePlatformApplicationCommand.ts @@ -60,6 +60,20 @@ export interface CreatePlatformApplicationCommandOutput extends CreatePlatformAp * *

You can use the returned PlatformApplicationArn as an attribute for the * CreatePlatformEndpoint action.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { SNSClient, CreatePlatformApplicationCommand } from "@aws-sdk/client-sns"; // ES Modules import + * // const { SNSClient, CreatePlatformApplicationCommand } = require("@aws-sdk/client-sns"); // CommonJS import + * const client = new SNSClient(config); + * const command = new CreatePlatformApplicationCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreatePlatformApplicationCommandInput} for command's `input` shape. + * @see {@link CreatePlatformApplicationCommandOutput} for command's `response` shape. + * @see {@link SNSClientResolvedConfig | config} for command's `input` shape. + * */ export class CreatePlatformApplicationCommand extends $Command< CreatePlatformApplicationCommandInput, diff --git a/clients/client-sns/commands/CreatePlatformEndpointCommand.ts b/clients/client-sns/commands/CreatePlatformEndpointCommand.ts index 66718ddc1eba..e7ed8b38527e 100644 --- a/clients/client-sns/commands/CreatePlatformEndpointCommand.ts +++ b/clients/client-sns/commands/CreatePlatformEndpointCommand.ts @@ -35,6 +35,20 @@ export interface CreatePlatformEndpointCommandOutput extends CreateEndpointRespo * provided: ChannelId and UserId. The token field must also contain the ChannelId. For * more information, see Creating an Amazon SNS Endpoint * for Baidu.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { SNSClient, CreatePlatformEndpointCommand } from "@aws-sdk/client-sns"; // ES Modules import + * // const { SNSClient, CreatePlatformEndpointCommand } = require("@aws-sdk/client-sns"); // CommonJS import + * const client = new SNSClient(config); + * const command = new CreatePlatformEndpointCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreatePlatformEndpointCommandInput} for command's `input` shape. + * @see {@link CreatePlatformEndpointCommandOutput} for command's `response` shape. + * @see {@link SNSClientResolvedConfig | config} for command's `input` shape. + * */ export class CreatePlatformEndpointCommand extends $Command< CreatePlatformEndpointCommandInput, diff --git a/clients/client-sns/commands/CreateTopicCommand.ts b/clients/client-sns/commands/CreateTopicCommand.ts index 11a081223500..812de782a6d0 100644 --- a/clients/client-sns/commands/CreateTopicCommand.ts +++ b/clients/client-sns/commands/CreateTopicCommand.ts @@ -22,6 +22,20 @@ export interface CreateTopicCommandOutput extends CreateTopicResponse, __Metadat * 100,000 standard topics (at most 1,000 FIFO topics). For more information, see https://aws.amazon.com/sns. 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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { SNSClient, CreateTopicCommand } from "@aws-sdk/client-sns"; // ES Modules import + * // const { SNSClient, CreateTopicCommand } = require("@aws-sdk/client-sns"); // CommonJS import + * const client = new SNSClient(config); + * const command = new CreateTopicCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreateTopicCommandInput} for command's `input` shape. + * @see {@link CreateTopicCommandOutput} for command's `response` shape. + * @see {@link SNSClientResolvedConfig | config} for command's `input` shape. + * */ export class CreateTopicCommand extends $Command< CreateTopicCommandInput, diff --git a/clients/client-sns/commands/DeleteEndpointCommand.ts b/clients/client-sns/commands/DeleteEndpointCommand.ts index a448be33e115..07310ceec55e 100644 --- a/clients/client-sns/commands/DeleteEndpointCommand.ts +++ b/clients/client-sns/commands/DeleteEndpointCommand.ts @@ -26,6 +26,20 @@ export interface DeleteEndpointCommandOutput extends __MetadataBearer {} * Notifications.

*

When you delete an endpoint that is also subscribed to a topic, then you must also * unsubscribe the endpoint from the topic.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { SNSClient, DeleteEndpointCommand } from "@aws-sdk/client-sns"; // ES Modules import + * // const { SNSClient, DeleteEndpointCommand } = require("@aws-sdk/client-sns"); // CommonJS import + * const client = new SNSClient(config); + * const command = new DeleteEndpointCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteEndpointCommandInput} for command's `input` shape. + * @see {@link DeleteEndpointCommandOutput} for command's `response` shape. + * @see {@link SNSClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteEndpointCommand extends $Command< DeleteEndpointCommandInput, diff --git a/clients/client-sns/commands/DeletePlatformApplicationCommand.ts b/clients/client-sns/commands/DeletePlatformApplicationCommand.ts index 78830c35bbd6..1b8f51aeccfd 100644 --- a/clients/client-sns/commands/DeletePlatformApplicationCommand.ts +++ b/clients/client-sns/commands/DeletePlatformApplicationCommand.ts @@ -25,6 +25,20 @@ export interface DeletePlatformApplicationCommandOutput extends __MetadataBearer * services, such as APNS and GCM (Firebase Cloud Messaging). For more information, see * Using Amazon SNS * Mobile Push Notifications.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { SNSClient, DeletePlatformApplicationCommand } from "@aws-sdk/client-sns"; // ES Modules import + * // const { SNSClient, DeletePlatformApplicationCommand } = require("@aws-sdk/client-sns"); // CommonJS import + * const client = new SNSClient(config); + * const command = new DeletePlatformApplicationCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeletePlatformApplicationCommandInput} for command's `input` shape. + * @see {@link DeletePlatformApplicationCommandOutput} for command's `response` shape. + * @see {@link SNSClientResolvedConfig | config} for command's `input` shape. + * */ export class DeletePlatformApplicationCommand extends $Command< DeletePlatformApplicationCommandInput, diff --git a/clients/client-sns/commands/DeleteTopicCommand.ts b/clients/client-sns/commands/DeleteTopicCommand.ts index 66e86972a27b..389a4e33f097 100644 --- a/clients/client-sns/commands/DeleteTopicCommand.ts +++ b/clients/client-sns/commands/DeleteTopicCommand.ts @@ -22,6 +22,20 @@ export interface DeleteTopicCommandOutput extends __MetadataBearer {} * 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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { SNSClient, DeleteTopicCommand } from "@aws-sdk/client-sns"; // ES Modules import + * // const { SNSClient, DeleteTopicCommand } = require("@aws-sdk/client-sns"); // CommonJS import + * const client = new SNSClient(config); + * const command = new DeleteTopicCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteTopicCommandInput} for command's `input` shape. + * @see {@link DeleteTopicCommandOutput} for command's `response` shape. + * @see {@link SNSClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteTopicCommand extends $Command< DeleteTopicCommandInput, diff --git a/clients/client-sns/commands/GetEndpointAttributesCommand.ts b/clients/client-sns/commands/GetEndpointAttributesCommand.ts index 847c2f88e3b0..95cafdcae973 100644 --- a/clients/client-sns/commands/GetEndpointAttributesCommand.ts +++ b/clients/client-sns/commands/GetEndpointAttributesCommand.ts @@ -24,6 +24,20 @@ export interface GetEndpointAttributesCommandOutput extends GetEndpointAttribute *

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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { SNSClient, GetEndpointAttributesCommand } from "@aws-sdk/client-sns"; // ES Modules import + * // const { SNSClient, GetEndpointAttributesCommand } = require("@aws-sdk/client-sns"); // CommonJS import + * const client = new SNSClient(config); + * const command = new GetEndpointAttributesCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetEndpointAttributesCommandInput} for command's `input` shape. + * @see {@link GetEndpointAttributesCommandOutput} for command's `response` shape. + * @see {@link SNSClientResolvedConfig | config} for command's `input` shape. + * */ export class GetEndpointAttributesCommand extends $Command< GetEndpointAttributesCommandInput, diff --git a/clients/client-sns/commands/GetPlatformApplicationAttributesCommand.ts b/clients/client-sns/commands/GetPlatformApplicationAttributesCommand.ts index ce28a769610f..2d03e189c8ca 100644 --- a/clients/client-sns/commands/GetPlatformApplicationAttributesCommand.ts +++ b/clients/client-sns/commands/GetPlatformApplicationAttributesCommand.ts @@ -26,6 +26,20 @@ export interface GetPlatformApplicationAttributesCommandOutput *

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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { SNSClient, GetPlatformApplicationAttributesCommand } from "@aws-sdk/client-sns"; // ES Modules import + * // const { SNSClient, GetPlatformApplicationAttributesCommand } = require("@aws-sdk/client-sns"); // CommonJS import + * const client = new SNSClient(config); + * const command = new GetPlatformApplicationAttributesCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetPlatformApplicationAttributesCommandInput} for command's `input` shape. + * @see {@link GetPlatformApplicationAttributesCommandOutput} for command's `response` shape. + * @see {@link SNSClientResolvedConfig | config} for command's `input` shape. + * */ export class GetPlatformApplicationAttributesCommand extends $Command< GetPlatformApplicationAttributesCommandInput, diff --git a/clients/client-sns/commands/GetSMSAttributesCommand.ts b/clients/client-sns/commands/GetSMSAttributesCommand.ts index 623a7e376307..4edcec585fae 100644 --- a/clients/client-sns/commands/GetSMSAttributesCommand.ts +++ b/clients/client-sns/commands/GetSMSAttributesCommand.ts @@ -23,6 +23,20 @@ export interface GetSMSAttributesCommandOutput extends GetSMSAttributesResponse, /** *

Returns the settings for sending SMS messages from your account.

*

These settings are set with the SetSMSAttributes action.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { SNSClient, GetSMSAttributesCommand } from "@aws-sdk/client-sns"; // ES Modules import + * // const { SNSClient, GetSMSAttributesCommand } = require("@aws-sdk/client-sns"); // CommonJS import + * const client = new SNSClient(config); + * const command = new GetSMSAttributesCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetSMSAttributesCommandInput} for command's `input` shape. + * @see {@link GetSMSAttributesCommandOutput} for command's `response` shape. + * @see {@link SNSClientResolvedConfig | config} for command's `input` shape. + * */ export class GetSMSAttributesCommand extends $Command< GetSMSAttributesCommandInput, diff --git a/clients/client-sns/commands/GetSubscriptionAttributesCommand.ts b/clients/client-sns/commands/GetSubscriptionAttributesCommand.ts index 7c6a6f79790a..ac8b58d8e03d 100644 --- a/clients/client-sns/commands/GetSubscriptionAttributesCommand.ts +++ b/clients/client-sns/commands/GetSubscriptionAttributesCommand.ts @@ -22,6 +22,20 @@ export interface GetSubscriptionAttributesCommandOutput extends GetSubscriptionA /** *

Returns all of the properties of a subscription.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { SNSClient, GetSubscriptionAttributesCommand } from "@aws-sdk/client-sns"; // ES Modules import + * // const { SNSClient, GetSubscriptionAttributesCommand } = require("@aws-sdk/client-sns"); // CommonJS import + * const client = new SNSClient(config); + * const command = new GetSubscriptionAttributesCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetSubscriptionAttributesCommandInput} for command's `input` shape. + * @see {@link GetSubscriptionAttributesCommandOutput} for command's `response` shape. + * @see {@link SNSClientResolvedConfig | config} for command's `input` shape. + * */ export class GetSubscriptionAttributesCommand extends $Command< GetSubscriptionAttributesCommandInput, diff --git a/clients/client-sns/commands/GetTopicAttributesCommand.ts b/clients/client-sns/commands/GetTopicAttributesCommand.ts index 49335db3670a..ac757d5f0af2 100644 --- a/clients/client-sns/commands/GetTopicAttributesCommand.ts +++ b/clients/client-sns/commands/GetTopicAttributesCommand.ts @@ -23,6 +23,20 @@ export interface GetTopicAttributesCommandOutput extends GetTopicAttributesRespo /** *

Returns all of the properties of a topic. Topic properties returned might differ based * on the authorization of the user.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { SNSClient, GetTopicAttributesCommand } from "@aws-sdk/client-sns"; // ES Modules import + * // const { SNSClient, GetTopicAttributesCommand } = require("@aws-sdk/client-sns"); // CommonJS import + * const client = new SNSClient(config); + * const command = new GetTopicAttributesCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetTopicAttributesCommandInput} for command's `input` shape. + * @see {@link GetTopicAttributesCommandOutput} for command's `response` shape. + * @see {@link SNSClientResolvedConfig | config} for command's `input` shape. + * */ export class GetTopicAttributesCommand extends $Command< GetTopicAttributesCommandInput, diff --git a/clients/client-sns/commands/ListEndpointsByPlatformApplicationCommand.ts b/clients/client-sns/commands/ListEndpointsByPlatformApplicationCommand.ts index f9d5b5f20a24..74e1b0382161 100644 --- a/clients/client-sns/commands/ListEndpointsByPlatformApplicationCommand.ts +++ b/clients/client-sns/commands/ListEndpointsByPlatformApplicationCommand.ts @@ -36,6 +36,20 @@ export interface ListEndpointsByPlatformApplicationCommandOutput * will be null. For more information, see Using Amazon SNS Mobile Push * Notifications.

*

This action is throttled at 30 transactions per second (TPS).

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { SNSClient, ListEndpointsByPlatformApplicationCommand } from "@aws-sdk/client-sns"; // ES Modules import + * // const { SNSClient, ListEndpointsByPlatformApplicationCommand } = require("@aws-sdk/client-sns"); // CommonJS import + * const client = new SNSClient(config); + * const command = new ListEndpointsByPlatformApplicationCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListEndpointsByPlatformApplicationCommandInput} for command's `input` shape. + * @see {@link ListEndpointsByPlatformApplicationCommandOutput} for command's `response` shape. + * @see {@link SNSClientResolvedConfig | config} for command's `input` shape. + * */ export class ListEndpointsByPlatformApplicationCommand extends $Command< ListEndpointsByPlatformApplicationCommandInput, diff --git a/clients/client-sns/commands/ListPhoneNumbersOptedOutCommand.ts b/clients/client-sns/commands/ListPhoneNumbersOptedOutCommand.ts index 77158b44804f..570d3d65f6d6 100644 --- a/clients/client-sns/commands/ListPhoneNumbersOptedOutCommand.ts +++ b/clients/client-sns/commands/ListPhoneNumbersOptedOutCommand.ts @@ -29,6 +29,20 @@ export interface ListPhoneNumbersOptedOutCommandOutput extends ListPhoneNumbersO * 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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { SNSClient, ListPhoneNumbersOptedOutCommand } from "@aws-sdk/client-sns"; // ES Modules import + * // const { SNSClient, ListPhoneNumbersOptedOutCommand } = require("@aws-sdk/client-sns"); // CommonJS import + * const client = new SNSClient(config); + * const command = new ListPhoneNumbersOptedOutCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListPhoneNumbersOptedOutCommandInput} for command's `input` shape. + * @see {@link ListPhoneNumbersOptedOutCommandOutput} for command's `response` shape. + * @see {@link SNSClientResolvedConfig | config} for command's `input` shape. + * */ export class ListPhoneNumbersOptedOutCommand extends $Command< ListPhoneNumbersOptedOutCommandInput, diff --git a/clients/client-sns/commands/ListPlatformApplicationsCommand.ts b/clients/client-sns/commands/ListPlatformApplicationsCommand.ts index 8d37f559efd9..20df7a8709f7 100644 --- a/clients/client-sns/commands/ListPlatformApplicationsCommand.ts +++ b/clients/client-sns/commands/ListPlatformApplicationsCommand.ts @@ -31,6 +31,20 @@ export interface ListPlatformApplicationsCommandOutput extends ListPlatformAppli * null. For more information, see Using Amazon SNS Mobile Push * Notifications.

*

This action is throttled at 15 transactions per second (TPS).

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { SNSClient, ListPlatformApplicationsCommand } from "@aws-sdk/client-sns"; // ES Modules import + * // const { SNSClient, ListPlatformApplicationsCommand } = require("@aws-sdk/client-sns"); // CommonJS import + * const client = new SNSClient(config); + * const command = new ListPlatformApplicationsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListPlatformApplicationsCommandInput} for command's `input` shape. + * @see {@link ListPlatformApplicationsCommandOutput} for command's `response` shape. + * @see {@link SNSClientResolvedConfig | config} for command's `input` shape. + * */ export class ListPlatformApplicationsCommand extends $Command< ListPlatformApplicationsCommandInput, diff --git a/clients/client-sns/commands/ListSubscriptionsByTopicCommand.ts b/clients/client-sns/commands/ListSubscriptionsByTopicCommand.ts index 83c3add2a464..8b0502dec888 100644 --- a/clients/client-sns/commands/ListSubscriptionsByTopicCommand.ts +++ b/clients/client-sns/commands/ListSubscriptionsByTopicCommand.ts @@ -26,6 +26,20 @@ export interface ListSubscriptionsByTopicCommandOutput extends ListSubscriptions * 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).

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { SNSClient, ListSubscriptionsByTopicCommand } from "@aws-sdk/client-sns"; // ES Modules import + * // const { SNSClient, ListSubscriptionsByTopicCommand } = require("@aws-sdk/client-sns"); // CommonJS import + * const client = new SNSClient(config); + * const command = new ListSubscriptionsByTopicCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListSubscriptionsByTopicCommandInput} for command's `input` shape. + * @see {@link ListSubscriptionsByTopicCommandOutput} for command's `response` shape. + * @see {@link SNSClientResolvedConfig | config} for command's `input` shape. + * */ export class ListSubscriptionsByTopicCommand extends $Command< ListSubscriptionsByTopicCommandInput, diff --git a/clients/client-sns/commands/ListSubscriptionsCommand.ts b/clients/client-sns/commands/ListSubscriptionsCommand.ts index 3447b14d1b06..44b3386ea6b3 100644 --- a/clients/client-sns/commands/ListSubscriptionsCommand.ts +++ b/clients/client-sns/commands/ListSubscriptionsCommand.ts @@ -26,6 +26,20 @@ export interface ListSubscriptionsCommandOutput extends ListSubscriptionsRespons * 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).

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { SNSClient, ListSubscriptionsCommand } from "@aws-sdk/client-sns"; // ES Modules import + * // const { SNSClient, ListSubscriptionsCommand } = require("@aws-sdk/client-sns"); // CommonJS import + * const client = new SNSClient(config); + * const command = new ListSubscriptionsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListSubscriptionsCommandInput} for command's `input` shape. + * @see {@link ListSubscriptionsCommandOutput} for command's `response` shape. + * @see {@link SNSClientResolvedConfig | config} for command's `input` shape. + * */ export class ListSubscriptionsCommand extends $Command< ListSubscriptionsCommandInput, diff --git a/clients/client-sns/commands/ListTagsForResourceCommand.ts b/clients/client-sns/commands/ListTagsForResourceCommand.ts index aec722b57c9e..44b704cfc5d0 100644 --- a/clients/client-sns/commands/ListTagsForResourceCommand.ts +++ b/clients/client-sns/commands/ListTagsForResourceCommand.ts @@ -24,6 +24,20 @@ export interface ListTagsForResourceCommandOutput extends ListTagsForResourceRes *

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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { SNSClient, ListTagsForResourceCommand } from "@aws-sdk/client-sns"; // ES Modules import + * // const { SNSClient, ListTagsForResourceCommand } = require("@aws-sdk/client-sns"); // CommonJS import + * const client = new SNSClient(config); + * const command = new ListTagsForResourceCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListTagsForResourceCommandInput} for command's `input` shape. + * @see {@link ListTagsForResourceCommandOutput} for command's `response` shape. + * @see {@link SNSClientResolvedConfig | config} for command's `input` shape. + * */ export class ListTagsForResourceCommand extends $Command< ListTagsForResourceCommandInput, diff --git a/clients/client-sns/commands/ListTopicsCommand.ts b/clients/client-sns/commands/ListTopicsCommand.ts index a41c79a3335a..7eb05e3f5648 100644 --- a/clients/client-sns/commands/ListTopicsCommand.ts +++ b/clients/client-sns/commands/ListTopicsCommand.ts @@ -23,6 +23,20 @@ export interface ListTopicsCommandOutput extends ListTopicsResponse, __MetadataB * NextToken parameter in a new ListTopics call to get * further results.

*

This action is throttled at 30 transactions per second (TPS).

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { SNSClient, ListTopicsCommand } from "@aws-sdk/client-sns"; // ES Modules import + * // const { SNSClient, ListTopicsCommand } = require("@aws-sdk/client-sns"); // CommonJS import + * const client = new SNSClient(config); + * const command = new ListTopicsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListTopicsCommandInput} for command's `input` shape. + * @see {@link ListTopicsCommandOutput} for command's `response` shape. + * @see {@link SNSClientResolvedConfig | config} for command's `input` shape. + * */ export class ListTopicsCommand extends $Command< ListTopicsCommandInput, diff --git a/clients/client-sns/commands/OptInPhoneNumberCommand.ts b/clients/client-sns/commands/OptInPhoneNumberCommand.ts index 547dc6dfa21a..2170064f7eb2 100644 --- a/clients/client-sns/commands/OptInPhoneNumberCommand.ts +++ b/clients/client-sns/commands/OptInPhoneNumberCommand.ts @@ -24,6 +24,20 @@ export interface OptInPhoneNumberCommandOutput extends OptInPhoneNumberResponse, *

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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { SNSClient, OptInPhoneNumberCommand } from "@aws-sdk/client-sns"; // ES Modules import + * // const { SNSClient, OptInPhoneNumberCommand } = require("@aws-sdk/client-sns"); // CommonJS import + * const client = new SNSClient(config); + * const command = new OptInPhoneNumberCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link OptInPhoneNumberCommandInput} for command's `input` shape. + * @see {@link OptInPhoneNumberCommandOutput} for command's `response` shape. + * @see {@link SNSClientResolvedConfig | config} for command's `input` shape. + * */ export class OptInPhoneNumberCommand extends $Command< OptInPhoneNumberCommandInput, diff --git a/clients/client-sns/commands/PublishCommand.ts b/clients/client-sns/commands/PublishCommand.ts index 6fc5f524f970..85859418a4d1 100644 --- a/clients/client-sns/commands/PublishCommand.ts +++ b/clients/client-sns/commands/PublishCommand.ts @@ -36,6 +36,20 @@ export interface PublishCommandOutput extends PublishResponse, __MetadataBearer * *

You can publish messages only to topics and endpoints in the same AWS Region.

* + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { SNSClient, PublishCommand } from "@aws-sdk/client-sns"; // ES Modules import + * // const { SNSClient, PublishCommand } = require("@aws-sdk/client-sns"); // CommonJS import + * const client = new SNSClient(config); + * const command = new PublishCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link PublishCommandInput} for command's `input` shape. + * @see {@link PublishCommandOutput} for command's `response` shape. + * @see {@link SNSClientResolvedConfig | config} for command's `input` shape. + * */ export class PublishCommand extends $Command { // Start section: command_properties diff --git a/clients/client-sns/commands/RemovePermissionCommand.ts b/clients/client-sns/commands/RemovePermissionCommand.ts index a06a3301ec51..76a2e92ce6ed 100644 --- a/clients/client-sns/commands/RemovePermissionCommand.ts +++ b/clients/client-sns/commands/RemovePermissionCommand.ts @@ -22,6 +22,20 @@ export interface RemovePermissionCommandOutput extends __MetadataBearer {} /** *

Removes a statement from a topic's access control policy.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { SNSClient, RemovePermissionCommand } from "@aws-sdk/client-sns"; // ES Modules import + * // const { SNSClient, RemovePermissionCommand } = require("@aws-sdk/client-sns"); // CommonJS import + * const client = new SNSClient(config); + * const command = new RemovePermissionCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link RemovePermissionCommandInput} for command's `input` shape. + * @see {@link RemovePermissionCommandOutput} for command's `response` shape. + * @see {@link SNSClientResolvedConfig | config} for command's `input` shape. + * */ export class RemovePermissionCommand extends $Command< RemovePermissionCommandInput, diff --git a/clients/client-sns/commands/SetEndpointAttributesCommand.ts b/clients/client-sns/commands/SetEndpointAttributesCommand.ts index 29dab7477a93..6f49a13a1ceb 100644 --- a/clients/client-sns/commands/SetEndpointAttributesCommand.ts +++ b/clients/client-sns/commands/SetEndpointAttributesCommand.ts @@ -24,6 +24,20 @@ export interface SetEndpointAttributesCommandOutput extends __MetadataBearer {} *

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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { SNSClient, SetEndpointAttributesCommand } from "@aws-sdk/client-sns"; // ES Modules import + * // const { SNSClient, SetEndpointAttributesCommand } = require("@aws-sdk/client-sns"); // CommonJS import + * const client = new SNSClient(config); + * const command = new SetEndpointAttributesCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link SetEndpointAttributesCommandInput} for command's `input` shape. + * @see {@link SetEndpointAttributesCommandOutput} for command's `response` shape. + * @see {@link SNSClientResolvedConfig | config} for command's `input` shape. + * */ export class SetEndpointAttributesCommand extends $Command< SetEndpointAttributesCommandInput, diff --git a/clients/client-sns/commands/SetPlatformApplicationAttributesCommand.ts b/clients/client-sns/commands/SetPlatformApplicationAttributesCommand.ts index 6bce5d1db7dd..c6e1fa8aef82 100644 --- a/clients/client-sns/commands/SetPlatformApplicationAttributesCommand.ts +++ b/clients/client-sns/commands/SetPlatformApplicationAttributesCommand.ts @@ -26,6 +26,20 @@ export interface SetPlatformApplicationAttributesCommandOutput extends __Metadat * 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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { SNSClient, SetPlatformApplicationAttributesCommand } from "@aws-sdk/client-sns"; // ES Modules import + * // const { SNSClient, SetPlatformApplicationAttributesCommand } = require("@aws-sdk/client-sns"); // CommonJS import + * const client = new SNSClient(config); + * const command = new SetPlatformApplicationAttributesCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link SetPlatformApplicationAttributesCommandInput} for command's `input` shape. + * @see {@link SetPlatformApplicationAttributesCommandOutput} for command's `response` shape. + * @see {@link SNSClientResolvedConfig | config} for command's `input` shape. + * */ export class SetPlatformApplicationAttributesCommand extends $Command< SetPlatformApplicationAttributesCommandInput, diff --git a/clients/client-sns/commands/SetSMSAttributesCommand.ts b/clients/client-sns/commands/SetSMSAttributesCommand.ts index caf8a2630686..4202b2ff682e 100644 --- a/clients/client-sns/commands/SetSMSAttributesCommand.ts +++ b/clients/client-sns/commands/SetSMSAttributesCommand.ts @@ -31,6 +31,20 @@ export interface SetSMSAttributesCommandOutput extends SetSMSAttributesResponse, *

To use this operation, you must grant the Amazon SNS service principal (sns.amazonaws.com) * permission to perform the s3:ListBucket action.

* + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { SNSClient, SetSMSAttributesCommand } from "@aws-sdk/client-sns"; // ES Modules import + * // const { SNSClient, SetSMSAttributesCommand } = require("@aws-sdk/client-sns"); // CommonJS import + * const client = new SNSClient(config); + * const command = new SetSMSAttributesCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link SetSMSAttributesCommandInput} for command's `input` shape. + * @see {@link SetSMSAttributesCommandOutput} for command's `response` shape. + * @see {@link SNSClientResolvedConfig | config} for command's `input` shape. + * */ export class SetSMSAttributesCommand extends $Command< SetSMSAttributesCommandInput, diff --git a/clients/client-sns/commands/SetSubscriptionAttributesCommand.ts b/clients/client-sns/commands/SetSubscriptionAttributesCommand.ts index b1af3bc6174c..44ee355b6dd1 100644 --- a/clients/client-sns/commands/SetSubscriptionAttributesCommand.ts +++ b/clients/client-sns/commands/SetSubscriptionAttributesCommand.ts @@ -23,6 +23,20 @@ export interface SetSubscriptionAttributesCommandOutput extends __MetadataBearer /** *

Allows a subscription owner to set an attribute of the subscription to a new * value.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { SNSClient, SetSubscriptionAttributesCommand } from "@aws-sdk/client-sns"; // ES Modules import + * // const { SNSClient, SetSubscriptionAttributesCommand } = require("@aws-sdk/client-sns"); // CommonJS import + * const client = new SNSClient(config); + * const command = new SetSubscriptionAttributesCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link SetSubscriptionAttributesCommandInput} for command's `input` shape. + * @see {@link SetSubscriptionAttributesCommandOutput} for command's `response` shape. + * @see {@link SNSClientResolvedConfig | config} for command's `input` shape. + * */ export class SetSubscriptionAttributesCommand extends $Command< SetSubscriptionAttributesCommandInput, diff --git a/clients/client-sns/commands/SetTopicAttributesCommand.ts b/clients/client-sns/commands/SetTopicAttributesCommand.ts index 3d14fa570231..afa0b74753ea 100644 --- a/clients/client-sns/commands/SetTopicAttributesCommand.ts +++ b/clients/client-sns/commands/SetTopicAttributesCommand.ts @@ -22,6 +22,20 @@ export interface SetTopicAttributesCommandOutput extends __MetadataBearer {} /** *

Allows a topic owner to set an attribute of the topic to a new value.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { SNSClient, SetTopicAttributesCommand } from "@aws-sdk/client-sns"; // ES Modules import + * // const { SNSClient, SetTopicAttributesCommand } = require("@aws-sdk/client-sns"); // CommonJS import + * const client = new SNSClient(config); + * const command = new SetTopicAttributesCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link SetTopicAttributesCommandInput} for command's `input` shape. + * @see {@link SetTopicAttributesCommandOutput} for command's `response` shape. + * @see {@link SNSClientResolvedConfig | config} for command's `input` shape. + * */ export class SetTopicAttributesCommand extends $Command< SetTopicAttributesCommandInput, diff --git a/clients/client-sns/commands/SubscribeCommand.ts b/clients/client-sns/commands/SubscribeCommand.ts index 8dde7ca94a5a..e6a787b043e6 100644 --- a/clients/client-sns/commands/SubscribeCommand.ts +++ b/clients/client-sns/commands/SubscribeCommand.ts @@ -24,6 +24,20 @@ export interface SubscribeCommandOutput extends SubscribeResponse, __MetadataBea *

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).

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { SNSClient, SubscribeCommand } from "@aws-sdk/client-sns"; // ES Modules import + * // const { SNSClient, SubscribeCommand } = require("@aws-sdk/client-sns"); // CommonJS import + * const client = new SNSClient(config); + * const command = new SubscribeCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link SubscribeCommandInput} for command's `input` shape. + * @see {@link SubscribeCommandOutput} for command's `response` shape. + * @see {@link SNSClientResolvedConfig | config} for command's `input` shape. + * */ export class SubscribeCommand extends $Command { // Start section: command_properties diff --git a/clients/client-sns/commands/TagResourceCommand.ts b/clients/client-sns/commands/TagResourceCommand.ts index 42028fe80173..1f53dd37f11b 100644 --- a/clients/client-sns/commands/TagResourceCommand.ts +++ b/clients/client-sns/commands/TagResourceCommand.ts @@ -42,6 +42,20 @@ export interface TagResourceCommandOutput extends TagResourceResponse, __Metadat * requires a higher throughput, file a technical support request.

* * + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { SNSClient, TagResourceCommand } from "@aws-sdk/client-sns"; // ES Modules import + * // const { SNSClient, TagResourceCommand } = require("@aws-sdk/client-sns"); // CommonJS import + * const client = new SNSClient(config); + * const command = new TagResourceCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link TagResourceCommandInput} for command's `input` shape. + * @see {@link TagResourceCommandOutput} for command's `response` shape. + * @see {@link SNSClientResolvedConfig | config} for command's `input` shape. + * */ export class TagResourceCommand extends $Command< TagResourceCommandInput, diff --git a/clients/client-sns/commands/UnsubscribeCommand.ts b/clients/client-sns/commands/UnsubscribeCommand.ts index 4dbce1f72dc5..88290352ead3 100644 --- a/clients/client-sns/commands/UnsubscribeCommand.ts +++ b/clients/client-sns/commands/UnsubscribeCommand.ts @@ -25,6 +25,20 @@ export interface UnsubscribeCommandOutput extends __MetadataBearer {} * to the endpoint, so that the endpoint owner can easily resubscribe to the topic if the * Unsubscribe request was unintended.

*

This action is throttled at 100 transactions per second (TPS).

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { SNSClient, UnsubscribeCommand } from "@aws-sdk/client-sns"; // ES Modules import + * // const { SNSClient, UnsubscribeCommand } = require("@aws-sdk/client-sns"); // CommonJS import + * const client = new SNSClient(config); + * const command = new UnsubscribeCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link UnsubscribeCommandInput} for command's `input` shape. + * @see {@link UnsubscribeCommandOutput} for command's `response` shape. + * @see {@link SNSClientResolvedConfig | config} for command's `input` shape. + * */ export class UnsubscribeCommand extends $Command< UnsubscribeCommandInput, diff --git a/clients/client-sns/commands/UntagResourceCommand.ts b/clients/client-sns/commands/UntagResourceCommand.ts index 37c6498daa11..8df498807b4e 100644 --- a/clients/client-sns/commands/UntagResourceCommand.ts +++ b/clients/client-sns/commands/UntagResourceCommand.ts @@ -24,6 +24,20 @@ export interface UntagResourceCommandOutput extends UntagResourceResponse, __Met *

Remove tags from the specified Amazon SNS topic. For an overview, see * Amazon SNS Tags in the * Amazon SNS Developer Guide.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { SNSClient, UntagResourceCommand } from "@aws-sdk/client-sns"; // ES Modules import + * // const { SNSClient, UntagResourceCommand } = require("@aws-sdk/client-sns"); // CommonJS import + * const client = new SNSClient(config); + * const command = new UntagResourceCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link UntagResourceCommandInput} for command's `input` shape. + * @see {@link UntagResourceCommandOutput} for command's `response` shape. + * @see {@link SNSClientResolvedConfig | config} for command's `input` shape. + * */ export class UntagResourceCommand extends $Command< UntagResourceCommandInput, diff --git a/clients/client-sns/models/models_0.ts b/clients/client-sns/models/models_0.ts index 3a83ac1972a0..8b682ba13bc7 100644 --- a/clients/client-sns/models/models_0.ts +++ b/clients/client-sns/models/models_0.ts @@ -27,6 +27,9 @@ export interface AddPermissionInput { } export namespace AddPermissionInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: AddPermissionInput): any => ({ ...obj, }); @@ -42,6 +45,9 @@ export interface AuthorizationErrorException extends __SmithyException, $Metadat } export namespace AuthorizationErrorException { + /** + * @internal + */ export const filterSensitiveLog = (obj: AuthorizationErrorException): any => ({ ...obj, }); @@ -57,6 +63,9 @@ export interface InternalErrorException extends __SmithyException, $MetadataBear } export namespace InternalErrorException { + /** + * @internal + */ export const filterSensitiveLog = (obj: InternalErrorException): any => ({ ...obj, }); @@ -73,6 +82,9 @@ export interface InvalidParameterException extends __SmithyException, $MetadataB } export namespace InvalidParameterException { + /** + * @internal + */ export const filterSensitiveLog = (obj: InvalidParameterException): any => ({ ...obj, }); @@ -88,6 +100,9 @@ export interface NotFoundException extends __SmithyException, $MetadataBearer { } export namespace NotFoundException { + /** + * @internal + */ export const filterSensitiveLog = (obj: NotFoundException): any => ({ ...obj, }); @@ -104,6 +119,9 @@ export interface CheckIfPhoneNumberIsOptedOutInput { } export namespace CheckIfPhoneNumberIsOptedOutInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: CheckIfPhoneNumberIsOptedOutInput): any => ({ ...obj, }); @@ -132,6 +150,9 @@ export interface CheckIfPhoneNumberIsOptedOutResponse { } export namespace CheckIfPhoneNumberIsOptedOutResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: CheckIfPhoneNumberIsOptedOutResponse): any => ({ ...obj, }); @@ -151,6 +172,9 @@ export interface ThrottledException extends __SmithyException, $MetadataBearer { } export namespace ThrottledException { + /** + * @internal + */ export const filterSensitiveLog = (obj: ThrottledException): any => ({ ...obj, }); @@ -180,6 +204,9 @@ export interface ConfirmSubscriptionInput { } export namespace ConfirmSubscriptionInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: ConfirmSubscriptionInput): any => ({ ...obj, }); @@ -196,6 +223,9 @@ export interface ConfirmSubscriptionResponse { } export namespace ConfirmSubscriptionResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ConfirmSubscriptionResponse): any => ({ ...obj, }); @@ -213,6 +243,9 @@ export interface FilterPolicyLimitExceededException extends __SmithyException, $ } export namespace FilterPolicyLimitExceededException { + /** + * @internal + */ export const filterSensitiveLog = (obj: FilterPolicyLimitExceededException): any => ({ ...obj, }); @@ -229,6 +262,9 @@ export interface SubscriptionLimitExceededException extends __SmithyException, $ } export namespace SubscriptionLimitExceededException { + /** + * @internal + */ export const filterSensitiveLog = (obj: SubscriptionLimitExceededException): any => ({ ...obj, }); @@ -259,6 +295,9 @@ export interface CreatePlatformApplicationInput { } export namespace CreatePlatformApplicationInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreatePlatformApplicationInput): any => ({ ...obj, }); @@ -275,6 +314,9 @@ export interface CreatePlatformApplicationResponse { } export namespace CreatePlatformApplicationResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreatePlatformApplicationResponse): any => ({ ...obj, }); @@ -291,6 +333,9 @@ export interface CreateEndpointResponse { } export namespace CreateEndpointResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateEndpointResponse): any => ({ ...obj, }); @@ -328,6 +373,9 @@ export interface CreatePlatformEndpointInput { } export namespace CreatePlatformEndpointInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreatePlatformEndpointInput): any => ({ ...obj, }); @@ -344,6 +392,9 @@ export interface ConcurrentAccessException extends __SmithyException, $MetadataB } export namespace ConcurrentAccessException { + /** + * @internal + */ export const filterSensitiveLog = (obj: ConcurrentAccessException): any => ({ ...obj, }); @@ -365,6 +416,9 @@ export interface Tag { } export namespace Tag { + /** + * @internal + */ export const filterSensitiveLog = (obj: Tag): any => ({ ...obj, }); @@ -465,6 +519,9 @@ export interface CreateTopicInput { } export namespace CreateTopicInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateTopicInput): any => ({ ...obj, }); @@ -481,6 +538,9 @@ export interface CreateTopicResponse { } export namespace CreateTopicResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateTopicResponse): any => ({ ...obj, }); @@ -497,6 +557,9 @@ export interface InvalidSecurityException extends __SmithyException, $MetadataBe } export namespace InvalidSecurityException { + /** + * @internal + */ export const filterSensitiveLog = (obj: InvalidSecurityException): any => ({ ...obj, }); @@ -513,6 +576,9 @@ export interface StaleTagException extends __SmithyException, $MetadataBearer { } export namespace StaleTagException { + /** + * @internal + */ export const filterSensitiveLog = (obj: StaleTagException): any => ({ ...obj, }); @@ -528,6 +594,9 @@ export interface TagLimitExceededException extends __SmithyException, $MetadataB } export namespace TagLimitExceededException { + /** + * @internal + */ export const filterSensitiveLog = (obj: TagLimitExceededException): any => ({ ...obj, }); @@ -544,6 +613,9 @@ export interface TagPolicyException extends __SmithyException, $MetadataBearer { } export namespace TagPolicyException { + /** + * @internal + */ export const filterSensitiveLog = (obj: TagPolicyException): any => ({ ...obj, }); @@ -559,6 +631,9 @@ export interface TopicLimitExceededException extends __SmithyException, $Metadat } export namespace TopicLimitExceededException { + /** + * @internal + */ export const filterSensitiveLog = (obj: TopicLimitExceededException): any => ({ ...obj, }); @@ -575,6 +650,9 @@ export interface DeleteEndpointInput { } export namespace DeleteEndpointInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteEndpointInput): any => ({ ...obj, }); @@ -591,6 +669,9 @@ export interface DeletePlatformApplicationInput { } export namespace DeletePlatformApplicationInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeletePlatformApplicationInput): any => ({ ...obj, }); @@ -604,6 +685,9 @@ export interface DeleteTopicInput { } export namespace DeleteTopicInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteTopicInput): any => ({ ...obj, }); @@ -620,6 +704,9 @@ export interface GetEndpointAttributesInput { } export namespace GetEndpointAttributesInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetEndpointAttributesInput): any => ({ ...obj, }); @@ -661,6 +748,9 @@ export interface GetEndpointAttributesResponse { } export namespace GetEndpointAttributesResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetEndpointAttributesResponse): any => ({ ...obj, }); @@ -677,6 +767,9 @@ export interface GetPlatformApplicationAttributesInput { } export namespace GetPlatformApplicationAttributesInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetPlatformApplicationAttributesInput): any => ({ ...obj, }); @@ -716,6 +809,9 @@ export interface GetPlatformApplicationAttributesResponse { } export namespace GetPlatformApplicationAttributesResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetPlatformApplicationAttributesResponse): any => ({ ...obj, }); @@ -735,6 +831,9 @@ export interface GetSMSAttributesInput { } export namespace GetSMSAttributesInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetSMSAttributesInput): any => ({ ...obj, }); @@ -751,6 +850,9 @@ export interface GetSMSAttributesResponse { } export namespace GetSMSAttributesResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetSMSAttributesResponse): any => ({ ...obj, }); @@ -767,6 +869,9 @@ export interface GetSubscriptionAttributesInput { } export namespace GetSubscriptionAttributesInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetSubscriptionAttributesInput): any => ({ ...obj, }); @@ -855,6 +960,9 @@ export interface GetSubscriptionAttributesResponse { } export namespace GetSubscriptionAttributesResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetSubscriptionAttributesResponse): any => ({ ...obj, }); @@ -871,6 +979,9 @@ export interface GetTopicAttributesInput { } export namespace GetTopicAttributesInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetTopicAttributesInput): any => ({ ...obj, }); @@ -975,6 +1086,9 @@ export interface GetTopicAttributesResponse { } export namespace GetTopicAttributesResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetTopicAttributesResponse): any => ({ ...obj, }); @@ -997,6 +1111,9 @@ export interface ListEndpointsByPlatformApplicationInput { } export namespace ListEndpointsByPlatformApplicationInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListEndpointsByPlatformApplicationInput): any => ({ ...obj, }); @@ -1018,6 +1135,9 @@ export interface Endpoint { } export namespace Endpoint { + /** + * @internal + */ export const filterSensitiveLog = (obj: Endpoint): any => ({ ...obj, }); @@ -1040,6 +1160,9 @@ export interface ListEndpointsByPlatformApplicationResponse { } export namespace ListEndpointsByPlatformApplicationResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListEndpointsByPlatformApplicationResponse): any => ({ ...obj, }); @@ -1058,6 +1181,9 @@ export interface ListPhoneNumbersOptedOutInput { } export namespace ListPhoneNumbersOptedOutInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListPhoneNumbersOptedOutInput): any => ({ ...obj, }); @@ -1082,6 +1208,9 @@ export interface ListPhoneNumbersOptedOutResponse { } export namespace ListPhoneNumbersOptedOutResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListPhoneNumbersOptedOutResponse): any => ({ ...obj, }); @@ -1099,6 +1228,9 @@ export interface ListPlatformApplicationsInput { } export namespace ListPlatformApplicationsInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListPlatformApplicationsInput): any => ({ ...obj, }); @@ -1120,6 +1252,9 @@ export interface PlatformApplication { } export namespace PlatformApplication { + /** + * @internal + */ export const filterSensitiveLog = (obj: PlatformApplication): any => ({ ...obj, }); @@ -1142,6 +1277,9 @@ export interface ListPlatformApplicationsResponse { } export namespace ListPlatformApplicationsResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListPlatformApplicationsResponse): any => ({ ...obj, }); @@ -1158,6 +1296,9 @@ export interface ListSubscriptionsInput { } export namespace ListSubscriptionsInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListSubscriptionsInput): any => ({ ...obj, }); @@ -1194,6 +1335,9 @@ export interface Subscription { } export namespace Subscription { + /** + * @internal + */ export const filterSensitiveLog = (obj: Subscription): any => ({ ...obj, }); @@ -1216,6 +1360,9 @@ export interface ListSubscriptionsResponse { } export namespace ListSubscriptionsResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListSubscriptionsResponse): any => ({ ...obj, }); @@ -1237,6 +1384,9 @@ export interface ListSubscriptionsByTopicInput { } export namespace ListSubscriptionsByTopicInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListSubscriptionsByTopicInput): any => ({ ...obj, }); @@ -1259,6 +1409,9 @@ export interface ListSubscriptionsByTopicResponse { } export namespace ListSubscriptionsByTopicResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListSubscriptionsByTopicResponse): any => ({ ...obj, }); @@ -1272,6 +1425,9 @@ export interface ListTagsForResourceRequest { } export namespace ListTagsForResourceRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListTagsForResourceRequest): any => ({ ...obj, }); @@ -1285,6 +1441,9 @@ export interface ListTagsForResourceResponse { } export namespace ListTagsForResourceResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListTagsForResourceResponse): any => ({ ...obj, }); @@ -1300,6 +1459,9 @@ export interface ResourceNotFoundException extends __SmithyException, $MetadataB } export namespace ResourceNotFoundException { + /** + * @internal + */ export const filterSensitiveLog = (obj: ResourceNotFoundException): any => ({ ...obj, }); @@ -1313,6 +1475,9 @@ export interface ListTopicsInput { } export namespace ListTopicsInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListTopicsInput): any => ({ ...obj, }); @@ -1330,6 +1495,9 @@ export interface Topic { } export namespace Topic { + /** + * @internal + */ export const filterSensitiveLog = (obj: Topic): any => ({ ...obj, }); @@ -1352,6 +1520,9 @@ export interface ListTopicsResponse { } export namespace ListTopicsResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListTopicsResponse): any => ({ ...obj, }); @@ -1368,6 +1539,9 @@ export interface OptInPhoneNumberInput { } export namespace OptInPhoneNumberInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: OptInPhoneNumberInput): any => ({ ...obj, }); @@ -1379,6 +1553,9 @@ export namespace OptInPhoneNumberInput { export interface OptInPhoneNumberResponse {} export namespace OptInPhoneNumberResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: OptInPhoneNumberResponse): any => ({ ...obj, }); @@ -1397,6 +1574,9 @@ export interface EndpointDisabledException extends __SmithyException, $MetadataB } export namespace EndpointDisabledException { + /** + * @internal + */ export const filterSensitiveLog = (obj: EndpointDisabledException): any => ({ ...obj, }); @@ -1416,6 +1596,9 @@ export interface InvalidParameterValueException extends __SmithyException, $Meta } export namespace InvalidParameterValueException { + /** + * @internal + */ export const filterSensitiveLog = (obj: InvalidParameterValueException): any => ({ ...obj, }); @@ -1432,6 +1615,9 @@ export interface KMSAccessDeniedException extends __SmithyException, $MetadataBe } export namespace KMSAccessDeniedException { + /** + * @internal + */ export const filterSensitiveLog = (obj: KMSAccessDeniedException): any => ({ ...obj, }); @@ -1448,6 +1634,9 @@ export interface KMSDisabledException extends __SmithyException, $MetadataBearer } export namespace KMSDisabledException { + /** + * @internal + */ export const filterSensitiveLog = (obj: KMSDisabledException): any => ({ ...obj, }); @@ -1466,6 +1655,9 @@ export interface KMSInvalidStateException extends __SmithyException, $MetadataBe } export namespace KMSInvalidStateException { + /** + * @internal + */ export const filterSensitiveLog = (obj: KMSInvalidStateException): any => ({ ...obj, }); @@ -1482,6 +1674,9 @@ export interface KMSNotFoundException extends __SmithyException, $MetadataBearer } export namespace KMSNotFoundException { + /** + * @internal + */ export const filterSensitiveLog = (obj: KMSNotFoundException): any => ({ ...obj, }); @@ -1497,6 +1692,9 @@ export interface KMSOptInRequired extends __SmithyException, $MetadataBearer { } export namespace KMSOptInRequired { + /** + * @internal + */ export const filterSensitiveLog = (obj: KMSOptInRequired): any => ({ ...obj, }); @@ -1515,6 +1713,9 @@ export interface KMSThrottlingException extends __SmithyException, $MetadataBear } export namespace KMSThrottlingException { + /** + * @internal + */ export const filterSensitiveLog = (obj: KMSThrottlingException): any => ({ ...obj, }); @@ -1533,6 +1734,9 @@ export interface PlatformApplicationDisabledException extends __SmithyException, } export namespace PlatformApplicationDisabledException { + /** + * @internal + */ export const filterSensitiveLog = (obj: PlatformApplicationDisabledException): any => ({ ...obj, }); @@ -1572,6 +1776,9 @@ export interface MessageAttributeValue { } export namespace MessageAttributeValue { + /** + * @internal + */ export const filterSensitiveLog = (obj: MessageAttributeValue): any => ({ ...obj, }); @@ -1728,6 +1935,9 @@ export interface PublishInput { } export namespace PublishInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: PublishInput): any => ({ ...obj, }); @@ -1752,6 +1962,9 @@ export interface PublishResponse { } export namespace PublishResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: PublishResponse): any => ({ ...obj, }); @@ -1773,6 +1986,9 @@ export interface RemovePermissionInput { } export namespace RemovePermissionInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: RemovePermissionInput): any => ({ ...obj, }); @@ -1816,6 +2032,9 @@ export interface SetEndpointAttributesInput { } export namespace SetEndpointAttributesInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: SetEndpointAttributesInput): any => ({ ...obj, }); @@ -1895,6 +2114,9 @@ export interface SetPlatformApplicationAttributesInput { } export namespace SetPlatformApplicationAttributesInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: SetPlatformApplicationAttributesInput): any => ({ ...obj, }); @@ -1996,6 +2218,9 @@ export interface SetSMSAttributesInput { } export namespace SetSMSAttributesInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: SetSMSAttributesInput): any => ({ ...obj, }); @@ -2007,6 +2232,9 @@ export namespace SetSMSAttributesInput { export interface SetSMSAttributesResponse {} export namespace SetSMSAttributesResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: SetSMSAttributesResponse): any => ({ ...obj, }); @@ -2080,6 +2308,9 @@ export interface SetSubscriptionAttributesInput { } export namespace SetSubscriptionAttributesInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: SetSubscriptionAttributesInput): any => ({ ...obj, }); @@ -2164,6 +2395,9 @@ export interface SetTopicAttributesInput { } export namespace SetTopicAttributesInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: SetTopicAttributesInput): any => ({ ...obj, }); @@ -2331,6 +2565,9 @@ export interface SubscribeInput { } export namespace SubscribeInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: SubscribeInput): any => ({ ...obj, }); @@ -2350,6 +2587,9 @@ export interface SubscribeResponse { } export namespace SubscribeResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: SubscribeResponse): any => ({ ...obj, }); @@ -2369,6 +2609,9 @@ export interface TagResourceRequest { } export namespace TagResourceRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: TagResourceRequest): any => ({ ...obj, }); @@ -2377,6 +2620,9 @@ export namespace TagResourceRequest { export interface TagResourceResponse {} export namespace TagResourceResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: TagResourceResponse): any => ({ ...obj, }); @@ -2393,6 +2639,9 @@ export interface UnsubscribeInput { } export namespace UnsubscribeInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: UnsubscribeInput): any => ({ ...obj, }); @@ -2411,6 +2660,9 @@ export interface UntagResourceRequest { } export namespace UntagResourceRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: UntagResourceRequest): any => ({ ...obj, }); @@ -2419,6 +2671,9 @@ export namespace UntagResourceRequest { export interface UntagResourceResponse {} export namespace UntagResourceResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: UntagResourceResponse): any => ({ ...obj, }); diff --git a/clients/client-sqs/commands/AddPermissionCommand.ts b/clients/client-sqs/commands/AddPermissionCommand.ts index 47d3a07ae8b6..ae223c4a8828 100644 --- a/clients/client-sqs/commands/AddPermissionCommand.ts +++ b/clients/client-sqs/commands/AddPermissionCommand.ts @@ -59,6 +59,20 @@ export interface AddPermissionCommandOutput extends __MetadataBearer {} * *

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 Simple Queue Service Developer Guide.

* + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { SQSClient, AddPermissionCommand } from "@aws-sdk/client-sqs"; // ES Modules import + * // const { SQSClient, AddPermissionCommand } = require("@aws-sdk/client-sqs"); // CommonJS import + * const client = new SQSClient(config); + * const command = new AddPermissionCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link AddPermissionCommandInput} for command's `input` shape. + * @see {@link AddPermissionCommandOutput} for command's `response` shape. + * @see {@link SQSClientResolvedConfig | config} for command's `input` shape. + * */ export class AddPermissionCommand extends $Command< AddPermissionCommandInput, diff --git a/clients/client-sqs/commands/ChangeMessageVisibilityBatchCommand.ts b/clients/client-sqs/commands/ChangeMessageVisibilityBatchCommand.ts index 7150d8dac63b..19e9227618cd 100644 --- a/clients/client-sqs/commands/ChangeMessageVisibilityBatchCommand.ts +++ b/clients/client-sqs/commands/ChangeMessageVisibilityBatchCommand.ts @@ -38,6 +38,20 @@ export interface ChangeMessageVisibilityBatchCommandOutput *

* &AttributeName.2=second *

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { SQSClient, ChangeMessageVisibilityBatchCommand } from "@aws-sdk/client-sqs"; // ES Modules import + * // const { SQSClient, ChangeMessageVisibilityBatchCommand } = require("@aws-sdk/client-sqs"); // CommonJS import + * const client = new SQSClient(config); + * const command = new ChangeMessageVisibilityBatchCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ChangeMessageVisibilityBatchCommandInput} for command's `input` shape. + * @see {@link ChangeMessageVisibilityBatchCommandOutput} for command's `response` shape. + * @see {@link SQSClientResolvedConfig | config} for command's `input` shape. + * */ export class ChangeMessageVisibilityBatchCommand extends $Command< ChangeMessageVisibilityBatchCommandInput, diff --git a/clients/client-sqs/commands/ChangeMessageVisibilityCommand.ts b/clients/client-sqs/commands/ChangeMessageVisibilityCommand.ts index 158d89e75d6f..c6f38f9fb2c1 100644 --- a/clients/client-sqs/commands/ChangeMessageVisibilityCommand.ts +++ b/clients/client-sqs/commands/ChangeMessageVisibilityCommand.ts @@ -55,6 +55,20 @@ export interface ChangeMessageVisibilityCommandOutput extends __MetadataBearer { *

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.

* + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { SQSClient, ChangeMessageVisibilityCommand } from "@aws-sdk/client-sqs"; // ES Modules import + * // const { SQSClient, ChangeMessageVisibilityCommand } = require("@aws-sdk/client-sqs"); // CommonJS import + * const client = new SQSClient(config); + * const command = new ChangeMessageVisibilityCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ChangeMessageVisibilityCommandInput} for command's `input` shape. + * @see {@link ChangeMessageVisibilityCommandOutput} for command's `response` shape. + * @see {@link SQSClientResolvedConfig | config} for command's `input` shape. + * */ export class ChangeMessageVisibilityCommand extends $Command< ChangeMessageVisibilityCommandInput, diff --git a/clients/client-sqs/commands/CreateQueueCommand.ts b/clients/client-sqs/commands/CreateQueueCommand.ts index 78a3e3e089e7..017125c682d6 100644 --- a/clients/client-sqs/commands/CreateQueueCommand.ts +++ b/clients/client-sqs/commands/CreateQueueCommand.ts @@ -68,6 +68,20 @@ export interface CreateQueueCommandOutput extends CreateQueueResult, __MetadataB * *

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 Simple Queue Service Developer Guide.

* + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { SQSClient, CreateQueueCommand } from "@aws-sdk/client-sqs"; // ES Modules import + * // const { SQSClient, CreateQueueCommand } = require("@aws-sdk/client-sqs"); // CommonJS import + * const client = new SQSClient(config); + * const command = new CreateQueueCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreateQueueCommandInput} for command's `input` shape. + * @see {@link CreateQueueCommandOutput} for command's `response` shape. + * @see {@link SQSClientResolvedConfig | config} for command's `input` shape. + * */ export class CreateQueueCommand extends $Command< CreateQueueCommandInput, diff --git a/clients/client-sqs/commands/DeleteMessageBatchCommand.ts b/clients/client-sqs/commands/DeleteMessageBatchCommand.ts index bdadb9ac0736..40ba513f1ea7 100644 --- a/clients/client-sqs/commands/DeleteMessageBatchCommand.ts +++ b/clients/client-sqs/commands/DeleteMessageBatchCommand.ts @@ -33,6 +33,20 @@ export interface DeleteMessageBatchCommandOutput extends DeleteMessageBatchResul *

* &AttributeName.2=second *

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { SQSClient, DeleteMessageBatchCommand } from "@aws-sdk/client-sqs"; // ES Modules import + * // const { SQSClient, DeleteMessageBatchCommand } = require("@aws-sdk/client-sqs"); // CommonJS import + * const client = new SQSClient(config); + * const command = new DeleteMessageBatchCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteMessageBatchCommandInput} for command's `input` shape. + * @see {@link DeleteMessageBatchCommandOutput} for command's `response` shape. + * @see {@link SQSClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteMessageBatchCommand extends $Command< DeleteMessageBatchCommandInput, diff --git a/clients/client-sqs/commands/DeleteMessageCommand.ts b/clients/client-sqs/commands/DeleteMessageCommand.ts index e5474aa9317e..7ab3cad94803 100644 --- a/clients/client-sqs/commands/DeleteMessageCommand.ts +++ b/clients/client-sqs/commands/DeleteMessageCommand.ts @@ -41,6 +41,20 @@ export interface DeleteMessageCommandOutput extends __MetadataBearer {} * receive request. You should ensure that your application is idempotent, so that * receiving a message more than once does not cause issues.

* + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { SQSClient, DeleteMessageCommand } from "@aws-sdk/client-sqs"; // ES Modules import + * // const { SQSClient, DeleteMessageCommand } = require("@aws-sdk/client-sqs"); // CommonJS import + * const client = new SQSClient(config); + * const command = new DeleteMessageCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteMessageCommandInput} for command's `input` shape. + * @see {@link DeleteMessageCommandOutput} for command's `response` shape. + * @see {@link SQSClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteMessageCommand extends $Command< DeleteMessageCommandInput, diff --git a/clients/client-sqs/commands/DeleteQueueCommand.ts b/clients/client-sqs/commands/DeleteQueueCommand.ts index 505f01380cb2..91160bd8ba2b 100644 --- a/clients/client-sqs/commands/DeleteQueueCommand.ts +++ b/clients/client-sqs/commands/DeleteQueueCommand.ts @@ -31,6 +31,20 @@ export interface DeleteQueueCommandOutput extends __MetadataBearer {} * *

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 Simple Queue Service Developer Guide.

* + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { SQSClient, DeleteQueueCommand } from "@aws-sdk/client-sqs"; // ES Modules import + * // const { SQSClient, DeleteQueueCommand } = require("@aws-sdk/client-sqs"); // CommonJS import + * const client = new SQSClient(config); + * const command = new DeleteQueueCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteQueueCommandInput} for command's `input` shape. + * @see {@link DeleteQueueCommandOutput} for command's `response` shape. + * @see {@link SQSClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteQueueCommand extends $Command< DeleteQueueCommandInput, diff --git a/clients/client-sqs/commands/GetQueueAttributesCommand.ts b/clients/client-sqs/commands/GetQueueAttributesCommand.ts index 385373a3a11c..db0ae90da8e2 100644 --- a/clients/client-sqs/commands/GetQueueAttributesCommand.ts +++ b/clients/client-sqs/commands/GetQueueAttributesCommand.ts @@ -25,6 +25,20 @@ export interface GetQueueAttributesCommandOutput extends GetQueueAttributesResul * *

To determine whether a queue is FIFO, you can check whether QueueName ends with the .fifo suffix.

* + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { SQSClient, GetQueueAttributesCommand } from "@aws-sdk/client-sqs"; // ES Modules import + * // const { SQSClient, GetQueueAttributesCommand } = require("@aws-sdk/client-sqs"); // CommonJS import + * const client = new SQSClient(config); + * const command = new GetQueueAttributesCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetQueueAttributesCommandInput} for command's `input` shape. + * @see {@link GetQueueAttributesCommandOutput} for command's `response` shape. + * @see {@link SQSClientResolvedConfig | config} for command's `input` shape. + * */ export class GetQueueAttributesCommand extends $Command< GetQueueAttributesCommandInput, diff --git a/clients/client-sqs/commands/GetQueueUrlCommand.ts b/clients/client-sqs/commands/GetQueueUrlCommand.ts index 54ece21a96b0..4bb5267d0fd3 100644 --- a/clients/client-sqs/commands/GetQueueUrlCommand.ts +++ b/clients/client-sqs/commands/GetQueueUrlCommand.ts @@ -24,6 +24,20 @@ export interface GetQueueUrlCommandOutput extends GetQueueUrlResult, __MetadataB * AddPermission * or see Allow Developers to Write Messages to a Shared Queue in the Amazon Simple Queue Service Developer Guide. *

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { SQSClient, GetQueueUrlCommand } from "@aws-sdk/client-sqs"; // ES Modules import + * // const { SQSClient, GetQueueUrlCommand } = require("@aws-sdk/client-sqs"); // CommonJS import + * const client = new SQSClient(config); + * const command = new GetQueueUrlCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetQueueUrlCommandInput} for command's `input` shape. + * @see {@link GetQueueUrlCommandOutput} for command's `response` shape. + * @see {@link SQSClientResolvedConfig | config} for command's `input` shape. + * */ export class GetQueueUrlCommand extends $Command< GetQueueUrlCommandInput, diff --git a/clients/client-sqs/commands/ListDeadLetterSourceQueuesCommand.ts b/clients/client-sqs/commands/ListDeadLetterSourceQueuesCommand.ts index 7fa32b7a9365..7e532f996873 100644 --- a/clients/client-sqs/commands/ListDeadLetterSourceQueuesCommand.ts +++ b/clients/client-sqs/commands/ListDeadLetterSourceQueuesCommand.ts @@ -32,6 +32,20 @@ export interface ListDeadLetterSourceQueuesCommandOutput extends ListDeadLetterS * *

For more information about using dead-letter queues, see Using Amazon SQS Dead-Letter Queues * in the Amazon Simple Queue Service Developer Guide.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { SQSClient, ListDeadLetterSourceQueuesCommand } from "@aws-sdk/client-sqs"; // ES Modules import + * // const { SQSClient, ListDeadLetterSourceQueuesCommand } = require("@aws-sdk/client-sqs"); // CommonJS import + * const client = new SQSClient(config); + * const command = new ListDeadLetterSourceQueuesCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListDeadLetterSourceQueuesCommandInput} for command's `input` shape. + * @see {@link ListDeadLetterSourceQueuesCommandOutput} for command's `response` shape. + * @see {@link SQSClientResolvedConfig | config} for command's `input` shape. + * */ export class ListDeadLetterSourceQueuesCommand extends $Command< ListDeadLetterSourceQueuesCommandInput, diff --git a/clients/client-sqs/commands/ListQueueTagsCommand.ts b/clients/client-sqs/commands/ListQueueTagsCommand.ts index 89b5e0016bb6..6eb6f21b6e33 100644 --- a/clients/client-sqs/commands/ListQueueTagsCommand.ts +++ b/clients/client-sqs/commands/ListQueueTagsCommand.ts @@ -25,6 +25,20 @@ export interface ListQueueTagsCommandOutput extends ListQueueTagsResult, __Metad * *

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 Simple Queue Service Developer Guide.

* + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { SQSClient, ListQueueTagsCommand } from "@aws-sdk/client-sqs"; // ES Modules import + * // const { SQSClient, ListQueueTagsCommand } = require("@aws-sdk/client-sqs"); // CommonJS import + * const client = new SQSClient(config); + * const command = new ListQueueTagsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListQueueTagsCommandInput} for command's `input` shape. + * @see {@link ListQueueTagsCommandOutput} for command's `response` shape. + * @see {@link SQSClientResolvedConfig | config} for command's `input` shape. + * */ export class ListQueueTagsCommand extends $Command< ListQueueTagsCommandInput, diff --git a/clients/client-sqs/commands/ListQueuesCommand.ts b/clients/client-sqs/commands/ListQueuesCommand.ts index b390584d863a..b2924e3a2390 100644 --- a/clients/client-sqs/commands/ListQueuesCommand.ts +++ b/clients/client-sqs/commands/ListQueuesCommand.ts @@ -30,6 +30,20 @@ export interface ListQueuesCommandOutput extends ListQueuesResult, __MetadataBea * *

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 Simple Queue Service Developer Guide.

* + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { SQSClient, ListQueuesCommand } from "@aws-sdk/client-sqs"; // ES Modules import + * // const { SQSClient, ListQueuesCommand } = require("@aws-sdk/client-sqs"); // CommonJS import + * const client = new SQSClient(config); + * const command = new ListQueuesCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListQueuesCommandInput} for command's `input` shape. + * @see {@link ListQueuesCommandOutput} for command's `response` shape. + * @see {@link SQSClientResolvedConfig | config} for command's `input` shape. + * */ export class ListQueuesCommand extends $Command< ListQueuesCommandInput, diff --git a/clients/client-sqs/commands/PurgeQueueCommand.ts b/clients/client-sqs/commands/PurgeQueueCommand.ts index 04ead3fe1b37..906b984576a0 100644 --- a/clients/client-sqs/commands/PurgeQueueCommand.ts +++ b/clients/client-sqs/commands/PurgeQueueCommand.ts @@ -32,6 +32,20 @@ export interface PurgeQueueCommandOutput extends __MetadataBearer {} * minute.

*

Messages sent to the queue after you call * PurgeQueue might be deleted while the queue is being purged.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { SQSClient, PurgeQueueCommand } from "@aws-sdk/client-sqs"; // ES Modules import + * // const { SQSClient, PurgeQueueCommand } = require("@aws-sdk/client-sqs"); // CommonJS import + * const client = new SQSClient(config); + * const command = new PurgeQueueCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link PurgeQueueCommandInput} for command's `input` shape. + * @see {@link PurgeQueueCommandOutput} for command's `response` shape. + * @see {@link SQSClientResolvedConfig | config} for command's `input` shape. + * */ export class PurgeQueueCommand extends $Command< PurgeQueueCommandInput, diff --git a/clients/client-sqs/commands/ReceiveMessageCommand.ts b/clients/client-sqs/commands/ReceiveMessageCommand.ts index aabc26c0eba8..5f824ec74f8a 100644 --- a/clients/client-sqs/commands/ReceiveMessageCommand.ts +++ b/clients/client-sqs/commands/ReceiveMessageCommand.ts @@ -58,6 +58,20 @@ export interface ReceiveMessageCommandOutput extends ReceiveMessageResult, __Met * *

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.

* + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { SQSClient, ReceiveMessageCommand } from "@aws-sdk/client-sqs"; // ES Modules import + * // const { SQSClient, ReceiveMessageCommand } = require("@aws-sdk/client-sqs"); // CommonJS import + * const client = new SQSClient(config); + * const command = new ReceiveMessageCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ReceiveMessageCommandInput} for command's `input` shape. + * @see {@link ReceiveMessageCommandOutput} for command's `response` shape. + * @see {@link SQSClientResolvedConfig | config} for command's `input` shape. + * */ export class ReceiveMessageCommand extends $Command< ReceiveMessageCommandInput, diff --git a/clients/client-sqs/commands/RemovePermissionCommand.ts b/clients/client-sqs/commands/RemovePermissionCommand.ts index a12797bc8f9c..4d94b5626fcb 100644 --- a/clients/client-sqs/commands/RemovePermissionCommand.ts +++ b/clients/client-sqs/commands/RemovePermissionCommand.ts @@ -35,6 +35,20 @@ export interface RemovePermissionCommandOutput extends __MetadataBearer {} * * * + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { SQSClient, RemovePermissionCommand } from "@aws-sdk/client-sqs"; // ES Modules import + * // const { SQSClient, RemovePermissionCommand } = require("@aws-sdk/client-sqs"); // CommonJS import + * const client = new SQSClient(config); + * const command = new RemovePermissionCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link RemovePermissionCommandInput} for command's `input` shape. + * @see {@link RemovePermissionCommandOutput} for command's `response` shape. + * @see {@link SQSClientResolvedConfig | config} for command's `input` shape. + * */ export class RemovePermissionCommand extends $Command< RemovePermissionCommandInput, diff --git a/clients/client-sqs/commands/SendMessageBatchCommand.ts b/clients/client-sqs/commands/SendMessageBatchCommand.ts index 725340ceb50b..67e981f65ff7 100644 --- a/clients/client-sqs/commands/SendMessageBatchCommand.ts +++ b/clients/client-sqs/commands/SendMessageBatchCommand.ts @@ -41,6 +41,20 @@ export interface SendMessageBatchCommandOutput extends SendMessageBatchResult, _ *

* &AttributeName.2=second *

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { SQSClient, SendMessageBatchCommand } from "@aws-sdk/client-sqs"; // ES Modules import + * // const { SQSClient, SendMessageBatchCommand } = require("@aws-sdk/client-sqs"); // CommonJS import + * const client = new SQSClient(config); + * const command = new SendMessageBatchCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link SendMessageBatchCommandInput} for command's `input` shape. + * @see {@link SendMessageBatchCommandOutput} for command's `response` shape. + * @see {@link SQSClientResolvedConfig | config} for command's `input` shape. + * */ export class SendMessageBatchCommand extends $Command< SendMessageBatchCommandInput, diff --git a/clients/client-sqs/commands/SendMessageCommand.ts b/clients/client-sqs/commands/SendMessageCommand.ts index 34f836cd33e6..5664f9d22d82 100644 --- a/clients/client-sqs/commands/SendMessageCommand.ts +++ b/clients/client-sqs/commands/SendMessageCommand.ts @@ -27,6 +27,20 @@ export interface SendMessageCommandOutput extends SendMessageResult, __MetadataB *

*

Any characters not included in this list will be rejected. For more information, see the W3C specification for characters.

* + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { SQSClient, SendMessageCommand } from "@aws-sdk/client-sqs"; // ES Modules import + * // const { SQSClient, SendMessageCommand } = require("@aws-sdk/client-sqs"); // CommonJS import + * const client = new SQSClient(config); + * const command = new SendMessageCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link SendMessageCommandInput} for command's `input` shape. + * @see {@link SendMessageCommandOutput} for command's `response` shape. + * @see {@link SQSClientResolvedConfig | config} for command's `input` shape. + * */ export class SendMessageCommand extends $Command< SendMessageCommandInput, diff --git a/clients/client-sqs/commands/SetQueueAttributesCommand.ts b/clients/client-sqs/commands/SetQueueAttributesCommand.ts index 9802c995e62b..905930aa7d1f 100644 --- a/clients/client-sqs/commands/SetQueueAttributesCommand.ts +++ b/clients/client-sqs/commands/SetQueueAttributesCommand.ts @@ -36,6 +36,20 @@ export interface SetQueueAttributesCommandOutput extends __MetadataBearer {} * * * + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { SQSClient, SetQueueAttributesCommand } from "@aws-sdk/client-sqs"; // ES Modules import + * // const { SQSClient, SetQueueAttributesCommand } = require("@aws-sdk/client-sqs"); // CommonJS import + * const client = new SQSClient(config); + * const command = new SetQueueAttributesCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link SetQueueAttributesCommandInput} for command's `input` shape. + * @see {@link SetQueueAttributesCommandOutput} for command's `response` shape. + * @see {@link SQSClientResolvedConfig | config} for command's `input` shape. + * */ export class SetQueueAttributesCommand extends $Command< SetQueueAttributesCommandInput, diff --git a/clients/client-sqs/commands/TagQueueCommand.ts b/clients/client-sqs/commands/TagQueueCommand.ts index 5cebbeafafb6..033e20463b01 100644 --- a/clients/client-sqs/commands/TagQueueCommand.ts +++ b/clients/client-sqs/commands/TagQueueCommand.ts @@ -39,6 +39,20 @@ export interface TagQueueCommandOutput extends __MetadataBearer {} * *

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 Simple Queue Service Developer Guide.

* + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { SQSClient, TagQueueCommand } from "@aws-sdk/client-sqs"; // ES Modules import + * // const { SQSClient, TagQueueCommand } = require("@aws-sdk/client-sqs"); // CommonJS import + * const client = new SQSClient(config); + * const command = new TagQueueCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link TagQueueCommandInput} for command's `input` shape. + * @see {@link TagQueueCommandOutput} for command's `response` shape. + * @see {@link SQSClientResolvedConfig | config} for command's `input` shape. + * */ export class TagQueueCommand extends $Command { // Start section: command_properties diff --git a/clients/client-sqs/commands/UntagQueueCommand.ts b/clients/client-sqs/commands/UntagQueueCommand.ts index d1ed60466002..4039ff5f7169 100644 --- a/clients/client-sqs/commands/UntagQueueCommand.ts +++ b/clients/client-sqs/commands/UntagQueueCommand.ts @@ -22,6 +22,20 @@ export interface UntagQueueCommandOutput extends __MetadataBearer {} * *

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 Simple Queue Service Developer Guide.

* + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { SQSClient, UntagQueueCommand } from "@aws-sdk/client-sqs"; // ES Modules import + * // const { SQSClient, UntagQueueCommand } = require("@aws-sdk/client-sqs"); // CommonJS import + * const client = new SQSClient(config); + * const command = new UntagQueueCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link UntagQueueCommandInput} for command's `input` shape. + * @see {@link UntagQueueCommandOutput} for command's `response` shape. + * @see {@link SQSClientResolvedConfig | config} for command's `input` shape. + * */ export class UntagQueueCommand extends $Command< UntagQueueCommandInput, diff --git a/clients/client-sqs/models/models_0.ts b/clients/client-sqs/models/models_0.ts index e658beb14129..cc8ccd5dccf4 100644 --- a/clients/client-sqs/models/models_0.ts +++ b/clients/client-sqs/models/models_0.ts @@ -33,6 +33,9 @@ export interface AddPermissionRequest { } export namespace AddPermissionRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: AddPermissionRequest): any => ({ ...obj, }); @@ -50,6 +53,9 @@ export interface OverLimit extends __SmithyException, $MetadataBearer { } export namespace OverLimit { + /** + * @internal + */ export const filterSensitiveLog = (obj: OverLimit): any => ({ ...obj, }); @@ -76,6 +82,9 @@ export interface ChangeMessageVisibilityRequest { } export namespace ChangeMessageVisibilityRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ChangeMessageVisibilityRequest): any => ({ ...obj, }); @@ -90,6 +99,9 @@ export interface MessageNotInflight extends __SmithyException, $MetadataBearer { } export namespace MessageNotInflight { + /** + * @internal + */ export const filterSensitiveLog = (obj: MessageNotInflight): any => ({ ...obj, }); @@ -104,6 +116,9 @@ export interface ReceiptHandleIsInvalid extends __SmithyException, $MetadataBear } export namespace ReceiptHandleIsInvalid { + /** + * @internal + */ export const filterSensitiveLog = (obj: ReceiptHandleIsInvalid): any => ({ ...obj, }); @@ -118,6 +133,9 @@ export interface BatchEntryIdsNotDistinct extends __SmithyException, $MetadataBe } export namespace BatchEntryIdsNotDistinct { + /** + * @internal + */ export const filterSensitiveLog = (obj: BatchEntryIdsNotDistinct): any => ({ ...obj, }); @@ -162,6 +180,9 @@ export interface ChangeMessageVisibilityBatchRequestEntry { } export namespace ChangeMessageVisibilityBatchRequestEntry { + /** + * @internal + */ export const filterSensitiveLog = (obj: ChangeMessageVisibilityBatchRequestEntry): any => ({ ...obj, }); @@ -184,6 +205,9 @@ export interface ChangeMessageVisibilityBatchRequest { } export namespace ChangeMessageVisibilityBatchRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ChangeMessageVisibilityBatchRequest): any => ({ ...obj, }); @@ -216,6 +240,9 @@ export interface BatchResultErrorEntry { } export namespace BatchResultErrorEntry { + /** + * @internal + */ export const filterSensitiveLog = (obj: BatchResultErrorEntry): any => ({ ...obj, }); @@ -234,6 +261,9 @@ export interface ChangeMessageVisibilityBatchResultEntry { } export namespace ChangeMessageVisibilityBatchResultEntry { + /** + * @internal + */ export const filterSensitiveLog = (obj: ChangeMessageVisibilityBatchResultEntry): any => ({ ...obj, }); @@ -263,6 +293,9 @@ export interface ChangeMessageVisibilityBatchResult { } export namespace ChangeMessageVisibilityBatchResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: ChangeMessageVisibilityBatchResult): any => ({ ...obj, }); @@ -277,6 +310,9 @@ export interface EmptyBatchRequest extends __SmithyException, $MetadataBearer { } export namespace EmptyBatchRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: EmptyBatchRequest): any => ({ ...obj, }); @@ -291,6 +327,9 @@ export interface InvalidBatchEntryId extends __SmithyException, $MetadataBearer } export namespace InvalidBatchEntryId { + /** + * @internal + */ export const filterSensitiveLog = (obj: InvalidBatchEntryId): any => ({ ...obj, }); @@ -305,6 +344,9 @@ export interface TooManyEntriesInBatchRequest extends __SmithyException, $Metada } export namespace TooManyEntriesInBatchRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: TooManyEntriesInBatchRequest): any => ({ ...obj, }); @@ -566,6 +608,9 @@ export interface CreateQueueRequest { } export namespace CreateQueueRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateQueueRequest): any => ({ ...obj, }); @@ -582,6 +627,9 @@ export interface CreateQueueResult { } export namespace CreateQueueResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateQueueResult): any => ({ ...obj, }); @@ -597,6 +645,9 @@ export interface QueueDeletedRecently extends __SmithyException, $MetadataBearer } export namespace QueueDeletedRecently { + /** + * @internal + */ export const filterSensitiveLog = (obj: QueueDeletedRecently): any => ({ ...obj, }); @@ -612,6 +663,9 @@ export interface QueueNameExists extends __SmithyException, $MetadataBearer { } export namespace QueueNameExists { + /** + * @internal + */ export const filterSensitiveLog = (obj: QueueNameExists): any => ({ ...obj, }); @@ -634,6 +688,9 @@ export interface DeleteMessageRequest { } export namespace DeleteMessageRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteMessageRequest): any => ({ ...obj, }); @@ -648,6 +705,9 @@ export interface InvalidIdFormat extends __SmithyException, $MetadataBearer { } export namespace InvalidIdFormat { + /** + * @internal + */ export const filterSensitiveLog = (obj: InvalidIdFormat): any => ({ ...obj, }); @@ -673,6 +733,9 @@ export interface DeleteMessageBatchRequestEntry { } export namespace DeleteMessageBatchRequestEntry { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteMessageBatchRequestEntry): any => ({ ...obj, }); @@ -695,6 +758,9 @@ export interface DeleteMessageBatchRequest { } export namespace DeleteMessageBatchRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteMessageBatchRequest): any => ({ ...obj, }); @@ -713,6 +779,9 @@ export interface DeleteMessageBatchResultEntry { } export namespace DeleteMessageBatchResultEntry { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteMessageBatchResultEntry): any => ({ ...obj, }); @@ -742,6 +811,9 @@ export interface DeleteMessageBatchResult { } export namespace DeleteMessageBatchResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteMessageBatchResult): any => ({ ...obj, }); @@ -759,6 +831,9 @@ export interface DeleteQueueRequest { } export namespace DeleteQueueRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteQueueRequest): any => ({ ...obj, }); @@ -965,6 +1040,9 @@ export interface GetQueueAttributesRequest { } export namespace GetQueueAttributesRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetQueueAttributesRequest): any => ({ ...obj, }); @@ -981,6 +1059,9 @@ export interface GetQueueAttributesResult { } export namespace GetQueueAttributesResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetQueueAttributesResult): any => ({ ...obj, }); @@ -995,6 +1076,9 @@ export interface InvalidAttributeName extends __SmithyException, $MetadataBearer } export namespace InvalidAttributeName { + /** + * @internal + */ export const filterSensitiveLog = (obj: InvalidAttributeName): any => ({ ...obj, }); @@ -1017,6 +1101,9 @@ export interface GetQueueUrlRequest { } export namespace GetQueueUrlRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetQueueUrlRequest): any => ({ ...obj, }); @@ -1033,6 +1120,9 @@ export interface GetQueueUrlResult { } export namespace GetQueueUrlResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetQueueUrlResult): any => ({ ...obj, }); @@ -1047,6 +1137,9 @@ export interface QueueDoesNotExist extends __SmithyException, $MetadataBearer { } export namespace QueueDoesNotExist { + /** + * @internal + */ export const filterSensitiveLog = (obj: QueueDoesNotExist): any => ({ ...obj, }); @@ -1075,6 +1168,9 @@ export interface ListDeadLetterSourceQueuesRequest { } export namespace ListDeadLetterSourceQueuesRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListDeadLetterSourceQueuesRequest): any => ({ ...obj, }); @@ -1097,6 +1193,9 @@ export interface ListDeadLetterSourceQueuesResult { } export namespace ListDeadLetterSourceQueuesResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListDeadLetterSourceQueuesResult): any => ({ ...obj, }); @@ -1125,6 +1224,9 @@ export interface ListQueuesRequest { } export namespace ListQueuesRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListQueuesRequest): any => ({ ...obj, }); @@ -1147,6 +1249,9 @@ export interface ListQueuesResult { } export namespace ListQueuesResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListQueuesResult): any => ({ ...obj, }); @@ -1160,6 +1265,9 @@ export interface ListQueueTagsRequest { } export namespace ListQueueTagsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListQueueTagsRequest): any => ({ ...obj, }); @@ -1173,6 +1281,9 @@ export interface ListQueueTagsResult { } export namespace ListQueueTagsResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListQueueTagsResult): any => ({ ...obj, }); @@ -1187,6 +1298,9 @@ export interface PurgeQueueInProgress extends __SmithyException, $MetadataBearer } export namespace PurgeQueueInProgress { + /** + * @internal + */ export const filterSensitiveLog = (obj: PurgeQueueInProgress): any => ({ ...obj, }); @@ -1204,6 +1318,9 @@ export interface PurgeQueueRequest { } export namespace PurgeQueueRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: PurgeQueueRequest): any => ({ ...obj, }); @@ -1378,6 +1495,9 @@ export interface ReceiveMessageRequest { } export namespace ReceiveMessageRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ReceiveMessageRequest): any => ({ ...obj, }); @@ -1429,6 +1549,9 @@ export interface MessageAttributeValue { } export namespace MessageAttributeValue { + /** + * @internal + */ export const filterSensitiveLog = (obj: MessageAttributeValue): any => ({ ...obj, }); @@ -1518,6 +1641,9 @@ export interface Message { } export namespace Message { + /** + * @internal + */ export const filterSensitiveLog = (obj: Message): any => ({ ...obj, }); @@ -1534,6 +1660,9 @@ export interface ReceiveMessageResult { } export namespace ReceiveMessageResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: ReceiveMessageResult): any => ({ ...obj, }); @@ -1558,6 +1687,9 @@ export interface RemovePermissionRequest { } export namespace RemovePermissionRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: RemovePermissionRequest): any => ({ ...obj, }); @@ -1572,6 +1704,9 @@ export interface InvalidMessageContents extends __SmithyException, $MetadataBear } export namespace InvalidMessageContents { + /** + * @internal + */ export const filterSensitiveLog = (obj: InvalidMessageContents): any => ({ ...obj, }); @@ -1615,6 +1750,9 @@ export interface MessageSystemAttributeValue { } export namespace MessageSystemAttributeValue { + /** + * @internal + */ export const filterSensitiveLog = (obj: MessageSystemAttributeValue): any => ({ ...obj, }); @@ -1758,6 +1896,9 @@ export interface SendMessageRequest { } export namespace SendMessageRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: SendMessageRequest): any => ({ ...obj, }); @@ -1798,6 +1939,9 @@ export interface SendMessageResult { } export namespace SendMessageResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: SendMessageResult): any => ({ ...obj, }); @@ -1812,6 +1956,9 @@ export interface UnsupportedOperation extends __SmithyException, $MetadataBearer } export namespace UnsupportedOperation { + /** + * @internal + */ export const filterSensitiveLog = (obj: UnsupportedOperation): any => ({ ...obj, }); @@ -1826,6 +1973,9 @@ export interface BatchRequestTooLong extends __SmithyException, $MetadataBearer } export namespace BatchRequestTooLong { + /** + * @internal + */ export const filterSensitiveLog = (obj: BatchRequestTooLong): any => ({ ...obj, }); @@ -1965,6 +2115,9 @@ export interface SendMessageBatchRequestEntry { } export namespace SendMessageBatchRequestEntry { + /** + * @internal + */ export const filterSensitiveLog = (obj: SendMessageBatchRequestEntry): any => ({ ...obj, }); @@ -1989,6 +2142,9 @@ export interface SendMessageBatchRequest { } export namespace SendMessageBatchRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: SendMessageBatchRequest): any => ({ ...obj, }); @@ -2034,6 +2190,9 @@ export interface SendMessageBatchResultEntry { } export namespace SendMessageBatchResultEntry { + /** + * @internal + */ export const filterSensitiveLog = (obj: SendMessageBatchResultEntry): any => ({ ...obj, }); @@ -2063,6 +2222,9 @@ export interface SendMessageBatchResult { } export namespace SendMessageBatchResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: SendMessageBatchResult): any => ({ ...obj, }); @@ -2256,6 +2418,9 @@ export interface SetQueueAttributesRequest { } export namespace SetQueueAttributesRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: SetQueueAttributesRequest): any => ({ ...obj, }); @@ -2274,6 +2439,9 @@ export interface TagQueueRequest { } export namespace TagQueueRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: TagQueueRequest): any => ({ ...obj, }); @@ -2292,6 +2460,9 @@ export interface UntagQueueRequest { } export namespace UntagQueueRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: UntagQueueRequest): any => ({ ...obj, }); diff --git a/clients/client-ssm/commands/AddTagsToResourceCommand.ts b/clients/client-ssm/commands/AddTagsToResourceCommand.ts index 237b8fff10bb..79084cfbb2b8 100644 --- a/clients/client-ssm/commands/AddTagsToResourceCommand.ts +++ b/clients/client-ssm/commands/AddTagsToResourceCommand.ts @@ -37,6 +37,20 @@ export interface AddTagsToResourceCommandOutput extends AddTagsToResourceResult, * to and are interpreted strictly as a string of characters.

*

For more information about using tags with EC2 instances, see Tagging your Amazon EC2 resources in the * Amazon EC2 User Guide.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { SSMClient, AddTagsToResourceCommand } from "@aws-sdk/client-ssm"; // ES Modules import + * // const { SSMClient, AddTagsToResourceCommand } = require("@aws-sdk/client-ssm"); // CommonJS import + * const client = new SSMClient(config); + * const command = new AddTagsToResourceCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link AddTagsToResourceCommandInput} for command's `input` shape. + * @see {@link AddTagsToResourceCommandOutput} for command's `response` shape. + * @see {@link SSMClientResolvedConfig | config} for command's `input` shape. + * */ export class AddTagsToResourceCommand extends $Command< AddTagsToResourceCommandInput, diff --git a/clients/client-ssm/commands/CancelCommandCommand.ts b/clients/client-ssm/commands/CancelCommandCommand.ts index 4f442c627a16..9549bd6fb1b8 100644 --- a/clients/client-ssm/commands/CancelCommandCommand.ts +++ b/clients/client-ssm/commands/CancelCommandCommand.ts @@ -23,6 +23,20 @@ export interface CancelCommandCommandOutput extends CancelCommandResult, __Metad /** *

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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { SSMClient, CancelCommandCommand } from "@aws-sdk/client-ssm"; // ES Modules import + * // const { SSMClient, CancelCommandCommand } = require("@aws-sdk/client-ssm"); // CommonJS import + * const client = new SSMClient(config); + * const command = new CancelCommandCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CancelCommandCommandInput} for command's `input` shape. + * @see {@link CancelCommandCommandOutput} for command's `response` shape. + * @see {@link SSMClientResolvedConfig | config} for command's `input` shape. + * */ export class CancelCommandCommand extends $Command< CancelCommandCommandInput, diff --git a/clients/client-ssm/commands/CancelMaintenanceWindowExecutionCommand.ts b/clients/client-ssm/commands/CancelMaintenanceWindowExecutionCommand.ts index e29daded2f46..f9409b268f47 100644 --- a/clients/client-ssm/commands/CancelMaintenanceWindowExecutionCommand.ts +++ b/clients/client-ssm/commands/CancelMaintenanceWindowExecutionCommand.ts @@ -26,6 +26,20 @@ export interface CancelMaintenanceWindowExecutionCommandOutput *

Stops a maintenance window execution that is already in progress and cancels any tasks in * the window that have not already starting running. (Tasks already in progress will continue to * completion.)

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { SSMClient, CancelMaintenanceWindowExecutionCommand } from "@aws-sdk/client-ssm"; // ES Modules import + * // const { SSMClient, CancelMaintenanceWindowExecutionCommand } = require("@aws-sdk/client-ssm"); // CommonJS import + * const client = new SSMClient(config); + * const command = new CancelMaintenanceWindowExecutionCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CancelMaintenanceWindowExecutionCommandInput} for command's `input` shape. + * @see {@link CancelMaintenanceWindowExecutionCommandOutput} for command's `response` shape. + * @see {@link SSMClientResolvedConfig | config} for command's `input` shape. + * */ export class CancelMaintenanceWindowExecutionCommand extends $Command< CancelMaintenanceWindowExecutionCommandInput, diff --git a/clients/client-ssm/commands/CreateActivationCommand.ts b/clients/client-ssm/commands/CreateActivationCommand.ts index 6052553cb97c..b12dd39c6119 100644 --- a/clients/client-ssm/commands/CreateActivationCommand.ts +++ b/clients/client-ssm/commands/CreateActivationCommand.ts @@ -31,6 +31,20 @@ export interface CreateActivationCommandOutput extends CreateActivationResult, _ *

On-premises servers or VMs that are registered with Systems Manager and EC2 instances that you manage * with Systems Manager are all called managed instances.

* + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { SSMClient, CreateActivationCommand } from "@aws-sdk/client-ssm"; // ES Modules import + * // const { SSMClient, CreateActivationCommand } = require("@aws-sdk/client-ssm"); // CommonJS import + * const client = new SSMClient(config); + * const command = new CreateActivationCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreateActivationCommandInput} for command's `input` shape. + * @see {@link CreateActivationCommandOutput} for command's `response` shape. + * @see {@link SSMClientResolvedConfig | config} for command's `input` shape. + * */ export class CreateActivationCommand extends $Command< CreateActivationCommandInput, diff --git a/clients/client-ssm/commands/CreateAssociationBatchCommand.ts b/clients/client-ssm/commands/CreateAssociationBatchCommand.ts index acdf0884b3b6..d1e3eb3f95e8 100644 --- a/clients/client-ssm/commands/CreateAssociationBatchCommand.ts +++ b/clients/client-ssm/commands/CreateAssociationBatchCommand.ts @@ -27,6 +27,20 @@ export interface CreateAssociationBatchCommandOutput extends CreateAssociationBa * specified.

*

If you associate a document with an instance that already has an associated document, the * system returns the AssociationAlreadyExists exception.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { SSMClient, CreateAssociationBatchCommand } from "@aws-sdk/client-ssm"; // ES Modules import + * // const { SSMClient, CreateAssociationBatchCommand } = require("@aws-sdk/client-ssm"); // CommonJS import + * const client = new SSMClient(config); + * const command = new CreateAssociationBatchCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreateAssociationBatchCommandInput} for command's `input` shape. + * @see {@link CreateAssociationBatchCommandOutput} for command's `response` shape. + * @see {@link SSMClientResolvedConfig | config} for command's `input` shape. + * */ export class CreateAssociationBatchCommand extends $Command< CreateAssociationBatchCommandInput, diff --git a/clients/client-ssm/commands/CreateAssociationCommand.ts b/clients/client-ssm/commands/CreateAssociationCommand.ts index d9973dbca02b..244a6ee109be 100644 --- a/clients/client-ssm/commands/CreateAssociationCommand.ts +++ b/clients/client-ssm/commands/CreateAssociationCommand.ts @@ -31,6 +31,20 @@ export interface CreateAssociationCommandOutput extends CreateAssociationResult, * the software is not installed, then State Manager installs it. If the software is installed, but * the service is not running, then the association might instruct State Manager to start the * service.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { SSMClient, CreateAssociationCommand } from "@aws-sdk/client-ssm"; // ES Modules import + * // const { SSMClient, CreateAssociationCommand } = require("@aws-sdk/client-ssm"); // CommonJS import + * const client = new SSMClient(config); + * const command = new CreateAssociationCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreateAssociationCommandInput} for command's `input` shape. + * @see {@link CreateAssociationCommandOutput} for command's `response` shape. + * @see {@link SSMClientResolvedConfig | config} for command's `input` shape. + * */ export class CreateAssociationCommand extends $Command< CreateAssociationCommandInput, diff --git a/clients/client-ssm/commands/CreateDocumentCommand.ts b/clients/client-ssm/commands/CreateDocumentCommand.ts index 99c10284e540..03ab1ba5c5b1 100644 --- a/clients/client-ssm/commands/CreateDocumentCommand.ts +++ b/clients/client-ssm/commands/CreateDocumentCommand.ts @@ -25,6 +25,20 @@ export interface CreateDocumentCommandOutput extends CreateDocumentResult, __Met * your managed instances. For more information about SSM documents, including information about * supported schemas, features, and syntax, see AWS Systems Manager Documents in the * AWS Systems Manager User Guide.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { SSMClient, CreateDocumentCommand } from "@aws-sdk/client-ssm"; // ES Modules import + * // const { SSMClient, CreateDocumentCommand } = require("@aws-sdk/client-ssm"); // CommonJS import + * const client = new SSMClient(config); + * const command = new CreateDocumentCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreateDocumentCommandInput} for command's `input` shape. + * @see {@link CreateDocumentCommandOutput} for command's `response` shape. + * @see {@link SSMClientResolvedConfig | config} for command's `input` shape. + * */ export class CreateDocumentCommand extends $Command< CreateDocumentCommandInput, diff --git a/clients/client-ssm/commands/CreateMaintenanceWindowCommand.ts b/clients/client-ssm/commands/CreateMaintenanceWindowCommand.ts index 091577f7d136..c88325ed63c9 100644 --- a/clients/client-ssm/commands/CreateMaintenanceWindowCommand.ts +++ b/clients/client-ssm/commands/CreateMaintenanceWindowCommand.ts @@ -30,6 +30,20 @@ export interface CreateMaintenanceWindowCommandOutput extends CreateMaintenanceW * value you specify for Cutoff is one hour, no maintenance window tasks can start * after 5 PM.

* + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { SSMClient, CreateMaintenanceWindowCommand } from "@aws-sdk/client-ssm"; // ES Modules import + * // const { SSMClient, CreateMaintenanceWindowCommand } = require("@aws-sdk/client-ssm"); // CommonJS import + * const client = new SSMClient(config); + * const command = new CreateMaintenanceWindowCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreateMaintenanceWindowCommandInput} for command's `input` shape. + * @see {@link CreateMaintenanceWindowCommandOutput} for command's `response` shape. + * @see {@link SSMClientResolvedConfig | config} for command's `input` shape. + * */ export class CreateMaintenanceWindowCommand extends $Command< CreateMaintenanceWindowCommandInput, diff --git a/clients/client-ssm/commands/CreateOpsItemCommand.ts b/clients/client-ssm/commands/CreateOpsItemCommand.ts index 2d8865d61795..e2f7bac5bdf3 100644 --- a/clients/client-ssm/commands/CreateOpsItemCommand.ts +++ b/clients/client-ssm/commands/CreateOpsItemCommand.ts @@ -28,6 +28,20 @@ export interface CreateOpsItemCommandOutput extends CreateOpsItemResponse, __Met * operational issues impacting the performance and health of their AWS resources. For more * information, see AWS Systems Manager OpsCenter in the * AWS Systems Manager User Guide.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { SSMClient, CreateOpsItemCommand } from "@aws-sdk/client-ssm"; // ES Modules import + * // const { SSMClient, CreateOpsItemCommand } = require("@aws-sdk/client-ssm"); // CommonJS import + * const client = new SSMClient(config); + * const command = new CreateOpsItemCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreateOpsItemCommandInput} for command's `input` shape. + * @see {@link CreateOpsItemCommandOutput} for command's `response` shape. + * @see {@link SSMClientResolvedConfig | config} for command's `input` shape. + * */ export class CreateOpsItemCommand extends $Command< CreateOpsItemCommandInput, diff --git a/clients/client-ssm/commands/CreateOpsMetadataCommand.ts b/clients/client-ssm/commands/CreateOpsMetadataCommand.ts index 648ad38a3fe7..4f765c499382 100644 --- a/clients/client-ssm/commands/CreateOpsMetadataCommand.ts +++ b/clients/client-ssm/commands/CreateOpsMetadataCommand.ts @@ -23,6 +23,20 @@ export interface CreateOpsMetadataCommandOutput extends CreateOpsMetadataResult, /** *

If you create a new application in Application Manager, Systems Manager calls this API action to specify * information about the new application, including the application type.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { SSMClient, CreateOpsMetadataCommand } from "@aws-sdk/client-ssm"; // ES Modules import + * // const { SSMClient, CreateOpsMetadataCommand } = require("@aws-sdk/client-ssm"); // CommonJS import + * const client = new SSMClient(config); + * const command = new CreateOpsMetadataCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreateOpsMetadataCommandInput} for command's `input` shape. + * @see {@link CreateOpsMetadataCommandOutput} for command's `response` shape. + * @see {@link SSMClientResolvedConfig | config} for command's `input` shape. + * */ export class CreateOpsMetadataCommand extends $Command< CreateOpsMetadataCommandInput, diff --git a/clients/client-ssm/commands/CreatePatchBaselineCommand.ts b/clients/client-ssm/commands/CreatePatchBaselineCommand.ts index 92027d653024..e3ee42a948ea 100644 --- a/clients/client-ssm/commands/CreatePatchBaselineCommand.ts +++ b/clients/client-ssm/commands/CreatePatchBaselineCommand.ts @@ -26,6 +26,20 @@ export interface CreatePatchBaselineCommandOutput extends CreatePatchBaselineRes *

For information about valid key and value pairs in PatchFilters for each * supported operating system type, see PatchFilter.

* + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { SSMClient, CreatePatchBaselineCommand } from "@aws-sdk/client-ssm"; // ES Modules import + * // const { SSMClient, CreatePatchBaselineCommand } = require("@aws-sdk/client-ssm"); // CommonJS import + * const client = new SSMClient(config); + * const command = new CreatePatchBaselineCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreatePatchBaselineCommandInput} for command's `input` shape. + * @see {@link CreatePatchBaselineCommandOutput} for command's `response` shape. + * @see {@link SSMClientResolvedConfig | config} for command's `input` shape. + * */ export class CreatePatchBaselineCommand extends $Command< CreatePatchBaselineCommandInput, diff --git a/clients/client-ssm/commands/CreateResourceDataSyncCommand.ts b/clients/client-ssm/commands/CreateResourceDataSyncCommand.ts index 8da7fb9e94a3..9b15af082cf6 100644 --- a/clients/client-ssm/commands/CreateResourceDataSyncCommand.ts +++ b/clients/client-ssm/commands/CreateResourceDataSyncCommand.ts @@ -44,6 +44,20 @@ export interface CreateResourceDataSyncCommandOutput extends CreateResourceDataS * 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.

* + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { SSMClient, CreateResourceDataSyncCommand } from "@aws-sdk/client-ssm"; // ES Modules import + * // const { SSMClient, CreateResourceDataSyncCommand } = require("@aws-sdk/client-ssm"); // CommonJS import + * const client = new SSMClient(config); + * const command = new CreateResourceDataSyncCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreateResourceDataSyncCommandInput} for command's `input` shape. + * @see {@link CreateResourceDataSyncCommandOutput} for command's `response` shape. + * @see {@link SSMClientResolvedConfig | config} for command's `input` shape. + * */ export class CreateResourceDataSyncCommand extends $Command< CreateResourceDataSyncCommandInput, diff --git a/clients/client-ssm/commands/DeleteActivationCommand.ts b/clients/client-ssm/commands/DeleteActivationCommand.ts index 5ea4620ddf60..4ba4628762f3 100644 --- a/clients/client-ssm/commands/DeleteActivationCommand.ts +++ b/clients/client-ssm/commands/DeleteActivationCommand.ts @@ -25,6 +25,20 @@ export interface DeleteActivationCommandOutput extends DeleteActivationResult, _ * activation, you can no longer use it to register additional managed instances. Deleting an * activation does not de-register managed instances. You must manually de-register managed * instances.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { SSMClient, DeleteActivationCommand } from "@aws-sdk/client-ssm"; // ES Modules import + * // const { SSMClient, DeleteActivationCommand } = require("@aws-sdk/client-ssm"); // CommonJS import + * const client = new SSMClient(config); + * const command = new DeleteActivationCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteActivationCommandInput} for command's `input` shape. + * @see {@link DeleteActivationCommandOutput} for command's `response` shape. + * @see {@link SSMClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteActivationCommand extends $Command< DeleteActivationCommandInput, diff --git a/clients/client-ssm/commands/DeleteAssociationCommand.ts b/clients/client-ssm/commands/DeleteAssociationCommand.ts index 925fc3425412..977c68b97b8c 100644 --- a/clients/client-ssm/commands/DeleteAssociationCommand.ts +++ b/clients/client-ssm/commands/DeleteAssociationCommand.ts @@ -26,6 +26,20 @@ export interface DeleteAssociationCommandOutput extends DeleteAssociationResult, * the instance. To change the configuration state of an instance after you disassociate a document, * you must create a new document with the desired configuration and associate it with the * instance.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { SSMClient, DeleteAssociationCommand } from "@aws-sdk/client-ssm"; // ES Modules import + * // const { SSMClient, DeleteAssociationCommand } = require("@aws-sdk/client-ssm"); // CommonJS import + * const client = new SSMClient(config); + * const command = new DeleteAssociationCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteAssociationCommandInput} for command's `input` shape. + * @see {@link DeleteAssociationCommandOutput} for command's `response` shape. + * @see {@link SSMClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteAssociationCommand extends $Command< DeleteAssociationCommandInput, diff --git a/clients/client-ssm/commands/DeleteDocumentCommand.ts b/clients/client-ssm/commands/DeleteDocumentCommand.ts index 426d6556b23c..a937b9c1ee11 100644 --- a/clients/client-ssm/commands/DeleteDocumentCommand.ts +++ b/clients/client-ssm/commands/DeleteDocumentCommand.ts @@ -23,6 +23,20 @@ export interface DeleteDocumentCommandOutput extends DeleteDocumentResult, __Met /** *

Deletes the Systems Manager document and all instance associations to the document.

*

Before you delete the document, we recommend that you use DeleteAssociation to disassociate all instances that are associated with the document.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { SSMClient, DeleteDocumentCommand } from "@aws-sdk/client-ssm"; // ES Modules import + * // const { SSMClient, DeleteDocumentCommand } = require("@aws-sdk/client-ssm"); // CommonJS import + * const client = new SSMClient(config); + * const command = new DeleteDocumentCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteDocumentCommandInput} for command's `input` shape. + * @see {@link DeleteDocumentCommandOutput} for command's `response` shape. + * @see {@link SSMClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteDocumentCommand extends $Command< DeleteDocumentCommandInput, diff --git a/clients/client-ssm/commands/DeleteInventoryCommand.ts b/clients/client-ssm/commands/DeleteInventoryCommand.ts index aeb44326dcc3..c973c342ae7e 100644 --- a/clients/client-ssm/commands/DeleteInventoryCommand.ts +++ b/clients/client-ssm/commands/DeleteInventoryCommand.ts @@ -23,6 +23,20 @@ export interface DeleteInventoryCommandOutput extends DeleteInventoryResult, __M /** *

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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { SSMClient, DeleteInventoryCommand } from "@aws-sdk/client-ssm"; // ES Modules import + * // const { SSMClient, DeleteInventoryCommand } = require("@aws-sdk/client-ssm"); // CommonJS import + * const client = new SSMClient(config); + * const command = new DeleteInventoryCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteInventoryCommandInput} for command's `input` shape. + * @see {@link DeleteInventoryCommandOutput} for command's `response` shape. + * @see {@link SSMClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteInventoryCommand extends $Command< DeleteInventoryCommandInput, diff --git a/clients/client-ssm/commands/DeleteMaintenanceWindowCommand.ts b/clients/client-ssm/commands/DeleteMaintenanceWindowCommand.ts index b9c9e09d1e34..eac16628b55c 100644 --- a/clients/client-ssm/commands/DeleteMaintenanceWindowCommand.ts +++ b/clients/client-ssm/commands/DeleteMaintenanceWindowCommand.ts @@ -22,6 +22,20 @@ export interface DeleteMaintenanceWindowCommandOutput extends DeleteMaintenanceW /** *

Deletes a maintenance window.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { SSMClient, DeleteMaintenanceWindowCommand } from "@aws-sdk/client-ssm"; // ES Modules import + * // const { SSMClient, DeleteMaintenanceWindowCommand } = require("@aws-sdk/client-ssm"); // CommonJS import + * const client = new SSMClient(config); + * const command = new DeleteMaintenanceWindowCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteMaintenanceWindowCommandInput} for command's `input` shape. + * @see {@link DeleteMaintenanceWindowCommandOutput} for command's `response` shape. + * @see {@link SSMClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteMaintenanceWindowCommand extends $Command< DeleteMaintenanceWindowCommandInput, diff --git a/clients/client-ssm/commands/DeleteOpsMetadataCommand.ts b/clients/client-ssm/commands/DeleteOpsMetadataCommand.ts index 6ed379f09747..ac8ae3dd4ce2 100644 --- a/clients/client-ssm/commands/DeleteOpsMetadataCommand.ts +++ b/clients/client-ssm/commands/DeleteOpsMetadataCommand.ts @@ -22,6 +22,20 @@ export interface DeleteOpsMetadataCommandOutput extends DeleteOpsMetadataResult, /** *

Delete OpsMetadata related to an application.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { SSMClient, DeleteOpsMetadataCommand } from "@aws-sdk/client-ssm"; // ES Modules import + * // const { SSMClient, DeleteOpsMetadataCommand } = require("@aws-sdk/client-ssm"); // CommonJS import + * const client = new SSMClient(config); + * const command = new DeleteOpsMetadataCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteOpsMetadataCommandInput} for command's `input` shape. + * @see {@link DeleteOpsMetadataCommandOutput} for command's `response` shape. + * @see {@link SSMClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteOpsMetadataCommand extends $Command< DeleteOpsMetadataCommandInput, diff --git a/clients/client-ssm/commands/DeleteParameterCommand.ts b/clients/client-ssm/commands/DeleteParameterCommand.ts index 1fa83c4d79ed..fe726b3b817c 100644 --- a/clients/client-ssm/commands/DeleteParameterCommand.ts +++ b/clients/client-ssm/commands/DeleteParameterCommand.ts @@ -22,6 +22,20 @@ export interface DeleteParameterCommandOutput extends DeleteParameterResult, __M /** *

Delete a parameter from the system.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { SSMClient, DeleteParameterCommand } from "@aws-sdk/client-ssm"; // ES Modules import + * // const { SSMClient, DeleteParameterCommand } = require("@aws-sdk/client-ssm"); // CommonJS import + * const client = new SSMClient(config); + * const command = new DeleteParameterCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteParameterCommandInput} for command's `input` shape. + * @see {@link DeleteParameterCommandOutput} for command's `response` shape. + * @see {@link SSMClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteParameterCommand extends $Command< DeleteParameterCommandInput, diff --git a/clients/client-ssm/commands/DeleteParametersCommand.ts b/clients/client-ssm/commands/DeleteParametersCommand.ts index 21f535edd2d0..9f4061e17f05 100644 --- a/clients/client-ssm/commands/DeleteParametersCommand.ts +++ b/clients/client-ssm/commands/DeleteParametersCommand.ts @@ -22,6 +22,20 @@ export interface DeleteParametersCommandOutput extends DeleteParametersResult, _ /** *

Delete a list of parameters.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { SSMClient, DeleteParametersCommand } from "@aws-sdk/client-ssm"; // ES Modules import + * // const { SSMClient, DeleteParametersCommand } = require("@aws-sdk/client-ssm"); // CommonJS import + * const client = new SSMClient(config); + * const command = new DeleteParametersCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteParametersCommandInput} for command's `input` shape. + * @see {@link DeleteParametersCommandOutput} for command's `response` shape. + * @see {@link SSMClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteParametersCommand extends $Command< DeleteParametersCommandInput, diff --git a/clients/client-ssm/commands/DeletePatchBaselineCommand.ts b/clients/client-ssm/commands/DeletePatchBaselineCommand.ts index c308713d854b..007405e01db4 100644 --- a/clients/client-ssm/commands/DeletePatchBaselineCommand.ts +++ b/clients/client-ssm/commands/DeletePatchBaselineCommand.ts @@ -22,6 +22,20 @@ export interface DeletePatchBaselineCommandOutput extends DeletePatchBaselineRes /** *

Deletes a patch baseline.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { SSMClient, DeletePatchBaselineCommand } from "@aws-sdk/client-ssm"; // ES Modules import + * // const { SSMClient, DeletePatchBaselineCommand } = require("@aws-sdk/client-ssm"); // CommonJS import + * const client = new SSMClient(config); + * const command = new DeletePatchBaselineCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeletePatchBaselineCommandInput} for command's `input` shape. + * @see {@link DeletePatchBaselineCommandOutput} for command's `response` shape. + * @see {@link SSMClientResolvedConfig | config} for command's `input` shape. + * */ export class DeletePatchBaselineCommand extends $Command< DeletePatchBaselineCommandInput, diff --git a/clients/client-ssm/commands/DeleteResourceDataSyncCommand.ts b/clients/client-ssm/commands/DeleteResourceDataSyncCommand.ts index 4f61bbed3337..153799737f56 100644 --- a/clients/client-ssm/commands/DeleteResourceDataSyncCommand.ts +++ b/clients/client-ssm/commands/DeleteResourceDataSyncCommand.ts @@ -24,6 +24,20 @@ export interface DeleteResourceDataSyncCommandOutput extends DeleteResourceDataS *

Deletes a Resource Data Sync configuration. After the configuration is deleted, changes to * data on managed instances are no longer synced to or from the target. Deleting a sync * configuration does not delete data.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { SSMClient, DeleteResourceDataSyncCommand } from "@aws-sdk/client-ssm"; // ES Modules import + * // const { SSMClient, DeleteResourceDataSyncCommand } = require("@aws-sdk/client-ssm"); // CommonJS import + * const client = new SSMClient(config); + * const command = new DeleteResourceDataSyncCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteResourceDataSyncCommandInput} for command's `input` shape. + * @see {@link DeleteResourceDataSyncCommandOutput} for command's `response` shape. + * @see {@link SSMClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteResourceDataSyncCommand extends $Command< DeleteResourceDataSyncCommandInput, diff --git a/clients/client-ssm/commands/DeregisterManagedInstanceCommand.ts b/clients/client-ssm/commands/DeregisterManagedInstanceCommand.ts index 800651075a5c..b2609b4d7962 100644 --- a/clients/client-ssm/commands/DeregisterManagedInstanceCommand.ts +++ b/clients/client-ssm/commands/DeregisterManagedInstanceCommand.ts @@ -24,6 +24,20 @@ export interface DeregisterManagedInstanceCommandOutput extends DeregisterManage *

Removes the server or virtual machine from the list of registered servers. You can * reregister the instance again at any time. If you don't plan to use Run Command on the server, we * suggest uninstalling SSM Agent first.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { SSMClient, DeregisterManagedInstanceCommand } from "@aws-sdk/client-ssm"; // ES Modules import + * // const { SSMClient, DeregisterManagedInstanceCommand } = require("@aws-sdk/client-ssm"); // CommonJS import + * const client = new SSMClient(config); + * const command = new DeregisterManagedInstanceCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeregisterManagedInstanceCommandInput} for command's `input` shape. + * @see {@link DeregisterManagedInstanceCommandOutput} for command's `response` shape. + * @see {@link SSMClientResolvedConfig | config} for command's `input` shape. + * */ export class DeregisterManagedInstanceCommand extends $Command< DeregisterManagedInstanceCommandInput, diff --git a/clients/client-ssm/commands/DeregisterPatchBaselineForPatchGroupCommand.ts b/clients/client-ssm/commands/DeregisterPatchBaselineForPatchGroupCommand.ts index 44ff7dad3a8b..79c3efc82cd0 100644 --- a/clients/client-ssm/commands/DeregisterPatchBaselineForPatchGroupCommand.ts +++ b/clients/client-ssm/commands/DeregisterPatchBaselineForPatchGroupCommand.ts @@ -27,6 +27,20 @@ export interface DeregisterPatchBaselineForPatchGroupCommandOutput /** *

Removes a patch group from a patch baseline.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { SSMClient, DeregisterPatchBaselineForPatchGroupCommand } from "@aws-sdk/client-ssm"; // ES Modules import + * // const { SSMClient, DeregisterPatchBaselineForPatchGroupCommand } = require("@aws-sdk/client-ssm"); // CommonJS import + * const client = new SSMClient(config); + * const command = new DeregisterPatchBaselineForPatchGroupCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeregisterPatchBaselineForPatchGroupCommandInput} for command's `input` shape. + * @see {@link DeregisterPatchBaselineForPatchGroupCommandOutput} for command's `response` shape. + * @see {@link SSMClientResolvedConfig | config} for command's `input` shape. + * */ export class DeregisterPatchBaselineForPatchGroupCommand extends $Command< DeregisterPatchBaselineForPatchGroupCommandInput, diff --git a/clients/client-ssm/commands/DeregisterTargetFromMaintenanceWindowCommand.ts b/clients/client-ssm/commands/DeregisterTargetFromMaintenanceWindowCommand.ts index b414d6d0e98e..40504642744f 100644 --- a/clients/client-ssm/commands/DeregisterTargetFromMaintenanceWindowCommand.ts +++ b/clients/client-ssm/commands/DeregisterTargetFromMaintenanceWindowCommand.ts @@ -28,6 +28,20 @@ export interface DeregisterTargetFromMaintenanceWindowCommandOutput /** *

Removes a target from a maintenance window.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { SSMClient, DeregisterTargetFromMaintenanceWindowCommand } from "@aws-sdk/client-ssm"; // ES Modules import + * // const { SSMClient, DeregisterTargetFromMaintenanceWindowCommand } = require("@aws-sdk/client-ssm"); // CommonJS import + * const client = new SSMClient(config); + * const command = new DeregisterTargetFromMaintenanceWindowCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeregisterTargetFromMaintenanceWindowCommandInput} for command's `input` shape. + * @see {@link DeregisterTargetFromMaintenanceWindowCommandOutput} for command's `response` shape. + * @see {@link SSMClientResolvedConfig | config} for command's `input` shape. + * */ export class DeregisterTargetFromMaintenanceWindowCommand extends $Command< DeregisterTargetFromMaintenanceWindowCommandInput, diff --git a/clients/client-ssm/commands/DeregisterTaskFromMaintenanceWindowCommand.ts b/clients/client-ssm/commands/DeregisterTaskFromMaintenanceWindowCommand.ts index b38b67f1c48a..62226faa1067 100644 --- a/clients/client-ssm/commands/DeregisterTaskFromMaintenanceWindowCommand.ts +++ b/clients/client-ssm/commands/DeregisterTaskFromMaintenanceWindowCommand.ts @@ -27,6 +27,20 @@ export interface DeregisterTaskFromMaintenanceWindowCommandOutput /** *

Removes a task from a maintenance window.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { SSMClient, DeregisterTaskFromMaintenanceWindowCommand } from "@aws-sdk/client-ssm"; // ES Modules import + * // const { SSMClient, DeregisterTaskFromMaintenanceWindowCommand } = require("@aws-sdk/client-ssm"); // CommonJS import + * const client = new SSMClient(config); + * const command = new DeregisterTaskFromMaintenanceWindowCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeregisterTaskFromMaintenanceWindowCommandInput} for command's `input` shape. + * @see {@link DeregisterTaskFromMaintenanceWindowCommandOutput} for command's `response` shape. + * @see {@link SSMClientResolvedConfig | config} for command's `input` shape. + * */ export class DeregisterTaskFromMaintenanceWindowCommand extends $Command< DeregisterTaskFromMaintenanceWindowCommandInput, diff --git a/clients/client-ssm/commands/DescribeActivationsCommand.ts b/clients/client-ssm/commands/DescribeActivationsCommand.ts index 2902bea0c42f..596cf9f976c3 100644 --- a/clients/client-ssm/commands/DescribeActivationsCommand.ts +++ b/clients/client-ssm/commands/DescribeActivationsCommand.ts @@ -24,6 +24,20 @@ export interface DescribeActivationsCommandOutput extends DescribeActivationsRes *

Describes details about the activation, such as the date and time the activation was * created, its expiration date, the IAM role assigned to the instances in the activation, and the * number of instances registered by using this activation.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { SSMClient, DescribeActivationsCommand } from "@aws-sdk/client-ssm"; // ES Modules import + * // const { SSMClient, DescribeActivationsCommand } = require("@aws-sdk/client-ssm"); // CommonJS import + * const client = new SSMClient(config); + * const command = new DescribeActivationsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeActivationsCommandInput} for command's `input` shape. + * @see {@link DescribeActivationsCommandOutput} for command's `response` shape. + * @see {@link SSMClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeActivationsCommand extends $Command< DescribeActivationsCommandInput, diff --git a/clients/client-ssm/commands/DescribeAssociationCommand.ts b/clients/client-ssm/commands/DescribeAssociationCommand.ts index 6bcc63ce65c4..52ac27e43d11 100644 --- a/clients/client-ssm/commands/DescribeAssociationCommand.ts +++ b/clients/client-ssm/commands/DescribeAssociationCommand.ts @@ -26,6 +26,20 @@ export interface DescribeAssociationCommandOutput extends DescribeAssociationRes * by using the association ID. If you created the association by specifying an instance ID and a * Systems Manager document, then you retrieve the association by specifying the document name and the * instance ID.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { SSMClient, DescribeAssociationCommand } from "@aws-sdk/client-ssm"; // ES Modules import + * // const { SSMClient, DescribeAssociationCommand } = require("@aws-sdk/client-ssm"); // CommonJS import + * const client = new SSMClient(config); + * const command = new DescribeAssociationCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeAssociationCommandInput} for command's `input` shape. + * @see {@link DescribeAssociationCommandOutput} for command's `response` shape. + * @see {@link SSMClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeAssociationCommand extends $Command< DescribeAssociationCommandInput, diff --git a/clients/client-ssm/commands/DescribeAssociationExecutionTargetsCommand.ts b/clients/client-ssm/commands/DescribeAssociationExecutionTargetsCommand.ts index 6538632bf8bd..e137e9f98a57 100644 --- a/clients/client-ssm/commands/DescribeAssociationExecutionTargetsCommand.ts +++ b/clients/client-ssm/commands/DescribeAssociationExecutionTargetsCommand.ts @@ -28,6 +28,20 @@ export interface DescribeAssociationExecutionTargetsCommandOutput /** *

Use this API action to view information about a specific execution of a specific * association.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { SSMClient, DescribeAssociationExecutionTargetsCommand } from "@aws-sdk/client-ssm"; // ES Modules import + * // const { SSMClient, DescribeAssociationExecutionTargetsCommand } = require("@aws-sdk/client-ssm"); // CommonJS import + * const client = new SSMClient(config); + * const command = new DescribeAssociationExecutionTargetsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeAssociationExecutionTargetsCommandInput} for command's `input` shape. + * @see {@link DescribeAssociationExecutionTargetsCommandOutput} for command's `response` shape. + * @see {@link SSMClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeAssociationExecutionTargetsCommand extends $Command< DescribeAssociationExecutionTargetsCommandInput, diff --git a/clients/client-ssm/commands/DescribeAssociationExecutionsCommand.ts b/clients/client-ssm/commands/DescribeAssociationExecutionsCommand.ts index bd1376cb5f71..c496887397c4 100644 --- a/clients/client-ssm/commands/DescribeAssociationExecutionsCommand.ts +++ b/clients/client-ssm/commands/DescribeAssociationExecutionsCommand.ts @@ -24,6 +24,20 @@ export interface DescribeAssociationExecutionsCommandOutput /** *

Use this API action to view all executions for a specific association ID.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { SSMClient, DescribeAssociationExecutionsCommand } from "@aws-sdk/client-ssm"; // ES Modules import + * // const { SSMClient, DescribeAssociationExecutionsCommand } = require("@aws-sdk/client-ssm"); // CommonJS import + * const client = new SSMClient(config); + * const command = new DescribeAssociationExecutionsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeAssociationExecutionsCommandInput} for command's `input` shape. + * @see {@link DescribeAssociationExecutionsCommandOutput} for command's `response` shape. + * @see {@link SSMClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeAssociationExecutionsCommand extends $Command< DescribeAssociationExecutionsCommandInput, diff --git a/clients/client-ssm/commands/DescribeAutomationExecutionsCommand.ts b/clients/client-ssm/commands/DescribeAutomationExecutionsCommand.ts index 125f571e110b..6c605a2e5e23 100644 --- a/clients/client-ssm/commands/DescribeAutomationExecutionsCommand.ts +++ b/clients/client-ssm/commands/DescribeAutomationExecutionsCommand.ts @@ -24,6 +24,20 @@ export interface DescribeAutomationExecutionsCommandOutput /** *

Provides details about all active and terminated Automation executions.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { SSMClient, DescribeAutomationExecutionsCommand } from "@aws-sdk/client-ssm"; // ES Modules import + * // const { SSMClient, DescribeAutomationExecutionsCommand } = require("@aws-sdk/client-ssm"); // CommonJS import + * const client = new SSMClient(config); + * const command = new DescribeAutomationExecutionsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeAutomationExecutionsCommandInput} for command's `input` shape. + * @see {@link DescribeAutomationExecutionsCommandOutput} for command's `response` shape. + * @see {@link SSMClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeAutomationExecutionsCommand extends $Command< DescribeAutomationExecutionsCommandInput, diff --git a/clients/client-ssm/commands/DescribeAutomationStepExecutionsCommand.ts b/clients/client-ssm/commands/DescribeAutomationStepExecutionsCommand.ts index a6e0b5366f9e..568b312ee51f 100644 --- a/clients/client-ssm/commands/DescribeAutomationStepExecutionsCommand.ts +++ b/clients/client-ssm/commands/DescribeAutomationStepExecutionsCommand.ts @@ -25,6 +25,20 @@ export interface DescribeAutomationStepExecutionsCommandOutput /** *

Information about all active and terminated step executions in an Automation * workflow.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { SSMClient, DescribeAutomationStepExecutionsCommand } from "@aws-sdk/client-ssm"; // ES Modules import + * // const { SSMClient, DescribeAutomationStepExecutionsCommand } = require("@aws-sdk/client-ssm"); // CommonJS import + * const client = new SSMClient(config); + * const command = new DescribeAutomationStepExecutionsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeAutomationStepExecutionsCommandInput} for command's `input` shape. + * @see {@link DescribeAutomationStepExecutionsCommandOutput} for command's `response` shape. + * @see {@link SSMClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeAutomationStepExecutionsCommand extends $Command< DescribeAutomationStepExecutionsCommandInput, diff --git a/clients/client-ssm/commands/DescribeAvailablePatchesCommand.ts b/clients/client-ssm/commands/DescribeAvailablePatchesCommand.ts index de6544d9cd56..74c5d8612d90 100644 --- a/clients/client-ssm/commands/DescribeAvailablePatchesCommand.ts +++ b/clients/client-ssm/commands/DescribeAvailablePatchesCommand.ts @@ -22,6 +22,20 @@ export interface DescribeAvailablePatchesCommandOutput extends DescribeAvailable /** *

Lists all patches eligible to be included in a patch baseline.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { SSMClient, DescribeAvailablePatchesCommand } from "@aws-sdk/client-ssm"; // ES Modules import + * // const { SSMClient, DescribeAvailablePatchesCommand } = require("@aws-sdk/client-ssm"); // CommonJS import + * const client = new SSMClient(config); + * const command = new DescribeAvailablePatchesCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeAvailablePatchesCommandInput} for command's `input` shape. + * @see {@link DescribeAvailablePatchesCommandOutput} for command's `response` shape. + * @see {@link SSMClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeAvailablePatchesCommand extends $Command< DescribeAvailablePatchesCommandInput, diff --git a/clients/client-ssm/commands/DescribeDocumentCommand.ts b/clients/client-ssm/commands/DescribeDocumentCommand.ts index 8f8e164647f7..67bf1aa34a73 100644 --- a/clients/client-ssm/commands/DescribeDocumentCommand.ts +++ b/clients/client-ssm/commands/DescribeDocumentCommand.ts @@ -22,6 +22,20 @@ export interface DescribeDocumentCommandOutput extends DescribeDocumentResult, _ /** *

Describes the specified Systems Manager document.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { SSMClient, DescribeDocumentCommand } from "@aws-sdk/client-ssm"; // ES Modules import + * // const { SSMClient, DescribeDocumentCommand } = require("@aws-sdk/client-ssm"); // CommonJS import + * const client = new SSMClient(config); + * const command = new DescribeDocumentCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeDocumentCommandInput} for command's `input` shape. + * @see {@link DescribeDocumentCommandOutput} for command's `response` shape. + * @see {@link SSMClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeDocumentCommand extends $Command< DescribeDocumentCommandInput, diff --git a/clients/client-ssm/commands/DescribeDocumentPermissionCommand.ts b/clients/client-ssm/commands/DescribeDocumentPermissionCommand.ts index 5f462bd4248e..81b93b5920cd 100644 --- a/clients/client-ssm/commands/DescribeDocumentPermissionCommand.ts +++ b/clients/client-ssm/commands/DescribeDocumentPermissionCommand.ts @@ -24,6 +24,20 @@ export interface DescribeDocumentPermissionCommandOutput extends DescribeDocumen *

Describes the permissions for a Systems Manager 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 AWS * account ID) or publicly (All).

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { SSMClient, DescribeDocumentPermissionCommand } from "@aws-sdk/client-ssm"; // ES Modules import + * // const { SSMClient, DescribeDocumentPermissionCommand } = require("@aws-sdk/client-ssm"); // CommonJS import + * const client = new SSMClient(config); + * const command = new DescribeDocumentPermissionCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeDocumentPermissionCommandInput} for command's `input` shape. + * @see {@link DescribeDocumentPermissionCommandOutput} for command's `response` shape. + * @see {@link SSMClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeDocumentPermissionCommand extends $Command< DescribeDocumentPermissionCommandInput, diff --git a/clients/client-ssm/commands/DescribeEffectiveInstanceAssociationsCommand.ts b/clients/client-ssm/commands/DescribeEffectiveInstanceAssociationsCommand.ts index 611aac9af8d6..46eb06840422 100644 --- a/clients/client-ssm/commands/DescribeEffectiveInstanceAssociationsCommand.ts +++ b/clients/client-ssm/commands/DescribeEffectiveInstanceAssociationsCommand.ts @@ -28,6 +28,20 @@ export interface DescribeEffectiveInstanceAssociationsCommandOutput /** *

All associations for the instance(s).

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { SSMClient, DescribeEffectiveInstanceAssociationsCommand } from "@aws-sdk/client-ssm"; // ES Modules import + * // const { SSMClient, DescribeEffectiveInstanceAssociationsCommand } = require("@aws-sdk/client-ssm"); // CommonJS import + * const client = new SSMClient(config); + * const command = new DescribeEffectiveInstanceAssociationsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeEffectiveInstanceAssociationsCommandInput} for command's `input` shape. + * @see {@link DescribeEffectiveInstanceAssociationsCommandOutput} for command's `response` shape. + * @see {@link SSMClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeEffectiveInstanceAssociationsCommand extends $Command< DescribeEffectiveInstanceAssociationsCommandInput, diff --git a/clients/client-ssm/commands/DescribeEffectivePatchesForPatchBaselineCommand.ts b/clients/client-ssm/commands/DescribeEffectivePatchesForPatchBaselineCommand.ts index 24cda632b6a0..6ea6d7cd1857 100644 --- a/clients/client-ssm/commands/DescribeEffectivePatchesForPatchBaselineCommand.ts +++ b/clients/client-ssm/commands/DescribeEffectivePatchesForPatchBaselineCommand.ts @@ -29,6 +29,20 @@ export interface DescribeEffectivePatchesForPatchBaselineCommandOutput /** *

Retrieves the current effective patches (the patch and the approval state) for the specified * patch baseline. Note that this API applies only to Windows patch baselines.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { SSMClient, DescribeEffectivePatchesForPatchBaselineCommand } from "@aws-sdk/client-ssm"; // ES Modules import + * // const { SSMClient, DescribeEffectivePatchesForPatchBaselineCommand } = require("@aws-sdk/client-ssm"); // CommonJS import + * const client = new SSMClient(config); + * const command = new DescribeEffectivePatchesForPatchBaselineCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeEffectivePatchesForPatchBaselineCommandInput} for command's `input` shape. + * @see {@link DescribeEffectivePatchesForPatchBaselineCommandOutput} for command's `response` shape. + * @see {@link SSMClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeEffectivePatchesForPatchBaselineCommand extends $Command< DescribeEffectivePatchesForPatchBaselineCommandInput, diff --git a/clients/client-ssm/commands/DescribeInstanceAssociationsStatusCommand.ts b/clients/client-ssm/commands/DescribeInstanceAssociationsStatusCommand.ts index bb2e1c117caa..47c9db97b339 100644 --- a/clients/client-ssm/commands/DescribeInstanceAssociationsStatusCommand.ts +++ b/clients/client-ssm/commands/DescribeInstanceAssociationsStatusCommand.ts @@ -27,6 +27,20 @@ export interface DescribeInstanceAssociationsStatusCommandOutput /** *

The status of the associations for the instance(s).

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { SSMClient, DescribeInstanceAssociationsStatusCommand } from "@aws-sdk/client-ssm"; // ES Modules import + * // const { SSMClient, DescribeInstanceAssociationsStatusCommand } = require("@aws-sdk/client-ssm"); // CommonJS import + * const client = new SSMClient(config); + * const command = new DescribeInstanceAssociationsStatusCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeInstanceAssociationsStatusCommandInput} for command's `input` shape. + * @see {@link DescribeInstanceAssociationsStatusCommandOutput} for command's `response` shape. + * @see {@link SSMClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeInstanceAssociationsStatusCommand extends $Command< DescribeInstanceAssociationsStatusCommandInput, diff --git a/clients/client-ssm/commands/DescribeInstanceInformationCommand.ts b/clients/client-ssm/commands/DescribeInstanceInformationCommand.ts index 6016c179bcfd..15838cc7f6a3 100644 --- a/clients/client-ssm/commands/DescribeInstanceInformationCommand.ts +++ b/clients/client-ssm/commands/DescribeInstanceInformationCommand.ts @@ -31,6 +31,20 @@ export interface DescribeInstanceInformationCommandOutput extends DescribeInstan * role assigned to on-premises instances. This call does not return the IAM role for EC2 * instances.

* + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { SSMClient, DescribeInstanceInformationCommand } from "@aws-sdk/client-ssm"; // ES Modules import + * // const { SSMClient, DescribeInstanceInformationCommand } = require("@aws-sdk/client-ssm"); // CommonJS import + * const client = new SSMClient(config); + * const command = new DescribeInstanceInformationCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeInstanceInformationCommandInput} for command's `input` shape. + * @see {@link DescribeInstanceInformationCommandOutput} for command's `response` shape. + * @see {@link SSMClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeInstanceInformationCommand extends $Command< DescribeInstanceInformationCommandInput, diff --git a/clients/client-ssm/commands/DescribeInstancePatchStatesCommand.ts b/clients/client-ssm/commands/DescribeInstancePatchStatesCommand.ts index 2732571366da..7cf94c1c3481 100644 --- a/clients/client-ssm/commands/DescribeInstancePatchStatesCommand.ts +++ b/clients/client-ssm/commands/DescribeInstancePatchStatesCommand.ts @@ -22,6 +22,20 @@ export interface DescribeInstancePatchStatesCommandOutput extends DescribeInstan /** *

Retrieves the high-level patch state of one or more instances.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { SSMClient, DescribeInstancePatchStatesCommand } from "@aws-sdk/client-ssm"; // ES Modules import + * // const { SSMClient, DescribeInstancePatchStatesCommand } = require("@aws-sdk/client-ssm"); // CommonJS import + * const client = new SSMClient(config); + * const command = new DescribeInstancePatchStatesCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeInstancePatchStatesCommandInput} for command's `input` shape. + * @see {@link DescribeInstancePatchStatesCommandOutput} for command's `response` shape. + * @see {@link SSMClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeInstancePatchStatesCommand extends $Command< DescribeInstancePatchStatesCommandInput, diff --git a/clients/client-ssm/commands/DescribeInstancePatchStatesForPatchGroupCommand.ts b/clients/client-ssm/commands/DescribeInstancePatchStatesForPatchGroupCommand.ts index 5d56b65ffea5..1f726dc50631 100644 --- a/clients/client-ssm/commands/DescribeInstancePatchStatesForPatchGroupCommand.ts +++ b/clients/client-ssm/commands/DescribeInstancePatchStatesForPatchGroupCommand.ts @@ -28,6 +28,20 @@ export interface DescribeInstancePatchStatesForPatchGroupCommandOutput /** *

Retrieves the high-level patch state for the instances in the specified patch group.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { SSMClient, DescribeInstancePatchStatesForPatchGroupCommand } from "@aws-sdk/client-ssm"; // ES Modules import + * // const { SSMClient, DescribeInstancePatchStatesForPatchGroupCommand } = require("@aws-sdk/client-ssm"); // CommonJS import + * const client = new SSMClient(config); + * const command = new DescribeInstancePatchStatesForPatchGroupCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeInstancePatchStatesForPatchGroupCommandInput} for command's `input` shape. + * @see {@link DescribeInstancePatchStatesForPatchGroupCommandOutput} for command's `response` shape. + * @see {@link SSMClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeInstancePatchStatesForPatchGroupCommand extends $Command< DescribeInstancePatchStatesForPatchGroupCommandInput, diff --git a/clients/client-ssm/commands/DescribeInstancePatchesCommand.ts b/clients/client-ssm/commands/DescribeInstancePatchesCommand.ts index d8180e9fcba0..fd8b3f013524 100644 --- a/clients/client-ssm/commands/DescribeInstancePatchesCommand.ts +++ b/clients/client-ssm/commands/DescribeInstancePatchesCommand.ts @@ -23,6 +23,20 @@ export interface DescribeInstancePatchesCommandOutput extends DescribeInstancePa /** *

Retrieves information about the patches on the specified instance and their state relative * to the patch baseline being used for the instance.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { SSMClient, DescribeInstancePatchesCommand } from "@aws-sdk/client-ssm"; // ES Modules import + * // const { SSMClient, DescribeInstancePatchesCommand } = require("@aws-sdk/client-ssm"); // CommonJS import + * const client = new SSMClient(config); + * const command = new DescribeInstancePatchesCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeInstancePatchesCommandInput} for command's `input` shape. + * @see {@link DescribeInstancePatchesCommandOutput} for command's `response` shape. + * @see {@link SSMClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeInstancePatchesCommand extends $Command< DescribeInstancePatchesCommandInput, diff --git a/clients/client-ssm/commands/DescribeInventoryDeletionsCommand.ts b/clients/client-ssm/commands/DescribeInventoryDeletionsCommand.ts index 92f88ec922af..e959692e8143 100644 --- a/clients/client-ssm/commands/DescribeInventoryDeletionsCommand.ts +++ b/clients/client-ssm/commands/DescribeInventoryDeletionsCommand.ts @@ -22,6 +22,20 @@ export interface DescribeInventoryDeletionsCommandOutput extends DescribeInvento /** *

Describes a specific delete inventory operation.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { SSMClient, DescribeInventoryDeletionsCommand } from "@aws-sdk/client-ssm"; // ES Modules import + * // const { SSMClient, DescribeInventoryDeletionsCommand } = require("@aws-sdk/client-ssm"); // CommonJS import + * const client = new SSMClient(config); + * const command = new DescribeInventoryDeletionsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeInventoryDeletionsCommandInput} for command's `input` shape. + * @see {@link DescribeInventoryDeletionsCommandOutput} for command's `response` shape. + * @see {@link SSMClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeInventoryDeletionsCommand extends $Command< DescribeInventoryDeletionsCommandInput, diff --git a/clients/client-ssm/commands/DescribeMaintenanceWindowExecutionTaskInvocationsCommand.ts b/clients/client-ssm/commands/DescribeMaintenanceWindowExecutionTaskInvocationsCommand.ts index 41e5e40e1d47..258241955bd9 100644 --- a/clients/client-ssm/commands/DescribeMaintenanceWindowExecutionTaskInvocationsCommand.ts +++ b/clients/client-ssm/commands/DescribeMaintenanceWindowExecutionTaskInvocationsCommand.ts @@ -29,6 +29,20 @@ export interface DescribeMaintenanceWindowExecutionTaskInvocationsCommandOutput /** *

Retrieves the individual task executions (one per target) for a particular task run as part * of a maintenance window execution.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { SSMClient, DescribeMaintenanceWindowExecutionTaskInvocationsCommand } from "@aws-sdk/client-ssm"; // ES Modules import + * // const { SSMClient, DescribeMaintenanceWindowExecutionTaskInvocationsCommand } = require("@aws-sdk/client-ssm"); // CommonJS import + * const client = new SSMClient(config); + * const command = new DescribeMaintenanceWindowExecutionTaskInvocationsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeMaintenanceWindowExecutionTaskInvocationsCommandInput} for command's `input` shape. + * @see {@link DescribeMaintenanceWindowExecutionTaskInvocationsCommandOutput} for command's `response` shape. + * @see {@link SSMClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeMaintenanceWindowExecutionTaskInvocationsCommand extends $Command< DescribeMaintenanceWindowExecutionTaskInvocationsCommandInput, diff --git a/clients/client-ssm/commands/DescribeMaintenanceWindowExecutionTasksCommand.ts b/clients/client-ssm/commands/DescribeMaintenanceWindowExecutionTasksCommand.ts index 6d6ab2cbf45e..871ceb306595 100644 --- a/clients/client-ssm/commands/DescribeMaintenanceWindowExecutionTasksCommand.ts +++ b/clients/client-ssm/commands/DescribeMaintenanceWindowExecutionTasksCommand.ts @@ -28,6 +28,20 @@ export interface DescribeMaintenanceWindowExecutionTasksCommandOutput /** *

For a given maintenance window execution, lists the tasks that were run.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { SSMClient, DescribeMaintenanceWindowExecutionTasksCommand } from "@aws-sdk/client-ssm"; // ES Modules import + * // const { SSMClient, DescribeMaintenanceWindowExecutionTasksCommand } = require("@aws-sdk/client-ssm"); // CommonJS import + * const client = new SSMClient(config); + * const command = new DescribeMaintenanceWindowExecutionTasksCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeMaintenanceWindowExecutionTasksCommandInput} for command's `input` shape. + * @see {@link DescribeMaintenanceWindowExecutionTasksCommandOutput} for command's `response` shape. + * @see {@link SSMClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeMaintenanceWindowExecutionTasksCommand extends $Command< DescribeMaintenanceWindowExecutionTasksCommandInput, diff --git a/clients/client-ssm/commands/DescribeMaintenanceWindowExecutionsCommand.ts b/clients/client-ssm/commands/DescribeMaintenanceWindowExecutionsCommand.ts index e3b6e0a05390..a6dddc28c332 100644 --- a/clients/client-ssm/commands/DescribeMaintenanceWindowExecutionsCommand.ts +++ b/clients/client-ssm/commands/DescribeMaintenanceWindowExecutionsCommand.ts @@ -29,6 +29,20 @@ export interface DescribeMaintenanceWindowExecutionsCommandOutput *

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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { SSMClient, DescribeMaintenanceWindowExecutionsCommand } from "@aws-sdk/client-ssm"; // ES Modules import + * // const { SSMClient, DescribeMaintenanceWindowExecutionsCommand } = require("@aws-sdk/client-ssm"); // CommonJS import + * const client = new SSMClient(config); + * const command = new DescribeMaintenanceWindowExecutionsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeMaintenanceWindowExecutionsCommandInput} for command's `input` shape. + * @see {@link DescribeMaintenanceWindowExecutionsCommandOutput} for command's `response` shape. + * @see {@link SSMClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeMaintenanceWindowExecutionsCommand extends $Command< DescribeMaintenanceWindowExecutionsCommandInput, diff --git a/clients/client-ssm/commands/DescribeMaintenanceWindowScheduleCommand.ts b/clients/client-ssm/commands/DescribeMaintenanceWindowScheduleCommand.ts index 989af874239a..a1668e43eb5f 100644 --- a/clients/client-ssm/commands/DescribeMaintenanceWindowScheduleCommand.ts +++ b/clients/client-ssm/commands/DescribeMaintenanceWindowScheduleCommand.ts @@ -24,6 +24,20 @@ export interface DescribeMaintenanceWindowScheduleCommandOutput /** *

Retrieves information about upcoming executions of a maintenance window.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { SSMClient, DescribeMaintenanceWindowScheduleCommand } from "@aws-sdk/client-ssm"; // ES Modules import + * // const { SSMClient, DescribeMaintenanceWindowScheduleCommand } = require("@aws-sdk/client-ssm"); // CommonJS import + * const client = new SSMClient(config); + * const command = new DescribeMaintenanceWindowScheduleCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeMaintenanceWindowScheduleCommandInput} for command's `input` shape. + * @see {@link DescribeMaintenanceWindowScheduleCommandOutput} for command's `response` shape. + * @see {@link SSMClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeMaintenanceWindowScheduleCommand extends $Command< DescribeMaintenanceWindowScheduleCommandInput, diff --git a/clients/client-ssm/commands/DescribeMaintenanceWindowTargetsCommand.ts b/clients/client-ssm/commands/DescribeMaintenanceWindowTargetsCommand.ts index 3eb7ec9ab620..6ad85030ae85 100644 --- a/clients/client-ssm/commands/DescribeMaintenanceWindowTargetsCommand.ts +++ b/clients/client-ssm/commands/DescribeMaintenanceWindowTargetsCommand.ts @@ -24,6 +24,20 @@ export interface DescribeMaintenanceWindowTargetsCommandOutput /** *

Lists the targets registered with the maintenance window.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { SSMClient, DescribeMaintenanceWindowTargetsCommand } from "@aws-sdk/client-ssm"; // ES Modules import + * // const { SSMClient, DescribeMaintenanceWindowTargetsCommand } = require("@aws-sdk/client-ssm"); // CommonJS import + * const client = new SSMClient(config); + * const command = new DescribeMaintenanceWindowTargetsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeMaintenanceWindowTargetsCommandInput} for command's `input` shape. + * @see {@link DescribeMaintenanceWindowTargetsCommandOutput} for command's `response` shape. + * @see {@link SSMClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeMaintenanceWindowTargetsCommand extends $Command< DescribeMaintenanceWindowTargetsCommandInput, diff --git a/clients/client-ssm/commands/DescribeMaintenanceWindowTasksCommand.ts b/clients/client-ssm/commands/DescribeMaintenanceWindowTasksCommand.ts index 2f8133b95311..1f23817e5e76 100644 --- a/clients/client-ssm/commands/DescribeMaintenanceWindowTasksCommand.ts +++ b/clients/client-ssm/commands/DescribeMaintenanceWindowTasksCommand.ts @@ -30,6 +30,20 @@ export interface DescribeMaintenanceWindowTasksCommandOutput * placeholder value of 1, which may be reported in the response to this command. * These values do not affect the running of your task and can be ignored.

* + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { SSMClient, DescribeMaintenanceWindowTasksCommand } from "@aws-sdk/client-ssm"; // ES Modules import + * // const { SSMClient, DescribeMaintenanceWindowTasksCommand } = require("@aws-sdk/client-ssm"); // CommonJS import + * const client = new SSMClient(config); + * const command = new DescribeMaintenanceWindowTasksCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeMaintenanceWindowTasksCommandInput} for command's `input` shape. + * @see {@link DescribeMaintenanceWindowTasksCommandOutput} for command's `response` shape. + * @see {@link SSMClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeMaintenanceWindowTasksCommand extends $Command< DescribeMaintenanceWindowTasksCommandInput, diff --git a/clients/client-ssm/commands/DescribeMaintenanceWindowsCommand.ts b/clients/client-ssm/commands/DescribeMaintenanceWindowsCommand.ts index ab329595ffd0..f3cf3c06a608 100644 --- a/clients/client-ssm/commands/DescribeMaintenanceWindowsCommand.ts +++ b/clients/client-ssm/commands/DescribeMaintenanceWindowsCommand.ts @@ -22,6 +22,20 @@ export interface DescribeMaintenanceWindowsCommandOutput extends DescribeMainten /** *

Retrieves the maintenance windows in an AWS account.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { SSMClient, DescribeMaintenanceWindowsCommand } from "@aws-sdk/client-ssm"; // ES Modules import + * // const { SSMClient, DescribeMaintenanceWindowsCommand } = require("@aws-sdk/client-ssm"); // CommonJS import + * const client = new SSMClient(config); + * const command = new DescribeMaintenanceWindowsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeMaintenanceWindowsCommandInput} for command's `input` shape. + * @see {@link DescribeMaintenanceWindowsCommandOutput} for command's `response` shape. + * @see {@link SSMClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeMaintenanceWindowsCommand extends $Command< DescribeMaintenanceWindowsCommandInput, diff --git a/clients/client-ssm/commands/DescribeMaintenanceWindowsForTargetCommand.ts b/clients/client-ssm/commands/DescribeMaintenanceWindowsForTargetCommand.ts index 73c3d93f3f63..1a14178f7fcb 100644 --- a/clients/client-ssm/commands/DescribeMaintenanceWindowsForTargetCommand.ts +++ b/clients/client-ssm/commands/DescribeMaintenanceWindowsForTargetCommand.ts @@ -28,6 +28,20 @@ export interface DescribeMaintenanceWindowsForTargetCommandOutput /** *

Retrieves information about the maintenance window targets or tasks that an instance is * associated with.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { SSMClient, DescribeMaintenanceWindowsForTargetCommand } from "@aws-sdk/client-ssm"; // ES Modules import + * // const { SSMClient, DescribeMaintenanceWindowsForTargetCommand } = require("@aws-sdk/client-ssm"); // CommonJS import + * const client = new SSMClient(config); + * const command = new DescribeMaintenanceWindowsForTargetCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeMaintenanceWindowsForTargetCommandInput} for command's `input` shape. + * @see {@link DescribeMaintenanceWindowsForTargetCommandOutput} for command's `response` shape. + * @see {@link SSMClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeMaintenanceWindowsForTargetCommand extends $Command< DescribeMaintenanceWindowsForTargetCommandInput, diff --git a/clients/client-ssm/commands/DescribeOpsItemsCommand.ts b/clients/client-ssm/commands/DescribeOpsItemsCommand.ts index 7dc38a19b6de..167413e1e1be 100644 --- a/clients/client-ssm/commands/DescribeOpsItemsCommand.ts +++ b/clients/client-ssm/commands/DescribeOpsItemsCommand.ts @@ -28,6 +28,20 @@ export interface DescribeOpsItemsCommandOutput extends DescribeOpsItemsResponse, * operational issues impacting the performance and health of their AWS resources. For more * information, see AWS Systems Manager OpsCenter in the * AWS Systems Manager User Guide.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { SSMClient, DescribeOpsItemsCommand } from "@aws-sdk/client-ssm"; // ES Modules import + * // const { SSMClient, DescribeOpsItemsCommand } = require("@aws-sdk/client-ssm"); // CommonJS import + * const client = new SSMClient(config); + * const command = new DescribeOpsItemsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeOpsItemsCommandInput} for command's `input` shape. + * @see {@link DescribeOpsItemsCommandOutput} for command's `response` shape. + * @see {@link SSMClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeOpsItemsCommand extends $Command< DescribeOpsItemsCommandInput, diff --git a/clients/client-ssm/commands/DescribeParametersCommand.ts b/clients/client-ssm/commands/DescribeParametersCommand.ts index f5d81e5ea24e..95eacccc46db 100644 --- a/clients/client-ssm/commands/DescribeParametersCommand.ts +++ b/clients/client-ssm/commands/DescribeParametersCommand.ts @@ -30,6 +30,20 @@ export interface DescribeParametersCommandOutput extends DescribeParametersResul * 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.

* + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { SSMClient, DescribeParametersCommand } from "@aws-sdk/client-ssm"; // ES Modules import + * // const { SSMClient, DescribeParametersCommand } = require("@aws-sdk/client-ssm"); // CommonJS import + * const client = new SSMClient(config); + * const command = new DescribeParametersCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeParametersCommandInput} for command's `input` shape. + * @see {@link DescribeParametersCommandOutput} for command's `response` shape. + * @see {@link SSMClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeParametersCommand extends $Command< DescribeParametersCommandInput, diff --git a/clients/client-ssm/commands/DescribePatchBaselinesCommand.ts b/clients/client-ssm/commands/DescribePatchBaselinesCommand.ts index 3e86ed2d58ca..d287ceaf96a9 100644 --- a/clients/client-ssm/commands/DescribePatchBaselinesCommand.ts +++ b/clients/client-ssm/commands/DescribePatchBaselinesCommand.ts @@ -22,6 +22,20 @@ export interface DescribePatchBaselinesCommandOutput extends DescribePatchBaseli /** *

Lists the patch baselines in your AWS account.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { SSMClient, DescribePatchBaselinesCommand } from "@aws-sdk/client-ssm"; // ES Modules import + * // const { SSMClient, DescribePatchBaselinesCommand } = require("@aws-sdk/client-ssm"); // CommonJS import + * const client = new SSMClient(config); + * const command = new DescribePatchBaselinesCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribePatchBaselinesCommandInput} for command's `input` shape. + * @see {@link DescribePatchBaselinesCommandOutput} for command's `response` shape. + * @see {@link SSMClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribePatchBaselinesCommand extends $Command< DescribePatchBaselinesCommandInput, diff --git a/clients/client-ssm/commands/DescribePatchGroupStateCommand.ts b/clients/client-ssm/commands/DescribePatchGroupStateCommand.ts index d1cff3842ed3..2ff8bf18fc81 100644 --- a/clients/client-ssm/commands/DescribePatchGroupStateCommand.ts +++ b/clients/client-ssm/commands/DescribePatchGroupStateCommand.ts @@ -22,6 +22,20 @@ export interface DescribePatchGroupStateCommandOutput extends DescribePatchGroup /** *

Returns high-level aggregated patch compliance state for a patch group.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { SSMClient, DescribePatchGroupStateCommand } from "@aws-sdk/client-ssm"; // ES Modules import + * // const { SSMClient, DescribePatchGroupStateCommand } = require("@aws-sdk/client-ssm"); // CommonJS import + * const client = new SSMClient(config); + * const command = new DescribePatchGroupStateCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribePatchGroupStateCommandInput} for command's `input` shape. + * @see {@link DescribePatchGroupStateCommandOutput} for command's `response` shape. + * @see {@link SSMClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribePatchGroupStateCommand extends $Command< DescribePatchGroupStateCommandInput, diff --git a/clients/client-ssm/commands/DescribePatchGroupsCommand.ts b/clients/client-ssm/commands/DescribePatchGroupsCommand.ts index 7f3f99e0254b..fb141a8c29a3 100644 --- a/clients/client-ssm/commands/DescribePatchGroupsCommand.ts +++ b/clients/client-ssm/commands/DescribePatchGroupsCommand.ts @@ -22,6 +22,20 @@ export interface DescribePatchGroupsCommandOutput extends DescribePatchGroupsRes /** *

Lists all patch groups that have been registered with patch baselines.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { SSMClient, DescribePatchGroupsCommand } from "@aws-sdk/client-ssm"; // ES Modules import + * // const { SSMClient, DescribePatchGroupsCommand } = require("@aws-sdk/client-ssm"); // CommonJS import + * const client = new SSMClient(config); + * const command = new DescribePatchGroupsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribePatchGroupsCommandInput} for command's `input` shape. + * @see {@link DescribePatchGroupsCommandOutput} for command's `response` shape. + * @see {@link SSMClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribePatchGroupsCommand extends $Command< DescribePatchGroupsCommandInput, diff --git a/clients/client-ssm/commands/DescribePatchPropertiesCommand.ts b/clients/client-ssm/commands/DescribePatchPropertiesCommand.ts index de66f17a7d64..aabe3f946a8c 100644 --- a/clients/client-ssm/commands/DescribePatchPropertiesCommand.ts +++ b/clients/client-ssm/commands/DescribePatchPropertiesCommand.ts @@ -68,6 +68,20 @@ export interface DescribePatchPropertiesCommandOutput extends DescribePatchPrope *

Valid properties: PRODUCT, PRODUCT_FAMILY, CLASSIFICATION, MSRC_SEVERITY

* * + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { SSMClient, DescribePatchPropertiesCommand } from "@aws-sdk/client-ssm"; // ES Modules import + * // const { SSMClient, DescribePatchPropertiesCommand } = require("@aws-sdk/client-ssm"); // CommonJS import + * const client = new SSMClient(config); + * const command = new DescribePatchPropertiesCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribePatchPropertiesCommandInput} for command's `input` shape. + * @see {@link DescribePatchPropertiesCommandOutput} for command's `response` shape. + * @see {@link SSMClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribePatchPropertiesCommand extends $Command< DescribePatchPropertiesCommandInput, diff --git a/clients/client-ssm/commands/DescribeSessionsCommand.ts b/clients/client-ssm/commands/DescribeSessionsCommand.ts index 1e8f8cc40440..9dc07821c56c 100644 --- a/clients/client-ssm/commands/DescribeSessionsCommand.ts +++ b/clients/client-ssm/commands/DescribeSessionsCommand.ts @@ -23,6 +23,20 @@ export interface DescribeSessionsCommandOutput extends DescribeSessionsResponse, /** *

Retrieves a list of all active sessions (both connected and disconnected) or terminated * sessions from the past 30 days.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { SSMClient, DescribeSessionsCommand } from "@aws-sdk/client-ssm"; // ES Modules import + * // const { SSMClient, DescribeSessionsCommand } = require("@aws-sdk/client-ssm"); // CommonJS import + * const client = new SSMClient(config); + * const command = new DescribeSessionsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeSessionsCommandInput} for command's `input` shape. + * @see {@link DescribeSessionsCommandOutput} for command's `response` shape. + * @see {@link SSMClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeSessionsCommand extends $Command< DescribeSessionsCommandInput, diff --git a/clients/client-ssm/commands/GetAutomationExecutionCommand.ts b/clients/client-ssm/commands/GetAutomationExecutionCommand.ts index 7821a9cb4e27..0a8fb87b52a3 100644 --- a/clients/client-ssm/commands/GetAutomationExecutionCommand.ts +++ b/clients/client-ssm/commands/GetAutomationExecutionCommand.ts @@ -22,6 +22,20 @@ export interface GetAutomationExecutionCommandOutput extends GetAutomationExecut /** *

Get detailed information about a particular Automation execution.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { SSMClient, GetAutomationExecutionCommand } from "@aws-sdk/client-ssm"; // ES Modules import + * // const { SSMClient, GetAutomationExecutionCommand } = require("@aws-sdk/client-ssm"); // CommonJS import + * const client = new SSMClient(config); + * const command = new GetAutomationExecutionCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetAutomationExecutionCommandInput} for command's `input` shape. + * @see {@link GetAutomationExecutionCommandOutput} for command's `response` shape. + * @see {@link SSMClientResolvedConfig | config} for command's `input` shape. + * */ export class GetAutomationExecutionCommand extends $Command< GetAutomationExecutionCommandInput, diff --git a/clients/client-ssm/commands/GetCalendarStateCommand.ts b/clients/client-ssm/commands/GetCalendarStateCommand.ts index 95013b8e192a..c25aa5a5f75f 100644 --- a/clients/client-ssm/commands/GetCalendarStateCommand.ts +++ b/clients/client-ssm/commands/GetCalendarStateCommand.ts @@ -31,6 +31,20 @@ export interface GetCalendarStateCommandOutput extends GetCalendarStateResponse, * request are closed, the status returned is CLOSED.

*

For more information about Systems Manager Change Calendar, see AWS Systems Manager Change * Calendar in the AWS Systems Manager User Guide.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { SSMClient, GetCalendarStateCommand } from "@aws-sdk/client-ssm"; // ES Modules import + * // const { SSMClient, GetCalendarStateCommand } = require("@aws-sdk/client-ssm"); // CommonJS import + * const client = new SSMClient(config); + * const command = new GetCalendarStateCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetCalendarStateCommandInput} for command's `input` shape. + * @see {@link GetCalendarStateCommandOutput} for command's `response` shape. + * @see {@link SSMClientResolvedConfig | config} for command's `input` shape. + * */ export class GetCalendarStateCommand extends $Command< GetCalendarStateCommandInput, diff --git a/clients/client-ssm/commands/GetCommandInvocationCommand.ts b/clients/client-ssm/commands/GetCommandInvocationCommand.ts index a746558fba75..18b1c60effaa 100644 --- a/clients/client-ssm/commands/GetCommandInvocationCommand.ts +++ b/clients/client-ssm/commands/GetCommandInvocationCommand.ts @@ -26,6 +26,20 @@ export interface GetCommandInvocationCommandOutput extends GetCommandInvocationR * GetCommandInvocation only gives the execution status of a plugin in a document. * To get the command execution status on a specific instance, use ListCommandInvocations. To get the command execution status across instances, use * ListCommands.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { SSMClient, GetCommandInvocationCommand } from "@aws-sdk/client-ssm"; // ES Modules import + * // const { SSMClient, GetCommandInvocationCommand } = require("@aws-sdk/client-ssm"); // CommonJS import + * const client = new SSMClient(config); + * const command = new GetCommandInvocationCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetCommandInvocationCommandInput} for command's `input` shape. + * @see {@link GetCommandInvocationCommandOutput} for command's `response` shape. + * @see {@link SSMClientResolvedConfig | config} for command's `input` shape. + * */ export class GetCommandInvocationCommand extends $Command< GetCommandInvocationCommandInput, diff --git a/clients/client-ssm/commands/GetConnectionStatusCommand.ts b/clients/client-ssm/commands/GetConnectionStatusCommand.ts index 8e1ec674e60c..4abdf7668e95 100644 --- a/clients/client-ssm/commands/GetConnectionStatusCommand.ts +++ b/clients/client-ssm/commands/GetConnectionStatusCommand.ts @@ -23,6 +23,20 @@ export interface GetConnectionStatusCommandOutput extends GetConnectionStatusRes /** *

Retrieves the Session Manager connection status for an instance to determine whether it is running and * ready to receive Session Manager connections.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { SSMClient, GetConnectionStatusCommand } from "@aws-sdk/client-ssm"; // ES Modules import + * // const { SSMClient, GetConnectionStatusCommand } = require("@aws-sdk/client-ssm"); // CommonJS import + * const client = new SSMClient(config); + * const command = new GetConnectionStatusCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetConnectionStatusCommandInput} for command's `input` shape. + * @see {@link GetConnectionStatusCommandOutput} for command's `response` shape. + * @see {@link SSMClientResolvedConfig | config} for command's `input` shape. + * */ export class GetConnectionStatusCommand extends $Command< GetConnectionStatusCommandInput, diff --git a/clients/client-ssm/commands/GetDefaultPatchBaselineCommand.ts b/clients/client-ssm/commands/GetDefaultPatchBaselineCommand.ts index 52695c318ecd..5ceff7d40cfa 100644 --- a/clients/client-ssm/commands/GetDefaultPatchBaselineCommand.ts +++ b/clients/client-ssm/commands/GetDefaultPatchBaselineCommand.ts @@ -26,6 +26,20 @@ export interface GetDefaultPatchBaselineCommandOutput extends GetDefaultPatchBas * system.

*

If you do not specify an operating system value, the default patch baseline for Windows is * returned.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { SSMClient, GetDefaultPatchBaselineCommand } from "@aws-sdk/client-ssm"; // ES Modules import + * // const { SSMClient, GetDefaultPatchBaselineCommand } = require("@aws-sdk/client-ssm"); // CommonJS import + * const client = new SSMClient(config); + * const command = new GetDefaultPatchBaselineCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetDefaultPatchBaselineCommandInput} for command's `input` shape. + * @see {@link GetDefaultPatchBaselineCommandOutput} for command's `response` shape. + * @see {@link SSMClientResolvedConfig | config} for command's `input` shape. + * */ export class GetDefaultPatchBaselineCommand extends $Command< GetDefaultPatchBaselineCommandInput, diff --git a/clients/client-ssm/commands/GetDeployablePatchSnapshotForInstanceCommand.ts b/clients/client-ssm/commands/GetDeployablePatchSnapshotForInstanceCommand.ts index 82e6207b8c62..539c70f83f4c 100644 --- a/clients/client-ssm/commands/GetDeployablePatchSnapshotForInstanceCommand.ts +++ b/clients/client-ssm/commands/GetDeployablePatchSnapshotForInstanceCommand.ts @@ -29,6 +29,20 @@ export interface GetDeployablePatchSnapshotForInstanceCommandOutput /** *

Retrieves the current snapshot for the patch baseline the instance uses. This API is * primarily used by the AWS-RunPatchBaseline Systems Manager document.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { SSMClient, GetDeployablePatchSnapshotForInstanceCommand } from "@aws-sdk/client-ssm"; // ES Modules import + * // const { SSMClient, GetDeployablePatchSnapshotForInstanceCommand } = require("@aws-sdk/client-ssm"); // CommonJS import + * const client = new SSMClient(config); + * const command = new GetDeployablePatchSnapshotForInstanceCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetDeployablePatchSnapshotForInstanceCommandInput} for command's `input` shape. + * @see {@link GetDeployablePatchSnapshotForInstanceCommandOutput} for command's `response` shape. + * @see {@link SSMClientResolvedConfig | config} for command's `input` shape. + * */ export class GetDeployablePatchSnapshotForInstanceCommand extends $Command< GetDeployablePatchSnapshotForInstanceCommandInput, diff --git a/clients/client-ssm/commands/GetDocumentCommand.ts b/clients/client-ssm/commands/GetDocumentCommand.ts index b1e4c51a69b9..c420fea3ac5a 100644 --- a/clients/client-ssm/commands/GetDocumentCommand.ts +++ b/clients/client-ssm/commands/GetDocumentCommand.ts @@ -22,6 +22,20 @@ export interface GetDocumentCommandOutput extends GetDocumentResult, __MetadataB /** *

Gets the contents of the specified Systems Manager document.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { SSMClient, GetDocumentCommand } from "@aws-sdk/client-ssm"; // ES Modules import + * // const { SSMClient, GetDocumentCommand } = require("@aws-sdk/client-ssm"); // CommonJS import + * const client = new SSMClient(config); + * const command = new GetDocumentCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetDocumentCommandInput} for command's `input` shape. + * @see {@link GetDocumentCommandOutput} for command's `response` shape. + * @see {@link SSMClientResolvedConfig | config} for command's `input` shape. + * */ export class GetDocumentCommand extends $Command< GetDocumentCommandInput, diff --git a/clients/client-ssm/commands/GetInventoryCommand.ts b/clients/client-ssm/commands/GetInventoryCommand.ts index eef8d2e5ec4c..a3332a27ac5d 100644 --- a/clients/client-ssm/commands/GetInventoryCommand.ts +++ b/clients/client-ssm/commands/GetInventoryCommand.ts @@ -23,6 +23,20 @@ export interface GetInventoryCommandOutput extends GetInventoryResult, __Metadat /** *

Query inventory information.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { SSMClient, GetInventoryCommand } from "@aws-sdk/client-ssm"; // ES Modules import + * // const { SSMClient, GetInventoryCommand } = require("@aws-sdk/client-ssm"); // CommonJS import + * const client = new SSMClient(config); + * const command = new GetInventoryCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetInventoryCommandInput} for command's `input` shape. + * @see {@link GetInventoryCommandOutput} for command's `response` shape. + * @see {@link SSMClientResolvedConfig | config} for command's `input` shape. + * */ export class GetInventoryCommand extends $Command< GetInventoryCommandInput, diff --git a/clients/client-ssm/commands/GetInventorySchemaCommand.ts b/clients/client-ssm/commands/GetInventorySchemaCommand.ts index c400818a3042..f5f75414c2e1 100644 --- a/clients/client-ssm/commands/GetInventorySchemaCommand.ts +++ b/clients/client-ssm/commands/GetInventorySchemaCommand.ts @@ -23,6 +23,20 @@ export interface GetInventorySchemaCommandOutput extends GetInventorySchemaResul /** *

Return a list of inventory type names for the account, or return a list of attribute names * for a specific Inventory item type.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { SSMClient, GetInventorySchemaCommand } from "@aws-sdk/client-ssm"; // ES Modules import + * // const { SSMClient, GetInventorySchemaCommand } = require("@aws-sdk/client-ssm"); // CommonJS import + * const client = new SSMClient(config); + * const command = new GetInventorySchemaCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetInventorySchemaCommandInput} for command's `input` shape. + * @see {@link GetInventorySchemaCommandOutput} for command's `response` shape. + * @see {@link SSMClientResolvedConfig | config} for command's `input` shape. + * */ export class GetInventorySchemaCommand extends $Command< GetInventorySchemaCommandInput, diff --git a/clients/client-ssm/commands/GetMaintenanceWindowCommand.ts b/clients/client-ssm/commands/GetMaintenanceWindowCommand.ts index 14585e0a7a37..3081f83e5f8b 100644 --- a/clients/client-ssm/commands/GetMaintenanceWindowCommand.ts +++ b/clients/client-ssm/commands/GetMaintenanceWindowCommand.ts @@ -22,6 +22,20 @@ export interface GetMaintenanceWindowCommandOutput extends GetMaintenanceWindowR /** *

Retrieves a maintenance window.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { SSMClient, GetMaintenanceWindowCommand } from "@aws-sdk/client-ssm"; // ES Modules import + * // const { SSMClient, GetMaintenanceWindowCommand } = require("@aws-sdk/client-ssm"); // CommonJS import + * const client = new SSMClient(config); + * const command = new GetMaintenanceWindowCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetMaintenanceWindowCommandInput} for command's `input` shape. + * @see {@link GetMaintenanceWindowCommandOutput} for command's `response` shape. + * @see {@link SSMClientResolvedConfig | config} for command's `input` shape. + * */ export class GetMaintenanceWindowCommand extends $Command< GetMaintenanceWindowCommandInput, diff --git a/clients/client-ssm/commands/GetMaintenanceWindowExecutionCommand.ts b/clients/client-ssm/commands/GetMaintenanceWindowExecutionCommand.ts index 4dbea28101c8..4ff7b91568ee 100644 --- a/clients/client-ssm/commands/GetMaintenanceWindowExecutionCommand.ts +++ b/clients/client-ssm/commands/GetMaintenanceWindowExecutionCommand.ts @@ -24,6 +24,20 @@ export interface GetMaintenanceWindowExecutionCommandOutput /** *

Retrieves details about a specific a maintenance window execution.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { SSMClient, GetMaintenanceWindowExecutionCommand } from "@aws-sdk/client-ssm"; // ES Modules import + * // const { SSMClient, GetMaintenanceWindowExecutionCommand } = require("@aws-sdk/client-ssm"); // CommonJS import + * const client = new SSMClient(config); + * const command = new GetMaintenanceWindowExecutionCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetMaintenanceWindowExecutionCommandInput} for command's `input` shape. + * @see {@link GetMaintenanceWindowExecutionCommandOutput} for command's `response` shape. + * @see {@link SSMClientResolvedConfig | config} for command's `input` shape. + * */ export class GetMaintenanceWindowExecutionCommand extends $Command< GetMaintenanceWindowExecutionCommandInput, diff --git a/clients/client-ssm/commands/GetMaintenanceWindowExecutionTaskCommand.ts b/clients/client-ssm/commands/GetMaintenanceWindowExecutionTaskCommand.ts index 47260e0e0260..a3dee1ca772a 100644 --- a/clients/client-ssm/commands/GetMaintenanceWindowExecutionTaskCommand.ts +++ b/clients/client-ssm/commands/GetMaintenanceWindowExecutionTaskCommand.ts @@ -25,6 +25,20 @@ export interface GetMaintenanceWindowExecutionTaskCommandOutput /** *

Retrieves the details about a specific task run as part of a maintenance window * execution.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { SSMClient, GetMaintenanceWindowExecutionTaskCommand } from "@aws-sdk/client-ssm"; // ES Modules import + * // const { SSMClient, GetMaintenanceWindowExecutionTaskCommand } = require("@aws-sdk/client-ssm"); // CommonJS import + * const client = new SSMClient(config); + * const command = new GetMaintenanceWindowExecutionTaskCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetMaintenanceWindowExecutionTaskCommandInput} for command's `input` shape. + * @see {@link GetMaintenanceWindowExecutionTaskCommandOutput} for command's `response` shape. + * @see {@link SSMClientResolvedConfig | config} for command's `input` shape. + * */ export class GetMaintenanceWindowExecutionTaskCommand extends $Command< GetMaintenanceWindowExecutionTaskCommandInput, diff --git a/clients/client-ssm/commands/GetMaintenanceWindowExecutionTaskInvocationCommand.ts b/clients/client-ssm/commands/GetMaintenanceWindowExecutionTaskInvocationCommand.ts index 6038beef787a..36815b0c15c5 100644 --- a/clients/client-ssm/commands/GetMaintenanceWindowExecutionTaskInvocationCommand.ts +++ b/clients/client-ssm/commands/GetMaintenanceWindowExecutionTaskInvocationCommand.ts @@ -28,6 +28,20 @@ export interface GetMaintenanceWindowExecutionTaskInvocationCommandOutput /** *

Retrieves information about a specific task running on a specific target.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { SSMClient, GetMaintenanceWindowExecutionTaskInvocationCommand } from "@aws-sdk/client-ssm"; // ES Modules import + * // const { SSMClient, GetMaintenanceWindowExecutionTaskInvocationCommand } = require("@aws-sdk/client-ssm"); // CommonJS import + * const client = new SSMClient(config); + * const command = new GetMaintenanceWindowExecutionTaskInvocationCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetMaintenanceWindowExecutionTaskInvocationCommandInput} for command's `input` shape. + * @see {@link GetMaintenanceWindowExecutionTaskInvocationCommandOutput} for command's `response` shape. + * @see {@link SSMClientResolvedConfig | config} for command's `input` shape. + * */ export class GetMaintenanceWindowExecutionTaskInvocationCommand extends $Command< GetMaintenanceWindowExecutionTaskInvocationCommandInput, diff --git a/clients/client-ssm/commands/GetMaintenanceWindowTaskCommand.ts b/clients/client-ssm/commands/GetMaintenanceWindowTaskCommand.ts index aac4b04428c6..bff81cd9a72d 100644 --- a/clients/client-ssm/commands/GetMaintenanceWindowTaskCommand.ts +++ b/clients/client-ssm/commands/GetMaintenanceWindowTaskCommand.ts @@ -28,6 +28,20 @@ export interface GetMaintenanceWindowTaskCommandOutput extends GetMaintenanceWin * placeholder value of 1, which may be reported in the response to this command. * These values do not affect the running of your task and can be ignored.

* + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { SSMClient, GetMaintenanceWindowTaskCommand } from "@aws-sdk/client-ssm"; // ES Modules import + * // const { SSMClient, GetMaintenanceWindowTaskCommand } = require("@aws-sdk/client-ssm"); // CommonJS import + * const client = new SSMClient(config); + * const command = new GetMaintenanceWindowTaskCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetMaintenanceWindowTaskCommandInput} for command's `input` shape. + * @see {@link GetMaintenanceWindowTaskCommandOutput} for command's `response` shape. + * @see {@link SSMClientResolvedConfig | config} for command's `input` shape. + * */ export class GetMaintenanceWindowTaskCommand extends $Command< GetMaintenanceWindowTaskCommandInput, diff --git a/clients/client-ssm/commands/GetOpsItemCommand.ts b/clients/client-ssm/commands/GetOpsItemCommand.ts index 73da80229fcf..a062e61146cd 100644 --- a/clients/client-ssm/commands/GetOpsItemCommand.ts +++ b/clients/client-ssm/commands/GetOpsItemCommand.ts @@ -29,6 +29,20 @@ export interface GetOpsItemCommandOutput extends GetOpsItemResponse, __MetadataB * operational issues impacting the performance and health of their AWS resources. For more * information, see AWS Systems Manager OpsCenter in the * AWS Systems Manager User Guide.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { SSMClient, GetOpsItemCommand } from "@aws-sdk/client-ssm"; // ES Modules import + * // const { SSMClient, GetOpsItemCommand } = require("@aws-sdk/client-ssm"); // CommonJS import + * const client = new SSMClient(config); + * const command = new GetOpsItemCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetOpsItemCommandInput} for command's `input` shape. + * @see {@link GetOpsItemCommandOutput} for command's `response` shape. + * @see {@link SSMClientResolvedConfig | config} for command's `input` shape. + * */ export class GetOpsItemCommand extends $Command< GetOpsItemCommandInput, diff --git a/clients/client-ssm/commands/GetOpsMetadataCommand.ts b/clients/client-ssm/commands/GetOpsMetadataCommand.ts index c382b58f576b..97ea8e55adba 100644 --- a/clients/client-ssm/commands/GetOpsMetadataCommand.ts +++ b/clients/client-ssm/commands/GetOpsMetadataCommand.ts @@ -22,6 +22,20 @@ export interface GetOpsMetadataCommandOutput extends GetOpsMetadataResult, __Met /** *

View operational metadata related to an application in Application Manager.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { SSMClient, GetOpsMetadataCommand } from "@aws-sdk/client-ssm"; // ES Modules import + * // const { SSMClient, GetOpsMetadataCommand } = require("@aws-sdk/client-ssm"); // CommonJS import + * const client = new SSMClient(config); + * const command = new GetOpsMetadataCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetOpsMetadataCommandInput} for command's `input` shape. + * @see {@link GetOpsMetadataCommandOutput} for command's `response` shape. + * @see {@link SSMClientResolvedConfig | config} for command's `input` shape. + * */ export class GetOpsMetadataCommand extends $Command< GetOpsMetadataCommandInput, diff --git a/clients/client-ssm/commands/GetOpsSummaryCommand.ts b/clients/client-ssm/commands/GetOpsSummaryCommand.ts index c81b6300fc70..ea1858d8a4d2 100644 --- a/clients/client-ssm/commands/GetOpsSummaryCommand.ts +++ b/clients/client-ssm/commands/GetOpsSummaryCommand.ts @@ -23,6 +23,20 @@ export interface GetOpsSummaryCommandOutput extends GetOpsSummaryResult, __Metad /** *

View a summary of OpsItems based on specified filters and aggregators.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { SSMClient, GetOpsSummaryCommand } from "@aws-sdk/client-ssm"; // ES Modules import + * // const { SSMClient, GetOpsSummaryCommand } = require("@aws-sdk/client-ssm"); // CommonJS import + * const client = new SSMClient(config); + * const command = new GetOpsSummaryCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetOpsSummaryCommandInput} for command's `input` shape. + * @see {@link GetOpsSummaryCommandOutput} for command's `response` shape. + * @see {@link SSMClientResolvedConfig | config} for command's `input` shape. + * */ export class GetOpsSummaryCommand extends $Command< GetOpsSummaryCommandInput, diff --git a/clients/client-ssm/commands/GetParameterCommand.ts b/clients/client-ssm/commands/GetParameterCommand.ts index d833f25af7c7..17b93b31c691 100644 --- a/clients/client-ssm/commands/GetParameterCommand.ts +++ b/clients/client-ssm/commands/GetParameterCommand.ts @@ -23,6 +23,20 @@ export interface GetParameterCommandOutput extends GetParameterResult, __Metadat /** *

Get information about a parameter by using the parameter name. Don't confuse this API action * with the GetParameters API action.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { SSMClient, GetParameterCommand } from "@aws-sdk/client-ssm"; // ES Modules import + * // const { SSMClient, GetParameterCommand } = require("@aws-sdk/client-ssm"); // CommonJS import + * const client = new SSMClient(config); + * const command = new GetParameterCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetParameterCommandInput} for command's `input` shape. + * @see {@link GetParameterCommandOutput} for command's `response` shape. + * @see {@link SSMClientResolvedConfig | config} for command's `input` shape. + * */ export class GetParameterCommand extends $Command< GetParameterCommandInput, diff --git a/clients/client-ssm/commands/GetParameterHistoryCommand.ts b/clients/client-ssm/commands/GetParameterHistoryCommand.ts index 5e2a033a8573..01ffce243cdf 100644 --- a/clients/client-ssm/commands/GetParameterHistoryCommand.ts +++ b/clients/client-ssm/commands/GetParameterHistoryCommand.ts @@ -22,6 +22,20 @@ export interface GetParameterHistoryCommandOutput extends GetParameterHistoryRes /** *

Retrieves the history of all changes to a parameter.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { SSMClient, GetParameterHistoryCommand } from "@aws-sdk/client-ssm"; // ES Modules import + * // const { SSMClient, GetParameterHistoryCommand } = require("@aws-sdk/client-ssm"); // CommonJS import + * const client = new SSMClient(config); + * const command = new GetParameterHistoryCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetParameterHistoryCommandInput} for command's `input` shape. + * @see {@link GetParameterHistoryCommandOutput} for command's `response` shape. + * @see {@link SSMClientResolvedConfig | config} for command's `input` shape. + * */ export class GetParameterHistoryCommand extends $Command< GetParameterHistoryCommandInput, diff --git a/clients/client-ssm/commands/GetParametersByPathCommand.ts b/clients/client-ssm/commands/GetParametersByPathCommand.ts index 2f650b68e018..a36235bb5e56 100644 --- a/clients/client-ssm/commands/GetParametersByPathCommand.ts +++ b/clients/client-ssm/commands/GetParametersByPathCommand.ts @@ -30,6 +30,20 @@ export interface GetParametersByPathCommandOutput extends GetParametersByPathRes * 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.

* + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { SSMClient, GetParametersByPathCommand } from "@aws-sdk/client-ssm"; // ES Modules import + * // const { SSMClient, GetParametersByPathCommand } = require("@aws-sdk/client-ssm"); // CommonJS import + * const client = new SSMClient(config); + * const command = new GetParametersByPathCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetParametersByPathCommandInput} for command's `input` shape. + * @see {@link GetParametersByPathCommandOutput} for command's `response` shape. + * @see {@link SSMClientResolvedConfig | config} for command's `input` shape. + * */ export class GetParametersByPathCommand extends $Command< GetParametersByPathCommandInput, diff --git a/clients/client-ssm/commands/GetParametersCommand.ts b/clients/client-ssm/commands/GetParametersCommand.ts index 420c88777cd0..9ecd843bd17d 100644 --- a/clients/client-ssm/commands/GetParametersCommand.ts +++ b/clients/client-ssm/commands/GetParametersCommand.ts @@ -22,6 +22,20 @@ export interface GetParametersCommandOutput extends GetParametersResult, __Metad /** *

Get details of a parameter. Don't confuse this API action with the GetParameter API action.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { SSMClient, GetParametersCommand } from "@aws-sdk/client-ssm"; // ES Modules import + * // const { SSMClient, GetParametersCommand } = require("@aws-sdk/client-ssm"); // CommonJS import + * const client = new SSMClient(config); + * const command = new GetParametersCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetParametersCommandInput} for command's `input` shape. + * @see {@link GetParametersCommandOutput} for command's `response` shape. + * @see {@link SSMClientResolvedConfig | config} for command's `input` shape. + * */ export class GetParametersCommand extends $Command< GetParametersCommandInput, diff --git a/clients/client-ssm/commands/GetPatchBaselineCommand.ts b/clients/client-ssm/commands/GetPatchBaselineCommand.ts index 0ff31d95ec29..ad30fac67801 100644 --- a/clients/client-ssm/commands/GetPatchBaselineCommand.ts +++ b/clients/client-ssm/commands/GetPatchBaselineCommand.ts @@ -22,6 +22,20 @@ export interface GetPatchBaselineCommandOutput extends GetPatchBaselineResult, _ /** *

Retrieves information about a patch baseline.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { SSMClient, GetPatchBaselineCommand } from "@aws-sdk/client-ssm"; // ES Modules import + * // const { SSMClient, GetPatchBaselineCommand } = require("@aws-sdk/client-ssm"); // CommonJS import + * const client = new SSMClient(config); + * const command = new GetPatchBaselineCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetPatchBaselineCommandInput} for command's `input` shape. + * @see {@link GetPatchBaselineCommandOutput} for command's `response` shape. + * @see {@link SSMClientResolvedConfig | config} for command's `input` shape. + * */ export class GetPatchBaselineCommand extends $Command< GetPatchBaselineCommandInput, diff --git a/clients/client-ssm/commands/GetPatchBaselineForPatchGroupCommand.ts b/clients/client-ssm/commands/GetPatchBaselineForPatchGroupCommand.ts index 9808ffde2610..87c119b8bf6d 100644 --- a/clients/client-ssm/commands/GetPatchBaselineForPatchGroupCommand.ts +++ b/clients/client-ssm/commands/GetPatchBaselineForPatchGroupCommand.ts @@ -24,6 +24,20 @@ export interface GetPatchBaselineForPatchGroupCommandOutput /** *

Retrieves the patch baseline that should be used for the specified patch group.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { SSMClient, GetPatchBaselineForPatchGroupCommand } from "@aws-sdk/client-ssm"; // ES Modules import + * // const { SSMClient, GetPatchBaselineForPatchGroupCommand } = require("@aws-sdk/client-ssm"); // CommonJS import + * const client = new SSMClient(config); + * const command = new GetPatchBaselineForPatchGroupCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetPatchBaselineForPatchGroupCommandInput} for command's `input` shape. + * @see {@link GetPatchBaselineForPatchGroupCommandOutput} for command's `response` shape. + * @see {@link SSMClientResolvedConfig | config} for command's `input` shape. + * */ export class GetPatchBaselineForPatchGroupCommand extends $Command< GetPatchBaselineForPatchGroupCommandInput, diff --git a/clients/client-ssm/commands/GetServiceSettingCommand.ts b/clients/client-ssm/commands/GetServiceSettingCommand.ts index 8ee1082bc1f1..20954779bd1d 100644 --- a/clients/client-ssm/commands/GetServiceSettingCommand.ts +++ b/clients/client-ssm/commands/GetServiceSettingCommand.ts @@ -35,6 +35,20 @@ export interface GetServiceSettingCommandOutput extends GetServiceSettingResult, * the original value defined by the AWS service team.

* *

Query the current service setting for the account.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { SSMClient, GetServiceSettingCommand } from "@aws-sdk/client-ssm"; // ES Modules import + * // const { SSMClient, GetServiceSettingCommand } = require("@aws-sdk/client-ssm"); // CommonJS import + * const client = new SSMClient(config); + * const command = new GetServiceSettingCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetServiceSettingCommandInput} for command's `input` shape. + * @see {@link GetServiceSettingCommandOutput} for command's `response` shape. + * @see {@link SSMClientResolvedConfig | config} for command's `input` shape. + * */ export class GetServiceSettingCommand extends $Command< GetServiceSettingCommandInput, diff --git a/clients/client-ssm/commands/LabelParameterVersionCommand.ts b/clients/client-ssm/commands/LabelParameterVersionCommand.ts index f7f8faf06b2e..bc9f118b8d7b 100644 --- a/clients/client-ssm/commands/LabelParameterVersionCommand.ts +++ b/clients/client-ssm/commands/LabelParameterVersionCommand.ts @@ -58,6 +58,20 @@ export interface LabelParameterVersionCommandOutput extends LabelParameterVersio * displays it in the list of InvalidLabels.

* * + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { SSMClient, LabelParameterVersionCommand } from "@aws-sdk/client-ssm"; // ES Modules import + * // const { SSMClient, LabelParameterVersionCommand } = require("@aws-sdk/client-ssm"); // CommonJS import + * const client = new SSMClient(config); + * const command = new LabelParameterVersionCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link LabelParameterVersionCommandInput} for command's `input` shape. + * @see {@link LabelParameterVersionCommandOutput} for command's `response` shape. + * @see {@link SSMClientResolvedConfig | config} for command's `input` shape. + * */ export class LabelParameterVersionCommand extends $Command< LabelParameterVersionCommandInput, diff --git a/clients/client-ssm/commands/ListAssociationVersionsCommand.ts b/clients/client-ssm/commands/ListAssociationVersionsCommand.ts index 36c43e37b1f9..6226c5628698 100644 --- a/clients/client-ssm/commands/ListAssociationVersionsCommand.ts +++ b/clients/client-ssm/commands/ListAssociationVersionsCommand.ts @@ -22,6 +22,20 @@ export interface ListAssociationVersionsCommandOutput extends ListAssociationVer /** *

Retrieves all versions of an association for a specific association ID.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { SSMClient, ListAssociationVersionsCommand } from "@aws-sdk/client-ssm"; // ES Modules import + * // const { SSMClient, ListAssociationVersionsCommand } = require("@aws-sdk/client-ssm"); // CommonJS import + * const client = new SSMClient(config); + * const command = new ListAssociationVersionsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListAssociationVersionsCommandInput} for command's `input` shape. + * @see {@link ListAssociationVersionsCommandOutput} for command's `response` shape. + * @see {@link SSMClientResolvedConfig | config} for command's `input` shape. + * */ export class ListAssociationVersionsCommand extends $Command< ListAssociationVersionsCommandInput, diff --git a/clients/client-ssm/commands/ListAssociationsCommand.ts b/clients/client-ssm/commands/ListAssociationsCommand.ts index 08e78e210efa..2abb9c9d8c5d 100644 --- a/clients/client-ssm/commands/ListAssociationsCommand.ts +++ b/clients/client-ssm/commands/ListAssociationsCommand.ts @@ -24,6 +24,20 @@ export interface ListAssociationsCommandOutput extends ListAssociationsResult, _ *

Returns all State Manager associations in the current AWS account and Region. You can limit * the results to a specific State Manager association document or instance by specifying a * filter.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { SSMClient, ListAssociationsCommand } from "@aws-sdk/client-ssm"; // ES Modules import + * // const { SSMClient, ListAssociationsCommand } = require("@aws-sdk/client-ssm"); // CommonJS import + * const client = new SSMClient(config); + * const command = new ListAssociationsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListAssociationsCommandInput} for command's `input` shape. + * @see {@link ListAssociationsCommandOutput} for command's `response` shape. + * @see {@link SSMClientResolvedConfig | config} for command's `input` shape. + * */ export class ListAssociationsCommand extends $Command< ListAssociationsCommandInput, diff --git a/clients/client-ssm/commands/ListCommandInvocationsCommand.ts b/clients/client-ssm/commands/ListCommandInvocationsCommand.ts index cfa7e3bc6213..7430b2cf564e 100644 --- a/clients/client-ssm/commands/ListCommandInvocationsCommand.ts +++ b/clients/client-ssm/commands/ListCommandInvocationsCommand.ts @@ -25,6 +25,20 @@ export interface ListCommandInvocationsCommandOutput extends ListCommandInvocati * or more instances. A command invocation applies to one instance. For example, if a user runs * SendCommand against three instances, then a command invocation is created for each requested * instance ID. ListCommandInvocations provide status about command execution.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { SSMClient, ListCommandInvocationsCommand } from "@aws-sdk/client-ssm"; // ES Modules import + * // const { SSMClient, ListCommandInvocationsCommand } = require("@aws-sdk/client-ssm"); // CommonJS import + * const client = new SSMClient(config); + * const command = new ListCommandInvocationsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListCommandInvocationsCommandInput} for command's `input` shape. + * @see {@link ListCommandInvocationsCommandOutput} for command's `response` shape. + * @see {@link SSMClientResolvedConfig | config} for command's `input` shape. + * */ export class ListCommandInvocationsCommand extends $Command< ListCommandInvocationsCommandInput, diff --git a/clients/client-ssm/commands/ListCommandsCommand.ts b/clients/client-ssm/commands/ListCommandsCommand.ts index eb18547da81d..6045940bb7d1 100644 --- a/clients/client-ssm/commands/ListCommandsCommand.ts +++ b/clients/client-ssm/commands/ListCommandsCommand.ts @@ -22,6 +22,20 @@ export interface ListCommandsCommandOutput extends ListCommandsResult, __Metadat /** *

Lists the commands requested by users of the AWS account.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { SSMClient, ListCommandsCommand } from "@aws-sdk/client-ssm"; // ES Modules import + * // const { SSMClient, ListCommandsCommand } = require("@aws-sdk/client-ssm"); // CommonJS import + * const client = new SSMClient(config); + * const command = new ListCommandsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListCommandsCommandInput} for command's `input` shape. + * @see {@link ListCommandsCommandOutput} for command's `response` shape. + * @see {@link SSMClientResolvedConfig | config} for command's `input` shape. + * */ export class ListCommandsCommand extends $Command< ListCommandsCommandInput, diff --git a/clients/client-ssm/commands/ListComplianceItemsCommand.ts b/clients/client-ssm/commands/ListComplianceItemsCommand.ts index 6806bcd347ec..238be56d36fe 100644 --- a/clients/client-ssm/commands/ListComplianceItemsCommand.ts +++ b/clients/client-ssm/commands/ListComplianceItemsCommand.ts @@ -24,6 +24,20 @@ export interface ListComplianceItemsCommandOutput extends ListComplianceItemsRes *

For a specified resource ID, this API action 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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { SSMClient, ListComplianceItemsCommand } from "@aws-sdk/client-ssm"; // ES Modules import + * // const { SSMClient, ListComplianceItemsCommand } = require("@aws-sdk/client-ssm"); // CommonJS import + * const client = new SSMClient(config); + * const command = new ListComplianceItemsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListComplianceItemsCommandInput} for command's `input` shape. + * @see {@link ListComplianceItemsCommandOutput} for command's `response` shape. + * @see {@link SSMClientResolvedConfig | config} for command's `input` shape. + * */ export class ListComplianceItemsCommand extends $Command< ListComplianceItemsCommandInput, diff --git a/clients/client-ssm/commands/ListComplianceSummariesCommand.ts b/clients/client-ssm/commands/ListComplianceSummariesCommand.ts index 46b8028b87b0..cad0497292ca 100644 --- a/clients/client-ssm/commands/ListComplianceSummariesCommand.ts +++ b/clients/client-ssm/commands/ListComplianceSummariesCommand.ts @@ -24,6 +24,20 @@ export interface ListComplianceSummariesCommandOutput extends ListComplianceSumm *

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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { SSMClient, ListComplianceSummariesCommand } from "@aws-sdk/client-ssm"; // ES Modules import + * // const { SSMClient, ListComplianceSummariesCommand } = require("@aws-sdk/client-ssm"); // CommonJS import + * const client = new SSMClient(config); + * const command = new ListComplianceSummariesCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListComplianceSummariesCommandInput} for command's `input` shape. + * @see {@link ListComplianceSummariesCommandOutput} for command's `response` shape. + * @see {@link SSMClientResolvedConfig | config} for command's `input` shape. + * */ export class ListComplianceSummariesCommand extends $Command< ListComplianceSummariesCommandInput, diff --git a/clients/client-ssm/commands/ListDocumentMetadataHistoryCommand.ts b/clients/client-ssm/commands/ListDocumentMetadataHistoryCommand.ts index f537efb3ae06..ec45fcc31561 100644 --- a/clients/client-ssm/commands/ListDocumentMetadataHistoryCommand.ts +++ b/clients/client-ssm/commands/ListDocumentMetadataHistoryCommand.ts @@ -24,6 +24,20 @@ export interface ListDocumentMetadataHistoryCommandOutput /** *

Information about approval reviews for a version of an SSM document.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { SSMClient, ListDocumentMetadataHistoryCommand } from "@aws-sdk/client-ssm"; // ES Modules import + * // const { SSMClient, ListDocumentMetadataHistoryCommand } = require("@aws-sdk/client-ssm"); // CommonJS import + * const client = new SSMClient(config); + * const command = new ListDocumentMetadataHistoryCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListDocumentMetadataHistoryCommandInput} for command's `input` shape. + * @see {@link ListDocumentMetadataHistoryCommandOutput} for command's `response` shape. + * @see {@link SSMClientResolvedConfig | config} for command's `input` shape. + * */ export class ListDocumentMetadataHistoryCommand extends $Command< ListDocumentMetadataHistoryCommandInput, diff --git a/clients/client-ssm/commands/ListDocumentVersionsCommand.ts b/clients/client-ssm/commands/ListDocumentVersionsCommand.ts index a67078fbfa45..9c260c35c142 100644 --- a/clients/client-ssm/commands/ListDocumentVersionsCommand.ts +++ b/clients/client-ssm/commands/ListDocumentVersionsCommand.ts @@ -22,6 +22,20 @@ export interface ListDocumentVersionsCommandOutput extends ListDocumentVersionsR /** *

List all versions for a document.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { SSMClient, ListDocumentVersionsCommand } from "@aws-sdk/client-ssm"; // ES Modules import + * // const { SSMClient, ListDocumentVersionsCommand } = require("@aws-sdk/client-ssm"); // CommonJS import + * const client = new SSMClient(config); + * const command = new ListDocumentVersionsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListDocumentVersionsCommandInput} for command's `input` shape. + * @see {@link ListDocumentVersionsCommandOutput} for command's `response` shape. + * @see {@link SSMClientResolvedConfig | config} for command's `input` shape. + * */ export class ListDocumentVersionsCommand extends $Command< ListDocumentVersionsCommandInput, diff --git a/clients/client-ssm/commands/ListDocumentsCommand.ts b/clients/client-ssm/commands/ListDocumentsCommand.ts index 04ff45dab9e8..4a551b1e7619 100644 --- a/clients/client-ssm/commands/ListDocumentsCommand.ts +++ b/clients/client-ssm/commands/ListDocumentsCommand.ts @@ -23,6 +23,20 @@ export interface ListDocumentsCommandOutput extends ListDocumentsResult, __Metad /** *

Returns all Systems Manager (SSM) documents in the current AWS account and Region. You can limit the * results of this request by using a filter.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { SSMClient, ListDocumentsCommand } from "@aws-sdk/client-ssm"; // ES Modules import + * // const { SSMClient, ListDocumentsCommand } = require("@aws-sdk/client-ssm"); // CommonJS import + * const client = new SSMClient(config); + * const command = new ListDocumentsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListDocumentsCommandInput} for command's `input` shape. + * @see {@link ListDocumentsCommandOutput} for command's `response` shape. + * @see {@link SSMClientResolvedConfig | config} for command's `input` shape. + * */ export class ListDocumentsCommand extends $Command< ListDocumentsCommandInput, diff --git a/clients/client-ssm/commands/ListInventoryEntriesCommand.ts b/clients/client-ssm/commands/ListInventoryEntriesCommand.ts index 10bc1b435132..d91ae33345bf 100644 --- a/clients/client-ssm/commands/ListInventoryEntriesCommand.ts +++ b/clients/client-ssm/commands/ListInventoryEntriesCommand.ts @@ -22,6 +22,20 @@ export interface ListInventoryEntriesCommandOutput extends ListInventoryEntriesR /** *

A list of inventory items returned by the request.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { SSMClient, ListInventoryEntriesCommand } from "@aws-sdk/client-ssm"; // ES Modules import + * // const { SSMClient, ListInventoryEntriesCommand } = require("@aws-sdk/client-ssm"); // CommonJS import + * const client = new SSMClient(config); + * const command = new ListInventoryEntriesCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListInventoryEntriesCommandInput} for command's `input` shape. + * @see {@link ListInventoryEntriesCommandOutput} for command's `response` shape. + * @see {@link SSMClientResolvedConfig | config} for command's `input` shape. + * */ export class ListInventoryEntriesCommand extends $Command< ListInventoryEntriesCommandInput, diff --git a/clients/client-ssm/commands/ListOpsItemEventsCommand.ts b/clients/client-ssm/commands/ListOpsItemEventsCommand.ts index 22979166818f..265a5d284fb9 100644 --- a/clients/client-ssm/commands/ListOpsItemEventsCommand.ts +++ b/clients/client-ssm/commands/ListOpsItemEventsCommand.ts @@ -23,6 +23,20 @@ export interface ListOpsItemEventsCommandOutput extends ListOpsItemEventsRespons /** *

Returns a list of all OpsItem events in the current AWS account and Region. You can limit * the results to events associated with specific OpsItems by specifying a filter.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { SSMClient, ListOpsItemEventsCommand } from "@aws-sdk/client-ssm"; // ES Modules import + * // const { SSMClient, ListOpsItemEventsCommand } = require("@aws-sdk/client-ssm"); // CommonJS import + * const client = new SSMClient(config); + * const command = new ListOpsItemEventsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListOpsItemEventsCommandInput} for command's `input` shape. + * @see {@link ListOpsItemEventsCommandOutput} for command's `response` shape. + * @see {@link SSMClientResolvedConfig | config} for command's `input` shape. + * */ export class ListOpsItemEventsCommand extends $Command< ListOpsItemEventsCommandInput, diff --git a/clients/client-ssm/commands/ListOpsMetadataCommand.ts b/clients/client-ssm/commands/ListOpsMetadataCommand.ts index 09949c7594f9..001f1a04488d 100644 --- a/clients/client-ssm/commands/ListOpsMetadataCommand.ts +++ b/clients/client-ssm/commands/ListOpsMetadataCommand.ts @@ -23,6 +23,20 @@ export interface ListOpsMetadataCommandOutput extends ListOpsMetadataResult, __M /** *

Systems Manager calls this API action when displaying all Application Manager OpsMetadata objects or * blobs.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { SSMClient, ListOpsMetadataCommand } from "@aws-sdk/client-ssm"; // ES Modules import + * // const { SSMClient, ListOpsMetadataCommand } = require("@aws-sdk/client-ssm"); // CommonJS import + * const client = new SSMClient(config); + * const command = new ListOpsMetadataCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListOpsMetadataCommandInput} for command's `input` shape. + * @see {@link ListOpsMetadataCommandOutput} for command's `response` shape. + * @see {@link SSMClientResolvedConfig | config} for command's `input` shape. + * */ export class ListOpsMetadataCommand extends $Command< ListOpsMetadataCommandInput, diff --git a/clients/client-ssm/commands/ListResourceComplianceSummariesCommand.ts b/clients/client-ssm/commands/ListResourceComplianceSummariesCommand.ts index bd3217f350d2..16a5611a8b98 100644 --- a/clients/client-ssm/commands/ListResourceComplianceSummariesCommand.ts +++ b/clients/client-ssm/commands/ListResourceComplianceSummariesCommand.ts @@ -26,6 +26,20 @@ export interface ListResourceComplianceSummariesCommandOutput *

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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { SSMClient, ListResourceComplianceSummariesCommand } from "@aws-sdk/client-ssm"; // ES Modules import + * // const { SSMClient, ListResourceComplianceSummariesCommand } = require("@aws-sdk/client-ssm"); // CommonJS import + * const client = new SSMClient(config); + * const command = new ListResourceComplianceSummariesCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListResourceComplianceSummariesCommandInput} for command's `input` shape. + * @see {@link ListResourceComplianceSummariesCommandOutput} for command's `response` shape. + * @see {@link SSMClientResolvedConfig | config} for command's `input` shape. + * */ export class ListResourceComplianceSummariesCommand extends $Command< ListResourceComplianceSummariesCommandInput, diff --git a/clients/client-ssm/commands/ListResourceDataSyncCommand.ts b/clients/client-ssm/commands/ListResourceDataSyncCommand.ts index b727c14d7d16..fe98645be326 100644 --- a/clients/client-ssm/commands/ListResourceDataSyncCommand.ts +++ b/clients/client-ssm/commands/ListResourceDataSyncCommand.ts @@ -30,6 +30,20 @@ export interface ListResourceDataSyncCommandOutput extends ListResourceDataSyncR * 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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { SSMClient, ListResourceDataSyncCommand } from "@aws-sdk/client-ssm"; // ES Modules import + * // const { SSMClient, ListResourceDataSyncCommand } = require("@aws-sdk/client-ssm"); // CommonJS import + * const client = new SSMClient(config); + * const command = new ListResourceDataSyncCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListResourceDataSyncCommandInput} for command's `input` shape. + * @see {@link ListResourceDataSyncCommandOutput} for command's `response` shape. + * @see {@link SSMClientResolvedConfig | config} for command's `input` shape. + * */ export class ListResourceDataSyncCommand extends $Command< ListResourceDataSyncCommandInput, diff --git a/clients/client-ssm/commands/ListTagsForResourceCommand.ts b/clients/client-ssm/commands/ListTagsForResourceCommand.ts index 0f0f884ba9b5..937a6cb98f21 100644 --- a/clients/client-ssm/commands/ListTagsForResourceCommand.ts +++ b/clients/client-ssm/commands/ListTagsForResourceCommand.ts @@ -22,6 +22,20 @@ export interface ListTagsForResourceCommandOutput extends ListTagsForResourceRes /** *

Returns a list of the tags assigned to the specified resource.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { SSMClient, ListTagsForResourceCommand } from "@aws-sdk/client-ssm"; // ES Modules import + * // const { SSMClient, ListTagsForResourceCommand } = require("@aws-sdk/client-ssm"); // CommonJS import + * const client = new SSMClient(config); + * const command = new ListTagsForResourceCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListTagsForResourceCommandInput} for command's `input` shape. + * @see {@link ListTagsForResourceCommandOutput} for command's `response` shape. + * @see {@link SSMClientResolvedConfig | config} for command's `input` shape. + * */ export class ListTagsForResourceCommand extends $Command< ListTagsForResourceCommandInput, diff --git a/clients/client-ssm/commands/ModifyDocumentPermissionCommand.ts b/clients/client-ssm/commands/ModifyDocumentPermissionCommand.ts index 6e17448fa661..3c76ba0c6aee 100644 --- a/clients/client-ssm/commands/ModifyDocumentPermissionCommand.ts +++ b/clients/client-ssm/commands/ModifyDocumentPermissionCommand.ts @@ -24,6 +24,20 @@ export interface ModifyDocumentPermissionCommandOutput extends ModifyDocumentPer *

Shares a Systems Manager document publicly or privately. If you share a document privately, you must * specify the AWS user account IDs for those people who can use the document. If you share a * document publicly, you must specify All as the account ID.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { SSMClient, ModifyDocumentPermissionCommand } from "@aws-sdk/client-ssm"; // ES Modules import + * // const { SSMClient, ModifyDocumentPermissionCommand } = require("@aws-sdk/client-ssm"); // CommonJS import + * const client = new SSMClient(config); + * const command = new ModifyDocumentPermissionCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ModifyDocumentPermissionCommandInput} for command's `input` shape. + * @see {@link ModifyDocumentPermissionCommandOutput} for command's `response` shape. + * @see {@link SSMClientResolvedConfig | config} for command's `input` shape. + * */ export class ModifyDocumentPermissionCommand extends $Command< ModifyDocumentPermissionCommandInput, diff --git a/clients/client-ssm/commands/PutComplianceItemsCommand.ts b/clients/client-ssm/commands/PutComplianceItemsCommand.ts index 452802566e56..558cce6a690d 100644 --- a/clients/client-ssm/commands/PutComplianceItemsCommand.ts +++ b/clients/client-ssm/commands/PutComplianceItemsCommand.ts @@ -77,6 +77,20 @@ export interface PutComplianceItemsCommandOutput extends PutComplianceItemsResul * the resource. Specify the time by using the following format: yyyy-MM-dd'T'HH:mm:ss'Z'

* * + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { SSMClient, PutComplianceItemsCommand } from "@aws-sdk/client-ssm"; // ES Modules import + * // const { SSMClient, PutComplianceItemsCommand } = require("@aws-sdk/client-ssm"); // CommonJS import + * const client = new SSMClient(config); + * const command = new PutComplianceItemsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link PutComplianceItemsCommandInput} for command's `input` shape. + * @see {@link PutComplianceItemsCommandOutput} for command's `response` shape. + * @see {@link SSMClientResolvedConfig | config} for command's `input` shape. + * */ export class PutComplianceItemsCommand extends $Command< PutComplianceItemsCommandInput, diff --git a/clients/client-ssm/commands/PutInventoryCommand.ts b/clients/client-ssm/commands/PutInventoryCommand.ts index 6a2459219a62..59413c4e22dc 100644 --- a/clients/client-ssm/commands/PutInventoryCommand.ts +++ b/clients/client-ssm/commands/PutInventoryCommand.ts @@ -23,6 +23,20 @@ export interface PutInventoryCommandOutput extends PutInventoryResult, __Metadat /** *

Bulk update custom inventory items on one more instance. The request adds an inventory item, * if it doesn't already exist, or updates an inventory item, if it does exist.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { SSMClient, PutInventoryCommand } from "@aws-sdk/client-ssm"; // ES Modules import + * // const { SSMClient, PutInventoryCommand } = require("@aws-sdk/client-ssm"); // CommonJS import + * const client = new SSMClient(config); + * const command = new PutInventoryCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link PutInventoryCommandInput} for command's `input` shape. + * @see {@link PutInventoryCommandOutput} for command's `response` shape. + * @see {@link SSMClientResolvedConfig | config} for command's `input` shape. + * */ export class PutInventoryCommand extends $Command< PutInventoryCommandInput, diff --git a/clients/client-ssm/commands/PutParameterCommand.ts b/clients/client-ssm/commands/PutParameterCommand.ts index d8aaa6889c6d..4401d5000f2b 100644 --- a/clients/client-ssm/commands/PutParameterCommand.ts +++ b/clients/client-ssm/commands/PutParameterCommand.ts @@ -22,6 +22,20 @@ export interface PutParameterCommandOutput extends PutParameterResult, __Metadat /** *

Add a parameter to the system.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { SSMClient, PutParameterCommand } from "@aws-sdk/client-ssm"; // ES Modules import + * // const { SSMClient, PutParameterCommand } = require("@aws-sdk/client-ssm"); // CommonJS import + * const client = new SSMClient(config); + * const command = new PutParameterCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link PutParameterCommandInput} for command's `input` shape. + * @see {@link PutParameterCommandOutput} for command's `response` shape. + * @see {@link SSMClientResolvedConfig | config} for command's `input` shape. + * */ export class PutParameterCommand extends $Command< PutParameterCommandInput, diff --git a/clients/client-ssm/commands/RegisterDefaultPatchBaselineCommand.ts b/clients/client-ssm/commands/RegisterDefaultPatchBaselineCommand.ts index 7b2953d699b3..7b160601f576 100644 --- a/clients/client-ssm/commands/RegisterDefaultPatchBaselineCommand.ts +++ b/clients/client-ssm/commands/RegisterDefaultPatchBaselineCommand.ts @@ -28,6 +28,20 @@ export interface RegisterDefaultPatchBaselineCommandOutput * 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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { SSMClient, RegisterDefaultPatchBaselineCommand } from "@aws-sdk/client-ssm"; // ES Modules import + * // const { SSMClient, RegisterDefaultPatchBaselineCommand } = require("@aws-sdk/client-ssm"); // CommonJS import + * const client = new SSMClient(config); + * const command = new RegisterDefaultPatchBaselineCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link RegisterDefaultPatchBaselineCommandInput} for command's `input` shape. + * @see {@link RegisterDefaultPatchBaselineCommandOutput} for command's `response` shape. + * @see {@link SSMClientResolvedConfig | config} for command's `input` shape. + * */ export class RegisterDefaultPatchBaselineCommand extends $Command< RegisterDefaultPatchBaselineCommandInput, diff --git a/clients/client-ssm/commands/RegisterPatchBaselineForPatchGroupCommand.ts b/clients/client-ssm/commands/RegisterPatchBaselineForPatchGroupCommand.ts index 7de1f5687520..53e0600b93b8 100644 --- a/clients/client-ssm/commands/RegisterPatchBaselineForPatchGroupCommand.ts +++ b/clients/client-ssm/commands/RegisterPatchBaselineForPatchGroupCommand.ts @@ -27,6 +27,20 @@ export interface RegisterPatchBaselineForPatchGroupCommandOutput /** *

Registers a patch baseline for a patch group.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { SSMClient, RegisterPatchBaselineForPatchGroupCommand } from "@aws-sdk/client-ssm"; // ES Modules import + * // const { SSMClient, RegisterPatchBaselineForPatchGroupCommand } = require("@aws-sdk/client-ssm"); // CommonJS import + * const client = new SSMClient(config); + * const command = new RegisterPatchBaselineForPatchGroupCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link RegisterPatchBaselineForPatchGroupCommandInput} for command's `input` shape. + * @see {@link RegisterPatchBaselineForPatchGroupCommandOutput} for command's `response` shape. + * @see {@link SSMClientResolvedConfig | config} for command's `input` shape. + * */ export class RegisterPatchBaselineForPatchGroupCommand extends $Command< RegisterPatchBaselineForPatchGroupCommandInput, diff --git a/clients/client-ssm/commands/RegisterTargetWithMaintenanceWindowCommand.ts b/clients/client-ssm/commands/RegisterTargetWithMaintenanceWindowCommand.ts index 3ce42a88a3b1..09d6dbeb47ac 100644 --- a/clients/client-ssm/commands/RegisterTargetWithMaintenanceWindowCommand.ts +++ b/clients/client-ssm/commands/RegisterTargetWithMaintenanceWindowCommand.ts @@ -27,6 +27,20 @@ export interface RegisterTargetWithMaintenanceWindowCommandOutput /** *

Registers a target with a maintenance window.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { SSMClient, RegisterTargetWithMaintenanceWindowCommand } from "@aws-sdk/client-ssm"; // ES Modules import + * // const { SSMClient, RegisterTargetWithMaintenanceWindowCommand } = require("@aws-sdk/client-ssm"); // CommonJS import + * const client = new SSMClient(config); + * const command = new RegisterTargetWithMaintenanceWindowCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link RegisterTargetWithMaintenanceWindowCommandInput} for command's `input` shape. + * @see {@link RegisterTargetWithMaintenanceWindowCommandOutput} for command's `response` shape. + * @see {@link SSMClientResolvedConfig | config} for command's `input` shape. + * */ export class RegisterTargetWithMaintenanceWindowCommand extends $Command< RegisterTargetWithMaintenanceWindowCommandInput, diff --git a/clients/client-ssm/commands/RegisterTaskWithMaintenanceWindowCommand.ts b/clients/client-ssm/commands/RegisterTaskWithMaintenanceWindowCommand.ts index c2c7e4bfa884..d85bebd218d3 100644 --- a/clients/client-ssm/commands/RegisterTaskWithMaintenanceWindowCommand.ts +++ b/clients/client-ssm/commands/RegisterTaskWithMaintenanceWindowCommand.ts @@ -24,6 +24,20 @@ export interface RegisterTaskWithMaintenanceWindowCommandOutput /** *

Adds a new task to a maintenance window.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { SSMClient, RegisterTaskWithMaintenanceWindowCommand } from "@aws-sdk/client-ssm"; // ES Modules import + * // const { SSMClient, RegisterTaskWithMaintenanceWindowCommand } = require("@aws-sdk/client-ssm"); // CommonJS import + * const client = new SSMClient(config); + * const command = new RegisterTaskWithMaintenanceWindowCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link RegisterTaskWithMaintenanceWindowCommandInput} for command's `input` shape. + * @see {@link RegisterTaskWithMaintenanceWindowCommandOutput} for command's `response` shape. + * @see {@link SSMClientResolvedConfig | config} for command's `input` shape. + * */ export class RegisterTaskWithMaintenanceWindowCommand extends $Command< RegisterTaskWithMaintenanceWindowCommandInput, diff --git a/clients/client-ssm/commands/RemoveTagsFromResourceCommand.ts b/clients/client-ssm/commands/RemoveTagsFromResourceCommand.ts index 742cb3530227..710ffa6eca0f 100644 --- a/clients/client-ssm/commands/RemoveTagsFromResourceCommand.ts +++ b/clients/client-ssm/commands/RemoveTagsFromResourceCommand.ts @@ -22,6 +22,20 @@ export interface RemoveTagsFromResourceCommandOutput extends RemoveTagsFromResou /** *

Removes tag keys from the specified resource.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { SSMClient, RemoveTagsFromResourceCommand } from "@aws-sdk/client-ssm"; // ES Modules import + * // const { SSMClient, RemoveTagsFromResourceCommand } = require("@aws-sdk/client-ssm"); // CommonJS import + * const client = new SSMClient(config); + * const command = new RemoveTagsFromResourceCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link RemoveTagsFromResourceCommandInput} for command's `input` shape. + * @see {@link RemoveTagsFromResourceCommandOutput} for command's `response` shape. + * @see {@link SSMClientResolvedConfig | config} for command's `input` shape. + * */ export class RemoveTagsFromResourceCommand extends $Command< RemoveTagsFromResourceCommandInput, diff --git a/clients/client-ssm/commands/ResetServiceSettingCommand.ts b/clients/client-ssm/commands/ResetServiceSettingCommand.ts index 4381897d08d5..7d4a5e5784d6 100644 --- a/clients/client-ssm/commands/ResetServiceSettingCommand.ts +++ b/clients/client-ssm/commands/ResetServiceSettingCommand.ts @@ -36,6 +36,20 @@ export interface ResetServiceSettingCommandOutput extends ResetServiceSettingRes * *

Reset the service setting for the account to the default value as provisioned by the AWS * service team.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { SSMClient, ResetServiceSettingCommand } from "@aws-sdk/client-ssm"; // ES Modules import + * // const { SSMClient, ResetServiceSettingCommand } = require("@aws-sdk/client-ssm"); // CommonJS import + * const client = new SSMClient(config); + * const command = new ResetServiceSettingCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ResetServiceSettingCommandInput} for command's `input` shape. + * @see {@link ResetServiceSettingCommandOutput} for command's `response` shape. + * @see {@link SSMClientResolvedConfig | config} for command's `input` shape. + * */ export class ResetServiceSettingCommand extends $Command< ResetServiceSettingCommandInput, diff --git a/clients/client-ssm/commands/ResumeSessionCommand.ts b/clients/client-ssm/commands/ResumeSessionCommand.ts index 2c60f46fb7c1..0d00581f77fc 100644 --- a/clients/client-ssm/commands/ResumeSessionCommand.ts +++ b/clients/client-ssm/commands/ResumeSessionCommand.ts @@ -27,6 +27,20 @@ export interface ResumeSessionCommandOutput extends ResumeSessionResponse, __Met *

This command is primarily for use by client machines to automatically reconnect during * intermittent network issues. It is not intended for any other use.

* + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { SSMClient, ResumeSessionCommand } from "@aws-sdk/client-ssm"; // ES Modules import + * // const { SSMClient, ResumeSessionCommand } = require("@aws-sdk/client-ssm"); // CommonJS import + * const client = new SSMClient(config); + * const command = new ResumeSessionCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ResumeSessionCommandInput} for command's `input` shape. + * @see {@link ResumeSessionCommandOutput} for command's `response` shape. + * @see {@link SSMClientResolvedConfig | config} for command's `input` shape. + * */ export class ResumeSessionCommand extends $Command< ResumeSessionCommandInput, diff --git a/clients/client-ssm/commands/SendAutomationSignalCommand.ts b/clients/client-ssm/commands/SendAutomationSignalCommand.ts index f87423c86774..1fe18e4219a8 100644 --- a/clients/client-ssm/commands/SendAutomationSignalCommand.ts +++ b/clients/client-ssm/commands/SendAutomationSignalCommand.ts @@ -23,6 +23,20 @@ export interface SendAutomationSignalCommandOutput extends SendAutomationSignalR /** *

Sends a signal to an Automation execution to change the current behavior or status of the * execution.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { SSMClient, SendAutomationSignalCommand } from "@aws-sdk/client-ssm"; // ES Modules import + * // const { SSMClient, SendAutomationSignalCommand } = require("@aws-sdk/client-ssm"); // CommonJS import + * const client = new SSMClient(config); + * const command = new SendAutomationSignalCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link SendAutomationSignalCommandInput} for command's `input` shape. + * @see {@link SendAutomationSignalCommandOutput} for command's `response` shape. + * @see {@link SSMClientResolvedConfig | config} for command's `input` shape. + * */ export class SendAutomationSignalCommand extends $Command< SendAutomationSignalCommandInput, diff --git a/clients/client-ssm/commands/SendCommandCommand.ts b/clients/client-ssm/commands/SendCommandCommand.ts index 1a5097757f1d..1ca0235f3282 100644 --- a/clients/client-ssm/commands/SendCommandCommand.ts +++ b/clients/client-ssm/commands/SendCommandCommand.ts @@ -22,6 +22,20 @@ export interface SendCommandCommandOutput extends SendCommandResult, __MetadataB /** *

Runs commands on one or more managed instances.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { SSMClient, SendCommandCommand } from "@aws-sdk/client-ssm"; // ES Modules import + * // const { SSMClient, SendCommandCommand } = require("@aws-sdk/client-ssm"); // CommonJS import + * const client = new SSMClient(config); + * const command = new SendCommandCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link SendCommandCommandInput} for command's `input` shape. + * @see {@link SendCommandCommandOutput} for command's `response` shape. + * @see {@link SSMClientResolvedConfig | config} for command's `input` shape. + * */ export class SendCommandCommand extends $Command< SendCommandCommandInput, diff --git a/clients/client-ssm/commands/StartAssociationsOnceCommand.ts b/clients/client-ssm/commands/StartAssociationsOnceCommand.ts index 8e019caa0c53..c93c315638a0 100644 --- a/clients/client-ssm/commands/StartAssociationsOnceCommand.ts +++ b/clients/client-ssm/commands/StartAssociationsOnceCommand.ts @@ -23,6 +23,20 @@ export interface StartAssociationsOnceCommandOutput extends StartAssociationsOnc /** *

Use this API action to run an association immediately and only one time. This action can be * helpful when troubleshooting associations.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { SSMClient, StartAssociationsOnceCommand } from "@aws-sdk/client-ssm"; // ES Modules import + * // const { SSMClient, StartAssociationsOnceCommand } = require("@aws-sdk/client-ssm"); // CommonJS import + * const client = new SSMClient(config); + * const command = new StartAssociationsOnceCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link StartAssociationsOnceCommandInput} for command's `input` shape. + * @see {@link StartAssociationsOnceCommandOutput} for command's `response` shape. + * @see {@link SSMClientResolvedConfig | config} for command's `input` shape. + * */ export class StartAssociationsOnceCommand extends $Command< StartAssociationsOnceCommandInput, diff --git a/clients/client-ssm/commands/StartAutomationExecutionCommand.ts b/clients/client-ssm/commands/StartAutomationExecutionCommand.ts index 3b8701969fee..3a99267bb622 100644 --- a/clients/client-ssm/commands/StartAutomationExecutionCommand.ts +++ b/clients/client-ssm/commands/StartAutomationExecutionCommand.ts @@ -22,6 +22,20 @@ export interface StartAutomationExecutionCommandOutput extends StartAutomationEx /** *

Initiates execution of an Automation document.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { SSMClient, StartAutomationExecutionCommand } from "@aws-sdk/client-ssm"; // ES Modules import + * // const { SSMClient, StartAutomationExecutionCommand } = require("@aws-sdk/client-ssm"); // CommonJS import + * const client = new SSMClient(config); + * const command = new StartAutomationExecutionCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link StartAutomationExecutionCommandInput} for command's `input` shape. + * @see {@link StartAutomationExecutionCommandOutput} for command's `response` shape. + * @see {@link SSMClientResolvedConfig | config} for command's `input` shape. + * */ export class StartAutomationExecutionCommand extends $Command< StartAutomationExecutionCommandInput, diff --git a/clients/client-ssm/commands/StartChangeRequestExecutionCommand.ts b/clients/client-ssm/commands/StartChangeRequestExecutionCommand.ts index ad7a73d546b8..de6dbf4f4ba1 100644 --- a/clients/client-ssm/commands/StartChangeRequestExecutionCommand.ts +++ b/clients/client-ssm/commands/StartChangeRequestExecutionCommand.ts @@ -24,6 +24,20 @@ export interface StartChangeRequestExecutionCommandOutput extends StartChangeReq *

Creates a change request for Change Manager. The runbooks (Automation documents) specified in the * change request run only after all required approvals for the change request have been * received.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { SSMClient, StartChangeRequestExecutionCommand } from "@aws-sdk/client-ssm"; // ES Modules import + * // const { SSMClient, StartChangeRequestExecutionCommand } = require("@aws-sdk/client-ssm"); // CommonJS import + * const client = new SSMClient(config); + * const command = new StartChangeRequestExecutionCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link StartChangeRequestExecutionCommandInput} for command's `input` shape. + * @see {@link StartChangeRequestExecutionCommandOutput} for command's `response` shape. + * @see {@link SSMClientResolvedConfig | config} for command's `input` shape. + * */ export class StartChangeRequestExecutionCommand extends $Command< StartChangeRequestExecutionCommandInput, diff --git a/clients/client-ssm/commands/StartSessionCommand.ts b/clients/client-ssm/commands/StartSessionCommand.ts index 02cdc9b59036..e53e53136acb 100644 --- a/clients/client-ssm/commands/StartSessionCommand.ts +++ b/clients/client-ssm/commands/StartSessionCommand.ts @@ -31,6 +31,20 @@ export interface StartSessionCommandOutput extends StartSessionResponse, __Metad *

AWS Tools for PowerShell usage: Start-SSMSession is not currently supported by AWS Tools * for PowerShell on Windows local machines.

* + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { SSMClient, StartSessionCommand } from "@aws-sdk/client-ssm"; // ES Modules import + * // const { SSMClient, StartSessionCommand } = require("@aws-sdk/client-ssm"); // CommonJS import + * const client = new SSMClient(config); + * const command = new StartSessionCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link StartSessionCommandInput} for command's `input` shape. + * @see {@link StartSessionCommandOutput} for command's `response` shape. + * @see {@link SSMClientResolvedConfig | config} for command's `input` shape. + * */ export class StartSessionCommand extends $Command< StartSessionCommandInput, diff --git a/clients/client-ssm/commands/StopAutomationExecutionCommand.ts b/clients/client-ssm/commands/StopAutomationExecutionCommand.ts index ee55e09e8848..57e533bcf66e 100644 --- a/clients/client-ssm/commands/StopAutomationExecutionCommand.ts +++ b/clients/client-ssm/commands/StopAutomationExecutionCommand.ts @@ -22,6 +22,20 @@ export interface StopAutomationExecutionCommandOutput extends StopAutomationExec /** *

Stop an Automation that is currently running.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { SSMClient, StopAutomationExecutionCommand } from "@aws-sdk/client-ssm"; // ES Modules import + * // const { SSMClient, StopAutomationExecutionCommand } = require("@aws-sdk/client-ssm"); // CommonJS import + * const client = new SSMClient(config); + * const command = new StopAutomationExecutionCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link StopAutomationExecutionCommandInput} for command's `input` shape. + * @see {@link StopAutomationExecutionCommandOutput} for command's `response` shape. + * @see {@link SSMClientResolvedConfig | config} for command's `input` shape. + * */ export class StopAutomationExecutionCommand extends $Command< StopAutomationExecutionCommandInput, diff --git a/clients/client-ssm/commands/TerminateSessionCommand.ts b/clients/client-ssm/commands/TerminateSessionCommand.ts index 0784a34c7b3b..3f7c50244783 100644 --- a/clients/client-ssm/commands/TerminateSessionCommand.ts +++ b/clients/client-ssm/commands/TerminateSessionCommand.ts @@ -23,6 +23,20 @@ export interface TerminateSessionCommandOutput extends TerminateSessionResponse, /** *

Permanently ends a session and closes the data connection between the Session Manager client and * SSM Agent on the instance. A terminated session cannot be resumed.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { SSMClient, TerminateSessionCommand } from "@aws-sdk/client-ssm"; // ES Modules import + * // const { SSMClient, TerminateSessionCommand } = require("@aws-sdk/client-ssm"); // CommonJS import + * const client = new SSMClient(config); + * const command = new TerminateSessionCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link TerminateSessionCommandInput} for command's `input` shape. + * @see {@link TerminateSessionCommandOutput} for command's `response` shape. + * @see {@link SSMClientResolvedConfig | config} for command's `input` shape. + * */ export class TerminateSessionCommand extends $Command< TerminateSessionCommandInput, diff --git a/clients/client-ssm/commands/UnlabelParameterVersionCommand.ts b/clients/client-ssm/commands/UnlabelParameterVersionCommand.ts index 8a10eb5981e0..995157a9d0fc 100644 --- a/clients/client-ssm/commands/UnlabelParameterVersionCommand.ts +++ b/clients/client-ssm/commands/UnlabelParameterVersionCommand.ts @@ -22,6 +22,20 @@ export interface UnlabelParameterVersionCommandOutput extends UnlabelParameterVe /** *

Remove a label or labels from a parameter.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { SSMClient, UnlabelParameterVersionCommand } from "@aws-sdk/client-ssm"; // ES Modules import + * // const { SSMClient, UnlabelParameterVersionCommand } = require("@aws-sdk/client-ssm"); // CommonJS import + * const client = new SSMClient(config); + * const command = new UnlabelParameterVersionCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link UnlabelParameterVersionCommandInput} for command's `input` shape. + * @see {@link UnlabelParameterVersionCommandOutput} for command's `response` shape. + * @see {@link SSMClientResolvedConfig | config} for command's `input` shape. + * */ export class UnlabelParameterVersionCommand extends $Command< UnlabelParameterVersionCommandInput, diff --git a/clients/client-ssm/commands/UpdateAssociationCommand.ts b/clients/client-ssm/commands/UpdateAssociationCommand.ts index a6bf2fae21d8..66239fd49f98 100644 --- a/clients/client-ssm/commands/UpdateAssociationCommand.ts +++ b/clients/client-ssm/commands/UpdateAssociationCommand.ts @@ -34,6 +34,20 @@ export interface UpdateAssociationCommandOutput extends UpdateAssociationResult, *

When you update an association, the association immediately runs against the specified * targets.

* + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { SSMClient, UpdateAssociationCommand } from "@aws-sdk/client-ssm"; // ES Modules import + * // const { SSMClient, UpdateAssociationCommand } = require("@aws-sdk/client-ssm"); // CommonJS import + * const client = new SSMClient(config); + * const command = new UpdateAssociationCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link UpdateAssociationCommandInput} for command's `input` shape. + * @see {@link UpdateAssociationCommandOutput} for command's `response` shape. + * @see {@link SSMClientResolvedConfig | config} for command's `input` shape. + * */ export class UpdateAssociationCommand extends $Command< UpdateAssociationCommandInput, diff --git a/clients/client-ssm/commands/UpdateAssociationStatusCommand.ts b/clients/client-ssm/commands/UpdateAssociationStatusCommand.ts index 4f78c911080c..d70baf2429ea 100644 --- a/clients/client-ssm/commands/UpdateAssociationStatusCommand.ts +++ b/clients/client-ssm/commands/UpdateAssociationStatusCommand.ts @@ -22,6 +22,20 @@ export interface UpdateAssociationStatusCommandOutput extends UpdateAssociationS /** *

Updates the status of the Systems Manager document associated with the specified instance.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { SSMClient, UpdateAssociationStatusCommand } from "@aws-sdk/client-ssm"; // ES Modules import + * // const { SSMClient, UpdateAssociationStatusCommand } = require("@aws-sdk/client-ssm"); // CommonJS import + * const client = new SSMClient(config); + * const command = new UpdateAssociationStatusCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link UpdateAssociationStatusCommandInput} for command's `input` shape. + * @see {@link UpdateAssociationStatusCommandOutput} for command's `response` shape. + * @see {@link SSMClientResolvedConfig | config} for command's `input` shape. + * */ export class UpdateAssociationStatusCommand extends $Command< UpdateAssociationStatusCommandInput, diff --git a/clients/client-ssm/commands/UpdateDocumentCommand.ts b/clients/client-ssm/commands/UpdateDocumentCommand.ts index 873385a32ed6..ff80e4eec622 100644 --- a/clients/client-ssm/commands/UpdateDocumentCommand.ts +++ b/clients/client-ssm/commands/UpdateDocumentCommand.ts @@ -22,6 +22,20 @@ export interface UpdateDocumentCommandOutput extends UpdateDocumentResult, __Met /** *

Updates one or more values for an SSM document.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { SSMClient, UpdateDocumentCommand } from "@aws-sdk/client-ssm"; // ES Modules import + * // const { SSMClient, UpdateDocumentCommand } = require("@aws-sdk/client-ssm"); // CommonJS import + * const client = new SSMClient(config); + * const command = new UpdateDocumentCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link UpdateDocumentCommandInput} for command's `input` shape. + * @see {@link UpdateDocumentCommandOutput} for command's `response` shape. + * @see {@link SSMClientResolvedConfig | config} for command's `input` shape. + * */ export class UpdateDocumentCommand extends $Command< UpdateDocumentCommandInput, diff --git a/clients/client-ssm/commands/UpdateDocumentDefaultVersionCommand.ts b/clients/client-ssm/commands/UpdateDocumentDefaultVersionCommand.ts index c854d3d69cb8..f0ce778637e6 100644 --- a/clients/client-ssm/commands/UpdateDocumentDefaultVersionCommand.ts +++ b/clients/client-ssm/commands/UpdateDocumentDefaultVersionCommand.ts @@ -24,6 +24,20 @@ export interface UpdateDocumentDefaultVersionCommandOutput /** *

Set the default version of a document.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { SSMClient, UpdateDocumentDefaultVersionCommand } from "@aws-sdk/client-ssm"; // ES Modules import + * // const { SSMClient, UpdateDocumentDefaultVersionCommand } = require("@aws-sdk/client-ssm"); // CommonJS import + * const client = new SSMClient(config); + * const command = new UpdateDocumentDefaultVersionCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link UpdateDocumentDefaultVersionCommandInput} for command's `input` shape. + * @see {@link UpdateDocumentDefaultVersionCommandOutput} for command's `response` shape. + * @see {@link SSMClientResolvedConfig | config} for command's `input` shape. + * */ export class UpdateDocumentDefaultVersionCommand extends $Command< UpdateDocumentDefaultVersionCommandInput, diff --git a/clients/client-ssm/commands/UpdateDocumentMetadataCommand.ts b/clients/client-ssm/commands/UpdateDocumentMetadataCommand.ts index b09a0290791d..d4415d7c91be 100644 --- a/clients/client-ssm/commands/UpdateDocumentMetadataCommand.ts +++ b/clients/client-ssm/commands/UpdateDocumentMetadataCommand.ts @@ -22,6 +22,20 @@ export interface UpdateDocumentMetadataCommandOutput extends UpdateDocumentMetad /** *

Updates information related to approval reviews for a specific version of a document.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { SSMClient, UpdateDocumentMetadataCommand } from "@aws-sdk/client-ssm"; // ES Modules import + * // const { SSMClient, UpdateDocumentMetadataCommand } = require("@aws-sdk/client-ssm"); // CommonJS import + * const client = new SSMClient(config); + * const command = new UpdateDocumentMetadataCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link UpdateDocumentMetadataCommandInput} for command's `input` shape. + * @see {@link UpdateDocumentMetadataCommandOutput} for command's `response` shape. + * @see {@link SSMClientResolvedConfig | config} for command's `input` shape. + * */ export class UpdateDocumentMetadataCommand extends $Command< UpdateDocumentMetadataCommandInput, diff --git a/clients/client-ssm/commands/UpdateMaintenanceWindowCommand.ts b/clients/client-ssm/commands/UpdateMaintenanceWindowCommand.ts index 3de6d289dd8c..8e4834fee210 100644 --- a/clients/client-ssm/commands/UpdateMaintenanceWindowCommand.ts +++ b/clients/client-ssm/commands/UpdateMaintenanceWindowCommand.ts @@ -30,6 +30,20 @@ export interface UpdateMaintenanceWindowCommandOutput extends UpdateMaintenanceW * value you specify for Cutoff is one hour, no maintenance window tasks can start * after 5 PM.

* + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { SSMClient, UpdateMaintenanceWindowCommand } from "@aws-sdk/client-ssm"; // ES Modules import + * // const { SSMClient, UpdateMaintenanceWindowCommand } = require("@aws-sdk/client-ssm"); // CommonJS import + * const client = new SSMClient(config); + * const command = new UpdateMaintenanceWindowCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link UpdateMaintenanceWindowCommandInput} for command's `input` shape. + * @see {@link UpdateMaintenanceWindowCommandOutput} for command's `response` shape. + * @see {@link SSMClientResolvedConfig | config} for command's `input` shape. + * */ export class UpdateMaintenanceWindowCommand extends $Command< UpdateMaintenanceWindowCommandInput, diff --git a/clients/client-ssm/commands/UpdateMaintenanceWindowTargetCommand.ts b/clients/client-ssm/commands/UpdateMaintenanceWindowTargetCommand.ts index 62729febf2c0..f81e492f7b1b 100644 --- a/clients/client-ssm/commands/UpdateMaintenanceWindowTargetCommand.ts +++ b/clients/client-ssm/commands/UpdateMaintenanceWindowTargetCommand.ts @@ -50,6 +50,20 @@ export interface UpdateMaintenanceWindowTargetCommandOutput * *

If a parameter is null, then the corresponding field is not modified.

* + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { SSMClient, UpdateMaintenanceWindowTargetCommand } from "@aws-sdk/client-ssm"; // ES Modules import + * // const { SSMClient, UpdateMaintenanceWindowTargetCommand } = require("@aws-sdk/client-ssm"); // CommonJS import + * const client = new SSMClient(config); + * const command = new UpdateMaintenanceWindowTargetCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link UpdateMaintenanceWindowTargetCommandInput} for command's `input` shape. + * @see {@link UpdateMaintenanceWindowTargetCommandOutput} for command's `response` shape. + * @see {@link SSMClientResolvedConfig | config} for command's `input` shape. + * */ export class UpdateMaintenanceWindowTargetCommand extends $Command< UpdateMaintenanceWindowTargetCommandInput, diff --git a/clients/client-ssm/commands/UpdateMaintenanceWindowTaskCommand.ts b/clients/client-ssm/commands/UpdateMaintenanceWindowTaskCommand.ts index f1030a1c5677..582b7978262a 100644 --- a/clients/client-ssm/commands/UpdateMaintenanceWindowTaskCommand.ts +++ b/clients/client-ssm/commands/UpdateMaintenanceWindowTaskCommand.ts @@ -66,6 +66,20 @@ export interface UpdateMaintenanceWindowTaskCommandOutput extends UpdateMaintena * maintenance window task and specify only a different OutputS3BucketName value, the * values for Comment and NotificationConfig are removed.

* + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { SSMClient, UpdateMaintenanceWindowTaskCommand } from "@aws-sdk/client-ssm"; // ES Modules import + * // const { SSMClient, UpdateMaintenanceWindowTaskCommand } = require("@aws-sdk/client-ssm"); // CommonJS import + * const client = new SSMClient(config); + * const command = new UpdateMaintenanceWindowTaskCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link UpdateMaintenanceWindowTaskCommandInput} for command's `input` shape. + * @see {@link UpdateMaintenanceWindowTaskCommandOutput} for command's `response` shape. + * @see {@link SSMClientResolvedConfig | config} for command's `input` shape. + * */ export class UpdateMaintenanceWindowTaskCommand extends $Command< UpdateMaintenanceWindowTaskCommandInput, diff --git a/clients/client-ssm/commands/UpdateManagedInstanceRoleCommand.ts b/clients/client-ssm/commands/UpdateManagedInstanceRoleCommand.ts index 66065392550d..6bcff94e418e 100644 --- a/clients/client-ssm/commands/UpdateManagedInstanceRoleCommand.ts +++ b/clients/client-ssm/commands/UpdateManagedInstanceRoleCommand.ts @@ -24,6 +24,20 @@ export interface UpdateManagedInstanceRoleCommandOutput extends UpdateManagedIns *

Changes the Amazon Identity and Access Management (IAM) role that is assigned to the * on-premises instance or virtual machines (VM). IAM roles are first assigned to these hybrid * instances during the activation process. For more information, see CreateActivation.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { SSMClient, UpdateManagedInstanceRoleCommand } from "@aws-sdk/client-ssm"; // ES Modules import + * // const { SSMClient, UpdateManagedInstanceRoleCommand } = require("@aws-sdk/client-ssm"); // CommonJS import + * const client = new SSMClient(config); + * const command = new UpdateManagedInstanceRoleCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link UpdateManagedInstanceRoleCommandInput} for command's `input` shape. + * @see {@link UpdateManagedInstanceRoleCommandOutput} for command's `response` shape. + * @see {@link SSMClientResolvedConfig | config} for command's `input` shape. + * */ export class UpdateManagedInstanceRoleCommand extends $Command< UpdateManagedInstanceRoleCommandInput, diff --git a/clients/client-ssm/commands/UpdateOpsItemCommand.ts b/clients/client-ssm/commands/UpdateOpsItemCommand.ts index e056cb6228a0..9bac6e9ac25f 100644 --- a/clients/client-ssm/commands/UpdateOpsItemCommand.ts +++ b/clients/client-ssm/commands/UpdateOpsItemCommand.ts @@ -28,6 +28,20 @@ export interface UpdateOpsItemCommandOutput extends UpdateOpsItemResponse, __Met * operational issues impacting the performance and health of their AWS resources. For more * information, see AWS Systems Manager OpsCenter in the * AWS Systems Manager User Guide.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { SSMClient, UpdateOpsItemCommand } from "@aws-sdk/client-ssm"; // ES Modules import + * // const { SSMClient, UpdateOpsItemCommand } = require("@aws-sdk/client-ssm"); // CommonJS import + * const client = new SSMClient(config); + * const command = new UpdateOpsItemCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link UpdateOpsItemCommandInput} for command's `input` shape. + * @see {@link UpdateOpsItemCommandOutput} for command's `response` shape. + * @see {@link SSMClientResolvedConfig | config} for command's `input` shape. + * */ export class UpdateOpsItemCommand extends $Command< UpdateOpsItemCommandInput, diff --git a/clients/client-ssm/commands/UpdateOpsMetadataCommand.ts b/clients/client-ssm/commands/UpdateOpsMetadataCommand.ts index e6262eef0f73..59623ec31b10 100644 --- a/clients/client-ssm/commands/UpdateOpsMetadataCommand.ts +++ b/clients/client-ssm/commands/UpdateOpsMetadataCommand.ts @@ -22,6 +22,20 @@ export interface UpdateOpsMetadataCommandOutput extends UpdateOpsMetadataResult, /** *

Systems Manager calls this API action when you edit OpsMetadata in Application Manager.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { SSMClient, UpdateOpsMetadataCommand } from "@aws-sdk/client-ssm"; // ES Modules import + * // const { SSMClient, UpdateOpsMetadataCommand } = require("@aws-sdk/client-ssm"); // CommonJS import + * const client = new SSMClient(config); + * const command = new UpdateOpsMetadataCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link UpdateOpsMetadataCommandInput} for command's `input` shape. + * @see {@link UpdateOpsMetadataCommandOutput} for command's `response` shape. + * @see {@link SSMClientResolvedConfig | config} for command's `input` shape. + * */ export class UpdateOpsMetadataCommand extends $Command< UpdateOpsMetadataCommandInput, diff --git a/clients/client-ssm/commands/UpdatePatchBaselineCommand.ts b/clients/client-ssm/commands/UpdatePatchBaselineCommand.ts index ff03f0bb0384..0c79dde68c44 100644 --- a/clients/client-ssm/commands/UpdatePatchBaselineCommand.ts +++ b/clients/client-ssm/commands/UpdatePatchBaselineCommand.ts @@ -28,6 +28,20 @@ export interface UpdatePatchBaselineCommandOutput extends UpdatePatchBaselineRes *

For information about valid key and value pairs in PatchFilters for each * supported operating system type, see PatchFilter.

* + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { SSMClient, UpdatePatchBaselineCommand } from "@aws-sdk/client-ssm"; // ES Modules import + * // const { SSMClient, UpdatePatchBaselineCommand } = require("@aws-sdk/client-ssm"); // CommonJS import + * const client = new SSMClient(config); + * const command = new UpdatePatchBaselineCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link UpdatePatchBaselineCommandInput} for command's `input` shape. + * @see {@link UpdatePatchBaselineCommandOutput} for command's `response` shape. + * @see {@link SSMClientResolvedConfig | config} for command's `input` shape. + * */ export class UpdatePatchBaselineCommand extends $Command< UpdatePatchBaselineCommandInput, diff --git a/clients/client-ssm/commands/UpdateResourceDataSyncCommand.ts b/clients/client-ssm/commands/UpdateResourceDataSyncCommand.ts index 18f6a0a4f108..b9285a5edb64 100644 --- a/clients/client-ssm/commands/UpdateResourceDataSyncCommand.ts +++ b/clients/client-ssm/commands/UpdateResourceDataSyncCommand.ts @@ -30,6 +30,20 @@ export interface UpdateResourceDataSyncCommandOutput extends UpdateResourceDataS *

This API action only supports a resource data sync that was created with a SyncFromSource * SyncType.

* + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { SSMClient, UpdateResourceDataSyncCommand } from "@aws-sdk/client-ssm"; // ES Modules import + * // const { SSMClient, UpdateResourceDataSyncCommand } = require("@aws-sdk/client-ssm"); // CommonJS import + * const client = new SSMClient(config); + * const command = new UpdateResourceDataSyncCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link UpdateResourceDataSyncCommandInput} for command's `input` shape. + * @see {@link UpdateResourceDataSyncCommandOutput} for command's `response` shape. + * @see {@link SSMClientResolvedConfig | config} for command's `input` shape. + * */ export class UpdateResourceDataSyncCommand extends $Command< UpdateResourceDataSyncCommandInput, diff --git a/clients/client-ssm/commands/UpdateServiceSettingCommand.ts b/clients/client-ssm/commands/UpdateServiceSettingCommand.ts index f8d1c45c5857..7b983371a2e4 100644 --- a/clients/client-ssm/commands/UpdateServiceSettingCommand.ts +++ b/clients/client-ssm/commands/UpdateServiceSettingCommand.ts @@ -35,6 +35,20 @@ export interface UpdateServiceSettingCommandOutput extends UpdateServiceSettingR * original value defined by the AWS service team.

* *

Update the service setting for the account.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { SSMClient, UpdateServiceSettingCommand } from "@aws-sdk/client-ssm"; // ES Modules import + * // const { SSMClient, UpdateServiceSettingCommand } = require("@aws-sdk/client-ssm"); // CommonJS import + * const client = new SSMClient(config); + * const command = new UpdateServiceSettingCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link UpdateServiceSettingCommandInput} for command's `input` shape. + * @see {@link UpdateServiceSettingCommandOutput} for command's `response` shape. + * @see {@link SSMClientResolvedConfig | config} for command's `input` shape. + * */ export class UpdateServiceSettingCommand extends $Command< UpdateServiceSettingCommandInput, diff --git a/clients/client-ssm/models/models_0.ts b/clients/client-ssm/models/models_0.ts index a961bea54cb1..eb85937ed529 100644 --- a/clients/client-ssm/models/models_0.ts +++ b/clients/client-ssm/models/models_0.ts @@ -18,6 +18,9 @@ export interface AccountSharingInfo { } export namespace AccountSharingInfo { + /** + * @internal + */ export const filterSensitiveLog = (obj: AccountSharingInfo): any => ({ ...obj, }); @@ -42,6 +45,9 @@ export interface Tag { } export namespace Tag { + /** + * @internal + */ export const filterSensitiveLog = (obj: Tag): any => ({ ...obj, }); @@ -106,6 +112,9 @@ export interface Activation { } export namespace Activation { + /** + * @internal + */ export const filterSensitiveLog = (obj: Activation): any => ({ ...obj, }); @@ -164,6 +173,9 @@ export interface AddTagsToResourceRequest { } export namespace AddTagsToResourceRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: AddTagsToResourceRequest): any => ({ ...obj, }); @@ -172,6 +184,9 @@ export namespace AddTagsToResourceRequest { export interface AddTagsToResourceResult {} export namespace AddTagsToResourceResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: AddTagsToResourceResult): any => ({ ...obj, }); @@ -187,6 +202,9 @@ export interface InternalServerError extends __SmithyException, $MetadataBearer } export namespace InternalServerError { + /** + * @internal + */ export const filterSensitiveLog = (obj: InternalServerError): any => ({ ...obj, }); @@ -201,6 +219,9 @@ export interface InvalidResourceId extends __SmithyException, $MetadataBearer { } export namespace InvalidResourceId { + /** + * @internal + */ export const filterSensitiveLog = (obj: InvalidResourceId): any => ({ ...obj, }); @@ -216,6 +237,9 @@ export interface InvalidResourceType extends __SmithyException, $MetadataBearer } export namespace InvalidResourceType { + /** + * @internal + */ export const filterSensitiveLog = (obj: InvalidResourceType): any => ({ ...obj, }); @@ -231,6 +255,9 @@ export interface TooManyTagsError extends __SmithyException, $MetadataBearer { } export namespace TooManyTagsError { + /** + * @internal + */ export const filterSensitiveLog = (obj: TooManyTagsError): any => ({ ...obj, }); @@ -246,6 +273,9 @@ export interface TooManyUpdates extends __SmithyException, $MetadataBearer { } export namespace TooManyUpdates { + /** + * @internal + */ export const filterSensitiveLog = (obj: TooManyUpdates): any => ({ ...obj, }); @@ -262,6 +292,9 @@ export interface AlreadyExistsException extends __SmithyException, $MetadataBear } export namespace AlreadyExistsException { + /** + * @internal + */ export const filterSensitiveLog = (obj: AlreadyExistsException): any => ({ ...obj, }); @@ -284,6 +317,9 @@ export interface CancelCommandRequest { } export namespace CancelCommandRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: CancelCommandRequest): any => ({ ...obj, }); @@ -296,6 +332,9 @@ export namespace CancelCommandRequest { export interface CancelCommandResult {} export namespace CancelCommandResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: CancelCommandResult): any => ({ ...obj, }); @@ -310,6 +349,9 @@ export interface DuplicateInstanceId extends __SmithyException, $MetadataBearer } export namespace DuplicateInstanceId { + /** + * @internal + */ export const filterSensitiveLog = (obj: DuplicateInstanceId): any => ({ ...obj, }); @@ -321,6 +363,9 @@ export interface InvalidCommandId extends __SmithyException, $MetadataBearer { } export namespace InvalidCommandId { + /** + * @internal + */ export const filterSensitiveLog = (obj: InvalidCommandId): any => ({ ...obj, }); @@ -341,6 +386,9 @@ export interface InvalidInstanceId extends __SmithyException, $MetadataBearer { } export namespace InvalidInstanceId { + /** + * @internal + */ export const filterSensitiveLog = (obj: InvalidInstanceId): any => ({ ...obj, }); @@ -354,6 +402,9 @@ export interface CancelMaintenanceWindowExecutionRequest { } export namespace CancelMaintenanceWindowExecutionRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: CancelMaintenanceWindowExecutionRequest): any => ({ ...obj, }); @@ -367,6 +418,9 @@ export interface CancelMaintenanceWindowExecutionResult { } export namespace CancelMaintenanceWindowExecutionResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: CancelMaintenanceWindowExecutionResult): any => ({ ...obj, }); @@ -385,6 +439,9 @@ export interface DoesNotExistException extends __SmithyException, $MetadataBeare } export namespace DoesNotExistException { + /** + * @internal + */ export const filterSensitiveLog = (obj: DoesNotExistException): any => ({ ...obj, }); @@ -463,6 +520,9 @@ export interface CreateActivationRequest { } export namespace CreateActivationRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateActivationRequest): any => ({ ...obj, }); @@ -483,6 +543,9 @@ export interface CreateActivationResult { } export namespace CreateActivationResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateActivationResult): any => ({ ...obj, }); @@ -497,6 +560,9 @@ export interface AssociationAlreadyExists extends __SmithyException, $MetadataBe } export namespace AssociationAlreadyExists { + /** + * @internal + */ export const filterSensitiveLog = (obj: AssociationAlreadyExists): any => ({ ...obj, }); @@ -511,6 +577,9 @@ export interface AssociationLimitExceeded extends __SmithyException, $MetadataBe } export namespace AssociationLimitExceeded { + /** + * @internal + */ export const filterSensitiveLog = (obj: AssociationLimitExceeded): any => ({ ...obj, }); @@ -546,6 +615,9 @@ export interface S3OutputLocation { } export namespace S3OutputLocation { + /** + * @internal + */ export const filterSensitiveLog = (obj: S3OutputLocation): any => ({ ...obj, }); @@ -564,6 +636,9 @@ export interface InstanceAssociationOutputLocation { } export namespace InstanceAssociationOutputLocation { + /** + * @internal + */ export const filterSensitiveLog = (obj: InstanceAssociationOutputLocation): any => ({ ...obj, }); @@ -609,6 +684,9 @@ export interface TargetLocation { } export namespace TargetLocation { + /** + * @internal + */ export const filterSensitiveLog = (obj: TargetLocation): any => ({ ...obj, }); @@ -737,6 +815,9 @@ export interface Target { } export namespace Target { + /** + * @internal + */ export const filterSensitiveLog = (obj: Target): any => ({ ...obj, }); @@ -881,6 +962,9 @@ export interface CreateAssociationRequest { } export namespace CreateAssociationRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateAssociationRequest): any => ({ ...obj, }); @@ -909,6 +993,9 @@ export interface AssociationOverview { } export namespace AssociationOverview { + /** + * @internal + */ export const filterSensitiveLog = (obj: AssociationOverview): any => ({ ...obj, }); @@ -946,6 +1033,9 @@ export interface AssociationStatus { } export namespace AssociationStatus { + /** + * @internal + */ export const filterSensitiveLog = (obj: AssociationStatus): any => ({ ...obj, }); @@ -1101,6 +1191,9 @@ export interface AssociationDescription { } export namespace AssociationDescription { + /** + * @internal + */ export const filterSensitiveLog = (obj: AssociationDescription): any => ({ ...obj, }); @@ -1114,6 +1207,9 @@ export interface CreateAssociationResult { } export namespace CreateAssociationResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateAssociationResult): any => ({ ...obj, }); @@ -1135,6 +1231,9 @@ export interface InvalidDocument extends __SmithyException, $MetadataBearer { } export namespace InvalidDocument { + /** + * @internal + */ export const filterSensitiveLog = (obj: InvalidDocument): any => ({ ...obj, }); @@ -1150,6 +1249,9 @@ export interface InvalidDocumentVersion extends __SmithyException, $MetadataBear } export namespace InvalidDocumentVersion { + /** + * @internal + */ export const filterSensitiveLog = (obj: InvalidDocumentVersion): any => ({ ...obj, }); @@ -1164,6 +1266,9 @@ export interface InvalidOutputLocation extends __SmithyException, $MetadataBeare } export namespace InvalidOutputLocation { + /** + * @internal + */ export const filterSensitiveLog = (obj: InvalidOutputLocation): any => ({ ...obj, }); @@ -1180,6 +1285,9 @@ export interface InvalidParameters extends __SmithyException, $MetadataBearer { } export namespace InvalidParameters { + /** + * @internal + */ export const filterSensitiveLog = (obj: InvalidParameters): any => ({ ...obj, }); @@ -1195,6 +1303,9 @@ export interface InvalidSchedule extends __SmithyException, $MetadataBearer { } export namespace InvalidSchedule { + /** + * @internal + */ export const filterSensitiveLog = (obj: InvalidSchedule): any => ({ ...obj, }); @@ -1211,6 +1322,9 @@ export interface InvalidTarget extends __SmithyException, $MetadataBearer { } export namespace InvalidTarget { + /** + * @internal + */ export const filterSensitiveLog = (obj: InvalidTarget): any => ({ ...obj, }); @@ -1227,6 +1341,9 @@ export interface UnsupportedPlatformType extends __SmithyException, $MetadataBea } export namespace UnsupportedPlatformType { + /** + * @internal + */ export const filterSensitiveLog = (obj: UnsupportedPlatformType): any => ({ ...obj, }); @@ -1357,6 +1474,9 @@ export interface CreateAssociationBatchRequestEntry { } export namespace CreateAssociationBatchRequestEntry { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateAssociationBatchRequestEntry): any => ({ ...obj, }); @@ -1370,6 +1490,9 @@ export interface CreateAssociationBatchRequest { } export namespace CreateAssociationBatchRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateAssociationBatchRequest): any => ({ ...obj, }); @@ -1398,6 +1521,9 @@ export interface FailedCreateAssociation { } export namespace FailedCreateAssociation { + /** + * @internal + */ export const filterSensitiveLog = (obj: FailedCreateAssociation): any => ({ ...obj, }); @@ -1416,6 +1542,9 @@ export interface CreateAssociationBatchResult { } export namespace CreateAssociationBatchResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateAssociationBatchResult): any => ({ ...obj, }); @@ -1483,6 +1612,9 @@ export interface AttachmentsSource { } export namespace AttachmentsSource { + /** + * @internal + */ export const filterSensitiveLog = (obj: AttachmentsSource): any => ({ ...obj, }); @@ -1523,6 +1655,9 @@ export interface DocumentRequires { } export namespace DocumentRequires { + /** + * @internal + */ export const filterSensitiveLog = (obj: DocumentRequires): any => ({ ...obj, }); @@ -1653,6 +1788,9 @@ export interface CreateDocumentRequest { } export namespace CreateDocumentRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateDocumentRequest): any => ({ ...obj, }); @@ -1669,6 +1807,9 @@ export interface AttachmentInformation { } export namespace AttachmentInformation { + /** + * @internal + */ export const filterSensitiveLog = (obj: AttachmentInformation): any => ({ ...obj, }); @@ -1710,6 +1851,9 @@ export interface DocumentParameter { } export namespace DocumentParameter { + /** + * @internal + */ export const filterSensitiveLog = (obj: DocumentParameter): any => ({ ...obj, }); @@ -1748,6 +1892,9 @@ export interface ReviewInformation { } export namespace ReviewInformation { + /** + * @internal + */ export const filterSensitiveLog = (obj: ReviewInformation): any => ({ ...obj, }); @@ -1915,6 +2062,9 @@ export interface DocumentDescription { } export namespace DocumentDescription { + /** + * @internal + */ export const filterSensitiveLog = (obj: DocumentDescription): any => ({ ...obj, }); @@ -1928,6 +2078,9 @@ export interface CreateDocumentResult { } export namespace CreateDocumentResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateDocumentResult): any => ({ ...obj, }); @@ -1943,6 +2096,9 @@ export interface DocumentAlreadyExists extends __SmithyException, $MetadataBeare } export namespace DocumentAlreadyExists { + /** + * @internal + */ export const filterSensitiveLog = (obj: DocumentAlreadyExists): any => ({ ...obj, }); @@ -1958,6 +2114,9 @@ export interface DocumentLimitExceeded extends __SmithyException, $MetadataBeare } export namespace DocumentLimitExceeded { + /** + * @internal + */ export const filterSensitiveLog = (obj: DocumentLimitExceeded): any => ({ ...obj, }); @@ -1976,6 +2135,9 @@ export interface InvalidDocumentContent extends __SmithyException, $MetadataBear } export namespace InvalidDocumentContent { + /** + * @internal + */ export const filterSensitiveLog = (obj: InvalidDocumentContent): any => ({ ...obj, }); @@ -1991,6 +2153,9 @@ export interface InvalidDocumentSchemaVersion extends __SmithyException, $Metada } export namespace InvalidDocumentSchemaVersion { + /** + * @internal + */ export const filterSensitiveLog = (obj: InvalidDocumentSchemaVersion): any => ({ ...obj, }); @@ -2006,6 +2171,9 @@ export interface MaxDocumentSizeExceeded extends __SmithyException, $MetadataBea } export namespace MaxDocumentSizeExceeded { + /** + * @internal + */ export const filterSensitiveLog = (obj: MaxDocumentSizeExceeded): any => ({ ...obj, }); @@ -2120,6 +2288,9 @@ export interface CreateMaintenanceWindowRequest { } export namespace CreateMaintenanceWindowRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateMaintenanceWindowRequest): any => ({ ...obj, ...(obj.Description && { Description: SENSITIVE_STRING }), @@ -2134,6 +2305,9 @@ export interface CreateMaintenanceWindowResult { } export namespace CreateMaintenanceWindowResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateMaintenanceWindowResult): any => ({ ...obj, }); @@ -2150,6 +2324,9 @@ export interface IdempotentParameterMismatch extends __SmithyException, $Metadat } export namespace IdempotentParameterMismatch { + /** + * @internal + */ export const filterSensitiveLog = (obj: IdempotentParameterMismatch): any => ({ ...obj, }); @@ -2168,6 +2345,9 @@ export interface ResourceLimitExceededException extends __SmithyException, $Meta } export namespace ResourceLimitExceededException { + /** + * @internal + */ export const filterSensitiveLog = (obj: ResourceLimitExceededException): any => ({ ...obj, }); @@ -2185,6 +2365,9 @@ export interface OpsItemNotification { } export namespace OpsItemNotification { + /** + * @internal + */ export const filterSensitiveLog = (obj: OpsItemNotification): any => ({ ...obj, }); @@ -2212,6 +2395,9 @@ export interface OpsItemDataValue { } export namespace OpsItemDataValue { + /** + * @internal + */ export const filterSensitiveLog = (obj: OpsItemDataValue): any => ({ ...obj, }); @@ -2230,6 +2416,9 @@ export interface RelatedOpsItem { } export namespace RelatedOpsItem { + /** + * @internal + */ export const filterSensitiveLog = (obj: RelatedOpsItem): any => ({ ...obj, }); @@ -2352,6 +2541,9 @@ export interface CreateOpsItemRequest { } export namespace CreateOpsItemRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateOpsItemRequest): any => ({ ...obj, }); @@ -2365,6 +2557,9 @@ export interface CreateOpsItemResponse { } export namespace CreateOpsItemResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateOpsItemResponse): any => ({ ...obj, }); @@ -2381,6 +2576,9 @@ export interface OpsItemAlreadyExistsException extends __SmithyException, $Metad } export namespace OpsItemAlreadyExistsException { + /** + * @internal + */ export const filterSensitiveLog = (obj: OpsItemAlreadyExistsException): any => ({ ...obj, }); @@ -2398,6 +2596,9 @@ export interface OpsItemInvalidParameterException extends __SmithyException, $Me } export namespace OpsItemInvalidParameterException { + /** + * @internal + */ export const filterSensitiveLog = (obj: OpsItemInvalidParameterException): any => ({ ...obj, }); @@ -2417,6 +2618,9 @@ export interface OpsItemLimitExceededException extends __SmithyException, $Metad } export namespace OpsItemLimitExceededException { + /** + * @internal + */ export const filterSensitiveLog = (obj: OpsItemLimitExceededException): any => ({ ...obj, }); @@ -2433,6 +2637,9 @@ export interface MetadataValue { } export namespace MetadataValue { + /** + * @internal + */ export const filterSensitiveLog = (obj: MetadataValue): any => ({ ...obj, }); @@ -2472,6 +2679,9 @@ export interface CreateOpsMetadataRequest { } export namespace CreateOpsMetadataRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateOpsMetadataRequest): any => ({ ...obj, }); @@ -2485,6 +2695,9 @@ export interface CreateOpsMetadataResult { } export namespace CreateOpsMetadataResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateOpsMetadataResult): any => ({ ...obj, }); @@ -2500,6 +2713,9 @@ export interface OpsMetadataAlreadyExistsException extends __SmithyException, $M } export namespace OpsMetadataAlreadyExistsException { + /** + * @internal + */ export const filterSensitiveLog = (obj: OpsMetadataAlreadyExistsException): any => ({ ...obj, }); @@ -2515,6 +2731,9 @@ export interface OpsMetadataInvalidArgumentException extends __SmithyException, } export namespace OpsMetadataInvalidArgumentException { + /** + * @internal + */ export const filterSensitiveLog = (obj: OpsMetadataInvalidArgumentException): any => ({ ...obj, }); @@ -2531,6 +2750,9 @@ export interface OpsMetadataLimitExceededException extends __SmithyException, $M } export namespace OpsMetadataLimitExceededException { + /** + * @internal + */ export const filterSensitiveLog = (obj: OpsMetadataLimitExceededException): any => ({ ...obj, }); @@ -2547,6 +2769,9 @@ export interface OpsMetadataTooManyUpdatesException extends __SmithyException, $ } export namespace OpsMetadataTooManyUpdatesException { + /** + * @internal + */ export const filterSensitiveLog = (obj: OpsMetadataTooManyUpdatesException): any => ({ ...obj, }); @@ -2613,6 +2838,9 @@ export interface PatchFilter { } export namespace PatchFilter { + /** + * @internal + */ export const filterSensitiveLog = (obj: PatchFilter): any => ({ ...obj, }); @@ -2629,6 +2857,9 @@ export interface PatchFilterGroup { } export namespace PatchFilterGroup { + /** + * @internal + */ export const filterSensitiveLog = (obj: PatchFilterGroup): any => ({ ...obj, }); @@ -2673,6 +2904,9 @@ export interface PatchRule { } export namespace PatchRule { + /** + * @internal + */ export const filterSensitiveLog = (obj: PatchRule): any => ({ ...obj, }); @@ -2689,6 +2923,9 @@ export interface PatchRuleGroup { } export namespace PatchRuleGroup { + /** + * @internal + */ export const filterSensitiveLog = (obj: PatchRuleGroup): any => ({ ...obj, }); @@ -2752,6 +2989,9 @@ export interface PatchSource { } export namespace PatchSource { + /** + * @internal + */ export const filterSensitiveLog = (obj: PatchSource): any => ({ ...obj, ...(obj.Configuration && { Configuration: SENSITIVE_STRING }), @@ -2874,6 +3114,9 @@ export interface CreatePatchBaselineRequest { } export namespace CreatePatchBaselineRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreatePatchBaselineRequest): any => ({ ...obj, ...(obj.Sources && { Sources: obj.Sources.map((item) => PatchSource.filterSensitiveLog(item)) }), @@ -2888,6 +3131,9 @@ export interface CreatePatchBaselineResult { } export namespace CreatePatchBaselineResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreatePatchBaselineResult): any => ({ ...obj, }); @@ -2906,6 +3152,9 @@ export interface ResourceDataSyncDestinationDataSharing { } export namespace ResourceDataSyncDestinationDataSharing { + /** + * @internal + */ export const filterSensitiveLog = (obj: ResourceDataSyncDestinationDataSharing): any => ({ ...obj, }); @@ -2952,6 +3201,9 @@ export interface ResourceDataSyncS3Destination { } export namespace ResourceDataSyncS3Destination { + /** + * @internal + */ export const filterSensitiveLog = (obj: ResourceDataSyncS3Destination): any => ({ ...obj, }); @@ -2968,6 +3220,9 @@ export interface ResourceDataSyncOrganizationalUnit { } export namespace ResourceDataSyncOrganizationalUnit { + /** + * @internal + */ export const filterSensitiveLog = (obj: ResourceDataSyncOrganizationalUnit): any => ({ ...obj, }); @@ -2994,6 +3249,9 @@ export interface ResourceDataSyncAwsOrganizationsSource { } export namespace ResourceDataSyncAwsOrganizationsSource { + /** + * @internal + */ export const filterSensitiveLog = (obj: ResourceDataSyncAwsOrganizationsSource): any => ({ ...obj, }); @@ -3037,6 +3295,9 @@ export interface ResourceDataSyncSource { } export namespace ResourceDataSyncSource { + /** + * @internal + */ export const filterSensitiveLog = (obj: ResourceDataSyncSource): any => ({ ...obj, }); @@ -3072,6 +3333,9 @@ export interface CreateResourceDataSyncRequest { } export namespace CreateResourceDataSyncRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateResourceDataSyncRequest): any => ({ ...obj, }); @@ -3080,6 +3344,9 @@ export namespace CreateResourceDataSyncRequest { export interface CreateResourceDataSyncResult {} export namespace CreateResourceDataSyncResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateResourceDataSyncResult): any => ({ ...obj, }); @@ -3095,6 +3362,9 @@ export interface ResourceDataSyncAlreadyExistsException extends __SmithyExceptio } export namespace ResourceDataSyncAlreadyExistsException { + /** + * @internal + */ export const filterSensitiveLog = (obj: ResourceDataSyncAlreadyExistsException): any => ({ ...obj, }); @@ -3110,6 +3380,9 @@ export interface ResourceDataSyncCountExceededException extends __SmithyExceptio } export namespace ResourceDataSyncCountExceededException { + /** + * @internal + */ export const filterSensitiveLog = (obj: ResourceDataSyncCountExceededException): any => ({ ...obj, }); @@ -3125,6 +3398,9 @@ export interface ResourceDataSyncInvalidConfigurationException extends __SmithyE } export namespace ResourceDataSyncInvalidConfigurationException { + /** + * @internal + */ export const filterSensitiveLog = (obj: ResourceDataSyncInvalidConfigurationException): any => ({ ...obj, }); @@ -3138,6 +3414,9 @@ export interface DeleteActivationRequest { } export namespace DeleteActivationRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteActivationRequest): any => ({ ...obj, }); @@ -3146,6 +3425,9 @@ export namespace DeleteActivationRequest { export interface DeleteActivationResult {} export namespace DeleteActivationResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteActivationResult): any => ({ ...obj, }); @@ -3162,6 +3444,9 @@ export interface InvalidActivation extends __SmithyException, $MetadataBearer { } export namespace InvalidActivation { + /** + * @internal + */ export const filterSensitiveLog = (obj: InvalidActivation): any => ({ ...obj, }); @@ -3178,6 +3463,9 @@ export interface InvalidActivationId extends __SmithyException, $MetadataBearer } export namespace InvalidActivationId { + /** + * @internal + */ export const filterSensitiveLog = (obj: InvalidActivationId): any => ({ ...obj, }); @@ -3193,6 +3481,9 @@ export interface AssociationDoesNotExist extends __SmithyException, $MetadataBea } export namespace AssociationDoesNotExist { + /** + * @internal + */ export const filterSensitiveLog = (obj: AssociationDoesNotExist): any => ({ ...obj, }); @@ -3216,6 +3507,9 @@ export interface DeleteAssociationRequest { } export namespace DeleteAssociationRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteAssociationRequest): any => ({ ...obj, }); @@ -3224,6 +3518,9 @@ export namespace DeleteAssociationRequest { export interface DeleteAssociationResult {} export namespace DeleteAssociationResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteAssociationResult): any => ({ ...obj, }); @@ -3238,6 +3535,9 @@ export interface AssociatedInstances extends __SmithyException, $MetadataBearer } export namespace AssociatedInstances { + /** + * @internal + */ export const filterSensitiveLog = (obj: AssociatedInstances): any => ({ ...obj, }); @@ -3271,6 +3571,9 @@ export interface DeleteDocumentRequest { } export namespace DeleteDocumentRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteDocumentRequest): any => ({ ...obj, }); @@ -3279,6 +3582,9 @@ export namespace DeleteDocumentRequest { export interface DeleteDocumentResult {} export namespace DeleteDocumentResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteDocumentResult): any => ({ ...obj, }); @@ -3295,6 +3601,9 @@ export interface InvalidDocumentOperation extends __SmithyException, $MetadataBe } export namespace InvalidDocumentOperation { + /** + * @internal + */ export const filterSensitiveLog = (obj: InvalidDocumentOperation): any => ({ ...obj, }); @@ -3339,6 +3648,9 @@ export interface DeleteInventoryRequest { } export namespace DeleteInventoryRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteInventoryRequest): any => ({ ...obj, }); @@ -3365,6 +3677,9 @@ export interface InventoryDeletionSummaryItem { } export namespace InventoryDeletionSummaryItem { + /** + * @internal + */ export const filterSensitiveLog = (obj: InventoryDeletionSummaryItem): any => ({ ...obj, }); @@ -3392,6 +3707,9 @@ export interface InventoryDeletionSummary { } export namespace InventoryDeletionSummary { + /** + * @internal + */ export const filterSensitiveLog = (obj: InventoryDeletionSummary): any => ({ ...obj, }); @@ -3417,6 +3735,9 @@ export interface DeleteInventoryResult { } export namespace DeleteInventoryResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteInventoryResult): any => ({ ...obj, }); @@ -3433,6 +3754,9 @@ export interface InvalidDeleteInventoryParametersException extends __SmithyExcep } export namespace InvalidDeleteInventoryParametersException { + /** + * @internal + */ export const filterSensitiveLog = (obj: InvalidDeleteInventoryParametersException): any => ({ ...obj, }); @@ -3448,6 +3772,9 @@ export interface InvalidInventoryRequestException extends __SmithyException, $Me } export namespace InvalidInventoryRequestException { + /** + * @internal + */ export const filterSensitiveLog = (obj: InvalidInventoryRequestException): any => ({ ...obj, }); @@ -3463,6 +3790,9 @@ export interface InvalidOptionException extends __SmithyException, $MetadataBear } export namespace InvalidOptionException { + /** + * @internal + */ export const filterSensitiveLog = (obj: InvalidOptionException): any => ({ ...obj, }); @@ -3478,6 +3808,9 @@ export interface InvalidTypeNameException extends __SmithyException, $MetadataBe } export namespace InvalidTypeNameException { + /** + * @internal + */ export const filterSensitiveLog = (obj: InvalidTypeNameException): any => ({ ...obj, }); @@ -3491,6 +3824,9 @@ export interface DeleteMaintenanceWindowRequest { } export namespace DeleteMaintenanceWindowRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteMaintenanceWindowRequest): any => ({ ...obj, }); @@ -3504,6 +3840,9 @@ export interface DeleteMaintenanceWindowResult { } export namespace DeleteMaintenanceWindowResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteMaintenanceWindowResult): any => ({ ...obj, }); @@ -3517,6 +3856,9 @@ export interface DeleteOpsMetadataRequest { } export namespace DeleteOpsMetadataRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteOpsMetadataRequest): any => ({ ...obj, }); @@ -3525,6 +3867,9 @@ export namespace DeleteOpsMetadataRequest { export interface DeleteOpsMetadataResult {} export namespace DeleteOpsMetadataResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteOpsMetadataResult): any => ({ ...obj, }); @@ -3540,6 +3885,9 @@ export interface OpsMetadataNotFoundException extends __SmithyException, $Metada } export namespace OpsMetadataNotFoundException { + /** + * @internal + */ export const filterSensitiveLog = (obj: OpsMetadataNotFoundException): any => ({ ...obj, }); @@ -3553,6 +3901,9 @@ export interface DeleteParameterRequest { } export namespace DeleteParameterRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteParameterRequest): any => ({ ...obj, }); @@ -3561,6 +3912,9 @@ export namespace DeleteParameterRequest { export interface DeleteParameterResult {} export namespace DeleteParameterResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteParameterResult): any => ({ ...obj, }); @@ -3576,6 +3930,9 @@ export interface ParameterNotFound extends __SmithyException, $MetadataBearer { } export namespace ParameterNotFound { + /** + * @internal + */ export const filterSensitiveLog = (obj: ParameterNotFound): any => ({ ...obj, }); @@ -3589,6 +3946,9 @@ export interface DeleteParametersRequest { } export namespace DeleteParametersRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteParametersRequest): any => ({ ...obj, }); @@ -3607,6 +3967,9 @@ export interface DeleteParametersResult { } export namespace DeleteParametersResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteParametersResult): any => ({ ...obj, }); @@ -3620,6 +3983,9 @@ export interface DeletePatchBaselineRequest { } export namespace DeletePatchBaselineRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeletePatchBaselineRequest): any => ({ ...obj, }); @@ -3633,6 +3999,9 @@ export interface DeletePatchBaselineResult { } export namespace DeletePatchBaselineResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeletePatchBaselineResult): any => ({ ...obj, }); @@ -3649,6 +4018,9 @@ export interface ResourceInUseException extends __SmithyException, $MetadataBear } export namespace ResourceInUseException { + /** + * @internal + */ export const filterSensitiveLog = (obj: ResourceInUseException): any => ({ ...obj, }); @@ -3667,6 +4039,9 @@ export interface DeleteResourceDataSyncRequest { } export namespace DeleteResourceDataSyncRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteResourceDataSyncRequest): any => ({ ...obj, }); @@ -3675,6 +4050,9 @@ export namespace DeleteResourceDataSyncRequest { export interface DeleteResourceDataSyncResult {} export namespace DeleteResourceDataSyncResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteResourceDataSyncResult): any => ({ ...obj, }); @@ -3692,6 +4070,9 @@ export interface ResourceDataSyncNotFoundException extends __SmithyException, $M } export namespace ResourceDataSyncNotFoundException { + /** + * @internal + */ export const filterSensitiveLog = (obj: ResourceDataSyncNotFoundException): any => ({ ...obj, }); @@ -3706,6 +4087,9 @@ export interface DeregisterManagedInstanceRequest { } export namespace DeregisterManagedInstanceRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeregisterManagedInstanceRequest): any => ({ ...obj, }); @@ -3714,6 +4098,9 @@ export namespace DeregisterManagedInstanceRequest { export interface DeregisterManagedInstanceResult {} export namespace DeregisterManagedInstanceResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeregisterManagedInstanceResult): any => ({ ...obj, }); @@ -3732,6 +4119,9 @@ export interface DeregisterPatchBaselineForPatchGroupRequest { } export namespace DeregisterPatchBaselineForPatchGroupRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeregisterPatchBaselineForPatchGroupRequest): any => ({ ...obj, }); @@ -3750,6 +4140,9 @@ export interface DeregisterPatchBaselineForPatchGroupResult { } export namespace DeregisterPatchBaselineForPatchGroupResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeregisterPatchBaselineForPatchGroupResult): any => ({ ...obj, }); @@ -3775,6 +4168,9 @@ export interface DeregisterTargetFromMaintenanceWindowRequest { } export namespace DeregisterTargetFromMaintenanceWindowRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeregisterTargetFromMaintenanceWindowRequest): any => ({ ...obj, }); @@ -3793,6 +4189,9 @@ export interface DeregisterTargetFromMaintenanceWindowResult { } export namespace DeregisterTargetFromMaintenanceWindowResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeregisterTargetFromMaintenanceWindowResult): any => ({ ...obj, }); @@ -3809,6 +4208,9 @@ export interface TargetInUseException extends __SmithyException, $MetadataBearer } export namespace TargetInUseException { + /** + * @internal + */ export const filterSensitiveLog = (obj: TargetInUseException): any => ({ ...obj, }); @@ -3827,6 +4229,9 @@ export interface DeregisterTaskFromMaintenanceWindowRequest { } export namespace DeregisterTaskFromMaintenanceWindowRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeregisterTaskFromMaintenanceWindowRequest): any => ({ ...obj, }); @@ -3845,6 +4250,9 @@ export interface DeregisterTaskFromMaintenanceWindowResult { } export namespace DeregisterTaskFromMaintenanceWindowResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeregisterTaskFromMaintenanceWindowResult): any => ({ ...obj, }); @@ -3872,6 +4280,9 @@ export interface DescribeActivationsFilter { } export namespace DescribeActivationsFilter { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeActivationsFilter): any => ({ ...obj, }); @@ -3896,6 +4307,9 @@ export interface DescribeActivationsRequest { } export namespace DescribeActivationsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeActivationsRequest): any => ({ ...obj, }); @@ -3915,6 +4329,9 @@ export interface DescribeActivationsResult { } export namespace DescribeActivationsResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeActivationsResult): any => ({ ...obj, }); @@ -3930,6 +4347,9 @@ export interface InvalidFilter extends __SmithyException, $MetadataBearer { } export namespace InvalidFilter { + /** + * @internal + */ export const filterSensitiveLog = (obj: InvalidFilter): any => ({ ...obj, }); @@ -3945,6 +4365,9 @@ export interface InvalidNextToken extends __SmithyException, $MetadataBearer { } export namespace InvalidNextToken { + /** + * @internal + */ export const filterSensitiveLog = (obj: InvalidNextToken): any => ({ ...obj, }); @@ -3976,6 +4399,9 @@ export interface DescribeAssociationRequest { } export namespace DescribeAssociationRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeAssociationRequest): any => ({ ...obj, }); @@ -3989,6 +4415,9 @@ export interface DescribeAssociationResult { } export namespace DescribeAssociationResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeAssociationResult): any => ({ ...obj, }); @@ -4006,6 +4435,9 @@ export interface InvalidAssociationVersion extends __SmithyException, $MetadataB } export namespace InvalidAssociationVersion { + /** + * @internal + */ export const filterSensitiveLog = (obj: InvalidAssociationVersion): any => ({ ...obj, }); @@ -4044,6 +4476,9 @@ export interface AssociationExecutionFilter { } export namespace AssociationExecutionFilter { + /** + * @internal + */ export const filterSensitiveLog = (obj: AssociationExecutionFilter): any => ({ ...obj, }); @@ -4076,6 +4511,9 @@ export interface DescribeAssociationExecutionsRequest { } export namespace DescribeAssociationExecutionsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeAssociationExecutionsRequest): any => ({ ...obj, }); @@ -4127,6 +4565,9 @@ export interface AssociationExecution { } export namespace AssociationExecution { + /** + * @internal + */ export const filterSensitiveLog = (obj: AssociationExecution): any => ({ ...obj, }); @@ -4146,6 +4587,9 @@ export interface DescribeAssociationExecutionsResult { } export namespace DescribeAssociationExecutionsResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeAssociationExecutionsResult): any => ({ ...obj, }); @@ -4161,6 +4605,9 @@ export interface AssociationExecutionDoesNotExist extends __SmithyException, $Me } export namespace AssociationExecutionDoesNotExist { + /** + * @internal + */ export const filterSensitiveLog = (obj: AssociationExecutionDoesNotExist): any => ({ ...obj, }); @@ -4188,6 +4635,9 @@ export interface AssociationExecutionTargetsFilter { } export namespace AssociationExecutionTargetsFilter { + /** + * @internal + */ export const filterSensitiveLog = (obj: AssociationExecutionTargetsFilter): any => ({ ...obj, }); @@ -4225,6 +4675,9 @@ export interface DescribeAssociationExecutionTargetsRequest { } export namespace DescribeAssociationExecutionTargetsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeAssociationExecutionTargetsRequest): any => ({ ...obj, }); @@ -4247,6 +4700,9 @@ export interface OutputSource { } export namespace OutputSource { + /** + * @internal + */ export const filterSensitiveLog = (obj: OutputSource): any => ({ ...obj, }); @@ -4303,6 +4759,9 @@ export interface AssociationExecutionTarget { } export namespace AssociationExecutionTarget { + /** + * @internal + */ export const filterSensitiveLog = (obj: AssociationExecutionTarget): any => ({ ...obj, }); @@ -4322,6 +4781,9 @@ export interface DescribeAssociationExecutionTargetsResult { } export namespace DescribeAssociationExecutionTargetsResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeAssociationExecutionTargetsResult): any => ({ ...obj, }); @@ -4359,6 +4821,9 @@ export interface AutomationExecutionFilter { } export namespace AutomationExecutionFilter { + /** + * @internal + */ export const filterSensitiveLog = (obj: AutomationExecutionFilter): any => ({ ...obj, }); @@ -4384,6 +4849,9 @@ export interface DescribeAutomationExecutionsRequest { } export namespace DescribeAutomationExecutionsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeAutomationExecutionsRequest): any => ({ ...obj, }); @@ -4441,6 +4909,9 @@ export interface ResolvedTargets { } export namespace ResolvedTargets { + /** + * @internal + */ export const filterSensitiveLog = (obj: ResolvedTargets): any => ({ ...obj, }); @@ -4506,6 +4977,9 @@ export interface Runbook { } export namespace Runbook { + /** + * @internal + */ export const filterSensitiveLog = (obj: Runbook): any => ({ ...obj, }); @@ -4667,6 +5141,9 @@ export interface AutomationExecutionMetadata { } export namespace AutomationExecutionMetadata { + /** + * @internal + */ export const filterSensitiveLog = (obj: AutomationExecutionMetadata): any => ({ ...obj, }); @@ -4687,6 +5164,9 @@ export interface DescribeAutomationExecutionsResult { } export namespace DescribeAutomationExecutionsResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeAutomationExecutionsResult): any => ({ ...obj, }); @@ -4701,6 +5181,9 @@ export interface InvalidFilterKey extends __SmithyException, $MetadataBearer { } export namespace InvalidFilterKey { + /** + * @internal + */ export const filterSensitiveLog = (obj: InvalidFilterKey): any => ({ ...obj, }); @@ -4716,6 +5199,9 @@ export interface InvalidFilterValue extends __SmithyException, $MetadataBearer { } export namespace InvalidFilterValue { + /** + * @internal + */ export const filterSensitiveLog = (obj: InvalidFilterValue): any => ({ ...obj, }); @@ -4732,6 +5218,9 @@ export interface AutomationExecutionNotFoundException extends __SmithyException, } export namespace AutomationExecutionNotFoundException { + /** + * @internal + */ export const filterSensitiveLog = (obj: AutomationExecutionNotFoundException): any => ({ ...obj, }); @@ -4763,6 +5252,9 @@ export interface StepExecutionFilter { } export namespace StepExecutionFilter { + /** + * @internal + */ export const filterSensitiveLog = (obj: StepExecutionFilter): any => ({ ...obj, }); @@ -4799,6 +5291,9 @@ export interface DescribeAutomationStepExecutionsRequest { } export namespace DescribeAutomationStepExecutionsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeAutomationStepExecutionsRequest): any => ({ ...obj, }); @@ -4827,6 +5322,9 @@ export interface FailureDetails { } export namespace FailureDetails { + /** + * @internal + */ export const filterSensitiveLog = (obj: FailureDetails): any => ({ ...obj, }); @@ -4956,6 +5454,9 @@ export interface StepExecution { } export namespace StepExecution { + /** + * @internal + */ export const filterSensitiveLog = (obj: StepExecution): any => ({ ...obj, }); @@ -4975,6 +5476,9 @@ export interface DescribeAutomationStepExecutionsResult { } export namespace DescribeAutomationStepExecutionsResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeAutomationStepExecutionsResult): any => ({ ...obj, }); @@ -4996,6 +5500,9 @@ export interface PatchOrchestratorFilter { } export namespace PatchOrchestratorFilter { + /** + * @internal + */ export const filterSensitiveLog = (obj: PatchOrchestratorFilter): any => ({ ...obj, }); @@ -5020,6 +5527,9 @@ export interface DescribeAvailablePatchesRequest { } export namespace DescribeAvailablePatchesRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeAvailablePatchesRequest): any => ({ ...obj, }); @@ -5168,6 +5678,9 @@ export interface Patch { } export namespace Patch { + /** + * @internal + */ export const filterSensitiveLog = (obj: Patch): any => ({ ...obj, }); @@ -5187,6 +5700,9 @@ export interface DescribeAvailablePatchesResult { } export namespace DescribeAvailablePatchesResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeAvailablePatchesResult): any => ({ ...obj, }); @@ -5213,6 +5729,9 @@ export interface DescribeDocumentRequest { } export namespace DescribeDocumentRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeDocumentRequest): any => ({ ...obj, }); @@ -5226,6 +5745,9 @@ export interface DescribeDocumentResult { } export namespace DescribeDocumentResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeDocumentResult): any => ({ ...obj, }); @@ -5261,6 +5783,9 @@ export interface DescribeDocumentPermissionRequest { } export namespace DescribeDocumentPermissionRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeDocumentPermissionRequest): any => ({ ...obj, }); @@ -5287,6 +5812,9 @@ export interface DescribeDocumentPermissionResponse { } export namespace DescribeDocumentPermissionResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeDocumentPermissionResponse): any => ({ ...obj, }); @@ -5303,6 +5831,9 @@ export interface InvalidPermissionType extends __SmithyException, $MetadataBeare } export namespace InvalidPermissionType { + /** + * @internal + */ export const filterSensitiveLog = (obj: InvalidPermissionType): any => ({ ...obj, }); @@ -5328,6 +5859,9 @@ export interface DescribeEffectiveInstanceAssociationsRequest { } export namespace DescribeEffectiveInstanceAssociationsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeEffectiveInstanceAssociationsRequest): any => ({ ...obj, }); @@ -5359,6 +5893,9 @@ export interface InstanceAssociation { } export namespace InstanceAssociation { + /** + * @internal + */ export const filterSensitiveLog = (obj: InstanceAssociation): any => ({ ...obj, }); @@ -5378,6 +5915,9 @@ export interface DescribeEffectiveInstanceAssociationsResult { } export namespace DescribeEffectiveInstanceAssociationsResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeEffectiveInstanceAssociationsResult): any => ({ ...obj, }); @@ -5402,6 +5942,9 @@ export interface DescribeEffectivePatchesForPatchBaselineRequest { } export namespace DescribeEffectivePatchesForPatchBaselineRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeEffectivePatchesForPatchBaselineRequest): any => ({ ...obj, }); @@ -5437,6 +5980,9 @@ export interface PatchStatus { } export namespace PatchStatus { + /** + * @internal + */ export const filterSensitiveLog = (obj: PatchStatus): any => ({ ...obj, }); @@ -5464,6 +6010,9 @@ export interface EffectivePatch { } export namespace EffectivePatch { + /** + * @internal + */ export const filterSensitiveLog = (obj: EffectivePatch): any => ({ ...obj, }); @@ -5483,6 +6032,9 @@ export interface DescribeEffectivePatchesForPatchBaselineResult { } export namespace DescribeEffectivePatchesForPatchBaselineResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeEffectivePatchesForPatchBaselineResult): any => ({ ...obj, }); @@ -5499,6 +6051,9 @@ export interface UnsupportedOperatingSystem extends __SmithyException, $Metadata } export namespace UnsupportedOperatingSystem { + /** + * @internal + */ export const filterSensitiveLog = (obj: UnsupportedOperatingSystem): any => ({ ...obj, }); @@ -5524,6 +6079,9 @@ export interface DescribeInstanceAssociationsStatusRequest { } export namespace DescribeInstanceAssociationsStatusRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeInstanceAssociationsStatusRequest): any => ({ ...obj, }); @@ -5540,6 +6098,9 @@ export interface S3OutputUrl { } export namespace S3OutputUrl { + /** + * @internal + */ export const filterSensitiveLog = (obj: S3OutputUrl): any => ({ ...obj, }); @@ -5556,6 +6117,9 @@ export interface InstanceAssociationOutputUrl { } export namespace InstanceAssociationOutputUrl { + /** + * @internal + */ export const filterSensitiveLog = (obj: InstanceAssociationOutputUrl): any => ({ ...obj, }); @@ -5627,6 +6191,9 @@ export interface InstanceAssociationStatusInfo { } export namespace InstanceAssociationStatusInfo { + /** + * @internal + */ export const filterSensitiveLog = (obj: InstanceAssociationStatusInfo): any => ({ ...obj, }); @@ -5646,6 +6213,9 @@ export interface DescribeInstanceAssociationsStatusResult { } export namespace DescribeInstanceAssociationsStatusResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeInstanceAssociationsStatusResult): any => ({ ...obj, }); @@ -5676,6 +6246,9 @@ export interface InstanceInformationStringFilter { } export namespace InstanceInformationStringFilter { + /** + * @internal + */ export const filterSensitiveLog = (obj: InstanceInformationStringFilter): any => ({ ...obj, }); @@ -5712,6 +6285,9 @@ export interface InstanceInformationFilter { } export namespace InstanceInformationFilter { + /** + * @internal + */ export const filterSensitiveLog = (obj: InstanceInformationFilter): any => ({ ...obj, }); @@ -5750,6 +6326,9 @@ export interface DescribeInstanceInformationRequest { } export namespace DescribeInstanceInformationRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeInstanceInformationRequest): any => ({ ...obj, }); @@ -5771,6 +6350,9 @@ export interface InstanceAggregatedAssociationOverview { } export namespace InstanceAggregatedAssociationOverview { + /** + * @internal + */ export const filterSensitiveLog = (obj: InstanceAggregatedAssociationOverview): any => ({ ...obj, }); @@ -5907,6 +6489,9 @@ export interface InstanceInformation { } export namespace InstanceInformation { + /** + * @internal + */ export const filterSensitiveLog = (obj: InstanceInformation): any => ({ ...obj, }); @@ -5926,6 +6511,9 @@ export interface DescribeInstanceInformationResult { } export namespace DescribeInstanceInformationResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeInstanceInformationResult): any => ({ ...obj, }); @@ -5941,6 +6529,9 @@ export interface InvalidInstanceInformationFilterValue extends __SmithyException } export namespace InvalidInstanceInformationFilterValue { + /** + * @internal + */ export const filterSensitiveLog = (obj: InvalidInstanceInformationFilterValue): any => ({ ...obj, }); @@ -5972,6 +6563,9 @@ export interface DescribeInstancePatchesRequest { } export namespace DescribeInstancePatchesRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeInstancePatchesRequest): any => ({ ...obj, }); @@ -6033,6 +6627,9 @@ export interface PatchComplianceData { } export namespace PatchComplianceData { + /** + * @internal + */ export const filterSensitiveLog = (obj: PatchComplianceData): any => ({ ...obj, }); @@ -6059,6 +6656,9 @@ export interface DescribeInstancePatchesResult { } export namespace DescribeInstancePatchesResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeInstancePatchesResult): any => ({ ...obj, }); @@ -6083,6 +6683,9 @@ export interface DescribeInstancePatchStatesRequest { } export namespace DescribeInstancePatchStatesRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeInstancePatchStatesRequest): any => ({ ...obj, }); @@ -6269,6 +6872,9 @@ export interface InstancePatchState { } export namespace InstancePatchState { + /** + * @internal + */ export const filterSensitiveLog = (obj: InstancePatchState): any => ({ ...obj, ...(obj.OwnerInformation && { OwnerInformation: SENSITIVE_STRING }), @@ -6289,6 +6895,9 @@ export interface DescribeInstancePatchStatesResult { } export namespace DescribeInstancePatchStatesResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeInstancePatchStatesResult): any => ({ ...obj, ...(obj.InstancePatchStates && { @@ -6328,6 +6937,9 @@ export interface InstancePatchStateFilter { } export namespace InstancePatchStateFilter { + /** + * @internal + */ export const filterSensitiveLog = (obj: InstancePatchStateFilter): any => ({ ...obj, }); @@ -6361,6 +6973,9 @@ export interface DescribeInstancePatchStatesForPatchGroupRequest { } export namespace DescribeInstancePatchStatesForPatchGroupRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeInstancePatchStatesForPatchGroupRequest): any => ({ ...obj, }); @@ -6380,6 +6995,9 @@ export interface DescribeInstancePatchStatesForPatchGroupResult { } export namespace DescribeInstancePatchStatesForPatchGroupResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeInstancePatchStatesForPatchGroupResult): any => ({ ...obj, ...(obj.InstancePatchStates && { @@ -6408,6 +7026,9 @@ export interface DescribeInventoryDeletionsRequest { } export namespace DescribeInventoryDeletionsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeInventoryDeletionsRequest): any => ({ ...obj, }); @@ -6460,6 +7081,9 @@ export interface InventoryDeletionStatusItem { } export namespace InventoryDeletionStatusItem { + /** + * @internal + */ export const filterSensitiveLog = (obj: InventoryDeletionStatusItem): any => ({ ...obj, }); @@ -6479,6 +7103,9 @@ export interface DescribeInventoryDeletionsResult { } export namespace DescribeInventoryDeletionsResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeInventoryDeletionsResult): any => ({ ...obj, }); @@ -6495,6 +7122,9 @@ export interface InvalidDeletionIdException extends __SmithyException, $Metadata } export namespace InvalidDeletionIdException { + /** + * @internal + */ export const filterSensitiveLog = (obj: InvalidDeletionIdException): any => ({ ...obj, }); @@ -6516,6 +7146,9 @@ export interface MaintenanceWindowFilter { } export namespace MaintenanceWindowFilter { + /** + * @internal + */ export const filterSensitiveLog = (obj: MaintenanceWindowFilter): any => ({ ...obj, }); @@ -6550,6 +7183,9 @@ export interface DescribeMaintenanceWindowExecutionsRequest { } export namespace DescribeMaintenanceWindowExecutionsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeMaintenanceWindowExecutionsRequest): any => ({ ...obj, }); @@ -6602,6 +7238,9 @@ export interface MaintenanceWindowExecution { } export namespace MaintenanceWindowExecution { + /** + * @internal + */ export const filterSensitiveLog = (obj: MaintenanceWindowExecution): any => ({ ...obj, }); @@ -6621,6 +7260,9 @@ export interface DescribeMaintenanceWindowExecutionsResult { } export namespace DescribeMaintenanceWindowExecutionsResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeMaintenanceWindowExecutionsResult): any => ({ ...obj, }); @@ -6658,6 +7300,9 @@ export interface DescribeMaintenanceWindowExecutionTaskInvocationsRequest { } export namespace DescribeMaintenanceWindowExecutionTaskInvocationsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeMaintenanceWindowExecutionTaskInvocationsRequest): any => ({ ...obj, }); @@ -6741,6 +7386,9 @@ export interface MaintenanceWindowExecutionTaskInvocationIdentity { } export namespace MaintenanceWindowExecutionTaskInvocationIdentity { + /** + * @internal + */ export const filterSensitiveLog = (obj: MaintenanceWindowExecutionTaskInvocationIdentity): any => ({ ...obj, ...(obj.Parameters && { Parameters: SENSITIVE_STRING }), @@ -6762,6 +7410,9 @@ export interface DescribeMaintenanceWindowExecutionTaskInvocationsResult { } export namespace DescribeMaintenanceWindowExecutionTaskInvocationsResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeMaintenanceWindowExecutionTaskInvocationsResult): any => ({ ...obj, ...(obj.WindowExecutionTaskInvocationIdentities && { @@ -6799,6 +7450,9 @@ export interface DescribeMaintenanceWindowExecutionTasksRequest { } export namespace DescribeMaintenanceWindowExecutionTasksRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeMaintenanceWindowExecutionTasksRequest): any => ({ ...obj, }); @@ -6852,6 +7506,9 @@ export interface MaintenanceWindowExecutionTaskIdentity { } export namespace MaintenanceWindowExecutionTaskIdentity { + /** + * @internal + */ export const filterSensitiveLog = (obj: MaintenanceWindowExecutionTaskIdentity): any => ({ ...obj, }); @@ -6871,6 +7528,9 @@ export interface DescribeMaintenanceWindowExecutionTasksResult { } export namespace DescribeMaintenanceWindowExecutionTasksResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeMaintenanceWindowExecutionTasksResult): any => ({ ...obj, }); @@ -6897,6 +7557,9 @@ export interface DescribeMaintenanceWindowsRequest { } export namespace DescribeMaintenanceWindowsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeMaintenanceWindowsRequest): any => ({ ...obj, }); @@ -6974,6 +7637,9 @@ export interface MaintenanceWindowIdentity { } export namespace MaintenanceWindowIdentity { + /** + * @internal + */ export const filterSensitiveLog = (obj: MaintenanceWindowIdentity): any => ({ ...obj, ...(obj.Description && { Description: SENSITIVE_STRING }), @@ -6994,6 +7660,9 @@ export interface DescribeMaintenanceWindowsResult { } export namespace DescribeMaintenanceWindowsResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeMaintenanceWindowsResult): any => ({ ...obj, ...(obj.WindowIdentities && { @@ -7043,6 +7712,9 @@ export interface DescribeMaintenanceWindowScheduleRequest { } export namespace DescribeMaintenanceWindowScheduleRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeMaintenanceWindowScheduleRequest): any => ({ ...obj, }); @@ -7070,6 +7742,9 @@ export interface ScheduledWindowExecution { } export namespace ScheduledWindowExecution { + /** + * @internal + */ export const filterSensitiveLog = (obj: ScheduledWindowExecution): any => ({ ...obj, }); @@ -7089,6 +7764,9 @@ export interface DescribeMaintenanceWindowScheduleResult { } export namespace DescribeMaintenanceWindowScheduleResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeMaintenanceWindowScheduleResult): any => ({ ...obj, }); @@ -7119,6 +7797,9 @@ export interface DescribeMaintenanceWindowsForTargetRequest { } export namespace DescribeMaintenanceWindowsForTargetRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeMaintenanceWindowsForTargetRequest): any => ({ ...obj, }); @@ -7140,6 +7821,9 @@ export interface MaintenanceWindowIdentityForTarget { } export namespace MaintenanceWindowIdentityForTarget { + /** + * @internal + */ export const filterSensitiveLog = (obj: MaintenanceWindowIdentityForTarget): any => ({ ...obj, }); @@ -7159,6 +7843,9 @@ export interface DescribeMaintenanceWindowsForTargetResult { } export namespace DescribeMaintenanceWindowsForTargetResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeMaintenanceWindowsForTargetResult): any => ({ ...obj, }); @@ -7190,6 +7877,9 @@ export interface DescribeMaintenanceWindowTargetsRequest { } export namespace DescribeMaintenanceWindowTargetsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeMaintenanceWindowTargetsRequest): any => ({ ...obj, }); @@ -7244,6 +7934,9 @@ export interface MaintenanceWindowTarget { } export namespace MaintenanceWindowTarget { + /** + * @internal + */ export const filterSensitiveLog = (obj: MaintenanceWindowTarget): any => ({ ...obj, ...(obj.OwnerInformation && { OwnerInformation: SENSITIVE_STRING }), @@ -7265,6 +7958,9 @@ export interface DescribeMaintenanceWindowTargetsResult { } export namespace DescribeMaintenanceWindowTargetsResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeMaintenanceWindowTargetsResult): any => ({ ...obj, ...(obj.Targets && { Targets: obj.Targets.map((item) => MaintenanceWindowTarget.filterSensitiveLog(item)) }), @@ -7297,6 +7993,9 @@ export interface DescribeMaintenanceWindowTasksRequest { } export namespace DescribeMaintenanceWindowTasksRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeMaintenanceWindowTasksRequest): any => ({ ...obj, }); @@ -7330,6 +8029,9 @@ export interface LoggingInfo { } export namespace LoggingInfo { + /** + * @internal + */ export const filterSensitiveLog = (obj: LoggingInfo): any => ({ ...obj, }); @@ -7347,6 +8049,9 @@ export interface MaintenanceWindowTaskParameterValueExpression { } export namespace MaintenanceWindowTaskParameterValueExpression { + /** + * @internal + */ export const filterSensitiveLog = (obj: MaintenanceWindowTaskParameterValueExpression): any => ({ ...obj, ...(obj.Values && { Values: SENSITIVE_STRING }), @@ -7445,6 +8150,9 @@ export interface MaintenanceWindowTask { } export namespace MaintenanceWindowTask { + /** + * @internal + */ export const filterSensitiveLog = (obj: MaintenanceWindowTask): any => ({ ...obj, ...(obj.TaskParameters && { TaskParameters: SENSITIVE_STRING }), @@ -7466,6 +8174,9 @@ export interface DescribeMaintenanceWindowTasksResult { } export namespace DescribeMaintenanceWindowTasksResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeMaintenanceWindowTasksResult): any => ({ ...obj, ...(obj.Tasks && { Tasks: obj.Tasks.map((item) => MaintenanceWindowTask.filterSensitiveLog(item)) }), @@ -7529,6 +8240,9 @@ export interface OpsItemFilter { } export namespace OpsItemFilter { + /** + * @internal + */ export const filterSensitiveLog = (obj: OpsItemFilter): any => ({ ...obj, }); @@ -7609,6 +8323,9 @@ export interface DescribeOpsItemsRequest { } export namespace DescribeOpsItemsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeOpsItemsRequest): any => ({ ...obj, }); @@ -7733,6 +8450,9 @@ export interface OpsItemSummary { } export namespace OpsItemSummary { + /** + * @internal + */ export const filterSensitiveLog = (obj: OpsItemSummary): any => ({ ...obj, }); @@ -7752,6 +8472,9 @@ export interface DescribeOpsItemsResponse { } export namespace DescribeOpsItemsResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeOpsItemsResponse): any => ({ ...obj, }); @@ -7779,6 +8502,9 @@ export interface ParametersFilter { } export namespace ParametersFilter { + /** + * @internal + */ export const filterSensitiveLog = (obj: ParametersFilter): any => ({ ...obj, }); @@ -7823,6 +8549,9 @@ export interface ParameterStringFilter { } export namespace ParameterStringFilter { + /** + * @internal + */ export const filterSensitiveLog = (obj: ParameterStringFilter): any => ({ ...obj, }); @@ -7853,6 +8582,9 @@ export interface DescribeParametersRequest { } export namespace DescribeParametersRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeParametersRequest): any => ({ ...obj, }); @@ -7882,6 +8614,9 @@ export interface ParameterInlinePolicy { } export namespace ParameterInlinePolicy { + /** + * @internal + */ export const filterSensitiveLog = (obj: ParameterInlinePolicy): any => ({ ...obj, }); @@ -7964,6 +8699,9 @@ export interface ParameterMetadata { } export namespace ParameterMetadata { + /** + * @internal + */ export const filterSensitiveLog = (obj: ParameterMetadata): any => ({ ...obj, }); @@ -7982,6 +8720,9 @@ export interface DescribeParametersResult { } export namespace DescribeParametersResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeParametersResult): any => ({ ...obj, }); @@ -8002,6 +8743,9 @@ export interface InvalidFilterOption extends __SmithyException, $MetadataBearer } export namespace InvalidFilterOption { + /** + * @internal + */ export const filterSensitiveLog = (obj: InvalidFilterOption): any => ({ ...obj, }); @@ -8028,6 +8772,9 @@ export interface DescribePatchBaselinesRequest { } export namespace DescribePatchBaselinesRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribePatchBaselinesRequest): any => ({ ...obj, }); @@ -8067,6 +8814,9 @@ export interface PatchBaselineIdentity { } export namespace PatchBaselineIdentity { + /** + * @internal + */ export const filterSensitiveLog = (obj: PatchBaselineIdentity): any => ({ ...obj, }); @@ -8086,6 +8836,9 @@ export interface DescribePatchBaselinesResult { } export namespace DescribePatchBaselinesResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribePatchBaselinesResult): any => ({ ...obj, }); diff --git a/clients/client-ssm/models/models_1.ts b/clients/client-ssm/models/models_1.ts index f1797aa64752..ca8e996d65b4 100644 --- a/clients/client-ssm/models/models_1.ts +++ b/clients/client-ssm/models/models_1.ts @@ -97,6 +97,9 @@ export interface DescribePatchGroupsRequest { } export namespace DescribePatchGroupsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribePatchGroupsRequest): any => ({ ...obj, }); @@ -119,6 +122,9 @@ export interface PatchGroupPatchBaselineMapping { } export namespace PatchGroupPatchBaselineMapping { + /** + * @internal + */ export const filterSensitiveLog = (obj: PatchGroupPatchBaselineMapping): any => ({ ...obj, }); @@ -141,6 +147,9 @@ export interface DescribePatchGroupsResult { } export namespace DescribePatchGroupsResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribePatchGroupsResult): any => ({ ...obj, }); @@ -154,6 +163,9 @@ export interface DescribePatchGroupStateRequest { } export namespace DescribePatchGroupStateRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribePatchGroupStateRequest): any => ({ ...obj, }); @@ -239,6 +251,9 @@ export interface DescribePatchGroupStateResult { } export namespace DescribePatchGroupStateResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribePatchGroupStateResult): any => ({ ...obj, }); @@ -289,6 +304,9 @@ export interface DescribePatchPropertiesRequest { } export namespace DescribePatchPropertiesRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribePatchPropertiesRequest): any => ({ ...obj, }); @@ -307,6 +325,9 @@ export interface DescribePatchPropertiesResult { } export namespace DescribePatchPropertiesResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribePatchPropertiesResult): any => ({ ...obj, }); @@ -380,6 +401,9 @@ export interface SessionFilter { } export namespace SessionFilter { + /** + * @internal + */ export const filterSensitiveLog = (obj: SessionFilter): any => ({ ...obj, }); @@ -415,6 +439,9 @@ export interface DescribeSessionsRequest { } export namespace DescribeSessionsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeSessionsRequest): any => ({ ...obj, }); @@ -436,6 +463,9 @@ export interface SessionManagerOutputUrl { } export namespace SessionManagerOutputUrl { + /** + * @internal + */ export const filterSensitiveLog = (obj: SessionManagerOutputUrl): any => ({ ...obj, }); @@ -502,6 +532,9 @@ export interface Session { } export namespace Session { + /** + * @internal + */ export const filterSensitiveLog = (obj: Session): any => ({ ...obj, }); @@ -521,6 +554,9 @@ export interface DescribeSessionsResponse { } export namespace DescribeSessionsResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeSessionsResponse): any => ({ ...obj, }); @@ -536,6 +572,9 @@ export interface GetAutomationExecutionRequest { } export namespace GetAutomationExecutionRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetAutomationExecutionRequest): any => ({ ...obj, }); @@ -578,6 +617,9 @@ export interface ProgressCounters { } export namespace ProgressCounters { + /** + * @internal + */ export const filterSensitiveLog = (obj: ProgressCounters): any => ({ ...obj, }); @@ -756,6 +798,9 @@ export interface AutomationExecution { } export namespace AutomationExecution { + /** + * @internal + */ export const filterSensitiveLog = (obj: AutomationExecution): any => ({ ...obj, }); @@ -769,6 +814,9 @@ export interface GetAutomationExecutionResult { } export namespace GetAutomationExecutionResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetAutomationExecutionResult): any => ({ ...obj, }); @@ -789,6 +837,9 @@ export interface GetCalendarStateRequest { } export namespace GetCalendarStateRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetCalendarStateRequest): any => ({ ...obj, }); @@ -824,6 +875,9 @@ export interface GetCalendarStateResponse { } export namespace GetCalendarStateResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetCalendarStateResponse): any => ({ ...obj, }); @@ -840,6 +894,9 @@ export interface InvalidDocumentType extends __SmithyException, $MetadataBearer } export namespace InvalidDocumentType { + /** + * @internal + */ export const filterSensitiveLog = (obj: InvalidDocumentType): any => ({ ...obj, }); @@ -855,6 +912,9 @@ export interface UnsupportedCalendarException extends __SmithyException, $Metada } export namespace UnsupportedCalendarException { + /** + * @internal + */ export const filterSensitiveLog = (obj: UnsupportedCalendarException): any => ({ ...obj, }); @@ -889,6 +949,9 @@ export interface GetCommandInvocationRequest { } export namespace GetCommandInvocationRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetCommandInvocationRequest): any => ({ ...obj, }); @@ -912,6 +975,9 @@ export interface CloudWatchOutputConfig { } export namespace CloudWatchOutputConfig { + /** + * @internal + */ export const filterSensitiveLog = (obj: CloudWatchOutputConfig): any => ({ ...obj, }); @@ -1092,6 +1158,9 @@ export interface GetCommandInvocationResult { } export namespace GetCommandInvocationResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetCommandInvocationResult): any => ({ ...obj, }); @@ -1106,6 +1175,9 @@ export interface InvalidPluginName extends __SmithyException, $MetadataBearer { } export namespace InvalidPluginName { + /** + * @internal + */ export const filterSensitiveLog = (obj: InvalidPluginName): any => ({ ...obj, }); @@ -1121,6 +1193,9 @@ export interface InvocationDoesNotExist extends __SmithyException, $MetadataBear } export namespace InvocationDoesNotExist { + /** + * @internal + */ export const filterSensitiveLog = (obj: InvocationDoesNotExist): any => ({ ...obj, }); @@ -1134,6 +1209,9 @@ export interface GetConnectionStatusRequest { } export namespace GetConnectionStatusRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetConnectionStatusRequest): any => ({ ...obj, }); @@ -1158,6 +1236,9 @@ export interface GetConnectionStatusResponse { } export namespace GetConnectionStatusResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetConnectionStatusResponse): any => ({ ...obj, }); @@ -1171,6 +1252,9 @@ export interface GetDefaultPatchBaselineRequest { } export namespace GetDefaultPatchBaselineRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetDefaultPatchBaselineRequest): any => ({ ...obj, }); @@ -1189,6 +1273,9 @@ export interface GetDefaultPatchBaselineResult { } export namespace GetDefaultPatchBaselineResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetDefaultPatchBaselineResult): any => ({ ...obj, }); @@ -1256,6 +1343,9 @@ export interface BaselineOverride { } export namespace BaselineOverride { + /** + * @internal + */ export const filterSensitiveLog = (obj: BaselineOverride): any => ({ ...obj, ...(obj.Sources && { Sources: obj.Sources.map((item) => PatchSource.filterSensitiveLog(item)) }), @@ -1280,6 +1370,9 @@ export interface GetDeployablePatchSnapshotForInstanceRequest { } export namespace GetDeployablePatchSnapshotForInstanceRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetDeployablePatchSnapshotForInstanceRequest): any => ({ ...obj, }); @@ -1309,6 +1402,9 @@ export interface GetDeployablePatchSnapshotForInstanceResult { } export namespace GetDeployablePatchSnapshotForInstanceResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetDeployablePatchSnapshotForInstanceResult): any => ({ ...obj, }); @@ -1327,6 +1423,9 @@ export interface UnsupportedFeatureRequiredException extends __SmithyException, } export namespace UnsupportedFeatureRequiredException { + /** + * @internal + */ export const filterSensitiveLog = (obj: UnsupportedFeatureRequiredException): any => ({ ...obj, }); @@ -1358,6 +1457,9 @@ export interface GetDocumentRequest { } export namespace GetDocumentRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetDocumentRequest): any => ({ ...obj, }); @@ -1398,6 +1500,9 @@ export interface AttachmentContent { } export namespace AttachmentContent { + /** + * @internal + */ export const filterSensitiveLog = (obj: AttachmentContent): any => ({ ...obj, }); @@ -1472,6 +1577,9 @@ export interface GetDocumentResult { } export namespace GetDocumentResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetDocumentResult): any => ({ ...obj, }); @@ -1514,6 +1622,9 @@ export interface InventoryFilter { } export namespace InventoryFilter { + /** + * @internal + */ export const filterSensitiveLog = (obj: InventoryFilter): any => ({ ...obj, }); @@ -1538,6 +1649,9 @@ export interface InventoryGroup { } export namespace InventoryGroup { + /** + * @internal + */ export const filterSensitiveLog = (obj: InventoryGroup): any => ({ ...obj, }); @@ -1555,6 +1669,9 @@ export interface ResultAttribute { } export namespace ResultAttribute { + /** + * @internal + */ export const filterSensitiveLog = (obj: ResultAttribute): any => ({ ...obj, }); @@ -1594,6 +1711,9 @@ export interface InventoryResultItem { } export namespace InventoryResultItem { + /** + * @internal + */ export const filterSensitiveLog = (obj: InventoryResultItem): any => ({ ...obj, }); @@ -1617,6 +1737,9 @@ export interface InventoryResultEntity { } export namespace InventoryResultEntity { + /** + * @internal + */ export const filterSensitiveLog = (obj: InventoryResultEntity): any => ({ ...obj, }); @@ -1636,6 +1759,9 @@ export interface GetInventoryResult { } export namespace GetInventoryResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetInventoryResult): any => ({ ...obj, }); @@ -1653,6 +1779,9 @@ export interface InvalidAggregatorException extends __SmithyException, $Metadata } export namespace InvalidAggregatorException { + /** + * @internal + */ export const filterSensitiveLog = (obj: InvalidAggregatorException): any => ({ ...obj, }); @@ -1668,6 +1797,9 @@ export interface InvalidInventoryGroupException extends __SmithyException, $Meta } export namespace InvalidInventoryGroupException { + /** + * @internal + */ export const filterSensitiveLog = (obj: InvalidInventoryGroupException): any => ({ ...obj, }); @@ -1683,6 +1815,9 @@ export interface InvalidResultAttributeException extends __SmithyException, $Met } export namespace InvalidResultAttributeException { + /** + * @internal + */ export const filterSensitiveLog = (obj: InvalidResultAttributeException): any => ({ ...obj, }); @@ -1721,6 +1856,9 @@ export interface GetInventorySchemaRequest { } export namespace GetInventorySchemaRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetInventorySchemaRequest): any => ({ ...obj, }); @@ -1748,6 +1886,9 @@ export interface InventoryItemAttribute { } export namespace InventoryItemAttribute { + /** + * @internal + */ export const filterSensitiveLog = (obj: InventoryItemAttribute): any => ({ ...obj, }); @@ -1783,6 +1924,9 @@ export interface InventoryItemSchema { } export namespace InventoryItemSchema { + /** + * @internal + */ export const filterSensitiveLog = (obj: InventoryItemSchema): any => ({ ...obj, }); @@ -1802,6 +1946,9 @@ export interface GetInventorySchemaResult { } export namespace GetInventorySchemaResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetInventorySchemaResult): any => ({ ...obj, }); @@ -1815,6 +1962,9 @@ export interface GetMaintenanceWindowRequest { } export namespace GetMaintenanceWindowRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetMaintenanceWindowRequest): any => ({ ...obj, }); @@ -1907,6 +2057,9 @@ export interface GetMaintenanceWindowResult { } export namespace GetMaintenanceWindowResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetMaintenanceWindowResult): any => ({ ...obj, ...(obj.Description && { Description: SENSITIVE_STRING }), @@ -1921,6 +2074,9 @@ export interface GetMaintenanceWindowExecutionRequest { } export namespace GetMaintenanceWindowExecutionRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetMaintenanceWindowExecutionRequest): any => ({ ...obj, }); @@ -1959,6 +2115,9 @@ export interface GetMaintenanceWindowExecutionResult { } export namespace GetMaintenanceWindowExecutionResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetMaintenanceWindowExecutionResult): any => ({ ...obj, }); @@ -1978,6 +2137,9 @@ export interface GetMaintenanceWindowExecutionTaskRequest { } export namespace GetMaintenanceWindowExecutionTaskRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetMaintenanceWindowExecutionTaskRequest): any => ({ ...obj, }); @@ -2063,6 +2225,9 @@ export interface GetMaintenanceWindowExecutionTaskResult { } export namespace GetMaintenanceWindowExecutionTaskResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetMaintenanceWindowExecutionTaskResult): any => ({ ...obj, ...(obj.TaskParameters && { TaskParameters: SENSITIVE_STRING }), @@ -2087,6 +2252,9 @@ export interface GetMaintenanceWindowExecutionTaskInvocationRequest { } export namespace GetMaintenanceWindowExecutionTaskInvocationRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetMaintenanceWindowExecutionTaskInvocationRequest): any => ({ ...obj, }); @@ -2158,6 +2326,9 @@ export interface GetMaintenanceWindowExecutionTaskInvocationResult { } export namespace GetMaintenanceWindowExecutionTaskInvocationResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetMaintenanceWindowExecutionTaskInvocationResult): any => ({ ...obj, ...(obj.Parameters && { Parameters: SENSITIVE_STRING }), @@ -2178,6 +2349,9 @@ export interface GetMaintenanceWindowTaskRequest { } export namespace GetMaintenanceWindowTaskRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetMaintenanceWindowTaskRequest): any => ({ ...obj, }); @@ -2215,6 +2389,9 @@ export interface MaintenanceWindowAutomationParameters { } export namespace MaintenanceWindowAutomationParameters { + /** + * @internal + */ export const filterSensitiveLog = (obj: MaintenanceWindowAutomationParameters): any => ({ ...obj, }); @@ -2261,6 +2438,9 @@ export interface MaintenanceWindowLambdaParameters { } export namespace MaintenanceWindowLambdaParameters { + /** + * @internal + */ export const filterSensitiveLog = (obj: MaintenanceWindowLambdaParameters): any => ({ ...obj, ...(obj.Payload && { Payload: SENSITIVE_STRING }), @@ -2309,6 +2489,9 @@ export interface NotificationConfig { } export namespace NotificationConfig { + /** + * @internal + */ export const filterSensitiveLog = (obj: NotificationConfig): any => ({ ...obj, }); @@ -2401,6 +2584,9 @@ export interface MaintenanceWindowRunCommandParameters { } export namespace MaintenanceWindowRunCommandParameters { + /** + * @internal + */ export const filterSensitiveLog = (obj: MaintenanceWindowRunCommandParameters): any => ({ ...obj, }); @@ -2438,6 +2624,9 @@ export interface MaintenanceWindowStepFunctionsParameters { } export namespace MaintenanceWindowStepFunctionsParameters { + /** + * @internal + */ export const filterSensitiveLog = (obj: MaintenanceWindowStepFunctionsParameters): any => ({ ...obj, ...(obj.Input && { Input: SENSITIVE_STRING }), @@ -2470,6 +2659,9 @@ export interface MaintenanceWindowTaskInvocationParameters { } export namespace MaintenanceWindowTaskInvocationParameters { + /** + * @internal + */ export const filterSensitiveLog = (obj: MaintenanceWindowTaskInvocationParameters): any => ({ ...obj, ...(obj.StepFunctions && { @@ -2582,6 +2774,9 @@ export interface GetMaintenanceWindowTaskResult { } export namespace GetMaintenanceWindowTaskResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetMaintenanceWindowTaskResult): any => ({ ...obj, ...(obj.TaskParameters && { TaskParameters: SENSITIVE_STRING }), @@ -2602,6 +2797,9 @@ export interface GetOpsItemRequest { } export namespace GetOpsItemRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetOpsItemRequest): any => ({ ...obj, }); @@ -2750,6 +2948,9 @@ export interface OpsItem { } export namespace OpsItem { + /** + * @internal + */ export const filterSensitiveLog = (obj: OpsItem): any => ({ ...obj, }); @@ -2763,6 +2964,9 @@ export interface GetOpsItemResponse { } export namespace GetOpsItemResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetOpsItemResponse): any => ({ ...obj, }); @@ -2778,6 +2982,9 @@ export interface OpsItemNotFoundException extends __SmithyException, $MetadataBe } export namespace OpsItemNotFoundException { + /** + * @internal + */ export const filterSensitiveLog = (obj: OpsItemNotFoundException): any => ({ ...obj, }); @@ -2802,6 +3009,9 @@ export interface GetOpsMetadataRequest { } export namespace GetOpsMetadataRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetOpsMetadataRequest): any => ({ ...obj, }); @@ -2826,6 +3036,9 @@ export interface GetOpsMetadataResult { } export namespace GetOpsMetadataResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetOpsMetadataResult): any => ({ ...obj, }); @@ -2861,6 +3074,9 @@ export interface OpsFilter { } export namespace OpsFilter { + /** + * @internal + */ export const filterSensitiveLog = (obj: OpsFilter): any => ({ ...obj, }); @@ -2878,6 +3094,9 @@ export interface OpsResultAttribute { } export namespace OpsResultAttribute { + /** + * @internal + */ export const filterSensitiveLog = (obj: OpsResultAttribute): any => ({ ...obj, }); @@ -2899,6 +3118,9 @@ export interface OpsEntityItem { } export namespace OpsEntityItem { + /** + * @internal + */ export const filterSensitiveLog = (obj: OpsEntityItem): any => ({ ...obj, }); @@ -2920,6 +3142,9 @@ export interface OpsEntity { } export namespace OpsEntity { + /** + * @internal + */ export const filterSensitiveLog = (obj: OpsEntity): any => ({ ...obj, }); @@ -2939,6 +3164,9 @@ export interface GetOpsSummaryResult { } export namespace GetOpsSummaryResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetOpsSummaryResult): any => ({ ...obj, }); @@ -2958,6 +3186,9 @@ export interface GetParameterRequest { } export namespace GetParameterRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetParameterRequest): any => ({ ...obj, }); @@ -3020,6 +3251,9 @@ export interface Parameter { } export namespace Parameter { + /** + * @internal + */ export const filterSensitiveLog = (obj: Parameter): any => ({ ...obj, }); @@ -3033,6 +3267,9 @@ export interface GetParameterResult { } export namespace GetParameterResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetParameterResult): any => ({ ...obj, }); @@ -3048,6 +3285,9 @@ export interface InvalidKeyId extends __SmithyException, $MetadataBearer { } export namespace InvalidKeyId { + /** + * @internal + */ export const filterSensitiveLog = (obj: InvalidKeyId): any => ({ ...obj, }); @@ -3064,6 +3304,9 @@ export interface ParameterVersionNotFound extends __SmithyException, $MetadataBe } export namespace ParameterVersionNotFound { + /** + * @internal + */ export const filterSensitiveLog = (obj: ParameterVersionNotFound): any => ({ ...obj, }); @@ -3095,6 +3338,9 @@ export interface GetParameterHistoryRequest { } export namespace GetParameterHistoryRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetParameterHistoryRequest): any => ({ ...obj, }); @@ -3176,6 +3422,9 @@ export interface ParameterHistory { } export namespace ParameterHistory { + /** + * @internal + */ export const filterSensitiveLog = (obj: ParameterHistory): any => ({ ...obj, }); @@ -3195,6 +3444,9 @@ export interface GetParameterHistoryResult { } export namespace GetParameterHistoryResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetParameterHistoryResult): any => ({ ...obj, }); @@ -3214,6 +3466,9 @@ export interface GetParametersRequest { } export namespace GetParametersRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetParametersRequest): any => ({ ...obj, }); @@ -3233,6 +3488,9 @@ export interface GetParametersResult { } export namespace GetParametersResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetParametersResult): any => ({ ...obj, }); @@ -3292,6 +3550,9 @@ export interface GetParametersByPathRequest { } export namespace GetParametersByPathRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetParametersByPathRequest): any => ({ ...obj, }); @@ -3311,6 +3572,9 @@ export interface GetParametersByPathResult { } export namespace GetParametersByPathResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetParametersByPathResult): any => ({ ...obj, }); @@ -3324,6 +3588,9 @@ export interface GetPatchBaselineRequest { } export namespace GetPatchBaselineRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetPatchBaselineRequest): any => ({ ...obj, }); @@ -3412,6 +3679,9 @@ export interface GetPatchBaselineResult { } export namespace GetPatchBaselineResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetPatchBaselineResult): any => ({ ...obj, ...(obj.Sources && { Sources: obj.Sources.map((item) => PatchSource.filterSensitiveLog(item)) }), @@ -3431,6 +3701,9 @@ export interface GetPatchBaselineForPatchGroupRequest { } export namespace GetPatchBaselineForPatchGroupRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetPatchBaselineForPatchGroupRequest): any => ({ ...obj, }); @@ -3454,6 +3727,9 @@ export interface GetPatchBaselineForPatchGroupResult { } export namespace GetPatchBaselineForPatchGroupResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetPatchBaselineForPatchGroupResult): any => ({ ...obj, }); @@ -3475,6 +3751,9 @@ export interface GetServiceSettingRequest { } export namespace GetServiceSettingRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetServiceSettingRequest): any => ({ ...obj, }); @@ -3544,6 +3823,9 @@ export interface ServiceSetting { } export namespace ServiceSetting { + /** + * @internal + */ export const filterSensitiveLog = (obj: ServiceSetting): any => ({ ...obj, }); @@ -3560,6 +3842,9 @@ export interface GetServiceSettingResult { } export namespace GetServiceSettingResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetServiceSettingResult): any => ({ ...obj, }); @@ -3576,6 +3861,9 @@ export interface ServiceSettingNotFound extends __SmithyException, $MetadataBear } export namespace ServiceSettingNotFound { + /** + * @internal + */ export const filterSensitiveLog = (obj: ServiceSettingNotFound): any => ({ ...obj, }); @@ -3600,6 +3888,9 @@ export interface LabelParameterVersionRequest { } export namespace LabelParameterVersionRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: LabelParameterVersionRequest): any => ({ ...obj, }); @@ -3620,6 +3911,9 @@ export interface LabelParameterVersionResult { } export namespace LabelParameterVersionResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: LabelParameterVersionResult): any => ({ ...obj, }); @@ -3635,6 +3929,9 @@ export interface ParameterVersionLabelLimitExceeded extends __SmithyException, $ } export namespace ParameterVersionLabelLimitExceeded { + /** + * @internal + */ export const filterSensitiveLog = (obj: ParameterVersionLabelLimitExceeded): any => ({ ...obj, }); @@ -3671,6 +3968,9 @@ export interface AssociationFilter { } export namespace AssociationFilter { + /** + * @internal + */ export const filterSensitiveLog = (obj: AssociationFilter): any => ({ ...obj, }); @@ -3702,6 +4002,9 @@ export interface ListAssociationsRequest { } export namespace ListAssociationsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListAssociationsRequest): any => ({ ...obj, }); @@ -3765,6 +4068,9 @@ export interface Association { } export namespace Association { + /** + * @internal + */ export const filterSensitiveLog = (obj: Association): any => ({ ...obj, }); @@ -3784,6 +4090,9 @@ export interface ListAssociationsResult { } export namespace ListAssociationsResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListAssociationsResult): any => ({ ...obj, }); @@ -3808,6 +4117,9 @@ export interface ListAssociationVersionsRequest { } export namespace ListAssociationVersionsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListAssociationVersionsRequest): any => ({ ...obj, }); @@ -3930,6 +4242,9 @@ export interface AssociationVersionInfo { } export namespace AssociationVersionInfo { + /** + * @internal + */ export const filterSensitiveLog = (obj: AssociationVersionInfo): any => ({ ...obj, }); @@ -3949,6 +4264,9 @@ export interface ListAssociationVersionsResult { } export namespace ListAssociationVersionsResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListAssociationVersionsResult): any => ({ ...obj, }); @@ -4062,6 +4380,9 @@ export interface CommandFilter { } export namespace CommandFilter { + /** + * @internal + */ export const filterSensitiveLog = (obj: CommandFilter): any => ({ ...obj, }); @@ -4104,6 +4425,9 @@ export interface ListCommandInvocationsRequest { } export namespace ListCommandInvocationsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListCommandInvocationsRequest): any => ({ ...obj, }); @@ -4251,6 +4575,9 @@ export interface CommandPlugin { } export namespace CommandPlugin { + /** + * @internal + */ export const filterSensitiveLog = (obj: CommandPlugin): any => ({ ...obj, }); @@ -4399,6 +4726,9 @@ export interface CommandInvocation { } export namespace CommandInvocation { + /** + * @internal + */ export const filterSensitiveLog = (obj: CommandInvocation): any => ({ ...obj, }); @@ -4418,6 +4748,9 @@ export interface ListCommandInvocationsResult { } export namespace ListCommandInvocationsResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListCommandInvocationsResult): any => ({ ...obj, }); @@ -4458,6 +4791,9 @@ export interface ListCommandsRequest { } export namespace ListCommandsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListCommandsRequest): any => ({ ...obj, }); @@ -4656,6 +4992,9 @@ export interface Command { } export namespace Command { + /** + * @internal + */ export const filterSensitiveLog = (obj: Command): any => ({ ...obj, }); @@ -4675,6 +5014,9 @@ export interface ListCommandsResult { } export namespace ListCommandsResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListCommandsResult): any => ({ ...obj, }); @@ -4710,6 +5052,9 @@ export interface ComplianceStringFilter { } export namespace ComplianceStringFilter { + /** + * @internal + */ export const filterSensitiveLog = (obj: ComplianceStringFilter): any => ({ ...obj, }); @@ -4747,6 +5092,9 @@ export interface ListComplianceItemsRequest { } export namespace ListComplianceItemsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListComplianceItemsRequest): any => ({ ...obj, }); @@ -4777,6 +5125,9 @@ export interface ComplianceExecutionSummary { } export namespace ComplianceExecutionSummary { + /** + * @internal + */ export const filterSensitiveLog = (obj: ComplianceExecutionSummary): any => ({ ...obj, }); @@ -4857,6 +5208,9 @@ export interface ComplianceItem { } export namespace ComplianceItem { + /** + * @internal + */ export const filterSensitiveLog = (obj: ComplianceItem): any => ({ ...obj, }); @@ -4876,6 +5230,9 @@ export interface ListComplianceItemsResult { } export namespace ListComplianceItemsResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListComplianceItemsResult): any => ({ ...obj, }); @@ -4902,6 +5259,9 @@ export interface ListComplianceSummariesRequest { } export namespace ListComplianceSummariesRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListComplianceSummariesRequest): any => ({ ...obj, }); @@ -4952,6 +5312,9 @@ export interface SeveritySummary { } export namespace SeveritySummary { + /** + * @internal + */ export const filterSensitiveLog = (obj: SeveritySummary): any => ({ ...obj, }); @@ -4974,6 +5337,9 @@ export interface CompliantSummary { } export namespace CompliantSummary { + /** + * @internal + */ export const filterSensitiveLog = (obj: CompliantSummary): any => ({ ...obj, }); @@ -4996,6 +5362,9 @@ export interface NonCompliantSummary { } export namespace NonCompliantSummary { + /** + * @internal + */ export const filterSensitiveLog = (obj: NonCompliantSummary): any => ({ ...obj, }); @@ -5023,6 +5392,9 @@ export interface ComplianceSummaryItem { } export namespace ComplianceSummaryItem { + /** + * @internal + */ export const filterSensitiveLog = (obj: ComplianceSummaryItem): any => ({ ...obj, }); @@ -5044,6 +5416,9 @@ export interface ListComplianceSummariesResult { } export namespace ListComplianceSummariesResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListComplianceSummariesResult): any => ({ ...obj, }); @@ -5084,6 +5459,9 @@ export interface ListDocumentMetadataHistoryRequest { } export namespace ListDocumentMetadataHistoryRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListDocumentMetadataHistoryRequest): any => ({ ...obj, }); @@ -5111,6 +5489,9 @@ export interface DocumentReviewCommentSource { } export namespace DocumentReviewCommentSource { + /** + * @internal + */ export const filterSensitiveLog = (obj: DocumentReviewCommentSource): any => ({ ...obj, }); @@ -5152,6 +5533,9 @@ export interface DocumentReviewerResponseSource { } export namespace DocumentReviewerResponseSource { + /** + * @internal + */ export const filterSensitiveLog = (obj: DocumentReviewerResponseSource): any => ({ ...obj, }); @@ -5168,6 +5552,9 @@ export interface DocumentMetadataResponseInfo { } export namespace DocumentMetadataResponseInfo { + /** + * @internal + */ export const filterSensitiveLog = (obj: DocumentMetadataResponseInfo): any => ({ ...obj, }); @@ -5202,6 +5589,9 @@ export interface ListDocumentMetadataHistoryResponse { } export namespace ListDocumentMetadataHistoryResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListDocumentMetadataHistoryResponse): any => ({ ...obj, }); @@ -5230,6 +5620,9 @@ export interface DocumentFilter { } export namespace DocumentFilter { + /** + * @internal + */ export const filterSensitiveLog = (obj: DocumentFilter): any => ({ ...obj, }); @@ -5342,6 +5735,9 @@ export interface DocumentKeyValuesFilter { } export namespace DocumentKeyValuesFilter { + /** + * @internal + */ export const filterSensitiveLog = (obj: DocumentKeyValuesFilter): any => ({ ...obj, }); @@ -5382,6 +5778,9 @@ export interface ListDocumentsRequest { } export namespace ListDocumentsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListDocumentsRequest): any => ({ ...obj, }); @@ -5464,6 +5863,9 @@ export interface DocumentIdentifier { } export namespace DocumentIdentifier { + /** + * @internal + */ export const filterSensitiveLog = (obj: DocumentIdentifier): any => ({ ...obj, }); @@ -5483,6 +5885,9 @@ export interface ListDocumentsResult { } export namespace ListDocumentsResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListDocumentsResult): any => ({ ...obj, }); @@ -5508,6 +5913,9 @@ export interface ListDocumentVersionsRequest { } export namespace ListDocumentVersionsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListDocumentVersionsRequest): any => ({ ...obj, }); @@ -5568,6 +5976,9 @@ export interface DocumentVersionInfo { } export namespace DocumentVersionInfo { + /** + * @internal + */ export const filterSensitiveLog = (obj: DocumentVersionInfo): any => ({ ...obj, }); @@ -5587,6 +5998,9 @@ export interface ListDocumentVersionsResult { } export namespace ListDocumentVersionsResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListDocumentVersionsResult): any => ({ ...obj, }); @@ -5622,6 +6036,9 @@ export interface ListInventoryEntriesRequest { } export namespace ListInventoryEntriesRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListInventoryEntriesRequest): any => ({ ...obj, }); @@ -5661,6 +6078,9 @@ export interface ListInventoryEntriesResult { } export namespace ListInventoryEntriesResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListInventoryEntriesResult): any => ({ ...obj, }); @@ -5698,6 +6118,9 @@ export interface OpsItemEventFilter { } export namespace OpsItemEventFilter { + /** + * @internal + */ export const filterSensitiveLog = (obj: OpsItemEventFilter): any => ({ ...obj, }); @@ -5722,6 +6145,9 @@ export interface ListOpsItemEventsRequest { } export namespace ListOpsItemEventsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListOpsItemEventsRequest): any => ({ ...obj, }); @@ -5738,6 +6164,9 @@ export interface OpsItemIdentity { } export namespace OpsItemIdentity { + /** + * @internal + */ export const filterSensitiveLog = (obj: OpsItemIdentity): any => ({ ...obj, }); @@ -5784,6 +6213,9 @@ export interface OpsItemEventSummary { } export namespace OpsItemEventSummary { + /** + * @internal + */ export const filterSensitiveLog = (obj: OpsItemEventSummary): any => ({ ...obj, }); @@ -5803,6 +6235,9 @@ export interface ListOpsItemEventsResponse { } export namespace ListOpsItemEventsResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListOpsItemEventsResponse): any => ({ ...obj, }); @@ -5824,6 +6259,9 @@ export interface OpsMetadataFilter { } export namespace OpsMetadataFilter { + /** + * @internal + */ export const filterSensitiveLog = (obj: OpsMetadataFilter): any => ({ ...obj, }); @@ -5848,6 +6286,9 @@ export interface ListOpsMetadataRequest { } export namespace ListOpsMetadataRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListOpsMetadataRequest): any => ({ ...obj, }); @@ -5884,6 +6325,9 @@ export interface OpsMetadata { } export namespace OpsMetadata { + /** + * @internal + */ export const filterSensitiveLog = (obj: OpsMetadata): any => ({ ...obj, }); @@ -5903,6 +6347,9 @@ export interface ListOpsMetadataResult { } export namespace ListOpsMetadataResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListOpsMetadataResult): any => ({ ...obj, }); @@ -5927,6 +6374,9 @@ export interface ListResourceComplianceSummariesRequest { } export namespace ListResourceComplianceSummariesRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListResourceComplianceSummariesRequest): any => ({ ...obj, }); @@ -5979,6 +6429,9 @@ export interface ResourceComplianceSummaryItem { } export namespace ResourceComplianceSummaryItem { + /** + * @internal + */ export const filterSensitiveLog = (obj: ResourceComplianceSummaryItem): any => ({ ...obj, }); @@ -6000,6 +6453,9 @@ export interface ListResourceComplianceSummariesResult { } export namespace ListResourceComplianceSummariesResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListResourceComplianceSummariesResult): any => ({ ...obj, }); @@ -6027,6 +6483,9 @@ export interface ListResourceDataSyncRequest { } export namespace ListResourceDataSyncRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListResourceDataSyncRequest): any => ({ ...obj, }); @@ -6107,6 +6566,9 @@ export interface ResourceDataSyncSourceWithState { } export namespace ResourceDataSyncSourceWithState { + /** + * @internal + */ export const filterSensitiveLog = (obj: ResourceDataSyncSourceWithState): any => ({ ...obj, }); @@ -6172,6 +6634,9 @@ export interface ResourceDataSyncItem { } export namespace ResourceDataSyncItem { + /** + * @internal + */ export const filterSensitiveLog = (obj: ResourceDataSyncItem): any => ({ ...obj, }); @@ -6191,6 +6656,9 @@ export interface ListResourceDataSyncResult { } export namespace ListResourceDataSyncResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListResourceDataSyncResult): any => ({ ...obj, }); @@ -6209,6 +6677,9 @@ export interface ListTagsForResourceRequest { } export namespace ListTagsForResourceRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListTagsForResourceRequest): any => ({ ...obj, }); @@ -6222,6 +6693,9 @@ export interface ListTagsForResourceResult { } export namespace ListTagsForResourceResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListTagsForResourceResult): any => ({ ...obj, }); @@ -6239,6 +6713,9 @@ export interface DocumentPermissionLimit extends __SmithyException, $MetadataBea } export namespace DocumentPermissionLimit { + /** + * @internal + */ export const filterSensitiveLog = (obj: DocumentPermissionLimit): any => ({ ...obj, }); @@ -6278,6 +6755,9 @@ export interface ModifyDocumentPermissionRequest { } export namespace ModifyDocumentPermissionRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ModifyDocumentPermissionRequest): any => ({ ...obj, }); @@ -6286,6 +6766,9 @@ export namespace ModifyDocumentPermissionRequest { export interface ModifyDocumentPermissionResponse {} export namespace ModifyDocumentPermissionResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ModifyDocumentPermissionResponse): any => ({ ...obj, }); @@ -6302,6 +6785,9 @@ export interface ComplianceTypeCountLimitExceededException extends __SmithyExcep } export namespace ComplianceTypeCountLimitExceededException { + /** + * @internal + */ export const filterSensitiveLog = (obj: ComplianceTypeCountLimitExceededException): any => ({ ...obj, }); @@ -6318,6 +6804,9 @@ export interface InvalidItemContentException extends __SmithyException, $Metadat } export namespace InvalidItemContentException { + /** + * @internal + */ export const filterSensitiveLog = (obj: InvalidItemContentException): any => ({ ...obj, }); @@ -6334,6 +6823,9 @@ export interface ItemSizeLimitExceededException extends __SmithyException, $Meta } export namespace ItemSizeLimitExceededException { + /** + * @internal + */ export const filterSensitiveLog = (obj: ItemSizeLimitExceededException): any => ({ ...obj, }); @@ -6374,6 +6866,9 @@ export interface ComplianceItemEntry { } export namespace ComplianceItemEntry { + /** + * @internal + */ export const filterSensitiveLog = (obj: ComplianceItemEntry): any => ({ ...obj, }); @@ -6439,6 +6934,9 @@ export interface PutComplianceItemsRequest { } export namespace PutComplianceItemsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: PutComplianceItemsRequest): any => ({ ...obj, }); @@ -6447,6 +6945,9 @@ export namespace PutComplianceItemsRequest { export interface PutComplianceItemsResult {} export namespace PutComplianceItemsResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: PutComplianceItemsResult): any => ({ ...obj, }); @@ -6462,6 +6963,9 @@ export interface TotalSizeLimitExceededException extends __SmithyException, $Met } export namespace TotalSizeLimitExceededException { + /** + * @internal + */ export const filterSensitiveLog = (obj: TotalSizeLimitExceededException): any => ({ ...obj, }); @@ -6478,6 +6982,9 @@ export interface CustomSchemaCountLimitExceededException extends __SmithyExcepti } export namespace CustomSchemaCountLimitExceededException { + /** + * @internal + */ export const filterSensitiveLog = (obj: CustomSchemaCountLimitExceededException): any => ({ ...obj, }); @@ -6494,6 +7001,9 @@ export interface InvalidInventoryItemContextException extends __SmithyException, } export namespace InvalidInventoryItemContextException { + /** + * @internal + */ export const filterSensitiveLog = (obj: InvalidInventoryItemContextException): any => ({ ...obj, }); @@ -6510,6 +7020,9 @@ export interface ItemContentMismatchException extends __SmithyException, $Metada } export namespace ItemContentMismatchException { + /** + * @internal + */ export const filterSensitiveLog = (obj: ItemContentMismatchException): any => ({ ...obj, }); @@ -6558,6 +7071,9 @@ export interface InventoryItem { } export namespace InventoryItem { + /** + * @internal + */ export const filterSensitiveLog = (obj: InventoryItem): any => ({ ...obj, }); @@ -6576,6 +7092,9 @@ export interface PutInventoryRequest { } export namespace PutInventoryRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: PutInventoryRequest): any => ({ ...obj, }); @@ -6589,6 +7108,9 @@ export interface PutInventoryResult { } export namespace PutInventoryResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: PutInventoryResult): any => ({ ...obj, }); @@ -6604,6 +7126,9 @@ export interface SubTypeCountLimitExceededException extends __SmithyException, $ } export namespace SubTypeCountLimitExceededException { + /** + * @internal + */ export const filterSensitiveLog = (obj: SubTypeCountLimitExceededException): any => ({ ...obj, }); @@ -6622,6 +7147,9 @@ export interface UnsupportedInventoryItemContextException extends __SmithyExcept } export namespace UnsupportedInventoryItemContextException { + /** + * @internal + */ export const filterSensitiveLog = (obj: UnsupportedInventoryItemContextException): any => ({ ...obj, }); @@ -6638,6 +7166,9 @@ export interface UnsupportedInventorySchemaVersionException extends __SmithyExce } export namespace UnsupportedInventorySchemaVersionException { + /** + * @internal + */ export const filterSensitiveLog = (obj: UnsupportedInventorySchemaVersionException): any => ({ ...obj, }); @@ -6658,6 +7189,9 @@ export interface HierarchyLevelLimitExceededException extends __SmithyException, } export namespace HierarchyLevelLimitExceededException { + /** + * @internal + */ export const filterSensitiveLog = (obj: HierarchyLevelLimitExceededException): any => ({ ...obj, }); @@ -6680,6 +7214,9 @@ export interface HierarchyTypeMismatchException extends __SmithyException, $Meta } export namespace HierarchyTypeMismatchException { + /** + * @internal + */ export const filterSensitiveLog = (obj: HierarchyTypeMismatchException): any => ({ ...obj, }); @@ -6696,6 +7233,9 @@ export interface IncompatiblePolicyException extends __SmithyException, $Metadat } export namespace IncompatiblePolicyException { + /** + * @internal + */ export const filterSensitiveLog = (obj: IncompatiblePolicyException): any => ({ ...obj, }); @@ -6714,6 +7254,9 @@ export interface InvalidAllowedPatternException extends __SmithyException, $Meta } export namespace InvalidAllowedPatternException { + /** + * @internal + */ export const filterSensitiveLog = (obj: InvalidAllowedPatternException): any => ({ ...obj, }); @@ -6729,6 +7272,9 @@ export interface InvalidPolicyAttributeException extends __SmithyException, $Met } export namespace InvalidPolicyAttributeException { + /** + * @internal + */ export const filterSensitiveLog = (obj: InvalidPolicyAttributeException): any => ({ ...obj, }); @@ -6745,6 +7291,9 @@ export interface InvalidPolicyTypeException extends __SmithyException, $Metadata } export namespace InvalidPolicyTypeException { + /** + * @internal + */ export const filterSensitiveLog = (obj: InvalidPolicyTypeException): any => ({ ...obj, }); @@ -6760,6 +7309,9 @@ export interface ParameterAlreadyExists extends __SmithyException, $MetadataBear } export namespace ParameterAlreadyExists { + /** + * @internal + */ export const filterSensitiveLog = (obj: ParameterAlreadyExists): any => ({ ...obj, }); @@ -6776,6 +7328,9 @@ export interface ParameterLimitExceeded extends __SmithyException, $MetadataBear } export namespace ParameterLimitExceeded { + /** + * @internal + */ export const filterSensitiveLog = (obj: ParameterLimitExceeded): any => ({ ...obj, }); @@ -6808,6 +7363,9 @@ export interface ParameterMaxVersionLimitExceeded extends __SmithyException, $Me } export namespace ParameterMaxVersionLimitExceeded { + /** + * @internal + */ export const filterSensitiveLog = (obj: ParameterMaxVersionLimitExceeded): any => ({ ...obj, }); @@ -6826,6 +7384,9 @@ export interface ParameterPatternMismatchException extends __SmithyException, $M } export namespace ParameterPatternMismatchException { + /** + * @internal + */ export const filterSensitiveLog = (obj: ParameterPatternMismatchException): any => ({ ...obj, }); @@ -6842,6 +7403,9 @@ export interface PoliciesLimitExceededException extends __SmithyException, $Meta } export namespace PoliciesLimitExceededException { + /** + * @internal + */ export const filterSensitiveLog = (obj: PoliciesLimitExceededException): any => ({ ...obj, }); @@ -7105,6 +7669,9 @@ export interface PutParameterRequest { } export namespace PutParameterRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: PutParameterRequest): any => ({ ...obj, }); @@ -7127,6 +7694,9 @@ export interface PutParameterResult { } export namespace PutParameterResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: PutParameterResult): any => ({ ...obj, }); @@ -7142,6 +7712,9 @@ export interface UnsupportedParameterType extends __SmithyException, $MetadataBe } export namespace UnsupportedParameterType { + /** + * @internal + */ export const filterSensitiveLog = (obj: UnsupportedParameterType): any => ({ ...obj, }); @@ -7155,6 +7728,9 @@ export interface RegisterDefaultPatchBaselineRequest { } export namespace RegisterDefaultPatchBaselineRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: RegisterDefaultPatchBaselineRequest): any => ({ ...obj, }); @@ -7168,6 +7744,9 @@ export interface RegisterDefaultPatchBaselineResult { } export namespace RegisterDefaultPatchBaselineResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: RegisterDefaultPatchBaselineResult): any => ({ ...obj, }); @@ -7186,6 +7765,9 @@ export interface RegisterPatchBaselineForPatchGroupRequest { } export namespace RegisterPatchBaselineForPatchGroupRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: RegisterPatchBaselineForPatchGroupRequest): any => ({ ...obj, }); @@ -7204,6 +7786,9 @@ export interface RegisterPatchBaselineForPatchGroupResult { } export namespace RegisterPatchBaselineForPatchGroupResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: RegisterPatchBaselineForPatchGroupResult): any => ({ ...obj, }); @@ -7300,6 +7885,9 @@ export interface RegisterTargetWithMaintenanceWindowRequest { } export namespace RegisterTargetWithMaintenanceWindowRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: RegisterTargetWithMaintenanceWindowRequest): any => ({ ...obj, ...(obj.OwnerInformation && { OwnerInformation: SENSITIVE_STRING }), @@ -7315,6 +7903,9 @@ export interface RegisterTargetWithMaintenanceWindowResult { } export namespace RegisterTargetWithMaintenanceWindowResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: RegisterTargetWithMaintenanceWindowResult): any => ({ ...obj, }); @@ -7331,6 +7922,9 @@ export interface FeatureNotAvailableException extends __SmithyException, $Metada } export namespace FeatureNotAvailableException { + /** + * @internal + */ export const filterSensitiveLog = (obj: FeatureNotAvailableException): any => ({ ...obj, }); @@ -7470,6 +8064,9 @@ export interface RegisterTaskWithMaintenanceWindowRequest { } export namespace RegisterTaskWithMaintenanceWindowRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: RegisterTaskWithMaintenanceWindowRequest): any => ({ ...obj, ...(obj.TaskParameters && { TaskParameters: SENSITIVE_STRING }), @@ -7490,6 +8087,9 @@ export interface RegisterTaskWithMaintenanceWindowResult { } export namespace RegisterTaskWithMaintenanceWindowResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: RegisterTaskWithMaintenanceWindowResult): any => ({ ...obj, }); @@ -7533,6 +8133,9 @@ export interface RemoveTagsFromResourceRequest { } export namespace RemoveTagsFromResourceRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: RemoveTagsFromResourceRequest): any => ({ ...obj, }); @@ -7541,6 +8144,9 @@ export namespace RemoveTagsFromResourceRequest { export interface RemoveTagsFromResourceResult {} export namespace RemoveTagsFromResourceResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: RemoveTagsFromResourceResult): any => ({ ...obj, }); @@ -7563,6 +8169,9 @@ export interface ResetServiceSettingRequest { } export namespace ResetServiceSettingRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ResetServiceSettingRequest): any => ({ ...obj, }); @@ -7580,6 +8189,9 @@ export interface ResetServiceSettingResult { } export namespace ResetServiceSettingResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: ResetServiceSettingResult): any => ({ ...obj, }); @@ -7593,6 +8205,9 @@ export interface ResumeSessionRequest { } export namespace ResumeSessionRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ResumeSessionRequest): any => ({ ...obj, }); @@ -7626,6 +8241,9 @@ export interface ResumeSessionResponse { } export namespace ResumeSessionResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ResumeSessionResponse): any => ({ ...obj, }); @@ -7642,6 +8260,9 @@ export interface AutomationStepNotFoundException extends __SmithyException, $Met } export namespace AutomationStepNotFoundException { + /** + * @internal + */ export const filterSensitiveLog = (obj: AutomationStepNotFoundException): any => ({ ...obj, }); @@ -7657,6 +8278,9 @@ export interface InvalidAutomationSignalException extends __SmithyException, $Me } export namespace InvalidAutomationSignalException { + /** + * @internal + */ export const filterSensitiveLog = (obj: InvalidAutomationSignalException): any => ({ ...obj, }); @@ -7705,6 +8329,9 @@ export interface SendAutomationSignalRequest { } export namespace SendAutomationSignalRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: SendAutomationSignalRequest): any => ({ ...obj, }); @@ -7713,6 +8340,9 @@ export namespace SendAutomationSignalRequest { export interface SendAutomationSignalResult {} export namespace SendAutomationSignalResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: SendAutomationSignalResult): any => ({ ...obj, }); @@ -7729,6 +8359,9 @@ export interface InvalidNotificationConfig extends __SmithyException, $MetadataB } export namespace InvalidNotificationConfig { + /** + * @internal + */ export const filterSensitiveLog = (obj: InvalidNotificationConfig): any => ({ ...obj, }); @@ -7743,6 +8376,9 @@ export interface InvalidOutputFolder extends __SmithyException, $MetadataBearer } export namespace InvalidOutputFolder { + /** + * @internal + */ export const filterSensitiveLog = (obj: InvalidOutputFolder): any => ({ ...obj, }); @@ -7761,6 +8397,9 @@ export interface InvalidRole extends __SmithyException, $MetadataBearer { } export namespace InvalidRole { + /** + * @internal + */ export const filterSensitiveLog = (obj: InvalidRole): any => ({ ...obj, }); @@ -7897,6 +8536,9 @@ export interface SendCommandRequest { } export namespace SendCommandRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: SendCommandRequest): any => ({ ...obj, }); @@ -7911,6 +8553,9 @@ export interface SendCommandResult { } export namespace SendCommandResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: SendCommandResult): any => ({ ...obj, }); @@ -7926,6 +8571,9 @@ export interface InvalidAssociation extends __SmithyException, $MetadataBearer { } export namespace InvalidAssociation { + /** + * @internal + */ export const filterSensitiveLog = (obj: InvalidAssociation): any => ({ ...obj, }); @@ -7939,6 +8587,9 @@ export interface StartAssociationsOnceRequest { } export namespace StartAssociationsOnceRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: StartAssociationsOnceRequest): any => ({ ...obj, }); @@ -7947,6 +8598,9 @@ export namespace StartAssociationsOnceRequest { export interface StartAssociationsOnceResult {} export namespace StartAssociationsOnceResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: StartAssociationsOnceResult): any => ({ ...obj, }); @@ -7962,6 +8616,9 @@ export interface AutomationDefinitionNotFoundException extends __SmithyException } export namespace AutomationDefinitionNotFoundException { + /** + * @internal + */ export const filterSensitiveLog = (obj: AutomationDefinitionNotFoundException): any => ({ ...obj, }); @@ -7977,6 +8634,9 @@ export interface AutomationDefinitionVersionNotFoundException extends __SmithyEx } export namespace AutomationDefinitionVersionNotFoundException { + /** + * @internal + */ export const filterSensitiveLog = (obj: AutomationDefinitionVersionNotFoundException): any => ({ ...obj, }); @@ -7993,6 +8653,9 @@ export interface AutomationExecutionLimitExceededException extends __SmithyExcep } export namespace AutomationExecutionLimitExceededException { + /** + * @internal + */ export const filterSensitiveLog = (obj: AutomationExecutionLimitExceededException): any => ({ ...obj, }); @@ -8010,6 +8673,9 @@ export interface InvalidAutomationExecutionParametersException extends __SmithyE } export namespace InvalidAutomationExecutionParametersException { + /** + * @internal + */ export const filterSensitiveLog = (obj: InvalidAutomationExecutionParametersException): any => ({ ...obj, }); @@ -8120,6 +8786,9 @@ export interface StartAutomationExecutionRequest { } export namespace StartAutomationExecutionRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: StartAutomationExecutionRequest): any => ({ ...obj, }); @@ -8133,6 +8802,9 @@ export interface StartAutomationExecutionResult { } export namespace StartAutomationExecutionResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: StartAutomationExecutionResult): any => ({ ...obj, }); @@ -8149,6 +8821,9 @@ export interface AutomationDefinitionNotApprovedException extends __SmithyExcept } export namespace AutomationDefinitionNotApprovedException { + /** + * @internal + */ export const filterSensitiveLog = (obj: AutomationDefinitionNotApprovedException): any => ({ ...obj, }); @@ -8237,6 +8912,9 @@ export interface StartChangeRequestExecutionRequest { } export namespace StartChangeRequestExecutionRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: StartChangeRequestExecutionRequest): any => ({ ...obj, }); @@ -8251,6 +8929,9 @@ export interface StartChangeRequestExecutionResult { } export namespace StartChangeRequestExecutionResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: StartChangeRequestExecutionResult): any => ({ ...obj, }); @@ -8276,6 +8957,9 @@ export interface StartSessionRequest { } export namespace StartSessionRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: StartSessionRequest): any => ({ ...obj, }); @@ -8310,6 +8994,9 @@ export interface StartSessionResponse { } export namespace StartSessionResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: StartSessionResponse): any => ({ ...obj, }); @@ -8328,6 +9015,9 @@ export interface TargetNotConnected extends __SmithyException, $MetadataBearer { } export namespace TargetNotConnected { + /** + * @internal + */ export const filterSensitiveLog = (obj: TargetNotConnected): any => ({ ...obj, }); @@ -8343,6 +9033,9 @@ export interface InvalidAutomationStatusUpdateException extends __SmithyExceptio } export namespace InvalidAutomationStatusUpdateException { + /** + * @internal + */ export const filterSensitiveLog = (obj: InvalidAutomationStatusUpdateException): any => ({ ...obj, }); @@ -8367,6 +9060,9 @@ export interface StopAutomationExecutionRequest { } export namespace StopAutomationExecutionRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: StopAutomationExecutionRequest): any => ({ ...obj, }); @@ -8375,6 +9071,9 @@ export namespace StopAutomationExecutionRequest { export interface StopAutomationExecutionResult {} export namespace StopAutomationExecutionResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: StopAutomationExecutionResult): any => ({ ...obj, }); @@ -8388,6 +9087,9 @@ export interface TerminateSessionRequest { } export namespace TerminateSessionRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: TerminateSessionRequest): any => ({ ...obj, }); @@ -8401,6 +9103,9 @@ export interface TerminateSessionResponse { } export namespace TerminateSessionResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: TerminateSessionResponse): any => ({ ...obj, }); @@ -8425,6 +9130,9 @@ export interface UnlabelParameterVersionRequest { } export namespace UnlabelParameterVersionRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: UnlabelParameterVersionRequest): any => ({ ...obj, }); @@ -8443,6 +9151,9 @@ export interface UnlabelParameterVersionResult { } export namespace UnlabelParameterVersionResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: UnlabelParameterVersionResult): any => ({ ...obj, }); @@ -8459,6 +9170,9 @@ export interface AssociationVersionLimitExceeded extends __SmithyException, $Met } export namespace AssociationVersionLimitExceeded { + /** + * @internal + */ export const filterSensitiveLog = (obj: AssociationVersionLimitExceeded): any => ({ ...obj, }); @@ -8474,6 +9188,9 @@ export interface InvalidUpdate extends __SmithyException, $MetadataBearer { } export namespace InvalidUpdate { + /** + * @internal + */ export const filterSensitiveLog = (obj: InvalidUpdate): any => ({ ...obj, }); @@ -8615,6 +9332,9 @@ export interface UpdateAssociationRequest { } export namespace UpdateAssociationRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateAssociationRequest): any => ({ ...obj, }); @@ -8628,6 +9348,9 @@ export interface UpdateAssociationResult { } export namespace UpdateAssociationResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateAssociationResult): any => ({ ...obj, }); @@ -8642,6 +9365,9 @@ export interface StatusUnchanged extends __SmithyException, $MetadataBearer { } export namespace StatusUnchanged { + /** + * @internal + */ export const filterSensitiveLog = (obj: StatusUnchanged): any => ({ ...obj, }); @@ -8665,6 +9391,9 @@ export interface UpdateAssociationStatusRequest { } export namespace UpdateAssociationStatusRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateAssociationStatusRequest): any => ({ ...obj, }); @@ -8678,6 +9407,9 @@ export interface UpdateAssociationStatusResult { } export namespace UpdateAssociationStatusResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateAssociationStatusResult): any => ({ ...obj, }); @@ -8694,6 +9426,9 @@ export interface DocumentVersionLimitExceeded extends __SmithyException, $Metada } export namespace DocumentVersionLimitExceeded { + /** + * @internal + */ export const filterSensitiveLog = (obj: DocumentVersionLimitExceeded): any => ({ ...obj, }); @@ -8710,6 +9445,9 @@ export interface DuplicateDocumentContent extends __SmithyException, $MetadataBe } export namespace DuplicateDocumentContent { + /** + * @internal + */ export const filterSensitiveLog = (obj: DuplicateDocumentContent): any => ({ ...obj, }); @@ -8726,6 +9464,9 @@ export interface DuplicateDocumentVersionName extends __SmithyException, $Metada } export namespace DuplicateDocumentVersionName { + /** + * @internal + */ export const filterSensitiveLog = (obj: DuplicateDocumentVersionName): any => ({ ...obj, }); @@ -8774,6 +9515,9 @@ export interface UpdateDocumentRequest { } export namespace UpdateDocumentRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateDocumentRequest): any => ({ ...obj, }); @@ -8787,6 +9531,9 @@ export interface UpdateDocumentResult { } export namespace UpdateDocumentResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateDocumentResult): any => ({ ...obj, }); @@ -8805,6 +9552,9 @@ export interface UpdateDocumentDefaultVersionRequest { } export namespace UpdateDocumentDefaultVersionRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateDocumentDefaultVersionRequest): any => ({ ...obj, }); @@ -8831,6 +9581,9 @@ export interface DocumentDefaultVersionDescription { } export namespace DocumentDefaultVersionDescription { + /** + * @internal + */ export const filterSensitiveLog = (obj: DocumentDefaultVersionDescription): any => ({ ...obj, }); @@ -8844,6 +9597,9 @@ export interface UpdateDocumentDefaultVersionResult { } export namespace UpdateDocumentDefaultVersionResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateDocumentDefaultVersionResult): any => ({ ...obj, }); @@ -8872,6 +9628,9 @@ export interface DocumentReviews { } export namespace DocumentReviews { + /** + * @internal + */ export const filterSensitiveLog = (obj: DocumentReviews): any => ({ ...obj, }); @@ -8895,6 +9654,9 @@ export interface UpdateDocumentMetadataRequest { } export namespace UpdateDocumentMetadataRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateDocumentMetadataRequest): any => ({ ...obj, }); @@ -8903,6 +9665,9 @@ export namespace UpdateDocumentMetadataRequest { export interface UpdateDocumentMetadataResponse {} export namespace UpdateDocumentMetadataResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateDocumentMetadataResponse): any => ({ ...obj, }); @@ -8995,6 +9760,9 @@ export interface UpdateMaintenanceWindowRequest { } export namespace UpdateMaintenanceWindowRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateMaintenanceWindowRequest): any => ({ ...obj, ...(obj.Description && { Description: SENSITIVE_STRING }), @@ -9072,6 +9840,9 @@ export interface UpdateMaintenanceWindowResult { } export namespace UpdateMaintenanceWindowResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateMaintenanceWindowResult): any => ({ ...obj, ...(obj.Description && { Description: SENSITIVE_STRING }), @@ -9119,6 +9890,9 @@ export interface UpdateMaintenanceWindowTargetRequest { } export namespace UpdateMaintenanceWindowTargetRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateMaintenanceWindowTargetRequest): any => ({ ...obj, ...(obj.OwnerInformation && { OwnerInformation: SENSITIVE_STRING }), @@ -9159,6 +9933,9 @@ export interface UpdateMaintenanceWindowTargetResult { } export namespace UpdateMaintenanceWindowTargetResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateMaintenanceWindowTargetResult): any => ({ ...obj, ...(obj.OwnerInformation && { OwnerInformation: SENSITIVE_STRING }), @@ -9312,6 +10089,9 @@ export interface UpdateMaintenanceWindowTaskRequest { } export namespace UpdateMaintenanceWindowTaskRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateMaintenanceWindowTaskRequest): any => ({ ...obj, ...(obj.TaskParameters && { TaskParameters: SENSITIVE_STRING }), @@ -9407,6 +10187,9 @@ export interface UpdateMaintenanceWindowTaskResult { } export namespace UpdateMaintenanceWindowTaskResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateMaintenanceWindowTaskResult): any => ({ ...obj, ...(obj.TaskParameters && { TaskParameters: SENSITIVE_STRING }), @@ -9432,6 +10215,9 @@ export interface UpdateManagedInstanceRoleRequest { } export namespace UpdateManagedInstanceRoleRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateManagedInstanceRoleRequest): any => ({ ...obj, }); @@ -9440,6 +10226,9 @@ export namespace UpdateManagedInstanceRoleRequest { export interface UpdateManagedInstanceRoleResult {} export namespace UpdateManagedInstanceRoleResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateManagedInstanceRoleResult): any => ({ ...obj, }); @@ -9553,6 +10342,9 @@ export interface UpdateOpsItemRequest { } export namespace UpdateOpsItemRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateOpsItemRequest): any => ({ ...obj, }); @@ -9561,6 +10353,9 @@ export namespace UpdateOpsItemRequest { export interface UpdateOpsItemResponse {} export namespace UpdateOpsItemResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateOpsItemResponse): any => ({ ...obj, }); @@ -9577,6 +10372,9 @@ export interface OpsMetadataKeyLimitExceededException extends __SmithyException, } export namespace OpsMetadataKeyLimitExceededException { + /** + * @internal + */ export const filterSensitiveLog = (obj: OpsMetadataKeyLimitExceededException): any => ({ ...obj, }); @@ -9600,6 +10398,9 @@ export interface UpdateOpsMetadataRequest { } export namespace UpdateOpsMetadataRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateOpsMetadataRequest): any => ({ ...obj, }); @@ -9613,6 +10414,9 @@ export interface UpdateOpsMetadataResult { } export namespace UpdateOpsMetadataResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateOpsMetadataResult): any => ({ ...obj, }); @@ -9708,6 +10512,9 @@ export interface UpdatePatchBaselineRequest { } export namespace UpdatePatchBaselineRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdatePatchBaselineRequest): any => ({ ...obj, ...(obj.Sources && { Sources: obj.Sources.map((item) => PatchSource.filterSensitiveLog(item)) }), diff --git a/clients/client-ssm/models/models_2.ts b/clients/client-ssm/models/models_2.ts index f3c249625590..547aaffd25c6 100644 --- a/clients/client-ssm/models/models_2.ts +++ b/clients/client-ssm/models/models_2.ts @@ -89,6 +89,9 @@ export interface UpdatePatchBaselineResult { } export namespace UpdatePatchBaselineResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdatePatchBaselineResult): any => ({ ...obj, ...(obj.Sources && { Sources: obj.Sources.map((item) => PatchSource.filterSensitiveLog(item)) }), @@ -106,6 +109,9 @@ export interface ResourceDataSyncConflictException extends __SmithyException, $M } export namespace ResourceDataSyncConflictException { + /** + * @internal + */ export const filterSensitiveLog = (obj: ResourceDataSyncConflictException): any => ({ ...obj, }); @@ -130,6 +136,9 @@ export interface UpdateResourceDataSyncRequest { } export namespace UpdateResourceDataSyncRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateResourceDataSyncRequest): any => ({ ...obj, }); @@ -138,6 +147,9 @@ export namespace UpdateResourceDataSyncRequest { export interface UpdateResourceDataSyncResult {} export namespace UpdateResourceDataSyncResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateResourceDataSyncResult): any => ({ ...obj, }); @@ -208,6 +220,9 @@ export interface UpdateServiceSettingRequest { } export namespace UpdateServiceSettingRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateServiceSettingRequest): any => ({ ...obj, }); @@ -219,6 +234,9 @@ export namespace UpdateServiceSettingRequest { export interface UpdateServiceSettingResult {} export namespace UpdateServiceSettingResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateServiceSettingResult): any => ({ ...obj, }); @@ -246,6 +264,9 @@ export interface InventoryAggregator { } export namespace InventoryAggregator { + /** + * @internal + */ export const filterSensitiveLog = (obj: InventoryAggregator): any => ({ ...obj, }); @@ -289,6 +310,9 @@ export interface OpsAggregator { } export namespace OpsAggregator { + /** + * @internal + */ export const filterSensitiveLog = (obj: OpsAggregator): any => ({ ...obj, }); @@ -327,6 +351,9 @@ export interface GetInventoryRequest { } export namespace GetInventoryRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetInventoryRequest): any => ({ ...obj, }); @@ -366,6 +393,9 @@ export interface GetOpsSummaryRequest { } export namespace GetOpsSummaryRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetOpsSummaryRequest): any => ({ ...obj, }); diff --git a/clients/client-sso-admin/commands/AttachManagedPolicyToPermissionSetCommand.ts b/clients/client-sso-admin/commands/AttachManagedPolicyToPermissionSetCommand.ts index 6de0bfa6e37a..37bdef252122 100644 --- a/clients/client-sso-admin/commands/AttachManagedPolicyToPermissionSetCommand.ts +++ b/clients/client-sso-admin/commands/AttachManagedPolicyToPermissionSetCommand.ts @@ -32,6 +32,20 @@ export interface AttachManagedPolicyToPermissionSetCommandOutput * ProvisionPermissionSet * after this action to apply the corresponding IAM policy updates to all assigned accounts.

* + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { SSOAdminClient, AttachManagedPolicyToPermissionSetCommand } from "@aws-sdk/client-sso-admin"; // ES Modules import + * // const { SSOAdminClient, AttachManagedPolicyToPermissionSetCommand } = require("@aws-sdk/client-sso-admin"); // CommonJS import + * const client = new SSOAdminClient(config); + * const command = new AttachManagedPolicyToPermissionSetCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link AttachManagedPolicyToPermissionSetCommandInput} for command's `input` shape. + * @see {@link AttachManagedPolicyToPermissionSetCommandOutput} for command's `response` shape. + * @see {@link SSOAdminClientResolvedConfig | config} for command's `input` shape. + * */ export class AttachManagedPolicyToPermissionSetCommand extends $Command< AttachManagedPolicyToPermissionSetCommandInput, diff --git a/clients/client-sso-admin/commands/CreateAccountAssignmentCommand.ts b/clients/client-sso-admin/commands/CreateAccountAssignmentCommand.ts index 431458f3e041..50b9f626da24 100644 --- a/clients/client-sso-admin/commands/CreateAccountAssignmentCommand.ts +++ b/clients/client-sso-admin/commands/CreateAccountAssignmentCommand.ts @@ -31,6 +31,20 @@ export interface CreateAccountAssignmentCommandOutput extends CreateAccountAssig * ProvisionPermissionSet * to make these updates.

* + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { SSOAdminClient, CreateAccountAssignmentCommand } from "@aws-sdk/client-sso-admin"; // ES Modules import + * // const { SSOAdminClient, CreateAccountAssignmentCommand } = require("@aws-sdk/client-sso-admin"); // CommonJS import + * const client = new SSOAdminClient(config); + * const command = new CreateAccountAssignmentCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreateAccountAssignmentCommandInput} for command's `input` shape. + * @see {@link CreateAccountAssignmentCommandOutput} for command's `response` shape. + * @see {@link SSOAdminClientResolvedConfig | config} for command's `input` shape. + * */ export class CreateAccountAssignmentCommand extends $Command< CreateAccountAssignmentCommandInput, diff --git a/clients/client-sso-admin/commands/CreateInstanceAccessControlAttributeConfigurationCommand.ts b/clients/client-sso-admin/commands/CreateInstanceAccessControlAttributeConfigurationCommand.ts index 6afbc2f6d5f2..627b0c685b40 100644 --- a/clients/client-sso-admin/commands/CreateInstanceAccessControlAttributeConfigurationCommand.ts +++ b/clients/client-sso-admin/commands/CreateInstanceAccessControlAttributeConfigurationCommand.ts @@ -28,6 +28,20 @@ export interface CreateInstanceAccessControlAttributeConfigurationCommandOutput /** *

Enables the attributes-based access control (ABAC) feature for the specified AWS SSO 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 AWS SSO User Guide.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { SSOAdminClient, CreateInstanceAccessControlAttributeConfigurationCommand } from "@aws-sdk/client-sso-admin"; // ES Modules import + * // const { SSOAdminClient, CreateInstanceAccessControlAttributeConfigurationCommand } = require("@aws-sdk/client-sso-admin"); // CommonJS import + * const client = new SSOAdminClient(config); + * const command = new CreateInstanceAccessControlAttributeConfigurationCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreateInstanceAccessControlAttributeConfigurationCommandInput} for command's `input` shape. + * @see {@link CreateInstanceAccessControlAttributeConfigurationCommandOutput} for command's `response` shape. + * @see {@link SSOAdminClientResolvedConfig | config} for command's `input` shape. + * */ export class CreateInstanceAccessControlAttributeConfigurationCommand extends $Command< CreateInstanceAccessControlAttributeConfigurationCommandInput, diff --git a/clients/client-sso-admin/commands/CreatePermissionSetCommand.ts b/clients/client-sso-admin/commands/CreatePermissionSetCommand.ts index eccf9ea5872c..b2bf788562a1 100644 --- a/clients/client-sso-admin/commands/CreatePermissionSetCommand.ts +++ b/clients/client-sso-admin/commands/CreatePermissionSetCommand.ts @@ -27,6 +27,20 @@ export interface CreatePermissionSetCommandOutput extends CreatePermissionSetRes * CreateAccountAssignment * .

* + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { SSOAdminClient, CreatePermissionSetCommand } from "@aws-sdk/client-sso-admin"; // ES Modules import + * // const { SSOAdminClient, CreatePermissionSetCommand } = require("@aws-sdk/client-sso-admin"); // CommonJS import + * const client = new SSOAdminClient(config); + * const command = new CreatePermissionSetCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreatePermissionSetCommandInput} for command's `input` shape. + * @see {@link CreatePermissionSetCommandOutput} for command's `response` shape. + * @see {@link SSOAdminClientResolvedConfig | config} for command's `input` shape. + * */ export class CreatePermissionSetCommand extends $Command< CreatePermissionSetCommandInput, diff --git a/clients/client-sso-admin/commands/DeleteAccountAssignmentCommand.ts b/clients/client-sso-admin/commands/DeleteAccountAssignmentCommand.ts index d2eb463f828e..92583fd6cbb4 100644 --- a/clients/client-sso-admin/commands/DeleteAccountAssignmentCommand.ts +++ b/clients/client-sso-admin/commands/DeleteAccountAssignmentCommand.ts @@ -23,6 +23,20 @@ export interface DeleteAccountAssignmentCommandOutput extends DeleteAccountAssig /** *

Deletes a principal's access from a specified AWS account using a specified permission * set.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { SSOAdminClient, DeleteAccountAssignmentCommand } from "@aws-sdk/client-sso-admin"; // ES Modules import + * // const { SSOAdminClient, DeleteAccountAssignmentCommand } = require("@aws-sdk/client-sso-admin"); // CommonJS import + * const client = new SSOAdminClient(config); + * const command = new DeleteAccountAssignmentCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteAccountAssignmentCommandInput} for command's `input` shape. + * @see {@link DeleteAccountAssignmentCommandOutput} for command's `response` shape. + * @see {@link SSOAdminClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteAccountAssignmentCommand extends $Command< DeleteAccountAssignmentCommandInput, diff --git a/clients/client-sso-admin/commands/DeleteInlinePolicyFromPermissionSetCommand.ts b/clients/client-sso-admin/commands/DeleteInlinePolicyFromPermissionSetCommand.ts index 23df34465e7e..78b19bd27396 100644 --- a/clients/client-sso-admin/commands/DeleteInlinePolicyFromPermissionSetCommand.ts +++ b/clients/client-sso-admin/commands/DeleteInlinePolicyFromPermissionSetCommand.ts @@ -27,6 +27,20 @@ export interface DeleteInlinePolicyFromPermissionSetCommandOutput /** *

Deletes the inline policy from a specified permission set.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { SSOAdminClient, DeleteInlinePolicyFromPermissionSetCommand } from "@aws-sdk/client-sso-admin"; // ES Modules import + * // const { SSOAdminClient, DeleteInlinePolicyFromPermissionSetCommand } = require("@aws-sdk/client-sso-admin"); // CommonJS import + * const client = new SSOAdminClient(config); + * const command = new DeleteInlinePolicyFromPermissionSetCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteInlinePolicyFromPermissionSetCommandInput} for command's `input` shape. + * @see {@link DeleteInlinePolicyFromPermissionSetCommandOutput} for command's `response` shape. + * @see {@link SSOAdminClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteInlinePolicyFromPermissionSetCommand extends $Command< DeleteInlinePolicyFromPermissionSetCommandInput, diff --git a/clients/client-sso-admin/commands/DeleteInstanceAccessControlAttributeConfigurationCommand.ts b/clients/client-sso-admin/commands/DeleteInstanceAccessControlAttributeConfigurationCommand.ts index 39a89c186724..33d0f5261754 100644 --- a/clients/client-sso-admin/commands/DeleteInstanceAccessControlAttributeConfigurationCommand.ts +++ b/clients/client-sso-admin/commands/DeleteInstanceAccessControlAttributeConfigurationCommand.ts @@ -28,6 +28,20 @@ export interface DeleteInstanceAccessControlAttributeConfigurationCommandOutput /** *

Disables the attributes-based access control (ABAC) feature for the specified AWS SSO 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 AWS SSO User Guide.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { SSOAdminClient, DeleteInstanceAccessControlAttributeConfigurationCommand } from "@aws-sdk/client-sso-admin"; // ES Modules import + * // const { SSOAdminClient, DeleteInstanceAccessControlAttributeConfigurationCommand } = require("@aws-sdk/client-sso-admin"); // CommonJS import + * const client = new SSOAdminClient(config); + * const command = new DeleteInstanceAccessControlAttributeConfigurationCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteInstanceAccessControlAttributeConfigurationCommandInput} for command's `input` shape. + * @see {@link DeleteInstanceAccessControlAttributeConfigurationCommandOutput} for command's `response` shape. + * @see {@link SSOAdminClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteInstanceAccessControlAttributeConfigurationCommand extends $Command< DeleteInstanceAccessControlAttributeConfigurationCommandInput, diff --git a/clients/client-sso-admin/commands/DeletePermissionSetCommand.ts b/clients/client-sso-admin/commands/DeletePermissionSetCommand.ts index 7e938b6683f0..ff3d1f05a17d 100644 --- a/clients/client-sso-admin/commands/DeletePermissionSetCommand.ts +++ b/clients/client-sso-admin/commands/DeletePermissionSetCommand.ts @@ -22,6 +22,20 @@ export interface DeletePermissionSetCommandOutput extends DeletePermissionSetRes /** *

Deletes the specified permission set.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { SSOAdminClient, DeletePermissionSetCommand } from "@aws-sdk/client-sso-admin"; // ES Modules import + * // const { SSOAdminClient, DeletePermissionSetCommand } = require("@aws-sdk/client-sso-admin"); // CommonJS import + * const client = new SSOAdminClient(config); + * const command = new DeletePermissionSetCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeletePermissionSetCommandInput} for command's `input` shape. + * @see {@link DeletePermissionSetCommandOutput} for command's `response` shape. + * @see {@link SSOAdminClientResolvedConfig | config} for command's `input` shape. + * */ export class DeletePermissionSetCommand extends $Command< DeletePermissionSetCommandInput, diff --git a/clients/client-sso-admin/commands/DescribeAccountAssignmentCreationStatusCommand.ts b/clients/client-sso-admin/commands/DescribeAccountAssignmentCreationStatusCommand.ts index 9437c116a486..e0955ab210a7 100644 --- a/clients/client-sso-admin/commands/DescribeAccountAssignmentCreationStatusCommand.ts +++ b/clients/client-sso-admin/commands/DescribeAccountAssignmentCreationStatusCommand.ts @@ -28,6 +28,20 @@ export interface DescribeAccountAssignmentCreationStatusCommandOutput /** *

Describes the status of the assignment creation request.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { SSOAdminClient, DescribeAccountAssignmentCreationStatusCommand } from "@aws-sdk/client-sso-admin"; // ES Modules import + * // const { SSOAdminClient, DescribeAccountAssignmentCreationStatusCommand } = require("@aws-sdk/client-sso-admin"); // CommonJS import + * const client = new SSOAdminClient(config); + * const command = new DescribeAccountAssignmentCreationStatusCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeAccountAssignmentCreationStatusCommandInput} for command's `input` shape. + * @see {@link DescribeAccountAssignmentCreationStatusCommandOutput} for command's `response` shape. + * @see {@link SSOAdminClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeAccountAssignmentCreationStatusCommand extends $Command< DescribeAccountAssignmentCreationStatusCommandInput, diff --git a/clients/client-sso-admin/commands/DescribeAccountAssignmentDeletionStatusCommand.ts b/clients/client-sso-admin/commands/DescribeAccountAssignmentDeletionStatusCommand.ts index 8a2da1e6d2c5..1e1c58a9d25e 100644 --- a/clients/client-sso-admin/commands/DescribeAccountAssignmentDeletionStatusCommand.ts +++ b/clients/client-sso-admin/commands/DescribeAccountAssignmentDeletionStatusCommand.ts @@ -28,6 +28,20 @@ export interface DescribeAccountAssignmentDeletionStatusCommandOutput /** *

Describes the status of the assignment deletion request.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { SSOAdminClient, DescribeAccountAssignmentDeletionStatusCommand } from "@aws-sdk/client-sso-admin"; // ES Modules import + * // const { SSOAdminClient, DescribeAccountAssignmentDeletionStatusCommand } = require("@aws-sdk/client-sso-admin"); // CommonJS import + * const client = new SSOAdminClient(config); + * const command = new DescribeAccountAssignmentDeletionStatusCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeAccountAssignmentDeletionStatusCommandInput} for command's `input` shape. + * @see {@link DescribeAccountAssignmentDeletionStatusCommandOutput} for command's `response` shape. + * @see {@link SSOAdminClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeAccountAssignmentDeletionStatusCommand extends $Command< DescribeAccountAssignmentDeletionStatusCommandInput, diff --git a/clients/client-sso-admin/commands/DescribeInstanceAccessControlAttributeConfigurationCommand.ts b/clients/client-sso-admin/commands/DescribeInstanceAccessControlAttributeConfigurationCommand.ts index cede9e3f458d..a7fe1f0aa7d1 100644 --- a/clients/client-sso-admin/commands/DescribeInstanceAccessControlAttributeConfigurationCommand.ts +++ b/clients/client-sso-admin/commands/DescribeInstanceAccessControlAttributeConfigurationCommand.ts @@ -28,6 +28,20 @@ export interface DescribeInstanceAccessControlAttributeConfigurationCommandOutpu /** *

Returns the list of AWS SSO identity store attributes that have been configured to work with attributes-based access control (ABAC) for the specified AWS SSO 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 AWS SSO User Guide.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { SSOAdminClient, DescribeInstanceAccessControlAttributeConfigurationCommand } from "@aws-sdk/client-sso-admin"; // ES Modules import + * // const { SSOAdminClient, DescribeInstanceAccessControlAttributeConfigurationCommand } = require("@aws-sdk/client-sso-admin"); // CommonJS import + * const client = new SSOAdminClient(config); + * const command = new DescribeInstanceAccessControlAttributeConfigurationCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeInstanceAccessControlAttributeConfigurationCommandInput} for command's `input` shape. + * @see {@link DescribeInstanceAccessControlAttributeConfigurationCommandOutput} for command's `response` shape. + * @see {@link SSOAdminClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeInstanceAccessControlAttributeConfigurationCommand extends $Command< DescribeInstanceAccessControlAttributeConfigurationCommandInput, diff --git a/clients/client-sso-admin/commands/DescribePermissionSetCommand.ts b/clients/client-sso-admin/commands/DescribePermissionSetCommand.ts index 4c6d09b7b1d4..fd32044deeeb 100644 --- a/clients/client-sso-admin/commands/DescribePermissionSetCommand.ts +++ b/clients/client-sso-admin/commands/DescribePermissionSetCommand.ts @@ -22,6 +22,20 @@ export interface DescribePermissionSetCommandOutput extends DescribePermissionSe /** *

Gets the details of the permission set.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { SSOAdminClient, DescribePermissionSetCommand } from "@aws-sdk/client-sso-admin"; // ES Modules import + * // const { SSOAdminClient, DescribePermissionSetCommand } = require("@aws-sdk/client-sso-admin"); // CommonJS import + * const client = new SSOAdminClient(config); + * const command = new DescribePermissionSetCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribePermissionSetCommandInput} for command's `input` shape. + * @see {@link DescribePermissionSetCommandOutput} for command's `response` shape. + * @see {@link SSOAdminClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribePermissionSetCommand extends $Command< DescribePermissionSetCommandInput, diff --git a/clients/client-sso-admin/commands/DescribePermissionSetProvisioningStatusCommand.ts b/clients/client-sso-admin/commands/DescribePermissionSetProvisioningStatusCommand.ts index e5f29c5dba10..acc44d46def5 100644 --- a/clients/client-sso-admin/commands/DescribePermissionSetProvisioningStatusCommand.ts +++ b/clients/client-sso-admin/commands/DescribePermissionSetProvisioningStatusCommand.ts @@ -28,6 +28,20 @@ export interface DescribePermissionSetProvisioningStatusCommandOutput /** *

Describes the status for the given permission set provisioning request.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { SSOAdminClient, DescribePermissionSetProvisioningStatusCommand } from "@aws-sdk/client-sso-admin"; // ES Modules import + * // const { SSOAdminClient, DescribePermissionSetProvisioningStatusCommand } = require("@aws-sdk/client-sso-admin"); // CommonJS import + * const client = new SSOAdminClient(config); + * const command = new DescribePermissionSetProvisioningStatusCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribePermissionSetProvisioningStatusCommandInput} for command's `input` shape. + * @see {@link DescribePermissionSetProvisioningStatusCommandOutput} for command's `response` shape. + * @see {@link SSOAdminClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribePermissionSetProvisioningStatusCommand extends $Command< DescribePermissionSetProvisioningStatusCommandInput, diff --git a/clients/client-sso-admin/commands/DetachManagedPolicyFromPermissionSetCommand.ts b/clients/client-sso-admin/commands/DetachManagedPolicyFromPermissionSetCommand.ts index 7c534b8fa878..d08f886d3210 100644 --- a/clients/client-sso-admin/commands/DetachManagedPolicyFromPermissionSetCommand.ts +++ b/clients/client-sso-admin/commands/DetachManagedPolicyFromPermissionSetCommand.ts @@ -27,6 +27,20 @@ export interface DetachManagedPolicyFromPermissionSetCommandOutput /** *

Detaches the attached IAM managed policy ARN from the specified permission set.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { SSOAdminClient, DetachManagedPolicyFromPermissionSetCommand } from "@aws-sdk/client-sso-admin"; // ES Modules import + * // const { SSOAdminClient, DetachManagedPolicyFromPermissionSetCommand } = require("@aws-sdk/client-sso-admin"); // CommonJS import + * const client = new SSOAdminClient(config); + * const command = new DetachManagedPolicyFromPermissionSetCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DetachManagedPolicyFromPermissionSetCommandInput} for command's `input` shape. + * @see {@link DetachManagedPolicyFromPermissionSetCommandOutput} for command's `response` shape. + * @see {@link SSOAdminClientResolvedConfig | config} for command's `input` shape. + * */ export class DetachManagedPolicyFromPermissionSetCommand extends $Command< DetachManagedPolicyFromPermissionSetCommandInput, diff --git a/clients/client-sso-admin/commands/GetInlinePolicyForPermissionSetCommand.ts b/clients/client-sso-admin/commands/GetInlinePolicyForPermissionSetCommand.ts index 509c750f7d28..84e8b03f2cf0 100644 --- a/clients/client-sso-admin/commands/GetInlinePolicyForPermissionSetCommand.ts +++ b/clients/client-sso-admin/commands/GetInlinePolicyForPermissionSetCommand.ts @@ -24,6 +24,20 @@ export interface GetInlinePolicyForPermissionSetCommandOutput /** *

Obtains the inline policy assigned to the permission set.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { SSOAdminClient, GetInlinePolicyForPermissionSetCommand } from "@aws-sdk/client-sso-admin"; // ES Modules import + * // const { SSOAdminClient, GetInlinePolicyForPermissionSetCommand } = require("@aws-sdk/client-sso-admin"); // CommonJS import + * const client = new SSOAdminClient(config); + * const command = new GetInlinePolicyForPermissionSetCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetInlinePolicyForPermissionSetCommandInput} for command's `input` shape. + * @see {@link GetInlinePolicyForPermissionSetCommandOutput} for command's `response` shape. + * @see {@link SSOAdminClientResolvedConfig | config} for command's `input` shape. + * */ export class GetInlinePolicyForPermissionSetCommand extends $Command< GetInlinePolicyForPermissionSetCommandInput, diff --git a/clients/client-sso-admin/commands/ListAccountAssignmentCreationStatusCommand.ts b/clients/client-sso-admin/commands/ListAccountAssignmentCreationStatusCommand.ts index 93612781a1b6..53589340c02b 100644 --- a/clients/client-sso-admin/commands/ListAccountAssignmentCreationStatusCommand.ts +++ b/clients/client-sso-admin/commands/ListAccountAssignmentCreationStatusCommand.ts @@ -28,6 +28,20 @@ export interface ListAccountAssignmentCreationStatusCommandOutput /** *

Lists the status of the AWS account assignment creation requests for a specified SSO * instance.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { SSOAdminClient, ListAccountAssignmentCreationStatusCommand } from "@aws-sdk/client-sso-admin"; // ES Modules import + * // const { SSOAdminClient, ListAccountAssignmentCreationStatusCommand } = require("@aws-sdk/client-sso-admin"); // CommonJS import + * const client = new SSOAdminClient(config); + * const command = new ListAccountAssignmentCreationStatusCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListAccountAssignmentCreationStatusCommandInput} for command's `input` shape. + * @see {@link ListAccountAssignmentCreationStatusCommandOutput} for command's `response` shape. + * @see {@link SSOAdminClientResolvedConfig | config} for command's `input` shape. + * */ export class ListAccountAssignmentCreationStatusCommand extends $Command< ListAccountAssignmentCreationStatusCommandInput, diff --git a/clients/client-sso-admin/commands/ListAccountAssignmentDeletionStatusCommand.ts b/clients/client-sso-admin/commands/ListAccountAssignmentDeletionStatusCommand.ts index 534ce385691f..827d1a1550be 100644 --- a/clients/client-sso-admin/commands/ListAccountAssignmentDeletionStatusCommand.ts +++ b/clients/client-sso-admin/commands/ListAccountAssignmentDeletionStatusCommand.ts @@ -28,6 +28,20 @@ export interface ListAccountAssignmentDeletionStatusCommandOutput /** *

Lists the status of the AWS account assignment deletion requests for a specified SSO * instance.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { SSOAdminClient, ListAccountAssignmentDeletionStatusCommand } from "@aws-sdk/client-sso-admin"; // ES Modules import + * // const { SSOAdminClient, ListAccountAssignmentDeletionStatusCommand } = require("@aws-sdk/client-sso-admin"); // CommonJS import + * const client = new SSOAdminClient(config); + * const command = new ListAccountAssignmentDeletionStatusCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListAccountAssignmentDeletionStatusCommandInput} for command's `input` shape. + * @see {@link ListAccountAssignmentDeletionStatusCommandOutput} for command's `response` shape. + * @see {@link SSOAdminClientResolvedConfig | config} for command's `input` shape. + * */ export class ListAccountAssignmentDeletionStatusCommand extends $Command< ListAccountAssignmentDeletionStatusCommandInput, diff --git a/clients/client-sso-admin/commands/ListAccountAssignmentsCommand.ts b/clients/client-sso-admin/commands/ListAccountAssignmentsCommand.ts index c16417495d43..155d5f603f1c 100644 --- a/clients/client-sso-admin/commands/ListAccountAssignmentsCommand.ts +++ b/clients/client-sso-admin/commands/ListAccountAssignmentsCommand.ts @@ -23,6 +23,20 @@ export interface ListAccountAssignmentsCommandOutput extends ListAccountAssignme /** *

Lists the assignee of the specified AWS account with the specified permission * set.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { SSOAdminClient, ListAccountAssignmentsCommand } from "@aws-sdk/client-sso-admin"; // ES Modules import + * // const { SSOAdminClient, ListAccountAssignmentsCommand } = require("@aws-sdk/client-sso-admin"); // CommonJS import + * const client = new SSOAdminClient(config); + * const command = new ListAccountAssignmentsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListAccountAssignmentsCommandInput} for command's `input` shape. + * @see {@link ListAccountAssignmentsCommandOutput} for command's `response` shape. + * @see {@link SSOAdminClientResolvedConfig | config} for command's `input` shape. + * */ export class ListAccountAssignmentsCommand extends $Command< ListAccountAssignmentsCommandInput, diff --git a/clients/client-sso-admin/commands/ListAccountsForProvisionedPermissionSetCommand.ts b/clients/client-sso-admin/commands/ListAccountsForProvisionedPermissionSetCommand.ts index 72a0f0c9c31d..1bd9839b7d29 100644 --- a/clients/client-sso-admin/commands/ListAccountsForProvisionedPermissionSetCommand.ts +++ b/clients/client-sso-admin/commands/ListAccountsForProvisionedPermissionSetCommand.ts @@ -28,6 +28,20 @@ export interface ListAccountsForProvisionedPermissionSetCommandOutput /** *

Lists all the AWS accounts where the specified permission set is provisioned.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { SSOAdminClient, ListAccountsForProvisionedPermissionSetCommand } from "@aws-sdk/client-sso-admin"; // ES Modules import + * // const { SSOAdminClient, ListAccountsForProvisionedPermissionSetCommand } = require("@aws-sdk/client-sso-admin"); // CommonJS import + * const client = new SSOAdminClient(config); + * const command = new ListAccountsForProvisionedPermissionSetCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListAccountsForProvisionedPermissionSetCommandInput} for command's `input` shape. + * @see {@link ListAccountsForProvisionedPermissionSetCommandOutput} for command's `response` shape. + * @see {@link SSOAdminClientResolvedConfig | config} for command's `input` shape. + * */ export class ListAccountsForProvisionedPermissionSetCommand extends $Command< ListAccountsForProvisionedPermissionSetCommandInput, diff --git a/clients/client-sso-admin/commands/ListInstancesCommand.ts b/clients/client-sso-admin/commands/ListInstancesCommand.ts index 71518d57a9e5..5b32b27ae3b4 100644 --- a/clients/client-sso-admin/commands/ListInstancesCommand.ts +++ b/clients/client-sso-admin/commands/ListInstancesCommand.ts @@ -22,6 +22,20 @@ export interface ListInstancesCommandOutput extends ListInstancesResponse, __Met /** *

Lists the SSO instances that the caller has access to.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { SSOAdminClient, ListInstancesCommand } from "@aws-sdk/client-sso-admin"; // ES Modules import + * // const { SSOAdminClient, ListInstancesCommand } = require("@aws-sdk/client-sso-admin"); // CommonJS import + * const client = new SSOAdminClient(config); + * const command = new ListInstancesCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListInstancesCommandInput} for command's `input` shape. + * @see {@link ListInstancesCommandOutput} for command's `response` shape. + * @see {@link SSOAdminClientResolvedConfig | config} for command's `input` shape. + * */ export class ListInstancesCommand extends $Command< ListInstancesCommandInput, diff --git a/clients/client-sso-admin/commands/ListManagedPoliciesInPermissionSetCommand.ts b/clients/client-sso-admin/commands/ListManagedPoliciesInPermissionSetCommand.ts index 9f8221238871..f414cb97897b 100644 --- a/clients/client-sso-admin/commands/ListManagedPoliciesInPermissionSetCommand.ts +++ b/clients/client-sso-admin/commands/ListManagedPoliciesInPermissionSetCommand.ts @@ -27,6 +27,20 @@ export interface ListManagedPoliciesInPermissionSetCommandOutput /** *

Lists the IAM managed policy that is attached to a specified permission set.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { SSOAdminClient, ListManagedPoliciesInPermissionSetCommand } from "@aws-sdk/client-sso-admin"; // ES Modules import + * // const { SSOAdminClient, ListManagedPoliciesInPermissionSetCommand } = require("@aws-sdk/client-sso-admin"); // CommonJS import + * const client = new SSOAdminClient(config); + * const command = new ListManagedPoliciesInPermissionSetCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListManagedPoliciesInPermissionSetCommandInput} for command's `input` shape. + * @see {@link ListManagedPoliciesInPermissionSetCommandOutput} for command's `response` shape. + * @see {@link SSOAdminClientResolvedConfig | config} for command's `input` shape. + * */ export class ListManagedPoliciesInPermissionSetCommand extends $Command< ListManagedPoliciesInPermissionSetCommandInput, diff --git a/clients/client-sso-admin/commands/ListPermissionSetProvisioningStatusCommand.ts b/clients/client-sso-admin/commands/ListPermissionSetProvisioningStatusCommand.ts index 4760dfcaaad8..13498dc08185 100644 --- a/clients/client-sso-admin/commands/ListPermissionSetProvisioningStatusCommand.ts +++ b/clients/client-sso-admin/commands/ListPermissionSetProvisioningStatusCommand.ts @@ -28,6 +28,20 @@ export interface ListPermissionSetProvisioningStatusCommandOutput /** *

Lists the status of the permission set provisioning requests for a specified SSO * instance.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { SSOAdminClient, ListPermissionSetProvisioningStatusCommand } from "@aws-sdk/client-sso-admin"; // ES Modules import + * // const { SSOAdminClient, ListPermissionSetProvisioningStatusCommand } = require("@aws-sdk/client-sso-admin"); // CommonJS import + * const client = new SSOAdminClient(config); + * const command = new ListPermissionSetProvisioningStatusCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListPermissionSetProvisioningStatusCommandInput} for command's `input` shape. + * @see {@link ListPermissionSetProvisioningStatusCommandOutput} for command's `response` shape. + * @see {@link SSOAdminClientResolvedConfig | config} for command's `input` shape. + * */ export class ListPermissionSetProvisioningStatusCommand extends $Command< ListPermissionSetProvisioningStatusCommandInput, diff --git a/clients/client-sso-admin/commands/ListPermissionSetsCommand.ts b/clients/client-sso-admin/commands/ListPermissionSetsCommand.ts index b3cecf86ace3..83f49aebf358 100644 --- a/clients/client-sso-admin/commands/ListPermissionSetsCommand.ts +++ b/clients/client-sso-admin/commands/ListPermissionSetsCommand.ts @@ -22,6 +22,20 @@ export interface ListPermissionSetsCommandOutput extends ListPermissionSetsRespo /** *

Lists the PermissionSets in an SSO instance.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { SSOAdminClient, ListPermissionSetsCommand } from "@aws-sdk/client-sso-admin"; // ES Modules import + * // const { SSOAdminClient, ListPermissionSetsCommand } = require("@aws-sdk/client-sso-admin"); // CommonJS import + * const client = new SSOAdminClient(config); + * const command = new ListPermissionSetsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListPermissionSetsCommandInput} for command's `input` shape. + * @see {@link ListPermissionSetsCommandOutput} for command's `response` shape. + * @see {@link SSOAdminClientResolvedConfig | config} for command's `input` shape. + * */ export class ListPermissionSetsCommand extends $Command< ListPermissionSetsCommandInput, diff --git a/clients/client-sso-admin/commands/ListPermissionSetsProvisionedToAccountCommand.ts b/clients/client-sso-admin/commands/ListPermissionSetsProvisionedToAccountCommand.ts index 0fd4807e68b7..f918c8e12560 100644 --- a/clients/client-sso-admin/commands/ListPermissionSetsProvisionedToAccountCommand.ts +++ b/clients/client-sso-admin/commands/ListPermissionSetsProvisionedToAccountCommand.ts @@ -28,6 +28,20 @@ export interface ListPermissionSetsProvisionedToAccountCommandOutput /** *

Lists all the permission sets that are provisioned to a specified AWS account.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { SSOAdminClient, ListPermissionSetsProvisionedToAccountCommand } from "@aws-sdk/client-sso-admin"; // ES Modules import + * // const { SSOAdminClient, ListPermissionSetsProvisionedToAccountCommand } = require("@aws-sdk/client-sso-admin"); // CommonJS import + * const client = new SSOAdminClient(config); + * const command = new ListPermissionSetsProvisionedToAccountCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListPermissionSetsProvisionedToAccountCommandInput} for command's `input` shape. + * @see {@link ListPermissionSetsProvisionedToAccountCommandOutput} for command's `response` shape. + * @see {@link SSOAdminClientResolvedConfig | config} for command's `input` shape. + * */ export class ListPermissionSetsProvisionedToAccountCommand extends $Command< ListPermissionSetsProvisionedToAccountCommandInput, diff --git a/clients/client-sso-admin/commands/ListTagsForResourceCommand.ts b/clients/client-sso-admin/commands/ListTagsForResourceCommand.ts index 9e20c3fca6a5..375933d24b14 100644 --- a/clients/client-sso-admin/commands/ListTagsForResourceCommand.ts +++ b/clients/client-sso-admin/commands/ListTagsForResourceCommand.ts @@ -22,6 +22,20 @@ export interface ListTagsForResourceCommandOutput extends ListTagsForResourceRes /** *

Lists the tags that are attached to a specified resource.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { SSOAdminClient, ListTagsForResourceCommand } from "@aws-sdk/client-sso-admin"; // ES Modules import + * // const { SSOAdminClient, ListTagsForResourceCommand } = require("@aws-sdk/client-sso-admin"); // CommonJS import + * const client = new SSOAdminClient(config); + * const command = new ListTagsForResourceCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListTagsForResourceCommandInput} for command's `input` shape. + * @see {@link ListTagsForResourceCommandOutput} for command's `response` shape. + * @see {@link SSOAdminClientResolvedConfig | config} for command's `input` shape. + * */ export class ListTagsForResourceCommand extends $Command< ListTagsForResourceCommandInput, diff --git a/clients/client-sso-admin/commands/ProvisionPermissionSetCommand.ts b/clients/client-sso-admin/commands/ProvisionPermissionSetCommand.ts index 2c81b66b0307..c8ea53c9df90 100644 --- a/clients/client-sso-admin/commands/ProvisionPermissionSetCommand.ts +++ b/clients/client-sso-admin/commands/ProvisionPermissionSetCommand.ts @@ -22,6 +22,20 @@ export interface ProvisionPermissionSetCommandOutput extends ProvisionPermission /** *

The process by which a specified permission set is provisioned to the specified target.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { SSOAdminClient, ProvisionPermissionSetCommand } from "@aws-sdk/client-sso-admin"; // ES Modules import + * // const { SSOAdminClient, ProvisionPermissionSetCommand } = require("@aws-sdk/client-sso-admin"); // CommonJS import + * const client = new SSOAdminClient(config); + * const command = new ProvisionPermissionSetCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ProvisionPermissionSetCommandInput} for command's `input` shape. + * @see {@link ProvisionPermissionSetCommandOutput} for command's `response` shape. + * @see {@link SSOAdminClientResolvedConfig | config} for command's `input` shape. + * */ export class ProvisionPermissionSetCommand extends $Command< ProvisionPermissionSetCommandInput, diff --git a/clients/client-sso-admin/commands/PutInlinePolicyToPermissionSetCommand.ts b/clients/client-sso-admin/commands/PutInlinePolicyToPermissionSetCommand.ts index 0de832fd6466..5fa9ea6498fc 100644 --- a/clients/client-sso-admin/commands/PutInlinePolicyToPermissionSetCommand.ts +++ b/clients/client-sso-admin/commands/PutInlinePolicyToPermissionSetCommand.ts @@ -29,6 +29,20 @@ export interface PutInlinePolicyToPermissionSetCommandOutput * ProvisionPermissionSet * after this action to apply the corresponding IAM policy updates to all assigned accounts.

* + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { SSOAdminClient, PutInlinePolicyToPermissionSetCommand } from "@aws-sdk/client-sso-admin"; // ES Modules import + * // const { SSOAdminClient, PutInlinePolicyToPermissionSetCommand } = require("@aws-sdk/client-sso-admin"); // CommonJS import + * const client = new SSOAdminClient(config); + * const command = new PutInlinePolicyToPermissionSetCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link PutInlinePolicyToPermissionSetCommandInput} for command's `input` shape. + * @see {@link PutInlinePolicyToPermissionSetCommandOutput} for command's `response` shape. + * @see {@link SSOAdminClientResolvedConfig | config} for command's `input` shape. + * */ export class PutInlinePolicyToPermissionSetCommand extends $Command< PutInlinePolicyToPermissionSetCommandInput, diff --git a/clients/client-sso-admin/commands/TagResourceCommand.ts b/clients/client-sso-admin/commands/TagResourceCommand.ts index 73eb664352bc..447c3b904cb3 100644 --- a/clients/client-sso-admin/commands/TagResourceCommand.ts +++ b/clients/client-sso-admin/commands/TagResourceCommand.ts @@ -22,6 +22,20 @@ export interface TagResourceCommandOutput extends TagResourceResponse, __Metadat /** *

Associates a set of tags with a specified resource.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { SSOAdminClient, TagResourceCommand } from "@aws-sdk/client-sso-admin"; // ES Modules import + * // const { SSOAdminClient, TagResourceCommand } = require("@aws-sdk/client-sso-admin"); // CommonJS import + * const client = new SSOAdminClient(config); + * const command = new TagResourceCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link TagResourceCommandInput} for command's `input` shape. + * @see {@link TagResourceCommandOutput} for command's `response` shape. + * @see {@link SSOAdminClientResolvedConfig | config} for command's `input` shape. + * */ export class TagResourceCommand extends $Command< TagResourceCommandInput, diff --git a/clients/client-sso-admin/commands/UntagResourceCommand.ts b/clients/client-sso-admin/commands/UntagResourceCommand.ts index 73c96840a313..ae1060389625 100644 --- a/clients/client-sso-admin/commands/UntagResourceCommand.ts +++ b/clients/client-sso-admin/commands/UntagResourceCommand.ts @@ -22,6 +22,20 @@ export interface UntagResourceCommandOutput extends UntagResourceResponse, __Met /** *

Disassociates a set of tags from a specified resource.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { SSOAdminClient, UntagResourceCommand } from "@aws-sdk/client-sso-admin"; // ES Modules import + * // const { SSOAdminClient, UntagResourceCommand } = require("@aws-sdk/client-sso-admin"); // CommonJS import + * const client = new SSOAdminClient(config); + * const command = new UntagResourceCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link UntagResourceCommandInput} for command's `input` shape. + * @see {@link UntagResourceCommandOutput} for command's `response` shape. + * @see {@link SSOAdminClientResolvedConfig | config} for command's `input` shape. + * */ export class UntagResourceCommand extends $Command< UntagResourceCommandInput, diff --git a/clients/client-sso-admin/commands/UpdateInstanceAccessControlAttributeConfigurationCommand.ts b/clients/client-sso-admin/commands/UpdateInstanceAccessControlAttributeConfigurationCommand.ts index 492c7fbe5146..1d5114447fc1 100644 --- a/clients/client-sso-admin/commands/UpdateInstanceAccessControlAttributeConfigurationCommand.ts +++ b/clients/client-sso-admin/commands/UpdateInstanceAccessControlAttributeConfigurationCommand.ts @@ -28,6 +28,20 @@ export interface UpdateInstanceAccessControlAttributeConfigurationCommandOutput /** *

Updates the AWS SSO identity store attributes to use with the AWS SSO 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 AWS SSO identity store. If a SAML assertion passes any of these attributes, AWS SSO will replace the attribute value with the value from the AWS SSO identity store. For more information about ABAC, see Attribute-Based Access Control in the AWS SSO User Guide.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { SSOAdminClient, UpdateInstanceAccessControlAttributeConfigurationCommand } from "@aws-sdk/client-sso-admin"; // ES Modules import + * // const { SSOAdminClient, UpdateInstanceAccessControlAttributeConfigurationCommand } = require("@aws-sdk/client-sso-admin"); // CommonJS import + * const client = new SSOAdminClient(config); + * const command = new UpdateInstanceAccessControlAttributeConfigurationCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link UpdateInstanceAccessControlAttributeConfigurationCommandInput} for command's `input` shape. + * @see {@link UpdateInstanceAccessControlAttributeConfigurationCommandOutput} for command's `response` shape. + * @see {@link SSOAdminClientResolvedConfig | config} for command's `input` shape. + * */ export class UpdateInstanceAccessControlAttributeConfigurationCommand extends $Command< UpdateInstanceAccessControlAttributeConfigurationCommandInput, diff --git a/clients/client-sso-admin/commands/UpdatePermissionSetCommand.ts b/clients/client-sso-admin/commands/UpdatePermissionSetCommand.ts index 268250a4b704..86c1f4928a0b 100644 --- a/clients/client-sso-admin/commands/UpdatePermissionSetCommand.ts +++ b/clients/client-sso-admin/commands/UpdatePermissionSetCommand.ts @@ -22,6 +22,20 @@ export interface UpdatePermissionSetCommandOutput extends UpdatePermissionSetRes /** *

Updates an existing permission set.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { SSOAdminClient, UpdatePermissionSetCommand } from "@aws-sdk/client-sso-admin"; // ES Modules import + * // const { SSOAdminClient, UpdatePermissionSetCommand } = require("@aws-sdk/client-sso-admin"); // CommonJS import + * const client = new SSOAdminClient(config); + * const command = new UpdatePermissionSetCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link UpdatePermissionSetCommandInput} for command's `input` shape. + * @see {@link UpdatePermissionSetCommandOutput} for command's `response` shape. + * @see {@link SSOAdminClientResolvedConfig | config} for command's `input` shape. + * */ export class UpdatePermissionSetCommand extends $Command< UpdatePermissionSetCommandInput, diff --git a/clients/client-sso-admin/models/models_0.ts b/clients/client-sso-admin/models/models_0.ts index abd0437e9efe..08402e9f50a4 100644 --- a/clients/client-sso-admin/models/models_0.ts +++ b/clients/client-sso-admin/models/models_0.ts @@ -12,6 +12,9 @@ export interface AccessControlAttributeValue { } export namespace AccessControlAttributeValue { + /** + * @internal + */ export const filterSensitiveLog = (obj: AccessControlAttributeValue): any => ({ ...obj, }); @@ -33,6 +36,9 @@ export interface AccessControlAttribute { } export namespace AccessControlAttribute { + /** + * @internal + */ export const filterSensitiveLog = (obj: AccessControlAttribute): any => ({ ...obj, }); @@ -48,6 +54,9 @@ export interface AccessDeniedException extends __SmithyException, $MetadataBeare } export namespace AccessDeniedException { + /** + * @internal + */ export const filterSensitiveLog = (obj: AccessDeniedException): any => ({ ...obj, }); @@ -89,6 +98,9 @@ export interface AccountAssignment { } export namespace AccountAssignment { + /** + * @internal + */ export const filterSensitiveLog = (obj: AccountAssignment): any => ({ ...obj, }); @@ -158,6 +170,9 @@ export interface AccountAssignmentOperationStatus { } export namespace AccountAssignmentOperationStatus { + /** + * @internal + */ export const filterSensitiveLog = (obj: AccountAssignmentOperationStatus): any => ({ ...obj, }); @@ -186,6 +201,9 @@ export interface AccountAssignmentOperationStatusMetadata { } export namespace AccountAssignmentOperationStatusMetadata { + /** + * @internal + */ export const filterSensitiveLog = (obj: AccountAssignmentOperationStatusMetadata): any => ({ ...obj, }); @@ -208,6 +226,9 @@ export interface AttachedManagedPolicy { } export namespace AttachedManagedPolicy { + /** + * @internal + */ export const filterSensitiveLog = (obj: AttachedManagedPolicy): any => ({ ...obj, }); @@ -234,6 +255,9 @@ export interface AttachManagedPolicyToPermissionSetRequest { } export namespace AttachManagedPolicyToPermissionSetRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: AttachManagedPolicyToPermissionSetRequest): any => ({ ...obj, }); @@ -242,6 +266,9 @@ export namespace AttachManagedPolicyToPermissionSetRequest { export interface AttachManagedPolicyToPermissionSetResponse {} export namespace AttachManagedPolicyToPermissionSetResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: AttachManagedPolicyToPermissionSetResponse): any => ({ ...obj, }); @@ -257,6 +284,9 @@ export interface ConflictException extends __SmithyException, $MetadataBearer { } export namespace ConflictException { + /** + * @internal + */ export const filterSensitiveLog = (obj: ConflictException): any => ({ ...obj, }); @@ -273,6 +303,9 @@ export interface InternalServerException extends __SmithyException, $MetadataBea } export namespace InternalServerException { + /** + * @internal + */ export const filterSensitiveLog = (obj: InternalServerException): any => ({ ...obj, }); @@ -288,6 +321,9 @@ export interface ResourceNotFoundException extends __SmithyException, $MetadataB } export namespace ResourceNotFoundException { + /** + * @internal + */ export const filterSensitiveLog = (obj: ResourceNotFoundException): any => ({ ...obj, }); @@ -303,6 +339,9 @@ export interface ServiceQuotaExceededException extends __SmithyException, $Metad } export namespace ServiceQuotaExceededException { + /** + * @internal + */ export const filterSensitiveLog = (obj: ServiceQuotaExceededException): any => ({ ...obj, }); @@ -318,6 +357,9 @@ export interface ThrottlingException extends __SmithyException, $MetadataBearer } export namespace ThrottlingException { + /** + * @internal + */ export const filterSensitiveLog = (obj: ThrottlingException): any => ({ ...obj, }); @@ -333,6 +375,9 @@ export interface ValidationException extends __SmithyException, $MetadataBearer } export namespace ValidationException { + /** + * @internal + */ export const filterSensitiveLog = (obj: ValidationException): any => ({ ...obj, }); @@ -373,6 +418,9 @@ export interface CreateAccountAssignmentRequest { } export namespace CreateAccountAssignmentRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateAccountAssignmentRequest): any => ({ ...obj, }); @@ -386,6 +434,9 @@ export interface CreateAccountAssignmentResponse { } export namespace CreateAccountAssignmentResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateAccountAssignmentResponse): any => ({ ...obj, }); @@ -402,6 +453,9 @@ export interface InstanceAccessControlAttributeConfiguration { } export namespace InstanceAccessControlAttributeConfiguration { + /** + * @internal + */ export const filterSensitiveLog = (obj: InstanceAccessControlAttributeConfiguration): any => ({ ...obj, }); @@ -420,6 +474,9 @@ export interface CreateInstanceAccessControlAttributeConfigurationRequest { } export namespace CreateInstanceAccessControlAttributeConfigurationRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateInstanceAccessControlAttributeConfigurationRequest): any => ({ ...obj, }); @@ -428,6 +485,9 @@ export namespace CreateInstanceAccessControlAttributeConfigurationRequest { export interface CreateInstanceAccessControlAttributeConfigurationResponse {} export namespace CreateInstanceAccessControlAttributeConfigurationResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateInstanceAccessControlAttributeConfigurationResponse): any => ({ ...obj, }); @@ -450,6 +510,9 @@ export interface Tag { } export namespace Tag { + /** + * @internal + */ export const filterSensitiveLog = (obj: Tag): any => ({ ...obj, }); @@ -492,6 +555,9 @@ export interface CreatePermissionSetRequest { } export namespace CreatePermissionSetRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreatePermissionSetRequest): any => ({ ...obj, }); @@ -536,6 +602,9 @@ export interface PermissionSet { } export namespace PermissionSet { + /** + * @internal + */ export const filterSensitiveLog = (obj: PermissionSet): any => ({ ...obj, }); @@ -549,6 +618,9 @@ export interface CreatePermissionSetResponse { } export namespace CreatePermissionSetResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreatePermissionSetResponse): any => ({ ...obj, }); @@ -589,6 +661,9 @@ export interface DeleteAccountAssignmentRequest { } export namespace DeleteAccountAssignmentRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteAccountAssignmentRequest): any => ({ ...obj, }); @@ -602,6 +677,9 @@ export interface DeleteAccountAssignmentResponse { } export namespace DeleteAccountAssignmentResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteAccountAssignmentResponse): any => ({ ...obj, }); @@ -622,6 +700,9 @@ export interface DeleteInlinePolicyFromPermissionSetRequest { } export namespace DeleteInlinePolicyFromPermissionSetRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteInlinePolicyFromPermissionSetRequest): any => ({ ...obj, }); @@ -630,6 +711,9 @@ export namespace DeleteInlinePolicyFromPermissionSetRequest { export interface DeleteInlinePolicyFromPermissionSetResponse {} export namespace DeleteInlinePolicyFromPermissionSetResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteInlinePolicyFromPermissionSetResponse): any => ({ ...obj, }); @@ -643,6 +727,9 @@ export interface DeleteInstanceAccessControlAttributeConfigurationRequest { } export namespace DeleteInstanceAccessControlAttributeConfigurationRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteInstanceAccessControlAttributeConfigurationRequest): any => ({ ...obj, }); @@ -651,6 +738,9 @@ export namespace DeleteInstanceAccessControlAttributeConfigurationRequest { export interface DeleteInstanceAccessControlAttributeConfigurationResponse {} export namespace DeleteInstanceAccessControlAttributeConfigurationResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteInstanceAccessControlAttributeConfigurationResponse): any => ({ ...obj, }); @@ -671,6 +761,9 @@ export interface DeletePermissionSetRequest { } export namespace DeletePermissionSetRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeletePermissionSetRequest): any => ({ ...obj, }); @@ -679,6 +772,9 @@ export namespace DeletePermissionSetRequest { export interface DeletePermissionSetResponse {} export namespace DeletePermissionSetResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeletePermissionSetResponse): any => ({ ...obj, }); @@ -699,6 +795,9 @@ export interface DescribeAccountAssignmentCreationStatusRequest { } export namespace DescribeAccountAssignmentCreationStatusRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeAccountAssignmentCreationStatusRequest): any => ({ ...obj, }); @@ -712,6 +811,9 @@ export interface DescribeAccountAssignmentCreationStatusResponse { } export namespace DescribeAccountAssignmentCreationStatusResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeAccountAssignmentCreationStatusResponse): any => ({ ...obj, }); @@ -732,6 +834,9 @@ export interface DescribeAccountAssignmentDeletionStatusRequest { } export namespace DescribeAccountAssignmentDeletionStatusRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeAccountAssignmentDeletionStatusRequest): any => ({ ...obj, }); @@ -745,6 +850,9 @@ export interface DescribeAccountAssignmentDeletionStatusResponse { } export namespace DescribeAccountAssignmentDeletionStatusResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeAccountAssignmentDeletionStatusResponse): any => ({ ...obj, }); @@ -758,6 +866,9 @@ export interface DescribeInstanceAccessControlAttributeConfigurationRequest { } export namespace DescribeInstanceAccessControlAttributeConfigurationRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeInstanceAccessControlAttributeConfigurationRequest): any => ({ ...obj, }); @@ -787,6 +898,9 @@ export interface DescribeInstanceAccessControlAttributeConfigurationResponse { } export namespace DescribeInstanceAccessControlAttributeConfigurationResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeInstanceAccessControlAttributeConfigurationResponse): any => ({ ...obj, }); @@ -807,6 +921,9 @@ export interface DescribePermissionSetRequest { } export namespace DescribePermissionSetRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribePermissionSetRequest): any => ({ ...obj, }); @@ -820,6 +937,9 @@ export interface DescribePermissionSetResponse { } export namespace DescribePermissionSetResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribePermissionSetResponse): any => ({ ...obj, }); @@ -841,6 +961,9 @@ export interface DescribePermissionSetProvisioningStatusRequest { } export namespace DescribePermissionSetProvisioningStatusRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribePermissionSetProvisioningStatusRequest): any => ({ ...obj, }); @@ -885,6 +1008,9 @@ export interface PermissionSetProvisioningStatus { } export namespace PermissionSetProvisioningStatus { + /** + * @internal + */ export const filterSensitiveLog = (obj: PermissionSetProvisioningStatus): any => ({ ...obj, }); @@ -898,6 +1024,9 @@ export interface DescribePermissionSetProvisioningStatusResponse { } export namespace DescribePermissionSetProvisioningStatusResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribePermissionSetProvisioningStatusResponse): any => ({ ...obj, }); @@ -923,6 +1052,9 @@ export interface DetachManagedPolicyFromPermissionSetRequest { } export namespace DetachManagedPolicyFromPermissionSetRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DetachManagedPolicyFromPermissionSetRequest): any => ({ ...obj, }); @@ -931,6 +1063,9 @@ export namespace DetachManagedPolicyFromPermissionSetRequest { export interface DetachManagedPolicyFromPermissionSetResponse {} export namespace DetachManagedPolicyFromPermissionSetResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DetachManagedPolicyFromPermissionSetResponse): any => ({ ...obj, }); @@ -951,6 +1086,9 @@ export interface GetInlinePolicyForPermissionSetRequest { } export namespace GetInlinePolicyForPermissionSetRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetInlinePolicyForPermissionSetRequest): any => ({ ...obj, }); @@ -964,6 +1102,9 @@ export interface GetInlinePolicyForPermissionSetResponse { } export namespace GetInlinePolicyForPermissionSetResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetInlinePolicyForPermissionSetResponse): any => ({ ...obj, ...(obj.InlinePolicy && { InlinePolicy: SENSITIVE_STRING }), @@ -988,6 +1129,9 @@ export interface InstanceMetadata { } export namespace InstanceMetadata { + /** + * @internal + */ export const filterSensitiveLog = (obj: InstanceMetadata): any => ({ ...obj, }); @@ -1004,6 +1148,9 @@ export interface OperationStatusFilter { } export namespace OperationStatusFilter { + /** + * @internal + */ export const filterSensitiveLog = (obj: OperationStatusFilter): any => ({ ...obj, }); @@ -1034,6 +1181,9 @@ export interface ListAccountAssignmentCreationStatusRequest { } export namespace ListAccountAssignmentCreationStatusRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListAccountAssignmentCreationStatusRequest): any => ({ ...obj, }); @@ -1052,6 +1202,9 @@ export interface ListAccountAssignmentCreationStatusResponse { } export namespace ListAccountAssignmentCreationStatusResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListAccountAssignmentCreationStatusResponse): any => ({ ...obj, }); @@ -1082,6 +1235,9 @@ export interface ListAccountAssignmentDeletionStatusRequest { } export namespace ListAccountAssignmentDeletionStatusRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListAccountAssignmentDeletionStatusRequest): any => ({ ...obj, }); @@ -1100,6 +1256,9 @@ export interface ListAccountAssignmentDeletionStatusResponse { } export namespace ListAccountAssignmentDeletionStatusResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListAccountAssignmentDeletionStatusResponse): any => ({ ...obj, }); @@ -1135,6 +1294,9 @@ export interface ListAccountAssignmentsRequest { } export namespace ListAccountAssignmentsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListAccountAssignmentsRequest): any => ({ ...obj, }); @@ -1153,6 +1315,9 @@ export interface ListAccountAssignmentsResponse { } export namespace ListAccountAssignmentsResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListAccountAssignmentsResponse): any => ({ ...obj, }); @@ -1194,6 +1359,9 @@ export interface ListAccountsForProvisionedPermissionSetRequest { } export namespace ListAccountsForProvisionedPermissionSetRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListAccountsForProvisionedPermissionSetRequest): any => ({ ...obj, }); @@ -1212,6 +1380,9 @@ export interface ListAccountsForProvisionedPermissionSetResponse { } export namespace ListAccountsForProvisionedPermissionSetResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListAccountsForProvisionedPermissionSetResponse): any => ({ ...obj, }); @@ -1230,6 +1401,9 @@ export interface ListInstancesRequest { } export namespace ListInstancesRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListInstancesRequest): any => ({ ...obj, }); @@ -1248,6 +1422,9 @@ export interface ListInstancesResponse { } export namespace ListInstancesResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListInstancesResponse): any => ({ ...obj, }); @@ -1278,6 +1455,9 @@ export interface ListManagedPoliciesInPermissionSetRequest { } export namespace ListManagedPoliciesInPermissionSetRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListManagedPoliciesInPermissionSetRequest): any => ({ ...obj, }); @@ -1296,6 +1476,9 @@ export interface ListManagedPoliciesInPermissionSetResponse { } export namespace ListManagedPoliciesInPermissionSetResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListManagedPoliciesInPermissionSetResponse): any => ({ ...obj, }); @@ -1326,6 +1509,9 @@ export interface ListPermissionSetProvisioningStatusRequest { } export namespace ListPermissionSetProvisioningStatusRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListPermissionSetProvisioningStatusRequest): any => ({ ...obj, }); @@ -1353,6 +1539,9 @@ export interface PermissionSetProvisioningStatusMetadata { } export namespace PermissionSetProvisioningStatusMetadata { + /** + * @internal + */ export const filterSensitiveLog = (obj: PermissionSetProvisioningStatusMetadata): any => ({ ...obj, }); @@ -1371,6 +1560,9 @@ export interface ListPermissionSetProvisioningStatusResponse { } export namespace ListPermissionSetProvisioningStatusResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListPermissionSetProvisioningStatusResponse): any => ({ ...obj, }); @@ -1396,6 +1588,9 @@ export interface ListPermissionSetsRequest { } export namespace ListPermissionSetsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListPermissionSetsRequest): any => ({ ...obj, }); @@ -1414,6 +1609,9 @@ export interface ListPermissionSetsResponse { } export namespace ListPermissionSetsResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListPermissionSetsResponse): any => ({ ...obj, }); @@ -1449,6 +1647,9 @@ export interface ListPermissionSetsProvisionedToAccountRequest { } export namespace ListPermissionSetsProvisionedToAccountRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListPermissionSetsProvisionedToAccountRequest): any => ({ ...obj, }); @@ -1467,6 +1668,9 @@ export interface ListPermissionSetsProvisionedToAccountResponse { } export namespace ListPermissionSetsProvisionedToAccountResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListPermissionSetsProvisionedToAccountResponse): any => ({ ...obj, }); @@ -1492,6 +1696,9 @@ export interface ListTagsForResourceRequest { } export namespace ListTagsForResourceRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListTagsForResourceRequest): any => ({ ...obj, }); @@ -1510,6 +1717,9 @@ export interface ListTagsForResourceResponse { } export namespace ListTagsForResourceResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListTagsForResourceResponse): any => ({ ...obj, }); @@ -1545,6 +1755,9 @@ export interface ProvisionPermissionSetRequest { } export namespace ProvisionPermissionSetRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ProvisionPermissionSetRequest): any => ({ ...obj, }); @@ -1558,6 +1771,9 @@ export interface ProvisionPermissionSetResponse { } export namespace ProvisionPermissionSetResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ProvisionPermissionSetResponse): any => ({ ...obj, }); @@ -1583,6 +1799,9 @@ export interface PutInlinePolicyToPermissionSetRequest { } export namespace PutInlinePolicyToPermissionSetRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: PutInlinePolicyToPermissionSetRequest): any => ({ ...obj, ...(obj.InlinePolicy && { InlinePolicy: SENSITIVE_STRING }), @@ -1592,6 +1811,9 @@ export namespace PutInlinePolicyToPermissionSetRequest { export interface PutInlinePolicyToPermissionSetResponse {} export namespace PutInlinePolicyToPermissionSetResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: PutInlinePolicyToPermissionSetResponse): any => ({ ...obj, }); @@ -1617,6 +1839,9 @@ export interface TagResourceRequest { } export namespace TagResourceRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: TagResourceRequest): any => ({ ...obj, }); @@ -1625,6 +1850,9 @@ export namespace TagResourceRequest { export interface TagResourceResponse {} export namespace TagResourceResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: TagResourceResponse): any => ({ ...obj, }); @@ -1650,6 +1878,9 @@ export interface UntagResourceRequest { } export namespace UntagResourceRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: UntagResourceRequest): any => ({ ...obj, }); @@ -1658,6 +1889,9 @@ export namespace UntagResourceRequest { export interface UntagResourceResponse {} export namespace UntagResourceResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: UntagResourceResponse): any => ({ ...obj, }); @@ -1676,6 +1910,9 @@ export interface UpdateInstanceAccessControlAttributeConfigurationRequest { } export namespace UpdateInstanceAccessControlAttributeConfigurationRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateInstanceAccessControlAttributeConfigurationRequest): any => ({ ...obj, }); @@ -1684,6 +1921,9 @@ export namespace UpdateInstanceAccessControlAttributeConfigurationRequest { export interface UpdateInstanceAccessControlAttributeConfigurationResponse {} export namespace UpdateInstanceAccessControlAttributeConfigurationResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateInstanceAccessControlAttributeConfigurationResponse): any => ({ ...obj, }); @@ -1721,6 +1961,9 @@ export interface UpdatePermissionSetRequest { } export namespace UpdatePermissionSetRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdatePermissionSetRequest): any => ({ ...obj, }); @@ -1729,6 +1972,9 @@ export namespace UpdatePermissionSetRequest { export interface UpdatePermissionSetResponse {} export namespace UpdatePermissionSetResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdatePermissionSetResponse): any => ({ ...obj, }); diff --git a/clients/client-sso-oidc/commands/CreateTokenCommand.ts b/clients/client-sso-oidc/commands/CreateTokenCommand.ts index bab3cc0cd62a..f01521bde08c 100644 --- a/clients/client-sso-oidc/commands/CreateTokenCommand.ts +++ b/clients/client-sso-oidc/commands/CreateTokenCommand.ts @@ -24,6 +24,20 @@ export interface CreateTokenCommandOutput extends CreateTokenResponse, __Metadat *

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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { SSOOIDCClient, CreateTokenCommand } from "@aws-sdk/client-sso-oidc"; // ES Modules import + * // const { SSOOIDCClient, CreateTokenCommand } = require("@aws-sdk/client-sso-oidc"); // CommonJS import + * const client = new SSOOIDCClient(config); + * const command = new CreateTokenCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreateTokenCommandInput} for command's `input` shape. + * @see {@link CreateTokenCommandOutput} for command's `response` shape. + * @see {@link SSOOIDCClientResolvedConfig | config} for command's `input` shape. + * */ export class CreateTokenCommand extends $Command< CreateTokenCommandInput, diff --git a/clients/client-sso-oidc/commands/RegisterClientCommand.ts b/clients/client-sso-oidc/commands/RegisterClientCommand.ts index 36db92ae0afd..7441309aee07 100644 --- a/clients/client-sso-oidc/commands/RegisterClientCommand.ts +++ b/clients/client-sso-oidc/commands/RegisterClientCommand.ts @@ -23,6 +23,20 @@ export interface RegisterClientCommandOutput extends RegisterClientResponse, __M /** *

Registers a client with AWS SSO. This allows clients to initiate device authorization. * The output should be persisted for reuse through many authentication requests.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { SSOOIDCClient, RegisterClientCommand } from "@aws-sdk/client-sso-oidc"; // ES Modules import + * // const { SSOOIDCClient, RegisterClientCommand } = require("@aws-sdk/client-sso-oidc"); // CommonJS import + * const client = new SSOOIDCClient(config); + * const command = new RegisterClientCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link RegisterClientCommandInput} for command's `input` shape. + * @see {@link RegisterClientCommandOutput} for command's `response` shape. + * @see {@link SSOOIDCClientResolvedConfig | config} for command's `input` shape. + * */ export class RegisterClientCommand extends $Command< RegisterClientCommandInput, diff --git a/clients/client-sso-oidc/commands/StartDeviceAuthorizationCommand.ts b/clients/client-sso-oidc/commands/StartDeviceAuthorizationCommand.ts index c9dfce529fa9..8883a1f4fbcb 100644 --- a/clients/client-sso-oidc/commands/StartDeviceAuthorizationCommand.ts +++ b/clients/client-sso-oidc/commands/StartDeviceAuthorizationCommand.ts @@ -22,6 +22,20 @@ export interface StartDeviceAuthorizationCommandOutput extends StartDeviceAuthor /** *

Initiates device authorization by requesting a pair of verification codes from the authorization service.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { SSOOIDCClient, StartDeviceAuthorizationCommand } from "@aws-sdk/client-sso-oidc"; // ES Modules import + * // const { SSOOIDCClient, StartDeviceAuthorizationCommand } = require("@aws-sdk/client-sso-oidc"); // CommonJS import + * const client = new SSOOIDCClient(config); + * const command = new StartDeviceAuthorizationCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link StartDeviceAuthorizationCommandInput} for command's `input` shape. + * @see {@link StartDeviceAuthorizationCommandOutput} for command's `response` shape. + * @see {@link SSOOIDCClientResolvedConfig | config} for command's `input` shape. + * */ export class StartDeviceAuthorizationCommand extends $Command< StartDeviceAuthorizationCommandInput, diff --git a/clients/client-sso-oidc/models/models_0.ts b/clients/client-sso-oidc/models/models_0.ts index 9df3c9479599..49598fea554d 100644 --- a/clients/client-sso-oidc/models/models_0.ts +++ b/clients/client-sso-oidc/models/models_0.ts @@ -12,6 +12,9 @@ export interface AccessDeniedException extends __SmithyException, $MetadataBeare } export namespace AccessDeniedException { + /** + * @internal + */ export const filterSensitiveLog = (obj: AccessDeniedException): any => ({ ...obj, }); @@ -28,6 +31,9 @@ export interface AuthorizationPendingException extends __SmithyException, $Metad } export namespace AuthorizationPendingException { + /** + * @internal + */ export const filterSensitiveLog = (obj: AuthorizationPendingException): any => ({ ...obj, }); @@ -80,6 +86,9 @@ export interface CreateTokenRequest { } export namespace CreateTokenRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateTokenRequest): any => ({ ...obj, }); @@ -115,6 +124,9 @@ export interface CreateTokenResponse { } export namespace CreateTokenResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateTokenResponse): any => ({ ...obj, }); @@ -131,6 +143,9 @@ export interface ExpiredTokenException extends __SmithyException, $MetadataBeare } export namespace ExpiredTokenException { + /** + * @internal + */ export const filterSensitiveLog = (obj: ExpiredTokenException): any => ({ ...obj, }); @@ -147,6 +162,9 @@ export interface InternalServerException extends __SmithyException, $MetadataBea } export namespace InternalServerException { + /** + * @internal + */ export const filterSensitiveLog = (obj: InternalServerException): any => ({ ...obj, }); @@ -165,6 +183,9 @@ export interface InvalidClientException extends __SmithyException, $MetadataBear } export namespace InvalidClientException { + /** + * @internal + */ export const filterSensitiveLog = (obj: InvalidClientException): any => ({ ...obj, }); @@ -181,6 +202,9 @@ export interface InvalidGrantException extends __SmithyException, $MetadataBeare } export namespace InvalidGrantException { + /** + * @internal + */ export const filterSensitiveLog = (obj: InvalidGrantException): any => ({ ...obj, }); @@ -198,6 +222,9 @@ export interface InvalidRequestException extends __SmithyException, $MetadataBea } export namespace InvalidRequestException { + /** + * @internal + */ export const filterSensitiveLog = (obj: InvalidRequestException): any => ({ ...obj, }); @@ -214,6 +241,9 @@ export interface InvalidScopeException extends __SmithyException, $MetadataBeare } export namespace InvalidScopeException { + /** + * @internal + */ export const filterSensitiveLog = (obj: InvalidScopeException): any => ({ ...obj, }); @@ -230,6 +260,9 @@ export interface SlowDownException extends __SmithyException, $MetadataBearer { } export namespace SlowDownException { + /** + * @internal + */ export const filterSensitiveLog = (obj: SlowDownException): any => ({ ...obj, }); @@ -247,6 +280,9 @@ export interface UnauthorizedClientException extends __SmithyException, $Metadat } export namespace UnauthorizedClientException { + /** + * @internal + */ export const filterSensitiveLog = (obj: UnauthorizedClientException): any => ({ ...obj, }); @@ -263,6 +299,9 @@ export interface UnsupportedGrantTypeException extends __SmithyException, $Metad } export namespace UnsupportedGrantTypeException { + /** + * @internal + */ export const filterSensitiveLog = (obj: UnsupportedGrantTypeException): any => ({ ...obj, }); @@ -279,6 +318,9 @@ export interface InvalidClientMetadataException extends __SmithyException, $Meta } export namespace InvalidClientMetadataException { + /** + * @internal + */ export const filterSensitiveLog = (obj: InvalidClientMetadataException): any => ({ ...obj, }); @@ -303,6 +345,9 @@ export interface RegisterClientRequest { } export namespace RegisterClientRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: RegisterClientRequest): any => ({ ...obj, }); @@ -343,6 +388,9 @@ export interface RegisterClientResponse { } export namespace RegisterClientResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: RegisterClientResponse): any => ({ ...obj, }); @@ -370,6 +418,9 @@ export interface StartDeviceAuthorizationRequest { } export namespace StartDeviceAuthorizationRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: StartDeviceAuthorizationRequest): any => ({ ...obj, }); @@ -410,6 +461,9 @@ export interface StartDeviceAuthorizationResponse { } export namespace StartDeviceAuthorizationResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: StartDeviceAuthorizationResponse): any => ({ ...obj, }); diff --git a/clients/client-sso/commands/GetRoleCredentialsCommand.ts b/clients/client-sso/commands/GetRoleCredentialsCommand.ts index 13d8b426c78e..8a703dab7e61 100644 --- a/clients/client-sso/commands/GetRoleCredentialsCommand.ts +++ b/clients/client-sso/commands/GetRoleCredentialsCommand.ts @@ -23,6 +23,20 @@ export interface GetRoleCredentialsCommandOutput extends GetRoleCredentialsRespo /** *

Returns the STS short-term credentials for a given role name that is assigned to the * user.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { SSOClient, GetRoleCredentialsCommand } from "@aws-sdk/client-sso"; // ES Modules import + * // const { SSOClient, GetRoleCredentialsCommand } = require("@aws-sdk/client-sso"); // CommonJS import + * const client = new SSOClient(config); + * const command = new GetRoleCredentialsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetRoleCredentialsCommandInput} for command's `input` shape. + * @see {@link GetRoleCredentialsCommandOutput} for command's `response` shape. + * @see {@link SSOClientResolvedConfig | config} for command's `input` shape. + * */ export class GetRoleCredentialsCommand extends $Command< GetRoleCredentialsCommandInput, diff --git a/clients/client-sso/commands/ListAccountRolesCommand.ts b/clients/client-sso/commands/ListAccountRolesCommand.ts index 1d8e64b2ed69..17e303875d56 100644 --- a/clients/client-sso/commands/ListAccountRolesCommand.ts +++ b/clients/client-sso/commands/ListAccountRolesCommand.ts @@ -22,6 +22,20 @@ export interface ListAccountRolesCommandOutput extends ListAccountRolesResponse, /** *

Lists all roles that are assigned to the user for a given AWS account.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { SSOClient, ListAccountRolesCommand } from "@aws-sdk/client-sso"; // ES Modules import + * // const { SSOClient, ListAccountRolesCommand } = require("@aws-sdk/client-sso"); // CommonJS import + * const client = new SSOClient(config); + * const command = new ListAccountRolesCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListAccountRolesCommandInput} for command's `input` shape. + * @see {@link ListAccountRolesCommandOutput} for command's `response` shape. + * @see {@link SSOClientResolvedConfig | config} for command's `input` shape. + * */ export class ListAccountRolesCommand extends $Command< ListAccountRolesCommandInput, diff --git a/clients/client-sso/commands/ListAccountsCommand.ts b/clients/client-sso/commands/ListAccountsCommand.ts index c9b9cab197e1..3287037e4e27 100644 --- a/clients/client-sso/commands/ListAccountsCommand.ts +++ b/clients/client-sso/commands/ListAccountsCommand.ts @@ -24,6 +24,20 @@ export interface ListAccountsCommandOutput extends ListAccountsResponse, __Metad *

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 AWS SSO User Guide. This operation * returns a paginated response.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { SSOClient, ListAccountsCommand } from "@aws-sdk/client-sso"; // ES Modules import + * // const { SSOClient, ListAccountsCommand } = require("@aws-sdk/client-sso"); // CommonJS import + * const client = new SSOClient(config); + * const command = new ListAccountsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListAccountsCommandInput} for command's `input` shape. + * @see {@link ListAccountsCommandOutput} for command's `response` shape. + * @see {@link SSOClientResolvedConfig | config} for command's `input` shape. + * */ export class ListAccountsCommand extends $Command< ListAccountsCommandInput, diff --git a/clients/client-sso/commands/LogoutCommand.ts b/clients/client-sso/commands/LogoutCommand.ts index 5f9768af8876..9280786552b7 100644 --- a/clients/client-sso/commands/LogoutCommand.ts +++ b/clients/client-sso/commands/LogoutCommand.ts @@ -19,6 +19,20 @@ export interface LogoutCommandOutput extends __MetadataBearer {} /** *

Removes the client- and server-side session that is associated with the user.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { SSOClient, LogoutCommand } from "@aws-sdk/client-sso"; // ES Modules import + * // const { SSOClient, LogoutCommand } = require("@aws-sdk/client-sso"); // CommonJS import + * const client = new SSOClient(config); + * const command = new LogoutCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link LogoutCommandInput} for command's `input` shape. + * @see {@link LogoutCommandOutput} for command's `response` shape. + * @see {@link SSOClientResolvedConfig | config} for command's `input` shape. + * */ export class LogoutCommand extends $Command { // Start section: command_properties diff --git a/clients/client-sso/models/models_0.ts b/clients/client-sso/models/models_0.ts index 38c260729a1d..5f7f1b646585 100644 --- a/clients/client-sso/models/models_0.ts +++ b/clients/client-sso/models/models_0.ts @@ -22,6 +22,9 @@ export interface AccountInfo { } export namespace AccountInfo { + /** + * @internal + */ export const filterSensitiveLog = (obj: AccountInfo): any => ({ ...obj, }); @@ -46,6 +49,9 @@ export interface GetRoleCredentialsRequest { } export namespace GetRoleCredentialsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetRoleCredentialsRequest): any => ({ ...obj, ...(obj.accessToken && { accessToken: SENSITIVE_STRING }), @@ -82,6 +88,9 @@ export interface RoleCredentials { } export namespace RoleCredentials { + /** + * @internal + */ export const filterSensitiveLog = (obj: RoleCredentials): any => ({ ...obj, ...(obj.secretAccessKey && { secretAccessKey: SENSITIVE_STRING }), @@ -97,6 +106,9 @@ export interface GetRoleCredentialsResponse { } export namespace GetRoleCredentialsResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetRoleCredentialsResponse): any => ({ ...obj, ...(obj.roleCredentials && { roleCredentials: RoleCredentials.filterSensitiveLog(obj.roleCredentials) }), @@ -114,6 +126,9 @@ export interface InvalidRequestException extends __SmithyException, $MetadataBea } export namespace InvalidRequestException { + /** + * @internal + */ export const filterSensitiveLog = (obj: InvalidRequestException): any => ({ ...obj, }); @@ -129,6 +144,9 @@ export interface ResourceNotFoundException extends __SmithyException, $MetadataB } export namespace ResourceNotFoundException { + /** + * @internal + */ export const filterSensitiveLog = (obj: ResourceNotFoundException): any => ({ ...obj, }); @@ -144,6 +162,9 @@ export interface TooManyRequestsException extends __SmithyException, $MetadataBe } export namespace TooManyRequestsException { + /** + * @internal + */ export const filterSensitiveLog = (obj: TooManyRequestsException): any => ({ ...obj, }); @@ -159,6 +180,9 @@ export interface UnauthorizedException extends __SmithyException, $MetadataBeare } export namespace UnauthorizedException { + /** + * @internal + */ export const filterSensitiveLog = (obj: UnauthorizedException): any => ({ ...obj, }); @@ -188,6 +212,9 @@ export interface ListAccountRolesRequest { } export namespace ListAccountRolesRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListAccountRolesRequest): any => ({ ...obj, ...(obj.accessToken && { accessToken: SENSITIVE_STRING }), @@ -210,6 +237,9 @@ export interface RoleInfo { } export namespace RoleInfo { + /** + * @internal + */ export const filterSensitiveLog = (obj: RoleInfo): any => ({ ...obj, }); @@ -228,6 +258,9 @@ export interface ListAccountRolesResponse { } export namespace ListAccountRolesResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListAccountRolesResponse): any => ({ ...obj, }); @@ -252,6 +285,9 @@ export interface ListAccountsRequest { } export namespace ListAccountsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListAccountsRequest): any => ({ ...obj, ...(obj.accessToken && { accessToken: SENSITIVE_STRING }), @@ -271,6 +307,9 @@ export interface ListAccountsResponse { } export namespace ListAccountsResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListAccountsResponse): any => ({ ...obj, }); @@ -285,6 +324,9 @@ export interface LogoutRequest { } export namespace LogoutRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: LogoutRequest): any => ({ ...obj, ...(obj.accessToken && { accessToken: SENSITIVE_STRING }), diff --git a/clients/client-storage-gateway/commands/ActivateGatewayCommand.ts b/clients/client-storage-gateway/commands/ActivateGatewayCommand.ts index 5762226c1e20..1eecbb504063 100644 --- a/clients/client-storage-gateway/commands/ActivateGatewayCommand.ts +++ b/clients/client-storage-gateway/commands/ActivateGatewayCommand.ts @@ -29,6 +29,20 @@ export interface ActivateGatewayCommandOutput extends ActivateGatewayOutput, __M * *

You must turn on the gateway VM before you can activate your gateway.

* + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { StorageGatewayClient, ActivateGatewayCommand } from "@aws-sdk/client-storage-gateway"; // ES Modules import + * // const { StorageGatewayClient, ActivateGatewayCommand } = require("@aws-sdk/client-storage-gateway"); // CommonJS import + * const client = new StorageGatewayClient(config); + * const command = new ActivateGatewayCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ActivateGatewayCommandInput} for command's `input` shape. + * @see {@link ActivateGatewayCommandOutput} for command's `response` shape. + * @see {@link StorageGatewayClientResolvedConfig | config} for command's `input` shape. + * */ export class ActivateGatewayCommand extends $Command< ActivateGatewayCommandInput, diff --git a/clients/client-storage-gateway/commands/AddCacheCommand.ts b/clients/client-storage-gateway/commands/AddCacheCommand.ts index 28a9b4cad17a..6a498e58dbc1 100644 --- a/clients/client-storage-gateway/commands/AddCacheCommand.ts +++ b/clients/client-storage-gateway/commands/AddCacheCommand.ts @@ -23,6 +23,20 @@ export interface AddCacheCommandOutput extends AddCacheOutput, __MetadataBearer * *

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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { StorageGatewayClient, AddCacheCommand } from "@aws-sdk/client-storage-gateway"; // ES Modules import + * // const { StorageGatewayClient, AddCacheCommand } = require("@aws-sdk/client-storage-gateway"); // CommonJS import + * const client = new StorageGatewayClient(config); + * const command = new AddCacheCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link AddCacheCommandInput} for command's `input` shape. + * @see {@link AddCacheCommandOutput} for command's `response` shape. + * @see {@link StorageGatewayClientResolvedConfig | config} for command's `input` shape. + * */ export class AddCacheCommand extends $Command< AddCacheCommandInput, diff --git a/clients/client-storage-gateway/commands/AddTagsToResourceCommand.ts b/clients/client-storage-gateway/commands/AddTagsToResourceCommand.ts index bd58ced267e7..28bc6662a89b 100644 --- a/clients/client-storage-gateway/commands/AddTagsToResourceCommand.ts +++ b/clients/client-storage-gateway/commands/AddTagsToResourceCommand.ts @@ -43,6 +43,20 @@ export interface AddTagsToResourceCommandOutput extends AddTagsToResourceOutput, * *

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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { StorageGatewayClient, AddTagsToResourceCommand } from "@aws-sdk/client-storage-gateway"; // ES Modules import + * // const { StorageGatewayClient, AddTagsToResourceCommand } = require("@aws-sdk/client-storage-gateway"); // CommonJS import + * const client = new StorageGatewayClient(config); + * const command = new AddTagsToResourceCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link AddTagsToResourceCommandInput} for command's `input` shape. + * @see {@link AddTagsToResourceCommandOutput} for command's `response` shape. + * @see {@link StorageGatewayClientResolvedConfig | config} for command's `input` shape. + * */ export class AddTagsToResourceCommand extends $Command< AddTagsToResourceCommandInput, diff --git a/clients/client-storage-gateway/commands/AddUploadBufferCommand.ts b/clients/client-storage-gateway/commands/AddUploadBufferCommand.ts index 6d8b6c95a478..80dd6ae3ce22 100644 --- a/clients/client-storage-gateway/commands/AddUploadBufferCommand.ts +++ b/clients/client-storage-gateway/commands/AddUploadBufferCommand.ts @@ -28,6 +28,20 @@ export interface AddUploadBufferCommandOutput extends AddUploadBufferOutput, __M *

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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { StorageGatewayClient, AddUploadBufferCommand } from "@aws-sdk/client-storage-gateway"; // ES Modules import + * // const { StorageGatewayClient, AddUploadBufferCommand } = require("@aws-sdk/client-storage-gateway"); // CommonJS import + * const client = new StorageGatewayClient(config); + * const command = new AddUploadBufferCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link AddUploadBufferCommandInput} for command's `input` shape. + * @see {@link AddUploadBufferCommandOutput} for command's `response` shape. + * @see {@link StorageGatewayClientResolvedConfig | config} for command's `input` shape. + * */ export class AddUploadBufferCommand extends $Command< AddUploadBufferCommandInput, diff --git a/clients/client-storage-gateway/commands/AddWorkingStorageCommand.ts b/clients/client-storage-gateway/commands/AddWorkingStorageCommand.ts index 2a30a73c547b..c12c0cedda91 100644 --- a/clients/client-storage-gateway/commands/AddWorkingStorageCommand.ts +++ b/clients/client-storage-gateway/commands/AddWorkingStorageCommand.ts @@ -34,6 +34,20 @@ export interface AddWorkingStorageCommandOutput extends AddWorkingStorageOutput, *

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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { StorageGatewayClient, AddWorkingStorageCommand } from "@aws-sdk/client-storage-gateway"; // ES Modules import + * // const { StorageGatewayClient, AddWorkingStorageCommand } = require("@aws-sdk/client-storage-gateway"); // CommonJS import + * const client = new StorageGatewayClient(config); + * const command = new AddWorkingStorageCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link AddWorkingStorageCommandInput} for command's `input` shape. + * @see {@link AddWorkingStorageCommandOutput} for command's `response` shape. + * @see {@link StorageGatewayClientResolvedConfig | config} for command's `input` shape. + * */ export class AddWorkingStorageCommand extends $Command< AddWorkingStorageCommandInput, diff --git a/clients/client-storage-gateway/commands/AssignTapePoolCommand.ts b/clients/client-storage-gateway/commands/AssignTapePoolCommand.ts index b364942b27ae..54ec8878b38b 100644 --- a/clients/client-storage-gateway/commands/AssignTapePoolCommand.ts +++ b/clients/client-storage-gateway/commands/AssignTapePoolCommand.ts @@ -28,6 +28,20 @@ export interface AssignTapePoolCommandOutput extends AssignTapePoolOutput, __Met * *

Valid Values: GLACIER | DEEP_ARCHIVE *

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { StorageGatewayClient, AssignTapePoolCommand } from "@aws-sdk/client-storage-gateway"; // ES Modules import + * // const { StorageGatewayClient, AssignTapePoolCommand } = require("@aws-sdk/client-storage-gateway"); // CommonJS import + * const client = new StorageGatewayClient(config); + * const command = new AssignTapePoolCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link AssignTapePoolCommandInput} for command's `input` shape. + * @see {@link AssignTapePoolCommandOutput} for command's `response` shape. + * @see {@link StorageGatewayClientResolvedConfig | config} for command's `input` shape. + * */ export class AssignTapePoolCommand extends $Command< AssignTapePoolCommandInput, diff --git a/clients/client-storage-gateway/commands/AssociateFileSystemCommand.ts b/clients/client-storage-gateway/commands/AssociateFileSystemCommand.ts index 8af6b1e9a59f..14a3ddc4e1e6 100644 --- a/clients/client-storage-gateway/commands/AssociateFileSystemCommand.ts +++ b/clients/client-storage-gateway/commands/AssociateFileSystemCommand.ts @@ -25,6 +25,20 @@ export interface AssociateFileSystemCommandOutput extends AssociateFileSystemOut * 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 Amazon FSx file * gateway type.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { StorageGatewayClient, AssociateFileSystemCommand } from "@aws-sdk/client-storage-gateway"; // ES Modules import + * // const { StorageGatewayClient, AssociateFileSystemCommand } = require("@aws-sdk/client-storage-gateway"); // CommonJS import + * const client = new StorageGatewayClient(config); + * const command = new AssociateFileSystemCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link AssociateFileSystemCommandInput} for command's `input` shape. + * @see {@link AssociateFileSystemCommandOutput} for command's `response` shape. + * @see {@link StorageGatewayClientResolvedConfig | config} for command's `input` shape. + * */ export class AssociateFileSystemCommand extends $Command< AssociateFileSystemCommandInput, diff --git a/clients/client-storage-gateway/commands/AttachVolumeCommand.ts b/clients/client-storage-gateway/commands/AttachVolumeCommand.ts index 3b6c3427e0d7..08da847ae237 100644 --- a/clients/client-storage-gateway/commands/AttachVolumeCommand.ts +++ b/clients/client-storage-gateway/commands/AttachVolumeCommand.ts @@ -25,6 +25,20 @@ export interface AttachVolumeCommandOutput extends AttachVolumeOutput, __Metadat * 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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { StorageGatewayClient, AttachVolumeCommand } from "@aws-sdk/client-storage-gateway"; // ES Modules import + * // const { StorageGatewayClient, AttachVolumeCommand } = require("@aws-sdk/client-storage-gateway"); // CommonJS import + * const client = new StorageGatewayClient(config); + * const command = new AttachVolumeCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link AttachVolumeCommandInput} for command's `input` shape. + * @see {@link AttachVolumeCommandOutput} for command's `response` shape. + * @see {@link StorageGatewayClientResolvedConfig | config} for command's `input` shape. + * */ export class AttachVolumeCommand extends $Command< AttachVolumeCommandInput, diff --git a/clients/client-storage-gateway/commands/CancelArchivalCommand.ts b/clients/client-storage-gateway/commands/CancelArchivalCommand.ts index cb1ae242aead..c326623df479 100644 --- a/clients/client-storage-gateway/commands/CancelArchivalCommand.ts +++ b/clients/client-storage-gateway/commands/CancelArchivalCommand.ts @@ -23,6 +23,20 @@ export interface CancelArchivalCommandOutput extends CancelArchivalOutput, __Met /** *

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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { StorageGatewayClient, CancelArchivalCommand } from "@aws-sdk/client-storage-gateway"; // ES Modules import + * // const { StorageGatewayClient, CancelArchivalCommand } = require("@aws-sdk/client-storage-gateway"); // CommonJS import + * const client = new StorageGatewayClient(config); + * const command = new CancelArchivalCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CancelArchivalCommandInput} for command's `input` shape. + * @see {@link CancelArchivalCommandOutput} for command's `response` shape. + * @see {@link StorageGatewayClientResolvedConfig | config} for command's `input` shape. + * */ export class CancelArchivalCommand extends $Command< CancelArchivalCommandInput, diff --git a/clients/client-storage-gateway/commands/CancelRetrievalCommand.ts b/clients/client-storage-gateway/commands/CancelRetrievalCommand.ts index 07cdb6683fdb..0ef236bde36b 100644 --- a/clients/client-storage-gateway/commands/CancelRetrievalCommand.ts +++ b/clients/client-storage-gateway/commands/CancelRetrievalCommand.ts @@ -24,6 +24,20 @@ export interface CancelRetrievalCommandOutput extends CancelRetrievalOutput, __M *

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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { StorageGatewayClient, CancelRetrievalCommand } from "@aws-sdk/client-storage-gateway"; // ES Modules import + * // const { StorageGatewayClient, CancelRetrievalCommand } = require("@aws-sdk/client-storage-gateway"); // CommonJS import + * const client = new StorageGatewayClient(config); + * const command = new CancelRetrievalCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CancelRetrievalCommandInput} for command's `input` shape. + * @see {@link CancelRetrievalCommandOutput} for command's `response` shape. + * @see {@link StorageGatewayClientResolvedConfig | config} for command's `input` shape. + * */ export class CancelRetrievalCommand extends $Command< CancelRetrievalCommandInput, diff --git a/clients/client-storage-gateway/commands/CreateCachediSCSIVolumeCommand.ts b/clients/client-storage-gateway/commands/CreateCachediSCSIVolumeCommand.ts index fb6e18fc751d..8c296d43d8c4 100644 --- a/clients/client-storage-gateway/commands/CreateCachediSCSIVolumeCommand.ts +++ b/clients/client-storage-gateway/commands/CreateCachediSCSIVolumeCommand.ts @@ -39,6 +39,20 @@ export interface CreateCachediSCSIVolumeCommandOutput extends CreateCachediSCSIV * 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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { StorageGatewayClient, CreateCachediSCSIVolumeCommand } from "@aws-sdk/client-storage-gateway"; // ES Modules import + * // const { StorageGatewayClient, CreateCachediSCSIVolumeCommand } = require("@aws-sdk/client-storage-gateway"); // CommonJS import + * const client = new StorageGatewayClient(config); + * const command = new CreateCachediSCSIVolumeCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreateCachediSCSIVolumeCommandInput} for command's `input` shape. + * @see {@link CreateCachediSCSIVolumeCommandOutput} for command's `response` shape. + * @see {@link StorageGatewayClientResolvedConfig | config} for command's `input` shape. + * */ export class CreateCachediSCSIVolumeCommand extends $Command< CreateCachediSCSIVolumeCommandInput, diff --git a/clients/client-storage-gateway/commands/CreateNFSFileShareCommand.ts b/clients/client-storage-gateway/commands/CreateNFSFileShareCommand.ts index 7812c81b5f93..76f8342c3916 100644 --- a/clients/client-storage-gateway/commands/CreateNFSFileShareCommand.ts +++ b/clients/client-storage-gateway/commands/CreateNFSFileShareCommand.ts @@ -36,6 +36,20 @@ export interface CreateNFSFileShareCommandOutput extends CreateNFSFileShareOutpu * *

File gateway does not support creating hard or symbolic links on a file share.

* + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { StorageGatewayClient, CreateNFSFileShareCommand } from "@aws-sdk/client-storage-gateway"; // ES Modules import + * // const { StorageGatewayClient, CreateNFSFileShareCommand } = require("@aws-sdk/client-storage-gateway"); // CommonJS import + * const client = new StorageGatewayClient(config); + * const command = new CreateNFSFileShareCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreateNFSFileShareCommandInput} for command's `input` shape. + * @see {@link CreateNFSFileShareCommandOutput} for command's `response` shape. + * @see {@link StorageGatewayClientResolvedConfig | config} for command's `input` shape. + * */ export class CreateNFSFileShareCommand extends $Command< CreateNFSFileShareCommandInput, diff --git a/clients/client-storage-gateway/commands/CreateSMBFileShareCommand.ts b/clients/client-storage-gateway/commands/CreateSMBFileShareCommand.ts index 2d35261d14bc..e5aace6a4dde 100644 --- a/clients/client-storage-gateway/commands/CreateSMBFileShareCommand.ts +++ b/clients/client-storage-gateway/commands/CreateSMBFileShareCommand.ts @@ -37,6 +37,20 @@ export interface CreateSMBFileShareCommandOutput extends CreateSMBFileShareOutpu *

File gateways don't support creating hard or symbolic links on a file * share.

* + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { StorageGatewayClient, CreateSMBFileShareCommand } from "@aws-sdk/client-storage-gateway"; // ES Modules import + * // const { StorageGatewayClient, CreateSMBFileShareCommand } = require("@aws-sdk/client-storage-gateway"); // CommonJS import + * const client = new StorageGatewayClient(config); + * const command = new CreateSMBFileShareCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreateSMBFileShareCommandInput} for command's `input` shape. + * @see {@link CreateSMBFileShareCommandOutput} for command's `response` shape. + * @see {@link StorageGatewayClientResolvedConfig | config} for command's `input` shape. + * */ export class CreateSMBFileShareCommand extends $Command< CreateSMBFileShareCommandInput, diff --git a/clients/client-storage-gateway/commands/CreateSnapshotCommand.ts b/clients/client-storage-gateway/commands/CreateSnapshotCommand.ts index 8f4c055f1b16..a5d7fa3f848c 100644 --- a/clients/client-storage-gateway/commands/CreateSnapshotCommand.ts +++ b/clients/client-storage-gateway/commands/CreateSnapshotCommand.ts @@ -49,6 +49,20 @@ export interface CreateSnapshotCommandOutput extends CreateSnapshotOutput, __Met *

Volume and snapshot IDs are changing to a longer length ID format. For more * information, see the important note on the Welcome page.

* + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { StorageGatewayClient, CreateSnapshotCommand } from "@aws-sdk/client-storage-gateway"; // ES Modules import + * // const { StorageGatewayClient, CreateSnapshotCommand } = require("@aws-sdk/client-storage-gateway"); // CommonJS import + * const client = new StorageGatewayClient(config); + * const command = new CreateSnapshotCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreateSnapshotCommandInput} for command's `input` shape. + * @see {@link CreateSnapshotCommandOutput} for command's `response` shape. + * @see {@link StorageGatewayClientResolvedConfig | config} for command's `input` shape. + * */ export class CreateSnapshotCommand extends $Command< CreateSnapshotCommandInput, diff --git a/clients/client-storage-gateway/commands/CreateSnapshotFromVolumeRecoveryPointCommand.ts b/clients/client-storage-gateway/commands/CreateSnapshotFromVolumeRecoveryPointCommand.ts index bb0567b4d6d6..5343aac22fae 100644 --- a/clients/client-storage-gateway/commands/CreateSnapshotFromVolumeRecoveryPointCommand.ts +++ b/clients/client-storage-gateway/commands/CreateSnapshotFromVolumeRecoveryPointCommand.ts @@ -47,6 +47,20 @@ export interface CreateSnapshotFromVolumeRecoveryPointCommandOutput * or DeleteSnapshot in the Amazon Elastic Compute Cloud API * Reference.

* + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { StorageGatewayClient, CreateSnapshotFromVolumeRecoveryPointCommand } from "@aws-sdk/client-storage-gateway"; // ES Modules import + * // const { StorageGatewayClient, CreateSnapshotFromVolumeRecoveryPointCommand } = require("@aws-sdk/client-storage-gateway"); // CommonJS import + * const client = new StorageGatewayClient(config); + * const command = new CreateSnapshotFromVolumeRecoveryPointCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreateSnapshotFromVolumeRecoveryPointCommandInput} for command's `input` shape. + * @see {@link CreateSnapshotFromVolumeRecoveryPointCommandOutput} for command's `response` shape. + * @see {@link StorageGatewayClientResolvedConfig | config} for command's `input` shape. + * */ export class CreateSnapshotFromVolumeRecoveryPointCommand extends $Command< CreateSnapshotFromVolumeRecoveryPointCommandInput, diff --git a/clients/client-storage-gateway/commands/CreateStorediSCSIVolumeCommand.ts b/clients/client-storage-gateway/commands/CreateStorediSCSIVolumeCommand.ts index d7e7e9c9a985..b495c026ca77 100644 --- a/clients/client-storage-gateway/commands/CreateStorediSCSIVolumeCommand.ts +++ b/clients/client-storage-gateway/commands/CreateStorediSCSIVolumeCommand.ts @@ -33,6 +33,20 @@ export interface CreateStorediSCSIVolumeCommandOutput extends CreateStorediSCSIV * 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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { StorageGatewayClient, CreateStorediSCSIVolumeCommand } from "@aws-sdk/client-storage-gateway"; // ES Modules import + * // const { StorageGatewayClient, CreateStorediSCSIVolumeCommand } = require("@aws-sdk/client-storage-gateway"); // CommonJS import + * const client = new StorageGatewayClient(config); + * const command = new CreateStorediSCSIVolumeCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreateStorediSCSIVolumeCommandInput} for command's `input` shape. + * @see {@link CreateStorediSCSIVolumeCommandOutput} for command's `response` shape. + * @see {@link StorageGatewayClientResolvedConfig | config} for command's `input` shape. + * */ export class CreateStorediSCSIVolumeCommand extends $Command< CreateStorediSCSIVolumeCommandInput, diff --git a/clients/client-storage-gateway/commands/CreateTapePoolCommand.ts b/clients/client-storage-gateway/commands/CreateTapePoolCommand.ts index 5392983e5209..fd3f1d33dab8 100644 --- a/clients/client-storage-gateway/commands/CreateTapePoolCommand.ts +++ b/clients/client-storage-gateway/commands/CreateTapePoolCommand.ts @@ -23,6 +23,20 @@ export interface CreateTapePoolCommandOutput extends CreateTapePoolOutput, __Met /** *

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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { StorageGatewayClient, CreateTapePoolCommand } from "@aws-sdk/client-storage-gateway"; // ES Modules import + * // const { StorageGatewayClient, CreateTapePoolCommand } = require("@aws-sdk/client-storage-gateway"); // CommonJS import + * const client = new StorageGatewayClient(config); + * const command = new CreateTapePoolCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreateTapePoolCommandInput} for command's `input` shape. + * @see {@link CreateTapePoolCommandOutput} for command's `response` shape. + * @see {@link StorageGatewayClientResolvedConfig | config} for command's `input` shape. + * */ export class CreateTapePoolCommand extends $Command< CreateTapePoolCommandInput, diff --git a/clients/client-storage-gateway/commands/CreateTapeWithBarcodeCommand.ts b/clients/client-storage-gateway/commands/CreateTapeWithBarcodeCommand.ts index e2ec82f10248..6dd5193af98d 100644 --- a/clients/client-storage-gateway/commands/CreateTapeWithBarcodeCommand.ts +++ b/clients/client-storage-gateway/commands/CreateTapeWithBarcodeCommand.ts @@ -30,6 +30,20 @@ export interface CreateTapeWithBarcodeCommandOutput extends CreateTapeWithBarcod *

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.

* + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { StorageGatewayClient, CreateTapeWithBarcodeCommand } from "@aws-sdk/client-storage-gateway"; // ES Modules import + * // const { StorageGatewayClient, CreateTapeWithBarcodeCommand } = require("@aws-sdk/client-storage-gateway"); // CommonJS import + * const client = new StorageGatewayClient(config); + * const command = new CreateTapeWithBarcodeCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreateTapeWithBarcodeCommandInput} for command's `input` shape. + * @see {@link CreateTapeWithBarcodeCommandOutput} for command's `response` shape. + * @see {@link StorageGatewayClientResolvedConfig | config} for command's `input` shape. + * */ export class CreateTapeWithBarcodeCommand extends $Command< CreateTapeWithBarcodeCommandInput, diff --git a/clients/client-storage-gateway/commands/CreateTapesCommand.ts b/clients/client-storage-gateway/commands/CreateTapesCommand.ts index a3169aab9b7e..35f210a25ba5 100644 --- a/clients/client-storage-gateway/commands/CreateTapesCommand.ts +++ b/clients/client-storage-gateway/commands/CreateTapesCommand.ts @@ -28,6 +28,20 @@ export interface CreateTapesCommandOutput extends CreateTapesOutput, __MetadataB *

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.

* + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { StorageGatewayClient, CreateTapesCommand } from "@aws-sdk/client-storage-gateway"; // ES Modules import + * // const { StorageGatewayClient, CreateTapesCommand } = require("@aws-sdk/client-storage-gateway"); // CommonJS import + * const client = new StorageGatewayClient(config); + * const command = new CreateTapesCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreateTapesCommandInput} for command's `input` shape. + * @see {@link CreateTapesCommandOutput} for command's `response` shape. + * @see {@link StorageGatewayClientResolvedConfig | config} for command's `input` shape. + * */ export class CreateTapesCommand extends $Command< CreateTapesCommandInput, diff --git a/clients/client-storage-gateway/commands/DeleteAutomaticTapeCreationPolicyCommand.ts b/clients/client-storage-gateway/commands/DeleteAutomaticTapeCreationPolicyCommand.ts index 8fe8427b1352..bde9d8e0a30f 100644 --- a/clients/client-storage-gateway/commands/DeleteAutomaticTapeCreationPolicyCommand.ts +++ b/clients/client-storage-gateway/commands/DeleteAutomaticTapeCreationPolicyCommand.ts @@ -26,6 +26,20 @@ export interface DeleteAutomaticTapeCreationPolicyCommandOutput *

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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { StorageGatewayClient, DeleteAutomaticTapeCreationPolicyCommand } from "@aws-sdk/client-storage-gateway"; // ES Modules import + * // const { StorageGatewayClient, DeleteAutomaticTapeCreationPolicyCommand } = require("@aws-sdk/client-storage-gateway"); // CommonJS import + * const client = new StorageGatewayClient(config); + * const command = new DeleteAutomaticTapeCreationPolicyCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteAutomaticTapeCreationPolicyCommandInput} for command's `input` shape. + * @see {@link DeleteAutomaticTapeCreationPolicyCommandOutput} for command's `response` shape. + * @see {@link StorageGatewayClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteAutomaticTapeCreationPolicyCommand extends $Command< DeleteAutomaticTapeCreationPolicyCommandInput, diff --git a/clients/client-storage-gateway/commands/DeleteBandwidthRateLimitCommand.ts b/clients/client-storage-gateway/commands/DeleteBandwidthRateLimitCommand.ts index 795ae50085d3..c0040be5e486 100644 --- a/clients/client-storage-gateway/commands/DeleteBandwidthRateLimitCommand.ts +++ b/clients/client-storage-gateway/commands/DeleteBandwidthRateLimitCommand.ts @@ -26,6 +26,20 @@ export interface DeleteBandwidthRateLimitCommandOutput extends DeleteBandwidthRa * 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 for * the stored volume, cached volume and tape gateway types.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { StorageGatewayClient, DeleteBandwidthRateLimitCommand } from "@aws-sdk/client-storage-gateway"; // ES Modules import + * // const { StorageGatewayClient, DeleteBandwidthRateLimitCommand } = require("@aws-sdk/client-storage-gateway"); // CommonJS import + * const client = new StorageGatewayClient(config); + * const command = new DeleteBandwidthRateLimitCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteBandwidthRateLimitCommandInput} for command's `input` shape. + * @see {@link DeleteBandwidthRateLimitCommandOutput} for command's `response` shape. + * @see {@link StorageGatewayClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteBandwidthRateLimitCommand extends $Command< DeleteBandwidthRateLimitCommandInput, diff --git a/clients/client-storage-gateway/commands/DeleteChapCredentialsCommand.ts b/clients/client-storage-gateway/commands/DeleteChapCredentialsCommand.ts index 4b0773f4045f..a5bfbb74bcda 100644 --- a/clients/client-storage-gateway/commands/DeleteChapCredentialsCommand.ts +++ b/clients/client-storage-gateway/commands/DeleteChapCredentialsCommand.ts @@ -24,6 +24,20 @@ export interface DeleteChapCredentialsCommandOutput extends DeleteChapCredential *

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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { StorageGatewayClient, DeleteChapCredentialsCommand } from "@aws-sdk/client-storage-gateway"; // ES Modules import + * // const { StorageGatewayClient, DeleteChapCredentialsCommand } = require("@aws-sdk/client-storage-gateway"); // CommonJS import + * const client = new StorageGatewayClient(config); + * const command = new DeleteChapCredentialsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteChapCredentialsCommandInput} for command's `input` shape. + * @see {@link DeleteChapCredentialsCommandOutput} for command's `response` shape. + * @see {@link StorageGatewayClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteChapCredentialsCommand extends $Command< DeleteChapCredentialsCommandInput, diff --git a/clients/client-storage-gateway/commands/DeleteFileShareCommand.ts b/clients/client-storage-gateway/commands/DeleteFileShareCommand.ts index 6aecb6fafc53..95d49cea1def 100644 --- a/clients/client-storage-gateway/commands/DeleteFileShareCommand.ts +++ b/clients/client-storage-gateway/commands/DeleteFileShareCommand.ts @@ -23,6 +23,20 @@ export interface DeleteFileShareCommandOutput extends DeleteFileShareOutput, __M /** *

Deletes a file share from a file gateway. This operation is only supported for file * gateways.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { StorageGatewayClient, DeleteFileShareCommand } from "@aws-sdk/client-storage-gateway"; // ES Modules import + * // const { StorageGatewayClient, DeleteFileShareCommand } = require("@aws-sdk/client-storage-gateway"); // CommonJS import + * const client = new StorageGatewayClient(config); + * const command = new DeleteFileShareCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteFileShareCommandInput} for command's `input` shape. + * @see {@link DeleteFileShareCommandOutput} for command's `response` shape. + * @see {@link StorageGatewayClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteFileShareCommand extends $Command< DeleteFileShareCommandInput, diff --git a/clients/client-storage-gateway/commands/DeleteGatewayCommand.ts b/clients/client-storage-gateway/commands/DeleteGatewayCommand.ts index 27b2ca715a52..ebe2fb7043a9 100644 --- a/clients/client-storage-gateway/commands/DeleteGatewayCommand.ts +++ b/clients/client-storage-gateway/commands/DeleteGatewayCommand.ts @@ -39,6 +39,20 @@ export interface DeleteGatewayCommandOutput extends DeleteGatewayOutput, __Metad * AWS Storage Gateway detail * page.

* + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { StorageGatewayClient, DeleteGatewayCommand } from "@aws-sdk/client-storage-gateway"; // ES Modules import + * // const { StorageGatewayClient, DeleteGatewayCommand } = require("@aws-sdk/client-storage-gateway"); // CommonJS import + * const client = new StorageGatewayClient(config); + * const command = new DeleteGatewayCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteGatewayCommandInput} for command's `input` shape. + * @see {@link DeleteGatewayCommandOutput} for command's `response` shape. + * @see {@link StorageGatewayClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteGatewayCommand extends $Command< DeleteGatewayCommandInput, diff --git a/clients/client-storage-gateway/commands/DeleteSnapshotScheduleCommand.ts b/clients/client-storage-gateway/commands/DeleteSnapshotScheduleCommand.ts index 93b618d97341..84a68ad223b0 100644 --- a/clients/client-storage-gateway/commands/DeleteSnapshotScheduleCommand.ts +++ b/clients/client-storage-gateway/commands/DeleteSnapshotScheduleCommand.ts @@ -36,6 +36,20 @@ export interface DeleteSnapshotScheduleCommandOutput extends DeleteSnapshotSched * go to DescribeSnapshots * in the Amazon Elastic Compute Cloud API Reference.

* + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { StorageGatewayClient, DeleteSnapshotScheduleCommand } from "@aws-sdk/client-storage-gateway"; // ES Modules import + * // const { StorageGatewayClient, DeleteSnapshotScheduleCommand } = require("@aws-sdk/client-storage-gateway"); // CommonJS import + * const client = new StorageGatewayClient(config); + * const command = new DeleteSnapshotScheduleCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteSnapshotScheduleCommandInput} for command's `input` shape. + * @see {@link DeleteSnapshotScheduleCommandOutput} for command's `response` shape. + * @see {@link StorageGatewayClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteSnapshotScheduleCommand extends $Command< DeleteSnapshotScheduleCommandInput, diff --git a/clients/client-storage-gateway/commands/DeleteTapeArchiveCommand.ts b/clients/client-storage-gateway/commands/DeleteTapeArchiveCommand.ts index d3b333978cef..c68aa64508f5 100644 --- a/clients/client-storage-gateway/commands/DeleteTapeArchiveCommand.ts +++ b/clients/client-storage-gateway/commands/DeleteTapeArchiveCommand.ts @@ -23,6 +23,20 @@ export interface DeleteTapeArchiveCommandOutput extends DeleteTapeArchiveOutput, /** *

Deletes the specified virtual tape from the virtual tape shelf (VTS). This operation is * only supported in the tape gateway type.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { StorageGatewayClient, DeleteTapeArchiveCommand } from "@aws-sdk/client-storage-gateway"; // ES Modules import + * // const { StorageGatewayClient, DeleteTapeArchiveCommand } = require("@aws-sdk/client-storage-gateway"); // CommonJS import + * const client = new StorageGatewayClient(config); + * const command = new DeleteTapeArchiveCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteTapeArchiveCommandInput} for command's `input` shape. + * @see {@link DeleteTapeArchiveCommandOutput} for command's `response` shape. + * @see {@link StorageGatewayClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteTapeArchiveCommand extends $Command< DeleteTapeArchiveCommandInput, diff --git a/clients/client-storage-gateway/commands/DeleteTapeCommand.ts b/clients/client-storage-gateway/commands/DeleteTapeCommand.ts index 7dc911619017..7ba27f5d87f6 100644 --- a/clients/client-storage-gateway/commands/DeleteTapeCommand.ts +++ b/clients/client-storage-gateway/commands/DeleteTapeCommand.ts @@ -23,6 +23,20 @@ export interface DeleteTapeCommandOutput extends DeleteTapeOutput, __MetadataBea /** *

Deletes the specified virtual tape. This operation is only supported in the tape gateway * type.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { StorageGatewayClient, DeleteTapeCommand } from "@aws-sdk/client-storage-gateway"; // ES Modules import + * // const { StorageGatewayClient, DeleteTapeCommand } = require("@aws-sdk/client-storage-gateway"); // CommonJS import + * const client = new StorageGatewayClient(config); + * const command = new DeleteTapeCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteTapeCommandInput} for command's `input` shape. + * @see {@link DeleteTapeCommandOutput} for command's `response` shape. + * @see {@link StorageGatewayClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteTapeCommand extends $Command< DeleteTapeCommandInput, diff --git a/clients/client-storage-gateway/commands/DeleteTapePoolCommand.ts b/clients/client-storage-gateway/commands/DeleteTapePoolCommand.ts index 29f8d704f07e..16ecab1030e3 100644 --- a/clients/client-storage-gateway/commands/DeleteTapePoolCommand.ts +++ b/clients/client-storage-gateway/commands/DeleteTapePoolCommand.ts @@ -24,6 +24,20 @@ export interface DeleteTapePoolCommandOutput extends DeleteTapePoolOutput, __Met *

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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { StorageGatewayClient, DeleteTapePoolCommand } from "@aws-sdk/client-storage-gateway"; // ES Modules import + * // const { StorageGatewayClient, DeleteTapePoolCommand } = require("@aws-sdk/client-storage-gateway"); // CommonJS import + * const client = new StorageGatewayClient(config); + * const command = new DeleteTapePoolCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteTapePoolCommandInput} for command's `input` shape. + * @see {@link DeleteTapePoolCommandOutput} for command's `response` shape. + * @see {@link StorageGatewayClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteTapePoolCommand extends $Command< DeleteTapePoolCommandInput, diff --git a/clients/client-storage-gateway/commands/DeleteVolumeCommand.ts b/clients/client-storage-gateway/commands/DeleteVolumeCommand.ts index a0156b7f6a8f..01f786adb49e 100644 --- a/clients/client-storage-gateway/commands/DeleteVolumeCommand.ts +++ b/clients/client-storage-gateway/commands/DeleteVolumeCommand.ts @@ -34,6 +34,20 @@ export interface DeleteVolumeCommandOutput extends DeleteVolumeOutput, __Metadat * *

In the request, you must provide the Amazon Resource Name (ARN) of the storage volume * you want to delete.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { StorageGatewayClient, DeleteVolumeCommand } from "@aws-sdk/client-storage-gateway"; // ES Modules import + * // const { StorageGatewayClient, DeleteVolumeCommand } = require("@aws-sdk/client-storage-gateway"); // CommonJS import + * const client = new StorageGatewayClient(config); + * const command = new DeleteVolumeCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteVolumeCommandInput} for command's `input` shape. + * @see {@link DeleteVolumeCommandOutput} for command's `response` shape. + * @see {@link StorageGatewayClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteVolumeCommand extends $Command< DeleteVolumeCommandInput, diff --git a/clients/client-storage-gateway/commands/DescribeAvailabilityMonitorTestCommand.ts b/clients/client-storage-gateway/commands/DescribeAvailabilityMonitorTestCommand.ts index 6f91514b9849..8acb4d9c7ab3 100644 --- a/clients/client-storage-gateway/commands/DescribeAvailabilityMonitorTestCommand.ts +++ b/clients/client-storage-gateway/commands/DescribeAvailabilityMonitorTestCommand.ts @@ -26,6 +26,20 @@ export interface DescribeAvailabilityMonitorTestCommandOutput *

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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { StorageGatewayClient, DescribeAvailabilityMonitorTestCommand } from "@aws-sdk/client-storage-gateway"; // ES Modules import + * // const { StorageGatewayClient, DescribeAvailabilityMonitorTestCommand } = require("@aws-sdk/client-storage-gateway"); // CommonJS import + * const client = new StorageGatewayClient(config); + * const command = new DescribeAvailabilityMonitorTestCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeAvailabilityMonitorTestCommandInput} for command's `input` shape. + * @see {@link DescribeAvailabilityMonitorTestCommandOutput} for command's `response` shape. + * @see {@link StorageGatewayClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeAvailabilityMonitorTestCommand extends $Command< DescribeAvailabilityMonitorTestCommandInput, diff --git a/clients/client-storage-gateway/commands/DescribeBandwidthRateLimitCommand.ts b/clients/client-storage-gateway/commands/DescribeBandwidthRateLimitCommand.ts index 3d29282328cb..f596a4290072 100644 --- a/clients/client-storage-gateway/commands/DescribeBandwidthRateLimitCommand.ts +++ b/clients/client-storage-gateway/commands/DescribeBandwidthRateLimitCommand.ts @@ -29,6 +29,20 @@ export interface DescribeBandwidthRateLimitCommandOutput extends DescribeBandwid * 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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { StorageGatewayClient, DescribeBandwidthRateLimitCommand } from "@aws-sdk/client-storage-gateway"; // ES Modules import + * // const { StorageGatewayClient, DescribeBandwidthRateLimitCommand } = require("@aws-sdk/client-storage-gateway"); // CommonJS import + * const client = new StorageGatewayClient(config); + * const command = new DescribeBandwidthRateLimitCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeBandwidthRateLimitCommandInput} for command's `input` shape. + * @see {@link DescribeBandwidthRateLimitCommandOutput} for command's `response` shape. + * @see {@link StorageGatewayClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeBandwidthRateLimitCommand extends $Command< DescribeBandwidthRateLimitCommandInput, diff --git a/clients/client-storage-gateway/commands/DescribeBandwidthRateLimitScheduleCommand.ts b/clients/client-storage-gateway/commands/DescribeBandwidthRateLimitScheduleCommand.ts index 88f2dc72ffa2..b1005bc64655 100644 --- a/clients/client-storage-gateway/commands/DescribeBandwidthRateLimitScheduleCommand.ts +++ b/clients/client-storage-gateway/commands/DescribeBandwidthRateLimitScheduleCommand.ts @@ -44,6 +44,20 @@ export interface DescribeBandwidthRateLimitScheduleCommandOutput * 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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { StorageGatewayClient, DescribeBandwidthRateLimitScheduleCommand } from "@aws-sdk/client-storage-gateway"; // ES Modules import + * // const { StorageGatewayClient, DescribeBandwidthRateLimitScheduleCommand } = require("@aws-sdk/client-storage-gateway"); // CommonJS import + * const client = new StorageGatewayClient(config); + * const command = new DescribeBandwidthRateLimitScheduleCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeBandwidthRateLimitScheduleCommandInput} for command's `input` shape. + * @see {@link DescribeBandwidthRateLimitScheduleCommandOutput} for command's `response` shape. + * @see {@link StorageGatewayClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeBandwidthRateLimitScheduleCommand extends $Command< DescribeBandwidthRateLimitScheduleCommandInput, diff --git a/clients/client-storage-gateway/commands/DescribeCacheCommand.ts b/clients/client-storage-gateway/commands/DescribeCacheCommand.ts index b9353a1e91b6..0b03627567c8 100644 --- a/clients/client-storage-gateway/commands/DescribeCacheCommand.ts +++ b/clients/client-storage-gateway/commands/DescribeCacheCommand.ts @@ -26,6 +26,20 @@ export interface DescribeCacheCommandOutput extends DescribeCacheOutput, __Metad * *

The response includes disk IDs that are configured as cache, and it includes the amount * of cache allocated and used.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { StorageGatewayClient, DescribeCacheCommand } from "@aws-sdk/client-storage-gateway"; // ES Modules import + * // const { StorageGatewayClient, DescribeCacheCommand } = require("@aws-sdk/client-storage-gateway"); // CommonJS import + * const client = new StorageGatewayClient(config); + * const command = new DescribeCacheCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeCacheCommandInput} for command's `input` shape. + * @see {@link DescribeCacheCommandOutput} for command's `response` shape. + * @see {@link StorageGatewayClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeCacheCommand extends $Command< DescribeCacheCommandInput, diff --git a/clients/client-storage-gateway/commands/DescribeCachediSCSIVolumesCommand.ts b/clients/client-storage-gateway/commands/DescribeCachediSCSIVolumesCommand.ts index 23a8df30b7e2..f9c866c8b04b 100644 --- a/clients/client-storage-gateway/commands/DescribeCachediSCSIVolumesCommand.ts +++ b/clients/client-storage-gateway/commands/DescribeCachediSCSIVolumesCommand.ts @@ -27,6 +27,20 @@ export interface DescribeCachediSCSIVolumesCommandOutput extends DescribeCachedi *

The list of gateway volumes in the request must be from one gateway. In the response, * AWS Storage Gateway returns volume information sorted by volume Amazon Resource Name * (ARN).

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { StorageGatewayClient, DescribeCachediSCSIVolumesCommand } from "@aws-sdk/client-storage-gateway"; // ES Modules import + * // const { StorageGatewayClient, DescribeCachediSCSIVolumesCommand } = require("@aws-sdk/client-storage-gateway"); // CommonJS import + * const client = new StorageGatewayClient(config); + * const command = new DescribeCachediSCSIVolumesCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeCachediSCSIVolumesCommandInput} for command's `input` shape. + * @see {@link DescribeCachediSCSIVolumesCommandOutput} for command's `response` shape. + * @see {@link StorageGatewayClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeCachediSCSIVolumesCommand extends $Command< DescribeCachediSCSIVolumesCommandInput, diff --git a/clients/client-storage-gateway/commands/DescribeChapCredentialsCommand.ts b/clients/client-storage-gateway/commands/DescribeChapCredentialsCommand.ts index e37845912d2f..f5a83d66cf8f 100644 --- a/clients/client-storage-gateway/commands/DescribeChapCredentialsCommand.ts +++ b/clients/client-storage-gateway/commands/DescribeChapCredentialsCommand.ts @@ -24,6 +24,20 @@ export interface DescribeChapCredentialsCommandOutput extends DescribeChapCreden *

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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { StorageGatewayClient, DescribeChapCredentialsCommand } from "@aws-sdk/client-storage-gateway"; // ES Modules import + * // const { StorageGatewayClient, DescribeChapCredentialsCommand } = require("@aws-sdk/client-storage-gateway"); // CommonJS import + * const client = new StorageGatewayClient(config); + * const command = new DescribeChapCredentialsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeChapCredentialsCommandInput} for command's `input` shape. + * @see {@link DescribeChapCredentialsCommandOutput} for command's `response` shape. + * @see {@link StorageGatewayClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeChapCredentialsCommand extends $Command< DescribeChapCredentialsCommandInput, diff --git a/clients/client-storage-gateway/commands/DescribeFileSystemAssociationsCommand.ts b/clients/client-storage-gateway/commands/DescribeFileSystemAssociationsCommand.ts index 8a5ade4357bc..4cb38782ccbb 100644 --- a/clients/client-storage-gateway/commands/DescribeFileSystemAssociationsCommand.ts +++ b/clients/client-storage-gateway/commands/DescribeFileSystemAssociationsCommand.ts @@ -25,6 +25,20 @@ export interface DescribeFileSystemAssociationsCommandOutput /** *

Gets the file system association information. This operation is only supported for * Amazon FSx file gateways.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { StorageGatewayClient, DescribeFileSystemAssociationsCommand } from "@aws-sdk/client-storage-gateway"; // ES Modules import + * // const { StorageGatewayClient, DescribeFileSystemAssociationsCommand } = require("@aws-sdk/client-storage-gateway"); // CommonJS import + * const client = new StorageGatewayClient(config); + * const command = new DescribeFileSystemAssociationsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeFileSystemAssociationsCommandInput} for command's `input` shape. + * @see {@link DescribeFileSystemAssociationsCommandOutput} for command's `response` shape. + * @see {@link StorageGatewayClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeFileSystemAssociationsCommand extends $Command< DescribeFileSystemAssociationsCommandInput, diff --git a/clients/client-storage-gateway/commands/DescribeGatewayInformationCommand.ts b/clients/client-storage-gateway/commands/DescribeGatewayInformationCommand.ts index 9d8e9461e1ba..0d4a62552aba 100644 --- a/clients/client-storage-gateway/commands/DescribeGatewayInformationCommand.ts +++ b/clients/client-storage-gateway/commands/DescribeGatewayInformationCommand.ts @@ -24,6 +24,20 @@ export interface DescribeGatewayInformationCommandOutput extends DescribeGateway *

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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { StorageGatewayClient, DescribeGatewayInformationCommand } from "@aws-sdk/client-storage-gateway"; // ES Modules import + * // const { StorageGatewayClient, DescribeGatewayInformationCommand } = require("@aws-sdk/client-storage-gateway"); // CommonJS import + * const client = new StorageGatewayClient(config); + * const command = new DescribeGatewayInformationCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeGatewayInformationCommandInput} for command's `input` shape. + * @see {@link DescribeGatewayInformationCommandOutput} for command's `response` shape. + * @see {@link StorageGatewayClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeGatewayInformationCommand extends $Command< DescribeGatewayInformationCommandInput, diff --git a/clients/client-storage-gateway/commands/DescribeMaintenanceStartTimeCommand.ts b/clients/client-storage-gateway/commands/DescribeMaintenanceStartTimeCommand.ts index 75a01552ca87..098cdfd27c17 100644 --- a/clients/client-storage-gateway/commands/DescribeMaintenanceStartTimeCommand.ts +++ b/clients/client-storage-gateway/commands/DescribeMaintenanceStartTimeCommand.ts @@ -25,6 +25,20 @@ export interface DescribeMaintenanceStartTimeCommandOutput /** *

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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { StorageGatewayClient, DescribeMaintenanceStartTimeCommand } from "@aws-sdk/client-storage-gateway"; // ES Modules import + * // const { StorageGatewayClient, DescribeMaintenanceStartTimeCommand } = require("@aws-sdk/client-storage-gateway"); // CommonJS import + * const client = new StorageGatewayClient(config); + * const command = new DescribeMaintenanceStartTimeCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeMaintenanceStartTimeCommandInput} for command's `input` shape. + * @see {@link DescribeMaintenanceStartTimeCommandOutput} for command's `response` shape. + * @see {@link StorageGatewayClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeMaintenanceStartTimeCommand extends $Command< DescribeMaintenanceStartTimeCommandInput, diff --git a/clients/client-storage-gateway/commands/DescribeNFSFileSharesCommand.ts b/clients/client-storage-gateway/commands/DescribeNFSFileSharesCommand.ts index d9f103b18d39..d23eac34c982 100644 --- a/clients/client-storage-gateway/commands/DescribeNFSFileSharesCommand.ts +++ b/clients/client-storage-gateway/commands/DescribeNFSFileSharesCommand.ts @@ -23,6 +23,20 @@ export interface DescribeNFSFileSharesCommandOutput extends DescribeNFSFileShare /** *

Gets a description for one or more Network File System (NFS) file shares from a file * gateway. This operation is only supported for file gateways.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { StorageGatewayClient, DescribeNFSFileSharesCommand } from "@aws-sdk/client-storage-gateway"; // ES Modules import + * // const { StorageGatewayClient, DescribeNFSFileSharesCommand } = require("@aws-sdk/client-storage-gateway"); // CommonJS import + * const client = new StorageGatewayClient(config); + * const command = new DescribeNFSFileSharesCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeNFSFileSharesCommandInput} for command's `input` shape. + * @see {@link DescribeNFSFileSharesCommandOutput} for command's `response` shape. + * @see {@link StorageGatewayClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeNFSFileSharesCommand extends $Command< DescribeNFSFileSharesCommandInput, diff --git a/clients/client-storage-gateway/commands/DescribeSMBFileSharesCommand.ts b/clients/client-storage-gateway/commands/DescribeSMBFileSharesCommand.ts index 8be7fdeabc37..53c651f78578 100644 --- a/clients/client-storage-gateway/commands/DescribeSMBFileSharesCommand.ts +++ b/clients/client-storage-gateway/commands/DescribeSMBFileSharesCommand.ts @@ -23,6 +23,20 @@ export interface DescribeSMBFileSharesCommandOutput extends DescribeSMBFileShare /** *

Gets a description for one or more Server Message Block (SMB) file shares from a file * gateway. This operation is only supported for file gateways.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { StorageGatewayClient, DescribeSMBFileSharesCommand } from "@aws-sdk/client-storage-gateway"; // ES Modules import + * // const { StorageGatewayClient, DescribeSMBFileSharesCommand } = require("@aws-sdk/client-storage-gateway"); // CommonJS import + * const client = new StorageGatewayClient(config); + * const command = new DescribeSMBFileSharesCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeSMBFileSharesCommandInput} for command's `input` shape. + * @see {@link DescribeSMBFileSharesCommandOutput} for command's `response` shape. + * @see {@link StorageGatewayClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeSMBFileSharesCommand extends $Command< DescribeSMBFileSharesCommandInput, diff --git a/clients/client-storage-gateway/commands/DescribeSMBSettingsCommand.ts b/clients/client-storage-gateway/commands/DescribeSMBSettingsCommand.ts index 4c001173eadc..e39c3c962fd4 100644 --- a/clients/client-storage-gateway/commands/DescribeSMBSettingsCommand.ts +++ b/clients/client-storage-gateway/commands/DescribeSMBSettingsCommand.ts @@ -23,6 +23,20 @@ export interface DescribeSMBSettingsCommandOutput extends DescribeSMBSettingsOut /** *

Gets a description of a Server Message Block (SMB) file share settings from a file * gateway. This operation is only supported for file gateways.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { StorageGatewayClient, DescribeSMBSettingsCommand } from "@aws-sdk/client-storage-gateway"; // ES Modules import + * // const { StorageGatewayClient, DescribeSMBSettingsCommand } = require("@aws-sdk/client-storage-gateway"); // CommonJS import + * const client = new StorageGatewayClient(config); + * const command = new DescribeSMBSettingsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeSMBSettingsCommandInput} for command's `input` shape. + * @see {@link DescribeSMBSettingsCommandOutput} for command's `response` shape. + * @see {@link StorageGatewayClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeSMBSettingsCommand extends $Command< DescribeSMBSettingsCommandInput, diff --git a/clients/client-storage-gateway/commands/DescribeSnapshotScheduleCommand.ts b/clients/client-storage-gateway/commands/DescribeSnapshotScheduleCommand.ts index a4b63696f6b4..ce4162e4ebe9 100644 --- a/clients/client-storage-gateway/commands/DescribeSnapshotScheduleCommand.ts +++ b/clients/client-storage-gateway/commands/DescribeSnapshotScheduleCommand.ts @@ -25,6 +25,20 @@ export interface DescribeSnapshotScheduleCommandOutput extends DescribeSnapshotS * 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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { StorageGatewayClient, DescribeSnapshotScheduleCommand } from "@aws-sdk/client-storage-gateway"; // ES Modules import + * // const { StorageGatewayClient, DescribeSnapshotScheduleCommand } = require("@aws-sdk/client-storage-gateway"); // CommonJS import + * const client = new StorageGatewayClient(config); + * const command = new DescribeSnapshotScheduleCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeSnapshotScheduleCommandInput} for command's `input` shape. + * @see {@link DescribeSnapshotScheduleCommandOutput} for command's `response` shape. + * @see {@link StorageGatewayClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeSnapshotScheduleCommand extends $Command< DescribeSnapshotScheduleCommandInput, diff --git a/clients/client-storage-gateway/commands/DescribeStorediSCSIVolumesCommand.ts b/clients/client-storage-gateway/commands/DescribeStorediSCSIVolumesCommand.ts index 1c3d65dd138a..43cd7a98f411 100644 --- a/clients/client-storage-gateway/commands/DescribeStorediSCSIVolumesCommand.ts +++ b/clients/client-storage-gateway/commands/DescribeStorediSCSIVolumesCommand.ts @@ -25,6 +25,20 @@ export interface DescribeStorediSCSIVolumesCommandOutput extends DescribeStoredi * gateway volumes in the request must be from one gateway. In the response, AWS Storage * Gateway returns volume information sorted by volume ARNs. This operation is only supported * in stored volume gateway type.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { StorageGatewayClient, DescribeStorediSCSIVolumesCommand } from "@aws-sdk/client-storage-gateway"; // ES Modules import + * // const { StorageGatewayClient, DescribeStorediSCSIVolumesCommand } = require("@aws-sdk/client-storage-gateway"); // CommonJS import + * const client = new StorageGatewayClient(config); + * const command = new DescribeStorediSCSIVolumesCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeStorediSCSIVolumesCommandInput} for command's `input` shape. + * @see {@link DescribeStorediSCSIVolumesCommandOutput} for command's `response` shape. + * @see {@link StorageGatewayClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeStorediSCSIVolumesCommand extends $Command< DescribeStorediSCSIVolumesCommandInput, diff --git a/clients/client-storage-gateway/commands/DescribeTapeArchivesCommand.ts b/clients/client-storage-gateway/commands/DescribeTapeArchivesCommand.ts index b3a0aea5cb17..07dd832c45ba 100644 --- a/clients/client-storage-gateway/commands/DescribeTapeArchivesCommand.ts +++ b/clients/client-storage-gateway/commands/DescribeTapeArchivesCommand.ts @@ -26,6 +26,20 @@ export interface DescribeTapeArchivesCommandOutput extends DescribeTapeArchivesO * *

If a specific TapeARN is not specified, AWS Storage Gateway returns a * description of all virtual tapes found in the VTS associated with your account.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { StorageGatewayClient, DescribeTapeArchivesCommand } from "@aws-sdk/client-storage-gateway"; // ES Modules import + * // const { StorageGatewayClient, DescribeTapeArchivesCommand } = require("@aws-sdk/client-storage-gateway"); // CommonJS import + * const client = new StorageGatewayClient(config); + * const command = new DescribeTapeArchivesCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeTapeArchivesCommandInput} for command's `input` shape. + * @see {@link DescribeTapeArchivesCommandOutput} for command's `response` shape. + * @see {@link StorageGatewayClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeTapeArchivesCommand extends $Command< DescribeTapeArchivesCommandInput, diff --git a/clients/client-storage-gateway/commands/DescribeTapeRecoveryPointsCommand.ts b/clients/client-storage-gateway/commands/DescribeTapeRecoveryPointsCommand.ts index 877c00564b2a..a556bd504e62 100644 --- a/clients/client-storage-gateway/commands/DescribeTapeRecoveryPointsCommand.ts +++ b/clients/client-storage-gateway/commands/DescribeTapeRecoveryPointsCommand.ts @@ -28,6 +28,20 @@ export interface DescribeTapeRecoveryPointsCommandOutput extends DescribeTapeRec * 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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { StorageGatewayClient, DescribeTapeRecoveryPointsCommand } from "@aws-sdk/client-storage-gateway"; // ES Modules import + * // const { StorageGatewayClient, DescribeTapeRecoveryPointsCommand } = require("@aws-sdk/client-storage-gateway"); // CommonJS import + * const client = new StorageGatewayClient(config); + * const command = new DescribeTapeRecoveryPointsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeTapeRecoveryPointsCommandInput} for command's `input` shape. + * @see {@link DescribeTapeRecoveryPointsCommandOutput} for command's `response` shape. + * @see {@link StorageGatewayClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeTapeRecoveryPointsCommand extends $Command< DescribeTapeRecoveryPointsCommandInput, diff --git a/clients/client-storage-gateway/commands/DescribeTapesCommand.ts b/clients/client-storage-gateway/commands/DescribeTapesCommand.ts index d49424fda54f..cce733d840f3 100644 --- a/clients/client-storage-gateway/commands/DescribeTapesCommand.ts +++ b/clients/client-storage-gateway/commands/DescribeTapesCommand.ts @@ -25,6 +25,20 @@ export interface DescribeTapesCommandOutput extends DescribeTapesOutput, __Metad * 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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { StorageGatewayClient, DescribeTapesCommand } from "@aws-sdk/client-storage-gateway"; // ES Modules import + * // const { StorageGatewayClient, DescribeTapesCommand } = require("@aws-sdk/client-storage-gateway"); // CommonJS import + * const client = new StorageGatewayClient(config); + * const command = new DescribeTapesCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeTapesCommandInput} for command's `input` shape. + * @see {@link DescribeTapesCommandOutput} for command's `response` shape. + * @see {@link StorageGatewayClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeTapesCommand extends $Command< DescribeTapesCommandInput, diff --git a/clients/client-storage-gateway/commands/DescribeUploadBufferCommand.ts b/clients/client-storage-gateway/commands/DescribeUploadBufferCommand.ts index c6702610d873..55039f504fa3 100644 --- a/clients/client-storage-gateway/commands/DescribeUploadBufferCommand.ts +++ b/clients/client-storage-gateway/commands/DescribeUploadBufferCommand.ts @@ -26,6 +26,20 @@ export interface DescribeUploadBufferCommandOutput extends DescribeUploadBufferO * *

The response includes disk IDs that are configured as upload buffer space, and it * includes the amount of upload buffer space allocated and used.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { StorageGatewayClient, DescribeUploadBufferCommand } from "@aws-sdk/client-storage-gateway"; // ES Modules import + * // const { StorageGatewayClient, DescribeUploadBufferCommand } = require("@aws-sdk/client-storage-gateway"); // CommonJS import + * const client = new StorageGatewayClient(config); + * const command = new DescribeUploadBufferCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeUploadBufferCommandInput} for command's `input` shape. + * @see {@link DescribeUploadBufferCommandOutput} for command's `response` shape. + * @see {@link StorageGatewayClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeUploadBufferCommand extends $Command< DescribeUploadBufferCommandInput, diff --git a/clients/client-storage-gateway/commands/DescribeVTLDevicesCommand.ts b/clients/client-storage-gateway/commands/DescribeVTLDevicesCommand.ts index dc2b28707e60..6000bf1261ec 100644 --- a/clients/client-storage-gateway/commands/DescribeVTLDevicesCommand.ts +++ b/clients/client-storage-gateway/commands/DescribeVTLDevicesCommand.ts @@ -25,6 +25,20 @@ export interface DescribeVTLDevicesCommandOutput extends DescribeVTLDevicesOutpu * gateway. In the response, AWS Storage Gateway returns VTL device information.

* *

This operation is only supported in the tape gateway type.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { StorageGatewayClient, DescribeVTLDevicesCommand } from "@aws-sdk/client-storage-gateway"; // ES Modules import + * // const { StorageGatewayClient, DescribeVTLDevicesCommand } = require("@aws-sdk/client-storage-gateway"); // CommonJS import + * const client = new StorageGatewayClient(config); + * const command = new DescribeVTLDevicesCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeVTLDevicesCommandInput} for command's `input` shape. + * @see {@link DescribeVTLDevicesCommandOutput} for command's `response` shape. + * @see {@link StorageGatewayClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeVTLDevicesCommand extends $Command< DescribeVTLDevicesCommandInput, diff --git a/clients/client-storage-gateway/commands/DescribeWorkingStorageCommand.ts b/clients/client-storage-gateway/commands/DescribeWorkingStorageCommand.ts index 9afaf31d2784..253176605a22 100644 --- a/clients/client-storage-gateway/commands/DescribeWorkingStorageCommand.ts +++ b/clients/client-storage-gateway/commands/DescribeWorkingStorageCommand.ts @@ -32,6 +32,20 @@ export interface DescribeWorkingStorageCommandOutput extends DescribeWorkingStor * *

The response includes disk IDs that are configured as working storage, and it includes * the amount of working storage allocated and used.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { StorageGatewayClient, DescribeWorkingStorageCommand } from "@aws-sdk/client-storage-gateway"; // ES Modules import + * // const { StorageGatewayClient, DescribeWorkingStorageCommand } = require("@aws-sdk/client-storage-gateway"); // CommonJS import + * const client = new StorageGatewayClient(config); + * const command = new DescribeWorkingStorageCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeWorkingStorageCommandInput} for command's `input` shape. + * @see {@link DescribeWorkingStorageCommandOutput} for command's `response` shape. + * @see {@link StorageGatewayClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeWorkingStorageCommand extends $Command< DescribeWorkingStorageCommandInput, diff --git a/clients/client-storage-gateway/commands/DetachVolumeCommand.ts b/clients/client-storage-gateway/commands/DetachVolumeCommand.ts index 8a51dac5d415..a1f798c15c06 100644 --- a/clients/client-storage-gateway/commands/DetachVolumeCommand.ts +++ b/clients/client-storage-gateway/commands/DetachVolumeCommand.ts @@ -26,6 +26,20 @@ export interface DetachVolumeCommandOutput extends DetachVolumeOutput, __Metadat * 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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { StorageGatewayClient, DetachVolumeCommand } from "@aws-sdk/client-storage-gateway"; // ES Modules import + * // const { StorageGatewayClient, DetachVolumeCommand } = require("@aws-sdk/client-storage-gateway"); // CommonJS import + * const client = new StorageGatewayClient(config); + * const command = new DetachVolumeCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DetachVolumeCommandInput} for command's `input` shape. + * @see {@link DetachVolumeCommandOutput} for command's `response` shape. + * @see {@link StorageGatewayClientResolvedConfig | config} for command's `input` shape. + * */ export class DetachVolumeCommand extends $Command< DetachVolumeCommandInput, diff --git a/clients/client-storage-gateway/commands/DisableGatewayCommand.ts b/clients/client-storage-gateway/commands/DisableGatewayCommand.ts index 46cb5aac7953..1001068b2c9f 100644 --- a/clients/client-storage-gateway/commands/DisableGatewayCommand.ts +++ b/clients/client-storage-gateway/commands/DisableGatewayCommand.ts @@ -30,6 +30,20 @@ export interface DisableGatewayCommandOutput extends DisableGatewayOutput, __Met * *

After a gateway is disabled, it cannot be enabled.

* + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { StorageGatewayClient, DisableGatewayCommand } from "@aws-sdk/client-storage-gateway"; // ES Modules import + * // const { StorageGatewayClient, DisableGatewayCommand } = require("@aws-sdk/client-storage-gateway"); // CommonJS import + * const client = new StorageGatewayClient(config); + * const command = new DisableGatewayCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DisableGatewayCommandInput} for command's `input` shape. + * @see {@link DisableGatewayCommandOutput} for command's `response` shape. + * @see {@link StorageGatewayClientResolvedConfig | config} for command's `input` shape. + * */ export class DisableGatewayCommand extends $Command< DisableGatewayCommandInput, diff --git a/clients/client-storage-gateway/commands/DisassociateFileSystemCommand.ts b/clients/client-storage-gateway/commands/DisassociateFileSystemCommand.ts index 3f559a9540d4..7bdde2c1023d 100644 --- a/clients/client-storage-gateway/commands/DisassociateFileSystemCommand.ts +++ b/clients/client-storage-gateway/commands/DisassociateFileSystemCommand.ts @@ -24,6 +24,20 @@ export interface DisassociateFileSystemCommandOutput extends DisassociateFileSys *

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 Amazon FSx file gateway type.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { StorageGatewayClient, DisassociateFileSystemCommand } from "@aws-sdk/client-storage-gateway"; // ES Modules import + * // const { StorageGatewayClient, DisassociateFileSystemCommand } = require("@aws-sdk/client-storage-gateway"); // CommonJS import + * const client = new StorageGatewayClient(config); + * const command = new DisassociateFileSystemCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DisassociateFileSystemCommandInput} for command's `input` shape. + * @see {@link DisassociateFileSystemCommandOutput} for command's `response` shape. + * @see {@link StorageGatewayClientResolvedConfig | config} for command's `input` shape. + * */ export class DisassociateFileSystemCommand extends $Command< DisassociateFileSystemCommandInput, diff --git a/clients/client-storage-gateway/commands/JoinDomainCommand.ts b/clients/client-storage-gateway/commands/JoinDomainCommand.ts index e9853a49854d..84bb2af012fb 100644 --- a/clients/client-storage-gateway/commands/JoinDomainCommand.ts +++ b/clients/client-storage-gateway/commands/JoinDomainCommand.ts @@ -23,6 +23,20 @@ export interface JoinDomainCommandOutput extends JoinDomainOutput, __MetadataBea /** *

Adds a file gateway to an Active Directory domain. This operation is only supported for * file gateways that support the SMB file protocol.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { StorageGatewayClient, JoinDomainCommand } from "@aws-sdk/client-storage-gateway"; // ES Modules import + * // const { StorageGatewayClient, JoinDomainCommand } = require("@aws-sdk/client-storage-gateway"); // CommonJS import + * const client = new StorageGatewayClient(config); + * const command = new JoinDomainCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link JoinDomainCommandInput} for command's `input` shape. + * @see {@link JoinDomainCommandOutput} for command's `response` shape. + * @see {@link StorageGatewayClientResolvedConfig | config} for command's `input` shape. + * */ export class JoinDomainCommand extends $Command< JoinDomainCommandInput, diff --git a/clients/client-storage-gateway/commands/ListAutomaticTapeCreationPoliciesCommand.ts b/clients/client-storage-gateway/commands/ListAutomaticTapeCreationPoliciesCommand.ts index 8a068be499b9..573519af677f 100644 --- a/clients/client-storage-gateway/commands/ListAutomaticTapeCreationPoliciesCommand.ts +++ b/clients/client-storage-gateway/commands/ListAutomaticTapeCreationPoliciesCommand.ts @@ -27,6 +27,20 @@ export interface ListAutomaticTapeCreationPoliciesCommandOutput * creation policies for the gateway, it returns an empty list.

* *

This operation is only supported for tape gateways.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { StorageGatewayClient, ListAutomaticTapeCreationPoliciesCommand } from "@aws-sdk/client-storage-gateway"; // ES Modules import + * // const { StorageGatewayClient, ListAutomaticTapeCreationPoliciesCommand } = require("@aws-sdk/client-storage-gateway"); // CommonJS import + * const client = new StorageGatewayClient(config); + * const command = new ListAutomaticTapeCreationPoliciesCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListAutomaticTapeCreationPoliciesCommandInput} for command's `input` shape. + * @see {@link ListAutomaticTapeCreationPoliciesCommandOutput} for command's `response` shape. + * @see {@link StorageGatewayClientResolvedConfig | config} for command's `input` shape. + * */ export class ListAutomaticTapeCreationPoliciesCommand extends $Command< ListAutomaticTapeCreationPoliciesCommandInput, diff --git a/clients/client-storage-gateway/commands/ListFileSharesCommand.ts b/clients/client-storage-gateway/commands/ListFileSharesCommand.ts index edd4cd7c5e0c..89da9ffc0a7c 100644 --- a/clients/client-storage-gateway/commands/ListFileSharesCommand.ts +++ b/clients/client-storage-gateway/commands/ListFileSharesCommand.ts @@ -24,6 +24,20 @@ export interface ListFileSharesCommandOutput extends ListFileSharesOutput, __Met *

Gets a list of the file shares for a specific file gateway, or the list of file shares * that belong to the calling user account. This operation is only supported for file * gateways.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { StorageGatewayClient, ListFileSharesCommand } from "@aws-sdk/client-storage-gateway"; // ES Modules import + * // const { StorageGatewayClient, ListFileSharesCommand } = require("@aws-sdk/client-storage-gateway"); // CommonJS import + * const client = new StorageGatewayClient(config); + * const command = new ListFileSharesCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListFileSharesCommandInput} for command's `input` shape. + * @see {@link ListFileSharesCommandOutput} for command's `response` shape. + * @see {@link StorageGatewayClientResolvedConfig | config} for command's `input` shape. + * */ export class ListFileSharesCommand extends $Command< ListFileSharesCommandInput, diff --git a/clients/client-storage-gateway/commands/ListFileSystemAssociationsCommand.ts b/clients/client-storage-gateway/commands/ListFileSystemAssociationsCommand.ts index 24effb8dc9f2..c2b35e8e8740 100644 --- a/clients/client-storage-gateway/commands/ListFileSystemAssociationsCommand.ts +++ b/clients/client-storage-gateway/commands/ListFileSystemAssociationsCommand.ts @@ -24,6 +24,20 @@ export interface ListFileSystemAssociationsCommandOutput extends ListFileSystemA *

Gets a list of FileSystemAssociationSummary objects. Each object contains a * summary of a file system association. This operation is only supported for Amazon FSx file * gateways.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { StorageGatewayClient, ListFileSystemAssociationsCommand } from "@aws-sdk/client-storage-gateway"; // ES Modules import + * // const { StorageGatewayClient, ListFileSystemAssociationsCommand } = require("@aws-sdk/client-storage-gateway"); // CommonJS import + * const client = new StorageGatewayClient(config); + * const command = new ListFileSystemAssociationsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListFileSystemAssociationsCommandInput} for command's `input` shape. + * @see {@link ListFileSystemAssociationsCommandOutput} for command's `response` shape. + * @see {@link StorageGatewayClientResolvedConfig | config} for command's `input` shape. + * */ export class ListFileSystemAssociationsCommand extends $Command< ListFileSystemAssociationsCommandInput, diff --git a/clients/client-storage-gateway/commands/ListGatewaysCommand.ts b/clients/client-storage-gateway/commands/ListGatewaysCommand.ts index 67c7b0106f29..816790a366d7 100644 --- a/clients/client-storage-gateway/commands/ListGatewaysCommand.ts +++ b/clients/client-storage-gateway/commands/ListGatewaysCommand.ts @@ -31,6 +31,20 @@ export interface ListGatewaysCommandOutput extends ListGatewaysOutput, __Metadat *

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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { StorageGatewayClient, ListGatewaysCommand } from "@aws-sdk/client-storage-gateway"; // ES Modules import + * // const { StorageGatewayClient, ListGatewaysCommand } = require("@aws-sdk/client-storage-gateway"); // CommonJS import + * const client = new StorageGatewayClient(config); + * const command = new ListGatewaysCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListGatewaysCommandInput} for command's `input` shape. + * @see {@link ListGatewaysCommandOutput} for command's `response` shape. + * @see {@link StorageGatewayClientResolvedConfig | config} for command's `input` shape. + * */ export class ListGatewaysCommand extends $Command< ListGatewaysCommandInput, diff --git a/clients/client-storage-gateway/commands/ListLocalDisksCommand.ts b/clients/client-storage-gateway/commands/ListLocalDisksCommand.ts index 57c7117f520e..095423cf8223 100644 --- a/clients/client-storage-gateway/commands/ListLocalDisksCommand.ts +++ b/clients/client-storage-gateway/commands/ListLocalDisksCommand.ts @@ -30,6 +30,20 @@ export interface ListLocalDisksCommandOutput extends ListLocalDisksOutput, __Met * 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).

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { StorageGatewayClient, ListLocalDisksCommand } from "@aws-sdk/client-storage-gateway"; // ES Modules import + * // const { StorageGatewayClient, ListLocalDisksCommand } = require("@aws-sdk/client-storage-gateway"); // CommonJS import + * const client = new StorageGatewayClient(config); + * const command = new ListLocalDisksCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListLocalDisksCommandInput} for command's `input` shape. + * @see {@link ListLocalDisksCommandOutput} for command's `response` shape. + * @see {@link StorageGatewayClientResolvedConfig | config} for command's `input` shape. + * */ export class ListLocalDisksCommand extends $Command< ListLocalDisksCommandInput, diff --git a/clients/client-storage-gateway/commands/ListTagsForResourceCommand.ts b/clients/client-storage-gateway/commands/ListTagsForResourceCommand.ts index 67f6082a94c3..af6834059ab4 100644 --- a/clients/client-storage-gateway/commands/ListTagsForResourceCommand.ts +++ b/clients/client-storage-gateway/commands/ListTagsForResourceCommand.ts @@ -23,6 +23,20 @@ export interface ListTagsForResourceCommandOutput extends ListTagsForResourceOut /** *

Lists the tags that have been added to the specified resource. This operation is * supported in storage gateways of all types.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { StorageGatewayClient, ListTagsForResourceCommand } from "@aws-sdk/client-storage-gateway"; // ES Modules import + * // const { StorageGatewayClient, ListTagsForResourceCommand } = require("@aws-sdk/client-storage-gateway"); // CommonJS import + * const client = new StorageGatewayClient(config); + * const command = new ListTagsForResourceCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListTagsForResourceCommandInput} for command's `input` shape. + * @see {@link ListTagsForResourceCommandOutput} for command's `response` shape. + * @see {@link StorageGatewayClientResolvedConfig | config} for command's `input` shape. + * */ export class ListTagsForResourceCommand extends $Command< ListTagsForResourceCommandInput, diff --git a/clients/client-storage-gateway/commands/ListTapePoolsCommand.ts b/clients/client-storage-gateway/commands/ListTapePoolsCommand.ts index 575e43eb175b..820a4c4aad6c 100644 --- a/clients/client-storage-gateway/commands/ListTapePoolsCommand.ts +++ b/clients/client-storage-gateway/commands/ListTapePoolsCommand.ts @@ -30,6 +30,20 @@ export interface ListTapePoolsCommandOutput extends ListTapePoolsOutput, __Metad * 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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { StorageGatewayClient, ListTapePoolsCommand } from "@aws-sdk/client-storage-gateway"; // ES Modules import + * // const { StorageGatewayClient, ListTapePoolsCommand } = require("@aws-sdk/client-storage-gateway"); // CommonJS import + * const client = new StorageGatewayClient(config); + * const command = new ListTapePoolsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListTapePoolsCommandInput} for command's `input` shape. + * @see {@link ListTapePoolsCommandOutput} for command's `response` shape. + * @see {@link StorageGatewayClientResolvedConfig | config} for command's `input` shape. + * */ export class ListTapePoolsCommand extends $Command< ListTapePoolsCommandInput, diff --git a/clients/client-storage-gateway/commands/ListTapesCommand.ts b/clients/client-storage-gateway/commands/ListTapesCommand.ts index a9a5b93d8e09..af7f9a1b6efa 100644 --- a/clients/client-storage-gateway/commands/ListTapesCommand.ts +++ b/clients/client-storage-gateway/commands/ListTapesCommand.ts @@ -29,6 +29,20 @@ export interface ListTapesCommandOutput extends ListTapesOutput, __MetadataBeare * 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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { StorageGatewayClient, ListTapesCommand } from "@aws-sdk/client-storage-gateway"; // ES Modules import + * // const { StorageGatewayClient, ListTapesCommand } = require("@aws-sdk/client-storage-gateway"); // CommonJS import + * const client = new StorageGatewayClient(config); + * const command = new ListTapesCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListTapesCommandInput} for command's `input` shape. + * @see {@link ListTapesCommandOutput} for command's `response` shape. + * @see {@link StorageGatewayClientResolvedConfig | config} for command's `input` shape. + * */ export class ListTapesCommand extends $Command< ListTapesCommandInput, diff --git a/clients/client-storage-gateway/commands/ListVolumeInitiatorsCommand.ts b/clients/client-storage-gateway/commands/ListVolumeInitiatorsCommand.ts index 7b4291b4ee31..892e18323439 100644 --- a/clients/client-storage-gateway/commands/ListVolumeInitiatorsCommand.ts +++ b/clients/client-storage-gateway/commands/ListVolumeInitiatorsCommand.ts @@ -24,6 +24,20 @@ export interface ListVolumeInitiatorsCommandOutput extends ListVolumeInitiatorsO *

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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { StorageGatewayClient, ListVolumeInitiatorsCommand } from "@aws-sdk/client-storage-gateway"; // ES Modules import + * // const { StorageGatewayClient, ListVolumeInitiatorsCommand } = require("@aws-sdk/client-storage-gateway"); // CommonJS import + * const client = new StorageGatewayClient(config); + * const command = new ListVolumeInitiatorsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListVolumeInitiatorsCommandInput} for command's `input` shape. + * @see {@link ListVolumeInitiatorsCommandOutput} for command's `response` shape. + * @see {@link StorageGatewayClientResolvedConfig | config} for command's `input` shape. + * */ export class ListVolumeInitiatorsCommand extends $Command< ListVolumeInitiatorsCommandInput, diff --git a/clients/client-storage-gateway/commands/ListVolumeRecoveryPointsCommand.ts b/clients/client-storage-gateway/commands/ListVolumeRecoveryPointsCommand.ts index d74f3bb59590..592512f25441 100644 --- a/clients/client-storage-gateway/commands/ListVolumeRecoveryPointsCommand.ts +++ b/clients/client-storage-gateway/commands/ListVolumeRecoveryPointsCommand.ts @@ -28,6 +28,20 @@ export interface ListVolumeRecoveryPointsCommandOutput extends ListVolumeRecover * 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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { StorageGatewayClient, ListVolumeRecoveryPointsCommand } from "@aws-sdk/client-storage-gateway"; // ES Modules import + * // const { StorageGatewayClient, ListVolumeRecoveryPointsCommand } = require("@aws-sdk/client-storage-gateway"); // CommonJS import + * const client = new StorageGatewayClient(config); + * const command = new ListVolumeRecoveryPointsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListVolumeRecoveryPointsCommandInput} for command's `input` shape. + * @see {@link ListVolumeRecoveryPointsCommandOutput} for command's `response` shape. + * @see {@link StorageGatewayClientResolvedConfig | config} for command's `input` shape. + * */ export class ListVolumeRecoveryPointsCommand extends $Command< ListVolumeRecoveryPointsCommandInput, diff --git a/clients/client-storage-gateway/commands/ListVolumesCommand.ts b/clients/client-storage-gateway/commands/ListVolumesCommand.ts index d17a1794ace1..f89037611302 100644 --- a/clients/client-storage-gateway/commands/ListVolumesCommand.ts +++ b/clients/client-storage-gateway/commands/ListVolumesCommand.ts @@ -31,6 +31,20 @@ export interface ListVolumesCommandOutput extends ListVolumesOutput, __MetadataB * 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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { StorageGatewayClient, ListVolumesCommand } from "@aws-sdk/client-storage-gateway"; // ES Modules import + * // const { StorageGatewayClient, ListVolumesCommand } = require("@aws-sdk/client-storage-gateway"); // CommonJS import + * const client = new StorageGatewayClient(config); + * const command = new ListVolumesCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListVolumesCommandInput} for command's `input` shape. + * @see {@link ListVolumesCommandOutput} for command's `response` shape. + * @see {@link StorageGatewayClientResolvedConfig | config} for command's `input` shape. + * */ export class ListVolumesCommand extends $Command< ListVolumesCommandInput, diff --git a/clients/client-storage-gateway/commands/NotifyWhenUploadedCommand.ts b/clients/client-storage-gateway/commands/NotifyWhenUploadedCommand.ts index cc844a1c7613..f249e90bb041 100644 --- a/clients/client-storage-gateway/commands/NotifyWhenUploadedCommand.ts +++ b/clients/client-storage-gateway/commands/NotifyWhenUploadedCommand.ts @@ -36,6 +36,20 @@ export interface NotifyWhenUploadedCommandOutput extends NotifyWhenUploadedOutpu * *

For more information, see Getting file upload notification in the AWS Storage Gateway User * Guide.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { StorageGatewayClient, NotifyWhenUploadedCommand } from "@aws-sdk/client-storage-gateway"; // ES Modules import + * // const { StorageGatewayClient, NotifyWhenUploadedCommand } = require("@aws-sdk/client-storage-gateway"); // CommonJS import + * const client = new StorageGatewayClient(config); + * const command = new NotifyWhenUploadedCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link NotifyWhenUploadedCommandInput} for command's `input` shape. + * @see {@link NotifyWhenUploadedCommandOutput} for command's `response` shape. + * @see {@link StorageGatewayClientResolvedConfig | config} for command's `input` shape. + * */ export class NotifyWhenUploadedCommand extends $Command< NotifyWhenUploadedCommandInput, diff --git a/clients/client-storage-gateway/commands/RefreshCacheCommand.ts b/clients/client-storage-gateway/commands/RefreshCacheCommand.ts index 57aeb01ba065..5dcd8c00e5f0 100644 --- a/clients/client-storage-gateway/commands/RefreshCacheCommand.ts +++ b/clients/client-storage-gateway/commands/RefreshCacheCommand.ts @@ -51,6 +51,20 @@ export interface RefreshCacheCommandOutput extends RefreshCacheOutput, __Metadat * *

For more information, see Getting notified about file operations in the AWS Storage Gateway * User Guide.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { StorageGatewayClient, RefreshCacheCommand } from "@aws-sdk/client-storage-gateway"; // ES Modules import + * // const { StorageGatewayClient, RefreshCacheCommand } = require("@aws-sdk/client-storage-gateway"); // CommonJS import + * const client = new StorageGatewayClient(config); + * const command = new RefreshCacheCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link RefreshCacheCommandInput} for command's `input` shape. + * @see {@link RefreshCacheCommandOutput} for command's `response` shape. + * @see {@link StorageGatewayClientResolvedConfig | config} for command's `input` shape. + * */ export class RefreshCacheCommand extends $Command< RefreshCacheCommandInput, diff --git a/clients/client-storage-gateway/commands/RemoveTagsFromResourceCommand.ts b/clients/client-storage-gateway/commands/RemoveTagsFromResourceCommand.ts index 48ea4cedc661..8014ab3f498d 100644 --- a/clients/client-storage-gateway/commands/RemoveTagsFromResourceCommand.ts +++ b/clients/client-storage-gateway/commands/RemoveTagsFromResourceCommand.ts @@ -23,6 +23,20 @@ export interface RemoveTagsFromResourceCommandOutput extends RemoveTagsFromResou /** *

Removes one or more tags from the specified resource. This operation is supported in * storage gateways of all types.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { StorageGatewayClient, RemoveTagsFromResourceCommand } from "@aws-sdk/client-storage-gateway"; // ES Modules import + * // const { StorageGatewayClient, RemoveTagsFromResourceCommand } = require("@aws-sdk/client-storage-gateway"); // CommonJS import + * const client = new StorageGatewayClient(config); + * const command = new RemoveTagsFromResourceCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link RemoveTagsFromResourceCommandInput} for command's `input` shape. + * @see {@link RemoveTagsFromResourceCommandOutput} for command's `response` shape. + * @see {@link StorageGatewayClientResolvedConfig | config} for command's `input` shape. + * */ export class RemoveTagsFromResourceCommand extends $Command< RemoveTagsFromResourceCommandInput, diff --git a/clients/client-storage-gateway/commands/ResetCacheCommand.ts b/clients/client-storage-gateway/commands/ResetCacheCommand.ts index 90f149dc7602..afa5e93e3fa8 100644 --- a/clients/client-storage-gateway/commands/ResetCacheCommand.ts +++ b/clients/client-storage-gateway/commands/ResetCacheCommand.ts @@ -34,6 +34,20 @@ export interface ResetCacheCommandOutput extends ResetCacheOutput, __MetadataBea * configured cache disks left in the gateway, so you must configure at least one new cache * disk for your gateway to function properly.

* + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { StorageGatewayClient, ResetCacheCommand } from "@aws-sdk/client-storage-gateway"; // ES Modules import + * // const { StorageGatewayClient, ResetCacheCommand } = require("@aws-sdk/client-storage-gateway"); // CommonJS import + * const client = new StorageGatewayClient(config); + * const command = new ResetCacheCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ResetCacheCommandInput} for command's `input` shape. + * @see {@link ResetCacheCommandOutput} for command's `response` shape. + * @see {@link StorageGatewayClientResolvedConfig | config} for command's `input` shape. + * */ export class ResetCacheCommand extends $Command< ResetCacheCommandInput, diff --git a/clients/client-storage-gateway/commands/RetrieveTapeArchiveCommand.ts b/clients/client-storage-gateway/commands/RetrieveTapeArchiveCommand.ts index ba14981e70fa..fdd9004a11b9 100644 --- a/clients/client-storage-gateway/commands/RetrieveTapeArchiveCommand.ts +++ b/clients/client-storage-gateway/commands/RetrieveTapeArchiveCommand.ts @@ -29,6 +29,20 @@ export interface RetrieveTapeArchiveCommandOutput extends RetrieveTapeArchiveOut *

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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { StorageGatewayClient, RetrieveTapeArchiveCommand } from "@aws-sdk/client-storage-gateway"; // ES Modules import + * // const { StorageGatewayClient, RetrieveTapeArchiveCommand } = require("@aws-sdk/client-storage-gateway"); // CommonJS import + * const client = new StorageGatewayClient(config); + * const command = new RetrieveTapeArchiveCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link RetrieveTapeArchiveCommandInput} for command's `input` shape. + * @see {@link RetrieveTapeArchiveCommandOutput} for command's `response` shape. + * @see {@link StorageGatewayClientResolvedConfig | config} for command's `input` shape. + * */ export class RetrieveTapeArchiveCommand extends $Command< RetrieveTapeArchiveCommandInput, diff --git a/clients/client-storage-gateway/commands/RetrieveTapeRecoveryPointCommand.ts b/clients/client-storage-gateway/commands/RetrieveTapeRecoveryPointCommand.ts index a579f290ea4f..bcbda33b3c77 100644 --- a/clients/client-storage-gateway/commands/RetrieveTapeRecoveryPointCommand.ts +++ b/clients/client-storage-gateway/commands/RetrieveTapeRecoveryPointCommand.ts @@ -33,6 +33,20 @@ export interface RetrieveTapeRecoveryPointCommandOutput extends RetrieveTapeReco * read-only. The virtual tape can be retrieved to only a tape gateway. There is no charge * for retrieving recovery points.

* + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { StorageGatewayClient, RetrieveTapeRecoveryPointCommand } from "@aws-sdk/client-storage-gateway"; // ES Modules import + * // const { StorageGatewayClient, RetrieveTapeRecoveryPointCommand } = require("@aws-sdk/client-storage-gateway"); // CommonJS import + * const client = new StorageGatewayClient(config); + * const command = new RetrieveTapeRecoveryPointCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link RetrieveTapeRecoveryPointCommandInput} for command's `input` shape. + * @see {@link RetrieveTapeRecoveryPointCommandOutput} for command's `response` shape. + * @see {@link StorageGatewayClientResolvedConfig | config} for command's `input` shape. + * */ export class RetrieveTapeRecoveryPointCommand extends $Command< RetrieveTapeRecoveryPointCommandInput, diff --git a/clients/client-storage-gateway/commands/SetLocalConsolePasswordCommand.ts b/clients/client-storage-gateway/commands/SetLocalConsolePasswordCommand.ts index a1ce66b94604..5b2be4fb4df9 100644 --- a/clients/client-storage-gateway/commands/SetLocalConsolePasswordCommand.ts +++ b/clients/client-storage-gateway/commands/SetLocalConsolePasswordCommand.ts @@ -25,6 +25,20 @@ export interface SetLocalConsolePasswordCommandOutput extends SetLocalConsolePas * 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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { StorageGatewayClient, SetLocalConsolePasswordCommand } from "@aws-sdk/client-storage-gateway"; // ES Modules import + * // const { StorageGatewayClient, SetLocalConsolePasswordCommand } = require("@aws-sdk/client-storage-gateway"); // CommonJS import + * const client = new StorageGatewayClient(config); + * const command = new SetLocalConsolePasswordCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link SetLocalConsolePasswordCommandInput} for command's `input` shape. + * @see {@link SetLocalConsolePasswordCommandOutput} for command's `response` shape. + * @see {@link StorageGatewayClientResolvedConfig | config} for command's `input` shape. + * */ export class SetLocalConsolePasswordCommand extends $Command< SetLocalConsolePasswordCommandInput, diff --git a/clients/client-storage-gateway/commands/SetSMBGuestPasswordCommand.ts b/clients/client-storage-gateway/commands/SetSMBGuestPasswordCommand.ts index 211c20346053..71e5560956cd 100644 --- a/clients/client-storage-gateway/commands/SetSMBGuestPasswordCommand.ts +++ b/clients/client-storage-gateway/commands/SetSMBGuestPasswordCommand.ts @@ -24,6 +24,20 @@ export interface SetSMBGuestPasswordCommandOutput extends SetSMBGuestPasswordOut *

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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { StorageGatewayClient, SetSMBGuestPasswordCommand } from "@aws-sdk/client-storage-gateway"; // ES Modules import + * // const { StorageGatewayClient, SetSMBGuestPasswordCommand } = require("@aws-sdk/client-storage-gateway"); // CommonJS import + * const client = new StorageGatewayClient(config); + * const command = new SetSMBGuestPasswordCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link SetSMBGuestPasswordCommandInput} for command's `input` shape. + * @see {@link SetSMBGuestPasswordCommandOutput} for command's `response` shape. + * @see {@link StorageGatewayClientResolvedConfig | config} for command's `input` shape. + * */ export class SetSMBGuestPasswordCommand extends $Command< SetSMBGuestPasswordCommandInput, diff --git a/clients/client-storage-gateway/commands/ShutdownGatewayCommand.ts b/clients/client-storage-gateway/commands/ShutdownGatewayCommand.ts index 326d8bc62df3..93fc1313b76e 100644 --- a/clients/client-storage-gateway/commands/ShutdownGatewayCommand.ts +++ b/clients/client-storage-gateway/commands/ShutdownGatewayCommand.ts @@ -45,6 +45,20 @@ export interface ShutdownGatewayCommandOutput extends ShutdownGatewayOutput, __M * *

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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { StorageGatewayClient, ShutdownGatewayCommand } from "@aws-sdk/client-storage-gateway"; // ES Modules import + * // const { StorageGatewayClient, ShutdownGatewayCommand } = require("@aws-sdk/client-storage-gateway"); // CommonJS import + * const client = new StorageGatewayClient(config); + * const command = new ShutdownGatewayCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ShutdownGatewayCommandInput} for command's `input` shape. + * @see {@link ShutdownGatewayCommandOutput} for command's `response` shape. + * @see {@link StorageGatewayClientResolvedConfig | config} for command's `input` shape. + * */ export class ShutdownGatewayCommand extends $Command< ShutdownGatewayCommandInput, diff --git a/clients/client-storage-gateway/commands/StartAvailabilityMonitorTestCommand.ts b/clients/client-storage-gateway/commands/StartAvailabilityMonitorTestCommand.ts index 25a76544cd01..8a98f577e38a 100644 --- a/clients/client-storage-gateway/commands/StartAvailabilityMonitorTestCommand.ts +++ b/clients/client-storage-gateway/commands/StartAvailabilityMonitorTestCommand.ts @@ -31,6 +31,20 @@ export interface StartAvailabilityMonitorTestCommandOutput * *

Starting this test will cause your gateway to go offline for a brief period.

* + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { StorageGatewayClient, StartAvailabilityMonitorTestCommand } from "@aws-sdk/client-storage-gateway"; // ES Modules import + * // const { StorageGatewayClient, StartAvailabilityMonitorTestCommand } = require("@aws-sdk/client-storage-gateway"); // CommonJS import + * const client = new StorageGatewayClient(config); + * const command = new StartAvailabilityMonitorTestCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link StartAvailabilityMonitorTestCommandInput} for command's `input` shape. + * @see {@link StartAvailabilityMonitorTestCommandOutput} for command's `response` shape. + * @see {@link StorageGatewayClientResolvedConfig | config} for command's `input` shape. + * */ export class StartAvailabilityMonitorTestCommand extends $Command< StartAvailabilityMonitorTestCommandInput, diff --git a/clients/client-storage-gateway/commands/StartGatewayCommand.ts b/clients/client-storage-gateway/commands/StartGatewayCommand.ts index 7a69d577cc7f..eb432336a5e1 100644 --- a/clients/client-storage-gateway/commands/StartGatewayCommand.ts +++ b/clients/client-storage-gateway/commands/StartGatewayCommand.ts @@ -34,6 +34,20 @@ export interface StartGatewayCommandOutput extends StartGatewayOutput, __Metadat * *

To specify which gateway to start, use the Amazon Resource Name (ARN) of the gateway in * your request.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { StorageGatewayClient, StartGatewayCommand } from "@aws-sdk/client-storage-gateway"; // ES Modules import + * // const { StorageGatewayClient, StartGatewayCommand } = require("@aws-sdk/client-storage-gateway"); // CommonJS import + * const client = new StorageGatewayClient(config); + * const command = new StartGatewayCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link StartGatewayCommandInput} for command's `input` shape. + * @see {@link StartGatewayCommandOutput} for command's `response` shape. + * @see {@link StorageGatewayClientResolvedConfig | config} for command's `input` shape. + * */ export class StartGatewayCommand extends $Command< StartGatewayCommandInput, diff --git a/clients/client-storage-gateway/commands/UpdateAutomaticTapeCreationPolicyCommand.ts b/clients/client-storage-gateway/commands/UpdateAutomaticTapeCreationPolicyCommand.ts index 812636aaa530..38869e9e8a97 100644 --- a/clients/client-storage-gateway/commands/UpdateAutomaticTapeCreationPolicyCommand.ts +++ b/clients/client-storage-gateway/commands/UpdateAutomaticTapeCreationPolicyCommand.ts @@ -32,6 +32,20 @@ export interface UpdateAutomaticTapeCreationPolicyCommandOutput * *

A gateway can have only one automatic tape creation policy.

* + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { StorageGatewayClient, UpdateAutomaticTapeCreationPolicyCommand } from "@aws-sdk/client-storage-gateway"; // ES Modules import + * // const { StorageGatewayClient, UpdateAutomaticTapeCreationPolicyCommand } = require("@aws-sdk/client-storage-gateway"); // CommonJS import + * const client = new StorageGatewayClient(config); + * const command = new UpdateAutomaticTapeCreationPolicyCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link UpdateAutomaticTapeCreationPolicyCommandInput} for command's `input` shape. + * @see {@link UpdateAutomaticTapeCreationPolicyCommandOutput} for command's `response` shape. + * @see {@link StorageGatewayClientResolvedConfig | config} for command's `input` shape. + * */ export class UpdateAutomaticTapeCreationPolicyCommand extends $Command< UpdateAutomaticTapeCreationPolicyCommandInput, diff --git a/clients/client-storage-gateway/commands/UpdateBandwidthRateLimitCommand.ts b/clients/client-storage-gateway/commands/UpdateBandwidthRateLimitCommand.ts index 36eac382354b..f2bea749515f 100644 --- a/clients/client-storage-gateway/commands/UpdateBandwidthRateLimitCommand.ts +++ b/clients/client-storage-gateway/commands/UpdateBandwidthRateLimitCommand.ts @@ -32,6 +32,20 @@ export interface UpdateBandwidthRateLimitCommandOutput extends UpdateBandwidthRa * *

To specify which gateway to update, use the Amazon Resource Name (ARN) of the gateway in * your request.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { StorageGatewayClient, UpdateBandwidthRateLimitCommand } from "@aws-sdk/client-storage-gateway"; // ES Modules import + * // const { StorageGatewayClient, UpdateBandwidthRateLimitCommand } = require("@aws-sdk/client-storage-gateway"); // CommonJS import + * const client = new StorageGatewayClient(config); + * const command = new UpdateBandwidthRateLimitCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link UpdateBandwidthRateLimitCommandInput} for command's `input` shape. + * @see {@link UpdateBandwidthRateLimitCommandOutput} for command's `response` shape. + * @see {@link StorageGatewayClientResolvedConfig | config} for command's `input` shape. + * */ export class UpdateBandwidthRateLimitCommand extends $Command< UpdateBandwidthRateLimitCommandInput, diff --git a/clients/client-storage-gateway/commands/UpdateBandwidthRateLimitScheduleCommand.ts b/clients/client-storage-gateway/commands/UpdateBandwidthRateLimitScheduleCommand.ts index c58576f5d9e5..b660e33b54ac 100644 --- a/clients/client-storage-gateway/commands/UpdateBandwidthRateLimitScheduleCommand.ts +++ b/clients/client-storage-gateway/commands/UpdateBandwidthRateLimitScheduleCommand.ts @@ -29,6 +29,20 @@ export interface UpdateBandwidthRateLimitScheduleCommandOutput * Use this to initiate or update a gateway's bandwidth rate limit schedule. * This operation is supported in the volume and tape gateway types. *

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { StorageGatewayClient, UpdateBandwidthRateLimitScheduleCommand } from "@aws-sdk/client-storage-gateway"; // ES Modules import + * // const { StorageGatewayClient, UpdateBandwidthRateLimitScheduleCommand } = require("@aws-sdk/client-storage-gateway"); // CommonJS import + * const client = new StorageGatewayClient(config); + * const command = new UpdateBandwidthRateLimitScheduleCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link UpdateBandwidthRateLimitScheduleCommandInput} for command's `input` shape. + * @see {@link UpdateBandwidthRateLimitScheduleCommandOutput} for command's `response` shape. + * @see {@link StorageGatewayClientResolvedConfig | config} for command's `input` shape. + * */ export class UpdateBandwidthRateLimitScheduleCommand extends $Command< UpdateBandwidthRateLimitScheduleCommandInput, diff --git a/clients/client-storage-gateway/commands/UpdateChapCredentialsCommand.ts b/clients/client-storage-gateway/commands/UpdateChapCredentialsCommand.ts index e229a75436a1..05458949bcad 100644 --- a/clients/client-storage-gateway/commands/UpdateChapCredentialsCommand.ts +++ b/clients/client-storage-gateway/commands/UpdateChapCredentialsCommand.ts @@ -30,6 +30,20 @@ export interface UpdateChapCredentialsCommandOutput extends UpdateChapCredential *

When you update CHAP credentials, all existing connections on the target are closed * and initiators must reconnect with the new credentials.

* + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { StorageGatewayClient, UpdateChapCredentialsCommand } from "@aws-sdk/client-storage-gateway"; // ES Modules import + * // const { StorageGatewayClient, UpdateChapCredentialsCommand } = require("@aws-sdk/client-storage-gateway"); // CommonJS import + * const client = new StorageGatewayClient(config); + * const command = new UpdateChapCredentialsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link UpdateChapCredentialsCommandInput} for command's `input` shape. + * @see {@link UpdateChapCredentialsCommandOutput} for command's `response` shape. + * @see {@link StorageGatewayClientResolvedConfig | config} for command's `input` shape. + * */ export class UpdateChapCredentialsCommand extends $Command< UpdateChapCredentialsCommandInput, diff --git a/clients/client-storage-gateway/commands/UpdateFileSystemAssociationCommand.ts b/clients/client-storage-gateway/commands/UpdateFileSystemAssociationCommand.ts index 7dbd5a1c26d0..e9132f2c9b4a 100644 --- a/clients/client-storage-gateway/commands/UpdateFileSystemAssociationCommand.ts +++ b/clients/client-storage-gateway/commands/UpdateFileSystemAssociationCommand.ts @@ -23,6 +23,20 @@ export interface UpdateFileSystemAssociationCommandOutput extends UpdateFileSyst /** *

Updates a file system association. This operation is only supported in the Amazon FSx * file gateway type.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { StorageGatewayClient, UpdateFileSystemAssociationCommand } from "@aws-sdk/client-storage-gateway"; // ES Modules import + * // const { StorageGatewayClient, UpdateFileSystemAssociationCommand } = require("@aws-sdk/client-storage-gateway"); // CommonJS import + * const client = new StorageGatewayClient(config); + * const command = new UpdateFileSystemAssociationCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link UpdateFileSystemAssociationCommandInput} for command's `input` shape. + * @see {@link UpdateFileSystemAssociationCommandOutput} for command's `response` shape. + * @see {@link StorageGatewayClientResolvedConfig | config} for command's `input` shape. + * */ export class UpdateFileSystemAssociationCommand extends $Command< UpdateFileSystemAssociationCommandInput, diff --git a/clients/client-storage-gateway/commands/UpdateGatewayInformationCommand.ts b/clients/client-storage-gateway/commands/UpdateGatewayInformationCommand.ts index 69fab3267b78..ec15cf0cf4b5 100644 --- a/clients/client-storage-gateway/commands/UpdateGatewayInformationCommand.ts +++ b/clients/client-storage-gateway/commands/UpdateGatewayInformationCommand.ts @@ -30,6 +30,20 @@ export interface UpdateGatewayInformationCommandOutput extends UpdateGatewayInfo * gateway ID rather than the gateway name. However, changing the name of the gateway has * no effect on the gateway's ARN.

* + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { StorageGatewayClient, UpdateGatewayInformationCommand } from "@aws-sdk/client-storage-gateway"; // ES Modules import + * // const { StorageGatewayClient, UpdateGatewayInformationCommand } = require("@aws-sdk/client-storage-gateway"); // CommonJS import + * const client = new StorageGatewayClient(config); + * const command = new UpdateGatewayInformationCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link UpdateGatewayInformationCommandInput} for command's `input` shape. + * @see {@link UpdateGatewayInformationCommandOutput} for command's `response` shape. + * @see {@link StorageGatewayClientResolvedConfig | config} for command's `input` shape. + * */ export class UpdateGatewayInformationCommand extends $Command< UpdateGatewayInformationCommandInput, diff --git a/clients/client-storage-gateway/commands/UpdateGatewaySoftwareNowCommand.ts b/clients/client-storage-gateway/commands/UpdateGatewaySoftwareNowCommand.ts index 97e591132f97..35ff86e6c9e2 100644 --- a/clients/client-storage-gateway/commands/UpdateGatewaySoftwareNowCommand.ts +++ b/clients/client-storage-gateway/commands/UpdateGatewaySoftwareNowCommand.ts @@ -37,6 +37,20 @@ export interface UpdateGatewaySoftwareNowCommandOutput extends UpdateGatewaySoft * 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.

* + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { StorageGatewayClient, UpdateGatewaySoftwareNowCommand } from "@aws-sdk/client-storage-gateway"; // ES Modules import + * // const { StorageGatewayClient, UpdateGatewaySoftwareNowCommand } = require("@aws-sdk/client-storage-gateway"); // CommonJS import + * const client = new StorageGatewayClient(config); + * const command = new UpdateGatewaySoftwareNowCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link UpdateGatewaySoftwareNowCommandInput} for command's `input` shape. + * @see {@link UpdateGatewaySoftwareNowCommandOutput} for command's `response` shape. + * @see {@link StorageGatewayClientResolvedConfig | config} for command's `input` shape. + * */ export class UpdateGatewaySoftwareNowCommand extends $Command< UpdateGatewaySoftwareNowCommandInput, diff --git a/clients/client-storage-gateway/commands/UpdateMaintenanceStartTimeCommand.ts b/clients/client-storage-gateway/commands/UpdateMaintenanceStartTimeCommand.ts index 5b47b5ddd88b..e0c1ad854c95 100644 --- a/clients/client-storage-gateway/commands/UpdateMaintenanceStartTimeCommand.ts +++ b/clients/client-storage-gateway/commands/UpdateMaintenanceStartTimeCommand.ts @@ -23,6 +23,20 @@ export interface UpdateMaintenanceStartTimeCommandOutput extends UpdateMaintenan /** *

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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { StorageGatewayClient, UpdateMaintenanceStartTimeCommand } from "@aws-sdk/client-storage-gateway"; // ES Modules import + * // const { StorageGatewayClient, UpdateMaintenanceStartTimeCommand } = require("@aws-sdk/client-storage-gateway"); // CommonJS import + * const client = new StorageGatewayClient(config); + * const command = new UpdateMaintenanceStartTimeCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link UpdateMaintenanceStartTimeCommandInput} for command's `input` shape. + * @see {@link UpdateMaintenanceStartTimeCommandOutput} for command's `response` shape. + * @see {@link StorageGatewayClientResolvedConfig | config} for command's `input` shape. + * */ export class UpdateMaintenanceStartTimeCommand extends $Command< UpdateMaintenanceStartTimeCommandInput, diff --git a/clients/client-storage-gateway/commands/UpdateNFSFileShareCommand.ts b/clients/client-storage-gateway/commands/UpdateNFSFileShareCommand.ts index 677416889f49..133d7aa221b1 100644 --- a/clients/client-storage-gateway/commands/UpdateNFSFileShareCommand.ts +++ b/clients/client-storage-gateway/commands/UpdateNFSFileShareCommand.ts @@ -48,6 +48,20 @@ export interface UpdateNFSFileShareCommandOutput extends UpdateNFSFileShareOutpu *

Write status of your file share

* * + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { StorageGatewayClient, UpdateNFSFileShareCommand } from "@aws-sdk/client-storage-gateway"; // ES Modules import + * // const { StorageGatewayClient, UpdateNFSFileShareCommand } = require("@aws-sdk/client-storage-gateway"); // CommonJS import + * const client = new StorageGatewayClient(config); + * const command = new UpdateNFSFileShareCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link UpdateNFSFileShareCommandInput} for command's `input` shape. + * @see {@link UpdateNFSFileShareCommandOutput} for command's `response` shape. + * @see {@link StorageGatewayClientResolvedConfig | config} for command's `input` shape. + * */ export class UpdateNFSFileShareCommand extends $Command< UpdateNFSFileShareCommandInput, diff --git a/clients/client-storage-gateway/commands/UpdateSMBFileShareCommand.ts b/clients/client-storage-gateway/commands/UpdateSMBFileShareCommand.ts index 1c0476f664c1..84b5d13738e2 100644 --- a/clients/client-storage-gateway/commands/UpdateSMBFileShareCommand.ts +++ b/clients/client-storage-gateway/commands/UpdateSMBFileShareCommand.ts @@ -40,6 +40,20 @@ export interface UpdateSMBFileShareCommandOutput extends UpdateSMBFileShareOutpu *

File gateways don't support creating hard or symbolic links on a file * share.

* + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { StorageGatewayClient, UpdateSMBFileShareCommand } from "@aws-sdk/client-storage-gateway"; // ES Modules import + * // const { StorageGatewayClient, UpdateSMBFileShareCommand } = require("@aws-sdk/client-storage-gateway"); // CommonJS import + * const client = new StorageGatewayClient(config); + * const command = new UpdateSMBFileShareCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link UpdateSMBFileShareCommandInput} for command's `input` shape. + * @see {@link UpdateSMBFileShareCommandOutput} for command's `response` shape. + * @see {@link StorageGatewayClientResolvedConfig | config} for command's `input` shape. + * */ export class UpdateSMBFileShareCommand extends $Command< UpdateSMBFileShareCommandInput, diff --git a/clients/client-storage-gateway/commands/UpdateSMBFileShareVisibilityCommand.ts b/clients/client-storage-gateway/commands/UpdateSMBFileShareVisibilityCommand.ts index f2912f3cb2b2..8524645ae552 100644 --- a/clients/client-storage-gateway/commands/UpdateSMBFileShareVisibilityCommand.ts +++ b/clients/client-storage-gateway/commands/UpdateSMBFileShareVisibilityCommand.ts @@ -25,6 +25,20 @@ export interface UpdateSMBFileShareVisibilityCommandOutput /** *

Controls whether the shares on a gateway are visible in a net view or browse * list.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { StorageGatewayClient, UpdateSMBFileShareVisibilityCommand } from "@aws-sdk/client-storage-gateway"; // ES Modules import + * // const { StorageGatewayClient, UpdateSMBFileShareVisibilityCommand } = require("@aws-sdk/client-storage-gateway"); // CommonJS import + * const client = new StorageGatewayClient(config); + * const command = new UpdateSMBFileShareVisibilityCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link UpdateSMBFileShareVisibilityCommandInput} for command's `input` shape. + * @see {@link UpdateSMBFileShareVisibilityCommandOutput} for command's `response` shape. + * @see {@link StorageGatewayClientResolvedConfig | config} for command's `input` shape. + * */ export class UpdateSMBFileShareVisibilityCommand extends $Command< UpdateSMBFileShareVisibilityCommandInput, diff --git a/clients/client-storage-gateway/commands/UpdateSMBSecurityStrategyCommand.ts b/clients/client-storage-gateway/commands/UpdateSMBSecurityStrategyCommand.ts index c2a12ae3b977..d707e2a7d5ef 100644 --- a/clients/client-storage-gateway/commands/UpdateSMBSecurityStrategyCommand.ts +++ b/clients/client-storage-gateway/commands/UpdateSMBSecurityStrategyCommand.ts @@ -29,6 +29,20 @@ export interface UpdateSMBSecurityStrategyCommandOutput extends UpdateSMBSecurit * *

A higher security level can affect performance of the gateway.

* + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { StorageGatewayClient, UpdateSMBSecurityStrategyCommand } from "@aws-sdk/client-storage-gateway"; // ES Modules import + * // const { StorageGatewayClient, UpdateSMBSecurityStrategyCommand } = require("@aws-sdk/client-storage-gateway"); // CommonJS import + * const client = new StorageGatewayClient(config); + * const command = new UpdateSMBSecurityStrategyCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link UpdateSMBSecurityStrategyCommandInput} for command's `input` shape. + * @see {@link UpdateSMBSecurityStrategyCommandOutput} for command's `response` shape. + * @see {@link StorageGatewayClientResolvedConfig | config} for command's `input` shape. + * */ export class UpdateSMBSecurityStrategyCommand extends $Command< UpdateSMBSecurityStrategyCommandInput, diff --git a/clients/client-storage-gateway/commands/UpdateSnapshotScheduleCommand.ts b/clients/client-storage-gateway/commands/UpdateSnapshotScheduleCommand.ts index 08b02d73bf5f..13d386ea8be7 100644 --- a/clients/client-storage-gateway/commands/UpdateSnapshotScheduleCommand.ts +++ b/clients/client-storage-gateway/commands/UpdateSnapshotScheduleCommand.ts @@ -31,6 +31,20 @@ export interface UpdateSnapshotScheduleCommandOutput extends UpdateSnapshotSched *

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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { StorageGatewayClient, UpdateSnapshotScheduleCommand } from "@aws-sdk/client-storage-gateway"; // ES Modules import + * // const { StorageGatewayClient, UpdateSnapshotScheduleCommand } = require("@aws-sdk/client-storage-gateway"); // CommonJS import + * const client = new StorageGatewayClient(config); + * const command = new UpdateSnapshotScheduleCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link UpdateSnapshotScheduleCommandInput} for command's `input` shape. + * @see {@link UpdateSnapshotScheduleCommandOutput} for command's `response` shape. + * @see {@link StorageGatewayClientResolvedConfig | config} for command's `input` shape. + * */ export class UpdateSnapshotScheduleCommand extends $Command< UpdateSnapshotScheduleCommandInput, diff --git a/clients/client-storage-gateway/commands/UpdateVTLDeviceTypeCommand.ts b/clients/client-storage-gateway/commands/UpdateVTLDeviceTypeCommand.ts index 04ec6f4be03d..f044ec6d0bbe 100644 --- a/clients/client-storage-gateway/commands/UpdateVTLDeviceTypeCommand.ts +++ b/clients/client-storage-gateway/commands/UpdateVTLDeviceTypeCommand.ts @@ -25,6 +25,20 @@ export interface UpdateVTLDeviceTypeCommandOutput extends UpdateVTLDeviceTypeOut * 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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { StorageGatewayClient, UpdateVTLDeviceTypeCommand } from "@aws-sdk/client-storage-gateway"; // ES Modules import + * // const { StorageGatewayClient, UpdateVTLDeviceTypeCommand } = require("@aws-sdk/client-storage-gateway"); // CommonJS import + * const client = new StorageGatewayClient(config); + * const command = new UpdateVTLDeviceTypeCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link UpdateVTLDeviceTypeCommandInput} for command's `input` shape. + * @see {@link UpdateVTLDeviceTypeCommandOutput} for command's `response` shape. + * @see {@link StorageGatewayClientResolvedConfig | config} for command's `input` shape. + * */ export class UpdateVTLDeviceTypeCommand extends $Command< UpdateVTLDeviceTypeCommandInput, diff --git a/clients/client-storage-gateway/models/models_0.ts b/clients/client-storage-gateway/models/models_0.ts index 27accf34ca19..08fb0a9c6122 100644 --- a/clients/client-storage-gateway/models/models_0.ts +++ b/clients/client-storage-gateway/models/models_0.ts @@ -19,6 +19,9 @@ export interface Tag { } export namespace Tag { + /** + * @internal + */ export const filterSensitiveLog = (obj: Tag): any => ({ ...obj, }); @@ -157,6 +160,9 @@ export interface ActivateGatewayInput { } export namespace ActivateGatewayInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: ActivateGatewayInput): any => ({ ...obj, }); @@ -183,6 +189,9 @@ export interface ActivateGatewayOutput { } export namespace ActivateGatewayOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: ActivateGatewayOutput): any => ({ ...obj, }); @@ -270,6 +279,9 @@ export interface StorageGatewayError { } export namespace StorageGatewayError { + /** + * @internal + */ export const filterSensitiveLog = (obj: StorageGatewayError): any => ({ ...obj, }); @@ -295,6 +307,9 @@ export interface InternalServerError extends __SmithyException, $MetadataBearer } export namespace InternalServerError { + /** + * @internal + */ export const filterSensitiveLog = (obj: InternalServerError): any => ({ ...obj, }); @@ -320,6 +335,9 @@ export interface InvalidGatewayRequestException extends __SmithyException, $Meta } export namespace InvalidGatewayRequestException { + /** + * @internal + */ export const filterSensitiveLog = (obj: InvalidGatewayRequestException): any => ({ ...obj, }); @@ -350,6 +368,9 @@ export interface AddCacheInput { } export namespace AddCacheInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: AddCacheInput): any => ({ ...obj, }); @@ -364,6 +385,9 @@ export interface AddCacheOutput { } export namespace AddCacheOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: AddCacheOutput): any => ({ ...obj, }); @@ -393,6 +417,9 @@ export interface AddTagsToResourceInput { } export namespace AddTagsToResourceInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: AddTagsToResourceInput): any => ({ ...obj, }); @@ -409,6 +436,9 @@ export interface AddTagsToResourceOutput { } export namespace AddTagsToResourceOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: AddTagsToResourceOutput): any => ({ ...obj, }); @@ -430,6 +460,9 @@ export interface AddUploadBufferInput { } export namespace AddUploadBufferInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: AddUploadBufferInput): any => ({ ...obj, }); @@ -444,6 +477,9 @@ export interface AddUploadBufferOutput { } export namespace AddUploadBufferOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: AddUploadBufferOutput): any => ({ ...obj, }); @@ -476,6 +512,9 @@ export interface AddWorkingStorageInput { } export namespace AddWorkingStorageInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: AddWorkingStorageInput): any => ({ ...obj, }); @@ -494,6 +533,9 @@ export interface AddWorkingStorageOutput { } export namespace AddWorkingStorageOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: AddWorkingStorageOutput): any => ({ ...obj, }); @@ -532,6 +574,9 @@ export interface AssignTapePoolInput { } export namespace AssignTapePoolInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: AssignTapePoolInput): any => ({ ...obj, }); @@ -546,6 +591,9 @@ export interface AssignTapePoolOutput { } export namespace AssignTapePoolOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: AssignTapePoolOutput): any => ({ ...obj, }); @@ -567,6 +615,9 @@ export interface CacheAttributes { } export namespace CacheAttributes { + /** + * @internal + */ export const filterSensitiveLog = (obj: CacheAttributes): any => ({ ...obj, }); @@ -620,6 +671,9 @@ export interface AssociateFileSystemInput { } export namespace AssociateFileSystemInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: AssociateFileSystemInput): any => ({ ...obj, ...(obj.Password && { Password: SENSITIVE_STRING }), @@ -634,6 +688,9 @@ export interface AssociateFileSystemOutput { } export namespace AssociateFileSystemOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: AssociateFileSystemOutput): any => ({ ...obj, }); @@ -684,6 +741,9 @@ export interface AttachVolumeInput { } export namespace AttachVolumeInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: AttachVolumeInput): any => ({ ...obj, }); @@ -706,6 +766,9 @@ export interface AttachVolumeOutput { } export namespace AttachVolumeOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: AttachVolumeOutput): any => ({ ...obj, }); @@ -761,6 +824,9 @@ export interface AutomaticTapeCreationRule { } export namespace AutomaticTapeCreationRule { + /** + * @internal + */ export const filterSensitiveLog = (obj: AutomaticTapeCreationRule): any => ({ ...obj, }); @@ -786,6 +852,9 @@ export interface AutomaticTapeCreationPolicyInfo { } export namespace AutomaticTapeCreationPolicyInfo { + /** + * @internal + */ export const filterSensitiveLog = (obj: AutomaticTapeCreationPolicyInfo): any => ({ ...obj, }); @@ -863,6 +932,9 @@ export interface BandwidthRateLimitInterval { } export namespace BandwidthRateLimitInterval { + /** + * @internal + */ export const filterSensitiveLog = (obj: BandwidthRateLimitInterval): any => ({ ...obj, }); @@ -899,6 +971,9 @@ export interface VolumeiSCSIAttributes { } export namespace VolumeiSCSIAttributes { + /** + * @internal + */ export const filterSensitiveLog = (obj: VolumeiSCSIAttributes): any => ({ ...obj, }); @@ -1000,6 +1075,9 @@ export interface CachediSCSIVolume { } export namespace CachediSCSIVolume { + /** + * @internal + */ export const filterSensitiveLog = (obj: CachediSCSIVolume): any => ({ ...obj, }); @@ -1023,6 +1101,9 @@ export interface CancelArchivalInput { } export namespace CancelArchivalInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: CancelArchivalInput): any => ({ ...obj, }); @@ -1040,6 +1121,9 @@ export interface CancelArchivalOutput { } export namespace CancelArchivalOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: CancelArchivalOutput): any => ({ ...obj, }); @@ -1063,6 +1147,9 @@ export interface CancelRetrievalInput { } export namespace CancelRetrievalInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: CancelRetrievalInput): any => ({ ...obj, }); @@ -1080,6 +1167,9 @@ export interface CancelRetrievalOutput { } export namespace CancelRetrievalOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: CancelRetrievalOutput): any => ({ ...obj, }); @@ -1118,6 +1208,9 @@ export interface ChapInfo { } export namespace ChapInfo { + /** + * @internal + */ export const filterSensitiveLog = (obj: ChapInfo): any => ({ ...obj, ...(obj.SecretToAuthenticateInitiator && { SecretToAuthenticateInitiator: SENSITIVE_STRING }), @@ -1211,6 +1304,9 @@ export interface CreateCachediSCSIVolumeInput { } export namespace CreateCachediSCSIVolumeInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateCachediSCSIVolumeInput): any => ({ ...obj, }); @@ -1230,6 +1326,9 @@ export interface CreateCachediSCSIVolumeOutput { } export namespace CreateCachediSCSIVolumeOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateCachediSCSIVolumeOutput): any => ({ ...obj, }); @@ -1270,6 +1369,9 @@ export interface NFSFileShareDefaults { } export namespace NFSFileShareDefaults { + /** + * @internal + */ export const filterSensitiveLog = (obj: NFSFileShareDefaults): any => ({ ...obj, }); @@ -1473,6 +1575,9 @@ export interface CreateNFSFileShareInput { } export namespace CreateNFSFileShareInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateNFSFileShareInput): any => ({ ...obj, }); @@ -1489,6 +1594,9 @@ export interface CreateNFSFileShareOutput { } export namespace CreateNFSFileShareOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateNFSFileShareOutput): any => ({ ...obj, }); @@ -1723,6 +1831,9 @@ export interface CreateSMBFileShareInput { } export namespace CreateSMBFileShareInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateSMBFileShareInput): any => ({ ...obj, }); @@ -1739,6 +1850,9 @@ export interface CreateSMBFileShareOutput { } export namespace CreateSMBFileShareOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateSMBFileShareOutput): any => ({ ...obj, }); @@ -1790,6 +1904,9 @@ export interface CreateSnapshotInput { } export namespace CreateSnapshotInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateSnapshotInput): any => ({ ...obj, }); @@ -1813,6 +1930,9 @@ export interface CreateSnapshotOutput { } export namespace CreateSnapshotOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateSnapshotOutput): any => ({ ...obj, }); @@ -1838,6 +1958,9 @@ export interface ServiceUnavailableError extends __SmithyException, $MetadataBea } export namespace ServiceUnavailableError { + /** + * @internal + */ export const filterSensitiveLog = (obj: ServiceUnavailableError): any => ({ ...obj, }); @@ -1873,6 +1996,9 @@ export interface CreateSnapshotFromVolumeRecoveryPointInput { } export namespace CreateSnapshotFromVolumeRecoveryPointInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateSnapshotFromVolumeRecoveryPointInput): any => ({ ...obj, }); @@ -1897,6 +2023,9 @@ export interface CreateSnapshotFromVolumeRecoveryPointOutput { } export namespace CreateSnapshotFromVolumeRecoveryPointOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateSnapshotFromVolumeRecoveryPointOutput): any => ({ ...obj, }); @@ -2016,6 +2145,9 @@ export interface CreateStorediSCSIVolumeInput { } export namespace CreateStorediSCSIVolumeInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateStorediSCSIVolumeInput): any => ({ ...obj, }); @@ -2043,6 +2175,9 @@ export interface CreateStorediSCSIVolumeOutput { } export namespace CreateStorediSCSIVolumeOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateStorediSCSIVolumeOutput): any => ({ ...obj, }); @@ -2094,6 +2229,9 @@ export interface CreateTapePoolInput { } export namespace CreateTapePoolInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateTapePoolInput): any => ({ ...obj, }); @@ -2109,6 +2247,9 @@ export interface CreateTapePoolOutput { } export namespace CreateTapePoolOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateTapePoolOutput): any => ({ ...obj, }); @@ -2209,6 +2350,9 @@ export interface CreateTapesInput { } export namespace CreateTapesInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateTapesInput): any => ({ ...obj, }); @@ -2226,6 +2370,9 @@ export interface CreateTapesOutput { } export namespace CreateTapesOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateTapesOutput): any => ({ ...obj, }); @@ -2309,6 +2456,9 @@ export interface CreateTapeWithBarcodeInput { } export namespace CreateTapeWithBarcodeInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateTapeWithBarcodeInput): any => ({ ...obj, }); @@ -2326,6 +2476,9 @@ export interface CreateTapeWithBarcodeOutput { } export namespace CreateTapeWithBarcodeOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateTapeWithBarcodeOutput): any => ({ ...obj, }); @@ -2340,6 +2493,9 @@ export interface DeleteAutomaticTapeCreationPolicyInput { } export namespace DeleteAutomaticTapeCreationPolicyInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteAutomaticTapeCreationPolicyInput): any => ({ ...obj, }); @@ -2354,6 +2510,9 @@ export interface DeleteAutomaticTapeCreationPolicyOutput { } export namespace DeleteAutomaticTapeCreationPolicyOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteAutomaticTapeCreationPolicyOutput): any => ({ ...obj, }); @@ -2388,6 +2547,9 @@ export interface DeleteBandwidthRateLimitInput { } export namespace DeleteBandwidthRateLimitInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteBandwidthRateLimitInput): any => ({ ...obj, }); @@ -2406,6 +2568,9 @@ export interface DeleteBandwidthRateLimitOutput { } export namespace DeleteBandwidthRateLimitOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteBandwidthRateLimitOutput): any => ({ ...obj, }); @@ -2441,6 +2606,9 @@ export interface DeleteChapCredentialsInput { } export namespace DeleteChapCredentialsInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteChapCredentialsInput): any => ({ ...obj, }); @@ -2462,6 +2630,9 @@ export interface DeleteChapCredentialsOutput { } export namespace DeleteChapCredentialsOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteChapCredentialsOutput): any => ({ ...obj, }); @@ -2489,6 +2660,9 @@ export interface DeleteFileShareInput { } export namespace DeleteFileShareInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteFileShareInput): any => ({ ...obj, }); @@ -2505,6 +2679,9 @@ export interface DeleteFileShareOutput { } export namespace DeleteFileShareOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteFileShareOutput): any => ({ ...obj, }); @@ -2522,6 +2699,9 @@ export interface DeleteGatewayInput { } export namespace DeleteGatewayInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteGatewayInput): any => ({ ...obj, }); @@ -2539,6 +2719,9 @@ export interface DeleteGatewayOutput { } export namespace DeleteGatewayOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteGatewayOutput): any => ({ ...obj, }); @@ -2552,6 +2735,9 @@ export interface DeleteSnapshotScheduleInput { } export namespace DeleteSnapshotScheduleInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteSnapshotScheduleInput): any => ({ ...obj, }); @@ -2565,6 +2751,9 @@ export interface DeleteSnapshotScheduleOutput { } export namespace DeleteSnapshotScheduleOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteSnapshotScheduleOutput): any => ({ ...obj, }); @@ -2596,6 +2785,9 @@ export interface DeleteTapeInput { } export namespace DeleteTapeInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteTapeInput): any => ({ ...obj, }); @@ -2612,6 +2804,9 @@ export interface DeleteTapeOutput { } export namespace DeleteTapeOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteTapeOutput): any => ({ ...obj, }); @@ -2637,6 +2832,9 @@ export interface DeleteTapeArchiveInput { } export namespace DeleteTapeArchiveInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteTapeArchiveInput): any => ({ ...obj, }); @@ -2654,6 +2852,9 @@ export interface DeleteTapeArchiveOutput { } export namespace DeleteTapeArchiveOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteTapeArchiveOutput): any => ({ ...obj, }); @@ -2667,6 +2868,9 @@ export interface DeleteTapePoolInput { } export namespace DeleteTapePoolInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteTapePoolInput): any => ({ ...obj, }); @@ -2680,6 +2884,9 @@ export interface DeleteTapePoolOutput { } export namespace DeleteTapePoolOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteTapePoolOutput): any => ({ ...obj, }); @@ -2698,6 +2905,9 @@ export interface DeleteVolumeInput { } export namespace DeleteVolumeInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteVolumeInput): any => ({ ...obj, }); @@ -2716,6 +2926,9 @@ export interface DeleteVolumeOutput { } export namespace DeleteVolumeOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteVolumeOutput): any => ({ ...obj, }); @@ -2730,6 +2943,9 @@ export interface DescribeAvailabilityMonitorTestInput { } export namespace DescribeAvailabilityMonitorTestInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeAvailabilityMonitorTestInput): any => ({ ...obj, }); @@ -2756,6 +2972,9 @@ export interface DescribeAvailabilityMonitorTestOutput { } export namespace DescribeAvailabilityMonitorTestOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeAvailabilityMonitorTestOutput): any => ({ ...obj, }); @@ -2773,6 +2992,9 @@ export interface DescribeBandwidthRateLimitInput { } export namespace DescribeBandwidthRateLimitInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeBandwidthRateLimitInput): any => ({ ...obj, }); @@ -2802,6 +3024,9 @@ export interface DescribeBandwidthRateLimitOutput { } export namespace DescribeBandwidthRateLimitOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeBandwidthRateLimitOutput): any => ({ ...obj, }); @@ -2816,6 +3041,9 @@ export interface DescribeBandwidthRateLimitScheduleInput { } export namespace DescribeBandwidthRateLimitScheduleInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeBandwidthRateLimitScheduleInput): any => ({ ...obj, }); @@ -2837,6 +3065,9 @@ export interface DescribeBandwidthRateLimitScheduleOutput { } export namespace DescribeBandwidthRateLimitScheduleOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeBandwidthRateLimitScheduleOutput): any => ({ ...obj, }); @@ -2851,6 +3082,9 @@ export interface DescribeCacheInput { } export namespace DescribeCacheInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeCacheInput): any => ({ ...obj, }); @@ -2902,6 +3136,9 @@ export interface DescribeCacheOutput { } export namespace DescribeCacheOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeCacheOutput): any => ({ ...obj, }); @@ -2916,6 +3153,9 @@ export interface DescribeCachediSCSIVolumesInput { } export namespace DescribeCachediSCSIVolumesInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeCachediSCSIVolumesInput): any => ({ ...obj, }); @@ -2932,6 +3172,9 @@ export interface DescribeCachediSCSIVolumesOutput { } export namespace DescribeCachediSCSIVolumesOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeCachediSCSIVolumesOutput): any => ({ ...obj, }); @@ -2950,6 +3193,9 @@ export interface DescribeChapCredentialsInput { } export namespace DescribeChapCredentialsInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeChapCredentialsInput): any => ({ ...obj, }); @@ -2998,6 +3244,9 @@ export interface DescribeChapCredentialsOutput { } export namespace DescribeChapCredentialsOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeChapCredentialsOutput): any => ({ ...obj, ...(obj.ChapCredentials && { @@ -3014,6 +3263,9 @@ export interface DescribeFileSystemAssociationsInput { } export namespace DescribeFileSystemAssociationsInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeFileSystemAssociationsInput): any => ({ ...obj, }); @@ -3067,6 +3319,9 @@ export interface FileSystemAssociationInfo { } export namespace FileSystemAssociationInfo { + /** + * @internal + */ export const filterSensitiveLog = (obj: FileSystemAssociationInfo): any => ({ ...obj, }); @@ -3081,6 +3336,9 @@ export interface DescribeFileSystemAssociationsOutput { } export namespace DescribeFileSystemAssociationsOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeFileSystemAssociationsOutput): any => ({ ...obj, }); @@ -3098,6 +3356,9 @@ export interface DescribeGatewayInformationInput { } export namespace DescribeGatewayInformationInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeGatewayInformationInput): any => ({ ...obj, }); @@ -3129,6 +3390,9 @@ export interface NetworkInterface { } export namespace NetworkInterface { + /** + * @internal + */ export const filterSensitiveLog = (obj: NetworkInterface): any => ({ ...obj, }); @@ -3247,6 +3511,9 @@ export interface DescribeGatewayInformationOutput { } export namespace DescribeGatewayInformationOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeGatewayInformationOutput): any => ({ ...obj, }); @@ -3264,6 +3531,9 @@ export interface DescribeMaintenanceStartTimeInput { } export namespace DescribeMaintenanceStartTimeInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeMaintenanceStartTimeInput): any => ({ ...obj, }); @@ -3343,6 +3613,9 @@ export interface DescribeMaintenanceStartTimeOutput { } export namespace DescribeMaintenanceStartTimeOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeMaintenanceStartTimeOutput): any => ({ ...obj, }); @@ -3360,6 +3633,9 @@ export interface DescribeNFSFileSharesInput { } export namespace DescribeNFSFileSharesInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeNFSFileSharesInput): any => ({ ...obj, }); @@ -3570,6 +3846,9 @@ export interface NFSFileShareInfo { } export namespace NFSFileShareInfo { + /** + * @internal + */ export const filterSensitiveLog = (obj: NFSFileShareInfo): any => ({ ...obj, }); @@ -3586,6 +3865,9 @@ export interface DescribeNFSFileSharesOutput { } export namespace DescribeNFSFileSharesOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeNFSFileSharesOutput): any => ({ ...obj, }); @@ -3603,6 +3885,9 @@ export interface DescribeSMBFileSharesInput { } export namespace DescribeSMBFileSharesInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeSMBFileSharesInput): any => ({ ...obj, }); @@ -3844,6 +4129,9 @@ export interface SMBFileShareInfo { } export namespace SMBFileShareInfo { + /** + * @internal + */ export const filterSensitiveLog = (obj: SMBFileShareInfo): any => ({ ...obj, }); @@ -3860,6 +4148,9 @@ export interface DescribeSMBFileSharesOutput { } export namespace DescribeSMBFileSharesOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeSMBFileSharesOutput): any => ({ ...obj, }); @@ -3874,6 +4165,9 @@ export interface DescribeSMBSettingsInput { } export namespace DescribeSMBSettingsInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeSMBSettingsInput): any => ({ ...obj, }); @@ -3979,6 +4273,9 @@ export interface DescribeSMBSettingsOutput { } export namespace DescribeSMBSettingsOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeSMBSettingsOutput): any => ({ ...obj, }); @@ -3997,6 +4294,9 @@ export interface DescribeSnapshotScheduleInput { } export namespace DescribeSnapshotScheduleInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeSnapshotScheduleInput): any => ({ ...obj, }); @@ -4039,6 +4339,9 @@ export interface DescribeSnapshotScheduleOutput { } export namespace DescribeSnapshotScheduleOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeSnapshotScheduleOutput): any => ({ ...obj, }); @@ -4056,6 +4359,9 @@ export interface DescribeStorediSCSIVolumesInput { } export namespace DescribeStorediSCSIVolumesInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeStorediSCSIVolumesInput): any => ({ ...obj, }); @@ -4171,6 +4477,9 @@ export interface StorediSCSIVolume { } export namespace StorediSCSIVolume { + /** + * @internal + */ export const filterSensitiveLog = (obj: StorediSCSIVolume): any => ({ ...obj, }); @@ -4267,6 +4576,9 @@ export interface DescribeStorediSCSIVolumesOutput { } export namespace DescribeStorediSCSIVolumesOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeStorediSCSIVolumesOutput): any => ({ ...obj, }); @@ -4296,6 +4608,9 @@ export interface DescribeTapeArchivesInput { } export namespace DescribeTapeArchivesInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeTapeArchivesInput): any => ({ ...obj, }); @@ -4393,6 +4708,9 @@ export interface TapeArchive { } export namespace TapeArchive { + /** + * @internal + */ export const filterSensitiveLog = (obj: TapeArchive): any => ({ ...obj, }); @@ -4420,6 +4738,9 @@ export interface DescribeTapeArchivesOutput { } export namespace DescribeTapeArchivesOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeTapeArchivesOutput): any => ({ ...obj, }); @@ -4449,6 +4770,9 @@ export interface DescribeTapeRecoveryPointsInput { } export namespace DescribeTapeRecoveryPointsInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeTapeRecoveryPointsInput): any => ({ ...obj, }); @@ -4484,6 +4808,9 @@ export interface TapeRecoveryPointInfo { } export namespace TapeRecoveryPointInfo { + /** + * @internal + */ export const filterSensitiveLog = (obj: TapeRecoveryPointInfo): any => ({ ...obj, }); @@ -4516,6 +4843,9 @@ export interface DescribeTapeRecoveryPointsOutput { } export namespace DescribeTapeRecoveryPointsOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeTapeRecoveryPointsOutput): any => ({ ...obj, }); @@ -4558,6 +4888,9 @@ export interface DescribeTapesInput { } export namespace DescribeTapesInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeTapesInput): any => ({ ...obj, }); @@ -4650,6 +4983,9 @@ export interface Tape { } export namespace Tape { + /** + * @internal + */ export const filterSensitiveLog = (obj: Tape): any => ({ ...obj, }); @@ -4675,6 +5011,9 @@ export interface DescribeTapesOutput { } export namespace DescribeTapesOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeTapesOutput): any => ({ ...obj, }); @@ -4689,6 +5028,9 @@ export interface DescribeUploadBufferInput { } export namespace DescribeUploadBufferInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeUploadBufferInput): any => ({ ...obj, }); @@ -4721,6 +5063,9 @@ export interface DescribeUploadBufferOutput { } export namespace DescribeUploadBufferOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeUploadBufferOutput): any => ({ ...obj, }); @@ -4761,6 +5106,9 @@ export interface DescribeVTLDevicesInput { } export namespace DescribeVTLDevicesInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeVTLDevicesInput): any => ({ ...obj, }); @@ -4793,6 +5141,9 @@ export interface DeviceiSCSIAttributes { } export namespace DeviceiSCSIAttributes { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeviceiSCSIAttributes): any => ({ ...obj, }); @@ -4830,6 +5181,9 @@ export interface VTLDevice { } export namespace VTLDevice { + /** + * @internal + */ export const filterSensitiveLog = (obj: VTLDevice): any => ({ ...obj, }); @@ -4861,6 +5215,9 @@ export interface DescribeVTLDevicesOutput { } export namespace DescribeVTLDevicesOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeVTLDevicesOutput): any => ({ ...obj, }); @@ -4878,6 +5235,9 @@ export interface DescribeWorkingStorageInput { } export namespace DescribeWorkingStorageInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeWorkingStorageInput): any => ({ ...obj, }); @@ -4915,6 +5275,9 @@ export interface DescribeWorkingStorageOutput { } export namespace DescribeWorkingStorageOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeWorkingStorageOutput): any => ({ ...obj, }); @@ -4942,6 +5305,9 @@ export interface DetachVolumeInput { } export namespace DetachVolumeInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: DetachVolumeInput): any => ({ ...obj, }); @@ -4958,6 +5324,9 @@ export interface DetachVolumeOutput { } export namespace DetachVolumeOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: DetachVolumeOutput): any => ({ ...obj, }); @@ -4975,6 +5344,9 @@ export interface DisableGatewayInput { } export namespace DisableGatewayInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: DisableGatewayInput): any => ({ ...obj, }); @@ -4991,6 +5363,9 @@ export interface DisableGatewayOutput { } export namespace DisableGatewayOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: DisableGatewayOutput): any => ({ ...obj, }); @@ -5012,6 +5387,9 @@ export interface DisassociateFileSystemInput { } export namespace DisassociateFileSystemInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: DisassociateFileSystemInput): any => ({ ...obj, }); @@ -5025,6 +5403,9 @@ export interface DisassociateFileSystemOutput { } export namespace DisassociateFileSystemOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: DisassociateFileSystemOutput): any => ({ ...obj, }); @@ -5082,6 +5463,9 @@ export interface Disk { } export namespace Disk { + /** + * @internal + */ export const filterSensitiveLog = (obj: Disk): any => ({ ...obj, }); @@ -5125,6 +5509,9 @@ export interface FileShareInfo { } export namespace FileShareInfo { + /** + * @internal + */ export const filterSensitiveLog = (obj: FileShareInfo): any => ({ ...obj, }); @@ -5160,6 +5547,9 @@ export interface FileSystemAssociationSummary { } export namespace FileSystemAssociationSummary { + /** + * @internal + */ export const filterSensitiveLog = (obj: FileSystemAssociationSummary): any => ({ ...obj, }); @@ -5212,6 +5602,9 @@ export interface GatewayInfo { } export namespace GatewayInfo { + /** + * @internal + */ export const filterSensitiveLog = (obj: GatewayInfo): any => ({ ...obj, }); @@ -5268,6 +5661,9 @@ export interface JoinDomainInput { } export namespace JoinDomainInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: JoinDomainInput): any => ({ ...obj, ...(obj.Password && { Password: SENSITIVE_STRING }), @@ -5327,6 +5723,9 @@ export interface JoinDomainOutput { } export namespace JoinDomainOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: JoinDomainOutput): any => ({ ...obj, }); @@ -5341,6 +5740,9 @@ export interface ListAutomaticTapeCreationPoliciesInput { } export namespace ListAutomaticTapeCreationPoliciesInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListAutomaticTapeCreationPoliciesInput): any => ({ ...obj, }); @@ -5356,6 +5758,9 @@ export interface ListAutomaticTapeCreationPoliciesOutput { } export namespace ListAutomaticTapeCreationPoliciesOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListAutomaticTapeCreationPoliciesOutput): any => ({ ...obj, }); @@ -5386,6 +5791,9 @@ export interface ListFileSharesInput { } export namespace ListFileSharesInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListFileSharesInput): any => ({ ...obj, }); @@ -5415,6 +5823,9 @@ export interface ListFileSharesOutput { } export namespace ListFileSharesOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListFileSharesOutput): any => ({ ...obj, }); @@ -5439,6 +5850,9 @@ export interface ListFileSystemAssociationsInput { } export namespace ListFileSystemAssociationsInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListFileSystemAssociationsInput): any => ({ ...obj, }); @@ -5463,6 +5877,9 @@ export interface ListFileSystemAssociationsOutput { } export namespace ListFileSystemAssociationsOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListFileSystemAssociationsOutput): any => ({ ...obj, }); @@ -5499,6 +5916,9 @@ export interface ListGatewaysInput { } export namespace ListGatewaysInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListGatewaysInput): any => ({ ...obj, }); @@ -5518,6 +5938,9 @@ export interface ListGatewaysOutput { } export namespace ListGatewaysOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListGatewaysOutput): any => ({ ...obj, }); @@ -5535,6 +5958,9 @@ export interface ListLocalDisksInput { } export namespace ListLocalDisksInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListLocalDisksInput): any => ({ ...obj, }); @@ -5562,6 +5988,9 @@ export interface ListLocalDisksOutput { } export namespace ListLocalDisksOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListLocalDisksOutput): any => ({ ...obj, }); @@ -5590,6 +6019,9 @@ export interface ListTagsForResourceInput { } export namespace ListTagsForResourceInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListTagsForResourceInput): any => ({ ...obj, }); @@ -5617,6 +6049,9 @@ export interface ListTagsForResourceOutput { } export namespace ListTagsForResourceOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListTagsForResourceOutput): any => ({ ...obj, }); @@ -5642,6 +6077,9 @@ export interface ListTapePoolsInput { } export namespace ListTapePoolsInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListTapePoolsInput): any => ({ ...obj, }); @@ -5694,6 +6132,9 @@ export interface PoolInfo { } export namespace PoolInfo { + /** + * @internal + */ export const filterSensitiveLog = (obj: PoolInfo): any => ({ ...obj, }); @@ -5716,6 +6157,9 @@ export interface ListTapePoolsOutput { } export namespace ListTapePoolsOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListTapePoolsOutput): any => ({ ...obj, }); @@ -5762,6 +6206,9 @@ export interface ListTapesInput { } export namespace ListTapesInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListTapesInput): any => ({ ...obj, }); @@ -5821,6 +6268,9 @@ export interface TapeInfo { } export namespace TapeInfo { + /** + * @internal + */ export const filterSensitiveLog = (obj: TapeInfo): any => ({ ...obj, }); @@ -5859,6 +6309,9 @@ export interface ListTapesOutput { } export namespace ListTapesOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListTapesOutput): any => ({ ...obj, }); @@ -5876,6 +6329,9 @@ export interface ListVolumeInitiatorsInput { } export namespace ListVolumeInitiatorsInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListVolumeInitiatorsInput): any => ({ ...obj, }); @@ -5893,6 +6349,9 @@ export interface ListVolumeInitiatorsOutput { } export namespace ListVolumeInitiatorsOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListVolumeInitiatorsOutput): any => ({ ...obj, }); @@ -5907,6 +6366,9 @@ export interface ListVolumeRecoveryPointsInput { } export namespace ListVolumeRecoveryPointsInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListVolumeRecoveryPointsInput): any => ({ ...obj, }); @@ -5943,6 +6405,9 @@ export interface VolumeRecoveryPointInfo { } export namespace VolumeRecoveryPointInfo { + /** + * @internal + */ export const filterSensitiveLog = (obj: VolumeRecoveryPointInfo): any => ({ ...obj, }); @@ -5962,6 +6427,9 @@ export interface ListVolumeRecoveryPointsOutput { } export namespace ListVolumeRecoveryPointsOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListVolumeRecoveryPointsOutput): any => ({ ...obj, }); @@ -6004,6 +6472,9 @@ export interface ListVolumesInput { } export namespace ListVolumesInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListVolumesInput): any => ({ ...obj, }); @@ -6067,6 +6538,9 @@ export interface VolumeInfo { } export namespace VolumeInfo { + /** + * @internal + */ export const filterSensitiveLog = (obj: VolumeInfo): any => ({ ...obj, }); @@ -6110,6 +6584,9 @@ export interface ListVolumesOutput { } export namespace ListVolumesOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListVolumesOutput): any => ({ ...obj, }); @@ -6123,6 +6600,9 @@ export interface NotifyWhenUploadedInput { } export namespace NotifyWhenUploadedInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: NotifyWhenUploadedInput): any => ({ ...obj, }); @@ -6142,6 +6622,9 @@ export interface NotifyWhenUploadedOutput { } export namespace NotifyWhenUploadedOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: NotifyWhenUploadedOutput): any => ({ ...obj, }); @@ -6180,6 +6663,9 @@ export interface RefreshCacheInput { } export namespace RefreshCacheInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: RefreshCacheInput): any => ({ ...obj, }); @@ -6202,6 +6688,9 @@ export interface RefreshCacheOutput { } export namespace RefreshCacheOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: RefreshCacheOutput): any => ({ ...obj, }); @@ -6224,6 +6713,9 @@ export interface RemoveTagsFromResourceInput { } export namespace RemoveTagsFromResourceInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: RemoveTagsFromResourceInput): any => ({ ...obj, }); @@ -6240,6 +6732,9 @@ export interface RemoveTagsFromResourceOutput { } export namespace RemoveTagsFromResourceOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: RemoveTagsFromResourceOutput): any => ({ ...obj, }); @@ -6254,6 +6749,9 @@ export interface ResetCacheInput { } export namespace ResetCacheInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: ResetCacheInput): any => ({ ...obj, }); @@ -6268,6 +6766,9 @@ export interface ResetCacheOutput { } export namespace ResetCacheOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: ResetCacheOutput): any => ({ ...obj, }); @@ -6295,6 +6796,9 @@ export interface RetrieveTapeArchiveInput { } export namespace RetrieveTapeArchiveInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: RetrieveTapeArchiveInput): any => ({ ...obj, }); @@ -6311,6 +6815,9 @@ export interface RetrieveTapeArchiveOutput { } export namespace RetrieveTapeArchiveOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: RetrieveTapeArchiveOutput): any => ({ ...obj, }); @@ -6334,6 +6841,9 @@ export interface RetrieveTapeRecoveryPointInput { } export namespace RetrieveTapeRecoveryPointInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: RetrieveTapeRecoveryPointInput): any => ({ ...obj, }); @@ -6351,6 +6861,9 @@ export interface RetrieveTapeRecoveryPointOutput { } export namespace RetrieveTapeRecoveryPointOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: RetrieveTapeRecoveryPointOutput): any => ({ ...obj, }); @@ -6373,6 +6886,9 @@ export interface SetLocalConsolePasswordInput { } export namespace SetLocalConsolePasswordInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: SetLocalConsolePasswordInput): any => ({ ...obj, ...(obj.LocalConsolePassword && { LocalConsolePassword: SENSITIVE_STRING }), @@ -6388,6 +6904,9 @@ export interface SetLocalConsolePasswordOutput { } export namespace SetLocalConsolePasswordOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: SetLocalConsolePasswordOutput): any => ({ ...obj, }); @@ -6410,6 +6929,9 @@ export interface SetSMBGuestPasswordInput { } export namespace SetSMBGuestPasswordInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: SetSMBGuestPasswordInput): any => ({ ...obj, ...(obj.Password && { Password: SENSITIVE_STRING }), @@ -6425,6 +6947,9 @@ export interface SetSMBGuestPasswordOutput { } export namespace SetSMBGuestPasswordOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: SetSMBGuestPasswordOutput): any => ({ ...obj, }); @@ -6443,6 +6968,9 @@ export interface ShutdownGatewayInput { } export namespace ShutdownGatewayInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: ShutdownGatewayInput): any => ({ ...obj, }); @@ -6461,6 +6989,9 @@ export interface ShutdownGatewayOutput { } export namespace ShutdownGatewayOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: ShutdownGatewayOutput): any => ({ ...obj, }); @@ -6475,6 +7006,9 @@ export interface StartAvailabilityMonitorTestInput { } export namespace StartAvailabilityMonitorTestInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: StartAvailabilityMonitorTestInput): any => ({ ...obj, }); @@ -6489,6 +7023,9 @@ export interface StartAvailabilityMonitorTestOutput { } export namespace StartAvailabilityMonitorTestOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: StartAvailabilityMonitorTestOutput): any => ({ ...obj, }); @@ -6506,6 +7043,9 @@ export interface StartGatewayInput { } export namespace StartGatewayInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: StartGatewayInput): any => ({ ...obj, }); @@ -6524,6 +7064,9 @@ export interface StartGatewayOutput { } export namespace StartGatewayOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: StartGatewayOutput): any => ({ ...obj, }); @@ -6544,6 +7087,9 @@ export interface UpdateAutomaticTapeCreationPolicyInput { } export namespace UpdateAutomaticTapeCreationPolicyInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateAutomaticTapeCreationPolicyInput): any => ({ ...obj, }); @@ -6558,6 +7104,9 @@ export interface UpdateAutomaticTapeCreationPolicyOutput { } export namespace UpdateAutomaticTapeCreationPolicyOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateAutomaticTapeCreationPolicyOutput): any => ({ ...obj, }); @@ -6598,6 +7147,9 @@ export interface UpdateBandwidthRateLimitInput { } export namespace UpdateBandwidthRateLimitInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateBandwidthRateLimitInput): any => ({ ...obj, }); @@ -6616,6 +7168,9 @@ export interface UpdateBandwidthRateLimitOutput { } export namespace UpdateBandwidthRateLimitOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateBandwidthRateLimitOutput): any => ({ ...obj, }); @@ -6638,6 +7193,9 @@ export interface UpdateBandwidthRateLimitScheduleInput { } export namespace UpdateBandwidthRateLimitScheduleInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateBandwidthRateLimitScheduleInput): any => ({ ...obj, }); @@ -6652,6 +7210,9 @@ export interface UpdateBandwidthRateLimitScheduleOutput { } export namespace UpdateBandwidthRateLimitScheduleOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateBandwidthRateLimitScheduleOutput): any => ({ ...obj, }); @@ -6720,6 +7281,9 @@ export interface UpdateChapCredentialsInput { } export namespace UpdateChapCredentialsInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateChapCredentialsInput): any => ({ ...obj, ...(obj.SecretToAuthenticateInitiator && { SecretToAuthenticateInitiator: SENSITIVE_STRING }), @@ -6745,6 +7309,9 @@ export interface UpdateChapCredentialsOutput { } export namespace UpdateChapCredentialsOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateChapCredentialsOutput): any => ({ ...obj, }); @@ -6780,6 +7347,9 @@ export interface UpdateFileSystemAssociationInput { } export namespace UpdateFileSystemAssociationInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateFileSystemAssociationInput): any => ({ ...obj, ...(obj.Password && { Password: SENSITIVE_STRING }), @@ -6794,6 +7364,9 @@ export interface UpdateFileSystemAssociationOutput { } export namespace UpdateFileSystemAssociationOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateFileSystemAssociationOutput): any => ({ ...obj, }); @@ -6828,6 +7401,9 @@ export interface UpdateGatewayInformationInput { } export namespace UpdateGatewayInformationInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateGatewayInformationInput): any => ({ ...obj, }); @@ -6851,6 +7427,9 @@ export interface UpdateGatewayInformationOutput { } export namespace UpdateGatewayInformationOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateGatewayInformationOutput): any => ({ ...obj, }); @@ -6868,6 +7447,9 @@ export interface UpdateGatewaySoftwareNowInput { } export namespace UpdateGatewaySoftwareNowInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateGatewaySoftwareNowInput): any => ({ ...obj, }); @@ -6886,6 +7468,9 @@ export interface UpdateGatewaySoftwareNowOutput { } export namespace UpdateGatewaySoftwareNowOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateGatewaySoftwareNowOutput): any => ({ ...obj, }); @@ -6953,6 +7538,9 @@ export interface UpdateMaintenanceStartTimeInput { } export namespace UpdateMaintenanceStartTimeInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateMaintenanceStartTimeInput): any => ({ ...obj, }); @@ -6971,6 +7559,9 @@ export interface UpdateMaintenanceStartTimeOutput { } export namespace UpdateMaintenanceStartTimeOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateMaintenanceStartTimeOutput): any => ({ ...obj, }); @@ -7133,6 +7724,9 @@ export interface UpdateNFSFileShareInput { } export namespace UpdateNFSFileShareInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateNFSFileShareInput): any => ({ ...obj, }); @@ -7149,6 +7743,9 @@ export interface UpdateNFSFileShareOutput { } export namespace UpdateNFSFileShareOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateNFSFileShareOutput): any => ({ ...obj, }); @@ -7339,6 +7936,9 @@ export interface UpdateSMBFileShareInput { } export namespace UpdateSMBFileShareInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateSMBFileShareInput): any => ({ ...obj, }); @@ -7355,6 +7955,9 @@ export interface UpdateSMBFileShareOutput { } export namespace UpdateSMBFileShareOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateSMBFileShareOutput): any => ({ ...obj, }); @@ -7374,6 +7977,9 @@ export interface UpdateSMBFileShareVisibilityInput { } export namespace UpdateSMBFileShareVisibilityInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateSMBFileShareVisibilityInput): any => ({ ...obj, }); @@ -7388,6 +7994,9 @@ export interface UpdateSMBFileShareVisibilityOutput { } export namespace UpdateSMBFileShareVisibilityOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateSMBFileShareVisibilityOutput): any => ({ ...obj, }); @@ -7420,6 +8029,9 @@ export interface UpdateSMBSecurityStrategyInput { } export namespace UpdateSMBSecurityStrategyInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateSMBSecurityStrategyInput): any => ({ ...obj, }); @@ -7434,6 +8046,9 @@ export interface UpdateSMBSecurityStrategyOutput { } export namespace UpdateSMBSecurityStrategyOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateSMBSecurityStrategyOutput): any => ({ ...obj, }); @@ -7504,6 +8119,9 @@ export interface UpdateSnapshotScheduleInput { } export namespace UpdateSnapshotScheduleInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateSnapshotScheduleInput): any => ({ ...obj, }); @@ -7522,6 +8140,9 @@ export interface UpdateSnapshotScheduleOutput { } export namespace UpdateSnapshotScheduleOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateSnapshotScheduleOutput): any => ({ ...obj, }); @@ -7544,6 +8165,9 @@ export interface UpdateVTLDeviceTypeInput { } export namespace UpdateVTLDeviceTypeInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateVTLDeviceTypeInput): any => ({ ...obj, }); @@ -7560,6 +8184,9 @@ export interface UpdateVTLDeviceTypeOutput { } export namespace UpdateVTLDeviceTypeOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateVTLDeviceTypeOutput): any => ({ ...obj, }); diff --git a/clients/client-sts/commands/AssumeRoleCommand.ts b/clients/client-sts/commands/AssumeRoleCommand.ts index bd8f69585ba9..787e2b50ed91 100644 --- a/clients/client-sts/commands/AssumeRoleCommand.ts +++ b/clients/client-sts/commands/AssumeRoleCommand.ts @@ -103,6 +103,20 @@ export interface AssumeRoleCommandOutput extends AssumeRoleResponse, __MetadataB * 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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { STSClient, AssumeRoleCommand } from "@aws-sdk/client-sts"; // ES Modules import + * // const { STSClient, AssumeRoleCommand } = require("@aws-sdk/client-sts"); // CommonJS import + * const client = new STSClient(config); + * const command = new AssumeRoleCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link AssumeRoleCommandInput} for command's `input` shape. + * @see {@link AssumeRoleCommandOutput} for command's `response` shape. + * @see {@link STSClientResolvedConfig | config} for command's `input` shape. + * */ export class AssumeRoleCommand extends $Command< AssumeRoleCommandInput, diff --git a/clients/client-sts/commands/AssumeRoleWithSAMLCommand.ts b/clients/client-sts/commands/AssumeRoleWithSAMLCommand.ts index 409df658e309..380b65940417 100644 --- a/clients/client-sts/commands/AssumeRoleWithSAMLCommand.ts +++ b/clients/client-sts/commands/AssumeRoleWithSAMLCommand.ts @@ -153,6 +153,20 @@ export interface AssumeRoleWithSAMLCommandOutput extends AssumeRoleWithSAMLRespo * IAM User Guide.

* * + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { STSClient, AssumeRoleWithSAMLCommand } from "@aws-sdk/client-sts"; // ES Modules import + * // const { STSClient, AssumeRoleWithSAMLCommand } = require("@aws-sdk/client-sts"); // CommonJS import + * const client = new STSClient(config); + * const command = new AssumeRoleWithSAMLCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link AssumeRoleWithSAMLCommandInput} for command's `input` shape. + * @see {@link AssumeRoleWithSAMLCommandOutput} for command's `response` shape. + * @see {@link STSClientResolvedConfig | config} for command's `input` shape. + * */ export class AssumeRoleWithSAMLCommand extends $Command< AssumeRoleWithSAMLCommandInput, diff --git a/clients/client-sts/commands/AssumeRoleWithWebIdentityCommand.ts b/clients/client-sts/commands/AssumeRoleWithWebIdentityCommand.ts index 6f66374c10ee..0155f85c1d5c 100644 --- a/clients/client-sts/commands/AssumeRoleWithWebIdentityCommand.ts +++ b/clients/client-sts/commands/AssumeRoleWithWebIdentityCommand.ts @@ -157,6 +157,20 @@ export interface AssumeRoleWithWebIdentityCommandOutput extends AssumeRoleWithWe * to content in Amazon S3.

* * + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { STSClient, AssumeRoleWithWebIdentityCommand } from "@aws-sdk/client-sts"; // ES Modules import + * // const { STSClient, AssumeRoleWithWebIdentityCommand } = require("@aws-sdk/client-sts"); // CommonJS import + * const client = new STSClient(config); + * const command = new AssumeRoleWithWebIdentityCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link AssumeRoleWithWebIdentityCommandInput} for command's `input` shape. + * @see {@link AssumeRoleWithWebIdentityCommandOutput} for command's `response` shape. + * @see {@link STSClientResolvedConfig | config} for command's `input` shape. + * */ export class AssumeRoleWithWebIdentityCommand extends $Command< AssumeRoleWithWebIdentityCommandInput, diff --git a/clients/client-sts/commands/DecodeAuthorizationMessageCommand.ts b/clients/client-sts/commands/DecodeAuthorizationMessageCommand.ts index 05e0007ea3ca..84fade458153 100644 --- a/clients/client-sts/commands/DecodeAuthorizationMessageCommand.ts +++ b/clients/client-sts/commands/DecodeAuthorizationMessageCommand.ts @@ -58,6 +58,20 @@ export interface DecodeAuthorizationMessageCommandOutput extends DecodeAuthoriza *

The values of condition keys in the context of the user's request.

* * + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { STSClient, DecodeAuthorizationMessageCommand } from "@aws-sdk/client-sts"; // ES Modules import + * // const { STSClient, DecodeAuthorizationMessageCommand } = require("@aws-sdk/client-sts"); // CommonJS import + * const client = new STSClient(config); + * const command = new DecodeAuthorizationMessageCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DecodeAuthorizationMessageCommandInput} for command's `input` shape. + * @see {@link DecodeAuthorizationMessageCommandOutput} for command's `response` shape. + * @see {@link STSClientResolvedConfig | config} for command's `input` shape. + * */ export class DecodeAuthorizationMessageCommand extends $Command< DecodeAuthorizationMessageCommandInput, diff --git a/clients/client-sts/commands/GetAccessKeyInfoCommand.ts b/clients/client-sts/commands/GetAccessKeyInfoCommand.ts index 803c377c5134..3d3060526880 100644 --- a/clients/client-sts/commands/GetAccessKeyInfoCommand.ts +++ b/clients/client-sts/commands/GetAccessKeyInfoCommand.ts @@ -40,6 +40,20 @@ export interface GetAccessKeyInfoCommandOutput extends GetAccessKeyInfoResponse, *

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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { STSClient, GetAccessKeyInfoCommand } from "@aws-sdk/client-sts"; // ES Modules import + * // const { STSClient, GetAccessKeyInfoCommand } = require("@aws-sdk/client-sts"); // CommonJS import + * const client = new STSClient(config); + * const command = new GetAccessKeyInfoCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetAccessKeyInfoCommandInput} for command's `input` shape. + * @see {@link GetAccessKeyInfoCommandOutput} for command's `response` shape. + * @see {@link STSClientResolvedConfig | config} for command's `input` shape. + * */ export class GetAccessKeyInfoCommand extends $Command< GetAccessKeyInfoCommandInput, diff --git a/clients/client-sts/commands/GetCallerIdentityCommand.ts b/clients/client-sts/commands/GetCallerIdentityCommand.ts index 16993afba3b7..20ed33ca2d26 100644 --- a/clients/client-sts/commands/GetCallerIdentityCommand.ts +++ b/clients/client-sts/commands/GetCallerIdentityCommand.ts @@ -32,6 +32,20 @@ export interface GetCallerIdentityCommandOutput extends GetCallerIdentityRespons * 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.

* + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { STSClient, GetCallerIdentityCommand } from "@aws-sdk/client-sts"; // ES Modules import + * // const { STSClient, GetCallerIdentityCommand } = require("@aws-sdk/client-sts"); // CommonJS import + * const client = new STSClient(config); + * const command = new GetCallerIdentityCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetCallerIdentityCommandInput} for command's `input` shape. + * @see {@link GetCallerIdentityCommandOutput} for command's `response` shape. + * @see {@link STSClientResolvedConfig | config} for command's `input` shape. + * */ export class GetCallerIdentityCommand extends $Command< GetCallerIdentityCommandInput, diff --git a/clients/client-sts/commands/GetFederationTokenCommand.ts b/clients/client-sts/commands/GetFederationTokenCommand.ts index 5e9c659d2ecd..fd04a7e2e1b8 100644 --- a/clients/client-sts/commands/GetFederationTokenCommand.ts +++ b/clients/client-sts/commands/GetFederationTokenCommand.ts @@ -161,6 +161,20 @@ export interface GetFederationTokenCommandOutput extends GetFederationTokenRespo * 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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { STSClient, GetFederationTokenCommand } from "@aws-sdk/client-sts"; // ES Modules import + * // const { STSClient, GetFederationTokenCommand } = require("@aws-sdk/client-sts"); // CommonJS import + * const client = new STSClient(config); + * const command = new GetFederationTokenCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetFederationTokenCommandInput} for command's `input` shape. + * @see {@link GetFederationTokenCommandOutput} for command's `response` shape. + * @see {@link STSClientResolvedConfig | config} for command's `input` shape. + * */ export class GetFederationTokenCommand extends $Command< GetFederationTokenCommandInput, diff --git a/clients/client-sts/commands/GetSessionTokenCommand.ts b/clients/client-sts/commands/GetSessionTokenCommand.ts index 37685bfdbec7..ed06fdb201ed 100644 --- a/clients/client-sts/commands/GetSessionTokenCommand.ts +++ b/clients/client-sts/commands/GetSessionTokenCommand.ts @@ -74,6 +74,20 @@ export interface GetSessionTokenCommandOutput extends GetSessionTokenResponse, _ * credentials, go to Temporary * Credentials for Users in Untrusted Environments in the * IAM User Guide.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { STSClient, GetSessionTokenCommand } from "@aws-sdk/client-sts"; // ES Modules import + * // const { STSClient, GetSessionTokenCommand } = require("@aws-sdk/client-sts"); // CommonJS import + * const client = new STSClient(config); + * const command = new GetSessionTokenCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetSessionTokenCommandInput} for command's `input` shape. + * @see {@link GetSessionTokenCommandOutput} for command's `response` shape. + * @see {@link STSClientResolvedConfig | config} for command's `input` shape. + * */ export class GetSessionTokenCommand extends $Command< GetSessionTokenCommandInput, diff --git a/clients/client-sts/models/models_0.ts b/clients/client-sts/models/models_0.ts index 71721fd19741..c47802e708f1 100644 --- a/clients/client-sts/models/models_0.ts +++ b/clients/client-sts/models/models_0.ts @@ -21,6 +21,9 @@ export interface AssumedRoleUser { } export namespace AssumedRoleUser { + /** + * @internal + */ export const filterSensitiveLog = (obj: AssumedRoleUser): any => ({ ...obj, }); @@ -40,6 +43,9 @@ export interface PolicyDescriptorType { } export namespace PolicyDescriptorType { + /** + * @internal + */ export const filterSensitiveLog = (obj: PolicyDescriptorType): any => ({ ...obj, }); @@ -70,6 +76,9 @@ export interface Tag { } export namespace Tag { + /** + * @internal + */ export const filterSensitiveLog = (obj: Tag): any => ({ ...obj, }); @@ -277,6 +286,9 @@ export interface AssumeRoleRequest { } export namespace AssumeRoleRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: AssumeRoleRequest): any => ({ ...obj, }); @@ -309,6 +321,9 @@ export interface Credentials { } export namespace Credentials { + /** + * @internal + */ export const filterSensitiveLog = (obj: Credentials): any => ({ ...obj, }); @@ -364,6 +379,9 @@ export interface AssumeRoleResponse { } export namespace AssumeRoleResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: AssumeRoleResponse): any => ({ ...obj, }); @@ -380,6 +398,9 @@ export interface ExpiredTokenException extends __SmithyException, $MetadataBeare } export namespace ExpiredTokenException { + /** + * @internal + */ export const filterSensitiveLog = (obj: ExpiredTokenException): any => ({ ...obj, }); @@ -396,6 +417,9 @@ export interface MalformedPolicyDocumentException extends __SmithyException, $Me } export namespace MalformedPolicyDocumentException { + /** + * @internal + */ export const filterSensitiveLog = (obj: MalformedPolicyDocumentException): any => ({ ...obj, }); @@ -419,6 +443,9 @@ export interface PackedPolicyTooLargeException extends __SmithyException, $Metad } export namespace PackedPolicyTooLargeException { + /** + * @internal + */ export const filterSensitiveLog = (obj: PackedPolicyTooLargeException): any => ({ ...obj, }); @@ -438,6 +465,9 @@ export interface RegionDisabledException extends __SmithyException, $MetadataBea } export namespace RegionDisabledException { + /** + * @internal + */ export const filterSensitiveLog = (obj: RegionDisabledException): any => ({ ...obj, }); @@ -542,6 +572,9 @@ export interface AssumeRoleWithSAMLRequest { } export namespace AssumeRoleWithSAMLRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: AssumeRoleWithSAMLRequest): any => ({ ...obj, }); @@ -647,6 +680,9 @@ export interface AssumeRoleWithSAMLResponse { } export namespace AssumeRoleWithSAMLResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: AssumeRoleWithSAMLResponse): any => ({ ...obj, }); @@ -665,6 +701,9 @@ export interface IDPRejectedClaimException extends __SmithyException, $MetadataB } export namespace IDPRejectedClaimException { + /** + * @internal + */ export const filterSensitiveLog = (obj: IDPRejectedClaimException): any => ({ ...obj, }); @@ -681,6 +720,9 @@ export interface InvalidIdentityTokenException extends __SmithyException, $Metad } export namespace InvalidIdentityTokenException { + /** + * @internal + */ export const filterSensitiveLog = (obj: InvalidIdentityTokenException): any => ({ ...obj, }); @@ -799,6 +841,9 @@ export interface AssumeRoleWithWebIdentityRequest { } export namespace AssumeRoleWithWebIdentityRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: AssumeRoleWithWebIdentityRequest): any => ({ ...obj, }); @@ -883,6 +928,9 @@ export interface AssumeRoleWithWebIdentityResponse { } export namespace AssumeRoleWithWebIdentityResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: AssumeRoleWithWebIdentityResponse): any => ({ ...obj, }); @@ -902,6 +950,9 @@ export interface IDPCommunicationErrorException extends __SmithyException, $Meta } export namespace IDPCommunicationErrorException { + /** + * @internal + */ export const filterSensitiveLog = (obj: IDPCommunicationErrorException): any => ({ ...obj, }); @@ -915,6 +966,9 @@ export interface DecodeAuthorizationMessageRequest { } export namespace DecodeAuthorizationMessageRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DecodeAuthorizationMessageRequest): any => ({ ...obj, }); @@ -932,6 +986,9 @@ export interface DecodeAuthorizationMessageResponse { } export namespace DecodeAuthorizationMessageResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DecodeAuthorizationMessageResponse): any => ({ ...obj, }); @@ -949,6 +1006,9 @@ export interface InvalidAuthorizationMessageException extends __SmithyException, } export namespace InvalidAuthorizationMessageException { + /** + * @internal + */ export const filterSensitiveLog = (obj: InvalidAuthorizationMessageException): any => ({ ...obj, }); @@ -964,6 +1024,9 @@ export interface GetAccessKeyInfoRequest { } export namespace GetAccessKeyInfoRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetAccessKeyInfoRequest): any => ({ ...obj, }); @@ -977,6 +1040,9 @@ export interface GetAccessKeyInfoResponse { } export namespace GetAccessKeyInfoResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetAccessKeyInfoResponse): any => ({ ...obj, }); @@ -985,6 +1051,9 @@ export namespace GetAccessKeyInfoResponse { export interface GetCallerIdentityRequest {} export namespace GetCallerIdentityRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetCallerIdentityRequest): any => ({ ...obj, }); @@ -1016,6 +1085,9 @@ export interface GetCallerIdentityResponse { } export namespace GetCallerIdentityResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetCallerIdentityResponse): any => ({ ...obj, }); @@ -1143,6 +1215,9 @@ export interface GetFederationTokenRequest { } export namespace GetFederationTokenRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetFederationTokenRequest): any => ({ ...obj, }); @@ -1167,6 +1242,9 @@ export interface FederatedUser { } export namespace FederatedUser { + /** + * @internal + */ export const filterSensitiveLog = (obj: FederatedUser): any => ({ ...obj, }); @@ -1204,6 +1282,9 @@ export interface GetFederationTokenResponse { } export namespace GetFederationTokenResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetFederationTokenResponse): any => ({ ...obj, }); @@ -1246,6 +1327,9 @@ export interface GetSessionTokenRequest { } export namespace GetSessionTokenRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetSessionTokenRequest): any => ({ ...obj, }); @@ -1269,6 +1353,9 @@ export interface GetSessionTokenResponse { } export namespace GetSessionTokenResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetSessionTokenResponse): any => ({ ...obj, }); diff --git a/clients/client-support/commands/AddAttachmentsToSetCommand.ts b/clients/client-support/commands/AddAttachmentsToSetCommand.ts index 828989d233b4..73736cefa984 100644 --- a/clients/client-support/commands/AddAttachmentsToSetCommand.ts +++ b/clients/client-support/commands/AddAttachmentsToSetCommand.ts @@ -39,6 +39,20 @@ export interface AddAttachmentsToSetCommandOutput extends AddAttachmentsToSetRes * * * + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { SupportClient, AddAttachmentsToSetCommand } from "@aws-sdk/client-support"; // ES Modules import + * // const { SupportClient, AddAttachmentsToSetCommand } = require("@aws-sdk/client-support"); // CommonJS import + * const client = new SupportClient(config); + * const command = new AddAttachmentsToSetCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link AddAttachmentsToSetCommandInput} for command's `input` shape. + * @see {@link AddAttachmentsToSetCommandOutput} for command's `response` shape. + * @see {@link SupportClientResolvedConfig | config} for command's `input` shape. + * */ export class AddAttachmentsToSetCommand extends $Command< AddAttachmentsToSetCommandInput, diff --git a/clients/client-support/commands/AddCommunicationToCaseCommand.ts b/clients/client-support/commands/AddCommunicationToCaseCommand.ts index 07772fb27a03..ad87fe6fb273 100644 --- a/clients/client-support/commands/AddCommunicationToCaseCommand.ts +++ b/clients/client-support/commands/AddCommunicationToCaseCommand.ts @@ -41,6 +41,20 @@ export interface AddCommunicationToCaseCommandOutput extends AddCommunicationToC * * * + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { SupportClient, AddCommunicationToCaseCommand } from "@aws-sdk/client-support"; // ES Modules import + * // const { SupportClient, AddCommunicationToCaseCommand } = require("@aws-sdk/client-support"); // CommonJS import + * const client = new SupportClient(config); + * const command = new AddCommunicationToCaseCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link AddCommunicationToCaseCommandInput} for command's `input` shape. + * @see {@link AddCommunicationToCaseCommandOutput} for command's `response` shape. + * @see {@link SupportClientResolvedConfig | config} for command's `input` shape. + * */ export class AddCommunicationToCaseCommand extends $Command< AddCommunicationToCaseCommandInput, diff --git a/clients/client-support/commands/CreateCaseCommand.ts b/clients/client-support/commands/CreateCaseCommand.ts index 7af5a97c0d87..fa1b0bc10ae0 100644 --- a/clients/client-support/commands/CreateCaseCommand.ts +++ b/clients/client-support/commands/CreateCaseCommand.ts @@ -54,6 +54,20 @@ export interface CreateCaseCommandOutput extends CreateCaseResponse, __MetadataB * * * + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { SupportClient, CreateCaseCommand } from "@aws-sdk/client-support"; // ES Modules import + * // const { SupportClient, CreateCaseCommand } = require("@aws-sdk/client-support"); // CommonJS import + * const client = new SupportClient(config); + * const command = new CreateCaseCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreateCaseCommandInput} for command's `input` shape. + * @see {@link CreateCaseCommandOutput} for command's `response` shape. + * @see {@link SupportClientResolvedConfig | config} for command's `input` shape. + * */ export class CreateCaseCommand extends $Command< CreateCaseCommandInput, diff --git a/clients/client-support/commands/DescribeAttachmentCommand.ts b/clients/client-support/commands/DescribeAttachmentCommand.ts index b2208f541fd8..88e59704a1b5 100644 --- a/clients/client-support/commands/DescribeAttachmentCommand.ts +++ b/clients/client-support/commands/DescribeAttachmentCommand.ts @@ -40,6 +40,20 @@ export interface DescribeAttachmentCommandOutput extends DescribeAttachmentRespo * * * + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { SupportClient, DescribeAttachmentCommand } from "@aws-sdk/client-support"; // ES Modules import + * // const { SupportClient, DescribeAttachmentCommand } = require("@aws-sdk/client-support"); // CommonJS import + * const client = new SupportClient(config); + * const command = new DescribeAttachmentCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeAttachmentCommandInput} for command's `input` shape. + * @see {@link DescribeAttachmentCommandOutput} for command's `response` shape. + * @see {@link SupportClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeAttachmentCommand extends $Command< DescribeAttachmentCommandInput, diff --git a/clients/client-support/commands/DescribeCasesCommand.ts b/clients/client-support/commands/DescribeCasesCommand.ts index 8e613bef3ee5..f77a19c79228 100644 --- a/clients/client-support/commands/DescribeCasesCommand.ts +++ b/clients/client-support/commands/DescribeCasesCommand.ts @@ -52,6 +52,20 @@ export interface DescribeCasesCommandOutput extends DescribeCasesResponse, __Met * * * + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { SupportClient, DescribeCasesCommand } from "@aws-sdk/client-support"; // ES Modules import + * // const { SupportClient, DescribeCasesCommand } = require("@aws-sdk/client-support"); // CommonJS import + * const client = new SupportClient(config); + * const command = new DescribeCasesCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeCasesCommandInput} for command's `input` shape. + * @see {@link DescribeCasesCommandOutput} for command's `response` shape. + * @see {@link SupportClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeCasesCommand extends $Command< DescribeCasesCommandInput, diff --git a/clients/client-support/commands/DescribeCommunicationsCommand.ts b/clients/client-support/commands/DescribeCommunicationsCommand.ts index 9bf60dede31b..8ccd2bdf67e2 100644 --- a/clients/client-support/commands/DescribeCommunicationsCommand.ts +++ b/clients/client-support/commands/DescribeCommunicationsCommand.ts @@ -45,6 +45,20 @@ export interface DescribeCommunicationsCommandOutput extends DescribeCommunicati * * * + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { SupportClient, DescribeCommunicationsCommand } from "@aws-sdk/client-support"; // ES Modules import + * // const { SupportClient, DescribeCommunicationsCommand } = require("@aws-sdk/client-support"); // CommonJS import + * const client = new SupportClient(config); + * const command = new DescribeCommunicationsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeCommunicationsCommandInput} for command's `input` shape. + * @see {@link DescribeCommunicationsCommandOutput} for command's `response` shape. + * @see {@link SupportClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeCommunicationsCommand extends $Command< DescribeCommunicationsCommandInput, diff --git a/clients/client-support/commands/DescribeServicesCommand.ts b/clients/client-support/commands/DescribeServicesCommand.ts index 2c49671accbe..0a8201208879 100644 --- a/clients/client-support/commands/DescribeServicesCommand.ts +++ b/clients/client-support/commands/DescribeServicesCommand.ts @@ -44,6 +44,20 @@ export interface DescribeServicesCommandOutput extends DescribeServicesResponse, * * * + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { SupportClient, DescribeServicesCommand } from "@aws-sdk/client-support"; // ES Modules import + * // const { SupportClient, DescribeServicesCommand } = require("@aws-sdk/client-support"); // CommonJS import + * const client = new SupportClient(config); + * const command = new DescribeServicesCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeServicesCommandInput} for command's `input` shape. + * @see {@link DescribeServicesCommandOutput} for command's `response` shape. + * @see {@link SupportClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeServicesCommand extends $Command< DescribeServicesCommandInput, diff --git a/clients/client-support/commands/DescribeSeverityLevelsCommand.ts b/clients/client-support/commands/DescribeSeverityLevelsCommand.ts index 9d4b5c19f26d..6e2b33edfba2 100644 --- a/clients/client-support/commands/DescribeSeverityLevelsCommand.ts +++ b/clients/client-support/commands/DescribeSeverityLevelsCommand.ts @@ -38,6 +38,20 @@ export interface DescribeSeverityLevelsCommandOutput extends DescribeSeverityLev * * * + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { SupportClient, DescribeSeverityLevelsCommand } from "@aws-sdk/client-support"; // ES Modules import + * // const { SupportClient, DescribeSeverityLevelsCommand } = require("@aws-sdk/client-support"); // CommonJS import + * const client = new SupportClient(config); + * const command = new DescribeSeverityLevelsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeSeverityLevelsCommandInput} for command's `input` shape. + * @see {@link DescribeSeverityLevelsCommandOutput} for command's `response` shape. + * @see {@link SupportClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeSeverityLevelsCommand extends $Command< DescribeSeverityLevelsCommandInput, diff --git a/clients/client-support/commands/DescribeTrustedAdvisorCheckRefreshStatusesCommand.ts b/clients/client-support/commands/DescribeTrustedAdvisorCheckRefreshStatusesCommand.ts index 88803923857f..f203ca32279b 100644 --- a/clients/client-support/commands/DescribeTrustedAdvisorCheckRefreshStatusesCommand.ts +++ b/clients/client-support/commands/DescribeTrustedAdvisorCheckRefreshStatusesCommand.ts @@ -47,6 +47,20 @@ export interface DescribeTrustedAdvisorCheckRefreshStatusesCommandOutput * * * + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { SupportClient, DescribeTrustedAdvisorCheckRefreshStatusesCommand } from "@aws-sdk/client-support"; // ES Modules import + * // const { SupportClient, DescribeTrustedAdvisorCheckRefreshStatusesCommand } = require("@aws-sdk/client-support"); // CommonJS import + * const client = new SupportClient(config); + * const command = new DescribeTrustedAdvisorCheckRefreshStatusesCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeTrustedAdvisorCheckRefreshStatusesCommandInput} for command's `input` shape. + * @see {@link DescribeTrustedAdvisorCheckRefreshStatusesCommandOutput} for command's `response` shape. + * @see {@link SupportClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeTrustedAdvisorCheckRefreshStatusesCommand extends $Command< DescribeTrustedAdvisorCheckRefreshStatusesCommandInput, diff --git a/clients/client-support/commands/DescribeTrustedAdvisorCheckResultCommand.ts b/clients/client-support/commands/DescribeTrustedAdvisorCheckResultCommand.ts index 9b9cb6087d03..86b2ce0cb4ed 100644 --- a/clients/client-support/commands/DescribeTrustedAdvisorCheckResultCommand.ts +++ b/clients/client-support/commands/DescribeTrustedAdvisorCheckResultCommand.ts @@ -81,6 +81,20 @@ export interface DescribeTrustedAdvisorCheckResultCommandOutput * * * + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { SupportClient, DescribeTrustedAdvisorCheckResultCommand } from "@aws-sdk/client-support"; // ES Modules import + * // const { SupportClient, DescribeTrustedAdvisorCheckResultCommand } = require("@aws-sdk/client-support"); // CommonJS import + * const client = new SupportClient(config); + * const command = new DescribeTrustedAdvisorCheckResultCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeTrustedAdvisorCheckResultCommandInput} for command's `input` shape. + * @see {@link DescribeTrustedAdvisorCheckResultCommandOutput} for command's `response` shape. + * @see {@link SupportClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeTrustedAdvisorCheckResultCommand extends $Command< DescribeTrustedAdvisorCheckResultCommandInput, diff --git a/clients/client-support/commands/DescribeTrustedAdvisorCheckSummariesCommand.ts b/clients/client-support/commands/DescribeTrustedAdvisorCheckSummariesCommand.ts index ab49026f77b8..0fc498a7e013 100644 --- a/clients/client-support/commands/DescribeTrustedAdvisorCheckSummariesCommand.ts +++ b/clients/client-support/commands/DescribeTrustedAdvisorCheckSummariesCommand.ts @@ -44,6 +44,20 @@ export interface DescribeTrustedAdvisorCheckSummariesCommandOutput * * * + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { SupportClient, DescribeTrustedAdvisorCheckSummariesCommand } from "@aws-sdk/client-support"; // ES Modules import + * // const { SupportClient, DescribeTrustedAdvisorCheckSummariesCommand } = require("@aws-sdk/client-support"); // CommonJS import + * const client = new SupportClient(config); + * const command = new DescribeTrustedAdvisorCheckSummariesCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeTrustedAdvisorCheckSummariesCommandInput} for command's `input` shape. + * @see {@link DescribeTrustedAdvisorCheckSummariesCommandOutput} for command's `response` shape. + * @see {@link SupportClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeTrustedAdvisorCheckSummariesCommand extends $Command< DescribeTrustedAdvisorCheckSummariesCommandInput, diff --git a/clients/client-support/commands/DescribeTrustedAdvisorChecksCommand.ts b/clients/client-support/commands/DescribeTrustedAdvisorChecksCommand.ts index 7e3876dff676..b7a644f620a3 100644 --- a/clients/client-support/commands/DescribeTrustedAdvisorChecksCommand.ts +++ b/clients/client-support/commands/DescribeTrustedAdvisorChecksCommand.ts @@ -41,6 +41,20 @@ export interface DescribeTrustedAdvisorChecksCommandOutput * * * + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { SupportClient, DescribeTrustedAdvisorChecksCommand } from "@aws-sdk/client-support"; // ES Modules import + * // const { SupportClient, DescribeTrustedAdvisorChecksCommand } = require("@aws-sdk/client-support"); // CommonJS import + * const client = new SupportClient(config); + * const command = new DescribeTrustedAdvisorChecksCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeTrustedAdvisorChecksCommandInput} for command's `input` shape. + * @see {@link DescribeTrustedAdvisorChecksCommandOutput} for command's `response` shape. + * @see {@link SupportClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeTrustedAdvisorChecksCommand extends $Command< DescribeTrustedAdvisorChecksCommandInput, diff --git a/clients/client-support/commands/RefreshTrustedAdvisorCheckCommand.ts b/clients/client-support/commands/RefreshTrustedAdvisorCheckCommand.ts index 6af5e703955a..b21045f7ebff 100644 --- a/clients/client-support/commands/RefreshTrustedAdvisorCheckCommand.ts +++ b/clients/client-support/commands/RefreshTrustedAdvisorCheckCommand.ts @@ -45,6 +45,20 @@ export interface RefreshTrustedAdvisorCheckCommandOutput extends RefreshTrustedA * * * + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { SupportClient, RefreshTrustedAdvisorCheckCommand } from "@aws-sdk/client-support"; // ES Modules import + * // const { SupportClient, RefreshTrustedAdvisorCheckCommand } = require("@aws-sdk/client-support"); // CommonJS import + * const client = new SupportClient(config); + * const command = new RefreshTrustedAdvisorCheckCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link RefreshTrustedAdvisorCheckCommandInput} for command's `input` shape. + * @see {@link RefreshTrustedAdvisorCheckCommandOutput} for command's `response` shape. + * @see {@link SupportClientResolvedConfig | config} for command's `input` shape. + * */ export class RefreshTrustedAdvisorCheckCommand extends $Command< RefreshTrustedAdvisorCheckCommandInput, diff --git a/clients/client-support/commands/ResolveCaseCommand.ts b/clients/client-support/commands/ResolveCaseCommand.ts index 1fab2bb0fcd6..36b603859785 100644 --- a/clients/client-support/commands/ResolveCaseCommand.ts +++ b/clients/client-support/commands/ResolveCaseCommand.ts @@ -37,6 +37,20 @@ export interface ResolveCaseCommandOutput extends ResolveCaseResponse, __Metadat * * * + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { SupportClient, ResolveCaseCommand } from "@aws-sdk/client-support"; // ES Modules import + * // const { SupportClient, ResolveCaseCommand } = require("@aws-sdk/client-support"); // CommonJS import + * const client = new SupportClient(config); + * const command = new ResolveCaseCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ResolveCaseCommandInput} for command's `input` shape. + * @see {@link ResolveCaseCommandOutput} for command's `response` shape. + * @see {@link SupportClientResolvedConfig | config} for command's `input` shape. + * */ export class ResolveCaseCommand extends $Command< ResolveCaseCommandInput, diff --git a/clients/client-support/models/models_0.ts b/clients/client-support/models/models_0.ts index 1d2af8fe121d..11dd5e90d107 100644 --- a/clients/client-support/models/models_0.ts +++ b/clients/client-support/models/models_0.ts @@ -18,6 +18,9 @@ export interface Attachment { } export namespace Attachment { + /** + * @internal + */ export const filterSensitiveLog = (obj: Attachment): any => ({ ...obj, }); @@ -45,6 +48,9 @@ export interface AddAttachmentsToSetRequest { } export namespace AddAttachmentsToSetRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: AddAttachmentsToSetRequest): any => ({ ...obj, }); @@ -69,6 +75,9 @@ export interface AddAttachmentsToSetResponse { } export namespace AddAttachmentsToSetResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: AddAttachmentsToSetResponse): any => ({ ...obj, }); @@ -89,6 +98,9 @@ export interface AttachmentLimitExceeded extends __SmithyException, $MetadataBea } export namespace AttachmentLimitExceeded { + /** + * @internal + */ export const filterSensitiveLog = (obj: AttachmentLimitExceeded): any => ({ ...obj, }); @@ -109,6 +121,9 @@ export interface AttachmentSetExpired extends __SmithyException, $MetadataBearer } export namespace AttachmentSetExpired { + /** + * @internal + */ export const filterSensitiveLog = (obj: AttachmentSetExpired): any => ({ ...obj, }); @@ -127,6 +142,9 @@ export interface AttachmentSetIdNotFound extends __SmithyException, $MetadataBea } export namespace AttachmentSetIdNotFound { + /** + * @internal + */ export const filterSensitiveLog = (obj: AttachmentSetIdNotFound): any => ({ ...obj, }); @@ -147,6 +165,9 @@ export interface AttachmentSetSizeLimitExceeded extends __SmithyException, $Meta } export namespace AttachmentSetSizeLimitExceeded { + /** + * @internal + */ export const filterSensitiveLog = (obj: AttachmentSetSizeLimitExceeded): any => ({ ...obj, }); @@ -165,6 +186,9 @@ export interface InternalServerError extends __SmithyException, $MetadataBearer } export namespace InternalServerError { + /** + * @internal + */ export const filterSensitiveLog = (obj: InternalServerError): any => ({ ...obj, }); @@ -198,6 +222,9 @@ export interface AddCommunicationToCaseRequest { } export namespace AddCommunicationToCaseRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: AddCommunicationToCaseRequest): any => ({ ...obj, }); @@ -215,6 +242,9 @@ export interface AddCommunicationToCaseResponse { } export namespace AddCommunicationToCaseResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: AddCommunicationToCaseResponse): any => ({ ...obj, }); @@ -233,6 +263,9 @@ export interface CaseIdNotFound extends __SmithyException, $MetadataBearer { } export namespace CaseIdNotFound { + /** + * @internal + */ export const filterSensitiveLog = (obj: CaseIdNotFound): any => ({ ...obj, }); @@ -255,6 +288,9 @@ export interface AttachmentDetails { } export namespace AttachmentDetails { + /** + * @internal + */ export const filterSensitiveLog = (obj: AttachmentDetails): any => ({ ...obj, }); @@ -273,6 +309,9 @@ export interface AttachmentIdNotFound extends __SmithyException, $MetadataBearer } export namespace AttachmentIdNotFound { + /** + * @internal + */ export const filterSensitiveLog = (obj: AttachmentIdNotFound): any => ({ ...obj, }); @@ -292,6 +331,9 @@ export interface CaseCreationLimitExceeded extends __SmithyException, $MetadataB } export namespace CaseCreationLimitExceeded { + /** + * @internal + */ export const filterSensitiveLog = (obj: CaseCreationLimitExceeded): any => ({ ...obj, }); @@ -364,6 +406,9 @@ export interface CreateCaseRequest { } export namespace CreateCaseRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateCaseRequest): any => ({ ...obj, }); @@ -383,6 +428,9 @@ export interface CreateCaseResponse { } export namespace CreateCaseResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateCaseResponse): any => ({ ...obj, }); @@ -403,6 +451,9 @@ export interface DescribeAttachmentLimitExceeded extends __SmithyException, $Met } export namespace DescribeAttachmentLimitExceeded { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeAttachmentLimitExceeded): any => ({ ...obj, }); @@ -416,6 +467,9 @@ export interface DescribeAttachmentRequest { } export namespace DescribeAttachmentRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeAttachmentRequest): any => ({ ...obj, }); @@ -436,6 +490,9 @@ export interface DescribeAttachmentResponse { } export namespace DescribeAttachmentResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeAttachmentResponse): any => ({ ...obj, }); @@ -496,6 +553,9 @@ export interface DescribeCasesRequest { } export namespace DescribeCasesRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeCasesRequest): any => ({ ...obj, }); @@ -541,6 +601,9 @@ export interface Communication { } export namespace Communication { + /** + * @internal + */ export const filterSensitiveLog = (obj: Communication): any => ({ ...obj, }); @@ -562,6 +625,9 @@ export interface RecentCaseCommunications { } export namespace RecentCaseCommunications { + /** + * @internal + */ export const filterSensitiveLog = (obj: RecentCaseCommunications): any => ({ ...obj, }); @@ -777,6 +843,9 @@ export interface CaseDetails { } export namespace CaseDetails { + /** + * @internal + */ export const filterSensitiveLog = (obj: CaseDetails): any => ({ ...obj, }); @@ -800,6 +869,9 @@ export interface DescribeCasesResponse { } export namespace DescribeCasesResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeCasesResponse): any => ({ ...obj, }); @@ -838,6 +910,9 @@ export interface DescribeCommunicationsRequest { } export namespace DescribeCommunicationsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeCommunicationsRequest): any => ({ ...obj, }); @@ -860,6 +935,9 @@ export interface DescribeCommunicationsResponse { } export namespace DescribeCommunicationsResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeCommunicationsResponse): any => ({ ...obj, }); @@ -880,6 +958,9 @@ export interface DescribeServicesRequest { } export namespace DescribeServicesRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeServicesRequest): any => ({ ...obj, }); @@ -903,6 +984,9 @@ export interface Category { } export namespace Category { + /** + * @internal + */ export const filterSensitiveLog = (obj: Category): any => ({ ...obj, }); @@ -934,6 +1018,9 @@ export interface Service { } export namespace Service { + /** + * @internal + */ export const filterSensitiveLog = (obj: Service): any => ({ ...obj, }); @@ -951,6 +1038,9 @@ export interface DescribeServicesResponse { } export namespace DescribeServicesResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeServicesResponse): any => ({ ...obj, }); @@ -966,6 +1056,9 @@ export interface DescribeSeverityLevelsRequest { } export namespace DescribeSeverityLevelsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeSeverityLevelsRequest): any => ({ ...obj, }); @@ -1023,6 +1116,9 @@ export interface SeverityLevel { } export namespace SeverityLevel { + /** + * @internal + */ export const filterSensitiveLog = (obj: SeverityLevel): any => ({ ...obj, }); @@ -1041,6 +1137,9 @@ export interface DescribeSeverityLevelsResponse { } export namespace DescribeSeverityLevelsResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeSeverityLevelsResponse): any => ({ ...obj, }); @@ -1058,6 +1157,9 @@ export interface DescribeTrustedAdvisorCheckRefreshStatusesRequest { } export namespace DescribeTrustedAdvisorCheckRefreshStatusesRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeTrustedAdvisorCheckRefreshStatusesRequest): any => ({ ...obj, }); @@ -1111,6 +1213,9 @@ export interface TrustedAdvisorCheckRefreshStatus { } export namespace TrustedAdvisorCheckRefreshStatus { + /** + * @internal + */ export const filterSensitiveLog = (obj: TrustedAdvisorCheckRefreshStatus): any => ({ ...obj, }); @@ -1127,6 +1232,9 @@ export interface DescribeTrustedAdvisorCheckRefreshStatusesResponse { } export namespace DescribeTrustedAdvisorCheckRefreshStatusesResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeTrustedAdvisorCheckRefreshStatusesResponse): any => ({ ...obj, }); @@ -1150,6 +1258,9 @@ export interface DescribeTrustedAdvisorCheckResultRequest { } export namespace DescribeTrustedAdvisorCheckResultRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeTrustedAdvisorCheckResultRequest): any => ({ ...obj, }); @@ -1174,6 +1285,9 @@ export interface TrustedAdvisorCostOptimizingSummary { } export namespace TrustedAdvisorCostOptimizingSummary { + /** + * @internal + */ export const filterSensitiveLog = (obj: TrustedAdvisorCostOptimizingSummary): any => ({ ...obj, }); @@ -1192,6 +1306,9 @@ export interface TrustedAdvisorCategorySpecificSummary { } export namespace TrustedAdvisorCategorySpecificSummary { + /** + * @internal + */ export const filterSensitiveLog = (obj: TrustedAdvisorCategorySpecificSummary): any => ({ ...obj, }); @@ -1232,6 +1349,9 @@ export interface TrustedAdvisorResourceDetail { } export namespace TrustedAdvisorResourceDetail { + /** + * @internal + */ export const filterSensitiveLog = (obj: TrustedAdvisorResourceDetail): any => ({ ...obj, }); @@ -1266,6 +1386,9 @@ export interface TrustedAdvisorResourcesSummary { } export namespace TrustedAdvisorResourcesSummary { + /** + * @internal + */ export const filterSensitiveLog = (obj: TrustedAdvisorResourcesSummary): any => ({ ...obj, }); @@ -1309,6 +1432,9 @@ export interface TrustedAdvisorCheckResult { } export namespace TrustedAdvisorCheckResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: TrustedAdvisorCheckResult): any => ({ ...obj, }); @@ -1325,6 +1451,9 @@ export interface DescribeTrustedAdvisorCheckResultResponse { } export namespace DescribeTrustedAdvisorCheckResultResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeTrustedAdvisorCheckResultResponse): any => ({ ...obj, }); @@ -1340,6 +1469,9 @@ export interface DescribeTrustedAdvisorChecksRequest { } export namespace DescribeTrustedAdvisorChecksRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeTrustedAdvisorChecksRequest): any => ({ ...obj, }); @@ -1381,6 +1513,9 @@ export interface TrustedAdvisorCheckDescription { } export namespace TrustedAdvisorCheckDescription { + /** + * @internal + */ export const filterSensitiveLog = (obj: TrustedAdvisorCheckDescription): any => ({ ...obj, }); @@ -1397,6 +1532,9 @@ export interface DescribeTrustedAdvisorChecksResponse { } export namespace DescribeTrustedAdvisorChecksResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeTrustedAdvisorChecksResponse): any => ({ ...obj, }); @@ -1410,6 +1548,9 @@ export interface DescribeTrustedAdvisorCheckSummariesRequest { } export namespace DescribeTrustedAdvisorCheckSummariesRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeTrustedAdvisorCheckSummariesRequest): any => ({ ...obj, }); @@ -1454,6 +1595,9 @@ export interface TrustedAdvisorCheckSummary { } export namespace TrustedAdvisorCheckSummary { + /** + * @internal + */ export const filterSensitiveLog = (obj: TrustedAdvisorCheckSummary): any => ({ ...obj, }); @@ -1470,6 +1614,9 @@ export interface DescribeTrustedAdvisorCheckSummariesResponse { } export namespace DescribeTrustedAdvisorCheckSummariesResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeTrustedAdvisorCheckSummariesResponse): any => ({ ...obj, }); @@ -1487,6 +1634,9 @@ export interface RefreshTrustedAdvisorCheckRequest { } export namespace RefreshTrustedAdvisorCheckRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: RefreshTrustedAdvisorCheckRequest): any => ({ ...obj, }); @@ -1504,6 +1654,9 @@ export interface RefreshTrustedAdvisorCheckResponse { } export namespace RefreshTrustedAdvisorCheckResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: RefreshTrustedAdvisorCheckResponse): any => ({ ...obj, }); @@ -1520,6 +1673,9 @@ export interface ResolveCaseRequest { } export namespace ResolveCaseRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ResolveCaseRequest): any => ({ ...obj, }); @@ -1542,6 +1698,9 @@ export interface ResolveCaseResponse { } export namespace ResolveCaseResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ResolveCaseResponse): any => ({ ...obj, }); diff --git a/clients/client-swf/commands/CountClosedWorkflowExecutionsCommand.ts b/clients/client-swf/commands/CountClosedWorkflowExecutionsCommand.ts index 4d62383f9181..50f84da51da6 100644 --- a/clients/client-swf/commands/CountClosedWorkflowExecutionsCommand.ts +++ b/clients/client-swf/commands/CountClosedWorkflowExecutionsCommand.ts @@ -68,6 +68,20 @@ export interface CountClosedWorkflowExecutionsCommandOutput extends WorkflowExec * 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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { SWFClient, CountClosedWorkflowExecutionsCommand } from "@aws-sdk/client-swf"; // ES Modules import + * // const { SWFClient, CountClosedWorkflowExecutionsCommand } = require("@aws-sdk/client-swf"); // CommonJS import + * const client = new SWFClient(config); + * const command = new CountClosedWorkflowExecutionsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CountClosedWorkflowExecutionsCommandInput} for command's `input` shape. + * @see {@link CountClosedWorkflowExecutionsCommandOutput} for command's `response` shape. + * @see {@link SWFClientResolvedConfig | config} for command's `input` shape. + * */ export class CountClosedWorkflowExecutionsCommand extends $Command< CountClosedWorkflowExecutionsCommandInput, diff --git a/clients/client-swf/commands/CountOpenWorkflowExecutionsCommand.ts b/clients/client-swf/commands/CountOpenWorkflowExecutionsCommand.ts index 0d60e7f988c8..f74db71bbe96 100644 --- a/clients/client-swf/commands/CountOpenWorkflowExecutionsCommand.ts +++ b/clients/client-swf/commands/CountOpenWorkflowExecutionsCommand.ts @@ -68,6 +68,20 @@ export interface CountOpenWorkflowExecutionsCommandOutput extends WorkflowExecut * 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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { SWFClient, CountOpenWorkflowExecutionsCommand } from "@aws-sdk/client-swf"; // ES Modules import + * // const { SWFClient, CountOpenWorkflowExecutionsCommand } = require("@aws-sdk/client-swf"); // CommonJS import + * const client = new SWFClient(config); + * const command = new CountOpenWorkflowExecutionsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CountOpenWorkflowExecutionsCommandInput} for command's `input` shape. + * @see {@link CountOpenWorkflowExecutionsCommandOutput} for command's `response` shape. + * @see {@link SWFClientResolvedConfig | config} for command's `input` shape. + * */ export class CountOpenWorkflowExecutionsCommand extends $Command< CountOpenWorkflowExecutionsCommandInput, diff --git a/clients/client-swf/commands/CountPendingActivityTasksCommand.ts b/clients/client-swf/commands/CountPendingActivityTasksCommand.ts index 6737cf1ee6e2..ce2fa89a8990 100644 --- a/clients/client-swf/commands/CountPendingActivityTasksCommand.ts +++ b/clients/client-swf/commands/CountPendingActivityTasksCommand.ts @@ -49,6 +49,20 @@ export interface CountPendingActivityTasksCommandOutput extends PendingTaskCount * 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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { SWFClient, CountPendingActivityTasksCommand } from "@aws-sdk/client-swf"; // ES Modules import + * // const { SWFClient, CountPendingActivityTasksCommand } = require("@aws-sdk/client-swf"); // CommonJS import + * const client = new SWFClient(config); + * const command = new CountPendingActivityTasksCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CountPendingActivityTasksCommandInput} for command's `input` shape. + * @see {@link CountPendingActivityTasksCommandOutput} for command's `response` shape. + * @see {@link SWFClientResolvedConfig | config} for command's `input` shape. + * */ export class CountPendingActivityTasksCommand extends $Command< CountPendingActivityTasksCommandInput, diff --git a/clients/client-swf/commands/CountPendingDecisionTasksCommand.ts b/clients/client-swf/commands/CountPendingDecisionTasksCommand.ts index 97adcee305de..d64f64651c3a 100644 --- a/clients/client-swf/commands/CountPendingDecisionTasksCommand.ts +++ b/clients/client-swf/commands/CountPendingDecisionTasksCommand.ts @@ -49,6 +49,20 @@ export interface CountPendingDecisionTasksCommandOutput extends PendingTaskCount * 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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { SWFClient, CountPendingDecisionTasksCommand } from "@aws-sdk/client-swf"; // ES Modules import + * // const { SWFClient, CountPendingDecisionTasksCommand } = require("@aws-sdk/client-swf"); // CommonJS import + * const client = new SWFClient(config); + * const command = new CountPendingDecisionTasksCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CountPendingDecisionTasksCommandInput} for command's `input` shape. + * @see {@link CountPendingDecisionTasksCommandOutput} for command's `response` shape. + * @see {@link SWFClientResolvedConfig | config} for command's `input` shape. + * */ export class CountPendingDecisionTasksCommand extends $Command< CountPendingDecisionTasksCommandInput, diff --git a/clients/client-swf/commands/DeprecateActivityTypeCommand.ts b/clients/client-swf/commands/DeprecateActivityTypeCommand.ts index f3e76d84a958..0a337ff34f7d 100644 --- a/clients/client-swf/commands/DeprecateActivityTypeCommand.ts +++ b/clients/client-swf/commands/DeprecateActivityTypeCommand.ts @@ -64,6 +64,20 @@ export interface DeprecateActivityTypeCommandOutput extends __MetadataBearer {} * 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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { SWFClient, DeprecateActivityTypeCommand } from "@aws-sdk/client-swf"; // ES Modules import + * // const { SWFClient, DeprecateActivityTypeCommand } = require("@aws-sdk/client-swf"); // CommonJS import + * const client = new SWFClient(config); + * const command = new DeprecateActivityTypeCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeprecateActivityTypeCommandInput} for command's `input` shape. + * @see {@link DeprecateActivityTypeCommandOutput} for command's `response` shape. + * @see {@link SWFClientResolvedConfig | config} for command's `input` shape. + * */ export class DeprecateActivityTypeCommand extends $Command< DeprecateActivityTypeCommandInput, diff --git a/clients/client-swf/commands/DeprecateDomainCommand.ts b/clients/client-swf/commands/DeprecateDomainCommand.ts index 728571188aa1..348505bfbb21 100644 --- a/clients/client-swf/commands/DeprecateDomainCommand.ts +++ b/clients/client-swf/commands/DeprecateDomainCommand.ts @@ -53,6 +53,20 @@ export interface DeprecateDomainCommandOutput extends __MetadataBearer {} * 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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { SWFClient, DeprecateDomainCommand } from "@aws-sdk/client-swf"; // ES Modules import + * // const { SWFClient, DeprecateDomainCommand } = require("@aws-sdk/client-swf"); // CommonJS import + * const client = new SWFClient(config); + * const command = new DeprecateDomainCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeprecateDomainCommandInput} for command's `input` shape. + * @see {@link DeprecateDomainCommandOutput} for command's `response` shape. + * @see {@link SWFClientResolvedConfig | config} for command's `input` shape. + * */ export class DeprecateDomainCommand extends $Command< DeprecateDomainCommandInput, diff --git a/clients/client-swf/commands/DeprecateWorkflowTypeCommand.ts b/clients/client-swf/commands/DeprecateWorkflowTypeCommand.ts index d187316e15dd..395d7a0761ea 100644 --- a/clients/client-swf/commands/DeprecateWorkflowTypeCommand.ts +++ b/clients/client-swf/commands/DeprecateWorkflowTypeCommand.ts @@ -65,6 +65,20 @@ export interface DeprecateWorkflowTypeCommandOutput extends __MetadataBearer {} * 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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { SWFClient, DeprecateWorkflowTypeCommand } from "@aws-sdk/client-swf"; // ES Modules import + * // const { SWFClient, DeprecateWorkflowTypeCommand } = require("@aws-sdk/client-swf"); // CommonJS import + * const client = new SWFClient(config); + * const command = new DeprecateWorkflowTypeCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeprecateWorkflowTypeCommandInput} for command's `input` shape. + * @see {@link DeprecateWorkflowTypeCommandOutput} for command's `response` shape. + * @see {@link SWFClientResolvedConfig | config} for command's `input` shape. + * */ export class DeprecateWorkflowTypeCommand extends $Command< DeprecateWorkflowTypeCommandInput, diff --git a/clients/client-swf/commands/DescribeActivityTypeCommand.ts b/clients/client-swf/commands/DescribeActivityTypeCommand.ts index 34c2099444b5..4fd358473465 100644 --- a/clients/client-swf/commands/DescribeActivityTypeCommand.ts +++ b/clients/client-swf/commands/DescribeActivityTypeCommand.ts @@ -60,6 +60,20 @@ export interface DescribeActivityTypeCommandOutput extends ActivityTypeDetail, _ * 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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { SWFClient, DescribeActivityTypeCommand } from "@aws-sdk/client-swf"; // ES Modules import + * // const { SWFClient, DescribeActivityTypeCommand } = require("@aws-sdk/client-swf"); // CommonJS import + * const client = new SWFClient(config); + * const command = new DescribeActivityTypeCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeActivityTypeCommandInput} for command's `input` shape. + * @see {@link DescribeActivityTypeCommandOutput} for command's `response` shape. + * @see {@link SWFClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeActivityTypeCommand extends $Command< DescribeActivityTypeCommandInput, diff --git a/clients/client-swf/commands/DescribeDomainCommand.ts b/clients/client-swf/commands/DescribeDomainCommand.ts index f435eb830263..0143a3770805 100644 --- a/clients/client-swf/commands/DescribeDomainCommand.ts +++ b/clients/client-swf/commands/DescribeDomainCommand.ts @@ -46,6 +46,20 @@ export interface DescribeDomainCommandOutput extends DomainDetail, __MetadataBea * 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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { SWFClient, DescribeDomainCommand } from "@aws-sdk/client-swf"; // ES Modules import + * // const { SWFClient, DescribeDomainCommand } = require("@aws-sdk/client-swf"); // CommonJS import + * const client = new SWFClient(config); + * const command = new DescribeDomainCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeDomainCommandInput} for command's `input` shape. + * @see {@link DescribeDomainCommandOutput} for command's `response` shape. + * @see {@link SWFClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeDomainCommand extends $Command< DescribeDomainCommandInput, diff --git a/clients/client-swf/commands/DescribeWorkflowExecutionCommand.ts b/clients/client-swf/commands/DescribeWorkflowExecutionCommand.ts index 8e5513ac176d..e07b62e0ce49 100644 --- a/clients/client-swf/commands/DescribeWorkflowExecutionCommand.ts +++ b/clients/client-swf/commands/DescribeWorkflowExecutionCommand.ts @@ -50,6 +50,20 @@ export interface DescribeWorkflowExecutionCommandOutput extends WorkflowExecutio * 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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { SWFClient, DescribeWorkflowExecutionCommand } from "@aws-sdk/client-swf"; // ES Modules import + * // const { SWFClient, DescribeWorkflowExecutionCommand } = require("@aws-sdk/client-swf"); // CommonJS import + * const client = new SWFClient(config); + * const command = new DescribeWorkflowExecutionCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeWorkflowExecutionCommandInput} for command's `input` shape. + * @see {@link DescribeWorkflowExecutionCommandOutput} for command's `response` shape. + * @see {@link SWFClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeWorkflowExecutionCommand extends $Command< DescribeWorkflowExecutionCommandInput, diff --git a/clients/client-swf/commands/DescribeWorkflowTypeCommand.ts b/clients/client-swf/commands/DescribeWorkflowTypeCommand.ts index 61c013a137de..d433b1f84b4e 100644 --- a/clients/client-swf/commands/DescribeWorkflowTypeCommand.ts +++ b/clients/client-swf/commands/DescribeWorkflowTypeCommand.ts @@ -60,6 +60,20 @@ export interface DescribeWorkflowTypeCommandOutput extends WorkflowTypeDetail, _ * 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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { SWFClient, DescribeWorkflowTypeCommand } from "@aws-sdk/client-swf"; // ES Modules import + * // const { SWFClient, DescribeWorkflowTypeCommand } = require("@aws-sdk/client-swf"); // CommonJS import + * const client = new SWFClient(config); + * const command = new DescribeWorkflowTypeCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeWorkflowTypeCommandInput} for command's `input` shape. + * @see {@link DescribeWorkflowTypeCommandOutput} for command's `response` shape. + * @see {@link SWFClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeWorkflowTypeCommand extends $Command< DescribeWorkflowTypeCommandInput, diff --git a/clients/client-swf/commands/GetWorkflowExecutionHistoryCommand.ts b/clients/client-swf/commands/GetWorkflowExecutionHistoryCommand.ts index 5c78ec2884c0..d4c41c95047e 100644 --- a/clients/client-swf/commands/GetWorkflowExecutionHistoryCommand.ts +++ b/clients/client-swf/commands/GetWorkflowExecutionHistoryCommand.ts @@ -51,6 +51,20 @@ export interface GetWorkflowExecutionHistoryCommandOutput extends History, __Met * 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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { SWFClient, GetWorkflowExecutionHistoryCommand } from "@aws-sdk/client-swf"; // ES Modules import + * // const { SWFClient, GetWorkflowExecutionHistoryCommand } = require("@aws-sdk/client-swf"); // CommonJS import + * const client = new SWFClient(config); + * const command = new GetWorkflowExecutionHistoryCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetWorkflowExecutionHistoryCommandInput} for command's `input` shape. + * @see {@link GetWorkflowExecutionHistoryCommandOutput} for command's `response` shape. + * @see {@link SWFClientResolvedConfig | config} for command's `input` shape. + * */ export class GetWorkflowExecutionHistoryCommand extends $Command< GetWorkflowExecutionHistoryCommandInput, diff --git a/clients/client-swf/commands/ListActivityTypesCommand.ts b/clients/client-swf/commands/ListActivityTypesCommand.ts index a62c30fc8029..fbb379553dee 100644 --- a/clients/client-swf/commands/ListActivityTypesCommand.ts +++ b/clients/client-swf/commands/ListActivityTypesCommand.ts @@ -49,6 +49,20 @@ export interface ListActivityTypesCommandOutput extends ActivityTypeInfos, __Met * 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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { SWFClient, ListActivityTypesCommand } from "@aws-sdk/client-swf"; // ES Modules import + * // const { SWFClient, ListActivityTypesCommand } = require("@aws-sdk/client-swf"); // CommonJS import + * const client = new SWFClient(config); + * const command = new ListActivityTypesCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListActivityTypesCommandInput} for command's `input` shape. + * @see {@link ListActivityTypesCommandOutput} for command's `response` shape. + * @see {@link SWFClientResolvedConfig | config} for command's `input` shape. + * */ export class ListActivityTypesCommand extends $Command< ListActivityTypesCommandInput, diff --git a/clients/client-swf/commands/ListClosedWorkflowExecutionsCommand.ts b/clients/client-swf/commands/ListClosedWorkflowExecutionsCommand.ts index 4d867818562b..f3b4841f8b5d 100644 --- a/clients/client-swf/commands/ListClosedWorkflowExecutionsCommand.ts +++ b/clients/client-swf/commands/ListClosedWorkflowExecutionsCommand.ts @@ -69,6 +69,20 @@ export interface ListClosedWorkflowExecutionsCommandOutput extends WorkflowExecu * 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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { SWFClient, ListClosedWorkflowExecutionsCommand } from "@aws-sdk/client-swf"; // ES Modules import + * // const { SWFClient, ListClosedWorkflowExecutionsCommand } = require("@aws-sdk/client-swf"); // CommonJS import + * const client = new SWFClient(config); + * const command = new ListClosedWorkflowExecutionsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListClosedWorkflowExecutionsCommandInput} for command's `input` shape. + * @see {@link ListClosedWorkflowExecutionsCommandOutput} for command's `response` shape. + * @see {@link SWFClientResolvedConfig | config} for command's `input` shape. + * */ export class ListClosedWorkflowExecutionsCommand extends $Command< ListClosedWorkflowExecutionsCommandInput, diff --git a/clients/client-swf/commands/ListDomainsCommand.ts b/clients/client-swf/commands/ListDomainsCommand.ts index ae3b8b010676..994cadc2f58a 100644 --- a/clients/client-swf/commands/ListDomainsCommand.ts +++ b/clients/client-swf/commands/ListDomainsCommand.ts @@ -53,6 +53,20 @@ export interface ListDomainsCommandOutput extends DomainInfos, __MetadataBearer * 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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { SWFClient, ListDomainsCommand } from "@aws-sdk/client-swf"; // ES Modules import + * // const { SWFClient, ListDomainsCommand } = require("@aws-sdk/client-swf"); // CommonJS import + * const client = new SWFClient(config); + * const command = new ListDomainsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListDomainsCommandInput} for command's `input` shape. + * @see {@link ListDomainsCommandOutput} for command's `response` shape. + * @see {@link SWFClientResolvedConfig | config} for command's `input` shape. + * */ export class ListDomainsCommand extends $Command< ListDomainsCommandInput, diff --git a/clients/client-swf/commands/ListOpenWorkflowExecutionsCommand.ts b/clients/client-swf/commands/ListOpenWorkflowExecutionsCommand.ts index 3ab8dc38065b..0d29980d373f 100644 --- a/clients/client-swf/commands/ListOpenWorkflowExecutionsCommand.ts +++ b/clients/client-swf/commands/ListOpenWorkflowExecutionsCommand.ts @@ -69,6 +69,20 @@ export interface ListOpenWorkflowExecutionsCommandOutput extends WorkflowExecuti * 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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { SWFClient, ListOpenWorkflowExecutionsCommand } from "@aws-sdk/client-swf"; // ES Modules import + * // const { SWFClient, ListOpenWorkflowExecutionsCommand } = require("@aws-sdk/client-swf"); // CommonJS import + * const client = new SWFClient(config); + * const command = new ListOpenWorkflowExecutionsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListOpenWorkflowExecutionsCommandInput} for command's `input` shape. + * @see {@link ListOpenWorkflowExecutionsCommandOutput} for command's `response` shape. + * @see {@link SWFClientResolvedConfig | config} for command's `input` shape. + * */ export class ListOpenWorkflowExecutionsCommand extends $Command< ListOpenWorkflowExecutionsCommandInput, diff --git a/clients/client-swf/commands/ListTagsForResourceCommand.ts b/clients/client-swf/commands/ListTagsForResourceCommand.ts index 054401be97e6..c18d473760ea 100644 --- a/clients/client-swf/commands/ListTagsForResourceCommand.ts +++ b/clients/client-swf/commands/ListTagsForResourceCommand.ts @@ -22,6 +22,20 @@ export interface ListTagsForResourceCommandOutput extends ListTagsForResourceOut /** *

List tags for a given domain.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { SWFClient, ListTagsForResourceCommand } from "@aws-sdk/client-swf"; // ES Modules import + * // const { SWFClient, ListTagsForResourceCommand } = require("@aws-sdk/client-swf"); // CommonJS import + * const client = new SWFClient(config); + * const command = new ListTagsForResourceCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListTagsForResourceCommandInput} for command's `input` shape. + * @see {@link ListTagsForResourceCommandOutput} for command's `response` shape. + * @see {@link SWFClientResolvedConfig | config} for command's `input` shape. + * */ export class ListTagsForResourceCommand extends $Command< ListTagsForResourceCommandInput, diff --git a/clients/client-swf/commands/ListWorkflowTypesCommand.ts b/clients/client-swf/commands/ListWorkflowTypesCommand.ts index 7b474ac73730..06505245ef73 100644 --- a/clients/client-swf/commands/ListWorkflowTypesCommand.ts +++ b/clients/client-swf/commands/ListWorkflowTypesCommand.ts @@ -46,6 +46,20 @@ export interface ListWorkflowTypesCommandOutput extends WorkflowTypeInfos, __Met * 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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { SWFClient, ListWorkflowTypesCommand } from "@aws-sdk/client-swf"; // ES Modules import + * // const { SWFClient, ListWorkflowTypesCommand } = require("@aws-sdk/client-swf"); // CommonJS import + * const client = new SWFClient(config); + * const command = new ListWorkflowTypesCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListWorkflowTypesCommandInput} for command's `input` shape. + * @see {@link ListWorkflowTypesCommandOutput} for command's `response` shape. + * @see {@link SWFClientResolvedConfig | config} for command's `input` shape. + * */ export class ListWorkflowTypesCommand extends $Command< ListWorkflowTypesCommandInput, diff --git a/clients/client-swf/commands/PollForActivityTaskCommand.ts b/clients/client-swf/commands/PollForActivityTaskCommand.ts index 12777eecbce1..3e8ac27978ac 100644 --- a/clients/client-swf/commands/PollForActivityTaskCommand.ts +++ b/clients/client-swf/commands/PollForActivityTaskCommand.ts @@ -57,6 +57,20 @@ export interface PollForActivityTaskCommandOutput extends ActivityTask, __Metada * 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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { SWFClient, PollForActivityTaskCommand } from "@aws-sdk/client-swf"; // ES Modules import + * // const { SWFClient, PollForActivityTaskCommand } = require("@aws-sdk/client-swf"); // CommonJS import + * const client = new SWFClient(config); + * const command = new PollForActivityTaskCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link PollForActivityTaskCommandInput} for command's `input` shape. + * @see {@link PollForActivityTaskCommandOutput} for command's `response` shape. + * @see {@link SWFClientResolvedConfig | config} for command's `input` shape. + * */ export class PollForActivityTaskCommand extends $Command< PollForActivityTaskCommandInput, diff --git a/clients/client-swf/commands/PollForDecisionTaskCommand.ts b/clients/client-swf/commands/PollForDecisionTaskCommand.ts index 502b76083405..582951aaa3a8 100644 --- a/clients/client-swf/commands/PollForDecisionTaskCommand.ts +++ b/clients/client-swf/commands/PollForDecisionTaskCommand.ts @@ -69,6 +69,20 @@ export interface PollForDecisionTaskCommandOutput extends DecisionTask, __Metada * 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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { SWFClient, PollForDecisionTaskCommand } from "@aws-sdk/client-swf"; // ES Modules import + * // const { SWFClient, PollForDecisionTaskCommand } = require("@aws-sdk/client-swf"); // CommonJS import + * const client = new SWFClient(config); + * const command = new PollForDecisionTaskCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link PollForDecisionTaskCommandInput} for command's `input` shape. + * @see {@link PollForDecisionTaskCommandOutput} for command's `response` shape. + * @see {@link SWFClientResolvedConfig | config} for command's `input` shape. + * */ export class PollForDecisionTaskCommand extends $Command< PollForDecisionTaskCommandInput, diff --git a/clients/client-swf/commands/RecordActivityTaskHeartbeatCommand.ts b/clients/client-swf/commands/RecordActivityTaskHeartbeatCommand.ts index 66b4f20946d7..ba7c987cfbf5 100644 --- a/clients/client-swf/commands/RecordActivityTaskHeartbeatCommand.ts +++ b/clients/client-swf/commands/RecordActivityTaskHeartbeatCommand.ts @@ -69,6 +69,20 @@ export interface RecordActivityTaskHeartbeatCommandOutput extends ActivityTaskSt * 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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { SWFClient, RecordActivityTaskHeartbeatCommand } from "@aws-sdk/client-swf"; // ES Modules import + * // const { SWFClient, RecordActivityTaskHeartbeatCommand } = require("@aws-sdk/client-swf"); // CommonJS import + * const client = new SWFClient(config); + * const command = new RecordActivityTaskHeartbeatCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link RecordActivityTaskHeartbeatCommandInput} for command's `input` shape. + * @see {@link RecordActivityTaskHeartbeatCommandOutput} for command's `response` shape. + * @see {@link SWFClientResolvedConfig | config} for command's `input` shape. + * */ export class RecordActivityTaskHeartbeatCommand extends $Command< RecordActivityTaskHeartbeatCommandInput, diff --git a/clients/client-swf/commands/RegisterActivityTypeCommand.ts b/clients/client-swf/commands/RegisterActivityTypeCommand.ts index 3ca0f966fa0e..3f14850a33ab 100644 --- a/clients/client-swf/commands/RegisterActivityTypeCommand.ts +++ b/clients/client-swf/commands/RegisterActivityTypeCommand.ts @@ -68,6 +68,20 @@ export interface RegisterActivityTypeCommandOutput extends __MetadataBearer {} * 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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { SWFClient, RegisterActivityTypeCommand } from "@aws-sdk/client-swf"; // ES Modules import + * // const { SWFClient, RegisterActivityTypeCommand } = require("@aws-sdk/client-swf"); // CommonJS import + * const client = new SWFClient(config); + * const command = new RegisterActivityTypeCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link RegisterActivityTypeCommandInput} for command's `input` shape. + * @see {@link RegisterActivityTypeCommandOutput} for command's `response` shape. + * @see {@link SWFClientResolvedConfig | config} for command's `input` shape. + * */ export class RegisterActivityTypeCommand extends $Command< RegisterActivityTypeCommandInput, diff --git a/clients/client-swf/commands/RegisterDomainCommand.ts b/clients/client-swf/commands/RegisterDomainCommand.ts index edd74f3d2bd8..f7f569a51ca0 100644 --- a/clients/client-swf/commands/RegisterDomainCommand.ts +++ b/clients/client-swf/commands/RegisterDomainCommand.ts @@ -45,6 +45,20 @@ export interface RegisterDomainCommandOutput extends __MetadataBearer {} * 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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { SWFClient, RegisterDomainCommand } from "@aws-sdk/client-swf"; // ES Modules import + * // const { SWFClient, RegisterDomainCommand } = require("@aws-sdk/client-swf"); // CommonJS import + * const client = new SWFClient(config); + * const command = new RegisterDomainCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link RegisterDomainCommandInput} for command's `input` shape. + * @see {@link RegisterDomainCommandOutput} for command's `response` shape. + * @see {@link SWFClientResolvedConfig | config} for command's `input` shape. + * */ export class RegisterDomainCommand extends $Command< RegisterDomainCommandInput, diff --git a/clients/client-swf/commands/RegisterWorkflowTypeCommand.ts b/clients/client-swf/commands/RegisterWorkflowTypeCommand.ts index aa95c5d71e47..a713544b0d8d 100644 --- a/clients/client-swf/commands/RegisterWorkflowTypeCommand.ts +++ b/clients/client-swf/commands/RegisterWorkflowTypeCommand.ts @@ -69,6 +69,20 @@ export interface RegisterWorkflowTypeCommandOutput extends __MetadataBearer {} * 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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { SWFClient, RegisterWorkflowTypeCommand } from "@aws-sdk/client-swf"; // ES Modules import + * // const { SWFClient, RegisterWorkflowTypeCommand } = require("@aws-sdk/client-swf"); // CommonJS import + * const client = new SWFClient(config); + * const command = new RegisterWorkflowTypeCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link RegisterWorkflowTypeCommandInput} for command's `input` shape. + * @see {@link RegisterWorkflowTypeCommandOutput} for command's `response` shape. + * @see {@link SWFClientResolvedConfig | config} for command's `input` shape. + * */ export class RegisterWorkflowTypeCommand extends $Command< RegisterWorkflowTypeCommandInput, diff --git a/clients/client-swf/commands/RequestCancelWorkflowExecutionCommand.ts b/clients/client-swf/commands/RequestCancelWorkflowExecutionCommand.ts index 9c767eecfb3e..8bab889bb195 100644 --- a/clients/client-swf/commands/RequestCancelWorkflowExecutionCommand.ts +++ b/clients/client-swf/commands/RequestCancelWorkflowExecutionCommand.ts @@ -60,6 +60,20 @@ export interface RequestCancelWorkflowExecutionCommandOutput extends __MetadataB * 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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { SWFClient, RequestCancelWorkflowExecutionCommand } from "@aws-sdk/client-swf"; // ES Modules import + * // const { SWFClient, RequestCancelWorkflowExecutionCommand } = require("@aws-sdk/client-swf"); // CommonJS import + * const client = new SWFClient(config); + * const command = new RequestCancelWorkflowExecutionCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link RequestCancelWorkflowExecutionCommandInput} for command's `input` shape. + * @see {@link RequestCancelWorkflowExecutionCommandOutput} for command's `response` shape. + * @see {@link SWFClientResolvedConfig | config} for command's `input` shape. + * */ export class RequestCancelWorkflowExecutionCommand extends $Command< RequestCancelWorkflowExecutionCommandInput, diff --git a/clients/client-swf/commands/RespondActivityTaskCanceledCommand.ts b/clients/client-swf/commands/RespondActivityTaskCanceledCommand.ts index 5c15f457cd47..83e43b8fe421 100644 --- a/clients/client-swf/commands/RespondActivityTaskCanceledCommand.ts +++ b/clients/client-swf/commands/RespondActivityTaskCanceledCommand.ts @@ -63,6 +63,20 @@ export interface RespondActivityTaskCanceledCommandOutput extends __MetadataBear * 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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { SWFClient, RespondActivityTaskCanceledCommand } from "@aws-sdk/client-swf"; // ES Modules import + * // const { SWFClient, RespondActivityTaskCanceledCommand } = require("@aws-sdk/client-swf"); // CommonJS import + * const client = new SWFClient(config); + * const command = new RespondActivityTaskCanceledCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link RespondActivityTaskCanceledCommandInput} for command's `input` shape. + * @see {@link RespondActivityTaskCanceledCommandOutput} for command's `response` shape. + * @see {@link SWFClientResolvedConfig | config} for command's `input` shape. + * */ export class RespondActivityTaskCanceledCommand extends $Command< RespondActivityTaskCanceledCommandInput, diff --git a/clients/client-swf/commands/RespondActivityTaskCompletedCommand.ts b/clients/client-swf/commands/RespondActivityTaskCompletedCommand.ts index c5a80524ad0a..301bbc797a8a 100644 --- a/clients/client-swf/commands/RespondActivityTaskCompletedCommand.ts +++ b/clients/client-swf/commands/RespondActivityTaskCompletedCommand.ts @@ -61,6 +61,20 @@ export interface RespondActivityTaskCompletedCommandOutput extends __MetadataBea * 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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { SWFClient, RespondActivityTaskCompletedCommand } from "@aws-sdk/client-swf"; // ES Modules import + * // const { SWFClient, RespondActivityTaskCompletedCommand } = require("@aws-sdk/client-swf"); // CommonJS import + * const client = new SWFClient(config); + * const command = new RespondActivityTaskCompletedCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link RespondActivityTaskCompletedCommandInput} for command's `input` shape. + * @see {@link RespondActivityTaskCompletedCommandOutput} for command's `response` shape. + * @see {@link SWFClientResolvedConfig | config} for command's `input` shape. + * */ export class RespondActivityTaskCompletedCommand extends $Command< RespondActivityTaskCompletedCommandInput, diff --git a/clients/client-swf/commands/RespondActivityTaskFailedCommand.ts b/clients/client-swf/commands/RespondActivityTaskFailedCommand.ts index 5b4d3ceab3ae..15be59507faa 100644 --- a/clients/client-swf/commands/RespondActivityTaskFailedCommand.ts +++ b/clients/client-swf/commands/RespondActivityTaskFailedCommand.ts @@ -54,6 +54,20 @@ export interface RespondActivityTaskFailedCommandOutput extends __MetadataBearer * 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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { SWFClient, RespondActivityTaskFailedCommand } from "@aws-sdk/client-swf"; // ES Modules import + * // const { SWFClient, RespondActivityTaskFailedCommand } = require("@aws-sdk/client-swf"); // CommonJS import + * const client = new SWFClient(config); + * const command = new RespondActivityTaskFailedCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link RespondActivityTaskFailedCommandInput} for command's `input` shape. + * @see {@link RespondActivityTaskFailedCommandOutput} for command's `response` shape. + * @see {@link SWFClientResolvedConfig | config} for command's `input` shape. + * */ export class RespondActivityTaskFailedCommand extends $Command< RespondActivityTaskFailedCommandInput, diff --git a/clients/client-swf/commands/RespondDecisionTaskCompletedCommand.ts b/clients/client-swf/commands/RespondDecisionTaskCompletedCommand.ts index 6f3279de4ebc..02748a73e685 100644 --- a/clients/client-swf/commands/RespondDecisionTaskCompletedCommand.ts +++ b/clients/client-swf/commands/RespondDecisionTaskCompletedCommand.ts @@ -41,6 +41,20 @@ export interface RespondDecisionTaskCompletedCommandOutput extends __MetadataBea * see Using * IAM to Manage Access to Amazon SWF Workflows in the * Amazon SWF Developer Guide.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { SWFClient, RespondDecisionTaskCompletedCommand } from "@aws-sdk/client-swf"; // ES Modules import + * // const { SWFClient, RespondDecisionTaskCompletedCommand } = require("@aws-sdk/client-swf"); // CommonJS import + * const client = new SWFClient(config); + * const command = new RespondDecisionTaskCompletedCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link RespondDecisionTaskCompletedCommandInput} for command's `input` shape. + * @see {@link RespondDecisionTaskCompletedCommandOutput} for command's `response` shape. + * @see {@link SWFClientResolvedConfig | config} for command's `input` shape. + * */ export class RespondDecisionTaskCompletedCommand extends $Command< RespondDecisionTaskCompletedCommandInput, diff --git a/clients/client-swf/commands/SignalWorkflowExecutionCommand.ts b/clients/client-swf/commands/SignalWorkflowExecutionCommand.ts index 9a93ba25fb39..b149a491c6e6 100644 --- a/clients/client-swf/commands/SignalWorkflowExecutionCommand.ts +++ b/clients/client-swf/commands/SignalWorkflowExecutionCommand.ts @@ -60,6 +60,20 @@ export interface SignalWorkflowExecutionCommandOutput extends __MetadataBearer { * 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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { SWFClient, SignalWorkflowExecutionCommand } from "@aws-sdk/client-swf"; // ES Modules import + * // const { SWFClient, SignalWorkflowExecutionCommand } = require("@aws-sdk/client-swf"); // CommonJS import + * const client = new SWFClient(config); + * const command = new SignalWorkflowExecutionCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link SignalWorkflowExecutionCommandInput} for command's `input` shape. + * @see {@link SignalWorkflowExecutionCommandOutput} for command's `response` shape. + * @see {@link SWFClientResolvedConfig | config} for command's `input` shape. + * */ export class SignalWorkflowExecutionCommand extends $Command< SignalWorkflowExecutionCommandInput, diff --git a/clients/client-swf/commands/StartWorkflowExecutionCommand.ts b/clients/client-swf/commands/StartWorkflowExecutionCommand.ts index 8a0d86499de1..4d54b3a17e60 100644 --- a/clients/client-swf/commands/StartWorkflowExecutionCommand.ts +++ b/clients/client-swf/commands/StartWorkflowExecutionCommand.ts @@ -87,6 +87,20 @@ export interface StartWorkflowExecutionCommandOutput extends Run, __MetadataBear * 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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { SWFClient, StartWorkflowExecutionCommand } from "@aws-sdk/client-swf"; // ES Modules import + * // const { SWFClient, StartWorkflowExecutionCommand } = require("@aws-sdk/client-swf"); // CommonJS import + * const client = new SWFClient(config); + * const command = new StartWorkflowExecutionCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link StartWorkflowExecutionCommandInput} for command's `input` shape. + * @see {@link StartWorkflowExecutionCommandOutput} for command's `response` shape. + * @see {@link SWFClientResolvedConfig | config} for command's `input` shape. + * */ export class StartWorkflowExecutionCommand extends $Command< StartWorkflowExecutionCommandInput, diff --git a/clients/client-swf/commands/TagResourceCommand.ts b/clients/client-swf/commands/TagResourceCommand.ts index c28cf9b3e194..3c1604319818 100644 --- a/clients/client-swf/commands/TagResourceCommand.ts +++ b/clients/client-swf/commands/TagResourceCommand.ts @@ -25,6 +25,20 @@ export interface TagResourceCommandOutput extends __MetadataBearer {} * *

Amazon SWF supports a maximum of 50 tags per resource.

* + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { SWFClient, TagResourceCommand } from "@aws-sdk/client-swf"; // ES Modules import + * // const { SWFClient, TagResourceCommand } = require("@aws-sdk/client-swf"); // CommonJS import + * const client = new SWFClient(config); + * const command = new TagResourceCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link TagResourceCommandInput} for command's `input` shape. + * @see {@link TagResourceCommandOutput} for command's `response` shape. + * @see {@link SWFClientResolvedConfig | config} for command's `input` shape. + * */ export class TagResourceCommand extends $Command< TagResourceCommandInput, diff --git a/clients/client-swf/commands/TerminateWorkflowExecutionCommand.ts b/clients/client-swf/commands/TerminateWorkflowExecutionCommand.ts index 53486b133fc8..9e9c7e0db70c 100644 --- a/clients/client-swf/commands/TerminateWorkflowExecutionCommand.ts +++ b/clients/client-swf/commands/TerminateWorkflowExecutionCommand.ts @@ -65,6 +65,20 @@ export interface TerminateWorkflowExecutionCommandOutput extends __MetadataBeare * 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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { SWFClient, TerminateWorkflowExecutionCommand } from "@aws-sdk/client-swf"; // ES Modules import + * // const { SWFClient, TerminateWorkflowExecutionCommand } = require("@aws-sdk/client-swf"); // CommonJS import + * const client = new SWFClient(config); + * const command = new TerminateWorkflowExecutionCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link TerminateWorkflowExecutionCommandInput} for command's `input` shape. + * @see {@link TerminateWorkflowExecutionCommandOutput} for command's `response` shape. + * @see {@link SWFClientResolvedConfig | config} for command's `input` shape. + * */ export class TerminateWorkflowExecutionCommand extends $Command< TerminateWorkflowExecutionCommandInput, diff --git a/clients/client-swf/commands/UndeprecateActivityTypeCommand.ts b/clients/client-swf/commands/UndeprecateActivityTypeCommand.ts index 1d2ccd40c650..5794e367b1ac 100644 --- a/clients/client-swf/commands/UndeprecateActivityTypeCommand.ts +++ b/clients/client-swf/commands/UndeprecateActivityTypeCommand.ts @@ -63,6 +63,20 @@ export interface UndeprecateActivityTypeCommandOutput extends __MetadataBearer { * 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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { SWFClient, UndeprecateActivityTypeCommand } from "@aws-sdk/client-swf"; // ES Modules import + * // const { SWFClient, UndeprecateActivityTypeCommand } = require("@aws-sdk/client-swf"); // CommonJS import + * const client = new SWFClient(config); + * const command = new UndeprecateActivityTypeCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link UndeprecateActivityTypeCommandInput} for command's `input` shape. + * @see {@link UndeprecateActivityTypeCommandOutput} for command's `response` shape. + * @see {@link SWFClientResolvedConfig | config} for command's `input` shape. + * */ export class UndeprecateActivityTypeCommand extends $Command< UndeprecateActivityTypeCommandInput, diff --git a/clients/client-swf/commands/UndeprecateDomainCommand.ts b/clients/client-swf/commands/UndeprecateDomainCommand.ts index 58506e21d981..01accb82d8a6 100644 --- a/clients/client-swf/commands/UndeprecateDomainCommand.ts +++ b/clients/client-swf/commands/UndeprecateDomainCommand.ts @@ -50,6 +50,20 @@ export interface UndeprecateDomainCommandOutput extends __MetadataBearer {} * 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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { SWFClient, UndeprecateDomainCommand } from "@aws-sdk/client-swf"; // ES Modules import + * // const { SWFClient, UndeprecateDomainCommand } = require("@aws-sdk/client-swf"); // CommonJS import + * const client = new SWFClient(config); + * const command = new UndeprecateDomainCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link UndeprecateDomainCommandInput} for command's `input` shape. + * @see {@link UndeprecateDomainCommandOutput} for command's `response` shape. + * @see {@link SWFClientResolvedConfig | config} for command's `input` shape. + * */ export class UndeprecateDomainCommand extends $Command< UndeprecateDomainCommandInput, diff --git a/clients/client-swf/commands/UndeprecateWorkflowTypeCommand.ts b/clients/client-swf/commands/UndeprecateWorkflowTypeCommand.ts index 0f2ae4021ac8..2d20751211ed 100644 --- a/clients/client-swf/commands/UndeprecateWorkflowTypeCommand.ts +++ b/clients/client-swf/commands/UndeprecateWorkflowTypeCommand.ts @@ -63,6 +63,20 @@ export interface UndeprecateWorkflowTypeCommandOutput extends __MetadataBearer { * 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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { SWFClient, UndeprecateWorkflowTypeCommand } from "@aws-sdk/client-swf"; // ES Modules import + * // const { SWFClient, UndeprecateWorkflowTypeCommand } = require("@aws-sdk/client-swf"); // CommonJS import + * const client = new SWFClient(config); + * const command = new UndeprecateWorkflowTypeCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link UndeprecateWorkflowTypeCommandInput} for command's `input` shape. + * @see {@link UndeprecateWorkflowTypeCommandOutput} for command's `response` shape. + * @see {@link SWFClientResolvedConfig | config} for command's `input` shape. + * */ export class UndeprecateWorkflowTypeCommand extends $Command< UndeprecateWorkflowTypeCommandInput, diff --git a/clients/client-swf/commands/UntagResourceCommand.ts b/clients/client-swf/commands/UntagResourceCommand.ts index 2a2fb848239b..b3c5c354863b 100644 --- a/clients/client-swf/commands/UntagResourceCommand.ts +++ b/clients/client-swf/commands/UntagResourceCommand.ts @@ -22,6 +22,20 @@ export interface UntagResourceCommandOutput extends __MetadataBearer {} /** *

Remove a tag from a Amazon SWF domain.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { SWFClient, UntagResourceCommand } from "@aws-sdk/client-swf"; // ES Modules import + * // const { SWFClient, UntagResourceCommand } = require("@aws-sdk/client-swf"); // CommonJS import + * const client = new SWFClient(config); + * const command = new UntagResourceCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link UntagResourceCommandInput} for command's `input` shape. + * @see {@link UntagResourceCommandOutput} for command's `response` shape. + * @see {@link SWFClientResolvedConfig | config} for command's `input` shape. + * */ export class UntagResourceCommand extends $Command< UntagResourceCommandInput, diff --git a/clients/client-swf/models/models_0.ts b/clients/client-swf/models/models_0.ts index c7ef99660c89..1c53e6d7b92d 100644 --- a/clients/client-swf/models/models_0.ts +++ b/clients/client-swf/models/models_0.ts @@ -23,6 +23,9 @@ export interface ActivityType { } export namespace ActivityType { + /** + * @internal + */ export const filterSensitiveLog = (obj: ActivityType): any => ({ ...obj, }); @@ -44,6 +47,9 @@ export interface WorkflowExecution { } export namespace WorkflowExecution { + /** + * @internal + */ export const filterSensitiveLog = (obj: WorkflowExecution): any => ({ ...obj, }); @@ -85,6 +91,9 @@ export interface ActivityTask { } export namespace ActivityTask { + /** + * @internal + */ export const filterSensitiveLog = (obj: ActivityTask): any => ({ ...obj, }); @@ -118,6 +127,9 @@ export interface ActivityTaskCanceledEventAttributes { } export namespace ActivityTaskCanceledEventAttributes { + /** + * @internal + */ export const filterSensitiveLog = (obj: ActivityTaskCanceledEventAttributes): any => ({ ...obj, }); @@ -140,6 +152,9 @@ export interface ActivityTaskCancelRequestedEventAttributes { } export namespace ActivityTaskCancelRequestedEventAttributes { + /** + * @internal + */ export const filterSensitiveLog = (obj: ActivityTaskCancelRequestedEventAttributes): any => ({ ...obj, }); @@ -168,6 +183,9 @@ export interface ActivityTaskCompletedEventAttributes { } export namespace ActivityTaskCompletedEventAttributes { + /** + * @internal + */ export const filterSensitiveLog = (obj: ActivityTaskCompletedEventAttributes): any => ({ ...obj, }); @@ -201,6 +219,9 @@ export interface ActivityTaskFailedEventAttributes { } export namespace ActivityTaskFailedEventAttributes { + /** + * @internal + */ export const filterSensitiveLog = (obj: ActivityTaskFailedEventAttributes): any => ({ ...obj, }); @@ -217,6 +238,9 @@ export interface TaskList { } export namespace TaskList { + /** + * @internal + */ export const filterSensitiveLog = (obj: TaskList): any => ({ ...obj, }); @@ -290,6 +314,9 @@ export interface ActivityTaskScheduledEventAttributes { } export namespace ActivityTaskScheduledEventAttributes { + /** + * @internal + */ export const filterSensitiveLog = (obj: ActivityTaskScheduledEventAttributes): any => ({ ...obj, }); @@ -311,6 +338,9 @@ export interface ActivityTaskStartedEventAttributes { } export namespace ActivityTaskStartedEventAttributes { + /** + * @internal + */ export const filterSensitiveLog = (obj: ActivityTaskStartedEventAttributes): any => ({ ...obj, }); @@ -327,6 +357,9 @@ export interface ActivityTaskStatus { } export namespace ActivityTaskStatus { + /** + * @internal + */ export const filterSensitiveLog = (obj: ActivityTaskStatus): any => ({ ...obj, }); @@ -363,6 +396,9 @@ export interface ActivityTaskTimedOutEventAttributes { } export namespace ActivityTaskTimedOutEventAttributes { + /** + * @internal + */ export const filterSensitiveLog = (obj: ActivityTaskTimedOutEventAttributes): any => ({ ...obj, }); @@ -437,6 +473,9 @@ export interface ActivityTypeConfiguration { } export namespace ActivityTypeConfiguration { + /** + * @internal + */ export const filterSensitiveLog = (obj: ActivityTypeConfiguration): any => ({ ...obj, }); @@ -475,6 +514,9 @@ export interface ActivityTypeInfo { } export namespace ActivityTypeInfo { + /** + * @internal + */ export const filterSensitiveLog = (obj: ActivityTypeInfo): any => ({ ...obj, }); @@ -512,6 +554,9 @@ export interface ActivityTypeDetail { } export namespace ActivityTypeDetail { + /** + * @internal + */ export const filterSensitiveLog = (obj: ActivityTypeDetail): any => ({ ...obj, }); @@ -536,6 +581,9 @@ export interface ActivityTypeInfos { } export namespace ActivityTypeInfos { + /** + * @internal + */ export const filterSensitiveLog = (obj: ActivityTypeInfos): any => ({ ...obj, }); @@ -573,6 +621,9 @@ export interface CancelTimerDecisionAttributes { } export namespace CancelTimerDecisionAttributes { + /** + * @internal + */ export const filterSensitiveLog = (obj: CancelTimerDecisionAttributes): any => ({ ...obj, }); @@ -606,6 +657,9 @@ export interface CancelTimerFailedEventAttributes { } export namespace CancelTimerFailedEventAttributes { + /** + * @internal + */ export const filterSensitiveLog = (obj: CancelTimerFailedEventAttributes): any => ({ ...obj, }); @@ -643,6 +697,9 @@ export interface CancelWorkflowExecutionDecisionAttributes { } export namespace CancelWorkflowExecutionDecisionAttributes { + /** + * @internal + */ export const filterSensitiveLog = (obj: CancelWorkflowExecutionDecisionAttributes): any => ({ ...obj, }); @@ -671,6 +728,9 @@ export interface CancelWorkflowExecutionFailedEventAttributes { } export namespace CancelWorkflowExecutionFailedEventAttributes { + /** + * @internal + */ export const filterSensitiveLog = (obj: CancelWorkflowExecutionFailedEventAttributes): any => ({ ...obj, }); @@ -702,6 +762,9 @@ export interface WorkflowType { } export namespace WorkflowType { + /** + * @internal + */ export const filterSensitiveLog = (obj: WorkflowType): any => ({ ...obj, }); @@ -744,6 +807,9 @@ export interface ChildWorkflowExecutionCanceledEventAttributes { } export namespace ChildWorkflowExecutionCanceledEventAttributes { + /** + * @internal + */ export const filterSensitiveLog = (obj: ChildWorkflowExecutionCanceledEventAttributes): any => ({ ...obj, }); @@ -783,6 +849,9 @@ export interface ChildWorkflowExecutionCompletedEventAttributes { } export namespace ChildWorkflowExecutionCompletedEventAttributes { + /** + * @internal + */ export const filterSensitiveLog = (obj: ChildWorkflowExecutionCompletedEventAttributes): any => ({ ...obj, }); @@ -830,6 +899,9 @@ export interface ChildWorkflowExecutionFailedEventAttributes { } export namespace ChildWorkflowExecutionFailedEventAttributes { + /** + * @internal + */ export const filterSensitiveLog = (obj: ChildWorkflowExecutionFailedEventAttributes): any => ({ ...obj, }); @@ -860,6 +932,9 @@ export interface ChildWorkflowExecutionStartedEventAttributes { } export namespace ChildWorkflowExecutionStartedEventAttributes { + /** + * @internal + */ export const filterSensitiveLog = (obj: ChildWorkflowExecutionStartedEventAttributes): any => ({ ...obj, }); @@ -897,6 +972,9 @@ export interface ChildWorkflowExecutionTerminatedEventAttributes { } export namespace ChildWorkflowExecutionTerminatedEventAttributes { + /** + * @internal + */ export const filterSensitiveLog = (obj: ChildWorkflowExecutionTerminatedEventAttributes): any => ({ ...obj, }); @@ -940,6 +1018,9 @@ export interface ChildWorkflowExecutionTimedOutEventAttributes { } export namespace ChildWorkflowExecutionTimedOutEventAttributes { + /** + * @internal + */ export const filterSensitiveLog = (obj: ChildWorkflowExecutionTimedOutEventAttributes): any => ({ ...obj, }); @@ -960,6 +1041,9 @@ export interface CloseStatusFilter { } export namespace CloseStatusFilter { + /** + * @internal + */ export const filterSensitiveLog = (obj: CloseStatusFilter): any => ({ ...obj, }); @@ -996,6 +1080,9 @@ export interface CompleteWorkflowExecutionDecisionAttributes { } export namespace CompleteWorkflowExecutionDecisionAttributes { + /** + * @internal + */ export const filterSensitiveLog = (obj: CompleteWorkflowExecutionDecisionAttributes): any => ({ ...obj, }); @@ -1026,6 +1113,9 @@ export interface CompleteWorkflowExecutionFailedEventAttributes { } export namespace CompleteWorkflowExecutionFailedEventAttributes { + /** + * @internal + */ export const filterSensitiveLog = (obj: CompleteWorkflowExecutionFailedEventAttributes): any => ({ ...obj, }); @@ -1159,6 +1249,9 @@ export interface ContinueAsNewWorkflowExecutionDecisionAttributes { } export namespace ContinueAsNewWorkflowExecutionDecisionAttributes { + /** + * @internal + */ export const filterSensitiveLog = (obj: ContinueAsNewWorkflowExecutionDecisionAttributes): any => ({ ...obj, }); @@ -1198,6 +1291,9 @@ export interface ContinueAsNewWorkflowExecutionFailedEventAttributes { } export namespace ContinueAsNewWorkflowExecutionFailedEventAttributes { + /** + * @internal + */ export const filterSensitiveLog = (obj: ContinueAsNewWorkflowExecutionFailedEventAttributes): any => ({ ...obj, }); @@ -1222,6 +1318,9 @@ export interface ExecutionTimeFilter { } export namespace ExecutionTimeFilter { + /** + * @internal + */ export const filterSensitiveLog = (obj: ExecutionTimeFilter): any => ({ ...obj, }); @@ -1238,6 +1337,9 @@ export interface WorkflowExecutionFilter { } export namespace WorkflowExecutionFilter { + /** + * @internal + */ export const filterSensitiveLog = (obj: WorkflowExecutionFilter): any => ({ ...obj, }); @@ -1257,6 +1359,9 @@ export interface TagFilter { } export namespace TagFilter { + /** + * @internal + */ export const filterSensitiveLog = (obj: TagFilter): any => ({ ...obj, }); @@ -1279,6 +1384,9 @@ export interface WorkflowTypeFilter { } export namespace WorkflowTypeFilter { + /** + * @internal + */ export const filterSensitiveLog = (obj: WorkflowTypeFilter): any => ({ ...obj, }); @@ -1362,6 +1470,9 @@ export interface CountClosedWorkflowExecutionsInput { } export namespace CountClosedWorkflowExecutionsInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: CountClosedWorkflowExecutionsInput): any => ({ ...obj, }); @@ -1380,6 +1491,9 @@ export interface OperationNotPermittedFault extends __SmithyException, $Metadata } export namespace OperationNotPermittedFault { + /** + * @internal + */ export const filterSensitiveLog = (obj: OperationNotPermittedFault): any => ({ ...obj, }); @@ -1398,6 +1512,9 @@ export interface UnknownResourceFault extends __SmithyException, $MetadataBearer } export namespace UnknownResourceFault { + /** + * @internal + */ export const filterSensitiveLog = (obj: UnknownResourceFault): any => ({ ...obj, }); @@ -1421,6 +1538,9 @@ export interface WorkflowExecutionCount { } export namespace WorkflowExecutionCount { + /** + * @internal + */ export const filterSensitiveLog = (obj: WorkflowExecutionCount): any => ({ ...obj, }); @@ -1472,6 +1592,9 @@ export interface CountOpenWorkflowExecutionsInput { } export namespace CountOpenWorkflowExecutionsInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: CountOpenWorkflowExecutionsInput): any => ({ ...obj, }); @@ -1490,6 +1613,9 @@ export interface CountPendingActivityTasksInput { } export namespace CountPendingActivityTasksInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: CountPendingActivityTasksInput): any => ({ ...obj, }); @@ -1511,6 +1637,9 @@ export interface PendingTaskCount { } export namespace PendingTaskCount { + /** + * @internal + */ export const filterSensitiveLog = (obj: PendingTaskCount): any => ({ ...obj, }); @@ -1529,6 +1658,9 @@ export interface CountPendingDecisionTasksInput { } export namespace CountPendingDecisionTasksInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: CountPendingDecisionTasksInput): any => ({ ...obj, }); @@ -1587,6 +1719,9 @@ export interface FailWorkflowExecutionDecisionAttributes { } export namespace FailWorkflowExecutionDecisionAttributes { + /** + * @internal + */ export const filterSensitiveLog = (obj: FailWorkflowExecutionDecisionAttributes): any => ({ ...obj, }); @@ -1630,6 +1765,9 @@ export interface RecordMarkerDecisionAttributes { } export namespace RecordMarkerDecisionAttributes { + /** + * @internal + */ export const filterSensitiveLog = (obj: RecordMarkerDecisionAttributes): any => ({ ...obj, }); @@ -1667,6 +1805,9 @@ export interface RequestCancelActivityTaskDecisionAttributes { } export namespace RequestCancelActivityTaskDecisionAttributes { + /** + * @internal + */ export const filterSensitiveLog = (obj: RequestCancelActivityTaskDecisionAttributes): any => ({ ...obj, }); @@ -1714,6 +1855,9 @@ export interface RequestCancelExternalWorkflowExecutionDecisionAttributes { } export namespace RequestCancelExternalWorkflowExecutionDecisionAttributes { + /** + * @internal + */ export const filterSensitiveLog = (obj: RequestCancelExternalWorkflowExecutionDecisionAttributes): any => ({ ...obj, }); @@ -1847,6 +1991,9 @@ export interface ScheduleActivityTaskDecisionAttributes { } export namespace ScheduleActivityTaskDecisionAttributes { + /** + * @internal + */ export const filterSensitiveLog = (obj: ScheduleActivityTaskDecisionAttributes): any => ({ ...obj, }); @@ -1885,6 +2032,9 @@ export interface ScheduleLambdaFunctionDecisionAttributes { } export namespace ScheduleLambdaFunctionDecisionAttributes { + /** + * @internal + */ export const filterSensitiveLog = (obj: ScheduleLambdaFunctionDecisionAttributes): any => ({ ...obj, }); @@ -1946,6 +2096,9 @@ export interface SignalExternalWorkflowExecutionDecisionAttributes { } export namespace SignalExternalWorkflowExecutionDecisionAttributes { + /** + * @internal + */ export const filterSensitiveLog = (obj: SignalExternalWorkflowExecutionDecisionAttributes): any => ({ ...obj, }); @@ -2102,6 +2255,9 @@ export interface StartChildWorkflowExecutionDecisionAttributes { } export namespace StartChildWorkflowExecutionDecisionAttributes { + /** + * @internal + */ export const filterSensitiveLog = (obj: StartChildWorkflowExecutionDecisionAttributes): any => ({ ...obj, }); @@ -2153,6 +2309,9 @@ export interface StartTimerDecisionAttributes { } export namespace StartTimerDecisionAttributes { + /** + * @internal + */ export const filterSensitiveLog = (obj: StartTimerDecisionAttributes): any => ({ ...obj, }); @@ -2509,6 +2668,9 @@ export interface Decision { } export namespace Decision { + /** + * @internal + */ export const filterSensitiveLog = (obj: Decision): any => ({ ...obj, }); @@ -2539,6 +2701,9 @@ export interface DecisionTaskCompletedEventAttributes { } export namespace DecisionTaskCompletedEventAttributes { + /** + * @internal + */ export const filterSensitiveLog = (obj: DecisionTaskCompletedEventAttributes): any => ({ ...obj, }); @@ -2570,6 +2735,9 @@ export interface DecisionTaskScheduledEventAttributes { } export namespace DecisionTaskScheduledEventAttributes { + /** + * @internal + */ export const filterSensitiveLog = (obj: DecisionTaskScheduledEventAttributes): any => ({ ...obj, }); @@ -2593,6 +2761,9 @@ export interface DecisionTaskStartedEventAttributes { } export namespace DecisionTaskStartedEventAttributes { + /** + * @internal + */ export const filterSensitiveLog = (obj: DecisionTaskStartedEventAttributes): any => ({ ...obj, }); @@ -2625,6 +2796,9 @@ export interface DecisionTaskTimedOutEventAttributes { } export namespace DecisionTaskTimedOutEventAttributes { + /** + * @internal + */ export const filterSensitiveLog = (obj: DecisionTaskTimedOutEventAttributes): any => ({ ...obj, }); @@ -2705,6 +2879,9 @@ export interface ExternalWorkflowExecutionCancelRequestedEventAttributes { } export namespace ExternalWorkflowExecutionCancelRequestedEventAttributes { + /** + * @internal + */ export const filterSensitiveLog = (obj: ExternalWorkflowExecutionCancelRequestedEventAttributes): any => ({ ...obj, }); @@ -2728,6 +2905,9 @@ export interface ExternalWorkflowExecutionSignaledEventAttributes { } export namespace ExternalWorkflowExecutionSignaledEventAttributes { + /** + * @internal + */ export const filterSensitiveLog = (obj: ExternalWorkflowExecutionSignaledEventAttributes): any => ({ ...obj, }); @@ -2758,6 +2938,9 @@ export interface FailWorkflowExecutionFailedEventAttributes { } export namespace FailWorkflowExecutionFailedEventAttributes { + /** + * @internal + */ export const filterSensitiveLog = (obj: FailWorkflowExecutionFailedEventAttributes): any => ({ ...obj, }); @@ -2787,6 +2970,9 @@ export interface LambdaFunctionCompletedEventAttributes { } export namespace LambdaFunctionCompletedEventAttributes { + /** + * @internal + */ export const filterSensitiveLog = (obj: LambdaFunctionCompletedEventAttributes): any => ({ ...obj, }); @@ -2821,6 +3007,9 @@ export interface LambdaFunctionFailedEventAttributes { } export namespace LambdaFunctionFailedEventAttributes { + /** + * @internal + */ export const filterSensitiveLog = (obj: LambdaFunctionFailedEventAttributes): any => ({ ...obj, }); @@ -2865,6 +3054,9 @@ export interface LambdaFunctionScheduledEventAttributes { } export namespace LambdaFunctionScheduledEventAttributes { + /** + * @internal + */ export const filterSensitiveLog = (obj: LambdaFunctionScheduledEventAttributes): any => ({ ...obj, }); @@ -2883,6 +3075,9 @@ export interface LambdaFunctionStartedEventAttributes { } export namespace LambdaFunctionStartedEventAttributes { + /** + * @internal + */ export const filterSensitiveLog = (obj: LambdaFunctionStartedEventAttributes): any => ({ ...obj, }); @@ -2913,6 +3108,9 @@ export interface LambdaFunctionTimedOutEventAttributes { } export namespace LambdaFunctionTimedOutEventAttributes { + /** + * @internal + */ export const filterSensitiveLog = (obj: LambdaFunctionTimedOutEventAttributes): any => ({ ...obj, }); @@ -2941,6 +3139,9 @@ export interface MarkerRecordedEventAttributes { } export namespace MarkerRecordedEventAttributes { + /** + * @internal + */ export const filterSensitiveLog = (obj: MarkerRecordedEventAttributes): any => ({ ...obj, }); @@ -2976,6 +3177,9 @@ export interface RecordMarkerFailedEventAttributes { } export namespace RecordMarkerFailedEventAttributes { + /** + * @internal + */ export const filterSensitiveLog = (obj: RecordMarkerFailedEventAttributes): any => ({ ...obj, }); @@ -3011,6 +3215,9 @@ export interface RequestCancelActivityTaskFailedEventAttributes { } export namespace RequestCancelActivityTaskFailedEventAttributes { + /** + * @internal + */ export const filterSensitiveLog = (obj: RequestCancelActivityTaskFailedEventAttributes): any => ({ ...obj, }); @@ -3068,6 +3275,9 @@ export interface RequestCancelExternalWorkflowExecutionFailedEventAttributes { } export namespace RequestCancelExternalWorkflowExecutionFailedEventAttributes { + /** + * @internal + */ export const filterSensitiveLog = (obj: RequestCancelExternalWorkflowExecutionFailedEventAttributes): any => ({ ...obj, }); @@ -3102,6 +3312,9 @@ export interface RequestCancelExternalWorkflowExecutionInitiatedEventAttributes } export namespace RequestCancelExternalWorkflowExecutionInitiatedEventAttributes { + /** + * @internal + */ export const filterSensitiveLog = (obj: RequestCancelExternalWorkflowExecutionInitiatedEventAttributes): any => ({ ...obj, }); @@ -3153,6 +3366,9 @@ export interface ScheduleActivityTaskFailedEventAttributes { } export namespace ScheduleActivityTaskFailedEventAttributes { + /** + * @internal + */ export const filterSensitiveLog = (obj: ScheduleActivityTaskFailedEventAttributes): any => ({ ...obj, }); @@ -3200,6 +3416,9 @@ export interface ScheduleLambdaFunctionFailedEventAttributes { } export namespace ScheduleLambdaFunctionFailedEventAttributes { + /** + * @internal + */ export const filterSensitiveLog = (obj: ScheduleLambdaFunctionFailedEventAttributes): any => ({ ...obj, }); @@ -3256,6 +3475,9 @@ export interface SignalExternalWorkflowExecutionFailedEventAttributes { } export namespace SignalExternalWorkflowExecutionFailedEventAttributes { + /** + * @internal + */ export const filterSensitiveLog = (obj: SignalExternalWorkflowExecutionFailedEventAttributes): any => ({ ...obj, }); @@ -3299,6 +3521,9 @@ export interface SignalExternalWorkflowExecutionInitiatedEventAttributes { } export namespace SignalExternalWorkflowExecutionInitiatedEventAttributes { + /** + * @internal + */ export const filterSensitiveLog = (obj: SignalExternalWorkflowExecutionInitiatedEventAttributes): any => ({ ...obj, }); @@ -3366,6 +3591,9 @@ export interface StartChildWorkflowExecutionFailedEventAttributes { } export namespace StartChildWorkflowExecutionFailedEventAttributes { + /** + * @internal + */ export const filterSensitiveLog = (obj: StartChildWorkflowExecutionFailedEventAttributes): any => ({ ...obj, }); @@ -3464,6 +3692,9 @@ export interface StartChildWorkflowExecutionInitiatedEventAttributes { } export namespace StartChildWorkflowExecutionInitiatedEventAttributes { + /** + * @internal + */ export const filterSensitiveLog = (obj: StartChildWorkflowExecutionInitiatedEventAttributes): any => ({ ...obj, }); @@ -3500,6 +3731,9 @@ export interface StartLambdaFunctionFailedEventAttributes { } export namespace StartLambdaFunctionFailedEventAttributes { + /** + * @internal + */ export const filterSensitiveLog = (obj: StartLambdaFunctionFailedEventAttributes): any => ({ ...obj, }); @@ -3539,6 +3773,9 @@ export interface StartTimerFailedEventAttributes { } export namespace StartTimerFailedEventAttributes { + /** + * @internal + */ export const filterSensitiveLog = (obj: StartTimerFailedEventAttributes): any => ({ ...obj, }); @@ -3571,6 +3808,9 @@ export interface TimerCanceledEventAttributes { } export namespace TimerCanceledEventAttributes { + /** + * @internal + */ export const filterSensitiveLog = (obj: TimerCanceledEventAttributes): any => ({ ...obj, }); @@ -3594,6 +3834,9 @@ export interface TimerFiredEventAttributes { } export namespace TimerFiredEventAttributes { + /** + * @internal + */ export const filterSensitiveLog = (obj: TimerFiredEventAttributes): any => ({ ...obj, }); @@ -3628,6 +3871,9 @@ export interface TimerStartedEventAttributes { } export namespace TimerStartedEventAttributes { + /** + * @internal + */ export const filterSensitiveLog = (obj: TimerStartedEventAttributes): any => ({ ...obj, }); @@ -3651,6 +3897,9 @@ export interface WorkflowExecutionCanceledEventAttributes { } export namespace WorkflowExecutionCanceledEventAttributes { + /** + * @internal + */ export const filterSensitiveLog = (obj: WorkflowExecutionCanceledEventAttributes): any => ({ ...obj, }); @@ -3682,6 +3931,9 @@ export interface WorkflowExecutionCancelRequestedEventAttributes { } export namespace WorkflowExecutionCancelRequestedEventAttributes { + /** + * @internal + */ export const filterSensitiveLog = (obj: WorkflowExecutionCancelRequestedEventAttributes): any => ({ ...obj, }); @@ -3705,6 +3957,9 @@ export interface WorkflowExecutionCompletedEventAttributes { } export namespace WorkflowExecutionCompletedEventAttributes { + /** + * @internal + */ export const filterSensitiveLog = (obj: WorkflowExecutionCompletedEventAttributes): any => ({ ...obj, }); @@ -3795,6 +4050,9 @@ export interface WorkflowExecutionContinuedAsNewEventAttributes { } export namespace WorkflowExecutionContinuedAsNewEventAttributes { + /** + * @internal + */ export const filterSensitiveLog = (obj: WorkflowExecutionContinuedAsNewEventAttributes): any => ({ ...obj, }); @@ -3823,6 +4081,9 @@ export interface WorkflowExecutionFailedEventAttributes { } export namespace WorkflowExecutionFailedEventAttributes { + /** + * @internal + */ export const filterSensitiveLog = (obj: WorkflowExecutionFailedEventAttributes): any => ({ ...obj, }); @@ -3858,6 +4119,9 @@ export interface WorkflowExecutionSignaledEventAttributes { } export namespace WorkflowExecutionSignaledEventAttributes { + /** + * @internal + */ export const filterSensitiveLog = (obj: WorkflowExecutionSignaledEventAttributes): any => ({ ...obj, }); @@ -3955,6 +4219,9 @@ export interface WorkflowExecutionStartedEventAttributes { } export namespace WorkflowExecutionStartedEventAttributes { + /** + * @internal + */ export const filterSensitiveLog = (obj: WorkflowExecutionStartedEventAttributes): any => ({ ...obj, }); @@ -4005,6 +4272,9 @@ export interface WorkflowExecutionTerminatedEventAttributes { } export namespace WorkflowExecutionTerminatedEventAttributes { + /** + * @internal + */ export const filterSensitiveLog = (obj: WorkflowExecutionTerminatedEventAttributes): any => ({ ...obj, }); @@ -4043,6 +4313,9 @@ export interface WorkflowExecutionTimedOutEventAttributes { } export namespace WorkflowExecutionTimedOutEventAttributes { + /** + * @internal + */ export const filterSensitiveLog = (obj: WorkflowExecutionTimedOutEventAttributes): any => ({ ...obj, }); @@ -4610,6 +4883,9 @@ export interface HistoryEvent { } export namespace HistoryEvent { + /** + * @internal + */ export const filterSensitiveLog = (obj: HistoryEvent): any => ({ ...obj, }); @@ -4659,6 +4935,9 @@ export interface DecisionTask { } export namespace DecisionTask { + /** + * @internal + */ export const filterSensitiveLog = (obj: DecisionTask): any => ({ ...obj, }); @@ -4684,6 +4963,9 @@ export interface DefaultUndefinedFault extends __SmithyException, $MetadataBeare } export namespace DefaultUndefinedFault { + /** + * @internal + */ export const filterSensitiveLog = (obj: DefaultUndefinedFault): any => ({ ...obj, }); @@ -4702,6 +4984,9 @@ export interface DeprecateActivityTypeInput { } export namespace DeprecateActivityTypeInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeprecateActivityTypeInput): any => ({ ...obj, }); @@ -4720,6 +5005,9 @@ export interface TypeDeprecatedFault extends __SmithyException, $MetadataBearer } export namespace TypeDeprecatedFault { + /** + * @internal + */ export const filterSensitiveLog = (obj: TypeDeprecatedFault): any => ({ ...obj, }); @@ -4733,6 +5021,9 @@ export interface DeprecateDomainInput { } export namespace DeprecateDomainInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeprecateDomainInput): any => ({ ...obj, }); @@ -4751,6 +5042,9 @@ export interface DomainDeprecatedFault extends __SmithyException, $MetadataBeare } export namespace DomainDeprecatedFault { + /** + * @internal + */ export const filterSensitiveLog = (obj: DomainDeprecatedFault): any => ({ ...obj, }); @@ -4769,6 +5063,9 @@ export interface DeprecateWorkflowTypeInput { } export namespace DeprecateWorkflowTypeInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeprecateWorkflowTypeInput): any => ({ ...obj, }); @@ -4789,6 +5086,9 @@ export interface DescribeActivityTypeInput { } export namespace DescribeActivityTypeInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeActivityTypeInput): any => ({ ...obj, }); @@ -4802,6 +5102,9 @@ export interface DescribeDomainInput { } export namespace DescribeDomainInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeDomainInput): any => ({ ...obj, }); @@ -4818,6 +5121,9 @@ export interface DomainConfiguration { } export namespace DomainConfiguration { + /** + * @internal + */ export const filterSensitiveLog = (obj: DomainConfiguration): any => ({ ...obj, }); @@ -4863,6 +5169,9 @@ export interface DomainInfo { } export namespace DomainInfo { + /** + * @internal + */ export const filterSensitiveLog = (obj: DomainInfo): any => ({ ...obj, }); @@ -4886,6 +5195,9 @@ export interface DomainDetail { } export namespace DomainDetail { + /** + * @internal + */ export const filterSensitiveLog = (obj: DomainDetail): any => ({ ...obj, }); @@ -4904,6 +5216,9 @@ export interface DescribeWorkflowExecutionInput { } export namespace DescribeWorkflowExecutionInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeWorkflowExecutionInput): any => ({ ...obj, }); @@ -4967,6 +5282,9 @@ export interface WorkflowExecutionConfiguration { } export namespace WorkflowExecutionConfiguration { + /** + * @internal + */ export const filterSensitiveLog = (obj: WorkflowExecutionConfiguration): any => ({ ...obj, }); @@ -5054,6 +5372,9 @@ export interface WorkflowExecutionInfo { } export namespace WorkflowExecutionInfo { + /** + * @internal + */ export const filterSensitiveLog = (obj: WorkflowExecutionInfo): any => ({ ...obj, }); @@ -5090,6 +5411,9 @@ export interface WorkflowExecutionOpenCounts { } export namespace WorkflowExecutionOpenCounts { + /** + * @internal + */ export const filterSensitiveLog = (obj: WorkflowExecutionOpenCounts): any => ({ ...obj, }); @@ -5127,6 +5451,9 @@ export interface WorkflowExecutionDetail { } export namespace WorkflowExecutionDetail { + /** + * @internal + */ export const filterSensitiveLog = (obj: WorkflowExecutionDetail): any => ({ ...obj, }); @@ -5145,6 +5472,9 @@ export interface DescribeWorkflowTypeInput { } export namespace DescribeWorkflowTypeInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeWorkflowTypeInput): any => ({ ...obj, }); @@ -5236,6 +5566,9 @@ export interface WorkflowTypeConfiguration { } export namespace WorkflowTypeConfiguration { + /** + * @internal + */ export const filterSensitiveLog = (obj: WorkflowTypeConfiguration): any => ({ ...obj, }); @@ -5272,6 +5605,9 @@ export interface WorkflowTypeInfo { } export namespace WorkflowTypeInfo { + /** + * @internal + */ export const filterSensitiveLog = (obj: WorkflowTypeInfo): any => ({ ...obj, }); @@ -5306,6 +5642,9 @@ export interface WorkflowTypeDetail { } export namespace WorkflowTypeDetail { + /** + * @internal + */ export const filterSensitiveLog = (obj: WorkflowTypeDetail): any => ({ ...obj, }); @@ -5324,6 +5663,9 @@ export interface DomainAlreadyExistsFault extends __SmithyException, $MetadataBe } export namespace DomainAlreadyExistsFault { + /** + * @internal + */ export const filterSensitiveLog = (obj: DomainAlreadyExistsFault): any => ({ ...obj, }); @@ -5348,6 +5690,9 @@ export interface DomainInfos { } export namespace DomainInfos { + /** + * @internal + */ export const filterSensitiveLog = (obj: DomainInfos): any => ({ ...obj, }); @@ -5391,6 +5736,9 @@ export interface GetWorkflowExecutionHistoryInput { } export namespace GetWorkflowExecutionHistoryInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetWorkflowExecutionHistoryInput): any => ({ ...obj, }); @@ -5415,6 +5763,9 @@ export interface History { } export namespace History { + /** + * @internal + */ export const filterSensitiveLog = (obj: History): any => ({ ...obj, }); @@ -5433,6 +5784,9 @@ export interface LimitExceededFault extends __SmithyException, $MetadataBearer { } export namespace LimitExceededFault { + /** + * @internal + */ export const filterSensitiveLog = (obj: LimitExceededFault): any => ({ ...obj, }); @@ -5481,6 +5835,9 @@ export interface ListActivityTypesInput { } export namespace ListActivityTypesInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListActivityTypesInput): any => ({ ...obj, }); @@ -5591,6 +5948,9 @@ export interface ListClosedWorkflowExecutionsInput { } export namespace ListClosedWorkflowExecutionsInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListClosedWorkflowExecutionsInput): any => ({ ...obj, }); @@ -5615,6 +5975,9 @@ export interface WorkflowExecutionInfos { } export namespace WorkflowExecutionInfos { + /** + * @internal + */ export const filterSensitiveLog = (obj: WorkflowExecutionInfos): any => ({ ...obj, }); @@ -5653,6 +6016,9 @@ export interface ListDomainsInput { } export namespace ListDomainsInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListDomainsInput): any => ({ ...obj, }); @@ -5728,6 +6094,9 @@ export interface ListOpenWorkflowExecutionsInput { } export namespace ListOpenWorkflowExecutionsInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListOpenWorkflowExecutionsInput): any => ({ ...obj, }); @@ -5741,6 +6110,9 @@ export interface ListTagsForResourceInput { } export namespace ListTagsForResourceInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListTagsForResourceInput): any => ({ ...obj, }); @@ -5764,6 +6136,9 @@ export interface ResourceTag { } export namespace ResourceTag { + /** + * @internal + */ export const filterSensitiveLog = (obj: ResourceTag): any => ({ ...obj, }); @@ -5777,6 +6152,9 @@ export interface ListTagsForResourceOutput { } export namespace ListTagsForResourceOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListTagsForResourceOutput): any => ({ ...obj, }); @@ -5825,6 +6203,9 @@ export interface ListWorkflowTypesInput { } export namespace ListWorkflowTypesInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListWorkflowTypesInput): any => ({ ...obj, }); @@ -5849,6 +6230,9 @@ export interface WorkflowTypeInfos { } export namespace WorkflowTypeInfos { + /** + * @internal + */ export const filterSensitiveLog = (obj: WorkflowTypeInfos): any => ({ ...obj, }); @@ -5879,6 +6263,9 @@ export interface PollForActivityTaskInput { } export namespace PollForActivityTaskInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: PollForActivityTaskInput): any => ({ ...obj, }); @@ -5942,6 +6329,9 @@ export interface PollForDecisionTaskInput { } export namespace PollForDecisionTaskInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: PollForDecisionTaskInput): any => ({ ...obj, }); @@ -5966,6 +6356,9 @@ export interface RecordActivityTaskHeartbeatInput { } export namespace RecordActivityTaskHeartbeatInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: RecordActivityTaskHeartbeatInput): any => ({ ...obj, }); @@ -6071,6 +6464,9 @@ export interface RegisterActivityTypeInput { } export namespace RegisterActivityTypeInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: RegisterActivityTypeInput): any => ({ ...obj, }); @@ -6089,6 +6485,9 @@ export interface TypeAlreadyExistsFault extends __SmithyException, $MetadataBear } export namespace TypeAlreadyExistsFault { + /** + * @internal + */ export const filterSensitiveLog = (obj: TypeAlreadyExistsFault): any => ({ ...obj, }); @@ -6132,6 +6531,9 @@ export interface RegisterDomainInput { } export namespace RegisterDomainInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: RegisterDomainInput): any => ({ ...obj, }); @@ -6147,6 +6549,9 @@ export interface TooManyTagsFault extends __SmithyException, $MetadataBearer { } export namespace TooManyTagsFault { + /** + * @internal + */ export const filterSensitiveLog = (obj: TooManyTagsFault): any => ({ ...obj, }); @@ -6269,6 +6674,9 @@ export interface RegisterWorkflowTypeInput { } export namespace RegisterWorkflowTypeInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: RegisterWorkflowTypeInput): any => ({ ...obj, }); @@ -6292,6 +6700,9 @@ export interface RequestCancelWorkflowExecutionInput { } export namespace RequestCancelWorkflowExecutionInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: RequestCancelWorkflowExecutionInput): any => ({ ...obj, }); @@ -6316,6 +6727,9 @@ export interface RespondActivityTaskCanceledInput { } export namespace RespondActivityTaskCanceledInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: RespondActivityTaskCanceledInput): any => ({ ...obj, }); @@ -6341,6 +6755,9 @@ export interface RespondActivityTaskCompletedInput { } export namespace RespondActivityTaskCompletedInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: RespondActivityTaskCompletedInput): any => ({ ...obj, }); @@ -6371,6 +6788,9 @@ export interface RespondActivityTaskFailedInput { } export namespace RespondActivityTaskFailedInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: RespondActivityTaskFailedInput): any => ({ ...obj, }); @@ -6405,6 +6825,9 @@ export interface RespondDecisionTaskCompletedInput { } export namespace RespondDecisionTaskCompletedInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: RespondDecisionTaskCompletedInput): any => ({ ...obj, }); @@ -6422,6 +6845,9 @@ export interface Run { } export namespace Run { + /** + * @internal + */ export const filterSensitiveLog = (obj: Run): any => ({ ...obj, }); @@ -6456,6 +6882,9 @@ export interface SignalWorkflowExecutionInput { } export namespace SignalWorkflowExecutionInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: SignalWorkflowExecutionInput): any => ({ ...obj, }); @@ -6606,6 +7035,9 @@ export interface StartWorkflowExecutionInput { } export namespace StartWorkflowExecutionInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: StartWorkflowExecutionInput): any => ({ ...obj, }); @@ -6625,6 +7057,9 @@ export interface WorkflowExecutionAlreadyStartedFault extends __SmithyException, } export namespace WorkflowExecutionAlreadyStartedFault { + /** + * @internal + */ export const filterSensitiveLog = (obj: WorkflowExecutionAlreadyStartedFault): any => ({ ...obj, }); @@ -6644,6 +7079,9 @@ export interface TagResourceInput { } export namespace TagResourceInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: TagResourceInput): any => ({ ...obj, }); @@ -6708,6 +7146,9 @@ export interface TerminateWorkflowExecutionInput { } export namespace TerminateWorkflowExecutionInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: TerminateWorkflowExecutionInput): any => ({ ...obj, }); @@ -6726,6 +7167,9 @@ export interface UndeprecateActivityTypeInput { } export namespace UndeprecateActivityTypeInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: UndeprecateActivityTypeInput): any => ({ ...obj, }); @@ -6739,6 +7183,9 @@ export interface UndeprecateDomainInput { } export namespace UndeprecateDomainInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: UndeprecateDomainInput): any => ({ ...obj, }); @@ -6757,6 +7204,9 @@ export interface UndeprecateWorkflowTypeInput { } export namespace UndeprecateWorkflowTypeInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: UndeprecateWorkflowTypeInput): any => ({ ...obj, }); @@ -6775,6 +7225,9 @@ export interface UntagResourceInput { } export namespace UntagResourceInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: UntagResourceInput): any => ({ ...obj, }); diff --git a/clients/client-synthetics/commands/CreateCanaryCommand.ts b/clients/client-synthetics/commands/CreateCanaryCommand.ts index d822705ad085..12cc2b44c9be 100644 --- a/clients/client-synthetics/commands/CreateCanaryCommand.ts +++ b/clients/client-synthetics/commands/CreateCanaryCommand.ts @@ -35,6 +35,20 @@ export interface CreateCanaryCommandOutput extends CreateCanaryResponse, __Metad * 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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { SyntheticsClient, CreateCanaryCommand } from "@aws-sdk/client-synthetics"; // ES Modules import + * // const { SyntheticsClient, CreateCanaryCommand } = require("@aws-sdk/client-synthetics"); // CommonJS import + * const client = new SyntheticsClient(config); + * const command = new CreateCanaryCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreateCanaryCommandInput} for command's `input` shape. + * @see {@link CreateCanaryCommandOutput} for command's `response` shape. + * @see {@link SyntheticsClientResolvedConfig | config} for command's `input` shape. + * */ export class CreateCanaryCommand extends $Command< CreateCanaryCommandInput, diff --git a/clients/client-synthetics/commands/DeleteCanaryCommand.ts b/clients/client-synthetics/commands/DeleteCanaryCommand.ts index 5c982bdc3edf..5c424c1e863d 100644 --- a/clients/client-synthetics/commands/DeleteCanaryCommand.ts +++ b/clients/client-synthetics/commands/DeleteCanaryCommand.ts @@ -56,6 +56,20 @@ export interface DeleteCanaryCommandOutput extends DeleteCanaryResponse, __Metad * 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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { SyntheticsClient, DeleteCanaryCommand } from "@aws-sdk/client-synthetics"; // ES Modules import + * // const { SyntheticsClient, DeleteCanaryCommand } = require("@aws-sdk/client-synthetics"); // CommonJS import + * const client = new SyntheticsClient(config); + * const command = new DeleteCanaryCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteCanaryCommandInput} for command's `input` shape. + * @see {@link DeleteCanaryCommandOutput} for command's `response` shape. + * @see {@link SyntheticsClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteCanaryCommand extends $Command< DeleteCanaryCommandInput, diff --git a/clients/client-synthetics/commands/DescribeCanariesCommand.ts b/clients/client-synthetics/commands/DescribeCanariesCommand.ts index b4c7ab639125..50f9c1e1499f 100644 --- a/clients/client-synthetics/commands/DescribeCanariesCommand.ts +++ b/clients/client-synthetics/commands/DescribeCanariesCommand.ts @@ -27,6 +27,20 @@ export interface DescribeCanariesCommandOutput extends DescribeCanariesResponse, * DescribeCanaries, the user can see all of the canaries in the account. A * deny policy can only be used to restrict access to all canaries. It cannot be used on * specific resources.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { SyntheticsClient, DescribeCanariesCommand } from "@aws-sdk/client-synthetics"; // ES Modules import + * // const { SyntheticsClient, DescribeCanariesCommand } = require("@aws-sdk/client-synthetics"); // CommonJS import + * const client = new SyntheticsClient(config); + * const command = new DescribeCanariesCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeCanariesCommandInput} for command's `input` shape. + * @see {@link DescribeCanariesCommandOutput} for command's `response` shape. + * @see {@link SyntheticsClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeCanariesCommand extends $Command< DescribeCanariesCommandInput, diff --git a/clients/client-synthetics/commands/DescribeCanariesLastRunCommand.ts b/clients/client-synthetics/commands/DescribeCanariesLastRunCommand.ts index 4f691957fa0a..0bc9895d5ddb 100644 --- a/clients/client-synthetics/commands/DescribeCanariesLastRunCommand.ts +++ b/clients/client-synthetics/commands/DescribeCanariesLastRunCommand.ts @@ -22,6 +22,20 @@ export interface DescribeCanariesLastRunCommandOutput extends DescribeCanariesLa /** *

Use this operation to see information from the most recent run of each canary that you have created.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { SyntheticsClient, DescribeCanariesLastRunCommand } from "@aws-sdk/client-synthetics"; // ES Modules import + * // const { SyntheticsClient, DescribeCanariesLastRunCommand } = require("@aws-sdk/client-synthetics"); // CommonJS import + * const client = new SyntheticsClient(config); + * const command = new DescribeCanariesLastRunCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeCanariesLastRunCommandInput} for command's `input` shape. + * @see {@link DescribeCanariesLastRunCommandOutput} for command's `response` shape. + * @see {@link SyntheticsClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeCanariesLastRunCommand extends $Command< DescribeCanariesLastRunCommandInput, diff --git a/clients/client-synthetics/commands/DescribeRuntimeVersionsCommand.ts b/clients/client-synthetics/commands/DescribeRuntimeVersionsCommand.ts index 644efb3ae7ae..1400abfd8567 100644 --- a/clients/client-synthetics/commands/DescribeRuntimeVersionsCommand.ts +++ b/clients/client-synthetics/commands/DescribeRuntimeVersionsCommand.ts @@ -24,6 +24,20 @@ export interface DescribeRuntimeVersionsCommandOutput extends DescribeRuntimeVer *

Returns a list of Synthetics canary runtime versions. For more information, * see * Canary Runtime Versions.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { SyntheticsClient, DescribeRuntimeVersionsCommand } from "@aws-sdk/client-synthetics"; // ES Modules import + * // const { SyntheticsClient, DescribeRuntimeVersionsCommand } = require("@aws-sdk/client-synthetics"); // CommonJS import + * const client = new SyntheticsClient(config); + * const command = new DescribeRuntimeVersionsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeRuntimeVersionsCommandInput} for command's `input` shape. + * @see {@link DescribeRuntimeVersionsCommandOutput} for command's `response` shape. + * @see {@link SyntheticsClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeRuntimeVersionsCommand extends $Command< DescribeRuntimeVersionsCommandInput, diff --git a/clients/client-synthetics/commands/GetCanaryCommand.ts b/clients/client-synthetics/commands/GetCanaryCommand.ts index 8b87bc583d21..0ac4f45e00f9 100644 --- a/clients/client-synthetics/commands/GetCanaryCommand.ts +++ b/clients/client-synthetics/commands/GetCanaryCommand.ts @@ -24,6 +24,20 @@ export interface GetCanaryCommandOutput extends GetCanaryResponse, __MetadataBea *

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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { SyntheticsClient, GetCanaryCommand } from "@aws-sdk/client-synthetics"; // ES Modules import + * // const { SyntheticsClient, GetCanaryCommand } = require("@aws-sdk/client-synthetics"); // CommonJS import + * const client = new SyntheticsClient(config); + * const command = new GetCanaryCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetCanaryCommandInput} for command's `input` shape. + * @see {@link GetCanaryCommandOutput} for command's `response` shape. + * @see {@link SyntheticsClientResolvedConfig | config} for command's `input` shape. + * */ export class GetCanaryCommand extends $Command< GetCanaryCommandInput, diff --git a/clients/client-synthetics/commands/GetCanaryRunsCommand.ts b/clients/client-synthetics/commands/GetCanaryRunsCommand.ts index a61241ca3531..6eebbad11503 100644 --- a/clients/client-synthetics/commands/GetCanaryRunsCommand.ts +++ b/clients/client-synthetics/commands/GetCanaryRunsCommand.ts @@ -22,6 +22,20 @@ export interface GetCanaryRunsCommandOutput extends GetCanaryRunsResponse, __Met /** *

Retrieves a list of runs for a specified canary.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { SyntheticsClient, GetCanaryRunsCommand } from "@aws-sdk/client-synthetics"; // ES Modules import + * // const { SyntheticsClient, GetCanaryRunsCommand } = require("@aws-sdk/client-synthetics"); // CommonJS import + * const client = new SyntheticsClient(config); + * const command = new GetCanaryRunsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetCanaryRunsCommandInput} for command's `input` shape. + * @see {@link GetCanaryRunsCommandOutput} for command's `response` shape. + * @see {@link SyntheticsClientResolvedConfig | config} for command's `input` shape. + * */ export class GetCanaryRunsCommand extends $Command< GetCanaryRunsCommandInput, diff --git a/clients/client-synthetics/commands/ListTagsForResourceCommand.ts b/clients/client-synthetics/commands/ListTagsForResourceCommand.ts index e76932b9ee90..bd9e0c9e3cdb 100644 --- a/clients/client-synthetics/commands/ListTagsForResourceCommand.ts +++ b/clients/client-synthetics/commands/ListTagsForResourceCommand.ts @@ -22,6 +22,20 @@ export interface ListTagsForResourceCommandOutput extends ListTagsForResourceRes /** *

Displays the tags associated with a canary.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { SyntheticsClient, ListTagsForResourceCommand } from "@aws-sdk/client-synthetics"; // ES Modules import + * // const { SyntheticsClient, ListTagsForResourceCommand } = require("@aws-sdk/client-synthetics"); // CommonJS import + * const client = new SyntheticsClient(config); + * const command = new ListTagsForResourceCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListTagsForResourceCommandInput} for command's `input` shape. + * @see {@link ListTagsForResourceCommandOutput} for command's `response` shape. + * @see {@link SyntheticsClientResolvedConfig | config} for command's `input` shape. + * */ export class ListTagsForResourceCommand extends $Command< ListTagsForResourceCommandInput, diff --git a/clients/client-synthetics/commands/StartCanaryCommand.ts b/clients/client-synthetics/commands/StartCanaryCommand.ts index 27853cb88f26..f1b0e08b0480 100644 --- a/clients/client-synthetics/commands/StartCanaryCommand.ts +++ b/clients/client-synthetics/commands/StartCanaryCommand.ts @@ -24,6 +24,20 @@ export interface StartCanaryCommandOutput extends StartCanaryResponse, __Metadat *

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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { SyntheticsClient, StartCanaryCommand } from "@aws-sdk/client-synthetics"; // ES Modules import + * // const { SyntheticsClient, StartCanaryCommand } = require("@aws-sdk/client-synthetics"); // CommonJS import + * const client = new SyntheticsClient(config); + * const command = new StartCanaryCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link StartCanaryCommandInput} for command's `input` shape. + * @see {@link StartCanaryCommandOutput} for command's `response` shape. + * @see {@link SyntheticsClientResolvedConfig | config} for command's `input` shape. + * */ export class StartCanaryCommand extends $Command< StartCanaryCommandInput, diff --git a/clients/client-synthetics/commands/StopCanaryCommand.ts b/clients/client-synthetics/commands/StopCanaryCommand.ts index ef493d56e149..ca77e9cf4c6d 100644 --- a/clients/client-synthetics/commands/StopCanaryCommand.ts +++ b/clients/client-synthetics/commands/StopCanaryCommand.ts @@ -27,6 +27,20 @@ export interface StopCanaryCommandOutput extends StopCanaryResponse, __MetadataB * 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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { SyntheticsClient, StopCanaryCommand } from "@aws-sdk/client-synthetics"; // ES Modules import + * // const { SyntheticsClient, StopCanaryCommand } = require("@aws-sdk/client-synthetics"); // CommonJS import + * const client = new SyntheticsClient(config); + * const command = new StopCanaryCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link StopCanaryCommandInput} for command's `input` shape. + * @see {@link StopCanaryCommandOutput} for command's `response` shape. + * @see {@link SyntheticsClientResolvedConfig | config} for command's `input` shape. + * */ export class StopCanaryCommand extends $Command< StopCanaryCommandInput, diff --git a/clients/client-synthetics/commands/TagResourceCommand.ts b/clients/client-synthetics/commands/TagResourceCommand.ts index 70c88fb48ce2..d05a9a28198e 100644 --- a/clients/client-synthetics/commands/TagResourceCommand.ts +++ b/clients/client-synthetics/commands/TagResourceCommand.ts @@ -31,6 +31,20 @@ export interface TagResourceCommandOutput extends TagResourceResponse, __Metadat * 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 canary.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { SyntheticsClient, TagResourceCommand } from "@aws-sdk/client-synthetics"; // ES Modules import + * // const { SyntheticsClient, TagResourceCommand } = require("@aws-sdk/client-synthetics"); // CommonJS import + * const client = new SyntheticsClient(config); + * const command = new TagResourceCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link TagResourceCommandInput} for command's `input` shape. + * @see {@link TagResourceCommandOutput} for command's `response` shape. + * @see {@link SyntheticsClientResolvedConfig | config} for command's `input` shape. + * */ export class TagResourceCommand extends $Command< TagResourceCommandInput, diff --git a/clients/client-synthetics/commands/UntagResourceCommand.ts b/clients/client-synthetics/commands/UntagResourceCommand.ts index ad5b903d27b0..e5021cd2c1d8 100644 --- a/clients/client-synthetics/commands/UntagResourceCommand.ts +++ b/clients/client-synthetics/commands/UntagResourceCommand.ts @@ -22,6 +22,20 @@ export interface UntagResourceCommandOutput extends UntagResourceResponse, __Met /** *

Removes one or more tags from the specified canary.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { SyntheticsClient, UntagResourceCommand } from "@aws-sdk/client-synthetics"; // ES Modules import + * // const { SyntheticsClient, UntagResourceCommand } = require("@aws-sdk/client-synthetics"); // CommonJS import + * const client = new SyntheticsClient(config); + * const command = new UntagResourceCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link UntagResourceCommandInput} for command's `input` shape. + * @see {@link UntagResourceCommandOutput} for command's `response` shape. + * @see {@link SyntheticsClientResolvedConfig | config} for command's `input` shape. + * */ export class UntagResourceCommand extends $Command< UntagResourceCommandInput, diff --git a/clients/client-synthetics/commands/UpdateCanaryCommand.ts b/clients/client-synthetics/commands/UpdateCanaryCommand.ts index 839e03702dcc..c45f938fd11a 100644 --- a/clients/client-synthetics/commands/UpdateCanaryCommand.ts +++ b/clients/client-synthetics/commands/UpdateCanaryCommand.ts @@ -26,6 +26,20 @@ export interface UpdateCanaryCommandOutput extends UpdateCanaryResponse, __Metad *

You can't use this operation to update the tags of an existing canary. To * change the tags of an existing canary, use * TagResource.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { SyntheticsClient, UpdateCanaryCommand } from "@aws-sdk/client-synthetics"; // ES Modules import + * // const { SyntheticsClient, UpdateCanaryCommand } = require("@aws-sdk/client-synthetics"); // CommonJS import + * const client = new SyntheticsClient(config); + * const command = new UpdateCanaryCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link UpdateCanaryCommandInput} for command's `input` shape. + * @see {@link UpdateCanaryCommandOutput} for command's `response` shape. + * @see {@link SyntheticsClientResolvedConfig | config} for command's `input` shape. + * */ export class UpdateCanaryCommand extends $Command< UpdateCanaryCommandInput, diff --git a/clients/client-synthetics/models/models_0.ts b/clients/client-synthetics/models/models_0.ts index 72ee373cec79..6939e9752506 100644 --- a/clients/client-synthetics/models/models_0.ts +++ b/clients/client-synthetics/models/models_0.ts @@ -18,6 +18,9 @@ export interface CanaryCodeOutput { } export namespace CanaryCodeOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: CanaryCodeOutput): any => ({ ...obj, }); @@ -45,6 +48,9 @@ export interface CanaryRunConfigOutput { } export namespace CanaryRunConfigOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: CanaryRunConfigOutput): any => ({ ...obj, }); @@ -76,6 +82,9 @@ export interface CanaryScheduleOutput { } export namespace CanaryScheduleOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: CanaryScheduleOutput): any => ({ ...obj, }); @@ -118,6 +127,9 @@ export interface CanaryStatus { } export namespace CanaryStatus { + /** + * @internal + */ export const filterSensitiveLog = (obj: CanaryStatus): any => ({ ...obj, }); @@ -149,6 +161,9 @@ export interface CanaryTimeline { } export namespace CanaryTimeline { + /** + * @internal + */ export const filterSensitiveLog = (obj: CanaryTimeline): any => ({ ...obj, }); @@ -178,6 +193,9 @@ export interface VpcConfigOutput { } export namespace VpcConfigOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: VpcConfigOutput): any => ({ ...obj, }); @@ -275,6 +293,9 @@ export interface Canary { } export namespace Canary { + /** + * @internal + */ export const filterSensitiveLog = (obj: Canary): any => ({ ...obj, }); @@ -314,6 +335,9 @@ export interface CanaryRunStatus { } export namespace CanaryRunStatus { + /** + * @internal + */ export const filterSensitiveLog = (obj: CanaryRunStatus): any => ({ ...obj, }); @@ -335,6 +359,9 @@ export interface CanaryRunTimeline { } export namespace CanaryRunTimeline { + /** + * @internal + */ export const filterSensitiveLog = (obj: CanaryRunTimeline): any => ({ ...obj, }); @@ -372,6 +399,9 @@ export interface CanaryRun { } export namespace CanaryRun { + /** + * @internal + */ export const filterSensitiveLog = (obj: CanaryRun): any => ({ ...obj, }); @@ -393,6 +423,9 @@ export interface CanaryLastRun { } export namespace CanaryLastRun { + /** + * @internal + */ export const filterSensitiveLog = (obj: CanaryLastRun): any => ({ ...obj, }); @@ -438,6 +471,9 @@ export interface CanaryCodeInput { } export namespace CanaryCodeInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: CanaryCodeInput): any => ({ ...obj, }); @@ -486,6 +522,9 @@ export interface CanaryRunConfigInput { } export namespace CanaryRunConfigInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: CanaryRunConfigInput): any => ({ ...obj, }); @@ -518,6 +557,9 @@ export interface CanaryScheduleInput { } export namespace CanaryScheduleInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: CanaryScheduleInput): any => ({ ...obj, }); @@ -533,6 +575,9 @@ export interface ConflictException extends __SmithyException, $MetadataBearer { } export namespace ConflictException { + /** + * @internal + */ export const filterSensitiveLog = (obj: ConflictException): any => ({ ...obj, }); @@ -557,6 +602,9 @@ export interface VpcConfigInput { } export namespace VpcConfigInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: VpcConfigInput): any => ({ ...obj, }); @@ -683,6 +731,9 @@ export interface CreateCanaryRequest { } export namespace CreateCanaryRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateCanaryRequest): any => ({ ...obj, }); @@ -696,6 +747,9 @@ export interface CreateCanaryResponse { } export namespace CreateCanaryResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateCanaryResponse): any => ({ ...obj, }); @@ -711,6 +765,9 @@ export interface InternalServerException extends __SmithyException, $MetadataBea } export namespace InternalServerException { + /** + * @internal + */ export const filterSensitiveLog = (obj: InternalServerException): any => ({ ...obj, }); @@ -726,6 +783,9 @@ export interface ValidationException extends __SmithyException, $MetadataBearer } export namespace ValidationException { + /** + * @internal + */ export const filterSensitiveLog = (obj: ValidationException): any => ({ ...obj, }); @@ -739,6 +799,9 @@ export interface DeleteCanaryRequest { } export namespace DeleteCanaryRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteCanaryRequest): any => ({ ...obj, }); @@ -747,6 +810,9 @@ export namespace DeleteCanaryRequest { export interface DeleteCanaryResponse {} export namespace DeleteCanaryResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteCanaryResponse): any => ({ ...obj, }); @@ -762,6 +828,9 @@ export interface ResourceNotFoundException extends __SmithyException, $MetadataB } export namespace ResourceNotFoundException { + /** + * @internal + */ export const filterSensitiveLog = (obj: ResourceNotFoundException): any => ({ ...obj, }); @@ -783,6 +852,9 @@ export interface DescribeCanariesRequest { } export namespace DescribeCanariesRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeCanariesRequest): any => ({ ...obj, }); @@ -804,6 +876,9 @@ export interface DescribeCanariesResponse { } export namespace DescribeCanariesResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeCanariesResponse): any => ({ ...obj, }); @@ -825,6 +900,9 @@ export interface DescribeCanariesLastRunRequest { } export namespace DescribeCanariesLastRunRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeCanariesLastRunRequest): any => ({ ...obj, }); @@ -846,6 +924,9 @@ export interface DescribeCanariesLastRunResponse { } export namespace DescribeCanariesLastRunResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeCanariesLastRunResponse): any => ({ ...obj, }); @@ -867,6 +948,9 @@ export interface DescribeRuntimeVersionsRequest { } export namespace DescribeRuntimeVersionsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeRuntimeVersionsRequest): any => ({ ...obj, }); @@ -902,6 +986,9 @@ export interface RuntimeVersion { } export namespace RuntimeVersion { + /** + * @internal + */ export const filterSensitiveLog = (obj: RuntimeVersion): any => ({ ...obj, }); @@ -923,6 +1010,9 @@ export interface DescribeRuntimeVersionsResponse { } export namespace DescribeRuntimeVersionsResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeRuntimeVersionsResponse): any => ({ ...obj, }); @@ -936,6 +1026,9 @@ export interface GetCanaryRequest { } export namespace GetCanaryRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetCanaryRequest): any => ({ ...obj, }); @@ -949,6 +1042,9 @@ export interface GetCanaryResponse { } export namespace GetCanaryResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetCanaryResponse): any => ({ ...obj, }); @@ -975,6 +1071,9 @@ export interface GetCanaryRunsRequest { } export namespace GetCanaryRunsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetCanaryRunsRequest): any => ({ ...obj, }); @@ -997,6 +1096,9 @@ export interface GetCanaryRunsResponse { } export namespace GetCanaryRunsResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetCanaryRunsResponse): any => ({ ...obj, }); @@ -1013,6 +1115,9 @@ export interface ListTagsForResourceRequest { } export namespace ListTagsForResourceRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListTagsForResourceRequest): any => ({ ...obj, }); @@ -1026,6 +1131,9 @@ export interface ListTagsForResourceResponse { } export namespace ListTagsForResourceResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListTagsForResourceResponse): any => ({ ...obj, }); @@ -1040,6 +1148,9 @@ export interface StartCanaryRequest { } export namespace StartCanaryRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: StartCanaryRequest): any => ({ ...obj, }); @@ -1048,6 +1159,9 @@ export namespace StartCanaryRequest { export interface StartCanaryResponse {} export namespace StartCanaryResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: StartCanaryResponse): any => ({ ...obj, }); @@ -1062,6 +1176,9 @@ export interface StopCanaryRequest { } export namespace StopCanaryRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: StopCanaryRequest): any => ({ ...obj, }); @@ -1070,6 +1187,9 @@ export namespace StopCanaryRequest { export interface StopCanaryResponse {} export namespace StopCanaryResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: StopCanaryResponse): any => ({ ...obj, }); @@ -1091,6 +1211,9 @@ export interface TagResourceRequest { } export namespace TagResourceRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: TagResourceRequest): any => ({ ...obj, }); @@ -1099,6 +1222,9 @@ export namespace TagResourceRequest { export interface TagResourceResponse {} export namespace TagResourceResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: TagResourceResponse): any => ({ ...obj, }); @@ -1120,6 +1246,9 @@ export interface UntagResourceRequest { } export namespace UntagResourceRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: UntagResourceRequest): any => ({ ...obj, }); @@ -1128,6 +1257,9 @@ export namespace UntagResourceRequest { export interface UntagResourceResponse {} export namespace UntagResourceResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: UntagResourceResponse): any => ({ ...obj, }); @@ -1233,6 +1365,9 @@ export interface UpdateCanaryRequest { } export namespace UpdateCanaryRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateCanaryRequest): any => ({ ...obj, }); @@ -1241,6 +1376,9 @@ export namespace UpdateCanaryRequest { export interface UpdateCanaryResponse {} export namespace UpdateCanaryResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateCanaryResponse): any => ({ ...obj, }); diff --git a/clients/client-textract/commands/AnalyzeDocumentCommand.ts b/clients/client-textract/commands/AnalyzeDocumentCommand.ts index 03c922807940..43adb2752bf1 100644 --- a/clients/client-textract/commands/AnalyzeDocumentCommand.ts +++ b/clients/client-textract/commands/AnalyzeDocumentCommand.ts @@ -52,6 +52,20 @@ export interface AnalyzeDocumentCommandOutput extends AnalyzeDocumentResponse, _ * AnalyzeDocument is a synchronous operation. To analyze documents * asynchronously, use StartDocumentAnalysis.

*

For more information, see Document Text Analysis.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { TextractClient, AnalyzeDocumentCommand } from "@aws-sdk/client-textract"; // ES Modules import + * // const { TextractClient, AnalyzeDocumentCommand } = require("@aws-sdk/client-textract"); // CommonJS import + * const client = new TextractClient(config); + * const command = new AnalyzeDocumentCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link AnalyzeDocumentCommandInput} for command's `input` shape. + * @see {@link AnalyzeDocumentCommandOutput} for command's `response` shape. + * @see {@link TextractClientResolvedConfig | config} for command's `input` shape. + * */ export class AnalyzeDocumentCommand extends $Command< AnalyzeDocumentCommandInput, diff --git a/clients/client-textract/commands/DetectDocumentTextCommand.ts b/clients/client-textract/commands/DetectDocumentTextCommand.ts index dbe1b455a4d0..0d3cb2726ee3 100644 --- a/clients/client-textract/commands/DetectDocumentTextCommand.ts +++ b/clients/client-textract/commands/DetectDocumentTextCommand.ts @@ -32,6 +32,20 @@ export interface DetectDocumentTextCommandOutput extends DetectDocumentTextRespo * DetectDocumentText is a synchronous operation. To analyze documents * asynchronously, use StartDocumentTextDetection.

*

For more information, see Document Text Detection.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { TextractClient, DetectDocumentTextCommand } from "@aws-sdk/client-textract"; // ES Modules import + * // const { TextractClient, DetectDocumentTextCommand } = require("@aws-sdk/client-textract"); // CommonJS import + * const client = new TextractClient(config); + * const command = new DetectDocumentTextCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DetectDocumentTextCommandInput} for command's `input` shape. + * @see {@link DetectDocumentTextCommandOutput} for command's `response` shape. + * @see {@link TextractClientResolvedConfig | config} for command's `input` shape. + * */ export class DetectDocumentTextCommand extends $Command< DetectDocumentTextCommandInput, diff --git a/clients/client-textract/commands/GetDocumentAnalysisCommand.ts b/clients/client-textract/commands/GetDocumentAnalysisCommand.ts index c774583ad69d..0d232ba97607 100644 --- a/clients/client-textract/commands/GetDocumentAnalysisCommand.ts +++ b/clients/client-textract/commands/GetDocumentAnalysisCommand.ts @@ -66,6 +66,20 @@ export interface GetDocumentAnalysisCommandOutput extends GetDocumentAnalysisRes * parameter with the token value that's returned from the previous call to * GetDocumentAnalysis.

*

For more information, see Document Text Analysis.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { TextractClient, GetDocumentAnalysisCommand } from "@aws-sdk/client-textract"; // ES Modules import + * // const { TextractClient, GetDocumentAnalysisCommand } = require("@aws-sdk/client-textract"); // CommonJS import + * const client = new TextractClient(config); + * const command = new GetDocumentAnalysisCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetDocumentAnalysisCommandInput} for command's `input` shape. + * @see {@link GetDocumentAnalysisCommandOutput} for command's `response` shape. + * @see {@link TextractClientResolvedConfig | config} for command's `input` shape. + * */ export class GetDocumentAnalysisCommand extends $Command< GetDocumentAnalysisCommandInput, diff --git a/clients/client-textract/commands/GetDocumentTextDetectionCommand.ts b/clients/client-textract/commands/GetDocumentTextDetectionCommand.ts index 646e7c4ec1a0..31579ae3a5a3 100644 --- a/clients/client-textract/commands/GetDocumentTextDetectionCommand.ts +++ b/clients/client-textract/commands/GetDocumentTextDetectionCommand.ts @@ -46,6 +46,20 @@ export interface GetDocumentTextDetectionCommandOutput extends GetDocumentTextDe * parameter with the token value that's returned from the previous call to * GetDocumentTextDetection.

*

For more information, see Document Text Detection.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { TextractClient, GetDocumentTextDetectionCommand } from "@aws-sdk/client-textract"; // ES Modules import + * // const { TextractClient, GetDocumentTextDetectionCommand } = require("@aws-sdk/client-textract"); // CommonJS import + * const client = new TextractClient(config); + * const command = new GetDocumentTextDetectionCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetDocumentTextDetectionCommandInput} for command's `input` shape. + * @see {@link GetDocumentTextDetectionCommandOutput} for command's `response` shape. + * @see {@link TextractClientResolvedConfig | config} for command's `input` shape. + * */ export class GetDocumentTextDetectionCommand extends $Command< GetDocumentTextDetectionCommandInput, diff --git a/clients/client-textract/commands/StartDocumentAnalysisCommand.ts b/clients/client-textract/commands/StartDocumentAnalysisCommand.ts index e4c85aa7fafd..a3e539ae6786 100644 --- a/clients/client-textract/commands/StartDocumentAnalysisCommand.ts +++ b/clients/client-textract/commands/StartDocumentAnalysisCommand.ts @@ -39,6 +39,20 @@ export interface StartDocumentAnalysisCommandOutput extends StartDocumentAnalysi * the job identifier (JobId) from the initial call to * StartDocumentAnalysis.

*

For more information, see Document Text Analysis.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { TextractClient, StartDocumentAnalysisCommand } from "@aws-sdk/client-textract"; // ES Modules import + * // const { TextractClient, StartDocumentAnalysisCommand } = require("@aws-sdk/client-textract"); // CommonJS import + * const client = new TextractClient(config); + * const command = new StartDocumentAnalysisCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link StartDocumentAnalysisCommandInput} for command's `input` shape. + * @see {@link StartDocumentAnalysisCommandOutput} for command's `response` shape. + * @see {@link TextractClientResolvedConfig | config} for command's `input` shape. + * */ export class StartDocumentAnalysisCommand extends $Command< StartDocumentAnalysisCommandInput, diff --git a/clients/client-textract/commands/StartDocumentTextDetectionCommand.ts b/clients/client-textract/commands/StartDocumentTextDetectionCommand.ts index 55ef495928c7..34b3c366c811 100644 --- a/clients/client-textract/commands/StartDocumentTextDetectionCommand.ts +++ b/clients/client-textract/commands/StartDocumentTextDetectionCommand.ts @@ -38,6 +38,20 @@ export interface StartDocumentTextDetectionCommandOutput extends StartDocumentTe * pass the job identifier (JobId) from the initial call to * StartDocumentTextDetection.

*

For more information, see Document Text Detection.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { TextractClient, StartDocumentTextDetectionCommand } from "@aws-sdk/client-textract"; // ES Modules import + * // const { TextractClient, StartDocumentTextDetectionCommand } = require("@aws-sdk/client-textract"); // CommonJS import + * const client = new TextractClient(config); + * const command = new StartDocumentTextDetectionCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link StartDocumentTextDetectionCommandInput} for command's `input` shape. + * @see {@link StartDocumentTextDetectionCommandOutput} for command's `response` shape. + * @see {@link TextractClientResolvedConfig | config} for command's `input` shape. + * */ export class StartDocumentTextDetectionCommand extends $Command< StartDocumentTextDetectionCommandInput, diff --git a/clients/client-textract/models/models_0.ts b/clients/client-textract/models/models_0.ts index bc77c6b15346..91b1d91ca29d 100644 --- a/clients/client-textract/models/models_0.ts +++ b/clients/client-textract/models/models_0.ts @@ -13,6 +13,9 @@ export interface AccessDeniedException extends __SmithyException, $MetadataBeare } export namespace AccessDeniedException { + /** + * @internal + */ export const filterSensitiveLog = (obj: AccessDeniedException): any => ({ ...obj, }); @@ -47,6 +50,9 @@ export interface S3Object { } export namespace S3Object { + /** + * @internal + */ export const filterSensitiveLog = (obj: S3Object): any => ({ ...obj, }); @@ -88,6 +94,9 @@ export interface Document { } export namespace Document { + /** + * @internal + */ export const filterSensitiveLog = (obj: Document): any => ({ ...obj, }); @@ -115,6 +124,9 @@ export interface HumanLoopDataAttributes { } export namespace HumanLoopDataAttributes { + /** + * @internal + */ export const filterSensitiveLog = (obj: HumanLoopDataAttributes): any => ({ ...obj, }); @@ -142,6 +154,9 @@ export interface HumanLoopConfig { } export namespace HumanLoopConfig { + /** + * @internal + */ export const filterSensitiveLog = (obj: HumanLoopConfig): any => ({ ...obj, }); @@ -173,6 +188,9 @@ export interface AnalyzeDocumentRequest { } export namespace AnalyzeDocumentRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: AnalyzeDocumentRequest): any => ({ ...obj, }); @@ -234,6 +252,9 @@ export interface BoundingBox { } export namespace BoundingBox { + /** + * @internal + */ export const filterSensitiveLog = (obj: BoundingBox): any => ({ ...obj, }); @@ -263,6 +284,9 @@ export interface Point { } export namespace Point { + /** + * @internal + */ export const filterSensitiveLog = (obj: Point): any => ({ ...obj, }); @@ -286,6 +310,9 @@ export interface Geometry { } export namespace Geometry { + /** + * @internal + */ export const filterSensitiveLog = (obj: Geometry): any => ({ ...obj, }); @@ -323,6 +350,9 @@ export interface Relationship { } export namespace Relationship { + /** + * @internal + */ export const filterSensitiveLog = (obj: Relationship): any => ({ ...obj, }); @@ -527,6 +557,9 @@ export interface Block { } export namespace Block { + /** + * @internal + */ export const filterSensitiveLog = (obj: Block): any => ({ ...obj, }); @@ -543,6 +576,9 @@ export interface DocumentMetadata { } export namespace DocumentMetadata { + /** + * @internal + */ export const filterSensitiveLog = (obj: DocumentMetadata): any => ({ ...obj, }); @@ -570,6 +606,9 @@ export interface HumanLoopActivationOutput { } export namespace HumanLoopActivationOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: HumanLoopActivationOutput): any => ({ ...obj, }); @@ -598,6 +637,9 @@ export interface AnalyzeDocumentResponse { } export namespace AnalyzeDocumentResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: AnalyzeDocumentResponse): any => ({ ...obj, }); @@ -615,6 +657,9 @@ export interface BadDocumentException extends __SmithyException, $MetadataBearer } export namespace BadDocumentException { + /** + * @internal + */ export const filterSensitiveLog = (obj: BadDocumentException): any => ({ ...obj, }); @@ -633,6 +678,9 @@ export interface DocumentTooLargeException extends __SmithyException, $MetadataB } export namespace DocumentTooLargeException { + /** + * @internal + */ export const filterSensitiveLog = (obj: DocumentTooLargeException): any => ({ ...obj, }); @@ -664,6 +712,9 @@ export interface HumanLoopQuotaExceededException extends __SmithyException, $Met } export namespace HumanLoopQuotaExceededException { + /** + * @internal + */ export const filterSensitiveLog = (obj: HumanLoopQuotaExceededException): any => ({ ...obj, }); @@ -680,6 +731,9 @@ export interface InternalServerError extends __SmithyException, $MetadataBearer } export namespace InternalServerError { + /** + * @internal + */ export const filterSensitiveLog = (obj: InternalServerError): any => ({ ...obj, }); @@ -700,6 +754,9 @@ export interface InvalidParameterException extends __SmithyException, $MetadataB } export namespace InvalidParameterException { + /** + * @internal + */ export const filterSensitiveLog = (obj: InvalidParameterException): any => ({ ...obj, }); @@ -719,6 +776,9 @@ export interface InvalidS3ObjectException extends __SmithyException, $MetadataBe } export namespace InvalidS3ObjectException { + /** + * @internal + */ export const filterSensitiveLog = (obj: InvalidS3ObjectException): any => ({ ...obj, }); @@ -736,6 +796,9 @@ export interface ProvisionedThroughputExceededException extends __SmithyExceptio } export namespace ProvisionedThroughputExceededException { + /** + * @internal + */ export const filterSensitiveLog = (obj: ProvisionedThroughputExceededException): any => ({ ...obj, }); @@ -752,6 +815,9 @@ export interface ThrottlingException extends __SmithyException, $MetadataBearer } export namespace ThrottlingException { + /** + * @internal + */ export const filterSensitiveLog = (obj: ThrottlingException): any => ({ ...obj, }); @@ -769,6 +835,9 @@ export interface UnsupportedDocumentException extends __SmithyException, $Metada } export namespace UnsupportedDocumentException { + /** + * @internal + */ export const filterSensitiveLog = (obj: UnsupportedDocumentException): any => ({ ...obj, }); @@ -786,6 +855,9 @@ export interface DetectDocumentTextRequest { } export namespace DetectDocumentTextRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DetectDocumentTextRequest): any => ({ ...obj, }); @@ -811,6 +883,9 @@ export interface DetectDocumentTextResponse { } export namespace DetectDocumentTextResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DetectDocumentTextResponse): any => ({ ...obj, }); @@ -830,6 +905,9 @@ export interface DocumentLocation { } export namespace DocumentLocation { + /** + * @internal + */ export const filterSensitiveLog = (obj: DocumentLocation): any => ({ ...obj, }); @@ -857,6 +935,9 @@ export interface GetDocumentAnalysisRequest { } export namespace GetDocumentAnalysisRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetDocumentAnalysisRequest): any => ({ ...obj, }); @@ -885,6 +966,9 @@ export interface Warning { } export namespace Warning { + /** + * @internal + */ export const filterSensitiveLog = (obj: Warning): any => ({ ...obj, }); @@ -930,6 +1014,9 @@ export interface GetDocumentAnalysisResponse { } export namespace GetDocumentAnalysisResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetDocumentAnalysisResponse): any => ({ ...obj, }); @@ -947,6 +1034,9 @@ export interface InvalidJobIdException extends __SmithyException, $MetadataBeare } export namespace InvalidJobIdException { + /** + * @internal + */ export const filterSensitiveLog = (obj: InvalidJobIdException): any => ({ ...obj, }); @@ -974,6 +1064,9 @@ export interface GetDocumentTextDetectionRequest { } export namespace GetDocumentTextDetectionRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetDocumentTextDetectionRequest): any => ({ ...obj, }); @@ -1020,6 +1113,9 @@ export interface GetDocumentTextDetectionResponse { } export namespace GetDocumentTextDetectionResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetDocumentTextDetectionResponse): any => ({ ...obj, }); @@ -1038,6 +1134,9 @@ export interface IdempotentParameterMismatchException extends __SmithyException, } export namespace IdempotentParameterMismatchException { + /** + * @internal + */ export const filterSensitiveLog = (obj: IdempotentParameterMismatchException): any => ({ ...obj, }); @@ -1055,6 +1154,9 @@ export interface InvalidKMSKeyException extends __SmithyException, $MetadataBear } export namespace InvalidKMSKeyException { + /** + * @internal + */ export const filterSensitiveLog = (obj: InvalidKMSKeyException): any => ({ ...obj, }); @@ -1075,6 +1177,9 @@ export interface LimitExceededException extends __SmithyException, $MetadataBear } export namespace LimitExceededException { + /** + * @internal + */ export const filterSensitiveLog = (obj: LimitExceededException): any => ({ ...obj, }); @@ -1097,6 +1202,9 @@ export interface NotificationChannel { } export namespace NotificationChannel { + /** + * @internal + */ export const filterSensitiveLog = (obj: NotificationChannel): any => ({ ...obj, }); @@ -1121,6 +1229,9 @@ export interface OutputConfig { } export namespace OutputConfig { + /** + * @internal + */ export const filterSensitiveLog = (obj: OutputConfig): any => ({ ...obj, }); @@ -1182,6 +1293,9 @@ export interface StartDocumentAnalysisRequest { } export namespace StartDocumentAnalysisRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: StartDocumentAnalysisRequest): any => ({ ...obj, }); @@ -1197,6 +1311,9 @@ export interface StartDocumentAnalysisResponse { } export namespace StartDocumentAnalysisResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: StartDocumentAnalysisResponse): any => ({ ...obj, }); @@ -1248,6 +1365,9 @@ export interface StartDocumentTextDetectionRequest { } export namespace StartDocumentTextDetectionRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: StartDocumentTextDetectionRequest): any => ({ ...obj, }); @@ -1263,6 +1383,9 @@ export interface StartDocumentTextDetectionResponse { } export namespace StartDocumentTextDetectionResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: StartDocumentTextDetectionResponse): any => ({ ...obj, }); diff --git a/clients/client-timestream-query/commands/CancelQueryCommand.ts b/clients/client-timestream-query/commands/CancelQueryCommand.ts index b9fb6583b36a..a1453d485f1e 100644 --- a/clients/client-timestream-query/commands/CancelQueryCommand.ts +++ b/clients/client-timestream-query/commands/CancelQueryCommand.ts @@ -26,6 +26,20 @@ export interface CancelQueryCommandOutput extends CancelQueryResponse, __Metadat * completed execution 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. *

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { TimestreamQueryClient, CancelQueryCommand } from "@aws-sdk/client-timestream-query"; // ES Modules import + * // const { TimestreamQueryClient, CancelQueryCommand } = require("@aws-sdk/client-timestream-query"); // CommonJS import + * const client = new TimestreamQueryClient(config); + * const command = new CancelQueryCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CancelQueryCommandInput} for command's `input` shape. + * @see {@link CancelQueryCommandOutput} for command's `response` shape. + * @see {@link TimestreamQueryClientResolvedConfig | config} for command's `input` shape. + * */ export class CancelQueryCommand extends $Command< CancelQueryCommandInput, diff --git a/clients/client-timestream-query/commands/DescribeEndpointsCommand.ts b/clients/client-timestream-query/commands/DescribeEndpointsCommand.ts index 1b465dfa816f..4cdff63b184b 100644 --- a/clients/client-timestream-query/commands/DescribeEndpointsCommand.ts +++ b/clients/client-timestream-query/commands/DescribeEndpointsCommand.ts @@ -36,6 +36,20 @@ export interface DescribeEndpointsCommandOutput extends DescribeEndpointsRespons * *

For detailed information on how to use DescribeEndpoints, * see The Endpoint Discovery Pattern and REST APIs.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { TimestreamQueryClient, DescribeEndpointsCommand } from "@aws-sdk/client-timestream-query"; // ES Modules import + * // const { TimestreamQueryClient, DescribeEndpointsCommand } = require("@aws-sdk/client-timestream-query"); // CommonJS import + * const client = new TimestreamQueryClient(config); + * const command = new DescribeEndpointsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeEndpointsCommandInput} for command's `input` shape. + * @see {@link DescribeEndpointsCommandOutput} for command's `response` shape. + * @see {@link TimestreamQueryClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeEndpointsCommand extends $Command< DescribeEndpointsCommandInput, diff --git a/clients/client-timestream-query/commands/QueryCommand.ts b/clients/client-timestream-query/commands/QueryCommand.ts index d5a475206dfd..e7308231663d 100644 --- a/clients/client-timestream-query/commands/QueryCommand.ts +++ b/clients/client-timestream-query/commands/QueryCommand.ts @@ -21,6 +21,20 @@ export interface QueryCommandOutput extends QueryResponse, __MetadataBearer {} *

* Query is a synchronous operation that enables you to execute a query. Query will timeout after 60 seconds. You must update the default timeout in the SDK to support a timeout of 60 seconds. The result set will be truncated to 1MB. Service quotas apply. For more information, see Quotas in the Timestream Developer Guide. *

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { TimestreamQueryClient, QueryCommand } from "@aws-sdk/client-timestream-query"; // ES Modules import + * // const { TimestreamQueryClient, QueryCommand } = require("@aws-sdk/client-timestream-query"); // CommonJS import + * const client = new TimestreamQueryClient(config); + * const command = new QueryCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link QueryCommandInput} for command's `input` shape. + * @see {@link QueryCommandOutput} for command's `response` shape. + * @see {@link TimestreamQueryClientResolvedConfig | config} for command's `input` shape. + * */ export class QueryCommand extends $Command { // Start section: command_properties diff --git a/clients/client-timestream-query/models/models_0.ts b/clients/client-timestream-query/models/models_0.ts index 9fc83338a052..866dff7f92cc 100644 --- a/clients/client-timestream-query/models/models_0.ts +++ b/clients/client-timestream-query/models/models_0.ts @@ -13,6 +13,9 @@ export interface AccessDeniedException extends __SmithyException, $MetadataBeare } export namespace AccessDeniedException { + /** + * @internal + */ export const filterSensitiveLog = (obj: AccessDeniedException): any => ({ ...obj, }); @@ -28,6 +31,9 @@ export interface CancelQueryRequest { } export namespace CancelQueryRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: CancelQueryRequest): any => ({ ...obj, }); @@ -43,6 +49,9 @@ export interface CancelQueryResponse { } export namespace CancelQueryResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: CancelQueryResponse): any => ({ ...obj, }); @@ -60,6 +69,9 @@ export interface InternalServerException extends __SmithyException, $MetadataBea } export namespace InternalServerException { + /** + * @internal + */ export const filterSensitiveLog = (obj: InternalServerException): any => ({ ...obj, }); @@ -75,6 +87,9 @@ export interface InvalidEndpointException extends __SmithyException, $MetadataBe } export namespace InvalidEndpointException { + /** + * @internal + */ export const filterSensitiveLog = (obj: InvalidEndpointException): any => ({ ...obj, }); @@ -90,6 +105,9 @@ export interface ThrottlingException extends __SmithyException, $MetadataBearer } export namespace ThrottlingException { + /** + * @internal + */ export const filterSensitiveLog = (obj: ThrottlingException): any => ({ ...obj, }); @@ -107,6 +125,9 @@ export interface ValidationException extends __SmithyException, $MetadataBearer } export namespace ValidationException { + /** + * @internal + */ export const filterSensitiveLog = (obj: ValidationException): any => ({ ...obj, }); @@ -138,6 +159,9 @@ export interface ConflictException extends __SmithyException, $MetadataBearer { } export namespace ConflictException { + /** + * @internal + */ export const filterSensitiveLog = (obj: ConflictException): any => ({ ...obj, }); @@ -146,6 +170,9 @@ export namespace ConflictException { export interface DescribeEndpointsRequest {} export namespace DescribeEndpointsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeEndpointsRequest): any => ({ ...obj, }); @@ -167,6 +194,9 @@ export interface Endpoint { } export namespace Endpoint { + /** + * @internal + */ export const filterSensitiveLog = (obj: Endpoint): any => ({ ...obj, }); @@ -180,6 +210,9 @@ export interface DescribeEndpointsResponse { } export namespace DescribeEndpointsResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeEndpointsResponse): any => ({ ...obj, }); @@ -197,6 +230,9 @@ export interface QueryExecutionException extends __SmithyException, $MetadataBea } export namespace QueryExecutionException { + /** + * @internal + */ export const filterSensitiveLog = (obj: QueryExecutionException): any => ({ ...obj, }); @@ -256,6 +292,9 @@ export interface QueryRequest { } export namespace QueryRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: QueryRequest): any => ({ ...obj, ...(obj.QueryString && { QueryString: SENSITIVE_STRING }), @@ -291,6 +330,9 @@ export interface QueryStatus { } export namespace QueryStatus { + /** + * @internal + */ export const filterSensitiveLog = (obj: QueryStatus): any => ({ ...obj, }); @@ -318,6 +360,9 @@ export interface ColumnInfo { } export namespace ColumnInfo { + /** + * @internal + */ export const filterSensitiveLog = (obj: ColumnInfo): any => ({ ...obj, }); @@ -349,6 +394,9 @@ export interface Type { } export namespace Type { + /** + * @internal + */ export const filterSensitiveLog = (obj: Type): any => ({ ...obj, }); @@ -397,6 +445,9 @@ export interface Datum { } export namespace Datum { + /** + * @internal + */ export const filterSensitiveLog = (obj: Datum): any => ({ ...obj, }); @@ -418,6 +469,9 @@ export interface TimeSeriesDataPoint { } export namespace TimeSeriesDataPoint { + /** + * @internal + */ export const filterSensitiveLog = (obj: TimeSeriesDataPoint): any => ({ ...obj, }); @@ -434,6 +488,9 @@ export interface Row { } export namespace Row { + /** + * @internal + */ export const filterSensitiveLog = (obj: Row): any => ({ ...obj, }); @@ -475,6 +532,9 @@ export interface QueryResponse { } export namespace QueryResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: QueryResponse): any => ({ ...obj, }); diff --git a/clients/client-timestream-write/commands/CreateDatabaseCommand.ts b/clients/client-timestream-write/commands/CreateDatabaseCommand.ts index c119cde7aeeb..5cc614ca000c 100644 --- a/clients/client-timestream-write/commands/CreateDatabaseCommand.ts +++ b/clients/client-timestream-write/commands/CreateDatabaseCommand.ts @@ -25,6 +25,20 @@ export interface CreateDatabaseCommandOutput extends CreateDatabaseResponse, __M * Refer to AWS managed KMS keys for more info. * Service quotas apply. For more information, see Access Management in the Timestream Developer Guide. *

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { TimestreamWriteClient, CreateDatabaseCommand } from "@aws-sdk/client-timestream-write"; // ES Modules import + * // const { TimestreamWriteClient, CreateDatabaseCommand } = require("@aws-sdk/client-timestream-write"); // CommonJS import + * const client = new TimestreamWriteClient(config); + * const command = new CreateDatabaseCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreateDatabaseCommandInput} for command's `input` shape. + * @see {@link CreateDatabaseCommandOutput} for command's `response` shape. + * @see {@link TimestreamWriteClientResolvedConfig | config} for command's `input` shape. + * */ export class CreateDatabaseCommand extends $Command< CreateDatabaseCommandInput, diff --git a/clients/client-timestream-write/commands/CreateTableCommand.ts b/clients/client-timestream-write/commands/CreateTableCommand.ts index 99c06fc56c21..143bde6f2deb 100644 --- a/clients/client-timestream-write/commands/CreateTableCommand.ts +++ b/clients/client-timestream-write/commands/CreateTableCommand.ts @@ -29,6 +29,20 @@ export interface CreateTableCommandOutput extends CreateTableResponse, __Metadat * Service quotas apply. For more information, see Access Management * in the Timestream Developer Guide. *

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { TimestreamWriteClient, CreateTableCommand } from "@aws-sdk/client-timestream-write"; // ES Modules import + * // const { TimestreamWriteClient, CreateTableCommand } = require("@aws-sdk/client-timestream-write"); // CommonJS import + * const client = new TimestreamWriteClient(config); + * const command = new CreateTableCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreateTableCommandInput} for command's `input` shape. + * @see {@link CreateTableCommandOutput} for command's `response` shape. + * @see {@link TimestreamWriteClientResolvedConfig | config} for command's `input` shape. + * */ export class CreateTableCommand extends $Command< CreateTableCommandInput, diff --git a/clients/client-timestream-write/commands/DeleteDatabaseCommand.ts b/clients/client-timestream-write/commands/DeleteDatabaseCommand.ts index 586918fc16f3..86aac4a64462 100644 --- a/clients/client-timestream-write/commands/DeleteDatabaseCommand.ts +++ b/clients/client-timestream-write/commands/DeleteDatabaseCommand.ts @@ -30,6 +30,20 @@ export interface DeleteDatabaseCommandOutput extends __MetadataBearer {} * *

Due to the nature of distributed retries, * the operation can return either success or a ResourceNotFoundException. Clients should consider them equivalent.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { TimestreamWriteClient, DeleteDatabaseCommand } from "@aws-sdk/client-timestream-write"; // ES Modules import + * // const { TimestreamWriteClient, DeleteDatabaseCommand } = require("@aws-sdk/client-timestream-write"); // CommonJS import + * const client = new TimestreamWriteClient(config); + * const command = new DeleteDatabaseCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteDatabaseCommandInput} for command's `input` shape. + * @see {@link DeleteDatabaseCommandOutput} for command's `response` shape. + * @see {@link TimestreamWriteClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteDatabaseCommand extends $Command< DeleteDatabaseCommandInput, diff --git a/clients/client-timestream-write/commands/DeleteTableCommand.ts b/clients/client-timestream-write/commands/DeleteTableCommand.ts index 1485000a9e7e..2306e5035ef4 100644 --- a/clients/client-timestream-write/commands/DeleteTableCommand.ts +++ b/clients/client-timestream-write/commands/DeleteTableCommand.ts @@ -27,6 +27,20 @@ export interface DeleteTableCommandOutput extends __MetadataBearer {} *

*

Due to the nature of distributed retries, * the operation can return either success or a ResourceNotFoundException. Clients should consider them equivalent.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { TimestreamWriteClient, DeleteTableCommand } from "@aws-sdk/client-timestream-write"; // ES Modules import + * // const { TimestreamWriteClient, DeleteTableCommand } = require("@aws-sdk/client-timestream-write"); // CommonJS import + * const client = new TimestreamWriteClient(config); + * const command = new DeleteTableCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteTableCommandInput} for command's `input` shape. + * @see {@link DeleteTableCommandOutput} for command's `response` shape. + * @see {@link TimestreamWriteClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteTableCommand extends $Command< DeleteTableCommandInput, diff --git a/clients/client-timestream-write/commands/DescribeDatabaseCommand.ts b/clients/client-timestream-write/commands/DescribeDatabaseCommand.ts index fd407f3cdfb8..79aaac876f6a 100644 --- a/clients/client-timestream-write/commands/DescribeDatabaseCommand.ts +++ b/clients/client-timestream-write/commands/DescribeDatabaseCommand.ts @@ -24,6 +24,20 @@ export interface DescribeDatabaseCommandOutput extends DescribeDatabaseResponse, *

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. For more information, see Access Management in the Timestream Developer Guide.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { TimestreamWriteClient, DescribeDatabaseCommand } from "@aws-sdk/client-timestream-write"; // ES Modules import + * // const { TimestreamWriteClient, DescribeDatabaseCommand } = require("@aws-sdk/client-timestream-write"); // CommonJS import + * const client = new TimestreamWriteClient(config); + * const command = new DescribeDatabaseCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeDatabaseCommandInput} for command's `input` shape. + * @see {@link DescribeDatabaseCommandOutput} for command's `response` shape. + * @see {@link TimestreamWriteClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeDatabaseCommand extends $Command< DescribeDatabaseCommandInput, diff --git a/clients/client-timestream-write/commands/DescribeEndpointsCommand.ts b/clients/client-timestream-write/commands/DescribeEndpointsCommand.ts index d42008b4aad2..357268de15e9 100644 --- a/clients/client-timestream-write/commands/DescribeEndpointsCommand.ts +++ b/clients/client-timestream-write/commands/DescribeEndpointsCommand.ts @@ -35,6 +35,20 @@ export interface DescribeEndpointsCommandOutput extends DescribeEndpointsRespons * *

For detailed information on how to use DescribeEndpoints, * see The Endpoint Discovery Pattern and REST APIs.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { TimestreamWriteClient, DescribeEndpointsCommand } from "@aws-sdk/client-timestream-write"; // ES Modules import + * // const { TimestreamWriteClient, DescribeEndpointsCommand } = require("@aws-sdk/client-timestream-write"); // CommonJS import + * const client = new TimestreamWriteClient(config); + * const command = new DescribeEndpointsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeEndpointsCommandInput} for command's `input` shape. + * @see {@link DescribeEndpointsCommandOutput} for command's `response` shape. + * @see {@link TimestreamWriteClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeEndpointsCommand extends $Command< DescribeEndpointsCommandInput, diff --git a/clients/client-timestream-write/commands/DescribeTableCommand.ts b/clients/client-timestream-write/commands/DescribeTableCommand.ts index 2c3c439aac5f..2508a3059fb5 100644 --- a/clients/client-timestream-write/commands/DescribeTableCommand.ts +++ b/clients/client-timestream-write/commands/DescribeTableCommand.ts @@ -25,6 +25,20 @@ export interface DescribeTableCommandOutput extends DescribeTableResponse, __Met * retention duration of the memory store and the magnetic store. * Service quotas apply. For more information, see Access Management in the Timestream Developer Guide. *

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { TimestreamWriteClient, DescribeTableCommand } from "@aws-sdk/client-timestream-write"; // ES Modules import + * // const { TimestreamWriteClient, DescribeTableCommand } = require("@aws-sdk/client-timestream-write"); // CommonJS import + * const client = new TimestreamWriteClient(config); + * const command = new DescribeTableCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeTableCommandInput} for command's `input` shape. + * @see {@link DescribeTableCommandOutput} for command's `response` shape. + * @see {@link TimestreamWriteClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeTableCommand extends $Command< DescribeTableCommandInput, diff --git a/clients/client-timestream-write/commands/ListDatabasesCommand.ts b/clients/client-timestream-write/commands/ListDatabasesCommand.ts index 9ef417766da4..2194f777a9c9 100644 --- a/clients/client-timestream-write/commands/ListDatabasesCommand.ts +++ b/clients/client-timestream-write/commands/ListDatabasesCommand.ts @@ -24,6 +24,20 @@ export interface ListDatabasesCommandOutput extends ListDatabasesResponse, __Met *

Returns a list of your Timestream databases. * Service quotas apply. For more information, see Access Management in the Timestream Developer Guide. *

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { TimestreamWriteClient, ListDatabasesCommand } from "@aws-sdk/client-timestream-write"; // ES Modules import + * // const { TimestreamWriteClient, ListDatabasesCommand } = require("@aws-sdk/client-timestream-write"); // CommonJS import + * const client = new TimestreamWriteClient(config); + * const command = new ListDatabasesCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListDatabasesCommandInput} for command's `input` shape. + * @see {@link ListDatabasesCommandOutput} for command's `response` shape. + * @see {@link TimestreamWriteClientResolvedConfig | config} for command's `input` shape. + * */ export class ListDatabasesCommand extends $Command< ListDatabasesCommandInput, diff --git a/clients/client-timestream-write/commands/ListTablesCommand.ts b/clients/client-timestream-write/commands/ListTablesCommand.ts index 24fe63c42564..6fbf7015db3d 100644 --- a/clients/client-timestream-write/commands/ListTablesCommand.ts +++ b/clients/client-timestream-write/commands/ListTablesCommand.ts @@ -23,6 +23,20 @@ export interface ListTablesCommandOutput extends ListTablesResponse, __MetadataB /** *

A list of tables, along with the name, status and retention properties of each table. *

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { TimestreamWriteClient, ListTablesCommand } from "@aws-sdk/client-timestream-write"; // ES Modules import + * // const { TimestreamWriteClient, ListTablesCommand } = require("@aws-sdk/client-timestream-write"); // CommonJS import + * const client = new TimestreamWriteClient(config); + * const command = new ListTablesCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListTablesCommandInput} for command's `input` shape. + * @see {@link ListTablesCommandOutput} for command's `response` shape. + * @see {@link TimestreamWriteClientResolvedConfig | config} for command's `input` shape. + * */ export class ListTablesCommand extends $Command< ListTablesCommandInput, diff --git a/clients/client-timestream-write/commands/ListTagsForResourceCommand.ts b/clients/client-timestream-write/commands/ListTagsForResourceCommand.ts index cf0716433c42..622dcca1db46 100644 --- a/clients/client-timestream-write/commands/ListTagsForResourceCommand.ts +++ b/clients/client-timestream-write/commands/ListTagsForResourceCommand.ts @@ -24,6 +24,20 @@ export interface ListTagsForResourceCommandOutput extends ListTagsForResourceRes *

* List all tags on a Timestream resource. *

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { TimestreamWriteClient, ListTagsForResourceCommand } from "@aws-sdk/client-timestream-write"; // ES Modules import + * // const { TimestreamWriteClient, ListTagsForResourceCommand } = require("@aws-sdk/client-timestream-write"); // CommonJS import + * const client = new TimestreamWriteClient(config); + * const command = new ListTagsForResourceCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListTagsForResourceCommandInput} for command's `input` shape. + * @see {@link ListTagsForResourceCommandOutput} for command's `response` shape. + * @see {@link TimestreamWriteClientResolvedConfig | config} for command's `input` shape. + * */ export class ListTagsForResourceCommand extends $Command< ListTagsForResourceCommandInput, diff --git a/clients/client-timestream-write/commands/TagResourceCommand.ts b/clients/client-timestream-write/commands/TagResourceCommand.ts index 4ab58603042d..6f7d93194d70 100644 --- a/clients/client-timestream-write/commands/TagResourceCommand.ts +++ b/clients/client-timestream-write/commands/TagResourceCommand.ts @@ -26,6 +26,20 @@ export interface TagResourceCommandOutput extends TagResourceResponse, __Metadat * these user-defined tags so that they appear on the Billing and Cost * Management console for cost allocation tracking. *

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { TimestreamWriteClient, TagResourceCommand } from "@aws-sdk/client-timestream-write"; // ES Modules import + * // const { TimestreamWriteClient, TagResourceCommand } = require("@aws-sdk/client-timestream-write"); // CommonJS import + * const client = new TimestreamWriteClient(config); + * const command = new TagResourceCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link TagResourceCommandInput} for command's `input` shape. + * @see {@link TagResourceCommandOutput} for command's `response` shape. + * @see {@link TimestreamWriteClientResolvedConfig | config} for command's `input` shape. + * */ export class TagResourceCommand extends $Command< TagResourceCommandInput, diff --git a/clients/client-timestream-write/commands/UntagResourceCommand.ts b/clients/client-timestream-write/commands/UntagResourceCommand.ts index df0c14c2d763..f3b260d6bf26 100644 --- a/clients/client-timestream-write/commands/UntagResourceCommand.ts +++ b/clients/client-timestream-write/commands/UntagResourceCommand.ts @@ -24,6 +24,20 @@ export interface UntagResourceCommandOutput extends UntagResourceResponse, __Met *

* Removes the association of tags from a Timestream resource. *

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { TimestreamWriteClient, UntagResourceCommand } from "@aws-sdk/client-timestream-write"; // ES Modules import + * // const { TimestreamWriteClient, UntagResourceCommand } = require("@aws-sdk/client-timestream-write"); // CommonJS import + * const client = new TimestreamWriteClient(config); + * const command = new UntagResourceCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link UntagResourceCommandInput} for command's `input` shape. + * @see {@link UntagResourceCommandOutput} for command's `response` shape. + * @see {@link TimestreamWriteClientResolvedConfig | config} for command's `input` shape. + * */ export class UntagResourceCommand extends $Command< UntagResourceCommandInput, diff --git a/clients/client-timestream-write/commands/UpdateDatabaseCommand.ts b/clients/client-timestream-write/commands/UpdateDatabaseCommand.ts index d16a9f238779..1a37c42af1d6 100644 --- a/clients/client-timestream-write/commands/UpdateDatabaseCommand.ts +++ b/clients/client-timestream-write/commands/UpdateDatabaseCommand.ts @@ -26,6 +26,20 @@ export interface UpdateDatabaseCommandOutput extends UpdateDatabaseResponse, __M * 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. *

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { TimestreamWriteClient, UpdateDatabaseCommand } from "@aws-sdk/client-timestream-write"; // ES Modules import + * // const { TimestreamWriteClient, UpdateDatabaseCommand } = require("@aws-sdk/client-timestream-write"); // CommonJS import + * const client = new TimestreamWriteClient(config); + * const command = new UpdateDatabaseCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link UpdateDatabaseCommandInput} for command's `input` shape. + * @see {@link UpdateDatabaseCommandOutput} for command's `response` shape. + * @see {@link TimestreamWriteClientResolvedConfig | config} for command's `input` shape. + * */ export class UpdateDatabaseCommand extends $Command< UpdateDatabaseCommandInput, diff --git a/clients/client-timestream-write/commands/UpdateTableCommand.ts b/clients/client-timestream-write/commands/UpdateTableCommand.ts index 64b1247a93b7..bfae5ba4f158 100644 --- a/clients/client-timestream-write/commands/UpdateTableCommand.ts +++ b/clients/client-timestream-write/commands/UpdateTableCommand.ts @@ -28,6 +28,20 @@ export interface UpdateTableCommandOutput extends UpdateTableResponse, __Metadat * 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.

*

Service quotas apply. For more information, see Access Management in the Timestream Developer Guide.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { TimestreamWriteClient, UpdateTableCommand } from "@aws-sdk/client-timestream-write"; // ES Modules import + * // const { TimestreamWriteClient, UpdateTableCommand } = require("@aws-sdk/client-timestream-write"); // CommonJS import + * const client = new TimestreamWriteClient(config); + * const command = new UpdateTableCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link UpdateTableCommandInput} for command's `input` shape. + * @see {@link UpdateTableCommandOutput} for command's `response` shape. + * @see {@link TimestreamWriteClientResolvedConfig | config} for command's `input` shape. + * */ export class UpdateTableCommand extends $Command< UpdateTableCommandInput, diff --git a/clients/client-timestream-write/commands/WriteRecordsCommand.ts b/clients/client-timestream-write/commands/WriteRecordsCommand.ts index 51c9ea895fe9..e6543957ba7d 100644 --- a/clients/client-timestream-write/commands/WriteRecordsCommand.ts +++ b/clients/client-timestream-write/commands/WriteRecordsCommand.ts @@ -35,6 +35,20 @@ export interface WriteRecordsCommandOutput extends __MetadataBearer {} * Service quotas apply. For more information, * see Access Management in the Timestream Developer Guide. *

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { TimestreamWriteClient, WriteRecordsCommand } from "@aws-sdk/client-timestream-write"; // ES Modules import + * // const { TimestreamWriteClient, WriteRecordsCommand } = require("@aws-sdk/client-timestream-write"); // CommonJS import + * const client = new TimestreamWriteClient(config); + * const command = new WriteRecordsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link WriteRecordsCommandInput} for command's `input` shape. + * @see {@link WriteRecordsCommandOutput} for command's `response` shape. + * @see {@link TimestreamWriteClientResolvedConfig | config} for command's `input` shape. + * */ export class WriteRecordsCommand extends $Command< WriteRecordsCommandInput, diff --git a/clients/client-timestream-write/models/models_0.ts b/clients/client-timestream-write/models/models_0.ts index f0c3990e991b..00c4c38fa12d 100644 --- a/clients/client-timestream-write/models/models_0.ts +++ b/clients/client-timestream-write/models/models_0.ts @@ -11,6 +11,9 @@ export interface AccessDeniedException extends __SmithyException, $MetadataBeare } export namespace AccessDeniedException { + /** + * @internal + */ export const filterSensitiveLog = (obj: AccessDeniedException): any => ({ ...obj, }); @@ -26,6 +29,9 @@ export interface ConflictException extends __SmithyException, $MetadataBearer { } export namespace ConflictException { + /** + * @internal + */ export const filterSensitiveLog = (obj: ConflictException): any => ({ ...obj, }); @@ -55,6 +61,9 @@ export interface Tag { } export namespace Tag { + /** + * @internal + */ export const filterSensitiveLog = (obj: Tag): any => ({ ...obj, }); @@ -81,6 +90,9 @@ export interface CreateDatabaseRequest { } export namespace CreateDatabaseRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateDatabaseRequest): any => ({ ...obj, }); @@ -126,6 +138,9 @@ export interface Database { } export namespace Database { + /** + * @internal + */ export const filterSensitiveLog = (obj: Database): any => ({ ...obj, }); @@ -139,6 +154,9 @@ export interface CreateDatabaseResponse { } export namespace CreateDatabaseResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateDatabaseResponse): any => ({ ...obj, }); @@ -154,6 +172,9 @@ export interface InternalServerException extends __SmithyException, $MetadataBea } export namespace InternalServerException { + /** + * @internal + */ export const filterSensitiveLog = (obj: InternalServerException): any => ({ ...obj, }); @@ -169,6 +190,9 @@ export interface InvalidEndpointException extends __SmithyException, $MetadataBe } export namespace InvalidEndpointException { + /** + * @internal + */ export const filterSensitiveLog = (obj: InvalidEndpointException): any => ({ ...obj, }); @@ -184,6 +208,9 @@ export interface ServiceQuotaExceededException extends __SmithyException, $Metad } export namespace ServiceQuotaExceededException { + /** + * @internal + */ export const filterSensitiveLog = (obj: ServiceQuotaExceededException): any => ({ ...obj, }); @@ -199,6 +226,9 @@ export interface ThrottlingException extends __SmithyException, $MetadataBearer } export namespace ThrottlingException { + /** + * @internal + */ export const filterSensitiveLog = (obj: ThrottlingException): any => ({ ...obj, }); @@ -214,6 +244,9 @@ export interface ValidationException extends __SmithyException, $MetadataBearer } export namespace ValidationException { + /** + * @internal + */ export const filterSensitiveLog = (obj: ValidationException): any => ({ ...obj, }); @@ -236,6 +269,9 @@ export interface RetentionProperties { } export namespace RetentionProperties { + /** + * @internal + */ export const filterSensitiveLog = (obj: RetentionProperties): any => ({ ...obj, }); @@ -266,6 +302,9 @@ export interface CreateTableRequest { } export namespace CreateTableRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateTableRequest): any => ({ ...obj, }); @@ -328,6 +367,9 @@ export interface Table { } export namespace Table { + /** + * @internal + */ export const filterSensitiveLog = (obj: Table): any => ({ ...obj, }); @@ -341,6 +383,9 @@ export interface CreateTableResponse { } export namespace CreateTableResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateTableResponse): any => ({ ...obj, }); @@ -356,6 +401,9 @@ export interface ResourceNotFoundException extends __SmithyException, $MetadataB } export namespace ResourceNotFoundException { + /** + * @internal + */ export const filterSensitiveLog = (obj: ResourceNotFoundException): any => ({ ...obj, }); @@ -369,6 +417,9 @@ export interface DeleteDatabaseRequest { } export namespace DeleteDatabaseRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteDatabaseRequest): any => ({ ...obj, }); @@ -387,6 +438,9 @@ export interface DeleteTableRequest { } export namespace DeleteTableRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteTableRequest): any => ({ ...obj, }); @@ -400,6 +454,9 @@ export interface DescribeDatabaseRequest { } export namespace DescribeDatabaseRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeDatabaseRequest): any => ({ ...obj, }); @@ -413,6 +470,9 @@ export interface DescribeDatabaseResponse { } export namespace DescribeDatabaseResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeDatabaseResponse): any => ({ ...obj, }); @@ -421,6 +481,9 @@ export namespace DescribeDatabaseResponse { export interface DescribeEndpointsRequest {} export namespace DescribeEndpointsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeEndpointsRequest): any => ({ ...obj, }); @@ -442,6 +505,9 @@ export interface Endpoint { } export namespace Endpoint { + /** + * @internal + */ export const filterSensitiveLog = (obj: Endpoint): any => ({ ...obj, }); @@ -455,6 +521,9 @@ export interface DescribeEndpointsResponse { } export namespace DescribeEndpointsResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeEndpointsResponse): any => ({ ...obj, }); @@ -473,6 +542,9 @@ export interface DescribeTableRequest { } export namespace DescribeTableRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeTableRequest): any => ({ ...obj, }); @@ -486,6 +558,9 @@ export interface DescribeTableResponse { } export namespace DescribeTableResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeTableResponse): any => ({ ...obj, }); @@ -523,6 +598,9 @@ export interface Dimension { } export namespace Dimension { + /** + * @internal + */ export const filterSensitiveLog = (obj: Dimension): any => ({ ...obj, }); @@ -541,6 +619,9 @@ export interface ListDatabasesRequest { } export namespace ListDatabasesRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListDatabasesRequest): any => ({ ...obj, }); @@ -559,6 +640,9 @@ export interface ListDatabasesResponse { } export namespace ListDatabasesResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListDatabasesResponse): any => ({ ...obj, }); @@ -582,6 +666,9 @@ export interface ListTablesRequest { } export namespace ListTablesRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListTablesRequest): any => ({ ...obj, }); @@ -600,6 +687,9 @@ export interface ListTablesResponse { } export namespace ListTablesResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListTablesResponse): any => ({ ...obj, }); @@ -615,6 +705,9 @@ export interface ListTagsForResourceRequest { } export namespace ListTagsForResourceRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListTagsForResourceRequest): any => ({ ...obj, }); @@ -630,6 +723,9 @@ export interface ListTagsForResourceResponse { } export namespace ListTagsForResourceResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListTagsForResourceResponse): any => ({ ...obj, }); @@ -712,6 +808,9 @@ export interface _Record { } export namespace _Record { + /** + * @internal + */ export const filterSensitiveLog = (obj: _Record): any => ({ ...obj, }); @@ -779,6 +878,9 @@ export interface RejectedRecord { } export namespace RejectedRecord { + /** + * @internal + */ export const filterSensitiveLog = (obj: RejectedRecord): any => ({ ...obj, }); @@ -818,6 +920,9 @@ export interface RejectedRecordsException extends __SmithyException, $MetadataBe } export namespace RejectedRecordsException { + /** + * @internal + */ export const filterSensitiveLog = (obj: RejectedRecordsException): any => ({ ...obj, }); @@ -841,6 +946,9 @@ export interface TagResourceRequest { } export namespace TagResourceRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: TagResourceRequest): any => ({ ...obj, }); @@ -849,6 +957,9 @@ export namespace TagResourceRequest { export interface TagResourceResponse {} export namespace TagResourceResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: TagResourceResponse): any => ({ ...obj, }); @@ -873,6 +984,9 @@ export interface UntagResourceRequest { } export namespace UntagResourceRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: UntagResourceRequest): any => ({ ...obj, }); @@ -881,6 +995,9 @@ export namespace UntagResourceRequest { export interface UntagResourceResponse {} export namespace UntagResourceResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: UntagResourceResponse): any => ({ ...obj, }); @@ -924,6 +1041,9 @@ export interface UpdateDatabaseRequest { } export namespace UpdateDatabaseRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateDatabaseRequest): any => ({ ...obj, }); @@ -939,6 +1059,9 @@ export interface UpdateDatabaseResponse { } export namespace UpdateDatabaseResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateDatabaseResponse): any => ({ ...obj, }); @@ -962,6 +1085,9 @@ export interface UpdateTableRequest { } export namespace UpdateTableRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateTableRequest): any => ({ ...obj, }); @@ -975,6 +1101,9 @@ export interface UpdateTableResponse { } export namespace UpdateTableResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateTableResponse): any => ({ ...obj, }); @@ -1009,6 +1138,9 @@ export interface WriteRecordsRequest { } export namespace WriteRecordsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: WriteRecordsRequest): any => ({ ...obj, }); diff --git a/clients/client-transcribe-streaming/commands/StartMedicalStreamTranscriptionCommand.ts b/clients/client-transcribe-streaming/commands/StartMedicalStreamTranscriptionCommand.ts index 2e935039c7e3..7d97fbd0dcf8 100644 --- a/clients/client-transcribe-streaming/commands/StartMedicalStreamTranscriptionCommand.ts +++ b/clients/client-transcribe-streaming/commands/StartMedicalStreamTranscriptionCommand.ts @@ -31,6 +31,20 @@ export interface StartMedicalStreamTranscriptionCommandOutput /** *

Starts a bidirectional HTTP/2 stream where audio is streamed to Amazon Transcribe Medical and the * transcription results are streamed to your application.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { TranscribeStreamingClient, StartMedicalStreamTranscriptionCommand } from "@aws-sdk/client-transcribe-streaming"; // ES Modules import + * // const { TranscribeStreamingClient, StartMedicalStreamTranscriptionCommand } = require("@aws-sdk/client-transcribe-streaming"); // CommonJS import + * const client = new TranscribeStreamingClient(config); + * const command = new StartMedicalStreamTranscriptionCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link StartMedicalStreamTranscriptionCommandInput} for command's `input` shape. + * @see {@link StartMedicalStreamTranscriptionCommandOutput} for command's `response` shape. + * @see {@link TranscribeStreamingClientResolvedConfig | config} for command's `input` shape. + * */ export class StartMedicalStreamTranscriptionCommand extends $Command< StartMedicalStreamTranscriptionCommandInput, diff --git a/clients/client-transcribe-streaming/commands/StartStreamTranscriptionCommand.ts b/clients/client-transcribe-streaming/commands/StartStreamTranscriptionCommand.ts index 529af52d7a79..44881c01c27e 100644 --- a/clients/client-transcribe-streaming/commands/StartStreamTranscriptionCommand.ts +++ b/clients/client-transcribe-streaming/commands/StartStreamTranscriptionCommand.ts @@ -44,6 +44,20 @@ export interface StartStreamTranscriptionCommandOutput extends StartStreamTransc *

x-amzn-transcribe-session-id

* * + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { TranscribeStreamingClient, StartStreamTranscriptionCommand } from "@aws-sdk/client-transcribe-streaming"; // ES Modules import + * // const { TranscribeStreamingClient, StartStreamTranscriptionCommand } = require("@aws-sdk/client-transcribe-streaming"); // CommonJS import + * const client = new TranscribeStreamingClient(config); + * const command = new StartStreamTranscriptionCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link StartStreamTranscriptionCommandInput} for command's `input` shape. + * @see {@link StartStreamTranscriptionCommandOutput} for command's `response` shape. + * @see {@link TranscribeStreamingClientResolvedConfig | config} for command's `input` shape. + * */ export class StartStreamTranscriptionCommand extends $Command< StartStreamTranscriptionCommandInput, diff --git a/clients/client-transcribe-streaming/models/models_0.ts b/clients/client-transcribe-streaming/models/models_0.ts index fa1cfd809729..6a5f8cc2dd3d 100644 --- a/clients/client-transcribe-streaming/models/models_0.ts +++ b/clients/client-transcribe-streaming/models/models_0.ts @@ -54,6 +54,9 @@ export interface Item { } export namespace Item { + /** + * @internal + */ export const filterSensitiveLog = (obj: Item): any => ({ ...obj, }); @@ -75,6 +78,9 @@ export interface Alternative { } export namespace Alternative { + /** + * @internal + */ export const filterSensitiveLog = (obj: Alternative): any => ({ ...obj, }); @@ -92,6 +98,9 @@ export interface AudioEvent { } export namespace AudioEvent { + /** + * @internal + */ export const filterSensitiveLog = (obj: AudioEvent): any => ({ ...obj, }); @@ -129,6 +138,9 @@ export namespace AudioStream { return visitor._(value.$unknown[0], value.$unknown[1]); }; + /** + * @internal + */ export const filterSensitiveLog = (obj: AudioStream): any => { if (obj.AudioEvent !== undefined) return { AudioEvent: AudioEvent.filterSensitiveLog(obj.AudioEvent) }; if (obj.$unknown !== undefined) return { [obj.$unknown[0]]: "UNKNOWN" }; @@ -148,6 +160,9 @@ export interface BadRequestException extends __SmithyException, $MetadataBearer } export namespace BadRequestException { + /** + * @internal + */ export const filterSensitiveLog = (obj: BadRequestException): any => ({ ...obj, }); @@ -164,6 +179,9 @@ export interface ConflictException extends __SmithyException, $MetadataBearer { } export namespace ConflictException { + /** + * @internal + */ export const filterSensitiveLog = (obj: ConflictException): any => ({ ...obj, }); @@ -180,6 +198,9 @@ export interface InternalFailureException extends __SmithyException, $MetadataBe } export namespace InternalFailureException { + /** + * @internal + */ export const filterSensitiveLog = (obj: InternalFailureException): any => ({ ...obj, }); @@ -213,6 +234,9 @@ export interface LimitExceededException extends __SmithyException, $MetadataBear } export namespace LimitExceededException { + /** + * @internal + */ export const filterSensitiveLog = (obj: LimitExceededException): any => ({ ...obj, }); @@ -258,6 +282,9 @@ export interface MedicalEntity { } export namespace MedicalEntity { + /** + * @internal + */ export const filterSensitiveLog = (obj: MedicalEntity): any => ({ ...obj, }); @@ -310,6 +337,9 @@ export interface MedicalItem { } export namespace MedicalItem { + /** + * @internal + */ export const filterSensitiveLog = (obj: MedicalItem): any => ({ ...obj, }); @@ -337,6 +367,9 @@ export interface MedicalAlternative { } export namespace MedicalAlternative { + /** + * @internal + */ export const filterSensitiveLog = (obj: MedicalAlternative): any => ({ ...obj, }); @@ -393,6 +426,9 @@ export interface MedicalResult { } export namespace MedicalResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: MedicalResult): any => ({ ...obj, }); @@ -411,6 +447,9 @@ export interface MedicalTranscript { } export namespace MedicalTranscript { + /** + * @internal + */ export const filterSensitiveLog = (obj: MedicalTranscript): any => ({ ...obj, }); @@ -429,6 +468,9 @@ export interface MedicalTranscriptEvent { } export namespace MedicalTranscriptEvent { + /** + * @internal + */ export const filterSensitiveLog = (obj: MedicalTranscriptEvent): any => ({ ...obj, }); @@ -444,6 +486,9 @@ export interface ServiceUnavailableException extends __SmithyException, $Metadat } export namespace ServiceUnavailableException { + /** + * @internal + */ export const filterSensitiveLog = (obj: ServiceUnavailableException): any => ({ ...obj, }); @@ -583,6 +628,9 @@ export namespace MedicalTranscriptResultStream { return visitor._(value.$unknown[0], value.$unknown[1]); }; + /** + * @internal + */ export const filterSensitiveLog = (obj: MedicalTranscriptResultStream): any => { if (obj.TranscriptEvent !== undefined) return { TranscriptEvent: MedicalTranscriptEvent.filterSensitiveLog(obj.TranscriptEvent) }; @@ -646,6 +694,9 @@ export interface Result { } export namespace Result { + /** + * @internal + */ export const filterSensitiveLog = (obj: Result): any => ({ ...obj, }); @@ -742,6 +793,9 @@ export interface StartMedicalStreamTranscriptionRequest { } export namespace StartMedicalStreamTranscriptionRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: StartMedicalStreamTranscriptionRequest): any => ({ ...obj, ...(obj.AudioStream && { AudioStream: "STREAMING_CONTENT" }), @@ -819,6 +873,9 @@ export interface StartMedicalStreamTranscriptionResponse { } export namespace StartMedicalStreamTranscriptionResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: StartMedicalStreamTranscriptionResponse): any => ({ ...obj, ...(obj.TranscriptResultStream && { TranscriptResultStream: "STREAMING_CONTENT" }), @@ -901,6 +958,9 @@ export interface StartStreamTranscriptionRequest { } export namespace StartStreamTranscriptionRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: StartStreamTranscriptionRequest): any => ({ ...obj, ...(obj.AudioStream && { AudioStream: "STREAMING_CONTENT" }), @@ -920,6 +980,9 @@ export interface Transcript { } export namespace Transcript { + /** + * @internal + */ export const filterSensitiveLog = (obj: Transcript): any => ({ ...obj, }); @@ -938,6 +1001,9 @@ export interface TranscriptEvent { } export namespace TranscriptEvent { + /** + * @internal + */ export const filterSensitiveLog = (obj: TranscriptEvent): any => ({ ...obj, }); @@ -1072,6 +1138,9 @@ export namespace TranscriptResultStream { return visitor._(value.$unknown[0], value.$unknown[1]); }; + /** + * @internal + */ export const filterSensitiveLog = (obj: TranscriptResultStream): any => { if (obj.TranscriptEvent !== undefined) return { TranscriptEvent: TranscriptEvent.filterSensitiveLog(obj.TranscriptEvent) }; @@ -1155,6 +1224,9 @@ export interface StartStreamTranscriptionResponse { } export namespace StartStreamTranscriptionResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: StartStreamTranscriptionResponse): any => ({ ...obj, ...(obj.TranscriptResultStream && { TranscriptResultStream: "STREAMING_CONTENT" }), diff --git a/clients/client-transcribe/commands/CreateLanguageModelCommand.ts b/clients/client-transcribe/commands/CreateLanguageModelCommand.ts index 9aadccc022a0..f3eba2718db4 100644 --- a/clients/client-transcribe/commands/CreateLanguageModelCommand.ts +++ b/clients/client-transcribe/commands/CreateLanguageModelCommand.ts @@ -24,6 +24,20 @@ export interface CreateLanguageModelCommandOutput extends CreateLanguageModelRes *

Creates a new custom language model. Use Amazon S3 prefixes to provide the location of your * input files. The time it takes to create your model depends on the size of your training * data.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { TranscribeClient, CreateLanguageModelCommand } from "@aws-sdk/client-transcribe"; // ES Modules import + * // const { TranscribeClient, CreateLanguageModelCommand } = require("@aws-sdk/client-transcribe"); // CommonJS import + * const client = new TranscribeClient(config); + * const command = new CreateLanguageModelCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreateLanguageModelCommandInput} for command's `input` shape. + * @see {@link CreateLanguageModelCommandOutput} for command's `response` shape. + * @see {@link TranscribeClientResolvedConfig | config} for command's `input` shape. + * */ export class CreateLanguageModelCommand extends $Command< CreateLanguageModelCommandInput, diff --git a/clients/client-transcribe/commands/CreateMedicalVocabularyCommand.ts b/clients/client-transcribe/commands/CreateMedicalVocabularyCommand.ts index 21afad71ee11..67d04b75805f 100644 --- a/clients/client-transcribe/commands/CreateMedicalVocabularyCommand.ts +++ b/clients/client-transcribe/commands/CreateMedicalVocabularyCommand.ts @@ -24,6 +24,20 @@ export interface CreateMedicalVocabularyCommandOutput extends CreateMedicalVocab *

Creates a new custom vocabulary that you can use to * change * how Amazon Transcribe Medical transcribes your audio file.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { TranscribeClient, CreateMedicalVocabularyCommand } from "@aws-sdk/client-transcribe"; // ES Modules import + * // const { TranscribeClient, CreateMedicalVocabularyCommand } = require("@aws-sdk/client-transcribe"); // CommonJS import + * const client = new TranscribeClient(config); + * const command = new CreateMedicalVocabularyCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreateMedicalVocabularyCommandInput} for command's `input` shape. + * @see {@link CreateMedicalVocabularyCommandOutput} for command's `response` shape. + * @see {@link TranscribeClientResolvedConfig | config} for command's `input` shape. + * */ export class CreateMedicalVocabularyCommand extends $Command< CreateMedicalVocabularyCommandInput, diff --git a/clients/client-transcribe/commands/CreateVocabularyCommand.ts b/clients/client-transcribe/commands/CreateVocabularyCommand.ts index b2cd16a45b57..e777cab87169 100644 --- a/clients/client-transcribe/commands/CreateVocabularyCommand.ts +++ b/clients/client-transcribe/commands/CreateVocabularyCommand.ts @@ -23,6 +23,20 @@ export interface CreateVocabularyCommandOutput extends CreateVocabularyResponse, /** *

Creates a new custom vocabulary that you can use to change the way Amazon Transcribe handles * transcription of an audio file.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { TranscribeClient, CreateVocabularyCommand } from "@aws-sdk/client-transcribe"; // ES Modules import + * // const { TranscribeClient, CreateVocabularyCommand } = require("@aws-sdk/client-transcribe"); // CommonJS import + * const client = new TranscribeClient(config); + * const command = new CreateVocabularyCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreateVocabularyCommandInput} for command's `input` shape. + * @see {@link CreateVocabularyCommandOutput} for command's `response` shape. + * @see {@link TranscribeClientResolvedConfig | config} for command's `input` shape. + * */ export class CreateVocabularyCommand extends $Command< CreateVocabularyCommandInput, diff --git a/clients/client-transcribe/commands/CreateVocabularyFilterCommand.ts b/clients/client-transcribe/commands/CreateVocabularyFilterCommand.ts index a258fbc48908..0a699704bbbe 100644 --- a/clients/client-transcribe/commands/CreateVocabularyFilterCommand.ts +++ b/clients/client-transcribe/commands/CreateVocabularyFilterCommand.ts @@ -23,6 +23,20 @@ export interface CreateVocabularyFilterCommandOutput extends CreateVocabularyFil /** *

Creates a new vocabulary filter that you can use to filter words, such as profane * words, from the output of a transcription job.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { TranscribeClient, CreateVocabularyFilterCommand } from "@aws-sdk/client-transcribe"; // ES Modules import + * // const { TranscribeClient, CreateVocabularyFilterCommand } = require("@aws-sdk/client-transcribe"); // CommonJS import + * const client = new TranscribeClient(config); + * const command = new CreateVocabularyFilterCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreateVocabularyFilterCommandInput} for command's `input` shape. + * @see {@link CreateVocabularyFilterCommandOutput} for command's `response` shape. + * @see {@link TranscribeClientResolvedConfig | config} for command's `input` shape. + * */ export class CreateVocabularyFilterCommand extends $Command< CreateVocabularyFilterCommandInput, diff --git a/clients/client-transcribe/commands/DeleteLanguageModelCommand.ts b/clients/client-transcribe/commands/DeleteLanguageModelCommand.ts index 572517431a67..e39482adf4ea 100644 --- a/clients/client-transcribe/commands/DeleteLanguageModelCommand.ts +++ b/clients/client-transcribe/commands/DeleteLanguageModelCommand.ts @@ -22,6 +22,20 @@ export interface DeleteLanguageModelCommandOutput extends __MetadataBearer {} /** *

Deletes a custom language model using its name.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { TranscribeClient, DeleteLanguageModelCommand } from "@aws-sdk/client-transcribe"; // ES Modules import + * // const { TranscribeClient, DeleteLanguageModelCommand } = require("@aws-sdk/client-transcribe"); // CommonJS import + * const client = new TranscribeClient(config); + * const command = new DeleteLanguageModelCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteLanguageModelCommandInput} for command's `input` shape. + * @see {@link DeleteLanguageModelCommandOutput} for command's `response` shape. + * @see {@link TranscribeClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteLanguageModelCommand extends $Command< DeleteLanguageModelCommandInput, diff --git a/clients/client-transcribe/commands/DeleteMedicalTranscriptionJobCommand.ts b/clients/client-transcribe/commands/DeleteMedicalTranscriptionJobCommand.ts index c82d4bdc39ae..214590ddeeaa 100644 --- a/clients/client-transcribe/commands/DeleteMedicalTranscriptionJobCommand.ts +++ b/clients/client-transcribe/commands/DeleteMedicalTranscriptionJobCommand.ts @@ -22,6 +22,20 @@ export interface DeleteMedicalTranscriptionJobCommandOutput extends __MetadataBe /** *

Deletes a transcription job generated by Amazon Transcribe Medical and any related information.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { TranscribeClient, DeleteMedicalTranscriptionJobCommand } from "@aws-sdk/client-transcribe"; // ES Modules import + * // const { TranscribeClient, DeleteMedicalTranscriptionJobCommand } = require("@aws-sdk/client-transcribe"); // CommonJS import + * const client = new TranscribeClient(config); + * const command = new DeleteMedicalTranscriptionJobCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteMedicalTranscriptionJobCommandInput} for command's `input` shape. + * @see {@link DeleteMedicalTranscriptionJobCommandOutput} for command's `response` shape. + * @see {@link TranscribeClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteMedicalTranscriptionJobCommand extends $Command< DeleteMedicalTranscriptionJobCommandInput, diff --git a/clients/client-transcribe/commands/DeleteMedicalVocabularyCommand.ts b/clients/client-transcribe/commands/DeleteMedicalVocabularyCommand.ts index db91b3d1acd6..c2fd79cbd1dd 100644 --- a/clients/client-transcribe/commands/DeleteMedicalVocabularyCommand.ts +++ b/clients/client-transcribe/commands/DeleteMedicalVocabularyCommand.ts @@ -22,6 +22,20 @@ export interface DeleteMedicalVocabularyCommandOutput extends __MetadataBearer { /** *

Deletes a vocabulary from Amazon Transcribe Medical.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { TranscribeClient, DeleteMedicalVocabularyCommand } from "@aws-sdk/client-transcribe"; // ES Modules import + * // const { TranscribeClient, DeleteMedicalVocabularyCommand } = require("@aws-sdk/client-transcribe"); // CommonJS import + * const client = new TranscribeClient(config); + * const command = new DeleteMedicalVocabularyCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteMedicalVocabularyCommandInput} for command's `input` shape. + * @see {@link DeleteMedicalVocabularyCommandOutput} for command's `response` shape. + * @see {@link TranscribeClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteMedicalVocabularyCommand extends $Command< DeleteMedicalVocabularyCommandInput, diff --git a/clients/client-transcribe/commands/DeleteTranscriptionJobCommand.ts b/clients/client-transcribe/commands/DeleteTranscriptionJobCommand.ts index a241fdb34448..3c00338e0948 100644 --- a/clients/client-transcribe/commands/DeleteTranscriptionJobCommand.ts +++ b/clients/client-transcribe/commands/DeleteTranscriptionJobCommand.ts @@ -23,6 +23,20 @@ export interface DeleteTranscriptionJobCommandOutput extends __MetadataBearer {} /** *

Deletes a previously submitted transcription job along with any other generated * results such as the transcription, models, and so on.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { TranscribeClient, DeleteTranscriptionJobCommand } from "@aws-sdk/client-transcribe"; // ES Modules import + * // const { TranscribeClient, DeleteTranscriptionJobCommand } = require("@aws-sdk/client-transcribe"); // CommonJS import + * const client = new TranscribeClient(config); + * const command = new DeleteTranscriptionJobCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteTranscriptionJobCommandInput} for command's `input` shape. + * @see {@link DeleteTranscriptionJobCommandOutput} for command's `response` shape. + * @see {@link TranscribeClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteTranscriptionJobCommand extends $Command< DeleteTranscriptionJobCommandInput, diff --git a/clients/client-transcribe/commands/DeleteVocabularyCommand.ts b/clients/client-transcribe/commands/DeleteVocabularyCommand.ts index 960f66be2c08..e3f439c8d6e4 100644 --- a/clients/client-transcribe/commands/DeleteVocabularyCommand.ts +++ b/clients/client-transcribe/commands/DeleteVocabularyCommand.ts @@ -22,6 +22,20 @@ export interface DeleteVocabularyCommandOutput extends __MetadataBearer {} /** *

Deletes a vocabulary from Amazon Transcribe.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { TranscribeClient, DeleteVocabularyCommand } from "@aws-sdk/client-transcribe"; // ES Modules import + * // const { TranscribeClient, DeleteVocabularyCommand } = require("@aws-sdk/client-transcribe"); // CommonJS import + * const client = new TranscribeClient(config); + * const command = new DeleteVocabularyCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteVocabularyCommandInput} for command's `input` shape. + * @see {@link DeleteVocabularyCommandOutput} for command's `response` shape. + * @see {@link TranscribeClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteVocabularyCommand extends $Command< DeleteVocabularyCommandInput, diff --git a/clients/client-transcribe/commands/DeleteVocabularyFilterCommand.ts b/clients/client-transcribe/commands/DeleteVocabularyFilterCommand.ts index 8381e09ddc9d..4cf2fe4e1564 100644 --- a/clients/client-transcribe/commands/DeleteVocabularyFilterCommand.ts +++ b/clients/client-transcribe/commands/DeleteVocabularyFilterCommand.ts @@ -22,6 +22,20 @@ export interface DeleteVocabularyFilterCommandOutput extends __MetadataBearer {} /** *

Removes a vocabulary filter.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { TranscribeClient, DeleteVocabularyFilterCommand } from "@aws-sdk/client-transcribe"; // ES Modules import + * // const { TranscribeClient, DeleteVocabularyFilterCommand } = require("@aws-sdk/client-transcribe"); // CommonJS import + * const client = new TranscribeClient(config); + * const command = new DeleteVocabularyFilterCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteVocabularyFilterCommandInput} for command's `input` shape. + * @see {@link DeleteVocabularyFilterCommandOutput} for command's `response` shape. + * @see {@link TranscribeClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteVocabularyFilterCommand extends $Command< DeleteVocabularyFilterCommandInput, diff --git a/clients/client-transcribe/commands/DescribeLanguageModelCommand.ts b/clients/client-transcribe/commands/DescribeLanguageModelCommand.ts index e7ff67cb721c..c6e7cb5c0955 100644 --- a/clients/client-transcribe/commands/DescribeLanguageModelCommand.ts +++ b/clients/client-transcribe/commands/DescribeLanguageModelCommand.ts @@ -27,6 +27,20 @@ export interface DescribeLanguageModelCommandOutput extends DescribeLanguageMode * updated the base model, you can create a new custom language model using the updated * base model. If the language model wasn't created, you can use this operation to * understand why Amazon Transcribe couldn't create it.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { TranscribeClient, DescribeLanguageModelCommand } from "@aws-sdk/client-transcribe"; // ES Modules import + * // const { TranscribeClient, DescribeLanguageModelCommand } = require("@aws-sdk/client-transcribe"); // CommonJS import + * const client = new TranscribeClient(config); + * const command = new DescribeLanguageModelCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeLanguageModelCommandInput} for command's `input` shape. + * @see {@link DescribeLanguageModelCommandOutput} for command's `response` shape. + * @see {@link TranscribeClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeLanguageModelCommand extends $Command< DescribeLanguageModelCommandInput, diff --git a/clients/client-transcribe/commands/GetMedicalTranscriptionJobCommand.ts b/clients/client-transcribe/commands/GetMedicalTranscriptionJobCommand.ts index a55094766b81..4b63af771f1d 100644 --- a/clients/client-transcribe/commands/GetMedicalTranscriptionJobCommand.ts +++ b/clients/client-transcribe/commands/GetMedicalTranscriptionJobCommand.ts @@ -25,6 +25,20 @@ export interface GetMedicalTranscriptionJobCommandOutput extends GetMedicalTrans * job, check the TranscriptionJobStatus field. If the status is * COMPLETED, the job is finished. You find the results of the completed * job in the TranscriptFileUri field.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { TranscribeClient, GetMedicalTranscriptionJobCommand } from "@aws-sdk/client-transcribe"; // ES Modules import + * // const { TranscribeClient, GetMedicalTranscriptionJobCommand } = require("@aws-sdk/client-transcribe"); // CommonJS import + * const client = new TranscribeClient(config); + * const command = new GetMedicalTranscriptionJobCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetMedicalTranscriptionJobCommandInput} for command's `input` shape. + * @see {@link GetMedicalTranscriptionJobCommandOutput} for command's `response` shape. + * @see {@link TranscribeClientResolvedConfig | config} for command's `input` shape. + * */ export class GetMedicalTranscriptionJobCommand extends $Command< GetMedicalTranscriptionJobCommandInput, diff --git a/clients/client-transcribe/commands/GetMedicalVocabularyCommand.ts b/clients/client-transcribe/commands/GetMedicalVocabularyCommand.ts index 57e32c6681c1..84b4eccbe156 100644 --- a/clients/client-transcribe/commands/GetMedicalVocabularyCommand.ts +++ b/clients/client-transcribe/commands/GetMedicalVocabularyCommand.ts @@ -22,6 +22,20 @@ export interface GetMedicalVocabularyCommandOutput extends GetMedicalVocabularyR /** *

Retrieves information about a medical vocabulary.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { TranscribeClient, GetMedicalVocabularyCommand } from "@aws-sdk/client-transcribe"; // ES Modules import + * // const { TranscribeClient, GetMedicalVocabularyCommand } = require("@aws-sdk/client-transcribe"); // CommonJS import + * const client = new TranscribeClient(config); + * const command = new GetMedicalVocabularyCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetMedicalVocabularyCommandInput} for command's `input` shape. + * @see {@link GetMedicalVocabularyCommandOutput} for command's `response` shape. + * @see {@link TranscribeClientResolvedConfig | config} for command's `input` shape. + * */ export class GetMedicalVocabularyCommand extends $Command< GetMedicalVocabularyCommandInput, diff --git a/clients/client-transcribe/commands/GetTranscriptionJobCommand.ts b/clients/client-transcribe/commands/GetTranscriptionJobCommand.ts index 34090f404953..2f858c684564 100644 --- a/clients/client-transcribe/commands/GetTranscriptionJobCommand.ts +++ b/clients/client-transcribe/commands/GetTranscriptionJobCommand.ts @@ -26,6 +26,20 @@ export interface GetTranscriptionJobCommandOutput extends GetTranscriptionJobRes * the job is finished and you can find the results at the location specified in the * TranscriptFileUri field. If you enable content redaction, the redacted * transcript appears in RedactedTranscriptFileUri.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { TranscribeClient, GetTranscriptionJobCommand } from "@aws-sdk/client-transcribe"; // ES Modules import + * // const { TranscribeClient, GetTranscriptionJobCommand } = require("@aws-sdk/client-transcribe"); // CommonJS import + * const client = new TranscribeClient(config); + * const command = new GetTranscriptionJobCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetTranscriptionJobCommandInput} for command's `input` shape. + * @see {@link GetTranscriptionJobCommandOutput} for command's `response` shape. + * @see {@link TranscribeClientResolvedConfig | config} for command's `input` shape. + * */ export class GetTranscriptionJobCommand extends $Command< GetTranscriptionJobCommandInput, diff --git a/clients/client-transcribe/commands/GetVocabularyCommand.ts b/clients/client-transcribe/commands/GetVocabularyCommand.ts index 5f49031937ee..0c77f6746669 100644 --- a/clients/client-transcribe/commands/GetVocabularyCommand.ts +++ b/clients/client-transcribe/commands/GetVocabularyCommand.ts @@ -22,6 +22,20 @@ export interface GetVocabularyCommandOutput extends GetVocabularyResponse, __Met /** *

Gets information about a vocabulary.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { TranscribeClient, GetVocabularyCommand } from "@aws-sdk/client-transcribe"; // ES Modules import + * // const { TranscribeClient, GetVocabularyCommand } = require("@aws-sdk/client-transcribe"); // CommonJS import + * const client = new TranscribeClient(config); + * const command = new GetVocabularyCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetVocabularyCommandInput} for command's `input` shape. + * @see {@link GetVocabularyCommandOutput} for command's `response` shape. + * @see {@link TranscribeClientResolvedConfig | config} for command's `input` shape. + * */ export class GetVocabularyCommand extends $Command< GetVocabularyCommandInput, diff --git a/clients/client-transcribe/commands/GetVocabularyFilterCommand.ts b/clients/client-transcribe/commands/GetVocabularyFilterCommand.ts index a646f5e52182..0e8c7626127e 100644 --- a/clients/client-transcribe/commands/GetVocabularyFilterCommand.ts +++ b/clients/client-transcribe/commands/GetVocabularyFilterCommand.ts @@ -22,6 +22,20 @@ export interface GetVocabularyFilterCommandOutput extends GetVocabularyFilterRes /** *

Returns information about a vocabulary filter.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { TranscribeClient, GetVocabularyFilterCommand } from "@aws-sdk/client-transcribe"; // ES Modules import + * // const { TranscribeClient, GetVocabularyFilterCommand } = require("@aws-sdk/client-transcribe"); // CommonJS import + * const client = new TranscribeClient(config); + * const command = new GetVocabularyFilterCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetVocabularyFilterCommandInput} for command's `input` shape. + * @see {@link GetVocabularyFilterCommandOutput} for command's `response` shape. + * @see {@link TranscribeClientResolvedConfig | config} for command's `input` shape. + * */ export class GetVocabularyFilterCommand extends $Command< GetVocabularyFilterCommandInput, diff --git a/clients/client-transcribe/commands/ListLanguageModelsCommand.ts b/clients/client-transcribe/commands/ListLanguageModelsCommand.ts index 27f60833f0d7..fcf8b2b157d8 100644 --- a/clients/client-transcribe/commands/ListLanguageModelsCommand.ts +++ b/clients/client-transcribe/commands/ListLanguageModelsCommand.ts @@ -25,6 +25,20 @@ export interface ListLanguageModelsCommandOutput extends ListLanguageModelsRespo * the information in this list to find a specific custom language model. You can then use * the operation to get more information about * it.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { TranscribeClient, ListLanguageModelsCommand } from "@aws-sdk/client-transcribe"; // ES Modules import + * // const { TranscribeClient, ListLanguageModelsCommand } = require("@aws-sdk/client-transcribe"); // CommonJS import + * const client = new TranscribeClient(config); + * const command = new ListLanguageModelsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListLanguageModelsCommandInput} for command's `input` shape. + * @see {@link ListLanguageModelsCommandOutput} for command's `response` shape. + * @see {@link TranscribeClientResolvedConfig | config} for command's `input` shape. + * */ export class ListLanguageModelsCommand extends $Command< ListLanguageModelsCommandInput, diff --git a/clients/client-transcribe/commands/ListMedicalTranscriptionJobsCommand.ts b/clients/client-transcribe/commands/ListMedicalTranscriptionJobsCommand.ts index 0d917a6d9b09..f59cfe1ff626 100644 --- a/clients/client-transcribe/commands/ListMedicalTranscriptionJobsCommand.ts +++ b/clients/client-transcribe/commands/ListMedicalTranscriptionJobsCommand.ts @@ -25,6 +25,20 @@ export interface ListMedicalTranscriptionJobsCommandOutput /** *

Lists medical transcription jobs with a specified status or substring that matches * their names.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { TranscribeClient, ListMedicalTranscriptionJobsCommand } from "@aws-sdk/client-transcribe"; // ES Modules import + * // const { TranscribeClient, ListMedicalTranscriptionJobsCommand } = require("@aws-sdk/client-transcribe"); // CommonJS import + * const client = new TranscribeClient(config); + * const command = new ListMedicalTranscriptionJobsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListMedicalTranscriptionJobsCommandInput} for command's `input` shape. + * @see {@link ListMedicalTranscriptionJobsCommandOutput} for command's `response` shape. + * @see {@link TranscribeClientResolvedConfig | config} for command's `input` shape. + * */ export class ListMedicalTranscriptionJobsCommand extends $Command< ListMedicalTranscriptionJobsCommandInput, diff --git a/clients/client-transcribe/commands/ListMedicalVocabulariesCommand.ts b/clients/client-transcribe/commands/ListMedicalVocabulariesCommand.ts index e517f8ee14de..58c4ca94715b 100644 --- a/clients/client-transcribe/commands/ListMedicalVocabulariesCommand.ts +++ b/clients/client-transcribe/commands/ListMedicalVocabulariesCommand.ts @@ -23,6 +23,20 @@ export interface ListMedicalVocabulariesCommandOutput extends ListMedicalVocabul /** *

Returns a list of vocabularies that match the specified criteria. If you don't enter a * value in any of the request parameters, returns the entire list of vocabularies.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { TranscribeClient, ListMedicalVocabulariesCommand } from "@aws-sdk/client-transcribe"; // ES Modules import + * // const { TranscribeClient, ListMedicalVocabulariesCommand } = require("@aws-sdk/client-transcribe"); // CommonJS import + * const client = new TranscribeClient(config); + * const command = new ListMedicalVocabulariesCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListMedicalVocabulariesCommandInput} for command's `input` shape. + * @see {@link ListMedicalVocabulariesCommandOutput} for command's `response` shape. + * @see {@link TranscribeClientResolvedConfig | config} for command's `input` shape. + * */ export class ListMedicalVocabulariesCommand extends $Command< ListMedicalVocabulariesCommandInput, diff --git a/clients/client-transcribe/commands/ListTranscriptionJobsCommand.ts b/clients/client-transcribe/commands/ListTranscriptionJobsCommand.ts index fd064712f6d8..8285fee615ce 100644 --- a/clients/client-transcribe/commands/ListTranscriptionJobsCommand.ts +++ b/clients/client-transcribe/commands/ListTranscriptionJobsCommand.ts @@ -22,6 +22,20 @@ export interface ListTranscriptionJobsCommandOutput extends ListTranscriptionJob /** *

Lists transcription jobs with the specified status.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { TranscribeClient, ListTranscriptionJobsCommand } from "@aws-sdk/client-transcribe"; // ES Modules import + * // const { TranscribeClient, ListTranscriptionJobsCommand } = require("@aws-sdk/client-transcribe"); // CommonJS import + * const client = new TranscribeClient(config); + * const command = new ListTranscriptionJobsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListTranscriptionJobsCommandInput} for command's `input` shape. + * @see {@link ListTranscriptionJobsCommandOutput} for command's `response` shape. + * @see {@link TranscribeClientResolvedConfig | config} for command's `input` shape. + * */ export class ListTranscriptionJobsCommand extends $Command< ListTranscriptionJobsCommandInput, diff --git a/clients/client-transcribe/commands/ListVocabulariesCommand.ts b/clients/client-transcribe/commands/ListVocabulariesCommand.ts index a528b887e3cc..ead3bca7ccee 100644 --- a/clients/client-transcribe/commands/ListVocabulariesCommand.ts +++ b/clients/client-transcribe/commands/ListVocabulariesCommand.ts @@ -23,6 +23,20 @@ export interface ListVocabulariesCommandOutput extends ListVocabulariesResponse, /** *

Returns a list of vocabularies that match the specified criteria. If no criteria are * specified, returns the entire list of vocabularies.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { TranscribeClient, ListVocabulariesCommand } from "@aws-sdk/client-transcribe"; // ES Modules import + * // const { TranscribeClient, ListVocabulariesCommand } = require("@aws-sdk/client-transcribe"); // CommonJS import + * const client = new TranscribeClient(config); + * const command = new ListVocabulariesCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListVocabulariesCommandInput} for command's `input` shape. + * @see {@link ListVocabulariesCommandOutput} for command's `response` shape. + * @see {@link TranscribeClientResolvedConfig | config} for command's `input` shape. + * */ export class ListVocabulariesCommand extends $Command< ListVocabulariesCommandInput, diff --git a/clients/client-transcribe/commands/ListVocabularyFiltersCommand.ts b/clients/client-transcribe/commands/ListVocabularyFiltersCommand.ts index 03d80b3da508..a81f10689b90 100644 --- a/clients/client-transcribe/commands/ListVocabularyFiltersCommand.ts +++ b/clients/client-transcribe/commands/ListVocabularyFiltersCommand.ts @@ -22,6 +22,20 @@ export interface ListVocabularyFiltersCommandOutput extends ListVocabularyFilter /** *

Gets information about vocabulary filters.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { TranscribeClient, ListVocabularyFiltersCommand } from "@aws-sdk/client-transcribe"; // ES Modules import + * // const { TranscribeClient, ListVocabularyFiltersCommand } = require("@aws-sdk/client-transcribe"); // CommonJS import + * const client = new TranscribeClient(config); + * const command = new ListVocabularyFiltersCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListVocabularyFiltersCommandInput} for command's `input` shape. + * @see {@link ListVocabularyFiltersCommandOutput} for command's `response` shape. + * @see {@link TranscribeClientResolvedConfig | config} for command's `input` shape. + * */ export class ListVocabularyFiltersCommand extends $Command< ListVocabularyFiltersCommandInput, diff --git a/clients/client-transcribe/commands/StartMedicalTranscriptionJobCommand.ts b/clients/client-transcribe/commands/StartMedicalTranscriptionJobCommand.ts index bae934bbc2e1..7a8959c2bab9 100644 --- a/clients/client-transcribe/commands/StartMedicalTranscriptionJobCommand.ts +++ b/clients/client-transcribe/commands/StartMedicalTranscriptionJobCommand.ts @@ -24,6 +24,20 @@ export interface StartMedicalTranscriptionJobCommandOutput /** *

Starts a batch job to transcribe medical speech to text.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { TranscribeClient, StartMedicalTranscriptionJobCommand } from "@aws-sdk/client-transcribe"; // ES Modules import + * // const { TranscribeClient, StartMedicalTranscriptionJobCommand } = require("@aws-sdk/client-transcribe"); // CommonJS import + * const client = new TranscribeClient(config); + * const command = new StartMedicalTranscriptionJobCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link StartMedicalTranscriptionJobCommandInput} for command's `input` shape. + * @see {@link StartMedicalTranscriptionJobCommandOutput} for command's `response` shape. + * @see {@link TranscribeClientResolvedConfig | config} for command's `input` shape. + * */ export class StartMedicalTranscriptionJobCommand extends $Command< StartMedicalTranscriptionJobCommandInput, diff --git a/clients/client-transcribe/commands/StartTranscriptionJobCommand.ts b/clients/client-transcribe/commands/StartTranscriptionJobCommand.ts index 4186d9607995..15d483ba108f 100644 --- a/clients/client-transcribe/commands/StartTranscriptionJobCommand.ts +++ b/clients/client-transcribe/commands/StartTranscriptionJobCommand.ts @@ -22,6 +22,20 @@ export interface StartTranscriptionJobCommandOutput extends StartTranscriptionJo /** *

Starts an asynchronous job to transcribe speech to text.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { TranscribeClient, StartTranscriptionJobCommand } from "@aws-sdk/client-transcribe"; // ES Modules import + * // const { TranscribeClient, StartTranscriptionJobCommand } = require("@aws-sdk/client-transcribe"); // CommonJS import + * const client = new TranscribeClient(config); + * const command = new StartTranscriptionJobCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link StartTranscriptionJobCommandInput} for command's `input` shape. + * @see {@link StartTranscriptionJobCommandOutput} for command's `response` shape. + * @see {@link TranscribeClientResolvedConfig | config} for command's `input` shape. + * */ export class StartTranscriptionJobCommand extends $Command< StartTranscriptionJobCommandInput, diff --git a/clients/client-transcribe/commands/UpdateMedicalVocabularyCommand.ts b/clients/client-transcribe/commands/UpdateMedicalVocabularyCommand.ts index b7006a120669..c4b95ba32820 100644 --- a/clients/client-transcribe/commands/UpdateMedicalVocabularyCommand.ts +++ b/clients/client-transcribe/commands/UpdateMedicalVocabularyCommand.ts @@ -25,6 +25,20 @@ export interface UpdateMedicalVocabularyCommandOutput extends UpdateMedicalVocab * the one you used to create the vocabulary. The UpdateMedicalVocabulary * operation overwrites all of the existing information with the values that you provide in * the request.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { TranscribeClient, UpdateMedicalVocabularyCommand } from "@aws-sdk/client-transcribe"; // ES Modules import + * // const { TranscribeClient, UpdateMedicalVocabularyCommand } = require("@aws-sdk/client-transcribe"); // CommonJS import + * const client = new TranscribeClient(config); + * const command = new UpdateMedicalVocabularyCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link UpdateMedicalVocabularyCommandInput} for command's `input` shape. + * @see {@link UpdateMedicalVocabularyCommandOutput} for command's `response` shape. + * @see {@link TranscribeClientResolvedConfig | config} for command's `input` shape. + * */ export class UpdateMedicalVocabularyCommand extends $Command< UpdateMedicalVocabularyCommandInput, diff --git a/clients/client-transcribe/commands/UpdateVocabularyCommand.ts b/clients/client-transcribe/commands/UpdateVocabularyCommand.ts index aad4d84ce1ec..b8f5ec23063c 100644 --- a/clients/client-transcribe/commands/UpdateVocabularyCommand.ts +++ b/clients/client-transcribe/commands/UpdateVocabularyCommand.ts @@ -24,6 +24,20 @@ export interface UpdateVocabularyCommandOutput extends UpdateVocabularyResponse, *

Updates an existing vocabulary with new values. The UpdateVocabulary * operation overwrites all of the existing information with the values that you provide in * the request.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { TranscribeClient, UpdateVocabularyCommand } from "@aws-sdk/client-transcribe"; // ES Modules import + * // const { TranscribeClient, UpdateVocabularyCommand } = require("@aws-sdk/client-transcribe"); // CommonJS import + * const client = new TranscribeClient(config); + * const command = new UpdateVocabularyCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link UpdateVocabularyCommandInput} for command's `input` shape. + * @see {@link UpdateVocabularyCommandOutput} for command's `response` shape. + * @see {@link TranscribeClientResolvedConfig | config} for command's `input` shape. + * */ export class UpdateVocabularyCommand extends $Command< UpdateVocabularyCommandInput, diff --git a/clients/client-transcribe/commands/UpdateVocabularyFilterCommand.ts b/clients/client-transcribe/commands/UpdateVocabularyFilterCommand.ts index dfde05fbb1e9..0aa509f83b35 100644 --- a/clients/client-transcribe/commands/UpdateVocabularyFilterCommand.ts +++ b/clients/client-transcribe/commands/UpdateVocabularyFilterCommand.ts @@ -22,6 +22,20 @@ export interface UpdateVocabularyFilterCommandOutput extends UpdateVocabularyFil /** *

Updates a vocabulary filter with a new list of filtered words.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { TranscribeClient, UpdateVocabularyFilterCommand } from "@aws-sdk/client-transcribe"; // ES Modules import + * // const { TranscribeClient, UpdateVocabularyFilterCommand } = require("@aws-sdk/client-transcribe"); // CommonJS import + * const client = new TranscribeClient(config); + * const command = new UpdateVocabularyFilterCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link UpdateVocabularyFilterCommandInput} for command's `input` shape. + * @see {@link UpdateVocabularyFilterCommandOutput} for command's `response` shape. + * @see {@link TranscribeClientResolvedConfig | config} for command's `input` shape. + * */ export class UpdateVocabularyFilterCommand extends $Command< UpdateVocabularyFilterCommandInput, diff --git a/clients/client-transcribe/models/models_0.ts b/clients/client-transcribe/models/models_0.ts index 4c51148ac092..4f4430a1ea93 100644 --- a/clients/client-transcribe/models/models_0.ts +++ b/clients/client-transcribe/models/models_0.ts @@ -14,6 +14,9 @@ export interface BadRequestException extends __SmithyException, $MetadataBearer } export namespace BadRequestException { + /** + * @internal + */ export const filterSensitiveLog = (obj: BadRequestException): any => ({ ...obj, }); @@ -42,6 +45,9 @@ export interface ConflictException extends __SmithyException, $MetadataBearer { } export namespace ConflictException { + /** + * @internal + */ export const filterSensitiveLog = (obj: ConflictException): any => ({ ...obj, }); @@ -78,6 +84,9 @@ export interface ContentRedaction { } export namespace ContentRedaction { + /** + * @internal + */ export const filterSensitiveLog = (obj: ContentRedaction): any => ({ ...obj, }); @@ -108,6 +117,9 @@ export interface InputDataConfig { } export namespace InputDataConfig { + /** + * @internal + */ export const filterSensitiveLog = (obj: InputDataConfig): any => ({ ...obj, }); @@ -143,6 +155,9 @@ export interface CreateLanguageModelRequest { } export namespace CreateLanguageModelRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateLanguageModelRequest): any => ({ ...obj, }); @@ -185,6 +200,9 @@ export interface CreateLanguageModelResponse { } export namespace CreateLanguageModelResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateLanguageModelResponse): any => ({ ...obj, }); @@ -201,6 +219,9 @@ export interface InternalFailureException extends __SmithyException, $MetadataBe } export namespace InternalFailureException { + /** + * @internal + */ export const filterSensitiveLog = (obj: InternalFailureException): any => ({ ...obj, }); @@ -217,6 +238,9 @@ export interface LimitExceededException extends __SmithyException, $MetadataBear } export namespace LimitExceededException { + /** + * @internal + */ export const filterSensitiveLog = (obj: LimitExceededException): any => ({ ...obj, }); @@ -299,6 +323,9 @@ export interface CreateMedicalVocabularyRequest { } export namespace CreateMedicalVocabularyRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateMedicalVocabularyRequest): any => ({ ...obj, }); @@ -343,6 +370,9 @@ export interface CreateMedicalVocabularyResponse { } export namespace CreateMedicalVocabularyResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateMedicalVocabularyResponse): any => ({ ...obj, }); @@ -380,6 +410,9 @@ export interface CreateVocabularyRequest { } export namespace CreateVocabularyRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateVocabularyRequest): any => ({ ...obj, }); @@ -416,6 +449,9 @@ export interface CreateVocabularyResponse { } export namespace CreateVocabularyResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateVocabularyResponse): any => ({ ...obj, }); @@ -458,6 +494,9 @@ export interface CreateVocabularyFilterRequest { } export namespace CreateVocabularyFilterRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateVocabularyFilterRequest): any => ({ ...obj, }); @@ -481,6 +520,9 @@ export interface CreateVocabularyFilterResponse { } export namespace CreateVocabularyFilterResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateVocabularyFilterResponse): any => ({ ...obj, }); @@ -494,6 +536,9 @@ export interface DeleteLanguageModelRequest { } export namespace DeleteLanguageModelRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteLanguageModelRequest): any => ({ ...obj, }); @@ -508,6 +553,9 @@ export interface DeleteMedicalTranscriptionJobRequest { } export namespace DeleteMedicalTranscriptionJobRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteMedicalTranscriptionJobRequest): any => ({ ...obj, }); @@ -521,6 +569,9 @@ export interface DeleteMedicalVocabularyRequest { } export namespace DeleteMedicalVocabularyRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteMedicalVocabularyRequest): any => ({ ...obj, }); @@ -537,6 +588,9 @@ export interface NotFoundException extends __SmithyException, $MetadataBearer { } export namespace NotFoundException { + /** + * @internal + */ export const filterSensitiveLog = (obj: NotFoundException): any => ({ ...obj, }); @@ -550,6 +604,9 @@ export interface DeleteTranscriptionJobRequest { } export namespace DeleteTranscriptionJobRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteTranscriptionJobRequest): any => ({ ...obj, }); @@ -563,6 +620,9 @@ export interface DeleteVocabularyRequest { } export namespace DeleteVocabularyRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteVocabularyRequest): any => ({ ...obj, }); @@ -576,6 +636,9 @@ export interface DeleteVocabularyFilterRequest { } export namespace DeleteVocabularyFilterRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteVocabularyFilterRequest): any => ({ ...obj, }); @@ -589,6 +652,9 @@ export interface DescribeLanguageModelRequest { } export namespace DescribeLanguageModelRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeLanguageModelRequest): any => ({ ...obj, }); @@ -650,6 +716,9 @@ export interface LanguageModel { } export namespace LanguageModel { + /** + * @internal + */ export const filterSensitiveLog = (obj: LanguageModel): any => ({ ...obj, }); @@ -663,6 +732,9 @@ export interface DescribeLanguageModelResponse { } export namespace DescribeLanguageModelResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeLanguageModelResponse): any => ({ ...obj, }); @@ -676,6 +748,9 @@ export interface GetMedicalTranscriptionJobRequest { } export namespace GetMedicalTranscriptionJobRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetMedicalTranscriptionJobRequest): any => ({ ...obj, }); @@ -698,6 +773,9 @@ export interface Media { } export namespace Media { + /** + * @internal + */ export const filterSensitiveLog = (obj: Media): any => ({ ...obj, }); @@ -774,6 +852,9 @@ export interface MedicalTranscriptionSetting { } export namespace MedicalTranscriptionSetting { + /** + * @internal + */ export const filterSensitiveLog = (obj: MedicalTranscriptionSetting): any => ({ ...obj, }); @@ -796,6 +877,9 @@ export interface MedicalTranscript { } export namespace MedicalTranscript { + /** + * @internal + */ export const filterSensitiveLog = (obj: MedicalTranscript): any => ({ ...obj, }); @@ -955,6 +1039,9 @@ export interface MedicalTranscriptionJob { } export namespace MedicalTranscriptionJob { + /** + * @internal + */ export const filterSensitiveLog = (obj: MedicalTranscriptionJob): any => ({ ...obj, }); @@ -968,6 +1055,9 @@ export interface GetMedicalTranscriptionJobResponse { } export namespace GetMedicalTranscriptionJobResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetMedicalTranscriptionJobResponse): any => ({ ...obj, }); @@ -982,6 +1072,9 @@ export interface GetMedicalVocabularyRequest { } export namespace GetMedicalVocabularyRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetMedicalVocabularyRequest): any => ({ ...obj, }); @@ -1028,6 +1121,9 @@ export interface GetMedicalVocabularyResponse { } export namespace GetMedicalVocabularyResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetMedicalVocabularyResponse): any => ({ ...obj, }); @@ -1041,6 +1137,9 @@ export interface GetTranscriptionJobRequest { } export namespace GetTranscriptionJobRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetTranscriptionJobRequest): any => ({ ...obj, }); @@ -1073,6 +1172,9 @@ export interface JobExecutionSettings { } export namespace JobExecutionSettings { + /** + * @internal + */ export const filterSensitiveLog = (obj: JobExecutionSettings): any => ({ ...obj, }); @@ -1089,6 +1191,9 @@ export interface ModelSettings { } export namespace ModelSettings { + /** + * @internal + */ export const filterSensitiveLog = (obj: ModelSettings): any => ({ ...obj, }); @@ -1174,6 +1279,9 @@ export interface Settings { } export namespace Settings { + /** + * @internal + */ export const filterSensitiveLog = (obj: Settings): any => ({ ...obj, }); @@ -1203,6 +1311,9 @@ export interface Transcript { } export namespace Transcript { + /** + * @internal + */ export const filterSensitiveLog = (obj: Transcript): any => ({ ...obj, }); @@ -1354,6 +1465,9 @@ export interface TranscriptionJob { } export namespace TranscriptionJob { + /** + * @internal + */ export const filterSensitiveLog = (obj: TranscriptionJob): any => ({ ...obj, }); @@ -1367,6 +1481,9 @@ export interface GetTranscriptionJobResponse { } export namespace GetTranscriptionJobResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetTranscriptionJobResponse): any => ({ ...obj, }); @@ -1381,6 +1498,9 @@ export interface GetVocabularyRequest { } export namespace GetVocabularyRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetVocabularyRequest): any => ({ ...obj, }); @@ -1421,6 +1541,9 @@ export interface GetVocabularyResponse { } export namespace GetVocabularyResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetVocabularyResponse): any => ({ ...obj, }); @@ -1434,6 +1557,9 @@ export interface GetVocabularyFilterRequest { } export namespace GetVocabularyFilterRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetVocabularyFilterRequest): any => ({ ...obj, }); @@ -1463,6 +1589,9 @@ export interface GetVocabularyFilterResponse { } export namespace GetVocabularyFilterResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetVocabularyFilterResponse): any => ({ ...obj, }); @@ -1496,6 +1625,9 @@ export interface ListLanguageModelsRequest { } export namespace ListLanguageModelsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListLanguageModelsRequest): any => ({ ...obj, }); @@ -1518,6 +1650,9 @@ export interface ListLanguageModelsResponse { } export namespace ListLanguageModelsResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListLanguageModelsResponse): any => ({ ...obj, }); @@ -1552,6 +1687,9 @@ export interface ListMedicalTranscriptionJobsRequest { } export namespace ListMedicalTranscriptionJobsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListMedicalTranscriptionJobsRequest): any => ({ ...obj, }); @@ -1622,6 +1760,9 @@ export interface MedicalTranscriptionJobSummary { } export namespace MedicalTranscriptionJobSummary { + /** + * @internal + */ export const filterSensitiveLog = (obj: MedicalTranscriptionJobSummary): any => ({ ...obj, }); @@ -1650,6 +1791,9 @@ export interface ListMedicalTranscriptionJobsResponse { } export namespace ListMedicalTranscriptionJobsResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListMedicalTranscriptionJobsResponse): any => ({ ...obj, }); @@ -1687,6 +1831,9 @@ export interface ListMedicalVocabulariesRequest { } export namespace ListMedicalVocabulariesRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListMedicalVocabulariesRequest): any => ({ ...obj, }); @@ -1719,6 +1866,9 @@ export interface VocabularyInfo { } export namespace VocabularyInfo { + /** + * @internal + */ export const filterSensitiveLog = (obj: VocabularyInfo): any => ({ ...obj, }); @@ -1748,6 +1898,9 @@ export interface ListMedicalVocabulariesResponse { } export namespace ListMedicalVocabulariesResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListMedicalVocabulariesResponse): any => ({ ...obj, }); @@ -1781,6 +1934,9 @@ export interface ListTranscriptionJobsRequest { } export namespace ListTranscriptionJobsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListTranscriptionJobsRequest): any => ({ ...obj, }); @@ -1863,6 +2019,9 @@ export interface TranscriptionJobSummary { } export namespace TranscriptionJobSummary { + /** + * @internal + */ export const filterSensitiveLog = (obj: TranscriptionJobSummary): any => ({ ...obj, }); @@ -1890,6 +2049,9 @@ export interface ListTranscriptionJobsResponse { } export namespace ListTranscriptionJobsResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListTranscriptionJobsResponse): any => ({ ...obj, }); @@ -1924,6 +2086,9 @@ export interface ListVocabulariesRequest { } export namespace ListVocabulariesRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListVocabulariesRequest): any => ({ ...obj, }); @@ -1952,6 +2117,9 @@ export interface ListVocabulariesResponse { } export namespace ListVocabulariesResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListVocabulariesResponse): any => ({ ...obj, }); @@ -1979,6 +2147,9 @@ export interface ListVocabularyFiltersRequest { } export namespace ListVocabularyFiltersRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListVocabularyFiltersRequest): any => ({ ...obj, }); @@ -2006,6 +2177,9 @@ export interface VocabularyFilterInfo { } export namespace VocabularyFilterInfo { + /** + * @internal + */ export const filterSensitiveLog = (obj: VocabularyFilterInfo): any => ({ ...obj, }); @@ -2032,6 +2206,9 @@ export interface ListVocabularyFiltersResponse { } export namespace ListVocabularyFiltersResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListVocabularyFiltersResponse): any => ({ ...obj, }); @@ -2156,6 +2333,9 @@ export interface StartMedicalTranscriptionJobRequest { } export namespace StartMedicalTranscriptionJobRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: StartMedicalTranscriptionJobRequest): any => ({ ...obj, }); @@ -2169,6 +2349,9 @@ export interface StartMedicalTranscriptionJobResponse { } export namespace StartMedicalTranscriptionJobResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: StartMedicalTranscriptionJobResponse): any => ({ ...obj, }); @@ -2319,6 +2502,9 @@ export interface StartTranscriptionJobRequest { } export namespace StartTranscriptionJobRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: StartTranscriptionJobRequest): any => ({ ...obj, }); @@ -2332,6 +2518,9 @@ export interface StartTranscriptionJobResponse { } export namespace StartTranscriptionJobResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: StartTranscriptionJobResponse): any => ({ ...obj, }); @@ -2375,6 +2564,9 @@ export interface UpdateMedicalVocabularyRequest { } export namespace UpdateMedicalVocabularyRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateMedicalVocabularyRequest): any => ({ ...obj, }); @@ -2406,6 +2598,9 @@ export interface UpdateMedicalVocabularyResponse { } export namespace UpdateMedicalVocabularyResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateMedicalVocabularyResponse): any => ({ ...obj, }); @@ -2443,6 +2638,9 @@ export interface UpdateVocabularyRequest { } export namespace UpdateVocabularyRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateVocabularyRequest): any => ({ ...obj, }); @@ -2473,6 +2671,9 @@ export interface UpdateVocabularyResponse { } export namespace UpdateVocabularyResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateVocabularyResponse): any => ({ ...obj, }); @@ -2508,6 +2709,9 @@ export interface UpdateVocabularyFilterRequest { } export namespace UpdateVocabularyFilterRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateVocabularyFilterRequest): any => ({ ...obj, }); @@ -2531,6 +2735,9 @@ export interface UpdateVocabularyFilterResponse { } export namespace UpdateVocabularyFilterResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateVocabularyFilterResponse): any => ({ ...obj, }); diff --git a/clients/client-transfer/commands/CreateServerCommand.ts b/clients/client-transfer/commands/CreateServerCommand.ts index 95f068d8cfc3..c92f275b8b65 100644 --- a/clients/client-transfer/commands/CreateServerCommand.ts +++ b/clients/client-transfer/commands/CreateServerCommand.ts @@ -25,6 +25,20 @@ export interface CreateServerCommandOutput extends CreateServerResponse, __Metad * AWS. 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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { TransferClient, CreateServerCommand } from "@aws-sdk/client-transfer"; // ES Modules import + * // const { TransferClient, CreateServerCommand } = require("@aws-sdk/client-transfer"); // CommonJS import + * const client = new TransferClient(config); + * const command = new CreateServerCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreateServerCommandInput} for command's `input` shape. + * @see {@link CreateServerCommandOutput} for command's `response` shape. + * @see {@link TransferClientResolvedConfig | config} for command's `input` shape. + * */ export class CreateServerCommand extends $Command< CreateServerCommandInput, diff --git a/clients/client-transfer/commands/CreateUserCommand.ts b/clients/client-transfer/commands/CreateUserCommand.ts index 7b9d5f7b82db..ced5cce21c4b 100644 --- a/clients/client-transfer/commands/CreateUserCommand.ts +++ b/clients/client-transfer/commands/CreateUserCommand.ts @@ -28,6 +28,20 @@ export interface CreateUserCommandOutput extends CreateUserResponse, __MetadataB * user's public key, and assign the user's AWS Identity and Access Management (IAM) * role. You can also optionally add a scope-down policy, and assign metadata with tags that can * be used to group and search for users.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { TransferClient, CreateUserCommand } from "@aws-sdk/client-transfer"; // ES Modules import + * // const { TransferClient, CreateUserCommand } = require("@aws-sdk/client-transfer"); // CommonJS import + * const client = new TransferClient(config); + * const command = new CreateUserCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreateUserCommandInput} for command's `input` shape. + * @see {@link CreateUserCommandOutput} for command's `response` shape. + * @see {@link TransferClientResolvedConfig | config} for command's `input` shape. + * */ export class CreateUserCommand extends $Command< CreateUserCommandInput, diff --git a/clients/client-transfer/commands/DeleteServerCommand.ts b/clients/client-transfer/commands/DeleteServerCommand.ts index 8d37bd175b9d..6247f8627c1c 100644 --- a/clients/client-transfer/commands/DeleteServerCommand.ts +++ b/clients/client-transfer/commands/DeleteServerCommand.ts @@ -24,6 +24,20 @@ export interface DeleteServerCommandOutput extends __MetadataBearer {} *

Deletes the file transfer protocol-enabled server that you specify.

* *

No response returns from this operation.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { TransferClient, DeleteServerCommand } from "@aws-sdk/client-transfer"; // ES Modules import + * // const { TransferClient, DeleteServerCommand } = require("@aws-sdk/client-transfer"); // CommonJS import + * const client = new TransferClient(config); + * const command = new DeleteServerCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteServerCommandInput} for command's `input` shape. + * @see {@link DeleteServerCommandOutput} for command's `response` shape. + * @see {@link TransferClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteServerCommand extends $Command< DeleteServerCommandInput, diff --git a/clients/client-transfer/commands/DeleteSshPublicKeyCommand.ts b/clients/client-transfer/commands/DeleteSshPublicKeyCommand.ts index 53df1c4c90c5..1d00f31f5900 100644 --- a/clients/client-transfer/commands/DeleteSshPublicKeyCommand.ts +++ b/clients/client-transfer/commands/DeleteSshPublicKeyCommand.ts @@ -24,6 +24,20 @@ export interface DeleteSshPublicKeyCommandOutput extends __MetadataBearer {} *

Deletes a user's Secure Shell (SSH) public key.

* *

No response is returned from this operation.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { TransferClient, DeleteSshPublicKeyCommand } from "@aws-sdk/client-transfer"; // ES Modules import + * // const { TransferClient, DeleteSshPublicKeyCommand } = require("@aws-sdk/client-transfer"); // CommonJS import + * const client = new TransferClient(config); + * const command = new DeleteSshPublicKeyCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteSshPublicKeyCommandInput} for command's `input` shape. + * @see {@link DeleteSshPublicKeyCommandOutput} for command's `response` shape. + * @see {@link TransferClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteSshPublicKeyCommand extends $Command< DeleteSshPublicKeyCommandInput, diff --git a/clients/client-transfer/commands/DeleteUserCommand.ts b/clients/client-transfer/commands/DeleteUserCommand.ts index 1a6d172445d6..ef6d5815e33a 100644 --- a/clients/client-transfer/commands/DeleteUserCommand.ts +++ b/clients/client-transfer/commands/DeleteUserCommand.ts @@ -28,6 +28,20 @@ export interface DeleteUserCommandOutput extends __MetadataBearer {} * *

When you delete a user from a server, the user's information is lost.

* + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { TransferClient, DeleteUserCommand } from "@aws-sdk/client-transfer"; // ES Modules import + * // const { TransferClient, DeleteUserCommand } = require("@aws-sdk/client-transfer"); // CommonJS import + * const client = new TransferClient(config); + * const command = new DeleteUserCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteUserCommandInput} for command's `input` shape. + * @see {@link DeleteUserCommandOutput} for command's `response` shape. + * @see {@link TransferClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteUserCommand extends $Command< DeleteUserCommandInput, diff --git a/clients/client-transfer/commands/DescribeSecurityPolicyCommand.ts b/clients/client-transfer/commands/DescribeSecurityPolicyCommand.ts index 7d9e9045a248..80d1cd2b61dd 100644 --- a/clients/client-transfer/commands/DescribeSecurityPolicyCommand.ts +++ b/clients/client-transfer/commands/DescribeSecurityPolicyCommand.ts @@ -25,6 +25,20 @@ export interface DescribeSecurityPolicyCommandOutput extends DescribeSecurityPol * server. The response contains a description of the security policy's properties. For more * information about security policies, see Working with security * policies.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { TransferClient, DescribeSecurityPolicyCommand } from "@aws-sdk/client-transfer"; // ES Modules import + * // const { TransferClient, DescribeSecurityPolicyCommand } = require("@aws-sdk/client-transfer"); // CommonJS import + * const client = new TransferClient(config); + * const command = new DescribeSecurityPolicyCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeSecurityPolicyCommandInput} for command's `input` shape. + * @see {@link DescribeSecurityPolicyCommandOutput} for command's `response` shape. + * @see {@link TransferClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeSecurityPolicyCommand extends $Command< DescribeSecurityPolicyCommandInput, diff --git a/clients/client-transfer/commands/DescribeServerCommand.ts b/clients/client-transfer/commands/DescribeServerCommand.ts index 630ab2e4b690..6d916583dfd5 100644 --- a/clients/client-transfer/commands/DescribeServerCommand.ts +++ b/clients/client-transfer/commands/DescribeServerCommand.ts @@ -27,6 +27,20 @@ export interface DescribeServerCommandOutput extends DescribeServerResponse, __M *

The response contains a description of a server's properties. When you set * EndpointType to VPC, the response will contain the * EndpointDetails.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { TransferClient, DescribeServerCommand } from "@aws-sdk/client-transfer"; // ES Modules import + * // const { TransferClient, DescribeServerCommand } = require("@aws-sdk/client-transfer"); // CommonJS import + * const client = new TransferClient(config); + * const command = new DescribeServerCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeServerCommandInput} for command's `input` shape. + * @see {@link DescribeServerCommandOutput} for command's `response` shape. + * @see {@link TransferClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeServerCommand extends $Command< DescribeServerCommandInput, diff --git a/clients/client-transfer/commands/DescribeUserCommand.ts b/clients/client-transfer/commands/DescribeUserCommand.ts index 03547b9b5466..88ff77eb1b2f 100644 --- a/clients/client-transfer/commands/DescribeUserCommand.ts +++ b/clients/client-transfer/commands/DescribeUserCommand.ts @@ -26,6 +26,20 @@ export interface DescribeUserCommandOutput extends DescribeUserResponse, __Metad * *

The response from this call returns the properties of the user associated with the * ServerId value that was specified.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { TransferClient, DescribeUserCommand } from "@aws-sdk/client-transfer"; // ES Modules import + * // const { TransferClient, DescribeUserCommand } = require("@aws-sdk/client-transfer"); // CommonJS import + * const client = new TransferClient(config); + * const command = new DescribeUserCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeUserCommandInput} for command's `input` shape. + * @see {@link DescribeUserCommandOutput} for command's `response` shape. + * @see {@link TransferClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeUserCommand extends $Command< DescribeUserCommandInput, diff --git a/clients/client-transfer/commands/ImportSshPublicKeyCommand.ts b/clients/client-transfer/commands/ImportSshPublicKeyCommand.ts index 228be4e3187c..86f4931d8e11 100644 --- a/clients/client-transfer/commands/ImportSshPublicKeyCommand.ts +++ b/clients/client-transfer/commands/ImportSshPublicKeyCommand.ts @@ -27,6 +27,20 @@ export interface ImportSshPublicKeyCommandOutput extends ImportSshPublicKeyRespo * *

The response returns the UserName value, the ServerId value, and * the name of the SshPublicKeyId.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { TransferClient, ImportSshPublicKeyCommand } from "@aws-sdk/client-transfer"; // ES Modules import + * // const { TransferClient, ImportSshPublicKeyCommand } = require("@aws-sdk/client-transfer"); // CommonJS import + * const client = new TransferClient(config); + * const command = new ImportSshPublicKeyCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ImportSshPublicKeyCommandInput} for command's `input` shape. + * @see {@link ImportSshPublicKeyCommandOutput} for command's `response` shape. + * @see {@link TransferClientResolvedConfig | config} for command's `input` shape. + * */ export class ImportSshPublicKeyCommand extends $Command< ImportSshPublicKeyCommandInput, diff --git a/clients/client-transfer/commands/ListSecurityPoliciesCommand.ts b/clients/client-transfer/commands/ListSecurityPoliciesCommand.ts index ca5f585cd504..70da74d8cb8f 100644 --- a/clients/client-transfer/commands/ListSecurityPoliciesCommand.ts +++ b/clients/client-transfer/commands/ListSecurityPoliciesCommand.ts @@ -23,6 +23,20 @@ export interface ListSecurityPoliciesCommandOutput extends ListSecurityPoliciesR /** *

Lists the security policies that are attached to your file transfer protocol-enabled * servers.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { TransferClient, ListSecurityPoliciesCommand } from "@aws-sdk/client-transfer"; // ES Modules import + * // const { TransferClient, ListSecurityPoliciesCommand } = require("@aws-sdk/client-transfer"); // CommonJS import + * const client = new TransferClient(config); + * const command = new ListSecurityPoliciesCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListSecurityPoliciesCommandInput} for command's `input` shape. + * @see {@link ListSecurityPoliciesCommandOutput} for command's `response` shape. + * @see {@link TransferClientResolvedConfig | config} for command's `input` shape. + * */ export class ListSecurityPoliciesCommand extends $Command< ListSecurityPoliciesCommandInput, diff --git a/clients/client-transfer/commands/ListServersCommand.ts b/clients/client-transfer/commands/ListServersCommand.ts index ed368b1d0d85..21c8406938a5 100644 --- a/clients/client-transfer/commands/ListServersCommand.ts +++ b/clients/client-transfer/commands/ListServersCommand.ts @@ -23,6 +23,20 @@ export interface ListServersCommandOutput extends ListServersResponse, __Metadat /** *

Lists the file transfer protocol-enabled servers that are associated with your AWS * account.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { TransferClient, ListServersCommand } from "@aws-sdk/client-transfer"; // ES Modules import + * // const { TransferClient, ListServersCommand } = require("@aws-sdk/client-transfer"); // CommonJS import + * const client = new TransferClient(config); + * const command = new ListServersCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListServersCommandInput} for command's `input` shape. + * @see {@link ListServersCommandOutput} for command's `response` shape. + * @see {@link TransferClientResolvedConfig | config} for command's `input` shape. + * */ export class ListServersCommand extends $Command< ListServersCommandInput, diff --git a/clients/client-transfer/commands/ListTagsForResourceCommand.ts b/clients/client-transfer/commands/ListTagsForResourceCommand.ts index c3ac2c719266..e201025379a8 100644 --- a/clients/client-transfer/commands/ListTagsForResourceCommand.ts +++ b/clients/client-transfer/commands/ListTagsForResourceCommand.ts @@ -23,6 +23,20 @@ export interface ListTagsForResourceCommandOutput extends ListTagsForResourceRes /** *

Lists all of the tags associated with the Amazon Resource Number (ARN) you specify. The * resource can be a user, server, or role.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { TransferClient, ListTagsForResourceCommand } from "@aws-sdk/client-transfer"; // ES Modules import + * // const { TransferClient, ListTagsForResourceCommand } = require("@aws-sdk/client-transfer"); // CommonJS import + * const client = new TransferClient(config); + * const command = new ListTagsForResourceCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListTagsForResourceCommandInput} for command's `input` shape. + * @see {@link ListTagsForResourceCommandOutput} for command's `response` shape. + * @see {@link TransferClientResolvedConfig | config} for command's `input` shape. + * */ export class ListTagsForResourceCommand extends $Command< ListTagsForResourceCommandInput, diff --git a/clients/client-transfer/commands/ListUsersCommand.ts b/clients/client-transfer/commands/ListUsersCommand.ts index 142cb3d7e21a..e9af300765a4 100644 --- a/clients/client-transfer/commands/ListUsersCommand.ts +++ b/clients/client-transfer/commands/ListUsersCommand.ts @@ -20,6 +20,20 @@ export interface ListUsersCommandOutput extends ListUsersResponse, __MetadataBea /** *

Lists the users for a file transfer protocol-enabled server that you specify by passing * the ServerId parameter.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { TransferClient, ListUsersCommand } from "@aws-sdk/client-transfer"; // ES Modules import + * // const { TransferClient, ListUsersCommand } = require("@aws-sdk/client-transfer"); // CommonJS import + * const client = new TransferClient(config); + * const command = new ListUsersCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListUsersCommandInput} for command's `input` shape. + * @see {@link ListUsersCommandOutput} for command's `response` shape. + * @see {@link TransferClientResolvedConfig | config} for command's `input` shape. + * */ export class ListUsersCommand extends $Command< ListUsersCommandInput, diff --git a/clients/client-transfer/commands/StartServerCommand.ts b/clients/client-transfer/commands/StartServerCommand.ts index 42cb781d7435..db796481a3b3 100644 --- a/clients/client-transfer/commands/StartServerCommand.ts +++ b/clients/client-transfer/commands/StartServerCommand.ts @@ -30,6 +30,20 @@ export interface StartServerCommandOutput extends __MetadataBearer {} * can indicate an error condition.

* *

No response is returned from this call.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { TransferClient, StartServerCommand } from "@aws-sdk/client-transfer"; // ES Modules import + * // const { TransferClient, StartServerCommand } = require("@aws-sdk/client-transfer"); // CommonJS import + * const client = new TransferClient(config); + * const command = new StartServerCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link StartServerCommandInput} for command's `input` shape. + * @see {@link StartServerCommandOutput} for command's `response` shape. + * @see {@link TransferClientResolvedConfig | config} for command's `input` shape. + * */ export class StartServerCommand extends $Command< StartServerCommandInput, diff --git a/clients/client-transfer/commands/StopServerCommand.ts b/clients/client-transfer/commands/StopServerCommand.ts index fd066f49d880..20b305beb239 100644 --- a/clients/client-transfer/commands/StopServerCommand.ts +++ b/clients/client-transfer/commands/StopServerCommand.ts @@ -36,6 +36,20 @@ export interface StopServerCommandOutput extends __MetadataBearer {} * can indicate an error condition.

* *

No response is returned from this call.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { TransferClient, StopServerCommand } from "@aws-sdk/client-transfer"; // ES Modules import + * // const { TransferClient, StopServerCommand } = require("@aws-sdk/client-transfer"); // CommonJS import + * const client = new TransferClient(config); + * const command = new StopServerCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link StopServerCommandInput} for command's `input` shape. + * @see {@link StopServerCommandOutput} for command's `response` shape. + * @see {@link TransferClientResolvedConfig | config} for command's `input` shape. + * */ export class StopServerCommand extends $Command< StopServerCommandInput, diff --git a/clients/client-transfer/commands/TagResourceCommand.ts b/clients/client-transfer/commands/TagResourceCommand.ts index 7fb3d82fd406..e1c556b78488 100644 --- a/clients/client-transfer/commands/TagResourceCommand.ts +++ b/clients/client-transfer/commands/TagResourceCommand.ts @@ -25,6 +25,20 @@ export interface TagResourceCommandOutput extends __MetadataBearer {} * Resources are users, servers, roles, and other entities.

* *

There is no response returned from this call.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { TransferClient, TagResourceCommand } from "@aws-sdk/client-transfer"; // ES Modules import + * // const { TransferClient, TagResourceCommand } = require("@aws-sdk/client-transfer"); // CommonJS import + * const client = new TransferClient(config); + * const command = new TagResourceCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link TagResourceCommandInput} for command's `input` shape. + * @see {@link TagResourceCommandOutput} for command's `response` shape. + * @see {@link TransferClientResolvedConfig | config} for command's `input` shape. + * */ export class TagResourceCommand extends $Command< TagResourceCommandInput, diff --git a/clients/client-transfer/commands/TestIdentityProviderCommand.ts b/clients/client-transfer/commands/TestIdentityProviderCommand.ts index 35e4391026fd..0076fec507c1 100644 --- a/clients/client-transfer/commands/TestIdentityProviderCommand.ts +++ b/clients/client-transfer/commands/TestIdentityProviderCommand.ts @@ -26,6 +26,20 @@ export interface TestIdentityProviderCommandOutput extends TestIdentityProviderR * 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 API Gateway integration * to ensure that your users can successfully use the service.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { TransferClient, TestIdentityProviderCommand } from "@aws-sdk/client-transfer"; // ES Modules import + * // const { TransferClient, TestIdentityProviderCommand } = require("@aws-sdk/client-transfer"); // CommonJS import + * const client = new TransferClient(config); + * const command = new TestIdentityProviderCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link TestIdentityProviderCommandInput} for command's `input` shape. + * @see {@link TestIdentityProviderCommandOutput} for command's `response` shape. + * @see {@link TransferClientResolvedConfig | config} for command's `input` shape. + * */ export class TestIdentityProviderCommand extends $Command< TestIdentityProviderCommandInput, diff --git a/clients/client-transfer/commands/UntagResourceCommand.ts b/clients/client-transfer/commands/UntagResourceCommand.ts index d4ff1ce64196..e1d600de2b02 100644 --- a/clients/client-transfer/commands/UntagResourceCommand.ts +++ b/clients/client-transfer/commands/UntagResourceCommand.ts @@ -25,6 +25,20 @@ export interface UntagResourceCommandOutput extends __MetadataBearer {} * (ARN). Resources are users, servers, roles, and other entities.

* *

No response is returned from this call.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { TransferClient, UntagResourceCommand } from "@aws-sdk/client-transfer"; // ES Modules import + * // const { TransferClient, UntagResourceCommand } = require("@aws-sdk/client-transfer"); // CommonJS import + * const client = new TransferClient(config); + * const command = new UntagResourceCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link UntagResourceCommandInput} for command's `input` shape. + * @see {@link UntagResourceCommandOutput} for command's `response` shape. + * @see {@link TransferClientResolvedConfig | config} for command's `input` shape. + * */ export class UntagResourceCommand extends $Command< UntagResourceCommandInput, diff --git a/clients/client-transfer/commands/UpdateServerCommand.ts b/clients/client-transfer/commands/UpdateServerCommand.ts index 91fd54b334cc..35d2eb0d28b6 100644 --- a/clients/client-transfer/commands/UpdateServerCommand.ts +++ b/clients/client-transfer/commands/UpdateServerCommand.ts @@ -26,6 +26,20 @@ export interface UpdateServerCommandOutput extends UpdateServerResponse, __Metad * *

The UpdateServer call returns the ServerId of the server you * updated.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { TransferClient, UpdateServerCommand } from "@aws-sdk/client-transfer"; // ES Modules import + * // const { TransferClient, UpdateServerCommand } = require("@aws-sdk/client-transfer"); // CommonJS import + * const client = new TransferClient(config); + * const command = new UpdateServerCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link UpdateServerCommandInput} for command's `input` shape. + * @see {@link UpdateServerCommandOutput} for command's `response` shape. + * @see {@link TransferClientResolvedConfig | config} for command's `input` shape. + * */ export class UpdateServerCommand extends $Command< UpdateServerCommandInput, diff --git a/clients/client-transfer/commands/UpdateUserCommand.ts b/clients/client-transfer/commands/UpdateUserCommand.ts index 4c7c71efffc2..b425a3298c9f 100644 --- a/clients/client-transfer/commands/UpdateUserCommand.ts +++ b/clients/client-transfer/commands/UpdateUserCommand.ts @@ -27,6 +27,20 @@ export interface UpdateUserCommandOutput extends UpdateUserResponse, __MetadataB * *

The response returns the ServerId and the UserName for the * updated user.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { TransferClient, UpdateUserCommand } from "@aws-sdk/client-transfer"; // ES Modules import + * // const { TransferClient, UpdateUserCommand } = require("@aws-sdk/client-transfer"); // CommonJS import + * const client = new TransferClient(config); + * const command = new UpdateUserCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link UpdateUserCommandInput} for command's `input` shape. + * @see {@link UpdateUserCommandOutput} for command's `response` shape. + * @see {@link TransferClientResolvedConfig | config} for command's `input` shape. + * */ export class UpdateUserCommand extends $Command< UpdateUserCommandInput, diff --git a/clients/client-transfer/models/models_0.ts b/clients/client-transfer/models/models_0.ts index a34bbebbabf5..8755da825caa 100644 --- a/clients/client-transfer/models/models_0.ts +++ b/clients/client-transfer/models/models_0.ts @@ -11,6 +11,9 @@ export interface AccessDeniedException extends __SmithyException, $MetadataBeare } export namespace AccessDeniedException { + /** + * @internal + */ export const filterSensitiveLog = (obj: AccessDeniedException): any => ({ ...obj, }); @@ -28,6 +31,9 @@ export interface ConflictException extends __SmithyException, $MetadataBearer { } export namespace ConflictException { + /** + * @internal + */ export const filterSensitiveLog = (obj: ConflictException): any => ({ ...obj, }); @@ -105,6 +111,9 @@ export interface EndpointDetails { } export namespace EndpointDetails { + /** + * @internal + */ export const filterSensitiveLog = (obj: EndpointDetails): any => ({ ...obj, }); @@ -135,6 +144,9 @@ export interface IdentityProviderDetails { } export namespace IdentityProviderDetails { + /** + * @internal + */ export const filterSensitiveLog = (obj: IdentityProviderDetails): any => ({ ...obj, }); @@ -171,6 +183,9 @@ export interface Tag { } export namespace Tag { + /** + * @internal + */ export const filterSensitiveLog = (obj: Tag): any => ({ ...obj, }); @@ -337,6 +352,9 @@ export interface CreateServerRequest { } export namespace CreateServerRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateServerRequest): any => ({ ...obj, ...(obj.HostKey && { HostKey: SENSITIVE_STRING }), @@ -351,6 +369,9 @@ export interface CreateServerResponse { } export namespace CreateServerResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateServerResponse): any => ({ ...obj, }); @@ -366,6 +387,9 @@ export interface InternalServiceError extends __SmithyException, $MetadataBearer } export namespace InternalServiceError { + /** + * @internal + */ export const filterSensitiveLog = (obj: InternalServiceError): any => ({ ...obj, }); @@ -381,6 +405,9 @@ export interface InvalidRequestException extends __SmithyException, $MetadataBea } export namespace InvalidRequestException { + /** + * @internal + */ export const filterSensitiveLog = (obj: InvalidRequestException): any => ({ ...obj, }); @@ -398,6 +425,9 @@ export interface ResourceExistsException extends __SmithyException, $MetadataBea } export namespace ResourceExistsException { + /** + * @internal + */ export const filterSensitiveLog = (obj: ResourceExistsException): any => ({ ...obj, }); @@ -413,6 +443,9 @@ export interface ServiceUnavailableException extends __SmithyException, $Metadat } export namespace ServiceUnavailableException { + /** + * @internal + */ export const filterSensitiveLog = (obj: ServiceUnavailableException): any => ({ ...obj, }); @@ -430,6 +463,9 @@ export interface ThrottlingException extends __SmithyException, $MetadataBearer } export namespace ThrottlingException { + /** + * @internal + */ export const filterSensitiveLog = (obj: ThrottlingException): any => ({ ...obj, }); @@ -452,6 +488,9 @@ export interface HomeDirectoryMapEntry { } export namespace HomeDirectoryMapEntry { + /** + * @internal + */ export const filterSensitiveLog = (obj: HomeDirectoryMapEntry): any => ({ ...obj, }); @@ -469,6 +508,9 @@ export interface PosixProfile { } export namespace PosixProfile { + /** + * @internal + */ export const filterSensitiveLog = (obj: PosixProfile): any => ({ ...obj, }); @@ -588,6 +630,9 @@ export interface CreateUserRequest { } export namespace CreateUserRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateUserRequest): any => ({ ...obj, }); @@ -606,6 +651,9 @@ export interface CreateUserResponse { } export namespace CreateUserResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateUserResponse): any => ({ ...obj, }); @@ -624,6 +672,9 @@ export interface ResourceNotFoundException extends __SmithyException, $MetadataB } export namespace ResourceNotFoundException { + /** + * @internal + */ export const filterSensitiveLog = (obj: ResourceNotFoundException): any => ({ ...obj, }); @@ -637,6 +688,9 @@ export interface DeleteServerRequest { } export namespace DeleteServerRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteServerRequest): any => ({ ...obj, }); @@ -661,6 +715,9 @@ export interface DeleteSshPublicKeyRequest { } export namespace DeleteSshPublicKeyRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteSshPublicKeyRequest): any => ({ ...obj, }); @@ -680,6 +737,9 @@ export interface DeleteUserRequest { } export namespace DeleteUserRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteUserRequest): any => ({ ...obj, }); @@ -728,6 +788,9 @@ export interface DescribedSecurityPolicy { } export namespace DescribedSecurityPolicy { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribedSecurityPolicy): any => ({ ...obj, }); @@ -861,6 +924,9 @@ export interface DescribedServer { } export namespace DescribedServer { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribedServer): any => ({ ...obj, }); @@ -893,6 +959,9 @@ export interface SshPublicKey { } export namespace SshPublicKey { + /** + * @internal + */ export const filterSensitiveLog = (obj: SshPublicKey): any => ({ ...obj, }); @@ -977,6 +1046,9 @@ export interface DescribedUser { } export namespace DescribedUser { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribedUser): any => ({ ...obj, }); @@ -990,6 +1062,9 @@ export interface DescribeSecurityPolicyRequest { } export namespace DescribeSecurityPolicyRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeSecurityPolicyRequest): any => ({ ...obj, }); @@ -1003,6 +1078,9 @@ export interface DescribeSecurityPolicyResponse { } export namespace DescribeSecurityPolicyResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeSecurityPolicyResponse): any => ({ ...obj, }); @@ -1016,6 +1094,9 @@ export interface DescribeServerRequest { } export namespace DescribeServerRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeServerRequest): any => ({ ...obj, }); @@ -1030,6 +1111,9 @@ export interface DescribeServerResponse { } export namespace DescribeServerResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeServerResponse): any => ({ ...obj, }); @@ -1049,6 +1133,9 @@ export interface DescribeUserRequest { } export namespace DescribeUserRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeUserRequest): any => ({ ...obj, }); @@ -1068,6 +1155,9 @@ export interface DescribeUserResponse { } export namespace DescribeUserResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeUserResponse): any => ({ ...obj, }); @@ -1091,6 +1181,9 @@ export interface ImportSshPublicKeyRequest { } export namespace ImportSshPublicKeyRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ImportSshPublicKeyRequest): any => ({ ...obj, }); @@ -1119,6 +1212,9 @@ export interface ImportSshPublicKeyResponse { } export namespace ImportSshPublicKeyResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ImportSshPublicKeyResponse): any => ({ ...obj, }); @@ -1134,6 +1230,9 @@ export interface InvalidNextTokenException extends __SmithyException, $MetadataB } export namespace InvalidNextTokenException { + /** + * @internal + */ export const filterSensitiveLog = (obj: InvalidNextTokenException): any => ({ ...obj, }); @@ -1196,6 +1295,9 @@ export interface ListedServer { } export namespace ListedServer { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListedServer): any => ({ ...obj, }); @@ -1248,6 +1350,9 @@ export interface ListedUser { } export namespace ListedUser { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListedUser): any => ({ ...obj, }); @@ -1270,6 +1375,9 @@ export interface ListSecurityPoliciesRequest { } export namespace ListSecurityPoliciesRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListSecurityPoliciesRequest): any => ({ ...obj, }); @@ -1290,6 +1398,9 @@ export interface ListSecurityPoliciesResponse { } export namespace ListSecurityPoliciesResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListSecurityPoliciesResponse): any => ({ ...obj, }); @@ -1312,6 +1423,9 @@ export interface ListServersRequest { } export namespace ListServersRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListServersRequest): any => ({ ...obj, }); @@ -1332,6 +1446,9 @@ export interface ListServersResponse { } export namespace ListServersResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListServersResponse): any => ({ ...obj, }); @@ -1359,6 +1476,9 @@ export interface ListTagsForResourceRequest { } export namespace ListTagsForResourceRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListTagsForResourceRequest): any => ({ ...obj, }); @@ -1386,6 +1506,9 @@ export interface ListTagsForResourceResponse { } export namespace ListTagsForResourceResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListTagsForResourceResponse): any => ({ ...obj, }); @@ -1413,6 +1536,9 @@ export interface ListUsersRequest { } export namespace ListUsersRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListUsersRequest): any => ({ ...obj, }); @@ -1440,6 +1566,9 @@ export interface ListUsersResponse { } export namespace ListUsersResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListUsersResponse): any => ({ ...obj, }); @@ -1453,6 +1582,9 @@ export interface StartServerRequest { } export namespace StartServerRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: StartServerRequest): any => ({ ...obj, }); @@ -1466,6 +1598,9 @@ export interface StopServerRequest { } export namespace StopServerRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: StopServerRequest): any => ({ ...obj, }); @@ -1486,6 +1621,9 @@ export interface TagResourceRequest { } export namespace TagResourceRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: TagResourceRequest): any => ({ ...obj, }); @@ -1534,6 +1672,9 @@ export interface TestIdentityProviderRequest { } export namespace TestIdentityProviderRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: TestIdentityProviderRequest): any => ({ ...obj, ...(obj.UserPassword && { UserPassword: SENSITIVE_STRING }), @@ -1563,6 +1704,9 @@ export interface TestIdentityProviderResponse { } export namespace TestIdentityProviderResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: TestIdentityProviderResponse): any => ({ ...obj, }); @@ -1583,6 +1727,9 @@ export interface UntagResourceRequest { } export namespace UntagResourceRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: UntagResourceRequest): any => ({ ...obj, }); @@ -1731,6 +1878,9 @@ export interface UpdateServerRequest { } export namespace UpdateServerRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateServerRequest): any => ({ ...obj, ...(obj.HostKey && { HostKey: SENSITIVE_STRING }), @@ -1746,6 +1896,9 @@ export interface UpdateServerResponse { } export namespace UpdateServerResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateServerResponse): any => ({ ...obj, }); @@ -1848,6 +2001,9 @@ export interface UpdateUserRequest { } export namespace UpdateUserRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateUserRequest): any => ({ ...obj, }); @@ -1873,6 +2029,9 @@ export interface UpdateUserResponse { } export namespace UpdateUserResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateUserResponse): any => ({ ...obj, }); diff --git a/clients/client-translate/commands/CreateParallelDataCommand.ts b/clients/client-translate/commands/CreateParallelDataCommand.ts index 2c4f35afccb4..94a6e83a7dcc 100644 --- a/clients/client-translate/commands/CreateParallelDataCommand.ts +++ b/clients/client-translate/commands/CreateParallelDataCommand.ts @@ -25,6 +25,20 @@ export interface CreateParallelDataCommandOutput extends CreateParallelDataRespo * Amazon S3. Parallel data files contain examples of source phrases and their translations from * your translation memory. By adding parallel data, you can influence the style, tone, and word * choice in your translation output.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { TranslateClient, CreateParallelDataCommand } from "@aws-sdk/client-translate"; // ES Modules import + * // const { TranslateClient, CreateParallelDataCommand } = require("@aws-sdk/client-translate"); // CommonJS import + * const client = new TranslateClient(config); + * const command = new CreateParallelDataCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreateParallelDataCommandInput} for command's `input` shape. + * @see {@link CreateParallelDataCommandOutput} for command's `response` shape. + * @see {@link TranslateClientResolvedConfig | config} for command's `input` shape. + * */ export class CreateParallelDataCommand extends $Command< CreateParallelDataCommandInput, diff --git a/clients/client-translate/commands/DeleteParallelDataCommand.ts b/clients/client-translate/commands/DeleteParallelDataCommand.ts index e5a9a3421b91..ec8d9ea65f4e 100644 --- a/clients/client-translate/commands/DeleteParallelDataCommand.ts +++ b/clients/client-translate/commands/DeleteParallelDataCommand.ts @@ -22,6 +22,20 @@ export interface DeleteParallelDataCommandOutput extends DeleteParallelDataRespo /** *

Deletes a parallel data resource in Amazon Translate.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { TranslateClient, DeleteParallelDataCommand } from "@aws-sdk/client-translate"; // ES Modules import + * // const { TranslateClient, DeleteParallelDataCommand } = require("@aws-sdk/client-translate"); // CommonJS import + * const client = new TranslateClient(config); + * const command = new DeleteParallelDataCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteParallelDataCommandInput} for command's `input` shape. + * @see {@link DeleteParallelDataCommandOutput} for command's `response` shape. + * @see {@link TranslateClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteParallelDataCommand extends $Command< DeleteParallelDataCommandInput, diff --git a/clients/client-translate/commands/DeleteTerminologyCommand.ts b/clients/client-translate/commands/DeleteTerminologyCommand.ts index 706b5003deb0..439ee8ff86e3 100644 --- a/clients/client-translate/commands/DeleteTerminologyCommand.ts +++ b/clients/client-translate/commands/DeleteTerminologyCommand.ts @@ -22,6 +22,20 @@ export interface DeleteTerminologyCommandOutput extends __MetadataBearer {} /** *

A synchronous action that deletes a custom terminology.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { TranslateClient, DeleteTerminologyCommand } from "@aws-sdk/client-translate"; // ES Modules import + * // const { TranslateClient, DeleteTerminologyCommand } = require("@aws-sdk/client-translate"); // CommonJS import + * const client = new TranslateClient(config); + * const command = new DeleteTerminologyCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteTerminologyCommandInput} for command's `input` shape. + * @see {@link DeleteTerminologyCommandOutput} for command's `response` shape. + * @see {@link TranslateClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteTerminologyCommand extends $Command< DeleteTerminologyCommandInput, diff --git a/clients/client-translate/commands/DescribeTextTranslationJobCommand.ts b/clients/client-translate/commands/DescribeTextTranslationJobCommand.ts index ce13c77eceba..fe62abc8a04e 100644 --- a/clients/client-translate/commands/DescribeTextTranslationJobCommand.ts +++ b/clients/client-translate/commands/DescribeTextTranslationJobCommand.ts @@ -23,6 +23,20 @@ export interface DescribeTextTranslationJobCommandOutput extends DescribeTextTra /** *

Gets the properties associated with an asycnhronous batch translation job including name, * ID, status, source and target languages, input/output S3 buckets, and so on.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { TranslateClient, DescribeTextTranslationJobCommand } from "@aws-sdk/client-translate"; // ES Modules import + * // const { TranslateClient, DescribeTextTranslationJobCommand } = require("@aws-sdk/client-translate"); // CommonJS import + * const client = new TranslateClient(config); + * const command = new DescribeTextTranslationJobCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeTextTranslationJobCommandInput} for command's `input` shape. + * @see {@link DescribeTextTranslationJobCommandOutput} for command's `response` shape. + * @see {@link TranslateClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeTextTranslationJobCommand extends $Command< DescribeTextTranslationJobCommandInput, diff --git a/clients/client-translate/commands/GetParallelDataCommand.ts b/clients/client-translate/commands/GetParallelDataCommand.ts index 9a2b740e5dfa..cf04f66d459a 100644 --- a/clients/client-translate/commands/GetParallelDataCommand.ts +++ b/clients/client-translate/commands/GetParallelDataCommand.ts @@ -22,6 +22,20 @@ export interface GetParallelDataCommandOutput extends GetParallelDataResponse, _ /** *

Provides information about a parallel data resource.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { TranslateClient, GetParallelDataCommand } from "@aws-sdk/client-translate"; // ES Modules import + * // const { TranslateClient, GetParallelDataCommand } = require("@aws-sdk/client-translate"); // CommonJS import + * const client = new TranslateClient(config); + * const command = new GetParallelDataCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetParallelDataCommandInput} for command's `input` shape. + * @see {@link GetParallelDataCommandOutput} for command's `response` shape. + * @see {@link TranslateClientResolvedConfig | config} for command's `input` shape. + * */ export class GetParallelDataCommand extends $Command< GetParallelDataCommandInput, diff --git a/clients/client-translate/commands/GetTerminologyCommand.ts b/clients/client-translate/commands/GetTerminologyCommand.ts index c6b239713459..5eefaf32d75a 100644 --- a/clients/client-translate/commands/GetTerminologyCommand.ts +++ b/clients/client-translate/commands/GetTerminologyCommand.ts @@ -22,6 +22,20 @@ export interface GetTerminologyCommandOutput extends GetTerminologyResponse, __M /** *

Retrieves a custom terminology.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { TranslateClient, GetTerminologyCommand } from "@aws-sdk/client-translate"; // ES Modules import + * // const { TranslateClient, GetTerminologyCommand } = require("@aws-sdk/client-translate"); // CommonJS import + * const client = new TranslateClient(config); + * const command = new GetTerminologyCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetTerminologyCommandInput} for command's `input` shape. + * @see {@link GetTerminologyCommandOutput} for command's `response` shape. + * @see {@link TranslateClientResolvedConfig | config} for command's `input` shape. + * */ export class GetTerminologyCommand extends $Command< GetTerminologyCommandInput, diff --git a/clients/client-translate/commands/ImportTerminologyCommand.ts b/clients/client-translate/commands/ImportTerminologyCommand.ts index 276b28eca2cf..8bfad8b66447 100644 --- a/clients/client-translate/commands/ImportTerminologyCommand.ts +++ b/clients/client-translate/commands/ImportTerminologyCommand.ts @@ -29,6 +29,20 @@ export interface ImportTerminologyCommandOutput extends ImportTerminologyRespons *

If you import a terminology that overwrites an existing one, the new terminology take up * to 10 minutes to fully propagate and be available for use in a translation due to cache * policies with the DataPlane service that performs the translations.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { TranslateClient, ImportTerminologyCommand } from "@aws-sdk/client-translate"; // ES Modules import + * // const { TranslateClient, ImportTerminologyCommand } = require("@aws-sdk/client-translate"); // CommonJS import + * const client = new TranslateClient(config); + * const command = new ImportTerminologyCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ImportTerminologyCommandInput} for command's `input` shape. + * @see {@link ImportTerminologyCommandOutput} for command's `response` shape. + * @see {@link TranslateClientResolvedConfig | config} for command's `input` shape. + * */ export class ImportTerminologyCommand extends $Command< ImportTerminologyCommandInput, diff --git a/clients/client-translate/commands/ListParallelDataCommand.ts b/clients/client-translate/commands/ListParallelDataCommand.ts index 48fbbdd97b35..7cc727030972 100644 --- a/clients/client-translate/commands/ListParallelDataCommand.ts +++ b/clients/client-translate/commands/ListParallelDataCommand.ts @@ -22,6 +22,20 @@ export interface ListParallelDataCommandOutput extends ListParallelDataResponse, /** *

Provides a list of your parallel data resources in Amazon Translate.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { TranslateClient, ListParallelDataCommand } from "@aws-sdk/client-translate"; // ES Modules import + * // const { TranslateClient, ListParallelDataCommand } = require("@aws-sdk/client-translate"); // CommonJS import + * const client = new TranslateClient(config); + * const command = new ListParallelDataCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListParallelDataCommandInput} for command's `input` shape. + * @see {@link ListParallelDataCommandOutput} for command's `response` shape. + * @see {@link TranslateClientResolvedConfig | config} for command's `input` shape. + * */ export class ListParallelDataCommand extends $Command< ListParallelDataCommandInput, diff --git a/clients/client-translate/commands/ListTerminologiesCommand.ts b/clients/client-translate/commands/ListTerminologiesCommand.ts index 77cd8df14749..58b6d1fcc04e 100644 --- a/clients/client-translate/commands/ListTerminologiesCommand.ts +++ b/clients/client-translate/commands/ListTerminologiesCommand.ts @@ -22,6 +22,20 @@ export interface ListTerminologiesCommandOutput extends ListTerminologiesRespons /** *

Provides a list of custom terminologies associated with your account.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { TranslateClient, ListTerminologiesCommand } from "@aws-sdk/client-translate"; // ES Modules import + * // const { TranslateClient, ListTerminologiesCommand } = require("@aws-sdk/client-translate"); // CommonJS import + * const client = new TranslateClient(config); + * const command = new ListTerminologiesCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListTerminologiesCommandInput} for command's `input` shape. + * @see {@link ListTerminologiesCommandOutput} for command's `response` shape. + * @see {@link TranslateClientResolvedConfig | config} for command's `input` shape. + * */ export class ListTerminologiesCommand extends $Command< ListTerminologiesCommandInput, diff --git a/clients/client-translate/commands/ListTextTranslationJobsCommand.ts b/clients/client-translate/commands/ListTextTranslationJobsCommand.ts index cb7a4677572a..00aff3636211 100644 --- a/clients/client-translate/commands/ListTextTranslationJobsCommand.ts +++ b/clients/client-translate/commands/ListTextTranslationJobsCommand.ts @@ -22,6 +22,20 @@ export interface ListTextTranslationJobsCommandOutput extends ListTextTranslatio /** *

Gets a list of the batch translation jobs that you have submitted.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { TranslateClient, ListTextTranslationJobsCommand } from "@aws-sdk/client-translate"; // ES Modules import + * // const { TranslateClient, ListTextTranslationJobsCommand } = require("@aws-sdk/client-translate"); // CommonJS import + * const client = new TranslateClient(config); + * const command = new ListTextTranslationJobsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListTextTranslationJobsCommandInput} for command's `input` shape. + * @see {@link ListTextTranslationJobsCommandOutput} for command's `response` shape. + * @see {@link TranslateClientResolvedConfig | config} for command's `input` shape. + * */ export class ListTextTranslationJobsCommand extends $Command< ListTextTranslationJobsCommandInput, diff --git a/clients/client-translate/commands/StartTextTranslationJobCommand.ts b/clients/client-translate/commands/StartTextTranslationJobCommand.ts index 9b7d84068fa6..7779b290011e 100644 --- a/clients/client-translate/commands/StartTextTranslationJobCommand.ts +++ b/clients/client-translate/commands/StartTextTranslationJobCommand.ts @@ -29,6 +29,20 @@ export interface StartTextTranslationJobCommandOutput extends StartTextTranslati * *

Amazon Translate does not support batch translation of multiple source languages at once.

* + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { TranslateClient, StartTextTranslationJobCommand } from "@aws-sdk/client-translate"; // ES Modules import + * // const { TranslateClient, StartTextTranslationJobCommand } = require("@aws-sdk/client-translate"); // CommonJS import + * const client = new TranslateClient(config); + * const command = new StartTextTranslationJobCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link StartTextTranslationJobCommandInput} for command's `input` shape. + * @see {@link StartTextTranslationJobCommandOutput} for command's `response` shape. + * @see {@link TranslateClientResolvedConfig | config} for command's `input` shape. + * */ export class StartTextTranslationJobCommand extends $Command< StartTextTranslationJobCommandInput, diff --git a/clients/client-translate/commands/StopTextTranslationJobCommand.ts b/clients/client-translate/commands/StopTextTranslationJobCommand.ts index c322ae9c4295..3a960cd90fa5 100644 --- a/clients/client-translate/commands/StopTextTranslationJobCommand.ts +++ b/clients/client-translate/commands/StopTextTranslationJobCommand.ts @@ -28,6 +28,20 @@ export interface StopTextTranslationJobCommandOutput extends StopTextTranslation * 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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { TranslateClient, StopTextTranslationJobCommand } from "@aws-sdk/client-translate"; // ES Modules import + * // const { TranslateClient, StopTextTranslationJobCommand } = require("@aws-sdk/client-translate"); // CommonJS import + * const client = new TranslateClient(config); + * const command = new StopTextTranslationJobCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link StopTextTranslationJobCommandInput} for command's `input` shape. + * @see {@link StopTextTranslationJobCommandOutput} for command's `response` shape. + * @see {@link TranslateClientResolvedConfig | config} for command's `input` shape. + * */ export class StopTextTranslationJobCommand extends $Command< StopTextTranslationJobCommandInput, diff --git a/clients/client-translate/commands/TranslateTextCommand.ts b/clients/client-translate/commands/TranslateTextCommand.ts index bd0e2f39c305..a7e1c60677a7 100644 --- a/clients/client-translate/commands/TranslateTextCommand.ts +++ b/clients/client-translate/commands/TranslateTextCommand.ts @@ -23,6 +23,20 @@ export interface TranslateTextCommandOutput extends TranslateTextResponse, __Met /** *

Translates input text from the source language to the target language. For a list of * available languages and language codes, see what-is-languages.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { TranslateClient, TranslateTextCommand } from "@aws-sdk/client-translate"; // ES Modules import + * // const { TranslateClient, TranslateTextCommand } = require("@aws-sdk/client-translate"); // CommonJS import + * const client = new TranslateClient(config); + * const command = new TranslateTextCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link TranslateTextCommandInput} for command's `input` shape. + * @see {@link TranslateTextCommandOutput} for command's `response` shape. + * @see {@link TranslateClientResolvedConfig | config} for command's `input` shape. + * */ export class TranslateTextCommand extends $Command< TranslateTextCommandInput, diff --git a/clients/client-translate/commands/UpdateParallelDataCommand.ts b/clients/client-translate/commands/UpdateParallelDataCommand.ts index cc7bec9395b4..b31a43e4df9b 100644 --- a/clients/client-translate/commands/UpdateParallelDataCommand.ts +++ b/clients/client-translate/commands/UpdateParallelDataCommand.ts @@ -23,6 +23,20 @@ export interface UpdateParallelDataCommandOutput extends UpdateParallelDataRespo /** *

Updates a previously created parallel data resource by importing a new input file from * Amazon S3.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { TranslateClient, UpdateParallelDataCommand } from "@aws-sdk/client-translate"; // ES Modules import + * // const { TranslateClient, UpdateParallelDataCommand } = require("@aws-sdk/client-translate"); // CommonJS import + * const client = new TranslateClient(config); + * const command = new UpdateParallelDataCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link UpdateParallelDataCommandInput} for command's `input` shape. + * @see {@link UpdateParallelDataCommandOutput} for command's `response` shape. + * @see {@link TranslateClientResolvedConfig | config} for command's `input` shape. + * */ export class UpdateParallelDataCommand extends $Command< UpdateParallelDataCommandInput, diff --git a/clients/client-translate/models/models_0.ts b/clients/client-translate/models/models_0.ts index 8e0285393de9..29c5a108afdc 100644 --- a/clients/client-translate/models/models_0.ts +++ b/clients/client-translate/models/models_0.ts @@ -17,6 +17,9 @@ export interface Term { } export namespace Term { + /** + * @internal + */ export const filterSensitiveLog = (obj: Term): any => ({ ...obj, }); @@ -44,6 +47,9 @@ export interface AppliedTerminology { } export namespace AppliedTerminology { + /** + * @internal + */ export const filterSensitiveLog = (obj: AppliedTerminology): any => ({ ...obj, }); @@ -59,6 +65,9 @@ export interface ConflictException extends __SmithyException, $MetadataBearer { } export namespace ConflictException { + /** + * @internal + */ export const filterSensitiveLog = (obj: ConflictException): any => ({ ...obj, }); @@ -85,6 +94,9 @@ export interface EncryptionKey { } export namespace EncryptionKey { + /** + * @internal + */ export const filterSensitiveLog = (obj: EncryptionKey): any => ({ ...obj, }); @@ -113,6 +125,9 @@ export interface ParallelDataConfig { } export namespace ParallelDataConfig { + /** + * @internal + */ export const filterSensitiveLog = (obj: ParallelDataConfig): any => ({ ...obj, }); @@ -148,6 +163,9 @@ export interface CreateParallelDataRequest { } export namespace CreateParallelDataRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateParallelDataRequest): any => ({ ...obj, }); @@ -175,6 +193,9 @@ export interface CreateParallelDataResponse { } export namespace CreateParallelDataResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateParallelDataResponse): any => ({ ...obj, }); @@ -190,6 +211,9 @@ export interface InternalServerException extends __SmithyException, $MetadataBea } export namespace InternalServerException { + /** + * @internal + */ export const filterSensitiveLog = (obj: InternalServerException): any => ({ ...obj, }); @@ -206,6 +230,9 @@ export interface InvalidParameterValueException extends __SmithyException, $Meta } export namespace InvalidParameterValueException { + /** + * @internal + */ export const filterSensitiveLog = (obj: InvalidParameterValueException): any => ({ ...obj, }); @@ -222,6 +249,9 @@ export interface InvalidRequestException extends __SmithyException, $MetadataBea } export namespace InvalidRequestException { + /** + * @internal + */ export const filterSensitiveLog = (obj: InvalidRequestException): any => ({ ...obj, }); @@ -238,6 +268,9 @@ export interface LimitExceededException extends __SmithyException, $MetadataBear } export namespace LimitExceededException { + /** + * @internal + */ export const filterSensitiveLog = (obj: LimitExceededException): any => ({ ...obj, }); @@ -254,6 +287,9 @@ export interface TooManyRequestsException extends __SmithyException, $MetadataBe } export namespace TooManyRequestsException { + /** + * @internal + */ export const filterSensitiveLog = (obj: TooManyRequestsException): any => ({ ...obj, }); @@ -270,6 +306,9 @@ export interface ConcurrentModificationException extends __SmithyException, $Met } export namespace ConcurrentModificationException { + /** + * @internal + */ export const filterSensitiveLog = (obj: ConcurrentModificationException): any => ({ ...obj, }); @@ -283,6 +322,9 @@ export interface DeleteParallelDataRequest { } export namespace DeleteParallelDataRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteParallelDataRequest): any => ({ ...obj, }); @@ -301,6 +343,9 @@ export interface DeleteParallelDataResponse { } export namespace DeleteParallelDataResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteParallelDataResponse): any => ({ ...obj, }); @@ -318,6 +363,9 @@ export interface ResourceNotFoundException extends __SmithyException, $MetadataB } export namespace ResourceNotFoundException { + /** + * @internal + */ export const filterSensitiveLog = (obj: ResourceNotFoundException): any => ({ ...obj, }); @@ -331,6 +379,9 @@ export interface DeleteTerminologyRequest { } export namespace DeleteTerminologyRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteTerminologyRequest): any => ({ ...obj, }); @@ -345,6 +396,9 @@ export interface DescribeTextTranslationJobRequest { } export namespace DescribeTextTranslationJobRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeTextTranslationJobRequest): any => ({ ...obj, }); @@ -402,6 +456,9 @@ export interface InputDataConfig { } export namespace InputDataConfig { + /** + * @internal + */ export const filterSensitiveLog = (obj: InputDataConfig): any => ({ ...obj, }); @@ -429,6 +486,9 @@ export interface JobDetails { } export namespace JobDetails { + /** + * @internal + */ export const filterSensitiveLog = (obj: JobDetails): any => ({ ...obj, }); @@ -456,6 +516,9 @@ export interface OutputDataConfig { } export namespace OutputDataConfig { + /** + * @internal + */ export const filterSensitiveLog = (obj: OutputDataConfig): any => ({ ...obj, }); @@ -544,6 +607,9 @@ export interface TextTranslationJobProperties { } export namespace TextTranslationJobProperties { + /** + * @internal + */ export const filterSensitiveLog = (obj: TextTranslationJobProperties): any => ({ ...obj, }); @@ -558,6 +624,9 @@ export interface DescribeTextTranslationJobResponse { } export namespace DescribeTextTranslationJobResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeTextTranslationJobResponse): any => ({ ...obj, }); @@ -571,6 +640,9 @@ export interface GetParallelDataRequest { } export namespace GetParallelDataRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetParallelDataRequest): any => ({ ...obj, }); @@ -594,6 +666,9 @@ export interface ParallelDataDataLocation { } export namespace ParallelDataDataLocation { + /** + * @internal + */ export const filterSensitiveLog = (obj: ParallelDataDataLocation): any => ({ ...obj, }); @@ -697,6 +772,9 @@ export interface ParallelDataProperties { } export namespace ParallelDataProperties { + /** + * @internal + */ export const filterSensitiveLog = (obj: ParallelDataProperties): any => ({ ...obj, }); @@ -733,6 +811,9 @@ export interface GetParallelDataResponse { } export namespace GetParallelDataResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetParallelDataResponse): any => ({ ...obj, }); @@ -756,6 +837,9 @@ export interface GetTerminologyRequest { } export namespace GetTerminologyRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetTerminologyRequest): any => ({ ...obj, }); @@ -777,6 +861,9 @@ export interface TerminologyDataLocation { } export namespace TerminologyDataLocation { + /** + * @internal + */ export const filterSensitiveLog = (obj: TerminologyDataLocation): any => ({ ...obj, }); @@ -840,6 +927,9 @@ export interface TerminologyProperties { } export namespace TerminologyProperties { + /** + * @internal + */ export const filterSensitiveLog = (obj: TerminologyProperties): any => ({ ...obj, }); @@ -859,6 +949,9 @@ export interface GetTerminologyResponse { } export namespace GetTerminologyResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetTerminologyResponse): any => ({ ...obj, }); @@ -886,6 +979,9 @@ export interface TerminologyData { } export namespace TerminologyData { + /** + * @internal + */ export const filterSensitiveLog = (obj: TerminologyData): any => ({ ...obj, ...(obj.File && { File: SENSITIVE_STRING }), @@ -922,6 +1018,9 @@ export interface ImportTerminologyRequest { } export namespace ImportTerminologyRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ImportTerminologyRequest): any => ({ ...obj, ...(obj.TerminologyData && { TerminologyData: TerminologyData.filterSensitiveLog(obj.TerminologyData) }), @@ -936,6 +1035,9 @@ export interface ImportTerminologyResponse { } export namespace ImportTerminologyResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ImportTerminologyResponse): any => ({ ...obj, }); @@ -954,6 +1056,9 @@ export interface ListParallelDataRequest { } export namespace ListParallelDataRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListParallelDataRequest): any => ({ ...obj, }); @@ -973,6 +1078,9 @@ export interface ListParallelDataResponse { } export namespace ListParallelDataResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListParallelDataResponse): any => ({ ...obj, }); @@ -992,6 +1100,9 @@ export interface ListTerminologiesRequest { } export namespace ListTerminologiesRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListTerminologiesRequest): any => ({ ...obj, }); @@ -1011,6 +1122,9 @@ export interface ListTerminologiesResponse { } export namespace ListTerminologiesResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListTerminologiesResponse): any => ({ ...obj, }); @@ -1026,6 +1140,9 @@ export interface InvalidFilterException extends __SmithyException, $MetadataBear } export namespace InvalidFilterException { + /** + * @internal + */ export const filterSensitiveLog = (obj: InvalidFilterException): any => ({ ...obj, }); @@ -1062,6 +1179,9 @@ export interface TextTranslationJobFilter { } export namespace TextTranslationJobFilter { + /** + * @internal + */ export const filterSensitiveLog = (obj: TextTranslationJobFilter): any => ({ ...obj, }); @@ -1086,6 +1206,9 @@ export interface ListTextTranslationJobsRequest { } export namespace ListTextTranslationJobsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListTextTranslationJobsRequest): any => ({ ...obj, }); @@ -1105,6 +1228,9 @@ export interface ListTextTranslationJobsResponse { } export namespace ListTextTranslationJobsResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListTextTranslationJobsResponse): any => ({ ...obj, }); @@ -1167,6 +1293,9 @@ export interface StartTextTranslationJobRequest { } export namespace StartTextTranslationJobRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: StartTextTranslationJobRequest): any => ({ ...obj, }); @@ -1220,6 +1349,9 @@ export interface StartTextTranslationJobResponse { } export namespace StartTextTranslationJobResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: StartTextTranslationJobResponse): any => ({ ...obj, }); @@ -1245,6 +1377,9 @@ export interface UnsupportedLanguagePairException extends __SmithyException, $Me } export namespace UnsupportedLanguagePairException { + /** + * @internal + */ export const filterSensitiveLog = (obj: UnsupportedLanguagePairException): any => ({ ...obj, }); @@ -1258,6 +1393,9 @@ export interface StopTextTranslationJobRequest { } export namespace StopTextTranslationJobRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: StopTextTranslationJobRequest): any => ({ ...obj, }); @@ -1277,6 +1415,9 @@ export interface StopTextTranslationJobResponse { } export namespace StopTextTranslationJobResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: StopTextTranslationJobResponse): any => ({ ...obj, }); @@ -1299,6 +1440,9 @@ export interface DetectedLanguageLowConfidenceException extends __SmithyExceptio } export namespace DetectedLanguageLowConfidenceException { + /** + * @internal + */ export const filterSensitiveLog = (obj: DetectedLanguageLowConfidenceException): any => ({ ...obj, }); @@ -1315,6 +1459,9 @@ export interface ServiceUnavailableException extends __SmithyException, $Metadat } export namespace ServiceUnavailableException { + /** + * @internal + */ export const filterSensitiveLog = (obj: ServiceUnavailableException): any => ({ ...obj, }); @@ -1331,6 +1478,9 @@ export interface TextSizeLimitExceededException extends __SmithyException, $Meta } export namespace TextSizeLimitExceededException { + /** + * @internal + */ export const filterSensitiveLog = (obj: TextSizeLimitExceededException): any => ({ ...obj, }); @@ -1368,6 +1518,9 @@ export interface TranslateTextRequest { } export namespace TranslateTextRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: TranslateTextRequest): any => ({ ...obj, }); @@ -1397,6 +1550,9 @@ export interface TranslateTextResponse { } export namespace TranslateTextResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: TranslateTextResponse): any => ({ ...obj, }); @@ -1426,6 +1582,9 @@ export interface UpdateParallelDataRequest { } export namespace UpdateParallelDataRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateParallelDataRequest): any => ({ ...obj, }); @@ -1457,6 +1616,9 @@ export interface UpdateParallelDataResponse { } export namespace UpdateParallelDataResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateParallelDataResponse): any => ({ ...obj, }); diff --git a/clients/client-waf-regional/commands/AssociateWebACLCommand.ts b/clients/client-waf-regional/commands/AssociateWebACLCommand.ts index cca4178b6200..f868ad1908fb 100644 --- a/clients/client-waf-regional/commands/AssociateWebACLCommand.ts +++ b/clients/client-waf-regional/commands/AssociateWebACLCommand.ts @@ -30,6 +30,20 @@ export interface AssociateWebACLCommandOutput extends AssociateWebACLResponse, _ * 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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { WAFRegionalClient, AssociateWebACLCommand } from "@aws-sdk/client-waf-regional"; // ES Modules import + * // const { WAFRegionalClient, AssociateWebACLCommand } = require("@aws-sdk/client-waf-regional"); // CommonJS import + * const client = new WAFRegionalClient(config); + * const command = new AssociateWebACLCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link AssociateWebACLCommandInput} for command's `input` shape. + * @see {@link AssociateWebACLCommandOutput} for command's `response` shape. + * @see {@link WAFRegionalClientResolvedConfig | config} for command's `input` shape. + * */ export class AssociateWebACLCommand extends $Command< AssociateWebACLCommandInput, diff --git a/clients/client-waf-regional/commands/CreateByteMatchSetCommand.ts b/clients/client-waf-regional/commands/CreateByteMatchSetCommand.ts index c0621a863cc3..8090f04a763e 100644 --- a/clients/client-waf-regional/commands/CreateByteMatchSetCommand.ts +++ b/clients/client-waf-regional/commands/CreateByteMatchSetCommand.ts @@ -53,6 +53,20 @@ export interface CreateByteMatchSetCommandOutput extends CreateByteMatchSetRespo * *

For more information about how to use the AWS WAF API to allow or block HTTP requests, see the * AWS WAF Developer Guide.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { WAFRegionalClient, CreateByteMatchSetCommand } from "@aws-sdk/client-waf-regional"; // ES Modules import + * // const { WAFRegionalClient, CreateByteMatchSetCommand } = require("@aws-sdk/client-waf-regional"); // CommonJS import + * const client = new WAFRegionalClient(config); + * const command = new CreateByteMatchSetCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreateByteMatchSetCommandInput} for command's `input` shape. + * @see {@link CreateByteMatchSetCommandOutput} for command's `response` shape. + * @see {@link WAFRegionalClientResolvedConfig | config} for command's `input` shape. + * */ export class CreateByteMatchSetCommand extends $Command< CreateByteMatchSetCommandInput, diff --git a/clients/client-waf-regional/commands/CreateGeoMatchSetCommand.ts b/clients/client-waf-regional/commands/CreateGeoMatchSetCommand.ts index 465209aaae22..c58fee2494b0 100644 --- a/clients/client-waf-regional/commands/CreateGeoMatchSetCommand.ts +++ b/clients/client-waf-regional/commands/CreateGeoMatchSetCommand.ts @@ -50,6 +50,20 @@ export interface CreateGeoMatchSetCommandOutput extends CreateGeoMatchSetRespons * *

For more information about how to use the AWS WAF API to allow or block HTTP requests, see the * AWS WAF Developer Guide.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { WAFRegionalClient, CreateGeoMatchSetCommand } from "@aws-sdk/client-waf-regional"; // ES Modules import + * // const { WAFRegionalClient, CreateGeoMatchSetCommand } = require("@aws-sdk/client-waf-regional"); // CommonJS import + * const client = new WAFRegionalClient(config); + * const command = new CreateGeoMatchSetCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreateGeoMatchSetCommandInput} for command's `input` shape. + * @see {@link CreateGeoMatchSetCommandOutput} for command's `response` shape. + * @see {@link WAFRegionalClientResolvedConfig | config} for command's `input` shape. + * */ export class CreateGeoMatchSetCommand extends $Command< CreateGeoMatchSetCommandInput, diff --git a/clients/client-waf-regional/commands/CreateIPSetCommand.ts b/clients/client-waf-regional/commands/CreateIPSetCommand.ts index a2554bcd26b2..048125687886 100644 --- a/clients/client-waf-regional/commands/CreateIPSetCommand.ts +++ b/clients/client-waf-regional/commands/CreateIPSetCommand.ts @@ -55,6 +55,20 @@ export interface CreateIPSetCommandOutput extends CreateIPSetResponse, __Metadat * *

For more information about how to use the AWS WAF API to allow or block HTTP requests, see the * AWS WAF Developer Guide.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { WAFRegionalClient, CreateIPSetCommand } from "@aws-sdk/client-waf-regional"; // ES Modules import + * // const { WAFRegionalClient, CreateIPSetCommand } = require("@aws-sdk/client-waf-regional"); // CommonJS import + * const client = new WAFRegionalClient(config); + * const command = new CreateIPSetCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreateIPSetCommandInput} for command's `input` shape. + * @see {@link CreateIPSetCommandOutput} for command's `response` shape. + * @see {@link WAFRegionalClientResolvedConfig | config} for command's `input` shape. + * */ export class CreateIPSetCommand extends $Command< CreateIPSetCommandInput, diff --git a/clients/client-waf-regional/commands/CreateRateBasedRuleCommand.ts b/clients/client-waf-regional/commands/CreateRateBasedRuleCommand.ts index 07506243c344..5ae86485d9e7 100644 --- a/clients/client-waf-regional/commands/CreateRateBasedRuleCommand.ts +++ b/clients/client-waf-regional/commands/CreateRateBasedRuleCommand.ts @@ -115,6 +115,20 @@ export interface CreateRateBasedRuleCommandOutput extends CreateRateBasedRuleRes *

For more information about how to use the AWS WAF API to allow or block HTTP requests, * see the AWS WAF Developer * Guide.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { WAFRegionalClient, CreateRateBasedRuleCommand } from "@aws-sdk/client-waf-regional"; // ES Modules import + * // const { WAFRegionalClient, CreateRateBasedRuleCommand } = require("@aws-sdk/client-waf-regional"); // CommonJS import + * const client = new WAFRegionalClient(config); + * const command = new CreateRateBasedRuleCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreateRateBasedRuleCommandInput} for command's `input` shape. + * @see {@link CreateRateBasedRuleCommandOutput} for command's `response` shape. + * @see {@link WAFRegionalClientResolvedConfig | config} for command's `input` shape. + * */ export class CreateRateBasedRuleCommand extends $Command< CreateRateBasedRuleCommandInput, diff --git a/clients/client-waf-regional/commands/CreateRegexMatchSetCommand.ts b/clients/client-waf-regional/commands/CreateRegexMatchSetCommand.ts index 09efd0c72186..aab6a6e17c71 100644 --- a/clients/client-waf-regional/commands/CreateRegexMatchSetCommand.ts +++ b/clients/client-waf-regional/commands/CreateRegexMatchSetCommand.ts @@ -53,6 +53,20 @@ export interface CreateRegexMatchSetCommandOutput extends CreateRegexMatchSetRes * *

For more information about how to use the AWS WAF API to allow or block HTTP requests, see the * AWS WAF Developer Guide.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { WAFRegionalClient, CreateRegexMatchSetCommand } from "@aws-sdk/client-waf-regional"; // ES Modules import + * // const { WAFRegionalClient, CreateRegexMatchSetCommand } = require("@aws-sdk/client-waf-regional"); // CommonJS import + * const client = new WAFRegionalClient(config); + * const command = new CreateRegexMatchSetCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreateRegexMatchSetCommandInput} for command's `input` shape. + * @see {@link CreateRegexMatchSetCommandOutput} for command's `response` shape. + * @see {@link WAFRegionalClientResolvedConfig | config} for command's `input` shape. + * */ export class CreateRegexMatchSetCommand extends $Command< CreateRegexMatchSetCommandInput, diff --git a/clients/client-waf-regional/commands/CreateRegexPatternSetCommand.ts b/clients/client-waf-regional/commands/CreateRegexPatternSetCommand.ts index 284ac5ca14c6..e3975e3eebb2 100644 --- a/clients/client-waf-regional/commands/CreateRegexPatternSetCommand.ts +++ b/clients/client-waf-regional/commands/CreateRegexPatternSetCommand.ts @@ -49,6 +49,20 @@ export interface CreateRegexPatternSetCommandOutput extends CreateRegexPatternSe * *

For more information about how to use the AWS WAF API to allow or block HTTP requests, see the * AWS WAF Developer Guide.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { WAFRegionalClient, CreateRegexPatternSetCommand } from "@aws-sdk/client-waf-regional"; // ES Modules import + * // const { WAFRegionalClient, CreateRegexPatternSetCommand } = require("@aws-sdk/client-waf-regional"); // CommonJS import + * const client = new WAFRegionalClient(config); + * const command = new CreateRegexPatternSetCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreateRegexPatternSetCommandInput} for command's `input` shape. + * @see {@link CreateRegexPatternSetCommandOutput} for command's `response` shape. + * @see {@link WAFRegionalClientResolvedConfig | config} for command's `input` shape. + * */ export class CreateRegexPatternSetCommand extends $Command< CreateRegexPatternSetCommandInput, diff --git a/clients/client-waf-regional/commands/CreateRuleCommand.ts b/clients/client-waf-regional/commands/CreateRuleCommand.ts index d28634e704b5..980cd1f6d081 100644 --- a/clients/client-waf-regional/commands/CreateRuleCommand.ts +++ b/clients/client-waf-regional/commands/CreateRuleCommand.ts @@ -73,6 +73,20 @@ export interface CreateRuleCommandOutput extends CreateRuleResponse, __MetadataB * *

For more information about how to use the AWS WAF API to allow or block HTTP requests, see the * AWS WAF Developer Guide.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { WAFRegionalClient, CreateRuleCommand } from "@aws-sdk/client-waf-regional"; // ES Modules import + * // const { WAFRegionalClient, CreateRuleCommand } = require("@aws-sdk/client-waf-regional"); // CommonJS import + * const client = new WAFRegionalClient(config); + * const command = new CreateRuleCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreateRuleCommandInput} for command's `input` shape. + * @see {@link CreateRuleCommandOutput} for command's `response` shape. + * @see {@link WAFRegionalClientResolvedConfig | config} for command's `input` shape. + * */ export class CreateRuleCommand extends $Command< CreateRuleCommandInput, diff --git a/clients/client-waf-regional/commands/CreateRuleGroupCommand.ts b/clients/client-waf-regional/commands/CreateRuleGroupCommand.ts index b7a8dc3eee95..39efab3a7e41 100644 --- a/clients/client-waf-regional/commands/CreateRuleGroupCommand.ts +++ b/clients/client-waf-regional/commands/CreateRuleGroupCommand.ts @@ -44,6 +44,20 @@ export interface CreateRuleGroupCommandOutput extends CreateRuleGroupResponse, _ * *

For more information about how to use the AWS WAF API to allow or block HTTP requests, see the * AWS WAF Developer Guide.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { WAFRegionalClient, CreateRuleGroupCommand } from "@aws-sdk/client-waf-regional"; // ES Modules import + * // const { WAFRegionalClient, CreateRuleGroupCommand } = require("@aws-sdk/client-waf-regional"); // CommonJS import + * const client = new WAFRegionalClient(config); + * const command = new CreateRuleGroupCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreateRuleGroupCommandInput} for command's `input` shape. + * @see {@link CreateRuleGroupCommandOutput} for command's `response` shape. + * @see {@link WAFRegionalClientResolvedConfig | config} for command's `input` shape. + * */ export class CreateRuleGroupCommand extends $Command< CreateRuleGroupCommandInput, diff --git a/clients/client-waf-regional/commands/CreateSizeConstraintSetCommand.ts b/clients/client-waf-regional/commands/CreateSizeConstraintSetCommand.ts index 49271b57938f..f24c17d133ce 100644 --- a/clients/client-waf-regional/commands/CreateSizeConstraintSetCommand.ts +++ b/clients/client-waf-regional/commands/CreateSizeConstraintSetCommand.ts @@ -53,6 +53,20 @@ export interface CreateSizeConstraintSetCommandOutput extends CreateSizeConstrai * *

For more information about how to use the AWS WAF API to allow or block HTTP requests, see the * AWS WAF Developer Guide.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { WAFRegionalClient, CreateSizeConstraintSetCommand } from "@aws-sdk/client-waf-regional"; // ES Modules import + * // const { WAFRegionalClient, CreateSizeConstraintSetCommand } = require("@aws-sdk/client-waf-regional"); // CommonJS import + * const client = new WAFRegionalClient(config); + * const command = new CreateSizeConstraintSetCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreateSizeConstraintSetCommandInput} for command's `input` shape. + * @see {@link CreateSizeConstraintSetCommandOutput} for command's `response` shape. + * @see {@link WAFRegionalClientResolvedConfig | config} for command's `input` shape. + * */ export class CreateSizeConstraintSetCommand extends $Command< CreateSizeConstraintSetCommandInput, diff --git a/clients/client-waf-regional/commands/CreateSqlInjectionMatchSetCommand.ts b/clients/client-waf-regional/commands/CreateSqlInjectionMatchSetCommand.ts index 1072ca09f16f..23847b6b09b1 100644 --- a/clients/client-waf-regional/commands/CreateSqlInjectionMatchSetCommand.ts +++ b/clients/client-waf-regional/commands/CreateSqlInjectionMatchSetCommand.ts @@ -51,6 +51,20 @@ export interface CreateSqlInjectionMatchSetCommandOutput extends CreateSqlInject * *

For more information about how to use the AWS WAF API to allow or block HTTP requests, see the * AWS WAF Developer Guide.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { WAFRegionalClient, CreateSqlInjectionMatchSetCommand } from "@aws-sdk/client-waf-regional"; // ES Modules import + * // const { WAFRegionalClient, CreateSqlInjectionMatchSetCommand } = require("@aws-sdk/client-waf-regional"); // CommonJS import + * const client = new WAFRegionalClient(config); + * const command = new CreateSqlInjectionMatchSetCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreateSqlInjectionMatchSetCommandInput} for command's `input` shape. + * @see {@link CreateSqlInjectionMatchSetCommandOutput} for command's `response` shape. + * @see {@link WAFRegionalClientResolvedConfig | config} for command's `input` shape. + * */ export class CreateSqlInjectionMatchSetCommand extends $Command< CreateSqlInjectionMatchSetCommandInput, diff --git a/clients/client-waf-regional/commands/CreateWebACLCommand.ts b/clients/client-waf-regional/commands/CreateWebACLCommand.ts index 38b08b34e311..22bed29a8583 100644 --- a/clients/client-waf-regional/commands/CreateWebACLCommand.ts +++ b/clients/client-waf-regional/commands/CreateWebACLCommand.ts @@ -61,6 +61,20 @@ export interface CreateWebACLCommandOutput extends CreateWebACLResponse, __Metad * * *

For more information about how to use the AWS WAF API, see the AWS WAF Developer Guide.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { WAFRegionalClient, CreateWebACLCommand } from "@aws-sdk/client-waf-regional"; // ES Modules import + * // const { WAFRegionalClient, CreateWebACLCommand } = require("@aws-sdk/client-waf-regional"); // CommonJS import + * const client = new WAFRegionalClient(config); + * const command = new CreateWebACLCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreateWebACLCommandInput} for command's `input` shape. + * @see {@link CreateWebACLCommandOutput} for command's `response` shape. + * @see {@link WAFRegionalClientResolvedConfig | config} for command's `input` shape. + * */ export class CreateWebACLCommand extends $Command< CreateWebACLCommandInput, diff --git a/clients/client-waf-regional/commands/CreateWebACLMigrationStackCommand.ts b/clients/client-waf-regional/commands/CreateWebACLMigrationStackCommand.ts index 55730b730efc..7e8fdab79c1a 100644 --- a/clients/client-waf-regional/commands/CreateWebACLMigrationStackCommand.ts +++ b/clients/client-waf-regional/commands/CreateWebACLMigrationStackCommand.ts @@ -29,6 +29,20 @@ export interface CreateWebACLMigrationStackCommandOutput extends CreateWebACLMig * 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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { WAFRegionalClient, CreateWebACLMigrationStackCommand } from "@aws-sdk/client-waf-regional"; // ES Modules import + * // const { WAFRegionalClient, CreateWebACLMigrationStackCommand } = require("@aws-sdk/client-waf-regional"); // CommonJS import + * const client = new WAFRegionalClient(config); + * const command = new CreateWebACLMigrationStackCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreateWebACLMigrationStackCommandInput} for command's `input` shape. + * @see {@link CreateWebACLMigrationStackCommandOutput} for command's `response` shape. + * @see {@link WAFRegionalClientResolvedConfig | config} for command's `input` shape. + * */ export class CreateWebACLMigrationStackCommand extends $Command< CreateWebACLMigrationStackCommandInput, diff --git a/clients/client-waf-regional/commands/CreateXssMatchSetCommand.ts b/clients/client-waf-regional/commands/CreateXssMatchSetCommand.ts index 16ab21cdb47b..c1af158723a7 100644 --- a/clients/client-waf-regional/commands/CreateXssMatchSetCommand.ts +++ b/clients/client-waf-regional/commands/CreateXssMatchSetCommand.ts @@ -51,6 +51,20 @@ export interface CreateXssMatchSetCommandOutput extends CreateXssMatchSetRespons * *

For more information about how to use the AWS WAF API to allow or block HTTP requests, see the * AWS WAF Developer Guide.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { WAFRegionalClient, CreateXssMatchSetCommand } from "@aws-sdk/client-waf-regional"; // ES Modules import + * // const { WAFRegionalClient, CreateXssMatchSetCommand } = require("@aws-sdk/client-waf-regional"); // CommonJS import + * const client = new WAFRegionalClient(config); + * const command = new CreateXssMatchSetCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreateXssMatchSetCommandInput} for command's `input` shape. + * @see {@link CreateXssMatchSetCommandOutput} for command's `response` shape. + * @see {@link WAFRegionalClientResolvedConfig | config} for command's `input` shape. + * */ export class CreateXssMatchSetCommand extends $Command< CreateXssMatchSetCommandInput, diff --git a/clients/client-waf-regional/commands/DeleteByteMatchSetCommand.ts b/clients/client-waf-regional/commands/DeleteByteMatchSetCommand.ts index a725680bcfe8..20a81e0c7541 100644 --- a/clients/client-waf-regional/commands/DeleteByteMatchSetCommand.ts +++ b/clients/client-waf-regional/commands/DeleteByteMatchSetCommand.ts @@ -45,6 +45,20 @@ export interface DeleteByteMatchSetCommandOutput extends DeleteByteMatchSetRespo *

Submit a DeleteByteMatchSet request.

* * + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { WAFRegionalClient, DeleteByteMatchSetCommand } from "@aws-sdk/client-waf-regional"; // ES Modules import + * // const { WAFRegionalClient, DeleteByteMatchSetCommand } = require("@aws-sdk/client-waf-regional"); // CommonJS import + * const client = new WAFRegionalClient(config); + * const command = new DeleteByteMatchSetCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteByteMatchSetCommandInput} for command's `input` shape. + * @see {@link DeleteByteMatchSetCommandOutput} for command's `response` shape. + * @see {@link WAFRegionalClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteByteMatchSetCommand extends $Command< DeleteByteMatchSetCommandInput, diff --git a/clients/client-waf-regional/commands/DeleteGeoMatchSetCommand.ts b/clients/client-waf-regional/commands/DeleteGeoMatchSetCommand.ts index 7c268dbb0d42..e3e041682c86 100644 --- a/clients/client-waf-regional/commands/DeleteGeoMatchSetCommand.ts +++ b/clients/client-waf-regional/commands/DeleteGeoMatchSetCommand.ts @@ -45,6 +45,20 @@ export interface DeleteGeoMatchSetCommandOutput extends DeleteGeoMatchSetRespons *

Submit a DeleteGeoMatchSet request.

* * + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { WAFRegionalClient, DeleteGeoMatchSetCommand } from "@aws-sdk/client-waf-regional"; // ES Modules import + * // const { WAFRegionalClient, DeleteGeoMatchSetCommand } = require("@aws-sdk/client-waf-regional"); // CommonJS import + * const client = new WAFRegionalClient(config); + * const command = new DeleteGeoMatchSetCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteGeoMatchSetCommandInput} for command's `input` shape. + * @see {@link DeleteGeoMatchSetCommandOutput} for command's `response` shape. + * @see {@link WAFRegionalClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteGeoMatchSetCommand extends $Command< DeleteGeoMatchSetCommandInput, diff --git a/clients/client-waf-regional/commands/DeleteIPSetCommand.ts b/clients/client-waf-regional/commands/DeleteIPSetCommand.ts index d28f89180c31..6efe2750090c 100644 --- a/clients/client-waf-regional/commands/DeleteIPSetCommand.ts +++ b/clients/client-waf-regional/commands/DeleteIPSetCommand.ts @@ -45,6 +45,20 @@ export interface DeleteIPSetCommandOutput extends DeleteIPSetResponse, __Metadat *

Submit a DeleteIPSet request.

* * + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { WAFRegionalClient, DeleteIPSetCommand } from "@aws-sdk/client-waf-regional"; // ES Modules import + * // const { WAFRegionalClient, DeleteIPSetCommand } = require("@aws-sdk/client-waf-regional"); // CommonJS import + * const client = new WAFRegionalClient(config); + * const command = new DeleteIPSetCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteIPSetCommandInput} for command's `input` shape. + * @see {@link DeleteIPSetCommandOutput} for command's `response` shape. + * @see {@link WAFRegionalClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteIPSetCommand extends $Command< DeleteIPSetCommandInput, diff --git a/clients/client-waf-regional/commands/DeleteLoggingConfigurationCommand.ts b/clients/client-waf-regional/commands/DeleteLoggingConfigurationCommand.ts index 87eaa8d24b0e..e681f80bbf0e 100644 --- a/clients/client-waf-regional/commands/DeleteLoggingConfigurationCommand.ts +++ b/clients/client-waf-regional/commands/DeleteLoggingConfigurationCommand.ts @@ -31,6 +31,20 @@ export interface DeleteLoggingConfigurationCommandOutput extends DeleteLoggingCo * *

Permanently deletes the LoggingConfiguration from the specified web * ACL.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { WAFRegionalClient, DeleteLoggingConfigurationCommand } from "@aws-sdk/client-waf-regional"; // ES Modules import + * // const { WAFRegionalClient, DeleteLoggingConfigurationCommand } = require("@aws-sdk/client-waf-regional"); // CommonJS import + * const client = new WAFRegionalClient(config); + * const command = new DeleteLoggingConfigurationCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteLoggingConfigurationCommandInput} for command's `input` shape. + * @see {@link DeleteLoggingConfigurationCommandOutput} for command's `response` shape. + * @see {@link WAFRegionalClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteLoggingConfigurationCommand extends $Command< DeleteLoggingConfigurationCommandInput, diff --git a/clients/client-waf-regional/commands/DeletePermissionPolicyCommand.ts b/clients/client-waf-regional/commands/DeletePermissionPolicyCommand.ts index 6d977abe7ec6..c92bb802eb02 100644 --- a/clients/client-waf-regional/commands/DeletePermissionPolicyCommand.ts +++ b/clients/client-waf-regional/commands/DeletePermissionPolicyCommand.ts @@ -31,6 +31,20 @@ export interface DeletePermissionPolicyCommandOutput extends DeletePermissionPol * *

Permanently deletes an IAM policy from the specified RuleGroup.

*

The user making the request must be the owner of the RuleGroup.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { WAFRegionalClient, DeletePermissionPolicyCommand } from "@aws-sdk/client-waf-regional"; // ES Modules import + * // const { WAFRegionalClient, DeletePermissionPolicyCommand } = require("@aws-sdk/client-waf-regional"); // CommonJS import + * const client = new WAFRegionalClient(config); + * const command = new DeletePermissionPolicyCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeletePermissionPolicyCommandInput} for command's `input` shape. + * @see {@link DeletePermissionPolicyCommandOutput} for command's `response` shape. + * @see {@link WAFRegionalClientResolvedConfig | config} for command's `input` shape. + * */ export class DeletePermissionPolicyCommand extends $Command< DeletePermissionPolicyCommandInput, diff --git a/clients/client-waf-regional/commands/DeleteRateBasedRuleCommand.ts b/clients/client-waf-regional/commands/DeleteRateBasedRuleCommand.ts index ab4e74f8fa77..5cc633a378c9 100644 --- a/clients/client-waf-regional/commands/DeleteRateBasedRuleCommand.ts +++ b/clients/client-waf-regional/commands/DeleteRateBasedRuleCommand.ts @@ -49,6 +49,20 @@ export interface DeleteRateBasedRuleCommandOutput extends DeleteRateBasedRuleRes *

Submit a DeleteRateBasedRule request.

* * + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { WAFRegionalClient, DeleteRateBasedRuleCommand } from "@aws-sdk/client-waf-regional"; // ES Modules import + * // const { WAFRegionalClient, DeleteRateBasedRuleCommand } = require("@aws-sdk/client-waf-regional"); // CommonJS import + * const client = new WAFRegionalClient(config); + * const command = new DeleteRateBasedRuleCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteRateBasedRuleCommandInput} for command's `input` shape. + * @see {@link DeleteRateBasedRuleCommandOutput} for command's `response` shape. + * @see {@link WAFRegionalClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteRateBasedRuleCommand extends $Command< DeleteRateBasedRuleCommandInput, diff --git a/clients/client-waf-regional/commands/DeleteRegexMatchSetCommand.ts b/clients/client-waf-regional/commands/DeleteRegexMatchSetCommand.ts index ef74549aaa2b..aeee33c96349 100644 --- a/clients/client-waf-regional/commands/DeleteRegexMatchSetCommand.ts +++ b/clients/client-waf-regional/commands/DeleteRegexMatchSetCommand.ts @@ -45,6 +45,20 @@ export interface DeleteRegexMatchSetCommandOutput extends DeleteRegexMatchSetRes *

Submit a DeleteRegexMatchSet request.

* * + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { WAFRegionalClient, DeleteRegexMatchSetCommand } from "@aws-sdk/client-waf-regional"; // ES Modules import + * // const { WAFRegionalClient, DeleteRegexMatchSetCommand } = require("@aws-sdk/client-waf-regional"); // CommonJS import + * const client = new WAFRegionalClient(config); + * const command = new DeleteRegexMatchSetCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteRegexMatchSetCommandInput} for command's `input` shape. + * @see {@link DeleteRegexMatchSetCommandOutput} for command's `response` shape. + * @see {@link WAFRegionalClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteRegexMatchSetCommand extends $Command< DeleteRegexMatchSetCommandInput, diff --git a/clients/client-waf-regional/commands/DeleteRegexPatternSetCommand.ts b/clients/client-waf-regional/commands/DeleteRegexPatternSetCommand.ts index 720e82433131..3b25b684d863 100644 --- a/clients/client-waf-regional/commands/DeleteRegexPatternSetCommand.ts +++ b/clients/client-waf-regional/commands/DeleteRegexPatternSetCommand.ts @@ -31,6 +31,20 @@ export interface DeleteRegexPatternSetCommandOutput extends DeleteRegexPatternSe * *

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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { WAFRegionalClient, DeleteRegexPatternSetCommand } from "@aws-sdk/client-waf-regional"; // ES Modules import + * // const { WAFRegionalClient, DeleteRegexPatternSetCommand } = require("@aws-sdk/client-waf-regional"); // CommonJS import + * const client = new WAFRegionalClient(config); + * const command = new DeleteRegexPatternSetCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteRegexPatternSetCommandInput} for command's `input` shape. + * @see {@link DeleteRegexPatternSetCommandOutput} for command's `response` shape. + * @see {@link WAFRegionalClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteRegexPatternSetCommand extends $Command< DeleteRegexPatternSetCommandInput, diff --git a/clients/client-waf-regional/commands/DeleteRuleCommand.ts b/clients/client-waf-regional/commands/DeleteRuleCommand.ts index 73e873f1a91e..76fafb285fc2 100644 --- a/clients/client-waf-regional/commands/DeleteRuleCommand.ts +++ b/clients/client-waf-regional/commands/DeleteRuleCommand.ts @@ -45,6 +45,20 @@ export interface DeleteRuleCommandOutput extends DeleteRuleResponse, __MetadataB *

Submit a DeleteRule request.

* * + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { WAFRegionalClient, DeleteRuleCommand } from "@aws-sdk/client-waf-regional"; // ES Modules import + * // const { WAFRegionalClient, DeleteRuleCommand } = require("@aws-sdk/client-waf-regional"); // CommonJS import + * const client = new WAFRegionalClient(config); + * const command = new DeleteRuleCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteRuleCommandInput} for command's `input` shape. + * @see {@link DeleteRuleCommandOutput} for command's `response` shape. + * @see {@link WAFRegionalClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteRuleCommand extends $Command< DeleteRuleCommandInput, diff --git a/clients/client-waf-regional/commands/DeleteRuleGroupCommand.ts b/clients/client-waf-regional/commands/DeleteRuleGroupCommand.ts index 62ff63b0a61f..1118440c6dd1 100644 --- a/clients/client-waf-regional/commands/DeleteRuleGroupCommand.ts +++ b/clients/client-waf-regional/commands/DeleteRuleGroupCommand.ts @@ -45,6 +45,20 @@ export interface DeleteRuleGroupCommandOutput extends DeleteRuleGroupResponse, _ *

Submit a DeleteRuleGroup request.

* * + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { WAFRegionalClient, DeleteRuleGroupCommand } from "@aws-sdk/client-waf-regional"; // ES Modules import + * // const { WAFRegionalClient, DeleteRuleGroupCommand } = require("@aws-sdk/client-waf-regional"); // CommonJS import + * const client = new WAFRegionalClient(config); + * const command = new DeleteRuleGroupCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteRuleGroupCommandInput} for command's `input` shape. + * @see {@link DeleteRuleGroupCommandOutput} for command's `response` shape. + * @see {@link WAFRegionalClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteRuleGroupCommand extends $Command< DeleteRuleGroupCommandInput, diff --git a/clients/client-waf-regional/commands/DeleteSizeConstraintSetCommand.ts b/clients/client-waf-regional/commands/DeleteSizeConstraintSetCommand.ts index 3bd9e66ff7b4..8fd887ea489c 100644 --- a/clients/client-waf-regional/commands/DeleteSizeConstraintSetCommand.ts +++ b/clients/client-waf-regional/commands/DeleteSizeConstraintSetCommand.ts @@ -45,6 +45,20 @@ export interface DeleteSizeConstraintSetCommandOutput extends DeleteSizeConstrai *

Submit a DeleteSizeConstraintSet request.

* * + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { WAFRegionalClient, DeleteSizeConstraintSetCommand } from "@aws-sdk/client-waf-regional"; // ES Modules import + * // const { WAFRegionalClient, DeleteSizeConstraintSetCommand } = require("@aws-sdk/client-waf-regional"); // CommonJS import + * const client = new WAFRegionalClient(config); + * const command = new DeleteSizeConstraintSetCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteSizeConstraintSetCommandInput} for command's `input` shape. + * @see {@link DeleteSizeConstraintSetCommandOutput} for command's `response` shape. + * @see {@link WAFRegionalClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteSizeConstraintSetCommand extends $Command< DeleteSizeConstraintSetCommandInput, diff --git a/clients/client-waf-regional/commands/DeleteSqlInjectionMatchSetCommand.ts b/clients/client-waf-regional/commands/DeleteSqlInjectionMatchSetCommand.ts index 812db91ed191..ac88b653c3ca 100644 --- a/clients/client-waf-regional/commands/DeleteSqlInjectionMatchSetCommand.ts +++ b/clients/client-waf-regional/commands/DeleteSqlInjectionMatchSetCommand.ts @@ -46,6 +46,20 @@ export interface DeleteSqlInjectionMatchSetCommandOutput extends DeleteSqlInject *

Submit a DeleteSqlInjectionMatchSet request.

* * + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { WAFRegionalClient, DeleteSqlInjectionMatchSetCommand } from "@aws-sdk/client-waf-regional"; // ES Modules import + * // const { WAFRegionalClient, DeleteSqlInjectionMatchSetCommand } = require("@aws-sdk/client-waf-regional"); // CommonJS import + * const client = new WAFRegionalClient(config); + * const command = new DeleteSqlInjectionMatchSetCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteSqlInjectionMatchSetCommandInput} for command's `input` shape. + * @see {@link DeleteSqlInjectionMatchSetCommandOutput} for command's `response` shape. + * @see {@link WAFRegionalClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteSqlInjectionMatchSetCommand extends $Command< DeleteSqlInjectionMatchSetCommandInput, diff --git a/clients/client-waf-regional/commands/DeleteWebACLCommand.ts b/clients/client-waf-regional/commands/DeleteWebACLCommand.ts index cc59cd070066..2751c651ae9d 100644 --- a/clients/client-waf-regional/commands/DeleteWebACLCommand.ts +++ b/clients/client-waf-regional/commands/DeleteWebACLCommand.ts @@ -43,6 +43,20 @@ export interface DeleteWebACLCommandOutput extends DeleteWebACLResponse, __Metad *

Submit a DeleteWebACL request.

* * + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { WAFRegionalClient, DeleteWebACLCommand } from "@aws-sdk/client-waf-regional"; // ES Modules import + * // const { WAFRegionalClient, DeleteWebACLCommand } = require("@aws-sdk/client-waf-regional"); // CommonJS import + * const client = new WAFRegionalClient(config); + * const command = new DeleteWebACLCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteWebACLCommandInput} for command's `input` shape. + * @see {@link DeleteWebACLCommandOutput} for command's `response` shape. + * @see {@link WAFRegionalClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteWebACLCommand extends $Command< DeleteWebACLCommandInput, diff --git a/clients/client-waf-regional/commands/DeleteXssMatchSetCommand.ts b/clients/client-waf-regional/commands/DeleteXssMatchSetCommand.ts index 18501684de0f..75177b7b84a6 100644 --- a/clients/client-waf-regional/commands/DeleteXssMatchSetCommand.ts +++ b/clients/client-waf-regional/commands/DeleteXssMatchSetCommand.ts @@ -46,6 +46,20 @@ export interface DeleteXssMatchSetCommandOutput extends DeleteXssMatchSetRespons *

Submit a DeleteXssMatchSet request.

* * + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { WAFRegionalClient, DeleteXssMatchSetCommand } from "@aws-sdk/client-waf-regional"; // ES Modules import + * // const { WAFRegionalClient, DeleteXssMatchSetCommand } = require("@aws-sdk/client-waf-regional"); // CommonJS import + * const client = new WAFRegionalClient(config); + * const command = new DeleteXssMatchSetCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteXssMatchSetCommandInput} for command's `input` shape. + * @see {@link DeleteXssMatchSetCommandOutput} for command's `response` shape. + * @see {@link WAFRegionalClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteXssMatchSetCommand extends $Command< DeleteXssMatchSetCommandInput, diff --git a/clients/client-waf-regional/commands/DisassociateWebACLCommand.ts b/clients/client-waf-regional/commands/DisassociateWebACLCommand.ts index 93feb56b5ce1..fedc60bd0b89 100644 --- a/clients/client-waf-regional/commands/DisassociateWebACLCommand.ts +++ b/clients/client-waf-regional/commands/DisassociateWebACLCommand.ts @@ -30,6 +30,20 @@ export interface DisassociateWebACLCommandOutput extends DisassociateWebACLRespo * 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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { WAFRegionalClient, DisassociateWebACLCommand } from "@aws-sdk/client-waf-regional"; // ES Modules import + * // const { WAFRegionalClient, DisassociateWebACLCommand } = require("@aws-sdk/client-waf-regional"); // CommonJS import + * const client = new WAFRegionalClient(config); + * const command = new DisassociateWebACLCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DisassociateWebACLCommandInput} for command's `input` shape. + * @see {@link DisassociateWebACLCommandOutput} for command's `response` shape. + * @see {@link WAFRegionalClientResolvedConfig | config} for command's `input` shape. + * */ export class DisassociateWebACLCommand extends $Command< DisassociateWebACLCommandInput, diff --git a/clients/client-waf-regional/commands/GetByteMatchSetCommand.ts b/clients/client-waf-regional/commands/GetByteMatchSetCommand.ts index a8e5f5bc09b7..6978e2526ff1 100644 --- a/clients/client-waf-regional/commands/GetByteMatchSetCommand.ts +++ b/clients/client-waf-regional/commands/GetByteMatchSetCommand.ts @@ -30,6 +30,20 @@ export interface GetByteMatchSetCommandOutput extends GetByteMatchSetResponse, _ * 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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { WAFRegionalClient, GetByteMatchSetCommand } from "@aws-sdk/client-waf-regional"; // ES Modules import + * // const { WAFRegionalClient, GetByteMatchSetCommand } = require("@aws-sdk/client-waf-regional"); // CommonJS import + * const client = new WAFRegionalClient(config); + * const command = new GetByteMatchSetCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetByteMatchSetCommandInput} for command's `input` shape. + * @see {@link GetByteMatchSetCommandOutput} for command's `response` shape. + * @see {@link WAFRegionalClientResolvedConfig | config} for command's `input` shape. + * */ export class GetByteMatchSetCommand extends $Command< GetByteMatchSetCommandInput, diff --git a/clients/client-waf-regional/commands/GetChangeTokenCommand.ts b/clients/client-waf-regional/commands/GetChangeTokenCommand.ts index 22b235295f28..ffb6ceb2c4cf 100644 --- a/clients/client-waf-regional/commands/GetChangeTokenCommand.ts +++ b/clients/client-waf-regional/commands/GetChangeTokenCommand.ts @@ -36,6 +36,20 @@ export interface GetChangeTokenCommandOutput extends GetChangeTokenResponse, __M *

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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { WAFRegionalClient, GetChangeTokenCommand } from "@aws-sdk/client-waf-regional"; // ES Modules import + * // const { WAFRegionalClient, GetChangeTokenCommand } = require("@aws-sdk/client-waf-regional"); // CommonJS import + * const client = new WAFRegionalClient(config); + * const command = new GetChangeTokenCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetChangeTokenCommandInput} for command's `input` shape. + * @see {@link GetChangeTokenCommandOutput} for command's `response` shape. + * @see {@link WAFRegionalClientResolvedConfig | config} for command's `input` shape. + * */ export class GetChangeTokenCommand extends $Command< GetChangeTokenCommandInput, diff --git a/clients/client-waf-regional/commands/GetChangeTokenStatusCommand.ts b/clients/client-waf-regional/commands/GetChangeTokenStatusCommand.ts index 118ab8d33d80..c9018eac7846 100644 --- a/clients/client-waf-regional/commands/GetChangeTokenStatusCommand.ts +++ b/clients/client-waf-regional/commands/GetChangeTokenStatusCommand.ts @@ -46,6 +46,20 @@ export interface GetChangeTokenStatusCommandOutput extends GetChangeTokenStatusR * INSYNC: Propagation is complete.

* * + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { WAFRegionalClient, GetChangeTokenStatusCommand } from "@aws-sdk/client-waf-regional"; // ES Modules import + * // const { WAFRegionalClient, GetChangeTokenStatusCommand } = require("@aws-sdk/client-waf-regional"); // CommonJS import + * const client = new WAFRegionalClient(config); + * const command = new GetChangeTokenStatusCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetChangeTokenStatusCommandInput} for command's `input` shape. + * @see {@link GetChangeTokenStatusCommandOutput} for command's `response` shape. + * @see {@link WAFRegionalClientResolvedConfig | config} for command's `input` shape. + * */ export class GetChangeTokenStatusCommand extends $Command< GetChangeTokenStatusCommandInput, diff --git a/clients/client-waf-regional/commands/GetGeoMatchSetCommand.ts b/clients/client-waf-regional/commands/GetGeoMatchSetCommand.ts index 433376e969fc..137e8618e7f4 100644 --- a/clients/client-waf-regional/commands/GetGeoMatchSetCommand.ts +++ b/clients/client-waf-regional/commands/GetGeoMatchSetCommand.ts @@ -30,6 +30,20 @@ export interface GetGeoMatchSetCommandOutput extends GetGeoMatchSetResponse, __M * 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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { WAFRegionalClient, GetGeoMatchSetCommand } from "@aws-sdk/client-waf-regional"; // ES Modules import + * // const { WAFRegionalClient, GetGeoMatchSetCommand } = require("@aws-sdk/client-waf-regional"); // CommonJS import + * const client = new WAFRegionalClient(config); + * const command = new GetGeoMatchSetCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetGeoMatchSetCommandInput} for command's `input` shape. + * @see {@link GetGeoMatchSetCommandOutput} for command's `response` shape. + * @see {@link WAFRegionalClientResolvedConfig | config} for command's `input` shape. + * */ export class GetGeoMatchSetCommand extends $Command< GetGeoMatchSetCommandInput, diff --git a/clients/client-waf-regional/commands/GetIPSetCommand.ts b/clients/client-waf-regional/commands/GetIPSetCommand.ts index 3374f804cb14..e30002294517 100644 --- a/clients/client-waf-regional/commands/GetIPSetCommand.ts +++ b/clients/client-waf-regional/commands/GetIPSetCommand.ts @@ -27,6 +27,20 @@ export interface GetIPSetCommandOutput extends GetIPSetResponse, __MetadataBeare * 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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { WAFRegionalClient, GetIPSetCommand } from "@aws-sdk/client-waf-regional"; // ES Modules import + * // const { WAFRegionalClient, GetIPSetCommand } = require("@aws-sdk/client-waf-regional"); // CommonJS import + * const client = new WAFRegionalClient(config); + * const command = new GetIPSetCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetIPSetCommandInput} for command's `input` shape. + * @see {@link GetIPSetCommandOutput} for command's `response` shape. + * @see {@link WAFRegionalClientResolvedConfig | config} for command's `input` shape. + * */ export class GetIPSetCommand extends $Command< GetIPSetCommandInput, diff --git a/clients/client-waf-regional/commands/GetLoggingConfigurationCommand.ts b/clients/client-waf-regional/commands/GetLoggingConfigurationCommand.ts index fc4c849e004d..295a3a52764e 100644 --- a/clients/client-waf-regional/commands/GetLoggingConfigurationCommand.ts +++ b/clients/client-waf-regional/commands/GetLoggingConfigurationCommand.ts @@ -30,6 +30,20 @@ export interface GetLoggingConfigurationCommandOutput extends GetLoggingConfigur * 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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { WAFRegionalClient, GetLoggingConfigurationCommand } from "@aws-sdk/client-waf-regional"; // ES Modules import + * // const { WAFRegionalClient, GetLoggingConfigurationCommand } = require("@aws-sdk/client-waf-regional"); // CommonJS import + * const client = new WAFRegionalClient(config); + * const command = new GetLoggingConfigurationCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetLoggingConfigurationCommandInput} for command's `input` shape. + * @see {@link GetLoggingConfigurationCommandOutput} for command's `response` shape. + * @see {@link WAFRegionalClientResolvedConfig | config} for command's `input` shape. + * */ export class GetLoggingConfigurationCommand extends $Command< GetLoggingConfigurationCommandInput, diff --git a/clients/client-waf-regional/commands/GetPermissionPolicyCommand.ts b/clients/client-waf-regional/commands/GetPermissionPolicyCommand.ts index ff81b99682dd..4847dcef7f5a 100644 --- a/clients/client-waf-regional/commands/GetPermissionPolicyCommand.ts +++ b/clients/client-waf-regional/commands/GetPermissionPolicyCommand.ts @@ -30,6 +30,20 @@ export interface GetPermissionPolicyCommandOutput extends GetPermissionPolicyRes * 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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { WAFRegionalClient, GetPermissionPolicyCommand } from "@aws-sdk/client-waf-regional"; // ES Modules import + * // const { WAFRegionalClient, GetPermissionPolicyCommand } = require("@aws-sdk/client-waf-regional"); // CommonJS import + * const client = new WAFRegionalClient(config); + * const command = new GetPermissionPolicyCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetPermissionPolicyCommandInput} for command's `input` shape. + * @see {@link GetPermissionPolicyCommandOutput} for command's `response` shape. + * @see {@link WAFRegionalClientResolvedConfig | config} for command's `input` shape. + * */ export class GetPermissionPolicyCommand extends $Command< GetPermissionPolicyCommandInput, diff --git a/clients/client-waf-regional/commands/GetRateBasedRuleCommand.ts b/clients/client-waf-regional/commands/GetRateBasedRuleCommand.ts index b470d44b56c2..3313f59e23b2 100644 --- a/clients/client-waf-regional/commands/GetRateBasedRuleCommand.ts +++ b/clients/client-waf-regional/commands/GetRateBasedRuleCommand.ts @@ -32,6 +32,20 @@ export interface GetRateBasedRuleCommandOutput extends GetRateBasedRuleResponse, *

Returns the RateBasedRule that is specified by the * RuleId that you included in the GetRateBasedRule * request.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { WAFRegionalClient, GetRateBasedRuleCommand } from "@aws-sdk/client-waf-regional"; // ES Modules import + * // const { WAFRegionalClient, GetRateBasedRuleCommand } = require("@aws-sdk/client-waf-regional"); // CommonJS import + * const client = new WAFRegionalClient(config); + * const command = new GetRateBasedRuleCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetRateBasedRuleCommandInput} for command's `input` shape. + * @see {@link GetRateBasedRuleCommandOutput} for command's `response` shape. + * @see {@link WAFRegionalClientResolvedConfig | config} for command's `input` shape. + * */ export class GetRateBasedRuleCommand extends $Command< GetRateBasedRuleCommandInput, diff --git a/clients/client-waf-regional/commands/GetRateBasedRuleManagedKeysCommand.ts b/clients/client-waf-regional/commands/GetRateBasedRuleManagedKeysCommand.ts index 11204dba4bb7..e28a125482ef 100644 --- a/clients/client-waf-regional/commands/GetRateBasedRuleManagedKeysCommand.ts +++ b/clients/client-waf-regional/commands/GetRateBasedRuleManagedKeysCommand.ts @@ -34,6 +34,20 @@ export interface GetRateBasedRuleManagedKeysCommandOutput *

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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { WAFRegionalClient, GetRateBasedRuleManagedKeysCommand } from "@aws-sdk/client-waf-regional"; // ES Modules import + * // const { WAFRegionalClient, GetRateBasedRuleManagedKeysCommand } = require("@aws-sdk/client-waf-regional"); // CommonJS import + * const client = new WAFRegionalClient(config); + * const command = new GetRateBasedRuleManagedKeysCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetRateBasedRuleManagedKeysCommandInput} for command's `input` shape. + * @see {@link GetRateBasedRuleManagedKeysCommandOutput} for command's `response` shape. + * @see {@link WAFRegionalClientResolvedConfig | config} for command's `input` shape. + * */ export class GetRateBasedRuleManagedKeysCommand extends $Command< GetRateBasedRuleManagedKeysCommandInput, diff --git a/clients/client-waf-regional/commands/GetRegexMatchSetCommand.ts b/clients/client-waf-regional/commands/GetRegexMatchSetCommand.ts index fd54ffc4168a..f7a7bc47cf84 100644 --- a/clients/client-waf-regional/commands/GetRegexMatchSetCommand.ts +++ b/clients/client-waf-regional/commands/GetRegexMatchSetCommand.ts @@ -30,6 +30,20 @@ export interface GetRegexMatchSetCommandOutput extends GetRegexMatchSetResponse, * 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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { WAFRegionalClient, GetRegexMatchSetCommand } from "@aws-sdk/client-waf-regional"; // ES Modules import + * // const { WAFRegionalClient, GetRegexMatchSetCommand } = require("@aws-sdk/client-waf-regional"); // CommonJS import + * const client = new WAFRegionalClient(config); + * const command = new GetRegexMatchSetCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetRegexMatchSetCommandInput} for command's `input` shape. + * @see {@link GetRegexMatchSetCommandOutput} for command's `response` shape. + * @see {@link WAFRegionalClientResolvedConfig | config} for command's `input` shape. + * */ export class GetRegexMatchSetCommand extends $Command< GetRegexMatchSetCommandInput, diff --git a/clients/client-waf-regional/commands/GetRegexPatternSetCommand.ts b/clients/client-waf-regional/commands/GetRegexPatternSetCommand.ts index 74c6e7e5486d..c843e9c2bbd3 100644 --- a/clients/client-waf-regional/commands/GetRegexPatternSetCommand.ts +++ b/clients/client-waf-regional/commands/GetRegexPatternSetCommand.ts @@ -30,6 +30,20 @@ export interface GetRegexPatternSetCommandOutput extends GetRegexPatternSetRespo * 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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { WAFRegionalClient, GetRegexPatternSetCommand } from "@aws-sdk/client-waf-regional"; // ES Modules import + * // const { WAFRegionalClient, GetRegexPatternSetCommand } = require("@aws-sdk/client-waf-regional"); // CommonJS import + * const client = new WAFRegionalClient(config); + * const command = new GetRegexPatternSetCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetRegexPatternSetCommandInput} for command's `input` shape. + * @see {@link GetRegexPatternSetCommandOutput} for command's `response` shape. + * @see {@link WAFRegionalClientResolvedConfig | config} for command's `input` shape. + * */ export class GetRegexPatternSetCommand extends $Command< GetRegexPatternSetCommandInput, diff --git a/clients/client-waf-regional/commands/GetRuleCommand.ts b/clients/client-waf-regional/commands/GetRuleCommand.ts index 5fd4257084e3..ad063c6a7763 100644 --- a/clients/client-waf-regional/commands/GetRuleCommand.ts +++ b/clients/client-waf-regional/commands/GetRuleCommand.ts @@ -27,6 +27,20 @@ export interface GetRuleCommandOutput extends GetRuleResponse, __MetadataBearer * 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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { WAFRegionalClient, GetRuleCommand } from "@aws-sdk/client-waf-regional"; // ES Modules import + * // const { WAFRegionalClient, GetRuleCommand } = require("@aws-sdk/client-waf-regional"); // CommonJS import + * const client = new WAFRegionalClient(config); + * const command = new GetRuleCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetRuleCommandInput} for command's `input` shape. + * @see {@link GetRuleCommandOutput} for command's `response` shape. + * @see {@link WAFRegionalClientResolvedConfig | config} for command's `input` shape. + * */ export class GetRuleCommand extends $Command< GetRuleCommandInput, diff --git a/clients/client-waf-regional/commands/GetRuleGroupCommand.ts b/clients/client-waf-regional/commands/GetRuleGroupCommand.ts index cc7c36fe16db..48b002e52727 100644 --- a/clients/client-waf-regional/commands/GetRuleGroupCommand.ts +++ b/clients/client-waf-regional/commands/GetRuleGroupCommand.ts @@ -31,6 +31,20 @@ export interface GetRuleGroupCommandOutput extends GetRuleGroupResponse, __Metad * *

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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { WAFRegionalClient, GetRuleGroupCommand } from "@aws-sdk/client-waf-regional"; // ES Modules import + * // const { WAFRegionalClient, GetRuleGroupCommand } = require("@aws-sdk/client-waf-regional"); // CommonJS import + * const client = new WAFRegionalClient(config); + * const command = new GetRuleGroupCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetRuleGroupCommandInput} for command's `input` shape. + * @see {@link GetRuleGroupCommandOutput} for command's `response` shape. + * @see {@link WAFRegionalClientResolvedConfig | config} for command's `input` shape. + * */ export class GetRuleGroupCommand extends $Command< GetRuleGroupCommandInput, diff --git a/clients/client-waf-regional/commands/GetSampledRequestsCommand.ts b/clients/client-waf-regional/commands/GetSampledRequestsCommand.ts index 57b4d58e893f..88038b4c3032 100644 --- a/clients/client-waf-regional/commands/GetSampledRequestsCommand.ts +++ b/clients/client-waf-regional/commands/GetSampledRequestsCommand.ts @@ -34,6 +34,20 @@ export interface GetSampledRequestsCommandOutput extends GetSampledRequestsRespo * 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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { WAFRegionalClient, GetSampledRequestsCommand } from "@aws-sdk/client-waf-regional"; // ES Modules import + * // const { WAFRegionalClient, GetSampledRequestsCommand } = require("@aws-sdk/client-waf-regional"); // CommonJS import + * const client = new WAFRegionalClient(config); + * const command = new GetSampledRequestsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetSampledRequestsCommandInput} for command's `input` shape. + * @see {@link GetSampledRequestsCommandOutput} for command's `response` shape. + * @see {@link WAFRegionalClientResolvedConfig | config} for command's `input` shape. + * */ export class GetSampledRequestsCommand extends $Command< GetSampledRequestsCommandInput, diff --git a/clients/client-waf-regional/commands/GetSizeConstraintSetCommand.ts b/clients/client-waf-regional/commands/GetSizeConstraintSetCommand.ts index 65fc00c9967e..46676ea83763 100644 --- a/clients/client-waf-regional/commands/GetSizeConstraintSetCommand.ts +++ b/clients/client-waf-regional/commands/GetSizeConstraintSetCommand.ts @@ -30,6 +30,20 @@ export interface GetSizeConstraintSetCommandOutput extends GetSizeConstraintSetR * 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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { WAFRegionalClient, GetSizeConstraintSetCommand } from "@aws-sdk/client-waf-regional"; // ES Modules import + * // const { WAFRegionalClient, GetSizeConstraintSetCommand } = require("@aws-sdk/client-waf-regional"); // CommonJS import + * const client = new WAFRegionalClient(config); + * const command = new GetSizeConstraintSetCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetSizeConstraintSetCommandInput} for command's `input` shape. + * @see {@link GetSizeConstraintSetCommandOutput} for command's `response` shape. + * @see {@link WAFRegionalClientResolvedConfig | config} for command's `input` shape. + * */ export class GetSizeConstraintSetCommand extends $Command< GetSizeConstraintSetCommandInput, diff --git a/clients/client-waf-regional/commands/GetSqlInjectionMatchSetCommand.ts b/clients/client-waf-regional/commands/GetSqlInjectionMatchSetCommand.ts index 309eef98cb71..57c91beef5e9 100644 --- a/clients/client-waf-regional/commands/GetSqlInjectionMatchSetCommand.ts +++ b/clients/client-waf-regional/commands/GetSqlInjectionMatchSetCommand.ts @@ -30,6 +30,20 @@ export interface GetSqlInjectionMatchSetCommandOutput extends GetSqlInjectionMat * 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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { WAFRegionalClient, GetSqlInjectionMatchSetCommand } from "@aws-sdk/client-waf-regional"; // ES Modules import + * // const { WAFRegionalClient, GetSqlInjectionMatchSetCommand } = require("@aws-sdk/client-waf-regional"); // CommonJS import + * const client = new WAFRegionalClient(config); + * const command = new GetSqlInjectionMatchSetCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetSqlInjectionMatchSetCommandInput} for command's `input` shape. + * @see {@link GetSqlInjectionMatchSetCommandOutput} for command's `response` shape. + * @see {@link WAFRegionalClientResolvedConfig | config} for command's `input` shape. + * */ export class GetSqlInjectionMatchSetCommand extends $Command< GetSqlInjectionMatchSetCommandInput, diff --git a/clients/client-waf-regional/commands/GetWebACLCommand.ts b/clients/client-waf-regional/commands/GetWebACLCommand.ts index ec89aa4a8974..57acbdbd6c70 100644 --- a/clients/client-waf-regional/commands/GetWebACLCommand.ts +++ b/clients/client-waf-regional/commands/GetWebACLCommand.ts @@ -27,6 +27,20 @@ export interface GetWebACLCommandOutput extends GetWebACLResponse, __MetadataBea * 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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { WAFRegionalClient, GetWebACLCommand } from "@aws-sdk/client-waf-regional"; // ES Modules import + * // const { WAFRegionalClient, GetWebACLCommand } = require("@aws-sdk/client-waf-regional"); // CommonJS import + * const client = new WAFRegionalClient(config); + * const command = new GetWebACLCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetWebACLCommandInput} for command's `input` shape. + * @see {@link GetWebACLCommandOutput} for command's `response` shape. + * @see {@link WAFRegionalClientResolvedConfig | config} for command's `input` shape. + * */ export class GetWebACLCommand extends $Command< GetWebACLCommandInput, diff --git a/clients/client-waf-regional/commands/GetWebACLForResourceCommand.ts b/clients/client-waf-regional/commands/GetWebACLForResourceCommand.ts index 54bf097485e0..639816ee9926 100644 --- a/clients/client-waf-regional/commands/GetWebACLForResourceCommand.ts +++ b/clients/client-waf-regional/commands/GetWebACLForResourceCommand.ts @@ -30,6 +30,20 @@ export interface GetWebACLForResourceCommandOutput extends GetWebACLForResourceR * 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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { WAFRegionalClient, GetWebACLForResourceCommand } from "@aws-sdk/client-waf-regional"; // ES Modules import + * // const { WAFRegionalClient, GetWebACLForResourceCommand } = require("@aws-sdk/client-waf-regional"); // CommonJS import + * const client = new WAFRegionalClient(config); + * const command = new GetWebACLForResourceCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetWebACLForResourceCommandInput} for command's `input` shape. + * @see {@link GetWebACLForResourceCommandOutput} for command's `response` shape. + * @see {@link WAFRegionalClientResolvedConfig | config} for command's `input` shape. + * */ export class GetWebACLForResourceCommand extends $Command< GetWebACLForResourceCommandInput, diff --git a/clients/client-waf-regional/commands/GetXssMatchSetCommand.ts b/clients/client-waf-regional/commands/GetXssMatchSetCommand.ts index 5bcdb4cafb47..9b1362f0b96a 100644 --- a/clients/client-waf-regional/commands/GetXssMatchSetCommand.ts +++ b/clients/client-waf-regional/commands/GetXssMatchSetCommand.ts @@ -30,6 +30,20 @@ export interface GetXssMatchSetCommandOutput extends GetXssMatchSetResponse, __M * 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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { WAFRegionalClient, GetXssMatchSetCommand } from "@aws-sdk/client-waf-regional"; // ES Modules import + * // const { WAFRegionalClient, GetXssMatchSetCommand } = require("@aws-sdk/client-waf-regional"); // CommonJS import + * const client = new WAFRegionalClient(config); + * const command = new GetXssMatchSetCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetXssMatchSetCommandInput} for command's `input` shape. + * @see {@link GetXssMatchSetCommandOutput} for command's `response` shape. + * @see {@link WAFRegionalClientResolvedConfig | config} for command's `input` shape. + * */ export class GetXssMatchSetCommand extends $Command< GetXssMatchSetCommandInput, diff --git a/clients/client-waf-regional/commands/ListActivatedRulesInRuleGroupCommand.ts b/clients/client-waf-regional/commands/ListActivatedRulesInRuleGroupCommand.ts index 25ca89841497..d8917feca477 100644 --- a/clients/client-waf-regional/commands/ListActivatedRulesInRuleGroupCommand.ts +++ b/clients/client-waf-regional/commands/ListActivatedRulesInRuleGroupCommand.ts @@ -32,6 +32,20 @@ export interface ListActivatedRulesInRuleGroupCommandOutput * 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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { WAFRegionalClient, ListActivatedRulesInRuleGroupCommand } from "@aws-sdk/client-waf-regional"; // ES Modules import + * // const { WAFRegionalClient, ListActivatedRulesInRuleGroupCommand } = require("@aws-sdk/client-waf-regional"); // CommonJS import + * const client = new WAFRegionalClient(config); + * const command = new ListActivatedRulesInRuleGroupCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListActivatedRulesInRuleGroupCommandInput} for command's `input` shape. + * @see {@link ListActivatedRulesInRuleGroupCommandOutput} for command's `response` shape. + * @see {@link WAFRegionalClientResolvedConfig | config} for command's `input` shape. + * */ export class ListActivatedRulesInRuleGroupCommand extends $Command< ListActivatedRulesInRuleGroupCommandInput, diff --git a/clients/client-waf-regional/commands/ListByteMatchSetsCommand.ts b/clients/client-waf-regional/commands/ListByteMatchSetsCommand.ts index 6cedc1477848..74f84fa83897 100644 --- a/clients/client-waf-regional/commands/ListByteMatchSetsCommand.ts +++ b/clients/client-waf-regional/commands/ListByteMatchSetsCommand.ts @@ -30,6 +30,20 @@ export interface ListByteMatchSetsCommandOutput extends ListByteMatchSetsRespons * 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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { WAFRegionalClient, ListByteMatchSetsCommand } from "@aws-sdk/client-waf-regional"; // ES Modules import + * // const { WAFRegionalClient, ListByteMatchSetsCommand } = require("@aws-sdk/client-waf-regional"); // CommonJS import + * const client = new WAFRegionalClient(config); + * const command = new ListByteMatchSetsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListByteMatchSetsCommandInput} for command's `input` shape. + * @see {@link ListByteMatchSetsCommandOutput} for command's `response` shape. + * @see {@link WAFRegionalClientResolvedConfig | config} for command's `input` shape. + * */ export class ListByteMatchSetsCommand extends $Command< ListByteMatchSetsCommandInput, diff --git a/clients/client-waf-regional/commands/ListGeoMatchSetsCommand.ts b/clients/client-waf-regional/commands/ListGeoMatchSetsCommand.ts index 59cd0adf6ab6..7560fd98512e 100644 --- a/clients/client-waf-regional/commands/ListGeoMatchSetsCommand.ts +++ b/clients/client-waf-regional/commands/ListGeoMatchSetsCommand.ts @@ -30,6 +30,20 @@ export interface ListGeoMatchSetsCommandOutput extends ListGeoMatchSetsResponse, * 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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { WAFRegionalClient, ListGeoMatchSetsCommand } from "@aws-sdk/client-waf-regional"; // ES Modules import + * // const { WAFRegionalClient, ListGeoMatchSetsCommand } = require("@aws-sdk/client-waf-regional"); // CommonJS import + * const client = new WAFRegionalClient(config); + * const command = new ListGeoMatchSetsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListGeoMatchSetsCommandInput} for command's `input` shape. + * @see {@link ListGeoMatchSetsCommandOutput} for command's `response` shape. + * @see {@link WAFRegionalClientResolvedConfig | config} for command's `input` shape. + * */ export class ListGeoMatchSetsCommand extends $Command< ListGeoMatchSetsCommandInput, diff --git a/clients/client-waf-regional/commands/ListIPSetsCommand.ts b/clients/client-waf-regional/commands/ListIPSetsCommand.ts index 79388b3689ea..c333e2b6eddf 100644 --- a/clients/client-waf-regional/commands/ListIPSetsCommand.ts +++ b/clients/client-waf-regional/commands/ListIPSetsCommand.ts @@ -30,6 +30,20 @@ export interface ListIPSetsCommandOutput extends ListIPSetsResponse, __MetadataB * 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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { WAFRegionalClient, ListIPSetsCommand } from "@aws-sdk/client-waf-regional"; // ES Modules import + * // const { WAFRegionalClient, ListIPSetsCommand } = require("@aws-sdk/client-waf-regional"); // CommonJS import + * const client = new WAFRegionalClient(config); + * const command = new ListIPSetsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListIPSetsCommandInput} for command's `input` shape. + * @see {@link ListIPSetsCommandOutput} for command's `response` shape. + * @see {@link WAFRegionalClientResolvedConfig | config} for command's `input` shape. + * */ export class ListIPSetsCommand extends $Command< ListIPSetsCommandInput, diff --git a/clients/client-waf-regional/commands/ListLoggingConfigurationsCommand.ts b/clients/client-waf-regional/commands/ListLoggingConfigurationsCommand.ts index 8bf701a85f34..2e5b6dc6479f 100644 --- a/clients/client-waf-regional/commands/ListLoggingConfigurationsCommand.ts +++ b/clients/client-waf-regional/commands/ListLoggingConfigurationsCommand.ts @@ -30,6 +30,20 @@ export interface ListLoggingConfigurationsCommandOutput extends ListLoggingConfi * 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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { WAFRegionalClient, ListLoggingConfigurationsCommand } from "@aws-sdk/client-waf-regional"; // ES Modules import + * // const { WAFRegionalClient, ListLoggingConfigurationsCommand } = require("@aws-sdk/client-waf-regional"); // CommonJS import + * const client = new WAFRegionalClient(config); + * const command = new ListLoggingConfigurationsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListLoggingConfigurationsCommandInput} for command's `input` shape. + * @see {@link ListLoggingConfigurationsCommandOutput} for command's `response` shape. + * @see {@link WAFRegionalClientResolvedConfig | config} for command's `input` shape. + * */ export class ListLoggingConfigurationsCommand extends $Command< ListLoggingConfigurationsCommandInput, diff --git a/clients/client-waf-regional/commands/ListRateBasedRulesCommand.ts b/clients/client-waf-regional/commands/ListRateBasedRulesCommand.ts index d70464163e0c..bebee002b362 100644 --- a/clients/client-waf-regional/commands/ListRateBasedRulesCommand.ts +++ b/clients/client-waf-regional/commands/ListRateBasedRulesCommand.ts @@ -30,6 +30,20 @@ export interface ListRateBasedRulesCommandOutput extends ListRateBasedRulesRespo * 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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { WAFRegionalClient, ListRateBasedRulesCommand } from "@aws-sdk/client-waf-regional"; // ES Modules import + * // const { WAFRegionalClient, ListRateBasedRulesCommand } = require("@aws-sdk/client-waf-regional"); // CommonJS import + * const client = new WAFRegionalClient(config); + * const command = new ListRateBasedRulesCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListRateBasedRulesCommandInput} for command's `input` shape. + * @see {@link ListRateBasedRulesCommandOutput} for command's `response` shape. + * @see {@link WAFRegionalClientResolvedConfig | config} for command's `input` shape. + * */ export class ListRateBasedRulesCommand extends $Command< ListRateBasedRulesCommandInput, diff --git a/clients/client-waf-regional/commands/ListRegexMatchSetsCommand.ts b/clients/client-waf-regional/commands/ListRegexMatchSetsCommand.ts index e70a96b158b5..04f2b667974f 100644 --- a/clients/client-waf-regional/commands/ListRegexMatchSetsCommand.ts +++ b/clients/client-waf-regional/commands/ListRegexMatchSetsCommand.ts @@ -30,6 +30,20 @@ export interface ListRegexMatchSetsCommandOutput extends ListRegexMatchSetsRespo * 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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { WAFRegionalClient, ListRegexMatchSetsCommand } from "@aws-sdk/client-waf-regional"; // ES Modules import + * // const { WAFRegionalClient, ListRegexMatchSetsCommand } = require("@aws-sdk/client-waf-regional"); // CommonJS import + * const client = new WAFRegionalClient(config); + * const command = new ListRegexMatchSetsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListRegexMatchSetsCommandInput} for command's `input` shape. + * @see {@link ListRegexMatchSetsCommandOutput} for command's `response` shape. + * @see {@link WAFRegionalClientResolvedConfig | config} for command's `input` shape. + * */ export class ListRegexMatchSetsCommand extends $Command< ListRegexMatchSetsCommandInput, diff --git a/clients/client-waf-regional/commands/ListRegexPatternSetsCommand.ts b/clients/client-waf-regional/commands/ListRegexPatternSetsCommand.ts index c8ddbdbca7e9..787f1b9f8eb7 100644 --- a/clients/client-waf-regional/commands/ListRegexPatternSetsCommand.ts +++ b/clients/client-waf-regional/commands/ListRegexPatternSetsCommand.ts @@ -30,6 +30,20 @@ export interface ListRegexPatternSetsCommandOutput extends ListRegexPatternSetsR * 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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { WAFRegionalClient, ListRegexPatternSetsCommand } from "@aws-sdk/client-waf-regional"; // ES Modules import + * // const { WAFRegionalClient, ListRegexPatternSetsCommand } = require("@aws-sdk/client-waf-regional"); // CommonJS import + * const client = new WAFRegionalClient(config); + * const command = new ListRegexPatternSetsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListRegexPatternSetsCommandInput} for command's `input` shape. + * @see {@link ListRegexPatternSetsCommandOutput} for command's `response` shape. + * @see {@link WAFRegionalClientResolvedConfig | config} for command's `input` shape. + * */ export class ListRegexPatternSetsCommand extends $Command< ListRegexPatternSetsCommandInput, diff --git a/clients/client-waf-regional/commands/ListResourcesForWebACLCommand.ts b/clients/client-waf-regional/commands/ListResourcesForWebACLCommand.ts index 099497de5c9a..f72434096b8a 100644 --- a/clients/client-waf-regional/commands/ListResourcesForWebACLCommand.ts +++ b/clients/client-waf-regional/commands/ListResourcesForWebACLCommand.ts @@ -30,6 +30,20 @@ export interface ListResourcesForWebACLCommandOutput extends ListResourcesForWeb * 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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { WAFRegionalClient, ListResourcesForWebACLCommand } from "@aws-sdk/client-waf-regional"; // ES Modules import + * // const { WAFRegionalClient, ListResourcesForWebACLCommand } = require("@aws-sdk/client-waf-regional"); // CommonJS import + * const client = new WAFRegionalClient(config); + * const command = new ListResourcesForWebACLCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListResourcesForWebACLCommandInput} for command's `input` shape. + * @see {@link ListResourcesForWebACLCommandOutput} for command's `response` shape. + * @see {@link WAFRegionalClientResolvedConfig | config} for command's `input` shape. + * */ export class ListResourcesForWebACLCommand extends $Command< ListResourcesForWebACLCommandInput, diff --git a/clients/client-waf-regional/commands/ListRuleGroupsCommand.ts b/clients/client-waf-regional/commands/ListRuleGroupsCommand.ts index fad4b03c103e..981b9147f200 100644 --- a/clients/client-waf-regional/commands/ListRuleGroupsCommand.ts +++ b/clients/client-waf-regional/commands/ListRuleGroupsCommand.ts @@ -30,6 +30,20 @@ export interface ListRuleGroupsCommandOutput extends ListRuleGroupsResponse, __M * 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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { WAFRegionalClient, ListRuleGroupsCommand } from "@aws-sdk/client-waf-regional"; // ES Modules import + * // const { WAFRegionalClient, ListRuleGroupsCommand } = require("@aws-sdk/client-waf-regional"); // CommonJS import + * const client = new WAFRegionalClient(config); + * const command = new ListRuleGroupsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListRuleGroupsCommandInput} for command's `input` shape. + * @see {@link ListRuleGroupsCommandOutput} for command's `response` shape. + * @see {@link WAFRegionalClientResolvedConfig | config} for command's `input` shape. + * */ export class ListRuleGroupsCommand extends $Command< ListRuleGroupsCommandInput, diff --git a/clients/client-waf-regional/commands/ListRulesCommand.ts b/clients/client-waf-regional/commands/ListRulesCommand.ts index b742dbf69310..f372cae17efe 100644 --- a/clients/client-waf-regional/commands/ListRulesCommand.ts +++ b/clients/client-waf-regional/commands/ListRulesCommand.ts @@ -27,6 +27,20 @@ export interface ListRulesCommandOutput extends ListRulesResponse, __MetadataBea * 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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { WAFRegionalClient, ListRulesCommand } from "@aws-sdk/client-waf-regional"; // ES Modules import + * // const { WAFRegionalClient, ListRulesCommand } = require("@aws-sdk/client-waf-regional"); // CommonJS import + * const client = new WAFRegionalClient(config); + * const command = new ListRulesCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListRulesCommandInput} for command's `input` shape. + * @see {@link ListRulesCommandOutput} for command's `response` shape. + * @see {@link WAFRegionalClientResolvedConfig | config} for command's `input` shape. + * */ export class ListRulesCommand extends $Command< ListRulesCommandInput, diff --git a/clients/client-waf-regional/commands/ListSizeConstraintSetsCommand.ts b/clients/client-waf-regional/commands/ListSizeConstraintSetsCommand.ts index ffc2debdfe6d..a39a74714a05 100644 --- a/clients/client-waf-regional/commands/ListSizeConstraintSetsCommand.ts +++ b/clients/client-waf-regional/commands/ListSizeConstraintSetsCommand.ts @@ -30,6 +30,20 @@ export interface ListSizeConstraintSetsCommandOutput extends ListSizeConstraintS * 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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { WAFRegionalClient, ListSizeConstraintSetsCommand } from "@aws-sdk/client-waf-regional"; // ES Modules import + * // const { WAFRegionalClient, ListSizeConstraintSetsCommand } = require("@aws-sdk/client-waf-regional"); // CommonJS import + * const client = new WAFRegionalClient(config); + * const command = new ListSizeConstraintSetsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListSizeConstraintSetsCommandInput} for command's `input` shape. + * @see {@link ListSizeConstraintSetsCommandOutput} for command's `response` shape. + * @see {@link WAFRegionalClientResolvedConfig | config} for command's `input` shape. + * */ export class ListSizeConstraintSetsCommand extends $Command< ListSizeConstraintSetsCommandInput, diff --git a/clients/client-waf-regional/commands/ListSqlInjectionMatchSetsCommand.ts b/clients/client-waf-regional/commands/ListSqlInjectionMatchSetsCommand.ts index f1b829b1fda9..7a326b9fdb74 100644 --- a/clients/client-waf-regional/commands/ListSqlInjectionMatchSetsCommand.ts +++ b/clients/client-waf-regional/commands/ListSqlInjectionMatchSetsCommand.ts @@ -30,6 +30,20 @@ export interface ListSqlInjectionMatchSetsCommandOutput extends ListSqlInjection * 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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { WAFRegionalClient, ListSqlInjectionMatchSetsCommand } from "@aws-sdk/client-waf-regional"; // ES Modules import + * // const { WAFRegionalClient, ListSqlInjectionMatchSetsCommand } = require("@aws-sdk/client-waf-regional"); // CommonJS import + * const client = new WAFRegionalClient(config); + * const command = new ListSqlInjectionMatchSetsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListSqlInjectionMatchSetsCommandInput} for command's `input` shape. + * @see {@link ListSqlInjectionMatchSetsCommandOutput} for command's `response` shape. + * @see {@link WAFRegionalClientResolvedConfig | config} for command's `input` shape. + * */ export class ListSqlInjectionMatchSetsCommand extends $Command< ListSqlInjectionMatchSetsCommandInput, diff --git a/clients/client-waf-regional/commands/ListSubscribedRuleGroupsCommand.ts b/clients/client-waf-regional/commands/ListSubscribedRuleGroupsCommand.ts index 018048dffc18..5d8404efd042 100644 --- a/clients/client-waf-regional/commands/ListSubscribedRuleGroupsCommand.ts +++ b/clients/client-waf-regional/commands/ListSubscribedRuleGroupsCommand.ts @@ -30,6 +30,20 @@ export interface ListSubscribedRuleGroupsCommandOutput extends ListSubscribedRul * 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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { WAFRegionalClient, ListSubscribedRuleGroupsCommand } from "@aws-sdk/client-waf-regional"; // ES Modules import + * // const { WAFRegionalClient, ListSubscribedRuleGroupsCommand } = require("@aws-sdk/client-waf-regional"); // CommonJS import + * const client = new WAFRegionalClient(config); + * const command = new ListSubscribedRuleGroupsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListSubscribedRuleGroupsCommandInput} for command's `input` shape. + * @see {@link ListSubscribedRuleGroupsCommandOutput} for command's `response` shape. + * @see {@link WAFRegionalClientResolvedConfig | config} for command's `input` shape. + * */ export class ListSubscribedRuleGroupsCommand extends $Command< ListSubscribedRuleGroupsCommandInput, diff --git a/clients/client-waf-regional/commands/ListTagsForResourceCommand.ts b/clients/client-waf-regional/commands/ListTagsForResourceCommand.ts index 61cbec87d7e8..94131abe190f 100644 --- a/clients/client-waf-regional/commands/ListTagsForResourceCommand.ts +++ b/clients/client-waf-regional/commands/ListTagsForResourceCommand.ts @@ -31,6 +31,20 @@ export interface ListTagsForResourceCommandOutput extends ListTagsForResourceRes * *

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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { WAFRegionalClient, ListTagsForResourceCommand } from "@aws-sdk/client-waf-regional"; // ES Modules import + * // const { WAFRegionalClient, ListTagsForResourceCommand } = require("@aws-sdk/client-waf-regional"); // CommonJS import + * const client = new WAFRegionalClient(config); + * const command = new ListTagsForResourceCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListTagsForResourceCommandInput} for command's `input` shape. + * @see {@link ListTagsForResourceCommandOutput} for command's `response` shape. + * @see {@link WAFRegionalClientResolvedConfig | config} for command's `input` shape. + * */ export class ListTagsForResourceCommand extends $Command< ListTagsForResourceCommandInput, diff --git a/clients/client-waf-regional/commands/ListWebACLsCommand.ts b/clients/client-waf-regional/commands/ListWebACLsCommand.ts index 8d2bedb233c8..683d9552ac16 100644 --- a/clients/client-waf-regional/commands/ListWebACLsCommand.ts +++ b/clients/client-waf-regional/commands/ListWebACLsCommand.ts @@ -30,6 +30,20 @@ export interface ListWebACLsCommandOutput extends ListWebACLsResponse, __Metadat * 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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { WAFRegionalClient, ListWebACLsCommand } from "@aws-sdk/client-waf-regional"; // ES Modules import + * // const { WAFRegionalClient, ListWebACLsCommand } = require("@aws-sdk/client-waf-regional"); // CommonJS import + * const client = new WAFRegionalClient(config); + * const command = new ListWebACLsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListWebACLsCommandInput} for command's `input` shape. + * @see {@link ListWebACLsCommandOutput} for command's `response` shape. + * @see {@link WAFRegionalClientResolvedConfig | config} for command's `input` shape. + * */ export class ListWebACLsCommand extends $Command< ListWebACLsCommandInput, diff --git a/clients/client-waf-regional/commands/ListXssMatchSetsCommand.ts b/clients/client-waf-regional/commands/ListXssMatchSetsCommand.ts index 3e78e9d3c134..60e1fcbd707c 100644 --- a/clients/client-waf-regional/commands/ListXssMatchSetsCommand.ts +++ b/clients/client-waf-regional/commands/ListXssMatchSetsCommand.ts @@ -30,6 +30,20 @@ export interface ListXssMatchSetsCommandOutput extends ListXssMatchSetsResponse, * 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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { WAFRegionalClient, ListXssMatchSetsCommand } from "@aws-sdk/client-waf-regional"; // ES Modules import + * // const { WAFRegionalClient, ListXssMatchSetsCommand } = require("@aws-sdk/client-waf-regional"); // CommonJS import + * const client = new WAFRegionalClient(config); + * const command = new ListXssMatchSetsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListXssMatchSetsCommandInput} for command's `input` shape. + * @see {@link ListXssMatchSetsCommandOutput} for command's `response` shape. + * @see {@link WAFRegionalClientResolvedConfig | config} for command's `input` shape. + * */ export class ListXssMatchSetsCommand extends $Command< ListXssMatchSetsCommandInput, diff --git a/clients/client-waf-regional/commands/PutLoggingConfigurationCommand.ts b/clients/client-waf-regional/commands/PutLoggingConfigurationCommand.ts index 95ab90e17743..32bdcdbe6c36 100644 --- a/clients/client-waf-regional/commands/PutLoggingConfigurationCommand.ts +++ b/clients/client-waf-regional/commands/PutLoggingConfigurationCommand.ts @@ -47,6 +47,20 @@ export interface PutLoggingConfigurationCommandOutput extends PutLoggingConfigur * * *

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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { WAFRegionalClient, PutLoggingConfigurationCommand } from "@aws-sdk/client-waf-regional"; // ES Modules import + * // const { WAFRegionalClient, PutLoggingConfigurationCommand } = require("@aws-sdk/client-waf-regional"); // CommonJS import + * const client = new WAFRegionalClient(config); + * const command = new PutLoggingConfigurationCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link PutLoggingConfigurationCommandInput} for command's `input` shape. + * @see {@link PutLoggingConfigurationCommandOutput} for command's `response` shape. + * @see {@link WAFRegionalClientResolvedConfig | config} for command's `input` shape. + * */ export class PutLoggingConfigurationCommand extends $Command< PutLoggingConfigurationCommandInput, diff --git a/clients/client-waf-regional/commands/PutPermissionPolicyCommand.ts b/clients/client-waf-regional/commands/PutPermissionPolicyCommand.ts index af77b1b6e9ef..017d7c3bc730 100644 --- a/clients/client-waf-regional/commands/PutPermissionPolicyCommand.ts +++ b/clients/client-waf-regional/commands/PutPermissionPolicyCommand.ts @@ -62,6 +62,20 @@ export interface PutPermissionPolicyCommandOutput extends PutPermissionPolicyRes *

For more information, see IAM Policies.

* *

An example of a valid policy parameter is shown in the Examples section below.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { WAFRegionalClient, PutPermissionPolicyCommand } from "@aws-sdk/client-waf-regional"; // ES Modules import + * // const { WAFRegionalClient, PutPermissionPolicyCommand } = require("@aws-sdk/client-waf-regional"); // CommonJS import + * const client = new WAFRegionalClient(config); + * const command = new PutPermissionPolicyCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link PutPermissionPolicyCommandInput} for command's `input` shape. + * @see {@link PutPermissionPolicyCommandOutput} for command's `response` shape. + * @see {@link WAFRegionalClientResolvedConfig | config} for command's `input` shape. + * */ export class PutPermissionPolicyCommand extends $Command< PutPermissionPolicyCommandInput, diff --git a/clients/client-waf-regional/commands/TagResourceCommand.ts b/clients/client-waf-regional/commands/TagResourceCommand.ts index 3cbf7183a847..1e743a47b01c 100644 --- a/clients/client-waf-regional/commands/TagResourceCommand.ts +++ b/clients/client-waf-regional/commands/TagResourceCommand.ts @@ -31,6 +31,20 @@ export interface TagResourceCommandOutput extends TagResourceResponse, __Metadat * *

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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { WAFRegionalClient, TagResourceCommand } from "@aws-sdk/client-waf-regional"; // ES Modules import + * // const { WAFRegionalClient, TagResourceCommand } = require("@aws-sdk/client-waf-regional"); // CommonJS import + * const client = new WAFRegionalClient(config); + * const command = new TagResourceCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link TagResourceCommandInput} for command's `input` shape. + * @see {@link TagResourceCommandOutput} for command's `response` shape. + * @see {@link WAFRegionalClientResolvedConfig | config} for command's `input` shape. + * */ export class TagResourceCommand extends $Command< TagResourceCommandInput, diff --git a/clients/client-waf-regional/commands/UntagResourceCommand.ts b/clients/client-waf-regional/commands/UntagResourceCommand.ts index ae953aecdc95..4ee19c0057dc 100644 --- a/clients/client-waf-regional/commands/UntagResourceCommand.ts +++ b/clients/client-waf-regional/commands/UntagResourceCommand.ts @@ -30,6 +30,20 @@ export interface UntagResourceCommandOutput extends UntagResourceResponse, __Met * 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.

* *

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { WAFRegionalClient, UntagResourceCommand } from "@aws-sdk/client-waf-regional"; // ES Modules import + * // const { WAFRegionalClient, UntagResourceCommand } = require("@aws-sdk/client-waf-regional"); // CommonJS import + * const client = new WAFRegionalClient(config); + * const command = new UntagResourceCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link UntagResourceCommandInput} for command's `input` shape. + * @see {@link UntagResourceCommandOutput} for command's `response` shape. + * @see {@link WAFRegionalClientResolvedConfig | config} for command's `input` shape. + * */ export class UntagResourceCommand extends $Command< UntagResourceCommandInput, diff --git a/clients/client-waf-regional/commands/UpdateByteMatchSetCommand.ts b/clients/client-waf-regional/commands/UpdateByteMatchSetCommand.ts index 1a9438f06ab0..5b3ae5ea1226 100644 --- a/clients/client-waf-regional/commands/UpdateByteMatchSetCommand.ts +++ b/clients/client-waf-regional/commands/UpdateByteMatchSetCommand.ts @@ -68,6 +68,20 @@ export interface UpdateByteMatchSetCommandOutput extends UpdateByteMatchSetRespo * *

For more information about how to use the AWS WAF API to allow or block HTTP requests, see the * AWS WAF Developer Guide.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { WAFRegionalClient, UpdateByteMatchSetCommand } from "@aws-sdk/client-waf-regional"; // ES Modules import + * // const { WAFRegionalClient, UpdateByteMatchSetCommand } = require("@aws-sdk/client-waf-regional"); // CommonJS import + * const client = new WAFRegionalClient(config); + * const command = new UpdateByteMatchSetCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link UpdateByteMatchSetCommandInput} for command's `input` shape. + * @see {@link UpdateByteMatchSetCommandOutput} for command's `response` shape. + * @see {@link WAFRegionalClientResolvedConfig | config} for command's `input` shape. + * */ export class UpdateByteMatchSetCommand extends $Command< UpdateByteMatchSetCommandInput, diff --git a/clients/client-waf-regional/commands/UpdateGeoMatchSetCommand.ts b/clients/client-waf-regional/commands/UpdateGeoMatchSetCommand.ts index 4d30944d2b28..d324da5a222f 100644 --- a/clients/client-waf-regional/commands/UpdateGeoMatchSetCommand.ts +++ b/clients/client-waf-regional/commands/UpdateGeoMatchSetCommand.ts @@ -60,6 +60,20 @@ export interface UpdateGeoMatchSetCommandOutput extends UpdateGeoMatchSetRespons * 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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { WAFRegionalClient, UpdateGeoMatchSetCommand } from "@aws-sdk/client-waf-regional"; // ES Modules import + * // const { WAFRegionalClient, UpdateGeoMatchSetCommand } = require("@aws-sdk/client-waf-regional"); // CommonJS import + * const client = new WAFRegionalClient(config); + * const command = new UpdateGeoMatchSetCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link UpdateGeoMatchSetCommandInput} for command's `input` shape. + * @see {@link UpdateGeoMatchSetCommandOutput} for command's `response` shape. + * @see {@link WAFRegionalClientResolvedConfig | config} for command's `input` shape. + * */ export class UpdateGeoMatchSetCommand extends $Command< UpdateGeoMatchSetCommandInput, diff --git a/clients/client-waf-regional/commands/UpdateIPSetCommand.ts b/clients/client-waf-regional/commands/UpdateIPSetCommand.ts index 6d58d940a923..31f7678bce7a 100644 --- a/clients/client-waf-regional/commands/UpdateIPSetCommand.ts +++ b/clients/client-waf-regional/commands/UpdateIPSetCommand.ts @@ -95,6 +95,20 @@ export interface UpdateIPSetCommandOutput extends UpdateIPSetResponse, __Metadat *

For more information about how to use the AWS WAF API to allow or block HTTP * requests, see the AWS WAF * Developer Guide.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { WAFRegionalClient, UpdateIPSetCommand } from "@aws-sdk/client-waf-regional"; // ES Modules import + * // const { WAFRegionalClient, UpdateIPSetCommand } = require("@aws-sdk/client-waf-regional"); // CommonJS import + * const client = new WAFRegionalClient(config); + * const command = new UpdateIPSetCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link UpdateIPSetCommandInput} for command's `input` shape. + * @see {@link UpdateIPSetCommandOutput} for command's `response` shape. + * @see {@link WAFRegionalClientResolvedConfig | config} for command's `input` shape. + * */ export class UpdateIPSetCommand extends $Command< UpdateIPSetCommandInput, diff --git a/clients/client-waf-regional/commands/UpdateRateBasedRuleCommand.ts b/clients/client-waf-regional/commands/UpdateRateBasedRuleCommand.ts index a978fd4dcfaf..e04d3dac9bf9 100644 --- a/clients/client-waf-regional/commands/UpdateRateBasedRuleCommand.ts +++ b/clients/client-waf-regional/commands/UpdateRateBasedRuleCommand.ts @@ -76,6 +76,20 @@ export interface UpdateRateBasedRuleCommandOutput extends UpdateRateBasedRuleRes * *

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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { WAFRegionalClient, UpdateRateBasedRuleCommand } from "@aws-sdk/client-waf-regional"; // ES Modules import + * // const { WAFRegionalClient, UpdateRateBasedRuleCommand } = require("@aws-sdk/client-waf-regional"); // CommonJS import + * const client = new WAFRegionalClient(config); + * const command = new UpdateRateBasedRuleCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link UpdateRateBasedRuleCommandInput} for command's `input` shape. + * @see {@link UpdateRateBasedRuleCommandOutput} for command's `response` shape. + * @see {@link WAFRegionalClientResolvedConfig | config} for command's `input` shape. + * */ export class UpdateRateBasedRuleCommand extends $Command< UpdateRateBasedRuleCommandInput, diff --git a/clients/client-waf-regional/commands/UpdateRegexMatchSetCommand.ts b/clients/client-waf-regional/commands/UpdateRegexMatchSetCommand.ts index 840334090dff..2ce1a4452019 100644 --- a/clients/client-waf-regional/commands/UpdateRegexMatchSetCommand.ts +++ b/clients/client-waf-regional/commands/UpdateRegexMatchSetCommand.ts @@ -64,6 +64,20 @@ export interface UpdateRegexMatchSetCommandOutput extends UpdateRegexMatchSetRes * *

For more information about how to use the AWS WAF API to allow or block HTTP requests, see the * AWS WAF Developer Guide.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { WAFRegionalClient, UpdateRegexMatchSetCommand } from "@aws-sdk/client-waf-regional"; // ES Modules import + * // const { WAFRegionalClient, UpdateRegexMatchSetCommand } = require("@aws-sdk/client-waf-regional"); // CommonJS import + * const client = new WAFRegionalClient(config); + * const command = new UpdateRegexMatchSetCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link UpdateRegexMatchSetCommandInput} for command's `input` shape. + * @see {@link UpdateRegexMatchSetCommandOutput} for command's `response` shape. + * @see {@link WAFRegionalClientResolvedConfig | config} for command's `input` shape. + * */ export class UpdateRegexMatchSetCommand extends $Command< UpdateRegexMatchSetCommandInput, diff --git a/clients/client-waf-regional/commands/UpdateRegexPatternSetCommand.ts b/clients/client-waf-regional/commands/UpdateRegexPatternSetCommand.ts index 6e9799163013..cb283ab18684 100644 --- a/clients/client-waf-regional/commands/UpdateRegexPatternSetCommand.ts +++ b/clients/client-waf-regional/commands/UpdateRegexPatternSetCommand.ts @@ -69,6 +69,20 @@ export interface UpdateRegexPatternSetCommandOutput extends UpdateRegexPatternSe * *

For more information about how to use the AWS WAF API to allow or block HTTP requests, see the * AWS WAF Developer Guide.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { WAFRegionalClient, UpdateRegexPatternSetCommand } from "@aws-sdk/client-waf-regional"; // ES Modules import + * // const { WAFRegionalClient, UpdateRegexPatternSetCommand } = require("@aws-sdk/client-waf-regional"); // CommonJS import + * const client = new WAFRegionalClient(config); + * const command = new UpdateRegexPatternSetCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link UpdateRegexPatternSetCommandInput} for command's `input` shape. + * @see {@link UpdateRegexPatternSetCommandOutput} for command's `response` shape. + * @see {@link WAFRegionalClientResolvedConfig | config} for command's `input` shape. + * */ export class UpdateRegexPatternSetCommand extends $Command< UpdateRegexPatternSetCommandInput, diff --git a/clients/client-waf-regional/commands/UpdateRuleCommand.ts b/clients/client-waf-regional/commands/UpdateRuleCommand.ts index f29c1c72f19f..0935699817b6 100644 --- a/clients/client-waf-regional/commands/UpdateRuleCommand.ts +++ b/clients/client-waf-regional/commands/UpdateRuleCommand.ts @@ -71,6 +71,20 @@ export interface UpdateRuleCommandOutput extends UpdateRuleResponse, __MetadataB * 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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { WAFRegionalClient, UpdateRuleCommand } from "@aws-sdk/client-waf-regional"; // ES Modules import + * // const { WAFRegionalClient, UpdateRuleCommand } = require("@aws-sdk/client-waf-regional"); // CommonJS import + * const client = new WAFRegionalClient(config); + * const command = new UpdateRuleCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link UpdateRuleCommandInput} for command's `input` shape. + * @see {@link UpdateRuleCommandOutput} for command's `response` shape. + * @see {@link WAFRegionalClientResolvedConfig | config} for command's `input` shape. + * */ export class UpdateRuleCommand extends $Command< UpdateRuleCommandInput, diff --git a/clients/client-waf-regional/commands/UpdateRuleGroupCommand.ts b/clients/client-waf-regional/commands/UpdateRuleGroupCommand.ts index c5d9ed1fdf2b..fb0efd81a070 100644 --- a/clients/client-waf-regional/commands/UpdateRuleGroupCommand.ts +++ b/clients/client-waf-regional/commands/UpdateRuleGroupCommand.ts @@ -54,6 +54,20 @@ export interface UpdateRuleGroupCommandOutput extends UpdateRuleGroupResponse, _ * 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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { WAFRegionalClient, UpdateRuleGroupCommand } from "@aws-sdk/client-waf-regional"; // ES Modules import + * // const { WAFRegionalClient, UpdateRuleGroupCommand } = require("@aws-sdk/client-waf-regional"); // CommonJS import + * const client = new WAFRegionalClient(config); + * const command = new UpdateRuleGroupCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link UpdateRuleGroupCommandInput} for command's `input` shape. + * @see {@link UpdateRuleGroupCommandOutput} for command's `response` shape. + * @see {@link WAFRegionalClientResolvedConfig | config} for command's `input` shape. + * */ export class UpdateRuleGroupCommand extends $Command< UpdateRuleGroupCommandInput, diff --git a/clients/client-waf-regional/commands/UpdateSizeConstraintSetCommand.ts b/clients/client-waf-regional/commands/UpdateSizeConstraintSetCommand.ts index c2a50cff5956..e1fb5efebeeb 100644 --- a/clients/client-waf-regional/commands/UpdateSizeConstraintSetCommand.ts +++ b/clients/client-waf-regional/commands/UpdateSizeConstraintSetCommand.ts @@ -72,6 +72,20 @@ export interface UpdateSizeConstraintSetCommandOutput extends UpdateSizeConstrai * *

For more information about how to use the AWS WAF API to allow or block HTTP requests, see the * AWS WAF Developer Guide.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { WAFRegionalClient, UpdateSizeConstraintSetCommand } from "@aws-sdk/client-waf-regional"; // ES Modules import + * // const { WAFRegionalClient, UpdateSizeConstraintSetCommand } = require("@aws-sdk/client-waf-regional"); // CommonJS import + * const client = new WAFRegionalClient(config); + * const command = new UpdateSizeConstraintSetCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link UpdateSizeConstraintSetCommandInput} for command's `input` shape. + * @see {@link UpdateSizeConstraintSetCommandOutput} for command's `response` shape. + * @see {@link WAFRegionalClientResolvedConfig | config} for command's `input` shape. + * */ export class UpdateSizeConstraintSetCommand extends $Command< UpdateSizeConstraintSetCommandInput, diff --git a/clients/client-waf-regional/commands/UpdateSqlInjectionMatchSetCommand.ts b/clients/client-waf-regional/commands/UpdateSqlInjectionMatchSetCommand.ts index 0a2b9bdd1409..2fe41141f59e 100644 --- a/clients/client-waf-regional/commands/UpdateSqlInjectionMatchSetCommand.ts +++ b/clients/client-waf-regional/commands/UpdateSqlInjectionMatchSetCommand.ts @@ -71,6 +71,20 @@ export interface UpdateSqlInjectionMatchSetCommandOutput extends UpdateSqlInject * *

For more information about how to use the AWS WAF API to allow or block HTTP requests, see the * AWS WAF Developer Guide.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { WAFRegionalClient, UpdateSqlInjectionMatchSetCommand } from "@aws-sdk/client-waf-regional"; // ES Modules import + * // const { WAFRegionalClient, UpdateSqlInjectionMatchSetCommand } = require("@aws-sdk/client-waf-regional"); // CommonJS import + * const client = new WAFRegionalClient(config); + * const command = new UpdateSqlInjectionMatchSetCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link UpdateSqlInjectionMatchSetCommandInput} for command's `input` shape. + * @see {@link UpdateSqlInjectionMatchSetCommandOutput} for command's `response` shape. + * @see {@link WAFRegionalClientResolvedConfig | config} for command's `input` shape. + * */ export class UpdateSqlInjectionMatchSetCommand extends $Command< UpdateSqlInjectionMatchSetCommandInput, diff --git a/clients/client-waf-regional/commands/UpdateWebACLCommand.ts b/clients/client-waf-regional/commands/UpdateWebACLCommand.ts index dc2471865dd7..0cdd6f5e8fab 100644 --- a/clients/client-waf-regional/commands/UpdateWebACLCommand.ts +++ b/clients/client-waf-regional/commands/UpdateWebACLCommand.ts @@ -101,6 +101,20 @@ export interface UpdateWebACLCommandOutput extends UpdateWebACLResponse, __Metad * *

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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { WAFRegionalClient, UpdateWebACLCommand } from "@aws-sdk/client-waf-regional"; // ES Modules import + * // const { WAFRegionalClient, UpdateWebACLCommand } = require("@aws-sdk/client-waf-regional"); // CommonJS import + * const client = new WAFRegionalClient(config); + * const command = new UpdateWebACLCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link UpdateWebACLCommandInput} for command's `input` shape. + * @see {@link UpdateWebACLCommandOutput} for command's `response` shape. + * @see {@link WAFRegionalClientResolvedConfig | config} for command's `input` shape. + * */ export class UpdateWebACLCommand extends $Command< UpdateWebACLCommandInput, diff --git a/clients/client-waf-regional/commands/UpdateXssMatchSetCommand.ts b/clients/client-waf-regional/commands/UpdateXssMatchSetCommand.ts index 16c8a21ac168..8f1318387910 100644 --- a/clients/client-waf-regional/commands/UpdateXssMatchSetCommand.ts +++ b/clients/client-waf-regional/commands/UpdateXssMatchSetCommand.ts @@ -73,6 +73,20 @@ export interface UpdateXssMatchSetCommandOutput extends UpdateXssMatchSetRespons * *

For more information about how to use the AWS WAF API to allow or block HTTP requests, see the * AWS WAF Developer Guide.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { WAFRegionalClient, UpdateXssMatchSetCommand } from "@aws-sdk/client-waf-regional"; // ES Modules import + * // const { WAFRegionalClient, UpdateXssMatchSetCommand } = require("@aws-sdk/client-waf-regional"); // CommonJS import + * const client = new WAFRegionalClient(config); + * const command = new UpdateXssMatchSetCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link UpdateXssMatchSetCommandInput} for command's `input` shape. + * @see {@link UpdateXssMatchSetCommandOutput} for command's `response` shape. + * @see {@link WAFRegionalClientResolvedConfig | config} for command's `input` shape. + * */ export class UpdateXssMatchSetCommand extends $Command< UpdateXssMatchSetCommandInput, diff --git a/clients/client-waf-regional/models/models_0.ts b/clients/client-waf-regional/models/models_0.ts index 872713038e0b..2b5111855163 100644 --- a/clients/client-waf-regional/models/models_0.ts +++ b/clients/client-waf-regional/models/models_0.ts @@ -44,6 +44,9 @@ export interface WafAction { } export namespace WafAction { + /** + * @internal + */ export const filterSensitiveLog = (obj: WafAction): any => ({ ...obj, }); @@ -70,6 +73,9 @@ export interface ExcludedRule { } export namespace ExcludedRule { + /** + * @internal + */ export const filterSensitiveLog = (obj: ExcludedRule): any => ({ ...obj, }); @@ -100,6 +106,9 @@ export interface WafOverrideAction { } export namespace WafOverrideAction { + /** + * @internal + */ export const filterSensitiveLog = (obj: WafOverrideAction): any => ({ ...obj, }); @@ -231,6 +240,9 @@ export interface ActivatedRule { } export namespace ActivatedRule { + /** + * @internal + */ export const filterSensitiveLog = (obj: ActivatedRule): any => ({ ...obj, }); @@ -262,6 +274,9 @@ export interface AssociateWebACLRequest { } export namespace AssociateWebACLRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: AssociateWebACLRequest): any => ({ ...obj, }); @@ -270,6 +285,9 @@ export namespace AssociateWebACLRequest { export interface AssociateWebACLResponse {} export namespace AssociateWebACLResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: AssociateWebACLResponse): any => ({ ...obj, }); @@ -285,6 +303,9 @@ export interface WAFInternalErrorException extends __SmithyException, $MetadataB } export namespace WAFInternalErrorException { + /** + * @internal + */ export const filterSensitiveLog = (obj: WAFInternalErrorException): any => ({ ...obj, }); @@ -299,6 +320,9 @@ export interface WAFInvalidAccountException extends __SmithyException, $Metadata } export namespace WAFInvalidAccountException { + /** + * @internal + */ export const filterSensitiveLog = (obj: WAFInvalidAccountException): any => ({ ...obj, }); @@ -381,6 +405,9 @@ export interface WAFInvalidParameterException extends __SmithyException, $Metada } export namespace WAFInvalidParameterException { + /** + * @internal + */ export const filterSensitiveLog = (obj: WAFInvalidParameterException): any => ({ ...obj, }); @@ -396,6 +423,9 @@ export interface WAFNonexistentItemException extends __SmithyException, $Metadat } export namespace WAFNonexistentItemException { + /** + * @internal + */ export const filterSensitiveLog = (obj: WAFNonexistentItemException): any => ({ ...obj, }); @@ -412,6 +442,9 @@ export interface WAFUnavailableEntityException extends __SmithyException, $Metad } export namespace WAFUnavailableEntityException { + /** + * @internal + */ export const filterSensitiveLog = (obj: WAFUnavailableEntityException): any => ({ ...obj, }); @@ -431,6 +464,9 @@ export interface CreateByteMatchSetRequest { } export namespace CreateByteMatchSetRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateByteMatchSetRequest): any => ({ ...obj, }); @@ -512,6 +548,9 @@ export interface FieldToMatch { } export namespace FieldToMatch { + /** + * @internal + */ export const filterSensitiveLog = (obj: FieldToMatch): any => ({ ...obj, }); @@ -767,6 +806,9 @@ export interface ByteMatchTuple { } export namespace ByteMatchTuple { + /** + * @internal + */ export const filterSensitiveLog = (obj: ByteMatchTuple): any => ({ ...obj, }); @@ -811,6 +853,9 @@ export interface ByteMatchSet { } export namespace ByteMatchSet { + /** + * @internal + */ export const filterSensitiveLog = (obj: ByteMatchSet): any => ({ ...obj, }); @@ -830,6 +875,9 @@ export interface CreateByteMatchSetResponse { } export namespace CreateByteMatchSetResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateByteMatchSetResponse): any => ({ ...obj, }); @@ -845,6 +893,9 @@ export interface WAFDisallowedNameException extends __SmithyException, $Metadata } export namespace WAFDisallowedNameException { + /** + * @internal + */ export const filterSensitiveLog = (obj: WAFDisallowedNameException): any => ({ ...obj, }); @@ -862,6 +913,9 @@ export interface WAFLimitsExceededException extends __SmithyException, $Metadata } export namespace WAFLimitsExceededException { + /** + * @internal + */ export const filterSensitiveLog = (obj: WAFLimitsExceededException): any => ({ ...obj, }); @@ -877,6 +931,9 @@ export interface WAFStaleDataException extends __SmithyException, $MetadataBeare } export namespace WAFStaleDataException { + /** + * @internal + */ export const filterSensitiveLog = (obj: WAFStaleDataException): any => ({ ...obj, }); @@ -895,6 +952,9 @@ export interface CreateGeoMatchSetRequest { } export namespace CreateGeoMatchSetRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateGeoMatchSetRequest): any => ({ ...obj, }); @@ -1180,6 +1240,9 @@ export interface GeoMatchConstraint { } export namespace GeoMatchConstraint { + /** + * @internal + */ export const filterSensitiveLog = (obj: GeoMatchConstraint): any => ({ ...obj, }); @@ -1217,6 +1280,9 @@ export interface GeoMatchSet { } export namespace GeoMatchSet { + /** + * @internal + */ export const filterSensitiveLog = (obj: GeoMatchSet): any => ({ ...obj, }); @@ -1236,6 +1302,9 @@ export interface CreateGeoMatchSetResponse { } export namespace CreateGeoMatchSetResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateGeoMatchSetResponse): any => ({ ...obj, }); @@ -1254,6 +1323,9 @@ export interface CreateIPSetRequest { } export namespace CreateIPSetRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateIPSetRequest): any => ({ ...obj, }); @@ -1309,6 +1381,9 @@ export interface IPSetDescriptor { } export namespace IPSetDescriptor { + /** + * @internal + */ export const filterSensitiveLog = (obj: IPSetDescriptor): any => ({ ...obj, }); @@ -1354,6 +1429,9 @@ export interface IPSet { } export namespace IPSet { + /** + * @internal + */ export const filterSensitiveLog = (obj: IPSet): any => ({ ...obj, }); @@ -1373,6 +1451,9 @@ export interface CreateIPSetResponse { } export namespace CreateIPSetResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateIPSetResponse): any => ({ ...obj, }); @@ -1407,6 +1488,9 @@ export interface Tag { } export namespace Tag { + /** + * @internal + */ export const filterSensitiveLog = (obj: Tag): any => ({ ...obj, }); @@ -1458,6 +1542,9 @@ export interface CreateRateBasedRuleRequest { } export namespace CreateRateBasedRuleRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateRateBasedRuleRequest): any => ({ ...obj, }); @@ -1512,6 +1599,9 @@ export interface Predicate { } export namespace Predicate { + /** + * @internal + */ export const filterSensitiveLog = (obj: Predicate): any => ({ ...obj, }); @@ -1592,6 +1682,9 @@ export interface RateBasedRule { } export namespace RateBasedRule { + /** + * @internal + */ export const filterSensitiveLog = (obj: RateBasedRule): any => ({ ...obj, }); @@ -1613,6 +1706,9 @@ export interface CreateRateBasedRuleResponse { } export namespace CreateRateBasedRuleResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateRateBasedRuleResponse): any => ({ ...obj, }); @@ -1628,6 +1724,9 @@ export interface WAFBadRequestException extends __SmithyException, $MetadataBear } export namespace WAFBadRequestException { + /** + * @internal + */ export const filterSensitiveLog = (obj: WAFBadRequestException): any => ({ ...obj, }); @@ -1643,6 +1742,9 @@ export interface WAFTagOperationException extends __SmithyException, $MetadataBe } export namespace WAFTagOperationException { + /** + * @internal + */ export const filterSensitiveLog = (obj: WAFTagOperationException): any => ({ ...obj, }); @@ -1658,6 +1760,9 @@ export interface WAFTagOperationInternalErrorException extends __SmithyException } export namespace WAFTagOperationInternalErrorException { + /** + * @internal + */ export const filterSensitiveLog = (obj: WAFTagOperationInternalErrorException): any => ({ ...obj, }); @@ -1677,6 +1782,9 @@ export interface CreateRegexMatchSetRequest { } export namespace CreateRegexMatchSetRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateRegexMatchSetRequest): any => ({ ...obj, }); @@ -1818,6 +1926,9 @@ export interface RegexMatchTuple { } export namespace RegexMatchTuple { + /** + * @internal + */ export const filterSensitiveLog = (obj: RegexMatchTuple): any => ({ ...obj, }); @@ -1874,6 +1985,9 @@ export interface RegexMatchSet { } export namespace RegexMatchSet { + /** + * @internal + */ export const filterSensitiveLog = (obj: RegexMatchSet): any => ({ ...obj, }); @@ -1893,6 +2007,9 @@ export interface CreateRegexMatchSetResponse { } export namespace CreateRegexMatchSetResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateRegexMatchSetResponse): any => ({ ...obj, }); @@ -1912,6 +2029,9 @@ export interface CreateRegexPatternSetRequest { } export namespace CreateRegexPatternSetRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateRegexPatternSetRequest): any => ({ ...obj, }); @@ -1949,6 +2069,9 @@ export interface RegexPatternSet { } export namespace RegexPatternSet { + /** + * @internal + */ export const filterSensitiveLog = (obj: RegexPatternSet): any => ({ ...obj, }); @@ -1968,6 +2091,9 @@ export interface CreateRegexPatternSetResponse { } export namespace CreateRegexPatternSetResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateRegexPatternSetResponse): any => ({ ...obj, }); @@ -1998,6 +2124,9 @@ export interface CreateRuleRequest { } export namespace CreateRuleRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateRuleRequest): any => ({ ...obj, }); @@ -2056,6 +2185,9 @@ export interface Rule { } export namespace Rule { + /** + * @internal + */ export const filterSensitiveLog = (obj: Rule): any => ({ ...obj, }); @@ -2075,6 +2207,9 @@ export interface CreateRuleResponse { } export namespace CreateRuleResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateRuleResponse): any => ({ ...obj, }); @@ -2105,6 +2240,9 @@ export interface CreateRuleGroupRequest { } export namespace CreateRuleGroupRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateRuleGroupRequest): any => ({ ...obj, }); @@ -2156,6 +2294,9 @@ export interface RuleGroup { } export namespace RuleGroup { + /** + * @internal + */ export const filterSensitiveLog = (obj: RuleGroup): any => ({ ...obj, }); @@ -2175,6 +2316,9 @@ export interface CreateRuleGroupResponse { } export namespace CreateRuleGroupResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateRuleGroupResponse): any => ({ ...obj, }); @@ -2194,6 +2338,9 @@ export interface CreateSizeConstraintSetRequest { } export namespace CreateSizeConstraintSetRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateSizeConstraintSetRequest): any => ({ ...obj, }); @@ -2364,6 +2511,9 @@ export interface SizeConstraint { } export namespace SizeConstraint { + /** + * @internal + */ export const filterSensitiveLog = (obj: SizeConstraint): any => ({ ...obj, }); @@ -2406,6 +2556,9 @@ export interface SizeConstraintSet { } export namespace SizeConstraintSet { + /** + * @internal + */ export const filterSensitiveLog = (obj: SizeConstraintSet): any => ({ ...obj, }); @@ -2425,6 +2578,9 @@ export interface CreateSizeConstraintSetResponse { } export namespace CreateSizeConstraintSetResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateSizeConstraintSetResponse): any => ({ ...obj, }); @@ -2447,6 +2603,9 @@ export interface CreateSqlInjectionMatchSetRequest { } export namespace CreateSqlInjectionMatchSetRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateSqlInjectionMatchSetRequest): any => ({ ...obj, }); @@ -2568,6 +2727,9 @@ export interface SqlInjectionMatchTuple { } export namespace SqlInjectionMatchTuple { + /** + * @internal + */ export const filterSensitiveLog = (obj: SqlInjectionMatchTuple): any => ({ ...obj, }); @@ -2611,6 +2773,9 @@ export interface SqlInjectionMatchSet { } export namespace SqlInjectionMatchSet { + /** + * @internal + */ export const filterSensitiveLog = (obj: SqlInjectionMatchSet): any => ({ ...obj, }); @@ -2633,6 +2798,9 @@ export interface CreateSqlInjectionMatchSetResponse { } export namespace CreateSqlInjectionMatchSetResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateSqlInjectionMatchSetResponse): any => ({ ...obj, }); @@ -2669,6 +2837,9 @@ export interface CreateWebACLRequest { } export namespace CreateWebACLRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateWebACLRequest): any => ({ ...obj, }); @@ -2730,6 +2901,9 @@ export interface WebACL { } export namespace WebACL { + /** + * @internal + */ export const filterSensitiveLog = (obj: WebACL): any => ({ ...obj, }); @@ -2749,6 +2923,9 @@ export interface CreateWebACLResponse { } export namespace CreateWebACLResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateWebACLResponse): any => ({ ...obj, }); @@ -2787,6 +2964,9 @@ export interface CreateWebACLMigrationStackRequest { } export namespace CreateWebACLMigrationStackRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateWebACLMigrationStackRequest): any => ({ ...obj, }); @@ -2800,6 +2980,9 @@ export interface CreateWebACLMigrationStackResponse { } export namespace CreateWebACLMigrationStackResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateWebACLMigrationStackResponse): any => ({ ...obj, }); @@ -2857,6 +3040,9 @@ export interface WAFEntityMigrationException extends __SmithyException, $Metadat } export namespace WAFEntityMigrationException { + /** + * @internal + */ export const filterSensitiveLog = (obj: WAFEntityMigrationException): any => ({ ...obj, }); @@ -2892,6 +3078,9 @@ export interface WAFInvalidOperationException extends __SmithyException, $Metada } export namespace WAFInvalidOperationException { + /** + * @internal + */ export const filterSensitiveLog = (obj: WAFInvalidOperationException): any => ({ ...obj, }); @@ -2914,6 +3103,9 @@ export interface CreateXssMatchSetRequest { } export namespace CreateXssMatchSetRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateXssMatchSetRequest): any => ({ ...obj, }); @@ -3035,6 +3227,9 @@ export interface XssMatchTuple { } export namespace XssMatchTuple { + /** + * @internal + */ export const filterSensitiveLog = (obj: XssMatchTuple): any => ({ ...obj, }); @@ -3078,6 +3273,9 @@ export interface XssMatchSet { } export namespace XssMatchSet { + /** + * @internal + */ export const filterSensitiveLog = (obj: XssMatchSet): any => ({ ...obj, }); @@ -3100,6 +3298,9 @@ export interface CreateXssMatchSetResponse { } export namespace CreateXssMatchSetResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateXssMatchSetResponse): any => ({ ...obj, }); @@ -3119,6 +3320,9 @@ export interface DeleteByteMatchSetRequest { } export namespace DeleteByteMatchSetRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteByteMatchSetRequest): any => ({ ...obj, }); @@ -3133,6 +3337,9 @@ export interface DeleteByteMatchSetResponse { } export namespace DeleteByteMatchSetResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteByteMatchSetResponse): any => ({ ...obj, }); @@ -3163,6 +3370,9 @@ export interface WAFNonEmptyEntityException extends __SmithyException, $Metadata } export namespace WAFNonEmptyEntityException { + /** + * @internal + */ export const filterSensitiveLog = (obj: WAFNonEmptyEntityException): any => ({ ...obj, }); @@ -3186,6 +3396,9 @@ export interface WAFReferencedItemException extends __SmithyException, $Metadata } export namespace WAFReferencedItemException { + /** + * @internal + */ export const filterSensitiveLog = (obj: WAFReferencedItemException): any => ({ ...obj, }); @@ -3205,6 +3418,9 @@ export interface DeleteGeoMatchSetRequest { } export namespace DeleteGeoMatchSetRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteGeoMatchSetRequest): any => ({ ...obj, }); @@ -3219,6 +3435,9 @@ export interface DeleteGeoMatchSetResponse { } export namespace DeleteGeoMatchSetResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteGeoMatchSetResponse): any => ({ ...obj, }); @@ -3238,6 +3457,9 @@ export interface DeleteIPSetRequest { } export namespace DeleteIPSetRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteIPSetRequest): any => ({ ...obj, }); @@ -3252,6 +3474,9 @@ export interface DeleteIPSetResponse { } export namespace DeleteIPSetResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteIPSetResponse): any => ({ ...obj, }); @@ -3265,6 +3490,9 @@ export interface DeleteLoggingConfigurationRequest { } export namespace DeleteLoggingConfigurationRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteLoggingConfigurationRequest): any => ({ ...obj, }); @@ -3273,6 +3501,9 @@ export namespace DeleteLoggingConfigurationRequest { export interface DeleteLoggingConfigurationResponse {} export namespace DeleteLoggingConfigurationResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteLoggingConfigurationResponse): any => ({ ...obj, }); @@ -3287,6 +3518,9 @@ export interface DeletePermissionPolicyRequest { } export namespace DeletePermissionPolicyRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeletePermissionPolicyRequest): any => ({ ...obj, }); @@ -3295,6 +3529,9 @@ export namespace DeletePermissionPolicyRequest { export interface DeletePermissionPolicyResponse {} export namespace DeletePermissionPolicyResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeletePermissionPolicyResponse): any => ({ ...obj, }); @@ -3315,6 +3552,9 @@ export interface DeleteRateBasedRuleRequest { } export namespace DeleteRateBasedRuleRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteRateBasedRuleRequest): any => ({ ...obj, }); @@ -3330,6 +3570,9 @@ export interface DeleteRateBasedRuleResponse { } export namespace DeleteRateBasedRuleResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteRateBasedRuleResponse): any => ({ ...obj, }); @@ -3349,6 +3592,9 @@ export interface DeleteRegexMatchSetRequest { } export namespace DeleteRegexMatchSetRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteRegexMatchSetRequest): any => ({ ...obj, }); @@ -3363,6 +3609,9 @@ export interface DeleteRegexMatchSetResponse { } export namespace DeleteRegexMatchSetResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteRegexMatchSetResponse): any => ({ ...obj, }); @@ -3382,6 +3631,9 @@ export interface DeleteRegexPatternSetRequest { } export namespace DeleteRegexPatternSetRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteRegexPatternSetRequest): any => ({ ...obj, }); @@ -3396,6 +3648,9 @@ export interface DeleteRegexPatternSetResponse { } export namespace DeleteRegexPatternSetResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteRegexPatternSetResponse): any => ({ ...obj, }); @@ -3415,6 +3670,9 @@ export interface DeleteRuleRequest { } export namespace DeleteRuleRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteRuleRequest): any => ({ ...obj, }); @@ -3429,6 +3687,9 @@ export interface DeleteRuleResponse { } export namespace DeleteRuleResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteRuleResponse): any => ({ ...obj, }); @@ -3448,6 +3709,9 @@ export interface DeleteRuleGroupRequest { } export namespace DeleteRuleGroupRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteRuleGroupRequest): any => ({ ...obj, }); @@ -3462,6 +3726,9 @@ export interface DeleteRuleGroupResponse { } export namespace DeleteRuleGroupResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteRuleGroupResponse): any => ({ ...obj, }); @@ -3481,6 +3748,9 @@ export interface DeleteSizeConstraintSetRequest { } export namespace DeleteSizeConstraintSetRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteSizeConstraintSetRequest): any => ({ ...obj, }); @@ -3495,6 +3765,9 @@ export interface DeleteSizeConstraintSetResponse { } export namespace DeleteSizeConstraintSetResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteSizeConstraintSetResponse): any => ({ ...obj, }); @@ -3517,6 +3790,9 @@ export interface DeleteSqlInjectionMatchSetRequest { } export namespace DeleteSqlInjectionMatchSetRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteSqlInjectionMatchSetRequest): any => ({ ...obj, }); @@ -3534,6 +3810,9 @@ export interface DeleteSqlInjectionMatchSetResponse { } export namespace DeleteSqlInjectionMatchSetResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteSqlInjectionMatchSetResponse): any => ({ ...obj, }); @@ -3553,6 +3832,9 @@ export interface DeleteWebACLRequest { } export namespace DeleteWebACLRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteWebACLRequest): any => ({ ...obj, }); @@ -3567,6 +3849,9 @@ export interface DeleteWebACLResponse { } export namespace DeleteWebACLResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteWebACLResponse): any => ({ ...obj, }); @@ -3589,6 +3874,9 @@ export interface DeleteXssMatchSetRequest { } export namespace DeleteXssMatchSetRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteXssMatchSetRequest): any => ({ ...obj, }); @@ -3606,6 +3894,9 @@ export interface DeleteXssMatchSetResponse { } export namespace DeleteXssMatchSetResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteXssMatchSetResponse): any => ({ ...obj, }); @@ -3632,6 +3923,9 @@ export interface DisassociateWebACLRequest { } export namespace DisassociateWebACLRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DisassociateWebACLRequest): any => ({ ...obj, }); @@ -3640,6 +3934,9 @@ export namespace DisassociateWebACLRequest { export interface DisassociateWebACLResponse {} export namespace DisassociateWebACLResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DisassociateWebACLResponse): any => ({ ...obj, }); @@ -3654,6 +3951,9 @@ export interface GetByteMatchSetRequest { } export namespace GetByteMatchSetRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetByteMatchSetRequest): any => ({ ...obj, }); @@ -3687,6 +3987,9 @@ export interface GetByteMatchSetResponse { } export namespace GetByteMatchSetResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetByteMatchSetResponse): any => ({ ...obj, }); @@ -3695,6 +3998,9 @@ export namespace GetByteMatchSetResponse { export interface GetChangeTokenRequest {} export namespace GetChangeTokenRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetChangeTokenRequest): any => ({ ...obj, }); @@ -3709,6 +4015,9 @@ export interface GetChangeTokenResponse { } export namespace GetChangeTokenResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetChangeTokenResponse): any => ({ ...obj, }); @@ -3722,6 +4031,9 @@ export interface GetChangeTokenStatusRequest { } export namespace GetChangeTokenStatusRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetChangeTokenStatusRequest): any => ({ ...obj, }); @@ -3741,6 +4053,9 @@ export interface GetChangeTokenStatusResponse { } export namespace GetChangeTokenStatusResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetChangeTokenStatusResponse): any => ({ ...obj, }); @@ -3755,6 +4070,9 @@ export interface GetGeoMatchSetRequest { } export namespace GetGeoMatchSetRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetGeoMatchSetRequest): any => ({ ...obj, }); @@ -3768,6 +4086,9 @@ export interface GetGeoMatchSetResponse { } export namespace GetGeoMatchSetResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetGeoMatchSetResponse): any => ({ ...obj, }); @@ -3782,6 +4103,9 @@ export interface GetIPSetRequest { } export namespace GetIPSetRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetIPSetRequest): any => ({ ...obj, }); @@ -3809,6 +4133,9 @@ export interface GetIPSetResponse { } export namespace GetIPSetResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetIPSetResponse): any => ({ ...obj, }); @@ -3822,6 +4149,9 @@ export interface GetLoggingConfigurationRequest { } export namespace GetLoggingConfigurationRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetLoggingConfigurationRequest): any => ({ ...obj, }); @@ -3861,6 +4191,9 @@ export interface LoggingConfiguration { } export namespace LoggingConfiguration { + /** + * @internal + */ export const filterSensitiveLog = (obj: LoggingConfiguration): any => ({ ...obj, }); @@ -3874,6 +4207,9 @@ export interface GetLoggingConfigurationResponse { } export namespace GetLoggingConfigurationResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetLoggingConfigurationResponse): any => ({ ...obj, }); @@ -3887,6 +4223,9 @@ export interface GetPermissionPolicyRequest { } export namespace GetPermissionPolicyRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetPermissionPolicyRequest): any => ({ ...obj, }); @@ -3900,6 +4239,9 @@ export interface GetPermissionPolicyResponse { } export namespace GetPermissionPolicyResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetPermissionPolicyResponse): any => ({ ...obj, }); @@ -3914,6 +4256,9 @@ export interface GetRateBasedRuleRequest { } export namespace GetRateBasedRuleRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetRateBasedRuleRequest): any => ({ ...obj, }); @@ -3928,6 +4273,9 @@ export interface GetRateBasedRuleResponse { } export namespace GetRateBasedRuleResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetRateBasedRuleResponse): any => ({ ...obj, }); @@ -3947,6 +4295,9 @@ export interface GetRateBasedRuleManagedKeysRequest { } export namespace GetRateBasedRuleManagedKeysRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetRateBasedRuleManagedKeysRequest): any => ({ ...obj, }); @@ -3965,6 +4316,9 @@ export interface GetRateBasedRuleManagedKeysResponse { } export namespace GetRateBasedRuleManagedKeysResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetRateBasedRuleManagedKeysResponse): any => ({ ...obj, }); @@ -3979,6 +4333,9 @@ export interface GetRegexMatchSetRequest { } export namespace GetRegexMatchSetRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetRegexMatchSetRequest): any => ({ ...obj, }); @@ -3992,6 +4349,9 @@ export interface GetRegexMatchSetResponse { } export namespace GetRegexMatchSetResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetRegexMatchSetResponse): any => ({ ...obj, }); @@ -4006,6 +4366,9 @@ export interface GetRegexPatternSetRequest { } export namespace GetRegexPatternSetRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetRegexPatternSetRequest): any => ({ ...obj, }); @@ -4019,6 +4382,9 @@ export interface GetRegexPatternSetResponse { } export namespace GetRegexPatternSetResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetRegexPatternSetResponse): any => ({ ...obj, }); @@ -4033,6 +4399,9 @@ export interface GetRuleRequest { } export namespace GetRuleRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetRuleRequest): any => ({ ...obj, }); @@ -4061,6 +4430,9 @@ export interface GetRuleResponse { } export namespace GetRuleResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetRuleResponse): any => ({ ...obj, }); @@ -4075,6 +4447,9 @@ export interface GetRuleGroupRequest { } export namespace GetRuleGroupRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetRuleGroupRequest): any => ({ ...obj, }); @@ -4088,6 +4463,9 @@ export interface GetRuleGroupResponse { } export namespace GetRuleGroupResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetRuleGroupResponse): any => ({ ...obj, }); @@ -4131,6 +4509,9 @@ export interface TimeWindow { } export namespace TimeWindow { + /** + * @internal + */ export const filterSensitiveLog = (obj: TimeWindow): any => ({ ...obj, }); @@ -4174,6 +4555,9 @@ export interface GetSampledRequestsRequest { } export namespace GetSampledRequestsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetSampledRequestsRequest): any => ({ ...obj, }); @@ -4205,6 +4589,9 @@ export interface HTTPHeader { } export namespace HTTPHeader { + /** + * @internal + */ export const filterSensitiveLog = (obj: HTTPHeader): any => ({ ...obj, }); @@ -4269,6 +4656,9 @@ export interface HTTPRequest { } export namespace HTTPRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: HTTPRequest): any => ({ ...obj, }); @@ -4317,6 +4707,9 @@ export interface SampledHTTPRequest { } export namespace SampledHTTPRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: SampledHTTPRequest): any => ({ ...obj, }); @@ -4344,6 +4737,9 @@ export interface GetSampledRequestsResponse { } export namespace GetSampledRequestsResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetSampledRequestsResponse): any => ({ ...obj, }); @@ -4358,6 +4754,9 @@ export interface GetSizeConstraintSetRequest { } export namespace GetSizeConstraintSetRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetSizeConstraintSetRequest): any => ({ ...obj, }); @@ -4391,6 +4790,9 @@ export interface GetSizeConstraintSetResponse { } export namespace GetSizeConstraintSetResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetSizeConstraintSetResponse): any => ({ ...obj, }); @@ -4408,6 +4810,9 @@ export interface GetSqlInjectionMatchSetRequest { } export namespace GetSqlInjectionMatchSetRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetSqlInjectionMatchSetRequest): any => ({ ...obj, }); @@ -4443,6 +4848,9 @@ export interface GetSqlInjectionMatchSetResponse { } export namespace GetSqlInjectionMatchSetResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetSqlInjectionMatchSetResponse): any => ({ ...obj, }); @@ -4457,6 +4865,9 @@ export interface GetWebACLRequest { } export namespace GetWebACLRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetWebACLRequest): any => ({ ...obj, }); @@ -4495,6 +4906,9 @@ export interface GetWebACLResponse { } export namespace GetWebACLResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetWebACLResponse): any => ({ ...obj, }); @@ -4521,6 +4935,9 @@ export interface GetWebACLForResourceRequest { } export namespace GetWebACLForResourceRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetWebACLForResourceRequest): any => ({ ...obj, }); @@ -4554,6 +4971,9 @@ export interface WebACLSummary { } export namespace WebACLSummary { + /** + * @internal + */ export const filterSensitiveLog = (obj: WebACLSummary): any => ({ ...obj, }); @@ -4567,6 +4987,9 @@ export interface GetWebACLForResourceResponse { } export namespace GetWebACLForResourceResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetWebACLForResourceResponse): any => ({ ...obj, }); @@ -4584,6 +5007,9 @@ export interface GetXssMatchSetRequest { } export namespace GetXssMatchSetRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetXssMatchSetRequest): any => ({ ...obj, }); @@ -4619,6 +5045,9 @@ export interface GetXssMatchSetResponse { } export namespace GetXssMatchSetResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetXssMatchSetResponse): any => ({ ...obj, }); @@ -4646,6 +5075,9 @@ export interface ListActivatedRulesInRuleGroupRequest { } export namespace ListActivatedRulesInRuleGroupRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListActivatedRulesInRuleGroupRequest): any => ({ ...obj, }); @@ -4664,6 +5096,9 @@ export interface ListActivatedRulesInRuleGroupResponse { } export namespace ListActivatedRulesInRuleGroupResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListActivatedRulesInRuleGroupResponse): any => ({ ...obj, }); @@ -4687,6 +5122,9 @@ export interface ListByteMatchSetsRequest { } export namespace ListByteMatchSetsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListByteMatchSetsRequest): any => ({ ...obj, }); @@ -4720,6 +5158,9 @@ export interface ByteMatchSetSummary { } export namespace ByteMatchSetSummary { + /** + * @internal + */ export const filterSensitiveLog = (obj: ByteMatchSetSummary): any => ({ ...obj, }); @@ -4741,6 +5182,9 @@ export interface ListByteMatchSetsResponse { } export namespace ListByteMatchSetsResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListByteMatchSetsResponse): any => ({ ...obj, }); @@ -4764,6 +5208,9 @@ export interface ListGeoMatchSetsRequest { } export namespace ListGeoMatchSetsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListGeoMatchSetsRequest): any => ({ ...obj, }); @@ -4793,6 +5240,9 @@ export interface GeoMatchSetSummary { } export namespace GeoMatchSetSummary { + /** + * @internal + */ export const filterSensitiveLog = (obj: GeoMatchSetSummary): any => ({ ...obj, }); @@ -4814,6 +5264,9 @@ export interface ListGeoMatchSetsResponse { } export namespace ListGeoMatchSetsResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListGeoMatchSetsResponse): any => ({ ...obj, }); @@ -4837,6 +5290,9 @@ export interface ListIPSetsRequest { } export namespace ListIPSetsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListIPSetsRequest): any => ({ ...obj, }); @@ -4867,6 +5323,9 @@ export interface IPSetSummary { } export namespace IPSetSummary { + /** + * @internal + */ export const filterSensitiveLog = (obj: IPSetSummary): any => ({ ...obj, }); @@ -4887,6 +5346,9 @@ export interface ListIPSetsResponse { } export namespace ListIPSetsResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListIPSetsResponse): any => ({ ...obj, }); @@ -4908,6 +5370,9 @@ export interface ListLoggingConfigurationsRequest { } export namespace ListLoggingConfigurationsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListLoggingConfigurationsRequest): any => ({ ...obj, }); @@ -4926,6 +5391,9 @@ export interface ListLoggingConfigurationsResponse { } export namespace ListLoggingConfigurationsResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListLoggingConfigurationsResponse): any => ({ ...obj, }); @@ -4952,6 +5420,9 @@ export interface ListRateBasedRulesRequest { } export namespace ListRateBasedRulesRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListRateBasedRulesRequest): any => ({ ...obj, }); @@ -4985,6 +5456,9 @@ export interface RuleSummary { } export namespace RuleSummary { + /** + * @internal + */ export const filterSensitiveLog = (obj: RuleSummary): any => ({ ...obj, }); @@ -5007,6 +5481,9 @@ export interface ListRateBasedRulesResponse { } export namespace ListRateBasedRulesResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListRateBasedRulesResponse): any => ({ ...obj, }); @@ -5030,6 +5507,9 @@ export interface ListRegexMatchSetsRequest { } export namespace ListRegexMatchSetsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListRegexMatchSetsRequest): any => ({ ...obj, }); @@ -5063,6 +5543,9 @@ export interface RegexMatchSetSummary { } export namespace RegexMatchSetSummary { + /** + * @internal + */ export const filterSensitiveLog = (obj: RegexMatchSetSummary): any => ({ ...obj, }); @@ -5084,6 +5567,9 @@ export interface ListRegexMatchSetsResponse { } export namespace ListRegexMatchSetsResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListRegexMatchSetsResponse): any => ({ ...obj, }); @@ -5107,6 +5593,9 @@ export interface ListRegexPatternSetsRequest { } export namespace ListRegexPatternSetsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListRegexPatternSetsRequest): any => ({ ...obj, }); @@ -5140,6 +5629,9 @@ export interface RegexPatternSetSummary { } export namespace RegexPatternSetSummary { + /** + * @internal + */ export const filterSensitiveLog = (obj: RegexPatternSetSummary): any => ({ ...obj, }); @@ -5161,6 +5653,9 @@ export interface ListRegexPatternSetsResponse { } export namespace ListRegexPatternSetsResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListRegexPatternSetsResponse): any => ({ ...obj, }); @@ -5184,6 +5679,9 @@ export interface ListResourcesForWebACLRequest { } export namespace ListResourcesForWebACLRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListResourcesForWebACLRequest): any => ({ ...obj, }); @@ -5197,6 +5695,9 @@ export interface ListResourcesForWebACLResponse { } export namespace ListResourcesForWebACLResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListResourcesForWebACLResponse): any => ({ ...obj, }); @@ -5218,6 +5719,9 @@ export interface ListRuleGroupsRequest { } export namespace ListRuleGroupsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListRuleGroupsRequest): any => ({ ...obj, }); @@ -5251,6 +5755,9 @@ export interface RuleGroupSummary { } export namespace RuleGroupSummary { + /** + * @internal + */ export const filterSensitiveLog = (obj: RuleGroupSummary): any => ({ ...obj, }); @@ -5269,6 +5776,9 @@ export interface ListRuleGroupsResponse { } export namespace ListRuleGroupsResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListRuleGroupsResponse): any => ({ ...obj, }); @@ -5291,6 +5801,9 @@ export interface ListRulesRequest { } export namespace ListRulesRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListRulesRequest): any => ({ ...obj, }); @@ -5311,6 +5824,9 @@ export interface ListRulesResponse { } export namespace ListRulesResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListRulesResponse): any => ({ ...obj, }); @@ -5333,6 +5849,9 @@ export interface ListSizeConstraintSetsRequest { } export namespace ListSizeConstraintSetsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListSizeConstraintSetsRequest): any => ({ ...obj, }); @@ -5368,6 +5887,9 @@ export interface SizeConstraintSetSummary { } export namespace SizeConstraintSetSummary { + /** + * @internal + */ export const filterSensitiveLog = (obj: SizeConstraintSetSummary): any => ({ ...obj, }); @@ -5389,6 +5911,9 @@ export interface ListSizeConstraintSetsResponse { } export namespace ListSizeConstraintSetsResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListSizeConstraintSetsResponse): any => ({ ...obj, }); @@ -5415,6 +5940,9 @@ export interface ListSqlInjectionMatchSetsRequest { } export namespace ListSqlInjectionMatchSetsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListSqlInjectionMatchSetsRequest): any => ({ ...obj, }); @@ -5450,6 +5978,9 @@ export interface SqlInjectionMatchSetSummary { } export namespace SqlInjectionMatchSetSummary { + /** + * @internal + */ export const filterSensitiveLog = (obj: SqlInjectionMatchSetSummary): any => ({ ...obj, }); @@ -5474,6 +6005,9 @@ export interface ListSqlInjectionMatchSetsResponse { } export namespace ListSqlInjectionMatchSetsResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListSqlInjectionMatchSetsResponse): any => ({ ...obj, }); @@ -5497,6 +6031,9 @@ export interface ListSubscribedRuleGroupsRequest { } export namespace ListSubscribedRuleGroupsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListSubscribedRuleGroupsRequest): any => ({ ...obj, }); @@ -5532,6 +6069,9 @@ export interface SubscribedRuleGroupSummary { } export namespace SubscribedRuleGroupSummary { + /** + * @internal + */ export const filterSensitiveLog = (obj: SubscribedRuleGroupSummary): any => ({ ...obj, }); @@ -5553,6 +6093,9 @@ export interface ListSubscribedRuleGroupsResponse { } export namespace ListSubscribedRuleGroupsResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListSubscribedRuleGroupsResponse): any => ({ ...obj, }); @@ -5576,6 +6119,9 @@ export interface ListTagsForResourceRequest { } export namespace ListTagsForResourceRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListTagsForResourceRequest): any => ({ ...obj, }); @@ -5606,6 +6152,9 @@ export interface TagInfoForResource { } export namespace TagInfoForResource { + /** + * @internal + */ export const filterSensitiveLog = (obj: TagInfoForResource): any => ({ ...obj, }); @@ -5624,6 +6173,9 @@ export interface ListTagsForResourceResponse { } export namespace ListTagsForResourceResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListTagsForResourceResponse): any => ({ ...obj, }); @@ -5647,6 +6199,9 @@ export interface ListWebACLsRequest { } export namespace ListWebACLsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListWebACLsRequest): any => ({ ...obj, }); @@ -5668,6 +6223,9 @@ export interface ListWebACLsResponse { } export namespace ListWebACLsResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListWebACLsResponse): any => ({ ...obj, }); @@ -5694,6 +6252,9 @@ export interface ListXssMatchSetsRequest { } export namespace ListXssMatchSetsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListXssMatchSetsRequest): any => ({ ...obj, }); @@ -5729,6 +6290,9 @@ export interface XssMatchSetSummary { } export namespace XssMatchSetSummary { + /** + * @internal + */ export const filterSensitiveLog = (obj: XssMatchSetSummary): any => ({ ...obj, }); @@ -5753,6 +6317,9 @@ export interface ListXssMatchSetsResponse { } export namespace ListXssMatchSetsResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListXssMatchSetsResponse): any => ({ ...obj, }); @@ -5773,6 +6340,9 @@ export interface PutLoggingConfigurationRequest { } export namespace PutLoggingConfigurationRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: PutLoggingConfigurationRequest): any => ({ ...obj, }); @@ -5786,6 +6356,9 @@ export interface PutLoggingConfigurationResponse { } export namespace PutLoggingConfigurationResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: PutLoggingConfigurationResponse): any => ({ ...obj, }); @@ -5801,6 +6374,9 @@ export interface WAFServiceLinkedRoleErrorException extends __SmithyException, $ } export namespace WAFServiceLinkedRoleErrorException { + /** + * @internal + */ export const filterSensitiveLog = (obj: WAFServiceLinkedRoleErrorException): any => ({ ...obj, }); @@ -5819,6 +6395,9 @@ export interface PutPermissionPolicyRequest { } export namespace PutPermissionPolicyRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: PutPermissionPolicyRequest): any => ({ ...obj, }); @@ -5827,6 +6406,9 @@ export namespace PutPermissionPolicyRequest { export interface PutPermissionPolicyResponse {} export namespace PutPermissionPolicyResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: PutPermissionPolicyResponse): any => ({ ...obj, }); @@ -5871,6 +6453,9 @@ export interface WAFInvalidPermissionPolicyException extends __SmithyException, } export namespace WAFInvalidPermissionPolicyException { + /** + * @internal + */ export const filterSensitiveLog = (obj: WAFInvalidPermissionPolicyException): any => ({ ...obj, }); @@ -5889,6 +6474,9 @@ export interface TagResourceRequest { } export namespace TagResourceRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: TagResourceRequest): any => ({ ...obj, }); @@ -5897,6 +6485,9 @@ export namespace TagResourceRequest { export interface TagResourceResponse {} export namespace TagResourceResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: TagResourceResponse): any => ({ ...obj, }); @@ -5915,6 +6506,9 @@ export interface UntagResourceRequest { } export namespace UntagResourceRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: UntagResourceRequest): any => ({ ...obj, }); @@ -5923,6 +6517,9 @@ export namespace UntagResourceRequest { export interface UntagResourceResponse {} export namespace UntagResourceResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: UntagResourceResponse): any => ({ ...obj, }); @@ -5960,6 +6557,9 @@ export interface ByteMatchSetUpdate { } export namespace ByteMatchSetUpdate { + /** + * @internal + */ export const filterSensitiveLog = (obj: ByteMatchSetUpdate): any => ({ ...obj, }); @@ -6003,6 +6603,9 @@ export interface UpdateByteMatchSetRequest { } export namespace UpdateByteMatchSetRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateByteMatchSetRequest): any => ({ ...obj, }); @@ -6017,6 +6620,9 @@ export interface UpdateByteMatchSetResponse { } export namespace UpdateByteMatchSetResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateByteMatchSetResponse): any => ({ ...obj, }); @@ -6047,6 +6653,9 @@ export interface WAFNonexistentContainerException extends __SmithyException, $Me } export namespace WAFNonexistentContainerException { + /** + * @internal + */ export const filterSensitiveLog = (obj: WAFNonexistentContainerException): any => ({ ...obj, }); @@ -6076,6 +6685,9 @@ export interface GeoMatchSetUpdate { } export namespace GeoMatchSetUpdate { + /** + * @internal + */ export const filterSensitiveLog = (obj: GeoMatchSetUpdate): any => ({ ...obj, }); @@ -6114,6 +6726,9 @@ export interface UpdateGeoMatchSetRequest { } export namespace UpdateGeoMatchSetRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateGeoMatchSetRequest): any => ({ ...obj, }); @@ -6128,6 +6743,9 @@ export interface UpdateGeoMatchSetResponse { } export namespace UpdateGeoMatchSetResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateGeoMatchSetResponse): any => ({ ...obj, }); @@ -6157,6 +6775,9 @@ export interface IPSetUpdate { } export namespace IPSetUpdate { + /** + * @internal + */ export const filterSensitiveLog = (obj: IPSetUpdate): any => ({ ...obj, }); @@ -6195,6 +6816,9 @@ export interface UpdateIPSetRequest { } export namespace UpdateIPSetRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateIPSetRequest): any => ({ ...obj, }); @@ -6209,6 +6833,9 @@ export interface UpdateIPSetResponse { } export namespace UpdateIPSetResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateIPSetResponse): any => ({ ...obj, }); @@ -6240,6 +6867,9 @@ export interface RuleUpdate { } export namespace RuleUpdate { + /** + * @internal + */ export const filterSensitiveLog = (obj: RuleUpdate): any => ({ ...obj, }); @@ -6273,6 +6903,9 @@ export interface UpdateRateBasedRuleRequest { } export namespace UpdateRateBasedRuleRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateRateBasedRuleRequest): any => ({ ...obj, }); @@ -6288,6 +6921,9 @@ export interface UpdateRateBasedRuleResponse { } export namespace UpdateRateBasedRuleResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateRateBasedRuleResponse): any => ({ ...obj, }); @@ -6320,6 +6956,9 @@ export interface RegexMatchSetUpdate { } export namespace RegexMatchSetUpdate { + /** + * @internal + */ export const filterSensitiveLog = (obj: RegexMatchSetUpdate): any => ({ ...obj, }); @@ -6345,6 +6984,9 @@ export interface UpdateRegexMatchSetRequest { } export namespace UpdateRegexMatchSetRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateRegexMatchSetRequest): any => ({ ...obj, }); @@ -6359,6 +7001,9 @@ export interface UpdateRegexMatchSetResponse { } export namespace UpdateRegexMatchSetResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateRegexMatchSetResponse): any => ({ ...obj, }); @@ -6389,6 +7034,9 @@ export interface RegexPatternSetUpdate { } export namespace RegexPatternSetUpdate { + /** + * @internal + */ export const filterSensitiveLog = (obj: RegexPatternSetUpdate): any => ({ ...obj, }); @@ -6413,6 +7061,9 @@ export interface UpdateRegexPatternSetRequest { } export namespace UpdateRegexPatternSetRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateRegexPatternSetRequest): any => ({ ...obj, }); @@ -6427,6 +7078,9 @@ export interface UpdateRegexPatternSetResponse { } export namespace UpdateRegexPatternSetResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateRegexPatternSetResponse): any => ({ ...obj, }); @@ -6442,6 +7096,9 @@ export interface WAFInvalidRegexPatternException extends __SmithyException, $Met } export namespace WAFInvalidRegexPatternException { + /** + * @internal + */ export const filterSensitiveLog = (obj: WAFInvalidRegexPatternException): any => ({ ...obj, }); @@ -6484,6 +7141,9 @@ export interface UpdateRuleRequest { } export namespace UpdateRuleRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateRuleRequest): any => ({ ...obj, }); @@ -6498,6 +7158,9 @@ export interface UpdateRuleResponse { } export namespace UpdateRuleResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateRuleResponse): any => ({ ...obj, }); @@ -6531,6 +7194,9 @@ export interface RuleGroupUpdate { } export namespace RuleGroupUpdate { + /** + * @internal + */ export const filterSensitiveLog = (obj: RuleGroupUpdate): any => ({ ...obj, }); @@ -6559,6 +7225,9 @@ export interface UpdateRuleGroupRequest { } export namespace UpdateRuleGroupRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateRuleGroupRequest): any => ({ ...obj, }); @@ -6573,6 +7242,9 @@ export interface UpdateRuleGroupResponse { } export namespace UpdateRuleGroupResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateRuleGroupResponse): any => ({ ...obj, }); @@ -6607,6 +7279,9 @@ export interface SizeConstraintSetUpdate { } export namespace SizeConstraintSetUpdate { + /** + * @internal + */ export const filterSensitiveLog = (obj: SizeConstraintSetUpdate): any => ({ ...obj, }); @@ -6650,6 +7325,9 @@ export interface UpdateSizeConstraintSetRequest { } export namespace UpdateSizeConstraintSetRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateSizeConstraintSetRequest): any => ({ ...obj, }); @@ -6664,6 +7342,9 @@ export interface UpdateSizeConstraintSetResponse { } export namespace UpdateSizeConstraintSetResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateSizeConstraintSetResponse): any => ({ ...obj, }); @@ -6695,6 +7376,9 @@ export interface SqlInjectionMatchSetUpdate { } export namespace SqlInjectionMatchSetUpdate { + /** + * @internal + */ export const filterSensitiveLog = (obj: SqlInjectionMatchSetUpdate): any => ({ ...obj, }); @@ -6740,6 +7424,9 @@ export interface UpdateSqlInjectionMatchSetRequest { } export namespace UpdateSqlInjectionMatchSetRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateSqlInjectionMatchSetRequest): any => ({ ...obj, }); @@ -6757,6 +7444,9 @@ export interface UpdateSqlInjectionMatchSetResponse { } export namespace UpdateSqlInjectionMatchSetResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateSqlInjectionMatchSetResponse): any => ({ ...obj, }); @@ -6788,6 +7478,9 @@ export interface WebACLUpdate { } export namespace WebACLUpdate { + /** + * @internal + */ export const filterSensitiveLog = (obj: WebACLUpdate): any => ({ ...obj, }); @@ -6843,6 +7536,9 @@ export interface UpdateWebACLRequest { } export namespace UpdateWebACLRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateWebACLRequest): any => ({ ...obj, }); @@ -6857,6 +7553,9 @@ export interface UpdateWebACLResponse { } export namespace UpdateWebACLResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateWebACLResponse): any => ({ ...obj, }); @@ -6872,6 +7571,9 @@ export interface WAFSubscriptionNotFoundException extends __SmithyException, $Me } export namespace WAFSubscriptionNotFoundException { + /** + * @internal + */ export const filterSensitiveLog = (obj: WAFSubscriptionNotFoundException): any => ({ ...obj, }); @@ -6905,6 +7607,9 @@ export interface XssMatchSetUpdate { } export namespace XssMatchSetUpdate { + /** + * @internal + */ export const filterSensitiveLog = (obj: XssMatchSetUpdate): any => ({ ...obj, }); @@ -6952,6 +7657,9 @@ export interface UpdateXssMatchSetRequest { } export namespace UpdateXssMatchSetRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateXssMatchSetRequest): any => ({ ...obj, }); @@ -6969,6 +7677,9 @@ export interface UpdateXssMatchSetResponse { } export namespace UpdateXssMatchSetResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateXssMatchSetResponse): any => ({ ...obj, }); diff --git a/clients/client-waf/commands/CreateByteMatchSetCommand.ts b/clients/client-waf/commands/CreateByteMatchSetCommand.ts index 0a3e6aba8223..3ed966de125d 100644 --- a/clients/client-waf/commands/CreateByteMatchSetCommand.ts +++ b/clients/client-waf/commands/CreateByteMatchSetCommand.ts @@ -53,6 +53,20 @@ export interface CreateByteMatchSetCommandOutput extends CreateByteMatchSetRespo * *

For more information about how to use the AWS WAF API to allow or block HTTP requests, see the * AWS WAF Developer Guide.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { WAFClient, CreateByteMatchSetCommand } from "@aws-sdk/client-waf"; // ES Modules import + * // const { WAFClient, CreateByteMatchSetCommand } = require("@aws-sdk/client-waf"); // CommonJS import + * const client = new WAFClient(config); + * const command = new CreateByteMatchSetCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreateByteMatchSetCommandInput} for command's `input` shape. + * @see {@link CreateByteMatchSetCommandOutput} for command's `response` shape. + * @see {@link WAFClientResolvedConfig | config} for command's `input` shape. + * */ export class CreateByteMatchSetCommand extends $Command< CreateByteMatchSetCommandInput, diff --git a/clients/client-waf/commands/CreateGeoMatchSetCommand.ts b/clients/client-waf/commands/CreateGeoMatchSetCommand.ts index 00bdabeb76f0..bc9a34ac8ab0 100644 --- a/clients/client-waf/commands/CreateGeoMatchSetCommand.ts +++ b/clients/client-waf/commands/CreateGeoMatchSetCommand.ts @@ -50,6 +50,20 @@ export interface CreateGeoMatchSetCommandOutput extends CreateGeoMatchSetRespons * *

For more information about how to use the AWS WAF API to allow or block HTTP requests, see the * AWS WAF Developer Guide.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { WAFClient, CreateGeoMatchSetCommand } from "@aws-sdk/client-waf"; // ES Modules import + * // const { WAFClient, CreateGeoMatchSetCommand } = require("@aws-sdk/client-waf"); // CommonJS import + * const client = new WAFClient(config); + * const command = new CreateGeoMatchSetCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreateGeoMatchSetCommandInput} for command's `input` shape. + * @see {@link CreateGeoMatchSetCommandOutput} for command's `response` shape. + * @see {@link WAFClientResolvedConfig | config} for command's `input` shape. + * */ export class CreateGeoMatchSetCommand extends $Command< CreateGeoMatchSetCommandInput, diff --git a/clients/client-waf/commands/CreateIPSetCommand.ts b/clients/client-waf/commands/CreateIPSetCommand.ts index c00287e82f9a..750485654c71 100644 --- a/clients/client-waf/commands/CreateIPSetCommand.ts +++ b/clients/client-waf/commands/CreateIPSetCommand.ts @@ -55,6 +55,20 @@ export interface CreateIPSetCommandOutput extends CreateIPSetResponse, __Metadat * *

For more information about how to use the AWS WAF API to allow or block HTTP requests, see the * AWS WAF Developer Guide.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { WAFClient, CreateIPSetCommand } from "@aws-sdk/client-waf"; // ES Modules import + * // const { WAFClient, CreateIPSetCommand } = require("@aws-sdk/client-waf"); // CommonJS import + * const client = new WAFClient(config); + * const command = new CreateIPSetCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreateIPSetCommandInput} for command's `input` shape. + * @see {@link CreateIPSetCommandOutput} for command's `response` shape. + * @see {@link WAFClientResolvedConfig | config} for command's `input` shape. + * */ export class CreateIPSetCommand extends $Command< CreateIPSetCommandInput, diff --git a/clients/client-waf/commands/CreateRateBasedRuleCommand.ts b/clients/client-waf/commands/CreateRateBasedRuleCommand.ts index a58ecee7aa77..988f7a282f84 100644 --- a/clients/client-waf/commands/CreateRateBasedRuleCommand.ts +++ b/clients/client-waf/commands/CreateRateBasedRuleCommand.ts @@ -115,6 +115,20 @@ export interface CreateRateBasedRuleCommandOutput extends CreateRateBasedRuleRes *

For more information about how to use the AWS WAF API to allow or block HTTP requests, * see the AWS WAF Developer * Guide.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { WAFClient, CreateRateBasedRuleCommand } from "@aws-sdk/client-waf"; // ES Modules import + * // const { WAFClient, CreateRateBasedRuleCommand } = require("@aws-sdk/client-waf"); // CommonJS import + * const client = new WAFClient(config); + * const command = new CreateRateBasedRuleCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreateRateBasedRuleCommandInput} for command's `input` shape. + * @see {@link CreateRateBasedRuleCommandOutput} for command's `response` shape. + * @see {@link WAFClientResolvedConfig | config} for command's `input` shape. + * */ export class CreateRateBasedRuleCommand extends $Command< CreateRateBasedRuleCommandInput, diff --git a/clients/client-waf/commands/CreateRegexMatchSetCommand.ts b/clients/client-waf/commands/CreateRegexMatchSetCommand.ts index 7f9859069b6c..0b25596a3412 100644 --- a/clients/client-waf/commands/CreateRegexMatchSetCommand.ts +++ b/clients/client-waf/commands/CreateRegexMatchSetCommand.ts @@ -53,6 +53,20 @@ export interface CreateRegexMatchSetCommandOutput extends CreateRegexMatchSetRes * *

For more information about how to use the AWS WAF API to allow or block HTTP requests, see the * AWS WAF Developer Guide.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { WAFClient, CreateRegexMatchSetCommand } from "@aws-sdk/client-waf"; // ES Modules import + * // const { WAFClient, CreateRegexMatchSetCommand } = require("@aws-sdk/client-waf"); // CommonJS import + * const client = new WAFClient(config); + * const command = new CreateRegexMatchSetCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreateRegexMatchSetCommandInput} for command's `input` shape. + * @see {@link CreateRegexMatchSetCommandOutput} for command's `response` shape. + * @see {@link WAFClientResolvedConfig | config} for command's `input` shape. + * */ export class CreateRegexMatchSetCommand extends $Command< CreateRegexMatchSetCommandInput, diff --git a/clients/client-waf/commands/CreateRegexPatternSetCommand.ts b/clients/client-waf/commands/CreateRegexPatternSetCommand.ts index f872a3d9045c..a48e23513a00 100644 --- a/clients/client-waf/commands/CreateRegexPatternSetCommand.ts +++ b/clients/client-waf/commands/CreateRegexPatternSetCommand.ts @@ -49,6 +49,20 @@ export interface CreateRegexPatternSetCommandOutput extends CreateRegexPatternSe * *

For more information about how to use the AWS WAF API to allow or block HTTP requests, see the * AWS WAF Developer Guide.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { WAFClient, CreateRegexPatternSetCommand } from "@aws-sdk/client-waf"; // ES Modules import + * // const { WAFClient, CreateRegexPatternSetCommand } = require("@aws-sdk/client-waf"); // CommonJS import + * const client = new WAFClient(config); + * const command = new CreateRegexPatternSetCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreateRegexPatternSetCommandInput} for command's `input` shape. + * @see {@link CreateRegexPatternSetCommandOutput} for command's `response` shape. + * @see {@link WAFClientResolvedConfig | config} for command's `input` shape. + * */ export class CreateRegexPatternSetCommand extends $Command< CreateRegexPatternSetCommandInput, diff --git a/clients/client-waf/commands/CreateRuleCommand.ts b/clients/client-waf/commands/CreateRuleCommand.ts index 5aef92cdf17d..839ccb9dfa76 100644 --- a/clients/client-waf/commands/CreateRuleCommand.ts +++ b/clients/client-waf/commands/CreateRuleCommand.ts @@ -73,6 +73,20 @@ export interface CreateRuleCommandOutput extends CreateRuleResponse, __MetadataB * *

For more information about how to use the AWS WAF API to allow or block HTTP requests, see the * AWS WAF Developer Guide.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { WAFClient, CreateRuleCommand } from "@aws-sdk/client-waf"; // ES Modules import + * // const { WAFClient, CreateRuleCommand } = require("@aws-sdk/client-waf"); // CommonJS import + * const client = new WAFClient(config); + * const command = new CreateRuleCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreateRuleCommandInput} for command's `input` shape. + * @see {@link CreateRuleCommandOutput} for command's `response` shape. + * @see {@link WAFClientResolvedConfig | config} for command's `input` shape. + * */ export class CreateRuleCommand extends $Command< CreateRuleCommandInput, diff --git a/clients/client-waf/commands/CreateRuleGroupCommand.ts b/clients/client-waf/commands/CreateRuleGroupCommand.ts index e437e782899c..7860613e6a34 100644 --- a/clients/client-waf/commands/CreateRuleGroupCommand.ts +++ b/clients/client-waf/commands/CreateRuleGroupCommand.ts @@ -44,6 +44,20 @@ export interface CreateRuleGroupCommandOutput extends CreateRuleGroupResponse, _ * *

For more information about how to use the AWS WAF API to allow or block HTTP requests, see the * AWS WAF Developer Guide.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { WAFClient, CreateRuleGroupCommand } from "@aws-sdk/client-waf"; // ES Modules import + * // const { WAFClient, CreateRuleGroupCommand } = require("@aws-sdk/client-waf"); // CommonJS import + * const client = new WAFClient(config); + * const command = new CreateRuleGroupCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreateRuleGroupCommandInput} for command's `input` shape. + * @see {@link CreateRuleGroupCommandOutput} for command's `response` shape. + * @see {@link WAFClientResolvedConfig | config} for command's `input` shape. + * */ export class CreateRuleGroupCommand extends $Command< CreateRuleGroupCommandInput, diff --git a/clients/client-waf/commands/CreateSizeConstraintSetCommand.ts b/clients/client-waf/commands/CreateSizeConstraintSetCommand.ts index a7fd2c443d5c..cd00840e7d45 100644 --- a/clients/client-waf/commands/CreateSizeConstraintSetCommand.ts +++ b/clients/client-waf/commands/CreateSizeConstraintSetCommand.ts @@ -53,6 +53,20 @@ export interface CreateSizeConstraintSetCommandOutput extends CreateSizeConstrai * *

For more information about how to use the AWS WAF API to allow or block HTTP requests, see the * AWS WAF Developer Guide.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { WAFClient, CreateSizeConstraintSetCommand } from "@aws-sdk/client-waf"; // ES Modules import + * // const { WAFClient, CreateSizeConstraintSetCommand } = require("@aws-sdk/client-waf"); // CommonJS import + * const client = new WAFClient(config); + * const command = new CreateSizeConstraintSetCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreateSizeConstraintSetCommandInput} for command's `input` shape. + * @see {@link CreateSizeConstraintSetCommandOutput} for command's `response` shape. + * @see {@link WAFClientResolvedConfig | config} for command's `input` shape. + * */ export class CreateSizeConstraintSetCommand extends $Command< CreateSizeConstraintSetCommandInput, diff --git a/clients/client-waf/commands/CreateSqlInjectionMatchSetCommand.ts b/clients/client-waf/commands/CreateSqlInjectionMatchSetCommand.ts index b2bcd675d2e8..131133a4bec9 100644 --- a/clients/client-waf/commands/CreateSqlInjectionMatchSetCommand.ts +++ b/clients/client-waf/commands/CreateSqlInjectionMatchSetCommand.ts @@ -51,6 +51,20 @@ export interface CreateSqlInjectionMatchSetCommandOutput extends CreateSqlInject * *

For more information about how to use the AWS WAF API to allow or block HTTP requests, see the * AWS WAF Developer Guide.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { WAFClient, CreateSqlInjectionMatchSetCommand } from "@aws-sdk/client-waf"; // ES Modules import + * // const { WAFClient, CreateSqlInjectionMatchSetCommand } = require("@aws-sdk/client-waf"); // CommonJS import + * const client = new WAFClient(config); + * const command = new CreateSqlInjectionMatchSetCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreateSqlInjectionMatchSetCommandInput} for command's `input` shape. + * @see {@link CreateSqlInjectionMatchSetCommandOutput} for command's `response` shape. + * @see {@link WAFClientResolvedConfig | config} for command's `input` shape. + * */ export class CreateSqlInjectionMatchSetCommand extends $Command< CreateSqlInjectionMatchSetCommandInput, diff --git a/clients/client-waf/commands/CreateWebACLCommand.ts b/clients/client-waf/commands/CreateWebACLCommand.ts index dc5fa10590a2..46758cf74cff 100644 --- a/clients/client-waf/commands/CreateWebACLCommand.ts +++ b/clients/client-waf/commands/CreateWebACLCommand.ts @@ -61,6 +61,20 @@ export interface CreateWebACLCommandOutput extends CreateWebACLResponse, __Metad * * *

For more information about how to use the AWS WAF API, see the AWS WAF Developer Guide.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { WAFClient, CreateWebACLCommand } from "@aws-sdk/client-waf"; // ES Modules import + * // const { WAFClient, CreateWebACLCommand } = require("@aws-sdk/client-waf"); // CommonJS import + * const client = new WAFClient(config); + * const command = new CreateWebACLCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreateWebACLCommandInput} for command's `input` shape. + * @see {@link CreateWebACLCommandOutput} for command's `response` shape. + * @see {@link WAFClientResolvedConfig | config} for command's `input` shape. + * */ export class CreateWebACLCommand extends $Command< CreateWebACLCommandInput, diff --git a/clients/client-waf/commands/CreateWebACLMigrationStackCommand.ts b/clients/client-waf/commands/CreateWebACLMigrationStackCommand.ts index 5cc353e1fccc..c4c8461da4f8 100644 --- a/clients/client-waf/commands/CreateWebACLMigrationStackCommand.ts +++ b/clients/client-waf/commands/CreateWebACLMigrationStackCommand.ts @@ -29,6 +29,20 @@ export interface CreateWebACLMigrationStackCommandOutput extends CreateWebACLMig * 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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { WAFClient, CreateWebACLMigrationStackCommand } from "@aws-sdk/client-waf"; // ES Modules import + * // const { WAFClient, CreateWebACLMigrationStackCommand } = require("@aws-sdk/client-waf"); // CommonJS import + * const client = new WAFClient(config); + * const command = new CreateWebACLMigrationStackCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreateWebACLMigrationStackCommandInput} for command's `input` shape. + * @see {@link CreateWebACLMigrationStackCommandOutput} for command's `response` shape. + * @see {@link WAFClientResolvedConfig | config} for command's `input` shape. + * */ export class CreateWebACLMigrationStackCommand extends $Command< CreateWebACLMigrationStackCommandInput, diff --git a/clients/client-waf/commands/CreateXssMatchSetCommand.ts b/clients/client-waf/commands/CreateXssMatchSetCommand.ts index d1b23561e590..255d4db5578d 100644 --- a/clients/client-waf/commands/CreateXssMatchSetCommand.ts +++ b/clients/client-waf/commands/CreateXssMatchSetCommand.ts @@ -51,6 +51,20 @@ export interface CreateXssMatchSetCommandOutput extends CreateXssMatchSetRespons * *

For more information about how to use the AWS WAF API to allow or block HTTP requests, see the * AWS WAF Developer Guide.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { WAFClient, CreateXssMatchSetCommand } from "@aws-sdk/client-waf"; // ES Modules import + * // const { WAFClient, CreateXssMatchSetCommand } = require("@aws-sdk/client-waf"); // CommonJS import + * const client = new WAFClient(config); + * const command = new CreateXssMatchSetCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreateXssMatchSetCommandInput} for command's `input` shape. + * @see {@link CreateXssMatchSetCommandOutput} for command's `response` shape. + * @see {@link WAFClientResolvedConfig | config} for command's `input` shape. + * */ export class CreateXssMatchSetCommand extends $Command< CreateXssMatchSetCommandInput, diff --git a/clients/client-waf/commands/DeleteByteMatchSetCommand.ts b/clients/client-waf/commands/DeleteByteMatchSetCommand.ts index 8e22a9d6f8e5..b1dd4b7611b6 100644 --- a/clients/client-waf/commands/DeleteByteMatchSetCommand.ts +++ b/clients/client-waf/commands/DeleteByteMatchSetCommand.ts @@ -45,6 +45,20 @@ export interface DeleteByteMatchSetCommandOutput extends DeleteByteMatchSetRespo *

Submit a DeleteByteMatchSet request.

* * + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { WAFClient, DeleteByteMatchSetCommand } from "@aws-sdk/client-waf"; // ES Modules import + * // const { WAFClient, DeleteByteMatchSetCommand } = require("@aws-sdk/client-waf"); // CommonJS import + * const client = new WAFClient(config); + * const command = new DeleteByteMatchSetCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteByteMatchSetCommandInput} for command's `input` shape. + * @see {@link DeleteByteMatchSetCommandOutput} for command's `response` shape. + * @see {@link WAFClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteByteMatchSetCommand extends $Command< DeleteByteMatchSetCommandInput, diff --git a/clients/client-waf/commands/DeleteGeoMatchSetCommand.ts b/clients/client-waf/commands/DeleteGeoMatchSetCommand.ts index 52f5eb441493..8a79258d73ab 100644 --- a/clients/client-waf/commands/DeleteGeoMatchSetCommand.ts +++ b/clients/client-waf/commands/DeleteGeoMatchSetCommand.ts @@ -45,6 +45,20 @@ export interface DeleteGeoMatchSetCommandOutput extends DeleteGeoMatchSetRespons *

Submit a DeleteGeoMatchSet request.

* * + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { WAFClient, DeleteGeoMatchSetCommand } from "@aws-sdk/client-waf"; // ES Modules import + * // const { WAFClient, DeleteGeoMatchSetCommand } = require("@aws-sdk/client-waf"); // CommonJS import + * const client = new WAFClient(config); + * const command = new DeleteGeoMatchSetCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteGeoMatchSetCommandInput} for command's `input` shape. + * @see {@link DeleteGeoMatchSetCommandOutput} for command's `response` shape. + * @see {@link WAFClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteGeoMatchSetCommand extends $Command< DeleteGeoMatchSetCommandInput, diff --git a/clients/client-waf/commands/DeleteIPSetCommand.ts b/clients/client-waf/commands/DeleteIPSetCommand.ts index 4b502e42a10c..3b8f836c574e 100644 --- a/clients/client-waf/commands/DeleteIPSetCommand.ts +++ b/clients/client-waf/commands/DeleteIPSetCommand.ts @@ -45,6 +45,20 @@ export interface DeleteIPSetCommandOutput extends DeleteIPSetResponse, __Metadat *

Submit a DeleteIPSet request.

* * + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { WAFClient, DeleteIPSetCommand } from "@aws-sdk/client-waf"; // ES Modules import + * // const { WAFClient, DeleteIPSetCommand } = require("@aws-sdk/client-waf"); // CommonJS import + * const client = new WAFClient(config); + * const command = new DeleteIPSetCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteIPSetCommandInput} for command's `input` shape. + * @see {@link DeleteIPSetCommandOutput} for command's `response` shape. + * @see {@link WAFClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteIPSetCommand extends $Command< DeleteIPSetCommandInput, diff --git a/clients/client-waf/commands/DeleteLoggingConfigurationCommand.ts b/clients/client-waf/commands/DeleteLoggingConfigurationCommand.ts index b09fff76ace4..cb1e7c276632 100644 --- a/clients/client-waf/commands/DeleteLoggingConfigurationCommand.ts +++ b/clients/client-waf/commands/DeleteLoggingConfigurationCommand.ts @@ -31,6 +31,20 @@ export interface DeleteLoggingConfigurationCommandOutput extends DeleteLoggingCo * *

Permanently deletes the LoggingConfiguration from the specified web * ACL.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { WAFClient, DeleteLoggingConfigurationCommand } from "@aws-sdk/client-waf"; // ES Modules import + * // const { WAFClient, DeleteLoggingConfigurationCommand } = require("@aws-sdk/client-waf"); // CommonJS import + * const client = new WAFClient(config); + * const command = new DeleteLoggingConfigurationCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteLoggingConfigurationCommandInput} for command's `input` shape. + * @see {@link DeleteLoggingConfigurationCommandOutput} for command's `response` shape. + * @see {@link WAFClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteLoggingConfigurationCommand extends $Command< DeleteLoggingConfigurationCommandInput, diff --git a/clients/client-waf/commands/DeletePermissionPolicyCommand.ts b/clients/client-waf/commands/DeletePermissionPolicyCommand.ts index 6a9f892ead03..44657e6a16c8 100644 --- a/clients/client-waf/commands/DeletePermissionPolicyCommand.ts +++ b/clients/client-waf/commands/DeletePermissionPolicyCommand.ts @@ -31,6 +31,20 @@ export interface DeletePermissionPolicyCommandOutput extends DeletePermissionPol * *

Permanently deletes an IAM policy from the specified RuleGroup.

*

The user making the request must be the owner of the RuleGroup.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { WAFClient, DeletePermissionPolicyCommand } from "@aws-sdk/client-waf"; // ES Modules import + * // const { WAFClient, DeletePermissionPolicyCommand } = require("@aws-sdk/client-waf"); // CommonJS import + * const client = new WAFClient(config); + * const command = new DeletePermissionPolicyCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeletePermissionPolicyCommandInput} for command's `input` shape. + * @see {@link DeletePermissionPolicyCommandOutput} for command's `response` shape. + * @see {@link WAFClientResolvedConfig | config} for command's `input` shape. + * */ export class DeletePermissionPolicyCommand extends $Command< DeletePermissionPolicyCommandInput, diff --git a/clients/client-waf/commands/DeleteRateBasedRuleCommand.ts b/clients/client-waf/commands/DeleteRateBasedRuleCommand.ts index a8ac5831f18a..90b13af426fa 100644 --- a/clients/client-waf/commands/DeleteRateBasedRuleCommand.ts +++ b/clients/client-waf/commands/DeleteRateBasedRuleCommand.ts @@ -49,6 +49,20 @@ export interface DeleteRateBasedRuleCommandOutput extends DeleteRateBasedRuleRes *

Submit a DeleteRateBasedRule request.

* * + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { WAFClient, DeleteRateBasedRuleCommand } from "@aws-sdk/client-waf"; // ES Modules import + * // const { WAFClient, DeleteRateBasedRuleCommand } = require("@aws-sdk/client-waf"); // CommonJS import + * const client = new WAFClient(config); + * const command = new DeleteRateBasedRuleCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteRateBasedRuleCommandInput} for command's `input` shape. + * @see {@link DeleteRateBasedRuleCommandOutput} for command's `response` shape. + * @see {@link WAFClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteRateBasedRuleCommand extends $Command< DeleteRateBasedRuleCommandInput, diff --git a/clients/client-waf/commands/DeleteRegexMatchSetCommand.ts b/clients/client-waf/commands/DeleteRegexMatchSetCommand.ts index 217ba1e43983..70eb61b09bff 100644 --- a/clients/client-waf/commands/DeleteRegexMatchSetCommand.ts +++ b/clients/client-waf/commands/DeleteRegexMatchSetCommand.ts @@ -45,6 +45,20 @@ export interface DeleteRegexMatchSetCommandOutput extends DeleteRegexMatchSetRes *

Submit a DeleteRegexMatchSet request.

* * + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { WAFClient, DeleteRegexMatchSetCommand } from "@aws-sdk/client-waf"; // ES Modules import + * // const { WAFClient, DeleteRegexMatchSetCommand } = require("@aws-sdk/client-waf"); // CommonJS import + * const client = new WAFClient(config); + * const command = new DeleteRegexMatchSetCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteRegexMatchSetCommandInput} for command's `input` shape. + * @see {@link DeleteRegexMatchSetCommandOutput} for command's `response` shape. + * @see {@link WAFClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteRegexMatchSetCommand extends $Command< DeleteRegexMatchSetCommandInput, diff --git a/clients/client-waf/commands/DeleteRegexPatternSetCommand.ts b/clients/client-waf/commands/DeleteRegexPatternSetCommand.ts index 624a5371212b..cd368db19021 100644 --- a/clients/client-waf/commands/DeleteRegexPatternSetCommand.ts +++ b/clients/client-waf/commands/DeleteRegexPatternSetCommand.ts @@ -31,6 +31,20 @@ export interface DeleteRegexPatternSetCommandOutput extends DeleteRegexPatternSe * *

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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { WAFClient, DeleteRegexPatternSetCommand } from "@aws-sdk/client-waf"; // ES Modules import + * // const { WAFClient, DeleteRegexPatternSetCommand } = require("@aws-sdk/client-waf"); // CommonJS import + * const client = new WAFClient(config); + * const command = new DeleteRegexPatternSetCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteRegexPatternSetCommandInput} for command's `input` shape. + * @see {@link DeleteRegexPatternSetCommandOutput} for command's `response` shape. + * @see {@link WAFClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteRegexPatternSetCommand extends $Command< DeleteRegexPatternSetCommandInput, diff --git a/clients/client-waf/commands/DeleteRuleCommand.ts b/clients/client-waf/commands/DeleteRuleCommand.ts index ffa020a639c7..253b7476b1b4 100644 --- a/clients/client-waf/commands/DeleteRuleCommand.ts +++ b/clients/client-waf/commands/DeleteRuleCommand.ts @@ -45,6 +45,20 @@ export interface DeleteRuleCommandOutput extends DeleteRuleResponse, __MetadataB *

Submit a DeleteRule request.

* * + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { WAFClient, DeleteRuleCommand } from "@aws-sdk/client-waf"; // ES Modules import + * // const { WAFClient, DeleteRuleCommand } = require("@aws-sdk/client-waf"); // CommonJS import + * const client = new WAFClient(config); + * const command = new DeleteRuleCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteRuleCommandInput} for command's `input` shape. + * @see {@link DeleteRuleCommandOutput} for command's `response` shape. + * @see {@link WAFClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteRuleCommand extends $Command< DeleteRuleCommandInput, diff --git a/clients/client-waf/commands/DeleteRuleGroupCommand.ts b/clients/client-waf/commands/DeleteRuleGroupCommand.ts index 82a46384cdd4..cc6c84994bea 100644 --- a/clients/client-waf/commands/DeleteRuleGroupCommand.ts +++ b/clients/client-waf/commands/DeleteRuleGroupCommand.ts @@ -45,6 +45,20 @@ export interface DeleteRuleGroupCommandOutput extends DeleteRuleGroupResponse, _ *

Submit a DeleteRuleGroup request.

* * + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { WAFClient, DeleteRuleGroupCommand } from "@aws-sdk/client-waf"; // ES Modules import + * // const { WAFClient, DeleteRuleGroupCommand } = require("@aws-sdk/client-waf"); // CommonJS import + * const client = new WAFClient(config); + * const command = new DeleteRuleGroupCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteRuleGroupCommandInput} for command's `input` shape. + * @see {@link DeleteRuleGroupCommandOutput} for command's `response` shape. + * @see {@link WAFClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteRuleGroupCommand extends $Command< DeleteRuleGroupCommandInput, diff --git a/clients/client-waf/commands/DeleteSizeConstraintSetCommand.ts b/clients/client-waf/commands/DeleteSizeConstraintSetCommand.ts index a20aa42dffe6..590a70ff7729 100644 --- a/clients/client-waf/commands/DeleteSizeConstraintSetCommand.ts +++ b/clients/client-waf/commands/DeleteSizeConstraintSetCommand.ts @@ -45,6 +45,20 @@ export interface DeleteSizeConstraintSetCommandOutput extends DeleteSizeConstrai *

Submit a DeleteSizeConstraintSet request.

* * + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { WAFClient, DeleteSizeConstraintSetCommand } from "@aws-sdk/client-waf"; // ES Modules import + * // const { WAFClient, DeleteSizeConstraintSetCommand } = require("@aws-sdk/client-waf"); // CommonJS import + * const client = new WAFClient(config); + * const command = new DeleteSizeConstraintSetCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteSizeConstraintSetCommandInput} for command's `input` shape. + * @see {@link DeleteSizeConstraintSetCommandOutput} for command's `response` shape. + * @see {@link WAFClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteSizeConstraintSetCommand extends $Command< DeleteSizeConstraintSetCommandInput, diff --git a/clients/client-waf/commands/DeleteSqlInjectionMatchSetCommand.ts b/clients/client-waf/commands/DeleteSqlInjectionMatchSetCommand.ts index d41c39141ede..f8bee1469c15 100644 --- a/clients/client-waf/commands/DeleteSqlInjectionMatchSetCommand.ts +++ b/clients/client-waf/commands/DeleteSqlInjectionMatchSetCommand.ts @@ -46,6 +46,20 @@ export interface DeleteSqlInjectionMatchSetCommandOutput extends DeleteSqlInject *

Submit a DeleteSqlInjectionMatchSet request.

* * + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { WAFClient, DeleteSqlInjectionMatchSetCommand } from "@aws-sdk/client-waf"; // ES Modules import + * // const { WAFClient, DeleteSqlInjectionMatchSetCommand } = require("@aws-sdk/client-waf"); // CommonJS import + * const client = new WAFClient(config); + * const command = new DeleteSqlInjectionMatchSetCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteSqlInjectionMatchSetCommandInput} for command's `input` shape. + * @see {@link DeleteSqlInjectionMatchSetCommandOutput} for command's `response` shape. + * @see {@link WAFClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteSqlInjectionMatchSetCommand extends $Command< DeleteSqlInjectionMatchSetCommandInput, diff --git a/clients/client-waf/commands/DeleteWebACLCommand.ts b/clients/client-waf/commands/DeleteWebACLCommand.ts index d0829be80a55..8e158a185d5b 100644 --- a/clients/client-waf/commands/DeleteWebACLCommand.ts +++ b/clients/client-waf/commands/DeleteWebACLCommand.ts @@ -43,6 +43,20 @@ export interface DeleteWebACLCommandOutput extends DeleteWebACLResponse, __Metad *

Submit a DeleteWebACL request.

* * + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { WAFClient, DeleteWebACLCommand } from "@aws-sdk/client-waf"; // ES Modules import + * // const { WAFClient, DeleteWebACLCommand } = require("@aws-sdk/client-waf"); // CommonJS import + * const client = new WAFClient(config); + * const command = new DeleteWebACLCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteWebACLCommandInput} for command's `input` shape. + * @see {@link DeleteWebACLCommandOutput} for command's `response` shape. + * @see {@link WAFClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteWebACLCommand extends $Command< DeleteWebACLCommandInput, diff --git a/clients/client-waf/commands/DeleteXssMatchSetCommand.ts b/clients/client-waf/commands/DeleteXssMatchSetCommand.ts index 23f753baf388..77b890198f1d 100644 --- a/clients/client-waf/commands/DeleteXssMatchSetCommand.ts +++ b/clients/client-waf/commands/DeleteXssMatchSetCommand.ts @@ -46,6 +46,20 @@ export interface DeleteXssMatchSetCommandOutput extends DeleteXssMatchSetRespons *

Submit a DeleteXssMatchSet request.

* * + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { WAFClient, DeleteXssMatchSetCommand } from "@aws-sdk/client-waf"; // ES Modules import + * // const { WAFClient, DeleteXssMatchSetCommand } = require("@aws-sdk/client-waf"); // CommonJS import + * const client = new WAFClient(config); + * const command = new DeleteXssMatchSetCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteXssMatchSetCommandInput} for command's `input` shape. + * @see {@link DeleteXssMatchSetCommandOutput} for command's `response` shape. + * @see {@link WAFClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteXssMatchSetCommand extends $Command< DeleteXssMatchSetCommandInput, diff --git a/clients/client-waf/commands/GetByteMatchSetCommand.ts b/clients/client-waf/commands/GetByteMatchSetCommand.ts index 38420262b27d..391f11ff34d9 100644 --- a/clients/client-waf/commands/GetByteMatchSetCommand.ts +++ b/clients/client-waf/commands/GetByteMatchSetCommand.ts @@ -30,6 +30,20 @@ export interface GetByteMatchSetCommandOutput extends GetByteMatchSetResponse, _ * 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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { WAFClient, GetByteMatchSetCommand } from "@aws-sdk/client-waf"; // ES Modules import + * // const { WAFClient, GetByteMatchSetCommand } = require("@aws-sdk/client-waf"); // CommonJS import + * const client = new WAFClient(config); + * const command = new GetByteMatchSetCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetByteMatchSetCommandInput} for command's `input` shape. + * @see {@link GetByteMatchSetCommandOutput} for command's `response` shape. + * @see {@link WAFClientResolvedConfig | config} for command's `input` shape. + * */ export class GetByteMatchSetCommand extends $Command< GetByteMatchSetCommandInput, diff --git a/clients/client-waf/commands/GetChangeTokenCommand.ts b/clients/client-waf/commands/GetChangeTokenCommand.ts index 0d86fa117757..c3a51b7a2e41 100644 --- a/clients/client-waf/commands/GetChangeTokenCommand.ts +++ b/clients/client-waf/commands/GetChangeTokenCommand.ts @@ -36,6 +36,20 @@ export interface GetChangeTokenCommandOutput extends GetChangeTokenResponse, __M *

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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { WAFClient, GetChangeTokenCommand } from "@aws-sdk/client-waf"; // ES Modules import + * // const { WAFClient, GetChangeTokenCommand } = require("@aws-sdk/client-waf"); // CommonJS import + * const client = new WAFClient(config); + * const command = new GetChangeTokenCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetChangeTokenCommandInput} for command's `input` shape. + * @see {@link GetChangeTokenCommandOutput} for command's `response` shape. + * @see {@link WAFClientResolvedConfig | config} for command's `input` shape. + * */ export class GetChangeTokenCommand extends $Command< GetChangeTokenCommandInput, diff --git a/clients/client-waf/commands/GetChangeTokenStatusCommand.ts b/clients/client-waf/commands/GetChangeTokenStatusCommand.ts index 9c3ad5cdeed7..fda3d86ab41a 100644 --- a/clients/client-waf/commands/GetChangeTokenStatusCommand.ts +++ b/clients/client-waf/commands/GetChangeTokenStatusCommand.ts @@ -46,6 +46,20 @@ export interface GetChangeTokenStatusCommandOutput extends GetChangeTokenStatusR * INSYNC: Propagation is complete.

* * + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { WAFClient, GetChangeTokenStatusCommand } from "@aws-sdk/client-waf"; // ES Modules import + * // const { WAFClient, GetChangeTokenStatusCommand } = require("@aws-sdk/client-waf"); // CommonJS import + * const client = new WAFClient(config); + * const command = new GetChangeTokenStatusCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetChangeTokenStatusCommandInput} for command's `input` shape. + * @see {@link GetChangeTokenStatusCommandOutput} for command's `response` shape. + * @see {@link WAFClientResolvedConfig | config} for command's `input` shape. + * */ export class GetChangeTokenStatusCommand extends $Command< GetChangeTokenStatusCommandInput, diff --git a/clients/client-waf/commands/GetGeoMatchSetCommand.ts b/clients/client-waf/commands/GetGeoMatchSetCommand.ts index d5fa59ba6e31..81b92d6867b8 100644 --- a/clients/client-waf/commands/GetGeoMatchSetCommand.ts +++ b/clients/client-waf/commands/GetGeoMatchSetCommand.ts @@ -30,6 +30,20 @@ export interface GetGeoMatchSetCommandOutput extends GetGeoMatchSetResponse, __M * 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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { WAFClient, GetGeoMatchSetCommand } from "@aws-sdk/client-waf"; // ES Modules import + * // const { WAFClient, GetGeoMatchSetCommand } = require("@aws-sdk/client-waf"); // CommonJS import + * const client = new WAFClient(config); + * const command = new GetGeoMatchSetCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetGeoMatchSetCommandInput} for command's `input` shape. + * @see {@link GetGeoMatchSetCommandOutput} for command's `response` shape. + * @see {@link WAFClientResolvedConfig | config} for command's `input` shape. + * */ export class GetGeoMatchSetCommand extends $Command< GetGeoMatchSetCommandInput, diff --git a/clients/client-waf/commands/GetIPSetCommand.ts b/clients/client-waf/commands/GetIPSetCommand.ts index 44ed69a3e9dd..50924402f522 100644 --- a/clients/client-waf/commands/GetIPSetCommand.ts +++ b/clients/client-waf/commands/GetIPSetCommand.ts @@ -27,6 +27,20 @@ export interface GetIPSetCommandOutput extends GetIPSetResponse, __MetadataBeare * 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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { WAFClient, GetIPSetCommand } from "@aws-sdk/client-waf"; // ES Modules import + * // const { WAFClient, GetIPSetCommand } = require("@aws-sdk/client-waf"); // CommonJS import + * const client = new WAFClient(config); + * const command = new GetIPSetCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetIPSetCommandInput} for command's `input` shape. + * @see {@link GetIPSetCommandOutput} for command's `response` shape. + * @see {@link WAFClientResolvedConfig | config} for command's `input` shape. + * */ export class GetIPSetCommand extends $Command { // Start section: command_properties diff --git a/clients/client-waf/commands/GetLoggingConfigurationCommand.ts b/clients/client-waf/commands/GetLoggingConfigurationCommand.ts index 0c14eebf0a17..542d9813dd47 100644 --- a/clients/client-waf/commands/GetLoggingConfigurationCommand.ts +++ b/clients/client-waf/commands/GetLoggingConfigurationCommand.ts @@ -30,6 +30,20 @@ export interface GetLoggingConfigurationCommandOutput extends GetLoggingConfigur * 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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { WAFClient, GetLoggingConfigurationCommand } from "@aws-sdk/client-waf"; // ES Modules import + * // const { WAFClient, GetLoggingConfigurationCommand } = require("@aws-sdk/client-waf"); // CommonJS import + * const client = new WAFClient(config); + * const command = new GetLoggingConfigurationCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetLoggingConfigurationCommandInput} for command's `input` shape. + * @see {@link GetLoggingConfigurationCommandOutput} for command's `response` shape. + * @see {@link WAFClientResolvedConfig | config} for command's `input` shape. + * */ export class GetLoggingConfigurationCommand extends $Command< GetLoggingConfigurationCommandInput, diff --git a/clients/client-waf/commands/GetPermissionPolicyCommand.ts b/clients/client-waf/commands/GetPermissionPolicyCommand.ts index f6e2815687d9..ab049a3a039a 100644 --- a/clients/client-waf/commands/GetPermissionPolicyCommand.ts +++ b/clients/client-waf/commands/GetPermissionPolicyCommand.ts @@ -30,6 +30,20 @@ export interface GetPermissionPolicyCommandOutput extends GetPermissionPolicyRes * 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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { WAFClient, GetPermissionPolicyCommand } from "@aws-sdk/client-waf"; // ES Modules import + * // const { WAFClient, GetPermissionPolicyCommand } = require("@aws-sdk/client-waf"); // CommonJS import + * const client = new WAFClient(config); + * const command = new GetPermissionPolicyCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetPermissionPolicyCommandInput} for command's `input` shape. + * @see {@link GetPermissionPolicyCommandOutput} for command's `response` shape. + * @see {@link WAFClientResolvedConfig | config} for command's `input` shape. + * */ export class GetPermissionPolicyCommand extends $Command< GetPermissionPolicyCommandInput, diff --git a/clients/client-waf/commands/GetRateBasedRuleCommand.ts b/clients/client-waf/commands/GetRateBasedRuleCommand.ts index 9f826e9de918..69bd123a8231 100644 --- a/clients/client-waf/commands/GetRateBasedRuleCommand.ts +++ b/clients/client-waf/commands/GetRateBasedRuleCommand.ts @@ -32,6 +32,20 @@ export interface GetRateBasedRuleCommandOutput extends GetRateBasedRuleResponse, *

Returns the RateBasedRule that is specified by the * RuleId that you included in the GetRateBasedRule * request.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { WAFClient, GetRateBasedRuleCommand } from "@aws-sdk/client-waf"; // ES Modules import + * // const { WAFClient, GetRateBasedRuleCommand } = require("@aws-sdk/client-waf"); // CommonJS import + * const client = new WAFClient(config); + * const command = new GetRateBasedRuleCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetRateBasedRuleCommandInput} for command's `input` shape. + * @see {@link GetRateBasedRuleCommandOutput} for command's `response` shape. + * @see {@link WAFClientResolvedConfig | config} for command's `input` shape. + * */ export class GetRateBasedRuleCommand extends $Command< GetRateBasedRuleCommandInput, diff --git a/clients/client-waf/commands/GetRateBasedRuleManagedKeysCommand.ts b/clients/client-waf/commands/GetRateBasedRuleManagedKeysCommand.ts index ffc451580058..1ee911a97370 100644 --- a/clients/client-waf/commands/GetRateBasedRuleManagedKeysCommand.ts +++ b/clients/client-waf/commands/GetRateBasedRuleManagedKeysCommand.ts @@ -34,6 +34,20 @@ export interface GetRateBasedRuleManagedKeysCommandOutput *

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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { WAFClient, GetRateBasedRuleManagedKeysCommand } from "@aws-sdk/client-waf"; // ES Modules import + * // const { WAFClient, GetRateBasedRuleManagedKeysCommand } = require("@aws-sdk/client-waf"); // CommonJS import + * const client = new WAFClient(config); + * const command = new GetRateBasedRuleManagedKeysCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetRateBasedRuleManagedKeysCommandInput} for command's `input` shape. + * @see {@link GetRateBasedRuleManagedKeysCommandOutput} for command's `response` shape. + * @see {@link WAFClientResolvedConfig | config} for command's `input` shape. + * */ export class GetRateBasedRuleManagedKeysCommand extends $Command< GetRateBasedRuleManagedKeysCommandInput, diff --git a/clients/client-waf/commands/GetRegexMatchSetCommand.ts b/clients/client-waf/commands/GetRegexMatchSetCommand.ts index 8b05694d09f7..30c72c799e76 100644 --- a/clients/client-waf/commands/GetRegexMatchSetCommand.ts +++ b/clients/client-waf/commands/GetRegexMatchSetCommand.ts @@ -30,6 +30,20 @@ export interface GetRegexMatchSetCommandOutput extends GetRegexMatchSetResponse, * 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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { WAFClient, GetRegexMatchSetCommand } from "@aws-sdk/client-waf"; // ES Modules import + * // const { WAFClient, GetRegexMatchSetCommand } = require("@aws-sdk/client-waf"); // CommonJS import + * const client = new WAFClient(config); + * const command = new GetRegexMatchSetCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetRegexMatchSetCommandInput} for command's `input` shape. + * @see {@link GetRegexMatchSetCommandOutput} for command's `response` shape. + * @see {@link WAFClientResolvedConfig | config} for command's `input` shape. + * */ export class GetRegexMatchSetCommand extends $Command< GetRegexMatchSetCommandInput, diff --git a/clients/client-waf/commands/GetRegexPatternSetCommand.ts b/clients/client-waf/commands/GetRegexPatternSetCommand.ts index b520fd6f464a..d6af858e6c8a 100644 --- a/clients/client-waf/commands/GetRegexPatternSetCommand.ts +++ b/clients/client-waf/commands/GetRegexPatternSetCommand.ts @@ -30,6 +30,20 @@ export interface GetRegexPatternSetCommandOutput extends GetRegexPatternSetRespo * 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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { WAFClient, GetRegexPatternSetCommand } from "@aws-sdk/client-waf"; // ES Modules import + * // const { WAFClient, GetRegexPatternSetCommand } = require("@aws-sdk/client-waf"); // CommonJS import + * const client = new WAFClient(config); + * const command = new GetRegexPatternSetCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetRegexPatternSetCommandInput} for command's `input` shape. + * @see {@link GetRegexPatternSetCommandOutput} for command's `response` shape. + * @see {@link WAFClientResolvedConfig | config} for command's `input` shape. + * */ export class GetRegexPatternSetCommand extends $Command< GetRegexPatternSetCommandInput, diff --git a/clients/client-waf/commands/GetRuleCommand.ts b/clients/client-waf/commands/GetRuleCommand.ts index 051ef0a11bba..85dbfd236b85 100644 --- a/clients/client-waf/commands/GetRuleCommand.ts +++ b/clients/client-waf/commands/GetRuleCommand.ts @@ -27,6 +27,20 @@ export interface GetRuleCommandOutput extends GetRuleResponse, __MetadataBearer * 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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { WAFClient, GetRuleCommand } from "@aws-sdk/client-waf"; // ES Modules import + * // const { WAFClient, GetRuleCommand } = require("@aws-sdk/client-waf"); // CommonJS import + * const client = new WAFClient(config); + * const command = new GetRuleCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetRuleCommandInput} for command's `input` shape. + * @see {@link GetRuleCommandOutput} for command's `response` shape. + * @see {@link WAFClientResolvedConfig | config} for command's `input` shape. + * */ export class GetRuleCommand extends $Command { // Start section: command_properties diff --git a/clients/client-waf/commands/GetRuleGroupCommand.ts b/clients/client-waf/commands/GetRuleGroupCommand.ts index 62f7bd1e4f03..31e92933b119 100644 --- a/clients/client-waf/commands/GetRuleGroupCommand.ts +++ b/clients/client-waf/commands/GetRuleGroupCommand.ts @@ -31,6 +31,20 @@ export interface GetRuleGroupCommandOutput extends GetRuleGroupResponse, __Metad * *

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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { WAFClient, GetRuleGroupCommand } from "@aws-sdk/client-waf"; // ES Modules import + * // const { WAFClient, GetRuleGroupCommand } = require("@aws-sdk/client-waf"); // CommonJS import + * const client = new WAFClient(config); + * const command = new GetRuleGroupCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetRuleGroupCommandInput} for command's `input` shape. + * @see {@link GetRuleGroupCommandOutput} for command's `response` shape. + * @see {@link WAFClientResolvedConfig | config} for command's `input` shape. + * */ export class GetRuleGroupCommand extends $Command< GetRuleGroupCommandInput, diff --git a/clients/client-waf/commands/GetSampledRequestsCommand.ts b/clients/client-waf/commands/GetSampledRequestsCommand.ts index edc3debbd6f6..6a9afaece406 100644 --- a/clients/client-waf/commands/GetSampledRequestsCommand.ts +++ b/clients/client-waf/commands/GetSampledRequestsCommand.ts @@ -34,6 +34,20 @@ export interface GetSampledRequestsCommandOutput extends GetSampledRequestsRespo * 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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { WAFClient, GetSampledRequestsCommand } from "@aws-sdk/client-waf"; // ES Modules import + * // const { WAFClient, GetSampledRequestsCommand } = require("@aws-sdk/client-waf"); // CommonJS import + * const client = new WAFClient(config); + * const command = new GetSampledRequestsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetSampledRequestsCommandInput} for command's `input` shape. + * @see {@link GetSampledRequestsCommandOutput} for command's `response` shape. + * @see {@link WAFClientResolvedConfig | config} for command's `input` shape. + * */ export class GetSampledRequestsCommand extends $Command< GetSampledRequestsCommandInput, diff --git a/clients/client-waf/commands/GetSizeConstraintSetCommand.ts b/clients/client-waf/commands/GetSizeConstraintSetCommand.ts index 2096d664cb1d..4b4981588d73 100644 --- a/clients/client-waf/commands/GetSizeConstraintSetCommand.ts +++ b/clients/client-waf/commands/GetSizeConstraintSetCommand.ts @@ -30,6 +30,20 @@ export interface GetSizeConstraintSetCommandOutput extends GetSizeConstraintSetR * 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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { WAFClient, GetSizeConstraintSetCommand } from "@aws-sdk/client-waf"; // ES Modules import + * // const { WAFClient, GetSizeConstraintSetCommand } = require("@aws-sdk/client-waf"); // CommonJS import + * const client = new WAFClient(config); + * const command = new GetSizeConstraintSetCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetSizeConstraintSetCommandInput} for command's `input` shape. + * @see {@link GetSizeConstraintSetCommandOutput} for command's `response` shape. + * @see {@link WAFClientResolvedConfig | config} for command's `input` shape. + * */ export class GetSizeConstraintSetCommand extends $Command< GetSizeConstraintSetCommandInput, diff --git a/clients/client-waf/commands/GetSqlInjectionMatchSetCommand.ts b/clients/client-waf/commands/GetSqlInjectionMatchSetCommand.ts index c3ec3b49f04d..749a01ae3b2a 100644 --- a/clients/client-waf/commands/GetSqlInjectionMatchSetCommand.ts +++ b/clients/client-waf/commands/GetSqlInjectionMatchSetCommand.ts @@ -30,6 +30,20 @@ export interface GetSqlInjectionMatchSetCommandOutput extends GetSqlInjectionMat * 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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { WAFClient, GetSqlInjectionMatchSetCommand } from "@aws-sdk/client-waf"; // ES Modules import + * // const { WAFClient, GetSqlInjectionMatchSetCommand } = require("@aws-sdk/client-waf"); // CommonJS import + * const client = new WAFClient(config); + * const command = new GetSqlInjectionMatchSetCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetSqlInjectionMatchSetCommandInput} for command's `input` shape. + * @see {@link GetSqlInjectionMatchSetCommandOutput} for command's `response` shape. + * @see {@link WAFClientResolvedConfig | config} for command's `input` shape. + * */ export class GetSqlInjectionMatchSetCommand extends $Command< GetSqlInjectionMatchSetCommandInput, diff --git a/clients/client-waf/commands/GetWebACLCommand.ts b/clients/client-waf/commands/GetWebACLCommand.ts index 59be670fa941..5a10bf2deb49 100644 --- a/clients/client-waf/commands/GetWebACLCommand.ts +++ b/clients/client-waf/commands/GetWebACLCommand.ts @@ -27,6 +27,20 @@ export interface GetWebACLCommandOutput extends GetWebACLResponse, __MetadataBea * 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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { WAFClient, GetWebACLCommand } from "@aws-sdk/client-waf"; // ES Modules import + * // const { WAFClient, GetWebACLCommand } = require("@aws-sdk/client-waf"); // CommonJS import + * const client = new WAFClient(config); + * const command = new GetWebACLCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetWebACLCommandInput} for command's `input` shape. + * @see {@link GetWebACLCommandOutput} for command's `response` shape. + * @see {@link WAFClientResolvedConfig | config} for command's `input` shape. + * */ export class GetWebACLCommand extends $Command { // Start section: command_properties diff --git a/clients/client-waf/commands/GetXssMatchSetCommand.ts b/clients/client-waf/commands/GetXssMatchSetCommand.ts index c3b275e42731..290910bb944d 100644 --- a/clients/client-waf/commands/GetXssMatchSetCommand.ts +++ b/clients/client-waf/commands/GetXssMatchSetCommand.ts @@ -30,6 +30,20 @@ export interface GetXssMatchSetCommandOutput extends GetXssMatchSetResponse, __M * 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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { WAFClient, GetXssMatchSetCommand } from "@aws-sdk/client-waf"; // ES Modules import + * // const { WAFClient, GetXssMatchSetCommand } = require("@aws-sdk/client-waf"); // CommonJS import + * const client = new WAFClient(config); + * const command = new GetXssMatchSetCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetXssMatchSetCommandInput} for command's `input` shape. + * @see {@link GetXssMatchSetCommandOutput} for command's `response` shape. + * @see {@link WAFClientResolvedConfig | config} for command's `input` shape. + * */ export class GetXssMatchSetCommand extends $Command< GetXssMatchSetCommandInput, diff --git a/clients/client-waf/commands/ListActivatedRulesInRuleGroupCommand.ts b/clients/client-waf/commands/ListActivatedRulesInRuleGroupCommand.ts index 3bf4e19dd516..18b214212694 100644 --- a/clients/client-waf/commands/ListActivatedRulesInRuleGroupCommand.ts +++ b/clients/client-waf/commands/ListActivatedRulesInRuleGroupCommand.ts @@ -32,6 +32,20 @@ export interface ListActivatedRulesInRuleGroupCommandOutput * 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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { WAFClient, ListActivatedRulesInRuleGroupCommand } from "@aws-sdk/client-waf"; // ES Modules import + * // const { WAFClient, ListActivatedRulesInRuleGroupCommand } = require("@aws-sdk/client-waf"); // CommonJS import + * const client = new WAFClient(config); + * const command = new ListActivatedRulesInRuleGroupCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListActivatedRulesInRuleGroupCommandInput} for command's `input` shape. + * @see {@link ListActivatedRulesInRuleGroupCommandOutput} for command's `response` shape. + * @see {@link WAFClientResolvedConfig | config} for command's `input` shape. + * */ export class ListActivatedRulesInRuleGroupCommand extends $Command< ListActivatedRulesInRuleGroupCommandInput, diff --git a/clients/client-waf/commands/ListByteMatchSetsCommand.ts b/clients/client-waf/commands/ListByteMatchSetsCommand.ts index 9d7bbfd534e6..d278ded228a8 100644 --- a/clients/client-waf/commands/ListByteMatchSetsCommand.ts +++ b/clients/client-waf/commands/ListByteMatchSetsCommand.ts @@ -30,6 +30,20 @@ export interface ListByteMatchSetsCommandOutput extends ListByteMatchSetsRespons * 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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { WAFClient, ListByteMatchSetsCommand } from "@aws-sdk/client-waf"; // ES Modules import + * // const { WAFClient, ListByteMatchSetsCommand } = require("@aws-sdk/client-waf"); // CommonJS import + * const client = new WAFClient(config); + * const command = new ListByteMatchSetsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListByteMatchSetsCommandInput} for command's `input` shape. + * @see {@link ListByteMatchSetsCommandOutput} for command's `response` shape. + * @see {@link WAFClientResolvedConfig | config} for command's `input` shape. + * */ export class ListByteMatchSetsCommand extends $Command< ListByteMatchSetsCommandInput, diff --git a/clients/client-waf/commands/ListGeoMatchSetsCommand.ts b/clients/client-waf/commands/ListGeoMatchSetsCommand.ts index c0ddbfed12ad..5a6b35d3d703 100644 --- a/clients/client-waf/commands/ListGeoMatchSetsCommand.ts +++ b/clients/client-waf/commands/ListGeoMatchSetsCommand.ts @@ -30,6 +30,20 @@ export interface ListGeoMatchSetsCommandOutput extends ListGeoMatchSetsResponse, * 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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { WAFClient, ListGeoMatchSetsCommand } from "@aws-sdk/client-waf"; // ES Modules import + * // const { WAFClient, ListGeoMatchSetsCommand } = require("@aws-sdk/client-waf"); // CommonJS import + * const client = new WAFClient(config); + * const command = new ListGeoMatchSetsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListGeoMatchSetsCommandInput} for command's `input` shape. + * @see {@link ListGeoMatchSetsCommandOutput} for command's `response` shape. + * @see {@link WAFClientResolvedConfig | config} for command's `input` shape. + * */ export class ListGeoMatchSetsCommand extends $Command< ListGeoMatchSetsCommandInput, diff --git a/clients/client-waf/commands/ListIPSetsCommand.ts b/clients/client-waf/commands/ListIPSetsCommand.ts index 766ca8b928a5..d2cb8f33b98a 100644 --- a/clients/client-waf/commands/ListIPSetsCommand.ts +++ b/clients/client-waf/commands/ListIPSetsCommand.ts @@ -30,6 +30,20 @@ export interface ListIPSetsCommandOutput extends ListIPSetsResponse, __MetadataB * 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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { WAFClient, ListIPSetsCommand } from "@aws-sdk/client-waf"; // ES Modules import + * // const { WAFClient, ListIPSetsCommand } = require("@aws-sdk/client-waf"); // CommonJS import + * const client = new WAFClient(config); + * const command = new ListIPSetsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListIPSetsCommandInput} for command's `input` shape. + * @see {@link ListIPSetsCommandOutput} for command's `response` shape. + * @see {@link WAFClientResolvedConfig | config} for command's `input` shape. + * */ export class ListIPSetsCommand extends $Command< ListIPSetsCommandInput, diff --git a/clients/client-waf/commands/ListLoggingConfigurationsCommand.ts b/clients/client-waf/commands/ListLoggingConfigurationsCommand.ts index 42b91f09b18e..df9ba71d49b1 100644 --- a/clients/client-waf/commands/ListLoggingConfigurationsCommand.ts +++ b/clients/client-waf/commands/ListLoggingConfigurationsCommand.ts @@ -30,6 +30,20 @@ export interface ListLoggingConfigurationsCommandOutput extends ListLoggingConfi * 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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { WAFClient, ListLoggingConfigurationsCommand } from "@aws-sdk/client-waf"; // ES Modules import + * // const { WAFClient, ListLoggingConfigurationsCommand } = require("@aws-sdk/client-waf"); // CommonJS import + * const client = new WAFClient(config); + * const command = new ListLoggingConfigurationsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListLoggingConfigurationsCommandInput} for command's `input` shape. + * @see {@link ListLoggingConfigurationsCommandOutput} for command's `response` shape. + * @see {@link WAFClientResolvedConfig | config} for command's `input` shape. + * */ export class ListLoggingConfigurationsCommand extends $Command< ListLoggingConfigurationsCommandInput, diff --git a/clients/client-waf/commands/ListRateBasedRulesCommand.ts b/clients/client-waf/commands/ListRateBasedRulesCommand.ts index e5d1792564b7..d0ff87c05241 100644 --- a/clients/client-waf/commands/ListRateBasedRulesCommand.ts +++ b/clients/client-waf/commands/ListRateBasedRulesCommand.ts @@ -30,6 +30,20 @@ export interface ListRateBasedRulesCommandOutput extends ListRateBasedRulesRespo * 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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { WAFClient, ListRateBasedRulesCommand } from "@aws-sdk/client-waf"; // ES Modules import + * // const { WAFClient, ListRateBasedRulesCommand } = require("@aws-sdk/client-waf"); // CommonJS import + * const client = new WAFClient(config); + * const command = new ListRateBasedRulesCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListRateBasedRulesCommandInput} for command's `input` shape. + * @see {@link ListRateBasedRulesCommandOutput} for command's `response` shape. + * @see {@link WAFClientResolvedConfig | config} for command's `input` shape. + * */ export class ListRateBasedRulesCommand extends $Command< ListRateBasedRulesCommandInput, diff --git a/clients/client-waf/commands/ListRegexMatchSetsCommand.ts b/clients/client-waf/commands/ListRegexMatchSetsCommand.ts index 72b535212f67..761fb1afe0c8 100644 --- a/clients/client-waf/commands/ListRegexMatchSetsCommand.ts +++ b/clients/client-waf/commands/ListRegexMatchSetsCommand.ts @@ -30,6 +30,20 @@ export interface ListRegexMatchSetsCommandOutput extends ListRegexMatchSetsRespo * 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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { WAFClient, ListRegexMatchSetsCommand } from "@aws-sdk/client-waf"; // ES Modules import + * // const { WAFClient, ListRegexMatchSetsCommand } = require("@aws-sdk/client-waf"); // CommonJS import + * const client = new WAFClient(config); + * const command = new ListRegexMatchSetsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListRegexMatchSetsCommandInput} for command's `input` shape. + * @see {@link ListRegexMatchSetsCommandOutput} for command's `response` shape. + * @see {@link WAFClientResolvedConfig | config} for command's `input` shape. + * */ export class ListRegexMatchSetsCommand extends $Command< ListRegexMatchSetsCommandInput, diff --git a/clients/client-waf/commands/ListRegexPatternSetsCommand.ts b/clients/client-waf/commands/ListRegexPatternSetsCommand.ts index 4cf508db5a45..54267d5237e1 100644 --- a/clients/client-waf/commands/ListRegexPatternSetsCommand.ts +++ b/clients/client-waf/commands/ListRegexPatternSetsCommand.ts @@ -30,6 +30,20 @@ export interface ListRegexPatternSetsCommandOutput extends ListRegexPatternSetsR * 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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { WAFClient, ListRegexPatternSetsCommand } from "@aws-sdk/client-waf"; // ES Modules import + * // const { WAFClient, ListRegexPatternSetsCommand } = require("@aws-sdk/client-waf"); // CommonJS import + * const client = new WAFClient(config); + * const command = new ListRegexPatternSetsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListRegexPatternSetsCommandInput} for command's `input` shape. + * @see {@link ListRegexPatternSetsCommandOutput} for command's `response` shape. + * @see {@link WAFClientResolvedConfig | config} for command's `input` shape. + * */ export class ListRegexPatternSetsCommand extends $Command< ListRegexPatternSetsCommandInput, diff --git a/clients/client-waf/commands/ListRuleGroupsCommand.ts b/clients/client-waf/commands/ListRuleGroupsCommand.ts index 0ae238b40095..d94d0b4585be 100644 --- a/clients/client-waf/commands/ListRuleGroupsCommand.ts +++ b/clients/client-waf/commands/ListRuleGroupsCommand.ts @@ -30,6 +30,20 @@ export interface ListRuleGroupsCommandOutput extends ListRuleGroupsResponse, __M * 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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { WAFClient, ListRuleGroupsCommand } from "@aws-sdk/client-waf"; // ES Modules import + * // const { WAFClient, ListRuleGroupsCommand } = require("@aws-sdk/client-waf"); // CommonJS import + * const client = new WAFClient(config); + * const command = new ListRuleGroupsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListRuleGroupsCommandInput} for command's `input` shape. + * @see {@link ListRuleGroupsCommandOutput} for command's `response` shape. + * @see {@link WAFClientResolvedConfig | config} for command's `input` shape. + * */ export class ListRuleGroupsCommand extends $Command< ListRuleGroupsCommandInput, diff --git a/clients/client-waf/commands/ListRulesCommand.ts b/clients/client-waf/commands/ListRulesCommand.ts index aa38560b7c10..77264cb2d582 100644 --- a/clients/client-waf/commands/ListRulesCommand.ts +++ b/clients/client-waf/commands/ListRulesCommand.ts @@ -27,6 +27,20 @@ export interface ListRulesCommandOutput extends ListRulesResponse, __MetadataBea * 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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { WAFClient, ListRulesCommand } from "@aws-sdk/client-waf"; // ES Modules import + * // const { WAFClient, ListRulesCommand } = require("@aws-sdk/client-waf"); // CommonJS import + * const client = new WAFClient(config); + * const command = new ListRulesCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListRulesCommandInput} for command's `input` shape. + * @see {@link ListRulesCommandOutput} for command's `response` shape. + * @see {@link WAFClientResolvedConfig | config} for command's `input` shape. + * */ export class ListRulesCommand extends $Command { // Start section: command_properties diff --git a/clients/client-waf/commands/ListSizeConstraintSetsCommand.ts b/clients/client-waf/commands/ListSizeConstraintSetsCommand.ts index 2181376cb37a..8efb42e8f447 100644 --- a/clients/client-waf/commands/ListSizeConstraintSetsCommand.ts +++ b/clients/client-waf/commands/ListSizeConstraintSetsCommand.ts @@ -30,6 +30,20 @@ export interface ListSizeConstraintSetsCommandOutput extends ListSizeConstraintS * 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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { WAFClient, ListSizeConstraintSetsCommand } from "@aws-sdk/client-waf"; // ES Modules import + * // const { WAFClient, ListSizeConstraintSetsCommand } = require("@aws-sdk/client-waf"); // CommonJS import + * const client = new WAFClient(config); + * const command = new ListSizeConstraintSetsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListSizeConstraintSetsCommandInput} for command's `input` shape. + * @see {@link ListSizeConstraintSetsCommandOutput} for command's `response` shape. + * @see {@link WAFClientResolvedConfig | config} for command's `input` shape. + * */ export class ListSizeConstraintSetsCommand extends $Command< ListSizeConstraintSetsCommandInput, diff --git a/clients/client-waf/commands/ListSqlInjectionMatchSetsCommand.ts b/clients/client-waf/commands/ListSqlInjectionMatchSetsCommand.ts index b127e69725db..350054d590cb 100644 --- a/clients/client-waf/commands/ListSqlInjectionMatchSetsCommand.ts +++ b/clients/client-waf/commands/ListSqlInjectionMatchSetsCommand.ts @@ -30,6 +30,20 @@ export interface ListSqlInjectionMatchSetsCommandOutput extends ListSqlInjection * 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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { WAFClient, ListSqlInjectionMatchSetsCommand } from "@aws-sdk/client-waf"; // ES Modules import + * // const { WAFClient, ListSqlInjectionMatchSetsCommand } = require("@aws-sdk/client-waf"); // CommonJS import + * const client = new WAFClient(config); + * const command = new ListSqlInjectionMatchSetsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListSqlInjectionMatchSetsCommandInput} for command's `input` shape. + * @see {@link ListSqlInjectionMatchSetsCommandOutput} for command's `response` shape. + * @see {@link WAFClientResolvedConfig | config} for command's `input` shape. + * */ export class ListSqlInjectionMatchSetsCommand extends $Command< ListSqlInjectionMatchSetsCommandInput, diff --git a/clients/client-waf/commands/ListSubscribedRuleGroupsCommand.ts b/clients/client-waf/commands/ListSubscribedRuleGroupsCommand.ts index 76d9543c600f..67c7cd23d4ad 100644 --- a/clients/client-waf/commands/ListSubscribedRuleGroupsCommand.ts +++ b/clients/client-waf/commands/ListSubscribedRuleGroupsCommand.ts @@ -30,6 +30,20 @@ export interface ListSubscribedRuleGroupsCommandOutput extends ListSubscribedRul * 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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { WAFClient, ListSubscribedRuleGroupsCommand } from "@aws-sdk/client-waf"; // ES Modules import + * // const { WAFClient, ListSubscribedRuleGroupsCommand } = require("@aws-sdk/client-waf"); // CommonJS import + * const client = new WAFClient(config); + * const command = new ListSubscribedRuleGroupsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListSubscribedRuleGroupsCommandInput} for command's `input` shape. + * @see {@link ListSubscribedRuleGroupsCommandOutput} for command's `response` shape. + * @see {@link WAFClientResolvedConfig | config} for command's `input` shape. + * */ export class ListSubscribedRuleGroupsCommand extends $Command< ListSubscribedRuleGroupsCommandInput, diff --git a/clients/client-waf/commands/ListTagsForResourceCommand.ts b/clients/client-waf/commands/ListTagsForResourceCommand.ts index 68c8e3767267..8db45e2f59db 100644 --- a/clients/client-waf/commands/ListTagsForResourceCommand.ts +++ b/clients/client-waf/commands/ListTagsForResourceCommand.ts @@ -31,6 +31,20 @@ export interface ListTagsForResourceCommandOutput extends ListTagsForResourceRes * *

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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { WAFClient, ListTagsForResourceCommand } from "@aws-sdk/client-waf"; // ES Modules import + * // const { WAFClient, ListTagsForResourceCommand } = require("@aws-sdk/client-waf"); // CommonJS import + * const client = new WAFClient(config); + * const command = new ListTagsForResourceCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListTagsForResourceCommandInput} for command's `input` shape. + * @see {@link ListTagsForResourceCommandOutput} for command's `response` shape. + * @see {@link WAFClientResolvedConfig | config} for command's `input` shape. + * */ export class ListTagsForResourceCommand extends $Command< ListTagsForResourceCommandInput, diff --git a/clients/client-waf/commands/ListWebACLsCommand.ts b/clients/client-waf/commands/ListWebACLsCommand.ts index a8e243da47c0..1bf117615b64 100644 --- a/clients/client-waf/commands/ListWebACLsCommand.ts +++ b/clients/client-waf/commands/ListWebACLsCommand.ts @@ -30,6 +30,20 @@ export interface ListWebACLsCommandOutput extends ListWebACLsResponse, __Metadat * 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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { WAFClient, ListWebACLsCommand } from "@aws-sdk/client-waf"; // ES Modules import + * // const { WAFClient, ListWebACLsCommand } = require("@aws-sdk/client-waf"); // CommonJS import + * const client = new WAFClient(config); + * const command = new ListWebACLsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListWebACLsCommandInput} for command's `input` shape. + * @see {@link ListWebACLsCommandOutput} for command's `response` shape. + * @see {@link WAFClientResolvedConfig | config} for command's `input` shape. + * */ export class ListWebACLsCommand extends $Command< ListWebACLsCommandInput, diff --git a/clients/client-waf/commands/ListXssMatchSetsCommand.ts b/clients/client-waf/commands/ListXssMatchSetsCommand.ts index dcdf2c862403..0b23d38982cb 100644 --- a/clients/client-waf/commands/ListXssMatchSetsCommand.ts +++ b/clients/client-waf/commands/ListXssMatchSetsCommand.ts @@ -30,6 +30,20 @@ export interface ListXssMatchSetsCommandOutput extends ListXssMatchSetsResponse, * 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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { WAFClient, ListXssMatchSetsCommand } from "@aws-sdk/client-waf"; // ES Modules import + * // const { WAFClient, ListXssMatchSetsCommand } = require("@aws-sdk/client-waf"); // CommonJS import + * const client = new WAFClient(config); + * const command = new ListXssMatchSetsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListXssMatchSetsCommandInput} for command's `input` shape. + * @see {@link ListXssMatchSetsCommandOutput} for command's `response` shape. + * @see {@link WAFClientResolvedConfig | config} for command's `input` shape. + * */ export class ListXssMatchSetsCommand extends $Command< ListXssMatchSetsCommandInput, diff --git a/clients/client-waf/commands/PutLoggingConfigurationCommand.ts b/clients/client-waf/commands/PutLoggingConfigurationCommand.ts index a98df25498d4..d836297acddf 100644 --- a/clients/client-waf/commands/PutLoggingConfigurationCommand.ts +++ b/clients/client-waf/commands/PutLoggingConfigurationCommand.ts @@ -47,6 +47,20 @@ export interface PutLoggingConfigurationCommandOutput extends PutLoggingConfigur * * *

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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { WAFClient, PutLoggingConfigurationCommand } from "@aws-sdk/client-waf"; // ES Modules import + * // const { WAFClient, PutLoggingConfigurationCommand } = require("@aws-sdk/client-waf"); // CommonJS import + * const client = new WAFClient(config); + * const command = new PutLoggingConfigurationCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link PutLoggingConfigurationCommandInput} for command's `input` shape. + * @see {@link PutLoggingConfigurationCommandOutput} for command's `response` shape. + * @see {@link WAFClientResolvedConfig | config} for command's `input` shape. + * */ export class PutLoggingConfigurationCommand extends $Command< PutLoggingConfigurationCommandInput, diff --git a/clients/client-waf/commands/PutPermissionPolicyCommand.ts b/clients/client-waf/commands/PutPermissionPolicyCommand.ts index 4dfeb938f0a8..25366df1e474 100644 --- a/clients/client-waf/commands/PutPermissionPolicyCommand.ts +++ b/clients/client-waf/commands/PutPermissionPolicyCommand.ts @@ -62,6 +62,20 @@ export interface PutPermissionPolicyCommandOutput extends PutPermissionPolicyRes *

For more information, see IAM Policies.

* *

An example of a valid policy parameter is shown in the Examples section below.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { WAFClient, PutPermissionPolicyCommand } from "@aws-sdk/client-waf"; // ES Modules import + * // const { WAFClient, PutPermissionPolicyCommand } = require("@aws-sdk/client-waf"); // CommonJS import + * const client = new WAFClient(config); + * const command = new PutPermissionPolicyCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link PutPermissionPolicyCommandInput} for command's `input` shape. + * @see {@link PutPermissionPolicyCommandOutput} for command's `response` shape. + * @see {@link WAFClientResolvedConfig | config} for command's `input` shape. + * */ export class PutPermissionPolicyCommand extends $Command< PutPermissionPolicyCommandInput, diff --git a/clients/client-waf/commands/TagResourceCommand.ts b/clients/client-waf/commands/TagResourceCommand.ts index e042a07517f2..c149a71a55b8 100644 --- a/clients/client-waf/commands/TagResourceCommand.ts +++ b/clients/client-waf/commands/TagResourceCommand.ts @@ -31,6 +31,20 @@ export interface TagResourceCommandOutput extends TagResourceResponse, __Metadat * *

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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { WAFClient, TagResourceCommand } from "@aws-sdk/client-waf"; // ES Modules import + * // const { WAFClient, TagResourceCommand } = require("@aws-sdk/client-waf"); // CommonJS import + * const client = new WAFClient(config); + * const command = new TagResourceCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link TagResourceCommandInput} for command's `input` shape. + * @see {@link TagResourceCommandOutput} for command's `response` shape. + * @see {@link WAFClientResolvedConfig | config} for command's `input` shape. + * */ export class TagResourceCommand extends $Command< TagResourceCommandInput, diff --git a/clients/client-waf/commands/UntagResourceCommand.ts b/clients/client-waf/commands/UntagResourceCommand.ts index 86636f3b6ffc..729377c1240d 100644 --- a/clients/client-waf/commands/UntagResourceCommand.ts +++ b/clients/client-waf/commands/UntagResourceCommand.ts @@ -30,6 +30,20 @@ export interface UntagResourceCommandOutput extends UntagResourceResponse, __Met * 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.

* *

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { WAFClient, UntagResourceCommand } from "@aws-sdk/client-waf"; // ES Modules import + * // const { WAFClient, UntagResourceCommand } = require("@aws-sdk/client-waf"); // CommonJS import + * const client = new WAFClient(config); + * const command = new UntagResourceCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link UntagResourceCommandInput} for command's `input` shape. + * @see {@link UntagResourceCommandOutput} for command's `response` shape. + * @see {@link WAFClientResolvedConfig | config} for command's `input` shape. + * */ export class UntagResourceCommand extends $Command< UntagResourceCommandInput, diff --git a/clients/client-waf/commands/UpdateByteMatchSetCommand.ts b/clients/client-waf/commands/UpdateByteMatchSetCommand.ts index 4230a5aab83b..9be45a1f7bea 100644 --- a/clients/client-waf/commands/UpdateByteMatchSetCommand.ts +++ b/clients/client-waf/commands/UpdateByteMatchSetCommand.ts @@ -68,6 +68,20 @@ export interface UpdateByteMatchSetCommandOutput extends UpdateByteMatchSetRespo * *

For more information about how to use the AWS WAF API to allow or block HTTP requests, see the * AWS WAF Developer Guide.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { WAFClient, UpdateByteMatchSetCommand } from "@aws-sdk/client-waf"; // ES Modules import + * // const { WAFClient, UpdateByteMatchSetCommand } = require("@aws-sdk/client-waf"); // CommonJS import + * const client = new WAFClient(config); + * const command = new UpdateByteMatchSetCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link UpdateByteMatchSetCommandInput} for command's `input` shape. + * @see {@link UpdateByteMatchSetCommandOutput} for command's `response` shape. + * @see {@link WAFClientResolvedConfig | config} for command's `input` shape. + * */ export class UpdateByteMatchSetCommand extends $Command< UpdateByteMatchSetCommandInput, diff --git a/clients/client-waf/commands/UpdateGeoMatchSetCommand.ts b/clients/client-waf/commands/UpdateGeoMatchSetCommand.ts index edf79ffcae20..b41ed258d678 100644 --- a/clients/client-waf/commands/UpdateGeoMatchSetCommand.ts +++ b/clients/client-waf/commands/UpdateGeoMatchSetCommand.ts @@ -60,6 +60,20 @@ export interface UpdateGeoMatchSetCommandOutput extends UpdateGeoMatchSetRespons * 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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { WAFClient, UpdateGeoMatchSetCommand } from "@aws-sdk/client-waf"; // ES Modules import + * // const { WAFClient, UpdateGeoMatchSetCommand } = require("@aws-sdk/client-waf"); // CommonJS import + * const client = new WAFClient(config); + * const command = new UpdateGeoMatchSetCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link UpdateGeoMatchSetCommandInput} for command's `input` shape. + * @see {@link UpdateGeoMatchSetCommandOutput} for command's `response` shape. + * @see {@link WAFClientResolvedConfig | config} for command's `input` shape. + * */ export class UpdateGeoMatchSetCommand extends $Command< UpdateGeoMatchSetCommandInput, diff --git a/clients/client-waf/commands/UpdateIPSetCommand.ts b/clients/client-waf/commands/UpdateIPSetCommand.ts index b26c91c04e34..b846327ff137 100644 --- a/clients/client-waf/commands/UpdateIPSetCommand.ts +++ b/clients/client-waf/commands/UpdateIPSetCommand.ts @@ -95,6 +95,20 @@ export interface UpdateIPSetCommandOutput extends UpdateIPSetResponse, __Metadat *

For more information about how to use the AWS WAF API to allow or block HTTP * requests, see the AWS WAF * Developer Guide.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { WAFClient, UpdateIPSetCommand } from "@aws-sdk/client-waf"; // ES Modules import + * // const { WAFClient, UpdateIPSetCommand } = require("@aws-sdk/client-waf"); // CommonJS import + * const client = new WAFClient(config); + * const command = new UpdateIPSetCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link UpdateIPSetCommandInput} for command's `input` shape. + * @see {@link UpdateIPSetCommandOutput} for command's `response` shape. + * @see {@link WAFClientResolvedConfig | config} for command's `input` shape. + * */ export class UpdateIPSetCommand extends $Command< UpdateIPSetCommandInput, diff --git a/clients/client-waf/commands/UpdateRateBasedRuleCommand.ts b/clients/client-waf/commands/UpdateRateBasedRuleCommand.ts index 1902d3934a15..e844e3660949 100644 --- a/clients/client-waf/commands/UpdateRateBasedRuleCommand.ts +++ b/clients/client-waf/commands/UpdateRateBasedRuleCommand.ts @@ -76,6 +76,20 @@ export interface UpdateRateBasedRuleCommandOutput extends UpdateRateBasedRuleRes * *

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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { WAFClient, UpdateRateBasedRuleCommand } from "@aws-sdk/client-waf"; // ES Modules import + * // const { WAFClient, UpdateRateBasedRuleCommand } = require("@aws-sdk/client-waf"); // CommonJS import + * const client = new WAFClient(config); + * const command = new UpdateRateBasedRuleCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link UpdateRateBasedRuleCommandInput} for command's `input` shape. + * @see {@link UpdateRateBasedRuleCommandOutput} for command's `response` shape. + * @see {@link WAFClientResolvedConfig | config} for command's `input` shape. + * */ export class UpdateRateBasedRuleCommand extends $Command< UpdateRateBasedRuleCommandInput, diff --git a/clients/client-waf/commands/UpdateRegexMatchSetCommand.ts b/clients/client-waf/commands/UpdateRegexMatchSetCommand.ts index 56369fc9d493..486035b899a9 100644 --- a/clients/client-waf/commands/UpdateRegexMatchSetCommand.ts +++ b/clients/client-waf/commands/UpdateRegexMatchSetCommand.ts @@ -64,6 +64,20 @@ export interface UpdateRegexMatchSetCommandOutput extends UpdateRegexMatchSetRes * *

For more information about how to use the AWS WAF API to allow or block HTTP requests, see the * AWS WAF Developer Guide.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { WAFClient, UpdateRegexMatchSetCommand } from "@aws-sdk/client-waf"; // ES Modules import + * // const { WAFClient, UpdateRegexMatchSetCommand } = require("@aws-sdk/client-waf"); // CommonJS import + * const client = new WAFClient(config); + * const command = new UpdateRegexMatchSetCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link UpdateRegexMatchSetCommandInput} for command's `input` shape. + * @see {@link UpdateRegexMatchSetCommandOutput} for command's `response` shape. + * @see {@link WAFClientResolvedConfig | config} for command's `input` shape. + * */ export class UpdateRegexMatchSetCommand extends $Command< UpdateRegexMatchSetCommandInput, diff --git a/clients/client-waf/commands/UpdateRegexPatternSetCommand.ts b/clients/client-waf/commands/UpdateRegexPatternSetCommand.ts index 13921b0fd95c..989ffa62f21e 100644 --- a/clients/client-waf/commands/UpdateRegexPatternSetCommand.ts +++ b/clients/client-waf/commands/UpdateRegexPatternSetCommand.ts @@ -69,6 +69,20 @@ export interface UpdateRegexPatternSetCommandOutput extends UpdateRegexPatternSe * *

For more information about how to use the AWS WAF API to allow or block HTTP requests, see the * AWS WAF Developer Guide.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { WAFClient, UpdateRegexPatternSetCommand } from "@aws-sdk/client-waf"; // ES Modules import + * // const { WAFClient, UpdateRegexPatternSetCommand } = require("@aws-sdk/client-waf"); // CommonJS import + * const client = new WAFClient(config); + * const command = new UpdateRegexPatternSetCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link UpdateRegexPatternSetCommandInput} for command's `input` shape. + * @see {@link UpdateRegexPatternSetCommandOutput} for command's `response` shape. + * @see {@link WAFClientResolvedConfig | config} for command's `input` shape. + * */ export class UpdateRegexPatternSetCommand extends $Command< UpdateRegexPatternSetCommandInput, diff --git a/clients/client-waf/commands/UpdateRuleCommand.ts b/clients/client-waf/commands/UpdateRuleCommand.ts index 97b68f225adc..e8dd641d1496 100644 --- a/clients/client-waf/commands/UpdateRuleCommand.ts +++ b/clients/client-waf/commands/UpdateRuleCommand.ts @@ -71,6 +71,20 @@ export interface UpdateRuleCommandOutput extends UpdateRuleResponse, __MetadataB * 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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { WAFClient, UpdateRuleCommand } from "@aws-sdk/client-waf"; // ES Modules import + * // const { WAFClient, UpdateRuleCommand } = require("@aws-sdk/client-waf"); // CommonJS import + * const client = new WAFClient(config); + * const command = new UpdateRuleCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link UpdateRuleCommandInput} for command's `input` shape. + * @see {@link UpdateRuleCommandOutput} for command's `response` shape. + * @see {@link WAFClientResolvedConfig | config} for command's `input` shape. + * */ export class UpdateRuleCommand extends $Command< UpdateRuleCommandInput, diff --git a/clients/client-waf/commands/UpdateRuleGroupCommand.ts b/clients/client-waf/commands/UpdateRuleGroupCommand.ts index 1b874c6b9a7b..ce47dc8fe53d 100644 --- a/clients/client-waf/commands/UpdateRuleGroupCommand.ts +++ b/clients/client-waf/commands/UpdateRuleGroupCommand.ts @@ -54,6 +54,20 @@ export interface UpdateRuleGroupCommandOutput extends UpdateRuleGroupResponse, _ * 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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { WAFClient, UpdateRuleGroupCommand } from "@aws-sdk/client-waf"; // ES Modules import + * // const { WAFClient, UpdateRuleGroupCommand } = require("@aws-sdk/client-waf"); // CommonJS import + * const client = new WAFClient(config); + * const command = new UpdateRuleGroupCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link UpdateRuleGroupCommandInput} for command's `input` shape. + * @see {@link UpdateRuleGroupCommandOutput} for command's `response` shape. + * @see {@link WAFClientResolvedConfig | config} for command's `input` shape. + * */ export class UpdateRuleGroupCommand extends $Command< UpdateRuleGroupCommandInput, diff --git a/clients/client-waf/commands/UpdateSizeConstraintSetCommand.ts b/clients/client-waf/commands/UpdateSizeConstraintSetCommand.ts index 6a7343c16798..161a4de4536c 100644 --- a/clients/client-waf/commands/UpdateSizeConstraintSetCommand.ts +++ b/clients/client-waf/commands/UpdateSizeConstraintSetCommand.ts @@ -72,6 +72,20 @@ export interface UpdateSizeConstraintSetCommandOutput extends UpdateSizeConstrai * *

For more information about how to use the AWS WAF API to allow or block HTTP requests, see the * AWS WAF Developer Guide.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { WAFClient, UpdateSizeConstraintSetCommand } from "@aws-sdk/client-waf"; // ES Modules import + * // const { WAFClient, UpdateSizeConstraintSetCommand } = require("@aws-sdk/client-waf"); // CommonJS import + * const client = new WAFClient(config); + * const command = new UpdateSizeConstraintSetCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link UpdateSizeConstraintSetCommandInput} for command's `input` shape. + * @see {@link UpdateSizeConstraintSetCommandOutput} for command's `response` shape. + * @see {@link WAFClientResolvedConfig | config} for command's `input` shape. + * */ export class UpdateSizeConstraintSetCommand extends $Command< UpdateSizeConstraintSetCommandInput, diff --git a/clients/client-waf/commands/UpdateSqlInjectionMatchSetCommand.ts b/clients/client-waf/commands/UpdateSqlInjectionMatchSetCommand.ts index 904929492c10..9154fbd87879 100644 --- a/clients/client-waf/commands/UpdateSqlInjectionMatchSetCommand.ts +++ b/clients/client-waf/commands/UpdateSqlInjectionMatchSetCommand.ts @@ -71,6 +71,20 @@ export interface UpdateSqlInjectionMatchSetCommandOutput extends UpdateSqlInject * *

For more information about how to use the AWS WAF API to allow or block HTTP requests, see the * AWS WAF Developer Guide.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { WAFClient, UpdateSqlInjectionMatchSetCommand } from "@aws-sdk/client-waf"; // ES Modules import + * // const { WAFClient, UpdateSqlInjectionMatchSetCommand } = require("@aws-sdk/client-waf"); // CommonJS import + * const client = new WAFClient(config); + * const command = new UpdateSqlInjectionMatchSetCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link UpdateSqlInjectionMatchSetCommandInput} for command's `input` shape. + * @see {@link UpdateSqlInjectionMatchSetCommandOutput} for command's `response` shape. + * @see {@link WAFClientResolvedConfig | config} for command's `input` shape. + * */ export class UpdateSqlInjectionMatchSetCommand extends $Command< UpdateSqlInjectionMatchSetCommandInput, diff --git a/clients/client-waf/commands/UpdateWebACLCommand.ts b/clients/client-waf/commands/UpdateWebACLCommand.ts index 4b4fcb60b340..52aff385da6d 100644 --- a/clients/client-waf/commands/UpdateWebACLCommand.ts +++ b/clients/client-waf/commands/UpdateWebACLCommand.ts @@ -101,6 +101,20 @@ export interface UpdateWebACLCommandOutput extends UpdateWebACLResponse, __Metad * *

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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { WAFClient, UpdateWebACLCommand } from "@aws-sdk/client-waf"; // ES Modules import + * // const { WAFClient, UpdateWebACLCommand } = require("@aws-sdk/client-waf"); // CommonJS import + * const client = new WAFClient(config); + * const command = new UpdateWebACLCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link UpdateWebACLCommandInput} for command's `input` shape. + * @see {@link UpdateWebACLCommandOutput} for command's `response` shape. + * @see {@link WAFClientResolvedConfig | config} for command's `input` shape. + * */ export class UpdateWebACLCommand extends $Command< UpdateWebACLCommandInput, diff --git a/clients/client-waf/commands/UpdateXssMatchSetCommand.ts b/clients/client-waf/commands/UpdateXssMatchSetCommand.ts index 77016b54e06c..35889974551d 100644 --- a/clients/client-waf/commands/UpdateXssMatchSetCommand.ts +++ b/clients/client-waf/commands/UpdateXssMatchSetCommand.ts @@ -73,6 +73,20 @@ export interface UpdateXssMatchSetCommandOutput extends UpdateXssMatchSetRespons * *

For more information about how to use the AWS WAF API to allow or block HTTP requests, see the * AWS WAF Developer Guide.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { WAFClient, UpdateXssMatchSetCommand } from "@aws-sdk/client-waf"; // ES Modules import + * // const { WAFClient, UpdateXssMatchSetCommand } = require("@aws-sdk/client-waf"); // CommonJS import + * const client = new WAFClient(config); + * const command = new UpdateXssMatchSetCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link UpdateXssMatchSetCommandInput} for command's `input` shape. + * @see {@link UpdateXssMatchSetCommandOutput} for command's `response` shape. + * @see {@link WAFClientResolvedConfig | config} for command's `input` shape. + * */ export class UpdateXssMatchSetCommand extends $Command< UpdateXssMatchSetCommandInput, diff --git a/clients/client-waf/models/models_0.ts b/clients/client-waf/models/models_0.ts index 0347e7a886c3..1004fdb1f2fe 100644 --- a/clients/client-waf/models/models_0.ts +++ b/clients/client-waf/models/models_0.ts @@ -44,6 +44,9 @@ export interface WafAction { } export namespace WafAction { + /** + * @internal + */ export const filterSensitiveLog = (obj: WafAction): any => ({ ...obj, }); @@ -70,6 +73,9 @@ export interface ExcludedRule { } export namespace ExcludedRule { + /** + * @internal + */ export const filterSensitiveLog = (obj: ExcludedRule): any => ({ ...obj, }); @@ -100,6 +106,9 @@ export interface WafOverrideAction { } export namespace WafOverrideAction { + /** + * @internal + */ export const filterSensitiveLog = (obj: WafOverrideAction): any => ({ ...obj, }); @@ -231,6 +240,9 @@ export interface ActivatedRule { } export namespace ActivatedRule { + /** + * @internal + */ export const filterSensitiveLog = (obj: ActivatedRule): any => ({ ...obj, }); @@ -250,6 +262,9 @@ export interface CreateByteMatchSetRequest { } export namespace CreateByteMatchSetRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateByteMatchSetRequest): any => ({ ...obj, }); @@ -331,6 +346,9 @@ export interface FieldToMatch { } export namespace FieldToMatch { + /** + * @internal + */ export const filterSensitiveLog = (obj: FieldToMatch): any => ({ ...obj, }); @@ -586,6 +604,9 @@ export interface ByteMatchTuple { } export namespace ByteMatchTuple { + /** + * @internal + */ export const filterSensitiveLog = (obj: ByteMatchTuple): any => ({ ...obj, }); @@ -630,6 +651,9 @@ export interface ByteMatchSet { } export namespace ByteMatchSet { + /** + * @internal + */ export const filterSensitiveLog = (obj: ByteMatchSet): any => ({ ...obj, }); @@ -649,6 +673,9 @@ export interface CreateByteMatchSetResponse { } export namespace CreateByteMatchSetResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateByteMatchSetResponse): any => ({ ...obj, }); @@ -664,6 +691,9 @@ export interface WAFDisallowedNameException extends __SmithyException, $Metadata } export namespace WAFDisallowedNameException { + /** + * @internal + */ export const filterSensitiveLog = (obj: WAFDisallowedNameException): any => ({ ...obj, }); @@ -679,6 +709,9 @@ export interface WAFInternalErrorException extends __SmithyException, $MetadataB } export namespace WAFInternalErrorException { + /** + * @internal + */ export const filterSensitiveLog = (obj: WAFInternalErrorException): any => ({ ...obj, }); @@ -693,6 +726,9 @@ export interface WAFInvalidAccountException extends __SmithyException, $Metadata } export namespace WAFInvalidAccountException { + /** + * @internal + */ export const filterSensitiveLog = (obj: WAFInvalidAccountException): any => ({ ...obj, }); @@ -775,6 +811,9 @@ export interface WAFInvalidParameterException extends __SmithyException, $Metada } export namespace WAFInvalidParameterException { + /** + * @internal + */ export const filterSensitiveLog = (obj: WAFInvalidParameterException): any => ({ ...obj, }); @@ -792,6 +831,9 @@ export interface WAFLimitsExceededException extends __SmithyException, $Metadata } export namespace WAFLimitsExceededException { + /** + * @internal + */ export const filterSensitiveLog = (obj: WAFLimitsExceededException): any => ({ ...obj, }); @@ -807,6 +849,9 @@ export interface WAFStaleDataException extends __SmithyException, $MetadataBeare } export namespace WAFStaleDataException { + /** + * @internal + */ export const filterSensitiveLog = (obj: WAFStaleDataException): any => ({ ...obj, }); @@ -825,6 +870,9 @@ export interface CreateGeoMatchSetRequest { } export namespace CreateGeoMatchSetRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateGeoMatchSetRequest): any => ({ ...obj, }); @@ -1110,6 +1158,9 @@ export interface GeoMatchConstraint { } export namespace GeoMatchConstraint { + /** + * @internal + */ export const filterSensitiveLog = (obj: GeoMatchConstraint): any => ({ ...obj, }); @@ -1147,6 +1198,9 @@ export interface GeoMatchSet { } export namespace GeoMatchSet { + /** + * @internal + */ export const filterSensitiveLog = (obj: GeoMatchSet): any => ({ ...obj, }); @@ -1166,6 +1220,9 @@ export interface CreateGeoMatchSetResponse { } export namespace CreateGeoMatchSetResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateGeoMatchSetResponse): any => ({ ...obj, }); @@ -1184,6 +1241,9 @@ export interface CreateIPSetRequest { } export namespace CreateIPSetRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateIPSetRequest): any => ({ ...obj, }); @@ -1239,6 +1299,9 @@ export interface IPSetDescriptor { } export namespace IPSetDescriptor { + /** + * @internal + */ export const filterSensitiveLog = (obj: IPSetDescriptor): any => ({ ...obj, }); @@ -1284,6 +1347,9 @@ export interface IPSet { } export namespace IPSet { + /** + * @internal + */ export const filterSensitiveLog = (obj: IPSet): any => ({ ...obj, }); @@ -1303,6 +1369,9 @@ export interface CreateIPSetResponse { } export namespace CreateIPSetResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateIPSetResponse): any => ({ ...obj, }); @@ -1337,6 +1406,9 @@ export interface Tag { } export namespace Tag { + /** + * @internal + */ export const filterSensitiveLog = (obj: Tag): any => ({ ...obj, }); @@ -1388,6 +1460,9 @@ export interface CreateRateBasedRuleRequest { } export namespace CreateRateBasedRuleRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateRateBasedRuleRequest): any => ({ ...obj, }); @@ -1442,6 +1517,9 @@ export interface Predicate { } export namespace Predicate { + /** + * @internal + */ export const filterSensitiveLog = (obj: Predicate): any => ({ ...obj, }); @@ -1522,6 +1600,9 @@ export interface RateBasedRule { } export namespace RateBasedRule { + /** + * @internal + */ export const filterSensitiveLog = (obj: RateBasedRule): any => ({ ...obj, }); @@ -1543,6 +1624,9 @@ export interface CreateRateBasedRuleResponse { } export namespace CreateRateBasedRuleResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateRateBasedRuleResponse): any => ({ ...obj, }); @@ -1558,6 +1642,9 @@ export interface WAFBadRequestException extends __SmithyException, $MetadataBear } export namespace WAFBadRequestException { + /** + * @internal + */ export const filterSensitiveLog = (obj: WAFBadRequestException): any => ({ ...obj, }); @@ -1573,6 +1660,9 @@ export interface WAFTagOperationException extends __SmithyException, $MetadataBe } export namespace WAFTagOperationException { + /** + * @internal + */ export const filterSensitiveLog = (obj: WAFTagOperationException): any => ({ ...obj, }); @@ -1588,6 +1678,9 @@ export interface WAFTagOperationInternalErrorException extends __SmithyException } export namespace WAFTagOperationInternalErrorException { + /** + * @internal + */ export const filterSensitiveLog = (obj: WAFTagOperationInternalErrorException): any => ({ ...obj, }); @@ -1607,6 +1700,9 @@ export interface CreateRegexMatchSetRequest { } export namespace CreateRegexMatchSetRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateRegexMatchSetRequest): any => ({ ...obj, }); @@ -1748,6 +1844,9 @@ export interface RegexMatchTuple { } export namespace RegexMatchTuple { + /** + * @internal + */ export const filterSensitiveLog = (obj: RegexMatchTuple): any => ({ ...obj, }); @@ -1804,6 +1903,9 @@ export interface RegexMatchSet { } export namespace RegexMatchSet { + /** + * @internal + */ export const filterSensitiveLog = (obj: RegexMatchSet): any => ({ ...obj, }); @@ -1823,6 +1925,9 @@ export interface CreateRegexMatchSetResponse { } export namespace CreateRegexMatchSetResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateRegexMatchSetResponse): any => ({ ...obj, }); @@ -1842,6 +1947,9 @@ export interface CreateRegexPatternSetRequest { } export namespace CreateRegexPatternSetRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateRegexPatternSetRequest): any => ({ ...obj, }); @@ -1879,6 +1987,9 @@ export interface RegexPatternSet { } export namespace RegexPatternSet { + /** + * @internal + */ export const filterSensitiveLog = (obj: RegexPatternSet): any => ({ ...obj, }); @@ -1898,6 +2009,9 @@ export interface CreateRegexPatternSetResponse { } export namespace CreateRegexPatternSetResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateRegexPatternSetResponse): any => ({ ...obj, }); @@ -1928,6 +2042,9 @@ export interface CreateRuleRequest { } export namespace CreateRuleRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateRuleRequest): any => ({ ...obj, }); @@ -1986,6 +2103,9 @@ export interface Rule { } export namespace Rule { + /** + * @internal + */ export const filterSensitiveLog = (obj: Rule): any => ({ ...obj, }); @@ -2005,6 +2125,9 @@ export interface CreateRuleResponse { } export namespace CreateRuleResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateRuleResponse): any => ({ ...obj, }); @@ -2035,6 +2158,9 @@ export interface CreateRuleGroupRequest { } export namespace CreateRuleGroupRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateRuleGroupRequest): any => ({ ...obj, }); @@ -2086,6 +2212,9 @@ export interface RuleGroup { } export namespace RuleGroup { + /** + * @internal + */ export const filterSensitiveLog = (obj: RuleGroup): any => ({ ...obj, }); @@ -2105,6 +2234,9 @@ export interface CreateRuleGroupResponse { } export namespace CreateRuleGroupResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateRuleGroupResponse): any => ({ ...obj, }); @@ -2124,6 +2256,9 @@ export interface CreateSizeConstraintSetRequest { } export namespace CreateSizeConstraintSetRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateSizeConstraintSetRequest): any => ({ ...obj, }); @@ -2294,6 +2429,9 @@ export interface SizeConstraint { } export namespace SizeConstraint { + /** + * @internal + */ export const filterSensitiveLog = (obj: SizeConstraint): any => ({ ...obj, }); @@ -2336,6 +2474,9 @@ export interface SizeConstraintSet { } export namespace SizeConstraintSet { + /** + * @internal + */ export const filterSensitiveLog = (obj: SizeConstraintSet): any => ({ ...obj, }); @@ -2355,6 +2496,9 @@ export interface CreateSizeConstraintSetResponse { } export namespace CreateSizeConstraintSetResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateSizeConstraintSetResponse): any => ({ ...obj, }); @@ -2377,6 +2521,9 @@ export interface CreateSqlInjectionMatchSetRequest { } export namespace CreateSqlInjectionMatchSetRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateSqlInjectionMatchSetRequest): any => ({ ...obj, }); @@ -2498,6 +2645,9 @@ export interface SqlInjectionMatchTuple { } export namespace SqlInjectionMatchTuple { + /** + * @internal + */ export const filterSensitiveLog = (obj: SqlInjectionMatchTuple): any => ({ ...obj, }); @@ -2541,6 +2691,9 @@ export interface SqlInjectionMatchSet { } export namespace SqlInjectionMatchSet { + /** + * @internal + */ export const filterSensitiveLog = (obj: SqlInjectionMatchSet): any => ({ ...obj, }); @@ -2563,6 +2716,9 @@ export interface CreateSqlInjectionMatchSetResponse { } export namespace CreateSqlInjectionMatchSetResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateSqlInjectionMatchSetResponse): any => ({ ...obj, }); @@ -2599,6 +2755,9 @@ export interface CreateWebACLRequest { } export namespace CreateWebACLRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateWebACLRequest): any => ({ ...obj, }); @@ -2660,6 +2819,9 @@ export interface WebACL { } export namespace WebACL { + /** + * @internal + */ export const filterSensitiveLog = (obj: WebACL): any => ({ ...obj, }); @@ -2679,6 +2841,9 @@ export interface CreateWebACLResponse { } export namespace CreateWebACLResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateWebACLResponse): any => ({ ...obj, }); @@ -2717,6 +2882,9 @@ export interface CreateWebACLMigrationStackRequest { } export namespace CreateWebACLMigrationStackRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateWebACLMigrationStackRequest): any => ({ ...obj, }); @@ -2730,6 +2898,9 @@ export interface CreateWebACLMigrationStackResponse { } export namespace CreateWebACLMigrationStackResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateWebACLMigrationStackResponse): any => ({ ...obj, }); @@ -2787,6 +2958,9 @@ export interface WAFEntityMigrationException extends __SmithyException, $Metadat } export namespace WAFEntityMigrationException { + /** + * @internal + */ export const filterSensitiveLog = (obj: WAFEntityMigrationException): any => ({ ...obj, }); @@ -2822,6 +2996,9 @@ export interface WAFInvalidOperationException extends __SmithyException, $Metada } export namespace WAFInvalidOperationException { + /** + * @internal + */ export const filterSensitiveLog = (obj: WAFInvalidOperationException): any => ({ ...obj, }); @@ -2837,6 +3014,9 @@ export interface WAFNonexistentItemException extends __SmithyException, $Metadat } export namespace WAFNonexistentItemException { + /** + * @internal + */ export const filterSensitiveLog = (obj: WAFNonexistentItemException): any => ({ ...obj, }); @@ -2859,6 +3039,9 @@ export interface CreateXssMatchSetRequest { } export namespace CreateXssMatchSetRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateXssMatchSetRequest): any => ({ ...obj, }); @@ -2980,6 +3163,9 @@ export interface XssMatchTuple { } export namespace XssMatchTuple { + /** + * @internal + */ export const filterSensitiveLog = (obj: XssMatchTuple): any => ({ ...obj, }); @@ -3023,6 +3209,9 @@ export interface XssMatchSet { } export namespace XssMatchSet { + /** + * @internal + */ export const filterSensitiveLog = (obj: XssMatchSet): any => ({ ...obj, }); @@ -3045,6 +3234,9 @@ export interface CreateXssMatchSetResponse { } export namespace CreateXssMatchSetResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateXssMatchSetResponse): any => ({ ...obj, }); @@ -3064,6 +3256,9 @@ export interface DeleteByteMatchSetRequest { } export namespace DeleteByteMatchSetRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteByteMatchSetRequest): any => ({ ...obj, }); @@ -3078,6 +3273,9 @@ export interface DeleteByteMatchSetResponse { } export namespace DeleteByteMatchSetResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteByteMatchSetResponse): any => ({ ...obj, }); @@ -3108,6 +3306,9 @@ export interface WAFNonEmptyEntityException extends __SmithyException, $Metadata } export namespace WAFNonEmptyEntityException { + /** + * @internal + */ export const filterSensitiveLog = (obj: WAFNonEmptyEntityException): any => ({ ...obj, }); @@ -3131,6 +3332,9 @@ export interface WAFReferencedItemException extends __SmithyException, $Metadata } export namespace WAFReferencedItemException { + /** + * @internal + */ export const filterSensitiveLog = (obj: WAFReferencedItemException): any => ({ ...obj, }); @@ -3150,6 +3354,9 @@ export interface DeleteGeoMatchSetRequest { } export namespace DeleteGeoMatchSetRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteGeoMatchSetRequest): any => ({ ...obj, }); @@ -3164,6 +3371,9 @@ export interface DeleteGeoMatchSetResponse { } export namespace DeleteGeoMatchSetResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteGeoMatchSetResponse): any => ({ ...obj, }); @@ -3183,6 +3393,9 @@ export interface DeleteIPSetRequest { } export namespace DeleteIPSetRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteIPSetRequest): any => ({ ...obj, }); @@ -3197,6 +3410,9 @@ export interface DeleteIPSetResponse { } export namespace DeleteIPSetResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteIPSetResponse): any => ({ ...obj, }); @@ -3210,6 +3426,9 @@ export interface DeleteLoggingConfigurationRequest { } export namespace DeleteLoggingConfigurationRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteLoggingConfigurationRequest): any => ({ ...obj, }); @@ -3218,6 +3437,9 @@ export namespace DeleteLoggingConfigurationRequest { export interface DeleteLoggingConfigurationResponse {} export namespace DeleteLoggingConfigurationResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteLoggingConfigurationResponse): any => ({ ...obj, }); @@ -3232,6 +3454,9 @@ export interface DeletePermissionPolicyRequest { } export namespace DeletePermissionPolicyRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeletePermissionPolicyRequest): any => ({ ...obj, }); @@ -3240,6 +3465,9 @@ export namespace DeletePermissionPolicyRequest { export interface DeletePermissionPolicyResponse {} export namespace DeletePermissionPolicyResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeletePermissionPolicyResponse): any => ({ ...obj, }); @@ -3260,6 +3488,9 @@ export interface DeleteRateBasedRuleRequest { } export namespace DeleteRateBasedRuleRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteRateBasedRuleRequest): any => ({ ...obj, }); @@ -3275,6 +3506,9 @@ export interface DeleteRateBasedRuleResponse { } export namespace DeleteRateBasedRuleResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteRateBasedRuleResponse): any => ({ ...obj, }); @@ -3294,6 +3528,9 @@ export interface DeleteRegexMatchSetRequest { } export namespace DeleteRegexMatchSetRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteRegexMatchSetRequest): any => ({ ...obj, }); @@ -3308,6 +3545,9 @@ export interface DeleteRegexMatchSetResponse { } export namespace DeleteRegexMatchSetResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteRegexMatchSetResponse): any => ({ ...obj, }); @@ -3327,6 +3567,9 @@ export interface DeleteRegexPatternSetRequest { } export namespace DeleteRegexPatternSetRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteRegexPatternSetRequest): any => ({ ...obj, }); @@ -3341,6 +3584,9 @@ export interface DeleteRegexPatternSetResponse { } export namespace DeleteRegexPatternSetResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteRegexPatternSetResponse): any => ({ ...obj, }); @@ -3360,6 +3606,9 @@ export interface DeleteRuleRequest { } export namespace DeleteRuleRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteRuleRequest): any => ({ ...obj, }); @@ -3374,6 +3623,9 @@ export interface DeleteRuleResponse { } export namespace DeleteRuleResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteRuleResponse): any => ({ ...obj, }); @@ -3393,6 +3645,9 @@ export interface DeleteRuleGroupRequest { } export namespace DeleteRuleGroupRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteRuleGroupRequest): any => ({ ...obj, }); @@ -3407,6 +3662,9 @@ export interface DeleteRuleGroupResponse { } export namespace DeleteRuleGroupResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteRuleGroupResponse): any => ({ ...obj, }); @@ -3426,6 +3684,9 @@ export interface DeleteSizeConstraintSetRequest { } export namespace DeleteSizeConstraintSetRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteSizeConstraintSetRequest): any => ({ ...obj, }); @@ -3440,6 +3701,9 @@ export interface DeleteSizeConstraintSetResponse { } export namespace DeleteSizeConstraintSetResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteSizeConstraintSetResponse): any => ({ ...obj, }); @@ -3462,6 +3726,9 @@ export interface DeleteSqlInjectionMatchSetRequest { } export namespace DeleteSqlInjectionMatchSetRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteSqlInjectionMatchSetRequest): any => ({ ...obj, }); @@ -3479,6 +3746,9 @@ export interface DeleteSqlInjectionMatchSetResponse { } export namespace DeleteSqlInjectionMatchSetResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteSqlInjectionMatchSetResponse): any => ({ ...obj, }); @@ -3498,6 +3768,9 @@ export interface DeleteWebACLRequest { } export namespace DeleteWebACLRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteWebACLRequest): any => ({ ...obj, }); @@ -3512,6 +3785,9 @@ export interface DeleteWebACLResponse { } export namespace DeleteWebACLResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteWebACLResponse): any => ({ ...obj, }); @@ -3534,6 +3810,9 @@ export interface DeleteXssMatchSetRequest { } export namespace DeleteXssMatchSetRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteXssMatchSetRequest): any => ({ ...obj, }); @@ -3551,6 +3830,9 @@ export interface DeleteXssMatchSetResponse { } export namespace DeleteXssMatchSetResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteXssMatchSetResponse): any => ({ ...obj, }); @@ -3565,6 +3847,9 @@ export interface GetByteMatchSetRequest { } export namespace GetByteMatchSetRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetByteMatchSetRequest): any => ({ ...obj, }); @@ -3598,6 +3883,9 @@ export interface GetByteMatchSetResponse { } export namespace GetByteMatchSetResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetByteMatchSetResponse): any => ({ ...obj, }); @@ -3606,6 +3894,9 @@ export namespace GetByteMatchSetResponse { export interface GetChangeTokenRequest {} export namespace GetChangeTokenRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetChangeTokenRequest): any => ({ ...obj, }); @@ -3620,6 +3911,9 @@ export interface GetChangeTokenResponse { } export namespace GetChangeTokenResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetChangeTokenResponse): any => ({ ...obj, }); @@ -3633,6 +3927,9 @@ export interface GetChangeTokenStatusRequest { } export namespace GetChangeTokenStatusRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetChangeTokenStatusRequest): any => ({ ...obj, }); @@ -3652,6 +3949,9 @@ export interface GetChangeTokenStatusResponse { } export namespace GetChangeTokenStatusResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetChangeTokenStatusResponse): any => ({ ...obj, }); @@ -3666,6 +3966,9 @@ export interface GetGeoMatchSetRequest { } export namespace GetGeoMatchSetRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetGeoMatchSetRequest): any => ({ ...obj, }); @@ -3679,6 +3982,9 @@ export interface GetGeoMatchSetResponse { } export namespace GetGeoMatchSetResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetGeoMatchSetResponse): any => ({ ...obj, }); @@ -3693,6 +3999,9 @@ export interface GetIPSetRequest { } export namespace GetIPSetRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetIPSetRequest): any => ({ ...obj, }); @@ -3720,6 +4029,9 @@ export interface GetIPSetResponse { } export namespace GetIPSetResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetIPSetResponse): any => ({ ...obj, }); @@ -3733,6 +4045,9 @@ export interface GetLoggingConfigurationRequest { } export namespace GetLoggingConfigurationRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetLoggingConfigurationRequest): any => ({ ...obj, }); @@ -3772,6 +4087,9 @@ export interface LoggingConfiguration { } export namespace LoggingConfiguration { + /** + * @internal + */ export const filterSensitiveLog = (obj: LoggingConfiguration): any => ({ ...obj, }); @@ -3785,6 +4103,9 @@ export interface GetLoggingConfigurationResponse { } export namespace GetLoggingConfigurationResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetLoggingConfigurationResponse): any => ({ ...obj, }); @@ -3798,6 +4119,9 @@ export interface GetPermissionPolicyRequest { } export namespace GetPermissionPolicyRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetPermissionPolicyRequest): any => ({ ...obj, }); @@ -3811,6 +4135,9 @@ export interface GetPermissionPolicyResponse { } export namespace GetPermissionPolicyResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetPermissionPolicyResponse): any => ({ ...obj, }); @@ -3825,6 +4152,9 @@ export interface GetRateBasedRuleRequest { } export namespace GetRateBasedRuleRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetRateBasedRuleRequest): any => ({ ...obj, }); @@ -3839,6 +4169,9 @@ export interface GetRateBasedRuleResponse { } export namespace GetRateBasedRuleResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetRateBasedRuleResponse): any => ({ ...obj, }); @@ -3858,6 +4191,9 @@ export interface GetRateBasedRuleManagedKeysRequest { } export namespace GetRateBasedRuleManagedKeysRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetRateBasedRuleManagedKeysRequest): any => ({ ...obj, }); @@ -3876,6 +4212,9 @@ export interface GetRateBasedRuleManagedKeysResponse { } export namespace GetRateBasedRuleManagedKeysResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetRateBasedRuleManagedKeysResponse): any => ({ ...obj, }); @@ -3890,6 +4229,9 @@ export interface GetRegexMatchSetRequest { } export namespace GetRegexMatchSetRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetRegexMatchSetRequest): any => ({ ...obj, }); @@ -3903,6 +4245,9 @@ export interface GetRegexMatchSetResponse { } export namespace GetRegexMatchSetResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetRegexMatchSetResponse): any => ({ ...obj, }); @@ -3917,6 +4262,9 @@ export interface GetRegexPatternSetRequest { } export namespace GetRegexPatternSetRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetRegexPatternSetRequest): any => ({ ...obj, }); @@ -3930,6 +4278,9 @@ export interface GetRegexPatternSetResponse { } export namespace GetRegexPatternSetResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetRegexPatternSetResponse): any => ({ ...obj, }); @@ -3944,6 +4295,9 @@ export interface GetRuleRequest { } export namespace GetRuleRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetRuleRequest): any => ({ ...obj, }); @@ -3972,6 +4326,9 @@ export interface GetRuleResponse { } export namespace GetRuleResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetRuleResponse): any => ({ ...obj, }); @@ -3986,6 +4343,9 @@ export interface GetRuleGroupRequest { } export namespace GetRuleGroupRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetRuleGroupRequest): any => ({ ...obj, }); @@ -3999,6 +4359,9 @@ export interface GetRuleGroupResponse { } export namespace GetRuleGroupResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetRuleGroupResponse): any => ({ ...obj, }); @@ -4042,6 +4405,9 @@ export interface TimeWindow { } export namespace TimeWindow { + /** + * @internal + */ export const filterSensitiveLog = (obj: TimeWindow): any => ({ ...obj, }); @@ -4085,6 +4451,9 @@ export interface GetSampledRequestsRequest { } export namespace GetSampledRequestsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetSampledRequestsRequest): any => ({ ...obj, }); @@ -4116,6 +4485,9 @@ export interface HTTPHeader { } export namespace HTTPHeader { + /** + * @internal + */ export const filterSensitiveLog = (obj: HTTPHeader): any => ({ ...obj, }); @@ -4180,6 +4552,9 @@ export interface HTTPRequest { } export namespace HTTPRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: HTTPRequest): any => ({ ...obj, }); @@ -4228,6 +4603,9 @@ export interface SampledHTTPRequest { } export namespace SampledHTTPRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: SampledHTTPRequest): any => ({ ...obj, }); @@ -4255,6 +4633,9 @@ export interface GetSampledRequestsResponse { } export namespace GetSampledRequestsResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetSampledRequestsResponse): any => ({ ...obj, }); @@ -4269,6 +4650,9 @@ export interface GetSizeConstraintSetRequest { } export namespace GetSizeConstraintSetRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetSizeConstraintSetRequest): any => ({ ...obj, }); @@ -4302,6 +4686,9 @@ export interface GetSizeConstraintSetResponse { } export namespace GetSizeConstraintSetResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetSizeConstraintSetResponse): any => ({ ...obj, }); @@ -4319,6 +4706,9 @@ export interface GetSqlInjectionMatchSetRequest { } export namespace GetSqlInjectionMatchSetRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetSqlInjectionMatchSetRequest): any => ({ ...obj, }); @@ -4354,6 +4744,9 @@ export interface GetSqlInjectionMatchSetResponse { } export namespace GetSqlInjectionMatchSetResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetSqlInjectionMatchSetResponse): any => ({ ...obj, }); @@ -4368,6 +4761,9 @@ export interface GetWebACLRequest { } export namespace GetWebACLRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetWebACLRequest): any => ({ ...obj, }); @@ -4406,6 +4802,9 @@ export interface GetWebACLResponse { } export namespace GetWebACLResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetWebACLResponse): any => ({ ...obj, }); @@ -4423,6 +4822,9 @@ export interface GetXssMatchSetRequest { } export namespace GetXssMatchSetRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetXssMatchSetRequest): any => ({ ...obj, }); @@ -4458,6 +4860,9 @@ export interface GetXssMatchSetResponse { } export namespace GetXssMatchSetResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetXssMatchSetResponse): any => ({ ...obj, }); @@ -4485,6 +4890,9 @@ export interface ListActivatedRulesInRuleGroupRequest { } export namespace ListActivatedRulesInRuleGroupRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListActivatedRulesInRuleGroupRequest): any => ({ ...obj, }); @@ -4503,6 +4911,9 @@ export interface ListActivatedRulesInRuleGroupResponse { } export namespace ListActivatedRulesInRuleGroupResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListActivatedRulesInRuleGroupResponse): any => ({ ...obj, }); @@ -4526,6 +4937,9 @@ export interface ListByteMatchSetsRequest { } export namespace ListByteMatchSetsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListByteMatchSetsRequest): any => ({ ...obj, }); @@ -4559,6 +4973,9 @@ export interface ByteMatchSetSummary { } export namespace ByteMatchSetSummary { + /** + * @internal + */ export const filterSensitiveLog = (obj: ByteMatchSetSummary): any => ({ ...obj, }); @@ -4580,6 +4997,9 @@ export interface ListByteMatchSetsResponse { } export namespace ListByteMatchSetsResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListByteMatchSetsResponse): any => ({ ...obj, }); @@ -4603,6 +5023,9 @@ export interface ListGeoMatchSetsRequest { } export namespace ListGeoMatchSetsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListGeoMatchSetsRequest): any => ({ ...obj, }); @@ -4632,6 +5055,9 @@ export interface GeoMatchSetSummary { } export namespace GeoMatchSetSummary { + /** + * @internal + */ export const filterSensitiveLog = (obj: GeoMatchSetSummary): any => ({ ...obj, }); @@ -4653,6 +5079,9 @@ export interface ListGeoMatchSetsResponse { } export namespace ListGeoMatchSetsResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListGeoMatchSetsResponse): any => ({ ...obj, }); @@ -4676,6 +5105,9 @@ export interface ListIPSetsRequest { } export namespace ListIPSetsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListIPSetsRequest): any => ({ ...obj, }); @@ -4706,6 +5138,9 @@ export interface IPSetSummary { } export namespace IPSetSummary { + /** + * @internal + */ export const filterSensitiveLog = (obj: IPSetSummary): any => ({ ...obj, }); @@ -4726,6 +5161,9 @@ export interface ListIPSetsResponse { } export namespace ListIPSetsResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListIPSetsResponse): any => ({ ...obj, }); @@ -4747,6 +5185,9 @@ export interface ListLoggingConfigurationsRequest { } export namespace ListLoggingConfigurationsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListLoggingConfigurationsRequest): any => ({ ...obj, }); @@ -4765,6 +5206,9 @@ export interface ListLoggingConfigurationsResponse { } export namespace ListLoggingConfigurationsResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListLoggingConfigurationsResponse): any => ({ ...obj, }); @@ -4791,6 +5235,9 @@ export interface ListRateBasedRulesRequest { } export namespace ListRateBasedRulesRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListRateBasedRulesRequest): any => ({ ...obj, }); @@ -4824,6 +5271,9 @@ export interface RuleSummary { } export namespace RuleSummary { + /** + * @internal + */ export const filterSensitiveLog = (obj: RuleSummary): any => ({ ...obj, }); @@ -4846,6 +5296,9 @@ export interface ListRateBasedRulesResponse { } export namespace ListRateBasedRulesResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListRateBasedRulesResponse): any => ({ ...obj, }); @@ -4869,6 +5322,9 @@ export interface ListRegexMatchSetsRequest { } export namespace ListRegexMatchSetsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListRegexMatchSetsRequest): any => ({ ...obj, }); @@ -4902,6 +5358,9 @@ export interface RegexMatchSetSummary { } export namespace RegexMatchSetSummary { + /** + * @internal + */ export const filterSensitiveLog = (obj: RegexMatchSetSummary): any => ({ ...obj, }); @@ -4923,6 +5382,9 @@ export interface ListRegexMatchSetsResponse { } export namespace ListRegexMatchSetsResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListRegexMatchSetsResponse): any => ({ ...obj, }); @@ -4946,6 +5408,9 @@ export interface ListRegexPatternSetsRequest { } export namespace ListRegexPatternSetsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListRegexPatternSetsRequest): any => ({ ...obj, }); @@ -4979,6 +5444,9 @@ export interface RegexPatternSetSummary { } export namespace RegexPatternSetSummary { + /** + * @internal + */ export const filterSensitiveLog = (obj: RegexPatternSetSummary): any => ({ ...obj, }); @@ -5000,6 +5468,9 @@ export interface ListRegexPatternSetsResponse { } export namespace ListRegexPatternSetsResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListRegexPatternSetsResponse): any => ({ ...obj, }); @@ -5021,6 +5492,9 @@ export interface ListRuleGroupsRequest { } export namespace ListRuleGroupsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListRuleGroupsRequest): any => ({ ...obj, }); @@ -5054,6 +5528,9 @@ export interface RuleGroupSummary { } export namespace RuleGroupSummary { + /** + * @internal + */ export const filterSensitiveLog = (obj: RuleGroupSummary): any => ({ ...obj, }); @@ -5072,6 +5549,9 @@ export interface ListRuleGroupsResponse { } export namespace ListRuleGroupsResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListRuleGroupsResponse): any => ({ ...obj, }); @@ -5094,6 +5574,9 @@ export interface ListRulesRequest { } export namespace ListRulesRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListRulesRequest): any => ({ ...obj, }); @@ -5114,6 +5597,9 @@ export interface ListRulesResponse { } export namespace ListRulesResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListRulesResponse): any => ({ ...obj, }); @@ -5136,6 +5622,9 @@ export interface ListSizeConstraintSetsRequest { } export namespace ListSizeConstraintSetsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListSizeConstraintSetsRequest): any => ({ ...obj, }); @@ -5171,6 +5660,9 @@ export interface SizeConstraintSetSummary { } export namespace SizeConstraintSetSummary { + /** + * @internal + */ export const filterSensitiveLog = (obj: SizeConstraintSetSummary): any => ({ ...obj, }); @@ -5192,6 +5684,9 @@ export interface ListSizeConstraintSetsResponse { } export namespace ListSizeConstraintSetsResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListSizeConstraintSetsResponse): any => ({ ...obj, }); @@ -5218,6 +5713,9 @@ export interface ListSqlInjectionMatchSetsRequest { } export namespace ListSqlInjectionMatchSetsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListSqlInjectionMatchSetsRequest): any => ({ ...obj, }); @@ -5253,6 +5751,9 @@ export interface SqlInjectionMatchSetSummary { } export namespace SqlInjectionMatchSetSummary { + /** + * @internal + */ export const filterSensitiveLog = (obj: SqlInjectionMatchSetSummary): any => ({ ...obj, }); @@ -5277,6 +5778,9 @@ export interface ListSqlInjectionMatchSetsResponse { } export namespace ListSqlInjectionMatchSetsResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListSqlInjectionMatchSetsResponse): any => ({ ...obj, }); @@ -5300,6 +5804,9 @@ export interface ListSubscribedRuleGroupsRequest { } export namespace ListSubscribedRuleGroupsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListSubscribedRuleGroupsRequest): any => ({ ...obj, }); @@ -5335,6 +5842,9 @@ export interface SubscribedRuleGroupSummary { } export namespace SubscribedRuleGroupSummary { + /** + * @internal + */ export const filterSensitiveLog = (obj: SubscribedRuleGroupSummary): any => ({ ...obj, }); @@ -5356,6 +5866,9 @@ export interface ListSubscribedRuleGroupsResponse { } export namespace ListSubscribedRuleGroupsResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListSubscribedRuleGroupsResponse): any => ({ ...obj, }); @@ -5379,6 +5892,9 @@ export interface ListTagsForResourceRequest { } export namespace ListTagsForResourceRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListTagsForResourceRequest): any => ({ ...obj, }); @@ -5409,6 +5925,9 @@ export interface TagInfoForResource { } export namespace TagInfoForResource { + /** + * @internal + */ export const filterSensitiveLog = (obj: TagInfoForResource): any => ({ ...obj, }); @@ -5427,6 +5946,9 @@ export interface ListTagsForResourceResponse { } export namespace ListTagsForResourceResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListTagsForResourceResponse): any => ({ ...obj, }); @@ -5450,6 +5972,9 @@ export interface ListWebACLsRequest { } export namespace ListWebACLsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListWebACLsRequest): any => ({ ...obj, }); @@ -5483,6 +6008,9 @@ export interface WebACLSummary { } export namespace WebACLSummary { + /** + * @internal + */ export const filterSensitiveLog = (obj: WebACLSummary): any => ({ ...obj, }); @@ -5504,6 +6032,9 @@ export interface ListWebACLsResponse { } export namespace ListWebACLsResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListWebACLsResponse): any => ({ ...obj, }); @@ -5530,6 +6061,9 @@ export interface ListXssMatchSetsRequest { } export namespace ListXssMatchSetsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListXssMatchSetsRequest): any => ({ ...obj, }); @@ -5565,6 +6099,9 @@ export interface XssMatchSetSummary { } export namespace XssMatchSetSummary { + /** + * @internal + */ export const filterSensitiveLog = (obj: XssMatchSetSummary): any => ({ ...obj, }); @@ -5589,6 +6126,9 @@ export interface ListXssMatchSetsResponse { } export namespace ListXssMatchSetsResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListXssMatchSetsResponse): any => ({ ...obj, }); @@ -5609,6 +6149,9 @@ export interface PutLoggingConfigurationRequest { } export namespace PutLoggingConfigurationRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: PutLoggingConfigurationRequest): any => ({ ...obj, }); @@ -5622,6 +6165,9 @@ export interface PutLoggingConfigurationResponse { } export namespace PutLoggingConfigurationResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: PutLoggingConfigurationResponse): any => ({ ...obj, }); @@ -5637,6 +6183,9 @@ export interface WAFServiceLinkedRoleErrorException extends __SmithyException, $ } export namespace WAFServiceLinkedRoleErrorException { + /** + * @internal + */ export const filterSensitiveLog = (obj: WAFServiceLinkedRoleErrorException): any => ({ ...obj, }); @@ -5655,6 +6204,9 @@ export interface PutPermissionPolicyRequest { } export namespace PutPermissionPolicyRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: PutPermissionPolicyRequest): any => ({ ...obj, }); @@ -5663,6 +6215,9 @@ export namespace PutPermissionPolicyRequest { export interface PutPermissionPolicyResponse {} export namespace PutPermissionPolicyResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: PutPermissionPolicyResponse): any => ({ ...obj, }); @@ -5707,6 +6262,9 @@ export interface WAFInvalidPermissionPolicyException extends __SmithyException, } export namespace WAFInvalidPermissionPolicyException { + /** + * @internal + */ export const filterSensitiveLog = (obj: WAFInvalidPermissionPolicyException): any => ({ ...obj, }); @@ -5725,6 +6283,9 @@ export interface TagResourceRequest { } export namespace TagResourceRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: TagResourceRequest): any => ({ ...obj, }); @@ -5733,6 +6294,9 @@ export namespace TagResourceRequest { export interface TagResourceResponse {} export namespace TagResourceResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: TagResourceResponse): any => ({ ...obj, }); @@ -5751,6 +6315,9 @@ export interface UntagResourceRequest { } export namespace UntagResourceRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: UntagResourceRequest): any => ({ ...obj, }); @@ -5759,6 +6326,9 @@ export namespace UntagResourceRequest { export interface UntagResourceResponse {} export namespace UntagResourceResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: UntagResourceResponse): any => ({ ...obj, }); @@ -5796,6 +6366,9 @@ export interface ByteMatchSetUpdate { } export namespace ByteMatchSetUpdate { + /** + * @internal + */ export const filterSensitiveLog = (obj: ByteMatchSetUpdate): any => ({ ...obj, }); @@ -5839,6 +6412,9 @@ export interface UpdateByteMatchSetRequest { } export namespace UpdateByteMatchSetRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateByteMatchSetRequest): any => ({ ...obj, }); @@ -5853,6 +6429,9 @@ export interface UpdateByteMatchSetResponse { } export namespace UpdateByteMatchSetResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateByteMatchSetResponse): any => ({ ...obj, }); @@ -5883,6 +6462,9 @@ export interface WAFNonexistentContainerException extends __SmithyException, $Me } export namespace WAFNonexistentContainerException { + /** + * @internal + */ export const filterSensitiveLog = (obj: WAFNonexistentContainerException): any => ({ ...obj, }); @@ -5912,6 +6494,9 @@ export interface GeoMatchSetUpdate { } export namespace GeoMatchSetUpdate { + /** + * @internal + */ export const filterSensitiveLog = (obj: GeoMatchSetUpdate): any => ({ ...obj, }); @@ -5950,6 +6535,9 @@ export interface UpdateGeoMatchSetRequest { } export namespace UpdateGeoMatchSetRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateGeoMatchSetRequest): any => ({ ...obj, }); @@ -5964,6 +6552,9 @@ export interface UpdateGeoMatchSetResponse { } export namespace UpdateGeoMatchSetResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateGeoMatchSetResponse): any => ({ ...obj, }); @@ -5993,6 +6584,9 @@ export interface IPSetUpdate { } export namespace IPSetUpdate { + /** + * @internal + */ export const filterSensitiveLog = (obj: IPSetUpdate): any => ({ ...obj, }); @@ -6031,6 +6625,9 @@ export interface UpdateIPSetRequest { } export namespace UpdateIPSetRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateIPSetRequest): any => ({ ...obj, }); @@ -6045,6 +6642,9 @@ export interface UpdateIPSetResponse { } export namespace UpdateIPSetResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateIPSetResponse): any => ({ ...obj, }); @@ -6076,6 +6676,9 @@ export interface RuleUpdate { } export namespace RuleUpdate { + /** + * @internal + */ export const filterSensitiveLog = (obj: RuleUpdate): any => ({ ...obj, }); @@ -6109,6 +6712,9 @@ export interface UpdateRateBasedRuleRequest { } export namespace UpdateRateBasedRuleRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateRateBasedRuleRequest): any => ({ ...obj, }); @@ -6124,6 +6730,9 @@ export interface UpdateRateBasedRuleResponse { } export namespace UpdateRateBasedRuleResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateRateBasedRuleResponse): any => ({ ...obj, }); @@ -6156,6 +6765,9 @@ export interface RegexMatchSetUpdate { } export namespace RegexMatchSetUpdate { + /** + * @internal + */ export const filterSensitiveLog = (obj: RegexMatchSetUpdate): any => ({ ...obj, }); @@ -6181,6 +6793,9 @@ export interface UpdateRegexMatchSetRequest { } export namespace UpdateRegexMatchSetRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateRegexMatchSetRequest): any => ({ ...obj, }); @@ -6195,6 +6810,9 @@ export interface UpdateRegexMatchSetResponse { } export namespace UpdateRegexMatchSetResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateRegexMatchSetResponse): any => ({ ...obj, }); @@ -6225,6 +6843,9 @@ export interface RegexPatternSetUpdate { } export namespace RegexPatternSetUpdate { + /** + * @internal + */ export const filterSensitiveLog = (obj: RegexPatternSetUpdate): any => ({ ...obj, }); @@ -6249,6 +6870,9 @@ export interface UpdateRegexPatternSetRequest { } export namespace UpdateRegexPatternSetRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateRegexPatternSetRequest): any => ({ ...obj, }); @@ -6263,6 +6887,9 @@ export interface UpdateRegexPatternSetResponse { } export namespace UpdateRegexPatternSetResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateRegexPatternSetResponse): any => ({ ...obj, }); @@ -6278,6 +6905,9 @@ export interface WAFInvalidRegexPatternException extends __SmithyException, $Met } export namespace WAFInvalidRegexPatternException { + /** + * @internal + */ export const filterSensitiveLog = (obj: WAFInvalidRegexPatternException): any => ({ ...obj, }); @@ -6320,6 +6950,9 @@ export interface UpdateRuleRequest { } export namespace UpdateRuleRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateRuleRequest): any => ({ ...obj, }); @@ -6334,6 +6967,9 @@ export interface UpdateRuleResponse { } export namespace UpdateRuleResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateRuleResponse): any => ({ ...obj, }); @@ -6367,6 +7003,9 @@ export interface RuleGroupUpdate { } export namespace RuleGroupUpdate { + /** + * @internal + */ export const filterSensitiveLog = (obj: RuleGroupUpdate): any => ({ ...obj, }); @@ -6395,6 +7034,9 @@ export interface UpdateRuleGroupRequest { } export namespace UpdateRuleGroupRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateRuleGroupRequest): any => ({ ...obj, }); @@ -6409,6 +7051,9 @@ export interface UpdateRuleGroupResponse { } export namespace UpdateRuleGroupResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateRuleGroupResponse): any => ({ ...obj, }); @@ -6443,6 +7088,9 @@ export interface SizeConstraintSetUpdate { } export namespace SizeConstraintSetUpdate { + /** + * @internal + */ export const filterSensitiveLog = (obj: SizeConstraintSetUpdate): any => ({ ...obj, }); @@ -6486,6 +7134,9 @@ export interface UpdateSizeConstraintSetRequest { } export namespace UpdateSizeConstraintSetRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateSizeConstraintSetRequest): any => ({ ...obj, }); @@ -6500,6 +7151,9 @@ export interface UpdateSizeConstraintSetResponse { } export namespace UpdateSizeConstraintSetResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateSizeConstraintSetResponse): any => ({ ...obj, }); @@ -6531,6 +7185,9 @@ export interface SqlInjectionMatchSetUpdate { } export namespace SqlInjectionMatchSetUpdate { + /** + * @internal + */ export const filterSensitiveLog = (obj: SqlInjectionMatchSetUpdate): any => ({ ...obj, }); @@ -6576,6 +7233,9 @@ export interface UpdateSqlInjectionMatchSetRequest { } export namespace UpdateSqlInjectionMatchSetRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateSqlInjectionMatchSetRequest): any => ({ ...obj, }); @@ -6593,6 +7253,9 @@ export interface UpdateSqlInjectionMatchSetResponse { } export namespace UpdateSqlInjectionMatchSetResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateSqlInjectionMatchSetResponse): any => ({ ...obj, }); @@ -6624,6 +7287,9 @@ export interface WebACLUpdate { } export namespace WebACLUpdate { + /** + * @internal + */ export const filterSensitiveLog = (obj: WebACLUpdate): any => ({ ...obj, }); @@ -6679,6 +7345,9 @@ export interface UpdateWebACLRequest { } export namespace UpdateWebACLRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateWebACLRequest): any => ({ ...obj, }); @@ -6693,6 +7362,9 @@ export interface UpdateWebACLResponse { } export namespace UpdateWebACLResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateWebACLResponse): any => ({ ...obj, }); @@ -6708,6 +7380,9 @@ export interface WAFSubscriptionNotFoundException extends __SmithyException, $Me } export namespace WAFSubscriptionNotFoundException { + /** + * @internal + */ export const filterSensitiveLog = (obj: WAFSubscriptionNotFoundException): any => ({ ...obj, }); @@ -6741,6 +7416,9 @@ export interface XssMatchSetUpdate { } export namespace XssMatchSetUpdate { + /** + * @internal + */ export const filterSensitiveLog = (obj: XssMatchSetUpdate): any => ({ ...obj, }); @@ -6788,6 +7466,9 @@ export interface UpdateXssMatchSetRequest { } export namespace UpdateXssMatchSetRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateXssMatchSetRequest): any => ({ ...obj, }); @@ -6805,6 +7486,9 @@ export interface UpdateXssMatchSetResponse { } export namespace UpdateXssMatchSetResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateXssMatchSetResponse): any => ({ ...obj, }); diff --git a/clients/client-wafv2/commands/AssociateWebACLCommand.ts b/clients/client-wafv2/commands/AssociateWebACLCommand.ts index 40eeccaa1ef0..45b84fe1f867 100644 --- a/clients/client-wafv2/commands/AssociateWebACLCommand.ts +++ b/clients/client-wafv2/commands/AssociateWebACLCommand.ts @@ -23,6 +23,20 @@ export interface AssociateWebACLCommandOutput extends AssociateWebACLResponse, _ /** *

Associates a Web ACL with a regional application resource, to protect the resource. A regional application can be an Application Load Balancer (ALB), an API Gateway REST API, or an AppSync GraphQL API.

*

For AWS 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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { WAFV2Client, AssociateWebACLCommand } from "@aws-sdk/client-wafv2"; // ES Modules import + * // const { WAFV2Client, AssociateWebACLCommand } = require("@aws-sdk/client-wafv2"); // CommonJS import + * const client = new WAFV2Client(config); + * const command = new AssociateWebACLCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link AssociateWebACLCommandInput} for command's `input` shape. + * @see {@link AssociateWebACLCommandOutput} for command's `response` shape. + * @see {@link WAFV2ClientResolvedConfig | config} for command's `input` shape. + * */ export class AssociateWebACLCommand extends $Command< AssociateWebACLCommandInput, diff --git a/clients/client-wafv2/commands/CheckCapacityCommand.ts b/clients/client-wafv2/commands/CheckCapacityCommand.ts index 55e12709b8a0..23fce5849840 100644 --- a/clients/client-wafv2/commands/CheckCapacityCommand.ts +++ b/clients/client-wafv2/commands/CheckCapacityCommand.ts @@ -33,6 +33,20 @@ export interface CheckCapacityCommandOutput extends CheckCapacityResponse, __Met * Rule group capacity is fixed at creation, which helps users plan their * web ACL WCU usage when they use a rule group. * The WCU limit for web ACLs is 1,500.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { WAFV2Client, CheckCapacityCommand } from "@aws-sdk/client-wafv2"; // ES Modules import + * // const { WAFV2Client, CheckCapacityCommand } = require("@aws-sdk/client-wafv2"); // CommonJS import + * const client = new WAFV2Client(config); + * const command = new CheckCapacityCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CheckCapacityCommandInput} for command's `input` shape. + * @see {@link CheckCapacityCommandOutput} for command's `response` shape. + * @see {@link WAFV2ClientResolvedConfig | config} for command's `input` shape. + * */ export class CheckCapacityCommand extends $Command< CheckCapacityCommandInput, diff --git a/clients/client-wafv2/commands/CreateIPSetCommand.ts b/clients/client-wafv2/commands/CreateIPSetCommand.ts index 09de17106b3f..67f967ffdd22 100644 --- a/clients/client-wafv2/commands/CreateIPSetCommand.ts +++ b/clients/client-wafv2/commands/CreateIPSetCommand.ts @@ -22,6 +22,20 @@ export interface CreateIPSetCommandOutput extends CreateIPSetResponse, __Metadat /** *

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 AWS WAF to block them using an IPSet that lists those IP addresses.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { WAFV2Client, CreateIPSetCommand } from "@aws-sdk/client-wafv2"; // ES Modules import + * // const { WAFV2Client, CreateIPSetCommand } = require("@aws-sdk/client-wafv2"); // CommonJS import + * const client = new WAFV2Client(config); + * const command = new CreateIPSetCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreateIPSetCommandInput} for command's `input` shape. + * @see {@link CreateIPSetCommandOutput} for command's `response` shape. + * @see {@link WAFV2ClientResolvedConfig | config} for command's `input` shape. + * */ export class CreateIPSetCommand extends $Command< CreateIPSetCommandInput, diff --git a/clients/client-wafv2/commands/CreateRegexPatternSetCommand.ts b/clients/client-wafv2/commands/CreateRegexPatternSetCommand.ts index 6959fbe542dd..370928c7fed8 100644 --- a/clients/client-wafv2/commands/CreateRegexPatternSetCommand.ts +++ b/clients/client-wafv2/commands/CreateRegexPatternSetCommand.ts @@ -22,6 +22,20 @@ export interface CreateRegexPatternSetCommandOutput extends CreateRegexPatternSe /** *

Creates a RegexPatternSet, which you reference in a RegexPatternSetReferenceStatement, to have AWS WAF inspect a web request component for the specified patterns.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { WAFV2Client, CreateRegexPatternSetCommand } from "@aws-sdk/client-wafv2"; // ES Modules import + * // const { WAFV2Client, CreateRegexPatternSetCommand } = require("@aws-sdk/client-wafv2"); // CommonJS import + * const client = new WAFV2Client(config); + * const command = new CreateRegexPatternSetCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreateRegexPatternSetCommandInput} for command's `input` shape. + * @see {@link CreateRegexPatternSetCommandOutput} for command's `response` shape. + * @see {@link WAFV2ClientResolvedConfig | config} for command's `input` shape. + * */ export class CreateRegexPatternSetCommand extends $Command< CreateRegexPatternSetCommandInput, diff --git a/clients/client-wafv2/commands/CreateRuleGroupCommand.ts b/clients/client-wafv2/commands/CreateRuleGroupCommand.ts index 0f1e27f97355..4f5b44814c6f 100644 --- a/clients/client-wafv2/commands/CreateRuleGroupCommand.ts +++ b/clients/client-wafv2/commands/CreateRuleGroupCommand.ts @@ -23,6 +23,20 @@ export interface CreateRuleGroupCommandOutput extends CreateRuleGroupResponse, _ /** *

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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { WAFV2Client, CreateRuleGroupCommand } from "@aws-sdk/client-wafv2"; // ES Modules import + * // const { WAFV2Client, CreateRuleGroupCommand } = require("@aws-sdk/client-wafv2"); // CommonJS import + * const client = new WAFV2Client(config); + * const command = new CreateRuleGroupCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreateRuleGroupCommandInput} for command's `input` shape. + * @see {@link CreateRuleGroupCommandOutput} for command's `response` shape. + * @see {@link WAFV2ClientResolvedConfig | config} for command's `input` shape. + * */ export class CreateRuleGroupCommand extends $Command< CreateRuleGroupCommandInput, diff --git a/clients/client-wafv2/commands/CreateWebACLCommand.ts b/clients/client-wafv2/commands/CreateWebACLCommand.ts index 380cc6fb5ebb..e6dedbf45ff8 100644 --- a/clients/client-wafv2/commands/CreateWebACLCommand.ts +++ b/clients/client-wafv2/commands/CreateWebACLCommand.ts @@ -23,6 +23,20 @@ export interface CreateWebACLCommandOutput extends CreateWebACLResponse, __Metad /** *

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 AWS resources to protect. The resources can be Amazon CloudFront, an Amazon API Gateway REST API, an Application Load Balancer, or an AWS AppSync GraphQL API.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { WAFV2Client, CreateWebACLCommand } from "@aws-sdk/client-wafv2"; // ES Modules import + * // const { WAFV2Client, CreateWebACLCommand } = require("@aws-sdk/client-wafv2"); // CommonJS import + * const client = new WAFV2Client(config); + * const command = new CreateWebACLCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreateWebACLCommandInput} for command's `input` shape. + * @see {@link CreateWebACLCommandOutput} for command's `response` shape. + * @see {@link WAFV2ClientResolvedConfig | config} for command's `input` shape. + * */ export class CreateWebACLCommand extends $Command< CreateWebACLCommandInput, diff --git a/clients/client-wafv2/commands/DeleteFirewallManagerRuleGroupsCommand.ts b/clients/client-wafv2/commands/DeleteFirewallManagerRuleGroupsCommand.ts index c034b7d98cf4..75ea646f3387 100644 --- a/clients/client-wafv2/commands/DeleteFirewallManagerRuleGroupsCommand.ts +++ b/clients/client-wafv2/commands/DeleteFirewallManagerRuleGroupsCommand.ts @@ -25,6 +25,20 @@ export interface DeleteFirewallManagerRuleGroupsCommandOutput /** *

Deletes all rule groups that are managed by AWS Firewall Manager for the specified web ACL.

*

You can only use this if ManagedByFirewallManager is false in the specified WebACL.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { WAFV2Client, DeleteFirewallManagerRuleGroupsCommand } from "@aws-sdk/client-wafv2"; // ES Modules import + * // const { WAFV2Client, DeleteFirewallManagerRuleGroupsCommand } = require("@aws-sdk/client-wafv2"); // CommonJS import + * const client = new WAFV2Client(config); + * const command = new DeleteFirewallManagerRuleGroupsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteFirewallManagerRuleGroupsCommandInput} for command's `input` shape. + * @see {@link DeleteFirewallManagerRuleGroupsCommandOutput} for command's `response` shape. + * @see {@link WAFV2ClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteFirewallManagerRuleGroupsCommand extends $Command< DeleteFirewallManagerRuleGroupsCommandInput, diff --git a/clients/client-wafv2/commands/DeleteIPSetCommand.ts b/clients/client-wafv2/commands/DeleteIPSetCommand.ts index 736d4af396d1..cba00cf2a05a 100644 --- a/clients/client-wafv2/commands/DeleteIPSetCommand.ts +++ b/clients/client-wafv2/commands/DeleteIPSetCommand.ts @@ -22,6 +22,20 @@ export interface DeleteIPSetCommandOutput extends DeleteIPSetResponse, __Metadat /** *

Deletes the specified IPSet.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { WAFV2Client, DeleteIPSetCommand } from "@aws-sdk/client-wafv2"; // ES Modules import + * // const { WAFV2Client, DeleteIPSetCommand } = require("@aws-sdk/client-wafv2"); // CommonJS import + * const client = new WAFV2Client(config); + * const command = new DeleteIPSetCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteIPSetCommandInput} for command's `input` shape. + * @see {@link DeleteIPSetCommandOutput} for command's `response` shape. + * @see {@link WAFV2ClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteIPSetCommand extends $Command< DeleteIPSetCommandInput, diff --git a/clients/client-wafv2/commands/DeleteLoggingConfigurationCommand.ts b/clients/client-wafv2/commands/DeleteLoggingConfigurationCommand.ts index a6f9ca6b09a2..0268d19038cc 100644 --- a/clients/client-wafv2/commands/DeleteLoggingConfigurationCommand.ts +++ b/clients/client-wafv2/commands/DeleteLoggingConfigurationCommand.ts @@ -23,6 +23,20 @@ export interface DeleteLoggingConfigurationCommandOutput extends DeleteLoggingCo /** *

Deletes the LoggingConfiguration from the specified web * ACL.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { WAFV2Client, DeleteLoggingConfigurationCommand } from "@aws-sdk/client-wafv2"; // ES Modules import + * // const { WAFV2Client, DeleteLoggingConfigurationCommand } = require("@aws-sdk/client-wafv2"); // CommonJS import + * const client = new WAFV2Client(config); + * const command = new DeleteLoggingConfigurationCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteLoggingConfigurationCommandInput} for command's `input` shape. + * @see {@link DeleteLoggingConfigurationCommandOutput} for command's `response` shape. + * @see {@link WAFV2ClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteLoggingConfigurationCommand extends $Command< DeleteLoggingConfigurationCommandInput, diff --git a/clients/client-wafv2/commands/DeletePermissionPolicyCommand.ts b/clients/client-wafv2/commands/DeletePermissionPolicyCommand.ts index be8a339e4a10..74a20080ffc7 100644 --- a/clients/client-wafv2/commands/DeletePermissionPolicyCommand.ts +++ b/clients/client-wafv2/commands/DeletePermissionPolicyCommand.ts @@ -23,6 +23,20 @@ export interface DeletePermissionPolicyCommandOutput extends DeletePermissionPol /** *

Permanently deletes an IAM policy from the specified rule group.

*

You must be the owner of the rule group to perform this operation.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { WAFV2Client, DeletePermissionPolicyCommand } from "@aws-sdk/client-wafv2"; // ES Modules import + * // const { WAFV2Client, DeletePermissionPolicyCommand } = require("@aws-sdk/client-wafv2"); // CommonJS import + * const client = new WAFV2Client(config); + * const command = new DeletePermissionPolicyCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeletePermissionPolicyCommandInput} for command's `input` shape. + * @see {@link DeletePermissionPolicyCommandOutput} for command's `response` shape. + * @see {@link WAFV2ClientResolvedConfig | config} for command's `input` shape. + * */ export class DeletePermissionPolicyCommand extends $Command< DeletePermissionPolicyCommandInput, diff --git a/clients/client-wafv2/commands/DeleteRegexPatternSetCommand.ts b/clients/client-wafv2/commands/DeleteRegexPatternSetCommand.ts index 8565fe52b221..d38f98d6ce87 100644 --- a/clients/client-wafv2/commands/DeleteRegexPatternSetCommand.ts +++ b/clients/client-wafv2/commands/DeleteRegexPatternSetCommand.ts @@ -22,6 +22,20 @@ export interface DeleteRegexPatternSetCommandOutput extends DeleteRegexPatternSe /** *

Deletes the specified RegexPatternSet.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { WAFV2Client, DeleteRegexPatternSetCommand } from "@aws-sdk/client-wafv2"; // ES Modules import + * // const { WAFV2Client, DeleteRegexPatternSetCommand } = require("@aws-sdk/client-wafv2"); // CommonJS import + * const client = new WAFV2Client(config); + * const command = new DeleteRegexPatternSetCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteRegexPatternSetCommandInput} for command's `input` shape. + * @see {@link DeleteRegexPatternSetCommandOutput} for command's `response` shape. + * @see {@link WAFV2ClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteRegexPatternSetCommand extends $Command< DeleteRegexPatternSetCommandInput, diff --git a/clients/client-wafv2/commands/DeleteRuleGroupCommand.ts b/clients/client-wafv2/commands/DeleteRuleGroupCommand.ts index beb71f0ce56a..319fd00e3c3c 100644 --- a/clients/client-wafv2/commands/DeleteRuleGroupCommand.ts +++ b/clients/client-wafv2/commands/DeleteRuleGroupCommand.ts @@ -22,6 +22,20 @@ export interface DeleteRuleGroupCommandOutput extends DeleteRuleGroupResponse, _ /** *

Deletes the specified RuleGroup.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { WAFV2Client, DeleteRuleGroupCommand } from "@aws-sdk/client-wafv2"; // ES Modules import + * // const { WAFV2Client, DeleteRuleGroupCommand } = require("@aws-sdk/client-wafv2"); // CommonJS import + * const client = new WAFV2Client(config); + * const command = new DeleteRuleGroupCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteRuleGroupCommandInput} for command's `input` shape. + * @see {@link DeleteRuleGroupCommandOutput} for command's `response` shape. + * @see {@link WAFV2ClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteRuleGroupCommand extends $Command< DeleteRuleGroupCommandInput, diff --git a/clients/client-wafv2/commands/DeleteWebACLCommand.ts b/clients/client-wafv2/commands/DeleteWebACLCommand.ts index 94a477667ddb..98e7e4ab0984 100644 --- a/clients/client-wafv2/commands/DeleteWebACLCommand.ts +++ b/clients/client-wafv2/commands/DeleteWebACLCommand.ts @@ -23,6 +23,20 @@ export interface DeleteWebACLCommandOutput extends DeleteWebACLResponse, __Metad /** *

Deletes the specified WebACL.

*

You can only use this if ManagedByFirewallManager is false in the specified WebACL.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { WAFV2Client, DeleteWebACLCommand } from "@aws-sdk/client-wafv2"; // ES Modules import + * // const { WAFV2Client, DeleteWebACLCommand } = require("@aws-sdk/client-wafv2"); // CommonJS import + * const client = new WAFV2Client(config); + * const command = new DeleteWebACLCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteWebACLCommandInput} for command's `input` shape. + * @see {@link DeleteWebACLCommandOutput} for command's `response` shape. + * @see {@link WAFV2ClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteWebACLCommand extends $Command< DeleteWebACLCommandInput, diff --git a/clients/client-wafv2/commands/DescribeManagedRuleGroupCommand.ts b/clients/client-wafv2/commands/DescribeManagedRuleGroupCommand.ts index 413840a5aa63..09f9bf6a180d 100644 --- a/clients/client-wafv2/commands/DescribeManagedRuleGroupCommand.ts +++ b/clients/client-wafv2/commands/DescribeManagedRuleGroupCommand.ts @@ -22,6 +22,20 @@ export interface DescribeManagedRuleGroupCommandOutput extends DescribeManagedRu /** *

Provides high-level information for a managed rule group, including descriptions of the rules.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { WAFV2Client, DescribeManagedRuleGroupCommand } from "@aws-sdk/client-wafv2"; // ES Modules import + * // const { WAFV2Client, DescribeManagedRuleGroupCommand } = require("@aws-sdk/client-wafv2"); // CommonJS import + * const client = new WAFV2Client(config); + * const command = new DescribeManagedRuleGroupCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeManagedRuleGroupCommandInput} for command's `input` shape. + * @see {@link DescribeManagedRuleGroupCommandOutput} for command's `response` shape. + * @see {@link WAFV2ClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeManagedRuleGroupCommand extends $Command< DescribeManagedRuleGroupCommandInput, diff --git a/clients/client-wafv2/commands/DisassociateWebACLCommand.ts b/clients/client-wafv2/commands/DisassociateWebACLCommand.ts index 33edc6ffad02..ac2155bbd8ee 100644 --- a/clients/client-wafv2/commands/DisassociateWebACLCommand.ts +++ b/clients/client-wafv2/commands/DisassociateWebACLCommand.ts @@ -23,6 +23,20 @@ export interface DisassociateWebACLCommandOutput extends DisassociateWebACLRespo /** *

Disassociates a Web ACL from a regional application resource. A regional application can be an Application Load Balancer (ALB), an API Gateway REST API, or an AppSync GraphQL API.

*

For AWS 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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { WAFV2Client, DisassociateWebACLCommand } from "@aws-sdk/client-wafv2"; // ES Modules import + * // const { WAFV2Client, DisassociateWebACLCommand } = require("@aws-sdk/client-wafv2"); // CommonJS import + * const client = new WAFV2Client(config); + * const command = new DisassociateWebACLCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DisassociateWebACLCommandInput} for command's `input` shape. + * @see {@link DisassociateWebACLCommandOutput} for command's `response` shape. + * @see {@link WAFV2ClientResolvedConfig | config} for command's `input` shape. + * */ export class DisassociateWebACLCommand extends $Command< DisassociateWebACLCommandInput, diff --git a/clients/client-wafv2/commands/GetIPSetCommand.ts b/clients/client-wafv2/commands/GetIPSetCommand.ts index fa8dafbe57b4..bcda56c36374 100644 --- a/clients/client-wafv2/commands/GetIPSetCommand.ts +++ b/clients/client-wafv2/commands/GetIPSetCommand.ts @@ -19,6 +19,20 @@ export interface GetIPSetCommandOutput extends GetIPSetResponse, __MetadataBeare /** *

Retrieves the specified IPSet.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { WAFV2Client, GetIPSetCommand } from "@aws-sdk/client-wafv2"; // ES Modules import + * // const { WAFV2Client, GetIPSetCommand } = require("@aws-sdk/client-wafv2"); // CommonJS import + * const client = new WAFV2Client(config); + * const command = new GetIPSetCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetIPSetCommandInput} for command's `input` shape. + * @see {@link GetIPSetCommandOutput} for command's `response` shape. + * @see {@link WAFV2ClientResolvedConfig | config} for command's `input` shape. + * */ export class GetIPSetCommand extends $Command { // Start section: command_properties diff --git a/clients/client-wafv2/commands/GetLoggingConfigurationCommand.ts b/clients/client-wafv2/commands/GetLoggingConfigurationCommand.ts index 5f47239eacab..41803b7ceb7a 100644 --- a/clients/client-wafv2/commands/GetLoggingConfigurationCommand.ts +++ b/clients/client-wafv2/commands/GetLoggingConfigurationCommand.ts @@ -22,6 +22,20 @@ export interface GetLoggingConfigurationCommandOutput extends GetLoggingConfigur /** *

Returns the LoggingConfiguration for the specified web ACL.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { WAFV2Client, GetLoggingConfigurationCommand } from "@aws-sdk/client-wafv2"; // ES Modules import + * // const { WAFV2Client, GetLoggingConfigurationCommand } = require("@aws-sdk/client-wafv2"); // CommonJS import + * const client = new WAFV2Client(config); + * const command = new GetLoggingConfigurationCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetLoggingConfigurationCommandInput} for command's `input` shape. + * @see {@link GetLoggingConfigurationCommandOutput} for command's `response` shape. + * @see {@link WAFV2ClientResolvedConfig | config} for command's `input` shape. + * */ export class GetLoggingConfigurationCommand extends $Command< GetLoggingConfigurationCommandInput, diff --git a/clients/client-wafv2/commands/GetPermissionPolicyCommand.ts b/clients/client-wafv2/commands/GetPermissionPolicyCommand.ts index 5f2504b1ba0c..beb2e271fd5c 100644 --- a/clients/client-wafv2/commands/GetPermissionPolicyCommand.ts +++ b/clients/client-wafv2/commands/GetPermissionPolicyCommand.ts @@ -23,6 +23,20 @@ export interface GetPermissionPolicyCommandOutput extends GetPermissionPolicyRes /** *

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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { WAFV2Client, GetPermissionPolicyCommand } from "@aws-sdk/client-wafv2"; // ES Modules import + * // const { WAFV2Client, GetPermissionPolicyCommand } = require("@aws-sdk/client-wafv2"); // CommonJS import + * const client = new WAFV2Client(config); + * const command = new GetPermissionPolicyCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetPermissionPolicyCommandInput} for command's `input` shape. + * @see {@link GetPermissionPolicyCommandOutput} for command's `response` shape. + * @see {@link WAFV2ClientResolvedConfig | config} for command's `input` shape. + * */ export class GetPermissionPolicyCommand extends $Command< GetPermissionPolicyCommandInput, diff --git a/clients/client-wafv2/commands/GetRateBasedStatementManagedKeysCommand.ts b/clients/client-wafv2/commands/GetRateBasedStatementManagedKeysCommand.ts index 90735048a9a9..d0eb7a2abbb3 100644 --- a/clients/client-wafv2/commands/GetRateBasedStatementManagedKeysCommand.ts +++ b/clients/client-wafv2/commands/GetRateBasedStatementManagedKeysCommand.ts @@ -24,6 +24,20 @@ export interface GetRateBasedStatementManagedKeysCommandOutput /** *

Retrieves the keys that are currently blocked by a rate-based rule. The maximum number of managed keys that can be blocked for a single rate-based rule is 10,000. If more than 10,000 addresses exceed the rate limit, those with the highest rates are blocked.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { WAFV2Client, GetRateBasedStatementManagedKeysCommand } from "@aws-sdk/client-wafv2"; // ES Modules import + * // const { WAFV2Client, GetRateBasedStatementManagedKeysCommand } = require("@aws-sdk/client-wafv2"); // CommonJS import + * const client = new WAFV2Client(config); + * const command = new GetRateBasedStatementManagedKeysCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetRateBasedStatementManagedKeysCommandInput} for command's `input` shape. + * @see {@link GetRateBasedStatementManagedKeysCommandOutput} for command's `response` shape. + * @see {@link WAFV2ClientResolvedConfig | config} for command's `input` shape. + * */ export class GetRateBasedStatementManagedKeysCommand extends $Command< GetRateBasedStatementManagedKeysCommandInput, diff --git a/clients/client-wafv2/commands/GetRegexPatternSetCommand.ts b/clients/client-wafv2/commands/GetRegexPatternSetCommand.ts index 2b35265e2e4f..00069ab820e8 100644 --- a/clients/client-wafv2/commands/GetRegexPatternSetCommand.ts +++ b/clients/client-wafv2/commands/GetRegexPatternSetCommand.ts @@ -22,6 +22,20 @@ export interface GetRegexPatternSetCommandOutput extends GetRegexPatternSetRespo /** *

Retrieves the specified RegexPatternSet.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { WAFV2Client, GetRegexPatternSetCommand } from "@aws-sdk/client-wafv2"; // ES Modules import + * // const { WAFV2Client, GetRegexPatternSetCommand } = require("@aws-sdk/client-wafv2"); // CommonJS import + * const client = new WAFV2Client(config); + * const command = new GetRegexPatternSetCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetRegexPatternSetCommandInput} for command's `input` shape. + * @see {@link GetRegexPatternSetCommandOutput} for command's `response` shape. + * @see {@link WAFV2ClientResolvedConfig | config} for command's `input` shape. + * */ export class GetRegexPatternSetCommand extends $Command< GetRegexPatternSetCommandInput, diff --git a/clients/client-wafv2/commands/GetRuleGroupCommand.ts b/clients/client-wafv2/commands/GetRuleGroupCommand.ts index 442f114e86f8..dd8e33fdf82d 100644 --- a/clients/client-wafv2/commands/GetRuleGroupCommand.ts +++ b/clients/client-wafv2/commands/GetRuleGroupCommand.ts @@ -22,6 +22,20 @@ export interface GetRuleGroupCommandOutput extends GetRuleGroupResponse, __Metad /** *

Retrieves the specified RuleGroup.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { WAFV2Client, GetRuleGroupCommand } from "@aws-sdk/client-wafv2"; // ES Modules import + * // const { WAFV2Client, GetRuleGroupCommand } = require("@aws-sdk/client-wafv2"); // CommonJS import + * const client = new WAFV2Client(config); + * const command = new GetRuleGroupCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetRuleGroupCommandInput} for command's `input` shape. + * @see {@link GetRuleGroupCommandOutput} for command's `response` shape. + * @see {@link WAFV2ClientResolvedConfig | config} for command's `input` shape. + * */ export class GetRuleGroupCommand extends $Command< GetRuleGroupCommandInput, diff --git a/clients/client-wafv2/commands/GetSampledRequestsCommand.ts b/clients/client-wafv2/commands/GetSampledRequestsCommand.ts index 562de97874bb..bf633c3750b1 100644 --- a/clients/client-wafv2/commands/GetSampledRequestsCommand.ts +++ b/clients/client-wafv2/commands/GetSampledRequestsCommand.ts @@ -26,6 +26,20 @@ export interface GetSampledRequestsCommandOutput extends GetSampledRequestsRespo * 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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { WAFV2Client, GetSampledRequestsCommand } from "@aws-sdk/client-wafv2"; // ES Modules import + * // const { WAFV2Client, GetSampledRequestsCommand } = require("@aws-sdk/client-wafv2"); // CommonJS import + * const client = new WAFV2Client(config); + * const command = new GetSampledRequestsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetSampledRequestsCommandInput} for command's `input` shape. + * @see {@link GetSampledRequestsCommandOutput} for command's `response` shape. + * @see {@link WAFV2ClientResolvedConfig | config} for command's `input` shape. + * */ export class GetSampledRequestsCommand extends $Command< GetSampledRequestsCommandInput, diff --git a/clients/client-wafv2/commands/GetWebACLCommand.ts b/clients/client-wafv2/commands/GetWebACLCommand.ts index d4c8e5b49f5e..83fd2431591c 100644 --- a/clients/client-wafv2/commands/GetWebACLCommand.ts +++ b/clients/client-wafv2/commands/GetWebACLCommand.ts @@ -19,6 +19,20 @@ export interface GetWebACLCommandOutput extends GetWebACLResponse, __MetadataBea /** *

Retrieves the specified WebACL.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { WAFV2Client, GetWebACLCommand } from "@aws-sdk/client-wafv2"; // ES Modules import + * // const { WAFV2Client, GetWebACLCommand } = require("@aws-sdk/client-wafv2"); // CommonJS import + * const client = new WAFV2Client(config); + * const command = new GetWebACLCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetWebACLCommandInput} for command's `input` shape. + * @see {@link GetWebACLCommandOutput} for command's `response` shape. + * @see {@link WAFV2ClientResolvedConfig | config} for command's `input` shape. + * */ export class GetWebACLCommand extends $Command< GetWebACLCommandInput, diff --git a/clients/client-wafv2/commands/GetWebACLForResourceCommand.ts b/clients/client-wafv2/commands/GetWebACLForResourceCommand.ts index 9e932418c393..06d94af4d42e 100644 --- a/clients/client-wafv2/commands/GetWebACLForResourceCommand.ts +++ b/clients/client-wafv2/commands/GetWebACLForResourceCommand.ts @@ -22,6 +22,20 @@ export interface GetWebACLForResourceCommandOutput extends GetWebACLForResourceR /** *

Retrieves the WebACL for the specified resource.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { WAFV2Client, GetWebACLForResourceCommand } from "@aws-sdk/client-wafv2"; // ES Modules import + * // const { WAFV2Client, GetWebACLForResourceCommand } = require("@aws-sdk/client-wafv2"); // CommonJS import + * const client = new WAFV2Client(config); + * const command = new GetWebACLForResourceCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetWebACLForResourceCommandInput} for command's `input` shape. + * @see {@link GetWebACLForResourceCommandOutput} for command's `response` shape. + * @see {@link WAFV2ClientResolvedConfig | config} for command's `input` shape. + * */ export class GetWebACLForResourceCommand extends $Command< GetWebACLForResourceCommandInput, diff --git a/clients/client-wafv2/commands/ListAvailableManagedRuleGroupsCommand.ts b/clients/client-wafv2/commands/ListAvailableManagedRuleGroupsCommand.ts index 97ac1cb9a3fb..ed5c861fa51a 100644 --- a/clients/client-wafv2/commands/ListAvailableManagedRuleGroupsCommand.ts +++ b/clients/client-wafv2/commands/ListAvailableManagedRuleGroupsCommand.ts @@ -24,6 +24,20 @@ export interface ListAvailableManagedRuleGroupsCommandOutput /** *

Retrieves an array of managed rule groups that are available for you to use. This list includes all AWS Managed Rules rule groups and the AWS Marketplace managed rule groups that you're subscribed to.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { WAFV2Client, ListAvailableManagedRuleGroupsCommand } from "@aws-sdk/client-wafv2"; // ES Modules import + * // const { WAFV2Client, ListAvailableManagedRuleGroupsCommand } = require("@aws-sdk/client-wafv2"); // CommonJS import + * const client = new WAFV2Client(config); + * const command = new ListAvailableManagedRuleGroupsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListAvailableManagedRuleGroupsCommandInput} for command's `input` shape. + * @see {@link ListAvailableManagedRuleGroupsCommandOutput} for command's `response` shape. + * @see {@link WAFV2ClientResolvedConfig | config} for command's `input` shape. + * */ export class ListAvailableManagedRuleGroupsCommand extends $Command< ListAvailableManagedRuleGroupsCommandInput, diff --git a/clients/client-wafv2/commands/ListIPSetsCommand.ts b/clients/client-wafv2/commands/ListIPSetsCommand.ts index f72969d68887..592976efefc1 100644 --- a/clients/client-wafv2/commands/ListIPSetsCommand.ts +++ b/clients/client-wafv2/commands/ListIPSetsCommand.ts @@ -22,6 +22,20 @@ export interface ListIPSetsCommandOutput extends ListIPSetsResponse, __MetadataB /** *

Retrieves an array of IPSetSummary objects for the IP sets that you manage.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { WAFV2Client, ListIPSetsCommand } from "@aws-sdk/client-wafv2"; // ES Modules import + * // const { WAFV2Client, ListIPSetsCommand } = require("@aws-sdk/client-wafv2"); // CommonJS import + * const client = new WAFV2Client(config); + * const command = new ListIPSetsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListIPSetsCommandInput} for command's `input` shape. + * @see {@link ListIPSetsCommandOutput} for command's `response` shape. + * @see {@link WAFV2ClientResolvedConfig | config} for command's `input` shape. + * */ export class ListIPSetsCommand extends $Command< ListIPSetsCommandInput, diff --git a/clients/client-wafv2/commands/ListLoggingConfigurationsCommand.ts b/clients/client-wafv2/commands/ListLoggingConfigurationsCommand.ts index 8c04e810ce39..47af28c5ca06 100644 --- a/clients/client-wafv2/commands/ListLoggingConfigurationsCommand.ts +++ b/clients/client-wafv2/commands/ListLoggingConfigurationsCommand.ts @@ -22,6 +22,20 @@ export interface ListLoggingConfigurationsCommandOutput extends ListLoggingConfi /** *

Retrieves an array of your LoggingConfiguration objects.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { WAFV2Client, ListLoggingConfigurationsCommand } from "@aws-sdk/client-wafv2"; // ES Modules import + * // const { WAFV2Client, ListLoggingConfigurationsCommand } = require("@aws-sdk/client-wafv2"); // CommonJS import + * const client = new WAFV2Client(config); + * const command = new ListLoggingConfigurationsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListLoggingConfigurationsCommandInput} for command's `input` shape. + * @see {@link ListLoggingConfigurationsCommandOutput} for command's `response` shape. + * @see {@link WAFV2ClientResolvedConfig | config} for command's `input` shape. + * */ export class ListLoggingConfigurationsCommand extends $Command< ListLoggingConfigurationsCommandInput, diff --git a/clients/client-wafv2/commands/ListRegexPatternSetsCommand.ts b/clients/client-wafv2/commands/ListRegexPatternSetsCommand.ts index 0259cac733b2..b60f4f6e9954 100644 --- a/clients/client-wafv2/commands/ListRegexPatternSetsCommand.ts +++ b/clients/client-wafv2/commands/ListRegexPatternSetsCommand.ts @@ -22,6 +22,20 @@ export interface ListRegexPatternSetsCommandOutput extends ListRegexPatternSetsR /** *

Retrieves an array of RegexPatternSetSummary objects for the regex pattern sets that you manage.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { WAFV2Client, ListRegexPatternSetsCommand } from "@aws-sdk/client-wafv2"; // ES Modules import + * // const { WAFV2Client, ListRegexPatternSetsCommand } = require("@aws-sdk/client-wafv2"); // CommonJS import + * const client = new WAFV2Client(config); + * const command = new ListRegexPatternSetsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListRegexPatternSetsCommandInput} for command's `input` shape. + * @see {@link ListRegexPatternSetsCommandOutput} for command's `response` shape. + * @see {@link WAFV2ClientResolvedConfig | config} for command's `input` shape. + * */ export class ListRegexPatternSetsCommand extends $Command< ListRegexPatternSetsCommandInput, diff --git a/clients/client-wafv2/commands/ListResourcesForWebACLCommand.ts b/clients/client-wafv2/commands/ListResourcesForWebACLCommand.ts index f60543811db4..9ab4e0857116 100644 --- a/clients/client-wafv2/commands/ListResourcesForWebACLCommand.ts +++ b/clients/client-wafv2/commands/ListResourcesForWebACLCommand.ts @@ -22,6 +22,20 @@ export interface ListResourcesForWebACLCommandOutput extends ListResourcesForWeb /** *

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 AWS CloudFront resources, use the AWS CloudFront call ListDistributionsByWebACLId.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { WAFV2Client, ListResourcesForWebACLCommand } from "@aws-sdk/client-wafv2"; // ES Modules import + * // const { WAFV2Client, ListResourcesForWebACLCommand } = require("@aws-sdk/client-wafv2"); // CommonJS import + * const client = new WAFV2Client(config); + * const command = new ListResourcesForWebACLCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListResourcesForWebACLCommandInput} for command's `input` shape. + * @see {@link ListResourcesForWebACLCommandOutput} for command's `response` shape. + * @see {@link WAFV2ClientResolvedConfig | config} for command's `input` shape. + * */ export class ListResourcesForWebACLCommand extends $Command< ListResourcesForWebACLCommandInput, diff --git a/clients/client-wafv2/commands/ListRuleGroupsCommand.ts b/clients/client-wafv2/commands/ListRuleGroupsCommand.ts index 04e58d2d8d9d..d12ac1b580df 100644 --- a/clients/client-wafv2/commands/ListRuleGroupsCommand.ts +++ b/clients/client-wafv2/commands/ListRuleGroupsCommand.ts @@ -22,6 +22,20 @@ export interface ListRuleGroupsCommandOutput extends ListRuleGroupsResponse, __M /** *

Retrieves an array of RuleGroupSummary objects for the rule groups that you manage.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { WAFV2Client, ListRuleGroupsCommand } from "@aws-sdk/client-wafv2"; // ES Modules import + * // const { WAFV2Client, ListRuleGroupsCommand } = require("@aws-sdk/client-wafv2"); // CommonJS import + * const client = new WAFV2Client(config); + * const command = new ListRuleGroupsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListRuleGroupsCommandInput} for command's `input` shape. + * @see {@link ListRuleGroupsCommandOutput} for command's `response` shape. + * @see {@link WAFV2ClientResolvedConfig | config} for command's `input` shape. + * */ export class ListRuleGroupsCommand extends $Command< ListRuleGroupsCommandInput, diff --git a/clients/client-wafv2/commands/ListTagsForResourceCommand.ts b/clients/client-wafv2/commands/ListTagsForResourceCommand.ts index 67eb2fe2db50..6844591cf3b4 100644 --- a/clients/client-wafv2/commands/ListTagsForResourceCommand.ts +++ b/clients/client-wafv2/commands/ListTagsForResourceCommand.ts @@ -24,6 +24,20 @@ export interface ListTagsForResourceCommandOutput extends ListTagsForResourceRes *

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 AWS resource, up to 50 tags for a resource.

*

You can tag the AWS resources that you manage through AWS WAF: web ACLs, rule groups, IP * sets, and regex pattern sets. You can't manage or view tags through the AWS WAF console.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { WAFV2Client, ListTagsForResourceCommand } from "@aws-sdk/client-wafv2"; // ES Modules import + * // const { WAFV2Client, ListTagsForResourceCommand } = require("@aws-sdk/client-wafv2"); // CommonJS import + * const client = new WAFV2Client(config); + * const command = new ListTagsForResourceCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListTagsForResourceCommandInput} for command's `input` shape. + * @see {@link ListTagsForResourceCommandOutput} for command's `response` shape. + * @see {@link WAFV2ClientResolvedConfig | config} for command's `input` shape. + * */ export class ListTagsForResourceCommand extends $Command< ListTagsForResourceCommandInput, diff --git a/clients/client-wafv2/commands/ListWebACLsCommand.ts b/clients/client-wafv2/commands/ListWebACLsCommand.ts index 741441f7b643..b2f32c2fd3fe 100644 --- a/clients/client-wafv2/commands/ListWebACLsCommand.ts +++ b/clients/client-wafv2/commands/ListWebACLsCommand.ts @@ -22,6 +22,20 @@ export interface ListWebACLsCommandOutput extends ListWebACLsResponse, __Metadat /** *

Retrieves an array of WebACLSummary objects for the web ACLs that you manage.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { WAFV2Client, ListWebACLsCommand } from "@aws-sdk/client-wafv2"; // ES Modules import + * // const { WAFV2Client, ListWebACLsCommand } = require("@aws-sdk/client-wafv2"); // CommonJS import + * const client = new WAFV2Client(config); + * const command = new ListWebACLsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListWebACLsCommandInput} for command's `input` shape. + * @see {@link ListWebACLsCommandOutput} for command's `response` shape. + * @see {@link WAFV2ClientResolvedConfig | config} for command's `input` shape. + * */ export class ListWebACLsCommand extends $Command< ListWebACLsCommandInput, diff --git a/clients/client-wafv2/commands/PutLoggingConfigurationCommand.ts b/clients/client-wafv2/commands/PutLoggingConfigurationCommand.ts index f514a3cf09d8..a868485c3d1e 100644 --- a/clients/client-wafv2/commands/PutLoggingConfigurationCommand.ts +++ b/clients/client-wafv2/commands/PutLoggingConfigurationCommand.ts @@ -40,6 +40,20 @@ export interface PutLoggingConfigurationCommandOutput extends PutLoggingConfigur * * *

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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { WAFV2Client, PutLoggingConfigurationCommand } from "@aws-sdk/client-wafv2"; // ES Modules import + * // const { WAFV2Client, PutLoggingConfigurationCommand } = require("@aws-sdk/client-wafv2"); // CommonJS import + * const client = new WAFV2Client(config); + * const command = new PutLoggingConfigurationCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link PutLoggingConfigurationCommandInput} for command's `input` shape. + * @see {@link PutLoggingConfigurationCommandOutput} for command's `response` shape. + * @see {@link WAFV2ClientResolvedConfig | config} for command's `input` shape. + * */ export class PutLoggingConfigurationCommand extends $Command< PutLoggingConfigurationCommandInput, diff --git a/clients/client-wafv2/commands/PutPermissionPolicyCommand.ts b/clients/client-wafv2/commands/PutPermissionPolicyCommand.ts index 9ca4a834226b..da126c581b08 100644 --- a/clients/client-wafv2/commands/PutPermissionPolicyCommand.ts +++ b/clients/client-wafv2/commands/PutPermissionPolicyCommand.ts @@ -35,6 +35,20 @@ export interface PutPermissionPolicyCommandOutput extends PutPermissionPolicyRes *

The user making the request must be the owner of the rule group.

* * + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { WAFV2Client, PutPermissionPolicyCommand } from "@aws-sdk/client-wafv2"; // ES Modules import + * // const { WAFV2Client, PutPermissionPolicyCommand } = require("@aws-sdk/client-wafv2"); // CommonJS import + * const client = new WAFV2Client(config); + * const command = new PutPermissionPolicyCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link PutPermissionPolicyCommandInput} for command's `input` shape. + * @see {@link PutPermissionPolicyCommandOutput} for command's `response` shape. + * @see {@link WAFV2ClientResolvedConfig | config} for command's `input` shape. + * */ export class PutPermissionPolicyCommand extends $Command< PutPermissionPolicyCommandInput, diff --git a/clients/client-wafv2/commands/TagResourceCommand.ts b/clients/client-wafv2/commands/TagResourceCommand.ts index ca331634ebfb..32681659981a 100644 --- a/clients/client-wafv2/commands/TagResourceCommand.ts +++ b/clients/client-wafv2/commands/TagResourceCommand.ts @@ -24,6 +24,20 @@ export interface TagResourceCommandOutput extends TagResourceResponse, __Metadat *

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.

*

You can tag the AWS resources that you manage through AWS WAF: web ACLs, rule groups, IP * sets, and regex pattern sets. You can't manage or view tags through the AWS WAF console.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { WAFV2Client, TagResourceCommand } from "@aws-sdk/client-wafv2"; // ES Modules import + * // const { WAFV2Client, TagResourceCommand } = require("@aws-sdk/client-wafv2"); // CommonJS import + * const client = new WAFV2Client(config); + * const command = new TagResourceCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link TagResourceCommandInput} for command's `input` shape. + * @see {@link TagResourceCommandOutput} for command's `response` shape. + * @see {@link WAFV2ClientResolvedConfig | config} for command's `input` shape. + * */ export class TagResourceCommand extends $Command< TagResourceCommandInput, diff --git a/clients/client-wafv2/commands/UntagResourceCommand.ts b/clients/client-wafv2/commands/UntagResourceCommand.ts index 0335581e3c03..3e5f5defb4a8 100644 --- a/clients/client-wafv2/commands/UntagResourceCommand.ts +++ b/clients/client-wafv2/commands/UntagResourceCommand.ts @@ -22,6 +22,20 @@ export interface UntagResourceCommandOutput extends UntagResourceResponse, __Met /** *

Disassociates tags from an AWS resource. 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 AWS resource.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { WAFV2Client, UntagResourceCommand } from "@aws-sdk/client-wafv2"; // ES Modules import + * // const { WAFV2Client, UntagResourceCommand } = require("@aws-sdk/client-wafv2"); // CommonJS import + * const client = new WAFV2Client(config); + * const command = new UntagResourceCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link UntagResourceCommandInput} for command's `input` shape. + * @see {@link UntagResourceCommandOutput} for command's `response` shape. + * @see {@link WAFV2ClientResolvedConfig | config} for command's `input` shape. + * */ export class UntagResourceCommand extends $Command< UntagResourceCommandInput, diff --git a/clients/client-wafv2/commands/UpdateIPSetCommand.ts b/clients/client-wafv2/commands/UpdateIPSetCommand.ts index a84ffed13a51..e462d1be680f 100644 --- a/clients/client-wafv2/commands/UpdateIPSetCommand.ts +++ b/clients/client-wafv2/commands/UpdateIPSetCommand.ts @@ -25,6 +25,20 @@ export interface UpdateIPSetCommandOutput extends UpdateIPSetResponse, __Metadat * *

This operation completely replaces any IP address specifications that you already have in the IP set with the ones that you provide to this call. If you want to add to or modify the addresses that are already in the IP set, retrieve those by calling GetIPSet, update them, and provide the complete updated array of IP addresses to this call.

* + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { WAFV2Client, UpdateIPSetCommand } from "@aws-sdk/client-wafv2"; // ES Modules import + * // const { WAFV2Client, UpdateIPSetCommand } = require("@aws-sdk/client-wafv2"); // CommonJS import + * const client = new WAFV2Client(config); + * const command = new UpdateIPSetCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link UpdateIPSetCommandInput} for command's `input` shape. + * @see {@link UpdateIPSetCommandOutput} for command's `response` shape. + * @see {@link WAFV2ClientResolvedConfig | config} for command's `input` shape. + * */ export class UpdateIPSetCommand extends $Command< UpdateIPSetCommandInput, diff --git a/clients/client-wafv2/commands/UpdateRegexPatternSetCommand.ts b/clients/client-wafv2/commands/UpdateRegexPatternSetCommand.ts index 499e3e9a278b..358fa1dcbc30 100644 --- a/clients/client-wafv2/commands/UpdateRegexPatternSetCommand.ts +++ b/clients/client-wafv2/commands/UpdateRegexPatternSetCommand.ts @@ -22,6 +22,20 @@ export interface UpdateRegexPatternSetCommandOutput extends UpdateRegexPatternSe /** *

Updates the specified RegexPatternSet.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { WAFV2Client, UpdateRegexPatternSetCommand } from "@aws-sdk/client-wafv2"; // ES Modules import + * // const { WAFV2Client, UpdateRegexPatternSetCommand } = require("@aws-sdk/client-wafv2"); // CommonJS import + * const client = new WAFV2Client(config); + * const command = new UpdateRegexPatternSetCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link UpdateRegexPatternSetCommandInput} for command's `input` shape. + * @see {@link UpdateRegexPatternSetCommandOutput} for command's `response` shape. + * @see {@link WAFV2ClientResolvedConfig | config} for command's `input` shape. + * */ export class UpdateRegexPatternSetCommand extends $Command< UpdateRegexPatternSetCommandInput, diff --git a/clients/client-wafv2/commands/UpdateRuleGroupCommand.ts b/clients/client-wafv2/commands/UpdateRuleGroupCommand.ts index 92259539044c..e717811bcc7c 100644 --- a/clients/client-wafv2/commands/UpdateRuleGroupCommand.ts +++ b/clients/client-wafv2/commands/UpdateRuleGroupCommand.ts @@ -23,6 +23,20 @@ export interface UpdateRuleGroupCommandOutput extends UpdateRuleGroupResponse, _ /** *

Updates the specified RuleGroup.

*

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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { WAFV2Client, UpdateRuleGroupCommand } from "@aws-sdk/client-wafv2"; // ES Modules import + * // const { WAFV2Client, UpdateRuleGroupCommand } = require("@aws-sdk/client-wafv2"); // CommonJS import + * const client = new WAFV2Client(config); + * const command = new UpdateRuleGroupCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link UpdateRuleGroupCommandInput} for command's `input` shape. + * @see {@link UpdateRuleGroupCommandOutput} for command's `response` shape. + * @see {@link WAFV2ClientResolvedConfig | config} for command's `input` shape. + * */ export class UpdateRuleGroupCommand extends $Command< UpdateRuleGroupCommandInput, diff --git a/clients/client-wafv2/commands/UpdateWebACLCommand.ts b/clients/client-wafv2/commands/UpdateWebACLCommand.ts index 27c967391597..b19a3209bc51 100644 --- a/clients/client-wafv2/commands/UpdateWebACLCommand.ts +++ b/clients/client-wafv2/commands/UpdateWebACLCommand.ts @@ -23,6 +23,20 @@ export interface UpdateWebACLCommandOutput extends UpdateWebACLResponse, __Metad /** *

Updates the specified WebACL.

*

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 AWS resources to protect. The resources can be Amazon CloudFront, an Amazon API Gateway REST API, an Application Load Balancer, or an AWS AppSync GraphQL API.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { WAFV2Client, UpdateWebACLCommand } from "@aws-sdk/client-wafv2"; // ES Modules import + * // const { WAFV2Client, UpdateWebACLCommand } = require("@aws-sdk/client-wafv2"); // CommonJS import + * const client = new WAFV2Client(config); + * const command = new UpdateWebACLCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link UpdateWebACLCommandInput} for command's `input` shape. + * @see {@link UpdateWebACLCommandOutput} for command's `response` shape. + * @see {@link WAFV2ClientResolvedConfig | config} for command's `input` shape. + * */ export class UpdateWebACLCommand extends $Command< UpdateWebACLCommandInput, diff --git a/clients/client-wafv2/models/models_0.ts b/clients/client-wafv2/models/models_0.ts index 47527d0889e7..4daa75c59ecf 100644 --- a/clients/client-wafv2/models/models_0.ts +++ b/clients/client-wafv2/models/models_0.ts @@ -18,6 +18,9 @@ export interface ActionCondition { } export namespace ActionCondition { + /** + * @internal + */ export const filterSensitiveLog = (obj: ActionCondition): any => ({ ...obj, }); @@ -31,6 +34,9 @@ export namespace ActionCondition { export interface All {} export namespace All { + /** + * @internal + */ export const filterSensitiveLog = (obj: All): any => ({ ...obj, }); @@ -53,6 +59,9 @@ export interface CustomHTTPHeader { } export namespace CustomHTTPHeader { + /** + * @internal + */ export const filterSensitiveLog = (obj: CustomHTTPHeader): any => ({ ...obj, }); @@ -73,6 +82,9 @@ export interface CustomRequestHandling { } export namespace CustomRequestHandling { + /** + * @internal + */ export const filterSensitiveLog = (obj: CustomRequestHandling): any => ({ ...obj, }); @@ -92,6 +104,9 @@ export interface AllowAction { } export namespace AllowAction { + /** + * @internal + */ export const filterSensitiveLog = (obj: AllowAction): any => ({ ...obj, }); @@ -104,6 +119,9 @@ export namespace AllowAction { export interface AllQueryArguments {} export namespace AllQueryArguments { + /** + * @internal + */ export const filterSensitiveLog = (obj: AllQueryArguments): any => ({ ...obj, }); @@ -116,6 +134,9 @@ export namespace AllQueryArguments { export interface Body {} export namespace Body { + /** + * @internal + */ export const filterSensitiveLog = (obj: Body): any => ({ ...obj, }); @@ -150,6 +171,9 @@ export interface JsonMatchPattern { } export namespace JsonMatchPattern { + /** + * @internal + */ export const filterSensitiveLog = (obj: JsonMatchPattern): any => ({ ...obj, }); @@ -226,6 +250,9 @@ export interface JsonBody { } export namespace JsonBody { + /** + * @internal + */ export const filterSensitiveLog = (obj: JsonBody): any => ({ ...obj, }); @@ -238,6 +265,9 @@ export namespace JsonBody { export interface Method {} export namespace Method { + /** + * @internal + */ export const filterSensitiveLog = (obj: Method): any => ({ ...obj, }); @@ -250,6 +280,9 @@ export namespace Method { export interface QueryString {} export namespace QueryString { + /** + * @internal + */ export const filterSensitiveLog = (obj: QueryString): any => ({ ...obj, }); @@ -267,6 +300,9 @@ export interface SingleHeader { } export namespace SingleHeader { + /** + * @internal + */ export const filterSensitiveLog = (obj: SingleHeader): any => ({ ...obj, }); @@ -283,6 +319,9 @@ export interface SingleQueryArgument { } export namespace SingleQueryArgument { + /** + * @internal + */ export const filterSensitiveLog = (obj: SingleQueryArgument): any => ({ ...obj, }); @@ -295,6 +334,9 @@ export namespace SingleQueryArgument { export interface UriPath {} export namespace UriPath { + /** + * @internal + */ export const filterSensitiveLog = (obj: UriPath): any => ({ ...obj, }); @@ -355,6 +397,9 @@ export interface FieldToMatch { } export namespace FieldToMatch { + /** + * @internal + */ export const filterSensitiveLog = (obj: FieldToMatch): any => ({ ...obj, }); @@ -485,6 +530,9 @@ export interface TextTransformation { } export namespace TextTransformation { + /** + * @internal + */ export const filterSensitiveLog = (obj: TextTransformation): any => ({ ...obj, }); @@ -583,6 +631,9 @@ export interface ByteMatchStatement { } export namespace ByteMatchStatement { + /** + * @internal + */ export const filterSensitiveLog = (obj: ByteMatchStatement): any => ({ ...obj, }); @@ -890,6 +941,9 @@ export interface ForwardedIPConfig { } export namespace ForwardedIPConfig { + /** + * @internal + */ export const filterSensitiveLog = (obj: ForwardedIPConfig): any => ({ ...obj, }); @@ -915,6 +969,9 @@ export interface GeoMatchStatement { } export namespace GeoMatchStatement { + /** + * @internal + */ export const filterSensitiveLog = (obj: GeoMatchStatement): any => ({ ...obj, }); @@ -986,6 +1043,9 @@ export interface IPSetForwardedIPConfig { } export namespace IPSetForwardedIPConfig { + /** + * @internal + */ export const filterSensitiveLog = (obj: IPSetForwardedIPConfig): any => ({ ...obj, }); @@ -1012,6 +1072,9 @@ export interface IPSetReferenceStatement { } export namespace IPSetReferenceStatement { + /** + * @internal + */ export const filterSensitiveLog = (obj: IPSetReferenceStatement): any => ({ ...obj, }); @@ -1048,6 +1111,9 @@ export interface LabelMatchStatement { } export namespace LabelMatchStatement { + /** + * @internal + */ export const filterSensitiveLog = (obj: LabelMatchStatement): any => ({ ...obj, }); @@ -1066,6 +1132,9 @@ export interface ExcludedRule { } export namespace ExcludedRule { + /** + * @internal + */ export const filterSensitiveLog = (obj: ExcludedRule): any => ({ ...obj, }); @@ -1100,6 +1169,9 @@ export interface RegexPatternSetReferenceStatement { } export namespace RegexPatternSetReferenceStatement { + /** + * @internal + */ export const filterSensitiveLog = (obj: RegexPatternSetReferenceStatement): any => ({ ...obj, }); @@ -1122,6 +1194,9 @@ export interface RuleGroupReferenceStatement { } export namespace RuleGroupReferenceStatement { + /** + * @internal + */ export const filterSensitiveLog = (obj: RuleGroupReferenceStatement): any => ({ ...obj, }); @@ -1166,6 +1241,9 @@ export interface SizeConstraintStatement { } export namespace SizeConstraintStatement { + /** + * @internal + */ export const filterSensitiveLog = (obj: SizeConstraintStatement): any => ({ ...obj, }); @@ -1189,6 +1267,9 @@ export interface SqliMatchStatement { } export namespace SqliMatchStatement { + /** + * @internal + */ export const filterSensitiveLog = (obj: SqliMatchStatement): any => ({ ...obj, }); @@ -1216,6 +1297,9 @@ export interface XssMatchStatement { } export namespace XssMatchStatement { + /** + * @internal + */ export const filterSensitiveLog = (obj: XssMatchStatement): any => ({ ...obj, }); @@ -1253,6 +1337,9 @@ export interface AssociateWebACLRequest { } export namespace AssociateWebACLRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: AssociateWebACLRequest): any => ({ ...obj, }); @@ -1261,6 +1348,9 @@ export namespace AssociateWebACLRequest { export interface AssociateWebACLResponse {} export namespace AssociateWebACLResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: AssociateWebACLResponse): any => ({ ...obj, }); @@ -1276,6 +1366,9 @@ export interface WAFInternalErrorException extends __SmithyException, $MetadataB } export namespace WAFInternalErrorException { + /** + * @internal + */ export const filterSensitiveLog = (obj: WAFInternalErrorException): any => ({ ...obj, }); @@ -1291,6 +1384,9 @@ export interface WAFInvalidOperationException extends __SmithyException, $Metada } export namespace WAFInvalidOperationException { + /** + * @internal + */ export const filterSensitiveLog = (obj: WAFInvalidOperationException): any => ({ ...obj, }); @@ -1380,6 +1476,9 @@ export interface WAFInvalidParameterException extends __SmithyException, $Metada } export namespace WAFInvalidParameterException { + /** + * @internal + */ export const filterSensitiveLog = (obj: WAFInvalidParameterException): any => ({ ...obj, }); @@ -1395,6 +1494,9 @@ export interface WAFNonexistentItemException extends __SmithyException, $Metadat } export namespace WAFNonexistentItemException { + /** + * @internal + */ export const filterSensitiveLog = (obj: WAFNonexistentItemException): any => ({ ...obj, }); @@ -1410,6 +1512,9 @@ export interface WAFUnavailableEntityException extends __SmithyException, $Metad } export namespace WAFUnavailableEntityException { + /** + * @internal + */ export const filterSensitiveLog = (obj: WAFUnavailableEntityException): any => ({ ...obj, }); @@ -1444,6 +1549,9 @@ export interface CustomResponse { } export namespace CustomResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: CustomResponse): any => ({ ...obj, }); @@ -1463,6 +1571,9 @@ export interface BlockAction { } export namespace BlockAction { + /** + * @internal + */ export const filterSensitiveLog = (obj: BlockAction): any => ({ ...obj, }); @@ -1482,6 +1593,9 @@ export interface CountAction { } export namespace CountAction { + /** + * @internal + */ export const filterSensitiveLog = (obj: CountAction): any => ({ ...obj, }); @@ -1508,6 +1622,9 @@ export interface RuleAction { } export namespace RuleAction { + /** + * @internal + */ export const filterSensitiveLog = (obj: RuleAction): any => ({ ...obj, }); @@ -1520,6 +1637,9 @@ export namespace RuleAction { export interface NoneAction {} export namespace NoneAction { + /** + * @internal + */ export const filterSensitiveLog = (obj: NoneAction): any => ({ ...obj, }); @@ -1552,6 +1672,9 @@ export interface OverrideAction { } export namespace OverrideAction { + /** + * @internal + */ export const filterSensitiveLog = (obj: OverrideAction): any => ({ ...obj, }); @@ -1568,6 +1691,9 @@ export interface Label { } export namespace Label { + /** + * @internal + */ export const filterSensitiveLog = (obj: Label): any => ({ ...obj, }); @@ -1597,6 +1723,9 @@ export interface VisibilityConfig { } export namespace VisibilityConfig { + /** + * @internal + */ export const filterSensitiveLog = (obj: VisibilityConfig): any => ({ ...obj, }); @@ -1615,6 +1744,9 @@ export interface CheckCapacityResponse { } export namespace CheckCapacityResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: CheckCapacityResponse): any => ({ ...obj, }); @@ -1630,6 +1762,9 @@ export interface WAFInvalidResourceException extends __SmithyException, $Metadat } export namespace WAFInvalidResourceException { + /** + * @internal + */ export const filterSensitiveLog = (obj: WAFInvalidResourceException): any => ({ ...obj, }); @@ -1647,6 +1782,9 @@ export interface WAFLimitsExceededException extends __SmithyException, $Metadata } export namespace WAFLimitsExceededException { + /** + * @internal + */ export const filterSensitiveLog = (obj: WAFLimitsExceededException): any => ({ ...obj, }); @@ -1662,6 +1800,9 @@ export interface WAFSubscriptionNotFoundException extends __SmithyException, $Me } export namespace WAFSubscriptionNotFoundException { + /** + * @internal + */ export const filterSensitiveLog = (obj: WAFSubscriptionNotFoundException): any => ({ ...obj, }); @@ -1691,6 +1832,9 @@ export interface Tag { } export namespace Tag { + /** + * @internal + */ export const filterSensitiveLog = (obj: Tag): any => ({ ...obj, }); @@ -1756,6 +1900,9 @@ export interface CreateIPSetRequest { } export namespace CreateIPSetRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateIPSetRequest): any => ({ ...obj, }); @@ -1792,6 +1939,9 @@ export interface IPSetSummary { } export namespace IPSetSummary { + /** + * @internal + */ export const filterSensitiveLog = (obj: IPSetSummary): any => ({ ...obj, }); @@ -1805,6 +1955,9 @@ export interface CreateIPSetResponse { } export namespace CreateIPSetResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateIPSetResponse): any => ({ ...obj, }); @@ -1820,6 +1973,9 @@ export interface WAFDuplicateItemException extends __SmithyException, $MetadataB } export namespace WAFDuplicateItemException { + /** + * @internal + */ export const filterSensitiveLog = (obj: WAFDuplicateItemException): any => ({ ...obj, }); @@ -1835,6 +1991,9 @@ export interface WAFOptimisticLockException extends __SmithyException, $Metadata } export namespace WAFOptimisticLockException { + /** + * @internal + */ export const filterSensitiveLog = (obj: WAFOptimisticLockException): any => ({ ...obj, }); @@ -1850,6 +2009,9 @@ export interface WAFTagOperationException extends __SmithyException, $MetadataBe } export namespace WAFTagOperationException { + /** + * @internal + */ export const filterSensitiveLog = (obj: WAFTagOperationException): any => ({ ...obj, }); @@ -1865,6 +2027,9 @@ export interface WAFTagOperationInternalErrorException extends __SmithyException } export namespace WAFTagOperationInternalErrorException { + /** + * @internal + */ export const filterSensitiveLog = (obj: WAFTagOperationInternalErrorException): any => ({ ...obj, }); @@ -1881,6 +2046,9 @@ export interface Regex { } export namespace Regex { + /** + * @internal + */ export const filterSensitiveLog = (obj: Regex): any => ({ ...obj, }); @@ -1923,6 +2091,9 @@ export interface CreateRegexPatternSetRequest { } export namespace CreateRegexPatternSetRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateRegexPatternSetRequest): any => ({ ...obj, }); @@ -1959,6 +2130,9 @@ export interface RegexPatternSetSummary { } export namespace RegexPatternSetSummary { + /** + * @internal + */ export const filterSensitiveLog = (obj: RegexPatternSetSummary): any => ({ ...obj, }); @@ -1972,6 +2146,9 @@ export interface CreateRegexPatternSetResponse { } export namespace CreateRegexPatternSetResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateRegexPatternSetResponse): any => ({ ...obj, }); @@ -2003,6 +2180,9 @@ export interface CustomResponseBody { } export namespace CustomResponseBody { + /** + * @internal + */ export const filterSensitiveLog = (obj: CustomResponseBody): any => ({ ...obj, }); @@ -2039,6 +2219,9 @@ export interface RuleGroupSummary { } export namespace RuleGroupSummary { + /** + * @internal + */ export const filterSensitiveLog = (obj: RuleGroupSummary): any => ({ ...obj, }); @@ -2052,6 +2235,9 @@ export interface CreateRuleGroupResponse { } export namespace CreateRuleGroupResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateRuleGroupResponse): any => ({ ...obj, }); @@ -2074,6 +2260,9 @@ export interface DefaultAction { } export namespace DefaultAction { + /** + * @internal + */ export const filterSensitiveLog = (obj: DefaultAction): any => ({ ...obj, }); @@ -2110,6 +2299,9 @@ export interface WebACLSummary { } export namespace WebACLSummary { + /** + * @internal + */ export const filterSensitiveLog = (obj: WebACLSummary): any => ({ ...obj, }); @@ -2123,6 +2315,9 @@ export interface CreateWebACLResponse { } export namespace CreateWebACLResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateWebACLResponse): any => ({ ...obj, }); @@ -2141,6 +2336,9 @@ export interface DeleteFirewallManagerRuleGroupsRequest { } export namespace DeleteFirewallManagerRuleGroupsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteFirewallManagerRuleGroupsRequest): any => ({ ...obj, }); @@ -2154,6 +2352,9 @@ export interface DeleteFirewallManagerRuleGroupsResponse { } export namespace DeleteFirewallManagerRuleGroupsResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteFirewallManagerRuleGroupsResponse): any => ({ ...obj, }); @@ -2191,6 +2392,9 @@ export interface DeleteIPSetRequest { } export namespace DeleteIPSetRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteIPSetRequest): any => ({ ...obj, }); @@ -2199,6 +2403,9 @@ export namespace DeleteIPSetRequest { export interface DeleteIPSetResponse {} export namespace DeleteIPSetResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteIPSetResponse): any => ({ ...obj, }); @@ -2214,6 +2421,9 @@ export interface WAFAssociatedItemException extends __SmithyException, $Metadata } export namespace WAFAssociatedItemException { + /** + * @internal + */ export const filterSensitiveLog = (obj: WAFAssociatedItemException): any => ({ ...obj, }); @@ -2227,6 +2437,9 @@ export interface DeleteLoggingConfigurationRequest { } export namespace DeleteLoggingConfigurationRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteLoggingConfigurationRequest): any => ({ ...obj, }); @@ -2235,6 +2448,9 @@ export namespace DeleteLoggingConfigurationRequest { export interface DeleteLoggingConfigurationResponse {} export namespace DeleteLoggingConfigurationResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteLoggingConfigurationResponse): any => ({ ...obj, }); @@ -2249,6 +2465,9 @@ export interface DeletePermissionPolicyRequest { } export namespace DeletePermissionPolicyRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeletePermissionPolicyRequest): any => ({ ...obj, }); @@ -2257,6 +2476,9 @@ export namespace DeletePermissionPolicyRequest { export interface DeletePermissionPolicyResponse {} export namespace DeletePermissionPolicyResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeletePermissionPolicyResponse): any => ({ ...obj, }); @@ -2294,6 +2516,9 @@ export interface DeleteRegexPatternSetRequest { } export namespace DeleteRegexPatternSetRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteRegexPatternSetRequest): any => ({ ...obj, }); @@ -2302,6 +2527,9 @@ export namespace DeleteRegexPatternSetRequest { export interface DeleteRegexPatternSetResponse {} export namespace DeleteRegexPatternSetResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteRegexPatternSetResponse): any => ({ ...obj, }); @@ -2339,6 +2567,9 @@ export interface DeleteRuleGroupRequest { } export namespace DeleteRuleGroupRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteRuleGroupRequest): any => ({ ...obj, }); @@ -2347,6 +2578,9 @@ export namespace DeleteRuleGroupRequest { export interface DeleteRuleGroupResponse {} export namespace DeleteRuleGroupResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteRuleGroupResponse): any => ({ ...obj, }); @@ -2384,6 +2618,9 @@ export interface DeleteWebACLRequest { } export namespace DeleteWebACLRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteWebACLRequest): any => ({ ...obj, }); @@ -2392,6 +2629,9 @@ export namespace DeleteWebACLRequest { export interface DeleteWebACLResponse {} export namespace DeleteWebACLResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteWebACLResponse): any => ({ ...obj, }); @@ -2424,6 +2664,9 @@ export interface DescribeManagedRuleGroupRequest { } export namespace DescribeManagedRuleGroupRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeManagedRuleGroupRequest): any => ({ ...obj, }); @@ -2450,6 +2693,9 @@ export interface LabelSummary { } export namespace LabelSummary { + /** + * @internal + */ export const filterSensitiveLog = (obj: LabelSummary): any => ({ ...obj, }); @@ -2471,6 +2717,9 @@ export interface RuleSummary { } export namespace RuleSummary { + /** + * @internal + */ export const filterSensitiveLog = (obj: RuleSummary): any => ({ ...obj, }); @@ -2524,6 +2773,9 @@ export interface DescribeManagedRuleGroupResponse { } export namespace DescribeManagedRuleGroupResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeManagedRuleGroupResponse): any => ({ ...obj, }); @@ -2556,6 +2808,9 @@ export interface DisassociateWebACLRequest { } export namespace DisassociateWebACLRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DisassociateWebACLRequest): any => ({ ...obj, }); @@ -2564,6 +2819,9 @@ export namespace DisassociateWebACLRequest { export interface DisassociateWebACLResponse {} export namespace DisassociateWebACLResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DisassociateWebACLResponse): any => ({ ...obj, }); @@ -2596,6 +2854,9 @@ export interface GetIPSetRequest { } export namespace GetIPSetRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetIPSetRequest): any => ({ ...obj, }); @@ -2657,6 +2918,9 @@ export interface IPSet { } export namespace IPSet { + /** + * @internal + */ export const filterSensitiveLog = (obj: IPSet): any => ({ ...obj, }); @@ -2675,6 +2939,9 @@ export interface GetIPSetResponse { } export namespace GetIPSetResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetIPSetResponse): any => ({ ...obj, }); @@ -2688,6 +2955,9 @@ export interface GetLoggingConfigurationRequest { } export namespace GetLoggingConfigurationRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetLoggingConfigurationRequest): any => ({ ...obj, }); @@ -2709,6 +2979,9 @@ export interface LabelNameCondition { } export namespace LabelNameCondition { + /** + * @internal + */ export const filterSensitiveLog = (obj: LabelNameCondition): any => ({ ...obj, }); @@ -2730,6 +3003,9 @@ export interface Condition { } export namespace Condition { + /** + * @internal + */ export const filterSensitiveLog = (obj: Condition): any => ({ ...obj, }); @@ -2761,6 +3037,9 @@ export interface Filter { } export namespace Filter { + /** + * @internal + */ export const filterSensitiveLog = (obj: Filter): any => ({ ...obj, }); @@ -2783,6 +3062,9 @@ export interface LoggingFilter { } export namespace LoggingFilter { + /** + * @internal + */ export const filterSensitiveLog = (obj: LoggingFilter): any => ({ ...obj, }); @@ -2828,6 +3110,9 @@ export interface LoggingConfiguration { } export namespace LoggingConfiguration { + /** + * @internal + */ export const filterSensitiveLog = (obj: LoggingConfiguration): any => ({ ...obj, }); @@ -2841,6 +3126,9 @@ export interface GetLoggingConfigurationResponse { } export namespace GetLoggingConfigurationResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetLoggingConfigurationResponse): any => ({ ...obj, }); @@ -2854,6 +3142,9 @@ export interface GetPermissionPolicyRequest { } export namespace GetPermissionPolicyRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetPermissionPolicyRequest): any => ({ ...obj, }); @@ -2867,6 +3158,9 @@ export interface GetPermissionPolicyResponse { } export namespace GetPermissionPolicyResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetPermissionPolicyResponse): any => ({ ...obj, }); @@ -2904,6 +3198,9 @@ export interface GetRateBasedStatementManagedKeysRequest { } export namespace GetRateBasedStatementManagedKeysRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetRateBasedStatementManagedKeysRequest): any => ({ ...obj, }); @@ -2921,6 +3218,9 @@ export interface RateBasedStatementManagedKeysIPSet { } export namespace RateBasedStatementManagedKeysIPSet { + /** + * @internal + */ export const filterSensitiveLog = (obj: RateBasedStatementManagedKeysIPSet): any => ({ ...obj, }); @@ -2939,6 +3239,9 @@ export interface GetRateBasedStatementManagedKeysResponse { } export namespace GetRateBasedStatementManagedKeysResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetRateBasedStatementManagedKeysResponse): any => ({ ...obj, }); @@ -2971,6 +3274,9 @@ export interface GetRegexPatternSetRequest { } export namespace GetRegexPatternSetRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetRegexPatternSetRequest): any => ({ ...obj, }); @@ -3008,6 +3314,9 @@ export interface RegexPatternSet { } export namespace RegexPatternSet { + /** + * @internal + */ export const filterSensitiveLog = (obj: RegexPatternSet): any => ({ ...obj, }); @@ -3026,6 +3335,9 @@ export interface GetRegexPatternSetResponse { } export namespace GetRegexPatternSetResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetRegexPatternSetResponse): any => ({ ...obj, }); @@ -3058,6 +3370,9 @@ export interface GetRuleGroupRequest { } export namespace GetRuleGroupRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetRuleGroupRequest): any => ({ ...obj, }); @@ -3088,6 +3403,9 @@ export interface TimeWindow { } export namespace TimeWindow { + /** + * @internal + */ export const filterSensitiveLog = (obj: TimeWindow): any => ({ ...obj, }); @@ -3133,6 +3451,9 @@ export interface GetSampledRequestsRequest { } export namespace GetSampledRequestsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetSampledRequestsRequest): any => ({ ...obj, }); @@ -3156,6 +3477,9 @@ export interface HTTPHeader { } export namespace HTTPHeader { + /** + * @internal + */ export const filterSensitiveLog = (obj: HTTPHeader): any => ({ ...obj, }); @@ -3211,6 +3535,9 @@ export interface HTTPRequest { } export namespace HTTPRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: HTTPRequest): any => ({ ...obj, }); @@ -3269,6 +3596,9 @@ export interface SampledHTTPRequest { } export namespace SampledHTTPRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: SampledHTTPRequest): any => ({ ...obj, }); @@ -3296,6 +3626,9 @@ export interface GetSampledRequestsResponse { } export namespace GetSampledRequestsResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetSampledRequestsResponse): any => ({ ...obj, }); @@ -3328,6 +3661,9 @@ export interface GetWebACLRequest { } export namespace GetWebACLRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetWebACLRequest): any => ({ ...obj, }); @@ -3341,6 +3677,9 @@ export interface GetWebACLForResourceRequest { } export namespace GetWebACLForResourceRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetWebACLForResourceRequest): any => ({ ...obj, }); @@ -3377,6 +3716,9 @@ export interface ListAvailableManagedRuleGroupsRequest { } export namespace ListAvailableManagedRuleGroupsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListAvailableManagedRuleGroupsRequest): any => ({ ...obj, }); @@ -3403,6 +3745,9 @@ export interface ManagedRuleGroupSummary { } export namespace ManagedRuleGroupSummary { + /** + * @internal + */ export const filterSensitiveLog = (obj: ManagedRuleGroupSummary): any => ({ ...obj, }); @@ -3423,6 +3768,9 @@ export interface ListAvailableManagedRuleGroupsResponse { } export namespace ListAvailableManagedRuleGroupsResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListAvailableManagedRuleGroupsResponse): any => ({ ...obj, }); @@ -3459,6 +3807,9 @@ export interface ListIPSetsRequest { } export namespace ListIPSetsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListIPSetsRequest): any => ({ ...obj, }); @@ -3479,6 +3830,9 @@ export interface ListIPSetsResponse { } export namespace ListIPSetsResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListIPSetsResponse): any => ({ ...obj, }); @@ -3515,6 +3869,9 @@ export interface ListLoggingConfigurationsRequest { } export namespace ListLoggingConfigurationsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListLoggingConfigurationsRequest): any => ({ ...obj, }); @@ -3535,6 +3892,9 @@ export interface ListLoggingConfigurationsResponse { } export namespace ListLoggingConfigurationsResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListLoggingConfigurationsResponse): any => ({ ...obj, }); @@ -3571,6 +3931,9 @@ export interface ListRegexPatternSetsRequest { } export namespace ListRegexPatternSetsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListRegexPatternSetsRequest): any => ({ ...obj, }); @@ -3591,6 +3954,9 @@ export interface ListRegexPatternSetsResponse { } export namespace ListRegexPatternSetsResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListRegexPatternSetsResponse): any => ({ ...obj, }); @@ -3615,6 +3981,9 @@ export interface ListResourcesForWebACLRequest { } export namespace ListResourcesForWebACLRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListResourcesForWebACLRequest): any => ({ ...obj, }); @@ -3628,6 +3997,9 @@ export interface ListResourcesForWebACLResponse { } export namespace ListResourcesForWebACLResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListResourcesForWebACLResponse): any => ({ ...obj, }); @@ -3664,6 +4036,9 @@ export interface ListRuleGroupsRequest { } export namespace ListRuleGroupsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListRuleGroupsRequest): any => ({ ...obj, }); @@ -3684,6 +4059,9 @@ export interface ListRuleGroupsResponse { } export namespace ListRuleGroupsResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListRuleGroupsResponse): any => ({ ...obj, }); @@ -3711,6 +4089,9 @@ export interface ListTagsForResourceRequest { } export namespace ListTagsForResourceRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListTagsForResourceRequest): any => ({ ...obj, }); @@ -3735,6 +4116,9 @@ export interface TagInfoForResource { } export namespace TagInfoForResource { + /** + * @internal + */ export const filterSensitiveLog = (obj: TagInfoForResource): any => ({ ...obj, }); @@ -3755,6 +4139,9 @@ export interface ListTagsForResourceResponse { } export namespace ListTagsForResourceResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListTagsForResourceResponse): any => ({ ...obj, }); @@ -3791,6 +4178,9 @@ export interface ListWebACLsRequest { } export namespace ListWebACLsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListWebACLsRequest): any => ({ ...obj, }); @@ -3811,6 +4201,9 @@ export interface ListWebACLsResponse { } export namespace ListWebACLsResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListWebACLsResponse): any => ({ ...obj, }); @@ -3824,6 +4217,9 @@ export interface PutLoggingConfigurationRequest { } export namespace PutLoggingConfigurationRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: PutLoggingConfigurationRequest): any => ({ ...obj, }); @@ -3837,6 +4233,9 @@ export interface PutLoggingConfigurationResponse { } export namespace PutLoggingConfigurationResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: PutLoggingConfigurationResponse): any => ({ ...obj, }); @@ -3852,6 +4251,9 @@ export interface WAFServiceLinkedRoleErrorException extends __SmithyException, $ } export namespace WAFServiceLinkedRoleErrorException { + /** + * @internal + */ export const filterSensitiveLog = (obj: WAFServiceLinkedRoleErrorException): any => ({ ...obj, }); @@ -3892,6 +4294,9 @@ export interface PutPermissionPolicyRequest { } export namespace PutPermissionPolicyRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: PutPermissionPolicyRequest): any => ({ ...obj, }); @@ -3900,6 +4305,9 @@ export namespace PutPermissionPolicyRequest { export interface PutPermissionPolicyResponse {} export namespace PutPermissionPolicyResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: PutPermissionPolicyResponse): any => ({ ...obj, }); @@ -3937,6 +4345,9 @@ export interface WAFInvalidPermissionPolicyException extends __SmithyException, } export namespace WAFInvalidPermissionPolicyException { + /** + * @internal + */ export const filterSensitiveLog = (obj: WAFInvalidPermissionPolicyException): any => ({ ...obj, }); @@ -3955,6 +4366,9 @@ export interface TagResourceRequest { } export namespace TagResourceRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: TagResourceRequest): any => ({ ...obj, }); @@ -3963,6 +4377,9 @@ export namespace TagResourceRequest { export interface TagResourceResponse {} export namespace TagResourceResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: TagResourceResponse): any => ({ ...obj, }); @@ -3981,6 +4398,9 @@ export interface UntagResourceRequest { } export namespace UntagResourceRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: UntagResourceRequest): any => ({ ...obj, }); @@ -3989,6 +4409,9 @@ export namespace UntagResourceRequest { export interface UntagResourceResponse {} export namespace UntagResourceResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: UntagResourceResponse): any => ({ ...obj, }); @@ -4054,6 +4477,9 @@ export interface UpdateIPSetRequest { } export namespace UpdateIPSetRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateIPSetRequest): any => ({ ...obj, }); @@ -4067,6 +4493,9 @@ export interface UpdateIPSetResponse { } export namespace UpdateIPSetResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateIPSetResponse): any => ({ ...obj, }); @@ -4114,6 +4543,9 @@ export interface UpdateRegexPatternSetRequest { } export namespace UpdateRegexPatternSetRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateRegexPatternSetRequest): any => ({ ...obj, }); @@ -4127,6 +4559,9 @@ export interface UpdateRegexPatternSetResponse { } export namespace UpdateRegexPatternSetResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateRegexPatternSetResponse): any => ({ ...obj, }); @@ -4140,6 +4575,9 @@ export interface UpdateRuleGroupResponse { } export namespace UpdateRuleGroupResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateRuleGroupResponse): any => ({ ...obj, }); @@ -4153,6 +4591,9 @@ export interface UpdateWebACLResponse { } export namespace UpdateWebACLResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateWebACLResponse): any => ({ ...obj, }); @@ -4257,6 +4698,9 @@ export interface Statement { } export namespace Statement { + /** + * @internal + */ export const filterSensitiveLog = (obj: Statement): any => ({ ...obj, }); @@ -4289,6 +4733,9 @@ export interface ManagedRuleGroupStatement { } export namespace ManagedRuleGroupStatement { + /** + * @internal + */ export const filterSensitiveLog = (obj: ManagedRuleGroupStatement): any => ({ ...obj, }); @@ -4305,6 +4752,9 @@ export interface NotStatement { } export namespace NotStatement { + /** + * @internal + */ export const filterSensitiveLog = (obj: NotStatement): any => ({ ...obj, }); @@ -4363,6 +4813,9 @@ export interface RateBasedStatement { } export namespace RateBasedStatement { + /** + * @internal + */ export const filterSensitiveLog = (obj: RateBasedStatement): any => ({ ...obj, }); @@ -4453,6 +4906,9 @@ export interface Rule { } export namespace Rule { + /** + * @internal + */ export const filterSensitiveLog = (obj: Rule): any => ({ ...obj, }); @@ -4469,6 +4925,9 @@ export interface AndStatement { } export namespace AndStatement { + /** + * @internal + */ export const filterSensitiveLog = (obj: AndStatement): any => ({ ...obj, }); @@ -4485,6 +4944,9 @@ export interface OrStatement { } export namespace OrStatement { + /** + * @internal + */ export const filterSensitiveLog = (obj: OrStatement): any => ({ ...obj, }); @@ -4508,6 +4970,9 @@ export interface FirewallManagerStatement { } export namespace FirewallManagerStatement { + /** + * @internal + */ export const filterSensitiveLog = (obj: FirewallManagerStatement): any => ({ ...obj, }); @@ -4557,6 +5022,9 @@ export interface FirewallManagerRuleGroup { } export namespace FirewallManagerRuleGroup { + /** + * @internal + */ export const filterSensitiveLog = (obj: FirewallManagerRuleGroup): any => ({ ...obj, }); @@ -4584,6 +5052,9 @@ export interface CheckCapacityRequest { } export namespace CheckCapacityRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: CheckCapacityRequest): any => ({ ...obj, }); @@ -4659,6 +5130,9 @@ export interface CreateRuleGroupRequest { } export namespace CreateRuleGroupRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateRuleGroupRequest): any => ({ ...obj, }); @@ -4723,6 +5197,9 @@ export interface CreateWebACLRequest { } export namespace CreateWebACLRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateWebACLRequest): any => ({ ...obj, }); @@ -4822,6 +5299,9 @@ export interface RuleGroup { } export namespace RuleGroup { + /** + * @internal + */ export const filterSensitiveLog = (obj: RuleGroup): any => ({ ...obj, }); @@ -4886,6 +5366,9 @@ export interface UpdateRuleGroupRequest { } export namespace UpdateRuleGroupRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateRuleGroupRequest): any => ({ ...obj, }); @@ -4955,6 +5438,9 @@ export interface UpdateWebACLRequest { } export namespace UpdateWebACLRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateWebACLRequest): any => ({ ...obj, }); @@ -4973,6 +5459,9 @@ export interface GetRuleGroupResponse { } export namespace GetRuleGroupResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetRuleGroupResponse): any => ({ ...obj, }); @@ -5089,6 +5578,9 @@ export interface WebACL { } export namespace WebACL { + /** + * @internal + */ export const filterSensitiveLog = (obj: WebACL): any => ({ ...obj, }); @@ -5102,6 +5594,9 @@ export interface GetWebACLForResourceResponse { } export namespace GetWebACLForResourceResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetWebACLForResourceResponse): any => ({ ...obj, }); @@ -5120,6 +5615,9 @@ export interface GetWebACLResponse { } export namespace GetWebACLResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetWebACLResponse): any => ({ ...obj, }); diff --git a/clients/client-wellarchitected/commands/AssociateLensesCommand.ts b/clients/client-wellarchitected/commands/AssociateLensesCommand.ts index 3132c0f59472..2ad2e9855e56 100644 --- a/clients/client-wellarchitected/commands/AssociateLensesCommand.ts +++ b/clients/client-wellarchitected/commands/AssociateLensesCommand.ts @@ -22,6 +22,20 @@ export interface AssociateLensesCommandOutput extends __MetadataBearer {} /** *

Associate a lens to a workload.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { WellArchitectedClient, AssociateLensesCommand } from "@aws-sdk/client-wellarchitected"; // ES Modules import + * // const { WellArchitectedClient, AssociateLensesCommand } = require("@aws-sdk/client-wellarchitected"); // CommonJS import + * const client = new WellArchitectedClient(config); + * const command = new AssociateLensesCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link AssociateLensesCommandInput} for command's `input` shape. + * @see {@link AssociateLensesCommandOutput} for command's `response` shape. + * @see {@link WellArchitectedClientResolvedConfig | config} for command's `input` shape. + * */ export class AssociateLensesCommand extends $Command< AssociateLensesCommandInput, diff --git a/clients/client-wellarchitected/commands/CreateMilestoneCommand.ts b/clients/client-wellarchitected/commands/CreateMilestoneCommand.ts index accb58de6dc2..6f3b9f9bf450 100644 --- a/clients/client-wellarchitected/commands/CreateMilestoneCommand.ts +++ b/clients/client-wellarchitected/commands/CreateMilestoneCommand.ts @@ -22,6 +22,20 @@ export interface CreateMilestoneCommandOutput extends CreateMilestoneOutput, __M /** *

Create a milestone for an existing workload.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { WellArchitectedClient, CreateMilestoneCommand } from "@aws-sdk/client-wellarchitected"; // ES Modules import + * // const { WellArchitectedClient, CreateMilestoneCommand } = require("@aws-sdk/client-wellarchitected"); // CommonJS import + * const client = new WellArchitectedClient(config); + * const command = new CreateMilestoneCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreateMilestoneCommandInput} for command's `input` shape. + * @see {@link CreateMilestoneCommandOutput} for command's `response` shape. + * @see {@link WellArchitectedClientResolvedConfig | config} for command's `input` shape. + * */ export class CreateMilestoneCommand extends $Command< CreateMilestoneCommandInput, diff --git a/clients/client-wellarchitected/commands/CreateWorkloadCommand.ts b/clients/client-wellarchitected/commands/CreateWorkloadCommand.ts index d0d08a37720a..4ed7ca48d962 100644 --- a/clients/client-wellarchitected/commands/CreateWorkloadCommand.ts +++ b/clients/client-wellarchitected/commands/CreateWorkloadCommand.ts @@ -26,6 +26,20 @@ export interface CreateWorkloadCommandOutput extends CreateWorkloadOutput, __Met * in the same AWS Region. Only the owner of a workload can delete it.

*

For more information, see Defining a Workload in the * AWS Well-Architected Tool User Guide.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { WellArchitectedClient, CreateWorkloadCommand } from "@aws-sdk/client-wellarchitected"; // ES Modules import + * // const { WellArchitectedClient, CreateWorkloadCommand } = require("@aws-sdk/client-wellarchitected"); // CommonJS import + * const client = new WellArchitectedClient(config); + * const command = new CreateWorkloadCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreateWorkloadCommandInput} for command's `input` shape. + * @see {@link CreateWorkloadCommandOutput} for command's `response` shape. + * @see {@link WellArchitectedClientResolvedConfig | config} for command's `input` shape. + * */ export class CreateWorkloadCommand extends $Command< CreateWorkloadCommandInput, diff --git a/clients/client-wellarchitected/commands/CreateWorkloadShareCommand.ts b/clients/client-wellarchitected/commands/CreateWorkloadShareCommand.ts index c03c9a2e0a9b..d3bbd1307695 100644 --- a/clients/client-wellarchitected/commands/CreateWorkloadShareCommand.ts +++ b/clients/client-wellarchitected/commands/CreateWorkloadShareCommand.ts @@ -27,6 +27,20 @@ export interface CreateWorkloadShareCommandOutput extends CreateWorkloadShareOut * deleted.

*

For more information, see Sharing a Workload in the * AWS Well-Architected Tool User Guide.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { WellArchitectedClient, CreateWorkloadShareCommand } from "@aws-sdk/client-wellarchitected"; // ES Modules import + * // const { WellArchitectedClient, CreateWorkloadShareCommand } = require("@aws-sdk/client-wellarchitected"); // CommonJS import + * const client = new WellArchitectedClient(config); + * const command = new CreateWorkloadShareCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreateWorkloadShareCommandInput} for command's `input` shape. + * @see {@link CreateWorkloadShareCommandOutput} for command's `response` shape. + * @see {@link WellArchitectedClientResolvedConfig | config} for command's `input` shape. + * */ export class CreateWorkloadShareCommand extends $Command< CreateWorkloadShareCommandInput, diff --git a/clients/client-wellarchitected/commands/DeleteWorkloadCommand.ts b/clients/client-wellarchitected/commands/DeleteWorkloadCommand.ts index f659ebe4bf79..49d5bfe94792 100644 --- a/clients/client-wellarchitected/commands/DeleteWorkloadCommand.ts +++ b/clients/client-wellarchitected/commands/DeleteWorkloadCommand.ts @@ -22,6 +22,20 @@ export interface DeleteWorkloadCommandOutput extends __MetadataBearer {} /** *

Delete an existing workload.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { WellArchitectedClient, DeleteWorkloadCommand } from "@aws-sdk/client-wellarchitected"; // ES Modules import + * // const { WellArchitectedClient, DeleteWorkloadCommand } = require("@aws-sdk/client-wellarchitected"); // CommonJS import + * const client = new WellArchitectedClient(config); + * const command = new DeleteWorkloadCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteWorkloadCommandInput} for command's `input` shape. + * @see {@link DeleteWorkloadCommandOutput} for command's `response` shape. + * @see {@link WellArchitectedClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteWorkloadCommand extends $Command< DeleteWorkloadCommandInput, diff --git a/clients/client-wellarchitected/commands/DeleteWorkloadShareCommand.ts b/clients/client-wellarchitected/commands/DeleteWorkloadShareCommand.ts index 9f3927174f71..6740449cd5dd 100644 --- a/clients/client-wellarchitected/commands/DeleteWorkloadShareCommand.ts +++ b/clients/client-wellarchitected/commands/DeleteWorkloadShareCommand.ts @@ -22,6 +22,20 @@ export interface DeleteWorkloadShareCommandOutput extends __MetadataBearer {} /** *

Delete a workload share.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { WellArchitectedClient, DeleteWorkloadShareCommand } from "@aws-sdk/client-wellarchitected"; // ES Modules import + * // const { WellArchitectedClient, DeleteWorkloadShareCommand } = require("@aws-sdk/client-wellarchitected"); // CommonJS import + * const client = new WellArchitectedClient(config); + * const command = new DeleteWorkloadShareCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteWorkloadShareCommandInput} for command's `input` shape. + * @see {@link DeleteWorkloadShareCommandOutput} for command's `response` shape. + * @see {@link WellArchitectedClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteWorkloadShareCommand extends $Command< DeleteWorkloadShareCommandInput, diff --git a/clients/client-wellarchitected/commands/DisassociateLensesCommand.ts b/clients/client-wellarchitected/commands/DisassociateLensesCommand.ts index 20281db8c441..441774087777 100644 --- a/clients/client-wellarchitected/commands/DisassociateLensesCommand.ts +++ b/clients/client-wellarchitected/commands/DisassociateLensesCommand.ts @@ -26,6 +26,20 @@ export interface DisassociateLensesCommandOutput extends __MetadataBearer {} *

The AWS Well-Architected Framework lens (wellarchitected) cannot be * removed from a workload.

* + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { WellArchitectedClient, DisassociateLensesCommand } from "@aws-sdk/client-wellarchitected"; // ES Modules import + * // const { WellArchitectedClient, DisassociateLensesCommand } = require("@aws-sdk/client-wellarchitected"); // CommonJS import + * const client = new WellArchitectedClient(config); + * const command = new DisassociateLensesCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DisassociateLensesCommandInput} for command's `input` shape. + * @see {@link DisassociateLensesCommandOutput} for command's `response` shape. + * @see {@link WellArchitectedClientResolvedConfig | config} for command's `input` shape. + * */ export class DisassociateLensesCommand extends $Command< DisassociateLensesCommandInput, diff --git a/clients/client-wellarchitected/commands/GetAnswerCommand.ts b/clients/client-wellarchitected/commands/GetAnswerCommand.ts index 30d5f098dc7f..00002c2ed950 100644 --- a/clients/client-wellarchitected/commands/GetAnswerCommand.ts +++ b/clients/client-wellarchitected/commands/GetAnswerCommand.ts @@ -22,6 +22,20 @@ export interface GetAnswerCommandOutput extends GetAnswerOutput, __MetadataBeare /** *

Get lens review.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { WellArchitectedClient, GetAnswerCommand } from "@aws-sdk/client-wellarchitected"; // ES Modules import + * // const { WellArchitectedClient, GetAnswerCommand } = require("@aws-sdk/client-wellarchitected"); // CommonJS import + * const client = new WellArchitectedClient(config); + * const command = new GetAnswerCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetAnswerCommandInput} for command's `input` shape. + * @see {@link GetAnswerCommandOutput} for command's `response` shape. + * @see {@link WellArchitectedClientResolvedConfig | config} for command's `input` shape. + * */ export class GetAnswerCommand extends $Command< GetAnswerCommandInput, diff --git a/clients/client-wellarchitected/commands/GetLensReviewCommand.ts b/clients/client-wellarchitected/commands/GetLensReviewCommand.ts index 09ca9e582d13..66311051303f 100644 --- a/clients/client-wellarchitected/commands/GetLensReviewCommand.ts +++ b/clients/client-wellarchitected/commands/GetLensReviewCommand.ts @@ -22,6 +22,20 @@ export interface GetLensReviewCommandOutput extends GetLensReviewOutput, __Metad /** *

Get lens review.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { WellArchitectedClient, GetLensReviewCommand } from "@aws-sdk/client-wellarchitected"; // ES Modules import + * // const { WellArchitectedClient, GetLensReviewCommand } = require("@aws-sdk/client-wellarchitected"); // CommonJS import + * const client = new WellArchitectedClient(config); + * const command = new GetLensReviewCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetLensReviewCommandInput} for command's `input` shape. + * @see {@link GetLensReviewCommandOutput} for command's `response` shape. + * @see {@link WellArchitectedClientResolvedConfig | config} for command's `input` shape. + * */ export class GetLensReviewCommand extends $Command< GetLensReviewCommandInput, diff --git a/clients/client-wellarchitected/commands/GetLensReviewReportCommand.ts b/clients/client-wellarchitected/commands/GetLensReviewReportCommand.ts index 134f5eaa6769..d90766b76232 100644 --- a/clients/client-wellarchitected/commands/GetLensReviewReportCommand.ts +++ b/clients/client-wellarchitected/commands/GetLensReviewReportCommand.ts @@ -22,6 +22,20 @@ export interface GetLensReviewReportCommandOutput extends GetLensReviewReportOut /** *

Get lens review report.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { WellArchitectedClient, GetLensReviewReportCommand } from "@aws-sdk/client-wellarchitected"; // ES Modules import + * // const { WellArchitectedClient, GetLensReviewReportCommand } = require("@aws-sdk/client-wellarchitected"); // CommonJS import + * const client = new WellArchitectedClient(config); + * const command = new GetLensReviewReportCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetLensReviewReportCommandInput} for command's `input` shape. + * @see {@link GetLensReviewReportCommandOutput} for command's `response` shape. + * @see {@link WellArchitectedClientResolvedConfig | config} for command's `input` shape. + * */ export class GetLensReviewReportCommand extends $Command< GetLensReviewReportCommandInput, diff --git a/clients/client-wellarchitected/commands/GetLensVersionDifferenceCommand.ts b/clients/client-wellarchitected/commands/GetLensVersionDifferenceCommand.ts index 2bf703ce628b..896179a0dddb 100644 --- a/clients/client-wellarchitected/commands/GetLensVersionDifferenceCommand.ts +++ b/clients/client-wellarchitected/commands/GetLensVersionDifferenceCommand.ts @@ -22,6 +22,20 @@ export interface GetLensVersionDifferenceCommandOutput extends GetLensVersionDif /** *

Get lens version differences.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { WellArchitectedClient, GetLensVersionDifferenceCommand } from "@aws-sdk/client-wellarchitected"; // ES Modules import + * // const { WellArchitectedClient, GetLensVersionDifferenceCommand } = require("@aws-sdk/client-wellarchitected"); // CommonJS import + * const client = new WellArchitectedClient(config); + * const command = new GetLensVersionDifferenceCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetLensVersionDifferenceCommandInput} for command's `input` shape. + * @see {@link GetLensVersionDifferenceCommandOutput} for command's `response` shape. + * @see {@link WellArchitectedClientResolvedConfig | config} for command's `input` shape. + * */ export class GetLensVersionDifferenceCommand extends $Command< GetLensVersionDifferenceCommandInput, diff --git a/clients/client-wellarchitected/commands/GetMilestoneCommand.ts b/clients/client-wellarchitected/commands/GetMilestoneCommand.ts index 9a73fca69a0f..a2556f8c749f 100644 --- a/clients/client-wellarchitected/commands/GetMilestoneCommand.ts +++ b/clients/client-wellarchitected/commands/GetMilestoneCommand.ts @@ -22,6 +22,20 @@ export interface GetMilestoneCommandOutput extends GetMilestoneOutput, __Metadat /** *

Get a milestone for an existing workload.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { WellArchitectedClient, GetMilestoneCommand } from "@aws-sdk/client-wellarchitected"; // ES Modules import + * // const { WellArchitectedClient, GetMilestoneCommand } = require("@aws-sdk/client-wellarchitected"); // CommonJS import + * const client = new WellArchitectedClient(config); + * const command = new GetMilestoneCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetMilestoneCommandInput} for command's `input` shape. + * @see {@link GetMilestoneCommandOutput} for command's `response` shape. + * @see {@link WellArchitectedClientResolvedConfig | config} for command's `input` shape. + * */ export class GetMilestoneCommand extends $Command< GetMilestoneCommandInput, diff --git a/clients/client-wellarchitected/commands/GetWorkloadCommand.ts b/clients/client-wellarchitected/commands/GetWorkloadCommand.ts index adfb8de9a77c..dd9b351f1bf6 100644 --- a/clients/client-wellarchitected/commands/GetWorkloadCommand.ts +++ b/clients/client-wellarchitected/commands/GetWorkloadCommand.ts @@ -22,6 +22,20 @@ export interface GetWorkloadCommandOutput extends GetWorkloadOutput, __MetadataB /** *

Get an existing workload.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { WellArchitectedClient, GetWorkloadCommand } from "@aws-sdk/client-wellarchitected"; // ES Modules import + * // const { WellArchitectedClient, GetWorkloadCommand } = require("@aws-sdk/client-wellarchitected"); // CommonJS import + * const client = new WellArchitectedClient(config); + * const command = new GetWorkloadCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetWorkloadCommandInput} for command's `input` shape. + * @see {@link GetWorkloadCommandOutput} for command's `response` shape. + * @see {@link WellArchitectedClientResolvedConfig | config} for command's `input` shape. + * */ export class GetWorkloadCommand extends $Command< GetWorkloadCommandInput, diff --git a/clients/client-wellarchitected/commands/ListAnswersCommand.ts b/clients/client-wellarchitected/commands/ListAnswersCommand.ts index 91ac30fe42ac..ebd6d9d3935e 100644 --- a/clients/client-wellarchitected/commands/ListAnswersCommand.ts +++ b/clients/client-wellarchitected/commands/ListAnswersCommand.ts @@ -22,6 +22,20 @@ export interface ListAnswersCommandOutput extends ListAnswersOutput, __MetadataB /** *

List of answers.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { WellArchitectedClient, ListAnswersCommand } from "@aws-sdk/client-wellarchitected"; // ES Modules import + * // const { WellArchitectedClient, ListAnswersCommand } = require("@aws-sdk/client-wellarchitected"); // CommonJS import + * const client = new WellArchitectedClient(config); + * const command = new ListAnswersCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListAnswersCommandInput} for command's `input` shape. + * @see {@link ListAnswersCommandOutput} for command's `response` shape. + * @see {@link WellArchitectedClientResolvedConfig | config} for command's `input` shape. + * */ export class ListAnswersCommand extends $Command< ListAnswersCommandInput, diff --git a/clients/client-wellarchitected/commands/ListLensReviewImprovementsCommand.ts b/clients/client-wellarchitected/commands/ListLensReviewImprovementsCommand.ts index b7db2a3fdec2..f3f754f1effe 100644 --- a/clients/client-wellarchitected/commands/ListLensReviewImprovementsCommand.ts +++ b/clients/client-wellarchitected/commands/ListLensReviewImprovementsCommand.ts @@ -22,6 +22,20 @@ export interface ListLensReviewImprovementsCommandOutput extends ListLensReviewI /** *

List lens review improvements.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { WellArchitectedClient, ListLensReviewImprovementsCommand } from "@aws-sdk/client-wellarchitected"; // ES Modules import + * // const { WellArchitectedClient, ListLensReviewImprovementsCommand } = require("@aws-sdk/client-wellarchitected"); // CommonJS import + * const client = new WellArchitectedClient(config); + * const command = new ListLensReviewImprovementsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListLensReviewImprovementsCommandInput} for command's `input` shape. + * @see {@link ListLensReviewImprovementsCommandOutput} for command's `response` shape. + * @see {@link WellArchitectedClientResolvedConfig | config} for command's `input` shape. + * */ export class ListLensReviewImprovementsCommand extends $Command< ListLensReviewImprovementsCommandInput, diff --git a/clients/client-wellarchitected/commands/ListLensReviewsCommand.ts b/clients/client-wellarchitected/commands/ListLensReviewsCommand.ts index 704f6d8834ba..725991a68a4e 100644 --- a/clients/client-wellarchitected/commands/ListLensReviewsCommand.ts +++ b/clients/client-wellarchitected/commands/ListLensReviewsCommand.ts @@ -22,6 +22,20 @@ export interface ListLensReviewsCommandOutput extends ListLensReviewsOutput, __M /** *

List lens reviews.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { WellArchitectedClient, ListLensReviewsCommand } from "@aws-sdk/client-wellarchitected"; // ES Modules import + * // const { WellArchitectedClient, ListLensReviewsCommand } = require("@aws-sdk/client-wellarchitected"); // CommonJS import + * const client = new WellArchitectedClient(config); + * const command = new ListLensReviewsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListLensReviewsCommandInput} for command's `input` shape. + * @see {@link ListLensReviewsCommandOutput} for command's `response` shape. + * @see {@link WellArchitectedClientResolvedConfig | config} for command's `input` shape. + * */ export class ListLensReviewsCommand extends $Command< ListLensReviewsCommandInput, diff --git a/clients/client-wellarchitected/commands/ListLensesCommand.ts b/clients/client-wellarchitected/commands/ListLensesCommand.ts index 5db39b504d84..c947815dc9cc 100644 --- a/clients/client-wellarchitected/commands/ListLensesCommand.ts +++ b/clients/client-wellarchitected/commands/ListLensesCommand.ts @@ -22,6 +22,20 @@ export interface ListLensesCommandOutput extends ListLensesOutput, __MetadataBea /** *

List the available lenses.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { WellArchitectedClient, ListLensesCommand } from "@aws-sdk/client-wellarchitected"; // ES Modules import + * // const { WellArchitectedClient, ListLensesCommand } = require("@aws-sdk/client-wellarchitected"); // CommonJS import + * const client = new WellArchitectedClient(config); + * const command = new ListLensesCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListLensesCommandInput} for command's `input` shape. + * @see {@link ListLensesCommandOutput} for command's `response` shape. + * @see {@link WellArchitectedClientResolvedConfig | config} for command's `input` shape. + * */ export class ListLensesCommand extends $Command< ListLensesCommandInput, diff --git a/clients/client-wellarchitected/commands/ListMilestonesCommand.ts b/clients/client-wellarchitected/commands/ListMilestonesCommand.ts index d550c318f7e4..d5d3238de933 100644 --- a/clients/client-wellarchitected/commands/ListMilestonesCommand.ts +++ b/clients/client-wellarchitected/commands/ListMilestonesCommand.ts @@ -22,6 +22,20 @@ export interface ListMilestonesCommandOutput extends ListMilestonesOutput, __Met /** *

List all milestones for an existing workload.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { WellArchitectedClient, ListMilestonesCommand } from "@aws-sdk/client-wellarchitected"; // ES Modules import + * // const { WellArchitectedClient, ListMilestonesCommand } = require("@aws-sdk/client-wellarchitected"); // CommonJS import + * const client = new WellArchitectedClient(config); + * const command = new ListMilestonesCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListMilestonesCommandInput} for command's `input` shape. + * @see {@link ListMilestonesCommandOutput} for command's `response` shape. + * @see {@link WellArchitectedClientResolvedConfig | config} for command's `input` shape. + * */ export class ListMilestonesCommand extends $Command< ListMilestonesCommandInput, diff --git a/clients/client-wellarchitected/commands/ListNotificationsCommand.ts b/clients/client-wellarchitected/commands/ListNotificationsCommand.ts index 66336e22e854..7125dc0cc896 100644 --- a/clients/client-wellarchitected/commands/ListNotificationsCommand.ts +++ b/clients/client-wellarchitected/commands/ListNotificationsCommand.ts @@ -22,6 +22,20 @@ export interface ListNotificationsCommandOutput extends ListNotificationsOutput, /** *

List lens notifications.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { WellArchitectedClient, ListNotificationsCommand } from "@aws-sdk/client-wellarchitected"; // ES Modules import + * // const { WellArchitectedClient, ListNotificationsCommand } = require("@aws-sdk/client-wellarchitected"); // CommonJS import + * const client = new WellArchitectedClient(config); + * const command = new ListNotificationsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListNotificationsCommandInput} for command's `input` shape. + * @see {@link ListNotificationsCommandOutput} for command's `response` shape. + * @see {@link WellArchitectedClientResolvedConfig | config} for command's `input` shape. + * */ export class ListNotificationsCommand extends $Command< ListNotificationsCommandInput, diff --git a/clients/client-wellarchitected/commands/ListShareInvitationsCommand.ts b/clients/client-wellarchitected/commands/ListShareInvitationsCommand.ts index eba5856400c2..242984e5704a 100644 --- a/clients/client-wellarchitected/commands/ListShareInvitationsCommand.ts +++ b/clients/client-wellarchitected/commands/ListShareInvitationsCommand.ts @@ -22,6 +22,20 @@ export interface ListShareInvitationsCommandOutput extends ListShareInvitationsO /** *

List the workload invitations.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { WellArchitectedClient, ListShareInvitationsCommand } from "@aws-sdk/client-wellarchitected"; // ES Modules import + * // const { WellArchitectedClient, ListShareInvitationsCommand } = require("@aws-sdk/client-wellarchitected"); // CommonJS import + * const client = new WellArchitectedClient(config); + * const command = new ListShareInvitationsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListShareInvitationsCommandInput} for command's `input` shape. + * @see {@link ListShareInvitationsCommandOutput} for command's `response` shape. + * @see {@link WellArchitectedClientResolvedConfig | config} for command's `input` shape. + * */ export class ListShareInvitationsCommand extends $Command< ListShareInvitationsCommandInput, diff --git a/clients/client-wellarchitected/commands/ListTagsForResourceCommand.ts b/clients/client-wellarchitected/commands/ListTagsForResourceCommand.ts index d4594b56f2f5..55dece730501 100644 --- a/clients/client-wellarchitected/commands/ListTagsForResourceCommand.ts +++ b/clients/client-wellarchitected/commands/ListTagsForResourceCommand.ts @@ -22,6 +22,20 @@ export interface ListTagsForResourceCommandOutput extends ListTagsForResourceOut /** *

List the tags for a resource.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { WellArchitectedClient, ListTagsForResourceCommand } from "@aws-sdk/client-wellarchitected"; // ES Modules import + * // const { WellArchitectedClient, ListTagsForResourceCommand } = require("@aws-sdk/client-wellarchitected"); // CommonJS import + * const client = new WellArchitectedClient(config); + * const command = new ListTagsForResourceCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListTagsForResourceCommandInput} for command's `input` shape. + * @see {@link ListTagsForResourceCommandOutput} for command's `response` shape. + * @see {@link WellArchitectedClientResolvedConfig | config} for command's `input` shape. + * */ export class ListTagsForResourceCommand extends $Command< ListTagsForResourceCommandInput, diff --git a/clients/client-wellarchitected/commands/ListWorkloadSharesCommand.ts b/clients/client-wellarchitected/commands/ListWorkloadSharesCommand.ts index 3c984eaf37f5..5911483c5142 100644 --- a/clients/client-wellarchitected/commands/ListWorkloadSharesCommand.ts +++ b/clients/client-wellarchitected/commands/ListWorkloadSharesCommand.ts @@ -22,6 +22,20 @@ export interface ListWorkloadSharesCommandOutput extends ListWorkloadSharesOutpu /** *

List the workload shares associated with the workload.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { WellArchitectedClient, ListWorkloadSharesCommand } from "@aws-sdk/client-wellarchitected"; // ES Modules import + * // const { WellArchitectedClient, ListWorkloadSharesCommand } = require("@aws-sdk/client-wellarchitected"); // CommonJS import + * const client = new WellArchitectedClient(config); + * const command = new ListWorkloadSharesCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListWorkloadSharesCommandInput} for command's `input` shape. + * @see {@link ListWorkloadSharesCommandOutput} for command's `response` shape. + * @see {@link WellArchitectedClientResolvedConfig | config} for command's `input` shape. + * */ export class ListWorkloadSharesCommand extends $Command< ListWorkloadSharesCommandInput, diff --git a/clients/client-wellarchitected/commands/ListWorkloadsCommand.ts b/clients/client-wellarchitected/commands/ListWorkloadsCommand.ts index 56a2fc15a9ea..8482b1c19bc3 100644 --- a/clients/client-wellarchitected/commands/ListWorkloadsCommand.ts +++ b/clients/client-wellarchitected/commands/ListWorkloadsCommand.ts @@ -22,6 +22,20 @@ export interface ListWorkloadsCommandOutput extends ListWorkloadsOutput, __Metad /** *

List workloads. Paginated.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { WellArchitectedClient, ListWorkloadsCommand } from "@aws-sdk/client-wellarchitected"; // ES Modules import + * // const { WellArchitectedClient, ListWorkloadsCommand } = require("@aws-sdk/client-wellarchitected"); // CommonJS import + * const client = new WellArchitectedClient(config); + * const command = new ListWorkloadsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListWorkloadsCommandInput} for command's `input` shape. + * @see {@link ListWorkloadsCommandOutput} for command's `response` shape. + * @see {@link WellArchitectedClientResolvedConfig | config} for command's `input` shape. + * */ export class ListWorkloadsCommand extends $Command< ListWorkloadsCommandInput, diff --git a/clients/client-wellarchitected/commands/TagResourceCommand.ts b/clients/client-wellarchitected/commands/TagResourceCommand.ts index 6edaa76108b1..df693a96efa7 100644 --- a/clients/client-wellarchitected/commands/TagResourceCommand.ts +++ b/clients/client-wellarchitected/commands/TagResourceCommand.ts @@ -22,6 +22,20 @@ export interface TagResourceCommandOutput extends TagResourceOutput, __MetadataB /** *

Adds one or more tags to the specified resource.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { WellArchitectedClient, TagResourceCommand } from "@aws-sdk/client-wellarchitected"; // ES Modules import + * // const { WellArchitectedClient, TagResourceCommand } = require("@aws-sdk/client-wellarchitected"); // CommonJS import + * const client = new WellArchitectedClient(config); + * const command = new TagResourceCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link TagResourceCommandInput} for command's `input` shape. + * @see {@link TagResourceCommandOutput} for command's `response` shape. + * @see {@link WellArchitectedClientResolvedConfig | config} for command's `input` shape. + * */ export class TagResourceCommand extends $Command< TagResourceCommandInput, diff --git a/clients/client-wellarchitected/commands/UntagResourceCommand.ts b/clients/client-wellarchitected/commands/UntagResourceCommand.ts index 5959802afb0b..12545ad95771 100644 --- a/clients/client-wellarchitected/commands/UntagResourceCommand.ts +++ b/clients/client-wellarchitected/commands/UntagResourceCommand.ts @@ -22,6 +22,20 @@ export interface UntagResourceCommandOutput extends UntagResourceOutput, __Metad /** *

Deletes specified tags from a resource.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { WellArchitectedClient, UntagResourceCommand } from "@aws-sdk/client-wellarchitected"; // ES Modules import + * // const { WellArchitectedClient, UntagResourceCommand } = require("@aws-sdk/client-wellarchitected"); // CommonJS import + * const client = new WellArchitectedClient(config); + * const command = new UntagResourceCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link UntagResourceCommandInput} for command's `input` shape. + * @see {@link UntagResourceCommandOutput} for command's `response` shape. + * @see {@link WellArchitectedClientResolvedConfig | config} for command's `input` shape. + * */ export class UntagResourceCommand extends $Command< UntagResourceCommandInput, diff --git a/clients/client-wellarchitected/commands/UpdateAnswerCommand.ts b/clients/client-wellarchitected/commands/UpdateAnswerCommand.ts index a4bc9d5b37df..e77569fad1b7 100644 --- a/clients/client-wellarchitected/commands/UpdateAnswerCommand.ts +++ b/clients/client-wellarchitected/commands/UpdateAnswerCommand.ts @@ -22,6 +22,20 @@ export interface UpdateAnswerCommandOutput extends UpdateAnswerOutput, __Metadat /** *

Update the answer to a specific question in a workload review.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { WellArchitectedClient, UpdateAnswerCommand } from "@aws-sdk/client-wellarchitected"; // ES Modules import + * // const { WellArchitectedClient, UpdateAnswerCommand } = require("@aws-sdk/client-wellarchitected"); // CommonJS import + * const client = new WellArchitectedClient(config); + * const command = new UpdateAnswerCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link UpdateAnswerCommandInput} for command's `input` shape. + * @see {@link UpdateAnswerCommandOutput} for command's `response` shape. + * @see {@link WellArchitectedClientResolvedConfig | config} for command's `input` shape. + * */ export class UpdateAnswerCommand extends $Command< UpdateAnswerCommandInput, diff --git a/clients/client-wellarchitected/commands/UpdateLensReviewCommand.ts b/clients/client-wellarchitected/commands/UpdateLensReviewCommand.ts index 42d639c5fa1e..9d63ff2099fb 100644 --- a/clients/client-wellarchitected/commands/UpdateLensReviewCommand.ts +++ b/clients/client-wellarchitected/commands/UpdateLensReviewCommand.ts @@ -22,6 +22,20 @@ export interface UpdateLensReviewCommandOutput extends UpdateLensReviewOutput, _ /** *

Update lens review.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { WellArchitectedClient, UpdateLensReviewCommand } from "@aws-sdk/client-wellarchitected"; // ES Modules import + * // const { WellArchitectedClient, UpdateLensReviewCommand } = require("@aws-sdk/client-wellarchitected"); // CommonJS import + * const client = new WellArchitectedClient(config); + * const command = new UpdateLensReviewCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link UpdateLensReviewCommandInput} for command's `input` shape. + * @see {@link UpdateLensReviewCommandOutput} for command's `response` shape. + * @see {@link WellArchitectedClientResolvedConfig | config} for command's `input` shape. + * */ export class UpdateLensReviewCommand extends $Command< UpdateLensReviewCommandInput, diff --git a/clients/client-wellarchitected/commands/UpdateShareInvitationCommand.ts b/clients/client-wellarchitected/commands/UpdateShareInvitationCommand.ts index 021ba9aa28d6..0fa6a76a6904 100644 --- a/clients/client-wellarchitected/commands/UpdateShareInvitationCommand.ts +++ b/clients/client-wellarchitected/commands/UpdateShareInvitationCommand.ts @@ -22,6 +22,20 @@ export interface UpdateShareInvitationCommandOutput extends UpdateShareInvitatio /** *

Update a workload invitation.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { WellArchitectedClient, UpdateShareInvitationCommand } from "@aws-sdk/client-wellarchitected"; // ES Modules import + * // const { WellArchitectedClient, UpdateShareInvitationCommand } = require("@aws-sdk/client-wellarchitected"); // CommonJS import + * const client = new WellArchitectedClient(config); + * const command = new UpdateShareInvitationCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link UpdateShareInvitationCommandInput} for command's `input` shape. + * @see {@link UpdateShareInvitationCommandOutput} for command's `response` shape. + * @see {@link WellArchitectedClientResolvedConfig | config} for command's `input` shape. + * */ export class UpdateShareInvitationCommand extends $Command< UpdateShareInvitationCommandInput, diff --git a/clients/client-wellarchitected/commands/UpdateWorkloadCommand.ts b/clients/client-wellarchitected/commands/UpdateWorkloadCommand.ts index a50543804202..a27c837c84dd 100644 --- a/clients/client-wellarchitected/commands/UpdateWorkloadCommand.ts +++ b/clients/client-wellarchitected/commands/UpdateWorkloadCommand.ts @@ -22,6 +22,20 @@ export interface UpdateWorkloadCommandOutput extends UpdateWorkloadOutput, __Met /** *

Update an existing workload.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { WellArchitectedClient, UpdateWorkloadCommand } from "@aws-sdk/client-wellarchitected"; // ES Modules import + * // const { WellArchitectedClient, UpdateWorkloadCommand } = require("@aws-sdk/client-wellarchitected"); // CommonJS import + * const client = new WellArchitectedClient(config); + * const command = new UpdateWorkloadCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link UpdateWorkloadCommandInput} for command's `input` shape. + * @see {@link UpdateWorkloadCommandOutput} for command's `response` shape. + * @see {@link WellArchitectedClientResolvedConfig | config} for command's `input` shape. + * */ export class UpdateWorkloadCommand extends $Command< UpdateWorkloadCommandInput, diff --git a/clients/client-wellarchitected/commands/UpdateWorkloadShareCommand.ts b/clients/client-wellarchitected/commands/UpdateWorkloadShareCommand.ts index 01c677e3a788..24ea7b5f859b 100644 --- a/clients/client-wellarchitected/commands/UpdateWorkloadShareCommand.ts +++ b/clients/client-wellarchitected/commands/UpdateWorkloadShareCommand.ts @@ -22,6 +22,20 @@ export interface UpdateWorkloadShareCommandOutput extends UpdateWorkloadShareOut /** *

Update a workload share.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { WellArchitectedClient, UpdateWorkloadShareCommand } from "@aws-sdk/client-wellarchitected"; // ES Modules import + * // const { WellArchitectedClient, UpdateWorkloadShareCommand } = require("@aws-sdk/client-wellarchitected"); // CommonJS import + * const client = new WellArchitectedClient(config); + * const command = new UpdateWorkloadShareCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link UpdateWorkloadShareCommandInput} for command's `input` shape. + * @see {@link UpdateWorkloadShareCommandOutput} for command's `response` shape. + * @see {@link WellArchitectedClientResolvedConfig | config} for command's `input` shape. + * */ export class UpdateWorkloadShareCommand extends $Command< UpdateWorkloadShareCommandInput, diff --git a/clients/client-wellarchitected/commands/UpgradeLensReviewCommand.ts b/clients/client-wellarchitected/commands/UpgradeLensReviewCommand.ts index baf4fe681f1d..46fbe147f3e8 100644 --- a/clients/client-wellarchitected/commands/UpgradeLensReviewCommand.ts +++ b/clients/client-wellarchitected/commands/UpgradeLensReviewCommand.ts @@ -22,6 +22,20 @@ export interface UpgradeLensReviewCommandOutput extends __MetadataBearer {} /** *

Upgrade lens review.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { WellArchitectedClient, UpgradeLensReviewCommand } from "@aws-sdk/client-wellarchitected"; // ES Modules import + * // const { WellArchitectedClient, UpgradeLensReviewCommand } = require("@aws-sdk/client-wellarchitected"); // CommonJS import + * const client = new WellArchitectedClient(config); + * const command = new UpgradeLensReviewCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link UpgradeLensReviewCommandInput} for command's `input` shape. + * @see {@link UpgradeLensReviewCommandOutput} for command's `response` shape. + * @see {@link WellArchitectedClientResolvedConfig | config} for command's `input` shape. + * */ export class UpgradeLensReviewCommand extends $Command< UpgradeLensReviewCommandInput, diff --git a/clients/client-wellarchitected/models/models_0.ts b/clients/client-wellarchitected/models/models_0.ts index abb27c41a062..eafad1134404 100644 --- a/clients/client-wellarchitected/models/models_0.ts +++ b/clients/client-wellarchitected/models/models_0.ts @@ -14,6 +14,9 @@ export interface AccessDeniedException extends __SmithyException, $MetadataBeare } export namespace AccessDeniedException { + /** + * @internal + */ export const filterSensitiveLog = (obj: AccessDeniedException): any => ({ ...obj, }); @@ -40,6 +43,9 @@ export interface Choice { } export namespace Choice { + /** + * @internal + */ export const filterSensitiveLog = (obj: Choice): any => ({ ...obj, }); @@ -116,6 +122,9 @@ export interface Answer { } export namespace Answer { + /** + * @internal + */ export const filterSensitiveLog = (obj: Answer): any => ({ ...obj, }); @@ -164,6 +173,9 @@ export interface AnswerSummary { } export namespace AnswerSummary { + /** + * @internal + */ export const filterSensitiveLog = (obj: AnswerSummary): any => ({ ...obj, }); @@ -186,6 +198,9 @@ export interface AssociateLensesInput { } export namespace AssociateLensesInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: AssociateLensesInput): any => ({ ...obj, }); @@ -214,6 +229,9 @@ export interface ConflictException extends __SmithyException, $MetadataBearer { } export namespace ConflictException { + /** + * @internal + */ export const filterSensitiveLog = (obj: ConflictException): any => ({ ...obj, }); @@ -232,6 +250,9 @@ export interface InternalServerException extends __SmithyException, $MetadataBea } export namespace InternalServerException { + /** + * @internal + */ export const filterSensitiveLog = (obj: InternalServerException): any => ({ ...obj, }); @@ -260,6 +281,9 @@ export interface ResourceNotFoundException extends __SmithyException, $MetadataB } export namespace ResourceNotFoundException { + /** + * @internal + */ export const filterSensitiveLog = (obj: ResourceNotFoundException): any => ({ ...obj, }); @@ -288,6 +312,9 @@ export interface ThrottlingException extends __SmithyException, $MetadataBearer } export namespace ThrottlingException { + /** + * @internal + */ export const filterSensitiveLog = (obj: ThrottlingException): any => ({ ...obj, }); @@ -309,6 +336,9 @@ export interface ValidationExceptionField { } export namespace ValidationExceptionField { + /** + * @internal + */ export const filterSensitiveLog = (obj: ValidationExceptionField): any => ({ ...obj, }); @@ -344,6 +374,9 @@ export interface ValidationException extends __SmithyException, $MetadataBearer } export namespace ValidationException { + /** + * @internal + */ export const filterSensitiveLog = (obj: ValidationException): any => ({ ...obj, }); @@ -380,6 +413,9 @@ export interface CreateMilestoneInput { } export namespace CreateMilestoneInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateMilestoneInput): any => ({ ...obj, }); @@ -402,6 +438,9 @@ export interface CreateMilestoneOutput { } export namespace CreateMilestoneOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateMilestoneOutput): any => ({ ...obj, }); @@ -440,6 +479,9 @@ export interface ServiceQuotaExceededException extends __SmithyException, $Metad } export namespace ServiceQuotaExceededException { + /** + * @internal + */ export const filterSensitiveLog = (obj: ServiceQuotaExceededException): any => ({ ...obj, }); @@ -683,6 +725,9 @@ export interface CreateWorkloadInput { } export namespace CreateWorkloadInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateWorkloadInput): any => ({ ...obj, }); @@ -704,6 +749,9 @@ export interface CreateWorkloadOutput { } export namespace CreateWorkloadOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateWorkloadOutput): any => ({ ...obj, }); @@ -749,6 +797,9 @@ export interface CreateWorkloadShareInput { } export namespace CreateWorkloadShareInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateWorkloadShareInput): any => ({ ...obj, }); @@ -770,6 +821,9 @@ export interface CreateWorkloadShareOutput { } export namespace CreateWorkloadShareOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateWorkloadShareOutput): any => ({ ...obj, }); @@ -800,6 +854,9 @@ export interface DeleteWorkloadInput { } export namespace DeleteWorkloadInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteWorkloadInput): any => ({ ...obj, }); @@ -835,6 +892,9 @@ export interface DeleteWorkloadShareInput { } export namespace DeleteWorkloadShareInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteWorkloadShareInput): any => ({ ...obj, }); @@ -863,6 +923,9 @@ export interface DisassociateLensesInput { } export namespace DisassociateLensesInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: DisassociateLensesInput): any => ({ ...obj, }); @@ -896,6 +959,9 @@ export interface GetAnswerInput { } export namespace GetAnswerInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetAnswerInput): any => ({ ...obj, }); @@ -929,6 +995,9 @@ export interface GetAnswerOutput { } export namespace GetAnswerOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetAnswerOutput): any => ({ ...obj, }); @@ -957,6 +1026,9 @@ export interface GetLensReviewInput { } export namespace GetLensReviewInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetLensReviewInput): any => ({ ...obj, }); @@ -995,6 +1067,9 @@ export interface PillarReviewSummary { } export namespace PillarReviewSummary { + /** + * @internal + */ export const filterSensitiveLog = (obj: PillarReviewSummary): any => ({ ...obj, }); @@ -1052,6 +1127,9 @@ export interface LensReview { } export namespace LensReview { + /** + * @internal + */ export const filterSensitiveLog = (obj: LensReview): any => ({ ...obj, }); @@ -1079,6 +1157,9 @@ export interface GetLensReviewOutput { } export namespace GetLensReviewOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetLensReviewOutput): any => ({ ...obj, }); @@ -1107,6 +1188,9 @@ export interface GetLensReviewReportInput { } export namespace GetLensReviewReportInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetLensReviewReportInput): any => ({ ...obj, }); @@ -1130,6 +1214,9 @@ export interface LensReviewReport { } export namespace LensReviewReport { + /** + * @internal + */ export const filterSensitiveLog = (obj: LensReviewReport): any => ({ ...obj, }); @@ -1157,6 +1244,9 @@ export interface GetLensReviewReportOutput { } export namespace GetLensReviewReportOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetLensReviewReportOutput): any => ({ ...obj, }); @@ -1176,6 +1266,9 @@ export interface GetLensVersionDifferenceInput { } export namespace GetLensVersionDifferenceInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetLensVersionDifferenceInput): any => ({ ...obj, }); @@ -1202,6 +1295,9 @@ export interface QuestionDifference { } export namespace QuestionDifference { + /** + * @internal + */ export const filterSensitiveLog = (obj: QuestionDifference): any => ({ ...obj, }); @@ -1229,6 +1325,9 @@ export interface PillarDifference { } export namespace PillarDifference { + /** + * @internal + */ export const filterSensitiveLog = (obj: PillarDifference): any => ({ ...obj, }); @@ -1245,6 +1344,9 @@ export interface VersionDifferences { } export namespace VersionDifferences { + /** + * @internal + */ export const filterSensitiveLog = (obj: VersionDifferences): any => ({ ...obj, }); @@ -1274,6 +1376,9 @@ export interface GetLensVersionDifferenceOutput { } export namespace GetLensVersionDifferenceOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetLensVersionDifferenceOutput): any => ({ ...obj, }); @@ -1296,6 +1401,9 @@ export interface GetMilestoneInput { } export namespace GetMilestoneInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetMilestoneInput): any => ({ ...obj, }); @@ -1577,6 +1685,9 @@ export interface Workload { } export namespace Workload { + /** + * @internal + */ export const filterSensitiveLog = (obj: Workload): any => ({ ...obj, }); @@ -1610,6 +1721,9 @@ export interface Milestone { } export namespace Milestone { + /** + * @internal + */ export const filterSensitiveLog = (obj: Milestone): any => ({ ...obj, }); @@ -1631,6 +1745,9 @@ export interface GetMilestoneOutput { } export namespace GetMilestoneOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetMilestoneOutput): any => ({ ...obj, }); @@ -1647,6 +1764,9 @@ export interface GetWorkloadInput { } export namespace GetWorkloadInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetWorkloadInput): any => ({ ...obj, }); @@ -1663,6 +1783,9 @@ export interface GetWorkloadOutput { } export namespace GetWorkloadOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetWorkloadOutput): any => ({ ...obj, }); @@ -1700,6 +1823,9 @@ export interface ImprovementSummary { } export namespace ImprovementSummary { + /** + * @internal + */ export const filterSensitiveLog = (obj: ImprovementSummary): any => ({ ...obj, }); @@ -1742,6 +1868,9 @@ export interface LensReviewSummary { } export namespace LensReviewSummary { + /** + * @internal + */ export const filterSensitiveLog = (obj: LensReviewSummary): any => ({ ...obj, }); @@ -1774,6 +1903,9 @@ export interface LensSummary { } export namespace LensSummary { + /** + * @internal + */ export const filterSensitiveLog = (obj: LensSummary): any => ({ ...obj, }); @@ -1813,6 +1945,9 @@ export interface LensUpgradeSummary { } export namespace LensUpgradeSummary { + /** + * @internal + */ export const filterSensitiveLog = (obj: LensUpgradeSummary): any => ({ ...obj, }); @@ -1857,6 +1992,9 @@ export interface ListAnswersInput { } export namespace ListAnswersInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListAnswersInput): any => ({ ...obj, }); @@ -1895,6 +2033,9 @@ export interface ListAnswersOutput { } export namespace ListAnswersOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListAnswersOutput): any => ({ ...obj, }); @@ -1916,6 +2057,9 @@ export interface ListLensesInput { } export namespace ListLensesInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListLensesInput): any => ({ ...obj, }); @@ -1937,6 +2081,9 @@ export interface ListLensesOutput { } export namespace ListLensesOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListLensesOutput): any => ({ ...obj, }); @@ -1981,6 +2128,9 @@ export interface ListLensReviewImprovementsInput { } export namespace ListLensReviewImprovementsInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListLensReviewImprovementsInput): any => ({ ...obj, }); @@ -2019,6 +2169,9 @@ export interface ListLensReviewImprovementsOutput { } export namespace ListLensReviewImprovementsOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListLensReviewImprovementsOutput): any => ({ ...obj, }); @@ -2051,6 +2204,9 @@ export interface ListLensReviewsInput { } export namespace ListLensReviewsInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListLensReviewsInput): any => ({ ...obj, }); @@ -2083,6 +2239,9 @@ export interface ListLensReviewsOutput { } export namespace ListLensReviewsOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListLensReviewsOutput): any => ({ ...obj, }); @@ -2109,6 +2268,9 @@ export interface ListMilestonesInput { } export namespace ListMilestonesInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListMilestonesInput): any => ({ ...obj, }); @@ -2162,6 +2324,9 @@ export interface WorkloadSummary { } export namespace WorkloadSummary { + /** + * @internal + */ export const filterSensitiveLog = (obj: WorkloadSummary): any => ({ ...obj, }); @@ -2195,6 +2360,9 @@ export interface MilestoneSummary { } export namespace MilestoneSummary { + /** + * @internal + */ export const filterSensitiveLog = (obj: MilestoneSummary): any => ({ ...obj, }); @@ -2221,6 +2389,9 @@ export interface ListMilestonesOutput { } export namespace ListMilestonesOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListMilestonesOutput): any => ({ ...obj, }); @@ -2244,6 +2415,9 @@ export interface ListNotificationsInput { } export namespace ListNotificationsInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListNotificationsInput): any => ({ ...obj, }); @@ -2270,6 +2444,9 @@ export interface NotificationSummary { } export namespace NotificationSummary { + /** + * @internal + */ export const filterSensitiveLog = (obj: NotificationSummary): any => ({ ...obj, }); @@ -2288,6 +2465,9 @@ export interface ListNotificationsOutput { } export namespace ListNotificationsOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListNotificationsOutput): any => ({ ...obj, }); @@ -2315,6 +2495,9 @@ export interface ListShareInvitationsInput { } export namespace ListShareInvitationsInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListShareInvitationsInput): any => ({ ...obj, }); @@ -2358,6 +2541,9 @@ export interface ShareInvitationSummary { } export namespace ShareInvitationSummary { + /** + * @internal + */ export const filterSensitiveLog = (obj: ShareInvitationSummary): any => ({ ...obj, }); @@ -2379,6 +2565,9 @@ export interface ListShareInvitationsOutput { } export namespace ListShareInvitationsOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListShareInvitationsOutput): any => ({ ...obj, }); @@ -2392,6 +2581,9 @@ export interface ListTagsForResourceInput { } export namespace ListTagsForResourceInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListTagsForResourceInput): any => ({ ...obj, }); @@ -2405,6 +2597,9 @@ export interface ListTagsForResourceOutput { } export namespace ListTagsForResourceOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListTagsForResourceOutput): any => ({ ...obj, }); @@ -2432,6 +2627,9 @@ export interface ListWorkloadsInput { } export namespace ListWorkloadsInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListWorkloadsInput): any => ({ ...obj, }); @@ -2453,6 +2651,9 @@ export interface ListWorkloadsOutput { } export namespace ListWorkloadsOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListWorkloadsOutput): any => ({ ...obj, }); @@ -2484,6 +2685,9 @@ export interface ListWorkloadSharesInput { } export namespace ListWorkloadSharesInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListWorkloadSharesInput): any => ({ ...obj, }); @@ -2523,6 +2727,9 @@ export interface WorkloadShareSummary { } export namespace WorkloadShareSummary { + /** + * @internal + */ export const filterSensitiveLog = (obj: WorkloadShareSummary): any => ({ ...obj, }); @@ -2549,6 +2756,9 @@ export interface ListWorkloadSharesOutput { } export namespace ListWorkloadSharesOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListWorkloadSharesOutput): any => ({ ...obj, }); @@ -2570,6 +2780,9 @@ export interface ShareInvitation { } export namespace ShareInvitation { + /** + * @internal + */ export const filterSensitiveLog = (obj: ShareInvitation): any => ({ ...obj, }); @@ -2593,6 +2806,9 @@ export interface TagResourceInput { } export namespace TagResourceInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: TagResourceInput): any => ({ ...obj, }); @@ -2601,6 +2817,9 @@ export namespace TagResourceInput { export interface TagResourceOutput {} export namespace TagResourceOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: TagResourceOutput): any => ({ ...obj, }); @@ -2619,6 +2838,9 @@ export interface UntagResourceInput { } export namespace UntagResourceInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: UntagResourceInput): any => ({ ...obj, }); @@ -2627,6 +2849,9 @@ export namespace UntagResourceInput { export interface UntagResourceOutput {} export namespace UntagResourceOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: UntagResourceOutput): any => ({ ...obj, }); @@ -2670,6 +2895,9 @@ export interface UpdateAnswerInput { } export namespace UpdateAnswerInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateAnswerInput): any => ({ ...obj, }); @@ -2697,6 +2925,9 @@ export interface UpdateAnswerOutput { } export namespace UpdateAnswerOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateAnswerOutput): any => ({ ...obj, }); @@ -2729,6 +2960,9 @@ export interface UpdateLensReviewInput { } export namespace UpdateLensReviewInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateLensReviewInput): any => ({ ...obj, }); @@ -2750,6 +2984,9 @@ export interface UpdateLensReviewOutput { } export namespace UpdateLensReviewOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateLensReviewOutput): any => ({ ...obj, }); @@ -2771,6 +3008,9 @@ export interface UpdateShareInvitationInput { } export namespace UpdateShareInvitationInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateShareInvitationInput): any => ({ ...obj, }); @@ -2784,6 +3024,9 @@ export interface UpdateShareInvitationOutput { } export namespace UpdateShareInvitationOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateShareInvitationOutput): any => ({ ...obj, }); @@ -3017,6 +3260,9 @@ export interface UpdateWorkloadInput { } export namespace UpdateWorkloadInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateWorkloadInput): any => ({ ...obj, }); @@ -3033,6 +3279,9 @@ export interface UpdateWorkloadOutput { } export namespace UpdateWorkloadOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateWorkloadOutput): any => ({ ...obj, }); @@ -3059,6 +3308,9 @@ export interface UpdateWorkloadShareInput { } export namespace UpdateWorkloadShareInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateWorkloadShareInput): any => ({ ...obj, }); @@ -3107,6 +3359,9 @@ export interface WorkloadShare { } export namespace WorkloadShare { + /** + * @internal + */ export const filterSensitiveLog = (obj: WorkloadShare): any => ({ ...obj, }); @@ -3128,6 +3383,9 @@ export interface UpdateWorkloadShareOutput { } export namespace UpdateWorkloadShareOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateWorkloadShareOutput): any => ({ ...obj, }); @@ -3167,6 +3425,9 @@ export interface UpgradeLensReviewInput { } export namespace UpgradeLensReviewInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpgradeLensReviewInput): any => ({ ...obj, }); diff --git a/clients/client-workdocs/commands/AbortDocumentVersionUploadCommand.ts b/clients/client-workdocs/commands/AbortDocumentVersionUploadCommand.ts index 6e3dd7059c99..e2a37432715a 100644 --- a/clients/client-workdocs/commands/AbortDocumentVersionUploadCommand.ts +++ b/clients/client-workdocs/commands/AbortDocumentVersionUploadCommand.ts @@ -25,6 +25,20 @@ export interface AbortDocumentVersionUploadCommandOutput extends __MetadataBeare * by InitiateDocumentVersionUpload. The client should make this call * only when it no longer intends to upload the document version, or fails to do * so.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { WorkDocsClient, AbortDocumentVersionUploadCommand } from "@aws-sdk/client-workdocs"; // ES Modules import + * // const { WorkDocsClient, AbortDocumentVersionUploadCommand } = require("@aws-sdk/client-workdocs"); // CommonJS import + * const client = new WorkDocsClient(config); + * const command = new AbortDocumentVersionUploadCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link AbortDocumentVersionUploadCommandInput} for command's `input` shape. + * @see {@link AbortDocumentVersionUploadCommandOutput} for command's `response` shape. + * @see {@link WorkDocsClientResolvedConfig | config} for command's `input` shape. + * */ export class AbortDocumentVersionUploadCommand extends $Command< AbortDocumentVersionUploadCommandInput, diff --git a/clients/client-workdocs/commands/ActivateUserCommand.ts b/clients/client-workdocs/commands/ActivateUserCommand.ts index 1b104617110d..c872ab55b8c7 100644 --- a/clients/client-workdocs/commands/ActivateUserCommand.ts +++ b/clients/client-workdocs/commands/ActivateUserCommand.ts @@ -23,6 +23,20 @@ export interface ActivateUserCommandOutput extends ActivateUserResponse, __Metad /** *

Activates the specified user. Only active users can access Amazon * WorkDocs.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { WorkDocsClient, ActivateUserCommand } from "@aws-sdk/client-workdocs"; // ES Modules import + * // const { WorkDocsClient, ActivateUserCommand } = require("@aws-sdk/client-workdocs"); // CommonJS import + * const client = new WorkDocsClient(config); + * const command = new ActivateUserCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ActivateUserCommandInput} for command's `input` shape. + * @see {@link ActivateUserCommandOutput} for command's `response` shape. + * @see {@link WorkDocsClientResolvedConfig | config} for command's `input` shape. + * */ export class ActivateUserCommand extends $Command< ActivateUserCommandInput, diff --git a/clients/client-workdocs/commands/AddResourcePermissionsCommand.ts b/clients/client-workdocs/commands/AddResourcePermissionsCommand.ts index 2769e8e1c843..d08f0637e3fa 100644 --- a/clients/client-workdocs/commands/AddResourcePermissionsCommand.ts +++ b/clients/client-workdocs/commands/AddResourcePermissionsCommand.ts @@ -24,6 +24,20 @@ export interface AddResourcePermissionsCommandOutput extends AddResourcePermissi *

Creates a set of permissions for the specified folder or document. The resource * permissions are overwritten if the principals already have different * permissions.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { WorkDocsClient, AddResourcePermissionsCommand } from "@aws-sdk/client-workdocs"; // ES Modules import + * // const { WorkDocsClient, AddResourcePermissionsCommand } = require("@aws-sdk/client-workdocs"); // CommonJS import + * const client = new WorkDocsClient(config); + * const command = new AddResourcePermissionsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link AddResourcePermissionsCommandInput} for command's `input` shape. + * @see {@link AddResourcePermissionsCommandOutput} for command's `response` shape. + * @see {@link WorkDocsClientResolvedConfig | config} for command's `input` shape. + * */ export class AddResourcePermissionsCommand extends $Command< AddResourcePermissionsCommandInput, diff --git a/clients/client-workdocs/commands/CreateCommentCommand.ts b/clients/client-workdocs/commands/CreateCommentCommand.ts index 90c1358f8e2b..7bd5946bd2a2 100644 --- a/clients/client-workdocs/commands/CreateCommentCommand.ts +++ b/clients/client-workdocs/commands/CreateCommentCommand.ts @@ -22,6 +22,20 @@ export interface CreateCommentCommandOutput extends CreateCommentResponse, __Met /** *

Adds a new comment to the specified document version.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { WorkDocsClient, CreateCommentCommand } from "@aws-sdk/client-workdocs"; // ES Modules import + * // const { WorkDocsClient, CreateCommentCommand } = require("@aws-sdk/client-workdocs"); // CommonJS import + * const client = new WorkDocsClient(config); + * const command = new CreateCommentCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreateCommentCommandInput} for command's `input` shape. + * @see {@link CreateCommentCommandOutput} for command's `response` shape. + * @see {@link WorkDocsClientResolvedConfig | config} for command's `input` shape. + * */ export class CreateCommentCommand extends $Command< CreateCommentCommandInput, diff --git a/clients/client-workdocs/commands/CreateCustomMetadataCommand.ts b/clients/client-workdocs/commands/CreateCustomMetadataCommand.ts index 5cb38ffe255e..fcdb7692b7ec 100644 --- a/clients/client-workdocs/commands/CreateCustomMetadataCommand.ts +++ b/clients/client-workdocs/commands/CreateCustomMetadataCommand.ts @@ -23,6 +23,20 @@ export interface CreateCustomMetadataCommandOutput extends CreateCustomMetadataR /** *

Adds one or more custom properties to the specified resource (a folder, document, * or version).

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { WorkDocsClient, CreateCustomMetadataCommand } from "@aws-sdk/client-workdocs"; // ES Modules import + * // const { WorkDocsClient, CreateCustomMetadataCommand } = require("@aws-sdk/client-workdocs"); // CommonJS import + * const client = new WorkDocsClient(config); + * const command = new CreateCustomMetadataCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreateCustomMetadataCommandInput} for command's `input` shape. + * @see {@link CreateCustomMetadataCommandOutput} for command's `response` shape. + * @see {@link WorkDocsClientResolvedConfig | config} for command's `input` shape. + * */ export class CreateCustomMetadataCommand extends $Command< CreateCustomMetadataCommandInput, diff --git a/clients/client-workdocs/commands/CreateFolderCommand.ts b/clients/client-workdocs/commands/CreateFolderCommand.ts index 062ec0433d04..600fa3d9c280 100644 --- a/clients/client-workdocs/commands/CreateFolderCommand.ts +++ b/clients/client-workdocs/commands/CreateFolderCommand.ts @@ -22,6 +22,20 @@ export interface CreateFolderCommandOutput extends CreateFolderResponse, __Metad /** *

Creates a folder with the specified name and parent folder.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { WorkDocsClient, CreateFolderCommand } from "@aws-sdk/client-workdocs"; // ES Modules import + * // const { WorkDocsClient, CreateFolderCommand } = require("@aws-sdk/client-workdocs"); // CommonJS import + * const client = new WorkDocsClient(config); + * const command = new CreateFolderCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreateFolderCommandInput} for command's `input` shape. + * @see {@link CreateFolderCommandOutput} for command's `response` shape. + * @see {@link WorkDocsClientResolvedConfig | config} for command's `input` shape. + * */ export class CreateFolderCommand extends $Command< CreateFolderCommandInput, diff --git a/clients/client-workdocs/commands/CreateLabelsCommand.ts b/clients/client-workdocs/commands/CreateLabelsCommand.ts index ddeb0010fb83..9f60727912a7 100644 --- a/clients/client-workdocs/commands/CreateLabelsCommand.ts +++ b/clients/client-workdocs/commands/CreateLabelsCommand.ts @@ -23,6 +23,20 @@ export interface CreateLabelsCommandOutput extends CreateLabelsResponse, __Metad /** *

Adds the specified list of labels to the given resource (a document or * folder)

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { WorkDocsClient, CreateLabelsCommand } from "@aws-sdk/client-workdocs"; // ES Modules import + * // const { WorkDocsClient, CreateLabelsCommand } = require("@aws-sdk/client-workdocs"); // CommonJS import + * const client = new WorkDocsClient(config); + * const command = new CreateLabelsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreateLabelsCommandInput} for command's `input` shape. + * @see {@link CreateLabelsCommandOutput} for command's `response` shape. + * @see {@link WorkDocsClientResolvedConfig | config} for command's `input` shape. + * */ export class CreateLabelsCommand extends $Command< CreateLabelsCommandInput, diff --git a/clients/client-workdocs/commands/CreateNotificationSubscriptionCommand.ts b/clients/client-workdocs/commands/CreateNotificationSubscriptionCommand.ts index cba467a84452..fbfa601a765f 100644 --- a/clients/client-workdocs/commands/CreateNotificationSubscriptionCommand.ts +++ b/clients/client-workdocs/commands/CreateNotificationSubscriptionCommand.ts @@ -28,6 +28,20 @@ export interface CreateNotificationSubscriptionCommandOutput *

For more information, see Subscribe to * Notifications in the Amazon WorkDocs Developer * Guide.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { WorkDocsClient, CreateNotificationSubscriptionCommand } from "@aws-sdk/client-workdocs"; // ES Modules import + * // const { WorkDocsClient, CreateNotificationSubscriptionCommand } = require("@aws-sdk/client-workdocs"); // CommonJS import + * const client = new WorkDocsClient(config); + * const command = new CreateNotificationSubscriptionCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreateNotificationSubscriptionCommandInput} for command's `input` shape. + * @see {@link CreateNotificationSubscriptionCommandOutput} for command's `response` shape. + * @see {@link WorkDocsClientResolvedConfig | config} for command's `input` shape. + * */ export class CreateNotificationSubscriptionCommand extends $Command< CreateNotificationSubscriptionCommandInput, diff --git a/clients/client-workdocs/commands/CreateUserCommand.ts b/clients/client-workdocs/commands/CreateUserCommand.ts index f0871b5640e1..1338a0a6e872 100644 --- a/clients/client-workdocs/commands/CreateUserCommand.ts +++ b/clients/client-workdocs/commands/CreateUserCommand.ts @@ -23,6 +23,20 @@ export interface CreateUserCommandOutput extends CreateUserResponse, __MetadataB /** *

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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { WorkDocsClient, CreateUserCommand } from "@aws-sdk/client-workdocs"; // ES Modules import + * // const { WorkDocsClient, CreateUserCommand } = require("@aws-sdk/client-workdocs"); // CommonJS import + * const client = new WorkDocsClient(config); + * const command = new CreateUserCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreateUserCommandInput} for command's `input` shape. + * @see {@link CreateUserCommandOutput} for command's `response` shape. + * @see {@link WorkDocsClientResolvedConfig | config} for command's `input` shape. + * */ export class CreateUserCommand extends $Command< CreateUserCommandInput, diff --git a/clients/client-workdocs/commands/DeactivateUserCommand.ts b/clients/client-workdocs/commands/DeactivateUserCommand.ts index beccd3997b6a..c25fc96ef432 100644 --- a/clients/client-workdocs/commands/DeactivateUserCommand.ts +++ b/clients/client-workdocs/commands/DeactivateUserCommand.ts @@ -23,6 +23,20 @@ export interface DeactivateUserCommandOutput extends __MetadataBearer {} /** *

Deactivates the specified user, which revokes the user's access to Amazon * WorkDocs.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { WorkDocsClient, DeactivateUserCommand } from "@aws-sdk/client-workdocs"; // ES Modules import + * // const { WorkDocsClient, DeactivateUserCommand } = require("@aws-sdk/client-workdocs"); // CommonJS import + * const client = new WorkDocsClient(config); + * const command = new DeactivateUserCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeactivateUserCommandInput} for command's `input` shape. + * @see {@link DeactivateUserCommandOutput} for command's `response` shape. + * @see {@link WorkDocsClientResolvedConfig | config} for command's `input` shape. + * */ export class DeactivateUserCommand extends $Command< DeactivateUserCommandInput, diff --git a/clients/client-workdocs/commands/DeleteCommentCommand.ts b/clients/client-workdocs/commands/DeleteCommentCommand.ts index 2bb3c2b01b68..1ae88097c81b 100644 --- a/clients/client-workdocs/commands/DeleteCommentCommand.ts +++ b/clients/client-workdocs/commands/DeleteCommentCommand.ts @@ -22,6 +22,20 @@ export interface DeleteCommentCommandOutput extends __MetadataBearer {} /** *

Deletes the specified comment from the document version.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { WorkDocsClient, DeleteCommentCommand } from "@aws-sdk/client-workdocs"; // ES Modules import + * // const { WorkDocsClient, DeleteCommentCommand } = require("@aws-sdk/client-workdocs"); // CommonJS import + * const client = new WorkDocsClient(config); + * const command = new DeleteCommentCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteCommentCommandInput} for command's `input` shape. + * @see {@link DeleteCommentCommandOutput} for command's `response` shape. + * @see {@link WorkDocsClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteCommentCommand extends $Command< DeleteCommentCommandInput, diff --git a/clients/client-workdocs/commands/DeleteCustomMetadataCommand.ts b/clients/client-workdocs/commands/DeleteCustomMetadataCommand.ts index 72a1b7054313..5033c1eaed88 100644 --- a/clients/client-workdocs/commands/DeleteCustomMetadataCommand.ts +++ b/clients/client-workdocs/commands/DeleteCustomMetadataCommand.ts @@ -22,6 +22,20 @@ export interface DeleteCustomMetadataCommandOutput extends DeleteCustomMetadataR /** *

Deletes custom metadata from the specified resource.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { WorkDocsClient, DeleteCustomMetadataCommand } from "@aws-sdk/client-workdocs"; // ES Modules import + * // const { WorkDocsClient, DeleteCustomMetadataCommand } = require("@aws-sdk/client-workdocs"); // CommonJS import + * const client = new WorkDocsClient(config); + * const command = new DeleteCustomMetadataCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteCustomMetadataCommandInput} for command's `input` shape. + * @see {@link DeleteCustomMetadataCommandOutput} for command's `response` shape. + * @see {@link WorkDocsClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteCustomMetadataCommand extends $Command< DeleteCustomMetadataCommandInput, diff --git a/clients/client-workdocs/commands/DeleteDocumentCommand.ts b/clients/client-workdocs/commands/DeleteDocumentCommand.ts index ff0d0ab4855d..da497726a280 100644 --- a/clients/client-workdocs/commands/DeleteDocumentCommand.ts +++ b/clients/client-workdocs/commands/DeleteDocumentCommand.ts @@ -22,6 +22,20 @@ export interface DeleteDocumentCommandOutput extends __MetadataBearer {} /** *

Permanently deletes the specified document and its associated metadata.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { WorkDocsClient, DeleteDocumentCommand } from "@aws-sdk/client-workdocs"; // ES Modules import + * // const { WorkDocsClient, DeleteDocumentCommand } = require("@aws-sdk/client-workdocs"); // CommonJS import + * const client = new WorkDocsClient(config); + * const command = new DeleteDocumentCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteDocumentCommandInput} for command's `input` shape. + * @see {@link DeleteDocumentCommandOutput} for command's `response` shape. + * @see {@link WorkDocsClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteDocumentCommand extends $Command< DeleteDocumentCommandInput, diff --git a/clients/client-workdocs/commands/DeleteFolderCommand.ts b/clients/client-workdocs/commands/DeleteFolderCommand.ts index 07585df77434..c348abb4a8cf 100644 --- a/clients/client-workdocs/commands/DeleteFolderCommand.ts +++ b/clients/client-workdocs/commands/DeleteFolderCommand.ts @@ -22,6 +22,20 @@ export interface DeleteFolderCommandOutput extends __MetadataBearer {} /** *

Permanently deletes the specified folder and its contents.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { WorkDocsClient, DeleteFolderCommand } from "@aws-sdk/client-workdocs"; // ES Modules import + * // const { WorkDocsClient, DeleteFolderCommand } = require("@aws-sdk/client-workdocs"); // CommonJS import + * const client = new WorkDocsClient(config); + * const command = new DeleteFolderCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteFolderCommandInput} for command's `input` shape. + * @see {@link DeleteFolderCommandOutput} for command's `response` shape. + * @see {@link WorkDocsClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteFolderCommand extends $Command< DeleteFolderCommandInput, diff --git a/clients/client-workdocs/commands/DeleteFolderContentsCommand.ts b/clients/client-workdocs/commands/DeleteFolderContentsCommand.ts index 1cd83928c8fc..3deb8938f24e 100644 --- a/clients/client-workdocs/commands/DeleteFolderContentsCommand.ts +++ b/clients/client-workdocs/commands/DeleteFolderContentsCommand.ts @@ -22,6 +22,20 @@ export interface DeleteFolderContentsCommandOutput extends __MetadataBearer {} /** *

Deletes the contents of the specified folder.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { WorkDocsClient, DeleteFolderContentsCommand } from "@aws-sdk/client-workdocs"; // ES Modules import + * // const { WorkDocsClient, DeleteFolderContentsCommand } = require("@aws-sdk/client-workdocs"); // CommonJS import + * const client = new WorkDocsClient(config); + * const command = new DeleteFolderContentsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteFolderContentsCommandInput} for command's `input` shape. + * @see {@link DeleteFolderContentsCommandOutput} for command's `response` shape. + * @see {@link WorkDocsClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteFolderContentsCommand extends $Command< DeleteFolderContentsCommandInput, diff --git a/clients/client-workdocs/commands/DeleteLabelsCommand.ts b/clients/client-workdocs/commands/DeleteLabelsCommand.ts index 24fabb02d8df..e8b58c563475 100644 --- a/clients/client-workdocs/commands/DeleteLabelsCommand.ts +++ b/clients/client-workdocs/commands/DeleteLabelsCommand.ts @@ -22,6 +22,20 @@ export interface DeleteLabelsCommandOutput extends DeleteLabelsResponse, __Metad /** *

Deletes the specified list of labels from a resource.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { WorkDocsClient, DeleteLabelsCommand } from "@aws-sdk/client-workdocs"; // ES Modules import + * // const { WorkDocsClient, DeleteLabelsCommand } = require("@aws-sdk/client-workdocs"); // CommonJS import + * const client = new WorkDocsClient(config); + * const command = new DeleteLabelsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteLabelsCommandInput} for command's `input` shape. + * @see {@link DeleteLabelsCommandOutput} for command's `response` shape. + * @see {@link WorkDocsClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteLabelsCommand extends $Command< DeleteLabelsCommandInput, diff --git a/clients/client-workdocs/commands/DeleteNotificationSubscriptionCommand.ts b/clients/client-workdocs/commands/DeleteNotificationSubscriptionCommand.ts index 3ef1dfefb7e1..754789544380 100644 --- a/clients/client-workdocs/commands/DeleteNotificationSubscriptionCommand.ts +++ b/clients/client-workdocs/commands/DeleteNotificationSubscriptionCommand.ts @@ -22,6 +22,20 @@ export interface DeleteNotificationSubscriptionCommandOutput extends __MetadataB /** *

Deletes the specified subscription from the specified organization.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { WorkDocsClient, DeleteNotificationSubscriptionCommand } from "@aws-sdk/client-workdocs"; // ES Modules import + * // const { WorkDocsClient, DeleteNotificationSubscriptionCommand } = require("@aws-sdk/client-workdocs"); // CommonJS import + * const client = new WorkDocsClient(config); + * const command = new DeleteNotificationSubscriptionCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteNotificationSubscriptionCommandInput} for command's `input` shape. + * @see {@link DeleteNotificationSubscriptionCommandOutput} for command's `response` shape. + * @see {@link WorkDocsClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteNotificationSubscriptionCommand extends $Command< DeleteNotificationSubscriptionCommandInput, diff --git a/clients/client-workdocs/commands/DeleteUserCommand.ts b/clients/client-workdocs/commands/DeleteUserCommand.ts index e27b4e6cd5aa..45175b54092f 100644 --- a/clients/client-workdocs/commands/DeleteUserCommand.ts +++ b/clients/client-workdocs/commands/DeleteUserCommand.ts @@ -22,6 +22,20 @@ export interface DeleteUserCommandOutput extends __MetadataBearer {} /** *

Deletes the specified user from a Simple AD or Microsoft AD directory.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { WorkDocsClient, DeleteUserCommand } from "@aws-sdk/client-workdocs"; // ES Modules import + * // const { WorkDocsClient, DeleteUserCommand } = require("@aws-sdk/client-workdocs"); // CommonJS import + * const client = new WorkDocsClient(config); + * const command = new DeleteUserCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteUserCommandInput} for command's `input` shape. + * @see {@link DeleteUserCommandOutput} for command's `response` shape. + * @see {@link WorkDocsClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteUserCommand extends $Command< DeleteUserCommandInput, diff --git a/clients/client-workdocs/commands/DescribeActivitiesCommand.ts b/clients/client-workdocs/commands/DescribeActivitiesCommand.ts index 658279977607..d61684d828bd 100644 --- a/clients/client-workdocs/commands/DescribeActivitiesCommand.ts +++ b/clients/client-workdocs/commands/DescribeActivitiesCommand.ts @@ -22,6 +22,20 @@ export interface DescribeActivitiesCommandOutput extends DescribeActivitiesRespo /** *

Describes the user activities in a specified time period.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { WorkDocsClient, DescribeActivitiesCommand } from "@aws-sdk/client-workdocs"; // ES Modules import + * // const { WorkDocsClient, DescribeActivitiesCommand } = require("@aws-sdk/client-workdocs"); // CommonJS import + * const client = new WorkDocsClient(config); + * const command = new DescribeActivitiesCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeActivitiesCommandInput} for command's `input` shape. + * @see {@link DescribeActivitiesCommandOutput} for command's `response` shape. + * @see {@link WorkDocsClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeActivitiesCommand extends $Command< DescribeActivitiesCommandInput, diff --git a/clients/client-workdocs/commands/DescribeCommentsCommand.ts b/clients/client-workdocs/commands/DescribeCommentsCommand.ts index e1e7faf01009..818240602721 100644 --- a/clients/client-workdocs/commands/DescribeCommentsCommand.ts +++ b/clients/client-workdocs/commands/DescribeCommentsCommand.ts @@ -22,6 +22,20 @@ export interface DescribeCommentsCommandOutput extends DescribeCommentsResponse, /** *

List all the comments for the specified document version.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { WorkDocsClient, DescribeCommentsCommand } from "@aws-sdk/client-workdocs"; // ES Modules import + * // const { WorkDocsClient, DescribeCommentsCommand } = require("@aws-sdk/client-workdocs"); // CommonJS import + * const client = new WorkDocsClient(config); + * const command = new DescribeCommentsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeCommentsCommandInput} for command's `input` shape. + * @see {@link DescribeCommentsCommandOutput} for command's `response` shape. + * @see {@link WorkDocsClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeCommentsCommand extends $Command< DescribeCommentsCommandInput, diff --git a/clients/client-workdocs/commands/DescribeDocumentVersionsCommand.ts b/clients/client-workdocs/commands/DescribeDocumentVersionsCommand.ts index 613a86ca5f46..ba5a9183812e 100644 --- a/clients/client-workdocs/commands/DescribeDocumentVersionsCommand.ts +++ b/clients/client-workdocs/commands/DescribeDocumentVersionsCommand.ts @@ -23,6 +23,20 @@ export interface DescribeDocumentVersionsCommandOutput extends DescribeDocumentV /** *

Retrieves the document versions for the specified document.

*

By default, only active versions are returned.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { WorkDocsClient, DescribeDocumentVersionsCommand } from "@aws-sdk/client-workdocs"; // ES Modules import + * // const { WorkDocsClient, DescribeDocumentVersionsCommand } = require("@aws-sdk/client-workdocs"); // CommonJS import + * const client = new WorkDocsClient(config); + * const command = new DescribeDocumentVersionsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeDocumentVersionsCommandInput} for command's `input` shape. + * @see {@link DescribeDocumentVersionsCommandOutput} for command's `response` shape. + * @see {@link WorkDocsClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeDocumentVersionsCommand extends $Command< DescribeDocumentVersionsCommandInput, diff --git a/clients/client-workdocs/commands/DescribeFolderContentsCommand.ts b/clients/client-workdocs/commands/DescribeFolderContentsCommand.ts index 22d681c36f8f..ec89493aeaee 100644 --- a/clients/client-workdocs/commands/DescribeFolderContentsCommand.ts +++ b/clients/client-workdocs/commands/DescribeFolderContentsCommand.ts @@ -27,6 +27,20 @@ export interface DescribeFolderContentsCommandOutput extends DescribeFolderConte * 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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { WorkDocsClient, DescribeFolderContentsCommand } from "@aws-sdk/client-workdocs"; // ES Modules import + * // const { WorkDocsClient, DescribeFolderContentsCommand } = require("@aws-sdk/client-workdocs"); // CommonJS import + * const client = new WorkDocsClient(config); + * const command = new DescribeFolderContentsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeFolderContentsCommandInput} for command's `input` shape. + * @see {@link DescribeFolderContentsCommandOutput} for command's `response` shape. + * @see {@link WorkDocsClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeFolderContentsCommand extends $Command< DescribeFolderContentsCommandInput, diff --git a/clients/client-workdocs/commands/DescribeGroupsCommand.ts b/clients/client-workdocs/commands/DescribeGroupsCommand.ts index 4e32298687ce..375aabbe911f 100644 --- a/clients/client-workdocs/commands/DescribeGroupsCommand.ts +++ b/clients/client-workdocs/commands/DescribeGroupsCommand.ts @@ -23,6 +23,20 @@ export interface DescribeGroupsCommandOutput extends DescribeGroupsResponse, __M /** *

Describes the groups specified by the query. Groups are defined by the underlying * Active Directory.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { WorkDocsClient, DescribeGroupsCommand } from "@aws-sdk/client-workdocs"; // ES Modules import + * // const { WorkDocsClient, DescribeGroupsCommand } = require("@aws-sdk/client-workdocs"); // CommonJS import + * const client = new WorkDocsClient(config); + * const command = new DescribeGroupsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeGroupsCommandInput} for command's `input` shape. + * @see {@link DescribeGroupsCommandOutput} for command's `response` shape. + * @see {@link WorkDocsClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeGroupsCommand extends $Command< DescribeGroupsCommandInput, diff --git a/clients/client-workdocs/commands/DescribeNotificationSubscriptionsCommand.ts b/clients/client-workdocs/commands/DescribeNotificationSubscriptionsCommand.ts index 7b61e9dda5a7..51846a8bcabc 100644 --- a/clients/client-workdocs/commands/DescribeNotificationSubscriptionsCommand.ts +++ b/clients/client-workdocs/commands/DescribeNotificationSubscriptionsCommand.ts @@ -27,6 +27,20 @@ export interface DescribeNotificationSubscriptionsCommandOutput /** *

Lists the specified notification subscriptions.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { WorkDocsClient, DescribeNotificationSubscriptionsCommand } from "@aws-sdk/client-workdocs"; // ES Modules import + * // const { WorkDocsClient, DescribeNotificationSubscriptionsCommand } = require("@aws-sdk/client-workdocs"); // CommonJS import + * const client = new WorkDocsClient(config); + * const command = new DescribeNotificationSubscriptionsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeNotificationSubscriptionsCommandInput} for command's `input` shape. + * @see {@link DescribeNotificationSubscriptionsCommandOutput} for command's `response` shape. + * @see {@link WorkDocsClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeNotificationSubscriptionsCommand extends $Command< DescribeNotificationSubscriptionsCommandInput, diff --git a/clients/client-workdocs/commands/DescribeResourcePermissionsCommand.ts b/clients/client-workdocs/commands/DescribeResourcePermissionsCommand.ts index 4c63c276f61a..b359a7e8a591 100644 --- a/clients/client-workdocs/commands/DescribeResourcePermissionsCommand.ts +++ b/clients/client-workdocs/commands/DescribeResourcePermissionsCommand.ts @@ -24,6 +24,20 @@ export interface DescribeResourcePermissionsCommandOutput /** *

Describes the permissions of a specified resource.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { WorkDocsClient, DescribeResourcePermissionsCommand } from "@aws-sdk/client-workdocs"; // ES Modules import + * // const { WorkDocsClient, DescribeResourcePermissionsCommand } = require("@aws-sdk/client-workdocs"); // CommonJS import + * const client = new WorkDocsClient(config); + * const command = new DescribeResourcePermissionsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeResourcePermissionsCommandInput} for command's `input` shape. + * @see {@link DescribeResourcePermissionsCommandOutput} for command's `response` shape. + * @see {@link WorkDocsClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeResourcePermissionsCommand extends $Command< DescribeResourcePermissionsCommandInput, diff --git a/clients/client-workdocs/commands/DescribeRootFoldersCommand.ts b/clients/client-workdocs/commands/DescribeRootFoldersCommand.ts index 06d5904d8e65..fdf0c273a803 100644 --- a/clients/client-workdocs/commands/DescribeRootFoldersCommand.ts +++ b/clients/client-workdocs/commands/DescribeRootFoldersCommand.ts @@ -30,6 +30,20 @@ export interface DescribeRootFoldersCommandOutput extends DescribeRootFoldersRes * Control for User Applications in the * Amazon * WorkDocs Developer Guide.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { WorkDocsClient, DescribeRootFoldersCommand } from "@aws-sdk/client-workdocs"; // ES Modules import + * // const { WorkDocsClient, DescribeRootFoldersCommand } = require("@aws-sdk/client-workdocs"); // CommonJS import + * const client = new WorkDocsClient(config); + * const command = new DescribeRootFoldersCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeRootFoldersCommandInput} for command's `input` shape. + * @see {@link DescribeRootFoldersCommandOutput} for command's `response` shape. + * @see {@link WorkDocsClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeRootFoldersCommand extends $Command< DescribeRootFoldersCommandInput, diff --git a/clients/client-workdocs/commands/DescribeUsersCommand.ts b/clients/client-workdocs/commands/DescribeUsersCommand.ts index 9e36bb18b2ca..9611a304e3c6 100644 --- a/clients/client-workdocs/commands/DescribeUsersCommand.ts +++ b/clients/client-workdocs/commands/DescribeUsersCommand.ts @@ -26,6 +26,20 @@ export interface DescribeUsersCommandOutput extends DescribeUsersResponse, __Met *

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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { WorkDocsClient, DescribeUsersCommand } from "@aws-sdk/client-workdocs"; // ES Modules import + * // const { WorkDocsClient, DescribeUsersCommand } = require("@aws-sdk/client-workdocs"); // CommonJS import + * const client = new WorkDocsClient(config); + * const command = new DescribeUsersCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeUsersCommandInput} for command's `input` shape. + * @see {@link DescribeUsersCommandOutput} for command's `response` shape. + * @see {@link WorkDocsClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeUsersCommand extends $Command< DescribeUsersCommandInput, diff --git a/clients/client-workdocs/commands/GetCurrentUserCommand.ts b/clients/client-workdocs/commands/GetCurrentUserCommand.ts index 6000bf15a7dd..5d9514e3fc84 100644 --- a/clients/client-workdocs/commands/GetCurrentUserCommand.ts +++ b/clients/client-workdocs/commands/GetCurrentUserCommand.ts @@ -28,6 +28,20 @@ export interface GetCurrentUserCommandOutput extends GetCurrentUserResponse, __M * Control for User Applications in the * Amazon * WorkDocs Developer Guide.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { WorkDocsClient, GetCurrentUserCommand } from "@aws-sdk/client-workdocs"; // ES Modules import + * // const { WorkDocsClient, GetCurrentUserCommand } = require("@aws-sdk/client-workdocs"); // CommonJS import + * const client = new WorkDocsClient(config); + * const command = new GetCurrentUserCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetCurrentUserCommandInput} for command's `input` shape. + * @see {@link GetCurrentUserCommandOutput} for command's `response` shape. + * @see {@link WorkDocsClientResolvedConfig | config} for command's `input` shape. + * */ export class GetCurrentUserCommand extends $Command< GetCurrentUserCommandInput, diff --git a/clients/client-workdocs/commands/GetDocumentCommand.ts b/clients/client-workdocs/commands/GetDocumentCommand.ts index f25ab4227d20..432328f1566f 100644 --- a/clients/client-workdocs/commands/GetDocumentCommand.ts +++ b/clients/client-workdocs/commands/GetDocumentCommand.ts @@ -22,6 +22,20 @@ export interface GetDocumentCommandOutput extends GetDocumentResponse, __Metadat /** *

Retrieves details of a document.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { WorkDocsClient, GetDocumentCommand } from "@aws-sdk/client-workdocs"; // ES Modules import + * // const { WorkDocsClient, GetDocumentCommand } = require("@aws-sdk/client-workdocs"); // CommonJS import + * const client = new WorkDocsClient(config); + * const command = new GetDocumentCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetDocumentCommandInput} for command's `input` shape. + * @see {@link GetDocumentCommandOutput} for command's `response` shape. + * @see {@link WorkDocsClientResolvedConfig | config} for command's `input` shape. + * */ export class GetDocumentCommand extends $Command< GetDocumentCommandInput, diff --git a/clients/client-workdocs/commands/GetDocumentPathCommand.ts b/clients/client-workdocs/commands/GetDocumentPathCommand.ts index f365d5fd913e..4ac7fd37d535 100644 --- a/clients/client-workdocs/commands/GetDocumentPathCommand.ts +++ b/clients/client-workdocs/commands/GetDocumentPathCommand.ts @@ -27,6 +27,20 @@ export interface GetDocumentPathCommandOutput extends GetDocumentPathResponse, _ * 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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { WorkDocsClient, GetDocumentPathCommand } from "@aws-sdk/client-workdocs"; // ES Modules import + * // const { WorkDocsClient, GetDocumentPathCommand } = require("@aws-sdk/client-workdocs"); // CommonJS import + * const client = new WorkDocsClient(config); + * const command = new GetDocumentPathCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetDocumentPathCommandInput} for command's `input` shape. + * @see {@link GetDocumentPathCommandOutput} for command's `response` shape. + * @see {@link WorkDocsClientResolvedConfig | config} for command's `input` shape. + * */ export class GetDocumentPathCommand extends $Command< GetDocumentPathCommandInput, diff --git a/clients/client-workdocs/commands/GetDocumentVersionCommand.ts b/clients/client-workdocs/commands/GetDocumentVersionCommand.ts index f3d324765889..a9076e9b4b17 100644 --- a/clients/client-workdocs/commands/GetDocumentVersionCommand.ts +++ b/clients/client-workdocs/commands/GetDocumentVersionCommand.ts @@ -22,6 +22,20 @@ export interface GetDocumentVersionCommandOutput extends GetDocumentVersionRespo /** *

Retrieves version metadata for the specified document.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { WorkDocsClient, GetDocumentVersionCommand } from "@aws-sdk/client-workdocs"; // ES Modules import + * // const { WorkDocsClient, GetDocumentVersionCommand } = require("@aws-sdk/client-workdocs"); // CommonJS import + * const client = new WorkDocsClient(config); + * const command = new GetDocumentVersionCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetDocumentVersionCommandInput} for command's `input` shape. + * @see {@link GetDocumentVersionCommandOutput} for command's `response` shape. + * @see {@link WorkDocsClientResolvedConfig | config} for command's `input` shape. + * */ export class GetDocumentVersionCommand extends $Command< GetDocumentVersionCommandInput, diff --git a/clients/client-workdocs/commands/GetFolderCommand.ts b/clients/client-workdocs/commands/GetFolderCommand.ts index 6a7a1ca6b833..25eb8855b9cf 100644 --- a/clients/client-workdocs/commands/GetFolderCommand.ts +++ b/clients/client-workdocs/commands/GetFolderCommand.ts @@ -22,6 +22,20 @@ export interface GetFolderCommandOutput extends GetFolderResponse, __MetadataBea /** *

Retrieves the metadata of the specified folder.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { WorkDocsClient, GetFolderCommand } from "@aws-sdk/client-workdocs"; // ES Modules import + * // const { WorkDocsClient, GetFolderCommand } = require("@aws-sdk/client-workdocs"); // CommonJS import + * const client = new WorkDocsClient(config); + * const command = new GetFolderCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetFolderCommandInput} for command's `input` shape. + * @see {@link GetFolderCommandOutput} for command's `response` shape. + * @see {@link WorkDocsClientResolvedConfig | config} for command's `input` shape. + * */ export class GetFolderCommand extends $Command< GetFolderCommandInput, diff --git a/clients/client-workdocs/commands/GetFolderPathCommand.ts b/clients/client-workdocs/commands/GetFolderPathCommand.ts index 8fdad9b42ea3..e2833c27f755 100644 --- a/clients/client-workdocs/commands/GetFolderPathCommand.ts +++ b/clients/client-workdocs/commands/GetFolderPathCommand.ts @@ -27,6 +27,20 @@ export interface GetFolderPathCommandOutput extends GetFolderPathResponse, __Met * 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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { WorkDocsClient, GetFolderPathCommand } from "@aws-sdk/client-workdocs"; // ES Modules import + * // const { WorkDocsClient, GetFolderPathCommand } = require("@aws-sdk/client-workdocs"); // CommonJS import + * const client = new WorkDocsClient(config); + * const command = new GetFolderPathCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetFolderPathCommandInput} for command's `input` shape. + * @see {@link GetFolderPathCommandOutput} for command's `response` shape. + * @see {@link WorkDocsClientResolvedConfig | config} for command's `input` shape. + * */ export class GetFolderPathCommand extends $Command< GetFolderPathCommandInput, diff --git a/clients/client-workdocs/commands/GetResourcesCommand.ts b/clients/client-workdocs/commands/GetResourcesCommand.ts index f18be3829f84..f2a59b6aad16 100644 --- a/clients/client-workdocs/commands/GetResourcesCommand.ts +++ b/clients/client-workdocs/commands/GetResourcesCommand.ts @@ -23,6 +23,20 @@ export interface GetResourcesCommandOutput extends GetResourcesResponse, __Metad /** *

Retrieves a collection of resources, including folders and documents. The only * CollectionType supported is SHARED_WITH_ME.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { WorkDocsClient, GetResourcesCommand } from "@aws-sdk/client-workdocs"; // ES Modules import + * // const { WorkDocsClient, GetResourcesCommand } = require("@aws-sdk/client-workdocs"); // CommonJS import + * const client = new WorkDocsClient(config); + * const command = new GetResourcesCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetResourcesCommandInput} for command's `input` shape. + * @see {@link GetResourcesCommandOutput} for command's `response` shape. + * @see {@link WorkDocsClientResolvedConfig | config} for command's `input` shape. + * */ export class GetResourcesCommand extends $Command< GetResourcesCommandInput, diff --git a/clients/client-workdocs/commands/InitiateDocumentVersionUploadCommand.ts b/clients/client-workdocs/commands/InitiateDocumentVersionUploadCommand.ts index 997cd02f681e..af9ecdb0db8e 100644 --- a/clients/client-workdocs/commands/InitiateDocumentVersionUploadCommand.ts +++ b/clients/client-workdocs/commands/InitiateDocumentVersionUploadCommand.ts @@ -29,6 +29,20 @@ export interface InitiateDocumentVersionUploadCommandOutput * 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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { WorkDocsClient, InitiateDocumentVersionUploadCommand } from "@aws-sdk/client-workdocs"; // ES Modules import + * // const { WorkDocsClient, InitiateDocumentVersionUploadCommand } = require("@aws-sdk/client-workdocs"); // CommonJS import + * const client = new WorkDocsClient(config); + * const command = new InitiateDocumentVersionUploadCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link InitiateDocumentVersionUploadCommandInput} for command's `input` shape. + * @see {@link InitiateDocumentVersionUploadCommandOutput} for command's `response` shape. + * @see {@link WorkDocsClientResolvedConfig | config} for command's `input` shape. + * */ export class InitiateDocumentVersionUploadCommand extends $Command< InitiateDocumentVersionUploadCommandInput, diff --git a/clients/client-workdocs/commands/RemoveAllResourcePermissionsCommand.ts b/clients/client-workdocs/commands/RemoveAllResourcePermissionsCommand.ts index 97e1bdaacc32..df9b9a686879 100644 --- a/clients/client-workdocs/commands/RemoveAllResourcePermissionsCommand.ts +++ b/clients/client-workdocs/commands/RemoveAllResourcePermissionsCommand.ts @@ -22,6 +22,20 @@ export interface RemoveAllResourcePermissionsCommandOutput extends __MetadataBea /** *

Removes all the permissions from the specified resource.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { WorkDocsClient, RemoveAllResourcePermissionsCommand } from "@aws-sdk/client-workdocs"; // ES Modules import + * // const { WorkDocsClient, RemoveAllResourcePermissionsCommand } = require("@aws-sdk/client-workdocs"); // CommonJS import + * const client = new WorkDocsClient(config); + * const command = new RemoveAllResourcePermissionsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link RemoveAllResourcePermissionsCommandInput} for command's `input` shape. + * @see {@link RemoveAllResourcePermissionsCommandOutput} for command's `response` shape. + * @see {@link WorkDocsClientResolvedConfig | config} for command's `input` shape. + * */ export class RemoveAllResourcePermissionsCommand extends $Command< RemoveAllResourcePermissionsCommandInput, diff --git a/clients/client-workdocs/commands/RemoveResourcePermissionCommand.ts b/clients/client-workdocs/commands/RemoveResourcePermissionCommand.ts index 0ff2b208ed1d..5d2c8a9c5b07 100644 --- a/clients/client-workdocs/commands/RemoveResourcePermissionCommand.ts +++ b/clients/client-workdocs/commands/RemoveResourcePermissionCommand.ts @@ -23,6 +23,20 @@ export interface RemoveResourcePermissionCommandOutput extends __MetadataBearer /** *

Removes the permission for the specified principal from the specified * resource.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { WorkDocsClient, RemoveResourcePermissionCommand } from "@aws-sdk/client-workdocs"; // ES Modules import + * // const { WorkDocsClient, RemoveResourcePermissionCommand } = require("@aws-sdk/client-workdocs"); // CommonJS import + * const client = new WorkDocsClient(config); + * const command = new RemoveResourcePermissionCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link RemoveResourcePermissionCommandInput} for command's `input` shape. + * @see {@link RemoveResourcePermissionCommandOutput} for command's `response` shape. + * @see {@link WorkDocsClientResolvedConfig | config} for command's `input` shape. + * */ export class RemoveResourcePermissionCommand extends $Command< RemoveResourcePermissionCommandInput, diff --git a/clients/client-workdocs/commands/UpdateDocumentCommand.ts b/clients/client-workdocs/commands/UpdateDocumentCommand.ts index bbab02633f8f..8d86af01a0af 100644 --- a/clients/client-workdocs/commands/UpdateDocumentCommand.ts +++ b/clients/client-workdocs/commands/UpdateDocumentCommand.ts @@ -23,6 +23,20 @@ export interface UpdateDocumentCommandOutput extends __MetadataBearer {} /** *

Updates the specified attributes of a document. The user must have access to both * the document and its parent folder, if applicable.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { WorkDocsClient, UpdateDocumentCommand } from "@aws-sdk/client-workdocs"; // ES Modules import + * // const { WorkDocsClient, UpdateDocumentCommand } = require("@aws-sdk/client-workdocs"); // CommonJS import + * const client = new WorkDocsClient(config); + * const command = new UpdateDocumentCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link UpdateDocumentCommandInput} for command's `input` shape. + * @see {@link UpdateDocumentCommandOutput} for command's `response` shape. + * @see {@link WorkDocsClientResolvedConfig | config} for command's `input` shape. + * */ export class UpdateDocumentCommand extends $Command< UpdateDocumentCommandInput, diff --git a/clients/client-workdocs/commands/UpdateDocumentVersionCommand.ts b/clients/client-workdocs/commands/UpdateDocumentVersionCommand.ts index 6fc317095875..492dab4f1fe3 100644 --- a/clients/client-workdocs/commands/UpdateDocumentVersionCommand.ts +++ b/clients/client-workdocs/commands/UpdateDocumentVersionCommand.ts @@ -25,6 +25,20 @@ export interface UpdateDocumentVersionCommandOutput extends __MetadataBearer {} *

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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { WorkDocsClient, UpdateDocumentVersionCommand } from "@aws-sdk/client-workdocs"; // ES Modules import + * // const { WorkDocsClient, UpdateDocumentVersionCommand } = require("@aws-sdk/client-workdocs"); // CommonJS import + * const client = new WorkDocsClient(config); + * const command = new UpdateDocumentVersionCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link UpdateDocumentVersionCommandInput} for command's `input` shape. + * @see {@link UpdateDocumentVersionCommandOutput} for command's `response` shape. + * @see {@link WorkDocsClientResolvedConfig | config} for command's `input` shape. + * */ export class UpdateDocumentVersionCommand extends $Command< UpdateDocumentVersionCommandInput, diff --git a/clients/client-workdocs/commands/UpdateFolderCommand.ts b/clients/client-workdocs/commands/UpdateFolderCommand.ts index ae8175fe2d9f..44dd61c1ecc6 100644 --- a/clients/client-workdocs/commands/UpdateFolderCommand.ts +++ b/clients/client-workdocs/commands/UpdateFolderCommand.ts @@ -23,6 +23,20 @@ export interface UpdateFolderCommandOutput extends __MetadataBearer {} /** *

Updates the specified attributes of the specified folder. The user must have access * to both the folder and its parent folder, if applicable.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { WorkDocsClient, UpdateFolderCommand } from "@aws-sdk/client-workdocs"; // ES Modules import + * // const { WorkDocsClient, UpdateFolderCommand } = require("@aws-sdk/client-workdocs"); // CommonJS import + * const client = new WorkDocsClient(config); + * const command = new UpdateFolderCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link UpdateFolderCommandInput} for command's `input` shape. + * @see {@link UpdateFolderCommandOutput} for command's `response` shape. + * @see {@link WorkDocsClientResolvedConfig | config} for command's `input` shape. + * */ export class UpdateFolderCommand extends $Command< UpdateFolderCommandInput, diff --git a/clients/client-workdocs/commands/UpdateUserCommand.ts b/clients/client-workdocs/commands/UpdateUserCommand.ts index 339c58373d28..e79762e918b4 100644 --- a/clients/client-workdocs/commands/UpdateUserCommand.ts +++ b/clients/client-workdocs/commands/UpdateUserCommand.ts @@ -23,6 +23,20 @@ export interface UpdateUserCommandOutput extends UpdateUserResponse, __MetadataB /** *

Updates the specified attributes of the specified user, and grants or revokes * administrative privileges to the Amazon WorkDocs site.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { WorkDocsClient, UpdateUserCommand } from "@aws-sdk/client-workdocs"; // ES Modules import + * // const { WorkDocsClient, UpdateUserCommand } = require("@aws-sdk/client-workdocs"); // CommonJS import + * const client = new WorkDocsClient(config); + * const command = new UpdateUserCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link UpdateUserCommandInput} for command's `input` shape. + * @see {@link UpdateUserCommandOutput} for command's `response` shape. + * @see {@link WorkDocsClientResolvedConfig | config} for command's `input` shape. + * */ export class UpdateUserCommand extends $Command< UpdateUserCommandInput, diff --git a/clients/client-workdocs/models/models_0.ts b/clients/client-workdocs/models/models_0.ts index 96f017cd4667..b6324f6420eb 100644 --- a/clients/client-workdocs/models/models_0.ts +++ b/clients/client-workdocs/models/models_0.ts @@ -19,6 +19,9 @@ export interface AbortDocumentVersionUploadRequest { } export namespace AbortDocumentVersionUploadRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: AbortDocumentVersionUploadRequest): any => ({ ...obj, ...(obj.AuthenticationToken && { AuthenticationToken: SENSITIVE_STRING }), @@ -36,6 +39,9 @@ export interface EntityNotExistsException extends __SmithyException, $MetadataBe } export namespace EntityNotExistsException { + /** + * @internal + */ export const filterSensitiveLog = (obj: EntityNotExistsException): any => ({ ...obj, }); @@ -53,6 +59,9 @@ export interface FailedDependencyException extends __SmithyException, $MetadataB } export namespace FailedDependencyException { + /** + * @internal + */ export const filterSensitiveLog = (obj: FailedDependencyException): any => ({ ...obj, }); @@ -68,6 +77,9 @@ export interface ProhibitedStateException extends __SmithyException, $MetadataBe } export namespace ProhibitedStateException { + /** + * @internal + */ export const filterSensitiveLog = (obj: ProhibitedStateException): any => ({ ...obj, }); @@ -83,6 +95,9 @@ export interface ServiceUnavailableException extends __SmithyException, $Metadat } export namespace ServiceUnavailableException { + /** + * @internal + */ export const filterSensitiveLog = (obj: ServiceUnavailableException): any => ({ ...obj, }); @@ -99,6 +114,9 @@ export interface UnauthorizedOperationException extends __SmithyException, $Meta } export namespace UnauthorizedOperationException { + /** + * @internal + */ export const filterSensitiveLog = (obj: UnauthorizedOperationException): any => ({ ...obj, }); @@ -114,6 +132,9 @@ export interface UnauthorizedResourceAccessException extends __SmithyException, } export namespace UnauthorizedResourceAccessException { + /** + * @internal + */ export const filterSensitiveLog = (obj: UnauthorizedResourceAccessException): any => ({ ...obj, }); @@ -132,6 +153,9 @@ export interface ActivateUserRequest { } export namespace ActivateUserRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ActivateUserRequest): any => ({ ...obj, ...(obj.AuthenticationToken && { AuthenticationToken: SENSITIVE_STRING }), @@ -179,6 +203,9 @@ export interface StorageRuleType { } export namespace StorageRuleType { + /** + * @internal + */ export const filterSensitiveLog = (obj: StorageRuleType): any => ({ ...obj, }); @@ -200,6 +227,9 @@ export interface UserStorageMetadata { } export namespace UserStorageMetadata { + /** + * @internal + */ export const filterSensitiveLog = (obj: UserStorageMetadata): any => ({ ...obj, }); @@ -294,6 +324,9 @@ export interface User { } export namespace User { + /** + * @internal + */ export const filterSensitiveLog = (obj: User): any => ({ ...obj, }); @@ -307,6 +340,9 @@ export interface ActivateUserResponse { } export namespace ActivateUserResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ActivateUserResponse): any => ({ ...obj, }); @@ -349,6 +385,9 @@ export interface CommentMetadata { } export namespace CommentMetadata { + /** + * @internal + */ export const filterSensitiveLog = (obj: CommentMetadata): any => ({ ...obj, }); @@ -385,6 +424,9 @@ export interface UserMetadata { } export namespace UserMetadata { + /** + * @internal + */ export const filterSensitiveLog = (obj: UserMetadata): any => ({ ...obj, }); @@ -437,6 +479,9 @@ export interface ResourceMetadata { } export namespace ResourceMetadata { + /** + * @internal + */ export const filterSensitiveLog = (obj: ResourceMetadata): any => ({ ...obj, }); @@ -458,6 +503,9 @@ export interface GroupMetadata { } export namespace GroupMetadata { + /** + * @internal + */ export const filterSensitiveLog = (obj: GroupMetadata): any => ({ ...obj, }); @@ -479,6 +527,9 @@ export interface Participants { } export namespace Participants { + /** + * @internal + */ export const filterSensitiveLog = (obj: Participants): any => ({ ...obj, }); @@ -578,6 +629,9 @@ export interface Activity { } export namespace Activity { + /** + * @internal + */ export const filterSensitiveLog = (obj: Activity): any => ({ ...obj, }); @@ -600,6 +654,9 @@ export interface NotificationOptions { } export namespace NotificationOptions { + /** + * @internal + */ export const filterSensitiveLog = (obj: NotificationOptions): any => ({ ...obj, ...(obj.EmailMessage && { EmailMessage: SENSITIVE_STRING }), @@ -642,6 +699,9 @@ export interface SharePrincipal { } export namespace SharePrincipal { + /** + * @internal + */ export const filterSensitiveLog = (obj: SharePrincipal): any => ({ ...obj, }); @@ -670,6 +730,9 @@ export interface AddResourcePermissionsRequest { } export namespace AddResourcePermissionsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: AddResourcePermissionsRequest): any => ({ ...obj, ...(obj.AuthenticationToken && { AuthenticationToken: SENSITIVE_STRING }), @@ -720,6 +783,9 @@ export interface ShareResult { } export namespace ShareResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: ShareResult): any => ({ ...obj, ...(obj.StatusMessage && { StatusMessage: SENSITIVE_STRING }), @@ -734,6 +800,9 @@ export interface AddResourcePermissionsResponse { } export namespace AddResourcePermissionsResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: AddResourcePermissionsResponse): any => ({ ...obj, ...(obj.ShareResults && { ShareResults: obj.ShareResults.map((item) => ShareResult.filterSensitiveLog(item)) }), @@ -791,6 +860,9 @@ export interface CreateCommentRequest { } export namespace CreateCommentRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateCommentRequest): any => ({ ...obj, ...(obj.AuthenticationToken && { AuthenticationToken: SENSITIVE_STRING }), @@ -852,6 +924,9 @@ export interface Comment { } export namespace Comment { + /** + * @internal + */ export const filterSensitiveLog = (obj: Comment): any => ({ ...obj, ...(obj.Text && { Text: SENSITIVE_STRING }), @@ -866,6 +941,9 @@ export interface CreateCommentResponse { } export namespace CreateCommentResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateCommentResponse): any => ({ ...obj, ...(obj.Comment && { Comment: Comment.filterSensitiveLog(obj.Comment) }), @@ -883,6 +961,9 @@ export interface DocumentLockedForCommentsException extends __SmithyException, $ } export namespace DocumentLockedForCommentsException { + /** + * @internal + */ export const filterSensitiveLog = (obj: DocumentLockedForCommentsException): any => ({ ...obj, }); @@ -898,6 +979,9 @@ export interface InvalidCommentOperationException extends __SmithyException, $Me } export namespace InvalidCommentOperationException { + /** + * @internal + */ export const filterSensitiveLog = (obj: InvalidCommentOperationException): any => ({ ...obj, }); @@ -927,6 +1011,9 @@ export interface CreateCustomMetadataRequest { } export namespace CreateCustomMetadataRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateCustomMetadataRequest): any => ({ ...obj, ...(obj.AuthenticationToken && { AuthenticationToken: SENSITIVE_STRING }), @@ -936,6 +1023,9 @@ export namespace CreateCustomMetadataRequest { export interface CreateCustomMetadataResponse {} export namespace CreateCustomMetadataResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateCustomMetadataResponse): any => ({ ...obj, }); @@ -952,6 +1042,9 @@ export interface CustomMetadataLimitExceededException extends __SmithyException, } export namespace CustomMetadataLimitExceededException { + /** + * @internal + */ export const filterSensitiveLog = (obj: CustomMetadataLimitExceededException): any => ({ ...obj, }); @@ -967,6 +1060,9 @@ export interface ConflictingOperationException extends __SmithyException, $Metad } export namespace ConflictingOperationException { + /** + * @internal + */ export const filterSensitiveLog = (obj: ConflictingOperationException): any => ({ ...obj, }); @@ -990,6 +1086,9 @@ export interface CreateFolderRequest { } export namespace CreateFolderRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateFolderRequest): any => ({ ...obj, ...(obj.AuthenticationToken && { AuthenticationToken: SENSITIVE_STRING }), @@ -1065,6 +1164,9 @@ export interface FolderMetadata { } export namespace FolderMetadata { + /** + * @internal + */ export const filterSensitiveLog = (obj: FolderMetadata): any => ({ ...obj, }); @@ -1078,6 +1180,9 @@ export interface CreateFolderResponse { } export namespace CreateFolderResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateFolderResponse): any => ({ ...obj, }); @@ -1093,6 +1198,9 @@ export interface EntityAlreadyExistsException extends __SmithyException, $Metada } export namespace EntityAlreadyExistsException { + /** + * @internal + */ export const filterSensitiveLog = (obj: EntityAlreadyExistsException): any => ({ ...obj, }); @@ -1108,6 +1216,9 @@ export interface LimitExceededException extends __SmithyException, $MetadataBear } export namespace LimitExceededException { + /** + * @internal + */ export const filterSensitiveLog = (obj: LimitExceededException): any => ({ ...obj, }); @@ -1131,6 +1242,9 @@ export interface CreateLabelsRequest { } export namespace CreateLabelsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateLabelsRequest): any => ({ ...obj, ...(obj.AuthenticationToken && { AuthenticationToken: SENSITIVE_STRING }), @@ -1140,6 +1254,9 @@ export namespace CreateLabelsRequest { export interface CreateLabelsResponse {} export namespace CreateLabelsResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateLabelsResponse): any => ({ ...obj, }); @@ -1156,6 +1273,9 @@ export interface TooManyLabelsException extends __SmithyException, $MetadataBear } export namespace TooManyLabelsException { + /** + * @internal + */ export const filterSensitiveLog = (obj: TooManyLabelsException): any => ({ ...obj, }); @@ -1194,6 +1314,9 @@ export interface CreateNotificationSubscriptionRequest { } export namespace CreateNotificationSubscriptionRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateNotificationSubscriptionRequest): any => ({ ...obj, }); @@ -1220,6 +1343,9 @@ export interface Subscription { } export namespace Subscription { + /** + * @internal + */ export const filterSensitiveLog = (obj: Subscription): any => ({ ...obj, }); @@ -1233,6 +1359,9 @@ export interface CreateNotificationSubscriptionResponse { } export namespace CreateNotificationSubscriptionResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateNotificationSubscriptionResponse): any => ({ ...obj, }); @@ -1249,6 +1378,9 @@ export interface TooManySubscriptionsException extends __SmithyException, $Metad } export namespace TooManySubscriptionsException { + /** + * @internal + */ export const filterSensitiveLog = (obj: TooManySubscriptionsException): any => ({ ...obj, }); @@ -1302,6 +1434,9 @@ export interface CreateUserRequest { } export namespace CreateUserRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateUserRequest): any => ({ ...obj, ...(obj.Password && { Password: SENSITIVE_STRING }), @@ -1317,6 +1452,9 @@ export interface CreateUserResponse { } export namespace CreateUserResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateUserResponse): any => ({ ...obj, }); @@ -1335,6 +1473,9 @@ export interface DeactivateUserRequest { } export namespace DeactivateUserRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeactivateUserRequest): any => ({ ...obj, ...(obj.AuthenticationToken && { AuthenticationToken: SENSITIVE_STRING }), @@ -1364,6 +1505,9 @@ export interface DeleteCommentRequest { } export namespace DeleteCommentRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteCommentRequest): any => ({ ...obj, ...(obj.AuthenticationToken && { AuthenticationToken: SENSITIVE_STRING }), @@ -1400,6 +1544,9 @@ export interface DeleteCustomMetadataRequest { } export namespace DeleteCustomMetadataRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteCustomMetadataRequest): any => ({ ...obj, ...(obj.AuthenticationToken && { AuthenticationToken: SENSITIVE_STRING }), @@ -1409,6 +1556,9 @@ export namespace DeleteCustomMetadataRequest { export interface DeleteCustomMetadataResponse {} export namespace DeleteCustomMetadataResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteCustomMetadataResponse): any => ({ ...obj, }); @@ -1424,6 +1574,9 @@ export interface ConcurrentModificationException extends __SmithyException, $Met } export namespace ConcurrentModificationException { + /** + * @internal + */ export const filterSensitiveLog = (obj: ConcurrentModificationException): any => ({ ...obj, }); @@ -1442,6 +1595,9 @@ export interface DeleteDocumentRequest { } export namespace DeleteDocumentRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteDocumentRequest): any => ({ ...obj, ...(obj.AuthenticationToken && { AuthenticationToken: SENSITIVE_STRING }), @@ -1461,6 +1617,9 @@ export interface DeleteFolderRequest { } export namespace DeleteFolderRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteFolderRequest): any => ({ ...obj, ...(obj.AuthenticationToken && { AuthenticationToken: SENSITIVE_STRING }), @@ -1480,6 +1639,9 @@ export interface DeleteFolderContentsRequest { } export namespace DeleteFolderContentsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteFolderContentsRequest): any => ({ ...obj, ...(obj.AuthenticationToken && { AuthenticationToken: SENSITIVE_STRING }), @@ -1509,6 +1671,9 @@ export interface DeleteLabelsRequest { } export namespace DeleteLabelsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteLabelsRequest): any => ({ ...obj, ...(obj.AuthenticationToken && { AuthenticationToken: SENSITIVE_STRING }), @@ -1518,6 +1683,9 @@ export namespace DeleteLabelsRequest { export interface DeleteLabelsResponse {} export namespace DeleteLabelsResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteLabelsResponse): any => ({ ...obj, }); @@ -1536,6 +1704,9 @@ export interface DeleteNotificationSubscriptionRequest { } export namespace DeleteNotificationSubscriptionRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteNotificationSubscriptionRequest): any => ({ ...obj, }); @@ -1555,6 +1726,9 @@ export interface DeleteUserRequest { } export namespace DeleteUserRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteUserRequest): any => ({ ...obj, ...(obj.AuthenticationToken && { AuthenticationToken: SENSITIVE_STRING }), @@ -1623,6 +1797,9 @@ export interface DescribeActivitiesRequest { } export namespace DescribeActivitiesRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeActivitiesRequest): any => ({ ...obj, ...(obj.AuthenticationToken && { AuthenticationToken: SENSITIVE_STRING }), @@ -1642,6 +1819,9 @@ export interface DescribeActivitiesResponse { } export namespace DescribeActivitiesResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeActivitiesResponse): any => ({ ...obj, }); @@ -1657,6 +1837,9 @@ export interface InvalidArgumentException extends __SmithyException, $MetadataBe } export namespace InvalidArgumentException { + /** + * @internal + */ export const filterSensitiveLog = (obj: InvalidArgumentException): any => ({ ...obj, }); @@ -1691,6 +1874,9 @@ export interface DescribeCommentsRequest { } export namespace DescribeCommentsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeCommentsRequest): any => ({ ...obj, ...(obj.AuthenticationToken && { AuthenticationToken: SENSITIVE_STRING }), @@ -1711,6 +1897,9 @@ export interface DescribeCommentsResponse { } export namespace DescribeCommentsResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeCommentsResponse): any => ({ ...obj, ...(obj.Comments && { Comments: obj.Comments.map((item) => Comment.filterSensitiveLog(item)) }), @@ -1753,6 +1942,9 @@ export interface DescribeDocumentVersionsRequest { } export namespace DescribeDocumentVersionsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeDocumentVersionsRequest): any => ({ ...obj, ...(obj.AuthenticationToken && { AuthenticationToken: SENSITIVE_STRING }), @@ -1846,6 +2038,9 @@ export interface DocumentVersionMetadata { } export namespace DocumentVersionMetadata { + /** + * @internal + */ export const filterSensitiveLog = (obj: DocumentVersionMetadata): any => ({ ...obj, ...(obj.Thumbnail && { Thumbnail: SENSITIVE_STRING }), @@ -1867,6 +2062,9 @@ export interface DescribeDocumentVersionsResponse { } export namespace DescribeDocumentVersionsResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeDocumentVersionsResponse): any => ({ ...obj, ...(obj.DocumentVersions && { @@ -1936,6 +2134,9 @@ export interface DescribeFolderContentsRequest { } export namespace DescribeFolderContentsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeFolderContentsRequest): any => ({ ...obj, ...(obj.AuthenticationToken && { AuthenticationToken: SENSITIVE_STRING }), @@ -1988,6 +2189,9 @@ export interface DocumentMetadata { } export namespace DocumentMetadata { + /** + * @internal + */ export const filterSensitiveLog = (obj: DocumentMetadata): any => ({ ...obj, ...(obj.LatestVersionMetadata && { @@ -2015,6 +2219,9 @@ export interface DescribeFolderContentsResponse { } export namespace DescribeFolderContentsResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeFolderContentsResponse): any => ({ ...obj, ...(obj.Documents && { Documents: obj.Documents.map((item) => DocumentMetadata.filterSensitiveLog(item)) }), @@ -2050,6 +2257,9 @@ export interface DescribeGroupsRequest { } export namespace DescribeGroupsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeGroupsRequest): any => ({ ...obj, ...(obj.AuthenticationToken && { AuthenticationToken: SENSITIVE_STRING }), @@ -2071,6 +2281,9 @@ export interface DescribeGroupsResponse { } export namespace DescribeGroupsResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeGroupsResponse): any => ({ ...obj, }); @@ -2095,6 +2308,9 @@ export interface DescribeNotificationSubscriptionsRequest { } export namespace DescribeNotificationSubscriptionsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeNotificationSubscriptionsRequest): any => ({ ...obj, }); @@ -2114,6 +2330,9 @@ export interface DescribeNotificationSubscriptionsResponse { } export namespace DescribeNotificationSubscriptionsResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeNotificationSubscriptionsResponse): any => ({ ...obj, }); @@ -2148,6 +2367,9 @@ export interface DescribeResourcePermissionsRequest { } export namespace DescribeResourcePermissionsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeResourcePermissionsRequest): any => ({ ...obj, ...(obj.AuthenticationToken && { AuthenticationToken: SENSITIVE_STRING }), @@ -2175,6 +2397,9 @@ export interface PermissionInfo { } export namespace PermissionInfo { + /** + * @internal + */ export const filterSensitiveLog = (obj: PermissionInfo): any => ({ ...obj, }); @@ -2201,6 +2426,9 @@ export interface Principal { } export namespace Principal { + /** + * @internal + */ export const filterSensitiveLog = (obj: Principal): any => ({ ...obj, }); @@ -2220,6 +2448,9 @@ export interface DescribeResourcePermissionsResponse { } export namespace DescribeResourcePermissionsResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeResourcePermissionsResponse): any => ({ ...obj, }); @@ -2244,6 +2475,9 @@ export interface DescribeRootFoldersRequest { } export namespace DescribeRootFoldersRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeRootFoldersRequest): any => ({ ...obj, ...(obj.AuthenticationToken && { AuthenticationToken: SENSITIVE_STRING }), @@ -2263,6 +2497,9 @@ export interface DescribeRootFoldersResponse { } export namespace DescribeRootFoldersResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeRootFoldersResponse): any => ({ ...obj, }); @@ -2336,6 +2573,9 @@ export interface DescribeUsersRequest { } export namespace DescribeUsersRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeUsersRequest): any => ({ ...obj, ...(obj.AuthenticationToken && { AuthenticationToken: SENSITIVE_STRING }), @@ -2364,6 +2604,9 @@ export interface DescribeUsersResponse { } export namespace DescribeUsersResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeUsersResponse): any => ({ ...obj, }); @@ -2379,6 +2622,9 @@ export interface RequestedEntityTooLargeException extends __SmithyException, $Me } export namespace RequestedEntityTooLargeException { + /** + * @internal + */ export const filterSensitiveLog = (obj: RequestedEntityTooLargeException): any => ({ ...obj, }); @@ -2392,6 +2638,9 @@ export interface GetCurrentUserRequest { } export namespace GetCurrentUserRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetCurrentUserRequest): any => ({ ...obj, ...(obj.AuthenticationToken && { AuthenticationToken: SENSITIVE_STRING }), @@ -2406,6 +2655,9 @@ export interface GetCurrentUserResponse { } export namespace GetCurrentUserResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetCurrentUserResponse): any => ({ ...obj, }); @@ -2429,6 +2681,9 @@ export interface GetDocumentRequest { } export namespace GetDocumentRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetDocumentRequest): any => ({ ...obj, ...(obj.AuthenticationToken && { AuthenticationToken: SENSITIVE_STRING }), @@ -2448,6 +2703,9 @@ export interface GetDocumentResponse { } export namespace GetDocumentResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetDocumentResponse): any => ({ ...obj, ...(obj.Metadata && { Metadata: DocumentMetadata.filterSensitiveLog(obj.Metadata) }), @@ -2464,6 +2722,9 @@ export interface InvalidPasswordException extends __SmithyException, $MetadataBe } export namespace InvalidPasswordException { + /** + * @internal + */ export const filterSensitiveLog = (obj: InvalidPasswordException): any => ({ ...obj, }); @@ -2498,6 +2759,9 @@ export interface GetDocumentPathRequest { } export namespace GetDocumentPathRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetDocumentPathRequest): any => ({ ...obj, ...(obj.AuthenticationToken && { AuthenticationToken: SENSITIVE_STRING }), @@ -2520,6 +2784,9 @@ export interface ResourcePathComponent { } export namespace ResourcePathComponent { + /** + * @internal + */ export const filterSensitiveLog = (obj: ResourcePathComponent): any => ({ ...obj, }); @@ -2536,6 +2803,9 @@ export interface ResourcePath { } export namespace ResourcePath { + /** + * @internal + */ export const filterSensitiveLog = (obj: ResourcePath): any => ({ ...obj, }); @@ -2549,6 +2819,9 @@ export interface GetDocumentPathResponse { } export namespace GetDocumentPathResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetDocumentPathResponse): any => ({ ...obj, }); @@ -2583,6 +2856,9 @@ export interface GetDocumentVersionRequest { } export namespace GetDocumentVersionRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetDocumentVersionRequest): any => ({ ...obj, ...(obj.AuthenticationToken && { AuthenticationToken: SENSITIVE_STRING }), @@ -2602,6 +2878,9 @@ export interface GetDocumentVersionResponse { } export namespace GetDocumentVersionResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetDocumentVersionResponse): any => ({ ...obj, ...(obj.Metadata && { Metadata: DocumentVersionMetadata.filterSensitiveLog(obj.Metadata) }), @@ -2626,6 +2905,9 @@ export interface GetFolderRequest { } export namespace GetFolderRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetFolderRequest): any => ({ ...obj, ...(obj.AuthenticationToken && { AuthenticationToken: SENSITIVE_STRING }), @@ -2645,6 +2927,9 @@ export interface GetFolderResponse { } export namespace GetFolderResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetFolderResponse): any => ({ ...obj, }); @@ -2679,6 +2964,9 @@ export interface GetFolderPathRequest { } export namespace GetFolderPathRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetFolderPathRequest): any => ({ ...obj, ...(obj.AuthenticationToken && { AuthenticationToken: SENSITIVE_STRING }), @@ -2693,6 +2981,9 @@ export interface GetFolderPathResponse { } export namespace GetFolderPathResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetFolderPathResponse): any => ({ ...obj, }); @@ -2731,6 +3022,9 @@ export interface GetResourcesRequest { } export namespace GetResourcesRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetResourcesRequest): any => ({ ...obj, ...(obj.AuthenticationToken && { AuthenticationToken: SENSITIVE_STRING }), @@ -2755,6 +3049,9 @@ export interface GetResourcesResponse { } export namespace GetResourcesResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetResourcesResponse): any => ({ ...obj, ...(obj.Documents && { Documents: obj.Documents.map((item) => DocumentMetadata.filterSensitiveLog(item)) }), @@ -2772,6 +3069,9 @@ export interface DraftUploadOutOfSyncException extends __SmithyException, $Metad } export namespace DraftUploadOutOfSyncException { + /** + * @internal + */ export const filterSensitiveLog = (obj: DraftUploadOutOfSyncException): any => ({ ...obj, }); @@ -2820,6 +3120,9 @@ export interface InitiateDocumentVersionUploadRequest { } export namespace InitiateDocumentVersionUploadRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: InitiateDocumentVersionUploadRequest): any => ({ ...obj, ...(obj.AuthenticationToken && { AuthenticationToken: SENSITIVE_STRING }), @@ -2842,6 +3145,9 @@ export interface UploadMetadata { } export namespace UploadMetadata { + /** + * @internal + */ export const filterSensitiveLog = (obj: UploadMetadata): any => ({ ...obj, ...(obj.UploadUrl && { UploadUrl: SENSITIVE_STRING }), @@ -2861,6 +3167,9 @@ export interface InitiateDocumentVersionUploadResponse { } export namespace InitiateDocumentVersionUploadResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: InitiateDocumentVersionUploadResponse): any => ({ ...obj, ...(obj.Metadata && { Metadata: DocumentMetadata.filterSensitiveLog(obj.Metadata) }), @@ -2878,6 +3187,9 @@ export interface ResourceAlreadyCheckedOutException extends __SmithyException, $ } export namespace ResourceAlreadyCheckedOutException { + /** + * @internal + */ export const filterSensitiveLog = (obj: ResourceAlreadyCheckedOutException): any => ({ ...obj, }); @@ -2893,6 +3205,9 @@ export interface StorageLimitExceededException extends __SmithyException, $Metad } export namespace StorageLimitExceededException { + /** + * @internal + */ export const filterSensitiveLog = (obj: StorageLimitExceededException): any => ({ ...obj, }); @@ -2908,6 +3223,9 @@ export interface StorageLimitWillExceedException extends __SmithyException, $Met } export namespace StorageLimitWillExceedException { + /** + * @internal + */ export const filterSensitiveLog = (obj: StorageLimitWillExceedException): any => ({ ...obj, }); @@ -2926,6 +3244,9 @@ export interface RemoveAllResourcePermissionsRequest { } export namespace RemoveAllResourcePermissionsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: RemoveAllResourcePermissionsRequest): any => ({ ...obj, ...(obj.AuthenticationToken && { AuthenticationToken: SENSITIVE_STRING }), @@ -2955,6 +3276,9 @@ export interface RemoveResourcePermissionRequest { } export namespace RemoveResourcePermissionRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: RemoveResourcePermissionRequest): any => ({ ...obj, ...(obj.AuthenticationToken && { AuthenticationToken: SENSITIVE_STRING }), @@ -2990,6 +3314,9 @@ export interface UpdateDocumentRequest { } export namespace UpdateDocumentRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateDocumentRequest): any => ({ ...obj, ...(obj.AuthenticationToken && { AuthenticationToken: SENSITIVE_STRING }), @@ -3006,6 +3333,9 @@ export interface InvalidOperationException extends __SmithyException, $MetadataB } export namespace InvalidOperationException { + /** + * @internal + */ export const filterSensitiveLog = (obj: InvalidOperationException): any => ({ ...obj, }); @@ -3038,6 +3368,9 @@ export interface UpdateDocumentVersionRequest { } export namespace UpdateDocumentVersionRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateDocumentVersionRequest): any => ({ ...obj, ...(obj.AuthenticationToken && { AuthenticationToken: SENSITIVE_STRING }), @@ -3073,6 +3406,9 @@ export interface UpdateFolderRequest { } export namespace UpdateFolderRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateFolderRequest): any => ({ ...obj, ...(obj.AuthenticationToken && { AuthenticationToken: SENSITIVE_STRING }), @@ -3090,6 +3426,9 @@ export interface DeactivatingLastSystemUserException extends __SmithyException, } export namespace DeactivatingLastSystemUserException { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeactivatingLastSystemUserException): any => ({ ...obj, }); @@ -3105,6 +3444,9 @@ export interface IllegalUserStateException extends __SmithyException, $MetadataB } export namespace IllegalUserStateException { + /** + * @internal + */ export const filterSensitiveLog = (obj: IllegalUserStateException): any => ({ ...obj, }); @@ -3163,6 +3505,9 @@ export interface UpdateUserRequest { } export namespace UpdateUserRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateUserRequest): any => ({ ...obj, ...(obj.AuthenticationToken && { AuthenticationToken: SENSITIVE_STRING }), @@ -3177,6 +3522,9 @@ export interface UpdateUserResponse { } export namespace UpdateUserResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateUserResponse): any => ({ ...obj, }); diff --git a/clients/client-worklink/commands/AssociateDomainCommand.ts b/clients/client-worklink/commands/AssociateDomainCommand.ts index 8ef30ee74923..4e470a7fc55f 100644 --- a/clients/client-worklink/commands/AssociateDomainCommand.ts +++ b/clients/client-worklink/commands/AssociateDomainCommand.ts @@ -22,6 +22,20 @@ export interface AssociateDomainCommandOutput extends AssociateDomainResponse, _ /** *

Specifies a domain to be associated to Amazon WorkLink.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { WorkLinkClient, AssociateDomainCommand } from "@aws-sdk/client-worklink"; // ES Modules import + * // const { WorkLinkClient, AssociateDomainCommand } = require("@aws-sdk/client-worklink"); // CommonJS import + * const client = new WorkLinkClient(config); + * const command = new AssociateDomainCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link AssociateDomainCommandInput} for command's `input` shape. + * @see {@link AssociateDomainCommandOutput} for command's `response` shape. + * @see {@link WorkLinkClientResolvedConfig | config} for command's `input` shape. + * */ export class AssociateDomainCommand extends $Command< AssociateDomainCommandInput, diff --git a/clients/client-worklink/commands/AssociateWebsiteAuthorizationProviderCommand.ts b/clients/client-worklink/commands/AssociateWebsiteAuthorizationProviderCommand.ts index f62787f9263f..19c4b1de97f9 100644 --- a/clients/client-worklink/commands/AssociateWebsiteAuthorizationProviderCommand.ts +++ b/clients/client-worklink/commands/AssociateWebsiteAuthorizationProviderCommand.ts @@ -28,6 +28,20 @@ export interface AssociateWebsiteAuthorizationProviderCommandOutput /** *

Associates a website authorization provider with a specified fleet. This is used to authorize users against associated websites in the company network.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { WorkLinkClient, AssociateWebsiteAuthorizationProviderCommand } from "@aws-sdk/client-worklink"; // ES Modules import + * // const { WorkLinkClient, AssociateWebsiteAuthorizationProviderCommand } = require("@aws-sdk/client-worklink"); // CommonJS import + * const client = new WorkLinkClient(config); + * const command = new AssociateWebsiteAuthorizationProviderCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link AssociateWebsiteAuthorizationProviderCommandInput} for command's `input` shape. + * @see {@link AssociateWebsiteAuthorizationProviderCommandOutput} for command's `response` shape. + * @see {@link WorkLinkClientResolvedConfig | config} for command's `input` shape. + * */ export class AssociateWebsiteAuthorizationProviderCommand extends $Command< AssociateWebsiteAuthorizationProviderCommandInput, diff --git a/clients/client-worklink/commands/AssociateWebsiteCertificateAuthorityCommand.ts b/clients/client-worklink/commands/AssociateWebsiteCertificateAuthorityCommand.ts index 2459f17586f7..f1f32c3f97ab 100644 --- a/clients/client-worklink/commands/AssociateWebsiteCertificateAuthorityCommand.ts +++ b/clients/client-worklink/commands/AssociateWebsiteCertificateAuthorityCommand.ts @@ -28,6 +28,20 @@ export interface AssociateWebsiteCertificateAuthorityCommandOutput /** *

Imports the root certificate of a certificate authority (CA) used to obtain TLS * certificates used by associated websites within the company network.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { WorkLinkClient, AssociateWebsiteCertificateAuthorityCommand } from "@aws-sdk/client-worklink"; // ES Modules import + * // const { WorkLinkClient, AssociateWebsiteCertificateAuthorityCommand } = require("@aws-sdk/client-worklink"); // CommonJS import + * const client = new WorkLinkClient(config); + * const command = new AssociateWebsiteCertificateAuthorityCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link AssociateWebsiteCertificateAuthorityCommandInput} for command's `input` shape. + * @see {@link AssociateWebsiteCertificateAuthorityCommandOutput} for command's `response` shape. + * @see {@link WorkLinkClientResolvedConfig | config} for command's `input` shape. + * */ export class AssociateWebsiteCertificateAuthorityCommand extends $Command< AssociateWebsiteCertificateAuthorityCommandInput, diff --git a/clients/client-worklink/commands/CreateFleetCommand.ts b/clients/client-worklink/commands/CreateFleetCommand.ts index b766148cf68c..27e714a73237 100644 --- a/clients/client-worklink/commands/CreateFleetCommand.ts +++ b/clients/client-worklink/commands/CreateFleetCommand.ts @@ -23,6 +23,20 @@ export interface CreateFleetCommandOutput extends CreateFleetResponse, __Metadat /** *

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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { WorkLinkClient, CreateFleetCommand } from "@aws-sdk/client-worklink"; // ES Modules import + * // const { WorkLinkClient, CreateFleetCommand } = require("@aws-sdk/client-worklink"); // CommonJS import + * const client = new WorkLinkClient(config); + * const command = new CreateFleetCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreateFleetCommandInput} for command's `input` shape. + * @see {@link CreateFleetCommandOutput} for command's `response` shape. + * @see {@link WorkLinkClientResolvedConfig | config} for command's `input` shape. + * */ export class CreateFleetCommand extends $Command< CreateFleetCommandInput, diff --git a/clients/client-worklink/commands/DeleteFleetCommand.ts b/clients/client-worklink/commands/DeleteFleetCommand.ts index 11b0778742b3..b45f88627433 100644 --- a/clients/client-worklink/commands/DeleteFleetCommand.ts +++ b/clients/client-worklink/commands/DeleteFleetCommand.ts @@ -22,6 +22,20 @@ export interface DeleteFleetCommandOutput extends DeleteFleetResponse, __Metadat /** *

Deletes a fleet. Prevents users from accessing previously associated websites.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { WorkLinkClient, DeleteFleetCommand } from "@aws-sdk/client-worklink"; // ES Modules import + * // const { WorkLinkClient, DeleteFleetCommand } = require("@aws-sdk/client-worklink"); // CommonJS import + * const client = new WorkLinkClient(config); + * const command = new DeleteFleetCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteFleetCommandInput} for command's `input` shape. + * @see {@link DeleteFleetCommandOutput} for command's `response` shape. + * @see {@link WorkLinkClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteFleetCommand extends $Command< DeleteFleetCommandInput, diff --git a/clients/client-worklink/commands/DescribeAuditStreamConfigurationCommand.ts b/clients/client-worklink/commands/DescribeAuditStreamConfigurationCommand.ts index e4054f462ee4..47fa54489aa8 100644 --- a/clients/client-worklink/commands/DescribeAuditStreamConfigurationCommand.ts +++ b/clients/client-worklink/commands/DescribeAuditStreamConfigurationCommand.ts @@ -24,6 +24,20 @@ export interface DescribeAuditStreamConfigurationCommandOutput /** *

Describes the configuration for delivering audit streams to the customer account.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { WorkLinkClient, DescribeAuditStreamConfigurationCommand } from "@aws-sdk/client-worklink"; // ES Modules import + * // const { WorkLinkClient, DescribeAuditStreamConfigurationCommand } = require("@aws-sdk/client-worklink"); // CommonJS import + * const client = new WorkLinkClient(config); + * const command = new DescribeAuditStreamConfigurationCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeAuditStreamConfigurationCommandInput} for command's `input` shape. + * @see {@link DescribeAuditStreamConfigurationCommandOutput} for command's `response` shape. + * @see {@link WorkLinkClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeAuditStreamConfigurationCommand extends $Command< DescribeAuditStreamConfigurationCommandInput, diff --git a/clients/client-worklink/commands/DescribeCompanyNetworkConfigurationCommand.ts b/clients/client-worklink/commands/DescribeCompanyNetworkConfigurationCommand.ts index 3df9fd36f74c..d5a21a3ad710 100644 --- a/clients/client-worklink/commands/DescribeCompanyNetworkConfigurationCommand.ts +++ b/clients/client-worklink/commands/DescribeCompanyNetworkConfigurationCommand.ts @@ -28,6 +28,20 @@ export interface DescribeCompanyNetworkConfigurationCommandOutput /** *

Describes the networking configuration to access the internal websites associated with * the specified fleet.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { WorkLinkClient, DescribeCompanyNetworkConfigurationCommand } from "@aws-sdk/client-worklink"; // ES Modules import + * // const { WorkLinkClient, DescribeCompanyNetworkConfigurationCommand } = require("@aws-sdk/client-worklink"); // CommonJS import + * const client = new WorkLinkClient(config); + * const command = new DescribeCompanyNetworkConfigurationCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeCompanyNetworkConfigurationCommandInput} for command's `input` shape. + * @see {@link DescribeCompanyNetworkConfigurationCommandOutput} for command's `response` shape. + * @see {@link WorkLinkClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeCompanyNetworkConfigurationCommand extends $Command< DescribeCompanyNetworkConfigurationCommandInput, diff --git a/clients/client-worklink/commands/DescribeDeviceCommand.ts b/clients/client-worklink/commands/DescribeDeviceCommand.ts index f3382be02e8a..6f6695fd4baa 100644 --- a/clients/client-worklink/commands/DescribeDeviceCommand.ts +++ b/clients/client-worklink/commands/DescribeDeviceCommand.ts @@ -22,6 +22,20 @@ export interface DescribeDeviceCommandOutput extends DescribeDeviceResponse, __M /** *

Provides information about a user's device.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { WorkLinkClient, DescribeDeviceCommand } from "@aws-sdk/client-worklink"; // ES Modules import + * // const { WorkLinkClient, DescribeDeviceCommand } = require("@aws-sdk/client-worklink"); // CommonJS import + * const client = new WorkLinkClient(config); + * const command = new DescribeDeviceCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeDeviceCommandInput} for command's `input` shape. + * @see {@link DescribeDeviceCommandOutput} for command's `response` shape. + * @see {@link WorkLinkClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeDeviceCommand extends $Command< DescribeDeviceCommandInput, diff --git a/clients/client-worklink/commands/DescribeDevicePolicyConfigurationCommand.ts b/clients/client-worklink/commands/DescribeDevicePolicyConfigurationCommand.ts index 4d2bb8e135a9..94eea6b455af 100644 --- a/clients/client-worklink/commands/DescribeDevicePolicyConfigurationCommand.ts +++ b/clients/client-worklink/commands/DescribeDevicePolicyConfigurationCommand.ts @@ -27,6 +27,20 @@ export interface DescribeDevicePolicyConfigurationCommandOutput /** *

Describes the device policy configuration for the specified fleet.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { WorkLinkClient, DescribeDevicePolicyConfigurationCommand } from "@aws-sdk/client-worklink"; // ES Modules import + * // const { WorkLinkClient, DescribeDevicePolicyConfigurationCommand } = require("@aws-sdk/client-worklink"); // CommonJS import + * const client = new WorkLinkClient(config); + * const command = new DescribeDevicePolicyConfigurationCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeDevicePolicyConfigurationCommandInput} for command's `input` shape. + * @see {@link DescribeDevicePolicyConfigurationCommandOutput} for command's `response` shape. + * @see {@link WorkLinkClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeDevicePolicyConfigurationCommand extends $Command< DescribeDevicePolicyConfigurationCommandInput, diff --git a/clients/client-worklink/commands/DescribeDomainCommand.ts b/clients/client-worklink/commands/DescribeDomainCommand.ts index eb4c06d1510c..d1dc9b47e33c 100644 --- a/clients/client-worklink/commands/DescribeDomainCommand.ts +++ b/clients/client-worklink/commands/DescribeDomainCommand.ts @@ -22,6 +22,20 @@ export interface DescribeDomainCommandOutput extends DescribeDomainResponse, __M /** *

Provides information about the domain.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { WorkLinkClient, DescribeDomainCommand } from "@aws-sdk/client-worklink"; // ES Modules import + * // const { WorkLinkClient, DescribeDomainCommand } = require("@aws-sdk/client-worklink"); // CommonJS import + * const client = new WorkLinkClient(config); + * const command = new DescribeDomainCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeDomainCommandInput} for command's `input` shape. + * @see {@link DescribeDomainCommandOutput} for command's `response` shape. + * @see {@link WorkLinkClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeDomainCommand extends $Command< DescribeDomainCommandInput, diff --git a/clients/client-worklink/commands/DescribeFleetMetadataCommand.ts b/clients/client-worklink/commands/DescribeFleetMetadataCommand.ts index 8faa3cca77c7..de99cbbcdb36 100644 --- a/clients/client-worklink/commands/DescribeFleetMetadataCommand.ts +++ b/clients/client-worklink/commands/DescribeFleetMetadataCommand.ts @@ -23,6 +23,20 @@ export interface DescribeFleetMetadataCommandOutput extends DescribeFleetMetadat /** *

Provides basic information for the specified fleet, excluding identity provider, * networking, and device configuration details.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { WorkLinkClient, DescribeFleetMetadataCommand } from "@aws-sdk/client-worklink"; // ES Modules import + * // const { WorkLinkClient, DescribeFleetMetadataCommand } = require("@aws-sdk/client-worklink"); // CommonJS import + * const client = new WorkLinkClient(config); + * const command = new DescribeFleetMetadataCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeFleetMetadataCommandInput} for command's `input` shape. + * @see {@link DescribeFleetMetadataCommandOutput} for command's `response` shape. + * @see {@link WorkLinkClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeFleetMetadataCommand extends $Command< DescribeFleetMetadataCommandInput, diff --git a/clients/client-worklink/commands/DescribeIdentityProviderConfigurationCommand.ts b/clients/client-worklink/commands/DescribeIdentityProviderConfigurationCommand.ts index 73201094aa8e..93846412aa1e 100644 --- a/clients/client-worklink/commands/DescribeIdentityProviderConfigurationCommand.ts +++ b/clients/client-worklink/commands/DescribeIdentityProviderConfigurationCommand.ts @@ -28,6 +28,20 @@ export interface DescribeIdentityProviderConfigurationCommandOutput /** *

Describes the identity provider configuration of the specified fleet.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { WorkLinkClient, DescribeIdentityProviderConfigurationCommand } from "@aws-sdk/client-worklink"; // ES Modules import + * // const { WorkLinkClient, DescribeIdentityProviderConfigurationCommand } = require("@aws-sdk/client-worklink"); // CommonJS import + * const client = new WorkLinkClient(config); + * const command = new DescribeIdentityProviderConfigurationCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeIdentityProviderConfigurationCommandInput} for command's `input` shape. + * @see {@link DescribeIdentityProviderConfigurationCommandOutput} for command's `response` shape. + * @see {@link WorkLinkClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeIdentityProviderConfigurationCommand extends $Command< DescribeIdentityProviderConfigurationCommandInput, diff --git a/clients/client-worklink/commands/DescribeWebsiteCertificateAuthorityCommand.ts b/clients/client-worklink/commands/DescribeWebsiteCertificateAuthorityCommand.ts index c509e19005cb..517f679c8d2b 100644 --- a/clients/client-worklink/commands/DescribeWebsiteCertificateAuthorityCommand.ts +++ b/clients/client-worklink/commands/DescribeWebsiteCertificateAuthorityCommand.ts @@ -27,6 +27,20 @@ export interface DescribeWebsiteCertificateAuthorityCommandOutput /** *

Provides information about the certificate authority.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { WorkLinkClient, DescribeWebsiteCertificateAuthorityCommand } from "@aws-sdk/client-worklink"; // ES Modules import + * // const { WorkLinkClient, DescribeWebsiteCertificateAuthorityCommand } = require("@aws-sdk/client-worklink"); // CommonJS import + * const client = new WorkLinkClient(config); + * const command = new DescribeWebsiteCertificateAuthorityCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeWebsiteCertificateAuthorityCommandInput} for command's `input` shape. + * @see {@link DescribeWebsiteCertificateAuthorityCommandOutput} for command's `response` shape. + * @see {@link WorkLinkClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeWebsiteCertificateAuthorityCommand extends $Command< DescribeWebsiteCertificateAuthorityCommandInput, diff --git a/clients/client-worklink/commands/DisassociateDomainCommand.ts b/clients/client-worklink/commands/DisassociateDomainCommand.ts index 3a1e808fbfea..318054f90ed7 100644 --- a/clients/client-worklink/commands/DisassociateDomainCommand.ts +++ b/clients/client-worklink/commands/DisassociateDomainCommand.ts @@ -22,6 +22,20 @@ export interface DisassociateDomainCommandOutput extends DisassociateDomainRespo /** *

Disassociates a domain from Amazon WorkLink. End users lose the ability to access the domain with Amazon WorkLink.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { WorkLinkClient, DisassociateDomainCommand } from "@aws-sdk/client-worklink"; // ES Modules import + * // const { WorkLinkClient, DisassociateDomainCommand } = require("@aws-sdk/client-worklink"); // CommonJS import + * const client = new WorkLinkClient(config); + * const command = new DisassociateDomainCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DisassociateDomainCommandInput} for command's `input` shape. + * @see {@link DisassociateDomainCommandOutput} for command's `response` shape. + * @see {@link WorkLinkClientResolvedConfig | config} for command's `input` shape. + * */ export class DisassociateDomainCommand extends $Command< DisassociateDomainCommandInput, diff --git a/clients/client-worklink/commands/DisassociateWebsiteAuthorizationProviderCommand.ts b/clients/client-worklink/commands/DisassociateWebsiteAuthorizationProviderCommand.ts index 296c80f18cc1..1a78d2f3b17e 100644 --- a/clients/client-worklink/commands/DisassociateWebsiteAuthorizationProviderCommand.ts +++ b/clients/client-worklink/commands/DisassociateWebsiteAuthorizationProviderCommand.ts @@ -30,6 +30,20 @@ export interface DisassociateWebsiteAuthorizationProviderCommandOutput *

Disassociates a website authorization provider from a specified fleet. After the * disassociation, users can't load any associated websites that require this authorization * provider.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { WorkLinkClient, DisassociateWebsiteAuthorizationProviderCommand } from "@aws-sdk/client-worklink"; // ES Modules import + * // const { WorkLinkClient, DisassociateWebsiteAuthorizationProviderCommand } = require("@aws-sdk/client-worklink"); // CommonJS import + * const client = new WorkLinkClient(config); + * const command = new DisassociateWebsiteAuthorizationProviderCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DisassociateWebsiteAuthorizationProviderCommandInput} for command's `input` shape. + * @see {@link DisassociateWebsiteAuthorizationProviderCommandOutput} for command's `response` shape. + * @see {@link WorkLinkClientResolvedConfig | config} for command's `input` shape. + * */ export class DisassociateWebsiteAuthorizationProviderCommand extends $Command< DisassociateWebsiteAuthorizationProviderCommandInput, diff --git a/clients/client-worklink/commands/DisassociateWebsiteCertificateAuthorityCommand.ts b/clients/client-worklink/commands/DisassociateWebsiteCertificateAuthorityCommand.ts index 2bcebbae5e95..8b643fad12c0 100644 --- a/clients/client-worklink/commands/DisassociateWebsiteCertificateAuthorityCommand.ts +++ b/clients/client-worklink/commands/DisassociateWebsiteCertificateAuthorityCommand.ts @@ -28,6 +28,20 @@ export interface DisassociateWebsiteCertificateAuthorityCommandOutput /** *

Removes a certificate authority (CA).

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { WorkLinkClient, DisassociateWebsiteCertificateAuthorityCommand } from "@aws-sdk/client-worklink"; // ES Modules import + * // const { WorkLinkClient, DisassociateWebsiteCertificateAuthorityCommand } = require("@aws-sdk/client-worklink"); // CommonJS import + * const client = new WorkLinkClient(config); + * const command = new DisassociateWebsiteCertificateAuthorityCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DisassociateWebsiteCertificateAuthorityCommandInput} for command's `input` shape. + * @see {@link DisassociateWebsiteCertificateAuthorityCommandOutput} for command's `response` shape. + * @see {@link WorkLinkClientResolvedConfig | config} for command's `input` shape. + * */ export class DisassociateWebsiteCertificateAuthorityCommand extends $Command< DisassociateWebsiteCertificateAuthorityCommandInput, diff --git a/clients/client-worklink/commands/ListDevicesCommand.ts b/clients/client-worklink/commands/ListDevicesCommand.ts index a6465aa8bda3..7a33c27dc518 100644 --- a/clients/client-worklink/commands/ListDevicesCommand.ts +++ b/clients/client-worklink/commands/ListDevicesCommand.ts @@ -22,6 +22,20 @@ export interface ListDevicesCommandOutput extends ListDevicesResponse, __Metadat /** *

Retrieves a list of devices registered with the specified fleet.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { WorkLinkClient, ListDevicesCommand } from "@aws-sdk/client-worklink"; // ES Modules import + * // const { WorkLinkClient, ListDevicesCommand } = require("@aws-sdk/client-worklink"); // CommonJS import + * const client = new WorkLinkClient(config); + * const command = new ListDevicesCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListDevicesCommandInput} for command's `input` shape. + * @see {@link ListDevicesCommandOutput} for command's `response` shape. + * @see {@link WorkLinkClientResolvedConfig | config} for command's `input` shape. + * */ export class ListDevicesCommand extends $Command< ListDevicesCommandInput, diff --git a/clients/client-worklink/commands/ListDomainsCommand.ts b/clients/client-worklink/commands/ListDomainsCommand.ts index e007517e03be..c3d0404a8507 100644 --- a/clients/client-worklink/commands/ListDomainsCommand.ts +++ b/clients/client-worklink/commands/ListDomainsCommand.ts @@ -22,6 +22,20 @@ export interface ListDomainsCommandOutput extends ListDomainsResponse, __Metadat /** *

Retrieves a list of domains associated to a specified fleet.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { WorkLinkClient, ListDomainsCommand } from "@aws-sdk/client-worklink"; // ES Modules import + * // const { WorkLinkClient, ListDomainsCommand } = require("@aws-sdk/client-worklink"); // CommonJS import + * const client = new WorkLinkClient(config); + * const command = new ListDomainsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListDomainsCommandInput} for command's `input` shape. + * @see {@link ListDomainsCommandOutput} for command's `response` shape. + * @see {@link WorkLinkClientResolvedConfig | config} for command's `input` shape. + * */ export class ListDomainsCommand extends $Command< ListDomainsCommandInput, diff --git a/clients/client-worklink/commands/ListFleetsCommand.ts b/clients/client-worklink/commands/ListFleetsCommand.ts index 716ac08e6dc3..c2b2c315ad77 100644 --- a/clients/client-worklink/commands/ListFleetsCommand.ts +++ b/clients/client-worklink/commands/ListFleetsCommand.ts @@ -22,6 +22,20 @@ export interface ListFleetsCommandOutput extends ListFleetsResponse, __MetadataB /** *

Retrieves a list of fleets for the current account and Region.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { WorkLinkClient, ListFleetsCommand } from "@aws-sdk/client-worklink"; // ES Modules import + * // const { WorkLinkClient, ListFleetsCommand } = require("@aws-sdk/client-worklink"); // CommonJS import + * const client = new WorkLinkClient(config); + * const command = new ListFleetsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListFleetsCommandInput} for command's `input` shape. + * @see {@link ListFleetsCommandOutput} for command's `response` shape. + * @see {@link WorkLinkClientResolvedConfig | config} for command's `input` shape. + * */ export class ListFleetsCommand extends $Command< ListFleetsCommandInput, diff --git a/clients/client-worklink/commands/ListTagsForResourceCommand.ts b/clients/client-worklink/commands/ListTagsForResourceCommand.ts index 21ce851e4cc5..d54c312ab630 100644 --- a/clients/client-worklink/commands/ListTagsForResourceCommand.ts +++ b/clients/client-worklink/commands/ListTagsForResourceCommand.ts @@ -22,6 +22,20 @@ export interface ListTagsForResourceCommandOutput extends ListTagsForResourceRes /** *

Retrieves a list of tags for the specified resource.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { WorkLinkClient, ListTagsForResourceCommand } from "@aws-sdk/client-worklink"; // ES Modules import + * // const { WorkLinkClient, ListTagsForResourceCommand } = require("@aws-sdk/client-worklink"); // CommonJS import + * const client = new WorkLinkClient(config); + * const command = new ListTagsForResourceCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListTagsForResourceCommandInput} for command's `input` shape. + * @see {@link ListTagsForResourceCommandOutput} for command's `response` shape. + * @see {@link WorkLinkClientResolvedConfig | config} for command's `input` shape. + * */ export class ListTagsForResourceCommand extends $Command< ListTagsForResourceCommandInput, diff --git a/clients/client-worklink/commands/ListWebsiteAuthorizationProvidersCommand.ts b/clients/client-worklink/commands/ListWebsiteAuthorizationProvidersCommand.ts index ef30d2702052..979fb3674ade 100644 --- a/clients/client-worklink/commands/ListWebsiteAuthorizationProvidersCommand.ts +++ b/clients/client-worklink/commands/ListWebsiteAuthorizationProvidersCommand.ts @@ -27,6 +27,20 @@ export interface ListWebsiteAuthorizationProvidersCommandOutput /** *

Retrieves a list of website authorization providers associated with a specified fleet.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { WorkLinkClient, ListWebsiteAuthorizationProvidersCommand } from "@aws-sdk/client-worklink"; // ES Modules import + * // const { WorkLinkClient, ListWebsiteAuthorizationProvidersCommand } = require("@aws-sdk/client-worklink"); // CommonJS import + * const client = new WorkLinkClient(config); + * const command = new ListWebsiteAuthorizationProvidersCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListWebsiteAuthorizationProvidersCommandInput} for command's `input` shape. + * @see {@link ListWebsiteAuthorizationProvidersCommandOutput} for command's `response` shape. + * @see {@link WorkLinkClientResolvedConfig | config} for command's `input` shape. + * */ export class ListWebsiteAuthorizationProvidersCommand extends $Command< ListWebsiteAuthorizationProvidersCommandInput, diff --git a/clients/client-worklink/commands/ListWebsiteCertificateAuthoritiesCommand.ts b/clients/client-worklink/commands/ListWebsiteCertificateAuthoritiesCommand.ts index 5c7554db4e31..ad4fdfd634db 100644 --- a/clients/client-worklink/commands/ListWebsiteCertificateAuthoritiesCommand.ts +++ b/clients/client-worklink/commands/ListWebsiteCertificateAuthoritiesCommand.ts @@ -28,6 +28,20 @@ export interface ListWebsiteCertificateAuthoritiesCommandOutput /** *

Retrieves a list of certificate authorities added for the current account and * Region.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { WorkLinkClient, ListWebsiteCertificateAuthoritiesCommand } from "@aws-sdk/client-worklink"; // ES Modules import + * // const { WorkLinkClient, ListWebsiteCertificateAuthoritiesCommand } = require("@aws-sdk/client-worklink"); // CommonJS import + * const client = new WorkLinkClient(config); + * const command = new ListWebsiteCertificateAuthoritiesCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListWebsiteCertificateAuthoritiesCommandInput} for command's `input` shape. + * @see {@link ListWebsiteCertificateAuthoritiesCommandOutput} for command's `response` shape. + * @see {@link WorkLinkClientResolvedConfig | config} for command's `input` shape. + * */ export class ListWebsiteCertificateAuthoritiesCommand extends $Command< ListWebsiteCertificateAuthoritiesCommandInput, diff --git a/clients/client-worklink/commands/RestoreDomainAccessCommand.ts b/clients/client-worklink/commands/RestoreDomainAccessCommand.ts index 02bb683adb72..c4f7914b2df9 100644 --- a/clients/client-worklink/commands/RestoreDomainAccessCommand.ts +++ b/clients/client-worklink/commands/RestoreDomainAccessCommand.ts @@ -22,6 +22,20 @@ export interface RestoreDomainAccessCommandOutput extends RestoreDomainAccessRes /** *

Moves a domain to ACTIVE status if it was in the INACTIVE status.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { WorkLinkClient, RestoreDomainAccessCommand } from "@aws-sdk/client-worklink"; // ES Modules import + * // const { WorkLinkClient, RestoreDomainAccessCommand } = require("@aws-sdk/client-worklink"); // CommonJS import + * const client = new WorkLinkClient(config); + * const command = new RestoreDomainAccessCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link RestoreDomainAccessCommandInput} for command's `input` shape. + * @see {@link RestoreDomainAccessCommandOutput} for command's `response` shape. + * @see {@link WorkLinkClientResolvedConfig | config} for command's `input` shape. + * */ export class RestoreDomainAccessCommand extends $Command< RestoreDomainAccessCommandInput, diff --git a/clients/client-worklink/commands/RevokeDomainAccessCommand.ts b/clients/client-worklink/commands/RevokeDomainAccessCommand.ts index 31cb384d09a3..c8526fada097 100644 --- a/clients/client-worklink/commands/RevokeDomainAccessCommand.ts +++ b/clients/client-worklink/commands/RevokeDomainAccessCommand.ts @@ -22,6 +22,20 @@ export interface RevokeDomainAccessCommandOutput extends RevokeDomainAccessRespo /** *

Moves a domain to INACTIVE status if it was in the ACTIVE status.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { WorkLinkClient, RevokeDomainAccessCommand } from "@aws-sdk/client-worklink"; // ES Modules import + * // const { WorkLinkClient, RevokeDomainAccessCommand } = require("@aws-sdk/client-worklink"); // CommonJS import + * const client = new WorkLinkClient(config); + * const command = new RevokeDomainAccessCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link RevokeDomainAccessCommandInput} for command's `input` shape. + * @see {@link RevokeDomainAccessCommandOutput} for command's `response` shape. + * @see {@link WorkLinkClientResolvedConfig | config} for command's `input` shape. + * */ export class RevokeDomainAccessCommand extends $Command< RevokeDomainAccessCommandInput, diff --git a/clients/client-worklink/commands/SignOutUserCommand.ts b/clients/client-worklink/commands/SignOutUserCommand.ts index c12603ba807f..d52807cb1d2d 100644 --- a/clients/client-worklink/commands/SignOutUserCommand.ts +++ b/clients/client-worklink/commands/SignOutUserCommand.ts @@ -23,6 +23,20 @@ export interface SignOutUserCommandOutput extends SignOutUserResponse, __Metadat /** *

Signs the user out from all of their devices. The user can sign in again if they have * valid credentials.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { WorkLinkClient, SignOutUserCommand } from "@aws-sdk/client-worklink"; // ES Modules import + * // const { WorkLinkClient, SignOutUserCommand } = require("@aws-sdk/client-worklink"); // CommonJS import + * const client = new WorkLinkClient(config); + * const command = new SignOutUserCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link SignOutUserCommandInput} for command's `input` shape. + * @see {@link SignOutUserCommandOutput} for command's `response` shape. + * @see {@link WorkLinkClientResolvedConfig | config} for command's `input` shape. + * */ export class SignOutUserCommand extends $Command< SignOutUserCommandInput, diff --git a/clients/client-worklink/commands/TagResourceCommand.ts b/clients/client-worklink/commands/TagResourceCommand.ts index eee951b93594..2924048532b9 100644 --- a/clients/client-worklink/commands/TagResourceCommand.ts +++ b/clients/client-worklink/commands/TagResourceCommand.ts @@ -22,6 +22,20 @@ export interface TagResourceCommandOutput extends TagResourceResponse, __Metadat /** *

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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { WorkLinkClient, TagResourceCommand } from "@aws-sdk/client-worklink"; // ES Modules import + * // const { WorkLinkClient, TagResourceCommand } = require("@aws-sdk/client-worklink"); // CommonJS import + * const client = new WorkLinkClient(config); + * const command = new TagResourceCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link TagResourceCommandInput} for command's `input` shape. + * @see {@link TagResourceCommandOutput} for command's `response` shape. + * @see {@link WorkLinkClientResolvedConfig | config} for command's `input` shape. + * */ export class TagResourceCommand extends $Command< TagResourceCommandInput, diff --git a/clients/client-worklink/commands/UntagResourceCommand.ts b/clients/client-worklink/commands/UntagResourceCommand.ts index 3ec9e8423c89..39488d8a41e1 100644 --- a/clients/client-worklink/commands/UntagResourceCommand.ts +++ b/clients/client-worklink/commands/UntagResourceCommand.ts @@ -22,6 +22,20 @@ export interface UntagResourceCommandOutput extends UntagResourceResponse, __Met /** *

Removes one or more tags from the specified resource.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { WorkLinkClient, UntagResourceCommand } from "@aws-sdk/client-worklink"; // ES Modules import + * // const { WorkLinkClient, UntagResourceCommand } = require("@aws-sdk/client-worklink"); // CommonJS import + * const client = new WorkLinkClient(config); + * const command = new UntagResourceCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link UntagResourceCommandInput} for command's `input` shape. + * @see {@link UntagResourceCommandOutput} for command's `response` shape. + * @see {@link WorkLinkClientResolvedConfig | config} for command's `input` shape. + * */ export class UntagResourceCommand extends $Command< UntagResourceCommandInput, diff --git a/clients/client-worklink/commands/UpdateAuditStreamConfigurationCommand.ts b/clients/client-worklink/commands/UpdateAuditStreamConfigurationCommand.ts index 9ff29dda35f2..710d3a4abaa3 100644 --- a/clients/client-worklink/commands/UpdateAuditStreamConfigurationCommand.ts +++ b/clients/client-worklink/commands/UpdateAuditStreamConfigurationCommand.ts @@ -24,6 +24,20 @@ export interface UpdateAuditStreamConfigurationCommandOutput /** *

Updates the audit stream configuration for the fleet.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { WorkLinkClient, UpdateAuditStreamConfigurationCommand } from "@aws-sdk/client-worklink"; // ES Modules import + * // const { WorkLinkClient, UpdateAuditStreamConfigurationCommand } = require("@aws-sdk/client-worklink"); // CommonJS import + * const client = new WorkLinkClient(config); + * const command = new UpdateAuditStreamConfigurationCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link UpdateAuditStreamConfigurationCommandInput} for command's `input` shape. + * @see {@link UpdateAuditStreamConfigurationCommandOutput} for command's `response` shape. + * @see {@link WorkLinkClientResolvedConfig | config} for command's `input` shape. + * */ export class UpdateAuditStreamConfigurationCommand extends $Command< UpdateAuditStreamConfigurationCommandInput, diff --git a/clients/client-worklink/commands/UpdateCompanyNetworkConfigurationCommand.ts b/clients/client-worklink/commands/UpdateCompanyNetworkConfigurationCommand.ts index f03350b6829e..502637434172 100644 --- a/clients/client-worklink/commands/UpdateCompanyNetworkConfigurationCommand.ts +++ b/clients/client-worklink/commands/UpdateCompanyNetworkConfigurationCommand.ts @@ -27,6 +27,20 @@ export interface UpdateCompanyNetworkConfigurationCommandOutput /** *

Updates the company network configuration for the fleet.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { WorkLinkClient, UpdateCompanyNetworkConfigurationCommand } from "@aws-sdk/client-worklink"; // ES Modules import + * // const { WorkLinkClient, UpdateCompanyNetworkConfigurationCommand } = require("@aws-sdk/client-worklink"); // CommonJS import + * const client = new WorkLinkClient(config); + * const command = new UpdateCompanyNetworkConfigurationCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link UpdateCompanyNetworkConfigurationCommandInput} for command's `input` shape. + * @see {@link UpdateCompanyNetworkConfigurationCommandOutput} for command's `response` shape. + * @see {@link WorkLinkClientResolvedConfig | config} for command's `input` shape. + * */ export class UpdateCompanyNetworkConfigurationCommand extends $Command< UpdateCompanyNetworkConfigurationCommandInput, diff --git a/clients/client-worklink/commands/UpdateDevicePolicyConfigurationCommand.ts b/clients/client-worklink/commands/UpdateDevicePolicyConfigurationCommand.ts index b3b5cd85a956..575e54db2967 100644 --- a/clients/client-worklink/commands/UpdateDevicePolicyConfigurationCommand.ts +++ b/clients/client-worklink/commands/UpdateDevicePolicyConfigurationCommand.ts @@ -24,6 +24,20 @@ export interface UpdateDevicePolicyConfigurationCommandOutput /** *

Updates the device policy configuration for the fleet.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { WorkLinkClient, UpdateDevicePolicyConfigurationCommand } from "@aws-sdk/client-worklink"; // ES Modules import + * // const { WorkLinkClient, UpdateDevicePolicyConfigurationCommand } = require("@aws-sdk/client-worklink"); // CommonJS import + * const client = new WorkLinkClient(config); + * const command = new UpdateDevicePolicyConfigurationCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link UpdateDevicePolicyConfigurationCommandInput} for command's `input` shape. + * @see {@link UpdateDevicePolicyConfigurationCommandOutput} for command's `response` shape. + * @see {@link WorkLinkClientResolvedConfig | config} for command's `input` shape. + * */ export class UpdateDevicePolicyConfigurationCommand extends $Command< UpdateDevicePolicyConfigurationCommandInput, diff --git a/clients/client-worklink/commands/UpdateDomainMetadataCommand.ts b/clients/client-worklink/commands/UpdateDomainMetadataCommand.ts index 42fddc2bcc11..22569abf8b8f 100644 --- a/clients/client-worklink/commands/UpdateDomainMetadataCommand.ts +++ b/clients/client-worklink/commands/UpdateDomainMetadataCommand.ts @@ -22,6 +22,20 @@ export interface UpdateDomainMetadataCommandOutput extends UpdateDomainMetadataR /** *

Updates domain metadata, such as DisplayName.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { WorkLinkClient, UpdateDomainMetadataCommand } from "@aws-sdk/client-worklink"; // ES Modules import + * // const { WorkLinkClient, UpdateDomainMetadataCommand } = require("@aws-sdk/client-worklink"); // CommonJS import + * const client = new WorkLinkClient(config); + * const command = new UpdateDomainMetadataCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link UpdateDomainMetadataCommandInput} for command's `input` shape. + * @see {@link UpdateDomainMetadataCommandOutput} for command's `response` shape. + * @see {@link WorkLinkClientResolvedConfig | config} for command's `input` shape. + * */ export class UpdateDomainMetadataCommand extends $Command< UpdateDomainMetadataCommandInput, diff --git a/clients/client-worklink/commands/UpdateFleetMetadataCommand.ts b/clients/client-worklink/commands/UpdateFleetMetadataCommand.ts index 173328eefd13..7617167ffe08 100644 --- a/clients/client-worklink/commands/UpdateFleetMetadataCommand.ts +++ b/clients/client-worklink/commands/UpdateFleetMetadataCommand.ts @@ -22,6 +22,20 @@ export interface UpdateFleetMetadataCommandOutput extends UpdateFleetMetadataRes /** *

Updates fleet metadata, such as DisplayName.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { WorkLinkClient, UpdateFleetMetadataCommand } from "@aws-sdk/client-worklink"; // ES Modules import + * // const { WorkLinkClient, UpdateFleetMetadataCommand } = require("@aws-sdk/client-worklink"); // CommonJS import + * const client = new WorkLinkClient(config); + * const command = new UpdateFleetMetadataCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link UpdateFleetMetadataCommandInput} for command's `input` shape. + * @see {@link UpdateFleetMetadataCommandOutput} for command's `response` shape. + * @see {@link WorkLinkClientResolvedConfig | config} for command's `input` shape. + * */ export class UpdateFleetMetadataCommand extends $Command< UpdateFleetMetadataCommandInput, diff --git a/clients/client-worklink/commands/UpdateIdentityProviderConfigurationCommand.ts b/clients/client-worklink/commands/UpdateIdentityProviderConfigurationCommand.ts index 715b85c487a2..6c170b179e1e 100644 --- a/clients/client-worklink/commands/UpdateIdentityProviderConfigurationCommand.ts +++ b/clients/client-worklink/commands/UpdateIdentityProviderConfigurationCommand.ts @@ -27,6 +27,20 @@ export interface UpdateIdentityProviderConfigurationCommandOutput /** *

Updates the identity provider configuration for the fleet.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { WorkLinkClient, UpdateIdentityProviderConfigurationCommand } from "@aws-sdk/client-worklink"; // ES Modules import + * // const { WorkLinkClient, UpdateIdentityProviderConfigurationCommand } = require("@aws-sdk/client-worklink"); // CommonJS import + * const client = new WorkLinkClient(config); + * const command = new UpdateIdentityProviderConfigurationCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link UpdateIdentityProviderConfigurationCommandInput} for command's `input` shape. + * @see {@link UpdateIdentityProviderConfigurationCommandOutput} for command's `response` shape. + * @see {@link WorkLinkClientResolvedConfig | config} for command's `input` shape. + * */ export class UpdateIdentityProviderConfigurationCommand extends $Command< UpdateIdentityProviderConfigurationCommandInput, diff --git a/clients/client-worklink/models/models_0.ts b/clients/client-worklink/models/models_0.ts index b0efd451f83f..e4e1377873f5 100644 --- a/clients/client-worklink/models/models_0.ts +++ b/clients/client-worklink/models/models_0.ts @@ -24,6 +24,9 @@ export interface AssociateDomainRequest { } export namespace AssociateDomainRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: AssociateDomainRequest): any => ({ ...obj, }); @@ -32,6 +35,9 @@ export namespace AssociateDomainRequest { export interface AssociateDomainResponse {} export namespace AssociateDomainResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: AssociateDomainResponse): any => ({ ...obj, }); @@ -47,6 +53,9 @@ export interface InternalServerErrorException extends __SmithyException, $Metada } export namespace InternalServerErrorException { + /** + * @internal + */ export const filterSensitiveLog = (obj: InternalServerErrorException): any => ({ ...obj, }); @@ -62,6 +71,9 @@ export interface InvalidRequestException extends __SmithyException, $MetadataBea } export namespace InvalidRequestException { + /** + * @internal + */ export const filterSensitiveLog = (obj: InvalidRequestException): any => ({ ...obj, }); @@ -77,6 +89,9 @@ export interface ResourceAlreadyExistsException extends __SmithyException, $Meta } export namespace ResourceAlreadyExistsException { + /** + * @internal + */ export const filterSensitiveLog = (obj: ResourceAlreadyExistsException): any => ({ ...obj, }); @@ -92,6 +107,9 @@ export interface ResourceNotFoundException extends __SmithyException, $MetadataB } export namespace ResourceNotFoundException { + /** + * @internal + */ export const filterSensitiveLog = (obj: ResourceNotFoundException): any => ({ ...obj, }); @@ -107,6 +125,9 @@ export interface TooManyRequestsException extends __SmithyException, $MetadataBe } export namespace TooManyRequestsException { + /** + * @internal + */ export const filterSensitiveLog = (obj: TooManyRequestsException): any => ({ ...obj, }); @@ -122,6 +143,9 @@ export interface UnauthorizedException extends __SmithyException, $MetadataBeare } export namespace UnauthorizedException { + /** + * @internal + */ export const filterSensitiveLog = (obj: UnauthorizedException): any => ({ ...obj, }); @@ -150,6 +174,9 @@ export interface AssociateWebsiteAuthorizationProviderRequest { } export namespace AssociateWebsiteAuthorizationProviderRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: AssociateWebsiteAuthorizationProviderRequest): any => ({ ...obj, }); @@ -163,6 +190,9 @@ export interface AssociateWebsiteAuthorizationProviderResponse { } export namespace AssociateWebsiteAuthorizationProviderResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: AssociateWebsiteAuthorizationProviderResponse): any => ({ ...obj, }); @@ -186,6 +216,9 @@ export interface AssociateWebsiteCertificateAuthorityRequest { } export namespace AssociateWebsiteCertificateAuthorityRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: AssociateWebsiteCertificateAuthorityRequest): any => ({ ...obj, }); @@ -199,6 +232,9 @@ export interface AssociateWebsiteCertificateAuthorityResponse { } export namespace AssociateWebsiteCertificateAuthorityResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: AssociateWebsiteCertificateAuthorityResponse): any => ({ ...obj, }); @@ -228,6 +264,9 @@ export interface CreateFleetRequest { } export namespace CreateFleetRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateFleetRequest): any => ({ ...obj, }); @@ -241,6 +280,9 @@ export interface CreateFleetResponse { } export namespace CreateFleetResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateFleetResponse): any => ({ ...obj, }); @@ -254,6 +296,9 @@ export interface DeleteFleetRequest { } export namespace DeleteFleetRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteFleetRequest): any => ({ ...obj, }); @@ -262,6 +307,9 @@ export namespace DeleteFleetRequest { export interface DeleteFleetResponse {} export namespace DeleteFleetResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteFleetResponse): any => ({ ...obj, }); @@ -275,6 +323,9 @@ export interface DescribeAuditStreamConfigurationRequest { } export namespace DescribeAuditStreamConfigurationRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeAuditStreamConfigurationRequest): any => ({ ...obj, }); @@ -288,6 +339,9 @@ export interface DescribeAuditStreamConfigurationResponse { } export namespace DescribeAuditStreamConfigurationResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeAuditStreamConfigurationResponse): any => ({ ...obj, }); @@ -301,6 +355,9 @@ export interface DescribeCompanyNetworkConfigurationRequest { } export namespace DescribeCompanyNetworkConfigurationRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeCompanyNetworkConfigurationRequest): any => ({ ...obj, }); @@ -324,6 +381,9 @@ export interface DescribeCompanyNetworkConfigurationResponse { } export namespace DescribeCompanyNetworkConfigurationResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeCompanyNetworkConfigurationResponse): any => ({ ...obj, }); @@ -342,6 +402,9 @@ export interface DescribeDeviceRequest { } export namespace DescribeDeviceRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeDeviceRequest): any => ({ ...obj, }); @@ -400,6 +463,9 @@ export interface DescribeDeviceResponse { } export namespace DescribeDeviceResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeDeviceResponse): any => ({ ...obj, }); @@ -413,6 +479,9 @@ export interface DescribeDevicePolicyConfigurationRequest { } export namespace DescribeDevicePolicyConfigurationRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeDevicePolicyConfigurationRequest): any => ({ ...obj, }); @@ -426,6 +495,9 @@ export interface DescribeDevicePolicyConfigurationResponse { } export namespace DescribeDevicePolicyConfigurationResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeDevicePolicyConfigurationResponse): any => ({ ...obj, }); @@ -444,6 +516,9 @@ export interface DescribeDomainRequest { } export namespace DescribeDomainRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeDomainRequest): any => ({ ...obj, }); @@ -488,6 +563,9 @@ export interface DescribeDomainResponse { } export namespace DescribeDomainResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeDomainResponse): any => ({ ...obj, }); @@ -501,6 +579,9 @@ export interface DescribeFleetMetadataRequest { } export namespace DescribeFleetMetadataRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeFleetMetadataRequest): any => ({ ...obj, }); @@ -559,6 +640,9 @@ export interface DescribeFleetMetadataResponse { } export namespace DescribeFleetMetadataResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeFleetMetadataResponse): any => ({ ...obj, }); @@ -572,6 +656,9 @@ export interface DescribeIdentityProviderConfigurationRequest { } export namespace DescribeIdentityProviderConfigurationRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeIdentityProviderConfigurationRequest): any => ({ ...obj, }); @@ -599,6 +686,9 @@ export interface DescribeIdentityProviderConfigurationResponse { } export namespace DescribeIdentityProviderConfigurationResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeIdentityProviderConfigurationResponse): any => ({ ...obj, }); @@ -617,6 +707,9 @@ export interface DescribeWebsiteCertificateAuthorityRequest { } export namespace DescribeWebsiteCertificateAuthorityRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeWebsiteCertificateAuthorityRequest): any => ({ ...obj, }); @@ -640,6 +733,9 @@ export interface DescribeWebsiteCertificateAuthorityResponse { } export namespace DescribeWebsiteCertificateAuthorityResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeWebsiteCertificateAuthorityResponse): any => ({ ...obj, }); @@ -661,6 +757,9 @@ export interface DeviceSummary { } export namespace DeviceSummary { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeviceSummary): any => ({ ...obj, }); @@ -679,6 +778,9 @@ export interface DisassociateDomainRequest { } export namespace DisassociateDomainRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DisassociateDomainRequest): any => ({ ...obj, }); @@ -687,6 +789,9 @@ export namespace DisassociateDomainRequest { export interface DisassociateDomainResponse {} export namespace DisassociateDomainResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DisassociateDomainResponse): any => ({ ...obj, }); @@ -705,6 +810,9 @@ export interface DisassociateWebsiteAuthorizationProviderRequest { } export namespace DisassociateWebsiteAuthorizationProviderRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DisassociateWebsiteAuthorizationProviderRequest): any => ({ ...obj, }); @@ -713,6 +821,9 @@ export namespace DisassociateWebsiteAuthorizationProviderRequest { export interface DisassociateWebsiteAuthorizationProviderResponse {} export namespace DisassociateWebsiteAuthorizationProviderResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DisassociateWebsiteAuthorizationProviderResponse): any => ({ ...obj, }); @@ -731,6 +842,9 @@ export interface DisassociateWebsiteCertificateAuthorityRequest { } export namespace DisassociateWebsiteCertificateAuthorityRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DisassociateWebsiteCertificateAuthorityRequest): any => ({ ...obj, }); @@ -739,6 +853,9 @@ export namespace DisassociateWebsiteCertificateAuthorityRequest { export interface DisassociateWebsiteCertificateAuthorityResponse {} export namespace DisassociateWebsiteCertificateAuthorityResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DisassociateWebsiteCertificateAuthorityResponse): any => ({ ...obj, }); @@ -770,6 +887,9 @@ export interface DomainSummary { } export namespace DomainSummary { + /** + * @internal + */ export const filterSensitiveLog = (obj: DomainSummary): any => ({ ...obj, }); @@ -821,6 +941,9 @@ export interface FleetSummary { } export namespace FleetSummary { + /** + * @internal + */ export const filterSensitiveLog = (obj: FleetSummary): any => ({ ...obj, }); @@ -845,6 +968,9 @@ export interface ListDevicesRequest { } export namespace ListDevicesRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListDevicesRequest): any => ({ ...obj, }); @@ -864,6 +990,9 @@ export interface ListDevicesResponse { } export namespace ListDevicesResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListDevicesResponse): any => ({ ...obj, }); @@ -888,6 +1017,9 @@ export interface ListDomainsRequest { } export namespace ListDomainsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListDomainsRequest): any => ({ ...obj, }); @@ -907,6 +1039,9 @@ export interface ListDomainsResponse { } export namespace ListDomainsResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListDomainsResponse): any => ({ ...obj, }); @@ -926,6 +1061,9 @@ export interface ListFleetsRequest { } export namespace ListFleetsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListFleetsRequest): any => ({ ...obj, }); @@ -945,6 +1083,9 @@ export interface ListFleetsResponse { } export namespace ListFleetsResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListFleetsResponse): any => ({ ...obj, }); @@ -958,6 +1099,9 @@ export interface ListTagsForResourceRequest { } export namespace ListTagsForResourceRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListTagsForResourceRequest): any => ({ ...obj, }); @@ -971,6 +1115,9 @@ export interface ListTagsForResourceResponse { } export namespace ListTagsForResourceResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListTagsForResourceResponse): any => ({ ...obj, }); @@ -994,6 +1141,9 @@ export interface ListWebsiteAuthorizationProvidersRequest { } export namespace ListWebsiteAuthorizationProvidersRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListWebsiteAuthorizationProvidersRequest): any => ({ ...obj, }); @@ -1026,6 +1176,9 @@ export interface WebsiteAuthorizationProviderSummary { } export namespace WebsiteAuthorizationProviderSummary { + /** + * @internal + */ export const filterSensitiveLog = (obj: WebsiteAuthorizationProviderSummary): any => ({ ...obj, }); @@ -1044,6 +1197,9 @@ export interface ListWebsiteAuthorizationProvidersResponse { } export namespace ListWebsiteAuthorizationProvidersResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListWebsiteAuthorizationProvidersResponse): any => ({ ...obj, }); @@ -1068,6 +1224,9 @@ export interface ListWebsiteCertificateAuthoritiesRequest { } export namespace ListWebsiteCertificateAuthoritiesRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListWebsiteCertificateAuthoritiesRequest): any => ({ ...obj, }); @@ -1094,6 +1253,9 @@ export interface WebsiteCaSummary { } export namespace WebsiteCaSummary { + /** + * @internal + */ export const filterSensitiveLog = (obj: WebsiteCaSummary): any => ({ ...obj, }); @@ -1113,6 +1275,9 @@ export interface ListWebsiteCertificateAuthoritiesResponse { } export namespace ListWebsiteCertificateAuthoritiesResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListWebsiteCertificateAuthoritiesResponse): any => ({ ...obj, }); @@ -1131,6 +1296,9 @@ export interface RestoreDomainAccessRequest { } export namespace RestoreDomainAccessRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: RestoreDomainAccessRequest): any => ({ ...obj, }); @@ -1139,6 +1307,9 @@ export namespace RestoreDomainAccessRequest { export interface RestoreDomainAccessResponse {} export namespace RestoreDomainAccessResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: RestoreDomainAccessResponse): any => ({ ...obj, }); @@ -1157,6 +1328,9 @@ export interface RevokeDomainAccessRequest { } export namespace RevokeDomainAccessRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: RevokeDomainAccessRequest): any => ({ ...obj, }); @@ -1165,6 +1339,9 @@ export namespace RevokeDomainAccessRequest { export interface RevokeDomainAccessResponse {} export namespace RevokeDomainAccessResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: RevokeDomainAccessResponse): any => ({ ...obj, }); @@ -1183,6 +1360,9 @@ export interface SignOutUserRequest { } export namespace SignOutUserRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: SignOutUserRequest): any => ({ ...obj, }); @@ -1191,6 +1371,9 @@ export namespace SignOutUserRequest { export interface SignOutUserResponse {} export namespace SignOutUserResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: SignOutUserResponse): any => ({ ...obj, }); @@ -1209,6 +1392,9 @@ export interface TagResourceRequest { } export namespace TagResourceRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: TagResourceRequest): any => ({ ...obj, }); @@ -1217,6 +1403,9 @@ export namespace TagResourceRequest { export interface TagResourceResponse {} export namespace TagResourceResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: TagResourceResponse): any => ({ ...obj, }); @@ -1235,6 +1424,9 @@ export interface UntagResourceRequest { } export namespace UntagResourceRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: UntagResourceRequest): any => ({ ...obj, }); @@ -1243,6 +1435,9 @@ export namespace UntagResourceRequest { export interface UntagResourceResponse {} export namespace UntagResourceResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: UntagResourceResponse): any => ({ ...obj, }); @@ -1261,6 +1456,9 @@ export interface UpdateAuditStreamConfigurationRequest { } export namespace UpdateAuditStreamConfigurationRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateAuditStreamConfigurationRequest): any => ({ ...obj, }); @@ -1269,6 +1467,9 @@ export namespace UpdateAuditStreamConfigurationRequest { export interface UpdateAuditStreamConfigurationResponse {} export namespace UpdateAuditStreamConfigurationResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateAuditStreamConfigurationResponse): any => ({ ...obj, }); @@ -1297,6 +1498,9 @@ export interface UpdateCompanyNetworkConfigurationRequest { } export namespace UpdateCompanyNetworkConfigurationRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateCompanyNetworkConfigurationRequest): any => ({ ...obj, }); @@ -1305,6 +1509,9 @@ export namespace UpdateCompanyNetworkConfigurationRequest { export interface UpdateCompanyNetworkConfigurationResponse {} export namespace UpdateCompanyNetworkConfigurationResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateCompanyNetworkConfigurationResponse): any => ({ ...obj, }); @@ -1323,6 +1530,9 @@ export interface UpdateDevicePolicyConfigurationRequest { } export namespace UpdateDevicePolicyConfigurationRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateDevicePolicyConfigurationRequest): any => ({ ...obj, }); @@ -1331,6 +1541,9 @@ export namespace UpdateDevicePolicyConfigurationRequest { export interface UpdateDevicePolicyConfigurationResponse {} export namespace UpdateDevicePolicyConfigurationResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateDevicePolicyConfigurationResponse): any => ({ ...obj, }); @@ -1354,6 +1567,9 @@ export interface UpdateDomainMetadataRequest { } export namespace UpdateDomainMetadataRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateDomainMetadataRequest): any => ({ ...obj, }); @@ -1362,6 +1578,9 @@ export namespace UpdateDomainMetadataRequest { export interface UpdateDomainMetadataResponse {} export namespace UpdateDomainMetadataResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateDomainMetadataResponse): any => ({ ...obj, }); @@ -1386,6 +1605,9 @@ export interface UpdateFleetMetadataRequest { } export namespace UpdateFleetMetadataRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateFleetMetadataRequest): any => ({ ...obj, }); @@ -1394,6 +1616,9 @@ export namespace UpdateFleetMetadataRequest { export interface UpdateFleetMetadataResponse {} export namespace UpdateFleetMetadataResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateFleetMetadataResponse): any => ({ ...obj, }); @@ -1418,6 +1643,9 @@ export interface UpdateIdentityProviderConfigurationRequest { } export namespace UpdateIdentityProviderConfigurationRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateIdentityProviderConfigurationRequest): any => ({ ...obj, }); @@ -1426,6 +1654,9 @@ export namespace UpdateIdentityProviderConfigurationRequest { export interface UpdateIdentityProviderConfigurationResponse {} export namespace UpdateIdentityProviderConfigurationResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateIdentityProviderConfigurationResponse): any => ({ ...obj, }); diff --git a/clients/client-workmail/commands/AssociateDelegateToResourceCommand.ts b/clients/client-workmail/commands/AssociateDelegateToResourceCommand.ts index 4ce5da111830..a13bae082bd7 100644 --- a/clients/client-workmail/commands/AssociateDelegateToResourceCommand.ts +++ b/clients/client-workmail/commands/AssociateDelegateToResourceCommand.ts @@ -24,6 +24,20 @@ export interface AssociateDelegateToResourceCommandOutput /** *

Adds a member (user or group) to the resource's set of delegates.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { WorkMailClient, AssociateDelegateToResourceCommand } from "@aws-sdk/client-workmail"; // ES Modules import + * // const { WorkMailClient, AssociateDelegateToResourceCommand } = require("@aws-sdk/client-workmail"); // CommonJS import + * const client = new WorkMailClient(config); + * const command = new AssociateDelegateToResourceCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link AssociateDelegateToResourceCommandInput} for command's `input` shape. + * @see {@link AssociateDelegateToResourceCommandOutput} for command's `response` shape. + * @see {@link WorkMailClientResolvedConfig | config} for command's `input` shape. + * */ export class AssociateDelegateToResourceCommand extends $Command< AssociateDelegateToResourceCommandInput, diff --git a/clients/client-workmail/commands/AssociateMemberToGroupCommand.ts b/clients/client-workmail/commands/AssociateMemberToGroupCommand.ts index accdac386011..c1a899eb2b58 100644 --- a/clients/client-workmail/commands/AssociateMemberToGroupCommand.ts +++ b/clients/client-workmail/commands/AssociateMemberToGroupCommand.ts @@ -22,6 +22,20 @@ export interface AssociateMemberToGroupCommandOutput extends AssociateMemberToGr /** *

Adds a member (user or group) to the group's set.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { WorkMailClient, AssociateMemberToGroupCommand } from "@aws-sdk/client-workmail"; // ES Modules import + * // const { WorkMailClient, AssociateMemberToGroupCommand } = require("@aws-sdk/client-workmail"); // CommonJS import + * const client = new WorkMailClient(config); + * const command = new AssociateMemberToGroupCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link AssociateMemberToGroupCommandInput} for command's `input` shape. + * @see {@link AssociateMemberToGroupCommandOutput} for command's `response` shape. + * @see {@link WorkMailClientResolvedConfig | config} for command's `input` shape. + * */ export class AssociateMemberToGroupCommand extends $Command< AssociateMemberToGroupCommandInput, diff --git a/clients/client-workmail/commands/CancelMailboxExportJobCommand.ts b/clients/client-workmail/commands/CancelMailboxExportJobCommand.ts index 53ed33bab434..94bd432f8793 100644 --- a/clients/client-workmail/commands/CancelMailboxExportJobCommand.ts +++ b/clients/client-workmail/commands/CancelMailboxExportJobCommand.ts @@ -26,6 +26,20 @@ export interface CancelMailboxExportJobCommandOutput extends CancelMailboxExport *

If the mailbox export job is near completion, it might not be possible to cancel * it.

* + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { WorkMailClient, CancelMailboxExportJobCommand } from "@aws-sdk/client-workmail"; // ES Modules import + * // const { WorkMailClient, CancelMailboxExportJobCommand } = require("@aws-sdk/client-workmail"); // CommonJS import + * const client = new WorkMailClient(config); + * const command = new CancelMailboxExportJobCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CancelMailboxExportJobCommandInput} for command's `input` shape. + * @see {@link CancelMailboxExportJobCommandOutput} for command's `response` shape. + * @see {@link WorkMailClientResolvedConfig | config} for command's `input` shape. + * */ export class CancelMailboxExportJobCommand extends $Command< CancelMailboxExportJobCommandInput, diff --git a/clients/client-workmail/commands/CreateAliasCommand.ts b/clients/client-workmail/commands/CreateAliasCommand.ts index 35b77cc2fd0d..c7e484801537 100644 --- a/clients/client-workmail/commands/CreateAliasCommand.ts +++ b/clients/client-workmail/commands/CreateAliasCommand.ts @@ -22,6 +22,20 @@ export interface CreateAliasCommandOutput extends CreateAliasResponse, __Metadat /** *

Adds an alias to the set of a given member (user or group) of Amazon WorkMail.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { WorkMailClient, CreateAliasCommand } from "@aws-sdk/client-workmail"; // ES Modules import + * // const { WorkMailClient, CreateAliasCommand } = require("@aws-sdk/client-workmail"); // CommonJS import + * const client = new WorkMailClient(config); + * const command = new CreateAliasCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreateAliasCommandInput} for command's `input` shape. + * @see {@link CreateAliasCommandOutput} for command's `response` shape. + * @see {@link WorkMailClientResolvedConfig | config} for command's `input` shape. + * */ export class CreateAliasCommand extends $Command< CreateAliasCommandInput, diff --git a/clients/client-workmail/commands/CreateGroupCommand.ts b/clients/client-workmail/commands/CreateGroupCommand.ts index c86fd8197166..a56b9d0a302a 100644 --- a/clients/client-workmail/commands/CreateGroupCommand.ts +++ b/clients/client-workmail/commands/CreateGroupCommand.ts @@ -22,6 +22,20 @@ export interface CreateGroupCommandOutput extends CreateGroupResponse, __Metadat /** *

Creates a group that can be used in Amazon WorkMail by calling the RegisterToWorkMail operation.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { WorkMailClient, CreateGroupCommand } from "@aws-sdk/client-workmail"; // ES Modules import + * // const { WorkMailClient, CreateGroupCommand } = require("@aws-sdk/client-workmail"); // CommonJS import + * const client = new WorkMailClient(config); + * const command = new CreateGroupCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreateGroupCommandInput} for command's `input` shape. + * @see {@link CreateGroupCommandOutput} for command's `response` shape. + * @see {@link WorkMailClientResolvedConfig | config} for command's `input` shape. + * */ export class CreateGroupCommand extends $Command< CreateGroupCommandInput, diff --git a/clients/client-workmail/commands/CreateMobileDeviceAccessRuleCommand.ts b/clients/client-workmail/commands/CreateMobileDeviceAccessRuleCommand.ts index 2f9f61b13ba7..ba9ed79981f8 100644 --- a/clients/client-workmail/commands/CreateMobileDeviceAccessRuleCommand.ts +++ b/clients/client-workmail/commands/CreateMobileDeviceAccessRuleCommand.ts @@ -24,6 +24,20 @@ export interface CreateMobileDeviceAccessRuleCommandOutput /** *

Creates a new mobile device access rule for the specified Amazon WorkMail organization.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { WorkMailClient, CreateMobileDeviceAccessRuleCommand } from "@aws-sdk/client-workmail"; // ES Modules import + * // const { WorkMailClient, CreateMobileDeviceAccessRuleCommand } = require("@aws-sdk/client-workmail"); // CommonJS import + * const client = new WorkMailClient(config); + * const command = new CreateMobileDeviceAccessRuleCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreateMobileDeviceAccessRuleCommandInput} for command's `input` shape. + * @see {@link CreateMobileDeviceAccessRuleCommandOutput} for command's `response` shape. + * @see {@link WorkMailClientResolvedConfig | config} for command's `input` shape. + * */ export class CreateMobileDeviceAccessRuleCommand extends $Command< CreateMobileDeviceAccessRuleCommandInput, diff --git a/clients/client-workmail/commands/CreateOrganizationCommand.ts b/clients/client-workmail/commands/CreateOrganizationCommand.ts index b5eaadfa70bf..e4d0b93f1545 100644 --- a/clients/client-workmail/commands/CreateOrganizationCommand.ts +++ b/clients/client-workmail/commands/CreateOrganizationCommand.ts @@ -26,6 +26,20 @@ export interface CreateOrganizationCommandOutput extends CreateOrganizationRespo *

Optionally, you can use a customer managed master key from AWS Key Management Service * (AWS KMS) to encrypt email for your organization. If you don't associate an AWS KMS key, Amazon WorkMail creates a * default AWS managed master key for you.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { WorkMailClient, CreateOrganizationCommand } from "@aws-sdk/client-workmail"; // ES Modules import + * // const { WorkMailClient, CreateOrganizationCommand } = require("@aws-sdk/client-workmail"); // CommonJS import + * const client = new WorkMailClient(config); + * const command = new CreateOrganizationCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreateOrganizationCommandInput} for command's `input` shape. + * @see {@link CreateOrganizationCommandOutput} for command's `response` shape. + * @see {@link WorkMailClientResolvedConfig | config} for command's `input` shape. + * */ export class CreateOrganizationCommand extends $Command< CreateOrganizationCommandInput, diff --git a/clients/client-workmail/commands/CreateResourceCommand.ts b/clients/client-workmail/commands/CreateResourceCommand.ts index 11b2420b293e..b6b12d275947 100644 --- a/clients/client-workmail/commands/CreateResourceCommand.ts +++ b/clients/client-workmail/commands/CreateResourceCommand.ts @@ -22,6 +22,20 @@ export interface CreateResourceCommandOutput extends CreateResourceResponse, __M /** *

Creates a new Amazon WorkMail resource.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { WorkMailClient, CreateResourceCommand } from "@aws-sdk/client-workmail"; // ES Modules import + * // const { WorkMailClient, CreateResourceCommand } = require("@aws-sdk/client-workmail"); // CommonJS import + * const client = new WorkMailClient(config); + * const command = new CreateResourceCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreateResourceCommandInput} for command's `input` shape. + * @see {@link CreateResourceCommandOutput} for command's `response` shape. + * @see {@link WorkMailClientResolvedConfig | config} for command's `input` shape. + * */ export class CreateResourceCommand extends $Command< CreateResourceCommandInput, diff --git a/clients/client-workmail/commands/CreateUserCommand.ts b/clients/client-workmail/commands/CreateUserCommand.ts index 1cbb82188519..87f09d445b72 100644 --- a/clients/client-workmail/commands/CreateUserCommand.ts +++ b/clients/client-workmail/commands/CreateUserCommand.ts @@ -22,6 +22,20 @@ export interface CreateUserCommandOutput extends CreateUserResponse, __MetadataB /** *

Creates a user who can be used in Amazon WorkMail by calling the RegisterToWorkMail operation.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { WorkMailClient, CreateUserCommand } from "@aws-sdk/client-workmail"; // ES Modules import + * // const { WorkMailClient, CreateUserCommand } = require("@aws-sdk/client-workmail"); // CommonJS import + * const client = new WorkMailClient(config); + * const command = new CreateUserCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreateUserCommandInput} for command's `input` shape. + * @see {@link CreateUserCommandOutput} for command's `response` shape. + * @see {@link WorkMailClientResolvedConfig | config} for command's `input` shape. + * */ export class CreateUserCommand extends $Command< CreateUserCommandInput, diff --git a/clients/client-workmail/commands/DeleteAccessControlRuleCommand.ts b/clients/client-workmail/commands/DeleteAccessControlRuleCommand.ts index ea77709df79e..f94917caca5b 100644 --- a/clients/client-workmail/commands/DeleteAccessControlRuleCommand.ts +++ b/clients/client-workmail/commands/DeleteAccessControlRuleCommand.ts @@ -22,6 +22,20 @@ export interface DeleteAccessControlRuleCommandOutput extends DeleteAccessContro /** *

Deletes an access control rule for the specified WorkMail organization.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { WorkMailClient, DeleteAccessControlRuleCommand } from "@aws-sdk/client-workmail"; // ES Modules import + * // const { WorkMailClient, DeleteAccessControlRuleCommand } = require("@aws-sdk/client-workmail"); // CommonJS import + * const client = new WorkMailClient(config); + * const command = new DeleteAccessControlRuleCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteAccessControlRuleCommandInput} for command's `input` shape. + * @see {@link DeleteAccessControlRuleCommandOutput} for command's `response` shape. + * @see {@link WorkMailClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteAccessControlRuleCommand extends $Command< DeleteAccessControlRuleCommandInput, diff --git a/clients/client-workmail/commands/DeleteAliasCommand.ts b/clients/client-workmail/commands/DeleteAliasCommand.ts index 683689386b1a..4c562920243b 100644 --- a/clients/client-workmail/commands/DeleteAliasCommand.ts +++ b/clients/client-workmail/commands/DeleteAliasCommand.ts @@ -23,6 +23,20 @@ export interface DeleteAliasCommandOutput extends DeleteAliasResponse, __Metadat /** *

Remove one or more specified aliases from a set of aliases for a given * user.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { WorkMailClient, DeleteAliasCommand } from "@aws-sdk/client-workmail"; // ES Modules import + * // const { WorkMailClient, DeleteAliasCommand } = require("@aws-sdk/client-workmail"); // CommonJS import + * const client = new WorkMailClient(config); + * const command = new DeleteAliasCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteAliasCommandInput} for command's `input` shape. + * @see {@link DeleteAliasCommandOutput} for command's `response` shape. + * @see {@link WorkMailClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteAliasCommand extends $Command< DeleteAliasCommandInput, diff --git a/clients/client-workmail/commands/DeleteGroupCommand.ts b/clients/client-workmail/commands/DeleteGroupCommand.ts index a20b56ff1cc0..e34c672d0bcf 100644 --- a/clients/client-workmail/commands/DeleteGroupCommand.ts +++ b/clients/client-workmail/commands/DeleteGroupCommand.ts @@ -22,6 +22,20 @@ export interface DeleteGroupCommandOutput extends DeleteGroupResponse, __Metadat /** *

Deletes a group from Amazon WorkMail.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { WorkMailClient, DeleteGroupCommand } from "@aws-sdk/client-workmail"; // ES Modules import + * // const { WorkMailClient, DeleteGroupCommand } = require("@aws-sdk/client-workmail"); // CommonJS import + * const client = new WorkMailClient(config); + * const command = new DeleteGroupCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteGroupCommandInput} for command's `input` shape. + * @see {@link DeleteGroupCommandOutput} for command's `response` shape. + * @see {@link WorkMailClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteGroupCommand extends $Command< DeleteGroupCommandInput, diff --git a/clients/client-workmail/commands/DeleteMailboxPermissionsCommand.ts b/clients/client-workmail/commands/DeleteMailboxPermissionsCommand.ts index 5302639d13af..d068ea3a363b 100644 --- a/clients/client-workmail/commands/DeleteMailboxPermissionsCommand.ts +++ b/clients/client-workmail/commands/DeleteMailboxPermissionsCommand.ts @@ -22,6 +22,20 @@ export interface DeleteMailboxPermissionsCommandOutput extends DeleteMailboxPerm /** *

Deletes permissions granted to a member (user or group).

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { WorkMailClient, DeleteMailboxPermissionsCommand } from "@aws-sdk/client-workmail"; // ES Modules import + * // const { WorkMailClient, DeleteMailboxPermissionsCommand } = require("@aws-sdk/client-workmail"); // CommonJS import + * const client = new WorkMailClient(config); + * const command = new DeleteMailboxPermissionsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteMailboxPermissionsCommandInput} for command's `input` shape. + * @see {@link DeleteMailboxPermissionsCommandOutput} for command's `response` shape. + * @see {@link WorkMailClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteMailboxPermissionsCommand extends $Command< DeleteMailboxPermissionsCommandInput, diff --git a/clients/client-workmail/commands/DeleteMobileDeviceAccessRuleCommand.ts b/clients/client-workmail/commands/DeleteMobileDeviceAccessRuleCommand.ts index 4d69787a28ef..2c8d94e4efe6 100644 --- a/clients/client-workmail/commands/DeleteMobileDeviceAccessRuleCommand.ts +++ b/clients/client-workmail/commands/DeleteMobileDeviceAccessRuleCommand.ts @@ -24,6 +24,20 @@ export interface DeleteMobileDeviceAccessRuleCommandOutput /** *

Deletes a mobile device access rule for the specified Amazon WorkMail organization.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { WorkMailClient, DeleteMobileDeviceAccessRuleCommand } from "@aws-sdk/client-workmail"; // ES Modules import + * // const { WorkMailClient, DeleteMobileDeviceAccessRuleCommand } = require("@aws-sdk/client-workmail"); // CommonJS import + * const client = new WorkMailClient(config); + * const command = new DeleteMobileDeviceAccessRuleCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteMobileDeviceAccessRuleCommandInput} for command's `input` shape. + * @see {@link DeleteMobileDeviceAccessRuleCommandOutput} for command's `response` shape. + * @see {@link WorkMailClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteMobileDeviceAccessRuleCommand extends $Command< DeleteMobileDeviceAccessRuleCommandInput, diff --git a/clients/client-workmail/commands/DeleteOrganizationCommand.ts b/clients/client-workmail/commands/DeleteOrganizationCommand.ts index b6e1492664bd..aadaf9c83bfb 100644 --- a/clients/client-workmail/commands/DeleteOrganizationCommand.ts +++ b/clients/client-workmail/commands/DeleteOrganizationCommand.ts @@ -22,6 +22,20 @@ export interface DeleteOrganizationCommandOutput extends DeleteOrganizationRespo /** *

Deletes an Amazon WorkMail organization and all underlying AWS resources managed by Amazon WorkMail as part of the organization. You can choose whether to delete the associated directory. For more information, see Removing an organization in the Amazon WorkMail Administrator Guide.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { WorkMailClient, DeleteOrganizationCommand } from "@aws-sdk/client-workmail"; // ES Modules import + * // const { WorkMailClient, DeleteOrganizationCommand } = require("@aws-sdk/client-workmail"); // CommonJS import + * const client = new WorkMailClient(config); + * const command = new DeleteOrganizationCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteOrganizationCommandInput} for command's `input` shape. + * @see {@link DeleteOrganizationCommandOutput} for command's `response` shape. + * @see {@link WorkMailClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteOrganizationCommand extends $Command< DeleteOrganizationCommandInput, diff --git a/clients/client-workmail/commands/DeleteResourceCommand.ts b/clients/client-workmail/commands/DeleteResourceCommand.ts index 7578fa88d065..5c90e8a490bb 100644 --- a/clients/client-workmail/commands/DeleteResourceCommand.ts +++ b/clients/client-workmail/commands/DeleteResourceCommand.ts @@ -22,6 +22,20 @@ export interface DeleteResourceCommandOutput extends DeleteResourceResponse, __M /** *

Deletes the specified resource.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { WorkMailClient, DeleteResourceCommand } from "@aws-sdk/client-workmail"; // ES Modules import + * // const { WorkMailClient, DeleteResourceCommand } = require("@aws-sdk/client-workmail"); // CommonJS import + * const client = new WorkMailClient(config); + * const command = new DeleteResourceCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteResourceCommandInput} for command's `input` shape. + * @see {@link DeleteResourceCommandOutput} for command's `response` shape. + * @see {@link WorkMailClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteResourceCommand extends $Command< DeleteResourceCommandInput, diff --git a/clients/client-workmail/commands/DeleteRetentionPolicyCommand.ts b/clients/client-workmail/commands/DeleteRetentionPolicyCommand.ts index d9906a470788..8c6b717128b2 100644 --- a/clients/client-workmail/commands/DeleteRetentionPolicyCommand.ts +++ b/clients/client-workmail/commands/DeleteRetentionPolicyCommand.ts @@ -22,6 +22,20 @@ export interface DeleteRetentionPolicyCommandOutput extends DeleteRetentionPolic /** *

Deletes the specified retention policy from the specified organization.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { WorkMailClient, DeleteRetentionPolicyCommand } from "@aws-sdk/client-workmail"; // ES Modules import + * // const { WorkMailClient, DeleteRetentionPolicyCommand } = require("@aws-sdk/client-workmail"); // CommonJS import + * const client = new WorkMailClient(config); + * const command = new DeleteRetentionPolicyCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteRetentionPolicyCommandInput} for command's `input` shape. + * @see {@link DeleteRetentionPolicyCommandOutput} for command's `response` shape. + * @see {@link WorkMailClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteRetentionPolicyCommand extends $Command< DeleteRetentionPolicyCommandInput, diff --git a/clients/client-workmail/commands/DeleteUserCommand.ts b/clients/client-workmail/commands/DeleteUserCommand.ts index 068743b30961..f7b52a0c90e6 100644 --- a/clients/client-workmail/commands/DeleteUserCommand.ts +++ b/clients/client-workmail/commands/DeleteUserCommand.ts @@ -26,6 +26,20 @@ export interface DeleteUserCommandOutput extends DeleteUserResponse, __MetadataB * 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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { WorkMailClient, DeleteUserCommand } from "@aws-sdk/client-workmail"; // ES Modules import + * // const { WorkMailClient, DeleteUserCommand } = require("@aws-sdk/client-workmail"); // CommonJS import + * const client = new WorkMailClient(config); + * const command = new DeleteUserCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteUserCommandInput} for command's `input` shape. + * @see {@link DeleteUserCommandOutput} for command's `response` shape. + * @see {@link WorkMailClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteUserCommand extends $Command< DeleteUserCommandInput, diff --git a/clients/client-workmail/commands/DeregisterFromWorkMailCommand.ts b/clients/client-workmail/commands/DeregisterFromWorkMailCommand.ts index bbc6d2195023..d0e324822dd3 100644 --- a/clients/client-workmail/commands/DeregisterFromWorkMailCommand.ts +++ b/clients/client-workmail/commands/DeregisterFromWorkMailCommand.ts @@ -25,6 +25,20 @@ export interface DeregisterFromWorkMailCommandOutput extends DeregisterFromWorkM * 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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { WorkMailClient, DeregisterFromWorkMailCommand } from "@aws-sdk/client-workmail"; // ES Modules import + * // const { WorkMailClient, DeregisterFromWorkMailCommand } = require("@aws-sdk/client-workmail"); // CommonJS import + * const client = new WorkMailClient(config); + * const command = new DeregisterFromWorkMailCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeregisterFromWorkMailCommandInput} for command's `input` shape. + * @see {@link DeregisterFromWorkMailCommandOutput} for command's `response` shape. + * @see {@link WorkMailClientResolvedConfig | config} for command's `input` shape. + * */ export class DeregisterFromWorkMailCommand extends $Command< DeregisterFromWorkMailCommandInput, diff --git a/clients/client-workmail/commands/DescribeGroupCommand.ts b/clients/client-workmail/commands/DescribeGroupCommand.ts index 70dba966665d..a1ff4b99f1c8 100644 --- a/clients/client-workmail/commands/DescribeGroupCommand.ts +++ b/clients/client-workmail/commands/DescribeGroupCommand.ts @@ -22,6 +22,20 @@ export interface DescribeGroupCommandOutput extends DescribeGroupResponse, __Met /** *

Returns the data available for the group.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { WorkMailClient, DescribeGroupCommand } from "@aws-sdk/client-workmail"; // ES Modules import + * // const { WorkMailClient, DescribeGroupCommand } = require("@aws-sdk/client-workmail"); // CommonJS import + * const client = new WorkMailClient(config); + * const command = new DescribeGroupCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeGroupCommandInput} for command's `input` shape. + * @see {@link DescribeGroupCommandOutput} for command's `response` shape. + * @see {@link WorkMailClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeGroupCommand extends $Command< DescribeGroupCommandInput, diff --git a/clients/client-workmail/commands/DescribeMailboxExportJobCommand.ts b/clients/client-workmail/commands/DescribeMailboxExportJobCommand.ts index abfc2fe81b2f..338d3c021a28 100644 --- a/clients/client-workmail/commands/DescribeMailboxExportJobCommand.ts +++ b/clients/client-workmail/commands/DescribeMailboxExportJobCommand.ts @@ -22,6 +22,20 @@ export interface DescribeMailboxExportJobCommandOutput extends DescribeMailboxEx /** *

Describes the current status of a mailbox export job.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { WorkMailClient, DescribeMailboxExportJobCommand } from "@aws-sdk/client-workmail"; // ES Modules import + * // const { WorkMailClient, DescribeMailboxExportJobCommand } = require("@aws-sdk/client-workmail"); // CommonJS import + * const client = new WorkMailClient(config); + * const command = new DescribeMailboxExportJobCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeMailboxExportJobCommandInput} for command's `input` shape. + * @see {@link DescribeMailboxExportJobCommandOutput} for command's `response` shape. + * @see {@link WorkMailClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeMailboxExportJobCommand extends $Command< DescribeMailboxExportJobCommandInput, diff --git a/clients/client-workmail/commands/DescribeOrganizationCommand.ts b/clients/client-workmail/commands/DescribeOrganizationCommand.ts index 6b6053e64536..3b9cb7c1da04 100644 --- a/clients/client-workmail/commands/DescribeOrganizationCommand.ts +++ b/clients/client-workmail/commands/DescribeOrganizationCommand.ts @@ -23,6 +23,20 @@ export interface DescribeOrganizationCommandOutput extends DescribeOrganizationR /** *

Provides more information regarding a given organization based on its * identifier.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { WorkMailClient, DescribeOrganizationCommand } from "@aws-sdk/client-workmail"; // ES Modules import + * // const { WorkMailClient, DescribeOrganizationCommand } = require("@aws-sdk/client-workmail"); // CommonJS import + * const client = new WorkMailClient(config); + * const command = new DescribeOrganizationCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeOrganizationCommandInput} for command's `input` shape. + * @see {@link DescribeOrganizationCommandOutput} for command's `response` shape. + * @see {@link WorkMailClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeOrganizationCommand extends $Command< DescribeOrganizationCommandInput, diff --git a/clients/client-workmail/commands/DescribeResourceCommand.ts b/clients/client-workmail/commands/DescribeResourceCommand.ts index bcfeda9fa4bf..2059255b1bbd 100644 --- a/clients/client-workmail/commands/DescribeResourceCommand.ts +++ b/clients/client-workmail/commands/DescribeResourceCommand.ts @@ -22,6 +22,20 @@ export interface DescribeResourceCommandOutput extends DescribeResourceResponse, /** *

Returns the data available for the resource.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { WorkMailClient, DescribeResourceCommand } from "@aws-sdk/client-workmail"; // ES Modules import + * // const { WorkMailClient, DescribeResourceCommand } = require("@aws-sdk/client-workmail"); // CommonJS import + * const client = new WorkMailClient(config); + * const command = new DescribeResourceCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeResourceCommandInput} for command's `input` shape. + * @see {@link DescribeResourceCommandOutput} for command's `response` shape. + * @see {@link WorkMailClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeResourceCommand extends $Command< DescribeResourceCommandInput, diff --git a/clients/client-workmail/commands/DescribeUserCommand.ts b/clients/client-workmail/commands/DescribeUserCommand.ts index 9e8fd2c63f94..9d198ba57e4a 100644 --- a/clients/client-workmail/commands/DescribeUserCommand.ts +++ b/clients/client-workmail/commands/DescribeUserCommand.ts @@ -22,6 +22,20 @@ export interface DescribeUserCommandOutput extends DescribeUserResponse, __Metad /** *

Provides information regarding the user.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { WorkMailClient, DescribeUserCommand } from "@aws-sdk/client-workmail"; // ES Modules import + * // const { WorkMailClient, DescribeUserCommand } = require("@aws-sdk/client-workmail"); // CommonJS import + * const client = new WorkMailClient(config); + * const command = new DescribeUserCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeUserCommandInput} for command's `input` shape. + * @see {@link DescribeUserCommandOutput} for command's `response` shape. + * @see {@link WorkMailClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeUserCommand extends $Command< DescribeUserCommandInput, diff --git a/clients/client-workmail/commands/DisassociateDelegateFromResourceCommand.ts b/clients/client-workmail/commands/DisassociateDelegateFromResourceCommand.ts index 7518d5de4ebc..29643c8c25ac 100644 --- a/clients/client-workmail/commands/DisassociateDelegateFromResourceCommand.ts +++ b/clients/client-workmail/commands/DisassociateDelegateFromResourceCommand.ts @@ -24,6 +24,20 @@ export interface DisassociateDelegateFromResourceCommandOutput /** *

Removes a member from the resource's set of delegates.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { WorkMailClient, DisassociateDelegateFromResourceCommand } from "@aws-sdk/client-workmail"; // ES Modules import + * // const { WorkMailClient, DisassociateDelegateFromResourceCommand } = require("@aws-sdk/client-workmail"); // CommonJS import + * const client = new WorkMailClient(config); + * const command = new DisassociateDelegateFromResourceCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DisassociateDelegateFromResourceCommandInput} for command's `input` shape. + * @see {@link DisassociateDelegateFromResourceCommandOutput} for command's `response` shape. + * @see {@link WorkMailClientResolvedConfig | config} for command's `input` shape. + * */ export class DisassociateDelegateFromResourceCommand extends $Command< DisassociateDelegateFromResourceCommandInput, diff --git a/clients/client-workmail/commands/DisassociateMemberFromGroupCommand.ts b/clients/client-workmail/commands/DisassociateMemberFromGroupCommand.ts index 7d04804199de..97a4335420d0 100644 --- a/clients/client-workmail/commands/DisassociateMemberFromGroupCommand.ts +++ b/clients/client-workmail/commands/DisassociateMemberFromGroupCommand.ts @@ -24,6 +24,20 @@ export interface DisassociateMemberFromGroupCommandOutput /** *

Removes a member from a group.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { WorkMailClient, DisassociateMemberFromGroupCommand } from "@aws-sdk/client-workmail"; // ES Modules import + * // const { WorkMailClient, DisassociateMemberFromGroupCommand } = require("@aws-sdk/client-workmail"); // CommonJS import + * const client = new WorkMailClient(config); + * const command = new DisassociateMemberFromGroupCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DisassociateMemberFromGroupCommandInput} for command's `input` shape. + * @see {@link DisassociateMemberFromGroupCommandOutput} for command's `response` shape. + * @see {@link WorkMailClientResolvedConfig | config} for command's `input` shape. + * */ export class DisassociateMemberFromGroupCommand extends $Command< DisassociateMemberFromGroupCommandInput, diff --git a/clients/client-workmail/commands/GetAccessControlEffectCommand.ts b/clients/client-workmail/commands/GetAccessControlEffectCommand.ts index 1eda2b175f3f..6435829657c7 100644 --- a/clients/client-workmail/commands/GetAccessControlEffectCommand.ts +++ b/clients/client-workmail/commands/GetAccessControlEffectCommand.ts @@ -23,6 +23,20 @@ export interface GetAccessControlEffectCommandOutput extends GetAccessControlEff /** *

Gets the effects of an organization's access control rules as they apply to a * specified IPv4 address, access protocol action, or user ID.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { WorkMailClient, GetAccessControlEffectCommand } from "@aws-sdk/client-workmail"; // ES Modules import + * // const { WorkMailClient, GetAccessControlEffectCommand } = require("@aws-sdk/client-workmail"); // CommonJS import + * const client = new WorkMailClient(config); + * const command = new GetAccessControlEffectCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetAccessControlEffectCommandInput} for command's `input` shape. + * @see {@link GetAccessControlEffectCommandOutput} for command's `response` shape. + * @see {@link WorkMailClientResolvedConfig | config} for command's `input` shape. + * */ export class GetAccessControlEffectCommand extends $Command< GetAccessControlEffectCommandInput, diff --git a/clients/client-workmail/commands/GetDefaultRetentionPolicyCommand.ts b/clients/client-workmail/commands/GetDefaultRetentionPolicyCommand.ts index 743c5332c63a..8768a77ebda5 100644 --- a/clients/client-workmail/commands/GetDefaultRetentionPolicyCommand.ts +++ b/clients/client-workmail/commands/GetDefaultRetentionPolicyCommand.ts @@ -22,6 +22,20 @@ export interface GetDefaultRetentionPolicyCommandOutput extends GetDefaultRetent /** *

Gets the default retention policy details for the specified organization.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { WorkMailClient, GetDefaultRetentionPolicyCommand } from "@aws-sdk/client-workmail"; // ES Modules import + * // const { WorkMailClient, GetDefaultRetentionPolicyCommand } = require("@aws-sdk/client-workmail"); // CommonJS import + * const client = new WorkMailClient(config); + * const command = new GetDefaultRetentionPolicyCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetDefaultRetentionPolicyCommandInput} for command's `input` shape. + * @see {@link GetDefaultRetentionPolicyCommandOutput} for command's `response` shape. + * @see {@link WorkMailClientResolvedConfig | config} for command's `input` shape. + * */ export class GetDefaultRetentionPolicyCommand extends $Command< GetDefaultRetentionPolicyCommandInput, diff --git a/clients/client-workmail/commands/GetMailboxDetailsCommand.ts b/clients/client-workmail/commands/GetMailboxDetailsCommand.ts index f28caa4cf2e8..d769311e6d9f 100644 --- a/clients/client-workmail/commands/GetMailboxDetailsCommand.ts +++ b/clients/client-workmail/commands/GetMailboxDetailsCommand.ts @@ -22,6 +22,20 @@ export interface GetMailboxDetailsCommandOutput extends GetMailboxDetailsRespons /** *

Requests a user's mailbox details for a specified organization and user.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { WorkMailClient, GetMailboxDetailsCommand } from "@aws-sdk/client-workmail"; // ES Modules import + * // const { WorkMailClient, GetMailboxDetailsCommand } = require("@aws-sdk/client-workmail"); // CommonJS import + * const client = new WorkMailClient(config); + * const command = new GetMailboxDetailsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetMailboxDetailsCommandInput} for command's `input` shape. + * @see {@link GetMailboxDetailsCommandOutput} for command's `response` shape. + * @see {@link WorkMailClientResolvedConfig | config} for command's `input` shape. + * */ export class GetMailboxDetailsCommand extends $Command< GetMailboxDetailsCommandInput, diff --git a/clients/client-workmail/commands/GetMobileDeviceAccessEffectCommand.ts b/clients/client-workmail/commands/GetMobileDeviceAccessEffectCommand.ts index 818bbee01d3b..339f16200b01 100644 --- a/clients/client-workmail/commands/GetMobileDeviceAccessEffectCommand.ts +++ b/clients/client-workmail/commands/GetMobileDeviceAccessEffectCommand.ts @@ -25,6 +25,20 @@ export interface GetMobileDeviceAccessEffectCommandOutput /** *

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 Amazon WorkMail organization for a particular user's attributes.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { WorkMailClient, GetMobileDeviceAccessEffectCommand } from "@aws-sdk/client-workmail"; // ES Modules import + * // const { WorkMailClient, GetMobileDeviceAccessEffectCommand } = require("@aws-sdk/client-workmail"); // CommonJS import + * const client = new WorkMailClient(config); + * const command = new GetMobileDeviceAccessEffectCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetMobileDeviceAccessEffectCommandInput} for command's `input` shape. + * @see {@link GetMobileDeviceAccessEffectCommandOutput} for command's `response` shape. + * @see {@link WorkMailClientResolvedConfig | config} for command's `input` shape. + * */ export class GetMobileDeviceAccessEffectCommand extends $Command< GetMobileDeviceAccessEffectCommandInput, diff --git a/clients/client-workmail/commands/ListAccessControlRulesCommand.ts b/clients/client-workmail/commands/ListAccessControlRulesCommand.ts index 6a3e58f52aac..4225c2b21f76 100644 --- a/clients/client-workmail/commands/ListAccessControlRulesCommand.ts +++ b/clients/client-workmail/commands/ListAccessControlRulesCommand.ts @@ -22,6 +22,20 @@ export interface ListAccessControlRulesCommandOutput extends ListAccessControlRu /** *

Lists the access control rules for the specified organization.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { WorkMailClient, ListAccessControlRulesCommand } from "@aws-sdk/client-workmail"; // ES Modules import + * // const { WorkMailClient, ListAccessControlRulesCommand } = require("@aws-sdk/client-workmail"); // CommonJS import + * const client = new WorkMailClient(config); + * const command = new ListAccessControlRulesCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListAccessControlRulesCommandInput} for command's `input` shape. + * @see {@link ListAccessControlRulesCommandOutput} for command's `response` shape. + * @see {@link WorkMailClientResolvedConfig | config} for command's `input` shape. + * */ export class ListAccessControlRulesCommand extends $Command< ListAccessControlRulesCommandInput, diff --git a/clients/client-workmail/commands/ListAliasesCommand.ts b/clients/client-workmail/commands/ListAliasesCommand.ts index b25632c680c5..f98cf9813541 100644 --- a/clients/client-workmail/commands/ListAliasesCommand.ts +++ b/clients/client-workmail/commands/ListAliasesCommand.ts @@ -23,6 +23,20 @@ export interface ListAliasesCommandOutput extends ListAliasesResponse, __Metadat /** *

Creates a paginated call to list the aliases associated with a given * entity.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { WorkMailClient, ListAliasesCommand } from "@aws-sdk/client-workmail"; // ES Modules import + * // const { WorkMailClient, ListAliasesCommand } = require("@aws-sdk/client-workmail"); // CommonJS import + * const client = new WorkMailClient(config); + * const command = new ListAliasesCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListAliasesCommandInput} for command's `input` shape. + * @see {@link ListAliasesCommandOutput} for command's `response` shape. + * @see {@link WorkMailClientResolvedConfig | config} for command's `input` shape. + * */ export class ListAliasesCommand extends $Command< ListAliasesCommandInput, diff --git a/clients/client-workmail/commands/ListGroupMembersCommand.ts b/clients/client-workmail/commands/ListGroupMembersCommand.ts index 85272d9cc82b..8a6f46d0e929 100644 --- a/clients/client-workmail/commands/ListGroupMembersCommand.ts +++ b/clients/client-workmail/commands/ListGroupMembersCommand.ts @@ -23,6 +23,20 @@ export interface ListGroupMembersCommandOutput extends ListGroupMembersResponse, /** *

Returns an overview of the members of a group. Users and groups can be members of a * group.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { WorkMailClient, ListGroupMembersCommand } from "@aws-sdk/client-workmail"; // ES Modules import + * // const { WorkMailClient, ListGroupMembersCommand } = require("@aws-sdk/client-workmail"); // CommonJS import + * const client = new WorkMailClient(config); + * const command = new ListGroupMembersCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListGroupMembersCommandInput} for command's `input` shape. + * @see {@link ListGroupMembersCommandOutput} for command's `response` shape. + * @see {@link WorkMailClientResolvedConfig | config} for command's `input` shape. + * */ export class ListGroupMembersCommand extends $Command< ListGroupMembersCommandInput, diff --git a/clients/client-workmail/commands/ListGroupsCommand.ts b/clients/client-workmail/commands/ListGroupsCommand.ts index ec94a72d34b6..8cf681952442 100644 --- a/clients/client-workmail/commands/ListGroupsCommand.ts +++ b/clients/client-workmail/commands/ListGroupsCommand.ts @@ -22,6 +22,20 @@ export interface ListGroupsCommandOutput extends ListGroupsResponse, __MetadataB /** *

Returns summaries of the organization's groups.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { WorkMailClient, ListGroupsCommand } from "@aws-sdk/client-workmail"; // ES Modules import + * // const { WorkMailClient, ListGroupsCommand } = require("@aws-sdk/client-workmail"); // CommonJS import + * const client = new WorkMailClient(config); + * const command = new ListGroupsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListGroupsCommandInput} for command's `input` shape. + * @see {@link ListGroupsCommandOutput} for command's `response` shape. + * @see {@link WorkMailClientResolvedConfig | config} for command's `input` shape. + * */ export class ListGroupsCommand extends $Command< ListGroupsCommandInput, diff --git a/clients/client-workmail/commands/ListMailboxExportJobsCommand.ts b/clients/client-workmail/commands/ListMailboxExportJobsCommand.ts index 90e3869eb971..a9b05b40216b 100644 --- a/clients/client-workmail/commands/ListMailboxExportJobsCommand.ts +++ b/clients/client-workmail/commands/ListMailboxExportJobsCommand.ts @@ -23,6 +23,20 @@ export interface ListMailboxExportJobsCommandOutput extends ListMailboxExportJob /** *

Lists the mailbox export jobs started for the specified organization within the last * seven days.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { WorkMailClient, ListMailboxExportJobsCommand } from "@aws-sdk/client-workmail"; // ES Modules import + * // const { WorkMailClient, ListMailboxExportJobsCommand } = require("@aws-sdk/client-workmail"); // CommonJS import + * const client = new WorkMailClient(config); + * const command = new ListMailboxExportJobsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListMailboxExportJobsCommandInput} for command's `input` shape. + * @see {@link ListMailboxExportJobsCommandOutput} for command's `response` shape. + * @see {@link WorkMailClientResolvedConfig | config} for command's `input` shape. + * */ export class ListMailboxExportJobsCommand extends $Command< ListMailboxExportJobsCommandInput, diff --git a/clients/client-workmail/commands/ListMailboxPermissionsCommand.ts b/clients/client-workmail/commands/ListMailboxPermissionsCommand.ts index 779d4c161195..207a5005e80d 100644 --- a/clients/client-workmail/commands/ListMailboxPermissionsCommand.ts +++ b/clients/client-workmail/commands/ListMailboxPermissionsCommand.ts @@ -23,6 +23,20 @@ export interface ListMailboxPermissionsCommandOutput extends ListMailboxPermissi /** *

Lists the mailbox permissions associated with a user, group, or resource * mailbox.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { WorkMailClient, ListMailboxPermissionsCommand } from "@aws-sdk/client-workmail"; // ES Modules import + * // const { WorkMailClient, ListMailboxPermissionsCommand } = require("@aws-sdk/client-workmail"); // CommonJS import + * const client = new WorkMailClient(config); + * const command = new ListMailboxPermissionsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListMailboxPermissionsCommandInput} for command's `input` shape. + * @see {@link ListMailboxPermissionsCommandOutput} for command's `response` shape. + * @see {@link WorkMailClientResolvedConfig | config} for command's `input` shape. + * */ export class ListMailboxPermissionsCommand extends $Command< ListMailboxPermissionsCommandInput, diff --git a/clients/client-workmail/commands/ListMobileDeviceAccessRulesCommand.ts b/clients/client-workmail/commands/ListMobileDeviceAccessRulesCommand.ts index 2b8deb3efddb..b90a99439dc3 100644 --- a/clients/client-workmail/commands/ListMobileDeviceAccessRulesCommand.ts +++ b/clients/client-workmail/commands/ListMobileDeviceAccessRulesCommand.ts @@ -24,6 +24,20 @@ export interface ListMobileDeviceAccessRulesCommandOutput /** *

Lists the mobile device access rules for the specified Amazon WorkMail organization.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { WorkMailClient, ListMobileDeviceAccessRulesCommand } from "@aws-sdk/client-workmail"; // ES Modules import + * // const { WorkMailClient, ListMobileDeviceAccessRulesCommand } = require("@aws-sdk/client-workmail"); // CommonJS import + * const client = new WorkMailClient(config); + * const command = new ListMobileDeviceAccessRulesCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListMobileDeviceAccessRulesCommandInput} for command's `input` shape. + * @see {@link ListMobileDeviceAccessRulesCommandOutput} for command's `response` shape. + * @see {@link WorkMailClientResolvedConfig | config} for command's `input` shape. + * */ export class ListMobileDeviceAccessRulesCommand extends $Command< ListMobileDeviceAccessRulesCommandInput, diff --git a/clients/client-workmail/commands/ListOrganizationsCommand.ts b/clients/client-workmail/commands/ListOrganizationsCommand.ts index 91d4b8359863..6eac4e92a96b 100644 --- a/clients/client-workmail/commands/ListOrganizationsCommand.ts +++ b/clients/client-workmail/commands/ListOrganizationsCommand.ts @@ -22,6 +22,20 @@ export interface ListOrganizationsCommandOutput extends ListOrganizationsRespons /** *

Returns summaries of the customer's organizations.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { WorkMailClient, ListOrganizationsCommand } from "@aws-sdk/client-workmail"; // ES Modules import + * // const { WorkMailClient, ListOrganizationsCommand } = require("@aws-sdk/client-workmail"); // CommonJS import + * const client = new WorkMailClient(config); + * const command = new ListOrganizationsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListOrganizationsCommandInput} for command's `input` shape. + * @see {@link ListOrganizationsCommandOutput} for command's `response` shape. + * @see {@link WorkMailClientResolvedConfig | config} for command's `input` shape. + * */ export class ListOrganizationsCommand extends $Command< ListOrganizationsCommandInput, diff --git a/clients/client-workmail/commands/ListResourceDelegatesCommand.ts b/clients/client-workmail/commands/ListResourceDelegatesCommand.ts index 87a73538496b..a222143c7b01 100644 --- a/clients/client-workmail/commands/ListResourceDelegatesCommand.ts +++ b/clients/client-workmail/commands/ListResourceDelegatesCommand.ts @@ -23,6 +23,20 @@ export interface ListResourceDelegatesCommandOutput extends ListResourceDelegate /** *

Lists the delegates associated with a resource. Users and groups can be resource * delegates and answer requests on behalf of the resource.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { WorkMailClient, ListResourceDelegatesCommand } from "@aws-sdk/client-workmail"; // ES Modules import + * // const { WorkMailClient, ListResourceDelegatesCommand } = require("@aws-sdk/client-workmail"); // CommonJS import + * const client = new WorkMailClient(config); + * const command = new ListResourceDelegatesCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListResourceDelegatesCommandInput} for command's `input` shape. + * @see {@link ListResourceDelegatesCommandOutput} for command's `response` shape. + * @see {@link WorkMailClientResolvedConfig | config} for command's `input` shape. + * */ export class ListResourceDelegatesCommand extends $Command< ListResourceDelegatesCommandInput, diff --git a/clients/client-workmail/commands/ListResourcesCommand.ts b/clients/client-workmail/commands/ListResourcesCommand.ts index 60032941a486..eec27e071178 100644 --- a/clients/client-workmail/commands/ListResourcesCommand.ts +++ b/clients/client-workmail/commands/ListResourcesCommand.ts @@ -22,6 +22,20 @@ export interface ListResourcesCommandOutput extends ListResourcesResponse, __Met /** *

Returns summaries of the organization's resources.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { WorkMailClient, ListResourcesCommand } from "@aws-sdk/client-workmail"; // ES Modules import + * // const { WorkMailClient, ListResourcesCommand } = require("@aws-sdk/client-workmail"); // CommonJS import + * const client = new WorkMailClient(config); + * const command = new ListResourcesCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListResourcesCommandInput} for command's `input` shape. + * @see {@link ListResourcesCommandOutput} for command's `response` shape. + * @see {@link WorkMailClientResolvedConfig | config} for command's `input` shape. + * */ export class ListResourcesCommand extends $Command< ListResourcesCommandInput, diff --git a/clients/client-workmail/commands/ListTagsForResourceCommand.ts b/clients/client-workmail/commands/ListTagsForResourceCommand.ts index 2c5d24a132da..4f4d309cb476 100644 --- a/clients/client-workmail/commands/ListTagsForResourceCommand.ts +++ b/clients/client-workmail/commands/ListTagsForResourceCommand.ts @@ -22,6 +22,20 @@ export interface ListTagsForResourceCommandOutput extends ListTagsForResourceRes /** *

Lists the tags applied to an Amazon WorkMail organization resource.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { WorkMailClient, ListTagsForResourceCommand } from "@aws-sdk/client-workmail"; // ES Modules import + * // const { WorkMailClient, ListTagsForResourceCommand } = require("@aws-sdk/client-workmail"); // CommonJS import + * const client = new WorkMailClient(config); + * const command = new ListTagsForResourceCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListTagsForResourceCommandInput} for command's `input` shape. + * @see {@link ListTagsForResourceCommandOutput} for command's `response` shape. + * @see {@link WorkMailClientResolvedConfig | config} for command's `input` shape. + * */ export class ListTagsForResourceCommand extends $Command< ListTagsForResourceCommandInput, diff --git a/clients/client-workmail/commands/ListUsersCommand.ts b/clients/client-workmail/commands/ListUsersCommand.ts index 95e49c3e6d23..d215d89fc3b9 100644 --- a/clients/client-workmail/commands/ListUsersCommand.ts +++ b/clients/client-workmail/commands/ListUsersCommand.ts @@ -19,6 +19,20 @@ export interface ListUsersCommandOutput extends ListUsersResponse, __MetadataBea /** *

Returns summaries of the organization's users.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { WorkMailClient, ListUsersCommand } from "@aws-sdk/client-workmail"; // ES Modules import + * // const { WorkMailClient, ListUsersCommand } = require("@aws-sdk/client-workmail"); // CommonJS import + * const client = new WorkMailClient(config); + * const command = new ListUsersCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListUsersCommandInput} for command's `input` shape. + * @see {@link ListUsersCommandOutput} for command's `response` shape. + * @see {@link WorkMailClientResolvedConfig | config} for command's `input` shape. + * */ export class ListUsersCommand extends $Command< ListUsersCommandInput, diff --git a/clients/client-workmail/commands/PutAccessControlRuleCommand.ts b/clients/client-workmail/commands/PutAccessControlRuleCommand.ts index 01fa6ac4c41a..562f0032066e 100644 --- a/clients/client-workmail/commands/PutAccessControlRuleCommand.ts +++ b/clients/client-workmail/commands/PutAccessControlRuleCommand.ts @@ -25,6 +25,20 @@ export interface PutAccessControlRuleCommandOutput extends PutAccessControlRuleR * denies access to the organization for the specified IPv4 addresses, access protocol * actions, and user IDs. Adding a new rule with the same name as an existing rule replaces * the older rule.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { WorkMailClient, PutAccessControlRuleCommand } from "@aws-sdk/client-workmail"; // ES Modules import + * // const { WorkMailClient, PutAccessControlRuleCommand } = require("@aws-sdk/client-workmail"); // CommonJS import + * const client = new WorkMailClient(config); + * const command = new PutAccessControlRuleCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link PutAccessControlRuleCommandInput} for command's `input` shape. + * @see {@link PutAccessControlRuleCommandOutput} for command's `response` shape. + * @see {@link WorkMailClientResolvedConfig | config} for command's `input` shape. + * */ export class PutAccessControlRuleCommand extends $Command< PutAccessControlRuleCommandInput, diff --git a/clients/client-workmail/commands/PutMailboxPermissionsCommand.ts b/clients/client-workmail/commands/PutMailboxPermissionsCommand.ts index 975cdb3ab76b..ea6835b64a58 100644 --- a/clients/client-workmail/commands/PutMailboxPermissionsCommand.ts +++ b/clients/client-workmail/commands/PutMailboxPermissionsCommand.ts @@ -23,6 +23,20 @@ export interface PutMailboxPermissionsCommandOutput extends PutMailboxPermission /** *

Sets permissions for a user, group, or resource. This replaces any pre-existing * permissions.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { WorkMailClient, PutMailboxPermissionsCommand } from "@aws-sdk/client-workmail"; // ES Modules import + * // const { WorkMailClient, PutMailboxPermissionsCommand } = require("@aws-sdk/client-workmail"); // CommonJS import + * const client = new WorkMailClient(config); + * const command = new PutMailboxPermissionsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link PutMailboxPermissionsCommandInput} for command's `input` shape. + * @see {@link PutMailboxPermissionsCommandOutput} for command's `response` shape. + * @see {@link WorkMailClientResolvedConfig | config} for command's `input` shape. + * */ export class PutMailboxPermissionsCommand extends $Command< PutMailboxPermissionsCommandInput, diff --git a/clients/client-workmail/commands/PutRetentionPolicyCommand.ts b/clients/client-workmail/commands/PutRetentionPolicyCommand.ts index f06ca3c19898..6a408b5e5dc2 100644 --- a/clients/client-workmail/commands/PutRetentionPolicyCommand.ts +++ b/clients/client-workmail/commands/PutRetentionPolicyCommand.ts @@ -22,6 +22,20 @@ export interface PutRetentionPolicyCommandOutput extends PutRetentionPolicyRespo /** *

Puts a retention policy to the specified organization.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { WorkMailClient, PutRetentionPolicyCommand } from "@aws-sdk/client-workmail"; // ES Modules import + * // const { WorkMailClient, PutRetentionPolicyCommand } = require("@aws-sdk/client-workmail"); // CommonJS import + * const client = new WorkMailClient(config); + * const command = new PutRetentionPolicyCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link PutRetentionPolicyCommandInput} for command's `input` shape. + * @see {@link PutRetentionPolicyCommandOutput} for command's `response` shape. + * @see {@link WorkMailClientResolvedConfig | config} for command's `input` shape. + * */ export class PutRetentionPolicyCommand extends $Command< PutRetentionPolicyCommandInput, diff --git a/clients/client-workmail/commands/RegisterToWorkMailCommand.ts b/clients/client-workmail/commands/RegisterToWorkMailCommand.ts index 1510fb5fc936..b9bca9ba4215 100644 --- a/clients/client-workmail/commands/RegisterToWorkMailCommand.ts +++ b/clients/client-workmail/commands/RegisterToWorkMailCommand.ts @@ -28,6 +28,20 @@ export interface RegisterToWorkMailCommandOutput extends RegisterToWorkMailRespo * 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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { WorkMailClient, RegisterToWorkMailCommand } from "@aws-sdk/client-workmail"; // ES Modules import + * // const { WorkMailClient, RegisterToWorkMailCommand } = require("@aws-sdk/client-workmail"); // CommonJS import + * const client = new WorkMailClient(config); + * const command = new RegisterToWorkMailCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link RegisterToWorkMailCommandInput} for command's `input` shape. + * @see {@link RegisterToWorkMailCommandOutput} for command's `response` shape. + * @see {@link WorkMailClientResolvedConfig | config} for command's `input` shape. + * */ export class RegisterToWorkMailCommand extends $Command< RegisterToWorkMailCommandInput, diff --git a/clients/client-workmail/commands/ResetPasswordCommand.ts b/clients/client-workmail/commands/ResetPasswordCommand.ts index 7d4551daf0c3..7442c285fd56 100644 --- a/clients/client-workmail/commands/ResetPasswordCommand.ts +++ b/clients/client-workmail/commands/ResetPasswordCommand.ts @@ -22,6 +22,20 @@ export interface ResetPasswordCommandOutput extends ResetPasswordResponse, __Met /** *

Allows the administrator to reset the password for a user.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { WorkMailClient, ResetPasswordCommand } from "@aws-sdk/client-workmail"; // ES Modules import + * // const { WorkMailClient, ResetPasswordCommand } = require("@aws-sdk/client-workmail"); // CommonJS import + * const client = new WorkMailClient(config); + * const command = new ResetPasswordCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ResetPasswordCommandInput} for command's `input` shape. + * @see {@link ResetPasswordCommandOutput} for command's `response` shape. + * @see {@link WorkMailClientResolvedConfig | config} for command's `input` shape. + * */ export class ResetPasswordCommand extends $Command< ResetPasswordCommandInput, diff --git a/clients/client-workmail/commands/StartMailboxExportJobCommand.ts b/clients/client-workmail/commands/StartMailboxExportJobCommand.ts index 05e4c69d12d7..888969763923 100644 --- a/clients/client-workmail/commands/StartMailboxExportJobCommand.ts +++ b/clients/client-workmail/commands/StartMailboxExportJobCommand.ts @@ -25,6 +25,20 @@ export interface StartMailboxExportJobCommandOutput extends StartMailboxExportJo * from the specified mailbox to the specified Amazon Simple Storage Service (Amazon S3) * bucket. For more information, see Exporting mailbox content in * the Amazon WorkMail Administrator Guide.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { WorkMailClient, StartMailboxExportJobCommand } from "@aws-sdk/client-workmail"; // ES Modules import + * // const { WorkMailClient, StartMailboxExportJobCommand } = require("@aws-sdk/client-workmail"); // CommonJS import + * const client = new WorkMailClient(config); + * const command = new StartMailboxExportJobCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link StartMailboxExportJobCommandInput} for command's `input` shape. + * @see {@link StartMailboxExportJobCommandOutput} for command's `response` shape. + * @see {@link WorkMailClientResolvedConfig | config} for command's `input` shape. + * */ export class StartMailboxExportJobCommand extends $Command< StartMailboxExportJobCommandInput, diff --git a/clients/client-workmail/commands/TagResourceCommand.ts b/clients/client-workmail/commands/TagResourceCommand.ts index c4a102cb4b1d..207047d036f5 100644 --- a/clients/client-workmail/commands/TagResourceCommand.ts +++ b/clients/client-workmail/commands/TagResourceCommand.ts @@ -23,6 +23,20 @@ export interface TagResourceCommandOutput extends TagResourceResponse, __Metadat /** *

Applies the specified tags to the specified Amazon WorkMail organization * resource.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { WorkMailClient, TagResourceCommand } from "@aws-sdk/client-workmail"; // ES Modules import + * // const { WorkMailClient, TagResourceCommand } = require("@aws-sdk/client-workmail"); // CommonJS import + * const client = new WorkMailClient(config); + * const command = new TagResourceCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link TagResourceCommandInput} for command's `input` shape. + * @see {@link TagResourceCommandOutput} for command's `response` shape. + * @see {@link WorkMailClientResolvedConfig | config} for command's `input` shape. + * */ export class TagResourceCommand extends $Command< TagResourceCommandInput, diff --git a/clients/client-workmail/commands/UntagResourceCommand.ts b/clients/client-workmail/commands/UntagResourceCommand.ts index 52279a4a82f3..27fab43b38ca 100644 --- a/clients/client-workmail/commands/UntagResourceCommand.ts +++ b/clients/client-workmail/commands/UntagResourceCommand.ts @@ -23,6 +23,20 @@ export interface UntagResourceCommandOutput extends UntagResourceResponse, __Met /** *

Untags the specified tags from the specified Amazon WorkMail organization * resource.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { WorkMailClient, UntagResourceCommand } from "@aws-sdk/client-workmail"; // ES Modules import + * // const { WorkMailClient, UntagResourceCommand } = require("@aws-sdk/client-workmail"); // CommonJS import + * const client = new WorkMailClient(config); + * const command = new UntagResourceCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link UntagResourceCommandInput} for command's `input` shape. + * @see {@link UntagResourceCommandOutput} for command's `response` shape. + * @see {@link WorkMailClientResolvedConfig | config} for command's `input` shape. + * */ export class UntagResourceCommand extends $Command< UntagResourceCommandInput, diff --git a/clients/client-workmail/commands/UpdateMailboxQuotaCommand.ts b/clients/client-workmail/commands/UpdateMailboxQuotaCommand.ts index 0b1894d529df..c30a67bb19dd 100644 --- a/clients/client-workmail/commands/UpdateMailboxQuotaCommand.ts +++ b/clients/client-workmail/commands/UpdateMailboxQuotaCommand.ts @@ -23,6 +23,20 @@ export interface UpdateMailboxQuotaCommandOutput extends UpdateMailboxQuotaRespo /** *

Updates a user's current mailbox quota for a specified organization and * user.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { WorkMailClient, UpdateMailboxQuotaCommand } from "@aws-sdk/client-workmail"; // ES Modules import + * // const { WorkMailClient, UpdateMailboxQuotaCommand } = require("@aws-sdk/client-workmail"); // CommonJS import + * const client = new WorkMailClient(config); + * const command = new UpdateMailboxQuotaCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link UpdateMailboxQuotaCommandInput} for command's `input` shape. + * @see {@link UpdateMailboxQuotaCommandOutput} for command's `response` shape. + * @see {@link WorkMailClientResolvedConfig | config} for command's `input` shape. + * */ export class UpdateMailboxQuotaCommand extends $Command< UpdateMailboxQuotaCommandInput, diff --git a/clients/client-workmail/commands/UpdateMobileDeviceAccessRuleCommand.ts b/clients/client-workmail/commands/UpdateMobileDeviceAccessRuleCommand.ts index d82e9768221b..b29ff65debb8 100644 --- a/clients/client-workmail/commands/UpdateMobileDeviceAccessRuleCommand.ts +++ b/clients/client-workmail/commands/UpdateMobileDeviceAccessRuleCommand.ts @@ -24,6 +24,20 @@ export interface UpdateMobileDeviceAccessRuleCommandOutput /** *

Updates a mobile device access rule for the specified Amazon WorkMail organization.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { WorkMailClient, UpdateMobileDeviceAccessRuleCommand } from "@aws-sdk/client-workmail"; // ES Modules import + * // const { WorkMailClient, UpdateMobileDeviceAccessRuleCommand } = require("@aws-sdk/client-workmail"); // CommonJS import + * const client = new WorkMailClient(config); + * const command = new UpdateMobileDeviceAccessRuleCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link UpdateMobileDeviceAccessRuleCommandInput} for command's `input` shape. + * @see {@link UpdateMobileDeviceAccessRuleCommandOutput} for command's `response` shape. + * @see {@link WorkMailClientResolvedConfig | config} for command's `input` shape. + * */ export class UpdateMobileDeviceAccessRuleCommand extends $Command< UpdateMobileDeviceAccessRuleCommandInput, diff --git a/clients/client-workmail/commands/UpdatePrimaryEmailAddressCommand.ts b/clients/client-workmail/commands/UpdatePrimaryEmailAddressCommand.ts index 57abbd6d29e2..93afb11cf2cf 100644 --- a/clients/client-workmail/commands/UpdatePrimaryEmailAddressCommand.ts +++ b/clients/client-workmail/commands/UpdatePrimaryEmailAddressCommand.ts @@ -24,6 +24,20 @@ export interface UpdatePrimaryEmailAddressCommandOutput extends UpdatePrimaryEma *

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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { WorkMailClient, UpdatePrimaryEmailAddressCommand } from "@aws-sdk/client-workmail"; // ES Modules import + * // const { WorkMailClient, UpdatePrimaryEmailAddressCommand } = require("@aws-sdk/client-workmail"); // CommonJS import + * const client = new WorkMailClient(config); + * const command = new UpdatePrimaryEmailAddressCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link UpdatePrimaryEmailAddressCommandInput} for command's `input` shape. + * @see {@link UpdatePrimaryEmailAddressCommandOutput} for command's `response` shape. + * @see {@link WorkMailClientResolvedConfig | config} for command's `input` shape. + * */ export class UpdatePrimaryEmailAddressCommand extends $Command< UpdatePrimaryEmailAddressCommandInput, diff --git a/clients/client-workmail/commands/UpdateResourceCommand.ts b/clients/client-workmail/commands/UpdateResourceCommand.ts index 371ed090324b..9806be763f50 100644 --- a/clients/client-workmail/commands/UpdateResourceCommand.ts +++ b/clients/client-workmail/commands/UpdateResourceCommand.ts @@ -24,6 +24,20 @@ export interface UpdateResourceCommandOutput extends UpdateResourceResponse, __M *

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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { WorkMailClient, UpdateResourceCommand } from "@aws-sdk/client-workmail"; // ES Modules import + * // const { WorkMailClient, UpdateResourceCommand } = require("@aws-sdk/client-workmail"); // CommonJS import + * const client = new WorkMailClient(config); + * const command = new UpdateResourceCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link UpdateResourceCommandInput} for command's `input` shape. + * @see {@link UpdateResourceCommandOutput} for command's `response` shape. + * @see {@link WorkMailClientResolvedConfig | config} for command's `input` shape. + * */ export class UpdateResourceCommand extends $Command< UpdateResourceCommandInput, diff --git a/clients/client-workmail/models/models_0.ts b/clients/client-workmail/models/models_0.ts index 3a268bdb37e8..1ecfbad6666e 100644 --- a/clients/client-workmail/models/models_0.ts +++ b/clients/client-workmail/models/models_0.ts @@ -71,6 +71,9 @@ export interface AccessControlRule { } export namespace AccessControlRule { + /** + * @internal + */ export const filterSensitiveLog = (obj: AccessControlRule): any => ({ ...obj, }); @@ -94,6 +97,9 @@ export interface AssociateDelegateToResourceRequest { } export namespace AssociateDelegateToResourceRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: AssociateDelegateToResourceRequest): any => ({ ...obj, }); @@ -102,6 +108,9 @@ export namespace AssociateDelegateToResourceRequest { export interface AssociateDelegateToResourceResponse {} export namespace AssociateDelegateToResourceResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: AssociateDelegateToResourceResponse): any => ({ ...obj, }); @@ -118,6 +127,9 @@ export interface EntityNotFoundException extends __SmithyException, $MetadataBea } export namespace EntityNotFoundException { + /** + * @internal + */ export const filterSensitiveLog = (obj: EntityNotFoundException): any => ({ ...obj, }); @@ -134,6 +146,9 @@ export interface EntityStateException extends __SmithyException, $MetadataBearer } export namespace EntityStateException { + /** + * @internal + */ export const filterSensitiveLog = (obj: EntityStateException): any => ({ ...obj, }); @@ -149,6 +164,9 @@ export interface InvalidParameterException extends __SmithyException, $MetadataB } export namespace InvalidParameterException { + /** + * @internal + */ export const filterSensitiveLog = (obj: InvalidParameterException): any => ({ ...obj, }); @@ -165,6 +183,9 @@ export interface OrganizationNotFoundException extends __SmithyException, $Metad } export namespace OrganizationNotFoundException { + /** + * @internal + */ export const filterSensitiveLog = (obj: OrganizationNotFoundException): any => ({ ...obj, }); @@ -181,6 +202,9 @@ export interface OrganizationStateException extends __SmithyException, $Metadata } export namespace OrganizationStateException { + /** + * @internal + */ export const filterSensitiveLog = (obj: OrganizationStateException): any => ({ ...obj, }); @@ -204,6 +228,9 @@ export interface AssociateMemberToGroupRequest { } export namespace AssociateMemberToGroupRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: AssociateMemberToGroupRequest): any => ({ ...obj, }); @@ -212,6 +239,9 @@ export namespace AssociateMemberToGroupRequest { export interface AssociateMemberToGroupResponse {} export namespace AssociateMemberToGroupResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: AssociateMemberToGroupResponse): any => ({ ...obj, }); @@ -227,6 +257,9 @@ export interface DirectoryServiceAuthenticationFailedException extends __SmithyE } export namespace DirectoryServiceAuthenticationFailedException { + /** + * @internal + */ export const filterSensitiveLog = (obj: DirectoryServiceAuthenticationFailedException): any => ({ ...obj, }); @@ -242,6 +275,9 @@ export interface DirectoryUnavailableException extends __SmithyException, $Metad } export namespace DirectoryUnavailableException { + /** + * @internal + */ export const filterSensitiveLog = (obj: DirectoryUnavailableException): any => ({ ...obj, }); @@ -257,6 +293,9 @@ export interface UnsupportedOperationException extends __SmithyException, $Metad } export namespace UnsupportedOperationException { + /** + * @internal + */ export const filterSensitiveLog = (obj: UnsupportedOperationException): any => ({ ...obj, }); @@ -285,6 +324,9 @@ export interface BookingOptions { } export namespace BookingOptions { + /** + * @internal + */ export const filterSensitiveLog = (obj: BookingOptions): any => ({ ...obj, }); @@ -308,6 +350,9 @@ export interface CancelMailboxExportJobRequest { } export namespace CancelMailboxExportJobRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: CancelMailboxExportJobRequest): any => ({ ...obj, }); @@ -316,6 +361,9 @@ export namespace CancelMailboxExportJobRequest { export interface CancelMailboxExportJobResponse {} export namespace CancelMailboxExportJobResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: CancelMailboxExportJobResponse): any => ({ ...obj, }); @@ -339,6 +387,9 @@ export interface CreateAliasRequest { } export namespace CreateAliasRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateAliasRequest): any => ({ ...obj, }); @@ -347,6 +398,9 @@ export namespace CreateAliasRequest { export interface CreateAliasResponse {} export namespace CreateAliasResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateAliasResponse): any => ({ ...obj, }); @@ -363,6 +417,9 @@ export interface EmailAddressInUseException extends __SmithyException, $Metadata } export namespace EmailAddressInUseException { + /** + * @internal + */ export const filterSensitiveLog = (obj: EmailAddressInUseException): any => ({ ...obj, }); @@ -378,6 +435,9 @@ export interface LimitExceededException extends __SmithyException, $MetadataBear } export namespace LimitExceededException { + /** + * @internal + */ export const filterSensitiveLog = (obj: LimitExceededException): any => ({ ...obj, }); @@ -394,6 +454,9 @@ export interface MailDomainNotFoundException extends __SmithyException, $Metadat } export namespace MailDomainNotFoundException { + /** + * @internal + */ export const filterSensitiveLog = (obj: MailDomainNotFoundException): any => ({ ...obj, }); @@ -410,6 +473,9 @@ export interface MailDomainStateException extends __SmithyException, $MetadataBe } export namespace MailDomainStateException { + /** + * @internal + */ export const filterSensitiveLog = (obj: MailDomainStateException): any => ({ ...obj, }); @@ -428,6 +494,9 @@ export interface CreateGroupRequest { } export namespace CreateGroupRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateGroupRequest): any => ({ ...obj, }); @@ -441,6 +510,9 @@ export interface CreateGroupResponse { } export namespace CreateGroupResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateGroupResponse): any => ({ ...obj, }); @@ -456,6 +528,9 @@ export interface NameAvailabilityException extends __SmithyException, $MetadataB } export namespace NameAvailabilityException { + /** + * @internal + */ export const filterSensitiveLog = (obj: NameAvailabilityException): any => ({ ...obj, }); @@ -471,6 +546,9 @@ export interface ReservedNameException extends __SmithyException, $MetadataBeare } export namespace ReservedNameException { + /** + * @internal + */ export const filterSensitiveLog = (obj: ReservedNameException): any => ({ ...obj, }); @@ -549,6 +627,9 @@ export interface CreateMobileDeviceAccessRuleRequest { } export namespace CreateMobileDeviceAccessRuleRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateMobileDeviceAccessRuleRequest): any => ({ ...obj, }); @@ -562,6 +643,9 @@ export interface CreateMobileDeviceAccessRuleResponse { } export namespace CreateMobileDeviceAccessRuleResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateMobileDeviceAccessRuleResponse): any => ({ ...obj, }); @@ -584,6 +668,9 @@ export interface Domain { } export namespace Domain { + /** + * @internal + */ export const filterSensitiveLog = (obj: Domain): any => ({ ...obj, }); @@ -623,6 +710,9 @@ export interface CreateOrganizationRequest { } export namespace CreateOrganizationRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateOrganizationRequest): any => ({ ...obj, }); @@ -636,6 +726,9 @@ export interface CreateOrganizationResponse { } export namespace CreateOrganizationResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateOrganizationResponse): any => ({ ...obj, }); @@ -651,6 +744,9 @@ export interface DirectoryInUseException extends __SmithyException, $MetadataBea } export namespace DirectoryInUseException { + /** + * @internal + */ export const filterSensitiveLog = (obj: DirectoryInUseException): any => ({ ...obj, }); @@ -681,6 +777,9 @@ export interface CreateResourceRequest { } export namespace CreateResourceRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateResourceRequest): any => ({ ...obj, }); @@ -694,6 +793,9 @@ export interface CreateResourceResponse { } export namespace CreateResourceResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateResourceResponse): any => ({ ...obj, }); @@ -722,6 +824,9 @@ export interface CreateUserRequest { } export namespace CreateUserRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateUserRequest): any => ({ ...obj, ...(obj.Password && { Password: SENSITIVE_STRING }), @@ -736,6 +841,9 @@ export interface CreateUserResponse { } export namespace CreateUserResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateUserResponse): any => ({ ...obj, }); @@ -752,6 +860,9 @@ export interface InvalidPasswordException extends __SmithyException, $MetadataBe } export namespace InvalidPasswordException { + /** + * @internal + */ export const filterSensitiveLog = (obj: InvalidPasswordException): any => ({ ...obj, }); @@ -779,6 +890,9 @@ export interface Delegate { } export namespace Delegate { + /** + * @internal + */ export const filterSensitiveLog = (obj: Delegate): any => ({ ...obj, }); @@ -797,6 +911,9 @@ export interface DeleteAccessControlRuleRequest { } export namespace DeleteAccessControlRuleRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteAccessControlRuleRequest): any => ({ ...obj, }); @@ -805,6 +922,9 @@ export namespace DeleteAccessControlRuleRequest { export interface DeleteAccessControlRuleResponse {} export namespace DeleteAccessControlRuleResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteAccessControlRuleResponse): any => ({ ...obj, }); @@ -830,6 +950,9 @@ export interface DeleteAliasRequest { } export namespace DeleteAliasRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteAliasRequest): any => ({ ...obj, }); @@ -838,6 +961,9 @@ export namespace DeleteAliasRequest { export interface DeleteAliasResponse {} export namespace DeleteAliasResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteAliasResponse): any => ({ ...obj, }); @@ -856,6 +982,9 @@ export interface DeleteGroupRequest { } export namespace DeleteGroupRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteGroupRequest): any => ({ ...obj, }); @@ -864,6 +993,9 @@ export namespace DeleteGroupRequest { export interface DeleteGroupResponse {} export namespace DeleteGroupResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteGroupResponse): any => ({ ...obj, }); @@ -889,6 +1021,9 @@ export interface DeleteMailboxPermissionsRequest { } export namespace DeleteMailboxPermissionsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteMailboxPermissionsRequest): any => ({ ...obj, }); @@ -897,6 +1032,9 @@ export namespace DeleteMailboxPermissionsRequest { export interface DeleteMailboxPermissionsResponse {} export namespace DeleteMailboxPermissionsResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteMailboxPermissionsResponse): any => ({ ...obj, }); @@ -915,6 +1053,9 @@ export interface DeleteMobileDeviceAccessRuleRequest { } export namespace DeleteMobileDeviceAccessRuleRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteMobileDeviceAccessRuleRequest): any => ({ ...obj, }); @@ -923,6 +1064,9 @@ export namespace DeleteMobileDeviceAccessRuleRequest { export interface DeleteMobileDeviceAccessRuleResponse {} export namespace DeleteMobileDeviceAccessRuleResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteMobileDeviceAccessRuleResponse): any => ({ ...obj, }); @@ -946,6 +1090,9 @@ export interface DeleteOrganizationRequest { } export namespace DeleteOrganizationRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteOrganizationRequest): any => ({ ...obj, }); @@ -964,6 +1111,9 @@ export interface DeleteOrganizationResponse { } export namespace DeleteOrganizationResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteOrganizationResponse): any => ({ ...obj, }); @@ -983,6 +1133,9 @@ export interface DeleteResourceRequest { } export namespace DeleteResourceRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteResourceRequest): any => ({ ...obj, }); @@ -991,6 +1144,9 @@ export namespace DeleteResourceRequest { export interface DeleteResourceResponse {} export namespace DeleteResourceResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteResourceResponse): any => ({ ...obj, }); @@ -1009,6 +1165,9 @@ export interface DeleteRetentionPolicyRequest { } export namespace DeleteRetentionPolicyRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteRetentionPolicyRequest): any => ({ ...obj, }); @@ -1017,6 +1176,9 @@ export namespace DeleteRetentionPolicyRequest { export interface DeleteRetentionPolicyResponse {} export namespace DeleteRetentionPolicyResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteRetentionPolicyResponse): any => ({ ...obj, }); @@ -1035,6 +1197,9 @@ export interface DeleteUserRequest { } export namespace DeleteUserRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteUserRequest): any => ({ ...obj, }); @@ -1043,6 +1208,9 @@ export namespace DeleteUserRequest { export interface DeleteUserResponse {} export namespace DeleteUserResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteUserResponse): any => ({ ...obj, }); @@ -1061,6 +1229,9 @@ export interface DeregisterFromWorkMailRequest { } export namespace DeregisterFromWorkMailRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeregisterFromWorkMailRequest): any => ({ ...obj, }); @@ -1069,6 +1240,9 @@ export namespace DeregisterFromWorkMailRequest { export interface DeregisterFromWorkMailResponse {} export namespace DeregisterFromWorkMailResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeregisterFromWorkMailResponse): any => ({ ...obj, }); @@ -1087,6 +1261,9 @@ export interface DescribeGroupRequest { } export namespace DescribeGroupRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeGroupRequest): any => ({ ...obj, }); @@ -1134,6 +1311,9 @@ export interface DescribeGroupResponse { } export namespace DescribeGroupResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeGroupResponse): any => ({ ...obj, }); @@ -1152,6 +1332,9 @@ export interface DescribeMailboxExportJobRequest { } export namespace DescribeMailboxExportJobRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeMailboxExportJobRequest): any => ({ ...obj, }); @@ -1230,6 +1413,9 @@ export interface DescribeMailboxExportJobResponse { } export namespace DescribeMailboxExportJobResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeMailboxExportJobResponse): any => ({ ...obj, }); @@ -1243,6 +1429,9 @@ export interface DescribeOrganizationRequest { } export namespace DescribeOrganizationRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeOrganizationRequest): any => ({ ...obj, }); @@ -1298,6 +1487,9 @@ export interface DescribeOrganizationResponse { } export namespace DescribeOrganizationResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeOrganizationResponse): any => ({ ...obj, }); @@ -1317,6 +1509,9 @@ export interface DescribeResourceRequest { } export namespace DescribeResourceRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeResourceRequest): any => ({ ...obj, }); @@ -1368,6 +1563,9 @@ export interface DescribeResourceResponse { } export namespace DescribeResourceResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeResourceResponse): any => ({ ...obj, }); @@ -1386,6 +1584,9 @@ export interface DescribeUserRequest { } export namespace DescribeUserRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeUserRequest): any => ({ ...obj, }); @@ -1447,6 +1648,9 @@ export interface DescribeUserResponse { } export namespace DescribeUserResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeUserResponse): any => ({ ...obj, }); @@ -1472,6 +1676,9 @@ export interface DisassociateDelegateFromResourceRequest { } export namespace DisassociateDelegateFromResourceRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DisassociateDelegateFromResourceRequest): any => ({ ...obj, }); @@ -1480,6 +1687,9 @@ export namespace DisassociateDelegateFromResourceRequest { export interface DisassociateDelegateFromResourceResponse {} export namespace DisassociateDelegateFromResourceResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DisassociateDelegateFromResourceResponse): any => ({ ...obj, }); @@ -1503,6 +1713,9 @@ export interface DisassociateMemberFromGroupRequest { } export namespace DisassociateMemberFromGroupRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DisassociateMemberFromGroupRequest): any => ({ ...obj, }); @@ -1511,6 +1724,9 @@ export namespace DisassociateMemberFromGroupRequest { export interface DisassociateMemberFromGroupResponse {} export namespace DisassociateMemberFromGroupResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: DisassociateMemberFromGroupResponse): any => ({ ...obj, }); @@ -1527,6 +1743,9 @@ export interface EntityAlreadyRegisteredException extends __SmithyException, $Me } export namespace EntityAlreadyRegisteredException { + /** + * @internal + */ export const filterSensitiveLog = (obj: EntityAlreadyRegisteredException): any => ({ ...obj, }); @@ -1569,6 +1788,9 @@ export interface FolderConfiguration { } export namespace FolderConfiguration { + /** + * @internal + */ export const filterSensitiveLog = (obj: FolderConfiguration): any => ({ ...obj, }); @@ -1599,6 +1821,9 @@ export interface GetAccessControlEffectRequest { } export namespace GetAccessControlEffectRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetAccessControlEffectRequest): any => ({ ...obj, }); @@ -1617,6 +1842,9 @@ export interface GetAccessControlEffectResponse { } export namespace GetAccessControlEffectResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetAccessControlEffectResponse): any => ({ ...obj, }); @@ -1630,6 +1858,9 @@ export interface GetDefaultRetentionPolicyRequest { } export namespace GetDefaultRetentionPolicyRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetDefaultRetentionPolicyRequest): any => ({ ...obj, }); @@ -1658,6 +1889,9 @@ export interface GetDefaultRetentionPolicyResponse { } export namespace GetDefaultRetentionPolicyResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetDefaultRetentionPolicyResponse): any => ({ ...obj, }); @@ -1677,6 +1911,9 @@ export interface GetMailboxDetailsRequest { } export namespace GetMailboxDetailsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetMailboxDetailsRequest): any => ({ ...obj, }); @@ -1695,6 +1932,9 @@ export interface GetMailboxDetailsResponse { } export namespace GetMailboxDetailsResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetMailboxDetailsResponse): any => ({ ...obj, }); @@ -1728,6 +1968,9 @@ export interface GetMobileDeviceAccessEffectRequest { } export namespace GetMobileDeviceAccessEffectRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetMobileDeviceAccessEffectRequest): any => ({ ...obj, }); @@ -1749,6 +1992,9 @@ export interface MobileDeviceAccessMatchedRule { } export namespace MobileDeviceAccessMatchedRule { + /** + * @internal + */ export const filterSensitiveLog = (obj: MobileDeviceAccessMatchedRule): any => ({ ...obj, }); @@ -1768,6 +2014,9 @@ export interface GetMobileDeviceAccessEffectResponse { } export namespace GetMobileDeviceAccessEffectResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetMobileDeviceAccessEffectResponse): any => ({ ...obj, }); @@ -1809,6 +2058,9 @@ export interface Group { } export namespace Group { + /** + * @internal + */ export const filterSensitiveLog = (obj: Group): any => ({ ...obj, }); @@ -1826,6 +2078,9 @@ export interface InvalidConfigurationException extends __SmithyException, $Metad } export namespace InvalidConfigurationException { + /** + * @internal + */ export const filterSensitiveLog = (obj: InvalidConfigurationException): any => ({ ...obj, }); @@ -1883,6 +2138,9 @@ export interface MailboxExportJob { } export namespace MailboxExportJob { + /** + * @internal + */ export const filterSensitiveLog = (obj: MailboxExportJob): any => ({ ...obj, }); @@ -1896,6 +2154,9 @@ export interface ListAccessControlRulesRequest { } export namespace ListAccessControlRulesRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListAccessControlRulesRequest): any => ({ ...obj, }); @@ -1909,6 +2170,9 @@ export interface ListAccessControlRulesResponse { } export namespace ListAccessControlRulesResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListAccessControlRulesResponse): any => ({ ...obj, }); @@ -1938,6 +2202,9 @@ export interface ListAliasesRequest { } export namespace ListAliasesRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListAliasesRequest): any => ({ ...obj, }); @@ -1957,6 +2224,9 @@ export interface ListAliasesResponse { } export namespace ListAliasesResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListAliasesResponse): any => ({ ...obj, }); @@ -1987,6 +2257,9 @@ export interface ListGroupMembersRequest { } export namespace ListGroupMembersRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListGroupMembersRequest): any => ({ ...obj, }); @@ -2028,6 +2301,9 @@ export interface Member { } export namespace Member { + /** + * @internal + */ export const filterSensitiveLog = (obj: Member): any => ({ ...obj, }); @@ -2047,6 +2323,9 @@ export interface ListGroupMembersResponse { } export namespace ListGroupMembersResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListGroupMembersResponse): any => ({ ...obj, }); @@ -2071,6 +2350,9 @@ export interface ListGroupsRequest { } export namespace ListGroupsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListGroupsRequest): any => ({ ...obj, }); @@ -2090,6 +2372,9 @@ export interface ListGroupsResponse { } export namespace ListGroupsResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListGroupsResponse): any => ({ ...obj, }); @@ -2113,6 +2398,9 @@ export interface ListMailboxExportJobsRequest { } export namespace ListMailboxExportJobsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListMailboxExportJobsRequest): any => ({ ...obj, }); @@ -2131,6 +2419,9 @@ export interface ListMailboxExportJobsResponse { } export namespace ListMailboxExportJobsResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListMailboxExportJobsResponse): any => ({ ...obj, }); @@ -2162,6 +2453,9 @@ export interface ListMailboxPermissionsRequest { } export namespace ListMailboxPermissionsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListMailboxPermissionsRequest): any => ({ ...obj, }); @@ -2201,6 +2495,9 @@ export interface Permission { } export namespace Permission { + /** + * @internal + */ export const filterSensitiveLog = (obj: Permission): any => ({ ...obj, }); @@ -2220,6 +2517,9 @@ export interface ListMailboxPermissionsResponse { } export namespace ListMailboxPermissionsResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListMailboxPermissionsResponse): any => ({ ...obj, }); @@ -2233,6 +2533,9 @@ export interface ListMobileDeviceAccessRulesRequest { } export namespace ListMobileDeviceAccessRulesRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListMobileDeviceAccessRulesRequest): any => ({ ...obj, }); @@ -2314,6 +2617,9 @@ export interface MobileDeviceAccessRule { } export namespace MobileDeviceAccessRule { + /** + * @internal + */ export const filterSensitiveLog = (obj: MobileDeviceAccessRule): any => ({ ...obj, }); @@ -2327,6 +2633,9 @@ export interface ListMobileDeviceAccessRulesResponse { } export namespace ListMobileDeviceAccessRulesResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListMobileDeviceAccessRulesResponse): any => ({ ...obj, }); @@ -2346,6 +2655,9 @@ export interface ListOrganizationsRequest { } export namespace ListOrganizationsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListOrganizationsRequest): any => ({ ...obj, }); @@ -2384,6 +2696,9 @@ export interface OrganizationSummary { } export namespace OrganizationSummary { + /** + * @internal + */ export const filterSensitiveLog = (obj: OrganizationSummary): any => ({ ...obj, }); @@ -2404,6 +2719,9 @@ export interface ListOrganizationsResponse { } export namespace ListOrganizationsResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListOrganizationsResponse): any => ({ ...obj, }); @@ -2434,6 +2752,9 @@ export interface ListResourceDelegatesRequest { } export namespace ListResourceDelegatesRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListResourceDelegatesRequest): any => ({ ...obj, }); @@ -2454,6 +2775,9 @@ export interface ListResourceDelegatesResponse { } export namespace ListResourceDelegatesResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListResourceDelegatesResponse): any => ({ ...obj, }); @@ -2478,6 +2802,9 @@ export interface ListResourcesRequest { } export namespace ListResourcesRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListResourcesRequest): any => ({ ...obj, }); @@ -2524,6 +2851,9 @@ export interface Resource { } export namespace Resource { + /** + * @internal + */ export const filterSensitiveLog = (obj: Resource): any => ({ ...obj, }); @@ -2544,6 +2874,9 @@ export interface ListResourcesResponse { } export namespace ListResourcesResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListResourcesResponse): any => ({ ...obj, }); @@ -2557,6 +2890,9 @@ export interface ListTagsForResourceRequest { } export namespace ListTagsForResourceRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListTagsForResourceRequest): any => ({ ...obj, }); @@ -2578,6 +2914,9 @@ export interface Tag { } export namespace Tag { + /** + * @internal + */ export const filterSensitiveLog = (obj: Tag): any => ({ ...obj, }); @@ -2591,6 +2930,9 @@ export interface ListTagsForResourceResponse { } export namespace ListTagsForResourceResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListTagsForResourceResponse): any => ({ ...obj, }); @@ -2606,6 +2948,9 @@ export interface ResourceNotFoundException extends __SmithyException, $MetadataB } export namespace ResourceNotFoundException { + /** + * @internal + */ export const filterSensitiveLog = (obj: ResourceNotFoundException): any => ({ ...obj, }); @@ -2630,6 +2975,9 @@ export interface ListUsersRequest { } export namespace ListUsersRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListUsersRequest): any => ({ ...obj, }); @@ -2681,6 +3029,9 @@ export interface User { } export namespace User { + /** + * @internal + */ export const filterSensitiveLog = (obj: User): any => ({ ...obj, }); @@ -2700,6 +3051,9 @@ export interface ListUsersResponse { } export namespace ListUsersResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListUsersResponse): any => ({ ...obj, }); @@ -2762,6 +3116,9 @@ export interface PutAccessControlRuleRequest { } export namespace PutAccessControlRuleRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: PutAccessControlRuleRequest): any => ({ ...obj, }); @@ -2770,6 +3127,9 @@ export namespace PutAccessControlRuleRequest { export interface PutAccessControlRuleResponse {} export namespace PutAccessControlRuleResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: PutAccessControlRuleResponse): any => ({ ...obj, }); @@ -2806,6 +3166,9 @@ export interface PutMailboxPermissionsRequest { } export namespace PutMailboxPermissionsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: PutMailboxPermissionsRequest): any => ({ ...obj, }); @@ -2814,6 +3177,9 @@ export namespace PutMailboxPermissionsRequest { export interface PutMailboxPermissionsResponse {} export namespace PutMailboxPermissionsResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: PutMailboxPermissionsResponse): any => ({ ...obj, }); @@ -2847,6 +3213,9 @@ export interface PutRetentionPolicyRequest { } export namespace PutRetentionPolicyRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: PutRetentionPolicyRequest): any => ({ ...obj, ...(obj.Description && { Description: SENSITIVE_STRING }), @@ -2856,6 +3225,9 @@ export namespace PutRetentionPolicyRequest { export interface PutRetentionPolicyResponse {} export namespace PutRetentionPolicyResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: PutRetentionPolicyResponse): any => ({ ...obj, }); @@ -2880,6 +3252,9 @@ export interface RegisterToWorkMailRequest { } export namespace RegisterToWorkMailRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: RegisterToWorkMailRequest): any => ({ ...obj, }); @@ -2888,6 +3263,9 @@ export namespace RegisterToWorkMailRequest { export interface RegisterToWorkMailResponse {} export namespace RegisterToWorkMailResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: RegisterToWorkMailResponse): any => ({ ...obj, }); @@ -2912,6 +3290,9 @@ export interface ResetPasswordRequest { } export namespace ResetPasswordRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ResetPasswordRequest): any => ({ ...obj, ...(obj.Password && { Password: SENSITIVE_STRING }), @@ -2921,6 +3302,9 @@ export namespace ResetPasswordRequest { export interface ResetPasswordResponse {} export namespace ResetPasswordResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ResetPasswordResponse): any => ({ ...obj, }); @@ -2971,6 +3355,9 @@ export interface StartMailboxExportJobRequest { } export namespace StartMailboxExportJobRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: StartMailboxExportJobRequest): any => ({ ...obj, }); @@ -2984,6 +3371,9 @@ export interface StartMailboxExportJobResponse { } export namespace StartMailboxExportJobResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: StartMailboxExportJobResponse): any => ({ ...obj, }); @@ -3002,6 +3392,9 @@ export interface TagResourceRequest { } export namespace TagResourceRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: TagResourceRequest): any => ({ ...obj, }); @@ -3010,6 +3403,9 @@ export namespace TagResourceRequest { export interface TagResourceResponse {} export namespace TagResourceResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: TagResourceResponse): any => ({ ...obj, }); @@ -3025,6 +3421,9 @@ export interface TooManyTagsException extends __SmithyException, $MetadataBearer } export namespace TooManyTagsException { + /** + * @internal + */ export const filterSensitiveLog = (obj: TooManyTagsException): any => ({ ...obj, }); @@ -3043,6 +3442,9 @@ export interface UntagResourceRequest { } export namespace UntagResourceRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: UntagResourceRequest): any => ({ ...obj, }); @@ -3051,6 +3453,9 @@ export namespace UntagResourceRequest { export interface UntagResourceResponse {} export namespace UntagResourceResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: UntagResourceResponse): any => ({ ...obj, }); @@ -3075,6 +3480,9 @@ export interface UpdateMailboxQuotaRequest { } export namespace UpdateMailboxQuotaRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateMailboxQuotaRequest): any => ({ ...obj, }); @@ -3083,6 +3491,9 @@ export namespace UpdateMailboxQuotaRequest { export interface UpdateMailboxQuotaResponse {} export namespace UpdateMailboxQuotaResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateMailboxQuotaResponse): any => ({ ...obj, }); @@ -3156,6 +3567,9 @@ export interface UpdateMobileDeviceAccessRuleRequest { } export namespace UpdateMobileDeviceAccessRuleRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateMobileDeviceAccessRuleRequest): any => ({ ...obj, }); @@ -3164,6 +3578,9 @@ export namespace UpdateMobileDeviceAccessRuleRequest { export interface UpdateMobileDeviceAccessRuleResponse {} export namespace UpdateMobileDeviceAccessRuleResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateMobileDeviceAccessRuleResponse): any => ({ ...obj, }); @@ -3187,6 +3604,9 @@ export interface UpdatePrimaryEmailAddressRequest { } export namespace UpdatePrimaryEmailAddressRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdatePrimaryEmailAddressRequest): any => ({ ...obj, }); @@ -3195,6 +3615,9 @@ export namespace UpdatePrimaryEmailAddressRequest { export interface UpdatePrimaryEmailAddressResponse {} export namespace UpdatePrimaryEmailAddressResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdatePrimaryEmailAddressResponse): any => ({ ...obj, }); @@ -3224,6 +3647,9 @@ export interface UpdateResourceRequest { } export namespace UpdateResourceRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateResourceRequest): any => ({ ...obj, }); @@ -3232,6 +3658,9 @@ export namespace UpdateResourceRequest { export interface UpdateResourceResponse {} export namespace UpdateResourceResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateResourceResponse): any => ({ ...obj, }); diff --git a/clients/client-workmailmessageflow/commands/GetRawMessageContentCommand.ts b/clients/client-workmailmessageflow/commands/GetRawMessageContentCommand.ts index e72f9b981c22..c829743e4384 100644 --- a/clients/client-workmailmessageflow/commands/GetRawMessageContentCommand.ts +++ b/clients/client-workmailmessageflow/commands/GetRawMessageContentCommand.ts @@ -26,6 +26,20 @@ export interface GetRawMessageContentCommandOutput extends GetRawMessageContentR /** *

Retrieves the raw content of an in-transit email message, in MIME format.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { WorkMailMessageFlowClient, GetRawMessageContentCommand } from "@aws-sdk/client-workmailmessageflow"; // ES Modules import + * // const { WorkMailMessageFlowClient, GetRawMessageContentCommand } = require("@aws-sdk/client-workmailmessageflow"); // CommonJS import + * const client = new WorkMailMessageFlowClient(config); + * const command = new GetRawMessageContentCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetRawMessageContentCommandInput} for command's `input` shape. + * @see {@link GetRawMessageContentCommandOutput} for command's `response` shape. + * @see {@link WorkMailMessageFlowClientResolvedConfig | config} for command's `input` shape. + * */ export class GetRawMessageContentCommand extends $Command< GetRawMessageContentCommandInput, diff --git a/clients/client-workmailmessageflow/commands/PutRawMessageContentCommand.ts b/clients/client-workmailmessageflow/commands/PutRawMessageContentCommand.ts index 9468bf497eb1..d59a38e4259c 100644 --- a/clients/client-workmailmessageflow/commands/PutRawMessageContentCommand.ts +++ b/clients/client-workmailmessageflow/commands/PutRawMessageContentCommand.ts @@ -39,6 +39,20 @@ export interface PutRawMessageContentCommandOutput extends PutRawMessageContentR * message. *

* + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { WorkMailMessageFlowClient, PutRawMessageContentCommand } from "@aws-sdk/client-workmailmessageflow"; // ES Modules import + * // const { WorkMailMessageFlowClient, PutRawMessageContentCommand } = require("@aws-sdk/client-workmailmessageflow"); // CommonJS import + * const client = new WorkMailMessageFlowClient(config); + * const command = new PutRawMessageContentCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link PutRawMessageContentCommandInput} for command's `input` shape. + * @see {@link PutRawMessageContentCommandOutput} for command's `response` shape. + * @see {@link WorkMailMessageFlowClientResolvedConfig | config} for command's `input` shape. + * */ export class PutRawMessageContentCommand extends $Command< PutRawMessageContentCommandInput, diff --git a/clients/client-workmailmessageflow/models/models_0.ts b/clients/client-workmailmessageflow/models/models_0.ts index 8d748c0dc255..d8b24555a1ae 100644 --- a/clients/client-workmailmessageflow/models/models_0.ts +++ b/clients/client-workmailmessageflow/models/models_0.ts @@ -10,6 +10,9 @@ export interface GetRawMessageContentRequest { } export namespace GetRawMessageContentRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetRawMessageContentRequest): any => ({ ...obj, }); @@ -23,6 +26,9 @@ export interface GetRawMessageContentResponse { } export namespace GetRawMessageContentResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetRawMessageContentResponse): any => ({ ...obj, }); @@ -38,6 +44,9 @@ export interface ResourceNotFoundException extends __SmithyException, $MetadataB } export namespace ResourceNotFoundException { + /** + * @internal + */ export const filterSensitiveLog = (obj: ResourceNotFoundException): any => ({ ...obj, }); @@ -69,6 +78,9 @@ export interface InvalidContentLocation extends __SmithyException, $MetadataBear } export namespace InvalidContentLocation { + /** + * @internal + */ export const filterSensitiveLog = (obj: InvalidContentLocation): any => ({ ...obj, }); @@ -84,6 +96,9 @@ export interface MessageFrozen extends __SmithyException, $MetadataBearer { } export namespace MessageFrozen { + /** + * @internal + */ export const filterSensitiveLog = (obj: MessageFrozen): any => ({ ...obj, }); @@ -100,6 +115,9 @@ export interface MessageRejected extends __SmithyException, $MetadataBearer { } export namespace MessageRejected { + /** + * @internal + */ export const filterSensitiveLog = (obj: MessageRejected): any => ({ ...obj, }); @@ -132,6 +150,9 @@ export interface S3Reference { } export namespace S3Reference { + /** + * @internal + */ export const filterSensitiveLog = (obj: S3Reference): any => ({ ...obj, }); @@ -174,6 +195,9 @@ export interface RawMessageContent { } export namespace RawMessageContent { + /** + * @internal + */ export const filterSensitiveLog = (obj: RawMessageContent): any => ({ ...obj, }); @@ -192,6 +216,9 @@ export interface PutRawMessageContentRequest { } export namespace PutRawMessageContentRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: PutRawMessageContentRequest): any => ({ ...obj, }); @@ -200,6 +227,9 @@ export namespace PutRawMessageContentRequest { export interface PutRawMessageContentResponse {} export namespace PutRawMessageContentResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: PutRawMessageContentResponse): any => ({ ...obj, }); diff --git a/clients/client-workspaces/commands/AssociateConnectionAliasCommand.ts b/clients/client-workspaces/commands/AssociateConnectionAliasCommand.ts index e31b927ce059..6798b3f01636 100644 --- a/clients/client-workspaces/commands/AssociateConnectionAliasCommand.ts +++ b/clients/client-workspaces/commands/AssociateConnectionAliasCommand.ts @@ -29,6 +29,20 @@ export interface AssociateConnectionAliasCommandOutput extends AssociateConnecti *

Before performing this operation, call * DescribeConnectionAliases to make sure that the current state of the connection alias is CREATED.

* + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { WorkSpacesClient, AssociateConnectionAliasCommand } from "@aws-sdk/client-workspaces"; // ES Modules import + * // const { WorkSpacesClient, AssociateConnectionAliasCommand } = require("@aws-sdk/client-workspaces"); // CommonJS import + * const client = new WorkSpacesClient(config); + * const command = new AssociateConnectionAliasCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link AssociateConnectionAliasCommandInput} for command's `input` shape. + * @see {@link AssociateConnectionAliasCommandOutput} for command's `response` shape. + * @see {@link WorkSpacesClientResolvedConfig | config} for command's `input` shape. + * */ export class AssociateConnectionAliasCommand extends $Command< AssociateConnectionAliasCommandInput, diff --git a/clients/client-workspaces/commands/AssociateIpGroupsCommand.ts b/clients/client-workspaces/commands/AssociateIpGroupsCommand.ts index 1a83f53544a6..7af371209782 100644 --- a/clients/client-workspaces/commands/AssociateIpGroupsCommand.ts +++ b/clients/client-workspaces/commands/AssociateIpGroupsCommand.ts @@ -22,6 +22,20 @@ export interface AssociateIpGroupsCommandOutput extends AssociateIpGroupsResult, /** *

Associates the specified IP access control group with the specified directory.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { WorkSpacesClient, AssociateIpGroupsCommand } from "@aws-sdk/client-workspaces"; // ES Modules import + * // const { WorkSpacesClient, AssociateIpGroupsCommand } = require("@aws-sdk/client-workspaces"); // CommonJS import + * const client = new WorkSpacesClient(config); + * const command = new AssociateIpGroupsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link AssociateIpGroupsCommandInput} for command's `input` shape. + * @see {@link AssociateIpGroupsCommandOutput} for command's `response` shape. + * @see {@link WorkSpacesClientResolvedConfig | config} for command's `input` shape. + * */ export class AssociateIpGroupsCommand extends $Command< AssociateIpGroupsCommandInput, diff --git a/clients/client-workspaces/commands/AuthorizeIpRulesCommand.ts b/clients/client-workspaces/commands/AuthorizeIpRulesCommand.ts index bd6019dd7b71..f0764f324f8e 100644 --- a/clients/client-workspaces/commands/AuthorizeIpRulesCommand.ts +++ b/clients/client-workspaces/commands/AuthorizeIpRulesCommand.ts @@ -24,6 +24,20 @@ export interface AuthorizeIpRulesCommandOutput extends AuthorizeIpRulesResult, _ *

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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { WorkSpacesClient, AuthorizeIpRulesCommand } from "@aws-sdk/client-workspaces"; // ES Modules import + * // const { WorkSpacesClient, AuthorizeIpRulesCommand } = require("@aws-sdk/client-workspaces"); // CommonJS import + * const client = new WorkSpacesClient(config); + * const command = new AuthorizeIpRulesCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link AuthorizeIpRulesCommandInput} for command's `input` shape. + * @see {@link AuthorizeIpRulesCommandOutput} for command's `response` shape. + * @see {@link WorkSpacesClientResolvedConfig | config} for command's `input` shape. + * */ export class AuthorizeIpRulesCommand extends $Command< AuthorizeIpRulesCommandInput, diff --git a/clients/client-workspaces/commands/CopyWorkspaceImageCommand.ts b/clients/client-workspaces/commands/CopyWorkspaceImageCommand.ts index 666224b7f955..ce58d950a42e 100644 --- a/clients/client-workspaces/commands/CopyWorkspaceImageCommand.ts +++ b/clients/client-workspaces/commands/CopyWorkspaceImageCommand.ts @@ -38,6 +38,20 @@ export interface CopyWorkspaceImageCommandOutput extends CopyWorkspaceImageResul * correct AWS account. To determine if an image has been shared and to see the AWS * account ID that owns an image, use the DescribeWorkSpaceImages and DescribeWorkspaceImagePermissions API operations.

* + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { WorkSpacesClient, CopyWorkspaceImageCommand } from "@aws-sdk/client-workspaces"; // ES Modules import + * // const { WorkSpacesClient, CopyWorkspaceImageCommand } = require("@aws-sdk/client-workspaces"); // CommonJS import + * const client = new WorkSpacesClient(config); + * const command = new CopyWorkspaceImageCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CopyWorkspaceImageCommandInput} for command's `input` shape. + * @see {@link CopyWorkspaceImageCommandOutput} for command's `response` shape. + * @see {@link WorkSpacesClientResolvedConfig | config} for command's `input` shape. + * */ export class CopyWorkspaceImageCommand extends $Command< CopyWorkspaceImageCommandInput, diff --git a/clients/client-workspaces/commands/CreateConnectionAliasCommand.ts b/clients/client-workspaces/commands/CreateConnectionAliasCommand.ts index d9df070bbdd5..ebcb6b47cab0 100644 --- a/clients/client-workspaces/commands/CreateConnectionAliasCommand.ts +++ b/clients/client-workspaces/commands/CreateConnectionAliasCommand.ts @@ -24,6 +24,20 @@ export interface CreateConnectionAliasCommandOutput extends CreateConnectionAlia *

Creates the specified connection alias for use with cross-Region redirection. For more information, see * * Cross-Region Redirection for Amazon WorkSpaces.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { WorkSpacesClient, CreateConnectionAliasCommand } from "@aws-sdk/client-workspaces"; // ES Modules import + * // const { WorkSpacesClient, CreateConnectionAliasCommand } = require("@aws-sdk/client-workspaces"); // CommonJS import + * const client = new WorkSpacesClient(config); + * const command = new CreateConnectionAliasCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreateConnectionAliasCommandInput} for command's `input` shape. + * @see {@link CreateConnectionAliasCommandOutput} for command's `response` shape. + * @see {@link WorkSpacesClientResolvedConfig | config} for command's `input` shape. + * */ export class CreateConnectionAliasCommand extends $Command< CreateConnectionAliasCommandInput, diff --git a/clients/client-workspaces/commands/CreateIpGroupCommand.ts b/clients/client-workspaces/commands/CreateIpGroupCommand.ts index 7625da24ab38..0fc4cf9c36e5 100644 --- a/clients/client-workspaces/commands/CreateIpGroupCommand.ts +++ b/clients/client-workspaces/commands/CreateIpGroupCommand.ts @@ -31,6 +31,20 @@ export interface CreateIpGroupCommandOutput extends CreateIpGroupResult, __Metad * 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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { WorkSpacesClient, CreateIpGroupCommand } from "@aws-sdk/client-workspaces"; // ES Modules import + * // const { WorkSpacesClient, CreateIpGroupCommand } = require("@aws-sdk/client-workspaces"); // CommonJS import + * const client = new WorkSpacesClient(config); + * const command = new CreateIpGroupCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreateIpGroupCommandInput} for command's `input` shape. + * @see {@link CreateIpGroupCommandOutput} for command's `response` shape. + * @see {@link WorkSpacesClientResolvedConfig | config} for command's `input` shape. + * */ export class CreateIpGroupCommand extends $Command< CreateIpGroupCommandInput, diff --git a/clients/client-workspaces/commands/CreateTagsCommand.ts b/clients/client-workspaces/commands/CreateTagsCommand.ts index a930518320d4..1c5a236ea16a 100644 --- a/clients/client-workspaces/commands/CreateTagsCommand.ts +++ b/clients/client-workspaces/commands/CreateTagsCommand.ts @@ -22,6 +22,20 @@ export interface CreateTagsCommandOutput extends CreateTagsResult, __MetadataBea /** *

Creates the specified tags for the specified WorkSpaces resource.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { WorkSpacesClient, CreateTagsCommand } from "@aws-sdk/client-workspaces"; // ES Modules import + * // const { WorkSpacesClient, CreateTagsCommand } = require("@aws-sdk/client-workspaces"); // CommonJS import + * const client = new WorkSpacesClient(config); + * const command = new CreateTagsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreateTagsCommandInput} for command's `input` shape. + * @see {@link CreateTagsCommandOutput} for command's `response` shape. + * @see {@link WorkSpacesClientResolvedConfig | config} for command's `input` shape. + * */ export class CreateTagsCommand extends $Command< CreateTagsCommandInput, diff --git a/clients/client-workspaces/commands/CreateWorkspaceBundleCommand.ts b/clients/client-workspaces/commands/CreateWorkspaceBundleCommand.ts index 8ab13830fcdc..3c621fe31885 100644 --- a/clients/client-workspaces/commands/CreateWorkspaceBundleCommand.ts +++ b/clients/client-workspaces/commands/CreateWorkspaceBundleCommand.ts @@ -24,6 +24,20 @@ export interface CreateWorkspaceBundleCommandOutput extends CreateWorkspaceBundl *

Creates the specified WorkSpace bundle. For more information about creating WorkSpace bundles, see * * Create a Custom WorkSpaces Image and Bundle.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { WorkSpacesClient, CreateWorkspaceBundleCommand } from "@aws-sdk/client-workspaces"; // ES Modules import + * // const { WorkSpacesClient, CreateWorkspaceBundleCommand } = require("@aws-sdk/client-workspaces"); // CommonJS import + * const client = new WorkSpacesClient(config); + * const command = new CreateWorkspaceBundleCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreateWorkspaceBundleCommandInput} for command's `input` shape. + * @see {@link CreateWorkspaceBundleCommandOutput} for command's `response` shape. + * @see {@link WorkSpacesClientResolvedConfig | config} for command's `input` shape. + * */ export class CreateWorkspaceBundleCommand extends $Command< CreateWorkspaceBundleCommandInput, diff --git a/clients/client-workspaces/commands/CreateWorkspacesCommand.ts b/clients/client-workspaces/commands/CreateWorkspacesCommand.ts index 14d29d82ddbc..800f8d761c78 100644 --- a/clients/client-workspaces/commands/CreateWorkspacesCommand.ts +++ b/clients/client-workspaces/commands/CreateWorkspacesCommand.ts @@ -23,6 +23,20 @@ export interface CreateWorkspacesCommandOutput extends CreateWorkspacesResult, _ /** *

Creates one or more WorkSpaces.

*

This operation is asynchronous and returns before the WorkSpaces are created.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { WorkSpacesClient, CreateWorkspacesCommand } from "@aws-sdk/client-workspaces"; // ES Modules import + * // const { WorkSpacesClient, CreateWorkspacesCommand } = require("@aws-sdk/client-workspaces"); // CommonJS import + * const client = new WorkSpacesClient(config); + * const command = new CreateWorkspacesCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreateWorkspacesCommandInput} for command's `input` shape. + * @see {@link CreateWorkspacesCommandOutput} for command's `response` shape. + * @see {@link WorkSpacesClientResolvedConfig | config} for command's `input` shape. + * */ export class CreateWorkspacesCommand extends $Command< CreateWorkspacesCommandInput, diff --git a/clients/client-workspaces/commands/DeleteConnectionAliasCommand.ts b/clients/client-workspaces/commands/DeleteConnectionAliasCommand.ts index c8597acbadf1..6bb94e02cd6f 100644 --- a/clients/client-workspaces/commands/DeleteConnectionAliasCommand.ts +++ b/clients/client-workspaces/commands/DeleteConnectionAliasCommand.ts @@ -39,6 +39,20 @@ export interface DeleteConnectionAliasCommandOutput extends DeleteConnectionAlia * been shared with. You can delete a connection alias only after it is no longer shared with any accounts or * associated with any directories.

* + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { WorkSpacesClient, DeleteConnectionAliasCommand } from "@aws-sdk/client-workspaces"; // ES Modules import + * // const { WorkSpacesClient, DeleteConnectionAliasCommand } = require("@aws-sdk/client-workspaces"); // CommonJS import + * const client = new WorkSpacesClient(config); + * const command = new DeleteConnectionAliasCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteConnectionAliasCommandInput} for command's `input` shape. + * @see {@link DeleteConnectionAliasCommandOutput} for command's `response` shape. + * @see {@link WorkSpacesClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteConnectionAliasCommand extends $Command< DeleteConnectionAliasCommandInput, diff --git a/clients/client-workspaces/commands/DeleteIpGroupCommand.ts b/clients/client-workspaces/commands/DeleteIpGroupCommand.ts index 0a3459909234..bd1bf1a279f3 100644 --- a/clients/client-workspaces/commands/DeleteIpGroupCommand.ts +++ b/clients/client-workspaces/commands/DeleteIpGroupCommand.ts @@ -23,6 +23,20 @@ export interface DeleteIpGroupCommandOutput extends DeleteIpGroupResult, __Metad /** *

Deletes the specified IP access control group.

*

You cannot delete an IP access control group that is associated with a directory.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { WorkSpacesClient, DeleteIpGroupCommand } from "@aws-sdk/client-workspaces"; // ES Modules import + * // const { WorkSpacesClient, DeleteIpGroupCommand } = require("@aws-sdk/client-workspaces"); // CommonJS import + * const client = new WorkSpacesClient(config); + * const command = new DeleteIpGroupCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteIpGroupCommandInput} for command's `input` shape. + * @see {@link DeleteIpGroupCommandOutput} for command's `response` shape. + * @see {@link WorkSpacesClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteIpGroupCommand extends $Command< DeleteIpGroupCommandInput, diff --git a/clients/client-workspaces/commands/DeleteTagsCommand.ts b/clients/client-workspaces/commands/DeleteTagsCommand.ts index 1752dd38de43..1aac2ad5a9bb 100644 --- a/clients/client-workspaces/commands/DeleteTagsCommand.ts +++ b/clients/client-workspaces/commands/DeleteTagsCommand.ts @@ -22,6 +22,20 @@ export interface DeleteTagsCommandOutput extends DeleteTagsResult, __MetadataBea /** *

Deletes the specified tags from the specified WorkSpaces resource.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { WorkSpacesClient, DeleteTagsCommand } from "@aws-sdk/client-workspaces"; // ES Modules import + * // const { WorkSpacesClient, DeleteTagsCommand } = require("@aws-sdk/client-workspaces"); // CommonJS import + * const client = new WorkSpacesClient(config); + * const command = new DeleteTagsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteTagsCommandInput} for command's `input` shape. + * @see {@link DeleteTagsCommandOutput} for command's `response` shape. + * @see {@link WorkSpacesClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteTagsCommand extends $Command< DeleteTagsCommandInput, diff --git a/clients/client-workspaces/commands/DeleteWorkspaceBundleCommand.ts b/clients/client-workspaces/commands/DeleteWorkspaceBundleCommand.ts index a2fdb4288435..b119a47724ec 100644 --- a/clients/client-workspaces/commands/DeleteWorkspaceBundleCommand.ts +++ b/clients/client-workspaces/commands/DeleteWorkspaceBundleCommand.ts @@ -24,6 +24,20 @@ export interface DeleteWorkspaceBundleCommandOutput extends DeleteWorkspaceBundl *

Deletes the specified WorkSpace bundle. For more information about deleting WorkSpace bundles, see * * Delete a Custom WorkSpaces Bundle or Image.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { WorkSpacesClient, DeleteWorkspaceBundleCommand } from "@aws-sdk/client-workspaces"; // ES Modules import + * // const { WorkSpacesClient, DeleteWorkspaceBundleCommand } = require("@aws-sdk/client-workspaces"); // CommonJS import + * const client = new WorkSpacesClient(config); + * const command = new DeleteWorkspaceBundleCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteWorkspaceBundleCommandInput} for command's `input` shape. + * @see {@link DeleteWorkspaceBundleCommandOutput} for command's `response` shape. + * @see {@link WorkSpacesClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteWorkspaceBundleCommand extends $Command< DeleteWorkspaceBundleCommandInput, diff --git a/clients/client-workspaces/commands/DeleteWorkspaceImageCommand.ts b/clients/client-workspaces/commands/DeleteWorkspaceImageCommand.ts index 124aec4c43a5..d0d2ff6b6fc3 100644 --- a/clients/client-workspaces/commands/DeleteWorkspaceImageCommand.ts +++ b/clients/client-workspaces/commands/DeleteWorkspaceImageCommand.ts @@ -24,6 +24,20 @@ export interface DeleteWorkspaceImageCommandOutput extends DeleteWorkspaceImageR *

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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { WorkSpacesClient, DeleteWorkspaceImageCommand } from "@aws-sdk/client-workspaces"; // ES Modules import + * // const { WorkSpacesClient, DeleteWorkspaceImageCommand } = require("@aws-sdk/client-workspaces"); // CommonJS import + * const client = new WorkSpacesClient(config); + * const command = new DeleteWorkspaceImageCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteWorkspaceImageCommandInput} for command's `input` shape. + * @see {@link DeleteWorkspaceImageCommandOutput} for command's `response` shape. + * @see {@link WorkSpacesClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteWorkspaceImageCommand extends $Command< DeleteWorkspaceImageCommandInput, diff --git a/clients/client-workspaces/commands/DeregisterWorkspaceDirectoryCommand.ts b/clients/client-workspaces/commands/DeregisterWorkspaceDirectoryCommand.ts index 230627515bc9..da121a16aed0 100644 --- a/clients/client-workspaces/commands/DeregisterWorkspaceDirectoryCommand.ts +++ b/clients/client-workspaces/commands/DeregisterWorkspaceDirectoryCommand.ts @@ -40,6 +40,20 @@ export interface DeregisterWorkspaceDirectoryCommandOutput * Simple AD or AD Connector directory, you can always create a new one when you want to start using * WorkSpaces again.

* + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { WorkSpacesClient, DeregisterWorkspaceDirectoryCommand } from "@aws-sdk/client-workspaces"; // ES Modules import + * // const { WorkSpacesClient, DeregisterWorkspaceDirectoryCommand } = require("@aws-sdk/client-workspaces"); // CommonJS import + * const client = new WorkSpacesClient(config); + * const command = new DeregisterWorkspaceDirectoryCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeregisterWorkspaceDirectoryCommandInput} for command's `input` shape. + * @see {@link DeregisterWorkspaceDirectoryCommandOutput} for command's `response` shape. + * @see {@link WorkSpacesClientResolvedConfig | config} for command's `input` shape. + * */ export class DeregisterWorkspaceDirectoryCommand extends $Command< DeregisterWorkspaceDirectoryCommandInput, diff --git a/clients/client-workspaces/commands/DescribeAccountCommand.ts b/clients/client-workspaces/commands/DescribeAccountCommand.ts index 3cc7bee7c1bd..b98554a0451d 100644 --- a/clients/client-workspaces/commands/DescribeAccountCommand.ts +++ b/clients/client-workspaces/commands/DescribeAccountCommand.ts @@ -23,6 +23,20 @@ export interface DescribeAccountCommandOutput extends DescribeAccountResult, __M /** *

Retrieves a list that describes the configuration of Bring Your Own License (BYOL) for * the specified account.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { WorkSpacesClient, DescribeAccountCommand } from "@aws-sdk/client-workspaces"; // ES Modules import + * // const { WorkSpacesClient, DescribeAccountCommand } = require("@aws-sdk/client-workspaces"); // CommonJS import + * const client = new WorkSpacesClient(config); + * const command = new DescribeAccountCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeAccountCommandInput} for command's `input` shape. + * @see {@link DescribeAccountCommandOutput} for command's `response` shape. + * @see {@link WorkSpacesClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeAccountCommand extends $Command< DescribeAccountCommandInput, diff --git a/clients/client-workspaces/commands/DescribeAccountModificationsCommand.ts b/clients/client-workspaces/commands/DescribeAccountModificationsCommand.ts index db4a0d85a26c..033827a16dcd 100644 --- a/clients/client-workspaces/commands/DescribeAccountModificationsCommand.ts +++ b/clients/client-workspaces/commands/DescribeAccountModificationsCommand.ts @@ -25,6 +25,20 @@ export interface DescribeAccountModificationsCommandOutput /** *

Retrieves a list that describes modifications to the configuration of Bring Your Own * License (BYOL) for the specified account.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { WorkSpacesClient, DescribeAccountModificationsCommand } from "@aws-sdk/client-workspaces"; // ES Modules import + * // const { WorkSpacesClient, DescribeAccountModificationsCommand } = require("@aws-sdk/client-workspaces"); // CommonJS import + * const client = new WorkSpacesClient(config); + * const command = new DescribeAccountModificationsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeAccountModificationsCommandInput} for command's `input` shape. + * @see {@link DescribeAccountModificationsCommandOutput} for command's `response` shape. + * @see {@link WorkSpacesClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeAccountModificationsCommand extends $Command< DescribeAccountModificationsCommandInput, diff --git a/clients/client-workspaces/commands/DescribeClientPropertiesCommand.ts b/clients/client-workspaces/commands/DescribeClientPropertiesCommand.ts index 4f1dd592b531..d7d88022de02 100644 --- a/clients/client-workspaces/commands/DescribeClientPropertiesCommand.ts +++ b/clients/client-workspaces/commands/DescribeClientPropertiesCommand.ts @@ -22,6 +22,20 @@ export interface DescribeClientPropertiesCommandOutput extends DescribeClientPro /** *

Retrieves a list that describes one or more specified Amazon WorkSpaces clients.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { WorkSpacesClient, DescribeClientPropertiesCommand } from "@aws-sdk/client-workspaces"; // ES Modules import + * // const { WorkSpacesClient, DescribeClientPropertiesCommand } = require("@aws-sdk/client-workspaces"); // CommonJS import + * const client = new WorkSpacesClient(config); + * const command = new DescribeClientPropertiesCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeClientPropertiesCommandInput} for command's `input` shape. + * @see {@link DescribeClientPropertiesCommandOutput} for command's `response` shape. + * @see {@link WorkSpacesClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeClientPropertiesCommand extends $Command< DescribeClientPropertiesCommandInput, diff --git a/clients/client-workspaces/commands/DescribeConnectionAliasPermissionsCommand.ts b/clients/client-workspaces/commands/DescribeConnectionAliasPermissionsCommand.ts index 2ecd72a9891a..0eb657230760 100644 --- a/clients/client-workspaces/commands/DescribeConnectionAliasPermissionsCommand.ts +++ b/clients/client-workspaces/commands/DescribeConnectionAliasPermissionsCommand.ts @@ -29,6 +29,20 @@ export interface DescribeConnectionAliasPermissionsCommandOutput *

Describes the permissions that the owner of a connection alias has granted to another AWS account for * the specified connection alias. For more information, see * Cross-Region Redirection for Amazon WorkSpaces.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { WorkSpacesClient, DescribeConnectionAliasPermissionsCommand } from "@aws-sdk/client-workspaces"; // ES Modules import + * // const { WorkSpacesClient, DescribeConnectionAliasPermissionsCommand } = require("@aws-sdk/client-workspaces"); // CommonJS import + * const client = new WorkSpacesClient(config); + * const command = new DescribeConnectionAliasPermissionsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeConnectionAliasPermissionsCommandInput} for command's `input` shape. + * @see {@link DescribeConnectionAliasPermissionsCommandOutput} for command's `response` shape. + * @see {@link WorkSpacesClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeConnectionAliasPermissionsCommand extends $Command< DescribeConnectionAliasPermissionsCommandInput, diff --git a/clients/client-workspaces/commands/DescribeConnectionAliasesCommand.ts b/clients/client-workspaces/commands/DescribeConnectionAliasesCommand.ts index 4fcbcaba771c..05e254aa72fe 100644 --- a/clients/client-workspaces/commands/DescribeConnectionAliasesCommand.ts +++ b/clients/client-workspaces/commands/DescribeConnectionAliasesCommand.ts @@ -24,6 +24,20 @@ export interface DescribeConnectionAliasesCommandOutput extends DescribeConnecti *

Retrieves a list that describes the connection aliases used for cross-Region redirection. For more information, see * * Cross-Region Redirection for Amazon WorkSpaces.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { WorkSpacesClient, DescribeConnectionAliasesCommand } from "@aws-sdk/client-workspaces"; // ES Modules import + * // const { WorkSpacesClient, DescribeConnectionAliasesCommand } = require("@aws-sdk/client-workspaces"); // CommonJS import + * const client = new WorkSpacesClient(config); + * const command = new DescribeConnectionAliasesCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeConnectionAliasesCommandInput} for command's `input` shape. + * @see {@link DescribeConnectionAliasesCommandOutput} for command's `response` shape. + * @see {@link WorkSpacesClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeConnectionAliasesCommand extends $Command< DescribeConnectionAliasesCommandInput, diff --git a/clients/client-workspaces/commands/DescribeIpGroupsCommand.ts b/clients/client-workspaces/commands/DescribeIpGroupsCommand.ts index 91da7e5e4d82..f517add8740c 100644 --- a/clients/client-workspaces/commands/DescribeIpGroupsCommand.ts +++ b/clients/client-workspaces/commands/DescribeIpGroupsCommand.ts @@ -22,6 +22,20 @@ export interface DescribeIpGroupsCommandOutput extends DescribeIpGroupsResult, _ /** *

Describes one or more of your IP access control groups.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { WorkSpacesClient, DescribeIpGroupsCommand } from "@aws-sdk/client-workspaces"; // ES Modules import + * // const { WorkSpacesClient, DescribeIpGroupsCommand } = require("@aws-sdk/client-workspaces"); // CommonJS import + * const client = new WorkSpacesClient(config); + * const command = new DescribeIpGroupsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeIpGroupsCommandInput} for command's `input` shape. + * @see {@link DescribeIpGroupsCommandOutput} for command's `response` shape. + * @see {@link WorkSpacesClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeIpGroupsCommand extends $Command< DescribeIpGroupsCommandInput, diff --git a/clients/client-workspaces/commands/DescribeTagsCommand.ts b/clients/client-workspaces/commands/DescribeTagsCommand.ts index eed01e7f342b..5dd34c93f1b7 100644 --- a/clients/client-workspaces/commands/DescribeTagsCommand.ts +++ b/clients/client-workspaces/commands/DescribeTagsCommand.ts @@ -22,6 +22,20 @@ export interface DescribeTagsCommandOutput extends DescribeTagsResult, __Metadat /** *

Describes the specified tags for the specified WorkSpaces resource.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { WorkSpacesClient, DescribeTagsCommand } from "@aws-sdk/client-workspaces"; // ES Modules import + * // const { WorkSpacesClient, DescribeTagsCommand } = require("@aws-sdk/client-workspaces"); // CommonJS import + * const client = new WorkSpacesClient(config); + * const command = new DescribeTagsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeTagsCommandInput} for command's `input` shape. + * @see {@link DescribeTagsCommandOutput} for command's `response` shape. + * @see {@link WorkSpacesClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeTagsCommand extends $Command< DescribeTagsCommandInput, diff --git a/clients/client-workspaces/commands/DescribeWorkspaceBundlesCommand.ts b/clients/client-workspaces/commands/DescribeWorkspaceBundlesCommand.ts index 4164fdc3fe4c..79979080dd74 100644 --- a/clients/client-workspaces/commands/DescribeWorkspaceBundlesCommand.ts +++ b/clients/client-workspaces/commands/DescribeWorkspaceBundlesCommand.ts @@ -23,6 +23,20 @@ export interface DescribeWorkspaceBundlesCommandOutput extends DescribeWorkspace /** *

Retrieves a list that describes the available WorkSpace bundles.

*

You can filter the results using either bundle ID or owner, but not both.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { WorkSpacesClient, DescribeWorkspaceBundlesCommand } from "@aws-sdk/client-workspaces"; // ES Modules import + * // const { WorkSpacesClient, DescribeWorkspaceBundlesCommand } = require("@aws-sdk/client-workspaces"); // CommonJS import + * const client = new WorkSpacesClient(config); + * const command = new DescribeWorkspaceBundlesCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeWorkspaceBundlesCommandInput} for command's `input` shape. + * @see {@link DescribeWorkspaceBundlesCommandOutput} for command's `response` shape. + * @see {@link WorkSpacesClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeWorkspaceBundlesCommand extends $Command< DescribeWorkspaceBundlesCommandInput, diff --git a/clients/client-workspaces/commands/DescribeWorkspaceDirectoriesCommand.ts b/clients/client-workspaces/commands/DescribeWorkspaceDirectoriesCommand.ts index 6881209048e2..a75ae4334140 100644 --- a/clients/client-workspaces/commands/DescribeWorkspaceDirectoriesCommand.ts +++ b/clients/client-workspaces/commands/DescribeWorkspaceDirectoriesCommand.ts @@ -25,6 +25,20 @@ export interface DescribeWorkspaceDirectoriesCommandOutput /** *

Describes the available directories that are registered with * Amazon WorkSpaces.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { WorkSpacesClient, DescribeWorkspaceDirectoriesCommand } from "@aws-sdk/client-workspaces"; // ES Modules import + * // const { WorkSpacesClient, DescribeWorkspaceDirectoriesCommand } = require("@aws-sdk/client-workspaces"); // CommonJS import + * const client = new WorkSpacesClient(config); + * const command = new DescribeWorkspaceDirectoriesCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeWorkspaceDirectoriesCommandInput} for command's `input` shape. + * @see {@link DescribeWorkspaceDirectoriesCommandOutput} for command's `response` shape. + * @see {@link WorkSpacesClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeWorkspaceDirectoriesCommand extends $Command< DescribeWorkspaceDirectoriesCommandInput, diff --git a/clients/client-workspaces/commands/DescribeWorkspaceImagePermissionsCommand.ts b/clients/client-workspaces/commands/DescribeWorkspaceImagePermissionsCommand.ts index 36a1f05268b9..bbc9b82e5076 100644 --- a/clients/client-workspaces/commands/DescribeWorkspaceImagePermissionsCommand.ts +++ b/clients/client-workspaces/commands/DescribeWorkspaceImagePermissionsCommand.ts @@ -25,6 +25,20 @@ export interface DescribeWorkspaceImagePermissionsCommandOutput /** *

Describes the permissions that the owner of an image has granted to other * AWS accounts for an image.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { WorkSpacesClient, DescribeWorkspaceImagePermissionsCommand } from "@aws-sdk/client-workspaces"; // ES Modules import + * // const { WorkSpacesClient, DescribeWorkspaceImagePermissionsCommand } = require("@aws-sdk/client-workspaces"); // CommonJS import + * const client = new WorkSpacesClient(config); + * const command = new DescribeWorkspaceImagePermissionsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeWorkspaceImagePermissionsCommandInput} for command's `input` shape. + * @see {@link DescribeWorkspaceImagePermissionsCommandOutput} for command's `response` shape. + * @see {@link WorkSpacesClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeWorkspaceImagePermissionsCommand extends $Command< DescribeWorkspaceImagePermissionsCommandInput, diff --git a/clients/client-workspaces/commands/DescribeWorkspaceImagesCommand.ts b/clients/client-workspaces/commands/DescribeWorkspaceImagesCommand.ts index aab4ceafaaca..f86293db3fd7 100644 --- a/clients/client-workspaces/commands/DescribeWorkspaceImagesCommand.ts +++ b/clients/client-workspaces/commands/DescribeWorkspaceImagesCommand.ts @@ -23,6 +23,20 @@ export interface DescribeWorkspaceImagesCommandOutput extends DescribeWorkspaceI /** *

Retrieves a list that describes one or more specified images, if the image identifiers * are provided. Otherwise, all images in the account are described.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { WorkSpacesClient, DescribeWorkspaceImagesCommand } from "@aws-sdk/client-workspaces"; // ES Modules import + * // const { WorkSpacesClient, DescribeWorkspaceImagesCommand } = require("@aws-sdk/client-workspaces"); // CommonJS import + * const client = new WorkSpacesClient(config); + * const command = new DescribeWorkspaceImagesCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeWorkspaceImagesCommandInput} for command's `input` shape. + * @see {@link DescribeWorkspaceImagesCommandOutput} for command's `response` shape. + * @see {@link WorkSpacesClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeWorkspaceImagesCommand extends $Command< DescribeWorkspaceImagesCommandInput, diff --git a/clients/client-workspaces/commands/DescribeWorkspaceSnapshotsCommand.ts b/clients/client-workspaces/commands/DescribeWorkspaceSnapshotsCommand.ts index 8ab89710a9b1..ecbd69fdcf33 100644 --- a/clients/client-workspaces/commands/DescribeWorkspaceSnapshotsCommand.ts +++ b/clients/client-workspaces/commands/DescribeWorkspaceSnapshotsCommand.ts @@ -22,6 +22,20 @@ export interface DescribeWorkspaceSnapshotsCommandOutput extends DescribeWorkspa /** *

Describes the snapshots for the specified WorkSpace.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { WorkSpacesClient, DescribeWorkspaceSnapshotsCommand } from "@aws-sdk/client-workspaces"; // ES Modules import + * // const { WorkSpacesClient, DescribeWorkspaceSnapshotsCommand } = require("@aws-sdk/client-workspaces"); // CommonJS import + * const client = new WorkSpacesClient(config); + * const command = new DescribeWorkspaceSnapshotsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeWorkspaceSnapshotsCommandInput} for command's `input` shape. + * @see {@link DescribeWorkspaceSnapshotsCommandOutput} for command's `response` shape. + * @see {@link WorkSpacesClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeWorkspaceSnapshotsCommand extends $Command< DescribeWorkspaceSnapshotsCommandInput, diff --git a/clients/client-workspaces/commands/DescribeWorkspacesCommand.ts b/clients/client-workspaces/commands/DescribeWorkspacesCommand.ts index 37eac14dd963..b760d3b94ed8 100644 --- a/clients/client-workspaces/commands/DescribeWorkspacesCommand.ts +++ b/clients/client-workspaces/commands/DescribeWorkspacesCommand.ts @@ -24,6 +24,20 @@ export interface DescribeWorkspacesCommandOutput extends DescribeWorkspacesResul *

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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { WorkSpacesClient, DescribeWorkspacesCommand } from "@aws-sdk/client-workspaces"; // ES Modules import + * // const { WorkSpacesClient, DescribeWorkspacesCommand } = require("@aws-sdk/client-workspaces"); // CommonJS import + * const client = new WorkSpacesClient(config); + * const command = new DescribeWorkspacesCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeWorkspacesCommandInput} for command's `input` shape. + * @see {@link DescribeWorkspacesCommandOutput} for command's `response` shape. + * @see {@link WorkSpacesClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeWorkspacesCommand extends $Command< DescribeWorkspacesCommandInput, diff --git a/clients/client-workspaces/commands/DescribeWorkspacesConnectionStatusCommand.ts b/clients/client-workspaces/commands/DescribeWorkspacesConnectionStatusCommand.ts index e885873ae93f..3969ee086b8f 100644 --- a/clients/client-workspaces/commands/DescribeWorkspacesConnectionStatusCommand.ts +++ b/clients/client-workspaces/commands/DescribeWorkspacesConnectionStatusCommand.ts @@ -27,6 +27,20 @@ export interface DescribeWorkspacesConnectionStatusCommandOutput /** *

Describes the connection status of the specified WorkSpaces.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { WorkSpacesClient, DescribeWorkspacesConnectionStatusCommand } from "@aws-sdk/client-workspaces"; // ES Modules import + * // const { WorkSpacesClient, DescribeWorkspacesConnectionStatusCommand } = require("@aws-sdk/client-workspaces"); // CommonJS import + * const client = new WorkSpacesClient(config); + * const command = new DescribeWorkspacesConnectionStatusCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeWorkspacesConnectionStatusCommandInput} for command's `input` shape. + * @see {@link DescribeWorkspacesConnectionStatusCommandOutput} for command's `response` shape. + * @see {@link WorkSpacesClientResolvedConfig | config} for command's `input` shape. + * */ export class DescribeWorkspacesConnectionStatusCommand extends $Command< DescribeWorkspacesConnectionStatusCommandInput, diff --git a/clients/client-workspaces/commands/DisassociateConnectionAliasCommand.ts b/clients/client-workspaces/commands/DisassociateConnectionAliasCommand.ts index b6a8f8442a24..f2becf4780bb 100644 --- a/clients/client-workspaces/commands/DisassociateConnectionAliasCommand.ts +++ b/clients/client-workspaces/commands/DisassociateConnectionAliasCommand.ts @@ -30,6 +30,20 @@ export interface DisassociateConnectionAliasCommandOutput extends DisassociateCo *

Before performing this operation, call * DescribeConnectionAliases to make sure that the current state of the connection alias is CREATED.

* + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { WorkSpacesClient, DisassociateConnectionAliasCommand } from "@aws-sdk/client-workspaces"; // ES Modules import + * // const { WorkSpacesClient, DisassociateConnectionAliasCommand } = require("@aws-sdk/client-workspaces"); // CommonJS import + * const client = new WorkSpacesClient(config); + * const command = new DisassociateConnectionAliasCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DisassociateConnectionAliasCommandInput} for command's `input` shape. + * @see {@link DisassociateConnectionAliasCommandOutput} for command's `response` shape. + * @see {@link WorkSpacesClientResolvedConfig | config} for command's `input` shape. + * */ export class DisassociateConnectionAliasCommand extends $Command< DisassociateConnectionAliasCommandInput, diff --git a/clients/client-workspaces/commands/DisassociateIpGroupsCommand.ts b/clients/client-workspaces/commands/DisassociateIpGroupsCommand.ts index e7d7faea55bf..6fcb8436a3fa 100644 --- a/clients/client-workspaces/commands/DisassociateIpGroupsCommand.ts +++ b/clients/client-workspaces/commands/DisassociateIpGroupsCommand.ts @@ -22,6 +22,20 @@ export interface DisassociateIpGroupsCommandOutput extends DisassociateIpGroupsR /** *

Disassociates the specified IP access control group from the specified directory.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { WorkSpacesClient, DisassociateIpGroupsCommand } from "@aws-sdk/client-workspaces"; // ES Modules import + * // const { WorkSpacesClient, DisassociateIpGroupsCommand } = require("@aws-sdk/client-workspaces"); // CommonJS import + * const client = new WorkSpacesClient(config); + * const command = new DisassociateIpGroupsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DisassociateIpGroupsCommandInput} for command's `input` shape. + * @see {@link DisassociateIpGroupsCommandOutput} for command's `response` shape. + * @see {@link WorkSpacesClientResolvedConfig | config} for command's `input` shape. + * */ export class DisassociateIpGroupsCommand extends $Command< DisassociateIpGroupsCommandInput, diff --git a/clients/client-workspaces/commands/ImportWorkspaceImageCommand.ts b/clients/client-workspaces/commands/ImportWorkspaceImageCommand.ts index 158d4e454aa8..4efc9720bbb4 100644 --- a/clients/client-workspaces/commands/ImportWorkspaceImageCommand.ts +++ b/clients/client-workspaces/commands/ImportWorkspaceImageCommand.ts @@ -26,6 +26,20 @@ export interface ImportWorkspaceImageCommandOutput extends ImportWorkspaceImageR * account, and you must own the image. For more information about creating BYOL images, see * * Bring Your Own Windows Desktop Licenses.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { WorkSpacesClient, ImportWorkspaceImageCommand } from "@aws-sdk/client-workspaces"; // ES Modules import + * // const { WorkSpacesClient, ImportWorkspaceImageCommand } = require("@aws-sdk/client-workspaces"); // CommonJS import + * const client = new WorkSpacesClient(config); + * const command = new ImportWorkspaceImageCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ImportWorkspaceImageCommandInput} for command's `input` shape. + * @see {@link ImportWorkspaceImageCommandOutput} for command's `response` shape. + * @see {@link WorkSpacesClientResolvedConfig | config} for command's `input` shape. + * */ export class ImportWorkspaceImageCommand extends $Command< ImportWorkspaceImageCommandInput, diff --git a/clients/client-workspaces/commands/ListAvailableManagementCidrRangesCommand.ts b/clients/client-workspaces/commands/ListAvailableManagementCidrRangesCommand.ts index 9a4ffd687417..9a9beb66e1a9 100644 --- a/clients/client-workspaces/commands/ListAvailableManagementCidrRangesCommand.ts +++ b/clients/client-workspaces/commands/ListAvailableManagementCidrRangesCommand.ts @@ -32,6 +32,20 @@ export interface ListAvailableManagementCidrRangesCommandOutput *

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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { WorkSpacesClient, ListAvailableManagementCidrRangesCommand } from "@aws-sdk/client-workspaces"; // ES Modules import + * // const { WorkSpacesClient, ListAvailableManagementCidrRangesCommand } = require("@aws-sdk/client-workspaces"); // CommonJS import + * const client = new WorkSpacesClient(config); + * const command = new ListAvailableManagementCidrRangesCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListAvailableManagementCidrRangesCommandInput} for command's `input` shape. + * @see {@link ListAvailableManagementCidrRangesCommandOutput} for command's `response` shape. + * @see {@link WorkSpacesClientResolvedConfig | config} for command's `input` shape. + * */ export class ListAvailableManagementCidrRangesCommand extends $Command< ListAvailableManagementCidrRangesCommandInput, diff --git a/clients/client-workspaces/commands/MigrateWorkspaceCommand.ts b/clients/client-workspaces/commands/MigrateWorkspaceCommand.ts index e71cf0f67841..3474aa4b1736 100644 --- a/clients/client-workspaces/commands/MigrateWorkspaceCommand.ts +++ b/clients/client-workspaces/commands/MigrateWorkspaceCommand.ts @@ -30,6 +30,20 @@ export interface MigrateWorkspaceCommandOutput extends MigrateWorkspaceResult, _ * *

For available migration scenarios, details about what happens during migration, and best practices, see * Migrate a WorkSpace.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { WorkSpacesClient, MigrateWorkspaceCommand } from "@aws-sdk/client-workspaces"; // ES Modules import + * // const { WorkSpacesClient, MigrateWorkspaceCommand } = require("@aws-sdk/client-workspaces"); // CommonJS import + * const client = new WorkSpacesClient(config); + * const command = new MigrateWorkspaceCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link MigrateWorkspaceCommandInput} for command's `input` shape. + * @see {@link MigrateWorkspaceCommandOutput} for command's `response` shape. + * @see {@link WorkSpacesClientResolvedConfig | config} for command's `input` shape. + * */ export class MigrateWorkspaceCommand extends $Command< MigrateWorkspaceCommandInput, diff --git a/clients/client-workspaces/commands/ModifyAccountCommand.ts b/clients/client-workspaces/commands/ModifyAccountCommand.ts index 781b2ffd04c7..d27c57e16b98 100644 --- a/clients/client-workspaces/commands/ModifyAccountCommand.ts +++ b/clients/client-workspaces/commands/ModifyAccountCommand.ts @@ -23,6 +23,20 @@ export interface ModifyAccountCommandOutput extends ModifyAccountResult, __Metad /** *

Modifies the configuration of Bring Your Own License (BYOL) for the specified * account.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { WorkSpacesClient, ModifyAccountCommand } from "@aws-sdk/client-workspaces"; // ES Modules import + * // const { WorkSpacesClient, ModifyAccountCommand } = require("@aws-sdk/client-workspaces"); // CommonJS import + * const client = new WorkSpacesClient(config); + * const command = new ModifyAccountCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ModifyAccountCommandInput} for command's `input` shape. + * @see {@link ModifyAccountCommandOutput} for command's `response` shape. + * @see {@link WorkSpacesClientResolvedConfig | config} for command's `input` shape. + * */ export class ModifyAccountCommand extends $Command< ModifyAccountCommandInput, diff --git a/clients/client-workspaces/commands/ModifyClientPropertiesCommand.ts b/clients/client-workspaces/commands/ModifyClientPropertiesCommand.ts index ff881320a496..9dfe019b9923 100644 --- a/clients/client-workspaces/commands/ModifyClientPropertiesCommand.ts +++ b/clients/client-workspaces/commands/ModifyClientPropertiesCommand.ts @@ -22,6 +22,20 @@ export interface ModifyClientPropertiesCommandOutput extends ModifyClientPropert /** *

Modifies the properties of the specified Amazon WorkSpaces clients.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { WorkSpacesClient, ModifyClientPropertiesCommand } from "@aws-sdk/client-workspaces"; // ES Modules import + * // const { WorkSpacesClient, ModifyClientPropertiesCommand } = require("@aws-sdk/client-workspaces"); // CommonJS import + * const client = new WorkSpacesClient(config); + * const command = new ModifyClientPropertiesCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ModifyClientPropertiesCommandInput} for command's `input` shape. + * @see {@link ModifyClientPropertiesCommandOutput} for command's `response` shape. + * @see {@link WorkSpacesClientResolvedConfig | config} for command's `input` shape. + * */ export class ModifyClientPropertiesCommand extends $Command< ModifyClientPropertiesCommandInput, diff --git a/clients/client-workspaces/commands/ModifySelfservicePermissionsCommand.ts b/clients/client-workspaces/commands/ModifySelfservicePermissionsCommand.ts index 6aa2e21ccd7d..723cf6cdb10a 100644 --- a/clients/client-workspaces/commands/ModifySelfservicePermissionsCommand.ts +++ b/clients/client-workspaces/commands/ModifySelfservicePermissionsCommand.ts @@ -25,6 +25,20 @@ export interface ModifySelfservicePermissionsCommandOutput /** *

Modifies the self-service WorkSpace management capabilities for your users. For more * information, see Enable Self-Service WorkSpace Management Capabilities for Your Users.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { WorkSpacesClient, ModifySelfservicePermissionsCommand } from "@aws-sdk/client-workspaces"; // ES Modules import + * // const { WorkSpacesClient, ModifySelfservicePermissionsCommand } = require("@aws-sdk/client-workspaces"); // CommonJS import + * const client = new WorkSpacesClient(config); + * const command = new ModifySelfservicePermissionsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ModifySelfservicePermissionsCommandInput} for command's `input` shape. + * @see {@link ModifySelfservicePermissionsCommandOutput} for command's `response` shape. + * @see {@link WorkSpacesClientResolvedConfig | config} for command's `input` shape. + * */ export class ModifySelfservicePermissionsCommand extends $Command< ModifySelfservicePermissionsCommandInput, diff --git a/clients/client-workspaces/commands/ModifyWorkspaceAccessPropertiesCommand.ts b/clients/client-workspaces/commands/ModifyWorkspaceAccessPropertiesCommand.ts index 610d4826ffa6..335f139d80bc 100644 --- a/clients/client-workspaces/commands/ModifyWorkspaceAccessPropertiesCommand.ts +++ b/clients/client-workspaces/commands/ModifyWorkspaceAccessPropertiesCommand.ts @@ -26,6 +26,20 @@ export interface ModifyWorkspaceAccessPropertiesCommandOutput *

Specifies which devices and operating systems users can use to access their WorkSpaces. * For more information, see * Control Device Access.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { WorkSpacesClient, ModifyWorkspaceAccessPropertiesCommand } from "@aws-sdk/client-workspaces"; // ES Modules import + * // const { WorkSpacesClient, ModifyWorkspaceAccessPropertiesCommand } = require("@aws-sdk/client-workspaces"); // CommonJS import + * const client = new WorkSpacesClient(config); + * const command = new ModifyWorkspaceAccessPropertiesCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ModifyWorkspaceAccessPropertiesCommandInput} for command's `input` shape. + * @see {@link ModifyWorkspaceAccessPropertiesCommandOutput} for command's `response` shape. + * @see {@link WorkSpacesClientResolvedConfig | config} for command's `input` shape. + * */ export class ModifyWorkspaceAccessPropertiesCommand extends $Command< ModifyWorkspaceAccessPropertiesCommandInput, diff --git a/clients/client-workspaces/commands/ModifyWorkspaceCreationPropertiesCommand.ts b/clients/client-workspaces/commands/ModifyWorkspaceCreationPropertiesCommand.ts index 64b44d6ad9d5..73f60756c48e 100644 --- a/clients/client-workspaces/commands/ModifyWorkspaceCreationPropertiesCommand.ts +++ b/clients/client-workspaces/commands/ModifyWorkspaceCreationPropertiesCommand.ts @@ -24,6 +24,20 @@ export interface ModifyWorkspaceCreationPropertiesCommandOutput /** *

Modify the default properties used to create WorkSpaces.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { WorkSpacesClient, ModifyWorkspaceCreationPropertiesCommand } from "@aws-sdk/client-workspaces"; // ES Modules import + * // const { WorkSpacesClient, ModifyWorkspaceCreationPropertiesCommand } = require("@aws-sdk/client-workspaces"); // CommonJS import + * const client = new WorkSpacesClient(config); + * const command = new ModifyWorkspaceCreationPropertiesCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ModifyWorkspaceCreationPropertiesCommandInput} for command's `input` shape. + * @see {@link ModifyWorkspaceCreationPropertiesCommandOutput} for command's `response` shape. + * @see {@link WorkSpacesClientResolvedConfig | config} for command's `input` shape. + * */ export class ModifyWorkspaceCreationPropertiesCommand extends $Command< ModifyWorkspaceCreationPropertiesCommandInput, diff --git a/clients/client-workspaces/commands/ModifyWorkspacePropertiesCommand.ts b/clients/client-workspaces/commands/ModifyWorkspacePropertiesCommand.ts index 59986a6adde8..78d9017b517d 100644 --- a/clients/client-workspaces/commands/ModifyWorkspacePropertiesCommand.ts +++ b/clients/client-workspaces/commands/ModifyWorkspacePropertiesCommand.ts @@ -26,6 +26,20 @@ export interface ModifyWorkspacePropertiesCommandOutput extends ModifyWorkspaceP * * Modify a WorkSpace. *

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { WorkSpacesClient, ModifyWorkspacePropertiesCommand } from "@aws-sdk/client-workspaces"; // ES Modules import + * // const { WorkSpacesClient, ModifyWorkspacePropertiesCommand } = require("@aws-sdk/client-workspaces"); // CommonJS import + * const client = new WorkSpacesClient(config); + * const command = new ModifyWorkspacePropertiesCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ModifyWorkspacePropertiesCommandInput} for command's `input` shape. + * @see {@link ModifyWorkspacePropertiesCommandOutput} for command's `response` shape. + * @see {@link WorkSpacesClientResolvedConfig | config} for command's `input` shape. + * */ export class ModifyWorkspacePropertiesCommand extends $Command< ModifyWorkspacePropertiesCommandInput, diff --git a/clients/client-workspaces/commands/ModifyWorkspaceStateCommand.ts b/clients/client-workspaces/commands/ModifyWorkspaceStateCommand.ts index f12d2e9c0ed2..cfc14bbdaca3 100644 --- a/clients/client-workspaces/commands/ModifyWorkspaceStateCommand.ts +++ b/clients/client-workspaces/commands/ModifyWorkspaceStateCommand.ts @@ -27,6 +27,20 @@ export interface ModifyWorkspaceStateCommandOutput extends ModifyWorkspaceStateR * 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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { WorkSpacesClient, ModifyWorkspaceStateCommand } from "@aws-sdk/client-workspaces"; // ES Modules import + * // const { WorkSpacesClient, ModifyWorkspaceStateCommand } = require("@aws-sdk/client-workspaces"); // CommonJS import + * const client = new WorkSpacesClient(config); + * const command = new ModifyWorkspaceStateCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ModifyWorkspaceStateCommandInput} for command's `input` shape. + * @see {@link ModifyWorkspaceStateCommandOutput} for command's `response` shape. + * @see {@link WorkSpacesClientResolvedConfig | config} for command's `input` shape. + * */ export class ModifyWorkspaceStateCommand extends $Command< ModifyWorkspaceStateCommandInput, diff --git a/clients/client-workspaces/commands/RebootWorkspacesCommand.ts b/clients/client-workspaces/commands/RebootWorkspacesCommand.ts index 70636f1036cc..0d15ae00ec42 100644 --- a/clients/client-workspaces/commands/RebootWorkspacesCommand.ts +++ b/clients/client-workspaces/commands/RebootWorkspacesCommand.ts @@ -25,6 +25,20 @@ export interface RebootWorkspacesCommandOutput extends RebootWorkspacesResult, _ *

You cannot reboot a WorkSpace unless its state is AVAILABLE or * UNHEALTHY.

*

This operation is asynchronous and returns before the WorkSpaces have rebooted.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { WorkSpacesClient, RebootWorkspacesCommand } from "@aws-sdk/client-workspaces"; // ES Modules import + * // const { WorkSpacesClient, RebootWorkspacesCommand } = require("@aws-sdk/client-workspaces"); // CommonJS import + * const client = new WorkSpacesClient(config); + * const command = new RebootWorkspacesCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link RebootWorkspacesCommandInput} for command's `input` shape. + * @see {@link RebootWorkspacesCommandOutput} for command's `response` shape. + * @see {@link WorkSpacesClientResolvedConfig | config} for command's `input` shape. + * */ export class RebootWorkspacesCommand extends $Command< RebootWorkspacesCommandInput, diff --git a/clients/client-workspaces/commands/RebuildWorkspacesCommand.ts b/clients/client-workspaces/commands/RebuildWorkspacesCommand.ts index 2d9f154fa6a1..467fb497c430 100644 --- a/clients/client-workspaces/commands/RebuildWorkspacesCommand.ts +++ b/clients/client-workspaces/commands/RebuildWorkspacesCommand.ts @@ -29,6 +29,20 @@ export interface RebuildWorkspacesCommandOutput extends RebuildWorkspacesResult, * WorkSpace.

*

This operation is asynchronous and returns before the WorkSpaces have been completely * rebuilt.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { WorkSpacesClient, RebuildWorkspacesCommand } from "@aws-sdk/client-workspaces"; // ES Modules import + * // const { WorkSpacesClient, RebuildWorkspacesCommand } = require("@aws-sdk/client-workspaces"); // CommonJS import + * const client = new WorkSpacesClient(config); + * const command = new RebuildWorkspacesCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link RebuildWorkspacesCommandInput} for command's `input` shape. + * @see {@link RebuildWorkspacesCommandOutput} for command's `response` shape. + * @see {@link WorkSpacesClientResolvedConfig | config} for command's `input` shape. + * */ export class RebuildWorkspacesCommand extends $Command< RebuildWorkspacesCommandInput, diff --git a/clients/client-workspaces/commands/RegisterWorkspaceDirectoryCommand.ts b/clients/client-workspaces/commands/RegisterWorkspaceDirectoryCommand.ts index e497b185facb..13c0387ce96a 100644 --- a/clients/client-workspaces/commands/RegisterWorkspaceDirectoryCommand.ts +++ b/clients/client-workspaces/commands/RegisterWorkspaceDirectoryCommand.ts @@ -26,6 +26,20 @@ export interface RegisterWorkspaceDirectoryCommandOutput extends RegisterWorkspa * 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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { WorkSpacesClient, RegisterWorkspaceDirectoryCommand } from "@aws-sdk/client-workspaces"; // ES Modules import + * // const { WorkSpacesClient, RegisterWorkspaceDirectoryCommand } = require("@aws-sdk/client-workspaces"); // CommonJS import + * const client = new WorkSpacesClient(config); + * const command = new RegisterWorkspaceDirectoryCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link RegisterWorkspaceDirectoryCommandInput} for command's `input` shape. + * @see {@link RegisterWorkspaceDirectoryCommandOutput} for command's `response` shape. + * @see {@link WorkSpacesClientResolvedConfig | config} for command's `input` shape. + * */ export class RegisterWorkspaceDirectoryCommand extends $Command< RegisterWorkspaceDirectoryCommandInput, diff --git a/clients/client-workspaces/commands/RestoreWorkspaceCommand.ts b/clients/client-workspaces/commands/RestoreWorkspaceCommand.ts index f76d403f43d3..60ebc4d9e458 100644 --- a/clients/client-workspaces/commands/RestoreWorkspaceCommand.ts +++ b/clients/client-workspaces/commands/RestoreWorkspaceCommand.ts @@ -29,6 +29,20 @@ export interface RestoreWorkspaceCommandOutput extends RestoreWorkspaceResult, _ * WorkSpace.

*

This operation is asynchronous and returns before the WorkSpace is completely * restored.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { WorkSpacesClient, RestoreWorkspaceCommand } from "@aws-sdk/client-workspaces"; // ES Modules import + * // const { WorkSpacesClient, RestoreWorkspaceCommand } = require("@aws-sdk/client-workspaces"); // CommonJS import + * const client = new WorkSpacesClient(config); + * const command = new RestoreWorkspaceCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link RestoreWorkspaceCommandInput} for command's `input` shape. + * @see {@link RestoreWorkspaceCommandOutput} for command's `response` shape. + * @see {@link WorkSpacesClientResolvedConfig | config} for command's `input` shape. + * */ export class RestoreWorkspaceCommand extends $Command< RestoreWorkspaceCommandInput, diff --git a/clients/client-workspaces/commands/RevokeIpRulesCommand.ts b/clients/client-workspaces/commands/RevokeIpRulesCommand.ts index 929594775eab..9f51f327c36f 100644 --- a/clients/client-workspaces/commands/RevokeIpRulesCommand.ts +++ b/clients/client-workspaces/commands/RevokeIpRulesCommand.ts @@ -22,6 +22,20 @@ export interface RevokeIpRulesCommandOutput extends RevokeIpRulesResult, __Metad /** *

Removes one or more rules from the specified IP access control group.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { WorkSpacesClient, RevokeIpRulesCommand } from "@aws-sdk/client-workspaces"; // ES Modules import + * // const { WorkSpacesClient, RevokeIpRulesCommand } = require("@aws-sdk/client-workspaces"); // CommonJS import + * const client = new WorkSpacesClient(config); + * const command = new RevokeIpRulesCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link RevokeIpRulesCommandInput} for command's `input` shape. + * @see {@link RevokeIpRulesCommandOutput} for command's `response` shape. + * @see {@link WorkSpacesClientResolvedConfig | config} for command's `input` shape. + * */ export class RevokeIpRulesCommand extends $Command< RevokeIpRulesCommandInput, diff --git a/clients/client-workspaces/commands/StartWorkspacesCommand.ts b/clients/client-workspaces/commands/StartWorkspacesCommand.ts index d83d10271bdf..251e7d1d6788 100644 --- a/clients/client-workspaces/commands/StartWorkspacesCommand.ts +++ b/clients/client-workspaces/commands/StartWorkspacesCommand.ts @@ -24,6 +24,20 @@ export interface StartWorkspacesCommandOutput extends StartWorkspacesResult, __M *

Starts the specified WorkSpaces.

*

You cannot start a WorkSpace unless it has a running mode of AutoStop and a * state of STOPPED.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { WorkSpacesClient, StartWorkspacesCommand } from "@aws-sdk/client-workspaces"; // ES Modules import + * // const { WorkSpacesClient, StartWorkspacesCommand } = require("@aws-sdk/client-workspaces"); // CommonJS import + * const client = new WorkSpacesClient(config); + * const command = new StartWorkspacesCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link StartWorkspacesCommandInput} for command's `input` shape. + * @see {@link StartWorkspacesCommandOutput} for command's `response` shape. + * @see {@link WorkSpacesClientResolvedConfig | config} for command's `input` shape. + * */ export class StartWorkspacesCommand extends $Command< StartWorkspacesCommandInput, diff --git a/clients/client-workspaces/commands/StopWorkspacesCommand.ts b/clients/client-workspaces/commands/StopWorkspacesCommand.ts index a0bb9986fce1..25f78fb49d9e 100644 --- a/clients/client-workspaces/commands/StopWorkspacesCommand.ts +++ b/clients/client-workspaces/commands/StopWorkspacesCommand.ts @@ -25,6 +25,20 @@ export interface StopWorkspacesCommandOutput extends StopWorkspacesResult, __Met *

You cannot stop a WorkSpace unless it has a running mode of AutoStop and a * state of AVAILABLE, IMPAIRED, UNHEALTHY, or * ERROR.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { WorkSpacesClient, StopWorkspacesCommand } from "@aws-sdk/client-workspaces"; // ES Modules import + * // const { WorkSpacesClient, StopWorkspacesCommand } = require("@aws-sdk/client-workspaces"); // CommonJS import + * const client = new WorkSpacesClient(config); + * const command = new StopWorkspacesCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link StopWorkspacesCommandInput} for command's `input` shape. + * @see {@link StopWorkspacesCommandOutput} for command's `response` shape. + * @see {@link WorkSpacesClientResolvedConfig | config} for command's `input` shape. + * */ export class StopWorkspacesCommand extends $Command< StopWorkspacesCommandInput, diff --git a/clients/client-workspaces/commands/TerminateWorkspacesCommand.ts b/clients/client-workspaces/commands/TerminateWorkspacesCommand.ts index 532d264a1f8c..9daf4b771d1a 100644 --- a/clients/client-workspaces/commands/TerminateWorkspacesCommand.ts +++ b/clients/client-workspaces/commands/TerminateWorkspacesCommand.ts @@ -51,6 +51,20 @@ export interface TerminateWorkspacesCommandOutput extends TerminateWorkspacesRes * Simple AD or AD Connector directory, you can always create a new one when you want to start using * WorkSpaces again.

* + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { WorkSpacesClient, TerminateWorkspacesCommand } from "@aws-sdk/client-workspaces"; // ES Modules import + * // const { WorkSpacesClient, TerminateWorkspacesCommand } = require("@aws-sdk/client-workspaces"); // CommonJS import + * const client = new WorkSpacesClient(config); + * const command = new TerminateWorkspacesCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link TerminateWorkspacesCommandInput} for command's `input` shape. + * @see {@link TerminateWorkspacesCommandOutput} for command's `response` shape. + * @see {@link WorkSpacesClientResolvedConfig | config} for command's `input` shape. + * */ export class TerminateWorkspacesCommand extends $Command< TerminateWorkspacesCommandInput, diff --git a/clients/client-workspaces/commands/UpdateConnectionAliasPermissionCommand.ts b/clients/client-workspaces/commands/UpdateConnectionAliasPermissionCommand.ts index 1f3cc7393546..c2d3f435385d 100644 --- a/clients/client-workspaces/commands/UpdateConnectionAliasPermissionCommand.ts +++ b/clients/client-workspaces/commands/UpdateConnectionAliasPermissionCommand.ts @@ -43,6 +43,20 @@ export interface UpdateConnectionAliasPermissionCommandOutput * * * + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { WorkSpacesClient, UpdateConnectionAliasPermissionCommand } from "@aws-sdk/client-workspaces"; // ES Modules import + * // const { WorkSpacesClient, UpdateConnectionAliasPermissionCommand } = require("@aws-sdk/client-workspaces"); // CommonJS import + * const client = new WorkSpacesClient(config); + * const command = new UpdateConnectionAliasPermissionCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link UpdateConnectionAliasPermissionCommandInput} for command's `input` shape. + * @see {@link UpdateConnectionAliasPermissionCommandOutput} for command's `response` shape. + * @see {@link WorkSpacesClientResolvedConfig | config} for command's `input` shape. + * */ export class UpdateConnectionAliasPermissionCommand extends $Command< UpdateConnectionAliasPermissionCommandInput, diff --git a/clients/client-workspaces/commands/UpdateRulesOfIpGroupCommand.ts b/clients/client-workspaces/commands/UpdateRulesOfIpGroupCommand.ts index 619338908bee..be478dec3c45 100644 --- a/clients/client-workspaces/commands/UpdateRulesOfIpGroupCommand.ts +++ b/clients/client-workspaces/commands/UpdateRulesOfIpGroupCommand.ts @@ -23,6 +23,20 @@ export interface UpdateRulesOfIpGroupCommandOutput extends UpdateRulesOfIpGroupR /** *

Replaces the current rules of the specified IP access control group with the specified * rules.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { WorkSpacesClient, UpdateRulesOfIpGroupCommand } from "@aws-sdk/client-workspaces"; // ES Modules import + * // const { WorkSpacesClient, UpdateRulesOfIpGroupCommand } = require("@aws-sdk/client-workspaces"); // CommonJS import + * const client = new WorkSpacesClient(config); + * const command = new UpdateRulesOfIpGroupCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link UpdateRulesOfIpGroupCommandInput} for command's `input` shape. + * @see {@link UpdateRulesOfIpGroupCommandOutput} for command's `response` shape. + * @see {@link WorkSpacesClientResolvedConfig | config} for command's `input` shape. + * */ export class UpdateRulesOfIpGroupCommand extends $Command< UpdateRulesOfIpGroupCommandInput, diff --git a/clients/client-workspaces/commands/UpdateWorkspaceBundleCommand.ts b/clients/client-workspaces/commands/UpdateWorkspaceBundleCommand.ts index b48cee5c13ef..bd79fcdc9ade 100644 --- a/clients/client-workspaces/commands/UpdateWorkspaceBundleCommand.ts +++ b/clients/client-workspaces/commands/UpdateWorkspaceBundleCommand.ts @@ -30,6 +30,20 @@ export interface UpdateWorkspaceBundleCommandOutput extends UpdateWorkspaceBundl * 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.

* + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { WorkSpacesClient, UpdateWorkspaceBundleCommand } from "@aws-sdk/client-workspaces"; // ES Modules import + * // const { WorkSpacesClient, UpdateWorkspaceBundleCommand } = require("@aws-sdk/client-workspaces"); // CommonJS import + * const client = new WorkSpacesClient(config); + * const command = new UpdateWorkspaceBundleCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link UpdateWorkspaceBundleCommandInput} for command's `input` shape. + * @see {@link UpdateWorkspaceBundleCommandOutput} for command's `response` shape. + * @see {@link WorkSpacesClientResolvedConfig | config} for command's `input` shape. + * */ export class UpdateWorkspaceBundleCommand extends $Command< UpdateWorkspaceBundleCommandInput, diff --git a/clients/client-workspaces/commands/UpdateWorkspaceImagePermissionCommand.ts b/clients/client-workspaces/commands/UpdateWorkspaceImagePermissionCommand.ts index 992f99a2be98..5a2c5e468401 100644 --- a/clients/client-workspaces/commands/UpdateWorkspaceImagePermissionCommand.ts +++ b/clients/client-workspaces/commands/UpdateWorkspaceImagePermissionCommand.ts @@ -52,6 +52,20 @@ export interface UpdateWorkspaceImagePermissionCommandOutput * * * + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { WorkSpacesClient, UpdateWorkspaceImagePermissionCommand } from "@aws-sdk/client-workspaces"; // ES Modules import + * // const { WorkSpacesClient, UpdateWorkspaceImagePermissionCommand } = require("@aws-sdk/client-workspaces"); // CommonJS import + * const client = new WorkSpacesClient(config); + * const command = new UpdateWorkspaceImagePermissionCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link UpdateWorkspaceImagePermissionCommandInput} for command's `input` shape. + * @see {@link UpdateWorkspaceImagePermissionCommandOutput} for command's `response` shape. + * @see {@link WorkSpacesClientResolvedConfig | config} for command's `input` shape. + * */ export class UpdateWorkspaceImagePermissionCommand extends $Command< UpdateWorkspaceImagePermissionCommandInput, diff --git a/clients/client-workspaces/models/models_0.ts b/clients/client-workspaces/models/models_0.ts index ec569475c8b6..170878106778 100644 --- a/clients/client-workspaces/models/models_0.ts +++ b/clients/client-workspaces/models/models_0.ts @@ -11,6 +11,9 @@ export interface AccessDeniedException extends __SmithyException, $MetadataBeare } export namespace AccessDeniedException { + /** + * @internal + */ export const filterSensitiveLog = (obj: AccessDeniedException): any => ({ ...obj, }); @@ -71,6 +74,9 @@ export interface AccountModification { } export namespace AccountModification { + /** + * @internal + */ export const filterSensitiveLog = (obj: AccountModification): any => ({ ...obj, }); @@ -94,6 +100,9 @@ export interface AssociateConnectionAliasRequest { } export namespace AssociateConnectionAliasRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: AssociateConnectionAliasRequest): any => ({ ...obj, }); @@ -108,6 +117,9 @@ export interface AssociateConnectionAliasResult { } export namespace AssociateConnectionAliasResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: AssociateConnectionAliasResult): any => ({ ...obj, }); @@ -126,6 +138,9 @@ export interface InvalidParameterValuesException extends __SmithyException, $Met } export namespace InvalidParameterValuesException { + /** + * @internal + */ export const filterSensitiveLog = (obj: InvalidParameterValuesException): any => ({ ...obj, }); @@ -141,6 +156,9 @@ export interface InvalidResourceStateException extends __SmithyException, $Metad } export namespace InvalidResourceStateException { + /** + * @internal + */ export const filterSensitiveLog = (obj: InvalidResourceStateException): any => ({ ...obj, }); @@ -156,6 +174,9 @@ export interface OperationNotSupportedException extends __SmithyException, $Meta } export namespace OperationNotSupportedException { + /** + * @internal + */ export const filterSensitiveLog = (obj: OperationNotSupportedException): any => ({ ...obj, }); @@ -171,6 +192,9 @@ export interface ResourceAssociatedException extends __SmithyException, $Metadat } export namespace ResourceAssociatedException { + /** + * @internal + */ export const filterSensitiveLog = (obj: ResourceAssociatedException): any => ({ ...obj, }); @@ -194,6 +218,9 @@ export interface ResourceNotFoundException extends __SmithyException, $MetadataB } export namespace ResourceNotFoundException { + /** + * @internal + */ export const filterSensitiveLog = (obj: ResourceNotFoundException): any => ({ ...obj, }); @@ -212,6 +239,9 @@ export interface AssociateIpGroupsRequest { } export namespace AssociateIpGroupsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: AssociateIpGroupsRequest): any => ({ ...obj, }); @@ -220,6 +250,9 @@ export namespace AssociateIpGroupsRequest { export interface AssociateIpGroupsResult {} export namespace AssociateIpGroupsResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: AssociateIpGroupsResult): any => ({ ...obj, }); @@ -238,6 +271,9 @@ export interface ResourceLimitExceededException extends __SmithyException, $Meta } export namespace ResourceLimitExceededException { + /** + * @internal + */ export const filterSensitiveLog = (obj: ResourceLimitExceededException): any => ({ ...obj, }); @@ -267,6 +303,9 @@ export interface IpRuleItem { } export namespace IpRuleItem { + /** + * @internal + */ export const filterSensitiveLog = (obj: IpRuleItem): any => ({ ...obj, }); @@ -285,6 +324,9 @@ export interface AuthorizeIpRulesRequest { } export namespace AuthorizeIpRulesRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: AuthorizeIpRulesRequest): any => ({ ...obj, }); @@ -293,6 +335,9 @@ export namespace AuthorizeIpRulesRequest { export interface AuthorizeIpRulesResult {} export namespace AuthorizeIpRulesResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: AuthorizeIpRulesResult): any => ({ ...obj, }); @@ -319,6 +364,9 @@ export interface ComputeType { } export namespace ComputeType { + /** + * @internal + */ export const filterSensitiveLog = (obj: ComputeType): any => ({ ...obj, }); @@ -335,6 +383,9 @@ export interface RootStorage { } export namespace RootStorage { + /** + * @internal + */ export const filterSensitiveLog = (obj: RootStorage): any => ({ ...obj, }); @@ -351,6 +402,9 @@ export interface UserStorage { } export namespace UserStorage { + /** + * @internal + */ export const filterSensitiveLog = (obj: UserStorage): any => ({ ...obj, }); @@ -414,6 +468,9 @@ export interface WorkspaceBundle { } export namespace WorkspaceBundle { + /** + * @internal + */ export const filterSensitiveLog = (obj: WorkspaceBundle): any => ({ ...obj, }); @@ -437,6 +494,9 @@ export interface ClientProperties { } export namespace ClientProperties { + /** + * @internal + */ export const filterSensitiveLog = (obj: ClientProperties): any => ({ ...obj, }); @@ -458,6 +518,9 @@ export interface ClientPropertiesResult { } export namespace ClientPropertiesResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: ClientPropertiesResult): any => ({ ...obj, }); @@ -492,6 +555,9 @@ export interface ConnectionAliasAssociation { } export namespace ConnectionAliasAssociation { + /** + * @internal + */ export const filterSensitiveLog = (obj: ConnectionAliasAssociation): any => ({ ...obj, }); @@ -537,6 +603,9 @@ export interface ConnectionAlias { } export namespace ConnectionAlias { + /** + * @internal + */ export const filterSensitiveLog = (obj: ConnectionAlias): any => ({ ...obj, }); @@ -560,6 +629,9 @@ export interface ConnectionAliasPermission { } export namespace ConnectionAliasPermission { + /** + * @internal + */ export const filterSensitiveLog = (obj: ConnectionAliasPermission): any => ({ ...obj, }); @@ -587,6 +659,9 @@ export interface Tag { } export namespace Tag { + /** + * @internal + */ export const filterSensitiveLog = (obj: Tag): any => ({ ...obj, }); @@ -620,6 +695,9 @@ export interface CopyWorkspaceImageRequest { } export namespace CopyWorkspaceImageRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: CopyWorkspaceImageRequest): any => ({ ...obj, }); @@ -633,6 +711,9 @@ export interface CopyWorkspaceImageResult { } export namespace CopyWorkspaceImageResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: CopyWorkspaceImageResult): any => ({ ...obj, }); @@ -648,6 +729,9 @@ export interface ResourceAlreadyExistsException extends __SmithyException, $Meta } export namespace ResourceAlreadyExistsException { + /** + * @internal + */ export const filterSensitiveLog = (obj: ResourceAlreadyExistsException): any => ({ ...obj, }); @@ -671,6 +755,9 @@ export interface ResourceUnavailableException extends __SmithyException, $Metada } export namespace ResourceUnavailableException { + /** + * @internal + */ export const filterSensitiveLog = (obj: ResourceUnavailableException): any => ({ ...obj, }); @@ -695,6 +782,9 @@ export interface CreateConnectionAliasRequest { } export namespace CreateConnectionAliasRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateConnectionAliasRequest): any => ({ ...obj, }); @@ -708,6 +798,9 @@ export interface CreateConnectionAliasResult { } export namespace CreateConnectionAliasResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateConnectionAliasResult): any => ({ ...obj, }); @@ -736,6 +829,9 @@ export interface CreateIpGroupRequest { } export namespace CreateIpGroupRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateIpGroupRequest): any => ({ ...obj, }); @@ -749,6 +845,9 @@ export interface CreateIpGroupResult { } export namespace CreateIpGroupResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateIpGroupResult): any => ({ ...obj, }); @@ -764,6 +863,9 @@ export interface ResourceCreationFailedException extends __SmithyException, $Met } export namespace ResourceCreationFailedException { + /** + * @internal + */ export const filterSensitiveLog = (obj: ResourceCreationFailedException): any => ({ ...obj, }); @@ -783,6 +885,9 @@ export interface CreateTagsRequest { } export namespace CreateTagsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateTagsRequest): any => ({ ...obj, }); @@ -791,6 +896,9 @@ export namespace CreateTagsRequest { export interface CreateTagsResult {} export namespace CreateTagsResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateTagsResult): any => ({ ...obj, }); @@ -839,6 +947,9 @@ export interface CreateWorkspaceBundleRequest { } export namespace CreateWorkspaceBundleRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateWorkspaceBundleRequest): any => ({ ...obj, }); @@ -852,6 +963,9 @@ export interface CreateWorkspaceBundleResult { } export namespace CreateWorkspaceBundleResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateWorkspaceBundleResult): any => ({ ...obj, }); @@ -897,6 +1011,9 @@ export interface WorkspaceProperties { } export namespace WorkspaceProperties { + /** + * @internal + */ export const filterSensitiveLog = (obj: WorkspaceProperties): any => ({ ...obj, }); @@ -951,6 +1068,9 @@ export interface WorkspaceRequest { } export namespace WorkspaceRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: WorkspaceRequest): any => ({ ...obj, }); @@ -964,6 +1084,9 @@ export interface CreateWorkspacesRequest { } export namespace CreateWorkspacesRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateWorkspacesRequest): any => ({ ...obj, }); @@ -991,6 +1114,9 @@ export interface FailedCreateWorkspaceRequest { } export namespace FailedCreateWorkspaceRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: FailedCreateWorkspaceRequest): any => ({ ...obj, }); @@ -1023,6 +1149,9 @@ export interface ModificationState { } export namespace ModificationState { + /** + * @internal + */ export const filterSensitiveLog = (obj: ModificationState): any => ({ ...obj, }); @@ -1142,6 +1271,9 @@ export interface Workspace { } export namespace Workspace { + /** + * @internal + */ export const filterSensitiveLog = (obj: Workspace): any => ({ ...obj, }); @@ -1163,6 +1295,9 @@ export interface CreateWorkspacesResult { } export namespace CreateWorkspacesResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateWorkspacesResult): any => ({ ...obj, }); @@ -1220,6 +1355,9 @@ export interface DefaultWorkspaceCreationProperties { } export namespace DefaultWorkspaceCreationProperties { + /** + * @internal + */ export const filterSensitiveLog = (obj: DefaultWorkspaceCreationProperties): any => ({ ...obj, }); @@ -1233,6 +1371,9 @@ export interface DeleteConnectionAliasRequest { } export namespace DeleteConnectionAliasRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteConnectionAliasRequest): any => ({ ...obj, }); @@ -1241,6 +1382,9 @@ export namespace DeleteConnectionAliasRequest { export interface DeleteConnectionAliasResult {} export namespace DeleteConnectionAliasResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteConnectionAliasResult): any => ({ ...obj, }); @@ -1254,6 +1398,9 @@ export interface DeleteIpGroupRequest { } export namespace DeleteIpGroupRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteIpGroupRequest): any => ({ ...obj, }); @@ -1262,6 +1409,9 @@ export namespace DeleteIpGroupRequest { export interface DeleteIpGroupResult {} export namespace DeleteIpGroupResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteIpGroupResult): any => ({ ...obj, }); @@ -1281,6 +1431,9 @@ export interface DeleteTagsRequest { } export namespace DeleteTagsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteTagsRequest): any => ({ ...obj, }); @@ -1289,6 +1442,9 @@ export namespace DeleteTagsRequest { export interface DeleteTagsResult {} export namespace DeleteTagsResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteTagsResult): any => ({ ...obj, }); @@ -1302,6 +1458,9 @@ export interface DeleteWorkspaceBundleRequest { } export namespace DeleteWorkspaceBundleRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteWorkspaceBundleRequest): any => ({ ...obj, }); @@ -1310,6 +1469,9 @@ export namespace DeleteWorkspaceBundleRequest { export interface DeleteWorkspaceBundleResult {} export namespace DeleteWorkspaceBundleResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteWorkspaceBundleResult): any => ({ ...obj, }); @@ -1323,6 +1485,9 @@ export interface DeleteWorkspaceImageRequest { } export namespace DeleteWorkspaceImageRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteWorkspaceImageRequest): any => ({ ...obj, }); @@ -1331,6 +1496,9 @@ export namespace DeleteWorkspaceImageRequest { export interface DeleteWorkspaceImageResult {} export namespace DeleteWorkspaceImageResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteWorkspaceImageResult): any => ({ ...obj, }); @@ -1346,6 +1514,9 @@ export interface DeregisterWorkspaceDirectoryRequest { } export namespace DeregisterWorkspaceDirectoryRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeregisterWorkspaceDirectoryRequest): any => ({ ...obj, }); @@ -1354,6 +1525,9 @@ export namespace DeregisterWorkspaceDirectoryRequest { export interface DeregisterWorkspaceDirectoryResult {} export namespace DeregisterWorkspaceDirectoryResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeregisterWorkspaceDirectoryResult): any => ({ ...obj, }); @@ -1362,6 +1536,9 @@ export namespace DeregisterWorkspaceDirectoryResult { export interface DescribeAccountRequest {} export namespace DescribeAccountRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeAccountRequest): any => ({ ...obj, }); @@ -1384,6 +1561,9 @@ export interface DescribeAccountResult { } export namespace DescribeAccountResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeAccountResult): any => ({ ...obj, }); @@ -1398,6 +1578,9 @@ export interface DescribeAccountModificationsRequest { } export namespace DescribeAccountModificationsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeAccountModificationsRequest): any => ({ ...obj, }); @@ -1417,6 +1600,9 @@ export interface DescribeAccountModificationsResult { } export namespace DescribeAccountModificationsResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeAccountModificationsResult): any => ({ ...obj, }); @@ -1430,6 +1616,9 @@ export interface DescribeClientPropertiesRequest { } export namespace DescribeClientPropertiesRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeClientPropertiesRequest): any => ({ ...obj, }); @@ -1443,6 +1632,9 @@ export interface DescribeClientPropertiesResult { } export namespace DescribeClientPropertiesResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeClientPropertiesResult): any => ({ ...obj, }); @@ -1472,6 +1664,9 @@ export interface DescribeConnectionAliasesRequest { } export namespace DescribeConnectionAliasesRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeConnectionAliasesRequest): any => ({ ...obj, }); @@ -1490,6 +1685,9 @@ export interface DescribeConnectionAliasesResult { } export namespace DescribeConnectionAliasesResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeConnectionAliasesResult): any => ({ ...obj, }); @@ -1514,6 +1712,9 @@ export interface DescribeConnectionAliasPermissionsRequest { } export namespace DescribeConnectionAliasPermissionsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeConnectionAliasPermissionsRequest): any => ({ ...obj, }); @@ -1537,6 +1738,9 @@ export interface DescribeConnectionAliasPermissionsResult { } export namespace DescribeConnectionAliasPermissionsResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeConnectionAliasPermissionsResult): any => ({ ...obj, }); @@ -1561,6 +1765,9 @@ export interface DescribeIpGroupsRequest { } export namespace DescribeIpGroupsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeIpGroupsRequest): any => ({ ...obj, }); @@ -1592,6 +1799,9 @@ export interface WorkspacesIpGroup { } export namespace WorkspacesIpGroup { + /** + * @internal + */ export const filterSensitiveLog = (obj: WorkspacesIpGroup): any => ({ ...obj, }); @@ -1610,6 +1820,9 @@ export interface DescribeIpGroupsResult { } export namespace DescribeIpGroupsResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeIpGroupsResult): any => ({ ...obj, }); @@ -1624,6 +1837,9 @@ export interface DescribeTagsRequest { } export namespace DescribeTagsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeTagsRequest): any => ({ ...obj, }); @@ -1637,6 +1853,9 @@ export interface DescribeTagsResult { } export namespace DescribeTagsResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeTagsResult): any => ({ ...obj, }); @@ -1662,6 +1881,9 @@ export interface DescribeWorkspaceBundlesRequest { } export namespace DescribeWorkspaceBundlesRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeWorkspaceBundlesRequest): any => ({ ...obj, }); @@ -1682,6 +1904,9 @@ export interface DescribeWorkspaceBundlesResult { } export namespace DescribeWorkspaceBundlesResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeWorkspaceBundlesResult): any => ({ ...obj, }); @@ -1707,6 +1932,9 @@ export interface DescribeWorkspaceDirectoriesRequest { } export namespace DescribeWorkspaceDirectoriesRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeWorkspaceDirectoriesRequest): any => ({ ...obj, }); @@ -1750,6 +1978,9 @@ export interface SelfservicePermissions { } export namespace SelfservicePermissions { + /** + * @internal + */ export const filterSensitiveLog = (obj: SelfservicePermissions): any => ({ ...obj, }); @@ -1817,6 +2048,9 @@ export interface WorkspaceAccessProperties { } export namespace WorkspaceAccessProperties { + /** + * @internal + */ export const filterSensitiveLog = (obj: WorkspaceAccessProperties): any => ({ ...obj, }); @@ -1918,6 +2152,9 @@ export interface WorkspaceDirectory { } export namespace WorkspaceDirectory { + /** + * @internal + */ export const filterSensitiveLog = (obj: WorkspaceDirectory): any => ({ ...obj, }); @@ -1936,6 +2173,9 @@ export interface DescribeWorkspaceDirectoriesResult { } export namespace DescribeWorkspaceDirectoriesResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeWorkspaceDirectoriesResult): any => ({ ...obj, }); @@ -1960,6 +2200,9 @@ export interface DescribeWorkspaceImagePermissionsRequest { } export namespace DescribeWorkspaceImagePermissionsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeWorkspaceImagePermissionsRequest): any => ({ ...obj, }); @@ -1979,6 +2222,9 @@ export interface ImagePermission { } export namespace ImagePermission { + /** + * @internal + */ export const filterSensitiveLog = (obj: ImagePermission): any => ({ ...obj, }); @@ -2002,6 +2248,9 @@ export interface DescribeWorkspaceImagePermissionsResult { } export namespace DescribeWorkspaceImagePermissionsResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeWorkspaceImagePermissionsResult): any => ({ ...obj, }); @@ -2036,6 +2285,9 @@ export interface DescribeWorkspaceImagesRequest { } export namespace DescribeWorkspaceImagesRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeWorkspaceImagesRequest): any => ({ ...obj, }); @@ -2057,6 +2309,9 @@ export interface OperatingSystem { } export namespace OperatingSystem { + /** + * @internal + */ export const filterSensitiveLog = (obj: OperatingSystem): any => ({ ...obj, }); @@ -2133,6 +2388,9 @@ export interface WorkspaceImage { } export namespace WorkspaceImage { + /** + * @internal + */ export const filterSensitiveLog = (obj: WorkspaceImage): any => ({ ...obj, }); @@ -2151,6 +2409,9 @@ export interface DescribeWorkspaceImagesResult { } export namespace DescribeWorkspaceImagesResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeWorkspaceImagesResult): any => ({ ...obj, }); @@ -2197,6 +2458,9 @@ export interface DescribeWorkspacesRequest { } export namespace DescribeWorkspacesRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeWorkspacesRequest): any => ({ ...obj, }); @@ -2217,6 +2481,9 @@ export interface DescribeWorkspacesResult { } export namespace DescribeWorkspacesResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeWorkspacesResult): any => ({ ...obj, }); @@ -2236,6 +2503,9 @@ export interface DescribeWorkspacesConnectionStatusRequest { } export namespace DescribeWorkspacesConnectionStatusRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeWorkspacesConnectionStatusRequest): any => ({ ...obj, }); @@ -2268,6 +2538,9 @@ export interface WorkspaceConnectionStatus { } export namespace WorkspaceConnectionStatus { + /** + * @internal + */ export const filterSensitiveLog = (obj: WorkspaceConnectionStatus): any => ({ ...obj, }); @@ -2286,6 +2559,9 @@ export interface DescribeWorkspacesConnectionStatusResult { } export namespace DescribeWorkspacesConnectionStatusResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeWorkspacesConnectionStatusResult): any => ({ ...obj, }); @@ -2299,6 +2575,9 @@ export interface DescribeWorkspaceSnapshotsRequest { } export namespace DescribeWorkspaceSnapshotsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeWorkspaceSnapshotsRequest): any => ({ ...obj, }); @@ -2315,6 +2594,9 @@ export interface Snapshot { } export namespace Snapshot { + /** + * @internal + */ export const filterSensitiveLog = (obj: Snapshot): any => ({ ...obj, }); @@ -2335,6 +2617,9 @@ export interface DescribeWorkspaceSnapshotsResult { } export namespace DescribeWorkspaceSnapshotsResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: DescribeWorkspaceSnapshotsResult): any => ({ ...obj, }); @@ -2348,6 +2633,9 @@ export interface DisassociateConnectionAliasRequest { } export namespace DisassociateConnectionAliasRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DisassociateConnectionAliasRequest): any => ({ ...obj, }); @@ -2356,6 +2644,9 @@ export namespace DisassociateConnectionAliasRequest { export interface DisassociateConnectionAliasResult {} export namespace DisassociateConnectionAliasResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: DisassociateConnectionAliasResult): any => ({ ...obj, }); @@ -2374,6 +2665,9 @@ export interface DisassociateIpGroupsRequest { } export namespace DisassociateIpGroupsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DisassociateIpGroupsRequest): any => ({ ...obj, }); @@ -2382,6 +2676,9 @@ export namespace DisassociateIpGroupsRequest { export interface DisassociateIpGroupsResult {} export namespace DisassociateIpGroupsResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: DisassociateIpGroupsResult): any => ({ ...obj, }); @@ -2411,6 +2708,9 @@ export interface FailedWorkspaceChangeRequest { } export namespace FailedWorkspaceChangeRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: FailedWorkspaceChangeRequest): any => ({ ...obj, }); @@ -2469,6 +2769,9 @@ export interface ImportWorkspaceImageRequest { } export namespace ImportWorkspaceImageRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ImportWorkspaceImageRequest): any => ({ ...obj, }); @@ -2482,6 +2785,9 @@ export interface ImportWorkspaceImageResult { } export namespace ImportWorkspaceImageResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: ImportWorkspaceImageResult): any => ({ ...obj, }); @@ -2507,6 +2813,9 @@ export interface ListAvailableManagementCidrRangesRequest { } export namespace ListAvailableManagementCidrRangesRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListAvailableManagementCidrRangesRequest): any => ({ ...obj, }); @@ -2525,6 +2834,9 @@ export interface ListAvailableManagementCidrRangesResult { } export namespace ListAvailableManagementCidrRangesResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListAvailableManagementCidrRangesResult): any => ({ ...obj, }); @@ -2543,6 +2855,9 @@ export interface MigrateWorkspaceRequest { } export namespace MigrateWorkspaceRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: MigrateWorkspaceRequest): any => ({ ...obj, }); @@ -2562,6 +2877,9 @@ export interface MigrateWorkspaceResult { } export namespace MigrateWorkspaceResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: MigrateWorkspaceResult): any => ({ ...obj, }); @@ -2577,6 +2895,9 @@ export interface OperationInProgressException extends __SmithyException, $Metada } export namespace OperationInProgressException { + /** + * @internal + */ export const filterSensitiveLog = (obj: OperationInProgressException): any => ({ ...obj, }); @@ -2599,6 +2920,9 @@ export interface ModifyAccountRequest { } export namespace ModifyAccountRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ModifyAccountRequest): any => ({ ...obj, }); @@ -2607,6 +2931,9 @@ export namespace ModifyAccountRequest { export interface ModifyAccountResult {} export namespace ModifyAccountResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: ModifyAccountResult): any => ({ ...obj, }); @@ -2625,6 +2952,9 @@ export interface ModifyClientPropertiesRequest { } export namespace ModifyClientPropertiesRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ModifyClientPropertiesRequest): any => ({ ...obj, }); @@ -2633,6 +2963,9 @@ export namespace ModifyClientPropertiesRequest { export interface ModifyClientPropertiesResult {} export namespace ModifyClientPropertiesResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: ModifyClientPropertiesResult): any => ({ ...obj, }); @@ -2651,6 +2984,9 @@ export interface ModifySelfservicePermissionsRequest { } export namespace ModifySelfservicePermissionsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ModifySelfservicePermissionsRequest): any => ({ ...obj, }); @@ -2659,6 +2995,9 @@ export namespace ModifySelfservicePermissionsRequest { export interface ModifySelfservicePermissionsResult {} export namespace ModifySelfservicePermissionsResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: ModifySelfservicePermissionsResult): any => ({ ...obj, }); @@ -2677,6 +3016,9 @@ export interface ModifyWorkspaceAccessPropertiesRequest { } export namespace ModifyWorkspaceAccessPropertiesRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ModifyWorkspaceAccessPropertiesRequest): any => ({ ...obj, }); @@ -2685,6 +3027,9 @@ export namespace ModifyWorkspaceAccessPropertiesRequest { export interface ModifyWorkspaceAccessPropertiesResult {} export namespace ModifyWorkspaceAccessPropertiesResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: ModifyWorkspaceAccessPropertiesResult): any => ({ ...obj, }); @@ -2760,6 +3105,9 @@ export interface WorkspaceCreationProperties { } export namespace WorkspaceCreationProperties { + /** + * @internal + */ export const filterSensitiveLog = (obj: WorkspaceCreationProperties): any => ({ ...obj, }); @@ -2778,6 +3126,9 @@ export interface ModifyWorkspaceCreationPropertiesRequest { } export namespace ModifyWorkspaceCreationPropertiesRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ModifyWorkspaceCreationPropertiesRequest): any => ({ ...obj, }); @@ -2786,6 +3137,9 @@ export namespace ModifyWorkspaceCreationPropertiesRequest { export interface ModifyWorkspaceCreationPropertiesResult {} export namespace ModifyWorkspaceCreationPropertiesResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: ModifyWorkspaceCreationPropertiesResult): any => ({ ...obj, }); @@ -2804,6 +3158,9 @@ export interface ModifyWorkspacePropertiesRequest { } export namespace ModifyWorkspacePropertiesRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ModifyWorkspacePropertiesRequest): any => ({ ...obj, }); @@ -2812,6 +3169,9 @@ export namespace ModifyWorkspacePropertiesRequest { export interface ModifyWorkspacePropertiesResult {} export namespace ModifyWorkspacePropertiesResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: ModifyWorkspacePropertiesResult): any => ({ ...obj, }); @@ -2829,6 +3189,9 @@ export interface UnsupportedWorkspaceConfigurationException extends __SmithyExce } export namespace UnsupportedWorkspaceConfigurationException { + /** + * @internal + */ export const filterSensitiveLog = (obj: UnsupportedWorkspaceConfigurationException): any => ({ ...obj, }); @@ -2852,6 +3215,9 @@ export interface ModifyWorkspaceStateRequest { } export namespace ModifyWorkspaceStateRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ModifyWorkspaceStateRequest): any => ({ ...obj, }); @@ -2860,6 +3226,9 @@ export namespace ModifyWorkspaceStateRequest { export interface ModifyWorkspaceStateResult {} export namespace ModifyWorkspaceStateResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: ModifyWorkspaceStateResult): any => ({ ...obj, }); @@ -2876,6 +3245,9 @@ export interface RebootRequest { } export namespace RebootRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: RebootRequest): any => ({ ...obj, }); @@ -2889,6 +3261,9 @@ export interface RebootWorkspacesRequest { } export namespace RebootWorkspacesRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: RebootWorkspacesRequest): any => ({ ...obj, }); @@ -2902,6 +3277,9 @@ export interface RebootWorkspacesResult { } export namespace RebootWorkspacesResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: RebootWorkspacesResult): any => ({ ...obj, }); @@ -2918,6 +3296,9 @@ export interface RebuildRequest { } export namespace RebuildRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: RebuildRequest): any => ({ ...obj, }); @@ -2931,6 +3312,9 @@ export interface RebuildWorkspacesRequest { } export namespace RebuildWorkspacesRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: RebuildWorkspacesRequest): any => ({ ...obj, }); @@ -2944,6 +3328,9 @@ export interface RebuildWorkspacesResult { } export namespace RebuildWorkspacesResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: RebuildWorkspacesResult): any => ({ ...obj, }); @@ -2994,6 +3381,9 @@ export interface RegisterWorkspaceDirectoryRequest { } export namespace RegisterWorkspaceDirectoryRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: RegisterWorkspaceDirectoryRequest): any => ({ ...obj, }); @@ -3002,6 +3392,9 @@ export namespace RegisterWorkspaceDirectoryRequest { export interface RegisterWorkspaceDirectoryResult {} export namespace RegisterWorkspaceDirectoryResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: RegisterWorkspaceDirectoryResult): any => ({ ...obj, }); @@ -3020,6 +3413,9 @@ export interface UnsupportedNetworkConfigurationException extends __SmithyExcept } export namespace UnsupportedNetworkConfigurationException { + /** + * @internal + */ export const filterSensitiveLog = (obj: UnsupportedNetworkConfigurationException): any => ({ ...obj, }); @@ -3036,6 +3432,9 @@ export interface WorkspacesDefaultRoleNotFoundException extends __SmithyExceptio } export namespace WorkspacesDefaultRoleNotFoundException { + /** + * @internal + */ export const filterSensitiveLog = (obj: WorkspacesDefaultRoleNotFoundException): any => ({ ...obj, }); @@ -3049,6 +3448,9 @@ export interface RestoreWorkspaceRequest { } export namespace RestoreWorkspaceRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: RestoreWorkspaceRequest): any => ({ ...obj, }); @@ -3057,6 +3459,9 @@ export namespace RestoreWorkspaceRequest { export interface RestoreWorkspaceResult {} export namespace RestoreWorkspaceResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: RestoreWorkspaceResult): any => ({ ...obj, }); @@ -3075,6 +3480,9 @@ export interface RevokeIpRulesRequest { } export namespace RevokeIpRulesRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: RevokeIpRulesRequest): any => ({ ...obj, }); @@ -3083,6 +3491,9 @@ export namespace RevokeIpRulesRequest { export interface RevokeIpRulesResult {} export namespace RevokeIpRulesResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: RevokeIpRulesResult): any => ({ ...obj, }); @@ -3099,6 +3510,9 @@ export interface StartRequest { } export namespace StartRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: StartRequest): any => ({ ...obj, }); @@ -3112,6 +3526,9 @@ export interface StartWorkspacesRequest { } export namespace StartWorkspacesRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: StartWorkspacesRequest): any => ({ ...obj, }); @@ -3125,6 +3542,9 @@ export interface StartWorkspacesResult { } export namespace StartWorkspacesResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: StartWorkspacesResult): any => ({ ...obj, }); @@ -3141,6 +3561,9 @@ export interface StopRequest { } export namespace StopRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: StopRequest): any => ({ ...obj, }); @@ -3154,6 +3577,9 @@ export interface StopWorkspacesRequest { } export namespace StopWorkspacesRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: StopWorkspacesRequest): any => ({ ...obj, }); @@ -3167,6 +3593,9 @@ export interface StopWorkspacesResult { } export namespace StopWorkspacesResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: StopWorkspacesResult): any => ({ ...obj, }); @@ -3183,6 +3612,9 @@ export interface TerminateRequest { } export namespace TerminateRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: TerminateRequest): any => ({ ...obj, }); @@ -3196,6 +3628,9 @@ export interface TerminateWorkspacesRequest { } export namespace TerminateWorkspacesRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: TerminateWorkspacesRequest): any => ({ ...obj, }); @@ -3209,6 +3644,9 @@ export interface TerminateWorkspacesResult { } export namespace TerminateWorkspacesResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: TerminateWorkspacesResult): any => ({ ...obj, }); @@ -3227,6 +3665,9 @@ export interface UpdateConnectionAliasPermissionRequest { } export namespace UpdateConnectionAliasPermissionRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateConnectionAliasPermissionRequest): any => ({ ...obj, }); @@ -3235,6 +3676,9 @@ export namespace UpdateConnectionAliasPermissionRequest { export interface UpdateConnectionAliasPermissionResult {} export namespace UpdateConnectionAliasPermissionResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateConnectionAliasPermissionResult): any => ({ ...obj, }); @@ -3253,6 +3697,9 @@ export interface UpdateRulesOfIpGroupRequest { } export namespace UpdateRulesOfIpGroupRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateRulesOfIpGroupRequest): any => ({ ...obj, }); @@ -3261,6 +3708,9 @@ export namespace UpdateRulesOfIpGroupRequest { export interface UpdateRulesOfIpGroupResult {} export namespace UpdateRulesOfIpGroupResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateRulesOfIpGroupResult): any => ({ ...obj, }); @@ -3279,6 +3729,9 @@ export interface UpdateWorkspaceBundleRequest { } export namespace UpdateWorkspaceBundleRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateWorkspaceBundleRequest): any => ({ ...obj, }); @@ -3287,6 +3740,9 @@ export namespace UpdateWorkspaceBundleRequest { export interface UpdateWorkspaceBundleResult {} export namespace UpdateWorkspaceBundleResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateWorkspaceBundleResult): any => ({ ...obj, }); @@ -3315,6 +3771,9 @@ export interface UpdateWorkspaceImagePermissionRequest { } export namespace UpdateWorkspaceImagePermissionRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateWorkspaceImagePermissionRequest): any => ({ ...obj, }); @@ -3323,6 +3782,9 @@ export namespace UpdateWorkspaceImagePermissionRequest { export interface UpdateWorkspaceImagePermissionResult {} export namespace UpdateWorkspaceImagePermissionResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateWorkspaceImagePermissionResult): any => ({ ...obj, }); diff --git a/clients/client-xray/commands/BatchGetTracesCommand.ts b/clients/client-xray/commands/BatchGetTracesCommand.ts index 8621b2b8f93b..9f13f0805193 100644 --- a/clients/client-xray/commands/BatchGetTracesCommand.ts +++ b/clients/client-xray/commands/BatchGetTracesCommand.ts @@ -24,6 +24,20 @@ export interface BatchGetTracesCommandOutput extends BatchGetTracesResult, __Met *

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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { XRayClient, BatchGetTracesCommand } from "@aws-sdk/client-xray"; // ES Modules import + * // const { XRayClient, BatchGetTracesCommand } = require("@aws-sdk/client-xray"); // CommonJS import + * const client = new XRayClient(config); + * const command = new BatchGetTracesCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link BatchGetTracesCommandInput} for command's `input` shape. + * @see {@link BatchGetTracesCommandOutput} for command's `response` shape. + * @see {@link XRayClientResolvedConfig | config} for command's `input` shape. + * */ export class BatchGetTracesCommand extends $Command< BatchGetTracesCommandInput, diff --git a/clients/client-xray/commands/CreateGroupCommand.ts b/clients/client-xray/commands/CreateGroupCommand.ts index 7c80405a3ae0..edf61043c344 100644 --- a/clients/client-xray/commands/CreateGroupCommand.ts +++ b/clients/client-xray/commands/CreateGroupCommand.ts @@ -22,6 +22,20 @@ export interface CreateGroupCommandOutput extends CreateGroupResult, __MetadataB /** *

Creates a group resource with a name and a filter expression.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { XRayClient, CreateGroupCommand } from "@aws-sdk/client-xray"; // ES Modules import + * // const { XRayClient, CreateGroupCommand } = require("@aws-sdk/client-xray"); // CommonJS import + * const client = new XRayClient(config); + * const command = new CreateGroupCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreateGroupCommandInput} for command's `input` shape. + * @see {@link CreateGroupCommandOutput} for command's `response` shape. + * @see {@link XRayClientResolvedConfig | config} for command's `input` shape. + * */ export class CreateGroupCommand extends $Command< CreateGroupCommandInput, diff --git a/clients/client-xray/commands/CreateSamplingRuleCommand.ts b/clients/client-xray/commands/CreateSamplingRuleCommand.ts index d92343ea6a33..3ac3447f90dd 100644 --- a/clients/client-xray/commands/CreateSamplingRuleCommand.ts +++ b/clients/client-xray/commands/CreateSamplingRuleCommand.ts @@ -28,6 +28,20 @@ export interface CreateSamplingRuleCommandOutput extends CreateSamplingRuleResul * 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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { XRayClient, CreateSamplingRuleCommand } from "@aws-sdk/client-xray"; // ES Modules import + * // const { XRayClient, CreateSamplingRuleCommand } = require("@aws-sdk/client-xray"); // CommonJS import + * const client = new XRayClient(config); + * const command = new CreateSamplingRuleCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreateSamplingRuleCommandInput} for command's `input` shape. + * @see {@link CreateSamplingRuleCommandOutput} for command's `response` shape. + * @see {@link XRayClientResolvedConfig | config} for command's `input` shape. + * */ export class CreateSamplingRuleCommand extends $Command< CreateSamplingRuleCommandInput, diff --git a/clients/client-xray/commands/DeleteGroupCommand.ts b/clients/client-xray/commands/DeleteGroupCommand.ts index d2c826d9220a..0243a4fb81b5 100644 --- a/clients/client-xray/commands/DeleteGroupCommand.ts +++ b/clients/client-xray/commands/DeleteGroupCommand.ts @@ -22,6 +22,20 @@ export interface DeleteGroupCommandOutput extends DeleteGroupResult, __MetadataB /** *

Deletes a group resource.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { XRayClient, DeleteGroupCommand } from "@aws-sdk/client-xray"; // ES Modules import + * // const { XRayClient, DeleteGroupCommand } = require("@aws-sdk/client-xray"); // CommonJS import + * const client = new XRayClient(config); + * const command = new DeleteGroupCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteGroupCommandInput} for command's `input` shape. + * @see {@link DeleteGroupCommandOutput} for command's `response` shape. + * @see {@link XRayClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteGroupCommand extends $Command< DeleteGroupCommandInput, diff --git a/clients/client-xray/commands/DeleteSamplingRuleCommand.ts b/clients/client-xray/commands/DeleteSamplingRuleCommand.ts index 208c6c7b1630..cf2df6e243e2 100644 --- a/clients/client-xray/commands/DeleteSamplingRuleCommand.ts +++ b/clients/client-xray/commands/DeleteSamplingRuleCommand.ts @@ -22,6 +22,20 @@ export interface DeleteSamplingRuleCommandOutput extends DeleteSamplingRuleResul /** *

Deletes a sampling rule.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { XRayClient, DeleteSamplingRuleCommand } from "@aws-sdk/client-xray"; // ES Modules import + * // const { XRayClient, DeleteSamplingRuleCommand } = require("@aws-sdk/client-xray"); // CommonJS import + * const client = new XRayClient(config); + * const command = new DeleteSamplingRuleCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteSamplingRuleCommandInput} for command's `input` shape. + * @see {@link DeleteSamplingRuleCommandOutput} for command's `response` shape. + * @see {@link XRayClientResolvedConfig | config} for command's `input` shape. + * */ export class DeleteSamplingRuleCommand extends $Command< DeleteSamplingRuleCommandInput, diff --git a/clients/client-xray/commands/GetEncryptionConfigCommand.ts b/clients/client-xray/commands/GetEncryptionConfigCommand.ts index 3480bf314efa..5af0a92d8cfb 100644 --- a/clients/client-xray/commands/GetEncryptionConfigCommand.ts +++ b/clients/client-xray/commands/GetEncryptionConfigCommand.ts @@ -22,6 +22,20 @@ export interface GetEncryptionConfigCommandOutput extends GetEncryptionConfigRes /** *

Retrieves the current encryption configuration for X-Ray data.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { XRayClient, GetEncryptionConfigCommand } from "@aws-sdk/client-xray"; // ES Modules import + * // const { XRayClient, GetEncryptionConfigCommand } = require("@aws-sdk/client-xray"); // CommonJS import + * const client = new XRayClient(config); + * const command = new GetEncryptionConfigCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetEncryptionConfigCommandInput} for command's `input` shape. + * @see {@link GetEncryptionConfigCommandOutput} for command's `response` shape. + * @see {@link XRayClientResolvedConfig | config} for command's `input` shape. + * */ export class GetEncryptionConfigCommand extends $Command< GetEncryptionConfigCommandInput, diff --git a/clients/client-xray/commands/GetGroupCommand.ts b/clients/client-xray/commands/GetGroupCommand.ts index 012bc61942e8..e54a817ad917 100644 --- a/clients/client-xray/commands/GetGroupCommand.ts +++ b/clients/client-xray/commands/GetGroupCommand.ts @@ -22,6 +22,20 @@ export interface GetGroupCommandOutput extends GetGroupResult, __MetadataBearer /** *

Retrieves group resource details.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { XRayClient, GetGroupCommand } from "@aws-sdk/client-xray"; // ES Modules import + * // const { XRayClient, GetGroupCommand } = require("@aws-sdk/client-xray"); // CommonJS import + * const client = new XRayClient(config); + * const command = new GetGroupCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetGroupCommandInput} for command's `input` shape. + * @see {@link GetGroupCommandOutput} for command's `response` shape. + * @see {@link XRayClientResolvedConfig | config} for command's `input` shape. + * */ export class GetGroupCommand extends $Command { // Start section: command_properties diff --git a/clients/client-xray/commands/GetGroupsCommand.ts b/clients/client-xray/commands/GetGroupsCommand.ts index ed9b7980030f..1f52f945942f 100644 --- a/clients/client-xray/commands/GetGroupsCommand.ts +++ b/clients/client-xray/commands/GetGroupsCommand.ts @@ -22,6 +22,20 @@ export interface GetGroupsCommandOutput extends GetGroupsResult, __MetadataBeare /** *

Retrieves all active group details.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { XRayClient, GetGroupsCommand } from "@aws-sdk/client-xray"; // ES Modules import + * // const { XRayClient, GetGroupsCommand } = require("@aws-sdk/client-xray"); // CommonJS import + * const client = new XRayClient(config); + * const command = new GetGroupsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetGroupsCommandInput} for command's `input` shape. + * @see {@link GetGroupsCommandOutput} for command's `response` shape. + * @see {@link XRayClientResolvedConfig | config} for command's `input` shape. + * */ export class GetGroupsCommand extends $Command< GetGroupsCommandInput, diff --git a/clients/client-xray/commands/GetInsightCommand.ts b/clients/client-xray/commands/GetInsightCommand.ts index 447b6b41b349..d9b0e84454fe 100644 --- a/clients/client-xray/commands/GetInsightCommand.ts +++ b/clients/client-xray/commands/GetInsightCommand.ts @@ -24,6 +24,20 @@ export interface GetInsightCommandOutput extends GetInsightResult, __MetadataBea *

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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { XRayClient, GetInsightCommand } from "@aws-sdk/client-xray"; // ES Modules import + * // const { XRayClient, GetInsightCommand } = require("@aws-sdk/client-xray"); // CommonJS import + * const client = new XRayClient(config); + * const command = new GetInsightCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetInsightCommandInput} for command's `input` shape. + * @see {@link GetInsightCommandOutput} for command's `response` shape. + * @see {@link XRayClientResolvedConfig | config} for command's `input` shape. + * */ export class GetInsightCommand extends $Command< GetInsightCommandInput, diff --git a/clients/client-xray/commands/GetInsightEventsCommand.ts b/clients/client-xray/commands/GetInsightEventsCommand.ts index f16246ad1c0f..d0fd2d8e79c8 100644 --- a/clients/client-xray/commands/GetInsightEventsCommand.ts +++ b/clients/client-xray/commands/GetInsightEventsCommand.ts @@ -24,6 +24,20 @@ export interface GetInsightEventsCommandOutput extends GetInsightEventsResult, _ *

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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { XRayClient, GetInsightEventsCommand } from "@aws-sdk/client-xray"; // ES Modules import + * // const { XRayClient, GetInsightEventsCommand } = require("@aws-sdk/client-xray"); // CommonJS import + * const client = new XRayClient(config); + * const command = new GetInsightEventsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetInsightEventsCommandInput} for command's `input` shape. + * @see {@link GetInsightEventsCommandOutput} for command's `response` shape. + * @see {@link XRayClientResolvedConfig | config} for command's `input` shape. + * */ export class GetInsightEventsCommand extends $Command< GetInsightEventsCommandInput, diff --git a/clients/client-xray/commands/GetInsightImpactGraphCommand.ts b/clients/client-xray/commands/GetInsightImpactGraphCommand.ts index 4c56ed1b0581..b602136edc7d 100644 --- a/clients/client-xray/commands/GetInsightImpactGraphCommand.ts +++ b/clients/client-xray/commands/GetInsightImpactGraphCommand.ts @@ -23,6 +23,20 @@ export interface GetInsightImpactGraphCommandOutput extends GetInsightImpactGrap /** *

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.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { XRayClient, GetInsightImpactGraphCommand } from "@aws-sdk/client-xray"; // ES Modules import + * // const { XRayClient, GetInsightImpactGraphCommand } = require("@aws-sdk/client-xray"); // CommonJS import + * const client = new XRayClient(config); + * const command = new GetInsightImpactGraphCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetInsightImpactGraphCommandInput} for command's `input` shape. + * @see {@link GetInsightImpactGraphCommandOutput} for command's `response` shape. + * @see {@link XRayClientResolvedConfig | config} for command's `input` shape. + * */ export class GetInsightImpactGraphCommand extends $Command< GetInsightImpactGraphCommandInput, diff --git a/clients/client-xray/commands/GetInsightSummariesCommand.ts b/clients/client-xray/commands/GetInsightSummariesCommand.ts index 4551a767409e..728647c733ea 100644 --- a/clients/client-xray/commands/GetInsightSummariesCommand.ts +++ b/clients/client-xray/commands/GetInsightSummariesCommand.ts @@ -22,6 +22,20 @@ export interface GetInsightSummariesCommandOutput extends GetInsightSummariesRes /** *

Retrieves the summaries of all insights in the specified group matching the provided filter values.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { XRayClient, GetInsightSummariesCommand } from "@aws-sdk/client-xray"; // ES Modules import + * // const { XRayClient, GetInsightSummariesCommand } = require("@aws-sdk/client-xray"); // CommonJS import + * const client = new XRayClient(config); + * const command = new GetInsightSummariesCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetInsightSummariesCommandInput} for command's `input` shape. + * @see {@link GetInsightSummariesCommandOutput} for command's `response` shape. + * @see {@link XRayClientResolvedConfig | config} for command's `input` shape. + * */ export class GetInsightSummariesCommand extends $Command< GetInsightSummariesCommandInput, diff --git a/clients/client-xray/commands/GetSamplingRulesCommand.ts b/clients/client-xray/commands/GetSamplingRulesCommand.ts index 942679e775b3..b13bb5220b97 100644 --- a/clients/client-xray/commands/GetSamplingRulesCommand.ts +++ b/clients/client-xray/commands/GetSamplingRulesCommand.ts @@ -22,6 +22,20 @@ export interface GetSamplingRulesCommandOutput extends GetSamplingRulesResult, _ /** *

Retrieves all sampling rules.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { XRayClient, GetSamplingRulesCommand } from "@aws-sdk/client-xray"; // ES Modules import + * // const { XRayClient, GetSamplingRulesCommand } = require("@aws-sdk/client-xray"); // CommonJS import + * const client = new XRayClient(config); + * const command = new GetSamplingRulesCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetSamplingRulesCommandInput} for command's `input` shape. + * @see {@link GetSamplingRulesCommandOutput} for command's `response` shape. + * @see {@link XRayClientResolvedConfig | config} for command's `input` shape. + * */ export class GetSamplingRulesCommand extends $Command< GetSamplingRulesCommandInput, diff --git a/clients/client-xray/commands/GetSamplingStatisticSummariesCommand.ts b/clients/client-xray/commands/GetSamplingStatisticSummariesCommand.ts index 4c207ae61104..2c802916a2ef 100644 --- a/clients/client-xray/commands/GetSamplingStatisticSummariesCommand.ts +++ b/clients/client-xray/commands/GetSamplingStatisticSummariesCommand.ts @@ -24,6 +24,20 @@ export interface GetSamplingStatisticSummariesCommandOutput /** *

Retrieves information about recent sampling results for all sampling rules.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { XRayClient, GetSamplingStatisticSummariesCommand } from "@aws-sdk/client-xray"; // ES Modules import + * // const { XRayClient, GetSamplingStatisticSummariesCommand } = require("@aws-sdk/client-xray"); // CommonJS import + * const client = new XRayClient(config); + * const command = new GetSamplingStatisticSummariesCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetSamplingStatisticSummariesCommandInput} for command's `input` shape. + * @see {@link GetSamplingStatisticSummariesCommandOutput} for command's `response` shape. + * @see {@link XRayClientResolvedConfig | config} for command's `input` shape. + * */ export class GetSamplingStatisticSummariesCommand extends $Command< GetSamplingStatisticSummariesCommandInput, diff --git a/clients/client-xray/commands/GetSamplingTargetsCommand.ts b/clients/client-xray/commands/GetSamplingTargetsCommand.ts index a1aac19bc7b2..60514af57334 100644 --- a/clients/client-xray/commands/GetSamplingTargetsCommand.ts +++ b/clients/client-xray/commands/GetSamplingTargetsCommand.ts @@ -23,6 +23,20 @@ export interface GetSamplingTargetsCommandOutput extends GetSamplingTargetsResul /** *

Requests a sampling quota for rules that the service is using to sample requests. *

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { XRayClient, GetSamplingTargetsCommand } from "@aws-sdk/client-xray"; // ES Modules import + * // const { XRayClient, GetSamplingTargetsCommand } = require("@aws-sdk/client-xray"); // CommonJS import + * const client = new XRayClient(config); + * const command = new GetSamplingTargetsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetSamplingTargetsCommandInput} for command's `input` shape. + * @see {@link GetSamplingTargetsCommandOutput} for command's `response` shape. + * @see {@link XRayClientResolvedConfig | config} for command's `input` shape. + * */ export class GetSamplingTargetsCommand extends $Command< GetSamplingTargetsCommandInput, diff --git a/clients/client-xray/commands/GetServiceGraphCommand.ts b/clients/client-xray/commands/GetServiceGraphCommand.ts index 6bc4aa6b8da4..0ad8e369cf1a 100644 --- a/clients/client-xray/commands/GetServiceGraphCommand.ts +++ b/clients/client-xray/commands/GetServiceGraphCommand.ts @@ -26,6 +26,20 @@ export interface GetServiceGraphCommandOutput extends GetServiceGraphResult, __M * make calls to downstream services. Root services are applications that use the AWS X-Ray SDK. * Downstream services can be other applications, AWS resources, HTTP web APIs, or SQL * databases.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { XRayClient, GetServiceGraphCommand } from "@aws-sdk/client-xray"; // ES Modules import + * // const { XRayClient, GetServiceGraphCommand } = require("@aws-sdk/client-xray"); // CommonJS import + * const client = new XRayClient(config); + * const command = new GetServiceGraphCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetServiceGraphCommandInput} for command's `input` shape. + * @see {@link GetServiceGraphCommandOutput} for command's `response` shape. + * @see {@link XRayClientResolvedConfig | config} for command's `input` shape. + * */ export class GetServiceGraphCommand extends $Command< GetServiceGraphCommandInput, diff --git a/clients/client-xray/commands/GetTimeSeriesServiceStatisticsCommand.ts b/clients/client-xray/commands/GetTimeSeriesServiceStatisticsCommand.ts index 542e025bbbf7..6cfb7d88765c 100644 --- a/clients/client-xray/commands/GetTimeSeriesServiceStatisticsCommand.ts +++ b/clients/client-xray/commands/GetTimeSeriesServiceStatisticsCommand.ts @@ -25,6 +25,20 @@ export interface GetTimeSeriesServiceStatisticsCommandOutput /** *

Get an aggregation of service statistics defined by a specific time * range.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { XRayClient, GetTimeSeriesServiceStatisticsCommand } from "@aws-sdk/client-xray"; // ES Modules import + * // const { XRayClient, GetTimeSeriesServiceStatisticsCommand } = require("@aws-sdk/client-xray"); // CommonJS import + * const client = new XRayClient(config); + * const command = new GetTimeSeriesServiceStatisticsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetTimeSeriesServiceStatisticsCommandInput} for command's `input` shape. + * @see {@link GetTimeSeriesServiceStatisticsCommandOutput} for command's `response` shape. + * @see {@link XRayClientResolvedConfig | config} for command's `input` shape. + * */ export class GetTimeSeriesServiceStatisticsCommand extends $Command< GetTimeSeriesServiceStatisticsCommandInput, diff --git a/clients/client-xray/commands/GetTraceGraphCommand.ts b/clients/client-xray/commands/GetTraceGraphCommand.ts index 77a549977486..56c76fd26d88 100644 --- a/clients/client-xray/commands/GetTraceGraphCommand.ts +++ b/clients/client-xray/commands/GetTraceGraphCommand.ts @@ -22,6 +22,20 @@ export interface GetTraceGraphCommandOutput extends GetTraceGraphResult, __Metad /** *

Retrieves a service graph for one or more specific trace IDs.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { XRayClient, GetTraceGraphCommand } from "@aws-sdk/client-xray"; // ES Modules import + * // const { XRayClient, GetTraceGraphCommand } = require("@aws-sdk/client-xray"); // CommonJS import + * const client = new XRayClient(config); + * const command = new GetTraceGraphCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetTraceGraphCommandInput} for command's `input` shape. + * @see {@link GetTraceGraphCommandOutput} for command's `response` shape. + * @see {@link XRayClientResolvedConfig | config} for command's `input` shape. + * */ export class GetTraceGraphCommand extends $Command< GetTraceGraphCommandInput, diff --git a/clients/client-xray/commands/GetTraceSummariesCommand.ts b/clients/client-xray/commands/GetTraceSummariesCommand.ts index 8d58071c1674..9fda578fd7c7 100644 --- a/clients/client-xray/commands/GetTraceSummariesCommand.ts +++ b/clients/client-xray/commands/GetTraceSummariesCommand.ts @@ -38,6 +38,20 @@ export interface GetTraceSummariesCommandOutput extends GetTraceSummariesResult, *

For a full list of indexed fields and keywords that you can use in filter expressions, * see Using Filter * Expressions in the AWS X-Ray Developer Guide.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { XRayClient, GetTraceSummariesCommand } from "@aws-sdk/client-xray"; // ES Modules import + * // const { XRayClient, GetTraceSummariesCommand } = require("@aws-sdk/client-xray"); // CommonJS import + * const client = new XRayClient(config); + * const command = new GetTraceSummariesCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetTraceSummariesCommandInput} for command's `input` shape. + * @see {@link GetTraceSummariesCommandOutput} for command's `response` shape. + * @see {@link XRayClientResolvedConfig | config} for command's `input` shape. + * */ export class GetTraceSummariesCommand extends $Command< GetTraceSummariesCommandInput, diff --git a/clients/client-xray/commands/ListTagsForResourceCommand.ts b/clients/client-xray/commands/ListTagsForResourceCommand.ts index 924ca27e1c30..19b0c5ac6bc6 100644 --- a/clients/client-xray/commands/ListTagsForResourceCommand.ts +++ b/clients/client-xray/commands/ListTagsForResourceCommand.ts @@ -22,6 +22,20 @@ export interface ListTagsForResourceCommandOutput extends ListTagsForResourceRes /** *

Returns a list of tags that are applied to the specified AWS X-Ray group or sampling rule.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { XRayClient, ListTagsForResourceCommand } from "@aws-sdk/client-xray"; // ES Modules import + * // const { XRayClient, ListTagsForResourceCommand } = require("@aws-sdk/client-xray"); // CommonJS import + * const client = new XRayClient(config); + * const command = new ListTagsForResourceCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListTagsForResourceCommandInput} for command's `input` shape. + * @see {@link ListTagsForResourceCommandOutput} for command's `response` shape. + * @see {@link XRayClientResolvedConfig | config} for command's `input` shape. + * */ export class ListTagsForResourceCommand extends $Command< ListTagsForResourceCommandInput, diff --git a/clients/client-xray/commands/PutEncryptionConfigCommand.ts b/clients/client-xray/commands/PutEncryptionConfigCommand.ts index da0f111e499e..4eb5381e517d 100644 --- a/clients/client-xray/commands/PutEncryptionConfigCommand.ts +++ b/clients/client-xray/commands/PutEncryptionConfigCommand.ts @@ -22,6 +22,20 @@ export interface PutEncryptionConfigCommandOutput extends PutEncryptionConfigRes /** *

Updates the encryption configuration for X-Ray data.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { XRayClient, PutEncryptionConfigCommand } from "@aws-sdk/client-xray"; // ES Modules import + * // const { XRayClient, PutEncryptionConfigCommand } = require("@aws-sdk/client-xray"); // CommonJS import + * const client = new XRayClient(config); + * const command = new PutEncryptionConfigCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link PutEncryptionConfigCommandInput} for command's `input` shape. + * @see {@link PutEncryptionConfigCommandOutput} for command's `response` shape. + * @see {@link XRayClientResolvedConfig | config} for command's `input` shape. + * */ export class PutEncryptionConfigCommand extends $Command< PutEncryptionConfigCommandInput, diff --git a/clients/client-xray/commands/PutTelemetryRecordsCommand.ts b/clients/client-xray/commands/PutTelemetryRecordsCommand.ts index 8b84bf500cf8..9961e2064aac 100644 --- a/clients/client-xray/commands/PutTelemetryRecordsCommand.ts +++ b/clients/client-xray/commands/PutTelemetryRecordsCommand.ts @@ -22,6 +22,20 @@ export interface PutTelemetryRecordsCommandOutput extends PutTelemetryRecordsRes /** *

Used by the AWS X-Ray daemon to upload telemetry.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { XRayClient, PutTelemetryRecordsCommand } from "@aws-sdk/client-xray"; // ES Modules import + * // const { XRayClient, PutTelemetryRecordsCommand } = require("@aws-sdk/client-xray"); // CommonJS import + * const client = new XRayClient(config); + * const command = new PutTelemetryRecordsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link PutTelemetryRecordsCommandInput} for command's `input` shape. + * @see {@link PutTelemetryRecordsCommandOutput} for command's `response` shape. + * @see {@link XRayClientResolvedConfig | config} for command's `input` shape. + * */ export class PutTelemetryRecordsCommand extends $Command< PutTelemetryRecordsCommandInput, diff --git a/clients/client-xray/commands/PutTraceSegmentsCommand.ts b/clients/client-xray/commands/PutTraceSegmentsCommand.ts index b304b4b08f6e..44a9ec76e316 100644 --- a/clients/client-xray/commands/PutTraceSegmentsCommand.ts +++ b/clients/client-xray/commands/PutTraceSegmentsCommand.ts @@ -84,6 +84,20 @@ export interface PutTraceSegmentsCommandOutput extends PutTraceSegmentsResult, _ * digits.

* * + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { XRayClient, PutTraceSegmentsCommand } from "@aws-sdk/client-xray"; // ES Modules import + * // const { XRayClient, PutTraceSegmentsCommand } = require("@aws-sdk/client-xray"); // CommonJS import + * const client = new XRayClient(config); + * const command = new PutTraceSegmentsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link PutTraceSegmentsCommandInput} for command's `input` shape. + * @see {@link PutTraceSegmentsCommandOutput} for command's `response` shape. + * @see {@link XRayClientResolvedConfig | config} for command's `input` shape. + * */ export class PutTraceSegmentsCommand extends $Command< PutTraceSegmentsCommandInput, diff --git a/clients/client-xray/commands/TagResourceCommand.ts b/clients/client-xray/commands/TagResourceCommand.ts index 26fe6ebfcebe..46c51d2f6ef8 100644 --- a/clients/client-xray/commands/TagResourceCommand.ts +++ b/clients/client-xray/commands/TagResourceCommand.ts @@ -22,6 +22,20 @@ export interface TagResourceCommandOutput extends TagResourceResponse, __Metadat /** *

Applies tags to an existing AWS X-Ray group or sampling rule.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { XRayClient, TagResourceCommand } from "@aws-sdk/client-xray"; // ES Modules import + * // const { XRayClient, TagResourceCommand } = require("@aws-sdk/client-xray"); // CommonJS import + * const client = new XRayClient(config); + * const command = new TagResourceCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link TagResourceCommandInput} for command's `input` shape. + * @see {@link TagResourceCommandOutput} for command's `response` shape. + * @see {@link XRayClientResolvedConfig | config} for command's `input` shape. + * */ export class TagResourceCommand extends $Command< TagResourceCommandInput, diff --git a/clients/client-xray/commands/UntagResourceCommand.ts b/clients/client-xray/commands/UntagResourceCommand.ts index 32ec8f020029..bb3b1669ff6f 100644 --- a/clients/client-xray/commands/UntagResourceCommand.ts +++ b/clients/client-xray/commands/UntagResourceCommand.ts @@ -23,6 +23,20 @@ export interface UntagResourceCommandOutput extends UntagResourceResponse, __Met /** *

Removes tags from an AWS X-Ray group or sampling rule. You cannot edit or delete system * tags (those with an aws: prefix).

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { XRayClient, UntagResourceCommand } from "@aws-sdk/client-xray"; // ES Modules import + * // const { XRayClient, UntagResourceCommand } = require("@aws-sdk/client-xray"); // CommonJS import + * const client = new XRayClient(config); + * const command = new UntagResourceCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link UntagResourceCommandInput} for command's `input` shape. + * @see {@link UntagResourceCommandOutput} for command's `response` shape. + * @see {@link XRayClientResolvedConfig | config} for command's `input` shape. + * */ export class UntagResourceCommand extends $Command< UntagResourceCommandInput, diff --git a/clients/client-xray/commands/UpdateGroupCommand.ts b/clients/client-xray/commands/UpdateGroupCommand.ts index 71ec1e903b45..3746a4e7c59e 100644 --- a/clients/client-xray/commands/UpdateGroupCommand.ts +++ b/clients/client-xray/commands/UpdateGroupCommand.ts @@ -22,6 +22,20 @@ export interface UpdateGroupCommandOutput extends UpdateGroupResult, __MetadataB /** *

Updates a group resource.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { XRayClient, UpdateGroupCommand } from "@aws-sdk/client-xray"; // ES Modules import + * // const { XRayClient, UpdateGroupCommand } = require("@aws-sdk/client-xray"); // CommonJS import + * const client = new XRayClient(config); + * const command = new UpdateGroupCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link UpdateGroupCommandInput} for command's `input` shape. + * @see {@link UpdateGroupCommandOutput} for command's `response` shape. + * @see {@link XRayClientResolvedConfig | config} for command's `input` shape. + * */ export class UpdateGroupCommand extends $Command< UpdateGroupCommandInput, diff --git a/clients/client-xray/commands/UpdateSamplingRuleCommand.ts b/clients/client-xray/commands/UpdateSamplingRuleCommand.ts index 2849b51a1e30..04b079c419d8 100644 --- a/clients/client-xray/commands/UpdateSamplingRuleCommand.ts +++ b/clients/client-xray/commands/UpdateSamplingRuleCommand.ts @@ -22,6 +22,20 @@ export interface UpdateSamplingRuleCommandOutput extends UpdateSamplingRuleResul /** *

Modifies a sampling rule's configuration.

+ * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { XRayClient, UpdateSamplingRuleCommand } from "@aws-sdk/client-xray"; // ES Modules import + * // const { XRayClient, UpdateSamplingRuleCommand } = require("@aws-sdk/client-xray"); // CommonJS import + * const client = new XRayClient(config); + * const command = new UpdateSamplingRuleCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link UpdateSamplingRuleCommandInput} for command's `input` shape. + * @see {@link UpdateSamplingRuleCommandOutput} for command's `response` shape. + * @see {@link XRayClientResolvedConfig | config} for command's `input` shape. + * */ export class UpdateSamplingRuleCommand extends $Command< UpdateSamplingRuleCommandInput, diff --git a/clients/client-xray/models/models_0.ts b/clients/client-xray/models/models_0.ts index 31473df07bf0..e71e4ce64c5e 100644 --- a/clients/client-xray/models/models_0.ts +++ b/clients/client-xray/models/models_0.ts @@ -22,6 +22,9 @@ export interface Alias { } export namespace Alias { + /** + * @internal + */ export const filterSensitiveLog = (obj: Alias): any => ({ ...obj, }); @@ -88,6 +91,9 @@ export namespace AnnotationValue { return visitor._(value.$unknown[0], value.$unknown[1]); }; + /** + * @internal + */ export const filterSensitiveLog = (obj: AnnotationValue): any => { if (obj.NumberValue !== undefined) return { NumberValue: obj.NumberValue }; if (obj.BooleanValue !== undefined) return { BooleanValue: obj.BooleanValue }; @@ -122,6 +128,9 @@ export interface ServiceId { } export namespace ServiceId { + /** + * @internal + */ export const filterSensitiveLog = (obj: ServiceId): any => ({ ...obj, }); @@ -143,6 +152,9 @@ export interface ValueWithServiceIds { } export namespace ValueWithServiceIds { + /** + * @internal + */ export const filterSensitiveLog = (obj: ValueWithServiceIds): any => ({ ...obj, ...(obj.AnnotationValue && { AnnotationValue: AnnotationValue.filterSensitiveLog(obj.AnnotationValue) }), @@ -160,6 +172,9 @@ export interface AnomalousService { } export namespace AnomalousService { + /** + * @internal + */ export const filterSensitiveLog = (obj: AnomalousService): any => ({ ...obj, }); @@ -176,6 +191,9 @@ export interface AvailabilityZoneDetail { } export namespace AvailabilityZoneDetail { + /** + * @internal + */ export const filterSensitiveLog = (obj: AvailabilityZoneDetail): any => ({ ...obj, }); @@ -194,6 +212,9 @@ export interface BatchGetTracesRequest { } export namespace BatchGetTracesRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: BatchGetTracesRequest): any => ({ ...obj, }); @@ -220,6 +241,9 @@ export interface Segment { } export namespace Segment { + /** + * @internal + */ export const filterSensitiveLog = (obj: Segment): any => ({ ...obj, }); @@ -254,6 +278,9 @@ export interface Trace { } export namespace Trace { + /** + * @internal + */ export const filterSensitiveLog = (obj: Trace): any => ({ ...obj, }); @@ -277,6 +304,9 @@ export interface BatchGetTracesResult { } export namespace BatchGetTracesResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: BatchGetTracesResult): any => ({ ...obj, }); @@ -292,6 +322,9 @@ export interface InvalidRequestException extends __SmithyException, $MetadataBea } export namespace InvalidRequestException { + /** + * @internal + */ export const filterSensitiveLog = (obj: InvalidRequestException): any => ({ ...obj, }); @@ -307,6 +340,9 @@ export interface ThrottledException extends __SmithyException, $MetadataBearer { } export namespace ThrottledException { + /** + * @internal + */ export const filterSensitiveLog = (obj: ThrottledException): any => ({ ...obj, }); @@ -330,6 +366,9 @@ export interface InsightsConfiguration { } export namespace InsightsConfiguration { + /** + * @internal + */ export const filterSensitiveLog = (obj: InsightsConfiguration): any => ({ ...obj, }); @@ -372,6 +411,9 @@ export interface Tag { } export namespace Tag { + /** + * @internal + */ export const filterSensitiveLog = (obj: Tag): any => ({ ...obj, }); @@ -437,6 +479,9 @@ export interface CreateGroupRequest { } export namespace CreateGroupRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateGroupRequest): any => ({ ...obj, }); @@ -478,6 +523,9 @@ export interface Group { } export namespace Group { + /** + * @internal + */ export const filterSensitiveLog = (obj: Group): any => ({ ...obj, }); @@ -493,6 +541,9 @@ export interface CreateGroupResult { } export namespace CreateGroupResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateGroupResult): any => ({ ...obj, }); @@ -573,6 +624,9 @@ export interface SamplingRule { } export namespace SamplingRule { + /** + * @internal + */ export const filterSensitiveLog = (obj: SamplingRule): any => ({ ...obj, }); @@ -616,6 +670,9 @@ export interface CreateSamplingRuleRequest { } export namespace CreateSamplingRuleRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateSamplingRuleRequest): any => ({ ...obj, }); @@ -642,6 +699,9 @@ export interface SamplingRuleRecord { } export namespace SamplingRuleRecord { + /** + * @internal + */ export const filterSensitiveLog = (obj: SamplingRuleRecord): any => ({ ...obj, }); @@ -655,6 +715,9 @@ export interface CreateSamplingRuleResult { } export namespace CreateSamplingRuleResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: CreateSamplingRuleResult): any => ({ ...obj, }); @@ -670,6 +733,9 @@ export interface RuleLimitExceededException extends __SmithyException, $Metadata } export namespace RuleLimitExceededException { + /** + * @internal + */ export const filterSensitiveLog = (obj: RuleLimitExceededException): any => ({ ...obj, }); @@ -688,6 +754,9 @@ export interface DeleteGroupRequest { } export namespace DeleteGroupRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteGroupRequest): any => ({ ...obj, }); @@ -696,6 +765,9 @@ export namespace DeleteGroupRequest { export interface DeleteGroupResult {} export namespace DeleteGroupResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteGroupResult): any => ({ ...obj, }); @@ -714,6 +786,9 @@ export interface DeleteSamplingRuleRequest { } export namespace DeleteSamplingRuleRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteSamplingRuleRequest): any => ({ ...obj, }); @@ -727,6 +802,9 @@ export interface DeleteSamplingRuleResult { } export namespace DeleteSamplingRuleResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: DeleteSamplingRuleResult): any => ({ ...obj, }); @@ -735,6 +813,9 @@ export namespace DeleteSamplingRuleResult { export interface GetEncryptionConfigRequest {} export namespace GetEncryptionConfigRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetEncryptionConfigRequest): any => ({ ...obj, }); @@ -772,6 +853,9 @@ export interface EncryptionConfig { } export namespace EncryptionConfig { + /** + * @internal + */ export const filterSensitiveLog = (obj: EncryptionConfig): any => ({ ...obj, }); @@ -785,6 +869,9 @@ export interface GetEncryptionConfigResult { } export namespace GetEncryptionConfigResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetEncryptionConfigResult): any => ({ ...obj, }); @@ -803,6 +890,9 @@ export interface GetGroupRequest { } export namespace GetGroupRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetGroupRequest): any => ({ ...obj, }); @@ -817,6 +907,9 @@ export interface GetGroupResult { } export namespace GetGroupResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetGroupResult): any => ({ ...obj, }); @@ -830,6 +923,9 @@ export interface GetGroupsRequest { } export namespace GetGroupsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetGroupsRequest): any => ({ ...obj, }); @@ -871,6 +967,9 @@ export interface GroupSummary { } export namespace GroupSummary { + /** + * @internal + */ export const filterSensitiveLog = (obj: GroupSummary): any => ({ ...obj, }); @@ -889,6 +988,9 @@ export interface GetGroupsResult { } export namespace GetGroupsResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetGroupsResult): any => ({ ...obj, }); @@ -902,6 +1004,9 @@ export interface GetInsightRequest { } export namespace GetInsightRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetInsightRequest): any => ({ ...obj, }); @@ -932,6 +1037,9 @@ export interface RequestImpactStatistics { } export namespace RequestImpactStatistics { + /** + * @internal + */ export const filterSensitiveLog = (obj: RequestImpactStatistics): any => ({ ...obj, }); @@ -1011,6 +1119,9 @@ export interface Insight { } export namespace Insight { + /** + * @internal + */ export const filterSensitiveLog = (obj: Insight): any => ({ ...obj, }); @@ -1024,6 +1135,9 @@ export interface GetInsightResult { } export namespace GetInsightResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetInsightResult): any => ({ ...obj, }); @@ -1047,6 +1161,9 @@ export interface GetInsightEventsRequest { } export namespace GetInsightEventsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetInsightEventsRequest): any => ({ ...obj, }); @@ -1086,6 +1203,9 @@ export interface InsightEvent { } export namespace InsightEvent { + /** + * @internal + */ export const filterSensitiveLog = (obj: InsightEvent): any => ({ ...obj, }); @@ -1106,6 +1226,9 @@ export interface GetInsightEventsResult { } export namespace GetInsightEventsResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetInsightEventsResult): any => ({ ...obj, }); @@ -1136,6 +1259,9 @@ export interface GetInsightImpactGraphRequest { } export namespace GetInsightImpactGraphRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetInsightImpactGraphRequest): any => ({ ...obj, }); @@ -1152,6 +1278,9 @@ export interface InsightImpactGraphEdge { } export namespace InsightImpactGraphEdge { + /** + * @internal + */ export const filterSensitiveLog = (obj: InsightImpactGraphEdge): any => ({ ...obj, }); @@ -1211,6 +1340,9 @@ export interface InsightImpactGraphService { } export namespace InsightImpactGraphService { + /** + * @internal + */ export const filterSensitiveLog = (obj: InsightImpactGraphService): any => ({ ...obj, }); @@ -1254,6 +1386,9 @@ export interface GetInsightImpactGraphResult { } export namespace GetInsightImpactGraphResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetInsightImpactGraphResult): any => ({ ...obj, }); @@ -1298,6 +1433,9 @@ export interface GetInsightSummariesRequest { } export namespace GetInsightSummariesRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetInsightSummariesRequest): any => ({ ...obj, }); @@ -1376,6 +1514,9 @@ export interface InsightSummary { } export namespace InsightSummary { + /** + * @internal + */ export const filterSensitiveLog = (obj: InsightSummary): any => ({ ...obj, }); @@ -1396,6 +1537,9 @@ export interface GetInsightSummariesResult { } export namespace GetInsightSummariesResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetInsightSummariesResult): any => ({ ...obj, }); @@ -1409,6 +1553,9 @@ export interface GetSamplingRulesRequest { } export namespace GetSamplingRulesRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetSamplingRulesRequest): any => ({ ...obj, }); @@ -1427,6 +1574,9 @@ export interface GetSamplingRulesResult { } export namespace GetSamplingRulesResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetSamplingRulesResult): any => ({ ...obj, }); @@ -1440,6 +1590,9 @@ export interface GetSamplingStatisticSummariesRequest { } export namespace GetSamplingStatisticSummariesRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetSamplingStatisticSummariesRequest): any => ({ ...obj, }); @@ -1476,6 +1629,9 @@ export interface SamplingStatisticSummary { } export namespace SamplingStatisticSummary { + /** + * @internal + */ export const filterSensitiveLog = (obj: SamplingStatisticSummary): any => ({ ...obj, }); @@ -1495,6 +1651,9 @@ export interface GetSamplingStatisticSummariesResult { } export namespace GetSamplingStatisticSummariesResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetSamplingStatisticSummariesResult): any => ({ ...obj, }); @@ -1538,6 +1697,9 @@ export interface SamplingStatisticsDocument { } export namespace SamplingStatisticsDocument { + /** + * @internal + */ export const filterSensitiveLog = (obj: SamplingStatisticsDocument): any => ({ ...obj, }); @@ -1551,6 +1713,9 @@ export interface GetSamplingTargetsRequest { } export namespace GetSamplingTargetsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetSamplingTargetsRequest): any => ({ ...obj, }); @@ -1590,6 +1755,9 @@ export interface SamplingTargetDocument { } export namespace SamplingTargetDocument { + /** + * @internal + */ export const filterSensitiveLog = (obj: SamplingTargetDocument): any => ({ ...obj, }); @@ -1617,6 +1785,9 @@ export interface UnprocessedStatistics { } export namespace UnprocessedStatistics { + /** + * @internal + */ export const filterSensitiveLog = (obj: UnprocessedStatistics): any => ({ ...obj, }); @@ -1643,6 +1814,9 @@ export interface GetSamplingTargetsResult { } export namespace GetSamplingTargetsResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetSamplingTargetsResult): any => ({ ...obj, }); @@ -1676,6 +1850,9 @@ export interface GetServiceGraphRequest { } export namespace GetServiceGraphRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetServiceGraphRequest): any => ({ ...obj, }); @@ -1698,6 +1875,9 @@ export interface HistogramEntry { } export namespace HistogramEntry { + /** + * @internal + */ export const filterSensitiveLog = (obj: HistogramEntry): any => ({ ...obj, }); @@ -1725,6 +1905,9 @@ export interface ErrorStatistics { } export namespace ErrorStatistics { + /** + * @internal + */ export const filterSensitiveLog = (obj: ErrorStatistics): any => ({ ...obj, }); @@ -1747,6 +1930,9 @@ export interface FaultStatistics { } export namespace FaultStatistics { + /** + * @internal + */ export const filterSensitiveLog = (obj: FaultStatistics): any => ({ ...obj, }); @@ -1783,6 +1969,9 @@ export interface EdgeStatistics { } export namespace EdgeStatistics { + /** + * @internal + */ export const filterSensitiveLog = (obj: EdgeStatistics): any => ({ ...obj, }); @@ -1824,6 +2013,9 @@ export interface Edge { } export namespace Edge { + /** + * @internal + */ export const filterSensitiveLog = (obj: Edge): any => ({ ...obj, }); @@ -1860,6 +2052,9 @@ export interface ServiceStatistics { } export namespace ServiceStatistics { + /** + * @internal + */ export const filterSensitiveLog = (obj: ServiceStatistics): any => ({ ...obj, }); @@ -1957,6 +2152,9 @@ export interface Service { } export namespace Service { + /** + * @internal + */ export const filterSensitiveLog = (obj: Service): any => ({ ...obj, }); @@ -1993,6 +2191,9 @@ export interface GetServiceGraphResult { } export namespace GetServiceGraphResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetServiceGraphResult): any => ({ ...obj, }); @@ -2044,6 +2245,9 @@ export interface GetTimeSeriesServiceStatisticsRequest { } export namespace GetTimeSeriesServiceStatisticsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetTimeSeriesServiceStatisticsRequest): any => ({ ...obj, }); @@ -2066,6 +2270,9 @@ export interface ForecastStatistics { } export namespace ForecastStatistics { + /** + * @internal + */ export const filterSensitiveLog = (obj: ForecastStatistics): any => ({ ...obj, }); @@ -2102,6 +2309,9 @@ export interface TimeSeriesServiceStatistics { } export namespace TimeSeriesServiceStatistics { + /** + * @internal + */ export const filterSensitiveLog = (obj: TimeSeriesServiceStatistics): any => ({ ...obj, }); @@ -2126,6 +2336,9 @@ export interface GetTimeSeriesServiceStatisticsResult { } export namespace GetTimeSeriesServiceStatisticsResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetTimeSeriesServiceStatisticsResult): any => ({ ...obj, }); @@ -2144,6 +2357,9 @@ export interface GetTraceGraphRequest { } export namespace GetTraceGraphRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetTraceGraphRequest): any => ({ ...obj, }); @@ -2162,6 +2378,9 @@ export interface GetTraceGraphResult { } export namespace GetTraceGraphResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetTraceGraphResult): any => ({ ...obj, }); @@ -2188,6 +2407,9 @@ export interface SamplingStrategy { } export namespace SamplingStrategy { + /** + * @internal + */ export const filterSensitiveLog = (obj: SamplingStrategy): any => ({ ...obj, }); @@ -2240,6 +2462,9 @@ export interface GetTraceSummariesRequest { } export namespace GetTraceSummariesRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetTraceSummariesRequest): any => ({ ...obj, }); @@ -2261,6 +2486,9 @@ export interface RootCauseException { } export namespace RootCauseException { + /** + * @internal + */ export const filterSensitiveLog = (obj: RootCauseException): any => ({ ...obj, }); @@ -2288,6 +2516,9 @@ export interface ErrorRootCauseEntity { } export namespace ErrorRootCauseEntity { + /** + * @internal + */ export const filterSensitiveLog = (obj: ErrorRootCauseEntity): any => ({ ...obj, }); @@ -2329,6 +2560,9 @@ export interface ErrorRootCauseService { } export namespace ErrorRootCauseService { + /** + * @internal + */ export const filterSensitiveLog = (obj: ErrorRootCauseService): any => ({ ...obj, }); @@ -2351,6 +2585,9 @@ export interface ErrorRootCause { } export namespace ErrorRootCause { + /** + * @internal + */ export const filterSensitiveLog = (obj: ErrorRootCause): any => ({ ...obj, }); @@ -2378,6 +2615,9 @@ export interface FaultRootCauseEntity { } export namespace FaultRootCauseEntity { + /** + * @internal + */ export const filterSensitiveLog = (obj: FaultRootCauseEntity): any => ({ ...obj, }); @@ -2419,6 +2659,9 @@ export interface FaultRootCauseService { } export namespace FaultRootCauseService { + /** + * @internal + */ export const filterSensitiveLog = (obj: FaultRootCauseService): any => ({ ...obj, }); @@ -2441,6 +2684,9 @@ export interface FaultRootCause { } export namespace FaultRootCause { + /** + * @internal + */ export const filterSensitiveLog = (obj: FaultRootCause): any => ({ ...obj, }); @@ -2477,6 +2723,9 @@ export interface Http { } export namespace Http { + /** + * @internal + */ export const filterSensitiveLog = (obj: Http): any => ({ ...obj, }); @@ -2493,6 +2742,9 @@ export interface InstanceIdDetail { } export namespace InstanceIdDetail { + /** + * @internal + */ export const filterSensitiveLog = (obj: InstanceIdDetail): any => ({ ...obj, }); @@ -2509,6 +2761,9 @@ export interface ResourceARNDetail { } export namespace ResourceARNDetail { + /** + * @internal + */ export const filterSensitiveLog = (obj: ResourceARNDetail): any => ({ ...obj, }); @@ -2536,6 +2791,9 @@ export interface ResponseTimeRootCauseEntity { } export namespace ResponseTimeRootCauseEntity { + /** + * @internal + */ export const filterSensitiveLog = (obj: ResponseTimeRootCauseEntity): any => ({ ...obj, }); @@ -2577,6 +2835,9 @@ export interface ResponseTimeRootCauseService { } export namespace ResponseTimeRootCauseService { + /** + * @internal + */ export const filterSensitiveLog = (obj: ResponseTimeRootCauseService): any => ({ ...obj, }); @@ -2599,6 +2860,9 @@ export interface ResponseTimeRootCause { } export namespace ResponseTimeRootCause { + /** + * @internal + */ export const filterSensitiveLog = (obj: ResponseTimeRootCause): any => ({ ...obj, }); @@ -2620,6 +2884,9 @@ export interface TraceUser { } export namespace TraceUser { + /** + * @internal + */ export const filterSensitiveLog = (obj: TraceUser): any => ({ ...obj, }); @@ -2739,6 +3006,9 @@ export interface TraceSummary { } export namespace TraceSummary { + /** + * @internal + */ export const filterSensitiveLog = (obj: TraceSummary): any => ({ ...obj, ...(obj.Annotations && { @@ -2779,6 +3049,9 @@ export interface GetTraceSummariesResult { } export namespace GetTraceSummariesResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: GetTraceSummariesResult): any => ({ ...obj, }); @@ -2798,6 +3071,9 @@ export interface ListTagsForResourceRequest { } export namespace ListTagsForResourceRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListTagsForResourceRequest): any => ({ ...obj, }); @@ -2817,6 +3093,9 @@ export interface ListTagsForResourceResponse { } export namespace ListTagsForResourceResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: ListTagsForResourceResponse): any => ({ ...obj, }); @@ -2834,6 +3113,9 @@ export interface ResourceNotFoundException extends __SmithyException, $MetadataB } export namespace ResourceNotFoundException { + /** + * @internal + */ export const filterSensitiveLog = (obj: ResourceNotFoundException): any => ({ ...obj, }); @@ -2873,6 +3155,9 @@ export interface PutEncryptionConfigRequest { } export namespace PutEncryptionConfigRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: PutEncryptionConfigRequest): any => ({ ...obj, }); @@ -2886,6 +3171,9 @@ export interface PutEncryptionConfigResult { } export namespace PutEncryptionConfigResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: PutEncryptionConfigResult): any => ({ ...obj, }); @@ -2927,6 +3215,9 @@ export interface BackendConnectionErrors { } export namespace BackendConnectionErrors { + /** + * @internal + */ export const filterSensitiveLog = (obj: BackendConnectionErrors): any => ({ ...obj, }); @@ -2968,6 +3259,9 @@ export interface TelemetryRecord { } export namespace TelemetryRecord { + /** + * @internal + */ export const filterSensitiveLog = (obj: TelemetryRecord): any => ({ ...obj, }); @@ -2996,6 +3290,9 @@ export interface PutTelemetryRecordsRequest { } export namespace PutTelemetryRecordsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: PutTelemetryRecordsRequest): any => ({ ...obj, }); @@ -3004,6 +3301,9 @@ export namespace PutTelemetryRecordsRequest { export interface PutTelemetryRecordsResult {} export namespace PutTelemetryRecordsResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: PutTelemetryRecordsResult): any => ({ ...obj, }); @@ -3018,6 +3318,9 @@ export interface PutTraceSegmentsRequest { } export namespace PutTraceSegmentsRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: PutTraceSegmentsRequest): any => ({ ...obj, }); @@ -3044,6 +3347,9 @@ export interface UnprocessedTraceSegment { } export namespace UnprocessedTraceSegment { + /** + * @internal + */ export const filterSensitiveLog = (obj: UnprocessedTraceSegment): any => ({ ...obj, }); @@ -3057,6 +3363,9 @@ export interface PutTraceSegmentsResult { } export namespace PutTraceSegmentsResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: PutTraceSegmentsResult): any => ({ ...obj, }); @@ -3100,6 +3409,9 @@ export interface TagResourceRequest { } export namespace TagResourceRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: TagResourceRequest): any => ({ ...obj, }); @@ -3108,6 +3420,9 @@ export namespace TagResourceRequest { export interface TagResourceResponse {} export namespace TagResourceResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: TagResourceResponse): any => ({ ...obj, }); @@ -3124,6 +3439,9 @@ export interface TooManyTagsException extends __SmithyException, $MetadataBearer } export namespace TooManyTagsException { + /** + * @internal + */ export const filterSensitiveLog = (obj: TooManyTagsException): any => ({ ...obj, }); @@ -3142,6 +3460,9 @@ export interface UntagResourceRequest { } export namespace UntagResourceRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: UntagResourceRequest): any => ({ ...obj, }); @@ -3150,6 +3471,9 @@ export namespace UntagResourceRequest { export interface UntagResourceResponse {} export namespace UntagResourceResponse { + /** + * @internal + */ export const filterSensitiveLog = (obj: UntagResourceResponse): any => ({ ...obj, }); @@ -3188,6 +3512,9 @@ export interface UpdateGroupRequest { } export namespace UpdateGroupRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateGroupRequest): any => ({ ...obj, }); @@ -3203,6 +3530,9 @@ export interface UpdateGroupResult { } export namespace UpdateGroupResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateGroupResult): any => ({ ...obj, }); @@ -3276,6 +3606,9 @@ export interface SamplingRuleUpdate { } export namespace SamplingRuleUpdate { + /** + * @internal + */ export const filterSensitiveLog = (obj: SamplingRuleUpdate): any => ({ ...obj, }); @@ -3289,6 +3622,9 @@ export interface UpdateSamplingRuleRequest { } export namespace UpdateSamplingRuleRequest { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateSamplingRuleRequest): any => ({ ...obj, }); @@ -3302,6 +3638,9 @@ export interface UpdateSamplingRuleResult { } export namespace UpdateSamplingRuleResult { + /** + * @internal + */ export const filterSensitiveLog = (obj: UpdateSamplingRuleResult): any => ({ ...obj, }); diff --git a/protocol_tests/aws-ec2/commands/EmptyInputAndEmptyOutputCommand.ts b/protocol_tests/aws-ec2/commands/EmptyInputAndEmptyOutputCommand.ts index 33142e4732b4..02bceef6ad7e 100644 --- a/protocol_tests/aws-ec2/commands/EmptyInputAndEmptyOutputCommand.ts +++ b/protocol_tests/aws-ec2/commands/EmptyInputAndEmptyOutputCommand.ts @@ -25,6 +25,20 @@ export interface EmptyInputAndEmptyOutputCommandOutput extends EmptyInputAndEmpt * no request or response members. * * While this should be rare, code generators must support this. + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { EC2ProtocolClient, EmptyInputAndEmptyOutputCommand } from "@aws-sdk/aws-ec2"; // ES Modules import + * // const { EC2ProtocolClient, EmptyInputAndEmptyOutputCommand } = require("@aws-sdk/aws-ec2"); // CommonJS import + * const client = new EC2ProtocolClient(config); + * const command = new EmptyInputAndEmptyOutputCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link EmptyInputAndEmptyOutputCommandInput} for command's `input` shape. + * @see {@link EmptyInputAndEmptyOutputCommandOutput} for command's `response` shape. + * @see {@link EC2ProtocolClientResolvedConfig | config} for command's `input` shape. + * */ export class EmptyInputAndEmptyOutputCommand extends $Command< EmptyInputAndEmptyOutputCommandInput, diff --git a/protocol_tests/aws-ec2/commands/GreetingWithErrorsCommand.ts b/protocol_tests/aws-ec2/commands/GreetingWithErrorsCommand.ts index e43304e312e4..bd3281ead0c3 100644 --- a/protocol_tests/aws-ec2/commands/GreetingWithErrorsCommand.ts +++ b/protocol_tests/aws-ec2/commands/GreetingWithErrorsCommand.ts @@ -26,6 +26,20 @@ export interface GreetingWithErrorsCommandOutput extends GreetingWithErrorsOutpu * 1. A successful response in the form of GreetingWithErrorsOutput * 2. An InvalidGreeting error. * 3. A BadRequest error. + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { EC2ProtocolClient, GreetingWithErrorsCommand } from "@aws-sdk/aws-ec2"; // ES Modules import + * // const { EC2ProtocolClient, GreetingWithErrorsCommand } = require("@aws-sdk/aws-ec2"); // CommonJS import + * const client = new EC2ProtocolClient(config); + * const command = new GreetingWithErrorsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GreetingWithErrorsCommandInput} for command's `input` shape. + * @see {@link GreetingWithErrorsCommandOutput} for command's `response` shape. + * @see {@link EC2ProtocolClientResolvedConfig | config} for command's `input` shape. + * */ export class GreetingWithErrorsCommand extends $Command< GreetingWithErrorsCommandInput, diff --git a/protocol_tests/aws-ec2/commands/IgnoresWrappingXmlNameCommand.ts b/protocol_tests/aws-ec2/commands/IgnoresWrappingXmlNameCommand.ts index 79b300023934..2785d6d304e2 100644 --- a/protocol_tests/aws-ec2/commands/IgnoresWrappingXmlNameCommand.ts +++ b/protocol_tests/aws-ec2/commands/IgnoresWrappingXmlNameCommand.ts @@ -24,6 +24,20 @@ export interface IgnoresWrappingXmlNameCommandOutput extends IgnoresWrappingXmlN * The xmlName trait on the output structure is ignored in AWS Query. * * The wrapping element is always operation name + "Response". + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { EC2ProtocolClient, IgnoresWrappingXmlNameCommand } from "@aws-sdk/aws-ec2"; // ES Modules import + * // const { EC2ProtocolClient, IgnoresWrappingXmlNameCommand } = require("@aws-sdk/aws-ec2"); // CommonJS import + * const client = new EC2ProtocolClient(config); + * const command = new IgnoresWrappingXmlNameCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link IgnoresWrappingXmlNameCommandInput} for command's `input` shape. + * @see {@link IgnoresWrappingXmlNameCommandOutput} for command's `response` shape. + * @see {@link EC2ProtocolClientResolvedConfig | config} for command's `input` shape. + * */ export class IgnoresWrappingXmlNameCommand extends $Command< IgnoresWrappingXmlNameCommandInput, diff --git a/protocol_tests/aws-ec2/commands/NestedStructuresCommand.ts b/protocol_tests/aws-ec2/commands/NestedStructuresCommand.ts index b7328c5de974..2d0bb981b782 100644 --- a/protocol_tests/aws-ec2/commands/NestedStructuresCommand.ts +++ b/protocol_tests/aws-ec2/commands/NestedStructuresCommand.ts @@ -22,6 +22,20 @@ export interface NestedStructuresCommandOutput extends __MetadataBearer {} /** * This test serializes nested and recursive structure members. + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { EC2ProtocolClient, NestedStructuresCommand } from "@aws-sdk/aws-ec2"; // ES Modules import + * // const { EC2ProtocolClient, NestedStructuresCommand } = require("@aws-sdk/aws-ec2"); // CommonJS import + * const client = new EC2ProtocolClient(config); + * const command = new NestedStructuresCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link NestedStructuresCommandInput} for command's `input` shape. + * @see {@link NestedStructuresCommandOutput} for command's `response` shape. + * @see {@link EC2ProtocolClientResolvedConfig | config} for command's `input` shape. + * */ export class NestedStructuresCommand extends $Command< NestedStructuresCommandInput, diff --git a/protocol_tests/aws-ec2/commands/NoInputAndOutputCommand.ts b/protocol_tests/aws-ec2/commands/NoInputAndOutputCommand.ts index f2d39a104a24..30de738e062a 100644 --- a/protocol_tests/aws-ec2/commands/NoInputAndOutputCommand.ts +++ b/protocol_tests/aws-ec2/commands/NoInputAndOutputCommand.ts @@ -25,6 +25,20 @@ export interface NoInputAndOutputCommandOutput extends NoInputAndOutputOutput, _ * no request payload or response members. * * While this should be rare, code generators must support this. + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { EC2ProtocolClient, NoInputAndOutputCommand } from "@aws-sdk/aws-ec2"; // ES Modules import + * // const { EC2ProtocolClient, NoInputAndOutputCommand } = require("@aws-sdk/aws-ec2"); // CommonJS import + * const client = new EC2ProtocolClient(config); + * const command = new NoInputAndOutputCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link NoInputAndOutputCommandInput} for command's `input` shape. + * @see {@link NoInputAndOutputCommandOutput} for command's `response` shape. + * @see {@link EC2ProtocolClientResolvedConfig | config} for command's `input` shape. + * */ export class NoInputAndOutputCommand extends $Command< NoInputAndOutputCommandInput, diff --git a/protocol_tests/aws-ec2/commands/QueryIdempotencyTokenAutoFillCommand.ts b/protocol_tests/aws-ec2/commands/QueryIdempotencyTokenAutoFillCommand.ts index aefb133113c8..aac48e3a7150 100644 --- a/protocol_tests/aws-ec2/commands/QueryIdempotencyTokenAutoFillCommand.ts +++ b/protocol_tests/aws-ec2/commands/QueryIdempotencyTokenAutoFillCommand.ts @@ -22,6 +22,20 @@ export interface QueryIdempotencyTokenAutoFillCommandOutput extends __MetadataBe /** * Automatically adds idempotency tokens. + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { EC2ProtocolClient, QueryIdempotencyTokenAutoFillCommand } from "@aws-sdk/aws-ec2"; // ES Modules import + * // const { EC2ProtocolClient, QueryIdempotencyTokenAutoFillCommand } = require("@aws-sdk/aws-ec2"); // CommonJS import + * const client = new EC2ProtocolClient(config); + * const command = new QueryIdempotencyTokenAutoFillCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link QueryIdempotencyTokenAutoFillCommandInput} for command's `input` shape. + * @see {@link QueryIdempotencyTokenAutoFillCommandOutput} for command's `response` shape. + * @see {@link EC2ProtocolClientResolvedConfig | config} for command's `input` shape. + * */ export class QueryIdempotencyTokenAutoFillCommand extends $Command< QueryIdempotencyTokenAutoFillCommandInput, diff --git a/protocol_tests/aws-ec2/commands/QueryListsCommand.ts b/protocol_tests/aws-ec2/commands/QueryListsCommand.ts index 31822a899d4f..478faa67e5ed 100644 --- a/protocol_tests/aws-ec2/commands/QueryListsCommand.ts +++ b/protocol_tests/aws-ec2/commands/QueryListsCommand.ts @@ -19,6 +19,20 @@ export interface QueryListsCommandOutput extends __MetadataBearer {} /** * This test serializes simple and complex lists. + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { EC2ProtocolClient, QueryListsCommand } from "@aws-sdk/aws-ec2"; // ES Modules import + * // const { EC2ProtocolClient, QueryListsCommand } = require("@aws-sdk/aws-ec2"); // CommonJS import + * const client = new EC2ProtocolClient(config); + * const command = new QueryListsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link QueryListsCommandInput} for command's `input` shape. + * @see {@link QueryListsCommandOutput} for command's `response` shape. + * @see {@link EC2ProtocolClientResolvedConfig | config} for command's `input` shape. + * */ export class QueryListsCommand extends $Command< QueryListsCommandInput, diff --git a/protocol_tests/aws-ec2/commands/QueryTimestampsCommand.ts b/protocol_tests/aws-ec2/commands/QueryTimestampsCommand.ts index f7daec835204..02cb937af933 100644 --- a/protocol_tests/aws-ec2/commands/QueryTimestampsCommand.ts +++ b/protocol_tests/aws-ec2/commands/QueryTimestampsCommand.ts @@ -23,6 +23,20 @@ export interface QueryTimestampsCommandOutput extends __MetadataBearer {} * 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. + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { EC2ProtocolClient, QueryTimestampsCommand } from "@aws-sdk/aws-ec2"; // ES Modules import + * // const { EC2ProtocolClient, QueryTimestampsCommand } = require("@aws-sdk/aws-ec2"); // CommonJS import + * const client = new EC2ProtocolClient(config); + * const command = new QueryTimestampsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link QueryTimestampsCommandInput} for command's `input` shape. + * @see {@link QueryTimestampsCommandOutput} for command's `response` shape. + * @see {@link EC2ProtocolClientResolvedConfig | config} for command's `input` shape. + * */ export class QueryTimestampsCommand extends $Command< QueryTimestampsCommandInput, diff --git a/protocol_tests/aws-ec2/commands/RecursiveXmlShapesCommand.ts b/protocol_tests/aws-ec2/commands/RecursiveXmlShapesCommand.ts index c7d82fb03d59..a0b77cb28ebc 100644 --- a/protocol_tests/aws-ec2/commands/RecursiveXmlShapesCommand.ts +++ b/protocol_tests/aws-ec2/commands/RecursiveXmlShapesCommand.ts @@ -22,6 +22,20 @@ export interface RecursiveXmlShapesCommandOutput extends RecursiveXmlShapesOutpu /** * Recursive shapes + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { EC2ProtocolClient, RecursiveXmlShapesCommand } from "@aws-sdk/aws-ec2"; // ES Modules import + * // const { EC2ProtocolClient, RecursiveXmlShapesCommand } = require("@aws-sdk/aws-ec2"); // CommonJS import + * const client = new EC2ProtocolClient(config); + * const command = new RecursiveXmlShapesCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link RecursiveXmlShapesCommandInput} for command's `input` shape. + * @see {@link RecursiveXmlShapesCommandOutput} for command's `response` shape. + * @see {@link EC2ProtocolClientResolvedConfig | config} for command's `input` shape. + * */ export class RecursiveXmlShapesCommand extends $Command< RecursiveXmlShapesCommandInput, diff --git a/protocol_tests/aws-ec2/commands/SimpleInputParamsCommand.ts b/protocol_tests/aws-ec2/commands/SimpleInputParamsCommand.ts index 1cff24e36d81..38ea9ad9a1a9 100644 --- a/protocol_tests/aws-ec2/commands/SimpleInputParamsCommand.ts +++ b/protocol_tests/aws-ec2/commands/SimpleInputParamsCommand.ts @@ -22,6 +22,20 @@ export interface SimpleInputParamsCommandOutput extends __MetadataBearer {} /** * This test serializes strings, numbers, and boolean values. + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { EC2ProtocolClient, SimpleInputParamsCommand } from "@aws-sdk/aws-ec2"; // ES Modules import + * // const { EC2ProtocolClient, SimpleInputParamsCommand } = require("@aws-sdk/aws-ec2"); // CommonJS import + * const client = new EC2ProtocolClient(config); + * const command = new SimpleInputParamsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link SimpleInputParamsCommandInput} for command's `input` shape. + * @see {@link SimpleInputParamsCommandOutput} for command's `response` shape. + * @see {@link EC2ProtocolClientResolvedConfig | config} for command's `input` shape. + * */ export class SimpleInputParamsCommand extends $Command< SimpleInputParamsCommandInput, diff --git a/protocol_tests/aws-ec2/commands/XmlBlobsCommand.ts b/protocol_tests/aws-ec2/commands/XmlBlobsCommand.ts index 90e6e9077334..619a8f919e3e 100644 --- a/protocol_tests/aws-ec2/commands/XmlBlobsCommand.ts +++ b/protocol_tests/aws-ec2/commands/XmlBlobsCommand.ts @@ -19,6 +19,20 @@ export interface XmlBlobsCommandOutput extends XmlBlobsOutput, __MetadataBearer /** * Blobs are base64 encoded + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { EC2ProtocolClient, XmlBlobsCommand } from "@aws-sdk/aws-ec2"; // ES Modules import + * // const { EC2ProtocolClient, XmlBlobsCommand } = require("@aws-sdk/aws-ec2"); // CommonJS import + * const client = new EC2ProtocolClient(config); + * const command = new XmlBlobsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link XmlBlobsCommandInput} for command's `input` shape. + * @see {@link XmlBlobsCommandOutput} for command's `response` shape. + * @see {@link EC2ProtocolClientResolvedConfig | config} for command's `input` shape. + * */ export class XmlBlobsCommand extends $Command< XmlBlobsCommandInput, diff --git a/protocol_tests/aws-ec2/commands/XmlEnumsCommand.ts b/protocol_tests/aws-ec2/commands/XmlEnumsCommand.ts index b95a3059e5d0..09533be890f4 100644 --- a/protocol_tests/aws-ec2/commands/XmlEnumsCommand.ts +++ b/protocol_tests/aws-ec2/commands/XmlEnumsCommand.ts @@ -19,6 +19,20 @@ export interface XmlEnumsCommandOutput extends XmlEnumsOutput, __MetadataBearer /** * This example serializes enums as top level properties, in lists, sets, and maps. + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { EC2ProtocolClient, XmlEnumsCommand } from "@aws-sdk/aws-ec2"; // ES Modules import + * // const { EC2ProtocolClient, XmlEnumsCommand } = require("@aws-sdk/aws-ec2"); // CommonJS import + * const client = new EC2ProtocolClient(config); + * const command = new XmlEnumsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link XmlEnumsCommandInput} for command's `input` shape. + * @see {@link XmlEnumsCommandOutput} for command's `response` shape. + * @see {@link EC2ProtocolClientResolvedConfig | config} for command's `input` shape. + * */ export class XmlEnumsCommand extends $Command< XmlEnumsCommandInput, diff --git a/protocol_tests/aws-ec2/commands/XmlListsCommand.ts b/protocol_tests/aws-ec2/commands/XmlListsCommand.ts index 3e81f852e181..80bc3817b4ad 100644 --- a/protocol_tests/aws-ec2/commands/XmlListsCommand.ts +++ b/protocol_tests/aws-ec2/commands/XmlListsCommand.ts @@ -29,6 +29,20 @@ export interface XmlListsCommandOutput extends XmlListsOutput, __MetadataBearer * 6. Flattened XML lists with @xmlName. * 7. Flattened XML lists with @xmlNamespace. * 8. Lists of structures. + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { EC2ProtocolClient, XmlListsCommand } from "@aws-sdk/aws-ec2"; // ES Modules import + * // const { EC2ProtocolClient, XmlListsCommand } = require("@aws-sdk/aws-ec2"); // CommonJS import + * const client = new EC2ProtocolClient(config); + * const command = new XmlListsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link XmlListsCommandInput} for command's `input` shape. + * @see {@link XmlListsCommandOutput} for command's `response` shape. + * @see {@link EC2ProtocolClientResolvedConfig | config} for command's `input` shape. + * */ export class XmlListsCommand extends $Command< XmlListsCommandInput, diff --git a/protocol_tests/aws-ec2/commands/XmlTimestampsCommand.ts b/protocol_tests/aws-ec2/commands/XmlTimestampsCommand.ts index 0caefe8a2cf3..cb0a6e3a8bce 100644 --- a/protocol_tests/aws-ec2/commands/XmlTimestampsCommand.ts +++ b/protocol_tests/aws-ec2/commands/XmlTimestampsCommand.ts @@ -21,6 +21,20 @@ export interface XmlTimestampsCommandOutput extends XmlTimestampsOutput, __Metad * This tests how timestamps are serialized, including using the * default format of date-time and various @timestampFormat trait * values. + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { EC2ProtocolClient, XmlTimestampsCommand } from "@aws-sdk/aws-ec2"; // ES Modules import + * // const { EC2ProtocolClient, XmlTimestampsCommand } = require("@aws-sdk/aws-ec2"); // CommonJS import + * const client = new EC2ProtocolClient(config); + * const command = new XmlTimestampsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link XmlTimestampsCommandInput} for command's `input` shape. + * @see {@link XmlTimestampsCommandOutput} for command's `response` shape. + * @see {@link EC2ProtocolClientResolvedConfig | config} for command's `input` shape. + * */ export class XmlTimestampsCommand extends $Command< XmlTimestampsCommandInput, diff --git a/protocol_tests/aws-ec2/models/models_0.ts b/protocol_tests/aws-ec2/models/models_0.ts index 7669b67a9eba..e930272d482a 100644 --- a/protocol_tests/aws-ec2/models/models_0.ts +++ b/protocol_tests/aws-ec2/models/models_0.ts @@ -4,6 +4,9 @@ import { MetadataBearer as $MetadataBearer } from "@aws-sdk/types"; export interface EmptyInputAndEmptyOutputInput {} export namespace EmptyInputAndEmptyOutputInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: EmptyInputAndEmptyOutputInput): any => ({ ...obj, }); @@ -12,6 +15,9 @@ export namespace EmptyInputAndEmptyOutputInput { export interface EmptyInputAndEmptyOutputOutput {} export namespace EmptyInputAndEmptyOutputOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: EmptyInputAndEmptyOutputOutput): any => ({ ...obj, }); @@ -22,6 +28,9 @@ export interface HostLabelInput { } export namespace HostLabelInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: HostLabelInput): any => ({ ...obj, }); @@ -32,6 +41,9 @@ export interface ComplexNestedErrorData { } export namespace ComplexNestedErrorData { + /** + * @internal + */ export const filterSensitiveLog = (obj: ComplexNestedErrorData): any => ({ ...obj, }); @@ -48,6 +60,9 @@ export interface ComplexError extends __SmithyException, $MetadataBearer { } export namespace ComplexError { + /** + * @internal + */ export const filterSensitiveLog = (obj: ComplexError): any => ({ ...obj, }); @@ -58,6 +73,9 @@ export interface GreetingWithErrorsOutput { } export namespace GreetingWithErrorsOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: GreetingWithErrorsOutput): any => ({ ...obj, }); @@ -73,6 +91,9 @@ export interface InvalidGreeting extends __SmithyException, $MetadataBearer { } export namespace InvalidGreeting { + /** + * @internal + */ export const filterSensitiveLog = (obj: InvalidGreeting): any => ({ ...obj, }); @@ -83,6 +104,9 @@ export interface IgnoresWrappingXmlNameOutput { } export namespace IgnoresWrappingXmlNameOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: IgnoresWrappingXmlNameOutput): any => ({ ...obj, }); @@ -91,6 +115,9 @@ export namespace IgnoresWrappingXmlNameOutput { export interface NoInputAndOutputOutput {} export namespace NoInputAndOutputOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: NoInputAndOutputOutput): any => ({ ...obj, }); @@ -101,6 +128,9 @@ export interface QueryIdempotencyTokenAutoFillInput { } export namespace QueryIdempotencyTokenAutoFillInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: QueryIdempotencyTokenAutoFillInput): any => ({ ...obj, }); @@ -111,6 +141,9 @@ export interface GreetingStruct { } export namespace GreetingStruct { + /** + * @internal + */ export const filterSensitiveLog = (obj: GreetingStruct): any => ({ ...obj, }); @@ -124,6 +157,9 @@ export interface QueryListsInput { } export namespace QueryListsInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: QueryListsInput): any => ({ ...obj, }); @@ -136,6 +172,9 @@ export interface QueryTimestampsInput { } export namespace QueryTimestampsInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: QueryTimestampsInput): any => ({ ...obj, }); @@ -163,6 +202,9 @@ export interface SimpleInputParamsInput { } export namespace SimpleInputParamsInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: SimpleInputParamsInput): any => ({ ...obj, }); @@ -182,6 +224,9 @@ export interface SimpleScalarXmlPropertiesOutput { } export namespace SimpleScalarXmlPropertiesOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: SimpleScalarXmlPropertiesOutput): any => ({ ...obj, }); @@ -192,6 +237,9 @@ export interface XmlBlobsOutput { } export namespace XmlBlobsOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: XmlBlobsOutput): any => ({ ...obj, }); @@ -203,6 +251,9 @@ export interface StructureListMember { } export namespace StructureListMember { + /** + * @internal + */ export const filterSensitiveLog = (obj: StructureListMember): any => ({ ...obj, }); @@ -229,6 +280,9 @@ export interface XmlListsOutput { } export namespace XmlListsOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: XmlListsOutput): any => ({ ...obj, }); @@ -244,6 +298,9 @@ export interface XmlEnumsOutput { } export namespace XmlEnumsOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: XmlEnumsOutput): any => ({ ...obj, }); @@ -255,6 +312,9 @@ export interface XmlNamespaceNested { } export namespace XmlNamespaceNested { + /** + * @internal + */ export const filterSensitiveLog = (obj: XmlNamespaceNested): any => ({ ...obj, }); @@ -265,6 +325,9 @@ export interface XmlNamespacesOutput { } export namespace XmlNamespacesOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: XmlNamespacesOutput): any => ({ ...obj, }); @@ -278,6 +341,9 @@ export interface XmlTimestampsOutput { } export namespace XmlTimestampsOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: XmlTimestampsOutput): any => ({ ...obj, }); @@ -290,6 +356,9 @@ export interface StructArg { } export namespace StructArg { + /** + * @internal + */ export const filterSensitiveLog = (obj: StructArg): any => ({ ...obj, }); @@ -300,6 +369,9 @@ export interface NestedStructuresInput { } export namespace NestedStructuresInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: NestedStructuresInput): any => ({ ...obj, }); @@ -311,6 +383,9 @@ export interface RecursiveXmlShapesOutputNested1 { } export namespace RecursiveXmlShapesOutputNested1 { + /** + * @internal + */ export const filterSensitiveLog = (obj: RecursiveXmlShapesOutputNested1): any => ({ ...obj, }); @@ -322,6 +397,9 @@ export interface RecursiveXmlShapesOutputNested2 { } export namespace RecursiveXmlShapesOutputNested2 { + /** + * @internal + */ export const filterSensitiveLog = (obj: RecursiveXmlShapesOutputNested2): any => ({ ...obj, }); @@ -332,6 +410,9 @@ export interface RecursiveXmlShapesOutput { } export namespace RecursiveXmlShapesOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: RecursiveXmlShapesOutput): any => ({ ...obj, }); diff --git a/protocol_tests/aws-json/commands/GreetingWithErrorsCommand.ts b/protocol_tests/aws-json/commands/GreetingWithErrorsCommand.ts index 1a8debe41b9e..3fa41818e860 100644 --- a/protocol_tests/aws-json/commands/GreetingWithErrorsCommand.ts +++ b/protocol_tests/aws-json/commands/GreetingWithErrorsCommand.ts @@ -29,6 +29,20 @@ export interface GreetingWithErrorsCommandOutput extends GreetingWithErrorsOutpu * * Implementations must be able to successfully take a response and * properly deserialize successful and error responses. + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { JsonProtocolClient, GreetingWithErrorsCommand } from "@aws-sdk/aws-json"; // ES Modules import + * // const { JsonProtocolClient, GreetingWithErrorsCommand } = require("@aws-sdk/aws-json"); // CommonJS import + * const client = new JsonProtocolClient(config); + * const command = new GreetingWithErrorsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GreetingWithErrorsCommandInput} for command's `input` shape. + * @see {@link GreetingWithErrorsCommandOutput} for command's `response` shape. + * @see {@link JsonProtocolClientResolvedConfig | config} for command's `input` shape. + * */ export class GreetingWithErrorsCommand extends $Command< GreetingWithErrorsCommandInput, diff --git a/protocol_tests/aws-json/commands/JsonEnumsCommand.ts b/protocol_tests/aws-json/commands/JsonEnumsCommand.ts index 13b11e1776c4..d25da3bd36f8 100644 --- a/protocol_tests/aws-json/commands/JsonEnumsCommand.ts +++ b/protocol_tests/aws-json/commands/JsonEnumsCommand.ts @@ -19,6 +19,20 @@ export interface JsonEnumsCommandOutput extends JsonEnumsInputOutput, __Metadata /** * This example serializes enums as top level properties, in lists, sets, and maps. + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { JsonProtocolClient, JsonEnumsCommand } from "@aws-sdk/aws-json"; // ES Modules import + * // const { JsonProtocolClient, JsonEnumsCommand } = require("@aws-sdk/aws-json"); // CommonJS import + * const client = new JsonProtocolClient(config); + * const command = new JsonEnumsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link JsonEnumsCommandInput} for command's `input` shape. + * @see {@link JsonEnumsCommandOutput} for command's `response` shape. + * @see {@link JsonProtocolClientResolvedConfig | config} for command's `input` shape. + * */ export class JsonEnumsCommand extends $Command< JsonEnumsCommandInput, diff --git a/protocol_tests/aws-json/commands/JsonUnionsCommand.ts b/protocol_tests/aws-json/commands/JsonUnionsCommand.ts index 7c509809328e..3f3d85d1af9e 100644 --- a/protocol_tests/aws-json/commands/JsonUnionsCommand.ts +++ b/protocol_tests/aws-json/commands/JsonUnionsCommand.ts @@ -22,6 +22,20 @@ export interface JsonUnionsCommandOutput extends UnionInputOutput, __MetadataBea /** * This operation uses unions for inputs and outputs. + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { JsonProtocolClient, JsonUnionsCommand } from "@aws-sdk/aws-json"; // ES Modules import + * // const { JsonProtocolClient, JsonUnionsCommand } = require("@aws-sdk/aws-json"); // CommonJS import + * const client = new JsonProtocolClient(config); + * const command = new JsonUnionsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link JsonUnionsCommandInput} for command's `input` shape. + * @see {@link JsonUnionsCommandOutput} for command's `response` shape. + * @see {@link JsonProtocolClientResolvedConfig | config} for command's `input` shape. + * */ export class JsonUnionsCommand extends $Command< JsonUnionsCommandInput, diff --git a/protocol_tests/aws-json/commands/PutAndGetInlineDocumentsCommand.ts b/protocol_tests/aws-json/commands/PutAndGetInlineDocumentsCommand.ts index a7ba5a3d5faa..c0c98031a5ec 100644 --- a/protocol_tests/aws-json/commands/PutAndGetInlineDocumentsCommand.ts +++ b/protocol_tests/aws-json/commands/PutAndGetInlineDocumentsCommand.ts @@ -22,6 +22,20 @@ export interface PutAndGetInlineDocumentsCommandOutput extends PutAndGetInlineDo /** * This example serializes an inline document as part of the payload. + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { JsonProtocolClient, PutAndGetInlineDocumentsCommand } from "@aws-sdk/aws-json"; // ES Modules import + * // const { JsonProtocolClient, PutAndGetInlineDocumentsCommand } = require("@aws-sdk/aws-json"); // CommonJS import + * const client = new JsonProtocolClient(config); + * const command = new PutAndGetInlineDocumentsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link PutAndGetInlineDocumentsCommandInput} for command's `input` shape. + * @see {@link PutAndGetInlineDocumentsCommandOutput} for command's `response` shape. + * @see {@link JsonProtocolClientResolvedConfig | config} for command's `input` shape. + * */ export class PutAndGetInlineDocumentsCommand extends $Command< PutAndGetInlineDocumentsCommandInput, diff --git a/protocol_tests/aws-json/models/models_0.ts b/protocol_tests/aws-json/models/models_0.ts index f501abca2528..cc6e32773686 100644 --- a/protocol_tests/aws-json/models/models_0.ts +++ b/protocol_tests/aws-json/models/models_0.ts @@ -10,6 +10,9 @@ export interface ComplexNestedErrorData { } export namespace ComplexNestedErrorData { + /** + * @internal + */ export const filterSensitiveLog = (obj: ComplexNestedErrorData): any => ({ ...obj, }); @@ -26,6 +29,9 @@ export interface ComplexError extends __SmithyException, $MetadataBearer { } export namespace ComplexError { + /** + * @internal + */ export const filterSensitiveLog = (obj: ComplexError): any => ({ ...obj, }); @@ -34,6 +40,9 @@ export namespace ComplexError { export interface EmptyStruct {} export namespace EmptyStruct { + /** + * @internal + */ export const filterSensitiveLog = (obj: EmptyStruct): any => ({ ...obj, }); @@ -44,6 +53,9 @@ export interface HostLabelInput { } export namespace HostLabelInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: HostLabelInput): any => ({ ...obj, }); @@ -54,6 +66,9 @@ export interface SimpleStruct { } export namespace SimpleStruct { + /** + * @internal + */ export const filterSensitiveLog = (obj: SimpleStruct): any => ({ ...obj, }); @@ -64,6 +79,9 @@ export interface StructWithLocationName { } export namespace StructWithLocationName { + /** + * @internal + */ export const filterSensitiveLog = (obj: StructWithLocationName): any => ({ ...obj, }); @@ -75,6 +93,9 @@ export interface ErrorWithoutMembers extends __SmithyException, $MetadataBearer } export namespace ErrorWithoutMembers { + /** + * @internal + */ export const filterSensitiveLog = (obj: ErrorWithoutMembers): any => ({ ...obj, }); @@ -90,6 +111,9 @@ export interface FooError extends __SmithyException, $MetadataBearer { } export namespace FooError { + /** + * @internal + */ export const filterSensitiveLog = (obj: FooError): any => ({ ...obj, }); @@ -100,6 +124,9 @@ export interface GreetingWithErrorsOutput { } export namespace GreetingWithErrorsOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: GreetingWithErrorsOutput): any => ({ ...obj, }); @@ -115,6 +142,9 @@ export interface InvalidGreeting extends __SmithyException, $MetadataBearer { } export namespace InvalidGreeting { + /** + * @internal + */ export const filterSensitiveLog = (obj: InvalidGreeting): any => ({ ...obj, }); @@ -138,6 +168,9 @@ export interface JsonEnumsInputOutput { } export namespace JsonEnumsInputOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: JsonEnumsInputOutput): any => ({ ...obj, }); @@ -148,6 +181,9 @@ export interface GreetingStruct { } export namespace GreetingStruct { + /** + * @internal + */ export const filterSensitiveLog = (obj: GreetingStruct): any => ({ ...obj, }); @@ -325,6 +361,9 @@ export namespace MyUnion { return visitor._(value.$unknown[0], value.$unknown[1]); }; + /** + * @internal + */ export const filterSensitiveLog = (obj: MyUnion): any => { if (obj.stringValue !== undefined) return { stringValue: obj.stringValue }; if (obj.booleanValue !== undefined) return { booleanValue: obj.booleanValue }; @@ -351,6 +390,9 @@ export interface UnionInputOutput { } export namespace UnionInputOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: UnionInputOutput): any => ({ ...obj, ...(obj.contents && { contents: MyUnion.filterSensitiveLog(obj.contents) }), @@ -364,6 +406,9 @@ export interface NullOperationInputOutput { } export namespace NullOperationInputOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: NullOperationInputOutput): any => ({ ...obj, }); @@ -374,6 +419,9 @@ export interface PutAndGetInlineDocumentsInputOutput { } export namespace PutAndGetInlineDocumentsInputOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: PutAndGetInlineDocumentsInputOutput): any => ({ ...obj, }); @@ -409,6 +457,9 @@ export interface KitchenSink { } export namespace KitchenSink { + /** + * @internal + */ export const filterSensitiveLog = (obj: KitchenSink): any => ({ ...obj, }); @@ -430,6 +481,9 @@ export interface ErrorWithMembers extends __SmithyException, $MetadataBearer { } export namespace ErrorWithMembers { + /** + * @internal + */ export const filterSensitiveLog = (obj: ErrorWithMembers): any => ({ ...obj, }); diff --git a/protocol_tests/aws-query/commands/EmptyInputAndEmptyOutputCommand.ts b/protocol_tests/aws-query/commands/EmptyInputAndEmptyOutputCommand.ts index 848cba43c2d0..400622a03ca6 100644 --- a/protocol_tests/aws-query/commands/EmptyInputAndEmptyOutputCommand.ts +++ b/protocol_tests/aws-query/commands/EmptyInputAndEmptyOutputCommand.ts @@ -25,6 +25,20 @@ export interface EmptyInputAndEmptyOutputCommandOutput extends EmptyInputAndEmpt * no request or response members. * * While this should be rare, code generators must support this. + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { QueryProtocolClient, EmptyInputAndEmptyOutputCommand } from "@aws-sdk/aws-query"; // ES Modules import + * // const { QueryProtocolClient, EmptyInputAndEmptyOutputCommand } = require("@aws-sdk/aws-query"); // CommonJS import + * const client = new QueryProtocolClient(config); + * const command = new EmptyInputAndEmptyOutputCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link EmptyInputAndEmptyOutputCommandInput} for command's `input` shape. + * @see {@link EmptyInputAndEmptyOutputCommandOutput} for command's `response` shape. + * @see {@link QueryProtocolClientResolvedConfig | config} for command's `input` shape. + * */ export class EmptyInputAndEmptyOutputCommand extends $Command< EmptyInputAndEmptyOutputCommandInput, diff --git a/protocol_tests/aws-query/commands/FlattenedXmlMapCommand.ts b/protocol_tests/aws-query/commands/FlattenedXmlMapCommand.ts index 5545d29ae65e..6c7c95d3b298 100644 --- a/protocol_tests/aws-query/commands/FlattenedXmlMapCommand.ts +++ b/protocol_tests/aws-query/commands/FlattenedXmlMapCommand.ts @@ -22,6 +22,20 @@ export interface FlattenedXmlMapCommandOutput extends FlattenedXmlMapOutput, __M /** * Flattened maps + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { QueryProtocolClient, FlattenedXmlMapCommand } from "@aws-sdk/aws-query"; // ES Modules import + * // const { QueryProtocolClient, FlattenedXmlMapCommand } = require("@aws-sdk/aws-query"); // CommonJS import + * const client = new QueryProtocolClient(config); + * const command = new FlattenedXmlMapCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link FlattenedXmlMapCommandInput} for command's `input` shape. + * @see {@link FlattenedXmlMapCommandOutput} for command's `response` shape. + * @see {@link QueryProtocolClientResolvedConfig | config} for command's `input` shape. + * */ export class FlattenedXmlMapCommand extends $Command< FlattenedXmlMapCommandInput, diff --git a/protocol_tests/aws-query/commands/FlattenedXmlMapWithXmlNameCommand.ts b/protocol_tests/aws-query/commands/FlattenedXmlMapWithXmlNameCommand.ts index 064148d2ea2a..60f60d444930 100644 --- a/protocol_tests/aws-query/commands/FlattenedXmlMapWithXmlNameCommand.ts +++ b/protocol_tests/aws-query/commands/FlattenedXmlMapWithXmlNameCommand.ts @@ -22,6 +22,20 @@ export interface FlattenedXmlMapWithXmlNameCommandOutput extends FlattenedXmlMap /** * Flattened maps with @xmlName + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { QueryProtocolClient, FlattenedXmlMapWithXmlNameCommand } from "@aws-sdk/aws-query"; // ES Modules import + * // const { QueryProtocolClient, FlattenedXmlMapWithXmlNameCommand } = require("@aws-sdk/aws-query"); // CommonJS import + * const client = new QueryProtocolClient(config); + * const command = new FlattenedXmlMapWithXmlNameCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link FlattenedXmlMapWithXmlNameCommandInput} for command's `input` shape. + * @see {@link FlattenedXmlMapWithXmlNameCommandOutput} for command's `response` shape. + * @see {@link QueryProtocolClientResolvedConfig | config} for command's `input` shape. + * */ export class FlattenedXmlMapWithXmlNameCommand extends $Command< FlattenedXmlMapWithXmlNameCommandInput, diff --git a/protocol_tests/aws-query/commands/FlattenedXmlMapWithXmlNamespaceCommand.ts b/protocol_tests/aws-query/commands/FlattenedXmlMapWithXmlNamespaceCommand.ts index 9572ed7ce4d5..ec454ba19f63 100644 --- a/protocol_tests/aws-query/commands/FlattenedXmlMapWithXmlNamespaceCommand.ts +++ b/protocol_tests/aws-query/commands/FlattenedXmlMapWithXmlNamespaceCommand.ts @@ -24,6 +24,20 @@ export interface FlattenedXmlMapWithXmlNamespaceCommandOutput /** * Flattened maps with @xmlNamespace and @xmlName + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { QueryProtocolClient, FlattenedXmlMapWithXmlNamespaceCommand } from "@aws-sdk/aws-query"; // ES Modules import + * // const { QueryProtocolClient, FlattenedXmlMapWithXmlNamespaceCommand } = require("@aws-sdk/aws-query"); // CommonJS import + * const client = new QueryProtocolClient(config); + * const command = new FlattenedXmlMapWithXmlNamespaceCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link FlattenedXmlMapWithXmlNamespaceCommandInput} for command's `input` shape. + * @see {@link FlattenedXmlMapWithXmlNamespaceCommandOutput} for command's `response` shape. + * @see {@link QueryProtocolClientResolvedConfig | config} for command's `input` shape. + * */ export class FlattenedXmlMapWithXmlNamespaceCommand extends $Command< FlattenedXmlMapWithXmlNamespaceCommandInput, diff --git a/protocol_tests/aws-query/commands/GreetingWithErrorsCommand.ts b/protocol_tests/aws-query/commands/GreetingWithErrorsCommand.ts index e6c3a28c7b8f..af1f76b5c884 100644 --- a/protocol_tests/aws-query/commands/GreetingWithErrorsCommand.ts +++ b/protocol_tests/aws-query/commands/GreetingWithErrorsCommand.ts @@ -26,6 +26,20 @@ export interface GreetingWithErrorsCommandOutput extends GreetingWithErrorsOutpu * 1. A successful response in the form of GreetingWithErrorsOutput * 2. An InvalidGreeting error. * 3. A BadRequest error. + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { QueryProtocolClient, GreetingWithErrorsCommand } from "@aws-sdk/aws-query"; // ES Modules import + * // const { QueryProtocolClient, GreetingWithErrorsCommand } = require("@aws-sdk/aws-query"); // CommonJS import + * const client = new QueryProtocolClient(config); + * const command = new GreetingWithErrorsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GreetingWithErrorsCommandInput} for command's `input` shape. + * @see {@link GreetingWithErrorsCommandOutput} for command's `response` shape. + * @see {@link QueryProtocolClientResolvedConfig | config} for command's `input` shape. + * */ export class GreetingWithErrorsCommand extends $Command< GreetingWithErrorsCommandInput, diff --git a/protocol_tests/aws-query/commands/IgnoresWrappingXmlNameCommand.ts b/protocol_tests/aws-query/commands/IgnoresWrappingXmlNameCommand.ts index 2c06f76cb5a7..2f068da47501 100644 --- a/protocol_tests/aws-query/commands/IgnoresWrappingXmlNameCommand.ts +++ b/protocol_tests/aws-query/commands/IgnoresWrappingXmlNameCommand.ts @@ -25,6 +25,20 @@ export interface IgnoresWrappingXmlNameCommandOutput extends IgnoresWrappingXmlN * * The wrapping element is always operation name + "Response", and * inside of that wrapper is another wrapper named operation name + "Result". + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { QueryProtocolClient, IgnoresWrappingXmlNameCommand } from "@aws-sdk/aws-query"; // ES Modules import + * // const { QueryProtocolClient, IgnoresWrappingXmlNameCommand } = require("@aws-sdk/aws-query"); // CommonJS import + * const client = new QueryProtocolClient(config); + * const command = new IgnoresWrappingXmlNameCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link IgnoresWrappingXmlNameCommandInput} for command's `input` shape. + * @see {@link IgnoresWrappingXmlNameCommandOutput} for command's `response` shape. + * @see {@link QueryProtocolClientResolvedConfig | config} for command's `input` shape. + * */ export class IgnoresWrappingXmlNameCommand extends $Command< IgnoresWrappingXmlNameCommandInput, diff --git a/protocol_tests/aws-query/commands/NestedStructuresCommand.ts b/protocol_tests/aws-query/commands/NestedStructuresCommand.ts index a9ea2318a449..048eab3f5d47 100644 --- a/protocol_tests/aws-query/commands/NestedStructuresCommand.ts +++ b/protocol_tests/aws-query/commands/NestedStructuresCommand.ts @@ -22,6 +22,20 @@ export interface NestedStructuresCommandOutput extends __MetadataBearer {} /** * This test serializes nested and recursive structure members. + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { QueryProtocolClient, NestedStructuresCommand } from "@aws-sdk/aws-query"; // ES Modules import + * // const { QueryProtocolClient, NestedStructuresCommand } = require("@aws-sdk/aws-query"); // CommonJS import + * const client = new QueryProtocolClient(config); + * const command = new NestedStructuresCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link NestedStructuresCommandInput} for command's `input` shape. + * @see {@link NestedStructuresCommandOutput} for command's `response` shape. + * @see {@link QueryProtocolClientResolvedConfig | config} for command's `input` shape. + * */ export class NestedStructuresCommand extends $Command< NestedStructuresCommandInput, diff --git a/protocol_tests/aws-query/commands/NoInputAndNoOutputCommand.ts b/protocol_tests/aws-query/commands/NoInputAndNoOutputCommand.ts index 813690f90b98..852915489724 100644 --- a/protocol_tests/aws-query/commands/NoInputAndNoOutputCommand.ts +++ b/protocol_tests/aws-query/commands/NoInputAndNoOutputCommand.ts @@ -24,6 +24,20 @@ export interface NoInputAndNoOutputCommandOutput extends __MetadataBearer {} * no request or response payload because the operation has no input or output. * * While this should be rare, code generators must support this. + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { QueryProtocolClient, NoInputAndNoOutputCommand } from "@aws-sdk/aws-query"; // ES Modules import + * // const { QueryProtocolClient, NoInputAndNoOutputCommand } = require("@aws-sdk/aws-query"); // CommonJS import + * const client = new QueryProtocolClient(config); + * const command = new NoInputAndNoOutputCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link NoInputAndNoOutputCommandInput} for command's `input` shape. + * @see {@link NoInputAndNoOutputCommandOutput} for command's `response` shape. + * @see {@link QueryProtocolClientResolvedConfig | config} for command's `input` shape. + * */ export class NoInputAndNoOutputCommand extends $Command< NoInputAndNoOutputCommandInput, diff --git a/protocol_tests/aws-query/commands/NoInputAndOutputCommand.ts b/protocol_tests/aws-query/commands/NoInputAndOutputCommand.ts index aab182e3db25..129045c2fd98 100644 --- a/protocol_tests/aws-query/commands/NoInputAndOutputCommand.ts +++ b/protocol_tests/aws-query/commands/NoInputAndOutputCommand.ts @@ -25,6 +25,20 @@ export interface NoInputAndOutputCommandOutput extends __MetadataBearer {} * no request payload or response members. * * While this should be rare, code generators must support this. + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { QueryProtocolClient, NoInputAndOutputCommand } from "@aws-sdk/aws-query"; // ES Modules import + * // const { QueryProtocolClient, NoInputAndOutputCommand } = require("@aws-sdk/aws-query"); // CommonJS import + * const client = new QueryProtocolClient(config); + * const command = new NoInputAndOutputCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link NoInputAndOutputCommandInput} for command's `input` shape. + * @see {@link NoInputAndOutputCommandOutput} for command's `response` shape. + * @see {@link QueryProtocolClientResolvedConfig | config} for command's `input` shape. + * */ export class NoInputAndOutputCommand extends $Command< NoInputAndOutputCommandInput, diff --git a/protocol_tests/aws-query/commands/QueryIdempotencyTokenAutoFillCommand.ts b/protocol_tests/aws-query/commands/QueryIdempotencyTokenAutoFillCommand.ts index 705ffb446920..5c27356d7a04 100644 --- a/protocol_tests/aws-query/commands/QueryIdempotencyTokenAutoFillCommand.ts +++ b/protocol_tests/aws-query/commands/QueryIdempotencyTokenAutoFillCommand.ts @@ -22,6 +22,20 @@ export interface QueryIdempotencyTokenAutoFillCommandOutput extends __MetadataBe /** * Automatically adds idempotency tokens. + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { QueryProtocolClient, QueryIdempotencyTokenAutoFillCommand } from "@aws-sdk/aws-query"; // ES Modules import + * // const { QueryProtocolClient, QueryIdempotencyTokenAutoFillCommand } = require("@aws-sdk/aws-query"); // CommonJS import + * const client = new QueryProtocolClient(config); + * const command = new QueryIdempotencyTokenAutoFillCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link QueryIdempotencyTokenAutoFillCommandInput} for command's `input` shape. + * @see {@link QueryIdempotencyTokenAutoFillCommandOutput} for command's `response` shape. + * @see {@link QueryProtocolClientResolvedConfig | config} for command's `input` shape. + * */ export class QueryIdempotencyTokenAutoFillCommand extends $Command< QueryIdempotencyTokenAutoFillCommandInput, diff --git a/protocol_tests/aws-query/commands/QueryListsCommand.ts b/protocol_tests/aws-query/commands/QueryListsCommand.ts index a6f77ed133c2..6dbd56590ec0 100644 --- a/protocol_tests/aws-query/commands/QueryListsCommand.ts +++ b/protocol_tests/aws-query/commands/QueryListsCommand.ts @@ -19,6 +19,20 @@ export interface QueryListsCommandOutput extends __MetadataBearer {} /** * This test serializes simple and complex lists. + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { QueryProtocolClient, QueryListsCommand } from "@aws-sdk/aws-query"; // ES Modules import + * // const { QueryProtocolClient, QueryListsCommand } = require("@aws-sdk/aws-query"); // CommonJS import + * const client = new QueryProtocolClient(config); + * const command = new QueryListsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link QueryListsCommandInput} for command's `input` shape. + * @see {@link QueryListsCommandOutput} for command's `response` shape. + * @see {@link QueryProtocolClientResolvedConfig | config} for command's `input` shape. + * */ export class QueryListsCommand extends $Command< QueryListsCommandInput, diff --git a/protocol_tests/aws-query/commands/QueryMapsCommand.ts b/protocol_tests/aws-query/commands/QueryMapsCommand.ts index fccb094c95ec..65d01b971e81 100644 --- a/protocol_tests/aws-query/commands/QueryMapsCommand.ts +++ b/protocol_tests/aws-query/commands/QueryMapsCommand.ts @@ -19,6 +19,20 @@ export interface QueryMapsCommandOutput extends __MetadataBearer {} /** * This test serializes simple and complex maps. + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { QueryProtocolClient, QueryMapsCommand } from "@aws-sdk/aws-query"; // ES Modules import + * // const { QueryProtocolClient, QueryMapsCommand } = require("@aws-sdk/aws-query"); // CommonJS import + * const client = new QueryProtocolClient(config); + * const command = new QueryMapsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link QueryMapsCommandInput} for command's `input` shape. + * @see {@link QueryMapsCommandOutput} for command's `response` shape. + * @see {@link QueryProtocolClientResolvedConfig | config} for command's `input` shape. + * */ export class QueryMapsCommand extends $Command< QueryMapsCommandInput, diff --git a/protocol_tests/aws-query/commands/QueryTimestampsCommand.ts b/protocol_tests/aws-query/commands/QueryTimestampsCommand.ts index 51890fa52e49..2e7151fd3164 100644 --- a/protocol_tests/aws-query/commands/QueryTimestampsCommand.ts +++ b/protocol_tests/aws-query/commands/QueryTimestampsCommand.ts @@ -26,6 +26,20 @@ export interface QueryTimestampsCommandOutput extends __MetadataBearer {} * 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. + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { QueryProtocolClient, QueryTimestampsCommand } from "@aws-sdk/aws-query"; // ES Modules import + * // const { QueryProtocolClient, QueryTimestampsCommand } = require("@aws-sdk/aws-query"); // CommonJS import + * const client = new QueryProtocolClient(config); + * const command = new QueryTimestampsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link QueryTimestampsCommandInput} for command's `input` shape. + * @see {@link QueryTimestampsCommandOutput} for command's `response` shape. + * @see {@link QueryProtocolClientResolvedConfig | config} for command's `input` shape. + * */ export class QueryTimestampsCommand extends $Command< QueryTimestampsCommandInput, diff --git a/protocol_tests/aws-query/commands/RecursiveXmlShapesCommand.ts b/protocol_tests/aws-query/commands/RecursiveXmlShapesCommand.ts index 2b83bd33ebbd..07d1cfe3a6d5 100644 --- a/protocol_tests/aws-query/commands/RecursiveXmlShapesCommand.ts +++ b/protocol_tests/aws-query/commands/RecursiveXmlShapesCommand.ts @@ -22,6 +22,20 @@ export interface RecursiveXmlShapesCommandOutput extends RecursiveXmlShapesOutpu /** * Recursive shapes + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { QueryProtocolClient, RecursiveXmlShapesCommand } from "@aws-sdk/aws-query"; // ES Modules import + * // const { QueryProtocolClient, RecursiveXmlShapesCommand } = require("@aws-sdk/aws-query"); // CommonJS import + * const client = new QueryProtocolClient(config); + * const command = new RecursiveXmlShapesCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link RecursiveXmlShapesCommandInput} for command's `input` shape. + * @see {@link RecursiveXmlShapesCommandOutput} for command's `response` shape. + * @see {@link QueryProtocolClientResolvedConfig | config} for command's `input` shape. + * */ export class RecursiveXmlShapesCommand extends $Command< RecursiveXmlShapesCommandInput, diff --git a/protocol_tests/aws-query/commands/SimpleInputParamsCommand.ts b/protocol_tests/aws-query/commands/SimpleInputParamsCommand.ts index 1a9b0618691a..3b2bddb511dd 100644 --- a/protocol_tests/aws-query/commands/SimpleInputParamsCommand.ts +++ b/protocol_tests/aws-query/commands/SimpleInputParamsCommand.ts @@ -22,6 +22,20 @@ export interface SimpleInputParamsCommandOutput extends __MetadataBearer {} /** * This test serializes strings, numbers, and boolean values. + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { QueryProtocolClient, SimpleInputParamsCommand } from "@aws-sdk/aws-query"; // ES Modules import + * // const { QueryProtocolClient, SimpleInputParamsCommand } = require("@aws-sdk/aws-query"); // CommonJS import + * const client = new QueryProtocolClient(config); + * const command = new SimpleInputParamsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link SimpleInputParamsCommandInput} for command's `input` shape. + * @see {@link SimpleInputParamsCommandOutput} for command's `response` shape. + * @see {@link QueryProtocolClientResolvedConfig | config} for command's `input` shape. + * */ export class SimpleInputParamsCommand extends $Command< SimpleInputParamsCommandInput, diff --git a/protocol_tests/aws-query/commands/XmlBlobsCommand.ts b/protocol_tests/aws-query/commands/XmlBlobsCommand.ts index 36678e67a702..4905c50306e4 100644 --- a/protocol_tests/aws-query/commands/XmlBlobsCommand.ts +++ b/protocol_tests/aws-query/commands/XmlBlobsCommand.ts @@ -19,6 +19,20 @@ export interface XmlBlobsCommandOutput extends XmlBlobsOutput, __MetadataBearer /** * Blobs are base64 encoded + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { QueryProtocolClient, XmlBlobsCommand } from "@aws-sdk/aws-query"; // ES Modules import + * // const { QueryProtocolClient, XmlBlobsCommand } = require("@aws-sdk/aws-query"); // CommonJS import + * const client = new QueryProtocolClient(config); + * const command = new XmlBlobsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link XmlBlobsCommandInput} for command's `input` shape. + * @see {@link XmlBlobsCommandOutput} for command's `response` shape. + * @see {@link QueryProtocolClientResolvedConfig | config} for command's `input` shape. + * */ export class XmlBlobsCommand extends $Command< XmlBlobsCommandInput, diff --git a/protocol_tests/aws-query/commands/XmlEnumsCommand.ts b/protocol_tests/aws-query/commands/XmlEnumsCommand.ts index e6515ac30e79..bead2e60ec98 100644 --- a/protocol_tests/aws-query/commands/XmlEnumsCommand.ts +++ b/protocol_tests/aws-query/commands/XmlEnumsCommand.ts @@ -19,6 +19,20 @@ export interface XmlEnumsCommandOutput extends XmlEnumsOutput, __MetadataBearer /** * This example serializes enums as top level properties, in lists, sets, and maps. + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { QueryProtocolClient, XmlEnumsCommand } from "@aws-sdk/aws-query"; // ES Modules import + * // const { QueryProtocolClient, XmlEnumsCommand } = require("@aws-sdk/aws-query"); // CommonJS import + * const client = new QueryProtocolClient(config); + * const command = new XmlEnumsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link XmlEnumsCommandInput} for command's `input` shape. + * @see {@link XmlEnumsCommandOutput} for command's `response` shape. + * @see {@link QueryProtocolClientResolvedConfig | config} for command's `input` shape. + * */ export class XmlEnumsCommand extends $Command< XmlEnumsCommandInput, diff --git a/protocol_tests/aws-query/commands/XmlListsCommand.ts b/protocol_tests/aws-query/commands/XmlListsCommand.ts index a695c6b567c7..bb529a88d4fc 100644 --- a/protocol_tests/aws-query/commands/XmlListsCommand.ts +++ b/protocol_tests/aws-query/commands/XmlListsCommand.ts @@ -28,6 +28,20 @@ export interface XmlListsCommandOutput extends XmlListsOutput, __MetadataBearer * 5. Flattened XML lists. * 6. Flattened XML lists with @xmlName. * 7. Lists of structures. + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { QueryProtocolClient, XmlListsCommand } from "@aws-sdk/aws-query"; // ES Modules import + * // const { QueryProtocolClient, XmlListsCommand } = require("@aws-sdk/aws-query"); // CommonJS import + * const client = new QueryProtocolClient(config); + * const command = new XmlListsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link XmlListsCommandInput} for command's `input` shape. + * @see {@link XmlListsCommandOutput} for command's `response` shape. + * @see {@link QueryProtocolClientResolvedConfig | config} for command's `input` shape. + * */ export class XmlListsCommand extends $Command< XmlListsCommandInput, diff --git a/protocol_tests/aws-query/commands/XmlMapsCommand.ts b/protocol_tests/aws-query/commands/XmlMapsCommand.ts index e72214231d52..a0c868ace006 100644 --- a/protocol_tests/aws-query/commands/XmlMapsCommand.ts +++ b/protocol_tests/aws-query/commands/XmlMapsCommand.ts @@ -19,6 +19,20 @@ export interface XmlMapsCommandOutput extends XmlMapsOutput, __MetadataBearer {} /** * The example tests basic map serialization. + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { QueryProtocolClient, XmlMapsCommand } from "@aws-sdk/aws-query"; // ES Modules import + * // const { QueryProtocolClient, XmlMapsCommand } = require("@aws-sdk/aws-query"); // CommonJS import + * const client = new QueryProtocolClient(config); + * const command = new XmlMapsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link XmlMapsCommandInput} for command's `input` shape. + * @see {@link XmlMapsCommandOutput} for command's `response` shape. + * @see {@link QueryProtocolClientResolvedConfig | config} for command's `input` shape. + * */ export class XmlMapsCommand extends $Command< XmlMapsCommandInput, diff --git a/protocol_tests/aws-query/commands/XmlTimestampsCommand.ts b/protocol_tests/aws-query/commands/XmlTimestampsCommand.ts index 6c7901d6cddd..55f9067c00b9 100644 --- a/protocol_tests/aws-query/commands/XmlTimestampsCommand.ts +++ b/protocol_tests/aws-query/commands/XmlTimestampsCommand.ts @@ -24,6 +24,20 @@ export interface XmlTimestampsCommandOutput extends XmlTimestampsOutput, __Metad * This tests how timestamps are serialized, including using the * default format of date-time and various @timestampFormat trait * values. + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { QueryProtocolClient, XmlTimestampsCommand } from "@aws-sdk/aws-query"; // ES Modules import + * // const { QueryProtocolClient, XmlTimestampsCommand } = require("@aws-sdk/aws-query"); // CommonJS import + * const client = new QueryProtocolClient(config); + * const command = new XmlTimestampsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link XmlTimestampsCommandInput} for command's `input` shape. + * @see {@link XmlTimestampsCommandOutput} for command's `response` shape. + * @see {@link QueryProtocolClientResolvedConfig | config} for command's `input` shape. + * */ export class XmlTimestampsCommand extends $Command< XmlTimestampsCommandInput, diff --git a/protocol_tests/aws-query/models/models_0.ts b/protocol_tests/aws-query/models/models_0.ts index fb2de3322b82..94c1cd74b052 100644 --- a/protocol_tests/aws-query/models/models_0.ts +++ b/protocol_tests/aws-query/models/models_0.ts @@ -4,6 +4,9 @@ import { MetadataBearer as $MetadataBearer } from "@aws-sdk/types"; export interface EmptyInputAndEmptyOutputInput {} export namespace EmptyInputAndEmptyOutputInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: EmptyInputAndEmptyOutputInput): any => ({ ...obj, }); @@ -12,6 +15,9 @@ export namespace EmptyInputAndEmptyOutputInput { export interface EmptyInputAndEmptyOutputOutput {} export namespace EmptyInputAndEmptyOutputOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: EmptyInputAndEmptyOutputOutput): any => ({ ...obj, }); @@ -22,6 +28,9 @@ export interface HostLabelInput { } export namespace HostLabelInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: HostLabelInput): any => ({ ...obj, }); @@ -40,6 +49,9 @@ export interface FlattenedXmlMapOutput { } export namespace FlattenedXmlMapOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: FlattenedXmlMapOutput): any => ({ ...obj, }); @@ -50,6 +62,9 @@ export interface FlattenedXmlMapWithXmlNameOutput { } export namespace FlattenedXmlMapWithXmlNameOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: FlattenedXmlMapWithXmlNameOutput): any => ({ ...obj, }); @@ -60,6 +75,9 @@ export interface FlattenedXmlMapWithXmlNamespaceOutput { } export namespace FlattenedXmlMapWithXmlNamespaceOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: FlattenedXmlMapWithXmlNamespaceOutput): any => ({ ...obj, }); @@ -70,6 +88,9 @@ export interface ComplexNestedErrorData { } export namespace ComplexNestedErrorData { + /** + * @internal + */ export const filterSensitiveLog = (obj: ComplexNestedErrorData): any => ({ ...obj, }); @@ -86,6 +107,9 @@ export interface ComplexError extends __SmithyException, $MetadataBearer { } export namespace ComplexError { + /** + * @internal + */ export const filterSensitiveLog = (obj: ComplexError): any => ({ ...obj, }); @@ -96,6 +120,9 @@ export interface GreetingWithErrorsOutput { } export namespace GreetingWithErrorsOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: GreetingWithErrorsOutput): any => ({ ...obj, }); @@ -111,6 +138,9 @@ export interface InvalidGreeting extends __SmithyException, $MetadataBearer { } export namespace InvalidGreeting { + /** + * @internal + */ export const filterSensitiveLog = (obj: InvalidGreeting): any => ({ ...obj, }); @@ -121,6 +151,9 @@ export interface IgnoresWrappingXmlNameOutput { } export namespace IgnoresWrappingXmlNameOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: IgnoresWrappingXmlNameOutput): any => ({ ...obj, }); @@ -129,6 +162,9 @@ export namespace IgnoresWrappingXmlNameOutput { export interface NoInputAndOutputOutput {} export namespace NoInputAndOutputOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: NoInputAndOutputOutput): any => ({ ...obj, }); @@ -139,6 +175,9 @@ export interface QueryIdempotencyTokenAutoFillInput { } export namespace QueryIdempotencyTokenAutoFillInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: QueryIdempotencyTokenAutoFillInput): any => ({ ...obj, }); @@ -149,6 +188,9 @@ export interface GreetingStruct { } export namespace GreetingStruct { + /** + * @internal + */ export const filterSensitiveLog = (obj: GreetingStruct): any => ({ ...obj, }); @@ -163,6 +205,9 @@ export interface QueryListsInput { } export namespace QueryListsInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: QueryListsInput): any => ({ ...obj, }); @@ -179,6 +224,9 @@ export interface QueryMapsInput { } export namespace QueryMapsInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: QueryMapsInput): any => ({ ...obj, }); @@ -191,6 +239,9 @@ export interface QueryTimestampsInput { } export namespace QueryTimestampsInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: QueryTimestampsInput): any => ({ ...obj, }); @@ -207,6 +258,9 @@ export interface SimpleInputParamsInput { } export namespace SimpleInputParamsInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: SimpleInputParamsInput): any => ({ ...obj, }); @@ -226,6 +280,9 @@ export interface SimpleScalarXmlPropertiesOutput { } export namespace SimpleScalarXmlPropertiesOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: SimpleScalarXmlPropertiesOutput): any => ({ ...obj, }); @@ -236,6 +293,9 @@ export interface XmlBlobsOutput { } export namespace XmlBlobsOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: XmlBlobsOutput): any => ({ ...obj, }); @@ -247,6 +307,9 @@ export interface StructureListMember { } export namespace StructureListMember { + /** + * @internal + */ export const filterSensitiveLog = (obj: StructureListMember): any => ({ ...obj, }); @@ -273,6 +336,9 @@ export interface XmlListsOutput { } export namespace XmlListsOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: XmlListsOutput): any => ({ ...obj, }); @@ -283,6 +349,9 @@ export interface XmlMapsOutput { } export namespace XmlMapsOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: XmlMapsOutput): any => ({ ...obj, }); @@ -298,6 +367,9 @@ export interface XmlEnumsOutput { } export namespace XmlEnumsOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: XmlEnumsOutput): any => ({ ...obj, }); @@ -308,6 +380,9 @@ export interface XmlMapsXmlNameOutput { } export namespace XmlMapsXmlNameOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: XmlMapsXmlNameOutput): any => ({ ...obj, }); @@ -319,6 +394,9 @@ export interface XmlNamespaceNested { } export namespace XmlNamespaceNested { + /** + * @internal + */ export const filterSensitiveLog = (obj: XmlNamespaceNested): any => ({ ...obj, }); @@ -329,6 +407,9 @@ export interface XmlNamespacesOutput { } export namespace XmlNamespacesOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: XmlNamespacesOutput): any => ({ ...obj, }); @@ -342,6 +423,9 @@ export interface XmlTimestampsOutput { } export namespace XmlTimestampsOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: XmlTimestampsOutput): any => ({ ...obj, }); @@ -354,6 +438,9 @@ export interface StructArg { } export namespace StructArg { + /** + * @internal + */ export const filterSensitiveLog = (obj: StructArg): any => ({ ...obj, }); @@ -364,6 +451,9 @@ export interface NestedStructuresInput { } export namespace NestedStructuresInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: NestedStructuresInput): any => ({ ...obj, }); @@ -375,6 +465,9 @@ export interface RecursiveXmlShapesOutputNested1 { } export namespace RecursiveXmlShapesOutputNested1 { + /** + * @internal + */ export const filterSensitiveLog = (obj: RecursiveXmlShapesOutputNested1): any => ({ ...obj, }); @@ -386,6 +479,9 @@ export interface RecursiveXmlShapesOutputNested2 { } export namespace RecursiveXmlShapesOutputNested2 { + /** + * @internal + */ export const filterSensitiveLog = (obj: RecursiveXmlShapesOutputNested2): any => ({ ...obj, }); @@ -396,6 +492,9 @@ export interface RecursiveXmlShapesOutput { } export namespace RecursiveXmlShapesOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: RecursiveXmlShapesOutput): any => ({ ...obj, }); diff --git a/protocol_tests/aws-restjson/commands/AllQueryStringTypesCommand.ts b/protocol_tests/aws-restjson/commands/AllQueryStringTypesCommand.ts index 31e9ef5b43dd..ce6dc727e705 100644 --- a/protocol_tests/aws-restjson/commands/AllQueryStringTypesCommand.ts +++ b/protocol_tests/aws-restjson/commands/AllQueryStringTypesCommand.ts @@ -22,6 +22,20 @@ export interface AllQueryStringTypesCommandOutput extends __MetadataBearer {} /** * This example uses all query string types. + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { RestJsonProtocolClient, AllQueryStringTypesCommand } from "@aws-sdk/aws-restjson"; // ES Modules import + * // const { RestJsonProtocolClient, AllQueryStringTypesCommand } = require("@aws-sdk/aws-restjson"); // CommonJS import + * const client = new RestJsonProtocolClient(config); + * const command = new AllQueryStringTypesCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link AllQueryStringTypesCommandInput} for command's `input` shape. + * @see {@link AllQueryStringTypesCommandOutput} for command's `response` shape. + * @see {@link RestJsonProtocolClientResolvedConfig | config} for command's `input` shape. + * */ export class AllQueryStringTypesCommand extends $Command< AllQueryStringTypesCommandInput, diff --git a/protocol_tests/aws-restjson/commands/ConstantAndVariableQueryStringCommand.ts b/protocol_tests/aws-restjson/commands/ConstantAndVariableQueryStringCommand.ts index 17ae472bde0c..79c8e35066ec 100644 --- a/protocol_tests/aws-restjson/commands/ConstantAndVariableQueryStringCommand.ts +++ b/protocol_tests/aws-restjson/commands/ConstantAndVariableQueryStringCommand.ts @@ -24,6 +24,20 @@ export interface ConstantAndVariableQueryStringCommandOutput extends __MetadataB * 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). + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { RestJsonProtocolClient, ConstantAndVariableQueryStringCommand } from "@aws-sdk/aws-restjson"; // ES Modules import + * // const { RestJsonProtocolClient, ConstantAndVariableQueryStringCommand } = require("@aws-sdk/aws-restjson"); // CommonJS import + * const client = new RestJsonProtocolClient(config); + * const command = new ConstantAndVariableQueryStringCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ConstantAndVariableQueryStringCommandInput} for command's `input` shape. + * @see {@link ConstantAndVariableQueryStringCommandOutput} for command's `response` shape. + * @see {@link RestJsonProtocolClientResolvedConfig | config} for command's `input` shape. + * */ export class ConstantAndVariableQueryStringCommand extends $Command< ConstantAndVariableQueryStringCommandInput, diff --git a/protocol_tests/aws-restjson/commands/ConstantQueryStringCommand.ts b/protocol_tests/aws-restjson/commands/ConstantQueryStringCommand.ts index df97cf28812c..1970db53a4c7 100644 --- a/protocol_tests/aws-restjson/commands/ConstantQueryStringCommand.ts +++ b/protocol_tests/aws-restjson/commands/ConstantQueryStringCommand.ts @@ -25,6 +25,20 @@ export interface ConstantQueryStringCommandOutput extends __MetadataBearer {} * 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}`. + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { RestJsonProtocolClient, ConstantQueryStringCommand } from "@aws-sdk/aws-restjson"; // ES Modules import + * // const { RestJsonProtocolClient, ConstantQueryStringCommand } = require("@aws-sdk/aws-restjson"); // CommonJS import + * const client = new RestJsonProtocolClient(config); + * const command = new ConstantQueryStringCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ConstantQueryStringCommandInput} for command's `input` shape. + * @see {@link ConstantQueryStringCommandOutput} for command's `response` shape. + * @see {@link RestJsonProtocolClientResolvedConfig | config} for command's `input` shape. + * */ export class ConstantQueryStringCommand extends $Command< ConstantQueryStringCommandInput, diff --git a/protocol_tests/aws-restjson/commands/EmptyInputAndEmptyOutputCommand.ts b/protocol_tests/aws-restjson/commands/EmptyInputAndEmptyOutputCommand.ts index 10362b9c85be..ed19b4987b8e 100644 --- a/protocol_tests/aws-restjson/commands/EmptyInputAndEmptyOutputCommand.ts +++ b/protocol_tests/aws-restjson/commands/EmptyInputAndEmptyOutputCommand.ts @@ -25,6 +25,20 @@ export interface EmptyInputAndEmptyOutputCommandOutput extends EmptyInputAndEmpt * 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. + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { RestJsonProtocolClient, EmptyInputAndEmptyOutputCommand } from "@aws-sdk/aws-restjson"; // ES Modules import + * // const { RestJsonProtocolClient, EmptyInputAndEmptyOutputCommand } = require("@aws-sdk/aws-restjson"); // CommonJS import + * const client = new RestJsonProtocolClient(config); + * const command = new EmptyInputAndEmptyOutputCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link EmptyInputAndEmptyOutputCommandInput} for command's `input` shape. + * @see {@link EmptyInputAndEmptyOutputCommandOutput} for command's `response` shape. + * @see {@link RestJsonProtocolClientResolvedConfig | config} for command's `input` shape. + * */ export class EmptyInputAndEmptyOutputCommand extends $Command< EmptyInputAndEmptyOutputCommandInput, diff --git a/protocol_tests/aws-restjson/commands/GreetingWithErrorsCommand.ts b/protocol_tests/aws-restjson/commands/GreetingWithErrorsCommand.ts index f967b92796f7..d7c5588032df 100644 --- a/protocol_tests/aws-restjson/commands/GreetingWithErrorsCommand.ts +++ b/protocol_tests/aws-restjson/commands/GreetingWithErrorsCommand.ts @@ -31,6 +31,20 @@ export interface GreetingWithErrorsCommandOutput extends GreetingWithErrorsOutpu * Implementations must be able to successfully take a response and * properly (de)serialize successful and error responses based on the * the presence of the + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { RestJsonProtocolClient, GreetingWithErrorsCommand } from "@aws-sdk/aws-restjson"; // ES Modules import + * // const { RestJsonProtocolClient, GreetingWithErrorsCommand } = require("@aws-sdk/aws-restjson"); // CommonJS import + * const client = new RestJsonProtocolClient(config); + * const command = new GreetingWithErrorsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GreetingWithErrorsCommandInput} for command's `input` shape. + * @see {@link GreetingWithErrorsCommandOutput} for command's `response` shape. + * @see {@link RestJsonProtocolClientResolvedConfig | config} for command's `input` shape. + * */ export class GreetingWithErrorsCommand extends $Command< GreetingWithErrorsCommandInput, diff --git a/protocol_tests/aws-restjson/commands/HttpPayloadTraitsCommand.ts b/protocol_tests/aws-restjson/commands/HttpPayloadTraitsCommand.ts index 8a1e0e8816f1..a00c383a4338 100644 --- a/protocol_tests/aws-restjson/commands/HttpPayloadTraitsCommand.ts +++ b/protocol_tests/aws-restjson/commands/HttpPayloadTraitsCommand.ts @@ -25,6 +25,20 @@ export interface HttpPayloadTraitsCommandOutput extends HttpPayloadTraitsInputOu * * In this example, no JSON document is synthesized because the payload is * not a structure or a union type. + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { RestJsonProtocolClient, HttpPayloadTraitsCommand } from "@aws-sdk/aws-restjson"; // ES Modules import + * // const { RestJsonProtocolClient, HttpPayloadTraitsCommand } = require("@aws-sdk/aws-restjson"); // CommonJS import + * const client = new RestJsonProtocolClient(config); + * const command = new HttpPayloadTraitsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link HttpPayloadTraitsCommandInput} for command's `input` shape. + * @see {@link HttpPayloadTraitsCommandOutput} for command's `response` shape. + * @see {@link RestJsonProtocolClientResolvedConfig | config} for command's `input` shape. + * */ export class HttpPayloadTraitsCommand extends $Command< HttpPayloadTraitsCommandInput, diff --git a/protocol_tests/aws-restjson/commands/HttpPayloadTraitsWithMediaTypeCommand.ts b/protocol_tests/aws-restjson/commands/HttpPayloadTraitsWithMediaTypeCommand.ts index 1de7641a8b28..e2d7b04b7726 100644 --- a/protocol_tests/aws-restjson/commands/HttpPayloadTraitsWithMediaTypeCommand.ts +++ b/protocol_tests/aws-restjson/commands/HttpPayloadTraitsWithMediaTypeCommand.ts @@ -25,6 +25,20 @@ export interface HttpPayloadTraitsWithMediaTypeCommandOutput /** * This examples uses a `@mediaType` trait on the payload to force a custom * content-type to be serialized. + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { RestJsonProtocolClient, HttpPayloadTraitsWithMediaTypeCommand } from "@aws-sdk/aws-restjson"; // ES Modules import + * // const { RestJsonProtocolClient, HttpPayloadTraitsWithMediaTypeCommand } = require("@aws-sdk/aws-restjson"); // CommonJS import + * const client = new RestJsonProtocolClient(config); + * const command = new HttpPayloadTraitsWithMediaTypeCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link HttpPayloadTraitsWithMediaTypeCommandInput} for command's `input` shape. + * @see {@link HttpPayloadTraitsWithMediaTypeCommandOutput} for command's `response` shape. + * @see {@link RestJsonProtocolClientResolvedConfig | config} for command's `input` shape. + * */ export class HttpPayloadTraitsWithMediaTypeCommand extends $Command< HttpPayloadTraitsWithMediaTypeCommandInput, diff --git a/protocol_tests/aws-restjson/commands/HttpPayloadWithStructureCommand.ts b/protocol_tests/aws-restjson/commands/HttpPayloadWithStructureCommand.ts index be3c93e8b8f0..ce64cb43ab87 100644 --- a/protocol_tests/aws-restjson/commands/HttpPayloadWithStructureCommand.ts +++ b/protocol_tests/aws-restjson/commands/HttpPayloadWithStructureCommand.ts @@ -25,6 +25,20 @@ export interface HttpPayloadWithStructureCommandOutput extends HttpPayloadWithSt * * Note that serializing a structure changes the wrapper element name * to match the targeted structure. + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { RestJsonProtocolClient, HttpPayloadWithStructureCommand } from "@aws-sdk/aws-restjson"; // ES Modules import + * // const { RestJsonProtocolClient, HttpPayloadWithStructureCommand } = require("@aws-sdk/aws-restjson"); // CommonJS import + * const client = new RestJsonProtocolClient(config); + * const command = new HttpPayloadWithStructureCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link HttpPayloadWithStructureCommandInput} for command's `input` shape. + * @see {@link HttpPayloadWithStructureCommandOutput} for command's `response` shape. + * @see {@link RestJsonProtocolClientResolvedConfig | config} for command's `input` shape. + * */ export class HttpPayloadWithStructureCommand extends $Command< HttpPayloadWithStructureCommandInput, diff --git a/protocol_tests/aws-restjson/commands/HttpPrefixHeadersCommand.ts b/protocol_tests/aws-restjson/commands/HttpPrefixHeadersCommand.ts index 81d0d893d53b..11f88a731306 100644 --- a/protocol_tests/aws-restjson/commands/HttpPrefixHeadersCommand.ts +++ b/protocol_tests/aws-restjson/commands/HttpPrefixHeadersCommand.ts @@ -22,6 +22,20 @@ export interface HttpPrefixHeadersCommandOutput extends HttpPrefixHeadersInputOu /** * This examples adds headers to the input of a request and response by prefix. + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { RestJsonProtocolClient, HttpPrefixHeadersCommand } from "@aws-sdk/aws-restjson"; // ES Modules import + * // const { RestJsonProtocolClient, HttpPrefixHeadersCommand } = require("@aws-sdk/aws-restjson"); // CommonJS import + * const client = new RestJsonProtocolClient(config); + * const command = new HttpPrefixHeadersCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link HttpPrefixHeadersCommandInput} for command's `input` shape. + * @see {@link HttpPrefixHeadersCommandOutput} for command's `response` shape. + * @see {@link RestJsonProtocolClientResolvedConfig | config} for command's `input` shape. + * */ export class HttpPrefixHeadersCommand extends $Command< HttpPrefixHeadersCommandInput, diff --git a/protocol_tests/aws-restjson/commands/HttpPrefixHeadersResponseCommand.ts b/protocol_tests/aws-restjson/commands/HttpPrefixHeadersResponseCommand.ts index 4e8f156c4dfa..42ce66c7d398 100644 --- a/protocol_tests/aws-restjson/commands/HttpPrefixHeadersResponseCommand.ts +++ b/protocol_tests/aws-restjson/commands/HttpPrefixHeadersResponseCommand.ts @@ -22,6 +22,20 @@ export interface HttpPrefixHeadersResponseCommandOutput extends HttpPrefixHeader /** * Clients that perform this test extract all headers from the response. + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { RestJsonProtocolClient, HttpPrefixHeadersResponseCommand } from "@aws-sdk/aws-restjson"; // ES Modules import + * // const { RestJsonProtocolClient, HttpPrefixHeadersResponseCommand } = require("@aws-sdk/aws-restjson"); // CommonJS import + * const client = new RestJsonProtocolClient(config); + * const command = new HttpPrefixHeadersResponseCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link HttpPrefixHeadersResponseCommandInput} for command's `input` shape. + * @see {@link HttpPrefixHeadersResponseCommandOutput} for command's `response` shape. + * @see {@link RestJsonProtocolClientResolvedConfig | config} for command's `input` shape. + * */ export class HttpPrefixHeadersResponseCommand extends $Command< HttpPrefixHeadersResponseCommandInput, diff --git a/protocol_tests/aws-restjson/commands/HttpRequestWithLabelsAndTimestampFormatCommand.ts b/protocol_tests/aws-restjson/commands/HttpRequestWithLabelsAndTimestampFormatCommand.ts index f6cdedbf3540..c206b95c0da1 100644 --- a/protocol_tests/aws-restjson/commands/HttpRequestWithLabelsAndTimestampFormatCommand.ts +++ b/protocol_tests/aws-restjson/commands/HttpRequestWithLabelsAndTimestampFormatCommand.ts @@ -24,6 +24,20 @@ export interface HttpRequestWithLabelsAndTimestampFormatCommandOutput extends __ /** * The example tests how requests serialize different timestamp formats in the * URI path. + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { RestJsonProtocolClient, HttpRequestWithLabelsAndTimestampFormatCommand } from "@aws-sdk/aws-restjson"; // ES Modules import + * // const { RestJsonProtocolClient, HttpRequestWithLabelsAndTimestampFormatCommand } = require("@aws-sdk/aws-restjson"); // CommonJS import + * const client = new RestJsonProtocolClient(config); + * const command = new HttpRequestWithLabelsAndTimestampFormatCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link HttpRequestWithLabelsAndTimestampFormatCommandInput} for command's `input` shape. + * @see {@link HttpRequestWithLabelsAndTimestampFormatCommandOutput} for command's `response` shape. + * @see {@link RestJsonProtocolClientResolvedConfig | config} for command's `input` shape. + * */ export class HttpRequestWithLabelsAndTimestampFormatCommand extends $Command< HttpRequestWithLabelsAndTimestampFormatCommandInput, diff --git a/protocol_tests/aws-restjson/commands/HttpRequestWithLabelsCommand.ts b/protocol_tests/aws-restjson/commands/HttpRequestWithLabelsCommand.ts index 03ac736b3ab7..0e5b7f2fae27 100644 --- a/protocol_tests/aws-restjson/commands/HttpRequestWithLabelsCommand.ts +++ b/protocol_tests/aws-restjson/commands/HttpRequestWithLabelsCommand.ts @@ -23,6 +23,20 @@ export interface HttpRequestWithLabelsCommandOutput extends __MetadataBearer {} /** * The example tests how requests are serialized when there's no input * payload but there are HTTP labels. + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { RestJsonProtocolClient, HttpRequestWithLabelsCommand } from "@aws-sdk/aws-restjson"; // ES Modules import + * // const { RestJsonProtocolClient, HttpRequestWithLabelsCommand } = require("@aws-sdk/aws-restjson"); // CommonJS import + * const client = new RestJsonProtocolClient(config); + * const command = new HttpRequestWithLabelsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link HttpRequestWithLabelsCommandInput} for command's `input` shape. + * @see {@link HttpRequestWithLabelsCommandOutput} for command's `response` shape. + * @see {@link RestJsonProtocolClientResolvedConfig | config} for command's `input` shape. + * */ export class HttpRequestWithLabelsCommand extends $Command< HttpRequestWithLabelsCommandInput, diff --git a/protocol_tests/aws-restjson/commands/IgnoreQueryParamsInResponseCommand.ts b/protocol_tests/aws-restjson/commands/IgnoreQueryParamsInResponseCommand.ts index 7c08daf8bfaa..4d44d311210e 100644 --- a/protocol_tests/aws-restjson/commands/IgnoreQueryParamsInResponseCommand.ts +++ b/protocol_tests/aws-restjson/commands/IgnoreQueryParamsInResponseCommand.ts @@ -24,6 +24,20 @@ export interface IgnoreQueryParamsInResponseCommandOutput extends IgnoreQueryPar * 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. + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { RestJsonProtocolClient, IgnoreQueryParamsInResponseCommand } from "@aws-sdk/aws-restjson"; // ES Modules import + * // const { RestJsonProtocolClient, IgnoreQueryParamsInResponseCommand } = require("@aws-sdk/aws-restjson"); // CommonJS import + * const client = new RestJsonProtocolClient(config); + * const command = new IgnoreQueryParamsInResponseCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link IgnoreQueryParamsInResponseCommandInput} for command's `input` shape. + * @see {@link IgnoreQueryParamsInResponseCommandOutput} for command's `response` shape. + * @see {@link RestJsonProtocolClientResolvedConfig | config} for command's `input` shape. + * */ export class IgnoreQueryParamsInResponseCommand extends $Command< IgnoreQueryParamsInResponseCommandInput, diff --git a/protocol_tests/aws-restjson/commands/InlineDocumentAsPayloadCommand.ts b/protocol_tests/aws-restjson/commands/InlineDocumentAsPayloadCommand.ts index f3792a1e1d79..944f0c23b72e 100644 --- a/protocol_tests/aws-restjson/commands/InlineDocumentAsPayloadCommand.ts +++ b/protocol_tests/aws-restjson/commands/InlineDocumentAsPayloadCommand.ts @@ -22,6 +22,20 @@ export interface InlineDocumentAsPayloadCommandOutput extends InlineDocumentAsPa /** * This example serializes an inline document as the entire HTTP payload. + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { RestJsonProtocolClient, InlineDocumentAsPayloadCommand } from "@aws-sdk/aws-restjson"; // ES Modules import + * // const { RestJsonProtocolClient, InlineDocumentAsPayloadCommand } = require("@aws-sdk/aws-restjson"); // CommonJS import + * const client = new RestJsonProtocolClient(config); + * const command = new InlineDocumentAsPayloadCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link InlineDocumentAsPayloadCommandInput} for command's `input` shape. + * @see {@link InlineDocumentAsPayloadCommandOutput} for command's `response` shape. + * @see {@link RestJsonProtocolClientResolvedConfig | config} for command's `input` shape. + * */ export class InlineDocumentAsPayloadCommand extends $Command< InlineDocumentAsPayloadCommandInput, diff --git a/protocol_tests/aws-restjson/commands/InlineDocumentCommand.ts b/protocol_tests/aws-restjson/commands/InlineDocumentCommand.ts index 7877c4b5b1cf..418d912cf6a4 100644 --- a/protocol_tests/aws-restjson/commands/InlineDocumentCommand.ts +++ b/protocol_tests/aws-restjson/commands/InlineDocumentCommand.ts @@ -22,6 +22,20 @@ export interface InlineDocumentCommandOutput extends InlineDocumentInputOutput, /** * This example serializes an inline document as part of the payload. + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { RestJsonProtocolClient, InlineDocumentCommand } from "@aws-sdk/aws-restjson"; // ES Modules import + * // const { RestJsonProtocolClient, InlineDocumentCommand } = require("@aws-sdk/aws-restjson"); // CommonJS import + * const client = new RestJsonProtocolClient(config); + * const command = new InlineDocumentCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link InlineDocumentCommandInput} for command's `input` shape. + * @see {@link InlineDocumentCommandOutput} for command's `response` shape. + * @see {@link RestJsonProtocolClientResolvedConfig | config} for command's `input` shape. + * */ export class InlineDocumentCommand extends $Command< InlineDocumentCommandInput, diff --git a/protocol_tests/aws-restjson/commands/InputAndOutputWithHeadersCommand.ts b/protocol_tests/aws-restjson/commands/InputAndOutputWithHeadersCommand.ts index 3465f3a240e4..bac688a16f3d 100644 --- a/protocol_tests/aws-restjson/commands/InputAndOutputWithHeadersCommand.ts +++ b/protocol_tests/aws-restjson/commands/InputAndOutputWithHeadersCommand.ts @@ -23,6 +23,20 @@ export interface InputAndOutputWithHeadersCommandOutput extends InputAndOutputWi /** * The example tests how requests and responses are serialized when there is * no input or output payload but there are HTTP header bindings. + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { RestJsonProtocolClient, InputAndOutputWithHeadersCommand } from "@aws-sdk/aws-restjson"; // ES Modules import + * // const { RestJsonProtocolClient, InputAndOutputWithHeadersCommand } = require("@aws-sdk/aws-restjson"); // CommonJS import + * const client = new RestJsonProtocolClient(config); + * const command = new InputAndOutputWithHeadersCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link InputAndOutputWithHeadersCommandInput} for command's `input` shape. + * @see {@link InputAndOutputWithHeadersCommandOutput} for command's `response` shape. + * @see {@link RestJsonProtocolClientResolvedConfig | config} for command's `input` shape. + * */ export class InputAndOutputWithHeadersCommand extends $Command< InputAndOutputWithHeadersCommandInput, diff --git a/protocol_tests/aws-restjson/commands/JsonBlobsCommand.ts b/protocol_tests/aws-restjson/commands/JsonBlobsCommand.ts index 1094ab35be40..c70f74ceee73 100644 --- a/protocol_tests/aws-restjson/commands/JsonBlobsCommand.ts +++ b/protocol_tests/aws-restjson/commands/JsonBlobsCommand.ts @@ -22,6 +22,20 @@ export interface JsonBlobsCommandOutput extends JsonBlobsInputOutput, __Metadata /** * Blobs are base64 encoded + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { RestJsonProtocolClient, JsonBlobsCommand } from "@aws-sdk/aws-restjson"; // ES Modules import + * // const { RestJsonProtocolClient, JsonBlobsCommand } = require("@aws-sdk/aws-restjson"); // CommonJS import + * const client = new RestJsonProtocolClient(config); + * const command = new JsonBlobsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link JsonBlobsCommandInput} for command's `input` shape. + * @see {@link JsonBlobsCommandOutput} for command's `response` shape. + * @see {@link RestJsonProtocolClientResolvedConfig | config} for command's `input` shape. + * */ export class JsonBlobsCommand extends $Command< JsonBlobsCommandInput, diff --git a/protocol_tests/aws-restjson/commands/JsonEnumsCommand.ts b/protocol_tests/aws-restjson/commands/JsonEnumsCommand.ts index d75a13ebf860..c8ba5e414269 100644 --- a/protocol_tests/aws-restjson/commands/JsonEnumsCommand.ts +++ b/protocol_tests/aws-restjson/commands/JsonEnumsCommand.ts @@ -22,6 +22,20 @@ export interface JsonEnumsCommandOutput extends JsonEnumsInputOutput, __Metadata /** * This example serializes enums as top level properties, in lists, sets, and maps. + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { RestJsonProtocolClient, JsonEnumsCommand } from "@aws-sdk/aws-restjson"; // ES Modules import + * // const { RestJsonProtocolClient, JsonEnumsCommand } = require("@aws-sdk/aws-restjson"); // CommonJS import + * const client = new RestJsonProtocolClient(config); + * const command = new JsonEnumsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link JsonEnumsCommandInput} for command's `input` shape. + * @see {@link JsonEnumsCommandOutput} for command's `response` shape. + * @see {@link RestJsonProtocolClientResolvedConfig | config} for command's `input` shape. + * */ export class JsonEnumsCommand extends $Command< JsonEnumsCommandInput, diff --git a/protocol_tests/aws-restjson/commands/JsonListsCommand.ts b/protocol_tests/aws-restjson/commands/JsonListsCommand.ts index 354a46cf5979..594e29d1683b 100644 --- a/protocol_tests/aws-restjson/commands/JsonListsCommand.ts +++ b/protocol_tests/aws-restjson/commands/JsonListsCommand.ts @@ -28,6 +28,20 @@ export interface JsonListsCommandOutput extends JsonListsInputOutput, __Metadata * 2. Normal JSON sets. * 3. JSON lists of lists. * 4. Lists of structures. + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { RestJsonProtocolClient, JsonListsCommand } from "@aws-sdk/aws-restjson"; // ES Modules import + * // const { RestJsonProtocolClient, JsonListsCommand } = require("@aws-sdk/aws-restjson"); // CommonJS import + * const client = new RestJsonProtocolClient(config); + * const command = new JsonListsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link JsonListsCommandInput} for command's `input` shape. + * @see {@link JsonListsCommandOutput} for command's `response` shape. + * @see {@link RestJsonProtocolClientResolvedConfig | config} for command's `input` shape. + * */ export class JsonListsCommand extends $Command< JsonListsCommandInput, diff --git a/protocol_tests/aws-restjson/commands/JsonMapsCommand.ts b/protocol_tests/aws-restjson/commands/JsonMapsCommand.ts index 1844df6db8ec..ad0485e94b49 100644 --- a/protocol_tests/aws-restjson/commands/JsonMapsCommand.ts +++ b/protocol_tests/aws-restjson/commands/JsonMapsCommand.ts @@ -22,6 +22,20 @@ export interface JsonMapsCommandOutput extends JsonMapsInputOutput, __MetadataBe /** * The example tests basic map serialization. + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { RestJsonProtocolClient, JsonMapsCommand } from "@aws-sdk/aws-restjson"; // ES Modules import + * // const { RestJsonProtocolClient, JsonMapsCommand } = require("@aws-sdk/aws-restjson"); // CommonJS import + * const client = new RestJsonProtocolClient(config); + * const command = new JsonMapsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link JsonMapsCommandInput} for command's `input` shape. + * @see {@link JsonMapsCommandOutput} for command's `response` shape. + * @see {@link RestJsonProtocolClientResolvedConfig | config} for command's `input` shape. + * */ export class JsonMapsCommand extends $Command< JsonMapsCommandInput, diff --git a/protocol_tests/aws-restjson/commands/JsonTimestampsCommand.ts b/protocol_tests/aws-restjson/commands/JsonTimestampsCommand.ts index 51b4d80e6dc0..24e72bfe15ac 100644 --- a/protocol_tests/aws-restjson/commands/JsonTimestampsCommand.ts +++ b/protocol_tests/aws-restjson/commands/JsonTimestampsCommand.ts @@ -24,6 +24,20 @@ export interface JsonTimestampsCommandOutput extends JsonTimestampsInputOutput, * This tests how timestamps are serialized, including using the * default format of date-time and various @timestampFormat trait * values. + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { RestJsonProtocolClient, JsonTimestampsCommand } from "@aws-sdk/aws-restjson"; // ES Modules import + * // const { RestJsonProtocolClient, JsonTimestampsCommand } = require("@aws-sdk/aws-restjson"); // CommonJS import + * const client = new RestJsonProtocolClient(config); + * const command = new JsonTimestampsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link JsonTimestampsCommandInput} for command's `input` shape. + * @see {@link JsonTimestampsCommandOutput} for command's `response` shape. + * @see {@link RestJsonProtocolClientResolvedConfig | config} for command's `input` shape. + * */ export class JsonTimestampsCommand extends $Command< JsonTimestampsCommandInput, diff --git a/protocol_tests/aws-restjson/commands/JsonUnionsCommand.ts b/protocol_tests/aws-restjson/commands/JsonUnionsCommand.ts index a7dc67d1a1a2..b684ccb55877 100644 --- a/protocol_tests/aws-restjson/commands/JsonUnionsCommand.ts +++ b/protocol_tests/aws-restjson/commands/JsonUnionsCommand.ts @@ -22,6 +22,20 @@ export interface JsonUnionsCommandOutput extends UnionInputOutput, __MetadataBea /** * This operation uses unions for inputs and outputs. + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { RestJsonProtocolClient, JsonUnionsCommand } from "@aws-sdk/aws-restjson"; // ES Modules import + * // const { RestJsonProtocolClient, JsonUnionsCommand } = require("@aws-sdk/aws-restjson"); // CommonJS import + * const client = new RestJsonProtocolClient(config); + * const command = new JsonUnionsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link JsonUnionsCommandInput} for command's `input` shape. + * @see {@link JsonUnionsCommandOutput} for command's `response` shape. + * @see {@link RestJsonProtocolClientResolvedConfig | config} for command's `input` shape. + * */ export class JsonUnionsCommand extends $Command< JsonUnionsCommandInput, diff --git a/protocol_tests/aws-restjson/commands/MediaTypeHeaderCommand.ts b/protocol_tests/aws-restjson/commands/MediaTypeHeaderCommand.ts index e26d70026ef9..42f144efb0cb 100644 --- a/protocol_tests/aws-restjson/commands/MediaTypeHeaderCommand.ts +++ b/protocol_tests/aws-restjson/commands/MediaTypeHeaderCommand.ts @@ -22,6 +22,20 @@ export interface MediaTypeHeaderCommandOutput extends MediaTypeHeaderOutput, __M /** * This example ensures that mediaType strings are base64 encoded in headers. + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { RestJsonProtocolClient, MediaTypeHeaderCommand } from "@aws-sdk/aws-restjson"; // ES Modules import + * // const { RestJsonProtocolClient, MediaTypeHeaderCommand } = require("@aws-sdk/aws-restjson"); // CommonJS import + * const client = new RestJsonProtocolClient(config); + * const command = new MediaTypeHeaderCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link MediaTypeHeaderCommandInput} for command's `input` shape. + * @see {@link MediaTypeHeaderCommandOutput} for command's `response` shape. + * @see {@link RestJsonProtocolClientResolvedConfig | config} for command's `input` shape. + * */ export class MediaTypeHeaderCommand extends $Command< MediaTypeHeaderCommandInput, diff --git a/protocol_tests/aws-restjson/commands/NoInputAndNoOutputCommand.ts b/protocol_tests/aws-restjson/commands/NoInputAndNoOutputCommand.ts index b54751cbe290..e35bb0d5388e 100644 --- a/protocol_tests/aws-restjson/commands/NoInputAndNoOutputCommand.ts +++ b/protocol_tests/aws-restjson/commands/NoInputAndNoOutputCommand.ts @@ -23,6 +23,20 @@ export interface NoInputAndNoOutputCommandOutput extends __MetadataBearer {} * 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. + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { RestJsonProtocolClient, NoInputAndNoOutputCommand } from "@aws-sdk/aws-restjson"; // ES Modules import + * // const { RestJsonProtocolClient, NoInputAndNoOutputCommand } = require("@aws-sdk/aws-restjson"); // CommonJS import + * const client = new RestJsonProtocolClient(config); + * const command = new NoInputAndNoOutputCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link NoInputAndNoOutputCommandInput} for command's `input` shape. + * @see {@link NoInputAndNoOutputCommandOutput} for command's `response` shape. + * @see {@link RestJsonProtocolClientResolvedConfig | config} for command's `input` shape. + * */ export class NoInputAndNoOutputCommand extends $Command< NoInputAndNoOutputCommandInput, diff --git a/protocol_tests/aws-restjson/commands/NoInputAndOutputCommand.ts b/protocol_tests/aws-restjson/commands/NoInputAndOutputCommand.ts index 3290447ea73c..38c4f99c1778 100644 --- a/protocol_tests/aws-restjson/commands/NoInputAndOutputCommand.ts +++ b/protocol_tests/aws-restjson/commands/NoInputAndOutputCommand.ts @@ -25,6 +25,20 @@ export interface NoInputAndOutputCommandOutput extends NoInputAndOutputOutput, _ * 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. + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { RestJsonProtocolClient, NoInputAndOutputCommand } from "@aws-sdk/aws-restjson"; // ES Modules import + * // const { RestJsonProtocolClient, NoInputAndOutputCommand } = require("@aws-sdk/aws-restjson"); // CommonJS import + * const client = new RestJsonProtocolClient(config); + * const command = new NoInputAndOutputCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link NoInputAndOutputCommandInput} for command's `input` shape. + * @see {@link NoInputAndOutputCommandOutput} for command's `response` shape. + * @see {@link RestJsonProtocolClientResolvedConfig | config} for command's `input` shape. + * */ export class NoInputAndOutputCommand extends $Command< NoInputAndOutputCommandInput, diff --git a/protocol_tests/aws-restjson/commands/NullAndEmptyHeadersClientCommand.ts b/protocol_tests/aws-restjson/commands/NullAndEmptyHeadersClientCommand.ts index c3e0508f2e9b..1fc8a8986399 100644 --- a/protocol_tests/aws-restjson/commands/NullAndEmptyHeadersClientCommand.ts +++ b/protocol_tests/aws-restjson/commands/NullAndEmptyHeadersClientCommand.ts @@ -22,6 +22,20 @@ export interface NullAndEmptyHeadersClientCommandOutput extends NullAndEmptyHead /** * Null and empty headers are not sent over the wire. + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { RestJsonProtocolClient, NullAndEmptyHeadersClientCommand } from "@aws-sdk/aws-restjson"; // ES Modules import + * // const { RestJsonProtocolClient, NullAndEmptyHeadersClientCommand } = require("@aws-sdk/aws-restjson"); // CommonJS import + * const client = new RestJsonProtocolClient(config); + * const command = new NullAndEmptyHeadersClientCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link NullAndEmptyHeadersClientCommandInput} for command's `input` shape. + * @see {@link NullAndEmptyHeadersClientCommandOutput} for command's `response` shape. + * @see {@link RestJsonProtocolClientResolvedConfig | config} for command's `input` shape. + * */ export class NullAndEmptyHeadersClientCommand extends $Command< NullAndEmptyHeadersClientCommandInput, diff --git a/protocol_tests/aws-restjson/commands/NullAndEmptyHeadersServerCommand.ts b/protocol_tests/aws-restjson/commands/NullAndEmptyHeadersServerCommand.ts index 7b13eda405cb..57440b9ee914 100644 --- a/protocol_tests/aws-restjson/commands/NullAndEmptyHeadersServerCommand.ts +++ b/protocol_tests/aws-restjson/commands/NullAndEmptyHeadersServerCommand.ts @@ -22,6 +22,20 @@ export interface NullAndEmptyHeadersServerCommandOutput extends NullAndEmptyHead /** * Null and empty headers are not sent over the wire. + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { RestJsonProtocolClient, NullAndEmptyHeadersServerCommand } from "@aws-sdk/aws-restjson"; // ES Modules import + * // const { RestJsonProtocolClient, NullAndEmptyHeadersServerCommand } = require("@aws-sdk/aws-restjson"); // CommonJS import + * const client = new RestJsonProtocolClient(config); + * const command = new NullAndEmptyHeadersServerCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link NullAndEmptyHeadersServerCommandInput} for command's `input` shape. + * @see {@link NullAndEmptyHeadersServerCommandOutput} for command's `response` shape. + * @see {@link RestJsonProtocolClientResolvedConfig | config} for command's `input` shape. + * */ export class NullAndEmptyHeadersServerCommand extends $Command< NullAndEmptyHeadersServerCommandInput, diff --git a/protocol_tests/aws-restjson/commands/OmitsNullSerializesEmptyStringCommand.ts b/protocol_tests/aws-restjson/commands/OmitsNullSerializesEmptyStringCommand.ts index 4a2d3298196a..b4a2a6b87aae 100644 --- a/protocol_tests/aws-restjson/commands/OmitsNullSerializesEmptyStringCommand.ts +++ b/protocol_tests/aws-restjson/commands/OmitsNullSerializesEmptyStringCommand.ts @@ -22,6 +22,20 @@ export interface OmitsNullSerializesEmptyStringCommandOutput extends __MetadataB /** * Omits null, but serializes empty string value. + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { RestJsonProtocolClient, OmitsNullSerializesEmptyStringCommand } from "@aws-sdk/aws-restjson"; // ES Modules import + * // const { RestJsonProtocolClient, OmitsNullSerializesEmptyStringCommand } = require("@aws-sdk/aws-restjson"); // CommonJS import + * const client = new RestJsonProtocolClient(config); + * const command = new OmitsNullSerializesEmptyStringCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link OmitsNullSerializesEmptyStringCommandInput} for command's `input` shape. + * @see {@link OmitsNullSerializesEmptyStringCommandOutput} for command's `response` shape. + * @see {@link RestJsonProtocolClientResolvedConfig | config} for command's `input` shape. + * */ export class OmitsNullSerializesEmptyStringCommand extends $Command< OmitsNullSerializesEmptyStringCommandInput, diff --git a/protocol_tests/aws-restjson/commands/QueryIdempotencyTokenAutoFillCommand.ts b/protocol_tests/aws-restjson/commands/QueryIdempotencyTokenAutoFillCommand.ts index 890df6dbad8a..39c83251a4c8 100644 --- a/protocol_tests/aws-restjson/commands/QueryIdempotencyTokenAutoFillCommand.ts +++ b/protocol_tests/aws-restjson/commands/QueryIdempotencyTokenAutoFillCommand.ts @@ -22,6 +22,20 @@ export interface QueryIdempotencyTokenAutoFillCommandOutput extends __MetadataBe /** * Automatically adds idempotency tokens. + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { RestJsonProtocolClient, QueryIdempotencyTokenAutoFillCommand } from "@aws-sdk/aws-restjson"; // ES Modules import + * // const { RestJsonProtocolClient, QueryIdempotencyTokenAutoFillCommand } = require("@aws-sdk/aws-restjson"); // CommonJS import + * const client = new RestJsonProtocolClient(config); + * const command = new QueryIdempotencyTokenAutoFillCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link QueryIdempotencyTokenAutoFillCommandInput} for command's `input` shape. + * @see {@link QueryIdempotencyTokenAutoFillCommandOutput} for command's `response` shape. + * @see {@link RestJsonProtocolClientResolvedConfig | config} for command's `input` shape. + * */ export class QueryIdempotencyTokenAutoFillCommand extends $Command< QueryIdempotencyTokenAutoFillCommandInput, diff --git a/protocol_tests/aws-restjson/commands/RecursiveShapesCommand.ts b/protocol_tests/aws-restjson/commands/RecursiveShapesCommand.ts index bc22a4419563..e4f939dd129a 100644 --- a/protocol_tests/aws-restjson/commands/RecursiveShapesCommand.ts +++ b/protocol_tests/aws-restjson/commands/RecursiveShapesCommand.ts @@ -22,6 +22,20 @@ export interface RecursiveShapesCommandOutput extends RecursiveShapesInputOutput /** * Recursive shapes + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { RestJsonProtocolClient, RecursiveShapesCommand } from "@aws-sdk/aws-restjson"; // ES Modules import + * // const { RestJsonProtocolClient, RecursiveShapesCommand } = require("@aws-sdk/aws-restjson"); // CommonJS import + * const client = new RestJsonProtocolClient(config); + * const command = new RecursiveShapesCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link RecursiveShapesCommandInput} for command's `input` shape. + * @see {@link RecursiveShapesCommandOutput} for command's `response` shape. + * @see {@link RestJsonProtocolClientResolvedConfig | config} for command's `input` shape. + * */ export class RecursiveShapesCommand extends $Command< RecursiveShapesCommandInput, diff --git a/protocol_tests/aws-restjson/commands/StreamingTraitsCommand.ts b/protocol_tests/aws-restjson/commands/StreamingTraitsCommand.ts index 82075bb8df40..acdc3dda93ad 100644 --- a/protocol_tests/aws-restjson/commands/StreamingTraitsCommand.ts +++ b/protocol_tests/aws-restjson/commands/StreamingTraitsCommand.ts @@ -34,6 +34,20 @@ export interface StreamingTraitsCommandOutput extends StreamingTraitsInputOutput * * In this example, no JSON document is synthesized because the payload is * not a structure or a union type. + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { RestJsonProtocolClient, StreamingTraitsCommand } from "@aws-sdk/aws-restjson"; // ES Modules import + * // const { RestJsonProtocolClient, StreamingTraitsCommand } = require("@aws-sdk/aws-restjson"); // CommonJS import + * const client = new RestJsonProtocolClient(config); + * const command = new StreamingTraitsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link StreamingTraitsCommandInput} for command's `input` shape. + * @see {@link StreamingTraitsCommandOutput} for command's `response` shape. + * @see {@link RestJsonProtocolClientResolvedConfig | config} for command's `input` shape. + * */ export class StreamingTraitsCommand extends $Command< StreamingTraitsCommandInput, diff --git a/protocol_tests/aws-restjson/commands/StreamingTraitsRequireLengthCommand.ts b/protocol_tests/aws-restjson/commands/StreamingTraitsRequireLengthCommand.ts index 1bb0e378470e..f0c673e455be 100644 --- a/protocol_tests/aws-restjson/commands/StreamingTraitsRequireLengthCommand.ts +++ b/protocol_tests/aws-restjson/commands/StreamingTraitsRequireLengthCommand.ts @@ -37,6 +37,20 @@ export interface StreamingTraitsRequireLengthCommandOutput * * In this example, no JSON document is synthesized because the payload is * not a structure or a union type. + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { RestJsonProtocolClient, StreamingTraitsRequireLengthCommand } from "@aws-sdk/aws-restjson"; // ES Modules import + * // const { RestJsonProtocolClient, StreamingTraitsRequireLengthCommand } = require("@aws-sdk/aws-restjson"); // CommonJS import + * const client = new RestJsonProtocolClient(config); + * const command = new StreamingTraitsRequireLengthCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link StreamingTraitsRequireLengthCommandInput} for command's `input` shape. + * @see {@link StreamingTraitsRequireLengthCommandOutput} for command's `response` shape. + * @see {@link RestJsonProtocolClientResolvedConfig | config} for command's `input` shape. + * */ export class StreamingTraitsRequireLengthCommand extends $Command< StreamingTraitsRequireLengthCommandInput, diff --git a/protocol_tests/aws-restjson/commands/StreamingTraitsWithMediaTypeCommand.ts b/protocol_tests/aws-restjson/commands/StreamingTraitsWithMediaTypeCommand.ts index f9d89180135a..023d54924fd4 100644 --- a/protocol_tests/aws-restjson/commands/StreamingTraitsWithMediaTypeCommand.ts +++ b/protocol_tests/aws-restjson/commands/StreamingTraitsWithMediaTypeCommand.ts @@ -36,6 +36,20 @@ export interface StreamingTraitsWithMediaTypeCommandOutput * * This examples uses a `@mediaType` trait on the payload to force a custom * content-type to be serialized. + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { RestJsonProtocolClient, StreamingTraitsWithMediaTypeCommand } from "@aws-sdk/aws-restjson"; // ES Modules import + * // const { RestJsonProtocolClient, StreamingTraitsWithMediaTypeCommand } = require("@aws-sdk/aws-restjson"); // CommonJS import + * const client = new RestJsonProtocolClient(config); + * const command = new StreamingTraitsWithMediaTypeCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link StreamingTraitsWithMediaTypeCommandInput} for command's `input` shape. + * @see {@link StreamingTraitsWithMediaTypeCommandOutput} for command's `response` shape. + * @see {@link RestJsonProtocolClientResolvedConfig | config} for command's `input` shape. + * */ export class StreamingTraitsWithMediaTypeCommand extends $Command< StreamingTraitsWithMediaTypeCommandInput, diff --git a/protocol_tests/aws-restjson/commands/TimestampFormatHeadersCommand.ts b/protocol_tests/aws-restjson/commands/TimestampFormatHeadersCommand.ts index 1660fd2ee23e..baa6aaeb0b9d 100644 --- a/protocol_tests/aws-restjson/commands/TimestampFormatHeadersCommand.ts +++ b/protocol_tests/aws-restjson/commands/TimestampFormatHeadersCommand.ts @@ -22,6 +22,20 @@ export interface TimestampFormatHeadersCommandOutput extends TimestampFormatHead /** * This example tests how timestamp request and response headers are serialized. + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { RestJsonProtocolClient, TimestampFormatHeadersCommand } from "@aws-sdk/aws-restjson"; // ES Modules import + * // const { RestJsonProtocolClient, TimestampFormatHeadersCommand } = require("@aws-sdk/aws-restjson"); // CommonJS import + * const client = new RestJsonProtocolClient(config); + * const command = new TimestampFormatHeadersCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link TimestampFormatHeadersCommandInput} for command's `input` shape. + * @see {@link TimestampFormatHeadersCommandOutput} for command's `response` shape. + * @see {@link RestJsonProtocolClientResolvedConfig | config} for command's `input` shape. + * */ export class TimestampFormatHeadersCommand extends $Command< TimestampFormatHeadersCommandInput, diff --git a/protocol_tests/aws-restjson/models/models_0.ts b/protocol_tests/aws-restjson/models/models_0.ts index 081189bb3b98..6d6e70a7c3d6 100644 --- a/protocol_tests/aws-restjson/models/models_0.ts +++ b/protocol_tests/aws-restjson/models/models_0.ts @@ -37,6 +37,9 @@ export interface AllQueryStringTypesInput { } export namespace AllQueryStringTypesInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: AllQueryStringTypesInput): any => ({ ...obj, }); @@ -47,6 +50,9 @@ export interface ComplexNestedErrorData { } export namespace ComplexNestedErrorData { + /** + * @internal + */ export const filterSensitiveLog = (obj: ComplexNestedErrorData): any => ({ ...obj, }); @@ -64,6 +70,9 @@ export interface ComplexError extends __SmithyException, $MetadataBearer { } export namespace ComplexError { + /** + * @internal + */ export const filterSensitiveLog = (obj: ComplexError): any => ({ ...obj, }); @@ -75,6 +84,9 @@ export interface ConstantAndVariableQueryStringInput { } export namespace ConstantAndVariableQueryStringInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: ConstantAndVariableQueryStringInput): any => ({ ...obj, }); @@ -85,6 +97,9 @@ export interface ConstantQueryStringInput { } export namespace ConstantQueryStringInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: ConstantQueryStringInput): any => ({ ...obj, }); @@ -95,6 +110,9 @@ export interface GreetingStruct { } export namespace GreetingStruct { + /** + * @internal + */ export const filterSensitiveLog = (obj: GreetingStruct): any => ({ ...obj, }); @@ -103,6 +121,9 @@ export namespace GreetingStruct { export interface EmptyInputAndEmptyOutputInput {} export namespace EmptyInputAndEmptyOutputInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: EmptyInputAndEmptyOutputInput): any => ({ ...obj, }); @@ -111,6 +132,9 @@ export namespace EmptyInputAndEmptyOutputInput { export interface EmptyInputAndEmptyOutputOutput {} export namespace EmptyInputAndEmptyOutputOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: EmptyInputAndEmptyOutputOutput): any => ({ ...obj, }); @@ -121,6 +145,9 @@ export interface HostLabelInput { } export namespace HostLabelInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: HostLabelInput): any => ({ ...obj, }); @@ -135,6 +162,9 @@ export interface EnumPayloadInput { } export namespace EnumPayloadInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: EnumPayloadInput): any => ({ ...obj, }); @@ -150,6 +180,9 @@ export interface FooError extends __SmithyException, $MetadataBearer { } export namespace FooError { + /** + * @internal + */ export const filterSensitiveLog = (obj: FooError): any => ({ ...obj, }); @@ -160,6 +193,9 @@ export interface GreetingWithErrorsOutput { } export namespace GreetingWithErrorsOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: GreetingWithErrorsOutput): any => ({ ...obj, }); @@ -175,6 +211,9 @@ export interface InvalidGreeting extends __SmithyException, $MetadataBearer { } export namespace InvalidGreeting { + /** + * @internal + */ export const filterSensitiveLog = (obj: InvalidGreeting): any => ({ ...obj, }); @@ -186,6 +225,9 @@ export interface HttpPayloadTraitsInputOutput { } export namespace HttpPayloadTraitsInputOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: HttpPayloadTraitsInputOutput): any => ({ ...obj, }); @@ -197,6 +239,9 @@ export interface HttpPayloadTraitsWithMediaTypeInputOutput { } export namespace HttpPayloadTraitsWithMediaTypeInputOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: HttpPayloadTraitsWithMediaTypeInputOutput): any => ({ ...obj, }); @@ -208,6 +253,9 @@ export interface NestedPayload { } export namespace NestedPayload { + /** + * @internal + */ export const filterSensitiveLog = (obj: NestedPayload): any => ({ ...obj, }); @@ -218,6 +266,9 @@ export interface HttpPayloadWithStructureInputOutput { } export namespace HttpPayloadWithStructureInputOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: HttpPayloadWithStructureInputOutput): any => ({ ...obj, }); @@ -229,6 +280,9 @@ export interface HttpPrefixHeadersInputOutput { } export namespace HttpPrefixHeadersInputOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: HttpPrefixHeadersInputOutput): any => ({ ...obj, }); @@ -239,6 +293,9 @@ export interface HttpPrefixHeadersResponseOutput { } export namespace HttpPrefixHeadersResponseOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: HttpPrefixHeadersResponseOutput): any => ({ ...obj, }); @@ -250,6 +307,9 @@ export interface HttpRequestWithGreedyLabelInPathInput { } export namespace HttpRequestWithGreedyLabelInPathInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: HttpRequestWithGreedyLabelInPathInput): any => ({ ...obj, }); @@ -274,6 +334,9 @@ export interface HttpRequestWithLabelsInput { } export namespace HttpRequestWithLabelsInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: HttpRequestWithLabelsInput): any => ({ ...obj, }); @@ -290,6 +353,9 @@ export interface HttpRequestWithLabelsAndTimestampFormatInput { } export namespace HttpRequestWithLabelsAndTimestampFormatInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: HttpRequestWithLabelsAndTimestampFormatInput): any => ({ ...obj, }); @@ -300,6 +366,9 @@ export interface HttpResponseCodeOutput { } export namespace HttpResponseCodeOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: HttpResponseCodeOutput): any => ({ ...obj, }); @@ -310,6 +379,9 @@ export interface StringPayloadInput { } export namespace StringPayloadInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: StringPayloadInput): any => ({ ...obj, }); @@ -320,6 +392,9 @@ export interface IgnoreQueryParamsInResponseOutput { } export namespace IgnoreQueryParamsInResponseOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: IgnoreQueryParamsInResponseOutput): any => ({ ...obj, }); @@ -331,6 +406,9 @@ export interface InlineDocumentInputOutput { } export namespace InlineDocumentInputOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: InlineDocumentInputOutput): any => ({ ...obj, }); @@ -341,6 +419,9 @@ export interface InlineDocumentAsPayloadInputOutput { } export namespace InlineDocumentAsPayloadInputOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: InlineDocumentAsPayloadInputOutput): any => ({ ...obj, }); @@ -366,6 +447,9 @@ export interface InputAndOutputWithHeadersIO { } export namespace InputAndOutputWithHeadersIO { + /** + * @internal + */ export const filterSensitiveLog = (obj: InputAndOutputWithHeadersIO): any => ({ ...obj, }); @@ -376,6 +460,9 @@ export interface JsonBlobsInputOutput { } export namespace JsonBlobsInputOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: JsonBlobsInputOutput): any => ({ ...obj, }); @@ -391,6 +478,9 @@ export interface JsonEnumsInputOutput { } export namespace JsonEnumsInputOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: JsonEnumsInputOutput): any => ({ ...obj, }); @@ -402,6 +492,9 @@ export interface StructureListMember { } export namespace StructureListMember { + /** + * @internal + */ export const filterSensitiveLog = (obj: StructureListMember): any => ({ ...obj, }); @@ -424,6 +517,9 @@ export interface JsonListsInputOutput { } export namespace JsonListsInputOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: JsonListsInputOutput): any => ({ ...obj, }); @@ -441,6 +537,9 @@ export interface JsonMapsInputOutput { } export namespace JsonMapsInputOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: JsonMapsInputOutput): any => ({ ...obj, }); @@ -454,6 +553,9 @@ export interface JsonTimestampsInputOutput { } export namespace JsonTimestampsInputOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: JsonTimestampsInputOutput): any => ({ ...obj, }); @@ -464,6 +566,9 @@ export interface RenamedGreeting { } export namespace RenamedGreeting { + /** + * @internal + */ export const filterSensitiveLog = (obj: RenamedGreeting): any => ({ ...obj, }); @@ -668,6 +773,9 @@ export namespace MyUnion { return visitor._(value.$unknown[0], value.$unknown[1]); }; + /** + * @internal + */ export const filterSensitiveLog = (obj: MyUnion): any => { if (obj.stringValue !== undefined) return { stringValue: obj.stringValue }; if (obj.booleanValue !== undefined) return { booleanValue: obj.booleanValue }; @@ -696,6 +804,9 @@ export interface UnionInputOutput { } export namespace UnionInputOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: UnionInputOutput): any => ({ ...obj, ...(obj.contents && { contents: MyUnion.filterSensitiveLog(obj.contents) }), @@ -707,6 +818,9 @@ export interface MediaTypeHeaderInput { } export namespace MediaTypeHeaderInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: MediaTypeHeaderInput): any => ({ ...obj, }); @@ -717,6 +831,9 @@ export interface MediaTypeHeaderOutput { } export namespace MediaTypeHeaderOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: MediaTypeHeaderOutput): any => ({ ...obj, }); @@ -725,6 +842,9 @@ export namespace MediaTypeHeaderOutput { export interface NoInputAndOutputOutput {} export namespace NoInputAndOutputOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: NoInputAndOutputOutput): any => ({ ...obj, }); @@ -737,6 +857,9 @@ export interface NullAndEmptyHeadersIO { } export namespace NullAndEmptyHeadersIO { + /** + * @internal + */ export const filterSensitiveLog = (obj: NullAndEmptyHeadersIO): any => ({ ...obj, }); @@ -748,6 +871,9 @@ export interface OmitsNullSerializesEmptyStringInput { } export namespace OmitsNullSerializesEmptyStringInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: OmitsNullSerializesEmptyStringInput): any => ({ ...obj, }); @@ -758,6 +884,9 @@ export interface QueryIdempotencyTokenAutoFillInput { } export namespace QueryIdempotencyTokenAutoFillInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: QueryIdempotencyTokenAutoFillInput): any => ({ ...obj, }); @@ -769,6 +898,9 @@ export interface QueryParamsAsStringListMapInput { } export namespace QueryParamsAsStringListMapInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: QueryParamsAsStringListMapInput): any => ({ ...obj, }); @@ -780,6 +912,9 @@ export interface QueryPrecedenceInput { } export namespace QueryPrecedenceInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: QueryPrecedenceInput): any => ({ ...obj, }); @@ -799,6 +934,9 @@ export interface SimpleScalarPropertiesInputOutput { } export namespace SimpleScalarPropertiesInputOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: SimpleScalarPropertiesInputOutput): any => ({ ...obj, }); @@ -810,6 +948,9 @@ export interface StreamingTraitsInputOutput { } export namespace StreamingTraitsInputOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: StreamingTraitsInputOutput): any => ({ ...obj, }); @@ -821,6 +962,9 @@ export interface StreamingTraitsRequireLengthInputOutput { } export namespace StreamingTraitsRequireLengthInputOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: StreamingTraitsRequireLengthInputOutput): any => ({ ...obj, }); @@ -832,6 +976,9 @@ export interface StreamingTraitsWithMediaTypeInputOutput { } export namespace StreamingTraitsWithMediaTypeInputOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: StreamingTraitsWithMediaTypeInputOutput): any => ({ ...obj, }); @@ -848,6 +995,9 @@ export interface TimestampFormatHeadersIO { } export namespace TimestampFormatHeadersIO { + /** + * @internal + */ export const filterSensitiveLog = (obj: TimestampFormatHeadersIO): any => ({ ...obj, }); @@ -859,6 +1009,9 @@ export interface RecursiveShapesInputOutputNested1 { } export namespace RecursiveShapesInputOutputNested1 { + /** + * @internal + */ export const filterSensitiveLog = (obj: RecursiveShapesInputOutputNested1): any => ({ ...obj, }); @@ -870,6 +1023,9 @@ export interface RecursiveShapesInputOutputNested2 { } export namespace RecursiveShapesInputOutputNested2 { + /** + * @internal + */ export const filterSensitiveLog = (obj: RecursiveShapesInputOutputNested2): any => ({ ...obj, }); @@ -880,6 +1036,9 @@ export interface RecursiveShapesInputOutput { } export namespace RecursiveShapesInputOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: RecursiveShapesInputOutput): any => ({ ...obj, }); diff --git a/protocol_tests/aws-restxml/commands/AllQueryStringTypesCommand.ts b/protocol_tests/aws-restxml/commands/AllQueryStringTypesCommand.ts index 13b21bc44c82..ade82a87cbcd 100644 --- a/protocol_tests/aws-restxml/commands/AllQueryStringTypesCommand.ts +++ b/protocol_tests/aws-restxml/commands/AllQueryStringTypesCommand.ts @@ -22,6 +22,20 @@ export interface AllQueryStringTypesCommandOutput extends __MetadataBearer {} /** * This example uses all query string types. + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { RestXmlProtocolClient, AllQueryStringTypesCommand } from "@aws-sdk/aws-restxml"; // ES Modules import + * // const { RestXmlProtocolClient, AllQueryStringTypesCommand } = require("@aws-sdk/aws-restxml"); // CommonJS import + * const client = new RestXmlProtocolClient(config); + * const command = new AllQueryStringTypesCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link AllQueryStringTypesCommandInput} for command's `input` shape. + * @see {@link AllQueryStringTypesCommandOutput} for command's `response` shape. + * @see {@link RestXmlProtocolClientResolvedConfig | config} for command's `input` shape. + * */ export class AllQueryStringTypesCommand extends $Command< AllQueryStringTypesCommandInput, diff --git a/protocol_tests/aws-restxml/commands/ConstantAndVariableQueryStringCommand.ts b/protocol_tests/aws-restxml/commands/ConstantAndVariableQueryStringCommand.ts index 49f3c12f4920..41266dcf3f68 100644 --- a/protocol_tests/aws-restxml/commands/ConstantAndVariableQueryStringCommand.ts +++ b/protocol_tests/aws-restxml/commands/ConstantAndVariableQueryStringCommand.ts @@ -24,6 +24,20 @@ export interface ConstantAndVariableQueryStringCommandOutput extends __MetadataB * 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). + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { RestXmlProtocolClient, ConstantAndVariableQueryStringCommand } from "@aws-sdk/aws-restxml"; // ES Modules import + * // const { RestXmlProtocolClient, ConstantAndVariableQueryStringCommand } = require("@aws-sdk/aws-restxml"); // CommonJS import + * const client = new RestXmlProtocolClient(config); + * const command = new ConstantAndVariableQueryStringCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ConstantAndVariableQueryStringCommandInput} for command's `input` shape. + * @see {@link ConstantAndVariableQueryStringCommandOutput} for command's `response` shape. + * @see {@link RestXmlProtocolClientResolvedConfig | config} for command's `input` shape. + * */ export class ConstantAndVariableQueryStringCommand extends $Command< ConstantAndVariableQueryStringCommandInput, diff --git a/protocol_tests/aws-restxml/commands/ConstantQueryStringCommand.ts b/protocol_tests/aws-restxml/commands/ConstantQueryStringCommand.ts index 370eca304bcf..f57ebad27ecc 100644 --- a/protocol_tests/aws-restxml/commands/ConstantQueryStringCommand.ts +++ b/protocol_tests/aws-restxml/commands/ConstantQueryStringCommand.ts @@ -25,6 +25,20 @@ export interface ConstantQueryStringCommandOutput extends __MetadataBearer {} * 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}`. + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { RestXmlProtocolClient, ConstantQueryStringCommand } from "@aws-sdk/aws-restxml"; // ES Modules import + * // const { RestXmlProtocolClient, ConstantQueryStringCommand } = require("@aws-sdk/aws-restxml"); // CommonJS import + * const client = new RestXmlProtocolClient(config); + * const command = new ConstantQueryStringCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ConstantQueryStringCommandInput} for command's `input` shape. + * @see {@link ConstantQueryStringCommandOutput} for command's `response` shape. + * @see {@link RestXmlProtocolClientResolvedConfig | config} for command's `input` shape. + * */ export class ConstantQueryStringCommand extends $Command< ConstantQueryStringCommandInput, diff --git a/protocol_tests/aws-restxml/commands/EmptyInputAndEmptyOutputCommand.ts b/protocol_tests/aws-restxml/commands/EmptyInputAndEmptyOutputCommand.ts index 07ac5b645611..0db0cda82e55 100644 --- a/protocol_tests/aws-restxml/commands/EmptyInputAndEmptyOutputCommand.ts +++ b/protocol_tests/aws-restxml/commands/EmptyInputAndEmptyOutputCommand.ts @@ -25,6 +25,20 @@ export interface EmptyInputAndEmptyOutputCommandOutput extends EmptyInputAndEmpt * 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. + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { RestXmlProtocolClient, EmptyInputAndEmptyOutputCommand } from "@aws-sdk/aws-restxml"; // ES Modules import + * // const { RestXmlProtocolClient, EmptyInputAndEmptyOutputCommand } = require("@aws-sdk/aws-restxml"); // CommonJS import + * const client = new RestXmlProtocolClient(config); + * const command = new EmptyInputAndEmptyOutputCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link EmptyInputAndEmptyOutputCommandInput} for command's `input` shape. + * @see {@link EmptyInputAndEmptyOutputCommandOutput} for command's `response` shape. + * @see {@link RestXmlProtocolClientResolvedConfig | config} for command's `input` shape. + * */ export class EmptyInputAndEmptyOutputCommand extends $Command< EmptyInputAndEmptyOutputCommandInput, diff --git a/protocol_tests/aws-restxml/commands/FlattenedXmlMapCommand.ts b/protocol_tests/aws-restxml/commands/FlattenedXmlMapCommand.ts index 2604cc008af7..85e3d224623c 100644 --- a/protocol_tests/aws-restxml/commands/FlattenedXmlMapCommand.ts +++ b/protocol_tests/aws-restxml/commands/FlattenedXmlMapCommand.ts @@ -22,6 +22,20 @@ export interface FlattenedXmlMapCommandOutput extends FlattenedXmlMapInputOutput /** * Flattened maps + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { RestXmlProtocolClient, FlattenedXmlMapCommand } from "@aws-sdk/aws-restxml"; // ES Modules import + * // const { RestXmlProtocolClient, FlattenedXmlMapCommand } = require("@aws-sdk/aws-restxml"); // CommonJS import + * const client = new RestXmlProtocolClient(config); + * const command = new FlattenedXmlMapCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link FlattenedXmlMapCommandInput} for command's `input` shape. + * @see {@link FlattenedXmlMapCommandOutput} for command's `response` shape. + * @see {@link RestXmlProtocolClientResolvedConfig | config} for command's `input` shape. + * */ export class FlattenedXmlMapCommand extends $Command< FlattenedXmlMapCommandInput, diff --git a/protocol_tests/aws-restxml/commands/FlattenedXmlMapWithXmlNameCommand.ts b/protocol_tests/aws-restxml/commands/FlattenedXmlMapWithXmlNameCommand.ts index 8332954eb175..905c086a226e 100644 --- a/protocol_tests/aws-restxml/commands/FlattenedXmlMapWithXmlNameCommand.ts +++ b/protocol_tests/aws-restxml/commands/FlattenedXmlMapWithXmlNameCommand.ts @@ -24,6 +24,20 @@ export interface FlattenedXmlMapWithXmlNameCommandOutput /** * Flattened maps with @xmlName + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { RestXmlProtocolClient, FlattenedXmlMapWithXmlNameCommand } from "@aws-sdk/aws-restxml"; // ES Modules import + * // const { RestXmlProtocolClient, FlattenedXmlMapWithXmlNameCommand } = require("@aws-sdk/aws-restxml"); // CommonJS import + * const client = new RestXmlProtocolClient(config); + * const command = new FlattenedXmlMapWithXmlNameCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link FlattenedXmlMapWithXmlNameCommandInput} for command's `input` shape. + * @see {@link FlattenedXmlMapWithXmlNameCommandOutput} for command's `response` shape. + * @see {@link RestXmlProtocolClientResolvedConfig | config} for command's `input` shape. + * */ export class FlattenedXmlMapWithXmlNameCommand extends $Command< FlattenedXmlMapWithXmlNameCommandInput, diff --git a/protocol_tests/aws-restxml/commands/FlattenedXmlMapWithXmlNamespaceCommand.ts b/protocol_tests/aws-restxml/commands/FlattenedXmlMapWithXmlNamespaceCommand.ts index 09ab3abbdeb6..ddb4ffea089e 100644 --- a/protocol_tests/aws-restxml/commands/FlattenedXmlMapWithXmlNamespaceCommand.ts +++ b/protocol_tests/aws-restxml/commands/FlattenedXmlMapWithXmlNamespaceCommand.ts @@ -24,6 +24,20 @@ export interface FlattenedXmlMapWithXmlNamespaceCommandOutput /** * Flattened maps with @xmlNamespace and @xmlName + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { RestXmlProtocolClient, FlattenedXmlMapWithXmlNamespaceCommand } from "@aws-sdk/aws-restxml"; // ES Modules import + * // const { RestXmlProtocolClient, FlattenedXmlMapWithXmlNamespaceCommand } = require("@aws-sdk/aws-restxml"); // CommonJS import + * const client = new RestXmlProtocolClient(config); + * const command = new FlattenedXmlMapWithXmlNamespaceCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link FlattenedXmlMapWithXmlNamespaceCommandInput} for command's `input` shape. + * @see {@link FlattenedXmlMapWithXmlNamespaceCommandOutput} for command's `response` shape. + * @see {@link RestXmlProtocolClientResolvedConfig | config} for command's `input` shape. + * */ export class FlattenedXmlMapWithXmlNamespaceCommand extends $Command< FlattenedXmlMapWithXmlNamespaceCommandInput, diff --git a/protocol_tests/aws-restxml/commands/GreetingWithErrorsCommand.ts b/protocol_tests/aws-restxml/commands/GreetingWithErrorsCommand.ts index f817fb3a1f98..4bdd175d33e0 100644 --- a/protocol_tests/aws-restxml/commands/GreetingWithErrorsCommand.ts +++ b/protocol_tests/aws-restxml/commands/GreetingWithErrorsCommand.ts @@ -30,6 +30,20 @@ export interface GreetingWithErrorsCommandOutput extends GreetingWithErrorsOutpu * Implementations must be able to successfully take a response and * properly (de)serialize successful and error responses based on the * the presence of the + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { RestXmlProtocolClient, GreetingWithErrorsCommand } from "@aws-sdk/aws-restxml"; // ES Modules import + * // const { RestXmlProtocolClient, GreetingWithErrorsCommand } = require("@aws-sdk/aws-restxml"); // CommonJS import + * const client = new RestXmlProtocolClient(config); + * const command = new GreetingWithErrorsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GreetingWithErrorsCommandInput} for command's `input` shape. + * @see {@link GreetingWithErrorsCommandOutput} for command's `response` shape. + * @see {@link RestXmlProtocolClientResolvedConfig | config} for command's `input` shape. + * */ export class GreetingWithErrorsCommand extends $Command< GreetingWithErrorsCommandInput, diff --git a/protocol_tests/aws-restxml/commands/HttpPayloadTraitsCommand.ts b/protocol_tests/aws-restxml/commands/HttpPayloadTraitsCommand.ts index 5b7e68d80afe..a70806952045 100644 --- a/protocol_tests/aws-restxml/commands/HttpPayloadTraitsCommand.ts +++ b/protocol_tests/aws-restxml/commands/HttpPayloadTraitsCommand.ts @@ -25,6 +25,20 @@ export interface HttpPayloadTraitsCommandOutput extends HttpPayloadTraitsInputOu * * In this example, no XML document is synthesized because the payload is * not a structure or a union type. + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { RestXmlProtocolClient, HttpPayloadTraitsCommand } from "@aws-sdk/aws-restxml"; // ES Modules import + * // const { RestXmlProtocolClient, HttpPayloadTraitsCommand } = require("@aws-sdk/aws-restxml"); // CommonJS import + * const client = new RestXmlProtocolClient(config); + * const command = new HttpPayloadTraitsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link HttpPayloadTraitsCommandInput} for command's `input` shape. + * @see {@link HttpPayloadTraitsCommandOutput} for command's `response` shape. + * @see {@link RestXmlProtocolClientResolvedConfig | config} for command's `input` shape. + * */ export class HttpPayloadTraitsCommand extends $Command< HttpPayloadTraitsCommandInput, diff --git a/protocol_tests/aws-restxml/commands/HttpPayloadTraitsWithMediaTypeCommand.ts b/protocol_tests/aws-restxml/commands/HttpPayloadTraitsWithMediaTypeCommand.ts index 1d96a0f9c594..066328323ea0 100644 --- a/protocol_tests/aws-restxml/commands/HttpPayloadTraitsWithMediaTypeCommand.ts +++ b/protocol_tests/aws-restxml/commands/HttpPayloadTraitsWithMediaTypeCommand.ts @@ -25,6 +25,20 @@ export interface HttpPayloadTraitsWithMediaTypeCommandOutput /** * This examples uses a `@mediaType` trait on the payload to force a custom * content-type to be serialized. + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { RestXmlProtocolClient, HttpPayloadTraitsWithMediaTypeCommand } from "@aws-sdk/aws-restxml"; // ES Modules import + * // const { RestXmlProtocolClient, HttpPayloadTraitsWithMediaTypeCommand } = require("@aws-sdk/aws-restxml"); // CommonJS import + * const client = new RestXmlProtocolClient(config); + * const command = new HttpPayloadTraitsWithMediaTypeCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link HttpPayloadTraitsWithMediaTypeCommandInput} for command's `input` shape. + * @see {@link HttpPayloadTraitsWithMediaTypeCommandOutput} for command's `response` shape. + * @see {@link RestXmlProtocolClientResolvedConfig | config} for command's `input` shape. + * */ export class HttpPayloadTraitsWithMediaTypeCommand extends $Command< HttpPayloadTraitsWithMediaTypeCommandInput, diff --git a/protocol_tests/aws-restxml/commands/HttpPayloadWithMemberXmlNameCommand.ts b/protocol_tests/aws-restxml/commands/HttpPayloadWithMemberXmlNameCommand.ts index 66c4ff7b0d2a..878fc7d8f724 100644 --- a/protocol_tests/aws-restxml/commands/HttpPayloadWithMemberXmlNameCommand.ts +++ b/protocol_tests/aws-restxml/commands/HttpPayloadWithMemberXmlNameCommand.ts @@ -25,6 +25,20 @@ export interface HttpPayloadWithMemberXmlNameCommandOutput /** * The following example serializes a payload that uses an XML name * on the member, changing the wrapper name. + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { RestXmlProtocolClient, HttpPayloadWithMemberXmlNameCommand } from "@aws-sdk/aws-restxml"; // ES Modules import + * // const { RestXmlProtocolClient, HttpPayloadWithMemberXmlNameCommand } = require("@aws-sdk/aws-restxml"); // CommonJS import + * const client = new RestXmlProtocolClient(config); + * const command = new HttpPayloadWithMemberXmlNameCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link HttpPayloadWithMemberXmlNameCommandInput} for command's `input` shape. + * @see {@link HttpPayloadWithMemberXmlNameCommandOutput} for command's `response` shape. + * @see {@link RestXmlProtocolClientResolvedConfig | config} for command's `input` shape. + * */ export class HttpPayloadWithMemberXmlNameCommand extends $Command< HttpPayloadWithMemberXmlNameCommandInput, diff --git a/protocol_tests/aws-restxml/commands/HttpPayloadWithStructureCommand.ts b/protocol_tests/aws-restxml/commands/HttpPayloadWithStructureCommand.ts index b39f42a10d1f..8b4366ab18fc 100644 --- a/protocol_tests/aws-restxml/commands/HttpPayloadWithStructureCommand.ts +++ b/protocol_tests/aws-restxml/commands/HttpPayloadWithStructureCommand.ts @@ -25,6 +25,20 @@ export interface HttpPayloadWithStructureCommandOutput extends HttpPayloadWithSt * * Note that serializing a structure changes the wrapper element name * to match the targeted structure. + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { RestXmlProtocolClient, HttpPayloadWithStructureCommand } from "@aws-sdk/aws-restxml"; // ES Modules import + * // const { RestXmlProtocolClient, HttpPayloadWithStructureCommand } = require("@aws-sdk/aws-restxml"); // CommonJS import + * const client = new RestXmlProtocolClient(config); + * const command = new HttpPayloadWithStructureCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link HttpPayloadWithStructureCommandInput} for command's `input` shape. + * @see {@link HttpPayloadWithStructureCommandOutput} for command's `response` shape. + * @see {@link RestXmlProtocolClientResolvedConfig | config} for command's `input` shape. + * */ export class HttpPayloadWithStructureCommand extends $Command< HttpPayloadWithStructureCommandInput, diff --git a/protocol_tests/aws-restxml/commands/HttpPayloadWithXmlNameCommand.ts b/protocol_tests/aws-restxml/commands/HttpPayloadWithXmlNameCommand.ts index 5d1609b7caa5..9b94121dcfba 100644 --- a/protocol_tests/aws-restxml/commands/HttpPayloadWithXmlNameCommand.ts +++ b/protocol_tests/aws-restxml/commands/HttpPayloadWithXmlNameCommand.ts @@ -23,6 +23,20 @@ export interface HttpPayloadWithXmlNameCommandOutput extends HttpPayloadWithXmlN /** * The following example serializes a payload that uses an XML name, * changing the wrapper name. + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { RestXmlProtocolClient, HttpPayloadWithXmlNameCommand } from "@aws-sdk/aws-restxml"; // ES Modules import + * // const { RestXmlProtocolClient, HttpPayloadWithXmlNameCommand } = require("@aws-sdk/aws-restxml"); // CommonJS import + * const client = new RestXmlProtocolClient(config); + * const command = new HttpPayloadWithXmlNameCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link HttpPayloadWithXmlNameCommandInput} for command's `input` shape. + * @see {@link HttpPayloadWithXmlNameCommandOutput} for command's `response` shape. + * @see {@link RestXmlProtocolClientResolvedConfig | config} for command's `input` shape. + * */ export class HttpPayloadWithXmlNameCommand extends $Command< HttpPayloadWithXmlNameCommandInput, diff --git a/protocol_tests/aws-restxml/commands/HttpPayloadWithXmlNamespaceAndPrefixCommand.ts b/protocol_tests/aws-restxml/commands/HttpPayloadWithXmlNamespaceAndPrefixCommand.ts index 8868355ed1d0..2d7bedba9365 100644 --- a/protocol_tests/aws-restxml/commands/HttpPayloadWithXmlNamespaceAndPrefixCommand.ts +++ b/protocol_tests/aws-restxml/commands/HttpPayloadWithXmlNamespaceAndPrefixCommand.ts @@ -25,6 +25,20 @@ export interface HttpPayloadWithXmlNamespaceAndPrefixCommandOutput /** * The following example serializes a payload that uses an XML namespace. + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { RestXmlProtocolClient, HttpPayloadWithXmlNamespaceAndPrefixCommand } from "@aws-sdk/aws-restxml"; // ES Modules import + * // const { RestXmlProtocolClient, HttpPayloadWithXmlNamespaceAndPrefixCommand } = require("@aws-sdk/aws-restxml"); // CommonJS import + * const client = new RestXmlProtocolClient(config); + * const command = new HttpPayloadWithXmlNamespaceAndPrefixCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link HttpPayloadWithXmlNamespaceAndPrefixCommandInput} for command's `input` shape. + * @see {@link HttpPayloadWithXmlNamespaceAndPrefixCommandOutput} for command's `response` shape. + * @see {@link RestXmlProtocolClientResolvedConfig | config} for command's `input` shape. + * */ export class HttpPayloadWithXmlNamespaceAndPrefixCommand extends $Command< HttpPayloadWithXmlNamespaceAndPrefixCommandInput, diff --git a/protocol_tests/aws-restxml/commands/HttpPayloadWithXmlNamespaceCommand.ts b/protocol_tests/aws-restxml/commands/HttpPayloadWithXmlNamespaceCommand.ts index 21f0e3dd6ba5..175891847f3d 100644 --- a/protocol_tests/aws-restxml/commands/HttpPayloadWithXmlNamespaceCommand.ts +++ b/protocol_tests/aws-restxml/commands/HttpPayloadWithXmlNamespaceCommand.ts @@ -24,6 +24,20 @@ export interface HttpPayloadWithXmlNamespaceCommandOutput /** * The following example serializes a payload that uses an XML namespace. + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { RestXmlProtocolClient, HttpPayloadWithXmlNamespaceCommand } from "@aws-sdk/aws-restxml"; // ES Modules import + * // const { RestXmlProtocolClient, HttpPayloadWithXmlNamespaceCommand } = require("@aws-sdk/aws-restxml"); // CommonJS import + * const client = new RestXmlProtocolClient(config); + * const command = new HttpPayloadWithXmlNamespaceCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link HttpPayloadWithXmlNamespaceCommandInput} for command's `input` shape. + * @see {@link HttpPayloadWithXmlNamespaceCommandOutput} for command's `response` shape. + * @see {@link RestXmlProtocolClientResolvedConfig | config} for command's `input` shape. + * */ export class HttpPayloadWithXmlNamespaceCommand extends $Command< HttpPayloadWithXmlNamespaceCommandInput, diff --git a/protocol_tests/aws-restxml/commands/HttpPrefixHeadersCommand.ts b/protocol_tests/aws-restxml/commands/HttpPrefixHeadersCommand.ts index 41b9405fe01a..769d6039f724 100644 --- a/protocol_tests/aws-restxml/commands/HttpPrefixHeadersCommand.ts +++ b/protocol_tests/aws-restxml/commands/HttpPrefixHeadersCommand.ts @@ -22,6 +22,20 @@ export interface HttpPrefixHeadersCommandOutput extends HttpPrefixHeadersInputOu /** * This examples adds headers to the input of a request and response by prefix. + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { RestXmlProtocolClient, HttpPrefixHeadersCommand } from "@aws-sdk/aws-restxml"; // ES Modules import + * // const { RestXmlProtocolClient, HttpPrefixHeadersCommand } = require("@aws-sdk/aws-restxml"); // CommonJS import + * const client = new RestXmlProtocolClient(config); + * const command = new HttpPrefixHeadersCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link HttpPrefixHeadersCommandInput} for command's `input` shape. + * @see {@link HttpPrefixHeadersCommandOutput} for command's `response` shape. + * @see {@link RestXmlProtocolClientResolvedConfig | config} for command's `input` shape. + * */ export class HttpPrefixHeadersCommand extends $Command< HttpPrefixHeadersCommandInput, diff --git a/protocol_tests/aws-restxml/commands/HttpRequestWithLabelsAndTimestampFormatCommand.ts b/protocol_tests/aws-restxml/commands/HttpRequestWithLabelsAndTimestampFormatCommand.ts index 70832517acae..26aab80453c8 100644 --- a/protocol_tests/aws-restxml/commands/HttpRequestWithLabelsAndTimestampFormatCommand.ts +++ b/protocol_tests/aws-restxml/commands/HttpRequestWithLabelsAndTimestampFormatCommand.ts @@ -24,6 +24,20 @@ export interface HttpRequestWithLabelsAndTimestampFormatCommandOutput extends __ /** * The example tests how requests serialize different timestamp formats in the * URI path. + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { RestXmlProtocolClient, HttpRequestWithLabelsAndTimestampFormatCommand } from "@aws-sdk/aws-restxml"; // ES Modules import + * // const { RestXmlProtocolClient, HttpRequestWithLabelsAndTimestampFormatCommand } = require("@aws-sdk/aws-restxml"); // CommonJS import + * const client = new RestXmlProtocolClient(config); + * const command = new HttpRequestWithLabelsAndTimestampFormatCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link HttpRequestWithLabelsAndTimestampFormatCommandInput} for command's `input` shape. + * @see {@link HttpRequestWithLabelsAndTimestampFormatCommandOutput} for command's `response` shape. + * @see {@link RestXmlProtocolClientResolvedConfig | config} for command's `input` shape. + * */ export class HttpRequestWithLabelsAndTimestampFormatCommand extends $Command< HttpRequestWithLabelsAndTimestampFormatCommandInput, diff --git a/protocol_tests/aws-restxml/commands/HttpRequestWithLabelsCommand.ts b/protocol_tests/aws-restxml/commands/HttpRequestWithLabelsCommand.ts index ba263d1f2d8a..80239a11dfef 100644 --- a/protocol_tests/aws-restxml/commands/HttpRequestWithLabelsCommand.ts +++ b/protocol_tests/aws-restxml/commands/HttpRequestWithLabelsCommand.ts @@ -23,6 +23,20 @@ export interface HttpRequestWithLabelsCommandOutput extends __MetadataBearer {} /** * The example tests how requests are serialized when there's no input * payload but there are HTTP labels. + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { RestXmlProtocolClient, HttpRequestWithLabelsCommand } from "@aws-sdk/aws-restxml"; // ES Modules import + * // const { RestXmlProtocolClient, HttpRequestWithLabelsCommand } = require("@aws-sdk/aws-restxml"); // CommonJS import + * const client = new RestXmlProtocolClient(config); + * const command = new HttpRequestWithLabelsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link HttpRequestWithLabelsCommandInput} for command's `input` shape. + * @see {@link HttpRequestWithLabelsCommandOutput} for command's `response` shape. + * @see {@link RestXmlProtocolClientResolvedConfig | config} for command's `input` shape. + * */ export class HttpRequestWithLabelsCommand extends $Command< HttpRequestWithLabelsCommandInput, diff --git a/protocol_tests/aws-restxml/commands/IgnoreQueryParamsInResponseCommand.ts b/protocol_tests/aws-restxml/commands/IgnoreQueryParamsInResponseCommand.ts index 3ad23fd45fb5..9050a8357223 100644 --- a/protocol_tests/aws-restxml/commands/IgnoreQueryParamsInResponseCommand.ts +++ b/protocol_tests/aws-restxml/commands/IgnoreQueryParamsInResponseCommand.ts @@ -24,6 +24,20 @@ export interface IgnoreQueryParamsInResponseCommandOutput extends IgnoreQueryPar * 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. + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { RestXmlProtocolClient, IgnoreQueryParamsInResponseCommand } from "@aws-sdk/aws-restxml"; // ES Modules import + * // const { RestXmlProtocolClient, IgnoreQueryParamsInResponseCommand } = require("@aws-sdk/aws-restxml"); // CommonJS import + * const client = new RestXmlProtocolClient(config); + * const command = new IgnoreQueryParamsInResponseCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link IgnoreQueryParamsInResponseCommandInput} for command's `input` shape. + * @see {@link IgnoreQueryParamsInResponseCommandOutput} for command's `response` shape. + * @see {@link RestXmlProtocolClientResolvedConfig | config} for command's `input` shape. + * */ export class IgnoreQueryParamsInResponseCommand extends $Command< IgnoreQueryParamsInResponseCommandInput, diff --git a/protocol_tests/aws-restxml/commands/InputAndOutputWithHeadersCommand.ts b/protocol_tests/aws-restxml/commands/InputAndOutputWithHeadersCommand.ts index c578128be778..7ef026ed0077 100644 --- a/protocol_tests/aws-restxml/commands/InputAndOutputWithHeadersCommand.ts +++ b/protocol_tests/aws-restxml/commands/InputAndOutputWithHeadersCommand.ts @@ -23,6 +23,20 @@ export interface InputAndOutputWithHeadersCommandOutput extends InputAndOutputWi /** * The example tests how requests and responses are serialized when there is * no input or output payload but there are HTTP header bindings. + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { RestXmlProtocolClient, InputAndOutputWithHeadersCommand } from "@aws-sdk/aws-restxml"; // ES Modules import + * // const { RestXmlProtocolClient, InputAndOutputWithHeadersCommand } = require("@aws-sdk/aws-restxml"); // CommonJS import + * const client = new RestXmlProtocolClient(config); + * const command = new InputAndOutputWithHeadersCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link InputAndOutputWithHeadersCommandInput} for command's `input` shape. + * @see {@link InputAndOutputWithHeadersCommandOutput} for command's `response` shape. + * @see {@link RestXmlProtocolClientResolvedConfig | config} for command's `input` shape. + * */ export class InputAndOutputWithHeadersCommand extends $Command< InputAndOutputWithHeadersCommandInput, diff --git a/protocol_tests/aws-restxml/commands/NoInputAndNoOutputCommand.ts b/protocol_tests/aws-restxml/commands/NoInputAndNoOutputCommand.ts index dbb88cea0b3c..453386db06f0 100644 --- a/protocol_tests/aws-restxml/commands/NoInputAndNoOutputCommand.ts +++ b/protocol_tests/aws-restxml/commands/NoInputAndNoOutputCommand.ts @@ -23,6 +23,20 @@ export interface NoInputAndNoOutputCommandOutput extends __MetadataBearer {} * 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. + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { RestXmlProtocolClient, NoInputAndNoOutputCommand } from "@aws-sdk/aws-restxml"; // ES Modules import + * // const { RestXmlProtocolClient, NoInputAndNoOutputCommand } = require("@aws-sdk/aws-restxml"); // CommonJS import + * const client = new RestXmlProtocolClient(config); + * const command = new NoInputAndNoOutputCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link NoInputAndNoOutputCommandInput} for command's `input` shape. + * @see {@link NoInputAndNoOutputCommandOutput} for command's `response` shape. + * @see {@link RestXmlProtocolClientResolvedConfig | config} for command's `input` shape. + * */ export class NoInputAndNoOutputCommand extends $Command< NoInputAndNoOutputCommandInput, diff --git a/protocol_tests/aws-restxml/commands/NoInputAndOutputCommand.ts b/protocol_tests/aws-restxml/commands/NoInputAndOutputCommand.ts index c35c7a9424ba..8815617635d7 100644 --- a/protocol_tests/aws-restxml/commands/NoInputAndOutputCommand.ts +++ b/protocol_tests/aws-restxml/commands/NoInputAndOutputCommand.ts @@ -25,6 +25,20 @@ export interface NoInputAndOutputCommandOutput extends NoInputAndOutputOutput, _ * 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. + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { RestXmlProtocolClient, NoInputAndOutputCommand } from "@aws-sdk/aws-restxml"; // ES Modules import + * // const { RestXmlProtocolClient, NoInputAndOutputCommand } = require("@aws-sdk/aws-restxml"); // CommonJS import + * const client = new RestXmlProtocolClient(config); + * const command = new NoInputAndOutputCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link NoInputAndOutputCommandInput} for command's `input` shape. + * @see {@link NoInputAndOutputCommandOutput} for command's `response` shape. + * @see {@link RestXmlProtocolClientResolvedConfig | config} for command's `input` shape. + * */ export class NoInputAndOutputCommand extends $Command< NoInputAndOutputCommandInput, diff --git a/protocol_tests/aws-restxml/commands/NullAndEmptyHeadersClientCommand.ts b/protocol_tests/aws-restxml/commands/NullAndEmptyHeadersClientCommand.ts index 5a05e4e9b162..4be3c8e7b80c 100644 --- a/protocol_tests/aws-restxml/commands/NullAndEmptyHeadersClientCommand.ts +++ b/protocol_tests/aws-restxml/commands/NullAndEmptyHeadersClientCommand.ts @@ -22,6 +22,20 @@ export interface NullAndEmptyHeadersClientCommandOutput extends NullAndEmptyHead /** * Null and empty headers are not sent over the wire. + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { RestXmlProtocolClient, NullAndEmptyHeadersClientCommand } from "@aws-sdk/aws-restxml"; // ES Modules import + * // const { RestXmlProtocolClient, NullAndEmptyHeadersClientCommand } = require("@aws-sdk/aws-restxml"); // CommonJS import + * const client = new RestXmlProtocolClient(config); + * const command = new NullAndEmptyHeadersClientCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link NullAndEmptyHeadersClientCommandInput} for command's `input` shape. + * @see {@link NullAndEmptyHeadersClientCommandOutput} for command's `response` shape. + * @see {@link RestXmlProtocolClientResolvedConfig | config} for command's `input` shape. + * */ export class NullAndEmptyHeadersClientCommand extends $Command< NullAndEmptyHeadersClientCommandInput, diff --git a/protocol_tests/aws-restxml/commands/NullAndEmptyHeadersServerCommand.ts b/protocol_tests/aws-restxml/commands/NullAndEmptyHeadersServerCommand.ts index b43d299c849a..66c6828d79bd 100644 --- a/protocol_tests/aws-restxml/commands/NullAndEmptyHeadersServerCommand.ts +++ b/protocol_tests/aws-restxml/commands/NullAndEmptyHeadersServerCommand.ts @@ -22,6 +22,20 @@ export interface NullAndEmptyHeadersServerCommandOutput extends NullAndEmptyHead /** * Null and empty headers are not sent over the wire. + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { RestXmlProtocolClient, NullAndEmptyHeadersServerCommand } from "@aws-sdk/aws-restxml"; // ES Modules import + * // const { RestXmlProtocolClient, NullAndEmptyHeadersServerCommand } = require("@aws-sdk/aws-restxml"); // CommonJS import + * const client = new RestXmlProtocolClient(config); + * const command = new NullAndEmptyHeadersServerCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link NullAndEmptyHeadersServerCommandInput} for command's `input` shape. + * @see {@link NullAndEmptyHeadersServerCommandOutput} for command's `response` shape. + * @see {@link RestXmlProtocolClientResolvedConfig | config} for command's `input` shape. + * */ export class NullAndEmptyHeadersServerCommand extends $Command< NullAndEmptyHeadersServerCommandInput, diff --git a/protocol_tests/aws-restxml/commands/OmitsNullSerializesEmptyStringCommand.ts b/protocol_tests/aws-restxml/commands/OmitsNullSerializesEmptyStringCommand.ts index a828a3455612..754538c09652 100644 --- a/protocol_tests/aws-restxml/commands/OmitsNullSerializesEmptyStringCommand.ts +++ b/protocol_tests/aws-restxml/commands/OmitsNullSerializesEmptyStringCommand.ts @@ -22,6 +22,20 @@ export interface OmitsNullSerializesEmptyStringCommandOutput extends __MetadataB /** * Omits null, but serializes empty string value. + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { RestXmlProtocolClient, OmitsNullSerializesEmptyStringCommand } from "@aws-sdk/aws-restxml"; // ES Modules import + * // const { RestXmlProtocolClient, OmitsNullSerializesEmptyStringCommand } = require("@aws-sdk/aws-restxml"); // CommonJS import + * const client = new RestXmlProtocolClient(config); + * const command = new OmitsNullSerializesEmptyStringCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link OmitsNullSerializesEmptyStringCommandInput} for command's `input` shape. + * @see {@link OmitsNullSerializesEmptyStringCommandOutput} for command's `response` shape. + * @see {@link RestXmlProtocolClientResolvedConfig | config} for command's `input` shape. + * */ export class OmitsNullSerializesEmptyStringCommand extends $Command< OmitsNullSerializesEmptyStringCommandInput, diff --git a/protocol_tests/aws-restxml/commands/QueryIdempotencyTokenAutoFillCommand.ts b/protocol_tests/aws-restxml/commands/QueryIdempotencyTokenAutoFillCommand.ts index 86b25bca6469..dce67c87b457 100644 --- a/protocol_tests/aws-restxml/commands/QueryIdempotencyTokenAutoFillCommand.ts +++ b/protocol_tests/aws-restxml/commands/QueryIdempotencyTokenAutoFillCommand.ts @@ -22,6 +22,20 @@ export interface QueryIdempotencyTokenAutoFillCommandOutput extends __MetadataBe /** * Automatically adds idempotency tokens. + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { RestXmlProtocolClient, QueryIdempotencyTokenAutoFillCommand } from "@aws-sdk/aws-restxml"; // ES Modules import + * // const { RestXmlProtocolClient, QueryIdempotencyTokenAutoFillCommand } = require("@aws-sdk/aws-restxml"); // CommonJS import + * const client = new RestXmlProtocolClient(config); + * const command = new QueryIdempotencyTokenAutoFillCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link QueryIdempotencyTokenAutoFillCommandInput} for command's `input` shape. + * @see {@link QueryIdempotencyTokenAutoFillCommandOutput} for command's `response` shape. + * @see {@link RestXmlProtocolClientResolvedConfig | config} for command's `input` shape. + * */ export class QueryIdempotencyTokenAutoFillCommand extends $Command< QueryIdempotencyTokenAutoFillCommandInput, diff --git a/protocol_tests/aws-restxml/commands/RecursiveShapesCommand.ts b/protocol_tests/aws-restxml/commands/RecursiveShapesCommand.ts index 80dfea0133cd..fc245655aa68 100644 --- a/protocol_tests/aws-restxml/commands/RecursiveShapesCommand.ts +++ b/protocol_tests/aws-restxml/commands/RecursiveShapesCommand.ts @@ -22,6 +22,20 @@ export interface RecursiveShapesCommandOutput extends RecursiveShapesInputOutput /** * Recursive shapes + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { RestXmlProtocolClient, RecursiveShapesCommand } from "@aws-sdk/aws-restxml"; // ES Modules import + * // const { RestXmlProtocolClient, RecursiveShapesCommand } = require("@aws-sdk/aws-restxml"); // CommonJS import + * const client = new RestXmlProtocolClient(config); + * const command = new RecursiveShapesCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link RecursiveShapesCommandInput} for command's `input` shape. + * @see {@link RecursiveShapesCommandOutput} for command's `response` shape. + * @see {@link RestXmlProtocolClientResolvedConfig | config} for command's `input` shape. + * */ export class RecursiveShapesCommand extends $Command< RecursiveShapesCommandInput, diff --git a/protocol_tests/aws-restxml/commands/TimestampFormatHeadersCommand.ts b/protocol_tests/aws-restxml/commands/TimestampFormatHeadersCommand.ts index f6fd56253546..39c03a0d43bc 100644 --- a/protocol_tests/aws-restxml/commands/TimestampFormatHeadersCommand.ts +++ b/protocol_tests/aws-restxml/commands/TimestampFormatHeadersCommand.ts @@ -22,6 +22,20 @@ export interface TimestampFormatHeadersCommandOutput extends TimestampFormatHead /** * The example tests how timestamp request and response headers are serialized. + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { RestXmlProtocolClient, TimestampFormatHeadersCommand } from "@aws-sdk/aws-restxml"; // ES Modules import + * // const { RestXmlProtocolClient, TimestampFormatHeadersCommand } = require("@aws-sdk/aws-restxml"); // CommonJS import + * const client = new RestXmlProtocolClient(config); + * const command = new TimestampFormatHeadersCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link TimestampFormatHeadersCommandInput} for command's `input` shape. + * @see {@link TimestampFormatHeadersCommandOutput} for command's `response` shape. + * @see {@link RestXmlProtocolClientResolvedConfig | config} for command's `input` shape. + * */ export class TimestampFormatHeadersCommand extends $Command< TimestampFormatHeadersCommandInput, diff --git a/protocol_tests/aws-restxml/commands/XmlAttributesCommand.ts b/protocol_tests/aws-restxml/commands/XmlAttributesCommand.ts index 4c9b2fee75c2..2870d51a3ef5 100644 --- a/protocol_tests/aws-restxml/commands/XmlAttributesCommand.ts +++ b/protocol_tests/aws-restxml/commands/XmlAttributesCommand.ts @@ -22,6 +22,20 @@ export interface XmlAttributesCommandOutput extends XmlAttributesInputOutput, __ /** * This example serializes an XML attributes on synthesized document. + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { RestXmlProtocolClient, XmlAttributesCommand } from "@aws-sdk/aws-restxml"; // ES Modules import + * // const { RestXmlProtocolClient, XmlAttributesCommand } = require("@aws-sdk/aws-restxml"); // CommonJS import + * const client = new RestXmlProtocolClient(config); + * const command = new XmlAttributesCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link XmlAttributesCommandInput} for command's `input` shape. + * @see {@link XmlAttributesCommandOutput} for command's `response` shape. + * @see {@link RestXmlProtocolClientResolvedConfig | config} for command's `input` shape. + * */ export class XmlAttributesCommand extends $Command< XmlAttributesCommandInput, diff --git a/protocol_tests/aws-restxml/commands/XmlAttributesOnPayloadCommand.ts b/protocol_tests/aws-restxml/commands/XmlAttributesOnPayloadCommand.ts index 2f06a382cc10..914e9e51e1a2 100644 --- a/protocol_tests/aws-restxml/commands/XmlAttributesOnPayloadCommand.ts +++ b/protocol_tests/aws-restxml/commands/XmlAttributesOnPayloadCommand.ts @@ -22,6 +22,20 @@ export interface XmlAttributesOnPayloadCommandOutput extends XmlAttributesOnPayl /** * This example serializes an XML attributes on a document targeted by httpPayload. + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { RestXmlProtocolClient, XmlAttributesOnPayloadCommand } from "@aws-sdk/aws-restxml"; // ES Modules import + * // const { RestXmlProtocolClient, XmlAttributesOnPayloadCommand } = require("@aws-sdk/aws-restxml"); // CommonJS import + * const client = new RestXmlProtocolClient(config); + * const command = new XmlAttributesOnPayloadCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link XmlAttributesOnPayloadCommandInput} for command's `input` shape. + * @see {@link XmlAttributesOnPayloadCommandOutput} for command's `response` shape. + * @see {@link RestXmlProtocolClientResolvedConfig | config} for command's `input` shape. + * */ export class XmlAttributesOnPayloadCommand extends $Command< XmlAttributesOnPayloadCommandInput, diff --git a/protocol_tests/aws-restxml/commands/XmlBlobsCommand.ts b/protocol_tests/aws-restxml/commands/XmlBlobsCommand.ts index df3d8e910b85..9f6b78a49dc3 100644 --- a/protocol_tests/aws-restxml/commands/XmlBlobsCommand.ts +++ b/protocol_tests/aws-restxml/commands/XmlBlobsCommand.ts @@ -19,6 +19,20 @@ export interface XmlBlobsCommandOutput extends XmlBlobsInputOutput, __MetadataBe /** * Blobs are base64 encoded + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { RestXmlProtocolClient, XmlBlobsCommand } from "@aws-sdk/aws-restxml"; // ES Modules import + * // const { RestXmlProtocolClient, XmlBlobsCommand } = require("@aws-sdk/aws-restxml"); // CommonJS import + * const client = new RestXmlProtocolClient(config); + * const command = new XmlBlobsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link XmlBlobsCommandInput} for command's `input` shape. + * @see {@link XmlBlobsCommandOutput} for command's `response` shape. + * @see {@link RestXmlProtocolClientResolvedConfig | config} for command's `input` shape. + * */ export class XmlBlobsCommand extends $Command< XmlBlobsCommandInput, diff --git a/protocol_tests/aws-restxml/commands/XmlEmptyBlobsCommand.ts b/protocol_tests/aws-restxml/commands/XmlEmptyBlobsCommand.ts index 620a28c456f6..7f642b44c00a 100644 --- a/protocol_tests/aws-restxml/commands/XmlEmptyBlobsCommand.ts +++ b/protocol_tests/aws-restxml/commands/XmlEmptyBlobsCommand.ts @@ -22,6 +22,20 @@ export interface XmlEmptyBlobsCommandOutput extends XmlBlobsInputOutput, __Metad /** * Blobs are base64 encoded + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { RestXmlProtocolClient, XmlEmptyBlobsCommand } from "@aws-sdk/aws-restxml"; // ES Modules import + * // const { RestXmlProtocolClient, XmlEmptyBlobsCommand } = require("@aws-sdk/aws-restxml"); // CommonJS import + * const client = new RestXmlProtocolClient(config); + * const command = new XmlEmptyBlobsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link XmlEmptyBlobsCommandInput} for command's `input` shape. + * @see {@link XmlEmptyBlobsCommandOutput} for command's `response` shape. + * @see {@link RestXmlProtocolClientResolvedConfig | config} for command's `input` shape. + * */ export class XmlEmptyBlobsCommand extends $Command< XmlEmptyBlobsCommandInput, diff --git a/protocol_tests/aws-restxml/commands/XmlEnumsCommand.ts b/protocol_tests/aws-restxml/commands/XmlEnumsCommand.ts index 309f2b6199b1..73e71deb6b4b 100644 --- a/protocol_tests/aws-restxml/commands/XmlEnumsCommand.ts +++ b/protocol_tests/aws-restxml/commands/XmlEnumsCommand.ts @@ -19,6 +19,20 @@ export interface XmlEnumsCommandOutput extends XmlEnumsInputOutput, __MetadataBe /** * This example serializes enums as top level properties, in lists, sets, and maps. + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { RestXmlProtocolClient, XmlEnumsCommand } from "@aws-sdk/aws-restxml"; // ES Modules import + * // const { RestXmlProtocolClient, XmlEnumsCommand } = require("@aws-sdk/aws-restxml"); // CommonJS import + * const client = new RestXmlProtocolClient(config); + * const command = new XmlEnumsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link XmlEnumsCommandInput} for command's `input` shape. + * @see {@link XmlEnumsCommandOutput} for command's `response` shape. + * @see {@link RestXmlProtocolClientResolvedConfig | config} for command's `input` shape. + * */ export class XmlEnumsCommand extends $Command< XmlEnumsCommandInput, diff --git a/protocol_tests/aws-restxml/commands/XmlListsCommand.ts b/protocol_tests/aws-restxml/commands/XmlListsCommand.ts index cb4531a4571b..140569d9ac5b 100644 --- a/protocol_tests/aws-restxml/commands/XmlListsCommand.ts +++ b/protocol_tests/aws-restxml/commands/XmlListsCommand.ts @@ -29,6 +29,20 @@ export interface XmlListsCommandOutput extends XmlListsInputOutput, __MetadataBe * 6. Flattened XML lists with @xmlName. * 7. Flattened XML lists with @xmlNamespace. * 8. Lists of structures. + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { RestXmlProtocolClient, XmlListsCommand } from "@aws-sdk/aws-restxml"; // ES Modules import + * // const { RestXmlProtocolClient, XmlListsCommand } = require("@aws-sdk/aws-restxml"); // CommonJS import + * const client = new RestXmlProtocolClient(config); + * const command = new XmlListsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link XmlListsCommandInput} for command's `input` shape. + * @see {@link XmlListsCommandOutput} for command's `response` shape. + * @see {@link RestXmlProtocolClientResolvedConfig | config} for command's `input` shape. + * */ export class XmlListsCommand extends $Command< XmlListsCommandInput, diff --git a/protocol_tests/aws-restxml/commands/XmlMapsCommand.ts b/protocol_tests/aws-restxml/commands/XmlMapsCommand.ts index 875da3ecc855..dd75b0130daa 100644 --- a/protocol_tests/aws-restxml/commands/XmlMapsCommand.ts +++ b/protocol_tests/aws-restxml/commands/XmlMapsCommand.ts @@ -19,6 +19,20 @@ export interface XmlMapsCommandOutput extends XmlMapsInputOutput, __MetadataBear /** * The example tests basic map serialization. + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { RestXmlProtocolClient, XmlMapsCommand } from "@aws-sdk/aws-restxml"; // ES Modules import + * // const { RestXmlProtocolClient, XmlMapsCommand } = require("@aws-sdk/aws-restxml"); // CommonJS import + * const client = new RestXmlProtocolClient(config); + * const command = new XmlMapsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link XmlMapsCommandInput} for command's `input` shape. + * @see {@link XmlMapsCommandOutput} for command's `response` shape. + * @see {@link RestXmlProtocolClientResolvedConfig | config} for command's `input` shape. + * */ export class XmlMapsCommand extends $Command< XmlMapsCommandInput, diff --git a/protocol_tests/aws-restxml/commands/XmlTimestampsCommand.ts b/protocol_tests/aws-restxml/commands/XmlTimestampsCommand.ts index 018ff46d1c25..389a75fab16b 100644 --- a/protocol_tests/aws-restxml/commands/XmlTimestampsCommand.ts +++ b/protocol_tests/aws-restxml/commands/XmlTimestampsCommand.ts @@ -24,6 +24,20 @@ export interface XmlTimestampsCommandOutput extends XmlTimestampsInputOutput, __ * This tests how timestamps are serialized, including using the * default format of date-time and various @timestampFormat trait * values. + * @example + * User a bare-bones client and the command you need to make an API call. + * ```javascript + * import { RestXmlProtocolClient, XmlTimestampsCommand } from "@aws-sdk/aws-restxml"; // ES Modules import + * // const { RestXmlProtocolClient, XmlTimestampsCommand } = require("@aws-sdk/aws-restxml"); // CommonJS import + * const client = new RestXmlProtocolClient(config); + * const command = new XmlTimestampsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link XmlTimestampsCommandInput} for command's `input` shape. + * @see {@link XmlTimestampsCommandOutput} for command's `response` shape. + * @see {@link RestXmlProtocolClientResolvedConfig | config} for command's `input` shape. + * */ export class XmlTimestampsCommand extends $Command< XmlTimestampsCommandInput, diff --git a/protocol_tests/aws-restxml/models/models_0.ts b/protocol_tests/aws-restxml/models/models_0.ts index 3be26701ca55..50ad9d77562b 100644 --- a/protocol_tests/aws-restxml/models/models_0.ts +++ b/protocol_tests/aws-restxml/models/models_0.ts @@ -32,6 +32,9 @@ export interface AllQueryStringTypesInput { } export namespace AllQueryStringTypesInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: AllQueryStringTypesInput): any => ({ ...obj, }); @@ -42,6 +45,9 @@ export interface ComplexNestedErrorData { } export namespace ComplexNestedErrorData { + /** + * @internal + */ export const filterSensitiveLog = (obj: ComplexNestedErrorData): any => ({ ...obj, }); @@ -59,6 +65,9 @@ export interface ComplexError extends __SmithyException, $MetadataBearer { } export namespace ComplexError { + /** + * @internal + */ export const filterSensitiveLog = (obj: ComplexError): any => ({ ...obj, }); @@ -70,6 +79,9 @@ export interface ConstantAndVariableQueryStringInput { } export namespace ConstantAndVariableQueryStringInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: ConstantAndVariableQueryStringInput): any => ({ ...obj, }); @@ -80,6 +92,9 @@ export interface ConstantQueryStringInput { } export namespace ConstantQueryStringInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: ConstantQueryStringInput): any => ({ ...obj, }); @@ -88,6 +103,9 @@ export namespace ConstantQueryStringInput { export interface EmptyInputAndEmptyOutputInput {} export namespace EmptyInputAndEmptyOutputInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: EmptyInputAndEmptyOutputInput): any => ({ ...obj, }); @@ -96,6 +114,9 @@ export namespace EmptyInputAndEmptyOutputInput { export interface EmptyInputAndEmptyOutputOutput {} export namespace EmptyInputAndEmptyOutputOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: EmptyInputAndEmptyOutputOutput): any => ({ ...obj, }); @@ -106,6 +127,9 @@ export interface HostLabelHeaderInput { } export namespace HostLabelHeaderInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: HostLabelHeaderInput): any => ({ ...obj, }); @@ -116,6 +140,9 @@ export interface HostLabelInput { } export namespace HostLabelInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: HostLabelInput): any => ({ ...obj, }); @@ -126,6 +153,9 @@ export interface FlattenedXmlMapInputOutput { } export namespace FlattenedXmlMapInputOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: FlattenedXmlMapInputOutput): any => ({ ...obj, }); @@ -136,6 +166,9 @@ export interface FlattenedXmlMapWithXmlNameInputOutput { } export namespace FlattenedXmlMapWithXmlNameInputOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: FlattenedXmlMapWithXmlNameInputOutput): any => ({ ...obj, }); @@ -146,6 +179,9 @@ export interface FlattenedXmlMapWithXmlNamespaceOutput { } export namespace FlattenedXmlMapWithXmlNamespaceOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: FlattenedXmlMapWithXmlNamespaceOutput): any => ({ ...obj, }); @@ -156,6 +192,9 @@ export interface GreetingWithErrorsOutput { } export namespace GreetingWithErrorsOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: GreetingWithErrorsOutput): any => ({ ...obj, }); @@ -171,6 +210,9 @@ export interface InvalidGreeting extends __SmithyException, $MetadataBearer { } export namespace InvalidGreeting { + /** + * @internal + */ export const filterSensitiveLog = (obj: InvalidGreeting): any => ({ ...obj, }); @@ -182,6 +224,9 @@ export interface HttpPayloadTraitsInputOutput { } export namespace HttpPayloadTraitsInputOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: HttpPayloadTraitsInputOutput): any => ({ ...obj, }); @@ -193,6 +238,9 @@ export interface HttpPayloadTraitsWithMediaTypeInputOutput { } export namespace HttpPayloadTraitsWithMediaTypeInputOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: HttpPayloadTraitsWithMediaTypeInputOutput): any => ({ ...obj, }); @@ -203,6 +251,9 @@ export interface PayloadWithXmlName { } export namespace PayloadWithXmlName { + /** + * @internal + */ export const filterSensitiveLog = (obj: PayloadWithXmlName): any => ({ ...obj, }); @@ -213,6 +264,9 @@ export interface HttpPayloadWithMemberXmlNameInputOutput { } export namespace HttpPayloadWithMemberXmlNameInputOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: HttpPayloadWithMemberXmlNameInputOutput): any => ({ ...obj, }); @@ -224,6 +278,9 @@ export interface NestedPayload { } export namespace NestedPayload { + /** + * @internal + */ export const filterSensitiveLog = (obj: NestedPayload): any => ({ ...obj, }); @@ -234,6 +291,9 @@ export interface HttpPayloadWithStructureInputOutput { } export namespace HttpPayloadWithStructureInputOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: HttpPayloadWithStructureInputOutput): any => ({ ...obj, }); @@ -244,6 +304,9 @@ export interface HttpPayloadWithXmlNameInputOutput { } export namespace HttpPayloadWithXmlNameInputOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: HttpPayloadWithXmlNameInputOutput): any => ({ ...obj, }); @@ -254,6 +317,9 @@ export interface PayloadWithXmlNamespace { } export namespace PayloadWithXmlNamespace { + /** + * @internal + */ export const filterSensitiveLog = (obj: PayloadWithXmlNamespace): any => ({ ...obj, }); @@ -264,6 +330,9 @@ export interface HttpPayloadWithXmlNamespaceInputOutput { } export namespace HttpPayloadWithXmlNamespaceInputOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: HttpPayloadWithXmlNamespaceInputOutput): any => ({ ...obj, }); @@ -274,6 +343,9 @@ export interface PayloadWithXmlNamespaceAndPrefix { } export namespace PayloadWithXmlNamespaceAndPrefix { + /** + * @internal + */ export const filterSensitiveLog = (obj: PayloadWithXmlNamespaceAndPrefix): any => ({ ...obj, }); @@ -284,6 +356,9 @@ export interface HttpPayloadWithXmlNamespaceAndPrefixInputOutput { } export namespace HttpPayloadWithXmlNamespaceAndPrefixInputOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: HttpPayloadWithXmlNamespaceAndPrefixInputOutput): any => ({ ...obj, }); @@ -295,6 +370,9 @@ export interface HttpPrefixHeadersInputOutput { } export namespace HttpPrefixHeadersInputOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: HttpPrefixHeadersInputOutput): any => ({ ...obj, }); @@ -306,6 +384,9 @@ export interface HttpRequestWithGreedyLabelInPathInput { } export namespace HttpRequestWithGreedyLabelInPathInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: HttpRequestWithGreedyLabelInPathInput): any => ({ ...obj, }); @@ -330,6 +411,9 @@ export interface HttpRequestWithLabelsInput { } export namespace HttpRequestWithLabelsInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: HttpRequestWithLabelsInput): any => ({ ...obj, }); @@ -346,6 +430,9 @@ export interface HttpRequestWithLabelsAndTimestampFormatInput { } export namespace HttpRequestWithLabelsAndTimestampFormatInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: HttpRequestWithLabelsAndTimestampFormatInput): any => ({ ...obj, }); @@ -356,6 +443,9 @@ export interface HttpResponseCodeOutput { } export namespace HttpResponseCodeOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: HttpResponseCodeOutput): any => ({ ...obj, }); @@ -366,6 +456,9 @@ export interface IgnoreQueryParamsInResponseOutput { } export namespace IgnoreQueryParamsInResponseOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: IgnoreQueryParamsInResponseOutput): any => ({ ...obj, }); @@ -391,6 +484,9 @@ export interface InputAndOutputWithHeadersIO { } export namespace InputAndOutputWithHeadersIO { + /** + * @internal + */ export const filterSensitiveLog = (obj: InputAndOutputWithHeadersIO): any => ({ ...obj, }); @@ -402,6 +498,9 @@ export interface NestedXmlMapsInputOutput { } export namespace NestedXmlMapsInputOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: NestedXmlMapsInputOutput): any => ({ ...obj, }); @@ -410,6 +509,9 @@ export namespace NestedXmlMapsInputOutput { export interface NoInputAndOutputOutput {} export namespace NoInputAndOutputOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: NoInputAndOutputOutput): any => ({ ...obj, }); @@ -422,6 +524,9 @@ export interface NullAndEmptyHeadersIO { } export namespace NullAndEmptyHeadersIO { + /** + * @internal + */ export const filterSensitiveLog = (obj: NullAndEmptyHeadersIO): any => ({ ...obj, }); @@ -433,6 +538,9 @@ export interface OmitsNullSerializesEmptyStringInput { } export namespace OmitsNullSerializesEmptyStringInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: OmitsNullSerializesEmptyStringInput): any => ({ ...obj, }); @@ -443,6 +551,9 @@ export interface QueryIdempotencyTokenAutoFillInput { } export namespace QueryIdempotencyTokenAutoFillInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: QueryIdempotencyTokenAutoFillInput): any => ({ ...obj, }); @@ -454,6 +565,9 @@ export interface QueryParamsAsStringListMapInput { } export namespace QueryParamsAsStringListMapInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: QueryParamsAsStringListMapInput): any => ({ ...obj, }); @@ -465,6 +579,9 @@ export interface QueryPrecedenceInput { } export namespace QueryPrecedenceInput { + /** + * @internal + */ export const filterSensitiveLog = (obj: QueryPrecedenceInput): any => ({ ...obj, }); @@ -484,6 +601,9 @@ export interface SimpleScalarPropertiesInputOutput { } export namespace SimpleScalarPropertiesInputOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: SimpleScalarPropertiesInputOutput): any => ({ ...obj, }); @@ -500,6 +620,9 @@ export interface TimestampFormatHeadersIO { } export namespace TimestampFormatHeadersIO { + /** + * @internal + */ export const filterSensitiveLog = (obj: TimestampFormatHeadersIO): any => ({ ...obj, }); @@ -511,6 +634,9 @@ export interface XmlAttributesInputOutput { } export namespace XmlAttributesInputOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: XmlAttributesInputOutput): any => ({ ...obj, }); @@ -521,6 +647,9 @@ export interface XmlAttributesOnPayloadInputOutput { } export namespace XmlAttributesOnPayloadInputOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: XmlAttributesOnPayloadInputOutput): any => ({ ...obj, }); @@ -531,6 +660,9 @@ export interface XmlBlobsInputOutput { } export namespace XmlBlobsInputOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: XmlBlobsInputOutput): any => ({ ...obj, }); @@ -542,6 +674,9 @@ export interface StructureListMember { } export namespace StructureListMember { + /** + * @internal + */ export const filterSensitiveLog = (obj: StructureListMember): any => ({ ...obj, }); @@ -568,6 +703,9 @@ export interface XmlListsInputOutput { } export namespace XmlListsInputOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: XmlListsInputOutput): any => ({ ...obj, }); @@ -578,6 +716,9 @@ export interface GreetingStruct { } export namespace GreetingStruct { + /** + * @internal + */ export const filterSensitiveLog = (obj: GreetingStruct): any => ({ ...obj, }); @@ -588,6 +729,9 @@ export interface XmlMapsInputOutput { } export namespace XmlMapsInputOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: XmlMapsInputOutput): any => ({ ...obj, }); @@ -598,6 +742,9 @@ export interface XmlEmptyStringsInputOutput { } export namespace XmlEmptyStringsInputOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: XmlEmptyStringsInputOutput): any => ({ ...obj, }); @@ -613,6 +760,9 @@ export interface XmlEnumsInputOutput { } export namespace XmlEnumsInputOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: XmlEnumsInputOutput): any => ({ ...obj, }); @@ -623,6 +773,9 @@ export interface XmlMapsXmlNameInputOutput { } export namespace XmlMapsXmlNameInputOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: XmlMapsXmlNameInputOutput): any => ({ ...obj, }); @@ -634,6 +787,9 @@ export interface XmlNamespaceNested { } export namespace XmlNamespaceNested { + /** + * @internal + */ export const filterSensitiveLog = (obj: XmlNamespaceNested): any => ({ ...obj, }); @@ -644,6 +800,9 @@ export interface XmlNamespacesInputOutput { } export namespace XmlNamespacesInputOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: XmlNamespacesInputOutput): any => ({ ...obj, }); @@ -657,6 +816,9 @@ export interface XmlTimestampsInputOutput { } export namespace XmlTimestampsInputOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: XmlTimestampsInputOutput): any => ({ ...obj, }); @@ -674,6 +836,9 @@ export interface XmlNestedUnionStruct { } export namespace XmlNestedUnionStruct { + /** + * @internal + */ export const filterSensitiveLog = (obj: XmlNestedUnionStruct): any => ({ ...obj, }); @@ -875,6 +1040,9 @@ export namespace XmlUnionShape { return visitor._(value.$unknown[0], value.$unknown[1]); }; + /** + * @internal + */ export const filterSensitiveLog = (obj: XmlUnionShape): any => { if (obj.stringValue !== undefined) return { stringValue: obj.stringValue }; if (obj.booleanValue !== undefined) return { booleanValue: obj.booleanValue }; @@ -896,6 +1064,9 @@ export interface RecursiveShapesInputOutputNested1 { } export namespace RecursiveShapesInputOutputNested1 { + /** + * @internal + */ export const filterSensitiveLog = (obj: RecursiveShapesInputOutputNested1): any => ({ ...obj, }); @@ -907,6 +1078,9 @@ export interface RecursiveShapesInputOutputNested2 { } export namespace RecursiveShapesInputOutputNested2 { + /** + * @internal + */ export const filterSensitiveLog = (obj: RecursiveShapesInputOutputNested2): any => ({ ...obj, }); @@ -917,6 +1091,9 @@ export interface XmlUnionsInputOutput { } export namespace XmlUnionsInputOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: XmlUnionsInputOutput): any => ({ ...obj, ...(obj.unionValue && { unionValue: XmlUnionShape.filterSensitiveLog(obj.unionValue) }), @@ -928,6 +1105,9 @@ export interface RecursiveShapesInputOutput { } export namespace RecursiveShapesInputOutput { + /** + * @internal + */ export const filterSensitiveLog = (obj: RecursiveShapesInputOutput): any => ({ ...obj, });